1 #LyX 2.3 created this file. For more info see http://www.lyx.org/
5 \save_transient_properties true
6 \origin /systemlyxdir/doc/
9 % DO NOT ALTER THIS PREAMBLE!!!
11 % This preamble is designed to ensure that this document prints
12 % out as advertised. If you mess with this preamble,
13 % parts of this document may not print out as expected. If you
14 % have problems LaTeXing this file, please contact
15 % the documentation team
16 % email: lyx-docs@lists.lyx.org
18 % the pages of the TOC is numbered roman
19 % and a pdf-bookmark for the TOC is added
20 \let\myTOC\tableofcontents
21 \renewcommand\tableofcontents{%
23 \pdfbookmark[1]{\contentsname}{}
27 % increase link area for cross-references and autoname them,
28 \AtBeginDocument{\renewcommand{\ref}[1]{\mbox{\autoref{#1}}}}
29 \@ifundefined{extrasenglish}{\usepackage[english]{babel}}{}
30 \@ifpackageloaded{babel}{
31 \addto\extrasenglish{%
32 \renewcommand*{\equationautorefname}[1]{}%
33 \renewcommand{\sectionautorefname}{sec.\negthinspace}%
34 \renewcommand{\subsectionautorefname}{sec.\negthinspace}%
35 \renewcommand{\subsubsectionautorefname}{sec.\negthinspace}%
39 \options fleqn,bibliography=totoc,index=totoc,BCOR7.5mm,titlepage,captions=tableheading
40 \use_default_options false
44 \maintain_unincluded_children false
46 \language_package default
49 \font_roman "lmodern" "default"
50 \font_sans "lmss" "default"
51 \font_typewriter "lmtt" "default"
52 \font_math "auto" "auto"
53 \font_default_family default
54 \use_non_tex_fonts false
57 \font_sf_scale 100 100
58 \font_tt_scale 100 100
60 \default_output_format pdf2
62 \bibtex_command default
63 \index_command default
67 \pdf_title "LyX Configuration Manual"
68 \pdf_author "LyX Team"
69 \pdf_subject "LyX-documentation Customization"
70 \pdf_keywords "LyX, documentation, customization"
72 \pdf_bookmarksnumbered true
73 \pdf_bookmarksopen true
74 \pdf_bookmarksopenlevel 1
79 \pdf_pdfusetitle false
80 \pdf_quoted_options "linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue,pdfpagelayout=OneColumn, pdfnewwindow=true, pdfstartview=XYZ, plainpages=false"
83 \use_package amsmath 0
84 \use_package amssymb 0
87 \use_package mathdots 1
88 \use_package mathtools 0
90 \use_package stackrel 0
91 \use_package stmaryrd 0
92 \use_package undertilde 0
94 \cite_engine_type default
98 \paperorientation portrait
102 \notefontcolor #0000ff
114 \paragraph_separation indent
115 \paragraph_indentation default
116 \quotes_language english
119 \paperpagestyle headings
120 \tracking_changes true
121 \output_changes false
125 \author -712698321 "Jürgen Spitzmüller"
126 \author 2047637253 "Guillaume Munch"
127 \author 2089657418 "Usti"
133 Customizing \SpecialChar LyX
134 : Features for the Advanced User
138 by the \SpecialChar LyX
143 \begin_layout Plain Layout
145 If you have comments or error corrections, please send them to the \SpecialChar LyX
148 \begin_inset CommandInset href
150 target "lyx-docs@lists.lyx.org"
157 \begin_inset Quotes eld
161 \begin_inset Quotes erd
164 in the subject header, and please cc the current maintainer of this file,
165 Richard Heck <rgheck@comcast.net>.
171 \begin_inset Newline newline
175 \begin_inset Newline newline
181 \begin_layout Standard
182 \begin_inset CommandInset toc
183 LatexCommand tableofcontents
190 \begin_layout Standard
191 \begin_inset Note Note
194 \begin_layout Plain Layout
195 Please use change tracking when modifying this document.
196 This makes it easier for our translators to recognize things that have
197 been changed, and it helps the maintainer keep up-to-date with what's been
206 \begin_layout Chapter
210 \begin_layout Standard
211 This manual covers the customization features present in \SpecialChar LyX
213 In it, we discuss issues like keyboard shortcuts, screen previewing options,
214 printer options, sending commands to \SpecialChar LyX
215 via the \SpecialChar LyX
216 Server, internationalization,
217 installing new \SpecialChar LaTeX
218 classes and \SpecialChar LyX
220 We can't possibly hope to touch on everything you can change—our developers
221 add new features faster than we can document them—but we will explain the
222 most common customizations and hopefully point you in the right direction
223 for some of the more obscure ones.
226 \begin_layout Standard
227 \begin_inset Branch OutDated
230 \begin_layout Standard
231 Information from previous versions of this document that now seems to be
232 outdated is contained in the OutDated branch of this document.
233 By default, this information will not appear in the \SpecialChar LaTeX
242 \begin_layout Chapter
247 \begin_layout Standard
248 This chapter aims to help you to find your way through the \SpecialChar LyX
251 Before continuing to read this chapter, you should find out where your
253 library and user directories are by using
254 \begin_inset Flex Noun
257 \begin_layout Plain Layout
258 Help\SpecialChar menuseparator
269 The library directory is the place where \SpecialChar LyX
270 places its system-wide configuration
271 files; the user directory is where you can place your modified versions.
272 We will call the former
273 \begin_inset Flex Code
276 \begin_layout Plain Layout
283 \begin_inset Flex Noun
286 \begin_layout Plain Layout
292 in the remainder of this document.
296 \begin_layout Section
298 \begin_inset Flex Code
301 \begin_layout Plain Layout
310 \begin_layout Standard
311 \begin_inset Flex Code
314 \begin_layout Plain Layout
320 and its sub-directories contain a number of files and that can be used
321 to customize \SpecialChar LyX
323 You can change many of these files from within \SpecialChar LyX
325 \begin_inset Flex Noun
328 \begin_layout Plain Layout
329 Tools\SpecialChar menuseparator
336 Most customization that you will want to do in \SpecialChar LyX
337 is possible through this
339 However, many other inner aspects of \SpecialChar LyX
340 can be customized by modifying the
342 \begin_inset Flex Code
345 \begin_layout Plain Layout
352 These files fall in different categories, described in the following subsection
356 \begin_layout Subsection
357 Automatically generated files
360 \begin_layout Standard
361 The files, which are to be found in
362 \begin_inset Flex Noun
365 \begin_layout Plain Layout
371 , are generated when you configure \SpecialChar LyX
373 They contain various default values that are guessed by inspection.
374 In general, it is not a good idea to modify them, since they might be overwritt
378 \begin_layout Labeling
379 \labelwidthstring 00.00.0000
380 \begin_inset Flex Code
383 \begin_layout Plain Layout
389 contains defaults for various commands.
392 \begin_layout Labeling
393 \labelwidthstring 00.00.0000
394 \begin_inset Flex Code
397 \begin_layout Plain Layout
403 contains the list of packages that have been recognized by \SpecialChar LyX
405 It is currently unused by the \SpecialChar LyX
406 program itself, but the information extracted,
407 and more, is made available with
408 \begin_inset Flex Noun
411 \begin_layout Plain Layout
412 Help\SpecialChar menuseparator
426 \begin_layout Labeling
427 \labelwidthstring 00.00.0000
428 \begin_inset Flex Code
431 \begin_layout Plain Layout
437 the list of text classes that have been found in your
438 \begin_inset Flex Code
441 \begin_layout Plain Layout
447 directories, along with the associated \SpecialChar LaTeX
448 document class and their description.
451 \begin_layout Labeling
452 \labelwidthstring 00.00.0000
453 \begin_inset Flex Code
456 \begin_layout Plain Layout
462 the list of layout modules found in your
463 \begin_inset Flex Code
466 \begin_layout Plain Layout
475 \begin_layout Labeling
476 \labelwidthstring 00.00.0000
477 \begin_inset Flex Code
480 \begin_layout Plain Layout
486 lists of various sorts of \SpecialChar LaTeX
487 -related files found on your system
490 \begin_layout Labeling
491 \labelwidthstring 00.00.0000
492 \begin_inset Flex Code
495 \begin_layout Plain Layout
496 doc/\SpecialChar LaTeX
502 is automatically generated during configuration from the file
503 \begin_inset Flex Code
506 \begin_layout Plain Layout
514 It contains information on your \SpecialChar LaTeX
518 \begin_layout Subsection
522 \begin_layout Standard
523 These directories are duplicated between
524 \begin_inset Flex Code
527 \begin_layout Plain Layout
534 \begin_inset Flex Code
537 \begin_layout Plain Layout
544 If a particular files exists in both places, the one in
545 \begin_inset Flex Code
548 \begin_layout Plain Layout
557 \begin_layout Labeling
558 \labelwidthstring 00.00.0000
559 \begin_inset Flex Code
562 \begin_layout Plain Layout
568 this directory contains files with the extension
569 \begin_inset Flex Code
572 \begin_layout Plain Layout
578 that define the keybindings used in \SpecialChar LyX
580 If there exists an internationalized version of the bind file named
581 \begin_inset Flex Code
584 \begin_layout Plain Layout
590 , that will be used first.
593 \begin_layout Labeling
594 \labelwidthstring 00.00.0000
595 \begin_inset Flex Code
598 \begin_layout Plain Layout
604 contains graphics files that can be included in documents.
608 \begin_layout Labeling
609 \labelwidthstring 00.00.0000
610 \begin_inset Flex Code
613 \begin_layout Plain Layout
619 contains \SpecialChar LyX
620 documentation files (including the one you are currently reading).
622 \begin_inset Flex Code
625 \begin_layout Plain Layout
632 deserves special attention, as noted above.
633 The internationalized help docs are in subdirectories
634 \begin_inset Flex Code
637 \begin_layout Plain Layout
644 \begin_inset Quotes eld
648 \begin_inset Quotes erd
651 is the ISO language code.
653 \begin_inset CommandInset ref
655 reference "cha:Internationalizing-LyX"
662 \begin_layout Labeling
663 \labelwidthstring 00.00.0000
664 \begin_inset Flex Code
667 \begin_layout Plain Layout
673 contains example files that explain how to use some features.
674 In the file browser, press the
675 \begin_inset Flex Noun
678 \begin_layout Plain Layout
687 \begin_layout Labeling
688 \labelwidthstring 00.00.0000
689 \begin_inset Flex Code
692 \begin_layout Plain Layout
698 contains image files that are used by the
699 \begin_inset Flex Noun
702 \begin_layout Plain Layout
709 In addition, it also contains the individual icons used in the toolbar
710 and the banners that can be shown when \SpecialChar LyX
714 \begin_layout Labeling
715 \labelwidthstring 00.00.0000
716 \begin_inset Flex Code
719 \begin_layout Plain Layout
725 contains keyboard keymapping files.
727 \begin_inset CommandInset ref
729 reference "sec:International-Keymap-Stuff"
736 \begin_layout Labeling
737 \labelwidthstring 00.00.0000
738 \begin_inset Flex Code
741 \begin_layout Plain Layout
747 contains the text class and module files described in
748 \begin_inset CommandInset ref
750 reference "cha:Installing-New-Document"
757 \begin_layout Labeling
758 \labelwidthstring 00.00.0000
759 \begin_inset Flex Code
762 \begin_layout Plain Layout
769 \begin_inset Flex Code
772 \begin_layout Plain Layout
778 Python scripts used to convert between \SpecialChar LyX
780 These can be run from the command line if, say, you want to batch-convert
784 \begin_layout Labeling
785 \labelwidthstring 00.00.0000
786 \begin_inset Flex Code
789 \begin_layout Plain Layout
795 contains some files that demonstrate the capabilities of the
796 \begin_inset Flex Noun
799 \begin_layout Plain Layout
810 Also contains some scripts used by \SpecialChar LyX
814 \begin_layout Labeling
815 \labelwidthstring 00.00.0000
816 \begin_inset Flex Code
819 \begin_layout Plain Layout
825 contains the standard \SpecialChar LyX
826 template files described in
827 \begin_inset CommandInset ref
829 reference "subsec:Creating-Templates"
836 \begin_layout Labeling
837 \labelwidthstring 00.00.0000
838 \begin_inset Flex Code
841 \begin_layout Plain Layout
847 contains files with the extension
848 \begin_inset Flex Code
851 \begin_layout Plain Layout
857 that define the user interface to \SpecialChar LyX
859 That is, the files define which items appear in which menus and the items
860 appearing on the toolbar.
863 \begin_layout Subsection
864 Files you don't want to modify
867 \begin_layout Standard
868 These files are used internally by \SpecialChar LyX
869 and you generally do not need to modify
870 them unless you are a developer.
873 \begin_layout Labeling
874 \labelwidthstring 00.00.0000
875 \begin_inset Flex Code
878 \begin_layout Plain Layout
884 this file contains the list of \SpecialChar LyX
886 The contents are displayed with the menu entry
887 \begin_inset Flex Noun
890 \begin_layout Plain Layout
891 Help\SpecialChar menuseparator
904 \begin_layout Labeling
905 \labelwidthstring 00.00.0000
906 \begin_inset Flex Code
909 \begin_layout Plain Layout
915 this is a \SpecialChar LaTeX
916 script used during the configuration process.
920 \begin_layout Labeling
921 \labelwidthstring 00.00.0000
922 \begin_inset Flex Code
925 \begin_layout Plain Layout
931 this is a Python script that is used to re-configure \SpecialChar LyX
933 It creates configuration files in the directory it was run from.
936 \begin_layout Subsection
937 Other files needing a line or two
940 \begin_layout Labeling
941 \labelwidthstring 00.00.0000
942 \begin_inset Flex Code
945 \begin_layout Plain Layout
951 this contains tables describing how different character encodings can be
955 \begin_layout Labeling
956 \labelwidthstring 00.00.0000
957 \begin_inset Flex Code
960 \begin_layout Plain Layout
966 this file contains the templates available to the new
967 \begin_inset Flex Noun
970 \begin_layout Plain Layout
981 \begin_inset CommandInset ref
983 reference "chap:Including-External-Material"
990 \begin_layout Labeling
991 \labelwidthstring 00.00.0000
992 \begin_inset Flex Code
995 \begin_layout Plain Layout
1001 this file contains a list of all the languages currently supported by \SpecialChar LyX
1005 \begin_layout Labeling
1006 \labelwidthstring 00.00.0000
1007 \begin_inset Flex Code
1010 \begin_layout Plain Layout
1016 contains information about the supported fonts.
1019 \begin_layout Labeling
1020 \labelwidthstring 00.00.0000
1021 \begin_inset Flex Code
1024 \begin_layout Plain Layout
1030 this file contains translations for internationalized paragraph styles
1032 \begin_inset CommandInset ref
1034 reference "subsec:I18n"
1041 \begin_layout Labeling
1042 \labelwidthstring 00.00.0000
1043 \begin_inset Flex Code
1046 \begin_layout Plain Layout
1052 this file contains information about unicode-encoded glyphs and the way
1053 they are supported by \SpecialChar LyX
1054 via \SpecialChar LaTeX
1058 \begin_layout Section
1059 Your local configuration directory
1062 \begin_layout Standard
1063 Even if you are using \SpecialChar LyX
1064 as an unprivileged user, you might want to change
1066 configuration for your own use.
1068 \begin_inset Flex Code
1071 \begin_layout Plain Layout
1077 directory contains all your personal configuration files.
1078 This is the directory described as
1079 \begin_inset Quotes eld
1083 \begin_inset Quotes erd
1087 \begin_inset Flex Noun
1090 \begin_layout Plain Layout
1091 Help\SpecialChar menuseparator
1093 \begin_inset space ~
1102 This directory is used as a mirror of
1103 \begin_inset Flex Code
1106 \begin_layout Plain Layout
1112 , which means that every file in
1113 \begin_inset Flex Code
1116 \begin_layout Plain Layout
1122 is a replacement for the corresponding file in
1123 \begin_inset Flex Code
1126 \begin_layout Plain Layout
1133 Any configuration file described in the above sections can be placed either
1134 in the system-wide directory, in which case it will affect all users, or
1135 in your local directory for your own use.
1138 \begin_layout Standard
1139 To make things clearer, let's provide a few examples:
1142 \begin_layout Itemize
1143 The preferences set in the
1144 \begin_inset Flex Noun
1147 \begin_layout Plain Layout
1148 Tools\SpecialChar menuseparator
1154 dialog are saved to a file
1155 \begin_inset Flex Code
1158 \begin_layout Plain Layout
1165 \begin_inset Flex Code
1168 \begin_layout Plain Layout
1177 \begin_layout Itemize
1178 When you reconfigure using
1179 \begin_inset Flex Noun
1182 \begin_layout Plain Layout
1183 Tools\SpecialChar menuseparator
1191 \begin_inset Flex Code
1194 \begin_layout Plain Layout
1200 script, and the resulting files are written in your local configuration
1202 This means that any additional text class file that you might have added
1204 \begin_inset Flex Code
1207 \begin_layout Plain Layout
1213 will be added to the list of classes in the
1214 \begin_inset Flex Noun
1217 \begin_layout Plain Layout
1218 Document\SpecialChar menuseparator
1227 \begin_layout Itemize
1228 If you get some updated documentation from \SpecialChar LyX
1229 ftp site and cannot install
1230 it because you do not have sysadmin rights on your system, you can just
1232 \begin_inset Flex Code
1235 \begin_layout Plain Layout
1241 and the items in the
1242 \begin_inset Flex Noun
1245 \begin_layout Plain Layout
1251 menu will open them!
1254 \begin_layout Section
1255 Running \SpecialChar LyX
1256 with multiple configurations
1259 \begin_layout Standard
1260 The configuration freedom of the local configuration directory may not suffice
1261 if you want to have more than one configuration at your disposal.
1262 For example, you may want to be use different key bindings or printer settings
1264 You can achieve this by having several such directories.
1265 You then specify which directory to use at run-time.
1268 \begin_layout Standard
1269 Invoking \SpecialChar LyX
1270 with the command line switch
1271 \begin_inset Flex Code
1274 \begin_layout Plain Layout
1284 instructs the program to read the configuration from that directory, and
1285 not from the default directory.
1286 (You can determine the default directory by running \SpecialChar LyX
1288 \begin_inset Flex Code
1291 \begin_layout Plain Layout
1297 switch.) If the specified directory does not exist, \SpecialChar LyX
1299 for you, just like it does for the default directory on the first time
1300 you run the program.
1301 You can modify the configuration options in this additional user directory
1302 exactly as you would for the default directory.
1303 These directories are completely independent (but read on).
1304 Note that setting the environment variable
1305 \begin_inset Flex Code
1308 \begin_layout Plain Layout
1314 to some value has exactly the same effect.
1317 \begin_layout Standard
1318 Having several configurations also requires more maintenance: if you want
1319 to add a new layout to
1320 \begin_inset Flex Code
1323 \begin_layout Plain Layout
1329 which you want available from all your configurations, you must add it
1330 to each directory separately.
1331 You can avoid this with the following trick: after \SpecialChar LyX
1332 creates the additional
1333 directory, most of the subdirectories (see above) are empty.
1334 If you want the new configuration to mirror an existing one, replace the
1335 empty subdirectory with a symbolic link to the matching subdirectory in
1336 the existing configuration.
1338 \begin_inset Flex Code
1341 \begin_layout Plain Layout
1347 subdirectory, however, since it contains a file written by the configuration
1348 script (also accessible through
1349 \begin_inset Flex Noun
1352 \begin_layout Plain Layout
1353 Tools\SpecialChar menuseparator
1359 ) which is configuration-specific.
1362 \begin_layout Chapter
1363 The Preferences dialog
1366 \begin_layout Standard
1367 All options of the preferences dialog are described in the Appendix
1369 The Preferences Dialog
1376 For some options you might find here more details.
1379 \begin_layout Section
1381 \begin_inset CommandInset label
1390 \begin_layout Standard
1391 The first step is to define your file formats if they are not already defined.
1393 \begin_inset Flex Noun
1396 \begin_layout Plain Layout
1397 Tools\SpecialChar menuseparator
1405 \begin_inset Flex Noun
1408 \begin_layout Plain Layout
1409 File Handling\SpecialChar menuseparator
1416 \begin_inset Flex Noun
1419 \begin_layout Plain Layout
1425 button to define your new format.
1427 \begin_inset Flex Noun
1430 \begin_layout Plain Layout
1436 field contains the name used to identify the format in the GUI.
1438 \begin_inset Flex Noun
1441 \begin_layout Plain Layout
1447 is used to identify the format internally.
1448 You will also need to enter a file extension.
1449 These are all required.
1451 \begin_inset Flex Noun
1454 \begin_layout Plain Layout
1460 field is used to provide a keyboard shortcut on the menus.
1461 (For example, pressing
1462 \begin_inset Flex Noun
1465 \begin_layout Plain Layout
1472 \begin_inset Flex Noun
1475 \begin_layout Plain Layout
1476 Document\SpecialChar menuseparator
1477 View (Other Formats)\SpecialChar menuseparator
1486 \begin_layout Standard
1488 \begin_inset Flex Noun
1491 \begin_layout Plain Layout
1498 \begin_inset Flex Noun
1501 \begin_layout Plain Layout
1508 For example, you might want to use
1509 \begin_inset Flex Noun
1512 \begin_layout Plain Layout
1518 to view PostScript files.
1519 You can enter the command needed to start the program in the corresponding
1521 In defining this command, you can use the four variables listed in the
1523 The viewer is launched when you view an image in \SpecialChar LyX
1525 \begin_inset Flex Noun
1528 \begin_layout Plain Layout
1529 Document\SpecialChar menuseparator
1536 The editor is for example launched when you right-click on an image and
1538 \begin_inset Flex Noun
1541 \begin_layout Plain Layout
1547 in the appearing context menu.
1550 \begin_layout Standard
1552 \begin_inset Flex Noun
1555 \begin_layout Plain Layout
1561 type of a format is optional, but if it is specified, it must be unique
1563 It is used to detect files of this format from the file contents.
1564 For some important file formats there is no MIME type officially registered
1566 \begin_inset CommandInset href
1569 target "http://www.iana.org/assignments/media-types/"
1574 Therefore \SpecialChar LyX
1575 uses the extended list of MIME types as specified by
1576 \begin_inset CommandInset href
1578 name "freedesktop.org"
1579 target "http://www.freedesktop.org/wiki/Specifications/shared-mime-info-spec"
1586 \begin_layout Standard
1588 \begin_inset Flex Noun
1591 \begin_layout Plain Layout
1597 option tells \SpecialChar LyX
1598 that a format is suitable for document export.
1599 If this is set and if a suitable conversion route exists (see
1600 \begin_inset CommandInset ref
1602 reference "sec:Converters"
1606 ), the format will appear in the
1607 \begin_inset Flex Noun
1610 \begin_layout Plain Layout
1611 File\SpecialChar menuseparator
1618 The format will also appear in the
1619 \begin_inset Flex Noun
1622 \begin_layout Plain Layout
1623 Document\SpecialChar menuseparator
1629 menu if a viewer is specified for the format.
1630 Pure image formats, such as
1631 \begin_inset Flex Code
1634 \begin_layout Plain Layout
1640 , should not use this option.
1641 Formats that can both represent vector graphics and documents like
1642 \begin_inset Flex Code
1645 \begin_layout Plain Layout
1654 \begin_layout Standard
1656 \begin_inset Flex Noun
1659 \begin_layout Plain Layout
1660 Vector graphics format
1665 tells \SpecialChar LyX
1666 that a format can contain vector graphics.
1667 This information is used to determine the target format of included graphics
1669 \begin_inset Flex Noun
1672 \begin_layout Plain Layout
1679 Included graphics may need to be converted to either
1680 \begin_inset Flex Noun
1683 \begin_layout Plain Layout
1690 \begin_inset Flex Noun
1693 \begin_layout Plain Layout
1700 \begin_inset Flex Noun
1703 \begin_layout Plain Layout
1710 \begin_inset Flex Noun
1713 \begin_layout Plain Layout
1719 cannot handle other image formats.
1720 If an included graphic is not already in
1721 \begin_inset Flex Noun
1724 \begin_layout Plain Layout
1731 \begin_inset Flex Noun
1734 \begin_layout Plain Layout
1741 \begin_inset Flex Noun
1744 \begin_layout Plain Layout
1750 format, it is converted to
1751 \begin_inset Flex Noun
1754 \begin_layout Plain Layout
1760 if the vector format option is set, and otherwise to
1761 \begin_inset Flex Noun
1764 \begin_layout Plain Layout
1773 \begin_layout Section
1777 \begin_layout Standard
1778 Since all conversions from one format to another take place in \SpecialChar LyX
1780 directory, it is sometimes necessary to modify a file before copying it
1781 to the temporary directory in order that the conversion may be performed.
1785 \begin_layout Plain Layout
1786 For example, the file may refer to other files—images, for example—using
1787 relative file names, and these may become invalid when the file is copied
1788 to the temporary directory.
1793 This is done by a Copier: It copies a file to (or from) the temporary directory
1794 and may modify it in the process.
1797 \begin_layout Standard
1798 The definitions of the copiers may use eight variables:
1801 \begin_layout Labeling
1802 \labelwidthstring 00.00.0000
1803 \begin_inset Flex Code
1806 \begin_layout Plain Layout
1812 The \SpecialChar LyX
1813 system directory (e.
1814 \begin_inset space \thinspace{}
1818 \begin_inset space \space{}
1822 \begin_inset Flex Noun
1825 \begin_layout Plain Layout
1834 \begin_layout Labeling
1835 \labelwidthstring 00.00.0000
1836 \begin_inset Flex Code
1839 \begin_layout Plain Layout
1848 \begin_layout Labeling
1849 \labelwidthstring 00.00.0000
1850 \begin_inset Flex Code
1853 \begin_layout Plain Layout
1862 \begin_layout Labeling
1863 \labelwidthstring 00.00.0000
1864 \begin_inset Flex Code
1867 \begin_layout Plain Layout
1873 The base name (without filename extension) in the \SpecialChar LyX
1877 \begin_layout Labeling
1878 \labelwidthstring 00.00.0000
1879 \begin_inset Flex Code
1882 \begin_layout Plain Layout
1888 The full directory path of the \SpecialChar LyX
1892 \begin_layout Labeling
1893 \labelwidthstring 00.00.0000
1894 \begin_inset Flex Code
1897 \begin_layout Plain Layout
1903 The full pathname to the original \SpecialChar LyX
1904 file being processed
1907 \begin_layout Labeling
1908 \labelwidthstring 00.00.0000
1909 \begin_inset Flex Code
1912 \begin_layout Plain Layout
1918 The filename (without any directory path) of the \SpecialChar LyX
1922 \begin_layout Labeling
1923 \labelwidthstring 00.00.0000
1924 \begin_inset Flex Code
1927 \begin_layout Plain Layout
1933 The `\SpecialChar LaTeX
1937 \begin_layout Standard
1938 The latter should be the filename as it would be used in a \SpecialChar LaTeX
1946 It is relevant only when exporting files suitable for such inclusion.
1949 \begin_layout Standard
1950 Copiers can be used to do almost anything with output files.
1951 For example, suppose you want generated pdf files to be copied to a special
1953 \begin_inset Flex Code
1956 \begin_layout Plain Layout
1963 Then you could write a shell script such as this one:
1966 \begin_layout Standard
1967 \begin_inset listings
1971 \begin_layout Plain Layout
1976 \begin_layout Plain Layout
1981 \begin_layout Plain Layout
1983 TOFILE=`basename $2`
1986 \begin_layout Plain Layout
1988 cp $FROMFILE /home/you/pdf/$TOFILE
1993 Save it in your local \SpecialChar LyX
1995 \begin_inset Flex Code
1998 \begin_layout Plain Layout
1999 /home/you/.lyx/scripts/pdfcopier.sh
2004 —and make it executable, if you need to do so on your platform.
2006 \begin_inset Flex Noun
2009 \begin_layout Plain Layout
2010 Tools\SpecialChar menuseparator
2016 dialog, select under
2017 \begin_inset Flex Noun
2020 \begin_layout Plain Layout
2021 File Handling\SpecialChar menuseparator
2028 \begin_inset Flex Noun
2031 \begin_layout Plain Layout
2037 format—or one of the other pdf formats—and enter
2038 \begin_inset Flex Code
2041 \begin_layout Plain Layout
2042 pdfcopier.sh $$i $$o
2048 \begin_inset Flex Noun
2051 \begin_layout Plain Layout
2061 \begin_layout Standard
2062 Copiers are used by \SpecialChar LyX
2063 in various of its own conversions.
2064 For example, if appropriate programs are found, \SpecialChar LyX
2065 will automatically install
2067 \begin_inset Flex Noun
2070 \begin_layout Plain Layout
2077 \begin_inset Flex Noun
2080 \begin_layout Plain Layout
2082 \begin_inset space ~
2091 When these formats are exported, the copier sees that not just the main
2092 HTML file but various associated files (style files, images, etc.) are also
2094 All these files are written to a subdirectory of the directory in which
2095 the original \SpecialChar LyX
2100 \begin_layout Plain Layout
2101 This copier can be customized.
2103 \begin_inset Quotes eld
2107 \begin_inset Quotes erd
2110 argument takes a comma-separated list of extensions to be copied; if it
2111 is omitted, all files will be copied.
2113 \begin_inset Quotes eld
2117 \begin_inset Quotes erd
2120 argument determines the extension added to the generated directory.
2122 \begin_inset Quotes eld
2126 \begin_inset Flex Noun
2129 \begin_layout Plain Layout
2136 \begin_inset Quotes erd
2139 , so HTML generated from
2140 \begin_inset Flex Noun
2143 \begin_layout Plain Layout
2144 /path/to/filename.lyx
2150 \begin_inset Flex Noun
2153 \begin_layout Plain Layout
2154 /path/to/filename.html.LyXconv
2168 \begin_layout Section
2170 \begin_inset CommandInset label
2172 name "sec:Converters"
2179 \begin_layout Standard
2180 You can define your own Converters to convert files between different formats.
2182 \begin_inset Flex Noun
2185 \begin_layout Plain Layout
2186 Tools\SpecialChar menuseparator
2187 Preferences\SpecialChar menuseparator
2188 File Handling\SpecialChar menuseparator
2197 \begin_layout Standard
2198 To define a new converter, select the
2199 \begin_inset Flex Noun
2202 \begin_layout Plain Layout
2204 \begin_inset space ~
2213 \begin_inset Flex Noun
2216 \begin_layout Plain Layout
2218 \begin_inset space ~
2226 from the drop-down lists, enter the command needed for the conversion,
2228 \begin_inset Flex Noun
2231 \begin_layout Plain Layout
2238 Several variables can be used in the definition of converters:
2241 \begin_layout Labeling
2242 \labelwidthstring 00.00.0000
2243 \begin_inset Flex Code
2246 \begin_layout Plain Layout
2252 The \SpecialChar LyX
2256 \begin_layout Labeling
2257 \labelwidthstring 00.00.0000
2258 \begin_inset Flex Code
2261 \begin_layout Plain Layout
2270 \begin_layout Labeling
2271 \labelwidthstring 00.00.0000
2272 \begin_inset Flex Code
2275 \begin_layout Plain Layout
2284 \begin_layout Labeling
2285 \labelwidthstring 00.00.0000
2286 \begin_inset Flex Code
2289 \begin_layout Plain Layout
2295 The base filename of the input file (i.
2296 \begin_inset space \thinspace{}
2299 g., without the extension)
2302 \begin_layout Labeling
2303 \labelwidthstring 00.00.0000
2304 \begin_inset Flex Code
2307 \begin_layout Plain Layout
2313 The path to the input file
2316 \begin_layout Labeling
2317 \labelwidthstring 00.00.0000
2318 \begin_inset Flex Code
2321 \begin_layout Plain Layout
2327 The path to the original input file (this is different from $$p when a
2328 chain of converters is called)
2331 \begin_layout Labeling
2332 \labelwidthstring 00.00.0000
2333 \begin_inset Flex Code
2336 \begin_layout Plain Layout
2342 The iconv name for the encoding of the document.
2345 \begin_layout Standard
2347 \begin_inset Flex Noun
2350 \begin_layout Plain Layout
2352 \begin_inset space ~
2360 field you can enter the following flags, separated by commas:
2363 \begin_layout Labeling
2364 \labelwidthstring 00.00.0000
2365 \begin_inset Flex Code
2368 \begin_layout Plain Layout
2374 This converter runs some form of \SpecialChar LaTeX
2376 This will make \SpecialChar LyX
2377 's \SpecialChar LaTeX
2378 error logs available.
2381 \begin_layout Labeling
2382 \labelwidthstring 00.00.0000
2383 \begin_inset Flex Code
2386 \begin_layout Plain Layout
2392 Needs the \SpecialChar LaTeX
2394 \begin_inset Flex Noun
2397 \begin_layout Plain Layout
2403 file for the conversion.
2406 \begin_layout Labeling
2407 \labelwidthstring 00.00.0000
2408 \begin_inset Flex Code
2411 \begin_layout Plain Layout
2418 \begin_inset Quotes eld
2422 \begin_inset Quotes erd
2425 file from the backend, which in practice means a \SpecialChar LaTeX
2426 file like the one we
2427 would export, without
2428 \begin_inset Flex Code
2431 \begin_layout Plain Layout
2440 \begin_layout Labeling
2441 \labelwidthstring 00.00.0000
2442 \begin_inset Flex Code
2445 \begin_layout Plain Layout
2454 \begin_layout Standard
2455 The following three flags are not really flags at all because they take
2457 \begin_inset Flex Noun
2460 \begin_layout Plain Layout
2462 \begin_inset space ~
2466 \begin_inset space ~
2477 \begin_layout Labeling
2478 \labelwidthstring 00.00.0000
2479 \begin_inset Flex Code
2482 \begin_layout Plain Layout
2488 If set, the converter's standard error will be redirected to a file
2489 \begin_inset Flex Code
2492 \begin_layout Plain Layout
2498 , and the script given as argument will be run as:
2499 \begin_inset Flex Code
2502 \begin_layout Plain Layout
2503 script < infile.out > infile.log
2509 The argument may contain
2510 \begin_inset Flex Code
2513 \begin_layout Plain Layout
2522 \begin_layout Labeling
2523 \labelwidthstring 00.00.0000
2524 \begin_inset Flex Code
2527 \begin_layout Plain Layout
2533 The name of the directory in which the converter will dump the generated
2536 will not create this directory, and it does not copy anything into it,
2537 though it will copy this directory to the destination.
2538 The argument may contain
2539 \begin_inset Flex Code
2542 \begin_layout Plain Layout
2548 , which will be replaced by the base name of the input and output files,
2549 respectively, when the directory is copied.
2550 \begin_inset Newline newline
2553 Note that resultdir and usetempdir make no sense together.
2554 The latter will be ignored if the former is given.
2557 \begin_layout Labeling
2558 \labelwidthstring 00.00.0000
2559 \begin_inset Flex Code
2562 \begin_layout Plain Layout
2568 Determines the output file name and may, contain
2569 \begin_inset Flex Code
2572 \begin_layout Plain Layout
2579 Sensible only with resultdir and optional even then; if not given, it defaults
2583 \begin_layout Standard
2584 None of these last three are presently used in any of the converters that
2585 are installed with \SpecialChar LyX
2590 \begin_layout Standard
2591 You do not have to define converters for all formats between which you want
2593 For example, you will note that there is no `\SpecialChar LyX
2594 to PostScript' converter,
2595 but \SpecialChar LyX
2596 will export PostScript.
2597 It does so by first creating a \SpecialChar LaTeX
2598 file (no converter needs to be defined
2599 for this) which is then converted to DVI using the `\SpecialChar LaTeX
2601 and finally converting the resulting DVI file to PostScript.
2603 finds such `chains' of converters automatically, and it will always choose
2604 the shortest possible chain.
2605 You can, though, still define multiple conversion methods between file
2607 For example, the standard \SpecialChar LyX
2608 configuration provides five ways to convert
2613 \begin_layout Enumerate
2615 \begin_inset Flex Noun
2618 \begin_layout Plain Layout
2627 \begin_layout Enumerate
2628 via (DVI and) PostScript, using
2629 \begin_inset Flex Noun
2632 \begin_layout Plain Layout
2641 \begin_layout Enumerate
2643 \begin_inset Flex Noun
2646 \begin_layout Plain Layout
2655 \begin_layout Enumerate
2657 \begin_inset Flex Noun
2660 \begin_layout Plain Layout
2670 \begin_layout Enumerate
2672 \begin_inset Flex Noun
2675 \begin_layout Plain Layout
2685 \begin_layout Standard
2686 To define such alternate chains, you must define multiple target `file formats',
2688 \begin_inset CommandInset ref
2690 reference "sec:Formats"
2695 For example, in the standard configuration, the formats named
2696 \begin_inset Flex Noun
2699 \begin_layout Plain Layout
2706 \begin_inset Flex Noun
2709 \begin_layout Plain Layout
2716 \begin_inset Flex Noun
2719 \begin_layout Plain Layout
2726 \begin_inset Flex Noun
2729 \begin_layout Plain Layout
2736 \begin_inset Flex Noun
2739 \begin_layout Plain Layout
2746 \begin_inset Flex Noun
2749 \begin_layout Plain Layout
2756 \begin_inset Flex Noun
2759 \begin_layout Plain Layout
2766 \begin_inset Flex Noun
2769 \begin_layout Plain Layout
2777 \begin_inset Flex Noun
2780 \begin_layout Plain Layout
2787 \begin_inset Flex Noun
2790 \begin_layout Plain Layout
2797 ) are defined, all of which share the extension
2798 \begin_inset Flex Noun
2801 \begin_layout Plain Layout
2807 , and which correspond to the conversion methods just mentioned.
2810 \begin_layout Chapter
2811 Internationalizing \SpecialChar LyX
2813 \begin_inset CommandInset label
2815 name "cha:Internationalizing-LyX"
2822 \begin_layout Standard
2824 supports using a translated interface.
2825 Last time we checked, \SpecialChar LyX
2826 provided text in thirty languages.
2827 The language of choice is called your
2832 (For further reading on locale settings, see also the documentation for
2833 locale that comes with your operating system.
2834 For Linux, the manual page for
2835 \begin_inset Flex Code
2838 \begin_layout Plain Layout
2844 could be a good place to start).
2847 \begin_layout Standard
2848 Notice that these translations will work, but do contain a few flaws.
2849 In particular, all dialogs have been designed with the English text in
2850 mind, which means that some of the translated text will be too large to
2851 fit within the space allocated.
2852 This is only a display problem and will not cause any harm.
2853 Also, you will find that some of the translations do not define shortcut
2854 keys for everything.
2855 Sometimes, there are simply not enough free letters to do it.
2856 Other times, the translator just hasn't got around to doing it yet.
2857 Our localization team, which you may wish to join,
2861 \begin_layout Plain Layout
2862 If you are a fluent speaker of a language other than English, joining these
2863 teams is a great way to give back to the \SpecialChar LyX
2869 will of course try to fix these shortcomings in future versions of \SpecialChar LyX
2873 \begin_layout Section
2874 Translating \SpecialChar LyX
2878 \begin_layout Subsection
2879 Translating the graphical user interface (text messages).
2882 \begin_layout Standard
2885 \begin_inset Flex Code
2888 \begin_layout Plain Layout
2894 library to handle the internationalization of the interface.
2895 To have \SpecialChar LyX
2896 speak your favorite language in all menus and dialogs, you need
2898 \begin_inset Flex Code
2901 \begin_layout Plain Layout
2907 -file for that language.
2908 When this is available, you'll have to generate a
2909 \begin_inset Flex Code
2912 \begin_layout Plain Layout
2918 -file from it and install the
2919 \begin_inset Flex Code
2922 \begin_layout Plain Layout
2929 The process of doing all of this is explained in the documentation for
2931 \begin_inset Flex Code
2934 \begin_layout Plain Layout
2941 It is possible to do this just for yourself, but if you're going to do
2942 it, you might as well share the results of your labors with the rest of
2943 the \SpecialChar LyX
2945 Send a message to the \SpecialChar LyX
2946 developers' list for more information about how
2950 \begin_layout Standard
2951 In short, this is what you should do (xx denotes the language code):
2954 \begin_layout Itemize
2955 Check out the \SpecialChar LyX
2958 \begin_inset CommandInset href
2960 name "information on the web"
2961 target "http://www.lyx.org/HowToUseGIT"
2968 \begin_layout Itemize
2970 \begin_inset Flex Code
2973 \begin_layout Plain Layout
2979 to the folder of the
2980 \begin_inset Flex Code
2983 \begin_layout Plain Layout
2991 \begin_inset Flex Code
2994 \begin_layout Plain Layout
3002 \begin_inset Flex Code
3005 \begin_layout Plain Layout
3011 doesn't exist anywhere, it can be remade with the console command
3012 \begin_inset Flex Code
3015 \begin_layout Plain Layout
3021 in that directory, or you can use an existing po-file for some other language
3025 \begin_layout Itemize
3027 \begin_inset Flex Code
3030 \begin_layout Plain Layout
3040 \begin_layout Plain Layout
3041 This is just a text file, so it can be edited in any text editor.
3042 But there are also specialized programs that support such editing, such
3047 (for all platforms) or
3056 contains a `mode' for editing
3057 \begin_inset Flex Code
3060 \begin_layout Plain Layout
3067 \begin_inset Flex URL
3070 \begin_layout Plain Layout
3072 https://www.gnu.org/software/gettext/manual/html_node/PO-Mode.html
3084 For some menu- and widget-labels, there are also shortcut keys that should
3086 Those keys are marked after a `|', and should be translated according to
3087 the words and phrases of the language.
3088 You should also fill also out the information at the beginning of the new
3090 \begin_inset Flex Code
3093 \begin_layout Plain Layout
3099 -file with your email-address, etc., so people know where to reach you with
3100 suggestions and entertaining flames.
3103 \begin_layout Standard
3104 If you are just doing this on your own, then:
3107 \begin_layout Itemize
3109 \begin_inset Flex Code
3112 \begin_layout Plain Layout
3119 This can be done with
3120 \begin_inset Flex Code
3123 \begin_layout Plain Layout
3124 msgfmt -o xx.mo < xx.po
3132 \begin_layout Itemize
3134 \begin_inset Flex Code
3137 \begin_layout Plain Layout
3143 -file to your locale-tree, at the correct directory for application messages
3148 xx, and under the name
3149 \begin_inset Flex Code
3152 \begin_layout Plain Layout
3159 \begin_inset space \thinspace{}
3163 \begin_inset space \space{}
3167 \begin_inset Flex Code
3170 \begin_layout Plain Layout
3171 /usr/local/share/locale/xx/LC_MESSAGES/lyx.mo
3181 \begin_layout Standard
3182 As said, however, it would be best if the new
3183 \begin_inset Flex Code
3186 \begin_layout Plain Layout
3192 file could be added to the \SpecialChar LyX
3193 distribution, so others can use it.
3194 Adding it involves making additional changes to \SpecialChar LyX
3196 So send an email to the developers' mailing list if you're interested in
3200 \begin_layout Subsubsection
3204 \begin_layout Standard
3205 Sometimes it turns out that one English message needs to be translated into
3206 different messages in the target language.
3207 One example is the message
3208 \begin_inset Flex Code
3211 \begin_layout Plain Layout
3217 which has the German translation
3225 , depending upon exactly what the English
3226 \begin_inset Quotes eld
3230 \begin_inset Quotes erd
3235 \begin_inset Flex Code
3238 \begin_layout Plain Layout
3244 does not handle such ambiguous translations.
3245 Therefore you have to add some context information to the message: Instead
3247 \begin_inset Flex Code
3250 \begin_layout Plain Layout
3257 \begin_inset Flex Code
3260 \begin_layout Plain Layout
3261 To[[as in 'From format x to format y']]
3267 \begin_inset Flex Code
3270 \begin_layout Plain Layout
3271 To[[as in 'From page x to page y']].
3276 Now the two occurrences of
3277 \begin_inset Flex Code
3280 \begin_layout Plain Layout
3287 \begin_inset Flex Code
3290 \begin_layout Plain Layout
3296 and can be translated correctly to
3307 \begin_layout Standard
3308 Of course the context information needs to be stripped off the original
3309 message when no translation is used.
3310 Therefore you have to put it in double square brackets at the end of the
3311 message (see the example above).
3312 The translation mechanism of \SpecialChar LyX
3313 ensures that everything in double square
3314 brackets at the end of messages is removed before displaying the message.
3317 \begin_layout Subsection
3318 Translating the documentation.
3321 \begin_layout Standard
3322 The online documentation (in the
3323 \begin_inset Flex Noun
3326 \begin_layout Plain Layout
3332 -menu) can (and should!) be translated.
3333 If there are translated versions of the documentation available
3337 \begin_layout Plain Layout
3338 As of March 2008, at least some of the documents have been translated into
3339 fourteen languages, with the Tutorial available in a few more.
3344 and the locale is set accordingly, these will be used automagically by
3348 looks for translated versions as
3349 \begin_inset Flex Code
3352 \begin_layout Plain Layout
3353 LyXDir/doc/xx/DocName.lyx
3359 \begin_inset Flex Code
3362 \begin_layout Plain Layout
3368 is the code for the language currently in use.
3369 If there are no translated documents, the default English versions will
3371 Note that the translated versions must have the same filenames (
3372 \begin_inset Flex Code
3375 \begin_layout Plain Layout
3381 above) as the original.
3382 If you feel up to translating the documentation (an excellent way to proof-read
3383 the original documentation by the way!), there are a few things you should
3387 \begin_layout Itemize
3388 Check out the documentation translation web page at
3389 \begin_inset CommandInset href
3391 name "http://www.lyx.org/Translation"
3392 target "http://www.lyx.org/Translation"
3397 That way, you can find out which (if any) documents have already been translate
3398 d into your language.
3399 You can also find out who (if anyone) is organizing the effort to translate
3400 the documentation into your language.
3401 If no one is organizing the effort, please let us know that you're interested.
3404 \begin_layout Standard
3405 Once you get to actually translating, here's a few hints for you that may
3409 \begin_layout Itemize
3410 Join the documentation team! There is information on how to do that in
3411 \begin_inset Flex Code
3414 \begin_layout Plain Layout
3421 \begin_inset Flex Noun
3424 \begin_layout Plain Layout
3425 Help\SpecialChar menuseparator
3431 ), which by the way is the first document you should translate.
3434 \begin_layout Itemize
3435 Learn the typographic conventions for the language you are translating to.
3436 Typography is an ancient art and over the centuries, a great variety of
3437 conventions have developed throughout different parts of the world.
3438 Also study the professional terminology amongst typographers in your country.
3439 Inventing your own terminology will only confuse the users.
3442 (Warning! Typography is addictive!)
3445 \begin_layout Itemize
3446 Make a copy of the document.
3447 This will be your working copy.
3448 You can use this as your personal translated help-file by placing it in
3450 \begin_inset Flex Code
3453 \begin_layout Plain Layout
3460 \begin_inset Note Greyedout
3463 \begin_layout Plain Layout
3468 For a complex document with external material (images, etc.), if you make
3470 \begin_inset space \thinspace{}
3474 \begin_inset space \space{}
3477 in a temp dir, beware that the links to external material may be broken
3478 when the document is moved to a different place.
3479 The best way is to retrieve the \SpecialChar LyX
3481 \begin_inset Flex URL
3484 \begin_layout Plain Layout
3486 http://www.lyx.org/HowToUseGIT
3491 ) and to edit the doc file in place.
3499 \begin_layout Itemize
3500 Sometimes the original document (from the \SpecialChar LyX
3501 team) will be updated.
3502 Use the source viewer at
3503 \begin_inset CommandInset href
3505 name "http://www.lyx.org/trac/timeline"
3506 target "http://www.lyx.org/trac/timeline"
3510 to see what has been changed.
3511 That way you can easily see which parts of the translated document need
3515 \begin_layout Standard
3516 If you ever find an error in the original document, fix it and notify the
3517 rest of the documentation team of the changes! (You didn't forget to join
3518 the documentation team, did you?)
3521 \begin_layout Standard
3522 \begin_inset Branch OutDated
3525 \begin_layout Section
3526 International Keyboard Support
3529 \begin_layout Standard
3532 [Editor's Note: The following section is by
3540 It needs to be fixed to conform to the new Documentation Style sheet and
3541 to make use of the new v1.0 features.
3542 The whole thing also needs to be merged with the section following it.-jw
3543 It may also be badly out of date.-rh (2008)]
3546 \begin_layout Subsection
3547 Defining Own Keymaps: Keymap File Format
3550 \begin_layout Standard
3551 Let's look at a keyboard definition file a little closer.
3552 It is a plain text file defining
3555 \begin_layout Itemize
3556 key-to-key or key-to-string translations
3559 \begin_layout Itemize
3563 \begin_layout Itemize
3564 dead keys exceptions
3567 \begin_layout Standard
3568 To define key-to-key or key-to-string translation, use this command:
3571 \begin_layout Quotation
3572 \begin_inset Flex Code
3575 \begin_layout Plain Layout
3584 \begin_inset Flex Code
3587 \begin_layout Plain Layout
3596 \begin_layout Standard
3598 \begin_inset Flex Code
3601 \begin_layout Plain Layout
3607 is the key to be translated and
3608 \begin_inset Flex Code
3611 \begin_layout Plain Layout
3617 is the string to be inserted into the document.
3618 To define dead keys, use:
3621 \begin_layout Quotation
3622 \begin_inset Flex Code
3625 \begin_layout Plain Layout
3634 \begin_inset Flex Code
3637 \begin_layout Plain Layout
3646 \begin_layout Standard
3648 \begin_inset Flex Code
3651 \begin_layout Plain Layout
3657 is a keyboard key and
3658 \begin_inset Flex Code
3661 \begin_layout Plain Layout
3668 The following dead keys are supported (shortcut name is in parentheses):
3671 \begin_layout Quotation
3675 \begin_inset space \hfill{}
3681 \begin_layout Quotation
3683 \begin_inset space \hfill{}
3689 \begin_layout Quotation
3691 \begin_inset space \hfill{}
3697 \begin_layout Quotation
3699 \begin_inset space \hfill{}
3705 \begin_layout Quotation
3707 \begin_inset space \hfill{}
3713 \begin_layout Quotation
3715 \begin_inset space \hfill{}
3722 \begin_layout Plain Layout
3734 \begin_layout Quotation
3736 \begin_inset space \hfill{}
3742 \begin_layout Quotation
3744 \begin_inset space \hfill{}
3751 \begin_layout Plain Layout
3763 \begin_layout Quotation
3765 \begin_inset space \hfill{}
3771 \begin_layout Quotation
3773 \begin_inset space \hfill{}
3779 \begin_layout Quotation
3781 \begin_inset space \hfill{}
3788 \begin_layout Plain Layout
3800 \begin_layout Quotation
3802 \begin_inset space \hfill{}
3809 \begin_layout Plain Layout
3821 \begin_layout Quotation
3823 \begin_inset space \hfill{}
3829 \begin_layout Quotation
3830 hungarian umlaut (hug)
3831 \begin_inset space \hfill{}
3837 \begin_layout Quotation
3839 \begin_inset space \hfill{}
3845 \begin_layout Quotation
3847 \begin_inset space \hfill{}
3854 \begin_layout Plain Layout
3866 \begin_layout Standard
3867 Since in many international keyboards there are exceptions to what some
3868 dead keys should do, you can define them using
3871 \begin_layout Quotation
3872 \begin_inset Flex Code
3875 \begin_layout Plain Layout
3883 deadkey key outstring
3886 \begin_layout Standard
3887 For example, on Slovak keyboard, if you enter caron-o, it generates circumflex-o
3891 \begin_layout Quotation
3892 \begin_inset Flex Code
3895 \begin_layout Plain Layout
3908 \begin_layout Standard
3909 to make it work correctly.
3910 Also, you have to define as exceptions dead keys over i and j, to remove
3911 the dot from them before inserting an accent mark.
3912 I will change this when the time comes, but so far I haven't had time.
3915 \begin_layout Standard
3916 Oh, and about characters: backslash is escaped, so to enter it, you'll need
3919 \begin_inset Flex Code
3922 \begin_layout Plain Layout
3928 have different meaning.
3930 \begin_inset Flex Code
3933 \begin_layout Plain Layout
3939 marks comments, quotes start and end \SpecialChar LaTeX
3941 To enter quote, you'll need to use
3942 \begin_inset Flex Code
3945 \begin_layout Plain Layout
3954 \begin_inset Flex Code
3957 \begin_layout Plain Layout
3964 \begin_inset Flex Code
3967 \begin_layout Plain Layout
3978 \begin_layout Standard
3979 If you make a keyboard description file that works for your language, please
3980 mail it to me, so I can include it in the next keymap distribution.
3983 \begin_layout Standard
3984 More keywords will be supported in keymap configuration file in future,
3988 \begin_layout Itemize
3989 \begin_inset Flex Code
3992 \begin_layout Plain Layout
4003 \begin_inset space \hfill{}
4007 \begin_inset Flex Code
4010 \begin_layout Plain Layout
4019 \begin_layout Itemize
4020 \begin_inset Flex Code
4023 \begin_layout Plain Layout
4034 \begin_inset space \hfill{}
4038 \begin_inset Flex Code
4041 \begin_layout Plain Layout
4047 an external keymap translation program
4050 \begin_layout Standard
4051 Also, it should look into
4052 \begin_inset Flex Code
4055 \begin_layout Plain Layout
4061 file for defaults, too (for example, a
4062 \begin_inset Flex Code
4065 \begin_layout Plain Layout
4073 option to include default keyboard).
4081 \begin_layout Section
4082 International Keymap Stuff
4083 \begin_inset CommandInset label
4085 name "sec:International-Keymap-Stuff"
4092 \begin_layout Standard
4093 \begin_inset Note Note
4096 \begin_layout Plain Layout
4097 In doing the revisions on this document in March 2008, I did not look over
4098 this stuff, as I do not understand it.
4099 It would be good if someone else could do so.
4108 \begin_layout Standard
4109 The next two sections describe the
4110 \begin_inset Flex Code
4113 \begin_layout Plain Layout
4122 \begin_inset Flex Code
4125 \begin_layout Plain Layout
4133 file syntax in detail.
4134 These sections should help you design your own key map if the ones provided
4135 do not meet your needs.
4138 \begin_layout Subsection
4142 \begin_layout Standard
4146 \begin_inset Flex Code
4149 \begin_layout Plain Layout
4155 file maps keystrokes to characters or strings.
4156 As the name suggests, it sets a keyboard mapping.
4158 \begin_inset Flex Code
4161 \begin_layout Plain Layout
4172 \begin_inset Flex Code
4175 \begin_layout Plain Layout
4190 \begin_inset Flex Code
4193 \begin_layout Plain Layout
4206 \begin_inset Flex Code
4209 \begin_layout Plain Layout
4218 \begin_inset Flex Code
4221 \begin_layout Plain Layout
4229 are described in this section.
4232 \begin_layout Labeling
4233 \labelwidthstring 00.00.0000
4234 \begin_inset Flex Code
4237 \begin_layout Plain Layout
4245 Map a character to a string
4248 \begin_layout LyX-Code
4263 \begin_layout Standard
4296 the double-quote (")
4313 must be escaped with a preceding backslash (
4324 \begin_layout Standard
4326 \begin_inset Flex Noun
4329 \begin_layout Plain Layout
4337 statement to cause the symbol
4338 \begin_inset Flex Noun
4341 \begin_layout Plain Layout
4349 to be output for the keystroke
4350 \begin_inset Flex Noun
4353 \begin_layout Plain Layout
4364 \begin_layout LyX-Code
4370 \begin_layout Labeling
4371 \labelwidthstring 00.00.0000
4372 \begin_inset Flex Code
4375 \begin_layout Plain Layout
4383 Specify an accent character
4386 \begin_layout LyX-Code
4395 \begin_layout Standard
4396 This will make the cha
4434 This is the dead key
4438 \begin_layout Plain Layout
4445 refers to a key that does not produce a character by itself, but when followed
4446 with another key, produces the desired accent character.
4447 For example, a German characte
4449 r with an umlaut like
4459 can be produced in this manner.
4468 \begin_layout Standard
4481 and then another key not in
4498 followed by the other, not allowed key, as output.
4502 \begin_inset Flex Noun
4505 \begin_layout Plain Layout
4513 cancels a dead key, so if
4524 \begin_inset Flex Noun
4527 \begin_layout Plain Layout
4536 , the cursor will not go one position backwards but will instead cancel
4552 might have had on the next keystroke.
4556 \begin_layout Standard
4557 The following example specifies that the character ' is to be an acute accent,
4558 allowed on the characters a, e, i, o, u, A, E, I, O, and U:
4561 \begin_layout LyX-Code
4564 kmod ' acute aeiouAEIOU
4567 \begin_layout Labeling
4568 \labelwidthstring 00.00.0000
4569 \begin_inset Flex Code
4572 \begin_layout Plain Layout
4578 Specify an exception to the accent character
4581 \begin_layout LyX-Code
4590 \begin_layout Standard
4591 This defines an exce
4632 have been assigned a keystroke with a previous
4635 \begin_inset Flex Code
4638 \begin_layout Plain Layout
4662 must not belong in the
4709 If such a declaration does not exist in
4717 \begin_inset Flex Code
4720 \begin_layout Plain Layout
4754 \begin_inset Flex Code
4757 \begin_layout Plain Layout
4771 \begin_layout Standard
4772 The following command produces causes äi to be produced when you enter acute-i
4776 \begin_layout LyX-Code
4790 \begin_layout Labeling
4791 \labelwidthstring 00.00.0000
4792 \begin_inset Flex Code
4795 \begin_layout Plain Layout
4801 Combine two accent characters
4804 \begin_layout LyX-Code
4810 accent1 accent2 allowed
4813 \begin_layout Standard
4814 This one is getting pretty esoteric.
4815 It allows you to combine the effect
4871 \begin_inset Flex Code
4874 \begin_layout Plain Layout
4902 \begin_layout Standard
4903 Consider this example from the
4904 \begin_inset Flex Code
4907 \begin_layout Plain Layout
4918 \begin_layout LyX-Code
4921 kmod ; acute aeioyvhAEIOYVH
4925 kcomb acute umlaut iyIY
4928 \begin_layout Standard
4929 This allows you to press
4930 \begin_inset Flex Noun
4933 \begin_layout Plain Layout
4941 and get the effect of
4942 \begin_inset Flex Code
4945 \begin_layout Plain Layout
4964 in this case cancels the last dead key, so if you press
4965 \begin_inset Flex Noun
4968 \begin_layout Plain Layout
4977 \begin_inset Flex Code
4980 \begin_layout Plain Layout
4993 \begin_layout Subsection
4997 \begin_layout Standard
4999 \begin_inset Flex Code
5002 \begin_layout Plain Layout
5010 mapping is performed, a
5011 \begin_inset Flex Code
5014 \begin_layout Plain Layout
5024 file maps the strings that the symbols generate to characters in the current
5026 The \SpecialChar LyX
5027 distribution currently includes at least the
5028 \begin_inset Flex Code
5031 \begin_layout Plain Layout
5040 \begin_inset Flex Code
5043 \begin_layout Plain Layout
5054 \begin_layout Standard
5056 \begin_inset Flex Code
5059 \begin_layout Plain Layout
5067 file is a sequence of declarations of the form
5070 \begin_layout LyX-Code
5083 \begin_layout Standard
5084 For example, in order to map
5085 \begin_inset Flex Noun
5088 \begin_layout Plain Layout
5098 to the corresponding character in the iso-8859-1 set (233), the following
5102 \begin_layout LyX-Code
5110 \begin_layout Standard
5112 \begin_inset Flex Code
5115 \begin_layout Plain Layout
5124 \begin_inset Flex Code
5127 \begin_layout Plain Layout
5145 the same character can apply to more than one string.
5147 \begin_inset Flex Code
5150 \begin_layout Plain Layout
5161 \begin_layout LyX-Code
5173 \begin_inset Newline newline
5189 \begin_layout Standard
5191 cannot find a mapping for the string produced by the keystroke or a
5192 deadkey sequence, it will check if it looks like an accented char and try
5193 to draw an accent over the character on screen.
5196 \begin_layout Subsection
5200 \begin_layout Standard
5201 There is a second way to add support for international characters through
5202 so-called dead-keys.
5203 A dead-key works in combination with a letter to produce an accented character.
5204 Here, we'll explain how to create a really simple dead-key to illustrate
5208 \begin_layout Standard
5209 Suppose you happen to need the circumflex character,
5210 \begin_inset Quotes eld
5214 \begin_inset Quotes erd
5219 \begin_inset Flex Noun
5222 \begin_layout Plain Layout
5229 \begin_inset space ~
5233 \begin_inset Flex Noun
5236 \begin_layout Plain Layout
5242 ] to the \SpecialChar LyX
5244 \begin_inset Flex Code
5247 \begin_layout Plain Layout
5254 \begin_inset Flex Code
5257 \begin_layout Plain Layout
5264 Now, whenever you type the
5265 \begin_inset Flex Noun
5268 \begin_layout Plain Layout
5274 -key followed by a letter, that letter will have a circumflex accent on
5276 For example, the sequence
5277 \begin_inset Quotes eld
5281 \begin_inset Flex Noun
5284 \begin_layout Plain Layout
5291 \begin_inset Quotes erd
5294 produces the letter:
5295 \begin_inset Quotes eld
5299 \begin_inset Quotes erd
5303 If you tried to type
5304 \begin_inset Quotes eld
5308 \begin_inset Flex Noun
5311 \begin_layout Plain Layout
5318 \begin_inset Quotes erd
5321 , however, \SpecialChar LyX
5322 will complain with a beep, since a
5323 \begin_inset Quotes eld
5327 \begin_inset Flex Noun
5330 \begin_layout Plain Layout
5337 \begin_inset Quotes erd
5340 never takes a circumflex accent.
5342 \begin_inset Flex Noun
5345 \begin_layout Plain Layout
5351 after a dead-key produces the bare-accent.
5352 Please note this last point! If you bind a key to a dead-key, you'll need
5353 to rebind the character on that key to yet another key.
5355 \begin_inset Flex Noun
5358 \begin_layout Plain Layout
5364 to a cedilla is a bad idea, since you'll only get cedillas instead of commas.
5367 \begin_layout Standard
5368 One common way to bind dead-keys is to use
5369 \begin_inset Flex Noun
5372 \begin_layout Plain Layout
5379 \begin_inset Flex Noun
5382 \begin_layout Plain Layout
5389 \begin_inset Flex Noun
5392 \begin_layout Plain Layout
5398 in combination with an accent, like
5399 \begin_inset Quotes eld
5403 \begin_inset Flex Noun
5406 \begin_layout Plain Layout
5413 \begin_inset Quotes erd
5417 \begin_inset Quotes eld
5421 \begin_inset Flex Noun
5424 \begin_layout Plain Layout
5431 \begin_inset Quotes erd
5435 \begin_inset Quotes eld
5439 \begin_inset Flex Noun
5442 \begin_layout Plain Layout
5449 \begin_inset Quotes erd
5453 Another way involves using
5454 \begin_inset Flex Code
5457 \begin_layout Plain Layout
5464 \begin_inset Flex Code
5467 \begin_layout Plain Layout
5473 to set up the special
5474 \begin_inset Flex Code
5477 \begin_layout Plain Layout
5485 \begin_inset Flex Code
5488 \begin_layout Plain Layout
5494 acts in some ways just like
5495 \begin_inset Flex Noun
5498 \begin_layout Plain Layout
5504 and permits you to bind keys to accented characters.
5505 You can also turn keys into dead-keys by binding them to something like
5507 \begin_inset Flex Code
5510 \begin_layout Plain Layout
5516 and then binding this symbolic key to the corresponding \SpecialChar LyX
5521 \begin_layout Plain Layout
5526 : This is exactly what I do in my
5527 \begin_inset Flex Code
5530 \begin_layout Plain Layout
5537 \begin_inset Flex Code
5540 \begin_layout Plain Layout
5548 \begin_inset Flex Noun
5551 \begin_layout Plain Layout
5553 \begin_inset space ~
5562 \begin_inset Flex Code
5565 \begin_layout Plain Layout
5571 and a bunch of these
5572 \begin_inset Quotes eld
5576 \begin_inset Flex Code
5579 \begin_layout Plain Layout
5586 \begin_inset Quotes erd
5589 symbolic keys bound such things as
5590 \begin_inset Flex Noun
5593 \begin_layout Plain Layout
5595 \begin_inset space ~
5604 \begin_inset Flex Noun
5607 \begin_layout Plain Layout
5609 \begin_inset space ~
5618 This is how I produce my accented characters.
5623 You can make just about anything into the
5624 \begin_inset Flex Code
5627 \begin_layout Plain Layout
5634 \begin_inset Flex Noun
5637 \begin_layout Plain Layout
5643 keys, a spare function key, etc.
5644 As for the \SpecialChar LyX
5645 commands that produce accents, check the entry for
5646 \begin_inset Flex Code
5649 \begin_layout Plain Layout
5660 You'll find the complete list there.
5663 \begin_layout Subsection
5664 Saving your Language Configuration
5667 \begin_layout Standard
5668 You can edit your preferences so that your desired language environment
5669 is automatically configured when \SpecialChar LyX
5671 \begin_inset Flex Noun
5674 \begin_layout Plain Layout
5675 Edit\SpecialChar menuseparator
5684 \begin_layout Chapter
5685 Installing New Document Classes, Layouts, and Templates
5686 \begin_inset CommandInset label
5688 name "cha:Installing-New-Document"
5693 \begin_inset Argument 1
5696 \begin_layout Plain Layout
5697 Installing New Document Classes
5705 \begin_layout Standard
5706 In this chapter, we describe the procedures for creating and installing
5707 new \SpecialChar LyX
5708 layout and template files, as well as offer a refresher on correctly
5709 installing new \SpecialChar LaTeX
5714 \begin_layout Standard
5715 First, let us a say a few words about how one ought to think about the relation
5716 between \SpecialChar LyX
5717 and \SpecialChar LaTeX
5719 The thing to understand is that, in a certain sense, \SpecialChar LyX
5720 doesn't know anything
5721 about \SpecialChar LaTeX
5723 Indeed, from \SpecialChar LyX
5724 's point of view, \SpecialChar LaTeX
5725 is just one of several
5726 \begin_inset Quotes eld
5730 \begin_inset Quotes erd
5733 in which it is capable of producing output.
5734 Other such formats are DocBook, plaintext, and XHTML.
5736 is, of course, a particularly important format, but very little of the
5737 information \SpecialChar LyX
5738 has about \SpecialChar LaTeX
5739 is actually contained in the program itself.
5743 \begin_layout Plain Layout
5744 Some commands are sufficiently complex that they are
5745 \begin_inset Quotes eld
5749 \begin_inset Quotes erd
5752 into \SpecialChar LyX
5754 But the developers generally regard this as a Bad Thing.
5759 Rather, that information, even for the standard classes like
5760 \begin_inset Flex Code
5763 \begin_layout Plain Layout
5769 , is contained in `layout files'.
5770 Similarly, \SpecialChar LyX
5771 itself does not know much about DocBook or XHTML.
5772 What it knows is contained in layout files.
5775 \begin_layout Standard
5776 You can think of the layout file for a given document class as a translation
5777 manual between \SpecialChar LyX
5778 constructs—paragraphs with their corresponding styles,
5779 certain sorts of insets, etc—and the corresponding \SpecialChar LaTeX
5782 Almost everything \SpecialChar LyX
5784 \begin_inset Flex Code
5787 \begin_layout Plain Layout
5793 , for example, is contained in the file
5794 \begin_inset Flex Code
5797 \begin_layout Plain Layout
5803 and in various other files it includes.
5804 For this reason, anyone intending to write layout files should plan to
5805 study the existing files.
5806 A good place to start is with
5807 \begin_inset Flex Code
5810 \begin_layout Plain Layout
5816 , which is included in
5817 \begin_inset Flex Code
5820 \begin_layout Plain Layout
5827 \begin_inset Flex Code
5830 \begin_layout Plain Layout
5836 , and many of the other layout files for document classes.
5837 This file is where sections and the like are defined:
5838 \begin_inset Flex Code
5841 \begin_layout Plain Layout
5847 tells \SpecialChar LyX
5848 how paragraphs that are marked with the Section, Subsection, etc,
5849 styles can be translated into corresponding \SpecialChar LaTeX
5850 , DocBook, and XHTML commands
5853 \begin_inset Flex Code
5856 \begin_layout Plain Layout
5862 file basically just includes several of these
5863 \begin_inset Flex Code
5866 \begin_layout Plain Layout
5875 \begin_layout Standard
5876 Defining the \SpecialChar LyX
5878 correspondence is not the only thing layout files do, though.
5879 Their other job is to define how the \SpecialChar LyX
5880 constructs themselves will appear
5882 The fact that layout files have these two jobs is often a source of confusion,
5883 because they are completely separate.
5884 Telling \SpecialChar LyX
5885 how to translate a certain paragraph style into \SpecialChar LaTeX
5888 how to display it; conversely, telling \SpecialChar LyX
5889 how to display a certain paragraph
5890 style does not tell \SpecialChar LyX
5891 how to translate it into \SpecialChar LaTeX
5892 (let alone tell \SpecialChar LaTeX
5895 So, in general, when you define a new \SpecialChar LyX
5896 construct, you must always do two
5897 quite separate things: (i)
5898 \begin_inset space ~
5901 tell \SpecialChar LyX
5902 how to translate it into \SpecialChar LaTeX
5904 \begin_inset space ~
5907 tell \SpecialChar LyX
5911 \begin_layout Standard
5912 Much the same is true, of course, as regards \SpecialChar LyX
5913 's other backend formats, though
5914 XHTML is in some ways different, because in that case \SpecialChar LyX
5919 able, to some extent, to use information about how it should display a
5920 paragraph on the screen to output information (in the form of CSS) about
5921 how the paragraph should be displayed in a browser.
5922 Even in this case, however, the distinction between what \SpecialChar LyX
5924 and how things are rendered externally remains in force, and the two can
5925 be controlled separately.
5927 \begin_inset CommandInset ref
5929 reference "sec:Tags-for-XHTML"
5936 \begin_layout Section
5937 Installing new \SpecialChar LaTeX
5941 \begin_layout Standard
5942 Some installations may not include a \SpecialChar LaTeX
5943 package or class file that you would
5944 like to use within \SpecialChar LyX
5946 For example, you might need Foil\SpecialChar TeX
5947 , a package for preparing slides for overhead
5949 Modern \SpecialChar LaTeX
5950 distributions like \SpecialChar TeX
5951 Live (2008 or newer) or MiK\SpecialChar TeX
5952 provide a user interface
5953 for installing such packages.
5954 For example, with MiK\SpecialChar TeX
5955 , you start the program
5956 \begin_inset Quotes eld
5960 \begin_inset space ~
5964 \begin_inset Quotes erd
5967 to get a list of available packages.
5968 To install one of them, right click on it or use the corresponding toolbar
5972 \begin_layout Standard
5973 If your \SpecialChar LaTeX
5974 distribution does not provide such a `package manager', or if the
5975 package is not available from your distribution, then follow these steps
5976 to install it manually:
5979 \begin_layout Enumerate
5980 Get the package from
5981 \begin_inset CommandInset href
5984 target "http://www.ctan.org/"
5991 \begin_layout Enumerate
5992 If the package contains a file with the ending
5993 \begin_inset Quotes eld
5997 \begin_inset Flex Code
6000 \begin_layout Plain Layout
6007 \begin_inset Quotes erd
6010 (is the case for Foil\SpecialChar TeX
6011 ) then open a console, change to the folder of this
6012 file and execute the command
6013 \begin_inset Flex Code
6016 \begin_layout Plain Layout
6023 You have now unpacked the package and have all files to install it.
6024 Most \SpecialChar LaTeX
6025 -packages are not packed and you can skip this step.
6028 \begin_layout Enumerate
6029 Now you need to decide if the package should be available for all users
6034 \begin_layout Enumerate
6035 On *nix systems (Linux, OSX, etc.), if you want the new package to be available
6036 for all users on your system, then install it in your `local' \SpecialChar TeX
6038 install it in your own `user' \SpecialChar TeX
6040 Where these trees should be created, if they do not already exist, depends
6042 To find this out, look in the file
6043 \begin_inset Flex Code
6046 \begin_layout Plain Layout
6056 \begin_layout Plain Layout
6057 This is usually in the directory
6058 \begin_inset Flex Code
6061 \begin_layout Plain Layout
6067 , though you can execute the command
6068 \begin_inset Flex Code
6071 \begin_layout Plain Layout
6082 The location of the `local' \SpecialChar TeX
6083 tree is defined by the
6084 \begin_inset Flex Code
6087 \begin_layout Plain Layout
6093 variable; this is usually somewhere like
6094 \begin_inset Flex Code
6097 \begin_layout Plain Layout
6098 /usr/local/share/texmf
6103 or /usr/local/texlive/XXXX where XXXX is the year of the installed \SpecialChar TeX
6106 The location of the `user' \SpecialChar TeX
6108 \begin_inset Flex Code
6111 \begin_layout Plain Layout
6118 \begin_inset Flex Code
6121 \begin_layout Plain Layout
6128 \begin_inset Flex Code
6131 \begin_layout Plain Layout
6141 (If these variables are not predefined, you have to define them.) You'll
6142 probably need root permissions to create or modify the `local' tree, but
6143 not for your `user' tree.
6144 \begin_inset Newline newline
6147 In general, it is recommended to install in the user tree because your user
6148 will not be modified or even overwritten when you upgrade your system.
6149 It will typically also be backed up together with everything else when
6150 you backup your home directory (which, of course, you do on a regular basis).
6153 \begin_layout Enumerate
6154 On Windows, if you want the new package to be available for all users on
6155 your system, change to the folder where \SpecialChar LaTeX
6156 is installed and then change to
6158 \begin_inset Flex Code
6161 \begin_layout Plain Layout
6172 (For MiK\SpecialChar TeX
6173 , this would be by default the folder
6174 \begin_inset Flex Code
6177 \begin_layout Plain Layout
6195 \begin_layout Plain Layout
6196 Note that this will be the correct path only on English installations.
6197 On a German one, it would be
6198 \begin_inset Flex Code
6201 \begin_layout Plain Layout
6215 , and similarly for other languages.
6220 Create there a new folder
6221 \begin_inset Flex Code
6224 \begin_layout Plain Layout
6230 and copy all files of the package into it.
6232 \begin_inset Newline newline
6235 If the package should only available for you or you don't have admin permissions
6236 , do the same, but in the local \SpecialChar LaTeX
6239 \begin_inset space \thinspace{}
6242 g., for MiK\SpecialChar TeX
6244 \begin_inset space ~
6247 2.8 under Windows XP, this would be the folder:
6248 \begin_inset Newline newline
6254 \begin_inset Flex Code
6257 \begin_layout Plain Layout
6260 Documents and Settings
6272 \begin_inset Newline newline
6278 \begin_inset Phantom HPhantom
6281 \begin_layout Plain Layout
6292 \begin_inset Flex Code
6295 \begin_layout Plain Layout
6308 \begin_inset Newline newline
6311 On Vista, it would be:
6312 \begin_inset Newline newline
6316 \begin_inset Flex Code
6319 \begin_layout Plain Layout
6345 \begin_layout Enumerate
6346 Now one only need to tell \SpecialChar LaTeX
6347 that there are new files.
6348 This depends on the used \SpecialChar LaTeX
6353 \begin_layout Enumerate
6354 For \SpecialChar TeX
6355 Live execute the command
6356 \begin_inset Flex Code
6359 \begin_layout Plain Layout
6366 If you installed the package for all users, then you will probably need
6367 to have root permissions for that.
6370 \begin_layout Enumerate
6371 For MiK\SpecialChar TeX
6372 , if you have installed the package for all users, start the program
6374 \begin_inset Quotes eld
6378 \begin_inset space ~
6382 \begin_inset Quotes erd
6385 and press the button marked
6386 \begin_inset Quotes eld
6390 \begin_inset Quotes erd
6394 Otherwise start the program
6395 \begin_inset Quotes eld
6399 \begin_inset Quotes erd
6406 \begin_layout Enumerate
6407 Finally, you need to tell \SpecialChar LyX
6408 that there are new packages available.
6409 So, in \SpecialChar LyX
6411 \begin_inset Flex Noun
6414 \begin_layout Plain Layout
6417 \SpecialChar menuseparator
6423 and then restart \SpecialChar LyX
6427 \begin_layout Standard
6428 Now the package is installed.
6429 In our example, the document class
6430 \begin_inset Flex Code
6433 \begin_layout Plain Layout
6435 \begin_inset space ~
6443 will now be available under
6444 \begin_inset Flex Noun
6447 \begin_layout Plain Layout
6448 Document\SpecialChar menuseparator
6449 Settings\SpecialChar menuseparator
6459 \begin_layout Standard
6460 If you would like to use a \SpecialChar LaTeX
6461 document class that is not even listed in the
6463 \begin_inset Flex Noun
6466 \begin_layout Plain Layout
6467 Document\SpecialChar menuseparator
6468 Settings\SpecialChar menuseparator
6474 , then you need to create a `layout' file for it.
6475 That is the topic of the next section.
6478 \begin_layout Section
6479 Types of layout files
6482 \begin_layout Standard
6483 This section describes the various sorts of \SpecialChar LyX
6484 files that contain layout informati
6486 These files describe various paragraph and character styles, determining
6487 how \SpecialChar LyX
6488 should display them and how they should be translated into \SpecialChar LaTeX
6490 XHTML, or whatever output format is being used.
6494 \begin_layout Standard
6495 We shall try to provide a thorough description of the process of writing
6497 However, there are so many different types of documents supported even
6498 by just \SpecialChar LaTeX
6499 that we can't hope to cover every different possibility or problem
6500 you might encounter.
6501 The \SpecialChar LyX
6502 users' list is frequented by people with lots of experience with layout
6503 design who are willing to share what they've learned, so please feel free
6504 to ask questions there.
6507 \begin_layout Standard
6508 As you prepare to write a new layout, it is extremely helpful to look at
6509 the layouts distributed with \SpecialChar LyX
6511 If you write a \SpecialChar LyX
6512 layout for a \SpecialChar LaTeX
6513 document class that might also be used by
6514 others, or write a module that might be useful to others, then you should
6515 consider posting your layout to the
6516 \begin_inset CommandInset href
6518 name "layout section on the LyX wiki"
6519 target "http://wiki.lyx.org/Layouts/Layouts"
6523 or even to the \SpecialChar LyX
6524 developers' list, so that it might be included in \SpecialChar LyX
6529 \begin_layout Plain Layout
6530 Note that \SpecialChar LyX
6531 is licensed under the General Public License, so any material
6532 that is contributed to \SpecialChar LyX
6533 must be similarly licensed.
6541 \begin_layout Subsection
6543 \begin_inset CommandInset label
6545 name "subsec:Layout-modules"
6552 \begin_layout Standard
6553 We have spoken to this point about `layout files'.
6554 But there are different sorts of files that contain layout information.
6555 Layout files, strictly so called, have the
6556 \begin_inset Flex Code
6559 \begin_layout Plain Layout
6565 extension and provide \SpecialChar LyX
6566 with information about document classes.
6567 Since \SpecialChar LyX
6568 1.6 layout information can also be contained in layout
6573 \begin_inset Flex Code
6576 \begin_layout Plain Layout
6583 Modules are to \SpecialChar LaTeX
6584 packages much as layouts are to \SpecialChar LaTeX
6585 classes, and some modules—such
6587 \begin_inset Flex Code
6590 \begin_layout Plain Layout
6596 module—specifically provide support for one package.
6597 In a sense, layout modules are similar to included
6601 \begin_layout Plain Layout
6602 These can have any extension, but by convention have the
6603 \begin_inset Flex Code
6606 \begin_layout Plain Layout
6618 \begin_inset Flex Code
6621 \begin_layout Plain Layout
6627 —in that modules are not specific to a given document class but may be used
6628 with many different classes.
6629 The difference is that using an included file with
6630 \begin_inset Flex Code
6633 \begin_layout Plain Layout
6639 requires editing that file.
6640 Modules, by contrast, are selected in the
6641 \begin_inset Flex Noun
6644 \begin_layout Plain Layout
6645 Document\SpecialChar menuseparator
6654 \begin_layout Standard
6655 Building modules is the easiest way to get started with layout editing,
6656 since it can be as simple as adding a single new paragraph style or flex
6658 But modules may, in principle, contain anything a layout file can contain.
6661 \begin_layout Standard
6662 After creating a new module and copying it to the
6663 \begin_inset Flex Code
6666 \begin_layout Plain Layout
6672 folder, you will need to reconfigure and then restart \SpecialChar LyX
6675 However, changes you make to the module will be seen immediately, if you
6677 \begin_inset Flex Noun
6680 \begin_layout Plain Layout
6681 Document\SpecialChar menuseparator
6687 , highlight something, and then hit
6688 \begin_inset Quotes eld
6692 \begin_inset Quotes erd
6698 It is strongly recommended that you save your work before doing this
6703 it is strongly recommended that you not attempt to edit modules while simultaneo
6704 usly working on actual documents
6707 Though of course the developers strive to keep \SpecialChar LyX
6708 stable in such situations,
6709 syntax errors and the like in your module file could cause strange behavior.
6712 \begin_layout Subsubsection
6716 \begin_layout Standard
6717 Modules are to \SpecialChar LyX
6718 as packages are to \SpecialChar LaTeX
6720 Sometimes, however, you find yourself wanting a specific inset or character
6721 style just for one document and writing a module that will also be available
6722 to other documents makes little sense.
6723 What you need is \SpecialChar LyX
6725 \begin_inset Quotes eld
6729 \begin_inset Quotes erd
6735 \begin_layout Standard
6736 You will find it under
6738 Document\SpecialChar menuseparator
6739 Settings\SpecialChar menuseparator
6743 The large text box allows you to enter anything that you might enter in
6744 a layout file or module.
6745 You can think of a document's local layout, in fact, as a module that belongs
6747 So, in particular, you must enter a
6748 \begin_inset Flex Code
6751 \begin_layout Plain Layout
6758 Any format is acceptable, but one would normally use the format current
6760 (In \SpecialChar LyX
6761 2.2, the current layout format is 60.)
6764 \begin_layout Standard
6765 When you have entered something in the
6766 \begin_inset Flex Code
6769 \begin_layout Plain Layout
6775 pane, \SpecialChar LyX
6777 \begin_inset Quotes eld
6781 \begin_inset Quotes erd
6784 button at the bottom.
6785 Clicking this button will cause \SpecialChar LyX
6786 to determine whether what you have entered
6787 is valid layout information for the chosen format.
6789 will report the result but, unfortunately, will not tell you what errors
6790 there might have been.
6791 These will be written to the terminal, however, if \SpecialChar LyX
6792 is started from a terminal.
6793 You will not be permitted to save your local layout until you have entered
6797 \begin_layout Standard
6798 The warnings at the end of the previous section apply here, too.
6799 Do not play with local layout while you are actually working, especially
6800 if you have not saved your document.
6801 That said, using local layout with a test document can be a very convenient
6802 way to try out layout ideas, or even to start developing a module.
6805 \begin_layout Subsection
6807 \begin_inset Flex Noun
6810 \begin_layout Plain Layout
6819 \begin_layout Standard
6820 There are two situations you are likely to encounter when wanting to support
6821 a new \SpecialChar LaTeX
6822 document class, involving style (
6823 \begin_inset Flex Code
6826 \begin_layout Plain Layout
6832 ) files and \SpecialChar LaTeX2e
6834 \begin_inset Flex Code
6837 \begin_layout Plain Layout
6844 Supporting a style file is usually fairly easy.
6845 Supporting a new class file is a bit harder.
6846 We'll discuss the former in this section and the latter in the next.
6847 Similar remarks apply, of course, if you want to support a new DocBook
6851 \begin_layout Standard
6852 The easier case is the one in which your new document class is provided
6853 as a style file that is to be used in conjunction with an already supported
6855 For the sake of the example, we'll assume that the style file is called
6857 \begin_inset Flex Noun
6860 \begin_layout Plain Layout
6866 and that it is meant to be used with
6867 \begin_inset Flex Noun
6870 \begin_layout Plain Layout
6876 , which is a standard class.
6880 \begin_layout Standard
6881 Start by copying the existing class's layout file into your local directory:
6885 \begin_layout Plain Layout
6886 Of course, which directory is your local directory will vary by platform,
6887 and \SpecialChar LyX
6888 allows you to specify your local directory on startup, too, using
6890 \begin_inset Flex Code
6893 \begin_layout Plain Layout
6907 \begin_layout LyX-Code
6908 cp report.layout ~/.lyx/layouts/myclass.layout
6911 \begin_layout Standard
6913 \begin_inset Flex Code
6916 \begin_layout Plain Layout
6922 and change the line:
6925 \begin_layout LyX-Code
6928 DeclareLaTeXClass{report}
6931 \begin_layout Standard
6935 \begin_layout LyX-Code
6938 DeclareLaTeXClass[report, myclass.sty]{report (myclass)}
6941 \begin_layout Standard
6945 \begin_layout LyX-Code
6947 \begin_inset Newline newline
6953 \begin_inset Newline newline
6959 \begin_layout Standard
6960 near the top of the file.
6963 \begin_layout Standard
6964 Start \SpecialChar LyX
6966 \begin_inset Flex Noun
6969 \begin_layout Plain Layout
6970 Tools\SpecialChar menuseparator
6977 Then restart \SpecialChar LyX
6978 and try creating a new document.
6980 \begin_inset Flex Noun
6983 \begin_layout Plain Layout
6989 " as a document class option in the
6990 \begin_inset Flex Noun
6993 \begin_layout Plain Layout
6994 Document\SpecialChar menuseparator
7001 It is likely that some of the sectioning commands and such in your new
7002 class will work differently from how they worked in the base class—
7003 \begin_inset Flex Code
7006 \begin_layout Plain Layout
7012 in this example—so you can fiddle around with the settings for the different
7013 sections if you wish.
7014 The layout information for sections is contained in
7015 \begin_inset Flex Code
7018 \begin_layout Plain Layout
7024 , but you do not need to copy and change this file.
7025 Instead, you can simply add your changes to your layout file, after the
7027 \begin_inset Flex Code
7030 \begin_layout Plain Layout
7036 , which itself includes
7037 \begin_inset Flex Code
7040 \begin_layout Plain Layout
7047 For example, you might add these lines:
7050 \begin_layout LyX-Code
7054 \begin_layout LyX-Code
7058 \begin_layout LyX-Code
7062 \begin_layout LyX-Code
7066 \begin_layout LyX-Code
7070 \begin_layout Standard
7071 to change the font for chapter headings to sans-serif.
7072 This will override (or, in this case, add to) the existing declaration
7073 for the Chapter style.
7077 \begin_layout Standard
7078 Your new package may also provide commands or environments not present in
7080 In this case, you will want to add these to the layout file.
7082 \begin_inset CommandInset ref
7084 reference "sec:TextClass"
7088 for information on how to do so.
7091 \begin_layout Standard
7093 \begin_inset Flex Noun
7096 \begin_layout Plain Layout
7102 can be used with several different document classes, and even if it cannot,
7103 you might find it easiest just to write a module that you can load with
7105 The simplest possible such module would be:
7108 \begin_layout LyX-Code
7111 DeclareLyXModule{My Package}
7114 \begin_layout LyX-Code
7118 \begin_layout LyX-Code
7119 #Support for mypkg.sty.
7122 \begin_layout LyX-Code
7124 \begin_inset Newline newline
7130 \begin_layout LyX-Code
7132 \begin_inset Newline newline
7138 \begin_layout LyX-Code
7140 \begin_inset Newline newline
7146 \begin_inset Newline newline
7152 \begin_layout Standard
7153 A more complex module might modify the behavior of some existing constructs
7154 or define some new ones.
7156 \begin_inset CommandInset ref
7158 reference "sec:TextClass"
7165 \begin_layout Subsection
7167 \begin_inset Flex Noun
7170 \begin_layout Plain Layout
7179 \begin_layout Standard
7180 There are two possibilities here.
7181 One is that the class file is itself based upon an existing document class.
7182 For example, many thesis classes are based upon
7183 \begin_inset Flex Noun
7186 \begin_layout Plain Layout
7193 To see whether yours is, look for a line like
7196 \begin_layout LyX-Code
7202 \begin_layout Standard
7204 If so, then you may proceed largely as in the previous section, though
7206 \begin_inset Flex Code
7209 \begin_layout Plain Layout
7210 Declare\SpecialChar LaTeX
7216 line will be different.
7217 If your new class is
7218 \begin_inset Flex Code
7221 \begin_layout Plain Layout
7227 and it is based upon
7228 \begin_inset Flex Code
7231 \begin_layout Plain Layout
7237 , then the line should read:
7241 \begin_layout Plain Layout
7242 And it will be easiest if you save the file to
7243 \begin_inset Flex Code
7246 \begin_layout Plain Layout
7253 assumes that the document class has the same name as the layout file.
7262 \begin_layout LyX-Code
7265 DeclareLaTeXClass[thesis,book]{thesis}
7268 \begin_layout Standard
7269 If, on the other hand, the new class is not based upon an existing class,
7270 you will probably have to
7271 \begin_inset Quotes eld
7275 \begin_inset Quotes erd
7279 We strongly suggest copying an existing layout file which uses a similar
7281 class and then modifying it, if you can do so.
7282 At least use an existing file as a starting point so you can find out what
7283 items you need to worry about.
7284 Again, the specifics are covered below.
7287 \begin_layout Subsection
7289 \begin_inset CommandInset label
7291 name "subsec:Creating-Templates"
7298 \begin_layout Standard
7299 Once you have written a layout file for a new document class, you might
7300 want to consider writing a
7305 A template acts as a kind of tutorial for your layout, showing how it might
7306 be used, though containing dummy content.
7307 You can of course look at the various templates included with \SpecialChar LyX
7311 \begin_layout Standard
7312 Templates are created just like usual documents: using \SpecialChar LyX
7314 The only difference is that usual documents contain all possible settings,
7315 including the font scheme and the paper size.
7316 Usually a user doesn't want a template to overwrite his preferred settings
7317 for such parameters.
7318 For that reason, the designer of a template should remove the corresponding
7320 \begin_inset Flex Code
7323 \begin_layout Plain Layout
7332 \begin_inset Flex Code
7335 \begin_layout Plain Layout
7343 from the template \SpecialChar LyX
7345 This can be done with any simple text-editor, for example
7346 \begin_inset Flex Code
7349 \begin_layout Plain Layout
7356 \begin_inset Flex Code
7359 \begin_layout Plain Layout
7368 \begin_layout Standard
7369 Put the edited template files you create in
7370 \begin_inset Flex Code
7373 \begin_layout Plain Layout
7379 , copy the ones you use from the global template directory in
7380 \begin_inset Flex Code
7383 \begin_layout Plain Layout
7389 to the same place, and redefine the template path in the
7390 \begin_inset Flex Noun
7393 \begin_layout Plain Layout
7394 Tools\SpecialChar menuseparator
7395 Preferences\SpecialChar menuseparator
7404 \begin_layout Standard
7405 Note, by the way, that there is a template which has a particular meaning:
7407 \begin_inset Flex Code
7410 \begin_layout Plain Layout
7417 This template is loaded every time you create a new document with
7418 \begin_inset Flex Noun
7421 \begin_layout Plain Layout
7422 File\SpecialChar menuseparator
7428 in order to provide useful defaults.
7429 To create this template from inside \SpecialChar LyX
7430 , all you have to do is to open a document
7431 with the correct settings, and use the
7432 \begin_inset Flex Noun
7435 \begin_layout Plain Layout
7436 Save as Document Defaults
7444 \begin_layout Subsection
7445 Upgrading old layout files
7448 \begin_layout Standard
7449 The format of layout files changes with each \SpecialChar LyX
7450 release, so old layout files
7451 need to be converted to the new format.
7453 reads a layout file in an older format, it automatically calls the
7455 \begin_inset Flex Code
7458 \begin_layout Plain Layout
7464 to convert it to a temporary file in current format.
7465 The original file is left untouched.
7466 If you use the layout file often, then, you may want to convert it permanently,
7467 so that \SpecialChar LyX
7468 does not have to do so itself every time.
7469 To do this, you can call the converter manually:
7472 \begin_layout Enumerate
7474 \begin_inset Flex Code
7477 \begin_layout Plain Layout
7484 \begin_inset Flex Code
7487 \begin_layout Plain Layout
7496 \begin_layout Enumerate
7498 \begin_inset Newline newline
7502 \begin_inset Flex Code
7505 \begin_layout Plain Layout
7506 python LyXDir/scripts/layout2layout.py myclass.old myclass.layout
7512 \begin_inset Newline newline
7516 \begin_inset Flex Code
7519 \begin_layout Plain Layout
7525 is the name of your \SpecialChar LyX
7529 \begin_layout Standard
7530 Note that manual conversion does not affect included files, so these will
7531 have to be converted separately.
7534 \begin_layout Section
7535 \begin_inset CommandInset label
7537 name "sec:TextClass"
7541 The layout file format
7544 \begin_layout Standard
7545 The following sections describe how layout files are structured and written.
7546 Our advice is to go slowly, save and test often.
7547 It is really not that hard, except that the multitude of options can become
7548 overwhelming, especially if you try to check out too many at once.
7549 It becomes easier if you use existing layouts of \SpecialChar LyX
7550 as examples/reference
7551 or if you modify an existing layout to your needs.
7554 \begin_layout Standard
7555 Note that all the tags used in layout files are case-insensitive.
7557 \begin_inset Flex Code
7560 \begin_layout Plain Layout
7567 \begin_inset Flex Code
7570 \begin_layout Plain Layout
7577 \begin_inset Flex Code
7580 \begin_layout Plain Layout
7586 are really the same tag.
7587 The possible arguments are printed in brackets after the tag's name.
7588 The default argument is typeset
7589 \begin_inset Flex Code
7592 \begin_layout Plain Layout
7601 If the argument has a data type like
7602 \begin_inset Quotes eld
7606 \begin_inset Quotes erd
7610 \begin_inset Quotes eld
7614 \begin_inset Quotes erd
7617 , the default is shown like this:
7618 \begin_inset Flex Code
7621 \begin_layout Plain Layout
7632 \begin_layout Subsection
7633 The document class declaration and classification
7636 \begin_layout Standard
7637 Lines in a layout file which begin with
7638 \begin_inset Flex Code
7641 \begin_layout Plain Layout
7648 There is one exception to this rule.
7650 \begin_inset Flex Code
7653 \begin_layout Plain Layout
7659 files should begin with lines like:
7662 \begin_layout LyX-Code
7665 #% Do not delete the line below; configure depends on this
7668 \begin_layout LyX-Code
7673 DeclareLaTeXClass{Article (Standard Class)}
7676 \begin_layout LyX-Code
7681 DeclareCategory{Articles}
7684 \begin_layout Standard
7685 The second and third lines are used when you (re)configure \SpecialChar LyX
7687 The layout file is read by the \SpecialChar LaTeX
7689 \begin_inset Flex Code
7692 \begin_layout Plain Layout
7698 , in a special mode where
7699 \begin_inset Flex Code
7702 \begin_layout Plain Layout
7709 The first line is just a \SpecialChar LaTeX
7710 comment, the second one contains the mandatory
7711 declaration of the text class and the third line contains the optional
7712 classification of the class.
7713 If these lines appear in a file named
7714 \begin_inset Flex Code
7717 \begin_layout Plain Layout
7723 , then they define a text class of name
7724 \begin_inset Flex Code
7727 \begin_layout Plain Layout
7733 (the name of the layout file) which uses the \SpecialChar LaTeX
7735 \begin_inset Flex Code
7738 \begin_layout Plain Layout
7744 (the default is to use the same name as the layout).
7746 \begin_inset Quotes eld
7749 Article (Standard Class)
7750 \begin_inset Quotes erd
7753 that appears above is used as a description of the text class in the
7754 \begin_inset Flex Noun
7757 \begin_layout Plain Layout
7758 Document\SpecialChar menuseparator
7766 \begin_inset Quotes eld
7770 \begin_inset Quotes erd
7773 in the example) is also used in the
7774 \begin_inset Flex Noun
7777 \begin_layout Plain Layout
7778 Document\SpecialChar menuseparator
7784 dialog: the text classes are grouped by these categories (which are usually
7785 genres, so typical categories are
7786 \begin_inset Quotes eld
7790 \begin_inset Quotes erd
7794 \begin_inset Quotes eld
7798 \begin_inset Quotes erd
7802 \begin_inset Quotes eld
7806 \begin_inset Quotes erd
7810 \begin_inset Quotes eld
7814 \begin_inset Quotes erd
7818 \begin_inset Quotes eld
7822 \begin_inset Quotes erd
7826 \begin_inset Quotes eld
7830 \begin_inset Quotes erd
7834 If no category has been declared, the class will be put in the
7835 \begin_inset Quotes eld
7839 \begin_inset Quotes erd
7845 \begin_layout Standard
7846 Let's assume that you wrote your own text class that uses the
7847 \begin_inset Flex Code
7850 \begin_layout Plain Layout
7856 document class, but where you changed the appearance of the section headings.
7857 If you put it in a file
7858 \begin_inset Flex Code
7861 \begin_layout Plain Layout
7867 , the header of this file should be:
7870 \begin_layout LyX-Code
7873 #% Do not delete the line below; configure depends on this
7876 \begin_layout LyX-Code
7881 DeclareLaTeXClass[article]{Article (with My Own Headings)}
7884 \begin_layout LyX-Code
7889 DeclareCategory{Articles}
7892 \begin_layout Standard
7893 This declares a text class
7894 \begin_inset Flex Code
7897 \begin_layout Plain Layout
7903 , associated with the \SpecialChar LaTeX
7905 \begin_inset Flex Code
7908 \begin_layout Plain Layout
7915 \begin_inset Quotes eld
7918 Article (with My Own Headings)
7919 \begin_inset Quotes erd
7923 If your text class depends on several packages, you can declare it as:
7926 \begin_layout LyX-Code
7929 #% Do not delete the line below; configure depends on this
7932 \begin_layout LyX-Code
7937 DeclareLaTeXClass[article,foo.sty]{Article (with My Own Headings)}
7940 \begin_layout LyX-Code
7945 DeclareCategory{Articles}
7948 \begin_layout Standard
7949 This indicates that your text class uses the
7950 \begin_inset Flex Code
7953 \begin_layout Plain Layout
7960 Finally, it is also possible to declare classes for DocBook code.
7961 Typical declarations will look like:
7964 \begin_layout LyX-Code
7967 #% Do not delete the line below; configure depends on this
7970 \begin_layout LyX-Code
7975 DeclareDocBookClass[article]{SGML (DocBook Article)}
7978 \begin_layout LyX-Code
7983 DeclareCategory{Articles (DocBook)}
7986 \begin_layout Standard
7987 Note that these declarations can also be given an optional parameter declaring
7988 the name of the document class (but not a list).
7991 \begin_layout Standard
7992 So, to be as explicit as possible, the form of the layout declaration is:
7995 \begin_layout LyX-Code
8000 DeclareLaTeXClass[class,package.sty]{layout description}
8003 \begin_layout LyX-Code
8008 DeclareCategory{category}
8011 \begin_layout Standard
8012 The class need only be specified if the name of the \SpecialChar LaTeX
8014 name of the layout file are different or if there are packages to load.
8015 If the name of the class file is not specified, then \SpecialChar LyX
8017 that it is the same as the name of the layout file.
8020 \begin_layout Standard
8021 When the text class has been modified to your taste, all you have to do
8022 is to copy it either to
8023 \begin_inset Flex Code
8026 \begin_layout Plain Layout
8033 \begin_inset Flex Code
8036 \begin_layout Plain Layout
8043 \begin_inset Flex Noun
8046 \begin_layout Plain Layout
8047 Tools\SpecialChar menuseparator
8053 , exit \SpecialChar LyX
8055 Then your new text class should be available along with the others.
8058 \begin_layout Standard
8059 Once the layout file is installed, you can edit it and see your changes
8060 without having to reconfigure or to restart \SpecialChar LyX
8066 \begin_layout Plain Layout
8067 In versions of \SpecialChar LyX
8068 prior to 1.6, this was not true.
8069 As a result, editing layout files was very time consuming, since you had
8070 constantly to restart \SpecialChar LyX
8076 You can force a reload of the current layout by using the \SpecialChar LyX
8078 \begin_inset Flex Noun
8081 \begin_layout Plain Layout
8088 There is no default binding for this function—though, of course, you can
8089 bind it to a key yourself.
8090 But you will normally use this function simply by entering it in the mini-buffe
8095 \begin_layout Standard
8101 \begin_inset Flex Noun
8104 \begin_layout Plain Layout
8110 is very much an `advanced feature'.
8115 recommended that you save your work before using this function.
8120 recommended that you not attempt to edit layout information while simultaneousl
8121 y working on a document that you care about.
8122 Use a test document.
8123 Syntax errors and the like in your layout file could cause peculiar behavior.
8124 In particular, such errors could cause \SpecialChar LyX
8125 to regard the current layout as
8126 invalid and to attempt to switch to some other layout.
8130 \begin_layout Plain Layout
8131 Really bad syntax errors may even caused \SpecialChar LyX
8133 This is because certain sorts of errors may make \SpecialChar LyX
8144 The \SpecialChar LyX
8145 team strives to keep \SpecialChar LyX
8146 stable in such situations, but safe is better
8151 \begin_layout Plain Layout
8152 While we're giving advice: make regular backups.
8153 And be nice to your mother.
8161 \begin_layout Subsection
8162 The Module declaration
8165 \begin_layout Standard
8166 A module must begin with a line like the following:
8169 \begin_layout LyX-Code
8172 DeclareLyXModule[endnotes.sty]{Endnotes}
8175 \begin_layout Standard
8176 The mandatory argument, in curly brackets, is the name of the module, as
8178 \begin_inset Flex Noun
8181 \begin_layout Plain Layout
8182 Document\SpecialChar menuseparator
8183 Settings\SpecialChar menuseparator
8190 The argument in square brackets is optional: It declares any \SpecialChar LaTeX
8192 on which the module depends.
8193 It is also possible to use the form
8194 \begin_inset Flex Noun
8197 \begin_layout Plain Layout
8203 as an optional argument, which declares that the module can only be used
8204 when there exists a conversion chain between the formats `
8205 \begin_inset Flex Code
8208 \begin_layout Plain Layout
8215 \begin_inset Flex Code
8218 \begin_layout Plain Layout
8227 \begin_layout Standard
8228 The module declaration should then be followed by lines like the following
8232 \begin_layout Plain Layout
8233 Preferably in English if the module should be published with \SpecialChar LyX
8235 This description will appear in the list of messages to be translated and
8236 will be thus translated with the next interface update.
8244 \begin_layout LyX-Code
8248 \begin_layout LyX-Code
8249 #Adds an endnote command, in addition to footnotes.
8253 \begin_layout LyX-Code
8254 #You will need to add
8256 theendnotes in TeX code where you
8259 \begin_layout LyX-Code
8260 #want the endnotes to appear.
8264 \begin_layout LyX-Code
8268 \begin_layout LyX-Code
8269 #Requires: somemodule | othermodule
8272 \begin_layout LyX-Code
8273 #Excludes: badmodule
8276 \begin_layout Standard
8277 The description is used in
8278 \begin_inset Flex Noun
8281 \begin_layout Plain Layout
8282 Document\SpecialChar menuseparator
8283 Settings\SpecialChar menuseparator
8289 to provide the user with information about what the module does.
8291 \begin_inset Flex Code
8294 \begin_layout Plain Layout
8300 line is used to identify other modules with which this one must be used;
8302 \begin_inset Flex Code
8305 \begin_layout Plain Layout
8311 line is used to identify modules with which this one may not be used.
8312 Both are optional, and, as shown, multiple modules should be separated
8313 with the pipe symbol: |.
8314 Note that the required modules are treated disjunctively:
8318 of the required modules must be used.
8323 excluded module may be used.
8324 Note that modules are identified here by their filenames without the
8325 \begin_inset Flex Code
8328 \begin_layout Plain Layout
8336 \begin_inset Flex Code
8339 \begin_layout Plain Layout
8346 \begin_inset Flex Code
8349 \begin_layout Plain Layout
8358 \begin_layout Subsection
8362 \begin_layout Standard
8363 The first non-comment line of any layout file, included file, or module
8368 contain the file format number:
8371 \begin_layout Description
8372 \begin_inset Flex Code
8375 \begin_layout Plain Layout
8382 \begin_inset Flex Code
8385 \begin_layout Plain Layout
8391 ] The format number of the layout file.
8394 \begin_layout Standard
8395 This tag was introduced with \SpecialChar LyX
8397 \begin_inset space ~
8401 Layout files from older \SpecialChar LyX
8402 versions do not have an explicit file format and
8403 are considered to have
8404 \begin_inset Flex Code
8407 \begin_layout Plain Layout
8409 \begin_inset space ~
8418 The format for the present version of \SpecialChar LyX
8420 But each version of \SpecialChar LyX
8421 is capable of reading earlier versions' layout files,
8422 just as they are capable of reading files produced by earlier versions
8425 There is, however, no provision for converting to earlier formats.
8428 \begin_layout Subsection
8429 \begin_inset CommandInset label
8431 name "subsec:General-text-class"
8435 General text class parameters
8438 \begin_layout Standard
8439 These are general parameters that govern the behavior of an entire document
8445 mean that they must appear in
8446 \begin_inset Flex Code
8449 \begin_layout Plain Layout
8455 files rather than in modules.
8456 A module can contain any layout tag.)
8459 \begin_layout Description
8460 \begin_inset Flex Code
8463 \begin_layout Plain Layout
8469 Adds information that will be output in the
8470 \begin_inset Flex Code
8473 \begin_layout Plain Layout
8479 block when the document is output to XHTML.
8480 Typically, this would be used to output CSS style information, but it can
8481 be used for anything that can appear in
8482 \begin_inset Flex Code
8485 \begin_layout Plain Layout
8493 \begin_inset Quotes eld
8497 \begin_inset Flex Code
8500 \begin_layout Plain Layout
8507 \begin_inset Quotes erd
8513 \begin_layout Description
8514 \begin_inset Flex Code
8517 \begin_layout Plain Layout
8523 Adds information to the document preamble.
8525 \begin_inset Newline newline
8529 \begin_inset Quotes eld
8533 \begin_inset Flex Code
8536 \begin_layout Plain Layout
8543 \begin_inset Quotes erd
8549 \begin_layout Description
8550 \begin_inset Flex Code
8553 \begin_layout Plain Layout
8559 Defines formats for use in the display of bibliographic information.
8561 \begin_inset CommandInset ref
8563 reference "subsec:Citation-format-description"
8569 \begin_inset Quotes eld
8573 \begin_inset Flex Code
8576 \begin_layout Plain Layout
8583 \begin_inset Quotes erd
8589 \begin_layout Description
8590 \begin_inset Flex Code
8593 \begin_layout Plain Layout
8599 Describes various global options supported by the document class.
8601 \begin_inset CommandInset ref
8603 reference "subsec:ClassOptions"
8609 \begin_inset Quotes eld
8613 \begin_inset Flex Code
8616 \begin_layout Plain Layout
8623 \begin_inset Quotes erd
8629 \begin_layout Description
8630 \begin_inset Flex Code
8633 \begin_layout Plain Layout
8640 \begin_inset Flex Code
8643 \begin_layout Plain Layout
8652 \begin_inset space \thinspace{}
8656 \begin_inset Flex Code
8659 \begin_layout Plain Layout
8665 ] Whether the class should
8669 to having one or two columns.
8670 Can be changed in the
8671 \begin_inset Flex Noun
8674 \begin_layout Plain Layout
8675 Document\SpecialChar menuseparator
8684 \begin_layout Description
8685 \begin_inset Flex Code
8688 \begin_layout Plain Layout
8695 \begin_inset Flex Code
8698 \begin_layout Plain Layout
8704 ] This sequence defines the properties for a counter.
8705 If the counter does not yet exist, it is created; if it does exist, it
8708 \begin_inset Quotes eld
8712 \begin_inset Flex Code
8715 \begin_layout Plain Layout
8722 \begin_inset Quotes erd
8726 \begin_inset Newline newline
8730 \begin_inset CommandInset ref
8732 reference "subsec:Counters"
8736 for details on counters.
8739 \begin_layout Description
8740 \begin_inset Flex Code
8743 \begin_layout Plain Layout
8749 Sets the default font used to display the document.
8751 \begin_inset CommandInset ref
8753 reference "subsec:Font-description"
8757 for how to declare fonts.
8759 \begin_inset Quotes eld
8763 \begin_inset Flex Code
8766 \begin_layout Plain Layout
8773 \begin_inset Quotes erd
8779 \begin_layout Description
8780 \begin_inset Flex Code
8783 \begin_layout Plain Layout
8790 \begin_inset Flex Code
8793 \begin_layout Plain Layout
8799 ] Specifies a module to be included by default with this document class.
8800 The module is specified as filename without the
8801 \begin_inset Flex Code
8804 \begin_layout Plain Layout
8811 The user can still remove the module, but it will be active at the outset.
8812 (This applies only when new files are created, or when this class is chosen
8813 for an existing document.)
8816 \begin_layout Description
8817 \begin_inset Flex Code
8820 \begin_layout Plain Layout
8827 \begin_inset Flex Code
8830 \begin_layout Plain Layout
8836 ] This is the style that will be assigned to new paragraphs, usually
8837 \begin_inset Flex Noun
8840 \begin_layout Plain Layout
8847 This will default to the first defined style if not given, but you are
8848 encouraged to use this directive.
8851 \begin_layout Description
8852 \begin_inset Flex Code
8855 \begin_layout Plain Layout
8862 \begin_inset Flex Code
8865 \begin_layout Plain Layout
8871 ] This tag indicates that the module (which is specified by filename without
8873 \begin_inset Flex Code
8876 \begin_layout Plain Layout
8882 extension) cannot be used with this document class.
8883 This might be used in a journal-specific layout file to prevent, say, the
8885 \begin_inset Flex Code
8888 \begin_layout Plain Layout
8894 module that numbers theorems by section.
8899 be used in a module.
8900 Modules have their own way of excluding other modules (see
8901 \begin_inset CommandInset ref
8903 reference "subsec:Layout-modules"
8910 \begin_layout Description
8911 \begin_inset Flex Code
8914 \begin_layout Plain Layout
8920 Defines a new float.
8922 \begin_inset CommandInset ref
8924 reference "subsec:Floats"
8930 \begin_inset Quotes eld
8934 \begin_inset Flex Code
8937 \begin_layout Plain Layout
8944 \begin_inset Quotes erd
8950 \begin_layout Description
8951 \begin_inset Flex Code
8954 \begin_layout Plain Layout
8960 Sets the information that will be output in the
8961 \begin_inset Flex Code
8964 \begin_layout Plain Layout
8970 block when this document class is output to XHTML.
8971 Note that this will completely override any prior
8972 \begin_inset Flex Code
8975 \begin_layout Plain Layout
8982 \begin_inset Flex Code
8985 \begin_layout Plain Layout
8993 \begin_inset Newline newline
8997 \begin_inset Flex Code
9000 \begin_layout Plain Layout
9006 if you just want to add material to the preamble.) Must end with
9007 \begin_inset Quotes eld
9011 \begin_inset Flex Code
9014 \begin_layout Plain Layout
9021 \begin_inset Quotes erd
9027 \begin_layout Description
9028 \begin_inset Flex Code
9031 \begin_layout Plain Layout
9038 \begin_inset Flex Code
9041 \begin_layout Plain Layout
9047 ] The style to use for the table of contents, bibliography, and so forth,
9048 when the document is output to HTML.
9049 For articles, this should normally be
9050 \begin_inset Flex Code
9053 \begin_layout Plain Layout
9060 \begin_inset Flex Code
9063 \begin_layout Plain Layout
9070 If it is not given, then \SpecialChar LyX
9071 will attempt to figure out which layout to use.
9074 \begin_layout Description
9075 \begin_inset Flex Code
9078 \begin_layout Plain Layout
9085 \begin_inset Flex Code
9088 \begin_layout Plain Layout
9094 ] Modifies the properties of the given counter.
9095 If the counter does not exist, the statement is ignored.
9097 \begin_inset Quotes eld
9101 \begin_inset Flex Code
9104 \begin_layout Plain Layout
9111 \begin_inset Quotes erd
9115 \begin_inset Newline newline
9119 \begin_inset CommandInset ref
9121 reference "subsec:Counters"
9125 for details on counters.
9128 \begin_layout Description
9129 \begin_inset Flex Code
9132 \begin_layout Plain Layout
9139 \begin_inset Flex Code
9142 \begin_layout Plain Layout
9148 ] This allows you to include another layout definition file within yours
9149 to avoid duplicating commands.
9150 Common examples are the standard layout files, for example,
9151 \begin_inset Flex Code
9154 \begin_layout Plain Layout
9160 , which contains most of the basic layouts.
9163 \begin_layout Description
9164 \begin_inset Flex Code
9167 \begin_layout Plain Layout
9174 \begin_inset Flex Code
9177 \begin_layout Plain Layout
9183 ] This section (re-)defines the layout of an inset.
9184 It can be applied to an existing inset or to a new, user-defined inset,
9185 e.g., a new character style.
9187 \begin_inset Quotes eld
9191 \begin_inset Flex Code
9194 \begin_layout Plain Layout
9201 \begin_inset Quotes erd
9205 \begin_inset Newline newline
9209 \begin_inset CommandInset ref
9211 reference "subsec:Flex-insets-and"
9215 for more information.
9219 \begin_layout Description
9220 \begin_inset Flex Code
9223 \begin_layout Plain Layout
9230 \begin_inset Flex Code
9233 \begin_layout Plain Layout
9239 ] A string that indicates the width of the left margin on the screen, for
9241 \begin_inset Quotes eld
9245 \begin_inset Flex Code
9248 \begin_layout Plain Layout
9255 \begin_inset Quotes erd
9259 (Note that this is not a `length', like
9260 \begin_inset Quotes eld
9264 \begin_inset Quotes erd
9270 \begin_layout Description
9271 \begin_inset Flex Code
9274 \begin_layout Plain Layout
9281 \begin_inset Flex Code
9284 \begin_layout Plain Layout
9290 ] Modifies the properties of the given paragraph style.
9291 If the style does not exist, this section is ignored.
9293 \begin_inset Quotes eld
9297 \begin_inset Flex Code
9300 \begin_layout Plain Layout
9307 \begin_inset Quotes erd
9313 \begin_layout Description
9314 \begin_inset Flex Code
9317 \begin_layout Plain Layout
9324 \begin_inset Flex Code
9327 \begin_layout Plain Layout
9333 ] Deletes an existing counter, usually one defined in an included file.
9336 \begin_layout Description
9337 \begin_inset Flex Code
9340 \begin_layout Plain Layout
9347 \begin_inset Flex Code
9350 \begin_layout Plain Layout
9356 ] Deletes an existing float.
9357 This is particularly useful when you want to suppress a float that has
9358 been defined in an input file.
9361 \begin_layout Description
9362 \begin_inset Flex Code
9365 \begin_layout Plain Layout
9372 \begin_inset Flex Code
9375 \begin_layout Plain Layout
9381 ] Deletes an existing style.
9382 \change_inserted 2047637253 1483900342
9386 \begin_layout Description
9388 \change_inserted 2047637253 1483900479
9389 \begin_inset Flex Code
9392 \begin_layout Plain Layout
9394 \change_inserted 2047637253 1483900346
9401 \begin_inset Flex Code
9404 \begin_layout Plain Layout
9406 \change_inserted 2047637253 1483900369
9413 \begin_inset Flex Code
9416 \begin_layout Plain Layout
9418 \change_inserted 2047637253 1483900418
9424 ] Define a new table of contents with type
9425 \begin_inset Flex Code
9428 \begin_layout Plain Layout
9430 \change_inserted 2047637253 1483900414
9437 \begin_inset Flex Code
9440 \begin_layout Plain Layout
9442 \change_inserted 2047637253 1483900419
9449 See also the AddToToc commands.
9454 \begin_layout Description
9455 \begin_inset Flex Code
9458 \begin_layout Plain Layout
9465 \begin_inset Flex Code
9468 \begin_layout Plain Layout
9474 ] The file format (as defined in the \SpecialChar LyX
9475 preferences) produced by this document
9477 It is mainly useful when
9478 \begin_inset Flex Code
9481 \begin_layout Plain Layout
9488 \begin_inset Flex Code
9491 \begin_layout Plain Layout
9497 and one wants to define a new type of literate document.
9498 The format is reset to
9499 \begin_inset Quotes eld
9503 \begin_inset Flex Code
9506 \begin_layout Plain Layout
9513 \begin_inset Quotes erd
9517 \begin_inset Quotes eld
9521 \begin_inset Flex Code
9524 \begin_layout Plain Layout
9531 \begin_inset Quotes erd
9534 when the corresponding
9535 \begin_inset Flex Code
9538 \begin_layout Plain Layout
9544 parameter is encountered.
9547 \begin_layout Description
9548 \begin_inset Flex Code
9551 \begin_layout Plain Layout
9558 \begin_inset Flex Code
9561 \begin_layout Plain Layout
9572 \begin_inset Flex Code
9575 \begin_layout Plain Layout
9582 \begin_inset Flex Code
9585 \begin_layout Plain Layout
9591 ] Specifies what sort of output documents using this class will produce.
9594 \begin_layout Description
9595 \begin_inset Flex Code
9598 \begin_layout Plain Layout
9605 \begin_inset Flex Code
9608 \begin_layout Plain Layout
9615 \begin_inset Flex Code
9618 \begin_layout Plain Layout
9624 ] Specifies options, given in the second string, for the package named by
9627 \begin_inset Quotes eld
9631 \begin_inset Flex Code
9634 \begin_layout Plain Layout
9635 PackageOptions natbib square
9641 \begin_inset Quotes erd
9645 \begin_inset Flex Code
9648 \begin_layout Plain Layout
9654 to be loaded with the
9655 \begin_inset Flex Code
9658 \begin_layout Plain Layout
9665 (For \SpecialChar TeX
9666 perts, this causes \SpecialChar LyX
9668 \begin_inset Flex Code
9671 \begin_layout Plain Layout
9674 PassOptionsToPackage{natbib}{square}
9680 \begin_inset Flex Code
9683 \begin_layout Plain Layout
9692 \begin_layout Description
9693 \begin_inset Flex Code
9696 \begin_layout Plain Layout
9703 \begin_inset Flex Code
9706 \begin_layout Plain Layout
9715 \begin_inset Flex Code
9718 \begin_layout Plain Layout
9725 \begin_inset Flex Code
9728 \begin_layout Plain Layout
9734 ] The default pagestyle.
9735 Can be changed in the
9736 \begin_inset Flex Noun
9739 \begin_layout Plain Layout
9740 Document\SpecialChar menuseparator
9749 \begin_layout Description
9750 \begin_inset Flex Code
9753 \begin_layout Plain Layout
9759 Sets the preamble for the \SpecialChar LaTeX
9761 Note that this will completely override any prior
9762 \begin_inset Flex Code
9765 \begin_layout Plain Layout
9772 \begin_inset Flex Code
9775 \begin_layout Plain Layout
9783 \begin_inset Flex Code
9786 \begin_layout Plain Layout
9792 if you just want to add material to the preamble.) Must end with
9793 \begin_inset Quotes eld
9797 \begin_inset Flex Code
9800 \begin_layout Plain Layout
9807 \begin_inset Quotes erd
9813 \begin_layout Description
9814 \begin_inset Flex Code
9817 \begin_layout Plain Layout
9824 \begin_inset Flex Code
9827 \begin_layout Plain Layout
9834 \begin_inset Flex Code
9837 \begin_layout Plain Layout
9846 \begin_inset space \thinspace{}
9850 \begin_inset Flex Code
9853 \begin_layout Plain Layout
9859 ] Whether the class already provides the feature
9860 \begin_inset Flex Code
9863 \begin_layout Plain Layout
9870 A feature is in general the name of a package (e.
9871 \begin_inset space \thinspace{}
9875 \begin_inset space \space{}
9879 \begin_inset Flex Code
9882 \begin_layout Plain Layout
9889 \begin_inset Flex Code
9892 \begin_layout Plain Layout
9899 \begin_inset space \thinspace{}
9903 \begin_inset space \space{}
9907 \begin_inset Flex Code
9910 \begin_layout Plain Layout
9917 \begin_inset Flex Code
9920 \begin_layout Plain Layout
9928 \begin_inset CommandInset ref
9930 reference "chap:List-of-functions"
9934 for the list of features.
9937 \begin_layout Description
9938 \begin_inset Flex Code
9941 \begin_layout Plain Layout
9948 \begin_inset Flex Code
9951 \begin_layout Plain Layout
9957 ] Indicates that this layout provides the functionality of the module mentioned,
9958 which should be specified by the filename without the
9959 \begin_inset Flex Code
9962 \begin_layout Plain Layout
9969 This will typically be used if the layout includes the module directly,
9970 rather than using the
9971 \begin_inset Flex Code
9974 \begin_layout Plain Layout
9980 tag to indicate that it ought to be used.
9981 It could also be used in a module that provided an alternate implementation
9982 of the same functionality.
9985 \begin_layout Description
9986 \begin_inset Flex Code
9989 \begin_layout Plain Layout
9996 \begin_inset Flex Code
9999 \begin_layout Plain Layout
10005 ] Creates a new paragraph style if it does not already exist.
10006 If the style does exist, this section is ignored.
10008 \begin_inset Quotes eld
10012 \begin_inset Flex Code
10015 \begin_layout Plain Layout
10022 \begin_inset Quotes erd
10028 \begin_layout Description
10029 \begin_inset Flex Code
10032 \begin_layout Plain Layout
10039 \begin_inset Flex Code
10042 \begin_layout Plain Layout
10048 ] Whether the class requires the feature
10049 \begin_inset Flex Code
10052 \begin_layout Plain Layout
10059 Multiple features must be separated by commas.
10060 Note that you can only request supported features.
10062 \begin_inset CommandInset ref
10064 reference "chap:List-of-functions"
10068 for the list of features.).
10069 If you require a package with specific options, you can additionally use
10071 \begin_inset Flex Code
10074 \begin_layout Plain Layout
10083 \begin_layout Description
10084 \begin_inset Flex Code
10087 \begin_layout Plain Layout
10094 \begin_inset Flex Code
10097 \begin_layout Plain Layout
10103 ] A string that indicates the width of the right margin on the screen, for
10105 \begin_inset Quotes eld
10109 \begin_inset Flex Code
10112 \begin_layout Plain Layout
10119 \begin_inset Quotes erd
10125 \begin_layout Description
10126 \begin_inset Flex Code
10129 \begin_layout Plain Layout
10136 \begin_inset Flex Code
10139 \begin_layout Plain Layout
10145 ] Sets which divisions get numbered.
10147 \begin_inset Newline newline
10151 \begin_inset Flex Code
10154 \begin_layout Plain Layout
10160 counter in \SpecialChar LaTeX
10164 \begin_layout Description
10165 \begin_inset Flex Code
10168 \begin_layout Plain Layout
10175 \begin_inset Flex Code
10178 \begin_layout Plain Layout
10187 \begin_inset space \thinspace{}
10191 \begin_inset Flex Code
10194 \begin_layout Plain Layout
10200 ] Whether the class-default should be printing on one or both sides of the
10202 Can be changed in the
10203 \begin_inset Flex Noun
10206 \begin_layout Plain Layout
10207 Document\SpecialChar menuseparator
10216 \begin_layout Description
10217 \begin_inset Flex Code
10220 \begin_layout Plain Layout
10227 \begin_inset Flex Code
10230 \begin_layout Plain Layout
10236 ] This sequence defines a paragraph style.
10237 If the style does not yet exist, it is created; if it does exist, its parameter
10240 \begin_inset Quotes eld
10244 \begin_inset Flex Code
10247 \begin_layout Plain Layout
10254 \begin_inset Quotes erd
10258 \begin_inset Newline newline
10262 \begin_inset CommandInset ref
10264 reference "subsec:Paragraph-Styles"
10268 for details on paragraph styles.
10271 \begin_layout Description
10272 \begin_inset Flex Code
10275 \begin_layout Plain Layout
10282 \begin_inset Flex Code
10285 \begin_layout Plain Layout
10291 ] The name of the command or environment to be used with
10292 \begin_inset Flex Code
10295 \begin_layout Plain Layout
10304 \begin_layout Description
10305 \begin_inset Flex Code
10308 \begin_layout Plain Layout
10315 \begin_inset Flex Code
10318 \begin_layout Plain Layout
10327 \begin_inset Flex Code
10330 \begin_layout Plain Layout
10336 ] Indicates what kind of markup is used to define the title of a document.
10338 \begin_inset Flex Code
10341 \begin_layout Plain Layout
10347 means that the macro with name
10348 \begin_inset Flex Code
10351 \begin_layout Plain Layout
10357 will be inserted after the last layout which has
10358 \begin_inset Quotes eld
10362 \begin_inset Flex Code
10365 \begin_layout Plain Layout
10367 \begin_inset space ~
10376 \begin_inset Quotes erd
10381 \begin_inset Flex Code
10384 \begin_layout Plain Layout
10390 corresponds to the case where all layouts which have
10391 \begin_inset Quotes eld
10395 \begin_inset Flex Code
10398 \begin_layout Plain Layout
10400 \begin_inset space ~
10409 \begin_inset Quotes erd
10412 should be enclosed into the
10413 \begin_inset Flex Code
10416 \begin_layout Plain Layout
10425 \begin_layout Description
10426 \begin_inset Flex Code
10429 \begin_layout Plain Layout
10436 \begin_inset Flex Code
10439 \begin_layout Plain Layout
10445 ] Sets which divisions are included in the table of contents.
10447 \begin_inset Flex Code
10450 \begin_layout Plain Layout
10456 counter in \SpecialChar LaTeX
10460 \begin_layout Subsection
10461 \begin_inset Flex Code
10464 \begin_layout Plain Layout
10471 \begin_inset CommandInset label
10473 name "subsec:ClassOptions"
10480 \begin_layout Standard
10482 \begin_inset Flex Code
10485 \begin_layout Plain Layout
10491 section can contain the following entries:
10494 \begin_layout Description
10495 \begin_inset Flex Code
10498 \begin_layout Plain Layout
10505 \begin_inset Flex Code
10508 \begin_layout Plain Layout
10514 ] The list of available font sizes for the document's main font, separated
10516 \begin_inset Quotes eld
10520 \begin_inset Flex Code
10523 \begin_layout Plain Layout
10530 \begin_inset Quotes erd
10536 \begin_layout Description
10537 \begin_inset Flex Code
10540 \begin_layout Plain Layout
10546 Used to set the DTD line with XML-based output classes.
10548 \begin_inset space \thinspace{}
10552 \begin_inset Quotes eld
10555 -//OASIS//DTD DocBook V4.2//EN
10556 \begin_inset Quotes erd
10562 \begin_layout Description
10563 \begin_inset Flex Code
10566 \begin_layout Plain Layout
10573 \begin_inset Flex Code
10576 \begin_layout Plain Layout
10577 string="empty|plain|headings|fancy"
10582 ] The list of available page sty\SpecialChar softhyphen
10584 \begin_inset Quotes eld
10588 \begin_inset Flex Code
10591 \begin_layout Plain Layout
10598 \begin_inset Quotes erd
10604 \begin_layout Description
10605 \begin_inset Flex Code
10608 \begin_layout Plain Layout
10615 \begin_inset Flex Code
10618 \begin_layout Plain Layout
10624 ] Some document class options, separated by a comma, that will be added
10625 to the optional part of the
10626 \begin_inset Flex Code
10629 \begin_layout Plain Layout
10640 \begin_layout Standard
10642 \begin_inset Flex Code
10645 \begin_layout Plain Layout
10651 section must end with
10652 \begin_inset Quotes eld
10656 \begin_inset Flex Code
10659 \begin_layout Plain Layout
10666 \begin_inset Quotes erd
10672 \begin_layout Subsection
10674 \begin_inset CommandInset label
10676 name "subsec:Paragraph-Styles"
10683 \begin_layout Standard
10684 A paragraph style description looks like this:
10688 \begin_layout Plain Layout
10689 Note that this will either define a new style or modify an existing one.
10697 \begin_layout LyX-Code
10704 \begin_layout LyX-Code
10708 \begin_layout LyX-Code
10712 \begin_layout Standard
10713 where the following commands are allowed:
10716 \begin_layout Description
10718 \change_inserted 2047637253 1483963019
10719 \begin_inset Flex Code
10722 \begin_layout Plain Layout
10724 \change_inserted 2047637253 1483901753
10731 \begin_inset Flex Code
10734 \begin_layout Plain Layout
10736 \change_inserted 2047637253 1483963007
10742 =""] This paragraph will appear in the table of contents of the given type.
10743 An empty string disables.
10744 See also the OutlinerName and the IsTocCaption commands.
10748 \begin_layout Description
10749 \begin_inset Flex Code
10752 \begin_layout Plain Layout
10759 \begin_inset Flex Code
10762 \begin_layout Plain Layout
10767 , left, right, center
10772 ] Paragraph alignment.
10775 \begin_layout Description
10776 \begin_inset Flex Code
10779 \begin_layout Plain Layout
10786 \begin_inset Flex Code
10789 \begin_layout Plain Layout
10794 , left, right, center
10799 ] A comma separated list of permitted alignments.
10800 (Some \SpecialChar LaTeX
10801 styles prohibit certain alignments, since those wouldn't make sense.
10802 For example a right-aligned or centered enumeration isn't possible.)
10805 \begin_layout Description
10806 \begin_inset Flex Code
10809 \begin_layout Plain Layout
10816 \begin_inset Flex Code
10819 \begin_layout Plain Layout
10825 ] Defines argument number <int> of a command\SpecialChar breakableslash
10826 environment associated with
10828 This is useful for things like section headings, and only makes sense with
10831 Every (optional or required) argument of a command or environment – except
10832 for the required argument that is associated with the content of the paragraph
10833 itself – has a separate definition, where the number specifies the order
10835 The definition must end with
10836 \begin_inset Flex Code
10839 \begin_layout Plain Layout
10846 So a command with two optional arguments has:
10850 \begin_layout Quote
10856 \begin_layout Quote
10862 \begin_layout Quote
10868 \begin_layout Quote
10874 \begin_layout Quote
10880 \begin_layout Quote
10886 \begin_layout Standard
10888 \begin_inset Flex Code
10891 \begin_layout Plain Layout
10897 definition, the following specifications are possible:
10900 \begin_layout Itemize
10901 \begin_inset Flex Code
10904 \begin_layout Plain Layout
10911 \begin_inset Flex Code
10914 \begin_layout Plain Layout
10920 The string that will appear both in the menu (to insert this argument)
10921 and on the argument inset button (unless you also specify a separate
10922 \begin_inset Flex Code
10925 \begin_layout Plain Layout
10932 For the menu, you can define an accelerator by appending the respective
10933 character to the string, divided by
10934 \begin_inset Quotes eld
10938 \begin_inset Quotes erd
10942 \begin_inset space \thinspace{}
10946 \begin_inset space \space{}
10950 \begin_inset Quotes eld
10954 \begin_inset Flex Code
10957 \begin_layout Plain Layout
10964 \begin_inset Quotes erd
10970 \begin_layout Itemize
10971 \begin_inset Flex Code
10974 \begin_layout Plain Layout
10981 \begin_inset Flex Code
10984 \begin_layout Plain Layout
10990 A separate string for the menu.
10991 You can define an accelerator by appending the respective character to
10992 the string, divided by
10993 \begin_inset Quotes eld
10997 \begin_inset Quotes erd
11001 \begin_inset space \thinspace{}
11005 \begin_inset space \space{}
11009 \begin_inset Quotes eld
11013 \begin_inset Flex Code
11016 \begin_layout Plain Layout
11023 \begin_inset Quotes erd
11027 This specification is optional.
11028 If it is not given the
11029 \begin_inset Flex Code
11032 \begin_layout Plain Layout
11038 will be used instead for the menu.
11041 \begin_layout Itemize
11042 \begin_inset Flex Code
11045 \begin_layout Plain Layout
11052 \begin_inset Flex Code
11055 \begin_layout Plain Layout
11061 A longer explanatory text that appears in the tooltip when hovering over
11062 the argument inset.
11065 \begin_layout Itemize
11066 \begin_inset Flex Code
11069 \begin_layout Plain Layout
11076 \begin_inset Flex Code
11079 \begin_layout Plain Layout
11088 \begin_inset space \thinspace{}
11092 \begin_inset Flex Code
11095 \begin_layout Plain Layout
11101 ] Declare if this is a mandatory (1) or an optional (0) argument.
11102 Mandatory arguments will be output empty if not given, while optional arguments
11103 will not be output at all.
11104 By default, mandatory arguments are delimited by
11105 \begin_inset Flex Code
11108 \begin_layout Plain Layout
11114 , while optional arguments are delimited by
11115 \begin_inset Flex Code
11118 \begin_layout Plain Layout
11127 \begin_layout Itemize
11128 \begin_inset Flex Code
11131 \begin_layout Plain Layout
11138 \begin_inset Flex Code
11141 \begin_layout Plain Layout
11147 defines another argument (by its number) which this argument requires to
11148 be output if it is itself output.
11150 \begin_inset space \thinspace{}
11153 g., in \SpecialChar LaTeX
11154 commands, optional arguments often require previous optional arguments
11155 to be output (at least empty), as in
11156 \begin_inset Flex Code
11159 \begin_layout Plain Layout
11162 command[][argument]{text}
11168 This can be achieved by the statement
11169 \begin_inset Flex Code
11172 \begin_layout Plain Layout
11179 \begin_inset Flex Code
11182 \begin_layout Plain Layout
11191 \begin_layout Itemize
11192 \begin_inset Flex Code
11195 \begin_layout Plain Layout
11202 \begin_inset Flex Code
11205 \begin_layout Plain Layout
11211 defines a custom left delimiter (instead of
11212 \begin_inset Flex Code
11215 \begin_layout Plain Layout
11222 \begin_inset Flex Code
11225 \begin_layout Plain Layout
11232 A line break in the output can be indicated by
11233 \begin_inset Flex Code
11236 \begin_layout Plain Layout
11245 \begin_layout Itemize
11246 \begin_inset Flex Code
11249 \begin_layout Plain Layout
11256 \begin_inset Flex Code
11259 \begin_layout Plain Layout
11265 defines a custom right delimiter (instead of
11266 \begin_inset Flex Code
11269 \begin_layout Plain Layout
11276 \begin_inset Flex Code
11279 \begin_layout Plain Layout
11286 A line break in the output can be indicated by
11287 \begin_inset Flex Code
11290 \begin_layout Plain Layout
11299 \begin_layout Itemize
11300 \begin_inset Flex Code
11303 \begin_layout Plain Layout
11310 \begin_inset Flex Code
11313 \begin_layout Plain Layout
11319 defines an argument that is inserted if and only if no user-specified arguments
11321 \begin_inset space \thinspace{}
11325 \begin_inset space \space{}
11328 if no argument inset has been inserted (note that also an empty argument
11329 inset omits the DefaultArg).
11330 Multiple arguments need to be separated by comma.
11333 \begin_layout Itemize
11334 \begin_inset Flex Code
11337 \begin_layout Plain Layout
11344 \begin_inset Flex Code
11347 \begin_layout Plain Layout
11353 defines an argument that is inserted in any case (alone or in addition
11354 to user-specified arguments).
11355 Multiple arguments need to be separated by comma.
11358 \begin_layout Itemize
11359 \begin_inset Flex Code
11362 \begin_layout Plain Layout
11368 The font used for the argument content, see
11369 \begin_inset CommandInset ref
11371 reference "subsec:Font-description"
11378 \begin_layout Itemize
11379 \begin_inset Flex Code
11382 \begin_layout Plain Layout
11388 The font used for the label; see
11389 \begin_inset CommandInset ref
11391 reference "subsec:Font-description"
11398 \begin_layout Itemize
11399 \begin_inset Flex Code
11402 \begin_layout Plain Layout
11409 \begin_inset Flex Code
11412 \begin_layout Plain Layout
11417 , Minimalistic, Conglomerate
11422 ] describes the rendering style used for the inset's frame and buttons.
11425 \begin_layout Itemize
11426 \begin_inset Flex Code
11429 \begin_layout Plain Layout
11436 \begin_inset Flex Code
11439 \begin_layout Plain Layout
11446 \begin_inset Flex Code
11449 \begin_layout Plain Layout
11455 , this argument is automatically inserted when the respective style is selected.
11456 Currently, only one argument per style\SpecialChar breakableslash
11457 layout can be automatically inserted.
11460 \begin_layout Itemize
11461 \begin_inset Flex Code
11464 \begin_layout Plain Layout
11471 \begin_inset Flex Code
11474 \begin_layout Plain Layout
11481 \begin_inset Flex Code
11484 \begin_layout Plain Layout
11490 , this argument will be inserted with a copy of the co-text (either selected
11491 text or the whole paragraph) as content.
11492 \change_inserted -712698321 1477038290
11496 \begin_layout Itemize
11498 \change_inserted -712698321 1477038425
11499 \begin_inset Flex Code
11502 \begin_layout Plain Layout
11504 \change_inserted -712698321 1477038295
11511 \begin_inset Flex Code
11514 \begin_layout Plain Layout
11516 \change_inserted -712698321 1477038311
11526 ] Whether the contents of this argument should be output in raw form, meaning
11527 without special translations that \SpecialChar LaTeX
11530 \begin_inset Flex Code
11533 \begin_layout Plain Layout
11535 \change_inserted -712698321 1477038356
11541 status is inherited by the inset or paragraph layout the argument belongs
11542 to, true and false change the status for the given argument only.
11547 \begin_layout Itemize
11548 \begin_inset Flex Code
11551 \begin_layout Plain Layout
11558 \begin_inset Flex Code
11561 \begin_layout Plain Layout
11562 string of characters
11571 Defines individual characters that should be output in raw form, meaning
11572 without special translations that \SpecialChar LaTeX
11574 Note that, contrary to PassThru, this needs to be explicitly defined for
11576 That is, arguments do not inherit PassThruChars from their parent inset
11578 \change_inserted 2047637253 1483899840
11582 \begin_layout Itemize
11584 \change_inserted 2047637253 1483900841
11585 \begin_inset Flex Code
11588 \begin_layout Plain Layout
11590 \change_inserted 2047637253 1483900841
11597 \begin_inset Flex Code
11600 \begin_layout Plain Layout
11602 \change_inserted 2047637253 1483900841
11611 \begin_inset space \thinspace{}
11615 \begin_inset Flex Code
11618 \begin_layout Plain Layout
11620 \change_inserted 2047637253 1483900841
11626 ] If this is set to 1, the argument will output its content in the corresponding
11627 item in the table of contents.
11633 \begin_layout Standard
11634 By default, the text entered in the \SpecialChar LyX
11635 workarea in the respective layout is
11636 the last (mandatory) argument of a command if the
11637 \begin_inset Flex Code
11640 \begin_layout Plain Layout
11647 \begin_inset Flex Code
11650 \begin_layout Plain Layout
11657 However, arguments with the prefix
11658 \begin_inset Flex Code
11661 \begin_layout Plain Layout
11667 are output after this workarea argument.
11668 Note that post-argument numbering restarts at 1, so the first argument
11669 following the workarea argument is
11670 \begin_inset Flex Code
11673 \begin_layout Plain Layout
11680 Post-arguments are ignored in any other
11681 \begin_inset Flex Code
11684 \begin_layout Plain Layout
11691 \begin_inset Flex Code
11694 \begin_layout Plain Layout
11703 \begin_layout Standard
11705 \begin_inset Flex Code
11708 \begin_layout Plain Layout
11717 \begin_inset Flex Code
11720 \begin_layout Plain Layout
11729 \begin_inset Flex Code
11732 \begin_layout Plain Layout
11738 followed by the number (e.
11739 \begin_inset space \thinspace{}
11743 \begin_inset space \space{}
11747 \begin_inset Flex Code
11750 \begin_layout Plain Layout
11760 \begin_layout Description
11761 \begin_inset Flex Code
11764 \begin_layout Plain Layout
11770 Note that this will completely override any prior
11771 \begin_inset Flex Code
11774 \begin_layout Plain Layout
11780 declaration for this style.
11782 \begin_inset Quotes eld
11786 \begin_inset Flex Code
11789 \begin_layout Plain Layout
11796 \begin_inset Quotes erd
11801 \begin_inset CommandInset ref
11803 reference "subsec:I18n"
11807 for details on its use.
11810 \begin_layout Description
11811 \begin_inset Flex Code
11814 \begin_layout Plain Layout
11821 \begin_inset Flex Code
11824 \begin_layout Plain Layout
11834 \begin_layout Plain Layout
11835 Note that a `float' here is a real number, such as: 1.5.
11840 The vertical space with which the last of a chain of paragraphs with this
11841 style is separated from the following paragraph.
11842 If the next paragraph has another style, the separations are not simply
11843 added, but the maximum is taken.
11846 \begin_layout Description
11847 \begin_inset Flex Code
11850 \begin_layout Plain Layout
11857 \begin_inset Flex Code
11860 \begin_layout Plain Layout
11866 ] The category for this style.
11867 This is used to group related styles in the style combobox on the toolbar.
11868 Any string can be used, but you may want to use existing categories with
11873 \begin_layout Description
11874 \begin_inset Flex Code
11877 \begin_layout Plain Layout
11883 Depth of XML command.
11884 Used only with XML-type formats.
11887 \begin_layout Description
11888 \begin_inset Flex Code
11891 \begin_layout Plain Layout
11898 \begin_inset Flex Code
11901 \begin_layout Plain Layout
11907 ] Copies all the features of an existing style into the current one.
11911 \begin_layout Description
11912 \begin_inset Flex Code
11915 \begin_layout Plain Layout
11922 \begin_inset Flex Code
11925 \begin_layout Plain Layout
11931 ] The name of a style whose preamble should be output
11936 This allows to ensure some ordering of the preamble snippets when macros
11937 definitions depend on one another.
11941 \begin_layout Plain Layout
11942 Note that, besides that functionality, there is no way to ensure any ordering
11944 The ordering that you see in a given version of \SpecialChar LyX
11945 may change without warning
11954 \begin_layout Description
11955 \begin_inset Flex Code
11958 \begin_layout Plain Layout
11965 \begin_inset Flex Code
11968 \begin_layout Plain Layout
11973 , Box, Filled_Box, Static
11978 ] The type of label that stands at the end of the paragraph (or sequence
11980 \begin_inset Flex Code
11983 \begin_layout Plain Layout
11990 \begin_inset Newline newline
11994 \begin_inset Flex Code
11997 \begin_layout Plain Layout
12004 \begin_inset Flex Code
12007 \begin_layout Plain Layout
12014 \begin_inset Flex Code
12017 \begin_layout Plain Layout
12025 \begin_inset Flex Code
12028 \begin_layout Plain Layout
12035 \begin_inset Quotes eld
12039 \begin_inset Quotes erd
12043 \begin_inset Flex Code
12046 \begin_layout Plain Layout
12053 \begin_inset space \space{}
12057 \begin_inset Flex Code
12060 \begin_layout Plain Layout
12066 ) is a white (resp.
12067 \begin_inset space ~
12070 black) square suitable for end of proof markers,
12071 \begin_inset Flex Code
12074 \begin_layout Plain Layout
12080 is an explicit text string.
12083 \begin_layout Description
12084 \begin_inset Flex Code
12087 \begin_layout Plain Layout
12094 \begin_inset Flex Code
12097 \begin_layout Plain Layout
12103 ] The string used for a label with a
12104 \begin_inset Flex Code
12107 \begin_layout Plain Layout
12114 \begin_inset Newline newline
12118 \begin_inset Flex Code
12121 \begin_layout Plain Layout
12131 \begin_layout Description
12132 \begin_inset Flex Code
12135 \begin_layout Plain Layout
12141 The font used for both the text body
12147 \begin_inset CommandInset ref
12149 reference "subsec:Font-description"
12154 Note that defining this font automatically defines the
12155 \begin_inset Flex Code
12158 \begin_layout Plain Layout
12165 So you should define this one first if you also want to define
12166 \begin_inset Flex Code
12169 \begin_layout Plain Layout
12178 \begin_layout Description
12179 \begin_inset Flex Code
12182 \begin_layout Plain Layout
12189 \begin_inset Flex Code
12192 \begin_layout Plain Layout
12198 ] Used for backporting new styles to stable \SpecialChar LyX
12200 The first stable version that supports this tag is \SpecialChar LyX
12202 The argument is a number which may either be 0, -1 or any value greater
12205 \begin_inset Flex Code
12208 \begin_layout Plain Layout
12214 flag of a style is greater than zero, it will always be written to the
12216 If a .lyx file is read, the style definitions from the document header are
12217 added to the document class.
12218 Therefore even older \SpecialChar LyX
12219 versions can handle the style.
12221 \begin_inset Flex Code
12224 \begin_layout Plain Layout
12230 is a version number: if the style is read, and the version number is less
12231 than the version number of the already existing style in the document class,
12232 the new style is ignored.
12233 If the version number is greater, the new style replaces the existing style.
12234 A value of -1 means an infinite version number, i.
12235 \begin_inset space \thinspace{}
12239 \begin_inset space \space{}
12242 the style is always used.
12245 \begin_layout Description
12246 \begin_inset Flex Code
12249 \begin_layout Plain Layout
12256 \begin_inset Flex Code
12259 \begin_layout Plain Layout
12268 \begin_inset space \thinspace{}
12272 \begin_inset Flex Code
12275 \begin_layout Plain Layout
12281 ] Usually \SpecialChar LyX
12282 does not allow you to insert more than one space between words,
12283 since a space is considered as the separation between two words, not a
12284 character or symbol of its own.
12285 This is a very fine thing but sometimes annoying, for example, when typing
12286 program code or plain \SpecialChar LaTeX
12289 \begin_inset Flex Code
12292 \begin_layout Plain Layout
12299 Note that \SpecialChar LyX
12300 will create protected blanks for the additional blanks when
12301 in another mode than \SpecialChar LaTeX
12305 \begin_layout Description
12306 \begin_inset Flex Code
12309 \begin_layout Plain Layout
12315 These tags are used with XHTML output.
12317 \begin_inset CommandInset ref
12319 reference "subsec:Paragraph-Style-XHTML"
12326 \begin_layout Description
12327 \begin_inset Flex Code
12330 \begin_layout Plain Layout
12336 [FIXME] (Used only with XML-type formats.)
12339 \begin_layout Description
12340 \begin_inset Flex Code
12343 \begin_layout Plain Layout
12350 \begin_inset Flex Code
12353 \begin_layout Plain Layout
12362 \begin_inset space \thinspace{}
12366 \begin_inset Flex Code
12369 \begin_layout Plain Layout
12376 \begin_inset Flex Code
12379 \begin_layout Plain Layout
12385 , marks the style as to be included in the document preamble and not in
12387 This is useful for document classes that want such information as the title
12388 and author to appear in the preamble.
12389 Note that this works only for styles for which the
12390 \begin_inset Flex Code
12393 \begin_layout Plain Layout
12400 \begin_inset Flex Code
12403 \begin_layout Plain Layout
12410 \begin_inset Flex Code
12413 \begin_layout Plain Layout
12422 \begin_layout Description
12423 \begin_inset Flex Code
12426 \begin_layout Plain Layout
12433 \begin_inset Flex Code
12436 \begin_layout Plain Layout
12445 \begin_inset space \thinspace{}
12449 \begin_inset Flex Code
12452 \begin_layout Plain Layout
12459 \begin_inset Flex Code
12462 \begin_layout Plain Layout
12468 , marks the style as being part of a title block (see also the
12469 \begin_inset Flex Code
12472 \begin_layout Plain Layout
12479 \begin_inset Flex Code
12482 \begin_layout Plain Layout
12491 \begin_layout Description
12493 \change_inserted 2047637253 1483902824
12494 \begin_inset Flex Code
12497 \begin_layout Plain Layout
12499 \change_inserted 2047637253 1483902211
12506 \begin_inset Flex Code
12509 \begin_layout Plain Layout
12511 \change_inserted 2047637253 1483902211
12520 \begin_inset space \thinspace{}
12524 \begin_inset Flex Code
12527 \begin_layout Plain Layout
12529 \change_inserted 2047637253 1483902211
12535 ] If this is set to 1 and AddToToc is enabled, the paragraph adds a summary
12536 of its contents in its item in the table of contents.
12537 Otherwise, only the label, if it exists, appears.
12540 \begin_layout Description
12541 \begin_inset Flex Code
12544 \begin_layout Plain Layout
12551 \begin_inset Flex Code
12554 \begin_layout Plain Layout
12560 ] The \SpecialChar LaTeX
12561 command sequence declaring an item in a list.
12562 The command is to be defined without the preceding backslash (the default
12564 \begin_inset Quotes eld
12568 \begin_inset Quotes erd
12572 \begin_inset Flex Code
12575 \begin_layout Plain Layout
12583 in the \SpecialChar LaTeX
12587 \begin_layout Description
12588 \begin_inset Flex Code
12591 \begin_layout Plain Layout
12598 \begin_inset Flex Code
12601 \begin_layout Plain Layout
12607 ] This provides extra space between paragraphs that have the same style.
12608 If you put other styles into an environment, each is separated with the
12610 \begin_inset Flex Code
12613 \begin_layout Plain Layout
12620 But the whole items of the environment are additionally separated with
12622 \begin_inset Flex Code
12625 \begin_layout Plain Layout
12632 Note that this is a
12637 \begin_layout Description
12638 \begin_inset Flex Code
12641 \begin_layout Plain Layout
12647 [FIXME] (Used only with XML-type formats.)
12650 \begin_layout Description
12651 \begin_inset Flex Code
12654 \begin_layout Plain Layout
12661 \begin_inset Flex Code
12664 \begin_layout Plain Layout
12673 \begin_inset space \thinspace{}
12677 \begin_inset Flex Code
12680 \begin_layout Plain Layout
12686 ] Usually \SpecialChar LyX
12687 does not allow you to leave a paragraph empty, since it would
12688 lead to empty \SpecialChar LaTeX
12690 There are some cases where this could be desirable however: in a letter
12691 template, the required fields can be provided as empty fields, so that
12692 people do not forget them; in some special classes, a style can be used
12693 as some kind of break, which does not contain actual text.
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 ] The vertical space between the label and the text body.
12717 Only used for labels that are above the text body (
12718 \begin_inset Flex Code
12721 \begin_layout Plain Layout
12728 \begin_inset Newline newline
12732 \begin_inset Flex Code
12735 \begin_layout Plain Layout
12736 Centered_Top_Environment
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 name of the counter for automatic numbering.
12765 In order to have the counter appear with your label, you will need to reference
12767 \begin_inset Flex Code
12770 \begin_layout Plain Layout
12779 This will work with
12780 \begin_inset Flex Code
12783 \begin_layout Plain Layout
12790 \begin_inset Flex Code
12793 \begin_layout Plain Layout
12800 \begin_inset Flex Code
12803 \begin_layout Plain Layout
12810 \begin_inset Flex Code
12813 \begin_layout Plain Layout
12820 \begin_inset Newline newline
12828 \begin_inset Flex Code
12831 \begin_layout Plain Layout
12838 \begin_inset Flex Code
12841 \begin_layout Plain Layout
12847 , though this case is a bit complicated.
12848 Suppose you declare
12849 \begin_inset Quotes eld
12853 \begin_inset Flex Code
12856 \begin_layout Plain Layout
12857 LabelCounter myenum
12863 \begin_inset Quotes erd
12867 Then the actual counters used are
12868 \begin_inset Flex Code
12871 \begin_layout Plain Layout
12878 \begin_inset Flex Code
12881 \begin_layout Plain Layout
12888 \begin_inset Flex Code
12891 \begin_layout Plain Layout
12898 \begin_inset Flex Code
12901 \begin_layout Plain Layout
12907 , much as in \SpecialChar LaTeX
12909 These counters must all be declared separately.
12910 \begin_inset Newline newline
12914 \begin_inset CommandInset ref
12916 reference "subsec:Counters"
12920 for details on counters.
12923 \begin_layout Description
12924 \begin_inset Flex Code
12927 \begin_layout Plain Layout
12933 The font used for the label.
12935 \begin_inset CommandInset ref
12937 reference "subsec:Font-description"
12944 \begin_layout Description
12945 \begin_inset Flex Code
12948 \begin_layout Plain Layout
12955 \begin_inset Flex Code
12958 \begin_layout Plain Layout
12964 ] Text that indicates how far a label should be indented.
12967 \begin_layout Description
12968 \begin_inset Flex Code
12971 \begin_layout Plain Layout
12978 \begin_inset Flex Code
12981 \begin_layout Plain Layout
12987 ] Text that indicates the amount of horizontal space between the label and
12989 Only used for labels that are not above the text body.
12992 \begin_layout Description
12993 \begin_inset Flex Code
12996 \begin_layout Plain Layout
13003 \begin_inset Flex Code
13006 \begin_layout Plain Layout
13012 ] The string used for the label.
13014 \begin_inset Flex Code
13017 \begin_layout Plain Layout
13023 is set, this string can be contain the special formatting commands described
13025 \begin_inset CommandInset ref
13027 reference "subsec:Counters"
13034 \begin_layout Description
13035 \begin_inset Flex Code
13038 \begin_layout Plain Layout
13039 LabelStringAppendix
13045 \begin_inset Flex Code
13048 \begin_layout Plain Layout
13054 ] This is used inside the appendix instead of
13055 \begin_inset Newline newline
13059 \begin_inset Flex Code
13062 \begin_layout Plain Layout
13070 \begin_inset Flex Code
13073 \begin_layout Plain Layout
13080 \begin_inset Newline newline
13084 \begin_inset Flex Code
13087 \begin_layout Plain Layout
13088 LabelStringAppendix
13096 \begin_layout Description
13097 \begin_inset Flex Code
13100 \begin_layout Plain Layout
13106 [FIXME] (Used only with XML-type formats.)
13109 \begin_layout Description
13110 \begin_inset Flex Code
13113 \begin_layout Plain Layout
13120 \begin_inset Flex Code
13123 \begin_layout Plain Layout
13128 , Manual, Static, Above,
13129 \begin_inset Newline newline
13132 Centered, Sensitive, Enumerate,
13133 \begin_inset Newline newline
13136 Itemize, Bibliography
13145 \begin_layout Description
13146 \begin_inset Flex Code
13149 \begin_layout Plain Layout
13155 means the label is the very first word (up to the first real blank).
13156 Use protected spaces if you want more than one word as the label.
13160 \begin_layout Description
13161 \begin_inset Flex Code
13164 \begin_layout Plain Layout
13170 means the label is simply what is declared as
13171 \begin_inset Flex Code
13174 \begin_layout Plain Layout
13181 This will be displayed
13182 \begin_inset Quotes eld
13186 \begin_inset Quotes erd
13189 , at the beginning of the paragraph.
13191 \begin_inset Flex Code
13194 \begin_layout Plain Layout
13201 \begin_inset Flex Code
13204 \begin_layout Plain Layout
13210 , then it will be displayed only in the first paragraph of any sequence
13211 of paragraphs with the same
13212 \begin_inset Flex Code
13215 \begin_layout Plain Layout
13224 \begin_layout Description
13225 \begin_inset Flex Code
13228 \begin_layout Plain Layout
13235 \begin_inset space ~
13239 \begin_inset space ~
13243 \begin_inset Flex Code
13246 \begin_layout Plain Layout
13252 are special cases of
13253 \begin_inset Flex Code
13256 \begin_layout Plain Layout
13263 The label will be printed above the paragraph either at the beginning of
13264 the line or centered.
13267 \begin_layout Description
13268 \begin_inset Flex Code
13271 \begin_layout Plain Layout
13277 is a special case for the caption-labels
13278 \begin_inset Quotes eld
13282 \begin_inset Quotes erd
13286 \begin_inset Quotes eld
13290 \begin_inset Quotes erd
13294 \begin_inset Newline newline
13298 \begin_inset Flex Code
13301 \begin_layout Plain Layout
13307 means the (hardcoded) label string depends on the kind of float: It is
13308 hardcoded to be `FloatType N', where N is the value of the counter associated
13310 For the case that a caption is inserted outside of a float the
13311 \begin_inset Flex Code
13314 \begin_layout Plain Layout
13321 \begin_inset Quotes eld
13325 \begin_inset Quotes erd
13331 \begin_layout Description
13332 \begin_inset Flex Code
13335 \begin_layout Plain Layout
13341 produces the usual sort of enumeration labels.
13342 At present, it is hardcoded to use Arabic numerals, lowercase letters,
13343 small Roman numerals, and uppercase letters for the four possible depths.
13346 \begin_layout Description
13347 \begin_inset Flex Code
13350 \begin_layout Plain Layout
13356 produces various bullets at the different levels.
13357 It is also hardcoded.
13360 \begin_layout Description
13361 \begin_inset Flex Code
13364 \begin_layout Plain Layout
13370 should be used only with
13371 \begin_inset Flex Code
13374 \begin_layout Plain Layout
13375 LatexType BibEnvironment
13384 \begin_layout Description
13385 \begin_inset Flex Code
13388 \begin_layout Plain Layout
13394 Note that this will completely override any prior
13395 \begin_inset Flex Code
13398 \begin_layout Plain Layout
13404 declaration for this style.
13406 \begin_inset Quotes eld
13410 \begin_inset Flex Code
13413 \begin_layout Plain Layout
13420 \begin_inset Quotes erd
13425 \begin_inset CommandInset ref
13427 reference "subsec:I18n"
13431 for details on its use.
13434 \begin_layout Description
13435 \begin_inset Flex Code
13438 \begin_layout Plain Layout
13445 \begin_inset Flex Code
13448 \begin_layout Plain Layout
13454 ] The name of the corresponding \SpecialChar LaTeX
13456 Either the environment or command name.
13459 \begin_layout Description
13460 \begin_inset Flex Code
13463 \begin_layout Plain Layout
13470 \begin_inset Flex Code
13473 \begin_layout Plain Layout
13479 ] An optional parameter for the corresponding
13480 \begin_inset Flex Code
13483 \begin_layout Plain Layout
13490 This parameter cannot be changed from within \SpecialChar LyX
13492 \begin_inset Flex Code
13495 \begin_layout Plain Layout
13501 for customizable parameters).
13502 This will be output as is after all \SpecialChar LaTeX
13504 \begin_inset Flex Code
13507 \begin_layout Plain Layout
13516 \begin_layout Description
13517 \begin_inset Flex Code
13520 \begin_layout Plain Layout
13527 \begin_inset Flex Code
13530 \begin_layout Plain Layout
13535 , Command, Environment, Item_Environment,
13536 \begin_inset Newline newline
13539 List_Environment, Bib_Environment
13544 ] How the style should be translated into \SpecialChar LaTeX
13549 \begin_layout Plain Layout
13550 \begin_inset Flex Code
13553 \begin_layout Plain Layout
13559 is perhaps a bit misleading, since these rules apply to SGML classes, too.
13560 Visit the SGML class files for specific examples.
13569 \begin_layout Description
13570 \begin_inset Flex Code
13573 \begin_layout Plain Layout
13579 means nothing special.
13582 \begin_layout Description
13583 \begin_inset Flex Code
13586 \begin_layout Plain Layout
13593 \begin_inset Flex Code
13596 \begin_layout Plain Layout
13603 {\SpecialChar ldots
13612 \begin_layout Description
13613 \begin_inset Flex Code
13616 \begin_layout Plain Layout
13623 \begin_inset Flex Code
13626 \begin_layout Plain Layout
13633 }\SpecialChar ldots
13649 \begin_layout Description
13650 \begin_inset Flex Code
13653 \begin_layout Plain Layout
13660 \begin_inset Flex Code
13663 \begin_layout Plain Layout
13670 \begin_inset Flex Code
13673 \begin_layout Plain Layout
13681 is generated for each paragraph of this environment.
13685 \begin_layout Description
13686 \begin_inset Flex Code
13689 \begin_layout Plain Layout
13696 \begin_inset Flex Code
13699 \begin_layout Plain Layout
13706 \begin_inset Newline newline
13710 \begin_inset Flex Code
13713 \begin_layout Plain Layout
13719 is passed as an argument to the environment.
13720 \begin_inset Newline newline
13724 \begin_inset Flex Code
13727 \begin_layout Plain Layout
13733 can be defined in the
13734 \begin_inset Flex Noun
13737 \begin_layout Plain Layout
13738 Edit\SpecialChar menuseparator
13740 \begin_inset space ~
13751 \begin_layout Description
13752 \begin_inset Flex Code
13755 \begin_layout Plain Layout
13762 \begin_inset Flex Code
13765 \begin_layout Plain Layout
13771 but adds the necessary mandatory argument (the longest label) to the begin
13772 statement of the bibliography environment:
13773 \begin_inset Newline newline
13777 \begin_inset Flex Code
13780 \begin_layout Plain Layout
13783 begin{thebibliography}{99}
13789 It is therefore only useful for bibliography environments.
13790 The default longest label
13791 \begin_inset Quotes eld
13795 \begin_inset Quotes erd
13798 can be changed by the user in the paragraph settings of a bibliography
13802 \begin_layout Standard
13803 Putting the last few things together, the \SpecialChar LaTeX
13804 output will be either:
13807 \begin_layout LyX-Code
13810 LatexName[LatexParam]{\SpecialChar ldots
13814 \begin_layout Standard
13818 \begin_layout LyX-Code
13821 begin{LatexName}[LatexParam] \SpecialChar ldots
13827 \begin_layout Standard
13828 depending upon the \SpecialChar LaTeX
13833 \begin_layout Description
13834 \begin_inset Flex Code
13837 \begin_layout Plain Layout
13844 \begin_inset Flex Code
13847 \begin_layout Plain Layout
13853 ] A string that is put at the beginning of the style content.
13854 A line break in the output can be indicated by
13855 \begin_inset Flex Code
13858 \begin_layout Plain Layout
13867 \begin_layout Description
13868 \begin_inset Flex Code
13871 \begin_layout Plain Layout
13878 \begin_inset Flex Code
13881 \begin_layout Plain Layout
13887 ] If you put styles into environments, the different
13888 \begin_inset Flex Code
13891 \begin_layout Plain Layout
13897 are not simply added, but added with a factor
13898 \begin_inset Formula $\frac{4}{\mathrm{depth}+4}$
13902 Note that this parameter is also used when
13903 \begin_inset Flex Code
13906 \begin_layout Plain Layout
13913 \begin_inset Flex Code
13916 \begin_layout Plain Layout
13923 \begin_inset Flex Code
13926 \begin_layout Plain Layout
13933 Then it is added to the manual or dynamic margin.
13934 \begin_inset Newline newline
13938 \begin_inset Quotes eld
13942 \begin_inset Flex Code
13945 \begin_layout Plain Layout
13952 \begin_inset Quotes erd
13955 means that the paragraph is indented with the width of
13956 \begin_inset Quotes eld
13960 \begin_inset Flex Code
13963 \begin_layout Plain Layout
13970 \begin_inset Quotes erd
13973 in the normal font.
13974 You can get a negative width by prefixing the string with
13975 \begin_inset Quotes eld
13979 \begin_inset Flex Code
13982 \begin_layout Plain Layout
13989 \begin_inset Quotes erd
13993 This way was chosen so that the look is the same with each used screen
13997 \begin_layout Description
13998 \begin_inset Flex Code
14001 \begin_layout Plain Layout
14008 \begin_inset Flex Code
14011 \begin_layout Plain Layout
14016 , Manual, Dynamic, First_Dynamic, Right_Address_Box
14022 \begin_inset Newline newline
14025 The kind of margin that the style has on the left side.
14029 \begin_layout Description
14030 \begin_inset Flex Code
14033 \begin_layout Plain Layout
14039 just means a fixed margin.
14042 \begin_layout Description
14043 \begin_inset Flex Code
14046 \begin_layout Plain Layout
14052 means that the left margin depends on the string entered in the
14053 \begin_inset Flex Noun
14056 \begin_layout Plain Layout
14057 Edit\SpecialChar menuseparator
14059 \begin_inset space ~
14068 This is used to typeset nice lists without tabulators.
14071 \begin_layout Description
14072 \begin_inset Flex Code
14075 \begin_layout Plain Layout
14081 means that the margin depends on the size of the label.
14082 This is used for automatic enumerated headlines.
14083 It is obvious that the headline
14084 \begin_inset Quotes eld
14087 5.4.3.2.1 Very long headline
14088 \begin_inset Quotes erd
14091 must have a wider left margin (as wide as
14092 \begin_inset Quotes eld
14096 \begin_inset Quotes erd
14099 plus the space) than
14100 \begin_inset Quotes eld
14103 3.2 Very long headline
14104 \begin_inset Quotes erd
14108 \begin_inset Quotes eld
14112 \begin_inset Quotes erd
14115 are not able to do this.
14118 \begin_layout Description
14119 \begin_inset Flex Code
14122 \begin_layout Plain Layout
14128 is similar, but only the very first row of the paragraph is dynamic, while
14129 the others are static; this is used, for example, for descriptions.
14132 \begin_layout Description
14133 \begin_inset Flex Code
14136 \begin_layout Plain Layout
14142 means the margin is chosen in a way that the longest row of this paragraph
14143 fits to the right margin.
14144 This is used to typeset an address on the right edge of the page.
14148 \begin_layout Description
14149 \begin_inset Flex Code
14152 \begin_layout Plain Layout
14159 \begin_inset Flex Code
14162 \begin_layout Plain Layout
14171 \begin_inset space \thinspace{}
14175 \begin_inset Flex Code
14178 \begin_layout Plain Layout
14184 ] Whether fragile commands in this style should be
14185 \begin_inset Flex Code
14188 \begin_layout Plain Layout
14201 whether this command should itself be protected.)
14204 \begin_layout Description
14205 \begin_inset Flex Code
14208 \begin_layout Plain Layout
14215 \begin_inset Flex Code
14218 \begin_layout Plain Layout
14225 \begin_inset space \thinspace{}
14229 \begin_inset Flex Code
14232 \begin_layout Plain Layout
14240 ] Whether newlines are translated into \SpecialChar LaTeX
14242 \begin_inset Flex Code
14245 \begin_layout Plain Layout
14256 The translation can be switched off to allow more comfortable \SpecialChar LaTeX
14258 inside \SpecialChar LyX
14262 \begin_layout Description
14263 \begin_inset Flex Code
14266 \begin_layout Plain Layout
14273 \begin_inset Flex Code
14276 \begin_layout Plain Layout
14285 \begin_inset space \thinspace{}
14289 \begin_inset Flex Code
14292 \begin_layout Plain Layout
14298 ] If set to true, and if
14299 \begin_inset Flex Code
14302 \begin_layout Plain Layout
14309 \begin_inset Flex Code
14312 \begin_layout Plain Layout
14318 ) paragraphs are being indented, then the indentation of such a paragraph
14319 following one of this type will be suppressed.
14320 (So this will not affect the display of non-default paragraphs.)
14323 \begin_layout Description
14324 \begin_inset Flex Code
14327 \begin_layout Plain Layout
14334 \begin_inset Flex Code
14337 \begin_layout Plain Layout
14343 ] Name of a style that has replaced this style.
14344 This is used to rename a style, while keeping backward compatibility.
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 \begin_inset space \thinspace{}
14372 \begin_inset Flex Code
14375 \begin_layout Plain Layout
14381 ] Determines whether consecutive pragraphs of the same type are treated
14382 as belonging together.
14383 This has the effect that the
14384 \begin_inset Flex Code
14387 \begin_layout Plain Layout
14393 is only printed once before such a group.
14394 By default, this is true for
14395 \begin_inset Flex Code
14398 \begin_layout Plain Layout
14405 \begin_inset Flex Code
14408 \begin_layout Plain Layout
14415 \begin_inset Flex Code
14418 \begin_layout Plain Layout
14424 and false for all other types.
14427 \begin_layout Description
14428 \begin_inset Flex Code
14431 \begin_layout Plain Layout
14438 \begin_inset Flex Code
14441 \begin_layout Plain Layout
14450 \begin_inset space \thinspace{}
14454 \begin_inset Flex Code
14457 \begin_layout Plain Layout
14463 ] Indicates that paragraphs will not be separated by an empty line in \SpecialChar LaTeX
14465 but only by a line break; together with
14466 \begin_inset Flex Code
14469 \begin_layout Plain Layout
14475 , this allows to emulate a plain text editor (like the ERT inset).
14478 \begin_layout Description
14479 \begin_inset Flex Code
14482 \begin_layout Plain Layout
14489 \begin_inset Flex Code
14492 \begin_layout Plain Layout
14498 ] The indent of the very first line of a paragraph.
14500 \begin_inset Newline newline
14504 \begin_inset Flex Code
14507 \begin_layout Plain Layout
14513 will be fixed for a certain style.
14514 The exception is the default style, since the indentation for these paragraphs
14515 can be prohibited with
14516 \begin_inset Flex Code
14519 \begin_layout Plain Layout
14527 \begin_inset Flex Code
14530 \begin_layout Plain Layout
14536 style paragraphs inside environments use the
14537 \begin_inset Flex Code
14540 \begin_layout Plain Layout
14546 of the environment, not their native one.
14548 \begin_inset Flex Code
14551 \begin_layout Plain Layout
14557 paragraphs inside an enumeration are not indented.
14560 \begin_layout Description
14561 \begin_inset Flex Code
14564 \begin_layout Plain Layout
14571 \begin_inset Flex Code
14574 \begin_layout Plain Layout
14580 ] The vertical space between two paragraphs of this style.
14583 \begin_layout Description
14584 \begin_inset Flex Code
14587 \begin_layout Plain Layout
14594 \begin_inset Flex Code
14597 \begin_layout Plain Layout
14604 allows the user to choose either
14605 \begin_inset Quotes eld
14609 \begin_inset Quotes erd
14613 \begin_inset Quotes eld
14617 \begin_inset Quotes erd
14620 to separate paragraphs.
14622 \begin_inset Quotes eld
14626 \begin_inset Quotes erd
14630 \begin_inset Flex Code
14633 \begin_layout Plain Layout
14641 \begin_inset Quotes eld
14645 \begin_inset Quotes erd
14649 \begin_inset Flex Code
14652 \begin_layout Plain Layout
14658 is ignored and all paragraphs are separated by the
14659 \begin_inset Flex Code
14662 \begin_layout Plain Layout
14669 The vertical space is calculated with
14670 \begin_inset Flex Code
14673 \begin_layout Plain Layout
14675 \begin_inset space ~
14684 \begin_inset Flex Code
14687 \begin_layout Plain Layout
14693 is the height of a row with the normal font.
14694 This way, the look stays the same with different screen fonts.
14697 \begin_layout Description
14698 \begin_inset Flex Code
14701 \begin_layout Plain Layout
14708 \begin_inset Flex Code
14711 \begin_layout Plain Layout
14720 \begin_inset space \thinspace{}
14724 \begin_inset Flex Code
14727 \begin_layout Plain Layout
14733 ] Whether the contents of this paragraph should be output in raw form, meaning
14734 without special translations that \SpecialChar LaTeX
14738 \begin_layout Description
14739 \begin_inset Flex Code
14742 \begin_layout Plain Layout
14749 \begin_inset Flex Code
14752 \begin_layout Plain Layout
14762 Defines individual characters that should be output in raw form, meaning
14763 without special translations that \SpecialChar LaTeX
14767 \begin_layout Description
14768 \begin_inset Flex Code
14771 \begin_layout Plain Layout
14777 Information to be included in the \SpecialChar LaTeX
14778 preamble when this style is used.
14779 Used to define macros, load packages, etc., required by this particular
14782 \begin_inset Quotes eld
14786 \begin_inset Flex Code
14789 \begin_layout Plain Layout
14796 \begin_inset Quotes erd
14802 \begin_layout Description
14803 \begin_inset Flex Code
14806 \begin_layout Plain Layout
14813 \begin_inset Flex Code
14816 \begin_layout Plain Layout
14822 ] The prefix to use when creating labels referring to paragraphs of this
14824 This allows the use of formatted references.
14827 \begin_layout Description
14828 \begin_inset Flex Code
14831 \begin_layout Plain Layout
14838 \begin_inset Flex Code
14841 \begin_layout Plain Layout
14847 ] Whether the style requires the feature
14848 \begin_inset Flex Code
14851 \begin_layout Plain Layout
14858 \begin_inset CommandInset ref
14860 reference "chap:List-of-functions"
14864 for the list of features).
14865 If you require a package with specific options, you can additionally use
14867 \begin_inset Flex Code
14870 \begin_layout Plain Layout
14876 as a general text class parameter (see
14877 \begin_inset CommandInset ref
14879 reference "subsec:General-text-class"
14886 \begin_layout Description
14887 \begin_inset Flex Code
14890 \begin_layout Plain Layout
14897 \begin_inset Flex Code
14900 \begin_layout Plain Layout
14909 \begin_inset Flex Code
14912 \begin_layout Plain Layout
14918 ] Resets the \SpecialChar LaTeX
14919 arguments of this style (as defined via the
14920 \begin_inset Flex Code
14923 \begin_layout Plain Layout
14930 This is useful if you have copied a style via
14931 \begin_inset Flex Code
14934 \begin_layout Plain Layout
14940 , but you do not want to inherit its (required and optional) arguments.
14941 \change_inserted 2089657418 1476488475
14945 \begin_layout Description
14947 \change_inserted 2089657418 1476488475
14948 \begin_inset Flex Code
14951 \begin_layout Plain Layout
14953 \change_inserted 2089657418 1476488475
14960 \begin_inset Flex Code
14963 \begin_layout Plain Layout
14965 \change_inserted 2089657418 1476488475
14974 \begin_inset Flex Code
14977 \begin_layout Plain Layout
14979 \change_inserted 2089657418 1476488475
14985 ] Resumes a counter that is usually reset at each new sequence of layouts.
14986 This is currently only useful when
14987 \begin_inset Flex Code
14990 \begin_layout Plain Layout
14992 \change_inserted 2089657418 1476488475
14999 \begin_inset Flex Code
15002 \begin_layout Plain Layout
15004 \change_inserted 2089657418 1476488475
15015 \begin_layout Description
15016 \begin_inset Flex Code
15019 \begin_layout Plain Layout
15026 \begin_inset Flex Code
15029 \begin_layout Plain Layout
15035 ] A string that is put at the end of the layout content.
15036 A line break in the output can be indicated by
15037 \begin_inset Flex Code
15040 \begin_layout Plain Layout
15049 \begin_layout Description
15050 \begin_inset Flex Code
15053 \begin_layout Plain Layout
15060 \begin_inset Flex Code
15063 \begin_layout Plain Layout
15070 \begin_inset Flex Code
15073 \begin_layout Plain Layout
15082 \begin_layout Description
15083 \begin_inset Flex Code
15086 \begin_layout Plain Layout
15093 \begin_inset Flex Code
15096 \begin_layout Plain Layout
15105 \begin_inset Flex Code
15108 \begin_layout Plain Layout
15115 \begin_inset Flex Code
15118 \begin_layout Plain Layout
15125 \begin_inset Flex Code
15128 \begin_layout Plain Layout
15130 \begin_inset space ~
15138 ] This defines what the default spacing should be in the style.
15140 \begin_inset Flex Code
15143 \begin_layout Plain Layout
15150 \begin_inset Flex Code
15153 \begin_layout Plain Layout
15160 \begin_inset Flex Code
15163 \begin_layout Plain Layout
15169 correspond respectively to a multiplier value of 1, 1.25 and 1.667.
15170 If you specify the argument
15171 \begin_inset Flex Code
15174 \begin_layout Plain Layout
15180 , then you must also provide a value argument which will be the actual multiplie
15182 Note that, contrary to other parameters,
15183 \begin_inset Flex Code
15186 \begin_layout Plain Layout
15192 implies the generation of specific \SpecialChar LaTeX
15193 code, using the \SpecialChar LaTeX
15197 \begin_inset Flex Code
15200 \begin_layout Plain Layout
15209 \begin_layout Description
15210 \begin_inset Flex Code
15213 \begin_layout Plain Layout
15220 \begin_inset Flex Code
15223 \begin_layout Plain Layout
15230 \begin_inset space \thinspace{}
15234 \begin_inset Flex Code
15237 \begin_layout Plain Layout
15245 ] Allow spell-checking paragraphs of this style.
15247 \change_inserted 2089657418 1476488264
15251 \begin_layout Description
15253 \change_inserted 2089657418 1476488264
15254 \begin_inset Flex Code
15257 \begin_layout Plain Layout
15259 \change_inserted 2089657418 1476488264
15266 \begin_inset Flex Code
15269 \begin_layout Plain Layout
15271 \change_inserted 2089657418 1476488264
15280 \begin_inset Flex Code
15283 \begin_layout Plain Layout
15285 \change_inserted 2089657418 1476488264
15291 ] Steps the master counter of a given counter at the beginning of a new
15292 sequence of layouts.
15293 This is currently only useful when
15294 \begin_inset Flex Code
15297 \begin_layout Plain Layout
15299 \change_inserted 2089657418 1476488264
15306 \begin_inset Flex Code
15309 \begin_layout Plain Layout
15311 \change_inserted 2089657418 1476488264
15322 \begin_layout Description
15323 \begin_inset Flex Code
15326 \begin_layout Plain Layout
15332 The font used for the text body .
15334 \begin_inset CommandInset ref
15336 reference "subsec:Font-description"
15343 \begin_layout Description
15344 \begin_inset Flex Code
15347 \begin_layout Plain Layout
15356 \begin_inset Flex Code
15359 \begin_layout Plain Layout
15369 The level of the style in the table of contents.
15370 This is used for automatic numbering of section headings.
15373 \begin_layout Description
15374 \begin_inset Flex Code
15377 \begin_layout Plain Layout
15386 \begin_inset Flex Code
15389 \begin_layout Plain Layout
15400 \begin_inset Flex Code
15403 \begin_layout Plain Layout
15410 \begin_inset Flex Code
15413 \begin_layout Plain Layout
15419 ] This tag determines whether the first line indentation of this paragraph
15420 can be toggled via the Paragraph settings dialog.
15424 \begin_inset Flex Code
15427 \begin_layout Plain Layout
15437 is set, indentation can be toggled if the document settings use
15438 \begin_inset Quotes eld
15442 \begin_inset Quotes erd
15445 paragraph style, with
15446 \begin_inset Flex Code
15449 \begin_layout Plain Layout
15455 , indentation can always be toggled, notwithstanding the document settings,
15457 \begin_inset Flex Code
15460 \begin_layout Plain Layout
15466 , indentation can never be toggled.
15469 \begin_layout Description
15470 \begin_inset Flex Code
15473 \begin_layout Plain Layout
15480 \begin_inset Flex Code
15483 \begin_layout Plain Layout
15489 ] The vertical space with which the very first of a chain of paragraphs
15490 with this style is separated from the previous paragraph.
15491 If the previous paragraph has another style, the separations are not simply
15492 added, but the maximum is taken.
15495 \begin_layout Subsection
15496 \begin_inset CommandInset label
15502 Internationalization of Paragraph Styles
15505 \begin_layout Standard
15507 has long supported internationalization of layout information, but, until
15508 version 2.0, this applied only to the user interface and not to, say, PDF
15510 Thus, French authors were forced to resort to ugly hacks if they wanted
15515 1' instead of `Theorem 1'.
15516 Thanks to Georg Baum, that is no longer the case.
15519 \begin_layout Standard
15521 \begin_inset Flex Code
15524 \begin_layout Plain Layout
15530 defines text that is to appear in the typeset document, it may use
15531 \begin_inset Flex Code
15534 \begin_layout Plain Layout
15541 \begin_inset Flex Code
15544 \begin_layout Plain Layout
15550 to support non-English and even multi-language documents correctly.
15551 The following excerpt (from the
15552 \begin_inset Flex Code
15555 \begin_layout Plain Layout
15561 file) shows how this works:
15564 \begin_layout LyX-Code
15569 \begin_layout LyX-Code
15572 theoremstyle{remark}
15575 \begin_layout LyX-Code
15578 newtheorem{claim}[thm]{
15585 \begin_layout LyX-Code
15589 \begin_layout LyX-Code
15593 \begin_layout LyX-Code
15598 claimname}{_(Claim)}
15601 \begin_layout LyX-Code
15605 \begin_layout LyX-Code
15609 \begin_layout LyX-Code
15618 claimname}{_(Claim)}}
15621 \begin_layout LyX-Code
15626 \begin_layout Standard
15627 In principle, any legal \SpecialChar LaTeX
15629 \begin_inset Flex Code
15632 \begin_layout Plain Layout
15639 \begin_inset Flex Code
15642 \begin_layout Plain Layout
15648 tags, but in practice they will typically look as they do here.
15649 The key to correct translation of the typeset text is the definition of
15650 the \SpecialChar LaTeX
15652 \begin_inset Flex Code
15655 \begin_layout Plain Layout
15664 \begin_inset Flex Code
15667 \begin_layout Plain Layout
15679 \begin_layout Standard
15681 \begin_inset Flex Code
15684 \begin_layout Plain Layout
15690 tag provides for internationalization based upon the overall language of
15692 The contents of the tag will be included in the preamble, just as with
15694 \begin_inset Flex Code
15697 \begin_layout Plain Layout
15704 What makes it special is the use of the
15705 \begin_inset Quotes eld
15709 \begin_inset Quotes erd
15713 \begin_inset Flex Code
15716 \begin_layout Plain Layout
15722 , which will be replaced, when \SpecialChar LyX
15723 produces \SpecialChar LaTeX
15724 output, with the translation of
15725 its argument into the document language.
15728 \begin_layout Standard
15730 \begin_inset Flex Code
15733 \begin_layout Plain Layout
15739 tag is more complex, since it is meant to provide support for multi-language
15740 documents and so offers an interface to the
15741 \begin_inset Flex Code
15744 \begin_layout Plain Layout
15751 Its contents will be added to the preamble once for each language that
15752 appears in the document.
15753 In this case, the argument to
15754 \begin_inset Flex Code
15757 \begin_layout Plain Layout
15763 will be replaced with its translation into the language in question; the
15765 \begin_inset Flex Code
15768 \begin_layout Plain Layout
15774 is replaced by the language name (as used by the babel package).
15777 \begin_layout Standard
15778 A German document that also included a French section would thus have the
15779 following in the preamble:
15782 \begin_layout LyX-Code
15791 claimname}{Affirmation}}
15792 \begin_inset Newline newline
15803 claimname}{Behauptung}}
15804 \begin_inset Newline newline
15811 claimname}{Behauptung}
15814 \begin_layout Standard
15817 \begin_inset Flex Code
15820 \begin_layout Plain Layout
15826 will then conspire to produce the correct text in the output.
15829 \begin_layout Standard
15830 One important point to note here is that the translations are provided by
15832 itself, through the file
15833 \begin_inset Flex Code
15836 \begin_layout Plain Layout
15843 This means, in effect, that
15844 \begin_inset Flex Code
15847 \begin_layout Plain Layout
15854 \begin_inset Flex Code
15857 \begin_layout Plain Layout
15863 are really only of use in layout files that are provided with \SpecialChar LyX
15865 entered in user-created layout files will not be seen by \SpecialChar LyX
15866 's internationalizatio
15867 n routines unless the
15868 \begin_inset Flex Code
15871 \begin_layout Plain Layout
15877 file is modified accordingly.
15878 That said, however, any layout created with the intention that it will
15879 be included with \SpecialChar LyX
15880 should use these tags where appropriate.
15881 Please note that the paragraph style translations provided by \SpecialChar LyX
15883 change with a minor update (e.
15884 \begin_inset space \thinspace{}
15888 \begin_inset space \space{}
15891 from version 2.1.x to 2.1.y).
15892 It is however quite likely that a major update (e.
15893 \begin_inset space \thinspace{}
15897 \begin_inset space \space{}
15900 from 2.0.x to 2.1.y) will introduce new translations or corrections.
15903 \begin_layout Subsection
15905 \begin_inset CommandInset label
15907 name "subsec:Floats"
15914 \begin_layout Standard
15915 It is necessary to define the floats (
15916 \begin_inset Flex Noun
15919 \begin_layout Plain Layout
15926 \begin_inset Flex Noun
15929 \begin_layout Plain Layout
15935 , \SpecialChar ldots
15936 ) in the text class itself.
15937 Standard floats are included in the file
15938 \begin_inset Flex Code
15941 \begin_layout Plain Layout
15947 , so you may have to do no more than add
15950 \begin_layout LyX-Code
15951 Input stdfloats.inc
15954 \begin_layout Standard
15955 to your layout file.
15956 If you want to implement a text class that proposes some other float types
15957 (like the AGU class bundled with \SpecialChar LyX
15958 ), the information below will hopefully
15962 \begin_layout Description
15963 \begin_inset Flex Code
15966 \begin_layout Plain Layout
15973 \begin_inset Flex Code
15976 \begin_layout Plain Layout
15982 =!htbpH] Allowed placement options for this float type.
15983 The value is a string of placement characters.
15984 Possible characters include:
15989 \begin_inset Quotes eld
15993 \begin_inset Quotes erd
16001 \begin_inset Quotes eld
16005 \begin_inset Quotes erd
16013 \begin_inset Quotes eld
16017 \begin_inset Quotes erd
16025 \begin_inset Quotes eld
16029 \begin_inset Quotes erd
16037 \begin_inset Quotes eld
16041 \begin_inset Quotes erd
16049 \begin_inset Quotes eld
16053 \begin_inset Quotes erd
16057 The order of the characters in the string does not matter.
16058 If no placement options are allowed, use the string
16065 \begin_layout Description
16066 \begin_inset Flex Code
16069 \begin_layout Plain Layout
16076 \begin_inset Flex Code
16079 \begin_layout Plain Layout
16088 \begin_inset space \thinspace{}
16094 \begin_inset Flex Code
16097 \begin_layout Plain Layout
16107 ] Defines whether the float allows to be rotated via the \SpecialChar LaTeX
16114 \begin_inset Flex Code
16117 \begin_layout Plain Layout
16123 if the float does not support this feature.
16126 \begin_layout Description
16127 \begin_inset Flex Code
16130 \begin_layout Plain Layout
16137 \begin_inset Flex Code
16140 \begin_layout Plain Layout
16149 \begin_inset space \thinspace{}
16155 \begin_inset Flex Code
16158 \begin_layout Plain Layout
16168 ] Defines whether the float has a starred variant that spans columns in
16169 a two column paragraph.
16171 \begin_inset Flex Code
16174 \begin_layout Plain Layout
16180 if the float does not support this feature.
16183 \begin_layout Description
16184 \begin_inset Flex Code
16187 \begin_layout Plain Layout
16194 \begin_inset Flex Code
16197 \begin_layout Plain Layout
16204 \begin_inset Quotes erd
16208 \begin_inset Quotes erd
16211 ] The file name extension of an auxiliary file for the list of figures (or
16214 writes the captions to this file.
16217 \begin_layout Description
16218 \begin_inset Flex Code
16221 \begin_layout Plain Layout
16228 \begin_inset Flex Code
16231 \begin_layout Plain Layout
16238 \begin_inset Quotes erd
16242 \begin_inset Quotes erd
16245 ] The string that will be used in the menus and also for the caption.
16246 This is translated to the current language if babel is used.
16249 \begin_layout Description
16250 \begin_inset Flex Code
16253 \begin_layout Plain Layout
16259 These tags control the XHTML output.
16261 \begin_inset CommandInset ref
16263 reference "sec:Tags-for-XHTML"
16270 \begin_layout Description
16271 \begin_inset Flex Code
16274 \begin_layout Plain Layout
16283 \begin_inset Flex Code
16286 \begin_layout Plain Layout
16295 \begin_inset space \thinspace{}
16299 \begin_inset Flex Code
16302 \begin_layout Plain Layout
16308 ] Indicates whether the float is already defined in the document class or
16309 if instead the \SpecialChar LaTeX
16311 \begin_inset Flex Code
16314 \begin_layout Plain Layout
16320 needs to be loaded to define it on-the-fly.
16322 \begin_inset Flex Code
16325 \begin_layout Plain Layout
16332 \begin_inset Flex Code
16335 \begin_layout Plain Layout
16342 It should be set to
16343 \begin_inset Flex Code
16346 \begin_layout Plain Layout
16352 if the float is already defined by the \SpecialChar LaTeX
16356 \begin_layout Description
16357 \begin_inset Flex Code
16360 \begin_layout Plain Layout
16367 \begin_inset Flex Code
16370 \begin_layout Plain Layout
16377 \begin_inset Quotes erd
16381 \begin_inset Quotes erd
16384 ] The command used to generate a list of floats of this type; the leading
16393 \begin_inset Flex Code
16396 \begin_layout Plain Layout
16402 is false, since there is no standard way to generate this command.
16404 \begin_inset Flex Code
16407 \begin_layout Plain Layout
16413 is true, since in that case there is a standard way to define the command.
16416 \begin_layout Description
16417 \begin_inset Flex Code
16420 \begin_layout Plain Layout
16427 \begin_inset Flex Code
16430 \begin_layout Plain Layout
16437 \begin_inset Quotes erd
16441 \begin_inset Quotes erd
16444 ] A title for a list of floats of this kind (list of figures, tables, or
16446 It is used for the screen label within \SpecialChar LyX
16447 , it is used by \SpecialChar LaTeX
16449 it is used as the title in the XHTML output.
16450 It will be translated to the document language.
16453 \begin_layout Description
16454 \begin_inset Flex Code
16457 \begin_layout Plain Layout
16464 \begin_inset Flex Code
16467 \begin_layout Plain Layout
16474 \begin_inset Quotes erd
16478 \begin_inset Quotes erd
16481 ] This (optional) argument determines whether floats of this class will
16482 be numbered within some sectional unit of the document.
16484 \begin_inset Flex Code
16487 \begin_layout Plain Layout
16494 \begin_inset Quotes eld
16498 \begin_inset Flex Code
16501 \begin_layout Plain Layout
16508 \begin_inset Quotes erd
16511 , the floats will be numbered within chapters.
16515 \begin_layout Description
16516 \begin_inset Flex Code
16519 \begin_layout Plain Layout
16526 \begin_inset Flex Code
16529 \begin_layout Plain Layout
16536 \begin_inset Quotes erd
16540 \begin_inset Quotes erd
16543 ] The default placement for the given class of floats.
16544 The string should be as in standard \SpecialChar LaTeX
16546 \begin_inset Flex Code
16549 \begin_layout Plain Layout
16556 \begin_inset Flex Code
16559 \begin_layout Plain Layout
16566 \begin_inset Flex Code
16569 \begin_layout Plain Layout
16576 \begin_inset Flex Code
16579 \begin_layout Plain Layout
16585 for top, bottom, page, and here, respectively.
16589 \begin_layout Plain Layout
16590 Note that the order of these letters in the string is irrelevant, like in
16597 On top of that there is a new type,
16598 \begin_inset Flex Code
16601 \begin_layout Plain Layout
16607 , which does not really correspond to a float, since it means: put it
16608 \begin_inset Quotes eld
16612 \begin_inset Quotes erd
16616 Note however that the
16617 \begin_inset Flex Code
16620 \begin_layout Plain Layout
16626 specifier is special and, because of implementation details, cannot be
16627 used in non-built in float types.
16628 If you do not understand what this means, just use
16629 \begin_inset Quotes eld
16633 \begin_inset Flex Code
16636 \begin_layout Plain Layout
16643 \begin_inset Quotes erd
16649 \begin_layout Description
16650 \begin_inset Flex Code
16653 \begin_layout Plain Layout
16660 \begin_inset Flex Code
16663 \begin_layout Plain Layout
16669 ] The prefix to use when creating labels referring to floats of this type.
16670 This allows the use of formatted references.
16671 Note that you can remove any
16672 \begin_inset Flex Code
16675 \begin_layout Plain Layout
16681 set by a copied style by using the special value
16682 \begin_inset Quotes eld
16686 \begin_inset Quotes erd
16689 , which must be all caps.
16692 \begin_layout Description
16693 \begin_inset Flex Code
16696 \begin_layout Plain Layout
16703 \begin_inset Flex Code
16706 \begin_layout Plain Layout
16713 \begin_inset Quotes erd
16717 \begin_inset Quotes erd
16720 ] The style used when defining the float using
16721 \begin_inset Flex Code
16724 \begin_layout Plain Layout
16735 \begin_layout Description
16736 \begin_inset Flex Code
16739 \begin_layout Plain Layout
16746 \begin_inset Flex Code
16749 \begin_layout Plain Layout
16756 \begin_inset Quotes erd
16760 \begin_inset Quotes erd
16764 \begin_inset Quotes eld
16768 \begin_inset Quotes erd
16771 of the new class of floats, like program or algorithm.
16772 After the appropriate
16773 \begin_inset Flex Code
16776 \begin_layout Plain Layout
16785 \begin_inset Flex Code
16788 \begin_layout Plain Layout
16797 \begin_inset Flex Code
16800 \begin_layout Plain Layout
16811 \begin_layout Description
16812 \begin_inset Flex Code
16815 \begin_layout Plain Layout
16822 \begin_inset Flex Code
16825 \begin_layout Plain Layout
16832 \begin_inset space \thinspace{}
16836 \begin_inset Flex Code
16839 \begin_layout Plain Layout
16847 ] Specifies whether this float is defined using the \SpecialChar LaTeX
16849 \begin_inset Flex Code
16852 \begin_layout Plain Layout
16858 , either by the class file, another package or on-the-fly by \SpecialChar LyX
16862 \begin_layout Standard
16863 Note that defining a float with type
16864 \begin_inset Flex Code
16867 \begin_layout Plain Layout
16875 automatically defines the corresponding counter with name
16876 \begin_inset Flex Code
16879 \begin_layout Plain Layout
16890 \begin_layout Subsection
16891 Flex insets and InsetLayout
16892 \begin_inset CommandInset label
16894 name "subsec:Flex-insets-and"
16901 \begin_layout Standard
16902 Flex insets come in three different kinds:
16905 \begin_layout Itemize
16907 \begin_inset Flex Code
16910 \begin_layout Plain Layout
16916 ): These define semantic markup corresponding to such \SpecialChar LaTeX
16918 \begin_inset Flex Code
16921 \begin_layout Plain Layout
16930 \begin_inset Flex Code
16933 \begin_layout Plain Layout
16944 \begin_layout Itemize
16946 \begin_inset Flex Code
16949 \begin_layout Plain Layout
16955 ): These can be used to define custom collapsible insets, similar to \SpecialChar TeX
16957 footnote, and the like.
16958 An obvious example is an endnote inset, which is defined in the
16959 \begin_inset Flex Code
16962 \begin_layout Plain Layout
16971 \begin_layout Itemize
16973 \begin_inset Flex Code
16976 \begin_layout Plain Layout
16982 ): For use with DocBook classes.
16985 \begin_layout Standard
16986 Flex insets are defined using the
16987 \begin_inset Flex Code
16990 \begin_layout Plain Layout
16996 tag, which shall be explained in a moment.
16999 \begin_layout Standard
17001 \begin_inset Flex Code
17004 \begin_layout Plain Layout
17010 tag also serves another function: It can be used to customize the general
17011 layout of many different types of insets.
17013 \begin_inset Flex Code
17016 \begin_layout Plain Layout
17022 can be used to customize the layout parameters for footnotes, marginal
17023 notes, note insets, \SpecialChar TeX
17024 code (ERT) insets, branches, listings, indexes, boxes,
17025 tables, algorithms, URLs, and captions, as well as to define Flex insets.
17028 \begin_layout Standard
17030 \begin_inset Flex Code
17033 \begin_layout Plain Layout
17039 definition must begin with a line of the form:
17042 \begin_layout LyX-Code
17046 \begin_layout Standard
17048 \begin_inset Flex Code
17051 \begin_layout Plain Layout
17057 indicates the inset whose layout is being defined, and here there are four
17061 \begin_layout Enumerate
17062 The layout for a pre-existing inset is being modified.
17063 In this case, can be
17064 \begin_inset Flex Code
17067 \begin_layout Plain Layout
17073 any one of the following:
17074 \begin_inset Flex Code
17077 \begin_layout Plain Layout
17084 \begin_inset Flex Code
17087 \begin_layout Plain Layout
17094 \begin_inset Flex Code
17097 \begin_layout Plain Layout
17104 \begin_inset Flex Code
17107 \begin_layout Plain Layout
17114 \begin_inset Flex Code
17117 \begin_layout Plain Layout
17124 \begin_inset Flex Code
17127 \begin_layout Plain Layout
17134 \begin_inset Flex Code
17137 \begin_layout Plain Layout
17144 \begin_inset Flex Code
17147 \begin_layout Plain Layout
17154 \begin_inset Flex Code
17157 \begin_layout Plain Layout
17164 \begin_inset Flex Code
17167 \begin_layout Plain Layout
17174 \begin_inset Flex Code
17177 \begin_layout Plain Layout
17184 \begin_inset Flex Code
17187 \begin_layout Plain Layout
17194 \begin_inset Flex Code
17197 \begin_layout Plain Layout
17204 \begin_inset Flex Code
17207 \begin_layout Plain Layout
17214 \begin_inset Flex Code
17217 \begin_layout Plain Layout
17224 \begin_inset Flex Code
17227 \begin_layout Plain Layout
17234 \begin_inset Flex Code
17237 \begin_layout Plain Layout
17244 \begin_inset Flex Code
17247 \begin_layout Plain Layout
17254 \begin_inset Flex Code
17257 \begin_layout Plain Layout
17264 \begin_inset Flex Code
17267 \begin_layout Plain Layout
17276 \begin_layout Enumerate
17277 The layout for a Flex inset is being defined.
17279 \begin_inset Flex Code
17282 \begin_layout Plain Layout
17288 must be of the form
17289 \begin_inset Quotes eld
17293 \begin_inset Flex Code
17296 \begin_layout Plain Layout
17303 \begin_inset Quotes erd
17307 \begin_inset Flex Code
17310 \begin_layout Plain Layout
17316 may be be any valid identifier not used by a pre-existing Flex inset.
17317 The identifier may include spaces, but in that case the whole thing must
17318 be wrapped in quotes.
17319 Note that the definition of a flex inset
17324 \begin_inset Flex Code
17327 \begin_layout Plain Layout
17333 entry, declaring which type of inset it defines.
17336 \begin_layout Enumerate
17337 The layout for user specific branch is being defined.
17339 \begin_inset Flex Code
17342 \begin_layout Plain Layout
17348 must be of the form
17349 \begin_inset Quotes eld
17353 \begin_inset Flex Code
17356 \begin_layout Plain Layout
17363 \begin_inset Quotes erd
17367 \begin_inset Flex Code
17370 \begin_layout Plain Layout
17376 may be be any valid identifier of branch defined in user's document.
17377 The identifier may include spaces, but in that case the whole thing must
17378 be wrapped in quotes.
17379 The main purpose of this feature is to allow \SpecialChar LaTeX
17380 wrapping around specific
17381 branches as user needs.
17384 \begin_layout Enumerate
17385 The layout of a user (or class) specific caption is being defined.
17387 \begin_inset Flex Code
17390 \begin_layout Plain Layout
17396 must be of the form
17397 \begin_inset Quotes eld
17401 \begin_inset Flex Code
17404 \begin_layout Plain Layout
17411 \begin_inset Quotes erd
17415 \begin_inset Flex Code
17418 \begin_layout Plain Layout
17424 specifies the name of the caption as it appears in the menu.
17425 Have a look at the standard caption (
17426 \begin_inset Flex Code
17429 \begin_layout Plain Layout
17435 ), the specific captions of the KOMA-Script classes (
17436 \begin_inset Flex Code
17439 \begin_layout Plain Layout
17446 \begin_inset Flex Code
17449 \begin_layout Plain Layout
17458 \begin_inset space ~
17464 \begin_inset Flex Code
17467 \begin_layout Plain Layout
17473 ) for applications.
17476 \begin_layout Standard
17478 \begin_inset Flex Code
17481 \begin_layout Plain Layout
17487 definition can contain the following entries:
17490 \begin_layout Description
17492 \change_inserted 2047637253 1483963036
17493 \begin_inset Flex Code
17496 \begin_layout Plain Layout
17498 \change_inserted 2047637253 1483900123
17505 \begin_inset Flex Code
17508 \begin_layout Plain Layout
17510 \change_inserted 2047637253 1483962897
17516 =""] This inset will appear in the table of contents of the given type.
17517 An empty string disables.
17518 See also the OutlinerName and the IsTocCaption commands.
17519 This is only implemented for Flex insets.
17523 \begin_layout Description
17524 \begin_inset Flex Code
17527 \begin_layout Plain Layout
17534 \begin_inset Flex Code
17537 \begin_layout Plain Layout
17543 ] Defines argument number of a command\SpecialChar breakableslash
17544 environment associated with the current
17546 The definition must end with
17547 \begin_inset Flex Code
17550 \begin_layout Plain Layout
17558 \begin_inset CommandInset ref
17560 reference "subsec:Paragraph-Styles"
17567 \begin_layout Description
17568 \begin_inset Flex Code
17571 \begin_layout Plain Layout
17577 Preamble for changing language commands; see
17578 \begin_inset CommandInset ref
17580 reference "subsec:I18n"
17587 \begin_layout Description
17588 \begin_inset Flex Code
17591 \begin_layout Plain Layout
17598 \begin_inset Flex Code
17601 \begin_layout Plain Layout
17607 ] The color for the inset's background.
17609 \begin_inset CommandInset ref
17611 reference "chap:Names-of-colors"
17615 for a list of the available color names.
17618 \begin_layout Description
17619 \begin_inset Flex Code
17622 \begin_layout Plain Layout
17629 \begin_inset Flex Code
17632 \begin_layout Plain Layout
17641 \begin_inset space \thinspace{}
17645 \begin_inset Flex Code
17648 \begin_layout Plain Layout
17654 ] Whether to use the content of the inset as the label, when the inset is
17659 \begin_layout Description
17660 \begin_inset Flex Code
17663 \begin_layout Plain Layout
17670 \begin_inset Flex Code
17673 \begin_layout Plain Layout
17679 ] As with paragraph styles, see
17680 \begin_inset CommandInset ref
17682 reference "subsec:Paragraph-Styles"
17687 Note that you need to specify the complete type, e.
17688 \begin_inset space \thinspace{}
17692 \begin_inset space ~
17696 \begin_inset Flex Code
17699 \begin_layout Plain Layout
17700 CopyStyle Flex:<name>
17708 \begin_layout Description
17709 \begin_inset Flex Code
17712 \begin_layout Plain Layout
17719 \begin_inset Flex Code
17722 \begin_layout Plain Layout
17731 \begin_inset space \thinspace{}
17735 \begin_inset Flex Code
17738 \begin_layout Plain Layout
17744 ] Indicates whether the user may employ the Paragraph Settings dialog to
17745 customize the paragraph.
17748 \begin_layout Description
17749 \begin_inset Flex Code
17752 \begin_layout Plain Layout
17759 \begin_inset Flex Code
17762 \begin_layout Plain Layout
17769 \begin_inset Flex Code
17772 \begin_layout Plain Layout
17779 \begin_inset Flex Code
17782 \begin_layout Plain Layout
17788 , describing the rendering style used for the inset's frame and buttons.
17789 Footnotes generally use
17790 \begin_inset Flex Code
17793 \begin_layout Plain Layout
17799 , ERT insets generally
17800 \begin_inset Flex Code
17803 \begin_layout Plain Layout
17809 , and character styles
17810 \begin_inset Flex Code
17813 \begin_layout Plain Layout
17822 \begin_layout Description
17823 \begin_inset Flex Code
17826 \begin_layout Plain Layout
17833 \begin_inset Flex Code
17836 \begin_layout Plain Layout
17845 \begin_inset space \thinspace{}
17851 \begin_inset Flex Code
17854 \begin_layout Plain Layout
17863 \begin_inset Flex Code
17866 \begin_layout Plain Layout
17873 \begin_inset Flex Code
17876 \begin_layout Plain Layout
17883 Indicates whether the environment will stand on its own in the output or
17884 will appear inline with the surrounding text.
17885 If set to false, it is supposed that the \SpecialChar LaTeX
17886 environment ignores white space
17887 (including one newline character) after the
17888 \begin_inset Flex Code
17891 \begin_layout Plain Layout
17904 \begin_inset Flex Code
17907 \begin_layout Plain Layout
17923 \begin_layout Description
17924 \begin_inset Flex Code
17927 \begin_layout Plain Layout
17933 Required at the end of the
17934 \begin_inset Flex Code
17937 \begin_layout Plain Layout
17946 \begin_layout Description
17947 \begin_inset Flex Code
17950 \begin_layout Plain Layout
17956 The font used for both the text body
17962 \begin_inset CommandInset ref
17964 reference "subsec:Font-description"
17969 Note that defining this font automatically defines the
17970 \begin_inset Flex Code
17973 \begin_layout Plain Layout
17979 to the same value, so define this first and define
17980 \begin_inset Flex Code
17983 \begin_layout Plain Layout
17989 later if you want them to be different.
17992 \begin_layout Description
17993 \begin_inset Flex Code
17996 \begin_layout Plain Layout
17997 FixedWidthPreambleEncoding
18003 \begin_inset Flex Code
18006 \begin_layout Plain Layout
18015 \begin_inset space \thinspace{}
18019 \begin_inset Flex Code
18022 \begin_layout Plain Layout
18028 ] Force a fixed width encoding for the translated contents of
18029 \begin_inset Flex Code
18032 \begin_layout Plain Layout
18039 \begin_inset Flex Code
18042 \begin_layout Plain Layout
18048 code generated by this layout.
18049 This is needed for special \SpecialChar LaTeX
18054 that do not work with variable width encodings such as
18059 This setting is ignored if fully Unicode aware \SpecialChar LaTeX
18060 backends such as Xe\SpecialChar TeX
18062 Lua\SpecialChar TeX
18066 \begin_layout Description
18067 \begin_inset Flex Code
18070 \begin_layout Plain Layout
18071 ForceLocalFontSwitch
18077 \begin_inset Flex Code
18080 \begin_layout Plain Layout
18089 \begin_inset space \thinspace{}
18093 \begin_inset Flex Code
18096 \begin_layout Plain Layout
18102 ] When using babel, always use a local font switch (
18103 \begin_inset Flex Code
18106 \begin_layout Plain Layout
18114 ), never a global one (such as
18115 \begin_inset Flex Code
18118 \begin_layout Plain Layout
18129 \begin_layout Description
18130 \begin_inset Flex Code
18133 \begin_layout Plain Layout
18140 \begin_inset Flex Code
18143 \begin_layout Plain Layout
18152 \begin_inset space \thinspace{}
18156 \begin_inset Flex Code
18159 \begin_layout Plain Layout
18166 \begin_inset Quotes eld
18170 \begin_inset Quotes erd
18173 language, leading to Left-to-Right (Latin) output, e.
18174 \begin_inset space \thinspace{}
18178 \begin_inset space \space{}
18181 in \SpecialChar TeX
18186 \begin_layout Description
18187 \begin_inset Flex Code
18190 \begin_layout Plain Layout
18197 \begin_inset Flex Code
18200 \begin_layout Plain Layout
18209 \begin_inset space \thinspace{}
18213 \begin_inset Flex Code
18216 \begin_layout Plain Layout
18222 ] Force a a line break in the \SpecialChar LaTeX
18223 output before the inset starts and after
18225 This assures the inset itself is output on its own lines, for parsing purposes.
18228 \begin_layout Description
18229 \begin_inset Flex Code
18232 \begin_layout Plain Layout
18239 \begin_inset Flex Code
18242 \begin_layout Plain Layout
18251 \begin_inset space \thinspace{}
18255 \begin_inset Flex Code
18258 \begin_layout Plain Layout
18264 ] Indicates whether the
18265 \begin_inset Flex Code
18268 \begin_layout Plain Layout
18274 should be used or, instead, the user can change the paragraph style used
18279 \begin_layout Description
18280 \begin_inset Flex Code
18283 \begin_layout Plain Layout
18290 \begin_inset Flex Code
18293 \begin_layout Plain Layout
18302 \begin_inset space \thinspace{}
18306 \begin_inset Flex Code
18309 \begin_layout Plain Layout
18315 ] As with paragraph styles, see
18316 \begin_inset CommandInset ref
18318 reference "subsec:Paragraph-Styles"
18325 \begin_layout Description
18326 \begin_inset Flex Code
18329 \begin_layout Plain Layout
18335 These tags control the XHTML output.
18337 \begin_inset CommandInset ref
18339 reference "sec:Tags-for-XHTML"
18346 \begin_layout Description
18347 \begin_inset Flex Code
18350 \begin_layout Plain Layout
18357 \begin_inset Flex Code
18360 \begin_layout Plain Layout
18369 \begin_inset space \thinspace{}
18373 \begin_inset Flex Code
18376 \begin_layout Plain Layout
18382 ] Whether to include the contents of this inset in the strings generated
18383 for the `Outline' pane
18384 \change_inserted 2047637253 1483900773
18385 for all table of contents, regardless of the AddToToc setting
18388 One would not, for example, want the content of a footnote in a section
18389 header to be included in the TOC displayed in the outline, but one would
18390 normally want the content of a character style displayed.
18391 Default is false: not to include.
18392 \change_inserted 2047637253 1483900609
18396 \begin_layout Description
18398 \change_inserted 2047637253 1483901257
18399 \begin_inset Flex Code
18402 \begin_layout Plain Layout
18404 \change_inserted 2047637253 1483900725
18411 \begin_inset Flex Code
18414 \begin_layout Plain Layout
18416 \change_inserted 2047637253 1483900620
18425 \begin_inset space \thinspace{}
18429 \begin_inset Flex Code
18432 \begin_layout Plain Layout
18434 \change_inserted 2047637253 1483900620
18440 ] If this is set to 1 and AddToToc is enabled, the inset adds a summary
18441 of its contents in its item in the table of contents.
18442 Otherwise, only the label appears.
18447 \begin_layout Description
18448 \begin_inset Flex Code
18451 \begin_layout Plain Layout
18460 \begin_inset Flex Code
18463 \begin_layout Plain Layout
18472 \begin_inset space \thinspace{}
18476 \begin_inset Flex Code
18479 \begin_layout Plain Layout
18485 ] As with paragraph styles, see
18486 \begin_inset CommandInset ref
18488 reference "subsec:Paragraph-Styles"
18495 \begin_layout Description
18496 \begin_inset Flex Code
18499 \begin_layout Plain Layout
18505 The font used for the label.
18507 \begin_inset CommandInset ref
18509 reference "subsec:Font-description"
18514 Note that this definition can never appear before
18515 \begin_inset Flex Code
18518 \begin_layout Plain Layout
18524 , lest it be ineffective.
18527 \begin_layout Description
18528 \begin_inset Flex Code
18531 \begin_layout Plain Layout
18538 \begin_inset Flex Code
18541 \begin_layout Plain Layout
18548 \begin_inset Quotes erd
18552 \begin_inset Quotes erd
18555 ] What will be displayed on the button or elsewhere as the inset label.
18557 \begin_inset Flex Code
18560 \begin_layout Plain Layout
18568 \begin_inset Flex Code
18571 \begin_layout Plain Layout
18577 ) modify this label on the fly.
18580 \begin_layout Description
18581 \begin_inset Flex Code
18584 \begin_layout Plain Layout
18590 Language dependent preamble; see
18591 \begin_inset CommandInset ref
18593 reference "subsec:I18n"
18600 \begin_layout Description
18601 \begin_inset Flex Code
18604 \begin_layout Plain Layout
18611 \begin_inset Flex Code
18614 \begin_layout Plain Layout
18620 ] The name of the corresponding \SpecialChar LaTeX
18622 Either the environment or command name.
18625 \begin_layout Description
18626 \begin_inset Flex Code
18629 \begin_layout Plain Layout
18636 \begin_inset Flex Code
18639 \begin_layout Plain Layout
18645 ] The optional parameter for the corresponding
18646 \begin_inset Flex Code
18649 \begin_layout Plain Layout
18655 stuff, including possible bracket pairs like
18656 \begin_inset Flex Code
18659 \begin_layout Plain Layout
18666 This parameter cannot be changed from within \SpecialChar LyX
18668 \begin_inset Flex Code
18671 \begin_layout Plain Layout
18677 for customizable parameters).
18678 It will be output as is after all \SpecialChar LaTeX
18680 \begin_inset Flex Code
18683 \begin_layout Plain Layout
18692 \begin_layout Description
18693 \begin_inset Flex Code
18696 \begin_layout Plain Layout
18703 \begin_inset Flex Code
18706 \begin_layout Plain Layout
18707 Command, Environment, None
18712 ] How the style should be translated into \SpecialChar LaTeX
18717 \begin_layout Plain Layout
18718 \begin_inset Flex Code
18721 \begin_layout Plain Layout
18727 is perhaps a bit misleading, since these rules apply to SGML classes too.
18728 Visit the SGML class files for specific examples.
18737 \begin_layout Description
18738 \begin_inset Flex Code
18741 \begin_layout Plain Layout
18747 means nothing special
18750 \begin_layout Description
18751 \begin_inset Flex Code
18754 \begin_layout Plain Layout
18761 \begin_inset Flex Code
18764 \begin_layout Plain Layout
18771 {\SpecialChar ldots
18780 \begin_layout Description
18781 \begin_inset Flex Code
18784 \begin_layout Plain Layout
18791 \begin_inset Flex Code
18794 \begin_layout Plain Layout
18801 }\SpecialChar ldots
18816 \begin_layout Standard
18817 Putting the last few things together, the \SpecialChar LaTeX
18818 output will be either:
18821 \begin_layout LyX-Code
18824 LatexName[LatexParam]{\SpecialChar ldots
18828 \begin_layout Standard
18832 \begin_layout LyX-Code
18835 begin{LatexName}[LatexParam] \SpecialChar ldots
18841 \begin_layout Standard
18842 depending upon the \SpecialChar LaTeX
18847 \begin_layout Description
18848 \begin_inset Flex Code
18851 \begin_layout Plain Layout
18858 \begin_inset Flex Code
18861 \begin_layout Plain Layout
18867 ] A string that is put at the beginning of the layout content.
18868 A line break in the output can be indicated by
18869 \begin_inset Flex Code
18872 \begin_layout Plain Layout
18881 \begin_layout Description
18882 \begin_inset Flex Code
18885 \begin_layout Plain Layout
18892 \begin_inset Flex Code
18895 \begin_layout Plain Layout
18902 \begin_inset Flex Code
18905 \begin_layout Plain Layout
18912 \begin_inset Flex Code
18915 \begin_layout Plain Layout
18922 \begin_inset Flex Code
18925 \begin_layout Plain Layout
18931 (indicating a dummy definition ending definitions of charstyles, etc).
18932 This entry is required in and is only meaningful for Flex insets.
18933 Among other things, it determines on which menu this inset will appear.
18935 \begin_inset Flex Code
18938 \begin_layout Plain Layout
18945 \begin_inset Flex Code
18948 \begin_layout Plain Layout
18954 will automatically set
18955 \begin_inset Flex Code
18958 \begin_layout Plain Layout
18965 \begin_inset Flex Code
18968 \begin_layout Plain Layout
18976 \begin_inset Flex Code
18979 \begin_layout Plain Layout
18985 can be set to true, or
18986 \begin_inset Flex Code
18989 \begin_layout Plain Layout
18996 \begin_inset Flex Code
18999 \begin_layout Plain Layout
19005 insets by setting it
19010 \begin_inset Flex Code
19013 \begin_layout Plain Layout
19022 \begin_layout Description
19023 \begin_inset Flex Code
19026 \begin_layout Plain Layout
19033 \begin_inset Flex Code
19036 \begin_layout Plain Layout
19045 \begin_inset space \thinspace{}
19049 \begin_inset Flex Code
19052 \begin_layout Plain Layout
19058 ] Whether multiple paragraphs are permitted in this inset.
19060 \begin_inset Flex Code
19063 \begin_layout Plain Layout
19069 to the same value and
19070 \begin_inset Flex Code
19073 \begin_layout Plain Layout
19079 to the opposite value.
19080 These can be reset to other values, if they are used
19085 \begin_inset Flex Code
19088 \begin_layout Plain Layout
19098 \begin_layout Description
19099 \begin_inset Flex Code
19102 \begin_layout Plain Layout
19109 \begin_inset Flex Code
19112 \begin_layout Plain Layout
19121 \begin_inset space \thinspace{}
19125 \begin_inset Flex Code
19128 \begin_layout Plain Layout
19134 ] Whether fragile commands in this inset should be
19135 \begin_inset Flex Code
19138 \begin_layout Plain Layout
19151 whether the command should itself be protected.) Default is false.
19154 \begin_layout Description
19155 \begin_inset Flex Code
19158 \begin_layout Plain Layout
19165 \begin_inset Flex Code
19168 \begin_layout Plain Layout
19174 ] Deletes an existing
19175 \begin_inset Flex Code
19178 \begin_layout Plain Layout
19187 \begin_layout Description
19188 \begin_inset Flex Code
19191 \begin_layout Plain Layout
19198 \begin_inset Flex Code
19201 \begin_layout Plain Layout
19208 \begin_inset Flex Code
19211 \begin_layout Plain Layout
19217 that has replaced this
19218 \begin_inset Flex Code
19221 \begin_layout Plain Layout
19228 This is used to rename an
19229 \begin_inset Flex Code
19232 \begin_layout Plain Layout
19238 , while keeping backward compatibility.
19241 \begin_layout Description
19242 \begin_inset Flex Code
19245 \begin_layout Plain Layout
19252 \begin_inset Flex Code
19255 \begin_layout Plain Layout
19264 \begin_inset space \thinspace{}
19268 \begin_inset Flex Code
19271 \begin_layout Plain Layout
19277 ] As with paragraph styles, see
19278 \begin_inset CommandInset ref
19280 reference "subsec:Paragraph-Styles"
19288 \begin_layout Description
19289 \begin_inset Flex Code
19292 \begin_layout Plain Layout
19299 \begin_inset Flex Code
19302 \begin_layout Plain Layout
19311 \begin_inset space \thinspace{}
19315 \begin_inset Flex Code
19318 \begin_layout Plain Layout
19324 ] As with paragraph styles, see
19325 \begin_inset CommandInset ref
19327 reference "subsec:Paragraph-Styles"
19335 \begin_layout Description
19336 \begin_inset Flex Code
19339 \begin_layout Plain Layout
19345 As with paragraph styles, see
19346 \begin_inset CommandInset ref
19348 reference "subsec:Paragraph-Styles"
19355 \begin_layout Description
19356 \begin_inset Flex Code
19359 \begin_layout Plain Layout
19366 \begin_inset Flex Code
19369 \begin_layout Plain Layout
19375 ] The prefix to use when creating labels referring to insets of this type.
19376 This allows the use of formatted references.
19379 \begin_layout Description
19380 \begin_inset Flex Code
19383 \begin_layout Plain Layout
19390 \begin_inset Flex Code
19393 \begin_layout Plain Layout
19399 ] As with paragraph styles, see
19400 \begin_inset CommandInset ref
19402 reference "subsec:Paragraph-Styles"
19409 \begin_layout Description
19410 \begin_inset Flex Code
19413 \begin_layout Plain Layout
19420 \begin_inset Flex Code
19423 \begin_layout Plain Layout
19432 \begin_inset space \thinspace{}
19436 \begin_inset Flex Code
19439 \begin_layout Plain Layout
19445 ] Resets the \SpecialChar LaTeX
19446 arguments of this layout (as defined via the
19447 \begin_inset Flex Code
19450 \begin_layout Plain Layout
19457 This is useful if you have copied a style via
19458 \begin_inset Flex Code
19461 \begin_layout Plain Layout
19467 , but you do not want to inherit its (required and optional) arguments.
19470 \begin_layout Description
19471 \begin_inset Flex Code
19474 \begin_layout Plain Layout
19481 \begin_inset Flex Code
19484 \begin_layout Plain Layout
19491 \begin_inset space \thinspace{}
19495 \begin_inset Flex Code
19498 \begin_layout Plain Layout
19506 ] Whether this inset should use the font of its surrounding environment
19508 Default is false: use the font of the surrounding environment.
19511 \begin_layout Description
19512 \begin_inset Flex Code
19515 \begin_layout Plain Layout
19522 \begin_inset Flex Code
19525 \begin_layout Plain Layout
19531 ] A string that is put at the end of the layout content.
19532 A line break in the output can be indicated by
19533 \begin_inset Flex Code
19536 \begin_layout Plain Layout
19545 \begin_layout Description
19546 \begin_inset Flex Code
19549 \begin_layout Plain Layout
19556 \begin_inset Flex Code
19559 \begin_layout Plain Layout
19566 \begin_inset space \thinspace{}
19570 \begin_inset Flex Code
19573 \begin_layout Plain Layout
19581 ] Allow spell-checking the contents of this inset.
19585 \begin_layout Subsection
19587 \begin_inset CommandInset label
19589 name "subsec:Counters"
19596 \begin_layout Standard
19597 It is necessary to define the counters (
19598 \begin_inset Flex Noun
19601 \begin_layout Plain Layout
19608 \begin_inset Flex Noun
19611 \begin_layout Plain Layout
19617 , \SpecialChar ldots
19618 ) in the text class itself.
19619 The standard counters are defined in the file
19620 \begin_inset Flex Code
19623 \begin_layout Plain Layout
19629 , so you may have to do no more than add
19632 \begin_layout LyX-Code
19633 Input stdcounters.inc
19636 \begin_layout Standard
19637 to your layout file to get them to work.
19638 But if you want to define custom counters, then you can do so.
19639 The counter declaration must begin with:
19642 \begin_layout LyX-Code
19643 Counter CounterName
19646 \begin_layout Standard
19648 \begin_inset Flex Code
19651 \begin_layout Plain Layout
19657 ' is replaced by the name of the counter.
19658 And it must end with
19659 \begin_inset Quotes eld
19663 \begin_inset Flex Code
19666 \begin_layout Plain Layout
19673 \begin_inset Quotes erd
19677 The following parameters can also be used:
19680 \begin_layout Description
19681 \begin_inset Flex Code
19684 \begin_layout Plain Layout
19691 \begin_inset Flex Code
19694 \begin_layout Plain Layout
19700 ] Sets the initial value for the counter, to which it will be reset whenever
19702 Normally, one will want the default, 1.
19705 \begin_layout Description
19706 \begin_inset Flex Code
19709 \begin_layout Plain Layout
19716 \begin_inset Flex Code
19719 \begin_layout Plain Layout
19726 \begin_inset Quotes erd
19730 \begin_inset Quotes erd
19733 ] When defined, this string defines how the counter is displayed.
19734 Setting this value sets
19735 \begin_inset Flex Code
19738 \begin_layout Plain Layout
19739 LabelStringAppendix
19745 The following special constructs can be used in the string:
19749 \begin_layout Itemize
19750 \begin_inset Flex Code
19753 \begin_layout Plain Layout
19761 will be replaced by the expansion of the
19762 \begin_inset Flex Code
19765 \begin_layout Plain Layout
19772 \begin_inset Flex Code
19775 \begin_layout Plain Layout
19776 LabelStringAppendix
19782 \begin_inset Flex Code
19785 \begin_layout Plain Layout
19795 \begin_layout Itemize
19796 counter values can be expressed using \SpecialChar LaTeX
19798 \begin_inset Newline newline
19802 \begin_inset Flex Code
19805 \begin_layout Plain Layout
19822 \begin_inset Flex Code
19825 \begin_layout Plain Layout
19837 \begin_layout Plain Layout
19847 Actually, the situation is a bit more complicated: any
19866 other than those described below will produce arabic numerals.
19867 It would not be surprising to see this change in the future.
19873 \begin_inset Flex Code
19876 \begin_layout Plain Layout
19882 : 1, 2, 3,\SpecialChar ldots
19884 \begin_inset Flex Code
19887 \begin_layout Plain Layout
19893 for lower-case letters: a, b, c, \SpecialChar ldots
19895 \begin_inset Flex Code
19898 \begin_layout Plain Layout
19904 for upper-case letters: A, B, C, \SpecialChar ldots
19906 \begin_inset Flex Code
19909 \begin_layout Plain Layout
19915 for lower-case roman numerals: i, ii, iii, \SpecialChar ldots
19917 \begin_inset Flex Code
19920 \begin_layout Plain Layout
19926 for upper-case roman numerals: I, II, III\SpecialChar ldots
19928 \begin_inset Flex Code
19931 \begin_layout Plain Layout
19937 for hebrew numerals.
19941 \begin_layout Standard
19942 If LabelString is not defined, a default value is constructed as follows:
19943 if the counter has a master counter
19944 \begin_inset Flex Code
19947 \begin_layout Plain Layout
19954 \begin_inset Flex Code
19957 \begin_layout Plain Layout
19964 \begin_inset Newline newline
19968 \begin_inset Flex Code
19971 \begin_layout Plain Layout
19981 is used; otherwise the string
19982 \begin_inset Flex Code
19985 \begin_layout Plain Layout
19996 \begin_layout Description
19997 \begin_inset Flex Code
20000 \begin_layout Plain Layout
20001 LabelStringAppendix
20007 \begin_inset Flex Code
20010 \begin_layout Plain Layout
20017 \begin_inset Quotes erd
20021 \begin_inset Quotes erd
20025 \begin_inset Flex Code
20028 \begin_layout Plain Layout
20034 , but for use in the Appendix.
20037 \begin_layout Description
20038 \begin_inset Flex Code
20041 \begin_layout Plain Layout
20048 \begin_inset Flex Code
20051 \begin_layout Plain Layout
20058 \begin_inset Quotes erd
20062 \begin_inset Quotes erd
20065 ] A format for use with formatted references to this counter.
20066 For example, one might want to have references to section numbers appear
20068 \begin_inset Quotes eld
20072 \begin_inset Quotes erd
20076 The string should contain
20077 \begin_inset Quotes eld
20081 \begin_inset Quotes erd
20085 This will be replaced by the counter number itself.
20086 So, for sections, it would be: Section ##.
20089 \begin_layout Description
20090 \begin_inset Flex Code
20093 \begin_layout Plain Layout
20100 \begin_inset Flex Code
20103 \begin_layout Plain Layout
20110 \begin_inset Quotes erd
20114 \begin_inset Quotes erd
20117 ] If this is set to the name of another counter, the present counter will
20118 be reset every time the other one is increased.
20120 \begin_inset Flex Code
20123 \begin_layout Plain Layout
20130 \begin_inset Flex Code
20133 \begin_layout Plain Layout
20142 \begin_layout Subsection
20144 \begin_inset CommandInset label
20146 name "subsec:Font-description"
20153 \begin_layout Standard
20154 A font description looks like this:
20157 \begin_layout LyX-Code
20171 \begin_layout LyX-Code
20175 \begin_layout LyX-Code
20179 \begin_layout Standard
20180 The following commands are available:
20183 \begin_layout Description
20184 \begin_inset Flex Code
20187 \begin_layout Plain Layout
20194 \begin_inset Flex Code
20197 \begin_layout Plain Layout
20206 \begin_inset Flex Code
20209 \begin_layout Plain Layout
20216 \begin_inset Flex Code
20219 \begin_layout Plain Layout
20226 \begin_inset Flex Code
20229 \begin_layout Plain Layout
20236 \begin_inset Flex Code
20239 \begin_layout Plain Layout
20246 \begin_inset Flex Code
20249 \begin_layout Plain Layout
20256 \begin_inset Flex Code
20259 \begin_layout Plain Layout
20266 \begin_inset Flex Code
20269 \begin_layout Plain Layout
20276 \begin_inset Flex Code
20279 \begin_layout Plain Layout
20286 \begin_inset Flex Code
20289 \begin_layout Plain Layout
20296 \begin_inset Flex Code
20299 \begin_layout Plain Layout
20306 \begin_inset Flex Code
20309 \begin_layout Plain Layout
20316 \begin_inset Flex Code
20319 \begin_layout Plain Layout
20326 \begin_inset Flex Code
20329 \begin_layout Plain Layout
20336 \begin_inset Flex Code
20339 \begin_layout Plain Layout
20346 \begin_inset Flex Code
20349 \begin_layout Plain Layout
20356 \begin_inset Flex Code
20359 \begin_layout Plain Layout
20366 \begin_inset Flex Code
20369 \begin_layout Plain Layout
20376 \begin_inset Flex Code
20379 \begin_layout Plain Layout
20386 \begin_inset Flex Code
20389 \begin_layout Plain Layout
20398 \begin_layout Description
20399 \begin_inset Flex Code
20402 \begin_layout Plain Layout
20409 \begin_inset Flex Code
20412 \begin_layout Plain Layout
20421 \begin_inset Flex Code
20424 \begin_layout Plain Layout
20431 \begin_inset Flex Code
20434 \begin_layout Plain Layout
20443 \begin_layout Description
20444 \begin_inset Flex Code
20447 \begin_layout Plain Layout
20454 \begin_inset Flex Code
20457 \begin_layout Plain Layout
20463 ] Valid arguments are:
20464 \begin_inset Flex Code
20467 \begin_layout Plain Layout
20474 \begin_inset Flex Code
20477 \begin_layout Plain Layout
20484 \begin_inset Flex Code
20487 \begin_layout Plain Layout
20494 \begin_inset Flex Code
20497 \begin_layout Plain Layout
20504 \begin_inset Flex Code
20507 \begin_layout Plain Layout
20514 \begin_inset Flex Code
20517 \begin_layout Plain Layout
20524 \begin_inset Flex Code
20527 \begin_layout Plain Layout
20534 \begin_inset Flex Code
20537 \begin_layout Plain Layout
20544 \begin_inset Flex Code
20547 \begin_layout Plain Layout
20554 \begin_inset Flex Code
20557 \begin_layout Plain Layout
20564 \begin_inset Flex Code
20567 \begin_layout Plain Layout
20574 \begin_inset Flex Code
20577 \begin_layout Plain Layout
20584 Each of these turns on or off the corresponding attribute.
20586 \begin_inset Flex Code
20589 \begin_layout Plain Layout
20595 turns on emphasis, and
20596 \begin_inset Flex Code
20599 \begin_layout Plain Layout
20607 \begin_inset Newline newline
20610 If the latter seems puzzling, remember that the font settings for the present
20611 context are generally inherited from the surrounding context.
20613 \begin_inset Flex Code
20616 \begin_layout Plain Layout
20622 would turn off the emphasis that was anyway in effect, say, in a theorem
20626 \begin_layout Description
20627 \begin_inset Flex Code
20630 \begin_layout Plain Layout
20637 \begin_inset Flex Code
20640 \begin_layout Plain Layout
20649 \begin_inset Flex Code
20652 \begin_layout Plain Layout
20661 \begin_layout Description
20662 \begin_inset Flex Code
20665 \begin_layout Plain Layout
20672 \begin_inset Flex Code
20675 \begin_layout Plain Layout
20684 \begin_inset Flex Code
20687 \begin_layout Plain Layout
20694 \begin_inset Flex Code
20697 \begin_layout Plain Layout
20704 \begin_inset Flex Code
20707 \begin_layout Plain Layout
20716 \begin_layout Description
20717 \begin_inset Flex Code
20720 \begin_layout Plain Layout
20727 \begin_inset Flex Code
20730 \begin_layout Plain Layout
20737 \begin_inset Flex Code
20740 \begin_layout Plain Layout
20747 \begin_inset Flex Code
20750 \begin_layout Plain Layout
20759 \begin_inset Flex Code
20762 \begin_layout Plain Layout
20769 \begin_inset Flex Code
20772 \begin_layout Plain Layout
20779 \begin_inset Flex Code
20782 \begin_layout Plain Layout
20789 \begin_inset Flex Code
20792 \begin_layout Plain Layout
20799 \begin_inset Flex Code
20802 \begin_layout Plain Layout
20811 \begin_layout Subsection
20812 \begin_inset CommandInset label
20814 name "subsec:Citation-format-description"
20818 Citation format description
20821 \begin_layout Standard
20823 \begin_inset Flex Code
20826 \begin_layout Plain Layout
20832 blocks are used to describe how bibliographic information should be displayed,
20833 both within \SpecialChar LyX
20834 itself (in the citation dialog and in tooltips, for example)
20835 and in XHTML output.
20836 Such a block might look like this:
20839 \begin_layout LyX-Code
20843 \begin_layout LyX-Code
20847 \begin_layout LyX-Code
20851 \begin_layout LyX-Code
20855 \begin_layout Standard
20856 The individual lines define how the bibliographic information associated
20857 with an article or book, respectively, is to be displayed, and such a definitio
20858 n can be given for any `entry type' that might be present in a Bib\SpecialChar TeX
20861 defines a default format in the source code that will be used if no specific
20862 definition has been given.
20864 predefines several formats in the file
20865 \begin_inset Flex Code
20868 \begin_layout Plain Layout
20874 , which is included in most of \SpecialChar LyX
20875 's document classes.
20878 \begin_layout Standard
20879 The definitions use a simple language that allows Bib\SpecialChar TeX
20880 keys to be replaced
20882 Keys should be enclosed in
20883 \begin_inset Flex Code
20886 \begin_layout Plain Layout
20893 \begin_inset Flex Code
20896 \begin_layout Plain Layout
20903 So a simple definition might look like this:
20906 \begin_layout LyX-Code
20908 \begin_inset Quotes eld
20912 \begin_inset Quotes erd
20918 \begin_layout Standard
20919 This would print the author, followed by a comma, followed by the title,
20920 in quotes, followed by a period.
20923 \begin_layout Standard
20924 Of course, sometimes you may want to print a key only if it exists.
20925 This can be done by using a conditional construction, such as:
20926 \begin_inset Flex Code
20929 \begin_layout Plain Layout
20931 \begin_inset space ~
20941 \begin_inset Flex Code
20944 \begin_layout Plain Layout
20950 key exists, then print
20951 \begin_inset Quotes eld
20955 \begin_inset space ~
20959 \begin_inset Quotes erd
20962 followed by the volume key.
20963 It is also possible to have an else clause in the conditional, such as:
20964 \begin_inset Newline newline
20968 \begin_inset Flex Code
20971 \begin_layout Plain Layout
20972 {%author%[[%author%]][[%editor%, ed.]]}
20978 \begin_inset Newline newline
20982 \begin_inset Flex Code
20985 \begin_layout Plain Layout
20991 key is printed if it exists; otherwise, the editor key is printed, followed
20993 \begin_inset Quotes eld
20997 \begin_inset space ~
21001 \begin_inset Quotes erd
21004 Note that the key is again enclosed in
21005 \begin_inset Flex Code
21008 \begin_layout Plain Layout
21014 signs; the entire conditional is enclosed in braces; and the if and else
21015 clauses are enclosed in double brackets,
21016 \begin_inset Quotes eld
21020 \begin_inset Flex Code
21023 \begin_layout Plain Layout
21030 \begin_inset Quotes eld
21034 \begin_inset Quotes eld
21038 \begin_inset Flex Code
21041 \begin_layout Plain Layout
21048 \begin_inset Quotes erd
21052 There must be no space between any of these.
21055 \begin_layout Standard
21056 There is one other piece of syntax available in definitions, which looks
21058 \begin_inset Flex Code
21061 \begin_layout Plain Layout
21068 This defines a piece of formatting information that is to be used when
21070 \begin_inset Quotes eld
21074 \begin_inset Quotes erd
21078 Obviously, we do not want to output HTML tags when writing plain text,
21079 so they should be wrapped in
21080 \begin_inset Quotes eld
21084 \begin_inset Quotes erd
21088 \begin_inset Quotes eld
21092 \begin_inset Quotes erd
21098 \begin_layout Standard
21099 Two special sorts of definitions are also possible in a
21100 \begin_inset Flex Code
21103 \begin_layout Plain Layout
21110 An example of the first would be:
21113 \begin_layout LyX-Code
21115 \begin_inset Quotes eld
21119 \begin_inset Quotes erd
21125 \begin_layout Standard
21126 This is an abbreviation, or macro, and it can be used by treating it as
21128 \begin_inset Flex Code
21131 \begin_layout Plain Layout
21140 \begin_inset Flex Code
21143 \begin_layout Plain Layout
21149 exactly as it would treat its definition.
21150 So, let us issue the obvious
21158 \begin_layout LyX-Code
21162 \begin_layout Standard
21163 or anything like it.
21165 shouldn't go into an infinite loop, but it may go into a long one before
21169 \begin_layout Standard
21170 The second sort of special definition might look like this:
21173 \begin_layout LyX-Code
21177 \begin_layout Standard
21178 This defines a translatable piece of text, which allows relevant parts of
21179 the bibliography to be translated.
21180 It can be included in a definition by treating it as a key:
21181 \begin_inset Flex Code
21184 \begin_layout Plain Layout
21191 Several of these are predefined in
21192 \begin_inset Flex Code
21195 \begin_layout Plain Layout
21202 Note that these are not macros, in the sense just defined.
21203 They will not be expanded.
21206 \begin_layout Standard
21207 So here then is an example that use all these features:
21208 \begin_inset VSpace defskip
21214 \begin_layout Standard
21218 !authoredit {%author%[[%author%, ]][[{%editor%[[%editor%, %_edtext%, ]]}]]}
21221 \begin_layout Standard
21222 \begin_inset VSpace defskip
21225 This defines a macro that prints the author, followed by a comma, if the
21227 \begin_inset Flex Code
21230 \begin_layout Plain Layout
21236 key is defined, or else prints the name of the editor, followed by the
21238 \begin_inset Flex Code
21241 \begin_layout Plain Layout
21247 or its translation (it is by default
21248 \begin_inset Quotes eld
21252 \begin_inset Quotes erd
21256 \begin_inset Flex Code
21259 \begin_layout Plain Layout
21266 Note that this is in fact defined in
21267 \begin_inset Flex Code
21270 \begin_layout Plain Layout
21276 , so you can use it in your own definitions, or re-definitions, if you load
21280 \begin_layout Section
21281 \begin_inset CommandInset label
21283 name "sec:Tags-for-XHTML"
21287 Tags for XHTML output
21290 \begin_layout Standard
21291 As with \SpecialChar LaTeX
21292 or DocBook, the format of \SpecialChar LyX
21293 's XHTML output is also controlled by
21294 layout information.
21295 In general, \SpecialChar LyX
21296 provides sensible defaults and, as mentioned earlier, it will
21297 even construct default CSS style rules from the other layout tags.
21298 For example, \SpecialChar LyX
21299 will attempt to use the information provided in the
21300 \begin_inset Flex Code
21303 \begin_layout Plain Layout
21309 declaration for the Chapter style to write CSS that will appropriately
21310 format chapter headings.
21313 \begin_layout Standard
21314 In many cases, then, you may not have to do anything at all to get acceptable
21315 XHTML output for your own environments, custom insets, and so forth.
21316 But in some cases you will, and so \SpecialChar LyX
21317 provides a number of layout tags that
21318 can be used to customize the XHTML and CSS that are generated.
21321 \begin_layout Standard
21322 Note that there are two tags,
21323 \begin_inset Flex Code
21326 \begin_layout Plain Layout
21333 \begin_inset Flex Code
21336 \begin_layout Plain Layout
21342 that may appear outside style and inset declarations.
21344 \begin_inset CommandInset ref
21346 reference "subsec:General-text-class"
21350 for details on these.
21353 \begin_layout Subsection
21354 \begin_inset CommandInset label
21356 name "subsec:Paragraph-Style-XHTML"
21363 \begin_layout Standard
21364 The sort of XHTML \SpecialChar LyX
21365 outputs for a paragraph depends upon whether we are dealing
21366 with a normal paragraph, a command, or an environment, where this is itself
21367 determined by the contents of the corresponding
21368 \begin_inset Flex Code
21371 \begin_layout Plain Layout
21382 \begin_layout Standard
21383 For a command or normal paragraph, the output XHTML has the following form:
21386 \begin_layout LyX-Code
21388 \begin_inset Quotes erd
21392 \begin_inset Quotes erd
21398 \begin_layout LyX-Code
21400 \begin_inset Quotes erd
21404 \begin_inset Quotes erd
21410 \begin_layout LyX-Code
21411 Contents of the paragraph.
21414 \begin_layout LyX-Code
21418 \begin_layout Standard
21419 The label tags are of course omitted if the paragraph does not have a label.
21422 \begin_layout Standard
21423 For an environment that is not some sort of list, the XHTML takes this form:
21426 \begin_layout LyX-Code
21428 \begin_inset Quotes erd
21432 \begin_inset Quotes erd
21438 \begin_layout LyX-Code
21440 \begin_inset Quotes erd
21444 \begin_inset Quotes erd
21448 \begin_inset Quotes erd
21452 \begin_inset Quotes erd
21455 >Environment Label</labeltag>First paragraph.</itemtag>
21458 \begin_layout LyX-Code
21459 <itemtag>Second paragraph.</itemtag>
21462 \begin_layout LyX-Code
21466 \begin_layout Standard
21467 Note that the label is output only for the first paragraph, as it should
21468 be for a theorem, for example.
21472 \begin_layout Standard
21473 For a list, we have one of these forms:
21476 \begin_layout LyX-Code
21478 \begin_inset Quotes erd
21482 \begin_inset Quotes erd
21488 \begin_layout LyX-Code
21490 \begin_inset Quotes erd
21494 \begin_inset Quotes erd
21498 \begin_inset Quotes erd
21502 \begin_inset Quotes erd
21505 >List Label</labeltag>First item.</itemtag>
21508 \begin_layout LyX-Code
21510 \begin_inset Quotes erd
21514 \begin_inset Quotes erd
21518 \begin_inset Quotes erd
21522 \begin_inset Quotes erd
21525 >List Label</labeltag>Second item.</itemtag>
21528 \begin_layout LyX-Code
21532 \begin_layout LyX-Code
21536 \begin_layout LyX-Code
21538 \begin_inset Quotes erd
21542 \begin_inset Quotes erd
21548 \begin_layout LyX-Code
21550 \begin_inset Quotes erd
21554 \begin_inset Quotes erd
21557 >List Label</labeltag><itemtag attr=
21558 \begin_inset Quotes erd
21562 \begin_inset Quotes erd
21565 >First item.</itemtag>
21568 \begin_layout LyX-Code
21570 \begin_inset Quotes erd
21574 \begin_inset Quotes erd
21577 >List Label</labeltag><itemtag attr=
21578 \begin_inset Quotes erd
21582 \begin_inset Quotes erd
21585 >Second item.</itemtag>
21588 \begin_layout LyX-Code
21592 \begin_layout Standard
21593 Note the different orders of
21594 \begin_inset Flex Code
21597 \begin_layout Plain Layout
21604 \begin_inset Flex Code
21607 \begin_layout Plain Layout
21614 Which order we get depends upon the setting of
21615 \begin_inset Flex Code
21618 \begin_layout Plain Layout
21625 \begin_inset Flex Code
21628 \begin_layout Plain Layout
21634 is false (the default), you get the first of these, with the label within
21635 the item; if true, you get the second, with the label outside the item.
21638 \begin_layout Standard
21639 The specific tags and attributes output for each paragraph type can be controlle
21640 d by means of the layout tags we are about to describe.
21641 As mentioned earlier, however, \SpecialChar LyX
21642 uses sensible defaults for many of these,
21643 so you often may not need to do very much to get good XHTML output.
21644 Think of the available tags as there so you can tweak things to your liking.
21647 \begin_layout Description
21648 \begin_inset Flex Code
21651 \begin_layout Plain Layout
21658 \begin_inset Flex Code
21661 \begin_layout Plain Layout
21667 ] Specifies attribute information to be output with the main tag.
21669 \begin_inset Quotes eld
21673 \begin_inset Flex Code
21676 \begin_layout Plain Layout
21683 \begin_inset Quotes erd
21687 By default, \SpecialChar LyX
21689 \begin_inset Quotes eld
21693 \begin_inset Flex Code
21696 \begin_layout Plain Layout
21703 \begin_inset Quotes erd
21707 \begin_inset Flex Code
21710 \begin_layout Plain Layout
21716 is the \SpecialChar LyX
21717 name of the layout, made lowercase, for example: chapter.
21722 contain any style information.
21724 \begin_inset Flex Code
21727 \begin_layout Plain Layout
21736 \begin_layout Description
21737 \begin_inset Flex Code
21740 \begin_layout Plain Layout
21747 \begin_inset Flex Code
21750 \begin_layout Plain Layout
21760 ] Whether to output the default CSS information \SpecialChar LyX
21761 generates for this layout,
21762 even if additional information is explicitly provided via
21763 \begin_inset Flex Code
21766 \begin_layout Plain Layout
21774 \begin_inset Flex Code
21777 \begin_layout Plain Layout
21783 allows you to alter or augment the generated CSS, rather than to override
21786 \begin_inset Flex Code
21789 \begin_layout Plain Layout
21798 \begin_layout Description
21799 \begin_inset Flex Code
21802 \begin_layout Plain Layout
21809 \begin_inset Flex Code
21812 \begin_layout Plain Layout
21818 ] The tag to be used for individual paragraphs of environments, replacing
21820 \begin_inset Flex Code
21823 \begin_layout Plain Layout
21829 in the examples above.
21831 \begin_inset Flex Code
21834 \begin_layout Plain Layout
21843 \begin_layout Description
21844 \begin_inset Flex Code
21847 \begin_layout Plain Layout
21854 \begin_inset Flex Code
21857 \begin_layout Plain Layout
21863 ] Attributes for the item tag.
21865 \begin_inset Quotes eld
21869 \begin_inset Flex Code
21872 \begin_layout Plain Layout
21873 class=`layoutname_item'
21879 \begin_inset Quotes erd
21887 contain any style information.
21889 \begin_inset Flex Code
21892 \begin_layout Plain Layout
21901 \begin_layout Description
21902 \begin_inset Flex Code
21905 \begin_layout Plain Layout
21912 \begin_inset Flex Code
21915 \begin_layout Plain Layout
21921 ] The tag to be used for paragraph and item labels, replacing
21922 \begin_inset Flex Code
21925 \begin_layout Plain Layout
21931 in the examples above.
21933 \begin_inset Flex Code
21936 \begin_layout Plain Layout
21943 \begin_inset Flex Code
21946 \begin_layout Plain Layout
21953 \begin_inset Flex Code
21956 \begin_layout Plain Layout
21963 \begin_inset Flex Code
21966 \begin_layout Plain Layout
21967 Centered_Top_Environment
21972 , in which case it defaults to
21973 \begin_inset Flex Code
21976 \begin_layout Plain Layout
21985 \begin_layout Description
21986 \begin_inset Flex Code
21989 \begin_layout Plain Layout
21996 \begin_inset Flex Code
21999 \begin_layout Plain Layout
22005 ] Attributes for the label tag.
22007 \begin_inset Quotes eld
22011 \begin_inset Flex Code
22014 \begin_layout Plain Layout
22015 class=`layoutname_label'
22021 \begin_inset Quotes erd
22029 contain any style information.
22031 \begin_inset Flex Code
22034 \begin_layout Plain Layout
22043 \begin_layout Description
22044 \begin_inset Flex Code
22047 \begin_layout Plain Layout
22054 \begin_inset Flex Code
22057 \begin_layout Plain Layout
22067 ] Meaningful only for list-like environments, this tag controls whether
22068 the label tag is output before or inside the item tag.
22069 This is used, for example, in the description environment, where we want
22071 \begin_inset Flex Code
22074 \begin_layout Plain Layout
22075 <dt>\SpecialChar ldots
22076 </dt><dd>\SpecialChar ldots
22084 \begin_inset Flex Code
22087 \begin_layout Plain Layout
22093 : The label tag is output inside the item tag.
22096 \begin_layout Description
22097 \begin_inset Flex Code
22100 \begin_layout Plain Layout
22106 Information to be output in the
22107 \begin_inset Flex Code
22110 \begin_layout Plain Layout
22116 section when this style is used.
22117 This might, for example, be used to include a
22118 \begin_inset Flex Code
22121 \begin_layout Plain Layout
22128 \begin_inset Flex Code
22131 \begin_layout Plain Layout
22140 \begin_layout Description
22141 \begin_inset Flex Code
22144 \begin_layout Plain Layout
22150 CSS style information to be included when this style is used.
22151 Note that this will automatically be wrapped in a layout-generated
22152 \begin_inset Flex Code
22155 \begin_layout Plain Layout
22161 block, so only the CSS itself need be included.
22163 \begin_inset Flex Code
22166 \begin_layout Plain Layout
22175 \begin_layout Description
22176 \begin_inset Flex Code
22179 \begin_layout Plain Layout
22186 \begin_inset Flex Code
22189 \begin_layout Plain Layout
22195 ] The tag to be used for the main label, replacing
22196 \begin_inset Flex Code
22199 \begin_layout Plain Layout
22205 in the examples above.
22207 \begin_inset Flex Code
22210 \begin_layout Plain Layout
22219 \begin_layout Description
22220 \begin_inset Flex Code
22223 \begin_layout Plain Layout
22230 \begin_inset Flex Code
22233 \begin_layout Plain Layout
22243 ] Marks this style as the one to be used to generate the
22244 \begin_inset Flex Code
22247 \begin_layout Plain Layout
22253 tag for the XHTML file.
22254 By default, it is false.
22256 \begin_inset Flex Code
22259 \begin_layout Plain Layout
22265 file sets it to true for the
22266 \begin_inset Flex Code
22269 \begin_layout Plain Layout
22279 \begin_layout Subsection
22283 \begin_layout Standard
22284 The XHTML output of insets can also be controlled by information in layout
22289 \begin_layout Plain Layout
22290 At present, this is true only for
22291 \begin_inset Quotes eld
22295 \begin_inset Quotes erd
22298 insets (insets you can type into) and is not true for
22299 \begin_inset Quotes eld
22303 \begin_inset Quotes erd
22306 insets (insets that are associated with dialog boxes).
22311 Here, too, \SpecialChar LyX
22312 tries to provide sensible defaults, and it constructs default
22314 But everything can be customized.
22317 \begin_layout Standard
22318 The XHTML \SpecialChar LyX
22319 outputs for an inset has the following form:
22322 \begin_layout LyX-Code
22324 \begin_inset Quotes erd
22328 \begin_inset Quotes erd
22334 \begin_layout LyX-Code
22335 <labeltag>Label</labeltag>
22338 \begin_layout LyX-Code
22340 \begin_inset Quotes erd
22344 \begin_inset Quotes erd
22347 >Contents of the inset.</innertag>
22350 \begin_layout LyX-Code
22354 \begin_layout Standard
22355 If the inset permits multiple paragraphs—that is, if
22356 \begin_inset Flex Code
22359 \begin_layout Plain Layout
22365 is true—then the contents of the inset will itself be output as paragraphs
22366 formatted according to the styles used for those paragraphs (standard,
22367 quote, and the like).
22368 The label tag is of course omitted if the paragraph does not have a label
22369 and, at present, is always
22370 \begin_inset Flex Code
22373 \begin_layout Plain Layout
22380 The inner tag is optional and, by default, does not appear.
22383 \begin_layout Standard
22384 The specific tags and attributes output for each inset can be controlled
22385 by means of the following layout tags.
22388 \begin_layout Description
22389 \begin_inset Flex Code
22392 \begin_layout Plain Layout
22399 \begin_inset Flex Code
22402 \begin_layout Plain Layout
22408 ] Specifies attribute information to be output with the main tag.
22410 \begin_inset Quotes eld
22414 \begin_inset Flex Code
22417 \begin_layout Plain Layout
22418 class=`myinset' onclick=`\SpecialChar ldots
22425 \begin_inset Quotes erd
22429 By default, \SpecialChar LyX
22431 \begin_inset Quotes eld
22435 \begin_inset Flex Code
22438 \begin_layout Plain Layout
22445 \begin_inset Quotes erd
22449 \begin_inset Flex Code
22452 \begin_layout Plain Layout
22458 is the \SpecialChar LyX
22459 name of the inset, made lowercase and with non-alphanumeric characters
22460 converted to underscores, for example: footnote.
22463 \begin_layout Description
22464 \begin_inset Flex Code
22467 \begin_layout Plain Layout
22474 \begin_inset Flex Code
22477 \begin_layout Plain Layout
22487 ] Whether to output the default CSS information \SpecialChar LyX
22488 generates for this layout,
22489 even if additional information is explicitly provided via
22490 \begin_inset Flex Code
22493 \begin_layout Plain Layout
22501 \begin_inset Flex Code
22504 \begin_layout Plain Layout
22510 allows you to alter or augment the generated CSS, rather than to override
22515 \begin_layout Description
22516 \begin_inset Flex Code
22519 \begin_layout Plain Layout
22526 \begin_inset Flex Code
22529 \begin_layout Plain Layout
22535 ] Attributes for the inner tag.
22537 \begin_inset Quotes eld
22541 \begin_inset Flex Code
22544 \begin_layout Plain Layout
22545 class=`insetname_inner'
22551 \begin_inset Quotes erd
22557 \begin_layout Description
22558 \begin_inset Flex Code
22561 \begin_layout Plain Layout
22568 \begin_inset Flex Code
22571 \begin_layout Plain Layout
22577 ] The inner tag, replacing
22578 \begin_inset Flex Code
22581 \begin_layout Plain Layout
22587 in the examples above.
22588 By default, there is none.
22591 \begin_layout Description
22592 \begin_inset Flex Code
22595 \begin_layout Plain Layout
22602 \begin_inset Flex Code
22605 \begin_layout Plain Layout
22613 ] Whether this inset represents a standalone block of text (such as a footnote)
22614 or instead represents material that is included in the surrounding text
22615 (such as a branch).
22619 \begin_layout Description
22620 \begin_inset Flex Code
22623 \begin_layout Plain Layout
22630 \begin_inset Flex Code
22633 \begin_layout Plain Layout
22639 ] A label for this inset, possibly including a reference to a counter.
22640 For example, for footnote, it might be:
22641 \begin_inset Flex Code
22644 \begin_layout Plain Layout
22653 This is optional, and there is no default.
22656 \begin_layout Description
22657 \begin_inset Flex Code
22660 \begin_layout Plain Layout
22666 Information to be output in the
22667 \begin_inset Flex Code
22670 \begin_layout Plain Layout
22676 section when this style is used.
22677 This might, for example, be used to include a
22678 \begin_inset Flex Code
22681 \begin_layout Plain Layout
22688 \begin_inset Flex Code
22691 \begin_layout Plain Layout
22700 \begin_layout Description
22701 \begin_inset Flex Code
22704 \begin_layout Plain Layout
22710 CSS style information to be included when this style is used.
22711 Note that this will automatically be wrapped in a layout-generated
22712 \begin_inset Flex Code
22715 \begin_layout Plain Layout
22721 block, so only the CSS itself need be included.
22724 \begin_layout Description
22725 \begin_inset Flex Code
22728 \begin_layout Plain Layout
22735 \begin_inset Flex Code
22738 \begin_layout Plain Layout
22744 ] The tag to be used for the main label, replacing
22745 \begin_inset Flex Code
22748 \begin_layout Plain Layout
22754 in the examples above.
22755 The default depends upon the setting of
22756 \begin_inset Flex Code
22759 \begin_layout Plain Layout
22766 \begin_inset Flex Code
22769 \begin_layout Plain Layout
22775 is true, the default is
22776 \begin_inset Flex Code
22779 \begin_layout Plain Layout
22785 ; if it is false, the default is
22786 \begin_inset Flex Code
22789 \begin_layout Plain Layout
22798 \begin_layout Subsection
22802 \begin_layout Standard
22803 The XHTML output for floats too can be controlled by layout information.
22804 The output has the following form:
22807 \begin_layout LyX-Code
22809 \begin_inset Quotes erd
22813 \begin_inset Quotes erd
22819 \begin_layout LyX-Code
22820 Contents of the float.
22823 \begin_layout LyX-Code
22827 \begin_layout Standard
22828 The caption, if there is one, is a separate inset and will be output as
22830 Its appearance can be controlled via the InsetLayout for caption insets.
22834 \begin_layout Description
22835 \begin_inset Flex Code
22838 \begin_layout Plain Layout
22845 \begin_inset Flex Code
22848 \begin_layout Plain Layout
22854 ] Specifies attribute information to be output with the main tag.
22856 \begin_inset Quotes eld
22860 \begin_inset Flex Code
22863 \begin_layout Plain Layout
22864 class=`myfloat' onclick=`\SpecialChar ldots
22871 \begin_inset Quotes erd
22875 By default, \SpecialChar LyX
22877 \begin_inset Quotes eld
22881 \begin_inset Flex Code
22884 \begin_layout Plain Layout
22885 class=`float float-floattype'
22891 \begin_inset Quotes erd
22895 \begin_inset Flex Code
22898 \begin_layout Plain Layout
22904 is \SpecialChar LyX
22905 's name for this type of float, as determined by the float declaration
22907 \begin_inset CommandInset ref
22909 reference "subsec:Floats"
22913 ), though made lowercase and with non-alphanumeric characters converted
22914 to underscores, for example: float-table.
22917 \begin_layout Description
22918 \begin_inset Flex Code
22921 \begin_layout Plain Layout
22927 CSS style information to be included when this float is used.
22928 Note that this will automatically be wrapped in a layout-generated
22929 \begin_inset Flex Code
22932 \begin_layout Plain Layout
22938 block, so only the CSS itself need be included.
22941 \begin_layout Description
22942 \begin_inset Flex Code
22945 \begin_layout Plain Layout
22952 \begin_inset Flex Code
22955 \begin_layout Plain Layout
22961 ] The tag to be used for this float, replacing
22962 \begin_inset Quotes eld
22966 \begin_inset Flex Code
22969 \begin_layout Plain Layout
22976 \begin_inset Quotes erd
22979 in the example above.
22981 \begin_inset Flex Code
22984 \begin_layout Plain Layout
22990 and will rarely need changing.
22993 \begin_layout Subsection
22994 Bibliography formatting
22997 \begin_layout Standard
22998 The bibliography can be formatted using
22999 \begin_inset Flex Code
23002 \begin_layout Plain Layout
23010 \begin_inset CommandInset ref
23012 reference "subsec:Citation-format-description"
23019 \begin_layout Subsection
23024 \begin_layout Standard
23025 We have several times mentioned that \SpecialChar LyX
23026 will generate default CSS style rules
23027 for both insets and paragraph styles, based upon the other layout information
23029 In this section, we shall say a word about which layout information \SpecialChar LyX
23034 \begin_layout Standard
23035 At present, \SpecialChar LyX
23036 auto-generates CSS only for font information, making use of
23038 \begin_inset Flex Code
23041 \begin_layout Plain Layout
23048 \begin_inset Flex Code
23051 \begin_layout Plain Layout
23058 \begin_inset Flex Code
23061 \begin_layout Plain Layout
23068 \begin_inset Flex Code
23071 \begin_layout Plain Layout
23078 \begin_inset Flex Code
23081 \begin_layout Plain Layout
23088 \begin_inset CommandInset ref
23090 reference "subsec:Font-description"
23095 The translation is mostly straightforward and obvious.
23097 \begin_inset Quotes eld
23101 \begin_inset Flex Code
23104 \begin_layout Plain Layout
23111 \begin_inset Quotes erd
23115 \begin_inset Quotes eld
23119 \begin_inset Flex Code
23122 \begin_layout Plain Layout
23123 font-family: sans-serif;
23129 \begin_inset Quotes erd
23133 The correspondence of \SpecialChar LyX
23134 sizes and CSS sizes is a little less obvious but
23135 nonetheless intuitive.
23137 \begin_inset Flex Code
23140 \begin_layout Plain Layout
23147 \begin_inset Flex URL
23150 \begin_layout Plain Layout
23160 \begin_layout Chapter
23161 Including External Material
23162 \begin_inset CommandInset label
23164 name "chap:Including-External-Material"
23171 \begin_layout Standard
23172 \begin_inset Box Shadowbox
23182 height_special "totalheight"
23187 backgroundcolor "none"
23190 \begin_layout Plain Layout
23191 WARNING: This portion of the documentation has not been updated for some
23193 We certainly hope that it is still accurate, but there are no guarantees.
23201 \begin_layout Standard
23202 The use of material from sources external to \SpecialChar LyX
23203 is covered in detail in the
23209 This part of the manual covers what needs to happen behind the scenes for
23210 new sorts of material to be included.
23213 \begin_layout Section
23217 \begin_layout Standard
23218 The external material feature is based on the concept of a
23223 A template is a specification of how \SpecialChar LyX
23224 should interface with a certain kind
23226 As bundled, \SpecialChar LyX
23227 comes with predefined templates for Xfig figures, various
23228 raster format images, chess diagrams, and LilyPond music notation.
23229 You can check the actual list by using the menu
23230 \begin_inset Flex Noun
23233 \begin_layout Plain Layout
23234 Insert\SpecialChar menuseparator
23235 File\SpecialChar menuseparator
23242 Furthermore, it is possible to roll your own template to support a specific
23244 Later we'll describe in more detail what is involved, and hopefully you
23245 will submit all the templates you create so we can include them in a later
23250 \begin_layout Standard
23251 Another basic idea of the external material feature is to distinguish between
23252 the original file that serves as a base for final material and the produced
23253 file that is included in your exported or printed document.
23254 For example, consider the case of a figure produced with
23255 \begin_inset Flex Code
23258 \begin_layout Plain Layout
23265 The Xfig application itself works on an original file with the
23266 \begin_inset Flex Code
23269 \begin_layout Plain Layout
23276 Within Xfig, you create and change your figure, and when you are done,
23278 \begin_inset Flex Code
23281 \begin_layout Plain Layout
23288 When you want to include the figure in your document, you invoke
23289 \begin_inset Flex Code
23292 \begin_layout Plain Layout
23298 in order to create a PostScript file that can readily be included in your
23302 \begin_inset Flex Code
23305 \begin_layout Plain Layout
23311 file is the original file, and the PostScript file is the produced file.
23314 \begin_layout Standard
23315 This distinction is important in order to allow updating of the material
23316 while you are in the process of writing the document.
23317 Furthermore, it provides us with the flexibility that is needed to support
23318 multiple export formats.
23319 For instance, in the case of a plain text file, it is not exactly an award-winn
23320 ing idea to include the figure as raw PostScript.
23321 Instead, you would either prefer to just include a reference to the figure
23322 or try to invoke some graphics to ASCII converter to make the final result
23323 look similar to the real graphics.
23324 The external material management allows you to do this, because it is parametri
23325 zed on the different export formats that \SpecialChar LyX
23329 \begin_layout Standard
23330 Besides supporting the production of different products according to the
23331 exported format, it supports tight integration with editing and viewing
23333 In the case of an Xfig figure, you are able to invoke Xfig on the original
23334 file with a single click from within the external material dialog in \SpecialChar LyX
23336 and also preview the produced PostScript file with Ghostview with another
23338 No more fiddling around with the command line and/or file browsers to locate
23339 and manipulate the original or produced files.
23340 In this way, you are finally able to take full advantage of the many different
23341 applications that are relevant to use when you write your documents, and
23342 ultimately be more productive.
23345 \begin_layout Section
23346 The external template configuration file
23349 \begin_layout Standard
23350 It is relatively easy to add custom external template definitions to \SpecialChar LyX
23352 However, be aware that doing this in an careless manner most probably
23356 introduce an easily exploitable security hole.
23357 So before you do this, please read the discussion about security in
23358 \begin_inset CommandInset ref
23360 reference "sec:Security-discussion"
23367 \begin_layout Standard
23368 Having said that, we encourage you to submit any interesting templates that
23373 \begin_layout Standard
23374 The external templates are defined in the
23375 \begin_inset Flex Code
23378 \begin_layout Plain Layout
23379 LyXDir/lib/external_templates
23385 You can place your own version in
23386 \begin_inset Flex Code
23389 \begin_layout Plain Layout
23390 UserDir/external_templates
23398 \begin_layout Standard
23399 A typical template looks like this:
23402 \begin_layout LyX-Code
23406 \begin_layout LyX-Code
23407 GuiName "XFig: $$AbsOrRelPathParent$$Basename"
23410 \begin_layout LyX-Code
23414 \begin_layout LyX-Code
23418 \begin_layout LyX-Code
23422 \begin_layout LyX-Code
23426 \begin_layout LyX-Code
23430 \begin_layout LyX-Code
23431 AutomaticProduction true
23434 \begin_layout LyX-Code
23438 \begin_layout LyX-Code
23442 \begin_layout LyX-Code
23446 \begin_layout LyX-Code
23447 TransformCommand Rotate RotationLatexCommand
23450 \begin_layout LyX-Code
23451 TransformCommand Resize ResizeLatexCommand
23454 \begin_layout LyX-Code
23455 Product "$$RotateFront$$ResizeFront
23458 \begin_layout LyX-Code
23463 input{$$AbsOrRelPathMaster$$Basename.pstex_t}
23466 \begin_layout LyX-Code
23467 $$ResizeBack$$RotateBack"
23470 \begin_layout LyX-Code
23474 \begin_layout LyX-Code
23475 UpdateResult "$$AbsPath$$Basename.pstex_t"
23478 \begin_layout LyX-Code
23479 Requirement "graphicx"
23482 \begin_layout LyX-Code
23483 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
23486 \begin_layout LyX-Code
23487 ReferencedFile latex "$$AbsPath$$Basename.eps"
23490 \begin_layout LyX-Code
23491 ReferencedFile dvi "$$AbsPath$$Basename.eps"
23494 \begin_layout LyX-Code
23498 \begin_layout LyX-Code
23502 \begin_layout LyX-Code
23503 TransformCommand Rotate RotationLatexCommand
23506 \begin_layout LyX-Code
23507 TransformCommand Resize ResizeLatexCommand
23510 \begin_layout LyX-Code
23511 Product "$$RotateFront$$ResizeFront
23514 \begin_layout LyX-Code
23519 input{$$AbsOrRelPathMaster$$Basename.pdftex_t}
23522 \begin_layout LyX-Code
23523 $$ResizeBack$$RotateBack"
23526 \begin_layout LyX-Code
23527 UpdateFormat pdftex
23530 \begin_layout LyX-Code
23531 UpdateResult "$$AbsPath$$Basename.pdftex_t"
23534 \begin_layout LyX-Code
23535 Requirement "graphicx"
23538 \begin_layout LyX-Code
23539 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pdftex_t"
23542 \begin_layout LyX-Code
23543 ReferencedFile latex "$$AbsPath$$Basename.pdf"
23546 \begin_layout LyX-Code
23550 \begin_layout LyX-Code
23554 \begin_layout LyX-Code
23555 Product "[XFig: $$FName]"
23558 \begin_layout LyX-Code
23562 \begin_layout LyX-Code
23566 \begin_layout LyX-Code
23567 Product "<graphic fileref=
23569 "$$AbsOrRelPathMaster$$Basename.eps
23574 \begin_layout LyX-Code
23578 \begin_layout LyX-Code
23582 \begin_layout LyX-Code
23583 UpdateResult "$$AbsPath$$Basename.eps"
23586 \begin_layout LyX-Code
23587 ReferencedFile docbook "$$AbsPath$$Basename.eps"
23590 \begin_layout LyX-Code
23591 ReferencedFile docbook-xml "$$AbsPath$$Basename.eps"
23594 \begin_layout LyX-Code
23598 \begin_layout LyX-Code
23602 \begin_layout Standard
23603 As you can see, the template is enclosed in
23604 \begin_inset Flex Code
23607 \begin_layout Plain Layout
23615 \begin_inset Flex Code
23618 \begin_layout Plain Layout
23625 It contains a header specifying some general settings and, for each supported
23626 primary document file format, a section
23627 \begin_inset Flex Code
23630 \begin_layout Plain Layout
23638 \begin_inset Flex Code
23641 \begin_layout Plain Layout
23650 \begin_layout Subsection
23651 The template header
23654 \begin_layout Description
23655 \begin_inset Flex Code
23658 \begin_layout Plain Layout
23659 AutomaticProduction
23660 \begin_inset space ~
23668 Whether the file represented by the template must be generated by \SpecialChar LyX
23670 This command must occur exactly once.
23673 \begin_layout Description
23674 \begin_inset Flex Code
23677 \begin_layout Plain Layout
23679 \begin_inset space ~
23687 A glob pattern that is used in the file dialog to filter out the desired
23689 If there is more than one possible file extension (e.
23690 \begin_inset space \thinspace{}
23694 \begin_inset space \space{}
23698 \begin_inset Flex Code
23701 \begin_layout Plain Layout
23708 \begin_inset Flex Code
23711 \begin_layout Plain Layout
23717 ), use something like
23718 \begin_inset Flex Code
23721 \begin_layout Plain Layout
23728 This command must occur exactly once.
23731 \begin_layout Description
23732 \begin_inset Flex Code
23735 \begin_layout Plain Layout
23737 \begin_inset space ~
23745 The text that is displayed on the button.
23746 This command must occur exactly once.
23749 \begin_layout Description
23750 \begin_inset Flex Code
23753 \begin_layout Plain Layout
23755 \begin_inset space ~
23759 \begin_inset space ~
23767 The help text that is used in the External dialog.
23768 Provide enough information to explain to the user just what the template
23769 can provide him with.
23770 This command must occur exactly once.
23773 \begin_layout Description
23774 \begin_inset Flex Code
23777 \begin_layout Plain Layout
23779 \begin_inset space ~
23787 The file format of the original file.
23788 This must be the name of a format that is known to \SpecialChar LyX
23790 \begin_inset CommandInset ref
23792 reference "sec:Formats"
23798 \begin_inset Quotes eld
23802 \begin_inset Flex Code
23805 \begin_layout Plain Layout
23812 \begin_inset Quotes erd
23815 if the template can handle original files of more than one format.
23817 will attempt to interrogate the file itself in order to deduce its format
23819 This command must occur exactly once.
23822 \begin_layout Description
23823 \begin_inset Flex Code
23826 \begin_layout Plain Layout
23828 \begin_inset space ~
23836 A unique name for the template.
23837 It must not contain substitution macros (see below).
23840 \begin_layout Description
23841 \begin_inset Flex Code
23844 \begin_layout Plain Layout
23846 \begin_inset space ~
23849 Rotate|Resize|Clip|Extra
23854 This command specifies which transformations are supported by this template.
23855 It may occur zero or more times.
23856 This command enables the corresponding tabs in the external dialog.
23858 \begin_inset Flex Code
23861 \begin_layout Plain Layout
23867 command must have either a corresponding
23868 \begin_inset Flex Code
23871 \begin_layout Plain Layout
23878 \begin_inset Flex Code
23881 \begin_layout Plain Layout
23888 \begin_inset Flex Code
23891 \begin_layout Plain Layout
23898 Otherwise the transformation will not be supported by that format.
23901 \begin_layout Subsection
23905 \begin_layout Description
23906 \begin_inset Flex Code
23909 \begin_layout Plain Layout
23911 \begin_inset space ~
23914 LaTeX|PDFLaTeX|PlainText|DocBook|XHTML
23919 The primary document file format that this format definition is for.
23920 Not every template has a sensible representation in all document file formats.
23921 Please define nevertheless a
23922 \begin_inset Flex Code
23925 \begin_layout Plain Layout
23931 section for all templates.
23932 Use a dummy text when no representation is available.
23933 Then you can at least see a reference to the external material in the exported
23937 \begin_layout Description
23938 \begin_inset Flex Code
23941 \begin_layout Plain Layout
23943 \begin_inset space ~
23947 \begin_inset space ~
23955 This command defines an additional macro
23956 \begin_inset Flex Code
23959 \begin_layout Plain Layout
23965 for substitution in
23966 \begin_inset Flex Code
23969 \begin_layout Plain Layout
23977 \begin_inset Flex Code
23980 \begin_layout Plain Layout
23986 itself may contain substitution macros.
23987 The advantage over using
23988 \begin_inset Flex Code
23991 \begin_layout Plain Layout
23998 \begin_inset Flex Code
24001 \begin_layout Plain Layout
24007 is that the substituted value of
24008 \begin_inset Flex Code
24011 \begin_layout Plain Layout
24017 is sanitized so that it is a valid optional argument in the document format.
24018 This command may occur zero or more times.
24021 \begin_layout Description
24022 \begin_inset Flex Code
24025 \begin_layout Plain Layout
24027 \begin_inset space ~
24035 The text that is inserted in the exported document.
24036 This is actually the most important command and can be quite complex.
24037 This command must occur exactly once.
24040 \begin_layout Description
24041 \begin_inset Flex Code
24044 \begin_layout Plain Layout
24046 \begin_inset space ~
24054 This command specifies a preamble snippet that will be included in the
24057 It has to be defined using
24058 \begin_inset Flex Code
24061 \begin_layout Plain Layout
24069 \begin_inset Flex Code
24072 \begin_layout Plain Layout
24079 This command may occur zero or more times.
24082 \begin_layout Description
24083 \begin_inset Flex Code
24086 \begin_layout Plain Layout
24088 \begin_inset space ~
24092 \begin_inset space ~
24100 This command denotes files that are created by the conversion process and
24101 are needed for a particular export format.
24102 If the filename is relative, it is interpreted relative to the master document.
24103 This command may be given zero or more times.
24106 \begin_layout Description
24107 \begin_inset Flex Code
24110 \begin_layout Plain Layout
24112 \begin_inset space ~
24120 The name of a required \SpecialChar LaTeX
24122 The package is included via
24123 \begin_inset Flex Code
24126 \begin_layout Plain Layout
24134 in the \SpecialChar LaTeX
24136 This command may occur zero or more times.
24139 \begin_layout Description
24140 \begin_inset Flex Code
24143 \begin_layout Plain Layout
24145 \begin_inset space ~
24149 \begin_inset space ~
24152 RotationLatexCommand
24157 This command specifies that the built in \SpecialChar LaTeX
24158 command should be used for rotation.
24159 This command may occur once or not at all.
24162 \begin_layout Description
24163 \begin_inset Flex Code
24166 \begin_layout Plain Layout
24168 \begin_inset space ~
24172 \begin_inset space ~
24180 This command specifies that the built in \SpecialChar LaTeX
24181 command should be used for resizing.
24182 This command may occur once or not at all.
24185 \begin_layout Description
24186 \begin_inset Flex Code
24189 \begin_layout Plain Layout
24191 \begin_inset space ~
24195 \begin_inset space ~
24198 RotationLatexOption
24203 This command specifies that rotation is done via an optional argument.
24204 This command may occur once or not at all.
24207 \begin_layout Description
24208 \begin_inset Flex Code
24211 \begin_layout Plain Layout
24213 \begin_inset space ~
24217 \begin_inset space ~
24225 This command specifies that resizing is done via an optional argument.
24226 This command may occur once or not at all.
24229 \begin_layout Description
24230 \begin_inset Flex Code
24233 \begin_layout Plain Layout
24235 \begin_inset space ~
24239 \begin_inset space ~
24247 This command specifies that clipping is done via an optional argument.
24248 This command may occur once or not at all.
24251 \begin_layout Description
24252 \begin_inset Flex Code
24255 \begin_layout Plain Layout
24257 \begin_inset space ~
24261 \begin_inset space ~
24269 This command specifies that an extra optional argument is used.
24270 This command may occur once or not at all.
24273 \begin_layout Description
24274 \begin_inset Flex Code
24277 \begin_layout Plain Layout
24279 \begin_inset space ~
24287 The file format of the converted file.
24288 This must be the name of a format that is known to \SpecialChar LyX
24290 \begin_inset Flex Noun
24293 \begin_layout Plain Layout
24294 Tools\SpecialChar menuseparator
24295 Preferences\SpecialChar menuseparator
24296 File Handling\SpecialChar menuseparator
24303 This command must occur exactly once.
24304 If the resulting file format is PDF, you need to specify the format
24305 \begin_inset Flex Code
24308 \begin_layout Plain Layout
24315 This is the PDF format used for including graphics.
24316 The other defined PDF formats are for document export.
24319 \begin_layout Description
24320 \begin_inset Flex Code
24323 \begin_layout Plain Layout
24325 \begin_inset space ~
24333 The file name of the converted file.
24334 The file name must be absolute.
24335 This command must occur exactly once.
24338 \begin_layout Subsection
24339 Preamble definitions
24342 \begin_layout Standard
24343 The external template configuration file may contain additional preamble
24344 definitions enclosed by
24345 \begin_inset Flex Code
24348 \begin_layout Plain Layout
24356 \begin_inset Flex Code
24359 \begin_layout Plain Layout
24366 They can be used by the templates in the
24367 \begin_inset Flex Code
24370 \begin_layout Plain Layout
24379 \begin_layout Section
24380 The substitution mechanism
24383 \begin_layout Standard
24384 When the external material facility invokes an external program, it is done
24385 on the basis of a command defined in the template configuration file.
24386 These commands can contain various macros that are expanded before execution.
24387 Execution always take place in the directory of the containing document.
24390 \begin_layout Standard
24391 Also, whenever external material is to be displayed, the name will be produced
24392 by the substitution mechanism, and most other commands in the template
24393 definition support substitution as well.
24396 \begin_layout Standard
24397 The available macros are the following:
24400 \begin_layout Description
24401 \begin_inset Flex Code
24404 \begin_layout Plain Layout
24405 $$AbsOrRelPathMaster
24410 The file path, absolute or relative to the master \SpecialChar LyX
24414 \begin_layout Description
24415 \begin_inset Flex Code
24418 \begin_layout Plain Layout
24419 $$AbsOrRelPathParent
24424 The file path, absolute or relative to the \SpecialChar LyX
24428 \begin_layout Description
24429 \begin_inset Flex Code
24432 \begin_layout Plain Layout
24438 The absolute file path.
24441 \begin_layout Description
24442 \begin_inset Flex Code
24445 \begin_layout Plain Layout
24451 The filename without path and without the extension.
24454 \begin_layout Description
24455 \begin_inset Flex Code
24458 \begin_layout Plain Layout
24460 \begin_inset Quotes eld
24464 \begin_inset Quotes erd
24472 This macro will expand to the contents of the file with the name
24473 \begin_inset Flex Code
24476 \begin_layout Plain Layout
24485 \begin_layout Description
24486 \begin_inset Flex Code
24489 \begin_layout Plain Layout
24495 The file extension (including the dot).
24498 \begin_layout Description
24499 \begin_inset Flex Code
24502 \begin_layout Plain Layout
24508 This will be the string
24509 \begin_inset Quotes eld
24513 \begin_inset Quotes erd
24516 if the file is in JPEG format, otherwise it will be the string
24517 \begin_inset Quotes eld
24521 \begin_inset Quotes erd
24525 This is useful to avoid uneeded conversions for output formats that support
24526 both PNG and JPEG fomats.
24527 The predefined RasterImage template uses this macro for the pdf\SpecialChar TeX
24532 \begin_layout Description
24533 \begin_inset Flex Code
24536 \begin_layout Plain Layout
24542 The filename of the file specified in the external material dialog.
24543 This is either an absolute name, or it is relative to the \SpecialChar LyX
24547 \begin_layout Description
24548 \begin_inset Flex Code
24551 \begin_layout Plain Layout
24558 \begin_inset Flex Code
24561 \begin_layout Plain Layout
24567 (absolute name or relative to the \SpecialChar LyX
24571 \begin_layout Description
24572 \begin_inset Flex Code
24575 \begin_layout Plain Layout
24581 The file path, relative to the master \SpecialChar LyX
24585 \begin_layout Description
24586 \begin_inset Flex Code
24589 \begin_layout Plain Layout
24595 The file path, relative to the \SpecialChar LyX
24599 \begin_layout Description
24600 \begin_inset Flex Code
24603 \begin_layout Plain Layout
24609 This macro will expand to the absolute path of the system directory.
24610 This is typically used to point to the various helper scripts that are
24611 bundled with \SpecialChar LyX
24615 \begin_layout Description
24616 \begin_inset Flex Code
24619 \begin_layout Plain Layout
24625 A name and full path to a temporary file which will be automatically deleted
24626 whenever the containing document is closed, or the external material insertion
24630 \begin_layout Standard
24631 All path macros contain a trailing directory separator, so you can construct
24633 \begin_inset space \thinspace{}
24637 \begin_inset space \space{}
24640 the absolute filename with
24641 \begin_inset Flex Code
24644 \begin_layout Plain Layout
24645 $$AbsPath$$Basename$$Extension
24653 \begin_layout Standard
24654 The macros above are substituted in all commands unless otherwise noted.
24656 \begin_inset Flex Code
24659 \begin_layout Plain Layout
24665 supports additionally the following substitutions if they are enabled by
24667 \begin_inset Flex Code
24670 \begin_layout Plain Layout
24677 \begin_inset Flex Code
24680 \begin_layout Plain Layout
24689 \begin_layout Description
24690 \begin_inset Flex Code
24693 \begin_layout Plain Layout
24699 The front part of the resize command.
24702 \begin_layout Description
24703 \begin_inset Flex Code
24706 \begin_layout Plain Layout
24712 The back part of the resize command.
24715 \begin_layout Description
24716 \begin_inset Flex Code
24719 \begin_layout Plain Layout
24725 The front part of the rotation command.
24728 \begin_layout Description
24729 \begin_inset Flex Code
24732 \begin_layout Plain Layout
24738 The back part of the rotation command.
24741 \begin_layout Standard
24742 The value string of the
24743 \begin_inset Flex Code
24746 \begin_layout Plain Layout
24752 command supports additionally the following substitutions if they are enabled
24754 \begin_inset Flex Code
24757 \begin_layout Plain Layout
24764 \begin_inset Flex Code
24767 \begin_layout Plain Layout
24776 \begin_layout Description
24777 \begin_inset Flex Code
24780 \begin_layout Plain Layout
24789 \begin_layout Description
24790 \begin_inset Flex Code
24793 \begin_layout Plain Layout
24802 \begin_layout Description
24803 \begin_inset Flex Code
24806 \begin_layout Plain Layout
24815 \begin_layout Description
24816 \begin_inset Flex Code
24819 \begin_layout Plain Layout
24825 The rotation option.
24828 \begin_layout Standard
24829 You may ask why there are so many path macros.
24830 There are mainly two reasons:
24833 \begin_layout Enumerate
24834 Relative and absolute file names should remain relative or absolute, respectivel
24836 Users may have reasons to prefer either form.
24837 Relative names are useful for portable documents that should work on different
24838 machines, for example.
24839 Absolute names may be required by some programs.
24842 \begin_layout Enumerate
24844 treats relative file names differently than \SpecialChar LyX
24845 and other programs in nested
24847 For \SpecialChar LyX
24848 , a relative file name is always relative to the document that contains
24850 For \SpecialChar LaTeX
24851 , it is always relative to the master document.
24852 These two definitions are identical if you have only one document, but
24853 differ if you have a master document that includes part documents.
24854 That means that relative filenames must be transformed when presented to
24857 Fortunately \SpecialChar LyX
24858 does this automatically for you if you choose the right macros.
24861 \begin_layout Standard
24862 So which path macro should be used in new template definitions? The rule
24866 \begin_layout Itemize
24868 \begin_inset Flex Code
24871 \begin_layout Plain Layout
24877 if an absolute path is required.
24880 \begin_layout Itemize
24882 \begin_inset Flex Code
24885 \begin_layout Plain Layout
24886 $$AbsOrRelPathMaster
24891 if the substituted string is some kind of \SpecialChar LaTeX
24895 \begin_layout Itemize
24897 \begin_inset Flex Code
24900 \begin_layout Plain Layout
24901 $$AbsOrRelPathParent
24906 in order to preserve the user's choice.
24909 \begin_layout Standard
24910 There are special cases where this rule does not work and e.
24911 \begin_inset space \thinspace{}
24915 \begin_inset space \space{}
24918 relative names are needed, but normally it will work just fine.
24919 One example for such a case is the command
24920 \begin_inset Flex Code
24923 \begin_layout Plain Layout
24924 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
24929 in the XFig template above: We can't use the absolute name because the
24931 \begin_inset Flex Code
24934 \begin_layout Plain Layout
24940 files needs the relative name in order to rewrite the file content.
24943 \begin_layout Section
24944 Security discussion
24945 \begin_inset CommandInset label
24947 name "sec:Security-discussion"
24954 \begin_layout Standard
24955 The external material feature interfaces with a lot of external programs
24956 and does so automatically, so we have to consider the security implications
24958 In particular, since you have the option of including your own filenames
24959 and/or parameter strings and those are expanded into a command, it seems
24960 that it would be possible to create a malicious document which executes
24961 arbitrary commands when a user views or prints the document.
24962 This is something we definitely want to avoid.
24965 \begin_layout Standard
24966 However, since the external program commands are specified in the template
24967 configuration file only, there are no security issues if \SpecialChar LyX
24968 is properly configure
24969 d with safe templates only.
24970 This is so because the external programs are invoked with the
24971 \begin_inset Flex Code
24974 \begin_layout Plain Layout
24980 -system call rather than the
24981 \begin_inset Flex Code
24984 \begin_layout Plain Layout
24990 system-call, so it's not possible to execute arbitrary commands from the
24991 filename or parameter section via the shell.
24994 \begin_layout Standard
24995 This also implies that you are restricted in what command strings you can
24996 use in the external material templates.
24997 In particular, pipes and redirection are not readily available.
24998 This has to be so if \SpecialChar LyX
24999 should remain safe.
25000 If you want to use some of the shell features, you should write a safe
25001 script to do this in a controlled manner, and then invoke the script from
25002 the command string.
25006 \begin_layout Standard
25007 It is possible to design a template that interacts directly with the shell,
25008 but since this would allow a malicious user to execute arbitrary commands
25009 by writing clever filenames and/or parameters, we generally recommend that
25010 you only use safe scripts that work with the
25011 \begin_inset Flex Code
25014 \begin_layout Plain Layout
25020 system call in a controlled manner.
25021 Of course, for use in a controlled environment, it can be tempting to just
25022 fall back to use ordinary shell scripts.
25023 If you do so, be aware that you
25027 provide an easily exploitable security hole in your system.
25028 Of course it stands to reason that such unsafe templates will never be
25029 included in the standard \SpecialChar LyX
25030 distribution, although we do encourage people
25031 to submit new templates in the open source tradition.
25032 But \SpecialChar LyX
25033 as shipped from the official distribution channels will never have
25037 \begin_layout Standard
25038 Including external material provides a lot of power, and you have to be
25039 careful not to introduce security hazards with this power.
25040 A subtle error in a single line in an innocent looking script can open
25041 the door to huge security problems.
25042 So if you do not fully understand the issues, we recommend that you consult
25043 a knowledgeable security professional or the \SpecialChar LyX
25044 development team if you have
25045 any questions about whether a given template is safe or not.
25046 And do this before you use it in an uncontrolled environment.
25049 \begin_layout Chapter
25051 List of supported \SpecialChar LyX
25052 functions to be used in layouts
25053 \begin_inset CommandInset label
25055 name "chap:List-of-functions"
25062 \begin_layout Standard
25064 \begin_inset Tabular
25065 <lyxtabular version="3" rows="11" columns="8">
25066 <features tabularvalignment="middle">
25067 <column alignment="left" valignment="top">
25068 <column alignment="left" valignment="top">
25069 <column alignment="left" valignment="top">
25070 <column alignment="left" valignment="top">
25071 <column alignment="left" valignment="top">
25072 <column alignment="left" valignment="top">
25073 <column alignment="left" valignment="top">
25074 <column alignment="left" valignment="top">
25076 <cell alignment="left" valignment="top" usebox="none">
25079 \begin_layout Plain Layout
25085 <cell alignment="left" valignment="top" usebox="none">
25088 \begin_layout Plain Layout
25094 <cell alignment="left" valignment="top" usebox="none">
25097 \begin_layout Plain Layout
25103 <cell alignment="left" valignment="top" usebox="none">
25106 \begin_layout Plain Layout
25112 <cell alignment="center" valignment="top" usebox="none">
25115 \begin_layout Plain Layout
25121 <cell alignment="center" valignment="top" usebox="none">
25124 \begin_layout Plain Layout
25130 <cell alignment="center" valignment="top" usebox="none">
25133 \begin_layout Plain Layout
25139 <cell alignment="center" valignment="top" usebox="none">
25142 \begin_layout Plain Layout
25150 <cell alignment="left" valignment="top" usebox="none">
25153 \begin_layout Plain Layout
25159 <cell alignment="left" valignment="top" usebox="none">
25162 \begin_layout Plain Layout
25168 <cell alignment="left" valignment="top" usebox="none">
25171 \begin_layout Plain Layout
25177 <cell alignment="left" valignment="top" usebox="none">
25180 \begin_layout Plain Layout
25186 <cell alignment="center" valignment="top" usebox="none">
25189 \begin_layout Plain Layout
25195 <cell alignment="center" valignment="top" usebox="none">
25198 \begin_layout Plain Layout
25204 <cell alignment="center" valignment="top" usebox="none">
25207 \begin_layout Plain Layout
25213 <cell alignment="center" valignment="top" usebox="none">
25216 \begin_layout Plain Layout
25224 <cell alignment="left" valignment="top" usebox="none">
25227 \begin_layout Plain Layout
25233 <cell alignment="left" valignment="top" usebox="none">
25236 \begin_layout Plain Layout
25242 <cell alignment="left" valignment="top" usebox="none">
25245 \begin_layout Plain Layout
25251 <cell alignment="left" valignment="top" usebox="none">
25254 \begin_layout Plain Layout
25260 <cell alignment="center" valignment="top" usebox="none">
25263 \begin_layout Plain Layout
25269 <cell alignment="center" valignment="top" usebox="none">
25272 \begin_layout Plain Layout
25278 <cell alignment="center" valignment="top" usebox="none">
25281 \begin_layout Plain Layout
25287 <cell alignment="center" valignment="top" usebox="none">
25290 \begin_layout Plain Layout
25298 <cell alignment="left" valignment="top" usebox="none">
25301 \begin_layout Plain Layout
25307 <cell alignment="left" valignment="top" usebox="none">
25310 \begin_layout Plain Layout
25316 <cell alignment="left" valignment="top" usebox="none">
25319 \begin_layout Plain Layout
25325 <cell alignment="left" valignment="top" usebox="none">
25328 \begin_layout Plain Layout
25334 <cell alignment="center" valignment="top" usebox="none">
25337 \begin_layout Plain Layout
25343 <cell alignment="center" valignment="top" usebox="none">
25346 \begin_layout Plain Layout
25352 <cell alignment="center" valignment="top" usebox="none">
25355 \begin_layout Plain Layout
25361 <cell alignment="center" valignment="top" usebox="none">
25364 \begin_layout Plain Layout
25372 <cell alignment="left" valignment="top" usebox="none">
25375 \begin_layout Plain Layout
25381 <cell alignment="left" valignment="top" usebox="none">
25384 \begin_layout Plain Layout
25390 <cell alignment="left" valignment="top" usebox="none">
25393 \begin_layout Plain Layout
25399 <cell alignment="left" valignment="top" usebox="none">
25402 \begin_layout Plain Layout
25408 <cell alignment="center" valignment="top" usebox="none">
25411 \begin_layout Plain Layout
25417 <cell alignment="center" valignment="top" usebox="none">
25420 \begin_layout Plain Layout
25426 <cell alignment="center" valignment="top" usebox="none">
25429 \begin_layout Plain Layout
25435 <cell alignment="center" valignment="top" usebox="none">
25438 \begin_layout Plain Layout
25446 <cell alignment="left" valignment="top" usebox="none">
25449 \begin_layout Plain Layout
25455 <cell alignment="left" valignment="top" usebox="none">
25458 \begin_layout Plain Layout
25464 <cell alignment="left" valignment="top" usebox="none">
25467 \begin_layout Plain Layout
25473 <cell alignment="left" valignment="top" usebox="none">
25476 \begin_layout Plain Layout
25482 <cell alignment="center" valignment="top" usebox="none">
25485 \begin_layout Plain Layout
25491 <cell alignment="center" valignment="top" usebox="none">
25494 \begin_layout Plain Layout
25500 <cell alignment="center" valignment="top" usebox="none">
25503 \begin_layout Plain Layout
25509 <cell alignment="center" valignment="top" usebox="none">
25512 \begin_layout Plain Layout
25520 <cell alignment="left" valignment="top" usebox="none">
25523 \begin_layout Plain Layout
25529 <cell alignment="left" valignment="top" usebox="none">
25532 \begin_layout Plain Layout
25538 <cell alignment="left" valignment="top" usebox="none">
25541 \begin_layout Plain Layout
25547 <cell alignment="left" valignment="top" usebox="none">
25550 \begin_layout Plain Layout
25556 <cell alignment="center" valignment="top" usebox="none">
25559 \begin_layout Plain Layout
25565 <cell alignment="center" valignment="top" usebox="none">
25568 \begin_layout Plain Layout
25574 <cell alignment="center" valignment="top" usebox="none">
25577 \begin_layout Plain Layout
25583 <cell alignment="center" valignment="top" usebox="none">
25586 \begin_layout Plain Layout
25594 <cell alignment="left" valignment="top" usebox="none">
25597 \begin_layout Plain Layout
25603 <cell alignment="left" valignment="top" usebox="none">
25606 \begin_layout Plain Layout
25612 <cell alignment="left" valignment="top" usebox="none">
25615 \begin_layout Plain Layout
25621 <cell alignment="left" valignment="top" usebox="none">
25624 \begin_layout Plain Layout
25630 <cell alignment="center" valignment="top" usebox="none">
25633 \begin_layout Plain Layout
25639 <cell alignment="center" valignment="top" usebox="none">
25642 \begin_layout Plain Layout
25648 <cell alignment="center" valignment="top" usebox="none">
25651 \begin_layout Plain Layout
25657 <cell alignment="center" valignment="top" usebox="none">
25660 \begin_layout Plain Layout
25668 <cell alignment="left" valignment="top" usebox="none">
25671 \begin_layout Plain Layout
25677 <cell alignment="left" valignment="top" usebox="none">
25680 \begin_layout Plain Layout
25686 <cell alignment="left" valignment="top" usebox="none">
25689 \begin_layout Plain Layout
25695 <cell alignment="left" valignment="top" usebox="none">
25698 \begin_layout Plain Layout
25704 <cell alignment="center" valignment="top" usebox="none">
25707 \begin_layout Plain Layout
25713 <cell alignment="center" valignment="top" usebox="none">
25716 \begin_layout Plain Layout
25722 <cell alignment="center" valignment="top" usebox="none">
25725 \begin_layout Plain Layout
25731 <cell alignment="center" valignment="top" usebox="none">
25734 \begin_layout Plain Layout
25742 <cell alignment="left" valignment="top" usebox="none">
25745 \begin_layout Plain Layout
25751 <cell alignment="left" valignment="top" usebox="none">
25754 \begin_layout Plain Layout
25760 <cell alignment="left" valignment="top" usebox="none">
25763 \begin_layout Plain Layout
25769 <cell alignment="left" valignment="top" usebox="none">
25772 \begin_layout Plain Layout
25778 <cell alignment="center" valignment="top" usebox="none">
25781 \begin_layout Plain Layout
25787 <cell alignment="center" valignment="top" usebox="none">
25790 \begin_layout Plain Layout
25796 <cell alignment="center" valignment="top" usebox="none">
25799 \begin_layout Plain Layout
25805 <cell alignment="center" valignment="top" usebox="none">
25808 \begin_layout Plain Layout
25816 <cell alignment="center" valignment="top" usebox="none">
25819 \begin_layout Plain Layout
25825 <cell alignment="center" valignment="top" usebox="none">
25828 \begin_layout Plain Layout
25834 <cell alignment="center" valignment="top" usebox="none">
25837 \begin_layout Plain Layout
25843 <cell alignment="center" valignment="top" usebox="none">
25846 \begin_layout Plain Layout
25852 <cell alignment="center" valignment="top" usebox="none">
25855 \begin_layout Plain Layout
25861 <cell alignment="center" valignment="top" usebox="none">
25864 \begin_layout Plain Layout
25870 <cell alignment="center" valignment="top" usebox="none">
25873 \begin_layout Plain Layout
25879 <cell alignment="center" valignment="top" usebox="none">
25882 \begin_layout Plain Layout
25896 \begin_layout Chapter
25897 Names of available colors to be used in layouts
25898 \begin_inset CommandInset label
25900 name "chap:Names-of-colors"
25907 \begin_layout Standard
25908 The colors listed here are the standard colors and the those that you can
25909 adjust in the \SpecialChar LyX
25913 \begin_layout Description
25926 No particular color – clear or default
25929 \begin_layout Description
25933 \begin_layout Description
25937 \begin_layout Description
25941 \begin_layout Description
25945 \begin_layout Description
25949 \begin_layout Description
25953 \begin_layout Description
25957 \begin_layout Description
25961 \begin_layout Description
25962 added_space Added space marker color
25965 \begin_layout Description
25966 addedtext Added text color
25969 \begin_layout Description
25970 appendix Appendix marker color
25973 \begin_layout Description
25974 background Background color
25977 \begin_layout Description
25978 bottomarea Bottom area color
25981 \begin_layout Description
25982 branchlabel Label color for branches
25985 \begin_layout Description
25986 buttonbg Color used for button background
25989 \begin_layout Description
25990 buttonhoverbg Color used for button background under focus
25993 \begin_layout Description
25994 buttonframe Color for inset button frames
25997 \begin_layout Description
25998 changebar Changebar color
26001 \begin_layout Description
26002 changedtextauthor1 Changed text color author 1
26005 \begin_layout Description
26006 changedtextauthor2 Changed text color author 2
26009 \begin_layout Description
26010 changedtextauthor3 Changed text color author 3
26013 \begin_layout Description
26014 changedtextauthor4 Changed text color author 4
26017 \begin_layout Description
26018 changedtextauthor5 Changed text color author 5
26021 \begin_layout Description
26022 collapsable_inset_frame Collapsable insets framecolor
26025 \begin_layout Description
26026 collapsable_inset_text Collapsable insets text color
26029 \begin_layout Description
26030 command Text color for command insets
26033 \begin_layout Description
26034 commandbg Background color for command insets
26037 \begin_layout Description
26038 commandframe Frame color for command insets
26041 \begin_layout Description
26042 comment color for comments
26045 \begin_layout Description
26046 commentbg Background color of comments
26049 \begin_layout Description
26050 cursor Cursor color
26053 \begin_layout Description
26054 deletedtext Deleted text color
26057 \begin_layout Description
26058 deletedtextmodifier Deleted text modifying color
26061 \begin_layout Description
26062 depthbar Color for the depth bars in the margin
26065 \begin_layout Description
26066 eolmarker End of line marker color
26069 \begin_layout Description
26070 error Color of the \SpecialChar LaTeX
26074 \begin_layout Description
26075 footlabel Label color for footnotes
26078 \begin_layout Description
26079 graphicsbg Graphics inset background color
26082 \begin_layout Description
26083 greyedout Label color for greyedout insets
26086 \begin_layout Description
26087 greyedoutbg Background color of greyedout inset
26090 \begin_layout Description
26091 greyedouttext Color for greyedout inset text
26094 \begin_layout Description
26095 indexlabel Label color for index insets
26098 \begin_layout Description
26099 ignore The color is ignored
26102 \begin_layout Description
26103 inherit The color is inherited
26106 \begin_layout Description
26107 inlinecompletion Inline completion color
26110 \begin_layout Description
26111 insetbg Inset marker background color
26114 \begin_layout Description
26115 insetframe Inset marker frame color
26118 \begin_layout Description
26119 language Color for marking foreign language words
26122 \begin_layout Description
26123 latex Text color in \SpecialChar LaTeX
26127 \begin_layout Description
26128 listingsbg Background color of listings inset
26131 \begin_layout Description
26132 marginlabel Label color for margin notes
26135 \begin_layout Description
26136 math Math inset text color
26139 \begin_layout Description
26140 mathbg Math inset background color
26143 \begin_layout Description
26144 mathcorners Math inset frame color not under focus
26147 \begin_layout Description
26148 mathframe Math inset frame color under focus
26151 \begin_layout Description
26152 mathline Math line color
26155 \begin_layout Description
26156 mathmacrobg Macro math inset background color
26159 \begin_layout Description
26160 mathmacroblend Macro math blended color
26163 \begin_layout Description
26164 mathmacroframe Macro math frame color
26167 \begin_layout Description
26168 mathmacrohoverbg Macro math inset background color hovered
26171 \begin_layout Description
26172 mathmacrolabel Macro math label color
26175 \begin_layout Description
26176 mathmacronewarg Macro template color for new parameters
26179 \begin_layout Description
26180 mathmacrooldarg Macro template color for old parameters
26183 \begin_layout Description
26184 newpage New page color
26187 \begin_layout Description
26188 nonunique_inlinecompletion Inline completion color for the non-unique part
26191 \begin_layout Description
26192 notebg Background color of notes
26195 \begin_layout Description
26196 notelabel Label color for notes
26199 \begin_layout Description
26200 pagebreak Page break/line break color
26203 \begin_layout Description
26204 paragraphmarker Color used for the pilcrow sign to mark the end of a paragraph
26207 \begin_layout Description
26208 phantomtext Text color for phantom insets
26211 \begin_layout Description
26212 preview The color used for previews
26215 \begin_layout Description
26216 previewframe Preview frame color
26219 \begin_layout Description
26220 regexpframe Color for regexp frame
26223 \begin_layout Description
26224 selection Background color of selected text
26227 \begin_layout Description
26228 selectiontext Foreground color of selected text
26231 \begin_layout Description
26232 shadedbg Background color of shaded box
26235 \begin_layout Description
26236 special Special chars text color
26239 \begin_layout Description
26240 tabularline Table line color
26243 \begin_layout Description
26244 tabularonoffline Table line color
26247 \begin_layout Description
26248 urllabel Label color for URL insets
26251 \begin_layout Description
26252 urltext Color for URL inset text