1 #LyX 2.2 created this file. For more info see http://www.lyx.org/
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 If you require a package with specific options, you can additionally use
9945 \begin_inset Flex Code
9948 \begin_layout Plain Layout
9957 \begin_layout Description
9958 \begin_inset Flex Code
9961 \begin_layout Plain Layout
9968 \begin_inset Flex Code
9971 \begin_layout Plain Layout
9977 ] A string that indicates the width of the right margin on the screen, for
9979 \begin_inset Quotes eld
9983 \begin_inset Flex Code
9986 \begin_layout Plain Layout
9993 \begin_inset Quotes erd
9999 \begin_layout Description
10000 \begin_inset Flex Code
10003 \begin_layout Plain Layout
10010 \begin_inset Flex Code
10013 \begin_layout Plain Layout
10019 ] Sets which divisions get numbered.
10021 \begin_inset Newline newline
10025 \begin_inset Flex Code
10028 \begin_layout Plain Layout
10034 counter in \SpecialChar LaTeX
10038 \begin_layout Description
10039 \begin_inset Flex Code
10042 \begin_layout Plain Layout
10049 \begin_inset Flex Code
10052 \begin_layout Plain Layout
10061 \begin_inset space \thinspace{}
10065 \begin_inset Flex Code
10068 \begin_layout Plain Layout
10074 ] Whether the class-default should be printing on one or both sides of the
10076 Can be changed in the
10077 \begin_inset Flex MenuItem
10080 \begin_layout Plain Layout
10081 Document\SpecialChar menuseparator
10090 \begin_layout Description
10091 \begin_inset Flex Code
10094 \begin_layout Plain Layout
10101 \begin_inset Flex Code
10104 \begin_layout Plain Layout
10110 ] This sequence defines a paragraph style.
10111 If the style does not yet exist, it is created; if it does exist, its parameter
10114 \begin_inset Quotes eld
10118 \begin_inset Flex Code
10121 \begin_layout Plain Layout
10128 \begin_inset Quotes erd
10132 \begin_inset Newline newline
10136 \begin_inset CommandInset ref
10138 reference "subsec:Paragraph-Styles"
10142 for details on paragraph styles.
10145 \begin_layout Description
10146 \begin_inset Flex Code
10149 \begin_layout Plain Layout
10156 \begin_inset Flex Code
10159 \begin_layout Plain Layout
10165 ] The name of the command or environment to be used with
10166 \begin_inset Flex Code
10169 \begin_layout Plain Layout
10178 \begin_layout Description
10179 \begin_inset Flex Code
10182 \begin_layout Plain Layout
10189 \begin_inset Flex Code
10192 \begin_layout Plain Layout
10201 \begin_inset Flex Code
10204 \begin_layout Plain Layout
10210 ] Indicates what kind of markup is used to define the title of a document.
10212 \begin_inset Flex Code
10215 \begin_layout Plain Layout
10221 means that the macro with name
10222 \begin_inset Flex Code
10225 \begin_layout Plain Layout
10231 will be inserted after the last layout which has
10232 \begin_inset Quotes eld
10236 \begin_inset Flex Code
10239 \begin_layout Plain Layout
10241 \begin_inset space ~
10250 \begin_inset Quotes erd
10255 \begin_inset Flex Code
10258 \begin_layout Plain Layout
10264 corresponds to the case where all layouts which have
10265 \begin_inset Quotes eld
10269 \begin_inset Flex Code
10272 \begin_layout Plain Layout
10274 \begin_inset space ~
10283 \begin_inset Quotes erd
10286 should be enclosed into the
10287 \begin_inset Flex Code
10290 \begin_layout Plain Layout
10299 \begin_layout Description
10300 \begin_inset Flex Code
10303 \begin_layout Plain Layout
10310 \begin_inset Flex Code
10313 \begin_layout Plain Layout
10319 ] Sets which divisions are included in the table of contents.
10321 \begin_inset Flex Code
10324 \begin_layout Plain Layout
10330 counter in \SpecialChar LaTeX
10334 \begin_layout Subsection
10335 \begin_inset Flex Code
10338 \begin_layout Plain Layout
10345 \begin_inset CommandInset label
10347 name "subsec:ClassOptions"
10354 \begin_layout Standard
10356 \begin_inset Flex Code
10359 \begin_layout Plain Layout
10365 section can contain the following entries:
10368 \begin_layout Description
10369 \begin_inset Flex Code
10372 \begin_layout Plain Layout
10379 \begin_inset Flex Code
10382 \begin_layout Plain Layout
10388 ] The list of available font sizes for the document's main font, separated
10390 \begin_inset Quotes eld
10394 \begin_inset Flex Code
10397 \begin_layout Plain Layout
10404 \begin_inset Quotes erd
10410 \begin_layout Description
10411 \begin_inset Flex Code
10414 \begin_layout Plain Layout
10420 Used to set the DTD line with XML-based output classes.
10422 \begin_inset space \thinspace{}
10426 \begin_inset Quotes eld
10429 -//OASIS//DTD DocBook V4.2//EN
10430 \begin_inset Quotes erd
10436 \begin_layout Description
10437 \begin_inset Flex Code
10440 \begin_layout Plain Layout
10447 \begin_inset Flex Code
10450 \begin_layout Plain Layout
10451 string="empty|plain|headings|fancy"
10456 ] The list of available page sty\SpecialChar softhyphen
10458 \begin_inset Quotes eld
10462 \begin_inset Flex Code
10465 \begin_layout Plain Layout
10472 \begin_inset Quotes erd
10478 \begin_layout Description
10479 \begin_inset Flex Code
10482 \begin_layout Plain Layout
10489 \begin_inset Flex Code
10492 \begin_layout Plain Layout
10498 ] Some document class options, separated by a comma, that will be added
10499 to the optional part of the
10500 \begin_inset Flex Code
10503 \begin_layout Plain Layout
10514 \begin_layout Standard
10516 \begin_inset Flex Code
10519 \begin_layout Plain Layout
10525 section must end with
10526 \begin_inset Quotes eld
10530 \begin_inset Flex Code
10533 \begin_layout Plain Layout
10540 \begin_inset Quotes erd
10546 \begin_layout Subsection
10548 \begin_inset CommandInset label
10550 name "subsec:Paragraph-Styles"
10557 \begin_layout Standard
10558 A paragraph style description looks like this:
10562 \begin_layout Plain Layout
10563 Note that this will either define a new style or modify an existing one.
10571 \begin_layout LyX-Code
10578 \begin_layout LyX-Code
10582 \begin_layout LyX-Code
10586 \begin_layout Standard
10587 where the following commands are allowed:
10590 \begin_layout Description
10591 \begin_inset Flex Code
10594 \begin_layout Plain Layout
10601 \begin_inset Flex Code
10604 \begin_layout Plain Layout
10609 , left, right, center
10614 ] Paragraph alignment.
10617 \begin_layout Description
10618 \begin_inset Flex Code
10621 \begin_layout Plain Layout
10628 \begin_inset Flex Code
10631 \begin_layout Plain Layout
10636 , left, right, center
10641 ] A comma separated list of permitted alignments.
10642 (Some \SpecialChar LaTeX
10643 styles prohibit certain alignments, since those wouldn't make sense.
10644 For example a right-aligned or centered enumeration isn't possible.)
10647 \begin_layout Description
10648 \begin_inset Flex Code
10651 \begin_layout Plain Layout
10658 \begin_inset Flex Code
10661 \begin_layout Plain Layout
10667 ] Defines argument number <int> of a command\SpecialChar breakableslash
10668 environment associated with
10670 This is useful for things like section headings, and only makes sense with
10673 Every (optional or required) argument of a command or environment – except
10674 for the required argument that is associated with the content of the paragraph
10675 itself – has a separate definition, where the number specifies the order
10677 The definition must end with
10678 \begin_inset Flex Code
10681 \begin_layout Plain Layout
10688 So a command with two optional arguments has:
10689 \begin_inset Separator parbreak
10696 \begin_layout Quote
10702 \begin_layout Quote
10708 \begin_layout Quote
10714 \begin_layout Quote
10720 \begin_layout Quote
10726 \begin_layout Quote
10732 \begin_layout Standard
10734 \begin_inset Flex Code
10737 \begin_layout Plain Layout
10743 definition, the following specifications are possible:
10746 \begin_layout Itemize
10747 \begin_inset Flex Code
10750 \begin_layout Plain Layout
10757 \begin_inset Flex Code
10760 \begin_layout Plain Layout
10766 The string that will appear both in the menu (to insert this argument)
10767 and on the argument inset button (unless you also specify a separate
10768 \begin_inset Flex Code
10771 \begin_layout Plain Layout
10778 For the menu, you can define an accelerator by appending the respective
10779 character to the string, divided by
10780 \begin_inset Quotes eld
10784 \begin_inset Quotes erd
10788 \begin_inset space \thinspace{}
10792 \begin_inset space \space{}
10796 \begin_inset Quotes eld
10800 \begin_inset Flex Code
10803 \begin_layout Plain Layout
10810 \begin_inset Quotes erd
10816 \begin_layout Itemize
10817 \begin_inset Flex Code
10820 \begin_layout Plain Layout
10827 \begin_inset Flex Code
10830 \begin_layout Plain Layout
10836 A separate string for the menu.
10837 You can define an accelerator by appending the respective character to
10838 the string, divided by
10839 \begin_inset Quotes eld
10843 \begin_inset Quotes erd
10847 \begin_inset space \thinspace{}
10851 \begin_inset space \space{}
10855 \begin_inset Quotes eld
10859 \begin_inset Flex Code
10862 \begin_layout Plain Layout
10869 \begin_inset Quotes erd
10873 This specification is optional.
10874 If it is not given the
10875 \begin_inset Flex Code
10878 \begin_layout Plain Layout
10884 will be used instead for the menu.
10887 \begin_layout Itemize
10888 \begin_inset Flex Code
10891 \begin_layout Plain Layout
10898 \begin_inset Flex Code
10901 \begin_layout Plain Layout
10907 A longer explanatory text that appears in the tooltip when hovering over
10908 the argument inset.
10911 \begin_layout Itemize
10912 \begin_inset Flex Code
10915 \begin_layout Plain Layout
10922 \begin_inset Flex Code
10925 \begin_layout Plain Layout
10934 \begin_inset space \thinspace{}
10938 \begin_inset Flex Code
10941 \begin_layout Plain Layout
10947 ] Declare if this is a mandatory (1) or an optional (0) argument.
10948 Mandatory arguments will be output empty if not given, while optional arguments
10949 will not be output at all.
10950 By default, mandatory arguments are delimited by
10951 \begin_inset Flex Code
10954 \begin_layout Plain Layout
10960 , while optional arguments are delimited by
10961 \begin_inset Flex Code
10964 \begin_layout Plain Layout
10973 \begin_layout Itemize
10974 \begin_inset Flex Code
10977 \begin_layout Plain Layout
10984 \begin_inset Flex Code
10987 \begin_layout Plain Layout
10993 defines another argument (by its number) which this argument requires to
10994 be output if it is itself output.
10996 \begin_inset space \thinspace{}
10999 g., in \SpecialChar LaTeX
11000 commands, optional arguments often require previous optional arguments
11001 to be output (at least empty), as in
11002 \begin_inset Flex Code
11005 \begin_layout Plain Layout
11008 command[][argument]{text}
11014 This can be achieved by the statement
11015 \begin_inset Flex Code
11018 \begin_layout Plain Layout
11025 \begin_inset Flex Code
11028 \begin_layout Plain Layout
11037 \begin_layout Itemize
11038 \begin_inset Flex Code
11041 \begin_layout Plain Layout
11048 \begin_inset Flex Code
11051 \begin_layout Plain Layout
11057 defines a custom left delimiter (instead of
11058 \begin_inset Flex Code
11061 \begin_layout Plain Layout
11068 \begin_inset Flex Code
11071 \begin_layout Plain Layout
11078 A line break in the output can be indicated by
11079 \begin_inset Flex Code
11082 \begin_layout Plain Layout
11091 \begin_layout Itemize
11092 \begin_inset Flex Code
11095 \begin_layout Plain Layout
11102 \begin_inset Flex Code
11105 \begin_layout Plain Layout
11111 defines a custom right delimiter (instead of
11112 \begin_inset Flex Code
11115 \begin_layout Plain Layout
11122 \begin_inset Flex Code
11125 \begin_layout Plain Layout
11132 A line break in the output can be indicated by
11133 \begin_inset Flex Code
11136 \begin_layout Plain Layout
11145 \begin_layout Itemize
11146 \begin_inset Flex Code
11149 \begin_layout Plain Layout
11156 \begin_inset Flex Code
11159 \begin_layout Plain Layout
11165 defines an argument that is inserted if and only if no user-specified arguments
11167 \begin_inset space \thinspace{}
11171 \begin_inset space \space{}
11174 if no argument inset has been inserted (note that also an empty argument
11175 inset omits the DefaultArg).
11176 Multiple arguments need to be separated by comma.
11179 \begin_layout Itemize
11180 \begin_inset Flex Code
11183 \begin_layout Plain Layout
11190 \begin_inset Flex Code
11193 \begin_layout Plain Layout
11199 defines an argument that is inserted in any case (alone or in addition
11200 to user-specified arguments).
11201 Multiple arguments need to be separated by comma.
11204 \begin_layout Itemize
11205 \begin_inset Flex Code
11208 \begin_layout Plain Layout
11214 The font used for the argument content, see
11215 \begin_inset CommandInset ref
11217 reference "subsec:Font-description"
11224 \begin_layout Itemize
11225 \begin_inset Flex Code
11228 \begin_layout Plain Layout
11234 The font used for the label; see
11235 \begin_inset CommandInset ref
11237 reference "subsec:Font-description"
11244 \begin_layout Itemize
11245 \begin_inset Flex Code
11248 \begin_layout Plain Layout
11255 \begin_inset Flex Code
11258 \begin_layout Plain Layout
11263 , Minimalistic, Conglomerate
11268 ] describes the rendering style used for the inset's frame and buttons.
11271 \begin_layout Itemize
11272 \begin_inset Flex Code
11275 \begin_layout Plain Layout
11282 \begin_inset Flex Code
11285 \begin_layout Plain Layout
11292 \begin_inset Flex Code
11295 \begin_layout Plain Layout
11301 , this argument is automatically inserted when the respective style is selected.
11302 Currently, only one argument per style\SpecialChar breakableslash
11303 layout can be automatically inserted.
11306 \begin_layout Itemize
11307 \begin_inset Flex Code
11310 \begin_layout Plain Layout
11317 \begin_inset Flex Code
11320 \begin_layout Plain Layout
11327 \begin_inset Flex Code
11330 \begin_layout Plain Layout
11336 , this argument will be inserted with a copy of the co-text (either selected
11337 text or the whole paragraph) as content.
11340 \begin_layout Itemize
11341 \begin_inset Flex Code
11344 \begin_layout Plain Layout
11351 \begin_inset Flex Code
11354 \begin_layout Plain Layout
11355 string of characters
11364 Defines individual characters that should be output in raw form, meaning
11365 without special translations that \SpecialChar LaTeX
11367 Note that, contrary to PassThru, this needs to be explicitly defined for
11369 That is, arguments do not inherit PassThruChars from their parent inset
11373 \begin_layout Standard
11374 By default, the text entered in the \SpecialChar LyX
11375 workarea in the respective layout is
11376 the last (mandatory) argument of a command if the
11377 \begin_inset Flex Code
11380 \begin_layout Plain Layout
11387 \begin_inset Flex Code
11390 \begin_layout Plain Layout
11397 However, arguments with the prefix
11398 \begin_inset Flex Code
11401 \begin_layout Plain Layout
11407 are output after this workarea argument.
11408 Note that post-argument numbering restarts at 1, so the first argument
11409 following the workarea argument is
11410 \begin_inset Flex Code
11413 \begin_layout Plain Layout
11420 Post-arguments are ignored in any other
11421 \begin_inset Flex Code
11424 \begin_layout Plain Layout
11431 \begin_inset Flex Code
11434 \begin_layout Plain Layout
11443 \begin_layout Standard
11445 \begin_inset Flex Code
11448 \begin_layout Plain Layout
11457 \begin_inset Flex Code
11460 \begin_layout Plain Layout
11469 \begin_inset Flex Code
11472 \begin_layout Plain Layout
11478 followed by the number (e.
11479 \begin_inset space \thinspace{}
11483 \begin_inset space \space{}
11487 \begin_inset Flex Code
11490 \begin_layout Plain Layout
11500 \begin_layout Description
11501 \begin_inset Flex Code
11504 \begin_layout Plain Layout
11510 Note that this will completely override any prior
11511 \begin_inset Flex Code
11514 \begin_layout Plain Layout
11520 declaration for this style.
11522 \begin_inset Quotes eld
11526 \begin_inset Flex Code
11529 \begin_layout Plain Layout
11536 \begin_inset Quotes erd
11541 \begin_inset CommandInset ref
11543 reference "subsec:I18n"
11547 for details on its use.
11550 \begin_layout Description
11551 \begin_inset Flex Code
11554 \begin_layout Plain Layout
11561 \begin_inset Flex Code
11564 \begin_layout Plain Layout
11574 \begin_layout Plain Layout
11575 Note that a `float' here is a real number, such as: 1.5.
11580 The vertical space with which the last of a chain of paragraphs with this
11581 style is separated from the following paragraph.
11582 If the next paragraph has another style, the separations are not simply
11583 added, but the maximum is taken.
11586 \begin_layout Description
11587 \begin_inset Flex Code
11590 \begin_layout Plain Layout
11597 \begin_inset Flex Code
11600 \begin_layout Plain Layout
11606 ] The category for this style.
11607 This is used to group related styles in the style combobox on the toolbar.
11608 Any string can be used, but you may want to use existing categories with
11613 \begin_layout Description
11614 \begin_inset Flex Code
11617 \begin_layout Plain Layout
11623 Depth of XML command.
11624 Used only with XML-type formats.
11627 \begin_layout Description
11628 \begin_inset Flex Code
11631 \begin_layout Plain Layout
11638 \begin_inset Flex Code
11641 \begin_layout Plain Layout
11647 ] Copies all the features of an existing style into the current one.
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 ] The name of a style whose preamble should be output
11676 This allows to ensure some ordering of the preamble snippets when macros
11677 definitions depend on one another.
11681 \begin_layout Plain Layout
11682 Note that, besides that functionality, there is no way to ensure any ordering
11684 The ordering that you see in a given version of \SpecialChar LyX
11685 may change without warning
11694 \begin_layout Description
11695 \begin_inset Flex Code
11698 \begin_layout Plain Layout
11705 \begin_inset Flex Code
11708 \begin_layout Plain Layout
11713 , Box, Filled_Box, Static
11718 ] The type of label that stands at the end of the paragraph (or sequence
11720 \begin_inset Flex Code
11723 \begin_layout Plain Layout
11730 \begin_inset Newline newline
11734 \begin_inset Flex Code
11737 \begin_layout Plain Layout
11744 \begin_inset Flex Code
11747 \begin_layout Plain Layout
11754 \begin_inset Flex Code
11757 \begin_layout Plain Layout
11765 \begin_inset Flex Code
11768 \begin_layout Plain Layout
11775 \begin_inset Quotes eld
11779 \begin_inset Quotes erd
11783 \begin_inset Flex Code
11786 \begin_layout Plain Layout
11793 \begin_inset space \space{}
11797 \begin_inset Flex Code
11800 \begin_layout Plain Layout
11806 ) is a white (resp.
11807 \begin_inset space ~
11810 black) square suitable for end of proof markers,
11811 \begin_inset Flex Code
11814 \begin_layout Plain Layout
11820 is an explicit text string.
11823 \begin_layout Description
11824 \begin_inset Flex Code
11827 \begin_layout Plain Layout
11834 \begin_inset Flex Code
11837 \begin_layout Plain Layout
11843 ] The string used for a label with a
11844 \begin_inset Flex Code
11847 \begin_layout Plain Layout
11854 \begin_inset Newline newline
11858 \begin_inset Flex Code
11861 \begin_layout Plain Layout
11871 \begin_layout Description
11872 \begin_inset Flex Code
11875 \begin_layout Plain Layout
11881 The font used for both the text body
11887 \begin_inset CommandInset ref
11889 reference "subsec:Font-description"
11894 Note that defining this font automatically defines the
11895 \begin_inset Flex Code
11898 \begin_layout Plain Layout
11905 So you should define this one first if you also want to define
11906 \begin_inset Flex Code
11909 \begin_layout Plain Layout
11918 \begin_layout Description
11919 \begin_inset Flex Code
11922 \begin_layout Plain Layout
11929 \begin_inset Flex Code
11932 \begin_layout Plain Layout
11938 ] Used for backporting new styles to stable \SpecialChar LyX
11940 The first stable version that supports this tag is \SpecialChar LyX
11942 The argument is a number which may either be 0, -1 or any value greater
11945 \begin_inset Flex Code
11948 \begin_layout Plain Layout
11954 flag of a style is greater than zero, it will always be written to the
11956 If a .lyx file is read, the style definitions from the document header are
11957 added to the document class.
11958 Therefore even older \SpecialChar LyX
11959 versions can handle the style.
11961 \begin_inset Flex Code
11964 \begin_layout Plain Layout
11970 is a version number: If the style is read, and the version number is less
11971 than the version number of the already existing style in the document class,
11972 the new style is ignored.
11973 If the version number is greater, the new style replaces the existing style.
11974 A value of -1 means an infinite version number, i.
11975 \begin_inset space \thinspace{}
11979 \begin_inset space \space{}
11982 the style is always used.
11985 \begin_layout Description
11986 \begin_inset Flex Code
11989 \begin_layout Plain Layout
11996 \begin_inset Flex Code
11999 \begin_layout Plain Layout
12008 \begin_inset space \thinspace{}
12012 \begin_inset Flex Code
12015 \begin_layout Plain Layout
12021 ] Usually \SpecialChar LyX
12022 does not allow you to insert more than one space between words,
12023 since a space is considered as the separation between two words, not a
12024 character or symbol of its own.
12025 This is a very fine thing but sometimes annoying, for example, when typing
12026 program code or plain \SpecialChar LaTeX
12029 \begin_inset Flex Code
12032 \begin_layout Plain Layout
12039 Note that \SpecialChar LyX
12040 will create protected blanks for the additional blanks when
12041 in another mode than \SpecialChar LaTeX
12045 \begin_layout Description
12046 \begin_inset Flex Code
12049 \begin_layout Plain Layout
12055 These tags are used with XHTML output.
12057 \begin_inset CommandInset ref
12059 reference "subsec:Paragraph-Style-XHTML"
12066 \begin_layout Description
12067 \begin_inset Flex Code
12070 \begin_layout Plain Layout
12076 [FIXME] (Used only with XML-type formats.)
12079 \begin_layout Description
12080 \begin_inset Flex Code
12083 \begin_layout Plain Layout
12090 \begin_inset Flex Code
12093 \begin_layout Plain Layout
12102 \begin_inset space \thinspace{}
12106 \begin_inset Flex Code
12109 \begin_layout Plain Layout
12116 \begin_inset Flex Code
12119 \begin_layout Plain Layout
12125 , marks the style as to be included in the document preamble and not in
12127 This is useful for document classes that want such information as the title
12128 and author to appear in the preamble.
12129 Note that this works only for styles for which the
12130 \begin_inset Flex Code
12133 \begin_layout Plain Layout
12140 \begin_inset Flex Code
12143 \begin_layout Plain Layout
12150 \begin_inset Flex Code
12153 \begin_layout Plain Layout
12162 \begin_layout Description
12163 \begin_inset Flex Code
12166 \begin_layout Plain Layout
12173 \begin_inset Flex Code
12176 \begin_layout Plain Layout
12185 \begin_inset space \thinspace{}
12189 \begin_inset Flex Code
12192 \begin_layout Plain Layout
12199 \begin_inset Flex Code
12202 \begin_layout Plain Layout
12208 , marks the style as being part of a title block (see also the
12209 \begin_inset Flex Code
12212 \begin_layout Plain Layout
12219 \begin_inset Flex Code
12222 \begin_layout Plain Layout
12231 \begin_layout Description
12232 \begin_inset Flex Code
12235 \begin_layout Plain Layout
12242 \begin_inset Flex Code
12245 \begin_layout Plain Layout
12251 ] The \SpecialChar LaTeX
12252 command sequence declaring an item in a list.
12253 The command is to be defined without the preceding backslash (the default
12255 \begin_inset Quotes eld
12259 \begin_inset Quotes erd
12263 \begin_inset Flex Code
12266 \begin_layout Plain Layout
12274 in the \SpecialChar LaTeX
12278 \begin_layout Description
12279 \begin_inset Flex Code
12282 \begin_layout Plain Layout
12289 \begin_inset Flex Code
12292 \begin_layout Plain Layout
12298 ] This provides extra space between paragraphs that have the same style.
12299 If you put other styles into an environment, each is separated with the
12301 \begin_inset Flex Code
12304 \begin_layout Plain Layout
12311 But the whole items of the environment are additionally separated with
12313 \begin_inset Flex Code
12316 \begin_layout Plain Layout
12323 Note that this is a
12328 \begin_layout Description
12329 \begin_inset Flex Code
12332 \begin_layout Plain Layout
12338 [FIXME] (Used only with XML-type formats.)
12341 \begin_layout Description
12342 \begin_inset Flex Code
12345 \begin_layout Plain Layout
12352 \begin_inset Flex Code
12355 \begin_layout Plain Layout
12364 \begin_inset space \thinspace{}
12368 \begin_inset Flex Code
12371 \begin_layout Plain Layout
12377 ] Usually \SpecialChar LyX
12378 does not allow you to leave a paragraph empty, since it would
12379 lead to empty \SpecialChar LaTeX
12381 There are some cases where this could be desirable however: in a letter
12382 template, the required fields can be provided as empty fields, so that
12383 people do not forget them; in some special classes, a style can be used
12384 as some kind of break, which does not contain actual text.
12387 \begin_layout Description
12388 \begin_inset Flex Code
12391 \begin_layout Plain Layout
12398 \begin_inset Flex Code
12401 \begin_layout Plain Layout
12407 ] The vertical space between the label and the text body.
12408 Only used for labels that are above the text body (
12409 \begin_inset Flex Code
12412 \begin_layout Plain Layout
12419 \begin_inset Newline newline
12423 \begin_inset Flex Code
12426 \begin_layout Plain Layout
12427 Centered_Top_Environment
12435 \begin_layout Description
12436 \begin_inset Flex Code
12439 \begin_layout Plain Layout
12446 \begin_inset Flex Code
12449 \begin_layout Plain Layout
12455 ] The name of the counter for automatic numbering.
12456 In order to have the counter appear with your label, you will need to reference
12458 \begin_inset Flex Code
12461 \begin_layout Plain Layout
12470 This will work with
12471 \begin_inset Flex Code
12474 \begin_layout Plain Layout
12481 \begin_inset Flex Code
12484 \begin_layout Plain Layout
12491 \begin_inset Flex Code
12494 \begin_layout Plain Layout
12501 \begin_inset Flex Code
12504 \begin_layout Plain Layout
12511 \begin_inset Newline newline
12519 \begin_inset Flex Code
12522 \begin_layout Plain Layout
12529 \begin_inset Flex Code
12532 \begin_layout Plain Layout
12538 , though this case is a bit complicated.
12539 Suppose you declare
12540 \begin_inset Quotes eld
12544 \begin_inset Flex Code
12547 \begin_layout Plain Layout
12548 LabelCounter myenum
12554 \begin_inset Quotes erd
12558 Then the actual counters used are
12559 \begin_inset Flex Code
12562 \begin_layout Plain Layout
12569 \begin_inset Flex Code
12572 \begin_layout Plain Layout
12579 \begin_inset Flex Code
12582 \begin_layout Plain Layout
12589 \begin_inset Flex Code
12592 \begin_layout Plain Layout
12598 , much as in \SpecialChar LaTeX
12600 These counters must all be declared separately.
12601 \begin_inset Newline newline
12605 \begin_inset CommandInset ref
12607 reference "subsec:Counters"
12611 for details on counters.
12614 \begin_layout Description
12615 \begin_inset Flex Code
12618 \begin_layout Plain Layout
12624 The font used for the label.
12626 \begin_inset CommandInset ref
12628 reference "subsec:Font-description"
12635 \begin_layout Description
12636 \begin_inset Flex Code
12639 \begin_layout Plain Layout
12646 \begin_inset Flex Code
12649 \begin_layout Plain Layout
12655 ] Text that indicates how far a label should be indented.
12658 \begin_layout Description
12659 \begin_inset Flex Code
12662 \begin_layout Plain Layout
12669 \begin_inset Flex Code
12672 \begin_layout Plain Layout
12678 ] Text that indicates the amount of horizontal space between the label and
12680 Only used for labels that are not above the text body.
12683 \begin_layout Description
12684 \begin_inset Flex Code
12687 \begin_layout Plain Layout
12694 \begin_inset Flex Code
12697 \begin_layout Plain Layout
12703 ] The string used for the label.
12705 \begin_inset Flex Code
12708 \begin_layout Plain Layout
12714 is set, this string can be contain the special formatting commands described
12716 \begin_inset CommandInset ref
12718 reference "subsec:Counters"
12725 \begin_layout Description
12726 \begin_inset Flex Code
12729 \begin_layout Plain Layout
12730 LabelStringAppendix
12736 \begin_inset Flex Code
12739 \begin_layout Plain Layout
12745 ] This is used inside the appendix instead of
12746 \begin_inset Newline newline
12750 \begin_inset Flex Code
12753 \begin_layout Plain Layout
12761 \begin_inset Flex Code
12764 \begin_layout Plain Layout
12771 \begin_inset Newline newline
12775 \begin_inset Flex Code
12778 \begin_layout Plain Layout
12779 LabelStringAppendix
12787 \begin_layout Description
12788 \begin_inset Flex Code
12791 \begin_layout Plain Layout
12797 [FIXME] (Used only with XML-type formats.)
12800 \begin_layout Description
12801 \begin_inset Flex Code
12804 \begin_layout Plain Layout
12811 \begin_inset Flex Code
12814 \begin_layout Plain Layout
12819 , Manual, Static, Above,
12820 \begin_inset Newline newline
12823 Centered, Sensitive, Enumerate,
12824 \begin_inset Newline newline
12827 Itemize, Bibliography
12833 \begin_inset Separator parbreak
12840 \begin_layout Description
12841 \begin_inset Flex Code
12844 \begin_layout Plain Layout
12850 means the label is the very first word (up to the first real blank).
12851 Use protected spaces if you want more than one word as the label.
12855 \begin_layout Description
12856 \begin_inset Flex Code
12859 \begin_layout Plain Layout
12865 means the label is simply what is declared as
12866 \begin_inset Flex Code
12869 \begin_layout Plain Layout
12876 This will be displayed
12877 \begin_inset Quotes eld
12881 \begin_inset Quotes erd
12884 , at the beginning of the paragraph.
12886 \begin_inset Flex Code
12889 \begin_layout Plain Layout
12896 \begin_inset Flex Code
12899 \begin_layout Plain Layout
12905 , then it will be displayed only in the first paragraph of any sequence
12906 of paragraphs with the same
12907 \begin_inset Flex Code
12910 \begin_layout Plain Layout
12919 \begin_layout Description
12920 \begin_inset Flex Code
12923 \begin_layout Plain Layout
12930 \begin_inset space ~
12934 \begin_inset space ~
12938 \begin_inset Flex Code
12941 \begin_layout Plain Layout
12947 are special cases of
12948 \begin_inset Flex Code
12951 \begin_layout Plain Layout
12958 The label will be printed above the paragraph either at the beginning of
12959 the line or centered.
12962 \begin_layout Description
12963 \begin_inset Flex Code
12966 \begin_layout Plain Layout
12972 is a special case for the caption-labels
12973 \begin_inset Quotes eld
12977 \begin_inset Quotes erd
12981 \begin_inset Quotes eld
12985 \begin_inset Quotes erd
12989 \begin_inset Newline newline
12993 \begin_inset Flex Code
12996 \begin_layout Plain Layout
13002 means the (hardcoded) label string depends on the kind of float: It is
13003 hardcoded to be `FloatType N', where N is the value of the counter associated
13005 For the case that a caption is inserted outside of a float the
13006 \begin_inset Flex Code
13009 \begin_layout Plain Layout
13016 \begin_inset Quotes eld
13020 \begin_inset Quotes erd
13026 \begin_layout Description
13027 \begin_inset Flex Code
13030 \begin_layout Plain Layout
13036 produces the usual sort of enumeration labels.
13037 At present, it is hardcoded to use Arabic numerals, lowercase letters,
13038 small Roman numerals, and uppercase letters for the four possible depths.
13041 \begin_layout Description
13042 \begin_inset Flex Code
13045 \begin_layout Plain Layout
13051 produces various bullets at the different levels.
13052 It is also hardcoded.
13055 \begin_layout Description
13056 \begin_inset Flex Code
13059 \begin_layout Plain Layout
13065 should be used only with
13066 \begin_inset Flex Code
13069 \begin_layout Plain Layout
13070 LatexType BibEnvironment
13079 \begin_layout Description
13080 \begin_inset Flex Code
13083 \begin_layout Plain Layout
13089 Note that this will completely override any prior
13090 \begin_inset Flex Code
13093 \begin_layout Plain Layout
13099 declaration for this style.
13101 \begin_inset Quotes eld
13105 \begin_inset Flex Code
13108 \begin_layout Plain Layout
13115 \begin_inset Quotes erd
13120 \begin_inset CommandInset ref
13122 reference "subsec:I18n"
13126 for details on its use.
13129 \begin_layout Description
13130 \begin_inset Flex Code
13133 \begin_layout Plain Layout
13140 \begin_inset Flex Code
13143 \begin_layout Plain Layout
13149 ] The name of the corresponding \SpecialChar LaTeX
13151 Either the environment or command name.
13154 \begin_layout Description
13155 \begin_inset Flex Code
13158 \begin_layout Plain Layout
13165 \begin_inset Flex Code
13168 \begin_layout Plain Layout
13174 ] An optional parameter for the corresponding
13175 \begin_inset Flex Code
13178 \begin_layout Plain Layout
13185 This parameter cannot be changed from within \SpecialChar LyX
13187 \begin_inset Flex Code
13190 \begin_layout Plain Layout
13196 for customizable parameters).
13197 This will be output as is after all \SpecialChar LaTeX
13199 \begin_inset Flex Code
13202 \begin_layout Plain Layout
13211 \begin_layout Description
13212 \begin_inset Flex Code
13215 \begin_layout Plain Layout
13222 \begin_inset Flex Code
13225 \begin_layout Plain Layout
13230 , Command, Environment, Item_Environment,
13231 \begin_inset Newline newline
13234 List_Environment, Bib_Environment
13239 ] How the style should be translated into \SpecialChar LaTeX
13244 \begin_layout Plain Layout
13245 \begin_inset Flex Code
13248 \begin_layout Plain Layout
13254 is perhaps a bit misleading, since these rules apply to SGML classes, too.
13255 Visit the SGML class files for specific examples.
13261 \begin_inset Separator parbreak
13268 \begin_layout Description
13269 \begin_inset Flex Code
13272 \begin_layout Plain Layout
13278 means nothing special.
13281 \begin_layout Description
13282 \begin_inset Flex Code
13285 \begin_layout Plain Layout
13292 \begin_inset Flex Code
13295 \begin_layout Plain Layout
13302 {\SpecialChar ldots
13311 \begin_layout Description
13312 \begin_inset Flex Code
13315 \begin_layout Plain Layout
13322 \begin_inset Flex Code
13325 \begin_layout Plain Layout
13332 }\SpecialChar ldots
13348 \begin_layout Description
13349 \begin_inset Flex Code
13352 \begin_layout Plain Layout
13359 \begin_inset Flex Code
13362 \begin_layout Plain Layout
13369 \begin_inset Flex Code
13372 \begin_layout Plain Layout
13380 is generated for each paragraph of this environment.
13384 \begin_layout Description
13385 \begin_inset Flex Code
13388 \begin_layout Plain Layout
13395 \begin_inset Flex Code
13398 \begin_layout Plain Layout
13405 \begin_inset Newline newline
13409 \begin_inset Flex Code
13412 \begin_layout Plain Layout
13418 is passed as an argument to the environment.
13419 \begin_inset Newline newline
13423 \begin_inset Flex Code
13426 \begin_layout Plain Layout
13432 can be defined in the
13433 \begin_inset Flex MenuItem
13436 \begin_layout Plain Layout
13437 Edit\SpecialChar menuseparator
13439 \begin_inset space ~
13450 \begin_layout Description
13451 \begin_inset Flex Code
13454 \begin_layout Plain Layout
13461 \begin_inset Flex Code
13464 \begin_layout Plain Layout
13470 but adds additionally the necessary mandatory argument (the longest label)
13471 to the begin statement of the bibliography environment:
13472 \begin_inset Newline newline
13476 \begin_inset Flex Code
13479 \begin_layout Plain Layout
13482 begin{thebibliography}{99}
13487 It is therefore only useful for bibliography environments.
13488 The default longest label
13489 \begin_inset Quotes eld
13493 \begin_inset Quotes erd
13496 can be changed by the user in the paragraph settings of a bibliography
13500 \begin_layout Standard
13501 Putting the last few things together, the \SpecialChar LaTeX
13502 output will be either:
13505 \begin_layout LyX-Code
13508 LatexName[LatexParam]{\SpecialChar ldots
13512 \begin_layout Standard
13516 \begin_layout LyX-Code
13519 begin{LatexName}[LatexParam] \SpecialChar ldots
13525 \begin_layout Standard
13526 depending upon the \SpecialChar LaTeX
13531 \begin_layout Description
13532 \begin_inset Flex Code
13535 \begin_layout Plain Layout
13542 \begin_inset Flex Code
13545 \begin_layout Plain Layout
13551 ] A string that is put at the beginning of the style content.
13552 A line break in the output can be indicated by
13553 \begin_inset Flex Code
13556 \begin_layout Plain Layout
13565 \begin_layout Description
13566 \begin_inset Flex Code
13569 \begin_layout Plain Layout
13576 \begin_inset Flex Code
13579 \begin_layout Plain Layout
13585 ] If you put styles into environments, the different
13586 \begin_inset Flex Code
13589 \begin_layout Plain Layout
13595 are not simply added, but added with a factor
13596 \begin_inset Formula $\frac{4}{\mathrm{depth}+4}$
13600 Note that this parameter is also used when
13601 \begin_inset Flex Code
13604 \begin_layout Plain Layout
13611 \begin_inset Flex Code
13614 \begin_layout Plain Layout
13621 \begin_inset Flex Code
13624 \begin_layout Plain Layout
13631 Then it is added to the manual or dynamic margin.
13632 \begin_inset Newline newline
13636 \begin_inset Quotes eld
13640 \begin_inset Flex Code
13643 \begin_layout Plain Layout
13650 \begin_inset Quotes erd
13653 means that the paragraph is indented with the width of
13654 \begin_inset Quotes eld
13658 \begin_inset Flex Code
13661 \begin_layout Plain Layout
13668 \begin_inset Quotes erd
13671 in the normal font.
13672 You can get a negative width by prefixing the string with
13673 \begin_inset Quotes eld
13677 \begin_inset Flex Code
13680 \begin_layout Plain Layout
13687 \begin_inset Quotes erd
13691 This way was chosen so that the look is the same with each used screen
13695 \begin_layout Description
13696 \begin_inset Flex Code
13699 \begin_layout Plain Layout
13706 \begin_inset Flex Code
13709 \begin_layout Plain Layout
13714 , Manual, Dynamic, First_Dynamic, Right_Address_Box
13720 \begin_inset Newline newline
13723 The kind of margin that the style has on the left side.
13724 \begin_inset Separator parbreak
13731 \begin_layout Description
13732 \begin_inset Flex Code
13735 \begin_layout Plain Layout
13741 just means a fixed margin.
13744 \begin_layout Description
13745 \begin_inset Flex Code
13748 \begin_layout Plain Layout
13754 means that the left margin depends on the string entered in the
13755 \begin_inset Flex MenuItem
13758 \begin_layout Plain Layout
13759 Edit\SpecialChar menuseparator
13761 \begin_inset space ~
13770 This is used to typeset nice lists without tabulators.
13773 \begin_layout Description
13774 \begin_inset Flex Code
13777 \begin_layout Plain Layout
13783 means that the margin depends on the size of the label.
13784 This is used for automatic enumerated headlines.
13785 It is obvious that the headline
13786 \begin_inset Quotes eld
13789 5.4.3.2.1 Very long headline
13790 \begin_inset Quotes erd
13793 must have a wider left margin (as wide as
13794 \begin_inset Quotes eld
13798 \begin_inset Quotes erd
13801 plus the space) than
13802 \begin_inset Quotes eld
13805 3.2 Very long headline
13806 \begin_inset Quotes erd
13810 \begin_inset Quotes eld
13814 \begin_inset Quotes erd
13817 are not able to do this.
13820 \begin_layout Description
13821 \begin_inset Flex Code
13824 \begin_layout Plain Layout
13830 is similar, but only the very first row of the paragraph is dynamic, while
13831 the others are static; this is used, for example, for descriptions.
13834 \begin_layout Description
13835 \begin_inset Flex Code
13838 \begin_layout Plain Layout
13844 means the margin is chosen in a way that the longest row of this paragraph
13845 fits to the right margin.
13846 This is used to typeset an address on the right edge of the page.
13850 \begin_layout Description
13851 \begin_inset Flex Code
13854 \begin_layout Plain Layout
13861 \begin_inset Flex Code
13864 \begin_layout Plain Layout
13873 \begin_inset space \thinspace{}
13877 \begin_inset Flex Code
13880 \begin_layout Plain Layout
13886 ] Whether fragile commands in this style should be
13887 \begin_inset Flex Code
13890 \begin_layout Plain Layout
13903 whether this command should itself be protected.)
13906 \begin_layout Description
13907 \begin_inset Flex Code
13910 \begin_layout Plain Layout
13917 \begin_inset Flex Code
13920 \begin_layout Plain Layout
13927 \begin_inset space \thinspace{}
13931 \begin_inset Flex Code
13934 \begin_layout Plain Layout
13942 ] Whether newlines are translated into \SpecialChar LaTeX
13944 \begin_inset Flex Code
13947 \begin_layout Plain Layout
13958 The translation can be switched off to allow more comfortable \SpecialChar LaTeX
13960 inside \SpecialChar LyX
13964 \begin_layout Description
13965 \begin_inset Flex Code
13968 \begin_layout Plain Layout
13975 \begin_inset Flex Code
13978 \begin_layout Plain Layout
13987 \begin_inset space \thinspace{}
13991 \begin_inset Flex Code
13994 \begin_layout Plain Layout
14000 ] If set to true, and if
14001 \begin_inset Flex Code
14004 \begin_layout Plain Layout
14011 \begin_inset Flex Code
14014 \begin_layout Plain Layout
14020 ) paragraphs are being indented, then the indentation of such a paragraph
14021 following one of this type will be suppressed.
14022 (So this will not affect the display of non-default paragraphs.)
14025 \begin_layout Description
14026 \begin_inset Flex Code
14029 \begin_layout Plain Layout
14036 \begin_inset Flex Code
14039 \begin_layout Plain Layout
14045 ] Name of a style that has replaced this style.
14046 This is used to rename a style, while keeping backward compatibility.
14049 \begin_layout Description
14050 \begin_inset Flex Code
14053 \begin_layout Plain Layout
14060 \begin_inset Flex Code
14063 \begin_layout Plain Layout
14070 \begin_inset space \thinspace{}
14074 \begin_inset Flex Code
14077 \begin_layout Plain Layout
14083 ] Determines whether consecutive pragraphs of the same type are treated
14084 as belonging together.
14085 This has the effect that the
14086 \begin_inset Flex Code
14089 \begin_layout Plain Layout
14095 is only printed once before such a group.
14096 By default, this is true for
14097 \begin_inset Flex Code
14100 \begin_layout Plain Layout
14107 \begin_inset Flex Code
14110 \begin_layout Plain Layout
14117 \begin_inset Flex Code
14120 \begin_layout Plain Layout
14126 and false for all other types.
14129 \begin_layout Description
14130 \begin_inset Flex Code
14133 \begin_layout Plain Layout
14140 \begin_inset Flex Code
14143 \begin_layout Plain Layout
14152 \begin_inset space \thinspace{}
14156 \begin_inset Flex Code
14159 \begin_layout Plain Layout
14165 ] Indicates that paragraphs will not be separated by an empty line in \SpecialChar LaTeX
14167 but only by a line break; together with
14168 \begin_inset Flex Code
14171 \begin_layout Plain Layout
14177 , this allows to emulate a plain text editor (like the ERT inset).
14180 \begin_layout Description
14181 \begin_inset Flex Code
14184 \begin_layout Plain Layout
14191 \begin_inset Flex Code
14194 \begin_layout Plain Layout
14200 ] The indent of the very first line of a paragraph.
14202 \begin_inset Newline newline
14206 \begin_inset Flex Code
14209 \begin_layout Plain Layout
14215 will be fixed for a certain style.
14216 The exception is the default style, since the indentation for these paragraphs
14217 can be prohibited with
14218 \begin_inset Flex Code
14221 \begin_layout Plain Layout
14229 \begin_inset Flex Code
14232 \begin_layout Plain Layout
14238 style paragraphs inside environments use the
14239 \begin_inset Flex Code
14242 \begin_layout Plain Layout
14248 of the environment, not their native one.
14250 \begin_inset Flex Code
14253 \begin_layout Plain Layout
14259 paragraphs inside an enumeration are not indented.
14262 \begin_layout Description
14263 \begin_inset Flex Code
14266 \begin_layout Plain Layout
14273 \begin_inset Flex Code
14276 \begin_layout Plain Layout
14282 ] The vertical space between two paragraphs of this style.
14285 \begin_layout Description
14286 \begin_inset Flex Code
14289 \begin_layout Plain Layout
14296 \begin_inset Flex Code
14299 \begin_layout Plain Layout
14306 allows the user to choose either
14307 \begin_inset Quotes eld
14311 \begin_inset Quotes erd
14315 \begin_inset Quotes eld
14319 \begin_inset Quotes erd
14322 to separate paragraphs.
14324 \begin_inset Quotes eld
14328 \begin_inset Quotes erd
14332 \begin_inset Flex Code
14335 \begin_layout Plain Layout
14343 \begin_inset Quotes eld
14347 \begin_inset Quotes erd
14351 \begin_inset Flex Code
14354 \begin_layout Plain Layout
14360 is ignored and all paragraphs are separated by the
14361 \begin_inset Flex Code
14364 \begin_layout Plain Layout
14371 The vertical space is calculated with
14372 \begin_inset Flex Code
14375 \begin_layout Plain Layout
14377 \begin_inset space ~
14386 \begin_inset Flex Code
14389 \begin_layout Plain Layout
14395 is the height of a row with the normal font.
14396 This way, the look stays the same with different screen fonts.
14399 \begin_layout Description
14400 \begin_inset Flex Code
14403 \begin_layout Plain Layout
14410 \begin_inset Flex Code
14413 \begin_layout Plain Layout
14422 \begin_inset space \thinspace{}
14426 \begin_inset Flex Code
14429 \begin_layout Plain Layout
14435 ] Whether the contents of this paragraph should be output in raw form, meaning
14436 without special translations that \SpecialChar LaTeX
14440 \begin_layout Description
14441 \begin_inset Flex Code
14444 \begin_layout Plain Layout
14451 \begin_inset Flex Code
14454 \begin_layout Plain Layout
14464 Defines individual characters that should be output in raw form, meaning
14465 without special translations that \SpecialChar LaTeX
14469 \begin_layout Description
14470 \begin_inset Flex Code
14473 \begin_layout Plain Layout
14479 Information to be included in the \SpecialChar LaTeX
14480 preamble when this style is used.
14481 Used to define macros, load packages, etc., required by this particular
14484 \begin_inset Quotes eld
14488 \begin_inset Flex Code
14491 \begin_layout Plain Layout
14498 \begin_inset Quotes erd
14504 \begin_layout Description
14505 \begin_inset Flex Code
14508 \begin_layout Plain Layout
14515 \begin_inset Flex Code
14518 \begin_layout Plain Layout
14524 ] The prefix to use when creating labels referring to paragraphs of this
14526 This allows the use of formatted references.
14529 \begin_layout Description
14530 \begin_inset Flex Code
14533 \begin_layout Plain Layout
14540 \begin_inset Flex Code
14543 \begin_layout Plain Layout
14549 ] Whether the style requires the feature
14550 \begin_inset Flex Code
14553 \begin_layout Plain Layout
14560 \begin_inset CommandInset ref
14562 reference "chap:List-of-functions"
14566 for the list of features).
14567 If you require a package with specific options, you can additionally use
14569 \begin_inset Flex Code
14572 \begin_layout Plain Layout
14578 as a general text class parameter (see
14579 \begin_inset CommandInset ref
14581 reference "subsec:General-text-class"
14588 \begin_layout Description
14589 \begin_inset Flex Code
14592 \begin_layout Plain Layout
14599 \begin_inset Flex Code
14602 \begin_layout Plain Layout
14611 \begin_inset Flex Code
14614 \begin_layout Plain Layout
14620 ] Resets the \SpecialChar LaTeX
14621 arguments of this style (as defined via the
14622 \begin_inset Flex Code
14625 \begin_layout Plain Layout
14632 This is useful if you have copied a style via
14633 \begin_inset Flex Code
14636 \begin_layout Plain Layout
14642 , but you do not want to inherit its (required and optional) arguments.
14645 \begin_layout Description
14646 \begin_inset Flex Code
14649 \begin_layout Plain Layout
14656 \begin_inset Flex Code
14659 \begin_layout Plain Layout
14665 ] A string that is put at the end of the layout content.
14666 A line break in the output can be indicated by
14667 \begin_inset Flex Code
14670 \begin_layout Plain Layout
14679 \begin_layout Description
14680 \begin_inset Flex Code
14683 \begin_layout Plain Layout
14690 \begin_inset Flex Code
14693 \begin_layout Plain Layout
14700 \begin_inset Flex Code
14703 \begin_layout Plain Layout
14712 \begin_layout Description
14713 \begin_inset Flex Code
14716 \begin_layout Plain Layout
14723 \begin_inset Flex Code
14726 \begin_layout Plain Layout
14735 \begin_inset Flex Code
14738 \begin_layout Plain Layout
14745 \begin_inset Flex Code
14748 \begin_layout Plain Layout
14755 \begin_inset Flex Code
14758 \begin_layout Plain Layout
14760 \begin_inset space ~
14768 ] This defines what the default spacing should be in the style.
14770 \begin_inset Flex Code
14773 \begin_layout Plain Layout
14780 \begin_inset Flex Code
14783 \begin_layout Plain Layout
14790 \begin_inset Flex Code
14793 \begin_layout Plain Layout
14799 correspond respectively to a multiplier value of 1, 1.25 and 1.667.
14800 If you specify the argument
14801 \begin_inset Flex Code
14804 \begin_layout Plain Layout
14810 , then you must also provide a value argument which will be the actual multiplie
14812 Note that, contrary to other parameters,
14813 \begin_inset Flex Code
14816 \begin_layout Plain Layout
14822 implies the generation of specific \SpecialChar LaTeX
14823 code, using the \SpecialChar LaTeX
14827 \begin_inset Flex Code
14830 \begin_layout Plain Layout
14839 \begin_layout Description
14840 \begin_inset Flex Code
14843 \begin_layout Plain Layout
14850 \begin_inset Flex Code
14853 \begin_layout Plain Layout
14860 \begin_inset space \thinspace{}
14864 \begin_inset Flex Code
14867 \begin_layout Plain Layout
14875 ] Allow spell-checking paragraphs of this style.
14879 \begin_layout Description
14880 \begin_inset Flex Code
14883 \begin_layout Plain Layout
14889 The font used for the text body .
14891 \begin_inset CommandInset ref
14893 reference "subsec:Font-description"
14900 \begin_layout Description
14901 \begin_inset Flex Code
14904 \begin_layout Plain Layout
14913 \begin_inset Flex Code
14916 \begin_layout Plain Layout
14926 The level of the style in the table of contents.
14927 This is used for automatic numbering of section headings.
14930 \begin_layout Description
14931 \begin_inset Flex Code
14934 \begin_layout Plain Layout
14943 \begin_inset Flex Code
14946 \begin_layout Plain Layout
14957 \begin_inset Flex Code
14960 \begin_layout Plain Layout
14967 \begin_inset Flex Code
14970 \begin_layout Plain Layout
14976 ] This tag determines whether the first line indentation of this paragraph
14977 can be toggled via the Paragraph settings dialog.
14981 \begin_inset Flex Code
14984 \begin_layout Plain Layout
14994 is set, indentation can be toggled if the document settings use
14995 \begin_inset Quotes eld
14999 \begin_inset Quotes erd
15002 paragraph style, with
15003 \begin_inset Flex Code
15006 \begin_layout Plain Layout
15012 , indentation can always be toggled, notwithstanding the document settings,
15014 \begin_inset Flex Code
15017 \begin_layout Plain Layout
15023 , indentation can never be toggled.
15026 \begin_layout Description
15027 \begin_inset Flex Code
15030 \begin_layout Plain Layout
15037 \begin_inset Flex Code
15040 \begin_layout Plain Layout
15046 ] The vertical space with which the very first of a chain of paragraphs
15047 with this style is separated from the previous paragraph.
15048 If the previous paragraph has another style, the separations are not simply
15049 added, but the maximum is taken.
15052 \begin_layout Subsection
15053 \begin_inset CommandInset label
15059 Internationalization of Paragraph Styles
15062 \begin_layout Standard
15064 has long supported internationalization of layout information, but, until
15065 version 2.0, this applied only to the user interface and not to, say, PDF
15067 Thus, French authors were forced to resort to ugly hacks if they wanted
15072 1' instead of `Theorem 1'.
15073 Thanks to Georg Baum, that is no longer the case.
15076 \begin_layout Standard
15078 \begin_inset Flex Code
15081 \begin_layout Plain Layout
15087 defines text that is to appear in the typeset document, it may use
15088 \begin_inset Flex Code
15091 \begin_layout Plain Layout
15098 \begin_inset Flex Code
15101 \begin_layout Plain Layout
15107 to support non-English and even multi-language documents correctly.
15108 The following excerpt (from the
15109 \begin_inset Flex Code
15112 \begin_layout Plain Layout
15118 file) shows how this works:
15121 \begin_layout LyX-Code
15123 \begin_inset Separator parbreak
15130 \begin_layout LyX-Code
15133 theoremstyle{remark}
15136 \begin_layout LyX-Code
15139 newtheorem{claim}[thm]{
15146 \begin_layout LyX-Code
15150 \begin_layout LyX-Code
15154 \begin_layout LyX-Code
15159 claimname}{_(Claim)}
15162 \begin_layout LyX-Code
15166 \begin_layout LyX-Code
15170 \begin_layout LyX-Code
15179 claimname}{_(Claim)}}
15182 \begin_layout LyX-Code
15187 \begin_layout Standard
15188 In principle, any legal \SpecialChar LaTeX
15190 \begin_inset Flex Code
15193 \begin_layout Plain Layout
15200 \begin_inset Flex Code
15203 \begin_layout Plain Layout
15209 tags, but in practice they will typically look as they do here.
15210 The key to correct translation of the typeset text is the definition of
15211 the \SpecialChar LaTeX
15213 \begin_inset Flex Code
15216 \begin_layout Plain Layout
15225 \begin_inset Flex Code
15228 \begin_layout Plain Layout
15240 \begin_layout Standard
15242 \begin_inset Flex Code
15245 \begin_layout Plain Layout
15251 tag provides for internationalization based upon the overall language of
15253 The contents of the tag will be included in the preamble, just as with
15255 \begin_inset Flex Code
15258 \begin_layout Plain Layout
15265 What makes it special is the use of the
15266 \begin_inset Quotes eld
15270 \begin_inset Quotes erd
15274 \begin_inset Flex Code
15277 \begin_layout Plain Layout
15283 , which will be replaced, when \SpecialChar LyX
15284 produces \SpecialChar LaTeX
15285 output, with the translation of
15286 its argument into the document language.
15289 \begin_layout Standard
15291 \begin_inset Flex Code
15294 \begin_layout Plain Layout
15300 tag is more complex, since it is meant to provide support for multi-language
15301 documents and so offers an interface to the
15302 \begin_inset Flex Code
15305 \begin_layout Plain Layout
15312 Its contents will be added to the preamble once for each language that
15313 appears in the document.
15314 In this case, the argument to
15315 \begin_inset Flex Code
15318 \begin_layout Plain Layout
15324 will be replaced with its translation into the language in question; the
15326 \begin_inset Flex Code
15329 \begin_layout Plain Layout
15335 is replaced by the language name (as used by the babel package).
15338 \begin_layout Standard
15339 A German document that also included a French section would thus have the
15340 following in the preamble:
15343 \begin_layout LyX-Code
15352 claimname}{Affirmation}}
15353 \begin_inset Newline newline
15364 claimname}{Behauptung}}
15365 \begin_inset Newline newline
15372 claimname}{Behauptung}
15375 \begin_layout Standard
15378 \begin_inset Flex Code
15381 \begin_layout Plain Layout
15387 will then conspire to produce the correct text in the output.
15390 \begin_layout Standard
15391 One important point to note here is that the translations are provided by
15393 itself, through the file
15394 \begin_inset Flex Code
15397 \begin_layout Plain Layout
15404 This means, in effect, that
15405 \begin_inset Flex Code
15408 \begin_layout Plain Layout
15415 \begin_inset Flex Code
15418 \begin_layout Plain Layout
15424 are really only of use in layout files that are provided with \SpecialChar LyX
15426 entered in user-created layout files will not be seen by \SpecialChar LyX
15427 's internationalizatio
15428 n routines unless the
15429 \begin_inset Flex Code
15432 \begin_layout Plain Layout
15438 file is modified accordingly.
15439 That said, however, any layout created with the intention that it will
15440 be included with \SpecialChar LyX
15441 should use these tags where appropriate.
15442 Please note that the paragraph style translations provided by \SpecialChar LyX
15444 change with a minor update (e.
15445 \begin_inset space \thinspace{}
15449 \begin_inset space \space{}
15452 from version 2.1.x to 2.1.y).
15453 It is however quite likely that a major update (e.
15454 \begin_inset space \thinspace{}
15458 \begin_inset space \space{}
15461 from 2.0.x to 2.1.y) will introduce new translations or corrections.
15464 \begin_layout Subsection
15466 \begin_inset CommandInset label
15468 name "subsec:Floats"
15475 \begin_layout Standard
15476 It is necessary to define the floats (
15477 \begin_inset Flex MenuItem
15480 \begin_layout Plain Layout
15487 \begin_inset Flex MenuItem
15490 \begin_layout Plain Layout
15496 , \SpecialChar ldots
15497 ) in the text class itself.
15498 Standard floats are included in the file
15499 \begin_inset Flex Code
15502 \begin_layout Plain Layout
15508 , so you may have to do no more than add
15511 \begin_layout LyX-Code
15512 Input stdfloats.inc
15515 \begin_layout Standard
15516 to your layout file.
15517 If you want to implement a text class that proposes some other float types
15518 (like the AGU class bundled with \SpecialChar LyX
15519 ), the information below will hopefully
15521 \change_inserted -712698321 1432283506
15525 \begin_layout Description
15527 \change_inserted -712698321 1432313622
15528 \begin_inset Flex Code
15531 \begin_layout Plain Layout
15533 \change_inserted -712698321 1432283514
15540 \begin_inset Flex Code
15543 \begin_layout Plain Layout
15545 \change_inserted -712698321 1432283507
15551 =!htbpH] Allowed placement options for this float type.
15552 The value is a string of placement characters.
15553 Possible characters include:
15558 \begin_inset Quotes eld
15562 \begin_inset Quotes erd
15570 \begin_inset Quotes eld
15574 \begin_inset Quotes erd
15582 \begin_inset Quotes eld
15586 \begin_inset Quotes erd
15594 \begin_inset Quotes eld
15598 \begin_inset Quotes erd
15606 \begin_inset Quotes eld
15610 \begin_inset Quotes erd
15618 \begin_inset Quotes eld
15622 \begin_inset Quotes erd
15626 The order of the characters in the string does not matter.
15627 If no placement options are allowed, use the string
15634 \begin_layout Description
15636 \change_inserted -712698321 1432313755
15637 \begin_inset Flex Code
15640 \begin_layout Plain Layout
15642 \change_inserted -712698321 1432313630
15649 \begin_inset Flex Code
15652 \begin_layout Plain Layout
15654 \change_inserted -712698321 1432313646
15663 \begin_inset space \thinspace{}
15669 \begin_inset Flex Code
15672 \begin_layout Plain Layout
15674 \change_inserted -712698321 1432313646
15684 ] Defines whether the float allows to be rotated via the rotfloat package
15687 \begin_inset Flex Code
15690 \begin_layout Plain Layout
15692 \change_inserted -712698321 1432313721
15698 if the float does not support this feature.
15701 \begin_layout Description
15703 \change_inserted -712698321 1432313802
15704 \begin_inset Flex Code
15707 \begin_layout Plain Layout
15709 \change_inserted -712698321 1432313759
15716 \begin_inset Flex Code
15719 \begin_layout Plain Layout
15721 \change_inserted -712698321 1432313755
15730 \begin_inset space \thinspace{}
15736 \begin_inset Flex Code
15739 \begin_layout Plain Layout
15741 \change_inserted -712698321 1432313755
15751 ] Defines whether the float has a starred variant that spans columns in
15752 a two column paragraph.
15754 \begin_inset Flex Code
15757 \begin_layout Plain Layout
15759 \change_inserted -712698321 1432313755
15765 if the float does not support this feature.
15770 \begin_layout Description
15771 \begin_inset Flex Code
15774 \begin_layout Plain Layout
15781 \begin_inset Flex Code
15784 \begin_layout Plain Layout
15791 \begin_inset Quotes erd
15795 \begin_inset Quotes erd
15798 ] The file name extension of an auxiliary file for the list of figures (or
15801 writes the captions to this file.
15804 \begin_layout Description
15805 \begin_inset Flex Code
15808 \begin_layout Plain Layout
15815 \begin_inset Flex Code
15818 \begin_layout Plain Layout
15825 \begin_inset Quotes erd
15829 \begin_inset Quotes erd
15832 ] The string that will be used in the menus and also for the caption.
15833 This is translated to the current language if babel is used.
15836 \begin_layout Description
15837 \begin_inset Flex Code
15840 \begin_layout Plain Layout
15846 These tags control the XHTML output.
15848 \begin_inset CommandInset ref
15850 reference "sec:Tags-for-XHTML"
15857 \begin_layout Description
15858 \begin_inset Flex Code
15861 \begin_layout Plain Layout
15870 \begin_inset Flex Code
15873 \begin_layout Plain Layout
15882 \begin_inset space \thinspace{}
15886 \begin_inset Flex Code
15889 \begin_layout Plain Layout
15895 ] Indicates whether the float is already defined in the document class or
15896 if instead the \SpecialChar LaTeX
15898 \begin_inset Flex Code
15901 \begin_layout Plain Layout
15907 needs to be loaded to define it on-the-fly.
15909 \begin_inset Flex Code
15912 \begin_layout Plain Layout
15919 \begin_inset Flex Code
15922 \begin_layout Plain Layout
15929 It should be set to
15930 \begin_inset Flex Code
15933 \begin_layout Plain Layout
15939 if the float is already defined by the \SpecialChar LaTeX
15943 \begin_layout Description
15944 \begin_inset Flex Code
15947 \begin_layout Plain Layout
15954 \begin_inset Flex Code
15957 \begin_layout Plain Layout
15964 \begin_inset Quotes erd
15968 \begin_inset Quotes erd
15971 ] The command used to generate a list of floats of this type; the leading
15980 \begin_inset Flex Code
15983 \begin_layout Plain Layout
15989 is false, since there is no standard way to generate this command.
15991 \begin_inset Flex Code
15994 \begin_layout Plain Layout
16000 is true, since in that case there is a standard way to define the command.
16003 \begin_layout Description
16004 \begin_inset Flex Code
16007 \begin_layout Plain Layout
16014 \begin_inset Flex Code
16017 \begin_layout Plain Layout
16024 \begin_inset Quotes erd
16028 \begin_inset Quotes erd
16031 ] A title for a list of floats of this kind (list of figures, tables, or
16033 It is used for the screen label within \SpecialChar LyX
16034 , it is used by \SpecialChar LaTeX
16036 it is used as the title in the XHTML output.
16037 It will be translated to the document language.
16040 \begin_layout Description
16041 \begin_inset Flex Code
16044 \begin_layout Plain Layout
16051 \begin_inset Flex Code
16054 \begin_layout Plain Layout
16061 \begin_inset Quotes erd
16065 \begin_inset Quotes erd
16068 ] This (optional) argument determines whether floats of this class will
16069 be numbered within some sectional unit of the document.
16071 \begin_inset Flex Code
16074 \begin_layout Plain Layout
16081 \begin_inset Quotes eld
16085 \begin_inset Flex Code
16088 \begin_layout Plain Layout
16095 \begin_inset Quotes erd
16098 , the floats will be numbered within chapters.
16102 \begin_layout Description
16103 \begin_inset Flex Code
16106 \begin_layout Plain Layout
16113 \begin_inset Flex Code
16116 \begin_layout Plain Layout
16123 \begin_inset Quotes erd
16127 \begin_inset Quotes erd
16130 ] The default placement for the given class of floats.
16131 The string should be as in standard \SpecialChar LaTeX
16133 \begin_inset Flex Code
16136 \begin_layout Plain Layout
16143 \begin_inset Flex Code
16146 \begin_layout Plain Layout
16153 \begin_inset Flex Code
16156 \begin_layout Plain Layout
16163 \begin_inset Flex Code
16166 \begin_layout Plain Layout
16172 for top, bottom, page, and here, respectively.
16176 \begin_layout Plain Layout
16177 Note that the order of these letters in the string is irrelevant, like in
16184 On top of that there is a new type,
16185 \begin_inset Flex Code
16188 \begin_layout Plain Layout
16194 , which does not really correspond to a float, since it means: put it
16195 \begin_inset Quotes eld
16199 \begin_inset Quotes erd
16203 Note however that the
16204 \begin_inset Flex Code
16207 \begin_layout Plain Layout
16213 specifier is special and, because of implementation details, cannot be
16214 used in non-built in float types.
16215 If you do not understand what this means, just use
16216 \begin_inset Quotes eld
16220 \begin_inset Flex Code
16223 \begin_layout Plain Layout
16230 \begin_inset Quotes erd
16236 \begin_layout Description
16237 \begin_inset Flex Code
16240 \begin_layout Plain Layout
16247 \begin_inset Flex Code
16250 \begin_layout Plain Layout
16256 ] The prefix to use when creating labels referring to floats of this type.
16257 This allows the use of formatted references.
16258 Note that you can remove any
16259 \begin_inset Flex Code
16262 \begin_layout Plain Layout
16268 set by a copied style by using the special value
16269 \begin_inset Quotes eld
16273 \begin_inset Quotes erd
16276 , which must be all caps.
16279 \begin_layout Description
16280 \begin_inset Flex Code
16283 \begin_layout Plain Layout
16290 \begin_inset Flex Code
16293 \begin_layout Plain Layout
16300 \begin_inset Quotes erd
16304 \begin_inset Quotes erd
16307 ] The style used when defining the float using
16308 \begin_inset Flex Code
16311 \begin_layout Plain Layout
16322 \begin_layout Description
16323 \begin_inset Flex Code
16326 \begin_layout Plain Layout
16333 \begin_inset Flex Code
16336 \begin_layout Plain Layout
16343 \begin_inset Quotes erd
16347 \begin_inset Quotes erd
16351 \begin_inset Quotes eld
16355 \begin_inset Quotes erd
16358 of the new class of floats, like program or algorithm.
16359 After the appropriate
16360 \begin_inset Flex Code
16363 \begin_layout Plain Layout
16372 \begin_inset Flex Code
16375 \begin_layout Plain Layout
16384 \begin_inset Flex Code
16387 \begin_layout Plain Layout
16398 \begin_layout Description
16399 \begin_inset Flex Code
16402 \begin_layout Plain Layout
16409 \begin_inset Flex Code
16412 \begin_layout Plain Layout
16419 \begin_inset space \thinspace{}
16423 \begin_inset Flex Code
16426 \begin_layout Plain Layout
16434 ] Specifies whether this float is defined using the \SpecialChar LaTeX
16436 \begin_inset Flex Code
16439 \begin_layout Plain Layout
16445 , either by the class file, another package or on-the-fly by \SpecialChar LyX
16449 \begin_layout Standard
16450 Note that defining a float with type
16451 \begin_inset Flex Code
16454 \begin_layout Plain Layout
16462 automatically defines the corresponding counter with name
16463 \begin_inset Flex Code
16466 \begin_layout Plain Layout
16477 \begin_layout Subsection
16478 Flex insets and InsetLayout
16479 \begin_inset CommandInset label
16481 name "subsec:Flex-insets-and"
16488 \begin_layout Standard
16489 Flex insets come in three different kinds:
16492 \begin_layout Itemize
16494 \begin_inset Flex Code
16497 \begin_layout Plain Layout
16503 ): These define semantic markup corresponding to such \SpecialChar LaTeX
16505 \begin_inset Flex Code
16508 \begin_layout Plain Layout
16517 \begin_inset Flex Code
16520 \begin_layout Plain Layout
16531 \begin_layout Itemize
16533 \begin_inset Flex Code
16536 \begin_layout Plain Layout
16542 ): These can be used to define custom collapsible insets, similar to \SpecialChar TeX
16544 footnote, and the like.
16545 An obvious example is an endnote inset, which is defined in the
16546 \begin_inset Flex Code
16549 \begin_layout Plain Layout
16558 \begin_layout Itemize
16560 \begin_inset Flex Code
16563 \begin_layout Plain Layout
16569 ): For use with DocBook classes.
16572 \begin_layout Standard
16573 Flex insets are defined using the
16574 \begin_inset Flex Code
16577 \begin_layout Plain Layout
16583 tag, which shall be explained in a moment.
16586 \begin_layout Standard
16588 \begin_inset Flex Code
16591 \begin_layout Plain Layout
16597 tag also serves another function: It can be used to customize the general
16598 layout of many different types of insets.
16600 \begin_inset Flex Code
16603 \begin_layout Plain Layout
16609 can be used to customize the layout parameters for footnotes, marginal
16610 notes, note insets, \SpecialChar TeX
16611 code (ERT) insets, branches, listings, indexes, boxes,
16612 tables, algorithms, URLs, and captions, as well as to define Flex insets.
16615 \begin_layout Standard
16617 \begin_inset Flex Code
16620 \begin_layout Plain Layout
16626 definition must begin with a line of the form:
16629 \begin_layout LyX-Code
16633 \begin_layout Standard
16635 \begin_inset Flex Code
16638 \begin_layout Plain Layout
16644 indicates the inset whose layout is being defined, and here there are four
16648 \begin_layout Enumerate
16649 The layout for a pre-existing inset is being modified.
16650 In this case, can be
16651 \begin_inset Flex Code
16654 \begin_layout Plain Layout
16660 any one of the following:
16661 \begin_inset Flex Code
16664 \begin_layout Plain Layout
16671 \begin_inset Flex Code
16674 \begin_layout Plain Layout
16681 \begin_inset Flex Code
16684 \begin_layout Plain Layout
16691 \begin_inset Flex Code
16694 \begin_layout Plain Layout
16701 \begin_inset Flex Code
16704 \begin_layout Plain Layout
16711 \begin_inset Flex Code
16714 \begin_layout Plain Layout
16721 \begin_inset Flex Code
16724 \begin_layout Plain Layout
16731 \begin_inset Flex Code
16734 \begin_layout Plain Layout
16741 \begin_inset Flex Code
16744 \begin_layout Plain Layout
16751 \begin_inset Flex Code
16754 \begin_layout Plain Layout
16761 \begin_inset Flex Code
16764 \begin_layout Plain Layout
16771 \begin_inset Flex Code
16774 \begin_layout Plain Layout
16781 \begin_inset Flex Code
16784 \begin_layout Plain Layout
16791 \begin_inset Flex Code
16794 \begin_layout Plain Layout
16801 \begin_inset Flex Code
16804 \begin_layout Plain Layout
16811 \begin_inset Flex Code
16814 \begin_layout Plain Layout
16821 \begin_inset Flex Code
16824 \begin_layout Plain Layout
16831 \begin_inset Flex Code
16834 \begin_layout Plain Layout
16841 \begin_inset Flex Code
16844 \begin_layout Plain Layout
16851 \begin_inset Flex Code
16854 \begin_layout Plain Layout
16863 \begin_layout Enumerate
16864 The layout for a Flex inset is being defined.
16866 \begin_inset Flex Code
16869 \begin_layout Plain Layout
16875 must be of the form
16876 \begin_inset Quotes eld
16880 \begin_inset Flex Code
16883 \begin_layout Plain Layout
16890 \begin_inset Quotes erd
16894 \begin_inset Flex Code
16897 \begin_layout Plain Layout
16903 may be be any valid identifier not used by a pre-existing Flex inset.
16904 The identifier may include spaces, but in that case the whole thing must
16905 be wrapped in quotes.
16906 Note that the definition of a flex inset
16911 \begin_inset Flex Code
16914 \begin_layout Plain Layout
16920 entry, declaring which type of inset it defines.
16923 \begin_layout Enumerate
16924 The layout for user specific branch is being defined.
16926 \begin_inset Flex Code
16929 \begin_layout Plain Layout
16935 must be of the form
16936 \begin_inset Quotes eld
16940 \begin_inset Flex Code
16943 \begin_layout Plain Layout
16950 \begin_inset Quotes erd
16954 \begin_inset Flex Code
16957 \begin_layout Plain Layout
16963 may be be any valid identifier of branch defined in user's document.
16964 The identifier may include spaces, but in that case the whole thing must
16965 be wrapped in quotes.
16966 The main purpose of this feature is to allow \SpecialChar LaTeX
16967 wrapping around specific
16968 branches as user needs.
16971 \begin_layout Enumerate
16972 The layout of a user (or class) specific caption is being defined.
16974 \begin_inset Flex Code
16977 \begin_layout Plain Layout
16983 must be of the form
16984 \begin_inset Quotes eld
16988 \begin_inset Flex Code
16991 \begin_layout Plain Layout
16998 \begin_inset Quotes erd
17002 \begin_inset Flex Code
17005 \begin_layout Plain Layout
17011 specifies the name of the caption as it appears in the menu.
17012 Have a look at the standard caption (
17013 \begin_inset Flex Code
17016 \begin_layout Plain Layout
17022 ), the specific captions of the KOMA-Script classes (
17023 \begin_inset Flex Code
17026 \begin_layout Plain Layout
17033 \begin_inset Flex Code
17036 \begin_layout Plain Layout
17045 \begin_inset space ~
17051 \begin_inset Flex Code
17054 \begin_layout Plain Layout
17060 ) for applications.
17063 \begin_layout Standard
17065 \begin_inset Flex Code
17068 \begin_layout Plain Layout
17074 definition can contain the following entries:
17077 \begin_layout Description
17078 \begin_inset Flex Code
17081 \begin_layout Plain Layout
17088 \begin_inset Flex Code
17091 \begin_layout Plain Layout
17097 ] Defines argument number of a command\SpecialChar breakableslash
17098 environment associated with the current
17100 The definition must end with
17101 \begin_inset Flex Code
17104 \begin_layout Plain Layout
17112 \begin_inset CommandInset ref
17114 reference "subsec:Paragraph-Styles"
17121 \begin_layout Description
17122 \begin_inset Flex Code
17125 \begin_layout Plain Layout
17131 Preamble for changing language commands; see
17132 \begin_inset CommandInset ref
17134 reference "subsec:I18n"
17141 \begin_layout Description
17142 \begin_inset Flex Code
17145 \begin_layout Plain Layout
17152 \begin_inset Flex Code
17155 \begin_layout Plain Layout
17161 ] The color for the inset's background.
17163 \begin_inset CommandInset ref
17165 reference "chap:Names-of-colors"
17169 for a list of the available color names.
17172 \begin_layout Description
17173 \begin_inset Flex Code
17176 \begin_layout Plain Layout
17183 \begin_inset Flex Code
17186 \begin_layout Plain Layout
17195 \begin_inset space \thinspace{}
17199 \begin_inset Flex Code
17202 \begin_layout Plain Layout
17208 ] Whether to use the content of the inset as the label, when the inset is
17213 \begin_layout Description
17214 \begin_inset Flex Code
17217 \begin_layout Plain Layout
17224 \begin_inset Flex Code
17227 \begin_layout Plain Layout
17233 ] As with paragraph styles, see
17234 \begin_inset CommandInset ref
17236 reference "subsec:Paragraph-Styles"
17241 Note that you need to specify the complete type, e.
17242 \begin_inset space \thinspace{}
17246 \begin_inset space ~
17250 \begin_inset Flex Code
17253 \begin_layout Plain Layout
17254 CopyStyle Flex:<name>
17262 \begin_layout Description
17263 \begin_inset Flex Code
17266 \begin_layout Plain Layout
17273 \begin_inset Flex Code
17276 \begin_layout Plain Layout
17285 \begin_inset space \thinspace{}
17289 \begin_inset Flex Code
17292 \begin_layout Plain Layout
17298 ] Indicates whether the user may employ the Paragraph Settings dialog to
17299 customize the paragraph.
17302 \begin_layout Description
17303 \begin_inset Flex Code
17306 \begin_layout Plain Layout
17313 \begin_inset Flex Code
17316 \begin_layout Plain Layout
17323 \begin_inset Flex Code
17326 \begin_layout Plain Layout
17333 \begin_inset Flex Code
17336 \begin_layout Plain Layout
17342 , describing the rendering style used for the inset's frame and buttons.
17343 Footnotes generally use
17344 \begin_inset Flex Code
17347 \begin_layout Plain Layout
17353 , ERT insets generally
17354 \begin_inset Flex Code
17357 \begin_layout Plain Layout
17363 , and character styles
17364 \begin_inset Flex Code
17367 \begin_layout Plain Layout
17376 \begin_layout Description
17377 \begin_inset Flex Code
17380 \begin_layout Plain Layout
17387 \begin_inset Flex Code
17390 \begin_layout Plain Layout
17399 \begin_inset space \thinspace{}
17405 \begin_inset Flex Code
17408 \begin_layout Plain Layout
17417 \begin_inset Flex Code
17420 \begin_layout Plain Layout
17427 \begin_inset Flex Code
17430 \begin_layout Plain Layout
17437 Indicates whether the environment will stand on its own in the output or
17438 will appear inline with the surrounding text.
17439 If set to false, it is supposed that the \SpecialChar LaTeX
17440 environment ignores white space
17441 (including one newline character) after the
17442 \begin_inset Flex Code
17445 \begin_layout Plain Layout
17458 \begin_inset Flex Code
17461 \begin_layout Plain Layout
17477 \begin_layout Description
17478 \begin_inset Flex Code
17481 \begin_layout Plain Layout
17487 Required at the end of the
17488 \begin_inset Flex Code
17491 \begin_layout Plain Layout
17500 \begin_layout Description
17501 \begin_inset Flex Code
17504 \begin_layout Plain Layout
17510 The font used for both the text body
17516 \begin_inset CommandInset ref
17518 reference "subsec:Font-description"
17523 Note that defining this font automatically defines the
17524 \begin_inset Flex Code
17527 \begin_layout Plain Layout
17533 to the same value, so define this first and define
17534 \begin_inset Flex Code
17537 \begin_layout Plain Layout
17543 later if you want them to be different.
17544 \change_inserted -195340706 1421002157
17548 \begin_layout Description
17550 \change_inserted -195340706 1421002157
17551 \begin_inset Flex Code
17554 \begin_layout Plain Layout
17556 \change_inserted -195340706 1421002157
17557 FixedWidthPreambleEncoding
17563 \begin_inset Flex Code
17566 \begin_layout Plain Layout
17568 \change_inserted -195340706 1421002157
17577 \begin_inset space \thinspace{}
17581 \begin_inset Flex Code
17584 \begin_layout Plain Layout
17586 \change_inserted -195340706 1421002157
17592 ] Force a fixed width encoding for the translated contents of
17593 \begin_inset Flex Code
17596 \begin_layout Plain Layout
17598 \change_inserted -195340706 1421002157
17605 \begin_inset Flex Code
17608 \begin_layout Plain Layout
17610 \change_inserted -195340706 1421002157
17616 code generated by this layout.
17617 This is needed for special packages like the listings package that do not
17618 work with variable width encodings such as utf8.
17620 This setting is ignored if fully unicode aware \SpecialChar LaTeX
17621 backends such as Xe\SpecialChar LaTeX
17628 \begin_layout Description
17629 \begin_inset Flex Code
17632 \begin_layout Plain Layout
17633 ForceLocalFontSwitch
17639 \begin_inset Flex Code
17642 \begin_layout Plain Layout
17651 \begin_inset space \thinspace{}
17655 \begin_inset Flex Code
17658 \begin_layout Plain Layout
17664 ] When using babel, always use a local font switch (
17665 \begin_inset Flex Code
17668 \begin_layout Plain Layout
17676 ), never a global one (such as
17677 \begin_inset Flex Code
17680 \begin_layout Plain Layout
17691 \begin_layout Description
17692 \begin_inset Flex Code
17695 \begin_layout Plain Layout
17702 \begin_inset Flex Code
17705 \begin_layout Plain Layout
17714 \begin_inset space \thinspace{}
17718 \begin_inset Flex Code
17721 \begin_layout Plain Layout
17728 \begin_inset Quotes eld
17732 \begin_inset Quotes erd
17735 language, leading to Left-to-Right (Latin) output, e.
17736 \begin_inset space \thinspace{}
17740 \begin_inset space \space{}
17743 in \SpecialChar TeX
17746 \change_inserted -712698321 1417441977
17750 \begin_layout Description
17752 \change_inserted -712698321 1417442090
17753 \begin_inset Flex Code
17756 \begin_layout Plain Layout
17758 \change_inserted -712698321 1417441983
17765 \begin_inset Flex Code
17768 \begin_layout Plain Layout
17770 \change_inserted -712698321 1417441978
17779 \begin_inset space \thinspace{}
17783 \begin_inset Flex Code
17786 \begin_layout Plain Layout
17788 \change_inserted -712698321 1417441978
17794 ] Force a a line break in the \SpecialChar LaTeX
17795 output before the inset starts and after
17797 This assures the inset itself is output on its own lines, for parsing purposes.
17799 \change_inserted 274215730 1419105878
17805 \begin_layout Description
17806 \begin_inset Flex Code
17809 \begin_layout Plain Layout
17816 \begin_inset Flex Code
17819 \begin_layout Plain Layout
17828 \begin_inset space \thinspace{}
17832 \begin_inset Flex Code
17835 \begin_layout Plain Layout
17841 ] Indicates whether the
17842 \begin_inset Flex Code
17845 \begin_layout Plain Layout
17851 should be used or, instead, the user can change the paragraph style used
17856 \begin_layout Description
17857 \begin_inset Flex Code
17860 \begin_layout Plain Layout
17867 \begin_inset Flex Code
17870 \begin_layout Plain Layout
17879 \begin_inset space \thinspace{}
17883 \begin_inset Flex Code
17886 \begin_layout Plain Layout
17892 ] As with paragraph styles, see
17893 \begin_inset CommandInset ref
17895 reference "subsec:Paragraph-Styles"
17902 \begin_layout Description
17903 \begin_inset Flex Code
17906 \begin_layout Plain Layout
17912 These tags control the XHTML output.
17914 \begin_inset CommandInset ref
17916 reference "sec:Tags-for-XHTML"
17923 \begin_layout Description
17924 \begin_inset Flex Code
17927 \begin_layout Plain Layout
17934 \begin_inset Flex Code
17937 \begin_layout Plain Layout
17946 \begin_inset space \thinspace{}
17950 \begin_inset Flex Code
17953 \begin_layout Plain Layout
17959 ] Whether to include the contents of this inset in the strings generated
17960 for the `Outline' pane.
17961 One would not, for example, want the content of a footnote in a section
17962 header to be included in the TOC displayed in the outline, but one would
17963 normally want the content of a character style displayed.
17964 Default is false: not to include.
17967 \begin_layout Description
17968 \begin_inset Flex Code
17971 \begin_layout Plain Layout
17980 \begin_inset Flex Code
17983 \begin_layout Plain Layout
17992 \begin_inset space \thinspace{}
17996 \begin_inset Flex Code
17999 \begin_layout Plain Layout
18005 ] As with paragraph styles, see
18006 \begin_inset CommandInset ref
18008 reference "subsec:Paragraph-Styles"
18015 \begin_layout Description
18016 \begin_inset Flex Code
18019 \begin_layout Plain Layout
18025 The font used for the label.
18027 \begin_inset CommandInset ref
18029 reference "subsec:Font-description"
18034 Note that this definition can never appear before
18035 \begin_inset Flex Code
18038 \begin_layout Plain Layout
18044 , lest it be ineffective.
18047 \begin_layout Description
18048 \begin_inset Flex Code
18051 \begin_layout Plain Layout
18058 \begin_inset Flex Code
18061 \begin_layout Plain Layout
18068 \begin_inset Quotes erd
18072 \begin_inset Quotes erd
18075 ] What will be displayed on the button or elsewhere as the inset label.
18077 \begin_inset Flex Code
18080 \begin_layout Plain Layout
18088 \begin_inset Flex Code
18091 \begin_layout Plain Layout
18097 ) modify this label on the fly.
18100 \begin_layout Description
18101 \begin_inset Flex Code
18104 \begin_layout Plain Layout
18110 Language dependent preamble; see
18111 \begin_inset CommandInset ref
18113 reference "subsec:I18n"
18120 \begin_layout Description
18121 \begin_inset Flex Code
18124 \begin_layout Plain Layout
18131 \begin_inset Flex Code
18134 \begin_layout Plain Layout
18140 ] The name of the corresponding \SpecialChar LaTeX
18142 Either the environment or command name.
18145 \begin_layout Description
18146 \begin_inset Flex Code
18149 \begin_layout Plain Layout
18156 \begin_inset Flex Code
18159 \begin_layout Plain Layout
18165 ] The optional parameter for the corresponding
18166 \begin_inset Flex Code
18169 \begin_layout Plain Layout
18175 stuff, including possible bracket pairs like
18176 \begin_inset Flex Code
18179 \begin_layout Plain Layout
18186 This parameter cannot be changed from within \SpecialChar LyX
18188 \begin_inset Flex Code
18191 \begin_layout Plain Layout
18197 for customizable parameters).
18198 It will be output as is after all \SpecialChar LaTeX
18200 \begin_inset Flex Code
18203 \begin_layout Plain Layout
18212 \begin_layout Description
18213 \begin_inset Flex Code
18216 \begin_layout Plain Layout
18223 \begin_inset Flex Code
18226 \begin_layout Plain Layout
18227 Command, Environment, None
18232 ] How the style should be translated into \SpecialChar LaTeX
18237 \begin_layout Plain Layout
18238 \begin_inset Flex Code
18241 \begin_layout Plain Layout
18247 is perhaps a bit misleading, since these rules apply to SGML classes too.
18248 Visit the SGML class files for specific examples.
18254 \begin_inset Separator parbreak
18261 \begin_layout Description
18262 \begin_inset Flex Code
18265 \begin_layout Plain Layout
18271 means nothing special
18274 \begin_layout Description
18275 \begin_inset Flex Code
18278 \begin_layout Plain Layout
18285 \begin_inset Flex Code
18288 \begin_layout Plain Layout
18295 {\SpecialChar ldots
18304 \begin_layout Description
18305 \begin_inset Flex Code
18308 \begin_layout Plain Layout
18315 \begin_inset Flex Code
18318 \begin_layout Plain Layout
18325 }\SpecialChar ldots
18340 \begin_layout Standard
18341 Putting the last few things together, the \SpecialChar LaTeX
18342 output will be either:
18345 \begin_layout LyX-Code
18348 LatexName[LatexParam]{\SpecialChar ldots
18352 \begin_layout Standard
18356 \begin_layout LyX-Code
18359 begin{LatexName}[LatexParam] \SpecialChar ldots
18365 \begin_layout Standard
18366 depending upon the \SpecialChar LaTeX
18371 \begin_layout Description
18372 \begin_inset Flex Code
18375 \begin_layout Plain Layout
18382 \begin_inset Flex Code
18385 \begin_layout Plain Layout
18391 ] A string that is put at the beginning of the layout content.
18392 A line break in the output can be indicated by
18393 \begin_inset Flex Code
18396 \begin_layout Plain Layout
18405 \begin_layout Description
18406 \begin_inset Flex Code
18409 \begin_layout Plain Layout
18416 \begin_inset Flex Code
18419 \begin_layout Plain Layout
18426 \begin_inset Flex Code
18429 \begin_layout Plain Layout
18436 \begin_inset Flex Code
18439 \begin_layout Plain Layout
18446 \begin_inset Flex Code
18449 \begin_layout Plain Layout
18455 (indicating a dummy definition ending definitions of charstyles, etc).
18456 This entry is required in and is only meaningful for Flex insets.
18457 Among other things, it determines on which menu this inset will appear.
18459 \begin_inset Flex Code
18462 \begin_layout Plain Layout
18469 \begin_inset Flex Code
18472 \begin_layout Plain Layout
18478 will automatically set
18479 \begin_inset Flex Code
18482 \begin_layout Plain Layout
18490 \begin_inset Flex Code
18493 \begin_layout Plain Layout
18499 can be set to true for
18500 \begin_inset Flex Code
18503 \begin_layout Plain Layout
18509 insets by setting it
18514 \begin_inset Flex Code
18517 \begin_layout Plain Layout
18526 \begin_layout Description
18527 \begin_inset Flex Code
18530 \begin_layout Plain Layout
18537 \begin_inset Flex Code
18540 \begin_layout Plain Layout
18549 \begin_inset space \thinspace{}
18553 \begin_inset Flex Code
18556 \begin_layout Plain Layout
18562 ] Whether multiple paragraphs are permitted in this inset.
18564 \begin_inset Flex Code
18567 \begin_layout Plain Layout
18573 to the same value and
18574 \begin_inset Flex Code
18577 \begin_layout Plain Layout
18583 to the opposite value.
18584 These can be reset to other values, if they are used
18589 \begin_inset Flex Code
18592 \begin_layout Plain Layout
18602 \begin_layout Description
18603 \begin_inset Flex Code
18606 \begin_layout Plain Layout
18613 \begin_inset Flex Code
18616 \begin_layout Plain Layout
18625 \begin_inset space \thinspace{}
18629 \begin_inset Flex Code
18632 \begin_layout Plain Layout
18638 ] Whether fragile commands in this inset should be
18639 \begin_inset Flex Code
18642 \begin_layout Plain Layout
18655 whether the command should itself be protected.) Default is false.
18658 \begin_layout Description
18659 \begin_inset Flex Code
18662 \begin_layout Plain Layout
18669 \begin_inset Flex Code
18672 \begin_layout Plain Layout
18678 ] Deletes an existing
18679 \begin_inset Flex Code
18682 \begin_layout Plain Layout
18689 \change_inserted -712698321 1417953494
18693 \begin_layout Description
18695 \change_inserted -712698321 1417953559
18696 \begin_inset Flex Code
18699 \begin_layout Plain Layout
18701 \change_inserted -712698321 1417953494
18708 \begin_inset Flex Code
18711 \begin_layout Plain Layout
18713 \change_inserted -712698321 1417953574
18720 \begin_inset Flex Code
18723 \begin_layout Plain Layout
18725 \change_inserted -712698321 1417953533
18731 that has replaced this
18732 \begin_inset Flex Code
18735 \begin_layout Plain Layout
18737 \change_inserted -712698321 1417953551
18744 This is used to rename an
18745 \begin_inset Flex Code
18748 \begin_layout Plain Layout
18750 \change_inserted -712698321 1417953559
18756 , while keeping backward compatibility.
18761 \begin_layout Description
18762 \begin_inset Flex Code
18765 \begin_layout Plain Layout
18772 \begin_inset Flex Code
18775 \begin_layout Plain Layout
18784 \begin_inset space \thinspace{}
18788 \begin_inset Flex Code
18791 \begin_layout Plain Layout
18797 ] As with paragraph styles, see
18798 \begin_inset CommandInset ref
18800 reference "subsec:Paragraph-Styles"
18808 \begin_layout Description
18809 \begin_inset Flex Code
18812 \begin_layout Plain Layout
18819 \begin_inset Flex Code
18822 \begin_layout Plain Layout
18831 \begin_inset space \thinspace{}
18835 \begin_inset Flex Code
18838 \begin_layout Plain Layout
18844 ] As with paragraph styles, see
18845 \begin_inset CommandInset ref
18847 reference "subsec:Paragraph-Styles"
18855 \begin_layout Description
18856 \begin_inset Flex Code
18859 \begin_layout Plain Layout
18865 As with paragraph styles, see
18866 \begin_inset CommandInset ref
18868 reference "subsec:Paragraph-Styles"
18875 \begin_layout Description
18876 \begin_inset Flex Code
18879 \begin_layout Plain Layout
18886 \begin_inset Flex Code
18889 \begin_layout Plain Layout
18895 ] The prefix to use when creating labels referring to insets of this type.
18896 This allows the use of formatted references.
18899 \begin_layout Description
18900 \begin_inset Flex Code
18903 \begin_layout Plain Layout
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"
18929 \begin_layout Description
18930 \begin_inset Flex Code
18933 \begin_layout Plain Layout
18940 \begin_inset Flex Code
18943 \begin_layout Plain Layout
18952 \begin_inset space \thinspace{}
18956 \begin_inset Flex Code
18959 \begin_layout Plain Layout
18965 ] Resets the \SpecialChar LaTeX
18966 arguments of this layout (as defined via the
18967 \begin_inset Flex Code
18970 \begin_layout Plain Layout
18977 This is useful if you have copied a style via
18978 \begin_inset Flex Code
18981 \begin_layout Plain Layout
18987 , but you do not want to inherit its (required and optional) arguments.
18990 \begin_layout Description
18991 \begin_inset Flex Code
18994 \begin_layout Plain Layout
19001 \begin_inset Flex Code
19004 \begin_layout Plain Layout
19011 \begin_inset space \thinspace{}
19015 \begin_inset Flex Code
19018 \begin_layout Plain Layout
19026 ] Whether this inset should use the font of its surrounding environment
19028 Default is false: use the font of the surrounding environment.
19031 \begin_layout Description
19032 \begin_inset Flex Code
19035 \begin_layout Plain Layout
19042 \begin_inset Flex Code
19045 \begin_layout Plain Layout
19051 ] A string that is put at the end of the layout content.
19052 A line break in the output can be indicated by
19053 \begin_inset Flex Code
19056 \begin_layout Plain Layout
19065 \begin_layout Description
19066 \begin_inset Flex Code
19069 \begin_layout Plain Layout
19076 \begin_inset Flex Code
19079 \begin_layout Plain Layout
19086 \begin_inset space \thinspace{}
19090 \begin_inset Flex Code
19093 \begin_layout Plain Layout
19101 ] Allow spell-checking the contents of this inset.
19105 \begin_layout Subsection
19107 \begin_inset CommandInset label
19109 name "subsec:Counters"
19116 \begin_layout Standard
19117 It is necessary to define the counters (
19118 \begin_inset Flex MenuItem
19121 \begin_layout Plain Layout
19128 \begin_inset Flex MenuItem
19131 \begin_layout Plain Layout
19137 , \SpecialChar ldots
19138 ) in the text class itself.
19139 The standard counters are defined in the file
19140 \begin_inset Flex Code
19143 \begin_layout Plain Layout
19149 , so you may have to do no more than add
19152 \begin_layout LyX-Code
19153 Input stdcounters.inc
19156 \begin_layout Standard
19157 to your layout file to get them to work.
19158 But if you want to define custom counters, then you can do so.
19159 The counter declaration must begin with:
19162 \begin_layout LyX-Code
19163 Counter CounterName
19166 \begin_layout Standard
19168 \begin_inset Flex Code
19171 \begin_layout Plain Layout
19177 ' is replaced by the name of the counter.
19178 And it must end with
19179 \begin_inset Quotes eld
19183 \begin_inset Flex Code
19186 \begin_layout Plain Layout
19193 \begin_inset Quotes erd
19197 The following parameters can also be used:
19200 \begin_layout Description
19201 \begin_inset Flex Code
19204 \begin_layout Plain Layout
19211 \begin_inset Flex Code
19214 \begin_layout Plain Layout
19220 ] Sets the initial value for the counter, to which it will be reset whenever
19222 Normally, one will want the default, 1.
19225 \begin_layout Description
19226 \begin_inset Flex Code
19229 \begin_layout Plain Layout
19236 \begin_inset Flex Code
19239 \begin_layout Plain Layout
19246 \begin_inset Quotes erd
19250 \begin_inset Quotes erd
19253 ] When defined, this string defines how the counter is displayed.
19254 Setting this value sets
19255 \begin_inset Flex Code
19258 \begin_layout Plain Layout
19259 LabelStringAppendix
19265 The following special constructs can be used in the string:
19266 \begin_inset Separator parbreak
19273 \begin_layout Itemize
19274 \begin_inset Flex Code
19277 \begin_layout Plain Layout
19285 will be replaced by the expansion of the
19286 \begin_inset Flex Code
19289 \begin_layout Plain Layout
19296 \begin_inset Flex Code
19299 \begin_layout Plain Layout
19300 LabelStringAppendix
19306 \begin_inset Flex Code
19309 \begin_layout Plain Layout
19319 \begin_layout Itemize
19320 counter values can be expressed using \SpecialChar LaTeX
19322 \begin_inset Newline newline
19326 \begin_inset Flex Code
19329 \begin_layout Plain Layout
19346 \begin_inset Flex Code
19349 \begin_layout Plain Layout
19361 \begin_layout Plain Layout
19371 Actually, the situation is a bit more complicated: any
19390 other than those described below will produce arabic numerals.
19391 It would not be surprising to see this change in the future.
19397 \begin_inset Flex Code
19400 \begin_layout Plain Layout
19406 : 1, 2, 3,\SpecialChar ldots
19408 \begin_inset Flex Code
19411 \begin_layout Plain Layout
19417 for lower-case letters: a, b, c, \SpecialChar ldots
19419 \begin_inset Flex Code
19422 \begin_layout Plain Layout
19428 for upper-case letters: A, B, C, \SpecialChar ldots
19430 \begin_inset Flex Code
19433 \begin_layout Plain Layout
19439 for lower-case roman numerals: i, ii, iii, \SpecialChar ldots
19441 \begin_inset Flex Code
19444 \begin_layout Plain Layout
19450 for upper-case roman numerals: I, II, III\SpecialChar ldots
19452 \begin_inset Flex Code
19455 \begin_layout Plain Layout
19461 for hebrew numerals.
19465 \begin_layout Standard
19466 If LabelString is not defined, a default value is constructed as follows:
19467 if the counter has a master counter
19468 \begin_inset Flex Code
19471 \begin_layout Plain Layout
19478 \begin_inset Flex Code
19481 \begin_layout Plain Layout
19488 \begin_inset Newline newline
19492 \begin_inset Flex Code
19495 \begin_layout Plain Layout
19505 is used; otherwise the string
19506 \begin_inset Flex Code
19509 \begin_layout Plain Layout
19520 \begin_layout Description
19521 \begin_inset Flex Code
19524 \begin_layout Plain Layout
19525 LabelStringAppendix
19531 \begin_inset Flex Code
19534 \begin_layout Plain Layout
19541 \begin_inset Quotes erd
19545 \begin_inset Quotes erd
19549 \begin_inset Flex Code
19552 \begin_layout Plain Layout
19558 , but for use in the Appendix.
19561 \begin_layout Description
19562 \begin_inset Flex Code
19565 \begin_layout Plain Layout
19572 \begin_inset Flex Code
19575 \begin_layout Plain Layout
19582 \begin_inset Quotes erd
19586 \begin_inset Quotes erd
19589 ] A format for use with formatted references to this counter.
19590 For example, one might want to have references to section numbers appear
19592 \begin_inset Quotes eld
19596 \begin_inset Quotes erd
19600 The string should contain
19601 \begin_inset Quotes eld
19605 \begin_inset Quotes erd
19609 This will be replaced by the counter number itself.
19610 So, for sections, it would be: Section ##.
19613 \begin_layout Description
19614 \begin_inset Flex Code
19617 \begin_layout Plain Layout
19624 \begin_inset Flex Code
19627 \begin_layout Plain Layout
19634 \begin_inset Quotes erd
19638 \begin_inset Quotes erd
19641 ] If this is set to the name of another counter, the present counter will
19642 be reset every time the other one is increased.
19644 \begin_inset Flex Code
19647 \begin_layout Plain Layout
19654 \begin_inset Flex Code
19657 \begin_layout Plain Layout
19666 \begin_layout Subsection
19668 \begin_inset CommandInset label
19670 name "subsec:Font-description"
19677 \begin_layout Standard
19678 A font description looks like this:
19681 \begin_layout LyX-Code
19695 \begin_layout LyX-Code
19699 \begin_layout LyX-Code
19703 \begin_layout Standard
19704 The following commands are available:
19707 \begin_layout Description
19708 \begin_inset Flex Code
19711 \begin_layout Plain Layout
19718 \begin_inset Flex Code
19721 \begin_layout Plain Layout
19730 \begin_inset Flex Code
19733 \begin_layout Plain Layout
19740 \begin_inset Flex Code
19743 \begin_layout Plain Layout
19750 \begin_inset Flex Code
19753 \begin_layout Plain Layout
19760 \begin_inset Flex Code
19763 \begin_layout Plain Layout
19770 \begin_inset Flex Code
19773 \begin_layout Plain Layout
19780 \begin_inset Flex Code
19783 \begin_layout Plain Layout
19790 \begin_inset Flex Code
19793 \begin_layout Plain Layout
19800 \begin_inset Flex Code
19803 \begin_layout Plain Layout
19812 \begin_layout Description
19813 \begin_inset Flex Code
19816 \begin_layout Plain Layout
19823 \begin_inset Flex Code
19826 \begin_layout Plain Layout
19835 \begin_inset Flex Code
19838 \begin_layout Plain Layout
19845 \begin_inset Flex Code
19848 \begin_layout Plain Layout
19857 \begin_layout Description
19858 \begin_inset Flex Code
19861 \begin_layout Plain Layout
19868 \begin_inset Flex Code
19871 \begin_layout Plain Layout
19877 ] Valid arguments are:
19878 \begin_inset Flex Code
19881 \begin_layout Plain Layout
19888 \begin_inset Flex Code
19891 \begin_layout Plain Layout
19898 \begin_inset Flex Code
19901 \begin_layout Plain Layout
19908 \begin_inset Flex Code
19911 \begin_layout Plain Layout
19918 \begin_inset Flex Code
19921 \begin_layout Plain Layout
19928 \begin_inset Flex Code
19931 \begin_layout Plain Layout
19938 \begin_inset Flex Code
19941 \begin_layout Plain Layout
19948 \begin_inset Flex Code
19951 \begin_layout Plain Layout
19958 \begin_inset Flex Code
19961 \begin_layout Plain Layout
19968 \begin_inset Flex Code
19971 \begin_layout Plain Layout
19978 \begin_inset Flex Code
19981 \begin_layout Plain Layout
19988 \begin_inset Flex Code
19991 \begin_layout Plain Layout
19998 Each of these turns on or off the corresponding attribute.
20000 \begin_inset Flex Code
20003 \begin_layout Plain Layout
20009 turns on emphasis, and
20010 \begin_inset Flex Code
20013 \begin_layout Plain Layout
20021 \begin_inset Newline newline
20024 If the latter seems puzzling, remember that the font settings for the present
20025 context are generally inherited from the surrounding context.
20027 \begin_inset Flex Code
20030 \begin_layout Plain Layout
20036 would turn off the emphasis that was anyway in effect, say, in a theorem
20040 \begin_layout Description
20041 \begin_inset Flex Code
20044 \begin_layout Plain Layout
20051 \begin_inset Flex Code
20054 \begin_layout Plain Layout
20063 \begin_inset Flex Code
20066 \begin_layout Plain Layout
20075 \begin_layout Description
20076 \begin_inset Flex Code
20079 \begin_layout Plain Layout
20086 \begin_inset Flex Code
20089 \begin_layout Plain Layout
20098 \begin_inset Flex Code
20101 \begin_layout Plain Layout
20108 \begin_inset Flex Code
20111 \begin_layout Plain Layout
20118 \begin_inset Flex Code
20121 \begin_layout Plain Layout
20130 \begin_layout Description
20131 \begin_inset Flex Code
20134 \begin_layout Plain Layout
20141 \begin_inset Flex Code
20144 \begin_layout Plain Layout
20151 \begin_inset Flex Code
20154 \begin_layout Plain Layout
20161 \begin_inset Flex Code
20164 \begin_layout Plain Layout
20173 \begin_inset Flex Code
20176 \begin_layout Plain Layout
20183 \begin_inset Flex Code
20186 \begin_layout Plain Layout
20193 \begin_inset Flex Code
20196 \begin_layout Plain Layout
20203 \begin_inset Flex Code
20206 \begin_layout Plain Layout
20213 \begin_inset Flex Code
20216 \begin_layout Plain Layout
20225 \begin_layout Subsection
20226 \begin_inset CommandInset label
20228 name "subsec:Citation-format-description"
20232 Citation format description
20235 \begin_layout Standard
20237 \begin_inset Flex Code
20240 \begin_layout Plain Layout
20246 blocks are used to describe how bibliographic information should be displayed,
20247 both within \SpecialChar LyX
20248 itself (in the citation dialog and in tooltips, for example)
20249 and in XHTML output.
20250 Such a block might look like this:
20253 \begin_layout LyX-Code
20257 \begin_layout LyX-Code
20261 \begin_layout LyX-Code
20265 \begin_layout LyX-Code
20269 \begin_layout Standard
20270 The individual lines define how the bibliographic information associated
20271 with an article or book, respectively, is to be displayed, and such a definitio
20272 n can be given for any `entry type' that might be present in a Bib\SpecialChar TeX
20275 defines a default format in the source code that will be used if no specific
20276 definition has been given.
20278 predefines several formats in the file
20279 \begin_inset Flex Code
20282 \begin_layout Plain Layout
20288 , which is included in most of \SpecialChar LyX
20289 's document classes.
20292 \begin_layout Standard
20293 The definitions use a simple language that allows Bib\SpecialChar TeX
20294 keys to be replaced
20296 Keys should be enclosed in
20297 \begin_inset Flex Code
20300 \begin_layout Plain Layout
20307 \begin_inset Flex Code
20310 \begin_layout Plain Layout
20317 So a simple definition might look like this:
20320 \begin_layout LyX-Code
20322 \begin_inset Quotes eld
20326 \begin_inset Quotes erd
20332 \begin_layout Standard
20333 This would print the author, followed by a comma, followed by the title,
20334 in quotes, followed by a period.
20337 \begin_layout Standard
20338 Of course, sometimes you may want to print a key only if it exists.
20339 This can be done by using a conditional construction, such as:
20340 \begin_inset Flex Code
20343 \begin_layout Plain Layout
20345 \begin_inset space ~
20355 \begin_inset Flex Code
20358 \begin_layout Plain Layout
20364 key exists, then print
20365 \begin_inset Quotes eld
20369 \begin_inset space ~
20373 \begin_inset Quotes erd
20376 followed by the volume key.
20377 It is also possible to have an else clause in the conditional, such as:
20378 \begin_inset Newline newline
20382 \begin_inset Flex Code
20385 \begin_layout Plain Layout
20386 {%author%[[%author%]][[%editor%, ed.]]}
20392 \begin_inset Newline newline
20396 \begin_inset Flex Code
20399 \begin_layout Plain Layout
20405 key is printed if it exists; otherwise, the editor key is printed, followed
20407 \begin_inset Quotes eld
20411 \begin_inset space ~
20415 \begin_inset Quotes erd
20418 Note that the key is again enclosed in
20419 \begin_inset Flex Code
20422 \begin_layout Plain Layout
20428 signs; the entire conditional is enclosed in braces; and the if and else
20429 clauses are enclosed in double brackets,
20430 \begin_inset Quotes eld
20434 \begin_inset Flex Code
20437 \begin_layout Plain Layout
20444 \begin_inset Quotes eld
20448 \begin_inset Quotes eld
20452 \begin_inset Flex Code
20455 \begin_layout Plain Layout
20462 \begin_inset Quotes erd
20466 There must be no space between any of these.
20469 \begin_layout Standard
20470 There is one other piece of syntax available in definitions, which looks
20472 \begin_inset Flex Code
20475 \begin_layout Plain Layout
20482 This defines a piece of formatting information that is to be used when
20484 \begin_inset Quotes eld
20488 \begin_inset Quotes erd
20492 Obviously, we do not want to output HTML tags when writing plain text,
20493 so they should be wrapped in
20494 \begin_inset Quotes eld
20498 \begin_inset Quotes erd
20502 \begin_inset Quotes eld
20506 \begin_inset Quotes erd
20512 \begin_layout Standard
20513 Two special sorts of definitions are also possible in a
20514 \begin_inset Flex Code
20517 \begin_layout Plain Layout
20524 An example of the first would be:
20527 \begin_layout LyX-Code
20529 \begin_inset Quotes eld
20533 \begin_inset Quotes erd
20539 \begin_layout Standard
20540 This is an abbreviation, or macro, and it can be used by treating it as
20542 \begin_inset Flex Code
20545 \begin_layout Plain Layout
20554 \begin_inset Flex Code
20557 \begin_layout Plain Layout
20563 exactly as it would treat its definition.
20564 So, let us issue the obvious
20572 \begin_layout LyX-Code
20576 \begin_layout Standard
20577 or anything like it.
20579 shouldn't go into an infinite loop, but it may go into a long one before
20583 \begin_layout Standard
20584 The second sort of special definition might look like this:
20587 \begin_layout LyX-Code
20591 \begin_layout Standard
20592 This defines a translatable piece of text, which allows relevant parts of
20593 the bibliography to be translated.
20594 It can be included in a definition by treating it as a key:
20595 \begin_inset Flex Code
20598 \begin_layout Plain Layout
20605 Several of these are predefined in
20606 \begin_inset Flex Code
20609 \begin_layout Plain Layout
20616 Note that these are not macros, in the sense just defined.
20617 They will not be expanded.
20620 \begin_layout Standard
20621 So here then is an example that use all these features:
20622 \begin_inset VSpace defskip
20628 \begin_layout Standard
20632 !authoredit {%author%[[%author%, ]][[{%editor%[[%editor%, %_edtext%, ]]}]]}
20635 \begin_layout Standard
20636 \begin_inset VSpace defskip
20639 This defines a macro that prints the author, followed by a comma, if the
20641 \begin_inset Flex Code
20644 \begin_layout Plain Layout
20650 key is defined, or else prints the name of the editor, followed by the
20652 \begin_inset Flex Code
20655 \begin_layout Plain Layout
20661 or its translation (it is by default
20662 \begin_inset Quotes eld
20666 \begin_inset Quotes erd
20670 \begin_inset Flex Code
20673 \begin_layout Plain Layout
20680 Note that this is in fact defined in
20681 \begin_inset Flex Code
20684 \begin_layout Plain Layout
20690 , so you can use it in your own definitions, or re-definitions, if you load
20694 \begin_layout Section
20695 \begin_inset CommandInset label
20697 name "sec:Tags-for-XHTML"
20701 Tags for XHTML output
20704 \begin_layout Standard
20705 As with \SpecialChar LaTeX
20706 or DocBook, the format of \SpecialChar LyX
20707 's XHTML output is also controlled by
20708 layout information.
20709 In general, \SpecialChar LyX
20710 provides sensible defaults and, as mentioned earlier, it will
20711 even construct default CSS style rules from the other layout tags.
20712 For example, \SpecialChar LyX
20713 will attempt to use the information provided in the
20714 \begin_inset Flex Code
20717 \begin_layout Plain Layout
20723 declaration for the Chapter style to write CSS that will appropriately
20724 format chapter headings.
20727 \begin_layout Standard
20728 In many cases, then, you may not have to do anything at all to get acceptable
20729 XHTML output for your own environments, custom insets, and so forth.
20730 But in some cases you will, and so \SpecialChar LyX
20731 provides a number of layout tags that
20732 can be used to customize the XHTML and CSS that are generated.
20735 \begin_layout Standard
20736 Note that there are two tags,
20737 \begin_inset Flex Code
20740 \begin_layout Plain Layout
20747 \begin_inset Flex Code
20750 \begin_layout Plain Layout
20756 that may appear outside style and inset declarations.
20758 \begin_inset CommandInset ref
20760 reference "subsec:General-text-class"
20764 for details on these.
20767 \begin_layout Subsection
20768 \begin_inset CommandInset label
20770 name "subsec:Paragraph-Style-XHTML"
20777 \begin_layout Standard
20778 The sort of XHTML \SpecialChar LyX
20779 outputs for a paragraph depends upon whether we are dealing
20780 with a normal paragraph, a command, or an environment, where this is itself
20781 determined by the contents of the corresponding
20782 \begin_inset Flex Code
20785 \begin_layout Plain Layout
20796 \begin_layout Standard
20797 For a command or normal paragraph, the output XHTML has the following form:
20800 \begin_layout LyX-Code
20802 \begin_inset Quotes erd
20806 \begin_inset Quotes erd
20812 \begin_layout LyX-Code
20814 \begin_inset Quotes erd
20818 \begin_inset Quotes erd
20824 \begin_layout LyX-Code
20825 Contents of the paragraph.
20828 \begin_layout LyX-Code
20832 \begin_layout Standard
20833 The label tags are of course omitted if the paragraph does not have a label.
20836 \begin_layout Standard
20837 For an environment that is not some sort of list, the XHTML takes this form:
20840 \begin_layout LyX-Code
20842 \begin_inset Quotes erd
20846 \begin_inset Quotes erd
20852 \begin_layout LyX-Code
20854 \begin_inset Quotes erd
20858 \begin_inset Quotes erd
20862 \begin_inset Quotes erd
20866 \begin_inset Quotes erd
20869 >Environment Label</labeltag>First paragraph.</itemtag>
20872 \begin_layout LyX-Code
20873 <itemtag>Second paragraph.</itemtag>
20876 \begin_layout LyX-Code
20880 \begin_layout Standard
20881 Note that the label is output only for the first paragraph, as it should
20882 be for a theorem, for example.
20886 \begin_layout Standard
20887 For a list, we have one of these forms:
20890 \begin_layout LyX-Code
20892 \begin_inset Quotes erd
20896 \begin_inset Quotes erd
20902 \begin_layout LyX-Code
20904 \begin_inset Quotes erd
20908 \begin_inset Quotes erd
20912 \begin_inset Quotes erd
20916 \begin_inset Quotes erd
20919 >List Label</labeltag>First item.</itemtag>
20922 \begin_layout LyX-Code
20924 \begin_inset Quotes erd
20928 \begin_inset Quotes erd
20932 \begin_inset Quotes erd
20936 \begin_inset Quotes erd
20939 >List Label</labeltag>Second item.</itemtag>
20942 \begin_layout LyX-Code
20946 \begin_layout LyX-Code
20950 \begin_layout LyX-Code
20952 \begin_inset Quotes erd
20956 \begin_inset Quotes erd
20962 \begin_layout LyX-Code
20964 \begin_inset Quotes erd
20968 \begin_inset Quotes erd
20971 >List Label</labeltag><itemtag attr=
20972 \begin_inset Quotes erd
20976 \begin_inset Quotes erd
20979 >First item.</itemtag>
20982 \begin_layout LyX-Code
20984 \begin_inset Quotes erd
20988 \begin_inset Quotes erd
20991 >List Label</labeltag><itemtag attr=
20992 \begin_inset Quotes erd
20996 \begin_inset Quotes erd
20999 >Second item.</itemtag>
21002 \begin_layout LyX-Code
21006 \begin_layout Standard
21007 Note the different orders of
21008 \begin_inset Flex Code
21011 \begin_layout Plain Layout
21018 \begin_inset Flex Code
21021 \begin_layout Plain Layout
21028 Which order we get depends upon the setting of
21029 \begin_inset Flex Code
21032 \begin_layout Plain Layout
21039 \begin_inset Flex Code
21042 \begin_layout Plain Layout
21048 is false (the default), you get the first of these, with the label within
21049 the item; if true, you get the second, with the label outside the item.
21052 \begin_layout Standard
21053 The specific tags and attributes output for each paragraph type can be controlle
21054 d by means of the layout tags we are about to describe.
21055 As mentioned earlier, however, \SpecialChar LyX
21056 uses sensible defaults for many of these,
21057 so you often may not need to do very much to get good XHTML output.
21058 Think of the available tags as there so you can tweak things to your liking.
21061 \begin_layout Description
21062 \begin_inset Flex Code
21065 \begin_layout Plain Layout
21072 \begin_inset Flex Code
21075 \begin_layout Plain Layout
21081 ] Specifies attribute information to be output with the main tag.
21083 \begin_inset Quotes eld
21087 \begin_inset Flex Code
21090 \begin_layout Plain Layout
21097 \begin_inset Quotes erd
21101 By default, \SpecialChar LyX
21103 \begin_inset Quotes eld
21107 \begin_inset Flex Code
21110 \begin_layout Plain Layout
21117 \begin_inset Quotes erd
21121 \begin_inset Flex Code
21124 \begin_layout Plain Layout
21130 is the \SpecialChar LyX
21131 name of the layout, made lowercase, for example: chapter.
21136 contain any style information.
21138 \begin_inset Flex Code
21141 \begin_layout Plain Layout
21150 \begin_layout Description
21151 \begin_inset Flex Code
21154 \begin_layout Plain Layout
21161 \begin_inset Flex Code
21164 \begin_layout Plain Layout
21174 ] Whether to output the default CSS information \SpecialChar LyX
21175 generates for this layout,
21176 even if additional information is explicitly provided via
21177 \begin_inset Flex Code
21180 \begin_layout Plain Layout
21188 \begin_inset Flex Code
21191 \begin_layout Plain Layout
21197 allows you to alter or augment the generated CSS, rather than to override
21200 \begin_inset Flex Code
21203 \begin_layout Plain Layout
21212 \begin_layout Description
21213 \begin_inset Flex Code
21216 \begin_layout Plain Layout
21223 \begin_inset Flex Code
21226 \begin_layout Plain Layout
21232 ] The tag to be used for individual paragraphs of environments, replacing
21234 \begin_inset Flex Code
21237 \begin_layout Plain Layout
21243 in the examples above.
21245 \begin_inset Flex Code
21248 \begin_layout Plain Layout
21257 \begin_layout Description
21258 \begin_inset Flex Code
21261 \begin_layout Plain Layout
21268 \begin_inset Flex Code
21271 \begin_layout Plain Layout
21277 ] Attributes for the item tag.
21279 \begin_inset Quotes eld
21283 \begin_inset Flex Code
21286 \begin_layout Plain Layout
21287 class=`layoutname_item'
21293 \begin_inset Quotes erd
21301 contain any style information.
21303 \begin_inset Flex Code
21306 \begin_layout Plain Layout
21315 \begin_layout Description
21316 \begin_inset Flex Code
21319 \begin_layout Plain Layout
21326 \begin_inset Flex Code
21329 \begin_layout Plain Layout
21335 ] The tag to be used for paragraph and item labels, replacing
21336 \begin_inset Flex Code
21339 \begin_layout Plain Layout
21345 in the examples above.
21347 \begin_inset Flex Code
21350 \begin_layout Plain Layout
21357 \begin_inset Flex Code
21360 \begin_layout Plain Layout
21367 \begin_inset Flex Code
21370 \begin_layout Plain Layout
21377 \begin_inset Flex Code
21380 \begin_layout Plain Layout
21381 Centered_Top_Environment
21386 , in which case it defaults to
21387 \begin_inset Flex Code
21390 \begin_layout Plain Layout
21399 \begin_layout Description
21400 \begin_inset Flex Code
21403 \begin_layout Plain Layout
21410 \begin_inset Flex Code
21413 \begin_layout Plain Layout
21419 ] Attributes for the label tag.
21421 \begin_inset Quotes eld
21425 \begin_inset Flex Code
21428 \begin_layout Plain Layout
21429 class=`layoutname_label'
21435 \begin_inset Quotes erd
21443 contain any style information.
21445 \begin_inset Flex Code
21448 \begin_layout Plain Layout
21457 \begin_layout Description
21458 \begin_inset Flex Code
21461 \begin_layout Plain Layout
21468 \begin_inset Flex Code
21471 \begin_layout Plain Layout
21481 ] Meaningful only for list-like environments, this tag controls whether
21482 the label tag is output before or inside the item tag.
21483 This is used, for example, in the description environment, where we want
21485 \begin_inset Flex Code
21488 \begin_layout Plain Layout
21489 <dt>\SpecialChar ldots
21490 </dt><dd>\SpecialChar ldots
21498 \begin_inset Flex Code
21501 \begin_layout Plain Layout
21507 : The label tag is output inside the item tag.
21510 \begin_layout Description
21511 \begin_inset Flex Code
21514 \begin_layout Plain Layout
21520 Information to be output in the
21521 \begin_inset Flex Code
21524 \begin_layout Plain Layout
21530 section when this style is used.
21531 This might, for example, be used to include a
21532 \begin_inset Flex Code
21535 \begin_layout Plain Layout
21542 \begin_inset Flex Code
21545 \begin_layout Plain Layout
21554 \begin_layout Description
21555 \begin_inset Flex Code
21558 \begin_layout Plain Layout
21564 CSS style information to be included when this style is used.
21565 Note that this will automatically be wrapped in a layout-generated
21566 \begin_inset Flex Code
21569 \begin_layout Plain Layout
21575 block, so only the CSS itself need be included.
21577 \begin_inset Flex Code
21580 \begin_layout Plain Layout
21589 \begin_layout Description
21590 \begin_inset Flex Code
21593 \begin_layout Plain Layout
21600 \begin_inset Flex Code
21603 \begin_layout Plain Layout
21609 ] The tag to be used for the main label, replacing
21610 \begin_inset Flex Code
21613 \begin_layout Plain Layout
21619 in the examples above.
21621 \begin_inset Flex Code
21624 \begin_layout Plain Layout
21633 \begin_layout Description
21634 \begin_inset Flex Code
21637 \begin_layout Plain Layout
21644 \begin_inset Flex Code
21647 \begin_layout Plain Layout
21657 ] Marks this style as the one to be used to generate the
21658 \begin_inset Flex Code
21661 \begin_layout Plain Layout
21667 tag for the XHTML file.
21668 By default, it is false.
21670 \begin_inset Flex Code
21673 \begin_layout Plain Layout
21679 file sets it to true for the
21680 \begin_inset Flex Code
21683 \begin_layout Plain Layout
21693 \begin_layout Subsection
21697 \begin_layout Standard
21698 The XHTML output of insets can also be controlled by information in layout
21703 \begin_layout Plain Layout
21704 At present, this is true only for
21705 \begin_inset Quotes eld
21709 \begin_inset Quotes erd
21712 insets (insets you can type into) and is not true for
21713 \begin_inset Quotes eld
21717 \begin_inset Quotes erd
21720 insets (insets that are associated with dialog boxes).
21725 Here, too, \SpecialChar LyX
21726 tries to provide sensible defaults, and it constructs default
21728 But everything can be customized.
21731 \begin_layout Standard
21732 The XHTML \SpecialChar LyX
21733 outputs for an inset has the following form:
21736 \begin_layout LyX-Code
21738 \begin_inset Quotes erd
21742 \begin_inset Quotes erd
21748 \begin_layout LyX-Code
21749 <labeltag>Label</labeltag>
21752 \begin_layout LyX-Code
21754 \begin_inset Quotes erd
21758 \begin_inset Quotes erd
21761 >Contents of the inset.</innertag>
21764 \begin_layout LyX-Code
21768 \begin_layout Standard
21769 If the inset permits multiple paragraphs—that is, if
21770 \begin_inset Flex Code
21773 \begin_layout Plain Layout
21779 is true—then the contents of the inset will itself be output as paragraphs
21780 formatted according to the styles used for those paragraphs (standard,
21781 quote, and the like).
21782 The label tag is of course omitted if the paragraph does not have a label
21783 and, at present, is always
21784 \begin_inset Flex Code
21787 \begin_layout Plain Layout
21794 The inner tag is optional and, by default, does not appear.
21797 \begin_layout Standard
21798 The specific tags and attributes output for each inset can be controlled
21799 by means of the following layout tags.
21802 \begin_layout Description
21803 \begin_inset Flex Code
21806 \begin_layout Plain Layout
21813 \begin_inset Flex Code
21816 \begin_layout Plain Layout
21822 ] Specifies attribute information to be output with the main tag.
21824 \begin_inset Quotes eld
21828 \begin_inset Flex Code
21831 \begin_layout Plain Layout
21832 class=`myinset' onclick=`\SpecialChar ldots
21839 \begin_inset Quotes erd
21843 By default, \SpecialChar LyX
21845 \begin_inset Quotes eld
21849 \begin_inset Flex Code
21852 \begin_layout Plain Layout
21859 \begin_inset Quotes erd
21863 \begin_inset Flex Code
21866 \begin_layout Plain Layout
21872 is the \SpecialChar LyX
21873 name of the inset, made lowercase and with non-alphanumeric characters
21874 converted to underscores, for example: footnote.
21877 \begin_layout Description
21878 \begin_inset Flex Code
21881 \begin_layout Plain Layout
21888 \begin_inset Flex Code
21891 \begin_layout Plain Layout
21901 ] Whether to output the default CSS information \SpecialChar LyX
21902 generates for this layout,
21903 even if additional information is explicitly provided via
21904 \begin_inset Flex Code
21907 \begin_layout Plain Layout
21915 \begin_inset Flex Code
21918 \begin_layout Plain Layout
21924 allows you to alter or augment the generated CSS, rather than to override
21929 \begin_layout Description
21930 \begin_inset Flex Code
21933 \begin_layout Plain Layout
21940 \begin_inset Flex Code
21943 \begin_layout Plain Layout
21949 ] Attributes for the inner tag.
21951 \begin_inset Quotes eld
21955 \begin_inset Flex Code
21958 \begin_layout Plain Layout
21959 class=`insetname_inner'
21965 \begin_inset Quotes erd
21971 \begin_layout Description
21972 \begin_inset Flex Code
21975 \begin_layout Plain Layout
21982 \begin_inset Flex Code
21985 \begin_layout Plain Layout
21991 ] The inner tag, replacing
21992 \begin_inset Flex Code
21995 \begin_layout Plain Layout
22001 in the examples above.
22002 By default, there is none.
22005 \begin_layout Description
22006 \begin_inset Flex Code
22009 \begin_layout Plain Layout
22016 \begin_inset Flex Code
22019 \begin_layout Plain Layout
22027 ] Whether this inset represents a standalone block of text (such as a footnote)
22028 or instead represents material that is included in the surrounding text
22029 (such as a branch).
22033 \begin_layout Description
22034 \begin_inset Flex Code
22037 \begin_layout Plain Layout
22044 \begin_inset Flex Code
22047 \begin_layout Plain Layout
22053 ] A label for this inset, possibly including a reference to a counter.
22054 For example, for footnote, it might be:
22055 \begin_inset Flex Code
22058 \begin_layout Plain Layout
22067 This is optional, and there is no default.
22070 \begin_layout Description
22071 \begin_inset Flex Code
22074 \begin_layout Plain Layout
22080 Information to be output in the
22081 \begin_inset Flex Code
22084 \begin_layout Plain Layout
22090 section when this style is used.
22091 This might, for example, be used to include a
22092 \begin_inset Flex Code
22095 \begin_layout Plain Layout
22102 \begin_inset Flex Code
22105 \begin_layout Plain Layout
22114 \begin_layout Description
22115 \begin_inset Flex Code
22118 \begin_layout Plain Layout
22124 CSS style information to be included when this style is used.
22125 Note that this will automatically be wrapped in a layout-generated
22126 \begin_inset Flex Code
22129 \begin_layout Plain Layout
22135 block, so only the CSS itself need be included.
22138 \begin_layout Description
22139 \begin_inset Flex Code
22142 \begin_layout Plain Layout
22149 \begin_inset Flex Code
22152 \begin_layout Plain Layout
22158 ] The tag to be used for the main label, replacing
22159 \begin_inset Flex Code
22162 \begin_layout Plain Layout
22168 in the examples above.
22169 The default depends upon the setting of
22170 \begin_inset Flex Code
22173 \begin_layout Plain Layout
22180 \begin_inset Flex Code
22183 \begin_layout Plain Layout
22189 is true, the default is
22190 \begin_inset Flex Code
22193 \begin_layout Plain Layout
22199 ; if it is false, the default is
22200 \begin_inset Flex Code
22203 \begin_layout Plain Layout
22212 \begin_layout Subsection
22216 \begin_layout Standard
22217 The XHTML output for floats too can be controlled by layout information.
22218 The output has the following form:
22221 \begin_layout LyX-Code
22223 \begin_inset Quotes erd
22227 \begin_inset Quotes erd
22233 \begin_layout LyX-Code
22234 Contents of the float.
22237 \begin_layout LyX-Code
22241 \begin_layout Standard
22242 The caption, if there is one, is a separate inset and will be output as
22244 Its appearance can be controlled via the InsetLayout for caption insets.
22248 \begin_layout Description
22249 \begin_inset Flex Code
22252 \begin_layout Plain Layout
22259 \begin_inset Flex Code
22262 \begin_layout Plain Layout
22268 ] Specifies attribute information to be output with the main tag.
22270 \begin_inset Quotes eld
22274 \begin_inset Flex Code
22277 \begin_layout Plain Layout
22278 class=`myfloat' onclick=`\SpecialChar ldots
22285 \begin_inset Quotes erd
22289 By default, \SpecialChar LyX
22291 \begin_inset Quotes eld
22295 \begin_inset Flex Code
22298 \begin_layout Plain Layout
22299 class=`float float-floattype'
22305 \begin_inset Quotes erd
22309 \begin_inset Flex Code
22312 \begin_layout Plain Layout
22318 is \SpecialChar LyX
22319 's name for this type of float, as determined by the float declaration
22321 \begin_inset CommandInset ref
22323 reference "subsec:Floats"
22327 ), though made lowercase and with non-alphanumeric characters converted
22328 to underscores, for example: float-table.
22331 \begin_layout Description
22332 \begin_inset Flex Code
22335 \begin_layout Plain Layout
22341 CSS style information to be included when this float is used.
22342 Note that this will automatically be wrapped in a layout-generated
22343 \begin_inset Flex Code
22346 \begin_layout Plain Layout
22352 block, so only the CSS itself need be included.
22355 \begin_layout Description
22356 \begin_inset Flex Code
22359 \begin_layout Plain Layout
22366 \begin_inset Flex Code
22369 \begin_layout Plain Layout
22375 ] The tag to be used for this float, replacing
22376 \begin_inset Quotes eld
22380 \begin_inset Flex Code
22383 \begin_layout Plain Layout
22390 \begin_inset Quotes erd
22393 in the example above.
22395 \begin_inset Flex Code
22398 \begin_layout Plain Layout
22404 and will rarely need changing.
22407 \begin_layout Subsection
22408 Bibliography formatting
22411 \begin_layout Standard
22412 The bibliography can be formatted using
22413 \begin_inset Flex Code
22416 \begin_layout Plain Layout
22424 \begin_inset CommandInset ref
22426 reference "subsec:Citation-format-description"
22433 \begin_layout Subsection
22438 \begin_layout Standard
22439 We have several times mentioned that \SpecialChar LyX
22440 will generate default CSS style rules
22441 for both insets and paragraph styles, based upon the other layout information
22443 In this section, we shall say a word about which layout information \SpecialChar LyX
22448 \begin_layout Standard
22449 At present, \SpecialChar LyX
22450 auto-generates CSS only for font information, making use of
22452 \begin_inset Flex Code
22455 \begin_layout Plain Layout
22462 \begin_inset Flex Code
22465 \begin_layout Plain Layout
22472 \begin_inset Flex Code
22475 \begin_layout Plain Layout
22482 \begin_inset Flex Code
22485 \begin_layout Plain Layout
22492 \begin_inset Flex Code
22495 \begin_layout Plain Layout
22502 \begin_inset CommandInset ref
22504 reference "subsec:Font-description"
22509 The translation is mostly straightforward and obvious.
22511 \begin_inset Quotes eld
22515 \begin_inset Flex Code
22518 \begin_layout Plain Layout
22525 \begin_inset Quotes erd
22529 \begin_inset Quotes eld
22533 \begin_inset Flex Code
22536 \begin_layout Plain Layout
22537 font-family: sans-serif;
22543 \begin_inset Quotes erd
22547 The correspondence of \SpecialChar LyX
22548 sizes and CSS sizes is a little less obvious but
22549 nonetheless intuitive.
22551 \begin_inset Flex Code
22554 \begin_layout Plain Layout
22561 \begin_inset Flex URL
22564 \begin_layout Plain Layout
22574 \begin_layout Chapter
22575 Including External Material
22576 \begin_inset CommandInset label
22578 name "chap:Including-External-Material"
22585 \begin_layout Standard
22586 \begin_inset Box Shadowbox
22596 height_special "totalheight"
22601 backgroundcolor "none"
22604 \begin_layout Plain Layout
22605 WARNING: This portion of the documentation has not been updated for some
22607 We certainly hope that it is still accurate, but there are no guarantees.
22615 \begin_layout Standard
22616 The use of material from sources external to \SpecialChar LyX
22617 is covered in detail in the
22623 This part of the manual covers what needs to happen behind the scenes for
22624 new sorts of material to be included.
22627 \begin_layout Section
22631 \begin_layout Standard
22632 The external material feature is based on the concept of a
22637 A template is a specification of how \SpecialChar LyX
22638 should interface with a certain kind
22640 As bundled, \SpecialChar LyX
22641 comes with predefined templates for Xfig figures, various
22642 raster format images, chess diagrams, and LilyPond music notation.
22643 You can check the actual list by using the menu
22644 \begin_inset Flex MenuItem
22647 \begin_layout Plain Layout
22648 Insert\SpecialChar menuseparator
22649 File\SpecialChar menuseparator
22656 Furthermore, it is possible to roll your own template to support a specific
22658 Later we'll describe in more detail what is involved, and hopefully you
22659 will submit all the templates you create so we can include them in a later
22664 \begin_layout Standard
22665 Another basic idea of the external material feature is to distinguish between
22666 the original file that serves as a base for final material and the produced
22667 file that is included in your exported or printed document.
22668 For example, consider the case of a figure produced with
22669 \begin_inset Flex Code
22672 \begin_layout Plain Layout
22679 The Xfig application itself works on an original file with the
22680 \begin_inset Flex Code
22683 \begin_layout Plain Layout
22690 Within Xfig, you create and change your figure, and when you are done,
22692 \begin_inset Flex Code
22695 \begin_layout Plain Layout
22702 When you want to include the figure in your document, you invoke
22703 \begin_inset Flex Code
22706 \begin_layout Plain Layout
22712 in order to create a PostScript file that can readily be included in your
22716 \begin_inset Flex Code
22719 \begin_layout Plain Layout
22725 file is the original file, and the PostScript file is the produced file.
22728 \begin_layout Standard
22729 This distinction is important in order to allow updating of the material
22730 while you are in the process of writing the document.
22731 Furthermore, it provides us with the flexibility that is needed to support
22732 multiple export formats.
22733 For instance, in the case of a plain text file, it is not exactly an award-winn
22734 ing idea to include the figure as raw PostScript.
22735 Instead, you would either prefer to just include a reference to the figure
22736 or try to invoke some graphics to ASCII converter to make the final result
22737 look similar to the real graphics.
22738 The external material management allows you to do this, because it is parametri
22739 zed on the different export formats that \SpecialChar LyX
22743 \begin_layout Standard
22744 Besides supporting the production of different products according to the
22745 exported format, it supports tight integration with editing and viewing
22747 In the case of an Xfig figure, you are able to invoke Xfig on the original
22748 file with a single click from within the external material dialog in \SpecialChar LyX
22750 and also preview the produced PostScript file with Ghostview with another
22752 No more fiddling around with the command line and/or file browsers to locate
22753 and manipulate the original or produced files.
22754 In this way, you are finally able to take full advantage of the many different
22755 applications that are relevant to use when you write your documents, and
22756 ultimately be more productive.
22759 \begin_layout Section
22760 The external template configuration file
22763 \begin_layout Standard
22764 It is relatively easy to add custom external template definitions to \SpecialChar LyX
22766 However, be aware that doing this in an careless manner most probably
22770 introduce an easily exploitable security hole.
22771 So before you do this, please read the discussion about security in
22772 \begin_inset CommandInset ref
22774 reference "sec:Security-discussion"
22781 \begin_layout Standard
22782 Having said that, we encourage you to submit any interesting templates that
22787 \begin_layout Standard
22788 The external templates are defined in the
22789 \begin_inset Flex Code
22792 \begin_layout Plain Layout
22793 LyXDir/lib/external_templates
22799 You can place your own version in
22800 \begin_inset Flex Code
22803 \begin_layout Plain Layout
22804 UserDir/external_templates
22812 \begin_layout Standard
22813 A typical template looks like this:
22816 \begin_layout LyX-Code
22820 \begin_layout LyX-Code
22821 GuiName "XFig: $$AbsOrRelPathParent$$Basename"
22824 \begin_layout LyX-Code
22828 \begin_layout LyX-Code
22832 \begin_layout LyX-Code
22836 \begin_layout LyX-Code
22840 \begin_layout LyX-Code
22844 \begin_layout LyX-Code
22845 AutomaticProduction true
22848 \begin_layout LyX-Code
22852 \begin_layout LyX-Code
22856 \begin_layout LyX-Code
22857 Format \SpecialChar LaTeX
22861 \begin_layout LyX-Code
22862 TransformCommand Rotate RotationLatexCommand
22865 \begin_layout LyX-Code
22866 TransformCommand Resize ResizeLatexCommand
22869 \begin_layout LyX-Code
22870 Product "$$RotateFront$$ResizeFront
22873 \begin_layout LyX-Code
22878 input{$$AbsOrRelPathMaster$$Basename.pstex_t}
22881 \begin_layout LyX-Code
22882 $$ResizeBack$$RotateBack"
22885 \begin_layout LyX-Code
22889 \begin_layout LyX-Code
22890 UpdateResult "$$AbsPath$$Basename.pstex_t"
22893 \begin_layout LyX-Code
22894 Requirement "graphicx"
22897 \begin_layout LyX-Code
22898 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
22901 \begin_layout LyX-Code
22902 ReferencedFile latex "$$AbsPath$$Basename.eps"
22905 \begin_layout LyX-Code
22906 ReferencedFile dvi "$$AbsPath$$Basename.eps"
22909 \begin_layout LyX-Code
22913 \begin_layout LyX-Code
22914 Format PDF\SpecialChar LaTeX
22918 \begin_layout LyX-Code
22919 TransformCommand Rotate RotationLatexCommand
22922 \begin_layout LyX-Code
22923 TransformCommand Resize ResizeLatexCommand
22926 \begin_layout LyX-Code
22927 Product "$$RotateFront$$ResizeFront
22930 \begin_layout LyX-Code
22935 input{$$AbsOrRelPathMaster$$Basename.pdftex_t}
22938 \begin_layout LyX-Code
22939 $$ResizeBack$$RotateBack"
22942 \begin_layout LyX-Code
22943 UpdateFormat pdftex
22946 \begin_layout LyX-Code
22947 UpdateResult "$$AbsPath$$Basename.pdftex_t"
22950 \begin_layout LyX-Code
22951 Requirement "graphicx"
22954 \begin_layout LyX-Code
22955 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pdftex_t"
22958 \begin_layout LyX-Code
22959 ReferencedFile latex "$$AbsPath$$Basename.pdf"
22962 \begin_layout LyX-Code
22966 \begin_layout LyX-Code
22970 \begin_layout LyX-Code
22971 Product "$$Contents(
22973 "$$AbsPath$$Basename.asc
22978 \begin_layout LyX-Code
22979 UpdateFormat asciixfig
22982 \begin_layout LyX-Code
22983 UpdateResult "$$AbsPath$$Basename.asc"
22986 \begin_layout LyX-Code
22990 \begin_layout LyX-Code
22994 \begin_layout LyX-Code
22995 Product "<graphic fileref=
22997 "$$AbsOrRelPathMaster$$Basename.eps
23002 \begin_layout LyX-Code
23006 \begin_layout LyX-Code
23010 \begin_layout LyX-Code
23011 UpdateResult "$$AbsPath$$Basename.eps"
23014 \begin_layout LyX-Code
23015 ReferencedFile docbook "$$AbsPath$$Basename.eps"
23018 \begin_layout LyX-Code
23019 ReferencedFile docbook-xml "$$AbsPath$$Basename.eps"
23022 \begin_layout LyX-Code
23026 \begin_layout LyX-Code
23027 Product "[XFig: $$FName]"
23030 \begin_layout LyX-Code
23034 \begin_layout LyX-Code
23038 \begin_layout Standard
23039 As you can see, the template is enclosed in
23040 \begin_inset Flex Code
23043 \begin_layout Plain Layout
23051 \begin_inset Flex Code
23054 \begin_layout Plain Layout
23061 It contains a header specifying some general settings and, for each supported
23062 primary document file format, a section
23063 \begin_inset Flex Code
23066 \begin_layout Plain Layout
23074 \begin_inset Flex Code
23077 \begin_layout Plain Layout
23086 \begin_layout Subsection
23087 The template header
23090 \begin_layout Description
23091 \begin_inset Flex Code
23094 \begin_layout Plain Layout
23095 AutomaticProduction
23096 \begin_inset space ~
23104 Whether the file represented by the template must be generated by \SpecialChar LyX
23106 This command must occur exactly once.
23109 \begin_layout Description
23110 \begin_inset Flex Code
23113 \begin_layout Plain Layout
23115 \begin_inset space ~
23123 A glob pattern that is used in the file dialog to filter out the desired
23125 If there is more than one possible file extension (e.
23126 \begin_inset space \thinspace{}
23130 \begin_inset space \space{}
23134 \begin_inset Flex Code
23137 \begin_layout Plain Layout
23144 \begin_inset Flex Code
23147 \begin_layout Plain Layout
23153 ), use something like
23154 \begin_inset Flex Code
23157 \begin_layout Plain Layout
23164 This command must occur exactly once.
23167 \begin_layout Description
23168 \begin_inset Flex Code
23171 \begin_layout Plain Layout
23173 \begin_inset space ~
23181 The text that is displayed on the button.
23182 This command must occur exactly once.
23185 \begin_layout Description
23186 \begin_inset Flex Code
23189 \begin_layout Plain Layout
23191 \begin_inset space ~
23195 \begin_inset space ~
23203 The help text that is used in the External dialog.
23204 Provide enough information to explain to the user just what the template
23205 can provide him with.
23206 This command must occur exactly once.
23209 \begin_layout Description
23210 \begin_inset Flex Code
23213 \begin_layout Plain Layout
23215 \begin_inset space ~
23223 The file format of the original file.
23224 This must be the name of a format that is known to \SpecialChar LyX
23226 \begin_inset CommandInset ref
23228 reference "sec:Formats"
23234 \begin_inset Quotes eld
23238 \begin_inset Flex Code
23241 \begin_layout Plain Layout
23248 \begin_inset Quotes erd
23251 if the template can handle original files of more than one format.
23253 will attempt to interrogate the file itself in order to deduce its format
23255 This command must occur exactly once.
23258 \begin_layout Description
23259 \begin_inset Flex Code
23262 \begin_layout Plain Layout
23264 \begin_inset space ~
23272 A unique name for the template.
23273 It must not contain substitution macros (see below).
23276 \begin_layout Description
23277 \begin_inset Flex Code
23280 \begin_layout Plain Layout
23282 \begin_inset space ~
23285 Rotate|Resize|Clip|Extra
23290 This command specifies which transformations are supported by this template.
23291 It may occur zero or more times.
23292 This command enables the corresponding tabs in the external dialog.
23294 \begin_inset Flex Code
23297 \begin_layout Plain Layout
23303 command must have either a corresponding
23304 \begin_inset Flex Code
23307 \begin_layout Plain Layout
23314 \begin_inset Flex Code
23317 \begin_layout Plain Layout
23324 \begin_inset Flex Code
23327 \begin_layout Plain Layout
23334 Otherwise the transformation will not be supported by that format.
23337 \begin_layout Subsection
23341 \begin_layout Description
23342 \begin_inset Flex Code
23345 \begin_layout Plain Layout
23347 \begin_inset space ~
23350 LaTeX|PDFLaTeX|PlainText|DocBook
23355 The primary document file format that this format definition is for.
23356 Not every template has a sensible representation in all document file formats.
23357 Please define nevertheless a
23358 \begin_inset Flex Code
23361 \begin_layout Plain Layout
23367 section for all templates.
23368 Use a dummy text when no representation is available.
23369 Then you can at least see a reference to the external material in the exported
23373 \begin_layout Description
23374 \begin_inset Flex Code
23377 \begin_layout Plain Layout
23379 \begin_inset space ~
23383 \begin_inset space ~
23391 This command defines an additional macro
23392 \begin_inset Flex Code
23395 \begin_layout Plain Layout
23401 for substitution in
23402 \begin_inset Flex Code
23405 \begin_layout Plain Layout
23413 \begin_inset Flex Code
23416 \begin_layout Plain Layout
23422 itself may contain substitution macros.
23423 The advantage over using
23424 \begin_inset Flex Code
23427 \begin_layout Plain Layout
23434 \begin_inset Flex Code
23437 \begin_layout Plain Layout
23443 is that the substituted value of
23444 \begin_inset Flex Code
23447 \begin_layout Plain Layout
23453 is sanitized so that it is a valid optional argument in the document format.
23454 This command may occur zero or more times.
23457 \begin_layout Description
23458 \begin_inset Flex Code
23461 \begin_layout Plain Layout
23463 \begin_inset space ~
23471 The text that is inserted in the exported document.
23472 This is actually the most important command and can be quite complex.
23473 This command must occur exactly once.
23476 \begin_layout Description
23477 \begin_inset Flex Code
23480 \begin_layout Plain Layout
23482 \begin_inset space ~
23490 This command specifies a preamble snippet that will be included in the
23493 It has to be defined using
23494 \begin_inset Flex Code
23497 \begin_layout Plain Layout
23505 \begin_inset Flex Code
23508 \begin_layout Plain Layout
23515 This command may occur zero or more times.
23518 \begin_layout Description
23519 \begin_inset Flex Code
23522 \begin_layout Plain Layout
23524 \begin_inset space ~
23528 \begin_inset space ~
23536 This command denotes files that are created by the conversion process and
23537 are needed for a particular export format.
23538 If the filename is relative, it is interpreted relative to the master document.
23539 This command may be given zero or more times.
23542 \begin_layout Description
23543 \begin_inset Flex Code
23546 \begin_layout Plain Layout
23548 \begin_inset space ~
23556 The name of a required \SpecialChar LaTeX
23558 The package is included via
23559 \begin_inset Flex Code
23562 \begin_layout Plain Layout
23570 in the \SpecialChar LaTeX
23572 This command may occur zero or more times.
23575 \begin_layout Description
23576 \begin_inset Flex Code
23579 \begin_layout Plain Layout
23581 \begin_inset space ~
23585 \begin_inset space ~
23588 RotationLatexCommand
23593 This command specifies that the built in \SpecialChar LaTeX
23594 command should be used for rotation.
23595 This command may occur once or not at all.
23598 \begin_layout Description
23599 \begin_inset Flex Code
23602 \begin_layout Plain Layout
23604 \begin_inset space ~
23608 \begin_inset space ~
23616 This command specifies that the built in \SpecialChar LaTeX
23617 command should be used for resizing.
23618 This command may occur once or not at all.
23621 \begin_layout Description
23622 \begin_inset Flex Code
23625 \begin_layout Plain Layout
23627 \begin_inset space ~
23631 \begin_inset space ~
23634 RotationLatexOption
23639 This command specifies that rotation is done via an optional argument.
23640 This command may occur once or not at all.
23643 \begin_layout Description
23644 \begin_inset Flex Code
23647 \begin_layout Plain Layout
23649 \begin_inset space ~
23653 \begin_inset space ~
23661 This command specifies that resizing is done via an optional argument.
23662 This command may occur once or not at all.
23665 \begin_layout Description
23666 \begin_inset Flex Code
23669 \begin_layout Plain Layout
23671 \begin_inset space ~
23675 \begin_inset space ~
23683 This command specifies that clipping is done via an optional argument.
23684 This command may occur once or not at all.
23687 \begin_layout Description
23688 \begin_inset Flex Code
23691 \begin_layout Plain Layout
23693 \begin_inset space ~
23697 \begin_inset space ~
23705 This command specifies that an extra optional argument is used.
23706 This command may occur once or not at all.
23709 \begin_layout Description
23710 \begin_inset Flex Code
23713 \begin_layout Plain Layout
23715 \begin_inset space ~
23723 The file format of the converted file.
23724 This must be the name of a format that is known to \SpecialChar LyX
23726 \begin_inset Flex MenuItem
23729 \begin_layout Plain Layout
23730 Tools\SpecialChar menuseparator
23731 Preferences\SpecialChar menuseparator
23732 File Handling\SpecialChar menuseparator
23739 This command must occur exactly once.
23740 If the resulting file format is PDF, you need to specify the format
23741 \begin_inset Flex Code
23744 \begin_layout Plain Layout
23751 This is the PDF format used for including graphics.
23752 The other defined PDF formats are for document export.
23755 \begin_layout Description
23756 \begin_inset Flex Code
23759 \begin_layout Plain Layout
23761 \begin_inset space ~
23769 The file name of the converted file.
23770 The file name must be absolute.
23771 This command must occur exactly once.
23774 \begin_layout Subsection
23775 Preamble definitions
23778 \begin_layout Standard
23779 The external template configuration file may contain additional preamble
23780 definitions enclosed by
23781 \begin_inset Flex Code
23784 \begin_layout Plain Layout
23792 \begin_inset Flex Code
23795 \begin_layout Plain Layout
23802 They can be used by the templates in the
23803 \begin_inset Flex Code
23806 \begin_layout Plain Layout
23815 \begin_layout Section
23816 The substitution mechanism
23819 \begin_layout Standard
23820 When the external material facility invokes an external program, it is done
23821 on the basis of a command defined in the template configuration file.
23822 These commands can contain various macros that are expanded before execution.
23823 Execution always take place in the directory of the containing document.
23826 \begin_layout Standard
23827 Also, whenever external material is to be displayed, the name will be produced
23828 by the substitution mechanism, and most other commands in the template
23829 definition support substitution as well.
23832 \begin_layout Standard
23833 The available macros are the following:
23836 \begin_layout Description
23837 \begin_inset Flex Code
23840 \begin_layout Plain Layout
23841 $$AbsOrRelPathMaster
23846 The file path, absolute or relative to the master \SpecialChar LyX
23850 \begin_layout Description
23851 \begin_inset Flex Code
23854 \begin_layout Plain Layout
23855 $$AbsOrRelPathParent
23860 The file path, absolute or relative to the \SpecialChar LyX
23864 \begin_layout Description
23865 \begin_inset Flex Code
23868 \begin_layout Plain Layout
23874 The absolute file path.
23877 \begin_layout Description
23878 \begin_inset Flex Code
23881 \begin_layout Plain Layout
23887 The filename without path and without the extension.
23890 \begin_layout Description
23891 \begin_inset Flex Code
23894 \begin_layout Plain Layout
23896 \begin_inset Quotes eld
23900 \begin_inset Quotes erd
23908 This macro will expand to the contents of the file with the name
23909 \begin_inset Flex Code
23912 \begin_layout Plain Layout
23921 \begin_layout Description
23922 \begin_inset Flex Code
23925 \begin_layout Plain Layout
23931 The file extension (including the dot).
23932 \change_inserted -195340706 1437418878
23936 \begin_layout Description
23938 \change_inserted -195340706 1437418878
23939 \begin_inset Flex Code
23942 \begin_layout Plain Layout
23944 \change_inserted -195340706 1437418878
23950 This will be the string
23951 \begin_inset Quotes eld
23955 \begin_inset Quotes erd
23958 if the file is in JPEG format, otherwise it will be the string
23959 \begin_inset Quotes eld
23963 \begin_inset Quotes erd
23967 This is useful to avoid uneeded conversions for output formats that support
23968 both PNG and JPEG fomats.
23969 The predefined RasterImage template uses this macro for the PDFL
23970 \change_deleted -712698321 1437634446
23972 \change_inserted -712698321 1437634446
23974 \change_inserted -195340706 1437418878
23980 \begin_layout Description
23981 \begin_inset Flex Code
23984 \begin_layout Plain Layout
23990 The filename of the file specified in the external material dialog.
23991 This is either an absolute name, or it is relative to the \SpecialChar LyX
23995 \begin_layout Description
23996 \begin_inset Flex Code
23999 \begin_layout Plain Layout
24006 \begin_inset Flex Code
24009 \begin_layout Plain Layout
24015 (absolute name or relative to the \SpecialChar LyX
24019 \begin_layout Description
24020 \begin_inset Flex Code
24023 \begin_layout Plain Layout
24029 The file path, relative to the master \SpecialChar LyX
24033 \begin_layout Description
24034 \begin_inset Flex Code
24037 \begin_layout Plain Layout
24043 The file path, relative to the \SpecialChar LyX
24047 \begin_layout Description
24048 \begin_inset Flex Code
24051 \begin_layout Plain Layout
24057 This macro will expand to the absolute path of the system directory.
24058 This is typically used to point to the various helper scripts that are
24059 bundled with \SpecialChar LyX
24063 \begin_layout Description
24064 \begin_inset Flex Code
24067 \begin_layout Plain Layout
24073 A name and full path to a temporary file which will be automatically deleted
24074 whenever the containing document is closed, or the external material insertion
24078 \begin_layout Standard
24079 All path macros contain a trailing directory separator, so you can construct
24081 \begin_inset space \thinspace{}
24085 \begin_inset space \space{}
24088 the absolute filename with
24089 \begin_inset Flex Code
24092 \begin_layout Plain Layout
24093 $$AbsPath$$Basename$$Extension
24101 \begin_layout Standard
24102 The macros above are substituted in all commands unless otherwise noted.
24104 \begin_inset Flex Code
24107 \begin_layout Plain Layout
24113 supports additionally the following substitutions if they are enabled by
24115 \begin_inset Flex Code
24118 \begin_layout Plain Layout
24125 \begin_inset Flex Code
24128 \begin_layout Plain Layout
24137 \begin_layout Description
24138 \begin_inset Flex Code
24141 \begin_layout Plain Layout
24147 The front part of the resize command.
24150 \begin_layout Description
24151 \begin_inset Flex Code
24154 \begin_layout Plain Layout
24160 The back part of the resize command.
24163 \begin_layout Description
24164 \begin_inset Flex Code
24167 \begin_layout Plain Layout
24173 The front part of the rotation command.
24176 \begin_layout Description
24177 \begin_inset Flex Code
24180 \begin_layout Plain Layout
24186 The back part of the rotation command.
24189 \begin_layout Standard
24190 The value string of the
24191 \begin_inset Flex Code
24194 \begin_layout Plain Layout
24200 command supports additionally the following substitutions if they are enabled
24202 \begin_inset Flex Code
24205 \begin_layout Plain Layout
24212 \begin_inset Flex Code
24215 \begin_layout Plain Layout
24224 \begin_layout Description
24225 \begin_inset Flex Code
24228 \begin_layout Plain Layout
24237 \begin_layout Description
24238 \begin_inset Flex Code
24241 \begin_layout Plain Layout
24250 \begin_layout Description
24251 \begin_inset Flex Code
24254 \begin_layout Plain Layout
24263 \begin_layout Description
24264 \begin_inset Flex Code
24267 \begin_layout Plain Layout
24273 The rotation option.
24276 \begin_layout Standard
24277 You may ask why there are so many path macros.
24278 There are mainly two reasons:
24281 \begin_layout Enumerate
24282 Relative and absolute file names should remain relative or absolute, respectivel
24284 Users may have reasons to prefer either form.
24285 Relative names are useful for portable documents that should work on different
24286 machines, for example.
24287 Absolute names may be required by some programs.
24290 \begin_layout Enumerate
24292 treats relative file names differently than \SpecialChar LyX
24293 and other programs in nested
24295 For \SpecialChar LyX
24296 , a relative file name is always relative to the document that contains
24298 For \SpecialChar LaTeX
24299 , it is always relative to the master document.
24300 These two definitions are identical if you have only one document, but
24301 differ if you have a master document that includes part documents.
24302 That means that relative filenames must be transformed when presented to
24305 Fortunately \SpecialChar LyX
24306 does this automatically for you if you choose the right macros.
24309 \begin_layout Standard
24310 So which path macro should be used in new template definitions? The rule
24314 \begin_layout Itemize
24316 \begin_inset Flex Code
24319 \begin_layout Plain Layout
24325 if an absolute path is required.
24328 \begin_layout Itemize
24330 \begin_inset Flex Code
24333 \begin_layout Plain Layout
24334 $$AbsOrRelPathMaster
24339 if the substituted string is some kind of \SpecialChar LaTeX
24343 \begin_layout Itemize
24345 \begin_inset Flex Code
24348 \begin_layout Plain Layout
24349 $$AbsOrRelPathParent
24354 in order to preserve the user's choice.
24357 \begin_layout Standard
24358 There are special cases where this rule does not work and e.
24359 \begin_inset space \thinspace{}
24363 \begin_inset space \space{}
24366 relative names are needed, but normally it will work just fine.
24367 One example for such a case is the command
24368 \begin_inset Flex Code
24371 \begin_layout Plain Layout
24372 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
24377 in the XFig template above: We can't use the absolute name because the
24379 \begin_inset Flex Code
24382 \begin_layout Plain Layout
24388 files needs the relative name in order to rewrite the file content.
24391 \begin_layout Section
24392 Security discussion
24393 \begin_inset CommandInset label
24395 name "sec:Security-discussion"
24402 \begin_layout Standard
24403 The external material feature interfaces with a lot of external programs
24404 and does so automatically, so we have to consider the security implications
24406 In particular, since you have the option of including your own filenames
24407 and/or parameter strings and those are expanded into a command, it seems
24408 that it would be possible to create a malicious document which executes
24409 arbitrary commands when a user views or prints the document.
24410 This is something we definitely want to avoid.
24413 \begin_layout Standard
24414 However, since the external program commands are specified in the template
24415 configuration file only, there are no security issues if \SpecialChar LyX
24416 is properly configure
24417 d with safe templates only.
24418 This is so because the external programs are invoked with the
24419 \begin_inset Flex Code
24422 \begin_layout Plain Layout
24428 -system call rather than the
24429 \begin_inset Flex Code
24432 \begin_layout Plain Layout
24438 system-call, so it's not possible to execute arbitrary commands from the
24439 filename or parameter section via the shell.
24442 \begin_layout Standard
24443 This also implies that you are restricted in what command strings you can
24444 use in the external material templates.
24445 In particular, pipes and redirection are not readily available.
24446 This has to be so if \SpecialChar LyX
24447 should remain safe.
24448 If you want to use some of the shell features, you should write a safe
24449 script to do this in a controlled manner, and then invoke the script from
24450 the command string.
24454 \begin_layout Standard
24455 It is possible to design a template that interacts directly with the shell,
24456 but since this would allow a malicious user to execute arbitrary commands
24457 by writing clever filenames and/or parameters, we generally recommend that
24458 you only use safe scripts that work with the
24459 \begin_inset Flex Code
24462 \begin_layout Plain Layout
24468 system call in a controlled manner.
24469 Of course, for use in a controlled environment, it can be tempting to just
24470 fall back to use ordinary shell scripts.
24471 If you do so, be aware that you
24475 provide an easily exploitable security hole in your system.
24476 Of course it stands to reason that such unsafe templates will never be
24477 included in the standard \SpecialChar LyX
24478 distribution, although we do encourage people
24479 to submit new templates in the open source tradition.
24480 But \SpecialChar LyX
24481 as shipped from the official distribution channels will never have
24485 \begin_layout Standard
24486 Including external material provides a lot of power, and you have to be
24487 careful not to introduce security hazards with this power.
24488 A subtle error in a single line in an innocent looking script can open
24489 the door to huge security problems.
24490 So if you do not fully understand the issues, we recommend that you consult
24491 a knowledgeable security professional or the \SpecialChar LyX
24492 development team if you have
24493 any questions about whether a given template is safe or not.
24494 And do this before you use it in an uncontrolled environment.
24497 \begin_layout Chapter
24499 List of supported \SpecialChar LyX
24500 functions to be used in layouts
24501 \begin_inset CommandInset label
24503 name "chap:List-of-functions"
24510 \begin_layout Standard
24512 \begin_inset Tabular
24513 <lyxtabular version="3" rows="11" columns="8">
24514 <features tabularvalignment="middle">
24515 <column alignment="left" valignment="top">
24516 <column alignment="left" valignment="top">
24517 <column alignment="left" valignment="top">
24518 <column alignment="left" valignment="top">
24519 <column alignment="left" valignment="top">
24520 <column alignment="left" valignment="top">
24521 <column alignment="left" valignment="top">
24522 <column alignment="left" valignment="top">
24524 <cell alignment="left" valignment="top" usebox="none">
24527 \begin_layout Plain Layout
24533 <cell alignment="left" valignment="top" usebox="none">
24536 \begin_layout Plain Layout
24542 <cell alignment="left" valignment="top" usebox="none">
24545 \begin_layout Plain Layout
24551 <cell alignment="left" valignment="top" usebox="none">
24554 \begin_layout Plain Layout
24560 <cell alignment="center" valignment="top" usebox="none">
24563 \begin_layout Plain Layout
24569 <cell alignment="center" valignment="top" usebox="none">
24572 \begin_layout Plain Layout
24578 <cell alignment="center" valignment="top" usebox="none">
24581 \begin_layout Plain Layout
24587 <cell alignment="center" valignment="top" usebox="none">
24590 \begin_layout Plain Layout
24598 <cell alignment="left" valignment="top" usebox="none">
24601 \begin_layout Plain Layout
24607 <cell alignment="left" valignment="top" usebox="none">
24610 \begin_layout Plain Layout
24616 <cell alignment="left" valignment="top" usebox="none">
24619 \begin_layout Plain Layout
24625 <cell alignment="left" valignment="top" usebox="none">
24628 \begin_layout Plain Layout
24634 <cell alignment="center" valignment="top" usebox="none">
24637 \begin_layout Plain Layout
24643 <cell alignment="center" valignment="top" usebox="none">
24646 \begin_layout Plain Layout
24652 <cell alignment="center" valignment="top" usebox="none">
24655 \begin_layout Plain Layout
24661 <cell alignment="center" valignment="top" usebox="none">
24664 \begin_layout Plain Layout
24672 <cell alignment="left" valignment="top" usebox="none">
24675 \begin_layout Plain Layout
24681 <cell alignment="left" valignment="top" usebox="none">
24684 \begin_layout Plain Layout
24690 <cell alignment="left" valignment="top" usebox="none">
24693 \begin_layout Plain Layout
24699 <cell alignment="left" valignment="top" usebox="none">
24702 \begin_layout Plain Layout
24708 <cell alignment="center" valignment="top" usebox="none">
24711 \begin_layout Plain Layout
24717 <cell alignment="center" valignment="top" usebox="none">
24720 \begin_layout Plain Layout
24726 <cell alignment="center" valignment="top" usebox="none">
24729 \begin_layout Plain Layout
24735 <cell alignment="center" valignment="top" usebox="none">
24738 \begin_layout Plain Layout
24746 <cell alignment="left" valignment="top" usebox="none">
24749 \begin_layout Plain Layout
24755 <cell alignment="left" valignment="top" usebox="none">
24758 \begin_layout Plain Layout
24764 <cell alignment="left" valignment="top" usebox="none">
24767 \begin_layout Plain Layout
24773 <cell alignment="left" valignment="top" usebox="none">
24776 \begin_layout Plain Layout
24782 <cell alignment="center" valignment="top" usebox="none">
24785 \begin_layout Plain Layout
24791 <cell alignment="center" valignment="top" usebox="none">
24794 \begin_layout Plain Layout
24800 <cell alignment="center" valignment="top" usebox="none">
24803 \begin_layout Plain Layout
24809 <cell alignment="center" valignment="top" usebox="none">
24812 \begin_layout Plain Layout
24820 <cell alignment="left" valignment="top" usebox="none">
24823 \begin_layout Plain Layout
24829 <cell alignment="left" valignment="top" usebox="none">
24832 \begin_layout Plain Layout
24838 <cell alignment="left" valignment="top" usebox="none">
24841 \begin_layout Plain Layout
24847 <cell alignment="left" valignment="top" usebox="none">
24850 \begin_layout Plain Layout
24856 <cell alignment="center" valignment="top" usebox="none">
24859 \begin_layout Plain Layout
24865 <cell alignment="center" valignment="top" usebox="none">
24868 \begin_layout Plain Layout
24874 <cell alignment="center" valignment="top" usebox="none">
24877 \begin_layout Plain Layout
24883 <cell alignment="center" valignment="top" usebox="none">
24886 \begin_layout Plain Layout
24894 <cell alignment="left" valignment="top" usebox="none">
24897 \begin_layout Plain Layout
24903 <cell alignment="left" valignment="top" usebox="none">
24906 \begin_layout Plain Layout
24912 <cell alignment="left" valignment="top" usebox="none">
24915 \begin_layout Plain Layout
24921 <cell alignment="left" valignment="top" usebox="none">
24924 \begin_layout Plain Layout
24930 <cell alignment="center" valignment="top" usebox="none">
24933 \begin_layout Plain Layout
24939 <cell alignment="center" valignment="top" usebox="none">
24942 \begin_layout Plain Layout
24948 <cell alignment="center" valignment="top" usebox="none">
24951 \begin_layout Plain Layout
24957 <cell alignment="center" valignment="top" usebox="none">
24960 \begin_layout Plain Layout
24968 <cell alignment="left" valignment="top" usebox="none">
24971 \begin_layout Plain Layout
24977 <cell alignment="left" valignment="top" usebox="none">
24980 \begin_layout Plain Layout
24986 <cell alignment="left" valignment="top" usebox="none">
24989 \begin_layout Plain Layout
24995 <cell alignment="left" valignment="top" usebox="none">
24998 \begin_layout Plain Layout
25004 <cell alignment="center" valignment="top" usebox="none">
25007 \begin_layout Plain Layout
25013 <cell alignment="center" valignment="top" usebox="none">
25016 \begin_layout Plain Layout
25022 <cell alignment="center" valignment="top" usebox="none">
25025 \begin_layout Plain Layout
25031 <cell alignment="center" valignment="top" usebox="none">
25034 \begin_layout Plain Layout
25042 <cell alignment="left" valignment="top" usebox="none">
25045 \begin_layout Plain Layout
25051 <cell alignment="left" valignment="top" usebox="none">
25054 \begin_layout Plain Layout
25060 <cell alignment="left" valignment="top" usebox="none">
25063 \begin_layout Plain Layout
25069 <cell alignment="left" valignment="top" usebox="none">
25072 \begin_layout Plain Layout
25078 <cell alignment="center" valignment="top" usebox="none">
25081 \begin_layout Plain Layout
25087 <cell alignment="center" valignment="top" usebox="none">
25090 \begin_layout Plain Layout
25096 <cell alignment="center" valignment="top" usebox="none">
25099 \begin_layout Plain Layout
25105 <cell alignment="center" valignment="top" usebox="none">
25108 \begin_layout Plain Layout
25116 <cell alignment="left" valignment="top" usebox="none">
25119 \begin_layout Plain Layout
25125 <cell alignment="left" valignment="top" usebox="none">
25128 \begin_layout Plain Layout
25134 <cell alignment="left" valignment="top" usebox="none">
25137 \begin_layout Plain Layout
25143 <cell alignment="left" valignment="top" usebox="none">
25146 \begin_layout Plain Layout
25152 <cell alignment="center" valignment="top" usebox="none">
25155 \begin_layout Plain Layout
25161 <cell alignment="center" valignment="top" usebox="none">
25164 \begin_layout Plain Layout
25170 <cell alignment="center" valignment="top" usebox="none">
25173 \begin_layout Plain Layout
25179 <cell alignment="center" valignment="top" usebox="none">
25182 \begin_layout Plain Layout
25190 <cell alignment="left" valignment="top" usebox="none">
25193 \begin_layout Plain Layout
25199 <cell alignment="left" valignment="top" usebox="none">
25202 \begin_layout Plain Layout
25208 <cell alignment="left" valignment="top" usebox="none">
25211 \begin_layout Plain Layout
25217 <cell alignment="left" valignment="top" usebox="none">
25220 \begin_layout Plain Layout
25226 <cell alignment="center" valignment="top" usebox="none">
25229 \begin_layout Plain Layout
25235 <cell alignment="center" valignment="top" usebox="none">
25238 \begin_layout Plain Layout
25244 <cell alignment="center" valignment="top" usebox="none">
25247 \begin_layout Plain Layout
25253 <cell alignment="center" valignment="top" usebox="none">
25256 \begin_layout Plain Layout
25264 <cell alignment="center" valignment="top" usebox="none">
25267 \begin_layout Plain Layout
25273 <cell alignment="center" valignment="top" usebox="none">
25276 \begin_layout Plain Layout
25282 <cell alignment="center" valignment="top" usebox="none">
25285 \begin_layout Plain Layout
25291 <cell alignment="center" valignment="top" usebox="none">
25294 \begin_layout Plain Layout
25300 <cell alignment="center" valignment="top" usebox="none">
25303 \begin_layout Plain Layout
25309 <cell alignment="center" valignment="top" usebox="none">
25312 \begin_layout Plain Layout
25318 <cell alignment="center" valignment="top" usebox="none">
25321 \begin_layout Plain Layout
25327 <cell alignment="center" valignment="top" usebox="none">
25330 \begin_layout Plain Layout
25344 \begin_layout Chapter
25345 Names of available colors to be used in layouts
25346 \begin_inset CommandInset label
25348 name "chap:Names-of-colors"
25355 \begin_layout Standard
25356 The colors listed here are the standard colors and the those that you can
25357 adjust in the \SpecialChar LyX
25361 \begin_layout Description
25374 No particular color – clear or default
25377 \begin_layout Description
25381 \begin_layout Description
25385 \begin_layout Description
25389 \begin_layout Description
25393 \begin_layout Description
25397 \begin_layout Description
25401 \begin_layout Description
25405 \begin_layout Description
25409 \begin_layout Description
25410 added_space Added space marker color
25413 \begin_layout Description
25414 addedtext Added text color
25417 \begin_layout Description
25418 appendix Appendix marker color
25421 \begin_layout Description
25422 background Background color
25425 \begin_layout Description
25426 bottomarea Bottom area color
25429 \begin_layout Description
25430 branchlabel Label color for branches
25433 \begin_layout Description
25434 buttonbg Color used for bottom background
25437 \begin_layout Description
25438 buttonhoverbg Color used for button background under focus
25441 \begin_layout Description
25442 buttonframe Color for inset button frames
25445 \begin_layout Description
25446 changebar Changebar color
25449 \begin_layout Description
25450 changedtextauthor1 Changed text color author 1
25453 \begin_layout Description
25454 changedtextauthor2 Changed text color author 2
25457 \begin_layout Description
25458 changedtextauthor3 Changed text color author 3
25461 \begin_layout Description
25462 changedtextauthor4 Changed text color author 4
25465 \begin_layout Description
25466 changedtextauthor5 Changed text color author 5
25469 \begin_layout Description
25470 collapsable_inset_frame Collapsable insets framecolor
25473 \begin_layout Description
25474 collapsable_inset_text Collapsable insets text color
25477 \begin_layout Description
25478 command Text color for command insets
25481 \begin_layout Description
25482 commandbg Background color for command insets
25485 \begin_layout Description
25486 commandframe Frame color for command insets
25489 \begin_layout Description
25490 comment color for comments
25493 \begin_layout Description
25494 commentbg Background color of comments
25497 \begin_layout Description
25498 cursor Cursor color
25501 \begin_layout Description
25502 deletedtext Deleted text color
25505 \begin_layout Description
25506 deletedtextmodifier Deleted text modifying color
25509 \begin_layout Description
25510 depthbar Color for the depth bars in the margin
25513 \begin_layout Description
25514 eolmarker End of line marker color
25517 \begin_layout Description
25518 error Color of the \SpecialChar LaTeX
25522 \begin_layout Description
25523 footlabel Label color for footnotes
25526 \begin_layout Description
25527 graphicsbg Graphics inset background color
25530 \begin_layout Description
25531 greyedout Label color for greyedout insets
25534 \begin_layout Description
25535 greyedoutbg Background color of greyedout inset
25538 \begin_layout Description
25539 greyedouttext Color for greyedout inset text
25542 \begin_layout Description
25543 indexlabel Label color for index insets
25546 \begin_layout Description
25547 ignore The color is ignored
25550 \begin_layout Description
25551 inherit The color is inherited
25554 \begin_layout Description
25555 inlinecompletion Inline completion color
25558 \begin_layout Description
25559 insetbg Inset marker background color
25562 \begin_layout Description
25563 insetframe Inset marker frame color
25566 \begin_layout Description
25567 language Color for marking foreign language words
25570 \begin_layout Description
25571 latex Text color in \SpecialChar LaTeX
25575 \begin_layout Description
25576 listingsbg Background color of listings inset
25579 \begin_layout Description
25580 marginlabel Label color for margin notes
25583 \begin_layout Description
25584 math Math inset text color
25587 \begin_layout Description
25588 mathbg Math inset background color
25591 \begin_layout Description
25592 mathcorners Math inset frame color not under focus
25595 \begin_layout Description
25596 mathframe Math inset frame color under focus
25599 \begin_layout Description
25600 mathline Math line color
25603 \begin_layout Description
25604 mathmacrobg Macro math inset background color
25607 \begin_layout Description
25608 mathmacroblend Macro math blended color
25611 \begin_layout Description
25612 mathmacroframe Macro math frame color
25615 \begin_layout Description
25616 mathmacrohoverbg Macro math inset background color hovered
25619 \begin_layout Description
25620 mathmacrolabel Macro math label color
25623 \begin_layout Description
25624 mathmacronewarg Macro template color for new parameters
25627 \begin_layout Description
25628 mathmacrooldarg Macro template color for old parameters
25631 \begin_layout Description
25632 newpage New page color
25635 \begin_layout Description
25636 nonunique_inlinecompletion Inline completion color for the non-unique part
25639 \begin_layout Description
25640 notebg Background color of notes
25643 \begin_layout Description
25644 notelabel Label color for notes
25647 \begin_layout Description
25648 pagebreak Page break/line break color
25651 \begin_layout Description
25652 paragraphmarker Color used for the pilcrow sign to mark the end of a paragraph
25655 \begin_layout Description
25656 phantomtext Text color for phantom insets
25659 \begin_layout Description
25660 preview The color used for previews
25663 \begin_layout Description
25664 previewframe Preview frame color
25667 \begin_layout Description
25668 regexpframe Color for regexp frame
25671 \begin_layout Description
25672 selection Background color of selected text
25675 \begin_layout Description
25676 selectiontext Foreground color of selected text
25679 \begin_layout Description
25680 shadedbg Background color of shaded box
25683 \begin_layout Description
25684 special Special chars text color
25687 \begin_layout Description
25688 tabularline Table line color
25691 \begin_layout Description
25692 tabularonoffline Table line color
25695 \begin_layout Description
25696 urllabel Label color for URL insets
25699 \begin_layout Description
25700 urltext Color for URL inset text