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 -712698321 "Jürgen Spitzmüller"
126 \author 2089657418 "Usti"
132 Customizing \SpecialChar LyX
133 : Features for the Advanced User
137 by the \SpecialChar LyX
142 \begin_layout Plain Layout
144 If you have comments or error corrections, please send them to the \SpecialChar LyX
147 \begin_inset CommandInset href
149 target "lyx-docs@lists.lyx.org"
156 \begin_inset Quotes eld
160 \begin_inset Quotes erd
163 in the subject header, and please cc the current maintainer of this file,
164 Richard Heck <rgheck@comcast.net>.
170 \begin_inset Newline newline
174 \begin_inset Newline newline
180 \begin_layout Standard
181 \begin_inset CommandInset toc
182 LatexCommand tableofcontents
189 \begin_layout Standard
190 \begin_inset Note Note
193 \begin_layout Plain Layout
194 Please use change tracking when modifying this document.
195 This makes it easier for our translators to recognize things that have
196 been changed, and it helps the maintainer keep up-to-date with what's been
205 \begin_layout Chapter
209 \begin_layout Standard
210 This manual covers the customization features present in \SpecialChar LyX
212 In it, we discuss issues like keyboard shortcuts, screen previewing options,
213 printer options, sending commands to \SpecialChar LyX
214 via the \SpecialChar LyX
215 Server, internationalization,
216 installing new \SpecialChar LaTeX
217 classes and \SpecialChar LyX
219 We can't possibly hope to touch on everything you can change—our developers
220 add new features faster than we can document them—but we will explain the
221 most common customizations and hopefully point you in the right direction
222 for some of the more obscure ones.
225 \begin_layout Standard
226 \begin_inset Branch OutDated
229 \begin_layout Standard
230 Information from previous versions of this document that now seems to be
231 outdated is contained in the OutDated branch of this document.
232 By default, this information will not appear in the \SpecialChar LaTeX
241 \begin_layout Chapter
246 \begin_layout Standard
247 This chapter aims to help you to find your way through the \SpecialChar LyX
250 Before continuing to read this chapter, you should find out where your
252 library and user directories are by using
253 \begin_inset Flex Noun
256 \begin_layout Plain Layout
257 Help\SpecialChar menuseparator
268 The library directory is the place where \SpecialChar LyX
269 places its system-wide configuration
270 files; the user directory is where you can place your modified versions.
271 We will call the former
272 \begin_inset Flex Code
275 \begin_layout Plain Layout
282 \begin_inset Flex Noun
285 \begin_layout Plain Layout
291 in the remainder of this document.
295 \begin_layout Section
297 \begin_inset Flex Code
300 \begin_layout Plain Layout
309 \begin_layout Standard
310 \begin_inset Flex Code
313 \begin_layout Plain Layout
319 and its sub-directories contain a number of files and that can be used
320 to customize \SpecialChar LyX
322 You can change many of these files from within \SpecialChar LyX
324 \begin_inset Flex Noun
327 \begin_layout Plain Layout
328 Tools\SpecialChar menuseparator
335 Most customization that you will want to do in \SpecialChar LyX
336 is possible through this
338 However, many other inner aspects of \SpecialChar LyX
339 can be customized by modifying the
341 \begin_inset Flex Code
344 \begin_layout Plain Layout
351 These files fall in different categories, described in the following subsection
355 \begin_layout Subsection
356 Automatically generated files
359 \begin_layout Standard
360 The files, which are to be found in
361 \begin_inset Flex Noun
364 \begin_layout Plain Layout
370 , are generated when you configure \SpecialChar LyX
372 They contain various default values that are guessed by inspection.
373 In general, it is not a good idea to modify them, since they might be overwritt
377 \begin_layout Labeling
378 \labelwidthstring 00.00.0000
379 \begin_inset Flex Code
382 \begin_layout Plain Layout
388 contains defaults for various commands.
391 \begin_layout Labeling
392 \labelwidthstring 00.00.0000
393 \begin_inset Flex Code
396 \begin_layout Plain Layout
402 contains the list of packages that have been recognized by \SpecialChar LyX
404 It is currently unused by the \SpecialChar LyX
405 program itself, but the information extracted,
406 and more, is made available with
407 \begin_inset Flex Noun
410 \begin_layout Plain Layout
411 Help\SpecialChar menuseparator
425 \begin_layout Labeling
426 \labelwidthstring 00.00.0000
427 \begin_inset Flex Code
430 \begin_layout Plain Layout
436 the list of text classes that have been found in your
437 \begin_inset Flex Code
440 \begin_layout Plain Layout
446 directories, along with the associated \SpecialChar LaTeX
447 document class and their description.
450 \begin_layout Labeling
451 \labelwidthstring 00.00.0000
452 \begin_inset Flex Code
455 \begin_layout Plain Layout
461 the list of layout modules found in your
462 \begin_inset Flex Code
465 \begin_layout Plain Layout
474 \begin_layout Labeling
475 \labelwidthstring 00.00.0000
476 \begin_inset Flex Code
479 \begin_layout Plain Layout
485 lists of various sorts of \SpecialChar LaTeX
486 -related files found on your system
489 \begin_layout Labeling
490 \labelwidthstring 00.00.0000
491 \begin_inset Flex Code
494 \begin_layout Plain Layout
495 doc/\SpecialChar LaTeX
501 is automatically generated during configuration from the file
502 \begin_inset Flex Code
505 \begin_layout Plain Layout
513 It contains information on your \SpecialChar LaTeX
517 \begin_layout Subsection
521 \begin_layout Standard
522 These directories are duplicated between
523 \begin_inset Flex Code
526 \begin_layout Plain Layout
533 \begin_inset Flex Code
536 \begin_layout Plain Layout
543 If a particular files exists in both places, the one in
544 \begin_inset Flex Code
547 \begin_layout Plain Layout
556 \begin_layout Labeling
557 \labelwidthstring 00.00.0000
558 \begin_inset Flex Code
561 \begin_layout Plain Layout
567 this directory contains files with the extension
568 \begin_inset Flex Code
571 \begin_layout Plain Layout
577 that define the keybindings used in \SpecialChar LyX
579 If there exists an internationalized version of the bind file named
580 \begin_inset Flex Code
583 \begin_layout Plain Layout
589 , that will be used first.
592 \begin_layout Labeling
593 \labelwidthstring 00.00.0000
594 \begin_inset Flex Code
597 \begin_layout Plain Layout
603 contains graphics files that can be included in documents.
607 \begin_layout Labeling
608 \labelwidthstring 00.00.0000
609 \begin_inset Flex Code
612 \begin_layout Plain Layout
618 contains \SpecialChar LyX
619 documentation files (including the one you are currently reading).
621 \begin_inset Flex Code
624 \begin_layout Plain Layout
631 deserves special attention, as noted above.
632 The internationalized help docs are in subdirectories
633 \begin_inset Flex Code
636 \begin_layout Plain Layout
643 \begin_inset Quotes eld
647 \begin_inset Quotes erd
650 is the ISO language code.
652 \begin_inset CommandInset ref
654 reference "cha:Internationalizing-LyX"
661 \begin_layout Labeling
662 \labelwidthstring 00.00.0000
663 \begin_inset Flex Code
666 \begin_layout Plain Layout
672 contains example files that explain how to use some features.
673 In the file browser, press the
674 \begin_inset Flex Noun
677 \begin_layout Plain Layout
686 \begin_layout Labeling
687 \labelwidthstring 00.00.0000
688 \begin_inset Flex Code
691 \begin_layout Plain Layout
697 contains image files that are used by the
698 \begin_inset Flex Noun
701 \begin_layout Plain Layout
708 In addition, it also contains the individual icons used in the toolbar
709 and the banners that can be shown when \SpecialChar LyX
713 \begin_layout Labeling
714 \labelwidthstring 00.00.0000
715 \begin_inset Flex Code
718 \begin_layout Plain Layout
724 contains keyboard keymapping files.
726 \begin_inset CommandInset ref
728 reference "sec:International-Keymap-Stuff"
735 \begin_layout Labeling
736 \labelwidthstring 00.00.0000
737 \begin_inset Flex Code
740 \begin_layout Plain Layout
746 contains the text class and module files described in
747 \begin_inset CommandInset ref
749 reference "cha:Installing-New-Document"
756 \begin_layout Labeling
757 \labelwidthstring 00.00.0000
758 \begin_inset Flex Code
761 \begin_layout Plain Layout
768 \begin_inset Flex Code
771 \begin_layout Plain Layout
777 Python scripts used to convert between \SpecialChar LyX
779 These can be run from the command line if, say, you want to batch-convert
783 \begin_layout Labeling
784 \labelwidthstring 00.00.0000
785 \begin_inset Flex Code
788 \begin_layout Plain Layout
794 contains some files that demonstrate the capabilities of the
795 \begin_inset Flex Noun
798 \begin_layout Plain Layout
809 Also contains some scripts used by \SpecialChar LyX
813 \begin_layout Labeling
814 \labelwidthstring 00.00.0000
815 \begin_inset Flex Code
818 \begin_layout Plain Layout
824 contains the standard \SpecialChar LyX
825 template files described in
826 \begin_inset CommandInset ref
828 reference "subsec:Creating-Templates"
835 \begin_layout Labeling
836 \labelwidthstring 00.00.0000
837 \begin_inset Flex Code
840 \begin_layout Plain Layout
846 contains files with the extension
847 \begin_inset Flex Code
850 \begin_layout Plain Layout
856 that define the user interface to \SpecialChar LyX
858 That is, the files define which items appear in which menus and the items
859 appearing on the toolbar.
862 \begin_layout Subsection
863 Files you don't want to modify
866 \begin_layout Standard
867 These files are used internally by \SpecialChar LyX
868 and you generally do not need to modify
869 them unless you are a developer.
872 \begin_layout Labeling
873 \labelwidthstring 00.00.0000
874 \begin_inset Flex Code
877 \begin_layout Plain Layout
883 this file contains the list of \SpecialChar LyX
885 The contents are displayed with the menu entry
886 \begin_inset Flex Noun
889 \begin_layout Plain Layout
890 Help\SpecialChar menuseparator
903 \begin_layout Labeling
904 \labelwidthstring 00.00.0000
905 \begin_inset Flex Code
908 \begin_layout Plain Layout
914 this is a \SpecialChar LaTeX
915 script used during the configuration process.
919 \begin_layout Labeling
920 \labelwidthstring 00.00.0000
921 \begin_inset Flex Code
924 \begin_layout Plain Layout
930 this is a Python script that is used to re-configure \SpecialChar LyX
932 It creates configuration files in the directory it was run from.
935 \begin_layout Subsection
936 Other files needing a line or two
939 \begin_layout Labeling
940 \labelwidthstring 00.00.0000
941 \begin_inset Flex Code
944 \begin_layout Plain Layout
950 this contains tables describing how different character encodings can be
954 \begin_layout Labeling
955 \labelwidthstring 00.00.0000
956 \begin_inset Flex Code
959 \begin_layout Plain Layout
965 this file contains the templates available to the new
966 \begin_inset Flex Noun
969 \begin_layout Plain Layout
980 \begin_inset CommandInset ref
982 reference "chap:Including-External-Material"
989 \begin_layout Labeling
990 \labelwidthstring 00.00.0000
991 \begin_inset Flex Code
994 \begin_layout Plain Layout
1000 this file contains a list of all the languages currently supported by \SpecialChar LyX
1004 \begin_layout Labeling
1005 \labelwidthstring 00.00.0000
1006 \begin_inset Flex Code
1009 \begin_layout Plain Layout
1015 contains information about the supported fonts.
1018 \begin_layout Labeling
1019 \labelwidthstring 00.00.0000
1020 \begin_inset Flex Code
1023 \begin_layout Plain Layout
1029 this file contains translations for internationalized paragraph styles
1031 \begin_inset CommandInset ref
1033 reference "subsec:I18n"
1040 \begin_layout Labeling
1041 \labelwidthstring 00.00.0000
1042 \begin_inset Flex Code
1045 \begin_layout Plain Layout
1051 this file contains information about unicode-encoded glyphs and the way
1052 they are supported by \SpecialChar LyX
1053 via \SpecialChar LaTeX
1057 \begin_layout Section
1058 Your local configuration directory
1061 \begin_layout Standard
1062 Even if you are using \SpecialChar LyX
1063 as an unprivileged user, you might want to change
1065 configuration for your own use.
1067 \begin_inset Flex Code
1070 \begin_layout Plain Layout
1076 directory contains all your personal configuration files.
1077 This is the directory described as
1078 \begin_inset Quotes eld
1082 \begin_inset Quotes erd
1086 \begin_inset Flex Noun
1089 \begin_layout Plain Layout
1090 Help\SpecialChar menuseparator
1092 \begin_inset space ~
1101 This directory is used as a mirror of
1102 \begin_inset Flex Code
1105 \begin_layout Plain Layout
1111 , which means that every file in
1112 \begin_inset Flex Code
1115 \begin_layout Plain Layout
1121 is a replacement for the corresponding file in
1122 \begin_inset Flex Code
1125 \begin_layout Plain Layout
1132 Any configuration file described in the above sections can be placed either
1133 in the system-wide directory, in which case it will affect all users, or
1134 in your local directory for your own use.
1137 \begin_layout Standard
1138 To make things clearer, let's provide a few examples:
1141 \begin_layout Itemize
1142 The preferences set in the
1143 \begin_inset Flex Noun
1146 \begin_layout Plain Layout
1147 Tools\SpecialChar menuseparator
1153 dialog are saved to a file
1154 \begin_inset Flex Code
1157 \begin_layout Plain Layout
1164 \begin_inset Flex Code
1167 \begin_layout Plain Layout
1176 \begin_layout Itemize
1177 When you reconfigure using
1178 \begin_inset Flex Noun
1181 \begin_layout Plain Layout
1182 Tools\SpecialChar menuseparator
1190 \begin_inset Flex Code
1193 \begin_layout Plain Layout
1199 script, and the resulting files are written in your local configuration
1201 This means that any additional text class file that you might have added
1203 \begin_inset Flex Code
1206 \begin_layout Plain Layout
1212 will be added to the list of classes in the
1213 \begin_inset Flex Noun
1216 \begin_layout Plain Layout
1217 Document\SpecialChar menuseparator
1226 \begin_layout Itemize
1227 If you get some updated documentation from \SpecialChar LyX
1228 ftp site and cannot install
1229 it because you do not have sysadmin rights on your system, you can just
1231 \begin_inset Flex Code
1234 \begin_layout Plain Layout
1240 and the items in the
1241 \begin_inset Flex Noun
1244 \begin_layout Plain Layout
1250 menu will open them!
1253 \begin_layout Section
1254 Running \SpecialChar LyX
1255 with multiple configurations
1258 \begin_layout Standard
1259 The configuration freedom of the local configuration directory may not suffice
1260 if you want to have more than one configuration at your disposal.
1261 For example, you may want to be use different key bindings or printer settings
1263 You can achieve this by having several such directories.
1264 You then specify which directory to use at run-time.
1267 \begin_layout Standard
1268 Invoking \SpecialChar LyX
1269 with the command line switch
1270 \begin_inset Flex Code
1273 \begin_layout Plain Layout
1283 instructs the program to read the configuration from that directory, and
1284 not from the default directory.
1285 (You can determine the default directory by running \SpecialChar LyX
1287 \begin_inset Flex Code
1290 \begin_layout Plain Layout
1296 switch.) If the specified directory does not exist, \SpecialChar LyX
1298 for you, just like it does for the default directory on the first time
1299 you run the program.
1300 You can modify the configuration options in this additional user directory
1301 exactly as you would for the default directory.
1302 These directories are completely independent (but read on).
1303 Note that setting the environment variable
1304 \begin_inset Flex Code
1307 \begin_layout Plain Layout
1313 to some value has exactly the same effect.
1316 \begin_layout Standard
1317 Having several configurations also requires more maintenance: if you want
1318 to add a new layout to
1319 \begin_inset Flex Code
1322 \begin_layout Plain Layout
1328 which you want available from all your configurations, you must add it
1329 to each directory separately.
1330 You can avoid this with the following trick: after \SpecialChar LyX
1331 creates the additional
1332 directory, most of the subdirectories (see above) are empty.
1333 If you want the new configuration to mirror an existing one, replace the
1334 empty subdirectory with a symbolic link to the matching subdirectory in
1335 the existing configuration.
1337 \begin_inset Flex Code
1340 \begin_layout Plain Layout
1346 subdirectory, however, since it contains a file written by the configuration
1347 script (also accessible through
1348 \begin_inset Flex Noun
1351 \begin_layout Plain Layout
1352 Tools\SpecialChar menuseparator
1358 ) which is configuration-specific.
1361 \begin_layout Chapter
1362 The Preferences dialog
1365 \begin_layout Standard
1366 All options of the preferences dialog are described in the Appendix
1368 The Preferences Dialog
1375 For some options you might find here more details.
1378 \begin_layout Section
1380 \begin_inset CommandInset label
1389 \begin_layout Standard
1390 The first step is to define your file formats if they are not already defined.
1392 \begin_inset Flex Noun
1395 \begin_layout Plain Layout
1396 Tools\SpecialChar menuseparator
1404 \begin_inset Flex Noun
1407 \begin_layout Plain Layout
1408 File Handling\SpecialChar menuseparator
1415 \begin_inset Flex Noun
1418 \begin_layout Plain Layout
1424 button to define your new format.
1426 \begin_inset Flex Noun
1429 \begin_layout Plain Layout
1435 field contains the name used to identify the format in the GUI.
1437 \begin_inset Flex Noun
1440 \begin_layout Plain Layout
1446 is used to identify the format internally.
1447 You will also need to enter a file extension.
1448 These are all required.
1450 \begin_inset Flex Noun
1453 \begin_layout Plain Layout
1459 field is used to provide a keyboard shortcut on the menus.
1460 (For example, pressing
1461 \begin_inset Flex Noun
1464 \begin_layout Plain Layout
1471 \begin_inset Flex Noun
1474 \begin_layout Plain Layout
1475 Document\SpecialChar menuseparator
1476 View (Other Formats)\SpecialChar menuseparator
1485 \begin_layout Standard
1487 \begin_inset Flex Noun
1490 \begin_layout Plain Layout
1497 \begin_inset Flex Noun
1500 \begin_layout Plain Layout
1507 For example, you might want to use
1508 \begin_inset Flex Noun
1511 \begin_layout Plain Layout
1517 to view PostScript files.
1518 You can enter the command needed to start the program in the corresponding
1520 In defining this command, you can use the four variables listed in the
1522 The viewer is launched when you view an image in \SpecialChar LyX
1524 \begin_inset Flex Noun
1527 \begin_layout Plain Layout
1528 Document\SpecialChar menuseparator
1535 The editor is for example launched when you right-click on an image and
1537 \begin_inset Flex Noun
1540 \begin_layout Plain Layout
1546 in the appearing context menu.
1549 \begin_layout Standard
1551 \begin_inset Flex Noun
1554 \begin_layout Plain Layout
1560 type of a format is optional, but if it is specified, it must be unique
1562 It is used to detect files of this format from the file contents.
1563 For some important file formats there is no MIME type officially registered
1565 \begin_inset CommandInset href
1568 target "http://www.iana.org/assignments/media-types/"
1573 Therefore \SpecialChar LyX
1574 uses the extended list of MIME types as specified by
1575 \begin_inset CommandInset href
1577 name "freedesktop.org"
1578 target "http://www.freedesktop.org/wiki/Specifications/shared-mime-info-spec"
1585 \begin_layout Standard
1587 \begin_inset Flex Noun
1590 \begin_layout Plain Layout
1596 option tells \SpecialChar LyX
1597 that a format is suitable for document export.
1598 If this is set and if a suitable conversion route exists (see
1599 \begin_inset CommandInset ref
1601 reference "sec:Converters"
1605 ), the format will appear in the
1606 \begin_inset Flex Noun
1609 \begin_layout Plain Layout
1610 File\SpecialChar menuseparator
1617 The format will also appear in the
1618 \begin_inset Flex Noun
1621 \begin_layout Plain Layout
1622 Document\SpecialChar menuseparator
1628 menu if a viewer is specified for the format.
1629 Pure image formats, such as
1630 \begin_inset Flex Code
1633 \begin_layout Plain Layout
1639 , should not use this option.
1640 Formats that can both represent vector graphics and documents like
1641 \begin_inset Flex Code
1644 \begin_layout Plain Layout
1653 \begin_layout Standard
1655 \begin_inset Flex Noun
1658 \begin_layout Plain Layout
1659 Vector graphics format
1664 tells \SpecialChar LyX
1665 that a format can contain vector graphics.
1666 This information is used to determine the target format of included graphics
1668 \begin_inset Flex Noun
1671 \begin_layout Plain Layout
1678 Included graphics may need to be converted to either
1679 \begin_inset Flex Noun
1682 \begin_layout Plain Layout
1689 \begin_inset Flex Noun
1692 \begin_layout Plain Layout
1699 \begin_inset Flex Noun
1702 \begin_layout Plain Layout
1709 \begin_inset Flex Noun
1712 \begin_layout Plain Layout
1718 cannot handle other image formats.
1719 If an included graphic is not already in
1720 \begin_inset Flex Noun
1723 \begin_layout Plain Layout
1730 \begin_inset Flex Noun
1733 \begin_layout Plain Layout
1740 \begin_inset Flex Noun
1743 \begin_layout Plain Layout
1749 format, it is converted to
1750 \begin_inset Flex Noun
1753 \begin_layout Plain Layout
1759 if the vector format option is set, and otherwise to
1760 \begin_inset Flex Noun
1763 \begin_layout Plain Layout
1772 \begin_layout Section
1776 \begin_layout Standard
1777 Since all conversions from one format to another take place in \SpecialChar LyX
1779 directory, it is sometimes necessary to modify a file before copying it
1780 to the temporary directory in order that the conversion may be performed.
1784 \begin_layout Plain Layout
1785 For example, the file may refer to other files—images, for example—using
1786 relative file names, and these may become invalid when the file is copied
1787 to the temporary directory.
1792 This is done by a Copier: It copies a file to (or from) the temporary directory
1793 and may modify it in the process.
1796 \begin_layout Standard
1797 The definitions of the copiers may use eight variables:
1800 \begin_layout Labeling
1801 \labelwidthstring 00.00.0000
1802 \begin_inset Flex Code
1805 \begin_layout Plain Layout
1811 The \SpecialChar LyX
1812 system directory (e.
1813 \begin_inset space \thinspace{}
1817 \begin_inset space \space{}
1821 \begin_inset Flex Noun
1824 \begin_layout Plain Layout
1833 \begin_layout Labeling
1834 \labelwidthstring 00.00.0000
1835 \begin_inset Flex Code
1838 \begin_layout Plain Layout
1847 \begin_layout Labeling
1848 \labelwidthstring 00.00.0000
1849 \begin_inset Flex Code
1852 \begin_layout Plain Layout
1861 \begin_layout Labeling
1862 \labelwidthstring 00.00.0000
1863 \begin_inset Flex Code
1866 \begin_layout Plain Layout
1872 The base name (without filename extension) in the \SpecialChar LyX
1876 \begin_layout Labeling
1877 \labelwidthstring 00.00.0000
1878 \begin_inset Flex Code
1881 \begin_layout Plain Layout
1887 The full directory path of the \SpecialChar LyX
1891 \begin_layout Labeling
1892 \labelwidthstring 00.00.0000
1893 \begin_inset Flex Code
1896 \begin_layout Plain Layout
1902 The full pathname to the original \SpecialChar LyX
1903 file being processed
1906 \begin_layout Labeling
1907 \labelwidthstring 00.00.0000
1908 \begin_inset Flex Code
1911 \begin_layout Plain Layout
1917 The filename (without any directory path) of the \SpecialChar LyX
1921 \begin_layout Labeling
1922 \labelwidthstring 00.00.0000
1923 \begin_inset Flex Code
1926 \begin_layout Plain Layout
1932 The `\SpecialChar LaTeX
1936 \begin_layout Standard
1937 The latter should be the filename as it would be used in a \SpecialChar LaTeX
1945 It is relevant only when exporting files suitable for such inclusion.
1948 \begin_layout Standard
1949 Copiers can be used to do almost anything with output files.
1950 For example, suppose you want generated pdf files to be copied to a special
1952 \begin_inset Flex Code
1955 \begin_layout Plain Layout
1962 Then you could write a shell script such as this one:
1965 \begin_layout Standard
1966 \begin_inset listings
1970 \begin_layout Plain Layout
1975 \begin_layout Plain Layout
1980 \begin_layout Plain Layout
1982 TOFILE=`basename $2`
1985 \begin_layout Plain Layout
1987 cp $FROMFILE /home/you/pdf/$TOFILE
1992 Save it in your local \SpecialChar LyX
1994 \begin_inset Flex Code
1997 \begin_layout Plain Layout
1998 /home/you/.lyx/scripts/pdfcopier.sh
2003 —and make it executable, if you need to do so on your platform.
2005 \begin_inset Flex Noun
2008 \begin_layout Plain Layout
2009 Tools\SpecialChar menuseparator
2015 dialog, select under
2016 \begin_inset Flex Noun
2019 \begin_layout Plain Layout
2020 File Handling\SpecialChar menuseparator
2027 \begin_inset Flex Noun
2030 \begin_layout Plain Layout
2036 format—or one of the other pdf formats—and enter
2037 \begin_inset Flex Code
2040 \begin_layout Plain Layout
2041 pdfcopier.sh $$i $$o
2047 \begin_inset Flex Noun
2050 \begin_layout Plain Layout
2060 \begin_layout Standard
2061 Copiers are used by \SpecialChar LyX
2062 in various of its own conversions.
2063 For example, if appropriate programs are found, \SpecialChar LyX
2064 will automatically install
2066 \begin_inset Flex Noun
2069 \begin_layout Plain Layout
2076 \begin_inset Flex Noun
2079 \begin_layout Plain Layout
2081 \begin_inset space ~
2090 When these formats are exported, the copier sees that not just the main
2091 HTML file but various associated files (style files, images, etc.) are also
2093 All these files are written to a subdirectory of the directory in which
2094 the original \SpecialChar LyX
2099 \begin_layout Plain Layout
2100 This copier can be customized.
2102 \begin_inset Quotes eld
2106 \begin_inset Quotes erd
2109 argument takes a comma-separated list of extensions to be copied; if it
2110 is omitted, all files will be copied.
2112 \begin_inset Quotes eld
2116 \begin_inset Quotes erd
2119 argument determines the extension added to the generated directory.
2121 \begin_inset Quotes eld
2125 \begin_inset Flex Noun
2128 \begin_layout Plain Layout
2135 \begin_inset Quotes erd
2138 , so HTML generated from
2139 \begin_inset Flex Noun
2142 \begin_layout Plain Layout
2143 /path/to/filename.lyx
2149 \begin_inset Flex Noun
2152 \begin_layout Plain Layout
2153 /path/to/filename.html.LyXconv
2167 \begin_layout Section
2169 \begin_inset CommandInset label
2171 name "sec:Converters"
2178 \begin_layout Standard
2179 You can define your own Converters to convert files between different formats.
2181 \begin_inset Flex Noun
2184 \begin_layout Plain Layout
2185 Tools\SpecialChar menuseparator
2186 Preferences\SpecialChar menuseparator
2187 File Handling\SpecialChar menuseparator
2196 \begin_layout Standard
2197 To define a new converter, select the
2198 \begin_inset Flex Noun
2201 \begin_layout Plain Layout
2203 \begin_inset space ~
2212 \begin_inset Flex Noun
2215 \begin_layout Plain Layout
2217 \begin_inset space ~
2225 from the drop-down lists, enter the command needed for the conversion,
2227 \begin_inset Flex Noun
2230 \begin_layout Plain Layout
2237 Several variables can be used in the definition of converters:
2240 \begin_layout Labeling
2241 \labelwidthstring 00.00.0000
2242 \begin_inset Flex Code
2245 \begin_layout Plain Layout
2251 The \SpecialChar LyX
2255 \begin_layout Labeling
2256 \labelwidthstring 00.00.0000
2257 \begin_inset Flex Code
2260 \begin_layout Plain Layout
2269 \begin_layout Labeling
2270 \labelwidthstring 00.00.0000
2271 \begin_inset Flex Code
2274 \begin_layout Plain Layout
2283 \begin_layout Labeling
2284 \labelwidthstring 00.00.0000
2285 \begin_inset Flex Code
2288 \begin_layout Plain Layout
2294 The base filename of the input file (i.
2295 \begin_inset space \thinspace{}
2298 g., without the extension)
2301 \begin_layout Labeling
2302 \labelwidthstring 00.00.0000
2303 \begin_inset Flex Code
2306 \begin_layout Plain Layout
2312 The path to the input file
2315 \begin_layout Labeling
2316 \labelwidthstring 00.00.0000
2317 \begin_inset Flex Code
2320 \begin_layout Plain Layout
2326 The path to the original input file (this is different from $$p when a
2327 chain of converters is called)
2330 \begin_layout Labeling
2331 \labelwidthstring 00.00.0000
2332 \begin_inset Flex Code
2335 \begin_layout Plain Layout
2341 The iconv name for the encoding of the document.
2344 \begin_layout Standard
2346 \begin_inset Flex Noun
2349 \begin_layout Plain Layout
2351 \begin_inset space ~
2359 field you can enter the following flags, separated by commas:
2362 \begin_layout Labeling
2363 \labelwidthstring 00.00.0000
2364 \begin_inset Flex Code
2367 \begin_layout Plain Layout
2373 This converter runs some form of \SpecialChar LaTeX
2375 This will make \SpecialChar LyX
2376 's \SpecialChar LaTeX
2377 error logs available.
2380 \begin_layout Labeling
2381 \labelwidthstring 00.00.0000
2382 \begin_inset Flex Code
2385 \begin_layout Plain Layout
2391 Needs the \SpecialChar LaTeX
2393 \begin_inset Flex Noun
2396 \begin_layout Plain Layout
2402 file for the conversion.
2405 \begin_layout Labeling
2406 \labelwidthstring 00.00.0000
2407 \begin_inset Flex Code
2410 \begin_layout Plain Layout
2417 \begin_inset Quotes eld
2421 \begin_inset Quotes erd
2424 file from the backend, which in practice means a \SpecialChar LaTeX
2425 file like the one we
2426 would export, without
2427 \begin_inset Flex Code
2430 \begin_layout Plain Layout
2439 \begin_layout Labeling
2440 \labelwidthstring 00.00.0000
2441 \begin_inset Flex Code
2444 \begin_layout Plain Layout
2453 \begin_layout Standard
2454 The following three flags are not really flags at all because they take
2456 \begin_inset Flex Noun
2459 \begin_layout Plain Layout
2461 \begin_inset space ~
2465 \begin_inset space ~
2476 \begin_layout Labeling
2477 \labelwidthstring 00.00.0000
2478 \begin_inset Flex Code
2481 \begin_layout Plain Layout
2487 If set, the converter's standard error will be redirected to a file
2488 \begin_inset Flex Code
2491 \begin_layout Plain Layout
2497 , and the script given as argument will be run as:
2498 \begin_inset Flex Code
2501 \begin_layout Plain Layout
2502 script < infile.out > infile.log
2508 The argument may contain
2509 \begin_inset Flex Code
2512 \begin_layout Plain Layout
2521 \begin_layout Labeling
2522 \labelwidthstring 00.00.0000
2523 \begin_inset Flex Code
2526 \begin_layout Plain Layout
2532 The name of the directory in which the converter will dump the generated
2535 will not create this directory, and it does not copy anything into it,
2536 though it will copy this directory to the destination.
2537 The argument may contain
2538 \begin_inset Flex Code
2541 \begin_layout Plain Layout
2547 , which will be replaced by the base name of the input and output files,
2548 respectively, when the directory is copied.
2549 \begin_inset Newline newline
2552 Note that resultdir and usetempdir make no sense together.
2553 The latter will be ignored if the former is given.
2556 \begin_layout Labeling
2557 \labelwidthstring 00.00.0000
2558 \begin_inset Flex Code
2561 \begin_layout Plain Layout
2567 Determines the output file name and may, contain
2568 \begin_inset Flex Code
2571 \begin_layout Plain Layout
2578 Sensible only with resultdir and optional even then; if not given, it defaults
2582 \begin_layout Standard
2583 None of these last three are presently used in any of the converters that
2584 are installed with \SpecialChar LyX
2589 \begin_layout Standard
2590 You do not have to define converters for all formats between which you want
2592 For example, you will note that there is no `\SpecialChar LyX
2593 to PostScript' converter,
2594 but \SpecialChar LyX
2595 will export PostScript.
2596 It does so by first creating a \SpecialChar LaTeX
2597 file (no converter needs to be defined
2598 for this) which is then converted to DVI using the `\SpecialChar LaTeX
2600 and finally converting the resulting DVI file to PostScript.
2602 finds such `chains' of converters automatically, and it will always choose
2603 the shortest possible chain.
2604 You can, though, still define multiple conversion methods between file
2606 For example, the standard \SpecialChar LyX
2607 configuration provides five ways to convert
2612 \begin_layout Enumerate
2614 \begin_inset Flex Noun
2617 \begin_layout Plain Layout
2626 \begin_layout Enumerate
2627 via (DVI and) PostScript, using
2628 \begin_inset Flex Noun
2631 \begin_layout Plain Layout
2640 \begin_layout Enumerate
2642 \begin_inset Flex Noun
2645 \begin_layout Plain Layout
2654 \begin_layout Enumerate
2656 \begin_inset Flex Noun
2659 \begin_layout Plain Layout
2669 \begin_layout Enumerate
2671 \begin_inset Flex Noun
2674 \begin_layout Plain Layout
2684 \begin_layout Standard
2685 To define such alternate chains, you must define multiple target `file formats',
2687 \begin_inset CommandInset ref
2689 reference "sec:Formats"
2694 For example, in the standard configuration, the formats named
2695 \begin_inset Flex Noun
2698 \begin_layout Plain Layout
2705 \begin_inset Flex Noun
2708 \begin_layout Plain Layout
2715 \begin_inset Flex Noun
2718 \begin_layout Plain Layout
2725 \begin_inset Flex Noun
2728 \begin_layout Plain Layout
2735 \begin_inset Flex Noun
2738 \begin_layout Plain Layout
2745 \begin_inset Flex Noun
2748 \begin_layout Plain Layout
2755 \begin_inset Flex Noun
2758 \begin_layout Plain Layout
2765 \begin_inset Flex Noun
2768 \begin_layout Plain Layout
2776 \begin_inset Flex Noun
2779 \begin_layout Plain Layout
2786 \begin_inset Flex Noun
2789 \begin_layout Plain Layout
2796 ) are defined, all of which share the extension
2797 \begin_inset Flex Noun
2800 \begin_layout Plain Layout
2806 , and which correspond to the conversion methods just mentioned.
2809 \begin_layout Chapter
2810 Internationalizing \SpecialChar LyX
2812 \begin_inset CommandInset label
2814 name "cha:Internationalizing-LyX"
2821 \begin_layout Standard
2823 supports using a translated interface.
2824 Last time we checked, \SpecialChar LyX
2825 provided text in thirty languages.
2826 The language of choice is called your
2831 (For further reading on locale settings, see also the documentation for
2832 locale that comes with your operating system.
2833 For Linux, the manual page for
2834 \begin_inset Flex Code
2837 \begin_layout Plain Layout
2843 could be a good place to start).
2846 \begin_layout Standard
2847 Notice that these translations will work, but do contain a few flaws.
2848 In particular, all dialogs have been designed with the English text in
2849 mind, which means that some of the translated text will be too large to
2850 fit within the space allocated.
2851 This is only a display problem and will not cause any harm.
2852 Also, you will find that some of the translations do not define shortcut
2853 keys for everything.
2854 Sometimes, there are simply not enough free letters to do it.
2855 Other times, the translator just hasn't got around to doing it yet.
2856 Our localization team, which you may wish to join,
2860 \begin_layout Plain Layout
2861 If you are a fluent speaker of a language other than English, joining these
2862 teams is a great way to give back to the \SpecialChar LyX
2868 will of course try to fix these shortcomings in future versions of \SpecialChar LyX
2872 \begin_layout Section
2873 Translating \SpecialChar LyX
2877 \begin_layout Subsection
2878 Translating the graphical user interface (text messages).
2881 \begin_layout Standard
2884 \begin_inset Flex Code
2887 \begin_layout Plain Layout
2893 library to handle the internationalization of the interface.
2894 To have \SpecialChar LyX
2895 speak your favorite language in all menus and dialogs, you need
2897 \begin_inset Flex Code
2900 \begin_layout Plain Layout
2906 -file for that language.
2907 When this is available, you'll have to generate a
2908 \begin_inset Flex Code
2911 \begin_layout Plain Layout
2917 -file from it and install the
2918 \begin_inset Flex Code
2921 \begin_layout Plain Layout
2928 The process of doing all of this is explained in the documentation for
2930 \begin_inset Flex Code
2933 \begin_layout Plain Layout
2940 It is possible to do this just for yourself, but if you're going to do
2941 it, you might as well share the results of your labors with the rest of
2942 the \SpecialChar LyX
2944 Send a message to the \SpecialChar LyX
2945 developers' list for more information about how
2949 \begin_layout Standard
2950 In short, this is what you should do (xx denotes the language code):
2953 \begin_layout Itemize
2954 Check out the \SpecialChar LyX
2957 \begin_inset CommandInset href
2959 name "information on the web"
2960 target "http://www.lyx.org/HowToUseGIT"
2967 \begin_layout Itemize
2969 \begin_inset Flex Code
2972 \begin_layout Plain Layout
2978 to the folder of the
2979 \begin_inset Flex Code
2982 \begin_layout Plain Layout
2990 \begin_inset Flex Code
2993 \begin_layout Plain Layout
3001 \begin_inset Flex Code
3004 \begin_layout Plain Layout
3010 doesn't exist anywhere, it can be remade with the console command
3011 \begin_inset Flex Code
3014 \begin_layout Plain Layout
3020 in that directory, or you can use an existing po-file for some other language
3024 \begin_layout Itemize
3026 \begin_inset Flex Code
3029 \begin_layout Plain Layout
3039 \begin_layout Plain Layout
3040 This is just a text file, so it can be edited in any text editor.
3041 But there are also specialized programs that support such editing, such
3046 (for all platforms) or
3055 contains a `mode' for editing
3056 \begin_inset Flex Code
3059 \begin_layout Plain Layout
3066 \begin_inset Flex URL
3069 \begin_layout Plain Layout
3071 https://www.gnu.org/software/gettext/manual/html_node/PO-Mode.html
3083 For some menu- and widget-labels, there are also shortcut keys that should
3085 Those keys are marked after a `|', and should be translated according to
3086 the words and phrases of the language.
3087 You should also fill also out the information at the beginning of the new
3089 \begin_inset Flex Code
3092 \begin_layout Plain Layout
3098 -file with your email-address, etc., so people know where to reach you with
3099 suggestions and entertaining flames.
3102 \begin_layout Standard
3103 If you are just doing this on your own, then:
3106 \begin_layout Itemize
3108 \begin_inset Flex Code
3111 \begin_layout Plain Layout
3118 This can be done with
3119 \begin_inset Flex Code
3122 \begin_layout Plain Layout
3123 msgfmt -o xx.mo < xx.po
3131 \begin_layout Itemize
3133 \begin_inset Flex Code
3136 \begin_layout Plain Layout
3142 -file to your locale-tree, at the correct directory for application messages
3147 xx, and under the name
3148 \begin_inset Flex Code
3151 \begin_layout Plain Layout
3158 \begin_inset space \thinspace{}
3162 \begin_inset space \space{}
3166 \begin_inset Flex Code
3169 \begin_layout Plain Layout
3170 /usr/local/share/locale/xx/LC_MESSAGES/lyx.mo
3180 \begin_layout Standard
3181 As said, however, it would be best if the new
3182 \begin_inset Flex Code
3185 \begin_layout Plain Layout
3191 file could be added to the \SpecialChar LyX
3192 distribution, so others can use it.
3193 Adding it involves making additional changes to \SpecialChar LyX
3195 So send an email to the developers' mailing list if you're interested in
3199 \begin_layout Subsubsection
3203 \begin_layout Standard
3204 Sometimes it turns out that one English message needs to be translated into
3205 different messages in the target language.
3206 One example is the message
3207 \begin_inset Flex Code
3210 \begin_layout Plain Layout
3216 which has the German translation
3224 , depending upon exactly what the English
3225 \begin_inset Quotes eld
3229 \begin_inset Quotes erd
3234 \begin_inset Flex Code
3237 \begin_layout Plain Layout
3243 does not handle such ambiguous translations.
3244 Therefore you have to add some context information to the message: Instead
3246 \begin_inset Flex Code
3249 \begin_layout Plain Layout
3256 \begin_inset Flex Code
3259 \begin_layout Plain Layout
3260 To[[as in 'From format x to format y']]
3266 \begin_inset Flex Code
3269 \begin_layout Plain Layout
3270 To[[as in 'From page x to page y']].
3275 Now the two occurrences of
3276 \begin_inset Flex Code
3279 \begin_layout Plain Layout
3286 \begin_inset Flex Code
3289 \begin_layout Plain Layout
3295 and can be translated correctly to
3306 \begin_layout Standard
3307 Of course the context information needs to be stripped off the original
3308 message when no translation is used.
3309 Therefore you have to put it in double square brackets at the end of the
3310 message (see the example above).
3311 The translation mechanism of \SpecialChar LyX
3312 ensures that everything in double square
3313 brackets at the end of messages is removed before displaying the message.
3316 \begin_layout Subsection
3317 Translating the documentation.
3320 \begin_layout Standard
3321 The online documentation (in the
3322 \begin_inset Flex Noun
3325 \begin_layout Plain Layout
3331 -menu) can (and should!) be translated.
3332 If there are translated versions of the documentation available
3336 \begin_layout Plain Layout
3337 As of March 2008, at least some of the documents have been translated into
3338 fourteen languages, with the Tutorial available in a few more.
3343 and the locale is set accordingly, these will be used automagically by
3347 looks for translated versions as
3348 \begin_inset Flex Code
3351 \begin_layout Plain Layout
3352 LyXDir/doc/xx/DocName.lyx
3358 \begin_inset Flex Code
3361 \begin_layout Plain Layout
3367 is the code for the language currently in use.
3368 If there are no translated documents, the default English versions will
3370 Note that the translated versions must have the same filenames (
3371 \begin_inset Flex Code
3374 \begin_layout Plain Layout
3380 above) as the original.
3381 If you feel up to translating the documentation (an excellent way to proof-read
3382 the original documentation by the way!), there are a few things you should
3386 \begin_layout Itemize
3387 Check out the documentation translation web page at
3388 \begin_inset CommandInset href
3390 name "http://www.lyx.org/Translation"
3391 target "http://www.lyx.org/Translation"
3396 That way, you can find out which (if any) documents have already been translate
3397 d into your language.
3398 You can also find out who (if anyone) is organizing the effort to translate
3399 the documentation into your language.
3400 If no one is organizing the effort, please let us know that you're interested.
3403 \begin_layout Standard
3404 Once you get to actually translating, here's a few hints for you that may
3408 \begin_layout Itemize
3409 Join the documentation team! There is information on how to do that in
3410 \begin_inset Flex Code
3413 \begin_layout Plain Layout
3420 \begin_inset Flex Noun
3423 \begin_layout Plain Layout
3424 Help\SpecialChar menuseparator
3430 ), which by the way is the first document you should translate.
3433 \begin_layout Itemize
3434 Learn the typographic conventions for the language you are translating to.
3435 Typography is an ancient art and over the centuries, a great variety of
3436 conventions have developed throughout different parts of the world.
3437 Also study the professional terminology amongst typographers in your country.
3438 Inventing your own terminology will only confuse the users.
3441 (Warning! Typography is addictive!)
3444 \begin_layout Itemize
3445 Make a copy of the document.
3446 This will be your working copy.
3447 You can use this as your personal translated help-file by placing it in
3449 \begin_inset Flex Code
3452 \begin_layout Plain Layout
3459 \begin_inset Note Greyedout
3462 \begin_layout Plain Layout
3467 For a complex document with external material (images, etc.), if you make
3469 \begin_inset space \thinspace{}
3473 \begin_inset space \space{}
3476 in a temp dir, beware that the links to external material may be broken
3477 when the document is moved to a different place.
3478 The best way is to retrieve the \SpecialChar LyX
3480 \begin_inset Flex URL
3483 \begin_layout Plain Layout
3485 http://www.lyx.org/HowToUseGIT
3490 ) and to edit the doc file in place.
3498 \begin_layout Itemize
3499 Sometimes the original document (from the \SpecialChar LyX
3500 team) will be updated.
3501 Use the source viewer at
3502 \begin_inset CommandInset href
3504 name "http://www.lyx.org/trac/timeline"
3505 target "http://www.lyx.org/trac/timeline"
3509 to see what has been changed.
3510 That way you can easily see which parts of the translated document need
3514 \begin_layout Standard
3515 If you ever find an error in the original document, fix it and notify the
3516 rest of the documentation team of the changes! (You didn't forget to join
3517 the documentation team, did you?)
3520 \begin_layout Standard
3521 \begin_inset Branch OutDated
3524 \begin_layout Section
3525 International Keyboard Support
3528 \begin_layout Standard
3531 [Editor's Note: The following section is by
3539 It needs to be fixed to conform to the new Documentation Style sheet and
3540 to make use of the new v1.0 features.
3541 The whole thing also needs to be merged with the section following it.-jw
3542 It may also be badly out of date.-rh (2008)]
3545 \begin_layout Subsection
3546 Defining Own Keymaps: Keymap File Format
3549 \begin_layout Standard
3550 Let's look at a keyboard definition file a little closer.
3551 It is a plain text file defining
3554 \begin_layout Itemize
3555 key-to-key or key-to-string translations
3558 \begin_layout Itemize
3562 \begin_layout Itemize
3563 dead keys exceptions
3566 \begin_layout Standard
3567 To define key-to-key or key-to-string translation, use this command:
3570 \begin_layout Quotation
3571 \begin_inset Flex Code
3574 \begin_layout Plain Layout
3583 \begin_inset Flex Code
3586 \begin_layout Plain Layout
3595 \begin_layout Standard
3597 \begin_inset Flex Code
3600 \begin_layout Plain Layout
3606 is the key to be translated and
3607 \begin_inset Flex Code
3610 \begin_layout Plain Layout
3616 is the string to be inserted into the document.
3617 To define dead keys, use:
3620 \begin_layout Quotation
3621 \begin_inset Flex Code
3624 \begin_layout Plain Layout
3633 \begin_inset Flex Code
3636 \begin_layout Plain Layout
3645 \begin_layout Standard
3647 \begin_inset Flex Code
3650 \begin_layout Plain Layout
3656 is a keyboard key and
3657 \begin_inset Flex Code
3660 \begin_layout Plain Layout
3667 The following dead keys are supported (shortcut name is in parentheses):
3670 \begin_layout Quotation
3674 \begin_inset space \hfill{}
3680 \begin_layout Quotation
3682 \begin_inset space \hfill{}
3688 \begin_layout Quotation
3690 \begin_inset space \hfill{}
3696 \begin_layout Quotation
3698 \begin_inset space \hfill{}
3704 \begin_layout Quotation
3706 \begin_inset space \hfill{}
3712 \begin_layout Quotation
3714 \begin_inset space \hfill{}
3721 \begin_layout Plain Layout
3733 \begin_layout Quotation
3735 \begin_inset space \hfill{}
3741 \begin_layout Quotation
3743 \begin_inset space \hfill{}
3750 \begin_layout Plain Layout
3762 \begin_layout Quotation
3764 \begin_inset space \hfill{}
3770 \begin_layout Quotation
3772 \begin_inset space \hfill{}
3778 \begin_layout Quotation
3780 \begin_inset space \hfill{}
3787 \begin_layout Plain Layout
3799 \begin_layout Quotation
3801 \begin_inset space \hfill{}
3808 \begin_layout Plain Layout
3820 \begin_layout Quotation
3822 \begin_inset space \hfill{}
3828 \begin_layout Quotation
3829 hungarian umlaut (hug)
3830 \begin_inset space \hfill{}
3836 \begin_layout Quotation
3838 \begin_inset space \hfill{}
3844 \begin_layout Quotation
3846 \begin_inset space \hfill{}
3853 \begin_layout Plain Layout
3865 \begin_layout Standard
3866 Since in many international keyboards there are exceptions to what some
3867 dead keys should do, you can define them using
3870 \begin_layout Quotation
3871 \begin_inset Flex Code
3874 \begin_layout Plain Layout
3882 deadkey key outstring
3885 \begin_layout Standard
3886 For example, on Slovak keyboard, if you enter caron-o, it generates circumflex-o
3890 \begin_layout Quotation
3891 \begin_inset Flex Code
3894 \begin_layout Plain Layout
3907 \begin_layout Standard
3908 to make it work correctly.
3909 Also, you have to define as exceptions dead keys over i and j, to remove
3910 the dot from them before inserting an accent mark.
3911 I will change this when the time comes, but so far I haven't had time.
3914 \begin_layout Standard
3915 Oh, and about characters: backslash is escaped, so to enter it, you'll need
3918 \begin_inset Flex Code
3921 \begin_layout Plain Layout
3927 have different meaning.
3929 \begin_inset Flex Code
3932 \begin_layout Plain Layout
3938 marks comments, quotes start and end \SpecialChar LaTeX
3940 To enter quote, you'll need to use
3941 \begin_inset Flex Code
3944 \begin_layout Plain Layout
3953 \begin_inset Flex Code
3956 \begin_layout Plain Layout
3963 \begin_inset Flex Code
3966 \begin_layout Plain Layout
3977 \begin_layout Standard
3978 If you make a keyboard description file that works for your language, please
3979 mail it to me, so I can include it in the next keymap distribution.
3982 \begin_layout Standard
3983 More keywords will be supported in keymap configuration file in future,
3987 \begin_layout Itemize
3988 \begin_inset Flex Code
3991 \begin_layout Plain Layout
4002 \begin_inset space \hfill{}
4006 \begin_inset Flex Code
4009 \begin_layout Plain Layout
4018 \begin_layout Itemize
4019 \begin_inset Flex Code
4022 \begin_layout Plain Layout
4033 \begin_inset space \hfill{}
4037 \begin_inset Flex Code
4040 \begin_layout Plain Layout
4046 an external keymap translation program
4049 \begin_layout Standard
4050 Also, it should look into
4051 \begin_inset Flex Code
4054 \begin_layout Plain Layout
4060 file for defaults, too (for example, a
4061 \begin_inset Flex Code
4064 \begin_layout Plain Layout
4072 option to include default keyboard).
4080 \begin_layout Section
4081 International Keymap Stuff
4082 \begin_inset CommandInset label
4084 name "sec:International-Keymap-Stuff"
4091 \begin_layout Standard
4092 \begin_inset Note Note
4095 \begin_layout Plain Layout
4096 In doing the revisions on this document in March 2008, I did not look over
4097 this stuff, as I do not understand it.
4098 It would be good if someone else could do so.
4107 \begin_layout Standard
4108 The next two sections describe the
4109 \begin_inset Flex Code
4112 \begin_layout Plain Layout
4121 \begin_inset Flex Code
4124 \begin_layout Plain Layout
4132 file syntax in detail.
4133 These sections should help you design your own key map if the ones provided
4134 do not meet your needs.
4137 \begin_layout Subsection
4141 \begin_layout Standard
4145 \begin_inset Flex Code
4148 \begin_layout Plain Layout
4154 file maps keystrokes to characters or strings.
4155 As the name suggests, it sets a keyboard mapping.
4157 \begin_inset Flex Code
4160 \begin_layout Plain Layout
4171 \begin_inset Flex Code
4174 \begin_layout Plain Layout
4189 \begin_inset Flex Code
4192 \begin_layout Plain Layout
4205 \begin_inset Flex Code
4208 \begin_layout Plain Layout
4217 \begin_inset Flex Code
4220 \begin_layout Plain Layout
4228 are described in this section.
4231 \begin_layout Labeling
4232 \labelwidthstring 00.00.0000
4233 \begin_inset Flex Code
4236 \begin_layout Plain Layout
4244 Map a character to a string
4247 \begin_layout LyX-Code
4262 \begin_layout Standard
4295 the double-quote (")
4312 must be escaped with a preceding backslash (
4323 \begin_layout Standard
4325 \begin_inset Flex Noun
4328 \begin_layout Plain Layout
4336 statement to cause the symbol
4337 \begin_inset Flex Noun
4340 \begin_layout Plain Layout
4348 to be output for the keystroke
4349 \begin_inset Flex Noun
4352 \begin_layout Plain Layout
4363 \begin_layout LyX-Code
4369 \begin_layout Labeling
4370 \labelwidthstring 00.00.0000
4371 \begin_inset Flex Code
4374 \begin_layout Plain Layout
4382 Specify an accent character
4385 \begin_layout LyX-Code
4394 \begin_layout Standard
4395 This will make the cha
4433 This is the dead key
4437 \begin_layout Plain Layout
4444 refers to a key that does not produce a character by itself, but when followed
4445 with another key, produces the desired accent character.
4446 For example, a German characte
4448 r with an umlaut like
4458 can be produced in this manner.
4467 \begin_layout Standard
4480 and then another key not in
4497 followed by the other, not allowed key, as output.
4501 \begin_inset Flex Noun
4504 \begin_layout Plain Layout
4512 cancels a dead key, so if
4523 \begin_inset Flex Noun
4526 \begin_layout Plain Layout
4535 , the cursor will not go one position backwards but will instead cancel
4551 might have had on the next keystroke.
4555 \begin_layout Standard
4556 The following example specifies that the character ' is to be an acute accent,
4557 allowed on the characters a, e, i, o, u, A, E, I, O, and U:
4560 \begin_layout LyX-Code
4563 kmod ' acute aeiouAEIOU
4566 \begin_layout Labeling
4567 \labelwidthstring 00.00.0000
4568 \begin_inset Flex Code
4571 \begin_layout Plain Layout
4577 Specify an exception to the accent character
4580 \begin_layout LyX-Code
4589 \begin_layout Standard
4590 This defines an exce
4631 have been assigned a keystroke with a previous
4634 \begin_inset Flex Code
4637 \begin_layout Plain Layout
4661 must not belong in the
4708 If such a declaration does not exist in
4716 \begin_inset Flex Code
4719 \begin_layout Plain Layout
4753 \begin_inset Flex Code
4756 \begin_layout Plain Layout
4770 \begin_layout Standard
4771 The following command produces causes äi to be produced when you enter acute-i
4775 \begin_layout LyX-Code
4789 \begin_layout Labeling
4790 \labelwidthstring 00.00.0000
4791 \begin_inset Flex Code
4794 \begin_layout Plain Layout
4800 Combine two accent characters
4803 \begin_layout LyX-Code
4809 accent1 accent2 allowed
4812 \begin_layout Standard
4813 This one is getting pretty esoteric.
4814 It allows you to combine the effect
4870 \begin_inset Flex Code
4873 \begin_layout Plain Layout
4901 \begin_layout Standard
4902 Consider this example from the
4903 \begin_inset Flex Code
4906 \begin_layout Plain Layout
4917 \begin_layout LyX-Code
4920 kmod ; acute aeioyvhAEIOYVH
4924 kcomb acute umlaut iyIY
4927 \begin_layout Standard
4928 This allows you to press
4929 \begin_inset Flex Noun
4932 \begin_layout Plain Layout
4940 and get the effect of
4941 \begin_inset Flex Code
4944 \begin_layout Plain Layout
4963 in this case cancels the last dead key, so if you press
4964 \begin_inset Flex Noun
4967 \begin_layout Plain Layout
4976 \begin_inset Flex Code
4979 \begin_layout Plain Layout
4992 \begin_layout Subsection
4996 \begin_layout Standard
4998 \begin_inset Flex Code
5001 \begin_layout Plain Layout
5009 mapping is performed, a
5010 \begin_inset Flex Code
5013 \begin_layout Plain Layout
5023 file maps the strings that the symbols generate to characters in the current
5025 The \SpecialChar LyX
5026 distribution currently includes at least the
5027 \begin_inset Flex Code
5030 \begin_layout Plain Layout
5039 \begin_inset Flex Code
5042 \begin_layout Plain Layout
5053 \begin_layout Standard
5055 \begin_inset Flex Code
5058 \begin_layout Plain Layout
5066 file is a sequence of declarations of the form
5069 \begin_layout LyX-Code
5082 \begin_layout Standard
5083 For example, in order to map
5084 \begin_inset Flex Noun
5087 \begin_layout Plain Layout
5097 to the corresponding character in the iso-8859-1 set (233), the following
5101 \begin_layout LyX-Code
5109 \begin_layout Standard
5111 \begin_inset Flex Code
5114 \begin_layout Plain Layout
5123 \begin_inset Flex Code
5126 \begin_layout Plain Layout
5144 the same character can apply to more than one string.
5146 \begin_inset Flex Code
5149 \begin_layout Plain Layout
5160 \begin_layout LyX-Code
5172 \begin_inset Newline newline
5188 \begin_layout Standard
5190 cannot find a mapping for the string produced by the keystroke or a
5191 deadkey sequence, it will check if it looks like an accented char and try
5192 to draw an accent over the character on screen.
5195 \begin_layout Subsection
5199 \begin_layout Standard
5200 There is a second way to add support for international characters through
5201 so-called dead-keys.
5202 A dead-key works in combination with a letter to produce an accented character.
5203 Here, we'll explain how to create a really simple dead-key to illustrate
5207 \begin_layout Standard
5208 Suppose you happen to need the circumflex character,
5209 \begin_inset Quotes eld
5213 \begin_inset Quotes erd
5218 \begin_inset Flex Noun
5221 \begin_layout Plain Layout
5228 \begin_inset space ~
5232 \begin_inset Flex Noun
5235 \begin_layout Plain Layout
5241 ] to the \SpecialChar LyX
5243 \begin_inset Flex Code
5246 \begin_layout Plain Layout
5253 \begin_inset Flex Code
5256 \begin_layout Plain Layout
5263 Now, whenever you type the
5264 \begin_inset Flex Noun
5267 \begin_layout Plain Layout
5273 -key followed by a letter, that letter will have a circumflex accent on
5275 For example, the sequence
5276 \begin_inset Quotes eld
5280 \begin_inset Flex Noun
5283 \begin_layout Plain Layout
5290 \begin_inset Quotes erd
5293 produces the letter:
5294 \begin_inset Quotes eld
5298 \begin_inset Quotes erd
5302 If you tried to type
5303 \begin_inset Quotes eld
5307 \begin_inset Flex Noun
5310 \begin_layout Plain Layout
5317 \begin_inset Quotes erd
5320 , however, \SpecialChar LyX
5321 will complain with a beep, since a
5322 \begin_inset Quotes eld
5326 \begin_inset Flex Noun
5329 \begin_layout Plain Layout
5336 \begin_inset Quotes erd
5339 never takes a circumflex accent.
5341 \begin_inset Flex Noun
5344 \begin_layout Plain Layout
5350 after a dead-key produces the bare-accent.
5351 Please note this last point! If you bind a key to a dead-key, you'll need
5352 to rebind the character on that key to yet another key.
5354 \begin_inset Flex Noun
5357 \begin_layout Plain Layout
5363 to a cedilla is a bad idea, since you'll only get cedillas instead of commas.
5366 \begin_layout Standard
5367 One common way to bind dead-keys is to use
5368 \begin_inset Flex Noun
5371 \begin_layout Plain Layout
5378 \begin_inset Flex Noun
5381 \begin_layout Plain Layout
5388 \begin_inset Flex Noun
5391 \begin_layout Plain Layout
5397 in combination with an accent, like
5398 \begin_inset Quotes eld
5402 \begin_inset Flex Noun
5405 \begin_layout Plain Layout
5412 \begin_inset Quotes erd
5416 \begin_inset Quotes eld
5420 \begin_inset Flex Noun
5423 \begin_layout Plain Layout
5430 \begin_inset Quotes erd
5434 \begin_inset Quotes eld
5438 \begin_inset Flex Noun
5441 \begin_layout Plain Layout
5448 \begin_inset Quotes erd
5452 Another way involves using
5453 \begin_inset Flex Code
5456 \begin_layout Plain Layout
5463 \begin_inset Flex Code
5466 \begin_layout Plain Layout
5472 to set up the special
5473 \begin_inset Flex Code
5476 \begin_layout Plain Layout
5484 \begin_inset Flex Code
5487 \begin_layout Plain Layout
5493 acts in some ways just like
5494 \begin_inset Flex Noun
5497 \begin_layout Plain Layout
5503 and permits you to bind keys to accented characters.
5504 You can also turn keys into dead-keys by binding them to something like
5506 \begin_inset Flex Code
5509 \begin_layout Plain Layout
5515 and then binding this symbolic key to the corresponding \SpecialChar LyX
5520 \begin_layout Plain Layout
5525 : This is exactly what I do in my
5526 \begin_inset Flex Code
5529 \begin_layout Plain Layout
5536 \begin_inset Flex Code
5539 \begin_layout Plain Layout
5547 \begin_inset Flex Noun
5550 \begin_layout Plain Layout
5552 \begin_inset space ~
5561 \begin_inset Flex Code
5564 \begin_layout Plain Layout
5570 and a bunch of these
5571 \begin_inset Quotes eld
5575 \begin_inset Flex Code
5578 \begin_layout Plain Layout
5585 \begin_inset Quotes erd
5588 symbolic keys bound such things as
5589 \begin_inset Flex Noun
5592 \begin_layout Plain Layout
5594 \begin_inset space ~
5603 \begin_inset Flex Noun
5606 \begin_layout Plain Layout
5608 \begin_inset space ~
5617 This is how I produce my accented characters.
5622 You can make just about anything into the
5623 \begin_inset Flex Code
5626 \begin_layout Plain Layout
5633 \begin_inset Flex Noun
5636 \begin_layout Plain Layout
5642 keys, a spare function key, etc.
5643 As for the \SpecialChar LyX
5644 commands that produce accents, check the entry for
5645 \begin_inset Flex Code
5648 \begin_layout Plain Layout
5659 You'll find the complete list there.
5662 \begin_layout Subsection
5663 Saving your Language Configuration
5666 \begin_layout Standard
5667 You can edit your preferences so that your desired language environment
5668 is automatically configured when \SpecialChar LyX
5670 \begin_inset Flex Noun
5673 \begin_layout Plain Layout
5674 Edit\SpecialChar menuseparator
5683 \begin_layout Chapter
5684 Installing New Document Classes, Layouts, and Templates
5685 \begin_inset CommandInset label
5687 name "cha:Installing-New-Document"
5692 \begin_inset Argument 1
5695 \begin_layout Plain Layout
5696 Installing New Document Classes
5704 \begin_layout Standard
5705 In this chapter, we describe the procedures for creating and installing
5706 new \SpecialChar LyX
5707 layout and template files, as well as offer a refresher on correctly
5708 installing new \SpecialChar LaTeX
5713 \begin_layout Standard
5714 First, let us a say a few words about how one ought to think about the relation
5715 between \SpecialChar LyX
5716 and \SpecialChar LaTeX
5718 The thing to understand is that, in a certain sense, \SpecialChar LyX
5719 doesn't know anything
5720 about \SpecialChar LaTeX
5722 Indeed, from \SpecialChar LyX
5723 's point of view, \SpecialChar LaTeX
5724 is just one of several
5725 \begin_inset Quotes eld
5729 \begin_inset Quotes erd
5732 in which it is capable of producing output.
5733 Other such formats are DocBook, plaintext, and XHTML.
5735 is, of course, a particularly important format, but very little of the
5736 information \SpecialChar LyX
5737 has about \SpecialChar LaTeX
5738 is actually contained in the program itself.
5742 \begin_layout Plain Layout
5743 Some commands are sufficiently complex that they are
5744 \begin_inset Quotes eld
5748 \begin_inset Quotes erd
5751 into \SpecialChar LyX
5753 But the developers generally regard this as a Bad Thing.
5758 Rather, that information, even for the standard classes like
5759 \begin_inset Flex Code
5762 \begin_layout Plain Layout
5768 , is contained in `layout files'.
5769 Similarly, \SpecialChar LyX
5770 itself does not know much about DocBook or XHTML.
5771 What it knows is contained in layout files.
5774 \begin_layout Standard
5775 You can think of the layout file for a given document class as a translation
5776 manual between \SpecialChar LyX
5777 constructs—paragraphs with their corresponding styles,
5778 certain sorts of insets, etc—and the corresponding \SpecialChar LaTeX
5781 Almost everything \SpecialChar LyX
5783 \begin_inset Flex Code
5786 \begin_layout Plain Layout
5792 , for example, is contained in the file
5793 \begin_inset Flex Code
5796 \begin_layout Plain Layout
5802 and in various other files it includes.
5803 For this reason, anyone intending to write layout files should plan to
5804 study the existing files.
5805 A good place to start is with
5806 \begin_inset Flex Code
5809 \begin_layout Plain Layout
5815 , which is included in
5816 \begin_inset Flex Code
5819 \begin_layout Plain Layout
5826 \begin_inset Flex Code
5829 \begin_layout Plain Layout
5835 , and many of the other layout files for document classes.
5836 This file is where sections and the like are defined:
5837 \begin_inset Flex Code
5840 \begin_layout Plain Layout
5846 tells \SpecialChar LyX
5847 how paragraphs that are marked with the Section, Subsection, etc,
5848 styles can be translated into corresponding \SpecialChar LaTeX
5849 , DocBook, and XHTML commands
5852 \begin_inset Flex Code
5855 \begin_layout Plain Layout
5861 file basically just includes several of these
5862 \begin_inset Flex Code
5865 \begin_layout Plain Layout
5874 \begin_layout Standard
5875 Defining the \SpecialChar LyX
5877 correspondence is not the only thing layout files do, though.
5878 Their other job is to define how the \SpecialChar LyX
5879 constructs themselves will appear
5881 The fact that layout files have these two jobs is often a source of confusion,
5882 because they are completely separate.
5883 Telling \SpecialChar LyX
5884 how to translate a certain paragraph style into \SpecialChar LaTeX
5887 how to display it; conversely, telling \SpecialChar LyX
5888 how to display a certain paragraph
5889 style does not tell \SpecialChar LyX
5890 how to translate it into \SpecialChar LaTeX
5891 (let alone tell \SpecialChar LaTeX
5894 So, in general, when you define a new \SpecialChar LyX
5895 construct, you must always do two
5896 quite separate things: (i)
5897 \begin_inset space ~
5900 tell \SpecialChar LyX
5901 how to translate it into \SpecialChar LaTeX
5903 \begin_inset space ~
5906 tell \SpecialChar LyX
5910 \begin_layout Standard
5911 Much the same is true, of course, as regards \SpecialChar LyX
5912 's other backend formats, though
5913 XHTML is in some ways different, because in that case \SpecialChar LyX
5918 able, to some extent, to use information about how it should display a
5919 paragraph on the screen to output information (in the form of CSS) about
5920 how the paragraph should be displayed in a browser.
5921 Even in this case, however, the distinction between what \SpecialChar LyX
5923 and how things are rendered externally remains in force, and the two can
5924 be controlled separately.
5926 \begin_inset CommandInset ref
5928 reference "sec:Tags-for-XHTML"
5935 \begin_layout Section
5936 Installing new \SpecialChar LaTeX
5940 \begin_layout Standard
5941 Some installations may not include a \SpecialChar LaTeX
5942 package or class file that you would
5943 like to use within \SpecialChar LyX
5945 For example, you might need Foil\SpecialChar TeX
5946 , a package for preparing slides for overhead
5948 Modern \SpecialChar LaTeX
5949 distributions like \SpecialChar TeX
5950 Live (2008 or newer) or MiK\SpecialChar TeX
5951 provide a user interface
5952 for installing such packages.
5953 For example, with MiK\SpecialChar TeX
5954 , you start the program
5955 \begin_inset Quotes eld
5959 \begin_inset space ~
5963 \begin_inset Quotes erd
5966 to get a list of available packages.
5967 To install one of them, right click on it or use the corresponding toolbar
5971 \begin_layout Standard
5972 If your \SpecialChar LaTeX
5973 distribution does not provide such a `package manager', or if the
5974 package is not available from your distribution, then follow these steps
5975 to install it manually:
5978 \begin_layout Enumerate
5979 Get the package from
5980 \begin_inset CommandInset href
5983 target "http://www.ctan.org/"
5990 \begin_layout Enumerate
5991 If the package contains a file with the ending
5992 \begin_inset Quotes eld
5996 \begin_inset Flex Code
5999 \begin_layout Plain Layout
6006 \begin_inset Quotes erd
6009 (is the case for Foil\SpecialChar TeX
6010 ) then open a console, change to the folder of this
6011 file and execute the command
6012 \begin_inset Flex Code
6015 \begin_layout Plain Layout
6022 You have now unpacked the package and have all files to install it.
6023 Most \SpecialChar LaTeX
6024 -packages are not packed and you can skip this step.
6027 \begin_layout Enumerate
6028 Now you need to decide if the package should be available for all users
6033 \begin_layout Enumerate
6034 On *nix systems (Linux, OSX, etc.), if you want the new package to be available
6035 for all users on your system, then install it in your `local' \SpecialChar TeX
6037 install it in your own `user' \SpecialChar TeX
6039 Where these trees should be created, if they do not already exist, depends
6041 To find this out, look in the file
6042 \begin_inset Flex Code
6045 \begin_layout Plain Layout
6055 \begin_layout Plain Layout
6056 This is usually in the directory
6057 \begin_inset Flex Code
6060 \begin_layout Plain Layout
6066 , though you can execute the command
6067 \begin_inset Flex Code
6070 \begin_layout Plain Layout
6081 The location of the `local' \SpecialChar TeX
6082 tree is defined by the
6083 \begin_inset Flex Code
6086 \begin_layout Plain Layout
6092 variable; this is usually somewhere like
6093 \begin_inset Flex Code
6096 \begin_layout Plain Layout
6097 /usr/local/share/texmf
6102 or /usr/local/texlive/XXXX where XXXX is the year of the installed \SpecialChar TeX
6105 The location of the `user' \SpecialChar TeX
6107 \begin_inset Flex Code
6110 \begin_layout Plain Layout
6117 \begin_inset Flex Code
6120 \begin_layout Plain Layout
6127 \begin_inset Flex Code
6130 \begin_layout Plain Layout
6140 (If these variables are not predefined, you have to define them.) You'll
6141 probably need root permissions to create or modify the `local' tree, but
6142 not for your `user' tree.
6143 \begin_inset Newline newline
6146 In general, it is recommended to install in the user tree because your user
6147 will not be modified or even overwritten when you upgrade your system.
6148 It will typically also be backed up together with everything else when
6149 you backup your home directory (which, of course, you do on a regular basis).
6152 \begin_layout Enumerate
6153 On Windows, if you want the new package to be available for all users on
6154 your system, change to the folder where \SpecialChar LaTeX
6155 is installed and then change to
6157 \begin_inset Flex Code
6160 \begin_layout Plain Layout
6171 (For MiK\SpecialChar TeX
6172 , this would be by default the folder
6173 \begin_inset Flex Code
6176 \begin_layout Plain Layout
6194 \begin_layout Plain Layout
6195 Note that this will be the correct path only on English installations.
6196 On a German one, it would be
6197 \begin_inset Flex Code
6200 \begin_layout Plain Layout
6214 , and similarly for other languages.
6219 Create there a new folder
6220 \begin_inset Flex Code
6223 \begin_layout Plain Layout
6229 and copy all files of the package into it.
6231 \begin_inset Newline newline
6234 If the package should only available for you or you don't have admin permissions
6235 , do the same, but in the local \SpecialChar LaTeX
6238 \begin_inset space \thinspace{}
6241 g., for MiK\SpecialChar TeX
6243 \begin_inset space ~
6246 2.8 under Windows XP, this would be the folder:
6247 \begin_inset Newline newline
6253 \begin_inset Flex Code
6256 \begin_layout Plain Layout
6259 Documents and Settings
6271 \begin_inset Newline newline
6277 \begin_inset Phantom HPhantom
6280 \begin_layout Plain Layout
6291 \begin_inset Flex Code
6294 \begin_layout Plain Layout
6307 \begin_inset Newline newline
6310 On Vista, it would be:
6311 \begin_inset Newline newline
6315 \begin_inset Flex Code
6318 \begin_layout Plain Layout
6344 \begin_layout Enumerate
6345 Now one only need to tell \SpecialChar LaTeX
6346 that there are new files.
6347 This depends on the used \SpecialChar LaTeX
6352 \begin_layout Enumerate
6353 For \SpecialChar TeX
6354 Live execute the command
6355 \begin_inset Flex Code
6358 \begin_layout Plain Layout
6365 If you installed the package for all users, then you will probably need
6366 to have root permissions for that.
6369 \begin_layout Enumerate
6370 For MiK\SpecialChar TeX
6371 , if you have installed the package for all users, start the program
6373 \begin_inset Quotes eld
6377 \begin_inset space ~
6381 \begin_inset Quotes erd
6384 and press the button marked
6385 \begin_inset Quotes eld
6389 \begin_inset Quotes erd
6393 Otherwise start the program
6394 \begin_inset Quotes eld
6398 \begin_inset Quotes erd
6405 \begin_layout Enumerate
6406 Finally, you need to tell \SpecialChar LyX
6407 that there are new packages available.
6408 So, in \SpecialChar LyX
6410 \begin_inset Flex Noun
6413 \begin_layout Plain Layout
6416 \SpecialChar menuseparator
6422 and then restart \SpecialChar LyX
6426 \begin_layout Standard
6427 Now the package is installed.
6428 In our example, the document class
6429 \begin_inset Flex Code
6432 \begin_layout Plain Layout
6434 \begin_inset space ~
6442 will now be available under
6443 \begin_inset Flex Noun
6446 \begin_layout Plain Layout
6447 Document\SpecialChar menuseparator
6448 Settings\SpecialChar menuseparator
6458 \begin_layout Standard
6459 If you would like to use a \SpecialChar LaTeX
6460 document class that is not even listed in the
6462 \begin_inset Flex Noun
6465 \begin_layout Plain Layout
6466 Document\SpecialChar menuseparator
6467 Settings\SpecialChar menuseparator
6473 , then you need to create a `layout' file for it.
6474 That is the topic of the next section.
6477 \begin_layout Section
6478 Types of layout files
6481 \begin_layout Standard
6482 This section describes the various sorts of \SpecialChar LyX
6483 files that contain layout informati
6485 These files describe various paragraph and character styles, determining
6486 how \SpecialChar LyX
6487 should display them and how they should be translated into \SpecialChar LaTeX
6489 XHTML, or whatever output format is being used.
6493 \begin_layout Standard
6494 We shall try to provide a thorough description of the process of writing
6496 However, there are so many different types of documents supported even
6497 by just \SpecialChar LaTeX
6498 that we can't hope to cover every different possibility or problem
6499 you might encounter.
6500 The \SpecialChar LyX
6501 users' list is frequented by people with lots of experience with layout
6502 design who are willing to share what they've learned, so please feel free
6503 to ask questions there.
6506 \begin_layout Standard
6507 As you prepare to write a new layout, it is extremely helpful to look at
6508 the layouts distributed with \SpecialChar LyX
6510 If you write a \SpecialChar LyX
6511 layout for a \SpecialChar LaTeX
6512 document class that might also be used by
6513 others, or write a module that might be useful to others, then you should
6514 consider posting your layout to the
6515 \begin_inset CommandInset href
6517 name "layout section on the LyX wiki"
6518 target "http://wiki.lyx.org/Layouts/Layouts"
6522 or even to the \SpecialChar LyX
6523 developers' list, so that it might be included in \SpecialChar LyX
6528 \begin_layout Plain Layout
6529 Note that \SpecialChar LyX
6530 is licensed under the General Public License, so any material
6531 that is contributed to \SpecialChar LyX
6532 must be similarly licensed.
6540 \begin_layout Subsection
6542 \begin_inset CommandInset label
6544 name "subsec:Layout-modules"
6551 \begin_layout Standard
6552 We have spoken to this point about `layout files'.
6553 But there are different sorts of files that contain layout information.
6554 Layout files, strictly so called, have the
6555 \begin_inset Flex Code
6558 \begin_layout Plain Layout
6564 extension and provide \SpecialChar LyX
6565 with information about document classes.
6566 Since \SpecialChar LyX
6567 1.6 layout information can also be contained in layout
6572 \begin_inset Flex Code
6575 \begin_layout Plain Layout
6582 Modules are to \SpecialChar LaTeX
6583 packages much as layouts are to \SpecialChar LaTeX
6584 classes, and some modules—such
6586 \begin_inset Flex Code
6589 \begin_layout Plain Layout
6595 module—specifically provide support for one package.
6596 In a sense, layout modules are similar to included
6600 \begin_layout Plain Layout
6601 These can have any extension, but by convention have the
6602 \begin_inset Flex Code
6605 \begin_layout Plain Layout
6617 \begin_inset Flex Code
6620 \begin_layout Plain Layout
6626 —in that modules are not specific to a given document class but may be used
6627 with many different classes.
6628 The difference is that using an included file with
6629 \begin_inset Flex Code
6632 \begin_layout Plain Layout
6638 requires editing that file.
6639 Modules, by contrast, are selected in the
6640 \begin_inset Flex Noun
6643 \begin_layout Plain Layout
6644 Document\SpecialChar menuseparator
6653 \begin_layout Standard
6654 Building modules is the easiest way to get started with layout editing,
6655 since it can be as simple as adding a single new paragraph style or flex
6657 But modules may, in principle, contain anything a layout file can contain.
6660 \begin_layout Standard
6661 After creating a new module and copying it to the
6662 \begin_inset Flex Code
6665 \begin_layout Plain Layout
6671 folder, you will need to reconfigure and then restart \SpecialChar LyX
6674 However, changes you make to the module will be seen immediately, if you
6676 \begin_inset Flex Noun
6679 \begin_layout Plain Layout
6680 Document\SpecialChar menuseparator
6686 , highlight something, and then hit
6687 \begin_inset Quotes eld
6691 \begin_inset Quotes erd
6697 It is strongly recommended that you save your work before doing this
6702 it is strongly recommended that you not attempt to edit modules while simultaneo
6703 usly working on actual documents
6706 Though of course the developers strive to keep \SpecialChar LyX
6707 stable in such situations,
6708 syntax errors and the like in your module file could cause strange behavior.
6711 \begin_layout Subsubsection
6715 \begin_layout Standard
6716 Modules are to \SpecialChar LyX
6717 as packages are to \SpecialChar LaTeX
6719 Sometimes, however, you find yourself wanting a specific inset or character
6720 style just for one document and writing a module that will also be available
6721 to other documents makes little sense.
6722 What you need is \SpecialChar LyX
6724 \begin_inset Quotes eld
6728 \begin_inset Quotes erd
6734 \begin_layout Standard
6735 You will find it under
6737 Document\SpecialChar menuseparator
6738 Settings\SpecialChar menuseparator
6742 The large text box allows you to enter anything that you might enter in
6743 a layout file or module.
6744 You can think of a document's local layout, in fact, as a module that belongs
6746 So, in particular, you must enter a
6747 \begin_inset Flex Code
6750 \begin_layout Plain Layout
6757 Any format is acceptable, but one would normally use the format current
6759 (In \SpecialChar LyX
6760 2.2, the current layout format is 60.)
6763 \begin_layout Standard
6764 When you have entered something in the
6765 \begin_inset Flex Code
6768 \begin_layout Plain Layout
6774 pane, \SpecialChar LyX
6776 \begin_inset Quotes eld
6780 \begin_inset Quotes erd
6783 button at the bottom.
6784 Clicking this button will cause \SpecialChar LyX
6785 to determine whether what you have entered
6786 is valid layout information for the chosen format.
6788 will report the result but, unfortunately, will not tell you what errors
6789 there might have been.
6790 These will be written to the terminal, however, if \SpecialChar LyX
6791 is started from a terminal.
6792 You will not be permitted to save your local layout until you have entered
6796 \begin_layout Standard
6797 The warnings at the end of the previous section apply here, too.
6798 Do not play with local layout while you are actually working, especially
6799 if you have not saved your document.
6800 That said, using local layout with a test document can be a very convenient
6801 way to try out layout ideas, or even to start developing a module.
6804 \begin_layout Subsection
6806 \begin_inset Flex Noun
6809 \begin_layout Plain Layout
6818 \begin_layout Standard
6819 There are two situations you are likely to encounter when wanting to support
6820 a new \SpecialChar LaTeX
6821 document class, involving style (
6822 \begin_inset Flex Code
6825 \begin_layout Plain Layout
6831 ) files and \SpecialChar LaTeX2e
6833 \begin_inset Flex Code
6836 \begin_layout Plain Layout
6843 Supporting a style file is usually fairly easy.
6844 Supporting a new class file is a bit harder.
6845 We'll discuss the former in this section and the latter in the next.
6846 Similar remarks apply, of course, if you want to support a new DocBook
6850 \begin_layout Standard
6851 The easier case is the one in which your new document class is provided
6852 as a style file that is to be used in conjunction with an already supported
6854 For the sake of the example, we'll assume that the style file is called
6856 \begin_inset Flex Noun
6859 \begin_layout Plain Layout
6865 and that it is meant to be used with
6866 \begin_inset Flex Noun
6869 \begin_layout Plain Layout
6875 , which is a standard class.
6879 \begin_layout Standard
6880 Start by copying the existing class's layout file into your local directory:
6884 \begin_layout Plain Layout
6885 Of course, which directory is your local directory will vary by platform,
6886 and \SpecialChar LyX
6887 allows you to specify your local directory on startup, too, using
6889 \begin_inset Flex Code
6892 \begin_layout Plain Layout
6906 \begin_layout LyX-Code
6907 cp report.layout ~/.lyx/layouts/myclass.layout
6910 \begin_layout Standard
6912 \begin_inset Flex Code
6915 \begin_layout Plain Layout
6921 and change the line:
6924 \begin_layout LyX-Code
6927 DeclareLaTeXClass{report}
6930 \begin_layout Standard
6934 \begin_layout LyX-Code
6937 DeclareLaTeXClass[report, myclass.sty]{report (myclass)}
6940 \begin_layout Standard
6944 \begin_layout LyX-Code
6946 \begin_inset Newline newline
6952 \begin_inset Newline newline
6958 \begin_layout Standard
6959 near the top of the file.
6962 \begin_layout Standard
6963 Start \SpecialChar LyX
6965 \begin_inset Flex Noun
6968 \begin_layout Plain Layout
6969 Tools\SpecialChar menuseparator
6976 Then restart \SpecialChar LyX
6977 and try creating a new document.
6979 \begin_inset Flex Noun
6982 \begin_layout Plain Layout
6988 " as a document class option in the
6989 \begin_inset Flex Noun
6992 \begin_layout Plain Layout
6993 Document\SpecialChar menuseparator
7000 It is likely that some of the sectioning commands and such in your new
7001 class will work differently from how they worked in the base class—
7002 \begin_inset Flex Code
7005 \begin_layout Plain Layout
7011 in this example—so you can fiddle around with the settings for the different
7012 sections if you wish.
7013 The layout information for sections is contained in
7014 \begin_inset Flex Code
7017 \begin_layout Plain Layout
7023 , but you do not need to copy and change this file.
7024 Instead, you can simply add your changes to your layout file, after the
7026 \begin_inset Flex Code
7029 \begin_layout Plain Layout
7035 , which itself includes
7036 \begin_inset Flex Code
7039 \begin_layout Plain Layout
7046 For example, you might add these lines:
7049 \begin_layout LyX-Code
7053 \begin_layout LyX-Code
7057 \begin_layout LyX-Code
7061 \begin_layout LyX-Code
7065 \begin_layout LyX-Code
7069 \begin_layout Standard
7070 to change the font for chapter headings to sans-serif.
7071 This will override (or, in this case, add to) the existing declaration
7072 for the Chapter style.
7076 \begin_layout Standard
7077 Your new package may also provide commands or environments not present in
7079 In this case, you will want to add these to the layout file.
7081 \begin_inset CommandInset ref
7083 reference "sec:TextClass"
7087 for information on how to do so.
7090 \begin_layout Standard
7092 \begin_inset Flex Noun
7095 \begin_layout Plain Layout
7101 can be used with several different document classes, and even if it cannot,
7102 you might find it easiest just to write a module that you can load with
7104 The simplest possible such module would be:
7107 \begin_layout LyX-Code
7110 DeclareLyXModule{My Package}
7113 \begin_layout LyX-Code
7117 \begin_layout LyX-Code
7118 #Support for mypkg.sty.
7121 \begin_layout LyX-Code
7123 \begin_inset Newline newline
7129 \begin_layout LyX-Code
7131 \begin_inset Newline newline
7137 \begin_layout LyX-Code
7139 \begin_inset Newline newline
7145 \begin_inset Newline newline
7151 \begin_layout Standard
7152 A more complex module might modify the behavior of some existing constructs
7153 or define some new ones.
7155 \begin_inset CommandInset ref
7157 reference "sec:TextClass"
7164 \begin_layout Subsection
7166 \begin_inset Flex Noun
7169 \begin_layout Plain Layout
7178 \begin_layout Standard
7179 There are two possibilities here.
7180 One is that the class file is itself based upon an existing document class.
7181 For example, many thesis classes are based upon
7182 \begin_inset Flex Noun
7185 \begin_layout Plain Layout
7192 To see whether yours is, look for a line like
7195 \begin_layout LyX-Code
7201 \begin_layout Standard
7203 If so, then you may proceed largely as in the previous section, though
7205 \begin_inset Flex Code
7208 \begin_layout Plain Layout
7209 Declare\SpecialChar LaTeX
7215 line will be different.
7216 If your new class is
7217 \begin_inset Flex Code
7220 \begin_layout Plain Layout
7226 and it is based upon
7227 \begin_inset Flex Code
7230 \begin_layout Plain Layout
7236 , then the line should read:
7240 \begin_layout Plain Layout
7241 And it will be easiest if you save the file to
7242 \begin_inset Flex Code
7245 \begin_layout Plain Layout
7252 assumes that the document class has the same name as the layout file.
7261 \begin_layout LyX-Code
7264 DeclareLaTeXClass[thesis,book]{thesis}
7267 \begin_layout Standard
7268 If, on the other hand, the new class is not based upon an existing class,
7269 you will probably have to
7270 \begin_inset Quotes eld
7274 \begin_inset Quotes erd
7278 We strongly suggest copying an existing layout file which uses a similar
7280 class and then modifying it, if you can do so.
7281 At least use an existing file as a starting point so you can find out what
7282 items you need to worry about.
7283 Again, the specifics are covered below.
7286 \begin_layout Subsection
7288 \begin_inset CommandInset label
7290 name "subsec:Creating-Templates"
7297 \begin_layout Standard
7298 Once you have written a layout file for a new document class, you might
7299 want to consider writing a
7304 A template acts as a kind of tutorial for your layout, showing how it might
7305 be used, though containing dummy content.
7306 You can of course look at the various templates included with \SpecialChar LyX
7310 \begin_layout Standard
7311 Templates are created just like usual documents: using \SpecialChar LyX
7313 The only difference is that usual documents contain all possible settings,
7314 including the font scheme and the paper size.
7315 Usually a user doesn't want a template to overwrite his preferred settings
7316 for such parameters.
7317 For that reason, the designer of a template should remove the corresponding
7319 \begin_inset Flex Code
7322 \begin_layout Plain Layout
7331 \begin_inset Flex Code
7334 \begin_layout Plain Layout
7342 from the template \SpecialChar LyX
7344 This can be done with any simple text-editor, for example
7345 \begin_inset Flex Code
7348 \begin_layout Plain Layout
7355 \begin_inset Flex Code
7358 \begin_layout Plain Layout
7367 \begin_layout Standard
7368 Put the edited template files you create in
7369 \begin_inset Flex Code
7372 \begin_layout Plain Layout
7378 , copy the ones you use from the global template directory in
7379 \begin_inset Flex Code
7382 \begin_layout Plain Layout
7388 to the same place, and redefine the template path in the
7389 \begin_inset Flex Noun
7392 \begin_layout Plain Layout
7393 Tools\SpecialChar menuseparator
7394 Preferences\SpecialChar menuseparator
7403 \begin_layout Standard
7404 Note, by the way, that there is a template which has a particular meaning:
7406 \begin_inset Flex Code
7409 \begin_layout Plain Layout
7416 This template is loaded every time you create a new document with
7417 \begin_inset Flex Noun
7420 \begin_layout Plain Layout
7421 File\SpecialChar menuseparator
7427 in order to provide useful defaults.
7428 To create this template from inside \SpecialChar LyX
7429 , all you have to do is to open a document
7430 with the correct settings, and use the
7431 \begin_inset Flex Noun
7434 \begin_layout Plain Layout
7435 Save as Document Defaults
7443 \begin_layout Subsection
7444 Upgrading old layout files
7447 \begin_layout Standard
7448 The format of layout files changes with each \SpecialChar LyX
7449 release, so old layout files
7450 need to be converted to the new format.
7452 reads a layout file in an older format, it automatically calls the
7454 \begin_inset Flex Code
7457 \begin_layout Plain Layout
7463 to convert it to a temporary file in current format.
7464 The original file is left untouched.
7465 If you use the layout file often, then, you may want to convert it permanently,
7466 so that \SpecialChar LyX
7467 does not have to do so itself every time.
7468 To do this, you can call the converter manually:
7471 \begin_layout Enumerate
7473 \begin_inset Flex Code
7476 \begin_layout Plain Layout
7483 \begin_inset Flex Code
7486 \begin_layout Plain Layout
7495 \begin_layout Enumerate
7497 \begin_inset Newline newline
7501 \begin_inset Flex Code
7504 \begin_layout Plain Layout
7505 python LyXDir/scripts/layout2layout.py myclass.old myclass.layout
7511 \begin_inset Newline newline
7515 \begin_inset Flex Code
7518 \begin_layout Plain Layout
7524 is the name of your \SpecialChar LyX
7528 \begin_layout Standard
7529 Note that manual conversion does not affect included files, so these will
7530 have to be converted separately.
7533 \begin_layout Section
7534 \begin_inset CommandInset label
7536 name "sec:TextClass"
7540 The layout file format
7543 \begin_layout Standard
7544 The following sections describe how layout files are structured and written.
7545 Our advice is to go slowly, save and test often.
7546 It is really not that hard, except that the multitude of options can become
7547 overwhelming, especially if you try to check out too many at once.
7548 It becomes easier if you use existing layouts of \SpecialChar LyX
7549 as examples/reference
7550 or if you modify an existing layout to your needs.
7553 \begin_layout Standard
7554 Note that all the tags used in layout files are case-insensitive.
7556 \begin_inset Flex Code
7559 \begin_layout Plain Layout
7566 \begin_inset Flex Code
7569 \begin_layout Plain Layout
7576 \begin_inset Flex Code
7579 \begin_layout Plain Layout
7585 are really the same tag.
7586 The possible arguments are printed in brackets after the tag's name.
7587 The default argument is typeset
7588 \begin_inset Flex Code
7591 \begin_layout Plain Layout
7600 If the argument has a data type like
7601 \begin_inset Quotes eld
7605 \begin_inset Quotes erd
7609 \begin_inset Quotes eld
7613 \begin_inset Quotes erd
7616 , the default is shown like this:
7617 \begin_inset Flex Code
7620 \begin_layout Plain Layout
7631 \begin_layout Subsection
7632 The document class declaration and classification
7635 \begin_layout Standard
7636 Lines in a layout file which begin with
7637 \begin_inset Flex Code
7640 \begin_layout Plain Layout
7647 There is one exception to this rule.
7649 \begin_inset Flex Code
7652 \begin_layout Plain Layout
7658 files should begin with lines like:
7661 \begin_layout LyX-Code
7664 #% Do not delete the line below; configure depends on this
7667 \begin_layout LyX-Code
7672 DeclareLaTeXClass{Article (Standard Class)}
7675 \begin_layout LyX-Code
7680 DeclareCategory{Articles}
7683 \begin_layout Standard
7684 The second and third lines are used when you (re)configure \SpecialChar LyX
7686 The layout file is read by the \SpecialChar LaTeX
7688 \begin_inset Flex Code
7691 \begin_layout Plain Layout
7697 , in a special mode where
7698 \begin_inset Flex Code
7701 \begin_layout Plain Layout
7708 The first line is just a \SpecialChar LaTeX
7709 comment, the second one contains the mandatory
7710 declaration of the text class and the third line contains the optional
7711 classification of the class.
7712 If these lines appear in a file named
7713 \begin_inset Flex Code
7716 \begin_layout Plain Layout
7722 , then they define a text class of name
7723 \begin_inset Flex Code
7726 \begin_layout Plain Layout
7732 (the name of the layout file) which uses the \SpecialChar LaTeX
7734 \begin_inset Flex Code
7737 \begin_layout Plain Layout
7743 (the default is to use the same name as the layout).
7745 \begin_inset Quotes eld
7748 Article (Standard Class)
7749 \begin_inset Quotes erd
7752 that appears above is used as a description of the text class in the
7753 \begin_inset Flex Noun
7756 \begin_layout Plain Layout
7757 Document\SpecialChar menuseparator
7765 \begin_inset Quotes eld
7769 \begin_inset Quotes erd
7772 in the example) is also used in the
7773 \begin_inset Flex Noun
7776 \begin_layout Plain Layout
7777 Document\SpecialChar menuseparator
7783 dialog: the text classes are grouped by these categories (which are usually
7784 genres, so typical categories are
7785 \begin_inset Quotes eld
7789 \begin_inset Quotes erd
7793 \begin_inset Quotes eld
7797 \begin_inset Quotes erd
7801 \begin_inset Quotes eld
7805 \begin_inset Quotes erd
7809 \begin_inset Quotes eld
7813 \begin_inset Quotes erd
7817 \begin_inset Quotes eld
7821 \begin_inset Quotes erd
7825 \begin_inset Quotes eld
7829 \begin_inset Quotes erd
7833 If no category has been declared, the class will be put in the
7834 \begin_inset Quotes eld
7838 \begin_inset Quotes erd
7844 \begin_layout Standard
7845 Let's assume that you wrote your own text class that uses the
7846 \begin_inset Flex Code
7849 \begin_layout Plain Layout
7855 document class, but where you changed the appearance of the section headings.
7856 If you put it in a file
7857 \begin_inset Flex Code
7860 \begin_layout Plain Layout
7866 , the header of this file should be:
7869 \begin_layout LyX-Code
7872 #% Do not delete the line below; configure depends on this
7875 \begin_layout LyX-Code
7880 DeclareLaTeXClass[article]{Article (with My Own Headings)}
7883 \begin_layout LyX-Code
7888 DeclareCategory{Articles}
7891 \begin_layout Standard
7892 This declares a text class
7893 \begin_inset Flex Code
7896 \begin_layout Plain Layout
7902 , associated with the \SpecialChar LaTeX
7904 \begin_inset Flex Code
7907 \begin_layout Plain Layout
7914 \begin_inset Quotes eld
7917 Article (with My Own Headings)
7918 \begin_inset Quotes erd
7922 If your text class depends on several packages, you can declare it as:
7925 \begin_layout LyX-Code
7928 #% Do not delete the line below; configure depends on this
7931 \begin_layout LyX-Code
7936 DeclareLaTeXClass[article,foo.sty]{Article (with My Own Headings)}
7939 \begin_layout LyX-Code
7944 DeclareCategory{Articles}
7947 \begin_layout Standard
7948 This indicates that your text class uses the
7949 \begin_inset Flex Code
7952 \begin_layout Plain Layout
7959 Finally, it is also possible to declare classes for DocBook code.
7960 Typical declarations will look like:
7963 \begin_layout LyX-Code
7966 #% Do not delete the line below; configure depends on this
7969 \begin_layout LyX-Code
7974 DeclareDocBookClass[article]{SGML (DocBook Article)}
7977 \begin_layout LyX-Code
7982 DeclareCategory{Articles (DocBook)}
7985 \begin_layout Standard
7986 Note that these declarations can also be given an optional parameter declaring
7987 the name of the document class (but not a list).
7990 \begin_layout Standard
7991 So, to be as explicit as possible, the form of the layout declaration is:
7994 \begin_layout LyX-Code
7999 DeclareLaTeXClass[class,package.sty]{layout description}
8002 \begin_layout LyX-Code
8007 DeclareCategory{category}
8010 \begin_layout Standard
8011 The class need only be specified if the name of the \SpecialChar LaTeX
8013 name of the layout file are different or if there are packages to load.
8014 If the name of the class file is not specified, then \SpecialChar LyX
8016 that it is the same as the name of the layout file.
8019 \begin_layout Standard
8020 When the text class has been modified to your taste, all you have to do
8021 is to copy it either to
8022 \begin_inset Flex Code
8025 \begin_layout Plain Layout
8032 \begin_inset Flex Code
8035 \begin_layout Plain Layout
8042 \begin_inset Flex Noun
8045 \begin_layout Plain Layout
8046 Tools\SpecialChar menuseparator
8052 , exit \SpecialChar LyX
8054 Then your new text class should be available along with the others.
8057 \begin_layout Standard
8058 Once the layout file is installed, you can edit it and see your changes
8059 without having to reconfigure or to restart \SpecialChar LyX
8065 \begin_layout Plain Layout
8066 In versions of \SpecialChar LyX
8067 prior to 1.6, this was not true.
8068 As a result, editing layout files was very time consuming, since you had
8069 constantly to restart \SpecialChar LyX
8075 You can force a reload of the current layout by using the \SpecialChar LyX
8077 \begin_inset Flex Noun
8080 \begin_layout Plain Layout
8087 There is no default binding for this function—though, of course, you can
8088 bind it to a key yourself.
8089 But you will normally use this function simply by entering it in the mini-buffe
8094 \begin_layout Standard
8100 \begin_inset Flex Noun
8103 \begin_layout Plain Layout
8109 is very much an `advanced feature'.
8114 recommended that you save your work before using this function.
8119 recommended that you not attempt to edit layout information while simultaneousl
8120 y working on a document that you care about.
8121 Use a test document.
8122 Syntax errors and the like in your layout file could cause peculiar behavior.
8123 In particular, such errors could cause \SpecialChar LyX
8124 to regard the current layout as
8125 invalid and to attempt to switch to some other layout.
8129 \begin_layout Plain Layout
8130 Really bad syntax errors may even caused \SpecialChar LyX
8132 This is because certain sorts of errors may make \SpecialChar LyX
8143 The \SpecialChar LyX
8144 team strives to keep \SpecialChar LyX
8145 stable in such situations, but safe is better
8150 \begin_layout Plain Layout
8151 While we're giving advice: make regular backups.
8152 And be nice to your mother.
8160 \begin_layout Subsection
8161 The Module declaration
8164 \begin_layout Standard
8165 A module must begin with a line like the following:
8168 \begin_layout LyX-Code
8171 DeclareLyXModule[endnotes.sty]{Endnotes}
8174 \begin_layout Standard
8175 The mandatory argument, in curly brackets, is the name of the module, as
8177 \begin_inset Flex Noun
8180 \begin_layout Plain Layout
8181 Document\SpecialChar menuseparator
8182 Settings\SpecialChar menuseparator
8189 The argument in square brackets is optional: It declares any \SpecialChar LaTeX
8191 on which the module depends.
8192 It is also possible to use the form
8193 \begin_inset Flex Noun
8196 \begin_layout Plain Layout
8202 as an optional argument, which declares that the module can only be used
8203 when there exists a conversion chain between the formats `
8204 \begin_inset Flex Code
8207 \begin_layout Plain Layout
8214 \begin_inset Flex Code
8217 \begin_layout Plain Layout
8226 \begin_layout Standard
8227 The module declaration should then be followed by lines like the following
8231 \begin_layout Plain Layout
8232 Preferably in English if the module should be published with \SpecialChar LyX
8234 This description will appear in the list of messages to be translated and
8235 will be thus translated with the next interface update.
8243 \begin_layout LyX-Code
8247 \begin_layout LyX-Code
8248 #Adds an endnote command, in addition to footnotes.
8252 \begin_layout LyX-Code
8253 #You will need to add
8255 theendnotes in TeX code where you
8258 \begin_layout LyX-Code
8259 #want the endnotes to appear.
8263 \begin_layout LyX-Code
8267 \begin_layout LyX-Code
8268 #Requires: somemodule | othermodule
8271 \begin_layout LyX-Code
8272 #Excludes: badmodule
8275 \begin_layout Standard
8276 The description is used in
8277 \begin_inset Flex Noun
8280 \begin_layout Plain Layout
8281 Document\SpecialChar menuseparator
8282 Settings\SpecialChar menuseparator
8288 to provide the user with information about what the module does.
8290 \begin_inset Flex Code
8293 \begin_layout Plain Layout
8299 line is used to identify other modules with which this one must be used;
8301 \begin_inset Flex Code
8304 \begin_layout Plain Layout
8310 line is used to identify modules with which this one may not be used.
8311 Both are optional, and, as shown, multiple modules should be separated
8312 with the pipe symbol: |.
8313 Note that the required modules are treated disjunctively:
8317 of the required modules must be used.
8322 excluded module may be used.
8323 Note that modules are identified here by their filenames without the
8324 \begin_inset Flex Code
8327 \begin_layout Plain Layout
8335 \begin_inset Flex Code
8338 \begin_layout Plain Layout
8345 \begin_inset Flex Code
8348 \begin_layout Plain Layout
8357 \begin_layout Subsection
8361 \begin_layout Standard
8362 The first non-comment line of any layout file, included file, or module
8367 contain the file format number:
8370 \begin_layout Description
8371 \begin_inset Flex Code
8374 \begin_layout Plain Layout
8381 \begin_inset Flex Code
8384 \begin_layout Plain Layout
8390 ] The format number of the layout file.
8393 \begin_layout Standard
8394 This tag was introduced with \SpecialChar LyX
8396 \begin_inset space ~
8400 Layout files from older \SpecialChar LyX
8401 versions do not have an explicit file format and
8402 are considered to have
8403 \begin_inset Flex Code
8406 \begin_layout Plain Layout
8408 \begin_inset space ~
8417 The format for the present version of \SpecialChar LyX
8419 But each version of \SpecialChar LyX
8420 is capable of reading earlier versions' layout files,
8421 just as they are capable of reading files produced by earlier versions
8424 There is, however, no provision for converting to earlier formats.
8427 \begin_layout Subsection
8428 \begin_inset CommandInset label
8430 name "subsec:General-text-class"
8434 General text class parameters
8437 \begin_layout Standard
8438 These are general parameters that govern the behavior of an entire document
8444 mean that they must appear in
8445 \begin_inset Flex Code
8448 \begin_layout Plain Layout
8454 files rather than in modules.
8455 A module can contain any layout tag.)
8458 \begin_layout Description
8459 \begin_inset Flex Code
8462 \begin_layout Plain Layout
8468 Adds information that will be output in the
8469 \begin_inset Flex Code
8472 \begin_layout Plain Layout
8478 block when the document is output to XHTML.
8479 Typically, this would be used to output CSS style information, but it can
8480 be used for anything that can appear in
8481 \begin_inset Flex Code
8484 \begin_layout Plain Layout
8492 \begin_inset Quotes eld
8496 \begin_inset Flex Code
8499 \begin_layout Plain Layout
8506 \begin_inset Quotes erd
8512 \begin_layout Description
8513 \begin_inset Flex Code
8516 \begin_layout Plain Layout
8522 Adds information to the document preamble.
8524 \begin_inset Newline newline
8528 \begin_inset Quotes eld
8532 \begin_inset Flex Code
8535 \begin_layout Plain Layout
8542 \begin_inset Quotes erd
8548 \begin_layout Description
8549 \begin_inset Flex Code
8552 \begin_layout Plain Layout
8558 Defines formats for use in the display of bibliographic information.
8560 \begin_inset CommandInset ref
8562 reference "subsec:Citation-format-description"
8568 \begin_inset Quotes eld
8572 \begin_inset Flex Code
8575 \begin_layout Plain Layout
8582 \begin_inset Quotes erd
8588 \begin_layout Description
8589 \begin_inset Flex Code
8592 \begin_layout Plain Layout
8598 Describes various global options supported by the document class.
8600 \begin_inset CommandInset ref
8602 reference "subsec:ClassOptions"
8608 \begin_inset Quotes eld
8612 \begin_inset Flex Code
8615 \begin_layout Plain Layout
8622 \begin_inset Quotes erd
8628 \begin_layout Description
8629 \begin_inset Flex Code
8632 \begin_layout Plain Layout
8639 \begin_inset Flex Code
8642 \begin_layout Plain Layout
8651 \begin_inset space \thinspace{}
8655 \begin_inset Flex Code
8658 \begin_layout Plain Layout
8664 ] Whether the class should
8668 to having one or two columns.
8669 Can be changed in the
8670 \begin_inset Flex Noun
8673 \begin_layout Plain Layout
8674 Document\SpecialChar menuseparator
8683 \begin_layout Description
8684 \begin_inset Flex Code
8687 \begin_layout Plain Layout
8694 \begin_inset Flex Code
8697 \begin_layout Plain Layout
8703 ] This sequence defines the properties for a counter.
8704 If the counter does not yet exist, it is created; if it does exist, it
8707 \begin_inset Quotes eld
8711 \begin_inset Flex Code
8714 \begin_layout Plain Layout
8721 \begin_inset Quotes erd
8725 \begin_inset Newline newline
8729 \begin_inset CommandInset ref
8731 reference "subsec:Counters"
8735 for details on counters.
8738 \begin_layout Description
8739 \begin_inset Flex Code
8742 \begin_layout Plain Layout
8748 Sets the default font used to display the document.
8750 \begin_inset CommandInset ref
8752 reference "subsec:Font-description"
8756 for how to declare fonts.
8758 \begin_inset Quotes eld
8762 \begin_inset Flex Code
8765 \begin_layout Plain Layout
8772 \begin_inset Quotes erd
8778 \begin_layout Description
8779 \begin_inset Flex Code
8782 \begin_layout Plain Layout
8789 \begin_inset Flex Code
8792 \begin_layout Plain Layout
8798 ] Specifies a module to be included by default with this document class.
8799 The module is specified as filename without the
8800 \begin_inset Flex Code
8803 \begin_layout Plain Layout
8810 The user can still remove the module, but it will be active at the outset.
8811 (This applies only when new files are created, or when this class is chosen
8812 for an existing document.)
8815 \begin_layout Description
8816 \begin_inset Flex Code
8819 \begin_layout Plain Layout
8826 \begin_inset Flex Code
8829 \begin_layout Plain Layout
8835 ] This is the style that will be assigned to new paragraphs, usually
8836 \begin_inset Flex Noun
8839 \begin_layout Plain Layout
8846 This will default to the first defined style if not given, but you are
8847 encouraged to use this directive.
8850 \begin_layout Description
8851 \begin_inset Flex Code
8854 \begin_layout Plain Layout
8861 \begin_inset Flex Code
8864 \begin_layout Plain Layout
8870 ] This tag indicates that the module (which is specified by filename without
8872 \begin_inset Flex Code
8875 \begin_layout Plain Layout
8881 extension) cannot be used with this document class.
8882 This might be used in a journal-specific layout file to prevent, say, the
8884 \begin_inset Flex Code
8887 \begin_layout Plain Layout
8893 module that numbers theorems by section.
8898 be used in a module.
8899 Modules have their own way of excluding other modules (see
8900 \begin_inset CommandInset ref
8902 reference "subsec:Layout-modules"
8909 \begin_layout Description
8910 \begin_inset Flex Code
8913 \begin_layout Plain Layout
8919 Defines a new float.
8921 \begin_inset CommandInset ref
8923 reference "subsec:Floats"
8929 \begin_inset Quotes eld
8933 \begin_inset Flex Code
8936 \begin_layout Plain Layout
8943 \begin_inset Quotes erd
8949 \begin_layout Description
8950 \begin_inset Flex Code
8953 \begin_layout Plain Layout
8959 Sets the information that will be output in the
8960 \begin_inset Flex Code
8963 \begin_layout Plain Layout
8969 block when this document class is output to XHTML.
8970 Note that this will completely override any prior
8971 \begin_inset Flex Code
8974 \begin_layout Plain Layout
8981 \begin_inset Flex Code
8984 \begin_layout Plain Layout
8992 \begin_inset Newline newline
8996 \begin_inset Flex Code
8999 \begin_layout Plain Layout
9005 if you just want to add material to the preamble.) Must end with
9006 \begin_inset Quotes eld
9010 \begin_inset Flex Code
9013 \begin_layout Plain Layout
9020 \begin_inset Quotes erd
9026 \begin_layout Description
9027 \begin_inset Flex Code
9030 \begin_layout Plain Layout
9037 \begin_inset Flex Code
9040 \begin_layout Plain Layout
9046 ] The style to use for the table of contents, bibliography, and so forth,
9047 when the document is output to HTML.
9048 For articles, this should normally be
9049 \begin_inset Flex Code
9052 \begin_layout Plain Layout
9059 \begin_inset Flex Code
9062 \begin_layout Plain Layout
9069 If it is not given, then \SpecialChar LyX
9070 will attempt to figure out which layout to use.
9073 \begin_layout Description
9074 \begin_inset Flex Code
9077 \begin_layout Plain Layout
9084 \begin_inset Flex Code
9087 \begin_layout Plain Layout
9093 ] Modifies the properties of the given counter.
9094 If the counter does not exist, the statement is ignored.
9096 \begin_inset Quotes eld
9100 \begin_inset Flex Code
9103 \begin_layout Plain Layout
9110 \begin_inset Quotes erd
9114 \begin_inset Newline newline
9118 \begin_inset CommandInset ref
9120 reference "subsec:Counters"
9124 for details on counters.
9127 \begin_layout Description
9128 \begin_inset Flex Code
9131 \begin_layout Plain Layout
9138 \begin_inset Flex Code
9141 \begin_layout Plain Layout
9147 ] This allows you to include another layout definition file within yours
9148 to avoid duplicating commands.
9149 Common examples are the standard layout files, for example,
9150 \begin_inset Flex Code
9153 \begin_layout Plain Layout
9159 , which contains most of the basic layouts.
9162 \begin_layout Description
9163 \begin_inset Flex Code
9166 \begin_layout Plain Layout
9173 \begin_inset Flex Code
9176 \begin_layout Plain Layout
9182 ] This section (re-)defines the layout of an inset.
9183 It can be applied to an existing inset or to a new, user-defined inset,
9184 e.g., a new character style.
9186 \begin_inset Quotes eld
9190 \begin_inset Flex Code
9193 \begin_layout Plain Layout
9200 \begin_inset Quotes erd
9204 \begin_inset Newline newline
9208 \begin_inset CommandInset ref
9210 reference "subsec:Flex-insets-and"
9214 for more information.
9218 \begin_layout Description
9219 \begin_inset Flex Code
9222 \begin_layout Plain Layout
9229 \begin_inset Flex Code
9232 \begin_layout Plain Layout
9238 ] A string that indicates the width of the left margin on the screen, for
9240 \begin_inset Quotes eld
9244 \begin_inset Flex Code
9247 \begin_layout Plain Layout
9254 \begin_inset Quotes erd
9258 (Note that this is not a `length', like
9259 \begin_inset Quotes eld
9263 \begin_inset Quotes erd
9269 \begin_layout Description
9270 \begin_inset Flex Code
9273 \begin_layout Plain Layout
9280 \begin_inset Flex Code
9283 \begin_layout Plain Layout
9289 ] Modifies the properties of the given paragraph style.
9290 If the style does not exist, this section is ignored.
9292 \begin_inset Quotes eld
9296 \begin_inset Flex Code
9299 \begin_layout Plain Layout
9306 \begin_inset Quotes erd
9312 \begin_layout Description
9313 \begin_inset Flex Code
9316 \begin_layout Plain Layout
9323 \begin_inset Flex Code
9326 \begin_layout Plain Layout
9332 ] Deletes an existing counter, usually one defined in an included file.
9335 \begin_layout Description
9336 \begin_inset Flex Code
9339 \begin_layout Plain Layout
9346 \begin_inset Flex Code
9349 \begin_layout Plain Layout
9355 ] Deletes an existing float.
9356 This is particularly useful when you want to suppress a float that has
9357 been defined in an input file.
9360 \begin_layout Description
9361 \begin_inset Flex Code
9364 \begin_layout Plain Layout
9371 \begin_inset Flex Code
9374 \begin_layout Plain Layout
9380 ] Deletes an existing style.
9383 \begin_layout Description
9384 \begin_inset Flex Code
9387 \begin_layout Plain Layout
9394 \begin_inset Flex Code
9397 \begin_layout Plain Layout
9403 ] The file format (as defined in the \SpecialChar LyX
9404 preferences) produced by this document
9406 It is mainly useful when
9407 \begin_inset Flex Code
9410 \begin_layout Plain Layout
9417 \begin_inset Flex Code
9420 \begin_layout Plain Layout
9426 and one wants to define a new type of literate document.
9427 The format is reset to
9428 \begin_inset Quotes eld
9432 \begin_inset Flex Code
9435 \begin_layout Plain Layout
9442 \begin_inset Quotes erd
9446 \begin_inset Quotes eld
9450 \begin_inset Flex Code
9453 \begin_layout Plain Layout
9460 \begin_inset Quotes erd
9463 when the corresponding
9464 \begin_inset Flex Code
9467 \begin_layout Plain Layout
9473 parameter is encountered.
9476 \begin_layout Description
9477 \begin_inset Flex Code
9480 \begin_layout Plain Layout
9487 \begin_inset Flex Code
9490 \begin_layout Plain Layout
9501 \begin_inset Flex Code
9504 \begin_layout Plain Layout
9511 \begin_inset Flex Code
9514 \begin_layout Plain Layout
9520 ] Specifies what sort of output documents using this class will produce.
9523 \begin_layout Description
9524 \begin_inset Flex Code
9527 \begin_layout Plain Layout
9534 \begin_inset Flex Code
9537 \begin_layout Plain Layout
9544 \begin_inset Flex Code
9547 \begin_layout Plain Layout
9553 ] Specifies options, given in the second string, for the package named by
9556 \begin_inset Quotes eld
9560 \begin_inset Flex Code
9563 \begin_layout Plain Layout
9564 PackageOptions natbib square
9570 \begin_inset Quotes erd
9574 \begin_inset Flex Code
9577 \begin_layout Plain Layout
9583 to be loaded with the
9584 \begin_inset Flex Code
9587 \begin_layout Plain Layout
9594 (For \SpecialChar TeX
9595 perts, this causes \SpecialChar LyX
9597 \begin_inset Flex Code
9600 \begin_layout Plain Layout
9603 PassOptionsToPackage{natbib}{square}
9609 \begin_inset Flex Code
9612 \begin_layout Plain Layout
9621 \begin_layout Description
9622 \begin_inset Flex Code
9625 \begin_layout Plain Layout
9632 \begin_inset Flex Code
9635 \begin_layout Plain Layout
9644 \begin_inset Flex Code
9647 \begin_layout Plain Layout
9654 \begin_inset Flex Code
9657 \begin_layout Plain Layout
9663 ] The default pagestyle.
9664 Can be changed in the
9665 \begin_inset Flex Noun
9668 \begin_layout Plain Layout
9669 Document\SpecialChar menuseparator
9678 \begin_layout Description
9679 \begin_inset Flex Code
9682 \begin_layout Plain Layout
9688 Sets the preamble for the \SpecialChar LaTeX
9690 Note that this will completely override any prior
9691 \begin_inset Flex Code
9694 \begin_layout Plain Layout
9701 \begin_inset Flex Code
9704 \begin_layout Plain Layout
9712 \begin_inset Flex Code
9715 \begin_layout Plain Layout
9721 if you just want to add material to the preamble.) Must end with
9722 \begin_inset Quotes eld
9726 \begin_inset Flex Code
9729 \begin_layout Plain Layout
9736 \begin_inset Quotes erd
9742 \begin_layout Description
9743 \begin_inset Flex Code
9746 \begin_layout Plain Layout
9753 \begin_inset Flex Code
9756 \begin_layout Plain Layout
9763 \begin_inset Flex Code
9766 \begin_layout Plain Layout
9775 \begin_inset space \thinspace{}
9779 \begin_inset Flex Code
9782 \begin_layout Plain Layout
9788 ] Whether the class already provides the feature
9789 \begin_inset Flex Code
9792 \begin_layout Plain Layout
9799 A feature is in general the name of a package (e.
9800 \begin_inset space \thinspace{}
9804 \begin_inset space \space{}
9808 \begin_inset Flex Code
9811 \begin_layout Plain Layout
9818 \begin_inset Flex Code
9821 \begin_layout Plain Layout
9828 \begin_inset space \thinspace{}
9832 \begin_inset space \space{}
9836 \begin_inset Flex Code
9839 \begin_layout Plain Layout
9846 \begin_inset Flex Code
9849 \begin_layout Plain Layout
9857 \begin_inset CommandInset ref
9859 reference "chap:List-of-functions"
9863 for the list of features.
9866 \begin_layout Description
9867 \begin_inset Flex Code
9870 \begin_layout Plain Layout
9877 \begin_inset Flex Code
9880 \begin_layout Plain Layout
9886 ] Indicates that this layout provides the functionality of the module mentioned,
9887 which should be specified by the filename without the
9888 \begin_inset Flex Code
9891 \begin_layout Plain Layout
9898 This will typically be used if the layout includes the module directly,
9899 rather than using the
9900 \begin_inset Flex Code
9903 \begin_layout Plain Layout
9909 tag to indicate that it ought to be used.
9910 It could also be used in a module that provided an alternate implementation
9911 of the same functionality.
9914 \begin_layout Description
9915 \begin_inset Flex Code
9918 \begin_layout Plain Layout
9925 \begin_inset Flex Code
9928 \begin_layout Plain Layout
9934 ] Creates a new paragraph style if it does not already exist.
9935 If the style does exist, this section is ignored.
9937 \begin_inset Quotes eld
9941 \begin_inset Flex Code
9944 \begin_layout Plain Layout
9951 \begin_inset Quotes erd
9957 \begin_layout Description
9958 \begin_inset Flex Code
9961 \begin_layout Plain Layout
9968 \begin_inset Flex Code
9971 \begin_layout Plain Layout
9977 ] Whether the class requires the feature
9978 \begin_inset Flex Code
9981 \begin_layout Plain Layout
9988 Multiple features must be separated by commas.
9989 Note that you can only request supported features.
9991 \begin_inset CommandInset ref
9993 reference "chap:List-of-functions"
9997 for the list of features.).
9998 If you require a package with specific options, you can additionally use
10000 \begin_inset Flex Code
10003 \begin_layout Plain Layout
10012 \begin_layout Description
10013 \begin_inset Flex Code
10016 \begin_layout Plain Layout
10023 \begin_inset Flex Code
10026 \begin_layout Plain Layout
10032 ] A string that indicates the width of the right margin on the screen, for
10034 \begin_inset Quotes eld
10038 \begin_inset Flex Code
10041 \begin_layout Plain Layout
10048 \begin_inset Quotes erd
10054 \begin_layout Description
10055 \begin_inset Flex Code
10058 \begin_layout Plain Layout
10065 \begin_inset Flex Code
10068 \begin_layout Plain Layout
10074 ] Sets which divisions get numbered.
10076 \begin_inset Newline newline
10080 \begin_inset Flex Code
10083 \begin_layout Plain Layout
10089 counter in \SpecialChar LaTeX
10093 \begin_layout Description
10094 \begin_inset Flex Code
10097 \begin_layout Plain Layout
10104 \begin_inset Flex Code
10107 \begin_layout Plain Layout
10116 \begin_inset space \thinspace{}
10120 \begin_inset Flex Code
10123 \begin_layout Plain Layout
10129 ] Whether the class-default should be printing on one or both sides of the
10131 Can be changed in the
10132 \begin_inset Flex Noun
10135 \begin_layout Plain Layout
10136 Document\SpecialChar menuseparator
10145 \begin_layout Description
10146 \begin_inset Flex Code
10149 \begin_layout Plain Layout
10156 \begin_inset Flex Code
10159 \begin_layout Plain Layout
10165 ] This sequence defines a paragraph style.
10166 If the style does not yet exist, it is created; if it does exist, its parameter
10169 \begin_inset Quotes eld
10173 \begin_inset Flex Code
10176 \begin_layout Plain Layout
10183 \begin_inset Quotes erd
10187 \begin_inset Newline newline
10191 \begin_inset CommandInset ref
10193 reference "subsec:Paragraph-Styles"
10197 for details on paragraph styles.
10200 \begin_layout Description
10201 \begin_inset Flex Code
10204 \begin_layout Plain Layout
10211 \begin_inset Flex Code
10214 \begin_layout Plain Layout
10220 ] The name of the command or environment to be used with
10221 \begin_inset Flex Code
10224 \begin_layout Plain Layout
10233 \begin_layout Description
10234 \begin_inset Flex Code
10237 \begin_layout Plain Layout
10244 \begin_inset Flex Code
10247 \begin_layout Plain Layout
10256 \begin_inset Flex Code
10259 \begin_layout Plain Layout
10265 ] Indicates what kind of markup is used to define the title of a document.
10267 \begin_inset Flex Code
10270 \begin_layout Plain Layout
10276 means that the macro with name
10277 \begin_inset Flex Code
10280 \begin_layout Plain Layout
10286 will be inserted after the last layout which has
10287 \begin_inset Quotes eld
10291 \begin_inset Flex Code
10294 \begin_layout Plain Layout
10296 \begin_inset space ~
10305 \begin_inset Quotes erd
10310 \begin_inset Flex Code
10313 \begin_layout Plain Layout
10319 corresponds to the case where all layouts which have
10320 \begin_inset Quotes eld
10324 \begin_inset Flex Code
10327 \begin_layout Plain Layout
10329 \begin_inset space ~
10338 \begin_inset Quotes erd
10341 should be enclosed into the
10342 \begin_inset Flex Code
10345 \begin_layout Plain Layout
10354 \begin_layout Description
10355 \begin_inset Flex Code
10358 \begin_layout Plain Layout
10365 \begin_inset Flex Code
10368 \begin_layout Plain Layout
10374 ] Sets which divisions are included in the table of contents.
10376 \begin_inset Flex Code
10379 \begin_layout Plain Layout
10385 counter in \SpecialChar LaTeX
10389 \begin_layout Subsection
10390 \begin_inset Flex Code
10393 \begin_layout Plain Layout
10400 \begin_inset CommandInset label
10402 name "subsec:ClassOptions"
10409 \begin_layout Standard
10411 \begin_inset Flex Code
10414 \begin_layout Plain Layout
10420 section can contain the following entries:
10423 \begin_layout Description
10424 \begin_inset Flex Code
10427 \begin_layout Plain Layout
10434 \begin_inset Flex Code
10437 \begin_layout Plain Layout
10443 ] The list of available font sizes for the document's main font, separated
10445 \begin_inset Quotes eld
10449 \begin_inset Flex Code
10452 \begin_layout Plain Layout
10459 \begin_inset Quotes erd
10465 \begin_layout Description
10466 \begin_inset Flex Code
10469 \begin_layout Plain Layout
10475 Used to set the DTD line with XML-based output classes.
10477 \begin_inset space \thinspace{}
10481 \begin_inset Quotes eld
10484 -//OASIS//DTD DocBook V4.2//EN
10485 \begin_inset Quotes erd
10491 \begin_layout Description
10492 \begin_inset Flex Code
10495 \begin_layout Plain Layout
10502 \begin_inset Flex Code
10505 \begin_layout Plain Layout
10506 string="empty|plain|headings|fancy"
10511 ] The list of available page sty\SpecialChar softhyphen
10513 \begin_inset Quotes eld
10517 \begin_inset Flex Code
10520 \begin_layout Plain Layout
10527 \begin_inset Quotes erd
10533 \begin_layout Description
10534 \begin_inset Flex Code
10537 \begin_layout Plain Layout
10544 \begin_inset Flex Code
10547 \begin_layout Plain Layout
10553 ] Some document class options, separated by a comma, that will be added
10554 to the optional part of the
10555 \begin_inset Flex Code
10558 \begin_layout Plain Layout
10569 \begin_layout Standard
10571 \begin_inset Flex Code
10574 \begin_layout Plain Layout
10580 section must end with
10581 \begin_inset Quotes eld
10585 \begin_inset Flex Code
10588 \begin_layout Plain Layout
10595 \begin_inset Quotes erd
10601 \begin_layout Subsection
10603 \begin_inset CommandInset label
10605 name "subsec:Paragraph-Styles"
10612 \begin_layout Standard
10613 A paragraph style description looks like this:
10617 \begin_layout Plain Layout
10618 Note that this will either define a new style or modify an existing one.
10626 \begin_layout LyX-Code
10633 \begin_layout LyX-Code
10637 \begin_layout LyX-Code
10641 \begin_layout Standard
10642 where the following commands are allowed:
10645 \begin_layout Description
10646 \begin_inset Flex Code
10649 \begin_layout Plain Layout
10656 \begin_inset Flex Code
10659 \begin_layout Plain Layout
10664 , left, right, center
10669 ] Paragraph alignment.
10672 \begin_layout Description
10673 \begin_inset Flex Code
10676 \begin_layout Plain Layout
10683 \begin_inset Flex Code
10686 \begin_layout Plain Layout
10691 , left, right, center
10696 ] A comma separated list of permitted alignments.
10697 (Some \SpecialChar LaTeX
10698 styles prohibit certain alignments, since those wouldn't make sense.
10699 For example a right-aligned or centered enumeration isn't possible.)
10702 \begin_layout Description
10703 \begin_inset Flex Code
10706 \begin_layout Plain Layout
10713 \begin_inset Flex Code
10716 \begin_layout Plain Layout
10722 ] Defines argument number <int> of a command\SpecialChar breakableslash
10723 environment associated with
10725 This is useful for things like section headings, and only makes sense with
10728 Every (optional or required) argument of a command or environment – except
10729 for the required argument that is associated with the content of the paragraph
10730 itself – has a separate definition, where the number specifies the order
10732 The definition must end with
10733 \begin_inset Flex Code
10736 \begin_layout Plain Layout
10743 So a command with two optional arguments has:
10747 \begin_layout Quote
10753 \begin_layout Quote
10759 \begin_layout Quote
10765 \begin_layout Quote
10771 \begin_layout Quote
10777 \begin_layout Quote
10783 \begin_layout Standard
10785 \begin_inset Flex Code
10788 \begin_layout Plain Layout
10794 definition, the following specifications are possible:
10797 \begin_layout Itemize
10798 \begin_inset Flex Code
10801 \begin_layout Plain Layout
10808 \begin_inset Flex Code
10811 \begin_layout Plain Layout
10817 The string that will appear both in the menu (to insert this argument)
10818 and on the argument inset button (unless you also specify a separate
10819 \begin_inset Flex Code
10822 \begin_layout Plain Layout
10829 For the menu, you can define an accelerator by appending the respective
10830 character to the string, divided by
10831 \begin_inset Quotes eld
10835 \begin_inset Quotes erd
10839 \begin_inset space \thinspace{}
10843 \begin_inset space \space{}
10847 \begin_inset Quotes eld
10851 \begin_inset Flex Code
10854 \begin_layout Plain Layout
10861 \begin_inset Quotes erd
10867 \begin_layout Itemize
10868 \begin_inset Flex Code
10871 \begin_layout Plain Layout
10878 \begin_inset Flex Code
10881 \begin_layout Plain Layout
10887 A separate string for the menu.
10888 You can define an accelerator by appending the respective character to
10889 the string, divided by
10890 \begin_inset Quotes eld
10894 \begin_inset Quotes erd
10898 \begin_inset space \thinspace{}
10902 \begin_inset space \space{}
10906 \begin_inset Quotes eld
10910 \begin_inset Flex Code
10913 \begin_layout Plain Layout
10920 \begin_inset Quotes erd
10924 This specification is optional.
10925 If it is not given the
10926 \begin_inset Flex Code
10929 \begin_layout Plain Layout
10935 will be used instead for the menu.
10938 \begin_layout Itemize
10939 \begin_inset Flex Code
10942 \begin_layout Plain Layout
10949 \begin_inset Flex Code
10952 \begin_layout Plain Layout
10958 A longer explanatory text that appears in the tooltip when hovering over
10959 the argument inset.
10962 \begin_layout Itemize
10963 \begin_inset Flex Code
10966 \begin_layout Plain Layout
10973 \begin_inset Flex Code
10976 \begin_layout Plain Layout
10985 \begin_inset space \thinspace{}
10989 \begin_inset Flex Code
10992 \begin_layout Plain Layout
10998 ] Declare if this is a mandatory (1) or an optional (0) argument.
10999 Mandatory arguments will be output empty if not given, while optional arguments
11000 will not be output at all.
11001 By default, mandatory arguments are delimited by
11002 \begin_inset Flex Code
11005 \begin_layout Plain Layout
11011 , while optional arguments are delimited by
11012 \begin_inset Flex Code
11015 \begin_layout Plain Layout
11024 \begin_layout Itemize
11025 \begin_inset Flex Code
11028 \begin_layout Plain Layout
11035 \begin_inset Flex Code
11038 \begin_layout Plain Layout
11044 defines another argument (by its number) which this argument requires to
11045 be output if it is itself output.
11047 \begin_inset space \thinspace{}
11050 g., in \SpecialChar LaTeX
11051 commands, optional arguments often require previous optional arguments
11052 to be output (at least empty), as in
11053 \begin_inset Flex Code
11056 \begin_layout Plain Layout
11059 command[][argument]{text}
11065 This can be achieved by the statement
11066 \begin_inset Flex Code
11069 \begin_layout Plain Layout
11076 \begin_inset Flex Code
11079 \begin_layout Plain Layout
11088 \begin_layout Itemize
11089 \begin_inset Flex Code
11092 \begin_layout Plain Layout
11099 \begin_inset Flex Code
11102 \begin_layout Plain Layout
11108 defines a custom left delimiter (instead of
11109 \begin_inset Flex Code
11112 \begin_layout Plain Layout
11119 \begin_inset Flex Code
11122 \begin_layout Plain Layout
11129 A line break in the output can be indicated by
11130 \begin_inset Flex Code
11133 \begin_layout Plain Layout
11142 \begin_layout Itemize
11143 \begin_inset Flex Code
11146 \begin_layout Plain Layout
11153 \begin_inset Flex Code
11156 \begin_layout Plain Layout
11162 defines a custom right delimiter (instead of
11163 \begin_inset Flex Code
11166 \begin_layout Plain Layout
11173 \begin_inset Flex Code
11176 \begin_layout Plain Layout
11183 A line break in the output can be indicated by
11184 \begin_inset Flex Code
11187 \begin_layout Plain Layout
11196 \begin_layout Itemize
11197 \begin_inset Flex Code
11200 \begin_layout Plain Layout
11207 \begin_inset Flex Code
11210 \begin_layout Plain Layout
11216 defines an argument that is inserted if and only if no user-specified arguments
11218 \begin_inset space \thinspace{}
11222 \begin_inset space \space{}
11225 if no argument inset has been inserted (note that also an empty argument
11226 inset omits the DefaultArg).
11227 Multiple arguments need to be separated by comma.
11230 \begin_layout Itemize
11231 \begin_inset Flex Code
11234 \begin_layout Plain Layout
11241 \begin_inset Flex Code
11244 \begin_layout Plain Layout
11250 defines an argument that is inserted in any case (alone or in addition
11251 to user-specified arguments).
11252 Multiple arguments need to be separated by comma.
11255 \begin_layout Itemize
11256 \begin_inset Flex Code
11259 \begin_layout Plain Layout
11265 The font used for the argument content, see
11266 \begin_inset CommandInset ref
11268 reference "subsec:Font-description"
11275 \begin_layout Itemize
11276 \begin_inset Flex Code
11279 \begin_layout Plain Layout
11285 The font used for the label; see
11286 \begin_inset CommandInset ref
11288 reference "subsec:Font-description"
11295 \begin_layout Itemize
11296 \begin_inset Flex Code
11299 \begin_layout Plain Layout
11306 \begin_inset Flex Code
11309 \begin_layout Plain Layout
11314 , Minimalistic, Conglomerate
11319 ] describes the rendering style used for the inset's frame and buttons.
11322 \begin_layout Itemize
11323 \begin_inset Flex Code
11326 \begin_layout Plain Layout
11333 \begin_inset Flex Code
11336 \begin_layout Plain Layout
11343 \begin_inset Flex Code
11346 \begin_layout Plain Layout
11352 , this argument is automatically inserted when the respective style is selected.
11353 Currently, only one argument per style\SpecialChar breakableslash
11354 layout can be automatically inserted.
11357 \begin_layout Itemize
11358 \begin_inset Flex Code
11361 \begin_layout Plain Layout
11368 \begin_inset Flex Code
11371 \begin_layout Plain Layout
11378 \begin_inset Flex Code
11381 \begin_layout Plain Layout
11387 , this argument will be inserted with a copy of the co-text (either selected
11388 text or the whole paragraph) as content.
11389 \change_inserted -712698321 1477038290
11393 \begin_layout Itemize
11395 \change_inserted -712698321 1477038425
11396 \begin_inset Flex Code
11399 \begin_layout Plain Layout
11401 \change_inserted -712698321 1477038295
11408 \begin_inset Flex Code
11411 \begin_layout Plain Layout
11413 \change_inserted -712698321 1477038311
11423 ] Whether the contents of this argument should be output in raw form, meaning
11424 without special translations that \SpecialChar LaTeX
11427 \begin_inset Flex Code
11430 \begin_layout Plain Layout
11432 \change_inserted -712698321 1477038356
11438 status is inherited by the inset or paragraph layout the argument belongs
11439 to, true and false change the status for the given argument only.
11444 \begin_layout Itemize
11445 \begin_inset Flex Code
11448 \begin_layout Plain Layout
11455 \begin_inset Flex Code
11458 \begin_layout Plain Layout
11459 string of characters
11468 Defines individual characters that should be output in raw form, meaning
11469 without special translations that \SpecialChar LaTeX
11471 Note that, contrary to PassThru, this needs to be explicitly defined for
11473 That is, arguments do not inherit PassThruChars from their parent inset
11477 \begin_layout Standard
11478 By default, the text entered in the \SpecialChar LyX
11479 workarea in the respective layout is
11480 the last (mandatory) argument of a command if the
11481 \begin_inset Flex Code
11484 \begin_layout Plain Layout
11491 \begin_inset Flex Code
11494 \begin_layout Plain Layout
11501 However, arguments with the prefix
11502 \begin_inset Flex Code
11505 \begin_layout Plain Layout
11511 are output after this workarea argument.
11512 Note that post-argument numbering restarts at 1, so the first argument
11513 following the workarea argument is
11514 \begin_inset Flex Code
11517 \begin_layout Plain Layout
11524 Post-arguments are ignored in any other
11525 \begin_inset Flex Code
11528 \begin_layout Plain Layout
11535 \begin_inset Flex Code
11538 \begin_layout Plain Layout
11547 \begin_layout Standard
11549 \begin_inset Flex Code
11552 \begin_layout Plain Layout
11561 \begin_inset Flex Code
11564 \begin_layout Plain Layout
11573 \begin_inset Flex Code
11576 \begin_layout Plain Layout
11582 followed by the number (e.
11583 \begin_inset space \thinspace{}
11587 \begin_inset space \space{}
11591 \begin_inset Flex Code
11594 \begin_layout Plain Layout
11604 \begin_layout Description
11605 \begin_inset Flex Code
11608 \begin_layout Plain Layout
11614 Note that this will completely override any prior
11615 \begin_inset Flex Code
11618 \begin_layout Plain Layout
11624 declaration for this style.
11626 \begin_inset Quotes eld
11630 \begin_inset Flex Code
11633 \begin_layout Plain Layout
11640 \begin_inset Quotes erd
11645 \begin_inset CommandInset ref
11647 reference "subsec:I18n"
11651 for details on its use.
11654 \begin_layout Description
11655 \begin_inset Flex Code
11658 \begin_layout Plain Layout
11665 \begin_inset Flex Code
11668 \begin_layout Plain Layout
11678 \begin_layout Plain Layout
11679 Note that a `float' here is a real number, such as: 1.5.
11684 The vertical space with which the last of a chain of paragraphs with this
11685 style is separated from the following paragraph.
11686 If the next paragraph has another style, the separations are not simply
11687 added, but the maximum is taken.
11690 \begin_layout Description
11691 \begin_inset Flex Code
11694 \begin_layout Plain Layout
11701 \begin_inset Flex Code
11704 \begin_layout Plain Layout
11710 ] The category for this style.
11711 This is used to group related styles in the style combobox on the toolbar.
11712 Any string can be used, but you may want to use existing categories with
11717 \begin_layout Description
11718 \begin_inset Flex Code
11721 \begin_layout Plain Layout
11727 Depth of XML command.
11728 Used only with XML-type formats.
11731 \begin_layout Description
11732 \begin_inset Flex Code
11735 \begin_layout Plain Layout
11742 \begin_inset Flex Code
11745 \begin_layout Plain Layout
11751 ] Copies all the features of an existing style into the current one.
11755 \begin_layout Description
11756 \begin_inset Flex Code
11759 \begin_layout Plain Layout
11766 \begin_inset Flex Code
11769 \begin_layout Plain Layout
11775 ] The name of a style whose preamble should be output
11780 This allows to ensure some ordering of the preamble snippets when macros
11781 definitions depend on one another.
11785 \begin_layout Plain Layout
11786 Note that, besides that functionality, there is no way to ensure any ordering
11788 The ordering that you see in a given version of \SpecialChar LyX
11789 may change without warning
11798 \begin_layout Description
11799 \begin_inset Flex Code
11802 \begin_layout Plain Layout
11809 \begin_inset Flex Code
11812 \begin_layout Plain Layout
11817 , Box, Filled_Box, Static
11822 ] The type of label that stands at the end of the paragraph (or sequence
11824 \begin_inset Flex Code
11827 \begin_layout Plain Layout
11834 \begin_inset Newline newline
11838 \begin_inset Flex Code
11841 \begin_layout Plain Layout
11848 \begin_inset Flex Code
11851 \begin_layout Plain Layout
11858 \begin_inset Flex Code
11861 \begin_layout Plain Layout
11869 \begin_inset Flex Code
11872 \begin_layout Plain Layout
11879 \begin_inset Quotes eld
11883 \begin_inset Quotes erd
11887 \begin_inset Flex Code
11890 \begin_layout Plain Layout
11897 \begin_inset space \space{}
11901 \begin_inset Flex Code
11904 \begin_layout Plain Layout
11910 ) is a white (resp.
11911 \begin_inset space ~
11914 black) square suitable for end of proof markers,
11915 \begin_inset Flex Code
11918 \begin_layout Plain Layout
11924 is an explicit text string.
11927 \begin_layout Description
11928 \begin_inset Flex Code
11931 \begin_layout Plain Layout
11938 \begin_inset Flex Code
11941 \begin_layout Plain Layout
11947 ] The string used for a label with a
11948 \begin_inset Flex Code
11951 \begin_layout Plain Layout
11958 \begin_inset Newline newline
11962 \begin_inset Flex Code
11965 \begin_layout Plain Layout
11975 \begin_layout Description
11976 \begin_inset Flex Code
11979 \begin_layout Plain Layout
11985 The font used for both the text body
11991 \begin_inset CommandInset ref
11993 reference "subsec:Font-description"
11998 Note that defining this font automatically defines the
11999 \begin_inset Flex Code
12002 \begin_layout Plain Layout
12009 So you should define this one first if you also want to define
12010 \begin_inset Flex Code
12013 \begin_layout Plain Layout
12022 \begin_layout Description
12023 \begin_inset Flex Code
12026 \begin_layout Plain Layout
12033 \begin_inset Flex Code
12036 \begin_layout Plain Layout
12042 ] Used for backporting new styles to stable \SpecialChar LyX
12044 The first stable version that supports this tag is \SpecialChar LyX
12046 The argument is a number which may either be 0, -1 or any value greater
12049 \begin_inset Flex Code
12052 \begin_layout Plain Layout
12058 flag of a style is greater than zero, it will always be written to the
12060 If a .lyx file is read, the style definitions from the document header are
12061 added to the document class.
12062 Therefore even older \SpecialChar LyX
12063 versions can handle the style.
12065 \begin_inset Flex Code
12068 \begin_layout Plain Layout
12074 is a version number: if the style is read, and the version number is less
12075 than the version number of the already existing style in the document class,
12076 the new style is ignored.
12077 If the version number is greater, the new style replaces the existing style.
12078 A value of -1 means an infinite version number, i.
12079 \begin_inset space \thinspace{}
12083 \begin_inset space \space{}
12086 the style is always used.
12089 \begin_layout Description
12090 \begin_inset Flex Code
12093 \begin_layout Plain Layout
12100 \begin_inset Flex Code
12103 \begin_layout Plain Layout
12112 \begin_inset space \thinspace{}
12116 \begin_inset Flex Code
12119 \begin_layout Plain Layout
12125 ] Usually \SpecialChar LyX
12126 does not allow you to insert more than one space between words,
12127 since a space is considered as the separation between two words, not a
12128 character or symbol of its own.
12129 This is a very fine thing but sometimes annoying, for example, when typing
12130 program code or plain \SpecialChar LaTeX
12133 \begin_inset Flex Code
12136 \begin_layout Plain Layout
12143 Note that \SpecialChar LyX
12144 will create protected blanks for the additional blanks when
12145 in another mode than \SpecialChar LaTeX
12149 \begin_layout Description
12150 \begin_inset Flex Code
12153 \begin_layout Plain Layout
12159 These tags are used with XHTML output.
12161 \begin_inset CommandInset ref
12163 reference "subsec:Paragraph-Style-XHTML"
12170 \begin_layout Description
12171 \begin_inset Flex Code
12174 \begin_layout Plain Layout
12180 [FIXME] (Used only with XML-type formats.)
12183 \begin_layout Description
12184 \begin_inset Flex Code
12187 \begin_layout Plain Layout
12194 \begin_inset Flex Code
12197 \begin_layout Plain Layout
12206 \begin_inset space \thinspace{}
12210 \begin_inset Flex Code
12213 \begin_layout Plain Layout
12220 \begin_inset Flex Code
12223 \begin_layout Plain Layout
12229 , marks the style as to be included in the document preamble and not in
12231 This is useful for document classes that want such information as the title
12232 and author to appear in the preamble.
12233 Note that this works only for styles for which the
12234 \begin_inset Flex Code
12237 \begin_layout Plain Layout
12244 \begin_inset Flex Code
12247 \begin_layout Plain Layout
12254 \begin_inset Flex Code
12257 \begin_layout Plain Layout
12266 \begin_layout Description
12267 \begin_inset Flex Code
12270 \begin_layout Plain Layout
12277 \begin_inset Flex Code
12280 \begin_layout Plain Layout
12289 \begin_inset space \thinspace{}
12293 \begin_inset Flex Code
12296 \begin_layout Plain Layout
12303 \begin_inset Flex Code
12306 \begin_layout Plain Layout
12312 , marks the style as being part of a title block (see also the
12313 \begin_inset Flex Code
12316 \begin_layout Plain Layout
12323 \begin_inset Flex Code
12326 \begin_layout Plain Layout
12335 \begin_layout Description
12336 \begin_inset Flex Code
12339 \begin_layout Plain Layout
12346 \begin_inset Flex Code
12349 \begin_layout Plain Layout
12355 ] The \SpecialChar LaTeX
12356 command sequence declaring an item in a list.
12357 The command is to be defined without the preceding backslash (the default
12359 \begin_inset Quotes eld
12363 \begin_inset Quotes erd
12367 \begin_inset Flex Code
12370 \begin_layout Plain Layout
12378 in the \SpecialChar LaTeX
12382 \begin_layout Description
12383 \begin_inset Flex Code
12386 \begin_layout Plain Layout
12393 \begin_inset Flex Code
12396 \begin_layout Plain Layout
12402 ] This provides extra space between paragraphs that have the same style.
12403 If you put other styles into an environment, each is separated with the
12405 \begin_inset Flex Code
12408 \begin_layout Plain Layout
12415 But the whole items of the environment are additionally separated with
12417 \begin_inset Flex Code
12420 \begin_layout Plain Layout
12427 Note that this is a
12432 \begin_layout Description
12433 \begin_inset Flex Code
12436 \begin_layout Plain Layout
12442 [FIXME] (Used only with XML-type formats.)
12445 \begin_layout Description
12446 \begin_inset Flex Code
12449 \begin_layout Plain Layout
12456 \begin_inset Flex Code
12459 \begin_layout Plain Layout
12468 \begin_inset space \thinspace{}
12472 \begin_inset Flex Code
12475 \begin_layout Plain Layout
12481 ] Usually \SpecialChar LyX
12482 does not allow you to leave a paragraph empty, since it would
12483 lead to empty \SpecialChar LaTeX
12485 There are some cases where this could be desirable however: in a letter
12486 template, the required fields can be provided as empty fields, so that
12487 people do not forget them; in some special classes, a style can be used
12488 as some kind of break, which does not contain actual text.
12491 \begin_layout Description
12492 \begin_inset Flex Code
12495 \begin_layout Plain Layout
12502 \begin_inset Flex Code
12505 \begin_layout Plain Layout
12511 ] The vertical space between the label and the text body.
12512 Only used for labels that are above the text body (
12513 \begin_inset Flex Code
12516 \begin_layout Plain Layout
12523 \begin_inset Newline newline
12527 \begin_inset Flex Code
12530 \begin_layout Plain Layout
12531 Centered_Top_Environment
12539 \begin_layout Description
12540 \begin_inset Flex Code
12543 \begin_layout Plain Layout
12550 \begin_inset Flex Code
12553 \begin_layout Plain Layout
12559 ] The name of the counter for automatic numbering.
12560 In order to have the counter appear with your label, you will need to reference
12562 \begin_inset Flex Code
12565 \begin_layout Plain Layout
12574 This will work with
12575 \begin_inset Flex Code
12578 \begin_layout Plain Layout
12585 \begin_inset Flex Code
12588 \begin_layout Plain Layout
12595 \begin_inset Flex Code
12598 \begin_layout Plain Layout
12605 \begin_inset Flex Code
12608 \begin_layout Plain Layout
12615 \begin_inset Newline newline
12623 \begin_inset Flex Code
12626 \begin_layout Plain Layout
12633 \begin_inset Flex Code
12636 \begin_layout Plain Layout
12642 , though this case is a bit complicated.
12643 Suppose you declare
12644 \begin_inset Quotes eld
12648 \begin_inset Flex Code
12651 \begin_layout Plain Layout
12652 LabelCounter myenum
12658 \begin_inset Quotes erd
12662 Then the actual counters used are
12663 \begin_inset Flex Code
12666 \begin_layout Plain Layout
12673 \begin_inset Flex Code
12676 \begin_layout Plain Layout
12683 \begin_inset Flex Code
12686 \begin_layout Plain Layout
12693 \begin_inset Flex Code
12696 \begin_layout Plain Layout
12702 , much as in \SpecialChar LaTeX
12704 These counters must all be declared separately.
12705 \begin_inset Newline newline
12709 \begin_inset CommandInset ref
12711 reference "subsec:Counters"
12715 for details on counters.
12718 \begin_layout Description
12719 \begin_inset Flex Code
12722 \begin_layout Plain Layout
12728 The font used for the label.
12730 \begin_inset CommandInset ref
12732 reference "subsec:Font-description"
12739 \begin_layout Description
12740 \begin_inset Flex Code
12743 \begin_layout Plain Layout
12750 \begin_inset Flex Code
12753 \begin_layout Plain Layout
12759 ] Text that indicates how far a label should be indented.
12762 \begin_layout Description
12763 \begin_inset Flex Code
12766 \begin_layout Plain Layout
12773 \begin_inset Flex Code
12776 \begin_layout Plain Layout
12782 ] Text that indicates the amount of horizontal space between the label and
12784 Only used for labels that are not above the text body.
12787 \begin_layout Description
12788 \begin_inset Flex Code
12791 \begin_layout Plain Layout
12798 \begin_inset Flex Code
12801 \begin_layout Plain Layout
12807 ] The string used for the label.
12809 \begin_inset Flex Code
12812 \begin_layout Plain Layout
12818 is set, this string can be contain the special formatting commands described
12820 \begin_inset CommandInset ref
12822 reference "subsec:Counters"
12829 \begin_layout Description
12830 \begin_inset Flex Code
12833 \begin_layout Plain Layout
12834 LabelStringAppendix
12840 \begin_inset Flex Code
12843 \begin_layout Plain Layout
12849 ] This is used inside the appendix instead of
12850 \begin_inset Newline newline
12854 \begin_inset Flex Code
12857 \begin_layout Plain Layout
12865 \begin_inset Flex Code
12868 \begin_layout Plain Layout
12875 \begin_inset Newline newline
12879 \begin_inset Flex Code
12882 \begin_layout Plain Layout
12883 LabelStringAppendix
12891 \begin_layout Description
12892 \begin_inset Flex Code
12895 \begin_layout Plain Layout
12901 [FIXME] (Used only with XML-type formats.)
12904 \begin_layout Description
12905 \begin_inset Flex Code
12908 \begin_layout Plain Layout
12915 \begin_inset Flex Code
12918 \begin_layout Plain Layout
12923 , Manual, Static, Above,
12924 \begin_inset Newline newline
12927 Centered, Sensitive, Enumerate,
12928 \begin_inset Newline newline
12931 Itemize, Bibliography
12940 \begin_layout Description
12941 \begin_inset Flex Code
12944 \begin_layout Plain Layout
12950 means the label is the very first word (up to the first real blank).
12951 Use protected spaces if you want more than one word as the label.
12955 \begin_layout Description
12956 \begin_inset Flex Code
12959 \begin_layout Plain Layout
12965 means the label is simply what is declared as
12966 \begin_inset Flex Code
12969 \begin_layout Plain Layout
12976 This will be displayed
12977 \begin_inset Quotes eld
12981 \begin_inset Quotes erd
12984 , at the beginning of the paragraph.
12986 \begin_inset Flex Code
12989 \begin_layout Plain Layout
12996 \begin_inset Flex Code
12999 \begin_layout Plain Layout
13005 , then it will be displayed only in the first paragraph of any sequence
13006 of paragraphs with the same
13007 \begin_inset Flex Code
13010 \begin_layout Plain Layout
13019 \begin_layout Description
13020 \begin_inset Flex Code
13023 \begin_layout Plain Layout
13030 \begin_inset space ~
13034 \begin_inset space ~
13038 \begin_inset Flex Code
13041 \begin_layout Plain Layout
13047 are special cases of
13048 \begin_inset Flex Code
13051 \begin_layout Plain Layout
13058 The label will be printed above the paragraph either at the beginning of
13059 the line or centered.
13062 \begin_layout Description
13063 \begin_inset Flex Code
13066 \begin_layout Plain Layout
13072 is a special case for the caption-labels
13073 \begin_inset Quotes eld
13077 \begin_inset Quotes erd
13081 \begin_inset Quotes eld
13085 \begin_inset Quotes erd
13089 \begin_inset Newline newline
13093 \begin_inset Flex Code
13096 \begin_layout Plain Layout
13102 means the (hardcoded) label string depends on the kind of float: It is
13103 hardcoded to be `FloatType N', where N is the value of the counter associated
13105 For the case that a caption is inserted outside of a float the
13106 \begin_inset Flex Code
13109 \begin_layout Plain Layout
13116 \begin_inset Quotes eld
13120 \begin_inset Quotes erd
13126 \begin_layout Description
13127 \begin_inset Flex Code
13130 \begin_layout Plain Layout
13136 produces the usual sort of enumeration labels.
13137 At present, it is hardcoded to use Arabic numerals, lowercase letters,
13138 small Roman numerals, and uppercase letters for the four possible depths.
13141 \begin_layout Description
13142 \begin_inset Flex Code
13145 \begin_layout Plain Layout
13151 produces various bullets at the different levels.
13152 It is also hardcoded.
13155 \begin_layout Description
13156 \begin_inset Flex Code
13159 \begin_layout Plain Layout
13165 should be used only with
13166 \begin_inset Flex Code
13169 \begin_layout Plain Layout
13170 LatexType BibEnvironment
13179 \begin_layout Description
13180 \begin_inset Flex Code
13183 \begin_layout Plain Layout
13189 Note that this will completely override any prior
13190 \begin_inset Flex Code
13193 \begin_layout Plain Layout
13199 declaration for this style.
13201 \begin_inset Quotes eld
13205 \begin_inset Flex Code
13208 \begin_layout Plain Layout
13215 \begin_inset Quotes erd
13220 \begin_inset CommandInset ref
13222 reference "subsec:I18n"
13226 for details on its use.
13229 \begin_layout Description
13230 \begin_inset Flex Code
13233 \begin_layout Plain Layout
13240 \begin_inset Flex Code
13243 \begin_layout Plain Layout
13249 ] The name of the corresponding \SpecialChar LaTeX
13251 Either the environment or command name.
13254 \begin_layout Description
13255 \begin_inset Flex Code
13258 \begin_layout Plain Layout
13265 \begin_inset Flex Code
13268 \begin_layout Plain Layout
13274 ] An optional parameter for the corresponding
13275 \begin_inset Flex Code
13278 \begin_layout Plain Layout
13285 This parameter cannot be changed from within \SpecialChar LyX
13287 \begin_inset Flex Code
13290 \begin_layout Plain Layout
13296 for customizable parameters).
13297 This will be output as is after all \SpecialChar LaTeX
13299 \begin_inset Flex Code
13302 \begin_layout Plain Layout
13311 \begin_layout Description
13312 \begin_inset Flex Code
13315 \begin_layout Plain Layout
13322 \begin_inset Flex Code
13325 \begin_layout Plain Layout
13330 , Command, Environment, Item_Environment,
13331 \begin_inset Newline newline
13334 List_Environment, Bib_Environment
13339 ] How the style should be translated into \SpecialChar LaTeX
13344 \begin_layout Plain Layout
13345 \begin_inset Flex Code
13348 \begin_layout Plain Layout
13354 is perhaps a bit misleading, since these rules apply to SGML classes, too.
13355 Visit the SGML class files for specific examples.
13364 \begin_layout Description
13365 \begin_inset Flex Code
13368 \begin_layout Plain Layout
13374 means nothing special.
13377 \begin_layout Description
13378 \begin_inset Flex Code
13381 \begin_layout Plain Layout
13388 \begin_inset Flex Code
13391 \begin_layout Plain Layout
13398 {\SpecialChar ldots
13407 \begin_layout Description
13408 \begin_inset Flex Code
13411 \begin_layout Plain Layout
13418 \begin_inset Flex Code
13421 \begin_layout Plain Layout
13428 }\SpecialChar ldots
13444 \begin_layout Description
13445 \begin_inset Flex Code
13448 \begin_layout Plain Layout
13455 \begin_inset Flex Code
13458 \begin_layout Plain Layout
13465 \begin_inset Flex Code
13468 \begin_layout Plain Layout
13476 is generated for each paragraph of this environment.
13480 \begin_layout Description
13481 \begin_inset Flex Code
13484 \begin_layout Plain Layout
13491 \begin_inset Flex Code
13494 \begin_layout Plain Layout
13501 \begin_inset Newline newline
13505 \begin_inset Flex Code
13508 \begin_layout Plain Layout
13514 is passed as an argument to the environment.
13515 \begin_inset Newline newline
13519 \begin_inset Flex Code
13522 \begin_layout Plain Layout
13528 can be defined in the
13529 \begin_inset Flex Noun
13532 \begin_layout Plain Layout
13533 Edit\SpecialChar menuseparator
13535 \begin_inset space ~
13546 \begin_layout Description
13547 \begin_inset Flex Code
13550 \begin_layout Plain Layout
13557 \begin_inset Flex Code
13560 \begin_layout Plain Layout
13566 but adds the necessary mandatory argument (the longest label) to the begin
13567 statement of the bibliography environment:
13568 \begin_inset Newline newline
13572 \begin_inset Flex Code
13575 \begin_layout Plain Layout
13578 begin{thebibliography}{99}
13584 It is therefore only useful for bibliography environments.
13585 The default longest label
13586 \begin_inset Quotes eld
13590 \begin_inset Quotes erd
13593 can be changed by the user in the paragraph settings of a bibliography
13597 \begin_layout Standard
13598 Putting the last few things together, the \SpecialChar LaTeX
13599 output will be either:
13602 \begin_layout LyX-Code
13605 LatexName[LatexParam]{\SpecialChar ldots
13609 \begin_layout Standard
13613 \begin_layout LyX-Code
13616 begin{LatexName}[LatexParam] \SpecialChar ldots
13622 \begin_layout Standard
13623 depending upon the \SpecialChar LaTeX
13628 \begin_layout Description
13629 \begin_inset Flex Code
13632 \begin_layout Plain Layout
13639 \begin_inset Flex Code
13642 \begin_layout Plain Layout
13648 ] A string that is put at the beginning of the style content.
13649 A line break in the output can be indicated by
13650 \begin_inset Flex Code
13653 \begin_layout Plain Layout
13662 \begin_layout Description
13663 \begin_inset Flex Code
13666 \begin_layout Plain Layout
13673 \begin_inset Flex Code
13676 \begin_layout Plain Layout
13682 ] If you put styles into environments, the different
13683 \begin_inset Flex Code
13686 \begin_layout Plain Layout
13692 are not simply added, but added with a factor
13693 \begin_inset Formula $\frac{4}{\mathrm{depth}+4}$
13697 Note that this parameter is also used when
13698 \begin_inset Flex Code
13701 \begin_layout Plain Layout
13708 \begin_inset Flex Code
13711 \begin_layout Plain Layout
13718 \begin_inset Flex Code
13721 \begin_layout Plain Layout
13728 Then it is added to the manual or dynamic margin.
13729 \begin_inset Newline newline
13733 \begin_inset Quotes eld
13737 \begin_inset Flex Code
13740 \begin_layout Plain Layout
13747 \begin_inset Quotes erd
13750 means that the paragraph is indented with the width of
13751 \begin_inset Quotes eld
13755 \begin_inset Flex Code
13758 \begin_layout Plain Layout
13765 \begin_inset Quotes erd
13768 in the normal font.
13769 You can get a negative width by prefixing the string with
13770 \begin_inset Quotes eld
13774 \begin_inset Flex Code
13777 \begin_layout Plain Layout
13784 \begin_inset Quotes erd
13788 This way was chosen so that the look is the same with each used screen
13792 \begin_layout Description
13793 \begin_inset Flex Code
13796 \begin_layout Plain Layout
13803 \begin_inset Flex Code
13806 \begin_layout Plain Layout
13811 , Manual, Dynamic, First_Dynamic, Right_Address_Box
13817 \begin_inset Newline newline
13820 The kind of margin that the style has on the left side.
13824 \begin_layout Description
13825 \begin_inset Flex Code
13828 \begin_layout Plain Layout
13834 just means a fixed margin.
13837 \begin_layout Description
13838 \begin_inset Flex Code
13841 \begin_layout Plain Layout
13847 means that the left margin depends on the string entered in the
13848 \begin_inset Flex Noun
13851 \begin_layout Plain Layout
13852 Edit\SpecialChar menuseparator
13854 \begin_inset space ~
13863 This is used to typeset nice lists without tabulators.
13866 \begin_layout Description
13867 \begin_inset Flex Code
13870 \begin_layout Plain Layout
13876 means that the margin depends on the size of the label.
13877 This is used for automatic enumerated headlines.
13878 It is obvious that the headline
13879 \begin_inset Quotes eld
13882 5.4.3.2.1 Very long headline
13883 \begin_inset Quotes erd
13886 must have a wider left margin (as wide as
13887 \begin_inset Quotes eld
13891 \begin_inset Quotes erd
13894 plus the space) than
13895 \begin_inset Quotes eld
13898 3.2 Very long headline
13899 \begin_inset Quotes erd
13903 \begin_inset Quotes eld
13907 \begin_inset Quotes erd
13910 are not able to do this.
13913 \begin_layout Description
13914 \begin_inset Flex Code
13917 \begin_layout Plain Layout
13923 is similar, but only the very first row of the paragraph is dynamic, while
13924 the others are static; this is used, for example, for descriptions.
13927 \begin_layout Description
13928 \begin_inset Flex Code
13931 \begin_layout Plain Layout
13937 means the margin is chosen in a way that the longest row of this paragraph
13938 fits to the right margin.
13939 This is used to typeset an address on the right edge of the page.
13943 \begin_layout Description
13944 \begin_inset Flex Code
13947 \begin_layout Plain Layout
13954 \begin_inset Flex Code
13957 \begin_layout Plain Layout
13966 \begin_inset space \thinspace{}
13970 \begin_inset Flex Code
13973 \begin_layout Plain Layout
13979 ] Whether fragile commands in this style should be
13980 \begin_inset Flex Code
13983 \begin_layout Plain Layout
13996 whether this command should itself be protected.)
13999 \begin_layout Description
14000 \begin_inset Flex Code
14003 \begin_layout Plain Layout
14010 \begin_inset Flex Code
14013 \begin_layout Plain Layout
14020 \begin_inset space \thinspace{}
14024 \begin_inset Flex Code
14027 \begin_layout Plain Layout
14035 ] Whether newlines are translated into \SpecialChar LaTeX
14037 \begin_inset Flex Code
14040 \begin_layout Plain Layout
14051 The translation can be switched off to allow more comfortable \SpecialChar LaTeX
14053 inside \SpecialChar LyX
14057 \begin_layout Description
14058 \begin_inset Flex Code
14061 \begin_layout Plain Layout
14068 \begin_inset Flex Code
14071 \begin_layout Plain Layout
14080 \begin_inset space \thinspace{}
14084 \begin_inset Flex Code
14087 \begin_layout Plain Layout
14093 ] If set to true, and if
14094 \begin_inset Flex Code
14097 \begin_layout Plain Layout
14104 \begin_inset Flex Code
14107 \begin_layout Plain Layout
14113 ) paragraphs are being indented, then the indentation of such a paragraph
14114 following one of this type will be suppressed.
14115 (So this will not affect the display of non-default paragraphs.)
14118 \begin_layout Description
14119 \begin_inset Flex Code
14122 \begin_layout Plain Layout
14129 \begin_inset Flex Code
14132 \begin_layout Plain Layout
14138 ] Name of a style that has replaced this style.
14139 This is used to rename a style, while keeping backward compatibility.
14142 \begin_layout Description
14143 \begin_inset Flex Code
14146 \begin_layout Plain Layout
14153 \begin_inset Flex Code
14156 \begin_layout Plain Layout
14163 \begin_inset space \thinspace{}
14167 \begin_inset Flex Code
14170 \begin_layout Plain Layout
14176 ] Determines whether consecutive pragraphs of the same type are treated
14177 as belonging together.
14178 This has the effect that the
14179 \begin_inset Flex Code
14182 \begin_layout Plain Layout
14188 is only printed once before such a group.
14189 By default, this is true for
14190 \begin_inset Flex Code
14193 \begin_layout Plain Layout
14200 \begin_inset Flex Code
14203 \begin_layout Plain Layout
14210 \begin_inset Flex Code
14213 \begin_layout Plain Layout
14219 and false for all other types.
14222 \begin_layout Description
14223 \begin_inset Flex Code
14226 \begin_layout Plain Layout
14233 \begin_inset Flex Code
14236 \begin_layout Plain Layout
14245 \begin_inset space \thinspace{}
14249 \begin_inset Flex Code
14252 \begin_layout Plain Layout
14258 ] Indicates that paragraphs will not be separated by an empty line in \SpecialChar LaTeX
14260 but only by a line break; together with
14261 \begin_inset Flex Code
14264 \begin_layout Plain Layout
14270 , this allows to emulate a plain text editor (like the ERT inset).
14273 \begin_layout Description
14274 \begin_inset Flex Code
14277 \begin_layout Plain Layout
14284 \begin_inset Flex Code
14287 \begin_layout Plain Layout
14293 ] The indent of the very first line of a paragraph.
14295 \begin_inset Newline newline
14299 \begin_inset Flex Code
14302 \begin_layout Plain Layout
14308 will be fixed for a certain style.
14309 The exception is the default style, since the indentation for these paragraphs
14310 can be prohibited with
14311 \begin_inset Flex Code
14314 \begin_layout Plain Layout
14322 \begin_inset Flex Code
14325 \begin_layout Plain Layout
14331 style paragraphs inside environments use the
14332 \begin_inset Flex Code
14335 \begin_layout Plain Layout
14341 of the environment, not their native one.
14343 \begin_inset Flex Code
14346 \begin_layout Plain Layout
14352 paragraphs inside an enumeration are not indented.
14355 \begin_layout Description
14356 \begin_inset Flex Code
14359 \begin_layout Plain Layout
14366 \begin_inset Flex Code
14369 \begin_layout Plain Layout
14375 ] The vertical space between two paragraphs of this style.
14378 \begin_layout Description
14379 \begin_inset Flex Code
14382 \begin_layout Plain Layout
14389 \begin_inset Flex Code
14392 \begin_layout Plain Layout
14399 allows the user to choose either
14400 \begin_inset Quotes eld
14404 \begin_inset Quotes erd
14408 \begin_inset Quotes eld
14412 \begin_inset Quotes erd
14415 to separate paragraphs.
14417 \begin_inset Quotes eld
14421 \begin_inset Quotes erd
14425 \begin_inset Flex Code
14428 \begin_layout Plain Layout
14436 \begin_inset Quotes eld
14440 \begin_inset Quotes erd
14444 \begin_inset Flex Code
14447 \begin_layout Plain Layout
14453 is ignored and all paragraphs are separated by the
14454 \begin_inset Flex Code
14457 \begin_layout Plain Layout
14464 The vertical space is calculated with
14465 \begin_inset Flex Code
14468 \begin_layout Plain Layout
14470 \begin_inset space ~
14479 \begin_inset Flex Code
14482 \begin_layout Plain Layout
14488 is the height of a row with the normal font.
14489 This way, the look stays the same with different screen fonts.
14492 \begin_layout Description
14493 \begin_inset Flex Code
14496 \begin_layout Plain Layout
14503 \begin_inset Flex Code
14506 \begin_layout Plain Layout
14515 \begin_inset space \thinspace{}
14519 \begin_inset Flex Code
14522 \begin_layout Plain Layout
14528 ] Whether the contents of this paragraph should be output in raw form, meaning
14529 without special translations that \SpecialChar LaTeX
14533 \begin_layout Description
14534 \begin_inset Flex Code
14537 \begin_layout Plain Layout
14544 \begin_inset Flex Code
14547 \begin_layout Plain Layout
14557 Defines individual characters that should be output in raw form, meaning
14558 without special translations that \SpecialChar LaTeX
14562 \begin_layout Description
14563 \begin_inset Flex Code
14566 \begin_layout Plain Layout
14572 Information to be included in the \SpecialChar LaTeX
14573 preamble when this style is used.
14574 Used to define macros, load packages, etc., required by this particular
14577 \begin_inset Quotes eld
14581 \begin_inset Flex Code
14584 \begin_layout Plain Layout
14591 \begin_inset Quotes erd
14597 \begin_layout Description
14598 \begin_inset Flex Code
14601 \begin_layout Plain Layout
14608 \begin_inset Flex Code
14611 \begin_layout Plain Layout
14617 ] The prefix to use when creating labels referring to paragraphs of this
14619 This allows the use of formatted references.
14622 \begin_layout Description
14623 \begin_inset Flex Code
14626 \begin_layout Plain Layout
14633 \begin_inset Flex Code
14636 \begin_layout Plain Layout
14642 ] Whether the style requires the feature
14643 \begin_inset Flex Code
14646 \begin_layout Plain Layout
14653 \begin_inset CommandInset ref
14655 reference "chap:List-of-functions"
14659 for the list of features).
14660 If you require a package with specific options, you can additionally use
14662 \begin_inset Flex Code
14665 \begin_layout Plain Layout
14671 as a general text class parameter (see
14672 \begin_inset CommandInset ref
14674 reference "subsec:General-text-class"
14681 \begin_layout Description
14682 \begin_inset Flex Code
14685 \begin_layout Plain Layout
14692 \begin_inset Flex Code
14695 \begin_layout Plain Layout
14704 \begin_inset Flex Code
14707 \begin_layout Plain Layout
14713 ] Resets the \SpecialChar LaTeX
14714 arguments of this style (as defined via the
14715 \begin_inset Flex Code
14718 \begin_layout Plain Layout
14725 This is useful if you have copied a style via
14726 \begin_inset Flex Code
14729 \begin_layout Plain Layout
14735 , but you do not want to inherit its (required and optional) arguments.
14736 \change_inserted 2089657418 1476488475
14740 \begin_layout Description
14742 \change_inserted 2089657418 1476488475
14743 \begin_inset Flex Code
14746 \begin_layout Plain Layout
14748 \change_inserted 2089657418 1476488475
14755 \begin_inset Flex Code
14758 \begin_layout Plain Layout
14760 \change_inserted 2089657418 1476488475
14769 \begin_inset Flex Code
14772 \begin_layout Plain Layout
14774 \change_inserted 2089657418 1476488475
14780 ] Resumes a counter that is usually reset at each new sequence of layouts.
14781 This is currently only useful when
14782 \begin_inset Flex Code
14785 \begin_layout Plain Layout
14787 \change_inserted 2089657418 1476488475
14794 \begin_inset Flex Code
14797 \begin_layout Plain Layout
14799 \change_inserted 2089657418 1476488475
14810 \begin_layout Description
14811 \begin_inset Flex Code
14814 \begin_layout Plain Layout
14821 \begin_inset Flex Code
14824 \begin_layout Plain Layout
14830 ] A string that is put at the end of the layout content.
14831 A line break in the output can be indicated by
14832 \begin_inset Flex Code
14835 \begin_layout Plain Layout
14844 \begin_layout Description
14845 \begin_inset Flex Code
14848 \begin_layout Plain Layout
14855 \begin_inset Flex Code
14858 \begin_layout Plain Layout
14865 \begin_inset Flex Code
14868 \begin_layout Plain Layout
14877 \begin_layout Description
14878 \begin_inset Flex Code
14881 \begin_layout Plain Layout
14888 \begin_inset Flex Code
14891 \begin_layout Plain Layout
14900 \begin_inset Flex Code
14903 \begin_layout Plain Layout
14910 \begin_inset Flex Code
14913 \begin_layout Plain Layout
14920 \begin_inset Flex Code
14923 \begin_layout Plain Layout
14925 \begin_inset space ~
14933 ] This defines what the default spacing should be in the style.
14935 \begin_inset Flex Code
14938 \begin_layout Plain Layout
14945 \begin_inset Flex Code
14948 \begin_layout Plain Layout
14955 \begin_inset Flex Code
14958 \begin_layout Plain Layout
14964 correspond respectively to a multiplier value of 1, 1.25 and 1.667.
14965 If you specify the argument
14966 \begin_inset Flex Code
14969 \begin_layout Plain Layout
14975 , then you must also provide a value argument which will be the actual multiplie
14977 Note that, contrary to other parameters,
14978 \begin_inset Flex Code
14981 \begin_layout Plain Layout
14987 implies the generation of specific \SpecialChar LaTeX
14988 code, using the \SpecialChar LaTeX
14992 \begin_inset Flex Code
14995 \begin_layout Plain Layout
15004 \begin_layout Description
15005 \begin_inset Flex Code
15008 \begin_layout Plain Layout
15015 \begin_inset Flex Code
15018 \begin_layout Plain Layout
15025 \begin_inset space \thinspace{}
15029 \begin_inset Flex Code
15032 \begin_layout Plain Layout
15040 ] Allow spell-checking paragraphs of this style.
15042 \change_inserted 2089657418 1476488264
15046 \begin_layout Description
15048 \change_inserted 2089657418 1476488264
15049 \begin_inset Flex Code
15052 \begin_layout Plain Layout
15054 \change_inserted 2089657418 1476488264
15061 \begin_inset Flex Code
15064 \begin_layout Plain Layout
15066 \change_inserted 2089657418 1476488264
15075 \begin_inset Flex Code
15078 \begin_layout Plain Layout
15080 \change_inserted 2089657418 1476488264
15086 ] Steps the master counter of a given counter at the beginning of a new
15087 sequence of layouts.
15088 This is currently only useful when
15089 \begin_inset Flex Code
15092 \begin_layout Plain Layout
15094 \change_inserted 2089657418 1476488264
15101 \begin_inset Flex Code
15104 \begin_layout Plain Layout
15106 \change_inserted 2089657418 1476488264
15117 \begin_layout Description
15118 \begin_inset Flex Code
15121 \begin_layout Plain Layout
15127 The font used for the text body .
15129 \begin_inset CommandInset ref
15131 reference "subsec:Font-description"
15138 \begin_layout Description
15139 \begin_inset Flex Code
15142 \begin_layout Plain Layout
15151 \begin_inset Flex Code
15154 \begin_layout Plain Layout
15164 The level of the style in the table of contents.
15165 This is used for automatic numbering of section headings.
15168 \begin_layout Description
15169 \begin_inset Flex Code
15172 \begin_layout Plain Layout
15181 \begin_inset Flex Code
15184 \begin_layout Plain Layout
15195 \begin_inset Flex Code
15198 \begin_layout Plain Layout
15205 \begin_inset Flex Code
15208 \begin_layout Plain Layout
15214 ] This tag determines whether the first line indentation of this paragraph
15215 can be toggled via the Paragraph settings dialog.
15219 \begin_inset Flex Code
15222 \begin_layout Plain Layout
15232 is set, indentation can be toggled if the document settings use
15233 \begin_inset Quotes eld
15237 \begin_inset Quotes erd
15240 paragraph style, with
15241 \begin_inset Flex Code
15244 \begin_layout Plain Layout
15250 , indentation can always be toggled, notwithstanding the document settings,
15252 \begin_inset Flex Code
15255 \begin_layout Plain Layout
15261 , indentation can never be toggled.
15264 \begin_layout Description
15265 \begin_inset Flex Code
15268 \begin_layout Plain Layout
15275 \begin_inset Flex Code
15278 \begin_layout Plain Layout
15284 ] The vertical space with which the very first of a chain of paragraphs
15285 with this style is separated from the previous paragraph.
15286 If the previous paragraph has another style, the separations are not simply
15287 added, but the maximum is taken.
15290 \begin_layout Subsection
15291 \begin_inset CommandInset label
15297 Internationalization of Paragraph Styles
15300 \begin_layout Standard
15302 has long supported internationalization of layout information, but, until
15303 version 2.0, this applied only to the user interface and not to, say, PDF
15305 Thus, French authors were forced to resort to ugly hacks if they wanted
15310 1' instead of `Theorem 1'.
15311 Thanks to Georg Baum, that is no longer the case.
15314 \begin_layout Standard
15316 \begin_inset Flex Code
15319 \begin_layout Plain Layout
15325 defines text that is to appear in the typeset document, it may use
15326 \begin_inset Flex Code
15329 \begin_layout Plain Layout
15336 \begin_inset Flex Code
15339 \begin_layout Plain Layout
15345 to support non-English and even multi-language documents correctly.
15346 The following excerpt (from the
15347 \begin_inset Flex Code
15350 \begin_layout Plain Layout
15356 file) shows how this works:
15359 \begin_layout LyX-Code
15364 \begin_layout LyX-Code
15367 theoremstyle{remark}
15370 \begin_layout LyX-Code
15373 newtheorem{claim}[thm]{
15380 \begin_layout LyX-Code
15384 \begin_layout LyX-Code
15388 \begin_layout LyX-Code
15393 claimname}{_(Claim)}
15396 \begin_layout LyX-Code
15400 \begin_layout LyX-Code
15404 \begin_layout LyX-Code
15413 claimname}{_(Claim)}}
15416 \begin_layout LyX-Code
15421 \begin_layout Standard
15422 In principle, any legal \SpecialChar LaTeX
15424 \begin_inset Flex Code
15427 \begin_layout Plain Layout
15434 \begin_inset Flex Code
15437 \begin_layout Plain Layout
15443 tags, but in practice they will typically look as they do here.
15444 The key to correct translation of the typeset text is the definition of
15445 the \SpecialChar LaTeX
15447 \begin_inset Flex Code
15450 \begin_layout Plain Layout
15459 \begin_inset Flex Code
15462 \begin_layout Plain Layout
15474 \begin_layout Standard
15476 \begin_inset Flex Code
15479 \begin_layout Plain Layout
15485 tag provides for internationalization based upon the overall language of
15487 The contents of the tag will be included in the preamble, just as with
15489 \begin_inset Flex Code
15492 \begin_layout Plain Layout
15499 What makes it special is the use of the
15500 \begin_inset Quotes eld
15504 \begin_inset Quotes erd
15508 \begin_inset Flex Code
15511 \begin_layout Plain Layout
15517 , which will be replaced, when \SpecialChar LyX
15518 produces \SpecialChar LaTeX
15519 output, with the translation of
15520 its argument into the document language.
15523 \begin_layout Standard
15525 \begin_inset Flex Code
15528 \begin_layout Plain Layout
15534 tag is more complex, since it is meant to provide support for multi-language
15535 documents and so offers an interface to the
15536 \begin_inset Flex Code
15539 \begin_layout Plain Layout
15546 Its contents will be added to the preamble once for each language that
15547 appears in the document.
15548 In this case, the argument to
15549 \begin_inset Flex Code
15552 \begin_layout Plain Layout
15558 will be replaced with its translation into the language in question; the
15560 \begin_inset Flex Code
15563 \begin_layout Plain Layout
15569 is replaced by the language name (as used by the babel package).
15572 \begin_layout Standard
15573 A German document that also included a French section would thus have the
15574 following in the preamble:
15577 \begin_layout LyX-Code
15586 claimname}{Affirmation}}
15587 \begin_inset Newline newline
15598 claimname}{Behauptung}}
15599 \begin_inset Newline newline
15606 claimname}{Behauptung}
15609 \begin_layout Standard
15612 \begin_inset Flex Code
15615 \begin_layout Plain Layout
15621 will then conspire to produce the correct text in the output.
15624 \begin_layout Standard
15625 One important point to note here is that the translations are provided by
15627 itself, through the file
15628 \begin_inset Flex Code
15631 \begin_layout Plain Layout
15638 This means, in effect, that
15639 \begin_inset Flex Code
15642 \begin_layout Plain Layout
15649 \begin_inset Flex Code
15652 \begin_layout Plain Layout
15658 are really only of use in layout files that are provided with \SpecialChar LyX
15660 entered in user-created layout files will not be seen by \SpecialChar LyX
15661 's internationalizatio
15662 n routines unless the
15663 \begin_inset Flex Code
15666 \begin_layout Plain Layout
15672 file is modified accordingly.
15673 That said, however, any layout created with the intention that it will
15674 be included with \SpecialChar LyX
15675 should use these tags where appropriate.
15676 Please note that the paragraph style translations provided by \SpecialChar LyX
15678 change with a minor update (e.
15679 \begin_inset space \thinspace{}
15683 \begin_inset space \space{}
15686 from version 2.1.x to 2.1.y).
15687 It is however quite likely that a major update (e.
15688 \begin_inset space \thinspace{}
15692 \begin_inset space \space{}
15695 from 2.0.x to 2.1.y) will introduce new translations or corrections.
15698 \begin_layout Subsection
15700 \begin_inset CommandInset label
15702 name "subsec:Floats"
15709 \begin_layout Standard
15710 It is necessary to define the floats (
15711 \begin_inset Flex Noun
15714 \begin_layout Plain Layout
15721 \begin_inset Flex Noun
15724 \begin_layout Plain Layout
15730 , \SpecialChar ldots
15731 ) in the text class itself.
15732 Standard floats are included in the file
15733 \begin_inset Flex Code
15736 \begin_layout Plain Layout
15742 , so you may have to do no more than add
15745 \begin_layout LyX-Code
15746 Input stdfloats.inc
15749 \begin_layout Standard
15750 to your layout file.
15751 If you want to implement a text class that proposes some other float types
15752 (like the AGU class bundled with \SpecialChar LyX
15753 ), the information below will hopefully
15757 \begin_layout Description
15758 \begin_inset Flex Code
15761 \begin_layout Plain Layout
15768 \begin_inset Flex Code
15771 \begin_layout Plain Layout
15777 =!htbpH] Allowed placement options for this float type.
15778 The value is a string of placement characters.
15779 Possible characters include:
15784 \begin_inset Quotes eld
15788 \begin_inset Quotes erd
15796 \begin_inset Quotes eld
15800 \begin_inset Quotes erd
15808 \begin_inset Quotes eld
15812 \begin_inset Quotes erd
15820 \begin_inset Quotes eld
15824 \begin_inset Quotes erd
15832 \begin_inset Quotes eld
15836 \begin_inset Quotes erd
15844 \begin_inset Quotes eld
15848 \begin_inset Quotes erd
15852 The order of the characters in the string does not matter.
15853 If no placement options are allowed, use the string
15860 \begin_layout Description
15861 \begin_inset Flex Code
15864 \begin_layout Plain Layout
15871 \begin_inset Flex Code
15874 \begin_layout Plain Layout
15883 \begin_inset space \thinspace{}
15889 \begin_inset Flex Code
15892 \begin_layout Plain Layout
15902 ] Defines whether the float allows to be rotated via the \SpecialChar LaTeX
15909 \begin_inset Flex Code
15912 \begin_layout Plain Layout
15918 if the float does not support this feature.
15921 \begin_layout Description
15922 \begin_inset Flex Code
15925 \begin_layout Plain Layout
15932 \begin_inset Flex Code
15935 \begin_layout Plain Layout
15944 \begin_inset space \thinspace{}
15950 \begin_inset Flex Code
15953 \begin_layout Plain Layout
15963 ] Defines whether the float has a starred variant that spans columns in
15964 a two column paragraph.
15966 \begin_inset Flex Code
15969 \begin_layout Plain Layout
15975 if the float does not support this feature.
15978 \begin_layout Description
15979 \begin_inset Flex Code
15982 \begin_layout Plain Layout
15989 \begin_inset Flex Code
15992 \begin_layout Plain Layout
15999 \begin_inset Quotes erd
16003 \begin_inset Quotes erd
16006 ] The file name extension of an auxiliary file for the list of figures (or
16009 writes the captions to this file.
16012 \begin_layout Description
16013 \begin_inset Flex Code
16016 \begin_layout Plain Layout
16023 \begin_inset Flex Code
16026 \begin_layout Plain Layout
16033 \begin_inset Quotes erd
16037 \begin_inset Quotes erd
16040 ] The string that will be used in the menus and also for the caption.
16041 This is translated to the current language if babel is used.
16044 \begin_layout Description
16045 \begin_inset Flex Code
16048 \begin_layout Plain Layout
16054 These tags control the XHTML output.
16056 \begin_inset CommandInset ref
16058 reference "sec:Tags-for-XHTML"
16065 \begin_layout Description
16066 \begin_inset Flex Code
16069 \begin_layout Plain Layout
16078 \begin_inset Flex Code
16081 \begin_layout Plain Layout
16090 \begin_inset space \thinspace{}
16094 \begin_inset Flex Code
16097 \begin_layout Plain Layout
16103 ] Indicates whether the float is already defined in the document class or
16104 if instead the \SpecialChar LaTeX
16106 \begin_inset Flex Code
16109 \begin_layout Plain Layout
16115 needs to be loaded to define it on-the-fly.
16117 \begin_inset Flex Code
16120 \begin_layout Plain Layout
16127 \begin_inset Flex Code
16130 \begin_layout Plain Layout
16137 It should be set to
16138 \begin_inset Flex Code
16141 \begin_layout Plain Layout
16147 if the float is already defined by the \SpecialChar LaTeX
16151 \begin_layout Description
16152 \begin_inset Flex Code
16155 \begin_layout Plain Layout
16162 \begin_inset Flex Code
16165 \begin_layout Plain Layout
16172 \begin_inset Quotes erd
16176 \begin_inset Quotes erd
16179 ] The command used to generate a list of floats of this type; the leading
16188 \begin_inset Flex Code
16191 \begin_layout Plain Layout
16197 is false, since there is no standard way to generate this command.
16199 \begin_inset Flex Code
16202 \begin_layout Plain Layout
16208 is true, since in that case there is a standard way to define the command.
16211 \begin_layout Description
16212 \begin_inset Flex Code
16215 \begin_layout Plain Layout
16222 \begin_inset Flex Code
16225 \begin_layout Plain Layout
16232 \begin_inset Quotes erd
16236 \begin_inset Quotes erd
16239 ] A title for a list of floats of this kind (list of figures, tables, or
16241 It is used for the screen label within \SpecialChar LyX
16242 , it is used by \SpecialChar LaTeX
16244 it is used as the title in the XHTML output.
16245 It will be translated to the document language.
16248 \begin_layout Description
16249 \begin_inset Flex Code
16252 \begin_layout Plain Layout
16259 \begin_inset Flex Code
16262 \begin_layout Plain Layout
16269 \begin_inset Quotes erd
16273 \begin_inset Quotes erd
16276 ] This (optional) argument determines whether floats of this class will
16277 be numbered within some sectional unit of the document.
16279 \begin_inset Flex Code
16282 \begin_layout Plain Layout
16289 \begin_inset Quotes eld
16293 \begin_inset Flex Code
16296 \begin_layout Plain Layout
16303 \begin_inset Quotes erd
16306 , the floats will be numbered within chapters.
16310 \begin_layout Description
16311 \begin_inset Flex Code
16314 \begin_layout Plain Layout
16321 \begin_inset Flex Code
16324 \begin_layout Plain Layout
16331 \begin_inset Quotes erd
16335 \begin_inset Quotes erd
16338 ] The default placement for the given class of floats.
16339 The string should be as in standard \SpecialChar LaTeX
16341 \begin_inset Flex Code
16344 \begin_layout Plain Layout
16351 \begin_inset Flex Code
16354 \begin_layout Plain Layout
16361 \begin_inset Flex Code
16364 \begin_layout Plain Layout
16371 \begin_inset Flex Code
16374 \begin_layout Plain Layout
16380 for top, bottom, page, and here, respectively.
16384 \begin_layout Plain Layout
16385 Note that the order of these letters in the string is irrelevant, like in
16392 On top of that there is a new type,
16393 \begin_inset Flex Code
16396 \begin_layout Plain Layout
16402 , which does not really correspond to a float, since it means: put it
16403 \begin_inset Quotes eld
16407 \begin_inset Quotes erd
16411 Note however that the
16412 \begin_inset Flex Code
16415 \begin_layout Plain Layout
16421 specifier is special and, because of implementation details, cannot be
16422 used in non-built in float types.
16423 If you do not understand what this means, just use
16424 \begin_inset Quotes eld
16428 \begin_inset Flex Code
16431 \begin_layout Plain Layout
16438 \begin_inset Quotes erd
16444 \begin_layout Description
16445 \begin_inset Flex Code
16448 \begin_layout Plain Layout
16455 \begin_inset Flex Code
16458 \begin_layout Plain Layout
16464 ] The prefix to use when creating labels referring to floats of this type.
16465 This allows the use of formatted references.
16466 Note that you can remove any
16467 \begin_inset Flex Code
16470 \begin_layout Plain Layout
16476 set by a copied style by using the special value
16477 \begin_inset Quotes eld
16481 \begin_inset Quotes erd
16484 , which must be all caps.
16487 \begin_layout Description
16488 \begin_inset Flex Code
16491 \begin_layout Plain Layout
16498 \begin_inset Flex Code
16501 \begin_layout Plain Layout
16508 \begin_inset Quotes erd
16512 \begin_inset Quotes erd
16515 ] The style used when defining the float using
16516 \begin_inset Flex Code
16519 \begin_layout Plain Layout
16530 \begin_layout Description
16531 \begin_inset Flex Code
16534 \begin_layout Plain Layout
16541 \begin_inset Flex Code
16544 \begin_layout Plain Layout
16551 \begin_inset Quotes erd
16555 \begin_inset Quotes erd
16559 \begin_inset Quotes eld
16563 \begin_inset Quotes erd
16566 of the new class of floats, like program or algorithm.
16567 After the appropriate
16568 \begin_inset Flex Code
16571 \begin_layout Plain Layout
16580 \begin_inset Flex Code
16583 \begin_layout Plain Layout
16592 \begin_inset Flex Code
16595 \begin_layout Plain Layout
16606 \begin_layout Description
16607 \begin_inset Flex Code
16610 \begin_layout Plain Layout
16617 \begin_inset Flex Code
16620 \begin_layout Plain Layout
16627 \begin_inset space \thinspace{}
16631 \begin_inset Flex Code
16634 \begin_layout Plain Layout
16642 ] Specifies whether this float is defined using the \SpecialChar LaTeX
16644 \begin_inset Flex Code
16647 \begin_layout Plain Layout
16653 , either by the class file, another package or on-the-fly by \SpecialChar LyX
16657 \begin_layout Standard
16658 Note that defining a float with type
16659 \begin_inset Flex Code
16662 \begin_layout Plain Layout
16670 automatically defines the corresponding counter with name
16671 \begin_inset Flex Code
16674 \begin_layout Plain Layout
16685 \begin_layout Subsection
16686 Flex insets and InsetLayout
16687 \begin_inset CommandInset label
16689 name "subsec:Flex-insets-and"
16696 \begin_layout Standard
16697 Flex insets come in three different kinds:
16700 \begin_layout Itemize
16702 \begin_inset Flex Code
16705 \begin_layout Plain Layout
16711 ): These define semantic markup corresponding to such \SpecialChar LaTeX
16713 \begin_inset Flex Code
16716 \begin_layout Plain Layout
16725 \begin_inset Flex Code
16728 \begin_layout Plain Layout
16739 \begin_layout Itemize
16741 \begin_inset Flex Code
16744 \begin_layout Plain Layout
16750 ): These can be used to define custom collapsible insets, similar to \SpecialChar TeX
16752 footnote, and the like.
16753 An obvious example is an endnote inset, which is defined in the
16754 \begin_inset Flex Code
16757 \begin_layout Plain Layout
16766 \begin_layout Itemize
16768 \begin_inset Flex Code
16771 \begin_layout Plain Layout
16777 ): For use with DocBook classes.
16780 \begin_layout Standard
16781 Flex insets are defined using the
16782 \begin_inset Flex Code
16785 \begin_layout Plain Layout
16791 tag, which shall be explained in a moment.
16794 \begin_layout Standard
16796 \begin_inset Flex Code
16799 \begin_layout Plain Layout
16805 tag also serves another function: It can be used to customize the general
16806 layout of many different types of insets.
16808 \begin_inset Flex Code
16811 \begin_layout Plain Layout
16817 can be used to customize the layout parameters for footnotes, marginal
16818 notes, note insets, \SpecialChar TeX
16819 code (ERT) insets, branches, listings, indexes, boxes,
16820 tables, algorithms, URLs, and captions, as well as to define Flex insets.
16823 \begin_layout Standard
16825 \begin_inset Flex Code
16828 \begin_layout Plain Layout
16834 definition must begin with a line of the form:
16837 \begin_layout LyX-Code
16841 \begin_layout Standard
16843 \begin_inset Flex Code
16846 \begin_layout Plain Layout
16852 indicates the inset whose layout is being defined, and here there are four
16856 \begin_layout Enumerate
16857 The layout for a pre-existing inset is being modified.
16858 In this case, can be
16859 \begin_inset Flex Code
16862 \begin_layout Plain Layout
16868 any one of the following:
16869 \begin_inset Flex Code
16872 \begin_layout Plain Layout
16879 \begin_inset Flex Code
16882 \begin_layout Plain Layout
16889 \begin_inset Flex Code
16892 \begin_layout Plain Layout
16899 \begin_inset Flex Code
16902 \begin_layout Plain Layout
16909 \begin_inset Flex Code
16912 \begin_layout Plain Layout
16919 \begin_inset Flex Code
16922 \begin_layout Plain Layout
16929 \begin_inset Flex Code
16932 \begin_layout Plain Layout
16939 \begin_inset Flex Code
16942 \begin_layout Plain Layout
16949 \begin_inset Flex Code
16952 \begin_layout Plain Layout
16959 \begin_inset Flex Code
16962 \begin_layout Plain Layout
16969 \begin_inset Flex Code
16972 \begin_layout Plain Layout
16979 \begin_inset Flex Code
16982 \begin_layout Plain Layout
16989 \begin_inset Flex Code
16992 \begin_layout Plain Layout
16999 \begin_inset Flex Code
17002 \begin_layout Plain Layout
17009 \begin_inset Flex Code
17012 \begin_layout Plain Layout
17019 \begin_inset Flex Code
17022 \begin_layout Plain Layout
17029 \begin_inset Flex Code
17032 \begin_layout Plain Layout
17039 \begin_inset Flex Code
17042 \begin_layout Plain Layout
17049 \begin_inset Flex Code
17052 \begin_layout Plain Layout
17059 \begin_inset Flex Code
17062 \begin_layout Plain Layout
17071 \begin_layout Enumerate
17072 The layout for a Flex inset is being defined.
17074 \begin_inset Flex Code
17077 \begin_layout Plain Layout
17083 must be of the form
17084 \begin_inset Quotes eld
17088 \begin_inset Flex Code
17091 \begin_layout Plain Layout
17098 \begin_inset Quotes erd
17102 \begin_inset Flex Code
17105 \begin_layout Plain Layout
17111 may be be any valid identifier not used by a pre-existing Flex inset.
17112 The identifier may include spaces, but in that case the whole thing must
17113 be wrapped in quotes.
17114 Note that the definition of a flex inset
17119 \begin_inset Flex Code
17122 \begin_layout Plain Layout
17128 entry, declaring which type of inset it defines.
17131 \begin_layout Enumerate
17132 The layout for user specific branch is being defined.
17134 \begin_inset Flex Code
17137 \begin_layout Plain Layout
17143 must be of the form
17144 \begin_inset Quotes eld
17148 \begin_inset Flex Code
17151 \begin_layout Plain Layout
17158 \begin_inset Quotes erd
17162 \begin_inset Flex Code
17165 \begin_layout Plain Layout
17171 may be be any valid identifier of branch defined in user's document.
17172 The identifier may include spaces, but in that case the whole thing must
17173 be wrapped in quotes.
17174 The main purpose of this feature is to allow \SpecialChar LaTeX
17175 wrapping around specific
17176 branches as user needs.
17179 \begin_layout Enumerate
17180 The layout of a user (or class) specific caption is being defined.
17182 \begin_inset Flex Code
17185 \begin_layout Plain Layout
17191 must be of the form
17192 \begin_inset Quotes eld
17196 \begin_inset Flex Code
17199 \begin_layout Plain Layout
17206 \begin_inset Quotes erd
17210 \begin_inset Flex Code
17213 \begin_layout Plain Layout
17219 specifies the name of the caption as it appears in the menu.
17220 Have a look at the standard caption (
17221 \begin_inset Flex Code
17224 \begin_layout Plain Layout
17230 ), the specific captions of the KOMA-Script classes (
17231 \begin_inset Flex Code
17234 \begin_layout Plain Layout
17241 \begin_inset Flex Code
17244 \begin_layout Plain Layout
17253 \begin_inset space ~
17259 \begin_inset Flex Code
17262 \begin_layout Plain Layout
17268 ) for applications.
17271 \begin_layout Standard
17273 \begin_inset Flex Code
17276 \begin_layout Plain Layout
17282 definition can contain the following entries:
17285 \begin_layout Description
17286 \begin_inset Flex Code
17289 \begin_layout Plain Layout
17296 \begin_inset Flex Code
17299 \begin_layout Plain Layout
17305 ] Defines argument number of a command\SpecialChar breakableslash
17306 environment associated with the current
17308 The definition must end with
17309 \begin_inset Flex Code
17312 \begin_layout Plain Layout
17320 \begin_inset CommandInset ref
17322 reference "subsec:Paragraph-Styles"
17329 \begin_layout Description
17330 \begin_inset Flex Code
17333 \begin_layout Plain Layout
17339 Preamble for changing language commands; see
17340 \begin_inset CommandInset ref
17342 reference "subsec:I18n"
17349 \begin_layout Description
17350 \begin_inset Flex Code
17353 \begin_layout Plain Layout
17360 \begin_inset Flex Code
17363 \begin_layout Plain Layout
17369 ] The color for the inset's background.
17371 \begin_inset CommandInset ref
17373 reference "chap:Names-of-colors"
17377 for a list of the available color names.
17380 \begin_layout Description
17381 \begin_inset Flex Code
17384 \begin_layout Plain Layout
17391 \begin_inset Flex Code
17394 \begin_layout Plain Layout
17403 \begin_inset space \thinspace{}
17407 \begin_inset Flex Code
17410 \begin_layout Plain Layout
17416 ] Whether to use the content of the inset as the label, when the inset is
17421 \begin_layout Description
17422 \begin_inset Flex Code
17425 \begin_layout Plain Layout
17432 \begin_inset Flex Code
17435 \begin_layout Plain Layout
17441 ] As with paragraph styles, see
17442 \begin_inset CommandInset ref
17444 reference "subsec:Paragraph-Styles"
17449 Note that you need to specify the complete type, e.
17450 \begin_inset space \thinspace{}
17454 \begin_inset space ~
17458 \begin_inset Flex Code
17461 \begin_layout Plain Layout
17462 CopyStyle Flex:<name>
17470 \begin_layout Description
17471 \begin_inset Flex Code
17474 \begin_layout Plain Layout
17481 \begin_inset Flex Code
17484 \begin_layout Plain Layout
17493 \begin_inset space \thinspace{}
17497 \begin_inset Flex Code
17500 \begin_layout Plain Layout
17506 ] Indicates whether the user may employ the Paragraph Settings dialog to
17507 customize the paragraph.
17510 \begin_layout Description
17511 \begin_inset Flex Code
17514 \begin_layout Plain Layout
17521 \begin_inset Flex Code
17524 \begin_layout Plain Layout
17531 \begin_inset Flex Code
17534 \begin_layout Plain Layout
17541 \begin_inset Flex Code
17544 \begin_layout Plain Layout
17550 , describing the rendering style used for the inset's frame and buttons.
17551 Footnotes generally use
17552 \begin_inset Flex Code
17555 \begin_layout Plain Layout
17561 , ERT insets generally
17562 \begin_inset Flex Code
17565 \begin_layout Plain Layout
17571 , and character styles
17572 \begin_inset Flex Code
17575 \begin_layout Plain Layout
17584 \begin_layout Description
17585 \begin_inset Flex Code
17588 \begin_layout Plain Layout
17595 \begin_inset Flex Code
17598 \begin_layout Plain Layout
17607 \begin_inset space \thinspace{}
17613 \begin_inset Flex Code
17616 \begin_layout Plain Layout
17625 \begin_inset Flex Code
17628 \begin_layout Plain Layout
17635 \begin_inset Flex Code
17638 \begin_layout Plain Layout
17645 Indicates whether the environment will stand on its own in the output or
17646 will appear inline with the surrounding text.
17647 If set to false, it is supposed that the \SpecialChar LaTeX
17648 environment ignores white space
17649 (including one newline character) after the
17650 \begin_inset Flex Code
17653 \begin_layout Plain Layout
17666 \begin_inset Flex Code
17669 \begin_layout Plain Layout
17685 \begin_layout Description
17686 \begin_inset Flex Code
17689 \begin_layout Plain Layout
17695 Required at the end of the
17696 \begin_inset Flex Code
17699 \begin_layout Plain Layout
17708 \begin_layout Description
17709 \begin_inset Flex Code
17712 \begin_layout Plain Layout
17718 The font used for both the text body
17724 \begin_inset CommandInset ref
17726 reference "subsec:Font-description"
17731 Note that defining this font automatically defines the
17732 \begin_inset Flex Code
17735 \begin_layout Plain Layout
17741 to the same value, so define this first and define
17742 \begin_inset Flex Code
17745 \begin_layout Plain Layout
17751 later if you want them to be different.
17754 \begin_layout Description
17755 \begin_inset Flex Code
17758 \begin_layout Plain Layout
17759 FixedWidthPreambleEncoding
17765 \begin_inset Flex Code
17768 \begin_layout Plain Layout
17777 \begin_inset space \thinspace{}
17781 \begin_inset Flex Code
17784 \begin_layout Plain Layout
17790 ] Force a fixed width encoding for the translated contents of
17791 \begin_inset Flex Code
17794 \begin_layout Plain Layout
17801 \begin_inset Flex Code
17804 \begin_layout Plain Layout
17810 code generated by this layout.
17811 This is needed for special \SpecialChar LaTeX
17816 that do not work with variable width encodings such as
17821 This setting is ignored if fully Unicode aware \SpecialChar LaTeX
17822 backends such as Xe\SpecialChar TeX
17824 Lua\SpecialChar TeX
17828 \begin_layout Description
17829 \begin_inset Flex Code
17832 \begin_layout Plain Layout
17833 ForceLocalFontSwitch
17839 \begin_inset Flex Code
17842 \begin_layout Plain Layout
17851 \begin_inset space \thinspace{}
17855 \begin_inset Flex Code
17858 \begin_layout Plain Layout
17864 ] When using babel, always use a local font switch (
17865 \begin_inset Flex Code
17868 \begin_layout Plain Layout
17876 ), never a global one (such as
17877 \begin_inset Flex Code
17880 \begin_layout Plain Layout
17891 \begin_layout Description
17892 \begin_inset Flex Code
17895 \begin_layout Plain Layout
17902 \begin_inset Flex Code
17905 \begin_layout Plain Layout
17914 \begin_inset space \thinspace{}
17918 \begin_inset Flex Code
17921 \begin_layout Plain Layout
17928 \begin_inset Quotes eld
17932 \begin_inset Quotes erd
17935 language, leading to Left-to-Right (Latin) output, e.
17936 \begin_inset space \thinspace{}
17940 \begin_inset space \space{}
17943 in \SpecialChar TeX
17948 \begin_layout Description
17949 \begin_inset Flex Code
17952 \begin_layout Plain Layout
17959 \begin_inset Flex Code
17962 \begin_layout Plain Layout
17971 \begin_inset space \thinspace{}
17975 \begin_inset Flex Code
17978 \begin_layout Plain Layout
17984 ] Force a a line break in the \SpecialChar LaTeX
17985 output before the inset starts and after
17987 This assures the inset itself is output on its own lines, for parsing purposes.
17990 \begin_layout Description
17991 \begin_inset Flex Code
17994 \begin_layout Plain Layout
18001 \begin_inset Flex Code
18004 \begin_layout Plain Layout
18013 \begin_inset space \thinspace{}
18017 \begin_inset Flex Code
18020 \begin_layout Plain Layout
18026 ] Indicates whether the
18027 \begin_inset Flex Code
18030 \begin_layout Plain Layout
18036 should be used or, instead, the user can change the paragraph style used
18041 \begin_layout Description
18042 \begin_inset Flex Code
18045 \begin_layout Plain Layout
18052 \begin_inset Flex Code
18055 \begin_layout Plain Layout
18064 \begin_inset space \thinspace{}
18068 \begin_inset Flex Code
18071 \begin_layout Plain Layout
18077 ] As with paragraph styles, see
18078 \begin_inset CommandInset ref
18080 reference "subsec:Paragraph-Styles"
18087 \begin_layout Description
18088 \begin_inset Flex Code
18091 \begin_layout Plain Layout
18097 These tags control the XHTML output.
18099 \begin_inset CommandInset ref
18101 reference "sec:Tags-for-XHTML"
18108 \begin_layout Description
18109 \begin_inset Flex Code
18112 \begin_layout Plain Layout
18119 \begin_inset Flex Code
18122 \begin_layout Plain Layout
18131 \begin_inset space \thinspace{}
18135 \begin_inset Flex Code
18138 \begin_layout Plain Layout
18144 ] Whether to include the contents of this inset in the strings generated
18145 for the `Outline' pane.
18146 One would not, for example, want the content of a footnote in a section
18147 header to be included in the TOC displayed in the outline, but one would
18148 normally want the content of a character style displayed.
18149 Default is false: not to include.
18152 \begin_layout Description
18153 \begin_inset Flex Code
18156 \begin_layout Plain Layout
18165 \begin_inset Flex Code
18168 \begin_layout Plain Layout
18177 \begin_inset space \thinspace{}
18181 \begin_inset Flex Code
18184 \begin_layout Plain Layout
18190 ] As with paragraph styles, see
18191 \begin_inset CommandInset ref
18193 reference "subsec:Paragraph-Styles"
18200 \begin_layout Description
18201 \begin_inset Flex Code
18204 \begin_layout Plain Layout
18210 The font used for the label.
18212 \begin_inset CommandInset ref
18214 reference "subsec:Font-description"
18219 Note that this definition can never appear before
18220 \begin_inset Flex Code
18223 \begin_layout Plain Layout
18229 , lest it be ineffective.
18232 \begin_layout Description
18233 \begin_inset Flex Code
18236 \begin_layout Plain Layout
18243 \begin_inset Flex Code
18246 \begin_layout Plain Layout
18253 \begin_inset Quotes erd
18257 \begin_inset Quotes erd
18260 ] What will be displayed on the button or elsewhere as the inset label.
18262 \begin_inset Flex Code
18265 \begin_layout Plain Layout
18273 \begin_inset Flex Code
18276 \begin_layout Plain Layout
18282 ) modify this label on the fly.
18285 \begin_layout Description
18286 \begin_inset Flex Code
18289 \begin_layout Plain Layout
18295 Language dependent preamble; see
18296 \begin_inset CommandInset ref
18298 reference "subsec:I18n"
18305 \begin_layout Description
18306 \begin_inset Flex Code
18309 \begin_layout Plain Layout
18316 \begin_inset Flex Code
18319 \begin_layout Plain Layout
18325 ] The name of the corresponding \SpecialChar LaTeX
18327 Either the environment or command name.
18330 \begin_layout Description
18331 \begin_inset Flex Code
18334 \begin_layout Plain Layout
18341 \begin_inset Flex Code
18344 \begin_layout Plain Layout
18350 ] The optional parameter for the corresponding
18351 \begin_inset Flex Code
18354 \begin_layout Plain Layout
18360 stuff, including possible bracket pairs like
18361 \begin_inset Flex Code
18364 \begin_layout Plain Layout
18371 This parameter cannot be changed from within \SpecialChar LyX
18373 \begin_inset Flex Code
18376 \begin_layout Plain Layout
18382 for customizable parameters).
18383 It will be output as is after all \SpecialChar LaTeX
18385 \begin_inset Flex Code
18388 \begin_layout Plain Layout
18397 \begin_layout Description
18398 \begin_inset Flex Code
18401 \begin_layout Plain Layout
18408 \begin_inset Flex Code
18411 \begin_layout Plain Layout
18412 Command, Environment, None
18417 ] How the style should be translated into \SpecialChar LaTeX
18422 \begin_layout Plain Layout
18423 \begin_inset Flex Code
18426 \begin_layout Plain Layout
18432 is perhaps a bit misleading, since these rules apply to SGML classes too.
18433 Visit the SGML class files for specific examples.
18442 \begin_layout Description
18443 \begin_inset Flex Code
18446 \begin_layout Plain Layout
18452 means nothing special
18455 \begin_layout Description
18456 \begin_inset Flex Code
18459 \begin_layout Plain Layout
18466 \begin_inset Flex Code
18469 \begin_layout Plain Layout
18476 {\SpecialChar ldots
18485 \begin_layout Description
18486 \begin_inset Flex Code
18489 \begin_layout Plain Layout
18496 \begin_inset Flex Code
18499 \begin_layout Plain Layout
18506 }\SpecialChar ldots
18521 \begin_layout Standard
18522 Putting the last few things together, the \SpecialChar LaTeX
18523 output will be either:
18526 \begin_layout LyX-Code
18529 LatexName[LatexParam]{\SpecialChar ldots
18533 \begin_layout Standard
18537 \begin_layout LyX-Code
18540 begin{LatexName}[LatexParam] \SpecialChar ldots
18546 \begin_layout Standard
18547 depending upon the \SpecialChar LaTeX
18552 \begin_layout Description
18553 \begin_inset Flex Code
18556 \begin_layout Plain Layout
18563 \begin_inset Flex Code
18566 \begin_layout Plain Layout
18572 ] A string that is put at the beginning of the layout content.
18573 A line break in the output can be indicated by
18574 \begin_inset Flex Code
18577 \begin_layout Plain Layout
18586 \begin_layout Description
18587 \begin_inset Flex Code
18590 \begin_layout Plain Layout
18597 \begin_inset Flex Code
18600 \begin_layout Plain Layout
18607 \begin_inset Flex Code
18610 \begin_layout Plain Layout
18617 \begin_inset Flex Code
18620 \begin_layout Plain Layout
18627 \begin_inset Flex Code
18630 \begin_layout Plain Layout
18636 (indicating a dummy definition ending definitions of charstyles, etc).
18637 This entry is required in and is only meaningful for Flex insets.
18638 Among other things, it determines on which menu this inset will appear.
18640 \begin_inset Flex Code
18643 \begin_layout Plain Layout
18650 \begin_inset Flex Code
18653 \begin_layout Plain Layout
18659 will automatically set
18660 \begin_inset Flex Code
18663 \begin_layout Plain Layout
18670 \begin_inset Flex Code
18673 \begin_layout Plain Layout
18681 \begin_inset Flex Code
18684 \begin_layout Plain Layout
18690 can be set to true, or
18691 \begin_inset Flex Code
18694 \begin_layout Plain Layout
18701 \begin_inset Flex Code
18704 \begin_layout Plain Layout
18710 insets by setting it
18715 \begin_inset Flex Code
18718 \begin_layout Plain Layout
18727 \begin_layout Description
18728 \begin_inset Flex Code
18731 \begin_layout Plain Layout
18738 \begin_inset Flex Code
18741 \begin_layout Plain Layout
18750 \begin_inset space \thinspace{}
18754 \begin_inset Flex Code
18757 \begin_layout Plain Layout
18763 ] Whether multiple paragraphs are permitted in this inset.
18765 \begin_inset Flex Code
18768 \begin_layout Plain Layout
18774 to the same value and
18775 \begin_inset Flex Code
18778 \begin_layout Plain Layout
18784 to the opposite value.
18785 These can be reset to other values, if they are used
18790 \begin_inset Flex Code
18793 \begin_layout Plain Layout
18803 \begin_layout Description
18804 \begin_inset Flex Code
18807 \begin_layout Plain Layout
18814 \begin_inset Flex Code
18817 \begin_layout Plain Layout
18826 \begin_inset space \thinspace{}
18830 \begin_inset Flex Code
18833 \begin_layout Plain Layout
18839 ] Whether fragile commands in this inset should be
18840 \begin_inset Flex Code
18843 \begin_layout Plain Layout
18856 whether the command should itself be protected.) Default is false.
18859 \begin_layout Description
18860 \begin_inset Flex Code
18863 \begin_layout Plain Layout
18870 \begin_inset Flex Code
18873 \begin_layout Plain Layout
18879 ] Deletes an existing
18880 \begin_inset Flex Code
18883 \begin_layout Plain Layout
18892 \begin_layout Description
18893 \begin_inset Flex Code
18896 \begin_layout Plain Layout
18903 \begin_inset Flex Code
18906 \begin_layout Plain Layout
18913 \begin_inset Flex Code
18916 \begin_layout Plain Layout
18922 that has replaced this
18923 \begin_inset Flex Code
18926 \begin_layout Plain Layout
18933 This is used to rename an
18934 \begin_inset Flex Code
18937 \begin_layout Plain Layout
18943 , while keeping backward compatibility.
18946 \begin_layout Description
18947 \begin_inset Flex Code
18950 \begin_layout Plain Layout
18957 \begin_inset Flex Code
18960 \begin_layout Plain Layout
18969 \begin_inset space \thinspace{}
18973 \begin_inset Flex Code
18976 \begin_layout Plain Layout
18982 ] As with paragraph styles, see
18983 \begin_inset CommandInset ref
18985 reference "subsec:Paragraph-Styles"
18993 \begin_layout Description
18994 \begin_inset Flex Code
18997 \begin_layout Plain Layout
19004 \begin_inset Flex Code
19007 \begin_layout Plain Layout
19016 \begin_inset space \thinspace{}
19020 \begin_inset Flex Code
19023 \begin_layout Plain Layout
19029 ] As with paragraph styles, see
19030 \begin_inset CommandInset ref
19032 reference "subsec:Paragraph-Styles"
19040 \begin_layout Description
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
19080 ] The prefix to use when creating labels referring to insets of this type.
19081 This allows the use of formatted references.
19084 \begin_layout Description
19085 \begin_inset Flex Code
19088 \begin_layout Plain Layout
19095 \begin_inset Flex Code
19098 \begin_layout Plain Layout
19104 ] As with paragraph styles, see
19105 \begin_inset CommandInset ref
19107 reference "subsec:Paragraph-Styles"
19114 \begin_layout Description
19115 \begin_inset Flex Code
19118 \begin_layout Plain Layout
19125 \begin_inset Flex Code
19128 \begin_layout Plain Layout
19137 \begin_inset space \thinspace{}
19141 \begin_inset Flex Code
19144 \begin_layout Plain Layout
19150 ] Resets the \SpecialChar LaTeX
19151 arguments of this layout (as defined via the
19152 \begin_inset Flex Code
19155 \begin_layout Plain Layout
19162 This is useful if you have copied a style via
19163 \begin_inset Flex Code
19166 \begin_layout Plain Layout
19172 , but you do not want to inherit its (required and optional) arguments.
19175 \begin_layout Description
19176 \begin_inset Flex Code
19179 \begin_layout Plain Layout
19186 \begin_inset Flex Code
19189 \begin_layout Plain Layout
19196 \begin_inset space \thinspace{}
19200 \begin_inset Flex Code
19203 \begin_layout Plain Layout
19211 ] Whether this inset should use the font of its surrounding environment
19213 Default is false: use the font of the surrounding environment.
19216 \begin_layout Description
19217 \begin_inset Flex Code
19220 \begin_layout Plain Layout
19227 \begin_inset Flex Code
19230 \begin_layout Plain Layout
19236 ] A string that is put at the end of the layout content.
19237 A line break in the output can be indicated by
19238 \begin_inset Flex Code
19241 \begin_layout Plain Layout
19250 \begin_layout Description
19251 \begin_inset Flex Code
19254 \begin_layout Plain Layout
19261 \begin_inset Flex Code
19264 \begin_layout Plain Layout
19271 \begin_inset space \thinspace{}
19275 \begin_inset Flex Code
19278 \begin_layout Plain Layout
19286 ] Allow spell-checking the contents of this inset.
19290 \begin_layout Subsection
19292 \begin_inset CommandInset label
19294 name "subsec:Counters"
19301 \begin_layout Standard
19302 It is necessary to define the counters (
19303 \begin_inset Flex Noun
19306 \begin_layout Plain Layout
19313 \begin_inset Flex Noun
19316 \begin_layout Plain Layout
19322 , \SpecialChar ldots
19323 ) in the text class itself.
19324 The standard counters are defined in the file
19325 \begin_inset Flex Code
19328 \begin_layout Plain Layout
19334 , so you may have to do no more than add
19337 \begin_layout LyX-Code
19338 Input stdcounters.inc
19341 \begin_layout Standard
19342 to your layout file to get them to work.
19343 But if you want to define custom counters, then you can do so.
19344 The counter declaration must begin with:
19347 \begin_layout LyX-Code
19348 Counter CounterName
19351 \begin_layout Standard
19353 \begin_inset Flex Code
19356 \begin_layout Plain Layout
19362 ' is replaced by the name of the counter.
19363 And it must end with
19364 \begin_inset Quotes eld
19368 \begin_inset Flex Code
19371 \begin_layout Plain Layout
19378 \begin_inset Quotes erd
19382 The following parameters can also be used:
19385 \begin_layout Description
19386 \begin_inset Flex Code
19389 \begin_layout Plain Layout
19396 \begin_inset Flex Code
19399 \begin_layout Plain Layout
19405 ] Sets the initial value for the counter, to which it will be reset whenever
19407 Normally, one will want the default, 1.
19410 \begin_layout Description
19411 \begin_inset Flex Code
19414 \begin_layout Plain Layout
19421 \begin_inset Flex Code
19424 \begin_layout Plain Layout
19431 \begin_inset Quotes erd
19435 \begin_inset Quotes erd
19438 ] When defined, this string defines how the counter is displayed.
19439 Setting this value sets
19440 \begin_inset Flex Code
19443 \begin_layout Plain Layout
19444 LabelStringAppendix
19450 The following special constructs can be used in the string:
19454 \begin_layout Itemize
19455 \begin_inset Flex Code
19458 \begin_layout Plain Layout
19466 will be replaced by the expansion of the
19467 \begin_inset Flex Code
19470 \begin_layout Plain Layout
19477 \begin_inset Flex Code
19480 \begin_layout Plain Layout
19481 LabelStringAppendix
19487 \begin_inset Flex Code
19490 \begin_layout Plain Layout
19500 \begin_layout Itemize
19501 counter values can be expressed using \SpecialChar LaTeX
19503 \begin_inset Newline newline
19507 \begin_inset Flex Code
19510 \begin_layout Plain Layout
19527 \begin_inset Flex Code
19530 \begin_layout Plain Layout
19542 \begin_layout Plain Layout
19552 Actually, the situation is a bit more complicated: any
19571 other than those described below will produce arabic numerals.
19572 It would not be surprising to see this change in the future.
19578 \begin_inset Flex Code
19581 \begin_layout Plain Layout
19587 : 1, 2, 3,\SpecialChar ldots
19589 \begin_inset Flex Code
19592 \begin_layout Plain Layout
19598 for lower-case letters: a, b, c, \SpecialChar ldots
19600 \begin_inset Flex Code
19603 \begin_layout Plain Layout
19609 for upper-case letters: A, B, C, \SpecialChar ldots
19611 \begin_inset Flex Code
19614 \begin_layout Plain Layout
19620 for lower-case roman numerals: i, ii, iii, \SpecialChar ldots
19622 \begin_inset Flex Code
19625 \begin_layout Plain Layout
19631 for upper-case roman numerals: I, II, III\SpecialChar ldots
19633 \begin_inset Flex Code
19636 \begin_layout Plain Layout
19642 for hebrew numerals.
19646 \begin_layout Standard
19647 If LabelString is not defined, a default value is constructed as follows:
19648 if the counter has a master counter
19649 \begin_inset Flex Code
19652 \begin_layout Plain Layout
19659 \begin_inset Flex Code
19662 \begin_layout Plain Layout
19669 \begin_inset Newline newline
19673 \begin_inset Flex Code
19676 \begin_layout Plain Layout
19686 is used; otherwise the string
19687 \begin_inset Flex Code
19690 \begin_layout Plain Layout
19701 \begin_layout Description
19702 \begin_inset Flex Code
19705 \begin_layout Plain Layout
19706 LabelStringAppendix
19712 \begin_inset Flex Code
19715 \begin_layout Plain Layout
19722 \begin_inset Quotes erd
19726 \begin_inset Quotes erd
19730 \begin_inset Flex Code
19733 \begin_layout Plain Layout
19739 , but for use in the Appendix.
19742 \begin_layout Description
19743 \begin_inset Flex Code
19746 \begin_layout Plain Layout
19753 \begin_inset Flex Code
19756 \begin_layout Plain Layout
19763 \begin_inset Quotes erd
19767 \begin_inset Quotes erd
19770 ] A format for use with formatted references to this counter.
19771 For example, one might want to have references to section numbers appear
19773 \begin_inset Quotes eld
19777 \begin_inset Quotes erd
19781 The string should contain
19782 \begin_inset Quotes eld
19786 \begin_inset Quotes erd
19790 This will be replaced by the counter number itself.
19791 So, for sections, it would be: Section ##.
19794 \begin_layout Description
19795 \begin_inset Flex Code
19798 \begin_layout Plain Layout
19805 \begin_inset Flex Code
19808 \begin_layout Plain Layout
19815 \begin_inset Quotes erd
19819 \begin_inset Quotes erd
19822 ] If this is set to the name of another counter, the present counter will
19823 be reset every time the other one is increased.
19825 \begin_inset Flex Code
19828 \begin_layout Plain Layout
19835 \begin_inset Flex Code
19838 \begin_layout Plain Layout
19847 \begin_layout Subsection
19849 \begin_inset CommandInset label
19851 name "subsec:Font-description"
19858 \begin_layout Standard
19859 A font description looks like this:
19862 \begin_layout LyX-Code
19876 \begin_layout LyX-Code
19880 \begin_layout LyX-Code
19884 \begin_layout Standard
19885 The following commands are available:
19888 \begin_layout Description
19889 \begin_inset Flex Code
19892 \begin_layout Plain Layout
19899 \begin_inset Flex Code
19902 \begin_layout Plain Layout
19911 \begin_inset Flex Code
19914 \begin_layout Plain Layout
19921 \begin_inset Flex Code
19924 \begin_layout Plain Layout
19931 \begin_inset Flex Code
19934 \begin_layout Plain Layout
19941 \begin_inset Flex Code
19944 \begin_layout Plain Layout
19951 \begin_inset Flex Code
19954 \begin_layout Plain Layout
19961 \begin_inset Flex Code
19964 \begin_layout Plain Layout
19971 \begin_inset Flex Code
19974 \begin_layout Plain Layout
19981 \begin_inset Flex Code
19984 \begin_layout Plain Layout
19991 \begin_inset Flex Code
19994 \begin_layout Plain Layout
20001 \begin_inset Flex Code
20004 \begin_layout Plain Layout
20011 \begin_inset Flex Code
20014 \begin_layout Plain Layout
20021 \begin_inset Flex Code
20024 \begin_layout Plain Layout
20031 \begin_inset Flex Code
20034 \begin_layout Plain Layout
20041 \begin_inset Flex Code
20044 \begin_layout Plain Layout
20051 \begin_inset Flex Code
20054 \begin_layout Plain Layout
20061 \begin_inset Flex Code
20064 \begin_layout Plain Layout
20071 \begin_inset Flex Code
20074 \begin_layout Plain Layout
20081 \begin_inset Flex Code
20084 \begin_layout Plain Layout
20091 \begin_inset Flex Code
20094 \begin_layout Plain Layout
20103 \begin_layout Description
20104 \begin_inset Flex Code
20107 \begin_layout Plain Layout
20114 \begin_inset Flex Code
20117 \begin_layout Plain Layout
20126 \begin_inset Flex Code
20129 \begin_layout Plain Layout
20136 \begin_inset Flex Code
20139 \begin_layout Plain Layout
20148 \begin_layout Description
20149 \begin_inset Flex Code
20152 \begin_layout Plain Layout
20159 \begin_inset Flex Code
20162 \begin_layout Plain Layout
20168 ] Valid arguments are:
20169 \begin_inset Flex Code
20172 \begin_layout Plain Layout
20179 \begin_inset Flex Code
20182 \begin_layout Plain Layout
20189 \begin_inset Flex Code
20192 \begin_layout Plain Layout
20199 \begin_inset Flex Code
20202 \begin_layout Plain Layout
20209 \begin_inset Flex Code
20212 \begin_layout Plain Layout
20219 \begin_inset Flex Code
20222 \begin_layout Plain Layout
20229 \begin_inset Flex Code
20232 \begin_layout Plain Layout
20239 \begin_inset Flex Code
20242 \begin_layout Plain Layout
20249 \begin_inset Flex Code
20252 \begin_layout Plain Layout
20259 \begin_inset Flex Code
20262 \begin_layout Plain Layout
20269 \begin_inset Flex Code
20272 \begin_layout Plain Layout
20279 \begin_inset Flex Code
20282 \begin_layout Plain Layout
20289 Each of these turns on or off the corresponding attribute.
20291 \begin_inset Flex Code
20294 \begin_layout Plain Layout
20300 turns on emphasis, and
20301 \begin_inset Flex Code
20304 \begin_layout Plain Layout
20312 \begin_inset Newline newline
20315 If the latter seems puzzling, remember that the font settings for the present
20316 context are generally inherited from the surrounding context.
20318 \begin_inset Flex Code
20321 \begin_layout Plain Layout
20327 would turn off the emphasis that was anyway in effect, say, in a theorem
20331 \begin_layout Description
20332 \begin_inset Flex Code
20335 \begin_layout Plain Layout
20342 \begin_inset Flex Code
20345 \begin_layout Plain Layout
20354 \begin_inset Flex Code
20357 \begin_layout Plain Layout
20366 \begin_layout Description
20367 \begin_inset Flex Code
20370 \begin_layout Plain Layout
20377 \begin_inset Flex Code
20380 \begin_layout Plain Layout
20389 \begin_inset Flex Code
20392 \begin_layout Plain Layout
20399 \begin_inset Flex Code
20402 \begin_layout Plain Layout
20409 \begin_inset Flex Code
20412 \begin_layout Plain Layout
20421 \begin_layout Description
20422 \begin_inset Flex Code
20425 \begin_layout Plain Layout
20432 \begin_inset Flex Code
20435 \begin_layout Plain Layout
20442 \begin_inset Flex Code
20445 \begin_layout Plain Layout
20452 \begin_inset Flex Code
20455 \begin_layout Plain Layout
20464 \begin_inset Flex Code
20467 \begin_layout Plain Layout
20474 \begin_inset Flex Code
20477 \begin_layout Plain Layout
20484 \begin_inset Flex Code
20487 \begin_layout Plain Layout
20494 \begin_inset Flex Code
20497 \begin_layout Plain Layout
20504 \begin_inset Flex Code
20507 \begin_layout Plain Layout
20516 \begin_layout Subsection
20517 \begin_inset CommandInset label
20519 name "subsec:Citation-format-description"
20523 Citation format description
20526 \begin_layout Standard
20528 \begin_inset Flex Code
20531 \begin_layout Plain Layout
20537 blocks are used to describe how bibliographic information should be displayed,
20538 both within \SpecialChar LyX
20539 itself (in the citation dialog and in tooltips, for example)
20540 and in XHTML output.
20541 Such a block might look like this:
20544 \begin_layout LyX-Code
20548 \begin_layout LyX-Code
20552 \begin_layout LyX-Code
20556 \begin_layout LyX-Code
20560 \begin_layout Standard
20561 The individual lines define how the bibliographic information associated
20562 with an article or book, respectively, is to be displayed, and such a definitio
20563 n can be given for any `entry type' that might be present in a Bib\SpecialChar TeX
20566 defines a default format in the source code that will be used if no specific
20567 definition has been given.
20569 predefines several formats in the file
20570 \begin_inset Flex Code
20573 \begin_layout Plain Layout
20579 , which is included in most of \SpecialChar LyX
20580 's document classes.
20583 \begin_layout Standard
20584 The definitions use a simple language that allows Bib\SpecialChar TeX
20585 keys to be replaced
20587 Keys should be enclosed in
20588 \begin_inset Flex Code
20591 \begin_layout Plain Layout
20598 \begin_inset Flex Code
20601 \begin_layout Plain Layout
20608 So a simple definition might look like this:
20611 \begin_layout LyX-Code
20613 \begin_inset Quotes eld
20617 \begin_inset Quotes erd
20623 \begin_layout Standard
20624 This would print the author, followed by a comma, followed by the title,
20625 in quotes, followed by a period.
20628 \begin_layout Standard
20629 Of course, sometimes you may want to print a key only if it exists.
20630 This can be done by using a conditional construction, such as:
20631 \begin_inset Flex Code
20634 \begin_layout Plain Layout
20636 \begin_inset space ~
20646 \begin_inset Flex Code
20649 \begin_layout Plain Layout
20655 key exists, then print
20656 \begin_inset Quotes eld
20660 \begin_inset space ~
20664 \begin_inset Quotes erd
20667 followed by the volume key.
20668 It is also possible to have an else clause in the conditional, such as:
20669 \begin_inset Newline newline
20673 \begin_inset Flex Code
20676 \begin_layout Plain Layout
20677 {%author%[[%author%]][[%editor%, ed.]]}
20683 \begin_inset Newline newline
20687 \begin_inset Flex Code
20690 \begin_layout Plain Layout
20696 key is printed if it exists; otherwise, the editor key is printed, followed
20698 \begin_inset Quotes eld
20702 \begin_inset space ~
20706 \begin_inset Quotes erd
20709 Note that the key is again enclosed in
20710 \begin_inset Flex Code
20713 \begin_layout Plain Layout
20719 signs; the entire conditional is enclosed in braces; and the if and else
20720 clauses are enclosed in double brackets,
20721 \begin_inset Quotes eld
20725 \begin_inset Flex Code
20728 \begin_layout Plain Layout
20735 \begin_inset Quotes eld
20739 \begin_inset Quotes eld
20743 \begin_inset Flex Code
20746 \begin_layout Plain Layout
20753 \begin_inset Quotes erd
20757 There must be no space between any of these.
20760 \begin_layout Standard
20761 There is one other piece of syntax available in definitions, which looks
20763 \begin_inset Flex Code
20766 \begin_layout Plain Layout
20773 This defines a piece of formatting information that is to be used when
20775 \begin_inset Quotes eld
20779 \begin_inset Quotes erd
20783 Obviously, we do not want to output HTML tags when writing plain text,
20784 so they should be wrapped in
20785 \begin_inset Quotes eld
20789 \begin_inset Quotes erd
20793 \begin_inset Quotes eld
20797 \begin_inset Quotes erd
20803 \begin_layout Standard
20804 Two special sorts of definitions are also possible in a
20805 \begin_inset Flex Code
20808 \begin_layout Plain Layout
20815 An example of the first would be:
20818 \begin_layout LyX-Code
20820 \begin_inset Quotes eld
20824 \begin_inset Quotes erd
20830 \begin_layout Standard
20831 This is an abbreviation, or macro, and it can be used by treating it as
20833 \begin_inset Flex Code
20836 \begin_layout Plain Layout
20845 \begin_inset Flex Code
20848 \begin_layout Plain Layout
20854 exactly as it would treat its definition.
20855 So, let us issue the obvious
20863 \begin_layout LyX-Code
20867 \begin_layout Standard
20868 or anything like it.
20870 shouldn't go into an infinite loop, but it may go into a long one before
20874 \begin_layout Standard
20875 The second sort of special definition might look like this:
20878 \begin_layout LyX-Code
20882 \begin_layout Standard
20883 This defines a translatable piece of text, which allows relevant parts of
20884 the bibliography to be translated.
20885 It can be included in a definition by treating it as a key:
20886 \begin_inset Flex Code
20889 \begin_layout Plain Layout
20896 Several of these are predefined in
20897 \begin_inset Flex Code
20900 \begin_layout Plain Layout
20907 Note that these are not macros, in the sense just defined.
20908 They will not be expanded.
20911 \begin_layout Standard
20912 So here then is an example that use all these features:
20913 \begin_inset VSpace defskip
20919 \begin_layout Standard
20923 !authoredit {%author%[[%author%, ]][[{%editor%[[%editor%, %_edtext%, ]]}]]}
20926 \begin_layout Standard
20927 \begin_inset VSpace defskip
20930 This defines a macro that prints the author, followed by a comma, if the
20932 \begin_inset Flex Code
20935 \begin_layout Plain Layout
20941 key is defined, or else prints the name of the editor, followed by the
20943 \begin_inset Flex Code
20946 \begin_layout Plain Layout
20952 or its translation (it is by default
20953 \begin_inset Quotes eld
20957 \begin_inset Quotes erd
20961 \begin_inset Flex Code
20964 \begin_layout Plain Layout
20971 Note that this is in fact defined in
20972 \begin_inset Flex Code
20975 \begin_layout Plain Layout
20981 , so you can use it in your own definitions, or re-definitions, if you load
20985 \begin_layout Section
20986 \begin_inset CommandInset label
20988 name "sec:Tags-for-XHTML"
20992 Tags for XHTML output
20995 \begin_layout Standard
20996 As with \SpecialChar LaTeX
20997 or DocBook, the format of \SpecialChar LyX
20998 's XHTML output is also controlled by
20999 layout information.
21000 In general, \SpecialChar LyX
21001 provides sensible defaults and, as mentioned earlier, it will
21002 even construct default CSS style rules from the other layout tags.
21003 For example, \SpecialChar LyX
21004 will attempt to use the information provided in the
21005 \begin_inset Flex Code
21008 \begin_layout Plain Layout
21014 declaration for the Chapter style to write CSS that will appropriately
21015 format chapter headings.
21018 \begin_layout Standard
21019 In many cases, then, you may not have to do anything at all to get acceptable
21020 XHTML output for your own environments, custom insets, and so forth.
21021 But in some cases you will, and so \SpecialChar LyX
21022 provides a number of layout tags that
21023 can be used to customize the XHTML and CSS that are generated.
21026 \begin_layout Standard
21027 Note that there are two tags,
21028 \begin_inset Flex Code
21031 \begin_layout Plain Layout
21038 \begin_inset Flex Code
21041 \begin_layout Plain Layout
21047 that may appear outside style and inset declarations.
21049 \begin_inset CommandInset ref
21051 reference "subsec:General-text-class"
21055 for details on these.
21058 \begin_layout Subsection
21059 \begin_inset CommandInset label
21061 name "subsec:Paragraph-Style-XHTML"
21068 \begin_layout Standard
21069 The sort of XHTML \SpecialChar LyX
21070 outputs for a paragraph depends upon whether we are dealing
21071 with a normal paragraph, a command, or an environment, where this is itself
21072 determined by the contents of the corresponding
21073 \begin_inset Flex Code
21076 \begin_layout Plain Layout
21087 \begin_layout Standard
21088 For a command or normal paragraph, the output XHTML has the following form:
21091 \begin_layout LyX-Code
21093 \begin_inset Quotes erd
21097 \begin_inset Quotes erd
21103 \begin_layout LyX-Code
21105 \begin_inset Quotes erd
21109 \begin_inset Quotes erd
21115 \begin_layout LyX-Code
21116 Contents of the paragraph.
21119 \begin_layout LyX-Code
21123 \begin_layout Standard
21124 The label tags are of course omitted if the paragraph does not have a label.
21127 \begin_layout Standard
21128 For an environment that is not some sort of list, the XHTML takes this form:
21131 \begin_layout LyX-Code
21133 \begin_inset Quotes erd
21137 \begin_inset Quotes erd
21143 \begin_layout LyX-Code
21145 \begin_inset Quotes erd
21149 \begin_inset Quotes erd
21153 \begin_inset Quotes erd
21157 \begin_inset Quotes erd
21160 >Environment Label</labeltag>First paragraph.</itemtag>
21163 \begin_layout LyX-Code
21164 <itemtag>Second paragraph.</itemtag>
21167 \begin_layout LyX-Code
21171 \begin_layout Standard
21172 Note that the label is output only for the first paragraph, as it should
21173 be for a theorem, for example.
21177 \begin_layout Standard
21178 For a list, we have one of these forms:
21181 \begin_layout LyX-Code
21183 \begin_inset Quotes erd
21187 \begin_inset Quotes erd
21193 \begin_layout LyX-Code
21195 \begin_inset Quotes erd
21199 \begin_inset Quotes erd
21203 \begin_inset Quotes erd
21207 \begin_inset Quotes erd
21210 >List Label</labeltag>First item.</itemtag>
21213 \begin_layout LyX-Code
21215 \begin_inset Quotes erd
21219 \begin_inset Quotes erd
21223 \begin_inset Quotes erd
21227 \begin_inset Quotes erd
21230 >List Label</labeltag>Second item.</itemtag>
21233 \begin_layout LyX-Code
21237 \begin_layout LyX-Code
21241 \begin_layout LyX-Code
21243 \begin_inset Quotes erd
21247 \begin_inset Quotes erd
21253 \begin_layout LyX-Code
21255 \begin_inset Quotes erd
21259 \begin_inset Quotes erd
21262 >List Label</labeltag><itemtag attr=
21263 \begin_inset Quotes erd
21267 \begin_inset Quotes erd
21270 >First item.</itemtag>
21273 \begin_layout LyX-Code
21275 \begin_inset Quotes erd
21279 \begin_inset Quotes erd
21282 >List Label</labeltag><itemtag attr=
21283 \begin_inset Quotes erd
21287 \begin_inset Quotes erd
21290 >Second item.</itemtag>
21293 \begin_layout LyX-Code
21297 \begin_layout Standard
21298 Note the different orders of
21299 \begin_inset Flex Code
21302 \begin_layout Plain Layout
21309 \begin_inset Flex Code
21312 \begin_layout Plain Layout
21319 Which order we get depends upon the setting of
21320 \begin_inset Flex Code
21323 \begin_layout Plain Layout
21330 \begin_inset Flex Code
21333 \begin_layout Plain Layout
21339 is false (the default), you get the first of these, with the label within
21340 the item; if true, you get the second, with the label outside the item.
21343 \begin_layout Standard
21344 The specific tags and attributes output for each paragraph type can be controlle
21345 d by means of the layout tags we are about to describe.
21346 As mentioned earlier, however, \SpecialChar LyX
21347 uses sensible defaults for many of these,
21348 so you often may not need to do very much to get good XHTML output.
21349 Think of the available tags as there so you can tweak things to your liking.
21352 \begin_layout Description
21353 \begin_inset Flex Code
21356 \begin_layout Plain Layout
21363 \begin_inset Flex Code
21366 \begin_layout Plain Layout
21372 ] Specifies attribute information to be output with the main tag.
21374 \begin_inset Quotes eld
21378 \begin_inset Flex Code
21381 \begin_layout Plain Layout
21388 \begin_inset Quotes erd
21392 By default, \SpecialChar LyX
21394 \begin_inset Quotes eld
21398 \begin_inset Flex Code
21401 \begin_layout Plain Layout
21408 \begin_inset Quotes erd
21412 \begin_inset Flex Code
21415 \begin_layout Plain Layout
21421 is the \SpecialChar LyX
21422 name of the layout, made lowercase, for example: chapter.
21427 contain any style information.
21429 \begin_inset Flex Code
21432 \begin_layout Plain Layout
21441 \begin_layout Description
21442 \begin_inset Flex Code
21445 \begin_layout Plain Layout
21452 \begin_inset Flex Code
21455 \begin_layout Plain Layout
21465 ] Whether to output the default CSS information \SpecialChar LyX
21466 generates for this layout,
21467 even if additional information is explicitly provided via
21468 \begin_inset Flex Code
21471 \begin_layout Plain Layout
21479 \begin_inset Flex Code
21482 \begin_layout Plain Layout
21488 allows you to alter or augment the generated CSS, rather than to override
21491 \begin_inset Flex Code
21494 \begin_layout Plain Layout
21503 \begin_layout Description
21504 \begin_inset Flex Code
21507 \begin_layout Plain Layout
21514 \begin_inset Flex Code
21517 \begin_layout Plain Layout
21523 ] The tag to be used for individual paragraphs of environments, replacing
21525 \begin_inset Flex Code
21528 \begin_layout Plain Layout
21534 in the examples above.
21536 \begin_inset Flex Code
21539 \begin_layout Plain Layout
21548 \begin_layout Description
21549 \begin_inset Flex Code
21552 \begin_layout Plain Layout
21559 \begin_inset Flex Code
21562 \begin_layout Plain Layout
21568 ] Attributes for the item tag.
21570 \begin_inset Quotes eld
21574 \begin_inset Flex Code
21577 \begin_layout Plain Layout
21578 class=`layoutname_item'
21584 \begin_inset Quotes erd
21592 contain any style information.
21594 \begin_inset Flex Code
21597 \begin_layout Plain Layout
21606 \begin_layout Description
21607 \begin_inset Flex Code
21610 \begin_layout Plain Layout
21617 \begin_inset Flex Code
21620 \begin_layout Plain Layout
21626 ] The tag to be used for paragraph and item labels, replacing
21627 \begin_inset Flex Code
21630 \begin_layout Plain Layout
21636 in the examples above.
21638 \begin_inset Flex Code
21641 \begin_layout Plain Layout
21648 \begin_inset Flex Code
21651 \begin_layout Plain Layout
21658 \begin_inset Flex Code
21661 \begin_layout Plain Layout
21668 \begin_inset Flex Code
21671 \begin_layout Plain Layout
21672 Centered_Top_Environment
21677 , in which case it defaults to
21678 \begin_inset Flex Code
21681 \begin_layout Plain Layout
21690 \begin_layout Description
21691 \begin_inset Flex Code
21694 \begin_layout Plain Layout
21701 \begin_inset Flex Code
21704 \begin_layout Plain Layout
21710 ] Attributes for the label tag.
21712 \begin_inset Quotes eld
21716 \begin_inset Flex Code
21719 \begin_layout Plain Layout
21720 class=`layoutname_label'
21726 \begin_inset Quotes erd
21734 contain any style information.
21736 \begin_inset Flex Code
21739 \begin_layout Plain Layout
21748 \begin_layout Description
21749 \begin_inset Flex Code
21752 \begin_layout Plain Layout
21759 \begin_inset Flex Code
21762 \begin_layout Plain Layout
21772 ] Meaningful only for list-like environments, this tag controls whether
21773 the label tag is output before or inside the item tag.
21774 This is used, for example, in the description environment, where we want
21776 \begin_inset Flex Code
21779 \begin_layout Plain Layout
21780 <dt>\SpecialChar ldots
21781 </dt><dd>\SpecialChar ldots
21789 \begin_inset Flex Code
21792 \begin_layout Plain Layout
21798 : The label tag is output inside the item tag.
21801 \begin_layout Description
21802 \begin_inset Flex Code
21805 \begin_layout Plain Layout
21811 Information to be output in the
21812 \begin_inset Flex Code
21815 \begin_layout Plain Layout
21821 section when this style is used.
21822 This might, for example, be used to include a
21823 \begin_inset Flex Code
21826 \begin_layout Plain Layout
21833 \begin_inset Flex Code
21836 \begin_layout Plain Layout
21845 \begin_layout Description
21846 \begin_inset Flex Code
21849 \begin_layout Plain Layout
21855 CSS style information to be included when this style is used.
21856 Note that this will automatically be wrapped in a layout-generated
21857 \begin_inset Flex Code
21860 \begin_layout Plain Layout
21866 block, so only the CSS itself need be included.
21868 \begin_inset Flex Code
21871 \begin_layout Plain Layout
21880 \begin_layout Description
21881 \begin_inset Flex Code
21884 \begin_layout Plain Layout
21891 \begin_inset Flex Code
21894 \begin_layout Plain Layout
21900 ] The tag to be used for the main label, replacing
21901 \begin_inset Flex Code
21904 \begin_layout Plain Layout
21910 in the examples above.
21912 \begin_inset Flex Code
21915 \begin_layout Plain Layout
21924 \begin_layout Description
21925 \begin_inset Flex Code
21928 \begin_layout Plain Layout
21935 \begin_inset Flex Code
21938 \begin_layout Plain Layout
21948 ] Marks this style as the one to be used to generate the
21949 \begin_inset Flex Code
21952 \begin_layout Plain Layout
21958 tag for the XHTML file.
21959 By default, it is false.
21961 \begin_inset Flex Code
21964 \begin_layout Plain Layout
21970 file sets it to true for the
21971 \begin_inset Flex Code
21974 \begin_layout Plain Layout
21984 \begin_layout Subsection
21988 \begin_layout Standard
21989 The XHTML output of insets can also be controlled by information in layout
21994 \begin_layout Plain Layout
21995 At present, this is true only for
21996 \begin_inset Quotes eld
22000 \begin_inset Quotes erd
22003 insets (insets you can type into) and is not true for
22004 \begin_inset Quotes eld
22008 \begin_inset Quotes erd
22011 insets (insets that are associated with dialog boxes).
22016 Here, too, \SpecialChar LyX
22017 tries to provide sensible defaults, and it constructs default
22019 But everything can be customized.
22022 \begin_layout Standard
22023 The XHTML \SpecialChar LyX
22024 outputs for an inset has the following form:
22027 \begin_layout LyX-Code
22029 \begin_inset Quotes erd
22033 \begin_inset Quotes erd
22039 \begin_layout LyX-Code
22040 <labeltag>Label</labeltag>
22043 \begin_layout LyX-Code
22045 \begin_inset Quotes erd
22049 \begin_inset Quotes erd
22052 >Contents of the inset.</innertag>
22055 \begin_layout LyX-Code
22059 \begin_layout Standard
22060 If the inset permits multiple paragraphs—that is, if
22061 \begin_inset Flex Code
22064 \begin_layout Plain Layout
22070 is true—then the contents of the inset will itself be output as paragraphs
22071 formatted according to the styles used for those paragraphs (standard,
22072 quote, and the like).
22073 The label tag is of course omitted if the paragraph does not have a label
22074 and, at present, is always
22075 \begin_inset Flex Code
22078 \begin_layout Plain Layout
22085 The inner tag is optional and, by default, does not appear.
22088 \begin_layout Standard
22089 The specific tags and attributes output for each inset can be controlled
22090 by means of the following layout tags.
22093 \begin_layout Description
22094 \begin_inset Flex Code
22097 \begin_layout Plain Layout
22104 \begin_inset Flex Code
22107 \begin_layout Plain Layout
22113 ] Specifies attribute information to be output with the main tag.
22115 \begin_inset Quotes eld
22119 \begin_inset Flex Code
22122 \begin_layout Plain Layout
22123 class=`myinset' onclick=`\SpecialChar ldots
22130 \begin_inset Quotes erd
22134 By default, \SpecialChar LyX
22136 \begin_inset Quotes eld
22140 \begin_inset Flex Code
22143 \begin_layout Plain Layout
22150 \begin_inset Quotes erd
22154 \begin_inset Flex Code
22157 \begin_layout Plain Layout
22163 is the \SpecialChar LyX
22164 name of the inset, made lowercase and with non-alphanumeric characters
22165 converted to underscores, for example: footnote.
22168 \begin_layout Description
22169 \begin_inset Flex Code
22172 \begin_layout Plain Layout
22179 \begin_inset Flex Code
22182 \begin_layout Plain Layout
22192 ] Whether to output the default CSS information \SpecialChar LyX
22193 generates for this layout,
22194 even if additional information is explicitly provided via
22195 \begin_inset Flex Code
22198 \begin_layout Plain Layout
22206 \begin_inset Flex Code
22209 \begin_layout Plain Layout
22215 allows you to alter or augment the generated CSS, rather than to override
22220 \begin_layout Description
22221 \begin_inset Flex Code
22224 \begin_layout Plain Layout
22231 \begin_inset Flex Code
22234 \begin_layout Plain Layout
22240 ] Attributes for the inner tag.
22242 \begin_inset Quotes eld
22246 \begin_inset Flex Code
22249 \begin_layout Plain Layout
22250 class=`insetname_inner'
22256 \begin_inset Quotes erd
22262 \begin_layout Description
22263 \begin_inset Flex Code
22266 \begin_layout Plain Layout
22273 \begin_inset Flex Code
22276 \begin_layout Plain Layout
22282 ] The inner tag, replacing
22283 \begin_inset Flex Code
22286 \begin_layout Plain Layout
22292 in the examples above.
22293 By default, there is none.
22296 \begin_layout Description
22297 \begin_inset Flex Code
22300 \begin_layout Plain Layout
22307 \begin_inset Flex Code
22310 \begin_layout Plain Layout
22318 ] Whether this inset represents a standalone block of text (such as a footnote)
22319 or instead represents material that is included in the surrounding text
22320 (such as a branch).
22324 \begin_layout Description
22325 \begin_inset Flex Code
22328 \begin_layout Plain Layout
22335 \begin_inset Flex Code
22338 \begin_layout Plain Layout
22344 ] A label for this inset, possibly including a reference to a counter.
22345 For example, for footnote, it might be:
22346 \begin_inset Flex Code
22349 \begin_layout Plain Layout
22358 This is optional, and there is no default.
22361 \begin_layout Description
22362 \begin_inset Flex Code
22365 \begin_layout Plain Layout
22371 Information to be output in the
22372 \begin_inset Flex Code
22375 \begin_layout Plain Layout
22381 section when this style is used.
22382 This might, for example, be used to include a
22383 \begin_inset Flex Code
22386 \begin_layout Plain Layout
22393 \begin_inset Flex Code
22396 \begin_layout Plain Layout
22405 \begin_layout Description
22406 \begin_inset Flex Code
22409 \begin_layout Plain Layout
22415 CSS style information to be included when this style is used.
22416 Note that this will automatically be wrapped in a layout-generated
22417 \begin_inset Flex Code
22420 \begin_layout Plain Layout
22426 block, so only the CSS itself need be included.
22429 \begin_layout Description
22430 \begin_inset Flex Code
22433 \begin_layout Plain Layout
22440 \begin_inset Flex Code
22443 \begin_layout Plain Layout
22449 ] The tag to be used for the main label, replacing
22450 \begin_inset Flex Code
22453 \begin_layout Plain Layout
22459 in the examples above.
22460 The default depends upon the setting of
22461 \begin_inset Flex Code
22464 \begin_layout Plain Layout
22471 \begin_inset Flex Code
22474 \begin_layout Plain Layout
22480 is true, the default is
22481 \begin_inset Flex Code
22484 \begin_layout Plain Layout
22490 ; if it is false, the default is
22491 \begin_inset Flex Code
22494 \begin_layout Plain Layout
22503 \begin_layout Subsection
22507 \begin_layout Standard
22508 The XHTML output for floats too can be controlled by layout information.
22509 The output has the following form:
22512 \begin_layout LyX-Code
22514 \begin_inset Quotes erd
22518 \begin_inset Quotes erd
22524 \begin_layout LyX-Code
22525 Contents of the float.
22528 \begin_layout LyX-Code
22532 \begin_layout Standard
22533 The caption, if there is one, is a separate inset and will be output as
22535 Its appearance can be controlled via the InsetLayout for caption insets.
22539 \begin_layout Description
22540 \begin_inset Flex Code
22543 \begin_layout Plain Layout
22550 \begin_inset Flex Code
22553 \begin_layout Plain Layout
22559 ] Specifies attribute information to be output with the main tag.
22561 \begin_inset Quotes eld
22565 \begin_inset Flex Code
22568 \begin_layout Plain Layout
22569 class=`myfloat' onclick=`\SpecialChar ldots
22576 \begin_inset Quotes erd
22580 By default, \SpecialChar LyX
22582 \begin_inset Quotes eld
22586 \begin_inset Flex Code
22589 \begin_layout Plain Layout
22590 class=`float float-floattype'
22596 \begin_inset Quotes erd
22600 \begin_inset Flex Code
22603 \begin_layout Plain Layout
22609 is \SpecialChar LyX
22610 's name for this type of float, as determined by the float declaration
22612 \begin_inset CommandInset ref
22614 reference "subsec:Floats"
22618 ), though made lowercase and with non-alphanumeric characters converted
22619 to underscores, for example: float-table.
22622 \begin_layout Description
22623 \begin_inset Flex Code
22626 \begin_layout Plain Layout
22632 CSS style information to be included when this float is used.
22633 Note that this will automatically be wrapped in a layout-generated
22634 \begin_inset Flex Code
22637 \begin_layout Plain Layout
22643 block, so only the CSS itself need be included.
22646 \begin_layout Description
22647 \begin_inset Flex Code
22650 \begin_layout Plain Layout
22657 \begin_inset Flex Code
22660 \begin_layout Plain Layout
22666 ] The tag to be used for this float, replacing
22667 \begin_inset Quotes eld
22671 \begin_inset Flex Code
22674 \begin_layout Plain Layout
22681 \begin_inset Quotes erd
22684 in the example above.
22686 \begin_inset Flex Code
22689 \begin_layout Plain Layout
22695 and will rarely need changing.
22698 \begin_layout Subsection
22699 Bibliography formatting
22702 \begin_layout Standard
22703 The bibliography can be formatted using
22704 \begin_inset Flex Code
22707 \begin_layout Plain Layout
22715 \begin_inset CommandInset ref
22717 reference "subsec:Citation-format-description"
22724 \begin_layout Subsection
22729 \begin_layout Standard
22730 We have several times mentioned that \SpecialChar LyX
22731 will generate default CSS style rules
22732 for both insets and paragraph styles, based upon the other layout information
22734 In this section, we shall say a word about which layout information \SpecialChar LyX
22739 \begin_layout Standard
22740 At present, \SpecialChar LyX
22741 auto-generates CSS only for font information, making use of
22743 \begin_inset Flex Code
22746 \begin_layout Plain Layout
22753 \begin_inset Flex Code
22756 \begin_layout Plain Layout
22763 \begin_inset Flex Code
22766 \begin_layout Plain Layout
22773 \begin_inset Flex Code
22776 \begin_layout Plain Layout
22783 \begin_inset Flex Code
22786 \begin_layout Plain Layout
22793 \begin_inset CommandInset ref
22795 reference "subsec:Font-description"
22800 The translation is mostly straightforward and obvious.
22802 \begin_inset Quotes eld
22806 \begin_inset Flex Code
22809 \begin_layout Plain Layout
22816 \begin_inset Quotes erd
22820 \begin_inset Quotes eld
22824 \begin_inset Flex Code
22827 \begin_layout Plain Layout
22828 font-family: sans-serif;
22834 \begin_inset Quotes erd
22838 The correspondence of \SpecialChar LyX
22839 sizes and CSS sizes is a little less obvious but
22840 nonetheless intuitive.
22842 \begin_inset Flex Code
22845 \begin_layout Plain Layout
22852 \begin_inset Flex URL
22855 \begin_layout Plain Layout
22865 \begin_layout Chapter
22866 Including External Material
22867 \begin_inset CommandInset label
22869 name "chap:Including-External-Material"
22876 \begin_layout Standard
22877 \begin_inset Box Shadowbox
22887 height_special "totalheight"
22892 backgroundcolor "none"
22895 \begin_layout Plain Layout
22896 WARNING: This portion of the documentation has not been updated for some
22898 We certainly hope that it is still accurate, but there are no guarantees.
22906 \begin_layout Standard
22907 The use of material from sources external to \SpecialChar LyX
22908 is covered in detail in the
22914 This part of the manual covers what needs to happen behind the scenes for
22915 new sorts of material to be included.
22918 \begin_layout Section
22922 \begin_layout Standard
22923 The external material feature is based on the concept of a
22928 A template is a specification of how \SpecialChar LyX
22929 should interface with a certain kind
22931 As bundled, \SpecialChar LyX
22932 comes with predefined templates for Xfig figures, various
22933 raster format images, chess diagrams, and LilyPond music notation.
22934 You can check the actual list by using the menu
22935 \begin_inset Flex Noun
22938 \begin_layout Plain Layout
22939 Insert\SpecialChar menuseparator
22940 File\SpecialChar menuseparator
22947 Furthermore, it is possible to roll your own template to support a specific
22949 Later we'll describe in more detail what is involved, and hopefully you
22950 will submit all the templates you create so we can include them in a later
22955 \begin_layout Standard
22956 Another basic idea of the external material feature is to distinguish between
22957 the original file that serves as a base for final material and the produced
22958 file that is included in your exported or printed document.
22959 For example, consider the case of a figure produced with
22960 \begin_inset Flex Code
22963 \begin_layout Plain Layout
22970 The Xfig application itself works on an original file with the
22971 \begin_inset Flex Code
22974 \begin_layout Plain Layout
22981 Within Xfig, you create and change your figure, and when you are done,
22983 \begin_inset Flex Code
22986 \begin_layout Plain Layout
22993 When you want to include the figure in your document, you invoke
22994 \begin_inset Flex Code
22997 \begin_layout Plain Layout
23003 in order to create a PostScript file that can readily be included in your
23007 \begin_inset Flex Code
23010 \begin_layout Plain Layout
23016 file is the original file, and the PostScript file is the produced file.
23019 \begin_layout Standard
23020 This distinction is important in order to allow updating of the material
23021 while you are in the process of writing the document.
23022 Furthermore, it provides us with the flexibility that is needed to support
23023 multiple export formats.
23024 For instance, in the case of a plain text file, it is not exactly an award-winn
23025 ing idea to include the figure as raw PostScript.
23026 Instead, you would either prefer to just include a reference to the figure
23027 or try to invoke some graphics to ASCII converter to make the final result
23028 look similar to the real graphics.
23029 The external material management allows you to do this, because it is parametri
23030 zed on the different export formats that \SpecialChar LyX
23034 \begin_layout Standard
23035 Besides supporting the production of different products according to the
23036 exported format, it supports tight integration with editing and viewing
23038 In the case of an Xfig figure, you are able to invoke Xfig on the original
23039 file with a single click from within the external material dialog in \SpecialChar LyX
23041 and also preview the produced PostScript file with Ghostview with another
23043 No more fiddling around with the command line and/or file browsers to locate
23044 and manipulate the original or produced files.
23045 In this way, you are finally able to take full advantage of the many different
23046 applications that are relevant to use when you write your documents, and
23047 ultimately be more productive.
23050 \begin_layout Section
23051 The external template configuration file
23054 \begin_layout Standard
23055 It is relatively easy to add custom external template definitions to \SpecialChar LyX
23057 However, be aware that doing this in an careless manner most probably
23061 introduce an easily exploitable security hole.
23062 So before you do this, please read the discussion about security in
23063 \begin_inset CommandInset ref
23065 reference "sec:Security-discussion"
23072 \begin_layout Standard
23073 Having said that, we encourage you to submit any interesting templates that
23078 \begin_layout Standard
23079 The external templates are defined in the
23080 \begin_inset Flex Code
23083 \begin_layout Plain Layout
23084 LyXDir/lib/external_templates
23090 You can place your own version in
23091 \begin_inset Flex Code
23094 \begin_layout Plain Layout
23095 UserDir/external_templates
23103 \begin_layout Standard
23104 A typical template looks like this:
23107 \begin_layout LyX-Code
23111 \begin_layout LyX-Code
23112 GuiName "XFig: $$AbsOrRelPathParent$$Basename"
23115 \begin_layout LyX-Code
23119 \begin_layout LyX-Code
23123 \begin_layout LyX-Code
23127 \begin_layout LyX-Code
23131 \begin_layout LyX-Code
23135 \begin_layout LyX-Code
23136 AutomaticProduction true
23139 \begin_layout LyX-Code
23143 \begin_layout LyX-Code
23147 \begin_layout LyX-Code
23151 \begin_layout LyX-Code
23152 TransformCommand Rotate RotationLatexCommand
23155 \begin_layout LyX-Code
23156 TransformCommand Resize ResizeLatexCommand
23159 \begin_layout LyX-Code
23160 Product "$$RotateFront$$ResizeFront
23163 \begin_layout LyX-Code
23168 input{$$AbsOrRelPathMaster$$Basename.pstex_t}
23171 \begin_layout LyX-Code
23172 $$ResizeBack$$RotateBack"
23175 \begin_layout LyX-Code
23179 \begin_layout LyX-Code
23180 UpdateResult "$$AbsPath$$Basename.pstex_t"
23183 \begin_layout LyX-Code
23184 Requirement "graphicx"
23187 \begin_layout LyX-Code
23188 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
23191 \begin_layout LyX-Code
23192 ReferencedFile latex "$$AbsPath$$Basename.eps"
23195 \begin_layout LyX-Code
23196 ReferencedFile dvi "$$AbsPath$$Basename.eps"
23199 \begin_layout LyX-Code
23203 \begin_layout LyX-Code
23207 \begin_layout LyX-Code
23208 TransformCommand Rotate RotationLatexCommand
23211 \begin_layout LyX-Code
23212 TransformCommand Resize ResizeLatexCommand
23215 \begin_layout LyX-Code
23216 Product "$$RotateFront$$ResizeFront
23219 \begin_layout LyX-Code
23224 input{$$AbsOrRelPathMaster$$Basename.pdftex_t}
23227 \begin_layout LyX-Code
23228 $$ResizeBack$$RotateBack"
23231 \begin_layout LyX-Code
23232 UpdateFormat pdftex
23235 \begin_layout LyX-Code
23236 UpdateResult "$$AbsPath$$Basename.pdftex_t"
23239 \begin_layout LyX-Code
23240 Requirement "graphicx"
23243 \begin_layout LyX-Code
23244 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pdftex_t"
23247 \begin_layout LyX-Code
23248 ReferencedFile latex "$$AbsPath$$Basename.pdf"
23251 \begin_layout LyX-Code
23255 \begin_layout LyX-Code
23259 \begin_layout LyX-Code
23260 Product "[XFig: $$FName]"
23263 \begin_layout LyX-Code
23267 \begin_layout LyX-Code
23271 \begin_layout LyX-Code
23272 Product "<graphic fileref=
23274 "$$AbsOrRelPathMaster$$Basename.eps
23279 \begin_layout LyX-Code
23283 \begin_layout LyX-Code
23287 \begin_layout LyX-Code
23288 UpdateResult "$$AbsPath$$Basename.eps"
23291 \begin_layout LyX-Code
23292 ReferencedFile docbook "$$AbsPath$$Basename.eps"
23295 \begin_layout LyX-Code
23296 ReferencedFile docbook-xml "$$AbsPath$$Basename.eps"
23299 \begin_layout LyX-Code
23303 \begin_layout LyX-Code
23307 \begin_layout Standard
23308 As you can see, the template is enclosed in
23309 \begin_inset Flex Code
23312 \begin_layout Plain Layout
23320 \begin_inset Flex Code
23323 \begin_layout Plain Layout
23330 It contains a header specifying some general settings and, for each supported
23331 primary document file format, a section
23332 \begin_inset Flex Code
23335 \begin_layout Plain Layout
23343 \begin_inset Flex Code
23346 \begin_layout Plain Layout
23355 \begin_layout Subsection
23356 The template header
23359 \begin_layout Description
23360 \begin_inset Flex Code
23363 \begin_layout Plain Layout
23364 AutomaticProduction
23365 \begin_inset space ~
23373 Whether the file represented by the template must be generated by \SpecialChar LyX
23375 This command must occur exactly once.
23378 \begin_layout Description
23379 \begin_inset Flex Code
23382 \begin_layout Plain Layout
23384 \begin_inset space ~
23392 A glob pattern that is used in the file dialog to filter out the desired
23394 If there is more than one possible file extension (e.
23395 \begin_inset space \thinspace{}
23399 \begin_inset space \space{}
23403 \begin_inset Flex Code
23406 \begin_layout Plain Layout
23413 \begin_inset Flex Code
23416 \begin_layout Plain Layout
23422 ), use something like
23423 \begin_inset Flex Code
23426 \begin_layout Plain Layout
23433 This command must occur exactly once.
23436 \begin_layout Description
23437 \begin_inset Flex Code
23440 \begin_layout Plain Layout
23442 \begin_inset space ~
23450 The text that is displayed on the button.
23451 This command must occur exactly once.
23454 \begin_layout Description
23455 \begin_inset Flex Code
23458 \begin_layout Plain Layout
23460 \begin_inset space ~
23464 \begin_inset space ~
23472 The help text that is used in the External dialog.
23473 Provide enough information to explain to the user just what the template
23474 can provide him with.
23475 This command must occur exactly once.
23478 \begin_layout Description
23479 \begin_inset Flex Code
23482 \begin_layout Plain Layout
23484 \begin_inset space ~
23492 The file format of the original file.
23493 This must be the name of a format that is known to \SpecialChar LyX
23495 \begin_inset CommandInset ref
23497 reference "sec:Formats"
23503 \begin_inset Quotes eld
23507 \begin_inset Flex Code
23510 \begin_layout Plain Layout
23517 \begin_inset Quotes erd
23520 if the template can handle original files of more than one format.
23522 will attempt to interrogate the file itself in order to deduce its format
23524 This command must occur exactly once.
23527 \begin_layout Description
23528 \begin_inset Flex Code
23531 \begin_layout Plain Layout
23533 \begin_inset space ~
23541 A unique name for the template.
23542 It must not contain substitution macros (see below).
23545 \begin_layout Description
23546 \begin_inset Flex Code
23549 \begin_layout Plain Layout
23551 \begin_inset space ~
23554 Rotate|Resize|Clip|Extra
23559 This command specifies which transformations are supported by this template.
23560 It may occur zero or more times.
23561 This command enables the corresponding tabs in the external dialog.
23563 \begin_inset Flex Code
23566 \begin_layout Plain Layout
23572 command must have either a corresponding
23573 \begin_inset Flex Code
23576 \begin_layout Plain Layout
23583 \begin_inset Flex Code
23586 \begin_layout Plain Layout
23593 \begin_inset Flex Code
23596 \begin_layout Plain Layout
23603 Otherwise the transformation will not be supported by that format.
23606 \begin_layout Subsection
23610 \begin_layout Description
23611 \begin_inset Flex Code
23614 \begin_layout Plain Layout
23616 \begin_inset space ~
23619 LaTeX|PDFLaTeX|PlainText|DocBook|XHTML
23624 The primary document file format that this format definition is for.
23625 Not every template has a sensible representation in all document file formats.
23626 Please define nevertheless a
23627 \begin_inset Flex Code
23630 \begin_layout Plain Layout
23636 section for all templates.
23637 Use a dummy text when no representation is available.
23638 Then you can at least see a reference to the external material in the exported
23642 \begin_layout Description
23643 \begin_inset Flex Code
23646 \begin_layout Plain Layout
23648 \begin_inset space ~
23652 \begin_inset space ~
23660 This command defines an additional macro
23661 \begin_inset Flex Code
23664 \begin_layout Plain Layout
23670 for substitution in
23671 \begin_inset Flex Code
23674 \begin_layout Plain Layout
23682 \begin_inset Flex Code
23685 \begin_layout Plain Layout
23691 itself may contain substitution macros.
23692 The advantage over using
23693 \begin_inset Flex Code
23696 \begin_layout Plain Layout
23703 \begin_inset Flex Code
23706 \begin_layout Plain Layout
23712 is that the substituted value of
23713 \begin_inset Flex Code
23716 \begin_layout Plain Layout
23722 is sanitized so that it is a valid optional argument in the document format.
23723 This command may occur zero or more times.
23726 \begin_layout Description
23727 \begin_inset Flex Code
23730 \begin_layout Plain Layout
23732 \begin_inset space ~
23740 The text that is inserted in the exported document.
23741 This is actually the most important command and can be quite complex.
23742 This command must occur exactly once.
23745 \begin_layout Description
23746 \begin_inset Flex Code
23749 \begin_layout Plain Layout
23751 \begin_inset space ~
23759 This command specifies a preamble snippet that will be included in the
23762 It has to be defined using
23763 \begin_inset Flex Code
23766 \begin_layout Plain Layout
23774 \begin_inset Flex Code
23777 \begin_layout Plain Layout
23784 This command may occur zero or more times.
23787 \begin_layout Description
23788 \begin_inset Flex Code
23791 \begin_layout Plain Layout
23793 \begin_inset space ~
23797 \begin_inset space ~
23805 This command denotes files that are created by the conversion process and
23806 are needed for a particular export format.
23807 If the filename is relative, it is interpreted relative to the master document.
23808 This command may be given zero or more times.
23811 \begin_layout Description
23812 \begin_inset Flex Code
23815 \begin_layout Plain Layout
23817 \begin_inset space ~
23825 The name of a required \SpecialChar LaTeX
23827 The package is included via
23828 \begin_inset Flex Code
23831 \begin_layout Plain Layout
23839 in the \SpecialChar LaTeX
23841 This command may occur zero or more times.
23844 \begin_layout Description
23845 \begin_inset Flex Code
23848 \begin_layout Plain Layout
23850 \begin_inset space ~
23854 \begin_inset space ~
23857 RotationLatexCommand
23862 This command specifies that the built in \SpecialChar LaTeX
23863 command should be used for rotation.
23864 This command may occur once or not at all.
23867 \begin_layout Description
23868 \begin_inset Flex Code
23871 \begin_layout Plain Layout
23873 \begin_inset space ~
23877 \begin_inset space ~
23885 This command specifies that the built in \SpecialChar LaTeX
23886 command should be used for resizing.
23887 This command may occur once or not at all.
23890 \begin_layout Description
23891 \begin_inset Flex Code
23894 \begin_layout Plain Layout
23896 \begin_inset space ~
23900 \begin_inset space ~
23903 RotationLatexOption
23908 This command specifies that rotation is done via an optional argument.
23909 This command may occur once or not at all.
23912 \begin_layout Description
23913 \begin_inset Flex Code
23916 \begin_layout Plain Layout
23918 \begin_inset space ~
23922 \begin_inset space ~
23930 This command specifies that resizing is done via an optional argument.
23931 This command may occur once or not at all.
23934 \begin_layout Description
23935 \begin_inset Flex Code
23938 \begin_layout Plain Layout
23940 \begin_inset space ~
23944 \begin_inset space ~
23952 This command specifies that clipping is done via an optional argument.
23953 This command may occur once or not at all.
23956 \begin_layout Description
23957 \begin_inset Flex Code
23960 \begin_layout Plain Layout
23962 \begin_inset space ~
23966 \begin_inset space ~
23974 This command specifies that an extra optional argument is used.
23975 This command may occur once or not at all.
23978 \begin_layout Description
23979 \begin_inset Flex Code
23982 \begin_layout Plain Layout
23984 \begin_inset space ~
23992 The file format of the converted file.
23993 This must be the name of a format that is known to \SpecialChar LyX
23995 \begin_inset Flex Noun
23998 \begin_layout Plain Layout
23999 Tools\SpecialChar menuseparator
24000 Preferences\SpecialChar menuseparator
24001 File Handling\SpecialChar menuseparator
24008 This command must occur exactly once.
24009 If the resulting file format is PDF, you need to specify the format
24010 \begin_inset Flex Code
24013 \begin_layout Plain Layout
24020 This is the PDF format used for including graphics.
24021 The other defined PDF formats are for document export.
24024 \begin_layout Description
24025 \begin_inset Flex Code
24028 \begin_layout Plain Layout
24030 \begin_inset space ~
24038 The file name of the converted file.
24039 The file name must be absolute.
24040 This command must occur exactly once.
24043 \begin_layout Subsection
24044 Preamble definitions
24047 \begin_layout Standard
24048 The external template configuration file may contain additional preamble
24049 definitions enclosed by
24050 \begin_inset Flex Code
24053 \begin_layout Plain Layout
24061 \begin_inset Flex Code
24064 \begin_layout Plain Layout
24071 They can be used by the templates in the
24072 \begin_inset Flex Code
24075 \begin_layout Plain Layout
24084 \begin_layout Section
24085 The substitution mechanism
24088 \begin_layout Standard
24089 When the external material facility invokes an external program, it is done
24090 on the basis of a command defined in the template configuration file.
24091 These commands can contain various macros that are expanded before execution.
24092 Execution always take place in the directory of the containing document.
24095 \begin_layout Standard
24096 Also, whenever external material is to be displayed, the name will be produced
24097 by the substitution mechanism, and most other commands in the template
24098 definition support substitution as well.
24101 \begin_layout Standard
24102 The available macros are the following:
24105 \begin_layout Description
24106 \begin_inset Flex Code
24109 \begin_layout Plain Layout
24110 $$AbsOrRelPathMaster
24115 The file path, absolute or relative to the master \SpecialChar LyX
24119 \begin_layout Description
24120 \begin_inset Flex Code
24123 \begin_layout Plain Layout
24124 $$AbsOrRelPathParent
24129 The file path, absolute or relative to the \SpecialChar LyX
24133 \begin_layout Description
24134 \begin_inset Flex Code
24137 \begin_layout Plain Layout
24143 The absolute file path.
24146 \begin_layout Description
24147 \begin_inset Flex Code
24150 \begin_layout Plain Layout
24156 The filename without path and without the extension.
24159 \begin_layout Description
24160 \begin_inset Flex Code
24163 \begin_layout Plain Layout
24165 \begin_inset Quotes eld
24169 \begin_inset Quotes erd
24177 This macro will expand to the contents of the file with the name
24178 \begin_inset Flex Code
24181 \begin_layout Plain Layout
24190 \begin_layout Description
24191 \begin_inset Flex Code
24194 \begin_layout Plain Layout
24200 The file extension (including the dot).
24203 \begin_layout Description
24204 \begin_inset Flex Code
24207 \begin_layout Plain Layout
24213 This will be the string
24214 \begin_inset Quotes eld
24218 \begin_inset Quotes erd
24221 if the file is in JPEG format, otherwise it will be the string
24222 \begin_inset Quotes eld
24226 \begin_inset Quotes erd
24230 This is useful to avoid uneeded conversions for output formats that support
24231 both PNG and JPEG fomats.
24232 The predefined RasterImage template uses this macro for the pdf\SpecialChar TeX
24237 \begin_layout Description
24238 \begin_inset Flex Code
24241 \begin_layout Plain Layout
24247 The filename of the file specified in the external material dialog.
24248 This is either an absolute name, or it is relative to the \SpecialChar LyX
24252 \begin_layout Description
24253 \begin_inset Flex Code
24256 \begin_layout Plain Layout
24263 \begin_inset Flex Code
24266 \begin_layout Plain Layout
24272 (absolute name or relative to the \SpecialChar LyX
24276 \begin_layout Description
24277 \begin_inset Flex Code
24280 \begin_layout Plain Layout
24286 The file path, relative to the master \SpecialChar LyX
24290 \begin_layout Description
24291 \begin_inset Flex Code
24294 \begin_layout Plain Layout
24300 The file path, relative to the \SpecialChar LyX
24304 \begin_layout Description
24305 \begin_inset Flex Code
24308 \begin_layout Plain Layout
24314 This macro will expand to the absolute path of the system directory.
24315 This is typically used to point to the various helper scripts that are
24316 bundled with \SpecialChar LyX
24320 \begin_layout Description
24321 \begin_inset Flex Code
24324 \begin_layout Plain Layout
24330 A name and full path to a temporary file which will be automatically deleted
24331 whenever the containing document is closed, or the external material insertion
24335 \begin_layout Standard
24336 All path macros contain a trailing directory separator, so you can construct
24338 \begin_inset space \thinspace{}
24342 \begin_inset space \space{}
24345 the absolute filename with
24346 \begin_inset Flex Code
24349 \begin_layout Plain Layout
24350 $$AbsPath$$Basename$$Extension
24358 \begin_layout Standard
24359 The macros above are substituted in all commands unless otherwise noted.
24361 \begin_inset Flex Code
24364 \begin_layout Plain Layout
24370 supports additionally the following substitutions if they are enabled by
24372 \begin_inset Flex Code
24375 \begin_layout Plain Layout
24382 \begin_inset Flex Code
24385 \begin_layout Plain Layout
24394 \begin_layout Description
24395 \begin_inset Flex Code
24398 \begin_layout Plain Layout
24404 The front part of the resize command.
24407 \begin_layout Description
24408 \begin_inset Flex Code
24411 \begin_layout Plain Layout
24417 The back part of the resize command.
24420 \begin_layout Description
24421 \begin_inset Flex Code
24424 \begin_layout Plain Layout
24430 The front part of the rotation command.
24433 \begin_layout Description
24434 \begin_inset Flex Code
24437 \begin_layout Plain Layout
24443 The back part of the rotation command.
24446 \begin_layout Standard
24447 The value string of the
24448 \begin_inset Flex Code
24451 \begin_layout Plain Layout
24457 command supports additionally the following substitutions if they are enabled
24459 \begin_inset Flex Code
24462 \begin_layout Plain Layout
24469 \begin_inset Flex Code
24472 \begin_layout Plain Layout
24481 \begin_layout Description
24482 \begin_inset Flex Code
24485 \begin_layout Plain Layout
24494 \begin_layout Description
24495 \begin_inset Flex Code
24498 \begin_layout Plain Layout
24507 \begin_layout Description
24508 \begin_inset Flex Code
24511 \begin_layout Plain Layout
24520 \begin_layout Description
24521 \begin_inset Flex Code
24524 \begin_layout Plain Layout
24530 The rotation option.
24533 \begin_layout Standard
24534 You may ask why there are so many path macros.
24535 There are mainly two reasons:
24538 \begin_layout Enumerate
24539 Relative and absolute file names should remain relative or absolute, respectivel
24541 Users may have reasons to prefer either form.
24542 Relative names are useful for portable documents that should work on different
24543 machines, for example.
24544 Absolute names may be required by some programs.
24547 \begin_layout Enumerate
24549 treats relative file names differently than \SpecialChar LyX
24550 and other programs in nested
24552 For \SpecialChar LyX
24553 , a relative file name is always relative to the document that contains
24555 For \SpecialChar LaTeX
24556 , it is always relative to the master document.
24557 These two definitions are identical if you have only one document, but
24558 differ if you have a master document that includes part documents.
24559 That means that relative filenames must be transformed when presented to
24562 Fortunately \SpecialChar LyX
24563 does this automatically for you if you choose the right macros.
24566 \begin_layout Standard
24567 So which path macro should be used in new template definitions? The rule
24571 \begin_layout Itemize
24573 \begin_inset Flex Code
24576 \begin_layout Plain Layout
24582 if an absolute path is required.
24585 \begin_layout Itemize
24587 \begin_inset Flex Code
24590 \begin_layout Plain Layout
24591 $$AbsOrRelPathMaster
24596 if the substituted string is some kind of \SpecialChar LaTeX
24600 \begin_layout Itemize
24602 \begin_inset Flex Code
24605 \begin_layout Plain Layout
24606 $$AbsOrRelPathParent
24611 in order to preserve the user's choice.
24614 \begin_layout Standard
24615 There are special cases where this rule does not work and e.
24616 \begin_inset space \thinspace{}
24620 \begin_inset space \space{}
24623 relative names are needed, but normally it will work just fine.
24624 One example for such a case is the command
24625 \begin_inset Flex Code
24628 \begin_layout Plain Layout
24629 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
24634 in the XFig template above: We can't use the absolute name because the
24636 \begin_inset Flex Code
24639 \begin_layout Plain Layout
24645 files needs the relative name in order to rewrite the file content.
24648 \begin_layout Section
24649 Security discussion
24650 \begin_inset CommandInset label
24652 name "sec:Security-discussion"
24659 \begin_layout Standard
24660 The external material feature interfaces with a lot of external programs
24661 and does so automatically, so we have to consider the security implications
24663 In particular, since you have the option of including your own filenames
24664 and/or parameter strings and those are expanded into a command, it seems
24665 that it would be possible to create a malicious document which executes
24666 arbitrary commands when a user views or prints the document.
24667 This is something we definitely want to avoid.
24670 \begin_layout Standard
24671 However, since the external program commands are specified in the template
24672 configuration file only, there are no security issues if \SpecialChar LyX
24673 is properly configure
24674 d with safe templates only.
24675 This is so because the external programs are invoked with the
24676 \begin_inset Flex Code
24679 \begin_layout Plain Layout
24685 -system call rather than the
24686 \begin_inset Flex Code
24689 \begin_layout Plain Layout
24695 system-call, so it's not possible to execute arbitrary commands from the
24696 filename or parameter section via the shell.
24699 \begin_layout Standard
24700 This also implies that you are restricted in what command strings you can
24701 use in the external material templates.
24702 In particular, pipes and redirection are not readily available.
24703 This has to be so if \SpecialChar LyX
24704 should remain safe.
24705 If you want to use some of the shell features, you should write a safe
24706 script to do this in a controlled manner, and then invoke the script from
24707 the command string.
24711 \begin_layout Standard
24712 It is possible to design a template that interacts directly with the shell,
24713 but since this would allow a malicious user to execute arbitrary commands
24714 by writing clever filenames and/or parameters, we generally recommend that
24715 you only use safe scripts that work with the
24716 \begin_inset Flex Code
24719 \begin_layout Plain Layout
24725 system call in a controlled manner.
24726 Of course, for use in a controlled environment, it can be tempting to just
24727 fall back to use ordinary shell scripts.
24728 If you do so, be aware that you
24732 provide an easily exploitable security hole in your system.
24733 Of course it stands to reason that such unsafe templates will never be
24734 included in the standard \SpecialChar LyX
24735 distribution, although we do encourage people
24736 to submit new templates in the open source tradition.
24737 But \SpecialChar LyX
24738 as shipped from the official distribution channels will never have
24742 \begin_layout Standard
24743 Including external material provides a lot of power, and you have to be
24744 careful not to introduce security hazards with this power.
24745 A subtle error in a single line in an innocent looking script can open
24746 the door to huge security problems.
24747 So if you do not fully understand the issues, we recommend that you consult
24748 a knowledgeable security professional or the \SpecialChar LyX
24749 development team if you have
24750 any questions about whether a given template is safe or not.
24751 And do this before you use it in an uncontrolled environment.
24754 \begin_layout Chapter
24756 List of supported \SpecialChar LyX
24757 functions to be used in layouts
24758 \begin_inset CommandInset label
24760 name "chap:List-of-functions"
24767 \begin_layout Standard
24769 \begin_inset Tabular
24770 <lyxtabular version="3" rows="11" columns="8">
24771 <features tabularvalignment="middle">
24772 <column alignment="left" valignment="top">
24773 <column alignment="left" valignment="top">
24774 <column alignment="left" valignment="top">
24775 <column alignment="left" valignment="top">
24776 <column alignment="left" valignment="top">
24777 <column alignment="left" valignment="top">
24778 <column alignment="left" valignment="top">
24779 <column alignment="left" valignment="top">
24781 <cell alignment="left" valignment="top" usebox="none">
24784 \begin_layout Plain Layout
24790 <cell alignment="left" valignment="top" usebox="none">
24793 \begin_layout Plain Layout
24799 <cell alignment="left" valignment="top" usebox="none">
24802 \begin_layout Plain Layout
24808 <cell alignment="left" valignment="top" usebox="none">
24811 \begin_layout Plain Layout
24817 <cell alignment="center" valignment="top" usebox="none">
24820 \begin_layout Plain Layout
24826 <cell alignment="center" valignment="top" usebox="none">
24829 \begin_layout Plain Layout
24835 <cell alignment="center" valignment="top" usebox="none">
24838 \begin_layout Plain Layout
24844 <cell alignment="center" valignment="top" usebox="none">
24847 \begin_layout Plain Layout
24855 <cell alignment="left" valignment="top" usebox="none">
24858 \begin_layout Plain Layout
24864 <cell alignment="left" valignment="top" usebox="none">
24867 \begin_layout Plain Layout
24873 <cell alignment="left" valignment="top" usebox="none">
24876 \begin_layout Plain Layout
24882 <cell alignment="left" valignment="top" usebox="none">
24885 \begin_layout Plain Layout
24891 <cell alignment="center" valignment="top" usebox="none">
24894 \begin_layout Plain Layout
24900 <cell alignment="center" valignment="top" usebox="none">
24903 \begin_layout Plain Layout
24909 <cell alignment="center" valignment="top" usebox="none">
24912 \begin_layout Plain Layout
24918 <cell alignment="center" valignment="top" usebox="none">
24921 \begin_layout Plain Layout
24929 <cell alignment="left" valignment="top" usebox="none">
24932 \begin_layout Plain Layout
24938 <cell alignment="left" valignment="top" usebox="none">
24941 \begin_layout Plain Layout
24947 <cell alignment="left" valignment="top" usebox="none">
24950 \begin_layout Plain Layout
24956 <cell alignment="left" valignment="top" usebox="none">
24959 \begin_layout Plain Layout
24965 <cell alignment="center" valignment="top" usebox="none">
24968 \begin_layout Plain Layout
24974 <cell alignment="center" valignment="top" usebox="none">
24977 \begin_layout Plain Layout
24983 <cell alignment="center" valignment="top" usebox="none">
24986 \begin_layout Plain Layout
24992 <cell alignment="center" valignment="top" usebox="none">
24995 \begin_layout Plain Layout
25003 <cell alignment="left" valignment="top" usebox="none">
25006 \begin_layout Plain Layout
25012 <cell alignment="left" valignment="top" usebox="none">
25015 \begin_layout Plain Layout
25021 <cell alignment="left" valignment="top" usebox="none">
25024 \begin_layout Plain Layout
25030 <cell alignment="left" valignment="top" usebox="none">
25033 \begin_layout Plain Layout
25039 <cell alignment="center" valignment="top" usebox="none">
25042 \begin_layout Plain Layout
25048 <cell alignment="center" valignment="top" usebox="none">
25051 \begin_layout Plain Layout
25057 <cell alignment="center" valignment="top" usebox="none">
25060 \begin_layout Plain Layout
25066 <cell alignment="center" valignment="top" usebox="none">
25069 \begin_layout Plain Layout
25077 <cell alignment="left" valignment="top" usebox="none">
25080 \begin_layout Plain Layout
25086 <cell alignment="left" valignment="top" usebox="none">
25089 \begin_layout Plain Layout
25095 <cell alignment="left" valignment="top" usebox="none">
25098 \begin_layout Plain Layout
25104 <cell alignment="left" valignment="top" usebox="none">
25107 \begin_layout Plain Layout
25113 <cell alignment="center" valignment="top" usebox="none">
25116 \begin_layout Plain Layout
25122 <cell alignment="center" valignment="top" usebox="none">
25125 \begin_layout Plain Layout
25131 <cell alignment="center" valignment="top" usebox="none">
25134 \begin_layout Plain Layout
25140 <cell alignment="center" valignment="top" usebox="none">
25143 \begin_layout Plain Layout
25151 <cell alignment="left" valignment="top" usebox="none">
25154 \begin_layout Plain Layout
25160 <cell alignment="left" valignment="top" usebox="none">
25163 \begin_layout Plain Layout
25169 <cell alignment="left" valignment="top" usebox="none">
25172 \begin_layout Plain Layout
25178 <cell alignment="left" valignment="top" usebox="none">
25181 \begin_layout Plain Layout
25187 <cell alignment="center" valignment="top" usebox="none">
25190 \begin_layout Plain Layout
25196 <cell alignment="center" valignment="top" usebox="none">
25199 \begin_layout Plain Layout
25205 <cell alignment="center" valignment="top" usebox="none">
25208 \begin_layout Plain Layout
25214 <cell alignment="center" valignment="top" usebox="none">
25217 \begin_layout Plain Layout
25225 <cell alignment="left" valignment="top" usebox="none">
25228 \begin_layout Plain Layout
25234 <cell alignment="left" valignment="top" usebox="none">
25237 \begin_layout Plain Layout
25243 <cell alignment="left" valignment="top" usebox="none">
25246 \begin_layout Plain Layout
25252 <cell alignment="left" valignment="top" usebox="none">
25255 \begin_layout Plain Layout
25261 <cell alignment="center" valignment="top" usebox="none">
25264 \begin_layout Plain Layout
25270 <cell alignment="center" valignment="top" usebox="none">
25273 \begin_layout Plain Layout
25279 <cell alignment="center" valignment="top" usebox="none">
25282 \begin_layout Plain Layout
25288 <cell alignment="center" valignment="top" usebox="none">
25291 \begin_layout Plain Layout
25299 <cell alignment="left" valignment="top" usebox="none">
25302 \begin_layout Plain Layout
25308 <cell alignment="left" valignment="top" usebox="none">
25311 \begin_layout Plain Layout
25317 <cell alignment="left" valignment="top" usebox="none">
25320 \begin_layout Plain Layout
25326 <cell alignment="left" valignment="top" usebox="none">
25329 \begin_layout Plain Layout
25335 <cell alignment="center" valignment="top" usebox="none">
25338 \begin_layout Plain Layout
25344 <cell alignment="center" valignment="top" usebox="none">
25347 \begin_layout Plain Layout
25353 <cell alignment="center" valignment="top" usebox="none">
25356 \begin_layout Plain Layout
25362 <cell alignment="center" valignment="top" usebox="none">
25365 \begin_layout Plain Layout
25373 <cell alignment="left" valignment="top" usebox="none">
25376 \begin_layout Plain Layout
25382 <cell alignment="left" valignment="top" usebox="none">
25385 \begin_layout Plain Layout
25391 <cell alignment="left" valignment="top" usebox="none">
25394 \begin_layout Plain Layout
25400 <cell alignment="left" valignment="top" usebox="none">
25403 \begin_layout Plain Layout
25409 <cell alignment="center" valignment="top" usebox="none">
25412 \begin_layout Plain Layout
25418 <cell alignment="center" valignment="top" usebox="none">
25421 \begin_layout Plain Layout
25427 <cell alignment="center" valignment="top" usebox="none">
25430 \begin_layout Plain Layout
25436 <cell alignment="center" valignment="top" usebox="none">
25439 \begin_layout Plain Layout
25447 <cell alignment="left" valignment="top" usebox="none">
25450 \begin_layout Plain Layout
25456 <cell alignment="left" valignment="top" usebox="none">
25459 \begin_layout Plain Layout
25465 <cell alignment="left" valignment="top" usebox="none">
25468 \begin_layout Plain Layout
25474 <cell alignment="left" valignment="top" usebox="none">
25477 \begin_layout Plain Layout
25483 <cell alignment="center" valignment="top" usebox="none">
25486 \begin_layout Plain Layout
25492 <cell alignment="center" valignment="top" usebox="none">
25495 \begin_layout Plain Layout
25501 <cell alignment="center" valignment="top" usebox="none">
25504 \begin_layout Plain Layout
25510 <cell alignment="center" valignment="top" usebox="none">
25513 \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
25539 <cell alignment="center" valignment="top" usebox="none">
25542 \begin_layout Plain Layout
25548 <cell alignment="center" valignment="top" usebox="none">
25551 \begin_layout Plain Layout
25557 <cell alignment="center" valignment="top" usebox="none">
25560 \begin_layout Plain Layout
25566 <cell alignment="center" valignment="top" usebox="none">
25569 \begin_layout Plain Layout
25575 <cell alignment="center" valignment="top" usebox="none">
25578 \begin_layout Plain Layout
25584 <cell alignment="center" valignment="top" usebox="none">
25587 \begin_layout Plain Layout
25601 \begin_layout Chapter
25602 Names of available colors to be used in layouts
25603 \begin_inset CommandInset label
25605 name "chap:Names-of-colors"
25612 \begin_layout Standard
25613 The colors listed here are the standard colors and the those that you can
25614 adjust in the \SpecialChar LyX
25618 \begin_layout Description
25631 No particular color – clear or default
25634 \begin_layout Description
25638 \begin_layout Description
25642 \begin_layout Description
25646 \begin_layout Description
25650 \begin_layout Description
25654 \begin_layout Description
25658 \begin_layout Description
25662 \begin_layout Description
25666 \begin_layout Description
25667 added_space Added space marker color
25670 \begin_layout Description
25671 addedtext Added text color
25674 \begin_layout Description
25675 appendix Appendix marker color
25678 \begin_layout Description
25679 background Background color
25682 \begin_layout Description
25683 bottomarea Bottom area color
25686 \begin_layout Description
25687 branchlabel Label color for branches
25690 \begin_layout Description
25691 buttonbg Color used for button background
25694 \begin_layout Description
25695 buttonhoverbg Color used for button background under focus
25698 \begin_layout Description
25699 buttonframe Color for inset button frames
25702 \begin_layout Description
25703 changebar Changebar color
25706 \begin_layout Description
25707 changedtextauthor1 Changed text color author 1
25710 \begin_layout Description
25711 changedtextauthor2 Changed text color author 2
25714 \begin_layout Description
25715 changedtextauthor3 Changed text color author 3
25718 \begin_layout Description
25719 changedtextauthor4 Changed text color author 4
25722 \begin_layout Description
25723 changedtextauthor5 Changed text color author 5
25726 \begin_layout Description
25727 collapsable_inset_frame Collapsable insets framecolor
25730 \begin_layout Description
25731 collapsable_inset_text Collapsable insets text color
25734 \begin_layout Description
25735 command Text color for command insets
25738 \begin_layout Description
25739 commandbg Background color for command insets
25742 \begin_layout Description
25743 commandframe Frame color for command insets
25746 \begin_layout Description
25747 comment color for comments
25750 \begin_layout Description
25751 commentbg Background color of comments
25754 \begin_layout Description
25755 cursor Cursor color
25758 \begin_layout Description
25759 deletedtext Deleted text color
25762 \begin_layout Description
25763 deletedtextmodifier Deleted text modifying color
25766 \begin_layout Description
25767 depthbar Color for the depth bars in the margin
25770 \begin_layout Description
25771 eolmarker End of line marker color
25774 \begin_layout Description
25775 error Color of the \SpecialChar LaTeX
25779 \begin_layout Description
25780 footlabel Label color for footnotes
25783 \begin_layout Description
25784 graphicsbg Graphics inset background color
25787 \begin_layout Description
25788 greyedout Label color for greyedout insets
25791 \begin_layout Description
25792 greyedoutbg Background color of greyedout inset
25795 \begin_layout Description
25796 greyedouttext Color for greyedout inset text
25799 \begin_layout Description
25800 indexlabel Label color for index insets
25803 \begin_layout Description
25804 ignore The color is ignored
25807 \begin_layout Description
25808 inherit The color is inherited
25811 \begin_layout Description
25812 inlinecompletion Inline completion color
25815 \begin_layout Description
25816 insetbg Inset marker background color
25819 \begin_layout Description
25820 insetframe Inset marker frame color
25823 \begin_layout Description
25824 language Color for marking foreign language words
25827 \begin_layout Description
25828 latex Text color in \SpecialChar LaTeX
25832 \begin_layout Description
25833 listingsbg Background color of listings inset
25836 \begin_layout Description
25837 marginlabel Label color for margin notes
25840 \begin_layout Description
25841 math Math inset text color
25844 \begin_layout Description
25845 mathbg Math inset background color
25848 \begin_layout Description
25849 mathcorners Math inset frame color not under focus
25852 \begin_layout Description
25853 mathframe Math inset frame color under focus
25856 \begin_layout Description
25857 mathline Math line color
25860 \begin_layout Description
25861 mathmacrobg Macro math inset background color
25864 \begin_layout Description
25865 mathmacroblend Macro math blended color
25868 \begin_layout Description
25869 mathmacroframe Macro math frame color
25872 \begin_layout Description
25873 mathmacrohoverbg Macro math inset background color hovered
25876 \begin_layout Description
25877 mathmacrolabel Macro math label color
25880 \begin_layout Description
25881 mathmacronewarg Macro template color for new parameters
25884 \begin_layout Description
25885 mathmacrooldarg Macro template color for old parameters
25888 \begin_layout Description
25889 newpage New page color
25892 \begin_layout Description
25893 nonunique_inlinecompletion Inline completion color for the non-unique part
25896 \begin_layout Description
25897 notebg Background color of notes
25900 \begin_layout Description
25901 notelabel Label color for notes
25904 \begin_layout Description
25905 pagebreak Page break/line break color
25908 \begin_layout Description
25909 paragraphmarker Color used for the pilcrow sign to mark the end of a paragraph
25912 \begin_layout Description
25913 phantomtext Text color for phantom insets
25916 \begin_layout Description
25917 preview The color used for previews
25920 \begin_layout Description
25921 previewframe Preview frame color
25924 \begin_layout Description
25925 regexpframe Color for regexp frame
25928 \begin_layout Description
25929 selection Background color of selected text
25932 \begin_layout Description
25933 selectiontext Foreground color of selected text
25936 \begin_layout Description
25937 shadedbg Background color of shaded box
25940 \begin_layout Description
25941 special Special chars text color
25944 \begin_layout Description
25945 tabularline Table line color
25948 \begin_layout Description
25949 tabularonoffline Table line color
25952 \begin_layout Description
25953 urllabel Label color for URL insets
25956 \begin_layout Description
25957 urltext Color for URL inset text