1 #LyX 2.2 created this file. For more info see http://www.lyx.org/
5 \origin /systemlyxdir/doc/
8 % DO NOT ALTER THIS PREAMBLE!!!
10 % This preamble is designed to ensure that this document prints
11 % out as advertised. If you mess with this preamble,
12 % parts of this document may not print out as expected. If you
13 % have problems LaTeXing this file, please contact
14 % the documentation team
15 % email: lyx-docs@lists.lyx.org
17 \usepackage{ifpdf} % part of the hyperref bundle
18 \ifpdf % if pdflatex is used
20 % set fonts for nicer pdf view
21 \IfFileExists{lmodern.sty}
22 {\usepackage{lmodern}}{}
24 \fi % end if pdflatex is used
26 % the pages of the TOC is numbered roman
27 % and a pdf-bookmark for the TOC is added
28 \let\myTOC\tableofcontents
29 \renewcommand\tableofcontents{%
31 \pdfbookmark[1]{\contentsname}{}
35 % increase link area for cross-references and autoname them,
36 \AtBeginDocument{\renewcommand{\ref}[1]{\mbox{\autoref{#1}}}}
37 \@ifundefined{extrasenglish}{\usepackage[english]{babel}}{}
38 \@ifpackageloaded{babel}{
39 \addto\extrasenglish{%
40 \renewcommand*{\equationautorefname}[1]{}%
41 \renewcommand{\sectionautorefname}{sec.\negthinspace}%
42 \renewcommand{\subsectionautorefname}{sec.\negthinspace}%
43 \renewcommand{\subsubsectionautorefname}{sec.\negthinspace}%
47 \options fleqn,bibliography=totoc,index=totoc,BCOR7.5mm,titlepage,captions=tableheading
48 \use_default_options false
52 \maintain_unincluded_children false
55 InsetLayout Flex:MenuItem
64 \newcommand*{\menuitem}[1]{{\sffamily #1}}
68 # In case we need to do with sans...
69 #InsetLayout CharStyle:Code
74 #\renewcommand{\code}[1]{{\sffamily #1}}
79 \language_package default
82 \font_roman "default" "default"
83 \font_sans "default" "default"
84 \font_typewriter "default" "default"
85 \font_math "auto" "auto"
86 \font_default_family default
87 \use_non_tex_fonts false
90 \font_sf_scale 100 100
91 \font_tt_scale 100 100
93 \default_output_format default
95 \bibtex_command default
96 \index_command default
100 \pdf_title "LyX Configuration Manual"
101 \pdf_author "LyX Team"
102 \pdf_subject "LyX-documentation Customization"
103 \pdf_keywords "LyX, documentation, customization"
105 \pdf_bookmarksnumbered true
106 \pdf_bookmarksopen true
107 \pdf_bookmarksopenlevel 1
108 \pdf_breaklinks false
112 \pdf_pdfusetitle false
113 \pdf_quoted_options "linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue,pdfpagelayout=OneColumn, pdfnewwindow=true, pdfstartview=XYZ, plainpages=false"
116 \use_package amsmath 0
117 \use_package amssymb 0
118 \use_package cancel 0
120 \use_package mathdots 1
121 \use_package mathtools 0
122 \use_package mhchem 0
123 \use_package stackrel 0
124 \use_package stmaryrd 0
125 \use_package undertilde 0
127 \cite_engine_type default
131 \paperorientation portrait
146 \paragraph_separation indent
147 \paragraph_indentation default
148 \quotes_language english
151 \paperpagestyle headings
152 \tracking_changes true
153 \output_changes false
157 \author -712698321 "Jürgen Spitzmüller"
158 \author -195340706 "Georg Baum"
159 \author 274215730 "scott"
165 Customizing \SpecialChar LyX
166 : Features for the Advanced User
170 by the \SpecialChar LyX
175 \begin_layout Plain Layout
177 If you have comments or error corrections, please send them to the \SpecialChar LyX
180 \begin_inset CommandInset href
182 target "lyx-docs@lists.lyx.org"
189 \begin_inset Quotes eld
193 \begin_inset Quotes erd
196 in the subject header, and please cc the current maintainer of this file,
197 Richard Heck <rgheck@comcast.net>.
203 \begin_inset Newline newline
207 \begin_inset Newline newline
213 \begin_layout Standard
214 \begin_inset CommandInset toc
215 LatexCommand tableofcontents
222 \begin_layout Standard
223 \begin_inset Note Note
226 \begin_layout Plain Layout
227 Please use change tracking when modifying this document.
228 This makes it easier for our translators to recognize things that have
229 been changed, and it helps the maintainer keep up-to-date with what's been
238 \begin_layout Chapter
242 \begin_layout Standard
243 This manual covers the customization features present in \SpecialChar LyX
245 In it, we discuss issues like keyboard shortcuts, screen previewing options,
246 printer options, sending commands to \SpecialChar LyX
247 via the \SpecialChar LyX
248 Server, internationalization,
249 installing new \SpecialChar LaTeX
250 classes and \SpecialChar LyX
252 We can't possibly hope to touch on everything you can change—our developers
253 add new features faster than we can document them—but we will explain the
254 most common customizations and hopefully point you in the right direction
255 for some of the more obscure ones.
258 \begin_layout Standard
259 \begin_inset Branch OutDated
262 \begin_layout Standard
263 Information from previous versions of this document that now seems to be
264 outdated is contained in the OutDated branch of this document.
265 By default, this information will not appear in the \SpecialChar LaTeX
274 \begin_layout Chapter
279 \begin_layout Standard
280 This chapter aims to help you to find your way through the \SpecialChar LyX
283 Before continuing to read this chapter, you should find out where your
285 library and user directories are by using
286 \begin_inset Flex MenuItem
289 \begin_layout Plain Layout
290 Help\SpecialChar menuseparator
301 The library directory is the place where \SpecialChar LyX
302 places its system-wide configuration
303 files; the user directory is where you can place your modified versions.
304 We will call the former
305 \begin_inset Flex Code
308 \begin_layout Plain Layout
315 \begin_inset Flex MenuItem
318 \begin_layout Plain Layout
324 in the remainder of this document.
328 \begin_layout Section
330 \begin_inset Flex Code
333 \begin_layout Plain Layout
342 \begin_layout Standard
343 \begin_inset Flex Code
346 \begin_layout Plain Layout
352 and its sub-directories contain a number of files and that can be used
353 to customize \SpecialChar LyX
355 You can change many of these files from within \SpecialChar LyX
357 \begin_inset Flex MenuItem
360 \begin_layout Plain Layout
361 Tools\SpecialChar menuseparator
368 Most customization that you will want to do in \SpecialChar LyX
369 is possible through this
371 However, many other inner aspects of \SpecialChar LyX
372 can be customized by modifying the
374 \begin_inset Flex Code
377 \begin_layout Plain Layout
384 These files fall in different categories, described in the following subsection
388 \begin_layout Subsection
389 Automatically generated files
392 \begin_layout Standard
393 The files, which are to be found in
394 \begin_inset Flex MenuItem
397 \begin_layout Plain Layout
403 , are generated when you configure \SpecialChar LyX
405 They contain various default values that are guessed by inspection.
406 In general, it is not a good idea to modify them, since they might be overwritt
410 \begin_layout Labeling
411 \labelwidthstring 00.00.0000
412 \begin_inset Flex Code
415 \begin_layout Plain Layout
421 contains defaults for various commands.
424 \begin_layout Labeling
425 \labelwidthstring 00.00.0000
426 \begin_inset Flex Code
429 \begin_layout Plain Layout
435 contains the list of packages that have been recognized by \SpecialChar LyX
437 It is currently unused by the \SpecialChar LyX
438 program itself, but the information extracted,
439 and more, is made available with
440 \begin_inset Flex MenuItem
443 \begin_layout Plain Layout
444 Help\SpecialChar menuseparator
458 \begin_layout Labeling
459 \labelwidthstring 00.00.0000
460 \begin_inset Flex Code
463 \begin_layout Plain Layout
469 the list of text classes that have been found in your
470 \begin_inset Flex Code
473 \begin_layout Plain Layout
479 directories, along with the associated \SpecialChar LaTeX
480 document class and their description.
483 \begin_layout Labeling
484 \labelwidthstring 00.00.0000
485 \begin_inset Flex Code
488 \begin_layout Plain Layout
494 the list of layout modules found in your
495 \begin_inset Flex Code
498 \begin_layout Plain Layout
507 \begin_layout Labeling
508 \labelwidthstring 00.00.0000
509 \begin_inset Flex Code
512 \begin_layout Plain Layout
518 lists of various sorts of \SpecialChar LaTeX
519 -related files found on your system
522 \begin_layout Labeling
523 \labelwidthstring 00.00.0000
524 \begin_inset Flex Code
527 \begin_layout Plain Layout
528 doc/\SpecialChar LaTeX
534 is automatically generated during configuration from the file
535 \begin_inset Flex Code
538 \begin_layout Plain Layout
546 It contains information on your \SpecialChar LaTeX
550 \begin_layout Subsection
554 \begin_layout Standard
555 These directories are duplicated between
556 \begin_inset Flex Code
559 \begin_layout Plain Layout
566 \begin_inset Flex Code
569 \begin_layout Plain Layout
576 If a particular files exists in both places, the one in
577 \begin_inset Flex Code
580 \begin_layout Plain Layout
589 \begin_layout Labeling
590 \labelwidthstring 00.00.0000
591 \begin_inset Flex Code
594 \begin_layout Plain Layout
600 this directory contains files with the extension
601 \begin_inset Flex Code
604 \begin_layout Plain Layout
610 that define the keybindings used in \SpecialChar LyX
612 If there exists an internationalized version of the bind file named
613 \begin_inset Flex Code
616 \begin_layout Plain Layout
622 , that will be used first.
625 \begin_layout Labeling
626 \labelwidthstring 00.00.0000
627 \begin_inset Flex Code
630 \begin_layout Plain Layout
636 contains graphics files that can be included in documents.
640 \begin_layout Labeling
641 \labelwidthstring 00.00.0000
642 \begin_inset Flex Code
645 \begin_layout Plain Layout
651 contains \SpecialChar LyX
652 documentation files (including the one you are currently reading).
654 \begin_inset Flex Code
657 \begin_layout Plain Layout
664 deserves special attention, as noted above.
665 The internationalized help docs are in subdirectories
666 \begin_inset Flex Code
669 \begin_layout Plain Layout
676 \begin_inset Quotes eld
680 \begin_inset Quotes erd
683 is the ISO language code.
685 \begin_inset CommandInset ref
687 reference "cha:Internationalizing-LyX"
694 \begin_layout Labeling
695 \labelwidthstring 00.00.0000
696 \begin_inset Flex Code
699 \begin_layout Plain Layout
705 contains example files that explain how to use some features.
706 In the file browser, press the
707 \begin_inset Flex MenuItem
710 \begin_layout Plain Layout
719 \begin_layout Labeling
720 \labelwidthstring 00.00.0000
721 \begin_inset Flex Code
724 \begin_layout Plain Layout
730 contains image files that are used by the
731 \begin_inset Flex MenuItem
734 \begin_layout Plain Layout
741 In addition, it also contains the individual icons used in the toolbar
742 and the banners that can be shown when \SpecialChar LyX
746 \begin_layout Labeling
747 \labelwidthstring 00.00.0000
748 \begin_inset Flex Code
751 \begin_layout Plain Layout
757 contains keyboard keymapping files.
759 \begin_inset CommandInset ref
761 reference "sec:International-Keymap-Stuff"
768 \begin_layout Labeling
769 \labelwidthstring 00.00.0000
770 \begin_inset Flex Code
773 \begin_layout Plain Layout
779 contains the text class and module files described in
780 \begin_inset CommandInset ref
782 reference "cha:Installing-New-Document"
789 \begin_layout Labeling
790 \labelwidthstring 00.00.0000
791 \begin_inset Flex Code
794 \begin_layout Plain Layout
801 \begin_inset Flex Code
804 \begin_layout Plain Layout
810 Python scripts used to convert between \SpecialChar LyX
812 These can be run from the command line if, say, you want to batch-convert
816 \begin_layout Labeling
817 \labelwidthstring 00.00.0000
818 \begin_inset Flex Code
821 \begin_layout Plain Layout
827 contains some files that demonstrate the capabilities of the
828 \begin_inset Flex MenuItem
831 \begin_layout Plain Layout
842 Also contains some scripts used by \SpecialChar LyX
846 \begin_layout Labeling
847 \labelwidthstring 00.00.0000
848 \begin_inset Flex Code
851 \begin_layout Plain Layout
857 contains the standard \SpecialChar LyX
858 template files described in
859 \begin_inset CommandInset ref
861 reference "subsec:Creating-Templates"
868 \begin_layout Labeling
869 \labelwidthstring 00.00.0000
870 \begin_inset Flex Code
873 \begin_layout Plain Layout
879 contains files with the extension
880 \begin_inset Flex Code
883 \begin_layout Plain Layout
889 that define the user interface to \SpecialChar LyX
891 That is, the files define which items appear in which menus and the items
892 appearing on the toolbar.
895 \begin_layout Subsection
896 Files you don't want to modify
899 \begin_layout Standard
900 These files are used internally by \SpecialChar LyX
901 and you generally do not need to modify
902 them unless you are a developer.
905 \begin_layout Labeling
906 \labelwidthstring 00.00.0000
907 \begin_inset Flex Code
910 \begin_layout Plain Layout
916 this file contains the list of \SpecialChar LyX
918 The contents are displayed with the menu entry
919 \begin_inset Flex MenuItem
922 \begin_layout Plain Layout
923 Help\SpecialChar menuseparator
936 \begin_layout Labeling
937 \labelwidthstring 00.00.0000
938 \begin_inset Flex Code
941 \begin_layout Plain Layout
947 this is a \SpecialChar LaTeX
948 script used during the configuration process.
952 \begin_layout Labeling
953 \labelwidthstring 00.00.0000
954 \begin_inset Flex Code
957 \begin_layout Plain Layout
963 this is a Python script that is used to re-configure \SpecialChar LyX
965 It creates configuration files in the directory it was run from.
968 \begin_layout Subsection
969 Other files needing a line or two
972 \begin_layout Labeling
973 \labelwidthstring 00.00.0000
974 \begin_inset Flex Code
977 \begin_layout Plain Layout
983 this contains tables describing how different character encodings can be
987 \begin_layout Labeling
988 \labelwidthstring 00.00.0000
989 \begin_inset Flex Code
992 \begin_layout Plain Layout
998 this file contains the templates available to the new
999 \begin_inset Flex MenuItem
1002 \begin_layout Plain Layout
1004 \begin_inset space ~
1013 \begin_inset CommandInset ref
1015 reference "chap:Including-External-Material"
1022 \begin_layout Labeling
1023 \labelwidthstring 00.00.0000
1024 \begin_inset Flex Code
1027 \begin_layout Plain Layout
1033 this file contains a list of all the languages currently supported by \SpecialChar LyX
1037 \begin_layout Labeling
1038 \labelwidthstring 00.00.0000
1039 \begin_inset Flex Code
1042 \begin_layout Plain Layout
1048 contains information about the supported fonts.
1051 \begin_layout Labeling
1052 \labelwidthstring 00.00.0000
1053 \begin_inset Flex Code
1056 \begin_layout Plain Layout
1062 this file contains translations for internationalized paragraph styles
1064 \begin_inset CommandInset ref
1066 reference "subsec:I18n"
1073 \begin_layout Labeling
1074 \labelwidthstring 00.00.0000
1075 \begin_inset Flex Code
1078 \begin_layout Plain Layout
1084 this file contains information about unicode-encoded glyphs and the way
1085 they are supported by \SpecialChar LyX
1086 via \SpecialChar LaTeX
1090 \begin_layout Section
1091 Your local configuration directory
1094 \begin_layout Standard
1095 Even if you are using \SpecialChar LyX
1096 as an unprivileged user, you might want to change
1098 configuration for your own use.
1100 \begin_inset Flex Code
1103 \begin_layout Plain Layout
1109 directory contains all your personal configuration files.
1110 This is the directory described as
1111 \begin_inset Quotes eld
1115 \begin_inset Quotes erd
1119 \begin_inset Flex MenuItem
1122 \begin_layout Plain Layout
1123 Help\SpecialChar menuseparator
1125 \begin_inset space ~
1134 This directory is used as a mirror of
1135 \begin_inset Flex Code
1138 \begin_layout Plain Layout
1144 , which means that every file in
1145 \begin_inset Flex Code
1148 \begin_layout Plain Layout
1154 is a replacement for the corresponding file in
1155 \begin_inset Flex Code
1158 \begin_layout Plain Layout
1165 Any configuration file described in the above sections can be placed either
1166 in the system-wide directory, in which case it will affect all users, or
1167 in your local directory for your own use.
1170 \begin_layout Standard
1171 To make things clearer, let's provide a few examples:
1174 \begin_layout Itemize
1175 The preferences set in the
1176 \begin_inset Flex MenuItem
1179 \begin_layout Plain Layout
1180 Tools\SpecialChar menuseparator
1186 dialog are saved to a file
1187 \begin_inset Flex Code
1190 \begin_layout Plain Layout
1197 \begin_inset Flex Code
1200 \begin_layout Plain Layout
1209 \begin_layout Itemize
1210 When you reconfigure using
1211 \begin_inset Flex MenuItem
1214 \begin_layout Plain Layout
1215 Tools\SpecialChar menuseparator
1223 \begin_inset Flex Code
1226 \begin_layout Plain Layout
1232 script, and the resulting files are written in your local configuration
1234 This means that any additional text class file that you might have added
1236 \begin_inset Flex Code
1239 \begin_layout Plain Layout
1245 will be added to the list of classes in the
1246 \begin_inset Flex MenuItem
1249 \begin_layout Plain Layout
1250 Document\SpecialChar menuseparator
1259 \begin_layout Itemize
1260 If you get some updated documentation from \SpecialChar LyX
1261 ftp site and cannot install
1262 it because you do not have sysadmin rights on your system, you can just
1264 \begin_inset Flex Code
1267 \begin_layout Plain Layout
1273 and the items in the
1274 \begin_inset Flex MenuItem
1277 \begin_layout Plain Layout
1283 menu will open them!
1286 \begin_layout Section
1287 Running \SpecialChar LyX
1288 with multiple configurations
1291 \begin_layout Standard
1292 The configuration freedom of the local configuration directory may not suffice
1293 if you want to have more than one configuration at your disposal.
1294 For example, you may want to be use different key bindings or printer settings
1296 You can achieve this by having several such directories.
1297 You then specify which directory to use at run-time.
1300 \begin_layout Standard
1301 Invoking \SpecialChar LyX
1302 with the command line switch
1303 \begin_inset Flex Code
1306 \begin_layout Plain Layout
1316 instructs the program to read the configuration from that directory, and
1317 not from the default directory.
1318 (You can determine the default directory by running \SpecialChar LyX
1320 \begin_inset Flex Code
1323 \begin_layout Plain Layout
1329 switch.) If the specified directory does not exist, \SpecialChar LyX
1331 for you, just like it does for the default directory on the first time
1332 you run the program.
1333 You can modify the configuration options in this additional user directory
1334 exactly as you would for the default directory.
1335 These directories are completely independent (but read on).
1336 Note that setting the environment variable
1337 \begin_inset Flex Code
1340 \begin_layout Plain Layout
1346 to some value has exactly the same effect.
1349 \begin_layout Standard
1350 Having several configurations also requires more maintenance: if you want
1351 to add a new layout to
1352 \begin_inset Flex Code
1355 \begin_layout Plain Layout
1361 which you want available from all your configurations, you must add it
1362 to each directory separately.
1363 You can avoid this with the following trick: after \SpecialChar LyX
1364 creates the additional
1365 directory, most of the subdirectories (see above) are empty.
1366 If you want the new configuration to mirror an existing one, replace the
1367 empty subdirectory with a symbolic link to the matching subdirectory in
1368 the existing configuration.
1370 \begin_inset Flex Code
1373 \begin_layout Plain Layout
1379 subdirectory, however, since it contains a file written by the configuration
1380 script (also accessible through
1381 \begin_inset Flex MenuItem
1384 \begin_layout Plain Layout
1385 Tools\SpecialChar menuseparator
1391 ) which is configuration-specific.
1394 \begin_layout Chapter
1395 The Preferences dialog
1398 \begin_layout Standard
1399 All options of the preferences dialog are described in the Appendix
1401 The Preferences Dialog
1408 For some options you might find here more details.
1411 \begin_layout Section
1413 \begin_inset CommandInset label
1422 \begin_layout Standard
1423 The first step is to define your file formats if they are not already defined.
1425 \begin_inset Flex MenuItem
1428 \begin_layout Plain Layout
1429 Tools\SpecialChar menuseparator
1437 \begin_inset Flex MenuItem
1440 \begin_layout Plain Layout
1441 File Handling\SpecialChar menuseparator
1448 \begin_inset Flex MenuItem
1451 \begin_layout Plain Layout
1457 button to define your new format.
1459 \begin_inset Flex MenuItem
1462 \begin_layout Plain Layout
1468 field contains the name used to identify the format in the GUI.
1470 \begin_inset Flex MenuItem
1473 \begin_layout Plain Layout
1479 is used to identify the format internally.
1480 You will also need to enter a file extension.
1481 These are all required.
1483 \begin_inset Flex MenuItem
1486 \begin_layout Plain Layout
1492 field is used to provide a keyboard shortcut on the menus.
1493 (For example, pressing
1494 \begin_inset Flex MenuItem
1497 \begin_layout Plain Layout
1504 \begin_inset Flex MenuItem
1507 \begin_layout Plain Layout
1508 Document\SpecialChar menuseparator
1509 View (Other Formats)\SpecialChar menuseparator
1518 \begin_layout Standard
1520 \begin_inset Flex MenuItem
1523 \begin_layout Plain Layout
1530 \begin_inset Flex MenuItem
1533 \begin_layout Plain Layout
1540 For example, you might want to use
1541 \begin_inset Flex MenuItem
1544 \begin_layout Plain Layout
1550 to view PostScript files.
1551 You can enter the command needed to start the program in the corresponding
1553 In defining this command, you can use the four variables listed in the
1555 The viewer is launched when you view an image in \SpecialChar LyX
1557 \begin_inset Flex MenuItem
1560 \begin_layout Plain Layout
1561 Document\SpecialChar menuseparator
1568 The editor is for example launched when you right-click on an image and
1570 \begin_inset Flex MenuItem
1573 \begin_layout Plain Layout
1579 in the appearing context menu.
1582 \begin_layout Standard
1584 \begin_inset Flex MenuItem
1587 \begin_layout Plain Layout
1593 type of a format is optional, but if it is specified, it must be unique
1595 It is used to detect files of this format from the file contents.
1596 For some important file formats there is no MIME type officially registered
1598 \begin_inset CommandInset href
1601 target "http://www.iana.org/assignments/media-types/"
1606 Therefore \SpecialChar LyX
1607 uses the extended list of MIME types as specified by
1608 \begin_inset CommandInset href
1610 name "freedesktop.org"
1611 target "http://www.freedesktop.org/wiki/Specifications/shared-mime-info-spec"
1618 \begin_layout Standard
1620 \begin_inset Flex MenuItem
1623 \begin_layout Plain Layout
1629 option tells \SpecialChar LyX
1630 that a format is suitable for document export.
1631 If this is set and if a suitable conversion route exists (see
1632 \begin_inset CommandInset ref
1634 reference "sec:Converters"
1638 ), the format will appear in the
1639 \begin_inset Flex MenuItem
1642 \begin_layout Plain Layout
1643 File\SpecialChar menuseparator
1650 The format will also appear in the
1651 \begin_inset Flex MenuItem
1654 \begin_layout Plain Layout
1655 Document\SpecialChar menuseparator
1661 menu if a viewer is specified for the format.
1662 Pure image formats, such as
1663 \begin_inset Flex Code
1666 \begin_layout Plain Layout
1672 , should not use this option.
1673 Formats that can both represent vector graphics and documents like
1674 \begin_inset Flex Code
1677 \begin_layout Plain Layout
1686 \begin_layout Standard
1688 \begin_inset Flex MenuItem
1691 \begin_layout Plain Layout
1692 Vector graphics format
1697 tells \SpecialChar LyX
1698 that a format can contain vector graphics.
1699 This information is used to determine the target format of included graphics
1701 \begin_inset Flex MenuItem
1704 \begin_layout Plain Layout
1711 Included graphics may need to be converted to either
1712 \begin_inset Flex MenuItem
1715 \begin_layout Plain Layout
1722 \begin_inset Flex MenuItem
1725 \begin_layout Plain Layout
1732 \begin_inset Flex MenuItem
1735 \begin_layout Plain Layout
1742 \begin_inset Flex MenuItem
1745 \begin_layout Plain Layout
1751 cannot handle other image formats.
1752 If an included graphic is not already in
1753 \begin_inset Flex MenuItem
1756 \begin_layout Plain Layout
1763 \begin_inset Flex MenuItem
1766 \begin_layout Plain Layout
1773 \begin_inset Flex MenuItem
1776 \begin_layout Plain Layout
1782 format, it is converted to
1783 \begin_inset Flex MenuItem
1786 \begin_layout Plain Layout
1792 if the vector format option is set, and otherwise to
1793 \begin_inset Flex MenuItem
1796 \begin_layout Plain Layout
1805 \begin_layout Section
1809 \begin_layout Standard
1810 Since all conversions from one format to another take place in \SpecialChar LyX
1812 directory, it is sometimes necessary to modify a file before copying it
1813 to the temporary directory in order that the conversion may be performed.
1817 \begin_layout Plain Layout
1818 For example, the file may refer to other files—images, for example—using
1819 relative file names, and these may become invalid when the file is copied
1820 to the temporary directory.
1825 This is done by a Copier: It copies a file to (or from) the temporary directory
1826 and may modify it in the process.
1829 \begin_layout Standard
1830 The definitions of the copiers may use four variables:
1833 \begin_layout Labeling
1834 \labelwidthstring 00.00.0000
1835 \begin_inset Flex Code
1838 \begin_layout Plain Layout
1844 The \SpecialChar LyX
1845 system directory (e.
1846 \begin_inset space \thinspace{}
1850 \begin_inset space \space{}
1854 \begin_inset Flex MenuItem
1857 \begin_layout Plain Layout
1866 \begin_layout Labeling
1867 \labelwidthstring 00.00.0000
1868 \begin_inset Flex Code
1871 \begin_layout Plain Layout
1880 \begin_layout Labeling
1881 \labelwidthstring 00.00.0000
1882 \begin_inset Flex Code
1885 \begin_layout Plain Layout
1894 \begin_layout Labeling
1895 \labelwidthstring 00.00.0000
1896 \begin_inset Flex Code
1899 \begin_layout Plain Layout
1905 The base name (without filename extension) in the \SpecialChar LyX
1909 \begin_layout Labeling
1910 \labelwidthstring 00.00.0000
1911 \begin_inset Flex Code
1914 \begin_layout Plain Layout
1920 The full directory path of the \SpecialChar LyX
1924 \begin_layout Labeling
1925 \labelwidthstring 00.00.0000
1926 \begin_inset Flex Code
1929 \begin_layout Plain Layout
1935 The full pathname to the original \SpecialChar LyX
1936 file being processed
1939 \begin_layout Labeling
1940 \labelwidthstring 00.00.0000
1941 \begin_inset Flex Code
1944 \begin_layout Plain Layout
1950 The filename (without any directory path) of the \SpecialChar LyX
1954 \begin_layout Labeling
1955 \labelwidthstring 00.00.0000
1956 \begin_inset Flex Code
1959 \begin_layout Plain Layout
1965 The `\SpecialChar LaTeX
1969 \begin_layout Standard
1970 The latter should be the filename as it would be used in a \SpecialChar LaTeX
1978 It is relevant only when exporting files suitable for such inclusion.
1981 \begin_layout Standard
1982 Copiers can be used to do almost anything with output files.
1983 For example, suppose you want generated pdf files to be copied to a special
1985 \begin_inset Flex Code
1988 \begin_layout Plain Layout
1995 Then you could write a shell script such as this one:
1998 \begin_layout Standard
1999 \begin_inset listings
2003 \begin_layout Plain Layout
2008 \begin_layout Plain Layout
2013 \begin_layout Plain Layout
2015 TOFILE=`basename $2`
2018 \begin_layout Plain Layout
2020 cp $FROMFILE /home/you/pdf/$TOFILE
2025 Save it in your local \SpecialChar LyX
2027 \begin_inset Flex Code
2030 \begin_layout Plain Layout
2031 /home/you/.lyx/scripts/pdfcopier.sh
2036 —and make it executable, if you need to do so on your platform.
2038 \begin_inset Flex MenuItem
2041 \begin_layout Plain Layout
2042 Tools\SpecialChar menuseparator
2048 dialog, select under
2049 \begin_inset Flex MenuItem
2052 \begin_layout Plain Layout
2053 File Handling\SpecialChar menuseparator
2060 \begin_inset Flex MenuItem
2063 \begin_layout Plain Layout
2069 format—or one of the other pdf formats—and enter
2070 \begin_inset Flex Code
2073 \begin_layout Plain Layout
2074 pdfcopier.sh $$i $$o
2080 \begin_inset Flex MenuItem
2083 \begin_layout Plain Layout
2093 \begin_layout Standard
2094 Copiers are used by \SpecialChar LyX
2095 in various of its own conversions.
2096 For example, if appropriate programs are found, \SpecialChar LyX
2097 will automatically install
2099 \begin_inset Flex MenuItem
2102 \begin_layout Plain Layout
2109 \begin_inset Flex MenuItem
2112 \begin_layout Plain Layout
2114 \begin_inset space ~
2123 When these formats are exported, the copier sees that not just the main
2124 HTML file but various associated files (style files, images, etc.) are also
2126 All these files are written to a subdirectory of the directory in which
2127 the original \SpecialChar LyX
2132 \begin_layout Plain Layout
2133 This copier can be customized.
2135 \begin_inset Quotes eld
2139 \begin_inset Quotes erd
2142 argument takes a comma-separated list of extensions to be copied; if it
2143 is omitted, all files will be copied.
2145 \begin_inset Quotes eld
2149 \begin_inset Quotes erd
2152 argument determines the extension added to the generated directory.
2154 \begin_inset Quotes eld
2158 \begin_inset Flex MenuItem
2161 \begin_layout Plain Layout
2168 \begin_inset Quotes erd
2171 , so HTML generated from
2172 \begin_inset Flex MenuItem
2175 \begin_layout Plain Layout
2176 /path/to/filename.lyx
2182 \begin_inset Flex MenuItem
2185 \begin_layout Plain Layout
2186 /path/to/filename.html.LyXconv
2200 \begin_layout Section
2202 \begin_inset CommandInset label
2204 name "sec:Converters"
2211 \begin_layout Standard
2212 You can define your own Converters to convert files between different formats.
2214 \begin_inset Flex MenuItem
2217 \begin_layout Plain Layout
2218 Tools\SpecialChar menuseparator
2219 Preferences\SpecialChar menuseparator
2220 File Handling\SpecialChar menuseparator
2229 \begin_layout Standard
2230 To define a new converter, select the
2231 \begin_inset Flex MenuItem
2234 \begin_layout Plain Layout
2236 \begin_inset space ~
2245 \begin_inset Flex MenuItem
2248 \begin_layout Plain Layout
2250 \begin_inset space ~
2258 from the drop-down lists, enter the command needed for the conversion,
2260 \begin_inset Flex MenuItem
2263 \begin_layout Plain Layout
2270 Several variables can be used in the definition of converters:
2273 \begin_layout Labeling
2274 \labelwidthstring 00.00.0000
2275 \begin_inset Flex Code
2278 \begin_layout Plain Layout
2284 The \SpecialChar LyX
2288 \begin_layout Labeling
2289 \labelwidthstring 00.00.0000
2290 \begin_inset Flex Code
2293 \begin_layout Plain Layout
2302 \begin_layout Labeling
2303 \labelwidthstring 00.00.0000
2304 \begin_inset Flex Code
2307 \begin_layout Plain Layout
2316 \begin_layout Labeling
2317 \labelwidthstring 00.00.0000
2318 \begin_inset Flex Code
2321 \begin_layout Plain Layout
2327 The base filename of the input file (i.
2328 \begin_inset space \thinspace{}
2331 g., without the extension)
2334 \begin_layout Labeling
2335 \labelwidthstring 00.00.0000
2336 \begin_inset Flex Code
2339 \begin_layout Plain Layout
2345 The path to the input file
2348 \begin_layout Labeling
2349 \labelwidthstring 00.00.0000
2350 \begin_inset Flex Code
2353 \begin_layout Plain Layout
2359 The path to the original input file (this is different from $$p when a
2360 chain of converters is called)
2363 \begin_layout Labeling
2364 \labelwidthstring 00.00.0000
2365 \begin_inset Flex Code
2368 \begin_layout Plain Layout
2374 The iconv name for the encoding of the document.
2377 \begin_layout Standard
2379 \begin_inset Flex MenuItem
2382 \begin_layout Plain Layout
2384 \begin_inset space ~
2392 field you can enter the following flags, separated by commas:
2395 \begin_layout Labeling
2396 \labelwidthstring 00.00.0000
2397 \begin_inset Flex Code
2400 \begin_layout Plain Layout
2406 This converter runs some form of \SpecialChar LaTeX
2408 This will make \SpecialChar LyX
2409 's \SpecialChar LaTeX
2410 error logs available.
2413 \begin_layout Labeling
2414 \labelwidthstring 00.00.0000
2415 \begin_inset Flex Code
2418 \begin_layout Plain Layout
2424 Needs the \SpecialChar LaTeX
2426 \begin_inset Flex MenuItem
2429 \begin_layout Plain Layout
2435 file for the conversion.
2438 \begin_layout Labeling
2439 \labelwidthstring 00.00.0000
2440 \begin_inset Flex Code
2443 \begin_layout Plain Layout
2450 \begin_inset Quotes eld
2454 \begin_inset Quotes erd
2457 file from the backend, which in practice means a \SpecialChar LaTeX
2458 file like the one we
2459 would export, without
2460 \begin_inset Flex Code
2463 \begin_layout Plain Layout
2472 \begin_layout Labeling
2473 \labelwidthstring 00.00.0000
2474 \begin_inset Flex Code
2477 \begin_layout Plain Layout
2486 \begin_layout Standard
2487 The following three flags are not really flags at all because they take
2489 \begin_inset Flex MenuItem
2492 \begin_layout Plain Layout
2494 \begin_inset space ~
2498 \begin_inset space ~
2509 \begin_layout Labeling
2510 \labelwidthstring 00.00.0000
2511 \begin_inset Flex Code
2514 \begin_layout Plain Layout
2520 If set, the converter's standard error will be redirected to a file
2521 \begin_inset Flex Code
2524 \begin_layout Plain Layout
2530 , and the script given as argument will be run as:
2531 \begin_inset Flex Code
2534 \begin_layout Plain Layout
2535 script < infile.out > infile.log
2541 The argument may contain
2542 \begin_inset Flex Code
2545 \begin_layout Plain Layout
2554 \begin_layout Labeling
2555 \labelwidthstring 00.00.0000
2556 \begin_inset Flex Code
2559 \begin_layout Plain Layout
2565 The name of the directory in which the converter will dump the generated
2568 will not create this directory, and it does not copy anything into it,
2569 though it will copy this directory to the destination.
2570 The argument may contain
2571 \begin_inset Flex Code
2574 \begin_layout Plain Layout
2580 , which will be replaced by the base name of the input and output files,
2581 respectively, when the directory is copied.
2582 \begin_inset Newline newline
2585 Note that resultdir and usetempdir make no sense together.
2586 The latter will be ignored if the former is given.
2589 \begin_layout Labeling
2590 \labelwidthstring 00.00.0000
2591 \begin_inset Flex Code
2594 \begin_layout Plain Layout
2600 Determines the output file name and may, contain
2601 \begin_inset Flex Code
2604 \begin_layout Plain Layout
2611 Sensible only with resultdir and optional even then; if not given, it defaults
2615 \begin_layout Standard
2616 None of these last three are presently used in any of the converters that
2617 are installed with \SpecialChar LyX
2622 \begin_layout Standard
2623 You do not have to define converters for all formats between which you want
2625 For example, you will note that there is no `\SpecialChar LyX
2626 to PostScript' converter,
2627 but \SpecialChar LyX
2628 will export PostScript.
2629 It does so by first creating a \SpecialChar LaTeX
2630 file (no converter needs to be defined
2631 for this) which is then converted to DVI using the `\SpecialChar LaTeX
2633 and finally converting the resulting DVI file to PostScript.
2635 finds such `chains' of converters automatically, and it will always choose
2636 the shortest possible chain.
2637 You can, though, still define multiple conversion methods between file
2639 For example, the standard \SpecialChar LyX
2640 configuration provides five ways to convert
2645 \begin_layout Enumerate
2647 \begin_inset Flex MenuItem
2650 \begin_layout Plain Layout
2659 \begin_layout Enumerate
2660 via (DVI and) PostScript, using
2661 \begin_inset Flex MenuItem
2664 \begin_layout Plain Layout
2673 \begin_layout Enumerate
2675 \begin_inset Flex MenuItem
2678 \begin_layout Plain Layout
2687 \begin_layout Enumerate
2689 \begin_inset Flex MenuItem
2692 \begin_layout Plain Layout
2702 \begin_layout Enumerate
2704 \begin_inset Flex MenuItem
2707 \begin_layout Plain Layout
2717 \begin_layout Standard
2718 To define such alternate chains, you must define multiple target `file formats',
2720 \begin_inset CommandInset ref
2722 reference "sec:Formats"
2727 For example, in the standard configuration, the formats named
2728 \begin_inset Flex MenuItem
2731 \begin_layout Plain Layout
2738 \begin_inset Flex MenuItem
2741 \begin_layout Plain Layout
2748 \begin_inset Flex MenuItem
2751 \begin_layout Plain Layout
2758 \begin_inset Flex MenuItem
2761 \begin_layout Plain Layout
2768 \begin_inset Flex MenuItem
2771 \begin_layout Plain Layout
2778 \begin_inset Flex MenuItem
2781 \begin_layout Plain Layout
2788 \begin_inset Flex MenuItem
2791 \begin_layout Plain Layout
2798 \begin_inset Flex MenuItem
2801 \begin_layout Plain Layout
2809 \begin_inset Flex MenuItem
2812 \begin_layout Plain Layout
2819 \begin_inset Flex MenuItem
2822 \begin_layout Plain Layout
2829 ) are defined, all of which share the extension
2830 \begin_inset Flex MenuItem
2833 \begin_layout Plain Layout
2839 , and which correspond to the conversion methods just mentioned.
2842 \begin_layout Chapter
2843 Internationalizing \SpecialChar LyX
2845 \begin_inset CommandInset label
2847 name "cha:Internationalizing-LyX"
2854 \begin_layout Standard
2856 supports using a translated interface.
2857 Last time we checked, \SpecialChar LyX
2858 provided text in thirty languages.
2859 The language of choice is called your
2864 (For further reading on locale settings, see also the documentation for
2865 locale that comes with your operating system.
2866 For Linux, the manual page for
2867 \begin_inset Flex Code
2870 \begin_layout Plain Layout
2876 could be a good place to start).
2879 \begin_layout Standard
2880 Notice that these translations will work, but do contain a few flaws.
2881 In particular, all dialogs have been designed with the English text in
2882 mind, which means that some of the translated text will be too large to
2883 fit within the space allocated.
2884 This is only a display problem and will not cause any harm.
2885 Also, you will find that some of the translations do not define shortcut
2886 keys for everything.
2887 Sometimes, there are simply not enough free letters to do it.
2888 Other times, the translator just hasn't got around to doing it yet.
2889 Our localization team, which you may wish to join,
2893 \begin_layout Plain Layout
2894 If you are a fluent speaker of a language other than English, joining these
2895 teams is a great way to give back to the \SpecialChar LyX
2901 will of course try to fix these shortcomings in future versions of \SpecialChar LyX
2905 \begin_layout Section
2906 Translating \SpecialChar LyX
2910 \begin_layout Subsection
2911 Translating the graphical user interface (text messages).
2914 \begin_layout Standard
2917 \begin_inset Flex Code
2920 \begin_layout Plain Layout
2926 library to handle the internationalization of the interface.
2927 To have \SpecialChar LyX
2928 speak your favorite language in all menus and dialogs, you need
2930 \begin_inset Flex Code
2933 \begin_layout Plain Layout
2939 -file for that language.
2940 When this is available, you'll have to generate a
2941 \begin_inset Flex Code
2944 \begin_layout Plain Layout
2950 -file from it and install the
2951 \begin_inset Flex Code
2954 \begin_layout Plain Layout
2961 The process of doing all of this is explained in the documentation for
2963 \begin_inset Flex Code
2966 \begin_layout Plain Layout
2973 It is possible to do this just for yourself, but if you're going to do
2974 it, you might as well share the results of your labors with the rest of
2975 the \SpecialChar LyX
2977 Send a message to the \SpecialChar LyX
2978 developers' list for more information about how
2982 \begin_layout Standard
2983 In short, this is what you should do (xx denotes the language code):
2986 \begin_layout Itemize
2987 Check out the \SpecialChar LyX
2990 \begin_inset CommandInset href
2992 name "information on the web"
2993 target "http://www.lyx.org/HowToUseSVN"
3000 \begin_layout Itemize
3002 \begin_inset Flex Code
3005 \begin_layout Plain Layout
3011 to the folder of the
3012 \begin_inset Flex Code
3015 \begin_layout Plain Layout
3023 \begin_inset Flex Code
3026 \begin_layout Plain Layout
3034 \begin_inset Flex Code
3037 \begin_layout Plain Layout
3043 doesn't exist anywhere, it can be remade with the console command
3044 \begin_inset Flex Code
3047 \begin_layout Plain Layout
3053 in that directory, or you can use an existing po-file for some other language
3057 \begin_layout Itemize
3059 \begin_inset Flex Code
3062 \begin_layout Plain Layout
3072 \begin_layout Plain Layout
3073 This is just a text file, so it can be edited in any text editor.
3074 But there are also specialized programs that support such editing, such
3079 (for all platforms) or
3088 contains a `mode' for editing
3089 \begin_inset Flex Code
3092 \begin_layout Plain Layout
3103 For some menu- and widget-labels, there are also shortcut keys that should
3105 Those keys are marked after a `|', and should be translated according to
3106 the words and phrases of the language.
3107 You should also fill also out the information at the beginning of the new
3109 \begin_inset Flex Code
3112 \begin_layout Plain Layout
3118 -file with your email-address, etc., so people know where to reach you with
3119 suggestions and entertaining flames.
3122 \begin_layout Standard
3123 If you are just doing this on your own, then:
3126 \begin_layout Itemize
3128 \begin_inset Flex Code
3131 \begin_layout Plain Layout
3138 This can be done with
3139 \begin_inset Flex Code
3142 \begin_layout Plain Layout
3143 msgfmt -o xx.mo < xx.po
3151 \begin_layout Itemize
3153 \begin_inset Flex Code
3156 \begin_layout Plain Layout
3162 -file to your locale-tree, at the correct directory for application messages
3167 xx, and under the name
3168 \begin_inset Flex Code
3171 \begin_layout Plain Layout
3178 \begin_inset space \thinspace{}
3182 \begin_inset space \space{}
3186 \begin_inset Flex Code
3189 \begin_layout Plain Layout
3190 /usr/local/share/locale/xx/LC_MESSAGES/lyx.mo
3200 \begin_layout Standard
3201 As said, however, it would be best if the new
3202 \begin_inset Flex Code
3205 \begin_layout Plain Layout
3211 file could be added to the \SpecialChar LyX
3212 distribution, so others can use it.
3213 Adding it involves making additional changes to \SpecialChar LyX
3215 So send an email to the developers' mailing list if you're interested in
3219 \begin_layout Subsubsection
3223 \begin_layout Standard
3224 Sometimes it turns out that one English message needs to be translated into
3225 different messages in the target language.
3226 One example is the message
3227 \begin_inset Flex Code
3230 \begin_layout Plain Layout
3236 which has the German translation
3244 , depending upon exactly what the English
3245 \begin_inset Quotes eld
3249 \begin_inset Quotes erd
3254 \begin_inset Flex Code
3257 \begin_layout Plain Layout
3263 does not handle such ambiguous translations.
3264 Therefore you have to add some context information to the message: Instead
3266 \begin_inset Flex Code
3269 \begin_layout Plain Layout
3276 \begin_inset Flex Code
3279 \begin_layout Plain Layout
3280 To[[as in 'From format x to format y']]
3286 \begin_inset Flex Code
3289 \begin_layout Plain Layout
3290 To[[as in 'From page x to page y']].
3295 Now the two occurrences of
3296 \begin_inset Flex Code
3299 \begin_layout Plain Layout
3306 \begin_inset Flex Code
3309 \begin_layout Plain Layout
3315 and can be translated correctly to
3326 \begin_layout Standard
3327 Of course the context information needs to be stripped off the original
3328 message when no translation is used.
3329 Therefore you have to put it in double square brackets at the end of the
3330 message (see the example above).
3331 The translation mechanism of \SpecialChar LyX
3332 ensures that everything in double square
3333 brackets at the end of messages is removed before displaying the message.
3336 \begin_layout Subsection
3337 Translating the documentation.
3340 \begin_layout Standard
3341 The online documentation (in the
3342 \begin_inset Flex MenuItem
3345 \begin_layout Plain Layout
3351 -menu) can (and should!) be translated.
3352 If there are translated versions of the documentation available
3356 \begin_layout Plain Layout
3357 As of March 2008, at least some of the documents have been translated into
3358 fourteen languages, with the Tutorial available in a few more.
3363 and the locale is set accordingly, these will be used automagically by
3367 looks for translated versions as
3368 \begin_inset Flex Code
3371 \begin_layout Plain Layout
3372 LyXDir/doc/xx/DocName.lyx
3378 \begin_inset Flex Code
3381 \begin_layout Plain Layout
3387 is the code for the language currently in use.
3388 If there are no translated documents, the default English versions will
3390 Note that the translated versions must have the same filenames (
3391 \begin_inset Flex Code
3394 \begin_layout Plain Layout
3400 above) as the original.
3401 If you feel up to translating the documentation (an excellent way to proof-read
3402 the original documentation by the way!), there are a few things you should
3406 \begin_layout Itemize
3407 Check out the documentation translation web page at
3408 \begin_inset CommandInset href
3410 name "http://www.lyx.org/Translation"
3411 target "http://www.lyx.org/Translation"
3416 That way, you can find out which (if any) documents have already been translate
3417 d into your language.
3418 You can also find out who (if anyone) is organizing the effort to translate
3419 the documentation into your language.
3420 If no one is organizing the effort, please let us know that you're interested.
3423 \begin_layout Standard
3424 Once you get to actually translating, here's a few hints for you that may
3428 \begin_layout Itemize
3429 Join the documentation team! There is information on how to do that in
3430 \begin_inset Flex Code
3433 \begin_layout Plain Layout
3440 \begin_inset Flex MenuItem
3443 \begin_layout Plain Layout
3444 Help\SpecialChar menuseparator
3450 ), which by the way is the first document you should translate.
3453 \begin_layout Itemize
3454 Learn the typographic conventions for the language you are translating to.
3455 Typography is an ancient art and over the centuries, a great variety of
3456 conventions have developed throughout different parts of the world.
3457 Also study the professional terminology amongst typographers in your country.
3458 Inventing your own terminology will only confuse the users.
3461 (Warning! Typography is addictive!)
3464 \begin_layout Itemize
3465 Make a copy of the document.
3466 This will be your working copy.
3467 You can use this as your personal translated help-file by placing it in
3469 \begin_inset Flex Code
3472 \begin_layout Plain Layout
3481 \begin_layout Itemize
3482 Sometimes the original document (from the \SpecialChar LyX
3483 team) will be updated.
3484 Use the source viewer at
3485 \begin_inset CommandInset href
3487 name "http://www.lyx.org/trac/timeline"
3488 target "http://www.lyx.org/trac/timeline"
3492 to see what has been changed.
3493 That way you can easily see which parts of the translated document need
3497 \begin_layout Standard
3498 If you ever find an error in the original document, fix it and notify the
3499 rest of the documentation team of the changes! (You didn't forget to join
3500 the documentation team, did you?)
3503 \begin_layout Standard
3504 \begin_inset Branch OutDated
3507 \begin_layout Section
3508 International Keyboard Support
3511 \begin_layout Standard
3514 [Editor's Note: The following section is by
3522 It needs to be fixed to conform to the new Documentation Style sheet and
3523 to make use of the new v1.0 features.
3524 The whole thing also needs to be merged with the section following it.-jw
3525 It may also be badly out of date.-rh (2008)]
3528 \begin_layout Subsection
3529 Defining Own Keymaps: Keymap File Format
3532 \begin_layout Standard
3533 Let's look at a keyboard definition file a little closer.
3534 It is a plain text file defining
3537 \begin_layout Itemize
3538 key-to-key or key-to-string translations
3541 \begin_layout Itemize
3545 \begin_layout Itemize
3546 dead keys exceptions
3549 \begin_layout Standard
3550 To define key-to-key or key-to-string translation, use this command:
3553 \begin_layout Quotation
3554 \begin_inset Flex Code
3557 \begin_layout Plain Layout
3566 \begin_inset Flex Code
3569 \begin_layout Plain Layout
3578 \begin_layout Standard
3580 \begin_inset Flex Code
3583 \begin_layout Plain Layout
3589 is the key to be translated and
3590 \begin_inset Flex Code
3593 \begin_layout Plain Layout
3599 is the string to be inserted into the document.
3600 To define dead keys, use:
3603 \begin_layout Quotation
3604 \begin_inset Flex Code
3607 \begin_layout Plain Layout
3616 \begin_inset Flex Code
3619 \begin_layout Plain Layout
3628 \begin_layout Standard
3630 \begin_inset Flex Code
3633 \begin_layout Plain Layout
3639 is a keyboard key and
3640 \begin_inset Flex Code
3643 \begin_layout Plain Layout
3650 The following dead keys are supported (shortcut name is in parentheses):
3653 \begin_layout Quotation
3657 \begin_inset space \hfill{}
3663 \begin_layout Quotation
3665 \begin_inset space \hfill{}
3671 \begin_layout Quotation
3673 \begin_inset space \hfill{}
3679 \begin_layout Quotation
3681 \begin_inset space \hfill{}
3687 \begin_layout Quotation
3689 \begin_inset space \hfill{}
3695 \begin_layout Quotation
3697 \begin_inset space \hfill{}
3704 \begin_layout Plain Layout
3716 \begin_layout Quotation
3718 \begin_inset space \hfill{}
3724 \begin_layout Quotation
3726 \begin_inset space \hfill{}
3733 \begin_layout Plain Layout
3745 \begin_layout Quotation
3747 \begin_inset space \hfill{}
3753 \begin_layout Quotation
3755 \begin_inset space \hfill{}
3761 \begin_layout Quotation
3763 \begin_inset space \hfill{}
3770 \begin_layout Plain Layout
3782 \begin_layout Quotation
3784 \begin_inset space \hfill{}
3791 \begin_layout Plain Layout
3803 \begin_layout Quotation
3805 \begin_inset space \hfill{}
3811 \begin_layout Quotation
3812 hungarian umlaut (hug)
3813 \begin_inset space \hfill{}
3819 \begin_layout Quotation
3821 \begin_inset space \hfill{}
3827 \begin_layout Quotation
3829 \begin_inset space \hfill{}
3836 \begin_layout Plain Layout
3848 \begin_layout Standard
3849 Since in many international keyboards there are exceptions to what some
3850 dead keys should do, you can define them using
3853 \begin_layout Quotation
3854 \begin_inset Flex Code
3857 \begin_layout Plain Layout
3865 deadkey key outstring
3868 \begin_layout Standard
3869 For example, on Slovak keyboard, if you enter caron-o, it generates circumflex-o
3873 \begin_layout Quotation
3874 \begin_inset Flex Code
3877 \begin_layout Plain Layout
3890 \begin_layout Standard
3891 to make it work correctly.
3892 Also, you have to define as exceptions dead keys over i and j, to remove
3893 the dot from them before inserting an accent mark.
3894 I will change this when the time comes, but so far I haven't had time.
3897 \begin_layout Standard
3898 Oh, and about characters: backslash is escaped, so to enter it, you'll need
3901 \begin_inset Flex Code
3904 \begin_layout Plain Layout
3910 have different meaning.
3912 \begin_inset Flex Code
3915 \begin_layout Plain Layout
3921 marks comments, quotes start and end \SpecialChar LaTeX
3923 To enter quote, you'll need to use
3924 \begin_inset Flex Code
3927 \begin_layout Plain Layout
3936 \begin_inset Flex Code
3939 \begin_layout Plain Layout
3946 \begin_inset Flex Code
3949 \begin_layout Plain Layout
3960 \begin_layout Standard
3961 If you make a keyboard description file that works for your language, please
3962 mail it to me, so I can include it in the next keymap distribution.
3965 \begin_layout Standard
3966 More keywords will be supported in keymap configuration file in future,
3970 \begin_layout Itemize
3971 \begin_inset Flex Code
3974 \begin_layout Plain Layout
3985 \begin_inset space \hfill{}
3989 \begin_inset Flex Code
3992 \begin_layout Plain Layout
4001 \begin_layout Itemize
4002 \begin_inset Flex Code
4005 \begin_layout Plain Layout
4016 \begin_inset space \hfill{}
4020 \begin_inset Flex Code
4023 \begin_layout Plain Layout
4029 an external keymap translation program
4032 \begin_layout Standard
4033 Also, it should look into
4034 \begin_inset Flex Code
4037 \begin_layout Plain Layout
4043 file for defaults, too (for example, a
4044 \begin_inset Flex Code
4047 \begin_layout Plain Layout
4055 option to include default keyboard).
4063 \begin_layout Section
4064 International Keymap Stuff
4065 \begin_inset CommandInset label
4067 name "sec:International-Keymap-Stuff"
4074 \begin_layout Standard
4075 \begin_inset Note Note
4078 \begin_layout Plain Layout
4079 In doing the revisions on this document in March 2008, I did not look over
4080 this stuff, as I do not understand it.
4081 It would be good if someone else could do so.
4090 \begin_layout Standard
4091 The next two sections describe the
4092 \begin_inset Flex Code
4095 \begin_layout Plain Layout
4104 \begin_inset Flex Code
4107 \begin_layout Plain Layout
4115 file syntax in detail.
4116 These sections should help you design your own key map if the ones provided
4117 do not meet your needs.
4120 \begin_layout Subsection
4124 \begin_layout Standard
4128 \begin_inset Flex Code
4131 \begin_layout Plain Layout
4137 file maps keystrokes to characters or strings.
4138 As the name suggests, it sets a keyboard mapping.
4140 \begin_inset Flex Code
4143 \begin_layout Plain Layout
4154 \begin_inset Flex Code
4157 \begin_layout Plain Layout
4172 \begin_inset Flex Code
4175 \begin_layout Plain Layout
4188 \begin_inset Flex Code
4191 \begin_layout Plain Layout
4200 \begin_inset Flex Code
4203 \begin_layout Plain Layout
4211 are described in this section.
4214 \begin_layout Labeling
4215 \labelwidthstring 00.00.0000
4216 \begin_inset Flex Code
4219 \begin_layout Plain Layout
4227 Map a character to a string
4230 \begin_layout LyX-Code
4245 \begin_layout Standard
4278 the double-quote (")
4295 must be escaped with a preceding backslash (
4306 \begin_layout Standard
4308 \begin_inset Flex MenuItem
4311 \begin_layout Plain Layout
4319 statement to cause the symbol
4320 \begin_inset Flex MenuItem
4323 \begin_layout Plain Layout
4331 to be output for the keystroke
4332 \begin_inset Flex MenuItem
4335 \begin_layout Plain Layout
4346 \begin_layout LyX-Code
4352 \begin_layout Labeling
4353 \labelwidthstring 00.00.0000
4354 \begin_inset Flex Code
4357 \begin_layout Plain Layout
4365 Specify an accent character
4368 \begin_layout LyX-Code
4377 \begin_layout Standard
4378 This will make the cha
4416 This is the dead key
4420 \begin_layout Plain Layout
4427 refers to a key that does not produce a character by itself, but when followed
4428 with another key, produces the desired accent character.
4429 For example, a German characte
4431 r with an umlaut like
4441 can be produced in this manner.
4450 \begin_layout Standard
4463 and then another key not in
4480 followed by the other, not allowed key, as output.
4484 \begin_inset Flex MenuItem
4487 \begin_layout Plain Layout
4495 cancels a dead key, so if
4506 \begin_inset Flex MenuItem
4509 \begin_layout Plain Layout
4518 , the cursor will not go one position backwards but will instead cancel
4534 might have had on the next keystroke.
4538 \begin_layout Standard
4539 The following example specifies that the character ' is to be an acute accent,
4540 allowed on the characters a, e, i, o, u, A, E, I, O, and U:
4543 \begin_layout LyX-Code
4546 kmod ' acute aeiouAEIOU
4549 \begin_layout Labeling
4550 \labelwidthstring 00.00.0000
4551 \begin_inset Flex Code
4554 \begin_layout Plain Layout
4560 Specify an exception to the accent character
4563 \begin_layout LyX-Code
4572 \begin_layout Standard
4573 This defines an exce
4614 have been assigned a keystroke with a previous
4617 \begin_inset Flex Code
4620 \begin_layout Plain Layout
4644 must not belong in the
4691 If such a declaration does not exist in
4699 \begin_inset Flex Code
4702 \begin_layout Plain Layout
4736 \begin_inset Flex Code
4739 \begin_layout Plain Layout
4753 \begin_layout Standard
4754 The following command produces causes äi to be produced when you enter acute-i
4758 \begin_layout LyX-Code
4772 \begin_layout Labeling
4773 \labelwidthstring 00.00.0000
4774 \begin_inset Flex Code
4777 \begin_layout Plain Layout
4783 Combine two accent characters
4786 \begin_layout LyX-Code
4792 accent1 accent2 allowed
4795 \begin_layout Standard
4796 This one is getting pretty esoteric.
4797 It allows you to combine the effect
4853 \begin_inset Flex Code
4856 \begin_layout Plain Layout
4884 \begin_layout Standard
4885 Consider this example from the
4886 \begin_inset Flex Code
4889 \begin_layout Plain Layout
4900 \begin_layout LyX-Code
4903 kmod ; acute aeioyvhAEIOYVH
4907 kcomb acute umlaut iyIY
4910 \begin_layout Standard
4911 This allows you to press
4912 \begin_inset Flex MenuItem
4915 \begin_layout Plain Layout
4923 and get the effect of
4924 \begin_inset Flex Code
4927 \begin_layout Plain Layout
4946 in this case cancels the last dead key, so if you press
4947 \begin_inset Flex MenuItem
4950 \begin_layout Plain Layout
4959 \begin_inset Flex Code
4962 \begin_layout Plain Layout
4975 \begin_layout Subsection
4979 \begin_layout Standard
4981 \begin_inset Flex Code
4984 \begin_layout Plain Layout
4992 mapping is performed, a
4993 \begin_inset Flex Code
4996 \begin_layout Plain Layout
5006 file maps the strings that the symbols generate to characters in the current
5008 The \SpecialChar LyX
5009 distribution currently includes at least the
5010 \begin_inset Flex Code
5013 \begin_layout Plain Layout
5022 \begin_inset Flex Code
5025 \begin_layout Plain Layout
5036 \begin_layout Standard
5038 \begin_inset Flex Code
5041 \begin_layout Plain Layout
5049 file is a sequence of declarations of the form
5052 \begin_layout LyX-Code
5065 \begin_layout Standard
5066 For example, in order to map
5067 \begin_inset Flex MenuItem
5070 \begin_layout Plain Layout
5080 to the corresponding character in the iso-8859-1 set (233), the following
5084 \begin_layout LyX-Code
5092 \begin_layout Standard
5094 \begin_inset Flex Code
5097 \begin_layout Plain Layout
5106 \begin_inset Flex Code
5109 \begin_layout Plain Layout
5127 the same character can apply to more than one string.
5129 \begin_inset Flex Code
5132 \begin_layout Plain Layout
5143 \begin_layout LyX-Code
5155 \begin_inset Newline newline
5171 \begin_layout Standard
5173 cannot find a mapping for the string produced by the keystroke or a
5174 deadkey sequence, it will check if it looks like an accented char and try
5175 to draw an accent over the character on screen.
5178 \begin_layout Subsection
5182 \begin_layout Standard
5183 There is a second way to add support for international characters through
5184 so-called dead-keys.
5185 A dead-key works in combination with a letter to produce an accented character.
5186 Here, we'll explain how to create a really simple dead-key to illustrate
5190 \begin_layout Standard
5191 Suppose you happen to need the circumflex character,
5192 \begin_inset Quotes eld
5196 \begin_inset Quotes erd
5201 \begin_inset Flex MenuItem
5204 \begin_layout Plain Layout
5211 \begin_inset space ~
5215 \begin_inset Flex MenuItem
5218 \begin_layout Plain Layout
5224 ] to the \SpecialChar LyX
5226 \begin_inset Flex Code
5229 \begin_layout Plain Layout
5236 \begin_inset Flex Code
5239 \begin_layout Plain Layout
5246 Now, whenever you type the
5247 \begin_inset Flex MenuItem
5250 \begin_layout Plain Layout
5256 -key followed by a letter, that letter will have a circumflex accent on
5258 For example, the sequence
5259 \begin_inset Quotes eld
5263 \begin_inset Flex MenuItem
5266 \begin_layout Plain Layout
5273 \begin_inset Quotes erd
5276 produces the letter:
5277 \begin_inset Quotes eld
5281 \begin_inset Quotes erd
5285 If you tried to type
5286 \begin_inset Quotes eld
5290 \begin_inset Flex MenuItem
5293 \begin_layout Plain Layout
5300 \begin_inset Quotes erd
5303 , however, \SpecialChar LyX
5304 will complain with a beep, since a
5305 \begin_inset Quotes eld
5309 \begin_inset Flex MenuItem
5312 \begin_layout Plain Layout
5319 \begin_inset Quotes erd
5322 never takes a circumflex accent.
5324 \begin_inset Flex MenuItem
5327 \begin_layout Plain Layout
5333 after a dead-key produces the bare-accent.
5334 Please note this last point! If you bind a key to a dead-key, you'll need
5335 to rebind the character on that key to yet another key.
5337 \begin_inset Flex MenuItem
5340 \begin_layout Plain Layout
5346 to a cedilla is a bad idea, since you'll only get cedillas instead of commas.
5349 \begin_layout Standard
5350 One common way to bind dead-keys is to use
5351 \begin_inset Flex MenuItem
5354 \begin_layout Plain Layout
5361 \begin_inset Flex MenuItem
5364 \begin_layout Plain Layout
5371 \begin_inset Flex MenuItem
5374 \begin_layout Plain Layout
5380 in combination with an accent, like
5381 \begin_inset Quotes eld
5385 \begin_inset Flex MenuItem
5388 \begin_layout Plain Layout
5395 \begin_inset Quotes erd
5399 \begin_inset Quotes eld
5403 \begin_inset Flex MenuItem
5406 \begin_layout Plain Layout
5413 \begin_inset Quotes erd
5417 \begin_inset Quotes eld
5421 \begin_inset Flex MenuItem
5424 \begin_layout Plain Layout
5431 \begin_inset Quotes erd
5435 Another way involves using
5436 \begin_inset Flex Code
5439 \begin_layout Plain Layout
5446 \begin_inset Flex Code
5449 \begin_layout Plain Layout
5455 to set up the special
5456 \begin_inset Flex Code
5459 \begin_layout Plain Layout
5467 \begin_inset Flex Code
5470 \begin_layout Plain Layout
5476 acts in some ways just like
5477 \begin_inset Flex MenuItem
5480 \begin_layout Plain Layout
5486 and permits you to bind keys to accented characters.
5487 You can also turn keys into dead-keys by binding them to something like
5489 \begin_inset Flex Code
5492 \begin_layout Plain Layout
5498 and then binding this symbolic key to the corresponding \SpecialChar LyX
5503 \begin_layout Plain Layout
5508 : This is exactly what I do in my
5509 \begin_inset Flex Code
5512 \begin_layout Plain Layout
5519 \begin_inset Flex Code
5522 \begin_layout Plain Layout
5530 \begin_inset Flex MenuItem
5533 \begin_layout Plain Layout
5535 \begin_inset space ~
5544 \begin_inset Flex Code
5547 \begin_layout Plain Layout
5553 and a bunch of these
5554 \begin_inset Quotes eld
5558 \begin_inset Flex Code
5561 \begin_layout Plain Layout
5568 \begin_inset Quotes erd
5571 symbolic keys bound such things as
5572 \begin_inset Flex MenuItem
5575 \begin_layout Plain Layout
5577 \begin_inset space ~
5586 \begin_inset Flex MenuItem
5589 \begin_layout Plain Layout
5591 \begin_inset space ~
5600 This is how I produce my accented characters.
5605 You can make just about anything into the
5606 \begin_inset Flex Code
5609 \begin_layout Plain Layout
5616 \begin_inset Flex MenuItem
5619 \begin_layout Plain Layout
5625 keys, a spare function key, etc.
5626 As for the \SpecialChar LyX
5627 commands that produce accents, check the entry for
5628 \begin_inset Flex Code
5631 \begin_layout Plain Layout
5642 You'll find the complete list there.
5645 \begin_layout Subsection
5646 Saving your Language Configuration
5649 \begin_layout Standard
5650 You can edit your preferences so that your desired language environment
5651 is automatically configured when \SpecialChar LyX
5653 \begin_inset Flex MenuItem
5656 \begin_layout Plain Layout
5657 Edit\SpecialChar menuseparator
5666 \begin_layout Chapter
5667 Installing New Document Classes, Layouts, and Templates
5668 \begin_inset CommandInset label
5670 name "cha:Installing-New-Document"
5675 \begin_inset Argument 1
5678 \begin_layout Plain Layout
5679 Installing New Document Classes
5687 \begin_layout Standard
5688 In this chapter, we describe the procedures for creating and installing
5689 new \SpecialChar LyX
5690 layout and template files, as well as offer a refresher on correctly
5691 installing new \SpecialChar LaTeX
5696 \begin_layout Standard
5697 First, let us a say a few words about how one ought to think about the relation
5698 between \SpecialChar LyX
5699 and \SpecialChar LaTeX
5701 The thing to understand is that, in a certain sense, \SpecialChar LyX
5702 doesn't know anything
5703 about \SpecialChar LaTeX
5705 Indeed, from \SpecialChar LyX
5706 's point of view, \SpecialChar LaTeX
5707 is just one of several
5708 \begin_inset Quotes eld
5712 \begin_inset Quotes erd
5715 in which it is capable of producing output.
5716 Other such formats are DocBook, plaintext, and XHTML.
5718 is, of course, a particularly important format, but very little of the
5719 information \SpecialChar LyX
5720 has about \SpecialChar LaTeX
5721 is actually contained in the program itself.
5725 \begin_layout Plain Layout
5726 Some commands are sufficiently complex that they are
5727 \begin_inset Quotes eld
5731 \begin_inset Quotes erd
5734 into \SpecialChar LyX
5736 But the developers generally regard this as a Bad Thing.
5741 Rather, that information, even for the standard classes like
5742 \begin_inset Flex Code
5745 \begin_layout Plain Layout
5751 , is contained in `layout files'.
5752 Similarly, \SpecialChar LyX
5753 itself does not know much about DocBook or XHTML.
5754 What it knows is contained in layout files.
5757 \begin_layout Standard
5758 You can think of the layout file for a given document class as a translation
5759 manual between \SpecialChar LyX
5760 constructs—paragraphs with their corresponding styles,
5761 certain sorts of insets, etc—and the corresponding \SpecialChar LaTeX
5764 Almost everything \SpecialChar LyX
5766 \begin_inset Flex Code
5769 \begin_layout Plain Layout
5775 , for example, is contained in the file
5776 \begin_inset Flex Code
5779 \begin_layout Plain Layout
5785 and in various other files it includes.
5786 For this reason, anyone intending to write layout files should plan to
5787 study the existing files.
5788 A good place to start is with
5789 \begin_inset Flex Code
5792 \begin_layout Plain Layout
5798 , which is included in
5799 \begin_inset Flex Code
5802 \begin_layout Plain Layout
5809 \begin_inset Flex Code
5812 \begin_layout Plain Layout
5818 , and many of the other layout files for document classes.
5819 This file is where sections and the like are defined:
5820 \begin_inset Flex Code
5823 \begin_layout Plain Layout
5829 tells \SpecialChar LyX
5830 how paragraphs that are marked with the Section, Subsection, etc,
5831 styles can be translated into corresponding \SpecialChar LaTeX
5832 , DocBook, and XHTML commands
5835 \begin_inset Flex Code
5838 \begin_layout Plain Layout
5844 file basically just includes several of these
5845 \begin_inset Flex Code
5848 \begin_layout Plain Layout
5857 \begin_layout Standard
5858 Defining the \SpecialChar LyX
5860 correspondence is not the only thing layout files do, though.
5861 Their other job is to define how the \SpecialChar LyX
5862 constructs themselves will appear
5864 The fact that layout files have these two jobs is often a source of confusion,
5865 because they are completely separate.
5866 Telling \SpecialChar LyX
5867 how to translate a certain paragraph style into \SpecialChar LaTeX
5870 how to display it; conversely, telling \SpecialChar LyX
5871 how to display a certain paragraph
5872 style does not tell \SpecialChar LyX
5873 how to translate it into \SpecialChar LaTeX
5874 (let alone tell \SpecialChar LaTeX
5877 So, in general, when you define a new \SpecialChar LyX
5878 construct, you must always do two
5879 quite separate things: (i)
5880 \begin_inset space ~
5883 tell \SpecialChar LyX
5884 how to translate it into \SpecialChar LaTeX
5886 \begin_inset space ~
5889 tell \SpecialChar LyX
5893 \begin_layout Standard
5894 Much the same is true, of course, as regards \SpecialChar LyX
5895 's other backend formats, though
5896 XHTML is in some ways different, because in that case \SpecialChar LyX
5901 able, to some extent, to use information about how it should display a
5902 paragraph on the screen to output information (in the form of CSS) about
5903 how the paragraph should be displayed in a browser.
5904 Even in this case, however, the distinction between what \SpecialChar LyX
5906 and how things are rendered externally remains in force, and the two can
5907 be controlled separately.
5909 \begin_inset CommandInset ref
5911 reference "sec:Tags-for-XHTML"
5918 \begin_layout Section
5919 Installing new \SpecialChar LaTeX
5923 \begin_layout Standard
5924 Some installations may not include a \SpecialChar LaTeX
5925 package or class file that you would
5926 like to use within \SpecialChar LyX
5928 For example, you might need Foil\SpecialChar TeX
5929 , a package for preparing slides for overhead
5931 Modern \SpecialChar LaTeX
5932 distributions like \SpecialChar TeX
5933 Live (2008 or newer) or MiK\SpecialChar TeX
5934 provide a user interface
5935 for installing such packages.
5936 For example, with MiK\SpecialChar TeX
5937 , you start the program
5938 \begin_inset Quotes eld
5942 \begin_inset space ~
5946 \begin_inset Quotes erd
5949 to get a list of available packages.
5950 To install one of them, right click on it or use the corresponding toolbar
5954 \begin_layout Standard
5955 If your \SpecialChar LaTeX
5956 distribution does not provide such a `package manager', or if the
5957 package is not available from your distribution, then follow these steps
5958 to install it manually:
5961 \begin_layout Enumerate
5962 Get the package from
5963 \begin_inset CommandInset href
5966 target "http://www.ctan.org/"
5973 \begin_layout Enumerate
5974 If the package contains a file with the ending
5975 \begin_inset Quotes eld
5979 \begin_inset Flex Code
5982 \begin_layout Plain Layout
5989 \begin_inset Quotes erd
5992 (is the case for Foil\SpecialChar TeX
5993 ) then open a console, change to the folder of this
5994 file and execute the command
5995 \begin_inset Flex Code
5998 \begin_layout Plain Layout
6005 You have now unpacked the package and have all files to install it.
6006 Most \SpecialChar LaTeX
6007 -packages are not packed and you can skip this step.
6010 \begin_layout Enumerate
6011 Now you need to decide if the package should be available for all users
6013 \begin_inset Separator parbreak
6020 \begin_layout Enumerate
6021 On *nix systems (Linux, OSX, etc.), if you want the new package to be available
6022 for all users on your system, then install it in your `local' \SpecialChar TeX
6024 install it in your own `user' \SpecialChar TeX
6026 Where these trees should be created, if they do not already exist, depends
6028 To find this out, look in the file
6029 \begin_inset Flex Code
6032 \begin_layout Plain Layout
6042 \begin_layout Plain Layout
6043 This is usually in the directory
6044 \begin_inset Flex Code
6047 \begin_layout Plain Layout
6053 , though you can execute the command
6054 \begin_inset Flex Code
6057 \begin_layout Plain Layout
6068 The location of the `local' \SpecialChar TeX
6069 tree is defined by the
6070 \begin_inset Flex Code
6073 \begin_layout Plain Layout
6079 variable; this is usually somewhere like
6080 \begin_inset Flex Code
6083 \begin_layout Plain Layout
6084 /usr/local/share/texmf
6090 The location of the `user' \SpecialChar TeX
6092 \begin_inset Flex Code
6095 \begin_layout Plain Layout
6102 \begin_inset Flex Code
6105 \begin_layout Plain Layout
6112 (If these variables are not predefined, you have to define them.) You'll
6113 probably need root permissions to create or modify the `local' tree, but
6114 not for your `user' tree.
6115 \begin_inset Newline newline
6118 In general, it is recommended to install in the user tree because your user
6119 will not be modified or even overwritten when you upgrade your system.
6120 It will typically also be backed up together with everything else when
6121 you backup your home directory (which, of course, you do on a regular basis).
6124 \begin_layout Enumerate
6125 On Windows, if you want the new package to be available for all users on
6126 your system, change to the folder where \SpecialChar LaTeX
6127 is installed and then change to
6129 \begin_inset Flex Code
6132 \begin_layout Plain Layout
6143 (For MiK\SpecialChar TeX
6144 , this would be by default the folder
6145 \begin_inset Flex Code
6148 \begin_layout Plain Layout
6166 \begin_layout Plain Layout
6167 Note that this will be the correct path only on English installations.
6168 On a German one, it would be
6169 \begin_inset Flex Code
6172 \begin_layout Plain Layout
6186 , and similarly for other languages.
6191 Create there a new folder
6192 \begin_inset Flex Code
6195 \begin_layout Plain Layout
6201 and copy all files of the package into it.
6203 \begin_inset Newline newline
6206 If the package should only available for you or you don't have admin permissions
6207 , do the same, but in the local \SpecialChar LaTeX
6210 \begin_inset space \thinspace{}
6213 g., for MiK\SpecialChar TeX
6215 \begin_inset space ~
6218 2.8 under Windows XP, this would be the folder:
6219 \begin_inset Newline newline
6225 \begin_inset Flex Code
6228 \begin_layout Plain Layout
6231 Documents and Settings
6243 \begin_inset Newline newline
6249 \begin_inset Phantom HPhantom
6252 \begin_layout Plain Layout
6263 \begin_inset Flex Code
6266 \begin_layout Plain Layout
6279 \begin_inset Newline newline
6282 On Vista, it would be:
6283 \begin_inset Newline newline
6287 \begin_inset Flex Code
6290 \begin_layout Plain Layout
6316 \begin_layout Enumerate
6317 Now one only need to tell \SpecialChar LaTeX
6318 that there are new files.
6319 This depends on the used \SpecialChar LaTeX
6321 \begin_inset Separator parbreak
6328 \begin_layout Enumerate
6329 For \SpecialChar TeX
6330 Live execute the command
6331 \begin_inset Flex Code
6334 \begin_layout Plain Layout
6341 If you installed the package for all users, then you will probably need
6342 to have root permissions for that.
6345 \begin_layout Enumerate
6346 For MiK\SpecialChar TeX
6347 , if you have installed the package for all users, start the program
6349 \begin_inset Quotes eld
6353 \begin_inset space ~
6357 \begin_inset Quotes erd
6360 and press the button marked
6361 \begin_inset Quotes eld
6365 \begin_inset Quotes erd
6369 Otherwise start the program
6370 \begin_inset Quotes eld
6374 \begin_inset Quotes erd
6381 \begin_layout Enumerate
6382 Finally, you need to tell \SpecialChar LyX
6383 that there are new packages available.
6384 So, in \SpecialChar LyX
6386 \begin_inset Flex MenuItem
6389 \begin_layout Plain Layout
6392 \SpecialChar menuseparator
6398 and then restart \SpecialChar LyX
6402 \begin_layout Standard
6403 Now the package is installed.
6404 In our example, the document class
6405 \begin_inset Flex Code
6408 \begin_layout Plain Layout
6410 \begin_inset space ~
6418 will now be available under
6419 \begin_inset Flex MenuItem
6422 \begin_layout Plain Layout
6423 Document\SpecialChar menuseparator
6424 Settings\SpecialChar menuseparator
6434 \begin_layout Standard
6435 If you would like to use a \SpecialChar LaTeX
6436 document class that is not even listed in the
6438 \begin_inset Flex MenuItem
6441 \begin_layout Plain Layout
6442 Document\SpecialChar menuseparator
6443 Settings\SpecialChar menuseparator
6449 , then you need to create a `layout' file for it.
6450 That is the topic of the next section.
6453 \begin_layout Section
6454 Types of layout files
6457 \begin_layout Standard
6458 This section describes the various sorts of \SpecialChar LyX
6459 files that contain layout informati
6461 These files describe various paragraph and character styles, determining
6462 how \SpecialChar LyX
6463 should display them and how they should be translated into \SpecialChar LaTeX
6465 XHTML, or whatever output format is being used.
6469 \begin_layout Standard
6470 We shall try to provide a thorough description of the process of writing
6472 However, there are so many different types of documents supported even
6473 by just \SpecialChar LaTeX
6474 that we can't hope to cover every different possibility or problem
6475 you might encounter.
6476 The \SpecialChar LyX
6477 users' list is frequented by people with lots of experience with layout
6478 design who are willing to share what they've learned, so please feel free
6479 to ask questions there.
6482 \begin_layout Standard
6483 As you prepare to write a new layout, it is extremely helpful to look at
6484 the layouts distributed with \SpecialChar LyX
6486 If you write a \SpecialChar LyX
6487 layout for a \SpecialChar LaTeX
6488 document class that might also be used by
6489 others, or write a module that might be useful to others, then you should
6490 consider posting your layout to the
6491 \begin_inset CommandInset href
6493 name "layout section on the LyX wiki"
6494 target "http://wiki.lyx.org/Layouts/Layouts"
6498 or even to the \SpecialChar LyX
6499 developers' list, so that it might be included in \SpecialChar LyX
6504 \begin_layout Plain Layout
6505 Note that \SpecialChar LyX
6506 is licensed under the General Public License, so any material
6507 that is contributed to \SpecialChar LyX
6508 must be similarly licensed.
6516 \begin_layout Subsection
6518 \begin_inset CommandInset label
6520 name "subsec:Layout-modules"
6527 \begin_layout Standard
6528 We have spoken to this point about `layout files'.
6529 But there are different sorts of files that contain layout information.
6530 Layout files, strictly so called, have the
6531 \begin_inset Flex Code
6534 \begin_layout Plain Layout
6540 extension and provide \SpecialChar LyX
6541 with information about document classes.
6542 Since \SpecialChar LyX
6543 1.6 layout information can also be contained in layout
6548 \begin_inset Flex Code
6551 \begin_layout Plain Layout
6558 Modules are to \SpecialChar LaTeX
6559 packages much as layouts are to \SpecialChar LaTeX
6560 classes, and some modules—such
6562 \begin_inset Flex Code
6565 \begin_layout Plain Layout
6571 module—specifically provide support for one package.
6572 In a sense, layout modules are similar to included
6576 \begin_layout Plain Layout
6577 These can have any extension, but by convention have the
6578 \begin_inset Flex Code
6581 \begin_layout Plain Layout
6593 \begin_inset Flex Code
6596 \begin_layout Plain Layout
6602 —in that modules are not specific to a given document class but may be used
6603 with many different classes.
6604 The difference is that using an included file with
6605 \begin_inset Flex Code
6608 \begin_layout Plain Layout
6614 requires editing that file.
6615 Modules, by contrast, are selected in the
6616 \begin_inset Flex MenuItem
6619 \begin_layout Plain Layout
6620 Document\SpecialChar menuseparator
6629 \begin_layout Standard
6630 Building modules is the easiest way to get started with layout editing,
6631 since it can be as simple as adding a single new paragraph style or flex
6633 But modules may, in principle, contain anything a layout file can contain.
6636 \begin_layout Standard
6637 After creating a new module and copying it to the
6638 \begin_inset Flex Code
6641 \begin_layout Plain Layout
6647 folder, you will need to reconfigure and then restart \SpecialChar LyX
6650 However, changes you make to the module will be seen immediately, if you
6652 \begin_inset Flex MenuItem
6655 \begin_layout Plain Layout
6656 Document\SpecialChar menuseparator
6662 , highlight something, and then hit
6663 \begin_inset Quotes eld
6667 \begin_inset Quotes erd
6673 It is strongly recommended that you save your work before doing this
6678 it is strongly recommended that you not attempt to edit modules while simultaneo
6679 usly working on actual documents
6682 Though of course the developers strive to keep \SpecialChar LyX
6683 stable in such situations,
6684 syntax errors and the like in your module file could cause strange behavior.
6687 \begin_layout Subsubsection
6691 \begin_layout Standard
6692 Modules are to \SpecialChar LyX
6693 as packages are to \SpecialChar LaTeX
6695 Sometimes, however, you find yourself wanting a specific inset or character
6696 style just for one document and writing a module that will also be available
6697 to other documents makes little sense.
6698 What you need is \SpecialChar LyX
6700 \begin_inset Quotes eld
6704 \begin_inset Quotes erd
6710 \begin_layout Standard
6711 You will find it under
6713 Document\SpecialChar menuseparator
6714 Settings\SpecialChar menuseparator
6718 The large text box allows you to enter anything that you might enter in
6719 a layout file or module.
6720 You can think of a document's local layout, in fact, as a module that belongs
6722 So, in particular, you must enter a
6723 \begin_inset Flex Code
6726 \begin_layout Plain Layout
6733 Any format is acceptable, but one would normally use the format current
6735 (In \SpecialChar LyX
6736 2.1, the current layout format is 48.) You should be aware that local
6737 layout is not supported by versions of \SpecialChar LyX
6738 prior to 1.6, so you should not
6739 use it if you want to be able to export your document to \SpecialChar LyX
6741 (without, that is, losing the local layout information).
6742 If you wish to be able to export to 1.6—local layout is supported in 1.6,
6743 though there is no UI for it—then you should use format 11 and, of course,
6744 use only layout constructs that were available in \SpecialChar LyX
6748 \begin_layout Standard
6749 When you have entered something in the
6750 \begin_inset Flex Code
6753 \begin_layout Plain Layout
6759 pane, \SpecialChar LyX
6761 \begin_inset Quotes eld
6765 \begin_inset Quotes erd
6768 button at the bottom.
6769 Clicking this button will cause \SpecialChar LyX
6770 to determine whether what you have entered
6771 is valid layout information for the chosen format.
6773 will report the result but, unfortunately, will not tell you what errors
6774 there might have been.
6775 These will be written to the terminal, however, if \SpecialChar LyX
6776 is started from a terminal.
6777 You will not be permitted to save your local layout until you have entered
6781 \begin_layout Standard
6782 The warnings at the end of the previous section apply here, too.
6783 Do not play with local layout while you are actually working, especially
6784 if you have not saved your document.
6785 That said, using local layout with a test document can be a very convenient
6786 way to try out layout ideas, or even to start developing a module.
6789 \begin_layout Subsection
6791 \begin_inset Flex MenuItem
6794 \begin_layout Plain Layout
6803 \begin_layout Standard
6804 There are two situations you are likely to encounter when wanting to support
6805 a new \SpecialChar LaTeX
6806 document class, involving style (
6807 \begin_inset Flex Code
6810 \begin_layout Plain Layout
6816 ) files and \SpecialChar LaTeX2e
6818 \begin_inset Flex Code
6821 \begin_layout Plain Layout
6828 Supporting a style file is usually fairly easy.
6829 Supporting a new class file is a bit harder.
6830 We'll discuss the former in this section and the latter in the next.
6831 Similar remarks apply, of course, if you want to support a new DocBook
6835 \begin_layout Standard
6836 The easier case is the one in which your new document class is provided
6837 as a style file that is to be used in conjunction with an already supported
6839 For the sake of the example, we'll assume that the style file is called
6841 \begin_inset Flex MenuItem
6844 \begin_layout Plain Layout
6850 and that it is meant to be used with
6851 \begin_inset Flex MenuItem
6854 \begin_layout Plain Layout
6860 , which is a standard class.
6864 \begin_layout Standard
6865 Start by copying the existing class's layout file into your local directory:
6869 \begin_layout Plain Layout
6870 Of course, which directory is your local directory will vary by platform,
6871 and \SpecialChar LyX
6872 allows you to specify your local directory on startup, too, using
6874 \begin_inset Flex Code
6877 \begin_layout Plain Layout
6891 \begin_layout LyX-Code
6892 cp report.layout ~/.lyx/layouts/myclass.layout
6895 \begin_layout Standard
6897 \begin_inset Flex Code
6900 \begin_layout Plain Layout
6906 and change the line:
6909 \begin_layout LyX-Code
6912 Declare\SpecialChar LaTeX
6916 \begin_layout Standard
6920 \begin_layout LyX-Code
6923 Declare\SpecialChar LaTeX
6924 Class[report, myclass.sty]{report (myclass)}
6927 \begin_layout Standard
6931 \begin_layout LyX-Code
6933 \begin_inset Newline newline
6939 \begin_inset Newline newline
6945 \begin_layout Standard
6946 near the top of the file.
6949 \begin_layout Standard
6950 Start \SpecialChar LyX
6952 \begin_inset Flex MenuItem
6955 \begin_layout Plain Layout
6956 Tools\SpecialChar menuseparator
6963 Then restart \SpecialChar LyX
6964 and try creating a new document.
6966 \begin_inset Flex MenuItem
6969 \begin_layout Plain Layout
6975 " as a document class option in the
6976 \begin_inset Flex MenuItem
6979 \begin_layout Plain Layout
6980 Document\SpecialChar menuseparator
6987 It is likely that some of the sectioning commands and such in your new
6988 class will work differently from how they worked in the base class—
6989 \begin_inset Flex Code
6992 \begin_layout Plain Layout
6998 in this example—so you can fiddle around with the settings for the different
6999 sections if you wish.
7000 The layout information for sections is contained in
7001 \begin_inset Flex Code
7004 \begin_layout Plain Layout
7010 , but you do not need to copy and change this file.
7011 Instead, you can simply add your changes to your layout file, after the
7013 \begin_inset Flex Code
7016 \begin_layout Plain Layout
7022 , which itself includes
7023 \begin_inset Flex Code
7026 \begin_layout Plain Layout
7033 For example, you might add these lines:
7036 \begin_layout LyX-Code
7040 \begin_layout LyX-Code
7044 \begin_layout LyX-Code
7048 \begin_layout LyX-Code
7052 \begin_layout LyX-Code
7056 \begin_layout Standard
7057 to change the font for chapter headings to sans-serif.
7058 This will override (or, in this case, add to) the existing declaration
7059 for the Chapter style.
7063 \begin_layout Standard
7064 Your new package may also provide commands or environments not present in
7066 In this case, you will want to add these to the layout file.
7068 \begin_inset CommandInset ref
7070 reference "sec:TextClass"
7074 for information on how to do so.
7077 \begin_layout Standard
7079 \begin_inset Flex MenuItem
7082 \begin_layout Plain Layout
7088 can be used with several different document classes, and even if it cannot,
7089 you might find it easiest just to write a module that you can load with
7091 The simplest possible such module would be:
7094 \begin_layout LyX-Code
7097 DeclareLyXModule{My Package}
7100 \begin_layout LyX-Code
7104 \begin_layout LyX-Code
7105 #Support for mypkg.sty.
7108 \begin_layout LyX-Code
7110 \begin_inset Newline newline
7116 \begin_layout LyX-Code
7118 \begin_inset Newline newline
7124 \begin_layout LyX-Code
7126 \begin_inset Newline newline
7132 \begin_inset Newline newline
7138 \begin_layout Standard
7139 A more complex module might modify the behavior of some existing constructs
7140 or define some new ones.
7142 \begin_inset CommandInset ref
7144 reference "sec:TextClass"
7151 \begin_layout Subsection
7153 \begin_inset Flex MenuItem
7156 \begin_layout Plain Layout
7165 \begin_layout Standard
7166 There are two possibilities here.
7167 One is that the class file is itself based upon an existing document class.
7168 For example, many thesis classes are based upon
7169 \begin_inset Flex MenuItem
7172 \begin_layout Plain Layout
7179 To see whether yours is, look for a line like
7182 \begin_layout LyX-Code
7188 \begin_layout Standard
7190 If so, then you may proceed largely as in the previous section, though
7192 \begin_inset Flex Code
7195 \begin_layout Plain Layout
7196 Declare\SpecialChar LaTeX
7202 line will be different.
7203 If your new class is
7204 \begin_inset Flex Code
7207 \begin_layout Plain Layout
7213 and it is based upon
7214 \begin_inset Flex Code
7217 \begin_layout Plain Layout
7223 , then the line should read:
7227 \begin_layout Plain Layout
7228 And it will be easiest if you save the file to
7229 \begin_inset Flex Code
7232 \begin_layout Plain Layout
7239 assumes that the document class has the same name as the layout file.
7248 \begin_layout LyX-Code
7251 Declare\SpecialChar LaTeX
7252 Class[thesis,book]{thesis}
7255 \begin_layout Standard
7256 If, on the other hand, the new class is not based upon an existing class,
7257 you will probably have to
7258 \begin_inset Quotes eld
7262 \begin_inset Quotes erd
7266 We strongly suggest copying an existing layout file which uses a similar
7268 class and then modifying it, if you can do so.
7269 At least use an existing file as a starting point so you can find out what
7270 items you need to worry about.
7271 Again, the specifics are covered below.
7274 \begin_layout Subsection
7276 \begin_inset CommandInset label
7278 name "subsec:Creating-Templates"
7285 \begin_layout Standard
7286 Once you have written a layout file for a new document class, you might
7287 want to consider writing a
7292 A template acts as a kind of tutorial for your layout, showing how it might
7293 be used, though containing dummy content.
7294 You can of course look at the various templates included with \SpecialChar LyX
7298 \begin_layout Standard
7299 Templates are created just like usual documents: using \SpecialChar LyX
7301 The only difference is that usual documents contain all possible settings,
7302 including the font scheme and the paper size.
7303 Usually a user doesn't want a template to overwrite his preferred settings
7304 for such parameters.
7305 For that reason, the designer of a template should remove the corresponding
7307 \begin_inset Flex Code
7310 \begin_layout Plain Layout
7319 \begin_inset Flex Code
7322 \begin_layout Plain Layout
7330 from the template \SpecialChar LyX
7332 This can be done with any simple text-editor, for example
7333 \begin_inset Flex Code
7336 \begin_layout Plain Layout
7343 \begin_inset Flex Code
7346 \begin_layout Plain Layout
7355 \begin_layout Standard
7356 Put the edited template files you create in
7357 \begin_inset Flex Code
7360 \begin_layout Plain Layout
7366 , copy the ones you use from the global template directory in
7367 \begin_inset Flex Code
7370 \begin_layout Plain Layout
7376 to the same place, and redefine the template path in the
7377 \begin_inset Flex MenuItem
7380 \begin_layout Plain Layout
7381 Tools\SpecialChar menuseparator
7382 Preferences\SpecialChar menuseparator
7391 \begin_layout Standard
7392 Note, by the way, that there is a template which has a particular meaning:
7394 \begin_inset Flex Code
7397 \begin_layout Plain Layout
7404 This template is loaded every time you create a new document with
7405 \begin_inset Flex MenuItem
7408 \begin_layout Plain Layout
7409 File\SpecialChar menuseparator
7415 in order to provide useful defaults.
7416 To create this template from inside \SpecialChar LyX
7417 , all you have to do is to open a document
7418 with the correct settings, and use the
7419 \begin_inset Flex MenuItem
7422 \begin_layout Plain Layout
7423 Save as Document Defaults
7431 \begin_layout Subsection
7432 Upgrading old layout files
7435 \begin_layout Standard
7436 The format of layout files changes with each \SpecialChar LyX
7437 release, so old layout files
7438 need to be converted to the new format.
7440 reads a layout file in an older format, it automatically calls the
7442 \begin_inset Flex Code
7445 \begin_layout Plain Layout
7451 to convert it to a temporary file in current format.
7452 The original file is left untouched.
7453 If you use the layout file often, then, you may want to convert it permanently,
7454 so that \SpecialChar LyX
7455 does not have to do so itself every time.
7456 To do this, you can call the converter manually:
7459 \begin_layout Enumerate
7461 \begin_inset Flex Code
7464 \begin_layout Plain Layout
7471 \begin_inset Flex Code
7474 \begin_layout Plain Layout
7483 \begin_layout Enumerate
7485 \begin_inset Newline newline
7489 \begin_inset Flex Code
7492 \begin_layout Plain Layout
7493 python LyXDir/scripts/layout2layout.py myclass.old myclass.layout
7499 \begin_inset Newline newline
7503 \begin_inset Flex Code
7506 \begin_layout Plain Layout
7512 is the name of your \SpecialChar LyX
7516 \begin_layout Standard
7517 Note that manual conversion does not affect included files, so these will
7518 have to be converted separately.
7521 \begin_layout Section
7522 \begin_inset CommandInset label
7524 name "sec:TextClass"
7528 The layout file format
7531 \begin_layout Standard
7532 The following sections describe how layout files are structured and written.
7533 Our advice is to go slowly, save and test often.
7534 It is really not that hard, except that the multitude of options can become
7535 overwhelming, especially if you try to check out too many at once.
7536 It becomes easier if you use existing layouts of \SpecialChar LyX
7537 as examples/reference
7538 or if you modify an existing layout to your needs.
7541 \begin_layout Standard
7542 Note that all the tags used in layout files are case-insensitive.
7544 \begin_inset Flex Code
7547 \begin_layout Plain Layout
7554 \begin_inset Flex Code
7557 \begin_layout Plain Layout
7564 \begin_inset Flex Code
7567 \begin_layout Plain Layout
7573 are really the same tag.
7574 The possible arguments are printed in brackets after the tag's name.
7575 The default argument is typeset
7576 \begin_inset Flex Code
7579 \begin_layout Plain Layout
7588 If the argument has a data type like
7589 \begin_inset Quotes eld
7593 \begin_inset Quotes erd
7597 \begin_inset Quotes eld
7601 \begin_inset Quotes erd
7604 , the default is shown like this:
7605 \begin_inset Flex Code
7608 \begin_layout Plain Layout
7619 \begin_layout Subsection
7620 The document class declaration and classification
7623 \begin_layout Standard
7624 Lines in a layout file which begin with
7625 \begin_inset Flex Code
7628 \begin_layout Plain Layout
7635 There is one exception to this rule.
7637 \begin_inset Flex Code
7640 \begin_layout Plain Layout
7646 files should begin with lines like:
7649 \begin_layout LyX-Code
7652 #% Do not delete the line below; configure depends on this
7655 \begin_layout LyX-Code
7660 DeclareLaTeXClass{Article (Standard Class)}
7663 \begin_layout LyX-Code
7668 DeclareCategory{Articles}
7671 \begin_layout Standard
7672 The second and third lines are used when you (re)configure \SpecialChar LyX
7674 The layout file is read by the \SpecialChar LaTeX
7676 \begin_inset Flex Code
7679 \begin_layout Plain Layout
7685 , in a special mode where
7686 \begin_inset Flex Code
7689 \begin_layout Plain Layout
7696 The first line is just a \SpecialChar LaTeX
7697 comment, the second one contains the mandatory
7698 declaration of the text class and the third line contains the optional
7699 classification of the class.
7700 If these lines appear in a file named
7701 \begin_inset Flex Code
7704 \begin_layout Plain Layout
7710 , then they define a text class of name
7711 \begin_inset Flex Code
7714 \begin_layout Plain Layout
7720 (the name of the layout file) which uses the \SpecialChar LaTeX
7722 \begin_inset Flex Code
7725 \begin_layout Plain Layout
7731 (the default is to use the same name as the layout).
7733 \begin_inset Quotes eld
7736 Article (Standard Class)
7737 \begin_inset Quotes erd
7740 that appears above is used as a description of the text class in the
7741 \begin_inset Flex MenuItem
7744 \begin_layout Plain Layout
7745 Document\SpecialChar menuseparator
7753 \begin_inset Quotes eld
7757 \begin_inset Quotes erd
7760 in the example) is also used in the
7761 \begin_inset Flex MenuItem
7764 \begin_layout Plain Layout
7765 Document\SpecialChar menuseparator
7771 dialog: the text classes are grouped by these categories (which are usually
7772 genres, so typical categories are
7773 \begin_inset Quotes eld
7777 \begin_inset Quotes erd
7781 \begin_inset Quotes eld
7785 \begin_inset Quotes erd
7789 \begin_inset Quotes eld
7793 \begin_inset Quotes erd
7797 \begin_inset Quotes eld
7801 \begin_inset Quotes erd
7805 \begin_inset Quotes eld
7809 \begin_inset Quotes erd
7813 \begin_inset Quotes eld
7817 \begin_inset Quotes erd
7821 If no category has been declared, the class will be put in the
7822 \begin_inset Quotes eld
7826 \begin_inset Quotes erd
7832 \begin_layout Standard
7833 Let's assume that you wrote your own text class that uses the
7834 \begin_inset Flex Code
7837 \begin_layout Plain Layout
7843 document class, but where you changed the appearance of the section headings.
7844 If you put it in a file
7845 \begin_inset Flex Code
7848 \begin_layout Plain Layout
7854 , the header of this file should be:
7857 \begin_layout LyX-Code
7860 #% Do not delete the line below; configure depends on this
7863 \begin_layout LyX-Code
7868 DeclareLaTeXClass[article]{Article (with My Own Headings)}
7871 \begin_layout LyX-Code
7876 DeclareCategory{Articles}
7879 \begin_layout Standard
7880 This declares a text class
7881 \begin_inset Flex Code
7884 \begin_layout Plain Layout
7890 , associated with the \SpecialChar LaTeX
7892 \begin_inset Flex Code
7895 \begin_layout Plain Layout
7902 \begin_inset Quotes eld
7905 Article (with My Own Headings)
7906 \begin_inset Quotes erd
7910 If your text class depends on several packages, you can declare it as:
7913 \begin_layout LyX-Code
7916 #% Do not delete the line below; configure depends on this
7919 \begin_layout LyX-Code
7924 DeclareLaTeXClass[article,foo.sty]{Article (with My Own Headings)}
7927 \begin_layout LyX-Code
7932 DeclareCategory{Articles}
7935 \begin_layout Standard
7936 This indicates that your text class uses the
7937 \begin_inset Flex Code
7940 \begin_layout Plain Layout
7947 Finally, it is also possible to declare classes for DocBook code.
7948 Typical declarations will look like:
7951 \begin_layout LyX-Code
7954 #% Do not delete the line below; configure depends on this
7957 \begin_layout LyX-Code
7962 DeclareDocBookClass[article]{SGML (DocBook Article)}
7965 \begin_layout LyX-Code
7970 DeclareCategory{Articles (DocBook)}
7973 \begin_layout Standard
7974 Note that these declarations can also be given an optional parameter declaring
7975 the name of the document class (but not a list).
7978 \begin_layout Standard
7979 So, to be as explicit as possible, the form of the layout declaration is:
7982 \begin_layout LyX-Code
7987 DeclareLaTeXClass[class,package.sty]{layout description}
7990 \begin_layout LyX-Code
7995 DeclareCategory{category}
7998 \begin_layout Standard
7999 The class need only be specified if the name of the \SpecialChar LaTeX
8001 name of the layout file are different or if there are packages to load.
8002 If the name of the class file is not specified, then \SpecialChar LyX
8004 that it is the same as the name of the layout file.
8007 \begin_layout Standard
8008 When the text class has been modified to your taste, all you have to do
8009 is to copy it either to
8010 \begin_inset Flex Code
8013 \begin_layout Plain Layout
8020 \begin_inset Flex Code
8023 \begin_layout Plain Layout
8030 \begin_inset Flex MenuItem
8033 \begin_layout Plain Layout
8034 Tools\SpecialChar menuseparator
8040 , exit \SpecialChar LyX
8042 Then your new text class should be available along with the others.
8045 \begin_layout Standard
8046 Once the layout file is installed, you can edit it and see your changes
8047 without having to reconfigure or to restart \SpecialChar LyX
8053 \begin_layout Plain Layout
8054 In versions of \SpecialChar LyX
8055 prior to 1.6, this was not true.
8056 As a result, editing layout files was very time consuming, since you had
8057 constantly to restart \SpecialChar LyX
8063 You can force a reload of the current layout by using the \SpecialChar LyX
8065 \begin_inset Flex MenuItem
8068 \begin_layout Plain Layout
8075 There is no default binding for this function—though, of course, you can
8076 bind it to a key yourself.
8077 But you will normally use this function simply by entering it in the mini-buffe
8082 \begin_layout Standard
8088 \begin_inset Flex MenuItem
8091 \begin_layout Plain Layout
8097 is very much an `advanced feature'.
8102 recommended that you save your work before using this function.
8107 recommended that you not attempt to edit layout information while simultaneousl
8108 y working on a document that you care about.
8109 Use a test document.
8110 Syntax errors and the like in your layout file could cause peculiar behavior.
8111 In particular, such errors could cause \SpecialChar LyX
8112 to regard the current layout as
8113 invalid and to attempt to switch to some other layout.
8117 \begin_layout Plain Layout
8118 Really bad syntax errors may even caused \SpecialChar LyX
8120 This is because certain sorts of errors may make \SpecialChar LyX
8131 The \SpecialChar LyX
8132 team strives to keep \SpecialChar LyX
8133 stable in such situations, but safe is better
8138 \begin_layout Plain Layout
8139 While we're giving advice: make regular backups.
8140 And be nice to your mother.
8148 \begin_layout Subsection
8149 The Module declaration
8152 \begin_layout Standard
8153 A module must begin with a line like the following:
8156 \begin_layout LyX-Code
8159 DeclareLyXModule[endnotes.sty]{Endnotes}
8162 \begin_layout Standard
8163 The mandatory argument, in curly brackets, is the name of the module, as
8165 \begin_inset Flex MenuItem
8168 \begin_layout Plain Layout
8169 Document\SpecialChar menuseparator
8170 Settings\SpecialChar menuseparator
8177 The argument in square brackets is optional: It declares any \SpecialChar LaTeX
8179 on which the module depends.
8180 It is also possible to use the form
8181 \begin_inset Flex MenuItem
8184 \begin_layout Plain Layout
8190 as an optional argument, which declares that the module can only be used
8191 when there exists a conversion chain between the formats `
8192 \begin_inset Flex Code
8195 \begin_layout Plain Layout
8202 \begin_inset Flex Code
8205 \begin_layout Plain Layout
8214 \begin_layout Standard
8215 The module declaration should then be followed by lines like the following
8219 \begin_layout Plain Layout
8220 Preferably in English if the module should be published with \SpecialChar LyX
8222 This description will appear in the list of messages to be translated and
8223 will be thus translated with the next interface update.
8231 \begin_layout LyX-Code
8235 \begin_layout LyX-Code
8236 #Adds an endnote command, in addition to footnotes.
8240 \begin_layout LyX-Code
8241 #You will need to add
8243 theendnotes in TeX code where you
8246 \begin_layout LyX-Code
8247 #want the endnotes to appear.
8251 \begin_layout LyX-Code
8255 \begin_layout LyX-Code
8256 #Requires: somemodule | othermodule
8259 \begin_layout LyX-Code
8260 #Excludes: badmodule
8263 \begin_layout Standard
8264 The description is used in
8265 \begin_inset Flex MenuItem
8268 \begin_layout Plain Layout
8269 Document\SpecialChar menuseparator
8270 Settings\SpecialChar menuseparator
8276 to provide the user with information about what the module does.
8278 \begin_inset Flex Code
8281 \begin_layout Plain Layout
8287 line is used to identify other modules with which this one must be used;
8289 \begin_inset Flex Code
8292 \begin_layout Plain Layout
8298 line is used to identify modules with which this one may not be used.
8299 Both are optional, and, as shown, multiple modules should be separated
8300 with the pipe symbol: |.
8301 Note that the required modules are treated disjunctively:
8305 of the required modules must be used.
8310 excluded module may be used.
8311 Note that modules are identified here by their filenames without the
8312 \begin_inset Flex Code
8315 \begin_layout Plain Layout
8323 \begin_inset Flex Code
8326 \begin_layout Plain Layout
8333 \begin_inset Flex Code
8336 \begin_layout Plain Layout
8345 \begin_layout Subsection
8349 \begin_layout Standard
8350 The first non-comment line of any layout file, included file, or module
8355 contain the file format number:
8358 \begin_layout Description
8359 \begin_inset Flex Code
8362 \begin_layout Plain Layout
8369 \begin_inset Flex Code
8372 \begin_layout Plain Layout
8378 ] The format number of the layout file.
8381 \begin_layout Standard
8382 This tag was introduced with \SpecialChar LyX
8384 \begin_inset space ~
8388 Layout files from older \SpecialChar LyX
8389 versions do not have an explicit file format and
8390 are considered to have
8391 \begin_inset Flex Code
8394 \begin_layout Plain Layout
8396 \begin_inset space ~
8405 The format for the present version of \SpecialChar LyX
8407 But each version of \SpecialChar LyX
8408 is capable of reading earlier versions' layout files,
8409 just as they are capable of reading files produced by earlier versions
8412 There is, however, no provision for converting to earlier formats.
8415 \begin_layout Subsection
8416 \begin_inset CommandInset label
8418 name "subsec:General-text-class"
8422 General text class parameters
8425 \begin_layout Standard
8426 These are general parameters that govern the behavior of an entire document
8432 mean that they must appear in
8433 \begin_inset Flex Code
8436 \begin_layout Plain Layout
8442 files rather than in modules.
8443 A module can contain any layout tag.)
8446 \begin_layout Description
8447 \begin_inset Flex Code
8450 \begin_layout Plain Layout
8456 Adds information that will be output in the
8457 \begin_inset Flex Code
8460 \begin_layout Plain Layout
8466 block when the document is output to XHTML.
8467 Typically, this would be used to output CSS style information, but it can
8468 be used for anything that can appear in
8469 \begin_inset Flex Code
8472 \begin_layout Plain Layout
8480 \begin_inset Quotes eld
8484 \begin_inset Flex Code
8487 \begin_layout Plain Layout
8494 \begin_inset Quotes erd
8500 \begin_layout Description
8501 \begin_inset Flex Code
8504 \begin_layout Plain Layout
8510 Adds information to the document preamble.
8512 \begin_inset Newline newline
8516 \begin_inset Quotes eld
8520 \begin_inset Flex Code
8523 \begin_layout Plain Layout
8530 \begin_inset Quotes erd
8536 \begin_layout Description
8537 \begin_inset Flex Code
8540 \begin_layout Plain Layout
8546 Defines formats for use in the display of bibliographic information.
8548 \begin_inset CommandInset ref
8550 reference "subsec:Citation-format-description"
8556 \begin_inset Quotes eld
8560 \begin_inset Flex Code
8563 \begin_layout Plain Layout
8570 \begin_inset Quotes erd
8576 \begin_layout Description
8577 \begin_inset Flex Code
8580 \begin_layout Plain Layout
8586 Describes various global options supported by the document class.
8588 \begin_inset CommandInset ref
8590 reference "subsec:ClassOptions"
8596 \begin_inset Quotes eld
8600 \begin_inset Flex Code
8603 \begin_layout Plain Layout
8610 \begin_inset Quotes erd
8616 \begin_layout Description
8617 \begin_inset Flex Code
8620 \begin_layout Plain Layout
8627 \begin_inset Flex Code
8630 \begin_layout Plain Layout
8639 \begin_inset space \thinspace{}
8643 \begin_inset Flex Code
8646 \begin_layout Plain Layout
8652 ] Whether the class should
8656 to having one or two columns.
8657 Can be changed in the
8658 \begin_inset Flex MenuItem
8661 \begin_layout Plain Layout
8662 Document\SpecialChar menuseparator
8671 \begin_layout Description
8672 \begin_inset Flex Code
8675 \begin_layout Plain Layout
8682 \begin_inset Flex Code
8685 \begin_layout Plain Layout
8691 ] This sequence defines the properties for a counter.
8692 If the counter does not yet exist, it is created; if it does exist, it
8695 \begin_inset Quotes eld
8699 \begin_inset Flex Code
8702 \begin_layout Plain Layout
8709 \begin_inset Quotes erd
8713 \begin_inset Newline newline
8717 \begin_inset CommandInset ref
8719 reference "subsec:Counters"
8723 for details on counters.
8726 \begin_layout Description
8727 \begin_inset Flex Code
8730 \begin_layout Plain Layout
8736 Sets the default font used to display the document.
8738 \begin_inset CommandInset ref
8740 reference "subsec:Font-description"
8744 for how to declare fonts.
8746 \begin_inset Quotes eld
8750 \begin_inset Flex Code
8753 \begin_layout Plain Layout
8760 \begin_inset Quotes erd
8766 \begin_layout Description
8767 \begin_inset Flex Code
8770 \begin_layout Plain Layout
8777 \begin_inset Flex Code
8780 \begin_layout Plain Layout
8786 ] Specifies a module to be included by default with this document class.
8787 The module is specified as filename without the
8788 \begin_inset Flex Code
8791 \begin_layout Plain Layout
8798 The user can still remove the module, but it will be active at the outset.
8799 (This applies only when new files are created, or when this class is chosen
8800 for an existing document.)
8803 \begin_layout Description
8804 \begin_inset Flex Code
8807 \begin_layout Plain Layout
8814 \begin_inset Flex Code
8817 \begin_layout Plain Layout
8823 ] This is the style that will be assigned to new paragraphs, usually
8824 \begin_inset Flex MenuItem
8827 \begin_layout Plain Layout
8834 This will default to the first defined style if not given, but you are
8835 encouraged to use this directive.
8838 \begin_layout Description
8839 \begin_inset Flex Code
8842 \begin_layout Plain Layout
8849 \begin_inset Flex Code
8852 \begin_layout Plain Layout
8858 ] This tag indicates that the module (which is specified by filename without
8860 \begin_inset Flex Code
8863 \begin_layout Plain Layout
8869 extension) cannot be used with this document class.
8870 This might be used in a journal-specific layout file to prevent, say, the
8872 \begin_inset Flex Code
8875 \begin_layout Plain Layout
8881 module that numbers theorems by section.
8886 be used in a module.
8887 Modules have their own way of excluding other modules (see
8888 \begin_inset CommandInset ref
8890 reference "subsec:Layout-modules"
8897 \begin_layout Description
8898 \begin_inset Flex Code
8901 \begin_layout Plain Layout
8907 Defines a new float.
8909 \begin_inset CommandInset ref
8911 reference "subsec:Floats"
8917 \begin_inset Quotes eld
8921 \begin_inset Flex Code
8924 \begin_layout Plain Layout
8931 \begin_inset Quotes erd
8937 \begin_layout Description
8938 \begin_inset Flex Code
8941 \begin_layout Plain Layout
8947 Sets the information that will be output in the
8948 \begin_inset Flex Code
8951 \begin_layout Plain Layout
8957 block when this document class is output to XHTML.
8958 Note that this will completely override any prior
8959 \begin_inset Flex Code
8962 \begin_layout Plain Layout
8969 \begin_inset Flex Code
8972 \begin_layout Plain Layout
8980 \begin_inset Newline newline
8984 \begin_inset Flex Code
8987 \begin_layout Plain Layout
8993 if you just want to add material to the preamble.) Must end with
8994 \begin_inset Quotes eld
8998 \begin_inset Flex Code
9001 \begin_layout Plain Layout
9008 \begin_inset Quotes erd
9014 \begin_layout Description
9015 \begin_inset Flex Code
9018 \begin_layout Plain Layout
9025 \begin_inset Flex Code
9028 \begin_layout Plain Layout
9034 ] The style to use for the table of contents, bibliography, and so forth,
9035 when the document is output to HTML.
9036 For articles, this should normally be
9037 \begin_inset Flex Code
9040 \begin_layout Plain Layout
9047 \begin_inset Flex Code
9050 \begin_layout Plain Layout
9057 If it is not given, then \SpecialChar LyX
9058 will attempt to figure out which layout to use.
9061 \begin_layout Description
9062 \begin_inset Flex Code
9065 \begin_layout Plain Layout
9072 \begin_inset Flex Code
9075 \begin_layout Plain Layout
9081 ] Modifies the properties of the given counter.
9082 If the counter does not exist, the statement is ignored.
9084 \begin_inset Quotes eld
9088 \begin_inset Flex Code
9091 \begin_layout Plain Layout
9098 \begin_inset Quotes erd
9102 \begin_inset Newline newline
9106 \begin_inset CommandInset ref
9108 reference "subsec:Counters"
9112 for details on counters.
9115 \begin_layout Description
9116 \begin_inset Flex Code
9119 \begin_layout Plain Layout
9126 \begin_inset Flex Code
9129 \begin_layout Plain Layout
9135 ] Modifies the properties of the given paragraph style.
9136 If the style does not exist, the statement is ignored.
9138 \begin_inset Quotes eld
9142 \begin_inset Flex Code
9145 \begin_layout Plain Layout
9152 \begin_inset Quotes erd
9158 \begin_layout Description
9159 \begin_inset Flex Code
9162 \begin_layout Plain Layout
9169 \begin_inset Flex Code
9172 \begin_layout Plain Layout
9178 ] This allows you to include another layout definition file within yours
9179 to avoid duplicating commands.
9180 Common examples are the standard layout files, for example,
9181 \begin_inset Flex Code
9184 \begin_layout Plain Layout
9190 , which contains most of the basic layouts.
9193 \begin_layout Description
9194 \begin_inset Flex Code
9197 \begin_layout Plain Layout
9204 \begin_inset Flex Code
9207 \begin_layout Plain Layout
9213 ] This section (re-)defines the layout of an inset.
9214 It can be applied to an existing inset or to a new, user-defined inset,
9215 e.g., a new character style.
9217 \begin_inset Quotes eld
9221 \begin_inset Flex Code
9224 \begin_layout Plain Layout
9231 \begin_inset Quotes erd
9235 \begin_inset Newline newline
9239 \begin_inset CommandInset ref
9241 reference "subsec:Flex-insets-and"
9245 for more information.
9249 \begin_layout Description
9250 \begin_inset Flex Code
9253 \begin_layout Plain Layout
9260 \begin_inset Flex Code
9263 \begin_layout Plain Layout
9269 ] A string that indicates the width of the left margin on the screen, for
9271 \begin_inset Quotes eld
9275 \begin_inset Flex Code
9278 \begin_layout Plain Layout
9285 \begin_inset Quotes erd
9289 (Note that this is not a `length', like
9290 \begin_inset Quotes eld
9294 \begin_inset Quotes erd
9300 \begin_layout Description
9301 \begin_inset Flex Code
9304 \begin_layout Plain Layout
9311 \begin_inset Flex Code
9314 \begin_layout Plain Layout
9320 ] Deletes an existing counter, usually one defined in an included file.
9323 \begin_layout Description
9324 \begin_inset Flex Code
9327 \begin_layout Plain Layout
9334 \begin_inset Flex Code
9337 \begin_layout Plain Layout
9343 ] Deletes an existing float.
9344 This is particularly useful when you want to suppress a float that has
9345 been defined in an input file.
9348 \begin_layout Description
9349 \begin_inset Flex Code
9352 \begin_layout Plain Layout
9359 \begin_inset Flex Code
9362 \begin_layout Plain Layout
9368 ] Deletes an existing style.
9371 \begin_layout Description
9372 \begin_inset Flex Code
9375 \begin_layout Plain Layout
9382 \begin_inset Flex Code
9385 \begin_layout Plain Layout
9391 ] The file format (as defined in the \SpecialChar LyX
9392 preferences) produced by this document
9394 It is mainly useful when
9395 \begin_inset Flex Code
9398 \begin_layout Plain Layout
9405 \begin_inset Flex Code
9408 \begin_layout Plain Layout
9414 and one wants to define a new type of literate document.
9415 The format is reset to
9416 \begin_inset Quotes eld
9420 \begin_inset Flex Code
9423 \begin_layout Plain Layout
9430 \begin_inset Quotes erd
9434 \begin_inset Quotes eld
9438 \begin_inset Flex Code
9441 \begin_layout Plain Layout
9448 \begin_inset Quotes erd
9451 when the corresponding
9452 \begin_inset Flex Code
9455 \begin_layout Plain Layout
9461 parameter is encountered.
9464 \begin_layout Description
9465 \begin_inset Flex Code
9468 \begin_layout Plain Layout
9475 \begin_inset Flex Code
9478 \begin_layout Plain Layout
9489 \begin_inset Flex Code
9492 \begin_layout Plain Layout
9499 \begin_inset Flex Code
9502 \begin_layout Plain Layout
9508 ] Specifies what sort of output documents using this class will produce.
9511 \begin_layout Description
9512 \begin_inset Flex Code
9515 \begin_layout Plain Layout
9522 \begin_inset Flex Code
9525 \begin_layout Plain Layout
9532 \begin_inset Flex Code
9535 \begin_layout Plain Layout
9541 ] Specifies options, given in the second string, for the package named by
9544 \begin_inset Quotes eld
9548 \begin_inset Flex Code
9551 \begin_layout Plain Layout
9552 PackageOptions natbib square
9558 \begin_inset Quotes erd
9562 \begin_inset Flex Code
9565 \begin_layout Plain Layout
9571 to be loaded with the
9572 \begin_inset Flex Code
9575 \begin_layout Plain Layout
9582 (For \SpecialChar TeX
9583 perts, this causes \SpecialChar LyX
9585 \begin_inset Flex Code
9588 \begin_layout Plain Layout
9591 PassOptionsToPackage{natbib}{square}
9597 \begin_inset Flex Code
9600 \begin_layout Plain Layout
9609 \begin_layout Description
9610 \begin_inset Flex Code
9613 \begin_layout Plain Layout
9620 \begin_inset Flex Code
9623 \begin_layout Plain Layout
9632 \begin_inset Flex Code
9635 \begin_layout Plain Layout
9642 \begin_inset Flex Code
9645 \begin_layout Plain Layout
9651 ] The default pagestyle.
9652 Can be changed in the
9653 \begin_inset Flex MenuItem
9656 \begin_layout Plain Layout
9657 Document\SpecialChar menuseparator
9666 \begin_layout Description
9667 \begin_inset Flex Code
9670 \begin_layout Plain Layout
9676 Sets the preamble for the \SpecialChar LaTeX
9678 Note that this will completely override any prior
9679 \begin_inset Flex Code
9682 \begin_layout Plain Layout
9689 \begin_inset Flex Code
9692 \begin_layout Plain Layout
9700 \begin_inset Flex Code
9703 \begin_layout Plain Layout
9709 if you just want to add material to the preamble.) Must end with
9710 \begin_inset Quotes eld
9714 \begin_inset Flex Code
9717 \begin_layout Plain Layout
9724 \begin_inset Quotes erd
9730 \begin_layout Description
9731 \begin_inset Flex Code
9734 \begin_layout Plain Layout
9741 \begin_inset Flex Code
9744 \begin_layout Plain Layout
9751 \begin_inset Flex Code
9754 \begin_layout Plain Layout
9763 \begin_inset space \thinspace{}
9767 \begin_inset Flex Code
9770 \begin_layout Plain Layout
9776 ] Whether the class already provides the feature
9777 \begin_inset Flex Code
9780 \begin_layout Plain Layout
9787 A feature is in general the name of a package (e.
9788 \begin_inset space \thinspace{}
9792 \begin_inset space \space{}
9796 \begin_inset Flex Code
9799 \begin_layout Plain Layout
9806 \begin_inset Flex Code
9809 \begin_layout Plain Layout
9816 \begin_inset space \thinspace{}
9820 \begin_inset space \space{}
9824 \begin_inset Flex Code
9827 \begin_layout Plain Layout
9834 \begin_inset Flex Code
9837 \begin_layout Plain Layout
9845 \begin_inset CommandInset ref
9847 reference "chap:List-of-functions"
9851 for the list of features.
9854 \begin_layout Description
9855 \begin_inset Flex Code
9858 \begin_layout Plain Layout
9865 \begin_inset Flex Code
9868 \begin_layout Plain Layout
9874 ] Indicates that this layout provides the functionality of the module mentioned,
9875 which should be specified by the filename without the
9876 \begin_inset Flex Code
9879 \begin_layout Plain Layout
9886 This will typically be used if the layout includes the module directly,
9887 rather than using the
9888 \begin_inset Flex Code
9891 \begin_layout Plain Layout
9897 tag to indicate that it ought to be used.
9898 It could also be used in a module that provided an alternate implementation
9899 of the same functionality.
9902 \begin_layout Description
9903 \begin_inset Flex Code
9906 \begin_layout Plain Layout
9913 \begin_inset Flex Code
9916 \begin_layout Plain Layout
9922 ] Whether the class requires the feature
9923 \begin_inset Flex Code
9926 \begin_layout Plain Layout
9933 Multiple features must be separated by commas.
9934 Note that you can only request supported features.
9936 \begin_inset CommandInset ref
9938 reference "chap:List-of-functions"
9942 for the list of features.)
9943 \change_inserted -712698321 1438601536
9945 If you require a package with specific options, you can additionally use
9947 \begin_inset Flex Code
9950 \begin_layout Plain Layout
9952 \change_inserted -712698321 1438601526
9963 \begin_layout Description
9964 \begin_inset Flex Code
9967 \begin_layout Plain Layout
9974 \begin_inset Flex Code
9977 \begin_layout Plain Layout
9983 ] A string that indicates the width of the right margin on the screen, for
9985 \begin_inset Quotes eld
9989 \begin_inset Flex Code
9992 \begin_layout Plain Layout
9999 \begin_inset Quotes erd
10005 \begin_layout Description
10006 \begin_inset Flex Code
10009 \begin_layout Plain Layout
10016 \begin_inset Flex Code
10019 \begin_layout Plain Layout
10025 ] Sets which divisions get numbered.
10027 \begin_inset Newline newline
10031 \begin_inset Flex Code
10034 \begin_layout Plain Layout
10040 counter in \SpecialChar LaTeX
10044 \begin_layout Description
10045 \begin_inset Flex Code
10048 \begin_layout Plain Layout
10055 \begin_inset Flex Code
10058 \begin_layout Plain Layout
10067 \begin_inset space \thinspace{}
10071 \begin_inset Flex Code
10074 \begin_layout Plain Layout
10080 ] Whether the class-default should be printing on one or both sides of the
10082 Can be changed in the
10083 \begin_inset Flex MenuItem
10086 \begin_layout Plain Layout
10087 Document\SpecialChar menuseparator
10096 \begin_layout Description
10097 \begin_inset Flex Code
10100 \begin_layout Plain Layout
10107 \begin_inset Flex Code
10110 \begin_layout Plain Layout
10116 ] This sequence defines a paragraph style.
10117 If the style does not yet exist, it is created; if it does exist, its parameter
10120 \begin_inset Quotes eld
10124 \begin_inset Flex Code
10127 \begin_layout Plain Layout
10134 \begin_inset Quotes erd
10138 \begin_inset Newline newline
10142 \begin_inset CommandInset ref
10144 reference "subsec:Paragraph-Styles"
10148 for details on paragraph styles.
10151 \begin_layout Description
10152 \begin_inset Flex Code
10155 \begin_layout Plain Layout
10162 \begin_inset Flex Code
10165 \begin_layout Plain Layout
10171 ] The name of the command or environment to be used with
10172 \begin_inset Flex Code
10175 \begin_layout Plain Layout
10184 \begin_layout Description
10185 \begin_inset Flex Code
10188 \begin_layout Plain Layout
10195 \begin_inset Flex Code
10198 \begin_layout Plain Layout
10207 \begin_inset Flex Code
10210 \begin_layout Plain Layout
10216 ] Indicates what kind of markup is used to define the title of a document.
10218 \begin_inset Flex Code
10221 \begin_layout Plain Layout
10227 means that the macro with name
10228 \begin_inset Flex Code
10231 \begin_layout Plain Layout
10237 will be inserted after the last layout which has
10238 \begin_inset Quotes eld
10242 \begin_inset Flex Code
10245 \begin_layout Plain Layout
10247 \begin_inset space ~
10256 \begin_inset Quotes erd
10261 \begin_inset Flex Code
10264 \begin_layout Plain Layout
10270 corresponds to the case where all layouts which have
10271 \begin_inset Quotes eld
10275 \begin_inset Flex Code
10278 \begin_layout Plain Layout
10280 \begin_inset space ~
10289 \begin_inset Quotes erd
10292 should be enclosed into the
10293 \begin_inset Flex Code
10296 \begin_layout Plain Layout
10305 \begin_layout Description
10306 \begin_inset Flex Code
10309 \begin_layout Plain Layout
10316 \begin_inset Flex Code
10319 \begin_layout Plain Layout
10325 ] Sets which divisions are included in the table of contents.
10327 \begin_inset Flex Code
10330 \begin_layout Plain Layout
10336 counter in \SpecialChar LaTeX
10340 \begin_layout Subsection
10341 \begin_inset Flex Code
10344 \begin_layout Plain Layout
10351 \begin_inset CommandInset label
10353 name "subsec:ClassOptions"
10360 \begin_layout Standard
10362 \begin_inset Flex Code
10365 \begin_layout Plain Layout
10371 section can contain the following entries:
10374 \begin_layout Description
10375 \begin_inset Flex Code
10378 \begin_layout Plain Layout
10385 \begin_inset Flex Code
10388 \begin_layout Plain Layout
10394 ] The list of available font sizes for the document's main font, separated
10396 \begin_inset Quotes eld
10400 \begin_inset Flex Code
10403 \begin_layout Plain Layout
10410 \begin_inset Quotes erd
10416 \begin_layout Description
10417 \begin_inset Flex Code
10420 \begin_layout Plain Layout
10426 Used to set the DTD line with XML-based output classes.
10428 \begin_inset space \thinspace{}
10432 \begin_inset Quotes eld
10435 -//OASIS//DTD DocBook V4.2//EN
10436 \begin_inset Quotes erd
10442 \begin_layout Description
10443 \begin_inset Flex Code
10446 \begin_layout Plain Layout
10453 \begin_inset Flex Code
10456 \begin_layout Plain Layout
10457 string="empty|plain|headings|fancy"
10462 ] The list of available page sty\SpecialChar softhyphen
10464 \begin_inset Quotes eld
10468 \begin_inset Flex Code
10471 \begin_layout Plain Layout
10478 \begin_inset Quotes erd
10484 \begin_layout Description
10485 \begin_inset Flex Code
10488 \begin_layout Plain Layout
10495 \begin_inset Flex Code
10498 \begin_layout Plain Layout
10504 ] Some document class options, separated by a comma, that will be added
10505 to the optional part of the
10506 \begin_inset Flex Code
10509 \begin_layout Plain Layout
10520 \begin_layout Standard
10522 \begin_inset Flex Code
10525 \begin_layout Plain Layout
10531 section must end with
10532 \begin_inset Quotes eld
10536 \begin_inset Flex Code
10539 \begin_layout Plain Layout
10546 \begin_inset Quotes erd
10552 \begin_layout Subsection
10554 \begin_inset CommandInset label
10556 name "subsec:Paragraph-Styles"
10563 \begin_layout Standard
10564 A paragraph style description looks like this:
10568 \begin_layout Plain Layout
10569 Note that this will either define a new style or modify an existing one.
10577 \begin_layout LyX-Code
10584 \begin_layout LyX-Code
10588 \begin_layout LyX-Code
10592 \begin_layout Standard
10593 where the following commands are allowed:
10596 \begin_layout Description
10597 \begin_inset Flex Code
10600 \begin_layout Plain Layout
10607 \begin_inset Flex Code
10610 \begin_layout Plain Layout
10615 , left, right, center
10620 ] Paragraph alignment.
10623 \begin_layout Description
10624 \begin_inset Flex Code
10627 \begin_layout Plain Layout
10634 \begin_inset Flex Code
10637 \begin_layout Plain Layout
10642 , left, right, center
10647 ] A comma separated list of permitted alignments.
10648 (Some \SpecialChar LaTeX
10649 styles prohibit certain alignments, since those wouldn't make sense.
10650 For example a right-aligned or centered enumeration isn't possible.)
10653 \begin_layout Description
10654 \begin_inset Flex Code
10657 \begin_layout Plain Layout
10664 \begin_inset Flex Code
10667 \begin_layout Plain Layout
10673 ] Defines argument number <int> of a command\SpecialChar breakableslash
10674 environment associated with
10676 This is useful for things like section headings, and only makes sense with
10679 Every (optional or required) argument of a command or environment – except
10680 for the required argument that is associated with the content of the paragraph
10681 itself – has a separate definition, where the number specifies the order
10683 The definition must end with
10684 \begin_inset Flex Code
10687 \begin_layout Plain Layout
10694 So a command with two optional arguments has:
10695 \begin_inset Separator parbreak
10702 \begin_layout Quote
10708 \begin_layout Quote
10714 \begin_layout Quote
10720 \begin_layout Quote
10726 \begin_layout Quote
10732 \begin_layout Quote
10738 \begin_layout Standard
10740 \begin_inset Flex Code
10743 \begin_layout Plain Layout
10749 definition, the following specifications are possible:
10752 \begin_layout Itemize
10753 \begin_inset Flex Code
10756 \begin_layout Plain Layout
10763 \begin_inset Flex Code
10766 \begin_layout Plain Layout
10772 The string that will appear both in the menu (to insert this argument)
10773 and on the argument inset button (unless you also specify a separate
10774 \begin_inset Flex Code
10777 \begin_layout Plain Layout
10784 For the menu, you can define an accelerator by appending the respective
10785 character to the string, divided by
10786 \begin_inset Quotes eld
10790 \begin_inset Quotes erd
10794 \begin_inset space \thinspace{}
10798 \begin_inset space \space{}
10802 \begin_inset Quotes eld
10806 \begin_inset Flex Code
10809 \begin_layout Plain Layout
10816 \begin_inset Quotes erd
10822 \begin_layout Itemize
10823 \begin_inset Flex Code
10826 \begin_layout Plain Layout
10833 \begin_inset Flex Code
10836 \begin_layout Plain Layout
10842 A separate string for the menu.
10843 You can define an accelerator by appending the respective character to
10844 the string, divided by
10845 \begin_inset Quotes eld
10849 \begin_inset Quotes erd
10853 \begin_inset space \thinspace{}
10857 \begin_inset space \space{}
10861 \begin_inset Quotes eld
10865 \begin_inset Flex Code
10868 \begin_layout Plain Layout
10875 \begin_inset Quotes erd
10879 This specification is optional.
10880 If it is not given the
10881 \begin_inset Flex Code
10884 \begin_layout Plain Layout
10890 will be used instead for the menu.
10893 \begin_layout Itemize
10894 \begin_inset Flex Code
10897 \begin_layout Plain Layout
10904 \begin_inset Flex Code
10907 \begin_layout Plain Layout
10913 A longer explanatory text that appears in the tooltip when hovering over
10914 the argument inset.
10917 \begin_layout Itemize
10918 \begin_inset Flex Code
10921 \begin_layout Plain Layout
10928 \begin_inset Flex Code
10931 \begin_layout Plain Layout
10940 \begin_inset space \thinspace{}
10944 \begin_inset Flex Code
10947 \begin_layout Plain Layout
10953 ] Declare if this is a mandatory (1) or an optional (0) argument.
10954 Mandatory arguments will be output empty if not given, while optional arguments
10955 will not be output at all.
10956 By default, mandatory arguments are delimited by
10957 \begin_inset Flex Code
10960 \begin_layout Plain Layout
10966 , while optional arguments are delimited by
10967 \begin_inset Flex Code
10970 \begin_layout Plain Layout
10979 \begin_layout Itemize
10980 \begin_inset Flex Code
10983 \begin_layout Plain Layout
10990 \begin_inset Flex Code
10993 \begin_layout Plain Layout
10999 defines another argument (by its number) which this argument requires to
11000 be output if it is itself output.
11002 \begin_inset space \thinspace{}
11005 g., in \SpecialChar LaTeX
11006 commands, optional arguments often require previous optional arguments
11007 to be output (at least empty), as in
11008 \begin_inset Flex Code
11011 \begin_layout Plain Layout
11014 command[][argument]{text}
11020 This can be achieved by the statement
11021 \begin_inset Flex Code
11024 \begin_layout Plain Layout
11031 \begin_inset Flex Code
11034 \begin_layout Plain Layout
11043 \begin_layout Itemize
11044 \begin_inset Flex Code
11047 \begin_layout Plain Layout
11054 \begin_inset Flex Code
11057 \begin_layout Plain Layout
11063 defines a custom left delimiter (instead of
11064 \begin_inset Flex Code
11067 \begin_layout Plain Layout
11074 \begin_inset Flex Code
11077 \begin_layout Plain Layout
11084 A line break in the output can be indicated by
11085 \begin_inset Flex Code
11088 \begin_layout Plain Layout
11097 \begin_layout Itemize
11098 \begin_inset Flex Code
11101 \begin_layout Plain Layout
11108 \begin_inset Flex Code
11111 \begin_layout Plain Layout
11117 defines a custom right delimiter (instead of
11118 \begin_inset Flex Code
11121 \begin_layout Plain Layout
11128 \begin_inset Flex Code
11131 \begin_layout Plain Layout
11138 A line break in the output can be indicated by
11139 \begin_inset Flex Code
11142 \begin_layout Plain Layout
11151 \begin_layout Itemize
11152 \begin_inset Flex Code
11155 \begin_layout Plain Layout
11162 \begin_inset Flex Code
11165 \begin_layout Plain Layout
11171 defines an argument that is inserted if and only if no user-specified arguments
11173 \begin_inset space \thinspace{}
11177 \begin_inset space \space{}
11180 if no argument inset has been inserted (note that also an empty argument
11181 inset omits the DefaultArg).
11182 Multiple arguments need to be separated by comma.
11185 \begin_layout Itemize
11186 \begin_inset Flex Code
11189 \begin_layout Plain Layout
11196 \begin_inset Flex Code
11199 \begin_layout Plain Layout
11205 defines an argument that is inserted in any case (alone or in addition
11206 to user-specified arguments).
11207 Multiple arguments need to be separated by comma.
11210 \begin_layout Itemize
11211 \begin_inset Flex Code
11214 \begin_layout Plain Layout
11220 The font used for the argument content, see
11221 \begin_inset CommandInset ref
11223 reference "subsec:Font-description"
11230 \begin_layout Itemize
11231 \begin_inset Flex Code
11234 \begin_layout Plain Layout
11240 The font used for the label; see
11241 \begin_inset CommandInset ref
11243 reference "subsec:Font-description"
11250 \begin_layout Itemize
11251 \begin_inset Flex Code
11254 \begin_layout Plain Layout
11261 \begin_inset Flex Code
11264 \begin_layout Plain Layout
11269 , Minimalistic, Conglomerate
11274 ] describes the rendering style used for the inset's frame and buttons.
11277 \begin_layout Itemize
11278 \begin_inset Flex Code
11281 \begin_layout Plain Layout
11288 \begin_inset Flex Code
11291 \begin_layout Plain Layout
11298 \begin_inset Flex Code
11301 \begin_layout Plain Layout
11307 , this argument is automatically inserted when the respective style is selected.
11308 Currently, only one argument per style\SpecialChar breakableslash
11309 layout can be automatically inserted.
11310 \change_inserted -712698321 1431166542
11314 \begin_layout Itemize
11316 \change_inserted -712698321 1431166604
11317 \begin_inset Flex Code
11320 \begin_layout Plain Layout
11322 \change_inserted -712698321 1431166548
11329 \begin_inset Flex Code
11332 \begin_layout Plain Layout
11334 \change_inserted -712698321 1431166543
11341 \begin_inset Flex Code
11344 \begin_layout Plain Layout
11346 \change_inserted -712698321 1431166543
11352 , this argument will be inserted with a copy of the co-text (either selected
11353 text or the whole paragraph) as content.
11356 \begin_layout Itemize
11358 \change_inserted -712698321 1431070588
11359 \begin_inset Flex Code
11362 \begin_layout Plain Layout
11364 \change_inserted -712698321 1431070522
11371 \begin_inset Flex Code
11374 \begin_layout Plain Layout
11376 \change_inserted -712698321 1431070522
11377 string of characters
11386 Defines individual characters that should be output in raw form, meaning
11387 without special translations that \SpecialChar LaTeX
11389 Note that, contrary to PassThru, this needs to be explicitly defined for
11391 That is, arguments do not inherit PassThruChars from their parent inset
11397 \begin_layout Standard
11398 By default, the text entered in the \SpecialChar LyX
11399 workarea in the respective layout is
11400 the last (mandatory) argument of a command if the
11401 \begin_inset Flex Code
11404 \begin_layout Plain Layout
11411 \begin_inset Flex Code
11414 \begin_layout Plain Layout
11421 However, arguments with the prefix
11422 \begin_inset Flex Code
11425 \begin_layout Plain Layout
11431 are output after this workarea argument.
11432 Note that post-argument numbering restarts at 1, so the first argument
11433 following the workarea argument is
11434 \begin_inset Flex Code
11437 \begin_layout Plain Layout
11444 Post-arguments are ignored in any other
11445 \begin_inset Flex Code
11448 \begin_layout Plain Layout
11455 \begin_inset Flex Code
11458 \begin_layout Plain Layout
11467 \begin_layout Standard
11469 \begin_inset Flex Code
11472 \begin_layout Plain Layout
11481 \begin_inset Flex Code
11484 \begin_layout Plain Layout
11493 \begin_inset Flex Code
11496 \begin_layout Plain Layout
11502 followed by the number (e.
11503 \begin_inset space \thinspace{}
11507 \begin_inset space \space{}
11511 \begin_inset Flex Code
11514 \begin_layout Plain Layout
11524 \begin_layout Description
11525 \begin_inset Flex Code
11528 \begin_layout Plain Layout
11534 Note that this will completely override any prior
11535 \begin_inset Flex Code
11538 \begin_layout Plain Layout
11544 declaration for this style.
11546 \begin_inset Quotes eld
11550 \begin_inset Flex Code
11553 \begin_layout Plain Layout
11560 \begin_inset Quotes erd
11565 \begin_inset CommandInset ref
11567 reference "subsec:I18n"
11571 for details on its use.
11574 \begin_layout Description
11575 \begin_inset Flex Code
11578 \begin_layout Plain Layout
11585 \begin_inset Flex Code
11588 \begin_layout Plain Layout
11598 \begin_layout Plain Layout
11599 Note that a `float' here is a real number, such as: 1.5.
11604 The vertical space with which the last of a chain of paragraphs with this
11605 style is separated from the following paragraph.
11606 If the next paragraph has another style, the separations are not simply
11607 added, but the maximum is taken.
11610 \begin_layout Description
11611 \begin_inset Flex Code
11614 \begin_layout Plain Layout
11621 \begin_inset Flex Code
11624 \begin_layout Plain Layout
11630 ] The category for this style.
11631 This is used to group related styles in the style combobox on the toolbar.
11632 Any string can be used, but you may want to use existing categories with
11637 \begin_layout Description
11638 \begin_inset Flex Code
11641 \begin_layout Plain Layout
11647 Depth of XML command.
11648 Used only with XML-type formats.
11651 \begin_layout Description
11652 \begin_inset Flex Code
11655 \begin_layout Plain Layout
11662 \begin_inset Flex Code
11665 \begin_layout Plain Layout
11671 ] Copies all the features of an existing style into the current one.
11675 \begin_layout Description
11676 \begin_inset Flex Code
11679 \begin_layout Plain Layout
11686 \begin_inset Flex Code
11689 \begin_layout Plain Layout
11695 ] The name of a style whose preamble should be output
11700 This allows to ensure some ordering of the preamble snippets when macros
11701 definitions depend on one another.
11705 \begin_layout Plain Layout
11706 Note that, besides that functionality, there is no way to ensure any ordering
11708 The ordering that you see in a given version of \SpecialChar LyX
11709 may change without warning
11718 \begin_layout Description
11719 \begin_inset Flex Code
11722 \begin_layout Plain Layout
11729 \begin_inset Flex Code
11732 \begin_layout Plain Layout
11737 , Box, Filled_Box, Static
11742 ] The type of label that stands at the end of the paragraph (or sequence
11744 \begin_inset Flex Code
11747 \begin_layout Plain Layout
11754 \begin_inset Newline newline
11758 \begin_inset Flex Code
11761 \begin_layout Plain Layout
11768 \begin_inset Flex Code
11771 \begin_layout Plain Layout
11778 \begin_inset Flex Code
11781 \begin_layout Plain Layout
11789 \begin_inset Flex Code
11792 \begin_layout Plain Layout
11799 \begin_inset Quotes eld
11803 \begin_inset Quotes erd
11807 \begin_inset Flex Code
11810 \begin_layout Plain Layout
11817 \begin_inset space \space{}
11821 \begin_inset Flex Code
11824 \begin_layout Plain Layout
11830 ) is a white (resp.
11831 \begin_inset space ~
11834 black) square suitable for end of proof markers,
11835 \begin_inset Flex Code
11838 \begin_layout Plain Layout
11844 is an explicit text string.
11847 \begin_layout Description
11848 \begin_inset Flex Code
11851 \begin_layout Plain Layout
11858 \begin_inset Flex Code
11861 \begin_layout Plain Layout
11867 ] The string used for a label with a
11868 \begin_inset Flex Code
11871 \begin_layout Plain Layout
11878 \begin_inset Newline newline
11882 \begin_inset Flex Code
11885 \begin_layout Plain Layout
11895 \begin_layout Description
11896 \begin_inset Flex Code
11899 \begin_layout Plain Layout
11905 The font used for both the text body
11911 \begin_inset CommandInset ref
11913 reference "subsec:Font-description"
11918 Note that defining this font automatically defines the
11919 \begin_inset Flex Code
11922 \begin_layout Plain Layout
11929 So you should define this one first if you also want to define
11930 \begin_inset Flex Code
11933 \begin_layout Plain Layout
11942 \begin_layout Description
11943 \begin_inset Flex Code
11946 \begin_layout Plain Layout
11953 \begin_inset Flex Code
11956 \begin_layout Plain Layout
11962 ] Used for backporting new styles to stable \SpecialChar LyX
11964 The first stable version that supports this tag is \SpecialChar LyX
11966 The argument is a number which may either be 0, -1 or any value greater
11969 \begin_inset Flex Code
11972 \begin_layout Plain Layout
11978 flag of a style is greater than zero, it will always be written to the
11980 If a .lyx file is read, the style definitions from the document header are
11981 added to the document class.
11982 Therefore even older \SpecialChar LyX
11983 versions can handle the style.
11985 \begin_inset Flex Code
11988 \begin_layout Plain Layout
11994 is a version number: If the style is read, and the version number is less
11995 than the version number of the already existing style in the document class,
11996 the new style is ignored.
11997 If the version number is greater, the new style replaces the existing style.
11998 A value of -1 means an infinite version number, i.
11999 \begin_inset space \thinspace{}
12003 \begin_inset space \space{}
12006 the style is always used.
12009 \begin_layout Description
12010 \begin_inset Flex Code
12013 \begin_layout Plain Layout
12020 \begin_inset Flex Code
12023 \begin_layout Plain Layout
12032 \begin_inset space \thinspace{}
12036 \begin_inset Flex Code
12039 \begin_layout Plain Layout
12045 ] Usually \SpecialChar LyX
12046 does not allow you to insert more than one space between words,
12047 since a space is considered as the separation between two words, not a
12048 character or symbol of its own.
12049 This is a very fine thing but sometimes annoying, for example, when typing
12050 program code or plain \SpecialChar LaTeX
12053 \begin_inset Flex Code
12056 \begin_layout Plain Layout
12063 Note that \SpecialChar LyX
12064 will create protected blanks for the additional blanks when
12065 in another mode than \SpecialChar LaTeX
12069 \begin_layout Description
12070 \begin_inset Flex Code
12073 \begin_layout Plain Layout
12079 These tags are used with XHTML output.
12081 \begin_inset CommandInset ref
12083 reference "subsec:Paragraph-Style-XHTML"
12090 \begin_layout Description
12091 \begin_inset Flex Code
12094 \begin_layout Plain Layout
12100 [FIXME] (Used only with XML-type formats.)
12103 \begin_layout Description
12104 \begin_inset Flex Code
12107 \begin_layout Plain Layout
12114 \begin_inset Flex Code
12117 \begin_layout Plain Layout
12126 \begin_inset space \thinspace{}
12130 \begin_inset Flex Code
12133 \begin_layout Plain Layout
12140 \begin_inset Flex Code
12143 \begin_layout Plain Layout
12149 , marks the style as to be included in the document preamble and not in
12151 This is useful for document classes that want such information as the title
12152 and author to appear in the preamble.
12153 Note that this works only for styles for which the
12154 \begin_inset Flex Code
12157 \begin_layout Plain Layout
12164 \begin_inset Flex Code
12167 \begin_layout Plain Layout
12174 \begin_inset Flex Code
12177 \begin_layout Plain Layout
12186 \begin_layout Description
12187 \begin_inset Flex Code
12190 \begin_layout Plain Layout
12197 \begin_inset Flex Code
12200 \begin_layout Plain Layout
12209 \begin_inset space \thinspace{}
12213 \begin_inset Flex Code
12216 \begin_layout Plain Layout
12223 \begin_inset Flex Code
12226 \begin_layout Plain Layout
12232 , marks the style as being part of a title block (see also the
12233 \begin_inset Flex Code
12236 \begin_layout Plain Layout
12243 \begin_inset Flex Code
12246 \begin_layout Plain Layout
12255 \begin_layout Description
12256 \begin_inset Flex Code
12259 \begin_layout Plain Layout
12266 \begin_inset Flex Code
12269 \begin_layout Plain Layout
12275 ] The \SpecialChar LaTeX
12276 command sequence declaring an item in a list.
12277 The command is to be defined without the preceding backslash (the default
12279 \begin_inset Quotes eld
12283 \begin_inset Quotes erd
12287 \begin_inset Flex Code
12290 \begin_layout Plain Layout
12298 in the \SpecialChar LaTeX
12302 \begin_layout Description
12303 \begin_inset Flex Code
12306 \begin_layout Plain Layout
12313 \begin_inset Flex Code
12316 \begin_layout Plain Layout
12322 ] This provides extra space between paragraphs that have the same style.
12323 If you put other styles into an environment, each is separated with the
12325 \begin_inset Flex Code
12328 \begin_layout Plain Layout
12335 But the whole items of the environment are additionally separated with
12337 \begin_inset Flex Code
12340 \begin_layout Plain Layout
12347 Note that this is a
12352 \begin_layout Description
12353 \begin_inset Flex Code
12356 \begin_layout Plain Layout
12362 [FIXME] (Used only with XML-type formats.)
12365 \begin_layout Description
12366 \begin_inset Flex Code
12369 \begin_layout Plain Layout
12376 \begin_inset Flex Code
12379 \begin_layout Plain Layout
12388 \begin_inset space \thinspace{}
12392 \begin_inset Flex Code
12395 \begin_layout Plain Layout
12401 ] Usually \SpecialChar LyX
12402 does not allow you to leave a paragraph empty, since it would
12403 lead to empty \SpecialChar LaTeX
12405 There are some cases where this could be desirable however: in a letter
12406 template, the required fields can be provided as empty fields, so that
12407 people do not forget them; in some special classes, a style can be used
12408 as some kind of break, which does not contain actual text.
12411 \begin_layout Description
12412 \begin_inset Flex Code
12415 \begin_layout Plain Layout
12422 \begin_inset Flex Code
12425 \begin_layout Plain Layout
12431 ] The vertical space between the label and the text body.
12432 Only used for labels that are above the text body (
12433 \begin_inset Flex Code
12436 \begin_layout Plain Layout
12443 \begin_inset Newline newline
12447 \begin_inset Flex Code
12450 \begin_layout Plain Layout
12451 Centered_Top_Environment
12459 \begin_layout Description
12460 \begin_inset Flex Code
12463 \begin_layout Plain Layout
12470 \begin_inset Flex Code
12473 \begin_layout Plain Layout
12479 ] The name of the counter for automatic numbering.
12480 In order to have the counter appear with your label, you will need to reference
12482 \begin_inset Flex Code
12485 \begin_layout Plain Layout
12494 This will work with
12495 \begin_inset Flex Code
12498 \begin_layout Plain Layout
12505 \begin_inset Flex Code
12508 \begin_layout Plain Layout
12515 \begin_inset Flex Code
12518 \begin_layout Plain Layout
12525 \begin_inset Flex Code
12528 \begin_layout Plain Layout
12535 \begin_inset Newline newline
12543 \begin_inset Flex Code
12546 \begin_layout Plain Layout
12553 \begin_inset Flex Code
12556 \begin_layout Plain Layout
12562 , though this case is a bit complicated.
12563 Suppose you declare
12564 \begin_inset Quotes eld
12568 \begin_inset Flex Code
12571 \begin_layout Plain Layout
12572 LabelCounter myenum
12578 \begin_inset Quotes erd
12582 Then the actual counters used are
12583 \begin_inset Flex Code
12586 \begin_layout Plain Layout
12593 \begin_inset Flex Code
12596 \begin_layout Plain Layout
12603 \begin_inset Flex Code
12606 \begin_layout Plain Layout
12613 \begin_inset Flex Code
12616 \begin_layout Plain Layout
12622 , much as in \SpecialChar LaTeX
12624 These counters must all be declared separately.
12625 \begin_inset Newline newline
12629 \begin_inset CommandInset ref
12631 reference "subsec:Counters"
12635 for details on counters.
12638 \begin_layout Description
12639 \begin_inset Flex Code
12642 \begin_layout Plain Layout
12648 The font used for the label.
12650 \begin_inset CommandInset ref
12652 reference "subsec:Font-description"
12659 \begin_layout Description
12660 \begin_inset Flex Code
12663 \begin_layout Plain Layout
12670 \begin_inset Flex Code
12673 \begin_layout Plain Layout
12679 ] Text that indicates how far a label should be indented.
12682 \begin_layout Description
12683 \begin_inset Flex Code
12686 \begin_layout Plain Layout
12693 \begin_inset Flex Code
12696 \begin_layout Plain Layout
12702 ] Text that indicates the amount of horizontal space between the label and
12704 Only used for labels that are not above the text body.
12707 \begin_layout Description
12708 \begin_inset Flex Code
12711 \begin_layout Plain Layout
12718 \begin_inset Flex Code
12721 \begin_layout Plain Layout
12727 ] The string used for the label.
12729 \begin_inset Flex Code
12732 \begin_layout Plain Layout
12738 is set, this string can be contain the special formatting commands described
12740 \begin_inset CommandInset ref
12742 reference "subsec:Counters"
12749 \begin_layout Description
12750 \begin_inset Flex Code
12753 \begin_layout Plain Layout
12754 LabelStringAppendix
12760 \begin_inset Flex Code
12763 \begin_layout Plain Layout
12769 ] This is used inside the appendix instead of
12770 \begin_inset Newline newline
12774 \begin_inset Flex Code
12777 \begin_layout Plain Layout
12785 \begin_inset Flex Code
12788 \begin_layout Plain Layout
12795 \begin_inset Newline newline
12799 \begin_inset Flex Code
12802 \begin_layout Plain Layout
12803 LabelStringAppendix
12811 \begin_layout Description
12812 \begin_inset Flex Code
12815 \begin_layout Plain Layout
12821 [FIXME] (Used only with XML-type formats.)
12824 \begin_layout Description
12825 \begin_inset Flex Code
12828 \begin_layout Plain Layout
12835 \begin_inset Flex Code
12838 \begin_layout Plain Layout
12843 , Manual, Static, Above,
12844 \begin_inset Newline newline
12847 Centered, Sensitive, Enumerate,
12848 \begin_inset Newline newline
12851 Itemize, Bibliography
12857 \begin_inset Separator parbreak
12864 \begin_layout Description
12865 \begin_inset Flex Code
12868 \begin_layout Plain Layout
12874 means the label is the very first word (up to the first real blank).
12875 Use protected spaces if you want more than one word as the label.
12879 \begin_layout Description
12880 \begin_inset Flex Code
12883 \begin_layout Plain Layout
12889 means the label is simply what is declared as
12890 \begin_inset Flex Code
12893 \begin_layout Plain Layout
12900 This will be displayed
12901 \begin_inset Quotes eld
12905 \begin_inset Quotes erd
12908 , at the beginning of the paragraph.
12910 \begin_inset Flex Code
12913 \begin_layout Plain Layout
12920 \begin_inset Flex Code
12923 \begin_layout Plain Layout
12929 , then it will be displayed only in the first paragraph of any sequence
12930 of paragraphs with the same
12931 \begin_inset Flex Code
12934 \begin_layout Plain Layout
12943 \begin_layout Description
12944 \begin_inset Flex Code
12947 \begin_layout Plain Layout
12954 \begin_inset space ~
12958 \begin_inset space ~
12962 \begin_inset Flex Code
12965 \begin_layout Plain Layout
12971 are special cases of
12972 \begin_inset Flex Code
12975 \begin_layout Plain Layout
12982 The label will be printed above the paragraph either at the beginning of
12983 the line or centered.
12986 \begin_layout Description
12987 \begin_inset Flex Code
12990 \begin_layout Plain Layout
12996 is a special case for the caption-labels
12997 \begin_inset Quotes eld
13001 \begin_inset Quotes erd
13005 \begin_inset Quotes eld
13009 \begin_inset Quotes erd
13013 \begin_inset Newline newline
13017 \begin_inset Flex Code
13020 \begin_layout Plain Layout
13026 means the (hardcoded) label string depends on the kind of float: It is
13027 hardcoded to be `FloatType N', where N is the value of the counter associated
13029 For the case that a caption is inserted outside of a float the
13030 \begin_inset Flex Code
13033 \begin_layout Plain Layout
13040 \begin_inset Quotes eld
13044 \begin_inset Quotes erd
13050 \begin_layout Description
13051 \begin_inset Flex Code
13054 \begin_layout Plain Layout
13060 produces the usual sort of enumeration labels.
13061 At present, it is hardcoded to use Arabic numerals, lowercase letters,
13062 small Roman numerals, and uppercase letters for the four possible depths.
13065 \begin_layout Description
13066 \begin_inset Flex Code
13069 \begin_layout Plain Layout
13075 produces various bullets at the different levels.
13076 It is also hardcoded.
13079 \begin_layout Description
13080 \begin_inset Flex Code
13083 \begin_layout Plain Layout
13089 should be used only with
13090 \begin_inset Flex Code
13093 \begin_layout Plain Layout
13094 LatexType BibEnvironment
13103 \begin_layout Description
13104 \begin_inset Flex Code
13107 \begin_layout Plain Layout
13113 Note that this will completely override any prior
13114 \begin_inset Flex Code
13117 \begin_layout Plain Layout
13123 declaration for this style.
13125 \begin_inset Quotes eld
13129 \begin_inset Flex Code
13132 \begin_layout Plain Layout
13139 \begin_inset Quotes erd
13144 \begin_inset CommandInset ref
13146 reference "subsec:I18n"
13150 for details on its use.
13153 \begin_layout Description
13154 \begin_inset Flex Code
13157 \begin_layout Plain Layout
13164 \begin_inset Flex Code
13167 \begin_layout Plain Layout
13173 ] The name of the corresponding \SpecialChar LaTeX
13175 Either the environment or command name.
13178 \begin_layout Description
13179 \begin_inset Flex Code
13182 \begin_layout Plain Layout
13189 \begin_inset Flex Code
13192 \begin_layout Plain Layout
13198 ] An optional parameter for the corresponding
13199 \begin_inset Flex Code
13202 \begin_layout Plain Layout
13209 This parameter cannot be changed from within \SpecialChar LyX
13211 \begin_inset Flex Code
13214 \begin_layout Plain Layout
13220 for customizable parameters).
13221 This will be output as is after all \SpecialChar LaTeX
13223 \begin_inset Flex Code
13226 \begin_layout Plain Layout
13235 \begin_layout Description
13236 \begin_inset Flex Code
13239 \begin_layout Plain Layout
13246 \begin_inset Flex Code
13249 \begin_layout Plain Layout
13254 , Command, Environment, Item_Environment,
13255 \begin_inset Newline newline
13258 List_Environment, Bib_Environment
13263 ] How the style should be translated into \SpecialChar LaTeX
13268 \begin_layout Plain Layout
13269 \begin_inset Flex Code
13272 \begin_layout Plain Layout
13278 is perhaps a bit misleading, since these rules apply to SGML classes, too.
13279 Visit the SGML class files for specific examples.
13285 \begin_inset Separator parbreak
13292 \begin_layout Description
13293 \begin_inset Flex Code
13296 \begin_layout Plain Layout
13302 means nothing special.
13305 \begin_layout Description
13306 \begin_inset Flex Code
13309 \begin_layout Plain Layout
13316 \begin_inset Flex Code
13319 \begin_layout Plain Layout
13326 {\SpecialChar ldots
13335 \begin_layout Description
13336 \begin_inset Flex Code
13339 \begin_layout Plain Layout
13346 \begin_inset Flex Code
13349 \begin_layout Plain Layout
13356 }\SpecialChar ldots
13372 \begin_layout Description
13373 \begin_inset Flex Code
13376 \begin_layout Plain Layout
13383 \begin_inset Flex Code
13386 \begin_layout Plain Layout
13393 \begin_inset Flex Code
13396 \begin_layout Plain Layout
13404 is generated for each paragraph of this environment.
13408 \begin_layout Description
13409 \begin_inset Flex Code
13412 \begin_layout Plain Layout
13419 \begin_inset Flex Code
13422 \begin_layout Plain Layout
13429 \begin_inset Newline newline
13433 \begin_inset Flex Code
13436 \begin_layout Plain Layout
13442 is passed as an argument to the environment.
13443 \begin_inset Newline newline
13447 \begin_inset Flex Code
13450 \begin_layout Plain Layout
13456 can be defined in the
13457 \begin_inset Flex MenuItem
13460 \begin_layout Plain Layout
13461 Edit\SpecialChar menuseparator
13463 \begin_inset space ~
13474 \begin_layout Description
13475 \begin_inset Flex Code
13478 \begin_layout Plain Layout
13485 \begin_inset Flex Code
13488 \begin_layout Plain Layout
13494 but adds additionally the necessary mandatory argument (the longest label)
13495 to the begin statement of the bibliography environment:
13496 \begin_inset Newline newline
13500 \begin_inset Flex Code
13503 \begin_layout Plain Layout
13506 begin{thebibliography}{99}
13511 It is therefore only useful for bibliography environments.
13512 The default longest label
13513 \begin_inset Quotes eld
13517 \begin_inset Quotes erd
13520 can be changed by the user in the paragraph settings of a bibliography
13524 \begin_layout Standard
13525 Putting the last few things together, the \SpecialChar LaTeX
13526 output will be either:
13529 \begin_layout LyX-Code
13532 LatexName[LatexParam]{\SpecialChar ldots
13536 \begin_layout Standard
13540 \begin_layout LyX-Code
13543 begin{LatexName}[LatexParam] \SpecialChar ldots
13549 \begin_layout Standard
13550 depending upon the \SpecialChar LaTeX
13555 \begin_layout Description
13556 \begin_inset Flex Code
13559 \begin_layout Plain Layout
13566 \begin_inset Flex Code
13569 \begin_layout Plain Layout
13575 ] A string that is put at the beginning of the style content.
13576 A line break in the output can be indicated by
13577 \begin_inset Flex Code
13580 \begin_layout Plain Layout
13589 \begin_layout Description
13590 \begin_inset Flex Code
13593 \begin_layout Plain Layout
13600 \begin_inset Flex Code
13603 \begin_layout Plain Layout
13609 ] If you put styles into environments, the different
13610 \begin_inset Flex Code
13613 \begin_layout Plain Layout
13619 are not simply added, but added with a factor
13620 \begin_inset Formula $\frac{4}{\mathrm{depth}+4}$
13624 Note that this parameter is also used when
13625 \begin_inset Flex Code
13628 \begin_layout Plain Layout
13635 \begin_inset Flex Code
13638 \begin_layout Plain Layout
13645 \begin_inset Flex Code
13648 \begin_layout Plain Layout
13655 Then it is added to the manual or dynamic margin.
13656 \begin_inset Newline newline
13660 \begin_inset Quotes eld
13664 \begin_inset Flex Code
13667 \begin_layout Plain Layout
13674 \begin_inset Quotes erd
13677 means that the paragraph is indented with the width of
13678 \begin_inset Quotes eld
13682 \begin_inset Flex Code
13685 \begin_layout Plain Layout
13692 \begin_inset Quotes erd
13695 in the normal font.
13696 You can get a negative width by prefixing the string with
13697 \begin_inset Quotes eld
13701 \begin_inset Flex Code
13704 \begin_layout Plain Layout
13711 \begin_inset Quotes erd
13715 This way was chosen so that the look is the same with each used screen
13719 \begin_layout Description
13720 \begin_inset Flex Code
13723 \begin_layout Plain Layout
13730 \begin_inset Flex Code
13733 \begin_layout Plain Layout
13738 , Manual, Dynamic, First_Dynamic, Right_Address_Box
13744 \begin_inset Newline newline
13747 The kind of margin that the style has on the left side.
13748 \begin_inset Separator parbreak
13755 \begin_layout Description
13756 \begin_inset Flex Code
13759 \begin_layout Plain Layout
13765 just means a fixed margin.
13768 \begin_layout Description
13769 \begin_inset Flex Code
13772 \begin_layout Plain Layout
13778 means that the left margin depends on the string entered in the
13779 \begin_inset Flex MenuItem
13782 \begin_layout Plain Layout
13783 Edit\SpecialChar menuseparator
13785 \begin_inset space ~
13794 This is used to typeset nice lists without tabulators.
13797 \begin_layout Description
13798 \begin_inset Flex Code
13801 \begin_layout Plain Layout
13807 means that the margin depends on the size of the label.
13808 This is used for automatic enumerated headlines.
13809 It is obvious that the headline
13810 \begin_inset Quotes eld
13813 5.4.3.2.1 Very long headline
13814 \begin_inset Quotes erd
13817 must have a wider left margin (as wide as
13818 \begin_inset Quotes eld
13822 \begin_inset Quotes erd
13825 plus the space) than
13826 \begin_inset Quotes eld
13829 3.2 Very long headline
13830 \begin_inset Quotes erd
13834 \begin_inset Quotes eld
13838 \begin_inset Quotes erd
13841 are not able to do this.
13844 \begin_layout Description
13845 \begin_inset Flex Code
13848 \begin_layout Plain Layout
13854 is similar, but only the very first row of the paragraph is dynamic, while
13855 the others are static; this is used, for example, for descriptions.
13858 \begin_layout Description
13859 \begin_inset Flex Code
13862 \begin_layout Plain Layout
13868 means the margin is chosen in a way that the longest row of this paragraph
13869 fits to the right margin.
13870 This is used to typeset an address on the right edge of the page.
13874 \begin_layout Description
13875 \begin_inset Flex Code
13878 \begin_layout Plain Layout
13885 \begin_inset Flex Code
13888 \begin_layout Plain Layout
13897 \begin_inset space \thinspace{}
13901 \begin_inset Flex Code
13904 \begin_layout Plain Layout
13910 ] Whether fragile commands in this style should be
13911 \begin_inset Flex Code
13914 \begin_layout Plain Layout
13927 whether this command should itself be protected.)
13930 \begin_layout Description
13931 \begin_inset Flex Code
13934 \begin_layout Plain Layout
13941 \begin_inset Flex Code
13944 \begin_layout Plain Layout
13951 \begin_inset space \thinspace{}
13955 \begin_inset Flex Code
13958 \begin_layout Plain Layout
13966 ] Whether newlines are translated into \SpecialChar LaTeX
13968 \begin_inset Flex Code
13971 \begin_layout Plain Layout
13982 The translation can be switched off to allow more comfortable \SpecialChar LaTeX
13984 inside \SpecialChar LyX
13988 \begin_layout Description
13989 \begin_inset Flex Code
13992 \begin_layout Plain Layout
13999 \begin_inset Flex Code
14002 \begin_layout Plain Layout
14011 \begin_inset space \thinspace{}
14015 \begin_inset Flex Code
14018 \begin_layout Plain Layout
14024 ] If set to true, and if
14025 \begin_inset Flex Code
14028 \begin_layout Plain Layout
14035 \begin_inset Flex Code
14038 \begin_layout Plain Layout
14044 ) paragraphs are being indented, then the indentation of such a paragraph
14045 following one of this type will be suppressed.
14046 (So this will not affect the display of non-default paragraphs.)
14049 \begin_layout Description
14050 \begin_inset Flex Code
14053 \begin_layout Plain Layout
14060 \begin_inset Flex Code
14063 \begin_layout Plain Layout
14069 ] Name of a style that has replaced this style.
14070 This is used to rename a style, while keeping backward compatibility.
14071 \change_inserted -712698321 1432986397
14075 \begin_layout Description
14077 \change_inserted -712698321 1432986583
14078 \begin_inset Flex Code
14081 \begin_layout Plain Layout
14083 \change_inserted -712698321 1432986403
14090 \begin_inset Flex Code
14093 \begin_layout Plain Layout
14095 \change_inserted -712698321 1432986397
14102 \begin_inset space \thinspace{}
14106 \begin_inset Flex Code
14109 \begin_layout Plain Layout
14111 \change_inserted -712698321 1432986397
14117 ] Determines whether consecutive pragraphs of the same type are treated
14118 as belonging together.
14119 This has the effect that the
14120 \begin_inset Flex Code
14123 \begin_layout Plain Layout
14125 \change_inserted -712698321 1432986460
14131 is only printed once before such a group.
14132 By default, this is true for
14133 \begin_inset Flex Code
14136 \begin_layout Plain Layout
14138 \change_inserted -712698321 1432986491
14145 \begin_inset Flex Code
14148 \begin_layout Plain Layout
14150 \change_inserted -712698321 1432986583
14159 \begin_inset Flex Code
14162 \begin_layout Plain Layout
14164 \change_inserted -712698321 1432986572
14172 and false for all other types.
14177 \begin_layout Description
14178 \begin_inset Flex Code
14181 \begin_layout Plain Layout
14188 \begin_inset Flex Code
14191 \begin_layout Plain Layout
14200 \begin_inset space \thinspace{}
14204 \begin_inset Flex Code
14207 \begin_layout Plain Layout
14213 ] Indicates that paragraphs will not be separated by an empty line in \SpecialChar LaTeX
14215 but only by a line break; together with
14216 \begin_inset Flex Code
14219 \begin_layout Plain Layout
14225 , this allows to emulate a plain text editor (like the ERT inset).
14228 \begin_layout Description
14229 \begin_inset Flex Code
14232 \begin_layout Plain Layout
14239 \begin_inset Flex Code
14242 \begin_layout Plain Layout
14248 ] The indent of the very first line of a paragraph.
14250 \begin_inset Newline newline
14254 \begin_inset Flex Code
14257 \begin_layout Plain Layout
14263 will be fixed for a certain style.
14264 The exception is the default style, since the indentation for these paragraphs
14265 can be prohibited with
14266 \begin_inset Flex Code
14269 \begin_layout Plain Layout
14277 \begin_inset Flex Code
14280 \begin_layout Plain Layout
14286 style paragraphs inside environments use the
14287 \begin_inset Flex Code
14290 \begin_layout Plain Layout
14296 of the environment, not their native one.
14298 \begin_inset Flex Code
14301 \begin_layout Plain Layout
14307 paragraphs inside an enumeration are not indented.
14310 \begin_layout Description
14311 \begin_inset Flex Code
14314 \begin_layout Plain Layout
14321 \begin_inset Flex Code
14324 \begin_layout Plain Layout
14330 ] The vertical space between two paragraphs of this style.
14333 \begin_layout Description
14334 \begin_inset Flex Code
14337 \begin_layout Plain Layout
14344 \begin_inset Flex Code
14347 \begin_layout Plain Layout
14354 allows the user to choose either
14355 \begin_inset Quotes eld
14359 \begin_inset Quotes erd
14363 \begin_inset Quotes eld
14367 \begin_inset Quotes erd
14370 to separate paragraphs.
14372 \begin_inset Quotes eld
14376 \begin_inset Quotes erd
14380 \begin_inset Flex Code
14383 \begin_layout Plain Layout
14391 \begin_inset Quotes eld
14395 \begin_inset Quotes erd
14399 \begin_inset Flex Code
14402 \begin_layout Plain Layout
14408 is ignored and all paragraphs are separated by the
14409 \begin_inset Flex Code
14412 \begin_layout Plain Layout
14419 The vertical space is calculated with
14420 \begin_inset Flex Code
14423 \begin_layout Plain Layout
14425 \begin_inset space ~
14434 \begin_inset Flex Code
14437 \begin_layout Plain Layout
14443 is the height of a row with the normal font.
14444 This way, the look stays the same with different screen fonts.
14447 \begin_layout Description
14448 \begin_inset Flex Code
14451 \begin_layout Plain Layout
14458 \begin_inset Flex Code
14461 \begin_layout Plain Layout
14470 \begin_inset space \thinspace{}
14474 \begin_inset Flex Code
14477 \begin_layout Plain Layout
14483 ] Whether the contents of this paragraph should be output in raw form, meaning
14484 without special translations that \SpecialChar LaTeX
14486 \change_inserted -712698321 1429534178
14490 \begin_layout Description
14492 \change_inserted -712698321 1429534242
14495 \begin_inset Flex Code
14498 \begin_layout Plain Layout
14500 \change_inserted -712698321 1429534178
14509 \begin_inset Flex Code
14512 \begin_layout Plain Layout
14514 \change_inserted -712698321 1429534178
14515 string of characters
14524 Defines individual characters that should be output in raw form, meaning
14525 without special translations that \SpecialChar LaTeX
14531 \begin_layout Description
14532 \begin_inset Flex Code
14535 \begin_layout Plain Layout
14541 Information to be included in the \SpecialChar LaTeX
14542 preamble when this style is used.
14543 Used to define macros, load packages, etc., required by this particular
14546 \begin_inset Quotes eld
14550 \begin_inset Flex Code
14553 \begin_layout Plain Layout
14560 \begin_inset Quotes erd
14566 \begin_layout Description
14567 \begin_inset Flex Code
14570 \begin_layout Plain Layout
14577 \begin_inset Flex Code
14580 \begin_layout Plain Layout
14586 ] The prefix to use when creating labels referring to paragraphs of this
14588 This allows the use of formatted references.
14591 \begin_layout Description
14592 \begin_inset Flex Code
14595 \begin_layout Plain Layout
14602 \begin_inset Flex Code
14605 \begin_layout Plain Layout
14611 ] Whether the style requires the feature
14612 \begin_inset Flex Code
14615 \begin_layout Plain Layout
14622 \change_deleted -712698321 1438601713
14627 \change_deleted -712698321 1438601638
14628 See the description of
14629 \begin_inset Flex Code
14632 \begin_layout Plain Layout
14639 \begin_inset CommandInset ref
14641 reference "subsec:General-text-class"
14645 ) for information on `features'.
14646 \change_inserted -712698321 1438601711
14648 \begin_inset CommandInset ref
14650 reference "chap:List-of-functions"
14654 for the list of features).
14655 If you require a package with specific options, you can additionally use
14657 \begin_inset Flex Code
14660 \begin_layout Plain Layout
14662 \change_inserted -712698321 1438601638
14668 as a general text class parameter (see sec.
14669 \begin_inset space ~
14673 \begin_inset CommandInset ref
14675 reference "subsec:General-text-class"
14684 \begin_layout Description
14685 \begin_inset Flex Code
14688 \begin_layout Plain Layout
14695 \begin_inset Flex Code
14698 \begin_layout Plain Layout
14707 \begin_inset Flex Code
14710 \begin_layout Plain Layout
14716 ] Resets the \SpecialChar LaTeX
14717 arguments of this style (as defined via the
14718 \begin_inset Flex Code
14721 \begin_layout Plain Layout
14728 This is useful if you have copied a style via
14729 \begin_inset Flex Code
14732 \begin_layout Plain Layout
14738 , but you do not want to inherit its (required and optional) arguments.
14741 \begin_layout Description
14742 \begin_inset Flex Code
14745 \begin_layout Plain Layout
14752 \begin_inset Flex Code
14755 \begin_layout Plain Layout
14761 ] A string that is put at the end of the layout content.
14762 A line break in the output can be indicated by
14763 \begin_inset Flex Code
14766 \begin_layout Plain Layout
14775 \begin_layout Description
14776 \begin_inset Flex Code
14779 \begin_layout Plain Layout
14786 \begin_inset Flex Code
14789 \begin_layout Plain Layout
14796 \begin_inset Flex Code
14799 \begin_layout Plain Layout
14808 \begin_layout Description
14809 \begin_inset Flex Code
14812 \begin_layout Plain Layout
14819 \begin_inset Flex Code
14822 \begin_layout Plain Layout
14831 \begin_inset Flex Code
14834 \begin_layout Plain Layout
14841 \begin_inset Flex Code
14844 \begin_layout Plain Layout
14851 \begin_inset Flex Code
14854 \begin_layout Plain Layout
14856 \begin_inset space ~
14864 ] This defines what the default spacing should be in the style.
14866 \begin_inset Flex Code
14869 \begin_layout Plain Layout
14876 \begin_inset Flex Code
14879 \begin_layout Plain Layout
14886 \begin_inset Flex Code
14889 \begin_layout Plain Layout
14895 correspond respectively to a multiplier value of 1, 1.25 and 1.667.
14896 If you specify the argument
14897 \begin_inset Flex Code
14900 \begin_layout Plain Layout
14906 , then you must also provide a value argument which will be the actual multiplie
14908 Note that, contrary to other parameters,
14909 \begin_inset Flex Code
14912 \begin_layout Plain Layout
14918 implies the generation of specific \SpecialChar LaTeX
14919 code, using the \SpecialChar LaTeX
14923 \begin_inset Flex Code
14926 \begin_layout Plain Layout
14935 \begin_layout Description
14936 \begin_inset Flex Code
14939 \begin_layout Plain Layout
14946 \begin_inset Flex Code
14949 \begin_layout Plain Layout
14956 \begin_inset space \thinspace{}
14960 \begin_inset Flex Code
14963 \begin_layout Plain Layout
14971 ] Allow spell-checking paragraphs of this style.
14975 \begin_layout Description
14976 \begin_inset Flex Code
14979 \begin_layout Plain Layout
14985 The font used for the text body .
14987 \begin_inset CommandInset ref
14989 reference "subsec:Font-description"
14996 \begin_layout Description
14997 \begin_inset Flex Code
15000 \begin_layout Plain Layout
15009 \begin_inset Flex Code
15012 \begin_layout Plain Layout
15022 The level of the style in the table of contents.
15023 This is used for automatic numbering of section headings.
15024 \change_inserted -712698321 1401363541
15028 \begin_layout Description
15030 \change_inserted -712698321 1401363906
15031 \begin_inset Flex Code
15034 \begin_layout Plain Layout
15036 \change_inserted -712698321 1401363547
15045 \begin_inset Flex Code
15048 \begin_layout Plain Layout
15050 \change_inserted -712698321 1401363664
15063 \begin_inset Flex Code
15066 \begin_layout Plain Layout
15068 \change_inserted -712698321 1401363669
15077 \begin_inset Flex Code
15080 \begin_layout Plain Layout
15082 \change_inserted -712698321 1401363675
15090 ] This tag determines whether the first line indentation of this paragraph
15091 can be toggled via the Paragraph settings dialog.
15095 \begin_inset Flex Code
15098 \begin_layout Plain Layout
15100 \change_inserted -712698321 1401363761
15110 is set, indentation can be toggled if the document settings use
15111 \begin_inset Quotes eld
15115 \begin_inset Quotes erd
15118 paragraph style, with
15119 \begin_inset Flex Code
15122 \begin_layout Plain Layout
15124 \change_inserted -712698321 1401363844
15130 , indentation can always be toggled, notwithstanding the document settings,
15132 \begin_inset Flex Code
15135 \begin_layout Plain Layout
15137 \change_inserted -712698321 1401363901
15143 , indentation can never be toggled.
15148 \begin_layout Description
15149 \begin_inset Flex Code
15152 \begin_layout Plain Layout
15159 \begin_inset Flex Code
15162 \begin_layout Plain Layout
15168 ] The vertical space with which the very first of a chain of paragraphs
15169 with this style is separated from the previous paragraph.
15170 If the previous paragraph has another style, the separations are not simply
15171 added, but the maximum is taken.
15174 \begin_layout Subsection
15175 \begin_inset CommandInset label
15181 Internationalization of Paragraph Styles
15184 \begin_layout Standard
15186 has long supported internationalization of layout information, but, until
15187 version 2.0, this applied only to the user interface and not to, say, PDF
15189 Thus, French authors were forced to resort to ugly hacks if they wanted
15194 1' instead of `Theorem 1'.
15195 Thanks to Georg Baum, that is no longer the case.
15198 \begin_layout Standard
15200 \begin_inset Flex Code
15203 \begin_layout Plain Layout
15209 defines text that is to appear in the typeset document, it may use
15210 \begin_inset Flex Code
15213 \begin_layout Plain Layout
15220 \begin_inset Flex Code
15223 \begin_layout Plain Layout
15229 to support non-English and even multi-language documents correctly.
15230 The following excerpt (from the
15231 \begin_inset Flex Code
15234 \begin_layout Plain Layout
15240 file) shows how this works:
15243 \begin_layout LyX-Code
15245 \begin_inset Separator parbreak
15252 \begin_layout LyX-Code
15255 theoremstyle{remark}
15258 \begin_layout LyX-Code
15261 newtheorem{claim}[thm]{
15268 \begin_layout LyX-Code
15272 \begin_layout LyX-Code
15276 \begin_layout LyX-Code
15281 claimname}{_(Claim)}
15284 \begin_layout LyX-Code
15288 \begin_layout LyX-Code
15292 \begin_layout LyX-Code
15301 claimname}{_(Claim)}}
15304 \begin_layout LyX-Code
15309 \begin_layout Standard
15310 In principle, any legal \SpecialChar LaTeX
15312 \begin_inset Flex Code
15315 \begin_layout Plain Layout
15322 \begin_inset Flex Code
15325 \begin_layout Plain Layout
15331 tags, but in practice they will typically look as they do here.
15332 The key to correct translation of the typeset text is the definition of
15333 the \SpecialChar LaTeX
15335 \begin_inset Flex Code
15338 \begin_layout Plain Layout
15347 \begin_inset Flex Code
15350 \begin_layout Plain Layout
15362 \begin_layout Standard
15364 \begin_inset Flex Code
15367 \begin_layout Plain Layout
15373 tag provides for internationalization based upon the overall language of
15375 The contents of the tag will be included in the preamble, just as with
15377 \begin_inset Flex Code
15380 \begin_layout Plain Layout
15387 What makes it special is the use of the
15388 \begin_inset Quotes eld
15392 \begin_inset Quotes erd
15396 \begin_inset Flex Code
15399 \begin_layout Plain Layout
15405 , which will be replaced, when \SpecialChar LyX
15406 produces \SpecialChar LaTeX
15407 output, with the translation of
15408 its argument into the document language.
15411 \begin_layout Standard
15413 \begin_inset Flex Code
15416 \begin_layout Plain Layout
15422 tag is more complex, since it is meant to provide support for multi-language
15423 documents and so offers an interface to the
15424 \begin_inset Flex Code
15427 \begin_layout Plain Layout
15434 Its contents will be added to the preamble once for each language that
15435 appears in the document.
15436 In this case, the argument to
15437 \begin_inset Flex Code
15440 \begin_layout Plain Layout
15446 will be replaced with its translation into the language in question; the
15448 \begin_inset Flex Code
15451 \begin_layout Plain Layout
15457 is replaced by the language name (as used by the babel package).
15460 \begin_layout Standard
15461 A German document that also included a French section would thus have the
15462 following in the preamble:
15465 \begin_layout LyX-Code
15474 claimname}{Affirmation}}
15475 \begin_inset Newline newline
15486 claimname}{Behauptung}}
15487 \begin_inset Newline newline
15494 claimname}{Behauptung}
15497 \begin_layout Standard
15500 \begin_inset Flex Code
15503 \begin_layout Plain Layout
15509 will then conspire to produce the correct text in the output.
15512 \begin_layout Standard
15513 One important point to note here is that the translations are provided by
15515 itself, through the file
15516 \begin_inset Flex Code
15519 \begin_layout Plain Layout
15526 This means, in effect, that
15527 \begin_inset Flex Code
15530 \begin_layout Plain Layout
15537 \begin_inset Flex Code
15540 \begin_layout Plain Layout
15546 are really only of use in layout files that are provided with \SpecialChar LyX
15548 entered in user-created layout files will not be seen by \SpecialChar LyX
15549 's internationalizatio
15550 n routines unless the
15551 \begin_inset Flex Code
15554 \begin_layout Plain Layout
15560 file is modified accordingly.
15561 That said, however, any layout created with the intention that it will
15562 be included with \SpecialChar LyX
15563 should use these tags where appropriate.
15564 Please note that the paragraph style translations provided by \SpecialChar LyX
15566 change with a minor update (e.
15567 \begin_inset space \thinspace{}
15571 \begin_inset space \space{}
15574 from version 2.1.x to 2.1.y).
15575 It is however quite likely that a major update (e.
15576 \begin_inset space \thinspace{}
15580 \begin_inset space \space{}
15583 from 2.0.x to 2.1.y) will introduce new translations or corrections.
15586 \begin_layout Subsection
15588 \begin_inset CommandInset label
15590 name "subsec:Floats"
15597 \begin_layout Standard
15598 It is necessary to define the floats (
15599 \begin_inset Flex MenuItem
15602 \begin_layout Plain Layout
15609 \begin_inset Flex MenuItem
15612 \begin_layout Plain Layout
15618 , \SpecialChar ldots
15619 ) in the text class itself.
15620 Standard floats are included in the file
15621 \begin_inset Flex Code
15624 \begin_layout Plain Layout
15630 , so you may have to do no more than add
15633 \begin_layout LyX-Code
15634 Input stdfloats.inc
15637 \begin_layout Standard
15638 to your layout file.
15639 If you want to implement a text class that proposes some other float types
15640 (like the AGU class bundled with \SpecialChar LyX
15641 ), the information below will hopefully
15643 \change_inserted -712698321 1432283506
15647 \begin_layout Description
15649 \change_inserted -712698321 1432313622
15650 \begin_inset Flex Code
15653 \begin_layout Plain Layout
15655 \change_inserted -712698321 1432283514
15662 \begin_inset Flex Code
15665 \begin_layout Plain Layout
15667 \change_inserted -712698321 1432283507
15673 =!htbpH] Allowed placement options for this float type.
15674 The value is a string of placement characters.
15675 Possible characters include:
15680 \begin_inset Quotes eld
15684 \begin_inset Quotes erd
15692 \begin_inset Quotes eld
15696 \begin_inset Quotes erd
15704 \begin_inset Quotes eld
15708 \begin_inset Quotes erd
15716 \begin_inset Quotes eld
15720 \begin_inset Quotes erd
15728 \begin_inset Quotes eld
15732 \begin_inset Quotes erd
15740 \begin_inset Quotes eld
15744 \begin_inset Quotes erd
15748 The order of the characters in the string does not matter.
15749 If no placement options are allowed, use the string
15756 \begin_layout Description
15758 \change_inserted -712698321 1432313755
15759 \begin_inset Flex Code
15762 \begin_layout Plain Layout
15764 \change_inserted -712698321 1432313630
15771 \begin_inset Flex Code
15774 \begin_layout Plain Layout
15776 \change_inserted -712698321 1432313646
15785 \begin_inset space \thinspace{}
15791 \begin_inset Flex Code
15794 \begin_layout Plain Layout
15796 \change_inserted -712698321 1432313646
15806 ] Defines whether the float allows to be rotated via the rotfloat package
15809 \begin_inset Flex Code
15812 \begin_layout Plain Layout
15814 \change_inserted -712698321 1432313721
15820 if the float does not support this feature.
15823 \begin_layout Description
15825 \change_inserted -712698321 1432313802
15826 \begin_inset Flex Code
15829 \begin_layout Plain Layout
15831 \change_inserted -712698321 1432313759
15838 \begin_inset Flex Code
15841 \begin_layout Plain Layout
15843 \change_inserted -712698321 1432313755
15852 \begin_inset space \thinspace{}
15858 \begin_inset Flex Code
15861 \begin_layout Plain Layout
15863 \change_inserted -712698321 1432313755
15873 ] Defines whether the float has a starred variant that spans columns in
15874 a two column paragraph.
15876 \begin_inset Flex Code
15879 \begin_layout Plain Layout
15881 \change_inserted -712698321 1432313755
15887 if the float does not support this feature.
15892 \begin_layout Description
15893 \begin_inset Flex Code
15896 \begin_layout Plain Layout
15903 \begin_inset Flex Code
15906 \begin_layout Plain Layout
15913 \begin_inset Quotes erd
15917 \begin_inset Quotes erd
15920 ] The file name extension of an auxiliary file for the list of figures (or
15923 writes the captions to this file.
15926 \begin_layout Description
15927 \begin_inset Flex Code
15930 \begin_layout Plain Layout
15937 \begin_inset Flex Code
15940 \begin_layout Plain Layout
15947 \begin_inset Quotes erd
15951 \begin_inset Quotes erd
15954 ] The string that will be used in the menus and also for the caption.
15955 This is translated to the current language if babel is used.
15958 \begin_layout Description
15959 \begin_inset Flex Code
15962 \begin_layout Plain Layout
15968 These tags control the XHTML output.
15970 \begin_inset CommandInset ref
15972 reference "sec:Tags-for-XHTML"
15979 \begin_layout Description
15980 \begin_inset Flex Code
15983 \begin_layout Plain Layout
15992 \begin_inset Flex Code
15995 \begin_layout Plain Layout
16004 \begin_inset space \thinspace{}
16008 \begin_inset Flex Code
16011 \begin_layout Plain Layout
16017 ] Indicates whether the float is already defined in the document class or
16018 if instead the \SpecialChar LaTeX
16020 \begin_inset Flex Code
16023 \begin_layout Plain Layout
16029 needs to be loaded to define it on-the-fly.
16031 \begin_inset Flex Code
16034 \begin_layout Plain Layout
16041 \begin_inset Flex Code
16044 \begin_layout Plain Layout
16051 It should be set to
16052 \begin_inset Flex Code
16055 \begin_layout Plain Layout
16061 if the float is already defined by the \SpecialChar LaTeX
16065 \begin_layout Description
16066 \begin_inset Flex Code
16069 \begin_layout Plain Layout
16076 \begin_inset Flex Code
16079 \begin_layout Plain Layout
16086 \begin_inset Quotes erd
16090 \begin_inset Quotes erd
16093 ] The command used to generate a list of floats of this type; the leading
16102 \begin_inset Flex Code
16105 \begin_layout Plain Layout
16111 is false, since there is no standard way to generate this command.
16113 \begin_inset Flex Code
16116 \begin_layout Plain Layout
16122 is true, since in that case there is a standard way to define the command.
16125 \begin_layout Description
16126 \begin_inset Flex Code
16129 \begin_layout Plain Layout
16136 \begin_inset Flex Code
16139 \begin_layout Plain Layout
16146 \begin_inset Quotes erd
16150 \begin_inset Quotes erd
16153 ] A title for a list of floats of this kind (list of figures, tables, or
16155 It is used for the screen label within \SpecialChar LyX
16156 , it is used by \SpecialChar LaTeX
16158 it is used as the title in the XHTML output.
16159 It will be translated to the document language.
16162 \begin_layout Description
16163 \begin_inset Flex Code
16166 \begin_layout Plain Layout
16173 \begin_inset Flex Code
16176 \begin_layout Plain Layout
16183 \begin_inset Quotes erd
16187 \begin_inset Quotes erd
16190 ] This (optional) argument determines whether floats of this class will
16191 be numbered within some sectional unit of the document.
16193 \begin_inset Flex Code
16196 \begin_layout Plain Layout
16203 \begin_inset Quotes eld
16207 \begin_inset Flex Code
16210 \begin_layout Plain Layout
16217 \begin_inset Quotes erd
16220 , the floats will be numbered within chapters.
16224 \begin_layout Description
16225 \begin_inset Flex Code
16228 \begin_layout Plain Layout
16235 \begin_inset Flex Code
16238 \begin_layout Plain Layout
16245 \begin_inset Quotes erd
16249 \begin_inset Quotes erd
16252 ] The default placement for the given class of floats.
16253 The string should be as in standard \SpecialChar LaTeX
16255 \begin_inset Flex Code
16258 \begin_layout Plain Layout
16265 \begin_inset Flex Code
16268 \begin_layout Plain Layout
16275 \begin_inset Flex Code
16278 \begin_layout Plain Layout
16285 \begin_inset Flex Code
16288 \begin_layout Plain Layout
16294 for top, bottom, page, and here, respectively.
16298 \begin_layout Plain Layout
16299 Note that the order of these letters in the string is irrelevant, like in
16306 On top of that there is a new type,
16307 \begin_inset Flex Code
16310 \begin_layout Plain Layout
16316 , which does not really correspond to a float, since it means: put it
16317 \begin_inset Quotes eld
16321 \begin_inset Quotes erd
16325 Note however that the
16326 \begin_inset Flex Code
16329 \begin_layout Plain Layout
16335 specifier is special and, because of implementation details, cannot be
16336 used in non-built in float types.
16337 If you do not understand what this means, just use
16338 \begin_inset Quotes eld
16342 \begin_inset Flex Code
16345 \begin_layout Plain Layout
16352 \begin_inset Quotes erd
16358 \begin_layout Description
16359 \begin_inset Flex Code
16362 \begin_layout Plain Layout
16369 \begin_inset Flex Code
16372 \begin_layout Plain Layout
16378 ] The prefix to use when creating labels referring to floats of this type.
16379 This allows the use of formatted references.
16380 Note that you can remove any
16381 \begin_inset Flex Code
16384 \begin_layout Plain Layout
16390 set by a copied style by using the special value
16391 \begin_inset Quotes eld
16395 \begin_inset Quotes erd
16398 , which must be all caps.
16401 \begin_layout Description
16402 \begin_inset Flex Code
16405 \begin_layout Plain Layout
16412 \begin_inset Flex Code
16415 \begin_layout Plain Layout
16422 \begin_inset Quotes erd
16426 \begin_inset Quotes erd
16429 ] The style used when defining the float using
16430 \begin_inset Flex Code
16433 \begin_layout Plain Layout
16444 \begin_layout Description
16445 \begin_inset Flex Code
16448 \begin_layout Plain Layout
16455 \begin_inset Flex Code
16458 \begin_layout Plain Layout
16465 \begin_inset Quotes erd
16469 \begin_inset Quotes erd
16473 \begin_inset Quotes eld
16477 \begin_inset Quotes erd
16480 of the new class of floats, like program or algorithm.
16481 After the appropriate
16482 \begin_inset Flex Code
16485 \begin_layout Plain Layout
16494 \begin_inset Flex Code
16497 \begin_layout Plain Layout
16506 \begin_inset Flex Code
16509 \begin_layout Plain Layout
16520 \begin_layout Description
16521 \begin_inset Flex Code
16524 \begin_layout Plain Layout
16531 \begin_inset Flex Code
16534 \begin_layout Plain Layout
16541 \begin_inset space \thinspace{}
16545 \begin_inset Flex Code
16548 \begin_layout Plain Layout
16556 ] Specifies whether this float is defined using the \SpecialChar LaTeX
16558 \begin_inset Flex Code
16561 \begin_layout Plain Layout
16567 , either by the class file, another package or on-the-fly by \SpecialChar LyX
16571 \begin_layout Standard
16572 Note that defining a float with type
16573 \begin_inset Flex Code
16576 \begin_layout Plain Layout
16584 automatically defines the corresponding counter with name
16585 \begin_inset Flex Code
16588 \begin_layout Plain Layout
16599 \begin_layout Subsection
16600 Flex insets and InsetLayout
16601 \begin_inset CommandInset label
16603 name "subsec:Flex-insets-and"
16610 \begin_layout Standard
16611 Flex insets come in three different kinds:
16614 \begin_layout Itemize
16616 \begin_inset Flex Code
16619 \begin_layout Plain Layout
16625 ): These define semantic markup corresponding to such \SpecialChar LaTeX
16627 \begin_inset Flex Code
16630 \begin_layout Plain Layout
16639 \begin_inset Flex Code
16642 \begin_layout Plain Layout
16653 \begin_layout Itemize
16655 \begin_inset Flex Code
16658 \begin_layout Plain Layout
16664 ): These can be used to define custom collapsible insets, similar to \SpecialChar TeX
16666 footnote, and the like.
16667 An obvious example is an endnote inset, which is defined in the
16668 \begin_inset Flex Code
16671 \begin_layout Plain Layout
16680 \begin_layout Itemize
16682 \begin_inset Flex Code
16685 \begin_layout Plain Layout
16691 ): For use with DocBook classes.
16694 \begin_layout Standard
16695 Flex insets are defined using the
16696 \begin_inset Flex Code
16699 \begin_layout Plain Layout
16705 tag, which shall be explained in a moment.
16708 \begin_layout Standard
16710 \begin_inset Flex Code
16713 \begin_layout Plain Layout
16719 tag also serves another function: It can be used to customize the general
16720 layout of many different types of insets.
16722 \begin_inset Flex Code
16725 \begin_layout Plain Layout
16731 can be used to customize the layout parameters for footnotes, marginal
16732 notes, note insets, \SpecialChar TeX
16733 code (ERT) insets, branches, listings, indexes, boxes,
16734 tables, algorithms, URLs, and captions, as well as to define Flex insets.
16737 \begin_layout Standard
16739 \begin_inset Flex Code
16742 \begin_layout Plain Layout
16748 definition must begin with a line of the form:
16751 \begin_layout LyX-Code
16755 \begin_layout Standard
16757 \begin_inset Flex Code
16760 \begin_layout Plain Layout
16766 indicates the inset whose layout is being defined, and here there are four
16770 \begin_layout Enumerate
16771 The layout for a pre-existing inset is being modified.
16772 In this case, can be
16773 \begin_inset Flex Code
16776 \begin_layout Plain Layout
16782 any one of the following:
16783 \begin_inset Flex Code
16786 \begin_layout Plain Layout
16793 \begin_inset Flex Code
16796 \begin_layout Plain Layout
16803 \begin_inset Flex Code
16806 \begin_layout Plain Layout
16813 \begin_inset Flex Code
16816 \begin_layout Plain Layout
16823 \begin_inset Flex Code
16826 \begin_layout Plain Layout
16833 \begin_inset Flex Code
16836 \begin_layout Plain Layout
16843 \begin_inset Flex Code
16846 \begin_layout Plain Layout
16853 \begin_inset Flex Code
16856 \begin_layout Plain Layout
16863 \begin_inset Flex Code
16866 \begin_layout Plain Layout
16873 \begin_inset Flex Code
16876 \begin_layout Plain Layout
16883 \begin_inset Flex Code
16886 \begin_layout Plain Layout
16893 \begin_inset Flex Code
16896 \begin_layout Plain Layout
16903 \begin_inset Flex Code
16906 \begin_layout Plain Layout
16913 \begin_inset Flex Code
16916 \begin_layout Plain Layout
16923 \begin_inset Flex Code
16926 \begin_layout Plain Layout
16933 \begin_inset Flex Code
16936 \begin_layout Plain Layout
16943 \begin_inset Flex Code
16946 \begin_layout Plain Layout
16953 \begin_inset Flex Code
16956 \begin_layout Plain Layout
16963 \begin_inset Flex Code
16966 \begin_layout Plain Layout
16973 \begin_inset Flex Code
16976 \begin_layout Plain Layout
16985 \begin_layout Enumerate
16986 The layout for a Flex inset is being defined.
16988 \begin_inset Flex Code
16991 \begin_layout Plain Layout
16997 must be of the form
16998 \begin_inset Quotes eld
17002 \begin_inset Flex Code
17005 \begin_layout Plain Layout
17012 \begin_inset Quotes erd
17016 \begin_inset Flex Code
17019 \begin_layout Plain Layout
17025 may be be any valid identifier not used by a pre-existing Flex inset.
17026 The identifier may include spaces, but in that case the whole thing must
17027 be wrapped in quotes.
17028 Note that the definition of a flex inset
17033 \begin_inset Flex Code
17036 \begin_layout Plain Layout
17042 entry, declaring which type of inset it defines.
17045 \begin_layout Enumerate
17046 The layout for user specific branch is being defined.
17048 \begin_inset Flex Code
17051 \begin_layout Plain Layout
17057 must be of the form
17058 \begin_inset Quotes eld
17062 \begin_inset Flex Code
17065 \begin_layout Plain Layout
17072 \begin_inset Quotes erd
17076 \begin_inset Flex Code
17079 \begin_layout Plain Layout
17085 may be be any valid identifier of branch defined in user's document.
17086 The identifier may include spaces, but in that case the whole thing must
17087 be wrapped in quotes.
17088 The main purpose of this feature is to allow \SpecialChar LaTeX
17089 wrapping around specific
17090 branches as user needs.
17093 \begin_layout Enumerate
17094 The layout of a user (or class) specific caption is being defined.
17096 \begin_inset Flex Code
17099 \begin_layout Plain Layout
17105 must be of the form
17106 \begin_inset Quotes eld
17110 \begin_inset Flex Code
17113 \begin_layout Plain Layout
17120 \begin_inset Quotes erd
17124 \begin_inset Flex Code
17127 \begin_layout Plain Layout
17133 specifies the name of the caption as it appears in the menu.
17134 Have a look at the standard caption (
17135 \begin_inset Flex Code
17138 \begin_layout Plain Layout
17144 ), the specific captions of the KOMA-Script classes (
17145 \begin_inset Flex Code
17148 \begin_layout Plain Layout
17155 \begin_inset Flex Code
17158 \begin_layout Plain Layout
17167 \begin_inset space ~
17173 \begin_inset Flex Code
17176 \begin_layout Plain Layout
17182 ) for applications.
17185 \begin_layout Standard
17187 \begin_inset Flex Code
17190 \begin_layout Plain Layout
17196 definition can contain the following entries:
17199 \begin_layout Description
17200 \begin_inset Flex Code
17203 \begin_layout Plain Layout
17210 \begin_inset Flex Code
17213 \begin_layout Plain Layout
17219 ] Defines argument number of a command\SpecialChar breakableslash
17220 environment associated with the current
17222 The definition must end with
17223 \begin_inset Flex Code
17226 \begin_layout Plain Layout
17234 \begin_inset CommandInset ref
17236 reference "subsec:Paragraph-Styles"
17243 \begin_layout Description
17244 \begin_inset Flex Code
17247 \begin_layout Plain Layout
17253 Preamble for changing language commands; see
17254 \begin_inset CommandInset ref
17256 reference "subsec:I18n"
17263 \begin_layout Description
17264 \begin_inset Flex Code
17267 \begin_layout Plain Layout
17274 \begin_inset Flex Code
17277 \begin_layout Plain Layout
17283 ] The color for the inset's background.
17285 \begin_inset CommandInset ref
17287 reference "chap:Names-of-colors"
17291 for a list of the available color names.
17294 \begin_layout Description
17295 \begin_inset Flex Code
17298 \begin_layout Plain Layout
17305 \begin_inset Flex Code
17308 \begin_layout Plain Layout
17317 \begin_inset space \thinspace{}
17321 \begin_inset Flex Code
17324 \begin_layout Plain Layout
17330 ] Whether to use the content of the inset as the label, when the inset is
17335 \begin_layout Description
17336 \begin_inset Flex Code
17339 \begin_layout Plain Layout
17346 \begin_inset Flex Code
17349 \begin_layout Plain Layout
17355 ] As with paragraph styles, see
17356 \begin_inset CommandInset ref
17358 reference "subsec:Paragraph-Styles"
17363 Note that you need to specify the complete type, e.
17364 \begin_inset space \thinspace{}
17368 \begin_inset space ~
17372 \begin_inset Flex Code
17375 \begin_layout Plain Layout
17376 CopyStyle Flex:<name>
17384 \begin_layout Description
17385 \begin_inset Flex Code
17388 \begin_layout Plain Layout
17395 \begin_inset Flex Code
17398 \begin_layout Plain Layout
17407 \begin_inset space \thinspace{}
17411 \begin_inset Flex Code
17414 \begin_layout Plain Layout
17420 ] Indicates whether the user may employ the Paragraph Settings dialog to
17421 customize the paragraph.
17424 \begin_layout Description
17425 \begin_inset Flex Code
17428 \begin_layout Plain Layout
17435 \begin_inset Flex Code
17438 \begin_layout Plain Layout
17445 \begin_inset Flex Code
17448 \begin_layout Plain Layout
17455 \begin_inset Flex Code
17458 \begin_layout Plain Layout
17464 , describing the rendering style used for the inset's frame and buttons.
17465 Footnotes generally use
17466 \begin_inset Flex Code
17469 \begin_layout Plain Layout
17475 , ERT insets generally
17476 \begin_inset Flex Code
17479 \begin_layout Plain Layout
17485 , and character styles
17486 \begin_inset Flex Code
17489 \begin_layout Plain Layout
17498 \begin_layout Description
17499 \begin_inset Flex Code
17502 \begin_layout Plain Layout
17509 \begin_inset Flex Code
17512 \begin_layout Plain Layout
17521 \begin_inset space \thinspace{}
17527 \begin_inset Flex Code
17530 \begin_layout Plain Layout
17539 \begin_inset Flex Code
17542 \begin_layout Plain Layout
17549 \begin_inset Flex Code
17552 \begin_layout Plain Layout
17559 Indicates whether the environment will stand on its own in the output or
17560 will appear inline with the surrounding text.
17561 If set to false, it is supposed that the \SpecialChar LaTeX
17562 environment ignores white space
17563 (including one newline character) after the
17564 \begin_inset Flex Code
17567 \begin_layout Plain Layout
17580 \begin_inset Flex Code
17583 \begin_layout Plain Layout
17599 \begin_layout Description
17600 \begin_inset Flex Code
17603 \begin_layout Plain Layout
17609 Required at the end of the
17610 \begin_inset Flex Code
17613 \begin_layout Plain Layout
17622 \begin_layout Description
17623 \begin_inset Flex Code
17626 \begin_layout Plain Layout
17632 The font used for both the text body
17638 \begin_inset CommandInset ref
17640 reference "subsec:Font-description"
17645 Note that defining this font automatically defines the
17646 \begin_inset Flex Code
17649 \begin_layout Plain Layout
17655 to the same value, so define this first and define
17656 \begin_inset Flex Code
17659 \begin_layout Plain Layout
17665 later if you want them to be different.
17666 \change_inserted -195340706 1421002157
17670 \begin_layout Description
17672 \change_inserted -195340706 1421002157
17673 \begin_inset Flex Code
17676 \begin_layout Plain Layout
17678 \change_inserted -195340706 1421002157
17679 FixedWidthPreambleEncoding
17685 \begin_inset Flex Code
17688 \begin_layout Plain Layout
17690 \change_inserted -195340706 1421002157
17699 \begin_inset space \thinspace{}
17703 \begin_inset Flex Code
17706 \begin_layout Plain Layout
17708 \change_inserted -195340706 1421002157
17714 ] Force a fixed width encoding for the translated contents of
17715 \begin_inset Flex Code
17718 \begin_layout Plain Layout
17720 \change_inserted -195340706 1421002157
17727 \begin_inset Flex Code
17730 \begin_layout Plain Layout
17732 \change_inserted -195340706 1421002157
17738 code generated by this layout.
17739 This is needed for special packages like the listings package that do not
17740 work with variable width encodings such as utf8.
17742 This setting is ignored if fully unicode aware \SpecialChar LaTeX
17743 backends such as Xe\SpecialChar LaTeX
17750 \begin_layout Description
17751 \begin_inset Flex Code
17754 \begin_layout Plain Layout
17755 ForceLocalFontSwitch
17761 \begin_inset Flex Code
17764 \begin_layout Plain Layout
17773 \begin_inset space \thinspace{}
17777 \begin_inset Flex Code
17780 \begin_layout Plain Layout
17786 ] When using babel, always use a local font switch (
17787 \begin_inset Flex Code
17790 \begin_layout Plain Layout
17798 ), never a global one (such as
17799 \begin_inset Flex Code
17802 \begin_layout Plain Layout
17813 \begin_layout Description
17814 \begin_inset Flex Code
17817 \begin_layout Plain Layout
17824 \begin_inset Flex Code
17827 \begin_layout Plain Layout
17836 \begin_inset space \thinspace{}
17840 \begin_inset Flex Code
17843 \begin_layout Plain Layout
17850 \begin_inset Quotes eld
17854 \begin_inset Quotes erd
17857 language, leading to Left-to-Right (Latin) output, e.
17858 \begin_inset space \thinspace{}
17862 \begin_inset space \space{}
17865 in \SpecialChar TeX
17868 \change_inserted -712698321 1417441977
17872 \begin_layout Description
17874 \change_inserted -712698321 1417442090
17875 \begin_inset Flex Code
17878 \begin_layout Plain Layout
17880 \change_inserted -712698321 1417441983
17887 \begin_inset Flex Code
17890 \begin_layout Plain Layout
17892 \change_inserted -712698321 1417441978
17901 \begin_inset space \thinspace{}
17905 \begin_inset Flex Code
17908 \begin_layout Plain Layout
17910 \change_inserted -712698321 1417441978
17916 ] Force a a line break in the \SpecialChar LaTeX
17917 output before the inset starts and after
17919 This assures the inset itself is output on its own lines, for parsing purposes.
17921 \change_inserted 274215730 1419105878
17927 \begin_layout Description
17928 \begin_inset Flex Code
17931 \begin_layout Plain Layout
17938 \begin_inset Flex Code
17941 \begin_layout Plain Layout
17950 \begin_inset space \thinspace{}
17954 \begin_inset Flex Code
17957 \begin_layout Plain Layout
17963 ] Indicates whether the
17964 \begin_inset Flex Code
17967 \begin_layout Plain Layout
17973 should be used or, instead, the user can change the paragraph style used
17978 \begin_layout Description
17979 \begin_inset Flex Code
17982 \begin_layout Plain Layout
17989 \begin_inset Flex Code
17992 \begin_layout Plain Layout
18001 \begin_inset space \thinspace{}
18005 \begin_inset Flex Code
18008 \begin_layout Plain Layout
18014 ] As with paragraph styles, see
18015 \begin_inset CommandInset ref
18017 reference "subsec:Paragraph-Styles"
18024 \begin_layout Description
18025 \begin_inset Flex Code
18028 \begin_layout Plain Layout
18034 These tags control the XHTML output.
18036 \begin_inset CommandInset ref
18038 reference "sec:Tags-for-XHTML"
18045 \begin_layout Description
18046 \begin_inset Flex Code
18049 \begin_layout Plain Layout
18056 \begin_inset Flex Code
18059 \begin_layout Plain Layout
18068 \begin_inset space \thinspace{}
18072 \begin_inset Flex Code
18075 \begin_layout Plain Layout
18081 ] Whether to include the contents of this inset in the strings generated
18082 for the `Outline' pane.
18083 One would not, for example, want the content of a footnote in a section
18084 header to be included in the TOC displayed in the outline, but one would
18085 normally want the content of a character style displayed.
18086 Default is false: not to include.
18089 \begin_layout Description
18090 \begin_inset Flex Code
18093 \begin_layout Plain Layout
18102 \begin_inset Flex Code
18105 \begin_layout Plain Layout
18114 \begin_inset space \thinspace{}
18118 \begin_inset Flex Code
18121 \begin_layout Plain Layout
18127 ] As with paragraph styles, see
18128 \begin_inset CommandInset ref
18130 reference "subsec:Paragraph-Styles"
18137 \begin_layout Description
18138 \begin_inset Flex Code
18141 \begin_layout Plain Layout
18147 The font used for the label.
18149 \begin_inset CommandInset ref
18151 reference "subsec:Font-description"
18156 Note that this definition can never appear before
18157 \begin_inset Flex Code
18160 \begin_layout Plain Layout
18166 , lest it be ineffective.
18169 \begin_layout Description
18170 \begin_inset Flex Code
18173 \begin_layout Plain Layout
18180 \begin_inset Flex Code
18183 \begin_layout Plain Layout
18190 \begin_inset Quotes erd
18194 \begin_inset Quotes erd
18197 ] What will be displayed on the button or elsewhere as the inset label.
18199 \begin_inset Flex Code
18202 \begin_layout Plain Layout
18210 \begin_inset Flex Code
18213 \begin_layout Plain Layout
18219 ) modify this label on the fly.
18222 \begin_layout Description
18223 \begin_inset Flex Code
18226 \begin_layout Plain Layout
18232 Language dependent preamble; see
18233 \begin_inset CommandInset ref
18235 reference "subsec:I18n"
18242 \begin_layout Description
18243 \begin_inset Flex Code
18246 \begin_layout Plain Layout
18253 \begin_inset Flex Code
18256 \begin_layout Plain Layout
18262 ] The name of the corresponding \SpecialChar LaTeX
18264 Either the environment or command name.
18267 \begin_layout Description
18268 \begin_inset Flex Code
18271 \begin_layout Plain Layout
18278 \begin_inset Flex Code
18281 \begin_layout Plain Layout
18287 ] The optional parameter for the corresponding
18288 \begin_inset Flex Code
18291 \begin_layout Plain Layout
18297 stuff, including possible bracket pairs like
18298 \begin_inset Flex Code
18301 \begin_layout Plain Layout
18308 This parameter cannot be changed from within \SpecialChar LyX
18310 \begin_inset Flex Code
18313 \begin_layout Plain Layout
18319 for customizable parameters).
18320 It will be output as is after all \SpecialChar LaTeX
18322 \begin_inset Flex Code
18325 \begin_layout Plain Layout
18334 \begin_layout Description
18335 \begin_inset Flex Code
18338 \begin_layout Plain Layout
18345 \begin_inset Flex Code
18348 \begin_layout Plain Layout
18349 Command, Environment, None
18354 ] How the style should be translated into \SpecialChar LaTeX
18359 \begin_layout Plain Layout
18360 \begin_inset Flex Code
18363 \begin_layout Plain Layout
18369 is perhaps a bit misleading, since these rules apply to SGML classes too.
18370 Visit the SGML class files for specific examples.
18376 \begin_inset Separator parbreak
18383 \begin_layout Description
18384 \begin_inset Flex Code
18387 \begin_layout Plain Layout
18393 means nothing special
18396 \begin_layout Description
18397 \begin_inset Flex Code
18400 \begin_layout Plain Layout
18407 \begin_inset Flex Code
18410 \begin_layout Plain Layout
18417 {\SpecialChar ldots
18426 \begin_layout Description
18427 \begin_inset Flex Code
18430 \begin_layout Plain Layout
18437 \begin_inset Flex Code
18440 \begin_layout Plain Layout
18447 }\SpecialChar ldots
18462 \begin_layout Standard
18463 Putting the last few things together, the \SpecialChar LaTeX
18464 output will be either:
18467 \begin_layout LyX-Code
18470 LatexName[LatexParam]{\SpecialChar ldots
18474 \begin_layout Standard
18478 \begin_layout LyX-Code
18481 begin{LatexName}[LatexParam] \SpecialChar ldots
18487 \begin_layout Standard
18488 depending upon the \SpecialChar LaTeX
18493 \begin_layout Description
18494 \begin_inset Flex Code
18497 \begin_layout Plain Layout
18504 \begin_inset Flex Code
18507 \begin_layout Plain Layout
18513 ] A string that is put at the beginning of the layout content.
18514 A line break in the output can be indicated by
18515 \begin_inset Flex Code
18518 \begin_layout Plain Layout
18527 \begin_layout Description
18528 \begin_inset Flex Code
18531 \begin_layout Plain Layout
18538 \begin_inset Flex Code
18541 \begin_layout Plain Layout
18548 \begin_inset Flex Code
18551 \begin_layout Plain Layout
18558 \begin_inset Flex Code
18561 \begin_layout Plain Layout
18568 \begin_inset Flex Code
18571 \begin_layout Plain Layout
18577 (indicating a dummy definition ending definitions of charstyles, etc).
18578 This entry is required in and is only meaningful for Flex insets.
18579 Among other things, it determines on which menu this inset will appear.
18581 \begin_inset Flex Code
18584 \begin_layout Plain Layout
18591 \begin_inset Flex Code
18594 \begin_layout Plain Layout
18600 will automatically set
18601 \begin_inset Flex Code
18604 \begin_layout Plain Layout
18612 \begin_inset Flex Code
18615 \begin_layout Plain Layout
18621 can be set to true for
18622 \begin_inset Flex Code
18625 \begin_layout Plain Layout
18631 insets by setting it
18636 \begin_inset Flex Code
18639 \begin_layout Plain Layout
18648 \begin_layout Description
18649 \begin_inset Flex Code
18652 \begin_layout Plain Layout
18659 \begin_inset Flex Code
18662 \begin_layout Plain Layout
18671 \begin_inset space \thinspace{}
18675 \begin_inset Flex Code
18678 \begin_layout Plain Layout
18684 ] Whether multiple paragraphs are permitted in this inset.
18686 \begin_inset Flex Code
18689 \begin_layout Plain Layout
18695 to the same value and
18696 \begin_inset Flex Code
18699 \begin_layout Plain Layout
18705 to the opposite value.
18706 These can be reset to other values, if they are used
18711 \begin_inset Flex Code
18714 \begin_layout Plain Layout
18724 \begin_layout Description
18725 \begin_inset Flex Code
18728 \begin_layout Plain Layout
18735 \begin_inset Flex Code
18738 \begin_layout Plain Layout
18747 \begin_inset space \thinspace{}
18751 \begin_inset Flex Code
18754 \begin_layout Plain Layout
18760 ] Whether fragile commands in this inset should be
18761 \begin_inset Flex Code
18764 \begin_layout Plain Layout
18777 whether the command should itself be protected.) Default is false.
18780 \begin_layout Description
18781 \begin_inset Flex Code
18784 \begin_layout Plain Layout
18791 \begin_inset Flex Code
18794 \begin_layout Plain Layout
18800 ] Deletes an existing
18801 \begin_inset Flex Code
18804 \begin_layout Plain Layout
18811 \change_inserted -712698321 1417953494
18815 \begin_layout Description
18817 \change_inserted -712698321 1417953559
18818 \begin_inset Flex Code
18821 \begin_layout Plain Layout
18823 \change_inserted -712698321 1417953494
18830 \begin_inset Flex Code
18833 \begin_layout Plain Layout
18835 \change_inserted -712698321 1417953574
18842 \begin_inset Flex Code
18845 \begin_layout Plain Layout
18847 \change_inserted -712698321 1417953533
18853 that has replaced this
18854 \begin_inset Flex Code
18857 \begin_layout Plain Layout
18859 \change_inserted -712698321 1417953551
18866 This is used to rename an
18867 \begin_inset Flex Code
18870 \begin_layout Plain Layout
18872 \change_inserted -712698321 1417953559
18878 , while keeping backward compatibility.
18883 \begin_layout Description
18884 \begin_inset Flex Code
18887 \begin_layout Plain Layout
18894 \begin_inset Flex Code
18897 \begin_layout Plain Layout
18906 \begin_inset space \thinspace{}
18910 \begin_inset Flex Code
18913 \begin_layout Plain Layout
18919 ] As with paragraph styles, see
18920 \begin_inset CommandInset ref
18922 reference "subsec:Paragraph-Styles"
18930 \begin_layout Description
18931 \begin_inset Flex Code
18934 \begin_layout Plain Layout
18941 \begin_inset Flex Code
18944 \begin_layout Plain Layout
18953 \begin_inset space \thinspace{}
18957 \begin_inset Flex Code
18960 \begin_layout Plain Layout
18966 ] As with paragraph styles, see
18967 \begin_inset CommandInset ref
18969 reference "subsec:Paragraph-Styles"
18977 \begin_layout Description
18978 \begin_inset Flex Code
18981 \begin_layout Plain Layout
18987 As with paragraph styles, see
18988 \begin_inset CommandInset ref
18990 reference "subsec:Paragraph-Styles"
18997 \begin_layout Description
18998 \begin_inset Flex Code
19001 \begin_layout Plain Layout
19008 \begin_inset Flex Code
19011 \begin_layout Plain Layout
19017 ] The prefix to use when creating labels referring to insets of this type.
19018 This allows the use of formatted references.
19021 \begin_layout Description
19022 \begin_inset Flex Code
19025 \begin_layout Plain Layout
19032 \begin_inset Flex Code
19035 \begin_layout Plain Layout
19041 ] As with paragraph styles, see
19042 \begin_inset CommandInset ref
19044 reference "subsec:Paragraph-Styles"
19051 \begin_layout Description
19052 \begin_inset Flex Code
19055 \begin_layout Plain Layout
19062 \begin_inset Flex Code
19065 \begin_layout Plain Layout
19074 \begin_inset space \thinspace{}
19078 \begin_inset Flex Code
19081 \begin_layout Plain Layout
19087 ] Resets the \SpecialChar LaTeX
19088 arguments of this layout (as defined via the
19089 \begin_inset Flex Code
19092 \begin_layout Plain Layout
19099 This is useful if you have copied a style via
19100 \begin_inset Flex Code
19103 \begin_layout Plain Layout
19109 , but you do not want to inherit its (required and optional) arguments.
19112 \begin_layout Description
19113 \begin_inset Flex Code
19116 \begin_layout Plain Layout
19123 \begin_inset Flex Code
19126 \begin_layout Plain Layout
19133 \begin_inset space \thinspace{}
19137 \begin_inset Flex Code
19140 \begin_layout Plain Layout
19148 ] Whether this inset should use the font of its surrounding environment
19150 Default is false: use the font of the surrounding environment.
19153 \begin_layout Description
19154 \begin_inset Flex Code
19157 \begin_layout Plain Layout
19164 \begin_inset Flex Code
19167 \begin_layout Plain Layout
19173 ] A string that is put at the end of the layout content.
19174 A line break in the output can be indicated by
19175 \begin_inset Flex Code
19178 \begin_layout Plain Layout
19187 \begin_layout Description
19188 \begin_inset Flex Code
19191 \begin_layout Plain Layout
19198 \begin_inset Flex Code
19201 \begin_layout Plain Layout
19208 \begin_inset space \thinspace{}
19212 \begin_inset Flex Code
19215 \begin_layout Plain Layout
19223 ] Allow spell-checking the contents of this inset.
19227 \begin_layout Subsection
19229 \begin_inset CommandInset label
19231 name "subsec:Counters"
19238 \begin_layout Standard
19239 It is necessary to define the counters (
19240 \begin_inset Flex MenuItem
19243 \begin_layout Plain Layout
19250 \begin_inset Flex MenuItem
19253 \begin_layout Plain Layout
19259 , \SpecialChar ldots
19260 ) in the text class itself.
19261 The standard counters are defined in the file
19262 \begin_inset Flex Code
19265 \begin_layout Plain Layout
19271 , so you may have to do no more than add
19274 \begin_layout LyX-Code
19275 Input stdcounters.inc
19278 \begin_layout Standard
19279 to your layout file to get them to work.
19280 But if you want to define custom counters, then you can do so.
19281 The counter declaration must begin with:
19284 \begin_layout LyX-Code
19285 Counter CounterName
19288 \begin_layout Standard
19290 \begin_inset Flex Code
19293 \begin_layout Plain Layout
19299 ' is replaced by the name of the counter.
19300 And it must end with
19301 \begin_inset Quotes eld
19305 \begin_inset Flex Code
19308 \begin_layout Plain Layout
19315 \begin_inset Quotes erd
19319 The following parameters can also be used:
19322 \begin_layout Description
19323 \begin_inset Flex Code
19326 \begin_layout Plain Layout
19333 \begin_inset Flex Code
19336 \begin_layout Plain Layout
19342 ] Sets the initial value for the counter, to which it will be reset whenever
19344 Normally, one will want the default, 1.
19347 \begin_layout Description
19348 \begin_inset Flex Code
19351 \begin_layout Plain Layout
19358 \begin_inset Flex Code
19361 \begin_layout Plain Layout
19368 \begin_inset Quotes erd
19372 \begin_inset Quotes erd
19375 ] When defined, this string defines how the counter is displayed.
19376 Setting this value sets
19377 \begin_inset Flex Code
19380 \begin_layout Plain Layout
19381 LabelStringAppendix
19387 The following special constructs can be used in the string:
19388 \begin_inset Separator parbreak
19395 \begin_layout Itemize
19396 \begin_inset Flex Code
19399 \begin_layout Plain Layout
19407 will be replaced by the expansion of the
19408 \begin_inset Flex Code
19411 \begin_layout Plain Layout
19418 \begin_inset Flex Code
19421 \begin_layout Plain Layout
19422 LabelStringAppendix
19428 \begin_inset Flex Code
19431 \begin_layout Plain Layout
19441 \begin_layout Itemize
19442 counter values can be expressed using \SpecialChar LaTeX
19444 \begin_inset Newline newline
19448 \begin_inset Flex Code
19451 \begin_layout Plain Layout
19468 \begin_inset Flex Code
19471 \begin_layout Plain Layout
19483 \begin_layout Plain Layout
19493 Actually, the situation is a bit more complicated: any
19512 other than those described below will produce arabic numerals.
19513 It would not be surprising to see this change in the future.
19519 \begin_inset Flex Code
19522 \begin_layout Plain Layout
19528 : 1, 2, 3,\SpecialChar ldots
19530 \begin_inset Flex Code
19533 \begin_layout Plain Layout
19539 for lower-case letters: a, b, c, \SpecialChar ldots
19541 \begin_inset Flex Code
19544 \begin_layout Plain Layout
19550 for upper-case letters: A, B, C, \SpecialChar ldots
19552 \begin_inset Flex Code
19555 \begin_layout Plain Layout
19561 for lower-case roman numerals: i, ii, iii, \SpecialChar ldots
19563 \begin_inset Flex Code
19566 \begin_layout Plain Layout
19572 for upper-case roman numerals: I, II, III\SpecialChar ldots
19574 \begin_inset Flex Code
19577 \begin_layout Plain Layout
19583 for hebrew numerals.
19587 \begin_layout Standard
19588 If LabelString is not defined, a default value is constructed as follows:
19589 if the counter has a master counter
19590 \begin_inset Flex Code
19593 \begin_layout Plain Layout
19600 \begin_inset Flex Code
19603 \begin_layout Plain Layout
19610 \begin_inset Newline newline
19614 \begin_inset Flex Code
19617 \begin_layout Plain Layout
19627 is used; otherwise the string
19628 \begin_inset Flex Code
19631 \begin_layout Plain Layout
19642 \begin_layout Description
19643 \begin_inset Flex Code
19646 \begin_layout Plain Layout
19647 LabelStringAppendix
19653 \begin_inset Flex Code
19656 \begin_layout Plain Layout
19663 \begin_inset Quotes erd
19667 \begin_inset Quotes erd
19671 \begin_inset Flex Code
19674 \begin_layout Plain Layout
19680 , but for use in the Appendix.
19683 \begin_layout Description
19684 \begin_inset Flex Code
19687 \begin_layout Plain Layout
19694 \begin_inset Flex Code
19697 \begin_layout Plain Layout
19704 \begin_inset Quotes erd
19708 \begin_inset Quotes erd
19711 ] A format for use with formatted references to this counter.
19712 For example, one might want to have references to section numbers appear
19714 \begin_inset Quotes eld
19718 \begin_inset Quotes erd
19722 The string should contain
19723 \begin_inset Quotes eld
19727 \begin_inset Quotes erd
19731 This will be replaced by the counter number itself.
19732 So, for sections, it would be: Section ##.
19735 \begin_layout Description
19736 \begin_inset Flex Code
19739 \begin_layout Plain Layout
19746 \begin_inset Flex Code
19749 \begin_layout Plain Layout
19756 \begin_inset Quotes erd
19760 \begin_inset Quotes erd
19763 ] If this is set to the name of another counter, the present counter will
19764 be reset every time the other one is increased.
19766 \begin_inset Flex Code
19769 \begin_layout Plain Layout
19776 \begin_inset Flex Code
19779 \begin_layout Plain Layout
19788 \begin_layout Subsection
19790 \begin_inset CommandInset label
19792 name "subsec:Font-description"
19799 \begin_layout Standard
19800 A font description looks like this:
19803 \begin_layout LyX-Code
19817 \begin_layout LyX-Code
19821 \begin_layout LyX-Code
19825 \begin_layout Standard
19826 The following commands are available:
19829 \begin_layout Description
19830 \begin_inset Flex Code
19833 \begin_layout Plain Layout
19840 \begin_inset Flex Code
19843 \begin_layout Plain Layout
19852 \begin_inset Flex Code
19855 \begin_layout Plain Layout
19862 \begin_inset Flex Code
19865 \begin_layout Plain Layout
19872 \begin_inset Flex Code
19875 \begin_layout Plain Layout
19882 \begin_inset Flex Code
19885 \begin_layout Plain Layout
19892 \begin_inset Flex Code
19895 \begin_layout Plain Layout
19902 \begin_inset Flex Code
19905 \begin_layout Plain Layout
19912 \begin_inset Flex Code
19915 \begin_layout Plain Layout
19922 \begin_inset Flex Code
19925 \begin_layout Plain Layout
19934 \begin_layout Description
19935 \begin_inset Flex Code
19938 \begin_layout Plain Layout
19945 \begin_inset Flex Code
19948 \begin_layout Plain Layout
19957 \begin_inset Flex Code
19960 \begin_layout Plain Layout
19967 \begin_inset Flex Code
19970 \begin_layout Plain Layout
19979 \begin_layout Description
19980 \begin_inset Flex Code
19983 \begin_layout Plain Layout
19990 \begin_inset Flex Code
19993 \begin_layout Plain Layout
19999 ] Valid arguments are:
20000 \begin_inset Flex Code
20003 \begin_layout Plain Layout
20010 \begin_inset Flex Code
20013 \begin_layout Plain Layout
20020 \begin_inset Flex Code
20023 \begin_layout Plain Layout
20030 \begin_inset Flex Code
20033 \begin_layout Plain Layout
20040 \begin_inset Flex Code
20043 \begin_layout Plain Layout
20050 \begin_inset Flex Code
20053 \begin_layout Plain Layout
20060 \begin_inset Flex Code
20063 \begin_layout Plain Layout
20070 \begin_inset Flex Code
20073 \begin_layout Plain Layout
20080 \begin_inset Flex Code
20083 \begin_layout Plain Layout
20090 \begin_inset Flex Code
20093 \begin_layout Plain Layout
20100 \begin_inset Flex Code
20103 \begin_layout Plain Layout
20110 \begin_inset Flex Code
20113 \begin_layout Plain Layout
20120 Each of these turns on or off the corresponding attribute.
20122 \begin_inset Flex Code
20125 \begin_layout Plain Layout
20131 turns on emphasis, and
20132 \begin_inset Flex Code
20135 \begin_layout Plain Layout
20143 \begin_inset Newline newline
20146 If the latter seems puzzling, remember that the font settings for the present
20147 context are generally inherited from the surrounding context.
20149 \begin_inset Flex Code
20152 \begin_layout Plain Layout
20158 would turn off the emphasis that was anyway in effect, say, in a theorem
20162 \begin_layout Description
20163 \begin_inset Flex Code
20166 \begin_layout Plain Layout
20173 \begin_inset Flex Code
20176 \begin_layout Plain Layout
20185 \begin_inset Flex Code
20188 \begin_layout Plain Layout
20197 \begin_layout Description
20198 \begin_inset Flex Code
20201 \begin_layout Plain Layout
20208 \begin_inset Flex Code
20211 \begin_layout Plain Layout
20220 \begin_inset Flex Code
20223 \begin_layout Plain Layout
20230 \begin_inset Flex Code
20233 \begin_layout Plain Layout
20240 \begin_inset Flex Code
20243 \begin_layout Plain Layout
20252 \begin_layout Description
20253 \begin_inset Flex Code
20256 \begin_layout Plain Layout
20263 \begin_inset Flex Code
20266 \begin_layout Plain Layout
20273 \begin_inset Flex Code
20276 \begin_layout Plain Layout
20283 \begin_inset Flex Code
20286 \begin_layout Plain Layout
20295 \begin_inset Flex Code
20298 \begin_layout Plain Layout
20305 \begin_inset Flex Code
20308 \begin_layout Plain Layout
20315 \begin_inset Flex Code
20318 \begin_layout Plain Layout
20325 \begin_inset Flex Code
20328 \begin_layout Plain Layout
20335 \begin_inset Flex Code
20338 \begin_layout Plain Layout
20347 \begin_layout Subsection
20348 \begin_inset CommandInset label
20350 name "subsec:Citation-format-description"
20354 Citation format description
20357 \begin_layout Standard
20359 \begin_inset Flex Code
20362 \begin_layout Plain Layout
20368 blocks are used to describe how bibliographic information should be displayed,
20369 both within \SpecialChar LyX
20370 itself (in the citation dialog and in tooltips, for example)
20371 and in XHTML output.
20372 Such a block might look like this:
20375 \begin_layout LyX-Code
20379 \begin_layout LyX-Code
20383 \begin_layout LyX-Code
20387 \begin_layout LyX-Code
20391 \begin_layout Standard
20392 The individual lines define how the bibliographic information associated
20393 with an article or book, respectively, is to be displayed, and such a definitio
20394 n can be given for any `entry type' that might be present in a Bib\SpecialChar TeX
20397 defines a default format in the source code that will be used if no specific
20398 definition has been given.
20400 predefines several formats in the file
20401 \begin_inset Flex Code
20404 \begin_layout Plain Layout
20410 , which is included in most of \SpecialChar LyX
20411 's document classes.
20414 \begin_layout Standard
20415 The definitions use a simple language that allows Bib\SpecialChar TeX
20416 keys to be replaced
20418 Keys should be enclosed in
20419 \begin_inset Flex Code
20422 \begin_layout Plain Layout
20429 \begin_inset Flex Code
20432 \begin_layout Plain Layout
20439 So a simple definition might look like this:
20442 \begin_layout LyX-Code
20444 \begin_inset Quotes eld
20448 \begin_inset Quotes erd
20454 \begin_layout Standard
20455 This would print the author, followed by a comma, followed by the title,
20456 in quotes, followed by a period.
20459 \begin_layout Standard
20460 Of course, sometimes you may want to print a key only if it exists.
20461 This can be done by using a conditional construction, such as:
20462 \begin_inset Flex Code
20465 \begin_layout Plain Layout
20467 \begin_inset space ~
20477 \begin_inset Flex Code
20480 \begin_layout Plain Layout
20486 key exists, then print
20487 \begin_inset Quotes eld
20491 \begin_inset space ~
20495 \begin_inset Quotes erd
20498 followed by the volume key.
20499 It is also possible to have an else clause in the conditional, such as:
20500 \begin_inset Newline newline
20504 \begin_inset Flex Code
20507 \begin_layout Plain Layout
20508 {%author%[[%author%]][[%editor%, ed.]]}
20514 \begin_inset Newline newline
20518 \begin_inset Flex Code
20521 \begin_layout Plain Layout
20527 key is printed if it exists; otherwise, the editor key is printed, followed
20529 \begin_inset Quotes eld
20533 \begin_inset space ~
20537 \begin_inset Quotes erd
20540 Note that the key is again enclosed in
20541 \begin_inset Flex Code
20544 \begin_layout Plain Layout
20550 signs; the entire conditional is enclosed in braces; and the if and else
20551 clauses are enclosed in double brackets,
20552 \begin_inset Quotes eld
20556 \begin_inset Flex Code
20559 \begin_layout Plain Layout
20566 \begin_inset Quotes eld
20570 \begin_inset Quotes eld
20574 \begin_inset Flex Code
20577 \begin_layout Plain Layout
20584 \begin_inset Quotes erd
20588 There must be no space between any of these.
20591 \begin_layout Standard
20592 There is one other piece of syntax available in definitions, which looks
20594 \begin_inset Flex Code
20597 \begin_layout Plain Layout
20604 This defines a piece of formatting information that is to be used when
20606 \begin_inset Quotes eld
20610 \begin_inset Quotes erd
20614 Obviously, we do not want to output HTML tags when writing plain text,
20615 so they should be wrapped in
20616 \begin_inset Quotes eld
20620 \begin_inset Quotes erd
20624 \begin_inset Quotes eld
20628 \begin_inset Quotes erd
20634 \begin_layout Standard
20635 Two special sorts of definitions are also possible in a
20636 \begin_inset Flex Code
20639 \begin_layout Plain Layout
20646 An example of the first would be:
20649 \begin_layout LyX-Code
20651 \begin_inset Quotes eld
20655 \begin_inset Quotes erd
20661 \begin_layout Standard
20662 This is an abbreviation, or macro, and it can be used by treating it as
20664 \begin_inset Flex Code
20667 \begin_layout Plain Layout
20676 \begin_inset Flex Code
20679 \begin_layout Plain Layout
20685 exactly as it would treat its definition.
20686 So, let us issue the obvious
20694 \begin_layout LyX-Code
20698 \begin_layout Standard
20699 or anything like it.
20701 shouldn't go into an infinite loop, but it may go into a long one before
20705 \begin_layout Standard
20706 The second sort of special definition might look like this:
20709 \begin_layout LyX-Code
20713 \begin_layout Standard
20714 This defines a translatable piece of text, which allows relevant parts of
20715 the bibliography to be translated.
20716 It can be included in a definition by treating it as a key:
20717 \begin_inset Flex Code
20720 \begin_layout Plain Layout
20727 Several of these are predefined in
20728 \begin_inset Flex Code
20731 \begin_layout Plain Layout
20738 Note that these are not macros, in the sense just defined.
20739 They will not be expanded.
20742 \begin_layout Standard
20743 So here then is an example that use all these features:
20744 \begin_inset VSpace defskip
20750 \begin_layout Standard
20754 !authoredit {%author%[[%author%, ]][[{%editor%[[%editor%, %_edtext%, ]]}]]}
20757 \begin_layout Standard
20758 \begin_inset VSpace defskip
20761 This defines a macro that prints the author, followed by a comma, if the
20763 \begin_inset Flex Code
20766 \begin_layout Plain Layout
20772 key is defined, or else prints the name of the editor, followed by the
20774 \begin_inset Flex Code
20777 \begin_layout Plain Layout
20783 or its translation (it is by default
20784 \begin_inset Quotes eld
20788 \begin_inset Quotes erd
20792 \begin_inset Flex Code
20795 \begin_layout Plain Layout
20802 Note that this is in fact defined in
20803 \begin_inset Flex Code
20806 \begin_layout Plain Layout
20812 , so you can use it in your own definitions, or re-definitions, if you load
20816 \begin_layout Section
20817 \begin_inset CommandInset label
20819 name "sec:Tags-for-XHTML"
20823 Tags for XHTML output
20826 \begin_layout Standard
20827 As with \SpecialChar LaTeX
20828 or DocBook, the format of \SpecialChar LyX
20829 's XHTML output is also controlled by
20830 layout information.
20831 In general, \SpecialChar LyX
20832 provides sensible defaults and, as mentioned earlier, it will
20833 even construct default CSS style rules from the other layout tags.
20834 For example, \SpecialChar LyX
20835 will attempt to use the information provided in the
20836 \begin_inset Flex Code
20839 \begin_layout Plain Layout
20845 declaration for the Chapter style to write CSS that will appropriately
20846 format chapter headings.
20849 \begin_layout Standard
20850 In many cases, then, you may not have to do anything at all to get acceptable
20851 XHTML output for your own environments, custom insets, and so forth.
20852 But in some cases you will, and so \SpecialChar LyX
20853 provides a number of layout tags that
20854 can be used to customize the XHTML and CSS that are generated.
20857 \begin_layout Standard
20858 Note that there are two tags,
20859 \begin_inset Flex Code
20862 \begin_layout Plain Layout
20869 \begin_inset Flex Code
20872 \begin_layout Plain Layout
20878 that may appear outside style and inset declarations.
20880 \begin_inset CommandInset ref
20882 reference "subsec:General-text-class"
20886 for details on these.
20889 \begin_layout Subsection
20890 \begin_inset CommandInset label
20892 name "subsec:Paragraph-Style-XHTML"
20899 \begin_layout Standard
20900 The sort of XHTML \SpecialChar LyX
20901 outputs for a paragraph depends upon whether we are dealing
20902 with a normal paragraph, a command, or an environment, where this is itself
20903 determined by the contents of the corresponding
20904 \begin_inset Flex Code
20907 \begin_layout Plain Layout
20918 \begin_layout Standard
20919 For a command or normal paragraph, the output XHTML has the following form:
20922 \begin_layout LyX-Code
20924 \begin_inset Quotes erd
20928 \begin_inset Quotes erd
20934 \begin_layout LyX-Code
20936 \begin_inset Quotes erd
20940 \begin_inset Quotes erd
20946 \begin_layout LyX-Code
20947 Contents of the paragraph.
20950 \begin_layout LyX-Code
20954 \begin_layout Standard
20955 The label tags are of course omitted if the paragraph does not have a label.
20958 \begin_layout Standard
20959 For an environment that is not some sort of list, the XHTML takes this form:
20962 \begin_layout LyX-Code
20964 \begin_inset Quotes erd
20968 \begin_inset Quotes erd
20974 \begin_layout LyX-Code
20976 \begin_inset Quotes erd
20980 \begin_inset Quotes erd
20984 \begin_inset Quotes erd
20988 \begin_inset Quotes erd
20991 >Environment Label</labeltag>First paragraph.</itemtag>
20994 \begin_layout LyX-Code
20995 <itemtag>Second paragraph.</itemtag>
20998 \begin_layout LyX-Code
21002 \begin_layout Standard
21003 Note that the label is output only for the first paragraph, as it should
21004 be for a theorem, for example.
21008 \begin_layout Standard
21009 For a list, we have one of these forms:
21012 \begin_layout LyX-Code
21014 \begin_inset Quotes erd
21018 \begin_inset Quotes erd
21024 \begin_layout LyX-Code
21026 \begin_inset Quotes erd
21030 \begin_inset Quotes erd
21034 \begin_inset Quotes erd
21038 \begin_inset Quotes erd
21041 >List Label</labeltag>First item.</itemtag>
21044 \begin_layout LyX-Code
21046 \begin_inset Quotes erd
21050 \begin_inset Quotes erd
21054 \begin_inset Quotes erd
21058 \begin_inset Quotes erd
21061 >List Label</labeltag>Second item.</itemtag>
21064 \begin_layout LyX-Code
21068 \begin_layout LyX-Code
21072 \begin_layout LyX-Code
21074 \begin_inset Quotes erd
21078 \begin_inset Quotes erd
21084 \begin_layout LyX-Code
21086 \begin_inset Quotes erd
21090 \begin_inset Quotes erd
21093 >List Label</labeltag><itemtag attr=
21094 \begin_inset Quotes erd
21098 \begin_inset Quotes erd
21101 >First item.</itemtag>
21104 \begin_layout LyX-Code
21106 \begin_inset Quotes erd
21110 \begin_inset Quotes erd
21113 >List Label</labeltag><itemtag attr=
21114 \begin_inset Quotes erd
21118 \begin_inset Quotes erd
21121 >Second item.</itemtag>
21124 \begin_layout LyX-Code
21128 \begin_layout Standard
21129 Note the different orders of
21130 \begin_inset Flex Code
21133 \begin_layout Plain Layout
21140 \begin_inset Flex Code
21143 \begin_layout Plain Layout
21150 Which order we get depends upon the setting of
21151 \begin_inset Flex Code
21154 \begin_layout Plain Layout
21161 \begin_inset Flex Code
21164 \begin_layout Plain Layout
21170 is false (the default), you get the first of these, with the label within
21171 the item; if true, you get the second, with the label outside the item.
21174 \begin_layout Standard
21175 The specific tags and attributes output for each paragraph type can be controlle
21176 d by means of the layout tags we are about to describe.
21177 As mentioned earlier, however, \SpecialChar LyX
21178 uses sensible defaults for many of these,
21179 so you often may not need to do very much to get good XHTML output.
21180 Think of the available tags as there so you can tweak things to your liking.
21183 \begin_layout Description
21184 \begin_inset Flex Code
21187 \begin_layout Plain Layout
21194 \begin_inset Flex Code
21197 \begin_layout Plain Layout
21203 ] Specifies attribute information to be output with the main tag.
21205 \begin_inset Quotes eld
21209 \begin_inset Flex Code
21212 \begin_layout Plain Layout
21219 \begin_inset Quotes erd
21223 By default, \SpecialChar LyX
21225 \begin_inset Quotes eld
21229 \begin_inset Flex Code
21232 \begin_layout Plain Layout
21239 \begin_inset Quotes erd
21243 \begin_inset Flex Code
21246 \begin_layout Plain Layout
21252 is the \SpecialChar LyX
21253 name of the layout, made lowercase, for example: chapter.
21258 contain any style information.
21260 \begin_inset Flex Code
21263 \begin_layout Plain Layout
21272 \begin_layout Description
21273 \begin_inset Flex Code
21276 \begin_layout Plain Layout
21283 \begin_inset Flex Code
21286 \begin_layout Plain Layout
21296 ] Whether to output the default CSS information \SpecialChar LyX
21297 generates for this layout,
21298 even if additional information is explicitly provided via
21299 \begin_inset Flex Code
21302 \begin_layout Plain Layout
21310 \begin_inset Flex Code
21313 \begin_layout Plain Layout
21319 allows you to alter or augment the generated CSS, rather than to override
21322 \begin_inset Flex Code
21325 \begin_layout Plain Layout
21334 \begin_layout Description
21335 \begin_inset Flex Code
21338 \begin_layout Plain Layout
21345 \begin_inset Flex Code
21348 \begin_layout Plain Layout
21354 ] The tag to be used for individual paragraphs of environments, replacing
21356 \begin_inset Flex Code
21359 \begin_layout Plain Layout
21365 in the examples above.
21367 \begin_inset Flex Code
21370 \begin_layout Plain Layout
21379 \begin_layout Description
21380 \begin_inset Flex Code
21383 \begin_layout Plain Layout
21390 \begin_inset Flex Code
21393 \begin_layout Plain Layout
21399 ] Attributes for the item tag.
21401 \begin_inset Quotes eld
21405 \begin_inset Flex Code
21408 \begin_layout Plain Layout
21409 class=`layoutname_item'
21415 \begin_inset Quotes erd
21423 contain any style information.
21425 \begin_inset Flex Code
21428 \begin_layout Plain Layout
21437 \begin_layout Description
21438 \begin_inset Flex Code
21441 \begin_layout Plain Layout
21448 \begin_inset Flex Code
21451 \begin_layout Plain Layout
21457 ] The tag to be used for paragraph and item labels, replacing
21458 \begin_inset Flex Code
21461 \begin_layout Plain Layout
21467 in the examples above.
21469 \begin_inset Flex Code
21472 \begin_layout Plain Layout
21479 \begin_inset Flex Code
21482 \begin_layout Plain Layout
21489 \begin_inset Flex Code
21492 \begin_layout Plain Layout
21499 \begin_inset Flex Code
21502 \begin_layout Plain Layout
21503 Centered_Top_Environment
21508 , in which case it defaults to
21509 \begin_inset Flex Code
21512 \begin_layout Plain Layout
21521 \begin_layout Description
21522 \begin_inset Flex Code
21525 \begin_layout Plain Layout
21532 \begin_inset Flex Code
21535 \begin_layout Plain Layout
21541 ] Attributes for the label tag.
21543 \begin_inset Quotes eld
21547 \begin_inset Flex Code
21550 \begin_layout Plain Layout
21551 class=`layoutname_label'
21557 \begin_inset Quotes erd
21565 contain any style information.
21567 \begin_inset Flex Code
21570 \begin_layout Plain Layout
21579 \begin_layout Description
21580 \begin_inset Flex Code
21583 \begin_layout Plain Layout
21590 \begin_inset Flex Code
21593 \begin_layout Plain Layout
21603 ] Meaningful only for list-like environments, this tag controls whether
21604 the label tag is output before or inside the item tag.
21605 This is used, for example, in the description environment, where we want
21607 \begin_inset Flex Code
21610 \begin_layout Plain Layout
21611 <dt>\SpecialChar ldots
21612 </dt><dd>\SpecialChar ldots
21620 \begin_inset Flex Code
21623 \begin_layout Plain Layout
21629 : The label tag is output inside the item tag.
21632 \begin_layout Description
21633 \begin_inset Flex Code
21636 \begin_layout Plain Layout
21642 Information to be output in the
21643 \begin_inset Flex Code
21646 \begin_layout Plain Layout
21652 section when this style is used.
21653 This might, for example, be used to include a
21654 \begin_inset Flex Code
21657 \begin_layout Plain Layout
21664 \begin_inset Flex Code
21667 \begin_layout Plain Layout
21676 \begin_layout Description
21677 \begin_inset Flex Code
21680 \begin_layout Plain Layout
21686 CSS style information to be included when this style is used.
21687 Note that this will automatically be wrapped in a layout-generated
21688 \begin_inset Flex Code
21691 \begin_layout Plain Layout
21697 block, so only the CSS itself need be included.
21699 \begin_inset Flex Code
21702 \begin_layout Plain Layout
21711 \begin_layout Description
21712 \begin_inset Flex Code
21715 \begin_layout Plain Layout
21722 \begin_inset Flex Code
21725 \begin_layout Plain Layout
21731 ] The tag to be used for the main label, replacing
21732 \begin_inset Flex Code
21735 \begin_layout Plain Layout
21741 in the examples above.
21743 \begin_inset Flex Code
21746 \begin_layout Plain Layout
21755 \begin_layout Description
21756 \begin_inset Flex Code
21759 \begin_layout Plain Layout
21766 \begin_inset Flex Code
21769 \begin_layout Plain Layout
21779 ] Marks this style as the one to be used to generate the
21780 \begin_inset Flex Code
21783 \begin_layout Plain Layout
21789 tag for the XHTML file.
21790 By default, it is false.
21792 \begin_inset Flex Code
21795 \begin_layout Plain Layout
21801 file sets it to true for the
21802 \begin_inset Flex Code
21805 \begin_layout Plain Layout
21815 \begin_layout Subsection
21819 \begin_layout Standard
21820 The XHTML output of insets can also be controlled by information in layout
21825 \begin_layout Plain Layout
21826 At present, this is true only for
21827 \begin_inset Quotes eld
21831 \begin_inset Quotes erd
21834 insets (insets you can type into) and is not true for
21835 \begin_inset Quotes eld
21839 \begin_inset Quotes erd
21842 insets (insets that are associated with dialog boxes).
21847 Here, too, \SpecialChar LyX
21848 tries to provide sensible defaults, and it constructs default
21850 But everything can be customized.
21853 \begin_layout Standard
21854 The XHTML \SpecialChar LyX
21855 outputs for an inset has the following form:
21858 \begin_layout LyX-Code
21860 \begin_inset Quotes erd
21864 \begin_inset Quotes erd
21870 \begin_layout LyX-Code
21871 <labeltag>Label</labeltag>
21874 \begin_layout LyX-Code
21876 \begin_inset Quotes erd
21880 \begin_inset Quotes erd
21883 >Contents of the inset.</innertag>
21886 \begin_layout LyX-Code
21890 \begin_layout Standard
21891 If the inset permits multiple paragraphs—that is, if
21892 \begin_inset Flex Code
21895 \begin_layout Plain Layout
21901 is true—then the contents of the inset will itself be output as paragraphs
21902 formatted according to the styles used for those paragraphs (standard,
21903 quote, and the like).
21904 The label tag is of course omitted if the paragraph does not have a label
21905 and, at present, is always
21906 \begin_inset Flex Code
21909 \begin_layout Plain Layout
21916 The inner tag is optional and, by default, does not appear.
21919 \begin_layout Standard
21920 The specific tags and attributes output for each inset can be controlled
21921 by means of the following layout tags.
21924 \begin_layout Description
21925 \begin_inset Flex Code
21928 \begin_layout Plain Layout
21935 \begin_inset Flex Code
21938 \begin_layout Plain Layout
21944 ] Specifies attribute information to be output with the main tag.
21946 \begin_inset Quotes eld
21950 \begin_inset Flex Code
21953 \begin_layout Plain Layout
21954 class=`myinset' onclick=`\SpecialChar ldots
21961 \begin_inset Quotes erd
21965 By default, \SpecialChar LyX
21967 \begin_inset Quotes eld
21971 \begin_inset Flex Code
21974 \begin_layout Plain Layout
21981 \begin_inset Quotes erd
21985 \begin_inset Flex Code
21988 \begin_layout Plain Layout
21994 is the \SpecialChar LyX
21995 name of the inset, made lowercase and with non-alphanumeric characters
21996 converted to underscores, for example: footnote.
21999 \begin_layout Description
22000 \begin_inset Flex Code
22003 \begin_layout Plain Layout
22010 \begin_inset Flex Code
22013 \begin_layout Plain Layout
22023 ] Whether to output the default CSS information \SpecialChar LyX
22024 generates for this layout,
22025 even if additional information is explicitly provided via
22026 \begin_inset Flex Code
22029 \begin_layout Plain Layout
22037 \begin_inset Flex Code
22040 \begin_layout Plain Layout
22046 allows you to alter or augment the generated CSS, rather than to override
22051 \begin_layout Description
22052 \begin_inset Flex Code
22055 \begin_layout Plain Layout
22062 \begin_inset Flex Code
22065 \begin_layout Plain Layout
22071 ] Attributes for the inner tag.
22073 \begin_inset Quotes eld
22077 \begin_inset Flex Code
22080 \begin_layout Plain Layout
22081 class=`insetname_inner'
22087 \begin_inset Quotes erd
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 ] The inner tag, replacing
22114 \begin_inset Flex Code
22117 \begin_layout Plain Layout
22123 in the examples above.
22124 By default, there is none.
22127 \begin_layout Description
22128 \begin_inset Flex Code
22131 \begin_layout Plain Layout
22138 \begin_inset Flex Code
22141 \begin_layout Plain Layout
22149 ] Whether this inset represents a standalone block of text (such as a footnote)
22150 or instead represents material that is included in the surrounding text
22151 (such as a branch).
22155 \begin_layout Description
22156 \begin_inset Flex Code
22159 \begin_layout Plain Layout
22166 \begin_inset Flex Code
22169 \begin_layout Plain Layout
22175 ] A label for this inset, possibly including a reference to a counter.
22176 For example, for footnote, it might be:
22177 \begin_inset Flex Code
22180 \begin_layout Plain Layout
22189 This is optional, and there is no default.
22192 \begin_layout Description
22193 \begin_inset Flex Code
22196 \begin_layout Plain Layout
22202 Information to be output in the
22203 \begin_inset Flex Code
22206 \begin_layout Plain Layout
22212 section when this style is used.
22213 This might, for example, be used to include a
22214 \begin_inset Flex Code
22217 \begin_layout Plain Layout
22224 \begin_inset Flex Code
22227 \begin_layout Plain Layout
22236 \begin_layout Description
22237 \begin_inset Flex Code
22240 \begin_layout Plain Layout
22246 CSS style information to be included when this style is used.
22247 Note that this will automatically be wrapped in a layout-generated
22248 \begin_inset Flex Code
22251 \begin_layout Plain Layout
22257 block, so only the CSS itself need be included.
22260 \begin_layout Description
22261 \begin_inset Flex Code
22264 \begin_layout Plain Layout
22271 \begin_inset Flex Code
22274 \begin_layout Plain Layout
22280 ] The tag to be used for the main label, replacing
22281 \begin_inset Flex Code
22284 \begin_layout Plain Layout
22290 in the examples above.
22291 The default depends upon the setting of
22292 \begin_inset Flex Code
22295 \begin_layout Plain Layout
22302 \begin_inset Flex Code
22305 \begin_layout Plain Layout
22311 is true, the default is
22312 \begin_inset Flex Code
22315 \begin_layout Plain Layout
22321 ; if it is false, the default is
22322 \begin_inset Flex Code
22325 \begin_layout Plain Layout
22334 \begin_layout Subsection
22338 \begin_layout Standard
22339 The XHTML output for floats too can be controlled by layout information.
22340 The output has the following form:
22343 \begin_layout LyX-Code
22345 \begin_inset Quotes erd
22349 \begin_inset Quotes erd
22355 \begin_layout LyX-Code
22356 Contents of the float.
22359 \begin_layout LyX-Code
22363 \begin_layout Standard
22364 The caption, if there is one, is a separate inset and will be output as
22366 Its appearance can be controlled via the InsetLayout for caption insets.
22370 \begin_layout Description
22371 \begin_inset Flex Code
22374 \begin_layout Plain Layout
22381 \begin_inset Flex Code
22384 \begin_layout Plain Layout
22390 ] Specifies attribute information to be output with the main tag.
22392 \begin_inset Quotes eld
22396 \begin_inset Flex Code
22399 \begin_layout Plain Layout
22400 class=`myfloat' onclick=`\SpecialChar ldots
22407 \begin_inset Quotes erd
22411 By default, \SpecialChar LyX
22413 \begin_inset Quotes eld
22417 \begin_inset Flex Code
22420 \begin_layout Plain Layout
22421 class=`float float-floattype'
22427 \begin_inset Quotes erd
22431 \begin_inset Flex Code
22434 \begin_layout Plain Layout
22440 is \SpecialChar LyX
22441 's name for this type of float, as determined by the float declaration
22443 \begin_inset CommandInset ref
22445 reference "subsec:Floats"
22449 ), though made lowercase and with non-alphanumeric characters converted
22450 to underscores, for example: float-table.
22453 \begin_layout Description
22454 \begin_inset Flex Code
22457 \begin_layout Plain Layout
22463 CSS style information to be included when this float is used.
22464 Note that this will automatically be wrapped in a layout-generated
22465 \begin_inset Flex Code
22468 \begin_layout Plain Layout
22474 block, so only the CSS itself need be included.
22477 \begin_layout Description
22478 \begin_inset Flex Code
22481 \begin_layout Plain Layout
22488 \begin_inset Flex Code
22491 \begin_layout Plain Layout
22497 ] The tag to be used for this float, replacing
22498 \begin_inset Quotes eld
22502 \begin_inset Flex Code
22505 \begin_layout Plain Layout
22512 \begin_inset Quotes erd
22515 in the example above.
22517 \begin_inset Flex Code
22520 \begin_layout Plain Layout
22526 and will rarely need changing.
22529 \begin_layout Subsection
22530 Bibliography formatting
22533 \begin_layout Standard
22534 The bibliography can be formatted using
22535 \begin_inset Flex Code
22538 \begin_layout Plain Layout
22546 \begin_inset CommandInset ref
22548 reference "subsec:Citation-format-description"
22555 \begin_layout Subsection
22560 \begin_layout Standard
22561 We have several times mentioned that \SpecialChar LyX
22562 will generate default CSS style rules
22563 for both insets and paragraph styles, based upon the other layout information
22565 In this section, we shall say a word about which layout information \SpecialChar LyX
22570 \begin_layout Standard
22571 At present, \SpecialChar LyX
22572 auto-generates CSS only for font information, making use of
22574 \begin_inset Flex Code
22577 \begin_layout Plain Layout
22584 \begin_inset Flex Code
22587 \begin_layout Plain Layout
22594 \begin_inset Flex Code
22597 \begin_layout Plain Layout
22604 \begin_inset Flex Code
22607 \begin_layout Plain Layout
22614 \begin_inset Flex Code
22617 \begin_layout Plain Layout
22624 \begin_inset CommandInset ref
22626 reference "subsec:Font-description"
22631 The translation is mostly straightforward and obvious.
22633 \begin_inset Quotes eld
22637 \begin_inset Flex Code
22640 \begin_layout Plain Layout
22647 \begin_inset Quotes erd
22651 \begin_inset Quotes eld
22655 \begin_inset Flex Code
22658 \begin_layout Plain Layout
22659 font-family: sans-serif;
22665 \begin_inset Quotes erd
22669 The correspondence of \SpecialChar LyX
22670 sizes and CSS sizes is a little less obvious but
22671 nonetheless intuitive.
22673 \begin_inset Flex Code
22676 \begin_layout Plain Layout
22683 \begin_inset Flex URL
22686 \begin_layout Plain Layout
22696 \begin_layout Chapter
22697 Including External Material
22698 \begin_inset CommandInset label
22700 name "chap:Including-External-Material"
22707 \begin_layout Standard
22708 \begin_inset Box Shadowbox
22718 height_special "totalheight"
22723 backgroundcolor "none"
22726 \begin_layout Plain Layout
22727 WARNING: This portion of the documentation has not been updated for some
22729 We certainly hope that it is still accurate, but there are no guarantees.
22737 \begin_layout Standard
22738 The use of material from sources external to \SpecialChar LyX
22739 is covered in detail in the
22745 This part of the manual covers what needs to happen behind the scenes for
22746 new sorts of material to be included.
22749 \begin_layout Section
22753 \begin_layout Standard
22754 The external material feature is based on the concept of a
22759 A template is a specification of how \SpecialChar LyX
22760 should interface with a certain kind
22762 As bundled, \SpecialChar LyX
22763 comes with predefined templates for Xfig figures, various
22764 raster format images, chess diagrams, and LilyPond music notation.
22765 You can check the actual list by using the menu
22766 \begin_inset Flex MenuItem
22769 \begin_layout Plain Layout
22770 Insert\SpecialChar menuseparator
22771 File\SpecialChar menuseparator
22778 Furthermore, it is possible to roll your own template to support a specific
22780 Later we'll describe in more detail what is involved, and hopefully you
22781 will submit all the templates you create so we can include them in a later
22786 \begin_layout Standard
22787 Another basic idea of the external material feature is to distinguish between
22788 the original file that serves as a base for final material and the produced
22789 file that is included in your exported or printed document.
22790 For example, consider the case of a figure produced with
22791 \begin_inset Flex Code
22794 \begin_layout Plain Layout
22801 The Xfig application itself works on an original file with the
22802 \begin_inset Flex Code
22805 \begin_layout Plain Layout
22812 Within Xfig, you create and change your figure, and when you are done,
22814 \begin_inset Flex Code
22817 \begin_layout Plain Layout
22824 When you want to include the figure in your document, you invoke
22825 \begin_inset Flex Code
22828 \begin_layout Plain Layout
22834 in order to create a PostScript file that can readily be included in your
22838 \begin_inset Flex Code
22841 \begin_layout Plain Layout
22847 file is the original file, and the PostScript file is the produced file.
22850 \begin_layout Standard
22851 This distinction is important in order to allow updating of the material
22852 while you are in the process of writing the document.
22853 Furthermore, it provides us with the flexibility that is needed to support
22854 multiple export formats.
22855 For instance, in the case of a plain text file, it is not exactly an award-winn
22856 ing idea to include the figure as raw PostScript.
22857 Instead, you would either prefer to just include a reference to the figure
22858 or try to invoke some graphics to ASCII converter to make the final result
22859 look similar to the real graphics.
22860 The external material management allows you to do this, because it is parametri
22861 zed on the different export formats that \SpecialChar LyX
22865 \begin_layout Standard
22866 Besides supporting the production of different products according to the
22867 exported format, it supports tight integration with editing and viewing
22869 In the case of an Xfig figure, you are able to invoke Xfig on the original
22870 file with a single click from within the external material dialog in \SpecialChar LyX
22872 and also preview the produced PostScript file with Ghostview with another
22874 No more fiddling around with the command line and/or file browsers to locate
22875 and manipulate the original or produced files.
22876 In this way, you are finally able to take full advantage of the many different
22877 applications that are relevant to use when you write your documents, and
22878 ultimately be more productive.
22881 \begin_layout Section
22882 The external template configuration file
22885 \begin_layout Standard
22886 It is relatively easy to add custom external template definitions to \SpecialChar LyX
22888 However, be aware that doing this in an careless manner most probably
22892 introduce an easily exploitable security hole.
22893 So before you do this, please read the discussion about security in
22894 \begin_inset CommandInset ref
22896 reference "sec:Security-discussion"
22903 \begin_layout Standard
22904 Having said that, we encourage you to submit any interesting templates that
22909 \begin_layout Standard
22910 The external templates are defined in the
22911 \begin_inset Flex Code
22914 \begin_layout Plain Layout
22915 LyXDir/lib/external_templates
22921 You can place your own version in
22922 \begin_inset Flex Code
22925 \begin_layout Plain Layout
22926 UserDir/external_templates
22934 \begin_layout Standard
22935 A typical template looks like this:
22938 \begin_layout LyX-Code
22942 \begin_layout LyX-Code
22943 GuiName "XFig: $$AbsOrRelPathParent$$Basename"
22946 \begin_layout LyX-Code
22950 \begin_layout LyX-Code
22954 \begin_layout LyX-Code
22958 \begin_layout LyX-Code
22962 \begin_layout LyX-Code
22966 \begin_layout LyX-Code
22967 AutomaticProduction true
22970 \begin_layout LyX-Code
22974 \begin_layout LyX-Code
22978 \begin_layout LyX-Code
22979 Format \SpecialChar LaTeX
22983 \begin_layout LyX-Code
22984 TransformCommand Rotate RotationLatexCommand
22987 \begin_layout LyX-Code
22988 TransformCommand Resize ResizeLatexCommand
22991 \begin_layout LyX-Code
22992 Product "$$RotateFront$$ResizeFront
22995 \begin_layout LyX-Code
23000 input{$$AbsOrRelPathMaster$$Basename.pstex_t}
23003 \begin_layout LyX-Code
23004 $$ResizeBack$$RotateBack"
23007 \begin_layout LyX-Code
23011 \begin_layout LyX-Code
23012 UpdateResult "$$AbsPath$$Basename.pstex_t"
23015 \begin_layout LyX-Code
23016 Requirement "graphicx"
23019 \begin_layout LyX-Code
23020 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
23023 \begin_layout LyX-Code
23024 ReferencedFile latex "$$AbsPath$$Basename.eps"
23027 \begin_layout LyX-Code
23028 ReferencedFile dvi "$$AbsPath$$Basename.eps"
23031 \begin_layout LyX-Code
23035 \begin_layout LyX-Code
23036 Format PDF\SpecialChar LaTeX
23040 \begin_layout LyX-Code
23041 TransformCommand Rotate RotationLatexCommand
23044 \begin_layout LyX-Code
23045 TransformCommand Resize ResizeLatexCommand
23048 \begin_layout LyX-Code
23049 Product "$$RotateFront$$ResizeFront
23052 \begin_layout LyX-Code
23057 input{$$AbsOrRelPathMaster$$Basename.pdftex_t}
23060 \begin_layout LyX-Code
23061 $$ResizeBack$$RotateBack"
23064 \begin_layout LyX-Code
23065 UpdateFormat pdftex
23068 \begin_layout LyX-Code
23069 UpdateResult "$$AbsPath$$Basename.pdftex_t"
23072 \begin_layout LyX-Code
23073 Requirement "graphicx"
23076 \begin_layout LyX-Code
23077 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pdftex_t"
23080 \begin_layout LyX-Code
23081 ReferencedFile latex "$$AbsPath$$Basename.pdf"
23084 \begin_layout LyX-Code
23088 \begin_layout LyX-Code
23092 \begin_layout LyX-Code
23093 Product "$$Contents(
23095 "$$AbsPath$$Basename.asc
23100 \begin_layout LyX-Code
23101 UpdateFormat asciixfig
23104 \begin_layout LyX-Code
23105 UpdateResult "$$AbsPath$$Basename.asc"
23108 \begin_layout LyX-Code
23112 \begin_layout LyX-Code
23116 \begin_layout LyX-Code
23117 Product "<graphic fileref=
23119 "$$AbsOrRelPathMaster$$Basename.eps
23124 \begin_layout LyX-Code
23128 \begin_layout LyX-Code
23132 \begin_layout LyX-Code
23133 UpdateResult "$$AbsPath$$Basename.eps"
23136 \begin_layout LyX-Code
23137 ReferencedFile docbook "$$AbsPath$$Basename.eps"
23140 \begin_layout LyX-Code
23141 ReferencedFile docbook-xml "$$AbsPath$$Basename.eps"
23144 \begin_layout LyX-Code
23148 \begin_layout LyX-Code
23149 Product "[XFig: $$FName]"
23152 \begin_layout LyX-Code
23156 \begin_layout LyX-Code
23160 \begin_layout Standard
23161 As you can see, the template is enclosed in
23162 \begin_inset Flex Code
23165 \begin_layout Plain Layout
23173 \begin_inset Flex Code
23176 \begin_layout Plain Layout
23183 It contains a header specifying some general settings and, for each supported
23184 primary document file format, a section
23185 \begin_inset Flex Code
23188 \begin_layout Plain Layout
23196 \begin_inset Flex Code
23199 \begin_layout Plain Layout
23208 \begin_layout Subsection
23209 The template header
23212 \begin_layout Description
23213 \begin_inset Flex Code
23216 \begin_layout Plain Layout
23217 AutomaticProduction
23218 \begin_inset space ~
23226 Whether the file represented by the template must be generated by \SpecialChar LyX
23228 This command must occur exactly once.
23231 \begin_layout Description
23232 \begin_inset Flex Code
23235 \begin_layout Plain Layout
23237 \begin_inset space ~
23245 A glob pattern that is used in the file dialog to filter out the desired
23247 If there is more than one possible file extension (e.
23248 \begin_inset space \thinspace{}
23252 \begin_inset space \space{}
23256 \begin_inset Flex Code
23259 \begin_layout Plain Layout
23266 \begin_inset Flex Code
23269 \begin_layout Plain Layout
23275 ), use something like
23276 \begin_inset Flex Code
23279 \begin_layout Plain Layout
23286 This command must occur exactly once.
23289 \begin_layout Description
23290 \begin_inset Flex Code
23293 \begin_layout Plain Layout
23295 \begin_inset space ~
23303 The text that is displayed on the button.
23304 This command must occur exactly once.
23307 \begin_layout Description
23308 \begin_inset Flex Code
23311 \begin_layout Plain Layout
23313 \begin_inset space ~
23317 \begin_inset space ~
23325 The help text that is used in the External dialog.
23326 Provide enough information to explain to the user just what the template
23327 can provide him with.
23328 This command must occur exactly once.
23331 \begin_layout Description
23332 \begin_inset Flex Code
23335 \begin_layout Plain Layout
23337 \begin_inset space ~
23345 The file format of the original file.
23346 This must be the name of a format that is known to \SpecialChar LyX
23348 \begin_inset CommandInset ref
23350 reference "sec:Formats"
23356 \begin_inset Quotes eld
23360 \begin_inset Flex Code
23363 \begin_layout Plain Layout
23370 \begin_inset Quotes erd
23373 if the template can handle original files of more than one format.
23375 will attempt to interrogate the file itself in order to deduce its format
23377 This command must occur exactly once.
23380 \begin_layout Description
23381 \begin_inset Flex Code
23384 \begin_layout Plain Layout
23386 \begin_inset space ~
23394 A unique name for the template.
23395 It must not contain substitution macros (see below).
23398 \begin_layout Description
23399 \begin_inset Flex Code
23402 \begin_layout Plain Layout
23404 \begin_inset space ~
23407 Rotate|Resize|Clip|Extra
23412 This command specifies which transformations are supported by this template.
23413 It may occur zero or more times.
23414 This command enables the corresponding tabs in the external dialog.
23416 \begin_inset Flex Code
23419 \begin_layout Plain Layout
23425 command must have either a corresponding
23426 \begin_inset Flex Code
23429 \begin_layout Plain Layout
23436 \begin_inset Flex Code
23439 \begin_layout Plain Layout
23446 \begin_inset Flex Code
23449 \begin_layout Plain Layout
23456 Otherwise the transformation will not be supported by that format.
23459 \begin_layout Subsection
23463 \begin_layout Description
23464 \begin_inset Flex Code
23467 \begin_layout Plain Layout
23469 \begin_inset space ~
23472 LaTeX|PDFLaTeX|PlainText|DocBook
23477 The primary document file format that this format definition is for.
23478 Not every template has a sensible representation in all document file formats.
23479 Please define nevertheless a
23480 \begin_inset Flex Code
23483 \begin_layout Plain Layout
23489 section for all templates.
23490 Use a dummy text when no representation is available.
23491 Then you can at least see a reference to the external material in the exported
23495 \begin_layout Description
23496 \begin_inset Flex Code
23499 \begin_layout Plain Layout
23501 \begin_inset space ~
23505 \begin_inset space ~
23513 This command defines an additional macro
23514 \begin_inset Flex Code
23517 \begin_layout Plain Layout
23523 for substitution in
23524 \begin_inset Flex Code
23527 \begin_layout Plain Layout
23535 \begin_inset Flex Code
23538 \begin_layout Plain Layout
23544 itself may contain substitution macros.
23545 The advantage over using
23546 \begin_inset Flex Code
23549 \begin_layout Plain Layout
23556 \begin_inset Flex Code
23559 \begin_layout Plain Layout
23565 is that the substituted value of
23566 \begin_inset Flex Code
23569 \begin_layout Plain Layout
23575 is sanitized so that it is a valid optional argument in the document format.
23576 This command may occur zero or more times.
23579 \begin_layout Description
23580 \begin_inset Flex Code
23583 \begin_layout Plain Layout
23585 \begin_inset space ~
23593 The text that is inserted in the exported document.
23594 This is actually the most important command and can be quite complex.
23595 This command must occur exactly once.
23598 \begin_layout Description
23599 \begin_inset Flex Code
23602 \begin_layout Plain Layout
23604 \begin_inset space ~
23612 This command specifies a preamble snippet that will be included in the
23615 It has to be defined using
23616 \begin_inset Flex Code
23619 \begin_layout Plain Layout
23627 \begin_inset Flex Code
23630 \begin_layout Plain Layout
23637 This command may occur zero or more times.
23640 \begin_layout Description
23641 \begin_inset Flex Code
23644 \begin_layout Plain Layout
23646 \begin_inset space ~
23650 \begin_inset space ~
23658 This command denotes files that are created by the conversion process and
23659 are needed for a particular export format.
23660 If the filename is relative, it is interpreted relative to the master document.
23661 This command may be given zero or more times.
23664 \begin_layout Description
23665 \begin_inset Flex Code
23668 \begin_layout Plain Layout
23670 \begin_inset space ~
23678 The name of a required \SpecialChar LaTeX
23680 The package is included via
23681 \begin_inset Flex Code
23684 \begin_layout Plain Layout
23692 in the \SpecialChar LaTeX
23694 This command may occur zero or more times.
23697 \begin_layout Description
23698 \begin_inset Flex Code
23701 \begin_layout Plain Layout
23703 \begin_inset space ~
23707 \begin_inset space ~
23710 RotationLatexCommand
23715 This command specifies that the built in \SpecialChar LaTeX
23716 command should be used for rotation.
23717 This command may occur once or not at all.
23720 \begin_layout Description
23721 \begin_inset Flex Code
23724 \begin_layout Plain Layout
23726 \begin_inset space ~
23730 \begin_inset space ~
23738 This command specifies that the built in \SpecialChar LaTeX
23739 command should be used for resizing.
23740 This command may occur once or not at all.
23743 \begin_layout Description
23744 \begin_inset Flex Code
23747 \begin_layout Plain Layout
23749 \begin_inset space ~
23753 \begin_inset space ~
23756 RotationLatexOption
23761 This command specifies that rotation is done via an optional argument.
23762 This command may occur once or not at all.
23765 \begin_layout Description
23766 \begin_inset Flex Code
23769 \begin_layout Plain Layout
23771 \begin_inset space ~
23775 \begin_inset space ~
23783 This command specifies that resizing is done via an optional argument.
23784 This command may occur once or not at all.
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 specifies that clipping is done via an optional argument.
23806 This command may occur once or not at all.
23809 \begin_layout Description
23810 \begin_inset Flex Code
23813 \begin_layout Plain Layout
23815 \begin_inset space ~
23819 \begin_inset space ~
23827 This command specifies that an extra optional argument is used.
23828 This command may occur once or not at all.
23831 \begin_layout Description
23832 \begin_inset Flex Code
23835 \begin_layout Plain Layout
23837 \begin_inset space ~
23845 The file format of the converted file.
23846 This must be the name of a format that is known to \SpecialChar LyX
23848 \begin_inset Flex MenuItem
23851 \begin_layout Plain Layout
23852 Tools\SpecialChar menuseparator
23853 Preferences\SpecialChar menuseparator
23854 File Handling\SpecialChar menuseparator
23861 This command must occur exactly once.
23862 If the resulting file format is PDF, you need to specify the format
23863 \begin_inset Flex Code
23866 \begin_layout Plain Layout
23873 This is the PDF format used for including graphics.
23874 The other defined PDF formats are for document export.
23877 \begin_layout Description
23878 \begin_inset Flex Code
23881 \begin_layout Plain Layout
23883 \begin_inset space ~
23891 The file name of the converted file.
23892 The file name must be absolute.
23893 This command must occur exactly once.
23896 \begin_layout Subsection
23897 Preamble definitions
23900 \begin_layout Standard
23901 The external template configuration file may contain additional preamble
23902 definitions enclosed by
23903 \begin_inset Flex Code
23906 \begin_layout Plain Layout
23914 \begin_inset Flex Code
23917 \begin_layout Plain Layout
23924 They can be used by the templates in the
23925 \begin_inset Flex Code
23928 \begin_layout Plain Layout
23937 \begin_layout Section
23938 The substitution mechanism
23941 \begin_layout Standard
23942 When the external material facility invokes an external program, it is done
23943 on the basis of a command defined in the template configuration file.
23944 These commands can contain various macros that are expanded before execution.
23945 Execution always take place in the directory of the containing document.
23948 \begin_layout Standard
23949 Also, whenever external material is to be displayed, the name will be produced
23950 by the substitution mechanism, and most other commands in the template
23951 definition support substitution as well.
23954 \begin_layout Standard
23955 The available macros are the following:
23958 \begin_layout Description
23959 \begin_inset Flex Code
23962 \begin_layout Plain Layout
23963 $$AbsOrRelPathMaster
23968 The file path, absolute or relative to the master \SpecialChar LyX
23972 \begin_layout Description
23973 \begin_inset Flex Code
23976 \begin_layout Plain Layout
23977 $$AbsOrRelPathParent
23982 The file path, absolute or relative to the \SpecialChar LyX
23986 \begin_layout Description
23987 \begin_inset Flex Code
23990 \begin_layout Plain Layout
23996 The absolute file path.
23999 \begin_layout Description
24000 \begin_inset Flex Code
24003 \begin_layout Plain Layout
24009 The filename without path and without the extension.
24012 \begin_layout Description
24013 \begin_inset Flex Code
24016 \begin_layout Plain Layout
24018 \begin_inset Quotes eld
24022 \begin_inset Quotes erd
24030 This macro will expand to the contents of the file with the name
24031 \begin_inset Flex Code
24034 \begin_layout Plain Layout
24043 \begin_layout Description
24044 \begin_inset Flex Code
24047 \begin_layout Plain Layout
24053 The file extension (including the dot).
24054 \change_inserted -195340706 1437418878
24058 \begin_layout Description
24060 \change_inserted -195340706 1437418878
24061 \begin_inset Flex Code
24064 \begin_layout Plain Layout
24066 \change_inserted -195340706 1437418878
24072 This will be the string
24073 \begin_inset Quotes eld
24077 \begin_inset Quotes erd
24080 if the file is in JPEG format, otherwise it will be the string
24081 \begin_inset Quotes eld
24085 \begin_inset Quotes erd
24089 This is useful to avoid uneeded conversions for output formats that support
24090 both PNG and JPEG fomats.
24091 The predefined RasterImage template uses this macro for the PDFL
24092 \change_deleted -712698321 1437634446
24094 \change_inserted -712698321 1437634446
24096 \change_inserted -195340706 1437418878
24102 \begin_layout Description
24103 \begin_inset Flex Code
24106 \begin_layout Plain Layout
24112 The filename of the file specified in the external material dialog.
24113 This is either an absolute name, or it is relative to the \SpecialChar LyX
24117 \begin_layout Description
24118 \begin_inset Flex Code
24121 \begin_layout Plain Layout
24128 \begin_inset Flex Code
24131 \begin_layout Plain Layout
24137 (absolute name or relative to the \SpecialChar LyX
24141 \begin_layout Description
24142 \begin_inset Flex Code
24145 \begin_layout Plain Layout
24151 The file path, relative to the master \SpecialChar LyX
24155 \begin_layout Description
24156 \begin_inset Flex Code
24159 \begin_layout Plain Layout
24165 The file path, relative to the \SpecialChar LyX
24169 \begin_layout Description
24170 \begin_inset Flex Code
24173 \begin_layout Plain Layout
24179 This macro will expand to the absolute path of the system directory.
24180 This is typically used to point to the various helper scripts that are
24181 bundled with \SpecialChar LyX
24185 \begin_layout Description
24186 \begin_inset Flex Code
24189 \begin_layout Plain Layout
24195 A name and full path to a temporary file which will be automatically deleted
24196 whenever the containing document is closed, or the external material insertion
24200 \begin_layout Standard
24201 All path macros contain a trailing directory separator, so you can construct
24203 \begin_inset space \thinspace{}
24207 \begin_inset space \space{}
24210 the absolute filename with
24211 \begin_inset Flex Code
24214 \begin_layout Plain Layout
24215 $$AbsPath$$Basename$$Extension
24223 \begin_layout Standard
24224 The macros above are substituted in all commands unless otherwise noted.
24226 \begin_inset Flex Code
24229 \begin_layout Plain Layout
24235 supports additionally the following substitutions if they are enabled by
24237 \begin_inset Flex Code
24240 \begin_layout Plain Layout
24247 \begin_inset Flex Code
24250 \begin_layout Plain Layout
24259 \begin_layout Description
24260 \begin_inset Flex Code
24263 \begin_layout Plain Layout
24269 The front part of the resize command.
24272 \begin_layout Description
24273 \begin_inset Flex Code
24276 \begin_layout Plain Layout
24282 The back part of the resize command.
24285 \begin_layout Description
24286 \begin_inset Flex Code
24289 \begin_layout Plain Layout
24295 The front part of the rotation command.
24298 \begin_layout Description
24299 \begin_inset Flex Code
24302 \begin_layout Plain Layout
24308 The back part of the rotation command.
24311 \begin_layout Standard
24312 The value string of the
24313 \begin_inset Flex Code
24316 \begin_layout Plain Layout
24322 command supports additionally the following substitutions if they are enabled
24324 \begin_inset Flex Code
24327 \begin_layout Plain Layout
24334 \begin_inset Flex Code
24337 \begin_layout Plain Layout
24346 \begin_layout Description
24347 \begin_inset Flex Code
24350 \begin_layout Plain Layout
24359 \begin_layout Description
24360 \begin_inset Flex Code
24363 \begin_layout Plain Layout
24372 \begin_layout Description
24373 \begin_inset Flex Code
24376 \begin_layout Plain Layout
24385 \begin_layout Description
24386 \begin_inset Flex Code
24389 \begin_layout Plain Layout
24395 The rotation option.
24398 \begin_layout Standard
24399 You may ask why there are so many path macros.
24400 There are mainly two reasons:
24403 \begin_layout Enumerate
24404 Relative and absolute file names should remain relative or absolute, respectivel
24406 Users may have reasons to prefer either form.
24407 Relative names are useful for portable documents that should work on different
24408 machines, for example.
24409 Absolute names may be required by some programs.
24412 \begin_layout Enumerate
24414 treats relative file names differently than \SpecialChar LyX
24415 and other programs in nested
24417 For \SpecialChar LyX
24418 , a relative file name is always relative to the document that contains
24420 For \SpecialChar LaTeX
24421 , it is always relative to the master document.
24422 These two definitions are identical if you have only one document, but
24423 differ if you have a master document that includes part documents.
24424 That means that relative filenames must be transformed when presented to
24427 Fortunately \SpecialChar LyX
24428 does this automatically for you if you choose the right macros.
24431 \begin_layout Standard
24432 So which path macro should be used in new template definitions? The rule
24436 \begin_layout Itemize
24438 \begin_inset Flex Code
24441 \begin_layout Plain Layout
24447 if an absolute path is required.
24450 \begin_layout Itemize
24452 \begin_inset Flex Code
24455 \begin_layout Plain Layout
24456 $$AbsOrRelPathMaster
24461 if the substituted string is some kind of \SpecialChar LaTeX
24465 \begin_layout Itemize
24467 \begin_inset Flex Code
24470 \begin_layout Plain Layout
24471 $$AbsOrRelPathParent
24476 in order to preserve the user's choice.
24479 \begin_layout Standard
24480 There are special cases where this rule does not work and e.
24481 \begin_inset space \thinspace{}
24485 \begin_inset space \space{}
24488 relative names are needed, but normally it will work just fine.
24489 One example for such a case is the command
24490 \begin_inset Flex Code
24493 \begin_layout Plain Layout
24494 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
24499 in the XFig template above: We can't use the absolute name because the
24501 \begin_inset Flex Code
24504 \begin_layout Plain Layout
24510 files needs the relative name in order to rewrite the file content.
24513 \begin_layout Section
24514 Security discussion
24515 \begin_inset CommandInset label
24517 name "sec:Security-discussion"
24524 \begin_layout Standard
24525 The external material feature interfaces with a lot of external programs
24526 and does so automatically, so we have to consider the security implications
24528 In particular, since you have the option of including your own filenames
24529 and/or parameter strings and those are expanded into a command, it seems
24530 that it would be possible to create a malicious document which executes
24531 arbitrary commands when a user views or prints the document.
24532 This is something we definitely want to avoid.
24535 \begin_layout Standard
24536 However, since the external program commands are specified in the template
24537 configuration file only, there are no security issues if \SpecialChar LyX
24538 is properly configure
24539 d with safe templates only.
24540 This is so because the external programs are invoked with the
24541 \begin_inset Flex Code
24544 \begin_layout Plain Layout
24550 -system call rather than the
24551 \begin_inset Flex Code
24554 \begin_layout Plain Layout
24560 system-call, so it's not possible to execute arbitrary commands from the
24561 filename or parameter section via the shell.
24564 \begin_layout Standard
24565 This also implies that you are restricted in what command strings you can
24566 use in the external material templates.
24567 In particular, pipes and redirection are not readily available.
24568 This has to be so if \SpecialChar LyX
24569 should remain safe.
24570 If you want to use some of the shell features, you should write a safe
24571 script to do this in a controlled manner, and then invoke the script from
24572 the command string.
24576 \begin_layout Standard
24577 It is possible to design a template that interacts directly with the shell,
24578 but since this would allow a malicious user to execute arbitrary commands
24579 by writing clever filenames and/or parameters, we generally recommend that
24580 you only use safe scripts that work with the
24581 \begin_inset Flex Code
24584 \begin_layout Plain Layout
24590 system call in a controlled manner.
24591 Of course, for use in a controlled environment, it can be tempting to just
24592 fall back to use ordinary shell scripts.
24593 If you do so, be aware that you
24597 provide an easily exploitable security hole in your system.
24598 Of course it stands to reason that such unsafe templates will never be
24599 included in the standard \SpecialChar LyX
24600 distribution, although we do encourage people
24601 to submit new templates in the open source tradition.
24602 But \SpecialChar LyX
24603 as shipped from the official distribution channels will never have
24607 \begin_layout Standard
24608 Including external material provides a lot of power, and you have to be
24609 careful not to introduce security hazards with this power.
24610 A subtle error in a single line in an innocent looking script can open
24611 the door to huge security problems.
24612 So if you do not fully understand the issues, we recommend that you consult
24613 a knowledgeable security professional or the \SpecialChar LyX
24614 development team if you have
24615 any questions about whether a given template is safe or not.
24616 And do this before you use it in an uncontrolled environment.
24619 \begin_layout Chapter
24621 List of supported \SpecialChar LyX
24622 functions to be used in layouts
24623 \begin_inset CommandInset label
24625 name "chap:List-of-functions"
24632 \begin_layout Standard
24634 \begin_inset Tabular
24635 <lyxtabular version="3" rows="11" columns="8">
24636 <features tabularvalignment="middle">
24637 <column alignment="left" valignment="top">
24638 <column alignment="left" valignment="top">
24639 <column alignment="left" valignment="top">
24640 <column alignment="left" valignment="top">
24641 <column alignment="left" valignment="top">
24642 <column alignment="left" valignment="top">
24643 <column alignment="left" valignment="top">
24644 <column alignment="left" valignment="top">
24646 <cell alignment="left" valignment="top" usebox="none">
24649 \begin_layout Plain Layout
24655 <cell alignment="left" valignment="top" usebox="none">
24658 \begin_layout Plain Layout
24664 <cell alignment="left" valignment="top" usebox="none">
24667 \begin_layout Plain Layout
24673 <cell alignment="left" valignment="top" usebox="none">
24676 \begin_layout Plain Layout
24682 <cell alignment="center" valignment="top" usebox="none">
24685 \begin_layout Plain Layout
24691 <cell alignment="center" valignment="top" usebox="none">
24694 \begin_layout Plain Layout
24700 <cell alignment="center" valignment="top" usebox="none">
24703 \begin_layout Plain Layout
24709 <cell alignment="center" valignment="top" usebox="none">
24712 \begin_layout Plain Layout
24720 <cell alignment="left" valignment="top" usebox="none">
24723 \begin_layout Plain Layout
24729 <cell alignment="left" valignment="top" usebox="none">
24732 \begin_layout Plain Layout
24738 <cell alignment="left" valignment="top" usebox="none">
24741 \begin_layout Plain Layout
24747 <cell alignment="left" valignment="top" usebox="none">
24750 \begin_layout Plain Layout
24756 <cell alignment="center" valignment="top" usebox="none">
24759 \begin_layout Plain Layout
24765 <cell alignment="center" valignment="top" usebox="none">
24768 \begin_layout Plain Layout
24774 <cell alignment="center" valignment="top" usebox="none">
24777 \begin_layout Plain Layout
24783 <cell alignment="center" valignment="top" usebox="none">
24786 \begin_layout Plain Layout
24794 <cell alignment="left" valignment="top" usebox="none">
24797 \begin_layout Plain Layout
24803 <cell alignment="left" valignment="top" usebox="none">
24806 \begin_layout Plain Layout
24812 <cell alignment="left" valignment="top" usebox="none">
24815 \begin_layout Plain Layout
24821 <cell alignment="left" valignment="top" usebox="none">
24824 \begin_layout Plain Layout
24830 <cell alignment="center" valignment="top" usebox="none">
24833 \begin_layout Plain Layout
24839 <cell alignment="center" valignment="top" usebox="none">
24842 \begin_layout Plain Layout
24848 <cell alignment="center" valignment="top" usebox="none">
24851 \begin_layout Plain Layout
24857 <cell alignment="center" valignment="top" usebox="none">
24860 \begin_layout Plain Layout
24868 <cell alignment="left" valignment="top" usebox="none">
24871 \begin_layout Plain Layout
24877 <cell alignment="left" valignment="top" usebox="none">
24880 \begin_layout Plain Layout
24886 <cell alignment="left" valignment="top" usebox="none">
24889 \begin_layout Plain Layout
24895 <cell alignment="left" valignment="top" usebox="none">
24898 \begin_layout Plain Layout
24904 <cell alignment="center" valignment="top" usebox="none">
24907 \begin_layout Plain Layout
24913 <cell alignment="center" valignment="top" usebox="none">
24916 \begin_layout Plain Layout
24922 <cell alignment="center" valignment="top" usebox="none">
24925 \begin_layout Plain Layout
24931 <cell alignment="center" valignment="top" usebox="none">
24934 \begin_layout Plain Layout
24942 <cell alignment="left" valignment="top" usebox="none">
24945 \begin_layout Plain Layout
24951 <cell alignment="left" valignment="top" usebox="none">
24954 \begin_layout Plain Layout
24960 <cell alignment="left" valignment="top" usebox="none">
24963 \begin_layout Plain Layout
24969 <cell alignment="left" valignment="top" usebox="none">
24972 \begin_layout Plain Layout
24978 <cell alignment="center" valignment="top" usebox="none">
24981 \begin_layout Plain Layout
24987 <cell alignment="center" valignment="top" usebox="none">
24990 \begin_layout Plain Layout
24996 <cell alignment="center" valignment="top" usebox="none">
24999 \begin_layout Plain Layout
25005 <cell alignment="center" valignment="top" usebox="none">
25008 \begin_layout Plain Layout
25016 <cell alignment="left" valignment="top" usebox="none">
25019 \begin_layout Plain Layout
25025 <cell alignment="left" valignment="top" usebox="none">
25028 \begin_layout Plain Layout
25034 <cell alignment="left" valignment="top" usebox="none">
25037 \begin_layout Plain Layout
25043 <cell alignment="left" valignment="top" usebox="none">
25046 \begin_layout Plain Layout
25052 <cell alignment="center" valignment="top" usebox="none">
25055 \begin_layout Plain Layout
25061 <cell alignment="center" valignment="top" usebox="none">
25064 \begin_layout Plain Layout
25070 <cell alignment="center" valignment="top" usebox="none">
25073 \begin_layout Plain Layout
25079 <cell alignment="center" valignment="top" usebox="none">
25082 \begin_layout Plain Layout
25090 <cell alignment="left" valignment="top" usebox="none">
25093 \begin_layout Plain Layout
25099 <cell alignment="left" valignment="top" usebox="none">
25102 \begin_layout Plain Layout
25108 <cell alignment="left" valignment="top" usebox="none">
25111 \begin_layout Plain Layout
25117 <cell alignment="left" valignment="top" usebox="none">
25120 \begin_layout Plain Layout
25126 <cell alignment="center" valignment="top" usebox="none">
25129 \begin_layout Plain Layout
25135 <cell alignment="center" valignment="top" usebox="none">
25138 \begin_layout Plain Layout
25144 <cell alignment="center" valignment="top" usebox="none">
25147 \begin_layout Plain Layout
25153 <cell alignment="center" valignment="top" usebox="none">
25156 \begin_layout Plain Layout
25164 <cell alignment="left" valignment="top" usebox="none">
25167 \begin_layout Plain Layout
25173 <cell alignment="left" valignment="top" usebox="none">
25176 \begin_layout Plain Layout
25182 <cell alignment="left" valignment="top" usebox="none">
25185 \begin_layout Plain Layout
25191 <cell alignment="left" valignment="top" usebox="none">
25194 \begin_layout Plain Layout
25200 <cell alignment="center" valignment="top" usebox="none">
25203 \begin_layout Plain Layout
25209 <cell alignment="center" valignment="top" usebox="none">
25212 \begin_layout Plain Layout
25218 <cell alignment="center" valignment="top" usebox="none">
25221 \begin_layout Plain Layout
25227 <cell alignment="center" valignment="top" usebox="none">
25230 \begin_layout Plain Layout
25238 <cell alignment="left" valignment="top" usebox="none">
25241 \begin_layout Plain Layout
25247 <cell alignment="left" valignment="top" usebox="none">
25250 \begin_layout Plain Layout
25256 <cell alignment="left" valignment="top" usebox="none">
25259 \begin_layout Plain Layout
25265 <cell alignment="left" valignment="top" usebox="none">
25268 \begin_layout Plain Layout
25274 <cell alignment="center" valignment="top" usebox="none">
25277 \begin_layout Plain Layout
25283 <cell alignment="center" valignment="top" usebox="none">
25286 \begin_layout Plain Layout
25292 <cell alignment="center" valignment="top" usebox="none">
25295 \begin_layout Plain Layout
25301 <cell alignment="center" valignment="top" usebox="none">
25304 \begin_layout Plain Layout
25312 <cell alignment="left" valignment="top" usebox="none">
25315 \begin_layout Plain Layout
25321 <cell alignment="left" valignment="top" usebox="none">
25324 \begin_layout Plain Layout
25330 <cell alignment="left" valignment="top" usebox="none">
25333 \begin_layout Plain Layout
25339 <cell alignment="left" valignment="top" usebox="none">
25342 \begin_layout Plain Layout
25348 <cell alignment="center" valignment="top" usebox="none">
25351 \begin_layout Plain Layout
25357 <cell alignment="center" valignment="top" usebox="none">
25360 \begin_layout Plain Layout
25366 <cell alignment="center" valignment="top" usebox="none">
25369 \begin_layout Plain Layout
25375 <cell alignment="center" valignment="top" usebox="none">
25378 \begin_layout Plain Layout
25386 <cell alignment="center" valignment="top" usebox="none">
25389 \begin_layout Plain Layout
25395 <cell alignment="center" valignment="top" usebox="none">
25398 \begin_layout Plain Layout
25404 <cell alignment="center" valignment="top" usebox="none">
25407 \begin_layout Plain Layout
25413 <cell alignment="center" valignment="top" usebox="none">
25416 \begin_layout Plain Layout
25422 <cell alignment="center" valignment="top" usebox="none">
25425 \begin_layout Plain Layout
25431 <cell alignment="center" valignment="top" usebox="none">
25434 \begin_layout Plain Layout
25440 <cell alignment="center" valignment="top" usebox="none">
25443 \begin_layout Plain Layout
25449 <cell alignment="center" valignment="top" usebox="none">
25452 \begin_layout Plain Layout
25466 \begin_layout Chapter
25467 Names of available colors to be used in layouts
25468 \begin_inset CommandInset label
25470 name "chap:Names-of-colors"
25477 \begin_layout Standard
25478 The colors listed here are the standard colors and the those that you can
25479 adjust in the \SpecialChar LyX
25483 \begin_layout Description
25496 No particular color – clear or default
25499 \begin_layout Description
25503 \begin_layout Description
25507 \begin_layout Description
25511 \begin_layout Description
25515 \begin_layout Description
25519 \begin_layout Description
25523 \begin_layout Description
25527 \begin_layout Description
25531 \begin_layout Description
25532 added_space Added space marker color
25535 \begin_layout Description
25536 addedtext Added text color
25539 \begin_layout Description
25540 appendix Appendix marker color
25543 \begin_layout Description
25544 background Background color
25547 \begin_layout Description
25548 bottomarea Bottom area color
25551 \begin_layout Description
25552 branchlabel Label color for branches
25555 \begin_layout Description
25556 buttonbg Color used for bottom background
25559 \begin_layout Description
25560 buttonhoverbg Color used for button background under focus
25563 \begin_layout Description
25564 buttonframe Color for inset button frames
25567 \begin_layout Description
25568 changebar Changebar color
25571 \begin_layout Description
25572 changedtextauthor1 Changed text color author 1
25575 \begin_layout Description
25576 changedtextauthor2 Changed text color author 2
25579 \begin_layout Description
25580 changedtextauthor3 Changed text color author 3
25583 \begin_layout Description
25584 changedtextauthor4 Changed text color author 4
25587 \begin_layout Description
25588 changedtextauthor5 Changed text color author 5
25591 \begin_layout Description
25592 collapsable_inset_frame Collapsable insets framecolor
25595 \begin_layout Description
25596 collapsable_inset_text Collapsable insets text color
25599 \begin_layout Description
25600 command Text color for command insets
25603 \begin_layout Description
25604 commandbg Background color for command insets
25607 \begin_layout Description
25608 commandframe Frame color for command insets
25611 \begin_layout Description
25612 comment color for comments
25615 \begin_layout Description
25616 commentbg Background color of comments
25619 \begin_layout Description
25620 cursor Cursor color
25623 \begin_layout Description
25624 deletedtext Deleted text color
25627 \begin_layout Description
25628 deletedtextmodifier Deleted text modifying color
25631 \begin_layout Description
25632 depthbar Color for the depth bars in the margin
25635 \begin_layout Description
25636 eolmarker End of line marker color
25639 \begin_layout Description
25640 error Color of the \SpecialChar LaTeX
25644 \begin_layout Description
25645 footlabel Label color for footnotes
25648 \begin_layout Description
25649 graphicsbg Graphics inset background color
25652 \begin_layout Description
25653 greyedout Label color for greyedout insets
25656 \begin_layout Description
25657 greyedoutbg Background color of greyedout inset
25660 \begin_layout Description
25661 greyedouttext Color for greyedout inset text
25664 \begin_layout Description
25665 indexlabel Label color for index insets
25668 \begin_layout Description
25669 ignore The color is ignored
25672 \begin_layout Description
25673 inherit The color is inherited
25676 \begin_layout Description
25677 inlinecompletion Inline completion color
25680 \begin_layout Description
25681 insetbg Inset marker background color
25684 \begin_layout Description
25685 insetframe Inset marker frame color
25688 \begin_layout Description
25689 language Color for marking foreign language words
25692 \begin_layout Description
25693 latex Text color in \SpecialChar LaTeX
25697 \begin_layout Description
25698 listingsbg Background color of listings inset
25701 \begin_layout Description
25702 marginlabel Label color for margin notes
25705 \begin_layout Description
25706 math Math inset text color
25709 \begin_layout Description
25710 mathbg Math inset background color
25713 \begin_layout Description
25714 mathcorners Math inset frame color not under focus
25717 \begin_layout Description
25718 mathframe Math inset frame color under focus
25721 \begin_layout Description
25722 mathline Math line color
25725 \begin_layout Description
25726 mathmacrobg Macro math inset background color
25729 \begin_layout Description
25730 mathmacroblend Macro math blended color
25733 \begin_layout Description
25734 mathmacroframe Macro math frame color
25737 \begin_layout Description
25738 mathmacrohoverbg Macro math inset background color hovered
25741 \begin_layout Description
25742 mathmacrolabel Macro math label color
25745 \begin_layout Description
25746 mathmacronewarg Macro template color for new parameters
25749 \begin_layout Description
25750 mathmacrooldarg Macro template color for old parameters
25753 \begin_layout Description
25754 newpage New page color
25757 \begin_layout Description
25758 nonunique_inlinecompletion Inline completion color for the non-unique part
25761 \begin_layout Description
25762 notebg Background color of notes
25765 \begin_layout Description
25766 notelabel Label color for notes
25769 \begin_layout Description
25770 pagebreak Page break/line break color
25773 \begin_layout Description
25774 paragraphmarker Color used for the pilcrow sign to mark the end of a paragraph
25777 \begin_layout Description
25778 phantomtext Text color for phantom insets
25781 \begin_layout Description
25782 preview The color used for previews
25785 \begin_layout Description
25786 previewframe Preview frame color
25789 \begin_layout Description
25790 regexpframe Color for regexp frame
25793 \begin_layout Description
25794 selection Background color of selected text
25797 \begin_layout Description
25798 selectiontext Foreground color of selected text
25801 \begin_layout Description
25802 shadedbg Background color of shaded box
25805 \begin_layout Description
25806 special Special chars text color
25809 \begin_layout Description
25810 tabularline Table line color
25813 \begin_layout Description
25814 tabularonoffline Table line color
25817 \begin_layout Description
25818 urllabel Label color for URL insets
25821 \begin_layout Description
25822 urltext Color for URL inset text