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
6028 \begin_inset Separator latexpar
6035 \begin_layout Enumerate
6036 On *nix systems (Linux, OSX, etc.), if you want the new package to be available
6037 for all users on your system, then install it in your `local' \SpecialChar TeX
6039 install it in your own `user' \SpecialChar TeX
6041 Where these trees should be created, if they do not already exist, depends
6043 To find this out, look in the file
6044 \begin_inset Flex Code
6047 \begin_layout Plain Layout
6057 \begin_layout Plain Layout
6058 This is usually in the directory
6059 \begin_inset Flex Code
6062 \begin_layout Plain Layout
6068 , though you can execute the command
6069 \begin_inset Flex Code
6072 \begin_layout Plain Layout
6083 The location of the `local' \SpecialChar TeX
6084 tree is defined by the
6085 \begin_inset Flex Code
6088 \begin_layout Plain Layout
6094 variable; this is usually somewhere like
6095 \begin_inset Flex Code
6098 \begin_layout Plain Layout
6099 /usr/local/share/texmf
6104 or /usr/local/texlive/XXXX where XXXX is the year of the installed \SpecialChar TeX
6107 The location of the `user' \SpecialChar TeX
6109 \begin_inset Flex Code
6112 \begin_layout Plain Layout
6119 \begin_inset Flex Code
6122 \begin_layout Plain Layout
6129 \begin_inset Flex Code
6132 \begin_layout Plain Layout
6142 (If these variables are not predefined, you have to define them.) You'll
6143 probably need root permissions to create or modify the `local' tree, but
6144 not for your `user' tree.
6145 \begin_inset Newline newline
6148 In general, it is recommended to install in the user tree because your user
6149 will not be modified or even overwritten when you upgrade your system.
6150 It will typically also be backed up together with everything else when
6151 you backup your home directory (which, of course, you do on a regular basis).
6154 \begin_layout Enumerate
6155 On Windows, if you want the new package to be available for all users on
6156 your system, change to the folder where \SpecialChar LaTeX
6157 is installed and then change to
6159 \begin_inset Flex Code
6162 \begin_layout Plain Layout
6173 (For MiK\SpecialChar TeX
6174 , this would be by default the folder
6175 \begin_inset Flex Code
6178 \begin_layout Plain Layout
6196 \begin_layout Plain Layout
6197 Note that this will be the correct path only on English installations.
6198 On a German one, it would be
6199 \begin_inset Flex Code
6202 \begin_layout Plain Layout
6216 , and similarly for other languages.
6221 Create there a new folder
6222 \begin_inset Flex Code
6225 \begin_layout Plain Layout
6231 and copy all files of the package into it.
6233 \begin_inset Newline newline
6236 If the package should only available for you or you don't have admin permissions
6237 , do the same, but in the local \SpecialChar LaTeX
6240 \begin_inset space \thinspace{}
6243 g., for MiK\SpecialChar TeX
6245 \begin_inset space ~
6248 2.8 under Windows XP, this would be the folder:
6249 \begin_inset Newline newline
6255 \begin_inset Flex Code
6258 \begin_layout Plain Layout
6261 Documents and Settings
6273 \begin_inset Newline newline
6279 \begin_inset Phantom HPhantom
6282 \begin_layout Plain Layout
6293 \begin_inset Flex Code
6296 \begin_layout Plain Layout
6309 \begin_inset Newline newline
6312 On Vista, it would be:
6313 \begin_inset Newline newline
6317 \begin_inset Flex Code
6320 \begin_layout Plain Layout
6346 \begin_layout Enumerate
6347 Now one only need to tell \SpecialChar LaTeX
6348 that there are new files.
6349 This depends on the used \SpecialChar LaTeX
6351 \begin_inset Separator latexpar
6358 \begin_layout Enumerate
6359 For \SpecialChar TeX
6360 Live execute the command
6361 \begin_inset Flex Code
6364 \begin_layout Plain Layout
6371 If you installed the package for all users, then you will probably need
6372 to have root permissions for that.
6375 \begin_layout Enumerate
6376 For MiK\SpecialChar TeX
6377 , if you have installed the package for all users, start the program
6379 \begin_inset Quotes eld
6383 \begin_inset space ~
6387 \begin_inset Quotes erd
6390 and press the button marked
6391 \begin_inset Quotes eld
6395 \begin_inset Quotes erd
6399 Otherwise start the program
6400 \begin_inset Quotes eld
6404 \begin_inset Quotes erd
6411 \begin_layout Enumerate
6412 Finally, you need to tell \SpecialChar LyX
6413 that there are new packages available.
6414 So, in \SpecialChar LyX
6416 \begin_inset Flex Noun
6419 \begin_layout Plain Layout
6422 \SpecialChar menuseparator
6428 and then restart \SpecialChar LyX
6432 \begin_layout Standard
6433 Now the package is installed.
6434 In our example, the document class
6435 \begin_inset Flex Code
6438 \begin_layout Plain Layout
6440 \begin_inset space ~
6448 will now be available under
6449 \begin_inset Flex Noun
6452 \begin_layout Plain Layout
6453 Document\SpecialChar menuseparator
6454 Settings\SpecialChar menuseparator
6464 \begin_layout Standard
6465 If you would like to use a \SpecialChar LaTeX
6466 document class that is not even listed in the
6468 \begin_inset Flex Noun
6471 \begin_layout Plain Layout
6472 Document\SpecialChar menuseparator
6473 Settings\SpecialChar menuseparator
6479 , then you need to create a `layout' file for it.
6480 That is the topic of the next section.
6483 \begin_layout Section
6484 Types of layout files
6487 \begin_layout Standard
6488 This section describes the various sorts of \SpecialChar LyX
6489 files that contain layout informati
6491 These files describe various paragraph and character styles, determining
6492 how \SpecialChar LyX
6493 should display them and how they should be translated into \SpecialChar LaTeX
6495 XHTML, or whatever output format is being used.
6499 \begin_layout Standard
6500 We shall try to provide a thorough description of the process of writing
6502 However, there are so many different types of documents supported even
6503 by just \SpecialChar LaTeX
6504 that we can't hope to cover every different possibility or problem
6505 you might encounter.
6506 The \SpecialChar LyX
6507 users' list is frequented by people with lots of experience with layout
6508 design who are willing to share what they've learned, so please feel free
6509 to ask questions there.
6512 \begin_layout Standard
6513 As you prepare to write a new layout, it is extremely helpful to look at
6514 the layouts distributed with \SpecialChar LyX
6516 If you write a \SpecialChar LyX
6517 layout for a \SpecialChar LaTeX
6518 document class that might also be used by
6519 others, or write a module that might be useful to others, then you should
6520 consider posting your layout to the
6521 \begin_inset CommandInset href
6523 name "layout section on the LyX wiki"
6524 target "http://wiki.lyx.org/Layouts/Layouts"
6528 or even to the \SpecialChar LyX
6529 developers' list, so that it might be included in \SpecialChar LyX
6534 \begin_layout Plain Layout
6535 Note that \SpecialChar LyX
6536 is licensed under the General Public License, so any material
6537 that is contributed to \SpecialChar LyX
6538 must be similarly licensed.
6546 \begin_layout Subsection
6548 \begin_inset CommandInset label
6550 name "subsec:Layout-modules"
6557 \begin_layout Standard
6558 We have spoken to this point about `layout files'.
6559 But there are different sorts of files that contain layout information.
6560 Layout files, strictly so called, have the
6561 \begin_inset Flex Code
6564 \begin_layout Plain Layout
6570 extension and provide \SpecialChar LyX
6571 with information about document classes.
6572 Since \SpecialChar LyX
6573 1.6 layout information can also be contained in layout
6578 \begin_inset Flex Code
6581 \begin_layout Plain Layout
6588 Modules are to \SpecialChar LaTeX
6589 packages much as layouts are to \SpecialChar LaTeX
6590 classes, and some modules—such
6592 \begin_inset Flex Code
6595 \begin_layout Plain Layout
6601 module—specifically provide support for one package.
6602 In a sense, layout modules are similar to included
6606 \begin_layout Plain Layout
6607 These can have any extension, but by convention have the
6608 \begin_inset Flex Code
6611 \begin_layout Plain Layout
6623 \begin_inset Flex Code
6626 \begin_layout Plain Layout
6632 —in that modules are not specific to a given document class but may be used
6633 with many different classes.
6634 The difference is that using an included file with
6635 \begin_inset Flex Code
6638 \begin_layout Plain Layout
6644 requires editing that file.
6645 Modules, by contrast, are selected in the
6646 \begin_inset Flex Noun
6649 \begin_layout Plain Layout
6650 Document\SpecialChar menuseparator
6659 \begin_layout Standard
6660 Building modules is the easiest way to get started with layout editing,
6661 since it can be as simple as adding a single new paragraph style or flex
6663 But modules may, in principle, contain anything a layout file can contain.
6666 \begin_layout Standard
6667 After creating a new module and copying it to the
6668 \begin_inset Flex Code
6671 \begin_layout Plain Layout
6677 folder, you will need to reconfigure and then restart \SpecialChar LyX
6680 However, changes you make to the module will be seen immediately, if you
6682 \begin_inset Flex Noun
6685 \begin_layout Plain Layout
6686 Document\SpecialChar menuseparator
6692 , highlight something, and then hit
6693 \begin_inset Quotes eld
6697 \begin_inset Quotes erd
6703 It is strongly recommended that you save your work before doing this
6708 it is strongly recommended that you not attempt to edit modules while simultaneo
6709 usly working on actual documents
6712 Though of course the developers strive to keep \SpecialChar LyX
6713 stable in such situations,
6714 syntax errors and the like in your module file could cause strange behavior.
6717 \begin_layout Subsubsection
6721 \begin_layout Standard
6722 Modules are to \SpecialChar LyX
6723 as packages are to \SpecialChar LaTeX
6725 Sometimes, however, you find yourself wanting a specific inset or character
6726 style just for one document and writing a module that will also be available
6727 to other documents makes little sense.
6728 What you need is \SpecialChar LyX
6730 \begin_inset Quotes eld
6734 \begin_inset Quotes erd
6740 \begin_layout Standard
6741 You will find it under
6743 Document\SpecialChar menuseparator
6744 Settings\SpecialChar menuseparator
6748 The large text box allows you to enter anything that you might enter in
6749 a layout file or module.
6750 You can think of a document's local layout, in fact, as a module that belongs
6752 So, in particular, you must enter a
6753 \begin_inset Flex Code
6756 \begin_layout Plain Layout
6763 Any format is acceptable, but one would normally use the format current
6765 (In \SpecialChar LyX
6766 2.2, the current layout format is 60.)
6769 \begin_layout Standard
6770 When you have entered something in the
6771 \begin_inset Flex Code
6774 \begin_layout Plain Layout
6780 pane, \SpecialChar LyX
6782 \begin_inset Quotes eld
6786 \begin_inset Quotes erd
6789 button at the bottom.
6790 Clicking this button will cause \SpecialChar LyX
6791 to determine whether what you have entered
6792 is valid layout information for the chosen format.
6794 will report the result but, unfortunately, will not tell you what errors
6795 there might have been.
6796 These will be written to the terminal, however, if \SpecialChar LyX
6797 is started from a terminal.
6798 You will not be permitted to save your local layout until you have entered
6802 \begin_layout Standard
6803 The warnings at the end of the previous section apply here, too.
6804 Do not play with local layout while you are actually working, especially
6805 if you have not saved your document.
6806 That said, using local layout with a test document can be a very convenient
6807 way to try out layout ideas, or even to start developing a module.
6810 \begin_layout Subsection
6812 \begin_inset Flex Noun
6815 \begin_layout Plain Layout
6824 \begin_layout Standard
6825 There are two situations you are likely to encounter when wanting to support
6826 a new \SpecialChar LaTeX
6827 document class, involving style (
6828 \begin_inset Flex Code
6831 \begin_layout Plain Layout
6837 ) files and \SpecialChar LaTeX2e
6839 \begin_inset Flex Code
6842 \begin_layout Plain Layout
6849 Supporting a style file is usually fairly easy.
6850 Supporting a new class file is a bit harder.
6851 We'll discuss the former in this section and the latter in the next.
6852 Similar remarks apply, of course, if you want to support a new DocBook
6856 \begin_layout Standard
6857 The easier case is the one in which your new document class is provided
6858 as a style file that is to be used in conjunction with an already supported
6860 For the sake of the example, we'll assume that the style file is called
6862 \begin_inset Flex Noun
6865 \begin_layout Plain Layout
6871 and that it is meant to be used with
6872 \begin_inset Flex Noun
6875 \begin_layout Plain Layout
6881 , which is a standard class.
6885 \begin_layout Standard
6886 Start by copying the existing class's layout file into your local directory:
6890 \begin_layout Plain Layout
6891 Of course, which directory is your local directory will vary by platform,
6892 and \SpecialChar LyX
6893 allows you to specify your local directory on startup, too, using
6895 \begin_inset Flex Code
6898 \begin_layout Plain Layout
6912 \begin_layout LyX-Code
6913 cp report.layout ~/.lyx/layouts/myclass.layout
6916 \begin_layout Standard
6918 \begin_inset Flex Code
6921 \begin_layout Plain Layout
6927 and change the line:
6930 \begin_layout LyX-Code
6933 DeclareLaTeXClass{report}
6936 \begin_layout Standard
6940 \begin_layout LyX-Code
6943 DeclareLaTeXClass[report, myclass.sty]{report (myclass)}
6946 \begin_layout Standard
6950 \begin_layout LyX-Code
6952 \begin_inset Newline newline
6958 \begin_inset Newline newline
6964 \begin_layout Standard
6965 near the top of the file.
6968 \begin_layout Standard
6969 Start \SpecialChar LyX
6971 \begin_inset Flex Noun
6974 \begin_layout Plain Layout
6975 Tools\SpecialChar menuseparator
6982 Then restart \SpecialChar LyX
6983 and try creating a new document.
6985 \begin_inset Flex Noun
6988 \begin_layout Plain Layout
6994 " as a document class option in the
6995 \begin_inset Flex Noun
6998 \begin_layout Plain Layout
6999 Document\SpecialChar menuseparator
7006 It is likely that some of the sectioning commands and such in your new
7007 class will work differently from how they worked in the base class—
7008 \begin_inset Flex Code
7011 \begin_layout Plain Layout
7017 in this example—so you can fiddle around with the settings for the different
7018 sections if you wish.
7019 The layout information for sections is contained in
7020 \begin_inset Flex Code
7023 \begin_layout Plain Layout
7029 , but you do not need to copy and change this file.
7030 Instead, you can simply add your changes to your layout file, after the
7032 \begin_inset Flex Code
7035 \begin_layout Plain Layout
7041 , which itself includes
7042 \begin_inset Flex Code
7045 \begin_layout Plain Layout
7052 For example, you might add these lines:
7055 \begin_layout LyX-Code
7059 \begin_layout LyX-Code
7063 \begin_layout LyX-Code
7067 \begin_layout LyX-Code
7071 \begin_layout LyX-Code
7075 \begin_layout Standard
7076 to change the font for chapter headings to sans-serif.
7077 This will override (or, in this case, add to) the existing declaration
7078 for the Chapter style.
7082 \begin_layout Standard
7083 Your new package may also provide commands or environments not present in
7085 In this case, you will want to add these to the layout file.
7087 \begin_inset CommandInset ref
7089 reference "sec:TextClass"
7093 for information on how to do so.
7096 \begin_layout Standard
7098 \begin_inset Flex Noun
7101 \begin_layout Plain Layout
7107 can be used with several different document classes, and even if it cannot,
7108 you might find it easiest just to write a module that you can load with
7110 The simplest possible such module would be:
7113 \begin_layout LyX-Code
7116 DeclareLyXModule{My Package}
7119 \begin_layout LyX-Code
7123 \begin_layout LyX-Code
7124 #Support for mypkg.sty.
7127 \begin_layout LyX-Code
7129 \begin_inset Newline newline
7135 \begin_layout LyX-Code
7137 \begin_inset Newline newline
7143 \begin_layout LyX-Code
7145 \begin_inset Newline newline
7151 \begin_inset Newline newline
7157 \begin_layout Standard
7158 A more complex module might modify the behavior of some existing constructs
7159 or define some new ones.
7161 \begin_inset CommandInset ref
7163 reference "sec:TextClass"
7170 \begin_layout Subsection
7172 \begin_inset Flex Noun
7175 \begin_layout Plain Layout
7184 \begin_layout Standard
7185 There are two possibilities here.
7186 One is that the class file is itself based upon an existing document class.
7187 For example, many thesis classes are based upon
7188 \begin_inset Flex Noun
7191 \begin_layout Plain Layout
7198 To see whether yours is, look for a line like
7201 \begin_layout LyX-Code
7207 \begin_layout Standard
7209 If so, then you may proceed largely as in the previous section, though
7211 \begin_inset Flex Code
7214 \begin_layout Plain Layout
7215 Declare\SpecialChar LaTeX
7221 line will be different.
7222 If your new class is
7223 \begin_inset Flex Code
7226 \begin_layout Plain Layout
7232 and it is based upon
7233 \begin_inset Flex Code
7236 \begin_layout Plain Layout
7242 , then the line should read:
7246 \begin_layout Plain Layout
7247 And it will be easiest if you save the file to
7248 \begin_inset Flex Code
7251 \begin_layout Plain Layout
7258 assumes that the document class has the same name as the layout file.
7267 \begin_layout LyX-Code
7270 DeclareLaTeXClass[thesis,book]{thesis}
7273 \begin_layout Standard
7274 If, on the other hand, the new class is not based upon an existing class,
7275 you will probably have to
7276 \begin_inset Quotes eld
7280 \begin_inset Quotes erd
7284 We strongly suggest copying an existing layout file which uses a similar
7286 class and then modifying it, if you can do so.
7287 At least use an existing file as a starting point so you can find out what
7288 items you need to worry about.
7289 Again, the specifics are covered below.
7292 \begin_layout Subsection
7294 \begin_inset CommandInset label
7296 name "subsec:Creating-Templates"
7303 \begin_layout Standard
7304 Once you have written a layout file for a new document class, you might
7305 want to consider writing a
7310 A template acts as a kind of tutorial for your layout, showing how it might
7311 be used, though containing dummy content.
7312 You can of course look at the various templates included with \SpecialChar LyX
7316 \begin_layout Standard
7317 Templates are created just like usual documents: using \SpecialChar LyX
7319 The only difference is that usual documents contain all possible settings,
7320 including the font scheme and the paper size.
7321 Usually a user doesn't want a template to overwrite his preferred settings
7322 for such parameters.
7323 For that reason, the designer of a template should remove the corresponding
7325 \begin_inset Flex Code
7328 \begin_layout Plain Layout
7337 \begin_inset Flex Code
7340 \begin_layout Plain Layout
7348 from the template \SpecialChar LyX
7350 This can be done with any simple text-editor, for example
7351 \begin_inset Flex Code
7354 \begin_layout Plain Layout
7361 \begin_inset Flex Code
7364 \begin_layout Plain Layout
7373 \begin_layout Standard
7374 Put the edited template files you create in
7375 \begin_inset Flex Code
7378 \begin_layout Plain Layout
7384 , copy the ones you use from the global template directory in
7385 \begin_inset Flex Code
7388 \begin_layout Plain Layout
7394 to the same place, and redefine the template path in the
7395 \begin_inset Flex Noun
7398 \begin_layout Plain Layout
7399 Tools\SpecialChar menuseparator
7400 Preferences\SpecialChar menuseparator
7409 \begin_layout Standard
7410 Note, by the way, that there is a template which has a particular meaning:
7412 \begin_inset Flex Code
7415 \begin_layout Plain Layout
7422 This template is loaded every time you create a new document with
7423 \begin_inset Flex Noun
7426 \begin_layout Plain Layout
7427 File\SpecialChar menuseparator
7433 in order to provide useful defaults.
7434 To create this template from inside \SpecialChar LyX
7435 , all you have to do is to open a document
7436 with the correct settings, and use the
7437 \begin_inset Flex Noun
7440 \begin_layout Plain Layout
7441 Save as Document Defaults
7449 \begin_layout Subsection
7450 Upgrading old layout files
7453 \begin_layout Standard
7454 The format of layout files changes with each \SpecialChar LyX
7455 release, so old layout files
7456 need to be converted to the new format.
7458 reads a layout file in an older format, it automatically calls the
7460 \begin_inset Flex Code
7463 \begin_layout Plain Layout
7469 to convert it to a temporary file in current format.
7470 The original file is left untouched.
7471 If you use the layout file often, then, you may want to convert it permanently,
7472 so that \SpecialChar LyX
7473 does not have to do so itself every time.
7474 To do this, you can call the converter manually:
7477 \begin_layout Enumerate
7479 \begin_inset Flex Code
7482 \begin_layout Plain Layout
7489 \begin_inset Flex Code
7492 \begin_layout Plain Layout
7501 \begin_layout Enumerate
7503 \begin_inset Newline newline
7507 \begin_inset Flex Code
7510 \begin_layout Plain Layout
7511 python LyXDir/scripts/layout2layout.py myclass.old myclass.layout
7517 \begin_inset Newline newline
7521 \begin_inset Flex Code
7524 \begin_layout Plain Layout
7530 is the name of your \SpecialChar LyX
7534 \begin_layout Standard
7535 Note that manual conversion does not affect included files, so these will
7536 have to be converted separately.
7539 \begin_layout Section
7540 \begin_inset CommandInset label
7542 name "sec:TextClass"
7546 The layout file format
7549 \begin_layout Standard
7550 The following sections describe how layout files are structured and written.
7551 Our advice is to go slowly, save and test often.
7552 It is really not that hard, except that the multitude of options can become
7553 overwhelming, especially if you try to check out too many at once.
7554 It becomes easier if you use existing layouts of \SpecialChar LyX
7555 as examples/reference
7556 or if you modify an existing layout to your needs.
7559 \begin_layout Standard
7560 Note that all the tags used in layout files are case-insensitive.
7562 \begin_inset Flex Code
7565 \begin_layout Plain Layout
7572 \begin_inset Flex Code
7575 \begin_layout Plain Layout
7582 \begin_inset Flex Code
7585 \begin_layout Plain Layout
7591 are really the same tag.
7592 The possible arguments are printed in brackets after the tag's name.
7593 The default argument is typeset
7594 \begin_inset Flex Code
7597 \begin_layout Plain Layout
7606 If the argument has a data type like
7607 \begin_inset Quotes eld
7611 \begin_inset Quotes erd
7615 \begin_inset Quotes eld
7619 \begin_inset Quotes erd
7622 , the default is shown like this:
7623 \begin_inset Flex Code
7626 \begin_layout Plain Layout
7637 \begin_layout Subsection
7638 The document class declaration and classification
7641 \begin_layout Standard
7642 Lines in a layout file which begin with
7643 \begin_inset Flex Code
7646 \begin_layout Plain Layout
7653 There is one exception to this rule.
7655 \begin_inset Flex Code
7658 \begin_layout Plain Layout
7664 files should begin with lines like:
7667 \begin_layout LyX-Code
7670 #% Do not delete the line below; configure depends on this
7673 \begin_layout LyX-Code
7678 DeclareLaTeXClass{Article (Standard Class)}
7681 \begin_layout LyX-Code
7686 DeclareCategory{Articles}
7689 \begin_layout Standard
7690 The second and third lines are used when you (re)configure \SpecialChar LyX
7692 The layout file is read by the \SpecialChar LaTeX
7694 \begin_inset Flex Code
7697 \begin_layout Plain Layout
7703 , in a special mode where
7704 \begin_inset Flex Code
7707 \begin_layout Plain Layout
7714 The first line is just a \SpecialChar LaTeX
7715 comment, the second one contains the mandatory
7716 declaration of the text class and the third line contains the optional
7717 classification of the class.
7718 If these lines appear in a file named
7719 \begin_inset Flex Code
7722 \begin_layout Plain Layout
7728 , then they define a text class of name
7729 \begin_inset Flex Code
7732 \begin_layout Plain Layout
7738 (the name of the layout file) which uses the \SpecialChar LaTeX
7740 \begin_inset Flex Code
7743 \begin_layout Plain Layout
7749 (the default is to use the same name as the layout).
7751 \begin_inset Quotes eld
7754 Article (Standard Class)
7755 \begin_inset Quotes erd
7758 that appears above is used as a description of the text class in the
7759 \begin_inset Flex Noun
7762 \begin_layout Plain Layout
7763 Document\SpecialChar menuseparator
7771 \begin_inset Quotes eld
7775 \begin_inset Quotes erd
7778 in the example) is also used in the
7779 \begin_inset Flex Noun
7782 \begin_layout Plain Layout
7783 Document\SpecialChar menuseparator
7789 dialog: the text classes are grouped by these categories (which are usually
7790 genres, so typical categories are
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 \begin_inset Quotes eld
7835 \begin_inset Quotes erd
7839 If no category has been declared, the class will be put in the
7840 \begin_inset Quotes eld
7844 \begin_inset Quotes erd
7850 \begin_layout Standard
7851 Let's assume that you wrote your own text class that uses the
7852 \begin_inset Flex Code
7855 \begin_layout Plain Layout
7861 document class, but where you changed the appearance of the section headings.
7862 If you put it in a file
7863 \begin_inset Flex Code
7866 \begin_layout Plain Layout
7872 , the header of this file should be:
7875 \begin_layout LyX-Code
7878 #% Do not delete the line below; configure depends on this
7881 \begin_layout LyX-Code
7886 DeclareLaTeXClass[article]{Article (with My Own Headings)}
7889 \begin_layout LyX-Code
7894 DeclareCategory{Articles}
7897 \begin_layout Standard
7898 This declares a text class
7899 \begin_inset Flex Code
7902 \begin_layout Plain Layout
7908 , associated with the \SpecialChar LaTeX
7910 \begin_inset Flex Code
7913 \begin_layout Plain Layout
7920 \begin_inset Quotes eld
7923 Article (with My Own Headings)
7924 \begin_inset Quotes erd
7928 If your text class depends on several packages, you can declare it as:
7931 \begin_layout LyX-Code
7934 #% Do not delete the line below; configure depends on this
7937 \begin_layout LyX-Code
7942 DeclareLaTeXClass[article,foo.sty]{Article (with My Own Headings)}
7945 \begin_layout LyX-Code
7950 DeclareCategory{Articles}
7953 \begin_layout Standard
7954 This indicates that your text class uses the
7955 \begin_inset Flex Code
7958 \begin_layout Plain Layout
7965 Finally, it is also possible to declare classes for DocBook code.
7966 Typical declarations will look like:
7969 \begin_layout LyX-Code
7972 #% Do not delete the line below; configure depends on this
7975 \begin_layout LyX-Code
7980 DeclareDocBookClass[article]{SGML (DocBook Article)}
7983 \begin_layout LyX-Code
7988 DeclareCategory{Articles (DocBook)}
7991 \begin_layout Standard
7992 Note that these declarations can also be given an optional parameter declaring
7993 the name of the document class (but not a list).
7996 \begin_layout Standard
7997 So, to be as explicit as possible, the form of the layout declaration is:
8000 \begin_layout LyX-Code
8005 DeclareLaTeXClass[class,package.sty]{layout description}
8008 \begin_layout LyX-Code
8013 DeclareCategory{category}
8016 \begin_layout Standard
8017 The class need only be specified if the name of the \SpecialChar LaTeX
8019 name of the layout file are different or if there are packages to load.
8020 If the name of the class file is not specified, then \SpecialChar LyX
8022 that it is the same as the name of the layout file.
8025 \begin_layout Standard
8026 When the text class has been modified to your taste, all you have to do
8027 is to copy it either to
8028 \begin_inset Flex Code
8031 \begin_layout Plain Layout
8038 \begin_inset Flex Code
8041 \begin_layout Plain Layout
8048 \begin_inset Flex Noun
8051 \begin_layout Plain Layout
8052 Tools\SpecialChar menuseparator
8058 , exit \SpecialChar LyX
8060 Then your new text class should be available along with the others.
8063 \begin_layout Standard
8064 Once the layout file is installed, you can edit it and see your changes
8065 without having to reconfigure or to restart \SpecialChar LyX
8071 \begin_layout Plain Layout
8072 In versions of \SpecialChar LyX
8073 prior to 1.6, this was not true.
8074 As a result, editing layout files was very time consuming, since you had
8075 constantly to restart \SpecialChar LyX
8081 You can force a reload of the current layout by using the \SpecialChar LyX
8083 \begin_inset Flex Noun
8086 \begin_layout Plain Layout
8093 There is no default binding for this function—though, of course, you can
8094 bind it to a key yourself.
8095 But you will normally use this function simply by entering it in the mini-buffe
8100 \begin_layout Standard
8106 \begin_inset Flex Noun
8109 \begin_layout Plain Layout
8115 is very much an `advanced feature'.
8120 recommended that you save your work before using this function.
8125 recommended that you not attempt to edit layout information while simultaneousl
8126 y working on a document that you care about.
8127 Use a test document.
8128 Syntax errors and the like in your layout file could cause peculiar behavior.
8129 In particular, such errors could cause \SpecialChar LyX
8130 to regard the current layout as
8131 invalid and to attempt to switch to some other layout.
8135 \begin_layout Plain Layout
8136 Really bad syntax errors may even caused \SpecialChar LyX
8138 This is because certain sorts of errors may make \SpecialChar LyX
8149 The \SpecialChar LyX
8150 team strives to keep \SpecialChar LyX
8151 stable in such situations, but safe is better
8156 \begin_layout Plain Layout
8157 While we're giving advice: make regular backups.
8158 And be nice to your mother.
8166 \begin_layout Subsection
8167 The Module declaration
8170 \begin_layout Standard
8171 A module must begin with a line like the following:
8174 \begin_layout LyX-Code
8177 DeclareLyXModule[endnotes.sty]{Endnotes}
8180 \begin_layout Standard
8181 The mandatory argument, in curly brackets, is the name of the module, as
8183 \begin_inset Flex Noun
8186 \begin_layout Plain Layout
8187 Document\SpecialChar menuseparator
8188 Settings\SpecialChar menuseparator
8195 The argument in square brackets is optional: It declares any \SpecialChar LaTeX
8197 on which the module depends.
8198 It is also possible to use the form
8199 \begin_inset Flex Noun
8202 \begin_layout Plain Layout
8208 as an optional argument, which declares that the module can only be used
8209 when there exists a conversion chain between the formats `
8210 \begin_inset Flex Code
8213 \begin_layout Plain Layout
8220 \begin_inset Flex Code
8223 \begin_layout Plain Layout
8232 \begin_layout Standard
8233 The module declaration should then be followed by lines like the following
8237 \begin_layout Plain Layout
8238 Preferably in English if the module should be published with \SpecialChar LyX
8240 This description will appear in the list of messages to be translated and
8241 will be thus translated with the next interface update.
8249 \begin_layout LyX-Code
8253 \begin_layout LyX-Code
8254 #Adds an endnote command, in addition to footnotes.
8258 \begin_layout LyX-Code
8259 #You will need to add
8261 theendnotes in TeX code where you
8264 \begin_layout LyX-Code
8265 #want the endnotes to appear.
8269 \begin_layout LyX-Code
8273 \begin_layout LyX-Code
8274 #Requires: somemodule | othermodule
8277 \begin_layout LyX-Code
8278 #Excludes: badmodule
8281 \begin_layout Standard
8282 The description is used in
8283 \begin_inset Flex Noun
8286 \begin_layout Plain Layout
8287 Document\SpecialChar menuseparator
8288 Settings\SpecialChar menuseparator
8294 to provide the user with information about what the module does.
8296 \begin_inset Flex Code
8299 \begin_layout Plain Layout
8305 line is used to identify other modules with which this one must be used;
8307 \begin_inset Flex Code
8310 \begin_layout Plain Layout
8316 line is used to identify modules with which this one may not be used.
8317 Both are optional, and, as shown, multiple modules should be separated
8318 with the pipe symbol: |.
8319 Note that the required modules are treated disjunctively:
8323 of the required modules must be used.
8328 excluded module may be used.
8329 Note that modules are identified here by their filenames without the
8330 \begin_inset Flex Code
8333 \begin_layout Plain Layout
8341 \begin_inset Flex Code
8344 \begin_layout Plain Layout
8351 \begin_inset Flex Code
8354 \begin_layout Plain Layout
8363 \begin_layout Subsection
8367 \begin_layout Standard
8368 The first non-comment line of any layout file, included file, or module
8373 contain the file format number:
8376 \begin_layout Description
8377 \begin_inset Flex Code
8380 \begin_layout Plain Layout
8387 \begin_inset Flex Code
8390 \begin_layout Plain Layout
8396 ] The format number of the layout file.
8399 \begin_layout Standard
8400 This tag was introduced with \SpecialChar LyX
8402 \begin_inset space ~
8406 Layout files from older \SpecialChar LyX
8407 versions do not have an explicit file format and
8408 are considered to have
8409 \begin_inset Flex Code
8412 \begin_layout Plain Layout
8414 \begin_inset space ~
8423 The format for the present version of \SpecialChar LyX
8425 But each version of \SpecialChar LyX
8426 is capable of reading earlier versions' layout files,
8427 just as they are capable of reading files produced by earlier versions
8430 There is, however, no provision for converting to earlier formats.
8433 \begin_layout Subsection
8434 \begin_inset CommandInset label
8436 name "subsec:General-text-class"
8440 General text class parameters
8443 \begin_layout Standard
8444 These are general parameters that govern the behavior of an entire document
8450 mean that they must appear in
8451 \begin_inset Flex Code
8454 \begin_layout Plain Layout
8460 files rather than in modules.
8461 A module can contain any layout tag.)
8464 \begin_layout Description
8465 \begin_inset Flex Code
8468 \begin_layout Plain Layout
8474 Adds information that will be output in the
8475 \begin_inset Flex Code
8478 \begin_layout Plain Layout
8484 block when the document is output to XHTML.
8485 Typically, this would be used to output CSS style information, but it can
8486 be used for anything that can appear in
8487 \begin_inset Flex Code
8490 \begin_layout Plain Layout
8498 \begin_inset Quotes eld
8502 \begin_inset Flex Code
8505 \begin_layout Plain Layout
8512 \begin_inset Quotes erd
8518 \begin_layout Description
8519 \begin_inset Flex Code
8522 \begin_layout Plain Layout
8528 Adds information to the document preamble.
8530 \begin_inset Newline newline
8534 \begin_inset Quotes eld
8538 \begin_inset Flex Code
8541 \begin_layout Plain Layout
8548 \begin_inset Quotes erd
8554 \begin_layout Description
8555 \begin_inset Flex Code
8558 \begin_layout Plain Layout
8564 Defines formats for use in the display of bibliographic information.
8566 \begin_inset CommandInset ref
8568 reference "subsec:Citation-format-description"
8574 \begin_inset Quotes eld
8578 \begin_inset Flex Code
8581 \begin_layout Plain Layout
8588 \begin_inset Quotes erd
8594 \begin_layout Description
8595 \begin_inset Flex Code
8598 \begin_layout Plain Layout
8604 Describes various global options supported by the document class.
8606 \begin_inset CommandInset ref
8608 reference "subsec:ClassOptions"
8614 \begin_inset Quotes eld
8618 \begin_inset Flex Code
8621 \begin_layout Plain Layout
8628 \begin_inset Quotes erd
8634 \begin_layout Description
8635 \begin_inset Flex Code
8638 \begin_layout Plain Layout
8645 \begin_inset Flex Code
8648 \begin_layout Plain Layout
8657 \begin_inset space \thinspace{}
8661 \begin_inset Flex Code
8664 \begin_layout Plain Layout
8670 ] Whether the class should
8674 to having one or two columns.
8675 Can be changed in the
8676 \begin_inset Flex Noun
8679 \begin_layout Plain Layout
8680 Document\SpecialChar menuseparator
8689 \begin_layout Description
8690 \begin_inset Flex Code
8693 \begin_layout Plain Layout
8700 \begin_inset Flex Code
8703 \begin_layout Plain Layout
8709 ] This sequence defines the properties for a counter.
8710 If the counter does not yet exist, it is created; if it does exist, it
8713 \begin_inset Quotes eld
8717 \begin_inset Flex Code
8720 \begin_layout Plain Layout
8727 \begin_inset Quotes erd
8731 \begin_inset Newline newline
8735 \begin_inset CommandInset ref
8737 reference "subsec:Counters"
8741 for details on counters.
8744 \begin_layout Description
8745 \begin_inset Flex Code
8748 \begin_layout Plain Layout
8754 Sets the default font used to display the document.
8756 \begin_inset CommandInset ref
8758 reference "subsec:Font-description"
8762 for how to declare fonts.
8764 \begin_inset Quotes eld
8768 \begin_inset Flex Code
8771 \begin_layout Plain Layout
8778 \begin_inset Quotes erd
8784 \begin_layout Description
8785 \begin_inset Flex Code
8788 \begin_layout Plain Layout
8795 \begin_inset Flex Code
8798 \begin_layout Plain Layout
8804 ] Specifies a module to be included by default with this document class.
8805 The module is specified as filename without the
8806 \begin_inset Flex Code
8809 \begin_layout Plain Layout
8816 The user can still remove the module, but it will be active at the outset.
8817 (This applies only when new files are created, or when this class is chosen
8818 for an existing document.)
8821 \begin_layout Description
8822 \begin_inset Flex Code
8825 \begin_layout Plain Layout
8832 \begin_inset Flex Code
8835 \begin_layout Plain Layout
8841 ] This is the style that will be assigned to new paragraphs, usually
8842 \begin_inset Flex Noun
8845 \begin_layout Plain Layout
8852 This will default to the first defined style if not given, but you are
8853 encouraged to use this directive.
8856 \begin_layout Description
8857 \begin_inset Flex Code
8860 \begin_layout Plain Layout
8867 \begin_inset Flex Code
8870 \begin_layout Plain Layout
8876 ] This tag indicates that the module (which is specified by filename without
8878 \begin_inset Flex Code
8881 \begin_layout Plain Layout
8887 extension) cannot be used with this document class.
8888 This might be used in a journal-specific layout file to prevent, say, the
8890 \begin_inset Flex Code
8893 \begin_layout Plain Layout
8899 module that numbers theorems by section.
8904 be used in a module.
8905 Modules have their own way of excluding other modules (see
8906 \begin_inset CommandInset ref
8908 reference "subsec:Layout-modules"
8915 \begin_layout Description
8916 \begin_inset Flex Code
8919 \begin_layout Plain Layout
8925 Defines a new float.
8927 \begin_inset CommandInset ref
8929 reference "subsec:Floats"
8935 \begin_inset Quotes eld
8939 \begin_inset Flex Code
8942 \begin_layout Plain Layout
8949 \begin_inset Quotes erd
8955 \begin_layout Description
8956 \begin_inset Flex Code
8959 \begin_layout Plain Layout
8965 Sets the information that will be output in the
8966 \begin_inset Flex Code
8969 \begin_layout Plain Layout
8975 block when this document class is output to XHTML.
8976 Note that this will completely override any prior
8977 \begin_inset Flex Code
8980 \begin_layout Plain Layout
8987 \begin_inset Flex Code
8990 \begin_layout Plain Layout
8998 \begin_inset Newline newline
9002 \begin_inset Flex Code
9005 \begin_layout Plain Layout
9011 if you just want to add material to the preamble.) Must end with
9012 \begin_inset Quotes eld
9016 \begin_inset Flex Code
9019 \begin_layout Plain Layout
9026 \begin_inset Quotes erd
9032 \begin_layout Description
9033 \begin_inset Flex Code
9036 \begin_layout Plain Layout
9043 \begin_inset Flex Code
9046 \begin_layout Plain Layout
9052 ] The style to use for the table of contents, bibliography, and so forth,
9053 when the document is output to HTML.
9054 For articles, this should normally be
9055 \begin_inset Flex Code
9058 \begin_layout Plain Layout
9065 \begin_inset Flex Code
9068 \begin_layout Plain Layout
9075 If it is not given, then \SpecialChar LyX
9076 will attempt to figure out which layout to use.
9079 \begin_layout Description
9080 \begin_inset Flex Code
9083 \begin_layout Plain Layout
9090 \begin_inset Flex Code
9093 \begin_layout Plain Layout
9099 ] Modifies the properties of the given counter.
9100 If the counter does not exist, the statement is ignored.
9102 \begin_inset Quotes eld
9106 \begin_inset Flex Code
9109 \begin_layout Plain Layout
9116 \begin_inset Quotes erd
9120 \begin_inset Newline newline
9124 \begin_inset CommandInset ref
9126 reference "subsec:Counters"
9130 for details on counters.
9133 \begin_layout Description
9134 \begin_inset Flex Code
9137 \begin_layout Plain Layout
9144 \begin_inset Flex Code
9147 \begin_layout Plain Layout
9153 ] This allows you to include another layout definition file within yours
9154 to avoid duplicating commands.
9155 Common examples are the standard layout files, for example,
9156 \begin_inset Flex Code
9159 \begin_layout Plain Layout
9165 , which contains most of the basic layouts.
9168 \begin_layout Description
9169 \begin_inset Flex Code
9172 \begin_layout Plain Layout
9179 \begin_inset Flex Code
9182 \begin_layout Plain Layout
9188 ] This section (re-)defines the layout of an inset.
9189 It can be applied to an existing inset or to a new, user-defined inset,
9190 e.g., a new character style.
9192 \begin_inset Quotes eld
9196 \begin_inset Flex Code
9199 \begin_layout Plain Layout
9206 \begin_inset Quotes erd
9210 \begin_inset Newline newline
9214 \begin_inset CommandInset ref
9216 reference "subsec:Flex-insets-and"
9220 for more information.
9224 \begin_layout Description
9225 \begin_inset Flex Code
9228 \begin_layout Plain Layout
9235 \begin_inset Flex Code
9238 \begin_layout Plain Layout
9244 ] A string that indicates the width of the left margin on the screen, for
9246 \begin_inset Quotes eld
9250 \begin_inset Flex Code
9253 \begin_layout Plain Layout
9260 \begin_inset Quotes erd
9264 (Note that this is not a `length', like
9265 \begin_inset Quotes eld
9269 \begin_inset Quotes erd
9275 \begin_layout Description
9276 \begin_inset Flex Code
9279 \begin_layout Plain Layout
9286 \begin_inset Flex Code
9289 \begin_layout Plain Layout
9295 ] Modifies the properties of the given paragraph style.
9296 If the style does not exist, this section is ignored.
9298 \begin_inset Quotes eld
9302 \begin_inset Flex Code
9305 \begin_layout Plain Layout
9312 \begin_inset Quotes erd
9318 \begin_layout Description
9319 \begin_inset Flex Code
9322 \begin_layout Plain Layout
9329 \begin_inset Flex Code
9332 \begin_layout Plain Layout
9338 ] Deletes an existing counter, usually one defined in an included file.
9341 \begin_layout Description
9342 \begin_inset Flex Code
9345 \begin_layout Plain Layout
9352 \begin_inset Flex Code
9355 \begin_layout Plain Layout
9361 ] Deletes an existing float.
9362 This is particularly useful when you want to suppress a float that has
9363 been defined in an input file.
9366 \begin_layout Description
9367 \begin_inset Flex Code
9370 \begin_layout Plain Layout
9377 \begin_inset Flex Code
9380 \begin_layout Plain Layout
9386 ] Deletes an existing style.
9389 \begin_layout Description
9390 \begin_inset Flex Code
9393 \begin_layout Plain Layout
9400 \begin_inset Flex Code
9403 \begin_layout Plain Layout
9409 ] The file format (as defined in the \SpecialChar LyX
9410 preferences) produced by this document
9412 It is mainly useful when
9413 \begin_inset Flex Code
9416 \begin_layout Plain Layout
9423 \begin_inset Flex Code
9426 \begin_layout Plain Layout
9432 and one wants to define a new type of literate document.
9433 The format is reset to
9434 \begin_inset Quotes eld
9438 \begin_inset Flex Code
9441 \begin_layout Plain Layout
9448 \begin_inset Quotes erd
9452 \begin_inset Quotes eld
9456 \begin_inset Flex Code
9459 \begin_layout Plain Layout
9466 \begin_inset Quotes erd
9469 when the corresponding
9470 \begin_inset Flex Code
9473 \begin_layout Plain Layout
9479 parameter is encountered.
9482 \begin_layout Description
9483 \begin_inset Flex Code
9486 \begin_layout Plain Layout
9493 \begin_inset Flex Code
9496 \begin_layout Plain Layout
9507 \begin_inset Flex Code
9510 \begin_layout Plain Layout
9517 \begin_inset Flex Code
9520 \begin_layout Plain Layout
9526 ] Specifies what sort of output documents using this class will produce.
9529 \begin_layout Description
9530 \begin_inset Flex Code
9533 \begin_layout Plain Layout
9540 \begin_inset Flex Code
9543 \begin_layout Plain Layout
9550 \begin_inset Flex Code
9553 \begin_layout Plain Layout
9559 ] Specifies options, given in the second string, for the package named by
9562 \begin_inset Quotes eld
9566 \begin_inset Flex Code
9569 \begin_layout Plain Layout
9570 PackageOptions natbib square
9576 \begin_inset Quotes erd
9580 \begin_inset Flex Code
9583 \begin_layout Plain Layout
9589 to be loaded with the
9590 \begin_inset Flex Code
9593 \begin_layout Plain Layout
9600 (For \SpecialChar TeX
9601 perts, this causes \SpecialChar LyX
9603 \begin_inset Flex Code
9606 \begin_layout Plain Layout
9609 PassOptionsToPackage{natbib}{square}
9615 \begin_inset Flex Code
9618 \begin_layout Plain Layout
9627 \begin_layout Description
9628 \begin_inset Flex Code
9631 \begin_layout Plain Layout
9638 \begin_inset Flex Code
9641 \begin_layout Plain Layout
9650 \begin_inset Flex Code
9653 \begin_layout Plain Layout
9660 \begin_inset Flex Code
9663 \begin_layout Plain Layout
9669 ] The default pagestyle.
9670 Can be changed in the
9671 \begin_inset Flex Noun
9674 \begin_layout Plain Layout
9675 Document\SpecialChar menuseparator
9684 \begin_layout Description
9685 \begin_inset Flex Code
9688 \begin_layout Plain Layout
9694 Sets the preamble for the \SpecialChar LaTeX
9696 Note that this will completely override any prior
9697 \begin_inset Flex Code
9700 \begin_layout Plain Layout
9707 \begin_inset Flex Code
9710 \begin_layout Plain Layout
9718 \begin_inset Flex Code
9721 \begin_layout Plain Layout
9727 if you just want to add material to the preamble.) Must end with
9728 \begin_inset Quotes eld
9732 \begin_inset Flex Code
9735 \begin_layout Plain Layout
9742 \begin_inset Quotes erd
9748 \begin_layout Description
9749 \begin_inset Flex Code
9752 \begin_layout Plain Layout
9759 \begin_inset Flex Code
9762 \begin_layout Plain Layout
9769 \begin_inset Flex Code
9772 \begin_layout Plain Layout
9781 \begin_inset space \thinspace{}
9785 \begin_inset Flex Code
9788 \begin_layout Plain Layout
9794 ] Whether the class already provides the feature
9795 \begin_inset Flex Code
9798 \begin_layout Plain Layout
9805 A feature is in general the name of a package (e.
9806 \begin_inset space \thinspace{}
9810 \begin_inset space \space{}
9814 \begin_inset Flex Code
9817 \begin_layout Plain Layout
9824 \begin_inset Flex Code
9827 \begin_layout Plain Layout
9834 \begin_inset space \thinspace{}
9838 \begin_inset space \space{}
9842 \begin_inset Flex Code
9845 \begin_layout Plain Layout
9852 \begin_inset Flex Code
9855 \begin_layout Plain Layout
9863 \begin_inset CommandInset ref
9865 reference "chap:List-of-functions"
9869 for the list of features.
9872 \begin_layout Description
9873 \begin_inset Flex Code
9876 \begin_layout Plain Layout
9883 \begin_inset Flex Code
9886 \begin_layout Plain Layout
9892 ] Indicates that this layout provides the functionality of the module mentioned,
9893 which should be specified by the filename without the
9894 \begin_inset Flex Code
9897 \begin_layout Plain Layout
9904 This will typically be used if the layout includes the module directly,
9905 rather than using the
9906 \begin_inset Flex Code
9909 \begin_layout Plain Layout
9915 tag to indicate that it ought to be used.
9916 It could also be used in a module that provided an alternate implementation
9917 of the same functionality.
9920 \begin_layout Description
9921 \begin_inset Flex Code
9924 \begin_layout Plain Layout
9931 \begin_inset Flex Code
9934 \begin_layout Plain Layout
9940 ] Creates a new paragraph style if it does not already exist.
9941 If the style does exist, this section is ignored.
9943 \begin_inset Quotes eld
9947 \begin_inset Flex Code
9950 \begin_layout Plain Layout
9957 \begin_inset Quotes erd
9963 \begin_layout Description
9964 \begin_inset Flex Code
9967 \begin_layout Plain Layout
9974 \begin_inset Flex Code
9977 \begin_layout Plain Layout
9983 ] Whether the class requires the feature
9984 \begin_inset Flex Code
9987 \begin_layout Plain Layout
9994 Multiple features must be separated by commas.
9995 Note that you can only request supported features.
9997 \begin_inset CommandInset ref
9999 reference "chap:List-of-functions"
10003 for the list of features.).
10004 If you require a package with specific options, you can additionally use
10006 \begin_inset Flex Code
10009 \begin_layout Plain Layout
10018 \begin_layout Description
10019 \begin_inset Flex Code
10022 \begin_layout Plain Layout
10029 \begin_inset Flex Code
10032 \begin_layout Plain Layout
10038 ] A string that indicates the width of the right margin on the screen, for
10040 \begin_inset Quotes eld
10044 \begin_inset Flex Code
10047 \begin_layout Plain Layout
10054 \begin_inset Quotes erd
10060 \begin_layout Description
10061 \begin_inset Flex Code
10064 \begin_layout Plain Layout
10071 \begin_inset Flex Code
10074 \begin_layout Plain Layout
10080 ] Sets which divisions get numbered.
10082 \begin_inset Newline newline
10086 \begin_inset Flex Code
10089 \begin_layout Plain Layout
10095 counter in \SpecialChar LaTeX
10099 \begin_layout Description
10100 \begin_inset Flex Code
10103 \begin_layout Plain Layout
10110 \begin_inset Flex Code
10113 \begin_layout Plain Layout
10122 \begin_inset space \thinspace{}
10126 \begin_inset Flex Code
10129 \begin_layout Plain Layout
10135 ] Whether the class-default should be printing on one or both sides of the
10137 Can be changed in the
10138 \begin_inset Flex Noun
10141 \begin_layout Plain Layout
10142 Document\SpecialChar menuseparator
10151 \begin_layout Description
10152 \begin_inset Flex Code
10155 \begin_layout Plain Layout
10162 \begin_inset Flex Code
10165 \begin_layout Plain Layout
10171 ] This sequence defines a paragraph style.
10172 If the style does not yet exist, it is created; if it does exist, its parameter
10175 \begin_inset Quotes eld
10179 \begin_inset Flex Code
10182 \begin_layout Plain Layout
10189 \begin_inset Quotes erd
10193 \begin_inset Newline newline
10197 \begin_inset CommandInset ref
10199 reference "subsec:Paragraph-Styles"
10203 for details on paragraph styles.
10206 \begin_layout Description
10207 \begin_inset Flex Code
10210 \begin_layout Plain Layout
10217 \begin_inset Flex Code
10220 \begin_layout Plain Layout
10226 ] The name of the command or environment to be used with
10227 \begin_inset Flex Code
10230 \begin_layout Plain Layout
10239 \begin_layout Description
10240 \begin_inset Flex Code
10243 \begin_layout Plain Layout
10250 \begin_inset Flex Code
10253 \begin_layout Plain Layout
10262 \begin_inset Flex Code
10265 \begin_layout Plain Layout
10271 ] Indicates what kind of markup is used to define the title of a document.
10273 \begin_inset Flex Code
10276 \begin_layout Plain Layout
10282 means that the macro with name
10283 \begin_inset Flex Code
10286 \begin_layout Plain Layout
10292 will be inserted after the last layout which has
10293 \begin_inset Quotes eld
10297 \begin_inset Flex Code
10300 \begin_layout Plain Layout
10302 \begin_inset space ~
10311 \begin_inset Quotes erd
10316 \begin_inset Flex Code
10319 \begin_layout Plain Layout
10325 corresponds to the case where all layouts which have
10326 \begin_inset Quotes eld
10330 \begin_inset Flex Code
10333 \begin_layout Plain Layout
10335 \begin_inset space ~
10344 \begin_inset Quotes erd
10347 should be enclosed into the
10348 \begin_inset Flex Code
10351 \begin_layout Plain Layout
10360 \begin_layout Description
10361 \begin_inset Flex Code
10364 \begin_layout Plain Layout
10371 \begin_inset Flex Code
10374 \begin_layout Plain Layout
10380 ] Sets which divisions are included in the table of contents.
10382 \begin_inset Flex Code
10385 \begin_layout Plain Layout
10391 counter in \SpecialChar LaTeX
10395 \begin_layout Subsection
10396 \begin_inset Flex Code
10399 \begin_layout Plain Layout
10406 \begin_inset CommandInset label
10408 name "subsec:ClassOptions"
10415 \begin_layout Standard
10417 \begin_inset Flex Code
10420 \begin_layout Plain Layout
10426 section can contain the following entries:
10429 \begin_layout Description
10430 \begin_inset Flex Code
10433 \begin_layout Plain Layout
10440 \begin_inset Flex Code
10443 \begin_layout Plain Layout
10449 ] The list of available font sizes for the document's main font, separated
10451 \begin_inset Quotes eld
10455 \begin_inset Flex Code
10458 \begin_layout Plain Layout
10465 \begin_inset Quotes erd
10471 \begin_layout Description
10472 \begin_inset Flex Code
10475 \begin_layout Plain Layout
10481 Used to set the DTD line with XML-based output classes.
10483 \begin_inset space \thinspace{}
10487 \begin_inset Quotes eld
10490 -//OASIS//DTD DocBook V4.2//EN
10491 \begin_inset Quotes erd
10497 \begin_layout Description
10498 \begin_inset Flex Code
10501 \begin_layout Plain Layout
10508 \begin_inset Flex Code
10511 \begin_layout Plain Layout
10512 string="empty|plain|headings|fancy"
10517 ] The list of available page sty\SpecialChar softhyphen
10519 \begin_inset Quotes eld
10523 \begin_inset Flex Code
10526 \begin_layout Plain Layout
10533 \begin_inset Quotes erd
10539 \begin_layout Description
10540 \begin_inset Flex Code
10543 \begin_layout Plain Layout
10550 \begin_inset Flex Code
10553 \begin_layout Plain Layout
10559 ] Some document class options, separated by a comma, that will be added
10560 to the optional part of the
10561 \begin_inset Flex Code
10564 \begin_layout Plain Layout
10575 \begin_layout Standard
10577 \begin_inset Flex Code
10580 \begin_layout Plain Layout
10586 section must end with
10587 \begin_inset Quotes eld
10591 \begin_inset Flex Code
10594 \begin_layout Plain Layout
10601 \begin_inset Quotes erd
10607 \begin_layout Subsection
10609 \begin_inset CommandInset label
10611 name "subsec:Paragraph-Styles"
10618 \begin_layout Standard
10619 A paragraph style description looks like this:
10623 \begin_layout Plain Layout
10624 Note that this will either define a new style or modify an existing one.
10632 \begin_layout LyX-Code
10639 \begin_layout LyX-Code
10643 \begin_layout LyX-Code
10647 \begin_layout Standard
10648 where the following commands are allowed:
10651 \begin_layout Description
10652 \begin_inset Flex Code
10655 \begin_layout Plain Layout
10662 \begin_inset Flex Code
10665 \begin_layout Plain Layout
10670 , left, right, center
10675 ] Paragraph alignment.
10678 \begin_layout Description
10679 \begin_inset Flex Code
10682 \begin_layout Plain Layout
10689 \begin_inset Flex Code
10692 \begin_layout Plain Layout
10697 , left, right, center
10702 ] A comma separated list of permitted alignments.
10703 (Some \SpecialChar LaTeX
10704 styles prohibit certain alignments, since those wouldn't make sense.
10705 For example a right-aligned or centered enumeration isn't possible.)
10708 \begin_layout Description
10709 \begin_inset Flex Code
10712 \begin_layout Plain Layout
10719 \begin_inset Flex Code
10722 \begin_layout Plain Layout
10728 ] Defines argument number <int> of a command\SpecialChar breakableslash
10729 environment associated with
10731 This is useful for things like section headings, and only makes sense with
10734 Every (optional or required) argument of a command or environment – except
10735 for the required argument that is associated with the content of the paragraph
10736 itself – has a separate definition, where the number specifies the order
10738 The definition must end with
10739 \begin_inset Flex Code
10742 \begin_layout Plain Layout
10749 So a command with two optional arguments has:
10750 \begin_inset Separator latexpar
10757 \begin_layout Quote
10763 \begin_layout Quote
10769 \begin_layout Quote
10775 \begin_layout Quote
10781 \begin_layout Quote
10787 \begin_layout Quote
10793 \begin_layout Standard
10795 \begin_inset Flex Code
10798 \begin_layout Plain Layout
10804 definition, the following specifications are possible:
10807 \begin_layout Itemize
10808 \begin_inset Flex Code
10811 \begin_layout Plain Layout
10818 \begin_inset Flex Code
10821 \begin_layout Plain Layout
10827 The string that will appear both in the menu (to insert this argument)
10828 and on the argument inset button (unless you also specify a separate
10829 \begin_inset Flex Code
10832 \begin_layout Plain Layout
10839 For the menu, you can define an accelerator by appending the respective
10840 character to the string, divided by
10841 \begin_inset Quotes eld
10845 \begin_inset Quotes erd
10849 \begin_inset space \thinspace{}
10853 \begin_inset space \space{}
10857 \begin_inset Quotes eld
10861 \begin_inset Flex Code
10864 \begin_layout Plain Layout
10871 \begin_inset Quotes erd
10877 \begin_layout Itemize
10878 \begin_inset Flex Code
10881 \begin_layout Plain Layout
10888 \begin_inset Flex Code
10891 \begin_layout Plain Layout
10897 A separate string for the menu.
10898 You can define an accelerator by appending the respective character to
10899 the string, divided by
10900 \begin_inset Quotes eld
10904 \begin_inset Quotes erd
10908 \begin_inset space \thinspace{}
10912 \begin_inset space \space{}
10916 \begin_inset Quotes eld
10920 \begin_inset Flex Code
10923 \begin_layout Plain Layout
10930 \begin_inset Quotes erd
10934 This specification is optional.
10935 If it is not given the
10936 \begin_inset Flex Code
10939 \begin_layout Plain Layout
10945 will be used instead for the menu.
10948 \begin_layout Itemize
10949 \begin_inset Flex Code
10952 \begin_layout Plain Layout
10959 \begin_inset Flex Code
10962 \begin_layout Plain Layout
10968 A longer explanatory text that appears in the tooltip when hovering over
10969 the argument inset.
10972 \begin_layout Itemize
10973 \begin_inset Flex Code
10976 \begin_layout Plain Layout
10983 \begin_inset Flex Code
10986 \begin_layout Plain Layout
10995 \begin_inset space \thinspace{}
10999 \begin_inset Flex Code
11002 \begin_layout Plain Layout
11008 ] Declare if this is a mandatory (1) or an optional (0) argument.
11009 Mandatory arguments will be output empty if not given, while optional arguments
11010 will not be output at all.
11011 By default, mandatory arguments are delimited by
11012 \begin_inset Flex Code
11015 \begin_layout Plain Layout
11021 , while optional arguments are delimited by
11022 \begin_inset Flex Code
11025 \begin_layout Plain Layout
11034 \begin_layout Itemize
11035 \begin_inset Flex Code
11038 \begin_layout Plain Layout
11045 \begin_inset Flex Code
11048 \begin_layout Plain Layout
11054 defines another argument (by its number) which this argument requires to
11055 be output if it is itself output.
11057 \begin_inset space \thinspace{}
11060 g., in \SpecialChar LaTeX
11061 commands, optional arguments often require previous optional arguments
11062 to be output (at least empty), as in
11063 \begin_inset Flex Code
11066 \begin_layout Plain Layout
11069 command[][argument]{text}
11075 This can be achieved by the statement
11076 \begin_inset Flex Code
11079 \begin_layout Plain Layout
11086 \begin_inset Flex Code
11089 \begin_layout Plain Layout
11098 \begin_layout Itemize
11099 \begin_inset Flex Code
11102 \begin_layout Plain Layout
11109 \begin_inset Flex Code
11112 \begin_layout Plain Layout
11118 defines a custom left delimiter (instead of
11119 \begin_inset Flex Code
11122 \begin_layout Plain Layout
11129 \begin_inset Flex Code
11132 \begin_layout Plain Layout
11139 A line break in the output can be indicated by
11140 \begin_inset Flex Code
11143 \begin_layout Plain Layout
11152 \begin_layout Itemize
11153 \begin_inset Flex Code
11156 \begin_layout Plain Layout
11163 \begin_inset Flex Code
11166 \begin_layout Plain Layout
11172 defines a custom right delimiter (instead of
11173 \begin_inset Flex Code
11176 \begin_layout Plain Layout
11183 \begin_inset Flex Code
11186 \begin_layout Plain Layout
11193 A line break in the output can be indicated by
11194 \begin_inset Flex Code
11197 \begin_layout Plain Layout
11206 \begin_layout Itemize
11207 \begin_inset Flex Code
11210 \begin_layout Plain Layout
11217 \begin_inset Flex Code
11220 \begin_layout Plain Layout
11226 defines an argument that is inserted if and only if no user-specified arguments
11228 \begin_inset space \thinspace{}
11232 \begin_inset space \space{}
11235 if no argument inset has been inserted (note that also an empty argument
11236 inset omits the DefaultArg).
11237 Multiple arguments need to be separated by comma.
11240 \begin_layout Itemize
11241 \begin_inset Flex Code
11244 \begin_layout Plain Layout
11251 \begin_inset Flex Code
11254 \begin_layout Plain Layout
11260 defines an argument that is inserted in any case (alone or in addition
11261 to user-specified arguments).
11262 Multiple arguments need to be separated by comma.
11265 \begin_layout Itemize
11266 \begin_inset Flex Code
11269 \begin_layout Plain Layout
11275 The font used for the argument content, see
11276 \begin_inset CommandInset ref
11278 reference "subsec:Font-description"
11285 \begin_layout Itemize
11286 \begin_inset Flex Code
11289 \begin_layout Plain Layout
11295 The font used for the label; see
11296 \begin_inset CommandInset ref
11298 reference "subsec:Font-description"
11305 \begin_layout Itemize
11306 \begin_inset Flex Code
11309 \begin_layout Plain Layout
11316 \begin_inset Flex Code
11319 \begin_layout Plain Layout
11324 , Minimalistic, Conglomerate
11329 ] describes the rendering style used for the inset's frame and buttons.
11332 \begin_layout Itemize
11333 \begin_inset Flex Code
11336 \begin_layout Plain Layout
11343 \begin_inset Flex Code
11346 \begin_layout Plain Layout
11353 \begin_inset Flex Code
11356 \begin_layout Plain Layout
11362 , this argument is automatically inserted when the respective style is selected.
11363 Currently, only one argument per style\SpecialChar breakableslash
11364 layout can be automatically inserted.
11367 \begin_layout Itemize
11368 \begin_inset Flex Code
11371 \begin_layout Plain Layout
11378 \begin_inset Flex Code
11381 \begin_layout Plain Layout
11388 \begin_inset Flex Code
11391 \begin_layout Plain Layout
11397 , this argument will be inserted with a copy of the co-text (either selected
11398 text or the whole paragraph) as content.
11401 \begin_layout Itemize
11402 \begin_inset Flex Code
11405 \begin_layout Plain Layout
11412 \begin_inset Flex Code
11415 \begin_layout Plain Layout
11416 string of characters
11425 Defines individual characters that should be output in raw form, meaning
11426 without special translations that \SpecialChar LaTeX
11428 Note that, contrary to PassThru, this needs to be explicitly defined for
11430 That is, arguments do not inherit PassThruChars from their parent inset
11434 \begin_layout Standard
11435 By default, the text entered in the \SpecialChar LyX
11436 workarea in the respective layout is
11437 the last (mandatory) argument of a command if the
11438 \begin_inset Flex Code
11441 \begin_layout Plain Layout
11448 \begin_inset Flex Code
11451 \begin_layout Plain Layout
11458 However, arguments with the prefix
11459 \begin_inset Flex Code
11462 \begin_layout Plain Layout
11468 are output after this workarea argument.
11469 Note that post-argument numbering restarts at 1, so the first argument
11470 following the workarea argument is
11471 \begin_inset Flex Code
11474 \begin_layout Plain Layout
11481 Post-arguments are ignored in any other
11482 \begin_inset Flex Code
11485 \begin_layout Plain Layout
11492 \begin_inset Flex Code
11495 \begin_layout Plain Layout
11504 \begin_layout Standard
11506 \begin_inset Flex Code
11509 \begin_layout Plain Layout
11518 \begin_inset Flex Code
11521 \begin_layout Plain Layout
11530 \begin_inset Flex Code
11533 \begin_layout Plain Layout
11539 followed by the number (e.
11540 \begin_inset space \thinspace{}
11544 \begin_inset space \space{}
11548 \begin_inset Flex Code
11551 \begin_layout Plain Layout
11561 \begin_layout Description
11562 \begin_inset Flex Code
11565 \begin_layout Plain Layout
11571 Note that this will completely override any prior
11572 \begin_inset Flex Code
11575 \begin_layout Plain Layout
11581 declaration for this style.
11583 \begin_inset Quotes eld
11587 \begin_inset Flex Code
11590 \begin_layout Plain Layout
11597 \begin_inset Quotes erd
11602 \begin_inset CommandInset ref
11604 reference "subsec:I18n"
11608 for details on its use.
11611 \begin_layout Description
11612 \begin_inset Flex Code
11615 \begin_layout Plain Layout
11622 \begin_inset Flex Code
11625 \begin_layout Plain Layout
11635 \begin_layout Plain Layout
11636 Note that a `float' here is a real number, such as: 1.5.
11641 The vertical space with which the last of a chain of paragraphs with this
11642 style is separated from the following paragraph.
11643 If the next paragraph has another style, the separations are not simply
11644 added, but the maximum is taken.
11647 \begin_layout Description
11648 \begin_inset Flex Code
11651 \begin_layout Plain Layout
11658 \begin_inset Flex Code
11661 \begin_layout Plain Layout
11667 ] The category for this style.
11668 This is used to group related styles in the style combobox on the toolbar.
11669 Any string can be used, but you may want to use existing categories with
11674 \begin_layout Description
11675 \begin_inset Flex Code
11678 \begin_layout Plain Layout
11684 Depth of XML command.
11685 Used only with XML-type formats.
11688 \begin_layout Description
11689 \begin_inset Flex Code
11692 \begin_layout Plain Layout
11699 \begin_inset Flex Code
11702 \begin_layout Plain Layout
11708 ] Copies all the features of an existing style into the current one.
11712 \begin_layout Description
11713 \begin_inset Flex Code
11716 \begin_layout Plain Layout
11723 \begin_inset Flex Code
11726 \begin_layout Plain Layout
11732 ] The name of a style whose preamble should be output
11737 This allows to ensure some ordering of the preamble snippets when macros
11738 definitions depend on one another.
11742 \begin_layout Plain Layout
11743 Note that, besides that functionality, there is no way to ensure any ordering
11745 The ordering that you see in a given version of \SpecialChar LyX
11746 may change without warning
11755 \begin_layout Description
11756 \begin_inset Flex Code
11759 \begin_layout Plain Layout
11766 \begin_inset Flex Code
11769 \begin_layout Plain Layout
11774 , Box, Filled_Box, Static
11779 ] The type of label that stands at the end of the paragraph (or sequence
11781 \begin_inset Flex Code
11784 \begin_layout Plain Layout
11791 \begin_inset Newline newline
11795 \begin_inset Flex Code
11798 \begin_layout Plain Layout
11805 \begin_inset Flex Code
11808 \begin_layout Plain Layout
11815 \begin_inset Flex Code
11818 \begin_layout Plain Layout
11826 \begin_inset Flex Code
11829 \begin_layout Plain Layout
11836 \begin_inset Quotes eld
11840 \begin_inset Quotes erd
11844 \begin_inset Flex Code
11847 \begin_layout Plain Layout
11854 \begin_inset space \space{}
11858 \begin_inset Flex Code
11861 \begin_layout Plain Layout
11867 ) is a white (resp.
11868 \begin_inset space ~
11871 black) square suitable for end of proof markers,
11872 \begin_inset Flex Code
11875 \begin_layout Plain Layout
11881 is an explicit text string.
11884 \begin_layout Description
11885 \begin_inset Flex Code
11888 \begin_layout Plain Layout
11895 \begin_inset Flex Code
11898 \begin_layout Plain Layout
11904 ] The string used for a label with a
11905 \begin_inset Flex Code
11908 \begin_layout Plain Layout
11915 \begin_inset Newline newline
11919 \begin_inset Flex Code
11922 \begin_layout Plain Layout
11932 \begin_layout Description
11933 \begin_inset Flex Code
11936 \begin_layout Plain Layout
11942 The font used for both the text body
11948 \begin_inset CommandInset ref
11950 reference "subsec:Font-description"
11955 Note that defining this font automatically defines the
11956 \begin_inset Flex Code
11959 \begin_layout Plain Layout
11966 So you should define this one first if you also want to define
11967 \begin_inset Flex Code
11970 \begin_layout Plain Layout
11979 \begin_layout Description
11980 \begin_inset Flex Code
11983 \begin_layout Plain Layout
11990 \begin_inset Flex Code
11993 \begin_layout Plain Layout
11999 ] Used for backporting new styles to stable \SpecialChar LyX
12001 The first stable version that supports this tag is \SpecialChar LyX
12003 The argument is a number which may either be 0, -1 or any value greater
12006 \begin_inset Flex Code
12009 \begin_layout Plain Layout
12015 flag of a style is greater than zero, it will always be written to the
12017 If a .lyx file is read, the style definitions from the document header are
12018 added to the document class.
12019 Therefore even older \SpecialChar LyX
12020 versions can handle the style.
12022 \begin_inset Flex Code
12025 \begin_layout Plain Layout
12031 is a version number: if the style is read, and the version number is less
12032 than the version number of the already existing style in the document class,
12033 the new style is ignored.
12034 If the version number is greater, the new style replaces the existing style.
12035 A value of -1 means an infinite version number, i.
12036 \begin_inset space \thinspace{}
12040 \begin_inset space \space{}
12043 the style is always used.
12046 \begin_layout Description
12047 \begin_inset Flex Code
12050 \begin_layout Plain Layout
12057 \begin_inset Flex Code
12060 \begin_layout Plain Layout
12069 \begin_inset space \thinspace{}
12073 \begin_inset Flex Code
12076 \begin_layout Plain Layout
12082 ] Usually \SpecialChar LyX
12083 does not allow you to insert more than one space between words,
12084 since a space is considered as the separation between two words, not a
12085 character or symbol of its own.
12086 This is a very fine thing but sometimes annoying, for example, when typing
12087 program code or plain \SpecialChar LaTeX
12090 \begin_inset Flex Code
12093 \begin_layout Plain Layout
12100 Note that \SpecialChar LyX
12101 will create protected blanks for the additional blanks when
12102 in another mode than \SpecialChar LaTeX
12106 \begin_layout Description
12107 \begin_inset Flex Code
12110 \begin_layout Plain Layout
12116 These tags are used with XHTML output.
12118 \begin_inset CommandInset ref
12120 reference "subsec:Paragraph-Style-XHTML"
12127 \begin_layout Description
12128 \begin_inset Flex Code
12131 \begin_layout Plain Layout
12137 [FIXME] (Used only with XML-type formats.)
12140 \begin_layout Description
12141 \begin_inset Flex Code
12144 \begin_layout Plain Layout
12151 \begin_inset Flex Code
12154 \begin_layout Plain Layout
12163 \begin_inset space \thinspace{}
12167 \begin_inset Flex Code
12170 \begin_layout Plain Layout
12177 \begin_inset Flex Code
12180 \begin_layout Plain Layout
12186 , marks the style as to be included in the document preamble and not in
12188 This is useful for document classes that want such information as the title
12189 and author to appear in the preamble.
12190 Note that this works only for styles for which the
12191 \begin_inset Flex Code
12194 \begin_layout Plain Layout
12201 \begin_inset Flex Code
12204 \begin_layout Plain Layout
12211 \begin_inset Flex Code
12214 \begin_layout Plain Layout
12223 \begin_layout Description
12224 \begin_inset Flex Code
12227 \begin_layout Plain Layout
12234 \begin_inset Flex Code
12237 \begin_layout Plain Layout
12246 \begin_inset space \thinspace{}
12250 \begin_inset Flex Code
12253 \begin_layout Plain Layout
12260 \begin_inset Flex Code
12263 \begin_layout Plain Layout
12269 , marks the style as being part of a title block (see also the
12270 \begin_inset Flex Code
12273 \begin_layout Plain Layout
12280 \begin_inset Flex Code
12283 \begin_layout Plain Layout
12292 \begin_layout Description
12293 \begin_inset Flex Code
12296 \begin_layout Plain Layout
12303 \begin_inset Flex Code
12306 \begin_layout Plain Layout
12312 ] The \SpecialChar LaTeX
12313 command sequence declaring an item in a list.
12314 The command is to be defined without the preceding backslash (the default
12316 \begin_inset Quotes eld
12320 \begin_inset Quotes erd
12324 \begin_inset Flex Code
12327 \begin_layout Plain Layout
12335 in the \SpecialChar LaTeX
12339 \begin_layout Description
12340 \begin_inset Flex Code
12343 \begin_layout Plain Layout
12350 \begin_inset Flex Code
12353 \begin_layout Plain Layout
12359 ] This provides extra space between paragraphs that have the same style.
12360 If you put other styles into an environment, each is separated with the
12362 \begin_inset Flex Code
12365 \begin_layout Plain Layout
12372 But the whole items of the environment are additionally separated with
12374 \begin_inset Flex Code
12377 \begin_layout Plain Layout
12384 Note that this is a
12389 \begin_layout Description
12390 \begin_inset Flex Code
12393 \begin_layout Plain Layout
12399 [FIXME] (Used only with XML-type formats.)
12402 \begin_layout Description
12403 \begin_inset Flex Code
12406 \begin_layout Plain Layout
12413 \begin_inset Flex Code
12416 \begin_layout Plain Layout
12425 \begin_inset space \thinspace{}
12429 \begin_inset Flex Code
12432 \begin_layout Plain Layout
12438 ] Usually \SpecialChar LyX
12439 does not allow you to leave a paragraph empty, since it would
12440 lead to empty \SpecialChar LaTeX
12442 There are some cases where this could be desirable however: in a letter
12443 template, the required fields can be provided as empty fields, so that
12444 people do not forget them; in some special classes, a style can be used
12445 as some kind of break, which does not contain actual text.
12448 \begin_layout Description
12449 \begin_inset Flex Code
12452 \begin_layout Plain Layout
12459 \begin_inset Flex Code
12462 \begin_layout Plain Layout
12468 ] The vertical space between the label and the text body.
12469 Only used for labels that are above the text body (
12470 \begin_inset Flex Code
12473 \begin_layout Plain Layout
12480 \begin_inset Newline newline
12484 \begin_inset Flex Code
12487 \begin_layout Plain Layout
12488 Centered_Top_Environment
12496 \begin_layout Description
12497 \begin_inset Flex Code
12500 \begin_layout Plain Layout
12507 \begin_inset Flex Code
12510 \begin_layout Plain Layout
12516 ] The name of the counter for automatic numbering.
12517 In order to have the counter appear with your label, you will need to reference
12519 \begin_inset Flex Code
12522 \begin_layout Plain Layout
12531 This will work with
12532 \begin_inset Flex Code
12535 \begin_layout Plain Layout
12542 \begin_inset Flex Code
12545 \begin_layout Plain Layout
12552 \begin_inset Flex Code
12555 \begin_layout Plain Layout
12562 \begin_inset Flex Code
12565 \begin_layout Plain Layout
12572 \begin_inset Newline newline
12580 \begin_inset Flex Code
12583 \begin_layout Plain Layout
12590 \begin_inset Flex Code
12593 \begin_layout Plain Layout
12599 , though this case is a bit complicated.
12600 Suppose you declare
12601 \begin_inset Quotes eld
12605 \begin_inset Flex Code
12608 \begin_layout Plain Layout
12609 LabelCounter myenum
12615 \begin_inset Quotes erd
12619 Then the actual counters used are
12620 \begin_inset Flex Code
12623 \begin_layout Plain Layout
12630 \begin_inset Flex Code
12633 \begin_layout Plain Layout
12640 \begin_inset Flex Code
12643 \begin_layout Plain Layout
12650 \begin_inset Flex Code
12653 \begin_layout Plain Layout
12659 , much as in \SpecialChar LaTeX
12661 These counters must all be declared separately.
12662 \begin_inset Newline newline
12666 \begin_inset CommandInset ref
12668 reference "subsec:Counters"
12672 for details on counters.
12675 \begin_layout Description
12676 \begin_inset Flex Code
12679 \begin_layout Plain Layout
12685 The font used for the label.
12687 \begin_inset CommandInset ref
12689 reference "subsec:Font-description"
12696 \begin_layout Description
12697 \begin_inset Flex Code
12700 \begin_layout Plain Layout
12707 \begin_inset Flex Code
12710 \begin_layout Plain Layout
12716 ] Text that indicates how far a label should be indented.
12719 \begin_layout Description
12720 \begin_inset Flex Code
12723 \begin_layout Plain Layout
12730 \begin_inset Flex Code
12733 \begin_layout Plain Layout
12739 ] Text that indicates the amount of horizontal space between the label and
12741 Only used for labels that are not above the text body.
12744 \begin_layout Description
12745 \begin_inset Flex Code
12748 \begin_layout Plain Layout
12755 \begin_inset Flex Code
12758 \begin_layout Plain Layout
12764 ] The string used for the label.
12766 \begin_inset Flex Code
12769 \begin_layout Plain Layout
12775 is set, this string can be contain the special formatting commands described
12777 \begin_inset CommandInset ref
12779 reference "subsec:Counters"
12786 \begin_layout Description
12787 \begin_inset Flex Code
12790 \begin_layout Plain Layout
12791 LabelStringAppendix
12797 \begin_inset Flex Code
12800 \begin_layout Plain Layout
12806 ] This is used inside the appendix instead of
12807 \begin_inset Newline newline
12811 \begin_inset Flex Code
12814 \begin_layout Plain Layout
12822 \begin_inset Flex Code
12825 \begin_layout Plain Layout
12832 \begin_inset Newline newline
12836 \begin_inset Flex Code
12839 \begin_layout Plain Layout
12840 LabelStringAppendix
12848 \begin_layout Description
12849 \begin_inset Flex Code
12852 \begin_layout Plain Layout
12858 [FIXME] (Used only with XML-type formats.)
12861 \begin_layout Description
12862 \begin_inset Flex Code
12865 \begin_layout Plain Layout
12872 \begin_inset Flex Code
12875 \begin_layout Plain Layout
12880 , Manual, Static, Above,
12881 \begin_inset Newline newline
12884 Centered, Sensitive, Enumerate,
12885 \begin_inset Newline newline
12888 Itemize, Bibliography
12894 \begin_inset Separator latexpar
12901 \begin_layout Description
12902 \begin_inset Flex Code
12905 \begin_layout Plain Layout
12911 means the label is the very first word (up to the first real blank).
12912 Use protected spaces if you want more than one word as the label.
12916 \begin_layout Description
12917 \begin_inset Flex Code
12920 \begin_layout Plain Layout
12926 means the label is simply what is declared as
12927 \begin_inset Flex Code
12930 \begin_layout Plain Layout
12937 This will be displayed
12938 \begin_inset Quotes eld
12942 \begin_inset Quotes erd
12945 , at the beginning of the paragraph.
12947 \begin_inset Flex Code
12950 \begin_layout Plain Layout
12957 \begin_inset Flex Code
12960 \begin_layout Plain Layout
12966 , then it will be displayed only in the first paragraph of any sequence
12967 of paragraphs with the same
12968 \begin_inset Flex Code
12971 \begin_layout Plain Layout
12980 \begin_layout Description
12981 \begin_inset Flex Code
12984 \begin_layout Plain Layout
12991 \begin_inset space ~
12995 \begin_inset space ~
12999 \begin_inset Flex Code
13002 \begin_layout Plain Layout
13008 are special cases of
13009 \begin_inset Flex Code
13012 \begin_layout Plain Layout
13019 The label will be printed above the paragraph either at the beginning of
13020 the line or centered.
13023 \begin_layout Description
13024 \begin_inset Flex Code
13027 \begin_layout Plain Layout
13033 is a special case for the caption-labels
13034 \begin_inset Quotes eld
13038 \begin_inset Quotes erd
13042 \begin_inset Quotes eld
13046 \begin_inset Quotes erd
13050 \begin_inset Newline newline
13054 \begin_inset Flex Code
13057 \begin_layout Plain Layout
13063 means the (hardcoded) label string depends on the kind of float: It is
13064 hardcoded to be `FloatType N', where N is the value of the counter associated
13066 For the case that a caption is inserted outside of a float the
13067 \begin_inset Flex Code
13070 \begin_layout Plain Layout
13077 \begin_inset Quotes eld
13081 \begin_inset Quotes erd
13087 \begin_layout Description
13088 \begin_inset Flex Code
13091 \begin_layout Plain Layout
13097 produces the usual sort of enumeration labels.
13098 At present, it is hardcoded to use Arabic numerals, lowercase letters,
13099 small Roman numerals, and uppercase letters for the four possible depths.
13102 \begin_layout Description
13103 \begin_inset Flex Code
13106 \begin_layout Plain Layout
13112 produces various bullets at the different levels.
13113 It is also hardcoded.
13116 \begin_layout Description
13117 \begin_inset Flex Code
13120 \begin_layout Plain Layout
13126 should be used only with
13127 \begin_inset Flex Code
13130 \begin_layout Plain Layout
13131 LatexType BibEnvironment
13140 \begin_layout Description
13141 \begin_inset Flex Code
13144 \begin_layout Plain Layout
13150 Note that this will completely override any prior
13151 \begin_inset Flex Code
13154 \begin_layout Plain Layout
13160 declaration for this style.
13162 \begin_inset Quotes eld
13166 \begin_inset Flex Code
13169 \begin_layout Plain Layout
13176 \begin_inset Quotes erd
13181 \begin_inset CommandInset ref
13183 reference "subsec:I18n"
13187 for details on its use.
13190 \begin_layout Description
13191 \begin_inset Flex Code
13194 \begin_layout Plain Layout
13201 \begin_inset Flex Code
13204 \begin_layout Plain Layout
13210 ] The name of the corresponding \SpecialChar LaTeX
13212 Either the environment or command name.
13215 \begin_layout Description
13216 \begin_inset Flex Code
13219 \begin_layout Plain Layout
13226 \begin_inset Flex Code
13229 \begin_layout Plain Layout
13235 ] An optional parameter for the corresponding
13236 \begin_inset Flex Code
13239 \begin_layout Plain Layout
13246 This parameter cannot be changed from within \SpecialChar LyX
13248 \begin_inset Flex Code
13251 \begin_layout Plain Layout
13257 for customizable parameters).
13258 This will be output as is after all \SpecialChar LaTeX
13260 \begin_inset Flex Code
13263 \begin_layout Plain Layout
13272 \begin_layout Description
13273 \begin_inset Flex Code
13276 \begin_layout Plain Layout
13283 \begin_inset Flex Code
13286 \begin_layout Plain Layout
13291 , Command, Environment, Item_Environment,
13292 \begin_inset Newline newline
13295 List_Environment, Bib_Environment
13300 ] How the style should be translated into \SpecialChar LaTeX
13305 \begin_layout Plain Layout
13306 \begin_inset Flex Code
13309 \begin_layout Plain Layout
13315 is perhaps a bit misleading, since these rules apply to SGML classes, too.
13316 Visit the SGML class files for specific examples.
13322 \begin_inset Separator latexpar
13329 \begin_layout Description
13330 \begin_inset Flex Code
13333 \begin_layout Plain Layout
13339 means nothing special.
13342 \begin_layout Description
13343 \begin_inset Flex Code
13346 \begin_layout Plain Layout
13353 \begin_inset Flex Code
13356 \begin_layout Plain Layout
13363 {\SpecialChar ldots
13372 \begin_layout Description
13373 \begin_inset Flex Code
13376 \begin_layout Plain Layout
13383 \begin_inset Flex Code
13386 \begin_layout Plain Layout
13393 }\SpecialChar ldots
13409 \begin_layout Description
13410 \begin_inset Flex Code
13413 \begin_layout Plain Layout
13420 \begin_inset Flex Code
13423 \begin_layout Plain Layout
13430 \begin_inset Flex Code
13433 \begin_layout Plain Layout
13441 is generated for each paragraph of this environment.
13445 \begin_layout Description
13446 \begin_inset Flex Code
13449 \begin_layout Plain Layout
13456 \begin_inset Flex Code
13459 \begin_layout Plain Layout
13466 \begin_inset Newline newline
13470 \begin_inset Flex Code
13473 \begin_layout Plain Layout
13479 is passed as an argument to the environment.
13480 \begin_inset Newline newline
13484 \begin_inset Flex Code
13487 \begin_layout Plain Layout
13493 can be defined in the
13494 \begin_inset Flex Noun
13497 \begin_layout Plain Layout
13498 Edit\SpecialChar menuseparator
13500 \begin_inset space ~
13511 \begin_layout Description
13512 \begin_inset Flex Code
13515 \begin_layout Plain Layout
13522 \begin_inset Flex Code
13525 \begin_layout Plain Layout
13531 but adds the necessary mandatory argument (the longest label) to the begin
13532 statement of the bibliography environment:
13533 \begin_inset Newline newline
13537 \begin_inset Flex Code
13540 \begin_layout Plain Layout
13543 begin{thebibliography}{99}
13549 It is therefore only useful for bibliography environments.
13550 The default longest label
13551 \begin_inset Quotes eld
13555 \begin_inset Quotes erd
13558 can be changed by the user in the paragraph settings of a bibliography
13562 \begin_layout Standard
13563 Putting the last few things together, the \SpecialChar LaTeX
13564 output will be either:
13567 \begin_layout LyX-Code
13570 LatexName[LatexParam]{\SpecialChar ldots
13574 \begin_layout Standard
13578 \begin_layout LyX-Code
13581 begin{LatexName}[LatexParam] \SpecialChar ldots
13587 \begin_layout Standard
13588 depending upon the \SpecialChar LaTeX
13593 \begin_layout Description
13594 \begin_inset Flex Code
13597 \begin_layout Plain Layout
13604 \begin_inset Flex Code
13607 \begin_layout Plain Layout
13613 ] A string that is put at the beginning of the style content.
13614 A line break in the output can be indicated by
13615 \begin_inset Flex Code
13618 \begin_layout Plain Layout
13627 \begin_layout Description
13628 \begin_inset Flex Code
13631 \begin_layout Plain Layout
13638 \begin_inset Flex Code
13641 \begin_layout Plain Layout
13647 ] If you put styles into environments, the different
13648 \begin_inset Flex Code
13651 \begin_layout Plain Layout
13657 are not simply added, but added with a factor
13658 \begin_inset Formula $\frac{4}{\mathrm{depth}+4}$
13662 Note that this parameter is also used when
13663 \begin_inset Flex Code
13666 \begin_layout Plain Layout
13673 \begin_inset Flex Code
13676 \begin_layout Plain Layout
13683 \begin_inset Flex Code
13686 \begin_layout Plain Layout
13693 Then it is added to the manual or dynamic margin.
13694 \begin_inset Newline newline
13698 \begin_inset Quotes eld
13702 \begin_inset Flex Code
13705 \begin_layout Plain Layout
13712 \begin_inset Quotes erd
13715 means that the paragraph is indented with the width of
13716 \begin_inset Quotes eld
13720 \begin_inset Flex Code
13723 \begin_layout Plain Layout
13730 \begin_inset Quotes erd
13733 in the normal font.
13734 You can get a negative width by prefixing the string with
13735 \begin_inset Quotes eld
13739 \begin_inset Flex Code
13742 \begin_layout Plain Layout
13749 \begin_inset Quotes erd
13753 This way was chosen so that the look is the same with each used screen
13757 \begin_layout Description
13758 \begin_inset Flex Code
13761 \begin_layout Plain Layout
13768 \begin_inset Flex Code
13771 \begin_layout Plain Layout
13776 , Manual, Dynamic, First_Dynamic, Right_Address_Box
13782 \begin_inset Newline newline
13785 The kind of margin that the style has on the left side.
13786 \begin_inset Separator latexpar
13793 \begin_layout Description
13794 \begin_inset Flex Code
13797 \begin_layout Plain Layout
13803 just means a fixed margin.
13806 \begin_layout Description
13807 \begin_inset Flex Code
13810 \begin_layout Plain Layout
13816 means that the left margin depends on the string entered in the
13817 \begin_inset Flex Noun
13820 \begin_layout Plain Layout
13821 Edit\SpecialChar menuseparator
13823 \begin_inset space ~
13832 This is used to typeset nice lists without tabulators.
13835 \begin_layout Description
13836 \begin_inset Flex Code
13839 \begin_layout Plain Layout
13845 means that the margin depends on the size of the label.
13846 This is used for automatic enumerated headlines.
13847 It is obvious that the headline
13848 \begin_inset Quotes eld
13851 5.4.3.2.1 Very long headline
13852 \begin_inset Quotes erd
13855 must have a wider left margin (as wide as
13856 \begin_inset Quotes eld
13860 \begin_inset Quotes erd
13863 plus the space) than
13864 \begin_inset Quotes eld
13867 3.2 Very long headline
13868 \begin_inset Quotes erd
13872 \begin_inset Quotes eld
13876 \begin_inset Quotes erd
13879 are not able to do this.
13882 \begin_layout Description
13883 \begin_inset Flex Code
13886 \begin_layout Plain Layout
13892 is similar, but only the very first row of the paragraph is dynamic, while
13893 the others are static; this is used, for example, for descriptions.
13896 \begin_layout Description
13897 \begin_inset Flex Code
13900 \begin_layout Plain Layout
13906 means the margin is chosen in a way that the longest row of this paragraph
13907 fits to the right margin.
13908 This is used to typeset an address on the right edge of the page.
13912 \begin_layout Description
13913 \begin_inset Flex Code
13916 \begin_layout Plain Layout
13923 \begin_inset Flex Code
13926 \begin_layout Plain Layout
13935 \begin_inset space \thinspace{}
13939 \begin_inset Flex Code
13942 \begin_layout Plain Layout
13948 ] Whether fragile commands in this style should be
13949 \begin_inset Flex Code
13952 \begin_layout Plain Layout
13965 whether this command should itself be protected.)
13968 \begin_layout Description
13969 \begin_inset Flex Code
13972 \begin_layout Plain Layout
13979 \begin_inset Flex Code
13982 \begin_layout Plain Layout
13989 \begin_inset space \thinspace{}
13993 \begin_inset Flex Code
13996 \begin_layout Plain Layout
14004 ] Whether newlines are translated into \SpecialChar LaTeX
14006 \begin_inset Flex Code
14009 \begin_layout Plain Layout
14020 The translation can be switched off to allow more comfortable \SpecialChar LaTeX
14022 inside \SpecialChar LyX
14026 \begin_layout Description
14027 \begin_inset Flex Code
14030 \begin_layout Plain Layout
14037 \begin_inset Flex Code
14040 \begin_layout Plain Layout
14049 \begin_inset space \thinspace{}
14053 \begin_inset Flex Code
14056 \begin_layout Plain Layout
14062 ] If set to true, and if
14063 \begin_inset Flex Code
14066 \begin_layout Plain Layout
14073 \begin_inset Flex Code
14076 \begin_layout Plain Layout
14082 ) paragraphs are being indented, then the indentation of such a paragraph
14083 following one of this type will be suppressed.
14084 (So this will not affect the display of non-default paragraphs.)
14087 \begin_layout Description
14088 \begin_inset Flex Code
14091 \begin_layout Plain Layout
14098 \begin_inset Flex Code
14101 \begin_layout Plain Layout
14107 ] Name of a style that has replaced this style.
14108 This is used to rename a style, while keeping backward compatibility.
14111 \begin_layout Description
14112 \begin_inset Flex Code
14115 \begin_layout Plain Layout
14122 \begin_inset Flex Code
14125 \begin_layout Plain Layout
14132 \begin_inset space \thinspace{}
14136 \begin_inset Flex Code
14139 \begin_layout Plain Layout
14145 ] Determines whether consecutive pragraphs of the same type are treated
14146 as belonging together.
14147 This has the effect that the
14148 \begin_inset Flex Code
14151 \begin_layout Plain Layout
14157 is only printed once before such a group.
14158 By default, this is true for
14159 \begin_inset Flex Code
14162 \begin_layout Plain Layout
14169 \begin_inset Flex Code
14172 \begin_layout Plain Layout
14179 \begin_inset Flex Code
14182 \begin_layout Plain Layout
14188 and false for all other types.
14191 \begin_layout Description
14192 \begin_inset Flex Code
14195 \begin_layout Plain Layout
14202 \begin_inset Flex Code
14205 \begin_layout Plain Layout
14214 \begin_inset space \thinspace{}
14218 \begin_inset Flex Code
14221 \begin_layout Plain Layout
14227 ] Indicates that paragraphs will not be separated by an empty line in \SpecialChar LaTeX
14229 but only by a line break; together with
14230 \begin_inset Flex Code
14233 \begin_layout Plain Layout
14239 , this allows to emulate a plain text editor (like the ERT inset).
14242 \begin_layout Description
14243 \begin_inset Flex Code
14246 \begin_layout Plain Layout
14253 \begin_inset Flex Code
14256 \begin_layout Plain Layout
14262 ] The indent of the very first line of a paragraph.
14264 \begin_inset Newline newline
14268 \begin_inset Flex Code
14271 \begin_layout Plain Layout
14277 will be fixed for a certain style.
14278 The exception is the default style, since the indentation for these paragraphs
14279 can be prohibited with
14280 \begin_inset Flex Code
14283 \begin_layout Plain Layout
14291 \begin_inset Flex Code
14294 \begin_layout Plain Layout
14300 style paragraphs inside environments use the
14301 \begin_inset Flex Code
14304 \begin_layout Plain Layout
14310 of the environment, not their native one.
14312 \begin_inset Flex Code
14315 \begin_layout Plain Layout
14321 paragraphs inside an enumeration are not indented.
14324 \begin_layout Description
14325 \begin_inset Flex Code
14328 \begin_layout Plain Layout
14335 \begin_inset Flex Code
14338 \begin_layout Plain Layout
14344 ] The vertical space between two paragraphs of this style.
14347 \begin_layout Description
14348 \begin_inset Flex Code
14351 \begin_layout Plain Layout
14358 \begin_inset Flex Code
14361 \begin_layout Plain Layout
14368 allows the user to choose either
14369 \begin_inset Quotes eld
14373 \begin_inset Quotes erd
14377 \begin_inset Quotes eld
14381 \begin_inset Quotes erd
14384 to separate paragraphs.
14386 \begin_inset Quotes eld
14390 \begin_inset Quotes erd
14394 \begin_inset Flex Code
14397 \begin_layout Plain Layout
14405 \begin_inset Quotes eld
14409 \begin_inset Quotes erd
14413 \begin_inset Flex Code
14416 \begin_layout Plain Layout
14422 is ignored and all paragraphs are separated by the
14423 \begin_inset Flex Code
14426 \begin_layout Plain Layout
14433 The vertical space is calculated with
14434 \begin_inset Flex Code
14437 \begin_layout Plain Layout
14439 \begin_inset space ~
14448 \begin_inset Flex Code
14451 \begin_layout Plain Layout
14457 is the height of a row with the normal font.
14458 This way, the look stays the same with different screen fonts.
14461 \begin_layout Description
14462 \begin_inset Flex Code
14465 \begin_layout Plain Layout
14472 \begin_inset Flex Code
14475 \begin_layout Plain Layout
14484 \begin_inset space \thinspace{}
14488 \begin_inset Flex Code
14491 \begin_layout Plain Layout
14497 ] Whether the contents of this paragraph should be output in raw form, meaning
14498 without special translations that \SpecialChar LaTeX
14502 \begin_layout Description
14503 \begin_inset Flex Code
14506 \begin_layout Plain Layout
14513 \begin_inset Flex Code
14516 \begin_layout Plain Layout
14526 Defines individual characters that should be output in raw form, meaning
14527 without special translations that \SpecialChar LaTeX
14531 \begin_layout Description
14532 \begin_inset Flex Code
14535 \begin_layout Plain Layout
14541 Information to be included in the \SpecialChar LaTeX
14542 preamble when this style is used.
14543 Used to define macros, load packages, etc., required by this particular
14546 \begin_inset Quotes eld
14550 \begin_inset Flex Code
14553 \begin_layout Plain Layout
14560 \begin_inset Quotes erd
14566 \begin_layout Description
14567 \begin_inset Flex Code
14570 \begin_layout Plain Layout
14577 \begin_inset Flex Code
14580 \begin_layout Plain Layout
14586 ] The prefix to use when creating labels referring to paragraphs of this
14588 This allows the use of formatted references.
14591 \begin_layout Description
14592 \begin_inset Flex Code
14595 \begin_layout Plain Layout
14602 \begin_inset Flex Code
14605 \begin_layout Plain Layout
14611 ] Whether the style requires the feature
14612 \begin_inset Flex Code
14615 \begin_layout Plain Layout
14622 \begin_inset CommandInset ref
14624 reference "chap:List-of-functions"
14628 for the list of features).
14629 If you require a package with specific options, you can additionally use
14631 \begin_inset Flex Code
14634 \begin_layout Plain Layout
14640 as a general text class parameter (see
14641 \begin_inset CommandInset ref
14643 reference "subsec:General-text-class"
14650 \begin_layout Description
14651 \begin_inset Flex Code
14654 \begin_layout Plain Layout
14661 \begin_inset Flex Code
14664 \begin_layout Plain Layout
14673 \begin_inset Flex Code
14676 \begin_layout Plain Layout
14682 ] Resets the \SpecialChar LaTeX
14683 arguments of this style (as defined via the
14684 \begin_inset Flex Code
14687 \begin_layout Plain Layout
14694 This is useful if you have copied a style via
14695 \begin_inset Flex Code
14698 \begin_layout Plain Layout
14704 , but you do not want to inherit its (required and optional) arguments.
14707 \begin_layout Description
14708 \begin_inset Flex Code
14711 \begin_layout Plain Layout
14718 \begin_inset Flex Code
14721 \begin_layout Plain Layout
14727 ] A string that is put at the end of the layout content.
14728 A line break in the output can be indicated by
14729 \begin_inset Flex Code
14732 \begin_layout Plain Layout
14741 \begin_layout Description
14742 \begin_inset Flex Code
14745 \begin_layout Plain Layout
14752 \begin_inset Flex Code
14755 \begin_layout Plain Layout
14762 \begin_inset Flex Code
14765 \begin_layout Plain Layout
14774 \begin_layout Description
14775 \begin_inset Flex Code
14778 \begin_layout Plain Layout
14785 \begin_inset Flex Code
14788 \begin_layout Plain Layout
14797 \begin_inset Flex Code
14800 \begin_layout Plain Layout
14807 \begin_inset Flex Code
14810 \begin_layout Plain Layout
14817 \begin_inset Flex Code
14820 \begin_layout Plain Layout
14822 \begin_inset space ~
14830 ] This defines what the default spacing should be in the style.
14832 \begin_inset Flex Code
14835 \begin_layout Plain Layout
14842 \begin_inset Flex Code
14845 \begin_layout Plain Layout
14852 \begin_inset Flex Code
14855 \begin_layout Plain Layout
14861 correspond respectively to a multiplier value of 1, 1.25 and 1.667.
14862 If you specify the argument
14863 \begin_inset Flex Code
14866 \begin_layout Plain Layout
14872 , then you must also provide a value argument which will be the actual multiplie
14874 Note that, contrary to other parameters,
14875 \begin_inset Flex Code
14878 \begin_layout Plain Layout
14884 implies the generation of specific \SpecialChar LaTeX
14885 code, using the \SpecialChar LaTeX
14889 \begin_inset Flex Code
14892 \begin_layout Plain Layout
14901 \begin_layout Description
14902 \begin_inset Flex Code
14905 \begin_layout Plain Layout
14912 \begin_inset Flex Code
14915 \begin_layout Plain Layout
14922 \begin_inset space \thinspace{}
14926 \begin_inset Flex Code
14929 \begin_layout Plain Layout
14937 ] Allow spell-checking paragraphs of this style.
14941 \begin_layout Description
14942 \begin_inset Flex Code
14945 \begin_layout Plain Layout
14951 The font used for the text body .
14953 \begin_inset CommandInset ref
14955 reference "subsec:Font-description"
14962 \begin_layout Description
14963 \begin_inset Flex Code
14966 \begin_layout Plain Layout
14975 \begin_inset Flex Code
14978 \begin_layout Plain Layout
14988 The level of the style in the table of contents.
14989 This is used for automatic numbering of section headings.
14992 \begin_layout Description
14993 \begin_inset Flex Code
14996 \begin_layout Plain Layout
15005 \begin_inset Flex Code
15008 \begin_layout Plain Layout
15019 \begin_inset Flex Code
15022 \begin_layout Plain Layout
15029 \begin_inset Flex Code
15032 \begin_layout Plain Layout
15038 ] This tag determines whether the first line indentation of this paragraph
15039 can be toggled via the Paragraph settings dialog.
15043 \begin_inset Flex Code
15046 \begin_layout Plain Layout
15056 is set, indentation can be toggled if the document settings use
15057 \begin_inset Quotes eld
15061 \begin_inset Quotes erd
15064 paragraph style, with
15065 \begin_inset Flex Code
15068 \begin_layout Plain Layout
15074 , indentation can always be toggled, notwithstanding the document settings,
15076 \begin_inset Flex Code
15079 \begin_layout Plain Layout
15085 , indentation can never be toggled.
15088 \begin_layout Description
15089 \begin_inset Flex Code
15092 \begin_layout Plain Layout
15099 \begin_inset Flex Code
15102 \begin_layout Plain Layout
15108 ] The vertical space with which the very first of a chain of paragraphs
15109 with this style is separated from the previous paragraph.
15110 If the previous paragraph has another style, the separations are not simply
15111 added, but the maximum is taken.
15114 \begin_layout Subsection
15115 \begin_inset CommandInset label
15121 Internationalization of Paragraph Styles
15124 \begin_layout Standard
15126 has long supported internationalization of layout information, but, until
15127 version 2.0, this applied only to the user interface and not to, say, PDF
15129 Thus, French authors were forced to resort to ugly hacks if they wanted
15134 1' instead of `Theorem 1'.
15135 Thanks to Georg Baum, that is no longer the case.
15138 \begin_layout Standard
15140 \begin_inset Flex Code
15143 \begin_layout Plain Layout
15149 defines text that is to appear in the typeset document, it may use
15150 \begin_inset Flex Code
15153 \begin_layout Plain Layout
15160 \begin_inset Flex Code
15163 \begin_layout Plain Layout
15169 to support non-English and even multi-language documents correctly.
15170 The following excerpt (from the
15171 \begin_inset Flex Code
15174 \begin_layout Plain Layout
15180 file) shows how this works:
15183 \begin_layout LyX-Code
15185 \begin_inset Separator latexpar
15192 \begin_layout LyX-Code
15195 theoremstyle{remark}
15198 \begin_layout LyX-Code
15201 newtheorem{claim}[thm]{
15208 \begin_layout LyX-Code
15212 \begin_layout LyX-Code
15216 \begin_layout LyX-Code
15221 claimname}{_(Claim)}
15224 \begin_layout LyX-Code
15228 \begin_layout LyX-Code
15232 \begin_layout LyX-Code
15241 claimname}{_(Claim)}}
15244 \begin_layout LyX-Code
15249 \begin_layout Standard
15250 In principle, any legal \SpecialChar LaTeX
15252 \begin_inset Flex Code
15255 \begin_layout Plain Layout
15262 \begin_inset Flex Code
15265 \begin_layout Plain Layout
15271 tags, but in practice they will typically look as they do here.
15272 The key to correct translation of the typeset text is the definition of
15273 the \SpecialChar LaTeX
15275 \begin_inset Flex Code
15278 \begin_layout Plain Layout
15287 \begin_inset Flex Code
15290 \begin_layout Plain Layout
15302 \begin_layout Standard
15304 \begin_inset Flex Code
15307 \begin_layout Plain Layout
15313 tag provides for internationalization based upon the overall language of
15315 The contents of the tag will be included in the preamble, just as with
15317 \begin_inset Flex Code
15320 \begin_layout Plain Layout
15327 What makes it special is the use of the
15328 \begin_inset Quotes eld
15332 \begin_inset Quotes erd
15336 \begin_inset Flex Code
15339 \begin_layout Plain Layout
15345 , which will be replaced, when \SpecialChar LyX
15346 produces \SpecialChar LaTeX
15347 output, with the translation of
15348 its argument into the document language.
15351 \begin_layout Standard
15353 \begin_inset Flex Code
15356 \begin_layout Plain Layout
15362 tag is more complex, since it is meant to provide support for multi-language
15363 documents and so offers an interface to the
15364 \begin_inset Flex Code
15367 \begin_layout Plain Layout
15374 Its contents will be added to the preamble once for each language that
15375 appears in the document.
15376 In this case, the argument to
15377 \begin_inset Flex Code
15380 \begin_layout Plain Layout
15386 will be replaced with its translation into the language in question; the
15388 \begin_inset Flex Code
15391 \begin_layout Plain Layout
15397 is replaced by the language name (as used by the babel package).
15400 \begin_layout Standard
15401 A German document that also included a French section would thus have the
15402 following in the preamble:
15405 \begin_layout LyX-Code
15414 claimname}{Affirmation}}
15415 \begin_inset Newline newline
15426 claimname}{Behauptung}}
15427 \begin_inset Newline newline
15434 claimname}{Behauptung}
15437 \begin_layout Standard
15440 \begin_inset Flex Code
15443 \begin_layout Plain Layout
15449 will then conspire to produce the correct text in the output.
15452 \begin_layout Standard
15453 One important point to note here is that the translations are provided by
15455 itself, through the file
15456 \begin_inset Flex Code
15459 \begin_layout Plain Layout
15466 This means, in effect, that
15467 \begin_inset Flex Code
15470 \begin_layout Plain Layout
15477 \begin_inset Flex Code
15480 \begin_layout Plain Layout
15486 are really only of use in layout files that are provided with \SpecialChar LyX
15488 entered in user-created layout files will not be seen by \SpecialChar LyX
15489 's internationalizatio
15490 n routines unless the
15491 \begin_inset Flex Code
15494 \begin_layout Plain Layout
15500 file is modified accordingly.
15501 That said, however, any layout created with the intention that it will
15502 be included with \SpecialChar LyX
15503 should use these tags where appropriate.
15504 Please note that the paragraph style translations provided by \SpecialChar LyX
15506 change with a minor update (e.
15507 \begin_inset space \thinspace{}
15511 \begin_inset space \space{}
15514 from version 2.1.x to 2.1.y).
15515 It is however quite likely that a major update (e.
15516 \begin_inset space \thinspace{}
15520 \begin_inset space \space{}
15523 from 2.0.x to 2.1.y) will introduce new translations or corrections.
15526 \begin_layout Subsection
15528 \begin_inset CommandInset label
15530 name "subsec:Floats"
15537 \begin_layout Standard
15538 It is necessary to define the floats (
15539 \begin_inset Flex Noun
15542 \begin_layout Plain Layout
15549 \begin_inset Flex Noun
15552 \begin_layout Plain Layout
15558 , \SpecialChar ldots
15559 ) in the text class itself.
15560 Standard floats are included in the file
15561 \begin_inset Flex Code
15564 \begin_layout Plain Layout
15570 , so you may have to do no more than add
15573 \begin_layout LyX-Code
15574 Input stdfloats.inc
15577 \begin_layout Standard
15578 to your layout file.
15579 If you want to implement a text class that proposes some other float types
15580 (like the AGU class bundled with \SpecialChar LyX
15581 ), the information below will hopefully
15585 \begin_layout Description
15586 \begin_inset Flex Code
15589 \begin_layout Plain Layout
15596 \begin_inset Flex Code
15599 \begin_layout Plain Layout
15605 =!htbpH] Allowed placement options for this float type.
15606 The value is a string of placement characters.
15607 Possible characters include:
15612 \begin_inset Quotes eld
15616 \begin_inset Quotes erd
15624 \begin_inset Quotes eld
15628 \begin_inset Quotes erd
15636 \begin_inset Quotes eld
15640 \begin_inset Quotes erd
15648 \begin_inset Quotes eld
15652 \begin_inset Quotes erd
15660 \begin_inset Quotes eld
15664 \begin_inset Quotes erd
15672 \begin_inset Quotes eld
15676 \begin_inset Quotes erd
15680 The order of the characters in the string does not matter.
15681 If no placement options are allowed, use the string
15688 \begin_layout Description
15689 \begin_inset Flex Code
15692 \begin_layout Plain Layout
15699 \begin_inset Flex Code
15702 \begin_layout Plain Layout
15711 \begin_inset space \thinspace{}
15717 \begin_inset Flex Code
15720 \begin_layout Plain Layout
15730 ] Defines whether the float allows to be rotated via the \SpecialChar LaTeX
15737 \begin_inset Flex Code
15740 \begin_layout Plain Layout
15746 if the float does not support this feature.
15749 \begin_layout Description
15750 \begin_inset Flex Code
15753 \begin_layout Plain Layout
15760 \begin_inset Flex Code
15763 \begin_layout Plain Layout
15772 \begin_inset space \thinspace{}
15778 \begin_inset Flex Code
15781 \begin_layout Plain Layout
15791 ] Defines whether the float has a starred variant that spans columns in
15792 a two column paragraph.
15794 \begin_inset Flex Code
15797 \begin_layout Plain Layout
15803 if the float does not support this feature.
15806 \begin_layout Description
15807 \begin_inset Flex Code
15810 \begin_layout Plain Layout
15817 \begin_inset Flex Code
15820 \begin_layout Plain Layout
15827 \begin_inset Quotes erd
15831 \begin_inset Quotes erd
15834 ] The file name extension of an auxiliary file for the list of figures (or
15837 writes the captions to this file.
15840 \begin_layout Description
15841 \begin_inset Flex Code
15844 \begin_layout Plain Layout
15851 \begin_inset Flex Code
15854 \begin_layout Plain Layout
15861 \begin_inset Quotes erd
15865 \begin_inset Quotes erd
15868 ] The string that will be used in the menus and also for the caption.
15869 This is translated to the current language if babel is used.
15872 \begin_layout Description
15873 \begin_inset Flex Code
15876 \begin_layout Plain Layout
15882 These tags control the XHTML output.
15884 \begin_inset CommandInset ref
15886 reference "sec:Tags-for-XHTML"
15893 \begin_layout Description
15894 \begin_inset Flex Code
15897 \begin_layout Plain Layout
15906 \begin_inset Flex Code
15909 \begin_layout Plain Layout
15918 \begin_inset space \thinspace{}
15922 \begin_inset Flex Code
15925 \begin_layout Plain Layout
15931 ] Indicates whether the float is already defined in the document class or
15932 if instead the \SpecialChar LaTeX
15934 \begin_inset Flex Code
15937 \begin_layout Plain Layout
15943 needs to be loaded to define it on-the-fly.
15945 \begin_inset Flex Code
15948 \begin_layout Plain Layout
15955 \begin_inset Flex Code
15958 \begin_layout Plain Layout
15965 It should be set to
15966 \begin_inset Flex Code
15969 \begin_layout Plain Layout
15975 if the float is already defined by the \SpecialChar LaTeX
15979 \begin_layout Description
15980 \begin_inset Flex Code
15983 \begin_layout Plain Layout
15990 \begin_inset Flex Code
15993 \begin_layout Plain Layout
16000 \begin_inset Quotes erd
16004 \begin_inset Quotes erd
16007 ] The command used to generate a list of floats of this type; the leading
16016 \begin_inset Flex Code
16019 \begin_layout Plain Layout
16025 is false, since there is no standard way to generate this command.
16027 \begin_inset Flex Code
16030 \begin_layout Plain Layout
16036 is true, since in that case there is a standard way to define the command.
16039 \begin_layout Description
16040 \begin_inset Flex Code
16043 \begin_layout Plain Layout
16050 \begin_inset Flex Code
16053 \begin_layout Plain Layout
16060 \begin_inset Quotes erd
16064 \begin_inset Quotes erd
16067 ] A title for a list of floats of this kind (list of figures, tables, or
16069 It is used for the screen label within \SpecialChar LyX
16070 , it is used by \SpecialChar LaTeX
16072 it is used as the title in the XHTML output.
16073 It will be translated to the document language.
16076 \begin_layout Description
16077 \begin_inset Flex Code
16080 \begin_layout Plain Layout
16087 \begin_inset Flex Code
16090 \begin_layout Plain Layout
16097 \begin_inset Quotes erd
16101 \begin_inset Quotes erd
16104 ] This (optional) argument determines whether floats of this class will
16105 be numbered within some sectional unit of the document.
16107 \begin_inset Flex Code
16110 \begin_layout Plain Layout
16117 \begin_inset Quotes eld
16121 \begin_inset Flex Code
16124 \begin_layout Plain Layout
16131 \begin_inset Quotes erd
16134 , the floats will be numbered within chapters.
16138 \begin_layout Description
16139 \begin_inset Flex Code
16142 \begin_layout Plain Layout
16149 \begin_inset Flex Code
16152 \begin_layout Plain Layout
16159 \begin_inset Quotes erd
16163 \begin_inset Quotes erd
16166 ] The default placement for the given class of floats.
16167 The string should be as in standard \SpecialChar LaTeX
16169 \begin_inset Flex Code
16172 \begin_layout Plain Layout
16179 \begin_inset Flex Code
16182 \begin_layout Plain Layout
16189 \begin_inset Flex Code
16192 \begin_layout Plain Layout
16199 \begin_inset Flex Code
16202 \begin_layout Plain Layout
16208 for top, bottom, page, and here, respectively.
16212 \begin_layout Plain Layout
16213 Note that the order of these letters in the string is irrelevant, like in
16220 On top of that there is a new type,
16221 \begin_inset Flex Code
16224 \begin_layout Plain Layout
16230 , which does not really correspond to a float, since it means: put it
16231 \begin_inset Quotes eld
16235 \begin_inset Quotes erd
16239 Note however that the
16240 \begin_inset Flex Code
16243 \begin_layout Plain Layout
16249 specifier is special and, because of implementation details, cannot be
16250 used in non-built in float types.
16251 If you do not understand what this means, just use
16252 \begin_inset Quotes eld
16256 \begin_inset Flex Code
16259 \begin_layout Plain Layout
16266 \begin_inset Quotes erd
16272 \begin_layout Description
16273 \begin_inset Flex Code
16276 \begin_layout Plain Layout
16283 \begin_inset Flex Code
16286 \begin_layout Plain Layout
16292 ] The prefix to use when creating labels referring to floats of this type.
16293 This allows the use of formatted references.
16294 Note that you can remove any
16295 \begin_inset Flex Code
16298 \begin_layout Plain Layout
16304 set by a copied style by using the special value
16305 \begin_inset Quotes eld
16309 \begin_inset Quotes erd
16312 , which must be all caps.
16315 \begin_layout Description
16316 \begin_inset Flex Code
16319 \begin_layout Plain Layout
16326 \begin_inset Flex Code
16329 \begin_layout Plain Layout
16336 \begin_inset Quotes erd
16340 \begin_inset Quotes erd
16343 ] The style used when defining the float using
16344 \begin_inset Flex Code
16347 \begin_layout Plain Layout
16358 \begin_layout Description
16359 \begin_inset Flex Code
16362 \begin_layout Plain Layout
16369 \begin_inset Flex Code
16372 \begin_layout Plain Layout
16379 \begin_inset Quotes erd
16383 \begin_inset Quotes erd
16387 \begin_inset Quotes eld
16391 \begin_inset Quotes erd
16394 of the new class of floats, like program or algorithm.
16395 After the appropriate
16396 \begin_inset Flex Code
16399 \begin_layout Plain Layout
16408 \begin_inset Flex Code
16411 \begin_layout Plain Layout
16420 \begin_inset Flex Code
16423 \begin_layout Plain Layout
16434 \begin_layout Description
16435 \begin_inset Flex Code
16438 \begin_layout Plain Layout
16445 \begin_inset Flex Code
16448 \begin_layout Plain Layout
16455 \begin_inset space \thinspace{}
16459 \begin_inset Flex Code
16462 \begin_layout Plain Layout
16470 ] Specifies whether this float is defined using the \SpecialChar LaTeX
16472 \begin_inset Flex Code
16475 \begin_layout Plain Layout
16481 , either by the class file, another package or on-the-fly by \SpecialChar LyX
16485 \begin_layout Standard
16486 Note that defining a float with type
16487 \begin_inset Flex Code
16490 \begin_layout Plain Layout
16498 automatically defines the corresponding counter with name
16499 \begin_inset Flex Code
16502 \begin_layout Plain Layout
16513 \begin_layout Subsection
16514 Flex insets and InsetLayout
16515 \begin_inset CommandInset label
16517 name "subsec:Flex-insets-and"
16524 \begin_layout Standard
16525 Flex insets come in three different kinds:
16528 \begin_layout Itemize
16530 \begin_inset Flex Code
16533 \begin_layout Plain Layout
16539 ): These define semantic markup corresponding to such \SpecialChar LaTeX
16541 \begin_inset Flex Code
16544 \begin_layout Plain Layout
16553 \begin_inset Flex Code
16556 \begin_layout Plain Layout
16567 \begin_layout Itemize
16569 \begin_inset Flex Code
16572 \begin_layout Plain Layout
16578 ): These can be used to define custom collapsible insets, similar to \SpecialChar TeX
16580 footnote, and the like.
16581 An obvious example is an endnote inset, which is defined in the
16582 \begin_inset Flex Code
16585 \begin_layout Plain Layout
16594 \begin_layout Itemize
16596 \begin_inset Flex Code
16599 \begin_layout Plain Layout
16605 ): For use with DocBook classes.
16608 \begin_layout Standard
16609 Flex insets are defined using the
16610 \begin_inset Flex Code
16613 \begin_layout Plain Layout
16619 tag, which shall be explained in a moment.
16622 \begin_layout Standard
16624 \begin_inset Flex Code
16627 \begin_layout Plain Layout
16633 tag also serves another function: It can be used to customize the general
16634 layout of many different types of insets.
16636 \begin_inset Flex Code
16639 \begin_layout Plain Layout
16645 can be used to customize the layout parameters for footnotes, marginal
16646 notes, note insets, \SpecialChar TeX
16647 code (ERT) insets, branches, listings, indexes, boxes,
16648 tables, algorithms, URLs, and captions, as well as to define Flex insets.
16651 \begin_layout Standard
16653 \begin_inset Flex Code
16656 \begin_layout Plain Layout
16662 definition must begin with a line of the form:
16665 \begin_layout LyX-Code
16669 \begin_layout Standard
16671 \begin_inset Flex Code
16674 \begin_layout Plain Layout
16680 indicates the inset whose layout is being defined, and here there are four
16684 \begin_layout Enumerate
16685 The layout for a pre-existing inset is being modified.
16686 In this case, can be
16687 \begin_inset Flex Code
16690 \begin_layout Plain Layout
16696 any one of the following:
16697 \begin_inset Flex Code
16700 \begin_layout Plain Layout
16707 \begin_inset Flex Code
16710 \begin_layout Plain Layout
16717 \begin_inset Flex Code
16720 \begin_layout Plain Layout
16727 \begin_inset Flex Code
16730 \begin_layout Plain Layout
16737 \begin_inset Flex Code
16740 \begin_layout Plain Layout
16747 \begin_inset Flex Code
16750 \begin_layout Plain Layout
16757 \begin_inset Flex Code
16760 \begin_layout Plain Layout
16767 \begin_inset Flex Code
16770 \begin_layout Plain Layout
16777 \begin_inset Flex Code
16780 \begin_layout Plain Layout
16787 \begin_inset Flex Code
16790 \begin_layout Plain Layout
16797 \begin_inset Flex Code
16800 \begin_layout Plain Layout
16807 \begin_inset Flex Code
16810 \begin_layout Plain Layout
16817 \begin_inset Flex Code
16820 \begin_layout Plain Layout
16827 \begin_inset Flex Code
16830 \begin_layout Plain Layout
16837 \begin_inset Flex Code
16840 \begin_layout Plain Layout
16847 \begin_inset Flex Code
16850 \begin_layout Plain Layout
16857 \begin_inset Flex Code
16860 \begin_layout Plain Layout
16867 \begin_inset Flex Code
16870 \begin_layout Plain Layout
16877 \begin_inset Flex Code
16880 \begin_layout Plain Layout
16887 \begin_inset Flex Code
16890 \begin_layout Plain Layout
16899 \begin_layout Enumerate
16900 The layout for a Flex inset is being defined.
16902 \begin_inset Flex Code
16905 \begin_layout Plain Layout
16911 must be of the form
16912 \begin_inset Quotes eld
16916 \begin_inset Flex Code
16919 \begin_layout Plain Layout
16926 \begin_inset Quotes erd
16930 \begin_inset Flex Code
16933 \begin_layout Plain Layout
16939 may be be any valid identifier not used by a pre-existing Flex inset.
16940 The identifier may include spaces, but in that case the whole thing must
16941 be wrapped in quotes.
16942 Note that the definition of a flex inset
16947 \begin_inset Flex Code
16950 \begin_layout Plain Layout
16956 entry, declaring which type of inset it defines.
16959 \begin_layout Enumerate
16960 The layout for user specific branch is being defined.
16962 \begin_inset Flex Code
16965 \begin_layout Plain Layout
16971 must be of the form
16972 \begin_inset Quotes eld
16976 \begin_inset Flex Code
16979 \begin_layout Plain Layout
16986 \begin_inset Quotes erd
16990 \begin_inset Flex Code
16993 \begin_layout Plain Layout
16999 may be be any valid identifier of branch defined in user's document.
17000 The identifier may include spaces, but in that case the whole thing must
17001 be wrapped in quotes.
17002 The main purpose of this feature is to allow \SpecialChar LaTeX
17003 wrapping around specific
17004 branches as user needs.
17007 \begin_layout Enumerate
17008 The layout of a user (or class) specific caption is being defined.
17010 \begin_inset Flex Code
17013 \begin_layout Plain Layout
17019 must be of the form
17020 \begin_inset Quotes eld
17024 \begin_inset Flex Code
17027 \begin_layout Plain Layout
17034 \begin_inset Quotes erd
17038 \begin_inset Flex Code
17041 \begin_layout Plain Layout
17047 specifies the name of the caption as it appears in the menu.
17048 Have a look at the standard caption (
17049 \begin_inset Flex Code
17052 \begin_layout Plain Layout
17058 ), the specific captions of the KOMA-Script classes (
17059 \begin_inset Flex Code
17062 \begin_layout Plain Layout
17069 \begin_inset Flex Code
17072 \begin_layout Plain Layout
17081 \begin_inset space ~
17087 \begin_inset Flex Code
17090 \begin_layout Plain Layout
17096 ) for applications.
17099 \begin_layout Standard
17101 \begin_inset Flex Code
17104 \begin_layout Plain Layout
17110 definition can contain the following entries:
17113 \begin_layout Description
17114 \begin_inset Flex Code
17117 \begin_layout Plain Layout
17124 \begin_inset Flex Code
17127 \begin_layout Plain Layout
17133 ] Defines argument number of a command\SpecialChar breakableslash
17134 environment associated with the current
17136 The definition must end with
17137 \begin_inset Flex Code
17140 \begin_layout Plain Layout
17148 \begin_inset CommandInset ref
17150 reference "subsec:Paragraph-Styles"
17157 \begin_layout Description
17158 \begin_inset Flex Code
17161 \begin_layout Plain Layout
17167 Preamble for changing language commands; see
17168 \begin_inset CommandInset ref
17170 reference "subsec:I18n"
17177 \begin_layout Description
17178 \begin_inset Flex Code
17181 \begin_layout Plain Layout
17188 \begin_inset Flex Code
17191 \begin_layout Plain Layout
17197 ] The color for the inset's background.
17199 \begin_inset CommandInset ref
17201 reference "chap:Names-of-colors"
17205 for a list of the available color names.
17208 \begin_layout Description
17209 \begin_inset Flex Code
17212 \begin_layout Plain Layout
17219 \begin_inset Flex Code
17222 \begin_layout Plain Layout
17231 \begin_inset space \thinspace{}
17235 \begin_inset Flex Code
17238 \begin_layout Plain Layout
17244 ] Whether to use the content of the inset as the label, when the inset is
17249 \begin_layout Description
17250 \begin_inset Flex Code
17253 \begin_layout Plain Layout
17260 \begin_inset Flex Code
17263 \begin_layout Plain Layout
17269 ] As with paragraph styles, see
17270 \begin_inset CommandInset ref
17272 reference "subsec:Paragraph-Styles"
17277 Note that you need to specify the complete type, e.
17278 \begin_inset space \thinspace{}
17282 \begin_inset space ~
17286 \begin_inset Flex Code
17289 \begin_layout Plain Layout
17290 CopyStyle Flex:<name>
17298 \begin_layout Description
17299 \begin_inset Flex Code
17302 \begin_layout Plain Layout
17309 \begin_inset Flex Code
17312 \begin_layout Plain Layout
17321 \begin_inset space \thinspace{}
17325 \begin_inset Flex Code
17328 \begin_layout Plain Layout
17334 ] Indicates whether the user may employ the Paragraph Settings dialog to
17335 customize the paragraph.
17338 \begin_layout Description
17339 \begin_inset Flex Code
17342 \begin_layout Plain Layout
17349 \begin_inset Flex Code
17352 \begin_layout Plain Layout
17359 \begin_inset Flex Code
17362 \begin_layout Plain Layout
17369 \begin_inset Flex Code
17372 \begin_layout Plain Layout
17378 , describing the rendering style used for the inset's frame and buttons.
17379 Footnotes generally use
17380 \begin_inset Flex Code
17383 \begin_layout Plain Layout
17389 , ERT insets generally
17390 \begin_inset Flex Code
17393 \begin_layout Plain Layout
17399 , and character styles
17400 \begin_inset Flex Code
17403 \begin_layout Plain Layout
17412 \begin_layout Description
17413 \begin_inset Flex Code
17416 \begin_layout Plain Layout
17423 \begin_inset Flex Code
17426 \begin_layout Plain Layout
17435 \begin_inset space \thinspace{}
17441 \begin_inset Flex Code
17444 \begin_layout Plain Layout
17453 \begin_inset Flex Code
17456 \begin_layout Plain Layout
17463 \begin_inset Flex Code
17466 \begin_layout Plain Layout
17473 Indicates whether the environment will stand on its own in the output or
17474 will appear inline with the surrounding text.
17475 If set to false, it is supposed that the \SpecialChar LaTeX
17476 environment ignores white space
17477 (including one newline character) after the
17478 \begin_inset Flex Code
17481 \begin_layout Plain Layout
17494 \begin_inset Flex Code
17497 \begin_layout Plain Layout
17513 \begin_layout Description
17514 \begin_inset Flex Code
17517 \begin_layout Plain Layout
17523 Required at the end of the
17524 \begin_inset Flex Code
17527 \begin_layout Plain Layout
17536 \begin_layout Description
17537 \begin_inset Flex Code
17540 \begin_layout Plain Layout
17546 The font used for both the text body
17552 \begin_inset CommandInset ref
17554 reference "subsec:Font-description"
17559 Note that defining this font automatically defines the
17560 \begin_inset Flex Code
17563 \begin_layout Plain Layout
17569 to the same value, so define this first and define
17570 \begin_inset Flex Code
17573 \begin_layout Plain Layout
17579 later if you want them to be different.
17582 \begin_layout Description
17583 \begin_inset Flex Code
17586 \begin_layout Plain Layout
17587 FixedWidthPreambleEncoding
17593 \begin_inset Flex Code
17596 \begin_layout Plain Layout
17605 \begin_inset space \thinspace{}
17609 \begin_inset Flex Code
17612 \begin_layout Plain Layout
17618 ] Force a fixed width encoding for the translated contents of
17619 \begin_inset Flex Code
17622 \begin_layout Plain Layout
17629 \begin_inset Flex Code
17632 \begin_layout Plain Layout
17638 code generated by this layout.
17639 This is needed for special \SpecialChar LaTeX
17644 that do not work with variable width encodings such as
17649 This setting is ignored if fully Unicode aware \SpecialChar LaTeX
17650 backends such as Xe\SpecialChar TeX
17652 Lua\SpecialChar TeX
17656 \begin_layout Description
17657 \begin_inset Flex Code
17660 \begin_layout Plain Layout
17661 ForceLocalFontSwitch
17667 \begin_inset Flex Code
17670 \begin_layout Plain Layout
17679 \begin_inset space \thinspace{}
17683 \begin_inset Flex Code
17686 \begin_layout Plain Layout
17692 ] When using babel, always use a local font switch (
17693 \begin_inset Flex Code
17696 \begin_layout Plain Layout
17704 ), never a global one (such as
17705 \begin_inset Flex Code
17708 \begin_layout Plain Layout
17719 \begin_layout Description
17720 \begin_inset Flex Code
17723 \begin_layout Plain Layout
17730 \begin_inset Flex Code
17733 \begin_layout Plain Layout
17742 \begin_inset space \thinspace{}
17746 \begin_inset Flex Code
17749 \begin_layout Plain Layout
17756 \begin_inset Quotes eld
17760 \begin_inset Quotes erd
17763 language, leading to Left-to-Right (Latin) output, e.
17764 \begin_inset space \thinspace{}
17768 \begin_inset space \space{}
17771 in \SpecialChar TeX
17776 \begin_layout Description
17777 \begin_inset Flex Code
17780 \begin_layout Plain Layout
17787 \begin_inset Flex Code
17790 \begin_layout Plain Layout
17799 \begin_inset space \thinspace{}
17803 \begin_inset Flex Code
17806 \begin_layout Plain Layout
17812 ] Force a a line break in the \SpecialChar LaTeX
17813 output before the inset starts and after
17815 This assures the inset itself is output on its own lines, for parsing purposes.
17818 \begin_layout Description
17819 \begin_inset Flex Code
17822 \begin_layout Plain Layout
17829 \begin_inset Flex Code
17832 \begin_layout Plain Layout
17841 \begin_inset space \thinspace{}
17845 \begin_inset Flex Code
17848 \begin_layout Plain Layout
17854 ] Indicates whether the
17855 \begin_inset Flex Code
17858 \begin_layout Plain Layout
17864 should be used or, instead, the user can change the paragraph style used
17869 \begin_layout Description
17870 \begin_inset Flex Code
17873 \begin_layout Plain Layout
17880 \begin_inset Flex Code
17883 \begin_layout Plain Layout
17892 \begin_inset space \thinspace{}
17896 \begin_inset Flex Code
17899 \begin_layout Plain Layout
17905 ] As with paragraph styles, see
17906 \begin_inset CommandInset ref
17908 reference "subsec:Paragraph-Styles"
17915 \begin_layout Description
17916 \begin_inset Flex Code
17919 \begin_layout Plain Layout
17925 These tags control the XHTML output.
17927 \begin_inset CommandInset ref
17929 reference "sec:Tags-for-XHTML"
17936 \begin_layout Description
17937 \begin_inset Flex Code
17940 \begin_layout Plain Layout
17947 \begin_inset Flex Code
17950 \begin_layout Plain Layout
17959 \begin_inset space \thinspace{}
17963 \begin_inset Flex Code
17966 \begin_layout Plain Layout
17972 ] Whether to include the contents of this inset in the strings generated
17973 for the `Outline' pane.
17974 One would not, for example, want the content of a footnote in a section
17975 header to be included in the TOC displayed in the outline, but one would
17976 normally want the content of a character style displayed.
17977 Default is false: not to include.
17980 \begin_layout Description
17981 \begin_inset Flex Code
17984 \begin_layout Plain Layout
17993 \begin_inset Flex Code
17996 \begin_layout Plain Layout
18005 \begin_inset space \thinspace{}
18009 \begin_inset Flex Code
18012 \begin_layout Plain Layout
18018 ] As with paragraph styles, see
18019 \begin_inset CommandInset ref
18021 reference "subsec:Paragraph-Styles"
18028 \begin_layout Description
18029 \begin_inset Flex Code
18032 \begin_layout Plain Layout
18038 The font used for the label.
18040 \begin_inset CommandInset ref
18042 reference "subsec:Font-description"
18047 Note that this definition can never appear before
18048 \begin_inset Flex Code
18051 \begin_layout Plain Layout
18057 , lest it be ineffective.
18060 \begin_layout Description
18061 \begin_inset Flex Code
18064 \begin_layout Plain Layout
18071 \begin_inset Flex Code
18074 \begin_layout Plain Layout
18081 \begin_inset Quotes erd
18085 \begin_inset Quotes erd
18088 ] What will be displayed on the button or elsewhere as the inset label.
18090 \begin_inset Flex Code
18093 \begin_layout Plain Layout
18101 \begin_inset Flex Code
18104 \begin_layout Plain Layout
18110 ) modify this label on the fly.
18113 \begin_layout Description
18114 \begin_inset Flex Code
18117 \begin_layout Plain Layout
18123 Language dependent preamble; see
18124 \begin_inset CommandInset ref
18126 reference "subsec:I18n"
18133 \begin_layout Description
18134 \begin_inset Flex Code
18137 \begin_layout Plain Layout
18144 \begin_inset Flex Code
18147 \begin_layout Plain Layout
18153 ] The name of the corresponding \SpecialChar LaTeX
18155 Either the environment or command name.
18158 \begin_layout Description
18159 \begin_inset Flex Code
18162 \begin_layout Plain Layout
18169 \begin_inset Flex Code
18172 \begin_layout Plain Layout
18178 ] The optional parameter for the corresponding
18179 \begin_inset Flex Code
18182 \begin_layout Plain Layout
18188 stuff, including possible bracket pairs like
18189 \begin_inset Flex Code
18192 \begin_layout Plain Layout
18199 This parameter cannot be changed from within \SpecialChar LyX
18201 \begin_inset Flex Code
18204 \begin_layout Plain Layout
18210 for customizable parameters).
18211 It will be output as is after all \SpecialChar LaTeX
18213 \begin_inset Flex Code
18216 \begin_layout Plain Layout
18225 \begin_layout Description
18226 \begin_inset Flex Code
18229 \begin_layout Plain Layout
18236 \begin_inset Flex Code
18239 \begin_layout Plain Layout
18240 Command, Environment, None
18245 ] How the style should be translated into \SpecialChar LaTeX
18250 \begin_layout Plain Layout
18251 \begin_inset Flex Code
18254 \begin_layout Plain Layout
18260 is perhaps a bit misleading, since these rules apply to SGML classes too.
18261 Visit the SGML class files for specific examples.
18267 \begin_inset Separator latexpar
18274 \begin_layout Description
18275 \begin_inset Flex Code
18278 \begin_layout Plain Layout
18284 means nothing special
18287 \begin_layout Description
18288 \begin_inset Flex Code
18291 \begin_layout Plain Layout
18298 \begin_inset Flex Code
18301 \begin_layout Plain Layout
18308 {\SpecialChar ldots
18317 \begin_layout Description
18318 \begin_inset Flex Code
18321 \begin_layout Plain Layout
18328 \begin_inset Flex Code
18331 \begin_layout Plain Layout
18338 }\SpecialChar ldots
18353 \begin_layout Standard
18354 Putting the last few things together, the \SpecialChar LaTeX
18355 output will be either:
18358 \begin_layout LyX-Code
18361 LatexName[LatexParam]{\SpecialChar ldots
18365 \begin_layout Standard
18369 \begin_layout LyX-Code
18372 begin{LatexName}[LatexParam] \SpecialChar ldots
18378 \begin_layout Standard
18379 depending upon the \SpecialChar LaTeX
18384 \begin_layout Description
18385 \begin_inset Flex Code
18388 \begin_layout Plain Layout
18395 \begin_inset Flex Code
18398 \begin_layout Plain Layout
18404 ] A string that is put at the beginning of the layout content.
18405 A line break in the output can be indicated by
18406 \begin_inset Flex Code
18409 \begin_layout Plain Layout
18418 \begin_layout Description
18419 \begin_inset Flex Code
18422 \begin_layout Plain Layout
18429 \begin_inset Flex Code
18432 \begin_layout Plain Layout
18439 \begin_inset Flex Code
18442 \begin_layout Plain Layout
18449 \begin_inset Flex Code
18452 \begin_layout Plain Layout
18459 \begin_inset Flex Code
18462 \begin_layout Plain Layout
18468 (indicating a dummy definition ending definitions of charstyles, etc).
18469 This entry is required in and is only meaningful for Flex insets.
18470 Among other things, it determines on which menu this inset will appear.
18472 \begin_inset Flex Code
18475 \begin_layout Plain Layout
18482 \begin_inset Flex Code
18485 \begin_layout Plain Layout
18491 will automatically set
18492 \begin_inset Flex Code
18495 \begin_layout Plain Layout
18502 \begin_inset Flex Code
18505 \begin_layout Plain Layout
18513 \begin_inset Flex Code
18516 \begin_layout Plain Layout
18522 can be set to true, or
18523 \begin_inset Flex Code
18526 \begin_layout Plain Layout
18533 \begin_inset Flex Code
18536 \begin_layout Plain Layout
18542 insets by setting it
18547 \begin_inset Flex Code
18550 \begin_layout Plain Layout
18559 \begin_layout Description
18560 \begin_inset Flex Code
18563 \begin_layout Plain Layout
18570 \begin_inset Flex Code
18573 \begin_layout Plain Layout
18582 \begin_inset space \thinspace{}
18586 \begin_inset Flex Code
18589 \begin_layout Plain Layout
18595 ] Whether multiple paragraphs are permitted in this inset.
18597 \begin_inset Flex Code
18600 \begin_layout Plain Layout
18606 to the same value and
18607 \begin_inset Flex Code
18610 \begin_layout Plain Layout
18616 to the opposite value.
18617 These can be reset to other values, if they are used
18622 \begin_inset Flex Code
18625 \begin_layout Plain Layout
18635 \begin_layout Description
18636 \begin_inset Flex Code
18639 \begin_layout Plain Layout
18646 \begin_inset Flex Code
18649 \begin_layout Plain Layout
18658 \begin_inset space \thinspace{}
18662 \begin_inset Flex Code
18665 \begin_layout Plain Layout
18671 ] Whether fragile commands in this inset should be
18672 \begin_inset Flex Code
18675 \begin_layout Plain Layout
18688 whether the command should itself be protected.) Default is false.
18691 \begin_layout Description
18692 \begin_inset Flex Code
18695 \begin_layout Plain Layout
18702 \begin_inset Flex Code
18705 \begin_layout Plain Layout
18711 ] Deletes an existing
18712 \begin_inset Flex Code
18715 \begin_layout Plain Layout
18724 \begin_layout Description
18725 \begin_inset Flex Code
18728 \begin_layout Plain Layout
18735 \begin_inset Flex Code
18738 \begin_layout Plain Layout
18745 \begin_inset Flex Code
18748 \begin_layout Plain Layout
18754 that has replaced this
18755 \begin_inset Flex Code
18758 \begin_layout Plain Layout
18765 This is used to rename an
18766 \begin_inset Flex Code
18769 \begin_layout Plain Layout
18775 , while keeping backward compatibility.
18778 \begin_layout Description
18779 \begin_inset Flex Code
18782 \begin_layout Plain Layout
18789 \begin_inset Flex Code
18792 \begin_layout Plain Layout
18801 \begin_inset space \thinspace{}
18805 \begin_inset Flex Code
18808 \begin_layout Plain Layout
18814 ] As with paragraph styles, see
18815 \begin_inset CommandInset ref
18817 reference "subsec:Paragraph-Styles"
18825 \begin_layout Description
18826 \begin_inset Flex Code
18829 \begin_layout Plain Layout
18836 \begin_inset Flex Code
18839 \begin_layout Plain Layout
18848 \begin_inset space \thinspace{}
18852 \begin_inset Flex Code
18855 \begin_layout Plain Layout
18861 ] As with paragraph styles, see
18862 \begin_inset CommandInset ref
18864 reference "subsec:Paragraph-Styles"
18872 \begin_layout Description
18873 \begin_inset Flex Code
18876 \begin_layout Plain Layout
18882 As with paragraph styles, see
18883 \begin_inset CommandInset ref
18885 reference "subsec:Paragraph-Styles"
18892 \begin_layout Description
18893 \begin_inset Flex Code
18896 \begin_layout Plain Layout
18903 \begin_inset Flex Code
18906 \begin_layout Plain Layout
18912 ] The prefix to use when creating labels referring to insets of this type.
18913 This allows the use of formatted references.
18916 \begin_layout Description
18917 \begin_inset Flex Code
18920 \begin_layout Plain Layout
18927 \begin_inset Flex Code
18930 \begin_layout Plain Layout
18936 ] As with paragraph styles, see
18937 \begin_inset CommandInset ref
18939 reference "subsec:Paragraph-Styles"
18946 \begin_layout Description
18947 \begin_inset Flex Code
18950 \begin_layout Plain Layout
18957 \begin_inset Flex Code
18960 \begin_layout Plain Layout
18969 \begin_inset space \thinspace{}
18973 \begin_inset Flex Code
18976 \begin_layout Plain Layout
18982 ] Resets the \SpecialChar LaTeX
18983 arguments of this layout (as defined via the
18984 \begin_inset Flex Code
18987 \begin_layout Plain Layout
18994 This is useful if you have copied a style via
18995 \begin_inset Flex Code
18998 \begin_layout Plain Layout
19004 , but you do not want to inherit its (required and optional) arguments.
19007 \begin_layout Description
19008 \begin_inset Flex Code
19011 \begin_layout Plain Layout
19018 \begin_inset Flex Code
19021 \begin_layout Plain Layout
19028 \begin_inset space \thinspace{}
19032 \begin_inset Flex Code
19035 \begin_layout Plain Layout
19043 ] Whether this inset should use the font of its surrounding environment
19045 Default is false: use the font of the surrounding environment.
19048 \begin_layout Description
19049 \begin_inset Flex Code
19052 \begin_layout Plain Layout
19059 \begin_inset Flex Code
19062 \begin_layout Plain Layout
19068 ] A string that is put at the end of the layout content.
19069 A line break in the output can be indicated by
19070 \begin_inset Flex Code
19073 \begin_layout Plain Layout
19082 \begin_layout Description
19083 \begin_inset Flex Code
19086 \begin_layout Plain Layout
19093 \begin_inset Flex Code
19096 \begin_layout Plain Layout
19103 \begin_inset space \thinspace{}
19107 \begin_inset Flex Code
19110 \begin_layout Plain Layout
19118 ] Allow spell-checking the contents of this inset.
19122 \begin_layout Subsection
19124 \begin_inset CommandInset label
19126 name "subsec:Counters"
19133 \begin_layout Standard
19134 It is necessary to define the counters (
19135 \begin_inset Flex Noun
19138 \begin_layout Plain Layout
19145 \begin_inset Flex Noun
19148 \begin_layout Plain Layout
19154 , \SpecialChar ldots
19155 ) in the text class itself.
19156 The standard counters are defined in the file
19157 \begin_inset Flex Code
19160 \begin_layout Plain Layout
19166 , so you may have to do no more than add
19169 \begin_layout LyX-Code
19170 Input stdcounters.inc
19173 \begin_layout Standard
19174 to your layout file to get them to work.
19175 But if you want to define custom counters, then you can do so.
19176 The counter declaration must begin with:
19179 \begin_layout LyX-Code
19180 Counter CounterName
19183 \begin_layout Standard
19185 \begin_inset Flex Code
19188 \begin_layout Plain Layout
19194 ' is replaced by the name of the counter.
19195 And it must end with
19196 \begin_inset Quotes eld
19200 \begin_inset Flex Code
19203 \begin_layout Plain Layout
19210 \begin_inset Quotes erd
19214 The following parameters can also be used:
19217 \begin_layout Description
19218 \begin_inset Flex Code
19221 \begin_layout Plain Layout
19228 \begin_inset Flex Code
19231 \begin_layout Plain Layout
19237 ] Sets the initial value for the counter, to which it will be reset whenever
19239 Normally, one will want the default, 1.
19242 \begin_layout Description
19243 \begin_inset Flex Code
19246 \begin_layout Plain Layout
19253 \begin_inset Flex Code
19256 \begin_layout Plain Layout
19263 \begin_inset Quotes erd
19267 \begin_inset Quotes erd
19270 ] When defined, this string defines how the counter is displayed.
19271 Setting this value sets
19272 \begin_inset Flex Code
19275 \begin_layout Plain Layout
19276 LabelStringAppendix
19282 The following special constructs can be used in the string:
19283 \begin_inset Separator latexpar
19290 \begin_layout Itemize
19291 \begin_inset Flex Code
19294 \begin_layout Plain Layout
19302 will be replaced by the expansion of the
19303 \begin_inset Flex Code
19306 \begin_layout Plain Layout
19313 \begin_inset Flex Code
19316 \begin_layout Plain Layout
19317 LabelStringAppendix
19323 \begin_inset Flex Code
19326 \begin_layout Plain Layout
19336 \begin_layout Itemize
19337 counter values can be expressed using \SpecialChar LaTeX
19339 \begin_inset Newline newline
19343 \begin_inset Flex Code
19346 \begin_layout Plain Layout
19363 \begin_inset Flex Code
19366 \begin_layout Plain Layout
19378 \begin_layout Plain Layout
19388 Actually, the situation is a bit more complicated: any
19407 other than those described below will produce arabic numerals.
19408 It would not be surprising to see this change in the future.
19414 \begin_inset Flex Code
19417 \begin_layout Plain Layout
19423 : 1, 2, 3,\SpecialChar ldots
19425 \begin_inset Flex Code
19428 \begin_layout Plain Layout
19434 for lower-case letters: a, b, c, \SpecialChar ldots
19436 \begin_inset Flex Code
19439 \begin_layout Plain Layout
19445 for upper-case letters: A, B, C, \SpecialChar ldots
19447 \begin_inset Flex Code
19450 \begin_layout Plain Layout
19456 for lower-case roman numerals: i, ii, iii, \SpecialChar ldots
19458 \begin_inset Flex Code
19461 \begin_layout Plain Layout
19467 for upper-case roman numerals: I, II, III\SpecialChar ldots
19469 \begin_inset Flex Code
19472 \begin_layout Plain Layout
19478 for hebrew numerals.
19482 \begin_layout Standard
19483 If LabelString is not defined, a default value is constructed as follows:
19484 if the counter has a master counter
19485 \begin_inset Flex Code
19488 \begin_layout Plain Layout
19495 \begin_inset Flex Code
19498 \begin_layout Plain Layout
19505 \begin_inset Newline newline
19509 \begin_inset Flex Code
19512 \begin_layout Plain Layout
19522 is used; otherwise the string
19523 \begin_inset Flex Code
19526 \begin_layout Plain Layout
19537 \begin_layout Description
19538 \begin_inset Flex Code
19541 \begin_layout Plain Layout
19542 LabelStringAppendix
19548 \begin_inset Flex Code
19551 \begin_layout Plain Layout
19558 \begin_inset Quotes erd
19562 \begin_inset Quotes erd
19566 \begin_inset Flex Code
19569 \begin_layout Plain Layout
19575 , but for use in the Appendix.
19578 \begin_layout Description
19579 \begin_inset Flex Code
19582 \begin_layout Plain Layout
19589 \begin_inset Flex Code
19592 \begin_layout Plain Layout
19599 \begin_inset Quotes erd
19603 \begin_inset Quotes erd
19606 ] A format for use with formatted references to this counter.
19607 For example, one might want to have references to section numbers appear
19609 \begin_inset Quotes eld
19613 \begin_inset Quotes erd
19617 The string should contain
19618 \begin_inset Quotes eld
19622 \begin_inset Quotes erd
19626 This will be replaced by the counter number itself.
19627 So, for sections, it would be: Section ##.
19630 \begin_layout Description
19631 \begin_inset Flex Code
19634 \begin_layout Plain Layout
19641 \begin_inset Flex Code
19644 \begin_layout Plain Layout
19651 \begin_inset Quotes erd
19655 \begin_inset Quotes erd
19658 ] If this is set to the name of another counter, the present counter will
19659 be reset every time the other one is increased.
19661 \begin_inset Flex Code
19664 \begin_layout Plain Layout
19671 \begin_inset Flex Code
19674 \begin_layout Plain Layout
19683 \begin_layout Subsection
19685 \begin_inset CommandInset label
19687 name "subsec:Font-description"
19694 \begin_layout Standard
19695 A font description looks like this:
19698 \begin_layout LyX-Code
19712 \begin_layout LyX-Code
19716 \begin_layout LyX-Code
19720 \begin_layout Standard
19721 The following commands are available:
19724 \begin_layout Description
19725 \begin_inset Flex Code
19728 \begin_layout Plain Layout
19735 \begin_inset Flex Code
19738 \begin_layout Plain Layout
19747 \begin_inset Flex Code
19750 \begin_layout Plain Layout
19757 \begin_inset Flex Code
19760 \begin_layout Plain Layout
19767 \begin_inset Flex Code
19770 \begin_layout Plain Layout
19777 \begin_inset Flex Code
19780 \begin_layout Plain Layout
19787 \begin_inset Flex Code
19790 \begin_layout Plain Layout
19797 \begin_inset Flex Code
19800 \begin_layout Plain Layout
19807 \begin_inset Flex Code
19810 \begin_layout Plain Layout
19817 \begin_inset Flex Code
19820 \begin_layout Plain Layout
19827 \begin_inset Flex Code
19830 \begin_layout Plain Layout
19837 \begin_inset Flex Code
19840 \begin_layout Plain Layout
19847 \begin_inset Flex Code
19850 \begin_layout Plain Layout
19857 \begin_inset Flex Code
19860 \begin_layout Plain Layout
19867 \begin_inset Flex Code
19870 \begin_layout Plain Layout
19877 \begin_inset Flex Code
19880 \begin_layout Plain Layout
19887 \begin_inset Flex Code
19890 \begin_layout Plain Layout
19897 \begin_inset Flex Code
19900 \begin_layout Plain Layout
19907 \begin_inset Flex Code
19910 \begin_layout Plain Layout
19917 \begin_inset Flex Code
19920 \begin_layout Plain Layout
19927 \begin_inset Flex Code
19930 \begin_layout Plain Layout
19939 \begin_layout Description
19940 \begin_inset Flex Code
19943 \begin_layout Plain Layout
19950 \begin_inset Flex Code
19953 \begin_layout Plain Layout
19962 \begin_inset Flex Code
19965 \begin_layout Plain Layout
19972 \begin_inset Flex Code
19975 \begin_layout Plain Layout
19984 \begin_layout Description
19985 \begin_inset Flex Code
19988 \begin_layout Plain Layout
19995 \begin_inset Flex Code
19998 \begin_layout Plain Layout
20004 ] Valid arguments are:
20005 \begin_inset Flex Code
20008 \begin_layout Plain Layout
20015 \begin_inset Flex Code
20018 \begin_layout Plain Layout
20025 \begin_inset Flex Code
20028 \begin_layout Plain Layout
20035 \begin_inset Flex Code
20038 \begin_layout Plain Layout
20045 \begin_inset Flex Code
20048 \begin_layout Plain Layout
20055 \begin_inset Flex Code
20058 \begin_layout Plain Layout
20065 \begin_inset Flex Code
20068 \begin_layout Plain Layout
20075 \begin_inset Flex Code
20078 \begin_layout Plain Layout
20085 \begin_inset Flex Code
20088 \begin_layout Plain Layout
20095 \begin_inset Flex Code
20098 \begin_layout Plain Layout
20105 \begin_inset Flex Code
20108 \begin_layout Plain Layout
20115 \begin_inset Flex Code
20118 \begin_layout Plain Layout
20125 Each of these turns on or off the corresponding attribute.
20127 \begin_inset Flex Code
20130 \begin_layout Plain Layout
20136 turns on emphasis, and
20137 \begin_inset Flex Code
20140 \begin_layout Plain Layout
20148 \begin_inset Newline newline
20151 If the latter seems puzzling, remember that the font settings for the present
20152 context are generally inherited from the surrounding context.
20154 \begin_inset Flex Code
20157 \begin_layout Plain Layout
20163 would turn off the emphasis that was anyway in effect, say, in a theorem
20167 \begin_layout Description
20168 \begin_inset Flex Code
20171 \begin_layout Plain Layout
20178 \begin_inset Flex Code
20181 \begin_layout Plain Layout
20190 \begin_inset Flex Code
20193 \begin_layout Plain Layout
20202 \begin_layout Description
20203 \begin_inset Flex Code
20206 \begin_layout Plain Layout
20213 \begin_inset Flex Code
20216 \begin_layout Plain Layout
20225 \begin_inset Flex Code
20228 \begin_layout Plain Layout
20235 \begin_inset Flex Code
20238 \begin_layout Plain Layout
20245 \begin_inset Flex Code
20248 \begin_layout Plain Layout
20257 \begin_layout Description
20258 \begin_inset Flex Code
20261 \begin_layout Plain Layout
20268 \begin_inset Flex Code
20271 \begin_layout Plain Layout
20278 \begin_inset Flex Code
20281 \begin_layout Plain Layout
20288 \begin_inset Flex Code
20291 \begin_layout Plain Layout
20300 \begin_inset Flex Code
20303 \begin_layout Plain Layout
20310 \begin_inset Flex Code
20313 \begin_layout Plain Layout
20320 \begin_inset Flex Code
20323 \begin_layout Plain Layout
20330 \begin_inset Flex Code
20333 \begin_layout Plain Layout
20340 \begin_inset Flex Code
20343 \begin_layout Plain Layout
20352 \begin_layout Subsection
20353 \begin_inset CommandInset label
20355 name "subsec:Citation-format-description"
20359 Citation format description
20362 \begin_layout Standard
20364 \begin_inset Flex Code
20367 \begin_layout Plain Layout
20373 blocks are used to describe how bibliographic information should be displayed,
20374 both within \SpecialChar LyX
20375 itself (in the citation dialog and in tooltips, for example)
20376 and in XHTML output.
20377 Such a block might look like this:
20380 \begin_layout LyX-Code
20384 \begin_layout LyX-Code
20388 \begin_layout LyX-Code
20392 \begin_layout LyX-Code
20396 \begin_layout Standard
20397 The individual lines define how the bibliographic information associated
20398 with an article or book, respectively, is to be displayed, and such a definitio
20399 n can be given for any `entry type' that might be present in a Bib\SpecialChar TeX
20402 defines a default format in the source code that will be used if no specific
20403 definition has been given.
20405 predefines several formats in the file
20406 \begin_inset Flex Code
20409 \begin_layout Plain Layout
20415 , which is included in most of \SpecialChar LyX
20416 's document classes.
20419 \begin_layout Standard
20420 The definitions use a simple language that allows Bib\SpecialChar TeX
20421 keys to be replaced
20423 Keys should be enclosed in
20424 \begin_inset Flex Code
20427 \begin_layout Plain Layout
20434 \begin_inset Flex Code
20437 \begin_layout Plain Layout
20444 So a simple definition might look like this:
20447 \begin_layout LyX-Code
20449 \begin_inset Quotes eld
20453 \begin_inset Quotes erd
20459 \begin_layout Standard
20460 This would print the author, followed by a comma, followed by the title,
20461 in quotes, followed by a period.
20464 \begin_layout Standard
20465 Of course, sometimes you may want to print a key only if it exists.
20466 This can be done by using a conditional construction, such as:
20467 \begin_inset Flex Code
20470 \begin_layout Plain Layout
20472 \begin_inset space ~
20482 \begin_inset Flex Code
20485 \begin_layout Plain Layout
20491 key exists, then print
20492 \begin_inset Quotes eld
20496 \begin_inset space ~
20500 \begin_inset Quotes erd
20503 followed by the volume key.
20504 It is also possible to have an else clause in the conditional, such as:
20505 \begin_inset Newline newline
20509 \begin_inset Flex Code
20512 \begin_layout Plain Layout
20513 {%author%[[%author%]][[%editor%, ed.]]}
20519 \begin_inset Newline newline
20523 \begin_inset Flex Code
20526 \begin_layout Plain Layout
20532 key is printed if it exists; otherwise, the editor key is printed, followed
20534 \begin_inset Quotes eld
20538 \begin_inset space ~
20542 \begin_inset Quotes erd
20545 Note that the key is again enclosed in
20546 \begin_inset Flex Code
20549 \begin_layout Plain Layout
20555 signs; the entire conditional is enclosed in braces; and the if and else
20556 clauses are enclosed in double brackets,
20557 \begin_inset Quotes eld
20561 \begin_inset Flex Code
20564 \begin_layout Plain Layout
20571 \begin_inset Quotes eld
20575 \begin_inset Quotes eld
20579 \begin_inset Flex Code
20582 \begin_layout Plain Layout
20589 \begin_inset Quotes erd
20593 There must be no space between any of these.
20596 \begin_layout Standard
20597 There is one other piece of syntax available in definitions, which looks
20599 \begin_inset Flex Code
20602 \begin_layout Plain Layout
20609 This defines a piece of formatting information that is to be used when
20611 \begin_inset Quotes eld
20615 \begin_inset Quotes erd
20619 Obviously, we do not want to output HTML tags when writing plain text,
20620 so they should be wrapped in
20621 \begin_inset Quotes eld
20625 \begin_inset Quotes erd
20629 \begin_inset Quotes eld
20633 \begin_inset Quotes erd
20639 \begin_layout Standard
20640 Two special sorts of definitions are also possible in a
20641 \begin_inset Flex Code
20644 \begin_layout Plain Layout
20651 An example of the first would be:
20654 \begin_layout LyX-Code
20656 \begin_inset Quotes eld
20660 \begin_inset Quotes erd
20666 \begin_layout Standard
20667 This is an abbreviation, or macro, and it can be used by treating it as
20669 \begin_inset Flex Code
20672 \begin_layout Plain Layout
20681 \begin_inset Flex Code
20684 \begin_layout Plain Layout
20690 exactly as it would treat its definition.
20691 So, let us issue the obvious
20699 \begin_layout LyX-Code
20703 \begin_layout Standard
20704 or anything like it.
20706 shouldn't go into an infinite loop, but it may go into a long one before
20710 \begin_layout Standard
20711 The second sort of special definition might look like this:
20714 \begin_layout LyX-Code
20718 \begin_layout Standard
20719 This defines a translatable piece of text, which allows relevant parts of
20720 the bibliography to be translated.
20721 It can be included in a definition by treating it as a key:
20722 \begin_inset Flex Code
20725 \begin_layout Plain Layout
20732 Several of these are predefined in
20733 \begin_inset Flex Code
20736 \begin_layout Plain Layout
20743 Note that these are not macros, in the sense just defined.
20744 They will not be expanded.
20747 \begin_layout Standard
20748 So here then is an example that use all these features:
20749 \begin_inset VSpace defskip
20755 \begin_layout Standard
20759 !authoredit {%author%[[%author%, ]][[{%editor%[[%editor%, %_edtext%, ]]}]]}
20762 \begin_layout Standard
20763 \begin_inset VSpace defskip
20766 This defines a macro that prints the author, followed by a comma, if the
20768 \begin_inset Flex Code
20771 \begin_layout Plain Layout
20777 key is defined, or else prints the name of the editor, followed by the
20779 \begin_inset Flex Code
20782 \begin_layout Plain Layout
20788 or its translation (it is by default
20789 \begin_inset Quotes eld
20793 \begin_inset Quotes erd
20797 \begin_inset Flex Code
20800 \begin_layout Plain Layout
20807 Note that this is in fact defined in
20808 \begin_inset Flex Code
20811 \begin_layout Plain Layout
20817 , so you can use it in your own definitions, or re-definitions, if you load
20821 \begin_layout Section
20822 \begin_inset CommandInset label
20824 name "sec:Tags-for-XHTML"
20828 Tags for XHTML output
20831 \begin_layout Standard
20832 As with \SpecialChar LaTeX
20833 or DocBook, the format of \SpecialChar LyX
20834 's XHTML output is also controlled by
20835 layout information.
20836 In general, \SpecialChar LyX
20837 provides sensible defaults and, as mentioned earlier, it will
20838 even construct default CSS style rules from the other layout tags.
20839 For example, \SpecialChar LyX
20840 will attempt to use the information provided in the
20841 \begin_inset Flex Code
20844 \begin_layout Plain Layout
20850 declaration for the Chapter style to write CSS that will appropriately
20851 format chapter headings.
20854 \begin_layout Standard
20855 In many cases, then, you may not have to do anything at all to get acceptable
20856 XHTML output for your own environments, custom insets, and so forth.
20857 But in some cases you will, and so \SpecialChar LyX
20858 provides a number of layout tags that
20859 can be used to customize the XHTML and CSS that are generated.
20862 \begin_layout Standard
20863 Note that there are two tags,
20864 \begin_inset Flex Code
20867 \begin_layout Plain Layout
20874 \begin_inset Flex Code
20877 \begin_layout Plain Layout
20883 that may appear outside style and inset declarations.
20885 \begin_inset CommandInset ref
20887 reference "subsec:General-text-class"
20891 for details on these.
20894 \begin_layout Subsection
20895 \begin_inset CommandInset label
20897 name "subsec:Paragraph-Style-XHTML"
20904 \begin_layout Standard
20905 The sort of XHTML \SpecialChar LyX
20906 outputs for a paragraph depends upon whether we are dealing
20907 with a normal paragraph, a command, or an environment, where this is itself
20908 determined by the contents of the corresponding
20909 \begin_inset Flex Code
20912 \begin_layout Plain Layout
20923 \begin_layout Standard
20924 For a command or normal paragraph, the output XHTML has the following form:
20927 \begin_layout LyX-Code
20929 \begin_inset Quotes erd
20933 \begin_inset Quotes erd
20939 \begin_layout LyX-Code
20941 \begin_inset Quotes erd
20945 \begin_inset Quotes erd
20951 \begin_layout LyX-Code
20952 Contents of the paragraph.
20955 \begin_layout LyX-Code
20959 \begin_layout Standard
20960 The label tags are of course omitted if the paragraph does not have a label.
20963 \begin_layout Standard
20964 For an environment that is not some sort of list, the XHTML takes this form:
20967 \begin_layout LyX-Code
20969 \begin_inset Quotes erd
20973 \begin_inset Quotes erd
20979 \begin_layout LyX-Code
20981 \begin_inset Quotes erd
20985 \begin_inset Quotes erd
20989 \begin_inset Quotes erd
20993 \begin_inset Quotes erd
20996 >Environment Label</labeltag>First paragraph.</itemtag>
20999 \begin_layout LyX-Code
21000 <itemtag>Second paragraph.</itemtag>
21003 \begin_layout LyX-Code
21007 \begin_layout Standard
21008 Note that the label is output only for the first paragraph, as it should
21009 be for a theorem, for example.
21013 \begin_layout Standard
21014 For a list, we have one of these forms:
21017 \begin_layout LyX-Code
21019 \begin_inset Quotes erd
21023 \begin_inset Quotes erd
21029 \begin_layout LyX-Code
21031 \begin_inset Quotes erd
21035 \begin_inset Quotes erd
21039 \begin_inset Quotes erd
21043 \begin_inset Quotes erd
21046 >List Label</labeltag>First item.</itemtag>
21049 \begin_layout LyX-Code
21051 \begin_inset Quotes erd
21055 \begin_inset Quotes erd
21059 \begin_inset Quotes erd
21063 \begin_inset Quotes erd
21066 >List Label</labeltag>Second item.</itemtag>
21069 \begin_layout LyX-Code
21073 \begin_layout LyX-Code
21077 \begin_layout LyX-Code
21079 \begin_inset Quotes erd
21083 \begin_inset Quotes erd
21089 \begin_layout LyX-Code
21091 \begin_inset Quotes erd
21095 \begin_inset Quotes erd
21098 >List Label</labeltag><itemtag attr=
21099 \begin_inset Quotes erd
21103 \begin_inset Quotes erd
21106 >First item.</itemtag>
21109 \begin_layout LyX-Code
21111 \begin_inset Quotes erd
21115 \begin_inset Quotes erd
21118 >List Label</labeltag><itemtag attr=
21119 \begin_inset Quotes erd
21123 \begin_inset Quotes erd
21126 >Second item.</itemtag>
21129 \begin_layout LyX-Code
21133 \begin_layout Standard
21134 Note the different orders of
21135 \begin_inset Flex Code
21138 \begin_layout Plain Layout
21145 \begin_inset Flex Code
21148 \begin_layout Plain Layout
21155 Which order we get depends upon the setting of
21156 \begin_inset Flex Code
21159 \begin_layout Plain Layout
21166 \begin_inset Flex Code
21169 \begin_layout Plain Layout
21175 is false (the default), you get the first of these, with the label within
21176 the item; if true, you get the second, with the label outside the item.
21179 \begin_layout Standard
21180 The specific tags and attributes output for each paragraph type can be controlle
21181 d by means of the layout tags we are about to describe.
21182 As mentioned earlier, however, \SpecialChar LyX
21183 uses sensible defaults for many of these,
21184 so you often may not need to do very much to get good XHTML output.
21185 Think of the available tags as there so you can tweak things to your liking.
21188 \begin_layout Description
21189 \begin_inset Flex Code
21192 \begin_layout Plain Layout
21199 \begin_inset Flex Code
21202 \begin_layout Plain Layout
21208 ] Specifies attribute information to be output with the main tag.
21210 \begin_inset Quotes eld
21214 \begin_inset Flex Code
21217 \begin_layout Plain Layout
21224 \begin_inset Quotes erd
21228 By default, \SpecialChar LyX
21230 \begin_inset Quotes eld
21234 \begin_inset Flex Code
21237 \begin_layout Plain Layout
21244 \begin_inset Quotes erd
21248 \begin_inset Flex Code
21251 \begin_layout Plain Layout
21257 is the \SpecialChar LyX
21258 name of the layout, made lowercase, for example: chapter.
21263 contain any style information.
21265 \begin_inset Flex Code
21268 \begin_layout Plain Layout
21277 \begin_layout Description
21278 \begin_inset Flex Code
21281 \begin_layout Plain Layout
21288 \begin_inset Flex Code
21291 \begin_layout Plain Layout
21301 ] Whether to output the default CSS information \SpecialChar LyX
21302 generates for this layout,
21303 even if additional information is explicitly provided via
21304 \begin_inset Flex Code
21307 \begin_layout Plain Layout
21315 \begin_inset Flex Code
21318 \begin_layout Plain Layout
21324 allows you to alter or augment the generated CSS, rather than to override
21327 \begin_inset Flex Code
21330 \begin_layout Plain Layout
21339 \begin_layout Description
21340 \begin_inset Flex Code
21343 \begin_layout Plain Layout
21350 \begin_inset Flex Code
21353 \begin_layout Plain Layout
21359 ] The tag to be used for individual paragraphs of environments, replacing
21361 \begin_inset Flex Code
21364 \begin_layout Plain Layout
21370 in the examples above.
21372 \begin_inset Flex Code
21375 \begin_layout Plain Layout
21384 \begin_layout Description
21385 \begin_inset Flex Code
21388 \begin_layout Plain Layout
21395 \begin_inset Flex Code
21398 \begin_layout Plain Layout
21404 ] Attributes for the item tag.
21406 \begin_inset Quotes eld
21410 \begin_inset Flex Code
21413 \begin_layout Plain Layout
21414 class=`layoutname_item'
21420 \begin_inset Quotes erd
21428 contain any style information.
21430 \begin_inset Flex Code
21433 \begin_layout Plain Layout
21442 \begin_layout Description
21443 \begin_inset Flex Code
21446 \begin_layout Plain Layout
21453 \begin_inset Flex Code
21456 \begin_layout Plain Layout
21462 ] The tag to be used for paragraph and item labels, replacing
21463 \begin_inset Flex Code
21466 \begin_layout Plain Layout
21472 in the examples above.
21474 \begin_inset Flex Code
21477 \begin_layout Plain Layout
21484 \begin_inset Flex Code
21487 \begin_layout Plain Layout
21494 \begin_inset Flex Code
21497 \begin_layout Plain Layout
21504 \begin_inset Flex Code
21507 \begin_layout Plain Layout
21508 Centered_Top_Environment
21513 , in which case it defaults to
21514 \begin_inset Flex Code
21517 \begin_layout Plain Layout
21526 \begin_layout Description
21527 \begin_inset Flex Code
21530 \begin_layout Plain Layout
21537 \begin_inset Flex Code
21540 \begin_layout Plain Layout
21546 ] Attributes for the label tag.
21548 \begin_inset Quotes eld
21552 \begin_inset Flex Code
21555 \begin_layout Plain Layout
21556 class=`layoutname_label'
21562 \begin_inset Quotes erd
21570 contain any style information.
21572 \begin_inset Flex Code
21575 \begin_layout Plain Layout
21584 \begin_layout Description
21585 \begin_inset Flex Code
21588 \begin_layout Plain Layout
21595 \begin_inset Flex Code
21598 \begin_layout Plain Layout
21608 ] Meaningful only for list-like environments, this tag controls whether
21609 the label tag is output before or inside the item tag.
21610 This is used, for example, in the description environment, where we want
21612 \begin_inset Flex Code
21615 \begin_layout Plain Layout
21616 <dt>\SpecialChar ldots
21617 </dt><dd>\SpecialChar ldots
21625 \begin_inset Flex Code
21628 \begin_layout Plain Layout
21634 : The label tag is output inside the item tag.
21637 \begin_layout Description
21638 \begin_inset Flex Code
21641 \begin_layout Plain Layout
21647 Information to be output in the
21648 \begin_inset Flex Code
21651 \begin_layout Plain Layout
21657 section when this style is used.
21658 This might, for example, be used to include a
21659 \begin_inset Flex Code
21662 \begin_layout Plain Layout
21669 \begin_inset Flex Code
21672 \begin_layout Plain Layout
21681 \begin_layout Description
21682 \begin_inset Flex Code
21685 \begin_layout Plain Layout
21691 CSS style information to be included when this style is used.
21692 Note that this will automatically be wrapped in a layout-generated
21693 \begin_inset Flex Code
21696 \begin_layout Plain Layout
21702 block, so only the CSS itself need be included.
21704 \begin_inset Flex Code
21707 \begin_layout Plain Layout
21716 \begin_layout Description
21717 \begin_inset Flex Code
21720 \begin_layout Plain Layout
21727 \begin_inset Flex Code
21730 \begin_layout Plain Layout
21736 ] The tag to be used for the main label, replacing
21737 \begin_inset Flex Code
21740 \begin_layout Plain Layout
21746 in the examples above.
21748 \begin_inset Flex Code
21751 \begin_layout Plain Layout
21760 \begin_layout Description
21761 \begin_inset Flex Code
21764 \begin_layout Plain Layout
21771 \begin_inset Flex Code
21774 \begin_layout Plain Layout
21784 ] Marks this style as the one to be used to generate the
21785 \begin_inset Flex Code
21788 \begin_layout Plain Layout
21794 tag for the XHTML file.
21795 By default, it is false.
21797 \begin_inset Flex Code
21800 \begin_layout Plain Layout
21806 file sets it to true for the
21807 \begin_inset Flex Code
21810 \begin_layout Plain Layout
21820 \begin_layout Subsection
21824 \begin_layout Standard
21825 The XHTML output of insets can also be controlled by information in layout
21830 \begin_layout Plain Layout
21831 At present, this is true only for
21832 \begin_inset Quotes eld
21836 \begin_inset Quotes erd
21839 insets (insets you can type into) and is not true for
21840 \begin_inset Quotes eld
21844 \begin_inset Quotes erd
21847 insets (insets that are associated with dialog boxes).
21852 Here, too, \SpecialChar LyX
21853 tries to provide sensible defaults, and it constructs default
21855 But everything can be customized.
21858 \begin_layout Standard
21859 The XHTML \SpecialChar LyX
21860 outputs for an inset has the following form:
21863 \begin_layout LyX-Code
21865 \begin_inset Quotes erd
21869 \begin_inset Quotes erd
21875 \begin_layout LyX-Code
21876 <labeltag>Label</labeltag>
21879 \begin_layout LyX-Code
21881 \begin_inset Quotes erd
21885 \begin_inset Quotes erd
21888 >Contents of the inset.</innertag>
21891 \begin_layout LyX-Code
21895 \begin_layout Standard
21896 If the inset permits multiple paragraphs—that is, if
21897 \begin_inset Flex Code
21900 \begin_layout Plain Layout
21906 is true—then the contents of the inset will itself be output as paragraphs
21907 formatted according to the styles used for those paragraphs (standard,
21908 quote, and the like).
21909 The label tag is of course omitted if the paragraph does not have a label
21910 and, at present, is always
21911 \begin_inset Flex Code
21914 \begin_layout Plain Layout
21921 The inner tag is optional and, by default, does not appear.
21924 \begin_layout Standard
21925 The specific tags and attributes output for each inset can be controlled
21926 by means of the following layout tags.
21929 \begin_layout Description
21930 \begin_inset Flex Code
21933 \begin_layout Plain Layout
21940 \begin_inset Flex Code
21943 \begin_layout Plain Layout
21949 ] Specifies attribute information to be output with the main tag.
21951 \begin_inset Quotes eld
21955 \begin_inset Flex Code
21958 \begin_layout Plain Layout
21959 class=`myinset' onclick=`\SpecialChar ldots
21966 \begin_inset Quotes erd
21970 By default, \SpecialChar LyX
21972 \begin_inset Quotes eld
21976 \begin_inset Flex Code
21979 \begin_layout Plain Layout
21986 \begin_inset Quotes erd
21990 \begin_inset Flex Code
21993 \begin_layout Plain Layout
21999 is the \SpecialChar LyX
22000 name of the inset, made lowercase and with non-alphanumeric characters
22001 converted to underscores, for example: footnote.
22004 \begin_layout Description
22005 \begin_inset Flex Code
22008 \begin_layout Plain Layout
22015 \begin_inset Flex Code
22018 \begin_layout Plain Layout
22028 ] Whether to output the default CSS information \SpecialChar LyX
22029 generates for this layout,
22030 even if additional information is explicitly provided via
22031 \begin_inset Flex Code
22034 \begin_layout Plain Layout
22042 \begin_inset Flex Code
22045 \begin_layout Plain Layout
22051 allows you to alter or augment the generated CSS, rather than to override
22056 \begin_layout Description
22057 \begin_inset Flex Code
22060 \begin_layout Plain Layout
22067 \begin_inset Flex Code
22070 \begin_layout Plain Layout
22076 ] Attributes for the inner tag.
22078 \begin_inset Quotes eld
22082 \begin_inset Flex Code
22085 \begin_layout Plain Layout
22086 class=`insetname_inner'
22092 \begin_inset Quotes erd
22098 \begin_layout Description
22099 \begin_inset Flex Code
22102 \begin_layout Plain Layout
22109 \begin_inset Flex Code
22112 \begin_layout Plain Layout
22118 ] The inner tag, replacing
22119 \begin_inset Flex Code
22122 \begin_layout Plain Layout
22128 in the examples above.
22129 By default, there is none.
22132 \begin_layout Description
22133 \begin_inset Flex Code
22136 \begin_layout Plain Layout
22143 \begin_inset Flex Code
22146 \begin_layout Plain Layout
22154 ] Whether this inset represents a standalone block of text (such as a footnote)
22155 or instead represents material that is included in the surrounding text
22156 (such as a branch).
22160 \begin_layout Description
22161 \begin_inset Flex Code
22164 \begin_layout Plain Layout
22171 \begin_inset Flex Code
22174 \begin_layout Plain Layout
22180 ] A label for this inset, possibly including a reference to a counter.
22181 For example, for footnote, it might be:
22182 \begin_inset Flex Code
22185 \begin_layout Plain Layout
22194 This is optional, and there is no default.
22197 \begin_layout Description
22198 \begin_inset Flex Code
22201 \begin_layout Plain Layout
22207 Information to be output in the
22208 \begin_inset Flex Code
22211 \begin_layout Plain Layout
22217 section when this style is used.
22218 This might, for example, be used to include a
22219 \begin_inset Flex Code
22222 \begin_layout Plain Layout
22229 \begin_inset Flex Code
22232 \begin_layout Plain Layout
22241 \begin_layout Description
22242 \begin_inset Flex Code
22245 \begin_layout Plain Layout
22251 CSS style information to be included when this style is used.
22252 Note that this will automatically be wrapped in a layout-generated
22253 \begin_inset Flex Code
22256 \begin_layout Plain Layout
22262 block, so only the CSS itself need be included.
22265 \begin_layout Description
22266 \begin_inset Flex Code
22269 \begin_layout Plain Layout
22276 \begin_inset Flex Code
22279 \begin_layout Plain Layout
22285 ] The tag to be used for the main label, replacing
22286 \begin_inset Flex Code
22289 \begin_layout Plain Layout
22295 in the examples above.
22296 The default depends upon the setting of
22297 \begin_inset Flex Code
22300 \begin_layout Plain Layout
22307 \begin_inset Flex Code
22310 \begin_layout Plain Layout
22316 is true, the default is
22317 \begin_inset Flex Code
22320 \begin_layout Plain Layout
22326 ; if it is false, the default is
22327 \begin_inset Flex Code
22330 \begin_layout Plain Layout
22339 \begin_layout Subsection
22343 \begin_layout Standard
22344 The XHTML output for floats too can be controlled by layout information.
22345 The output has the following form:
22348 \begin_layout LyX-Code
22350 \begin_inset Quotes erd
22354 \begin_inset Quotes erd
22360 \begin_layout LyX-Code
22361 Contents of the float.
22364 \begin_layout LyX-Code
22368 \begin_layout Standard
22369 The caption, if there is one, is a separate inset and will be output as
22371 Its appearance can be controlled via the InsetLayout for caption insets.
22375 \begin_layout Description
22376 \begin_inset Flex Code
22379 \begin_layout Plain Layout
22386 \begin_inset Flex Code
22389 \begin_layout Plain Layout
22395 ] Specifies attribute information to be output with the main tag.
22397 \begin_inset Quotes eld
22401 \begin_inset Flex Code
22404 \begin_layout Plain Layout
22405 class=`myfloat' onclick=`\SpecialChar ldots
22412 \begin_inset Quotes erd
22416 By default, \SpecialChar LyX
22418 \begin_inset Quotes eld
22422 \begin_inset Flex Code
22425 \begin_layout Plain Layout
22426 class=`float float-floattype'
22432 \begin_inset Quotes erd
22436 \begin_inset Flex Code
22439 \begin_layout Plain Layout
22445 is \SpecialChar LyX
22446 's name for this type of float, as determined by the float declaration
22448 \begin_inset CommandInset ref
22450 reference "subsec:Floats"
22454 ), though made lowercase and with non-alphanumeric characters converted
22455 to underscores, for example: float-table.
22458 \begin_layout Description
22459 \begin_inset Flex Code
22462 \begin_layout Plain Layout
22468 CSS style information to be included when this float is used.
22469 Note that this will automatically be wrapped in a layout-generated
22470 \begin_inset Flex Code
22473 \begin_layout Plain Layout
22479 block, so only the CSS itself need be included.
22482 \begin_layout Description
22483 \begin_inset Flex Code
22486 \begin_layout Plain Layout
22493 \begin_inset Flex Code
22496 \begin_layout Plain Layout
22502 ] The tag to be used for this float, replacing
22503 \begin_inset Quotes eld
22507 \begin_inset Flex Code
22510 \begin_layout Plain Layout
22517 \begin_inset Quotes erd
22520 in the example above.
22522 \begin_inset Flex Code
22525 \begin_layout Plain Layout
22531 and will rarely need changing.
22534 \begin_layout Subsection
22535 Bibliography formatting
22538 \begin_layout Standard
22539 The bibliography can be formatted using
22540 \begin_inset Flex Code
22543 \begin_layout Plain Layout
22551 \begin_inset CommandInset ref
22553 reference "subsec:Citation-format-description"
22560 \begin_layout Subsection
22565 \begin_layout Standard
22566 We have several times mentioned that \SpecialChar LyX
22567 will generate default CSS style rules
22568 for both insets and paragraph styles, based upon the other layout information
22570 In this section, we shall say a word about which layout information \SpecialChar LyX
22575 \begin_layout Standard
22576 At present, \SpecialChar LyX
22577 auto-generates CSS only for font information, making use of
22579 \begin_inset Flex Code
22582 \begin_layout Plain Layout
22589 \begin_inset Flex Code
22592 \begin_layout Plain Layout
22599 \begin_inset Flex Code
22602 \begin_layout Plain Layout
22609 \begin_inset Flex Code
22612 \begin_layout Plain Layout
22619 \begin_inset Flex Code
22622 \begin_layout Plain Layout
22629 \begin_inset CommandInset ref
22631 reference "subsec:Font-description"
22636 The translation is mostly straightforward and obvious.
22638 \begin_inset Quotes eld
22642 \begin_inset Flex Code
22645 \begin_layout Plain Layout
22652 \begin_inset Quotes erd
22656 \begin_inset Quotes eld
22660 \begin_inset Flex Code
22663 \begin_layout Plain Layout
22664 font-family: sans-serif;
22670 \begin_inset Quotes erd
22674 The correspondence of \SpecialChar LyX
22675 sizes and CSS sizes is a little less obvious but
22676 nonetheless intuitive.
22678 \begin_inset Flex Code
22681 \begin_layout Plain Layout
22688 \begin_inset Flex URL
22691 \begin_layout Plain Layout
22701 \begin_layout Chapter
22702 Including External Material
22703 \begin_inset CommandInset label
22705 name "chap:Including-External-Material"
22712 \begin_layout Standard
22713 \begin_inset Box Shadowbox
22723 height_special "totalheight"
22728 backgroundcolor "none"
22731 \begin_layout Plain Layout
22732 WARNING: This portion of the documentation has not been updated for some
22734 We certainly hope that it is still accurate, but there are no guarantees.
22742 \begin_layout Standard
22743 The use of material from sources external to \SpecialChar LyX
22744 is covered in detail in the
22750 This part of the manual covers what needs to happen behind the scenes for
22751 new sorts of material to be included.
22754 \begin_layout Section
22758 \begin_layout Standard
22759 The external material feature is based on the concept of a
22764 A template is a specification of how \SpecialChar LyX
22765 should interface with a certain kind
22767 As bundled, \SpecialChar LyX
22768 comes with predefined templates for Xfig figures, various
22769 raster format images, chess diagrams, and LilyPond music notation.
22770 You can check the actual list by using the menu
22771 \begin_inset Flex Noun
22774 \begin_layout Plain Layout
22775 Insert\SpecialChar menuseparator
22776 File\SpecialChar menuseparator
22783 Furthermore, it is possible to roll your own template to support a specific
22785 Later we'll describe in more detail what is involved, and hopefully you
22786 will submit all the templates you create so we can include them in a later
22791 \begin_layout Standard
22792 Another basic idea of the external material feature is to distinguish between
22793 the original file that serves as a base for final material and the produced
22794 file that is included in your exported or printed document.
22795 For example, consider the case of a figure produced with
22796 \begin_inset Flex Code
22799 \begin_layout Plain Layout
22806 The Xfig application itself works on an original file with the
22807 \begin_inset Flex Code
22810 \begin_layout Plain Layout
22817 Within Xfig, you create and change your figure, and when you are done,
22819 \begin_inset Flex Code
22822 \begin_layout Plain Layout
22829 When you want to include the figure in your document, you invoke
22830 \begin_inset Flex Code
22833 \begin_layout Plain Layout
22839 in order to create a PostScript file that can readily be included in your
22843 \begin_inset Flex Code
22846 \begin_layout Plain Layout
22852 file is the original file, and the PostScript file is the produced file.
22855 \begin_layout Standard
22856 This distinction is important in order to allow updating of the material
22857 while you are in the process of writing the document.
22858 Furthermore, it provides us with the flexibility that is needed to support
22859 multiple export formats.
22860 For instance, in the case of a plain text file, it is not exactly an award-winn
22861 ing idea to include the figure as raw PostScript.
22862 Instead, you would either prefer to just include a reference to the figure
22863 or try to invoke some graphics to ASCII converter to make the final result
22864 look similar to the real graphics.
22865 The external material management allows you to do this, because it is parametri
22866 zed on the different export formats that \SpecialChar LyX
22870 \begin_layout Standard
22871 Besides supporting the production of different products according to the
22872 exported format, it supports tight integration with editing and viewing
22874 In the case of an Xfig figure, you are able to invoke Xfig on the original
22875 file with a single click from within the external material dialog in \SpecialChar LyX
22877 and also preview the produced PostScript file with Ghostview with another
22879 No more fiddling around with the command line and/or file browsers to locate
22880 and manipulate the original or produced files.
22881 In this way, you are finally able to take full advantage of the many different
22882 applications that are relevant to use when you write your documents, and
22883 ultimately be more productive.
22886 \begin_layout Section
22887 The external template configuration file
22890 \begin_layout Standard
22891 It is relatively easy to add custom external template definitions to \SpecialChar LyX
22893 However, be aware that doing this in an careless manner most probably
22897 introduce an easily exploitable security hole.
22898 So before you do this, please read the discussion about security in
22899 \begin_inset CommandInset ref
22901 reference "sec:Security-discussion"
22908 \begin_layout Standard
22909 Having said that, we encourage you to submit any interesting templates that
22914 \begin_layout Standard
22915 The external templates are defined in the
22916 \begin_inset Flex Code
22919 \begin_layout Plain Layout
22920 LyXDir/lib/external_templates
22926 You can place your own version in
22927 \begin_inset Flex Code
22930 \begin_layout Plain Layout
22931 UserDir/external_templates
22939 \begin_layout Standard
22940 A typical template looks like this:
22943 \begin_layout LyX-Code
22947 \begin_layout LyX-Code
22948 GuiName "XFig: $$AbsOrRelPathParent$$Basename"
22951 \begin_layout LyX-Code
22955 \begin_layout LyX-Code
22959 \begin_layout LyX-Code
22963 \begin_layout LyX-Code
22967 \begin_layout LyX-Code
22971 \begin_layout LyX-Code
22972 AutomaticProduction true
22975 \begin_layout LyX-Code
22979 \begin_layout LyX-Code
22983 \begin_layout LyX-Code
22984 Format \SpecialChar LaTeX
22988 \begin_layout LyX-Code
22989 TransformCommand Rotate RotationLatexCommand
22992 \begin_layout LyX-Code
22993 TransformCommand Resize ResizeLatexCommand
22996 \begin_layout LyX-Code
22997 Product "$$RotateFront$$ResizeFront
23000 \begin_layout LyX-Code
23005 input{$$AbsOrRelPathMaster$$Basename.pstex_t}
23008 \begin_layout LyX-Code
23009 $$ResizeBack$$RotateBack"
23012 \begin_layout LyX-Code
23016 \begin_layout LyX-Code
23017 UpdateResult "$$AbsPath$$Basename.pstex_t"
23020 \begin_layout LyX-Code
23021 Requirement "graphicx"
23024 \begin_layout LyX-Code
23025 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
23028 \begin_layout LyX-Code
23029 ReferencedFile latex "$$AbsPath$$Basename.eps"
23032 \begin_layout LyX-Code
23033 ReferencedFile dvi "$$AbsPath$$Basename.eps"
23036 \begin_layout LyX-Code
23040 \begin_layout LyX-Code
23041 Format PDF\SpecialChar LaTeX
23045 \begin_layout LyX-Code
23046 TransformCommand Rotate RotationLatexCommand
23049 \begin_layout LyX-Code
23050 TransformCommand Resize ResizeLatexCommand
23053 \begin_layout LyX-Code
23054 Product "$$RotateFront$$ResizeFront
23057 \begin_layout LyX-Code
23062 input{$$AbsOrRelPathMaster$$Basename.pdftex_t}
23065 \begin_layout LyX-Code
23066 $$ResizeBack$$RotateBack"
23069 \begin_layout LyX-Code
23070 UpdateFormat pdftex
23073 \begin_layout LyX-Code
23074 UpdateResult "$$AbsPath$$Basename.pdftex_t"
23077 \begin_layout LyX-Code
23078 Requirement "graphicx"
23081 \begin_layout LyX-Code
23082 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pdftex_t"
23085 \begin_layout LyX-Code
23086 ReferencedFile latex "$$AbsPath$$Basename.pdf"
23089 \begin_layout LyX-Code
23093 \begin_layout LyX-Code
23097 \begin_layout LyX-Code
23098 Product "$$Contents(
23100 "$$AbsPath$$Basename.asc
23105 \begin_layout LyX-Code
23106 UpdateFormat asciixfig
23109 \begin_layout LyX-Code
23110 UpdateResult "$$AbsPath$$Basename.asc"
23113 \begin_layout LyX-Code
23117 \begin_layout LyX-Code
23121 \begin_layout LyX-Code
23122 Product "<graphic fileref=
23124 "$$AbsOrRelPathMaster$$Basename.eps
23129 \begin_layout LyX-Code
23133 \begin_layout LyX-Code
23137 \begin_layout LyX-Code
23138 UpdateResult "$$AbsPath$$Basename.eps"
23141 \begin_layout LyX-Code
23142 ReferencedFile docbook "$$AbsPath$$Basename.eps"
23145 \begin_layout LyX-Code
23146 ReferencedFile docbook-xml "$$AbsPath$$Basename.eps"
23149 \begin_layout LyX-Code
23153 \begin_layout LyX-Code
23154 Product "[XFig: $$FName]"
23157 \begin_layout LyX-Code
23161 \begin_layout LyX-Code
23165 \begin_layout Standard
23166 As you can see, the template is enclosed in
23167 \begin_inset Flex Code
23170 \begin_layout Plain Layout
23178 \begin_inset Flex Code
23181 \begin_layout Plain Layout
23188 It contains a header specifying some general settings and, for each supported
23189 primary document file format, a section
23190 \begin_inset Flex Code
23193 \begin_layout Plain Layout
23201 \begin_inset Flex Code
23204 \begin_layout Plain Layout
23213 \begin_layout Subsection
23214 The template header
23217 \begin_layout Description
23218 \begin_inset Flex Code
23221 \begin_layout Plain Layout
23222 AutomaticProduction
23223 \begin_inset space ~
23231 Whether the file represented by the template must be generated by \SpecialChar LyX
23233 This command must occur exactly once.
23236 \begin_layout Description
23237 \begin_inset Flex Code
23240 \begin_layout Plain Layout
23242 \begin_inset space ~
23250 A glob pattern that is used in the file dialog to filter out the desired
23252 If there is more than one possible file extension (e.
23253 \begin_inset space \thinspace{}
23257 \begin_inset space \space{}
23261 \begin_inset Flex Code
23264 \begin_layout Plain Layout
23271 \begin_inset Flex Code
23274 \begin_layout Plain Layout
23280 ), use something like
23281 \begin_inset Flex Code
23284 \begin_layout Plain Layout
23291 This command must occur exactly once.
23294 \begin_layout Description
23295 \begin_inset Flex Code
23298 \begin_layout Plain Layout
23300 \begin_inset space ~
23308 The text that is displayed on the button.
23309 This command must occur exactly once.
23312 \begin_layout Description
23313 \begin_inset Flex Code
23316 \begin_layout Plain Layout
23318 \begin_inset space ~
23322 \begin_inset space ~
23330 The help text that is used in the External dialog.
23331 Provide enough information to explain to the user just what the template
23332 can provide him with.
23333 This command must occur exactly once.
23336 \begin_layout Description
23337 \begin_inset Flex Code
23340 \begin_layout Plain Layout
23342 \begin_inset space ~
23350 The file format of the original file.
23351 This must be the name of a format that is known to \SpecialChar LyX
23353 \begin_inset CommandInset ref
23355 reference "sec:Formats"
23361 \begin_inset Quotes eld
23365 \begin_inset Flex Code
23368 \begin_layout Plain Layout
23375 \begin_inset Quotes erd
23378 if the template can handle original files of more than one format.
23380 will attempt to interrogate the file itself in order to deduce its format
23382 This command must occur exactly once.
23385 \begin_layout Description
23386 \begin_inset Flex Code
23389 \begin_layout Plain Layout
23391 \begin_inset space ~
23399 A unique name for the template.
23400 It must not contain substitution macros (see below).
23403 \begin_layout Description
23404 \begin_inset Flex Code
23407 \begin_layout Plain Layout
23409 \begin_inset space ~
23412 Rotate|Resize|Clip|Extra
23417 This command specifies which transformations are supported by this template.
23418 It may occur zero or more times.
23419 This command enables the corresponding tabs in the external dialog.
23421 \begin_inset Flex Code
23424 \begin_layout Plain Layout
23430 command must have either a corresponding
23431 \begin_inset Flex Code
23434 \begin_layout Plain Layout
23441 \begin_inset Flex Code
23444 \begin_layout Plain Layout
23451 \begin_inset Flex Code
23454 \begin_layout Plain Layout
23461 Otherwise the transformation will not be supported by that format.
23464 \begin_layout Subsection
23468 \begin_layout Description
23469 \begin_inset Flex Code
23472 \begin_layout Plain Layout
23474 \begin_inset space ~
23477 LaTeX|PDFLaTeX|PlainText|DocBook
23482 The primary document file format that this format definition is for.
23483 Not every template has a sensible representation in all document file formats.
23484 Please define nevertheless a
23485 \begin_inset Flex Code
23488 \begin_layout Plain Layout
23494 section for all templates.
23495 Use a dummy text when no representation is available.
23496 Then you can at least see a reference to the external material in the exported
23500 \begin_layout Description
23501 \begin_inset Flex Code
23504 \begin_layout Plain Layout
23506 \begin_inset space ~
23510 \begin_inset space ~
23518 This command defines an additional macro
23519 \begin_inset Flex Code
23522 \begin_layout Plain Layout
23528 for substitution in
23529 \begin_inset Flex Code
23532 \begin_layout Plain Layout
23540 \begin_inset Flex Code
23543 \begin_layout Plain Layout
23549 itself may contain substitution macros.
23550 The advantage over using
23551 \begin_inset Flex Code
23554 \begin_layout Plain Layout
23561 \begin_inset Flex Code
23564 \begin_layout Plain Layout
23570 is that the substituted value of
23571 \begin_inset Flex Code
23574 \begin_layout Plain Layout
23580 is sanitized so that it is a valid optional argument in the document format.
23581 This command may occur zero or more times.
23584 \begin_layout Description
23585 \begin_inset Flex Code
23588 \begin_layout Plain Layout
23590 \begin_inset space ~
23598 The text that is inserted in the exported document.
23599 This is actually the most important command and can be quite complex.
23600 This command must occur exactly once.
23603 \begin_layout Description
23604 \begin_inset Flex Code
23607 \begin_layout Plain Layout
23609 \begin_inset space ~
23617 This command specifies a preamble snippet that will be included in the
23620 It has to be defined using
23621 \begin_inset Flex Code
23624 \begin_layout Plain Layout
23632 \begin_inset Flex Code
23635 \begin_layout Plain Layout
23642 This command may occur zero or more times.
23645 \begin_layout Description
23646 \begin_inset Flex Code
23649 \begin_layout Plain Layout
23651 \begin_inset space ~
23655 \begin_inset space ~
23663 This command denotes files that are created by the conversion process and
23664 are needed for a particular export format.
23665 If the filename is relative, it is interpreted relative to the master document.
23666 This command may be given zero or more times.
23669 \begin_layout Description
23670 \begin_inset Flex Code
23673 \begin_layout Plain Layout
23675 \begin_inset space ~
23683 The name of a required \SpecialChar LaTeX
23685 The package is included via
23686 \begin_inset Flex Code
23689 \begin_layout Plain Layout
23697 in the \SpecialChar LaTeX
23699 This command may occur zero or more times.
23702 \begin_layout Description
23703 \begin_inset Flex Code
23706 \begin_layout Plain Layout
23708 \begin_inset space ~
23712 \begin_inset space ~
23715 RotationLatexCommand
23720 This command specifies that the built in \SpecialChar LaTeX
23721 command should be used for rotation.
23722 This command may occur once or not at all.
23725 \begin_layout Description
23726 \begin_inset Flex Code
23729 \begin_layout Plain Layout
23731 \begin_inset space ~
23735 \begin_inset space ~
23743 This command specifies that the built in \SpecialChar LaTeX
23744 command should be used for resizing.
23745 This command may occur once or not at all.
23748 \begin_layout Description
23749 \begin_inset Flex Code
23752 \begin_layout Plain Layout
23754 \begin_inset space ~
23758 \begin_inset space ~
23761 RotationLatexOption
23766 This command specifies that rotation is done via an optional argument.
23767 This command may occur once or not at all.
23770 \begin_layout Description
23771 \begin_inset Flex Code
23774 \begin_layout Plain Layout
23776 \begin_inset space ~
23780 \begin_inset space ~
23788 This command specifies that resizing is done via an optional argument.
23789 This command may occur once or not at all.
23792 \begin_layout Description
23793 \begin_inset Flex Code
23796 \begin_layout Plain Layout
23798 \begin_inset space ~
23802 \begin_inset space ~
23810 This command specifies that clipping is done via an optional argument.
23811 This command may occur once or not at all.
23814 \begin_layout Description
23815 \begin_inset Flex Code
23818 \begin_layout Plain Layout
23820 \begin_inset space ~
23824 \begin_inset space ~
23832 This command specifies that an extra optional argument is used.
23833 This command may occur once or not at all.
23836 \begin_layout Description
23837 \begin_inset Flex Code
23840 \begin_layout Plain Layout
23842 \begin_inset space ~
23850 The file format of the converted file.
23851 This must be the name of a format that is known to \SpecialChar LyX
23853 \begin_inset Flex Noun
23856 \begin_layout Plain Layout
23857 Tools\SpecialChar menuseparator
23858 Preferences\SpecialChar menuseparator
23859 File Handling\SpecialChar menuseparator
23866 This command must occur exactly once.
23867 If the resulting file format is PDF, you need to specify the format
23868 \begin_inset Flex Code
23871 \begin_layout Plain Layout
23878 This is the PDF format used for including graphics.
23879 The other defined PDF formats are for document export.
23882 \begin_layout Description
23883 \begin_inset Flex Code
23886 \begin_layout Plain Layout
23888 \begin_inset space ~
23896 The file name of the converted file.
23897 The file name must be absolute.
23898 This command must occur exactly once.
23901 \begin_layout Subsection
23902 Preamble definitions
23905 \begin_layout Standard
23906 The external template configuration file may contain additional preamble
23907 definitions enclosed by
23908 \begin_inset Flex Code
23911 \begin_layout Plain Layout
23919 \begin_inset Flex Code
23922 \begin_layout Plain Layout
23929 They can be used by the templates in the
23930 \begin_inset Flex Code
23933 \begin_layout Plain Layout
23942 \begin_layout Section
23943 The substitution mechanism
23946 \begin_layout Standard
23947 When the external material facility invokes an external program, it is done
23948 on the basis of a command defined in the template configuration file.
23949 These commands can contain various macros that are expanded before execution.
23950 Execution always take place in the directory of the containing document.
23953 \begin_layout Standard
23954 Also, whenever external material is to be displayed, the name will be produced
23955 by the substitution mechanism, and most other commands in the template
23956 definition support substitution as well.
23959 \begin_layout Standard
23960 The available macros are the following:
23963 \begin_layout Description
23964 \begin_inset Flex Code
23967 \begin_layout Plain Layout
23968 $$AbsOrRelPathMaster
23973 The file path, absolute or relative to the master \SpecialChar LyX
23977 \begin_layout Description
23978 \begin_inset Flex Code
23981 \begin_layout Plain Layout
23982 $$AbsOrRelPathParent
23987 The file path, absolute or relative to the \SpecialChar LyX
23991 \begin_layout Description
23992 \begin_inset Flex Code
23995 \begin_layout Plain Layout
24001 The absolute file path.
24004 \begin_layout Description
24005 \begin_inset Flex Code
24008 \begin_layout Plain Layout
24014 The filename without path and without the extension.
24017 \begin_layout Description
24018 \begin_inset Flex Code
24021 \begin_layout Plain Layout
24023 \begin_inset Quotes eld
24027 \begin_inset Quotes erd
24035 This macro will expand to the contents of the file with the name
24036 \begin_inset Flex Code
24039 \begin_layout Plain Layout
24048 \begin_layout Description
24049 \begin_inset Flex Code
24052 \begin_layout Plain Layout
24058 The file extension (including the dot).
24061 \begin_layout Description
24062 \begin_inset Flex Code
24065 \begin_layout Plain Layout
24071 This will be the string
24072 \begin_inset Quotes eld
24076 \begin_inset Quotes erd
24079 if the file is in JPEG format, otherwise it will be the string
24080 \begin_inset Quotes eld
24084 \begin_inset Quotes erd
24088 This is useful to avoid uneeded conversions for output formats that support
24089 both PNG and JPEG fomats.
24090 The predefined RasterImage template uses this macro for the pdf\SpecialChar TeX
24095 \begin_layout Description
24096 \begin_inset Flex Code
24099 \begin_layout Plain Layout
24105 The filename of the file specified in the external material dialog.
24106 This is either an absolute name, or it is relative to the \SpecialChar LyX
24110 \begin_layout Description
24111 \begin_inset Flex Code
24114 \begin_layout Plain Layout
24121 \begin_inset Flex Code
24124 \begin_layout Plain Layout
24130 (absolute name or relative to the \SpecialChar LyX
24134 \begin_layout Description
24135 \begin_inset Flex Code
24138 \begin_layout Plain Layout
24144 The file path, relative to the master \SpecialChar LyX
24148 \begin_layout Description
24149 \begin_inset Flex Code
24152 \begin_layout Plain Layout
24158 The file path, relative to the \SpecialChar LyX
24162 \begin_layout Description
24163 \begin_inset Flex Code
24166 \begin_layout Plain Layout
24172 This macro will expand to the absolute path of the system directory.
24173 This is typically used to point to the various helper scripts that are
24174 bundled with \SpecialChar LyX
24178 \begin_layout Description
24179 \begin_inset Flex Code
24182 \begin_layout Plain Layout
24188 A name and full path to a temporary file which will be automatically deleted
24189 whenever the containing document is closed, or the external material insertion
24193 \begin_layout Standard
24194 All path macros contain a trailing directory separator, so you can construct
24196 \begin_inset space \thinspace{}
24200 \begin_inset space \space{}
24203 the absolute filename with
24204 \begin_inset Flex Code
24207 \begin_layout Plain Layout
24208 $$AbsPath$$Basename$$Extension
24216 \begin_layout Standard
24217 The macros above are substituted in all commands unless otherwise noted.
24219 \begin_inset Flex Code
24222 \begin_layout Plain Layout
24228 supports additionally the following substitutions if they are enabled by
24230 \begin_inset Flex Code
24233 \begin_layout Plain Layout
24240 \begin_inset Flex Code
24243 \begin_layout Plain Layout
24252 \begin_layout Description
24253 \begin_inset Flex Code
24256 \begin_layout Plain Layout
24262 The front part of the resize command.
24265 \begin_layout Description
24266 \begin_inset Flex Code
24269 \begin_layout Plain Layout
24275 The back part of the resize command.
24278 \begin_layout Description
24279 \begin_inset Flex Code
24282 \begin_layout Plain Layout
24288 The front part of the rotation command.
24291 \begin_layout Description
24292 \begin_inset Flex Code
24295 \begin_layout Plain Layout
24301 The back part of the rotation command.
24304 \begin_layout Standard
24305 The value string of the
24306 \begin_inset Flex Code
24309 \begin_layout Plain Layout
24315 command supports additionally the following substitutions if they are enabled
24317 \begin_inset Flex Code
24320 \begin_layout Plain Layout
24327 \begin_inset Flex Code
24330 \begin_layout Plain Layout
24339 \begin_layout Description
24340 \begin_inset Flex Code
24343 \begin_layout Plain Layout
24352 \begin_layout Description
24353 \begin_inset Flex Code
24356 \begin_layout Plain Layout
24365 \begin_layout Description
24366 \begin_inset Flex Code
24369 \begin_layout Plain Layout
24378 \begin_layout Description
24379 \begin_inset Flex Code
24382 \begin_layout Plain Layout
24388 The rotation option.
24391 \begin_layout Standard
24392 You may ask why there are so many path macros.
24393 There are mainly two reasons:
24396 \begin_layout Enumerate
24397 Relative and absolute file names should remain relative or absolute, respectivel
24399 Users may have reasons to prefer either form.
24400 Relative names are useful for portable documents that should work on different
24401 machines, for example.
24402 Absolute names may be required by some programs.
24405 \begin_layout Enumerate
24407 treats relative file names differently than \SpecialChar LyX
24408 and other programs in nested
24410 For \SpecialChar LyX
24411 , a relative file name is always relative to the document that contains
24413 For \SpecialChar LaTeX
24414 , it is always relative to the master document.
24415 These two definitions are identical if you have only one document, but
24416 differ if you have a master document that includes part documents.
24417 That means that relative filenames must be transformed when presented to
24420 Fortunately \SpecialChar LyX
24421 does this automatically for you if you choose the right macros.
24424 \begin_layout Standard
24425 So which path macro should be used in new template definitions? The rule
24429 \begin_layout Itemize
24431 \begin_inset Flex Code
24434 \begin_layout Plain Layout
24440 if an absolute path is required.
24443 \begin_layout Itemize
24445 \begin_inset Flex Code
24448 \begin_layout Plain Layout
24449 $$AbsOrRelPathMaster
24454 if the substituted string is some kind of \SpecialChar LaTeX
24458 \begin_layout Itemize
24460 \begin_inset Flex Code
24463 \begin_layout Plain Layout
24464 $$AbsOrRelPathParent
24469 in order to preserve the user's choice.
24472 \begin_layout Standard
24473 There are special cases where this rule does not work and e.
24474 \begin_inset space \thinspace{}
24478 \begin_inset space \space{}
24481 relative names are needed, but normally it will work just fine.
24482 One example for such a case is the command
24483 \begin_inset Flex Code
24486 \begin_layout Plain Layout
24487 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
24492 in the XFig template above: We can't use the absolute name because the
24494 \begin_inset Flex Code
24497 \begin_layout Plain Layout
24503 files needs the relative name in order to rewrite the file content.
24506 \begin_layout Section
24507 Security discussion
24508 \begin_inset CommandInset label
24510 name "sec:Security-discussion"
24517 \begin_layout Standard
24518 The external material feature interfaces with a lot of external programs
24519 and does so automatically, so we have to consider the security implications
24521 In particular, since you have the option of including your own filenames
24522 and/or parameter strings and those are expanded into a command, it seems
24523 that it would be possible to create a malicious document which executes
24524 arbitrary commands when a user views or prints the document.
24525 This is something we definitely want to avoid.
24528 \begin_layout Standard
24529 However, since the external program commands are specified in the template
24530 configuration file only, there are no security issues if \SpecialChar LyX
24531 is properly configure
24532 d with safe templates only.
24533 This is so because the external programs are invoked with the
24534 \begin_inset Flex Code
24537 \begin_layout Plain Layout
24543 -system call rather than the
24544 \begin_inset Flex Code
24547 \begin_layout Plain Layout
24553 system-call, so it's not possible to execute arbitrary commands from the
24554 filename or parameter section via the shell.
24557 \begin_layout Standard
24558 This also implies that you are restricted in what command strings you can
24559 use in the external material templates.
24560 In particular, pipes and redirection are not readily available.
24561 This has to be so if \SpecialChar LyX
24562 should remain safe.
24563 If you want to use some of the shell features, you should write a safe
24564 script to do this in a controlled manner, and then invoke the script from
24565 the command string.
24569 \begin_layout Standard
24570 It is possible to design a template that interacts directly with the shell,
24571 but since this would allow a malicious user to execute arbitrary commands
24572 by writing clever filenames and/or parameters, we generally recommend that
24573 you only use safe scripts that work with the
24574 \begin_inset Flex Code
24577 \begin_layout Plain Layout
24583 system call in a controlled manner.
24584 Of course, for use in a controlled environment, it can be tempting to just
24585 fall back to use ordinary shell scripts.
24586 If you do so, be aware that you
24590 provide an easily exploitable security hole in your system.
24591 Of course it stands to reason that such unsafe templates will never be
24592 included in the standard \SpecialChar LyX
24593 distribution, although we do encourage people
24594 to submit new templates in the open source tradition.
24595 But \SpecialChar LyX
24596 as shipped from the official distribution channels will never have
24600 \begin_layout Standard
24601 Including external material provides a lot of power, and you have to be
24602 careful not to introduce security hazards with this power.
24603 A subtle error in a single line in an innocent looking script can open
24604 the door to huge security problems.
24605 So if you do not fully understand the issues, we recommend that you consult
24606 a knowledgeable security professional or the \SpecialChar LyX
24607 development team if you have
24608 any questions about whether a given template is safe or not.
24609 And do this before you use it in an uncontrolled environment.
24612 \begin_layout Chapter
24614 List of supported \SpecialChar LyX
24615 functions to be used in layouts
24616 \begin_inset CommandInset label
24618 name "chap:List-of-functions"
24625 \begin_layout Standard
24627 \begin_inset Tabular
24628 <lyxtabular version="3" rows="11" columns="8">
24629 <features tabularvalignment="middle">
24630 <column alignment="left" valignment="top">
24631 <column alignment="left" valignment="top">
24632 <column alignment="left" valignment="top">
24633 <column alignment="left" valignment="top">
24634 <column alignment="left" valignment="top">
24635 <column alignment="left" valignment="top">
24636 <column alignment="left" valignment="top">
24637 <column alignment="left" valignment="top">
24639 <cell alignment="left" valignment="top" usebox="none">
24642 \begin_layout Plain Layout
24648 <cell alignment="left" valignment="top" usebox="none">
24651 \begin_layout Plain Layout
24657 <cell alignment="left" valignment="top" usebox="none">
24660 \begin_layout Plain Layout
24666 <cell alignment="left" valignment="top" usebox="none">
24669 \begin_layout Plain Layout
24675 <cell alignment="center" valignment="top" usebox="none">
24678 \begin_layout Plain Layout
24684 <cell alignment="center" valignment="top" usebox="none">
24687 \begin_layout Plain Layout
24693 <cell alignment="center" valignment="top" usebox="none">
24696 \begin_layout Plain Layout
24702 <cell alignment="center" valignment="top" usebox="none">
24705 \begin_layout Plain Layout
24713 <cell alignment="left" valignment="top" usebox="none">
24716 \begin_layout Plain Layout
24722 <cell alignment="left" valignment="top" usebox="none">
24725 \begin_layout Plain Layout
24731 <cell alignment="left" valignment="top" usebox="none">
24734 \begin_layout Plain Layout
24740 <cell alignment="left" valignment="top" usebox="none">
24743 \begin_layout Plain Layout
24749 <cell alignment="center" valignment="top" usebox="none">
24752 \begin_layout Plain Layout
24758 <cell alignment="center" valignment="top" usebox="none">
24761 \begin_layout Plain Layout
24767 <cell alignment="center" valignment="top" usebox="none">
24770 \begin_layout Plain Layout
24776 <cell alignment="center" valignment="top" usebox="none">
24779 \begin_layout Plain Layout
24787 <cell alignment="left" valignment="top" usebox="none">
24790 \begin_layout Plain Layout
24796 <cell alignment="left" valignment="top" usebox="none">
24799 \begin_layout Plain Layout
24805 <cell alignment="left" valignment="top" usebox="none">
24808 \begin_layout Plain Layout
24814 <cell alignment="left" valignment="top" usebox="none">
24817 \begin_layout Plain Layout
24823 <cell alignment="center" valignment="top" usebox="none">
24826 \begin_layout Plain Layout
24832 <cell alignment="center" valignment="top" usebox="none">
24835 \begin_layout Plain Layout
24841 <cell alignment="center" valignment="top" usebox="none">
24844 \begin_layout Plain Layout
24850 <cell alignment="center" valignment="top" usebox="none">
24853 \begin_layout Plain Layout
24861 <cell alignment="left" valignment="top" usebox="none">
24864 \begin_layout Plain Layout
24870 <cell alignment="left" valignment="top" usebox="none">
24873 \begin_layout Plain Layout
24879 <cell alignment="left" valignment="top" usebox="none">
24882 \begin_layout Plain Layout
24888 <cell alignment="left" valignment="top" usebox="none">
24891 \begin_layout Plain Layout
24897 <cell alignment="center" valignment="top" usebox="none">
24900 \begin_layout Plain Layout
24906 <cell alignment="center" valignment="top" usebox="none">
24909 \begin_layout Plain Layout
24915 <cell alignment="center" valignment="top" usebox="none">
24918 \begin_layout Plain Layout
24924 <cell alignment="center" valignment="top" usebox="none">
24927 \begin_layout Plain Layout
24935 <cell alignment="left" valignment="top" usebox="none">
24938 \begin_layout Plain Layout
24944 <cell alignment="left" valignment="top" usebox="none">
24947 \begin_layout Plain Layout
24953 <cell alignment="left" valignment="top" usebox="none">
24956 \begin_layout Plain Layout
24962 <cell alignment="left" valignment="top" usebox="none">
24965 \begin_layout Plain Layout
24971 <cell alignment="center" valignment="top" usebox="none">
24974 \begin_layout Plain Layout
24980 <cell alignment="center" valignment="top" usebox="none">
24983 \begin_layout Plain Layout
24989 <cell alignment="center" valignment="top" usebox="none">
24992 \begin_layout Plain Layout
24998 <cell alignment="center" valignment="top" usebox="none">
25001 \begin_layout Plain Layout
25009 <cell alignment="left" valignment="top" usebox="none">
25012 \begin_layout Plain Layout
25018 <cell alignment="left" valignment="top" usebox="none">
25021 \begin_layout Plain Layout
25027 <cell alignment="left" valignment="top" usebox="none">
25030 \begin_layout Plain Layout
25036 <cell alignment="left" valignment="top" usebox="none">
25039 \begin_layout Plain Layout
25045 <cell alignment="center" valignment="top" usebox="none">
25048 \begin_layout Plain Layout
25054 <cell alignment="center" valignment="top" usebox="none">
25057 \begin_layout Plain Layout
25063 <cell alignment="center" valignment="top" usebox="none">
25066 \begin_layout Plain Layout
25072 <cell alignment="center" valignment="top" usebox="none">
25075 \begin_layout Plain Layout
25083 <cell alignment="left" valignment="top" usebox="none">
25086 \begin_layout Plain Layout
25092 <cell alignment="left" valignment="top" usebox="none">
25095 \begin_layout Plain Layout
25101 <cell alignment="left" valignment="top" usebox="none">
25104 \begin_layout Plain Layout
25110 <cell alignment="left" valignment="top" usebox="none">
25113 \begin_layout Plain Layout
25119 <cell alignment="center" valignment="top" usebox="none">
25122 \begin_layout Plain Layout
25128 <cell alignment="center" valignment="top" usebox="none">
25131 \begin_layout Plain Layout
25137 <cell alignment="center" valignment="top" usebox="none">
25140 \begin_layout Plain Layout
25146 <cell alignment="center" valignment="top" usebox="none">
25149 \begin_layout Plain Layout
25157 <cell alignment="left" valignment="top" usebox="none">
25160 \begin_layout Plain Layout
25166 <cell alignment="left" valignment="top" usebox="none">
25169 \begin_layout Plain Layout
25175 <cell alignment="left" valignment="top" usebox="none">
25178 \begin_layout Plain Layout
25184 <cell alignment="left" valignment="top" usebox="none">
25187 \begin_layout Plain Layout
25193 <cell alignment="center" valignment="top" usebox="none">
25196 \begin_layout Plain Layout
25202 <cell alignment="center" valignment="top" usebox="none">
25205 \begin_layout Plain Layout
25211 <cell alignment="center" valignment="top" usebox="none">
25214 \begin_layout Plain Layout
25220 <cell alignment="center" valignment="top" usebox="none">
25223 \begin_layout Plain Layout
25231 <cell alignment="left" valignment="top" usebox="none">
25234 \begin_layout Plain Layout
25240 <cell alignment="left" valignment="top" usebox="none">
25243 \begin_layout Plain Layout
25249 <cell alignment="left" valignment="top" usebox="none">
25252 \begin_layout Plain Layout
25258 <cell alignment="left" valignment="top" usebox="none">
25261 \begin_layout Plain Layout
25267 <cell alignment="center" valignment="top" usebox="none">
25270 \begin_layout Plain Layout
25276 <cell alignment="center" valignment="top" usebox="none">
25279 \begin_layout Plain Layout
25285 <cell alignment="center" valignment="top" usebox="none">
25288 \begin_layout Plain Layout
25294 <cell alignment="center" valignment="top" usebox="none">
25297 \begin_layout Plain Layout
25305 <cell alignment="left" valignment="top" usebox="none">
25308 \begin_layout Plain Layout
25314 <cell alignment="left" valignment="top" usebox="none">
25317 \begin_layout Plain Layout
25323 <cell alignment="left" valignment="top" usebox="none">
25326 \begin_layout Plain Layout
25332 <cell alignment="left" valignment="top" usebox="none">
25335 \begin_layout Plain Layout
25341 <cell alignment="center" valignment="top" usebox="none">
25344 \begin_layout Plain Layout
25350 <cell alignment="center" valignment="top" usebox="none">
25353 \begin_layout Plain Layout
25359 <cell alignment="center" valignment="top" usebox="none">
25362 \begin_layout Plain Layout
25368 <cell alignment="center" valignment="top" usebox="none">
25371 \begin_layout Plain Layout
25379 <cell alignment="center" valignment="top" usebox="none">
25382 \begin_layout Plain Layout
25388 <cell alignment="center" valignment="top" usebox="none">
25391 \begin_layout Plain Layout
25397 <cell alignment="center" valignment="top" usebox="none">
25400 \begin_layout Plain Layout
25406 <cell alignment="center" valignment="top" usebox="none">
25409 \begin_layout Plain Layout
25415 <cell alignment="center" valignment="top" usebox="none">
25418 \begin_layout Plain Layout
25424 <cell alignment="center" valignment="top" usebox="none">
25427 \begin_layout Plain Layout
25433 <cell alignment="center" valignment="top" usebox="none">
25436 \begin_layout Plain Layout
25442 <cell alignment="center" valignment="top" usebox="none">
25445 \begin_layout Plain Layout
25459 \begin_layout Chapter
25460 Names of available colors to be used in layouts
25461 \begin_inset CommandInset label
25463 name "chap:Names-of-colors"
25470 \begin_layout Standard
25471 The colors listed here are the standard colors and the those that you can
25472 adjust in the \SpecialChar LyX
25476 \begin_layout Description
25489 No particular color – clear or default
25492 \begin_layout Description
25496 \begin_layout Description
25500 \begin_layout Description
25504 \begin_layout Description
25508 \begin_layout Description
25512 \begin_layout Description
25516 \begin_layout Description
25520 \begin_layout Description
25524 \begin_layout Description
25525 added_space Added space marker color
25528 \begin_layout Description
25529 addedtext Added text color
25532 \begin_layout Description
25533 appendix Appendix marker color
25536 \begin_layout Description
25537 background Background color
25540 \begin_layout Description
25541 bottomarea Bottom area color
25544 \begin_layout Description
25545 branchlabel Label color for branches
25548 \begin_layout Description
25549 buttonbg Color used for button background
25552 \begin_layout Description
25553 buttonhoverbg Color used for button background under focus
25556 \begin_layout Description
25557 buttonframe Color for inset button frames
25560 \begin_layout Description
25561 changebar Changebar color
25564 \begin_layout Description
25565 changedtextauthor1 Changed text color author 1
25568 \begin_layout Description
25569 changedtextauthor2 Changed text color author 2
25572 \begin_layout Description
25573 changedtextauthor3 Changed text color author 3
25576 \begin_layout Description
25577 changedtextauthor4 Changed text color author 4
25580 \begin_layout Description
25581 changedtextauthor5 Changed text color author 5
25584 \begin_layout Description
25585 collapsable_inset_frame Collapsable insets framecolor
25588 \begin_layout Description
25589 collapsable_inset_text Collapsable insets text color
25592 \begin_layout Description
25593 command Text color for command insets
25596 \begin_layout Description
25597 commandbg Background color for command insets
25600 \begin_layout Description
25601 commandframe Frame color for command insets
25604 \begin_layout Description
25605 comment color for comments
25608 \begin_layout Description
25609 commentbg Background color of comments
25612 \begin_layout Description
25613 cursor Cursor color
25616 \begin_layout Description
25617 deletedtext Deleted text color
25620 \begin_layout Description
25621 deletedtextmodifier Deleted text modifying color
25624 \begin_layout Description
25625 depthbar Color for the depth bars in the margin
25628 \begin_layout Description
25629 eolmarker End of line marker color
25632 \begin_layout Description
25633 error Color of the \SpecialChar LaTeX
25637 \begin_layout Description
25638 footlabel Label color for footnotes
25641 \begin_layout Description
25642 graphicsbg Graphics inset background color
25645 \begin_layout Description
25646 greyedout Label color for greyedout insets
25649 \begin_layout Description
25650 greyedoutbg Background color of greyedout inset
25653 \begin_layout Description
25654 greyedouttext Color for greyedout inset text
25657 \begin_layout Description
25658 indexlabel Label color for index insets
25661 \begin_layout Description
25662 ignore The color is ignored
25665 \begin_layout Description
25666 inherit The color is inherited
25669 \begin_layout Description
25670 inlinecompletion Inline completion color
25673 \begin_layout Description
25674 insetbg Inset marker background color
25677 \begin_layout Description
25678 insetframe Inset marker frame color
25681 \begin_layout Description
25682 language Color for marking foreign language words
25685 \begin_layout Description
25686 latex Text color in \SpecialChar LaTeX
25690 \begin_layout Description
25691 listingsbg Background color of listings inset
25694 \begin_layout Description
25695 marginlabel Label color for margin notes
25698 \begin_layout Description
25699 math Math inset text color
25702 \begin_layout Description
25703 mathbg Math inset background color
25706 \begin_layout Description
25707 mathcorners Math inset frame color not under focus
25710 \begin_layout Description
25711 mathframe Math inset frame color under focus
25714 \begin_layout Description
25715 mathline Math line color
25718 \begin_layout Description
25719 mathmacrobg Macro math inset background color
25722 \begin_layout Description
25723 mathmacroblend Macro math blended color
25726 \begin_layout Description
25727 mathmacroframe Macro math frame color
25730 \begin_layout Description
25731 mathmacrohoverbg Macro math inset background color hovered
25734 \begin_layout Description
25735 mathmacrolabel Macro math label color
25738 \begin_layout Description
25739 mathmacronewarg Macro template color for new parameters
25742 \begin_layout Description
25743 mathmacrooldarg Macro template color for old parameters
25746 \begin_layout Description
25747 newpage New page color
25750 \begin_layout Description
25751 nonunique_inlinecompletion Inline completion color for the non-unique part
25754 \begin_layout Description
25755 notebg Background color of notes
25758 \begin_layout Description
25759 notelabel Label color for notes
25762 \begin_layout Description
25763 pagebreak Page break/line break color
25766 \begin_layout Description
25767 paragraphmarker Color used for the pilcrow sign to mark the end of a paragraph
25770 \begin_layout Description
25771 phantomtext Text color for phantom insets
25774 \begin_layout Description
25775 preview The color used for previews
25778 \begin_layout Description
25779 previewframe Preview frame color
25782 \begin_layout Description
25783 regexpframe Color for regexp frame
25786 \begin_layout Description
25787 selection Background color of selected text
25790 \begin_layout Description
25791 selectiontext Foreground color of selected text
25794 \begin_layout Description
25795 shadedbg Background color of shaded box
25798 \begin_layout Description
25799 special Special chars text color
25802 \begin_layout Description
25803 tabularline Table line color
25806 \begin_layout Description
25807 tabularonoffline Table line color
25810 \begin_layout Description
25811 urllabel Label color for URL insets
25814 \begin_layout Description
25815 urltext Color for URL inset text