1 #LyX 2.2 created this file. For more info see http://www.lyx.org/
5 \save_transient_properties true
6 \origin /systemlyxdir/doc/
9 % DO NOT ALTER THIS PREAMBLE!!!
11 % This preamble is designed to ensure that this document prints
12 % out as advertised. If you mess with this preamble,
13 % parts of this document may not print out as expected. If you
14 % have problems LaTeXing this file, please contact
15 % the documentation team
16 % email: lyx-docs@lists.lyx.org
18 % the pages of the TOC is numbered roman
19 % and a pdf-bookmark for the TOC is added
20 \let\myTOC\tableofcontents
21 \renewcommand\tableofcontents{%
23 \pdfbookmark[1]{\contentsname}{}
27 % increase link area for cross-references and autoname them,
28 \AtBeginDocument{\renewcommand{\ref}[1]{\mbox{\autoref{#1}}}}
29 \@ifundefined{extrasenglish}{\usepackage[english]{babel}}{}
30 \@ifpackageloaded{babel}{
31 \addto\extrasenglish{%
32 \renewcommand*{\equationautorefname}[1]{}%
33 \renewcommand{\sectionautorefname}{sec.\negthinspace}%
34 \renewcommand{\subsectionautorefname}{sec.\negthinspace}%
35 \renewcommand{\subsubsectionautorefname}{sec.\negthinspace}%
39 \options fleqn,bibliography=totoc,index=totoc,BCOR7.5mm,titlepage,captions=tableheading
40 \use_default_options false
44 \maintain_unincluded_children false
46 \language_package default
49 \font_roman "lmodern" "default"
50 \font_sans "lmss" "default"
51 \font_typewriter "lmtt" "default"
52 \font_math "auto" "auto"
53 \font_default_family default
54 \use_non_tex_fonts false
57 \font_sf_scale 100 100
58 \font_tt_scale 100 100
60 \default_output_format pdf2
62 \bibtex_command default
63 \index_command default
67 \pdf_title "LyX Configuration Manual"
68 \pdf_author "LyX Team"
69 \pdf_subject "LyX-documentation Customization"
70 \pdf_keywords "LyX, documentation, customization"
72 \pdf_bookmarksnumbered true
73 \pdf_bookmarksopen true
74 \pdf_bookmarksopenlevel 1
79 \pdf_pdfusetitle false
80 \pdf_quoted_options "linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue,pdfpagelayout=OneColumn, pdfnewwindow=true, pdfstartview=XYZ, plainpages=false"
83 \use_package amsmath 0
84 \use_package amssymb 0
87 \use_package mathdots 1
88 \use_package mathtools 0
90 \use_package stackrel 0
91 \use_package stmaryrd 0
92 \use_package undertilde 0
94 \cite_engine_type default
98 \paperorientation portrait
102 \notefontcolor #0000ff
114 \paragraph_separation indent
115 \paragraph_indentation default
116 \quotes_language english
119 \paperpagestyle headings
120 \tracking_changes false
121 \output_changes false
130 Customizing \SpecialChar LyX
131 : Features for the Advanced User
135 by the \SpecialChar LyX
140 \begin_layout Plain Layout
142 If you have comments or error corrections, please send them to the \SpecialChar LyX
145 \begin_inset CommandInset href
147 target "lyx-docs@lists.lyx.org"
154 \begin_inset Quotes eld
158 \begin_inset Quotes erd
161 in the subject header, and please cc the current maintainer of this file,
162 Richard Heck <rgheck@comcast.net>.
168 \begin_inset Newline newline
172 \begin_inset Newline newline
178 \begin_layout Standard
179 \begin_inset CommandInset toc
180 LatexCommand tableofcontents
187 \begin_layout Standard
188 \begin_inset Note Note
191 \begin_layout Plain Layout
192 Please use change tracking when modifying this document.
193 This makes it easier for our translators to recognize things that have
194 been changed, and it helps the maintainer keep up-to-date with what's been
203 \begin_layout Chapter
207 \begin_layout Standard
208 This manual covers the customization features present in \SpecialChar LyX
210 In it, we discuss issues like keyboard shortcuts, screen previewing options,
211 printer options, sending commands to \SpecialChar LyX
212 via the \SpecialChar LyX
213 Server, internationalization,
214 installing new \SpecialChar LaTeX
215 classes and \SpecialChar LyX
217 We can't possibly hope to touch on everything you can change—our developers
218 add new features faster than we can document them—but we will explain the
219 most common customizations and hopefully point you in the right direction
220 for some of the more obscure ones.
223 \begin_layout Standard
224 \begin_inset Branch OutDated
227 \begin_layout Standard
228 Information from previous versions of this document that now seems to be
229 outdated is contained in the OutDated branch of this document.
230 By default, this information will not appear in the \SpecialChar LaTeX
239 \begin_layout Chapter
244 \begin_layout Standard
245 This chapter aims to help you to find your way through the \SpecialChar LyX
248 Before continuing to read this chapter, you should find out where your
250 library and user directories are by using
251 \begin_inset Flex Noun
254 \begin_layout Plain Layout
255 Help\SpecialChar menuseparator
266 The library directory is the place where \SpecialChar LyX
267 places its system-wide configuration
268 files; the user directory is where you can place your modified versions.
269 We will call the former
270 \begin_inset Flex Code
273 \begin_layout Plain Layout
280 \begin_inset Flex Noun
283 \begin_layout Plain Layout
289 in the remainder of this document.
293 \begin_layout Section
295 \begin_inset Flex Code
298 \begin_layout Plain Layout
307 \begin_layout Standard
308 \begin_inset Flex Code
311 \begin_layout Plain Layout
317 and its sub-directories contain a number of files and that can be used
318 to customize \SpecialChar LyX
320 You can change many of these files from within \SpecialChar LyX
322 \begin_inset Flex Noun
325 \begin_layout Plain Layout
326 Tools\SpecialChar menuseparator
333 Most customization that you will want to do in \SpecialChar LyX
334 is possible through this
336 However, many other inner aspects of \SpecialChar LyX
337 can be customized by modifying the
339 \begin_inset Flex Code
342 \begin_layout Plain Layout
349 These files fall in different categories, described in the following subsection
353 \begin_layout Subsection
354 Automatically generated files
357 \begin_layout Standard
358 The files, which are to be found in
359 \begin_inset Flex Noun
362 \begin_layout Plain Layout
368 , are generated when you configure \SpecialChar LyX
370 They contain various default values that are guessed by inspection.
371 In general, it is not a good idea to modify them, since they might be overwritt
375 \begin_layout Labeling
376 \labelwidthstring 00.00.0000
377 \begin_inset Flex Code
380 \begin_layout Plain Layout
386 contains defaults for various commands.
389 \begin_layout Labeling
390 \labelwidthstring 00.00.0000
391 \begin_inset Flex Code
394 \begin_layout Plain Layout
400 contains the list of packages that have been recognized by \SpecialChar LyX
402 It is currently unused by the \SpecialChar LyX
403 program itself, but the information extracted,
404 and more, is made available with
405 \begin_inset Flex Noun
408 \begin_layout Plain Layout
409 Help\SpecialChar menuseparator
423 \begin_layout Labeling
424 \labelwidthstring 00.00.0000
425 \begin_inset Flex Code
428 \begin_layout Plain Layout
434 the list of text classes that have been found in your
435 \begin_inset Flex Code
438 \begin_layout Plain Layout
444 directories, along with the associated \SpecialChar LaTeX
445 document class and their description.
448 \begin_layout Labeling
449 \labelwidthstring 00.00.0000
450 \begin_inset Flex Code
453 \begin_layout Plain Layout
459 the list of layout modules found in your
460 \begin_inset Flex Code
463 \begin_layout Plain Layout
472 \begin_layout Labeling
473 \labelwidthstring 00.00.0000
474 \begin_inset Flex Code
477 \begin_layout Plain Layout
483 lists of various sorts of \SpecialChar LaTeX
484 -related files found on your system
487 \begin_layout Labeling
488 \labelwidthstring 00.00.0000
489 \begin_inset Flex Code
492 \begin_layout Plain Layout
493 doc/\SpecialChar LaTeX
499 is automatically generated during configuration from the file
500 \begin_inset Flex Code
503 \begin_layout Plain Layout
511 It contains information on your \SpecialChar LaTeX
515 \begin_layout Subsection
519 \begin_layout Standard
520 These directories are duplicated between
521 \begin_inset Flex Code
524 \begin_layout Plain Layout
531 \begin_inset Flex Code
534 \begin_layout Plain Layout
541 If a particular files exists in both places, the one in
542 \begin_inset Flex Code
545 \begin_layout Plain Layout
554 \begin_layout Labeling
555 \labelwidthstring 00.00.0000
556 \begin_inset Flex Code
559 \begin_layout Plain Layout
565 this directory contains files with the extension
566 \begin_inset Flex Code
569 \begin_layout Plain Layout
575 that define the keybindings used in \SpecialChar LyX
577 If there exists an internationalized version of the bind file named
578 \begin_inset Flex Code
581 \begin_layout Plain Layout
587 , that will be used first.
590 \begin_layout Labeling
591 \labelwidthstring 00.00.0000
592 \begin_inset Flex Code
595 \begin_layout Plain Layout
601 contains graphics files that can be included in documents.
605 \begin_layout Labeling
606 \labelwidthstring 00.00.0000
607 \begin_inset Flex Code
610 \begin_layout Plain Layout
616 contains \SpecialChar LyX
617 documentation files (including the one you are currently reading).
619 \begin_inset Flex Code
622 \begin_layout Plain Layout
629 deserves special attention, as noted above.
630 The internationalized help docs are in subdirectories
631 \begin_inset Flex Code
634 \begin_layout Plain Layout
641 \begin_inset Quotes eld
645 \begin_inset Quotes erd
648 is the ISO language code.
650 \begin_inset CommandInset ref
652 reference "cha:Internationalizing-LyX"
659 \begin_layout Labeling
660 \labelwidthstring 00.00.0000
661 \begin_inset Flex Code
664 \begin_layout Plain Layout
670 contains example files that explain how to use some features.
671 In the file browser, press the
672 \begin_inset Flex Noun
675 \begin_layout Plain Layout
684 \begin_layout Labeling
685 \labelwidthstring 00.00.0000
686 \begin_inset Flex Code
689 \begin_layout Plain Layout
695 contains image files that are used by the
696 \begin_inset Flex Noun
699 \begin_layout Plain Layout
706 In addition, it also contains the individual icons used in the toolbar
707 and the banners that can be shown when \SpecialChar LyX
711 \begin_layout Labeling
712 \labelwidthstring 00.00.0000
713 \begin_inset Flex Code
716 \begin_layout Plain Layout
722 contains keyboard keymapping files.
724 \begin_inset CommandInset ref
726 reference "sec:International-Keymap-Stuff"
733 \begin_layout Labeling
734 \labelwidthstring 00.00.0000
735 \begin_inset Flex Code
738 \begin_layout Plain Layout
744 contains the text class and module files described in
745 \begin_inset CommandInset ref
747 reference "cha:Installing-New-Document"
754 \begin_layout Labeling
755 \labelwidthstring 00.00.0000
756 \begin_inset Flex Code
759 \begin_layout Plain Layout
766 \begin_inset Flex Code
769 \begin_layout Plain Layout
775 Python scripts used to convert between \SpecialChar LyX
777 These can be run from the command line if, say, you want to batch-convert
781 \begin_layout Labeling
782 \labelwidthstring 00.00.0000
783 \begin_inset Flex Code
786 \begin_layout Plain Layout
792 contains some files that demonstrate the capabilities of the
793 \begin_inset Flex Noun
796 \begin_layout Plain Layout
807 Also contains some scripts used by \SpecialChar LyX
811 \begin_layout Labeling
812 \labelwidthstring 00.00.0000
813 \begin_inset Flex Code
816 \begin_layout Plain Layout
822 contains the standard \SpecialChar LyX
823 template files described in
824 \begin_inset CommandInset ref
826 reference "subsec:Creating-Templates"
833 \begin_layout Labeling
834 \labelwidthstring 00.00.0000
835 \begin_inset Flex Code
838 \begin_layout Plain Layout
844 contains files with the extension
845 \begin_inset Flex Code
848 \begin_layout Plain Layout
854 that define the user interface to \SpecialChar LyX
856 That is, the files define which items appear in which menus and the items
857 appearing on the toolbar.
860 \begin_layout Subsection
861 Files you don't want to modify
864 \begin_layout Standard
865 These files are used internally by \SpecialChar LyX
866 and you generally do not need to modify
867 them unless you are a developer.
870 \begin_layout Labeling
871 \labelwidthstring 00.00.0000
872 \begin_inset Flex Code
875 \begin_layout Plain Layout
881 this file contains the list of \SpecialChar LyX
883 The contents are displayed with the menu entry
884 \begin_inset Flex Noun
887 \begin_layout Plain Layout
888 Help\SpecialChar menuseparator
901 \begin_layout Labeling
902 \labelwidthstring 00.00.0000
903 \begin_inset Flex Code
906 \begin_layout Plain Layout
912 this is a \SpecialChar LaTeX
913 script used during the configuration process.
917 \begin_layout Labeling
918 \labelwidthstring 00.00.0000
919 \begin_inset Flex Code
922 \begin_layout Plain Layout
928 this is a Python script that is used to re-configure \SpecialChar LyX
930 It creates configuration files in the directory it was run from.
933 \begin_layout Subsection
934 Other files needing a line or two
937 \begin_layout Labeling
938 \labelwidthstring 00.00.0000
939 \begin_inset Flex Code
942 \begin_layout Plain Layout
948 this contains tables describing how different character encodings can be
952 \begin_layout Labeling
953 \labelwidthstring 00.00.0000
954 \begin_inset Flex Code
957 \begin_layout Plain Layout
963 this file contains the templates available to the new
964 \begin_inset Flex Noun
967 \begin_layout Plain Layout
978 \begin_inset CommandInset ref
980 reference "chap:Including-External-Material"
987 \begin_layout Labeling
988 \labelwidthstring 00.00.0000
989 \begin_inset Flex Code
992 \begin_layout Plain Layout
998 this file contains a list of all the languages currently supported by \SpecialChar LyX
1002 \begin_layout Labeling
1003 \labelwidthstring 00.00.0000
1004 \begin_inset Flex Code
1007 \begin_layout Plain Layout
1013 contains information about the supported fonts.
1016 \begin_layout Labeling
1017 \labelwidthstring 00.00.0000
1018 \begin_inset Flex Code
1021 \begin_layout Plain Layout
1027 this file contains translations for internationalized paragraph styles
1029 \begin_inset CommandInset ref
1031 reference "subsec:I18n"
1038 \begin_layout Labeling
1039 \labelwidthstring 00.00.0000
1040 \begin_inset Flex Code
1043 \begin_layout Plain Layout
1049 this file contains information about unicode-encoded glyphs and the way
1050 they are supported by \SpecialChar LyX
1051 via \SpecialChar LaTeX
1055 \begin_layout Section
1056 Your local configuration directory
1059 \begin_layout Standard
1060 Even if you are using \SpecialChar LyX
1061 as an unprivileged user, you might want to change
1063 configuration for your own use.
1065 \begin_inset Flex Code
1068 \begin_layout Plain Layout
1074 directory contains all your personal configuration files.
1075 This is the directory described as
1076 \begin_inset Quotes eld
1080 \begin_inset Quotes erd
1084 \begin_inset Flex Noun
1087 \begin_layout Plain Layout
1088 Help\SpecialChar menuseparator
1090 \begin_inset space ~
1099 This directory is used as a mirror of
1100 \begin_inset Flex Code
1103 \begin_layout Plain Layout
1109 , which means that every file in
1110 \begin_inset Flex Code
1113 \begin_layout Plain Layout
1119 is a replacement for the corresponding file in
1120 \begin_inset Flex Code
1123 \begin_layout Plain Layout
1130 Any configuration file described in the above sections can be placed either
1131 in the system-wide directory, in which case it will affect all users, or
1132 in your local directory for your own use.
1135 \begin_layout Standard
1136 To make things clearer, let's provide a few examples:
1139 \begin_layout Itemize
1140 The preferences set in the
1141 \begin_inset Flex Noun
1144 \begin_layout Plain Layout
1145 Tools\SpecialChar menuseparator
1151 dialog are saved to a file
1152 \begin_inset Flex Code
1155 \begin_layout Plain Layout
1162 \begin_inset Flex Code
1165 \begin_layout Plain Layout
1174 \begin_layout Itemize
1175 When you reconfigure using
1176 \begin_inset Flex Noun
1179 \begin_layout Plain Layout
1180 Tools\SpecialChar menuseparator
1188 \begin_inset Flex Code
1191 \begin_layout Plain Layout
1197 script, and the resulting files are written in your local configuration
1199 This means that any additional text class file that you might have added
1201 \begin_inset Flex Code
1204 \begin_layout Plain Layout
1210 will be added to the list of classes in the
1211 \begin_inset Flex Noun
1214 \begin_layout Plain Layout
1215 Document\SpecialChar menuseparator
1224 \begin_layout Itemize
1225 If you get some updated documentation from \SpecialChar LyX
1226 ftp site and cannot install
1227 it because you do not have sysadmin rights on your system, you can just
1229 \begin_inset Flex Code
1232 \begin_layout Plain Layout
1238 and the items in the
1239 \begin_inset Flex Noun
1242 \begin_layout Plain Layout
1248 menu will open them!
1251 \begin_layout Section
1252 Running \SpecialChar LyX
1253 with multiple configurations
1256 \begin_layout Standard
1257 The configuration freedom of the local configuration directory may not suffice
1258 if you want to have more than one configuration at your disposal.
1259 For example, you may want to be use different key bindings or printer settings
1261 You can achieve this by having several such directories.
1262 You then specify which directory to use at run-time.
1265 \begin_layout Standard
1266 Invoking \SpecialChar LyX
1267 with the command line switch
1268 \begin_inset Flex Code
1271 \begin_layout Plain Layout
1281 instructs the program to read the configuration from that directory, and
1282 not from the default directory.
1283 (You can determine the default directory by running \SpecialChar LyX
1285 \begin_inset Flex Code
1288 \begin_layout Plain Layout
1294 switch.) If the specified directory does not exist, \SpecialChar LyX
1296 for you, just like it does for the default directory on the first time
1297 you run the program.
1298 You can modify the configuration options in this additional user directory
1299 exactly as you would for the default directory.
1300 These directories are completely independent (but read on).
1301 Note that setting the environment variable
1302 \begin_inset Flex Code
1305 \begin_layout Plain Layout
1311 to some value has exactly the same effect.
1314 \begin_layout Standard
1315 Having several configurations also requires more maintenance: if you want
1316 to add a new layout to
1317 \begin_inset Flex Code
1320 \begin_layout Plain Layout
1326 which you want available from all your configurations, you must add it
1327 to each directory separately.
1328 You can avoid this with the following trick: after \SpecialChar LyX
1329 creates the additional
1330 directory, most of the subdirectories (see above) are empty.
1331 If you want the new configuration to mirror an existing one, replace the
1332 empty subdirectory with a symbolic link to the matching subdirectory in
1333 the existing configuration.
1335 \begin_inset Flex Code
1338 \begin_layout Plain Layout
1344 subdirectory, however, since it contains a file written by the configuration
1345 script (also accessible through
1346 \begin_inset Flex Noun
1349 \begin_layout Plain Layout
1350 Tools\SpecialChar menuseparator
1356 ) which is configuration-specific.
1359 \begin_layout Chapter
1360 The Preferences dialog
1363 \begin_layout Standard
1364 All options of the preferences dialog are described in the Appendix
1366 The Preferences Dialog
1373 For some options you might find here more details.
1376 \begin_layout Section
1378 \begin_inset CommandInset label
1387 \begin_layout Standard
1388 The first step is to define your file formats if they are not already defined.
1390 \begin_inset Flex Noun
1393 \begin_layout Plain Layout
1394 Tools\SpecialChar menuseparator
1402 \begin_inset Flex Noun
1405 \begin_layout Plain Layout
1406 File Handling\SpecialChar menuseparator
1413 \begin_inset Flex Noun
1416 \begin_layout Plain Layout
1422 button to define your new format.
1424 \begin_inset Flex Noun
1427 \begin_layout Plain Layout
1433 field contains the name used to identify the format in the GUI.
1435 \begin_inset Flex Noun
1438 \begin_layout Plain Layout
1444 is used to identify the format internally.
1445 You will also need to enter a file extension.
1446 These are all required.
1448 \begin_inset Flex Noun
1451 \begin_layout Plain Layout
1457 field is used to provide a keyboard shortcut on the menus.
1458 (For example, pressing
1459 \begin_inset Flex Noun
1462 \begin_layout Plain Layout
1469 \begin_inset Flex Noun
1472 \begin_layout Plain Layout
1473 Document\SpecialChar menuseparator
1474 View (Other Formats)\SpecialChar menuseparator
1483 \begin_layout Standard
1485 \begin_inset Flex Noun
1488 \begin_layout Plain Layout
1495 \begin_inset Flex Noun
1498 \begin_layout Plain Layout
1505 For example, you might want to use
1506 \begin_inset Flex Noun
1509 \begin_layout Plain Layout
1515 to view PostScript files.
1516 You can enter the command needed to start the program in the corresponding
1518 In defining this command, you can use the four variables listed in the
1520 The viewer is launched when you view an image in \SpecialChar LyX
1522 \begin_inset Flex Noun
1525 \begin_layout Plain Layout
1526 Document\SpecialChar menuseparator
1533 The editor is for example launched when you right-click on an image and
1535 \begin_inset Flex Noun
1538 \begin_layout Plain Layout
1544 in the appearing context menu.
1547 \begin_layout Standard
1549 \begin_inset Flex Noun
1552 \begin_layout Plain Layout
1558 type of a format is optional, but if it is specified, it must be unique
1560 It is used to detect files of this format from the file contents.
1561 For some important file formats there is no MIME type officially registered
1563 \begin_inset CommandInset href
1566 target "http://www.iana.org/assignments/media-types/"
1571 Therefore \SpecialChar LyX
1572 uses the extended list of MIME types as specified by
1573 \begin_inset CommandInset href
1575 name "freedesktop.org"
1576 target "http://www.freedesktop.org/wiki/Specifications/shared-mime-info-spec"
1583 \begin_layout Standard
1585 \begin_inset Flex Noun
1588 \begin_layout Plain Layout
1594 option tells \SpecialChar LyX
1595 that a format is suitable for document export.
1596 If this is set and if a suitable conversion route exists (see
1597 \begin_inset CommandInset ref
1599 reference "sec:Converters"
1603 ), the format will appear in the
1604 \begin_inset Flex Noun
1607 \begin_layout Plain Layout
1608 File\SpecialChar menuseparator
1615 The format will also appear in the
1616 \begin_inset Flex Noun
1619 \begin_layout Plain Layout
1620 Document\SpecialChar menuseparator
1626 menu if a viewer is specified for the format.
1627 Pure image formats, such as
1628 \begin_inset Flex Code
1631 \begin_layout Plain Layout
1637 , should not use this option.
1638 Formats that can both represent vector graphics and documents like
1639 \begin_inset Flex Code
1642 \begin_layout Plain Layout
1651 \begin_layout Standard
1653 \begin_inset Flex Noun
1656 \begin_layout Plain Layout
1657 Vector graphics format
1662 tells \SpecialChar LyX
1663 that a format can contain vector graphics.
1664 This information is used to determine the target format of included graphics
1666 \begin_inset Flex Noun
1669 \begin_layout Plain Layout
1676 Included graphics may need to be converted to either
1677 \begin_inset Flex Noun
1680 \begin_layout Plain Layout
1687 \begin_inset Flex Noun
1690 \begin_layout Plain Layout
1697 \begin_inset Flex Noun
1700 \begin_layout Plain Layout
1707 \begin_inset Flex Noun
1710 \begin_layout Plain Layout
1716 cannot handle other image formats.
1717 If an included graphic is not already in
1718 \begin_inset Flex Noun
1721 \begin_layout Plain Layout
1728 \begin_inset Flex Noun
1731 \begin_layout Plain Layout
1738 \begin_inset Flex Noun
1741 \begin_layout Plain Layout
1747 format, it is converted to
1748 \begin_inset Flex Noun
1751 \begin_layout Plain Layout
1757 if the vector format option is set, and otherwise to
1758 \begin_inset Flex Noun
1761 \begin_layout Plain Layout
1770 \begin_layout Section
1774 \begin_layout Standard
1775 Since all conversions from one format to another take place in \SpecialChar LyX
1777 directory, it is sometimes necessary to modify a file before copying it
1778 to the temporary directory in order that the conversion may be performed.
1782 \begin_layout Plain Layout
1783 For example, the file may refer to other files—images, for example—using
1784 relative file names, and these may become invalid when the file is copied
1785 to the temporary directory.
1790 This is done by a Copier: It copies a file to (or from) the temporary directory
1791 and may modify it in the process.
1794 \begin_layout Standard
1795 The definitions of the copiers may use eight variables:
1798 \begin_layout Labeling
1799 \labelwidthstring 00.00.0000
1800 \begin_inset Flex Code
1803 \begin_layout Plain Layout
1809 The \SpecialChar LyX
1810 system directory (e.
1811 \begin_inset space \thinspace{}
1815 \begin_inset space \space{}
1819 \begin_inset Flex Noun
1822 \begin_layout Plain Layout
1831 \begin_layout Labeling
1832 \labelwidthstring 00.00.0000
1833 \begin_inset Flex Code
1836 \begin_layout Plain Layout
1845 \begin_layout Labeling
1846 \labelwidthstring 00.00.0000
1847 \begin_inset Flex Code
1850 \begin_layout Plain Layout
1859 \begin_layout Labeling
1860 \labelwidthstring 00.00.0000
1861 \begin_inset Flex Code
1864 \begin_layout Plain Layout
1870 The base name (without filename extension) in the \SpecialChar LyX
1874 \begin_layout Labeling
1875 \labelwidthstring 00.00.0000
1876 \begin_inset Flex Code
1879 \begin_layout Plain Layout
1885 The full directory path of the \SpecialChar LyX
1889 \begin_layout Labeling
1890 \labelwidthstring 00.00.0000
1891 \begin_inset Flex Code
1894 \begin_layout Plain Layout
1900 The full pathname to the original \SpecialChar LyX
1901 file being processed
1904 \begin_layout Labeling
1905 \labelwidthstring 00.00.0000
1906 \begin_inset Flex Code
1909 \begin_layout Plain Layout
1915 The filename (without any directory path) of the \SpecialChar LyX
1919 \begin_layout Labeling
1920 \labelwidthstring 00.00.0000
1921 \begin_inset Flex Code
1924 \begin_layout Plain Layout
1930 The `\SpecialChar LaTeX
1934 \begin_layout Standard
1935 The latter should be the filename as it would be used in a \SpecialChar LaTeX
1943 It is relevant only when exporting files suitable for such inclusion.
1946 \begin_layout Standard
1947 Copiers can be used to do almost anything with output files.
1948 For example, suppose you want generated pdf files to be copied to a special
1950 \begin_inset Flex Code
1953 \begin_layout Plain Layout
1960 Then you could write a shell script such as this one:
1963 \begin_layout Standard
1964 \begin_inset listings
1968 \begin_layout Plain Layout
1973 \begin_layout Plain Layout
1978 \begin_layout Plain Layout
1980 TOFILE=`basename $2`
1983 \begin_layout Plain Layout
1985 cp $FROMFILE /home/you/pdf/$TOFILE
1990 Save it in your local \SpecialChar LyX
1992 \begin_inset Flex Code
1995 \begin_layout Plain Layout
1996 /home/you/.lyx/scripts/pdfcopier.sh
2001 —and make it executable, if you need to do so on your platform.
2003 \begin_inset Flex Noun
2006 \begin_layout Plain Layout
2007 Tools\SpecialChar menuseparator
2013 dialog, select under
2014 \begin_inset Flex Noun
2017 \begin_layout Plain Layout
2018 File Handling\SpecialChar menuseparator
2025 \begin_inset Flex Noun
2028 \begin_layout Plain Layout
2034 format—or one of the other pdf formats—and enter
2035 \begin_inset Flex Code
2038 \begin_layout Plain Layout
2039 pdfcopier.sh $$i $$o
2045 \begin_inset Flex Noun
2048 \begin_layout Plain Layout
2058 \begin_layout Standard
2059 Copiers are used by \SpecialChar LyX
2060 in various of its own conversions.
2061 For example, if appropriate programs are found, \SpecialChar LyX
2062 will automatically install
2064 \begin_inset Flex Noun
2067 \begin_layout Plain Layout
2074 \begin_inset Flex Noun
2077 \begin_layout Plain Layout
2079 \begin_inset space ~
2088 When these formats are exported, the copier sees that not just the main
2089 HTML file but various associated files (style files, images, etc.) are also
2091 All these files are written to a subdirectory of the directory in which
2092 the original \SpecialChar LyX
2097 \begin_layout Plain Layout
2098 This copier can be customized.
2100 \begin_inset Quotes eld
2104 \begin_inset Quotes erd
2107 argument takes a comma-separated list of extensions to be copied; if it
2108 is omitted, all files will be copied.
2110 \begin_inset Quotes eld
2114 \begin_inset Quotes erd
2117 argument determines the extension added to the generated directory.
2119 \begin_inset Quotes eld
2123 \begin_inset Flex Noun
2126 \begin_layout Plain Layout
2133 \begin_inset Quotes erd
2136 , so HTML generated from
2137 \begin_inset Flex Noun
2140 \begin_layout Plain Layout
2141 /path/to/filename.lyx
2147 \begin_inset Flex Noun
2150 \begin_layout Plain Layout
2151 /path/to/filename.html.LyXconv
2165 \begin_layout Section
2167 \begin_inset CommandInset label
2169 name "sec:Converters"
2176 \begin_layout Standard
2177 You can define your own Converters to convert files between different formats.
2179 \begin_inset Flex Noun
2182 \begin_layout Plain Layout
2183 Tools\SpecialChar menuseparator
2184 Preferences\SpecialChar menuseparator
2185 File Handling\SpecialChar menuseparator
2194 \begin_layout Standard
2195 To define a new converter, select the
2196 \begin_inset Flex Noun
2199 \begin_layout Plain Layout
2201 \begin_inset space ~
2210 \begin_inset Flex Noun
2213 \begin_layout Plain Layout
2215 \begin_inset space ~
2223 from the drop-down lists, enter the command needed for the conversion,
2225 \begin_inset Flex Noun
2228 \begin_layout Plain Layout
2235 Several variables can be used in the definition of converters:
2238 \begin_layout Labeling
2239 \labelwidthstring 00.00.0000
2240 \begin_inset Flex Code
2243 \begin_layout Plain Layout
2249 The \SpecialChar LyX
2253 \begin_layout Labeling
2254 \labelwidthstring 00.00.0000
2255 \begin_inset Flex Code
2258 \begin_layout Plain Layout
2267 \begin_layout Labeling
2268 \labelwidthstring 00.00.0000
2269 \begin_inset Flex Code
2272 \begin_layout Plain Layout
2281 \begin_layout Labeling
2282 \labelwidthstring 00.00.0000
2283 \begin_inset Flex Code
2286 \begin_layout Plain Layout
2292 The base filename of the input file (i.
2293 \begin_inset space \thinspace{}
2296 g., without the extension)
2299 \begin_layout Labeling
2300 \labelwidthstring 00.00.0000
2301 \begin_inset Flex Code
2304 \begin_layout Plain Layout
2310 The path to the input file
2313 \begin_layout Labeling
2314 \labelwidthstring 00.00.0000
2315 \begin_inset Flex Code
2318 \begin_layout Plain Layout
2324 The path to the original input file (this is different from $$p when a
2325 chain of converters is called)
2328 \begin_layout Labeling
2329 \labelwidthstring 00.00.0000
2330 \begin_inset Flex Code
2333 \begin_layout Plain Layout
2339 The iconv name for the encoding of the document.
2342 \begin_layout Standard
2344 \begin_inset Flex Noun
2347 \begin_layout Plain Layout
2349 \begin_inset space ~
2357 field you can enter the following flags, separated by commas:
2360 \begin_layout Labeling
2361 \labelwidthstring 00.00.0000
2362 \begin_inset Flex Code
2365 \begin_layout Plain Layout
2371 This converter runs some form of \SpecialChar LaTeX
2373 This will make \SpecialChar LyX
2374 's \SpecialChar LaTeX
2375 error logs available.
2378 \begin_layout Labeling
2379 \labelwidthstring 00.00.0000
2380 \begin_inset Flex Code
2383 \begin_layout Plain Layout
2389 Needs the \SpecialChar LaTeX
2391 \begin_inset Flex Noun
2394 \begin_layout Plain Layout
2400 file for the conversion.
2403 \begin_layout Labeling
2404 \labelwidthstring 00.00.0000
2405 \begin_inset Flex Code
2408 \begin_layout Plain Layout
2415 \begin_inset Quotes eld
2419 \begin_inset Quotes erd
2422 file from the backend, which in practice means a \SpecialChar LaTeX
2423 file like the one we
2424 would export, without
2425 \begin_inset Flex Code
2428 \begin_layout Plain Layout
2437 \begin_layout Labeling
2438 \labelwidthstring 00.00.0000
2439 \begin_inset Flex Code
2442 \begin_layout Plain Layout
2451 \begin_layout Standard
2452 The following three flags are not really flags at all because they take
2454 \begin_inset Flex Noun
2457 \begin_layout Plain Layout
2459 \begin_inset space ~
2463 \begin_inset space ~
2474 \begin_layout Labeling
2475 \labelwidthstring 00.00.0000
2476 \begin_inset Flex Code
2479 \begin_layout Plain Layout
2485 If set, the converter's standard error will be redirected to a file
2486 \begin_inset Flex Code
2489 \begin_layout Plain Layout
2495 , and the script given as argument will be run as:
2496 \begin_inset Flex Code
2499 \begin_layout Plain Layout
2500 script < infile.out > infile.log
2506 The argument may contain
2507 \begin_inset Flex Code
2510 \begin_layout Plain Layout
2519 \begin_layout Labeling
2520 \labelwidthstring 00.00.0000
2521 \begin_inset Flex Code
2524 \begin_layout Plain Layout
2530 The name of the directory in which the converter will dump the generated
2533 will not create this directory, and it does not copy anything into it,
2534 though it will copy this directory to the destination.
2535 The argument may contain
2536 \begin_inset Flex Code
2539 \begin_layout Plain Layout
2545 , which will be replaced by the base name of the input and output files,
2546 respectively, when the directory is copied.
2547 \begin_inset Newline newline
2550 Note that resultdir and usetempdir make no sense together.
2551 The latter will be ignored if the former is given.
2554 \begin_layout Labeling
2555 \labelwidthstring 00.00.0000
2556 \begin_inset Flex Code
2559 \begin_layout Plain Layout
2565 Determines the output file name and may, contain
2566 \begin_inset Flex Code
2569 \begin_layout Plain Layout
2576 Sensible only with resultdir and optional even then; if not given, it defaults
2580 \begin_layout Standard
2581 None of these last three are presently used in any of the converters that
2582 are installed with \SpecialChar LyX
2587 \begin_layout Standard
2588 You do not have to define converters for all formats between which you want
2590 For example, you will note that there is no `\SpecialChar LyX
2591 to PostScript' converter,
2592 but \SpecialChar LyX
2593 will export PostScript.
2594 It does so by first creating a \SpecialChar LaTeX
2595 file (no converter needs to be defined
2596 for this) which is then converted to DVI using the `\SpecialChar LaTeX
2598 and finally converting the resulting DVI file to PostScript.
2600 finds such `chains' of converters automatically, and it will always choose
2601 the shortest possible chain.
2602 You can, though, still define multiple conversion methods between file
2604 For example, the standard \SpecialChar LyX
2605 configuration provides five ways to convert
2610 \begin_layout Enumerate
2612 \begin_inset Flex Noun
2615 \begin_layout Plain Layout
2624 \begin_layout Enumerate
2625 via (DVI and) PostScript, using
2626 \begin_inset Flex Noun
2629 \begin_layout Plain Layout
2638 \begin_layout Enumerate
2640 \begin_inset Flex Noun
2643 \begin_layout Plain Layout
2652 \begin_layout Enumerate
2654 \begin_inset Flex Noun
2657 \begin_layout Plain Layout
2667 \begin_layout Enumerate
2669 \begin_inset Flex Noun
2672 \begin_layout Plain Layout
2682 \begin_layout Standard
2683 To define such alternate chains, you must define multiple target `file formats',
2685 \begin_inset CommandInset ref
2687 reference "sec:Formats"
2692 For example, in the standard configuration, the formats named
2693 \begin_inset Flex Noun
2696 \begin_layout Plain Layout
2703 \begin_inset Flex Noun
2706 \begin_layout Plain Layout
2713 \begin_inset Flex Noun
2716 \begin_layout Plain Layout
2723 \begin_inset Flex Noun
2726 \begin_layout Plain Layout
2733 \begin_inset Flex Noun
2736 \begin_layout Plain Layout
2743 \begin_inset Flex Noun
2746 \begin_layout Plain Layout
2753 \begin_inset Flex Noun
2756 \begin_layout Plain Layout
2763 \begin_inset Flex Noun
2766 \begin_layout Plain Layout
2774 \begin_inset Flex Noun
2777 \begin_layout Plain Layout
2784 \begin_inset Flex Noun
2787 \begin_layout Plain Layout
2794 ) are defined, all of which share the extension
2795 \begin_inset Flex Noun
2798 \begin_layout Plain Layout
2804 , and which correspond to the conversion methods just mentioned.
2807 \begin_layout Chapter
2808 Internationalizing \SpecialChar LyX
2810 \begin_inset CommandInset label
2812 name "cha:Internationalizing-LyX"
2819 \begin_layout Standard
2821 supports using a translated interface.
2822 Last time we checked, \SpecialChar LyX
2823 provided text in thirty languages.
2824 The language of choice is called your
2829 (For further reading on locale settings, see also the documentation for
2830 locale that comes with your operating system.
2831 For Linux, the manual page for
2832 \begin_inset Flex Code
2835 \begin_layout Plain Layout
2841 could be a good place to start).
2844 \begin_layout Standard
2845 Notice that these translations will work, but do contain a few flaws.
2846 In particular, all dialogs have been designed with the English text in
2847 mind, which means that some of the translated text will be too large to
2848 fit within the space allocated.
2849 This is only a display problem and will not cause any harm.
2850 Also, you will find that some of the translations do not define shortcut
2851 keys for everything.
2852 Sometimes, there are simply not enough free letters to do it.
2853 Other times, the translator just hasn't got around to doing it yet.
2854 Our localization team, which you may wish to join,
2858 \begin_layout Plain Layout
2859 If you are a fluent speaker of a language other than English, joining these
2860 teams is a great way to give back to the \SpecialChar LyX
2866 will of course try to fix these shortcomings in future versions of \SpecialChar LyX
2870 \begin_layout Section
2871 Translating \SpecialChar LyX
2875 \begin_layout Subsection
2876 Translating the graphical user interface (text messages).
2879 \begin_layout Standard
2882 \begin_inset Flex Code
2885 \begin_layout Plain Layout
2891 library to handle the internationalization of the interface.
2892 To have \SpecialChar LyX
2893 speak your favorite language in all menus and dialogs, you need
2895 \begin_inset Flex Code
2898 \begin_layout Plain Layout
2904 -file for that language.
2905 When this is available, you'll have to generate a
2906 \begin_inset Flex Code
2909 \begin_layout Plain Layout
2915 -file from it and install the
2916 \begin_inset Flex Code
2919 \begin_layout Plain Layout
2926 The process of doing all of this is explained in the documentation for
2928 \begin_inset Flex Code
2931 \begin_layout Plain Layout
2938 It is possible to do this just for yourself, but if you're going to do
2939 it, you might as well share the results of your labors with the rest of
2940 the \SpecialChar LyX
2942 Send a message to the \SpecialChar LyX
2943 developers' list for more information about how
2947 \begin_layout Standard
2948 In short, this is what you should do (xx denotes the language code):
2951 \begin_layout Itemize
2952 Check out the \SpecialChar LyX
2955 \begin_inset CommandInset href
2957 name "information on the web"
2958 target "http://www.lyx.org/HowToUseGIT"
2965 \begin_layout Itemize
2967 \begin_inset Flex Code
2970 \begin_layout Plain Layout
2976 to the folder of the
2977 \begin_inset Flex Code
2980 \begin_layout Plain Layout
2988 \begin_inset Flex Code
2991 \begin_layout Plain Layout
2999 \begin_inset Flex Code
3002 \begin_layout Plain Layout
3008 doesn't exist anywhere, it can be remade with the console command
3009 \begin_inset Flex Code
3012 \begin_layout Plain Layout
3018 in that directory, or you can use an existing po-file for some other language
3022 \begin_layout Itemize
3024 \begin_inset Flex Code
3027 \begin_layout Plain Layout
3037 \begin_layout Plain Layout
3038 This is just a text file, so it can be edited in any text editor.
3039 But there are also specialized programs that support such editing, such
3044 (for all platforms) or
3053 contains a `mode' for editing
3054 \begin_inset Flex Code
3057 \begin_layout Plain Layout
3064 \begin_inset Flex URL
3067 \begin_layout Plain Layout
3069 https://www.gnu.org/software/gettext/manual/html_node/PO-Mode.html
3081 For some menu- and widget-labels, there are also shortcut keys that should
3083 Those keys are marked after a `|', and should be translated according to
3084 the words and phrases of the language.
3085 You should also fill also out the information at the beginning of the new
3087 \begin_inset Flex Code
3090 \begin_layout Plain Layout
3096 -file with your email-address, etc., so people know where to reach you with
3097 suggestions and entertaining flames.
3100 \begin_layout Standard
3101 If you are just doing this on your own, then:
3104 \begin_layout Itemize
3106 \begin_inset Flex Code
3109 \begin_layout Plain Layout
3116 This can be done with
3117 \begin_inset Flex Code
3120 \begin_layout Plain Layout
3121 msgfmt -o xx.mo < xx.po
3129 \begin_layout Itemize
3131 \begin_inset Flex Code
3134 \begin_layout Plain Layout
3140 -file to your locale-tree, at the correct directory for application messages
3145 xx, and under the name
3146 \begin_inset Flex Code
3149 \begin_layout Plain Layout
3156 \begin_inset space \thinspace{}
3160 \begin_inset space \space{}
3164 \begin_inset Flex Code
3167 \begin_layout Plain Layout
3168 /usr/local/share/locale/xx/LC_MESSAGES/lyx.mo
3178 \begin_layout Standard
3179 As said, however, it would be best if the new
3180 \begin_inset Flex Code
3183 \begin_layout Plain Layout
3189 file could be added to the \SpecialChar LyX
3190 distribution, so others can use it.
3191 Adding it involves making additional changes to \SpecialChar LyX
3193 So send an email to the developers' mailing list if you're interested in
3197 \begin_layout Subsubsection
3201 \begin_layout Standard
3202 Sometimes it turns out that one English message needs to be translated into
3203 different messages in the target language.
3204 One example is the message
3205 \begin_inset Flex Code
3208 \begin_layout Plain Layout
3214 which has the German translation
3222 , depending upon exactly what the English
3223 \begin_inset Quotes eld
3227 \begin_inset Quotes erd
3232 \begin_inset Flex Code
3235 \begin_layout Plain Layout
3241 does not handle such ambiguous translations.
3242 Therefore you have to add some context information to the message: Instead
3244 \begin_inset Flex Code
3247 \begin_layout Plain Layout
3254 \begin_inset Flex Code
3257 \begin_layout Plain Layout
3258 To[[as in 'From format x to format y']]
3264 \begin_inset Flex Code
3267 \begin_layout Plain Layout
3268 To[[as in 'From page x to page y']].
3273 Now the two occurrences of
3274 \begin_inset Flex Code
3277 \begin_layout Plain Layout
3284 \begin_inset Flex Code
3287 \begin_layout Plain Layout
3293 and can be translated correctly to
3304 \begin_layout Standard
3305 Of course the context information needs to be stripped off the original
3306 message when no translation is used.
3307 Therefore you have to put it in double square brackets at the end of the
3308 message (see the example above).
3309 The translation mechanism of \SpecialChar LyX
3310 ensures that everything in double square
3311 brackets at the end of messages is removed before displaying the message.
3314 \begin_layout Subsection
3315 Translating the documentation.
3318 \begin_layout Standard
3319 The online documentation (in the
3320 \begin_inset Flex Noun
3323 \begin_layout Plain Layout
3329 -menu) can (and should!) be translated.
3330 If there are translated versions of the documentation available
3334 \begin_layout Plain Layout
3335 As of March 2008, at least some of the documents have been translated into
3336 fourteen languages, with the Tutorial available in a few more.
3341 and the locale is set accordingly, these will be used automagically by
3345 looks for translated versions as
3346 \begin_inset Flex Code
3349 \begin_layout Plain Layout
3350 LyXDir/doc/xx/DocName.lyx
3356 \begin_inset Flex Code
3359 \begin_layout Plain Layout
3365 is the code for the language currently in use.
3366 If there are no translated documents, the default English versions will
3368 Note that the translated versions must have the same filenames (
3369 \begin_inset Flex Code
3372 \begin_layout Plain Layout
3378 above) as the original.
3379 If you feel up to translating the documentation (an excellent way to proof-read
3380 the original documentation by the way!), there are a few things you should
3384 \begin_layout Itemize
3385 Check out the documentation translation web page at
3386 \begin_inset CommandInset href
3388 name "http://www.lyx.org/Translation"
3389 target "http://www.lyx.org/Translation"
3394 That way, you can find out which (if any) documents have already been translate
3395 d into your language.
3396 You can also find out who (if anyone) is organizing the effort to translate
3397 the documentation into your language.
3398 If no one is organizing the effort, please let us know that you're interested.
3401 \begin_layout Standard
3402 Once you get to actually translating, here's a few hints for you that may
3406 \begin_layout Itemize
3407 Join the documentation team! There is information on how to do that in
3408 \begin_inset Flex Code
3411 \begin_layout Plain Layout
3418 \begin_inset Flex Noun
3421 \begin_layout Plain Layout
3422 Help\SpecialChar menuseparator
3428 ), which by the way is the first document you should translate.
3431 \begin_layout Itemize
3432 Learn the typographic conventions for the language you are translating to.
3433 Typography is an ancient art and over the centuries, a great variety of
3434 conventions have developed throughout different parts of the world.
3435 Also study the professional terminology amongst typographers in your country.
3436 Inventing your own terminology will only confuse the users.
3439 (Warning! Typography is addictive!)
3442 \begin_layout Itemize
3443 Make a copy of the document.
3444 This will be your working copy.
3445 You can use this as your personal translated help-file by placing it in
3447 \begin_inset Flex Code
3450 \begin_layout Plain Layout
3457 \begin_inset Note Greyedout
3460 \begin_layout Plain Layout
3465 For a complex document with external material (images, etc.), if you make
3467 \begin_inset space \thinspace{}
3471 \begin_inset space \space{}
3474 in a temp dir, beware that the links to external material may be broken
3475 when the document is moved to a different place.
3476 The best way is to retrieve the \SpecialChar LyX
3478 \begin_inset Flex URL
3481 \begin_layout Plain Layout
3483 http://www.lyx.org/HowToUseGIT
3488 ) and to edit the doc file in place.
3496 \begin_layout Itemize
3497 Sometimes the original document (from the \SpecialChar LyX
3498 team) will be updated.
3499 Use the source viewer at
3500 \begin_inset CommandInset href
3502 name "http://www.lyx.org/trac/timeline"
3503 target "http://www.lyx.org/trac/timeline"
3507 to see what has been changed.
3508 That way you can easily see which parts of the translated document need
3512 \begin_layout Standard
3513 If you ever find an error in the original document, fix it and notify the
3514 rest of the documentation team of the changes! (You didn't forget to join
3515 the documentation team, did you?)
3518 \begin_layout Standard
3519 \begin_inset Branch OutDated
3522 \begin_layout Section
3523 International Keyboard Support
3526 \begin_layout Standard
3529 [Editor's Note: The following section is by
3537 It needs to be fixed to conform to the new Documentation Style sheet and
3538 to make use of the new v1.0 features.
3539 The whole thing also needs to be merged with the section following it.-jw
3540 It may also be badly out of date.-rh (2008)]
3543 \begin_layout Subsection
3544 Defining Own Keymaps: Keymap File Format
3547 \begin_layout Standard
3548 Let's look at a keyboard definition file a little closer.
3549 It is a plain text file defining
3552 \begin_layout Itemize
3553 key-to-key or key-to-string translations
3556 \begin_layout Itemize
3560 \begin_layout Itemize
3561 dead keys exceptions
3564 \begin_layout Standard
3565 To define key-to-key or key-to-string translation, use this command:
3568 \begin_layout Quotation
3569 \begin_inset Flex Code
3572 \begin_layout Plain Layout
3581 \begin_inset Flex Code
3584 \begin_layout Plain Layout
3593 \begin_layout Standard
3595 \begin_inset Flex Code
3598 \begin_layout Plain Layout
3604 is the key to be translated and
3605 \begin_inset Flex Code
3608 \begin_layout Plain Layout
3614 is the string to be inserted into the document.
3615 To define dead keys, use:
3618 \begin_layout Quotation
3619 \begin_inset Flex Code
3622 \begin_layout Plain Layout
3631 \begin_inset Flex Code
3634 \begin_layout Plain Layout
3643 \begin_layout Standard
3645 \begin_inset Flex Code
3648 \begin_layout Plain Layout
3654 is a keyboard key and
3655 \begin_inset Flex Code
3658 \begin_layout Plain Layout
3665 The following dead keys are supported (shortcut name is in parentheses):
3668 \begin_layout Quotation
3672 \begin_inset space \hfill{}
3678 \begin_layout Quotation
3680 \begin_inset space \hfill{}
3686 \begin_layout Quotation
3688 \begin_inset space \hfill{}
3694 \begin_layout Quotation
3696 \begin_inset space \hfill{}
3702 \begin_layout Quotation
3704 \begin_inset space \hfill{}
3710 \begin_layout Quotation
3712 \begin_inset space \hfill{}
3719 \begin_layout Plain Layout
3731 \begin_layout Quotation
3733 \begin_inset space \hfill{}
3739 \begin_layout Quotation
3741 \begin_inset space \hfill{}
3748 \begin_layout Plain Layout
3760 \begin_layout Quotation
3762 \begin_inset space \hfill{}
3768 \begin_layout Quotation
3770 \begin_inset space \hfill{}
3776 \begin_layout Quotation
3778 \begin_inset space \hfill{}
3785 \begin_layout Plain Layout
3797 \begin_layout Quotation
3799 \begin_inset space \hfill{}
3806 \begin_layout Plain Layout
3818 \begin_layout Quotation
3820 \begin_inset space \hfill{}
3826 \begin_layout Quotation
3827 hungarian umlaut (hug)
3828 \begin_inset space \hfill{}
3834 \begin_layout Quotation
3836 \begin_inset space \hfill{}
3842 \begin_layout Quotation
3844 \begin_inset space \hfill{}
3851 \begin_layout Plain Layout
3863 \begin_layout Standard
3864 Since in many international keyboards there are exceptions to what some
3865 dead keys should do, you can define them using
3868 \begin_layout Quotation
3869 \begin_inset Flex Code
3872 \begin_layout Plain Layout
3880 deadkey key outstring
3883 \begin_layout Standard
3884 For example, on Slovak keyboard, if you enter caron-o, it generates circumflex-o
3888 \begin_layout Quotation
3889 \begin_inset Flex Code
3892 \begin_layout Plain Layout
3905 \begin_layout Standard
3906 to make it work correctly.
3907 Also, you have to define as exceptions dead keys over i and j, to remove
3908 the dot from them before inserting an accent mark.
3909 I will change this when the time comes, but so far I haven't had time.
3912 \begin_layout Standard
3913 Oh, and about characters: backslash is escaped, so to enter it, you'll need
3916 \begin_inset Flex Code
3919 \begin_layout Plain Layout
3925 have different meaning.
3927 \begin_inset Flex Code
3930 \begin_layout Plain Layout
3936 marks comments, quotes start and end \SpecialChar LaTeX
3938 To enter quote, you'll need to use
3939 \begin_inset Flex Code
3942 \begin_layout Plain Layout
3951 \begin_inset Flex Code
3954 \begin_layout Plain Layout
3961 \begin_inset Flex Code
3964 \begin_layout Plain Layout
3975 \begin_layout Standard
3976 If you make a keyboard description file that works for your language, please
3977 mail it to me, so I can include it in the next keymap distribution.
3980 \begin_layout Standard
3981 More keywords will be supported in keymap configuration file in future,
3985 \begin_layout Itemize
3986 \begin_inset Flex Code
3989 \begin_layout Plain Layout
4000 \begin_inset space \hfill{}
4004 \begin_inset Flex Code
4007 \begin_layout Plain Layout
4016 \begin_layout Itemize
4017 \begin_inset Flex Code
4020 \begin_layout Plain Layout
4031 \begin_inset space \hfill{}
4035 \begin_inset Flex Code
4038 \begin_layout Plain Layout
4044 an external keymap translation program
4047 \begin_layout Standard
4048 Also, it should look into
4049 \begin_inset Flex Code
4052 \begin_layout Plain Layout
4058 file for defaults, too (for example, a
4059 \begin_inset Flex Code
4062 \begin_layout Plain Layout
4070 option to include default keyboard).
4078 \begin_layout Section
4079 International Keymap Stuff
4080 \begin_inset CommandInset label
4082 name "sec:International-Keymap-Stuff"
4089 \begin_layout Standard
4090 \begin_inset Note Note
4093 \begin_layout Plain Layout
4094 In doing the revisions on this document in March 2008, I did not look over
4095 this stuff, as I do not understand it.
4096 It would be good if someone else could do so.
4105 \begin_layout Standard
4106 The next two sections describe the
4107 \begin_inset Flex Code
4110 \begin_layout Plain Layout
4119 \begin_inset Flex Code
4122 \begin_layout Plain Layout
4130 file syntax in detail.
4131 These sections should help you design your own key map if the ones provided
4132 do not meet your needs.
4135 \begin_layout Subsection
4139 \begin_layout Standard
4143 \begin_inset Flex Code
4146 \begin_layout Plain Layout
4152 file maps keystrokes to characters or strings.
4153 As the name suggests, it sets a keyboard mapping.
4155 \begin_inset Flex Code
4158 \begin_layout Plain Layout
4169 \begin_inset Flex Code
4172 \begin_layout Plain Layout
4187 \begin_inset Flex Code
4190 \begin_layout Plain Layout
4203 \begin_inset Flex Code
4206 \begin_layout Plain Layout
4215 \begin_inset Flex Code
4218 \begin_layout Plain Layout
4226 are described in this section.
4229 \begin_layout Labeling
4230 \labelwidthstring 00.00.0000
4231 \begin_inset Flex Code
4234 \begin_layout Plain Layout
4242 Map a character to a string
4245 \begin_layout LyX-Code
4260 \begin_layout Standard
4293 the double-quote (")
4310 must be escaped with a preceding backslash (
4321 \begin_layout Standard
4323 \begin_inset Flex Noun
4326 \begin_layout Plain Layout
4334 statement to cause the symbol
4335 \begin_inset Flex Noun
4338 \begin_layout Plain Layout
4346 to be output for the keystroke
4347 \begin_inset Flex Noun
4350 \begin_layout Plain Layout
4361 \begin_layout LyX-Code
4367 \begin_layout Labeling
4368 \labelwidthstring 00.00.0000
4369 \begin_inset Flex Code
4372 \begin_layout Plain Layout
4380 Specify an accent character
4383 \begin_layout LyX-Code
4392 \begin_layout Standard
4393 This will make the cha
4431 This is the dead key
4435 \begin_layout Plain Layout
4442 refers to a key that does not produce a character by itself, but when followed
4443 with another key, produces the desired accent character.
4444 For example, a German characte
4446 r with an umlaut like
4456 can be produced in this manner.
4465 \begin_layout Standard
4478 and then another key not in
4495 followed by the other, not allowed key, as output.
4499 \begin_inset Flex Noun
4502 \begin_layout Plain Layout
4510 cancels a dead key, so if
4521 \begin_inset Flex Noun
4524 \begin_layout Plain Layout
4533 , the cursor will not go one position backwards but will instead cancel
4549 might have had on the next keystroke.
4553 \begin_layout Standard
4554 The following example specifies that the character ' is to be an acute accent,
4555 allowed on the characters a, e, i, o, u, A, E, I, O, and U:
4558 \begin_layout LyX-Code
4561 kmod ' acute aeiouAEIOU
4564 \begin_layout Labeling
4565 \labelwidthstring 00.00.0000
4566 \begin_inset Flex Code
4569 \begin_layout Plain Layout
4575 Specify an exception to the accent character
4578 \begin_layout LyX-Code
4587 \begin_layout Standard
4588 This defines an exce
4629 have been assigned a keystroke with a previous
4632 \begin_inset Flex Code
4635 \begin_layout Plain Layout
4659 must not belong in the
4706 If such a declaration does not exist in
4714 \begin_inset Flex Code
4717 \begin_layout Plain Layout
4751 \begin_inset Flex Code
4754 \begin_layout Plain Layout
4768 \begin_layout Standard
4769 The following command produces causes äi to be produced when you enter acute-i
4773 \begin_layout LyX-Code
4787 \begin_layout Labeling
4788 \labelwidthstring 00.00.0000
4789 \begin_inset Flex Code
4792 \begin_layout Plain Layout
4798 Combine two accent characters
4801 \begin_layout LyX-Code
4807 accent1 accent2 allowed
4810 \begin_layout Standard
4811 This one is getting pretty esoteric.
4812 It allows you to combine the effect
4868 \begin_inset Flex Code
4871 \begin_layout Plain Layout
4899 \begin_layout Standard
4900 Consider this example from the
4901 \begin_inset Flex Code
4904 \begin_layout Plain Layout
4915 \begin_layout LyX-Code
4918 kmod ; acute aeioyvhAEIOYVH
4922 kcomb acute umlaut iyIY
4925 \begin_layout Standard
4926 This allows you to press
4927 \begin_inset Flex Noun
4930 \begin_layout Plain Layout
4938 and get the effect of
4939 \begin_inset Flex Code
4942 \begin_layout Plain Layout
4961 in this case cancels the last dead key, so if you press
4962 \begin_inset Flex Noun
4965 \begin_layout Plain Layout
4974 \begin_inset Flex Code
4977 \begin_layout Plain Layout
4990 \begin_layout Subsection
4994 \begin_layout Standard
4996 \begin_inset Flex Code
4999 \begin_layout Plain Layout
5007 mapping is performed, a
5008 \begin_inset Flex Code
5011 \begin_layout Plain Layout
5021 file maps the strings that the symbols generate to characters in the current
5023 The \SpecialChar LyX
5024 distribution currently includes at least the
5025 \begin_inset Flex Code
5028 \begin_layout Plain Layout
5037 \begin_inset Flex Code
5040 \begin_layout Plain Layout
5051 \begin_layout Standard
5053 \begin_inset Flex Code
5056 \begin_layout Plain Layout
5064 file is a sequence of declarations of the form
5067 \begin_layout LyX-Code
5080 \begin_layout Standard
5081 For example, in order to map
5082 \begin_inset Flex Noun
5085 \begin_layout Plain Layout
5095 to the corresponding character in the iso-8859-1 set (233), the following
5099 \begin_layout LyX-Code
5107 \begin_layout Standard
5109 \begin_inset Flex Code
5112 \begin_layout Plain Layout
5121 \begin_inset Flex Code
5124 \begin_layout Plain Layout
5142 the same character can apply to more than one string.
5144 \begin_inset Flex Code
5147 \begin_layout Plain Layout
5158 \begin_layout LyX-Code
5170 \begin_inset Newline newline
5186 \begin_layout Standard
5188 cannot find a mapping for the string produced by the keystroke or a
5189 deadkey sequence, it will check if it looks like an accented char and try
5190 to draw an accent over the character on screen.
5193 \begin_layout Subsection
5197 \begin_layout Standard
5198 There is a second way to add support for international characters through
5199 so-called dead-keys.
5200 A dead-key works in combination with a letter to produce an accented character.
5201 Here, we'll explain how to create a really simple dead-key to illustrate
5205 \begin_layout Standard
5206 Suppose you happen to need the circumflex character,
5207 \begin_inset Quotes eld
5211 \begin_inset Quotes erd
5216 \begin_inset Flex Noun
5219 \begin_layout Plain Layout
5226 \begin_inset space ~
5230 \begin_inset Flex Noun
5233 \begin_layout Plain Layout
5239 ] to the \SpecialChar LyX
5241 \begin_inset Flex Code
5244 \begin_layout Plain Layout
5251 \begin_inset Flex Code
5254 \begin_layout Plain Layout
5261 Now, whenever you type the
5262 \begin_inset Flex Noun
5265 \begin_layout Plain Layout
5271 -key followed by a letter, that letter will have a circumflex accent on
5273 For example, the sequence
5274 \begin_inset Quotes eld
5278 \begin_inset Flex Noun
5281 \begin_layout Plain Layout
5288 \begin_inset Quotes erd
5291 produces the letter:
5292 \begin_inset Quotes eld
5296 \begin_inset Quotes erd
5300 If you tried to type
5301 \begin_inset Quotes eld
5305 \begin_inset Flex Noun
5308 \begin_layout Plain Layout
5315 \begin_inset Quotes erd
5318 , however, \SpecialChar LyX
5319 will complain with a beep, since a
5320 \begin_inset Quotes eld
5324 \begin_inset Flex Noun
5327 \begin_layout Plain Layout
5334 \begin_inset Quotes erd
5337 never takes a circumflex accent.
5339 \begin_inset Flex Noun
5342 \begin_layout Plain Layout
5348 after a dead-key produces the bare-accent.
5349 Please note this last point! If you bind a key to a dead-key, you'll need
5350 to rebind the character on that key to yet another key.
5352 \begin_inset Flex Noun
5355 \begin_layout Plain Layout
5361 to a cedilla is a bad idea, since you'll only get cedillas instead of commas.
5364 \begin_layout Standard
5365 One common way to bind dead-keys is to use
5366 \begin_inset Flex Noun
5369 \begin_layout Plain Layout
5376 \begin_inset Flex Noun
5379 \begin_layout Plain Layout
5386 \begin_inset Flex Noun
5389 \begin_layout Plain Layout
5395 in combination with an accent, like
5396 \begin_inset Quotes eld
5400 \begin_inset Flex Noun
5403 \begin_layout Plain Layout
5410 \begin_inset Quotes erd
5414 \begin_inset Quotes eld
5418 \begin_inset Flex Noun
5421 \begin_layout Plain Layout
5428 \begin_inset Quotes erd
5432 \begin_inset Quotes eld
5436 \begin_inset Flex Noun
5439 \begin_layout Plain Layout
5446 \begin_inset Quotes erd
5450 Another way involves using
5451 \begin_inset Flex Code
5454 \begin_layout Plain Layout
5461 \begin_inset Flex Code
5464 \begin_layout Plain Layout
5470 to set up the special
5471 \begin_inset Flex Code
5474 \begin_layout Plain Layout
5482 \begin_inset Flex Code
5485 \begin_layout Plain Layout
5491 acts in some ways just like
5492 \begin_inset Flex Noun
5495 \begin_layout Plain Layout
5501 and permits you to bind keys to accented characters.
5502 You can also turn keys into dead-keys by binding them to something like
5504 \begin_inset Flex Code
5507 \begin_layout Plain Layout
5513 and then binding this symbolic key to the corresponding \SpecialChar LyX
5518 \begin_layout Plain Layout
5523 : This is exactly what I do in my
5524 \begin_inset Flex Code
5527 \begin_layout Plain Layout
5534 \begin_inset Flex Code
5537 \begin_layout Plain Layout
5545 \begin_inset Flex Noun
5548 \begin_layout Plain Layout
5550 \begin_inset space ~
5559 \begin_inset Flex Code
5562 \begin_layout Plain Layout
5568 and a bunch of these
5569 \begin_inset Quotes eld
5573 \begin_inset Flex Code
5576 \begin_layout Plain Layout
5583 \begin_inset Quotes erd
5586 symbolic keys bound such things as
5587 \begin_inset Flex Noun
5590 \begin_layout Plain Layout
5592 \begin_inset space ~
5601 \begin_inset Flex Noun
5604 \begin_layout Plain Layout
5606 \begin_inset space ~
5615 This is how I produce my accented characters.
5620 You can make just about anything into the
5621 \begin_inset Flex Code
5624 \begin_layout Plain Layout
5631 \begin_inset Flex Noun
5634 \begin_layout Plain Layout
5640 keys, a spare function key, etc.
5641 As for the \SpecialChar LyX
5642 commands that produce accents, check the entry for
5643 \begin_inset Flex Code
5646 \begin_layout Plain Layout
5657 You'll find the complete list there.
5660 \begin_layout Subsection
5661 Saving your Language Configuration
5664 \begin_layout Standard
5665 You can edit your preferences so that your desired language environment
5666 is automatically configured when \SpecialChar LyX
5668 \begin_inset Flex Noun
5671 \begin_layout Plain Layout
5672 Edit\SpecialChar menuseparator
5681 \begin_layout Chapter
5682 Installing New Document Classes, Layouts, and Templates
5683 \begin_inset CommandInset label
5685 name "cha:Installing-New-Document"
5690 \begin_inset Argument 1
5693 \begin_layout Plain Layout
5694 Installing New Document Classes
5702 \begin_layout Standard
5703 In this chapter, we describe the procedures for creating and installing
5704 new \SpecialChar LyX
5705 layout and template files, as well as offer a refresher on correctly
5706 installing new \SpecialChar LaTeX
5711 \begin_layout Standard
5712 First, let us a say a few words about how one ought to think about the relation
5713 between \SpecialChar LyX
5714 and \SpecialChar LaTeX
5716 The thing to understand is that, in a certain sense, \SpecialChar LyX
5717 doesn't know anything
5718 about \SpecialChar LaTeX
5720 Indeed, from \SpecialChar LyX
5721 's point of view, \SpecialChar LaTeX
5722 is just one of several
5723 \begin_inset Quotes eld
5727 \begin_inset Quotes erd
5730 in which it is capable of producing output.
5731 Other such formats are DocBook, plaintext, and XHTML.
5733 is, of course, a particularly important format, but very little of the
5734 information \SpecialChar LyX
5735 has about \SpecialChar LaTeX
5736 is actually contained in the program itself.
5740 \begin_layout Plain Layout
5741 Some commands are sufficiently complex that they are
5742 \begin_inset Quotes eld
5746 \begin_inset Quotes erd
5749 into \SpecialChar LyX
5751 But the developers generally regard this as a Bad Thing.
5756 Rather, that information, even for the standard classes like
5757 \begin_inset Flex Code
5760 \begin_layout Plain Layout
5766 , is contained in `layout files'.
5767 Similarly, \SpecialChar LyX
5768 itself does not know much about DocBook or XHTML.
5769 What it knows is contained in layout files.
5772 \begin_layout Standard
5773 You can think of the layout file for a given document class as a translation
5774 manual between \SpecialChar LyX
5775 constructs—paragraphs with their corresponding styles,
5776 certain sorts of insets, etc—and the corresponding \SpecialChar LaTeX
5779 Almost everything \SpecialChar LyX
5781 \begin_inset Flex Code
5784 \begin_layout Plain Layout
5790 , for example, is contained in the file
5791 \begin_inset Flex Code
5794 \begin_layout Plain Layout
5800 and in various other files it includes.
5801 For this reason, anyone intending to write layout files should plan to
5802 study the existing files.
5803 A good place to start is with
5804 \begin_inset Flex Code
5807 \begin_layout Plain Layout
5813 , which is included in
5814 \begin_inset Flex Code
5817 \begin_layout Plain Layout
5824 \begin_inset Flex Code
5827 \begin_layout Plain Layout
5833 , and many of the other layout files for document classes.
5834 This file is where sections and the like are defined:
5835 \begin_inset Flex Code
5838 \begin_layout Plain Layout
5844 tells \SpecialChar LyX
5845 how paragraphs that are marked with the Section, Subsection, etc,
5846 styles can be translated into corresponding \SpecialChar LaTeX
5847 , DocBook, and XHTML commands
5850 \begin_inset Flex Code
5853 \begin_layout Plain Layout
5859 file basically just includes several of these
5860 \begin_inset Flex Code
5863 \begin_layout Plain Layout
5872 \begin_layout Standard
5873 Defining the \SpecialChar LyX
5875 correspondence is not the only thing layout files do, though.
5876 Their other job is to define how the \SpecialChar LyX
5877 constructs themselves will appear
5879 The fact that layout files have these two jobs is often a source of confusion,
5880 because they are completely separate.
5881 Telling \SpecialChar LyX
5882 how to translate a certain paragraph style into \SpecialChar LaTeX
5885 how to display it; conversely, telling \SpecialChar LyX
5886 how to display a certain paragraph
5887 style does not tell \SpecialChar LyX
5888 how to translate it into \SpecialChar LaTeX
5889 (let alone tell \SpecialChar LaTeX
5892 So, in general, when you define a new \SpecialChar LyX
5893 construct, you must always do two
5894 quite separate things: (i)
5895 \begin_inset space ~
5898 tell \SpecialChar LyX
5899 how to translate it into \SpecialChar LaTeX
5901 \begin_inset space ~
5904 tell \SpecialChar LyX
5908 \begin_layout Standard
5909 Much the same is true, of course, as regards \SpecialChar LyX
5910 's other backend formats, though
5911 XHTML is in some ways different, because in that case \SpecialChar LyX
5916 able, to some extent, to use information about how it should display a
5917 paragraph on the screen to output information (in the form of CSS) about
5918 how the paragraph should be displayed in a browser.
5919 Even in this case, however, the distinction between what \SpecialChar LyX
5921 and how things are rendered externally remains in force, and the two can
5922 be controlled separately.
5924 \begin_inset CommandInset ref
5926 reference "sec:Tags-for-XHTML"
5933 \begin_layout Section
5934 Installing new \SpecialChar LaTeX
5938 \begin_layout Standard
5939 Some installations may not include a \SpecialChar LaTeX
5940 package or class file that you would
5941 like to use within \SpecialChar LyX
5943 For example, you might need Foil\SpecialChar TeX
5944 , a package for preparing slides for overhead
5946 Modern \SpecialChar LaTeX
5947 distributions like \SpecialChar TeX
5948 Live (2008 or newer) or MiK\SpecialChar TeX
5949 provide a user interface
5950 for installing such packages.
5951 For example, with MiK\SpecialChar TeX
5952 , you start the program
5953 \begin_inset Quotes eld
5957 \begin_inset space ~
5961 \begin_inset Quotes erd
5964 to get a list of available packages.
5965 To install one of them, right click on it or use the corresponding toolbar
5969 \begin_layout Standard
5970 If your \SpecialChar LaTeX
5971 distribution does not provide such a `package manager', or if the
5972 package is not available from your distribution, then follow these steps
5973 to install it manually:
5976 \begin_layout Enumerate
5977 Get the package from
5978 \begin_inset CommandInset href
5981 target "http://www.ctan.org/"
5988 \begin_layout Enumerate
5989 If the package contains a file with the ending
5990 \begin_inset Quotes eld
5994 \begin_inset Flex Code
5997 \begin_layout Plain Layout
6004 \begin_inset Quotes erd
6007 (is the case for Foil\SpecialChar TeX
6008 ) then open a console, change to the folder of this
6009 file and execute the command
6010 \begin_inset Flex Code
6013 \begin_layout Plain Layout
6020 You have now unpacked the package and have all files to install it.
6021 Most \SpecialChar LaTeX
6022 -packages are not packed and you can skip this step.
6025 \begin_layout Enumerate
6026 Now you need to decide if the package should be available for all users
6031 \begin_layout Enumerate
6032 On *nix systems (Linux, OSX, etc.), if you want the new package to be available
6033 for all users on your system, then install it in your `local' \SpecialChar TeX
6035 install it in your own `user' \SpecialChar TeX
6037 Where these trees should be created, if they do not already exist, depends
6039 To find this out, look in the file
6040 \begin_inset Flex Code
6043 \begin_layout Plain Layout
6053 \begin_layout Plain Layout
6054 This is usually in the directory
6055 \begin_inset Flex Code
6058 \begin_layout Plain Layout
6064 , though you can execute the command
6065 \begin_inset Flex Code
6068 \begin_layout Plain Layout
6079 The location of the `local' \SpecialChar TeX
6080 tree is defined by the
6081 \begin_inset Flex Code
6084 \begin_layout Plain Layout
6090 variable; this is usually somewhere like
6091 \begin_inset Flex Code
6094 \begin_layout Plain Layout
6095 /usr/local/share/texmf
6100 or /usr/local/texlive/XXXX where XXXX is the year of the installed \SpecialChar TeX
6103 The location of the `user' \SpecialChar TeX
6105 \begin_inset Flex Code
6108 \begin_layout Plain Layout
6115 \begin_inset Flex Code
6118 \begin_layout Plain Layout
6125 \begin_inset Flex Code
6128 \begin_layout Plain Layout
6138 (If these variables are not predefined, you have to define them.) You'll
6139 probably need root permissions to create or modify the `local' tree, but
6140 not for your `user' tree.
6141 \begin_inset Newline newline
6144 In general, it is recommended to install in the user tree because your user
6145 will not be modified or even overwritten when you upgrade your system.
6146 It will typically also be backed up together with everything else when
6147 you backup your home directory (which, of course, you do on a regular basis).
6150 \begin_layout Enumerate
6151 On Windows, if you want the new package to be available for all users on
6152 your system, change to the folder where \SpecialChar LaTeX
6153 is installed and then change to
6155 \begin_inset Flex Code
6158 \begin_layout Plain Layout
6169 (For MiK\SpecialChar TeX
6170 , this would be by default the folder
6171 \begin_inset Flex Code
6174 \begin_layout Plain Layout
6192 \begin_layout Plain Layout
6193 Note that this will be the correct path only on English installations.
6194 On a German one, it would be
6195 \begin_inset Flex Code
6198 \begin_layout Plain Layout
6212 , and similarly for other languages.
6217 Create there a new folder
6218 \begin_inset Flex Code
6221 \begin_layout Plain Layout
6227 and copy all files of the package into it.
6229 \begin_inset Newline newline
6232 If the package should only available for you or you don't have admin permissions
6233 , do the same, but in the local \SpecialChar LaTeX
6236 \begin_inset space \thinspace{}
6239 g., for MiK\SpecialChar TeX
6241 \begin_inset space ~
6244 2.8 under Windows XP, this would be the folder:
6245 \begin_inset Newline newline
6251 \begin_inset Flex Code
6254 \begin_layout Plain Layout
6257 Documents and Settings
6269 \begin_inset Newline newline
6275 \begin_inset Phantom HPhantom
6278 \begin_layout Plain Layout
6289 \begin_inset Flex Code
6292 \begin_layout Plain Layout
6305 \begin_inset Newline newline
6308 On Vista, it would be:
6309 \begin_inset Newline newline
6313 \begin_inset Flex Code
6316 \begin_layout Plain Layout
6342 \begin_layout Enumerate
6343 Now one only need to tell \SpecialChar LaTeX
6344 that there are new files.
6345 This depends on the used \SpecialChar LaTeX
6350 \begin_layout Enumerate
6351 For \SpecialChar TeX
6352 Live execute the command
6353 \begin_inset Flex Code
6356 \begin_layout Plain Layout
6363 If you installed the package for all users, then you will probably need
6364 to have root permissions for that.
6367 \begin_layout Enumerate
6368 For MiK\SpecialChar TeX
6369 , if you have installed the package for all users, start the program
6371 \begin_inset Quotes eld
6375 \begin_inset space ~
6379 \begin_inset Quotes erd
6382 and press the button marked
6383 \begin_inset Quotes eld
6387 \begin_inset Quotes erd
6391 Otherwise start the program
6392 \begin_inset Quotes eld
6396 \begin_inset Quotes erd
6403 \begin_layout Enumerate
6404 Finally, you need to tell \SpecialChar LyX
6405 that there are new packages available.
6406 So, in \SpecialChar LyX
6408 \begin_inset Flex Noun
6411 \begin_layout Plain Layout
6414 \SpecialChar menuseparator
6420 and then restart \SpecialChar LyX
6424 \begin_layout Standard
6425 Now the package is installed.
6426 In our example, the document class
6427 \begin_inset Flex Code
6430 \begin_layout Plain Layout
6432 \begin_inset space ~
6440 will now be available under
6441 \begin_inset Flex Noun
6444 \begin_layout Plain Layout
6445 Document\SpecialChar menuseparator
6446 Settings\SpecialChar menuseparator
6456 \begin_layout Standard
6457 If you would like to use a \SpecialChar LaTeX
6458 document class that is not even listed in the
6460 \begin_inset Flex Noun
6463 \begin_layout Plain Layout
6464 Document\SpecialChar menuseparator
6465 Settings\SpecialChar menuseparator
6471 , then you need to create a `layout' file for it.
6472 That is the topic of the next section.
6475 \begin_layout Section
6476 Types of layout files
6479 \begin_layout Standard
6480 This section describes the various sorts of \SpecialChar LyX
6481 files that contain layout informati
6483 These files describe various paragraph and character styles, determining
6484 how \SpecialChar LyX
6485 should display them and how they should be translated into \SpecialChar LaTeX
6487 XHTML, or whatever output format is being used.
6491 \begin_layout Standard
6492 We shall try to provide a thorough description of the process of writing
6494 However, there are so many different types of documents supported even
6495 by just \SpecialChar LaTeX
6496 that we can't hope to cover every different possibility or problem
6497 you might encounter.
6498 The \SpecialChar LyX
6499 users' list is frequented by people with lots of experience with layout
6500 design who are willing to share what they've learned, so please feel free
6501 to ask questions there.
6504 \begin_layout Standard
6505 As you prepare to write a new layout, it is extremely helpful to look at
6506 the layouts distributed with \SpecialChar LyX
6508 If you write a \SpecialChar LyX
6509 layout for a \SpecialChar LaTeX
6510 document class that might also be used by
6511 others, or write a module that might be useful to others, then you should
6512 consider posting your layout to the
6513 \begin_inset CommandInset href
6515 name "layout section on the LyX wiki"
6516 target "http://wiki.lyx.org/Layouts/Layouts"
6520 or even to the \SpecialChar LyX
6521 developers' list, so that it might be included in \SpecialChar LyX
6526 \begin_layout Plain Layout
6527 Note that \SpecialChar LyX
6528 is licensed under the General Public License, so any material
6529 that is contributed to \SpecialChar LyX
6530 must be similarly licensed.
6538 \begin_layout Subsection
6540 \begin_inset CommandInset label
6542 name "subsec:Layout-modules"
6549 \begin_layout Standard
6550 We have spoken to this point about `layout files'.
6551 But there are different sorts of files that contain layout information.
6552 Layout files, strictly so called, have the
6553 \begin_inset Flex Code
6556 \begin_layout Plain Layout
6562 extension and provide \SpecialChar LyX
6563 with information about document classes.
6564 Since \SpecialChar LyX
6565 1.6 layout information can also be contained in layout
6570 \begin_inset Flex Code
6573 \begin_layout Plain Layout
6580 Modules are to \SpecialChar LaTeX
6581 packages much as layouts are to \SpecialChar LaTeX
6582 classes, and some modules—such
6584 \begin_inset Flex Code
6587 \begin_layout Plain Layout
6593 module—specifically provide support for one package.
6594 In a sense, layout modules are similar to included
6598 \begin_layout Plain Layout
6599 These can have any extension, but by convention have the
6600 \begin_inset Flex Code
6603 \begin_layout Plain Layout
6615 \begin_inset Flex Code
6618 \begin_layout Plain Layout
6624 —in that modules are not specific to a given document class but may be used
6625 with many different classes.
6626 The difference is that using an included file with
6627 \begin_inset Flex Code
6630 \begin_layout Plain Layout
6636 requires editing that file.
6637 Modules, by contrast, are selected in the
6638 \begin_inset Flex Noun
6641 \begin_layout Plain Layout
6642 Document\SpecialChar menuseparator
6651 \begin_layout Standard
6652 Building modules is the easiest way to get started with layout editing,
6653 since it can be as simple as adding a single new paragraph style or flex
6655 But modules may, in principle, contain anything a layout file can contain.
6658 \begin_layout Standard
6659 After creating a new module and copying it to the
6660 \begin_inset Flex Code
6663 \begin_layout Plain Layout
6669 folder, you will need to reconfigure and then restart \SpecialChar LyX
6672 However, changes you make to the module will be seen immediately, if you
6674 \begin_inset Flex Noun
6677 \begin_layout Plain Layout
6678 Document\SpecialChar menuseparator
6684 , highlight something, and then hit
6685 \begin_inset Quotes eld
6689 \begin_inset Quotes erd
6695 It is strongly recommended that you save your work before doing this
6700 it is strongly recommended that you not attempt to edit modules while simultaneo
6701 usly working on actual documents
6704 Though of course the developers strive to keep \SpecialChar LyX
6705 stable in such situations,
6706 syntax errors and the like in your module file could cause strange behavior.
6709 \begin_layout Subsubsection
6713 \begin_layout Standard
6714 Modules are to \SpecialChar LyX
6715 as packages are to \SpecialChar LaTeX
6717 Sometimes, however, you find yourself wanting a specific inset or character
6718 style just for one document and writing a module that will also be available
6719 to other documents makes little sense.
6720 What you need is \SpecialChar LyX
6722 \begin_inset Quotes eld
6726 \begin_inset Quotes erd
6732 \begin_layout Standard
6733 You will find it under
6735 Document\SpecialChar menuseparator
6736 Settings\SpecialChar menuseparator
6740 The large text box allows you to enter anything that you might enter in
6741 a layout file or module.
6742 You can think of a document's local layout, in fact, as a module that belongs
6744 So, in particular, you must enter a
6745 \begin_inset Flex Code
6748 \begin_layout Plain Layout
6755 Any format is acceptable, but one would normally use the format current
6757 (In \SpecialChar LyX
6758 2.2, the current layout format is 60.)
6761 \begin_layout Standard
6762 When you have entered something in the
6763 \begin_inset Flex Code
6766 \begin_layout Plain Layout
6772 pane, \SpecialChar LyX
6774 \begin_inset Quotes eld
6778 \begin_inset Quotes erd
6781 button at the bottom.
6782 Clicking this button will cause \SpecialChar LyX
6783 to determine whether what you have entered
6784 is valid layout information for the chosen format.
6786 will report the result but, unfortunately, will not tell you what errors
6787 there might have been.
6788 These will be written to the terminal, however, if \SpecialChar LyX
6789 is started from a terminal.
6790 You will not be permitted to save your local layout until you have entered
6794 \begin_layout Standard
6795 The warnings at the end of the previous section apply here, too.
6796 Do not play with local layout while you are actually working, especially
6797 if you have not saved your document.
6798 That said, using local layout with a test document can be a very convenient
6799 way to try out layout ideas, or even to start developing a module.
6802 \begin_layout Subsection
6804 \begin_inset Flex Noun
6807 \begin_layout Plain Layout
6816 \begin_layout Standard
6817 There are two situations you are likely to encounter when wanting to support
6818 a new \SpecialChar LaTeX
6819 document class, involving style (
6820 \begin_inset Flex Code
6823 \begin_layout Plain Layout
6829 ) files and \SpecialChar LaTeX2e
6831 \begin_inset Flex Code
6834 \begin_layout Plain Layout
6841 Supporting a style file is usually fairly easy.
6842 Supporting a new class file is a bit harder.
6843 We'll discuss the former in this section and the latter in the next.
6844 Similar remarks apply, of course, if you want to support a new DocBook
6848 \begin_layout Standard
6849 The easier case is the one in which your new document class is provided
6850 as a style file that is to be used in conjunction with an already supported
6852 For the sake of the example, we'll assume that the style file is called
6854 \begin_inset Flex Noun
6857 \begin_layout Plain Layout
6863 and that it is meant to be used with
6864 \begin_inset Flex Noun
6867 \begin_layout Plain Layout
6873 , which is a standard class.
6877 \begin_layout Standard
6878 Start by copying the existing class's layout file into your local directory:
6882 \begin_layout Plain Layout
6883 Of course, which directory is your local directory will vary by platform,
6884 and \SpecialChar LyX
6885 allows you to specify your local directory on startup, too, using
6887 \begin_inset Flex Code
6890 \begin_layout Plain Layout
6904 \begin_layout LyX-Code
6905 cp report.layout ~/.lyx/layouts/myclass.layout
6908 \begin_layout Standard
6910 \begin_inset Flex Code
6913 \begin_layout Plain Layout
6919 and change the line:
6922 \begin_layout LyX-Code
6925 DeclareLaTeXClass{report}
6928 \begin_layout Standard
6932 \begin_layout LyX-Code
6935 DeclareLaTeXClass[report, myclass.sty]{report (myclass)}
6938 \begin_layout Standard
6942 \begin_layout LyX-Code
6944 \begin_inset Newline newline
6950 \begin_inset Newline newline
6956 \begin_layout Standard
6957 near the top of the file.
6960 \begin_layout Standard
6961 Start \SpecialChar LyX
6963 \begin_inset Flex Noun
6966 \begin_layout Plain Layout
6967 Tools\SpecialChar menuseparator
6974 Then restart \SpecialChar LyX
6975 and try creating a new document.
6977 \begin_inset Flex Noun
6980 \begin_layout Plain Layout
6986 " as a document class option in the
6987 \begin_inset Flex Noun
6990 \begin_layout Plain Layout
6991 Document\SpecialChar menuseparator
6998 It is likely that some of the sectioning commands and such in your new
6999 class will work differently from how they worked in the base class—
7000 \begin_inset Flex Code
7003 \begin_layout Plain Layout
7009 in this example—so you can fiddle around with the settings for the different
7010 sections if you wish.
7011 The layout information for sections is contained in
7012 \begin_inset Flex Code
7015 \begin_layout Plain Layout
7021 , but you do not need to copy and change this file.
7022 Instead, you can simply add your changes to your layout file, after the
7024 \begin_inset Flex Code
7027 \begin_layout Plain Layout
7033 , which itself includes
7034 \begin_inset Flex Code
7037 \begin_layout Plain Layout
7044 For example, you might add these lines:
7047 \begin_layout LyX-Code
7051 \begin_layout LyX-Code
7055 \begin_layout LyX-Code
7059 \begin_layout LyX-Code
7063 \begin_layout LyX-Code
7067 \begin_layout Standard
7068 to change the font for chapter headings to sans-serif.
7069 This will override (or, in this case, add to) the existing declaration
7070 for the Chapter style.
7074 \begin_layout Standard
7075 Your new package may also provide commands or environments not present in
7077 In this case, you will want to add these to the layout file.
7079 \begin_inset CommandInset ref
7081 reference "sec:TextClass"
7085 for information on how to do so.
7088 \begin_layout Standard
7090 \begin_inset Flex Noun
7093 \begin_layout Plain Layout
7099 can be used with several different document classes, and even if it cannot,
7100 you might find it easiest just to write a module that you can load with
7102 The simplest possible such module would be:
7105 \begin_layout LyX-Code
7108 DeclareLyXModule{My Package}
7111 \begin_layout LyX-Code
7115 \begin_layout LyX-Code
7116 #Support for mypkg.sty.
7119 \begin_layout LyX-Code
7121 \begin_inset Newline newline
7127 \begin_layout LyX-Code
7129 \begin_inset Newline newline
7135 \begin_layout LyX-Code
7137 \begin_inset Newline newline
7143 \begin_inset Newline newline
7149 \begin_layout Standard
7150 A more complex module might modify the behavior of some existing constructs
7151 or define some new ones.
7153 \begin_inset CommandInset ref
7155 reference "sec:TextClass"
7162 \begin_layout Subsection
7164 \begin_inset Flex Noun
7167 \begin_layout Plain Layout
7176 \begin_layout Standard
7177 There are two possibilities here.
7178 One is that the class file is itself based upon an existing document class.
7179 For example, many thesis classes are based upon
7180 \begin_inset Flex Noun
7183 \begin_layout Plain Layout
7190 To see whether yours is, look for a line like
7193 \begin_layout LyX-Code
7199 \begin_layout Standard
7201 If so, then you may proceed largely as in the previous section, though
7203 \begin_inset Flex Code
7206 \begin_layout Plain Layout
7207 Declare\SpecialChar LaTeX
7213 line will be different.
7214 If your new class is
7215 \begin_inset Flex Code
7218 \begin_layout Plain Layout
7224 and it is based upon
7225 \begin_inset Flex Code
7228 \begin_layout Plain Layout
7234 , then the line should read:
7238 \begin_layout Plain Layout
7239 And it will be easiest if you save the file to
7240 \begin_inset Flex Code
7243 \begin_layout Plain Layout
7250 assumes that the document class has the same name as the layout file.
7259 \begin_layout LyX-Code
7262 DeclareLaTeXClass[thesis,book]{thesis}
7265 \begin_layout Standard
7266 If, on the other hand, the new class is not based upon an existing class,
7267 you will probably have to
7268 \begin_inset Quotes eld
7272 \begin_inset Quotes erd
7276 We strongly suggest copying an existing layout file which uses a similar
7278 class and then modifying it, if you can do so.
7279 At least use an existing file as a starting point so you can find out what
7280 items you need to worry about.
7281 Again, the specifics are covered below.
7284 \begin_layout Subsection
7286 \begin_inset CommandInset label
7288 name "subsec:Creating-Templates"
7295 \begin_layout Standard
7296 Once you have written a layout file for a new document class, you might
7297 want to consider writing a
7302 A template acts as a kind of tutorial for your layout, showing how it might
7303 be used, though containing dummy content.
7304 You can of course look at the various templates included with \SpecialChar LyX
7308 \begin_layout Standard
7309 Templates are created just like usual documents: using \SpecialChar LyX
7311 The only difference is that usual documents contain all possible settings,
7312 including the font scheme and the paper size.
7313 Usually a user doesn't want a template to overwrite his preferred settings
7314 for such parameters.
7315 For that reason, the designer of a template should remove the corresponding
7317 \begin_inset Flex Code
7320 \begin_layout Plain Layout
7329 \begin_inset Flex Code
7332 \begin_layout Plain Layout
7340 from the template \SpecialChar LyX
7342 This can be done with any simple text-editor, for example
7343 \begin_inset Flex Code
7346 \begin_layout Plain Layout
7353 \begin_inset Flex Code
7356 \begin_layout Plain Layout
7365 \begin_layout Standard
7366 Put the edited template files you create in
7367 \begin_inset Flex Code
7370 \begin_layout Plain Layout
7376 , copy the ones you use from the global template directory in
7377 \begin_inset Flex Code
7380 \begin_layout Plain Layout
7386 to the same place, and redefine the template path in the
7387 \begin_inset Flex Noun
7390 \begin_layout Plain Layout
7391 Tools\SpecialChar menuseparator
7392 Preferences\SpecialChar menuseparator
7401 \begin_layout Standard
7402 Note, by the way, that there is a template which has a particular meaning:
7404 \begin_inset Flex Code
7407 \begin_layout Plain Layout
7414 This template is loaded every time you create a new document with
7415 \begin_inset Flex Noun
7418 \begin_layout Plain Layout
7419 File\SpecialChar menuseparator
7425 in order to provide useful defaults.
7426 To create this template from inside \SpecialChar LyX
7427 , all you have to do is to open a document
7428 with the correct settings, and use the
7429 \begin_inset Flex Noun
7432 \begin_layout Plain Layout
7433 Save as Document Defaults
7441 \begin_layout Subsection
7442 Upgrading old layout files
7445 \begin_layout Standard
7446 The format of layout files changes with each \SpecialChar LyX
7447 release, so old layout files
7448 need to be converted to the new format.
7450 reads a layout file in an older format, it automatically calls the
7452 \begin_inset Flex Code
7455 \begin_layout Plain Layout
7461 to convert it to a temporary file in current format.
7462 The original file is left untouched.
7463 If you use the layout file often, then, you may want to convert it permanently,
7464 so that \SpecialChar LyX
7465 does not have to do so itself every time.
7466 To do this, you can call the converter manually:
7469 \begin_layout Enumerate
7471 \begin_inset Flex Code
7474 \begin_layout Plain Layout
7481 \begin_inset Flex Code
7484 \begin_layout Plain Layout
7493 \begin_layout Enumerate
7495 \begin_inset Newline newline
7499 \begin_inset Flex Code
7502 \begin_layout Plain Layout
7503 python LyXDir/scripts/layout2layout.py myclass.old myclass.layout
7509 \begin_inset Newline newline
7513 \begin_inset Flex Code
7516 \begin_layout Plain Layout
7522 is the name of your \SpecialChar LyX
7526 \begin_layout Standard
7527 Note that manual conversion does not affect included files, so these will
7528 have to be converted separately.
7531 \begin_layout Section
7532 \begin_inset CommandInset label
7534 name "sec:TextClass"
7538 The layout file format
7541 \begin_layout Standard
7542 The following sections describe how layout files are structured and written.
7543 Our advice is to go slowly, save and test often.
7544 It is really not that hard, except that the multitude of options can become
7545 overwhelming, especially if you try to check out too many at once.
7546 It becomes easier if you use existing layouts of \SpecialChar LyX
7547 as examples/reference
7548 or if you modify an existing layout to your needs.
7551 \begin_layout Standard
7552 Note that all the tags used in layout files are case-insensitive.
7554 \begin_inset Flex Code
7557 \begin_layout Plain Layout
7564 \begin_inset Flex Code
7567 \begin_layout Plain Layout
7574 \begin_inset Flex Code
7577 \begin_layout Plain Layout
7583 are really the same tag.
7584 The possible arguments are printed in brackets after the tag's name.
7585 The default argument is typeset
7586 \begin_inset Flex Code
7589 \begin_layout Plain Layout
7598 If the argument has a data type like
7599 \begin_inset Quotes eld
7603 \begin_inset Quotes erd
7607 \begin_inset Quotes eld
7611 \begin_inset Quotes erd
7614 , the default is shown like this:
7615 \begin_inset Flex Code
7618 \begin_layout Plain Layout
7629 \begin_layout Subsection
7630 The document class declaration and classification
7633 \begin_layout Standard
7634 Lines in a layout file which begin with
7635 \begin_inset Flex Code
7638 \begin_layout Plain Layout
7645 There is one exception to this rule.
7647 \begin_inset Flex Code
7650 \begin_layout Plain Layout
7656 files should begin with lines like:
7659 \begin_layout LyX-Code
7662 #% Do not delete the line below; configure depends on this
7665 \begin_layout LyX-Code
7670 DeclareLaTeXClass{Article (Standard Class)}
7673 \begin_layout LyX-Code
7678 DeclareCategory{Articles}
7681 \begin_layout Standard
7682 The second and third lines are used when you (re)configure \SpecialChar LyX
7684 The layout file is read by the \SpecialChar LaTeX
7686 \begin_inset Flex Code
7689 \begin_layout Plain Layout
7695 , in a special mode where
7696 \begin_inset Flex Code
7699 \begin_layout Plain Layout
7706 The first line is just a \SpecialChar LaTeX
7707 comment, the second one contains the mandatory
7708 declaration of the text class and the third line contains the optional
7709 classification of the class.
7710 If these lines appear in a file named
7711 \begin_inset Flex Code
7714 \begin_layout Plain Layout
7720 , then they define a text class of name
7721 \begin_inset Flex Code
7724 \begin_layout Plain Layout
7730 (the name of the layout file) which uses the \SpecialChar LaTeX
7732 \begin_inset Flex Code
7735 \begin_layout Plain Layout
7741 (the default is to use the same name as the layout).
7743 \begin_inset Quotes eld
7746 Article (Standard Class)
7747 \begin_inset Quotes erd
7750 that appears above is used as a description of the text class in the
7751 \begin_inset Flex Noun
7754 \begin_layout Plain Layout
7755 Document\SpecialChar menuseparator
7763 \begin_inset Quotes eld
7767 \begin_inset Quotes erd
7770 in the example) is also used in the
7771 \begin_inset Flex Noun
7774 \begin_layout Plain Layout
7775 Document\SpecialChar menuseparator
7781 dialog: the text classes are grouped by these categories (which are usually
7782 genres, so typical categories are
7783 \begin_inset Quotes eld
7787 \begin_inset Quotes erd
7791 \begin_inset Quotes eld
7795 \begin_inset Quotes erd
7799 \begin_inset Quotes eld
7803 \begin_inset Quotes erd
7807 \begin_inset Quotes eld
7811 \begin_inset Quotes erd
7815 \begin_inset Quotes eld
7819 \begin_inset Quotes erd
7823 \begin_inset Quotes eld
7827 \begin_inset Quotes erd
7831 If no category has been declared, the class will be put in the
7832 \begin_inset Quotes eld
7836 \begin_inset Quotes erd
7842 \begin_layout Standard
7843 Let's assume that you wrote your own text class that uses the
7844 \begin_inset Flex Code
7847 \begin_layout Plain Layout
7853 document class, but where you changed the appearance of the section headings.
7854 If you put it in a file
7855 \begin_inset Flex Code
7858 \begin_layout Plain Layout
7864 , the header of this file should be:
7867 \begin_layout LyX-Code
7870 #% Do not delete the line below; configure depends on this
7873 \begin_layout LyX-Code
7878 DeclareLaTeXClass[article]{Article (with My Own Headings)}
7881 \begin_layout LyX-Code
7886 DeclareCategory{Articles}
7889 \begin_layout Standard
7890 This declares a text class
7891 \begin_inset Flex Code
7894 \begin_layout Plain Layout
7900 , associated with the \SpecialChar LaTeX
7902 \begin_inset Flex Code
7905 \begin_layout Plain Layout
7912 \begin_inset Quotes eld
7915 Article (with My Own Headings)
7916 \begin_inset Quotes erd
7920 If your text class depends on several packages, you can declare it as:
7923 \begin_layout LyX-Code
7926 #% Do not delete the line below; configure depends on this
7929 \begin_layout LyX-Code
7934 DeclareLaTeXClass[article,foo.sty]{Article (with My Own Headings)}
7937 \begin_layout LyX-Code
7942 DeclareCategory{Articles}
7945 \begin_layout Standard
7946 This indicates that your text class uses the
7947 \begin_inset Flex Code
7950 \begin_layout Plain Layout
7957 Finally, it is also possible to declare classes for DocBook code.
7958 Typical declarations will look like:
7961 \begin_layout LyX-Code
7964 #% Do not delete the line below; configure depends on this
7967 \begin_layout LyX-Code
7972 DeclareDocBookClass[article]{SGML (DocBook Article)}
7975 \begin_layout LyX-Code
7980 DeclareCategory{Articles (DocBook)}
7983 \begin_layout Standard
7984 Note that these declarations can also be given an optional parameter declaring
7985 the name of the document class (but not a list).
7988 \begin_layout Standard
7989 So, to be as explicit as possible, the form of the layout declaration is:
7992 \begin_layout LyX-Code
7997 DeclareLaTeXClass[class,package.sty]{layout description}
8000 \begin_layout LyX-Code
8005 DeclareCategory{category}
8008 \begin_layout Standard
8009 The class need only be specified if the name of the \SpecialChar LaTeX
8011 name of the layout file are different or if there are packages to load.
8012 If the name of the class file is not specified, then \SpecialChar LyX
8014 that it is the same as the name of the layout file.
8017 \begin_layout Standard
8018 When the text class has been modified to your taste, all you have to do
8019 is to copy it either to
8020 \begin_inset Flex Code
8023 \begin_layout Plain Layout
8030 \begin_inset Flex Code
8033 \begin_layout Plain Layout
8040 \begin_inset Flex Noun
8043 \begin_layout Plain Layout
8044 Tools\SpecialChar menuseparator
8050 , exit \SpecialChar LyX
8052 Then your new text class should be available along with the others.
8055 \begin_layout Standard
8056 Once the layout file is installed, you can edit it and see your changes
8057 without having to reconfigure or to restart \SpecialChar LyX
8063 \begin_layout Plain Layout
8064 In versions of \SpecialChar LyX
8065 prior to 1.6, this was not true.
8066 As a result, editing layout files was very time consuming, since you had
8067 constantly to restart \SpecialChar LyX
8073 You can force a reload of the current layout by using the \SpecialChar LyX
8075 \begin_inset Flex Noun
8078 \begin_layout Plain Layout
8085 There is no default binding for this function—though, of course, you can
8086 bind it to a key yourself.
8087 But you will normally use this function simply by entering it in the mini-buffe
8092 \begin_layout Standard
8098 \begin_inset Flex Noun
8101 \begin_layout Plain Layout
8107 is very much an `advanced feature'.
8112 recommended that you save your work before using this function.
8117 recommended that you not attempt to edit layout information while simultaneousl
8118 y working on a document that you care about.
8119 Use a test document.
8120 Syntax errors and the like in your layout file could cause peculiar behavior.
8121 In particular, such errors could cause \SpecialChar LyX
8122 to regard the current layout as
8123 invalid and to attempt to switch to some other layout.
8127 \begin_layout Plain Layout
8128 Really bad syntax errors may even caused \SpecialChar LyX
8130 This is because certain sorts of errors may make \SpecialChar LyX
8141 The \SpecialChar LyX
8142 team strives to keep \SpecialChar LyX
8143 stable in such situations, but safe is better
8148 \begin_layout Plain Layout
8149 While we're giving advice: make regular backups.
8150 And be nice to your mother.
8158 \begin_layout Subsection
8159 The Module declaration
8162 \begin_layout Standard
8163 A module must begin with a line like the following:
8166 \begin_layout LyX-Code
8169 DeclareLyXModule[endnotes.sty]{Endnotes}
8172 \begin_layout Standard
8173 The mandatory argument, in curly brackets, is the name of the module, as
8175 \begin_inset Flex Noun
8178 \begin_layout Plain Layout
8179 Document\SpecialChar menuseparator
8180 Settings\SpecialChar menuseparator
8187 The argument in square brackets is optional: It declares any \SpecialChar LaTeX
8189 on which the module depends.
8190 It is also possible to use the form
8191 \begin_inset Flex Noun
8194 \begin_layout Plain Layout
8200 as an optional argument, which declares that the module can only be used
8201 when there exists a conversion chain between the formats `
8202 \begin_inset Flex Code
8205 \begin_layout Plain Layout
8212 \begin_inset Flex Code
8215 \begin_layout Plain Layout
8224 \begin_layout Standard
8225 The module declaration should then be followed by lines like the following
8229 \begin_layout Plain Layout
8230 Preferably in English if the module should be published with \SpecialChar LyX
8232 This description will appear in the list of messages to be translated and
8233 will be thus translated with the next interface update.
8241 \begin_layout LyX-Code
8245 \begin_layout LyX-Code
8246 #Adds an endnote command, in addition to footnotes.
8250 \begin_layout LyX-Code
8251 #You will need to add
8253 theendnotes in TeX code where you
8256 \begin_layout LyX-Code
8257 #want the endnotes to appear.
8261 \begin_layout LyX-Code
8265 \begin_layout LyX-Code
8266 #Requires: somemodule | othermodule
8269 \begin_layout LyX-Code
8270 #Excludes: badmodule
8273 \begin_layout Standard
8274 The description is used in
8275 \begin_inset Flex Noun
8278 \begin_layout Plain Layout
8279 Document\SpecialChar menuseparator
8280 Settings\SpecialChar menuseparator
8286 to provide the user with information about what the module does.
8288 \begin_inset Flex Code
8291 \begin_layout Plain Layout
8297 line is used to identify other modules with which this one must be used;
8299 \begin_inset Flex Code
8302 \begin_layout Plain Layout
8308 line is used to identify modules with which this one may not be used.
8309 Both are optional, and, as shown, multiple modules should be separated
8310 with the pipe symbol: |.
8311 Note that the required modules are treated disjunctively:
8315 of the required modules must be used.
8320 excluded module may be used.
8321 Note that modules are identified here by their filenames without the
8322 \begin_inset Flex Code
8325 \begin_layout Plain Layout
8333 \begin_inset Flex Code
8336 \begin_layout Plain Layout
8343 \begin_inset Flex Code
8346 \begin_layout Plain Layout
8355 \begin_layout Subsection
8359 \begin_layout Standard
8360 The first non-comment line of any layout file, included file, or module
8365 contain the file format number:
8368 \begin_layout Description
8369 \begin_inset Flex Code
8372 \begin_layout Plain Layout
8379 \begin_inset Flex Code
8382 \begin_layout Plain Layout
8388 ] The format number of the layout file.
8391 \begin_layout Standard
8392 This tag was introduced with \SpecialChar LyX
8394 \begin_inset space ~
8398 Layout files from older \SpecialChar LyX
8399 versions do not have an explicit file format and
8400 are considered to have
8401 \begin_inset Flex Code
8404 \begin_layout Plain Layout
8406 \begin_inset space ~
8415 The format for the present version of \SpecialChar LyX
8417 But each version of \SpecialChar LyX
8418 is capable of reading earlier versions' layout files,
8419 just as they are capable of reading files produced by earlier versions
8422 There is, however, no provision for converting to earlier formats.
8425 \begin_layout Subsection
8426 \begin_inset CommandInset label
8428 name "subsec:General-text-class"
8432 General text class parameters
8435 \begin_layout Standard
8436 These are general parameters that govern the behavior of an entire document
8442 mean that they must appear in
8443 \begin_inset Flex Code
8446 \begin_layout Plain Layout
8452 files rather than in modules.
8453 A module can contain any layout tag.)
8456 \begin_layout Description
8457 \begin_inset Flex Code
8460 \begin_layout Plain Layout
8466 Adds information that will be output in the
8467 \begin_inset Flex Code
8470 \begin_layout Plain Layout
8476 block when the document is output to XHTML.
8477 Typically, this would be used to output CSS style information, but it can
8478 be used for anything that can appear in
8479 \begin_inset Flex Code
8482 \begin_layout Plain Layout
8490 \begin_inset Quotes eld
8494 \begin_inset Flex Code
8497 \begin_layout Plain Layout
8504 \begin_inset Quotes erd
8510 \begin_layout Description
8511 \begin_inset Flex Code
8514 \begin_layout Plain Layout
8520 Adds information to the document preamble.
8522 \begin_inset Newline newline
8526 \begin_inset Quotes eld
8530 \begin_inset Flex Code
8533 \begin_layout Plain Layout
8540 \begin_inset Quotes erd
8546 \begin_layout Description
8547 \begin_inset Flex Code
8550 \begin_layout Plain Layout
8556 Defines formats for use in the display of bibliographic information.
8558 \begin_inset CommandInset ref
8560 reference "subsec:Citation-format-description"
8566 \begin_inset Quotes eld
8570 \begin_inset Flex Code
8573 \begin_layout Plain Layout
8580 \begin_inset Quotes erd
8586 \begin_layout Description
8587 \begin_inset Flex Code
8590 \begin_layout Plain Layout
8596 Describes various global options supported by the document class.
8598 \begin_inset CommandInset ref
8600 reference "subsec:ClassOptions"
8606 \begin_inset Quotes eld
8610 \begin_inset Flex Code
8613 \begin_layout Plain Layout
8620 \begin_inset Quotes erd
8626 \begin_layout Description
8627 \begin_inset Flex Code
8630 \begin_layout Plain Layout
8637 \begin_inset Flex Code
8640 \begin_layout Plain Layout
8649 \begin_inset space \thinspace{}
8653 \begin_inset Flex Code
8656 \begin_layout Plain Layout
8662 ] Whether the class should
8666 to having one or two columns.
8667 Can be changed in the
8668 \begin_inset Flex Noun
8671 \begin_layout Plain Layout
8672 Document\SpecialChar menuseparator
8681 \begin_layout Description
8682 \begin_inset Flex Code
8685 \begin_layout Plain Layout
8692 \begin_inset Flex Code
8695 \begin_layout Plain Layout
8701 ] This sequence defines the properties for a counter.
8702 If the counter does not yet exist, it is created; if it does exist, it
8705 \begin_inset Quotes eld
8709 \begin_inset Flex Code
8712 \begin_layout Plain Layout
8719 \begin_inset Quotes erd
8723 \begin_inset Newline newline
8727 \begin_inset CommandInset ref
8729 reference "subsec:Counters"
8733 for details on counters.
8736 \begin_layout Description
8737 \begin_inset Flex Code
8740 \begin_layout Plain Layout
8746 Sets the default font used to display the document.
8748 \begin_inset CommandInset ref
8750 reference "subsec:Font-description"
8754 for how to declare fonts.
8756 \begin_inset Quotes eld
8760 \begin_inset Flex Code
8763 \begin_layout Plain Layout
8770 \begin_inset Quotes erd
8776 \begin_layout Description
8777 \begin_inset Flex Code
8780 \begin_layout Plain Layout
8787 \begin_inset Flex Code
8790 \begin_layout Plain Layout
8796 ] Specifies a module to be included by default with this document class.
8797 The module is specified as filename without the
8798 \begin_inset Flex Code
8801 \begin_layout Plain Layout
8808 The user can still remove the module, but it will be active at the outset.
8809 (This applies only when new files are created, or when this class is chosen
8810 for an existing document.)
8813 \begin_layout Description
8814 \begin_inset Flex Code
8817 \begin_layout Plain Layout
8824 \begin_inset Flex Code
8827 \begin_layout Plain Layout
8833 ] This is the style that will be assigned to new paragraphs, usually
8834 \begin_inset Flex Noun
8837 \begin_layout Plain Layout
8844 This will default to the first defined style if not given, but you are
8845 encouraged to use this directive.
8848 \begin_layout Description
8849 \begin_inset Flex Code
8852 \begin_layout Plain Layout
8859 \begin_inset Flex Code
8862 \begin_layout Plain Layout
8868 ] This tag indicates that the module (which is specified by filename without
8870 \begin_inset Flex Code
8873 \begin_layout Plain Layout
8879 extension) cannot be used with this document class.
8880 This might be used in a journal-specific layout file to prevent, say, the
8882 \begin_inset Flex Code
8885 \begin_layout Plain Layout
8891 module that numbers theorems by section.
8896 be used in a module.
8897 Modules have their own way of excluding other modules (see
8898 \begin_inset CommandInset ref
8900 reference "subsec:Layout-modules"
8907 \begin_layout Description
8908 \begin_inset Flex Code
8911 \begin_layout Plain Layout
8917 Defines a new float.
8919 \begin_inset CommandInset ref
8921 reference "subsec:Floats"
8927 \begin_inset Quotes eld
8931 \begin_inset Flex Code
8934 \begin_layout Plain Layout
8941 \begin_inset Quotes erd
8947 \begin_layout Description
8948 \begin_inset Flex Code
8951 \begin_layout Plain Layout
8957 Sets the information that will be output in the
8958 \begin_inset Flex Code
8961 \begin_layout Plain Layout
8967 block when this document class is output to XHTML.
8968 Note that this will completely override any prior
8969 \begin_inset Flex Code
8972 \begin_layout Plain Layout
8979 \begin_inset Flex Code
8982 \begin_layout Plain Layout
8990 \begin_inset Newline newline
8994 \begin_inset Flex Code
8997 \begin_layout Plain Layout
9003 if you just want to add material to the preamble.) Must end with
9004 \begin_inset Quotes eld
9008 \begin_inset Flex Code
9011 \begin_layout Plain Layout
9018 \begin_inset Quotes erd
9024 \begin_layout Description
9025 \begin_inset Flex Code
9028 \begin_layout Plain Layout
9035 \begin_inset Flex Code
9038 \begin_layout Plain Layout
9044 ] The style to use for the table of contents, bibliography, and so forth,
9045 when the document is output to HTML.
9046 For articles, this should normally be
9047 \begin_inset Flex Code
9050 \begin_layout Plain Layout
9057 \begin_inset Flex Code
9060 \begin_layout Plain Layout
9067 If it is not given, then \SpecialChar LyX
9068 will attempt to figure out which layout to use.
9071 \begin_layout Description
9072 \begin_inset Flex Code
9075 \begin_layout Plain Layout
9082 \begin_inset Flex Code
9085 \begin_layout Plain Layout
9091 ] Modifies the properties of the given counter.
9092 If the counter does not exist, the statement is ignored.
9094 \begin_inset Quotes eld
9098 \begin_inset Flex Code
9101 \begin_layout Plain Layout
9108 \begin_inset Quotes erd
9112 \begin_inset Newline newline
9116 \begin_inset CommandInset ref
9118 reference "subsec:Counters"
9122 for details on counters.
9125 \begin_layout Description
9126 \begin_inset Flex Code
9129 \begin_layout Plain Layout
9136 \begin_inset Flex Code
9139 \begin_layout Plain Layout
9145 ] This allows you to include another layout definition file within yours
9146 to avoid duplicating commands.
9147 Common examples are the standard layout files, for example,
9148 \begin_inset Flex Code
9151 \begin_layout Plain Layout
9157 , which contains most of the basic layouts.
9160 \begin_layout Description
9161 \begin_inset Flex Code
9164 \begin_layout Plain Layout
9171 \begin_inset Flex Code
9174 \begin_layout Plain Layout
9180 ] This section (re-)defines the layout of an inset.
9181 It can be applied to an existing inset or to a new, user-defined inset,
9182 e.g., a new character style.
9184 \begin_inset Quotes eld
9188 \begin_inset Flex Code
9191 \begin_layout Plain Layout
9198 \begin_inset Quotes erd
9202 \begin_inset Newline newline
9206 \begin_inset CommandInset ref
9208 reference "subsec:Flex-insets-and"
9212 for more information.
9216 \begin_layout Description
9217 \begin_inset Flex Code
9220 \begin_layout Plain Layout
9227 \begin_inset Flex Code
9230 \begin_layout Plain Layout
9236 ] A string that indicates the width of the left margin on the screen, for
9238 \begin_inset Quotes eld
9242 \begin_inset Flex Code
9245 \begin_layout Plain Layout
9252 \begin_inset Quotes erd
9256 (Note that this is not a `length', like
9257 \begin_inset Quotes eld
9261 \begin_inset Quotes erd
9267 \begin_layout Description
9268 \begin_inset Flex Code
9271 \begin_layout Plain Layout
9278 \begin_inset Flex Code
9281 \begin_layout Plain Layout
9287 ] Modifies the properties of the given paragraph style.
9288 If the style does not exist, this section is ignored.
9290 \begin_inset Quotes eld
9294 \begin_inset Flex Code
9297 \begin_layout Plain Layout
9304 \begin_inset Quotes erd
9310 \begin_layout Description
9311 \begin_inset Flex Code
9314 \begin_layout Plain Layout
9321 \begin_inset Flex Code
9324 \begin_layout Plain Layout
9330 ] Deletes an existing counter, usually one defined in an included file.
9333 \begin_layout Description
9334 \begin_inset Flex Code
9337 \begin_layout Plain Layout
9344 \begin_inset Flex Code
9347 \begin_layout Plain Layout
9353 ] Deletes an existing float.
9354 This is particularly useful when you want to suppress a float that has
9355 been defined in an input file.
9358 \begin_layout Description
9359 \begin_inset Flex Code
9362 \begin_layout Plain Layout
9369 \begin_inset Flex Code
9372 \begin_layout Plain Layout
9378 ] Deletes an existing style.
9381 \begin_layout Description
9382 \begin_inset Flex Code
9385 \begin_layout Plain Layout
9392 \begin_inset Flex Code
9395 \begin_layout Plain Layout
9401 ] The file format (as defined in the \SpecialChar LyX
9402 preferences) produced by this document
9404 It is mainly useful when
9405 \begin_inset Flex Code
9408 \begin_layout Plain Layout
9415 \begin_inset Flex Code
9418 \begin_layout Plain Layout
9424 and one wants to define a new type of literate document.
9425 The format is reset to
9426 \begin_inset Quotes eld
9430 \begin_inset Flex Code
9433 \begin_layout Plain Layout
9440 \begin_inset Quotes erd
9444 \begin_inset Quotes eld
9448 \begin_inset Flex Code
9451 \begin_layout Plain Layout
9458 \begin_inset Quotes erd
9461 when the corresponding
9462 \begin_inset Flex Code
9465 \begin_layout Plain Layout
9471 parameter is encountered.
9474 \begin_layout Description
9475 \begin_inset Flex Code
9478 \begin_layout Plain Layout
9485 \begin_inset Flex Code
9488 \begin_layout Plain Layout
9499 \begin_inset Flex Code
9502 \begin_layout Plain Layout
9509 \begin_inset Flex Code
9512 \begin_layout Plain Layout
9518 ] Specifies what sort of output documents using this class will produce.
9521 \begin_layout Description
9522 \begin_inset Flex Code
9525 \begin_layout Plain Layout
9532 \begin_inset Flex Code
9535 \begin_layout Plain Layout
9542 \begin_inset Flex Code
9545 \begin_layout Plain Layout
9551 ] Specifies options, given in the second string, for the package named by
9554 \begin_inset Quotes eld
9558 \begin_inset Flex Code
9561 \begin_layout Plain Layout
9562 PackageOptions natbib square
9568 \begin_inset Quotes erd
9572 \begin_inset Flex Code
9575 \begin_layout Plain Layout
9581 to be loaded with the
9582 \begin_inset Flex Code
9585 \begin_layout Plain Layout
9592 (For \SpecialChar TeX
9593 perts, this causes \SpecialChar LyX
9595 \begin_inset Flex Code
9598 \begin_layout Plain Layout
9601 PassOptionsToPackage{natbib}{square}
9607 \begin_inset Flex Code
9610 \begin_layout Plain Layout
9619 \begin_layout Description
9620 \begin_inset Flex Code
9623 \begin_layout Plain Layout
9630 \begin_inset Flex Code
9633 \begin_layout Plain Layout
9642 \begin_inset Flex Code
9645 \begin_layout Plain Layout
9652 \begin_inset Flex Code
9655 \begin_layout Plain Layout
9661 ] The default pagestyle.
9662 Can be changed in the
9663 \begin_inset Flex Noun
9666 \begin_layout Plain Layout
9667 Document\SpecialChar menuseparator
9676 \begin_layout Description
9677 \begin_inset Flex Code
9680 \begin_layout Plain Layout
9686 Sets the preamble for the \SpecialChar LaTeX
9688 Note that this will completely override any prior
9689 \begin_inset Flex Code
9692 \begin_layout Plain Layout
9699 \begin_inset Flex Code
9702 \begin_layout Plain Layout
9710 \begin_inset Flex Code
9713 \begin_layout Plain Layout
9719 if you just want to add material to the preamble.) Must end with
9720 \begin_inset Quotes eld
9724 \begin_inset Flex Code
9727 \begin_layout Plain Layout
9734 \begin_inset Quotes erd
9740 \begin_layout Description
9741 \begin_inset Flex Code
9744 \begin_layout Plain Layout
9751 \begin_inset Flex Code
9754 \begin_layout Plain Layout
9761 \begin_inset Flex Code
9764 \begin_layout Plain Layout
9773 \begin_inset space \thinspace{}
9777 \begin_inset Flex Code
9780 \begin_layout Plain Layout
9786 ] Whether the class already provides the feature
9787 \begin_inset Flex Code
9790 \begin_layout Plain Layout
9797 A feature is in general the name of a package (e.
9798 \begin_inset space \thinspace{}
9802 \begin_inset space \space{}
9806 \begin_inset Flex Code
9809 \begin_layout Plain Layout
9816 \begin_inset Flex Code
9819 \begin_layout Plain Layout
9826 \begin_inset space \thinspace{}
9830 \begin_inset space \space{}
9834 \begin_inset Flex Code
9837 \begin_layout Plain Layout
9844 \begin_inset Flex Code
9847 \begin_layout Plain Layout
9855 \begin_inset CommandInset ref
9857 reference "chap:List-of-functions"
9861 for the list of features.
9864 \begin_layout Description
9865 \begin_inset Flex Code
9868 \begin_layout Plain Layout
9875 \begin_inset Flex Code
9878 \begin_layout Plain Layout
9884 ] Indicates that this layout provides the functionality of the module mentioned,
9885 which should be specified by the filename without the
9886 \begin_inset Flex Code
9889 \begin_layout Plain Layout
9896 This will typically be used if the layout includes the module directly,
9897 rather than using the
9898 \begin_inset Flex Code
9901 \begin_layout Plain Layout
9907 tag to indicate that it ought to be used.
9908 It could also be used in a module that provided an alternate implementation
9909 of the same functionality.
9912 \begin_layout Description
9913 \begin_inset Flex Code
9916 \begin_layout Plain Layout
9923 \begin_inset Flex Code
9926 \begin_layout Plain Layout
9932 ] Creates a new paragraph style if it does not already exist.
9933 If the style does exist, this section is ignored.
9935 \begin_inset Quotes eld
9939 \begin_inset Flex Code
9942 \begin_layout Plain Layout
9949 \begin_inset Quotes erd
9955 \begin_layout Description
9956 \begin_inset Flex Code
9959 \begin_layout Plain Layout
9966 \begin_inset Flex Code
9969 \begin_layout Plain Layout
9975 ] Whether the class requires the feature
9976 \begin_inset Flex Code
9979 \begin_layout Plain Layout
9986 Multiple features must be separated by commas.
9987 Note that you can only request supported features.
9989 \begin_inset CommandInset ref
9991 reference "chap:List-of-functions"
9995 for the list of features.).
9996 If you require a package with specific options, you can additionally use
9998 \begin_inset Flex Code
10001 \begin_layout Plain Layout
10010 \begin_layout Description
10011 \begin_inset Flex Code
10014 \begin_layout Plain Layout
10021 \begin_inset Flex Code
10024 \begin_layout Plain Layout
10030 ] A string that indicates the width of the right margin on the screen, for
10032 \begin_inset Quotes eld
10036 \begin_inset Flex Code
10039 \begin_layout Plain Layout
10046 \begin_inset Quotes erd
10052 \begin_layout Description
10053 \begin_inset Flex Code
10056 \begin_layout Plain Layout
10063 \begin_inset Flex Code
10066 \begin_layout Plain Layout
10072 ] Sets which divisions get numbered.
10074 \begin_inset Newline newline
10078 \begin_inset Flex Code
10081 \begin_layout Plain Layout
10087 counter in \SpecialChar LaTeX
10091 \begin_layout Description
10092 \begin_inset Flex Code
10095 \begin_layout Plain Layout
10102 \begin_inset Flex Code
10105 \begin_layout Plain Layout
10114 \begin_inset space \thinspace{}
10118 \begin_inset Flex Code
10121 \begin_layout Plain Layout
10127 ] Whether the class-default should be printing on one or both sides of the
10129 Can be changed in the
10130 \begin_inset Flex Noun
10133 \begin_layout Plain Layout
10134 Document\SpecialChar menuseparator
10143 \begin_layout Description
10144 \begin_inset Flex Code
10147 \begin_layout Plain Layout
10154 \begin_inset Flex Code
10157 \begin_layout Plain Layout
10163 ] This sequence defines a paragraph style.
10164 If the style does not yet exist, it is created; if it does exist, its parameter
10167 \begin_inset Quotes eld
10171 \begin_inset Flex Code
10174 \begin_layout Plain Layout
10181 \begin_inset Quotes erd
10185 \begin_inset Newline newline
10189 \begin_inset CommandInset ref
10191 reference "subsec:Paragraph-Styles"
10195 for details on paragraph styles.
10198 \begin_layout Description
10199 \begin_inset Flex Code
10202 \begin_layout Plain Layout
10209 \begin_inset Flex Code
10212 \begin_layout Plain Layout
10218 ] The name of the command or environment to be used with
10219 \begin_inset Flex Code
10222 \begin_layout Plain Layout
10231 \begin_layout Description
10232 \begin_inset Flex Code
10235 \begin_layout Plain Layout
10242 \begin_inset Flex Code
10245 \begin_layout Plain Layout
10254 \begin_inset Flex Code
10257 \begin_layout Plain Layout
10263 ] Indicates what kind of markup is used to define the title of a document.
10265 \begin_inset Flex Code
10268 \begin_layout Plain Layout
10274 means that the macro with name
10275 \begin_inset Flex Code
10278 \begin_layout Plain Layout
10284 will be inserted after the last layout which has
10285 \begin_inset Quotes eld
10289 \begin_inset Flex Code
10292 \begin_layout Plain Layout
10294 \begin_inset space ~
10303 \begin_inset Quotes erd
10308 \begin_inset Flex Code
10311 \begin_layout Plain Layout
10317 corresponds to the case where all layouts which have
10318 \begin_inset Quotes eld
10322 \begin_inset Flex Code
10325 \begin_layout Plain Layout
10327 \begin_inset space ~
10336 \begin_inset Quotes erd
10339 should be enclosed into the
10340 \begin_inset Flex Code
10343 \begin_layout Plain Layout
10352 \begin_layout Description
10353 \begin_inset Flex Code
10356 \begin_layout Plain Layout
10363 \begin_inset Flex Code
10366 \begin_layout Plain Layout
10372 ] Sets which divisions are included in the table of contents.
10374 \begin_inset Flex Code
10377 \begin_layout Plain Layout
10383 counter in \SpecialChar LaTeX
10387 \begin_layout Subsection
10388 \begin_inset Flex Code
10391 \begin_layout Plain Layout
10398 \begin_inset CommandInset label
10400 name "subsec:ClassOptions"
10407 \begin_layout Standard
10409 \begin_inset Flex Code
10412 \begin_layout Plain Layout
10418 section can contain the following entries:
10421 \begin_layout Description
10422 \begin_inset Flex Code
10425 \begin_layout Plain Layout
10432 \begin_inset Flex Code
10435 \begin_layout Plain Layout
10441 ] The list of available font sizes for the document's main font, separated
10443 \begin_inset Quotes eld
10447 \begin_inset Flex Code
10450 \begin_layout Plain Layout
10457 \begin_inset Quotes erd
10463 \begin_layout Description
10464 \begin_inset Flex Code
10467 \begin_layout Plain Layout
10473 Used to set the DTD line with XML-based output classes.
10475 \begin_inset space \thinspace{}
10479 \begin_inset Quotes eld
10482 -//OASIS//DTD DocBook V4.2//EN
10483 \begin_inset Quotes erd
10489 \begin_layout Description
10490 \begin_inset Flex Code
10493 \begin_layout Plain Layout
10500 \begin_inset Flex Code
10503 \begin_layout Plain Layout
10504 string="empty|plain|headings|fancy"
10509 ] The list of available page sty\SpecialChar softhyphen
10511 \begin_inset Quotes eld
10515 \begin_inset Flex Code
10518 \begin_layout Plain Layout
10525 \begin_inset Quotes erd
10531 \begin_layout Description
10532 \begin_inset Flex Code
10535 \begin_layout Plain Layout
10542 \begin_inset Flex Code
10545 \begin_layout Plain Layout
10551 ] Some document class options, separated by a comma, that will be added
10552 to the optional part of the
10553 \begin_inset Flex Code
10556 \begin_layout Plain Layout
10567 \begin_layout Standard
10569 \begin_inset Flex Code
10572 \begin_layout Plain Layout
10578 section must end with
10579 \begin_inset Quotes eld
10583 \begin_inset Flex Code
10586 \begin_layout Plain Layout
10593 \begin_inset Quotes erd
10599 \begin_layout Subsection
10601 \begin_inset CommandInset label
10603 name "subsec:Paragraph-Styles"
10610 \begin_layout Standard
10611 A paragraph style description looks like this:
10615 \begin_layout Plain Layout
10616 Note that this will either define a new style or modify an existing one.
10624 \begin_layout LyX-Code
10631 \begin_layout LyX-Code
10635 \begin_layout LyX-Code
10639 \begin_layout Standard
10640 where the following commands are allowed:
10643 \begin_layout Description
10644 \begin_inset Flex Code
10647 \begin_layout Plain Layout
10654 \begin_inset Flex Code
10657 \begin_layout Plain Layout
10662 , left, right, center
10667 ] Paragraph alignment.
10670 \begin_layout Description
10671 \begin_inset Flex Code
10674 \begin_layout Plain Layout
10681 \begin_inset Flex Code
10684 \begin_layout Plain Layout
10689 , left, right, center
10694 ] A comma separated list of permitted alignments.
10695 (Some \SpecialChar LaTeX
10696 styles prohibit certain alignments, since those wouldn't make sense.
10697 For example a right-aligned or centered enumeration isn't possible.)
10700 \begin_layout Description
10701 \begin_inset Flex Code
10704 \begin_layout Plain Layout
10711 \begin_inset Flex Code
10714 \begin_layout Plain Layout
10720 ] Defines argument number <int> of a command\SpecialChar breakableslash
10721 environment associated with
10723 This is useful for things like section headings, and only makes sense with
10726 Every (optional or required) argument of a command or environment – except
10727 for the required argument that is associated with the content of the paragraph
10728 itself – has a separate definition, where the number specifies the order
10730 The definition must end with
10731 \begin_inset Flex Code
10734 \begin_layout Plain Layout
10741 So a command with two optional arguments has:
10745 \begin_layout Quote
10751 \begin_layout Quote
10757 \begin_layout Quote
10763 \begin_layout Quote
10769 \begin_layout Quote
10775 \begin_layout Quote
10781 \begin_layout Standard
10783 \begin_inset Flex Code
10786 \begin_layout Plain Layout
10792 definition, the following specifications are possible:
10795 \begin_layout Itemize
10796 \begin_inset Flex Code
10799 \begin_layout Plain Layout
10806 \begin_inset Flex Code
10809 \begin_layout Plain Layout
10815 The string that will appear both in the menu (to insert this argument)
10816 and on the argument inset button (unless you also specify a separate
10817 \begin_inset Flex Code
10820 \begin_layout Plain Layout
10827 For the menu, you can define an accelerator by appending the respective
10828 character to the string, divided by
10829 \begin_inset Quotes eld
10833 \begin_inset Quotes erd
10837 \begin_inset space \thinspace{}
10841 \begin_inset space \space{}
10845 \begin_inset Quotes eld
10849 \begin_inset Flex Code
10852 \begin_layout Plain Layout
10859 \begin_inset Quotes erd
10865 \begin_layout Itemize
10866 \begin_inset Flex Code
10869 \begin_layout Plain Layout
10876 \begin_inset Flex Code
10879 \begin_layout Plain Layout
10885 A separate string for the menu.
10886 You can define an accelerator by appending the respective character to
10887 the string, divided by
10888 \begin_inset Quotes eld
10892 \begin_inset Quotes erd
10896 \begin_inset space \thinspace{}
10900 \begin_inset space \space{}
10904 \begin_inset Quotes eld
10908 \begin_inset Flex Code
10911 \begin_layout Plain Layout
10918 \begin_inset Quotes erd
10922 This specification is optional.
10923 If it is not given the
10924 \begin_inset Flex Code
10927 \begin_layout Plain Layout
10933 will be used instead for the menu.
10936 \begin_layout Itemize
10937 \begin_inset Flex Code
10940 \begin_layout Plain Layout
10947 \begin_inset Flex Code
10950 \begin_layout Plain Layout
10956 A longer explanatory text that appears in the tooltip when hovering over
10957 the argument inset.
10960 \begin_layout Itemize
10961 \begin_inset Flex Code
10964 \begin_layout Plain Layout
10971 \begin_inset Flex Code
10974 \begin_layout Plain Layout
10983 \begin_inset space \thinspace{}
10987 \begin_inset Flex Code
10990 \begin_layout Plain Layout
10996 ] Declare if this is a mandatory (1) or an optional (0) argument.
10997 Mandatory arguments will be output empty if not given, while optional arguments
10998 will not be output at all.
10999 By default, mandatory arguments are delimited by
11000 \begin_inset Flex Code
11003 \begin_layout Plain Layout
11009 , while optional arguments are delimited by
11010 \begin_inset Flex Code
11013 \begin_layout Plain Layout
11022 \begin_layout Itemize
11023 \begin_inset Flex Code
11026 \begin_layout Plain Layout
11033 \begin_inset Flex Code
11036 \begin_layout Plain Layout
11042 defines another argument (by its number) which this argument requires to
11043 be output if it is itself output.
11045 \begin_inset space \thinspace{}
11048 g., in \SpecialChar LaTeX
11049 commands, optional arguments often require previous optional arguments
11050 to be output (at least empty), as in
11051 \begin_inset Flex Code
11054 \begin_layout Plain Layout
11057 command[][argument]{text}
11063 This can be achieved by the statement
11064 \begin_inset Flex Code
11067 \begin_layout Plain Layout
11074 \begin_inset Flex Code
11077 \begin_layout Plain Layout
11086 \begin_layout Itemize
11087 \begin_inset Flex Code
11090 \begin_layout Plain Layout
11097 \begin_inset Flex Code
11100 \begin_layout Plain Layout
11106 defines a custom left delimiter (instead of
11107 \begin_inset Flex Code
11110 \begin_layout Plain Layout
11117 \begin_inset Flex Code
11120 \begin_layout Plain Layout
11127 A line break in the output can be indicated by
11128 \begin_inset Flex Code
11131 \begin_layout Plain Layout
11140 \begin_layout Itemize
11141 \begin_inset Flex Code
11144 \begin_layout Plain Layout
11151 \begin_inset Flex Code
11154 \begin_layout Plain Layout
11160 defines a custom right delimiter (instead of
11161 \begin_inset Flex Code
11164 \begin_layout Plain Layout
11171 \begin_inset Flex Code
11174 \begin_layout Plain Layout
11181 A line break in the output can be indicated by
11182 \begin_inset Flex Code
11185 \begin_layout Plain Layout
11194 \begin_layout Itemize
11195 \begin_inset Flex Code
11198 \begin_layout Plain Layout
11205 \begin_inset Flex Code
11208 \begin_layout Plain Layout
11214 defines an argument that is inserted if and only if no user-specified arguments
11216 \begin_inset space \thinspace{}
11220 \begin_inset space \space{}
11223 if no argument inset has been inserted (note that also an empty argument
11224 inset omits the DefaultArg).
11225 Multiple arguments need to be separated by comma.
11228 \begin_layout Itemize
11229 \begin_inset Flex Code
11232 \begin_layout Plain Layout
11239 \begin_inset Flex Code
11242 \begin_layout Plain Layout
11248 defines an argument that is inserted in any case (alone or in addition
11249 to user-specified arguments).
11250 Multiple arguments need to be separated by comma.
11253 \begin_layout Itemize
11254 \begin_inset Flex Code
11257 \begin_layout Plain Layout
11263 The font used for the argument content, see
11264 \begin_inset CommandInset ref
11266 reference "subsec:Font-description"
11273 \begin_layout Itemize
11274 \begin_inset Flex Code
11277 \begin_layout Plain Layout
11283 The font used for the label; see
11284 \begin_inset CommandInset ref
11286 reference "subsec:Font-description"
11293 \begin_layout Itemize
11294 \begin_inset Flex Code
11297 \begin_layout Plain Layout
11304 \begin_inset Flex Code
11307 \begin_layout Plain Layout
11312 , Minimalistic, Conglomerate
11317 ] describes the rendering style used for the inset's frame and buttons.
11320 \begin_layout Itemize
11321 \begin_inset Flex Code
11324 \begin_layout Plain Layout
11331 \begin_inset Flex Code
11334 \begin_layout Plain Layout
11341 \begin_inset Flex Code
11344 \begin_layout Plain Layout
11350 , this argument is automatically inserted when the respective style is selected.
11351 Currently, only one argument per style\SpecialChar breakableslash
11352 layout can be automatically inserted.
11355 \begin_layout Itemize
11356 \begin_inset Flex Code
11359 \begin_layout Plain Layout
11366 \begin_inset Flex Code
11369 \begin_layout Plain Layout
11376 \begin_inset Flex Code
11379 \begin_layout Plain Layout
11385 , this argument will be inserted with a copy of the co-text (either selected
11386 text or the whole paragraph) as content.
11389 \begin_layout Itemize
11390 \begin_inset Flex Code
11393 \begin_layout Plain Layout
11400 \begin_inset Flex Code
11403 \begin_layout Plain Layout
11404 string of characters
11413 Defines individual characters that should be output in raw form, meaning
11414 without special translations that \SpecialChar LaTeX
11416 Note that, contrary to PassThru, this needs to be explicitly defined for
11418 That is, arguments do not inherit PassThruChars from their parent inset
11422 \begin_layout Standard
11423 By default, the text entered in the \SpecialChar LyX
11424 workarea in the respective layout is
11425 the last (mandatory) argument of a command if the
11426 \begin_inset Flex Code
11429 \begin_layout Plain Layout
11436 \begin_inset Flex Code
11439 \begin_layout Plain Layout
11446 However, arguments with the prefix
11447 \begin_inset Flex Code
11450 \begin_layout Plain Layout
11456 are output after this workarea argument.
11457 Note that post-argument numbering restarts at 1, so the first argument
11458 following the workarea argument is
11459 \begin_inset Flex Code
11462 \begin_layout Plain Layout
11469 Post-arguments are ignored in any other
11470 \begin_inset Flex Code
11473 \begin_layout Plain Layout
11480 \begin_inset Flex Code
11483 \begin_layout Plain Layout
11492 \begin_layout Standard
11494 \begin_inset Flex Code
11497 \begin_layout Plain Layout
11506 \begin_inset Flex Code
11509 \begin_layout Plain Layout
11518 \begin_inset Flex Code
11521 \begin_layout Plain Layout
11527 followed by the number (e.
11528 \begin_inset space \thinspace{}
11532 \begin_inset space \space{}
11536 \begin_inset Flex Code
11539 \begin_layout Plain Layout
11549 \begin_layout Description
11550 \begin_inset Flex Code
11553 \begin_layout Plain Layout
11559 Note that this will completely override any prior
11560 \begin_inset Flex Code
11563 \begin_layout Plain Layout
11569 declaration for this style.
11571 \begin_inset Quotes eld
11575 \begin_inset Flex Code
11578 \begin_layout Plain Layout
11585 \begin_inset Quotes erd
11590 \begin_inset CommandInset ref
11592 reference "subsec:I18n"
11596 for details on its use.
11599 \begin_layout Description
11600 \begin_inset Flex Code
11603 \begin_layout Plain Layout
11610 \begin_inset Flex Code
11613 \begin_layout Plain Layout
11623 \begin_layout Plain Layout
11624 Note that a `float' here is a real number, such as: 1.5.
11629 The vertical space with which the last of a chain of paragraphs with this
11630 style is separated from the following paragraph.
11631 If the next paragraph has another style, the separations are not simply
11632 added, but the maximum is taken.
11635 \begin_layout Description
11636 \begin_inset Flex Code
11639 \begin_layout Plain Layout
11646 \begin_inset Flex Code
11649 \begin_layout Plain Layout
11655 ] The category for this style.
11656 This is used to group related styles in the style combobox on the toolbar.
11657 Any string can be used, but you may want to use existing categories with
11662 \begin_layout Description
11663 \begin_inset Flex Code
11666 \begin_layout Plain Layout
11672 Depth of XML command.
11673 Used only with XML-type formats.
11676 \begin_layout Description
11677 \begin_inset Flex Code
11680 \begin_layout Plain Layout
11687 \begin_inset Flex Code
11690 \begin_layout Plain Layout
11696 ] Copies all the features of an existing style into the current one.
11700 \begin_layout Description
11701 \begin_inset Flex Code
11704 \begin_layout Plain Layout
11711 \begin_inset Flex Code
11714 \begin_layout Plain Layout
11720 ] The name of a style whose preamble should be output
11725 This allows to ensure some ordering of the preamble snippets when macros
11726 definitions depend on one another.
11730 \begin_layout Plain Layout
11731 Note that, besides that functionality, there is no way to ensure any ordering
11733 The ordering that you see in a given version of \SpecialChar LyX
11734 may change without warning
11743 \begin_layout Description
11744 \begin_inset Flex Code
11747 \begin_layout Plain Layout
11754 \begin_inset Flex Code
11757 \begin_layout Plain Layout
11762 , Box, Filled_Box, Static
11767 ] The type of label that stands at the end of the paragraph (or sequence
11769 \begin_inset Flex Code
11772 \begin_layout Plain Layout
11779 \begin_inset Newline newline
11783 \begin_inset Flex Code
11786 \begin_layout Plain Layout
11793 \begin_inset Flex Code
11796 \begin_layout Plain Layout
11803 \begin_inset Flex Code
11806 \begin_layout Plain Layout
11814 \begin_inset Flex Code
11817 \begin_layout Plain Layout
11824 \begin_inset Quotes eld
11828 \begin_inset Quotes erd
11832 \begin_inset Flex Code
11835 \begin_layout Plain Layout
11842 \begin_inset space \space{}
11846 \begin_inset Flex Code
11849 \begin_layout Plain Layout
11855 ) is a white (resp.
11856 \begin_inset space ~
11859 black) square suitable for end of proof markers,
11860 \begin_inset Flex Code
11863 \begin_layout Plain Layout
11869 is an explicit text string.
11872 \begin_layout Description
11873 \begin_inset Flex Code
11876 \begin_layout Plain Layout
11883 \begin_inset Flex Code
11886 \begin_layout Plain Layout
11892 ] The string used for a label with a
11893 \begin_inset Flex Code
11896 \begin_layout Plain Layout
11903 \begin_inset Newline newline
11907 \begin_inset Flex Code
11910 \begin_layout Plain Layout
11920 \begin_layout Description
11921 \begin_inset Flex Code
11924 \begin_layout Plain Layout
11930 The font used for both the text body
11936 \begin_inset CommandInset ref
11938 reference "subsec:Font-description"
11943 Note that defining this font automatically defines the
11944 \begin_inset Flex Code
11947 \begin_layout Plain Layout
11954 So you should define this one first if you also want to define
11955 \begin_inset Flex Code
11958 \begin_layout Plain Layout
11967 \begin_layout Description
11968 \begin_inset Flex Code
11971 \begin_layout Plain Layout
11978 \begin_inset Flex Code
11981 \begin_layout Plain Layout
11987 ] Used for backporting new styles to stable \SpecialChar LyX
11989 The first stable version that supports this tag is \SpecialChar LyX
11991 The argument is a number which may either be 0, -1 or any value greater
11994 \begin_inset Flex Code
11997 \begin_layout Plain Layout
12003 flag of a style is greater than zero, it will always be written to the
12005 If a .lyx file is read, the style definitions from the document header are
12006 added to the document class.
12007 Therefore even older \SpecialChar LyX
12008 versions can handle the style.
12010 \begin_inset Flex Code
12013 \begin_layout Plain Layout
12019 is a version number: if the style is read, and the version number is less
12020 than the version number of the already existing style in the document class,
12021 the new style is ignored.
12022 If the version number is greater, the new style replaces the existing style.
12023 A value of -1 means an infinite version number, i.
12024 \begin_inset space \thinspace{}
12028 \begin_inset space \space{}
12031 the style is always used.
12034 \begin_layout Description
12035 \begin_inset Flex Code
12038 \begin_layout Plain Layout
12045 \begin_inset Flex Code
12048 \begin_layout Plain Layout
12057 \begin_inset space \thinspace{}
12061 \begin_inset Flex Code
12064 \begin_layout Plain Layout
12070 ] Usually \SpecialChar LyX
12071 does not allow you to insert more than one space between words,
12072 since a space is considered as the separation between two words, not a
12073 character or symbol of its own.
12074 This is a very fine thing but sometimes annoying, for example, when typing
12075 program code or plain \SpecialChar LaTeX
12078 \begin_inset Flex Code
12081 \begin_layout Plain Layout
12088 Note that \SpecialChar LyX
12089 will create protected blanks for the additional blanks when
12090 in another mode than \SpecialChar LaTeX
12094 \begin_layout Description
12095 \begin_inset Flex Code
12098 \begin_layout Plain Layout
12104 These tags are used with XHTML output.
12106 \begin_inset CommandInset ref
12108 reference "subsec:Paragraph-Style-XHTML"
12115 \begin_layout Description
12116 \begin_inset Flex Code
12119 \begin_layout Plain Layout
12125 [FIXME] (Used only with XML-type formats.)
12128 \begin_layout Description
12129 \begin_inset Flex Code
12132 \begin_layout Plain Layout
12139 \begin_inset Flex Code
12142 \begin_layout Plain Layout
12151 \begin_inset space \thinspace{}
12155 \begin_inset Flex Code
12158 \begin_layout Plain Layout
12165 \begin_inset Flex Code
12168 \begin_layout Plain Layout
12174 , marks the style as to be included in the document preamble and not in
12176 This is useful for document classes that want such information as the title
12177 and author to appear in the preamble.
12178 Note that this works only for styles for which the
12179 \begin_inset Flex Code
12182 \begin_layout Plain Layout
12189 \begin_inset Flex Code
12192 \begin_layout Plain Layout
12199 \begin_inset Flex Code
12202 \begin_layout Plain Layout
12211 \begin_layout Description
12212 \begin_inset Flex Code
12215 \begin_layout Plain Layout
12222 \begin_inset Flex Code
12225 \begin_layout Plain Layout
12234 \begin_inset space \thinspace{}
12238 \begin_inset Flex Code
12241 \begin_layout Plain Layout
12248 \begin_inset Flex Code
12251 \begin_layout Plain Layout
12257 , marks the style as being part of a title block (see also the
12258 \begin_inset Flex Code
12261 \begin_layout Plain Layout
12268 \begin_inset Flex Code
12271 \begin_layout Plain Layout
12280 \begin_layout Description
12281 \begin_inset Flex Code
12284 \begin_layout Plain Layout
12291 \begin_inset Flex Code
12294 \begin_layout Plain Layout
12300 ] The \SpecialChar LaTeX
12301 command sequence declaring an item in a list.
12302 The command is to be defined without the preceding backslash (the default
12304 \begin_inset Quotes eld
12308 \begin_inset Quotes erd
12312 \begin_inset Flex Code
12315 \begin_layout Plain Layout
12323 in the \SpecialChar LaTeX
12327 \begin_layout Description
12328 \begin_inset Flex Code
12331 \begin_layout Plain Layout
12338 \begin_inset Flex Code
12341 \begin_layout Plain Layout
12347 ] This provides extra space between paragraphs that have the same style.
12348 If you put other styles into an environment, each is separated with the
12350 \begin_inset Flex Code
12353 \begin_layout Plain Layout
12360 But the whole items of the environment are additionally separated with
12362 \begin_inset Flex Code
12365 \begin_layout Plain Layout
12372 Note that this is a
12377 \begin_layout Description
12378 \begin_inset Flex Code
12381 \begin_layout Plain Layout
12387 [FIXME] (Used only with XML-type formats.)
12390 \begin_layout Description
12391 \begin_inset Flex Code
12394 \begin_layout Plain Layout
12401 \begin_inset Flex Code
12404 \begin_layout Plain Layout
12413 \begin_inset space \thinspace{}
12417 \begin_inset Flex Code
12420 \begin_layout Plain Layout
12426 ] Usually \SpecialChar LyX
12427 does not allow you to leave a paragraph empty, since it would
12428 lead to empty \SpecialChar LaTeX
12430 There are some cases where this could be desirable however: in a letter
12431 template, the required fields can be provided as empty fields, so that
12432 people do not forget them; in some special classes, a style can be used
12433 as some kind of break, which does not contain actual text.
12436 \begin_layout Description
12437 \begin_inset Flex Code
12440 \begin_layout Plain Layout
12447 \begin_inset Flex Code
12450 \begin_layout Plain Layout
12456 ] The vertical space between the label and the text body.
12457 Only used for labels that are above the text body (
12458 \begin_inset Flex Code
12461 \begin_layout Plain Layout
12468 \begin_inset Newline newline
12472 \begin_inset Flex Code
12475 \begin_layout Plain Layout
12476 Centered_Top_Environment
12484 \begin_layout Description
12485 \begin_inset Flex Code
12488 \begin_layout Plain Layout
12495 \begin_inset Flex Code
12498 \begin_layout Plain Layout
12504 ] The name of the counter for automatic numbering.
12505 In order to have the counter appear with your label, you will need to reference
12507 \begin_inset Flex Code
12510 \begin_layout Plain Layout
12519 This will work with
12520 \begin_inset Flex Code
12523 \begin_layout Plain Layout
12530 \begin_inset Flex Code
12533 \begin_layout Plain Layout
12540 \begin_inset Flex Code
12543 \begin_layout Plain Layout
12550 \begin_inset Flex Code
12553 \begin_layout Plain Layout
12560 \begin_inset Newline newline
12568 \begin_inset Flex Code
12571 \begin_layout Plain Layout
12578 \begin_inset Flex Code
12581 \begin_layout Plain Layout
12587 , though this case is a bit complicated.
12588 Suppose you declare
12589 \begin_inset Quotes eld
12593 \begin_inset Flex Code
12596 \begin_layout Plain Layout
12597 LabelCounter myenum
12603 \begin_inset Quotes erd
12607 Then the actual counters used are
12608 \begin_inset Flex Code
12611 \begin_layout Plain Layout
12618 \begin_inset Flex Code
12621 \begin_layout Plain Layout
12628 \begin_inset Flex Code
12631 \begin_layout Plain Layout
12638 \begin_inset Flex Code
12641 \begin_layout Plain Layout
12647 , much as in \SpecialChar LaTeX
12649 These counters must all be declared separately.
12650 \begin_inset Newline newline
12654 \begin_inset CommandInset ref
12656 reference "subsec:Counters"
12660 for details on counters.
12663 \begin_layout Description
12664 \begin_inset Flex Code
12667 \begin_layout Plain Layout
12673 The font used for the label.
12675 \begin_inset CommandInset ref
12677 reference "subsec:Font-description"
12684 \begin_layout Description
12685 \begin_inset Flex Code
12688 \begin_layout Plain Layout
12695 \begin_inset Flex Code
12698 \begin_layout Plain Layout
12704 ] Text that indicates how far a label should be indented.
12707 \begin_layout Description
12708 \begin_inset Flex Code
12711 \begin_layout Plain Layout
12718 \begin_inset Flex Code
12721 \begin_layout Plain Layout
12727 ] Text that indicates the amount of horizontal space between the label and
12729 Only used for labels that are not above the text body.
12732 \begin_layout Description
12733 \begin_inset Flex Code
12736 \begin_layout Plain Layout
12743 \begin_inset Flex Code
12746 \begin_layout Plain Layout
12752 ] The string used for the label.
12754 \begin_inset Flex Code
12757 \begin_layout Plain Layout
12763 is set, this string can be contain the special formatting commands described
12765 \begin_inset CommandInset ref
12767 reference "subsec:Counters"
12774 \begin_layout Description
12775 \begin_inset Flex Code
12778 \begin_layout Plain Layout
12779 LabelStringAppendix
12785 \begin_inset Flex Code
12788 \begin_layout Plain Layout
12794 ] This is used inside the appendix instead of
12795 \begin_inset Newline newline
12799 \begin_inset Flex Code
12802 \begin_layout Plain Layout
12810 \begin_inset Flex Code
12813 \begin_layout Plain Layout
12820 \begin_inset Newline newline
12824 \begin_inset Flex Code
12827 \begin_layout Plain Layout
12828 LabelStringAppendix
12836 \begin_layout Description
12837 \begin_inset Flex Code
12840 \begin_layout Plain Layout
12846 [FIXME] (Used only with XML-type formats.)
12849 \begin_layout Description
12850 \begin_inset Flex Code
12853 \begin_layout Plain Layout
12860 \begin_inset Flex Code
12863 \begin_layout Plain Layout
12868 , Manual, Static, Above,
12869 \begin_inset Newline newline
12872 Centered, Sensitive, Enumerate,
12873 \begin_inset Newline newline
12876 Itemize, Bibliography
12885 \begin_layout Description
12886 \begin_inset Flex Code
12889 \begin_layout Plain Layout
12895 means the label is the very first word (up to the first real blank).
12896 Use protected spaces if you want more than one word as the label.
12900 \begin_layout Description
12901 \begin_inset Flex Code
12904 \begin_layout Plain Layout
12910 means the label is simply what is declared as
12911 \begin_inset Flex Code
12914 \begin_layout Plain Layout
12921 This will be displayed
12922 \begin_inset Quotes eld
12926 \begin_inset Quotes erd
12929 , at the beginning of the paragraph.
12931 \begin_inset Flex Code
12934 \begin_layout Plain Layout
12941 \begin_inset Flex Code
12944 \begin_layout Plain Layout
12950 , then it will be displayed only in the first paragraph of any sequence
12951 of paragraphs with the same
12952 \begin_inset Flex Code
12955 \begin_layout Plain Layout
12964 \begin_layout Description
12965 \begin_inset Flex Code
12968 \begin_layout Plain Layout
12975 \begin_inset space ~
12979 \begin_inset space ~
12983 \begin_inset Flex Code
12986 \begin_layout Plain Layout
12992 are special cases of
12993 \begin_inset Flex Code
12996 \begin_layout Plain Layout
13003 The label will be printed above the paragraph either at the beginning of
13004 the line or centered.
13007 \begin_layout Description
13008 \begin_inset Flex Code
13011 \begin_layout Plain Layout
13017 is a special case for the caption-labels
13018 \begin_inset Quotes eld
13022 \begin_inset Quotes erd
13026 \begin_inset Quotes eld
13030 \begin_inset Quotes erd
13034 \begin_inset Newline newline
13038 \begin_inset Flex Code
13041 \begin_layout Plain Layout
13047 means the (hardcoded) label string depends on the kind of float: It is
13048 hardcoded to be `FloatType N', where N is the value of the counter associated
13050 For the case that a caption is inserted outside of a float the
13051 \begin_inset Flex Code
13054 \begin_layout Plain Layout
13061 \begin_inset Quotes eld
13065 \begin_inset Quotes erd
13071 \begin_layout Description
13072 \begin_inset Flex Code
13075 \begin_layout Plain Layout
13081 produces the usual sort of enumeration labels.
13082 At present, it is hardcoded to use Arabic numerals, lowercase letters,
13083 small Roman numerals, and uppercase letters for the four possible depths.
13086 \begin_layout Description
13087 \begin_inset Flex Code
13090 \begin_layout Plain Layout
13096 produces various bullets at the different levels.
13097 It is also hardcoded.
13100 \begin_layout Description
13101 \begin_inset Flex Code
13104 \begin_layout Plain Layout
13110 should be used only with
13111 \begin_inset Flex Code
13114 \begin_layout Plain Layout
13115 LatexType BibEnvironment
13124 \begin_layout Description
13125 \begin_inset Flex Code
13128 \begin_layout Plain Layout
13134 Note that this will completely override any prior
13135 \begin_inset Flex Code
13138 \begin_layout Plain Layout
13144 declaration for this style.
13146 \begin_inset Quotes eld
13150 \begin_inset Flex Code
13153 \begin_layout Plain Layout
13160 \begin_inset Quotes erd
13165 \begin_inset CommandInset ref
13167 reference "subsec:I18n"
13171 for details on its use.
13174 \begin_layout Description
13175 \begin_inset Flex Code
13178 \begin_layout Plain Layout
13185 \begin_inset Flex Code
13188 \begin_layout Plain Layout
13194 ] The name of the corresponding \SpecialChar LaTeX
13196 Either the environment or command name.
13199 \begin_layout Description
13200 \begin_inset Flex Code
13203 \begin_layout Plain Layout
13210 \begin_inset Flex Code
13213 \begin_layout Plain Layout
13219 ] An optional parameter for the corresponding
13220 \begin_inset Flex Code
13223 \begin_layout Plain Layout
13230 This parameter cannot be changed from within \SpecialChar LyX
13232 \begin_inset Flex Code
13235 \begin_layout Plain Layout
13241 for customizable parameters).
13242 This will be output as is after all \SpecialChar LaTeX
13244 \begin_inset Flex Code
13247 \begin_layout Plain Layout
13256 \begin_layout Description
13257 \begin_inset Flex Code
13260 \begin_layout Plain Layout
13267 \begin_inset Flex Code
13270 \begin_layout Plain Layout
13275 , Command, Environment, Item_Environment,
13276 \begin_inset Newline newline
13279 List_Environment, Bib_Environment
13284 ] How the style should be translated into \SpecialChar LaTeX
13289 \begin_layout Plain Layout
13290 \begin_inset Flex Code
13293 \begin_layout Plain Layout
13299 is perhaps a bit misleading, since these rules apply to SGML classes, too.
13300 Visit the SGML class files for specific examples.
13309 \begin_layout Description
13310 \begin_inset Flex Code
13313 \begin_layout Plain Layout
13319 means nothing special.
13322 \begin_layout Description
13323 \begin_inset Flex Code
13326 \begin_layout Plain Layout
13333 \begin_inset Flex Code
13336 \begin_layout Plain Layout
13343 {\SpecialChar ldots
13352 \begin_layout Description
13353 \begin_inset Flex Code
13356 \begin_layout Plain Layout
13363 \begin_inset Flex Code
13366 \begin_layout Plain Layout
13373 }\SpecialChar ldots
13389 \begin_layout Description
13390 \begin_inset Flex Code
13393 \begin_layout Plain Layout
13400 \begin_inset Flex Code
13403 \begin_layout Plain Layout
13410 \begin_inset Flex Code
13413 \begin_layout Plain Layout
13421 is generated for each paragraph of this environment.
13425 \begin_layout Description
13426 \begin_inset Flex Code
13429 \begin_layout Plain Layout
13436 \begin_inset Flex Code
13439 \begin_layout Plain Layout
13446 \begin_inset Newline newline
13450 \begin_inset Flex Code
13453 \begin_layout Plain Layout
13459 is passed as an argument to the environment.
13460 \begin_inset Newline newline
13464 \begin_inset Flex Code
13467 \begin_layout Plain Layout
13473 can be defined in the
13474 \begin_inset Flex Noun
13477 \begin_layout Plain Layout
13478 Edit\SpecialChar menuseparator
13480 \begin_inset space ~
13491 \begin_layout Description
13492 \begin_inset Flex Code
13495 \begin_layout Plain Layout
13502 \begin_inset Flex Code
13505 \begin_layout Plain Layout
13511 but adds the necessary mandatory argument (the longest label) to the begin
13512 statement of the bibliography environment:
13513 \begin_inset Newline newline
13517 \begin_inset Flex Code
13520 \begin_layout Plain Layout
13523 begin{thebibliography}{99}
13529 It is therefore only useful for bibliography environments.
13530 The default longest label
13531 \begin_inset Quotes eld
13535 \begin_inset Quotes erd
13538 can be changed by the user in the paragraph settings of a bibliography
13542 \begin_layout Standard
13543 Putting the last few things together, the \SpecialChar LaTeX
13544 output will be either:
13547 \begin_layout LyX-Code
13550 LatexName[LatexParam]{\SpecialChar ldots
13554 \begin_layout Standard
13558 \begin_layout LyX-Code
13561 begin{LatexName}[LatexParam] \SpecialChar ldots
13567 \begin_layout Standard
13568 depending upon the \SpecialChar LaTeX
13573 \begin_layout Description
13574 \begin_inset Flex Code
13577 \begin_layout Plain Layout
13584 \begin_inset Flex Code
13587 \begin_layout Plain Layout
13593 ] A string that is put at the beginning of the style content.
13594 A line break in the output can be indicated by
13595 \begin_inset Flex Code
13598 \begin_layout Plain Layout
13607 \begin_layout Description
13608 \begin_inset Flex Code
13611 \begin_layout Plain Layout
13618 \begin_inset Flex Code
13621 \begin_layout Plain Layout
13627 ] If you put styles into environments, the different
13628 \begin_inset Flex Code
13631 \begin_layout Plain Layout
13637 are not simply added, but added with a factor
13638 \begin_inset Formula $\frac{4}{\mathrm{depth}+4}$
13642 Note that this parameter is also used when
13643 \begin_inset Flex Code
13646 \begin_layout Plain Layout
13653 \begin_inset Flex Code
13656 \begin_layout Plain Layout
13663 \begin_inset Flex Code
13666 \begin_layout Plain Layout
13673 Then it is added to the manual or dynamic margin.
13674 \begin_inset Newline newline
13678 \begin_inset Quotes eld
13682 \begin_inset Flex Code
13685 \begin_layout Plain Layout
13692 \begin_inset Quotes erd
13695 means that the paragraph is indented with the width of
13696 \begin_inset Quotes eld
13700 \begin_inset Flex Code
13703 \begin_layout Plain Layout
13710 \begin_inset Quotes erd
13713 in the normal font.
13714 You can get a negative width by prefixing the string with
13715 \begin_inset Quotes eld
13719 \begin_inset Flex Code
13722 \begin_layout Plain Layout
13729 \begin_inset Quotes erd
13733 This way was chosen so that the look is the same with each used screen
13737 \begin_layout Description
13738 \begin_inset Flex Code
13741 \begin_layout Plain Layout
13748 \begin_inset Flex Code
13751 \begin_layout Plain Layout
13756 , Manual, Dynamic, First_Dynamic, Right_Address_Box
13762 \begin_inset Newline newline
13765 The kind of margin that the style has on the left side.
13769 \begin_layout Description
13770 \begin_inset Flex Code
13773 \begin_layout Plain Layout
13779 just means a fixed margin.
13782 \begin_layout Description
13783 \begin_inset Flex Code
13786 \begin_layout Plain Layout
13792 means that the left margin depends on the string entered in the
13793 \begin_inset Flex Noun
13796 \begin_layout Plain Layout
13797 Edit\SpecialChar menuseparator
13799 \begin_inset space ~
13808 This is used to typeset nice lists without tabulators.
13811 \begin_layout Description
13812 \begin_inset Flex Code
13815 \begin_layout Plain Layout
13821 means that the margin depends on the size of the label.
13822 This is used for automatic enumerated headlines.
13823 It is obvious that the headline
13824 \begin_inset Quotes eld
13827 5.4.3.2.1 Very long headline
13828 \begin_inset Quotes erd
13831 must have a wider left margin (as wide as
13832 \begin_inset Quotes eld
13836 \begin_inset Quotes erd
13839 plus the space) than
13840 \begin_inset Quotes eld
13843 3.2 Very long headline
13844 \begin_inset Quotes erd
13848 \begin_inset Quotes eld
13852 \begin_inset Quotes erd
13855 are not able to do this.
13858 \begin_layout Description
13859 \begin_inset Flex Code
13862 \begin_layout Plain Layout
13868 is similar, but only the very first row of the paragraph is dynamic, while
13869 the others are static; this is used, for example, for descriptions.
13872 \begin_layout Description
13873 \begin_inset Flex Code
13876 \begin_layout Plain Layout
13882 means the margin is chosen in a way that the longest row of this paragraph
13883 fits to the right margin.
13884 This is used to typeset an address on the right edge of the page.
13888 \begin_layout Description
13889 \begin_inset Flex Code
13892 \begin_layout Plain Layout
13899 \begin_inset Flex Code
13902 \begin_layout Plain Layout
13911 \begin_inset space \thinspace{}
13915 \begin_inset Flex Code
13918 \begin_layout Plain Layout
13924 ] Whether fragile commands in this style should be
13925 \begin_inset Flex Code
13928 \begin_layout Plain Layout
13941 whether this command should itself be protected.)
13944 \begin_layout Description
13945 \begin_inset Flex Code
13948 \begin_layout Plain Layout
13955 \begin_inset Flex Code
13958 \begin_layout Plain Layout
13965 \begin_inset space \thinspace{}
13969 \begin_inset Flex Code
13972 \begin_layout Plain Layout
13980 ] Whether newlines are translated into \SpecialChar LaTeX
13982 \begin_inset Flex Code
13985 \begin_layout Plain Layout
13996 The translation can be switched off to allow more comfortable \SpecialChar LaTeX
13998 inside \SpecialChar LyX
14002 \begin_layout Description
14003 \begin_inset Flex Code
14006 \begin_layout Plain Layout
14013 \begin_inset Flex Code
14016 \begin_layout Plain Layout
14025 \begin_inset space \thinspace{}
14029 \begin_inset Flex Code
14032 \begin_layout Plain Layout
14038 ] If set to true, and if
14039 \begin_inset Flex Code
14042 \begin_layout Plain Layout
14049 \begin_inset Flex Code
14052 \begin_layout Plain Layout
14058 ) paragraphs are being indented, then the indentation of such a paragraph
14059 following one of this type will be suppressed.
14060 (So this will not affect the display of non-default paragraphs.)
14063 \begin_layout Description
14064 \begin_inset Flex Code
14067 \begin_layout Plain Layout
14074 \begin_inset Flex Code
14077 \begin_layout Plain Layout
14083 ] Name of a style that has replaced this style.
14084 This is used to rename a style, while keeping backward compatibility.
14087 \begin_layout Description
14088 \begin_inset Flex Code
14091 \begin_layout Plain Layout
14098 \begin_inset Flex Code
14101 \begin_layout Plain Layout
14108 \begin_inset space \thinspace{}
14112 \begin_inset Flex Code
14115 \begin_layout Plain Layout
14121 ] Determines whether consecutive pragraphs of the same type are treated
14122 as belonging together.
14123 This has the effect that the
14124 \begin_inset Flex Code
14127 \begin_layout Plain Layout
14133 is only printed once before such a group.
14134 By default, this is true for
14135 \begin_inset Flex Code
14138 \begin_layout Plain Layout
14145 \begin_inset Flex Code
14148 \begin_layout Plain Layout
14155 \begin_inset Flex Code
14158 \begin_layout Plain Layout
14164 and false for all other types.
14167 \begin_layout Description
14168 \begin_inset Flex Code
14171 \begin_layout Plain Layout
14178 \begin_inset Flex Code
14181 \begin_layout Plain Layout
14190 \begin_inset space \thinspace{}
14194 \begin_inset Flex Code
14197 \begin_layout Plain Layout
14203 ] Indicates that paragraphs will not be separated by an empty line in \SpecialChar LaTeX
14205 but only by a line break; together with
14206 \begin_inset Flex Code
14209 \begin_layout Plain Layout
14215 , this allows to emulate a plain text editor (like the ERT inset).
14218 \begin_layout Description
14219 \begin_inset Flex Code
14222 \begin_layout Plain Layout
14229 \begin_inset Flex Code
14232 \begin_layout Plain Layout
14238 ] The indent of the very first line of a paragraph.
14240 \begin_inset Newline newline
14244 \begin_inset Flex Code
14247 \begin_layout Plain Layout
14253 will be fixed for a certain style.
14254 The exception is the default style, since the indentation for these paragraphs
14255 can be prohibited with
14256 \begin_inset Flex Code
14259 \begin_layout Plain Layout
14267 \begin_inset Flex Code
14270 \begin_layout Plain Layout
14276 style paragraphs inside environments use the
14277 \begin_inset Flex Code
14280 \begin_layout Plain Layout
14286 of the environment, not their native one.
14288 \begin_inset Flex Code
14291 \begin_layout Plain Layout
14297 paragraphs inside an enumeration are not indented.
14300 \begin_layout Description
14301 \begin_inset Flex Code
14304 \begin_layout Plain Layout
14311 \begin_inset Flex Code
14314 \begin_layout Plain Layout
14320 ] The vertical space between two paragraphs of this style.
14323 \begin_layout Description
14324 \begin_inset Flex Code
14327 \begin_layout Plain Layout
14334 \begin_inset Flex Code
14337 \begin_layout Plain Layout
14344 allows the user to choose either
14345 \begin_inset Quotes eld
14349 \begin_inset Quotes erd
14353 \begin_inset Quotes eld
14357 \begin_inset Quotes erd
14360 to separate paragraphs.
14362 \begin_inset Quotes eld
14366 \begin_inset Quotes erd
14370 \begin_inset Flex Code
14373 \begin_layout Plain Layout
14381 \begin_inset Quotes eld
14385 \begin_inset Quotes erd
14389 \begin_inset Flex Code
14392 \begin_layout Plain Layout
14398 is ignored and all paragraphs are separated by the
14399 \begin_inset Flex Code
14402 \begin_layout Plain Layout
14409 The vertical space is calculated with
14410 \begin_inset Flex Code
14413 \begin_layout Plain Layout
14415 \begin_inset space ~
14424 \begin_inset Flex Code
14427 \begin_layout Plain Layout
14433 is the height of a row with the normal font.
14434 This way, the look stays the same with different screen fonts.
14437 \begin_layout Description
14438 \begin_inset Flex Code
14441 \begin_layout Plain Layout
14448 \begin_inset Flex Code
14451 \begin_layout Plain Layout
14460 \begin_inset space \thinspace{}
14464 \begin_inset Flex Code
14467 \begin_layout Plain Layout
14473 ] Whether the contents of this paragraph should be output in raw form, meaning
14474 without special translations that \SpecialChar LaTeX
14478 \begin_layout Description
14479 \begin_inset Flex Code
14482 \begin_layout Plain Layout
14489 \begin_inset Flex Code
14492 \begin_layout Plain Layout
14502 Defines individual characters that should be output in raw form, meaning
14503 without special translations that \SpecialChar LaTeX
14507 \begin_layout Description
14508 \begin_inset Flex Code
14511 \begin_layout Plain Layout
14517 Information to be included in the \SpecialChar LaTeX
14518 preamble when this style is used.
14519 Used to define macros, load packages, etc., required by this particular
14522 \begin_inset Quotes eld
14526 \begin_inset Flex Code
14529 \begin_layout Plain Layout
14536 \begin_inset Quotes erd
14542 \begin_layout Description
14543 \begin_inset Flex Code
14546 \begin_layout Plain Layout
14553 \begin_inset Flex Code
14556 \begin_layout Plain Layout
14562 ] The prefix to use when creating labels referring to paragraphs of this
14564 This allows the use of formatted references.
14567 \begin_layout Description
14568 \begin_inset Flex Code
14571 \begin_layout Plain Layout
14578 \begin_inset Flex Code
14581 \begin_layout Plain Layout
14587 ] Whether the style requires the feature
14588 \begin_inset Flex Code
14591 \begin_layout Plain Layout
14598 \begin_inset CommandInset ref
14600 reference "chap:List-of-functions"
14604 for the list of features).
14605 If you require a package with specific options, you can additionally use
14607 \begin_inset Flex Code
14610 \begin_layout Plain Layout
14616 as a general text class parameter (see
14617 \begin_inset CommandInset ref
14619 reference "subsec:General-text-class"
14626 \begin_layout Description
14627 \begin_inset Flex Code
14630 \begin_layout Plain Layout
14637 \begin_inset Flex Code
14640 \begin_layout Plain Layout
14649 \begin_inset Flex Code
14652 \begin_layout Plain Layout
14658 ] Resets the \SpecialChar LaTeX
14659 arguments of this style (as defined via the
14660 \begin_inset Flex Code
14663 \begin_layout Plain Layout
14670 This is useful if you have copied a style via
14671 \begin_inset Flex Code
14674 \begin_layout Plain Layout
14680 , but you do not want to inherit its (required and optional) arguments.
14683 \begin_layout Description
14684 \begin_inset Flex Code
14687 \begin_layout Plain Layout
14694 \begin_inset Flex Code
14697 \begin_layout Plain Layout
14706 \begin_inset Flex Code
14709 \begin_layout Plain Layout
14715 ] Resumes a counter that is usually reset at each new sequence of layouts.
14716 This is currently only useful when
14717 \begin_inset Flex Code
14720 \begin_layout Plain Layout
14727 \begin_inset Flex Code
14730 \begin_layout Plain Layout
14739 \begin_layout Description
14740 \begin_inset Flex Code
14743 \begin_layout Plain Layout
14750 \begin_inset Flex Code
14753 \begin_layout Plain Layout
14759 ] A string that is put at the end of the layout content.
14760 A line break in the output can be indicated by
14761 \begin_inset Flex Code
14764 \begin_layout Plain Layout
14773 \begin_layout Description
14774 \begin_inset Flex Code
14777 \begin_layout Plain Layout
14784 \begin_inset Flex Code
14787 \begin_layout Plain Layout
14794 \begin_inset Flex Code
14797 \begin_layout Plain Layout
14806 \begin_layout Description
14807 \begin_inset Flex Code
14810 \begin_layout Plain Layout
14817 \begin_inset Flex Code
14820 \begin_layout Plain Layout
14829 \begin_inset Flex Code
14832 \begin_layout Plain Layout
14839 \begin_inset Flex Code
14842 \begin_layout Plain Layout
14849 \begin_inset Flex Code
14852 \begin_layout Plain Layout
14854 \begin_inset space ~
14862 ] This defines what the default spacing should be in the style.
14864 \begin_inset Flex Code
14867 \begin_layout Plain Layout
14874 \begin_inset Flex Code
14877 \begin_layout Plain Layout
14884 \begin_inset Flex Code
14887 \begin_layout Plain Layout
14893 correspond respectively to a multiplier value of 1, 1.25 and 1.667.
14894 If you specify the argument
14895 \begin_inset Flex Code
14898 \begin_layout Plain Layout
14904 , then you must also provide a value argument which will be the actual multiplie
14906 Note that, contrary to other parameters,
14907 \begin_inset Flex Code
14910 \begin_layout Plain Layout
14916 implies the generation of specific \SpecialChar LaTeX
14917 code, using the \SpecialChar LaTeX
14921 \begin_inset Flex Code
14924 \begin_layout Plain Layout
14933 \begin_layout Description
14934 \begin_inset Flex Code
14937 \begin_layout Plain Layout
14944 \begin_inset Flex Code
14947 \begin_layout Plain Layout
14954 \begin_inset space \thinspace{}
14958 \begin_inset Flex Code
14961 \begin_layout Plain Layout
14969 ] Allow spell-checking paragraphs of this style.
14973 \begin_layout Description
14974 \begin_inset Flex Code
14977 \begin_layout Plain Layout
14984 \begin_inset Flex Code
14987 \begin_layout Plain Layout
14996 \begin_inset Flex Code
14999 \begin_layout Plain Layout
15005 ] Steps the master counter of a given counter at the beginning of a new
15006 sequence of layouts.
15007 This is currently only useful when
15008 \begin_inset Flex Code
15011 \begin_layout Plain Layout
15018 \begin_inset Flex Code
15021 \begin_layout Plain Layout
15030 \begin_layout Description
15031 \begin_inset Flex Code
15034 \begin_layout Plain Layout
15040 The font used for the text body .
15042 \begin_inset CommandInset ref
15044 reference "subsec:Font-description"
15051 \begin_layout Description
15052 \begin_inset Flex Code
15055 \begin_layout Plain Layout
15064 \begin_inset Flex Code
15067 \begin_layout Plain Layout
15077 The level of the style in the table of contents.
15078 This is used for automatic numbering of section headings.
15081 \begin_layout Description
15082 \begin_inset Flex Code
15085 \begin_layout Plain Layout
15094 \begin_inset Flex Code
15097 \begin_layout Plain Layout
15108 \begin_inset Flex Code
15111 \begin_layout Plain Layout
15118 \begin_inset Flex Code
15121 \begin_layout Plain Layout
15127 ] This tag determines whether the first line indentation of this paragraph
15128 can be toggled via the Paragraph settings dialog.
15132 \begin_inset Flex Code
15135 \begin_layout Plain Layout
15145 is set, indentation can be toggled if the document settings use
15146 \begin_inset Quotes eld
15150 \begin_inset Quotes erd
15153 paragraph style, with
15154 \begin_inset Flex Code
15157 \begin_layout Plain Layout
15163 , indentation can always be toggled, notwithstanding the document settings,
15165 \begin_inset Flex Code
15168 \begin_layout Plain Layout
15174 , indentation can never be toggled.
15177 \begin_layout Description
15178 \begin_inset Flex Code
15181 \begin_layout Plain Layout
15188 \begin_inset Flex Code
15191 \begin_layout Plain Layout
15197 ] The vertical space with which the very first of a chain of paragraphs
15198 with this style is separated from the previous paragraph.
15199 If the previous paragraph has another style, the separations are not simply
15200 added, but the maximum is taken.
15203 \begin_layout Subsection
15204 \begin_inset CommandInset label
15210 Internationalization of Paragraph Styles
15213 \begin_layout Standard
15215 has long supported internationalization of layout information, but, until
15216 version 2.0, this applied only to the user interface and not to, say, PDF
15218 Thus, French authors were forced to resort to ugly hacks if they wanted
15223 1' instead of `Theorem 1'.
15224 Thanks to Georg Baum, that is no longer the case.
15227 \begin_layout Standard
15229 \begin_inset Flex Code
15232 \begin_layout Plain Layout
15238 defines text that is to appear in the typeset document, it may use
15239 \begin_inset Flex Code
15242 \begin_layout Plain Layout
15249 \begin_inset Flex Code
15252 \begin_layout Plain Layout
15258 to support non-English and even multi-language documents correctly.
15259 The following excerpt (from the
15260 \begin_inset Flex Code
15263 \begin_layout Plain Layout
15269 file) shows how this works:
15272 \begin_layout LyX-Code
15277 \begin_layout LyX-Code
15280 theoremstyle{remark}
15283 \begin_layout LyX-Code
15286 newtheorem{claim}[thm]{
15293 \begin_layout LyX-Code
15297 \begin_layout LyX-Code
15301 \begin_layout LyX-Code
15306 claimname}{_(Claim)}
15309 \begin_layout LyX-Code
15313 \begin_layout LyX-Code
15317 \begin_layout LyX-Code
15326 claimname}{_(Claim)}}
15329 \begin_layout LyX-Code
15334 \begin_layout Standard
15335 In principle, any legal \SpecialChar LaTeX
15337 \begin_inset Flex Code
15340 \begin_layout Plain Layout
15347 \begin_inset Flex Code
15350 \begin_layout Plain Layout
15356 tags, but in practice they will typically look as they do here.
15357 The key to correct translation of the typeset text is the definition of
15358 the \SpecialChar LaTeX
15360 \begin_inset Flex Code
15363 \begin_layout Plain Layout
15372 \begin_inset Flex Code
15375 \begin_layout Plain Layout
15387 \begin_layout Standard
15389 \begin_inset Flex Code
15392 \begin_layout Plain Layout
15398 tag provides for internationalization based upon the overall language of
15400 The contents of the tag will be included in the preamble, just as with
15402 \begin_inset Flex Code
15405 \begin_layout Plain Layout
15412 What makes it special is the use of the
15413 \begin_inset Quotes eld
15417 \begin_inset Quotes erd
15421 \begin_inset Flex Code
15424 \begin_layout Plain Layout
15430 , which will be replaced, when \SpecialChar LyX
15431 produces \SpecialChar LaTeX
15432 output, with the translation of
15433 its argument into the document language.
15436 \begin_layout Standard
15438 \begin_inset Flex Code
15441 \begin_layout Plain Layout
15447 tag is more complex, since it is meant to provide support for multi-language
15448 documents and so offers an interface to the
15449 \begin_inset Flex Code
15452 \begin_layout Plain Layout
15459 Its contents will be added to the preamble once for each language that
15460 appears in the document.
15461 In this case, the argument to
15462 \begin_inset Flex Code
15465 \begin_layout Plain Layout
15471 will be replaced with its translation into the language in question; the
15473 \begin_inset Flex Code
15476 \begin_layout Plain Layout
15482 is replaced by the language name (as used by the babel package).
15485 \begin_layout Standard
15486 A German document that also included a French section would thus have the
15487 following in the preamble:
15490 \begin_layout LyX-Code
15499 claimname}{Affirmation}}
15500 \begin_inset Newline newline
15511 claimname}{Behauptung}}
15512 \begin_inset Newline newline
15519 claimname}{Behauptung}
15522 \begin_layout Standard
15525 \begin_inset Flex Code
15528 \begin_layout Plain Layout
15534 will then conspire to produce the correct text in the output.
15537 \begin_layout Standard
15538 One important point to note here is that the translations are provided by
15540 itself, through the file
15541 \begin_inset Flex Code
15544 \begin_layout Plain Layout
15551 This means, in effect, that
15552 \begin_inset Flex Code
15555 \begin_layout Plain Layout
15562 \begin_inset Flex Code
15565 \begin_layout Plain Layout
15571 are really only of use in layout files that are provided with \SpecialChar LyX
15573 entered in user-created layout files will not be seen by \SpecialChar LyX
15574 's internationalizatio
15575 n routines unless the
15576 \begin_inset Flex Code
15579 \begin_layout Plain Layout
15585 file is modified accordingly.
15586 That said, however, any layout created with the intention that it will
15587 be included with \SpecialChar LyX
15588 should use these tags where appropriate.
15589 Please note that the paragraph style translations provided by \SpecialChar LyX
15591 change with a minor update (e.
15592 \begin_inset space \thinspace{}
15596 \begin_inset space \space{}
15599 from version 2.1.x to 2.1.y).
15600 It is however quite likely that a major update (e.
15601 \begin_inset space \thinspace{}
15605 \begin_inset space \space{}
15608 from 2.0.x to 2.1.y) will introduce new translations or corrections.
15611 \begin_layout Subsection
15613 \begin_inset CommandInset label
15615 name "subsec:Floats"
15622 \begin_layout Standard
15623 It is necessary to define the floats (
15624 \begin_inset Flex Noun
15627 \begin_layout Plain Layout
15634 \begin_inset Flex Noun
15637 \begin_layout Plain Layout
15643 , \SpecialChar ldots
15644 ) in the text class itself.
15645 Standard floats are included in the file
15646 \begin_inset Flex Code
15649 \begin_layout Plain Layout
15655 , so you may have to do no more than add
15658 \begin_layout LyX-Code
15659 Input stdfloats.inc
15662 \begin_layout Standard
15663 to your layout file.
15664 If you want to implement a text class that proposes some other float types
15665 (like the AGU class bundled with \SpecialChar LyX
15666 ), the information below will hopefully
15670 \begin_layout Description
15671 \begin_inset Flex Code
15674 \begin_layout Plain Layout
15681 \begin_inset Flex Code
15684 \begin_layout Plain Layout
15690 =!htbpH] Allowed placement options for this float type.
15691 The value is a string of placement characters.
15692 Possible characters include:
15697 \begin_inset Quotes eld
15701 \begin_inset Quotes erd
15709 \begin_inset Quotes eld
15713 \begin_inset Quotes erd
15721 \begin_inset Quotes eld
15725 \begin_inset Quotes erd
15733 \begin_inset Quotes eld
15737 \begin_inset Quotes erd
15745 \begin_inset Quotes eld
15749 \begin_inset Quotes erd
15757 \begin_inset Quotes eld
15761 \begin_inset Quotes erd
15765 The order of the characters in the string does not matter.
15766 If no placement options are allowed, use the string
15773 \begin_layout Description
15774 \begin_inset Flex Code
15777 \begin_layout Plain Layout
15784 \begin_inset Flex Code
15787 \begin_layout Plain Layout
15796 \begin_inset space \thinspace{}
15802 \begin_inset Flex Code
15805 \begin_layout Plain Layout
15815 ] Defines whether the float allows to be rotated via the \SpecialChar LaTeX
15822 \begin_inset Flex Code
15825 \begin_layout Plain Layout
15831 if the float does not support this feature.
15834 \begin_layout Description
15835 \begin_inset Flex Code
15838 \begin_layout Plain Layout
15845 \begin_inset Flex Code
15848 \begin_layout Plain Layout
15857 \begin_inset space \thinspace{}
15863 \begin_inset Flex Code
15866 \begin_layout Plain Layout
15876 ] Defines whether the float has a starred variant that spans columns in
15877 a two column paragraph.
15879 \begin_inset Flex Code
15882 \begin_layout Plain Layout
15888 if the float does not support this feature.
15891 \begin_layout Description
15892 \begin_inset Flex Code
15895 \begin_layout Plain Layout
15902 \begin_inset Flex Code
15905 \begin_layout Plain Layout
15912 \begin_inset Quotes erd
15916 \begin_inset Quotes erd
15919 ] The file name extension of an auxiliary file for the list of figures (or
15922 writes the captions to this file.
15925 \begin_layout Description
15926 \begin_inset Flex Code
15929 \begin_layout Plain Layout
15936 \begin_inset Flex Code
15939 \begin_layout Plain Layout
15946 \begin_inset Quotes erd
15950 \begin_inset Quotes erd
15953 ] The string that will be used in the menus and also for the caption.
15954 This is translated to the current language if babel is used.
15957 \begin_layout Description
15958 \begin_inset Flex Code
15961 \begin_layout Plain Layout
15967 These tags control the XHTML output.
15969 \begin_inset CommandInset ref
15971 reference "sec:Tags-for-XHTML"
15978 \begin_layout Description
15979 \begin_inset Flex Code
15982 \begin_layout Plain Layout
15991 \begin_inset Flex Code
15994 \begin_layout Plain Layout
16003 \begin_inset space \thinspace{}
16007 \begin_inset Flex Code
16010 \begin_layout Plain Layout
16016 ] Indicates whether the float is already defined in the document class or
16017 if instead the \SpecialChar LaTeX
16019 \begin_inset Flex Code
16022 \begin_layout Plain Layout
16028 needs to be loaded to define it on-the-fly.
16030 \begin_inset Flex Code
16033 \begin_layout Plain Layout
16040 \begin_inset Flex Code
16043 \begin_layout Plain Layout
16050 It should be set to
16051 \begin_inset Flex Code
16054 \begin_layout Plain Layout
16060 if the float is already defined by the \SpecialChar LaTeX
16064 \begin_layout Description
16065 \begin_inset Flex Code
16068 \begin_layout Plain Layout
16075 \begin_inset Flex Code
16078 \begin_layout Plain Layout
16085 \begin_inset Quotes erd
16089 \begin_inset Quotes erd
16092 ] The command used to generate a list of floats of this type; the leading
16101 \begin_inset Flex Code
16104 \begin_layout Plain Layout
16110 is false, since there is no standard way to generate this command.
16112 \begin_inset Flex Code
16115 \begin_layout Plain Layout
16121 is true, since in that case there is a standard way to define the command.
16124 \begin_layout Description
16125 \begin_inset Flex Code
16128 \begin_layout Plain Layout
16135 \begin_inset Flex Code
16138 \begin_layout Plain Layout
16145 \begin_inset Quotes erd
16149 \begin_inset Quotes erd
16152 ] A title for a list of floats of this kind (list of figures, tables, or
16154 It is used for the screen label within \SpecialChar LyX
16155 , it is used by \SpecialChar LaTeX
16157 it is used as the title in the XHTML output.
16158 It will be translated to the document language.
16161 \begin_layout Description
16162 \begin_inset Flex Code
16165 \begin_layout Plain Layout
16172 \begin_inset Flex Code
16175 \begin_layout Plain Layout
16182 \begin_inset Quotes erd
16186 \begin_inset Quotes erd
16189 ] This (optional) argument determines whether floats of this class will
16190 be numbered within some sectional unit of the document.
16192 \begin_inset Flex Code
16195 \begin_layout Plain Layout
16202 \begin_inset Quotes eld
16206 \begin_inset Flex Code
16209 \begin_layout Plain Layout
16216 \begin_inset Quotes erd
16219 , the floats will be numbered within chapters.
16223 \begin_layout Description
16224 \begin_inset Flex Code
16227 \begin_layout Plain Layout
16234 \begin_inset Flex Code
16237 \begin_layout Plain Layout
16244 \begin_inset Quotes erd
16248 \begin_inset Quotes erd
16251 ] The default placement for the given class of floats.
16252 The string should be as in standard \SpecialChar LaTeX
16254 \begin_inset Flex Code
16257 \begin_layout Plain Layout
16264 \begin_inset Flex Code
16267 \begin_layout Plain Layout
16274 \begin_inset Flex Code
16277 \begin_layout Plain Layout
16284 \begin_inset Flex Code
16287 \begin_layout Plain Layout
16293 for top, bottom, page, and here, respectively.
16297 \begin_layout Plain Layout
16298 Note that the order of these letters in the string is irrelevant, like in
16305 On top of that there is a new type,
16306 \begin_inset Flex Code
16309 \begin_layout Plain Layout
16315 , which does not really correspond to a float, since it means: put it
16316 \begin_inset Quotes eld
16320 \begin_inset Quotes erd
16324 Note however that the
16325 \begin_inset Flex Code
16328 \begin_layout Plain Layout
16334 specifier is special and, because of implementation details, cannot be
16335 used in non-built in float types.
16336 If you do not understand what this means, just use
16337 \begin_inset Quotes eld
16341 \begin_inset Flex Code
16344 \begin_layout Plain Layout
16351 \begin_inset Quotes erd
16357 \begin_layout Description
16358 \begin_inset Flex Code
16361 \begin_layout Plain Layout
16368 \begin_inset Flex Code
16371 \begin_layout Plain Layout
16377 ] The prefix to use when creating labels referring to floats of this type.
16378 This allows the use of formatted references.
16379 Note that you can remove any
16380 \begin_inset Flex Code
16383 \begin_layout Plain Layout
16389 set by a copied style by using the special value
16390 \begin_inset Quotes eld
16394 \begin_inset Quotes erd
16397 , which must be all caps.
16400 \begin_layout Description
16401 \begin_inset Flex Code
16404 \begin_layout Plain Layout
16411 \begin_inset Flex Code
16414 \begin_layout Plain Layout
16421 \begin_inset Quotes erd
16425 \begin_inset Quotes erd
16428 ] The style used when defining the float using
16429 \begin_inset Flex Code
16432 \begin_layout Plain Layout
16443 \begin_layout Description
16444 \begin_inset Flex Code
16447 \begin_layout Plain Layout
16454 \begin_inset Flex Code
16457 \begin_layout Plain Layout
16464 \begin_inset Quotes erd
16468 \begin_inset Quotes erd
16472 \begin_inset Quotes eld
16476 \begin_inset Quotes erd
16479 of the new class of floats, like program or algorithm.
16480 After the appropriate
16481 \begin_inset Flex Code
16484 \begin_layout Plain Layout
16493 \begin_inset Flex Code
16496 \begin_layout Plain Layout
16505 \begin_inset Flex Code
16508 \begin_layout Plain Layout
16519 \begin_layout Description
16520 \begin_inset Flex Code
16523 \begin_layout Plain Layout
16530 \begin_inset Flex Code
16533 \begin_layout Plain Layout
16540 \begin_inset space \thinspace{}
16544 \begin_inset Flex Code
16547 \begin_layout Plain Layout
16555 ] Specifies whether this float is defined using the \SpecialChar LaTeX
16557 \begin_inset Flex Code
16560 \begin_layout Plain Layout
16566 , either by the class file, another package or on-the-fly by \SpecialChar LyX
16570 \begin_layout Standard
16571 Note that defining a float with type
16572 \begin_inset Flex Code
16575 \begin_layout Plain Layout
16583 automatically defines the corresponding counter with name
16584 \begin_inset Flex Code
16587 \begin_layout Plain Layout
16598 \begin_layout Subsection
16599 Flex insets and InsetLayout
16600 \begin_inset CommandInset label
16602 name "subsec:Flex-insets-and"
16609 \begin_layout Standard
16610 Flex insets come in three different kinds:
16613 \begin_layout Itemize
16615 \begin_inset Flex Code
16618 \begin_layout Plain Layout
16624 ): These define semantic markup corresponding to such \SpecialChar LaTeX
16626 \begin_inset Flex Code
16629 \begin_layout Plain Layout
16638 \begin_inset Flex Code
16641 \begin_layout Plain Layout
16652 \begin_layout Itemize
16654 \begin_inset Flex Code
16657 \begin_layout Plain Layout
16663 ): These can be used to define custom collapsible insets, similar to \SpecialChar TeX
16665 footnote, and the like.
16666 An obvious example is an endnote inset, which is defined in the
16667 \begin_inset Flex Code
16670 \begin_layout Plain Layout
16679 \begin_layout Itemize
16681 \begin_inset Flex Code
16684 \begin_layout Plain Layout
16690 ): For use with DocBook classes.
16693 \begin_layout Standard
16694 Flex insets are defined using the
16695 \begin_inset Flex Code
16698 \begin_layout Plain Layout
16704 tag, which shall be explained in a moment.
16707 \begin_layout Standard
16709 \begin_inset Flex Code
16712 \begin_layout Plain Layout
16718 tag also serves another function: It can be used to customize the general
16719 layout of many different types of insets.
16721 \begin_inset Flex Code
16724 \begin_layout Plain Layout
16730 can be used to customize the layout parameters for footnotes, marginal
16731 notes, note insets, \SpecialChar TeX
16732 code (ERT) insets, branches, listings, indexes, boxes,
16733 tables, algorithms, URLs, and captions, as well as to define Flex insets.
16736 \begin_layout Standard
16738 \begin_inset Flex Code
16741 \begin_layout Plain Layout
16747 definition must begin with a line of the form:
16750 \begin_layout LyX-Code
16754 \begin_layout Standard
16756 \begin_inset Flex Code
16759 \begin_layout Plain Layout
16765 indicates the inset whose layout is being defined, and here there are four
16769 \begin_layout Enumerate
16770 The layout for a pre-existing inset is being modified.
16771 In this case, can be
16772 \begin_inset Flex Code
16775 \begin_layout Plain Layout
16781 any one of the following:
16782 \begin_inset Flex Code
16785 \begin_layout Plain Layout
16792 \begin_inset Flex Code
16795 \begin_layout Plain Layout
16802 \begin_inset Flex Code
16805 \begin_layout Plain Layout
16812 \begin_inset Flex Code
16815 \begin_layout Plain Layout
16822 \begin_inset Flex Code
16825 \begin_layout Plain Layout
16832 \begin_inset Flex Code
16835 \begin_layout Plain Layout
16842 \begin_inset Flex Code
16845 \begin_layout Plain Layout
16852 \begin_inset Flex Code
16855 \begin_layout Plain Layout
16862 \begin_inset Flex Code
16865 \begin_layout Plain Layout
16872 \begin_inset Flex Code
16875 \begin_layout Plain Layout
16882 \begin_inset Flex Code
16885 \begin_layout Plain Layout
16892 \begin_inset Flex Code
16895 \begin_layout Plain Layout
16902 \begin_inset Flex Code
16905 \begin_layout Plain Layout
16912 \begin_inset Flex Code
16915 \begin_layout Plain Layout
16922 \begin_inset Flex Code
16925 \begin_layout Plain Layout
16932 \begin_inset Flex Code
16935 \begin_layout Plain Layout
16942 \begin_inset Flex Code
16945 \begin_layout Plain Layout
16952 \begin_inset Flex Code
16955 \begin_layout Plain Layout
16962 \begin_inset Flex Code
16965 \begin_layout Plain Layout
16972 \begin_inset Flex Code
16975 \begin_layout Plain Layout
16984 \begin_layout Enumerate
16985 The layout for a Flex inset is being defined.
16987 \begin_inset Flex Code
16990 \begin_layout Plain Layout
16996 must be of the form
16997 \begin_inset Quotes eld
17001 \begin_inset Flex Code
17004 \begin_layout Plain Layout
17011 \begin_inset Quotes erd
17015 \begin_inset Flex Code
17018 \begin_layout Plain Layout
17024 may be be any valid identifier not used by a pre-existing Flex inset.
17025 The identifier may include spaces, but in that case the whole thing must
17026 be wrapped in quotes.
17027 Note that the definition of a flex inset
17032 \begin_inset Flex Code
17035 \begin_layout Plain Layout
17041 entry, declaring which type of inset it defines.
17044 \begin_layout Enumerate
17045 The layout for user specific branch is being defined.
17047 \begin_inset Flex Code
17050 \begin_layout Plain Layout
17056 must be of the form
17057 \begin_inset Quotes eld
17061 \begin_inset Flex Code
17064 \begin_layout Plain Layout
17071 \begin_inset Quotes erd
17075 \begin_inset Flex Code
17078 \begin_layout Plain Layout
17084 may be be any valid identifier of branch defined in user's document.
17085 The identifier may include spaces, but in that case the whole thing must
17086 be wrapped in quotes.
17087 The main purpose of this feature is to allow \SpecialChar LaTeX
17088 wrapping around specific
17089 branches as user needs.
17092 \begin_layout Enumerate
17093 The layout of a user (or class) specific caption is being defined.
17095 \begin_inset Flex Code
17098 \begin_layout Plain Layout
17104 must be of the form
17105 \begin_inset Quotes eld
17109 \begin_inset Flex Code
17112 \begin_layout Plain Layout
17119 \begin_inset Quotes erd
17123 \begin_inset Flex Code
17126 \begin_layout Plain Layout
17132 specifies the name of the caption as it appears in the menu.
17133 Have a look at the standard caption (
17134 \begin_inset Flex Code
17137 \begin_layout Plain Layout
17143 ), the specific captions of the KOMA-Script classes (
17144 \begin_inset Flex Code
17147 \begin_layout Plain Layout
17154 \begin_inset Flex Code
17157 \begin_layout Plain Layout
17166 \begin_inset space ~
17172 \begin_inset Flex Code
17175 \begin_layout Plain Layout
17181 ) for applications.
17184 \begin_layout Standard
17186 \begin_inset Flex Code
17189 \begin_layout Plain Layout
17195 definition can contain the following entries:
17198 \begin_layout Description
17199 \begin_inset Flex Code
17202 \begin_layout Plain Layout
17209 \begin_inset Flex Code
17212 \begin_layout Plain Layout
17218 ] Defines argument number of a command\SpecialChar breakableslash
17219 environment associated with the current
17221 The definition must end with
17222 \begin_inset Flex Code
17225 \begin_layout Plain Layout
17233 \begin_inset CommandInset ref
17235 reference "subsec:Paragraph-Styles"
17242 \begin_layout Description
17243 \begin_inset Flex Code
17246 \begin_layout Plain Layout
17252 Preamble for changing language commands; see
17253 \begin_inset CommandInset ref
17255 reference "subsec:I18n"
17262 \begin_layout Description
17263 \begin_inset Flex Code
17266 \begin_layout Plain Layout
17273 \begin_inset Flex Code
17276 \begin_layout Plain Layout
17282 ] The color for the inset's background.
17284 \begin_inset CommandInset ref
17286 reference "chap:Names-of-colors"
17290 for a list of the available color names.
17293 \begin_layout Description
17294 \begin_inset Flex Code
17297 \begin_layout Plain Layout
17304 \begin_inset Flex Code
17307 \begin_layout Plain Layout
17316 \begin_inset space \thinspace{}
17320 \begin_inset Flex Code
17323 \begin_layout Plain Layout
17329 ] Whether to use the content of the inset as the label, when the inset is
17334 \begin_layout Description
17335 \begin_inset Flex Code
17338 \begin_layout Plain Layout
17345 \begin_inset Flex Code
17348 \begin_layout Plain Layout
17354 ] As with paragraph styles, see
17355 \begin_inset CommandInset ref
17357 reference "subsec:Paragraph-Styles"
17362 Note that you need to specify the complete type, e.
17363 \begin_inset space \thinspace{}
17367 \begin_inset space ~
17371 \begin_inset Flex Code
17374 \begin_layout Plain Layout
17375 CopyStyle Flex:<name>
17383 \begin_layout Description
17384 \begin_inset Flex Code
17387 \begin_layout Plain Layout
17394 \begin_inset Flex Code
17397 \begin_layout Plain Layout
17406 \begin_inset space \thinspace{}
17410 \begin_inset Flex Code
17413 \begin_layout Plain Layout
17419 ] Indicates whether the user may employ the Paragraph Settings dialog to
17420 customize the paragraph.
17423 \begin_layout Description
17424 \begin_inset Flex Code
17427 \begin_layout Plain Layout
17434 \begin_inset Flex Code
17437 \begin_layout Plain Layout
17444 \begin_inset Flex Code
17447 \begin_layout Plain Layout
17454 \begin_inset Flex Code
17457 \begin_layout Plain Layout
17463 , describing the rendering style used for the inset's frame and buttons.
17464 Footnotes generally use
17465 \begin_inset Flex Code
17468 \begin_layout Plain Layout
17474 , ERT insets generally
17475 \begin_inset Flex Code
17478 \begin_layout Plain Layout
17484 , and character styles
17485 \begin_inset Flex Code
17488 \begin_layout Plain Layout
17497 \begin_layout Description
17498 \begin_inset Flex Code
17501 \begin_layout Plain Layout
17508 \begin_inset Flex Code
17511 \begin_layout Plain Layout
17520 \begin_inset space \thinspace{}
17526 \begin_inset Flex Code
17529 \begin_layout Plain Layout
17538 \begin_inset Flex Code
17541 \begin_layout Plain Layout
17548 \begin_inset Flex Code
17551 \begin_layout Plain Layout
17558 Indicates whether the environment will stand on its own in the output or
17559 will appear inline with the surrounding text.
17560 If set to false, it is supposed that the \SpecialChar LaTeX
17561 environment ignores white space
17562 (including one newline character) after the
17563 \begin_inset Flex Code
17566 \begin_layout Plain Layout
17579 \begin_inset Flex Code
17582 \begin_layout Plain Layout
17598 \begin_layout Description
17599 \begin_inset Flex Code
17602 \begin_layout Plain Layout
17608 Required at the end of the
17609 \begin_inset Flex Code
17612 \begin_layout Plain Layout
17621 \begin_layout Description
17622 \begin_inset Flex Code
17625 \begin_layout Plain Layout
17631 The font used for both the text body
17637 \begin_inset CommandInset ref
17639 reference "subsec:Font-description"
17644 Note that defining this font automatically defines the
17645 \begin_inset Flex Code
17648 \begin_layout Plain Layout
17654 to the same value, so define this first and define
17655 \begin_inset Flex Code
17658 \begin_layout Plain Layout
17664 later if you want them to be different.
17667 \begin_layout Description
17668 \begin_inset Flex Code
17671 \begin_layout Plain Layout
17672 FixedWidthPreambleEncoding
17678 \begin_inset Flex Code
17681 \begin_layout Plain Layout
17690 \begin_inset space \thinspace{}
17694 \begin_inset Flex Code
17697 \begin_layout Plain Layout
17703 ] Force a fixed width encoding for the translated contents of
17704 \begin_inset Flex Code
17707 \begin_layout Plain Layout
17714 \begin_inset Flex Code
17717 \begin_layout Plain Layout
17723 code generated by this layout.
17724 This is needed for special \SpecialChar LaTeX
17729 that do not work with variable width encodings such as
17734 This setting is ignored if fully Unicode aware \SpecialChar LaTeX
17735 backends such as Xe\SpecialChar TeX
17737 Lua\SpecialChar TeX
17741 \begin_layout Description
17742 \begin_inset Flex Code
17745 \begin_layout Plain Layout
17746 ForceLocalFontSwitch
17752 \begin_inset Flex Code
17755 \begin_layout Plain Layout
17764 \begin_inset space \thinspace{}
17768 \begin_inset Flex Code
17771 \begin_layout Plain Layout
17777 ] When using babel, always use a local font switch (
17778 \begin_inset Flex Code
17781 \begin_layout Plain Layout
17789 ), never a global one (such as
17790 \begin_inset Flex Code
17793 \begin_layout Plain Layout
17804 \begin_layout Description
17805 \begin_inset Flex Code
17808 \begin_layout Plain Layout
17815 \begin_inset Flex Code
17818 \begin_layout Plain Layout
17827 \begin_inset space \thinspace{}
17831 \begin_inset Flex Code
17834 \begin_layout Plain Layout
17841 \begin_inset Quotes eld
17845 \begin_inset Quotes erd
17848 language, leading to Left-to-Right (Latin) output, e.
17849 \begin_inset space \thinspace{}
17853 \begin_inset space \space{}
17856 in \SpecialChar TeX
17861 \begin_layout Description
17862 \begin_inset Flex Code
17865 \begin_layout Plain Layout
17872 \begin_inset Flex Code
17875 \begin_layout Plain Layout
17884 \begin_inset space \thinspace{}
17888 \begin_inset Flex Code
17891 \begin_layout Plain Layout
17897 ] Force a a line break in the \SpecialChar LaTeX
17898 output before the inset starts and after
17900 This assures the inset itself is output on its own lines, for parsing purposes.
17903 \begin_layout Description
17904 \begin_inset Flex Code
17907 \begin_layout Plain Layout
17914 \begin_inset Flex Code
17917 \begin_layout Plain Layout
17926 \begin_inset space \thinspace{}
17930 \begin_inset Flex Code
17933 \begin_layout Plain Layout
17939 ] Indicates whether the
17940 \begin_inset Flex Code
17943 \begin_layout Plain Layout
17949 should be used or, instead, the user can change the paragraph style used
17954 \begin_layout Description
17955 \begin_inset Flex Code
17958 \begin_layout Plain Layout
17965 \begin_inset Flex Code
17968 \begin_layout Plain Layout
17977 \begin_inset space \thinspace{}
17981 \begin_inset Flex Code
17984 \begin_layout Plain Layout
17990 ] As with paragraph styles, see
17991 \begin_inset CommandInset ref
17993 reference "subsec:Paragraph-Styles"
18000 \begin_layout Description
18001 \begin_inset Flex Code
18004 \begin_layout Plain Layout
18010 These tags control the XHTML output.
18012 \begin_inset CommandInset ref
18014 reference "sec:Tags-for-XHTML"
18021 \begin_layout Description
18022 \begin_inset Flex Code
18025 \begin_layout Plain Layout
18032 \begin_inset Flex Code
18035 \begin_layout Plain Layout
18044 \begin_inset space \thinspace{}
18048 \begin_inset Flex Code
18051 \begin_layout Plain Layout
18057 ] Whether to include the contents of this inset in the strings generated
18058 for the `Outline' pane.
18059 One would not, for example, want the content of a footnote in a section
18060 header to be included in the TOC displayed in the outline, but one would
18061 normally want the content of a character style displayed.
18062 Default is false: not to include.
18065 \begin_layout Description
18066 \begin_inset Flex Code
18069 \begin_layout Plain Layout
18078 \begin_inset Flex Code
18081 \begin_layout Plain Layout
18090 \begin_inset space \thinspace{}
18094 \begin_inset Flex Code
18097 \begin_layout Plain Layout
18103 ] As with paragraph styles, see
18104 \begin_inset CommandInset ref
18106 reference "subsec:Paragraph-Styles"
18113 \begin_layout Description
18114 \begin_inset Flex Code
18117 \begin_layout Plain Layout
18123 The font used for the label.
18125 \begin_inset CommandInset ref
18127 reference "subsec:Font-description"
18132 Note that this definition can never appear before
18133 \begin_inset Flex Code
18136 \begin_layout Plain Layout
18142 , lest it be ineffective.
18145 \begin_layout Description
18146 \begin_inset Flex Code
18149 \begin_layout Plain Layout
18156 \begin_inset Flex Code
18159 \begin_layout Plain Layout
18166 \begin_inset Quotes erd
18170 \begin_inset Quotes erd
18173 ] What will be displayed on the button or elsewhere as the inset label.
18175 \begin_inset Flex Code
18178 \begin_layout Plain Layout
18186 \begin_inset Flex Code
18189 \begin_layout Plain Layout
18195 ) modify this label on the fly.
18198 \begin_layout Description
18199 \begin_inset Flex Code
18202 \begin_layout Plain Layout
18208 Language dependent preamble; see
18209 \begin_inset CommandInset ref
18211 reference "subsec:I18n"
18218 \begin_layout Description
18219 \begin_inset Flex Code
18222 \begin_layout Plain Layout
18229 \begin_inset Flex Code
18232 \begin_layout Plain Layout
18238 ] The name of the corresponding \SpecialChar LaTeX
18240 Either the environment or command name.
18243 \begin_layout Description
18244 \begin_inset Flex Code
18247 \begin_layout Plain Layout
18254 \begin_inset Flex Code
18257 \begin_layout Plain Layout
18263 ] The optional parameter for the corresponding
18264 \begin_inset Flex Code
18267 \begin_layout Plain Layout
18273 stuff, including possible bracket pairs like
18274 \begin_inset Flex Code
18277 \begin_layout Plain Layout
18284 This parameter cannot be changed from within \SpecialChar LyX
18286 \begin_inset Flex Code
18289 \begin_layout Plain Layout
18295 for customizable parameters).
18296 It will be output as is after all \SpecialChar LaTeX
18298 \begin_inset Flex Code
18301 \begin_layout Plain Layout
18310 \begin_layout Description
18311 \begin_inset Flex Code
18314 \begin_layout Plain Layout
18321 \begin_inset Flex Code
18324 \begin_layout Plain Layout
18325 Command, Environment, None
18330 ] How the style should be translated into \SpecialChar LaTeX
18335 \begin_layout Plain Layout
18336 \begin_inset Flex Code
18339 \begin_layout Plain Layout
18345 is perhaps a bit misleading, since these rules apply to SGML classes too.
18346 Visit the SGML class files for specific examples.
18355 \begin_layout Description
18356 \begin_inset Flex Code
18359 \begin_layout Plain Layout
18365 means nothing special
18368 \begin_layout Description
18369 \begin_inset Flex Code
18372 \begin_layout Plain Layout
18379 \begin_inset Flex Code
18382 \begin_layout Plain Layout
18389 {\SpecialChar ldots
18398 \begin_layout Description
18399 \begin_inset Flex Code
18402 \begin_layout Plain Layout
18409 \begin_inset Flex Code
18412 \begin_layout Plain Layout
18419 }\SpecialChar ldots
18434 \begin_layout Standard
18435 Putting the last few things together, the \SpecialChar LaTeX
18436 output will be either:
18439 \begin_layout LyX-Code
18442 LatexName[LatexParam]{\SpecialChar ldots
18446 \begin_layout Standard
18450 \begin_layout LyX-Code
18453 begin{LatexName}[LatexParam] \SpecialChar ldots
18459 \begin_layout Standard
18460 depending upon the \SpecialChar LaTeX
18465 \begin_layout Description
18466 \begin_inset Flex Code
18469 \begin_layout Plain Layout
18476 \begin_inset Flex Code
18479 \begin_layout Plain Layout
18485 ] A string that is put at the beginning of the layout content.
18486 A line break in the output can be indicated by
18487 \begin_inset Flex Code
18490 \begin_layout Plain Layout
18499 \begin_layout Description
18500 \begin_inset Flex Code
18503 \begin_layout Plain Layout
18510 \begin_inset Flex Code
18513 \begin_layout Plain Layout
18520 \begin_inset Flex Code
18523 \begin_layout Plain Layout
18530 \begin_inset Flex Code
18533 \begin_layout Plain Layout
18540 \begin_inset Flex Code
18543 \begin_layout Plain Layout
18549 (indicating a dummy definition ending definitions of charstyles, etc).
18550 This entry is required in and is only meaningful for Flex insets.
18551 Among other things, it determines on which menu this inset will appear.
18553 \begin_inset Flex Code
18556 \begin_layout Plain Layout
18563 \begin_inset Flex Code
18566 \begin_layout Plain Layout
18572 will automatically set
18573 \begin_inset Flex Code
18576 \begin_layout Plain Layout
18583 \begin_inset Flex Code
18586 \begin_layout Plain Layout
18594 \begin_inset Flex Code
18597 \begin_layout Plain Layout
18603 can be set to true, or
18604 \begin_inset Flex Code
18607 \begin_layout Plain Layout
18614 \begin_inset Flex Code
18617 \begin_layout Plain Layout
18623 insets by setting it
18628 \begin_inset Flex Code
18631 \begin_layout Plain Layout
18640 \begin_layout Description
18641 \begin_inset Flex Code
18644 \begin_layout Plain Layout
18651 \begin_inset Flex Code
18654 \begin_layout Plain Layout
18663 \begin_inset space \thinspace{}
18667 \begin_inset Flex Code
18670 \begin_layout Plain Layout
18676 ] Whether multiple paragraphs are permitted in this inset.
18678 \begin_inset Flex Code
18681 \begin_layout Plain Layout
18687 to the same value and
18688 \begin_inset Flex Code
18691 \begin_layout Plain Layout
18697 to the opposite value.
18698 These can be reset to other values, if they are used
18703 \begin_inset Flex Code
18706 \begin_layout Plain Layout
18716 \begin_layout Description
18717 \begin_inset Flex Code
18720 \begin_layout Plain Layout
18727 \begin_inset Flex Code
18730 \begin_layout Plain Layout
18739 \begin_inset space \thinspace{}
18743 \begin_inset Flex Code
18746 \begin_layout Plain Layout
18752 ] Whether fragile commands in this inset should be
18753 \begin_inset Flex Code
18756 \begin_layout Plain Layout
18769 whether the command should itself be protected.) Default is false.
18772 \begin_layout Description
18773 \begin_inset Flex Code
18776 \begin_layout Plain Layout
18783 \begin_inset Flex Code
18786 \begin_layout Plain Layout
18792 ] Deletes an existing
18793 \begin_inset Flex Code
18796 \begin_layout Plain Layout
18805 \begin_layout Description
18806 \begin_inset Flex Code
18809 \begin_layout Plain Layout
18816 \begin_inset Flex Code
18819 \begin_layout Plain Layout
18826 \begin_inset Flex Code
18829 \begin_layout Plain Layout
18835 that has replaced this
18836 \begin_inset Flex Code
18839 \begin_layout Plain Layout
18846 This is used to rename an
18847 \begin_inset Flex Code
18850 \begin_layout Plain Layout
18856 , while keeping backward compatibility.
18859 \begin_layout Description
18860 \begin_inset Flex Code
18863 \begin_layout Plain Layout
18870 \begin_inset Flex Code
18873 \begin_layout Plain Layout
18882 \begin_inset space \thinspace{}
18886 \begin_inset Flex Code
18889 \begin_layout Plain Layout
18895 ] As with paragraph styles, see
18896 \begin_inset CommandInset ref
18898 reference "subsec:Paragraph-Styles"
18906 \begin_layout Description
18907 \begin_inset Flex Code
18910 \begin_layout Plain Layout
18917 \begin_inset Flex Code
18920 \begin_layout Plain Layout
18929 \begin_inset space \thinspace{}
18933 \begin_inset Flex Code
18936 \begin_layout Plain Layout
18942 ] As with paragraph styles, see
18943 \begin_inset CommandInset ref
18945 reference "subsec:Paragraph-Styles"
18953 \begin_layout Description
18954 \begin_inset Flex Code
18957 \begin_layout Plain Layout
18963 As with paragraph styles, see
18964 \begin_inset CommandInset ref
18966 reference "subsec:Paragraph-Styles"
18973 \begin_layout Description
18974 \begin_inset Flex Code
18977 \begin_layout Plain Layout
18984 \begin_inset Flex Code
18987 \begin_layout Plain Layout
18993 ] The prefix to use when creating labels referring to insets of this type.
18994 This allows the use of formatted references.
18997 \begin_layout Description
18998 \begin_inset Flex Code
19001 \begin_layout Plain Layout
19008 \begin_inset Flex Code
19011 \begin_layout Plain Layout
19017 ] As with paragraph styles, see
19018 \begin_inset CommandInset ref
19020 reference "subsec:Paragraph-Styles"
19027 \begin_layout Description
19028 \begin_inset Flex Code
19031 \begin_layout Plain Layout
19038 \begin_inset Flex Code
19041 \begin_layout Plain Layout
19050 \begin_inset space \thinspace{}
19054 \begin_inset Flex Code
19057 \begin_layout Plain Layout
19063 ] Resets the \SpecialChar LaTeX
19064 arguments of this layout (as defined via the
19065 \begin_inset Flex Code
19068 \begin_layout Plain Layout
19075 This is useful if you have copied a style via
19076 \begin_inset Flex Code
19079 \begin_layout Plain Layout
19085 , but you do not want to inherit its (required and optional) arguments.
19088 \begin_layout Description
19089 \begin_inset Flex Code
19092 \begin_layout Plain Layout
19099 \begin_inset Flex Code
19102 \begin_layout Plain Layout
19109 \begin_inset space \thinspace{}
19113 \begin_inset Flex Code
19116 \begin_layout Plain Layout
19124 ] Whether this inset should use the font of its surrounding environment
19126 Default is false: use the font of the surrounding environment.
19129 \begin_layout Description
19130 \begin_inset Flex Code
19133 \begin_layout Plain Layout
19140 \begin_inset Flex Code
19143 \begin_layout Plain Layout
19149 ] A string that is put at the end of the layout content.
19150 A line break in the output can be indicated by
19151 \begin_inset Flex Code
19154 \begin_layout Plain Layout
19163 \begin_layout Description
19164 \begin_inset Flex Code
19167 \begin_layout Plain Layout
19174 \begin_inset Flex Code
19177 \begin_layout Plain Layout
19184 \begin_inset space \thinspace{}
19188 \begin_inset Flex Code
19191 \begin_layout Plain Layout
19199 ] Allow spell-checking the contents of this inset.
19203 \begin_layout Subsection
19205 \begin_inset CommandInset label
19207 name "subsec:Counters"
19214 \begin_layout Standard
19215 It is necessary to define the counters (
19216 \begin_inset Flex Noun
19219 \begin_layout Plain Layout
19226 \begin_inset Flex Noun
19229 \begin_layout Plain Layout
19235 , \SpecialChar ldots
19236 ) in the text class itself.
19237 The standard counters are defined in the file
19238 \begin_inset Flex Code
19241 \begin_layout Plain Layout
19247 , so you may have to do no more than add
19250 \begin_layout LyX-Code
19251 Input stdcounters.inc
19254 \begin_layout Standard
19255 to your layout file to get them to work.
19256 But if you want to define custom counters, then you can do so.
19257 The counter declaration must begin with:
19260 \begin_layout LyX-Code
19261 Counter CounterName
19264 \begin_layout Standard
19266 \begin_inset Flex Code
19269 \begin_layout Plain Layout
19275 ' is replaced by the name of the counter.
19276 And it must end with
19277 \begin_inset Quotes eld
19281 \begin_inset Flex Code
19284 \begin_layout Plain Layout
19291 \begin_inset Quotes erd
19295 The following parameters can also be used:
19298 \begin_layout Description
19299 \begin_inset Flex Code
19302 \begin_layout Plain Layout
19309 \begin_inset Flex Code
19312 \begin_layout Plain Layout
19318 ] Sets the initial value for the counter, to which it will be reset whenever
19320 Normally, one will want the default, 1.
19323 \begin_layout Description
19324 \begin_inset Flex Code
19327 \begin_layout Plain Layout
19334 \begin_inset Flex Code
19337 \begin_layout Plain Layout
19344 \begin_inset Quotes erd
19348 \begin_inset Quotes erd
19351 ] When defined, this string defines how the counter is displayed.
19352 Setting this value sets
19353 \begin_inset Flex Code
19356 \begin_layout Plain Layout
19357 LabelStringAppendix
19363 The following special constructs can be used in the string:
19367 \begin_layout Itemize
19368 \begin_inset Flex Code
19371 \begin_layout Plain Layout
19379 will be replaced by the expansion of the
19380 \begin_inset Flex Code
19383 \begin_layout Plain Layout
19390 \begin_inset Flex Code
19393 \begin_layout Plain Layout
19394 LabelStringAppendix
19400 \begin_inset Flex Code
19403 \begin_layout Plain Layout
19413 \begin_layout Itemize
19414 counter values can be expressed using \SpecialChar LaTeX
19416 \begin_inset Newline newline
19420 \begin_inset Flex Code
19423 \begin_layout Plain Layout
19440 \begin_inset Flex Code
19443 \begin_layout Plain Layout
19455 \begin_layout Plain Layout
19465 Actually, the situation is a bit more complicated: any
19484 other than those described below will produce arabic numerals.
19485 It would not be surprising to see this change in the future.
19491 \begin_inset Flex Code
19494 \begin_layout Plain Layout
19500 : 1, 2, 3,\SpecialChar ldots
19502 \begin_inset Flex Code
19505 \begin_layout Plain Layout
19511 for lower-case letters: a, b, c, \SpecialChar ldots
19513 \begin_inset Flex Code
19516 \begin_layout Plain Layout
19522 for upper-case letters: A, B, C, \SpecialChar ldots
19524 \begin_inset Flex Code
19527 \begin_layout Plain Layout
19533 for lower-case roman numerals: i, ii, iii, \SpecialChar ldots
19535 \begin_inset Flex Code
19538 \begin_layout Plain Layout
19544 for upper-case roman numerals: I, II, III\SpecialChar ldots
19546 \begin_inset Flex Code
19549 \begin_layout Plain Layout
19555 for hebrew numerals.
19559 \begin_layout Standard
19560 If LabelString is not defined, a default value is constructed as follows:
19561 if the counter has a master counter
19562 \begin_inset Flex Code
19565 \begin_layout Plain Layout
19572 \begin_inset Flex Code
19575 \begin_layout Plain Layout
19582 \begin_inset Newline newline
19586 \begin_inset Flex Code
19589 \begin_layout Plain Layout
19599 is used; otherwise the string
19600 \begin_inset Flex Code
19603 \begin_layout Plain Layout
19614 \begin_layout Description
19615 \begin_inset Flex Code
19618 \begin_layout Plain Layout
19619 LabelStringAppendix
19625 \begin_inset Flex Code
19628 \begin_layout Plain Layout
19635 \begin_inset Quotes erd
19639 \begin_inset Quotes erd
19643 \begin_inset Flex Code
19646 \begin_layout Plain Layout
19652 , but for use in the Appendix.
19655 \begin_layout Description
19656 \begin_inset Flex Code
19659 \begin_layout Plain Layout
19666 \begin_inset Flex Code
19669 \begin_layout Plain Layout
19676 \begin_inset Quotes erd
19680 \begin_inset Quotes erd
19683 ] A format for use with formatted references to this counter.
19684 For example, one might want to have references to section numbers appear
19686 \begin_inset Quotes eld
19690 \begin_inset Quotes erd
19694 The string should contain
19695 \begin_inset Quotes eld
19699 \begin_inset Quotes erd
19703 This will be replaced by the counter number itself.
19704 So, for sections, it would be: Section ##.
19707 \begin_layout Description
19708 \begin_inset Flex Code
19711 \begin_layout Plain Layout
19718 \begin_inset Flex Code
19721 \begin_layout Plain Layout
19728 \begin_inset Quotes erd
19732 \begin_inset Quotes erd
19735 ] If this is set to the name of another counter, the present counter will
19736 be reset every time the other one is increased.
19738 \begin_inset Flex Code
19741 \begin_layout Plain Layout
19748 \begin_inset Flex Code
19751 \begin_layout Plain Layout
19760 \begin_layout Subsection
19762 \begin_inset CommandInset label
19764 name "subsec:Font-description"
19771 \begin_layout Standard
19772 A font description looks like this:
19775 \begin_layout LyX-Code
19789 \begin_layout LyX-Code
19793 \begin_layout LyX-Code
19797 \begin_layout Standard
19798 The following commands are available:
19801 \begin_layout Description
19802 \begin_inset Flex Code
19805 \begin_layout Plain Layout
19812 \begin_inset Flex Code
19815 \begin_layout Plain Layout
19824 \begin_inset Flex Code
19827 \begin_layout Plain Layout
19834 \begin_inset Flex Code
19837 \begin_layout Plain Layout
19844 \begin_inset Flex Code
19847 \begin_layout Plain Layout
19854 \begin_inset Flex Code
19857 \begin_layout Plain Layout
19864 \begin_inset Flex Code
19867 \begin_layout Plain Layout
19874 \begin_inset Flex Code
19877 \begin_layout Plain Layout
19884 \begin_inset Flex Code
19887 \begin_layout Plain Layout
19894 \begin_inset Flex Code
19897 \begin_layout Plain Layout
19904 \begin_inset Flex Code
19907 \begin_layout Plain Layout
19914 \begin_inset Flex Code
19917 \begin_layout Plain Layout
19924 \begin_inset Flex Code
19927 \begin_layout Plain Layout
19934 \begin_inset Flex Code
19937 \begin_layout Plain Layout
19944 \begin_inset Flex Code
19947 \begin_layout Plain Layout
19954 \begin_inset Flex Code
19957 \begin_layout Plain Layout
19964 \begin_inset Flex Code
19967 \begin_layout Plain Layout
19974 \begin_inset Flex Code
19977 \begin_layout Plain Layout
19984 \begin_inset Flex Code
19987 \begin_layout Plain Layout
19994 \begin_inset Flex Code
19997 \begin_layout Plain Layout
20004 \begin_inset Flex Code
20007 \begin_layout Plain Layout
20016 \begin_layout Description
20017 \begin_inset Flex Code
20020 \begin_layout Plain Layout
20027 \begin_inset Flex Code
20030 \begin_layout Plain Layout
20039 \begin_inset Flex Code
20042 \begin_layout Plain Layout
20049 \begin_inset Flex Code
20052 \begin_layout Plain Layout
20061 \begin_layout Description
20062 \begin_inset Flex Code
20065 \begin_layout Plain Layout
20072 \begin_inset Flex Code
20075 \begin_layout Plain Layout
20081 ] Valid arguments are:
20082 \begin_inset Flex Code
20085 \begin_layout Plain Layout
20092 \begin_inset Flex Code
20095 \begin_layout Plain Layout
20102 \begin_inset Flex Code
20105 \begin_layout Plain Layout
20112 \begin_inset Flex Code
20115 \begin_layout Plain Layout
20122 \begin_inset Flex Code
20125 \begin_layout Plain Layout
20132 \begin_inset Flex Code
20135 \begin_layout Plain Layout
20142 \begin_inset Flex Code
20145 \begin_layout Plain Layout
20152 \begin_inset Flex Code
20155 \begin_layout Plain Layout
20162 \begin_inset Flex Code
20165 \begin_layout Plain Layout
20172 \begin_inset Flex Code
20175 \begin_layout Plain Layout
20182 \begin_inset Flex Code
20185 \begin_layout Plain Layout
20192 \begin_inset Flex Code
20195 \begin_layout Plain Layout
20202 Each of these turns on or off the corresponding attribute.
20204 \begin_inset Flex Code
20207 \begin_layout Plain Layout
20213 turns on emphasis, and
20214 \begin_inset Flex Code
20217 \begin_layout Plain Layout
20225 \begin_inset Newline newline
20228 If the latter seems puzzling, remember that the font settings for the present
20229 context are generally inherited from the surrounding context.
20231 \begin_inset Flex Code
20234 \begin_layout Plain Layout
20240 would turn off the emphasis that was anyway in effect, say, in a theorem
20244 \begin_layout Description
20245 \begin_inset Flex Code
20248 \begin_layout Plain Layout
20255 \begin_inset Flex Code
20258 \begin_layout Plain Layout
20267 \begin_inset Flex Code
20270 \begin_layout Plain Layout
20279 \begin_layout Description
20280 \begin_inset Flex Code
20283 \begin_layout Plain Layout
20290 \begin_inset Flex Code
20293 \begin_layout Plain Layout
20302 \begin_inset Flex Code
20305 \begin_layout Plain Layout
20312 \begin_inset Flex Code
20315 \begin_layout Plain Layout
20322 \begin_inset Flex Code
20325 \begin_layout Plain Layout
20334 \begin_layout Description
20335 \begin_inset Flex Code
20338 \begin_layout Plain Layout
20345 \begin_inset Flex Code
20348 \begin_layout Plain Layout
20355 \begin_inset Flex Code
20358 \begin_layout Plain Layout
20365 \begin_inset Flex Code
20368 \begin_layout Plain Layout
20377 \begin_inset Flex Code
20380 \begin_layout Plain Layout
20387 \begin_inset Flex Code
20390 \begin_layout Plain Layout
20397 \begin_inset Flex Code
20400 \begin_layout Plain Layout
20407 \begin_inset Flex Code
20410 \begin_layout Plain Layout
20417 \begin_inset Flex Code
20420 \begin_layout Plain Layout
20429 \begin_layout Subsection
20430 \begin_inset CommandInset label
20432 name "subsec:Citation-format-description"
20436 Citation format description
20439 \begin_layout Standard
20441 \begin_inset Flex Code
20444 \begin_layout Plain Layout
20450 blocks are used to describe how bibliographic information should be displayed,
20451 both within \SpecialChar LyX
20452 itself (in the citation dialog and in tooltips, for example)
20453 and in XHTML output.
20454 Such a block might look like this:
20457 \begin_layout LyX-Code
20461 \begin_layout LyX-Code
20465 \begin_layout LyX-Code
20469 \begin_layout LyX-Code
20473 \begin_layout Standard
20474 The individual lines define how the bibliographic information associated
20475 with an article or book, respectively, is to be displayed, and such a definitio
20476 n can be given for any `entry type' that might be present in a Bib\SpecialChar TeX
20479 defines a default format in the source code that will be used if no specific
20480 definition has been given.
20482 predefines several formats in the file
20483 \begin_inset Flex Code
20486 \begin_layout Plain Layout
20492 , which is included in most of \SpecialChar LyX
20493 's document classes.
20496 \begin_layout Standard
20497 The definitions use a simple language that allows Bib\SpecialChar TeX
20498 keys to be replaced
20500 Keys should be enclosed in
20501 \begin_inset Flex Code
20504 \begin_layout Plain Layout
20511 \begin_inset Flex Code
20514 \begin_layout Plain Layout
20521 So a simple definition might look like this:
20524 \begin_layout LyX-Code
20526 \begin_inset Quotes eld
20530 \begin_inset Quotes erd
20536 \begin_layout Standard
20537 This would print the author, followed by a comma, followed by the title,
20538 in quotes, followed by a period.
20541 \begin_layout Standard
20542 Of course, sometimes you may want to print a key only if it exists.
20543 This can be done by using a conditional construction, such as:
20544 \begin_inset Flex Code
20547 \begin_layout Plain Layout
20549 \begin_inset space ~
20559 \begin_inset Flex Code
20562 \begin_layout Plain Layout
20568 key exists, then print
20569 \begin_inset Quotes eld
20573 \begin_inset space ~
20577 \begin_inset Quotes erd
20580 followed by the volume key.
20581 It is also possible to have an else clause in the conditional, such as:
20582 \begin_inset Newline newline
20586 \begin_inset Flex Code
20589 \begin_layout Plain Layout
20590 {%author%[[%author%]][[%editor%, ed.]]}
20596 \begin_inset Newline newline
20600 \begin_inset Flex Code
20603 \begin_layout Plain Layout
20609 key is printed if it exists; otherwise, the editor key is printed, followed
20611 \begin_inset Quotes eld
20615 \begin_inset space ~
20619 \begin_inset Quotes erd
20622 Note that the key is again enclosed in
20623 \begin_inset Flex Code
20626 \begin_layout Plain Layout
20632 signs; the entire conditional is enclosed in braces; and the if and else
20633 clauses are enclosed in double brackets,
20634 \begin_inset Quotes eld
20638 \begin_inset Flex Code
20641 \begin_layout Plain Layout
20648 \begin_inset Quotes eld
20652 \begin_inset Quotes eld
20656 \begin_inset Flex Code
20659 \begin_layout Plain Layout
20666 \begin_inset Quotes erd
20670 There must be no space between any of these.
20673 \begin_layout Standard
20674 There is one other piece of syntax available in definitions, which looks
20676 \begin_inset Flex Code
20679 \begin_layout Plain Layout
20686 This defines a piece of formatting information that is to be used when
20688 \begin_inset Quotes eld
20692 \begin_inset Quotes erd
20696 Obviously, we do not want to output HTML tags when writing plain text,
20697 so they should be wrapped in
20698 \begin_inset Quotes eld
20702 \begin_inset Quotes erd
20706 \begin_inset Quotes eld
20710 \begin_inset Quotes erd
20716 \begin_layout Standard
20717 Two special sorts of definitions are also possible in a
20718 \begin_inset Flex Code
20721 \begin_layout Plain Layout
20728 An example of the first would be:
20731 \begin_layout LyX-Code
20733 \begin_inset Quotes eld
20737 \begin_inset Quotes erd
20743 \begin_layout Standard
20744 This is an abbreviation, or macro, and it can be used by treating it as
20746 \begin_inset Flex Code
20749 \begin_layout Plain Layout
20758 \begin_inset Flex Code
20761 \begin_layout Plain Layout
20767 exactly as it would treat its definition.
20768 So, let us issue the obvious
20776 \begin_layout LyX-Code
20780 \begin_layout Standard
20781 or anything like it.
20783 shouldn't go into an infinite loop, but it may go into a long one before
20787 \begin_layout Standard
20788 The second sort of special definition might look like this:
20791 \begin_layout LyX-Code
20795 \begin_layout Standard
20796 This defines a translatable piece of text, which allows relevant parts of
20797 the bibliography to be translated.
20798 It can be included in a definition by treating it as a key:
20799 \begin_inset Flex Code
20802 \begin_layout Plain Layout
20809 Several of these are predefined in
20810 \begin_inset Flex Code
20813 \begin_layout Plain Layout
20820 Note that these are not macros, in the sense just defined.
20821 They will not be expanded.
20824 \begin_layout Standard
20825 So here then is an example that use all these features:
20826 \begin_inset VSpace defskip
20832 \begin_layout Standard
20836 !authoredit {%author%[[%author%, ]][[{%editor%[[%editor%, %_edtext%, ]]}]]}
20839 \begin_layout Standard
20840 \begin_inset VSpace defskip
20843 This defines a macro that prints the author, followed by a comma, if the
20845 \begin_inset Flex Code
20848 \begin_layout Plain Layout
20854 key is defined, or else prints the name of the editor, followed by the
20856 \begin_inset Flex Code
20859 \begin_layout Plain Layout
20865 or its translation (it is by default
20866 \begin_inset Quotes eld
20870 \begin_inset Quotes erd
20874 \begin_inset Flex Code
20877 \begin_layout Plain Layout
20884 Note that this is in fact defined in
20885 \begin_inset Flex Code
20888 \begin_layout Plain Layout
20894 , so you can use it in your own definitions, or re-definitions, if you load
20898 \begin_layout Section
20899 \begin_inset CommandInset label
20901 name "sec:Tags-for-XHTML"
20905 Tags for XHTML output
20908 \begin_layout Standard
20909 As with \SpecialChar LaTeX
20910 or DocBook, the format of \SpecialChar LyX
20911 's XHTML output is also controlled by
20912 layout information.
20913 In general, \SpecialChar LyX
20914 provides sensible defaults and, as mentioned earlier, it will
20915 even construct default CSS style rules from the other layout tags.
20916 For example, \SpecialChar LyX
20917 will attempt to use the information provided in the
20918 \begin_inset Flex Code
20921 \begin_layout Plain Layout
20927 declaration for the Chapter style to write CSS that will appropriately
20928 format chapter headings.
20931 \begin_layout Standard
20932 In many cases, then, you may not have to do anything at all to get acceptable
20933 XHTML output for your own environments, custom insets, and so forth.
20934 But in some cases you will, and so \SpecialChar LyX
20935 provides a number of layout tags that
20936 can be used to customize the XHTML and CSS that are generated.
20939 \begin_layout Standard
20940 Note that there are two tags,
20941 \begin_inset Flex Code
20944 \begin_layout Plain Layout
20951 \begin_inset Flex Code
20954 \begin_layout Plain Layout
20960 that may appear outside style and inset declarations.
20962 \begin_inset CommandInset ref
20964 reference "subsec:General-text-class"
20968 for details on these.
20971 \begin_layout Subsection
20972 \begin_inset CommandInset label
20974 name "subsec:Paragraph-Style-XHTML"
20981 \begin_layout Standard
20982 The sort of XHTML \SpecialChar LyX
20983 outputs for a paragraph depends upon whether we are dealing
20984 with a normal paragraph, a command, or an environment, where this is itself
20985 determined by the contents of the corresponding
20986 \begin_inset Flex Code
20989 \begin_layout Plain Layout
21000 \begin_layout Standard
21001 For a command or normal paragraph, the output XHTML has the following form:
21004 \begin_layout LyX-Code
21006 \begin_inset Quotes erd
21010 \begin_inset Quotes erd
21016 \begin_layout LyX-Code
21018 \begin_inset Quotes erd
21022 \begin_inset Quotes erd
21028 \begin_layout LyX-Code
21029 Contents of the paragraph.
21032 \begin_layout LyX-Code
21036 \begin_layout Standard
21037 The label tags are of course omitted if the paragraph does not have a label.
21040 \begin_layout Standard
21041 For an environment that is not some sort of list, the XHTML takes this form:
21044 \begin_layout LyX-Code
21046 \begin_inset Quotes erd
21050 \begin_inset Quotes erd
21056 \begin_layout LyX-Code
21058 \begin_inset Quotes erd
21062 \begin_inset Quotes erd
21066 \begin_inset Quotes erd
21070 \begin_inset Quotes erd
21073 >Environment Label</labeltag>First paragraph.</itemtag>
21076 \begin_layout LyX-Code
21077 <itemtag>Second paragraph.</itemtag>
21080 \begin_layout LyX-Code
21084 \begin_layout Standard
21085 Note that the label is output only for the first paragraph, as it should
21086 be for a theorem, for example.
21090 \begin_layout Standard
21091 For a list, we have one of these forms:
21094 \begin_layout LyX-Code
21096 \begin_inset Quotes erd
21100 \begin_inset Quotes erd
21106 \begin_layout LyX-Code
21108 \begin_inset Quotes erd
21112 \begin_inset Quotes erd
21116 \begin_inset Quotes erd
21120 \begin_inset Quotes erd
21123 >List Label</labeltag>First item.</itemtag>
21126 \begin_layout LyX-Code
21128 \begin_inset Quotes erd
21132 \begin_inset Quotes erd
21136 \begin_inset Quotes erd
21140 \begin_inset Quotes erd
21143 >List Label</labeltag>Second item.</itemtag>
21146 \begin_layout LyX-Code
21150 \begin_layout LyX-Code
21154 \begin_layout LyX-Code
21156 \begin_inset Quotes erd
21160 \begin_inset Quotes erd
21166 \begin_layout LyX-Code
21168 \begin_inset Quotes erd
21172 \begin_inset Quotes erd
21175 >List Label</labeltag><itemtag attr=
21176 \begin_inset Quotes erd
21180 \begin_inset Quotes erd
21183 >First item.</itemtag>
21186 \begin_layout LyX-Code
21188 \begin_inset Quotes erd
21192 \begin_inset Quotes erd
21195 >List Label</labeltag><itemtag attr=
21196 \begin_inset Quotes erd
21200 \begin_inset Quotes erd
21203 >Second item.</itemtag>
21206 \begin_layout LyX-Code
21210 \begin_layout Standard
21211 Note the different orders of
21212 \begin_inset Flex Code
21215 \begin_layout Plain Layout
21222 \begin_inset Flex Code
21225 \begin_layout Plain Layout
21232 Which order we get depends upon the setting of
21233 \begin_inset Flex Code
21236 \begin_layout Plain Layout
21243 \begin_inset Flex Code
21246 \begin_layout Plain Layout
21252 is false (the default), you get the first of these, with the label within
21253 the item; if true, you get the second, with the label outside the item.
21256 \begin_layout Standard
21257 The specific tags and attributes output for each paragraph type can be controlle
21258 d by means of the layout tags we are about to describe.
21259 As mentioned earlier, however, \SpecialChar LyX
21260 uses sensible defaults for many of these,
21261 so you often may not need to do very much to get good XHTML output.
21262 Think of the available tags as there so you can tweak things to your liking.
21265 \begin_layout Description
21266 \begin_inset Flex Code
21269 \begin_layout Plain Layout
21276 \begin_inset Flex Code
21279 \begin_layout Plain Layout
21285 ] Specifies attribute information to be output with the main tag.
21287 \begin_inset Quotes eld
21291 \begin_inset Flex Code
21294 \begin_layout Plain Layout
21301 \begin_inset Quotes erd
21305 By default, \SpecialChar LyX
21307 \begin_inset Quotes eld
21311 \begin_inset Flex Code
21314 \begin_layout Plain Layout
21321 \begin_inset Quotes erd
21325 \begin_inset Flex Code
21328 \begin_layout Plain Layout
21334 is the \SpecialChar LyX
21335 name of the layout, made lowercase, for example: chapter.
21340 contain any style information.
21342 \begin_inset Flex Code
21345 \begin_layout Plain Layout
21354 \begin_layout Description
21355 \begin_inset Flex Code
21358 \begin_layout Plain Layout
21365 \begin_inset Flex Code
21368 \begin_layout Plain Layout
21378 ] Whether to output the default CSS information \SpecialChar LyX
21379 generates for this layout,
21380 even if additional information is explicitly provided via
21381 \begin_inset Flex Code
21384 \begin_layout Plain Layout
21392 \begin_inset Flex Code
21395 \begin_layout Plain Layout
21401 allows you to alter or augment the generated CSS, rather than to override
21404 \begin_inset Flex Code
21407 \begin_layout Plain Layout
21416 \begin_layout Description
21417 \begin_inset Flex Code
21420 \begin_layout Plain Layout
21427 \begin_inset Flex Code
21430 \begin_layout Plain Layout
21436 ] The tag to be used for individual paragraphs of environments, replacing
21438 \begin_inset Flex Code
21441 \begin_layout Plain Layout
21447 in the examples above.
21449 \begin_inset Flex Code
21452 \begin_layout Plain Layout
21461 \begin_layout Description
21462 \begin_inset Flex Code
21465 \begin_layout Plain Layout
21472 \begin_inset Flex Code
21475 \begin_layout Plain Layout
21481 ] Attributes for the item tag.
21483 \begin_inset Quotes eld
21487 \begin_inset Flex Code
21490 \begin_layout Plain Layout
21491 class=`layoutname_item'
21497 \begin_inset Quotes erd
21505 contain any style information.
21507 \begin_inset Flex Code
21510 \begin_layout Plain Layout
21519 \begin_layout Description
21520 \begin_inset Flex Code
21523 \begin_layout Plain Layout
21530 \begin_inset Flex Code
21533 \begin_layout Plain Layout
21539 ] The tag to be used for paragraph and item labels, replacing
21540 \begin_inset Flex Code
21543 \begin_layout Plain Layout
21549 in the examples above.
21551 \begin_inset Flex Code
21554 \begin_layout Plain Layout
21561 \begin_inset Flex Code
21564 \begin_layout Plain Layout
21571 \begin_inset Flex Code
21574 \begin_layout Plain Layout
21581 \begin_inset Flex Code
21584 \begin_layout Plain Layout
21585 Centered_Top_Environment
21590 , in which case it defaults to
21591 \begin_inset Flex Code
21594 \begin_layout Plain Layout
21603 \begin_layout Description
21604 \begin_inset Flex Code
21607 \begin_layout Plain Layout
21614 \begin_inset Flex Code
21617 \begin_layout Plain Layout
21623 ] Attributes for the label tag.
21625 \begin_inset Quotes eld
21629 \begin_inset Flex Code
21632 \begin_layout Plain Layout
21633 class=`layoutname_label'
21639 \begin_inset Quotes erd
21647 contain any style information.
21649 \begin_inset Flex Code
21652 \begin_layout Plain Layout
21661 \begin_layout Description
21662 \begin_inset Flex Code
21665 \begin_layout Plain Layout
21672 \begin_inset Flex Code
21675 \begin_layout Plain Layout
21685 ] Meaningful only for list-like environments, this tag controls whether
21686 the label tag is output before or inside the item tag.
21687 This is used, for example, in the description environment, where we want
21689 \begin_inset Flex Code
21692 \begin_layout Plain Layout
21693 <dt>\SpecialChar ldots
21694 </dt><dd>\SpecialChar ldots
21702 \begin_inset Flex Code
21705 \begin_layout Plain Layout
21711 : The label tag is output inside the item tag.
21714 \begin_layout Description
21715 \begin_inset Flex Code
21718 \begin_layout Plain Layout
21724 Information to be output in the
21725 \begin_inset Flex Code
21728 \begin_layout Plain Layout
21734 section when this style is used.
21735 This might, for example, be used to include a
21736 \begin_inset Flex Code
21739 \begin_layout Plain Layout
21746 \begin_inset Flex Code
21749 \begin_layout Plain Layout
21758 \begin_layout Description
21759 \begin_inset Flex Code
21762 \begin_layout Plain Layout
21768 CSS style information to be included when this style is used.
21769 Note that this will automatically be wrapped in a layout-generated
21770 \begin_inset Flex Code
21773 \begin_layout Plain Layout
21779 block, so only the CSS itself need be included.
21781 \begin_inset Flex Code
21784 \begin_layout Plain Layout
21793 \begin_layout Description
21794 \begin_inset Flex Code
21797 \begin_layout Plain Layout
21804 \begin_inset Flex Code
21807 \begin_layout Plain Layout
21813 ] The tag to be used for the main label, replacing
21814 \begin_inset Flex Code
21817 \begin_layout Plain Layout
21823 in the examples above.
21825 \begin_inset Flex Code
21828 \begin_layout Plain Layout
21837 \begin_layout Description
21838 \begin_inset Flex Code
21841 \begin_layout Plain Layout
21848 \begin_inset Flex Code
21851 \begin_layout Plain Layout
21861 ] Marks this style as the one to be used to generate the
21862 \begin_inset Flex Code
21865 \begin_layout Plain Layout
21871 tag for the XHTML file.
21872 By default, it is false.
21874 \begin_inset Flex Code
21877 \begin_layout Plain Layout
21883 file sets it to true for the
21884 \begin_inset Flex Code
21887 \begin_layout Plain Layout
21897 \begin_layout Subsection
21901 \begin_layout Standard
21902 The XHTML output of insets can also be controlled by information in layout
21907 \begin_layout Plain Layout
21908 At present, this is true only for
21909 \begin_inset Quotes eld
21913 \begin_inset Quotes erd
21916 insets (insets you can type into) and is not true for
21917 \begin_inset Quotes eld
21921 \begin_inset Quotes erd
21924 insets (insets that are associated with dialog boxes).
21929 Here, too, \SpecialChar LyX
21930 tries to provide sensible defaults, and it constructs default
21932 But everything can be customized.
21935 \begin_layout Standard
21936 The XHTML \SpecialChar LyX
21937 outputs for an inset has the following form:
21940 \begin_layout LyX-Code
21942 \begin_inset Quotes erd
21946 \begin_inset Quotes erd
21952 \begin_layout LyX-Code
21953 <labeltag>Label</labeltag>
21956 \begin_layout LyX-Code
21958 \begin_inset Quotes erd
21962 \begin_inset Quotes erd
21965 >Contents of the inset.</innertag>
21968 \begin_layout LyX-Code
21972 \begin_layout Standard
21973 If the inset permits multiple paragraphs—that is, if
21974 \begin_inset Flex Code
21977 \begin_layout Plain Layout
21983 is true—then the contents of the inset will itself be output as paragraphs
21984 formatted according to the styles used for those paragraphs (standard,
21985 quote, and the like).
21986 The label tag is of course omitted if the paragraph does not have a label
21987 and, at present, is always
21988 \begin_inset Flex Code
21991 \begin_layout Plain Layout
21998 The inner tag is optional and, by default, does not appear.
22001 \begin_layout Standard
22002 The specific tags and attributes output for each inset can be controlled
22003 by means of the following layout tags.
22006 \begin_layout Description
22007 \begin_inset Flex Code
22010 \begin_layout Plain Layout
22017 \begin_inset Flex Code
22020 \begin_layout Plain Layout
22026 ] Specifies attribute information to be output with the main tag.
22028 \begin_inset Quotes eld
22032 \begin_inset Flex Code
22035 \begin_layout Plain Layout
22036 class=`myinset' onclick=`\SpecialChar ldots
22043 \begin_inset Quotes erd
22047 By default, \SpecialChar LyX
22049 \begin_inset Quotes eld
22053 \begin_inset Flex Code
22056 \begin_layout Plain Layout
22063 \begin_inset Quotes erd
22067 \begin_inset Flex Code
22070 \begin_layout Plain Layout
22076 is the \SpecialChar LyX
22077 name of the inset, made lowercase and with non-alphanumeric characters
22078 converted to underscores, for example: footnote.
22081 \begin_layout Description
22082 \begin_inset Flex Code
22085 \begin_layout Plain Layout
22092 \begin_inset Flex Code
22095 \begin_layout Plain Layout
22105 ] Whether to output the default CSS information \SpecialChar LyX
22106 generates for this layout,
22107 even if additional information is explicitly provided via
22108 \begin_inset Flex Code
22111 \begin_layout Plain Layout
22119 \begin_inset Flex Code
22122 \begin_layout Plain Layout
22128 allows you to alter or augment the generated CSS, rather than to override
22133 \begin_layout Description
22134 \begin_inset Flex Code
22137 \begin_layout Plain Layout
22144 \begin_inset Flex Code
22147 \begin_layout Plain Layout
22153 ] Attributes for the inner tag.
22155 \begin_inset Quotes eld
22159 \begin_inset Flex Code
22162 \begin_layout Plain Layout
22163 class=`insetname_inner'
22169 \begin_inset Quotes erd
22175 \begin_layout Description
22176 \begin_inset Flex Code
22179 \begin_layout Plain Layout
22186 \begin_inset Flex Code
22189 \begin_layout Plain Layout
22195 ] The inner tag, replacing
22196 \begin_inset Flex Code
22199 \begin_layout Plain Layout
22205 in the examples above.
22206 By default, there is none.
22209 \begin_layout Description
22210 \begin_inset Flex Code
22213 \begin_layout Plain Layout
22220 \begin_inset Flex Code
22223 \begin_layout Plain Layout
22231 ] Whether this inset represents a standalone block of text (such as a footnote)
22232 or instead represents material that is included in the surrounding text
22233 (such as a branch).
22237 \begin_layout Description
22238 \begin_inset Flex Code
22241 \begin_layout Plain Layout
22248 \begin_inset Flex Code
22251 \begin_layout Plain Layout
22257 ] A label for this inset, possibly including a reference to a counter.
22258 For example, for footnote, it might be:
22259 \begin_inset Flex Code
22262 \begin_layout Plain Layout
22271 This is optional, and there is no default.
22274 \begin_layout Description
22275 \begin_inset Flex Code
22278 \begin_layout Plain Layout
22284 Information to be output in the
22285 \begin_inset Flex Code
22288 \begin_layout Plain Layout
22294 section when this style is used.
22295 This might, for example, be used to include a
22296 \begin_inset Flex Code
22299 \begin_layout Plain Layout
22306 \begin_inset Flex Code
22309 \begin_layout Plain Layout
22318 \begin_layout Description
22319 \begin_inset Flex Code
22322 \begin_layout Plain Layout
22328 CSS style information to be included when this style is used.
22329 Note that this will automatically be wrapped in a layout-generated
22330 \begin_inset Flex Code
22333 \begin_layout Plain Layout
22339 block, so only the CSS itself need be included.
22342 \begin_layout Description
22343 \begin_inset Flex Code
22346 \begin_layout Plain Layout
22353 \begin_inset Flex Code
22356 \begin_layout Plain Layout
22362 ] The tag to be used for the main label, replacing
22363 \begin_inset Flex Code
22366 \begin_layout Plain Layout
22372 in the examples above.
22373 The default depends upon the setting of
22374 \begin_inset Flex Code
22377 \begin_layout Plain Layout
22384 \begin_inset Flex Code
22387 \begin_layout Plain Layout
22393 is true, the default is
22394 \begin_inset Flex Code
22397 \begin_layout Plain Layout
22403 ; if it is false, the default is
22404 \begin_inset Flex Code
22407 \begin_layout Plain Layout
22416 \begin_layout Subsection
22420 \begin_layout Standard
22421 The XHTML output for floats too can be controlled by layout information.
22422 The output has the following form:
22425 \begin_layout LyX-Code
22427 \begin_inset Quotes erd
22431 \begin_inset Quotes erd
22437 \begin_layout LyX-Code
22438 Contents of the float.
22441 \begin_layout LyX-Code
22445 \begin_layout Standard
22446 The caption, if there is one, is a separate inset and will be output as
22448 Its appearance can be controlled via the InsetLayout for caption insets.
22452 \begin_layout Description
22453 \begin_inset Flex Code
22456 \begin_layout Plain Layout
22463 \begin_inset Flex Code
22466 \begin_layout Plain Layout
22472 ] Specifies attribute information to be output with the main tag.
22474 \begin_inset Quotes eld
22478 \begin_inset Flex Code
22481 \begin_layout Plain Layout
22482 class=`myfloat' onclick=`\SpecialChar ldots
22489 \begin_inset Quotes erd
22493 By default, \SpecialChar LyX
22495 \begin_inset Quotes eld
22499 \begin_inset Flex Code
22502 \begin_layout Plain Layout
22503 class=`float float-floattype'
22509 \begin_inset Quotes erd
22513 \begin_inset Flex Code
22516 \begin_layout Plain Layout
22522 is \SpecialChar LyX
22523 's name for this type of float, as determined by the float declaration
22525 \begin_inset CommandInset ref
22527 reference "subsec:Floats"
22531 ), though made lowercase and with non-alphanumeric characters converted
22532 to underscores, for example: float-table.
22535 \begin_layout Description
22536 \begin_inset Flex Code
22539 \begin_layout Plain Layout
22545 CSS style information to be included when this float is used.
22546 Note that this will automatically be wrapped in a layout-generated
22547 \begin_inset Flex Code
22550 \begin_layout Plain Layout
22556 block, so only the CSS itself need be included.
22559 \begin_layout Description
22560 \begin_inset Flex Code
22563 \begin_layout Plain Layout
22570 \begin_inset Flex Code
22573 \begin_layout Plain Layout
22579 ] The tag to be used for this float, replacing
22580 \begin_inset Quotes eld
22584 \begin_inset Flex Code
22587 \begin_layout Plain Layout
22594 \begin_inset Quotes erd
22597 in the example above.
22599 \begin_inset Flex Code
22602 \begin_layout Plain Layout
22608 and will rarely need changing.
22611 \begin_layout Subsection
22612 Bibliography formatting
22615 \begin_layout Standard
22616 The bibliography can be formatted using
22617 \begin_inset Flex Code
22620 \begin_layout Plain Layout
22628 \begin_inset CommandInset ref
22630 reference "subsec:Citation-format-description"
22637 \begin_layout Subsection
22642 \begin_layout Standard
22643 We have several times mentioned that \SpecialChar LyX
22644 will generate default CSS style rules
22645 for both insets and paragraph styles, based upon the other layout information
22647 In this section, we shall say a word about which layout information \SpecialChar LyX
22652 \begin_layout Standard
22653 At present, \SpecialChar LyX
22654 auto-generates CSS only for font information, making use of
22656 \begin_inset Flex Code
22659 \begin_layout Plain Layout
22666 \begin_inset Flex Code
22669 \begin_layout Plain Layout
22676 \begin_inset Flex Code
22679 \begin_layout Plain Layout
22686 \begin_inset Flex Code
22689 \begin_layout Plain Layout
22696 \begin_inset Flex Code
22699 \begin_layout Plain Layout
22706 \begin_inset CommandInset ref
22708 reference "subsec:Font-description"
22713 The translation is mostly straightforward and obvious.
22715 \begin_inset Quotes eld
22719 \begin_inset Flex Code
22722 \begin_layout Plain Layout
22729 \begin_inset Quotes erd
22733 \begin_inset Quotes eld
22737 \begin_inset Flex Code
22740 \begin_layout Plain Layout
22741 font-family: sans-serif;
22747 \begin_inset Quotes erd
22751 The correspondence of \SpecialChar LyX
22752 sizes and CSS sizes is a little less obvious but
22753 nonetheless intuitive.
22755 \begin_inset Flex Code
22758 \begin_layout Plain Layout
22765 \begin_inset Flex URL
22768 \begin_layout Plain Layout
22778 \begin_layout Chapter
22779 Including External Material
22780 \begin_inset CommandInset label
22782 name "chap:Including-External-Material"
22789 \begin_layout Standard
22790 \begin_inset Box Shadowbox
22800 height_special "totalheight"
22805 backgroundcolor "none"
22808 \begin_layout Plain Layout
22809 WARNING: This portion of the documentation has not been updated for some
22811 We certainly hope that it is still accurate, but there are no guarantees.
22819 \begin_layout Standard
22820 The use of material from sources external to \SpecialChar LyX
22821 is covered in detail in the
22827 This part of the manual covers what needs to happen behind the scenes for
22828 new sorts of material to be included.
22831 \begin_layout Section
22835 \begin_layout Standard
22836 The external material feature is based on the concept of a
22841 A template is a specification of how \SpecialChar LyX
22842 should interface with a certain kind
22844 As bundled, \SpecialChar LyX
22845 comes with predefined templates for Xfig figures, various
22846 raster format images, chess diagrams, and LilyPond music notation.
22847 You can check the actual list by using the menu
22848 \begin_inset Flex Noun
22851 \begin_layout Plain Layout
22852 Insert\SpecialChar menuseparator
22853 File\SpecialChar menuseparator
22860 Furthermore, it is possible to roll your own template to support a specific
22862 Later we'll describe in more detail what is involved, and hopefully you
22863 will submit all the templates you create so we can include them in a later
22868 \begin_layout Standard
22869 Another basic idea of the external material feature is to distinguish between
22870 the original file that serves as a base for final material and the produced
22871 file that is included in your exported or printed document.
22872 For example, consider the case of a figure produced with
22873 \begin_inset Flex Code
22876 \begin_layout Plain Layout
22883 The Xfig application itself works on an original file with the
22884 \begin_inset Flex Code
22887 \begin_layout Plain Layout
22894 Within Xfig, you create and change your figure, and when you are done,
22896 \begin_inset Flex Code
22899 \begin_layout Plain Layout
22906 When you want to include the figure in your document, you invoke
22907 \begin_inset Flex Code
22910 \begin_layout Plain Layout
22916 in order to create a PostScript file that can readily be included in your
22920 \begin_inset Flex Code
22923 \begin_layout Plain Layout
22929 file is the original file, and the PostScript file is the produced file.
22932 \begin_layout Standard
22933 This distinction is important in order to allow updating of the material
22934 while you are in the process of writing the document.
22935 Furthermore, it provides us with the flexibility that is needed to support
22936 multiple export formats.
22937 For instance, in the case of a plain text file, it is not exactly an award-winn
22938 ing idea to include the figure as raw PostScript.
22939 Instead, you would either prefer to just include a reference to the figure
22940 or try to invoke some graphics to ASCII converter to make the final result
22941 look similar to the real graphics.
22942 The external material management allows you to do this, because it is parametri
22943 zed on the different export formats that \SpecialChar LyX
22947 \begin_layout Standard
22948 Besides supporting the production of different products according to the
22949 exported format, it supports tight integration with editing and viewing
22951 In the case of an Xfig figure, you are able to invoke Xfig on the original
22952 file with a single click from within the external material dialog in \SpecialChar LyX
22954 and also preview the produced PostScript file with Ghostview with another
22956 No more fiddling around with the command line and/or file browsers to locate
22957 and manipulate the original or produced files.
22958 In this way, you are finally able to take full advantage of the many different
22959 applications that are relevant to use when you write your documents, and
22960 ultimately be more productive.
22963 \begin_layout Section
22964 The external template configuration file
22967 \begin_layout Standard
22968 It is relatively easy to add custom external template definitions to \SpecialChar LyX
22970 However, be aware that doing this in an careless manner most probably
22974 introduce an easily exploitable security hole.
22975 So before you do this, please read the discussion about security in
22976 \begin_inset CommandInset ref
22978 reference "sec:Security-discussion"
22985 \begin_layout Standard
22986 Having said that, we encourage you to submit any interesting templates that
22991 \begin_layout Standard
22992 The external templates are defined in the
22993 \begin_inset Flex Code
22996 \begin_layout Plain Layout
22997 LyXDir/lib/external_templates
23003 You can place your own version in
23004 \begin_inset Flex Code
23007 \begin_layout Plain Layout
23008 UserDir/external_templates
23016 \begin_layout Standard
23017 A typical template looks like this:
23020 \begin_layout LyX-Code
23024 \begin_layout LyX-Code
23025 GuiName "XFig: $$AbsOrRelPathParent$$Basename"
23028 \begin_layout LyX-Code
23032 \begin_layout LyX-Code
23036 \begin_layout LyX-Code
23040 \begin_layout LyX-Code
23044 \begin_layout LyX-Code
23048 \begin_layout LyX-Code
23049 AutomaticProduction true
23052 \begin_layout LyX-Code
23056 \begin_layout LyX-Code
23060 \begin_layout LyX-Code
23064 \begin_layout LyX-Code
23065 TransformCommand Rotate RotationLatexCommand
23068 \begin_layout LyX-Code
23069 TransformCommand Resize ResizeLatexCommand
23072 \begin_layout LyX-Code
23073 Product "$$RotateFront$$ResizeFront
23076 \begin_layout LyX-Code
23081 input{$$AbsOrRelPathMaster$$Basename.pstex_t}
23084 \begin_layout LyX-Code
23085 $$ResizeBack$$RotateBack"
23088 \begin_layout LyX-Code
23092 \begin_layout LyX-Code
23093 UpdateResult "$$AbsPath$$Basename.pstex_t"
23096 \begin_layout LyX-Code
23097 Requirement "graphicx"
23100 \begin_layout LyX-Code
23101 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
23104 \begin_layout LyX-Code
23105 ReferencedFile latex "$$AbsPath$$Basename.eps"
23108 \begin_layout LyX-Code
23109 ReferencedFile dvi "$$AbsPath$$Basename.eps"
23112 \begin_layout LyX-Code
23116 \begin_layout LyX-Code
23120 \begin_layout LyX-Code
23121 TransformCommand Rotate RotationLatexCommand
23124 \begin_layout LyX-Code
23125 TransformCommand Resize ResizeLatexCommand
23128 \begin_layout LyX-Code
23129 Product "$$RotateFront$$ResizeFront
23132 \begin_layout LyX-Code
23137 input{$$AbsOrRelPathMaster$$Basename.pdftex_t}
23140 \begin_layout LyX-Code
23141 $$ResizeBack$$RotateBack"
23144 \begin_layout LyX-Code
23145 UpdateFormat pdftex
23148 \begin_layout LyX-Code
23149 UpdateResult "$$AbsPath$$Basename.pdftex_t"
23152 \begin_layout LyX-Code
23153 Requirement "graphicx"
23156 \begin_layout LyX-Code
23157 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pdftex_t"
23160 \begin_layout LyX-Code
23161 ReferencedFile latex "$$AbsPath$$Basename.pdf"
23164 \begin_layout LyX-Code
23168 \begin_layout LyX-Code
23172 \begin_layout LyX-Code
23173 Product "[XFig: $$FName]"
23176 \begin_layout LyX-Code
23180 \begin_layout LyX-Code
23184 \begin_layout LyX-Code
23185 Product "<graphic fileref=
23187 "$$AbsOrRelPathMaster$$Basename.eps
23192 \begin_layout LyX-Code
23196 \begin_layout LyX-Code
23200 \begin_layout LyX-Code
23201 UpdateResult "$$AbsPath$$Basename.eps"
23204 \begin_layout LyX-Code
23205 ReferencedFile docbook "$$AbsPath$$Basename.eps"
23208 \begin_layout LyX-Code
23209 ReferencedFile docbook-xml "$$AbsPath$$Basename.eps"
23212 \begin_layout LyX-Code
23216 \begin_layout LyX-Code
23220 \begin_layout Standard
23221 As you can see, the template is enclosed in
23222 \begin_inset Flex Code
23225 \begin_layout Plain Layout
23233 \begin_inset Flex Code
23236 \begin_layout Plain Layout
23243 It contains a header specifying some general settings and, for each supported
23244 primary document file format, a section
23245 \begin_inset Flex Code
23248 \begin_layout Plain Layout
23256 \begin_inset Flex Code
23259 \begin_layout Plain Layout
23268 \begin_layout Subsection
23269 The template header
23272 \begin_layout Description
23273 \begin_inset Flex Code
23276 \begin_layout Plain Layout
23277 AutomaticProduction
23278 \begin_inset space ~
23286 Whether the file represented by the template must be generated by \SpecialChar LyX
23288 This command must occur exactly once.
23291 \begin_layout Description
23292 \begin_inset Flex Code
23295 \begin_layout Plain Layout
23297 \begin_inset space ~
23305 A glob pattern that is used in the file dialog to filter out the desired
23307 If there is more than one possible file extension (e.
23308 \begin_inset space \thinspace{}
23312 \begin_inset space \space{}
23316 \begin_inset Flex Code
23319 \begin_layout Plain Layout
23326 \begin_inset Flex Code
23329 \begin_layout Plain Layout
23335 ), use something like
23336 \begin_inset Flex Code
23339 \begin_layout Plain Layout
23346 This command must occur exactly once.
23349 \begin_layout Description
23350 \begin_inset Flex Code
23353 \begin_layout Plain Layout
23355 \begin_inset space ~
23363 The text that is displayed on the button.
23364 This command must occur exactly once.
23367 \begin_layout Description
23368 \begin_inset Flex Code
23371 \begin_layout Plain Layout
23373 \begin_inset space ~
23377 \begin_inset space ~
23385 The help text that is used in the External dialog.
23386 Provide enough information to explain to the user just what the template
23387 can provide him with.
23388 This command must occur exactly once.
23391 \begin_layout Description
23392 \begin_inset Flex Code
23395 \begin_layout Plain Layout
23397 \begin_inset space ~
23405 The file format of the original file.
23406 This must be the name of a format that is known to \SpecialChar LyX
23408 \begin_inset CommandInset ref
23410 reference "sec:Formats"
23416 \begin_inset Quotes eld
23420 \begin_inset Flex Code
23423 \begin_layout Plain Layout
23430 \begin_inset Quotes erd
23433 if the template can handle original files of more than one format.
23435 will attempt to interrogate the file itself in order to deduce its format
23437 This command must occur exactly once.
23440 \begin_layout Description
23441 \begin_inset Flex Code
23444 \begin_layout Plain Layout
23446 \begin_inset space ~
23454 A unique name for the template.
23455 It must not contain substitution macros (see below).
23458 \begin_layout Description
23459 \begin_inset Flex Code
23462 \begin_layout Plain Layout
23464 \begin_inset space ~
23467 Rotate|Resize|Clip|Extra
23472 This command specifies which transformations are supported by this template.
23473 It may occur zero or more times.
23474 This command enables the corresponding tabs in the external dialog.
23476 \begin_inset Flex Code
23479 \begin_layout Plain Layout
23485 command must have either a corresponding
23486 \begin_inset Flex Code
23489 \begin_layout Plain Layout
23496 \begin_inset Flex Code
23499 \begin_layout Plain Layout
23506 \begin_inset Flex Code
23509 \begin_layout Plain Layout
23516 Otherwise the transformation will not be supported by that format.
23519 \begin_layout Subsection
23523 \begin_layout Description
23524 \begin_inset Flex Code
23527 \begin_layout Plain Layout
23529 \begin_inset space ~
23532 LaTeX|PDFLaTeX|PlainText|DocBook|XHTML
23537 The primary document file format that this format definition is for.
23538 Not every template has a sensible representation in all document file formats.
23539 Please define nevertheless a
23540 \begin_inset Flex Code
23543 \begin_layout Plain Layout
23549 section for all templates.
23550 Use a dummy text when no representation is available.
23551 Then you can at least see a reference to the external material in the exported
23555 \begin_layout Description
23556 \begin_inset Flex Code
23559 \begin_layout Plain Layout
23561 \begin_inset space ~
23565 \begin_inset space ~
23573 This command defines an additional macro
23574 \begin_inset Flex Code
23577 \begin_layout Plain Layout
23583 for substitution in
23584 \begin_inset Flex Code
23587 \begin_layout Plain Layout
23595 \begin_inset Flex Code
23598 \begin_layout Plain Layout
23604 itself may contain substitution macros.
23605 The advantage over using
23606 \begin_inset Flex Code
23609 \begin_layout Plain Layout
23616 \begin_inset Flex Code
23619 \begin_layout Plain Layout
23625 is that the substituted value of
23626 \begin_inset Flex Code
23629 \begin_layout Plain Layout
23635 is sanitized so that it is a valid optional argument in the document format.
23636 This command may occur zero or more times.
23639 \begin_layout Description
23640 \begin_inset Flex Code
23643 \begin_layout Plain Layout
23645 \begin_inset space ~
23653 The text that is inserted in the exported document.
23654 This is actually the most important command and can be quite complex.
23655 This command must occur exactly once.
23658 \begin_layout Description
23659 \begin_inset Flex Code
23662 \begin_layout Plain Layout
23664 \begin_inset space ~
23672 This command specifies a preamble snippet that will be included in the
23675 It has to be defined using
23676 \begin_inset Flex Code
23679 \begin_layout Plain Layout
23687 \begin_inset Flex Code
23690 \begin_layout Plain Layout
23697 This command may occur zero or more times.
23700 \begin_layout Description
23701 \begin_inset Flex Code
23704 \begin_layout Plain Layout
23706 \begin_inset space ~
23710 \begin_inset space ~
23718 This command denotes files that are created by the conversion process and
23719 are needed for a particular export format.
23720 If the filename is relative, it is interpreted relative to the master document.
23721 This command may be given zero or more times.
23724 \begin_layout Description
23725 \begin_inset Flex Code
23728 \begin_layout Plain Layout
23730 \begin_inset space ~
23738 The name of a required \SpecialChar LaTeX
23740 The package is included via
23741 \begin_inset Flex Code
23744 \begin_layout Plain Layout
23752 in the \SpecialChar LaTeX
23754 This command may occur zero or more times.
23757 \begin_layout Description
23758 \begin_inset Flex Code
23761 \begin_layout Plain Layout
23763 \begin_inset space ~
23767 \begin_inset space ~
23770 RotationLatexCommand
23775 This command specifies that the built in \SpecialChar LaTeX
23776 command should be used for rotation.
23777 This command may occur once or not at all.
23780 \begin_layout Description
23781 \begin_inset Flex Code
23784 \begin_layout Plain Layout
23786 \begin_inset space ~
23790 \begin_inset space ~
23798 This command specifies that the built in \SpecialChar LaTeX
23799 command should be used for resizing.
23800 This command may occur once or not at all.
23803 \begin_layout Description
23804 \begin_inset Flex Code
23807 \begin_layout Plain Layout
23809 \begin_inset space ~
23813 \begin_inset space ~
23816 RotationLatexOption
23821 This command specifies that rotation is done via an optional argument.
23822 This command may occur once or not at all.
23825 \begin_layout Description
23826 \begin_inset Flex Code
23829 \begin_layout Plain Layout
23831 \begin_inset space ~
23835 \begin_inset space ~
23843 This command specifies that resizing is done via an optional argument.
23844 This command may occur once or not at all.
23847 \begin_layout Description
23848 \begin_inset Flex Code
23851 \begin_layout Plain Layout
23853 \begin_inset space ~
23857 \begin_inset space ~
23865 This command specifies that clipping is done via an optional argument.
23866 This command may occur once or not at all.
23869 \begin_layout Description
23870 \begin_inset Flex Code
23873 \begin_layout Plain Layout
23875 \begin_inset space ~
23879 \begin_inset space ~
23887 This command specifies that an extra optional argument is used.
23888 This command may occur once or not at all.
23891 \begin_layout Description
23892 \begin_inset Flex Code
23895 \begin_layout Plain Layout
23897 \begin_inset space ~
23905 The file format of the converted file.
23906 This must be the name of a format that is known to \SpecialChar LyX
23908 \begin_inset Flex Noun
23911 \begin_layout Plain Layout
23912 Tools\SpecialChar menuseparator
23913 Preferences\SpecialChar menuseparator
23914 File Handling\SpecialChar menuseparator
23921 This command must occur exactly once.
23922 If the resulting file format is PDF, you need to specify the format
23923 \begin_inset Flex Code
23926 \begin_layout Plain Layout
23933 This is the PDF format used for including graphics.
23934 The other defined PDF formats are for document export.
23937 \begin_layout Description
23938 \begin_inset Flex Code
23941 \begin_layout Plain Layout
23943 \begin_inset space ~
23951 The file name of the converted file.
23952 The file name must be absolute.
23953 This command must occur exactly once.
23956 \begin_layout Subsection
23957 Preamble definitions
23960 \begin_layout Standard
23961 The external template configuration file may contain additional preamble
23962 definitions enclosed by
23963 \begin_inset Flex Code
23966 \begin_layout Plain Layout
23974 \begin_inset Flex Code
23977 \begin_layout Plain Layout
23984 They can be used by the templates in the
23985 \begin_inset Flex Code
23988 \begin_layout Plain Layout
23997 \begin_layout Section
23998 The substitution mechanism
24001 \begin_layout Standard
24002 When the external material facility invokes an external program, it is done
24003 on the basis of a command defined in the template configuration file.
24004 These commands can contain various macros that are expanded before execution.
24005 Execution always take place in the directory of the containing document.
24008 \begin_layout Standard
24009 Also, whenever external material is to be displayed, the name will be produced
24010 by the substitution mechanism, and most other commands in the template
24011 definition support substitution as well.
24014 \begin_layout Standard
24015 The available macros are the following:
24018 \begin_layout Description
24019 \begin_inset Flex Code
24022 \begin_layout Plain Layout
24023 $$AbsOrRelPathMaster
24028 The file path, absolute or relative to the master \SpecialChar LyX
24032 \begin_layout Description
24033 \begin_inset Flex Code
24036 \begin_layout Plain Layout
24037 $$AbsOrRelPathParent
24042 The file path, absolute or relative to the \SpecialChar LyX
24046 \begin_layout Description
24047 \begin_inset Flex Code
24050 \begin_layout Plain Layout
24056 The absolute file path.
24059 \begin_layout Description
24060 \begin_inset Flex Code
24063 \begin_layout Plain Layout
24069 The filename without path and without the extension.
24072 \begin_layout Description
24073 \begin_inset Flex Code
24076 \begin_layout Plain Layout
24078 \begin_inset Quotes eld
24082 \begin_inset Quotes erd
24090 This macro will expand to the contents of the file with the name
24091 \begin_inset Flex Code
24094 \begin_layout Plain Layout
24103 \begin_layout Description
24104 \begin_inset Flex Code
24107 \begin_layout Plain Layout
24113 The file extension (including the dot).
24116 \begin_layout Description
24117 \begin_inset Flex Code
24120 \begin_layout Plain Layout
24126 This will be the string
24127 \begin_inset Quotes eld
24131 \begin_inset Quotes erd
24134 if the file is in JPEG format, otherwise it will be the string
24135 \begin_inset Quotes eld
24139 \begin_inset Quotes erd
24143 This is useful to avoid uneeded conversions for output formats that support
24144 both PNG and JPEG fomats.
24145 The predefined RasterImage template uses this macro for the pdf\SpecialChar TeX
24150 \begin_layout Description
24151 \begin_inset Flex Code
24154 \begin_layout Plain Layout
24160 The filename of the file specified in the external material dialog.
24161 This is either an absolute name, or it is relative to the \SpecialChar LyX
24165 \begin_layout Description
24166 \begin_inset Flex Code
24169 \begin_layout Plain Layout
24176 \begin_inset Flex Code
24179 \begin_layout Plain Layout
24185 (absolute name or relative to the \SpecialChar LyX
24189 \begin_layout Description
24190 \begin_inset Flex Code
24193 \begin_layout Plain Layout
24199 The file path, relative to the master \SpecialChar LyX
24203 \begin_layout Description
24204 \begin_inset Flex Code
24207 \begin_layout Plain Layout
24213 The file path, relative to the \SpecialChar LyX
24217 \begin_layout Description
24218 \begin_inset Flex Code
24221 \begin_layout Plain Layout
24227 This macro will expand to the absolute path of the system directory.
24228 This is typically used to point to the various helper scripts that are
24229 bundled with \SpecialChar LyX
24233 \begin_layout Description
24234 \begin_inset Flex Code
24237 \begin_layout Plain Layout
24243 A name and full path to a temporary file which will be automatically deleted
24244 whenever the containing document is closed, or the external material insertion
24248 \begin_layout Standard
24249 All path macros contain a trailing directory separator, so you can construct
24251 \begin_inset space \thinspace{}
24255 \begin_inset space \space{}
24258 the absolute filename with
24259 \begin_inset Flex Code
24262 \begin_layout Plain Layout
24263 $$AbsPath$$Basename$$Extension
24271 \begin_layout Standard
24272 The macros above are substituted in all commands unless otherwise noted.
24274 \begin_inset Flex Code
24277 \begin_layout Plain Layout
24283 supports additionally the following substitutions if they are enabled by
24285 \begin_inset Flex Code
24288 \begin_layout Plain Layout
24295 \begin_inset Flex Code
24298 \begin_layout Plain Layout
24307 \begin_layout Description
24308 \begin_inset Flex Code
24311 \begin_layout Plain Layout
24317 The front part of the resize command.
24320 \begin_layout Description
24321 \begin_inset Flex Code
24324 \begin_layout Plain Layout
24330 The back part of the resize command.
24333 \begin_layout Description
24334 \begin_inset Flex Code
24337 \begin_layout Plain Layout
24343 The front part of the rotation command.
24346 \begin_layout Description
24347 \begin_inset Flex Code
24350 \begin_layout Plain Layout
24356 The back part of the rotation command.
24359 \begin_layout Standard
24360 The value string of the
24361 \begin_inset Flex Code
24364 \begin_layout Plain Layout
24370 command supports additionally the following substitutions if they are enabled
24372 \begin_inset Flex Code
24375 \begin_layout Plain Layout
24382 \begin_inset Flex Code
24385 \begin_layout Plain Layout
24394 \begin_layout Description
24395 \begin_inset Flex Code
24398 \begin_layout Plain Layout
24407 \begin_layout Description
24408 \begin_inset Flex Code
24411 \begin_layout Plain Layout
24420 \begin_layout Description
24421 \begin_inset Flex Code
24424 \begin_layout Plain Layout
24433 \begin_layout Description
24434 \begin_inset Flex Code
24437 \begin_layout Plain Layout
24443 The rotation option.
24446 \begin_layout Standard
24447 You may ask why there are so many path macros.
24448 There are mainly two reasons:
24451 \begin_layout Enumerate
24452 Relative and absolute file names should remain relative or absolute, respectivel
24454 Users may have reasons to prefer either form.
24455 Relative names are useful for portable documents that should work on different
24456 machines, for example.
24457 Absolute names may be required by some programs.
24460 \begin_layout Enumerate
24462 treats relative file names differently than \SpecialChar LyX
24463 and other programs in nested
24465 For \SpecialChar LyX
24466 , a relative file name is always relative to the document that contains
24468 For \SpecialChar LaTeX
24469 , it is always relative to the master document.
24470 These two definitions are identical if you have only one document, but
24471 differ if you have a master document that includes part documents.
24472 That means that relative filenames must be transformed when presented to
24475 Fortunately \SpecialChar LyX
24476 does this automatically for you if you choose the right macros.
24479 \begin_layout Standard
24480 So which path macro should be used in new template definitions? The rule
24484 \begin_layout Itemize
24486 \begin_inset Flex Code
24489 \begin_layout Plain Layout
24495 if an absolute path is required.
24498 \begin_layout Itemize
24500 \begin_inset Flex Code
24503 \begin_layout Plain Layout
24504 $$AbsOrRelPathMaster
24509 if the substituted string is some kind of \SpecialChar LaTeX
24513 \begin_layout Itemize
24515 \begin_inset Flex Code
24518 \begin_layout Plain Layout
24519 $$AbsOrRelPathParent
24524 in order to preserve the user's choice.
24527 \begin_layout Standard
24528 There are special cases where this rule does not work and e.
24529 \begin_inset space \thinspace{}
24533 \begin_inset space \space{}
24536 relative names are needed, but normally it will work just fine.
24537 One example for such a case is the command
24538 \begin_inset Flex Code
24541 \begin_layout Plain Layout
24542 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
24547 in the XFig template above: We can't use the absolute name because the
24549 \begin_inset Flex Code
24552 \begin_layout Plain Layout
24558 files needs the relative name in order to rewrite the file content.
24561 \begin_layout Section
24562 Security discussion
24563 \begin_inset CommandInset label
24565 name "sec:Security-discussion"
24572 \begin_layout Standard
24573 The external material feature interfaces with a lot of external programs
24574 and does so automatically, so we have to consider the security implications
24576 In particular, since you have the option of including your own filenames
24577 and/or parameter strings and those are expanded into a command, it seems
24578 that it would be possible to create a malicious document which executes
24579 arbitrary commands when a user views or prints the document.
24580 This is something we definitely want to avoid.
24583 \begin_layout Standard
24584 However, since the external program commands are specified in the template
24585 configuration file only, there are no security issues if \SpecialChar LyX
24586 is properly configure
24587 d with safe templates only.
24588 This is so because the external programs are invoked with the
24589 \begin_inset Flex Code
24592 \begin_layout Plain Layout
24598 -system call rather than the
24599 \begin_inset Flex Code
24602 \begin_layout Plain Layout
24608 system-call, so it's not possible to execute arbitrary commands from the
24609 filename or parameter section via the shell.
24612 \begin_layout Standard
24613 This also implies that you are restricted in what command strings you can
24614 use in the external material templates.
24615 In particular, pipes and redirection are not readily available.
24616 This has to be so if \SpecialChar LyX
24617 should remain safe.
24618 If you want to use some of the shell features, you should write a safe
24619 script to do this in a controlled manner, and then invoke the script from
24620 the command string.
24624 \begin_layout Standard
24625 It is possible to design a template that interacts directly with the shell,
24626 but since this would allow a malicious user to execute arbitrary commands
24627 by writing clever filenames and/or parameters, we generally recommend that
24628 you only use safe scripts that work with the
24629 \begin_inset Flex Code
24632 \begin_layout Plain Layout
24638 system call in a controlled manner.
24639 Of course, for use in a controlled environment, it can be tempting to just
24640 fall back to use ordinary shell scripts.
24641 If you do so, be aware that you
24645 provide an easily exploitable security hole in your system.
24646 Of course it stands to reason that such unsafe templates will never be
24647 included in the standard \SpecialChar LyX
24648 distribution, although we do encourage people
24649 to submit new templates in the open source tradition.
24650 But \SpecialChar LyX
24651 as shipped from the official distribution channels will never have
24655 \begin_layout Standard
24656 Including external material provides a lot of power, and you have to be
24657 careful not to introduce security hazards with this power.
24658 A subtle error in a single line in an innocent looking script can open
24659 the door to huge security problems.
24660 So if you do not fully understand the issues, we recommend that you consult
24661 a knowledgeable security professional or the \SpecialChar LyX
24662 development team if you have
24663 any questions about whether a given template is safe or not.
24664 And do this before you use it in an uncontrolled environment.
24667 \begin_layout Chapter
24669 List of supported \SpecialChar LyX
24670 functions to be used in layouts
24671 \begin_inset CommandInset label
24673 name "chap:List-of-functions"
24680 \begin_layout Standard
24682 \begin_inset Tabular
24683 <lyxtabular version="3" rows="11" columns="8">
24684 <features tabularvalignment="middle">
24685 <column alignment="left" valignment="top">
24686 <column alignment="left" valignment="top">
24687 <column alignment="left" valignment="top">
24688 <column alignment="left" valignment="top">
24689 <column alignment="left" valignment="top">
24690 <column alignment="left" valignment="top">
24691 <column alignment="left" valignment="top">
24692 <column alignment="left" valignment="top">
24694 <cell alignment="left" valignment="top" usebox="none">
24697 \begin_layout Plain Layout
24703 <cell alignment="left" valignment="top" usebox="none">
24706 \begin_layout Plain Layout
24712 <cell alignment="left" valignment="top" usebox="none">
24715 \begin_layout Plain Layout
24721 <cell alignment="left" valignment="top" usebox="none">
24724 \begin_layout Plain Layout
24730 <cell alignment="center" valignment="top" usebox="none">
24733 \begin_layout Plain Layout
24739 <cell alignment="center" valignment="top" usebox="none">
24742 \begin_layout Plain Layout
24748 <cell alignment="center" valignment="top" usebox="none">
24751 \begin_layout Plain Layout
24757 <cell alignment="center" valignment="top" usebox="none">
24760 \begin_layout Plain Layout
24768 <cell alignment="left" valignment="top" usebox="none">
24771 \begin_layout Plain Layout
24777 <cell alignment="left" valignment="top" usebox="none">
24780 \begin_layout Plain Layout
24786 <cell alignment="left" valignment="top" usebox="none">
24789 \begin_layout Plain Layout
24795 <cell alignment="left" valignment="top" usebox="none">
24798 \begin_layout Plain Layout
24804 <cell alignment="center" valignment="top" usebox="none">
24807 \begin_layout Plain Layout
24813 <cell alignment="center" valignment="top" usebox="none">
24816 \begin_layout Plain Layout
24822 <cell alignment="center" valignment="top" usebox="none">
24825 \begin_layout Plain Layout
24831 <cell alignment="center" valignment="top" usebox="none">
24834 \begin_layout Plain Layout
24842 <cell alignment="left" valignment="top" usebox="none">
24845 \begin_layout Plain Layout
24851 <cell alignment="left" valignment="top" usebox="none">
24854 \begin_layout Plain Layout
24860 <cell alignment="left" valignment="top" usebox="none">
24863 \begin_layout Plain Layout
24869 <cell alignment="left" valignment="top" usebox="none">
24872 \begin_layout Plain Layout
24878 <cell alignment="center" valignment="top" usebox="none">
24881 \begin_layout Plain Layout
24887 <cell alignment="center" valignment="top" usebox="none">
24890 \begin_layout Plain Layout
24896 <cell alignment="center" valignment="top" usebox="none">
24899 \begin_layout Plain Layout
24905 <cell alignment="center" valignment="top" usebox="none">
24908 \begin_layout Plain Layout
24916 <cell alignment="left" valignment="top" usebox="none">
24919 \begin_layout Plain Layout
24925 <cell alignment="left" valignment="top" usebox="none">
24928 \begin_layout Plain Layout
24934 <cell alignment="left" valignment="top" usebox="none">
24937 \begin_layout Plain Layout
24943 <cell alignment="left" valignment="top" usebox="none">
24946 \begin_layout Plain Layout
24952 <cell alignment="center" valignment="top" usebox="none">
24955 \begin_layout Plain Layout
24961 <cell alignment="center" valignment="top" usebox="none">
24964 \begin_layout Plain Layout
24970 <cell alignment="center" valignment="top" usebox="none">
24973 \begin_layout Plain Layout
24979 <cell alignment="center" valignment="top" usebox="none">
24982 \begin_layout Plain Layout
24990 <cell alignment="left" valignment="top" usebox="none">
24993 \begin_layout Plain Layout
24999 <cell alignment="left" valignment="top" usebox="none">
25002 \begin_layout Plain Layout
25008 <cell alignment="left" valignment="top" usebox="none">
25011 \begin_layout Plain Layout
25017 <cell alignment="left" valignment="top" usebox="none">
25020 \begin_layout Plain Layout
25026 <cell alignment="center" valignment="top" usebox="none">
25029 \begin_layout Plain Layout
25035 <cell alignment="center" valignment="top" usebox="none">
25038 \begin_layout Plain Layout
25044 <cell alignment="center" valignment="top" usebox="none">
25047 \begin_layout Plain Layout
25053 <cell alignment="center" valignment="top" usebox="none">
25056 \begin_layout Plain Layout
25064 <cell alignment="left" valignment="top" usebox="none">
25067 \begin_layout Plain Layout
25073 <cell alignment="left" valignment="top" usebox="none">
25076 \begin_layout Plain Layout
25082 <cell alignment="left" valignment="top" usebox="none">
25085 \begin_layout Plain Layout
25091 <cell alignment="left" valignment="top" usebox="none">
25094 \begin_layout Plain Layout
25100 <cell alignment="center" valignment="top" usebox="none">
25103 \begin_layout Plain Layout
25109 <cell alignment="center" valignment="top" usebox="none">
25112 \begin_layout Plain Layout
25118 <cell alignment="center" valignment="top" usebox="none">
25121 \begin_layout Plain Layout
25127 <cell alignment="center" valignment="top" usebox="none">
25130 \begin_layout Plain Layout
25138 <cell alignment="left" valignment="top" usebox="none">
25141 \begin_layout Plain Layout
25147 <cell alignment="left" valignment="top" usebox="none">
25150 \begin_layout Plain Layout
25156 <cell alignment="left" valignment="top" usebox="none">
25159 \begin_layout Plain Layout
25165 <cell alignment="left" valignment="top" usebox="none">
25168 \begin_layout Plain Layout
25174 <cell alignment="center" valignment="top" usebox="none">
25177 \begin_layout Plain Layout
25183 <cell alignment="center" valignment="top" usebox="none">
25186 \begin_layout Plain Layout
25192 <cell alignment="center" valignment="top" usebox="none">
25195 \begin_layout Plain Layout
25201 <cell alignment="center" valignment="top" usebox="none">
25204 \begin_layout Plain Layout
25212 <cell alignment="left" valignment="top" usebox="none">
25215 \begin_layout Plain Layout
25221 <cell alignment="left" valignment="top" usebox="none">
25224 \begin_layout Plain Layout
25230 <cell alignment="left" valignment="top" usebox="none">
25233 \begin_layout Plain Layout
25239 <cell alignment="left" valignment="top" usebox="none">
25242 \begin_layout Plain Layout
25248 <cell alignment="center" valignment="top" usebox="none">
25251 \begin_layout Plain Layout
25257 <cell alignment="center" valignment="top" usebox="none">
25260 \begin_layout Plain Layout
25266 <cell alignment="center" valignment="top" usebox="none">
25269 \begin_layout Plain Layout
25275 <cell alignment="center" valignment="top" usebox="none">
25278 \begin_layout Plain Layout
25286 <cell alignment="left" valignment="top" usebox="none">
25289 \begin_layout Plain Layout
25295 <cell alignment="left" valignment="top" usebox="none">
25298 \begin_layout Plain Layout
25304 <cell alignment="left" valignment="top" usebox="none">
25307 \begin_layout Plain Layout
25313 <cell alignment="left" valignment="top" usebox="none">
25316 \begin_layout Plain Layout
25322 <cell alignment="center" valignment="top" usebox="none">
25325 \begin_layout Plain Layout
25331 <cell alignment="center" valignment="top" usebox="none">
25334 \begin_layout Plain Layout
25340 <cell alignment="center" valignment="top" usebox="none">
25343 \begin_layout Plain Layout
25349 <cell alignment="center" valignment="top" usebox="none">
25352 \begin_layout Plain Layout
25360 <cell alignment="left" valignment="top" usebox="none">
25363 \begin_layout Plain Layout
25369 <cell alignment="left" valignment="top" usebox="none">
25372 \begin_layout Plain Layout
25378 <cell alignment="left" valignment="top" usebox="none">
25381 \begin_layout Plain Layout
25387 <cell alignment="left" valignment="top" usebox="none">
25390 \begin_layout Plain Layout
25396 <cell alignment="center" valignment="top" usebox="none">
25399 \begin_layout Plain Layout
25405 <cell alignment="center" valignment="top" usebox="none">
25408 \begin_layout Plain Layout
25414 <cell alignment="center" valignment="top" usebox="none">
25417 \begin_layout Plain Layout
25423 <cell alignment="center" valignment="top" usebox="none">
25426 \begin_layout Plain Layout
25434 <cell alignment="center" valignment="top" usebox="none">
25437 \begin_layout Plain Layout
25443 <cell alignment="center" valignment="top" usebox="none">
25446 \begin_layout Plain Layout
25452 <cell alignment="center" valignment="top" usebox="none">
25455 \begin_layout Plain Layout
25461 <cell alignment="center" valignment="top" usebox="none">
25464 \begin_layout Plain Layout
25470 <cell alignment="center" valignment="top" usebox="none">
25473 \begin_layout Plain Layout
25479 <cell alignment="center" valignment="top" usebox="none">
25482 \begin_layout Plain Layout
25488 <cell alignment="center" valignment="top" usebox="none">
25491 \begin_layout Plain Layout
25497 <cell alignment="center" valignment="top" usebox="none">
25500 \begin_layout Plain Layout
25514 \begin_layout Chapter
25515 Names of available colors to be used in layouts
25516 \begin_inset CommandInset label
25518 name "chap:Names-of-colors"
25525 \begin_layout Standard
25526 The colors listed here are the standard colors and the those that you can
25527 adjust in the \SpecialChar LyX
25531 \begin_layout Description
25544 No particular color – clear or default
25547 \begin_layout Description
25551 \begin_layout Description
25555 \begin_layout Description
25559 \begin_layout Description
25563 \begin_layout Description
25567 \begin_layout Description
25571 \begin_layout Description
25575 \begin_layout Description
25579 \begin_layout Description
25580 added_space Added space marker color
25583 \begin_layout Description
25584 addedtext Added text color
25587 \begin_layout Description
25588 appendix Appendix marker color
25591 \begin_layout Description
25592 background Background color
25595 \begin_layout Description
25596 bottomarea Bottom area color
25599 \begin_layout Description
25600 branchlabel Label color for branches
25603 \begin_layout Description
25604 buttonbg Color used for button background
25607 \begin_layout Description
25608 buttonhoverbg Color used for button background under focus
25611 \begin_layout Description
25612 buttonframe Color for inset button frames
25615 \begin_layout Description
25616 changebar Changebar color
25619 \begin_layout Description
25620 changedtextauthor1 Changed text color author 1
25623 \begin_layout Description
25624 changedtextauthor2 Changed text color author 2
25627 \begin_layout Description
25628 changedtextauthor3 Changed text color author 3
25631 \begin_layout Description
25632 changedtextauthor4 Changed text color author 4
25635 \begin_layout Description
25636 changedtextauthor5 Changed text color author 5
25639 \begin_layout Description
25640 collapsable_inset_frame Collapsable insets framecolor
25643 \begin_layout Description
25644 collapsable_inset_text Collapsable insets text color
25647 \begin_layout Description
25648 command Text color for command insets
25651 \begin_layout Description
25652 commandbg Background color for command insets
25655 \begin_layout Description
25656 commandframe Frame color for command insets
25659 \begin_layout Description
25660 comment color for comments
25663 \begin_layout Description
25664 commentbg Background color of comments
25667 \begin_layout Description
25668 cursor Cursor color
25671 \begin_layout Description
25672 deletedtext Deleted text color
25675 \begin_layout Description
25676 deletedtextmodifier Deleted text modifying color
25679 \begin_layout Description
25680 depthbar Color for the depth bars in the margin
25683 \begin_layout Description
25684 eolmarker End of line marker color
25687 \begin_layout Description
25688 error Color of the \SpecialChar LaTeX
25692 \begin_layout Description
25693 footlabel Label color for footnotes
25696 \begin_layout Description
25697 graphicsbg Graphics inset background color
25700 \begin_layout Description
25701 greyedout Label color for greyedout insets
25704 \begin_layout Description
25705 greyedoutbg Background color of greyedout inset
25708 \begin_layout Description
25709 greyedouttext Color for greyedout inset text
25712 \begin_layout Description
25713 indexlabel Label color for index insets
25716 \begin_layout Description
25717 ignore The color is ignored
25720 \begin_layout Description
25721 inherit The color is inherited
25724 \begin_layout Description
25725 inlinecompletion Inline completion color
25728 \begin_layout Description
25729 insetbg Inset marker background color
25732 \begin_layout Description
25733 insetframe Inset marker frame color
25736 \begin_layout Description
25737 language Color for marking foreign language words
25740 \begin_layout Description
25741 latex Text color in \SpecialChar LaTeX
25745 \begin_layout Description
25746 listingsbg Background color of listings inset
25749 \begin_layout Description
25750 marginlabel Label color for margin notes
25753 \begin_layout Description
25754 math Math inset text color
25757 \begin_layout Description
25758 mathbg Math inset background color
25761 \begin_layout Description
25762 mathcorners Math inset frame color not under focus
25765 \begin_layout Description
25766 mathframe Math inset frame color under focus
25769 \begin_layout Description
25770 mathline Math line color
25773 \begin_layout Description
25774 mathmacrobg Macro math inset background color
25777 \begin_layout Description
25778 mathmacroblend Macro math blended color
25781 \begin_layout Description
25782 mathmacroframe Macro math frame color
25785 \begin_layout Description
25786 mathmacrohoverbg Macro math inset background color hovered
25789 \begin_layout Description
25790 mathmacrolabel Macro math label color
25793 \begin_layout Description
25794 mathmacronewarg Macro template color for new parameters
25797 \begin_layout Description
25798 mathmacrooldarg Macro template color for old parameters
25801 \begin_layout Description
25802 newpage New page color
25805 \begin_layout Description
25806 nonunique_inlinecompletion Inline completion color for the non-unique part
25809 \begin_layout Description
25810 notebg Background color of notes
25813 \begin_layout Description
25814 notelabel Label color for notes
25817 \begin_layout Description
25818 pagebreak Page break/line break color
25821 \begin_layout Description
25822 paragraphmarker Color used for the pilcrow sign to mark the end of a paragraph
25825 \begin_layout Description
25826 phantomtext Text color for phantom insets
25829 \begin_layout Description
25830 preview The color used for previews
25833 \begin_layout Description
25834 previewframe Preview frame color
25837 \begin_layout Description
25838 regexpframe Color for regexp frame
25841 \begin_layout Description
25842 selection Background color of selected text
25845 \begin_layout Description
25846 selectiontext Foreground color of selected text
25849 \begin_layout Description
25850 shadedbg Background color of shaded box
25853 \begin_layout Description
25854 special Special chars text color
25857 \begin_layout Description
25858 tabularline Table line color
25861 \begin_layout Description
25862 tabularonoffline Table line color
25865 \begin_layout Description
25866 urllabel Label color for URL insets
25869 \begin_layout Description
25870 urltext Color for URL inset text