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 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 \use_dash_ligatures true
62 \default_output_format pdf2
64 \bibtex_command default
65 \index_command default
69 \pdf_title "LyX Configuration Manual"
70 \pdf_author "LyX Team"
71 \pdf_subject "LyX-documentation Customization"
72 \pdf_keywords "LyX, documentation, customization"
74 \pdf_bookmarksnumbered true
75 \pdf_bookmarksopen true
76 \pdf_bookmarksopenlevel 1
81 \pdf_pdfusetitle false
82 \pdf_quoted_options "linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue,pdfpagelayout=OneColumn, pdfnewwindow=true, pdfstartview=XYZ, plainpages=false"
85 \use_package amsmath 1
86 \use_package amssymb 1
89 \use_package mathdots 1
90 \use_package mathtools 1
92 \use_package stackrel 1
93 \use_package stmaryrd 1
94 \use_package undertilde 1
96 \cite_engine_type default
100 \paperorientation portrait
105 \notefontcolor #0000ff
117 \paragraph_separation indent
118 \paragraph_indentation default
120 \math_indentation default
121 \math_numbering_side default
122 \quotes_style english
126 \paperpagestyle headings
127 \tracking_changes true
128 \output_changes false
132 \author -712698321 "Jürgen Spitzmüller"
138 Customizing \SpecialChar LyX
139 : Features for the Advanced User
143 by the \SpecialChar LyX
148 \begin_layout Plain Layout
150 If you have comments or error corrections, please send them to the \SpecialChar LyX
153 \begin_inset CommandInset href
155 target "lyx-docs@lists.lyx.org"
163 \begin_inset Quotes eld
167 \begin_inset Quotes erd
170 in the subject header, and please cc the current maintainer of this file,
171 Richard Heck <rgheck@comcast.net>.
177 \begin_inset Newline newline
181 \begin_inset Newline newline
187 \begin_layout Standard
188 \begin_inset CommandInset toc
189 LatexCommand tableofcontents
196 \begin_layout Standard
197 \begin_inset Note Note
200 \begin_layout Plain Layout
201 Please use change tracking when modifying this document.
202 This makes it easier for our translators to recognize things that have
203 been changed, and it helps the maintainer keep up-to-date with what's been
212 \begin_layout Chapter
216 \begin_layout Standard
217 This manual covers the customization features present in \SpecialChar LyX
219 In it, we discuss issues like keyboard shortcuts, screen previewing options,
220 printer options, sending commands to \SpecialChar LyX
221 via the \SpecialChar LyX
222 Server, internationalization,
223 installing new \SpecialChar LaTeX
224 classes and \SpecialChar LyX
226 We can't possibly hope to touch on everything you can change—our developers
227 add new features faster than we can document them—but we will explain the
228 most common customizations and hopefully point you in the right direction
229 for some of the more obscure ones.
232 \begin_layout Standard
233 \begin_inset Branch OutDated
237 \begin_layout Standard
238 Information from previous versions of this document that now seems to be
239 outdated is contained in the OutDated branch of this document.
240 By default, this information will not appear in the \SpecialChar LaTeX
249 \begin_layout Chapter
254 \begin_layout Standard
255 This chapter aims to help you to find your way through the \SpecialChar LyX
258 Before continuing to read this chapter, you should find out where your
260 library and user directories are by using
261 \begin_inset Flex Noun
264 \begin_layout Plain Layout
265 Help\SpecialChar menuseparator
276 The library directory is the place where \SpecialChar LyX
277 places its system-wide configuration
278 files; the user directory is where you can place your modified versions.
279 We will call the former
280 \begin_inset Flex Code
283 \begin_layout Plain Layout
290 \begin_inset Flex Noun
293 \begin_layout Plain Layout
299 in the remainder of this document.
303 \begin_layout Section
305 \begin_inset Flex Code
308 \begin_layout Plain Layout
317 \begin_layout Standard
318 \begin_inset Flex Code
321 \begin_layout Plain Layout
327 and its sub-directories contain a number of files and that can be used
328 to customize \SpecialChar LyX
330 You can change many of these files from within \SpecialChar LyX
332 \begin_inset Flex Noun
335 \begin_layout Plain Layout
336 Tools\SpecialChar menuseparator
343 Most customization that you will want to do in \SpecialChar LyX
344 is possible through this
346 However, many other inner aspects of \SpecialChar LyX
347 can be customized by modifying the
349 \begin_inset Flex Code
352 \begin_layout Plain Layout
359 These files fall in different categories, described in the following subsection
363 \begin_layout Subsection
364 Automatically generated files
367 \begin_layout Standard
368 The files, which are to be found in
369 \begin_inset Flex Noun
372 \begin_layout Plain Layout
378 , are generated when you configure \SpecialChar LyX
380 They contain various default values that are guessed by inspection.
381 In general, it is not a good idea to modify them, since they might be overwritt
385 \begin_layout Labeling
386 \labelwidthstring 00.00.0000
387 \begin_inset Flex Code
390 \begin_layout Plain Layout
396 contains defaults for various commands.
399 \begin_layout Labeling
400 \labelwidthstring 00.00.0000
401 \begin_inset Flex Code
404 \begin_layout Plain Layout
410 contains the list of packages that have been recognized by \SpecialChar LyX
412 It is currently unused by the \SpecialChar LyX
413 program itself, but the information extracted,
414 and more, is made available with
415 \begin_inset Flex Noun
418 \begin_layout Plain Layout
419 Help\SpecialChar menuseparator
433 \begin_layout Labeling
434 \labelwidthstring 00.00.0000
435 \begin_inset Flex Code
438 \begin_layout Plain Layout
444 the list of text classes that have been found in your
445 \begin_inset Flex Code
448 \begin_layout Plain Layout
454 directories, along with the associated \SpecialChar LaTeX
455 document class and their description.
458 \begin_layout Labeling
459 \labelwidthstring 00.00.0000
460 \begin_inset Flex Code
463 \begin_layout Plain Layout
469 the list of layout modules found in your
470 \begin_inset Flex Code
473 \begin_layout Plain Layout
482 \begin_layout Labeling
483 \labelwidthstring 00.00.0000
484 \begin_inset Flex Code
487 \begin_layout Plain Layout
493 lists of various sorts of \SpecialChar LaTeX
494 -related files found on your system
497 \begin_layout Labeling
498 \labelwidthstring 00.00.0000
499 \begin_inset Flex Code
502 \begin_layout Plain Layout
503 doc/\SpecialChar LaTeX
509 is automatically generated during configuration from the file
510 \begin_inset Flex Code
513 \begin_layout Plain Layout
521 It contains information on your \SpecialChar LaTeX
525 \begin_layout Subsection
529 \begin_layout Standard
530 These directories are duplicated between
531 \begin_inset Flex Code
534 \begin_layout Plain Layout
541 \begin_inset Flex Code
544 \begin_layout Plain Layout
551 If a particular files exists in both places, the one in
552 \begin_inset Flex Code
555 \begin_layout Plain Layout
564 \begin_layout Labeling
565 \labelwidthstring 00.00.0000
566 \begin_inset Flex Code
569 \begin_layout Plain Layout
575 this directory contains files with the extension
576 \begin_inset Flex Code
579 \begin_layout Plain Layout
585 that define the keybindings used in \SpecialChar LyX
587 If there exists an internationalized version of the bind file named
588 \begin_inset Flex Code
591 \begin_layout Plain Layout
597 , that will be used first.
600 \begin_layout Labeling
601 \labelwidthstring 00.00.0000
602 \begin_inset Flex Code
605 \begin_layout Plain Layout
611 contains files with the extension
612 \begin_inset Flex Code
615 \begin_layout Plain Layout
621 which define the diverse citation possibilities (natbib, biblatex etc.).
623 \begin_inset CommandInset ref
625 reference "subsec:Cite-Engine-Files"
635 \begin_layout Labeling
636 \labelwidthstring 00.00.0000
637 \begin_inset Flex Code
640 \begin_layout Plain Layout
646 contains graphics files that can be included in documents.
650 \begin_layout Labeling
651 \labelwidthstring 00.00.0000
652 \begin_inset Flex Code
655 \begin_layout Plain Layout
661 contains \SpecialChar LyX
662 documentation files (including the one you are currently reading).
664 \begin_inset Flex Code
667 \begin_layout Plain Layout
674 deserves special attention, as noted above.
675 The internationalized help docs are in subdirectories
676 \begin_inset Flex Code
679 \begin_layout Plain Layout
686 \begin_inset Quotes eld
690 \begin_inset Quotes erd
693 is the ISO language code.
695 \begin_inset CommandInset ref
697 reference "cha:Internationalizing-LyX"
704 \begin_layout Labeling
705 \labelwidthstring 00.00.0000
706 \begin_inset Flex Code
709 \begin_layout Plain Layout
715 contains example files that explain how to use some features.
716 In the file browser, press the
717 \begin_inset Flex Noun
720 \begin_layout Plain Layout
729 \begin_layout Labeling
730 \labelwidthstring 00.00.0000
731 \begin_inset Flex Code
734 \begin_layout Plain Layout
740 contains image files that are used by the
741 \begin_inset Flex Noun
744 \begin_layout Plain Layout
751 In addition, it also contains the individual icons used in the toolbar
752 and the banners that can be shown when \SpecialChar LyX
756 \begin_layout Labeling
757 \labelwidthstring 00.00.0000
758 \begin_inset Flex Code
761 \begin_layout Plain Layout
767 contains keyboard keymapping files.
769 \begin_inset CommandInset ref
771 reference "sec:International-Keymap-Stuff"
778 \begin_layout Labeling
779 \labelwidthstring 00.00.0000
780 \begin_inset Flex Code
783 \begin_layout Plain Layout
789 contains the text class and module files described in
790 \begin_inset CommandInset ref
792 reference "cha:Installing-New-Document"
799 \begin_layout Labeling
800 \labelwidthstring 00.00.0000
801 \begin_inset Flex Code
804 \begin_layout Plain Layout
811 \begin_inset Flex Code
814 \begin_layout Plain Layout
820 Python scripts used to convert between \SpecialChar LyX
822 These can be run from the command line if, say, you want to batch-convert
826 \begin_layout Labeling
827 \labelwidthstring 00.00.0000
828 \begin_inset Flex Code
831 \begin_layout Plain Layout
837 contains some files that demonstrate the capabilities of the
838 \begin_inset Flex Noun
841 \begin_layout Plain Layout
852 Also contains some scripts used by \SpecialChar LyX
856 \begin_layout Labeling
857 \labelwidthstring 00.00.0000
858 \begin_inset Flex Code
861 \begin_layout Plain Layout
867 contains the standard \SpecialChar LyX
868 template files described in
869 \begin_inset CommandInset ref
871 reference "subsec:Creating-Templates"
878 \begin_layout Labeling
879 \labelwidthstring 00.00.0000
880 \begin_inset Flex Code
883 \begin_layout Plain Layout
889 contains files with the extension
890 \begin_inset Flex Code
893 \begin_layout Plain Layout
899 that define the user interface to \SpecialChar LyX
901 That is, the files define which items appear in which menus and the items
902 appearing on the toolbar.
905 \begin_layout Labeling
906 \labelwidthstring 00.00.0000
907 \begin_inset Flex Code
910 \begin_layout Plain Layout
916 contains files with the extension
917 \begin_inset Flex Code
920 \begin_layout Plain Layout
926 which define the templates for the insertion of external material to a
929 \begin_inset CommandInset ref
931 reference "chap:Including-External-Material"
938 \begin_layout Subsection
939 Files you don't want to modify
942 \begin_layout Standard
943 These files are used internally by \SpecialChar LyX
944 and you generally do not need to modify
945 them unless you are a developer.
948 \begin_layout Labeling
949 \labelwidthstring 00.00.0000
950 \begin_inset Flex Code
953 \begin_layout Plain Layout
959 this file contains the list of \SpecialChar LyX
961 The contents are displayed with the menu entry
962 \begin_inset Flex Noun
965 \begin_layout Plain Layout
966 Help\SpecialChar menuseparator
979 \begin_layout Labeling
980 \labelwidthstring 00.00.0000
981 \begin_inset Flex Code
984 \begin_layout Plain Layout
990 this is a \SpecialChar LaTeX
991 script used during the configuration process.
995 \begin_layout Labeling
996 \labelwidthstring 00.00.0000
997 \begin_inset Flex Code
1000 \begin_layout Plain Layout
1006 this is a Python script that is used to re-configure \SpecialChar LyX
1008 It creates configuration files in the directory it was run from.
1011 \begin_layout Subsection
1012 Other files needing a line or two
1015 \begin_layout Labeling
1016 \labelwidthstring 00.00.0000
1017 \begin_inset Flex Code
1020 \begin_layout Plain Layout
1026 this contains tables describing how different character encodings can be
1030 \begin_layout Labeling
1031 \labelwidthstring 00.00.0000
1032 \begin_inset Flex Code
1035 \begin_layout Plain Layout
1041 this file contains a list of all the languages currently supported by \SpecialChar LyX
1045 \begin_layout Labeling
1046 \labelwidthstring 00.00.0000
1047 \begin_inset Flex Code
1050 \begin_layout Plain Layout
1056 contains information about the supported fonts.
1059 \begin_layout Labeling
1060 \labelwidthstring 00.00.0000
1061 \begin_inset Flex Code
1064 \begin_layout Plain Layout
1070 this file contains translations for internationalized paragraph styles
1072 \begin_inset CommandInset ref
1074 reference "subsec:I18n"
1081 \begin_layout Labeling
1082 \labelwidthstring 00.00.0000
1083 \begin_inset Flex Code
1086 \begin_layout Plain Layout
1092 this file contains information about Unicode-encoded glyphs and the way
1093 they are supported by \SpecialChar LyX
1094 via \SpecialChar LaTeX
1098 \begin_layout Section
1099 Your local configuration directory
1102 \begin_layout Standard
1103 Even if you are using \SpecialChar LyX
1104 as an unprivileged user, you might want to change
1106 configuration for your own use.
1108 \begin_inset Flex Code
1111 \begin_layout Plain Layout
1117 directory contains all your personal configuration files.
1118 This is the directory described as
1119 \begin_inset Quotes eld
1123 \begin_inset Quotes erd
1127 \begin_inset Flex Noun
1130 \begin_layout Plain Layout
1131 Help\SpecialChar menuseparator
1133 \begin_inset space ~
1142 This directory is used as a mirror of
1143 \begin_inset Flex Code
1146 \begin_layout Plain Layout
1152 , which means that every file in
1153 \begin_inset Flex Code
1156 \begin_layout Plain Layout
1162 is a replacement for the corresponding file in
1163 \begin_inset Flex Code
1166 \begin_layout Plain Layout
1173 Any configuration file described in the above sections can be placed either
1174 in the system-wide directory, in which case it will affect all users, or
1175 in your local directory for your own use.
1178 \begin_layout Standard
1179 To make things clearer, let's provide a few examples:
1182 \begin_layout Itemize
1183 The preferences set in the
1184 \begin_inset Flex Noun
1187 \begin_layout Plain Layout
1188 Tools\SpecialChar menuseparator
1194 dialog are saved to a file
1195 \begin_inset Flex Code
1198 \begin_layout Plain Layout
1205 \begin_inset Flex Code
1208 \begin_layout Plain Layout
1217 \begin_layout Itemize
1218 When you reconfigure using
1219 \begin_inset Flex Noun
1222 \begin_layout Plain Layout
1223 Tools\SpecialChar menuseparator
1231 \begin_inset Flex Code
1234 \begin_layout Plain Layout
1240 script, and the resulting files are written in your local configuration
1242 This means that any additional text class file that you might have added
1244 \begin_inset Flex Code
1247 \begin_layout Plain Layout
1253 will be added to the list of classes in the
1254 \begin_inset Flex Noun
1257 \begin_layout Plain Layout
1258 Document\SpecialChar menuseparator
1267 \begin_layout Itemize
1268 If you get some updated documentation from \SpecialChar LyX
1269 ftp site and cannot install
1270 it because you do not have sysadmin rights on your system, you can just
1272 \begin_inset Flex Code
1275 \begin_layout Plain Layout
1281 and the items in the
1282 \begin_inset Flex Noun
1285 \begin_layout Plain Layout
1291 menu will open them!
1294 \begin_layout Section
1295 Running \SpecialChar LyX
1296 with multiple configurations
1299 \begin_layout Standard
1300 The configuration freedom of the local configuration directory may not suffice
1301 if you want to have more than one configuration at your disposal.
1302 For example, you may want to be use different key bindings or printer settings
1304 You can achieve this by having several such directories.
1305 You then specify which directory to use at run-time.
1308 \begin_layout Standard
1309 Invoking \SpecialChar LyX
1310 with the command line switch
1311 \begin_inset Flex Code
1314 \begin_layout Plain Layout
1324 instructs the program to read the configuration from that directory, and
1325 not from the default directory.
1326 (You can determine the default directory by running \SpecialChar LyX
1328 \begin_inset Flex Code
1331 \begin_layout Plain Layout
1337 switch.) If the specified directory does not exist, \SpecialChar LyX
1339 for you, just like it does for the default directory on the first time
1340 you run the program.
1341 You can modify the configuration options in this additional user directory
1342 exactly as you would for the default directory.
1343 These directories are completely independent (but read on).
1344 Note that setting the environment variable
1345 \begin_inset Flex Code
1348 \begin_layout Plain Layout
1354 to some value has exactly the same effect.
1357 \begin_layout Standard
1358 Having several configurations also requires more maintenance: if you want
1359 to add a new layout to
1360 \begin_inset Flex Code
1363 \begin_layout Plain Layout
1369 which you want available from all your configurations, you must add it
1370 to each directory separately.
1371 You can avoid this with the following trick: after \SpecialChar LyX
1372 creates the additional
1373 directory, most of the subdirectories (see above) are empty.
1374 If you want the new configuration to mirror an existing one, replace the
1375 empty subdirectory with a symbolic link to the matching subdirectory in
1376 the existing configuration.
1378 \begin_inset Flex Code
1381 \begin_layout Plain Layout
1387 subdirectory, however, since it contains a file written by the configuration
1388 script (also accessible through
1389 \begin_inset Flex Noun
1392 \begin_layout Plain Layout
1393 Tools\SpecialChar menuseparator
1399 ) which is configuration-specific.
1402 \begin_layout Chapter
1403 The Preferences dialog
1406 \begin_layout Standard
1407 All options of the preferences dialog are described in the Appendix
1409 The Preferences Dialog
1416 For some options you might find here more details.
1419 \begin_layout Section
1421 \begin_inset CommandInset label
1430 \begin_layout Standard
1431 The first step is to define your file formats if they are not already defined.
1433 \begin_inset Flex Noun
1436 \begin_layout Plain Layout
1437 Tools\SpecialChar menuseparator
1445 \begin_inset Flex Noun
1448 \begin_layout Plain Layout
1449 File Handling\SpecialChar menuseparator
1456 \begin_inset Flex Noun
1459 \begin_layout Plain Layout
1465 button to define your new format.
1467 \begin_inset Flex Noun
1470 \begin_layout Plain Layout
1476 field contains the name used to identify the format in the GUI.
1478 \begin_inset Flex Noun
1481 \begin_layout Plain Layout
1487 is used to identify the format internally.
1488 You will also need to enter a file extension.
1489 These are all required.
1491 \begin_inset Flex Noun
1494 \begin_layout Plain Layout
1500 field is used to provide a keyboard shortcut on the menus.
1501 (For example, pressing
1502 \begin_inset Flex Noun
1505 \begin_layout Plain Layout
1512 \begin_inset Flex Noun
1515 \begin_layout Plain Layout
1516 Document\SpecialChar menuseparator
1517 View (Other Formats)\SpecialChar menuseparator
1526 \begin_layout Standard
1528 \begin_inset Flex Noun
1531 \begin_layout Plain Layout
1538 \begin_inset Flex Noun
1541 \begin_layout Plain Layout
1548 For example, you might want to use
1549 \begin_inset Flex Noun
1552 \begin_layout Plain Layout
1558 to view PostScript files.
1559 You can enter the command needed to start the program in the corresponding
1561 In defining this command, you can use the four variables listed in the
1563 The viewer is launched when you view an image in \SpecialChar LyX
1565 \begin_inset Flex Noun
1568 \begin_layout Plain Layout
1569 Document\SpecialChar menuseparator
1576 The editor is for example launched when you right-click on an image and
1578 \begin_inset Flex Noun
1581 \begin_layout Plain Layout
1587 in the appearing context menu.
1590 \begin_layout Standard
1592 \begin_inset Flex Noun
1595 \begin_layout Plain Layout
1601 type of a format is optional, but if it is specified, it must be unique
1603 It is used to detect files of this format from the file contents.
1604 For some important file formats there is no MIME type officially registered
1606 \begin_inset CommandInset href
1609 target "http://www.iana.org/assignments/media-types/"
1615 Therefore \SpecialChar LyX
1616 uses the extended list of MIME types as specified by
1617 \begin_inset CommandInset href
1619 name "freedesktop.org"
1620 target "http://www.freedesktop.org/wiki/Specifications/shared-mime-info-spec"
1628 \begin_layout Standard
1630 \begin_inset Flex Noun
1633 \begin_layout Plain Layout
1639 option tells \SpecialChar LyX
1640 that a format is suitable for document export.
1641 If this is set and if a suitable conversion route exists (see
1642 \begin_inset CommandInset ref
1644 reference "sec:Converters"
1648 ), the format will appear in the
1649 \begin_inset Flex Noun
1652 \begin_layout Plain Layout
1653 File\SpecialChar menuseparator
1660 The format will also appear in the
1661 \begin_inset Flex Noun
1664 \begin_layout Plain Layout
1665 Document\SpecialChar menuseparator
1671 menu if a viewer is specified for the format.
1672 Pure image formats, such as
1673 \begin_inset Flex Code
1676 \begin_layout Plain Layout
1682 , should not use this option.
1683 Formats that can both represent vector graphics and documents like
1684 \begin_inset Flex Code
1687 \begin_layout Plain Layout
1696 \begin_layout Standard
1698 \begin_inset Flex Noun
1701 \begin_layout Plain Layout
1702 Vector graphics format
1707 tells \SpecialChar LyX
1708 that a format can contain vector graphics.
1709 This information is used to determine the target format of included graphics
1711 \begin_inset Flex Noun
1714 \begin_layout Plain Layout
1721 Included graphics may need to be converted to either
1722 \begin_inset Flex Noun
1725 \begin_layout Plain Layout
1732 \begin_inset Flex Noun
1735 \begin_layout Plain Layout
1742 \begin_inset Flex Noun
1745 \begin_layout Plain Layout
1752 \begin_inset Flex Noun
1755 \begin_layout Plain Layout
1761 cannot handle other image formats.
1762 If an included graphic is not already in
1763 \begin_inset Flex Noun
1766 \begin_layout Plain Layout
1773 \begin_inset Flex Noun
1776 \begin_layout Plain Layout
1783 \begin_inset Flex Noun
1786 \begin_layout Plain Layout
1792 format, it is converted to
1793 \begin_inset Flex Noun
1796 \begin_layout Plain Layout
1802 if the vector format option is set, and otherwise to
1803 \begin_inset Flex Noun
1806 \begin_layout Plain Layout
1815 \begin_layout Section
1819 \begin_layout Standard
1820 Since all conversions from one format to another take place in \SpecialChar LyX
1822 directory, it is sometimes necessary to modify a file before copying it
1823 to the temporary directory in order that the conversion may be performed.
1827 \begin_layout Plain Layout
1828 For example, the file may refer to other files—images, for example—using
1829 relative file names, and these may become invalid when the file is copied
1830 to the temporary directory.
1835 This is done by a Copier: It copies a file to (or from) the temporary directory
1836 and may modify it in the process.
1839 \begin_layout Standard
1840 The definitions of the copiers may use eight variables:
1843 \begin_layout Labeling
1844 \labelwidthstring 00.00.0000
1845 \begin_inset Flex Code
1848 \begin_layout Plain Layout
1854 The \SpecialChar LyX
1855 system directory (e.
1856 \begin_inset space \thinspace{}
1860 \begin_inset space \space{}
1864 \begin_inset Flex Noun
1867 \begin_layout Plain Layout
1876 \begin_layout Labeling
1877 \labelwidthstring 00.00.0000
1878 \begin_inset Flex Code
1881 \begin_layout Plain Layout
1890 \begin_layout Labeling
1891 \labelwidthstring 00.00.0000
1892 \begin_inset Flex Code
1895 \begin_layout Plain Layout
1904 \begin_layout Labeling
1905 \labelwidthstring 00.00.0000
1906 \begin_inset Flex Code
1909 \begin_layout Plain Layout
1915 The base name (without filename extension) in the \SpecialChar LyX
1919 \begin_layout Labeling
1920 \labelwidthstring 00.00.0000
1921 \begin_inset Flex Code
1924 \begin_layout Plain Layout
1930 The full directory path of the \SpecialChar LyX
1934 \begin_layout Labeling
1935 \labelwidthstring 00.00.0000
1936 \begin_inset Flex Code
1939 \begin_layout Plain Layout
1945 The full pathname to the original \SpecialChar LyX
1946 file being processed
1949 \begin_layout Labeling
1950 \labelwidthstring 00.00.0000
1951 \begin_inset Flex Code
1954 \begin_layout Plain Layout
1960 The filename (without any directory path) of the \SpecialChar LyX
1964 \begin_layout Labeling
1965 \labelwidthstring 00.00.0000
1966 \begin_inset Flex Code
1969 \begin_layout Plain Layout
1975 The `\SpecialChar LaTeX
1979 \begin_layout Standard
1980 The latter should be the filename as it would be used in a \SpecialChar LaTeX
1988 It is relevant only when exporting files suitable for such inclusion.
1991 \begin_layout Standard
1992 Copiers can be used to do almost anything with output files.
1993 For example, suppose you want generated pdf files to be copied to a special
1995 \begin_inset Flex Code
1998 \begin_layout Plain Layout
2005 Then you could write a shell script such as this one:
2008 \begin_layout Standard
2009 \begin_inset listings
2013 \begin_layout Plain Layout
2018 \begin_layout Plain Layout
2023 \begin_layout Plain Layout
2025 TOFILE=`basename $2`
2028 \begin_layout Plain Layout
2030 cp $FROMFILE /home/you/pdf/$TOFILE
2035 Save it in your local \SpecialChar LyX
2037 \begin_inset Flex Code
2040 \begin_layout Plain Layout
2041 /home/you/.lyx/scripts/pdfcopier.sh
2046 —and make it executable, if you need to do so on your platform.
2048 \begin_inset Flex Noun
2051 \begin_layout Plain Layout
2052 Tools\SpecialChar menuseparator
2058 dialog, select under
2059 \begin_inset Flex Noun
2062 \begin_layout Plain Layout
2063 File Handling\SpecialChar menuseparator
2070 \begin_inset Flex Noun
2073 \begin_layout Plain Layout
2079 format—or one of the other pdf formats—and enter
2080 \begin_inset Flex Code
2083 \begin_layout Plain Layout
2084 pdfcopier.sh $$i $$o
2090 \begin_inset Flex Noun
2093 \begin_layout Plain Layout
2103 \begin_layout Standard
2104 Copiers are used by \SpecialChar LyX
2105 in various of its own conversions.
2106 For example, if appropriate programs are found, \SpecialChar LyX
2107 will automatically install
2109 \begin_inset Flex Noun
2112 \begin_layout Plain Layout
2119 \begin_inset Flex Noun
2122 \begin_layout Plain Layout
2124 \begin_inset space ~
2133 When these formats are exported, the copier sees that not just the main
2134 HTML file but various associated files (style files, images, etc.) are also
2136 All these files are written to a subdirectory of the directory in which
2137 the original \SpecialChar LyX
2142 \begin_layout Plain Layout
2143 This copier can be customized.
2145 \begin_inset Quotes eld
2149 \begin_inset Quotes erd
2152 argument takes a comma-separated list of extensions to be copied; if it
2153 is omitted, all files will be copied.
2155 \begin_inset Quotes eld
2159 \begin_inset Quotes erd
2162 argument determines the extension added to the generated directory.
2164 \begin_inset Quotes eld
2168 \begin_inset Flex Noun
2171 \begin_layout Plain Layout
2178 \begin_inset Quotes erd
2181 , so HTML generated from
2182 \begin_inset Flex Noun
2185 \begin_layout Plain Layout
2186 /path/to/filename.lyx
2192 \begin_inset Flex Noun
2195 \begin_layout Plain Layout
2196 /path/to/filename.html.LyXconv
2210 \begin_layout Section
2212 \begin_inset CommandInset label
2214 name "sec:Converters"
2221 \begin_layout Standard
2222 You can define your own Converters to convert files between different formats.
2224 \begin_inset Flex Noun
2227 \begin_layout Plain Layout
2228 Tools\SpecialChar menuseparator
2229 Preferences\SpecialChar menuseparator
2230 File Handling\SpecialChar menuseparator
2239 \begin_layout Standard
2240 To define a new converter, select the
2241 \begin_inset Flex Noun
2244 \begin_layout Plain Layout
2246 \begin_inset space ~
2255 \begin_inset Flex Noun
2258 \begin_layout Plain Layout
2260 \begin_inset space ~
2268 from the drop-down lists, enter the command needed for the conversion,
2270 \begin_inset Flex Noun
2273 \begin_layout Plain Layout
2280 Several variables can be used in the definition of converters:
2283 \begin_layout Labeling
2284 \labelwidthstring 00.00.0000
2285 \begin_inset Flex Code
2288 \begin_layout Plain Layout
2294 The \SpecialChar LyX
2298 \begin_layout Labeling
2299 \labelwidthstring 00.00.0000
2300 \begin_inset Flex Code
2303 \begin_layout Plain Layout
2312 \begin_layout Labeling
2313 \labelwidthstring 00.00.0000
2314 \begin_inset Flex Code
2317 \begin_layout Plain Layout
2326 \begin_layout Labeling
2327 \labelwidthstring 00.00.0000
2328 \begin_inset Flex Code
2331 \begin_layout Plain Layout
2337 The base filename of the input file (i.
2338 \begin_inset space \thinspace{}
2341 g., without the extension)
2344 \begin_layout Labeling
2345 \labelwidthstring 00.00.0000
2346 \begin_inset Flex Code
2349 \begin_layout Plain Layout
2355 The path to the input file
2358 \begin_layout Labeling
2359 \labelwidthstring 00.00.0000
2360 \begin_inset Flex Code
2363 \begin_layout Plain Layout
2369 The path to the original input file (this is different from $$p when a
2370 chain of converters is called)
2373 \begin_layout Labeling
2374 \labelwidthstring 00.00.0000
2375 \begin_inset Flex Code
2378 \begin_layout Plain Layout
2384 The iconv name for the encoding of the document.
2387 \begin_layout Standard
2389 \begin_inset Flex Noun
2392 \begin_layout Plain Layout
2394 \begin_inset space ~
2402 field you can enter the following flags, separated by commas:
2405 \begin_layout Labeling
2406 \labelwidthstring 00.00.0000
2407 \begin_inset Flex Code
2410 \begin_layout Plain Layout
2416 This converter runs some form of \SpecialChar LaTeX
2418 This will make \SpecialChar LyX
2419 's \SpecialChar LaTeX
2420 error logs available.
2423 \begin_layout Labeling
2424 \labelwidthstring 00.00.0000
2425 \begin_inset Flex Code
2428 \begin_layout Plain Layout
2434 Needs the \SpecialChar LaTeX
2436 \begin_inset Flex Noun
2439 \begin_layout Plain Layout
2445 file for the conversion.
2448 \begin_layout Labeling
2449 \labelwidthstring 00.00.0000
2450 \begin_inset Flex Code
2453 \begin_layout Plain Layout
2460 \begin_inset Quotes eld
2464 \begin_inset Quotes erd
2467 file from the backend, which in practice means a \SpecialChar LaTeX
2468 file like the one we
2469 would export, without
2470 \begin_inset Flex Code
2473 \begin_layout Plain Layout
2482 \begin_layout Labeling
2483 \labelwidthstring 00.00.0000
2484 \begin_inset Flex Code
2487 \begin_layout Plain Layout
2496 \begin_layout Standard
2497 The following three flags are not really flags at all because they take
2499 \begin_inset Flex Noun
2502 \begin_layout Plain Layout
2504 \begin_inset space ~
2508 \begin_inset space ~
2519 \begin_layout Labeling
2520 \labelwidthstring 00.00.0000
2521 \begin_inset Flex Code
2524 \begin_layout Plain Layout
2530 If set, the converter's standard error will be redirected to a file
2531 \begin_inset Flex Code
2534 \begin_layout Plain Layout
2540 , and the script given as argument will be run as:
2541 \begin_inset Flex Code
2544 \begin_layout Plain Layout
2545 script < infile.out > infile.log
2551 The argument may contain
2552 \begin_inset Flex Code
2555 \begin_layout Plain Layout
2564 \begin_layout Labeling
2565 \labelwidthstring 00.00.0000
2566 \begin_inset Flex Code
2569 \begin_layout Plain Layout
2575 The name of the directory in which the converter will dump the generated
2578 will not create this directory, and it does not copy anything into it,
2579 though it will copy this directory to the destination.
2580 The argument may contain
2581 \begin_inset Flex Code
2584 \begin_layout Plain Layout
2590 , which will be replaced by the base name of the input and output files,
2591 respectively, when the directory is copied.
2592 \begin_inset Newline newline
2595 Note that resultdir and usetempdir make no sense together.
2596 The latter will be ignored if the former is given.
2599 \begin_layout Labeling
2600 \labelwidthstring 00.00.0000
2601 \begin_inset Flex Code
2604 \begin_layout Plain Layout
2610 Determines the output file name and may, contain
2611 \begin_inset Flex Code
2614 \begin_layout Plain Layout
2621 Sensible only with resultdir and optional even then; if not given, it defaults
2625 \begin_layout Standard
2626 None of these last three are presently used in any of the converters that
2627 are installed with \SpecialChar LyX
2632 \begin_layout Standard
2633 You do not have to define converters for all formats between which you want
2635 For example, you will note that there is no `\SpecialChar LyX
2636 to PostScript' converter,
2637 but \SpecialChar LyX
2638 will export PostScript.
2639 It does so by first creating a \SpecialChar LaTeX
2640 file (no converter needs to be defined
2641 for this) which is then converted to DVI using the `\SpecialChar LaTeX
2643 and finally converting the resulting DVI file to PostScript.
2645 finds such `chains' of converters automatically, and it will always choose
2646 the shortest possible chain.
2647 You can, though, still define multiple conversion methods between file
2649 For example, the standard \SpecialChar LyX
2650 configuration provides five ways to convert
2655 \begin_layout Enumerate
2657 \begin_inset Flex Noun
2660 \begin_layout Plain Layout
2669 \begin_layout Enumerate
2670 via (DVI and) PostScript, using
2671 \begin_inset Flex Noun
2674 \begin_layout Plain Layout
2683 \begin_layout Enumerate
2685 \begin_inset Flex Noun
2688 \begin_layout Plain Layout
2697 \begin_layout Enumerate
2699 \begin_inset Flex Noun
2702 \begin_layout Plain Layout
2712 \begin_layout Enumerate
2714 \begin_inset Flex Noun
2717 \begin_layout Plain Layout
2727 \begin_layout Standard
2728 To define such alternate chains, you must define multiple target `file formats',
2730 \begin_inset CommandInset ref
2732 reference "sec:Formats"
2737 For example, in the standard configuration, the formats named
2738 \begin_inset Flex Noun
2741 \begin_layout Plain Layout
2748 \begin_inset Flex Noun
2751 \begin_layout Plain Layout
2758 \begin_inset Flex Noun
2761 \begin_layout Plain Layout
2768 \begin_inset Flex Noun
2771 \begin_layout Plain Layout
2778 \begin_inset Flex Noun
2781 \begin_layout Plain Layout
2788 \begin_inset Flex Noun
2791 \begin_layout Plain Layout
2798 \begin_inset Flex Noun
2801 \begin_layout Plain Layout
2808 \begin_inset Flex Noun
2811 \begin_layout Plain Layout
2819 \begin_inset Flex Noun
2822 \begin_layout Plain Layout
2829 \begin_inset Flex Noun
2832 \begin_layout Plain Layout
2839 ) are defined, all of which share the extension
2840 \begin_inset Flex Noun
2843 \begin_layout Plain Layout
2849 , and which correspond to the conversion methods just mentioned.
2852 \begin_layout Chapter
2853 Internationalizing \SpecialChar LyX
2855 \begin_inset CommandInset label
2857 name "cha:Internationalizing-LyX"
2864 \begin_layout Standard
2866 supports using a translated interface.
2867 Last time we checked, \SpecialChar LyX
2868 provided text in thirty languages.
2869 The language of choice is called your
2874 (For further reading on locale settings, see also the documentation for
2875 locale that comes with your operating system.
2876 For Linux, the manual page for
2877 \begin_inset Flex Code
2880 \begin_layout Plain Layout
2886 could be a good place to start).
2889 \begin_layout Standard
2890 Notice that these translations will work, but do contain a few flaws.
2891 In particular, all dialogs have been designed with the English text in
2892 mind, which means that some of the translated text will be too large to
2893 fit within the space allocated.
2894 This is only a display problem and will not cause any harm.
2895 Also, you will find that some of the translations do not define shortcut
2896 keys for everything.
2897 Sometimes, there are simply not enough free letters to do it.
2898 Other times, the translator just hasn't got around to doing it yet.
2899 Our localization team, which you may wish to join,
2903 \begin_layout Plain Layout
2904 If you are a fluent speaker of a language other than English, joining these
2905 teams is a great way to give back to the \SpecialChar LyX
2911 will of course try to fix these shortcomings in future versions of \SpecialChar LyX
2915 \begin_layout Section
2916 Translating \SpecialChar LyX
2920 \begin_layout Subsection
2921 Translating the graphical user interface (text messages).
2924 \begin_layout Standard
2927 \begin_inset Flex Code
2930 \begin_layout Plain Layout
2936 library to handle the internationalization of the interface.
2937 To have \SpecialChar LyX
2938 speak your favorite language in all menus and dialogs, you need
2940 \begin_inset Flex Code
2943 \begin_layout Plain Layout
2949 -file for that language.
2950 When this is available, you'll have to generate a
2951 \begin_inset Flex Code
2954 \begin_layout Plain Layout
2960 -file from it and install the
2961 \begin_inset Flex Code
2964 \begin_layout Plain Layout
2971 The process of doing all of this is explained in the documentation for
2973 \begin_inset Flex Code
2976 \begin_layout Plain Layout
2983 It is possible to do this just for yourself, but if you're going to do
2984 it, you might as well share the results of your labors with the rest of
2985 the \SpecialChar LyX
2987 Send a message to the \SpecialChar LyX
2988 developers' list for more information about how
2992 \begin_layout Standard
2993 In short, this is what you should do (xx denotes the language code):
2996 \begin_layout Itemize
2997 Check out the \SpecialChar LyX
3000 \begin_inset CommandInset href
3002 name "information on the web"
3003 target "https://www.lyx.org/HowToUseGIT"
3011 \begin_layout Itemize
3013 \begin_inset Flex Code
3016 \begin_layout Plain Layout
3022 to the folder of the
3023 \begin_inset Flex Code
3026 \begin_layout Plain Layout
3034 \begin_inset Flex Code
3037 \begin_layout Plain Layout
3045 \begin_inset Flex Code
3048 \begin_layout Plain Layout
3054 doesn't exist anywhere, it can be remade with the console command
3055 \begin_inset Flex Code
3058 \begin_layout Plain Layout
3064 in that directory, or you can use an existing po-file for some other language
3068 \begin_layout Itemize
3070 \begin_inset Flex Code
3073 \begin_layout Plain Layout
3083 \begin_layout Plain Layout
3084 This is just a text file, so it can be edited in any text editor.
3085 But there are also specialized programs that support such editing, such
3090 (for all platforms) or
3099 contains a `mode' for editing
3100 \begin_inset Flex Code
3103 \begin_layout Plain Layout
3110 \begin_inset Flex URL
3113 \begin_layout Plain Layout
3115 https://www.gnu.org/software/gettext/manual/html_node/PO-Mode.html
3127 For some menu- and widget-labels, there are also shortcut keys that should
3129 Those keys are marked after a `|', and should be translated according to
3130 the words and phrases of the language.
3131 You should also fill also out the information at the beginning of the new
3133 \begin_inset Flex Code
3136 \begin_layout Plain Layout
3142 -file with your email-address, etc., so people know where to reach you with
3143 suggestions and entertaining flames.
3146 \begin_layout Standard
3147 If you are just doing this on your own, then:
3150 \begin_layout Itemize
3152 \begin_inset Flex Code
3155 \begin_layout Plain Layout
3162 This can be done with
3163 \begin_inset Flex Code
3166 \begin_layout Plain Layout
3167 msgfmt -o xx.mo < xx.po
3175 \begin_layout Itemize
3177 \begin_inset Flex Code
3180 \begin_layout Plain Layout
3186 -file to your locale-tree, at the correct directory for application messages
3191 xx, and under the name
3192 \begin_inset Flex Code
3195 \begin_layout Plain Layout
3202 \begin_inset space \thinspace{}
3206 \begin_inset space \space{}
3210 \begin_inset Flex Code
3213 \begin_layout Plain Layout
3214 /usr/local/share/locale/xx/LC_MESSAGES/lyx.mo
3224 \begin_layout Standard
3225 As said, however, it would be best if the new
3226 \begin_inset Flex Code
3229 \begin_layout Plain Layout
3235 file could be added to the \SpecialChar LyX
3236 distribution, so others can use it.
3237 Adding it involves making additional changes to \SpecialChar LyX
3239 So send an email to the developers' mailing list if you're interested in
3243 \begin_layout Subsubsection
3247 \begin_layout Standard
3248 Sometimes it turns out that one English message needs to be translated into
3249 different messages in the target language.
3250 One example is the message
3251 \begin_inset Flex Code
3254 \begin_layout Plain Layout
3260 which has the German translation
3268 , depending upon exactly what the English
3269 \begin_inset Quotes eld
3273 \begin_inset Quotes erd
3278 \begin_inset Flex Code
3281 \begin_layout Plain Layout
3287 does not handle such ambiguous translations.
3288 Therefore you have to add some context information to the message: Instead
3290 \begin_inset Flex Code
3293 \begin_layout Plain Layout
3300 \begin_inset Flex Code
3303 \begin_layout Plain Layout
3304 To[[as in 'From format x to format y']]
3310 \begin_inset Flex Code
3313 \begin_layout Plain Layout
3314 To[[as in 'From page x to page y']].
3319 Now the two occurrences of
3320 \begin_inset Flex Code
3323 \begin_layout Plain Layout
3330 \begin_inset Flex Code
3333 \begin_layout Plain Layout
3339 and can be translated correctly to
3350 \begin_layout Standard
3351 Of course the context information needs to be stripped off the original
3352 message when no translation is used.
3353 Therefore you have to put it in double square brackets at the end of the
3354 message (see the example above).
3355 The translation mechanism of \SpecialChar LyX
3356 ensures that everything in double square
3357 brackets at the end of messages is removed before displaying the message.
3360 \begin_layout Subsection
3361 Translating the documentation.
3364 \begin_layout Standard
3365 The online documentation (in the
3366 \begin_inset Flex Noun
3369 \begin_layout Plain Layout
3375 -menu) can (and should!) be translated.
3376 If there are translated versions of the documentation available
3380 \begin_layout Plain Layout
3381 As of March 2008, at least some of the documents have been translated into
3382 fourteen languages, with the Tutorial available in a few more.
3387 and the locale is set accordingly, these will be used automagically by
3391 looks for translated versions as
3392 \begin_inset Flex Code
3395 \begin_layout Plain Layout
3396 LyXDir/doc/xx/DocName.lyx
3402 \begin_inset Flex Code
3405 \begin_layout Plain Layout
3411 is the code for the language currently in use.
3412 If there are no translated documents, the default English versions will
3414 Note that the translated versions must have the same filenames (
3415 \begin_inset Flex Code
3418 \begin_layout Plain Layout
3424 above) as the original.
3425 If you feel up to translating the documentation (an excellent way to proof-read
3426 the original documentation by the way!), there are a few things you should
3430 \begin_layout Itemize
3431 Check out the documentation translation web page at
3432 \begin_inset CommandInset href
3434 name "https://www.lyx.org/Translation"
3435 target "https://www.lyx.org/Translation"
3441 That way, you can find out which (if any) documents have already been translate
3442 d into your language.
3443 You can also find out who (if anyone) is organizing the effort to translate
3444 the documentation into your language.
3445 If no one is organizing the effort, please let us know that you're interested.
3448 \begin_layout Standard
3449 Once you get to actually translating, here's a few hints for you that may
3453 \begin_layout Itemize
3454 Join the documentation team! There is information on how to do that in
3455 \begin_inset Flex Code
3458 \begin_layout Plain Layout
3465 \begin_inset Flex Noun
3468 \begin_layout Plain Layout
3469 Help\SpecialChar menuseparator
3475 ), which by the way is the first document you should translate.
3478 \begin_layout Itemize
3479 Learn the typographic conventions for the language you are translating to.
3480 Typography is an ancient art and over the centuries, a great variety of
3481 conventions have developed throughout different parts of the world.
3482 Also study the professional terminology amongst typographers in your country.
3483 Inventing your own terminology will only confuse the users.
3486 (Warning! Typography is addictive!)
3489 \begin_layout Itemize
3490 Make a copy of the document.
3491 This will be your working copy.
3492 You can use this as your personal translated help-file by placing it in
3494 \begin_inset Flex Code
3497 \begin_layout Plain Layout
3504 \begin_inset Note Greyedout
3507 \begin_layout Plain Layout
3512 For a complex document with external material (images, etc.), if you make
3514 \begin_inset space \thinspace{}
3518 \begin_inset space \space{}
3521 in a temp dir, beware that the links to external material may be broken
3522 when the document is moved to a different place.
3523 The best way is to retrieve the \SpecialChar LyX
3525 \begin_inset Flex URL
3528 \begin_layout Plain Layout
3530 https://www.lyx.org/HowToUseGIT
3535 ) and to edit the doc file in place.
3543 \begin_layout Itemize
3544 Sometimes the original document (from the \SpecialChar LyX
3545 team) will be updated.
3546 Use the source viewer at
3547 \begin_inset CommandInset href
3549 name "https://www.lyx.org/trac/timeline"
3550 target "https://www.lyx.org/trac/timeline"
3555 to see what has been changed.
3556 That way you can easily see which parts of the translated document need
3560 \begin_layout Standard
3561 If you ever find an error in the original document, fix it and notify the
3562 rest of the documentation team of the changes! (You didn't forget to join
3563 the documentation team, did you?)
3566 \begin_layout Standard
3567 \begin_inset Branch OutDated
3571 \begin_layout Section
3572 International Keyboard Support
3575 \begin_layout Standard
3578 [Editor's Note: The following section is by
3586 It needs to be fixed to conform to the new Documentation Style sheet and
3587 to make use of the new v1.0 features.
3588 The whole thing also needs to be merged with the section following it.-jw
3589 It may also be badly out of date.-rh (2008)]
3592 \begin_layout Subsection
3593 Defining Own Keymaps: Keymap File Format
3596 \begin_layout Standard
3597 Let's look at a keyboard definition file a little closer.
3598 It is a plain text file defining
3601 \begin_layout Itemize
3602 key-to-key or key-to-string translations
3605 \begin_layout Itemize
3609 \begin_layout Itemize
3610 dead keys exceptions
3613 \begin_layout Standard
3614 To define key-to-key or key-to-string translation, use this command:
3617 \begin_layout Quotation
3618 \begin_inset Flex Code
3621 \begin_layout Plain Layout
3630 \begin_inset Flex Code
3633 \begin_layout Plain Layout
3642 \begin_layout Standard
3644 \begin_inset Flex Code
3647 \begin_layout Plain Layout
3653 is the key to be translated and
3654 \begin_inset Flex Code
3657 \begin_layout Plain Layout
3663 is the string to be inserted into the document.
3664 To define dead keys, use:
3667 \begin_layout Quotation
3668 \begin_inset Flex Code
3671 \begin_layout Plain Layout
3680 \begin_inset Flex Code
3683 \begin_layout Plain Layout
3692 \begin_layout Standard
3694 \begin_inset Flex Code
3697 \begin_layout Plain Layout
3703 is a keyboard key and
3704 \begin_inset Flex Code
3707 \begin_layout Plain Layout
3714 The following dead keys are supported (shortcut name is in parentheses):
3717 \begin_layout Quotation
3721 \begin_inset space \hfill{}
3727 \begin_layout Quotation
3729 \begin_inset space \hfill{}
3735 \begin_layout Quotation
3737 \begin_inset space \hfill{}
3743 \begin_layout Quotation
3745 \begin_inset space \hfill{}
3751 \begin_layout Quotation
3753 \begin_inset space \hfill{}
3759 \begin_layout Quotation
3761 \begin_inset space \hfill{}
3768 \begin_layout Plain Layout
3780 \begin_layout Quotation
3782 \begin_inset space \hfill{}
3788 \begin_layout Quotation
3790 \begin_inset space \hfill{}
3797 \begin_layout Plain Layout
3809 \begin_layout Quotation
3811 \begin_inset space \hfill{}
3817 \begin_layout Quotation
3819 \begin_inset space \hfill{}
3825 \begin_layout Quotation
3827 \begin_inset space \hfill{}
3834 \begin_layout Plain Layout
3846 \begin_layout Quotation
3848 \begin_inset space \hfill{}
3855 \begin_layout Plain Layout
3867 \begin_layout Quotation
3869 \begin_inset space \hfill{}
3875 \begin_layout Quotation
3876 hungarian umlaut (hug)
3877 \begin_inset space \hfill{}
3883 \begin_layout Quotation
3885 \begin_inset space \hfill{}
3891 \begin_layout Quotation
3893 \begin_inset space \hfill{}
3900 \begin_layout Plain Layout
3912 \begin_layout Standard
3913 Since in many international keyboards there are exceptions to what some
3914 dead keys should do, you can define them using
3917 \begin_layout Quotation
3918 \begin_inset Flex Code
3921 \begin_layout Plain Layout
3929 deadkey key outstring
3932 \begin_layout Standard
3933 For example, on Slovak keyboard, if you enter caron-o, it generates circumflex-o
3937 \begin_layout Quotation
3938 \begin_inset Flex Code
3941 \begin_layout Plain Layout
3954 \begin_layout Standard
3955 to make it work correctly.
3956 Also, you have to define as exceptions dead keys over i and j, to remove
3957 the dot from them before inserting an accent mark.
3958 I will change this when the time comes, but so far I haven't had time.
3961 \begin_layout Standard
3962 Oh, and about characters: backslash is escaped, so to enter it, you'll need
3965 \begin_inset Flex Code
3968 \begin_layout Plain Layout
3974 have different meaning.
3976 \begin_inset Flex Code
3979 \begin_layout Plain Layout
3985 marks comments, quotes start and end \SpecialChar LaTeX
3987 To enter quote, you'll need to use
3988 \begin_inset Flex Code
3991 \begin_layout Plain Layout
4000 \begin_inset Flex Code
4003 \begin_layout Plain Layout
4010 \begin_inset Flex Code
4013 \begin_layout Plain Layout
4024 \begin_layout Standard
4025 If you make a keyboard description file that works for your language, please
4026 mail it to me, so I can include it in the next keymap distribution.
4029 \begin_layout Standard
4030 More keywords will be supported in keymap configuration file in future,
4034 \begin_layout Itemize
4035 \begin_inset Flex Code
4038 \begin_layout Plain Layout
4049 \begin_inset space \hfill{}
4053 \begin_inset Flex Code
4056 \begin_layout Plain Layout
4065 \begin_layout Itemize
4066 \begin_inset Flex Code
4069 \begin_layout Plain Layout
4080 \begin_inset space \hfill{}
4084 \begin_inset Flex Code
4087 \begin_layout Plain Layout
4093 an external keymap translation program
4096 \begin_layout Standard
4097 Also, it should look into
4098 \begin_inset Flex Code
4101 \begin_layout Plain Layout
4107 file for defaults, too (for example, a
4108 \begin_inset Flex Code
4111 \begin_layout Plain Layout
4119 option to include default keyboard).
4127 \begin_layout Section
4128 International Keymap Stuff
4129 \begin_inset CommandInset label
4131 name "sec:International-Keymap-Stuff"
4138 \begin_layout Standard
4139 \begin_inset Note Note
4142 \begin_layout Plain Layout
4143 In doing the revisions on this document in March 2008, I did not look over
4144 this stuff, as I do not understand it.
4145 It would be good if someone else could do so.
4154 \begin_layout Standard
4155 The next two sections describe the
4156 \begin_inset Flex Code
4159 \begin_layout Plain Layout
4168 \begin_inset Flex Code
4171 \begin_layout Plain Layout
4179 file syntax in detail.
4180 These sections should help you design your own key map if the ones provided
4181 do not meet your needs.
4184 \begin_layout Subsection
4188 \begin_layout Standard
4192 \begin_inset Flex Code
4195 \begin_layout Plain Layout
4201 file maps keystrokes to characters or strings.
4202 As the name suggests, it sets a keyboard mapping.
4204 \begin_inset Flex Code
4207 \begin_layout Plain Layout
4218 \begin_inset Flex Code
4221 \begin_layout Plain Layout
4236 \begin_inset Flex Code
4239 \begin_layout Plain Layout
4252 \begin_inset Flex Code
4255 \begin_layout Plain Layout
4264 \begin_inset Flex Code
4267 \begin_layout Plain Layout
4275 are described in this section.
4278 \begin_layout Labeling
4279 \labelwidthstring 00.00.0000
4280 \begin_inset Flex Code
4283 \begin_layout Plain Layout
4291 Map a character to a string
4294 \begin_layout LyX-Code
4309 \begin_layout Standard
4342 the double-quote (")
4359 must be escaped with a preceding backslash (
4370 \begin_layout Standard
4372 \begin_inset Flex Noun
4375 \begin_layout Plain Layout
4383 statement to cause the symbol
4384 \begin_inset Flex Noun
4387 \begin_layout Plain Layout
4395 to be output for the keystroke
4396 \begin_inset Flex Noun
4399 \begin_layout Plain Layout
4410 \begin_layout LyX-Code
4416 \begin_layout Labeling
4417 \labelwidthstring 00.00.0000
4418 \begin_inset Flex Code
4421 \begin_layout Plain Layout
4429 Specify an accent character
4432 \begin_layout LyX-Code
4441 \begin_layout Standard
4442 This will make the cha
4480 This is the dead key
4484 \begin_layout Plain Layout
4491 refers to a key that does not produce a character by itself, but when followed
4492 with another key, produces the desired accent character.
4493 For example, a German characte
4495 r with an umlaut like
4505 can be produced in this manner.
4514 \begin_layout Standard
4527 and then another key not in
4544 followed by the other, not allowed key, as output.
4548 \begin_inset Flex Noun
4551 \begin_layout Plain Layout
4559 cancels a dead key, so if
4570 \begin_inset Flex Noun
4573 \begin_layout Plain Layout
4582 , the cursor will not go one position backwards but will instead cancel
4598 might have had on the next keystroke.
4602 \begin_layout Standard
4603 The following example specifies that the character ' is to be an acute accent,
4604 allowed on the characters a, e, i, o, u, A, E, I, O, and U:
4607 \begin_layout LyX-Code
4610 kmod ' acute aeiouAEIOU
4613 \begin_layout Labeling
4614 \labelwidthstring 00.00.0000
4615 \begin_inset Flex Code
4618 \begin_layout Plain Layout
4624 Specify an exception to the accent character
4627 \begin_layout LyX-Code
4636 \begin_layout Standard
4637 This defines an exce
4678 have been assigned a keystroke with a previous
4681 \begin_inset Flex Code
4684 \begin_layout Plain Layout
4708 must not belong in the
4755 If such a declaration does not exist in
4763 \begin_inset Flex Code
4766 \begin_layout Plain Layout
4800 \begin_inset Flex Code
4803 \begin_layout Plain Layout
4817 \begin_layout Standard
4818 The following command produces causes äi to be produced when you enter acute-i
4822 \begin_layout LyX-Code
4836 \begin_layout Labeling
4837 \labelwidthstring 00.00.0000
4838 \begin_inset Flex Code
4841 \begin_layout Plain Layout
4847 Combine two accent characters
4850 \begin_layout LyX-Code
4856 accent1 accent2 allowed
4859 \begin_layout Standard
4860 This one is getting pretty esoteric.
4861 It allows you to combine the effect
4917 \begin_inset Flex Code
4920 \begin_layout Plain Layout
4948 \begin_layout Standard
4949 Consider this example from the
4950 \begin_inset Flex Code
4953 \begin_layout Plain Layout
4964 \begin_layout LyX-Code
4967 kmod ; acute aeioyvhAEIOYVH
4971 kcomb acute umlaut iyIY
4974 \begin_layout Standard
4975 This allows you to press
4976 \begin_inset Flex Noun
4979 \begin_layout Plain Layout
4987 and get the effect of
4988 \begin_inset Flex Code
4991 \begin_layout Plain Layout
5010 in this case cancels the last dead key, so if you press
5011 \begin_inset Flex Noun
5014 \begin_layout Plain Layout
5023 \begin_inset Flex Code
5026 \begin_layout Plain Layout
5039 \begin_layout Subsection
5043 \begin_layout Standard
5045 \begin_inset Flex Code
5048 \begin_layout Plain Layout
5056 mapping is performed, a
5057 \begin_inset Flex Code
5060 \begin_layout Plain Layout
5070 file maps the strings that the symbols generate to characters in the current
5072 The \SpecialChar LyX
5073 distribution currently includes at least the
5074 \begin_inset Flex Code
5077 \begin_layout Plain Layout
5086 \begin_inset Flex Code
5089 \begin_layout Plain Layout
5100 \begin_layout Standard
5102 \begin_inset Flex Code
5105 \begin_layout Plain Layout
5113 file is a sequence of declarations of the form
5116 \begin_layout LyX-Code
5129 \begin_layout Standard
5130 For example, in order to map
5131 \begin_inset Flex Noun
5134 \begin_layout Plain Layout
5144 to the corresponding character in the iso-8859-1 set (233), the following
5148 \begin_layout LyX-Code
5156 \begin_layout Standard
5158 \begin_inset Flex Code
5161 \begin_layout Plain Layout
5170 \begin_inset Flex Code
5173 \begin_layout Plain Layout
5191 the same character can apply to more than one string.
5193 \begin_inset Flex Code
5196 \begin_layout Plain Layout
5207 \begin_layout LyX-Code
5219 \begin_inset Newline newline
5235 \begin_layout Standard
5237 cannot find a mapping for the string produced by the keystroke or a
5238 deadkey sequence, it will check if it looks like an accented char and try
5239 to draw an accent over the character on screen.
5242 \begin_layout Subsection
5246 \begin_layout Standard
5247 There is a second way to add support for international characters through
5248 so-called dead-keys.
5249 A dead-key works in combination with a letter to produce an accented character.
5250 Here, we'll explain how to create a really simple dead-key to illustrate
5254 \begin_layout Standard
5255 Suppose you happen to need the circumflex character,
5256 \begin_inset Quotes eld
5260 \begin_inset Quotes erd
5265 \begin_inset Flex Noun
5268 \begin_layout Plain Layout
5275 \begin_inset space ~
5279 \begin_inset Flex Noun
5282 \begin_layout Plain Layout
5288 ] to the \SpecialChar LyX
5290 \begin_inset Flex Code
5293 \begin_layout Plain Layout
5300 \begin_inset Flex Code
5303 \begin_layout Plain Layout
5310 Now, whenever you type the
5311 \begin_inset Flex Noun
5314 \begin_layout Plain Layout
5320 -key followed by a letter, that letter will have a circumflex accent on
5322 For example, the sequence
5323 \begin_inset Quotes eld
5327 \begin_inset Flex Noun
5330 \begin_layout Plain Layout
5337 \begin_inset Quotes erd
5340 produces the letter:
5341 \begin_inset Quotes eld
5345 \begin_inset Quotes erd
5349 If you tried to type
5350 \begin_inset Quotes eld
5354 \begin_inset Flex Noun
5357 \begin_layout Plain Layout
5364 \begin_inset Quotes erd
5367 , however, \SpecialChar LyX
5368 will complain with a beep, since a
5369 \begin_inset Quotes eld
5373 \begin_inset Flex Noun
5376 \begin_layout Plain Layout
5383 \begin_inset Quotes erd
5386 never takes a circumflex accent.
5388 \begin_inset Flex Noun
5391 \begin_layout Plain Layout
5397 after a dead-key produces the bare-accent.
5398 Please note this last point! If you bind a key to a dead-key, you'll need
5399 to rebind the character on that key to yet another key.
5401 \begin_inset Flex Noun
5404 \begin_layout Plain Layout
5410 to a cedilla is a bad idea, since you'll only get cedillas instead of commas.
5413 \begin_layout Standard
5414 One common way to bind dead-keys is to use
5415 \begin_inset Flex Noun
5418 \begin_layout Plain Layout
5425 \begin_inset Flex Noun
5428 \begin_layout Plain Layout
5435 \begin_inset Flex Noun
5438 \begin_layout Plain Layout
5444 in combination with an accent, like
5445 \begin_inset Quotes eld
5449 \begin_inset Flex Noun
5452 \begin_layout Plain Layout
5459 \begin_inset Quotes erd
5463 \begin_inset Quotes eld
5467 \begin_inset Flex Noun
5470 \begin_layout Plain Layout
5477 \begin_inset Quotes erd
5481 \begin_inset Quotes eld
5485 \begin_inset Flex Noun
5488 \begin_layout Plain Layout
5495 \begin_inset Quotes erd
5499 Another way involves using
5500 \begin_inset Flex Code
5503 \begin_layout Plain Layout
5510 \begin_inset Flex Code
5513 \begin_layout Plain Layout
5519 to set up the special
5520 \begin_inset Flex Code
5523 \begin_layout Plain Layout
5531 \begin_inset Flex Code
5534 \begin_layout Plain Layout
5540 acts in some ways just like
5541 \begin_inset Flex Noun
5544 \begin_layout Plain Layout
5550 and permits you to bind keys to accented characters.
5551 You can also turn keys into dead-keys by binding them to something like
5553 \begin_inset Flex Code
5556 \begin_layout Plain Layout
5562 and then binding this symbolic key to the corresponding \SpecialChar LyX
5567 \begin_layout Plain Layout
5572 : This is exactly what I do in my
5573 \begin_inset Flex Code
5576 \begin_layout Plain Layout
5583 \begin_inset Flex Code
5586 \begin_layout Plain Layout
5594 \begin_inset Flex Noun
5597 \begin_layout Plain Layout
5599 \begin_inset space ~
5608 \begin_inset Flex Code
5611 \begin_layout Plain Layout
5617 and a bunch of these
5618 \begin_inset Quotes eld
5622 \begin_inset Flex Code
5625 \begin_layout Plain Layout
5632 \begin_inset Quotes erd
5635 symbolic keys bound such things as
5636 \begin_inset Flex Noun
5639 \begin_layout Plain Layout
5641 \begin_inset space ~
5650 \begin_inset Flex Noun
5653 \begin_layout Plain Layout
5655 \begin_inset space ~
5664 This is how I produce my accented characters.
5669 You can make just about anything into the
5670 \begin_inset Flex Code
5673 \begin_layout Plain Layout
5680 \begin_inset Flex Noun
5683 \begin_layout Plain Layout
5689 keys, a spare function key, etc.
5690 As for the \SpecialChar LyX
5691 commands that produce accents, check the entry for
5692 \begin_inset Flex Code
5695 \begin_layout Plain Layout
5706 You'll find the complete list there.
5709 \begin_layout Subsection
5710 Saving your Language Configuration
5713 \begin_layout Standard
5714 You can edit your preferences so that your desired language environment
5715 is automatically configured when \SpecialChar LyX
5717 \begin_inset Flex Noun
5720 \begin_layout Plain Layout
5721 Edit\SpecialChar menuseparator
5730 \begin_layout Chapter
5731 Installing New Document Classes, Layouts, and Templates
5732 \begin_inset CommandInset label
5734 name "cha:Installing-New-Document"
5739 \begin_inset Argument 1
5742 \begin_layout Plain Layout
5743 Installing New Document Classes
5751 \begin_layout Standard
5752 In this chapter, we describe the procedures for creating and installing
5753 new \SpecialChar LyX
5754 layout and template files, as well as offer a refresher on correctly
5755 installing new \SpecialChar LaTeX
5760 \begin_layout Standard
5761 First, let us a say a few words about how one ought to think about the relation
5762 between \SpecialChar LyX
5763 and \SpecialChar LaTeX
5765 The thing to understand is that, in a certain sense, \SpecialChar LyX
5766 doesn't know anything
5767 about \SpecialChar LaTeX
5769 Indeed, from \SpecialChar LyX
5770 's point of view, \SpecialChar LaTeX
5771 is just one of several
5772 \begin_inset Quotes eld
5776 \begin_inset Quotes erd
5779 in which it is capable of producing output.
5780 Other such formats are DocBook, plaintext, and XHTML.
5782 is, of course, a particularly important format, but very little of the
5783 information \SpecialChar LyX
5784 has about \SpecialChar LaTeX
5785 is actually contained in the program itself.
5789 \begin_layout Plain Layout
5790 Some commands are sufficiently complex that they are
5791 \begin_inset Quotes eld
5795 \begin_inset Quotes erd
5798 into \SpecialChar LyX
5800 But the developers generally regard this as a Bad Thing.
5805 Rather, that information, even for the standard classes like
5806 \begin_inset Flex Code
5809 \begin_layout Plain Layout
5815 , is contained in `layout files'.
5816 Similarly, \SpecialChar LyX
5817 itself does not know much about DocBook or XHTML.
5818 What it knows is contained in layout files.
5821 \begin_layout Standard
5822 You can think of the layout file for a given document class as a translation
5823 manual between \SpecialChar LyX
5824 constructs—paragraphs with their corresponding styles,
5825 certain sorts of insets, etc—and the corresponding \SpecialChar LaTeX
5828 Almost everything \SpecialChar LyX
5830 \begin_inset Flex Code
5833 \begin_layout Plain Layout
5839 , for example, is contained in the file
5840 \begin_inset Flex Code
5843 \begin_layout Plain Layout
5849 and in various other files it includes.
5850 For this reason, anyone intending to write layout files should plan to
5851 study the existing files.
5852 A good place to start is with
5853 \begin_inset Flex Code
5856 \begin_layout Plain Layout
5862 , which is included in
5863 \begin_inset Flex Code
5866 \begin_layout Plain Layout
5873 \begin_inset Flex Code
5876 \begin_layout Plain Layout
5882 , and many of the other layout files for document classes.
5883 This file is where sections and the like are defined:
5884 \begin_inset Flex Code
5887 \begin_layout Plain Layout
5893 tells \SpecialChar LyX
5894 how paragraphs that are marked with the Section, Subsection, etc,
5895 styles can be translated into corresponding \SpecialChar LaTeX
5896 , DocBook, and XHTML commands
5899 \begin_inset Flex Code
5902 \begin_layout Plain Layout
5908 file basically just includes several of these
5909 \begin_inset Flex Code
5912 \begin_layout Plain Layout
5921 \begin_layout Standard
5922 Defining the \SpecialChar LyX
5924 correspondence is not the only thing layout files do, though.
5925 Their other job is to define how the \SpecialChar LyX
5926 constructs themselves will appear
5928 The fact that layout files have these two jobs is often a source of confusion,
5929 because they are completely separate.
5930 Telling \SpecialChar LyX
5931 how to translate a certain paragraph style into \SpecialChar LaTeX
5934 how to display it; conversely, telling \SpecialChar LyX
5935 how to display a certain paragraph
5936 style does not tell \SpecialChar LyX
5937 how to translate it into \SpecialChar LaTeX
5938 (let alone tell \SpecialChar LaTeX
5941 So, in general, when you define a new \SpecialChar LyX
5942 construct, you must always do two
5943 quite separate things: (i)
5944 \begin_inset space ~
5947 tell \SpecialChar LyX
5948 how to translate it into \SpecialChar LaTeX
5950 \begin_inset space ~
5953 tell \SpecialChar LyX
5957 \begin_layout Standard
5958 Much the same is true, of course, as regards \SpecialChar LyX
5959 's other backend formats, though
5960 XHTML is in some ways different, because in that case \SpecialChar LyX
5965 able, to some extent, to use information about how it should display a
5966 paragraph on the screen to output information (in the form of CSS) about
5967 how the paragraph should be displayed in a browser.
5968 Even in this case, however, the distinction between what \SpecialChar LyX
5970 and how things are rendered externally remains in force, and the two can
5971 be controlled separately.
5973 \begin_inset CommandInset ref
5975 reference "sec:Tags-for-XHTML"
5982 \begin_layout Section
5983 Installing new \SpecialChar LaTeX
5987 \begin_layout Standard
5988 Some installations may not include a \SpecialChar LaTeX
5989 package or class file that you would
5990 like to use within \SpecialChar LyX
5992 For example, you might need Foil\SpecialChar TeX
5993 , a package for preparing slides for overhead
5995 Modern \SpecialChar LaTeX
5996 distributions like \SpecialChar TeX
5997 Live (2008 or newer) or MiK\SpecialChar TeX
5998 provide a user interface
5999 for installing such packages.
6000 For example, with MiK\SpecialChar TeX
6001 , you start the program
6002 \begin_inset Quotes eld
6006 \begin_inset space ~
6010 \begin_inset Quotes erd
6013 to get a list of available packages.
6014 To install one of them, right click on it or use the corresponding toolbar
6018 \begin_layout Standard
6019 If your \SpecialChar LaTeX
6020 distribution does not provide such a `package manager', or if the
6021 package is not available from your distribution, then follow these steps
6022 to install it manually:
6025 \begin_layout Enumerate
6026 Get the package from
6027 \begin_inset CommandInset href
6030 target "http://www.ctan.org/"
6038 \begin_layout Enumerate
6039 If the package contains a file with the ending
6040 \begin_inset Quotes eld
6044 \begin_inset Flex Code
6047 \begin_layout Plain Layout
6054 \begin_inset Quotes erd
6057 (is the case for Foil\SpecialChar TeX
6058 ) then open a console, change to the folder of this
6059 file and execute the command
6060 \begin_inset Flex Code
6063 \begin_layout Plain Layout
6070 You have now unpacked the package and have all files to install it.
6071 Most \SpecialChar LaTeX
6072 -packages are not packed and you can skip this step.
6075 \begin_layout Enumerate
6076 Now you need to decide if the package should be available for all users
6081 \begin_layout Enumerate
6082 On *nix systems (Linux, OSX, etc.), if you want the new package to be available
6083 for all users on your system, then install it in your `local' \SpecialChar TeX
6085 install it in your own `user' \SpecialChar TeX
6087 Where these trees should be created, if they do not already exist, depends
6089 To find this out, look in the file
6090 \begin_inset Flex Code
6093 \begin_layout Plain Layout
6103 \begin_layout Plain Layout
6104 This is usually in the directory
6105 \begin_inset Flex Code
6108 \begin_layout Plain Layout
6114 , though you can execute the command
6115 \begin_inset Flex Code
6118 \begin_layout Plain Layout
6129 The location of the `local' \SpecialChar TeX
6130 tree is defined by the
6131 \begin_inset Flex Code
6134 \begin_layout Plain Layout
6140 variable; this is usually somewhere like
6141 \begin_inset Flex Code
6144 \begin_layout Plain Layout
6145 /usr/local/share/texmf
6150 or /usr/local/texlive/XXXX where XXXX is the year of the installed \SpecialChar TeX
6153 The location of the `user' \SpecialChar TeX
6155 \begin_inset Flex Code
6158 \begin_layout Plain Layout
6165 \begin_inset Flex Code
6168 \begin_layout Plain Layout
6175 \begin_inset Flex Code
6178 \begin_layout Plain Layout
6187 (If these variables are not predefined, you have to define them.) You'll
6188 probably need root permissions to create or modify the `local' tree, but
6189 not for your `user' tree.
6190 \begin_inset Newline newline
6193 In general, it is recommended to install in the user tree because your user
6194 will not be modified or even overwritten when you upgrade your system.
6195 It will typically also be backed up together with everything else when
6196 you backup your home directory (which, of course, you do on a regular basis).
6199 \begin_layout Enumerate
6200 On Windows, if you want the new package to be available for all users on
6201 your system, change to the folder where \SpecialChar LaTeX
6202 is installed and then change to
6204 \begin_inset Flex Code
6207 \begin_layout Plain Layout
6218 (For MiK\SpecialChar TeX
6219 , this would be by default the folder
6220 \begin_inset Flex Code
6223 \begin_layout Plain Layout
6241 \begin_layout Plain Layout
6242 Note that this will be the correct path only on English installations.
6243 On a German one, it would be
6244 \begin_inset Flex Code
6247 \begin_layout Plain Layout
6261 , and similarly for other languages.
6266 Create there a new folder
6267 \begin_inset Flex Code
6270 \begin_layout Plain Layout
6276 and copy all files of the package into it.
6278 \begin_inset Newline newline
6281 If the package should only available for you or you don't have admin permissions
6282 , do the same, but in the local \SpecialChar LaTeX
6285 \begin_inset space \thinspace{}
6288 g., for MiK\SpecialChar TeX
6290 \begin_inset space ~
6293 2.8 under Windows XP, this would be the folder:
6294 \begin_inset Newline newline
6300 \begin_inset Flex Code
6303 \begin_layout Plain Layout
6306 Documents and Settings
6318 \begin_inset Newline newline
6324 \begin_inset Phantom HPhantom
6327 \begin_layout Plain Layout
6338 \begin_inset Flex Code
6341 \begin_layout Plain Layout
6354 \begin_inset Newline newline
6357 On Vista, it would be:
6358 \begin_inset Newline newline
6362 \begin_inset Flex Code
6365 \begin_layout Plain Layout
6391 \begin_layout Enumerate
6392 Now one only need to tell \SpecialChar LaTeX
6393 that there are new files.
6394 This depends on the used \SpecialChar LaTeX
6399 \begin_layout Enumerate
6400 For \SpecialChar TeX
6401 Live execute the command
6402 \begin_inset Flex Code
6405 \begin_layout Plain Layout
6412 If you installed the package for all users, then you will probably need
6413 to have root permissions for that.
6416 \begin_layout Enumerate
6417 For MiK\SpecialChar TeX
6418 , if you have installed the package for all users, start the program
6420 \begin_inset Quotes eld
6424 \begin_inset space ~
6428 \begin_inset Quotes erd
6431 and press the button marked
6432 \begin_inset Quotes eld
6436 \begin_inset Quotes erd
6440 Otherwise start the program
6441 \begin_inset Quotes eld
6445 \begin_inset Quotes erd
6452 \begin_layout Enumerate
6453 Finally, you need to tell \SpecialChar LyX
6454 that there are new packages available.
6455 So, in \SpecialChar LyX
6457 \begin_inset Flex Noun
6460 \begin_layout Plain Layout
6463 \SpecialChar menuseparator
6469 and then restart \SpecialChar LyX
6473 \begin_layout Standard
6474 Now the package is installed.
6475 In our example, the document class
6476 \begin_inset Flex Code
6479 \begin_layout Plain Layout
6485 will now be available under
6486 \begin_inset Flex Noun
6489 \begin_layout Plain Layout
6490 Document\SpecialChar menuseparator
6491 Settings\SpecialChar menuseparator
6498 \begin_inset Quotes eld
6502 \begin_inset Quotes erd
6509 \begin_layout Standard
6510 If you would like to use a \SpecialChar LaTeX
6511 document class that is not even listed in the
6513 \begin_inset Flex Noun
6516 \begin_layout Plain Layout
6517 Document\SpecialChar menuseparator
6518 Settings\SpecialChar menuseparator
6524 , then you need to create a `layout' file for it.
6525 That is the topic of the next section.
6528 \begin_layout Section
6529 Types of layout files
6532 \begin_layout Standard
6533 This section describes the various sorts of \SpecialChar LyX
6534 files that contain layout informati
6536 These files describe various paragraph and character styles, determining
6537 how \SpecialChar LyX
6538 should display them and how they should be translated into \SpecialChar LaTeX
6540 XHTML, or whatever output format is being used.
6544 \begin_layout Standard
6545 We shall try to provide a thorough description of the process of writing
6547 However, there are so many different types of documents supported even
6548 by just \SpecialChar LaTeX
6549 that we can't hope to cover every different possibility or problem
6550 you might encounter.
6551 The \SpecialChar LyX
6552 users' list is frequented by people with lots of experience with layout
6553 design who are willing to share what they've learned, so please feel free
6554 to ask questions there.
6557 \begin_layout Standard
6558 As you prepare to write a new layout, it is extremely helpful to look at
6559 the layouts distributed with \SpecialChar LyX
6561 If you write a \SpecialChar LyX
6562 layout for a \SpecialChar LaTeX
6563 document class that might also be used by
6564 others, or write a module that might be useful to others, then you should
6565 consider posting your layout to the
6566 \begin_inset CommandInset href
6568 name "layout section on the LyX wiki"
6569 target "https://wiki.lyx.org/Layouts/Layouts"
6574 or even to the \SpecialChar LyX
6575 developers' list, so that it might be included in \SpecialChar LyX
6580 \begin_layout Plain Layout
6581 Note that \SpecialChar LyX
6582 is licensed under the General Public License, so any material
6583 that is contributed to \SpecialChar LyX
6584 must be similarly licensed.
6592 \begin_layout Subsection
6594 \begin_inset CommandInset label
6596 name "subsec:Layout-modules"
6603 \begin_layout Standard
6604 We have spoken to this point about `layout files'.
6605 But there are different sorts of files that contain layout information.
6606 Layout files, strictly so called, have the
6607 \begin_inset Flex Code
6610 \begin_layout Plain Layout
6616 extension and provide \SpecialChar LyX
6617 with information about document classes.
6618 Since \SpecialChar LyX
6619 1.6 layout information can also be contained in layout
6624 \begin_inset Flex Code
6627 \begin_layout Plain Layout
6634 Modules are to \SpecialChar LaTeX
6635 packages much as layouts are to \SpecialChar LaTeX
6636 classes, and some modules—such
6638 \begin_inset Flex Code
6641 \begin_layout Plain Layout
6647 module—specifically provide support for one package.
6648 In a sense, layout modules are similar to included
6652 \begin_layout Plain Layout
6653 These can have any extension, but by convention have the
6654 \begin_inset Flex Code
6657 \begin_layout Plain Layout
6669 \begin_inset Flex Code
6672 \begin_layout Plain Layout
6678 —in that modules are not specific to a given document class but may be used
6679 with many different classes.
6680 The difference is that using an included file with
6681 \begin_inset Flex Code
6684 \begin_layout Plain Layout
6690 requires editing that file.
6691 Modules, by contrast, are selected in the
6692 \begin_inset Flex Noun
6695 \begin_layout Plain Layout
6696 Document\SpecialChar menuseparator
6705 \begin_layout Standard
6706 Building modules is the easiest way to get started with layout editing,
6707 since it can be as simple as adding a single new paragraph style or flex
6709 But modules may, in principle, contain anything a layout file can contain.
6712 \begin_layout Standard
6713 After creating a new module and copying it to the
6714 \begin_inset Flex Code
6717 \begin_layout Plain Layout
6723 folder, you will need to reconfigure and then restart \SpecialChar LyX
6726 However, changes you make to the module will be seen immediately, if you
6728 \begin_inset Flex Noun
6731 \begin_layout Plain Layout
6732 Document\SpecialChar menuseparator
6738 , highlight something, and then hit
6739 \begin_inset Quotes eld
6743 \begin_inset Quotes erd
6749 It is strongly recommended that you save your work before doing this
6754 it is strongly recommended that you not attempt to edit modules while simultaneo
6755 usly working on actual documents
6758 Though of course the developers strive to keep \SpecialChar LyX
6759 stable in such situations,
6760 syntax errors and the like in your module file could cause strange behavior.
6763 \begin_layout Subsubsection
6767 \begin_layout Standard
6768 Modules are to \SpecialChar LyX
6769 as packages are to \SpecialChar LaTeX
6771 Sometimes, however, you find yourself wanting a specific inset or character
6772 style just for one document and writing a module that will also be available
6773 to other documents makes little sense.
6774 What you need is \SpecialChar LyX
6776 \begin_inset Quotes eld
6780 \begin_inset Quotes erd
6786 \begin_layout Standard
6787 You will find it under
6789 Document\SpecialChar menuseparator
6790 Settings\SpecialChar menuseparator
6794 The large text box allows you to enter anything that you might enter in
6795 a layout file or module.
6796 You can think of a document's local layout, in fact, as a module that belongs
6798 So, in particular, you must enter a
6799 \begin_inset Flex Code
6802 \begin_layout Plain Layout
6809 Any format is acceptable, but one would normally use the format current
6811 (In \SpecialChar LyX
6812 2.3, the current layout format is 63.)
6815 \begin_layout Standard
6816 When you have entered something in the
6817 \begin_inset Flex Code
6820 \begin_layout Plain Layout
6826 pane, \SpecialChar LyX
6828 \begin_inset Quotes eld
6832 \begin_inset Quotes erd
6835 button at the bottom.
6836 Clicking this button will cause \SpecialChar LyX
6837 to determine whether what you have entered
6838 is valid layout information for the chosen format.
6840 will report the result but, unfortunately, will not tell you what errors
6841 there might have been.
6842 These will be written to the terminal, however, if \SpecialChar LyX
6843 is started from a terminal.
6844 You will not be permitted to save your local layout until you have entered
6848 \begin_layout Standard
6849 The warnings at the end of the previous section apply here, too.
6850 Do not play with local layout while you are actually working, especially
6851 if you have not saved your document.
6852 That said, using local layout with a test document can be a very convenient
6853 way to try out layout ideas, or even to start developing a module.
6856 \begin_layout Subsection
6858 \begin_inset Flex Noun
6861 \begin_layout Plain Layout
6870 \begin_layout Standard
6871 There are two situations you are likely to encounter when wanting to support
6872 a new \SpecialChar LaTeX
6873 document class, involving style (
6874 \begin_inset Flex Code
6877 \begin_layout Plain Layout
6883 ) files and \SpecialChar LaTeX2e
6885 \begin_inset Flex Code
6888 \begin_layout Plain Layout
6895 Supporting a style file is usually fairly easy.
6896 Supporting a new class file is a bit harder.
6897 We'll discuss the former in this section and the latter in the next.
6898 Similar remarks apply, of course, if you want to support a new DocBook
6902 \begin_layout Standard
6903 The easier case is the one in which your new document class is provided
6904 as a style file that is to be used in conjunction with an already supported
6906 For the sake of the example, we'll assume that the style file is called
6908 \begin_inset Flex Noun
6911 \begin_layout Plain Layout
6917 and that it is meant to be used with
6918 \begin_inset Flex Noun
6921 \begin_layout Plain Layout
6927 , which is a standard class.
6931 \begin_layout Standard
6932 Start by copying the existing class's layout file into your local directory:
6936 \begin_layout Plain Layout
6937 Of course, which directory is your local directory will vary by platform,
6938 and \SpecialChar LyX
6939 allows you to specify your local directory on startup, too, using
6941 \begin_inset Flex Code
6944 \begin_layout Plain Layout
6958 \begin_layout LyX-Code
6959 cp report.layout ~/.lyx/layouts/myclass.layout
6962 \begin_layout Standard
6964 \begin_inset Flex Code
6967 \begin_layout Plain Layout
6973 and change the line:
6976 \begin_layout LyX-Code
6979 DeclareLaTeXClass{Report (Standard Class)}
6982 \begin_layout Standard
6986 \begin_layout LyX-Code
6989 DeclareLaTeXClass[report, myclass.sty]{Report (My Class)}
6992 \begin_layout Standard
6996 \begin_layout LyX-Code
6998 \begin_inset Newline newline
7004 \begin_inset Newline newline
7010 \begin_layout Standard
7011 near the top of the file.
7014 \begin_layout Standard
7015 Start \SpecialChar LyX
7017 \begin_inset Flex Noun
7020 \begin_layout Plain Layout
7021 Tools\SpecialChar menuseparator
7028 Then restart \SpecialChar LyX
7029 and try creating a new document.
7031 \begin_inset Flex Noun
7034 \begin_layout Plain Layout
7040 " as a document class option in the
7041 \begin_inset Flex Noun
7044 \begin_layout Plain Layout
7045 Document\SpecialChar menuseparator
7052 It is likely that some of the sectioning commands and such in your new
7053 class will work differently from how they worked in the base class—
7054 \begin_inset Flex Code
7057 \begin_layout Plain Layout
7063 in this example—so you can fiddle around with the settings for the different
7064 sections if you wish.
7065 The layout information for sections is contained in
7066 \begin_inset Flex Code
7069 \begin_layout Plain Layout
7075 , but you do not need to copy and change this file.
7076 Instead, you can simply add your changes to your layout file, after the
7078 \begin_inset Flex Code
7081 \begin_layout Plain Layout
7087 , which itself includes
7088 \begin_inset Flex Code
7091 \begin_layout Plain Layout
7098 For example, you might add these lines:
7101 \begin_layout LyX-Code
7105 \begin_layout LyX-Code
7109 \begin_layout LyX-Code
7113 \begin_layout LyX-Code
7117 \begin_layout LyX-Code
7121 \begin_layout Standard
7122 to change the font for chapter headings to sans-serif.
7123 This will override (or, in this case, add to) the existing declaration
7124 for the Chapter style.
7128 \begin_layout Standard
7129 Your new package may also provide commands or environments not present in
7131 In this case, you will want to add these to the layout file.
7133 \begin_inset CommandInset ref
7135 reference "sec:TextClass"
7139 for information on how to do so.
7142 \begin_layout Standard
7144 \begin_inset Flex Noun
7147 \begin_layout Plain Layout
7153 can be used with several different document classes, and even if it cannot,
7154 you might find it easiest just to write a module that you can load with
7156 The simplest possible such module would be:
7159 \begin_layout LyX-Code
7162 DeclareLyXModule{My Class}
7165 \begin_layout LyX-Code
7169 \begin_layout LyX-Code
7170 #Support for myclass.sty.
7173 \begin_layout LyX-Code
7175 \begin_inset Newline newline
7181 \begin_layout LyX-Code
7183 \begin_inset Newline newline
7189 \begin_layout LyX-Code
7191 \begin_inset Newline newline
7197 \begin_inset Newline newline
7203 \begin_layout Standard
7204 A more complex module might modify the behavior of some existing constructs
7205 or define some new ones.
7207 \begin_inset CommandInset ref
7209 reference "sec:TextClass"
7216 \begin_layout Subsection
7218 \begin_inset Flex Noun
7221 \begin_layout Plain Layout
7230 \begin_layout Standard
7231 There are two possibilities here.
7232 One is that the class file is itself based upon an existing document class.
7233 For example, many thesis classes are based upon
7234 \begin_inset Flex Noun
7237 \begin_layout Plain Layout
7244 To see whether yours is, look for a line like
7247 \begin_layout LyX-Code
7253 \begin_layout Standard
7255 If so, then you may proceed largely as in the previous section, though
7257 \begin_inset Flex Code
7260 \begin_layout Plain Layout
7261 Declare\SpecialChar LaTeX
7267 line will be different.
7268 If your new class is
7269 \begin_inset Flex Code
7272 \begin_layout Plain Layout
7278 and it is based upon
7279 \begin_inset Flex Code
7282 \begin_layout Plain Layout
7288 , then the line should read:
7292 \begin_layout Plain Layout
7293 And it will be easiest if you save the file to
7294 \begin_inset Flex Code
7297 \begin_layout Plain Layout
7304 assumes that the document class has the same name as the layout file.
7313 \begin_layout LyX-Code
7316 DeclareLaTeXClass[thesis,book]{thesis}
7319 \begin_layout Standard
7320 If, on the other hand, the new class is not based upon an existing class,
7321 you will probably have to
7322 \begin_inset Quotes eld
7326 \begin_inset Quotes erd
7330 We strongly suggest copying an existing layout file which uses a similar
7332 class and then modifying it, if you can do so.
7333 At least use an existing file as a starting point so you can find out what
7334 items you need to worry about.
7335 Again, the specifics are covered below.
7338 \begin_layout Subsection
7340 \begin_inset CommandInset label
7342 name "subsec:Creating-Templates"
7349 \begin_layout Standard
7350 Once you have written a layout file for a new document class, you might
7351 want to consider writing a
7356 A template acts as a kind of tutorial for your layout, showing how it might
7357 be used, though containing dummy content.
7358 You can of course look at the various templates included with \SpecialChar LyX
7362 \begin_layout Standard
7363 Templates are created just like usual documents: using \SpecialChar LyX
7365 The only difference is that usual documents contain all possible settings,
7366 including the font scheme and the paper size.
7367 Usually a user doesn't want a template to overwrite his preferred settings
7368 for such parameters.
7369 For that reason, the designer of a template should remove the corresponding
7371 \begin_inset Flex Code
7374 \begin_layout Plain Layout
7383 \begin_inset Flex Code
7386 \begin_layout Plain Layout
7394 from the template \SpecialChar LyX
7396 This can be done with any simple text-editor, for example
7397 \begin_inset Flex Code
7400 \begin_layout Plain Layout
7407 \begin_inset Flex Code
7410 \begin_layout Plain Layout
7419 \begin_layout Standard
7420 Put the edited template files you create in
7421 \begin_inset Flex Code
7424 \begin_layout Plain Layout
7430 , copy the ones you use from the global template directory in
7431 \begin_inset Flex Code
7434 \begin_layout Plain Layout
7440 to the same place, and redefine the template path in the
7441 \begin_inset Flex Noun
7444 \begin_layout Plain Layout
7445 Tools\SpecialChar menuseparator
7446 Preferences\SpecialChar menuseparator
7455 \begin_layout Standard
7456 Note, by the way, that there is a template which has a particular meaning:
7457 \begin_inset Newline linebreak
7461 \begin_inset Flex Code
7464 \begin_layout Plain Layout
7471 This template is loaded every time you create a new document with
7472 \begin_inset Flex Noun
7475 \begin_layout Plain Layout
7476 File\SpecialChar menuseparator
7482 in order to provide useful defaults.
7483 To create this template from inside \SpecialChar LyX
7484 , all you have to do is to open a document
7485 with the correct settings, and use the
7486 \begin_inset Flex Noun
7489 \begin_layout Plain Layout
7490 Save as Document Defaults
7498 \begin_layout Subsection
7499 Upgrading old layout files
7502 \begin_layout Standard
7503 The format of layout files changes with each \SpecialChar LyX
7504 release, so old layout files
7505 need to be converted to the new format.
7507 reads a layout file in an older format, it automatically calls the
7509 \begin_inset Flex Code
7512 \begin_layout Plain Layout
7518 to convert it to a temporary file in current format.
7519 The original file is left untouched.
7520 If you use the layout file often, then, you may want to convert it permanently,
7521 so that \SpecialChar LyX
7522 does not have to do so itself every time.
7523 To do this, you can call the converter manually:
7526 \begin_layout Enumerate
7528 \begin_inset Flex Code
7531 \begin_layout Plain Layout
7538 \begin_inset Flex Code
7541 \begin_layout Plain Layout
7550 \begin_layout Enumerate
7552 \begin_inset Newline newline
7556 \begin_inset Flex Code
7559 \begin_layout Plain Layout
7560 python LyXDir/scripts/layout2layout.py myclass.old myclass.layout
7566 \begin_inset Newline newline
7570 \begin_inset Flex Code
7573 \begin_layout Plain Layout
7579 is the name of your \SpecialChar LyX
7583 \begin_layout Standard
7584 Note that manual conversion does not affect included files, so these will
7585 have to be converted separately.
7588 \begin_layout Subsection
7589 \begin_inset CommandInset label
7591 name "subsec:Cite-Engine-Files"
7598 \begin_layout Standard
7599 A specific form of layout files are the so-called
7600 \begin_inset Flex Code
7603 \begin_layout Plain Layout
7609 files that are located in the
7610 \begin_inset Flex Code
7613 \begin_layout Plain Layout
7620 Their purpose is to define the specifics of \SpecialChar LaTeX
7621 packages aimed at bibliography
7634 , but also the way how normal Bib\SpecialChar TeX
7635 citations (without additional packages)
7636 are handled in \SpecialChar LyX
7637 is defined in such a file.
7641 \begin_layout Standard
7642 More specifically, it is defined which packages \SpecialChar LyX
7643 needs to load, which citation
7644 commands are available, how these are to be displayed in \SpecialChar LyX
7646 the dialogs, the context menus) as well as in the XHTML and plain text
7648 Furthermore, the files specify available style variants (author-year, numerical
7649 , etc.) and their specifics.
7650 The cite engine files are also used to generate the options that are available
7653 Document\SpecialChar menuseparator
7654 Settings\SpecialChar menuseparator
7655 Bibliography\SpecialChar menuseparator
7661 \begin_layout Standard
7662 Even though a cite engine file is essentially a normal layout file that
7663 could theoretically include any layout information, it usually primarily
7664 includes some specific parameters such as
7665 \begin_inset Flex Code
7668 \begin_layout Plain Layout
7675 \begin_inset Flex Code
7678 \begin_layout Plain Layout
7685 \begin_inset Flex Code
7688 \begin_layout Plain Layout
7695 \begin_inset Flex Code
7698 \begin_layout Plain Layout
7705 The syntax of the latter two is described in
7706 \begin_inset CommandInset ref
7708 reference "subsec:Citation-engine-description"
7716 \begin_inset CommandInset ref
7718 reference "subsec:Citation-format-description"
7722 , as well as in the files themselves.
7725 \begin_layout Section
7726 \begin_inset CommandInset label
7728 name "sec:TextClass"
7732 The layout file format
7735 \begin_layout Standard
7736 The following sections describe how layout files are structured and written.
7737 Our advice is to go slowly, save and test often.
7738 It is really not that hard, except that the multitude of options can become
7739 overwhelming, especially if you try to check out too many at once.
7740 It becomes easier if you use existing layouts of \SpecialChar LyX
7741 as examples/reference
7742 or if you modify an existing layout to your needs.
7745 \begin_layout Standard
7746 Note that all the tags used in layout files are case-insensitive.
7748 \begin_inset Flex Code
7751 \begin_layout Plain Layout
7758 \begin_inset Flex Code
7761 \begin_layout Plain Layout
7768 \begin_inset Flex Code
7771 \begin_layout Plain Layout
7777 are really the same tag.
7778 The possible arguments are printed in brackets after the tag's name.
7779 The default argument is typeset
7780 \begin_inset Flex Code
7783 \begin_layout Plain Layout
7792 If the argument has a data type like
7793 \begin_inset Quotes eld
7797 \begin_inset Quotes erd
7801 \begin_inset Quotes eld
7805 \begin_inset Quotes erd
7808 , the default is shown like this:
7809 \begin_inset Flex Code
7812 \begin_layout Plain Layout
7823 \begin_layout Subsection
7824 The document class declaration and classification
7827 \begin_layout Standard
7828 Lines in a layout file which begin with
7829 \begin_inset Flex Code
7832 \begin_layout Plain Layout
7839 There is one exception to this rule.
7841 \begin_inset Flex Code
7844 \begin_layout Plain Layout
7850 files should begin with lines like:
7853 \begin_layout LyX-Code
7856 #% Do not delete the line below; configure depends on this
7859 \begin_layout LyX-Code
7864 DeclareLaTeXClass{Article (Standard Class)}
7867 \begin_layout LyX-Code
7872 DeclareCategory{Articles}
7875 \begin_layout Standard
7876 The second and third lines are used when you (re)configure \SpecialChar LyX
7878 The layout file is read by the \SpecialChar LaTeX
7880 \begin_inset Flex Code
7883 \begin_layout Plain Layout
7889 , in a special mode where
7890 \begin_inset Flex Code
7893 \begin_layout Plain Layout
7900 The first line is just a \SpecialChar LaTeX
7901 comment, the second one contains the mandatory
7902 declaration of the text class and the third line contains the optional
7903 classification of the class.
7904 If these lines appear in a file named
7905 \begin_inset Flex Code
7908 \begin_layout Plain Layout
7914 , then they define a text class of name
7915 \begin_inset Flex Code
7918 \begin_layout Plain Layout
7924 (the name of the layout file) which uses the \SpecialChar LaTeX
7926 \begin_inset Flex Code
7929 \begin_layout Plain Layout
7935 (the default is to use the same name as the layout).
7937 \begin_inset Quotes eld
7940 Article (Standard Class)
7941 \begin_inset Quotes erd
7944 that appears above is used as a description of the text class in the
7945 \begin_inset Flex Noun
7948 \begin_layout Plain Layout
7949 Document\SpecialChar menuseparator
7957 \begin_inset Quotes eld
7961 \begin_inset Quotes erd
7964 in the example) is also used in the
7965 \begin_inset Flex Noun
7968 \begin_layout Plain Layout
7969 Document\SpecialChar menuseparator
7975 dialog: the text classes are grouped by these categories (which are usually
7976 genres, so typical categories are
7977 \begin_inset Quotes eld
7981 \begin_inset Quotes erd
7985 \begin_inset Quotes eld
7989 \begin_inset Quotes erd
7993 \begin_inset Quotes eld
7997 \begin_inset Quotes erd
8001 \begin_inset Quotes eld
8005 \begin_inset Quotes erd
8009 \begin_inset Quotes eld
8013 \begin_inset Quotes erd
8017 \begin_inset Quotes eld
8021 \begin_inset Quotes erd
8025 If no category has been declared, the class will be put in the
8026 \begin_inset Quotes eld
8030 \begin_inset Quotes erd
8036 \begin_layout Standard
8037 Let's assume that you wrote your own text class that uses the
8038 \begin_inset Flex Code
8041 \begin_layout Plain Layout
8047 document class, but where you changed the appearance of the section headings.
8048 If you put it in a file
8049 \begin_inset Flex Code
8052 \begin_layout Plain Layout
8058 , the header of this file should be:
8061 \begin_layout LyX-Code
8064 #% Do not delete the line below; configure depends on this
8067 \begin_layout LyX-Code
8072 DeclareLaTeXClass[article]{Article (with My Own Headings)}
8075 \begin_layout LyX-Code
8080 DeclareCategory{Articles}
8083 \begin_layout Standard
8084 This declares a text class
8085 \begin_inset Flex Code
8088 \begin_layout Plain Layout
8094 , associated with the \SpecialChar LaTeX
8096 \begin_inset Flex Code
8099 \begin_layout Plain Layout
8106 \begin_inset Quotes eld
8109 Article (with My Own Headings)
8110 \begin_inset Quotes erd
8114 If your text class depends on several packages, you can declare it as:
8117 \begin_layout LyX-Code
8120 #% Do not delete the line below; configure depends on this
8123 \begin_layout LyX-Code
8128 DeclareLaTeXClass[article,foo.sty]{Article (with My Own Headings)}
8131 \begin_layout LyX-Code
8136 DeclareCategory{Articles}
8139 \begin_layout Standard
8140 This indicates that your text class uses the
8141 \begin_inset Flex Code
8144 \begin_layout Plain Layout
8151 Finally, it is also possible to declare classes for DocBook code.
8152 Typical declarations will look like:
8155 \begin_layout LyX-Code
8158 #% Do not delete the line below; configure depends on this
8161 \begin_layout LyX-Code
8166 DeclareDocBookClass[article]{SGML (DocBook Article)}
8169 \begin_layout LyX-Code
8174 DeclareCategory{Articles (DocBook)}
8177 \begin_layout Standard
8178 Note that these declarations can also be given an optional parameter declaring
8179 the name of the document class (but not a list).
8182 \begin_layout Standard
8183 So, to be as explicit as possible, the form of the layout declaration is:
8186 \begin_layout LyX-Code
8191 DeclareLaTeXClass[class,package.sty]{layout description}
8194 \begin_layout LyX-Code
8199 DeclareCategory{category}
8202 \begin_layout Standard
8203 The class need only be specified if the name of the \SpecialChar LaTeX
8205 name of the layout file are different or if there are packages to load.
8206 If the name of the class file is not specified, then \SpecialChar LyX
8208 that it is the same as the name of the layout file.
8211 \begin_layout Standard
8212 When the text class has been modified to your taste, all you have to do
8213 is to copy it either to
8214 \begin_inset Flex Code
8217 \begin_layout Plain Layout
8224 \begin_inset Flex Code
8227 \begin_layout Plain Layout
8234 \begin_inset Flex Noun
8237 \begin_layout Plain Layout
8238 Tools\SpecialChar menuseparator
8244 , exit \SpecialChar LyX
8246 Then your new text class should be available along with the others.
8249 \begin_layout Standard
8250 Once the layout file is installed, you can edit it and see your changes
8251 without having to reconfigure or to restart \SpecialChar LyX
8256 \begin_layout Plain Layout
8257 In versions of \SpecialChar LyX
8258 prior to 1.6, this was not true.
8259 As a result, editing layout files was very time consuming, since you had
8260 constantly to restart \SpecialChar LyX
8266 You can force a reload of the current layout by using the \SpecialChar LyX
8268 \begin_inset Flex Noun
8271 \begin_layout Plain Layout
8278 There is no default binding for this function—though, of course, you can
8279 bind it to a key yourself.
8280 But you will normally use this function simply by entering it in the mini-buffe
8285 \begin_layout Standard
8291 \begin_inset Flex Noun
8294 \begin_layout Plain Layout
8300 is very much an `advanced feature'.
8305 recommended that you save your work before using this function.
8310 recommended that you not attempt to edit layout information while simultaneousl
8311 y working on a document that you care about.
8312 Use a test document.
8313 Syntax errors and the like in your layout file could cause peculiar behavior.
8314 In particular, such errors could cause \SpecialChar LyX
8315 to regard the current layout as
8316 invalid and to attempt to switch to some other layout.
8320 \begin_layout Plain Layout
8321 Really bad syntax errors may even caused \SpecialChar LyX
8323 This is because certain sorts of errors may make \SpecialChar LyX
8334 The \SpecialChar LyX
8335 team strives to keep \SpecialChar LyX
8336 stable in such situations, but safe is better
8341 \begin_layout Plain Layout
8342 While we're giving advice: make regular backups.
8343 And be nice to your mother.
8351 \begin_layout Subsection
8352 The Module declaration
8355 \begin_layout Standard
8356 A module must begin with a line like the following:
8359 \begin_layout LyX-Code
8362 DeclareLyXModule[endnotes.sty]{Endnotes}
8365 \begin_layout Standard
8366 The mandatory argument, in curly brackets, is the name of the module, as
8368 \begin_inset Flex Noun
8371 \begin_layout Plain Layout
8372 Document\SpecialChar menuseparator
8373 Settings\SpecialChar menuseparator
8380 The argument in square brackets is optional: It declares any \SpecialChar LaTeX
8382 on which the module depends.
8383 It is also possible to use the form
8384 \begin_inset Flex Noun
8387 \begin_layout Plain Layout
8393 as an optional argument, which declares that the module can only be used
8394 when there exists a conversion chain between the formats `
8395 \begin_inset Flex Code
8398 \begin_layout Plain Layout
8405 \begin_inset Flex Code
8408 \begin_layout Plain Layout
8417 \begin_layout Standard
8418 The module declaration should then be followed by lines like the following:
8422 \begin_layout Plain Layout
8423 Preferably in English if the module should be published with \SpecialChar LyX
8425 This description will appear in the list of messages to be translated and
8426 will be thus translated with the next interface update.
8434 \begin_layout LyX-Code
8438 \begin_layout LyX-Code
8439 #Adds an endnote command, in addition to footnotes.
8443 \begin_layout LyX-Code
8444 #You will need to add
8446 theendnotes in TeX code where you
8449 \begin_layout LyX-Code
8450 #want the endnotes to appear.
8454 \begin_layout LyX-Code
8458 \begin_layout LyX-Code
8459 #Requires: somemodule | othermodule
8462 \begin_layout LyX-Code
8463 #Excludes: badmodule
8466 \begin_layout Standard
8467 The description is used in
8468 \begin_inset Flex Noun
8471 \begin_layout Plain Layout
8472 Document\SpecialChar menuseparator
8473 Settings\SpecialChar menuseparator
8479 to provide the user with information about what the module does.
8481 \begin_inset Flex Code
8484 \begin_layout Plain Layout
8490 line is used to identify other modules with which this one must be used;
8492 \begin_inset Flex Code
8495 \begin_layout Plain Layout
8501 line is used to identify modules with which this one may not be used.
8502 Both are optional, and, as shown, multiple modules should be separated
8503 with the pipe symbol: |.
8504 Note that the required modules are treated disjunctively:
8508 of the required modules must be used.
8513 excluded module may be used.
8514 Note that modules are identified here by their filenames without the
8515 \begin_inset Flex Code
8518 \begin_layout Plain Layout
8526 \begin_inset Flex Code
8529 \begin_layout Plain Layout
8536 \begin_inset Flex Code
8539 \begin_layout Plain Layout
8548 \begin_layout Subsection
8549 The CiteEngine file declaration
8552 \begin_layout Standard
8553 A cite engine file must begin with a line like the following:
8556 \begin_layout LyX-Code
8559 DeclareLyXCiteEngineModule[biblatex.sty]{Biblatex}
8562 \begin_layout Standard
8563 The mandatory argument, in curly brackets, is the name of the cite style,
8564 as it should appear in
8565 \begin_inset Flex Noun
8568 \begin_layout Plain Layout
8569 Document\SpecialChar menuseparator
8570 Settings\SpecialChar menuseparator
8577 The argument in square brackets is optional: It declares any \SpecialChar LaTeX
8579 on which the cite engine depends.
8582 \begin_layout Standard
8583 The cite engine declaration should then be followed by lines like the following:
8587 \begin_layout Plain Layout
8588 Preferably in English if the module should be published with \SpecialChar LyX
8590 This description will appear in the list of messages to be translated and
8591 will be thus translated with the next interface update.
8599 \begin_layout LyX-Code
8603 \begin_layout LyX-Code
8604 # Biblatex supports many author-year and numerical styles.
8607 \begin_layout LyX-Code
8608 # It is mainly aimed at the Humanities.
8612 \begin_layout LyX-Code
8613 # customizable, fully localized and provides many features
8616 \begin_layout LyX-Code
8617 # that are not possible with BibTeX.
8618 The use of 'biber' as
8621 \begin_layout LyX-Code
8622 # bibliography processor is advised.
8625 \begin_layout LyX-Code
8629 \begin_layout Standard
8630 The description is used in
8631 \begin_inset Flex Noun
8634 \begin_layout Plain Layout
8635 Document\SpecialChar menuseparator
8636 Settings\SpecialChar menuseparator
8642 to provide the user with information about the cite engine.
8645 \begin_layout Subsection
8649 \begin_layout Standard
8650 The first non-comment line of any layout file, included file, or module
8655 contain the file format number:
8658 \begin_layout Description
8659 \begin_inset Flex Code
8662 \begin_layout Plain Layout
8669 \begin_inset Flex Code
8672 \begin_layout Plain Layout
8678 ] The format number of the layout file.
8681 \begin_layout Standard
8682 This tag was introduced with \SpecialChar LyX
8684 \begin_inset space ~
8688 Layout files from older \SpecialChar LyX
8689 versions do not have an explicit file format and
8690 are considered to have
8691 \begin_inset Flex Code
8694 \begin_layout Plain Layout
8696 \begin_inset space ~
8705 The format for the present version of \SpecialChar LyX
8707 But each version of \SpecialChar LyX
8708 is capable of reading earlier versions' layout files,
8709 just as they are capable of reading files produced by earlier versions
8712 There is, however, no provision for converting to earlier formats.
8715 \begin_layout Subsection
8716 \begin_inset CommandInset label
8718 name "subsec:General-text-class"
8722 General text class parameters
8725 \begin_layout Standard
8726 These are general parameters that govern the behavior of an entire document
8732 mean that they must appear in
8733 \begin_inset Flex Code
8736 \begin_layout Plain Layout
8742 files rather than in modules.
8743 A module can contain any layout tag.)
8746 \begin_layout Description
8747 \begin_inset Flex Code
8750 \begin_layout Plain Layout
8756 Adds information that will be output in the
8757 \begin_inset Flex Code
8760 \begin_layout Plain Layout
8766 block when the document is output to XHTML.
8767 Typically, this would be used to output CSS style information, but it can
8768 be used for anything that can appear in
8769 \begin_inset Flex Code
8772 \begin_layout Plain Layout
8780 \begin_inset Quotes eld
8784 \begin_inset Flex Code
8787 \begin_layout Plain Layout
8794 \begin_inset Quotes erd
8800 \begin_layout Description
8801 \begin_inset Flex Code
8804 \begin_layout Plain Layout
8810 Adds information to the document preamble.
8812 \begin_inset Newline newline
8816 \begin_inset Quotes eld
8820 \begin_inset Flex Code
8823 \begin_layout Plain Layout
8830 \begin_inset Quotes erd
8836 \begin_layout Description
8837 \begin_inset Flex Code
8840 \begin_layout Plain Layout
8846 Defines the possibilities for displaying citation references.
8848 \begin_inset CommandInset ref
8850 reference "subsec:Citation-engine-description"
8859 \begin_inset Quotes eld
8863 \begin_inset Flex Code
8866 \begin_layout Plain Layout
8873 \begin_inset Quotes erd
8877 Primarily used in cite engine files (see
8878 \begin_inset CommandInset ref
8880 reference "subsec:Cite-Engine-Files"
8890 \begin_layout Description
8891 \begin_inset Flex Code
8894 \begin_layout Plain Layout
8900 Defines formats for use in the display of bibliographic information.
8902 \begin_inset CommandInset ref
8904 reference "subsec:Citation-format-description"
8910 \begin_inset Quotes eld
8914 \begin_inset Flex Code
8917 \begin_layout Plain Layout
8924 \begin_inset Quotes erd
8928 Primarily used in cite engine files (see
8929 \begin_inset CommandInset ref
8931 reference "subsec:Cite-Engine-Files"
8941 \begin_layout Description
8942 \begin_inset Flex Code
8945 \begin_layout Plain Layout
8952 \begin_inset Flex Code
8955 \begin_layout Plain Layout
8964 \begin_inset Flex Code
8967 \begin_layout Plain Layout
8973 ] Determines whether
8977 or Bib\SpecialChar TeX
8978 is used to generate a Bibliography.
8979 Primarily used in cite engine files (see
8980 \begin_inset CommandInset ref
8982 reference "subsec:Cite-Engine-Files"
8992 \begin_layout Description
8993 \begin_inset Flex Code
8996 \begin_layout Plain Layout
9002 Describes various global options supported by the document class.
9004 \begin_inset CommandInset ref
9006 reference "subsec:ClassOptions"
9012 \begin_inset Quotes eld
9016 \begin_inset Flex Code
9019 \begin_layout Plain Layout
9026 \begin_inset Quotes erd
9032 \begin_layout Description
9033 \begin_inset Flex Code
9036 \begin_layout Plain Layout
9043 \begin_inset Flex Code
9046 \begin_layout Plain Layout
9055 \begin_inset space \thinspace{}
9059 \begin_inset Flex Code
9062 \begin_layout Plain Layout
9068 ] Whether the class should
9072 to having one or two columns.
9073 Can be changed in the
9074 \begin_inset Flex Noun
9077 \begin_layout Plain Layout
9078 Document\SpecialChar menuseparator
9087 \begin_layout Description
9088 \begin_inset Flex Code
9091 \begin_layout Plain Layout
9098 \begin_inset Flex Code
9101 \begin_layout Plain Layout
9107 ] This sequence defines the properties for a counter.
9108 If the counter does not yet exist, it is created; if it does exist, it
9111 \begin_inset Quotes eld
9115 \begin_inset Flex Code
9118 \begin_layout Plain Layout
9125 \begin_inset Quotes erd
9129 \begin_inset Newline newline
9133 \begin_inset CommandInset ref
9135 reference "subsec:Counters"
9139 for details on counters.
9142 \begin_layout Description
9143 \begin_inset Flex Code
9146 \begin_layout Plain Layout
9152 Sets the default font used to display the document.
9154 \begin_inset CommandInset ref
9156 reference "subsec:Font-description"
9160 for how to declare fonts.
9162 \begin_inset Quotes eld
9166 \begin_inset Flex Code
9169 \begin_layout Plain Layout
9176 \begin_inset Quotes erd
9182 \begin_layout Description
9183 \begin_inset Flex Code
9186 \begin_layout Plain Layout
9193 \begin_inset Flex Code
9196 \begin_layout Plain Layout
9202 ] Specifies a module to be included by default with this document class.
9203 The module is specified as filename without the
9204 \begin_inset Flex Code
9207 \begin_layout Plain Layout
9214 The user can still remove the module, but it will be active at the outset.
9215 (This applies only when new files are created, or when this class is chosen
9216 for an existing document.)
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 ] This is the style that will be assigned to new paragraphs, usually
9240 \begin_inset Flex Noun
9243 \begin_layout Plain Layout
9250 This will default to the first defined style if not given, but you are
9251 encouraged to use this directive.
9254 \begin_layout Description
9255 \begin_inset Flex Code
9258 \begin_layout Plain Layout
9265 \begin_inset Flex Code
9268 \begin_layout Plain Layout
9274 ] This tag indicates that the module (which is specified by filename without
9276 \begin_inset Flex Code
9279 \begin_layout Plain Layout
9285 extension) cannot be used with this document class.
9286 This might be used in a journal-specific layout file to prevent, say, the
9288 \begin_inset Flex Code
9291 \begin_layout Plain Layout
9297 module that numbers theorems by section.
9302 be used in a module.
9303 Modules have their own way of excluding other modules (see
9304 \begin_inset CommandInset ref
9306 reference "subsec:Layout-modules"
9313 \begin_layout Description
9314 \begin_inset Flex Code
9317 \begin_layout Plain Layout
9323 Defines a new float.
9325 \begin_inset CommandInset ref
9327 reference "subsec:Floats"
9333 \begin_inset Quotes eld
9337 \begin_inset Flex Code
9340 \begin_layout Plain Layout
9347 \begin_inset Quotes erd
9353 \begin_layout Description
9354 \begin_inset Flex Code
9357 \begin_layout Plain Layout
9363 Sets the information that will be output in the
9364 \begin_inset Flex Code
9367 \begin_layout Plain Layout
9373 block when this document class is output to XHTML.
9374 Note that this will completely override any prior
9375 \begin_inset Flex Code
9378 \begin_layout Plain Layout
9385 \begin_inset Flex Code
9388 \begin_layout Plain Layout
9396 \begin_inset Newline newline
9400 \begin_inset Flex Code
9403 \begin_layout Plain Layout
9409 if you just want to add material to the preamble.) Must end with
9410 \begin_inset Quotes eld
9414 \begin_inset Flex Code
9417 \begin_layout Plain Layout
9424 \begin_inset Quotes erd
9430 \begin_layout Description
9431 \begin_inset Flex Code
9434 \begin_layout Plain Layout
9441 \begin_inset Flex Code
9444 \begin_layout Plain Layout
9450 ] The style to use for the table of contents, bibliography, and so forth,
9451 when the document is output to HTML.
9452 For articles, this should normally be
9453 \begin_inset Flex Code
9456 \begin_layout Plain Layout
9463 \begin_inset Flex Code
9466 \begin_layout Plain Layout
9473 If it is not given, then \SpecialChar LyX
9474 will attempt to figure out which layout to use.
9477 \begin_layout Description
9478 \begin_inset Flex Code
9481 \begin_layout Plain Layout
9488 \begin_inset Flex Code
9491 \begin_layout Plain Layout
9497 ] Modifies the properties of the given counter.
9498 If the counter does not exist, the statement is ignored.
9500 \begin_inset Quotes eld
9504 \begin_inset Flex Code
9507 \begin_layout Plain Layout
9514 \begin_inset Quotes erd
9518 \begin_inset Newline newline
9522 \begin_inset CommandInset ref
9524 reference "subsec:Counters"
9528 for details on counters.
9531 \begin_layout Description
9532 \begin_inset Flex Code
9535 \begin_layout Plain Layout
9542 \begin_inset Flex Code
9545 \begin_layout Plain Layout
9551 ] This allows you to include another layout definition file within yours
9552 to avoid duplicating commands.
9553 Common examples are the standard layout files, for example,
9554 \begin_inset Flex Code
9557 \begin_layout Plain Layout
9563 , which contains most of the basic layouts.
9566 \begin_layout Description
9567 \begin_inset Flex Code
9570 \begin_layout Plain Layout
9577 \begin_inset Flex Code
9580 \begin_layout Plain Layout
9586 ] This section (re-)defines the layout of an inset.
9587 It can be applied to an existing inset or to a new, user-defined inset,
9588 e.g., a new character style.
9590 \begin_inset Quotes eld
9594 \begin_inset Flex Code
9597 \begin_layout Plain Layout
9604 \begin_inset Quotes erd
9608 \begin_inset Newline newline
9612 \begin_inset CommandInset ref
9614 reference "subsec:Flex-insets-and"
9618 for more information.
9622 \begin_layout Description
9623 \begin_inset Flex Code
9626 \begin_layout Plain Layout
9633 \begin_inset Flex Code
9636 \begin_layout Plain Layout
9642 ] A string that indicates the width of the left margin on the screen, for
9644 \begin_inset Quotes eld
9648 \begin_inset Flex Code
9651 \begin_layout Plain Layout
9658 \begin_inset Quotes erd
9662 (Note that this is not a `length', like
9663 \begin_inset Quotes eld
9667 \begin_inset Quotes erd
9673 \begin_layout Description
9674 \begin_inset Flex Code
9677 \begin_layout Plain Layout
9684 \begin_inset Flex Code
9687 \begin_layout Plain Layout
9693 ] An integer that determines the maximal number of names displayed in an
9694 author-year citation before the citation switches to
9695 \begin_inset Quotes eld
9699 \begin_inset Quotes erd
9703 Primarily used in cite engine files (see
9704 \begin_inset CommandInset ref
9706 reference "subsec:Cite-Engine-Files"
9716 \begin_layout Description
9717 \begin_inset Flex Code
9720 \begin_layout Plain Layout
9727 \begin_inset Flex Code
9730 \begin_layout Plain Layout
9736 ] Modifies the properties of the given paragraph style.
9737 If the style does not exist, this section is ignored.
9739 \begin_inset Quotes eld
9743 \begin_inset Flex Code
9746 \begin_layout Plain Layout
9753 \begin_inset Quotes erd
9759 \begin_layout Description
9760 \begin_inset Flex Code
9763 \begin_layout Plain Layout
9770 \begin_inset Flex Code
9773 \begin_layout Plain Layout
9779 ] Deletes an existing counter, usually one defined in an included file.
9782 \begin_layout Description
9783 \begin_inset Flex Code
9786 \begin_layout Plain Layout
9793 \begin_inset Flex Code
9796 \begin_layout Plain Layout
9802 ] Deletes an existing float.
9803 This is particularly useful when you want to suppress a float that has
9804 been defined in an input file.
9807 \begin_layout Description
9808 \begin_inset Flex Code
9811 \begin_layout Plain Layout
9818 \begin_inset Flex Code
9821 \begin_layout Plain Layout
9827 ] Deletes an existing style.
9830 \begin_layout Description
9831 \begin_inset Flex Code
9834 \begin_layout Plain Layout
9841 \begin_inset Flex Code
9844 \begin_layout Plain Layout
9851 \begin_inset Flex Code
9854 \begin_layout Plain Layout
9860 ] Define a new table of contents with type
9861 \begin_inset Flex Code
9864 \begin_layout Plain Layout
9871 \begin_inset Flex Code
9874 \begin_layout Plain Layout
9881 See also the AddToToc commands.
9884 \begin_layout Description
9885 \begin_inset Flex Code
9888 \begin_layout Plain Layout
9895 \begin_inset Flex Code
9898 \begin_layout Plain Layout
9904 ] The file format (as defined in the \SpecialChar LyX
9905 preferences) produced by this document
9907 It is mainly useful when
9908 \begin_inset Flex Code
9911 \begin_layout Plain Layout
9918 \begin_inset Flex Code
9921 \begin_layout Plain Layout
9927 and one wants to define a new type of literate document.
9928 The format is reset to
9929 \begin_inset Quotes eld
9933 \begin_inset Flex Code
9936 \begin_layout Plain Layout
9943 \begin_inset Quotes erd
9947 \begin_inset Quotes eld
9951 \begin_inset Flex Code
9954 \begin_layout Plain Layout
9961 \begin_inset Quotes erd
9964 when the corresponding
9965 \begin_inset Flex Code
9968 \begin_layout Plain Layout
9974 parameter is encountered.
9977 \begin_layout Description
9978 \begin_inset Flex Code
9981 \begin_layout Plain Layout
9988 \begin_inset Flex Code
9991 \begin_layout Plain Layout
10002 \begin_inset Flex Code
10005 \begin_layout Plain Layout
10012 \begin_inset Flex Code
10015 \begin_layout Plain Layout
10021 ] Specifies what sort of output documents using this class will produce.
10024 \begin_layout Description
10025 \begin_inset Flex Code
10028 \begin_layout Plain Layout
10035 \begin_inset Flex Code
10038 \begin_layout Plain Layout
10045 \begin_inset Flex Code
10048 \begin_layout Plain Layout
10054 ] Specifies options, given in the second string, for the package named by
10057 \begin_inset Quotes eld
10061 \begin_inset Flex Code
10064 \begin_layout Plain Layout
10065 PackageOptions natbib square
10071 \begin_inset Quotes erd
10075 \begin_inset Flex Code
10078 \begin_layout Plain Layout
10084 to be loaded with the
10085 \begin_inset Flex Code
10088 \begin_layout Plain Layout
10095 (For \SpecialChar TeX
10096 perts, this causes \SpecialChar LyX
10098 \begin_inset Flex Code
10101 \begin_layout Plain Layout
10104 PassOptionsToPackage{natbib}{square}
10110 \begin_inset Flex Code
10113 \begin_layout Plain Layout
10122 \begin_layout Description
10123 \begin_inset Flex Code
10126 \begin_layout Plain Layout
10133 \begin_inset Flex Code
10136 \begin_layout Plain Layout
10145 \begin_inset Flex Code
10148 \begin_layout Plain Layout
10155 \begin_inset Flex Code
10158 \begin_layout Plain Layout
10164 ] The default pagestyle.
10165 Can be changed in the
10166 \begin_inset Flex Noun
10169 \begin_layout Plain Layout
10170 Document\SpecialChar menuseparator
10179 \begin_layout Description
10180 \begin_inset Flex Code
10183 \begin_layout Plain Layout
10189 Sets the preamble for the \SpecialChar LaTeX
10191 Note that this will completely override any prior
10192 \begin_inset Flex Code
10195 \begin_layout Plain Layout
10202 \begin_inset Flex Code
10205 \begin_layout Plain Layout
10213 \begin_inset Flex Code
10216 \begin_layout Plain Layout
10222 if you just want to add material to the preamble.) Must end with
10223 \begin_inset Quotes eld
10227 \begin_inset Flex Code
10230 \begin_layout Plain Layout
10237 \begin_inset Quotes erd
10243 \begin_layout Description
10244 \begin_inset Flex Code
10247 \begin_layout Plain Layout
10254 \begin_inset Flex Code
10257 \begin_layout Plain Layout
10264 \begin_inset Flex Code
10267 \begin_layout Plain Layout
10276 \begin_inset space \thinspace{}
10280 \begin_inset Flex Code
10283 \begin_layout Plain Layout
10289 ] Whether the class already provides the feature
10290 \begin_inset Flex Code
10293 \begin_layout Plain Layout
10300 A feature is in general the name of a package (e.
10301 \begin_inset space \thinspace{}
10305 \begin_inset space \space{}
10309 \begin_inset Flex Code
10312 \begin_layout Plain Layout
10319 \begin_inset Flex Code
10322 \begin_layout Plain Layout
10329 \begin_inset space \thinspace{}
10333 \begin_inset space \space{}
10337 \begin_inset Flex Code
10340 \begin_layout Plain Layout
10347 \begin_inset Flex Code
10350 \begin_layout Plain Layout
10358 \begin_inset CommandInset ref
10360 reference "chap:List-of-functions"
10364 for the list of features.
10367 \begin_layout Description
10368 \begin_inset Flex Code
10371 \begin_layout Plain Layout
10378 \begin_inset Flex Code
10381 \begin_layout Plain Layout
10387 ] Indicates that this layout provides the functionality of the module mentioned,
10388 which should be specified by the filename without the
10389 \begin_inset Flex Code
10392 \begin_layout Plain Layout
10399 This will typically be used if the layout includes the module directly,
10400 rather than using the
10401 \begin_inset Flex Code
10404 \begin_layout Plain Layout
10410 tag to indicate that it ought to be used.
10411 It could also be used in a module that provided an alternate implementation
10412 of the same functionality.
10415 \begin_layout Description
10416 \begin_inset Flex Code
10419 \begin_layout Plain Layout
10426 \begin_inset Flex Code
10429 \begin_layout Plain Layout
10435 ] Creates a new paragraph style if it does not already exist.
10436 If the style does exist, this section is ignored.
10438 \begin_inset Quotes eld
10442 \begin_inset Flex Code
10445 \begin_layout Plain Layout
10452 \begin_inset Quotes erd
10458 \begin_layout Description
10459 \begin_inset Flex Code
10462 \begin_layout Plain Layout
10469 \begin_inset Flex Code
10472 \begin_layout Plain Layout
10478 ] Whether the class requires the feature
10479 \begin_inset Flex Code
10482 \begin_layout Plain Layout
10489 Multiple features must be separated by commas.
10490 Note that you can only request supported features.
10492 \begin_inset CommandInset ref
10494 reference "chap:List-of-functions"
10498 for the list of features.).
10499 If you require a package with specific options, you can additionally use
10501 \begin_inset Flex Code
10504 \begin_layout Plain Layout
10513 \begin_layout Description
10514 \begin_inset Flex Code
10517 \begin_layout Plain Layout
10524 \begin_inset Flex Code
10527 \begin_layout Plain Layout
10533 ] A string that indicates the width of the right margin on the screen, for
10535 \begin_inset Quotes eld
10539 \begin_inset Flex Code
10542 \begin_layout Plain Layout
10549 \begin_inset Quotes erd
10555 \begin_layout Description
10556 \begin_inset Flex Code
10559 \begin_layout Plain Layout
10566 \begin_inset Flex Code
10569 \begin_layout Plain Layout
10575 ] Sets which divisions get numbered.
10577 \begin_inset Newline newline
10581 \begin_inset Flex Code
10584 \begin_layout Plain Layout
10590 counter in \SpecialChar LaTeX
10594 \begin_layout Description
10595 \begin_inset Flex Code
10598 \begin_layout Plain Layout
10605 \begin_inset Flex Code
10608 \begin_layout Plain Layout
10617 \begin_inset space \thinspace{}
10621 \begin_inset Flex Code
10624 \begin_layout Plain Layout
10630 ] Whether the class-default should be printing on one or both sides of the
10632 Can be changed in the
10633 \begin_inset Flex Noun
10636 \begin_layout Plain Layout
10637 Document\SpecialChar menuseparator
10646 \begin_layout Description
10647 \begin_inset Flex Code
10650 \begin_layout Plain Layout
10657 \begin_inset Flex Code
10660 \begin_layout Plain Layout
10666 ] This sequence defines a paragraph style.
10667 If the style does not yet exist, it is created; if it does exist, its parameter
10670 \begin_inset Quotes eld
10674 \begin_inset Flex Code
10677 \begin_layout Plain Layout
10684 \begin_inset Quotes erd
10688 \begin_inset Newline newline
10692 \begin_inset CommandInset ref
10694 reference "subsec:Paragraph-Styles"
10698 for details on paragraph styles.
10701 \begin_layout Description
10702 \begin_inset Flex Code
10705 \begin_layout Plain Layout
10712 \begin_inset Flex Code
10715 \begin_layout Plain Layout
10721 ] The name of the command or environment to be used with
10722 \begin_inset Flex Code
10725 \begin_layout Plain Layout
10734 \begin_layout Description
10735 \begin_inset Flex Code
10738 \begin_layout Plain Layout
10745 \begin_inset Flex Code
10748 \begin_layout Plain Layout
10757 \begin_inset Flex Code
10760 \begin_layout Plain Layout
10766 ] Indicates what kind of markup is used to define the title of a document.
10768 \begin_inset Flex Code
10771 \begin_layout Plain Layout
10777 means that the macro with name
10778 \begin_inset Flex Code
10781 \begin_layout Plain Layout
10787 will be inserted after the last layout which has
10788 \begin_inset Quotes eld
10792 \begin_inset Flex Code
10795 \begin_layout Plain Layout
10797 \begin_inset space ~
10806 \begin_inset Quotes erd
10811 \begin_inset Flex Code
10814 \begin_layout Plain Layout
10820 corresponds to the case where all layouts which have
10821 \begin_inset Quotes eld
10825 \begin_inset Flex Code
10828 \begin_layout Plain Layout
10830 \begin_inset space ~
10839 \begin_inset Quotes erd
10842 should be enclosed into the
10843 \begin_inset Flex Code
10846 \begin_layout Plain Layout
10855 \begin_layout Description
10856 \begin_inset Flex Code
10859 \begin_layout Plain Layout
10866 \begin_inset Flex Code
10869 \begin_layout Plain Layout
10875 ] Sets which divisions are included in the table of contents.
10877 \begin_inset Flex Code
10880 \begin_layout Plain Layout
10886 counter in \SpecialChar LaTeX
10890 \begin_layout Subsection
10891 \begin_inset Flex Code
10894 \begin_layout Plain Layout
10901 \begin_inset CommandInset label
10903 name "subsec:ClassOptions"
10910 \begin_layout Standard
10912 \begin_inset Flex Code
10915 \begin_layout Plain Layout
10921 section can contain the following entries:
10924 \begin_layout Description
10925 \begin_inset Flex Code
10928 \begin_layout Plain Layout
10935 \begin_inset Flex Code
10938 \begin_layout Plain Layout
10944 ] The list of available font sizes for the document's main font, separated
10946 \begin_inset Quotes eld
10950 \begin_inset Flex Code
10953 \begin_layout Plain Layout
10960 \begin_inset Quotes erd
10966 \begin_layout Description
10967 \begin_inset Flex Code
10970 \begin_layout Plain Layout
10976 Used to set the DTD line with XML-based output classes.
10978 \begin_inset space \thinspace{}
10982 \begin_inset Quotes eld
10985 -//OASIS//DTD DocBook V4.2//EN
10986 \begin_inset Quotes erd
10992 \begin_layout Description
10993 \begin_inset Flex Code
10996 \begin_layout Plain Layout
11003 \begin_inset Flex Code
11006 \begin_layout Plain Layout
11007 string="empty|plain|headings|fancy"
11012 ] The list of available page sty\SpecialChar softhyphen
11014 \begin_inset Quotes eld
11018 \begin_inset Flex Code
11021 \begin_layout Plain Layout
11028 \begin_inset Quotes erd
11034 \begin_layout Description
11035 \begin_inset Flex Code
11038 \begin_layout Plain Layout
11045 \begin_inset Flex Code
11048 \begin_layout Plain Layout
11054 ] Some document class options, separated by a comma, that will be added
11055 to the optional part of the
11056 \begin_inset Flex Code
11059 \begin_layout Plain Layout
11070 \begin_layout Standard
11072 \begin_inset Flex Code
11075 \begin_layout Plain Layout
11081 section must end with
11082 \begin_inset Quotes eld
11086 \begin_inset Flex Code
11089 \begin_layout Plain Layout
11096 \begin_inset Quotes erd
11102 \begin_layout Subsection
11104 \begin_inset CommandInset label
11106 name "subsec:Paragraph-Styles"
11113 \begin_layout Standard
11114 A paragraph style description looks like this:
11118 \begin_layout Plain Layout
11119 Note that this will either define a new style or modify an existing one.
11127 \begin_layout LyX-Code
11134 \begin_layout LyX-Code
11138 \begin_layout LyX-Code
11142 \begin_layout Standard
11143 where the following commands are allowed:
11146 \begin_layout Description
11147 \begin_inset Flex Code
11150 \begin_layout Plain Layout
11157 \begin_inset Flex Code
11160 \begin_layout Plain Layout
11166 =""] This paragraph will appear in the table of contents of the given type.
11167 An empty string disables.
11168 See also the OutlinerName and the IsTocCaption commands.
11172 \begin_layout Description
11173 \begin_inset Flex Code
11176 \begin_layout Plain Layout
11183 \begin_inset Flex Code
11186 \begin_layout Plain Layout
11191 , left, right, center
11196 ] Paragraph alignment.
11199 \begin_layout Description
11200 \begin_inset Flex Code
11203 \begin_layout Plain Layout
11210 \begin_inset Flex Code
11213 \begin_layout Plain Layout
11218 , left, right, center
11223 ] A comma separated list of permitted alignments.
11224 (Some \SpecialChar LaTeX
11225 styles prohibit certain alignments, since those wouldn't make sense.
11226 For example a right-aligned or centered enumeration isn't possible.)
11229 \begin_layout Description
11230 \begin_inset Flex Code
11233 \begin_layout Plain Layout
11240 \begin_inset Flex Code
11243 \begin_layout Plain Layout
11249 ] Defines argument number <int> of a command\SpecialChar breakableslash
11250 environment associated with
11252 This is useful for things like section headings, and only makes sense with
11255 Every (optional or required) argument of a command or environment – except
11256 for the required argument that is associated with the content of the paragraph
11257 itself – has a separate definition, where the number specifies the order
11259 The definition must end with
11260 \begin_inset Flex Code
11263 \begin_layout Plain Layout
11270 So a command with two optional arguments has:
11274 \begin_layout Quote
11280 \begin_layout Quote
11286 \begin_layout Quote
11292 \begin_layout Quote
11298 \begin_layout Quote
11304 \begin_layout Quote
11310 \begin_layout Standard
11312 \begin_inset Flex Code
11315 \begin_layout Plain Layout
11321 definition, the following specifications are possible:
11324 \begin_layout Itemize
11325 \begin_inset Flex Code
11328 \begin_layout Plain Layout
11335 \begin_inset Flex Code
11338 \begin_layout Plain Layout
11344 The string that will appear both in the menu (to insert this argument)
11345 and on the argument inset button (unless you also specify a separate
11346 \begin_inset Flex Code
11349 \begin_layout Plain Layout
11356 For the menu, you can define an accelerator by appending the respective
11357 character to the string, divided by
11358 \begin_inset Quotes eld
11362 \begin_inset Quotes erd
11366 \begin_inset space \thinspace{}
11370 \begin_inset space \space{}
11374 \begin_inset Quotes eld
11378 \begin_inset Flex Code
11381 \begin_layout Plain Layout
11388 \begin_inset Quotes erd
11394 \begin_layout Itemize
11395 \begin_inset Flex Code
11398 \begin_layout Plain Layout
11405 \begin_inset Flex Code
11408 \begin_layout Plain Layout
11414 A separate string for the menu.
11415 You can define an accelerator by appending the respective character to
11416 the string, divided by
11417 \begin_inset Quotes eld
11421 \begin_inset Quotes erd
11425 \begin_inset space \thinspace{}
11429 \begin_inset space \space{}
11433 \begin_inset Quotes eld
11437 \begin_inset Flex Code
11440 \begin_layout Plain Layout
11447 \begin_inset Quotes erd
11451 This specification is optional.
11452 If it is not given the
11453 \begin_inset Flex Code
11456 \begin_layout Plain Layout
11462 will be used instead for the menu.
11465 \begin_layout Itemize
11466 \begin_inset Flex Code
11469 \begin_layout Plain Layout
11476 \begin_inset Flex Code
11479 \begin_layout Plain Layout
11485 A longer explanatory text that appears in the tooltip when hovering over
11486 the argument inset.
11489 \begin_layout Itemize
11490 \begin_inset Flex Code
11493 \begin_layout Plain Layout
11500 \begin_inset Flex Code
11503 \begin_layout Plain Layout
11512 \begin_inset space \thinspace{}
11516 \begin_inset Flex Code
11519 \begin_layout Plain Layout
11525 ] Declare if this is a mandatory (1) or an optional (0) argument.
11526 Mandatory arguments will be output empty if not given, while optional arguments
11527 will not be output at all.
11528 By default, mandatory arguments are delimited by
11529 \begin_inset Flex Code
11532 \begin_layout Plain Layout
11538 , while optional arguments are delimited by
11539 \begin_inset Flex Code
11542 \begin_layout Plain Layout
11551 \begin_layout Itemize
11552 \begin_inset Flex Code
11555 \begin_layout Plain Layout
11562 \begin_inset Flex Code
11565 \begin_layout Plain Layout
11571 defines another argument (by its number) which this argument requires to
11572 be output if it is itself output.
11574 \begin_inset space \thinspace{}
11577 g., in \SpecialChar LaTeX
11578 commands, optional arguments often require previous optional arguments
11579 to be output (at least empty), as in
11580 \begin_inset Flex Code
11583 \begin_layout Plain Layout
11586 command[][argument]{text}
11592 This can be achieved by the statement
11593 \begin_inset Flex Code
11596 \begin_layout Plain Layout
11603 \begin_inset Flex Code
11606 \begin_layout Plain Layout
11615 \begin_layout Itemize
11616 \begin_inset Flex Code
11619 \begin_layout Plain Layout
11626 \begin_inset Flex Code
11629 \begin_layout Plain Layout
11635 defines a custom left delimiter (instead of
11636 \begin_inset Flex Code
11639 \begin_layout Plain Layout
11646 \begin_inset Flex Code
11649 \begin_layout Plain Layout
11656 A line break in the output can be indicated by
11657 \begin_inset Flex Code
11660 \begin_layout Plain Layout
11669 \begin_layout Itemize
11670 \begin_inset Flex Code
11673 \begin_layout Plain Layout
11680 \begin_inset Flex Code
11683 \begin_layout Plain Layout
11689 defines a custom right delimiter (instead of
11690 \begin_inset Flex Code
11693 \begin_layout Plain Layout
11700 \begin_inset Flex Code
11703 \begin_layout Plain Layout
11710 A line break in the output can be indicated by
11711 \begin_inset Flex Code
11714 \begin_layout Plain Layout
11723 \begin_layout Itemize
11724 \begin_inset Flex Code
11727 \begin_layout Plain Layout
11734 \begin_inset Flex Code
11737 \begin_layout Plain Layout
11743 defines an argument that is inserted if and only if no user-specified arguments
11745 \begin_inset space \thinspace{}
11749 \begin_inset space \space{}
11752 if no argument inset has been inserted (note that also an empty argument
11753 inset omits the DefaultArg).
11754 Multiple arguments need to be separated by comma.
11757 \begin_layout Itemize
11758 \begin_inset Flex Code
11761 \begin_layout Plain Layout
11768 \begin_inset Flex Code
11771 \begin_layout Plain Layout
11777 defines an argument that is inserted in any case (alone or in addition
11778 to user-specified arguments).
11779 Multiple arguments need to be separated by comma.
11782 \begin_layout Itemize
11783 \begin_inset Flex Code
11786 \begin_layout Plain Layout
11792 The font used for the argument content, see
11793 \begin_inset CommandInset ref
11795 reference "subsec:Font-description"
11802 \begin_layout Itemize
11803 \begin_inset Flex Code
11806 \begin_layout Plain Layout
11812 The font used for the label; see
11813 \begin_inset CommandInset ref
11815 reference "subsec:Font-description"
11822 \begin_layout Itemize
11823 \begin_inset Flex Code
11826 \begin_layout Plain Layout
11833 \begin_inset Flex Code
11836 \begin_layout Plain Layout
11841 , Minimalistic, Conglomerate
11846 ] describes the rendering style used for the inset's frame and buttons.
11849 \begin_layout Itemize
11850 \begin_inset Flex Code
11853 \begin_layout Plain Layout
11860 \begin_inset Flex Code
11863 \begin_layout Plain Layout
11870 \begin_inset Flex Code
11873 \begin_layout Plain Layout
11879 , this argument is automatically inserted when the respective style is selected.
11880 Currently, only one argument per style\SpecialChar breakableslash
11881 layout can be automatically inserted.
11884 \begin_layout Itemize
11885 \begin_inset Flex Code
11888 \begin_layout Plain Layout
11895 \begin_inset Flex Code
11898 \begin_layout Plain Layout
11905 \begin_inset Flex Code
11908 \begin_layout Plain Layout
11914 , this argument will be inserted with a copy of the co-text (either selected
11915 text or the whole paragraph) as content.
11918 \begin_layout Itemize
11919 \begin_inset Flex Code
11922 \begin_layout Plain Layout
11929 \begin_inset Flex Code
11932 \begin_layout Plain Layout
11942 ] Whether the contents of this argument should be output in raw form, meaning
11943 without special translations that \SpecialChar LaTeX
11946 \begin_inset Flex Code
11949 \begin_layout Plain Layout
11955 status is inherited by the inset or paragraph layout the argument belongs
11956 to, true and false change the status for the given argument only.
11959 \begin_layout Itemize
11960 \begin_inset Flex Code
11963 \begin_layout Plain Layout
11970 \begin_inset Flex Code
11973 \begin_layout Plain Layout
11974 string of characters
11983 Defines individual characters
11984 \begin_inset Newline linebreak
11987 that should be output in raw form, meaning without special translations
11988 that \SpecialChar LaTeX
11990 Note that, contrary to PassThru, this needs to be explicitly defined for
11992 That is, arguments do not inherit PassThruChars from their parent inset
11996 \begin_layout Itemize
11997 \begin_inset Flex Code
12000 \begin_layout Plain Layout
12007 \begin_inset Flex Code
12010 \begin_layout Plain Layout
12019 \begin_inset space \thinspace{}
12023 \begin_inset Flex Code
12026 \begin_layout Plain Layout
12032 ] If this is set to 1, the argument will output its content in the corresponding
12033 item in the table of contents.
12037 \begin_layout Standard
12038 By default, the text entered in the \SpecialChar LyX
12039 workarea in the respective layout is
12040 the last (mandatory) argument of a command if the
12041 \begin_inset Flex Code
12044 \begin_layout Plain Layout
12051 \begin_inset Flex Code
12054 \begin_layout Plain Layout
12061 However, arguments with the prefix
12062 \begin_inset Flex Code
12065 \begin_layout Plain Layout
12071 are output after this workarea argument.
12072 Note that post-argument numbering restarts at 1, so the first argument
12073 following the workarea argument is
12074 \begin_inset Flex Code
12077 \begin_layout Plain Layout
12084 Post-arguments are ignored in any other
12085 \begin_inset Flex Code
12088 \begin_layout Plain Layout
12095 \begin_inset Flex Code
12098 \begin_layout Plain Layout
12107 \begin_layout Standard
12109 \begin_inset Flex Code
12112 \begin_layout Plain Layout
12121 \begin_inset Flex Code
12124 \begin_layout Plain Layout
12133 \begin_inset Flex Code
12136 \begin_layout Plain Layout
12142 followed by the number (e.
12143 \begin_inset space \thinspace{}
12147 \begin_inset space \space{}
12151 \begin_inset Flex Code
12154 \begin_layout Plain Layout
12164 \begin_layout Description
12165 \begin_inset Flex Code
12168 \begin_layout Plain Layout
12174 Note that this will completely override any prior
12175 \begin_inset Flex Code
12178 \begin_layout Plain Layout
12184 declaration for this style.
12186 \begin_inset Quotes eld
12190 \begin_inset Flex Code
12193 \begin_layout Plain Layout
12200 \begin_inset Quotes erd
12205 \begin_inset CommandInset ref
12207 reference "subsec:I18n"
12211 for details on its use.
12214 \begin_layout Description
12215 \begin_inset Flex Code
12218 \begin_layout Plain Layout
12225 \begin_inset Flex Code
12228 \begin_layout Plain Layout
12238 \begin_layout Plain Layout
12239 Note that a `float' here is a real number, such as: 1.5.
12244 The vertical space with which the last of a chain of paragraphs with this
12245 style is separated from the following paragraph.
12246 If the next paragraph has another style, the separations are not simply
12247 added, but the maximum is taken.
12250 \begin_layout Description
12251 \begin_inset Flex Code
12254 \begin_layout Plain Layout
12261 \begin_inset Flex Code
12264 \begin_layout Plain Layout
12270 ] The category for this style.
12271 This is used to group related styles in the style combobox on the toolbar.
12272 Any string can be used, but you may want to use existing categories with
12277 \begin_layout Description
12278 \begin_inset Flex Code
12281 \begin_layout Plain Layout
12287 Depth of XML command.
12288 Used only with XML-type formats.
12291 \begin_layout Description
12292 \begin_inset Flex Code
12295 \begin_layout Plain Layout
12302 \begin_inset Flex Code
12305 \begin_layout Plain Layout
12311 ] Copies all the features of an existing style into the current one.
12315 \begin_layout Description
12316 \begin_inset Flex Code
12319 \begin_layout Plain Layout
12326 \begin_inset Flex Code
12329 \begin_layout Plain Layout
12335 ] The name of a style whose preamble should be output
12340 This allows to ensure some ordering of the preamble snippets when macros
12341 definitions depend on one another.
12345 \begin_layout Plain Layout
12346 Note that, besides that functionality, there is no way to ensure any ordering
12348 The ordering that you see in a given version of \SpecialChar LyX
12349 may change without warning
12358 \begin_layout Description
12359 \begin_inset Flex Code
12362 \begin_layout Plain Layout
12369 \begin_inset Flex Code
12372 \begin_layout Plain Layout
12377 , Box, Filled_Box, Static
12382 ] The type of label that stands at the end of the paragraph (or sequence
12384 \begin_inset Flex Code
12387 \begin_layout Plain Layout
12394 \begin_inset Newline newline
12398 \begin_inset Flex Code
12401 \begin_layout Plain Layout
12408 \begin_inset Flex Code
12411 \begin_layout Plain Layout
12418 \begin_inset Flex Code
12421 \begin_layout Plain Layout
12429 \begin_inset Flex Code
12432 \begin_layout Plain Layout
12439 \begin_inset Quotes eld
12443 \begin_inset Quotes erd
12447 \begin_inset Flex Code
12450 \begin_layout Plain Layout
12457 \begin_inset space \space{}
12461 \begin_inset Flex Code
12464 \begin_layout Plain Layout
12470 ) is a white (resp.
12471 \begin_inset space ~
12474 black) square suitable for end of proof markers,
12475 \begin_inset Flex Code
12478 \begin_layout Plain Layout
12484 is an explicit text string.
12487 \begin_layout Description
12488 \begin_inset Flex Code
12491 \begin_layout Plain Layout
12498 \begin_inset Flex Code
12501 \begin_layout Plain Layout
12507 ] The string used for a label with a
12508 \begin_inset Flex Code
12511 \begin_layout Plain Layout
12518 \begin_inset Newline newline
12522 \begin_inset Flex Code
12525 \begin_layout Plain Layout
12535 \begin_layout Description
12536 \begin_inset Flex Code
12539 \begin_layout Plain Layout
12545 The font used for both the text body
12551 \begin_inset CommandInset ref
12553 reference "subsec:Font-description"
12558 Note that defining this font automatically defines the
12559 \begin_inset Flex Code
12562 \begin_layout Plain Layout
12569 So you should define this one first if you also want to define
12570 \begin_inset Flex Code
12573 \begin_layout Plain Layout
12582 \begin_layout Description
12583 \begin_inset Flex Code
12586 \begin_layout Plain Layout
12593 \begin_inset Flex Code
12596 \begin_layout Plain Layout
12602 ] Used for backporting new styles to stable \SpecialChar LyX
12604 The first stable version that supports this tag is \SpecialChar LyX
12606 The argument is a number which may either be 0, -1 or any value greater
12609 \begin_inset Flex Code
12612 \begin_layout Plain Layout
12618 flag of a style is greater than zero, it will always be written to the
12620 If a .lyx file is read, the style definitions from the document header are
12621 added to the document class.
12622 Therefore even older \SpecialChar LyX
12623 versions can handle the style.
12625 \begin_inset Flex Code
12628 \begin_layout Plain Layout
12634 is a version number: if the style is read, and the version number is less
12635 than the version number of the already existing style in the document class,
12636 the new style is ignored.
12637 If the version number is greater, the new style replaces the existing style.
12638 A value of -1 means an infinite version number, i.
12639 \begin_inset space \thinspace{}
12643 \begin_inset space \space{}
12646 the style is always used.
12649 \begin_layout Description
12650 \begin_inset Flex Code
12653 \begin_layout Plain Layout
12660 \begin_inset Flex Code
12663 \begin_layout Plain Layout
12672 \begin_inset space \thinspace{}
12676 \begin_inset Flex Code
12679 \begin_layout Plain Layout
12685 ] Usually \SpecialChar LyX
12686 does not allow you to insert more than one space between words,
12687 since a space is considered as the separation between two words, not a
12688 character or symbol of its own.
12689 This is a very fine thing but sometimes annoying, for example, when typing
12690 program code or plain \SpecialChar LaTeX
12693 \begin_inset Flex Code
12696 \begin_layout Plain Layout
12703 Note that \SpecialChar LyX
12704 will create protected blanks for the additional blanks when
12705 in another mode than \SpecialChar LaTeX
12709 \begin_layout Description
12710 \begin_inset Flex Code
12713 \begin_layout Plain Layout
12719 These tags are used with XHTML output.
12721 \begin_inset CommandInset ref
12723 reference "subsec:Paragraph-Style-XHTML"
12730 \begin_layout Description
12731 \begin_inset Flex Code
12734 \begin_layout Plain Layout
12740 [FIXME] (Used only with XML-type formats.)
12743 \begin_layout Description
12744 \begin_inset Flex Code
12747 \begin_layout Plain Layout
12754 \begin_inset Flex Code
12757 \begin_layout Plain Layout
12766 \begin_inset space \thinspace{}
12770 \begin_inset Flex Code
12773 \begin_layout Plain Layout
12780 \begin_inset Flex Code
12783 \begin_layout Plain Layout
12789 , marks the style as to be included in the document preamble and not in
12791 This is useful for document classes that want such information as the title
12792 and author to appear in the preamble.
12793 Note that this works only for styles for which the
12794 \begin_inset Flex Code
12797 \begin_layout Plain Layout
12804 \begin_inset Flex Code
12807 \begin_layout Plain Layout
12814 \begin_inset Flex Code
12817 \begin_layout Plain Layout
12826 \begin_layout Description
12827 \begin_inset Flex Code
12830 \begin_layout Plain Layout
12837 \begin_inset Flex Code
12840 \begin_layout Plain Layout
12849 \begin_inset space \thinspace{}
12853 \begin_inset Flex Code
12856 \begin_layout Plain Layout
12863 \begin_inset Flex Code
12866 \begin_layout Plain Layout
12872 , marks the style as being part of a title block (see also the
12873 \begin_inset Flex Code
12876 \begin_layout Plain Layout
12883 \begin_inset Flex Code
12886 \begin_layout Plain Layout
12895 \begin_layout Description
12896 \begin_inset Flex Code
12899 \begin_layout Plain Layout
12906 \begin_inset Flex Code
12909 \begin_layout Plain Layout
12918 \begin_inset space \thinspace{}
12922 \begin_inset Flex Code
12925 \begin_layout Plain Layout
12931 ] If this is set to 1 and AddToToc is enabled, the paragraph adds a summary
12932 of its contents in its item in the table of contents.
12933 Otherwise, only the label, if it exists, appears.
12936 \begin_layout Description
12937 \begin_inset Flex Code
12940 \begin_layout Plain Layout
12947 \begin_inset Flex Code
12950 \begin_layout Plain Layout
12956 ] The \SpecialChar LaTeX
12957 command sequence declaring an item in a list.
12958 The command is to be defined without the preceding backslash (the default
12960 \begin_inset Quotes eld
12964 \begin_inset Quotes erd
12968 \begin_inset Flex Code
12971 \begin_layout Plain Layout
12979 in the \SpecialChar LaTeX
12983 \begin_layout Description
12984 \begin_inset Flex Code
12987 \begin_layout Plain Layout
12994 \begin_inset Flex Code
12997 \begin_layout Plain Layout
13003 ] This provides extra space between paragraphs that have the same style.
13004 If you put other styles into an environment, each is separated with the
13006 \begin_inset Flex Code
13009 \begin_layout Plain Layout
13016 But the whole items of the environment are additionally separated with
13018 \begin_inset Flex Code
13021 \begin_layout Plain Layout
13028 Note that this is a
13033 \begin_layout Description
13034 \begin_inset Flex Code
13037 \begin_layout Plain Layout
13043 [FIXME] (Used only with XML-type formats.)
13046 \begin_layout Description
13047 \begin_inset Flex Code
13050 \begin_layout Plain Layout
13057 \begin_inset Flex Code
13060 \begin_layout Plain Layout
13069 \begin_inset space \thinspace{}
13073 \begin_inset Flex Code
13076 \begin_layout Plain Layout
13082 ] Usually \SpecialChar LyX
13083 does not allow you to leave a paragraph empty, since it would
13084 lead to empty \SpecialChar LaTeX
13086 There are some cases where this could be desirable however: in a letter
13087 template, the required fields can be provided as empty fields, so that
13088 people do not forget them; in some special classes, a style can be used
13089 as some kind of break, which does not contain actual text.
13092 \begin_layout Description
13093 \begin_inset Flex Code
13096 \begin_layout Plain Layout
13103 \begin_inset Flex Code
13106 \begin_layout Plain Layout
13112 ] The vertical space between the label and the text body.
13113 Only used for labels that are above the text body (
13114 \begin_inset Flex Code
13117 \begin_layout Plain Layout
13124 \begin_inset Newline newline
13128 \begin_inset Flex Code
13131 \begin_layout Plain Layout
13132 Centered_Top_Environment
13140 \begin_layout Description
13141 \begin_inset Flex Code
13144 \begin_layout Plain Layout
13151 \begin_inset Flex Code
13154 \begin_layout Plain Layout
13160 ] The name of the counter for automatic numbering.
13161 In order to have the counter appear with your label, you will need to reference
13163 \begin_inset Flex Code
13166 \begin_layout Plain Layout
13175 This will work with
13176 \begin_inset Flex Code
13179 \begin_layout Plain Layout
13186 \begin_inset Flex Code
13189 \begin_layout Plain Layout
13196 \begin_inset Flex Code
13199 \begin_layout Plain Layout
13206 \begin_inset Flex Code
13209 \begin_layout Plain Layout
13216 \begin_inset Newline newline
13224 \begin_inset Flex Code
13227 \begin_layout Plain Layout
13234 \begin_inset Flex Code
13237 \begin_layout Plain Layout
13243 , though this case is a bit complicated.
13244 Suppose you declare
13245 \begin_inset Quotes eld
13249 \begin_inset Flex Code
13252 \begin_layout Plain Layout
13253 LabelCounter myenum
13259 \begin_inset Quotes erd
13263 Then the actual counters used are
13264 \begin_inset Flex Code
13267 \begin_layout Plain Layout
13274 \begin_inset Flex Code
13277 \begin_layout Plain Layout
13284 \begin_inset Flex Code
13287 \begin_layout Plain Layout
13294 \begin_inset Flex Code
13297 \begin_layout Plain Layout
13303 , much as in \SpecialChar LaTeX
13305 These counters must all be declared separately.
13306 \begin_inset Newline newline
13310 \begin_inset CommandInset ref
13312 reference "subsec:Counters"
13316 for details on counters.
13319 \begin_layout Description
13320 \begin_inset Flex Code
13323 \begin_layout Plain Layout
13329 The font used for the label.
13331 \begin_inset CommandInset ref
13333 reference "subsec:Font-description"
13340 \begin_layout Description
13341 \begin_inset Flex Code
13344 \begin_layout Plain Layout
13351 \begin_inset Flex Code
13354 \begin_layout Plain Layout
13360 ] Text that indicates how far a label should be indented.
13363 \begin_layout Description
13364 \begin_inset Flex Code
13367 \begin_layout Plain Layout
13374 \begin_inset Flex Code
13377 \begin_layout Plain Layout
13383 ] Text that indicates the amount of horizontal space between the label and
13385 Only used for labels that are not above the text body.
13388 \begin_layout Description
13389 \begin_inset Flex Code
13392 \begin_layout Plain Layout
13399 \begin_inset Flex Code
13402 \begin_layout Plain Layout
13408 ] The string used for the label.
13410 \begin_inset Flex Code
13413 \begin_layout Plain Layout
13419 is set, this string can be contain the special formatting commands described
13421 \begin_inset CommandInset ref
13423 reference "subsec:Counters"
13430 \begin_layout Description
13431 \begin_inset Flex Code
13434 \begin_layout Plain Layout
13435 LabelStringAppendix
13441 \begin_inset Flex Code
13444 \begin_layout Plain Layout
13450 ] This is used inside the appendix instead of
13451 \begin_inset Newline newline
13455 \begin_inset Flex Code
13458 \begin_layout Plain Layout
13466 \begin_inset Flex Code
13469 \begin_layout Plain Layout
13476 \begin_inset Newline newline
13480 \begin_inset Flex Code
13483 \begin_layout Plain Layout
13484 LabelStringAppendix
13492 \begin_layout Description
13493 \begin_inset Flex Code
13496 \begin_layout Plain Layout
13502 [FIXME] (Used only with XML-type formats.)
13505 \begin_layout Description
13506 \begin_inset Flex Code
13509 \begin_layout Plain Layout
13516 \begin_inset Flex Code
13519 \begin_layout Plain Layout
13524 , Manual, Static, Above,
13525 \begin_inset Newline newline
13528 Centered, Sensitive, Enumerate,
13529 \begin_inset Newline newline
13532 Itemize, Bibliography
13541 \begin_layout Description
13542 \begin_inset Flex Code
13545 \begin_layout Plain Layout
13551 means the label is the very first word (up to the first real blank).
13552 Use protected spaces if you want more than one word as the label.
13556 \begin_layout Description
13557 \begin_inset Flex Code
13560 \begin_layout Plain Layout
13566 means the label is simply what is declared as
13567 \begin_inset Flex Code
13570 \begin_layout Plain Layout
13577 This will be displayed
13578 \begin_inset Quotes eld
13582 \begin_inset Quotes erd
13585 , at the beginning of the paragraph.
13587 \begin_inset Flex Code
13590 \begin_layout Plain Layout
13597 \begin_inset Flex Code
13600 \begin_layout Plain Layout
13606 , then it will be displayed only in the first paragraph of any sequence
13607 of paragraphs with the same
13608 \begin_inset Flex Code
13611 \begin_layout Plain Layout
13620 \begin_layout Description
13621 \begin_inset Flex Code
13624 \begin_layout Plain Layout
13631 \begin_inset space ~
13635 \begin_inset space ~
13639 \begin_inset Flex Code
13642 \begin_layout Plain Layout
13648 are special cases of
13649 \begin_inset Flex Code
13652 \begin_layout Plain Layout
13659 The label will be printed above the paragraph either at the beginning of
13660 the line or centered.
13663 \begin_layout Description
13664 \begin_inset Flex Code
13667 \begin_layout Plain Layout
13673 is a special case for the caption-labels
13674 \begin_inset Quotes eld
13678 \begin_inset Quotes erd
13682 \begin_inset Quotes eld
13686 \begin_inset Quotes erd
13690 \begin_inset Newline newline
13694 \begin_inset Flex Code
13697 \begin_layout Plain Layout
13703 means the (hardcoded) label string depends on the kind of float: It is
13704 hardcoded to be `FloatType N', where N is the value of the counter associated
13706 For the case that a caption is inserted outside of a float the
13707 \begin_inset Flex Code
13710 \begin_layout Plain Layout
13717 \begin_inset Quotes eld
13721 \begin_inset Quotes erd
13727 \begin_layout Description
13728 \begin_inset Flex Code
13731 \begin_layout Plain Layout
13737 produces the usual sort of enumeration labels.
13738 The number type needs to be set in the
13743 \begin_inset CommandInset ref
13745 reference "subsec:Counters"
13752 \begin_layout Description
13753 \begin_inset Flex Code
13756 \begin_layout Plain Layout
13762 produces various bullets at the different levels.
13763 The bullet types displayed can be set via
13764 \begin_inset Flex Noun
13767 \begin_layout Plain Layout
13768 Document\SpecialChar menuseparator
13769 Settings\SpecialChar menuseparator
13778 \begin_layout Description
13779 \begin_inset Flex Code
13782 \begin_layout Plain Layout
13788 should be used only with
13789 \begin_inset Flex Code
13792 \begin_layout Plain Layout
13793 LatexType BibEnvironment
13802 \begin_layout Description
13803 \begin_inset Flex Code
13806 \begin_layout Plain Layout
13812 Note that this will completely override any prior
13813 \begin_inset Flex Code
13816 \begin_layout Plain Layout
13822 declaration for this style.
13824 \begin_inset Quotes eld
13828 \begin_inset Flex Code
13831 \begin_layout Plain Layout
13838 \begin_inset Quotes erd
13843 \begin_inset CommandInset ref
13845 reference "subsec:I18n"
13849 for details on its use.
13852 \begin_layout Description
13853 \begin_inset Flex Code
13856 \begin_layout Plain Layout
13863 \begin_inset Flex Code
13866 \begin_layout Plain Layout
13872 ] The name of the corresponding \SpecialChar LaTeX
13874 Either the environment or command name.
13877 \begin_layout Description
13878 \begin_inset Flex Code
13881 \begin_layout Plain Layout
13888 \begin_inset Flex Code
13891 \begin_layout Plain Layout
13897 ] An optional parameter for the corresponding
13898 \begin_inset Flex Code
13901 \begin_layout Plain Layout
13908 This parameter cannot be changed from within \SpecialChar LyX
13910 \begin_inset Flex Code
13913 \begin_layout Plain Layout
13919 for customizable parameters).
13920 This will be output as is after all \SpecialChar LaTeX
13922 \begin_inset Flex Code
13925 \begin_layout Plain Layout
13934 \begin_layout Description
13935 \begin_inset Flex Code
13938 \begin_layout Plain Layout
13945 \begin_inset Flex Code
13948 \begin_layout Plain Layout
13953 , Command, Environment, Item_Environment,
13954 \begin_inset Newline newline
13957 List_Environment, Bib_Environment
13962 ] How the style should be translated into \SpecialChar LaTeX
13967 \begin_layout Plain Layout
13968 \begin_inset Flex Code
13971 \begin_layout Plain Layout
13977 is perhaps a bit misleading, since these rules apply to SGML classes, too.
13978 Visit the SGML class files for specific examples.
13987 \begin_layout Description
13988 \begin_inset Flex Code
13991 \begin_layout Plain Layout
13997 means nothing special.
14000 \begin_layout Description
14001 \begin_inset Flex Code
14004 \begin_layout Plain Layout
14011 \begin_inset Flex Code
14014 \begin_layout Plain Layout
14021 {\SpecialChar ldots
14030 \begin_layout Description
14031 \begin_inset Flex Code
14034 \begin_layout Plain Layout
14041 \begin_inset Flex Code
14044 \begin_layout Plain Layout
14051 }\SpecialChar ldots
14067 \begin_layout Description
14068 \begin_inset Flex Code
14071 \begin_layout Plain Layout
14078 \begin_inset Flex Code
14081 \begin_layout Plain Layout
14088 \begin_inset Flex Code
14091 \begin_layout Plain Layout
14099 is generated for each paragraph of this environment.
14103 \begin_layout Description
14104 \begin_inset Flex Code
14107 \begin_layout Plain Layout
14114 \begin_inset Flex Code
14117 \begin_layout Plain Layout
14124 \begin_inset Newline newline
14128 \begin_inset Flex Code
14131 \begin_layout Plain Layout
14137 is passed as an argument to the environment.
14138 \begin_inset Newline newline
14142 \begin_inset Flex Code
14145 \begin_layout Plain Layout
14151 can be defined in the
14152 \begin_inset Flex Noun
14155 \begin_layout Plain Layout
14156 Edit\SpecialChar menuseparator
14158 \begin_inset space ~
14169 \begin_layout Description
14170 \begin_inset Flex Code
14173 \begin_layout Plain Layout
14180 \begin_inset Flex Code
14183 \begin_layout Plain Layout
14189 but adds the necessary mandatory argument (the longest label) to the begin
14190 statement of the bibliography environment:
14191 \begin_inset Newline newline
14195 \begin_inset Flex Code
14198 \begin_layout Plain Layout
14201 begin{thebibliography}{99}
14207 It is therefore only useful for bibliography environments.
14208 The default longest label
14209 \begin_inset Quotes eld
14213 \begin_inset Quotes erd
14216 can be changed by the user in the paragraph settings of a bibliography
14220 \begin_layout Standard
14221 Putting the last few things together, the \SpecialChar LaTeX
14222 output will be either:
14225 \begin_layout LyX-Code
14228 LatexName[LatexParam]{\SpecialChar ldots
14232 \begin_layout Standard
14236 \begin_layout LyX-Code
14239 begin{LatexName}[LatexParam] \SpecialChar ldots
14245 \begin_layout Standard
14246 depending upon the \SpecialChar LaTeX
14251 \begin_layout Description
14252 \begin_inset Flex Code
14255 \begin_layout Plain Layout
14262 \begin_inset Flex Code
14265 \begin_layout Plain Layout
14271 ] A string that is put at the beginning of the style content.
14272 A line break in the output can be indicated by
14273 \begin_inset Flex Code
14276 \begin_layout Plain Layout
14285 \begin_layout Description
14286 \begin_inset Flex Code
14289 \begin_layout Plain Layout
14296 \begin_inset Flex Code
14299 \begin_layout Plain Layout
14305 ] If you put styles into environments, the different
14306 \begin_inset Flex Code
14309 \begin_layout Plain Layout
14315 are not simply added, but added with a factor
14316 \begin_inset Formula $\frac{4}{\mathrm{depth}+4}$
14320 Note that this parameter is also used when
14321 \begin_inset Flex Code
14324 \begin_layout Plain Layout
14331 \begin_inset Flex Code
14334 \begin_layout Plain Layout
14341 \begin_inset Flex Code
14344 \begin_layout Plain Layout
14351 Then it is added to the manual or dynamic margin.
14352 \begin_inset Newline newline
14356 \begin_inset Quotes eld
14360 \begin_inset Flex Code
14363 \begin_layout Plain Layout
14370 \begin_inset Quotes erd
14373 means that the paragraph is indented with the width of
14374 \begin_inset Quotes eld
14378 \begin_inset Flex Code
14381 \begin_layout Plain Layout
14388 \begin_inset Quotes erd
14391 in the normal font.
14392 You can get a negative width by prefixing the string with
14393 \begin_inset Quotes eld
14397 \begin_inset Flex Code
14400 \begin_layout Plain Layout
14407 \begin_inset Quotes erd
14411 This way was chosen so that the look is the same with each used screen
14415 \begin_layout Description
14416 \begin_inset Flex Code
14419 \begin_layout Plain Layout
14426 \begin_inset Flex Code
14429 \begin_layout Plain Layout
14434 , Manual, Dynamic, First_Dynamic, Right_Address_Box
14440 \begin_inset Newline newline
14443 The kind of margin that the style has on the left side.
14447 \begin_layout Description
14448 \begin_inset Flex Code
14451 \begin_layout Plain Layout
14457 just means a fixed margin.
14460 \begin_layout Description
14461 \begin_inset Flex Code
14464 \begin_layout Plain Layout
14470 means that the left margin depends on the string entered in the
14471 \begin_inset Flex Noun
14474 \begin_layout Plain Layout
14475 Edit\SpecialChar menuseparator
14477 \begin_inset space ~
14486 This is used to typeset nice lists without tabulators.
14489 \begin_layout Description
14490 \begin_inset Flex Code
14493 \begin_layout Plain Layout
14499 means that the margin depends on the size of the label.
14500 This is used for automatic enumerated headlines.
14501 It is obvious that the headline
14502 \begin_inset Quotes eld
14505 5.4.3.2.1 Very long headline
14506 \begin_inset Quotes erd
14509 must have a wider left margin (as wide as
14510 \begin_inset Quotes eld
14514 \begin_inset Quotes erd
14517 plus the space) than
14518 \begin_inset Quotes eld
14521 3.2 Very long headline
14522 \begin_inset Quotes erd
14526 \begin_inset Quotes eld
14530 \begin_inset Quotes erd
14533 are not able to do this.
14536 \begin_layout Description
14537 \begin_inset Flex Code
14540 \begin_layout Plain Layout
14546 is similar, but only the very first row of the paragraph is dynamic, while
14547 the others are static; this is used, for example, for descriptions.
14550 \begin_layout Description
14551 \begin_inset Flex Code
14554 \begin_layout Plain Layout
14560 means the margin is chosen in a way that the longest row of this paragraph
14561 fits to the right margin.
14562 This is used to typeset an address on the right edge of the page.
14566 \begin_layout Description
14567 \begin_inset Flex Code
14570 \begin_layout Plain Layout
14577 \begin_inset Flex Code
14580 \begin_layout Plain Layout
14589 \begin_inset space \thinspace{}
14593 \begin_inset Flex Code
14596 \begin_layout Plain Layout
14602 ] Whether fragile commands in this style should be
14603 \begin_inset Flex Code
14606 \begin_layout Plain Layout
14619 whether this command should itself be protected.)
14620 \change_inserted -712698321 1514479340
14624 \begin_layout Description
14626 \change_inserted -712698321 1514479340
14627 \begin_inset Flex Code
14630 \begin_layout Plain Layout
14632 \change_inserted -712698321 1514479340
14638 Includes a comma-separated list of layout names that should be nested in
14639 and after the current one.
14640 Only makes sense for nestable layouts (such as environments)
14641 \begin_inset Quotes eld
14645 \begin_inset Flex Code
14648 \begin_layout Plain Layout
14650 \change_inserted -712698321 1514479340
14657 \begin_inset Quotes erd
14665 \begin_layout Description
14666 \begin_inset Flex Code
14669 \begin_layout Plain Layout
14676 \begin_inset Flex Code
14679 \begin_layout Plain Layout
14686 \begin_inset space \thinspace{}
14690 \begin_inset Flex Code
14693 \begin_layout Plain Layout
14701 ] Whether newlines are translated into \SpecialChar LaTeX
14703 \begin_inset Flex Code
14706 \begin_layout Plain Layout
14717 The translation can be switched off to allow more comfortable \SpecialChar LaTeX
14719 inside \SpecialChar LyX
14723 \begin_layout Description
14724 \begin_inset Flex Code
14727 \begin_layout Plain Layout
14734 \begin_inset Flex Code
14737 \begin_layout Plain Layout
14746 \begin_inset space \thinspace{}
14750 \begin_inset Flex Code
14753 \begin_layout Plain Layout
14759 ] If set to true, and if
14760 \begin_inset Flex Code
14763 \begin_layout Plain Layout
14770 \begin_inset Flex Code
14773 \begin_layout Plain Layout
14779 ) paragraphs are being indented, then the indentation of such a paragraph
14780 following one of this type will be suppressed.
14781 (So this will not affect the display of non-default paragraphs.)
14784 \begin_layout Description
14785 \begin_inset Flex Code
14788 \begin_layout Plain Layout
14795 \begin_inset Flex Code
14798 \begin_layout Plain Layout
14804 ] Name of a style that has replaced this style.
14805 This is used to rename a style, while keeping backward compatibility.
14808 \begin_layout Description
14809 \begin_inset Flex Code
14812 \begin_layout Plain Layout
14819 \begin_inset Flex Code
14822 \begin_layout Plain Layout
14829 \begin_inset space \thinspace{}
14833 \begin_inset Flex Code
14836 \begin_layout Plain Layout
14842 ] Determines whether consecutive paragraphs of the same type are treated
14843 as belonging together.
14844 This has the effect that the
14845 \begin_inset Flex Code
14848 \begin_layout Plain Layout
14854 is only printed once before such a group.
14855 By default, this is true for
14856 \begin_inset Flex Code
14859 \begin_layout Plain Layout
14866 \begin_inset Flex Code
14869 \begin_layout Plain Layout
14876 \begin_inset Flex Code
14879 \begin_layout Plain Layout
14885 and false for all other types.
14888 \begin_layout Description
14889 \begin_inset Flex Code
14892 \begin_layout Plain Layout
14899 \begin_inset Flex Code
14902 \begin_layout Plain Layout
14911 \begin_inset space \thinspace{}
14915 \begin_inset Flex Code
14918 \begin_layout Plain Layout
14924 ] Indicates that paragraphs will not be separated by an empty line in \SpecialChar LaTeX
14926 but only by a line break; together with
14927 \begin_inset Flex Code
14930 \begin_layout Plain Layout
14936 , this allows to emulate a plain text editor (like the ERT inset).
14939 \begin_layout Description
14940 \begin_inset Flex Code
14943 \begin_layout Plain Layout
14950 \begin_inset Flex Code
14953 \begin_layout Plain Layout
14959 ] The indent of the very first line of a paragraph.
14961 \begin_inset Newline newline
14965 \begin_inset Flex Code
14968 \begin_layout Plain Layout
14974 will be fixed for a certain style.
14975 The exception is the default style, since the indentation for these paragraphs
14976 can be prohibited with
14977 \begin_inset Flex Code
14980 \begin_layout Plain Layout
14988 \begin_inset Flex Code
14991 \begin_layout Plain Layout
14997 style paragraphs inside environments use the
14998 \begin_inset Flex Code
15001 \begin_layout Plain Layout
15007 of the environment, not their native one.
15009 \begin_inset Flex Code
15012 \begin_layout Plain Layout
15018 paragraphs inside an enumeration are not indented.
15021 \begin_layout Description
15022 \begin_inset Flex Code
15025 \begin_layout Plain Layout
15032 \begin_inset Flex Code
15035 \begin_layout Plain Layout
15041 ] The vertical space between two paragraphs of this style.
15044 \begin_layout Description
15045 \begin_inset Flex Code
15048 \begin_layout Plain Layout
15055 \begin_inset Flex Code
15058 \begin_layout Plain Layout
15065 allows the user to choose either
15066 \begin_inset Quotes eld
15070 \begin_inset Quotes erd
15074 \begin_inset Quotes eld
15078 \begin_inset Quotes erd
15081 to separate paragraphs.
15083 \begin_inset Quotes eld
15087 \begin_inset Quotes erd
15091 \begin_inset Flex Code
15094 \begin_layout Plain Layout
15102 \begin_inset Quotes eld
15106 \begin_inset Quotes erd
15110 \begin_inset Flex Code
15113 \begin_layout Plain Layout
15119 is ignored and all paragraphs are separated by the
15120 \begin_inset Flex Code
15123 \begin_layout Plain Layout
15130 The vertical space is calculated with
15131 \begin_inset Flex Code
15134 \begin_layout Plain Layout
15136 \begin_inset space ~
15145 \begin_inset Flex Code
15148 \begin_layout Plain Layout
15154 is the height of a row with the normal font.
15155 This way, the look stays the same with different screen fonts.
15158 \begin_layout Description
15159 \begin_inset Flex Code
15162 \begin_layout Plain Layout
15169 \begin_inset Flex Code
15172 \begin_layout Plain Layout
15181 \begin_inset space \thinspace{}
15185 \begin_inset Flex Code
15188 \begin_layout Plain Layout
15194 ] Whether the contents of this paragraph should be output in raw form, meaning
15195 without special translations that \SpecialChar LaTeX
15199 \begin_layout Description
15200 \begin_inset Flex Code
15203 \begin_layout Plain Layout
15210 \begin_inset Flex Code
15213 \begin_layout Plain Layout
15223 Defines individual characters that should be output in raw form, meaning
15224 without special translations that \SpecialChar LaTeX
15228 \begin_layout Description
15229 \begin_inset Flex Code
15232 \begin_layout Plain Layout
15238 Information to be included in the \SpecialChar LaTeX
15239 preamble when this style is used.
15240 Used to define macros, load packages, etc., required by this particular
15243 \begin_inset Quotes eld
15247 \begin_inset Flex Code
15250 \begin_layout Plain Layout
15257 \begin_inset Quotes erd
15263 \begin_layout Description
15264 \begin_inset Flex Code
15267 \begin_layout Plain Layout
15274 \begin_inset Flex Code
15277 \begin_layout Plain Layout
15283 ] The prefix to use when creating labels referring to paragraphs of this
15285 This allows the use of formatted references.
15288 \begin_layout Description
15289 \begin_inset Flex Code
15292 \begin_layout Plain Layout
15299 \begin_inset Flex Code
15302 \begin_layout Plain Layout
15308 ] Whether the style requires the feature
15309 \begin_inset Flex Code
15312 \begin_layout Plain Layout
15319 \begin_inset CommandInset ref
15321 reference "chap:List-of-functions"
15325 for the list of features).
15326 If you require a package with specific options, you can additionally use
15328 \begin_inset Flex Code
15331 \begin_layout Plain Layout
15337 as a general text class parameter (see
15338 \begin_inset CommandInset ref
15340 reference "subsec:General-text-class"
15347 \begin_layout Description
15348 \begin_inset Flex Code
15351 \begin_layout Plain Layout
15358 \begin_inset Flex Code
15361 \begin_layout Plain Layout
15370 \begin_inset Flex Code
15373 \begin_layout Plain Layout
15379 ] Resets the \SpecialChar LaTeX
15380 arguments of this style (as defined via the
15381 \begin_inset Flex Code
15384 \begin_layout Plain Layout
15391 This is useful if you have copied a style via
15392 \begin_inset Flex Code
15395 \begin_layout Plain Layout
15401 , but you do not want to inherit its (required and optional) arguments.
15404 \begin_layout Description
15405 \begin_inset Flex Code
15408 \begin_layout Plain Layout
15415 \begin_inset Flex Code
15418 \begin_layout Plain Layout
15427 \begin_inset Flex Code
15430 \begin_layout Plain Layout
15436 ] Resumes a counter that is usually reset at each new sequence of layouts.
15437 This is currently only useful when
15438 \begin_inset Flex Code
15441 \begin_layout Plain Layout
15448 \begin_inset Flex Code
15451 \begin_layout Plain Layout
15460 \begin_layout Description
15461 \begin_inset Flex Code
15464 \begin_layout Plain Layout
15471 \begin_inset Flex Code
15474 \begin_layout Plain Layout
15480 ] A string that is put at the end of the layout content.
15481 A line break in the output can be indicated by
15482 \begin_inset Flex Code
15485 \begin_layout Plain Layout
15494 \begin_layout Description
15495 \begin_inset Flex Code
15498 \begin_layout Plain Layout
15505 \begin_inset Flex Code
15508 \begin_layout Plain Layout
15515 \begin_inset Flex Code
15518 \begin_layout Plain Layout
15527 \begin_layout Description
15528 \begin_inset Flex Code
15531 \begin_layout Plain Layout
15538 \begin_inset Flex Code
15541 \begin_layout Plain Layout
15550 \begin_inset Flex Code
15553 \begin_layout Plain Layout
15560 \begin_inset Flex Code
15563 \begin_layout Plain Layout
15570 \begin_inset Flex Code
15573 \begin_layout Plain Layout
15575 \begin_inset space ~
15583 ] This defines what the default spacing should be in the style.
15585 \begin_inset Flex Code
15588 \begin_layout Plain Layout
15595 \begin_inset Flex Code
15598 \begin_layout Plain Layout
15605 \begin_inset Flex Code
15608 \begin_layout Plain Layout
15614 correspond respectively to a multiplier value of 1, 1.25 and 1.667.
15615 If you specify the argument
15616 \begin_inset Flex Code
15619 \begin_layout Plain Layout
15625 , then you must also provide a value argument which will be the actual multiplie
15627 Note that, contrary to other parameters,
15628 \begin_inset Flex Code
15631 \begin_layout Plain Layout
15637 implies the generation of specific \SpecialChar LaTeX
15638 code, using the \SpecialChar LaTeX
15642 \begin_inset Flex Code
15645 \begin_layout Plain Layout
15654 \begin_layout Description
15655 \begin_inset Flex Code
15658 \begin_layout Plain Layout
15665 \begin_inset Flex Code
15668 \begin_layout Plain Layout
15675 \begin_inset space \thinspace{}
15679 \begin_inset Flex Code
15682 \begin_layout Plain Layout
15690 ] Allow spell-checking paragraphs of this style.
15694 \begin_layout Description
15695 \begin_inset Flex Code
15698 \begin_layout Plain Layout
15705 \begin_inset Flex Code
15708 \begin_layout Plain Layout
15717 \begin_inset Flex Code
15720 \begin_layout Plain Layout
15726 ] Steps the master counter of a given counter at the beginning of a new
15727 sequence of layouts.
15728 This is currently only useful when
15729 \begin_inset Flex Code
15732 \begin_layout Plain Layout
15739 \begin_inset Flex Code
15742 \begin_layout Plain Layout
15751 \begin_layout Description
15752 \begin_inset Flex Code
15755 \begin_layout Plain Layout
15761 The font used for the text body .
15763 \begin_inset CommandInset ref
15765 reference "subsec:Font-description"
15772 \begin_layout Description
15773 \begin_inset Flex Code
15776 \begin_layout Plain Layout
15785 \begin_inset Flex Code
15788 \begin_layout Plain Layout
15798 The level of the style in the table of contents.
15799 This is used for automatic numbering of section headings.
15802 \begin_layout Description
15803 \begin_inset Flex Code
15806 \begin_layout Plain Layout
15815 \begin_inset Flex Code
15818 \begin_layout Plain Layout
15829 \begin_inset Flex Code
15832 \begin_layout Plain Layout
15839 \begin_inset Flex Code
15842 \begin_layout Plain Layout
15848 ] This tag determines whether the first line indentation of this paragraph
15849 can be toggled via the Paragraph settings dialog.
15853 \begin_inset Flex Code
15856 \begin_layout Plain Layout
15866 is set, indentation can be toggled if the document settings use
15867 \begin_inset Quotes eld
15871 \begin_inset Quotes erd
15874 paragraph style, with
15875 \begin_inset Flex Code
15878 \begin_layout Plain Layout
15884 , indentation can always be toggled, notwithstanding the document settings,
15886 \begin_inset Flex Code
15889 \begin_layout Plain Layout
15895 , indentation can never be toggled.
15898 \begin_layout Description
15899 \begin_inset Flex Code
15902 \begin_layout Plain Layout
15909 \begin_inset Flex Code
15912 \begin_layout Plain Layout
15918 ] The vertical space with which the very first of a chain of paragraphs
15919 with this style is separated from the previous paragraph.
15920 If the previous paragraph has another style, the separations are not simply
15921 added, but the maximum is taken.
15924 \begin_layout Subsection
15925 \begin_inset CommandInset label
15931 Internationalization of Paragraph Styles
15934 \begin_layout Standard
15936 has long supported internationalization of layout information, but, until
15937 version 2.0, this applied only to the user interface and not to, say, PDF
15939 Thus, French authors were forced to resort to ugly hacks if they wanted
15944 1' instead of `Theorem 1'.
15945 Thanks to Georg Baum, that is no longer the case.
15948 \begin_layout Standard
15950 \begin_inset Flex Code
15953 \begin_layout Plain Layout
15959 defines text that is to appear in the typeset document, it may use
15960 \begin_inset Flex Code
15963 \begin_layout Plain Layout
15970 \begin_inset Flex Code
15973 \begin_layout Plain Layout
15979 to support non-English and even multi-language documents correctly.
15980 The following excerpt (from the
15981 \begin_inset Flex Code
15984 \begin_layout Plain Layout
15990 file) shows how this works:
15993 \begin_layout LyX-Code
15998 \begin_layout LyX-Code
16001 theoremstyle{remark}
16004 \begin_layout LyX-Code
16007 newtheorem{claim}[thm]{
16014 \begin_layout LyX-Code
16018 \begin_layout LyX-Code
16022 \begin_layout LyX-Code
16027 claimname}{_(Claim)}
16030 \begin_layout LyX-Code
16034 \begin_layout LyX-Code
16038 \begin_layout LyX-Code
16047 claimname}{_(Claim)}}
16050 \begin_layout LyX-Code
16055 \begin_layout Standard
16056 In principle, any legal \SpecialChar LaTeX
16058 \begin_inset Flex Code
16061 \begin_layout Plain Layout
16068 \begin_inset Flex Code
16071 \begin_layout Plain Layout
16077 tags, but in practice they will typically look as they do here.
16078 The key to correct translation of the typeset text is the definition of
16079 the \SpecialChar LaTeX
16081 \begin_inset Flex Code
16084 \begin_layout Plain Layout
16093 \begin_inset Flex Code
16096 \begin_layout Plain Layout
16108 \begin_layout Standard
16110 \begin_inset Flex Code
16113 \begin_layout Plain Layout
16119 tag provides for internationalization based upon the overall language of
16121 The contents of the tag will be included in the preamble, just as with
16123 \begin_inset Flex Code
16126 \begin_layout Plain Layout
16133 What makes it special is the use of the
16134 \begin_inset Quotes eld
16138 \begin_inset Quotes erd
16142 \begin_inset Flex Code
16145 \begin_layout Plain Layout
16151 , which will be replaced, when \SpecialChar LyX
16152 produces \SpecialChar LaTeX
16153 output, with the translation of
16154 its argument into the document language.
16157 \begin_layout Standard
16159 \begin_inset Flex Code
16162 \begin_layout Plain Layout
16168 tag is more complex, since it is meant to provide support for multi-language
16169 documents and so offers an interface to the
16170 \begin_inset Flex Code
16173 \begin_layout Plain Layout
16180 Its contents will be added to the preamble once for each language that
16181 appears in the document.
16182 In this case, the argument to
16183 \begin_inset Flex Code
16186 \begin_layout Plain Layout
16192 will be replaced with its translation into the language in question; the
16194 \begin_inset Flex Code
16197 \begin_layout Plain Layout
16203 is replaced by the language name (as used by the babel package).
16206 \begin_layout Standard
16207 A German document that also included a French section would thus have the
16208 following in the preamble:
16211 \begin_layout LyX-Code
16220 claimname}{Affirmation}}
16221 \begin_inset Newline newline
16232 claimname}{Behauptung}}
16233 \begin_inset Newline newline
16240 claimname}{Behauptung}
16243 \begin_layout Standard
16246 \begin_inset Flex Code
16249 \begin_layout Plain Layout
16255 will then conspire to produce the correct text in the output.
16258 \begin_layout Standard
16259 One important point to note here is that the translations are provided by
16261 itself, through the file
16262 \begin_inset Flex Code
16265 \begin_layout Plain Layout
16272 This means, in effect, that
16273 \begin_inset Flex Code
16276 \begin_layout Plain Layout
16283 \begin_inset Flex Code
16286 \begin_layout Plain Layout
16292 are really only of use in layout files that are provided with \SpecialChar LyX
16294 entered in user-created layout files will not be seen by \SpecialChar LyX
16295 's internationalizatio
16296 n routines unless the
16297 \begin_inset Flex Code
16300 \begin_layout Plain Layout
16306 file is modified accordingly.
16307 That said, however, any layout created with the intention that it will
16308 be included with \SpecialChar LyX
16309 should use these tags where appropriate.
16310 Please note that the paragraph style translations provided by \SpecialChar LyX
16312 change with a minor update (e.
16313 \begin_inset space \thinspace{}
16317 \begin_inset space \space{}
16320 from version 2.1.x to 2.1.y).
16321 It is however quite likely that a major update (e.
16322 \begin_inset space \thinspace{}
16326 \begin_inset space \space{}
16329 from 2.0.x to 2.1.0) will introduce new translations or corrections.
16332 \begin_layout Subsection
16334 \begin_inset CommandInset label
16336 name "subsec:Floats"
16343 \begin_layout Standard
16344 It is necessary to define the floats (
16345 \begin_inset Flex Noun
16348 \begin_layout Plain Layout
16355 \begin_inset Flex Noun
16358 \begin_layout Plain Layout
16364 , \SpecialChar ldots
16365 ) in the text class itself.
16366 Standard floats are included in the file
16367 \begin_inset Flex Code
16370 \begin_layout Plain Layout
16376 , so you may have to do no more than add
16379 \begin_layout LyX-Code
16380 Input stdfloats.inc
16383 \begin_layout Standard
16384 to your layout file.
16385 If you want to implement a text class that proposes some other float types
16386 (like the AGU class bundled with \SpecialChar LyX
16387 ), the information below will hopefully
16391 \begin_layout Description
16392 \begin_inset Flex Code
16395 \begin_layout Plain Layout
16402 \begin_inset Flex Code
16405 \begin_layout Plain Layout
16411 =!htbpH] Allowed placement options for this float type.
16412 The value is a string of placement characters.
16413 Possible characters include:
16418 \begin_inset Quotes eld
16422 \begin_inset Quotes erd
16430 \begin_inset Quotes eld
16434 \begin_inset Quotes erd
16442 \begin_inset Quotes eld
16446 \begin_inset Quotes erd
16454 \begin_inset Quotes eld
16458 \begin_inset Quotes erd
16466 \begin_inset Quotes eld
16470 \begin_inset Quotes erd
16478 \begin_inset Quotes eld
16482 \begin_inset Quotes erd
16486 The order of the characters in the string does not matter.
16487 If no placement options are allowed, use the string
16494 \begin_layout Description
16495 \begin_inset Flex Code
16498 \begin_layout Plain Layout
16505 \begin_inset Flex Code
16508 \begin_layout Plain Layout
16517 \begin_inset space \thinspace{}
16523 \begin_inset Flex Code
16526 \begin_layout Plain Layout
16536 ] Defines whether the float allows to be rotated via the \SpecialChar LaTeX
16543 \begin_inset Flex Code
16546 \begin_layout Plain Layout
16552 if the float does not support this feature.
16555 \begin_layout Description
16556 \begin_inset Flex Code
16559 \begin_layout Plain Layout
16566 \begin_inset Flex Code
16569 \begin_layout Plain Layout
16578 \begin_inset space \thinspace{}
16584 \begin_inset Flex Code
16587 \begin_layout Plain Layout
16597 ] Defines whether the float has a starred variant that spans columns in
16598 a two column paragraph.
16600 \begin_inset Flex Code
16603 \begin_layout Plain Layout
16609 if the float does not support this feature.
16612 \begin_layout Description
16613 \begin_inset Flex Code
16616 \begin_layout Plain Layout
16623 \begin_inset Flex Code
16626 \begin_layout Plain Layout
16633 \begin_inset Quotes erd
16637 \begin_inset Quotes erd
16640 ] The file name extension of an auxiliary file for the list of figures (or
16643 writes the captions to this file.
16646 \begin_layout Description
16647 \begin_inset Flex Code
16650 \begin_layout Plain Layout
16657 \begin_inset Flex Code
16660 \begin_layout Plain Layout
16667 \begin_inset Quotes erd
16671 \begin_inset Quotes erd
16674 ] The string that will be used in the menus and also for the caption.
16675 This is translated to the current language if babel is used.
16678 \begin_layout Description
16679 \begin_inset Flex Code
16682 \begin_layout Plain Layout
16688 These tags control the XHTML output.
16690 \begin_inset CommandInset ref
16692 reference "sec:Tags-for-XHTML"
16699 \begin_layout Description
16700 \begin_inset Flex Code
16703 \begin_layout Plain Layout
16712 \begin_inset Flex Code
16715 \begin_layout Plain Layout
16724 \begin_inset space \thinspace{}
16728 \begin_inset Flex Code
16731 \begin_layout Plain Layout
16737 ] Indicates whether the float is already defined in the document class or
16738 if instead the \SpecialChar LaTeX
16740 \begin_inset Flex Code
16743 \begin_layout Plain Layout
16749 needs to be loaded to define it on-the-fly.
16751 \begin_inset Flex Code
16754 \begin_layout Plain Layout
16761 \begin_inset Flex Code
16764 \begin_layout Plain Layout
16771 It should be set to
16772 \begin_inset Flex Code
16775 \begin_layout Plain Layout
16781 if the float is already defined by the \SpecialChar LaTeX
16785 \begin_layout Description
16786 \begin_inset Flex Code
16789 \begin_layout Plain Layout
16796 \begin_inset Flex Code
16799 \begin_layout Plain Layout
16806 \begin_inset Quotes erd
16810 \begin_inset Quotes erd
16813 ] The command used to generate a list of floats of this type; the leading
16822 \begin_inset Flex Code
16825 \begin_layout Plain Layout
16831 is false, since there is no standard way to generate this command.
16833 \begin_inset Flex Code
16836 \begin_layout Plain Layout
16842 is true, since in that case there is a standard way to define the command.
16845 \begin_layout Description
16846 \begin_inset Flex Code
16849 \begin_layout Plain Layout
16856 \begin_inset Flex Code
16859 \begin_layout Plain Layout
16866 \begin_inset Quotes erd
16870 \begin_inset Quotes erd
16873 ] A title for a list of floats of this kind (list of figures, tables, or
16875 It is used for the screen label within \SpecialChar LyX
16876 , it is used by \SpecialChar LaTeX
16878 it is used as the title in the XHTML output.
16879 It will be translated to the document language.
16882 \begin_layout Description
16883 \begin_inset Flex Code
16886 \begin_layout Plain Layout
16893 \begin_inset Flex Code
16896 \begin_layout Plain Layout
16903 \begin_inset Quotes erd
16907 \begin_inset Quotes erd
16910 ] This (optional) argument determines whether floats of this class will
16911 be numbered within some sectional unit of the document.
16913 \begin_inset Flex Code
16916 \begin_layout Plain Layout
16923 \begin_inset Quotes eld
16927 \begin_inset Flex Code
16930 \begin_layout Plain Layout
16937 \begin_inset Quotes erd
16940 , the floats will be numbered within chapters.
16944 \begin_layout Description
16945 \begin_inset Flex Code
16948 \begin_layout Plain Layout
16955 \begin_inset Flex Code
16958 \begin_layout Plain Layout
16965 \begin_inset Quotes erd
16969 \begin_inset Quotes erd
16972 ] The default placement for the given class of floats.
16973 The string should be as in standard \SpecialChar LaTeX
16975 \begin_inset Flex Code
16978 \begin_layout Plain Layout
16985 \begin_inset Flex Code
16988 \begin_layout Plain Layout
16995 \begin_inset Flex Code
16998 \begin_layout Plain Layout
17005 \begin_inset Flex Code
17008 \begin_layout Plain Layout
17014 for top, bottom, page, and here, respectively.
17018 \begin_layout Plain Layout
17019 Note that the order of these letters in the string is irrelevant, like in
17026 On top of that there is a new type,
17027 \begin_inset Flex Code
17030 \begin_layout Plain Layout
17036 , which does not really correspond to a float, since it means: put it
17037 \begin_inset Quotes eld
17041 \begin_inset Quotes erd
17045 Note however that the
17046 \begin_inset Flex Code
17049 \begin_layout Plain Layout
17055 specifier is special and, because of implementation details, cannot be
17056 used in non-built in float types.
17057 If you do not understand what this means, just use
17058 \begin_inset Quotes eld
17062 \begin_inset Flex Code
17065 \begin_layout Plain Layout
17072 \begin_inset Quotes erd
17078 \begin_layout Description
17079 \begin_inset Flex Code
17082 \begin_layout Plain Layout
17089 \begin_inset Flex Code
17092 \begin_layout Plain Layout
17098 ] The prefix to use when creating labels referring to floats of this type.
17099 This allows the use of formatted references.
17100 Note that you can remove any
17101 \begin_inset Flex Code
17104 \begin_layout Plain Layout
17110 set by a copied style by using the special value
17111 \begin_inset Quotes eld
17115 \begin_inset Quotes erd
17118 , which must be all caps.
17121 \begin_layout Description
17122 \begin_inset Flex Code
17125 \begin_layout Plain Layout
17132 \begin_inset Flex Code
17135 \begin_layout Plain Layout
17142 \begin_inset Quotes erd
17146 \begin_inset Quotes erd
17149 ] The style used when defining the float using
17150 \begin_inset Flex Code
17153 \begin_layout Plain Layout
17164 \begin_layout Description
17165 \begin_inset Flex Code
17168 \begin_layout Plain Layout
17175 \begin_inset Flex Code
17178 \begin_layout Plain Layout
17185 \begin_inset Quotes erd
17189 \begin_inset Quotes erd
17193 \begin_inset Quotes eld
17197 \begin_inset Quotes erd
17200 of the new class of floats, like program or algorithm.
17201 After the appropriate
17202 \begin_inset Flex Code
17205 \begin_layout Plain Layout
17214 \begin_inset Flex Code
17217 \begin_layout Plain Layout
17226 \begin_inset Flex Code
17229 \begin_layout Plain Layout
17240 \begin_layout Description
17241 \begin_inset Flex Code
17244 \begin_layout Plain Layout
17251 \begin_inset Flex Code
17254 \begin_layout Plain Layout
17261 \begin_inset space \thinspace{}
17265 \begin_inset Flex Code
17268 \begin_layout Plain Layout
17276 ] Specifies whether this float is defined using the \SpecialChar LaTeX
17278 \begin_inset Flex Code
17281 \begin_layout Plain Layout
17287 , either by the class file, another package or on-the-fly by \SpecialChar LyX
17291 \begin_layout Standard
17292 Note that defining a float with type
17293 \begin_inset Flex Code
17296 \begin_layout Plain Layout
17304 automatically defines the corresponding counter with name
17305 \begin_inset Flex Code
17308 \begin_layout Plain Layout
17319 \begin_layout Subsection
17320 Flex insets and InsetLayout
17321 \begin_inset CommandInset label
17323 name "subsec:Flex-insets-and"
17330 \begin_layout Standard
17331 Flex insets come in three different kinds:
17334 \begin_layout Itemize
17336 \begin_inset Flex Code
17339 \begin_layout Plain Layout
17345 ): These define semantic markup corresponding to such \SpecialChar LaTeX
17347 \begin_inset Flex Code
17350 \begin_layout Plain Layout
17359 \begin_inset Flex Code
17362 \begin_layout Plain Layout
17373 \begin_layout Itemize
17375 \begin_inset Flex Code
17378 \begin_layout Plain Layout
17384 ): These can be used to define custom collapsible insets, similar to \SpecialChar TeX
17386 footnote, and the like.
17387 An obvious example is an endnote inset, which is defined in the
17388 \begin_inset Flex Code
17391 \begin_layout Plain Layout
17400 \begin_layout Itemize
17402 \begin_inset Flex Code
17405 \begin_layout Plain Layout
17411 ): For use with DocBook classes.
17414 \begin_layout Standard
17415 Flex insets are defined using the
17416 \begin_inset Flex Code
17419 \begin_layout Plain Layout
17425 tag, which shall be explained in a moment.
17428 \begin_layout Standard
17430 \begin_inset Flex Code
17433 \begin_layout Plain Layout
17439 tag also serves another function: It can be used to customize the general
17440 layout of many different types of insets.
17442 \begin_inset Flex Code
17445 \begin_layout Plain Layout
17451 can be used to customize the layout parameters for footnotes, marginal
17452 notes, note insets, \SpecialChar TeX
17453 code (ERT) insets, branches, listings, indexes, boxes,
17454 tables, algorithms, URLs, and captions, as well as to define Flex insets.
17457 \begin_layout Standard
17459 \begin_inset Flex Code
17462 \begin_layout Plain Layout
17468 definition must begin with a line of the form:
17471 \begin_layout LyX-Code
17475 \begin_layout Standard
17477 \begin_inset Flex Code
17480 \begin_layout Plain Layout
17486 indicates the inset whose layout is being defined, and here there are four
17490 \begin_layout Enumerate
17491 The layout for a pre-existing inset is being modified.
17492 In this case, can be
17493 \begin_inset Flex Code
17496 \begin_layout Plain Layout
17502 any one of the following:
17503 \begin_inset Flex Code
17506 \begin_layout Plain Layout
17513 \begin_inset Flex Code
17516 \begin_layout Plain Layout
17523 \begin_inset Flex Code
17526 \begin_layout Plain Layout
17533 \begin_inset Flex Code
17536 \begin_layout Plain Layout
17543 \begin_inset Flex Code
17546 \begin_layout Plain Layout
17553 \begin_inset Flex Code
17556 \begin_layout Plain Layout
17563 \begin_inset Flex Code
17566 \begin_layout Plain Layout
17573 \begin_inset Flex Code
17576 \begin_layout Plain Layout
17583 \begin_inset Flex Code
17586 \begin_layout Plain Layout
17593 \begin_inset Flex Code
17596 \begin_layout Plain Layout
17603 \begin_inset Flex Code
17606 \begin_layout Plain Layout
17613 \begin_inset Flex Code
17616 \begin_layout Plain Layout
17623 \begin_inset Flex Code
17626 \begin_layout Plain Layout
17633 \begin_inset Flex Code
17636 \begin_layout Plain Layout
17643 \begin_inset Flex Code
17646 \begin_layout Plain Layout
17653 \begin_inset Flex Code
17656 \begin_layout Plain Layout
17663 \begin_inset Flex Code
17666 \begin_layout Plain Layout
17673 \begin_inset Flex Code
17676 \begin_layout Plain Layout
17683 \begin_inset Flex Code
17686 \begin_layout Plain Layout
17693 \begin_inset Flex Code
17696 \begin_layout Plain Layout
17705 \begin_layout Enumerate
17706 The layout for a Flex inset is being defined.
17708 \begin_inset Flex Code
17711 \begin_layout Plain Layout
17717 must be of the form
17718 \begin_inset Quotes eld
17722 \begin_inset Flex Code
17725 \begin_layout Plain Layout
17732 \begin_inset Quotes erd
17736 \begin_inset Flex Code
17739 \begin_layout Plain Layout
17745 may be be any valid identifier not used by a pre-existing Flex inset.
17746 The identifier may include spaces, but in that case the whole thing must
17747 be wrapped in quotes.
17748 Note that the definition of a flex inset
17753 \begin_inset Flex Code
17756 \begin_layout Plain Layout
17762 entry, declaring which type of inset it defines.
17765 \begin_layout Enumerate
17766 The layout for user specific branch is being defined.
17768 \begin_inset Flex Code
17771 \begin_layout Plain Layout
17777 must be of the form
17778 \begin_inset Quotes eld
17782 \begin_inset Flex Code
17785 \begin_layout Plain Layout
17792 \begin_inset Quotes erd
17796 \begin_inset Flex Code
17799 \begin_layout Plain Layout
17805 may be be any valid identifier of branch defined in user's document.
17806 The identifier may include spaces, but in that case the whole thing must
17807 be wrapped in quotes.
17808 The main purpose of this feature is to allow \SpecialChar LaTeX
17809 wrapping around specific
17810 branches as user needs.
17813 \begin_layout Enumerate
17814 The layout of a user (or class) specific caption is being defined.
17816 \begin_inset Flex Code
17819 \begin_layout Plain Layout
17825 must be of the form
17826 \begin_inset Quotes eld
17830 \begin_inset Flex Code
17833 \begin_layout Plain Layout
17840 \begin_inset Quotes erd
17844 \begin_inset Flex Code
17847 \begin_layout Plain Layout
17853 specifies the name of the caption as it appears in the menu.
17854 Have a look at the standard caption (
17855 \begin_inset Flex Code
17858 \begin_layout Plain Layout
17864 ), the specific captions of the KOMA-Script classes (
17865 \begin_inset Flex Code
17868 \begin_layout Plain Layout
17875 \begin_inset Flex Code
17878 \begin_layout Plain Layout
17887 \begin_inset space ~
17891 \begin_inset Newline linebreak
17897 \begin_inset Flex Code
17900 \begin_layout Plain Layout
17906 ) for applications.
17909 \begin_layout Standard
17911 \begin_inset Flex Code
17914 \begin_layout Plain Layout
17920 definition can contain the following entries:
17923 \begin_layout Description
17924 \begin_inset Flex Code
17927 \begin_layout Plain Layout
17934 \begin_inset Flex Code
17937 \begin_layout Plain Layout
17943 =""] This inset will appear in the table of contents of the given type.
17944 An empty string disables.
17945 See also the OutlinerName and the IsTocCaption commands.
17946 This is only implemented for Flex insets.
17950 \begin_layout Description
17951 \begin_inset Flex Code
17954 \begin_layout Plain Layout
17961 \begin_inset Flex Code
17964 \begin_layout Plain Layout
17970 ] Defines argument number of a command\SpecialChar breakableslash
17971 environment associated with the current
17973 The definition must end with
17974 \begin_inset Flex Code
17977 \begin_layout Plain Layout
17985 \begin_inset CommandInset ref
17987 reference "subsec:Paragraph-Styles"
17994 \begin_layout Description
17995 \begin_inset Flex Code
17998 \begin_layout Plain Layout
18004 Preamble for changing language commands; see
18005 \begin_inset CommandInset ref
18007 reference "subsec:I18n"
18014 \begin_layout Description
18015 \begin_inset Flex Code
18018 \begin_layout Plain Layout
18025 \begin_inset Flex Code
18028 \begin_layout Plain Layout
18034 ] The color for the inset's background.
18036 \begin_inset CommandInset ref
18038 reference "chap:Names-of-colors"
18042 for a list of the available color names.
18045 \begin_layout Description
18046 \begin_inset Flex Code
18049 \begin_layout Plain Layout
18056 \begin_inset Flex Code
18059 \begin_layout Plain Layout
18068 \begin_inset space \thinspace{}
18072 \begin_inset Flex Code
18075 \begin_layout Plain Layout
18081 ] Whether to use the content of the inset as the label, when the inset is
18086 \begin_layout Description
18087 \begin_inset Flex Code
18090 \begin_layout Plain Layout
18097 \begin_inset Flex Code
18100 \begin_layout Plain Layout
18106 ] As with paragraph styles, see
18107 \begin_inset CommandInset ref
18109 reference "subsec:Paragraph-Styles"
18114 Note that you need to specify the complete type, e.
18115 \begin_inset space \thinspace{}
18119 \begin_inset space ~
18123 \begin_inset Flex Code
18126 \begin_layout Plain Layout
18127 CopyStyle Flex:<name>
18135 \begin_layout Description
18136 \begin_inset Flex Code
18139 \begin_layout Plain Layout
18146 \begin_inset Flex Code
18149 \begin_layout Plain Layout
18158 \begin_inset space \thinspace{}
18162 \begin_inset Flex Code
18165 \begin_layout Plain Layout
18171 ] Indicates whether the user may employ the Paragraph Settings dialog to
18172 customize the paragraph.
18175 \begin_layout Description
18176 \begin_inset Flex Code
18179 \begin_layout Plain Layout
18186 \begin_inset Flex Code
18189 \begin_layout Plain Layout
18196 \begin_inset Flex Code
18199 \begin_layout Plain Layout
18206 \begin_inset Flex Code
18209 \begin_layout Plain Layout
18215 , describing the rendering style used for the inset's frame and buttons.
18216 Footnotes generally use
18217 \begin_inset Flex Code
18220 \begin_layout Plain Layout
18226 , ERT insets generally
18227 \begin_inset Flex Code
18230 \begin_layout Plain Layout
18236 , and character styles
18237 \begin_inset Flex Code
18240 \begin_layout Plain Layout
18249 \begin_layout Description
18250 \begin_inset Flex Code
18253 \begin_layout Plain Layout
18260 \begin_inset Flex Code
18263 \begin_layout Plain Layout
18272 \begin_inset space \thinspace{}
18278 \begin_inset Flex Code
18281 \begin_layout Plain Layout
18290 \begin_inset Flex Code
18293 \begin_layout Plain Layout
18300 \begin_inset Flex Code
18303 \begin_layout Plain Layout
18310 Indicates whether the environment will stand on its own in the output or
18311 will appear inline with the surrounding text.
18312 If set to false, it is supposed that the \SpecialChar LaTeX
18313 environment ignores white space
18314 (including one newline character) after the
18315 \begin_inset Flex Code
18318 \begin_layout Plain Layout
18331 \begin_inset Flex Code
18334 \begin_layout Plain Layout
18350 \begin_layout Description
18351 \begin_inset Flex Code
18354 \begin_layout Plain Layout
18360 Required at the end of the
18361 \begin_inset Flex Code
18364 \begin_layout Plain Layout
18373 \begin_layout Description
18374 \begin_inset Flex Code
18377 \begin_layout Plain Layout
18383 The font used for both the text body
18389 \begin_inset CommandInset ref
18391 reference "subsec:Font-description"
18396 Note that defining this font automatically defines the
18397 \begin_inset Flex Code
18400 \begin_layout Plain Layout
18406 to the same value, so define this first and define
18407 \begin_inset Flex Code
18410 \begin_layout Plain Layout
18416 later if you want them to be different.
18419 \begin_layout Description
18420 \begin_inset Flex Code
18423 \begin_layout Plain Layout
18424 FixedWidthPreambleEncoding
18430 \begin_inset Flex Code
18433 \begin_layout Plain Layout
18442 \begin_inset space \thinspace{}
18446 \begin_inset Flex Code
18449 \begin_layout Plain Layout
18455 ] Force a fixed width encoding for the translated contents of
18456 \begin_inset Flex Code
18459 \begin_layout Plain Layout
18466 \begin_inset Flex Code
18469 \begin_layout Plain Layout
18475 code generated by this layout.
18476 This is needed for special \SpecialChar LaTeX
18481 that do not work with variable width encodings such as
18486 This setting is ignored if fully Unicode aware \SpecialChar LaTeX
18487 backends such as Xe\SpecialChar TeX
18489 Lua\SpecialChar TeX
18493 \begin_layout Description
18494 \begin_inset Flex Code
18497 \begin_layout Plain Layout
18498 ForceLocalFontSwitch
18504 \begin_inset Flex Code
18507 \begin_layout Plain Layout
18516 \begin_inset space \thinspace{}
18520 \begin_inset Flex Code
18523 \begin_layout Plain Layout
18529 ] When using babel, always use a local font switch (
18530 \begin_inset Flex Code
18533 \begin_layout Plain Layout
18541 ), never a global one (such as
18542 \begin_inset Flex Code
18545 \begin_layout Plain Layout
18556 \begin_layout Description
18557 \begin_inset Flex Code
18560 \begin_layout Plain Layout
18567 \begin_inset Flex Code
18570 \begin_layout Plain Layout
18579 \begin_inset space \thinspace{}
18583 \begin_inset Flex Code
18586 \begin_layout Plain Layout
18593 \begin_inset Quotes eld
18597 \begin_inset Quotes erd
18600 language, leading to Left-to-Right (Latin) output, e.
18601 \begin_inset space \thinspace{}
18605 \begin_inset space \space{}
18608 in \SpecialChar TeX
18613 \begin_layout Description
18614 \begin_inset Flex Code
18617 \begin_layout Plain Layout
18624 \begin_inset Flex Code
18627 \begin_layout Plain Layout
18636 \begin_inset space \thinspace{}
18640 \begin_inset Flex Code
18643 \begin_layout Plain Layout
18649 ] Force a a line break in the \SpecialChar LaTeX
18650 output before the inset starts and after
18652 This assures the inset itself is output on its own lines, for parsing purposes.
18655 \begin_layout Description
18656 \begin_inset Flex Code
18659 \begin_layout Plain Layout
18666 \begin_inset Flex Code
18669 \begin_layout Plain Layout
18678 \begin_inset space \thinspace{}
18682 \begin_inset Flex Code
18685 \begin_layout Plain Layout
18691 ] Indicates whether the
18692 \begin_inset Flex Code
18695 \begin_layout Plain Layout
18701 should be used or, instead, the user can change the paragraph style used
18706 \begin_layout Description
18707 \begin_inset Flex Code
18710 \begin_layout Plain Layout
18717 \begin_inset Flex Code
18720 \begin_layout Plain Layout
18729 \begin_inset space \thinspace{}
18733 \begin_inset Flex Code
18736 \begin_layout Plain Layout
18742 ] As with paragraph styles, see
18743 \begin_inset CommandInset ref
18745 reference "subsec:Paragraph-Styles"
18752 \begin_layout Description
18753 \begin_inset Flex Code
18756 \begin_layout Plain Layout
18762 These tags control the XHTML output.
18764 \begin_inset CommandInset ref
18766 reference "sec:Tags-for-XHTML"
18773 \begin_layout Description
18774 \begin_inset Flex Code
18777 \begin_layout Plain Layout
18784 \begin_inset Flex Code
18787 \begin_layout Plain Layout
18796 \begin_inset space \thinspace{}
18800 \begin_inset Flex Code
18803 \begin_layout Plain Layout
18809 ] Whether to include the contents of this inset in the strings generated
18810 for the `Outline' pane for all table of contents, regardless of the AddToToc
18812 One would not, for example, want the content of a footnote in a section
18813 header to be included in the TOC displayed in the outline, but one would
18814 normally want the content of a character style displayed.
18815 Default is false: not to include.
18818 \begin_layout Description
18819 \begin_inset Flex Code
18822 \begin_layout Plain Layout
18829 \begin_inset Flex Code
18832 \begin_layout Plain Layout
18841 \begin_inset space \thinspace{}
18845 \begin_inset Flex Code
18848 \begin_layout Plain Layout
18854 ] If this is set to 1 and AddToToc is enabled, the inset adds a summary
18855 of its contents in its item in the table of contents.
18856 Otherwise, only the label appears.
18859 \begin_layout Description
18860 \begin_inset Flex Code
18863 \begin_layout Plain Layout
18872 \begin_inset Flex Code
18875 \begin_layout Plain Layout
18884 \begin_inset space \thinspace{}
18888 \begin_inset Flex Code
18891 \begin_layout Plain Layout
18897 ] As with paragraph styles, see
18898 \begin_inset CommandInset ref
18900 reference "subsec:Paragraph-Styles"
18907 \begin_layout Description
18908 \begin_inset Flex Code
18911 \begin_layout Plain Layout
18917 The font used for the label.
18919 \begin_inset CommandInset ref
18921 reference "subsec:Font-description"
18926 Note that this definition can never appear before
18927 \begin_inset Flex Code
18930 \begin_layout Plain Layout
18936 , lest it be ineffective.
18939 \begin_layout Description
18940 \begin_inset Flex Code
18943 \begin_layout Plain Layout
18950 \begin_inset Flex Code
18953 \begin_layout Plain Layout
18960 \begin_inset Quotes erd
18964 \begin_inset Quotes erd
18967 ] What will be displayed on the button or elsewhere as the inset label.
18969 \begin_inset Flex Code
18972 \begin_layout Plain Layout
18980 \begin_inset Flex Code
18983 \begin_layout Plain Layout
18989 ) modify this label on the fly.
18992 \begin_layout Description
18993 \begin_inset Flex Code
18996 \begin_layout Plain Layout
19002 Language dependent preamble; see
19003 \begin_inset CommandInset ref
19005 reference "subsec:I18n"
19012 \begin_layout Description
19013 \begin_inset Flex Code
19016 \begin_layout Plain Layout
19023 \begin_inset Flex Code
19026 \begin_layout Plain Layout
19032 ] The name of the corresponding \SpecialChar LaTeX
19034 Either the environment or command name.
19037 \begin_layout Description
19038 \begin_inset Flex Code
19041 \begin_layout Plain Layout
19048 \begin_inset Flex Code
19051 \begin_layout Plain Layout
19057 ] The optional parameter for the corresponding
19058 \begin_inset Flex Code
19061 \begin_layout Plain Layout
19067 stuff, including possible bracket pairs like
19068 \begin_inset Flex Code
19071 \begin_layout Plain Layout
19078 This parameter cannot be changed from within \SpecialChar LyX
19080 \begin_inset Flex Code
19083 \begin_layout Plain Layout
19089 for customizable parameters).
19090 It will be output as is after all \SpecialChar LaTeX
19092 \begin_inset Flex Code
19095 \begin_layout Plain Layout
19104 \begin_layout Description
19105 \begin_inset Flex Code
19108 \begin_layout Plain Layout
19115 \begin_inset Flex Code
19118 \begin_layout Plain Layout
19119 Command, Environment, None
19124 ] How the style should be translated into \SpecialChar LaTeX
19129 \begin_layout Plain Layout
19130 \begin_inset Flex Code
19133 \begin_layout Plain Layout
19139 is perhaps a bit misleading, since these rules apply to SGML classes too.
19140 Visit the SGML class files for specific examples.
19149 \begin_layout Description
19150 \begin_inset Flex Code
19153 \begin_layout Plain Layout
19159 means nothing special
19162 \begin_layout Description
19163 \begin_inset Flex Code
19166 \begin_layout Plain Layout
19173 \begin_inset Flex Code
19176 \begin_layout Plain Layout
19183 {\SpecialChar ldots
19192 \begin_layout Description
19193 \begin_inset Flex Code
19196 \begin_layout Plain Layout
19203 \begin_inset Flex Code
19206 \begin_layout Plain Layout
19213 }\SpecialChar ldots
19228 \begin_layout Standard
19229 Putting the last few things together, the \SpecialChar LaTeX
19230 output will be either:
19233 \begin_layout LyX-Code
19236 LatexName[LatexParam]{\SpecialChar ldots
19240 \begin_layout Standard
19244 \begin_layout LyX-Code
19247 begin{LatexName}[LatexParam] \SpecialChar ldots
19253 \begin_layout Standard
19254 depending upon the \SpecialChar LaTeX
19259 \begin_layout Description
19260 \begin_inset Flex Code
19263 \begin_layout Plain Layout
19270 \begin_inset Flex Code
19273 \begin_layout Plain Layout
19279 ] A string that is put at the beginning of the layout content.
19280 A line break in the output can be indicated by
19281 \begin_inset Flex Code
19284 \begin_layout Plain Layout
19293 \begin_layout Description
19294 \begin_inset Flex Code
19297 \begin_layout Plain Layout
19304 \begin_inset Flex Code
19307 \begin_layout Plain Layout
19314 \begin_inset Flex Code
19317 \begin_layout Plain Layout
19324 \begin_inset Flex Code
19327 \begin_layout Plain Layout
19334 \begin_inset Flex Code
19337 \begin_layout Plain Layout
19343 (indicating a dummy definition ending definitions of charstyles, etc).
19344 This entry is required in and is only meaningful for Flex insets.
19345 Among other things, it determines on which menu this inset will appear.
19347 \begin_inset Flex Code
19350 \begin_layout Plain Layout
19357 \begin_inset Flex Code
19360 \begin_layout Plain Layout
19366 will automatically set
19367 \begin_inset Flex Code
19370 \begin_layout Plain Layout
19377 \begin_inset Flex Code
19380 \begin_layout Plain Layout
19388 \begin_inset Flex Code
19391 \begin_layout Plain Layout
19397 can be set to true, or
19398 \begin_inset Flex Code
19401 \begin_layout Plain Layout
19408 \begin_inset Flex Code
19411 \begin_layout Plain Layout
19417 insets by setting it
19422 \begin_inset Flex Code
19425 \begin_layout Plain Layout
19434 \begin_layout Description
19435 \begin_inset Flex Code
19438 \begin_layout Plain Layout
19445 \begin_inset Flex Code
19448 \begin_layout Plain Layout
19457 \begin_inset space \thinspace{}
19461 \begin_inset Flex Code
19464 \begin_layout Plain Layout
19470 ] Whether multiple paragraphs are permitted in this inset.
19472 \begin_inset Flex Code
19475 \begin_layout Plain Layout
19481 to the same value and
19482 \begin_inset Flex Code
19485 \begin_layout Plain Layout
19491 to the opposite value.
19492 These can be reset to other values, if they are used
19497 \begin_inset Flex Code
19500 \begin_layout Plain Layout
19510 \begin_layout Description
19511 \begin_inset Flex Code
19514 \begin_layout Plain Layout
19521 \begin_inset Flex Code
19524 \begin_layout Plain Layout
19533 \begin_inset space \thinspace{}
19537 \begin_inset Flex Code
19540 \begin_layout Plain Layout
19546 ] Whether fragile commands in this inset should be
19547 \begin_inset Flex Code
19550 \begin_layout Plain Layout
19563 whether the command should itself be protected.) Default is false.
19566 \begin_layout Description
19567 \begin_inset Flex Code
19570 \begin_layout Plain Layout
19577 \begin_inset Flex Code
19580 \begin_layout Plain Layout
19586 ] Deletes an existing
19587 \begin_inset Flex Code
19590 \begin_layout Plain Layout
19599 \begin_layout Description
19600 \begin_inset Flex Code
19603 \begin_layout Plain Layout
19610 \begin_inset Flex Code
19613 \begin_layout Plain Layout
19620 \begin_inset Flex Code
19623 \begin_layout Plain Layout
19629 that has replaced this
19630 \begin_inset Flex Code
19633 \begin_layout Plain Layout
19640 This is used to rename an
19641 \begin_inset Flex Code
19644 \begin_layout Plain Layout
19650 , while keeping backward compatibility.
19653 \begin_layout Description
19654 \begin_inset Flex Code
19657 \begin_layout Plain Layout
19664 \begin_inset Flex Code
19667 \begin_layout Plain Layout
19676 \begin_inset space \thinspace{}
19680 \begin_inset Flex Code
19683 \begin_layout Plain Layout
19689 ] As with paragraph styles, see
19690 \begin_inset CommandInset ref
19692 reference "subsec:Paragraph-Styles"
19700 \begin_layout Description
19701 \begin_inset Flex Code
19704 \begin_layout Plain Layout
19711 \begin_inset Flex Code
19714 \begin_layout Plain Layout
19723 \begin_inset space \thinspace{}
19727 \begin_inset Flex Code
19730 \begin_layout Plain Layout
19736 ] As with paragraph styles, see
19737 \begin_inset CommandInset ref
19739 reference "subsec:Paragraph-Styles"
19747 \begin_layout Description
19748 \begin_inset Flex Code
19751 \begin_layout Plain Layout
19757 As with paragraph styles, see
19758 \begin_inset CommandInset ref
19760 reference "subsec:Paragraph-Styles"
19767 \begin_layout Description
19768 \begin_inset Flex Code
19771 \begin_layout Plain Layout
19778 \begin_inset Flex Code
19781 \begin_layout Plain Layout
19787 ] The prefix to use when creating labels referring to insets of this type.
19788 This allows the use of formatted references.
19791 \begin_layout Description
19792 \begin_inset Flex Code
19795 \begin_layout Plain Layout
19802 \begin_inset Flex Code
19805 \begin_layout Plain Layout
19811 ] As with paragraph styles, see
19812 \begin_inset CommandInset ref
19814 reference "subsec:Paragraph-Styles"
19821 \begin_layout Description
19822 \begin_inset Flex Code
19825 \begin_layout Plain Layout
19832 \begin_inset Flex Code
19835 \begin_layout Plain Layout
19844 \begin_inset space \thinspace{}
19848 \begin_inset Flex Code
19851 \begin_layout Plain Layout
19857 ] Resets the \SpecialChar LaTeX
19858 arguments of this layout (as defined via the
19859 \begin_inset Flex Code
19862 \begin_layout Plain Layout
19869 This is useful if you have copied a style via
19870 \begin_inset Flex Code
19873 \begin_layout Plain Layout
19879 , but you do not want to inherit its (required and optional) arguments.
19882 \begin_layout Description
19883 \begin_inset Flex Code
19886 \begin_layout Plain Layout
19893 \begin_inset Flex Code
19896 \begin_layout Plain Layout
19903 \begin_inset space \thinspace{}
19907 \begin_inset Flex Code
19910 \begin_layout Plain Layout
19918 ] Whether this inset should use the font of its surrounding environment
19920 Default is false: use the font of the surrounding environment.
19923 \begin_layout Description
19924 \begin_inset Flex Code
19927 \begin_layout Plain Layout
19934 \begin_inset Flex Code
19937 \begin_layout Plain Layout
19943 ] A string that is put at the end of the layout content.
19944 A line break in the output can be indicated by
19945 \begin_inset Flex Code
19948 \begin_layout Plain Layout
19957 \begin_layout Description
19958 \begin_inset Flex Code
19961 \begin_layout Plain Layout
19968 \begin_inset Flex Code
19971 \begin_layout Plain Layout
19978 \begin_inset space \thinspace{}
19982 \begin_inset Flex Code
19985 \begin_layout Plain Layout
19993 ] Allow spell-checking the contents of this inset.
19997 \begin_layout Subsection
19999 \begin_inset CommandInset label
20001 name "subsec:Counters"
20008 \begin_layout Standard
20009 It is necessary to define the counters (
20010 \begin_inset Flex Noun
20013 \begin_layout Plain Layout
20020 \begin_inset Flex Noun
20023 \begin_layout Plain Layout
20029 , \SpecialChar ldots
20030 ) in the text class itself.
20031 The standard counters are defined in the file
20032 \begin_inset Flex Code
20035 \begin_layout Plain Layout
20041 , so you may have to do no more than add
20044 \begin_layout LyX-Code
20045 Input stdcounters.inc
20048 \begin_layout Standard
20049 to your layout file to get them to work.
20050 But if you want to define custom counters, then you can do so.
20051 The counter declaration must begin with:
20054 \begin_layout LyX-Code
20055 Counter CounterName
20058 \begin_layout Standard
20060 \begin_inset Flex Code
20063 \begin_layout Plain Layout
20069 ' is replaced by the name of the counter.
20070 And it must end with
20071 \begin_inset Quotes eld
20075 \begin_inset Flex Code
20078 \begin_layout Plain Layout
20085 \begin_inset Quotes erd
20089 The following parameters can also be used:
20092 \begin_layout Description
20093 \begin_inset Flex Code
20096 \begin_layout Plain Layout
20103 \begin_inset Flex Code
20106 \begin_layout Plain Layout
20112 ] Sets the initial value for the counter, to which it will be reset whenever
20114 Normally, one will want the default, 1.
20117 \begin_layout Description
20118 \begin_inset Flex Code
20121 \begin_layout Plain Layout
20128 \begin_inset Flex Code
20131 \begin_layout Plain Layout
20138 \begin_inset Quotes erd
20142 \begin_inset Quotes erd
20145 ] When defined, this string defines how the counter is displayed.
20146 Setting this value sets
20147 \begin_inset Flex Code
20150 \begin_layout Plain Layout
20151 LabelStringAppendix
20157 The following special constructs can be used in the string:
20161 \begin_layout Itemize
20162 \begin_inset Flex Code
20165 \begin_layout Plain Layout
20173 will be replaced by the expansion of the
20174 \begin_inset Flex Code
20177 \begin_layout Plain Layout
20184 \begin_inset Flex Code
20187 \begin_layout Plain Layout
20188 LabelStringAppendix
20194 \begin_inset Flex Code
20197 \begin_layout Plain Layout
20207 \begin_layout Itemize
20208 counter values can be expressed using \SpecialChar LaTeX
20210 \begin_inset Newline newline
20214 \begin_inset Flex Code
20217 \begin_layout Plain Layout
20234 \begin_inset Flex Code
20237 \begin_layout Plain Layout
20249 \begin_layout Plain Layout
20259 Actually, the situation is a bit more complicated: any
20278 other than those described below will produce arabic numerals.
20279 It would not be surprising to see this change in the future.
20285 \begin_inset Flex Code
20288 \begin_layout Plain Layout
20294 : 1, 2, 3,\SpecialChar ldots
20296 \begin_inset Flex Code
20299 \begin_layout Plain Layout
20305 for lower-case letters: a, b, c, \SpecialChar ldots
20307 \begin_inset Flex Code
20310 \begin_layout Plain Layout
20316 for upper-case letters: A, B, C, \SpecialChar ldots
20318 \begin_inset Flex Code
20321 \begin_layout Plain Layout
20327 for lower-case roman numerals: i, ii, iii, \SpecialChar ldots
20329 \begin_inset Flex Code
20332 \begin_layout Plain Layout
20338 for upper-case roman numerals: I, II, III\SpecialChar ldots
20340 \begin_inset Flex Code
20343 \begin_layout Plain Layout
20349 for hebrew numerals.
20353 \begin_layout Standard
20354 If LabelString is not defined, a default value is constructed as follows:
20355 if the counter has a master counter
20356 \begin_inset Flex Code
20359 \begin_layout Plain Layout
20366 \begin_inset Flex Code
20369 \begin_layout Plain Layout
20376 \begin_inset Newline newline
20380 \begin_inset Flex Code
20383 \begin_layout Plain Layout
20393 is used; otherwise the string
20394 \begin_inset Flex Code
20397 \begin_layout Plain Layout
20408 \begin_layout Description
20409 \begin_inset Flex Code
20412 \begin_layout Plain Layout
20413 LabelStringAppendix
20419 \begin_inset Flex Code
20422 \begin_layout Plain Layout
20429 \begin_inset Quotes erd
20433 \begin_inset Quotes erd
20437 \begin_inset Flex Code
20440 \begin_layout Plain Layout
20446 , but for use in the Appendix.
20449 \begin_layout Description
20450 \begin_inset Flex Code
20453 \begin_layout Plain Layout
20460 \begin_inset Flex Code
20463 \begin_layout Plain Layout
20470 \begin_inset Quotes erd
20474 \begin_inset Quotes erd
20477 ] A format for use with formatted references to this counter.
20478 For example, one might want to have references to section numbers appear
20480 \begin_inset Quotes eld
20484 \begin_inset Quotes erd
20488 The string should contain
20489 \begin_inset Quotes eld
20493 \begin_inset Quotes erd
20497 This will be replaced by the counter number itself.
20498 So, for sections, it would be: Section ##.
20501 \begin_layout Description
20502 \begin_inset Flex Code
20505 \begin_layout Plain Layout
20512 \begin_inset Flex Code
20515 \begin_layout Plain Layout
20522 \begin_inset Quotes erd
20526 \begin_inset Quotes erd
20529 ] If this is set to the name of another counter, the present counter will
20530 be reset every time the other one is increased.
20532 \begin_inset Flex Code
20535 \begin_layout Plain Layout
20542 \begin_inset Flex Code
20545 \begin_layout Plain Layout
20554 \begin_layout Subsection
20556 \begin_inset CommandInset label
20558 name "subsec:Font-description"
20565 \begin_layout Standard
20566 A font description looks like this:
20569 \begin_layout LyX-Code
20586 \begin_layout LyX-Code
20590 \begin_layout LyX-Code
20594 \begin_layout Standard
20595 The following commands are available:
20598 \begin_layout Description
20599 \begin_inset Flex Code
20602 \begin_layout Plain Layout
20609 \begin_inset Flex Code
20612 \begin_layout Plain Layout
20621 \begin_inset Flex Code
20624 \begin_layout Plain Layout
20631 \begin_inset Flex Code
20634 \begin_layout Plain Layout
20641 \begin_inset Flex Code
20644 \begin_layout Plain Layout
20651 \begin_inset Flex Code
20654 \begin_layout Plain Layout
20661 \begin_inset Flex Code
20664 \begin_layout Plain Layout
20671 \begin_inset Flex Code
20674 \begin_layout Plain Layout
20681 \begin_inset Flex Code
20684 \begin_layout Plain Layout
20691 \begin_inset Flex Code
20694 \begin_layout Plain Layout
20701 \begin_inset Flex Code
20704 \begin_layout Plain Layout
20711 \begin_inset Flex Code
20714 \begin_layout Plain Layout
20721 \begin_inset Flex Code
20724 \begin_layout Plain Layout
20731 \begin_inset Flex Code
20734 \begin_layout Plain Layout
20741 \begin_inset Flex Code
20744 \begin_layout Plain Layout
20751 \begin_inset Flex Code
20754 \begin_layout Plain Layout
20761 \begin_inset Flex Code
20764 \begin_layout Plain Layout
20771 \begin_inset Flex Code
20774 \begin_layout Plain Layout
20781 \begin_inset Flex Code
20784 \begin_layout Plain Layout
20791 \begin_inset Flex Code
20794 \begin_layout Plain Layout
20801 \begin_inset Flex Code
20804 \begin_layout Plain Layout
20813 \begin_layout Description
20814 \begin_inset Flex Code
20817 \begin_layout Plain Layout
20824 \begin_inset Flex Code
20827 \begin_layout Plain Layout
20836 \begin_inset Flex Code
20839 \begin_layout Plain Layout
20846 \begin_inset Flex Code
20849 \begin_layout Plain Layout
20858 \begin_layout Description
20859 \begin_inset Flex Code
20862 \begin_layout Plain Layout
20869 \begin_inset Flex Code
20872 \begin_layout Plain Layout
20878 ] Valid arguments are:
20879 \begin_inset Flex Code
20882 \begin_layout Plain Layout
20889 \begin_inset Flex Code
20892 \begin_layout Plain Layout
20899 \begin_inset Flex Code
20902 \begin_layout Plain Layout
20909 \begin_inset Flex Code
20912 \begin_layout Plain Layout
20919 \begin_inset Flex Code
20922 \begin_layout Plain Layout
20929 \begin_inset Flex Code
20932 \begin_layout Plain Layout
20939 \begin_inset Flex Code
20942 \begin_layout Plain Layout
20949 \begin_inset Flex Code
20952 \begin_layout Plain Layout
20959 \begin_inset Flex Code
20962 \begin_layout Plain Layout
20969 \begin_inset Flex Code
20972 \begin_layout Plain Layout
20979 \begin_inset Flex Code
20982 \begin_layout Plain Layout
20989 \begin_inset Flex Code
20992 \begin_layout Plain Layout
20999 Each of these turns on or off the corresponding attribute.
21001 \begin_inset Flex Code
21004 \begin_layout Plain Layout
21010 turns on emphasis, and
21011 \begin_inset Flex Code
21014 \begin_layout Plain Layout
21022 \begin_inset Newline newline
21025 If the latter seems puzzling, remember that the font settings for the present
21026 context are generally inherited from the surrounding context.
21028 \begin_inset Flex Code
21031 \begin_layout Plain Layout
21037 would turn off the emphasis that was anyway in effect, say, in a theorem
21041 \begin_layout Description
21042 \begin_inset Flex Code
21045 \begin_layout Plain Layout
21052 \begin_inset Flex Code
21055 \begin_layout Plain Layout
21064 \begin_inset Flex Code
21067 \begin_layout Plain Layout
21076 \begin_layout Description
21077 \begin_inset Flex Code
21080 \begin_layout Plain Layout
21087 \begin_inset Flex Code
21090 \begin_layout Plain Layout
21099 \begin_inset Flex Code
21102 \begin_layout Plain Layout
21109 \begin_inset Flex Code
21112 \begin_layout Plain Layout
21119 \begin_inset Flex Code
21122 \begin_layout Plain Layout
21131 \begin_layout Description
21132 \begin_inset Flex Code
21135 \begin_layout Plain Layout
21142 \begin_inset Flex Code
21145 \begin_layout Plain Layout
21152 \begin_inset Flex Code
21155 \begin_layout Plain Layout
21162 \begin_inset Flex Code
21165 \begin_layout Plain Layout
21174 \begin_inset Flex Code
21177 \begin_layout Plain Layout
21184 \begin_inset Flex Code
21187 \begin_layout Plain Layout
21194 \begin_inset Flex Code
21197 \begin_layout Plain Layout
21204 \begin_inset Flex Code
21207 \begin_layout Plain Layout
21214 \begin_inset Flex Code
21217 \begin_layout Plain Layout
21226 \begin_layout Subsection
21227 \begin_inset CommandInset label
21229 name "subsec:Citation-engine-description"
21233 Cite engine description
21236 \begin_layout Standard
21238 \begin_inset Flex Code
21241 \begin_layout Plain Layout
21247 blocks, as used mainly in cite engine files (see
21248 \begin_inset CommandInset ref
21250 reference "subsec:Cite-Engine-Files"
21257 ), define the citation commands provided by a specific
21258 \begin_inset Quotes eld
21262 \begin_inset Quotes erd
21266 A cite engine, in \SpecialChar LyX
21267 terms, is way specific way to format citations, using
21268 numbers, author names and/or years.
21269 Currently, \SpecialChar LyX
21270 supports three such engine types, namely:
21273 \begin_layout Enumerate
21274 \begin_inset Flex Code
21277 \begin_layout Plain Layout
21283 : the default Bib\SpecialChar TeX
21284 way to format citations, a simple numeric style (e.
21285 \begin_inset space \thinspace{}
21289 \begin_inset Quotes eld
21293 \begin_inset Quotes erd
21299 \begin_layout Enumerate
21300 \begin_inset Flex Code
21303 \begin_layout Plain Layout
21309 : Harvard-styled citations using author names and publication year (e.
21310 \begin_inset space \thinspace{}
21314 \begin_inset Quotes eld
21317 Smith and Miller (2017b)
21318 \begin_inset Quotes erd
21324 \begin_layout Enumerate
21325 \begin_inset Flex Code
21328 \begin_layout Plain Layout
21334 : extended numerical citations that also allow for author or title next
21336 \begin_inset space \thinspace{}
21340 \begin_inset Quotes eld
21343 Smith and Miller [1]
21344 \begin_inset Quotes erd
21350 \begin_layout Standard
21351 \begin_inset Flex Code
21354 \begin_layout Plain Layout
21360 blocks look like this:
21363 \begin_layout LyX-Code
21367 \begin_layout LyX-Code
21371 \begin_layout LyX-Code
21375 \begin_layout LyX-Code
21376 citeyearpar[][]=parencite*
21379 \begin_layout LyX-Code
21383 \begin_layout LyX-Code
21387 \begin_layout Standard
21389 \begin_inset Flex Code
21392 \begin_layout Plain Layout
21398 denotes the engine.
21399 The individual lines respectively define a cite command or cite command
21400 paradigm supported by this engine.
21401 The line can be as simple as a cite command that is used both to name the
21402 respective \SpecialChar LyX
21403 command and the \SpecialChar LaTeX
21404 output or more complex in order to differentiate
21406 The full syntax is:
21409 \begin_layout LyX-Code
21410 LyXName|alias$*<!_stardesc!_stardesctooltip>[][]=latexcmd
21413 \begin_layout Itemize
21414 \begin_inset Flex Code
21417 \begin_layout Plain Layout
21423 : The name as used in the
21424 \begin_inset Flex Code
21427 \begin_layout Plain Layout
21437 \begin_layout Standard
21438 For portability reasons, we try to use the same name for same-formatted
21439 commands in different cite packages (thus many names stem from natbib,
21440 and thus we need to differentiate a
21441 \begin_inset Flex Code
21444 \begin_layout Plain Layout
21450 sometimes, if the \SpecialChar LaTeX
21451 command names differ).
21455 \begin_layout Itemize
21456 \begin_inset Flex Code
21459 \begin_layout Plain Layout
21465 : a (comma-separated) list of commands that fall back to the given
21466 \begin_inset Flex Code
21469 \begin_layout Plain Layout
21475 in the current engine.
21476 This eases the switch of citation packages and engines.
21478 \begin_inset Flex Code
21481 \begin_layout Plain Layout
21488 \begin_inset Flex Code
21491 \begin_layout Plain Layout
21497 in layout definitions.
21500 \begin_layout Itemize
21501 \begin_inset Flex Code
21504 \begin_layout Plain Layout
21510 : The actual \SpecialChar LaTeX
21511 command that is output.
21515 \begin_layout Standard
21516 \begin_inset Flex Code
21519 \begin_layout Plain Layout
21526 \begin_inset Flex Code
21529 \begin_layout Plain Layout
21537 \begin_inset Flex Code
21540 \begin_layout Plain Layout
21547 \begin_inset Flex Code
21550 \begin_layout Plain Layout
21556 will be output to \SpecialChar LaTeX
21560 \begin_layout Standard
21564 \begin_layout Itemize
21565 Capitalization indicates that the command also has a capitalized form (
21566 \begin_inset Flex Code
21569 \begin_layout Plain Layout
21579 \begin_inset Flex Code
21582 \begin_layout Plain Layout
21591 These usually enforce up-casing of name prefixes (
21596 \begin_inset Formula $\Rightarrow$
21606 \begin_layout Itemize
21608 \begin_inset Flex Code
21611 \begin_layout Plain Layout
21617 indicate the number of optional arguments (there can be 0–2).
21620 \begin_layout Itemize
21622 \begin_inset Flex Code
21625 \begin_layout Plain Layout
21631 indicates there is a starred version of the command (
21632 \begin_inset Flex Code
21635 \begin_layout Plain Layout
21645 \begin_inset Flex Code
21648 \begin_layout Plain Layout
21661 \begin_layout Standard
21662 By default, the starred version means: Output all authors even if it should
21664 \begin_inset Quotes eld
21668 \begin_inset Quotes erd
21672 \begin_inset Flex Code
21675 \begin_layout Plain Layout
21684 \begin_layout Standard
21685 If the star has a different meaning for a given command, it can be specified
21687 \begin_inset Flex Code
21690 \begin_layout Plain Layout
21691 <!_stardesc!_stardesctooltip>
21697 Maximal two translatable macro keywords, marked by the prefix
21698 \begin_inset Flex Code
21701 \begin_layout Plain Layout
21708 The first points to the string that replaces the
21709 \begin_inset Quotes eld
21713 \begin_inset Quotes erd
21716 checkbox label in the citation dialog, the second one to an optional tool
21717 tip for this checkbox.
21721 \begin_layout Standard
21722 Note that these two macros have to be defined in a
21723 \begin_inset Flex Code
21726 \begin_layout Plain Layout
21732 (see next section), dropping the
21733 \begin_inset Flex Code
21736 \begin_layout Plain Layout
21742 from the prefix, like this:
21745 \begin_layout LyX-Code
21746 _stardesc Sta&rred command label
21749 \begin_layout LyX-Code
21750 _stardesctooltip Tooltip for the starred command checkbox.
21754 \begin_layout Itemize
21756 \begin_inset Flex Code
21759 \begin_layout Plain Layout
21765 indicates that this command features
21766 \begin_inset Quotes eld
21769 qualified citation lists
21770 \begin_inset Quotes erd
21778 -specific feature for multi-reference citations where an individual pre-
21779 and postnote can be given to each reference in the list.
21780 Please refer to the
21784 manual for details.
21787 \begin_layout Subsection
21788 \begin_inset CommandInset label
21790 name "subsec:Citation-format-description"
21794 Cite format description
21797 \begin_layout Standard
21799 \begin_inset Flex Code
21802 \begin_layout Plain Layout
21808 blocks are used to describe how bibliographic information should be displayed,
21809 both within \SpecialChar LyX
21810 itself (in the citation dialog and in tooltips, for example)
21811 and in XHTML output.
21812 Such a block might look like this:
21815 \begin_layout LyX-Code
21819 \begin_layout LyX-Code
21823 \begin_layout LyX-Code
21827 \begin_layout LyX-Code
21831 \begin_layout Standard
21835 \begin_layout LyX-Code
21839 \begin_layout LyX-Code
21843 \begin_layout LyX-Code
21847 \begin_layout LyX-Code
21851 \begin_layout Standard
21852 In the first case, the individual lines define how the bibliographic information
21853 associated with an article or book, respectively, is to be displayed, and
21854 such a definition can be given for any
21855 \begin_inset Quotes els
21859 \begin_inset Quotes ers
21862 that might be present in a Bib\SpecialChar TeX
21865 defines a default format in the source code that will be used if no specific
21866 definition has been given.
21868 predefines several formats in the file
21869 \begin_inset Flex Code
21872 \begin_layout Plain Layout
21878 , which is included in most of \SpecialChar LyX
21879 's document classes.
21882 \begin_layout Standard
21883 In the second case, the lines define how a specific citation command (in
21885 \begin_inset Flex Code
21888 \begin_layout Plain Layout
21897 \begin_inset Flex Code
21900 \begin_layout Plain Layout
21908 ) is to be displayed on the citation inset label, in the citation dialog,
21909 menu or XHTML output.
21911 defines such formats for the citation style variants it supports via
21913 Document\SpecialChar menuseparator
21914 Setting\SpecialChar menuseparator
21915 Bibliography\SpecialChar ldots
21919 \begin_inset Flex Code
21922 \begin_layout Plain Layout
21928 files that are shipped with \SpecialChar LyX
21930 \begin_inset CommandInset ref
21932 reference "subsec:Cite-Engine-Files"
21942 \begin_layout Standard
21943 The definitions use a simple language that allows Bib\SpecialChar TeX
21944 keys to be replaced
21946 Keys should be enclosed in
21947 \begin_inset Flex Code
21950 \begin_layout Plain Layout
21957 \begin_inset Flex Code
21960 \begin_layout Plain Layout
21967 So a simple definition might look like this:
21970 \begin_layout LyX-Code
21972 \begin_inset Quotes eld
21976 \begin_inset Quotes erd
21982 \begin_layout Standard
21983 This would print the author, followed by a comma, followed by the title,
21984 in quotes, followed by a period.
21987 \begin_layout Standard
21988 Of course, sometimes you may want to print a key only if it exists.
21989 This can be done by using a conditional construction, such as:
21990 \begin_inset Flex Code
21993 \begin_layout Plain Layout
21995 \begin_inset space ~
22005 \begin_inset Flex Code
22008 \begin_layout Plain Layout
22014 key exists, then print
22015 \begin_inset Quotes eld
22019 \begin_inset space ~
22023 \begin_inset Quotes erd
22026 followed by the volume key.
22027 It is also possible to have an else clause in the conditional, such as:
22028 \begin_inset Newline newline
22032 \begin_inset Flex Code
22035 \begin_layout Plain Layout
22036 {%author%[[%author%]][[%editor%, ed.]]}
22042 \begin_inset Newline newline
22046 \begin_inset Flex Code
22049 \begin_layout Plain Layout
22055 key is printed if it exists; otherwise, the editor key is printed, followed
22057 \begin_inset Quotes eld
22061 \begin_inset space ~
22065 \begin_inset Quotes erd
22068 Note that the key is again enclosed in
22069 \begin_inset Flex Code
22072 \begin_layout Plain Layout
22078 signs; the entire conditional is enclosed in braces; and the if and else
22079 clauses are enclosed in double brackets,
22080 \begin_inset Quotes eld
22084 \begin_inset Flex Code
22087 \begin_layout Plain Layout
22094 \begin_inset Quotes eld
22098 \begin_inset Quotes eld
22102 \begin_inset Flex Code
22105 \begin_layout Plain Layout
22112 \begin_inset Quotes erd
22116 There must be no space between any of these.
22119 \begin_layout Standard
22120 Next to the entry keys, there are some special keys that can be used for
22121 these conditionals:
22124 \begin_layout Itemize
22125 \begin_inset Flex Code
22128 \begin_layout Plain Layout
22129 {%dialog%[[true]][[false]]}
22135 \begin_inset Quotes eld
22139 \begin_inset Quotes erd
22142 part for dialogs and menus, the
22143 \begin_inset Quotes eld
22147 \begin_inset Quotes erd
22150 part for other contexts (workarea, export)
22153 \begin_layout Itemize
22154 \begin_inset Flex Code
22157 \begin_layout Plain Layout
22158 {%export%[[true]][[false]]}
22164 \begin_inset Quotes eld
22168 \begin_inset Quotes erd
22171 part for export and menus, the
22172 \begin_inset Quotes eld
22176 \begin_inset Quotes erd
22179 part for other contexts (workarea, dialog)
22182 \begin_layout Itemize
22183 \begin_inset Flex Code
22186 \begin_layout Plain Layout
22193 \begin_inset Quotes eld
22197 \begin_inset Quotes erd
22200 part if another item follows (e.
22201 \begin_inset space \thinspace{}
22204 g., in a citation with multiple keys)
22207 \begin_layout Itemize
22208 \begin_inset Flex Code
22211 \begin_layout Plain Layout
22212 {%second%[[true]][[false]]}
22218 \begin_inset Quotes eld
22222 \begin_inset Quotes erd
22225 if this is the second of multiple items, else the
22226 \begin_inset Quotes eld
22230 \begin_inset Quotes erd
22236 \begin_layout Itemize
22237 \begin_inset Flex Code
22240 \begin_layout Plain Layout
22241 {%ifstar%[[true]][[false]]}
22247 \begin_inset Quotes eld
22251 \begin_inset Quotes erd
22254 part for starred citation commands (such as
22255 \begin_inset Flex Code
22258 \begin_layout Plain Layout
22266 ), the false part for unstarred
22269 \begin_layout Itemize
22270 \begin_inset Flex Code
22273 \begin_layout Plain Layout
22274 {%ifentrytype:<type>%[[true]][[false]]}
22280 \begin_inset Quotes eld
22284 \begin_inset Quotes erd
22287 if the current entry type matches
22288 \begin_inset Flex Code
22291 \begin_layout Plain Layout
22297 , else the false part (e.g., in a citation definition:
22298 \begin_inset Flex Code
22301 \begin_layout Plain Layout
22302 {%ifentrytype:book%[[this is a book]][[this is no book]]}
22310 \begin_layout Itemize
22311 \begin_inset Flex Code
22314 \begin_layout Plain Layout
22315 {%ifmultiple:<authortype>%[[true]][[false]]}
22321 \begin_inset Quotes eld
22325 \begin_inset Quotes erd
22328 if the current author type (author, editor etc.) has multiple authors, else
22329 the false part (e.g., in a bibliography definition:
22330 \begin_inset Flex Code
22333 \begin_layout Plain Layout
22334 {%ifmultiple:editor%[[eds.]][[ed.]]}
22342 \begin_layout Itemize
22343 \begin_inset Flex Code
22346 \begin_layout Plain Layout
22347 {%ifqualified%[[true]][[false]]}
22353 \begin_inset Quotes eld
22357 \begin_inset Quotes erd
22360 part if the current citation is a qualified citation list (a specific
22364 format for multi-reference citations), the false part if this is not the
22368 \begin_layout Standard
22370 \begin_inset Flex Code
22373 \begin_layout Plain Layout
22379 prints the author key as it is recorded in the bibliography file.
22380 This might not be what you want, since it will result in a string such
22382 \begin_inset Quotes eld
22385 Miller, Peter and Smith, Mary and White, Jane
22386 \begin_inset Quotes erd
22390 \begin_inset Quotes eld
22394 \begin_inset Quotes erd
22397 is used by Bib\SpecialChar TeX
22398 to delimit authors).
22400 therefore provides some methods to get properly formatted name lists (which
22401 will also get translated).
22402 The following keys are provided:
22405 \begin_layout Enumerate
22406 For name lists with pre- and surname, suitable for the main authors/editors
22407 of a bibliography item.
22409 \begin_inset Flex Code
22412 \begin_layout Plain Layout
22418 part denotes the kind of list that is requested (e.g.
22420 \begin_inset Flex Code
22423 \begin_layout Plain Layout
22433 \begin_layout Itemize
22434 \begin_inset Flex Code
22437 \begin_layout Plain Layout
22438 %abbrvnames:<nametype>%
22443 : Provides a name list which is abbreviated (with
22444 \begin_inset Quotes eld
22448 \begin_inset Quotes erd
22452 \begin_inset Flex Code
22455 \begin_layout Plain Layout
22464 \begin_layout Itemize
22465 \begin_inset Flex Code
22468 \begin_layout Plain Layout
22469 %fullnames:<nametype>%
22474 : Provides a full name list (never abbreviated with
22475 \begin_inset Quotes eld
22479 \begin_inset Quotes erd
22485 \begin_layout Itemize
22486 \begin_inset Flex Code
22489 \begin_layout Plain Layout
22490 %forceabbrvnames:<nametype>%
22495 : Provides a name list which is always abbreviated (with
22496 \begin_inset Quotes eld
22500 \begin_inset Quotes erd
22504 \begin_inset Flex Code
22507 \begin_layout Plain Layout
22517 \begin_layout Enumerate
22518 Alternative name lists with pre- and surname, if the order of pre- and surname
22519 inside the bibliography item differs (as in:
22520 \begin_inset Quotes eld
22523 Miller, John: Some text, in: Mary Smith, ed.: A volume
22524 \begin_inset Quotes erd
22531 \begin_layout Itemize
22532 \begin_inset Flex Code
22535 \begin_layout Plain Layout
22536 %abbrvbynames:<nametype>%
22541 : Provides a name list which is abbreviated (with
22542 \begin_inset Quotes eld
22546 \begin_inset Quotes erd
22550 \begin_inset Flex Code
22553 \begin_layout Plain Layout
22562 \begin_layout Itemize
22563 \begin_inset Flex Code
22566 \begin_layout Plain Layout
22567 %fullbynames:<nametype>%
22572 : Provides a full name list (never abbreviated with
22573 \begin_inset Quotes eld
22577 \begin_inset Quotes erd
22583 \begin_layout Itemize
22584 \begin_inset Flex Code
22587 \begin_layout Plain Layout
22588 %forceabbrvbynames:<nametype>%
22593 : Provides a name list which is always abbreviated (with
22594 \begin_inset Quotes eld
22598 \begin_inset Quotes erd
22602 \begin_inset Flex Code
22605 \begin_layout Plain Layout
22615 \begin_layout Enumerate
22616 And finally name lists which consist of family names only, as used in author-yea
22618 These do not take a
22619 \begin_inset Flex Code
22622 \begin_layout Plain Layout
22628 part, but always return either an author list or, if this does not exist,
22629 an editor list (as common in author-year labels):
22633 \begin_layout Itemize
22634 \begin_inset Flex Code
22637 \begin_layout Plain Layout
22643 : Provides a name list which is abbreviated (with
22644 \begin_inset Quotes eld
22648 \begin_inset Quotes erd
22652 \begin_inset Flex Code
22655 \begin_layout Plain Layout
22664 \begin_layout Itemize
22665 \begin_inset Flex Code
22668 \begin_layout Plain Layout
22674 : Provides a full name list (never abbreviated with
22675 \begin_inset Quotes eld
22679 \begin_inset Quotes erd
22685 \begin_layout Itemize
22686 \begin_inset Flex Code
22689 \begin_layout Plain Layout
22690 %forceabbrvciteauthor%
22695 : Provides a name list which is always abbreviated (with
22696 \begin_inset Quotes eld
22700 \begin_inset Quotes erd
22704 \begin_inset Flex Code
22707 \begin_layout Plain Layout
22717 \begin_layout Standard
22718 The order of pre- and surname in the former two lists can be adjusted by
22722 \begin_layout Itemize
22723 \begin_inset Flex Code
22726 \begin_layout Plain Layout
22727 !firstnameform %surname%, %prename%
22732 (first author in lists of type 1)
22735 \begin_layout Itemize
22736 \begin_inset Flex Code
22739 \begin_layout Plain Layout
22740 !othernameform %surname%, %prename%
22745 (other authors in lists of type 1)
22748 \begin_layout Itemize
22749 \begin_inset Flex Code
22752 \begin_layout Plain Layout
22753 !firstbynameform %prename% %surname%
22758 (first author in lists of type 2)
22761 \begin_layout Itemize
22762 \begin_inset Flex Code
22765 \begin_layout Plain Layout
22766 !otherbynameform %prename% %surname%
22771 (other authors in lists of type 2)
22774 \begin_layout Standard
22775 This allows you to configure namings like
22776 \begin_inset Quotes eld
22779 Miller, Peter and Mary Smith: \SpecialChar ldots
22780 , in: John Doe and Pat Green, eds.:\SpecialChar ldots
22782 \begin_inset Quotes erd
22788 \begin_layout Standard
22789 There is one other piece of syntax available in definitions, which looks
22791 \begin_inset Flex Code
22794 \begin_layout Plain Layout
22801 This defines a piece of formatting information that is to be used when
22803 \begin_inset Quotes eld
22807 \begin_inset Quotes erd
22811 Obviously, we do not want to output HTML tags when writing plain text,
22812 so they should be wrapped in
22813 \begin_inset Quotes eld
22817 \begin_inset Quotes erd
22821 \begin_inset Quotes eld
22825 \begin_inset Quotes erd
22831 \begin_layout Standard
22832 Two special sorts of definitions are also possible in a
22833 \begin_inset Flex Code
22836 \begin_layout Plain Layout
22843 An example of the first would be:
22846 \begin_layout LyX-Code
22848 \begin_inset Quotes eld
22852 \begin_inset Quotes erd
22858 \begin_layout Standard
22859 This is an abbreviation, or macro, and it can be used by treating it as
22861 \begin_inset Flex Code
22864 \begin_layout Plain Layout
22873 \begin_inset Flex Code
22876 \begin_layout Plain Layout
22882 exactly as it would treat its definition.
22883 So, let us issue the obvious
22891 \begin_layout LyX-Code
22895 \begin_layout Standard
22896 or anything like it.
22898 shouldn't go into an infinite loop, but it may go into a long one before
22902 \begin_layout Standard
22903 The second sort of special definition might look like this:
22906 \begin_layout LyX-Code
22910 \begin_layout Standard
22911 This defines a translatable piece of text, which allows relevant parts of
22912 the bibliography or citation to be translated.
22913 It can be included in a definition by treating it as a key:
22914 \begin_inset Flex Code
22917 \begin_layout Plain Layout
22924 Several of these are predefined in
22925 \begin_inset Flex Code
22928 \begin_layout Plain Layout
22935 \begin_inset Flex Code
22938 \begin_layout Plain Layout
22945 Note that these are not macros, in the sense just defined.
22946 They will not be expanded.
22949 \begin_layout Standard
22950 So here then is an example that use all these features:
22951 \begin_inset VSpace defskip
22957 \begin_layout Standard
22961 !authoredit {%author%[[%author%, ]][[{%editor%[[%editor%, %_edtext%, ]]}]]}
22964 \begin_layout Standard
22965 \begin_inset VSpace defskip
22968 This defines a macro that prints the author, followed by a comma, if the
22970 \begin_inset Flex Code
22973 \begin_layout Plain Layout
22979 key is defined, or else prints the name of the editor, followed by the
22981 \begin_inset Flex Code
22984 \begin_layout Plain Layout
22990 or its translation (it is by default
22991 \begin_inset Quotes eld
22995 \begin_inset Quotes erd
22999 \begin_inset Flex Code
23002 \begin_layout Plain Layout
23009 Note that this is in fact defined in
23010 \begin_inset Flex Code
23013 \begin_layout Plain Layout
23019 , so you can use it in your own definitions, or re-definitions, if you load
23023 \begin_layout Section
23024 \begin_inset CommandInset label
23026 name "sec:Tags-for-XHTML"
23030 Tags for XHTML output
23033 \begin_layout Standard
23034 As with \SpecialChar LaTeX
23035 or DocBook, the format of \SpecialChar LyX
23036 's XHTML output is also controlled by
23037 layout information.
23038 In general, \SpecialChar LyX
23039 provides sensible defaults and, as mentioned earlier, it will
23040 even construct default CSS style rules from the other layout tags.
23041 For example, \SpecialChar LyX
23042 will attempt to use the information provided in the
23043 \begin_inset Flex Code
23046 \begin_layout Plain Layout
23052 declaration for the Chapter style to write CSS that will appropriately
23053 format chapter headings.
23056 \begin_layout Standard
23057 In many cases, then, you may not have to do anything at all to get acceptable
23058 XHTML output for your own environments, custom insets, and so forth.
23059 But in some cases you will, and so \SpecialChar LyX
23060 provides a number of layout tags that
23061 can be used to customize the XHTML and CSS that are generated.
23064 \begin_layout Standard
23065 Note that there are two tags,
23066 \begin_inset Flex Code
23069 \begin_layout Plain Layout
23076 \begin_inset Flex Code
23079 \begin_layout Plain Layout
23085 that may appear outside style and inset declarations.
23087 \begin_inset CommandInset ref
23089 reference "subsec:General-text-class"
23093 for details on these.
23096 \begin_layout Subsection
23097 \begin_inset CommandInset label
23099 name "subsec:Paragraph-Style-XHTML"
23106 \begin_layout Standard
23107 The sort of XHTML \SpecialChar LyX
23108 outputs for a paragraph depends upon whether we are dealing
23109 with a normal paragraph, a command, or an environment, where this is itself
23110 determined by the contents of the corresponding
23111 \begin_inset Flex Code
23114 \begin_layout Plain Layout
23125 \begin_layout Standard
23126 For a command or normal paragraph, the output XHTML has the following form:
23129 \begin_layout LyX-Code
23133 \begin_inset Quotes erd
23137 \begin_inset Quotes erd
23143 \begin_layout LyX-Code
23147 \begin_inset Quotes erd
23151 \begin_inset Quotes erd
23157 \begin_layout LyX-Code
23160 Contents of the paragraph.
23163 \begin_layout LyX-Code
23169 \begin_layout Standard
23170 The label tags are of course omitted if the paragraph does not have a label.
23173 \begin_layout Standard
23174 For an environment that is not some sort of list, the XHTML takes this form:
23177 \begin_layout LyX-Code
23181 \begin_inset Quotes erd
23185 \begin_inset Quotes erd
23191 \begin_layout LyX-Code
23195 \begin_inset Quotes erd
23199 \begin_inset Quotes erd
23203 \begin_inset Quotes erd
23207 \begin_inset Quotes erd
23210 >Environment Label</labeltag>First paragraph.</itemtag>
23213 \begin_layout LyX-Code
23216 <itemtag>Second paragraph.</itemtag>
23219 \begin_layout LyX-Code
23225 \begin_layout Standard
23226 Note that the label is output only for the first paragraph, as it should
23227 be for a theorem, for example.
23231 \begin_layout Standard
23232 For a list, we have one of these forms:
23235 \begin_layout LyX-Code
23239 \begin_inset Quotes erd
23243 \begin_inset Quotes erd
23249 \begin_layout LyX-Code
23253 \begin_inset Quotes erd
23257 \begin_inset Quotes erd
23261 \begin_inset Quotes erd
23265 \begin_inset Quotes erd
23268 >List Label</labeltag>First item.</itemtag>
23271 \begin_layout LyX-Code
23275 \begin_inset Quotes erd
23279 \begin_inset Quotes erd
23283 \begin_inset Quotes erd
23287 \begin_inset Quotes erd
23290 >List Label</labeltag>Second item.</itemtag>
23293 \begin_layout LyX-Code
23299 \begin_layout LyX-Code
23303 \begin_layout LyX-Code
23307 \begin_inset Quotes erd
23311 \begin_inset Quotes erd
23317 \begin_layout LyX-Code
23321 \begin_inset Quotes erd
23325 \begin_inset Quotes erd
23328 >List Label</labeltag><itemtag attr=
23329 \begin_inset Quotes erd
23333 \begin_inset Quotes erd
23336 >First item.</itemtag>
23339 \begin_layout LyX-Code
23343 \begin_inset Quotes erd
23347 \begin_inset Quotes erd
23350 >List Label</labeltag><itemtag attr=
23351 \begin_inset Quotes erd
23355 \begin_inset Quotes erd
23358 >Second item.</itemtag>
23361 \begin_layout LyX-Code
23367 \begin_layout Standard
23368 Note the different orders of
23369 \begin_inset Flex Code
23372 \begin_layout Plain Layout
23379 \begin_inset Flex Code
23382 \begin_layout Plain Layout
23389 Which order we get depends upon the setting of
23390 \begin_inset Flex Code
23393 \begin_layout Plain Layout
23400 \begin_inset Flex Code
23403 \begin_layout Plain Layout
23409 is false (the default), you get the first of these, with the label within
23410 the item; if true, you get the second, with the label outside the item.
23413 \begin_layout Standard
23414 The specific tags and attributes output for each paragraph type can be controlle
23415 d by means of the layout tags we are about to describe.
23416 As mentioned earlier, however, \SpecialChar LyX
23417 uses sensible defaults for many of these,
23418 so you often may not need to do very much to get good XHTML output.
23419 Think of the available tags as there so you can tweak things to your liking.
23422 \begin_layout Description
23423 \begin_inset Flex Code
23426 \begin_layout Plain Layout
23433 \begin_inset Flex Code
23436 \begin_layout Plain Layout
23442 ] Specifies attribute information to be output with the main tag.
23444 \begin_inset Quotes eld
23448 \begin_inset Flex Code
23451 \begin_layout Plain Layout
23458 \begin_inset Quotes erd
23462 By default, \SpecialChar LyX
23464 \begin_inset Quotes eld
23468 \begin_inset Flex Code
23471 \begin_layout Plain Layout
23478 \begin_inset Quotes erd
23482 \begin_inset Flex Code
23485 \begin_layout Plain Layout
23491 is the \SpecialChar LyX
23492 name of the layout, made lowercase, for example: chapter.
23497 contain any style information.
23499 \begin_inset Flex Code
23502 \begin_layout Plain Layout
23511 \begin_layout Description
23512 \begin_inset Flex Code
23515 \begin_layout Plain Layout
23522 \begin_inset Flex Code
23525 \begin_layout Plain Layout
23535 ] Whether to output the default CSS information \SpecialChar LyX
23536 generates for this layout,
23537 even if additional information is explicitly provided via
23538 \begin_inset Flex Code
23541 \begin_layout Plain Layout
23549 \begin_inset Flex Code
23552 \begin_layout Plain Layout
23558 allows you to alter or augment the generated CSS, rather than to override
23561 \begin_inset Flex Code
23564 \begin_layout Plain Layout
23573 \begin_layout Description
23574 \begin_inset Flex Code
23577 \begin_layout Plain Layout
23584 \begin_inset Flex Code
23587 \begin_layout Plain Layout
23593 ] The tag to be used for individual paragraphs of environments, replacing
23595 \begin_inset Flex Code
23598 \begin_layout Plain Layout
23604 in the examples above.
23606 \begin_inset Flex Code
23609 \begin_layout Plain Layout
23618 \begin_layout Description
23619 \begin_inset Flex Code
23622 \begin_layout Plain Layout
23629 \begin_inset Flex Code
23632 \begin_layout Plain Layout
23638 ] Attributes for the item tag.
23640 \begin_inset Newline newline
23644 \begin_inset Quotes eld
23648 \begin_inset Flex Code
23651 \begin_layout Plain Layout
23652 class=`layoutname_item'
23658 \begin_inset Quotes erd
23666 contain any style information.
23668 \begin_inset Flex Code
23671 \begin_layout Plain Layout
23680 \begin_layout Description
23681 \begin_inset Flex Code
23684 \begin_layout Plain Layout
23691 \begin_inset Flex Code
23694 \begin_layout Plain Layout
23700 ] The tag to be used for paragraph and item labels, replacing
23701 \begin_inset Flex Code
23704 \begin_layout Plain Layout
23710 in the examples above.
23712 \begin_inset Flex Code
23715 \begin_layout Plain Layout
23722 \begin_inset Flex Code
23725 \begin_layout Plain Layout
23732 \begin_inset Flex Code
23735 \begin_layout Plain Layout
23742 \begin_inset Flex Code
23745 \begin_layout Plain Layout
23746 Centered_Top_Environment
23751 , in which case it defaults to
23752 \begin_inset Flex Code
23755 \begin_layout Plain Layout
23764 \begin_layout Description
23765 \begin_inset Flex Code
23768 \begin_layout Plain Layout
23775 \begin_inset Flex Code
23778 \begin_layout Plain Layout
23784 ] Attributes for the label tag.
23786 \begin_inset Newline newline
23790 \begin_inset Quotes eld
23794 \begin_inset Flex Code
23797 \begin_layout Plain Layout
23798 class=`layoutname_label'
23804 \begin_inset Quotes erd
23812 contain any style information.
23814 \begin_inset Flex Code
23817 \begin_layout Plain Layout
23826 \begin_layout Description
23827 \begin_inset Flex Code
23830 \begin_layout Plain Layout
23837 \begin_inset Flex Code
23840 \begin_layout Plain Layout
23850 ] Meaningful only for list-like environments, this tag controls whether
23851 the label tag is output before or inside the item tag.
23852 This is used, for example, in the description environment, where we want
23854 \begin_inset Flex Code
23857 \begin_layout Plain Layout
23858 <dt>\SpecialChar ldots
23859 </dt><dd>\SpecialChar ldots
23867 \begin_inset Flex Code
23870 \begin_layout Plain Layout
23876 : The label tag is output inside the item tag.
23879 \begin_layout Description
23880 \begin_inset Flex Code
23883 \begin_layout Plain Layout
23889 Information to be output in the
23890 \begin_inset Flex Code
23893 \begin_layout Plain Layout
23899 section when this style is used.
23900 This might, for example, be used to include a
23901 \begin_inset Flex Code
23904 \begin_layout Plain Layout
23911 \begin_inset Flex Code
23914 \begin_layout Plain Layout
23923 \begin_layout Description
23924 \begin_inset Flex Code
23927 \begin_layout Plain Layout
23933 CSS style information to be included when this style is used.
23934 Note that this will automatically be wrapped in a layout-generated
23935 \begin_inset Flex Code
23938 \begin_layout Plain Layout
23944 block, so only the CSS itself need be included.
23946 \begin_inset Flex Code
23949 \begin_layout Plain Layout
23958 \begin_layout Description
23959 \begin_inset Flex Code
23962 \begin_layout Plain Layout
23969 \begin_inset Flex Code
23972 \begin_layout Plain Layout
23978 ] The tag to be used for the main label, replacing
23979 \begin_inset Flex Code
23982 \begin_layout Plain Layout
23988 in the examples above.
23990 \begin_inset Flex Code
23993 \begin_layout Plain Layout
24002 \begin_layout Description
24003 \begin_inset Flex Code
24006 \begin_layout Plain Layout
24013 \begin_inset Flex Code
24016 \begin_layout Plain Layout
24026 ] Marks this style as the one to be used to generate the
24027 \begin_inset Flex Code
24030 \begin_layout Plain Layout
24036 tag for the XHTML file.
24037 By default, it is false.
24039 \begin_inset Flex Code
24042 \begin_layout Plain Layout
24048 file sets it to true for the
24049 \begin_inset Flex Code
24052 \begin_layout Plain Layout
24062 \begin_layout Subsection
24066 \begin_layout Standard
24067 The XHTML output of insets can also be controlled by information in layout
24072 \begin_layout Plain Layout
24073 At present, this is true only for
24074 \begin_inset Quotes eld
24078 \begin_inset Quotes erd
24081 insets (insets you can type into) and is not true for
24082 \begin_inset Quotes eld
24086 \begin_inset Quotes erd
24089 insets (insets that are associated with dialog boxes).
24094 Here, too, \SpecialChar LyX
24095 tries to provide sensible defaults, and it constructs default
24097 But everything can be customized.
24100 \begin_layout Standard
24101 The XHTML \SpecialChar LyX
24102 outputs for an inset has the following form:
24105 \begin_layout LyX-Code
24107 \begin_inset Quotes erd
24111 \begin_inset Quotes erd
24117 \begin_layout LyX-Code
24118 <labeltag>Label</labeltag>
24121 \begin_layout LyX-Code
24123 \begin_inset Quotes erd
24127 \begin_inset Quotes erd
24130 >Contents of the inset.</innertag>
24133 \begin_layout LyX-Code
24137 \begin_layout Standard
24138 If the inset permits multiple paragraphs—that is, if
24139 \begin_inset Flex Code
24142 \begin_layout Plain Layout
24148 is true—then the contents of the inset will itself be output as paragraphs
24149 formatted according to the styles used for those paragraphs (standard,
24150 quote, and the like).
24151 The label tag is of course omitted if the paragraph does not have a label
24152 and, at present, is always
24153 \begin_inset Flex Code
24156 \begin_layout Plain Layout
24163 The inner tag is optional and, by default, does not appear.
24166 \begin_layout Standard
24167 The specific tags and attributes output for each inset can be controlled
24168 by means of the following layout tags.
24171 \begin_layout Description
24172 \begin_inset Flex Code
24175 \begin_layout Plain Layout
24182 \begin_inset Flex Code
24185 \begin_layout Plain Layout
24191 ] Specifies attribute information to be output with the main tag.
24193 \begin_inset Quotes eld
24197 \begin_inset Flex Code
24200 \begin_layout Plain Layout
24201 class=`myinset' onclick=`\SpecialChar ldots
24208 \begin_inset Quotes erd
24212 By default, \SpecialChar LyX
24214 \begin_inset Quotes eld
24218 \begin_inset Flex Code
24221 \begin_layout Plain Layout
24228 \begin_inset Quotes erd
24232 \begin_inset Flex Code
24235 \begin_layout Plain Layout
24241 is the \SpecialChar LyX
24242 name of the inset, made lowercase and with non-alphanumeric characters
24243 converted to underscores, for example: footnote.
24246 \begin_layout Description
24247 \begin_inset Flex Code
24250 \begin_layout Plain Layout
24257 \begin_inset Flex Code
24260 \begin_layout Plain Layout
24270 ] Whether to output the default CSS information \SpecialChar LyX
24271 generates for this layout,
24272 even if additional information is explicitly provided via
24273 \begin_inset Flex Code
24276 \begin_layout Plain Layout
24284 \begin_inset Flex Code
24287 \begin_layout Plain Layout
24293 allows you to alter or augment the generated CSS, rather than to override
24298 \begin_layout Description
24299 \begin_inset Flex Code
24302 \begin_layout Plain Layout
24309 \begin_inset Flex Code
24312 \begin_layout Plain Layout
24318 ] Attributes for the inner tag.
24320 \begin_inset Newline newline
24324 \begin_inset Quotes eld
24328 \begin_inset Flex Code
24331 \begin_layout Plain Layout
24332 class=`insetname_inner'
24338 \begin_inset Quotes erd
24344 \begin_layout Description
24345 \begin_inset Flex Code
24348 \begin_layout Plain Layout
24355 \begin_inset Flex Code
24358 \begin_layout Plain Layout
24364 ] The inner tag, replacing
24365 \begin_inset Flex Code
24368 \begin_layout Plain Layout
24374 in the examples above.
24375 By default, there is none.
24378 \begin_layout Description
24379 \begin_inset Flex Code
24382 \begin_layout Plain Layout
24389 \begin_inset Flex Code
24392 \begin_layout Plain Layout
24400 ] Whether this inset represents a standalone block of text (such as a footnote)
24401 or instead represents material that is included in the surrounding text
24402 (such as a branch).
24406 \begin_layout Description
24407 \begin_inset Flex Code
24410 \begin_layout Plain Layout
24417 \begin_inset Flex Code
24420 \begin_layout Plain Layout
24426 ] A label for this inset, possibly including a reference to a counter.
24427 For example, for footnote, it might be:
24428 \begin_inset Flex Code
24431 \begin_layout Plain Layout
24440 This is optional, and there is no default.
24443 \begin_layout Description
24444 \begin_inset Flex Code
24447 \begin_layout Plain Layout
24453 Information to be output in the
24454 \begin_inset Flex Code
24457 \begin_layout Plain Layout
24463 section when this style is used.
24464 This might, for example, be used to include a
24465 \begin_inset Flex Code
24468 \begin_layout Plain Layout
24475 \begin_inset Flex Code
24478 \begin_layout Plain Layout
24487 \begin_layout Description
24488 \begin_inset Flex Code
24491 \begin_layout Plain Layout
24497 CSS style information to be included when this style is used.
24498 Note that this will automatically be wrapped in a layout-generated
24499 \begin_inset Flex Code
24502 \begin_layout Plain Layout
24508 block, so only the CSS itself need be included.
24511 \begin_layout Description
24512 \begin_inset Flex Code
24515 \begin_layout Plain Layout
24522 \begin_inset Flex Code
24525 \begin_layout Plain Layout
24531 ] The tag to be used for the main label, replacing
24532 \begin_inset Flex Code
24535 \begin_layout Plain Layout
24541 in the examples above.
24542 The default depends upon the setting of
24543 \begin_inset Flex Code
24546 \begin_layout Plain Layout
24553 \begin_inset Flex Code
24556 \begin_layout Plain Layout
24562 is true, the default is
24563 \begin_inset Flex Code
24566 \begin_layout Plain Layout
24572 ; if it is false, the default is
24573 \begin_inset Flex Code
24576 \begin_layout Plain Layout
24585 \begin_layout Subsection
24589 \begin_layout Standard
24590 The XHTML output for floats too can be controlled by layout information.
24591 The output has the following form:
24594 \begin_layout LyX-Code
24596 \begin_inset Quotes erd
24600 \begin_inset Quotes erd
24606 \begin_layout LyX-Code
24607 Contents of the float.
24610 \begin_layout LyX-Code
24614 \begin_layout Standard
24615 The caption, if there is one, is a separate inset and will be output as
24617 Its appearance can be controlled via the InsetLayout for caption insets.
24621 \begin_layout Description
24622 \begin_inset Flex Code
24625 \begin_layout Plain Layout
24632 \begin_inset Flex Code
24635 \begin_layout Plain Layout
24641 ] Specifies attribute information to be output with the main tag.
24643 \begin_inset Quotes eld
24647 \begin_inset Flex Code
24650 \begin_layout Plain Layout
24651 class=`myfloat' onclick=`\SpecialChar ldots
24658 \begin_inset Quotes erd
24662 By default, \SpecialChar LyX
24664 \begin_inset Quotes eld
24668 \begin_inset Flex Code
24671 \begin_layout Plain Layout
24672 class=`float float-floattype'
24678 \begin_inset Quotes erd
24682 \begin_inset Flex Code
24685 \begin_layout Plain Layout
24691 is \SpecialChar LyX
24692 's name for this type of float, as determined by the float declaration
24694 \begin_inset CommandInset ref
24696 reference "subsec:Floats"
24700 ), though made lowercase and with non-alphanumeric characters converted
24701 to underscores, for example: float-table.
24704 \begin_layout Description
24705 \begin_inset Flex Code
24708 \begin_layout Plain Layout
24714 CSS style information to be included when this float is used.
24715 Note that this will automatically be wrapped in a layout-generated
24716 \begin_inset Flex Code
24719 \begin_layout Plain Layout
24725 block, so only the CSS itself need be included.
24728 \begin_layout Description
24729 \begin_inset Flex Code
24732 \begin_layout Plain Layout
24739 \begin_inset Flex Code
24742 \begin_layout Plain Layout
24748 ] The tag to be used for this float, replacing
24749 \begin_inset Quotes eld
24753 \begin_inset Flex Code
24756 \begin_layout Plain Layout
24763 \begin_inset Quotes erd
24766 in the example above.
24768 \begin_inset Flex Code
24771 \begin_layout Plain Layout
24777 and will rarely need changing.
24780 \begin_layout Subsection
24781 Bibliography formatting
24784 \begin_layout Standard
24785 The bibliography can be formatted using
24786 \begin_inset Flex Code
24789 \begin_layout Plain Layout
24797 \begin_inset CommandInset ref
24799 reference "subsec:Citation-format-description"
24806 \begin_layout Subsection
24811 \begin_layout Standard
24812 We have several times mentioned that \SpecialChar LyX
24813 will generate default CSS style rules
24814 for both insets and paragraph styles, based upon the other layout information
24816 In this section, we shall say a word about which layout information \SpecialChar LyX
24821 \begin_layout Standard
24822 At present, \SpecialChar LyX
24823 auto-generates CSS only for font information, making use of
24825 \begin_inset Flex Code
24828 \begin_layout Plain Layout
24835 \begin_inset Flex Code
24838 \begin_layout Plain Layout
24845 \begin_inset Flex Code
24848 \begin_layout Plain Layout
24855 \begin_inset Flex Code
24858 \begin_layout Plain Layout
24865 \begin_inset Flex Code
24868 \begin_layout Plain Layout
24875 \begin_inset CommandInset ref
24877 reference "subsec:Font-description"
24882 The translation is mostly straightforward and obvious.
24884 \begin_inset Quotes eld
24888 \begin_inset Flex Code
24891 \begin_layout Plain Layout
24898 \begin_inset Quotes erd
24902 \begin_inset Quotes eld
24906 \begin_inset Flex Code
24909 \begin_layout Plain Layout
24910 font-family: sans-serif;
24916 \begin_inset Quotes erd
24920 The correspondence of \SpecialChar LyX
24921 sizes and CSS sizes is a little less obvious but
24922 nonetheless intuitive.
24924 \begin_inset Flex Code
24927 \begin_layout Plain Layout
24934 \begin_inset Flex URL
24937 \begin_layout Plain Layout
24947 \begin_layout Chapter
24948 Including External Material
24949 \begin_inset CommandInset label
24951 name "chap:Including-External-Material"
24958 \begin_layout Standard
24959 \begin_inset Box Shadowbox
24969 height_special "totalheight"
24974 backgroundcolor "none"
24977 \begin_layout Plain Layout
24978 WARNING: This portion of the documentation has not been updated for some
24980 We certainly hope that it is still accurate, but there are no guarantees.
24988 \begin_layout Standard
24989 The use of material from sources external to \SpecialChar LyX
24990 is covered in detail in the
24996 This part of the manual covers what needs to happen behind the scenes for
24997 new sorts of material to be included.
25000 \begin_layout Section
25004 \begin_layout Standard
25005 The external material feature is based on the concept of a
25010 A template is a specification of how \SpecialChar LyX
25011 should interface with a certain kind
25013 As bundled, \SpecialChar LyX
25014 comes with predefined templates for Xfig figures, various
25015 raster format images, chess diagrams, and LilyPond music notation.
25016 You can check the actual list by using the menu
25017 \begin_inset Flex Noun
25020 \begin_layout Plain Layout
25021 Insert\SpecialChar menuseparator
25022 File\SpecialChar menuseparator
25029 Furthermore, it is possible to roll your own template to support a specific
25031 Later we'll describe in more detail what is involved, and hopefully you
25032 will submit all the templates you create so we can include them in a later
25037 \begin_layout Standard
25038 Another basic idea of the external material feature is to distinguish between
25039 the original file that serves as a base for final material and the produced
25040 file that is included in your exported or printed document.
25041 For example, consider the case of a figure produced with
25042 \begin_inset Flex Code
25045 \begin_layout Plain Layout
25052 The Xfig application itself works on an original file with the
25053 \begin_inset Flex Code
25056 \begin_layout Plain Layout
25063 Within Xfig, you create and change your figure, and when you are done,
25065 \begin_inset Flex Code
25068 \begin_layout Plain Layout
25075 When you want to include the figure in your document, you invoke
25076 \begin_inset Flex Code
25079 \begin_layout Plain Layout
25085 in order to create a PostScript file that can readily be included in your
25089 \begin_inset Flex Code
25092 \begin_layout Plain Layout
25098 file is the original file, and the PostScript file is the produced file.
25101 \begin_layout Standard
25102 This distinction is important in order to allow updating of the material
25103 while you are in the process of writing the document.
25104 Furthermore, it provides us with the flexibility that is needed to support
25105 multiple export formats.
25106 For instance, in the case of a plain text file, it is not exactly an award-winn
25107 ing idea to include the figure as raw PostScript.
25108 Instead, you would either prefer to just include a reference to the figure
25109 or try to invoke some graphics to ASCII converter to make the final result
25110 look similar to the real graphics.
25111 The external material management allows you to do this, because it is parametri
25112 zed on the different export formats that \SpecialChar LyX
25116 \begin_layout Standard
25117 Besides supporting the production of different products according to the
25118 exported format, it supports tight integration with editing and viewing
25120 In the case of an Xfig figure, you are able to invoke Xfig on the original
25121 file with a single click from within the external material dialog in \SpecialChar LyX
25123 and also preview the produced PostScript file with Ghostview with another
25125 No more fiddling around with the command line and/or file browsers to locate
25126 and manipulate the original or produced files.
25127 In this way, you are finally able to take full advantage of the many different
25128 applications that are relevant to use when you write your documents, and
25129 ultimately be more productive.
25132 \begin_layout Section
25133 The external template configuration files
25136 \begin_layout Standard
25137 It is relatively easy to add custom external template definitions to \SpecialChar LyX
25139 However, be aware that doing this in an careless manner most probably
25143 introduce an easily exploitable security hole.
25144 So before you do this, please read the discussion about security in
25145 \begin_inset CommandInset ref
25147 reference "sec:Security-discussion"
25154 \begin_layout Standard
25155 Having said that, we encourage you to submit any interesting templates that
25160 \begin_layout Standard
25161 The external templates are defined in the
25162 \begin_inset Flex Code
25165 \begin_layout Plain Layout
25171 files that are stored in the
25172 \begin_inset Flex Code
25175 \begin_layout Plain Layout
25176 LyXDir/lib/xtemplates/
25182 Each template is defined in a file of its own.
25183 You can place your own templates in
25184 \begin_inset Flex Code
25187 \begin_layout Plain Layout
25188 UserDir/xtemplates/
25193 or copy existing templates to that directory in order to modify them.
25196 \begin_layout Standard
25197 A typical template looks like this:
25200 \begin_layout LyX-Code
25204 \begin_layout LyX-Code
25205 GuiName "XFig: $$AbsOrRelPathParent$$Basename"
25208 \begin_layout LyX-Code
25212 \begin_layout LyX-Code
25216 \begin_layout LyX-Code
25220 \begin_layout LyX-Code
25224 \begin_layout LyX-Code
25228 \begin_layout LyX-Code
25229 AutomaticProduction true
25232 \begin_layout LyX-Code
25236 \begin_layout LyX-Code
25240 \begin_layout LyX-Code
25244 \begin_layout LyX-Code
25245 TransformCommand Rotate RotationLatexCommand
25248 \begin_layout LyX-Code
25249 TransformCommand Resize ResizeLatexCommand
25252 \begin_layout LyX-Code
25253 Product "$$RotateFront$$ResizeFront
25256 \begin_layout LyX-Code
25261 input{$$AbsOrRelPathMaster$$Basename.pstex_t}
25264 \begin_layout LyX-Code
25265 $$ResizeBack$$RotateBack"
25268 \begin_layout LyX-Code
25272 \begin_layout LyX-Code
25273 UpdateResult "$$AbsPath$$Basename.pstex_t"
25276 \begin_layout LyX-Code
25277 Requirement "graphicx"
25280 \begin_layout LyX-Code
25281 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
25284 \begin_layout LyX-Code
25285 ReferencedFile latex "$$AbsPath$$Basename.eps"
25288 \begin_layout LyX-Code
25289 ReferencedFile dvi "$$AbsPath$$Basename.eps"
25292 \begin_layout LyX-Code
25296 \begin_layout LyX-Code
25300 \begin_layout LyX-Code
25301 TransformCommand Rotate RotationLatexCommand
25304 \begin_layout LyX-Code
25305 TransformCommand Resize ResizeLatexCommand
25308 \begin_layout LyX-Code
25309 Product "$$RotateFront$$ResizeFront
25312 \begin_layout LyX-Code
25317 input{$$AbsOrRelPathMaster$$Basename.pdftex_t}
25320 \begin_layout LyX-Code
25321 $$ResizeBack$$RotateBack"
25324 \begin_layout LyX-Code
25325 UpdateFormat pdftex
25328 \begin_layout LyX-Code
25329 UpdateResult "$$AbsPath$$Basename.pdftex_t"
25332 \begin_layout LyX-Code
25333 Requirement "graphicx"
25336 \begin_layout LyX-Code
25337 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pdftex_t"
25340 \begin_layout LyX-Code
25341 ReferencedFile latex "$$AbsPath$$Basename.pdf"
25344 \begin_layout LyX-Code
25348 \begin_layout LyX-Code
25352 \begin_layout LyX-Code
25353 Product "[XFig: $$FName]"
25356 \begin_layout LyX-Code
25360 \begin_layout LyX-Code
25364 \begin_layout LyX-Code
25365 Product "<graphic fileref=
25367 "$$AbsOrRelPathMaster$$Basename.eps
25372 \begin_layout LyX-Code
25376 \begin_layout LyX-Code
25380 \begin_layout LyX-Code
25381 UpdateResult "$$AbsPath$$Basename.eps"
25384 \begin_layout LyX-Code
25385 ReferencedFile docbook "$$AbsPath$$Basename.eps"
25388 \begin_layout LyX-Code
25389 ReferencedFile docbook-xml "$$AbsPath$$Basename.eps"
25392 \begin_layout LyX-Code
25396 \begin_layout LyX-Code
25400 \begin_layout Standard
25401 As you can see, the template is enclosed in
25402 \begin_inset Flex Code
25405 \begin_layout Plain Layout
25413 \begin_inset Flex Code
25416 \begin_layout Plain Layout
25423 It contains a header specifying some general settings and, for each supported
25424 primary document file format, a section
25425 \begin_inset Flex Code
25428 \begin_layout Plain Layout
25436 \begin_inset Flex Code
25439 \begin_layout Plain Layout
25448 \begin_layout Subsection
25449 The template header
25452 \begin_layout Description
25453 \begin_inset Flex Code
25456 \begin_layout Plain Layout
25457 AutomaticProduction
25458 \begin_inset space ~
25466 Whether the file represented by the template must be generated by \SpecialChar LyX
25468 This command must occur exactly once.
25471 \begin_layout Description
25472 \begin_inset Flex Code
25475 \begin_layout Plain Layout
25477 \begin_inset space ~
25485 A glob pattern that is used in the file dialog to filter out the desired
25487 If there is more than one possible file extension (e.
25488 \begin_inset space \thinspace{}
25492 \begin_inset space \space{}
25496 \begin_inset Flex Code
25499 \begin_layout Plain Layout
25506 \begin_inset Flex Code
25509 \begin_layout Plain Layout
25515 ), use something like
25516 \begin_inset Flex Code
25519 \begin_layout Plain Layout
25526 This command must occur exactly once.
25529 \begin_layout Description
25530 \begin_inset Flex Code
25533 \begin_layout Plain Layout
25535 \begin_inset space ~
25543 The text that is displayed on the button.
25544 This command must occur exactly once.
25547 \begin_layout Description
25548 \begin_inset Flex Code
25551 \begin_layout Plain Layout
25553 \begin_inset space ~
25557 \begin_inset space ~
25565 The help text that is used in the External dialog.
25566 Provide enough information to explain to the user just what the template
25567 can provide him with.
25568 This command must occur exactly once.
25571 \begin_layout Description
25572 \begin_inset Flex Code
25575 \begin_layout Plain Layout
25577 \begin_inset space ~
25585 The file format of the original file.
25586 This must be the name of a format that is known to \SpecialChar LyX
25588 \begin_inset CommandInset ref
25590 reference "sec:Formats"
25596 \begin_inset Quotes eld
25600 \begin_inset Flex Code
25603 \begin_layout Plain Layout
25610 \begin_inset Quotes erd
25613 if the template can handle original files of more than one format.
25615 will attempt to interrogate the file itself in order to deduce its format
25617 This command must occur exactly once.
25620 \begin_layout Description
25621 \begin_inset Flex Code
25624 \begin_layout Plain Layout
25626 \begin_inset space ~
25634 A unique name for the template.
25635 It must not contain substitution macros (see below).
25638 \begin_layout Description
25639 \begin_inset Flex Code
25642 \begin_layout Plain Layout
25644 \begin_inset space ~
25647 Rotate|Resize|Clip|Extra
25652 This command specifies which transformations are supported by this template.
25653 It may occur zero or more times.
25654 This command enables the corresponding tabs in the external dialog.
25656 \begin_inset Flex Code
25659 \begin_layout Plain Layout
25665 command must have either a corresponding
25666 \begin_inset Flex Code
25669 \begin_layout Plain Layout
25676 \begin_inset Flex Code
25679 \begin_layout Plain Layout
25686 \begin_inset Flex Code
25689 \begin_layout Plain Layout
25696 Otherwise the transformation will not be supported by that format.
25699 \begin_layout Subsection
25703 \begin_layout Description
25704 \begin_inset Flex Code
25707 \begin_layout Plain Layout
25709 \begin_inset space ~
25712 LaTeX|PDFLaTeX|PlainText|DocBook|XHTML
25717 The primary document file format that this format definition is for.
25718 Not every template has a sensible representation in all document file formats.
25719 Please define nevertheless a
25720 \begin_inset Flex Code
25723 \begin_layout Plain Layout
25729 section for all templates.
25730 Use a dummy text when no representation is available.
25731 Then you can at least see a reference to the external material in the exported
25735 \begin_layout Description
25736 \begin_inset Flex Code
25739 \begin_layout Plain Layout
25741 \begin_inset space ~
25745 \begin_inset space ~
25753 This command defines an additional macro
25754 \begin_inset Flex Code
25757 \begin_layout Plain Layout
25763 for substitution in
25764 \begin_inset Flex Code
25767 \begin_layout Plain Layout
25775 \begin_inset Flex Code
25778 \begin_layout Plain Layout
25784 itself may contain substitution macros.
25785 The advantage over using
25786 \begin_inset Flex Code
25789 \begin_layout Plain Layout
25796 \begin_inset Flex Code
25799 \begin_layout Plain Layout
25805 is that the substituted value of
25806 \begin_inset Flex Code
25809 \begin_layout Plain Layout
25815 is sanitized so that it is a valid optional argument in the document format.
25816 This command may occur zero or more times.
25819 \begin_layout Description
25820 \begin_inset Flex Code
25823 \begin_layout Plain Layout
25825 \begin_inset space ~
25833 The text that is inserted in the exported document.
25834 This is actually the most important command and can be quite complex.
25835 This command must occur exactly once.
25838 \begin_layout Description
25839 \begin_inset Flex Code
25842 \begin_layout Plain Layout
25844 \begin_inset space ~
25852 This command specifies a preamble snippet that will be included in the
25855 It has to be defined using
25856 \begin_inset Flex Code
25859 \begin_layout Plain Layout
25867 \begin_inset Flex Code
25870 \begin_layout Plain Layout
25877 This command may occur zero or more times.
25880 \begin_layout Description
25881 \begin_inset Flex Code
25884 \begin_layout Plain Layout
25886 \begin_inset space ~
25890 \begin_inset space ~
25898 This command denotes files that are created by the conversion process and
25899 are needed for a particular export format.
25900 If the filename is relative, it is interpreted relative to the master document.
25901 This command may be given zero or more times.
25904 \begin_layout Description
25905 \begin_inset Flex Code
25908 \begin_layout Plain Layout
25910 \begin_inset space ~
25918 The name of a required \SpecialChar LaTeX
25920 The package is included via
25921 \begin_inset Flex Code
25924 \begin_layout Plain Layout
25932 in the \SpecialChar LaTeX
25934 This command may occur zero or more times.
25937 \begin_layout Description
25938 \begin_inset Flex Code
25941 \begin_layout Plain Layout
25943 \begin_inset space ~
25947 \begin_inset space ~
25950 RotationLatexCommand
25955 This command specifies that the built in \SpecialChar LaTeX
25956 command should be used for rotation.
25957 This command may occur once or not at all.
25960 \begin_layout Description
25961 \begin_inset Flex Code
25964 \begin_layout Plain Layout
25966 \begin_inset space ~
25970 \begin_inset space ~
25978 This command specifies that the built in \SpecialChar LaTeX
25979 command should be used for resizing.
25980 This command may occur once or not at all.
25983 \begin_layout Description
25984 \begin_inset Flex Code
25987 \begin_layout Plain Layout
25989 \begin_inset space ~
25993 \begin_inset space ~
25996 RotationLatexOption
26001 This command specifies that rotation is done via an optional argument.
26002 This command may occur once or not at all.
26005 \begin_layout Description
26006 \begin_inset Flex Code
26009 \begin_layout Plain Layout
26011 \begin_inset space ~
26015 \begin_inset space ~
26023 This command specifies that resizing is done via an optional argument.
26024 This command may occur once or not at all.
26027 \begin_layout Description
26028 \begin_inset Flex Code
26031 \begin_layout Plain Layout
26033 \begin_inset space ~
26037 \begin_inset space ~
26045 This command specifies that clipping is done via an optional argument.
26046 This command may occur once or not at all.
26049 \begin_layout Description
26050 \begin_inset Flex Code
26053 \begin_layout Plain Layout
26055 \begin_inset space ~
26059 \begin_inset space ~
26067 This command specifies that an extra optional argument is used.
26068 This command may occur once or not at all.
26071 \begin_layout Description
26072 \begin_inset Flex Code
26075 \begin_layout Plain Layout
26077 \begin_inset space ~
26085 The file format of the converted file.
26086 This must be the name of a format that is known to \SpecialChar LyX
26088 \begin_inset Flex Noun
26091 \begin_layout Plain Layout
26092 Tools\SpecialChar menuseparator
26093 Preferences\SpecialChar menuseparator
26094 File Handling\SpecialChar menuseparator
26101 This command must occur exactly once.
26102 If the resulting file format is PDF, you need to specify the format
26103 \begin_inset Flex Code
26106 \begin_layout Plain Layout
26113 This is the PDF format used for including graphics.
26114 The other defined PDF formats are for document export.
26117 \begin_layout Description
26118 \begin_inset Flex Code
26121 \begin_layout Plain Layout
26123 \begin_inset space ~
26131 The file name of the converted file.
26132 The file name must be absolute.
26133 This command must occur exactly once.
26136 \begin_layout Subsection
26137 Preamble definitions
26140 \begin_layout Standard
26141 The external template configuration file may contain additional preamble
26142 definitions enclosed by
26143 \begin_inset Flex Code
26146 \begin_layout Plain Layout
26154 \begin_inset Flex Code
26157 \begin_layout Plain Layout
26164 They can be used by the templates in the
26165 \begin_inset Flex Code
26168 \begin_layout Plain Layout
26177 \begin_layout Section
26178 The substitution mechanism
26181 \begin_layout Standard
26182 When the external material facility invokes an external program, it is done
26183 on the basis of a command defined in the template configuration file.
26184 These commands can contain various macros that are expanded before execution.
26185 Execution always take place in the directory of the containing document.
26188 \begin_layout Standard
26189 Also, whenever external material is to be displayed, the name will be produced
26190 by the substitution mechanism, and most other commands in the template
26191 definition support substitution as well.
26194 \begin_layout Standard
26195 The available macros are the following:
26198 \begin_layout Description
26199 \begin_inset Flex Code
26202 \begin_layout Plain Layout
26203 $$AbsOrRelPathMaster
26208 The file path, absolute or relative to the master \SpecialChar LyX
26212 \begin_layout Description
26213 \begin_inset Flex Code
26216 \begin_layout Plain Layout
26217 $$AbsOrRelPathParent
26222 The file path, absolute or relative to the \SpecialChar LyX
26226 \begin_layout Description
26227 \begin_inset Flex Code
26230 \begin_layout Plain Layout
26236 The absolute file path.
26239 \begin_layout Description
26240 \begin_inset Flex Code
26243 \begin_layout Plain Layout
26249 The filename without path and without the extension.
26252 \begin_layout Description
26253 \begin_inset Flex Code
26256 \begin_layout Plain Layout
26258 \begin_inset Quotes eld
26262 \begin_inset Quotes erd
26270 This macro will expand to the contents of the file with the name
26271 \begin_inset Flex Code
26274 \begin_layout Plain Layout
26283 \begin_layout Description
26284 \begin_inset Flex Code
26287 \begin_layout Plain Layout
26293 The file extension (including the dot).
26296 \begin_layout Description
26297 \begin_inset Flex Code
26300 \begin_layout Plain Layout
26306 This will be the string
26307 \begin_inset Quotes eld
26311 \begin_inset Quotes erd
26314 if the file is in JPEG format, otherwise it will be the string
26315 \begin_inset Quotes eld
26319 \begin_inset Quotes erd
26323 This is useful to avoid uneeded conversions for output formats that support
26324 both PNG and JPEG fomats.
26325 The predefined RasterImage template uses this macro for the pdf\SpecialChar TeX
26330 \begin_layout Description
26331 \begin_inset Flex Code
26334 \begin_layout Plain Layout
26340 The filename of the file specified in the external material dialog.
26341 This is either an absolute name, or it is relative to the \SpecialChar LyX
26345 \begin_layout Description
26346 \begin_inset Flex Code
26349 \begin_layout Plain Layout
26356 \begin_inset Flex Code
26359 \begin_layout Plain Layout
26365 (absolute name or relative to the \SpecialChar LyX
26369 \begin_layout Description
26370 \begin_inset Flex Code
26373 \begin_layout Plain Layout
26379 The file path, relative to the master \SpecialChar LyX
26383 \begin_layout Description
26384 \begin_inset Flex Code
26387 \begin_layout Plain Layout
26393 The file path, relative to the \SpecialChar LyX
26397 \begin_layout Description
26398 \begin_inset Flex Code
26401 \begin_layout Plain Layout
26407 This macro will expand to the absolute path of the system directory.
26408 This is typically used to point to the various helper scripts that are
26409 bundled with \SpecialChar LyX
26413 \begin_layout Description
26414 \begin_inset Flex Code
26417 \begin_layout Plain Layout
26423 A name and full path to a temporary file which will be automatically deleted
26424 whenever the containing document is closed, or the external material insertion
26428 \begin_layout Standard
26429 All path macros contain a trailing directory separator, so you can construct
26431 \begin_inset space \thinspace{}
26435 \begin_inset space \space{}
26438 the absolute filename with
26439 \begin_inset Flex Code
26442 \begin_layout Plain Layout
26443 $$AbsPath$$Basename$$Extension
26451 \begin_layout Standard
26452 The macros above are substituted in all commands unless otherwise noted.
26454 \begin_inset Flex Code
26457 \begin_layout Plain Layout
26463 supports additionally the following substitutions if they are enabled by
26465 \begin_inset Flex Code
26468 \begin_layout Plain Layout
26475 \begin_inset Flex Code
26478 \begin_layout Plain Layout
26487 \begin_layout Description
26488 \begin_inset Flex Code
26491 \begin_layout Plain Layout
26497 The front part of the resize command.
26500 \begin_layout Description
26501 \begin_inset Flex Code
26504 \begin_layout Plain Layout
26510 The back part of the resize command.
26513 \begin_layout Description
26514 \begin_inset Flex Code
26517 \begin_layout Plain Layout
26523 The front part of the rotation command.
26526 \begin_layout Description
26527 \begin_inset Flex Code
26530 \begin_layout Plain Layout
26536 The back part of the rotation command.
26539 \begin_layout Standard
26540 The value string of the
26541 \begin_inset Flex Code
26544 \begin_layout Plain Layout
26550 command supports additionally the following substitutions if they are enabled
26552 \begin_inset Flex Code
26555 \begin_layout Plain Layout
26562 \begin_inset Flex Code
26565 \begin_layout Plain Layout
26574 \begin_layout Description
26575 \begin_inset Flex Code
26578 \begin_layout Plain Layout
26587 \begin_layout Description
26588 \begin_inset Flex Code
26591 \begin_layout Plain Layout
26600 \begin_layout Description
26601 \begin_inset Flex Code
26604 \begin_layout Plain Layout
26613 \begin_layout Description
26614 \begin_inset Flex Code
26617 \begin_layout Plain Layout
26623 The rotation option.
26626 \begin_layout Standard
26627 You may ask why there are so many path macros.
26628 There are mainly two reasons:
26631 \begin_layout Enumerate
26632 Relative and absolute file names should remain relative or absolute, respectivel
26634 Users may have reasons to prefer either form.
26635 Relative names are useful for portable documents that should work on different
26636 machines, for example.
26637 Absolute names may be required by some programs.
26640 \begin_layout Enumerate
26642 treats relative file names differently than \SpecialChar LyX
26643 and other programs in nested
26645 For \SpecialChar LyX
26646 , a relative file name is always relative to the document that contains
26648 For \SpecialChar LaTeX
26649 , it is always relative to the master document.
26650 These two definitions are identical if you have only one document, but
26651 differ if you have a master document that includes part documents.
26652 That means that relative filenames must be transformed when presented to
26655 Fortunately \SpecialChar LyX
26656 does this automatically for you if you choose the right macros.
26659 \begin_layout Standard
26660 So which path macro should be used in new template definitions? The rule
26664 \begin_layout Itemize
26666 \begin_inset Flex Code
26669 \begin_layout Plain Layout
26675 if an absolute path is required.
26678 \begin_layout Itemize
26680 \begin_inset Flex Code
26683 \begin_layout Plain Layout
26684 $$AbsOrRelPathMaster
26689 if the substituted string is some kind of \SpecialChar LaTeX
26693 \begin_layout Itemize
26695 \begin_inset Flex Code
26698 \begin_layout Plain Layout
26699 $$AbsOrRelPathParent
26704 in order to preserve the user's choice.
26707 \begin_layout Standard
26708 There are special cases where this rule does not work and e.
26709 \begin_inset space \thinspace{}
26713 \begin_inset space \space{}
26716 relative names are needed, but normally it will work just fine.
26717 One example for such a case is the command
26718 \begin_inset Flex Code
26721 \begin_layout Plain Layout
26722 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
26727 in the XFig template above: We can't use the absolute name because the
26729 \begin_inset Flex Code
26732 \begin_layout Plain Layout
26738 files needs the relative name in order to rewrite the file content.
26741 \begin_layout Section
26742 Security discussion
26743 \begin_inset CommandInset label
26745 name "sec:Security-discussion"
26752 \begin_layout Standard
26753 The external material feature interfaces with a lot of external programs
26754 and does so automatically, so we have to consider the security implications
26756 In particular, since you have the option of including your own filenames
26757 and/or parameter strings and those are expanded into a command, it seems
26758 that it would be possible to create a malicious document which executes
26759 arbitrary commands when a user views or prints the document.
26760 This is something we definitely want to avoid.
26763 \begin_layout Standard
26764 However, since the external program commands are specified in the template
26765 configuration file only, there are no security issues if \SpecialChar LyX
26766 is properly configure
26767 d with safe templates only.
26768 This is so because the external programs are invoked with the
26769 \begin_inset Flex Code
26772 \begin_layout Plain Layout
26778 -system call rather than the
26779 \begin_inset Flex Code
26782 \begin_layout Plain Layout
26788 system-call, so it's not possible to execute arbitrary commands from the
26789 filename or parameter section via the shell.
26792 \begin_layout Standard
26793 This also implies that you are restricted in what command strings you can
26794 use in the external material templates.
26795 In particular, pipes and redirection are not readily available.
26796 This has to be so if \SpecialChar LyX
26797 should remain safe.
26798 If you want to use some of the shell features, you should write a safe
26799 script to do this in a controlled manner, and then invoke the script from
26800 the command string.
26804 \begin_layout Standard
26805 It is possible to design a template that interacts directly with the shell,
26806 but since this would allow a malicious user to execute arbitrary commands
26807 by writing clever filenames and/or parameters, we generally recommend that
26808 you only use safe scripts that work with the
26809 \begin_inset Flex Code
26812 \begin_layout Plain Layout
26818 system call in a controlled manner.
26819 Of course, for use in a controlled environment, it can be tempting to just
26820 fall back to use ordinary shell scripts.
26821 If you do so, be aware that you
26825 provide an easily exploitable security hole in your system.
26826 Of course it stands to reason that such unsafe templates will never be
26827 included in the standard \SpecialChar LyX
26828 distribution, although we do encourage people
26829 to submit new templates in the open source tradition.
26830 But \SpecialChar LyX
26831 as shipped from the official distribution channels will never have
26835 \begin_layout Standard
26836 Including external material provides a lot of power, and you have to be
26837 careful not to introduce security hazards with this power.
26838 A subtle error in a single line in an innocent looking script can open
26839 the door to huge security problems.
26840 So if you do not fully understand the issues, we recommend that you consult
26841 a knowledgeable security professional or the \SpecialChar LyX
26842 development team if you have
26843 any questions about whether a given template is safe or not.
26844 And do this before you use it in an uncontrolled environment.
26847 \begin_layout Chapter
26849 List of supported \SpecialChar LyX
26850 functions to be used in layouts
26851 \begin_inset CommandInset label
26853 name "chap:List-of-functions"
26860 \begin_layout Standard
26862 \begin_inset Tabular
26863 <lyxtabular version="3" rows="11" columns="8">
26864 <features tabularvalignment="middle">
26865 <column alignment="left" valignment="top">
26866 <column alignment="left" valignment="top">
26867 <column alignment="left" valignment="top">
26868 <column alignment="left" valignment="top">
26869 <column alignment="left" valignment="top">
26870 <column alignment="left" valignment="top">
26871 <column alignment="left" valignment="top">
26872 <column alignment="left" valignment="top">
26874 <cell alignment="left" valignment="top" usebox="none">
26877 \begin_layout Plain Layout
26883 <cell alignment="left" valignment="top" usebox="none">
26886 \begin_layout Plain Layout
26892 <cell alignment="left" valignment="top" usebox="none">
26895 \begin_layout Plain Layout
26901 <cell alignment="left" valignment="top" usebox="none">
26904 \begin_layout Plain Layout
26910 <cell alignment="center" valignment="top" usebox="none">
26913 \begin_layout Plain Layout
26919 <cell alignment="center" valignment="top" usebox="none">
26922 \begin_layout Plain Layout
26928 <cell alignment="center" valignment="top" usebox="none">
26931 \begin_layout Plain Layout
26937 <cell alignment="center" valignment="top" usebox="none">
26940 \begin_layout Plain Layout
26948 <cell alignment="left" valignment="top" usebox="none">
26951 \begin_layout Plain Layout
26957 <cell alignment="left" valignment="top" usebox="none">
26960 \begin_layout Plain Layout
26966 <cell alignment="left" valignment="top" usebox="none">
26969 \begin_layout Plain Layout
26975 <cell alignment="left" valignment="top" usebox="none">
26978 \begin_layout Plain Layout
26984 <cell alignment="center" valignment="top" usebox="none">
26987 \begin_layout Plain Layout
26993 <cell alignment="center" valignment="top" usebox="none">
26996 \begin_layout Plain Layout
27002 <cell alignment="center" valignment="top" usebox="none">
27005 \begin_layout Plain Layout
27011 <cell alignment="center" valignment="top" usebox="none">
27014 \begin_layout Plain Layout
27022 <cell alignment="left" valignment="top" usebox="none">
27025 \begin_layout Plain Layout
27031 <cell alignment="left" valignment="top" usebox="none">
27034 \begin_layout Plain Layout
27040 <cell alignment="left" valignment="top" usebox="none">
27043 \begin_layout Plain Layout
27049 <cell alignment="left" valignment="top" usebox="none">
27052 \begin_layout Plain Layout
27058 <cell alignment="center" valignment="top" usebox="none">
27061 \begin_layout Plain Layout
27067 <cell alignment="center" valignment="top" usebox="none">
27070 \begin_layout Plain Layout
27076 <cell alignment="center" valignment="top" usebox="none">
27079 \begin_layout Plain Layout
27085 <cell alignment="center" valignment="top" usebox="none">
27088 \begin_layout Plain Layout
27096 <cell alignment="left" valignment="top" usebox="none">
27099 \begin_layout Plain Layout
27105 <cell alignment="left" valignment="top" usebox="none">
27108 \begin_layout Plain Layout
27114 <cell alignment="left" valignment="top" usebox="none">
27117 \begin_layout Plain Layout
27123 <cell alignment="left" valignment="top" usebox="none">
27126 \begin_layout Plain Layout
27132 <cell alignment="center" valignment="top" usebox="none">
27135 \begin_layout Plain Layout
27141 <cell alignment="center" valignment="top" usebox="none">
27144 \begin_layout Plain Layout
27150 <cell alignment="center" valignment="top" usebox="none">
27153 \begin_layout Plain Layout
27159 <cell alignment="center" valignment="top" usebox="none">
27162 \begin_layout Plain Layout
27170 <cell alignment="left" valignment="top" usebox="none">
27173 \begin_layout Plain Layout
27179 <cell alignment="left" valignment="top" usebox="none">
27182 \begin_layout Plain Layout
27188 <cell alignment="left" valignment="top" usebox="none">
27191 \begin_layout Plain Layout
27197 <cell alignment="left" valignment="top" usebox="none">
27200 \begin_layout Plain Layout
27206 <cell alignment="center" valignment="top" usebox="none">
27209 \begin_layout Plain Layout
27215 <cell alignment="center" valignment="top" usebox="none">
27218 \begin_layout Plain Layout
27224 <cell alignment="center" valignment="top" usebox="none">
27227 \begin_layout Plain Layout
27233 <cell alignment="center" valignment="top" usebox="none">
27236 \begin_layout Plain Layout
27244 <cell alignment="left" valignment="top" usebox="none">
27247 \begin_layout Plain Layout
27253 <cell alignment="left" valignment="top" usebox="none">
27256 \begin_layout Plain Layout
27262 <cell alignment="left" valignment="top" usebox="none">
27265 \begin_layout Plain Layout
27271 <cell alignment="left" valignment="top" usebox="none">
27274 \begin_layout Plain Layout
27280 <cell alignment="center" valignment="top" usebox="none">
27283 \begin_layout Plain Layout
27289 <cell alignment="center" valignment="top" usebox="none">
27292 \begin_layout Plain Layout
27298 <cell alignment="center" valignment="top" usebox="none">
27301 \begin_layout Plain Layout
27307 <cell alignment="center" valignment="top" usebox="none">
27310 \begin_layout Plain Layout
27318 <cell alignment="left" valignment="top" usebox="none">
27321 \begin_layout Plain Layout
27327 <cell alignment="left" valignment="top" usebox="none">
27330 \begin_layout Plain Layout
27336 <cell alignment="left" valignment="top" usebox="none">
27339 \begin_layout Plain Layout
27345 <cell alignment="left" valignment="top" usebox="none">
27348 \begin_layout Plain Layout
27354 <cell alignment="center" valignment="top" usebox="none">
27357 \begin_layout Plain Layout
27363 <cell alignment="center" valignment="top" usebox="none">
27366 \begin_layout Plain Layout
27372 <cell alignment="center" valignment="top" usebox="none">
27375 \begin_layout Plain Layout
27381 <cell alignment="center" valignment="top" usebox="none">
27384 \begin_layout Plain Layout
27392 <cell alignment="left" valignment="top" usebox="none">
27395 \begin_layout Plain Layout
27401 <cell alignment="left" valignment="top" usebox="none">
27404 \begin_layout Plain Layout
27410 <cell alignment="left" valignment="top" usebox="none">
27413 \begin_layout Plain Layout
27419 <cell alignment="left" valignment="top" usebox="none">
27422 \begin_layout Plain Layout
27428 <cell alignment="center" valignment="top" usebox="none">
27431 \begin_layout Plain Layout
27437 <cell alignment="center" valignment="top" usebox="none">
27440 \begin_layout Plain Layout
27446 <cell alignment="center" valignment="top" usebox="none">
27449 \begin_layout Plain Layout
27455 <cell alignment="center" valignment="top" usebox="none">
27458 \begin_layout Plain Layout
27466 <cell alignment="left" valignment="top" usebox="none">
27469 \begin_layout Plain Layout
27475 <cell alignment="left" valignment="top" usebox="none">
27478 \begin_layout Plain Layout
27484 <cell alignment="left" valignment="top" usebox="none">
27487 \begin_layout Plain Layout
27493 <cell alignment="left" valignment="top" usebox="none">
27496 \begin_layout Plain Layout
27502 <cell alignment="center" valignment="top" usebox="none">
27505 \begin_layout Plain Layout
27511 <cell alignment="center" valignment="top" usebox="none">
27514 \begin_layout Plain Layout
27520 <cell alignment="center" valignment="top" usebox="none">
27523 \begin_layout Plain Layout
27529 <cell alignment="center" valignment="top" usebox="none">
27532 \begin_layout Plain Layout
27540 <cell alignment="left" valignment="top" usebox="none">
27543 \begin_layout Plain Layout
27549 <cell alignment="left" valignment="top" usebox="none">
27552 \begin_layout Plain Layout
27558 <cell alignment="left" valignment="top" usebox="none">
27561 \begin_layout Plain Layout
27567 <cell alignment="left" valignment="top" usebox="none">
27570 \begin_layout Plain Layout
27576 <cell alignment="center" valignment="top" usebox="none">
27579 \begin_layout Plain Layout
27585 <cell alignment="center" valignment="top" usebox="none">
27588 \begin_layout Plain Layout
27594 <cell alignment="center" valignment="top" usebox="none">
27597 \begin_layout Plain Layout
27603 <cell alignment="center" valignment="top" usebox="none">
27606 \begin_layout Plain Layout
27614 <cell alignment="center" valignment="top" usebox="none">
27617 \begin_layout Plain Layout
27623 <cell alignment="center" valignment="top" usebox="none">
27626 \begin_layout Plain Layout
27632 <cell alignment="center" valignment="top" usebox="none">
27635 \begin_layout Plain Layout
27641 <cell alignment="center" valignment="top" usebox="none">
27644 \begin_layout Plain Layout
27650 <cell alignment="center" valignment="top" usebox="none">
27653 \begin_layout Plain Layout
27659 <cell alignment="center" valignment="top" usebox="none">
27662 \begin_layout Plain Layout
27668 <cell alignment="center" valignment="top" usebox="none">
27671 \begin_layout Plain Layout
27677 <cell alignment="center" valignment="top" usebox="none">
27680 \begin_layout Plain Layout
27694 \begin_layout Chapter
27695 Names of available colors to be used in layouts
27696 \begin_inset CommandInset label
27698 name "chap:Names-of-colors"
27705 \begin_layout Standard
27706 The colors listed below are the standard colors and those that you can adjust
27707 in the \SpecialChar LyX
27711 \begin_layout Section
27715 \begin_layout Standard
27716 The following are no real colors, but rather act on color definitions:
27719 \begin_layout Description
27720 ignore The color is ignored
27723 \begin_layout Description
27724 inherit The color is inherited
27727 \begin_layout Description
27740 No particular color – clear or default
27743 \begin_layout Section
27747 \begin_layout Standard
27748 These are fixed colors that cannot me customized:
27751 \begin_layout Description
27755 \begin_layout Description
27759 \begin_layout Description
27763 \begin_layout Description
27767 \begin_layout Description
27771 \begin_layout Description
27775 \begin_layout Description
27779 \begin_layout Description
27783 \begin_layout Description
27787 \begin_layout Description
27791 \begin_layout Description
27795 \begin_layout Description
27799 \begin_layout Description
27803 \begin_layout Description
27807 \begin_layout Description
27811 \begin_layout Description
27815 \begin_layout Description
27819 \begin_layout Description
27823 \begin_layout Description
27827 \begin_layout Section
27831 \begin_layout Standard
27832 These are the colors allocated to specific elements in
27835 arg "dialog-show prefs"
27841 \begin_layout Description
27842 added_space Added space color
27845 \begin_layout Description
27846 addedtext Added text color
27849 \begin_layout Description
27850 appendix Appendix marker color
27853 \begin_layout Description
27854 background Background color
27857 \begin_layout Description
27858 bottomarea Bottom area color
27861 \begin_layout Description
27862 branchlabel Label color for branches
27865 \begin_layout Description
27866 buttonbg Color used for button background
27869 \begin_layout Description
27870 buttonframe Color for inset button frames
27873 \begin_layout Description
27874 buttonhoverbg Color used for button background under focus
27877 \begin_layout Description
27878 changebar Changebar color
27881 \begin_layout Description
27882 changedtextauthor1 Changed text color author 1
27885 \begin_layout Description
27886 changedtextauthor2 Changed text color author 2
27889 \begin_layout Description
27890 changedtextauthor3 Changed text color author 3
27893 \begin_layout Description
27894 changedtextauthor4 Changed text color author 4
27897 \begin_layout Description
27898 changedtextauthor5 Changed text color author 5
27901 \begin_layout Description
27902 collapsible Collapsible insets text color
27905 \begin_layout Description
27906 collapsibleframe Collapsible insets framecolor
27909 \begin_layout Description
27910 command Text color for command insets
27913 \begin_layout Description
27914 commandbg Background color for command insets
27917 \begin_layout Description
27918 commandframe Frame color for command insets
27921 \begin_layout Description
27922 commentbg Background color of comments
27925 \begin_layout Description
27926 commentlabel Label color for comments
27929 \begin_layout Description
27930 cursor Cursor color
27933 \begin_layout Description
27934 deletedtext Deleted text color
27937 \begin_layout Description
27938 deletedtextmodifier Deleted text modifying color
27941 \begin_layout Description
27942 depthbar Color for the depth bars in the margin
27945 \begin_layout Description
27946 eolmarker End of line marker color
27949 \begin_layout Description
27950 error Color of the \SpecialChar LaTeX
27954 \begin_layout Description
27955 footlabel Label color for footnotes
27958 \begin_layout Description
27959 foreground Foreground color
27962 \begin_layout Description
27963 graphicsbg Graphics inset background color
27966 \begin_layout Description
27967 greyedoutbg Background color of greyedout inset
27970 \begin_layout Description
27971 greyedoutlabel Label color for greyedout insets
27974 \begin_layout Description
27975 greyedouttext Color for greyedout inset text
27978 \begin_layout Description
27979 indexlabel Label color for index insets
27982 \begin_layout Description
27983 inlinecompletion Inline completion color
27986 \begin_layout Description
27987 insetbg Inset marker background color
27990 \begin_layout Description
27991 insetframe Inset marker frame color
27994 \begin_layout Description
27995 language Color for marking foreign language words
27998 \begin_layout Description
27999 latex Text color in \SpecialChar LaTeX
28003 \begin_layout Description
28004 listingsbg Background color of listings inset
28007 \begin_layout Description
28008 marginlabel Label color for margin notes
28011 \begin_layout Description
28012 math Math inset text color
28015 \begin_layout Description
28016 mathbg Math inset background color
28019 \begin_layout Description
28020 mathcorners Math inset frame color not under focus
28023 \begin_layout Description
28024 mathframe Math inset frame color under focus
28027 \begin_layout Description
28028 mathline Math line color
28031 \begin_layout Description
28032 mathmacrobg Macro math inset background color
28035 \begin_layout Description
28036 mathmacroblend Macro math blended color
28039 \begin_layout Description
28040 mathmacroframe Macro math frame color
28043 \begin_layout Description
28044 mathmacrohoverbg Macro math inset background color hovered
28047 \begin_layout Description
28048 mathmacrolabel Macro math label color
28051 \begin_layout Description
28052 mathmacronewarg Macro template color for new parameters
28055 \begin_layout Description
28056 mathmacrooldarg Macro template color for old parameters
28059 \begin_layout Description
28060 newpage New page color
28063 \begin_layout Description
28064 nonunique_inlinecompletion Inline completion color for the non-unique part
28067 \begin_layout Description
28068 notebg Background color of notes
28071 \begin_layout Description
28072 notelabel Label color for notes
28075 \begin_layout Description
28076 pagebreak Page break/line break color
28079 \begin_layout Description
28080 paragraphmarker Color used for the pilcrow sign to mark the end of a paragraph
28083 \begin_layout Description
28084 phantomtext Text color for phantom insets
28087 \begin_layout Description
28088 preview The color used for previews
28091 \begin_layout Description
28092 previewframe Preview frame color
28095 \begin_layout Description
28096 regexpframe Color for regexp frame
28099 \begin_layout Description
28100 scroll Color that indicates when a row can be scrolled
28103 \begin_layout Description
28104 selection Background color of selected text
28107 \begin_layout Description
28108 selectiontext Foreground color of selected text
28111 \begin_layout Description
28112 shadedbg Background color of shaded box
28115 \begin_layout Description
28116 special Special chars text color
28119 \begin_layout Description
28120 tabularline Table line color
28123 \begin_layout Description
28124 tabularonoffline Table line color
28127 \begin_layout Description
28128 urllabel Label color for URL insets
28131 \begin_layout Description
28132 urltext Color for URL inset text