1 #LyX 2.4 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 424524441 "rgheck"
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 "http://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 "http://www.lyx.org/Translation"
3435 target "http://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 http://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 "http://www.lyx.org/trac/timeline"
3550 target "http://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 "http://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:
7458 \begin_inset Flex Code
7461 \begin_layout Plain Layout
7468 This template is loaded every time you create a new document with
7469 \begin_inset Flex Noun
7472 \begin_layout Plain Layout
7473 File\SpecialChar menuseparator
7479 in order to provide useful defaults.
7480 To create this template from inside \SpecialChar LyX
7481 , all you have to do is to open a document
7482 with the correct settings, and use the
7483 \begin_inset Flex Noun
7486 \begin_layout Plain Layout
7487 Save as Document Defaults
7495 \begin_layout Subsection
7496 Upgrading old layout files
7499 \begin_layout Standard
7500 The format of layout files changes with each \SpecialChar LyX
7501 release, so old layout files
7502 need to be converted to the new format.
7504 reads a layout file in an older format, it automatically calls the
7506 \begin_inset Flex Code
7509 \begin_layout Plain Layout
7515 to convert it to a temporary file in current format.
7516 The original file is left untouched.
7517 If you use the layout file often, then, you may want to convert it permanently,
7518 so that \SpecialChar LyX
7519 does not have to do so itself every time.
7520 To do this, you can call the converter manually:
7523 \begin_layout Enumerate
7525 \begin_inset Flex Code
7528 \begin_layout Plain Layout
7535 \begin_inset Flex Code
7538 \begin_layout Plain Layout
7547 \begin_layout Enumerate
7549 \begin_inset Newline newline
7553 \begin_inset Flex Code
7556 \begin_layout Plain Layout
7557 python LyXDir/scripts/layout2layout.py myclass.old myclass.layout
7563 \begin_inset Newline newline
7567 \begin_inset Flex Code
7570 \begin_layout Plain Layout
7576 is the name of your \SpecialChar LyX
7580 \begin_layout Standard
7581 Note that manual conversion does not affect included files, so these will
7582 have to be converted separately.
7585 \begin_layout Subsection
7586 \begin_inset CommandInset label
7588 name "subsec:Cite-Engine-Files"
7595 \begin_layout Standard
7596 A specific form of layout files are the so-called
7597 \begin_inset Flex Code
7600 \begin_layout Plain Layout
7606 files that are located in the
7607 \begin_inset Flex Code
7610 \begin_layout Plain Layout
7617 Their purpose is to define the specifics of \SpecialChar LaTeX
7618 packages aimed at bibliography
7631 , but also the way how normal Bib\SpecialChar TeX
7632 citations (without additional packages)
7633 are handled in \SpecialChar LyX
7634 is defined in such a file.
7638 \begin_layout Standard
7639 More specifically, it is defined which packages \SpecialChar LyX
7640 needs to load, which citation
7641 commands are available, how these are to be displayed in \SpecialChar LyX
7643 the dialogs, the context menus) as well as in the XHTML and plain text
7645 Furthermore, the files specify available style variants (author-year, numerical
7646 , etc.) and their specifics.
7647 The cite engine files are also used to generate the options that are available
7650 Document\SpecialChar menuseparator
7651 Settings\SpecialChar menuseparator
7652 Bibliography\SpecialChar menuseparator
7658 \begin_layout Standard
7659 Even though a cite engine file is essentially a normal layout file that
7660 could theoretically include any layout information, it usually primarily
7661 includes some specific parameters such as
7662 \begin_inset Flex Code
7665 \begin_layout Plain Layout
7672 \begin_inset Flex Code
7675 \begin_layout Plain Layout
7682 \begin_inset Flex Code
7685 \begin_layout Plain Layout
7692 \begin_inset Flex Code
7695 \begin_layout Plain Layout
7702 The syntax of the latter two is described in
7703 \begin_inset CommandInset ref
7705 reference "subsec:Citation-engine-description"
7713 \begin_inset CommandInset ref
7715 reference "subsec:Citation-format-description"
7719 , as well as in the files themselves.
7722 \begin_layout Section
7723 \begin_inset CommandInset label
7725 name "sec:TextClass"
7729 The layout file format
7732 \begin_layout Standard
7733 The following sections describe how layout files are structured and written.
7734 Our advice is to go slowly, save and test often.
7735 It is really not that hard, except that the multitude of options can become
7736 overwhelming, especially if you try to check out too many at once.
7737 It becomes easier if you use existing layouts of \SpecialChar LyX
7738 as examples/reference
7739 or if you modify an existing layout to your needs.
7742 \begin_layout Standard
7743 Note that all the tags used in layout files are case-insensitive.
7745 \begin_inset Flex Code
7748 \begin_layout Plain Layout
7755 \begin_inset Flex Code
7758 \begin_layout Plain Layout
7765 \begin_inset Flex Code
7768 \begin_layout Plain Layout
7774 are really the same tag.
7775 The possible arguments are printed in brackets after the tag's name.
7776 The default argument is typeset
7777 \begin_inset Flex Code
7780 \begin_layout Plain Layout
7789 If the argument has a data type like
7790 \begin_inset Quotes eld
7794 \begin_inset Quotes erd
7798 \begin_inset Quotes eld
7802 \begin_inset Quotes erd
7805 , the default is shown like this:
7806 \begin_inset Flex Code
7809 \begin_layout Plain Layout
7820 \begin_layout Subsection
7821 The document class declaration and classification
7824 \begin_layout Standard
7825 Lines in a layout file which begin with
7826 \begin_inset Flex Code
7829 \begin_layout Plain Layout
7836 There is one exception to this rule.
7838 \begin_inset Flex Code
7841 \begin_layout Plain Layout
7847 files should begin with lines like:
7850 \begin_layout LyX-Code
7853 #% Do not delete the line below; configure depends on this
7856 \begin_layout LyX-Code
7861 DeclareLaTeXClass{Article (Standard Class)}
7864 \begin_layout LyX-Code
7869 DeclareCategory{Articles}
7872 \begin_layout Standard
7873 The second and third lines are used when you (re)configure \SpecialChar LyX
7875 The layout file is read by the \SpecialChar LaTeX
7877 \begin_inset Flex Code
7880 \begin_layout Plain Layout
7886 , in a special mode where
7887 \begin_inset Flex Code
7890 \begin_layout Plain Layout
7897 The first line is just a \SpecialChar LaTeX
7898 comment, the second one contains the mandatory
7899 declaration of the text class and the third line contains the optional
7900 classification of the class.
7901 If these lines appear in a file named
7902 \begin_inset Flex Code
7905 \begin_layout Plain Layout
7911 , then they define a text class of name
7912 \begin_inset Flex Code
7915 \begin_layout Plain Layout
7921 (the name of the layout file) which uses the \SpecialChar LaTeX
7923 \begin_inset Flex Code
7926 \begin_layout Plain Layout
7932 (the default is to use the same name as the layout).
7934 \begin_inset Quotes eld
7937 Article (Standard Class)
7938 \begin_inset Quotes erd
7941 that appears above is used as a description of the text class in the
7942 \begin_inset Flex Noun
7945 \begin_layout Plain Layout
7946 Document\SpecialChar menuseparator
7954 \begin_inset Quotes eld
7958 \begin_inset Quotes erd
7961 in the example) is also used in the
7962 \begin_inset Flex Noun
7965 \begin_layout Plain Layout
7966 Document\SpecialChar menuseparator
7972 dialog: the text classes are grouped by these categories (which are usually
7973 genres, so typical categories are
7974 \begin_inset Quotes eld
7978 \begin_inset Quotes erd
7982 \begin_inset Quotes eld
7986 \begin_inset Quotes erd
7990 \begin_inset Quotes eld
7994 \begin_inset Quotes erd
7998 \begin_inset Quotes eld
8002 \begin_inset Quotes erd
8006 \begin_inset Quotes eld
8010 \begin_inset Quotes erd
8014 \begin_inset Quotes eld
8018 \begin_inset Quotes erd
8022 If no category has been declared, the class will be put in the
8023 \begin_inset Quotes eld
8027 \begin_inset Quotes erd
8033 \begin_layout Standard
8034 Let's assume that you wrote your own text class that uses the
8035 \begin_inset Flex Code
8038 \begin_layout Plain Layout
8044 document class, but where you changed the appearance of the section headings.
8045 If you put it in a file
8046 \begin_inset Flex Code
8049 \begin_layout Plain Layout
8055 , the header of this file should be:
8058 \begin_layout LyX-Code
8061 #% Do not delete the line below; configure depends on this
8064 \begin_layout LyX-Code
8069 DeclareLaTeXClass[article]{Article (with My Own Headings)}
8072 \begin_layout LyX-Code
8077 DeclareCategory{Articles}
8080 \begin_layout Standard
8081 This declares a text class
8082 \begin_inset Flex Code
8085 \begin_layout Plain Layout
8091 , associated with the \SpecialChar LaTeX
8093 \begin_inset Flex Code
8096 \begin_layout Plain Layout
8103 \begin_inset Quotes eld
8106 Article (with My Own Headings)
8107 \begin_inset Quotes erd
8111 If your text class depends on several packages, you can declare it as:
8114 \begin_layout LyX-Code
8117 #% Do not delete the line below; configure depends on this
8120 \begin_layout LyX-Code
8125 DeclareLaTeXClass[article,foo.sty]{Article (with My Own Headings)}
8128 \begin_layout LyX-Code
8133 DeclareCategory{Articles}
8136 \begin_layout Standard
8137 This indicates that your text class uses the
8138 \begin_inset Flex Code
8141 \begin_layout Plain Layout
8148 Finally, it is also possible to declare classes for DocBook code.
8149 Typical declarations will look like:
8152 \begin_layout LyX-Code
8155 #% Do not delete the line below; configure depends on this
8158 \begin_layout LyX-Code
8163 DeclareDocBookClass[article]{SGML (DocBook Article)}
8166 \begin_layout LyX-Code
8171 DeclareCategory{Articles (DocBook)}
8174 \begin_layout Standard
8175 Note that these declarations can also be given an optional parameter declaring
8176 the name of the document class (but not a list).
8179 \begin_layout Standard
8180 So, to be as explicit as possible, the form of the layout declaration is:
8183 \begin_layout LyX-Code
8188 DeclareLaTeXClass[class,package.sty]{layout description}
8191 \begin_layout LyX-Code
8196 DeclareCategory{category}
8199 \begin_layout Standard
8200 The class need only be specified if the name of the \SpecialChar LaTeX
8202 name of the layout file are different or if there are packages to load.
8203 If the name of the class file is not specified, then \SpecialChar LyX
8205 that it is the same as the name of the layout file.
8208 \begin_layout Standard
8209 When the text class has been modified to your taste, all you have to do
8210 is to copy it either to
8211 \begin_inset Flex Code
8214 \begin_layout Plain Layout
8221 \begin_inset Flex Code
8224 \begin_layout Plain Layout
8231 \begin_inset Flex Noun
8234 \begin_layout Plain Layout
8235 Tools\SpecialChar menuseparator
8241 , exit \SpecialChar LyX
8243 Then your new text class should be available along with the others.
8246 \begin_layout Standard
8247 Once the layout file is installed, you can edit it and see your changes
8248 without having to reconfigure or to restart \SpecialChar LyX
8253 \begin_layout Plain Layout
8254 In versions of \SpecialChar LyX
8255 prior to 1.6, this was not true.
8256 As a result, editing layout files was very time consuming, since you had
8257 constantly to restart \SpecialChar LyX
8263 You can force a reload of the current layout by using the \SpecialChar LyX
8265 \begin_inset Flex Noun
8268 \begin_layout Plain Layout
8275 There is no default binding for this function—though, of course, you can
8276 bind it to a key yourself.
8277 But you will normally use this function simply by entering it in the mini-buffe
8282 \begin_layout Standard
8288 \begin_inset Flex Noun
8291 \begin_layout Plain Layout
8297 is very much an `advanced feature'.
8302 recommended that you save your work before using this function.
8307 recommended that you not attempt to edit layout information while simultaneousl
8308 y working on a document that you care about.
8309 Use a test document.
8310 Syntax errors and the like in your layout file could cause peculiar behavior.
8311 In particular, such errors could cause \SpecialChar LyX
8312 to regard the current layout as
8313 invalid and to attempt to switch to some other layout.
8317 \begin_layout Plain Layout
8318 Really bad syntax errors may even caused \SpecialChar LyX
8320 This is because certain sorts of errors may make \SpecialChar LyX
8331 The \SpecialChar LyX
8332 team strives to keep \SpecialChar LyX
8333 stable in such situations, but safe is better
8338 \begin_layout Plain Layout
8339 While we're giving advice: make regular backups.
8340 And be nice to your mother.
8348 \begin_layout Subsection
8349 The Module declaration
8352 \begin_layout Standard
8353 A module must begin with a line like the following:
8356 \begin_layout LyX-Code
8359 DeclareLyXModule[endnotes.sty]{Endnotes}
8362 \begin_layout Standard
8363 The mandatory argument, in curly brackets, is the name of the module, as
8365 \begin_inset Flex Noun
8368 \begin_layout Plain Layout
8369 Document\SpecialChar menuseparator
8370 Settings\SpecialChar menuseparator
8377 The argument in square brackets is optional: It declares any \SpecialChar LaTeX
8379 on which the module depends.
8380 It is also possible to use the form
8381 \begin_inset Flex Noun
8384 \begin_layout Plain Layout
8390 as an optional argument, which declares that the module can only be used
8391 when there exists a conversion chain between the formats `
8392 \begin_inset Flex Code
8395 \begin_layout Plain Layout
8402 \begin_inset Flex Code
8405 \begin_layout Plain Layout
8414 \begin_layout Standard
8415 The module declaration should then be followed by lines like the following:
8419 \begin_layout Plain Layout
8420 Preferably in English if the module should be published with \SpecialChar LyX
8422 This description will appear in the list of messages to be translated and
8423 will be thus translated with the next interface update.
8431 \begin_layout LyX-Code
8435 \begin_layout LyX-Code
8436 #Adds an endnote command, in addition to footnotes.
8440 \begin_layout LyX-Code
8441 #You will need to add
8443 theendnotes in TeX code where you
8446 \begin_layout LyX-Code
8447 #want the endnotes to appear.
8451 \begin_layout LyX-Code
8455 \begin_layout LyX-Code
8456 #Requires: somemodule | othermodule
8459 \begin_layout LyX-Code
8460 #Excludes: badmodule
8463 \begin_layout Standard
8464 The description is used in
8465 \begin_inset Flex Noun
8468 \begin_layout Plain Layout
8469 Document\SpecialChar menuseparator
8470 Settings\SpecialChar menuseparator
8476 to provide the user with information about what the module does.
8478 \begin_inset Flex Code
8481 \begin_layout Plain Layout
8487 line is used to identify other modules with which this one must be used;
8489 \begin_inset Flex Code
8492 \begin_layout Plain Layout
8498 line is used to identify modules with which this one may not be used.
8499 Both are optional, and, as shown, multiple modules should be separated
8500 with the pipe symbol: |.
8501 Note that the required modules are treated disjunctively:
8505 of the required modules must be used.
8510 excluded module may be used.
8511 Note that modules are identified here by their filenames without the
8512 \begin_inset Flex Code
8515 \begin_layout Plain Layout
8523 \begin_inset Flex Code
8526 \begin_layout Plain Layout
8533 \begin_inset Flex Code
8536 \begin_layout Plain Layout
8545 \begin_layout Subsection
8546 The CiteEngine file declaration
8549 \begin_layout Standard
8550 A cite engine file must begin with a line like the following:
8553 \begin_layout LyX-Code
8556 DeclareLyXCiteEngineModule[biblatex.sty]{Biblatex}
8559 \begin_layout Standard
8560 The mandatory argument, in curly brackets, is the name of the cite style,
8561 as it should appear in
8562 \begin_inset Flex Noun
8565 \begin_layout Plain Layout
8566 Document\SpecialChar menuseparator
8567 Settings\SpecialChar menuseparator
8574 The argument in square brackets is optional: It declares any \SpecialChar LaTeX
8576 on which the cite engine depends.
8579 \begin_layout Standard
8580 The cite engine declaration should then be followed by lines like the following:
8584 \begin_layout Plain Layout
8585 Preferably in English if the module should be published with \SpecialChar LyX
8587 This description will appear in the list of messages to be translated and
8588 will be thus translated with the next interface update.
8596 \begin_layout LyX-Code
8600 \begin_layout LyX-Code
8601 # Biblatex supports many author-year and numerical styles.
8604 \begin_layout LyX-Code
8605 # It is mainly aimed at the Humanities.
8609 \begin_layout LyX-Code
8610 # customizable, fully localized and provides many features
8613 \begin_layout LyX-Code
8614 # that are not possible with BibTeX.
8615 The use of 'biber' as
8618 \begin_layout LyX-Code
8619 # bibliography processor is advised.
8622 \begin_layout LyX-Code
8626 \begin_layout Standard
8627 The description is used in
8628 \begin_inset Flex Noun
8631 \begin_layout Plain Layout
8632 Document\SpecialChar menuseparator
8633 Settings\SpecialChar menuseparator
8639 to provide the user with information about the cite engine.
8642 \begin_layout Subsection
8646 \begin_layout Standard
8647 The first non-comment line of any layout file, included file, or module
8652 contain the file format number:
8655 \begin_layout Description
8656 \begin_inset Flex Code
8659 \begin_layout Plain Layout
8666 \begin_inset Flex Code
8669 \begin_layout Plain Layout
8675 ] The format number of the layout file.
8678 \begin_layout Standard
8679 This tag was introduced with \SpecialChar LyX
8681 \begin_inset space ~
8685 Layout files from older \SpecialChar LyX
8686 versions do not have an explicit file format and
8687 are considered to have
8688 \begin_inset Flex Code
8691 \begin_layout Plain Layout
8693 \begin_inset space ~
8702 The format for the present version of \SpecialChar LyX
8704 But each version of \SpecialChar LyX
8705 is capable of reading earlier versions' layout files,
8706 just as they are capable of reading files produced by earlier versions
8709 There is, however, no provision for converting to earlier formats.
8712 \begin_layout Subsection
8713 \begin_inset CommandInset label
8715 name "subsec:General-text-class"
8719 General text class parameters
8722 \begin_layout Standard
8723 These are general parameters that govern the behavior of an entire document
8729 mean that they must appear in
8730 \begin_inset Flex Code
8733 \begin_layout Plain Layout
8739 files rather than in modules.
8740 A module can contain any layout tag.)
8743 \begin_layout Description
8744 \begin_inset Flex Code
8747 \begin_layout Plain Layout
8753 Adds information that will be output in the
8754 \begin_inset Flex Code
8757 \begin_layout Plain Layout
8763 block when the document is output to XHTML.
8764 Typically, this would be used to output CSS style information, but it can
8765 be used for anything that can appear in
8766 \begin_inset Flex Code
8769 \begin_layout Plain Layout
8777 \begin_inset Quotes eld
8781 \begin_inset Flex Code
8784 \begin_layout Plain Layout
8791 \begin_inset Quotes erd
8797 \begin_layout Description
8798 \begin_inset Flex Code
8801 \begin_layout Plain Layout
8807 Adds information to the document preamble.
8809 \begin_inset Newline newline
8813 \begin_inset Quotes eld
8817 \begin_inset Flex Code
8820 \begin_layout Plain Layout
8827 \begin_inset Quotes erd
8833 \begin_layout Description
8834 \begin_inset Flex Code
8837 \begin_layout Plain Layout
8843 Defines the possibilities for displaying citation references.
8845 \begin_inset CommandInset ref
8847 reference "subsec:Citation-engine-description"
8856 \begin_inset Quotes eld
8860 \begin_inset Flex Code
8863 \begin_layout Plain Layout
8870 \begin_inset Quotes erd
8874 Primarily used in cite engine files (see
8875 \begin_inset CommandInset ref
8877 reference "subsec:Cite-Engine-Files"
8887 \begin_layout Description
8888 \begin_inset Flex Code
8891 \begin_layout Plain Layout
8897 Defines formats for use in the display of bibliographic information.
8899 \begin_inset CommandInset ref
8901 reference "subsec:Citation-format-description"
8907 \begin_inset Quotes eld
8911 \begin_inset Flex Code
8914 \begin_layout Plain Layout
8921 \begin_inset Quotes erd
8925 Primarily used in cite engine files (see
8926 \begin_inset CommandInset ref
8928 reference "subsec:Cite-Engine-Files"
8938 \begin_layout Description
8939 \begin_inset Flex Code
8942 \begin_layout Plain Layout
8949 \begin_inset Flex Code
8952 \begin_layout Plain Layout
8961 \begin_inset Flex Code
8964 \begin_layout Plain Layout
8970 ] Determines whether
8974 or Bib\SpecialChar TeX
8975 is used to generate a Bibliography.
8976 Primarily used in cite engine files (see
8977 \begin_inset CommandInset ref
8979 reference "subsec:Cite-Engine-Files"
8989 \begin_layout Description
8990 \begin_inset Flex Code
8993 \begin_layout Plain Layout
8999 Describes various global options supported by the document class.
9001 \begin_inset CommandInset ref
9003 reference "subsec:ClassOptions"
9009 \begin_inset Quotes eld
9013 \begin_inset Flex Code
9016 \begin_layout Plain Layout
9023 \begin_inset Quotes erd
9029 \begin_layout Description
9030 \begin_inset Flex Code
9033 \begin_layout Plain Layout
9040 \begin_inset Flex Code
9043 \begin_layout Plain Layout
9052 \begin_inset space \thinspace{}
9056 \begin_inset Flex Code
9059 \begin_layout Plain Layout
9065 ] Whether the class should
9069 to having one or two columns.
9070 Can be changed in the
9071 \begin_inset Flex Noun
9074 \begin_layout Plain Layout
9075 Document\SpecialChar menuseparator
9084 \begin_layout Description
9085 \begin_inset Flex Code
9088 \begin_layout Plain Layout
9095 \begin_inset Flex Code
9098 \begin_layout Plain Layout
9104 ] This sequence defines the properties for a counter.
9105 If the counter does not yet exist, it is created; if it does exist, it
9108 \begin_inset Quotes eld
9112 \begin_inset Flex Code
9115 \begin_layout Plain Layout
9122 \begin_inset Quotes erd
9126 \begin_inset Newline newline
9130 \begin_inset CommandInset ref
9132 reference "subsec:Counters"
9136 for details on counters.
9139 \begin_layout Description
9140 \begin_inset Flex Code
9143 \begin_layout Plain Layout
9149 Sets the default font used to display the document.
9151 \begin_inset CommandInset ref
9153 reference "subsec:Font-description"
9157 for how to declare fonts.
9159 \begin_inset Quotes eld
9163 \begin_inset Flex Code
9166 \begin_layout Plain Layout
9173 \begin_inset Quotes erd
9179 \begin_layout Description
9180 \begin_inset Flex Code
9183 \begin_layout Plain Layout
9190 \begin_inset Flex Code
9193 \begin_layout Plain Layout
9199 ] Specifies a module to be included by default with this document class.
9200 The module is specified as filename without the
9201 \begin_inset Flex Code
9204 \begin_layout Plain Layout
9211 The user can still remove the module, but it will be active at the outset.
9212 (This applies only when new files are created, or when this class is chosen
9213 for an existing document.)
9216 \begin_layout Description
9217 \begin_inset Flex Code
9220 \begin_layout Plain Layout
9227 \begin_inset Flex Code
9230 \begin_layout Plain Layout
9236 ] This is the style that will be assigned to new paragraphs, usually
9237 \begin_inset Flex Noun
9240 \begin_layout Plain Layout
9247 This will default to the first defined style if not given, but you are
9248 encouraged to use this directive.
9251 \begin_layout Description
9252 \begin_inset Flex Code
9255 \begin_layout Plain Layout
9262 \begin_inset Flex Code
9265 \begin_layout Plain Layout
9271 ] This tag indicates that the module (which is specified by filename without
9273 \begin_inset Flex Code
9276 \begin_layout Plain Layout
9282 extension) cannot be used with this document class.
9283 This might be used in a journal-specific layout file to prevent, say, the
9285 \begin_inset Flex Code
9288 \begin_layout Plain Layout
9294 module that numbers theorems by section.
9299 be used in a module.
9300 Modules have their own way of excluding other modules (see
9301 \begin_inset CommandInset ref
9303 reference "subsec:Layout-modules"
9310 \begin_layout Description
9311 \begin_inset Flex Code
9314 \begin_layout Plain Layout
9320 Defines a new float.
9322 \begin_inset CommandInset ref
9324 reference "subsec:Floats"
9330 \begin_inset Quotes eld
9334 \begin_inset Flex Code
9337 \begin_layout Plain Layout
9344 \begin_inset Quotes erd
9350 \begin_layout Description
9351 \begin_inset Flex Code
9354 \begin_layout Plain Layout
9360 Sets the information that will be output in the
9361 \begin_inset Flex Code
9364 \begin_layout Plain Layout
9370 block when this document class is output to XHTML.
9371 Note that this will completely override any prior
9372 \begin_inset Flex Code
9375 \begin_layout Plain Layout
9382 \begin_inset Flex Code
9385 \begin_layout Plain Layout
9393 \begin_inset Newline newline
9397 \begin_inset Flex Code
9400 \begin_layout Plain Layout
9406 if you just want to add material to the preamble.) Must end with
9407 \begin_inset Quotes eld
9411 \begin_inset Flex Code
9414 \begin_layout Plain Layout
9421 \begin_inset Quotes erd
9427 \begin_layout Description
9428 \begin_inset Flex Code
9431 \begin_layout Plain Layout
9438 \begin_inset Flex Code
9441 \begin_layout Plain Layout
9447 ] The style to use for the table of contents, bibliography, and so forth,
9448 when the document is output to HTML.
9449 For articles, this should normally be
9450 \begin_inset Flex Code
9453 \begin_layout Plain Layout
9460 \begin_inset Flex Code
9463 \begin_layout Plain Layout
9470 If it is not given, then \SpecialChar LyX
9471 will attempt to figure out which layout to use.
9474 \begin_layout Description
9475 \begin_inset Flex Code
9478 \begin_layout Plain Layout
9485 \begin_inset Flex Code
9488 \begin_layout Plain Layout
9494 ] Modifies the properties of the given counter.
9495 If the counter does not exist, the statement is ignored.
9497 \begin_inset Quotes eld
9501 \begin_inset Flex Code
9504 \begin_layout Plain Layout
9511 \begin_inset Quotes erd
9515 \begin_inset Newline newline
9519 \begin_inset CommandInset ref
9521 reference "subsec:Counters"
9525 for details on counters.
9528 \begin_layout Description
9529 \begin_inset Flex Code
9532 \begin_layout Plain Layout
9539 \begin_inset Flex Code
9542 \begin_layout Plain Layout
9548 ] This allows you to include another layout definition file within yours
9549 to avoid duplicating commands.
9550 Common examples are the standard layout files, for example,
9551 \begin_inset Flex Code
9554 \begin_layout Plain Layout
9560 , which contains most of the basic layouts.
9563 \begin_layout Description
9564 \begin_inset Flex Code
9567 \begin_layout Plain Layout
9574 \begin_inset Flex Code
9577 \begin_layout Plain Layout
9583 ] This section (re-)defines the layout of an inset.
9584 It can be applied to an existing inset or to a new, user-defined inset,
9585 e.g., a new character style.
9587 \begin_inset Quotes eld
9591 \begin_inset Flex Code
9594 \begin_layout Plain Layout
9601 \begin_inset Quotes erd
9605 \begin_inset Newline newline
9609 \begin_inset CommandInset ref
9611 reference "subsec:Flex-insets-and"
9615 for more information.
9619 \begin_layout Description
9620 \begin_inset Flex Code
9623 \begin_layout Plain Layout
9630 \begin_inset Flex Code
9633 \begin_layout Plain Layout
9639 ] A string that indicates the width of the left margin on the screen, for
9641 \begin_inset Quotes eld
9645 \begin_inset Flex Code
9648 \begin_layout Plain Layout
9655 \begin_inset Quotes erd
9659 (Note that this is not a `length', like
9660 \begin_inset Quotes eld
9664 \begin_inset Quotes erd
9670 \begin_layout Description
9671 \begin_inset Flex Code
9674 \begin_layout Plain Layout
9681 \begin_inset Flex Code
9684 \begin_layout Plain Layout
9690 ] An integer that determines the maximal number of names displayed in an
9691 author-year citation before the citation switches to
9692 \begin_inset Quotes eld
9696 \begin_inset Quotes erd
9700 Primarily used in cite engine files (see
9701 \begin_inset CommandInset ref
9703 reference "subsec:Cite-Engine-Files"
9713 \begin_layout Description
9714 \begin_inset Flex Code
9717 \begin_layout Plain Layout
9724 \begin_inset Flex Code
9727 \begin_layout Plain Layout
9733 ] Modifies the properties of the given paragraph style.
9734 If the style does not exist, this section is ignored.
9736 \begin_inset Quotes eld
9740 \begin_inset Flex Code
9743 \begin_layout Plain Layout
9750 \begin_inset Quotes erd
9756 \begin_layout Description
9757 \begin_inset Flex Code
9760 \begin_layout Plain Layout
9767 \begin_inset Flex Code
9770 \begin_layout Plain Layout
9776 ] Deletes an existing counter, usually one defined in an included file.
9779 \begin_layout Description
9780 \begin_inset Flex Code
9783 \begin_layout Plain Layout
9790 \begin_inset Flex Code
9793 \begin_layout Plain Layout
9799 ] Deletes an existing float.
9800 This is particularly useful when you want to suppress a float that has
9801 been defined in an input file.
9804 \begin_layout Description
9805 \begin_inset Flex Code
9808 \begin_layout Plain Layout
9815 \begin_inset Flex Code
9818 \begin_layout Plain Layout
9824 ] Deletes an existing style.
9827 \begin_layout Description
9828 \begin_inset Flex Code
9831 \begin_layout Plain Layout
9838 \begin_inset Flex Code
9841 \begin_layout Plain Layout
9848 \begin_inset Flex Code
9851 \begin_layout Plain Layout
9857 ] Define a new table of contents with type
9858 \begin_inset Flex Code
9861 \begin_layout Plain Layout
9868 \begin_inset Flex Code
9871 \begin_layout Plain Layout
9878 See also the AddToToc commands.
9881 \begin_layout Description
9882 \begin_inset Flex Code
9885 \begin_layout Plain Layout
9892 \begin_inset Flex Code
9895 \begin_layout Plain Layout
9901 ] The file format (as defined in the \SpecialChar LyX
9902 preferences) produced by this document
9904 It is mainly useful when
9905 \begin_inset Flex Code
9908 \begin_layout Plain Layout
9915 \begin_inset Flex Code
9918 \begin_layout Plain Layout
9924 and one wants to define a new type of literate document.
9925 The format is reset to
9926 \begin_inset Quotes eld
9930 \begin_inset Flex Code
9933 \begin_layout Plain Layout
9940 \begin_inset Quotes erd
9944 \begin_inset Quotes eld
9948 \begin_inset Flex Code
9951 \begin_layout Plain Layout
9958 \begin_inset Quotes erd
9961 when the corresponding
9962 \begin_inset Flex Code
9965 \begin_layout Plain Layout
9971 parameter is encountered.
9974 \begin_layout Description
9975 \begin_inset Flex Code
9978 \begin_layout Plain Layout
9985 \begin_inset Flex Code
9988 \begin_layout Plain Layout
9999 \begin_inset Flex Code
10002 \begin_layout Plain Layout
10009 \begin_inset Flex Code
10012 \begin_layout Plain Layout
10018 ] Specifies what sort of output documents using this class will produce.
10021 \begin_layout Description
10022 \begin_inset Flex Code
10025 \begin_layout Plain Layout
10032 \begin_inset Flex Code
10035 \begin_layout Plain Layout
10042 \begin_inset Flex Code
10045 \begin_layout Plain Layout
10051 ] Specifies options, given in the second string, for the package named by
10054 \begin_inset Quotes eld
10058 \begin_inset Flex Code
10061 \begin_layout Plain Layout
10062 PackageOptions natbib square
10068 \begin_inset Quotes erd
10072 \begin_inset Flex Code
10075 \begin_layout Plain Layout
10081 to be loaded with the
10082 \begin_inset Flex Code
10085 \begin_layout Plain Layout
10092 (For \SpecialChar TeX
10093 perts, this causes \SpecialChar LyX
10095 \begin_inset Flex Code
10098 \begin_layout Plain Layout
10101 PassOptionsToPackage{natbib}{square}
10107 \begin_inset Flex Code
10110 \begin_layout Plain Layout
10119 \begin_layout Description
10120 \begin_inset Flex Code
10123 \begin_layout Plain Layout
10130 \begin_inset Flex Code
10133 \begin_layout Plain Layout
10142 \begin_inset Flex Code
10145 \begin_layout Plain Layout
10152 \begin_inset Flex Code
10155 \begin_layout Plain Layout
10161 ] The default pagestyle.
10162 Can be changed in the
10163 \begin_inset Flex Noun
10166 \begin_layout Plain Layout
10167 Document\SpecialChar menuseparator
10176 \begin_layout Description
10177 \begin_inset Flex Code
10180 \begin_layout Plain Layout
10186 Sets the preamble for the \SpecialChar LaTeX
10188 Note that this will completely override any prior
10189 \begin_inset Flex Code
10192 \begin_layout Plain Layout
10199 \begin_inset Flex Code
10202 \begin_layout Plain Layout
10210 \begin_inset Flex Code
10213 \begin_layout Plain Layout
10219 if you just want to add material to the preamble.) Must end with
10220 \begin_inset Quotes eld
10224 \begin_inset Flex Code
10227 \begin_layout Plain Layout
10234 \begin_inset Quotes erd
10240 \begin_layout Description
10241 \begin_inset Flex Code
10244 \begin_layout Plain Layout
10251 \begin_inset Flex Code
10254 \begin_layout Plain Layout
10261 \begin_inset Flex Code
10264 \begin_layout Plain Layout
10273 \begin_inset space \thinspace{}
10277 \begin_inset Flex Code
10280 \begin_layout Plain Layout
10286 ] Whether the class already provides the feature
10287 \begin_inset Flex Code
10290 \begin_layout Plain Layout
10297 A feature is in general the name of a package (e.
10298 \begin_inset space \thinspace{}
10302 \begin_inset space \space{}
10306 \begin_inset Flex Code
10309 \begin_layout Plain Layout
10316 \begin_inset Flex Code
10319 \begin_layout Plain Layout
10326 \begin_inset space \thinspace{}
10330 \begin_inset space \space{}
10334 \begin_inset Flex Code
10337 \begin_layout Plain Layout
10344 \begin_inset Flex Code
10347 \begin_layout Plain Layout
10355 \begin_inset CommandInset ref
10357 reference "chap:List-of-functions"
10361 for the list of features.
10364 \begin_layout Description
10365 \begin_inset Flex Code
10368 \begin_layout Plain Layout
10375 \begin_inset Flex Code
10378 \begin_layout Plain Layout
10384 ] Indicates that this layout provides the functionality of the module mentioned,
10385 which should be specified by the filename without the
10386 \begin_inset Flex Code
10389 \begin_layout Plain Layout
10396 This will typically be used if the layout includes the module directly,
10397 rather than using the
10398 \begin_inset Flex Code
10401 \begin_layout Plain Layout
10407 tag to indicate that it ought to be used.
10408 It could also be used in a module that provided an alternate implementation
10409 of the same functionality.
10412 \begin_layout Description
10413 \begin_inset Flex Code
10416 \begin_layout Plain Layout
10423 \begin_inset Flex Code
10426 \begin_layout Plain Layout
10432 ] Creates a new paragraph style if it does not already exist.
10433 If the style does exist, this section is ignored.
10435 \begin_inset Quotes eld
10439 \begin_inset Flex Code
10442 \begin_layout Plain Layout
10449 \begin_inset Quotes erd
10455 \begin_layout Description
10456 \begin_inset Flex Code
10459 \begin_layout Plain Layout
10466 \begin_inset Flex Code
10469 \begin_layout Plain Layout
10475 ] Whether the class requires the feature
10476 \begin_inset Flex Code
10479 \begin_layout Plain Layout
10486 Multiple features must be separated by commas.
10487 Note that you can only request supported features.
10489 \begin_inset CommandInset ref
10491 reference "chap:List-of-functions"
10495 for the list of features.).
10496 If you require a package with specific options, you can additionally use
10498 \begin_inset Flex Code
10501 \begin_layout Plain Layout
10510 \begin_layout Description
10511 \begin_inset Flex Code
10514 \begin_layout Plain Layout
10521 \begin_inset Flex Code
10524 \begin_layout Plain Layout
10530 ] A string that indicates the width of the right margin on the screen, for
10532 \begin_inset Quotes eld
10536 \begin_inset Flex Code
10539 \begin_layout Plain Layout
10546 \begin_inset Quotes erd
10552 \begin_layout Description
10553 \begin_inset Flex Code
10556 \begin_layout Plain Layout
10563 \begin_inset Flex Code
10566 \begin_layout Plain Layout
10572 ] Sets which divisions get numbered.
10574 \begin_inset Newline newline
10578 \begin_inset Flex Code
10581 \begin_layout Plain Layout
10587 counter in \SpecialChar LaTeX
10591 \begin_layout Description
10592 \begin_inset Flex Code
10595 \begin_layout Plain Layout
10602 \begin_inset Flex Code
10605 \begin_layout Plain Layout
10614 \begin_inset space \thinspace{}
10618 \begin_inset Flex Code
10621 \begin_layout Plain Layout
10627 ] Whether the class-default should be printing on one or both sides of the
10629 Can be changed in the
10630 \begin_inset Flex Noun
10633 \begin_layout Plain Layout
10634 Document\SpecialChar menuseparator
10643 \begin_layout Description
10644 \begin_inset Flex Code
10647 \begin_layout Plain Layout
10654 \begin_inset Flex Code
10657 \begin_layout Plain Layout
10663 ] This sequence defines a paragraph style.
10664 If the style does not yet exist, it is created; if it does exist, its parameter
10667 \begin_inset Quotes eld
10671 \begin_inset Flex Code
10674 \begin_layout Plain Layout
10681 \begin_inset Quotes erd
10685 \begin_inset Newline newline
10689 \begin_inset CommandInset ref
10691 reference "subsec:Paragraph-Styles"
10695 for details on paragraph styles.
10698 \begin_layout Description
10699 \begin_inset Flex Code
10702 \begin_layout Plain Layout
10709 \begin_inset Flex Code
10712 \begin_layout Plain Layout
10718 ] The name of the command or environment to be used with
10719 \begin_inset Flex Code
10722 \begin_layout Plain Layout
10731 \begin_layout Description
10732 \begin_inset Flex Code
10735 \begin_layout Plain Layout
10742 \begin_inset Flex Code
10745 \begin_layout Plain Layout
10754 \begin_inset Flex Code
10757 \begin_layout Plain Layout
10763 ] Indicates what kind of markup is used to define the title of a document.
10765 \begin_inset Flex Code
10768 \begin_layout Plain Layout
10774 means that the macro with name
10775 \begin_inset Flex Code
10778 \begin_layout Plain Layout
10784 will be inserted after the last layout which has
10785 \begin_inset Quotes eld
10789 \begin_inset Flex Code
10792 \begin_layout Plain Layout
10794 \begin_inset space ~
10803 \begin_inset Quotes erd
10808 \begin_inset Flex Code
10811 \begin_layout Plain Layout
10817 corresponds to the case where all layouts which have
10818 \begin_inset Quotes eld
10822 \begin_inset Flex Code
10825 \begin_layout Plain Layout
10827 \begin_inset space ~
10836 \begin_inset Quotes erd
10839 should be enclosed into the
10840 \begin_inset Flex Code
10843 \begin_layout Plain Layout
10852 \begin_layout Description
10853 \begin_inset Flex Code
10856 \begin_layout Plain Layout
10863 \begin_inset Flex Code
10866 \begin_layout Plain Layout
10872 ] Sets which divisions are included in the table of contents.
10874 \begin_inset Flex Code
10877 \begin_layout Plain Layout
10883 counter in \SpecialChar LaTeX
10887 \begin_layout Subsection
10888 \begin_inset Flex Code
10891 \begin_layout Plain Layout
10898 \begin_inset CommandInset label
10900 name "subsec:ClassOptions"
10907 \begin_layout Standard
10909 \begin_inset Flex Code
10912 \begin_layout Plain Layout
10918 section can contain the following entries:
10921 \begin_layout Description
10922 \begin_inset Flex Code
10925 \begin_layout Plain Layout
10932 \begin_inset Flex Code
10935 \begin_layout Plain Layout
10941 ] The list of available font sizes for the document's main font, separated
10943 \begin_inset Quotes eld
10947 \begin_inset Flex Code
10950 \begin_layout Plain Layout
10957 \begin_inset Quotes erd
10963 \begin_layout Description
10964 \begin_inset Flex Code
10967 \begin_layout Plain Layout
10973 Used to set the DTD line with XML-based output classes.
10975 \begin_inset space \thinspace{}
10979 \begin_inset Quotes eld
10982 -//OASIS//DTD DocBook V4.2//EN
10983 \begin_inset Quotes erd
10989 \begin_layout Description
10990 \begin_inset Flex Code
10993 \begin_layout Plain Layout
11000 \begin_inset Flex Code
11003 \begin_layout Plain Layout
11004 string="empty|plain|headings|fancy"
11009 ] The list of available page sty\SpecialChar softhyphen
11011 \begin_inset Quotes eld
11015 \begin_inset Flex Code
11018 \begin_layout Plain Layout
11025 \begin_inset Quotes erd
11031 \begin_layout Description
11032 \begin_inset Flex Code
11035 \begin_layout Plain Layout
11042 \begin_inset Flex Code
11045 \begin_layout Plain Layout
11051 ] Some document class options, separated by a comma, that will be added
11052 to the optional part of the
11053 \begin_inset Flex Code
11056 \begin_layout Plain Layout
11067 \begin_layout Standard
11069 \begin_inset Flex Code
11072 \begin_layout Plain Layout
11078 section must end with
11079 \begin_inset Quotes eld
11083 \begin_inset Flex Code
11086 \begin_layout Plain Layout
11093 \begin_inset Quotes erd
11099 \begin_layout Subsection
11101 \begin_inset CommandInset label
11103 name "subsec:Paragraph-Styles"
11110 \begin_layout Standard
11111 A paragraph style description looks like this:
11115 \begin_layout Plain Layout
11116 Note that this will either define a new style or modify an existing one.
11124 \begin_layout LyX-Code
11131 \begin_layout LyX-Code
11135 \begin_layout LyX-Code
11139 \begin_layout Standard
11140 where the following commands are allowed:
11143 \begin_layout Description
11144 \begin_inset Flex Code
11147 \begin_layout Plain Layout
11154 \begin_inset Flex Code
11157 \begin_layout Plain Layout
11163 =""] This paragraph will appear in the table of contents of the given type.
11164 An empty string disables.
11165 See also the OutlinerName and the IsTocCaption commands.
11169 \begin_layout Description
11170 \begin_inset Flex Code
11173 \begin_layout Plain Layout
11180 \begin_inset Flex Code
11183 \begin_layout Plain Layout
11188 , left, right, center
11193 ] Paragraph alignment.
11196 \begin_layout Description
11197 \begin_inset Flex Code
11200 \begin_layout Plain Layout
11207 \begin_inset Flex Code
11210 \begin_layout Plain Layout
11215 , left, right, center
11220 ] A comma separated list of permitted alignments.
11221 (Some \SpecialChar LaTeX
11222 styles prohibit certain alignments, since those wouldn't make sense.
11223 For example a right-aligned or centered enumeration isn't possible.)
11226 \begin_layout Description
11227 \begin_inset Flex Code
11230 \begin_layout Plain Layout
11237 \begin_inset Flex Code
11240 \begin_layout Plain Layout
11246 ] Defines argument number <int> of a command\SpecialChar breakableslash
11247 environment associated with
11249 This is useful for things like section headings, and only makes sense with
11252 Every (optional or required) argument of a command or environment – except
11253 for the required argument that is associated with the content of the paragraph
11254 itself – has a separate definition, where the number specifies the order
11256 The definition must end with
11257 \begin_inset Flex Code
11260 \begin_layout Plain Layout
11267 So a command with two optional arguments has:
11271 \begin_layout Quote
11277 \begin_layout Quote
11283 \begin_layout Quote
11289 \begin_layout Quote
11295 \begin_layout Quote
11301 \begin_layout Quote
11307 \begin_layout Standard
11309 \begin_inset Flex Code
11312 \begin_layout Plain Layout
11318 definition, the following specifications are possible:
11321 \begin_layout Itemize
11322 \begin_inset Flex Code
11325 \begin_layout Plain Layout
11332 \begin_inset Flex Code
11335 \begin_layout Plain Layout
11341 The string that will appear both in the menu (to insert this argument)
11342 and on the argument inset button (unless you also specify a separate
11343 \begin_inset Flex Code
11346 \begin_layout Plain Layout
11353 For the menu, you can define an accelerator by appending the respective
11354 character to the string, divided by
11355 \begin_inset Quotes eld
11359 \begin_inset Quotes erd
11363 \begin_inset space \thinspace{}
11367 \begin_inset space \space{}
11371 \begin_inset Quotes eld
11375 \begin_inset Flex Code
11378 \begin_layout Plain Layout
11385 \begin_inset Quotes erd
11391 \begin_layout Itemize
11392 \begin_inset Flex Code
11395 \begin_layout Plain Layout
11402 \begin_inset Flex Code
11405 \begin_layout Plain Layout
11411 A separate string for the menu.
11412 You can define an accelerator by appending the respective character to
11413 the string, divided by
11414 \begin_inset Quotes eld
11418 \begin_inset Quotes erd
11422 \begin_inset space \thinspace{}
11426 \begin_inset space \space{}
11430 \begin_inset Quotes eld
11434 \begin_inset Flex Code
11437 \begin_layout Plain Layout
11444 \begin_inset Quotes erd
11448 This specification is optional.
11449 If it is not given the
11450 \begin_inset Flex Code
11453 \begin_layout Plain Layout
11459 will be used instead for the menu.
11462 \begin_layout Itemize
11463 \begin_inset Flex Code
11466 \begin_layout Plain Layout
11473 \begin_inset Flex Code
11476 \begin_layout Plain Layout
11482 A longer explanatory text that appears in the tooltip when hovering over
11483 the argument inset.
11486 \begin_layout Itemize
11487 \begin_inset Flex Code
11490 \begin_layout Plain Layout
11497 \begin_inset Flex Code
11500 \begin_layout Plain Layout
11509 \begin_inset space \thinspace{}
11513 \begin_inset Flex Code
11516 \begin_layout Plain Layout
11522 ] Declare if this is a mandatory (1) or an optional (0) argument.
11523 Mandatory arguments will be output empty if not given, while optional arguments
11524 will not be output at all.
11525 By default, mandatory arguments are delimited by
11526 \begin_inset Flex Code
11529 \begin_layout Plain Layout
11535 , while optional arguments are delimited by
11536 \begin_inset Flex Code
11539 \begin_layout Plain Layout
11548 \begin_layout Itemize
11549 \begin_inset Flex Code
11552 \begin_layout Plain Layout
11559 \begin_inset Flex Code
11562 \begin_layout Plain Layout
11568 defines another argument (by its number) which this argument requires to
11569 be output if it is itself output.
11571 \begin_inset space \thinspace{}
11574 g., in \SpecialChar LaTeX
11575 commands, optional arguments often require previous optional arguments
11576 to be output (at least empty), as in
11577 \begin_inset Flex Code
11580 \begin_layout Plain Layout
11583 command[][argument]{text}
11589 This can be achieved by the statement
11590 \begin_inset Flex Code
11593 \begin_layout Plain Layout
11600 \begin_inset Flex Code
11603 \begin_layout Plain Layout
11612 \begin_layout Itemize
11613 \begin_inset Flex Code
11616 \begin_layout Plain Layout
11623 \begin_inset Flex Code
11626 \begin_layout Plain Layout
11632 defines a custom left delimiter (instead of
11633 \begin_inset Flex Code
11636 \begin_layout Plain Layout
11643 \begin_inset Flex Code
11646 \begin_layout Plain Layout
11653 A line break in the output can be indicated by
11654 \begin_inset Flex Code
11657 \begin_layout Plain Layout
11666 \begin_layout Itemize
11667 \begin_inset Flex Code
11670 \begin_layout Plain Layout
11677 \begin_inset Flex Code
11680 \begin_layout Plain Layout
11686 defines a custom right delimiter (instead of
11687 \begin_inset Flex Code
11690 \begin_layout Plain Layout
11697 \begin_inset Flex Code
11700 \begin_layout Plain Layout
11707 A line break in the output can be indicated by
11708 \begin_inset Flex Code
11711 \begin_layout Plain Layout
11720 \begin_layout Itemize
11721 \begin_inset Flex Code
11724 \begin_layout Plain Layout
11731 \begin_inset Flex Code
11734 \begin_layout Plain Layout
11740 defines an argument that is inserted if and only if no user-specified arguments
11742 \begin_inset space \thinspace{}
11746 \begin_inset space \space{}
11749 if no argument inset has been inserted (note that also an empty argument
11750 inset omits the DefaultArg).
11751 Multiple arguments need to be separated by comma.
11754 \begin_layout Itemize
11755 \begin_inset Flex Code
11758 \begin_layout Plain Layout
11765 \begin_inset Flex Code
11768 \begin_layout Plain Layout
11774 defines an argument that is inserted in any case (alone or in addition
11775 to user-specified arguments).
11776 Multiple arguments need to be separated by comma.
11779 \begin_layout Itemize
11780 \begin_inset Flex Code
11783 \begin_layout Plain Layout
11789 The font used for the argument content, see
11790 \begin_inset CommandInset ref
11792 reference "subsec:Font-description"
11799 \begin_layout Itemize
11800 \begin_inset Flex Code
11803 \begin_layout Plain Layout
11809 The font used for the label; see
11810 \begin_inset CommandInset ref
11812 reference "subsec:Font-description"
11819 \begin_layout Itemize
11820 \begin_inset Flex Code
11823 \begin_layout Plain Layout
11830 \begin_inset Flex Code
11833 \begin_layout Plain Layout
11838 , Minimalistic, Conglomerate
11843 ] describes the rendering style used for the inset's frame and buttons.
11846 \begin_layout Itemize
11847 \begin_inset Flex Code
11850 \begin_layout Plain Layout
11857 \begin_inset Flex Code
11860 \begin_layout Plain Layout
11867 \begin_inset Flex Code
11870 \begin_layout Plain Layout
11876 , this argument is automatically inserted when the respective style is selected.
11877 Currently, only one argument per style\SpecialChar breakableslash
11878 layout can be automatically inserted.
11881 \begin_layout Itemize
11882 \begin_inset Flex Code
11885 \begin_layout Plain Layout
11892 \begin_inset Flex Code
11895 \begin_layout Plain Layout
11902 \begin_inset Flex Code
11905 \begin_layout Plain Layout
11911 , this argument will be inserted with a copy of the co-text (either selected
11912 text or the whole paragraph) as content.
11915 \begin_layout Itemize
11916 \begin_inset Flex Code
11919 \begin_layout Plain Layout
11926 \begin_inset Flex Code
11929 \begin_layout Plain Layout
11939 ] Whether the contents of this argument should be output in raw form, meaning
11940 without special translations that \SpecialChar LaTeX
11943 \begin_inset Flex Code
11946 \begin_layout Plain Layout
11952 status is inherited by the inset or paragraph layout the argument belongs
11953 to, true and false change the status for the given argument only.
11956 \begin_layout Itemize
11957 \begin_inset Flex Code
11960 \begin_layout Plain Layout
11967 \begin_inset Flex Code
11970 \begin_layout Plain Layout
11971 string of characters
11980 Defines individual characters that should be output in raw form, meaning
11981 without special translations that \SpecialChar LaTeX
11983 Note that, contrary to PassThru, this needs to be explicitly defined for
11985 That is, arguments do not inherit PassThruChars from their parent inset
11989 \begin_layout Itemize
11990 \begin_inset Flex Code
11993 \begin_layout Plain Layout
12000 \begin_inset Flex Code
12003 \begin_layout Plain Layout
12012 \begin_inset space \thinspace{}
12016 \begin_inset Flex Code
12019 \begin_layout Plain Layout
12025 ] If this is set to 1, the argument will output its content in the corresponding
12026 item in the table of contents.
12030 \begin_layout Standard
12031 By default, the text entered in the \SpecialChar LyX
12032 workarea in the respective layout is
12033 the last (mandatory) argument of a command if the
12034 \begin_inset Flex Code
12037 \begin_layout Plain Layout
12044 \begin_inset Flex Code
12047 \begin_layout Plain Layout
12054 However, arguments with the prefix
12055 \begin_inset Flex Code
12058 \begin_layout Plain Layout
12064 are output after this workarea argument.
12065 Note that post-argument numbering restarts at 1, so the first argument
12066 following the workarea argument is
12067 \begin_inset Flex Code
12070 \begin_layout Plain Layout
12077 Post-arguments are ignored in any other
12078 \begin_inset Flex Code
12081 \begin_layout Plain Layout
12088 \begin_inset Flex Code
12091 \begin_layout Plain Layout
12100 \begin_layout Standard
12102 \begin_inset Flex Code
12105 \begin_layout Plain Layout
12114 \begin_inset Flex Code
12117 \begin_layout Plain Layout
12126 \begin_inset Flex Code
12129 \begin_layout Plain Layout
12135 followed by the number (e.
12136 \begin_inset space \thinspace{}
12140 \begin_inset space \space{}
12144 \begin_inset Flex Code
12147 \begin_layout Plain Layout
12157 \begin_layout Description
12158 \begin_inset Flex Code
12161 \begin_layout Plain Layout
12167 Note that this will completely override any prior
12168 \begin_inset Flex Code
12171 \begin_layout Plain Layout
12177 declaration for this style.
12179 \begin_inset Quotes eld
12183 \begin_inset Flex Code
12186 \begin_layout Plain Layout
12193 \begin_inset Quotes erd
12198 \begin_inset CommandInset ref
12200 reference "subsec:I18n"
12204 for details on its use.
12207 \begin_layout Description
12208 \begin_inset Flex Code
12211 \begin_layout Plain Layout
12218 \begin_inset Flex Code
12221 \begin_layout Plain Layout
12231 \begin_layout Plain Layout
12232 Note that a `float' here is a real number, such as: 1.5.
12237 The vertical space with which the last of a chain of paragraphs with this
12238 style is separated from the following paragraph.
12239 If the next paragraph has another style, the separations are not simply
12240 added, but the maximum is taken.
12243 \begin_layout Description
12244 \begin_inset Flex Code
12247 \begin_layout Plain Layout
12254 \begin_inset Flex Code
12257 \begin_layout Plain Layout
12263 ] The category for this style.
12264 This is used to group related styles in the style combobox on the toolbar.
12265 Any string can be used, but you may want to use existing categories with
12270 \begin_layout Description
12271 \begin_inset Flex Code
12274 \begin_layout Plain Layout
12280 Depth of XML command.
12281 Used only with XML-type formats.
12284 \begin_layout Description
12285 \begin_inset Flex Code
12288 \begin_layout Plain Layout
12295 \begin_inset Flex Code
12298 \begin_layout Plain Layout
12304 ] Copies all the features of an existing style into the current one.
12308 \begin_layout Description
12309 \begin_inset Flex Code
12312 \begin_layout Plain Layout
12319 \begin_inset Flex Code
12322 \begin_layout Plain Layout
12328 ] The name of a style whose preamble should be output
12333 This allows to ensure some ordering of the preamble snippets when macros
12334 definitions depend on one another.
12338 \begin_layout Plain Layout
12339 Note that, besides that functionality, there is no way to ensure any ordering
12341 The ordering that you see in a given version of \SpecialChar LyX
12342 may change without warning
12351 \begin_layout Description
12352 \begin_inset Flex Code
12355 \begin_layout Plain Layout
12362 \begin_inset Flex Code
12365 \begin_layout Plain Layout
12370 , Box, Filled_Box, Static
12375 ] The type of label that stands at the end of the paragraph (or sequence
12377 \begin_inset Flex Code
12380 \begin_layout Plain Layout
12387 \begin_inset Newline newline
12391 \begin_inset Flex Code
12394 \begin_layout Plain Layout
12401 \begin_inset Flex Code
12404 \begin_layout Plain Layout
12411 \begin_inset Flex Code
12414 \begin_layout Plain Layout
12422 \begin_inset Flex Code
12425 \begin_layout Plain Layout
12432 \begin_inset Quotes eld
12436 \begin_inset Quotes erd
12440 \begin_inset Flex Code
12443 \begin_layout Plain Layout
12450 \begin_inset space \space{}
12454 \begin_inset Flex Code
12457 \begin_layout Plain Layout
12463 ) is a white (resp.
12464 \begin_inset space ~
12467 black) square suitable for end of proof markers,
12468 \begin_inset Flex Code
12471 \begin_layout Plain Layout
12477 is an explicit text string.
12480 \begin_layout Description
12481 \begin_inset Flex Code
12484 \begin_layout Plain Layout
12491 \begin_inset Flex Code
12494 \begin_layout Plain Layout
12500 ] The string used for a label with a
12501 \begin_inset Flex Code
12504 \begin_layout Plain Layout
12511 \begin_inset Newline newline
12515 \begin_inset Flex Code
12518 \begin_layout Plain Layout
12528 \begin_layout Description
12529 \begin_inset Flex Code
12532 \begin_layout Plain Layout
12538 The font used for both the text body
12544 \begin_inset CommandInset ref
12546 reference "subsec:Font-description"
12551 Note that defining this font automatically defines the
12552 \begin_inset Flex Code
12555 \begin_layout Plain Layout
12562 So you should define this one first if you also want to define
12563 \begin_inset Flex Code
12566 \begin_layout Plain Layout
12575 \begin_layout Description
12576 \begin_inset Flex Code
12579 \begin_layout Plain Layout
12586 \begin_inset Flex Code
12589 \begin_layout Plain Layout
12595 ] Used for backporting new styles to stable \SpecialChar LyX
12597 The first stable version that supports this tag is \SpecialChar LyX
12599 The argument is a number which may either be 0, -1 or any value greater
12602 \begin_inset Flex Code
12605 \begin_layout Plain Layout
12611 flag of a style is greater than zero, it will always be written to the
12613 If a .lyx file is read, the style definitions from the document header are
12614 added to the document class.
12615 Therefore even older \SpecialChar LyX
12616 versions can handle the style.
12618 \begin_inset Flex Code
12621 \begin_layout Plain Layout
12627 is a version number: if the style is read, and the version number is less
12628 than the version number of the already existing style in the document class,
12629 the new style is ignored.
12630 If the version number is greater, the new style replaces the existing style.
12631 A value of -1 means an infinite version number, i.
12632 \begin_inset space \thinspace{}
12636 \begin_inset space \space{}
12639 the style is always used.
12642 \begin_layout Description
12643 \begin_inset Flex Code
12646 \begin_layout Plain Layout
12653 \begin_inset Flex Code
12656 \begin_layout Plain Layout
12665 \begin_inset space \thinspace{}
12669 \begin_inset Flex Code
12672 \begin_layout Plain Layout
12678 ] Usually \SpecialChar LyX
12679 does not allow you to insert more than one space between words,
12680 since a space is considered as the separation between two words, not a
12681 character or symbol of its own.
12682 This is a very fine thing but sometimes annoying, for example, when typing
12683 program code or plain \SpecialChar LaTeX
12686 \begin_inset Flex Code
12689 \begin_layout Plain Layout
12696 Note that \SpecialChar LyX
12697 will create protected blanks for the additional blanks when
12698 in another mode than \SpecialChar LaTeX
12702 \begin_layout Description
12703 \begin_inset Flex Code
12706 \begin_layout Plain Layout
12712 These tags are used with XHTML output.
12714 \begin_inset CommandInset ref
12716 reference "subsec:Paragraph-Style-XHTML"
12723 \begin_layout Description
12724 \begin_inset Flex Code
12727 \begin_layout Plain Layout
12733 [FIXME] (Used only with XML-type formats.)
12736 \begin_layout Description
12737 \begin_inset Flex Code
12740 \begin_layout Plain Layout
12747 \begin_inset Flex Code
12750 \begin_layout Plain Layout
12759 \begin_inset space \thinspace{}
12763 \begin_inset Flex Code
12766 \begin_layout Plain Layout
12773 \begin_inset Flex Code
12776 \begin_layout Plain Layout
12782 , marks the style as to be included in the document preamble and not in
12784 This is useful for document classes that want such information as the title
12785 and author to appear in the preamble.
12786 Note that this works only for styles for which the
12787 \begin_inset Flex Code
12790 \begin_layout Plain Layout
12797 \begin_inset Flex Code
12800 \begin_layout Plain Layout
12807 \begin_inset Flex Code
12810 \begin_layout Plain Layout
12819 \begin_layout Description
12820 \begin_inset Flex Code
12823 \begin_layout Plain Layout
12830 \begin_inset Flex Code
12833 \begin_layout Plain Layout
12842 \begin_inset space \thinspace{}
12846 \begin_inset Flex Code
12849 \begin_layout Plain Layout
12856 \begin_inset Flex Code
12859 \begin_layout Plain Layout
12865 , marks the style as being part of a title block (see also the
12866 \begin_inset Flex Code
12869 \begin_layout Plain Layout
12876 \begin_inset Flex Code
12879 \begin_layout Plain Layout
12888 \begin_layout Description
12889 \begin_inset Flex Code
12892 \begin_layout Plain Layout
12899 \begin_inset Flex Code
12902 \begin_layout Plain Layout
12911 \begin_inset space \thinspace{}
12915 \begin_inset Flex Code
12918 \begin_layout Plain Layout
12924 ] If this is set to 1 and AddToToc is enabled, the paragraph adds a summary
12925 of its contents in its item in the table of contents.
12926 Otherwise, only the label, if it exists, appears.
12929 \begin_layout Description
12930 \begin_inset Flex Code
12933 \begin_layout Plain Layout
12940 \begin_inset Flex Code
12943 \begin_layout Plain Layout
12949 ] The \SpecialChar LaTeX
12950 command sequence declaring an item in a list.
12951 The command is to be defined without the preceding backslash (the default
12953 \begin_inset Quotes eld
12957 \begin_inset Quotes erd
12961 \begin_inset Flex Code
12964 \begin_layout Plain Layout
12972 in the \SpecialChar LaTeX
12976 \begin_layout Description
12977 \begin_inset Flex Code
12980 \begin_layout Plain Layout
12987 \begin_inset Flex Code
12990 \begin_layout Plain Layout
12996 ] This provides extra space between paragraphs that have the same style.
12997 If you put other styles into an environment, each is separated with the
12999 \begin_inset Flex Code
13002 \begin_layout Plain Layout
13009 But the whole items of the environment are additionally separated with
13011 \begin_inset Flex Code
13014 \begin_layout Plain Layout
13021 Note that this is a
13026 \begin_layout Description
13027 \begin_inset Flex Code
13030 \begin_layout Plain Layout
13036 [FIXME] (Used only with XML-type formats.)
13039 \begin_layout Description
13040 \begin_inset Flex Code
13043 \begin_layout Plain Layout
13050 \begin_inset Flex Code
13053 \begin_layout Plain Layout
13062 \begin_inset space \thinspace{}
13066 \begin_inset Flex Code
13069 \begin_layout Plain Layout
13075 ] Usually \SpecialChar LyX
13076 does not allow you to leave a paragraph empty, since it would
13077 lead to empty \SpecialChar LaTeX
13079 There are some cases where this could be desirable however: in a letter
13080 template, the required fields can be provided as empty fields, so that
13081 people do not forget them; in some special classes, a style can be used
13082 as some kind of break, which does not contain actual text.
13085 \begin_layout Description
13086 \begin_inset Flex Code
13089 \begin_layout Plain Layout
13096 \begin_inset Flex Code
13099 \begin_layout Plain Layout
13105 ] The vertical space between the label and the text body.
13106 Only used for labels that are above the text body (
13107 \begin_inset Flex Code
13110 \begin_layout Plain Layout
13117 \begin_inset Newline newline
13121 \begin_inset Flex Code
13124 \begin_layout Plain Layout
13125 Centered_Top_Environment
13133 \begin_layout Description
13134 \begin_inset Flex Code
13137 \begin_layout Plain Layout
13144 \begin_inset Flex Code
13147 \begin_layout Plain Layout
13153 ] The name of the counter for automatic numbering.
13154 In order to have the counter appear with your label, you will need to reference
13156 \begin_inset Flex Code
13159 \begin_layout Plain Layout
13168 This will work with
13169 \begin_inset Flex Code
13172 \begin_layout Plain Layout
13179 \begin_inset Flex Code
13182 \begin_layout Plain Layout
13189 \begin_inset Flex Code
13192 \begin_layout Plain Layout
13199 \begin_inset Flex Code
13202 \begin_layout Plain Layout
13209 \begin_inset Newline newline
13217 \begin_inset Flex Code
13220 \begin_layout Plain Layout
13227 \begin_inset Flex Code
13230 \begin_layout Plain Layout
13236 , though this case is a bit complicated.
13237 Suppose you declare
13238 \begin_inset Quotes eld
13242 \begin_inset Flex Code
13245 \begin_layout Plain Layout
13246 LabelCounter myenum
13252 \begin_inset Quotes erd
13256 Then the actual counters used are
13257 \begin_inset Flex Code
13260 \begin_layout Plain Layout
13267 \begin_inset Flex Code
13270 \begin_layout Plain Layout
13277 \begin_inset Flex Code
13280 \begin_layout Plain Layout
13287 \begin_inset Flex Code
13290 \begin_layout Plain Layout
13296 , much as in \SpecialChar LaTeX
13298 These counters must all be declared separately.
13299 \begin_inset Newline newline
13303 \begin_inset CommandInset ref
13305 reference "subsec:Counters"
13309 for details on counters.
13312 \begin_layout Description
13313 \begin_inset Flex Code
13316 \begin_layout Plain Layout
13322 The font used for the label.
13324 \begin_inset CommandInset ref
13326 reference "subsec:Font-description"
13333 \begin_layout Description
13334 \begin_inset Flex Code
13337 \begin_layout Plain Layout
13344 \begin_inset Flex Code
13347 \begin_layout Plain Layout
13353 ] Text that indicates how far a label should be indented.
13356 \begin_layout Description
13357 \begin_inset Flex Code
13360 \begin_layout Plain Layout
13367 \begin_inset Flex Code
13370 \begin_layout Plain Layout
13376 ] Text that indicates the amount of horizontal space between the label and
13378 Only used for labels that are not above the text body.
13381 \begin_layout Description
13382 \begin_inset Flex Code
13385 \begin_layout Plain Layout
13392 \begin_inset Flex Code
13395 \begin_layout Plain Layout
13401 ] The string used for the label.
13403 \begin_inset Flex Code
13406 \begin_layout Plain Layout
13412 is set, this string can be contain the special formatting commands described
13414 \begin_inset CommandInset ref
13416 reference "subsec:Counters"
13423 \begin_layout Description
13424 \begin_inset Flex Code
13427 \begin_layout Plain Layout
13428 LabelStringAppendix
13434 \begin_inset Flex Code
13437 \begin_layout Plain Layout
13443 ] This is used inside the appendix instead of
13444 \begin_inset Newline newline
13448 \begin_inset Flex Code
13451 \begin_layout Plain Layout
13459 \begin_inset Flex Code
13462 \begin_layout Plain Layout
13469 \begin_inset Newline newline
13473 \begin_inset Flex Code
13476 \begin_layout Plain Layout
13477 LabelStringAppendix
13485 \begin_layout Description
13486 \begin_inset Flex Code
13489 \begin_layout Plain Layout
13495 [FIXME] (Used only with XML-type formats.)
13498 \begin_layout Description
13499 \begin_inset Flex Code
13502 \begin_layout Plain Layout
13509 \begin_inset Flex Code
13512 \begin_layout Plain Layout
13517 , Manual, Static, Above,
13518 \begin_inset Newline newline
13521 Centered, Sensitive, Enumerate,
13522 \begin_inset Newline newline
13525 Itemize, Bibliography
13534 \begin_layout Description
13535 \begin_inset Flex Code
13538 \begin_layout Plain Layout
13544 means the label is the very first word (up to the first real blank).
13545 Use protected spaces if you want more than one word as the label.
13549 \begin_layout Description
13550 \begin_inset Flex Code
13553 \begin_layout Plain Layout
13559 means the label is simply what is declared as
13560 \begin_inset Flex Code
13563 \begin_layout Plain Layout
13570 This will be displayed
13571 \begin_inset Quotes eld
13575 \begin_inset Quotes erd
13578 , at the beginning of the paragraph.
13580 \begin_inset Flex Code
13583 \begin_layout Plain Layout
13590 \begin_inset Flex Code
13593 \begin_layout Plain Layout
13599 , then it will be displayed only in the first paragraph of any sequence
13600 of paragraphs with the same
13601 \begin_inset Flex Code
13604 \begin_layout Plain Layout
13613 \begin_layout Description
13614 \begin_inset Flex Code
13617 \begin_layout Plain Layout
13624 \begin_inset space ~
13628 \begin_inset space ~
13632 \begin_inset Flex Code
13635 \begin_layout Plain Layout
13641 are special cases of
13642 \begin_inset Flex Code
13645 \begin_layout Plain Layout
13652 The label will be printed above the paragraph either at the beginning of
13653 the line or centered.
13656 \begin_layout Description
13657 \begin_inset Flex Code
13660 \begin_layout Plain Layout
13666 is a special case for the caption-labels
13667 \begin_inset Quotes eld
13671 \begin_inset Quotes erd
13675 \begin_inset Quotes eld
13679 \begin_inset Quotes erd
13683 \begin_inset Newline newline
13687 \begin_inset Flex Code
13690 \begin_layout Plain Layout
13696 means the (hardcoded) label string depends on the kind of float: It is
13697 hardcoded to be `FloatType N', where N is the value of the counter associated
13699 For the case that a caption is inserted outside of a float the
13700 \begin_inset Flex Code
13703 \begin_layout Plain Layout
13710 \begin_inset Quotes eld
13714 \begin_inset Quotes erd
13720 \begin_layout Description
13721 \begin_inset Flex Code
13724 \begin_layout Plain Layout
13730 produces the usual sort of enumeration labels.
13732 \change_deleted 424524441 1511752012
13733 At present, it is hardcoded to use Arabic numerals, lowercase letters, small
13734 Roman numerals, and uppercase letters for the four possible depths.
13735 \change_inserted 424524441 1511752012
13736 The label type needs to be set in the Counter.
13738 \begin_inset CommandInset ref
13740 reference "subsec:Counters"
13749 \begin_layout Description
13750 \begin_inset Flex Code
13753 \begin_layout Plain Layout
13759 produces various bullets at the different levels.
13761 \change_deleted 424524441 1511752024
13762 It is also hardcoded.
13763 \change_inserted 424524441 1511752031
13764 The bullet types displayed can be set via Document\SpecialChar menuseparator
13765 Settings\SpecialChar menuseparator
13771 \begin_layout Description
13772 \begin_inset Flex Code
13775 \begin_layout Plain Layout
13781 should be used only with
13782 \begin_inset Flex Code
13785 \begin_layout Plain Layout
13786 LatexType BibEnvironment
13795 \begin_layout Description
13796 \begin_inset Flex Code
13799 \begin_layout Plain Layout
13805 Note that this will completely override any prior
13806 \begin_inset Flex Code
13809 \begin_layout Plain Layout
13815 declaration for this style.
13817 \begin_inset Quotes eld
13821 \begin_inset Flex Code
13824 \begin_layout Plain Layout
13831 \begin_inset Quotes erd
13836 \begin_inset CommandInset ref
13838 reference "subsec:I18n"
13842 for details on its use.
13845 \begin_layout Description
13846 \begin_inset Flex Code
13849 \begin_layout Plain Layout
13856 \begin_inset Flex Code
13859 \begin_layout Plain Layout
13865 ] The name of the corresponding \SpecialChar LaTeX
13867 Either the environment or command name.
13870 \begin_layout Description
13871 \begin_inset Flex Code
13874 \begin_layout Plain Layout
13881 \begin_inset Flex Code
13884 \begin_layout Plain Layout
13890 ] An optional parameter for the corresponding
13891 \begin_inset Flex Code
13894 \begin_layout Plain Layout
13901 This parameter cannot be changed from within \SpecialChar LyX
13903 \begin_inset Flex Code
13906 \begin_layout Plain Layout
13912 for customizable parameters).
13913 This will be output as is after all \SpecialChar LaTeX
13915 \begin_inset Flex Code
13918 \begin_layout Plain Layout
13927 \begin_layout Description
13928 \begin_inset Flex Code
13931 \begin_layout Plain Layout
13938 \begin_inset Flex Code
13941 \begin_layout Plain Layout
13946 , Command, Environment, Item_Environment,
13947 \begin_inset Newline newline
13950 List_Environment, Bib_Environment
13955 ] How the style should be translated into \SpecialChar LaTeX
13960 \begin_layout Plain Layout
13961 \begin_inset Flex Code
13964 \begin_layout Plain Layout
13970 is perhaps a bit misleading, since these rules apply to SGML classes, too.
13971 Visit the SGML class files for specific examples.
13980 \begin_layout Description
13981 \begin_inset Flex Code
13984 \begin_layout Plain Layout
13990 means nothing special.
13993 \begin_layout Description
13994 \begin_inset Flex Code
13997 \begin_layout Plain Layout
14004 \begin_inset Flex Code
14007 \begin_layout Plain Layout
14014 {\SpecialChar ldots
14023 \begin_layout Description
14024 \begin_inset Flex Code
14027 \begin_layout Plain Layout
14034 \begin_inset Flex Code
14037 \begin_layout Plain Layout
14044 }\SpecialChar ldots
14060 \begin_layout Description
14061 \begin_inset Flex Code
14064 \begin_layout Plain Layout
14071 \begin_inset Flex Code
14074 \begin_layout Plain Layout
14081 \begin_inset Flex Code
14084 \begin_layout Plain Layout
14092 is generated for each paragraph of this environment.
14096 \begin_layout Description
14097 \begin_inset Flex Code
14100 \begin_layout Plain Layout
14107 \begin_inset Flex Code
14110 \begin_layout Plain Layout
14117 \begin_inset Newline newline
14121 \begin_inset Flex Code
14124 \begin_layout Plain Layout
14130 is passed as an argument to the environment.
14131 \begin_inset Newline newline
14135 \begin_inset Flex Code
14138 \begin_layout Plain Layout
14144 can be defined in the
14145 \begin_inset Flex Noun
14148 \begin_layout Plain Layout
14149 Edit\SpecialChar menuseparator
14151 \begin_inset space ~
14162 \begin_layout Description
14163 \begin_inset Flex Code
14166 \begin_layout Plain Layout
14173 \begin_inset Flex Code
14176 \begin_layout Plain Layout
14182 but adds the necessary mandatory argument (the longest label) to the begin
14183 statement of the bibliography environment:
14184 \begin_inset Newline newline
14188 \begin_inset Flex Code
14191 \begin_layout Plain Layout
14194 begin{thebibliography}{99}
14200 It is therefore only useful for bibliography environments.
14201 The default longest label
14202 \begin_inset Quotes eld
14206 \begin_inset Quotes erd
14209 can be changed by the user in the paragraph settings of a bibliography
14213 \begin_layout Standard
14214 Putting the last few things together, the \SpecialChar LaTeX
14215 output will be either:
14218 \begin_layout LyX-Code
14221 LatexName[LatexParam]{\SpecialChar ldots
14225 \begin_layout Standard
14229 \begin_layout LyX-Code
14232 begin{LatexName}[LatexParam] \SpecialChar ldots
14238 \begin_layout Standard
14239 depending upon the \SpecialChar LaTeX
14244 \begin_layout Description
14245 \begin_inset Flex Code
14248 \begin_layout Plain Layout
14255 \begin_inset Flex Code
14258 \begin_layout Plain Layout
14264 ] A string that is put at the beginning of the style content.
14265 A line break in the output can be indicated by
14266 \begin_inset Flex Code
14269 \begin_layout Plain Layout
14278 \begin_layout Description
14279 \begin_inset Flex Code
14282 \begin_layout Plain Layout
14289 \begin_inset Flex Code
14292 \begin_layout Plain Layout
14298 ] If you put styles into environments, the different
14299 \begin_inset Flex Code
14302 \begin_layout Plain Layout
14308 are not simply added, but added with a factor
14309 \begin_inset Formula $\frac{4}{\mathrm{depth}+4}$
14313 Note that this parameter is also used when
14314 \begin_inset Flex Code
14317 \begin_layout Plain Layout
14324 \begin_inset Flex Code
14327 \begin_layout Plain Layout
14334 \begin_inset Flex Code
14337 \begin_layout Plain Layout
14344 Then it is added to the manual or dynamic margin.
14345 \begin_inset Newline newline
14349 \begin_inset Quotes eld
14353 \begin_inset Flex Code
14356 \begin_layout Plain Layout
14363 \begin_inset Quotes erd
14366 means that the paragraph is indented with the width of
14367 \begin_inset Quotes eld
14371 \begin_inset Flex Code
14374 \begin_layout Plain Layout
14381 \begin_inset Quotes erd
14384 in the normal font.
14385 You can get a negative width by prefixing the string with
14386 \begin_inset Quotes eld
14390 \begin_inset Flex Code
14393 \begin_layout Plain Layout
14400 \begin_inset Quotes erd
14404 This way was chosen so that the look is the same with each used screen
14408 \begin_layout Description
14409 \begin_inset Flex Code
14412 \begin_layout Plain Layout
14419 \begin_inset Flex Code
14422 \begin_layout Plain Layout
14427 , Manual, Dynamic, First_Dynamic, Right_Address_Box
14433 \begin_inset Newline newline
14436 The kind of margin that the style has on the left side.
14440 \begin_layout Description
14441 \begin_inset Flex Code
14444 \begin_layout Plain Layout
14450 just means a fixed margin.
14453 \begin_layout Description
14454 \begin_inset Flex Code
14457 \begin_layout Plain Layout
14463 means that the left margin depends on the string entered in the
14464 \begin_inset Flex Noun
14467 \begin_layout Plain Layout
14468 Edit\SpecialChar menuseparator
14470 \begin_inset space ~
14479 This is used to typeset nice lists without tabulators.
14482 \begin_layout Description
14483 \begin_inset Flex Code
14486 \begin_layout Plain Layout
14492 means that the margin depends on the size of the label.
14493 This is used for automatic enumerated headlines.
14494 It is obvious that the headline
14495 \begin_inset Quotes eld
14498 5.4.3.2.1 Very long headline
14499 \begin_inset Quotes erd
14502 must have a wider left margin (as wide as
14503 \begin_inset Quotes eld
14507 \begin_inset Quotes erd
14510 plus the space) than
14511 \begin_inset Quotes eld
14514 3.2 Very long headline
14515 \begin_inset Quotes erd
14519 \begin_inset Quotes eld
14523 \begin_inset Quotes erd
14526 are not able to do this.
14529 \begin_layout Description
14530 \begin_inset Flex Code
14533 \begin_layout Plain Layout
14539 is similar, but only the very first row of the paragraph is dynamic, while
14540 the others are static; this is used, for example, for descriptions.
14543 \begin_layout Description
14544 \begin_inset Flex Code
14547 \begin_layout Plain Layout
14553 means the margin is chosen in a way that the longest row of this paragraph
14554 fits to the right margin.
14555 This is used to typeset an address on the right edge of the page.
14559 \begin_layout Description
14560 \begin_inset Flex Code
14563 \begin_layout Plain Layout
14570 \begin_inset Flex Code
14573 \begin_layout Plain Layout
14582 \begin_inset space \thinspace{}
14586 \begin_inset Flex Code
14589 \begin_layout Plain Layout
14595 ] Whether fragile commands in this style should be
14596 \begin_inset Flex Code
14599 \begin_layout Plain Layout
14612 whether this command should itself be protected.)
14615 \begin_layout Description
14616 \begin_inset Flex Code
14619 \begin_layout Plain Layout
14626 \begin_inset Flex Code
14629 \begin_layout Plain Layout
14636 \begin_inset space \thinspace{}
14640 \begin_inset Flex Code
14643 \begin_layout Plain Layout
14651 ] Whether newlines are translated into \SpecialChar LaTeX
14653 \begin_inset Flex Code
14656 \begin_layout Plain Layout
14667 The translation can be switched off to allow more comfortable \SpecialChar LaTeX
14669 inside \SpecialChar LyX
14673 \begin_layout Description
14674 \begin_inset Flex Code
14677 \begin_layout Plain Layout
14684 \begin_inset Flex Code
14687 \begin_layout Plain Layout
14696 \begin_inset space \thinspace{}
14700 \begin_inset Flex Code
14703 \begin_layout Plain Layout
14709 ] If set to true, and if
14710 \begin_inset Flex Code
14713 \begin_layout Plain Layout
14720 \begin_inset Flex Code
14723 \begin_layout Plain Layout
14729 ) paragraphs are being indented, then the indentation of such a paragraph
14730 following one of this type will be suppressed.
14731 (So this will not affect the display of non-default paragraphs.)
14734 \begin_layout Description
14735 \begin_inset Flex Code
14738 \begin_layout Plain Layout
14745 \begin_inset Flex Code
14748 \begin_layout Plain Layout
14754 ] Name of a style that has replaced this style.
14755 This is used to rename a style, while keeping backward compatibility.
14758 \begin_layout Description
14759 \begin_inset Flex Code
14762 \begin_layout Plain Layout
14769 \begin_inset Flex Code
14772 \begin_layout Plain Layout
14779 \begin_inset space \thinspace{}
14783 \begin_inset Flex Code
14786 \begin_layout Plain Layout
14792 ] Determines whether consecutive paragraphs of the same type are treated
14793 as belonging together.
14794 This has the effect that the
14795 \begin_inset Flex Code
14798 \begin_layout Plain Layout
14804 is only printed once before such a group.
14805 By default, this is true for
14806 \begin_inset Flex Code
14809 \begin_layout Plain Layout
14816 \begin_inset Flex Code
14819 \begin_layout Plain Layout
14826 \begin_inset Flex Code
14829 \begin_layout Plain Layout
14835 and false for all other types.
14838 \begin_layout Description
14839 \begin_inset Flex Code
14842 \begin_layout Plain Layout
14849 \begin_inset Flex Code
14852 \begin_layout Plain Layout
14861 \begin_inset space \thinspace{}
14865 \begin_inset Flex Code
14868 \begin_layout Plain Layout
14874 ] Indicates that paragraphs will not be separated by an empty line in \SpecialChar LaTeX
14876 but only by a line break; together with
14877 \begin_inset Flex Code
14880 \begin_layout Plain Layout
14886 , this allows to emulate a plain text editor (like the ERT inset).
14889 \begin_layout Description
14890 \begin_inset Flex Code
14893 \begin_layout Plain Layout
14900 \begin_inset Flex Code
14903 \begin_layout Plain Layout
14909 ] The indent of the very first line of a paragraph.
14911 \begin_inset Newline newline
14915 \begin_inset Flex Code
14918 \begin_layout Plain Layout
14924 will be fixed for a certain style.
14925 The exception is the default style, since the indentation for these paragraphs
14926 can be prohibited with
14927 \begin_inset Flex Code
14930 \begin_layout Plain Layout
14938 \begin_inset Flex Code
14941 \begin_layout Plain Layout
14947 style paragraphs inside environments use the
14948 \begin_inset Flex Code
14951 \begin_layout Plain Layout
14957 of the environment, not their native one.
14959 \begin_inset Flex Code
14962 \begin_layout Plain Layout
14968 paragraphs inside an enumeration are not indented.
14971 \begin_layout Description
14972 \begin_inset Flex Code
14975 \begin_layout Plain Layout
14982 \begin_inset Flex Code
14985 \begin_layout Plain Layout
14991 ] The vertical space between two paragraphs of this style.
14994 \begin_layout Description
14995 \begin_inset Flex Code
14998 \begin_layout Plain Layout
15005 \begin_inset Flex Code
15008 \begin_layout Plain Layout
15015 allows the user to choose either
15016 \begin_inset Quotes eld
15020 \begin_inset Quotes erd
15024 \begin_inset Quotes eld
15028 \begin_inset Quotes erd
15031 to separate paragraphs.
15033 \begin_inset Quotes eld
15037 \begin_inset Quotes erd
15041 \begin_inset Flex Code
15044 \begin_layout Plain Layout
15052 \begin_inset Quotes eld
15056 \begin_inset Quotes erd
15060 \begin_inset Flex Code
15063 \begin_layout Plain Layout
15069 is ignored and all paragraphs are separated by the
15070 \begin_inset Flex Code
15073 \begin_layout Plain Layout
15080 The vertical space is calculated with
15081 \begin_inset Flex Code
15084 \begin_layout Plain Layout
15086 \begin_inset space ~
15095 \begin_inset Flex Code
15098 \begin_layout Plain Layout
15104 is the height of a row with the normal font.
15105 This way, the look stays the same with different screen fonts.
15108 \begin_layout Description
15109 \begin_inset Flex Code
15112 \begin_layout Plain Layout
15119 \begin_inset Flex Code
15122 \begin_layout Plain Layout
15131 \begin_inset space \thinspace{}
15135 \begin_inset Flex Code
15138 \begin_layout Plain Layout
15144 ] Whether the contents of this paragraph should be output in raw form, meaning
15145 without special translations that \SpecialChar LaTeX
15149 \begin_layout Description
15150 \begin_inset Flex Code
15153 \begin_layout Plain Layout
15160 \begin_inset Flex Code
15163 \begin_layout Plain Layout
15173 Defines individual characters that should be output in raw form, meaning
15174 without special translations that \SpecialChar LaTeX
15178 \begin_layout Description
15179 \begin_inset Flex Code
15182 \begin_layout Plain Layout
15188 Information to be included in the \SpecialChar LaTeX
15189 preamble when this style is used.
15190 Used to define macros, load packages, etc., required by this particular
15193 \begin_inset Quotes eld
15197 \begin_inset Flex Code
15200 \begin_layout Plain Layout
15207 \begin_inset Quotes erd
15213 \begin_layout Description
15214 \begin_inset Flex Code
15217 \begin_layout Plain Layout
15224 \begin_inset Flex Code
15227 \begin_layout Plain Layout
15233 ] The prefix to use when creating labels referring to paragraphs of this
15235 This allows the use of formatted references.
15238 \begin_layout Description
15239 \begin_inset Flex Code
15242 \begin_layout Plain Layout
15249 \begin_inset Flex Code
15252 \begin_layout Plain Layout
15258 ] Whether the style requires the feature
15259 \begin_inset Flex Code
15262 \begin_layout Plain Layout
15269 \begin_inset CommandInset ref
15271 reference "chap:List-of-functions"
15275 for the list of features).
15276 If you require a package with specific options, you can additionally use
15278 \begin_inset Flex Code
15281 \begin_layout Plain Layout
15287 as a general text class parameter (see
15288 \begin_inset CommandInset ref
15290 reference "subsec:General-text-class"
15297 \begin_layout Description
15298 \begin_inset Flex Code
15301 \begin_layout Plain Layout
15308 \begin_inset Flex Code
15311 \begin_layout Plain Layout
15320 \begin_inset Flex Code
15323 \begin_layout Plain Layout
15329 ] Resets the \SpecialChar LaTeX
15330 arguments of this style (as defined via the
15331 \begin_inset Flex Code
15334 \begin_layout Plain Layout
15341 This is useful if you have copied a style via
15342 \begin_inset Flex Code
15345 \begin_layout Plain Layout
15351 , but you do not want to inherit its (required and optional) arguments.
15354 \begin_layout Description
15355 \begin_inset Flex Code
15358 \begin_layout Plain Layout
15365 \begin_inset Flex Code
15368 \begin_layout Plain Layout
15377 \begin_inset Flex Code
15380 \begin_layout Plain Layout
15386 ] Resumes a counter that is usually reset at each new sequence of layouts.
15387 This is currently only useful when
15388 \begin_inset Flex Code
15391 \begin_layout Plain Layout
15398 \begin_inset Flex Code
15401 \begin_layout Plain Layout
15410 \begin_layout Description
15411 \begin_inset Flex Code
15414 \begin_layout Plain Layout
15421 \begin_inset Flex Code
15424 \begin_layout Plain Layout
15430 ] A string that is put at the end of the layout content.
15431 A line break in the output can be indicated by
15432 \begin_inset Flex Code
15435 \begin_layout Plain Layout
15444 \begin_layout Description
15445 \begin_inset Flex Code
15448 \begin_layout Plain Layout
15455 \begin_inset Flex Code
15458 \begin_layout Plain Layout
15465 \begin_inset Flex Code
15468 \begin_layout Plain Layout
15477 \begin_layout Description
15478 \begin_inset Flex Code
15481 \begin_layout Plain Layout
15488 \begin_inset Flex Code
15491 \begin_layout Plain Layout
15500 \begin_inset Flex Code
15503 \begin_layout Plain Layout
15510 \begin_inset Flex Code
15513 \begin_layout Plain Layout
15520 \begin_inset Flex Code
15523 \begin_layout Plain Layout
15525 \begin_inset space ~
15533 ] This defines what the default spacing should be in the style.
15535 \begin_inset Flex Code
15538 \begin_layout Plain Layout
15545 \begin_inset Flex Code
15548 \begin_layout Plain Layout
15555 \begin_inset Flex Code
15558 \begin_layout Plain Layout
15564 correspond respectively to a multiplier value of 1, 1.25 and 1.667.
15565 If you specify the argument
15566 \begin_inset Flex Code
15569 \begin_layout Plain Layout
15575 , then you must also provide a value argument which will be the actual multiplie
15577 Note that, contrary to other parameters,
15578 \begin_inset Flex Code
15581 \begin_layout Plain Layout
15587 implies the generation of specific \SpecialChar LaTeX
15588 code, using the \SpecialChar LaTeX
15592 \begin_inset Flex Code
15595 \begin_layout Plain Layout
15604 \begin_layout Description
15605 \begin_inset Flex Code
15608 \begin_layout Plain Layout
15615 \begin_inset Flex Code
15618 \begin_layout Plain Layout
15625 \begin_inset space \thinspace{}
15629 \begin_inset Flex Code
15632 \begin_layout Plain Layout
15640 ] Allow spell-checking paragraphs of this style.
15644 \begin_layout Description
15645 \begin_inset Flex Code
15648 \begin_layout Plain Layout
15655 \begin_inset Flex Code
15658 \begin_layout Plain Layout
15667 \begin_inset Flex Code
15670 \begin_layout Plain Layout
15676 ] Steps the master counter of a given counter at the beginning of a new
15677 sequence of layouts.
15678 This is currently only useful when
15679 \begin_inset Flex Code
15682 \begin_layout Plain Layout
15689 \begin_inset Flex Code
15692 \begin_layout Plain Layout
15701 \begin_layout Description
15702 \begin_inset Flex Code
15705 \begin_layout Plain Layout
15711 The font used for the text body .
15713 \begin_inset CommandInset ref
15715 reference "subsec:Font-description"
15722 \begin_layout Description
15723 \begin_inset Flex Code
15726 \begin_layout Plain Layout
15735 \begin_inset Flex Code
15738 \begin_layout Plain Layout
15748 The level of the style in the table of contents.
15749 This is used for automatic numbering of section headings.
15752 \begin_layout Description
15753 \begin_inset Flex Code
15756 \begin_layout Plain Layout
15765 \begin_inset Flex Code
15768 \begin_layout Plain Layout
15779 \begin_inset Flex Code
15782 \begin_layout Plain Layout
15789 \begin_inset Flex Code
15792 \begin_layout Plain Layout
15798 ] This tag determines whether the first line indentation of this paragraph
15799 can be toggled via the Paragraph settings dialog.
15803 \begin_inset Flex Code
15806 \begin_layout Plain Layout
15816 is set, indentation can be toggled if the document settings use
15817 \begin_inset Quotes eld
15821 \begin_inset Quotes erd
15824 paragraph style, with
15825 \begin_inset Flex Code
15828 \begin_layout Plain Layout
15834 , indentation can always be toggled, notwithstanding the document settings,
15836 \begin_inset Flex Code
15839 \begin_layout Plain Layout
15845 , indentation can never be toggled.
15848 \begin_layout Description
15849 \begin_inset Flex Code
15852 \begin_layout Plain Layout
15859 \begin_inset Flex Code
15862 \begin_layout Plain Layout
15868 ] The vertical space with which the very first of a chain of paragraphs
15869 with this style is separated from the previous paragraph.
15870 If the previous paragraph has another style, the separations are not simply
15871 added, but the maximum is taken.
15874 \begin_layout Subsection
15875 \begin_inset CommandInset label
15881 Internationalization of Paragraph Styles
15884 \begin_layout Standard
15886 has long supported internationalization of layout information, but, until
15887 version 2.0, this applied only to the user interface and not to, say, PDF
15889 Thus, French authors were forced to resort to ugly hacks if they wanted
15894 1' instead of `Theorem 1'.
15895 Thanks to Georg Baum, that is no longer the case.
15898 \begin_layout Standard
15900 \begin_inset Flex Code
15903 \begin_layout Plain Layout
15909 defines text that is to appear in the typeset document, it may use
15910 \begin_inset Flex Code
15913 \begin_layout Plain Layout
15920 \begin_inset Flex Code
15923 \begin_layout Plain Layout
15929 to support non-English and even multi-language documents correctly.
15930 The following excerpt (from the
15931 \begin_inset Flex Code
15934 \begin_layout Plain Layout
15940 file) shows how this works:
15943 \begin_layout LyX-Code
15948 \begin_layout LyX-Code
15951 theoremstyle{remark}
15954 \begin_layout LyX-Code
15957 newtheorem{claim}[thm]{
15964 \begin_layout LyX-Code
15968 \begin_layout LyX-Code
15972 \begin_layout LyX-Code
15977 claimname}{_(Claim)}
15980 \begin_layout LyX-Code
15984 \begin_layout LyX-Code
15988 \begin_layout LyX-Code
15997 claimname}{_(Claim)}}
16000 \begin_layout LyX-Code
16005 \begin_layout Standard
16006 In principle, any legal \SpecialChar LaTeX
16008 \begin_inset Flex Code
16011 \begin_layout Plain Layout
16018 \begin_inset Flex Code
16021 \begin_layout Plain Layout
16027 tags, but in practice they will typically look as they do here.
16028 The key to correct translation of the typeset text is the definition of
16029 the \SpecialChar LaTeX
16031 \begin_inset Flex Code
16034 \begin_layout Plain Layout
16043 \begin_inset Flex Code
16046 \begin_layout Plain Layout
16058 \begin_layout Standard
16060 \begin_inset Flex Code
16063 \begin_layout Plain Layout
16069 tag provides for internationalization based upon the overall language of
16071 The contents of the tag will be included in the preamble, just as with
16073 \begin_inset Flex Code
16076 \begin_layout Plain Layout
16083 What makes it special is the use of the
16084 \begin_inset Quotes eld
16088 \begin_inset Quotes erd
16092 \begin_inset Flex Code
16095 \begin_layout Plain Layout
16101 , which will be replaced, when \SpecialChar LyX
16102 produces \SpecialChar LaTeX
16103 output, with the translation of
16104 its argument into the document language.
16107 \begin_layout Standard
16109 \begin_inset Flex Code
16112 \begin_layout Plain Layout
16118 tag is more complex, since it is meant to provide support for multi-language
16119 documents and so offers an interface to the
16120 \begin_inset Flex Code
16123 \begin_layout Plain Layout
16130 Its contents will be added to the preamble once for each language that
16131 appears in the document.
16132 In this case, the argument to
16133 \begin_inset Flex Code
16136 \begin_layout Plain Layout
16142 will be replaced with its translation into the language in question; the
16144 \begin_inset Flex Code
16147 \begin_layout Plain Layout
16153 is replaced by the language name (as used by the babel package).
16156 \begin_layout Standard
16157 A German document that also included a French section would thus have the
16158 following in the preamble:
16161 \begin_layout LyX-Code
16170 claimname}{Affirmation}}
16171 \begin_inset Newline newline
16182 claimname}{Behauptung}}
16183 \begin_inset Newline newline
16190 claimname}{Behauptung}
16193 \begin_layout Standard
16196 \begin_inset Flex Code
16199 \begin_layout Plain Layout
16205 will then conspire to produce the correct text in the output.
16208 \begin_layout Standard
16209 One important point to note here is that the translations are provided by
16211 itself, through the file
16212 \begin_inset Flex Code
16215 \begin_layout Plain Layout
16222 This means, in effect, that
16223 \begin_inset Flex Code
16226 \begin_layout Plain Layout
16233 \begin_inset Flex Code
16236 \begin_layout Plain Layout
16242 are really only of use in layout files that are provided with \SpecialChar LyX
16244 entered in user-created layout files will not be seen by \SpecialChar LyX
16245 's internationalizatio
16246 n routines unless the
16247 \begin_inset Flex Code
16250 \begin_layout Plain Layout
16256 file is modified accordingly.
16257 That said, however, any layout created with the intention that it will
16258 be included with \SpecialChar LyX
16259 should use these tags where appropriate.
16260 Please note that the paragraph style translations provided by \SpecialChar LyX
16262 change with a minor update (e.
16263 \begin_inset space \thinspace{}
16267 \begin_inset space \space{}
16270 from version 2.1.x to 2.1.y).
16271 It is however quite likely that a major update (e.
16272 \begin_inset space \thinspace{}
16276 \begin_inset space \space{}
16279 from 2.0.x to 2.1.0) will introduce new translations or corrections.
16282 \begin_layout Subsection
16284 \begin_inset CommandInset label
16286 name "subsec:Floats"
16293 \begin_layout Standard
16294 It is necessary to define the floats (
16295 \begin_inset Flex Noun
16298 \begin_layout Plain Layout
16305 \begin_inset Flex Noun
16308 \begin_layout Plain Layout
16314 , \SpecialChar ldots
16315 ) in the text class itself.
16316 Standard floats are included in the file
16317 \begin_inset Flex Code
16320 \begin_layout Plain Layout
16326 , so you may have to do no more than add
16329 \begin_layout LyX-Code
16330 Input stdfloats.inc
16333 \begin_layout Standard
16334 to your layout file.
16335 If you want to implement a text class that proposes some other float types
16336 (like the AGU class bundled with \SpecialChar LyX
16337 ), the information below will hopefully
16341 \begin_layout Description
16342 \begin_inset Flex Code
16345 \begin_layout Plain Layout
16352 \begin_inset Flex Code
16355 \begin_layout Plain Layout
16361 =!htbpH] Allowed placement options for this float type.
16362 The value is a string of placement characters.
16363 Possible characters include:
16368 \begin_inset Quotes eld
16372 \begin_inset Quotes erd
16380 \begin_inset Quotes eld
16384 \begin_inset Quotes erd
16392 \begin_inset Quotes eld
16396 \begin_inset Quotes erd
16404 \begin_inset Quotes eld
16408 \begin_inset Quotes erd
16416 \begin_inset Quotes eld
16420 \begin_inset Quotes erd
16428 \begin_inset Quotes eld
16432 \begin_inset Quotes erd
16436 The order of the characters in the string does not matter.
16437 If no placement options are allowed, use the string
16444 \begin_layout Description
16445 \begin_inset Flex Code
16448 \begin_layout Plain Layout
16455 \begin_inset Flex Code
16458 \begin_layout Plain Layout
16467 \begin_inset space \thinspace{}
16473 \begin_inset Flex Code
16476 \begin_layout Plain Layout
16486 ] Defines whether the float allows to be rotated via the \SpecialChar LaTeX
16493 \begin_inset Flex Code
16496 \begin_layout Plain Layout
16502 if the float does not support this feature.
16505 \begin_layout Description
16506 \begin_inset Flex Code
16509 \begin_layout Plain Layout
16516 \begin_inset Flex Code
16519 \begin_layout Plain Layout
16528 \begin_inset space \thinspace{}
16534 \begin_inset Flex Code
16537 \begin_layout Plain Layout
16547 ] Defines whether the float has a starred variant that spans columns in
16548 a two column paragraph.
16550 \begin_inset Flex Code
16553 \begin_layout Plain Layout
16559 if the float does not support this feature.
16562 \begin_layout Description
16563 \begin_inset Flex Code
16566 \begin_layout Plain Layout
16573 \begin_inset Flex Code
16576 \begin_layout Plain Layout
16583 \begin_inset Quotes erd
16587 \begin_inset Quotes erd
16590 ] The file name extension of an auxiliary file for the list of figures (or
16593 writes the captions to this file.
16596 \begin_layout Description
16597 \begin_inset Flex Code
16600 \begin_layout Plain Layout
16607 \begin_inset Flex Code
16610 \begin_layout Plain Layout
16617 \begin_inset Quotes erd
16621 \begin_inset Quotes erd
16624 ] The string that will be used in the menus and also for the caption.
16625 This is translated to the current language if babel is used.
16628 \begin_layout Description
16629 \begin_inset Flex Code
16632 \begin_layout Plain Layout
16638 These tags control the XHTML output.
16640 \begin_inset CommandInset ref
16642 reference "sec:Tags-for-XHTML"
16649 \begin_layout Description
16650 \begin_inset Flex Code
16653 \begin_layout Plain Layout
16662 \begin_inset Flex Code
16665 \begin_layout Plain Layout
16674 \begin_inset space \thinspace{}
16678 \begin_inset Flex Code
16681 \begin_layout Plain Layout
16687 ] Indicates whether the float is already defined in the document class or
16688 if instead the \SpecialChar LaTeX
16690 \begin_inset Flex Code
16693 \begin_layout Plain Layout
16699 needs to be loaded to define it on-the-fly.
16701 \begin_inset Flex Code
16704 \begin_layout Plain Layout
16711 \begin_inset Flex Code
16714 \begin_layout Plain Layout
16721 It should be set to
16722 \begin_inset Flex Code
16725 \begin_layout Plain Layout
16731 if the float is already defined by the \SpecialChar LaTeX
16735 \begin_layout Description
16736 \begin_inset Flex Code
16739 \begin_layout Plain Layout
16746 \begin_inset Flex Code
16749 \begin_layout Plain Layout
16756 \begin_inset Quotes erd
16760 \begin_inset Quotes erd
16763 ] The command used to generate a list of floats of this type; the leading
16772 \begin_inset Flex Code
16775 \begin_layout Plain Layout
16781 is false, since there is no standard way to generate this command.
16783 \begin_inset Flex Code
16786 \begin_layout Plain Layout
16792 is true, since in that case there is a standard way to define the command.
16795 \begin_layout Description
16796 \begin_inset Flex Code
16799 \begin_layout Plain Layout
16806 \begin_inset Flex Code
16809 \begin_layout Plain Layout
16816 \begin_inset Quotes erd
16820 \begin_inset Quotes erd
16823 ] A title for a list of floats of this kind (list of figures, tables, or
16825 It is used for the screen label within \SpecialChar LyX
16826 , it is used by \SpecialChar LaTeX
16828 it is used as the title in the XHTML output.
16829 It will be translated to the document language.
16832 \begin_layout Description
16833 \begin_inset Flex Code
16836 \begin_layout Plain Layout
16843 \begin_inset Flex Code
16846 \begin_layout Plain Layout
16853 \begin_inset Quotes erd
16857 \begin_inset Quotes erd
16860 ] This (optional) argument determines whether floats of this class will
16861 be numbered within some sectional unit of the document.
16863 \begin_inset Flex Code
16866 \begin_layout Plain Layout
16873 \begin_inset Quotes eld
16877 \begin_inset Flex Code
16880 \begin_layout Plain Layout
16887 \begin_inset Quotes erd
16890 , the floats will be numbered within chapters.
16894 \begin_layout Description
16895 \begin_inset Flex Code
16898 \begin_layout Plain Layout
16905 \begin_inset Flex Code
16908 \begin_layout Plain Layout
16915 \begin_inset Quotes erd
16919 \begin_inset Quotes erd
16922 ] The default placement for the given class of floats.
16923 The string should be as in standard \SpecialChar LaTeX
16925 \begin_inset Flex Code
16928 \begin_layout Plain Layout
16935 \begin_inset Flex Code
16938 \begin_layout Plain Layout
16945 \begin_inset Flex Code
16948 \begin_layout Plain Layout
16955 \begin_inset Flex Code
16958 \begin_layout Plain Layout
16964 for top, bottom, page, and here, respectively.
16968 \begin_layout Plain Layout
16969 Note that the order of these letters in the string is irrelevant, like in
16976 On top of that there is a new type,
16977 \begin_inset Flex Code
16980 \begin_layout Plain Layout
16986 , which does not really correspond to a float, since it means: put it
16987 \begin_inset Quotes eld
16991 \begin_inset Quotes erd
16995 Note however that the
16996 \begin_inset Flex Code
16999 \begin_layout Plain Layout
17005 specifier is special and, because of implementation details, cannot be
17006 used in non-built in float types.
17007 If you do not understand what this means, just use
17008 \begin_inset Quotes eld
17012 \begin_inset Flex Code
17015 \begin_layout Plain Layout
17022 \begin_inset Quotes erd
17028 \begin_layout Description
17029 \begin_inset Flex Code
17032 \begin_layout Plain Layout
17039 \begin_inset Flex Code
17042 \begin_layout Plain Layout
17048 ] The prefix to use when creating labels referring to floats of this type.
17049 This allows the use of formatted references.
17050 Note that you can remove any
17051 \begin_inset Flex Code
17054 \begin_layout Plain Layout
17060 set by a copied style by using the special value
17061 \begin_inset Quotes eld
17065 \begin_inset Quotes erd
17068 , which must be all caps.
17071 \begin_layout Description
17072 \begin_inset Flex Code
17075 \begin_layout Plain Layout
17082 \begin_inset Flex Code
17085 \begin_layout Plain Layout
17092 \begin_inset Quotes erd
17096 \begin_inset Quotes erd
17099 ] The style used when defining the float using
17100 \begin_inset Flex Code
17103 \begin_layout Plain Layout
17114 \begin_layout Description
17115 \begin_inset Flex Code
17118 \begin_layout Plain Layout
17125 \begin_inset Flex Code
17128 \begin_layout Plain Layout
17135 \begin_inset Quotes erd
17139 \begin_inset Quotes erd
17143 \begin_inset Quotes eld
17147 \begin_inset Quotes erd
17150 of the new class of floats, like program or algorithm.
17151 After the appropriate
17152 \begin_inset Flex Code
17155 \begin_layout Plain Layout
17164 \begin_inset Flex Code
17167 \begin_layout Plain Layout
17176 \begin_inset Flex Code
17179 \begin_layout Plain Layout
17190 \begin_layout Description
17191 \begin_inset Flex Code
17194 \begin_layout Plain Layout
17201 \begin_inset Flex Code
17204 \begin_layout Plain Layout
17211 \begin_inset space \thinspace{}
17215 \begin_inset Flex Code
17218 \begin_layout Plain Layout
17226 ] Specifies whether this float is defined using the \SpecialChar LaTeX
17228 \begin_inset Flex Code
17231 \begin_layout Plain Layout
17237 , either by the class file, another package or on-the-fly by \SpecialChar LyX
17241 \begin_layout Standard
17242 Note that defining a float with type
17243 \begin_inset Flex Code
17246 \begin_layout Plain Layout
17254 automatically defines the corresponding counter with name
17255 \begin_inset Flex Code
17258 \begin_layout Plain Layout
17269 \begin_layout Subsection
17270 Flex insets and InsetLayout
17271 \begin_inset CommandInset label
17273 name "subsec:Flex-insets-and"
17280 \begin_layout Standard
17281 Flex insets come in three different kinds:
17284 \begin_layout Itemize
17286 \begin_inset Flex Code
17289 \begin_layout Plain Layout
17295 ): These define semantic markup corresponding to such \SpecialChar LaTeX
17297 \begin_inset Flex Code
17300 \begin_layout Plain Layout
17309 \begin_inset Flex Code
17312 \begin_layout Plain Layout
17323 \begin_layout Itemize
17325 \begin_inset Flex Code
17328 \begin_layout Plain Layout
17334 ): These can be used to define custom collapsible insets, similar to \SpecialChar TeX
17336 footnote, and the like.
17337 An obvious example is an endnote inset, which is defined in the
17338 \begin_inset Flex Code
17341 \begin_layout Plain Layout
17350 \begin_layout Itemize
17352 \begin_inset Flex Code
17355 \begin_layout Plain Layout
17361 ): For use with DocBook classes.
17364 \begin_layout Standard
17365 Flex insets are defined using the
17366 \begin_inset Flex Code
17369 \begin_layout Plain Layout
17375 tag, which shall be explained in a moment.
17378 \begin_layout Standard
17380 \begin_inset Flex Code
17383 \begin_layout Plain Layout
17389 tag also serves another function: It can be used to customize the general
17390 layout of many different types of insets.
17392 \begin_inset Flex Code
17395 \begin_layout Plain Layout
17401 can be used to customize the layout parameters for footnotes, marginal
17402 notes, note insets, \SpecialChar TeX
17403 code (ERT) insets, branches, listings, indexes, boxes,
17404 tables, algorithms, URLs, and captions, as well as to define Flex insets.
17407 \begin_layout Standard
17409 \begin_inset Flex Code
17412 \begin_layout Plain Layout
17418 definition must begin with a line of the form:
17421 \begin_layout LyX-Code
17425 \begin_layout Standard
17427 \begin_inset Flex Code
17430 \begin_layout Plain Layout
17436 indicates the inset whose layout is being defined, and here there are four
17440 \begin_layout Enumerate
17441 The layout for a pre-existing inset is being modified.
17442 In this case, can be
17443 \begin_inset Flex Code
17446 \begin_layout Plain Layout
17452 any one of the following:
17453 \begin_inset Flex Code
17456 \begin_layout Plain Layout
17463 \begin_inset Flex Code
17466 \begin_layout Plain Layout
17473 \begin_inset Flex Code
17476 \begin_layout Plain Layout
17483 \begin_inset Flex Code
17486 \begin_layout Plain Layout
17493 \begin_inset Flex Code
17496 \begin_layout Plain Layout
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
17655 \begin_layout Enumerate
17656 The layout for a Flex inset is being defined.
17658 \begin_inset Flex Code
17661 \begin_layout Plain Layout
17667 must be of the form
17668 \begin_inset Quotes eld
17672 \begin_inset Flex Code
17675 \begin_layout Plain Layout
17682 \begin_inset Quotes erd
17686 \begin_inset Flex Code
17689 \begin_layout Plain Layout
17695 may be be any valid identifier not used by a pre-existing Flex inset.
17696 The identifier may include spaces, but in that case the whole thing must
17697 be wrapped in quotes.
17698 Note that the definition of a flex inset
17703 \begin_inset Flex Code
17706 \begin_layout Plain Layout
17712 entry, declaring which type of inset it defines.
17715 \begin_layout Enumerate
17716 The layout for user specific branch is being defined.
17718 \begin_inset Flex Code
17721 \begin_layout Plain Layout
17727 must be of the form
17728 \begin_inset Quotes eld
17732 \begin_inset Flex Code
17735 \begin_layout Plain Layout
17742 \begin_inset Quotes erd
17746 \begin_inset Flex Code
17749 \begin_layout Plain Layout
17755 may be be any valid identifier of branch defined in user's document.
17756 The identifier may include spaces, but in that case the whole thing must
17757 be wrapped in quotes.
17758 The main purpose of this feature is to allow \SpecialChar LaTeX
17759 wrapping around specific
17760 branches as user needs.
17763 \begin_layout Enumerate
17764 The layout of a user (or class) specific caption is being defined.
17766 \begin_inset Flex Code
17769 \begin_layout Plain Layout
17775 must be of the form
17776 \begin_inset Quotes eld
17780 \begin_inset Flex Code
17783 \begin_layout Plain Layout
17790 \begin_inset Quotes erd
17794 \begin_inset Flex Code
17797 \begin_layout Plain Layout
17803 specifies the name of the caption as it appears in the menu.
17804 Have a look at the standard caption (
17805 \begin_inset Flex Code
17808 \begin_layout Plain Layout
17814 ), the specific captions of the KOMA-Script classes (
17815 \begin_inset Flex Code
17818 \begin_layout Plain Layout
17825 \begin_inset Flex Code
17828 \begin_layout Plain Layout
17837 \begin_inset space ~
17843 \begin_inset Flex Code
17846 \begin_layout Plain Layout
17852 ) for applications.
17855 \begin_layout Standard
17857 \begin_inset Flex Code
17860 \begin_layout Plain Layout
17866 definition can contain the following entries:
17869 \begin_layout Description
17870 \begin_inset Flex Code
17873 \begin_layout Plain Layout
17880 \begin_inset Flex Code
17883 \begin_layout Plain Layout
17889 =""] This inset will appear in the table of contents of the given type.
17890 An empty string disables.
17891 See also the OutlinerName and the IsTocCaption commands.
17892 This is only implemented for Flex insets.
17896 \begin_layout Description
17897 \begin_inset Flex Code
17900 \begin_layout Plain Layout
17907 \begin_inset Flex Code
17910 \begin_layout Plain Layout
17916 ] Defines argument number of a command\SpecialChar breakableslash
17917 environment associated with the current
17919 The definition must end with
17920 \begin_inset Flex Code
17923 \begin_layout Plain Layout
17931 \begin_inset CommandInset ref
17933 reference "subsec:Paragraph-Styles"
17940 \begin_layout Description
17941 \begin_inset Flex Code
17944 \begin_layout Plain Layout
17950 Preamble for changing language commands; see
17951 \begin_inset CommandInset ref
17953 reference "subsec:I18n"
17960 \begin_layout Description
17961 \begin_inset Flex Code
17964 \begin_layout Plain Layout
17971 \begin_inset Flex Code
17974 \begin_layout Plain Layout
17980 ] The color for the inset's background.
17982 \begin_inset CommandInset ref
17984 reference "chap:Names-of-colors"
17988 for a list of the available color names.
17991 \begin_layout Description
17992 \begin_inset Flex Code
17995 \begin_layout Plain Layout
18002 \begin_inset Flex Code
18005 \begin_layout Plain Layout
18014 \begin_inset space \thinspace{}
18018 \begin_inset Flex Code
18021 \begin_layout Plain Layout
18027 ] Whether to use the content of the inset as the label, when the inset is
18032 \begin_layout Description
18033 \begin_inset Flex Code
18036 \begin_layout Plain Layout
18043 \begin_inset Flex Code
18046 \begin_layout Plain Layout
18052 ] As with paragraph styles, see
18053 \begin_inset CommandInset ref
18055 reference "subsec:Paragraph-Styles"
18060 Note that you need to specify the complete type, e.
18061 \begin_inset space \thinspace{}
18065 \begin_inset space ~
18069 \begin_inset Flex Code
18072 \begin_layout Plain Layout
18073 CopyStyle Flex:<name>
18081 \begin_layout Description
18082 \begin_inset Flex Code
18085 \begin_layout Plain Layout
18092 \begin_inset Flex Code
18095 \begin_layout Plain Layout
18104 \begin_inset space \thinspace{}
18108 \begin_inset Flex Code
18111 \begin_layout Plain Layout
18117 ] Indicates whether the user may employ the Paragraph Settings dialog to
18118 customize the paragraph.
18121 \begin_layout Description
18122 \begin_inset Flex Code
18125 \begin_layout Plain Layout
18132 \begin_inset Flex Code
18135 \begin_layout Plain Layout
18142 \begin_inset Flex Code
18145 \begin_layout Plain Layout
18152 \begin_inset Flex Code
18155 \begin_layout Plain Layout
18161 , describing the rendering style used for the inset's frame and buttons.
18162 Footnotes generally use
18163 \begin_inset Flex Code
18166 \begin_layout Plain Layout
18172 , ERT insets generally
18173 \begin_inset Flex Code
18176 \begin_layout Plain Layout
18182 , and character styles
18183 \begin_inset Flex Code
18186 \begin_layout Plain Layout
18195 \begin_layout Description
18196 \begin_inset Flex Code
18199 \begin_layout Plain Layout
18206 \begin_inset Flex Code
18209 \begin_layout Plain Layout
18218 \begin_inset space \thinspace{}
18224 \begin_inset Flex Code
18227 \begin_layout Plain Layout
18236 \begin_inset Flex Code
18239 \begin_layout Plain Layout
18246 \begin_inset Flex Code
18249 \begin_layout Plain Layout
18256 Indicates whether the environment will stand on its own in the output or
18257 will appear inline with the surrounding text.
18258 If set to false, it is supposed that the \SpecialChar LaTeX
18259 environment ignores white space
18260 (including one newline character) after the
18261 \begin_inset Flex Code
18264 \begin_layout Plain Layout
18277 \begin_inset Flex Code
18280 \begin_layout Plain Layout
18296 \begin_layout Description
18297 \begin_inset Flex Code
18300 \begin_layout Plain Layout
18306 Required at the end of the
18307 \begin_inset Flex Code
18310 \begin_layout Plain Layout
18319 \begin_layout Description
18320 \begin_inset Flex Code
18323 \begin_layout Plain Layout
18329 The font used for both the text body
18335 \begin_inset CommandInset ref
18337 reference "subsec:Font-description"
18342 Note that defining this font automatically defines the
18343 \begin_inset Flex Code
18346 \begin_layout Plain Layout
18352 to the same value, so define this first and define
18353 \begin_inset Flex Code
18356 \begin_layout Plain Layout
18362 later if you want them to be different.
18365 \begin_layout Description
18366 \begin_inset Flex Code
18369 \begin_layout Plain Layout
18370 FixedWidthPreambleEncoding
18376 \begin_inset Flex Code
18379 \begin_layout Plain Layout
18388 \begin_inset space \thinspace{}
18392 \begin_inset Flex Code
18395 \begin_layout Plain Layout
18401 ] Force a fixed width encoding for the translated contents of
18402 \begin_inset Flex Code
18405 \begin_layout Plain Layout
18412 \begin_inset Flex Code
18415 \begin_layout Plain Layout
18421 code generated by this layout.
18422 This is needed for special \SpecialChar LaTeX
18427 that do not work with variable width encodings such as
18432 This setting is ignored if fully Unicode aware \SpecialChar LaTeX
18433 backends such as Xe\SpecialChar TeX
18435 Lua\SpecialChar TeX
18439 \begin_layout Description
18440 \begin_inset Flex Code
18443 \begin_layout Plain Layout
18444 ForceLocalFontSwitch
18450 \begin_inset Flex Code
18453 \begin_layout Plain Layout
18462 \begin_inset space \thinspace{}
18466 \begin_inset Flex Code
18469 \begin_layout Plain Layout
18475 ] When using babel, always use a local font switch (
18476 \begin_inset Flex Code
18479 \begin_layout Plain Layout
18487 ), never a global one (such as
18488 \begin_inset Flex Code
18491 \begin_layout Plain Layout
18502 \begin_layout Description
18503 \begin_inset Flex Code
18506 \begin_layout Plain Layout
18513 \begin_inset Flex Code
18516 \begin_layout Plain Layout
18525 \begin_inset space \thinspace{}
18529 \begin_inset Flex Code
18532 \begin_layout Plain Layout
18539 \begin_inset Quotes eld
18543 \begin_inset Quotes erd
18546 language, leading to Left-to-Right (Latin) output, e.
18547 \begin_inset space \thinspace{}
18551 \begin_inset space \space{}
18554 in \SpecialChar TeX
18559 \begin_layout Description
18560 \begin_inset Flex Code
18563 \begin_layout Plain Layout
18570 \begin_inset Flex Code
18573 \begin_layout Plain Layout
18582 \begin_inset space \thinspace{}
18586 \begin_inset Flex Code
18589 \begin_layout Plain Layout
18595 ] Force a a line break in the \SpecialChar LaTeX
18596 output before the inset starts and after
18598 This assures the inset itself is output on its own lines, for parsing purposes.
18601 \begin_layout Description
18602 \begin_inset Flex Code
18605 \begin_layout Plain Layout
18612 \begin_inset Flex Code
18615 \begin_layout Plain Layout
18624 \begin_inset space \thinspace{}
18628 \begin_inset Flex Code
18631 \begin_layout Plain Layout
18637 ] Indicates whether the
18638 \begin_inset Flex Code
18641 \begin_layout Plain Layout
18647 should be used or, instead, the user can change the paragraph style used
18652 \begin_layout Description
18653 \begin_inset Flex Code
18656 \begin_layout Plain Layout
18663 \begin_inset Flex Code
18666 \begin_layout Plain Layout
18675 \begin_inset space \thinspace{}
18679 \begin_inset Flex Code
18682 \begin_layout Plain Layout
18688 ] As with paragraph styles, see
18689 \begin_inset CommandInset ref
18691 reference "subsec:Paragraph-Styles"
18698 \begin_layout Description
18699 \begin_inset Flex Code
18702 \begin_layout Plain Layout
18708 These tags control the XHTML output.
18710 \begin_inset CommandInset ref
18712 reference "sec:Tags-for-XHTML"
18719 \begin_layout Description
18720 \begin_inset Flex Code
18723 \begin_layout Plain Layout
18730 \begin_inset Flex Code
18733 \begin_layout Plain Layout
18742 \begin_inset space \thinspace{}
18746 \begin_inset Flex Code
18749 \begin_layout Plain Layout
18755 ] Whether to include the contents of this inset in the strings generated
18756 for the `Outline' pane for all table of contents, regardless of the AddToToc
18758 One would not, for example, want the content of a footnote in a section
18759 header to be included in the TOC displayed in the outline, but one would
18760 normally want the content of a character style displayed.
18761 Default is false: not to include.
18764 \begin_layout Description
18765 \begin_inset Flex Code
18768 \begin_layout Plain Layout
18775 \begin_inset Flex Code
18778 \begin_layout Plain Layout
18787 \begin_inset space \thinspace{}
18791 \begin_inset Flex Code
18794 \begin_layout Plain Layout
18800 ] If this is set to 1 and AddToToc is enabled, the inset adds a summary
18801 of its contents in its item in the table of contents.
18802 Otherwise, only the label appears.
18805 \begin_layout Description
18806 \begin_inset Flex Code
18809 \begin_layout Plain Layout
18818 \begin_inset Flex Code
18821 \begin_layout Plain Layout
18830 \begin_inset space \thinspace{}
18834 \begin_inset Flex Code
18837 \begin_layout Plain Layout
18843 ] As with paragraph styles, see
18844 \begin_inset CommandInset ref
18846 reference "subsec:Paragraph-Styles"
18853 \begin_layout Description
18854 \begin_inset Flex Code
18857 \begin_layout Plain Layout
18863 The font used for the label.
18865 \begin_inset CommandInset ref
18867 reference "subsec:Font-description"
18872 Note that this definition can never appear before
18873 \begin_inset Flex Code
18876 \begin_layout Plain Layout
18882 , lest it be ineffective.
18885 \begin_layout Description
18886 \begin_inset Flex Code
18889 \begin_layout Plain Layout
18896 \begin_inset Flex Code
18899 \begin_layout Plain Layout
18906 \begin_inset Quotes erd
18910 \begin_inset Quotes erd
18913 ] What will be displayed on the button or elsewhere as the inset label.
18915 \begin_inset Flex Code
18918 \begin_layout Plain Layout
18926 \begin_inset Flex Code
18929 \begin_layout Plain Layout
18935 ) modify this label on the fly.
18938 \begin_layout Description
18939 \begin_inset Flex Code
18942 \begin_layout Plain Layout
18948 Language dependent preamble; see
18949 \begin_inset CommandInset ref
18951 reference "subsec:I18n"
18958 \begin_layout Description
18959 \begin_inset Flex Code
18962 \begin_layout Plain Layout
18969 \begin_inset Flex Code
18972 \begin_layout Plain Layout
18978 ] The name of the corresponding \SpecialChar LaTeX
18980 Either the environment or command name.
18983 \begin_layout Description
18984 \begin_inset Flex Code
18987 \begin_layout Plain Layout
18994 \begin_inset Flex Code
18997 \begin_layout Plain Layout
19003 ] The optional parameter for the corresponding
19004 \begin_inset Flex Code
19007 \begin_layout Plain Layout
19013 stuff, including possible bracket pairs like
19014 \begin_inset Flex Code
19017 \begin_layout Plain Layout
19024 This parameter cannot be changed from within \SpecialChar LyX
19026 \begin_inset Flex Code
19029 \begin_layout Plain Layout
19035 for customizable parameters).
19036 It will be output as is after all \SpecialChar LaTeX
19038 \begin_inset Flex Code
19041 \begin_layout Plain Layout
19050 \begin_layout Description
19051 \begin_inset Flex Code
19054 \begin_layout Plain Layout
19061 \begin_inset Flex Code
19064 \begin_layout Plain Layout
19065 Command, Environment, None
19070 ] How the style should be translated into \SpecialChar LaTeX
19075 \begin_layout Plain Layout
19076 \begin_inset Flex Code
19079 \begin_layout Plain Layout
19085 is perhaps a bit misleading, since these rules apply to SGML classes too.
19086 Visit the SGML class files for specific examples.
19095 \begin_layout Description
19096 \begin_inset Flex Code
19099 \begin_layout Plain Layout
19105 means nothing special
19108 \begin_layout Description
19109 \begin_inset Flex Code
19112 \begin_layout Plain Layout
19119 \begin_inset Flex Code
19122 \begin_layout Plain Layout
19129 {\SpecialChar ldots
19138 \begin_layout Description
19139 \begin_inset Flex Code
19142 \begin_layout Plain Layout
19149 \begin_inset Flex Code
19152 \begin_layout Plain Layout
19159 }\SpecialChar ldots
19174 \begin_layout Standard
19175 Putting the last few things together, the \SpecialChar LaTeX
19176 output will be either:
19179 \begin_layout LyX-Code
19182 LatexName[LatexParam]{\SpecialChar ldots
19186 \begin_layout Standard
19190 \begin_layout LyX-Code
19193 begin{LatexName}[LatexParam] \SpecialChar ldots
19199 \begin_layout Standard
19200 depending upon the \SpecialChar LaTeX
19205 \begin_layout Description
19206 \begin_inset Flex Code
19209 \begin_layout Plain Layout
19216 \begin_inset Flex Code
19219 \begin_layout Plain Layout
19225 ] A string that is put at the beginning of the layout content.
19226 A line break in the output can be indicated by
19227 \begin_inset Flex Code
19230 \begin_layout Plain Layout
19239 \begin_layout Description
19240 \begin_inset Flex Code
19243 \begin_layout Plain Layout
19250 \begin_inset Flex Code
19253 \begin_layout Plain Layout
19260 \begin_inset Flex Code
19263 \begin_layout Plain Layout
19270 \begin_inset Flex Code
19273 \begin_layout Plain Layout
19280 \begin_inset Flex Code
19283 \begin_layout Plain Layout
19289 (indicating a dummy definition ending definitions of charstyles, etc).
19290 This entry is required in and is only meaningful for Flex insets.
19291 Among other things, it determines on which menu this inset will appear.
19293 \begin_inset Flex Code
19296 \begin_layout Plain Layout
19303 \begin_inset Flex Code
19306 \begin_layout Plain Layout
19312 will automatically set
19313 \begin_inset Flex Code
19316 \begin_layout Plain Layout
19323 \begin_inset Flex Code
19326 \begin_layout Plain Layout
19334 \begin_inset Flex Code
19337 \begin_layout Plain Layout
19343 can be set to true, or
19344 \begin_inset Flex Code
19347 \begin_layout Plain Layout
19354 \begin_inset Flex Code
19357 \begin_layout Plain Layout
19363 insets by setting it
19368 \begin_inset Flex Code
19371 \begin_layout Plain Layout
19380 \begin_layout Description
19381 \begin_inset Flex Code
19384 \begin_layout Plain Layout
19391 \begin_inset Flex Code
19394 \begin_layout Plain Layout
19403 \begin_inset space \thinspace{}
19407 \begin_inset Flex Code
19410 \begin_layout Plain Layout
19416 ] Whether multiple paragraphs are permitted in this inset.
19418 \begin_inset Flex Code
19421 \begin_layout Plain Layout
19427 to the same value and
19428 \begin_inset Flex Code
19431 \begin_layout Plain Layout
19437 to the opposite value.
19438 These can be reset to other values, if they are used
19443 \begin_inset Flex Code
19446 \begin_layout Plain Layout
19456 \begin_layout Description
19457 \begin_inset Flex Code
19460 \begin_layout Plain Layout
19467 \begin_inset Flex Code
19470 \begin_layout Plain Layout
19479 \begin_inset space \thinspace{}
19483 \begin_inset Flex Code
19486 \begin_layout Plain Layout
19492 ] Whether fragile commands in this inset should be
19493 \begin_inset Flex Code
19496 \begin_layout Plain Layout
19509 whether the command should itself be protected.) Default is false.
19512 \begin_layout Description
19513 \begin_inset Flex Code
19516 \begin_layout Plain Layout
19523 \begin_inset Flex Code
19526 \begin_layout Plain Layout
19532 ] Deletes an existing
19533 \begin_inset Flex Code
19536 \begin_layout Plain Layout
19545 \begin_layout Description
19546 \begin_inset Flex Code
19549 \begin_layout Plain Layout
19556 \begin_inset Flex Code
19559 \begin_layout Plain Layout
19566 \begin_inset Flex Code
19569 \begin_layout Plain Layout
19575 that has replaced this
19576 \begin_inset Flex Code
19579 \begin_layout Plain Layout
19586 This is used to rename an
19587 \begin_inset Flex Code
19590 \begin_layout Plain Layout
19596 , while keeping backward compatibility.
19599 \begin_layout Description
19600 \begin_inset Flex Code
19603 \begin_layout Plain Layout
19610 \begin_inset Flex Code
19613 \begin_layout Plain Layout
19622 \begin_inset space \thinspace{}
19626 \begin_inset Flex Code
19629 \begin_layout Plain Layout
19635 ] As with paragraph styles, see
19636 \begin_inset CommandInset ref
19638 reference "subsec:Paragraph-Styles"
19646 \begin_layout Description
19647 \begin_inset Flex Code
19650 \begin_layout Plain Layout
19657 \begin_inset Flex Code
19660 \begin_layout Plain Layout
19669 \begin_inset space \thinspace{}
19673 \begin_inset Flex Code
19676 \begin_layout Plain Layout
19682 ] As with paragraph styles, see
19683 \begin_inset CommandInset ref
19685 reference "subsec:Paragraph-Styles"
19693 \begin_layout Description
19694 \begin_inset Flex Code
19697 \begin_layout Plain Layout
19703 As with paragraph styles, see
19704 \begin_inset CommandInset ref
19706 reference "subsec:Paragraph-Styles"
19713 \begin_layout Description
19714 \begin_inset Flex Code
19717 \begin_layout Plain Layout
19724 \begin_inset Flex Code
19727 \begin_layout Plain Layout
19733 ] The prefix to use when creating labels referring to insets of this type.
19734 This allows the use of formatted references.
19737 \begin_layout Description
19738 \begin_inset Flex Code
19741 \begin_layout Plain Layout
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
19790 \begin_inset space \thinspace{}
19794 \begin_inset Flex Code
19797 \begin_layout Plain Layout
19803 ] Resets the \SpecialChar LaTeX
19804 arguments of this layout (as defined via the
19805 \begin_inset Flex Code
19808 \begin_layout Plain Layout
19815 This is useful if you have copied a style via
19816 \begin_inset Flex Code
19819 \begin_layout Plain Layout
19825 , but you do not want to inherit its (required and optional) arguments.
19828 \begin_layout Description
19829 \begin_inset Flex Code
19832 \begin_layout Plain Layout
19839 \begin_inset Flex Code
19842 \begin_layout Plain Layout
19849 \begin_inset space \thinspace{}
19853 \begin_inset Flex Code
19856 \begin_layout Plain Layout
19864 ] Whether this inset should use the font of its surrounding environment
19866 Default is false: use the font of the surrounding environment.
19869 \begin_layout Description
19870 \begin_inset Flex Code
19873 \begin_layout Plain Layout
19880 \begin_inset Flex Code
19883 \begin_layout Plain Layout
19889 ] A string that is put at the end of the layout content.
19890 A line break in the output can be indicated by
19891 \begin_inset Flex Code
19894 \begin_layout Plain Layout
19903 \begin_layout Description
19904 \begin_inset Flex Code
19907 \begin_layout Plain Layout
19914 \begin_inset Flex Code
19917 \begin_layout Plain Layout
19924 \begin_inset space \thinspace{}
19928 \begin_inset Flex Code
19931 \begin_layout Plain Layout
19939 ] Allow spell-checking the contents of this inset.
19943 \begin_layout Subsection
19945 \begin_inset CommandInset label
19947 name "subsec:Counters"
19954 \begin_layout Standard
19955 It is necessary to define the counters (
19956 \begin_inset Flex Noun
19959 \begin_layout Plain Layout
19966 \begin_inset Flex Noun
19969 \begin_layout Plain Layout
19975 , \SpecialChar ldots
19976 ) in the text class itself.
19977 The standard counters are defined in the file
19978 \begin_inset Flex Code
19981 \begin_layout Plain Layout
19987 , so you may have to do no more than add
19990 \begin_layout LyX-Code
19991 Input stdcounters.inc
19994 \begin_layout Standard
19995 to your layout file to get them to work.
19996 But if you want to define custom counters, then you can do so.
19997 The counter declaration must begin with:
20000 \begin_layout LyX-Code
20001 Counter CounterName
20004 \begin_layout Standard
20006 \begin_inset Flex Code
20009 \begin_layout Plain Layout
20015 ' is replaced by the name of the counter.
20016 And it must end with
20017 \begin_inset Quotes eld
20021 \begin_inset Flex Code
20024 \begin_layout Plain Layout
20031 \begin_inset Quotes erd
20035 The following parameters can also be used:
20038 \begin_layout Description
20039 \begin_inset Flex Code
20042 \begin_layout Plain Layout
20049 \begin_inset Flex Code
20052 \begin_layout Plain Layout
20058 ] Sets the initial value for the counter, to which it will be reset whenever
20060 Normally, one will want the default, 1.
20063 \begin_layout Description
20064 \begin_inset Flex Code
20067 \begin_layout Plain Layout
20074 \begin_inset Flex Code
20077 \begin_layout Plain Layout
20084 \begin_inset Quotes erd
20088 \begin_inset Quotes erd
20091 ] When defined, this string defines how the counter is displayed.
20092 Setting this value sets
20093 \begin_inset Flex Code
20096 \begin_layout Plain Layout
20097 LabelStringAppendix
20103 The following special constructs can be used in the string:
20107 \begin_layout Itemize
20108 \begin_inset Flex Code
20111 \begin_layout Plain Layout
20119 will be replaced by the expansion of the
20120 \begin_inset Flex Code
20123 \begin_layout Plain Layout
20130 \begin_inset Flex Code
20133 \begin_layout Plain Layout
20134 LabelStringAppendix
20140 \begin_inset Flex Code
20143 \begin_layout Plain Layout
20153 \begin_layout Itemize
20154 counter values can be expressed using \SpecialChar LaTeX
20156 \begin_inset Newline newline
20160 \begin_inset Flex Code
20163 \begin_layout Plain Layout
20180 \begin_inset Flex Code
20183 \begin_layout Plain Layout
20195 \begin_layout Plain Layout
20205 Actually, the situation is a bit more complicated: any
20224 other than those described below will produce arabic numerals.
20225 It would not be surprising to see this change in the future.
20231 \begin_inset Flex Code
20234 \begin_layout Plain Layout
20240 : 1, 2, 3,\SpecialChar ldots
20242 \begin_inset Flex Code
20245 \begin_layout Plain Layout
20251 for lower-case letters: a, b, c, \SpecialChar ldots
20253 \begin_inset Flex Code
20256 \begin_layout Plain Layout
20262 for upper-case letters: A, B, C, \SpecialChar ldots
20264 \begin_inset Flex Code
20267 \begin_layout Plain Layout
20273 for lower-case roman numerals: i, ii, iii, \SpecialChar ldots
20275 \begin_inset Flex Code
20278 \begin_layout Plain Layout
20284 for upper-case roman numerals: I, II, III\SpecialChar ldots
20286 \begin_inset Flex Code
20289 \begin_layout Plain Layout
20295 for hebrew numerals.
20299 \begin_layout Standard
20300 If LabelString is not defined, a default value is constructed as follows:
20301 if the counter has a master counter
20302 \begin_inset Flex Code
20305 \begin_layout Plain Layout
20312 \begin_inset Flex Code
20315 \begin_layout Plain Layout
20322 \begin_inset Newline newline
20326 \begin_inset Flex Code
20329 \begin_layout Plain Layout
20339 is used; otherwise the string
20340 \begin_inset Flex Code
20343 \begin_layout Plain Layout
20354 \begin_layout Description
20355 \begin_inset Flex Code
20358 \begin_layout Plain Layout
20359 LabelStringAppendix
20365 \begin_inset Flex Code
20368 \begin_layout Plain Layout
20375 \begin_inset Quotes erd
20379 \begin_inset Quotes erd
20383 \begin_inset Flex Code
20386 \begin_layout Plain Layout
20392 , but for use in the Appendix.
20395 \begin_layout Description
20396 \begin_inset Flex Code
20399 \begin_layout Plain Layout
20406 \begin_inset Flex Code
20409 \begin_layout Plain Layout
20416 \begin_inset Quotes erd
20420 \begin_inset Quotes erd
20423 ] A format for use with formatted references to this counter.
20424 For example, one might want to have references to section numbers appear
20426 \begin_inset Quotes eld
20430 \begin_inset Quotes erd
20434 The string should contain
20435 \begin_inset Quotes eld
20439 \begin_inset Quotes erd
20443 This will be replaced by the counter number itself.
20444 So, for sections, it would be: Section ##.
20447 \begin_layout Description
20448 \begin_inset Flex Code
20451 \begin_layout Plain Layout
20458 \begin_inset Flex Code
20461 \begin_layout Plain Layout
20468 \begin_inset Quotes erd
20472 \begin_inset Quotes erd
20475 ] If this is set to the name of another counter, the present counter will
20476 be reset every time the other one is increased.
20478 \begin_inset Flex Code
20481 \begin_layout Plain Layout
20488 \begin_inset Flex Code
20491 \begin_layout Plain Layout
20500 \begin_layout Subsection
20502 \begin_inset CommandInset label
20504 name "subsec:Font-description"
20511 \begin_layout Standard
20512 A font description looks like this:
20515 \begin_layout LyX-Code
20532 \begin_layout LyX-Code
20536 \begin_layout LyX-Code
20540 \begin_layout Standard
20541 The following commands are available:
20544 \begin_layout Description
20545 \begin_inset Flex Code
20548 \begin_layout Plain Layout
20555 \begin_inset Flex Code
20558 \begin_layout Plain Layout
20567 \begin_inset Flex Code
20570 \begin_layout Plain Layout
20577 \begin_inset Flex Code
20580 \begin_layout Plain Layout
20587 \begin_inset Flex Code
20590 \begin_layout Plain Layout
20597 \begin_inset Flex Code
20600 \begin_layout Plain Layout
20607 \begin_inset Flex Code
20610 \begin_layout Plain Layout
20617 \begin_inset Flex Code
20620 \begin_layout Plain Layout
20627 \begin_inset Flex Code
20630 \begin_layout Plain Layout
20637 \begin_inset Flex Code
20640 \begin_layout Plain Layout
20647 \begin_inset Flex Code
20650 \begin_layout Plain Layout
20657 \begin_inset Flex Code
20660 \begin_layout Plain Layout
20667 \begin_inset Flex Code
20670 \begin_layout Plain Layout
20677 \begin_inset Flex Code
20680 \begin_layout Plain Layout
20687 \begin_inset Flex Code
20690 \begin_layout Plain Layout
20697 \begin_inset Flex Code
20700 \begin_layout Plain Layout
20707 \begin_inset Flex Code
20710 \begin_layout Plain Layout
20717 \begin_inset Flex Code
20720 \begin_layout Plain Layout
20727 \begin_inset Flex Code
20730 \begin_layout Plain Layout
20737 \begin_inset Flex Code
20740 \begin_layout Plain Layout
20747 \begin_inset Flex Code
20750 \begin_layout Plain Layout
20759 \begin_layout Description
20760 \begin_inset Flex Code
20763 \begin_layout Plain Layout
20770 \begin_inset Flex Code
20773 \begin_layout Plain Layout
20782 \begin_inset Flex Code
20785 \begin_layout Plain Layout
20792 \begin_inset Flex Code
20795 \begin_layout Plain Layout
20804 \begin_layout Description
20805 \begin_inset Flex Code
20808 \begin_layout Plain Layout
20815 \begin_inset Flex Code
20818 \begin_layout Plain Layout
20824 ] Valid arguments are:
20825 \begin_inset Flex Code
20828 \begin_layout Plain Layout
20835 \begin_inset Flex Code
20838 \begin_layout Plain Layout
20845 \begin_inset Flex Code
20848 \begin_layout Plain Layout
20855 \begin_inset Flex Code
20858 \begin_layout Plain Layout
20865 \begin_inset Flex Code
20868 \begin_layout Plain Layout
20875 \begin_inset Flex Code
20878 \begin_layout Plain Layout
20885 \begin_inset Flex Code
20888 \begin_layout Plain Layout
20895 \begin_inset Flex Code
20898 \begin_layout Plain Layout
20905 \begin_inset Flex Code
20908 \begin_layout Plain Layout
20915 \begin_inset Flex Code
20918 \begin_layout Plain Layout
20925 \begin_inset Flex Code
20928 \begin_layout Plain Layout
20935 \begin_inset Flex Code
20938 \begin_layout Plain Layout
20945 Each of these turns on or off the corresponding attribute.
20947 \begin_inset Flex Code
20950 \begin_layout Plain Layout
20956 turns on emphasis, and
20957 \begin_inset Flex Code
20960 \begin_layout Plain Layout
20968 \begin_inset Newline newline
20971 If the latter seems puzzling, remember that the font settings for the present
20972 context are generally inherited from the surrounding context.
20974 \begin_inset Flex Code
20977 \begin_layout Plain Layout
20983 would turn off the emphasis that was anyway in effect, say, in a theorem
20987 \begin_layout Description
20988 \begin_inset Flex Code
20991 \begin_layout Plain Layout
20998 \begin_inset Flex Code
21001 \begin_layout Plain Layout
21010 \begin_inset Flex Code
21013 \begin_layout Plain Layout
21022 \begin_layout Description
21023 \begin_inset Flex Code
21026 \begin_layout Plain Layout
21033 \begin_inset Flex Code
21036 \begin_layout Plain Layout
21045 \begin_inset Flex Code
21048 \begin_layout Plain Layout
21055 \begin_inset Flex Code
21058 \begin_layout Plain Layout
21065 \begin_inset Flex Code
21068 \begin_layout Plain Layout
21077 \begin_layout Description
21078 \begin_inset Flex Code
21081 \begin_layout Plain Layout
21088 \begin_inset Flex Code
21091 \begin_layout Plain Layout
21098 \begin_inset Flex Code
21101 \begin_layout Plain Layout
21108 \begin_inset Flex Code
21111 \begin_layout Plain Layout
21120 \begin_inset Flex Code
21123 \begin_layout Plain Layout
21130 \begin_inset Flex Code
21133 \begin_layout Plain Layout
21140 \begin_inset Flex Code
21143 \begin_layout Plain Layout
21150 \begin_inset Flex Code
21153 \begin_layout Plain Layout
21160 \begin_inset Flex Code
21163 \begin_layout Plain Layout
21172 \begin_layout Subsection
21173 \begin_inset CommandInset label
21175 name "subsec:Citation-engine-description"
21179 Cite engine description
21182 \begin_layout Standard
21184 \begin_inset Flex Code
21187 \begin_layout Plain Layout
21193 blocks, as used mainly in cite engine files (see
21194 \begin_inset CommandInset ref
21196 reference "subsec:Cite-Engine-Files"
21203 ), define the citation commands provided by a specific
21204 \begin_inset Quotes eld
21208 \begin_inset Quotes erd
21212 A cite engine, in \SpecialChar LyX
21213 terms, is way specific way to format citations, using
21214 numbers, author names and/or years.
21215 Currently, \SpecialChar LyX
21216 supports three such engine types, namely:
21219 \begin_layout Enumerate
21220 \begin_inset Flex Code
21223 \begin_layout Plain Layout
21229 : the default Bib\SpecialChar TeX
21230 way to format citations, a simple numeric style (e.
21231 \begin_inset space \thinspace{}
21235 \begin_inset Quotes eld
21239 \begin_inset Quotes erd
21245 \begin_layout Enumerate
21246 \begin_inset Flex Code
21249 \begin_layout Plain Layout
21255 : Harvard-styled citations using author names and publication year (e.
21256 \begin_inset space \thinspace{}
21260 \begin_inset Quotes eld
21263 Smith and Miller (2017b)
21264 \begin_inset Quotes erd
21270 \begin_layout Enumerate
21271 \begin_inset Flex Code
21274 \begin_layout Plain Layout
21280 : extended numerical citations that also allow for author or title next
21282 \begin_inset space \thinspace{}
21286 \begin_inset Quotes eld
21289 Smith and Miller [1]
21290 \begin_inset Quotes erd
21296 \begin_layout Standard
21297 \begin_inset Flex Code
21300 \begin_layout Plain Layout
21306 blocks look like this:
21309 \begin_layout LyX-Code
21313 \begin_layout LyX-Code
21317 \begin_layout LyX-Code
21321 \begin_layout LyX-Code
21322 citeyearpar[][]=parencite*
21325 \begin_layout LyX-Code
21329 \begin_layout LyX-Code
21333 \begin_layout Standard
21335 \begin_inset Flex Code
21338 \begin_layout Plain Layout
21344 denotes the engine.
21345 The individual lines respectively define a cite command or cite command
21346 paradigm supported by this engine.
21347 The line can be as simple as a cite command that is used both to name the
21348 respective \SpecialChar LyX
21349 command and the \SpecialChar LaTeX
21350 output or more complex in order to differentiate
21352 The full syntax is:
21355 \begin_layout LyX-Code
21356 LyXName|alias$*<!_stardesc!_stardesctooltip>[][]=latexcmd
21359 \begin_layout Itemize
21360 \begin_inset Flex Code
21363 \begin_layout Plain Layout
21369 : The name as used in the
21370 \begin_inset Flex Code
21373 \begin_layout Plain Layout
21383 \begin_layout Standard
21384 For portability reasons, we try to use the same name for same-formatted
21385 commands in different cite packages (thus many names stem from natbib,
21386 and thus we need to differentiate a
21387 \begin_inset Flex Code
21390 \begin_layout Plain Layout
21396 sometimes, if the \SpecialChar LaTeX
21397 command names differ).
21401 \begin_layout Itemize
21402 \begin_inset Flex Code
21405 \begin_layout Plain Layout
21411 : a (comma-separated) list of commands that fall back to the given
21412 \begin_inset Flex Code
21415 \begin_layout Plain Layout
21421 in the current engine.
21422 This eases the switch of citation packages and engines.
21424 \begin_inset Flex Code
21427 \begin_layout Plain Layout
21434 \begin_inset Flex Code
21437 \begin_layout Plain Layout
21443 in layout definitions.
21446 \begin_layout Itemize
21447 \begin_inset Flex Code
21450 \begin_layout Plain Layout
21456 : The actual \SpecialChar LaTeX
21457 command that is output.
21461 \begin_layout Standard
21462 \begin_inset Flex Code
21465 \begin_layout Plain Layout
21472 \begin_inset Flex Code
21475 \begin_layout Plain Layout
21483 \begin_inset Flex Code
21486 \begin_layout Plain Layout
21493 \begin_inset Flex Code
21496 \begin_layout Plain Layout
21502 will be output to \SpecialChar LaTeX
21506 \begin_layout Standard
21510 \begin_layout Itemize
21511 Capitalization indicates that the command also has a capitalized form (
21512 \begin_inset Flex Code
21515 \begin_layout Plain Layout
21525 \begin_inset Flex Code
21528 \begin_layout Plain Layout
21537 These usually enforce up-casing of name prefixes (
21542 \begin_inset Formula $\Rightarrow$
21552 \begin_layout Itemize
21554 \begin_inset Flex Code
21557 \begin_layout Plain Layout
21563 indicate the number of optional arguments (there can be 0–2).
21566 \begin_layout Itemize
21568 \begin_inset Flex Code
21571 \begin_layout Plain Layout
21577 indicates there is a starred version of the command (
21578 \begin_inset Flex Code
21581 \begin_layout Plain Layout
21591 \begin_inset Flex Code
21594 \begin_layout Plain Layout
21607 \begin_layout Standard
21608 By default, the starred version means: Output all authors even if it should
21610 \begin_inset Quotes eld
21614 \begin_inset Quotes erd
21618 \begin_inset Flex Code
21621 \begin_layout Plain Layout
21630 \begin_layout Standard
21631 If the star has a different meaning for a given command, it can be specified
21633 \begin_inset Flex Code
21636 \begin_layout Plain Layout
21637 <!_stardesc!_stardesctooltip>
21643 Maximal two translatable macro keywords, marked by the prefix
21644 \begin_inset Flex Code
21647 \begin_layout Plain Layout
21654 The first points to the string that replaces the
21655 \begin_inset Quotes eld
21659 \begin_inset Quotes erd
21662 checkbox label in the citation dialog, the second one to an optional tool
21663 tip for this checkbox.
21667 \begin_layout Standard
21668 Note that these two macros have to be defined in a
21669 \begin_inset Flex Code
21672 \begin_layout Plain Layout
21678 (see next section), dropping the
21679 \begin_inset Flex Code
21682 \begin_layout Plain Layout
21688 from the prefix, like this:
21691 \begin_layout LyX-Code
21692 _stardesc Sta&rred command label
21695 \begin_layout LyX-Code
21696 _stardesctooltip Tooltip for the starred command checkbox.
21700 \begin_layout Itemize
21702 \begin_inset Flex Code
21705 \begin_layout Plain Layout
21711 indicates that this command features
21712 \begin_inset Quotes eld
21715 qualified citation lists
21716 \begin_inset Quotes erd
21724 -specific feature for multi-reference citations where an individual pre-
21725 and postnote can be given to each reference in the list.
21726 Please refer to the
21730 manual for details.
21733 \begin_layout Subsection
21734 \begin_inset CommandInset label
21736 name "subsec:Citation-format-description"
21740 Cite format description
21743 \begin_layout Standard
21745 \begin_inset Flex Code
21748 \begin_layout Plain Layout
21754 blocks are used to describe how bibliographic information should be displayed,
21755 both within \SpecialChar LyX
21756 itself (in the citation dialog and in tooltips, for example)
21757 and in XHTML output.
21758 Such a block might look like this:
21761 \begin_layout LyX-Code
21765 \begin_layout LyX-Code
21769 \begin_layout LyX-Code
21773 \begin_layout LyX-Code
21777 \begin_layout Standard
21781 \begin_layout LyX-Code
21785 \begin_layout LyX-Code
21789 \begin_layout LyX-Code
21793 \begin_layout LyX-Code
21797 \begin_layout Standard
21798 In the first case, the individual lines define how the bibliographic information
21799 associated with an article or book, respectively, is to be displayed, and
21800 such a definition can be given for any
21801 \begin_inset Quotes els
21805 \begin_inset Quotes ers
21808 that might be present in a Bib\SpecialChar TeX
21811 defines a default format in the source code that will be used if no specific
21812 definition has been given.
21814 predefines several formats in the file
21815 \begin_inset Flex Code
21818 \begin_layout Plain Layout
21824 , which is included in most of \SpecialChar LyX
21825 's document classes.
21828 \begin_layout Standard
21829 In the second case, the lines define how a specific citation command (in
21831 \begin_inset Flex Code
21834 \begin_layout Plain Layout
21843 \begin_inset Flex Code
21846 \begin_layout Plain Layout
21854 ) is to be displayed on the citation inset label, in the citation dialog,
21855 menu or XHTML output.
21857 defines such formats for the citation style variants it supports via
21859 Document\SpecialChar menuseparator
21860 Setting\SpecialChar menuseparator
21861 Bibliography\SpecialChar ldots
21865 \begin_inset Flex Code
21868 \begin_layout Plain Layout
21874 files that are shipped with \SpecialChar LyX
21876 \begin_inset CommandInset ref
21878 reference "subsec:Cite-Engine-Files"
21888 \begin_layout Standard
21889 The definitions use a simple language that allows Bib\SpecialChar TeX
21890 keys to be replaced
21892 Keys should be enclosed in
21893 \begin_inset Flex Code
21896 \begin_layout Plain Layout
21903 \begin_inset Flex Code
21906 \begin_layout Plain Layout
21913 So a simple definition might look like this:
21916 \begin_layout LyX-Code
21918 \begin_inset Quotes eld
21922 \begin_inset Quotes erd
21928 \begin_layout Standard
21929 This would print the author, followed by a comma, followed by the title,
21930 in quotes, followed by a period.
21933 \begin_layout Standard
21934 Of course, sometimes you may want to print a key only if it exists.
21935 This can be done by using a conditional construction, such as:
21936 \begin_inset Flex Code
21939 \begin_layout Plain Layout
21941 \begin_inset space ~
21951 \begin_inset Flex Code
21954 \begin_layout Plain Layout
21960 key exists, then print
21961 \begin_inset Quotes eld
21965 \begin_inset space ~
21969 \begin_inset Quotes erd
21972 followed by the volume key.
21973 It is also possible to have an else clause in the conditional, such as:
21974 \begin_inset Newline newline
21978 \begin_inset Flex Code
21981 \begin_layout Plain Layout
21982 {%author%[[%author%]][[%editor%, ed.]]}
21988 \begin_inset Newline newline
21992 \begin_inset Flex Code
21995 \begin_layout Plain Layout
22001 key is printed if it exists; otherwise, the editor key is printed, followed
22003 \begin_inset Quotes eld
22007 \begin_inset space ~
22011 \begin_inset Quotes erd
22014 Note that the key is again enclosed in
22015 \begin_inset Flex Code
22018 \begin_layout Plain Layout
22024 signs; the entire conditional is enclosed in braces; and the if and else
22025 clauses are enclosed in double brackets,
22026 \begin_inset Quotes eld
22030 \begin_inset Flex Code
22033 \begin_layout Plain Layout
22040 \begin_inset Quotes eld
22044 \begin_inset Quotes eld
22048 \begin_inset Flex Code
22051 \begin_layout Plain Layout
22058 \begin_inset Quotes erd
22062 There must be no space between any of these.
22065 \begin_layout Standard
22066 Next to the entry keys, there are some special keys that can be used for
22067 these conditionals:
22070 \begin_layout Itemize
22071 \begin_inset Flex Code
22074 \begin_layout Plain Layout
22075 {%dialog%[[true]][[false]]}
22081 \begin_inset Quotes eld
22085 \begin_inset Quotes erd
22088 part for dialogs and menus, the
22089 \begin_inset Quotes eld
22093 \begin_inset Quotes erd
22096 part for other contexts (workarea, export)
22099 \begin_layout Itemize
22100 \begin_inset Flex Code
22103 \begin_layout Plain Layout
22104 {%export%[[true]][[false]]}
22110 \begin_inset Quotes eld
22114 \begin_inset Quotes erd
22117 part for export and menus, the
22118 \begin_inset Quotes eld
22122 \begin_inset Quotes erd
22125 part for other contexts (workarea, dialog)
22128 \begin_layout Itemize
22129 \begin_inset Flex Code
22132 \begin_layout Plain Layout
22139 \begin_inset Quotes eld
22143 \begin_inset Quotes erd
22146 part if another item follows (e.
22147 \begin_inset space \thinspace{}
22150 g., in a citation with multiple keys)
22153 \begin_layout Itemize
22154 \begin_inset Flex Code
22157 \begin_layout Plain Layout
22158 {%second%[[true]][[false]]}
22164 \begin_inset Quotes eld
22168 \begin_inset Quotes erd
22171 if this is the second of multiple items, else the
22172 \begin_inset Quotes eld
22176 \begin_inset Quotes erd
22182 \begin_layout Itemize
22183 \begin_inset Flex Code
22186 \begin_layout Plain Layout
22187 {%ifstar%[[true]][[false]]}
22193 \begin_inset Quotes eld
22197 \begin_inset Quotes erd
22200 part for starred citation commands (such as
22201 \begin_inset Flex Code
22204 \begin_layout Plain Layout
22212 ), the false part for unstarred
22215 \begin_layout Itemize
22216 \begin_inset Flex Code
22219 \begin_layout Plain Layout
22220 {%ifentrytype:<type>%[[true]][[false]]}
22226 \begin_inset Quotes eld
22230 \begin_inset Quotes erd
22233 if the current entry type matches
22234 \begin_inset Flex Code
22237 \begin_layout Plain Layout
22243 , else the false part (e.g., in a citation definition:
22244 \begin_inset Flex Code
22247 \begin_layout Plain Layout
22248 {%ifentrytype:book%[[this is a book]][[this is no book]]}
22256 \begin_layout Itemize
22257 \begin_inset Flex Code
22260 \begin_layout Plain Layout
22261 {%ifmultiple:<authortype>%[[true]][[false]]}
22267 \begin_inset Quotes eld
22271 \begin_inset Quotes erd
22274 if the current author type (author, editor etc.) has multiple authors, else
22275 the false part (e.g., in a bibliography definition:
22276 \begin_inset Flex Code
22279 \begin_layout Plain Layout
22280 {%ifmultiple:editor%[[eds.]][[ed.]]}
22288 \begin_layout Itemize
22289 \begin_inset Flex Code
22292 \begin_layout Plain Layout
22293 {%ifqualified%[[true]][[false]]}
22299 \begin_inset Quotes eld
22303 \begin_inset Quotes erd
22306 part if the current citation is a qualified citation list (a specific
22310 format for multi-reference citations), the false part if this is not the
22314 \begin_layout Standard
22316 \begin_inset Flex Code
22319 \begin_layout Plain Layout
22325 prints the author key as it is recorded in the bibliography file.
22326 This might not be what you want, since it will result in a string such
22328 \begin_inset Quotes eld
22331 Miller, Peter and Smith, Mary and White, Jane
22332 \begin_inset Quotes erd
22336 \begin_inset Quotes eld
22340 \begin_inset Quotes erd
22343 is used by Bib\SpecialChar TeX
22344 to delimit authors).
22346 therefore provides some methods to get properly formatted name lists (which
22347 will also get translated).
22348 The following keys are provided:
22351 \begin_layout Enumerate
22352 For name lists with pre- and surname, suitable for the main authors/editors
22353 of a bibliography item.
22355 \begin_inset Flex Code
22358 \begin_layout Plain Layout
22364 part denotes the kind of list that is requested (e.g.
22366 \begin_inset Flex Code
22369 \begin_layout Plain Layout
22379 \begin_layout Itemize
22380 \begin_inset Flex Code
22383 \begin_layout Plain Layout
22384 %abbrvnames:<nametype>%
22389 : Provides a name list which is abbreviated (with
22390 \begin_inset Quotes eld
22394 \begin_inset Quotes erd
22398 \begin_inset Flex Code
22401 \begin_layout Plain Layout
22410 \begin_layout Itemize
22411 \begin_inset Flex Code
22414 \begin_layout Plain Layout
22415 %fullnames:<nametype>%
22420 : Provides a full name list (never abbreviated with
22421 \begin_inset Quotes eld
22425 \begin_inset Quotes erd
22431 \begin_layout Itemize
22432 \begin_inset Flex Code
22435 \begin_layout Plain Layout
22436 %forceabbrvnames:<nametype>%
22441 : Provides a name list which is always abbreviated (with
22442 \begin_inset Quotes eld
22446 \begin_inset Quotes erd
22450 \begin_inset Flex Code
22453 \begin_layout Plain Layout
22463 \begin_layout Enumerate
22464 Alternative name lists with pre- and surname, if the order of pre- and surname
22465 inside the bibliography item differs (as in:
22466 \begin_inset Quotes eld
22469 Miller, John: Some text, in: Mary Smith, ed.: A volume
22470 \begin_inset Quotes erd
22477 \begin_layout Itemize
22478 \begin_inset Flex Code
22481 \begin_layout Plain Layout
22482 %abbrvbynames:<nametype>%
22487 : Provides a name list which is abbreviated (with
22488 \begin_inset Quotes eld
22492 \begin_inset Quotes erd
22496 \begin_inset Flex Code
22499 \begin_layout Plain Layout
22508 \begin_layout Itemize
22509 \begin_inset Flex Code
22512 \begin_layout Plain Layout
22513 %fullbynames:<nametype>%
22518 : Provides a full name list (never abbreviated with
22519 \begin_inset Quotes eld
22523 \begin_inset Quotes erd
22529 \begin_layout Itemize
22530 \begin_inset Flex Code
22533 \begin_layout Plain Layout
22534 %forceabbrvbynames:<nametype>%
22539 : Provides a name list which is always abbreviated (with
22540 \begin_inset Quotes eld
22544 \begin_inset Quotes erd
22548 \begin_inset Flex Code
22551 \begin_layout Plain Layout
22561 \begin_layout Enumerate
22562 And finally name lists which consist of family names only, as used in author-yea
22564 These do not take a
22565 \begin_inset Flex Code
22568 \begin_layout Plain Layout
22574 part, but always return either an author list or, if this does not exist,
22575 an editor list (as common in author-year labels):
22579 \begin_layout Itemize
22580 \begin_inset Flex Code
22583 \begin_layout Plain Layout
22589 : Provides a name list which is abbreviated (with
22590 \begin_inset Quotes eld
22594 \begin_inset Quotes erd
22598 \begin_inset Flex Code
22601 \begin_layout Plain Layout
22610 \begin_layout Itemize
22611 \begin_inset Flex Code
22614 \begin_layout Plain Layout
22620 : Provides a full name list (never abbreviated with
22621 \begin_inset Quotes eld
22625 \begin_inset Quotes erd
22631 \begin_layout Itemize
22632 \begin_inset Flex Code
22635 \begin_layout Plain Layout
22636 %forceabbrvciteauthor%
22641 : Provides a name list which is always abbreviated (with
22642 \begin_inset Quotes eld
22646 \begin_inset Quotes erd
22650 \begin_inset Flex Code
22653 \begin_layout Plain Layout
22663 \begin_layout Standard
22664 The order of pre- and surname in the former two lists can be adjusted by
22668 \begin_layout Itemize
22669 \begin_inset Flex Code
22672 \begin_layout Plain Layout
22673 !firstnameform %surname%, %prename%
22678 (first author in lists of type 1)
22681 \begin_layout Itemize
22682 \begin_inset Flex Code
22685 \begin_layout Plain Layout
22686 !othernameform %surname%, %prename%
22691 (other authors in lists of type 1)
22694 \begin_layout Itemize
22695 \begin_inset Flex Code
22698 \begin_layout Plain Layout
22699 !firstbynameform %prename% %surname%
22704 (first author in lists of type 2)
22707 \begin_layout Itemize
22708 \begin_inset Flex Code
22711 \begin_layout Plain Layout
22712 !otherbynameform %prename% %surname%
22717 (other authors in lists of type 2)
22720 \begin_layout Standard
22721 This allows you to configure namings like
22722 \begin_inset Quotes eld
22725 Miller, Peter and Mary Smith: \SpecialChar ldots
22726 , in: John Doe and Pat Green, eds.:\SpecialChar ldots
22728 \begin_inset Quotes erd
22734 \begin_layout Standard
22735 There is one other piece of syntax available in definitions, which looks
22737 \begin_inset Flex Code
22740 \begin_layout Plain Layout
22747 This defines a piece of formatting information that is to be used when
22749 \begin_inset Quotes eld
22753 \begin_inset Quotes erd
22757 Obviously, we do not want to output HTML tags when writing plain text,
22758 so they should be wrapped in
22759 \begin_inset Quotes eld
22763 \begin_inset Quotes erd
22767 \begin_inset Quotes eld
22771 \begin_inset Quotes erd
22777 \begin_layout Standard
22778 Two special sorts of definitions are also possible in a
22779 \begin_inset Flex Code
22782 \begin_layout Plain Layout
22789 An example of the first would be:
22792 \begin_layout LyX-Code
22794 \begin_inset Quotes eld
22798 \begin_inset Quotes erd
22804 \begin_layout Standard
22805 This is an abbreviation, or macro, and it can be used by treating it as
22807 \begin_inset Flex Code
22810 \begin_layout Plain Layout
22819 \begin_inset Flex Code
22822 \begin_layout Plain Layout
22828 exactly as it would treat its definition.
22829 So, let us issue the obvious
22837 \begin_layout LyX-Code
22841 \begin_layout Standard
22842 or anything like it.
22844 shouldn't go into an infinite loop, but it may go into a long one before
22848 \begin_layout Standard
22849 The second sort of special definition might look like this:
22852 \begin_layout LyX-Code
22856 \begin_layout Standard
22857 This defines a translatable piece of text, which allows relevant parts of
22858 the bibliography or citation to be translated.
22859 It can be included in a definition by treating it as a key:
22860 \begin_inset Flex Code
22863 \begin_layout Plain Layout
22870 Several of these are predefined in
22871 \begin_inset Flex Code
22874 \begin_layout Plain Layout
22881 \begin_inset Flex Code
22884 \begin_layout Plain Layout
22891 Note that these are not macros, in the sense just defined.
22892 They will not be expanded.
22895 \begin_layout Standard
22896 So here then is an example that use all these features:
22897 \begin_inset VSpace defskip
22903 \begin_layout Standard
22907 !authoredit {%author%[[%author%, ]][[{%editor%[[%editor%, %_edtext%, ]]}]]}
22910 \begin_layout Standard
22911 \begin_inset VSpace defskip
22914 This defines a macro that prints the author, followed by a comma, if the
22916 \begin_inset Flex Code
22919 \begin_layout Plain Layout
22925 key is defined, or else prints the name of the editor, followed by the
22927 \begin_inset Flex Code
22930 \begin_layout Plain Layout
22936 or its translation (it is by default
22937 \begin_inset Quotes eld
22941 \begin_inset Quotes erd
22945 \begin_inset Flex Code
22948 \begin_layout Plain Layout
22955 Note that this is in fact defined in
22956 \begin_inset Flex Code
22959 \begin_layout Plain Layout
22965 , so you can use it in your own definitions, or re-definitions, if you load
22969 \begin_layout Section
22970 \begin_inset CommandInset label
22972 name "sec:Tags-for-XHTML"
22976 Tags for XHTML output
22979 \begin_layout Standard
22980 As with \SpecialChar LaTeX
22981 or DocBook, the format of \SpecialChar LyX
22982 's XHTML output is also controlled by
22983 layout information.
22984 In general, \SpecialChar LyX
22985 provides sensible defaults and, as mentioned earlier, it will
22986 even construct default CSS style rules from the other layout tags.
22987 For example, \SpecialChar LyX
22988 will attempt to use the information provided in the
22989 \begin_inset Flex Code
22992 \begin_layout Plain Layout
22998 declaration for the Chapter style to write CSS that will appropriately
22999 format chapter headings.
23002 \begin_layout Standard
23003 In many cases, then, you may not have to do anything at all to get acceptable
23004 XHTML output for your own environments, custom insets, and so forth.
23005 But in some cases you will, and so \SpecialChar LyX
23006 provides a number of layout tags that
23007 can be used to customize the XHTML and CSS that are generated.
23010 \begin_layout Standard
23011 Note that there are two tags,
23012 \begin_inset Flex Code
23015 \begin_layout Plain Layout
23022 \begin_inset Flex Code
23025 \begin_layout Plain Layout
23031 that may appear outside style and inset declarations.
23033 \begin_inset CommandInset ref
23035 reference "subsec:General-text-class"
23039 for details on these.
23042 \begin_layout Subsection
23043 \begin_inset CommandInset label
23045 name "subsec:Paragraph-Style-XHTML"
23052 \begin_layout Standard
23053 The sort of XHTML \SpecialChar LyX
23054 outputs for a paragraph depends upon whether we are dealing
23055 with a normal paragraph, a command, or an environment, where this is itself
23056 determined by the contents of the corresponding
23057 \begin_inset Flex Code
23060 \begin_layout Plain Layout
23071 \begin_layout Standard
23072 For a command or normal paragraph, the output XHTML has the following form:
23075 \begin_layout LyX-Code
23077 \begin_inset Quotes erd
23081 \begin_inset Quotes erd
23087 \begin_layout LyX-Code
23089 \begin_inset Quotes erd
23093 \begin_inset Quotes erd
23099 \begin_layout LyX-Code
23100 Contents of the paragraph.
23103 \begin_layout LyX-Code
23107 \begin_layout Standard
23108 The label tags are of course omitted if the paragraph does not have a label.
23111 \begin_layout Standard
23112 For an environment that is not some sort of list, the XHTML takes this form:
23115 \begin_layout LyX-Code
23117 \begin_inset Quotes erd
23121 \begin_inset Quotes erd
23127 \begin_layout LyX-Code
23129 \begin_inset Quotes erd
23133 \begin_inset Quotes erd
23137 \begin_inset Quotes erd
23141 \begin_inset Quotes erd
23144 >Environment Label</labeltag>First paragraph.</itemtag>
23147 \begin_layout LyX-Code
23148 <itemtag>Second paragraph.</itemtag>
23151 \begin_layout LyX-Code
23155 \begin_layout Standard
23156 Note that the label is output only for the first paragraph, as it should
23157 be for a theorem, for example.
23161 \begin_layout Standard
23162 For a list, we have one of these forms:
23165 \begin_layout LyX-Code
23167 \begin_inset Quotes erd
23171 \begin_inset Quotes erd
23177 \begin_layout LyX-Code
23179 \begin_inset Quotes erd
23183 \begin_inset Quotes erd
23187 \begin_inset Quotes erd
23191 \begin_inset Quotes erd
23194 >List Label</labeltag>First item.</itemtag>
23197 \begin_layout LyX-Code
23199 \begin_inset Quotes erd
23203 \begin_inset Quotes erd
23207 \begin_inset Quotes erd
23211 \begin_inset Quotes erd
23214 >List Label</labeltag>Second item.</itemtag>
23217 \begin_layout LyX-Code
23221 \begin_layout LyX-Code
23225 \begin_layout LyX-Code
23227 \begin_inset Quotes erd
23231 \begin_inset Quotes erd
23237 \begin_layout LyX-Code
23239 \begin_inset Quotes erd
23243 \begin_inset Quotes erd
23246 >List Label</labeltag><itemtag attr=
23247 \begin_inset Quotes erd
23251 \begin_inset Quotes erd
23254 >First item.</itemtag>
23257 \begin_layout LyX-Code
23259 \begin_inset Quotes erd
23263 \begin_inset Quotes erd
23266 >List Label</labeltag><itemtag attr=
23267 \begin_inset Quotes erd
23271 \begin_inset Quotes erd
23274 >Second item.</itemtag>
23277 \begin_layout LyX-Code
23281 \begin_layout Standard
23282 Note the different orders of
23283 \begin_inset Flex Code
23286 \begin_layout Plain Layout
23293 \begin_inset Flex Code
23296 \begin_layout Plain Layout
23303 Which order we get depends upon the setting of
23304 \begin_inset Flex Code
23307 \begin_layout Plain Layout
23314 \begin_inset Flex Code
23317 \begin_layout Plain Layout
23323 is false (the default), you get the first of these, with the label within
23324 the item; if true, you get the second, with the label outside the item.
23327 \begin_layout Standard
23328 The specific tags and attributes output for each paragraph type can be controlle
23329 d by means of the layout tags we are about to describe.
23330 As mentioned earlier, however, \SpecialChar LyX
23331 uses sensible defaults for many of these,
23332 so you often may not need to do very much to get good XHTML output.
23333 Think of the available tags as there so you can tweak things to your liking.
23336 \begin_layout Description
23337 \begin_inset Flex Code
23340 \begin_layout Plain Layout
23347 \begin_inset Flex Code
23350 \begin_layout Plain Layout
23356 ] Specifies attribute information to be output with the main tag.
23358 \begin_inset Quotes eld
23362 \begin_inset Flex Code
23365 \begin_layout Plain Layout
23372 \begin_inset Quotes erd
23376 By default, \SpecialChar LyX
23378 \begin_inset Quotes eld
23382 \begin_inset Flex Code
23385 \begin_layout Plain Layout
23392 \begin_inset Quotes erd
23396 \begin_inset Flex Code
23399 \begin_layout Plain Layout
23405 is the \SpecialChar LyX
23406 name of the layout, made lowercase, for example: chapter.
23411 contain any style information.
23413 \begin_inset Flex Code
23416 \begin_layout Plain Layout
23425 \begin_layout Description
23426 \begin_inset Flex Code
23429 \begin_layout Plain Layout
23436 \begin_inset Flex Code
23439 \begin_layout Plain Layout
23449 ] Whether to output the default CSS information \SpecialChar LyX
23450 generates for this layout,
23451 even if additional information is explicitly provided via
23452 \begin_inset Flex Code
23455 \begin_layout Plain Layout
23463 \begin_inset Flex Code
23466 \begin_layout Plain Layout
23472 allows you to alter or augment the generated CSS, rather than to override
23475 \begin_inset Flex Code
23478 \begin_layout Plain Layout
23487 \begin_layout Description
23488 \begin_inset Flex Code
23491 \begin_layout Plain Layout
23498 \begin_inset Flex Code
23501 \begin_layout Plain Layout
23507 ] The tag to be used for individual paragraphs of environments, replacing
23509 \begin_inset Flex Code
23512 \begin_layout Plain Layout
23518 in the examples above.
23520 \begin_inset Flex Code
23523 \begin_layout Plain Layout
23532 \begin_layout Description
23533 \begin_inset Flex Code
23536 \begin_layout Plain Layout
23543 \begin_inset Flex Code
23546 \begin_layout Plain Layout
23552 ] Attributes for the item tag.
23554 \begin_inset Quotes eld
23558 \begin_inset Flex Code
23561 \begin_layout Plain Layout
23562 class=`layoutname_item'
23568 \begin_inset Quotes erd
23576 contain any style information.
23578 \begin_inset Flex Code
23581 \begin_layout Plain Layout
23590 \begin_layout Description
23591 \begin_inset Flex Code
23594 \begin_layout Plain Layout
23601 \begin_inset Flex Code
23604 \begin_layout Plain Layout
23610 ] The tag to be used for paragraph and item labels, replacing
23611 \begin_inset Flex Code
23614 \begin_layout Plain Layout
23620 in the examples above.
23622 \begin_inset Flex Code
23625 \begin_layout Plain Layout
23632 \begin_inset Flex Code
23635 \begin_layout Plain Layout
23642 \begin_inset Flex Code
23645 \begin_layout Plain Layout
23652 \begin_inset Flex Code
23655 \begin_layout Plain Layout
23656 Centered_Top_Environment
23661 , in which case it defaults to
23662 \begin_inset Flex Code
23665 \begin_layout Plain Layout
23674 \begin_layout Description
23675 \begin_inset Flex Code
23678 \begin_layout Plain Layout
23685 \begin_inset Flex Code
23688 \begin_layout Plain Layout
23694 ] Attributes for the label tag.
23696 \begin_inset Quotes eld
23700 \begin_inset Flex Code
23703 \begin_layout Plain Layout
23704 class=`layoutname_label'
23710 \begin_inset Quotes erd
23718 contain any style information.
23720 \begin_inset Flex Code
23723 \begin_layout Plain Layout
23732 \begin_layout Description
23733 \begin_inset Flex Code
23736 \begin_layout Plain Layout
23743 \begin_inset Flex Code
23746 \begin_layout Plain Layout
23756 ] Meaningful only for list-like environments, this tag controls whether
23757 the label tag is output before or inside the item tag.
23758 This is used, for example, in the description environment, where we want
23760 \begin_inset Flex Code
23763 \begin_layout Plain Layout
23764 <dt>\SpecialChar ldots
23765 </dt><dd>\SpecialChar ldots
23773 \begin_inset Flex Code
23776 \begin_layout Plain Layout
23782 : The label tag is output inside the item tag.
23785 \begin_layout Description
23786 \begin_inset Flex Code
23789 \begin_layout Plain Layout
23795 Information to be output in the
23796 \begin_inset Flex Code
23799 \begin_layout Plain Layout
23805 section when this style is used.
23806 This might, for example, be used to include a
23807 \begin_inset Flex Code
23810 \begin_layout Plain Layout
23817 \begin_inset Flex Code
23820 \begin_layout Plain Layout
23829 \begin_layout Description
23830 \begin_inset Flex Code
23833 \begin_layout Plain Layout
23839 CSS style information to be included when this style is used.
23840 Note that this will automatically be wrapped in a layout-generated
23841 \begin_inset Flex Code
23844 \begin_layout Plain Layout
23850 block, so only the CSS itself need be included.
23852 \begin_inset Flex Code
23855 \begin_layout Plain Layout
23864 \begin_layout Description
23865 \begin_inset Flex Code
23868 \begin_layout Plain Layout
23875 \begin_inset Flex Code
23878 \begin_layout Plain Layout
23884 ] The tag to be used for the main label, replacing
23885 \begin_inset Flex Code
23888 \begin_layout Plain Layout
23894 in the examples above.
23896 \begin_inset Flex Code
23899 \begin_layout Plain Layout
23908 \begin_layout Description
23909 \begin_inset Flex Code
23912 \begin_layout Plain Layout
23919 \begin_inset Flex Code
23922 \begin_layout Plain Layout
23932 ] Marks this style as the one to be used to generate the
23933 \begin_inset Flex Code
23936 \begin_layout Plain Layout
23942 tag for the XHTML file.
23943 By default, it is false.
23945 \begin_inset Flex Code
23948 \begin_layout Plain Layout
23954 file sets it to true for the
23955 \begin_inset Flex Code
23958 \begin_layout Plain Layout
23968 \begin_layout Subsection
23972 \begin_layout Standard
23973 The XHTML output of insets can also be controlled by information in layout
23978 \begin_layout Plain Layout
23979 At present, this is true only for
23980 \begin_inset Quotes eld
23984 \begin_inset Quotes erd
23987 insets (insets you can type into) and is not true for
23988 \begin_inset Quotes eld
23992 \begin_inset Quotes erd
23995 insets (insets that are associated with dialog boxes).
24000 Here, too, \SpecialChar LyX
24001 tries to provide sensible defaults, and it constructs default
24003 But everything can be customized.
24006 \begin_layout Standard
24007 The XHTML \SpecialChar LyX
24008 outputs for an inset has the following form:
24011 \begin_layout LyX-Code
24013 \begin_inset Quotes erd
24017 \begin_inset Quotes erd
24023 \begin_layout LyX-Code
24024 <labeltag>Label</labeltag>
24027 \begin_layout LyX-Code
24029 \begin_inset Quotes erd
24033 \begin_inset Quotes erd
24036 >Contents of the inset.</innertag>
24039 \begin_layout LyX-Code
24043 \begin_layout Standard
24044 If the inset permits multiple paragraphs—that is, if
24045 \begin_inset Flex Code
24048 \begin_layout Plain Layout
24054 is true—then the contents of the inset will itself be output as paragraphs
24055 formatted according to the styles used for those paragraphs (standard,
24056 quote, and the like).
24057 The label tag is of course omitted if the paragraph does not have a label
24058 and, at present, is always
24059 \begin_inset Flex Code
24062 \begin_layout Plain Layout
24069 The inner tag is optional and, by default, does not appear.
24072 \begin_layout Standard
24073 The specific tags and attributes output for each inset can be controlled
24074 by means of the following layout tags.
24077 \begin_layout Description
24078 \begin_inset Flex Code
24081 \begin_layout Plain Layout
24088 \begin_inset Flex Code
24091 \begin_layout Plain Layout
24097 ] Specifies attribute information to be output with the main tag.
24099 \begin_inset Quotes eld
24103 \begin_inset Flex Code
24106 \begin_layout Plain Layout
24107 class=`myinset' onclick=`\SpecialChar ldots
24114 \begin_inset Quotes erd
24118 By default, \SpecialChar LyX
24120 \begin_inset Quotes eld
24124 \begin_inset Flex Code
24127 \begin_layout Plain Layout
24134 \begin_inset Quotes erd
24138 \begin_inset Flex Code
24141 \begin_layout Plain Layout
24147 is the \SpecialChar LyX
24148 name of the inset, made lowercase and with non-alphanumeric characters
24149 converted to underscores, for example: footnote.
24152 \begin_layout Description
24153 \begin_inset Flex Code
24156 \begin_layout Plain Layout
24163 \begin_inset Flex Code
24166 \begin_layout Plain Layout
24176 ] Whether to output the default CSS information \SpecialChar LyX
24177 generates for this layout,
24178 even if additional information is explicitly provided via
24179 \begin_inset Flex Code
24182 \begin_layout Plain Layout
24190 \begin_inset Flex Code
24193 \begin_layout Plain Layout
24199 allows you to alter or augment the generated CSS, rather than to override
24204 \begin_layout Description
24205 \begin_inset Flex Code
24208 \begin_layout Plain Layout
24215 \begin_inset Flex Code
24218 \begin_layout Plain Layout
24224 ] Attributes for the inner tag.
24226 \begin_inset Quotes eld
24230 \begin_inset Flex Code
24233 \begin_layout Plain Layout
24234 class=`insetname_inner'
24240 \begin_inset Quotes erd
24246 \begin_layout Description
24247 \begin_inset Flex Code
24250 \begin_layout Plain Layout
24257 \begin_inset Flex Code
24260 \begin_layout Plain Layout
24266 ] The inner tag, replacing
24267 \begin_inset Flex Code
24270 \begin_layout Plain Layout
24276 in the examples above.
24277 By default, there is none.
24280 \begin_layout Description
24281 \begin_inset Flex Code
24284 \begin_layout Plain Layout
24291 \begin_inset Flex Code
24294 \begin_layout Plain Layout
24302 ] Whether this inset represents a standalone block of text (such as a footnote)
24303 or instead represents material that is included in the surrounding text
24304 (such as a branch).
24308 \begin_layout Description
24309 \begin_inset Flex Code
24312 \begin_layout Plain Layout
24319 \begin_inset Flex Code
24322 \begin_layout Plain Layout
24328 ] A label for this inset, possibly including a reference to a counter.
24329 For example, for footnote, it might be:
24330 \begin_inset Flex Code
24333 \begin_layout Plain Layout
24342 This is optional, and there is no default.
24345 \begin_layout Description
24346 \begin_inset Flex Code
24349 \begin_layout Plain Layout
24355 Information to be output in the
24356 \begin_inset Flex Code
24359 \begin_layout Plain Layout
24365 section when this style is used.
24366 This might, for example, be used to include a
24367 \begin_inset Flex Code
24370 \begin_layout Plain Layout
24377 \begin_inset Flex Code
24380 \begin_layout Plain Layout
24389 \begin_layout Description
24390 \begin_inset Flex Code
24393 \begin_layout Plain Layout
24399 CSS style information to be included when this style is used.
24400 Note that this will automatically be wrapped in a layout-generated
24401 \begin_inset Flex Code
24404 \begin_layout Plain Layout
24410 block, so only the CSS itself need be included.
24413 \begin_layout Description
24414 \begin_inset Flex Code
24417 \begin_layout Plain Layout
24424 \begin_inset Flex Code
24427 \begin_layout Plain Layout
24433 ] The tag to be used for the main label, replacing
24434 \begin_inset Flex Code
24437 \begin_layout Plain Layout
24443 in the examples above.
24444 The default depends upon the setting of
24445 \begin_inset Flex Code
24448 \begin_layout Plain Layout
24455 \begin_inset Flex Code
24458 \begin_layout Plain Layout
24464 is true, the default is
24465 \begin_inset Flex Code
24468 \begin_layout Plain Layout
24474 ; if it is false, the default is
24475 \begin_inset Flex Code
24478 \begin_layout Plain Layout
24487 \begin_layout Subsection
24491 \begin_layout Standard
24492 The XHTML output for floats too can be controlled by layout information.
24493 The output has the following form:
24496 \begin_layout LyX-Code
24498 \begin_inset Quotes erd
24502 \begin_inset Quotes erd
24508 \begin_layout LyX-Code
24509 Contents of the float.
24512 \begin_layout LyX-Code
24516 \begin_layout Standard
24517 The caption, if there is one, is a separate inset and will be output as
24519 Its appearance can be controlled via the InsetLayout for caption insets.
24523 \begin_layout Description
24524 \begin_inset Flex Code
24527 \begin_layout Plain Layout
24534 \begin_inset Flex Code
24537 \begin_layout Plain Layout
24543 ] Specifies attribute information to be output with the main tag.
24545 \begin_inset Quotes eld
24549 \begin_inset Flex Code
24552 \begin_layout Plain Layout
24553 class=`myfloat' onclick=`\SpecialChar ldots
24560 \begin_inset Quotes erd
24564 By default, \SpecialChar LyX
24566 \begin_inset Quotes eld
24570 \begin_inset Flex Code
24573 \begin_layout Plain Layout
24574 class=`float float-floattype'
24580 \begin_inset Quotes erd
24584 \begin_inset Flex Code
24587 \begin_layout Plain Layout
24593 is \SpecialChar LyX
24594 's name for this type of float, as determined by the float declaration
24596 \begin_inset CommandInset ref
24598 reference "subsec:Floats"
24602 ), though made lowercase and with non-alphanumeric characters converted
24603 to underscores, for example: float-table.
24606 \begin_layout Description
24607 \begin_inset Flex Code
24610 \begin_layout Plain Layout
24616 CSS style information to be included when this float is used.
24617 Note that this will automatically be wrapped in a layout-generated
24618 \begin_inset Flex Code
24621 \begin_layout Plain Layout
24627 block, so only the CSS itself need be included.
24630 \begin_layout Description
24631 \begin_inset Flex Code
24634 \begin_layout Plain Layout
24641 \begin_inset Flex Code
24644 \begin_layout Plain Layout
24650 ] The tag to be used for this float, replacing
24651 \begin_inset Quotes eld
24655 \begin_inset Flex Code
24658 \begin_layout Plain Layout
24665 \begin_inset Quotes erd
24668 in the example above.
24670 \begin_inset Flex Code
24673 \begin_layout Plain Layout
24679 and will rarely need changing.
24682 \begin_layout Subsection
24683 Bibliography formatting
24686 \begin_layout Standard
24687 The bibliography can be formatted using
24688 \begin_inset Flex Code
24691 \begin_layout Plain Layout
24699 \begin_inset CommandInset ref
24701 reference "subsec:Citation-format-description"
24708 \begin_layout Subsection
24713 \begin_layout Standard
24714 We have several times mentioned that \SpecialChar LyX
24715 will generate default CSS style rules
24716 for both insets and paragraph styles, based upon the other layout information
24718 In this section, we shall say a word about which layout information \SpecialChar LyX
24723 \begin_layout Standard
24724 At present, \SpecialChar LyX
24725 auto-generates CSS only for font information, making use of
24727 \begin_inset Flex Code
24730 \begin_layout Plain Layout
24737 \begin_inset Flex Code
24740 \begin_layout Plain Layout
24747 \begin_inset Flex Code
24750 \begin_layout Plain Layout
24757 \begin_inset Flex Code
24760 \begin_layout Plain Layout
24767 \begin_inset Flex Code
24770 \begin_layout Plain Layout
24777 \begin_inset CommandInset ref
24779 reference "subsec:Font-description"
24784 The translation is mostly straightforward and obvious.
24786 \begin_inset Quotes eld
24790 \begin_inset Flex Code
24793 \begin_layout Plain Layout
24800 \begin_inset Quotes erd
24804 \begin_inset Quotes eld
24808 \begin_inset Flex Code
24811 \begin_layout Plain Layout
24812 font-family: sans-serif;
24818 \begin_inset Quotes erd
24822 The correspondence of \SpecialChar LyX
24823 sizes and CSS sizes is a little less obvious but
24824 nonetheless intuitive.
24826 \begin_inset Flex Code
24829 \begin_layout Plain Layout
24836 \begin_inset Flex URL
24839 \begin_layout Plain Layout
24849 \begin_layout Chapter
24850 Including External Material
24851 \begin_inset CommandInset label
24853 name "chap:Including-External-Material"
24860 \begin_layout Standard
24861 \begin_inset Box Shadowbox
24871 height_special "totalheight"
24876 backgroundcolor "none"
24879 \begin_layout Plain Layout
24880 WARNING: This portion of the documentation has not been updated for some
24882 We certainly hope that it is still accurate, but there are no guarantees.
24890 \begin_layout Standard
24891 The use of material from sources external to \SpecialChar LyX
24892 is covered in detail in the
24898 This part of the manual covers what needs to happen behind the scenes for
24899 new sorts of material to be included.
24902 \begin_layout Section
24906 \begin_layout Standard
24907 The external material feature is based on the concept of a
24912 A template is a specification of how \SpecialChar LyX
24913 should interface with a certain kind
24915 As bundled, \SpecialChar LyX
24916 comes with predefined templates for Xfig figures, various
24917 raster format images, chess diagrams, and LilyPond music notation.
24918 You can check the actual list by using the menu
24919 \begin_inset Flex Noun
24922 \begin_layout Plain Layout
24923 Insert\SpecialChar menuseparator
24924 File\SpecialChar menuseparator
24931 Furthermore, it is possible to roll your own template to support a specific
24933 Later we'll describe in more detail what is involved, and hopefully you
24934 will submit all the templates you create so we can include them in a later
24939 \begin_layout Standard
24940 Another basic idea of the external material feature is to distinguish between
24941 the original file that serves as a base for final material and the produced
24942 file that is included in your exported or printed document.
24943 For example, consider the case of a figure produced with
24944 \begin_inset Flex Code
24947 \begin_layout Plain Layout
24954 The Xfig application itself works on an original file with the
24955 \begin_inset Flex Code
24958 \begin_layout Plain Layout
24965 Within Xfig, you create and change your figure, and when you are done,
24967 \begin_inset Flex Code
24970 \begin_layout Plain Layout
24977 When you want to include the figure in your document, you invoke
24978 \begin_inset Flex Code
24981 \begin_layout Plain Layout
24987 in order to create a PostScript file that can readily be included in your
24991 \begin_inset Flex Code
24994 \begin_layout Plain Layout
25000 file is the original file, and the PostScript file is the produced file.
25003 \begin_layout Standard
25004 This distinction is important in order to allow updating of the material
25005 while you are in the process of writing the document.
25006 Furthermore, it provides us with the flexibility that is needed to support
25007 multiple export formats.
25008 For instance, in the case of a plain text file, it is not exactly an award-winn
25009 ing idea to include the figure as raw PostScript.
25010 Instead, you would either prefer to just include a reference to the figure
25011 or try to invoke some graphics to ASCII converter to make the final result
25012 look similar to the real graphics.
25013 The external material management allows you to do this, because it is parametri
25014 zed on the different export formats that \SpecialChar LyX
25018 \begin_layout Standard
25019 Besides supporting the production of different products according to the
25020 exported format, it supports tight integration with editing and viewing
25022 In the case of an Xfig figure, you are able to invoke Xfig on the original
25023 file with a single click from within the external material dialog in \SpecialChar LyX
25025 and also preview the produced PostScript file with Ghostview with another
25027 No more fiddling around with the command line and/or file browsers to locate
25028 and manipulate the original or produced files.
25029 In this way, you are finally able to take full advantage of the many different
25030 applications that are relevant to use when you write your documents, and
25031 ultimately be more productive.
25034 \begin_layout Section
25035 The external template configuration files
25038 \begin_layout Standard
25039 It is relatively easy to add custom external template definitions to \SpecialChar LyX
25041 However, be aware that doing this in an careless manner most probably
25045 introduce an easily exploitable security hole.
25046 So before you do this, please read the discussion about security in
25047 \begin_inset CommandInset ref
25049 reference "sec:Security-discussion"
25056 \begin_layout Standard
25057 Having said that, we encourage you to submit any interesting templates that
25062 \begin_layout Standard
25063 The external templates are defined in the
25064 \begin_inset Flex Code
25067 \begin_layout Plain Layout
25073 files that are stored in the
25074 \begin_inset Flex Code
25077 \begin_layout Plain Layout
25078 LyXDir/lib/xtemplates/
25084 Each template is defined in a file of its own.
25085 You can place your own templates in
25086 \begin_inset Flex Code
25089 \begin_layout Plain Layout
25090 UserDir/xtemplates/
25095 or copy existing templates to that directory in order to modify them.
25098 \begin_layout Standard
25099 A typical template looks like this:
25102 \begin_layout LyX-Code
25106 \begin_layout LyX-Code
25107 GuiName "XFig: $$AbsOrRelPathParent$$Basename"
25110 \begin_layout LyX-Code
25114 \begin_layout LyX-Code
25118 \begin_layout LyX-Code
25122 \begin_layout LyX-Code
25126 \begin_layout LyX-Code
25130 \begin_layout LyX-Code
25131 AutomaticProduction true
25134 \begin_layout LyX-Code
25138 \begin_layout LyX-Code
25142 \begin_layout LyX-Code
25146 \begin_layout LyX-Code
25147 TransformCommand Rotate RotationLatexCommand
25150 \begin_layout LyX-Code
25151 TransformCommand Resize ResizeLatexCommand
25154 \begin_layout LyX-Code
25155 Product "$$RotateFront$$ResizeFront
25158 \begin_layout LyX-Code
25163 input{$$AbsOrRelPathMaster$$Basename.pstex_t}
25166 \begin_layout LyX-Code
25167 $$ResizeBack$$RotateBack"
25170 \begin_layout LyX-Code
25174 \begin_layout LyX-Code
25175 UpdateResult "$$AbsPath$$Basename.pstex_t"
25178 \begin_layout LyX-Code
25179 Requirement "graphicx"
25182 \begin_layout LyX-Code
25183 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
25186 \begin_layout LyX-Code
25187 ReferencedFile latex "$$AbsPath$$Basename.eps"
25190 \begin_layout LyX-Code
25191 ReferencedFile dvi "$$AbsPath$$Basename.eps"
25194 \begin_layout LyX-Code
25198 \begin_layout LyX-Code
25202 \begin_layout LyX-Code
25203 TransformCommand Rotate RotationLatexCommand
25206 \begin_layout LyX-Code
25207 TransformCommand Resize ResizeLatexCommand
25210 \begin_layout LyX-Code
25211 Product "$$RotateFront$$ResizeFront
25214 \begin_layout LyX-Code
25219 input{$$AbsOrRelPathMaster$$Basename.pdftex_t}
25222 \begin_layout LyX-Code
25223 $$ResizeBack$$RotateBack"
25226 \begin_layout LyX-Code
25227 UpdateFormat pdftex
25230 \begin_layout LyX-Code
25231 UpdateResult "$$AbsPath$$Basename.pdftex_t"
25234 \begin_layout LyX-Code
25235 Requirement "graphicx"
25238 \begin_layout LyX-Code
25239 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pdftex_t"
25242 \begin_layout LyX-Code
25243 ReferencedFile latex "$$AbsPath$$Basename.pdf"
25246 \begin_layout LyX-Code
25250 \begin_layout LyX-Code
25254 \begin_layout LyX-Code
25255 Product "[XFig: $$FName]"
25258 \begin_layout LyX-Code
25262 \begin_layout LyX-Code
25266 \begin_layout LyX-Code
25267 Product "<graphic fileref=
25269 "$$AbsOrRelPathMaster$$Basename.eps
25274 \begin_layout LyX-Code
25278 \begin_layout LyX-Code
25282 \begin_layout LyX-Code
25283 UpdateResult "$$AbsPath$$Basename.eps"
25286 \begin_layout LyX-Code
25287 ReferencedFile docbook "$$AbsPath$$Basename.eps"
25290 \begin_layout LyX-Code
25291 ReferencedFile docbook-xml "$$AbsPath$$Basename.eps"
25294 \begin_layout LyX-Code
25298 \begin_layout LyX-Code
25302 \begin_layout Standard
25303 As you can see, the template is enclosed in
25304 \begin_inset Flex Code
25307 \begin_layout Plain Layout
25315 \begin_inset Flex Code
25318 \begin_layout Plain Layout
25325 It contains a header specifying some general settings and, for each supported
25326 primary document file format, a section
25327 \begin_inset Flex Code
25330 \begin_layout Plain Layout
25338 \begin_inset Flex Code
25341 \begin_layout Plain Layout
25350 \begin_layout Subsection
25351 The template header
25354 \begin_layout Description
25355 \begin_inset Flex Code
25358 \begin_layout Plain Layout
25359 AutomaticProduction
25360 \begin_inset space ~
25368 Whether the file represented by the template must be generated by \SpecialChar LyX
25370 This command must occur exactly once.
25373 \begin_layout Description
25374 \begin_inset Flex Code
25377 \begin_layout Plain Layout
25379 \begin_inset space ~
25387 A glob pattern that is used in the file dialog to filter out the desired
25389 If there is more than one possible file extension (e.
25390 \begin_inset space \thinspace{}
25394 \begin_inset space \space{}
25398 \begin_inset Flex Code
25401 \begin_layout Plain Layout
25408 \begin_inset Flex Code
25411 \begin_layout Plain Layout
25417 ), use something like
25418 \begin_inset Flex Code
25421 \begin_layout Plain Layout
25428 This command must occur exactly once.
25431 \begin_layout Description
25432 \begin_inset Flex Code
25435 \begin_layout Plain Layout
25437 \begin_inset space ~
25445 The text that is displayed on the button.
25446 This command must occur exactly once.
25449 \begin_layout Description
25450 \begin_inset Flex Code
25453 \begin_layout Plain Layout
25455 \begin_inset space ~
25459 \begin_inset space ~
25467 The help text that is used in the External dialog.
25468 Provide enough information to explain to the user just what the template
25469 can provide him with.
25470 This command must occur exactly once.
25473 \begin_layout Description
25474 \begin_inset Flex Code
25477 \begin_layout Plain Layout
25479 \begin_inset space ~
25487 The file format of the original file.
25488 This must be the name of a format that is known to \SpecialChar LyX
25490 \begin_inset CommandInset ref
25492 reference "sec:Formats"
25498 \begin_inset Quotes eld
25502 \begin_inset Flex Code
25505 \begin_layout Plain Layout
25512 \begin_inset Quotes erd
25515 if the template can handle original files of more than one format.
25517 will attempt to interrogate the file itself in order to deduce its format
25519 This command must occur exactly once.
25522 \begin_layout Description
25523 \begin_inset Flex Code
25526 \begin_layout Plain Layout
25528 \begin_inset space ~
25536 A unique name for the template.
25537 It must not contain substitution macros (see below).
25540 \begin_layout Description
25541 \begin_inset Flex Code
25544 \begin_layout Plain Layout
25546 \begin_inset space ~
25549 Rotate|Resize|Clip|Extra
25554 This command specifies which transformations are supported by this template.
25555 It may occur zero or more times.
25556 This command enables the corresponding tabs in the external dialog.
25558 \begin_inset Flex Code
25561 \begin_layout Plain Layout
25567 command must have either a corresponding
25568 \begin_inset Flex Code
25571 \begin_layout Plain Layout
25578 \begin_inset Flex Code
25581 \begin_layout Plain Layout
25588 \begin_inset Flex Code
25591 \begin_layout Plain Layout
25598 Otherwise the transformation will not be supported by that format.
25601 \begin_layout Subsection
25605 \begin_layout Description
25606 \begin_inset Flex Code
25609 \begin_layout Plain Layout
25611 \begin_inset space ~
25614 LaTeX|PDFLaTeX|PlainText|DocBook|XHTML
25619 The primary document file format that this format definition is for.
25620 Not every template has a sensible representation in all document file formats.
25621 Please define nevertheless a
25622 \begin_inset Flex Code
25625 \begin_layout Plain Layout
25631 section for all templates.
25632 Use a dummy text when no representation is available.
25633 Then you can at least see a reference to the external material in the exported
25637 \begin_layout Description
25638 \begin_inset Flex Code
25641 \begin_layout Plain Layout
25643 \begin_inset space ~
25647 \begin_inset space ~
25655 This command defines an additional macro
25656 \begin_inset Flex Code
25659 \begin_layout Plain Layout
25665 for substitution in
25666 \begin_inset Flex Code
25669 \begin_layout Plain Layout
25677 \begin_inset Flex Code
25680 \begin_layout Plain Layout
25686 itself may contain substitution macros.
25687 The advantage over using
25688 \begin_inset Flex Code
25691 \begin_layout Plain Layout
25698 \begin_inset Flex Code
25701 \begin_layout Plain Layout
25707 is that the substituted value of
25708 \begin_inset Flex Code
25711 \begin_layout Plain Layout
25717 is sanitized so that it is a valid optional argument in the document format.
25718 This command may occur zero or more times.
25721 \begin_layout Description
25722 \begin_inset Flex Code
25725 \begin_layout Plain Layout
25727 \begin_inset space ~
25735 The text that is inserted in the exported document.
25736 This is actually the most important command and can be quite complex.
25737 This command must occur exactly once.
25740 \begin_layout Description
25741 \begin_inset Flex Code
25744 \begin_layout Plain Layout
25746 \begin_inset space ~
25754 This command specifies a preamble snippet that will be included in the
25757 It has to be defined using
25758 \begin_inset Flex Code
25761 \begin_layout Plain Layout
25769 \begin_inset Flex Code
25772 \begin_layout Plain Layout
25779 This command may occur zero or more times.
25782 \begin_layout Description
25783 \begin_inset Flex Code
25786 \begin_layout Plain Layout
25788 \begin_inset space ~
25792 \begin_inset space ~
25800 This command denotes files that are created by the conversion process and
25801 are needed for a particular export format.
25802 If the filename is relative, it is interpreted relative to the master document.
25803 This command may be given zero or more times.
25806 \begin_layout Description
25807 \begin_inset Flex Code
25810 \begin_layout Plain Layout
25812 \begin_inset space ~
25820 The name of a required \SpecialChar LaTeX
25822 The package is included via
25823 \begin_inset Flex Code
25826 \begin_layout Plain Layout
25834 in the \SpecialChar LaTeX
25836 This command may occur zero or more times.
25839 \begin_layout Description
25840 \begin_inset Flex Code
25843 \begin_layout Plain Layout
25845 \begin_inset space ~
25849 \begin_inset space ~
25852 RotationLatexCommand
25857 This command specifies that the built in \SpecialChar LaTeX
25858 command should be used for rotation.
25859 This command may occur once or not at all.
25862 \begin_layout Description
25863 \begin_inset Flex Code
25866 \begin_layout Plain Layout
25868 \begin_inset space ~
25872 \begin_inset space ~
25880 This command specifies that the built in \SpecialChar LaTeX
25881 command should be used for resizing.
25882 This command may occur once or not at all.
25885 \begin_layout Description
25886 \begin_inset Flex Code
25889 \begin_layout Plain Layout
25891 \begin_inset space ~
25895 \begin_inset space ~
25898 RotationLatexOption
25903 This command specifies that rotation is done via an optional argument.
25904 This command may occur once or not at all.
25907 \begin_layout Description
25908 \begin_inset Flex Code
25911 \begin_layout Plain Layout
25913 \begin_inset space ~
25917 \begin_inset space ~
25925 This command specifies that resizing is done via an optional argument.
25926 This command may occur once or not at all.
25929 \begin_layout Description
25930 \begin_inset Flex Code
25933 \begin_layout Plain Layout
25935 \begin_inset space ~
25939 \begin_inset space ~
25947 This command specifies that clipping is done via an optional argument.
25948 This command may occur once or not at all.
25951 \begin_layout Description
25952 \begin_inset Flex Code
25955 \begin_layout Plain Layout
25957 \begin_inset space ~
25961 \begin_inset space ~
25969 This command specifies that an extra optional argument is used.
25970 This command may occur once or not at all.
25973 \begin_layout Description
25974 \begin_inset Flex Code
25977 \begin_layout Plain Layout
25979 \begin_inset space ~
25987 The file format of the converted file.
25988 This must be the name of a format that is known to \SpecialChar LyX
25990 \begin_inset Flex Noun
25993 \begin_layout Plain Layout
25994 Tools\SpecialChar menuseparator
25995 Preferences\SpecialChar menuseparator
25996 File Handling\SpecialChar menuseparator
26003 This command must occur exactly once.
26004 If the resulting file format is PDF, you need to specify the format
26005 \begin_inset Flex Code
26008 \begin_layout Plain Layout
26015 This is the PDF format used for including graphics.
26016 The other defined PDF formats are for document export.
26019 \begin_layout Description
26020 \begin_inset Flex Code
26023 \begin_layout Plain Layout
26025 \begin_inset space ~
26033 The file name of the converted file.
26034 The file name must be absolute.
26035 This command must occur exactly once.
26038 \begin_layout Subsection
26039 Preamble definitions
26042 \begin_layout Standard
26043 The external template configuration file may contain additional preamble
26044 definitions enclosed by
26045 \begin_inset Flex Code
26048 \begin_layout Plain Layout
26056 \begin_inset Flex Code
26059 \begin_layout Plain Layout
26066 They can be used by the templates in the
26067 \begin_inset Flex Code
26070 \begin_layout Plain Layout
26079 \begin_layout Section
26080 The substitution mechanism
26083 \begin_layout Standard
26084 When the external material facility invokes an external program, it is done
26085 on the basis of a command defined in the template configuration file.
26086 These commands can contain various macros that are expanded before execution.
26087 Execution always take place in the directory of the containing document.
26090 \begin_layout Standard
26091 Also, whenever external material is to be displayed, the name will be produced
26092 by the substitution mechanism, and most other commands in the template
26093 definition support substitution as well.
26096 \begin_layout Standard
26097 The available macros are the following:
26100 \begin_layout Description
26101 \begin_inset Flex Code
26104 \begin_layout Plain Layout
26105 $$AbsOrRelPathMaster
26110 The file path, absolute or relative to the master \SpecialChar LyX
26114 \begin_layout Description
26115 \begin_inset Flex Code
26118 \begin_layout Plain Layout
26119 $$AbsOrRelPathParent
26124 The file path, absolute or relative to the \SpecialChar LyX
26128 \begin_layout Description
26129 \begin_inset Flex Code
26132 \begin_layout Plain Layout
26138 The absolute file path.
26141 \begin_layout Description
26142 \begin_inset Flex Code
26145 \begin_layout Plain Layout
26151 The filename without path and without the extension.
26154 \begin_layout Description
26155 \begin_inset Flex Code
26158 \begin_layout Plain Layout
26160 \begin_inset Quotes eld
26164 \begin_inset Quotes erd
26172 This macro will expand to the contents of the file with the name
26173 \begin_inset Flex Code
26176 \begin_layout Plain Layout
26185 \begin_layout Description
26186 \begin_inset Flex Code
26189 \begin_layout Plain Layout
26195 The file extension (including the dot).
26198 \begin_layout Description
26199 \begin_inset Flex Code
26202 \begin_layout Plain Layout
26208 This will be the string
26209 \begin_inset Quotes eld
26213 \begin_inset Quotes erd
26216 if the file is in JPEG format, otherwise it will be the string
26217 \begin_inset Quotes eld
26221 \begin_inset Quotes erd
26225 This is useful to avoid uneeded conversions for output formats that support
26226 both PNG and JPEG fomats.
26227 The predefined RasterImage template uses this macro for the pdf\SpecialChar TeX
26232 \begin_layout Description
26233 \begin_inset Flex Code
26236 \begin_layout Plain Layout
26242 The filename of the file specified in the external material dialog.
26243 This is either an absolute name, or it is relative to the \SpecialChar LyX
26247 \begin_layout Description
26248 \begin_inset Flex Code
26251 \begin_layout Plain Layout
26258 \begin_inset Flex Code
26261 \begin_layout Plain Layout
26267 (absolute name or relative to the \SpecialChar LyX
26271 \begin_layout Description
26272 \begin_inset Flex Code
26275 \begin_layout Plain Layout
26281 The file path, relative to the master \SpecialChar LyX
26285 \begin_layout Description
26286 \begin_inset Flex Code
26289 \begin_layout Plain Layout
26295 The file path, relative to the \SpecialChar LyX
26299 \begin_layout Description
26300 \begin_inset Flex Code
26303 \begin_layout Plain Layout
26309 This macro will expand to the absolute path of the system directory.
26310 This is typically used to point to the various helper scripts that are
26311 bundled with \SpecialChar LyX
26315 \begin_layout Description
26316 \begin_inset Flex Code
26319 \begin_layout Plain Layout
26325 A name and full path to a temporary file which will be automatically deleted
26326 whenever the containing document is closed, or the external material insertion
26330 \begin_layout Standard
26331 All path macros contain a trailing directory separator, so you can construct
26333 \begin_inset space \thinspace{}
26337 \begin_inset space \space{}
26340 the absolute filename with
26341 \begin_inset Flex Code
26344 \begin_layout Plain Layout
26345 $$AbsPath$$Basename$$Extension
26353 \begin_layout Standard
26354 The macros above are substituted in all commands unless otherwise noted.
26356 \begin_inset Flex Code
26359 \begin_layout Plain Layout
26365 supports additionally the following substitutions if they are enabled by
26367 \begin_inset Flex Code
26370 \begin_layout Plain Layout
26377 \begin_inset Flex Code
26380 \begin_layout Plain Layout
26389 \begin_layout Description
26390 \begin_inset Flex Code
26393 \begin_layout Plain Layout
26399 The front part of the resize command.
26402 \begin_layout Description
26403 \begin_inset Flex Code
26406 \begin_layout Plain Layout
26412 The back part of the resize command.
26415 \begin_layout Description
26416 \begin_inset Flex Code
26419 \begin_layout Plain Layout
26425 The front part of the rotation command.
26428 \begin_layout Description
26429 \begin_inset Flex Code
26432 \begin_layout Plain Layout
26438 The back part of the rotation command.
26441 \begin_layout Standard
26442 The value string of the
26443 \begin_inset Flex Code
26446 \begin_layout Plain Layout
26452 command supports additionally the following substitutions if they are enabled
26454 \begin_inset Flex Code
26457 \begin_layout Plain Layout
26464 \begin_inset Flex Code
26467 \begin_layout Plain Layout
26476 \begin_layout Description
26477 \begin_inset Flex Code
26480 \begin_layout Plain Layout
26489 \begin_layout Description
26490 \begin_inset Flex Code
26493 \begin_layout Plain Layout
26502 \begin_layout Description
26503 \begin_inset Flex Code
26506 \begin_layout Plain Layout
26515 \begin_layout Description
26516 \begin_inset Flex Code
26519 \begin_layout Plain Layout
26525 The rotation option.
26528 \begin_layout Standard
26529 You may ask why there are so many path macros.
26530 There are mainly two reasons:
26533 \begin_layout Enumerate
26534 Relative and absolute file names should remain relative or absolute, respectivel
26536 Users may have reasons to prefer either form.
26537 Relative names are useful for portable documents that should work on different
26538 machines, for example.
26539 Absolute names may be required by some programs.
26542 \begin_layout Enumerate
26544 treats relative file names differently than \SpecialChar LyX
26545 and other programs in nested
26547 For \SpecialChar LyX
26548 , a relative file name is always relative to the document that contains
26550 For \SpecialChar LaTeX
26551 , it is always relative to the master document.
26552 These two definitions are identical if you have only one document, but
26553 differ if you have a master document that includes part documents.
26554 That means that relative filenames must be transformed when presented to
26557 Fortunately \SpecialChar LyX
26558 does this automatically for you if you choose the right macros.
26561 \begin_layout Standard
26562 So which path macro should be used in new template definitions? The rule
26566 \begin_layout Itemize
26568 \begin_inset Flex Code
26571 \begin_layout Plain Layout
26577 if an absolute path is required.
26580 \begin_layout Itemize
26582 \begin_inset Flex Code
26585 \begin_layout Plain Layout
26586 $$AbsOrRelPathMaster
26591 if the substituted string is some kind of \SpecialChar LaTeX
26595 \begin_layout Itemize
26597 \begin_inset Flex Code
26600 \begin_layout Plain Layout
26601 $$AbsOrRelPathParent
26606 in order to preserve the user's choice.
26609 \begin_layout Standard
26610 There are special cases where this rule does not work and e.
26611 \begin_inset space \thinspace{}
26615 \begin_inset space \space{}
26618 relative names are needed, but normally it will work just fine.
26619 One example for such a case is the command
26620 \begin_inset Flex Code
26623 \begin_layout Plain Layout
26624 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
26629 in the XFig template above: We can't use the absolute name because the
26631 \begin_inset Flex Code
26634 \begin_layout Plain Layout
26640 files needs the relative name in order to rewrite the file content.
26643 \begin_layout Section
26644 Security discussion
26645 \begin_inset CommandInset label
26647 name "sec:Security-discussion"
26654 \begin_layout Standard
26655 The external material feature interfaces with a lot of external programs
26656 and does so automatically, so we have to consider the security implications
26658 In particular, since you have the option of including your own filenames
26659 and/or parameter strings and those are expanded into a command, it seems
26660 that it would be possible to create a malicious document which executes
26661 arbitrary commands when a user views or prints the document.
26662 This is something we definitely want to avoid.
26665 \begin_layout Standard
26666 However, since the external program commands are specified in the template
26667 configuration file only, there are no security issues if \SpecialChar LyX
26668 is properly configure
26669 d with safe templates only.
26670 This is so because the external programs are invoked with the
26671 \begin_inset Flex Code
26674 \begin_layout Plain Layout
26680 -system call rather than the
26681 \begin_inset Flex Code
26684 \begin_layout Plain Layout
26690 system-call, so it's not possible to execute arbitrary commands from the
26691 filename or parameter section via the shell.
26694 \begin_layout Standard
26695 This also implies that you are restricted in what command strings you can
26696 use in the external material templates.
26697 In particular, pipes and redirection are not readily available.
26698 This has to be so if \SpecialChar LyX
26699 should remain safe.
26700 If you want to use some of the shell features, you should write a safe
26701 script to do this in a controlled manner, and then invoke the script from
26702 the command string.
26706 \begin_layout Standard
26707 It is possible to design a template that interacts directly with the shell,
26708 but since this would allow a malicious user to execute arbitrary commands
26709 by writing clever filenames and/or parameters, we generally recommend that
26710 you only use safe scripts that work with the
26711 \begin_inset Flex Code
26714 \begin_layout Plain Layout
26720 system call in a controlled manner.
26721 Of course, for use in a controlled environment, it can be tempting to just
26722 fall back to use ordinary shell scripts.
26723 If you do so, be aware that you
26727 provide an easily exploitable security hole in your system.
26728 Of course it stands to reason that such unsafe templates will never be
26729 included in the standard \SpecialChar LyX
26730 distribution, although we do encourage people
26731 to submit new templates in the open source tradition.
26732 But \SpecialChar LyX
26733 as shipped from the official distribution channels will never have
26737 \begin_layout Standard
26738 Including external material provides a lot of power, and you have to be
26739 careful not to introduce security hazards with this power.
26740 A subtle error in a single line in an innocent looking script can open
26741 the door to huge security problems.
26742 So if you do not fully understand the issues, we recommend that you consult
26743 a knowledgeable security professional or the \SpecialChar LyX
26744 development team if you have
26745 any questions about whether a given template is safe or not.
26746 And do this before you use it in an uncontrolled environment.
26749 \begin_layout Chapter
26751 List of supported \SpecialChar LyX
26752 functions to be used in layouts
26753 \begin_inset CommandInset label
26755 name "chap:List-of-functions"
26762 \begin_layout Standard
26764 \begin_inset Tabular
26765 <lyxtabular version="3" rows="11" columns="8">
26766 <features tabularvalignment="middle">
26767 <column alignment="left" valignment="top">
26768 <column alignment="left" valignment="top">
26769 <column alignment="left" valignment="top">
26770 <column alignment="left" valignment="top">
26771 <column alignment="left" valignment="top">
26772 <column alignment="left" valignment="top">
26773 <column alignment="left" valignment="top">
26774 <column alignment="left" valignment="top">
26776 <cell alignment="left" valignment="top" usebox="none">
26779 \begin_layout Plain Layout
26785 <cell alignment="left" valignment="top" usebox="none">
26788 \begin_layout Plain Layout
26794 <cell alignment="left" valignment="top" usebox="none">
26797 \begin_layout Plain Layout
26803 <cell alignment="left" valignment="top" usebox="none">
26806 \begin_layout Plain Layout
26812 <cell alignment="center" valignment="top" usebox="none">
26815 \begin_layout Plain Layout
26821 <cell alignment="center" valignment="top" usebox="none">
26824 \begin_layout Plain Layout
26830 <cell alignment="center" valignment="top" usebox="none">
26833 \begin_layout Plain Layout
26839 <cell alignment="center" valignment="top" usebox="none">
26842 \begin_layout Plain Layout
26850 <cell alignment="left" valignment="top" usebox="none">
26853 \begin_layout Plain Layout
26859 <cell alignment="left" valignment="top" usebox="none">
26862 \begin_layout Plain Layout
26868 <cell alignment="left" valignment="top" usebox="none">
26871 \begin_layout Plain Layout
26877 <cell alignment="left" valignment="top" usebox="none">
26880 \begin_layout Plain Layout
26886 <cell alignment="center" valignment="top" usebox="none">
26889 \begin_layout Plain Layout
26895 <cell alignment="center" valignment="top" usebox="none">
26898 \begin_layout Plain Layout
26904 <cell alignment="center" valignment="top" usebox="none">
26907 \begin_layout Plain Layout
26913 <cell alignment="center" valignment="top" usebox="none">
26916 \begin_layout Plain Layout
26924 <cell alignment="left" valignment="top" usebox="none">
26927 \begin_layout Plain Layout
26933 <cell alignment="left" valignment="top" usebox="none">
26936 \begin_layout Plain Layout
26942 <cell alignment="left" valignment="top" usebox="none">
26945 \begin_layout Plain Layout
26951 <cell alignment="left" valignment="top" usebox="none">
26954 \begin_layout Plain Layout
26960 <cell alignment="center" valignment="top" usebox="none">
26963 \begin_layout Plain Layout
26969 <cell alignment="center" valignment="top" usebox="none">
26972 \begin_layout Plain Layout
26978 <cell alignment="center" valignment="top" usebox="none">
26981 \begin_layout Plain Layout
26987 <cell alignment="center" valignment="top" usebox="none">
26990 \begin_layout Plain Layout
26998 <cell alignment="left" valignment="top" usebox="none">
27001 \begin_layout Plain Layout
27007 <cell alignment="left" valignment="top" usebox="none">
27010 \begin_layout Plain Layout
27016 <cell alignment="left" valignment="top" usebox="none">
27019 \begin_layout Plain Layout
27025 <cell alignment="left" valignment="top" usebox="none">
27028 \begin_layout Plain Layout
27034 <cell alignment="center" valignment="top" usebox="none">
27037 \begin_layout Plain Layout
27043 <cell alignment="center" valignment="top" usebox="none">
27046 \begin_layout Plain Layout
27052 <cell alignment="center" valignment="top" usebox="none">
27055 \begin_layout Plain Layout
27061 <cell alignment="center" valignment="top" usebox="none">
27064 \begin_layout Plain Layout
27072 <cell alignment="left" valignment="top" usebox="none">
27075 \begin_layout Plain Layout
27081 <cell alignment="left" valignment="top" usebox="none">
27084 \begin_layout Plain Layout
27090 <cell alignment="left" valignment="top" usebox="none">
27093 \begin_layout Plain Layout
27099 <cell alignment="left" valignment="top" usebox="none">
27102 \begin_layout Plain Layout
27108 <cell alignment="center" valignment="top" usebox="none">
27111 \begin_layout Plain Layout
27117 <cell alignment="center" valignment="top" usebox="none">
27120 \begin_layout Plain Layout
27126 <cell alignment="center" valignment="top" usebox="none">
27129 \begin_layout Plain Layout
27135 <cell alignment="center" valignment="top" usebox="none">
27138 \begin_layout Plain Layout
27146 <cell alignment="left" valignment="top" usebox="none">
27149 \begin_layout Plain Layout
27155 <cell alignment="left" valignment="top" usebox="none">
27158 \begin_layout Plain Layout
27164 <cell alignment="left" valignment="top" usebox="none">
27167 \begin_layout Plain Layout
27173 <cell alignment="left" valignment="top" usebox="none">
27176 \begin_layout Plain Layout
27182 <cell alignment="center" valignment="top" usebox="none">
27185 \begin_layout Plain Layout
27191 <cell alignment="center" valignment="top" usebox="none">
27194 \begin_layout Plain Layout
27200 <cell alignment="center" valignment="top" usebox="none">
27203 \begin_layout Plain Layout
27209 <cell alignment="center" valignment="top" usebox="none">
27212 \begin_layout Plain Layout
27220 <cell alignment="left" valignment="top" usebox="none">
27223 \begin_layout Plain Layout
27229 <cell alignment="left" valignment="top" usebox="none">
27232 \begin_layout Plain Layout
27238 <cell alignment="left" valignment="top" usebox="none">
27241 \begin_layout Plain Layout
27247 <cell alignment="left" valignment="top" usebox="none">
27250 \begin_layout Plain Layout
27256 <cell alignment="center" valignment="top" usebox="none">
27259 \begin_layout Plain Layout
27265 <cell alignment="center" valignment="top" usebox="none">
27268 \begin_layout Plain Layout
27274 <cell alignment="center" valignment="top" usebox="none">
27277 \begin_layout Plain Layout
27283 <cell alignment="center" valignment="top" usebox="none">
27286 \begin_layout Plain Layout
27294 <cell alignment="left" valignment="top" usebox="none">
27297 \begin_layout Plain Layout
27303 <cell alignment="left" valignment="top" usebox="none">
27306 \begin_layout Plain Layout
27312 <cell alignment="left" valignment="top" usebox="none">
27315 \begin_layout Plain Layout
27321 <cell alignment="left" valignment="top" usebox="none">
27324 \begin_layout Plain Layout
27330 <cell alignment="center" valignment="top" usebox="none">
27333 \begin_layout Plain Layout
27339 <cell alignment="center" valignment="top" usebox="none">
27342 \begin_layout Plain Layout
27348 <cell alignment="center" valignment="top" usebox="none">
27351 \begin_layout Plain Layout
27357 <cell alignment="center" valignment="top" usebox="none">
27360 \begin_layout Plain Layout
27368 <cell alignment="left" valignment="top" usebox="none">
27371 \begin_layout Plain Layout
27377 <cell alignment="left" valignment="top" usebox="none">
27380 \begin_layout Plain Layout
27386 <cell alignment="left" valignment="top" usebox="none">
27389 \begin_layout Plain Layout
27395 <cell alignment="left" valignment="top" usebox="none">
27398 \begin_layout Plain Layout
27404 <cell alignment="center" valignment="top" usebox="none">
27407 \begin_layout Plain Layout
27413 <cell alignment="center" valignment="top" usebox="none">
27416 \begin_layout Plain Layout
27422 <cell alignment="center" valignment="top" usebox="none">
27425 \begin_layout Plain Layout
27431 <cell alignment="center" valignment="top" usebox="none">
27434 \begin_layout Plain Layout
27442 <cell alignment="left" valignment="top" usebox="none">
27445 \begin_layout Plain Layout
27451 <cell alignment="left" valignment="top" usebox="none">
27454 \begin_layout Plain Layout
27460 <cell alignment="left" valignment="top" usebox="none">
27463 \begin_layout Plain Layout
27469 <cell alignment="left" valignment="top" usebox="none">
27472 \begin_layout Plain Layout
27478 <cell alignment="center" valignment="top" usebox="none">
27481 \begin_layout Plain Layout
27487 <cell alignment="center" valignment="top" usebox="none">
27490 \begin_layout Plain Layout
27496 <cell alignment="center" valignment="top" usebox="none">
27499 \begin_layout Plain Layout
27505 <cell alignment="center" valignment="top" usebox="none">
27508 \begin_layout Plain Layout
27516 <cell alignment="center" valignment="top" usebox="none">
27519 \begin_layout Plain Layout
27525 <cell alignment="center" valignment="top" usebox="none">
27528 \begin_layout Plain Layout
27534 <cell alignment="center" valignment="top" usebox="none">
27537 \begin_layout Plain Layout
27543 <cell alignment="center" valignment="top" usebox="none">
27546 \begin_layout Plain Layout
27552 <cell alignment="center" valignment="top" usebox="none">
27555 \begin_layout Plain Layout
27561 <cell alignment="center" valignment="top" usebox="none">
27564 \begin_layout Plain Layout
27570 <cell alignment="center" valignment="top" usebox="none">
27573 \begin_layout Plain Layout
27579 <cell alignment="center" valignment="top" usebox="none">
27582 \begin_layout Plain Layout
27596 \begin_layout Chapter
27597 Names of available colors to be used in layouts
27598 \begin_inset CommandInset label
27600 name "chap:Names-of-colors"
27607 \begin_layout Standard
27608 The colors listed below are the standard colors and those that you can adjust
27609 in the \SpecialChar LyX
27613 \begin_layout Section
27617 \begin_layout Standard
27618 The following are no real colors, but rather act on color definitions:
27621 \begin_layout Description
27622 ignore The color is ignored
27625 \begin_layout Description
27626 inherit The color is inherited
27629 \begin_layout Description
27642 No particular color – clear or default
27645 \begin_layout Section
27649 \begin_layout Standard
27650 These are fixed colors that cannot me customized:
27653 \begin_layout Description
27657 \begin_layout Description
27661 \begin_layout Description
27665 \begin_layout Description
27669 \begin_layout Description
27673 \begin_layout Description
27677 \begin_layout Description
27681 \begin_layout Description
27685 \begin_layout Description
27689 \begin_layout Description
27693 \begin_layout Description
27697 \begin_layout Description
27701 \begin_layout Description
27705 \begin_layout Description
27709 \begin_layout Description
27713 \begin_layout Description
27717 \begin_layout Description
27721 \begin_layout Description
27725 \begin_layout Description
27729 \begin_layout Section
27733 \begin_layout Standard
27734 These are the colors allocated to specific elements in
27737 arg "dialog-show prefs"
27743 \begin_layout Description
27744 added_space Added space color
27747 \begin_layout Description
27748 addedtext Added text color
27751 \begin_layout Description
27752 appendix Appendix marker color
27755 \begin_layout Description
27756 background Background color
27759 \begin_layout Description
27760 bottomarea Bottom area color
27763 \begin_layout Description
27764 branchlabel Label color for branches
27767 \begin_layout Description
27768 buttonbg Color used for button background
27771 \begin_layout Description
27772 buttonframe Color for inset button frames
27775 \begin_layout Description
27776 buttonhoverbg Color used for button background under focus
27779 \begin_layout Description
27780 changebar Changebar color
27783 \begin_layout Description
27784 changedtextauthor1 Changed text color author 1
27787 \begin_layout Description
27788 changedtextauthor2 Changed text color author 2
27791 \begin_layout Description
27792 changedtextauthor3 Changed text color author 3
27795 \begin_layout Description
27796 changedtextauthor4 Changed text color author 4
27799 \begin_layout Description
27800 changedtextauthor5 Changed text color author 5
27803 \begin_layout Description
27804 collapsible Collapsible insets text color
27807 \begin_layout Description
27808 collapsibleframe Collapsible insets framecolor
27811 \begin_layout Description
27812 command Text color for command insets
27815 \begin_layout Description
27816 commandbg Background color for command insets
27819 \begin_layout Description
27820 commandframe Frame color for command insets
27823 \begin_layout Description
27824 commentbg Background color of comments
27827 \begin_layout Description
27828 commentlabel Label color for comments
27831 \begin_layout Description
27832 cursor Cursor color
27835 \begin_layout Description
27836 deletedtext Deleted text color
27839 \begin_layout Description
27840 deletedtextmodifier Deleted text modifying color
27843 \begin_layout Description
27844 depthbar Color for the depth bars in the margin
27847 \begin_layout Description
27848 eolmarker End of line marker color
27851 \begin_layout Description
27852 error Color of the \SpecialChar LaTeX
27856 \begin_layout Description
27857 footlabel Label color for footnotes
27860 \begin_layout Description
27861 foreground Foreground color
27864 \begin_layout Description
27865 graphicsbg Graphics inset background color
27868 \begin_layout Description
27869 greyedoutbg Background color of greyedout inset
27872 \begin_layout Description
27873 greyedoutlabel Label color for greyedout insets
27876 \begin_layout Description
27877 greyedouttext Color for greyedout inset text
27880 \begin_layout Description
27881 indexlabel Label color for index insets
27884 \begin_layout Description
27885 inlinecompletion Inline completion color
27888 \begin_layout Description
27889 insetbg Inset marker background color
27892 \begin_layout Description
27893 insetframe Inset marker frame color
27896 \begin_layout Description
27897 language Color for marking foreign language words
27900 \begin_layout Description
27901 latex Text color in \SpecialChar LaTeX
27905 \begin_layout Description
27906 listingsbg Background color of listings inset
27909 \begin_layout Description
27910 marginlabel Label color for margin notes
27913 \begin_layout Description
27914 math Math inset text color
27917 \begin_layout Description
27918 mathbg Math inset background color
27921 \begin_layout Description
27922 mathcorners Math inset frame color not under focus
27925 \begin_layout Description
27926 mathframe Math inset frame color under focus
27929 \begin_layout Description
27930 mathline Math line color
27933 \begin_layout Description
27934 mathmacrobg Macro math inset background color
27937 \begin_layout Description
27938 mathmacroblend Macro math blended color
27941 \begin_layout Description
27942 mathmacroframe Macro math frame color
27945 \begin_layout Description
27946 mathmacrohoverbg Macro math inset background color hovered
27949 \begin_layout Description
27950 mathmacrolabel Macro math label color
27953 \begin_layout Description
27954 mathmacronewarg Macro template color for new parameters
27957 \begin_layout Description
27958 mathmacrooldarg Macro template color for old parameters
27961 \begin_layout Description
27962 newpage New page color
27965 \begin_layout Description
27966 nonunique_inlinecompletion Inline completion color for the non-unique part
27969 \begin_layout Description
27970 notebg Background color of notes
27973 \begin_layout Description
27974 notelabel Label color for notes
27977 \begin_layout Description
27978 pagebreak Page break/line break color
27981 \begin_layout Description
27982 paragraphmarker Color used for the pilcrow sign to mark the end of a paragraph
27985 \begin_layout Description
27986 phantomtext Text color for phantom insets
27989 \begin_layout Description
27990 preview The color used for previews
27993 \begin_layout Description
27994 previewframe Preview frame color
27997 \begin_layout Description
27998 regexpframe Color for regexp frame
28001 \begin_layout Description
28002 scroll Color that indicates when a row can be scrolled
28005 \begin_layout Description
28006 selection Background color of selected text
28009 \begin_layout Description
28010 selectiontext Foreground color of selected text
28013 \begin_layout Description
28014 shadedbg Background color of shaded box
28017 \begin_layout Description
28018 special Special chars text color
28021 \begin_layout Description
28022 tabularline Table line color
28025 \begin_layout Description
28026 tabularonoffline Table line color
28029 \begin_layout Description
28030 urllabel Label color for URL insets
28033 \begin_layout Description
28034 urltext Color for URL inset text