1 #LyX 2.3 created this file. For more info see http://www.lyx.org/
5 \save_transient_properties true
6 \origin /systemlyxdir/doc/
9 % DO NOT ALTER THIS PREAMBLE!!!
11 % This preamble is designed to ensure that this document prints
12 % out as advertised. If you mess with this preamble,
13 % parts of this document may not print out as expected. If you
14 % have problems LaTeXing this file, please contact
15 % the documentation team
16 % email: lyx-docs@lists.lyx.org
18 % the pages of the TOC is numbered roman
19 % and a pdf-bookmark for the TOC is added
20 \let\myTOC\tableofcontents
21 \renewcommand\tableofcontents{%
23 \pdfbookmark[1]{\contentsname}{}
27 % increase link area for cross-references and autoname them,
28 \AtBeginDocument{\renewcommand{\ref}[1]{\mbox{\autoref{#1}}}}
29 \@ifundefined{extrasenglish}{\usepackage[english]{babel}}{}
30 \@ifpackageloaded{babel}{
31 \addto\extrasenglish{%
32 \renewcommand*{\equationautorefname}[1]{}%
33 \renewcommand{\sectionautorefname}{sec.\negthinspace}%
34 \renewcommand{\subsectionautorefname}{sec.\negthinspace}%
35 \renewcommand{\subsubsectionautorefname}{sec.\negthinspace}%
39 \options bibliography=totoc,index=totoc,BCOR7.5mm,titlepage,captions=tableheading
40 \use_default_options false
44 \maintain_unincluded_children false
46 \language_package default
49 \font_roman "lmodern" "default"
50 \font_sans "lmss" "default"
51 \font_typewriter "lmtt" "default"
52 \font_math "auto" "auto"
53 \font_default_family default
54 \use_non_tex_fonts false
57 \font_sf_scale 100 100
58 \font_tt_scale 100 100
60 \use_dash_ligatures true
62 \default_output_format pdf2
64 \bibtex_command default
65 \index_command default
69 \pdf_title "LyX Configuration Manual"
70 \pdf_author "LyX Team"
71 \pdf_subject "LyX-documentation Customization"
72 \pdf_keywords "LyX, documentation, customization"
74 \pdf_bookmarksnumbered true
75 \pdf_bookmarksopen true
76 \pdf_bookmarksopenlevel 1
81 \pdf_pdfusetitle false
82 \pdf_quoted_options "linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue,pdfpagelayout=OneColumn, pdfnewwindow=true, pdfstartview=XYZ, plainpages=false"
85 \use_package amsmath 1
86 \use_package amssymb 1
89 \use_package mathdots 1
90 \use_package mathtools 1
92 \use_package stackrel 1
93 \use_package stmaryrd 1
94 \use_package undertilde 1
96 \cite_engine_type default
100 \paperorientation portrait
105 \notefontcolor #0000ff
117 \paragraph_separation indent
118 \paragraph_indentation default
120 \math_indentation default
121 \math_numbering_side default
122 \quotes_style english
126 \paperpagestyle headings
127 \tracking_changes true
128 \output_changes false
132 \author -712698321 "Jürgen Spitzmüller"
138 Customizing \SpecialChar LyX
139 : Features for the Advanced User
143 by the \SpecialChar LyX
148 \begin_layout Plain Layout
150 If you have comments or error corrections, please send them to the \SpecialChar LyX
153 \begin_inset CommandInset href
155 target "lyx-docs@lists.lyx.org"
163 \begin_inset Quotes eld
167 \begin_inset Quotes erd
170 in the subject header, and please cc the current maintainer of this file,
171 Richard Heck <rgheck@comcast.net>.
177 \begin_inset Newline newline
181 \begin_inset Newline newline
187 \begin_layout Standard
188 \begin_inset CommandInset toc
189 LatexCommand tableofcontents
196 \begin_layout Standard
197 \begin_inset Note Note
200 \begin_layout Plain Layout
201 Please use change tracking when modifying this document.
202 This makes it easier for our translators to recognize things that have
203 been changed, and it helps the maintainer keep up-to-date with what's been
212 \begin_layout Chapter
216 \begin_layout Standard
217 This manual covers the customization features present in \SpecialChar LyX
219 In it, we discuss issues like keyboard shortcuts, screen previewing options,
220 printer options, sending commands to \SpecialChar LyX
221 via the \SpecialChar LyX
222 Server, internationalization,
223 installing new \SpecialChar LaTeX
224 classes and \SpecialChar LyX
226 We can't possibly hope to touch on everything you can change—our developers
227 add new features faster than we can document them—but we will explain the
228 most common customizations and hopefully point you in the right direction
229 for some of the more obscure ones.
232 \begin_layout Standard
233 \begin_inset Branch OutDated
237 \begin_layout Standard
238 Information from previous versions of this document that now seems to be
239 outdated is contained in the OutDated branch of this document.
240 By default, this information will not appear in the \SpecialChar LaTeX
249 \begin_layout Chapter
254 \begin_layout Standard
255 This chapter aims to help you to find your way through the \SpecialChar LyX
258 Before continuing to read this chapter, you should find out where your
260 library and user directories are by using
261 \begin_inset Flex Noun
264 \begin_layout Plain Layout
265 Help\SpecialChar menuseparator
276 The library directory is the place where \SpecialChar LyX
277 places its system-wide configuration
278 files; the user directory is where you can place your modified versions.
279 We will call the former
280 \begin_inset Flex Code
283 \begin_layout Plain Layout
290 \begin_inset Flex Noun
293 \begin_layout Plain Layout
299 in the remainder of this document.
303 \begin_layout Section
305 \begin_inset Flex Code
308 \begin_layout Plain Layout
317 \begin_layout Standard
318 \begin_inset Flex Code
321 \begin_layout Plain Layout
327 and its sub-directories contain a number of files and that can be used
328 to customize \SpecialChar LyX
330 You can change many of these files from within \SpecialChar LyX
332 \begin_inset Flex Noun
335 \begin_layout Plain Layout
336 Tools\SpecialChar menuseparator
343 Most customization that you will want to do in \SpecialChar LyX
344 is possible through this
346 However, many other inner aspects of \SpecialChar LyX
347 can be customized by modifying the
349 \begin_inset Flex Code
352 \begin_layout Plain Layout
359 These files fall in different categories, described in the following subsection
363 \begin_layout Subsection
364 Automatically generated files
367 \begin_layout Standard
368 The files, which are to be found in
369 \begin_inset Flex Noun
372 \begin_layout Plain Layout
378 , are generated when you configure \SpecialChar LyX
380 They contain various default values that are guessed by inspection.
381 In general, it is not a good idea to modify them, since they might be overwritt
385 \begin_layout Labeling
386 \labelwidthstring 00.00.0000
387 \begin_inset Flex Code
390 \begin_layout Plain Layout
396 contains defaults for various commands.
399 \begin_layout Labeling
400 \labelwidthstring 00.00.0000
401 \begin_inset Flex Code
404 \begin_layout Plain Layout
410 contains the list of packages that have been recognized by \SpecialChar LyX
412 It is currently unused by the \SpecialChar LyX
413 program itself, but the information extracted,
414 and more, is made available with
415 \begin_inset Flex Noun
418 \begin_layout Plain Layout
419 Help\SpecialChar menuseparator
433 \begin_layout Labeling
434 \labelwidthstring 00.00.0000
435 \begin_inset Flex Code
438 \begin_layout Plain Layout
444 the list of text classes that have been found in your
445 \begin_inset Flex Code
448 \begin_layout Plain Layout
454 directories, along with the associated \SpecialChar LaTeX
455 document class and their description.
458 \begin_layout Labeling
459 \labelwidthstring 00.00.0000
460 \begin_inset Flex Code
463 \begin_layout Plain Layout
469 the list of layout modules found in your
470 \begin_inset Flex Code
473 \begin_layout Plain Layout
482 \begin_layout Labeling
483 \labelwidthstring 00.00.0000
484 \begin_inset Flex Code
487 \begin_layout Plain Layout
493 lists of various sorts of \SpecialChar LaTeX
494 -related files found on your system
497 \begin_layout Labeling
498 \labelwidthstring 00.00.0000
499 \begin_inset Flex Code
502 \begin_layout Plain Layout
503 doc/\SpecialChar LaTeX
509 is automatically generated during configuration from the file
510 \begin_inset Flex Code
513 \begin_layout Plain Layout
521 It contains information on your \SpecialChar LaTeX
525 \begin_layout Subsection
529 \begin_layout Standard
530 These directories are duplicated between
531 \begin_inset Flex Code
534 \begin_layout Plain Layout
541 \begin_inset Flex Code
544 \begin_layout Plain Layout
551 If a particular files exists in both places, the one in
552 \begin_inset Flex Code
555 \begin_layout Plain Layout
564 \begin_layout Labeling
565 \labelwidthstring 00.00.0000
566 \begin_inset Flex Code
569 \begin_layout Plain Layout
575 this directory contains files with the extension
576 \begin_inset Flex Code
579 \begin_layout Plain Layout
585 that define the keybindings used in \SpecialChar LyX
587 If there exists an internationalized version of the bind file named
588 \begin_inset Flex Code
591 \begin_layout Plain Layout
597 , that will be used first.
600 \begin_layout Labeling
601 \labelwidthstring 00.00.0000
602 \begin_inset Flex Code
605 \begin_layout Plain Layout
611 contains files with the extension
612 \begin_inset Flex Code
615 \begin_layout Plain Layout
621 which define the diverse citation possibilities (natbib, biblatex etc.).
623 \begin_inset CommandInset ref
625 reference "subsec:Cite-Engine-Files"
635 \begin_layout Labeling
636 \labelwidthstring 00.00.0000
637 \begin_inset Flex Code
640 \begin_layout Plain Layout
646 contains graphics files that can be included in documents.
650 \begin_layout Labeling
651 \labelwidthstring 00.00.0000
652 \begin_inset Flex Code
655 \begin_layout Plain Layout
661 contains \SpecialChar LyX
662 documentation files (including the one you are currently reading).
664 \begin_inset Flex Code
667 \begin_layout Plain Layout
674 deserves special attention, as noted above.
675 The internationalized help docs are in subdirectories
676 \begin_inset Flex Code
679 \begin_layout Plain Layout
686 \begin_inset Quotes eld
690 \begin_inset Quotes erd
693 is the ISO language code.
695 \begin_inset CommandInset ref
697 reference "cha:Internationalizing-LyX"
704 \begin_layout Labeling
705 \labelwidthstring 00.00.0000
706 \begin_inset Flex Code
709 \begin_layout Plain Layout
715 contains example files that explain how to use some features.
716 In the file browser, press the
717 \begin_inset Flex Noun
720 \begin_layout Plain Layout
729 \begin_layout Labeling
730 \labelwidthstring 00.00.0000
731 \begin_inset Flex Code
734 \begin_layout Plain Layout
740 contains image files that are used by the
741 \begin_inset Flex Noun
744 \begin_layout Plain Layout
751 In addition, it also contains the individual icons used in the toolbar
752 and the banners that can be shown when \SpecialChar LyX
756 \begin_layout Labeling
757 \labelwidthstring 00.00.0000
758 \begin_inset Flex Code
761 \begin_layout Plain Layout
767 contains keyboard keymapping files.
769 \begin_inset CommandInset ref
771 reference "sec:International-Keymap-Stuff"
778 \begin_layout Labeling
779 \labelwidthstring 00.00.0000
780 \begin_inset Flex Code
783 \begin_layout Plain Layout
789 contains the text class and module files described in
790 \begin_inset CommandInset ref
792 reference "cha:Installing-New-Document"
799 \begin_layout Labeling
800 \labelwidthstring 00.00.0000
801 \begin_inset Flex Code
804 \begin_layout Plain Layout
811 \begin_inset Flex Code
814 \begin_layout Plain Layout
820 Python scripts used to convert between \SpecialChar LyX
822 These can be run from the command line if, say, you want to batch-convert
826 \begin_layout Labeling
827 \labelwidthstring 00.00.0000
828 \begin_inset Flex Code
831 \begin_layout Plain Layout
837 contains some files that demonstrate the capabilities of the
838 \begin_inset Flex Noun
841 \begin_layout Plain Layout
852 Also contains some scripts used by \SpecialChar LyX
856 \begin_layout Labeling
857 \labelwidthstring 00.00.0000
858 \begin_inset Flex Code
861 \begin_layout Plain Layout
867 contains the standard \SpecialChar LyX
868 template files described in
869 \begin_inset CommandInset ref
871 reference "subsec:Creating-Templates"
878 \begin_layout Labeling
879 \labelwidthstring 00.00.0000
880 \begin_inset Flex Code
883 \begin_layout Plain Layout
889 contains files with the extension
890 \begin_inset Flex Code
893 \begin_layout Plain Layout
899 that define the user interface to \SpecialChar LyX
901 That is, the files define which items appear in which menus and the items
902 appearing on the toolbar.
905 \begin_layout Labeling
906 \labelwidthstring 00.00.0000
907 \begin_inset Flex Code
910 \begin_layout Plain Layout
916 contains files with the extension
917 \begin_inset Flex Code
920 \begin_layout Plain Layout
926 which define the templates for the insertion of external material to a
929 \begin_inset CommandInset ref
931 reference "chap:Including-External-Material"
938 \begin_layout Subsection
939 Files you don't want to modify
942 \begin_layout Standard
943 These files are used internally by \SpecialChar LyX
944 and you generally do not need to modify
945 them unless you are a developer.
948 \begin_layout Labeling
949 \labelwidthstring 00.00.0000
950 \begin_inset Flex Code
953 \begin_layout Plain Layout
959 this file contains the list of \SpecialChar LyX
961 The contents are displayed with the menu entry
962 \begin_inset Flex Noun
965 \begin_layout Plain Layout
966 Help\SpecialChar menuseparator
979 \begin_layout Labeling
980 \labelwidthstring 00.00.0000
981 \begin_inset Flex Code
984 \begin_layout Plain Layout
990 this is a \SpecialChar LaTeX
991 script used during the configuration process.
995 \begin_layout Labeling
996 \labelwidthstring 00.00.0000
997 \begin_inset Flex Code
1000 \begin_layout Plain Layout
1006 this is a Python script that is used to re-configure \SpecialChar LyX
1008 It creates configuration files in the directory it was run from.
1011 \begin_layout Subsection
1012 Other files needing a line or two
1015 \begin_layout Labeling
1016 \labelwidthstring 00.00.0000
1017 \begin_inset Flex Code
1020 \begin_layout Plain Layout
1026 this contains tables describing how different character encodings can be
1030 \begin_layout Labeling
1031 \labelwidthstring 00.00.0000
1032 \begin_inset Flex Code
1035 \begin_layout Plain Layout
1041 this file contains a list of all the languages currently supported by \SpecialChar LyX
1045 \begin_layout Labeling
1046 \labelwidthstring 00.00.0000
1047 \begin_inset Flex Code
1050 \begin_layout Plain Layout
1056 contains information about the supported fonts.
1059 \begin_layout Labeling
1060 \labelwidthstring 00.00.0000
1061 \begin_inset Flex Code
1064 \begin_layout Plain Layout
1070 this file contains translations for internationalized paragraph styles
1072 \begin_inset CommandInset ref
1074 reference "subsec:I18n"
1081 \begin_layout Labeling
1082 \labelwidthstring 00.00.0000
1083 \begin_inset Flex Code
1086 \begin_layout Plain Layout
1092 this file contains information about Unicode-encoded glyphs and the way
1093 they are supported by \SpecialChar LyX
1094 via \SpecialChar LaTeX
1098 \begin_layout Section
1099 Your local configuration directory
1102 \begin_layout Standard
1103 Even if you are using \SpecialChar LyX
1104 as an unprivileged user, you might want to change
1106 configuration for your own use.
1108 \begin_inset Flex Code
1111 \begin_layout Plain Layout
1117 directory contains all your personal configuration files.
1118 This is the directory described as
1119 \begin_inset Quotes eld
1123 \begin_inset Quotes erd
1127 \begin_inset Flex Noun
1130 \begin_layout Plain Layout
1131 Help\SpecialChar menuseparator
1133 \begin_inset space ~
1142 This directory is used as a mirror of
1143 \begin_inset Flex Code
1146 \begin_layout Plain Layout
1152 , which means that every file in
1153 \begin_inset Flex Code
1156 \begin_layout Plain Layout
1162 is a replacement for the corresponding file in
1163 \begin_inset Flex Code
1166 \begin_layout Plain Layout
1173 Any configuration file described in the above sections can be placed either
1174 in the system-wide directory, in which case it will affect all users, or
1175 in your local directory for your own use.
1178 \begin_layout Standard
1179 To make things clearer, let's provide a few examples:
1182 \begin_layout Itemize
1183 The preferences set in the
1184 \begin_inset Flex Noun
1187 \begin_layout Plain Layout
1188 Tools\SpecialChar menuseparator
1194 dialog are saved to a file
1195 \begin_inset Flex Code
1198 \begin_layout Plain Layout
1205 \begin_inset Flex Code
1208 \begin_layout Plain Layout
1217 \begin_layout Itemize
1218 When you reconfigure using
1219 \begin_inset Flex Noun
1222 \begin_layout Plain Layout
1223 Tools\SpecialChar menuseparator
1231 \begin_inset Flex Code
1234 \begin_layout Plain Layout
1240 script, and the resulting files are written in your local configuration
1242 This means that any additional text class file that you might have added
1244 \begin_inset Flex Code
1247 \begin_layout Plain Layout
1253 will be added to the list of classes in the
1254 \begin_inset Flex Noun
1257 \begin_layout Plain Layout
1258 Document\SpecialChar menuseparator
1267 \begin_layout Itemize
1268 If you get some updated documentation from \SpecialChar LyX
1269 ftp site and cannot install
1270 it because you do not have sysadmin rights on your system, you can just
1272 \begin_inset Flex Code
1275 \begin_layout Plain Layout
1281 and the items in the
1282 \begin_inset Flex Noun
1285 \begin_layout Plain Layout
1291 menu will open them!
1294 \begin_layout Section
1295 Running \SpecialChar LyX
1296 with multiple configurations
1299 \begin_layout Standard
1300 The configuration freedom of the local configuration directory may not suffice
1301 if you want to have more than one configuration at your disposal.
1302 For example, you may want to be use different key bindings or printer settings
1304 You can achieve this by having several such directories.
1305 You then specify which directory to use at run-time.
1308 \begin_layout Standard
1309 Invoking \SpecialChar LyX
1310 with the command line switch
1311 \begin_inset Flex Code
1314 \begin_layout Plain Layout
1324 instructs the program to read the configuration from that directory, and
1325 not from the default directory.
1326 (You can determine the default directory by running \SpecialChar LyX
1328 \begin_inset Flex Code
1331 \begin_layout Plain Layout
1337 switch.) If the specified directory does not exist, \SpecialChar LyX
1339 for you, just like it does for the default directory on the first time
1340 you run the program.
1341 You can modify the configuration options in this additional user directory
1342 exactly as you would for the default directory.
1343 These directories are completely independent (but read on).
1344 Note that setting the environment variable
1345 \begin_inset Flex Code
1348 \begin_layout Plain Layout
1354 to some value has exactly the same effect.
1357 \begin_layout Standard
1358 Having several configurations also requires more maintenance: if you want
1359 to add a new layout to
1360 \begin_inset Flex Code
1363 \begin_layout Plain Layout
1369 which you want available from all your configurations, you must add it
1370 to each directory separately.
1371 You can avoid this with the following trick: after \SpecialChar LyX
1372 creates the additional
1373 directory, most of the subdirectories (see above) are empty.
1374 If you want the new configuration to mirror an existing one, replace the
1375 empty subdirectory with a symbolic link to the matching subdirectory in
1376 the existing configuration.
1378 \begin_inset Flex Code
1381 \begin_layout Plain Layout
1387 subdirectory, however, since it contains a file written by the configuration
1388 script (also accessible through
1389 \begin_inset Flex Noun
1392 \begin_layout Plain Layout
1393 Tools\SpecialChar menuseparator
1399 ) which is configuration-specific.
1402 \begin_layout Chapter
1403 The Preferences dialog
1406 \begin_layout Standard
1407 All options of the preferences dialog are described in the Appendix
1409 The Preferences Dialog
1416 For some options you might find here more details.
1419 \begin_layout Section
1421 \begin_inset CommandInset label
1430 \begin_layout Standard
1431 The first step is to define your file formats if they are not already defined.
1433 \begin_inset Flex Noun
1436 \begin_layout Plain Layout
1437 Tools\SpecialChar menuseparator
1445 \begin_inset Flex Noun
1448 \begin_layout Plain Layout
1449 File Handling\SpecialChar menuseparator
1456 \begin_inset Flex Noun
1459 \begin_layout Plain Layout
1465 button to define your new format.
1467 \begin_inset Flex Noun
1470 \begin_layout Plain Layout
1476 field contains the name used to identify the format in the GUI.
1478 \begin_inset Flex Noun
1481 \begin_layout Plain Layout
1487 is used to identify the format internally.
1488 You will also need to enter a file extension.
1489 These are all required.
1491 \begin_inset Flex Noun
1494 \begin_layout Plain Layout
1500 field is used to provide a keyboard shortcut on the menus.
1501 (For example, pressing
1502 \begin_inset Flex Noun
1505 \begin_layout Plain Layout
1512 \begin_inset Flex Noun
1515 \begin_layout Plain Layout
1516 Document\SpecialChar menuseparator
1517 View (Other Formats)\SpecialChar menuseparator
1526 \begin_layout Standard
1528 \begin_inset Flex Noun
1531 \begin_layout Plain Layout
1538 \begin_inset Flex Noun
1541 \begin_layout Plain Layout
1548 For example, you might want to use
1549 \begin_inset Flex Noun
1552 \begin_layout Plain Layout
1558 to view PostScript files.
1559 You can enter the command needed to start the program in the corresponding
1561 In defining this command, you can use the four variables listed in the
1563 The viewer is launched when you view an image in \SpecialChar LyX
1565 \begin_inset Flex Noun
1568 \begin_layout Plain Layout
1569 Document\SpecialChar menuseparator
1576 The editor is for example launched when you right-click on an image and
1578 \begin_inset Flex Noun
1581 \begin_layout Plain Layout
1587 in the appearing context menu.
1590 \begin_layout Standard
1592 \begin_inset Flex Noun
1595 \begin_layout Plain Layout
1601 type of a format is optional, but if it is specified, it must be unique
1603 It is used to detect files of this format from the file contents.
1604 For some important file formats there is no MIME type officially registered
1606 \begin_inset CommandInset href
1609 target "http://www.iana.org/assignments/media-types/"
1615 Therefore \SpecialChar LyX
1616 uses the extended list of MIME types as specified by
1617 \begin_inset CommandInset href
1619 name "freedesktop.org"
1620 target "http://www.freedesktop.org/wiki/Specifications/shared-mime-info-spec"
1628 \begin_layout Standard
1630 \begin_inset Flex Noun
1633 \begin_layout Plain Layout
1639 option tells \SpecialChar LyX
1640 that a format is suitable for document export.
1641 If this is set and if a suitable conversion route exists (see
1642 \begin_inset CommandInset ref
1644 reference "sec:Converters"
1648 ), the format will appear in the
1649 \begin_inset Flex Noun
1652 \begin_layout Plain Layout
1653 File\SpecialChar menuseparator
1660 The format will also appear in the
1661 \begin_inset Flex Noun
1664 \begin_layout Plain Layout
1665 Document\SpecialChar menuseparator
1671 menu if a viewer is specified for the format.
1672 Pure image formats, such as
1673 \begin_inset Flex Code
1676 \begin_layout Plain Layout
1682 , should not use this option.
1683 Formats that can both represent vector graphics and documents like
1684 \begin_inset Flex Code
1687 \begin_layout Plain Layout
1696 \begin_layout Standard
1698 \begin_inset Flex Noun
1701 \begin_layout Plain Layout
1702 Vector graphics format
1707 tells \SpecialChar LyX
1708 that a format can contain vector graphics.
1709 This information is used to determine the target format of included graphics
1711 \begin_inset Flex Noun
1714 \begin_layout Plain Layout
1721 Included graphics may need to be converted to either
1722 \begin_inset Flex Noun
1725 \begin_layout Plain Layout
1732 \begin_inset Flex Noun
1735 \begin_layout Plain Layout
1742 \begin_inset Flex Noun
1745 \begin_layout Plain Layout
1752 \begin_inset Flex Noun
1755 \begin_layout Plain Layout
1761 cannot handle other image formats.
1762 If an included graphic is not already in
1763 \begin_inset Flex Noun
1766 \begin_layout Plain Layout
1773 \begin_inset Flex Noun
1776 \begin_layout Plain Layout
1783 \begin_inset Flex Noun
1786 \begin_layout Plain Layout
1792 format, it is converted to
1793 \begin_inset Flex Noun
1796 \begin_layout Plain Layout
1802 if the vector format option is set, and otherwise to
1803 \begin_inset Flex Noun
1806 \begin_layout Plain Layout
1815 \begin_layout Section
1819 \begin_layout Standard
1820 Since all conversions from one format to another take place in \SpecialChar LyX
1822 directory, it is sometimes necessary to modify a file before copying it
1823 to the temporary directory in order that the conversion may be performed.
1827 \begin_layout Plain Layout
1828 For example, the file may refer to other files—images, for example—using
1829 relative file names, and these may become invalid when the file is copied
1830 to the temporary directory.
1835 This is done by a Copier: It copies a file to (or from) the temporary directory
1836 and may modify it in the process.
1839 \begin_layout Standard
1840 The definitions of the copiers may use eight variables:
1843 \begin_layout Labeling
1844 \labelwidthstring 00.00.0000
1845 \begin_inset Flex Code
1848 \begin_layout Plain Layout
1854 The \SpecialChar LyX
1855 system directory (e.
1856 \begin_inset space \thinspace{}
1860 \begin_inset space \space{}
1864 \begin_inset Flex Noun
1867 \begin_layout Plain Layout
1876 \begin_layout Labeling
1877 \labelwidthstring 00.00.0000
1878 \begin_inset Flex Code
1881 \begin_layout Plain Layout
1890 \begin_layout Labeling
1891 \labelwidthstring 00.00.0000
1892 \begin_inset Flex Code
1895 \begin_layout Plain Layout
1904 \begin_layout Labeling
1905 \labelwidthstring 00.00.0000
1906 \begin_inset Flex Code
1909 \begin_layout Plain Layout
1915 The base name (without filename extension) in the \SpecialChar LyX
1919 \begin_layout Labeling
1920 \labelwidthstring 00.00.0000
1921 \begin_inset Flex Code
1924 \begin_layout Plain Layout
1930 The full directory path of the \SpecialChar LyX
1934 \begin_layout Labeling
1935 \labelwidthstring 00.00.0000
1936 \begin_inset Flex Code
1939 \begin_layout Plain Layout
1945 The full pathname to the original \SpecialChar LyX
1946 file being processed
1949 \begin_layout Labeling
1950 \labelwidthstring 00.00.0000
1951 \begin_inset Flex Code
1954 \begin_layout Plain Layout
1960 The filename (without any directory path) of the \SpecialChar LyX
1964 \begin_layout Labeling
1965 \labelwidthstring 00.00.0000
1966 \begin_inset Flex Code
1969 \begin_layout Plain Layout
1975 The `\SpecialChar LaTeX
1979 \begin_layout Standard
1980 The latter should be the filename as it would be used in a \SpecialChar LaTeX
1988 It is relevant only when exporting files suitable for such inclusion.
1991 \begin_layout Standard
1992 Copiers can be used to do almost anything with output files.
1993 For example, suppose you want generated pdf files to be copied to a special
1995 \begin_inset Flex Code
1998 \begin_layout Plain Layout
2005 Then you could write a shell script such as this one:
2008 \begin_layout Standard
2009 \begin_inset listings
2013 \begin_layout Plain Layout
2018 \begin_layout Plain Layout
2023 \begin_layout Plain Layout
2025 TOFILE=`basename $2`
2028 \begin_layout Plain Layout
2030 cp $FROMFILE /home/you/pdf/$TOFILE
2035 Save it in your local \SpecialChar LyX
2037 \begin_inset Flex Code
2040 \begin_layout Plain Layout
2041 /home/you/.lyx/scripts/pdfcopier.sh
2046 —and make it executable, if you need to do so on your platform.
2048 \begin_inset Flex Noun
2051 \begin_layout Plain Layout
2052 Tools\SpecialChar menuseparator
2058 dialog, select under
2059 \begin_inset Flex Noun
2062 \begin_layout Plain Layout
2063 File Handling\SpecialChar menuseparator
2070 \begin_inset Flex Noun
2073 \begin_layout Plain Layout
2079 format—or one of the other pdf formats—and enter
2080 \begin_inset Flex Code
2083 \begin_layout Plain Layout
2084 pdfcopier.sh $$i $$o
2090 \begin_inset Flex Noun
2093 \begin_layout Plain Layout
2103 \begin_layout Standard
2104 Copiers are used by \SpecialChar LyX
2105 in various of its own conversions.
2106 For example, if appropriate programs are found, \SpecialChar LyX
2107 will automatically install
2109 \begin_inset Flex Noun
2112 \begin_layout Plain Layout
2119 \begin_inset Flex Noun
2122 \begin_layout Plain Layout
2124 \begin_inset space ~
2133 When these formats are exported, the copier sees that not just the main
2134 HTML file but various associated files (style files, images, etc.) are also
2136 All these files are written to a subdirectory of the directory in which
2137 the original \SpecialChar LyX
2142 \begin_layout Plain Layout
2143 This copier can be customized.
2145 \begin_inset Quotes eld
2149 \begin_inset Quotes erd
2152 argument takes a comma-separated list of extensions to be copied; if it
2153 is omitted, all files will be copied.
2155 \begin_inset Quotes eld
2159 \begin_inset Quotes erd
2162 argument determines the extension added to the generated directory.
2164 \begin_inset Quotes eld
2168 \begin_inset Flex Noun
2171 \begin_layout Plain Layout
2178 \begin_inset Quotes erd
2181 , so HTML generated from
2182 \begin_inset Flex Noun
2185 \begin_layout Plain Layout
2186 /path/to/filename.lyx
2192 \begin_inset Flex Noun
2195 \begin_layout Plain Layout
2196 /path/to/filename.html.LyXconv
2210 \begin_layout Section
2212 \begin_inset CommandInset label
2214 name "sec:Converters"
2221 \begin_layout Standard
2222 You can define your own Converters to convert files between different formats.
2224 \begin_inset Flex Noun
2227 \begin_layout Plain Layout
2228 Tools\SpecialChar menuseparator
2229 Preferences\SpecialChar menuseparator
2230 File Handling\SpecialChar menuseparator
2239 \begin_layout Standard
2240 To define a new converter, select the
2241 \begin_inset Flex Noun
2244 \begin_layout Plain Layout
2246 \begin_inset space ~
2255 \begin_inset Flex Noun
2258 \begin_layout Plain Layout
2260 \begin_inset space ~
2268 from the drop-down lists, enter the command needed for the conversion,
2270 \begin_inset Flex Noun
2273 \begin_layout Plain Layout
2280 Several variables can be used in the definition of converters:
2283 \begin_layout Labeling
2284 \labelwidthstring 00.00.0000
2285 \begin_inset Flex Code
2288 \begin_layout Plain Layout
2294 The \SpecialChar LyX
2298 \begin_layout Labeling
2299 \labelwidthstring 00.00.0000
2300 \begin_inset Flex Code
2303 \begin_layout Plain Layout
2312 \begin_layout Labeling
2313 \labelwidthstring 00.00.0000
2314 \begin_inset Flex Code
2317 \begin_layout Plain Layout
2326 \begin_layout Labeling
2327 \labelwidthstring 00.00.0000
2328 \begin_inset Flex Code
2331 \begin_layout Plain Layout
2337 The base filename of the input file (i.
2338 \begin_inset space \thinspace{}
2341 g., without the extension)
2344 \begin_layout Labeling
2345 \labelwidthstring 00.00.0000
2346 \begin_inset Flex Code
2349 \begin_layout Plain Layout
2355 The path to the input file
2358 \begin_layout Labeling
2359 \labelwidthstring 00.00.0000
2360 \begin_inset Flex Code
2363 \begin_layout Plain Layout
2369 The path to the original input file (this is different from $$p when a
2370 chain of converters is called)
2373 \begin_layout Labeling
2374 \labelwidthstring 00.00.0000
2375 \begin_inset Flex Code
2378 \begin_layout Plain Layout
2384 The iconv name for the encoding of the document.
2387 \begin_layout Standard
2389 \begin_inset Flex Noun
2392 \begin_layout Plain Layout
2394 \begin_inset space ~
2402 field you can enter the following flags, separated by commas:
2405 \begin_layout Labeling
2406 \labelwidthstring 00.00.0000
2407 \begin_inset Flex Code
2410 \begin_layout Plain Layout
2412 \change_inserted -712698321 1524656940
2420 This converter runs some form of \SpecialChar LaTeX
2422 This will make \SpecialChar LyX
2423 's \SpecialChar LaTeX
2424 error logs available.
2426 \change_inserted -712698321 1524657018
2428 \begin_inset Flex Code
2431 \begin_layout Plain Layout
2433 \change_inserted -712698321 1524657012
2441 value specifies the form of \SpecialChar LaTeX
2443 \begin_inset Flex Code
2446 \begin_layout Plain Layout
2448 \change_inserted -712698321 1524657005
2449 latex, pdflatex, platex, xetex, luatex
2457 If no value is specified,
2458 \begin_inset Flex Code
2461 \begin_layout Plain Layout
2463 \change_inserted -712698321 1524657018
2476 \begin_layout Labeling
2477 \labelwidthstring 00.00.0000
2478 \begin_inset Flex Code
2481 \begin_layout Plain Layout
2483 \change_inserted -712698321 1524656935
2491 Needs the \SpecialChar LaTeX
2493 \begin_inset Flex Noun
2496 \begin_layout Plain Layout
2502 file for the conversion.
2504 \change_inserted -712698321 1524657047
2506 \begin_inset Flex Code
2509 \begin_layout Plain Layout
2511 \change_inserted -712698321 1524657030
2517 value specifies the form of \SpecialChar LaTeX
2518 that is run in order to generate the
2519 \begin_inset Flex Noun
2522 \begin_layout Plain Layout
2524 \change_inserted -712698321 1524657047
2531 \begin_inset Flex Code
2534 \begin_layout Plain Layout
2536 \change_inserted -712698321 1524657030
2537 latex, pdflatex, platex, xetex, luatex
2543 If no value is specified,
2544 \begin_inset Flex Code
2547 \begin_layout Plain Layout
2549 \change_inserted -712698321 1524657030
2560 \begin_layout Labeling
2561 \labelwidthstring 00.00.0000
2562 \begin_inset Flex Code
2565 \begin_layout Plain Layout
2572 \begin_inset Quotes eld
2576 \begin_inset Quotes erd
2579 file from the backend, which in practice means a \SpecialChar LaTeX
2580 file like the one we
2581 would export, without
2582 \begin_inset Flex Code
2585 \begin_layout Plain Layout
2594 \begin_layout Labeling
2595 \labelwidthstring 00.00.0000
2596 \begin_inset Flex Code
2599 \begin_layout Plain Layout
2608 \begin_layout Standard
2609 The following three flags are not really flags at all because they take
2611 \begin_inset Flex Noun
2614 \begin_layout Plain Layout
2616 \begin_inset space ~
2620 \begin_inset space ~
2631 \begin_layout Labeling
2632 \labelwidthstring 00.00.0000
2634 \change_inserted -712698321 1523206314
2635 \begin_inset Flex Code
2638 \begin_layout Plain Layout
2640 \change_inserted -712698321 1523206193
2646 The name of the driver that needs to be loaded with the
2650 package for this converter.
2651 The loading of the correct driver is necessary to get some PDF-specific
2660 \begin_layout Labeling
2661 \labelwidthstring 00.00.0000
2662 \begin_inset Flex Code
2665 \begin_layout Plain Layout
2671 If set, the converter's standard error will be redirected to a file
2672 \begin_inset Flex Code
2675 \begin_layout Plain Layout
2681 , and the script given as argument will be run as:
2682 \begin_inset Flex Code
2685 \begin_layout Plain Layout
2686 script < infile.out > infile.log
2692 The argument may contain
2693 \begin_inset Flex Code
2696 \begin_layout Plain Layout
2705 \begin_layout Labeling
2706 \labelwidthstring 00.00.0000
2707 \begin_inset Flex Code
2710 \begin_layout Plain Layout
2716 The name of the directory in which the converter will dump the generated
2719 will not create this directory, and it does not copy anything into it,
2720 though it will copy this directory to the destination.
2721 The argument may contain
2722 \begin_inset Flex Code
2725 \begin_layout Plain Layout
2731 , which will be replaced by the base name of the input and output files,
2732 respectively, when the directory is copied.
2733 \begin_inset Newline newline
2736 Note that resultdir and usetempdir make no sense together.
2737 The latter will be ignored if the former is given.
2740 \begin_layout Labeling
2741 \labelwidthstring 00.00.0000
2742 \begin_inset Flex Code
2745 \begin_layout Plain Layout
2751 Determines the output file name and may, contain
2752 \begin_inset Flex Code
2755 \begin_layout Plain Layout
2762 Sensible only with resultdir and optional even then; if not given, it defaults
2766 \begin_layout Standard
2768 \change_inserted -712698321 1523206384
2769 A suitable hyperref-driver is set for some converters that are installed
2770 with \SpecialChar LyX
2773 \change_deleted -712698321 1523206388
2775 \change_inserted -712698321 1523206389
2779 \change_inserted -712698321 1523206400
2783 \change_inserted -712698321 1523206407
2787 \change_inserted -712698321 1523206437
2791 \change_deleted -712698321 1523206442
2792 that are installed with \SpecialChar LyX
2799 \begin_layout Standard
2800 You do not have to define converters for all formats between which you want
2802 For example, you will note that there is no `\SpecialChar LyX
2803 to PostScript' converter,
2804 but \SpecialChar LyX
2805 will export PostScript.
2806 It does so by first creating a \SpecialChar LaTeX
2807 file (no converter needs to be defined
2808 for this) which is then converted to DVI using the `\SpecialChar LaTeX
2810 and finally converting the resulting DVI file to PostScript.
2812 finds such `chains' of converters automatically, and it will always choose
2813 the shortest possible chain.
2814 You can, though, still define multiple conversion methods between file
2816 For example, the standard \SpecialChar LyX
2817 configuration provides five ways to convert
2822 \begin_layout Enumerate
2824 \begin_inset Flex Noun
2827 \begin_layout Plain Layout
2836 \begin_layout Enumerate
2837 via (DVI and) PostScript, using
2838 \begin_inset Flex Noun
2841 \begin_layout Plain Layout
2850 \begin_layout Enumerate
2852 \begin_inset Flex Noun
2855 \begin_layout Plain Layout
2864 \begin_layout Enumerate
2866 \begin_inset Flex Noun
2869 \begin_layout Plain Layout
2879 \begin_layout Enumerate
2881 \begin_inset Flex Noun
2884 \begin_layout Plain Layout
2894 \begin_layout Standard
2895 To define such alternate chains, you must define multiple target `file formats',
2897 \begin_inset CommandInset ref
2899 reference "sec:Formats"
2904 For example, in the standard configuration, the formats named
2905 \begin_inset Flex Noun
2908 \begin_layout Plain Layout
2915 \begin_inset Flex Noun
2918 \begin_layout Plain Layout
2925 \begin_inset Flex Noun
2928 \begin_layout Plain Layout
2935 \begin_inset Flex Noun
2938 \begin_layout Plain Layout
2945 \begin_inset Flex Noun
2948 \begin_layout Plain Layout
2955 \begin_inset Flex Noun
2958 \begin_layout Plain Layout
2965 \begin_inset Flex Noun
2968 \begin_layout Plain Layout
2975 \begin_inset Flex Noun
2978 \begin_layout Plain Layout
2986 \begin_inset Flex Noun
2989 \begin_layout Plain Layout
2996 \begin_inset Flex Noun
2999 \begin_layout Plain Layout
3006 ) are defined, all of which share the extension
3007 \begin_inset Flex Noun
3010 \begin_layout Plain Layout
3016 , and which correspond to the conversion methods just mentioned.
3019 \begin_layout Chapter
3020 Internationalizing \SpecialChar LyX
3022 \begin_inset CommandInset label
3024 name "cha:Internationalizing-LyX"
3031 \begin_layout Standard
3033 supports using a translated interface.
3034 Last time we checked, \SpecialChar LyX
3035 provided text in thirty languages.
3036 The language of choice is called your
3041 (For further reading on locale settings, see also the documentation for
3042 locale that comes with your operating system.
3043 For Linux, the manual page for
3044 \begin_inset Flex Code
3047 \begin_layout Plain Layout
3053 could be a good place to start).
3056 \begin_layout Standard
3057 Notice that these translations will work, but do contain a few flaws.
3058 In particular, all dialogs have been designed with the English text in
3059 mind, which means that some of the translated text will be too large to
3060 fit within the space allocated.
3061 This is only a display problem and will not cause any harm.
3062 Also, you will find that some of the translations do not define shortcut
3063 keys for everything.
3064 Sometimes, there are simply not enough free letters to do it.
3065 Other times, the translator just hasn't got around to doing it yet.
3066 Our localization team, which you may wish to join,
3070 \begin_layout Plain Layout
3071 If you are a fluent speaker of a language other than English, joining these
3072 teams is a great way to give back to the \SpecialChar LyX
3078 will of course try to fix these shortcomings in future versions of \SpecialChar LyX
3082 \begin_layout Section
3083 Translating \SpecialChar LyX
3087 \begin_layout Subsection
3088 Translating the graphical user interface (text messages).
3091 \begin_layout Standard
3094 \begin_inset Flex Code
3097 \begin_layout Plain Layout
3103 library to handle the internationalization of the interface.
3104 To have \SpecialChar LyX
3105 speak your favorite language in all menus and dialogs, you need
3107 \begin_inset Flex Code
3110 \begin_layout Plain Layout
3116 -file for that language.
3117 When this is available, you'll have to generate a
3118 \begin_inset Flex Code
3121 \begin_layout Plain Layout
3127 -file from it and install the
3128 \begin_inset Flex Code
3131 \begin_layout Plain Layout
3138 The process of doing all of this is explained in the documentation for
3140 \begin_inset Flex Code
3143 \begin_layout Plain Layout
3150 It is possible to do this just for yourself, but if you're going to do
3151 it, you might as well share the results of your labors with the rest of
3152 the \SpecialChar LyX
3154 Send a message to the \SpecialChar LyX
3155 developers' list for more information about how
3159 \begin_layout Standard
3160 In short, this is what you should do (xx denotes the language code):
3163 \begin_layout Itemize
3164 Check out the \SpecialChar LyX
3167 \begin_inset CommandInset href
3169 name "information on the web"
3170 target "https://www.lyx.org/HowToUseGIT"
3178 \begin_layout Itemize
3180 \begin_inset Flex Code
3183 \begin_layout Plain Layout
3189 to the folder of the
3190 \begin_inset Flex Code
3193 \begin_layout Plain Layout
3201 \begin_inset Flex Code
3204 \begin_layout Plain Layout
3212 \begin_inset Flex Code
3215 \begin_layout Plain Layout
3221 doesn't exist anywhere, it can be remade with the console command
3222 \begin_inset Flex Code
3225 \begin_layout Plain Layout
3231 in that directory, or you can use an existing po-file for some other language
3235 \begin_layout Itemize
3237 \begin_inset Flex Code
3240 \begin_layout Plain Layout
3250 \begin_layout Plain Layout
3251 This is just a text file, so it can be edited in any text editor.
3252 But there are also specialized programs that support such editing, such
3257 (for all platforms) or
3266 contains a `mode' for editing
3267 \begin_inset Flex Code
3270 \begin_layout Plain Layout
3277 \begin_inset Flex URL
3280 \begin_layout Plain Layout
3282 https://www.gnu.org/software/gettext/manual/html_node/PO-Mode.html
3294 For some menu- and widget-labels, there are also shortcut keys that should
3296 Those keys are marked after a `|', and should be translated according to
3297 the words and phrases of the language.
3298 You should also fill also out the information at the beginning of the new
3300 \begin_inset Flex Code
3303 \begin_layout Plain Layout
3309 -file with your email-address, etc., so people know where to reach you with
3310 suggestions and entertaining flames.
3313 \begin_layout Standard
3314 If you are just doing this on your own, then:
3317 \begin_layout Itemize
3319 \begin_inset Flex Code
3322 \begin_layout Plain Layout
3329 This can be done with
3330 \begin_inset Flex Code
3333 \begin_layout Plain Layout
3334 msgfmt -o xx.mo < xx.po
3342 \begin_layout Itemize
3344 \begin_inset Flex Code
3347 \begin_layout Plain Layout
3353 -file to your locale-tree, at the correct directory for application messages
3358 xx, and under the name
3359 \begin_inset Flex Code
3362 \begin_layout Plain Layout
3369 \begin_inset space \thinspace{}
3373 \begin_inset space \space{}
3377 \begin_inset Flex Code
3380 \begin_layout Plain Layout
3381 /usr/local/share/locale/xx/LC_MESSAGES/lyx.mo
3391 \begin_layout Standard
3392 As said, however, it would be best if the new
3393 \begin_inset Flex Code
3396 \begin_layout Plain Layout
3402 file could be added to the \SpecialChar LyX
3403 distribution, so others can use it.
3404 Adding it involves making additional changes to \SpecialChar LyX
3406 So send an email to the developers' mailing list if you're interested in
3410 \begin_layout Subsubsection
3414 \begin_layout Standard
3415 Sometimes it turns out that one English message needs to be translated into
3416 different messages in the target language.
3417 One example is the message
3418 \begin_inset Flex Code
3421 \begin_layout Plain Layout
3427 which has the German translation
3435 , depending upon exactly what the English
3436 \begin_inset Quotes eld
3440 \begin_inset Quotes erd
3445 \begin_inset Flex Code
3448 \begin_layout Plain Layout
3454 does not handle such ambiguous translations.
3455 Therefore you have to add some context information to the message: Instead
3457 \begin_inset Flex Code
3460 \begin_layout Plain Layout
3467 \begin_inset Flex Code
3470 \begin_layout Plain Layout
3471 To[[as in 'From format x to format y']]
3477 \begin_inset Flex Code
3480 \begin_layout Plain Layout
3481 To[[as in 'From page x to page y']].
3486 Now the two occurrences of
3487 \begin_inset Flex Code
3490 \begin_layout Plain Layout
3497 \begin_inset Flex Code
3500 \begin_layout Plain Layout
3506 and can be translated correctly to
3517 \begin_layout Standard
3518 Of course the context information needs to be stripped off the original
3519 message when no translation is used.
3520 Therefore you have to put it in double square brackets at the end of the
3521 message (see the example above).
3522 The translation mechanism of \SpecialChar LyX
3523 ensures that everything in double square
3524 brackets at the end of messages is removed before displaying the message.
3527 \begin_layout Subsection
3528 Translating the documentation.
3531 \begin_layout Standard
3532 The online documentation (in the
3533 \begin_inset Flex Noun
3536 \begin_layout Plain Layout
3542 -menu) can (and should!) be translated.
3543 If there are translated versions of the documentation available
3547 \begin_layout Plain Layout
3548 As of March 2008, at least some of the documents have been translated into
3549 fourteen languages, with the Tutorial available in a few more.
3554 and the locale is set accordingly, these will be used automagically by
3558 looks for translated versions as
3559 \begin_inset Flex Code
3562 \begin_layout Plain Layout
3563 LyXDir/doc/xx/DocName.lyx
3569 \begin_inset Flex Code
3572 \begin_layout Plain Layout
3578 is the code for the language currently in use.
3579 If there are no translated documents, the default English versions will
3581 Note that the translated versions must have the same filenames (
3582 \begin_inset Flex Code
3585 \begin_layout Plain Layout
3591 above) as the original.
3592 If you feel up to translating the documentation (an excellent way to proof-read
3593 the original documentation by the way!), there are a few things you should
3597 \begin_layout Itemize
3598 Check out the documentation translation web page at
3599 \begin_inset CommandInset href
3601 name "https://www.lyx.org/Translation"
3602 target "https://www.lyx.org/Translation"
3608 That way, you can find out which (if any) documents have already been translate
3609 d into your language.
3610 You can also find out who (if anyone) is organizing the effort to translate
3611 the documentation into your language.
3612 If no one is organizing the effort, please let us know that you're interested.
3615 \begin_layout Standard
3616 Once you get to actually translating, here's a few hints for you that may
3620 \begin_layout Itemize
3621 Join the documentation team! There is information on how to do that in
3622 \begin_inset Flex Code
3625 \begin_layout Plain Layout
3632 \begin_inset Flex Noun
3635 \begin_layout Plain Layout
3636 Help\SpecialChar menuseparator
3642 ), which by the way is the first document you should translate.
3645 \begin_layout Itemize
3646 Learn the typographic conventions for the language you are translating to.
3647 Typography is an ancient art and over the centuries, a great variety of
3648 conventions have developed throughout different parts of the world.
3649 Also study the professional terminology amongst typographers in your country.
3650 Inventing your own terminology will only confuse the users.
3653 (Warning! Typography is addictive!)
3656 \begin_layout Itemize
3657 Make a copy of the document.
3658 This will be your working copy.
3659 You can use this as your personal translated help-file by placing it in
3661 \begin_inset Flex Code
3664 \begin_layout Plain Layout
3671 \begin_inset Note Greyedout
3674 \begin_layout Plain Layout
3679 For a complex document with external material (images, etc.), if you make
3681 \begin_inset space \thinspace{}
3685 \begin_inset space \space{}
3688 in a temp dir, beware that the links to external material may be broken
3689 when the document is moved to a different place.
3690 The best way is to retrieve the \SpecialChar LyX
3692 \begin_inset Flex URL
3695 \begin_layout Plain Layout
3697 https://www.lyx.org/HowToUseGIT
3702 ) and to edit the doc file in place.
3710 \begin_layout Itemize
3711 Sometimes the original document (from the \SpecialChar LyX
3712 team) will be updated.
3713 Use the source viewer at
3714 \begin_inset CommandInset href
3716 name "https://www.lyx.org/trac/timeline"
3717 target "https://www.lyx.org/trac/timeline"
3722 to see what has been changed.
3723 That way you can easily see which parts of the translated document need
3727 \begin_layout Standard
3728 If you ever find an error in the original document, fix it and notify the
3729 rest of the documentation team of the changes! (You didn't forget to join
3730 the documentation team, did you?)
3733 \begin_layout Standard
3734 \begin_inset Branch OutDated
3738 \begin_layout Section
3739 International Keyboard Support
3742 \begin_layout Standard
3745 [Editor's Note: The following section is by
3753 It needs to be fixed to conform to the new Documentation Style sheet and
3754 to make use of the new v1.0 features.
3755 The whole thing also needs to be merged with the section following it.-jw
3756 It may also be badly out of date.-rh (2008)]
3759 \begin_layout Subsection
3760 Defining Own Keymaps: Keymap File Format
3763 \begin_layout Standard
3764 Let's look at a keyboard definition file a little closer.
3765 It is a plain text file defining
3768 \begin_layout Itemize
3769 key-to-key or key-to-string translations
3772 \begin_layout Itemize
3776 \begin_layout Itemize
3777 dead keys exceptions
3780 \begin_layout Standard
3781 To define key-to-key or key-to-string translation, use this command:
3784 \begin_layout Quotation
3785 \begin_inset Flex Code
3788 \begin_layout Plain Layout
3797 \begin_inset Flex Code
3800 \begin_layout Plain Layout
3809 \begin_layout Standard
3811 \begin_inset Flex Code
3814 \begin_layout Plain Layout
3820 is the key to be translated and
3821 \begin_inset Flex Code
3824 \begin_layout Plain Layout
3830 is the string to be inserted into the document.
3831 To define dead keys, use:
3834 \begin_layout Quotation
3835 \begin_inset Flex Code
3838 \begin_layout Plain Layout
3847 \begin_inset Flex Code
3850 \begin_layout Plain Layout
3859 \begin_layout Standard
3861 \begin_inset Flex Code
3864 \begin_layout Plain Layout
3870 is a keyboard key and
3871 \begin_inset Flex Code
3874 \begin_layout Plain Layout
3881 The following dead keys are supported (shortcut name is in parentheses):
3884 \begin_layout Quotation
3888 \begin_inset space \hfill{}
3894 \begin_layout Quotation
3896 \begin_inset space \hfill{}
3902 \begin_layout Quotation
3904 \begin_inset space \hfill{}
3910 \begin_layout Quotation
3912 \begin_inset space \hfill{}
3918 \begin_layout Quotation
3920 \begin_inset space \hfill{}
3926 \begin_layout Quotation
3928 \begin_inset space \hfill{}
3935 \begin_layout Plain Layout
3947 \begin_layout Quotation
3949 \begin_inset space \hfill{}
3955 \begin_layout Quotation
3957 \begin_inset space \hfill{}
3964 \begin_layout Plain Layout
3976 \begin_layout Quotation
3978 \begin_inset space \hfill{}
3984 \begin_layout Quotation
3986 \begin_inset space \hfill{}
3992 \begin_layout Quotation
3994 \begin_inset space \hfill{}
4001 \begin_layout Plain Layout
4013 \begin_layout Quotation
4015 \begin_inset space \hfill{}
4022 \begin_layout Plain Layout
4034 \begin_layout Quotation
4036 \begin_inset space \hfill{}
4042 \begin_layout Quotation
4043 hungarian umlaut (hug)
4044 \begin_inset space \hfill{}
4050 \begin_layout Quotation
4052 \begin_inset space \hfill{}
4058 \begin_layout Quotation
4060 \begin_inset space \hfill{}
4067 \begin_layout Plain Layout
4079 \begin_layout Standard
4080 Since in many international keyboards there are exceptions to what some
4081 dead keys should do, you can define them using
4084 \begin_layout Quotation
4085 \begin_inset Flex Code
4088 \begin_layout Plain Layout
4096 deadkey key outstring
4099 \begin_layout Standard
4100 For example, on Slovak keyboard, if you enter caron-o, it generates circumflex-o
4104 \begin_layout Quotation
4105 \begin_inset Flex Code
4108 \begin_layout Plain Layout
4121 \begin_layout Standard
4122 to make it work correctly.
4123 Also, you have to define as exceptions dead keys over i and j, to remove
4124 the dot from them before inserting an accent mark.
4125 I will change this when the time comes, but so far I haven't had time.
4128 \begin_layout Standard
4129 Oh, and about characters: backslash is escaped, so to enter it, you'll need
4132 \begin_inset Flex Code
4135 \begin_layout Plain Layout
4141 have different meaning.
4143 \begin_inset Flex Code
4146 \begin_layout Plain Layout
4152 marks comments, quotes start and end \SpecialChar LaTeX
4154 To enter quote, you'll need to use
4155 \begin_inset Flex Code
4158 \begin_layout Plain Layout
4167 \begin_inset Flex Code
4170 \begin_layout Plain Layout
4177 \begin_inset Flex Code
4180 \begin_layout Plain Layout
4191 \begin_layout Standard
4192 If you make a keyboard description file that works for your language, please
4193 mail it to me, so I can include it in the next keymap distribution.
4196 \begin_layout Standard
4197 More keywords will be supported in keymap configuration file in future,
4201 \begin_layout Itemize
4202 \begin_inset Flex Code
4205 \begin_layout Plain Layout
4216 \begin_inset space \hfill{}
4220 \begin_inset Flex Code
4223 \begin_layout Plain Layout
4232 \begin_layout Itemize
4233 \begin_inset Flex Code
4236 \begin_layout Plain Layout
4247 \begin_inset space \hfill{}
4251 \begin_inset Flex Code
4254 \begin_layout Plain Layout
4260 an external keymap translation program
4263 \begin_layout Standard
4264 Also, it should look into
4265 \begin_inset Flex Code
4268 \begin_layout Plain Layout
4274 file for defaults, too (for example, a
4275 \begin_inset Flex Code
4278 \begin_layout Plain Layout
4286 option to include default keyboard).
4294 \begin_layout Section
4295 International Keymap Stuff
4296 \begin_inset CommandInset label
4298 name "sec:International-Keymap-Stuff"
4305 \begin_layout Standard
4306 \begin_inset Note Note
4309 \begin_layout Plain Layout
4310 In doing the revisions on this document in March 2008, I did not look over
4311 this stuff, as I do not understand it.
4312 It would be good if someone else could do so.
4321 \begin_layout Standard
4322 The next two sections describe the
4323 \begin_inset Flex Code
4326 \begin_layout Plain Layout
4335 \begin_inset Flex Code
4338 \begin_layout Plain Layout
4346 file syntax in detail.
4347 These sections should help you design your own key map if the ones provided
4348 do not meet your needs.
4351 \begin_layout Subsection
4355 \begin_layout Standard
4359 \begin_inset Flex Code
4362 \begin_layout Plain Layout
4368 file maps keystrokes to characters or strings.
4369 As the name suggests, it sets a keyboard mapping.
4371 \begin_inset Flex Code
4374 \begin_layout Plain Layout
4385 \begin_inset Flex Code
4388 \begin_layout Plain Layout
4403 \begin_inset Flex Code
4406 \begin_layout Plain Layout
4419 \begin_inset Flex Code
4422 \begin_layout Plain Layout
4431 \begin_inset Flex Code
4434 \begin_layout Plain Layout
4442 are described in this section.
4445 \begin_layout Labeling
4446 \labelwidthstring 00.00.0000
4447 \begin_inset Flex Code
4450 \begin_layout Plain Layout
4458 Map a character to a string
4461 \begin_layout LyX-Code
4476 \begin_layout Standard
4509 the double-quote (")
4526 must be escaped with a preceding backslash (
4537 \begin_layout Standard
4539 \begin_inset Flex Noun
4542 \begin_layout Plain Layout
4550 statement to cause the symbol
4551 \begin_inset Flex Noun
4554 \begin_layout Plain Layout
4562 to be output for the keystroke
4563 \begin_inset Flex Noun
4566 \begin_layout Plain Layout
4577 \begin_layout LyX-Code
4583 \begin_layout Labeling
4584 \labelwidthstring 00.00.0000
4585 \begin_inset Flex Code
4588 \begin_layout Plain Layout
4596 Specify an accent character
4599 \begin_layout LyX-Code
4608 \begin_layout Standard
4609 This will make the cha
4647 This is the dead key
4651 \begin_layout Plain Layout
4658 refers to a key that does not produce a character by itself, but when followed
4659 with another key, produces the desired accent character.
4660 For example, a German characte
4662 r with an umlaut like
4672 can be produced in this manner.
4681 \begin_layout Standard
4694 and then another key not in
4711 followed by the other, not allowed key, as output.
4715 \begin_inset Flex Noun
4718 \begin_layout Plain Layout
4726 cancels a dead key, so if
4737 \begin_inset Flex Noun
4740 \begin_layout Plain Layout
4749 , the cursor will not go one position backwards but will instead cancel
4765 might have had on the next keystroke.
4769 \begin_layout Standard
4770 The following example specifies that the character ' is to be an acute accent,
4771 allowed on the characters a, e, i, o, u, A, E, I, O, and U:
4774 \begin_layout LyX-Code
4777 kmod ' acute aeiouAEIOU
4780 \begin_layout Labeling
4781 \labelwidthstring 00.00.0000
4782 \begin_inset Flex Code
4785 \begin_layout Plain Layout
4791 Specify an exception to the accent character
4794 \begin_layout LyX-Code
4803 \begin_layout Standard
4804 This defines an exce
4845 have been assigned a keystroke with a previous
4848 \begin_inset Flex Code
4851 \begin_layout Plain Layout
4875 must not belong in the
4922 If such a declaration does not exist in
4930 \begin_inset Flex Code
4933 \begin_layout Plain Layout
4967 \begin_inset Flex Code
4970 \begin_layout Plain Layout
4984 \begin_layout Standard
4985 The following command produces causes äi to be produced when you enter acute-i
4989 \begin_layout LyX-Code
5003 \begin_layout Labeling
5004 \labelwidthstring 00.00.0000
5005 \begin_inset Flex Code
5008 \begin_layout Plain Layout
5014 Combine two accent characters
5017 \begin_layout LyX-Code
5023 accent1 accent2 allowed
5026 \begin_layout Standard
5027 This one is getting pretty esoteric.
5028 It allows you to combine the effect
5084 \begin_inset Flex Code
5087 \begin_layout Plain Layout
5115 \begin_layout Standard
5116 Consider this example from the
5117 \begin_inset Flex Code
5120 \begin_layout Plain Layout
5131 \begin_layout LyX-Code
5134 kmod ; acute aeioyvhAEIOYVH
5138 kcomb acute umlaut iyIY
5141 \begin_layout Standard
5142 This allows you to press
5143 \begin_inset Flex Noun
5146 \begin_layout Plain Layout
5154 and get the effect of
5155 \begin_inset Flex Code
5158 \begin_layout Plain Layout
5177 in this case cancels the last dead key, so if you press
5178 \begin_inset Flex Noun
5181 \begin_layout Plain Layout
5190 \begin_inset Flex Code
5193 \begin_layout Plain Layout
5206 \begin_layout Subsection
5210 \begin_layout Standard
5212 \begin_inset Flex Code
5215 \begin_layout Plain Layout
5223 mapping is performed, a
5224 \begin_inset Flex Code
5227 \begin_layout Plain Layout
5237 file maps the strings that the symbols generate to characters in the current
5239 The \SpecialChar LyX
5240 distribution currently includes at least the
5241 \begin_inset Flex Code
5244 \begin_layout Plain Layout
5253 \begin_inset Flex Code
5256 \begin_layout Plain Layout
5267 \begin_layout Standard
5269 \begin_inset Flex Code
5272 \begin_layout Plain Layout
5280 file is a sequence of declarations of the form
5283 \begin_layout LyX-Code
5296 \begin_layout Standard
5297 For example, in order to map
5298 \begin_inset Flex Noun
5301 \begin_layout Plain Layout
5311 to the corresponding character in the iso-8859-1 set (233), the following
5315 \begin_layout LyX-Code
5323 \begin_layout Standard
5325 \begin_inset Flex Code
5328 \begin_layout Plain Layout
5337 \begin_inset Flex Code
5340 \begin_layout Plain Layout
5358 the same character can apply to more than one string.
5360 \begin_inset Flex Code
5363 \begin_layout Plain Layout
5374 \begin_layout LyX-Code
5386 \begin_inset Newline newline
5402 \begin_layout Standard
5404 cannot find a mapping for the string produced by the keystroke or a
5405 deadkey sequence, it will check if it looks like an accented char and try
5406 to draw an accent over the character on screen.
5409 \begin_layout Subsection
5413 \begin_layout Standard
5414 There is a second way to add support for international characters through
5415 so-called dead-keys.
5416 A dead-key works in combination with a letter to produce an accented character.
5417 Here, we'll explain how to create a really simple dead-key to illustrate
5421 \begin_layout Standard
5422 Suppose you happen to need the circumflex character,
5423 \begin_inset Quotes eld
5427 \begin_inset Quotes erd
5432 \begin_inset Flex Noun
5435 \begin_layout Plain Layout
5442 \begin_inset space ~
5446 \begin_inset Flex Noun
5449 \begin_layout Plain Layout
5455 ] to the \SpecialChar LyX
5457 \begin_inset Flex Code
5460 \begin_layout Plain Layout
5467 \begin_inset Flex Code
5470 \begin_layout Plain Layout
5477 Now, whenever you type the
5478 \begin_inset Flex Noun
5481 \begin_layout Plain Layout
5487 -key followed by a letter, that letter will have a circumflex accent on
5489 For example, the sequence
5490 \begin_inset Quotes eld
5494 \begin_inset Flex Noun
5497 \begin_layout Plain Layout
5504 \begin_inset Quotes erd
5507 produces the letter:
5508 \begin_inset Quotes eld
5512 \begin_inset Quotes erd
5516 If you tried to type
5517 \begin_inset Quotes eld
5521 \begin_inset Flex Noun
5524 \begin_layout Plain Layout
5531 \begin_inset Quotes erd
5534 , however, \SpecialChar LyX
5535 will complain with a beep, since a
5536 \begin_inset Quotes eld
5540 \begin_inset Flex Noun
5543 \begin_layout Plain Layout
5550 \begin_inset Quotes erd
5553 never takes a circumflex accent.
5555 \begin_inset Flex Noun
5558 \begin_layout Plain Layout
5564 after a dead-key produces the bare-accent.
5565 Please note this last point! If you bind a key to a dead-key, you'll need
5566 to rebind the character on that key to yet another key.
5568 \begin_inset Flex Noun
5571 \begin_layout Plain Layout
5577 to a cedilla is a bad idea, since you'll only get cedillas instead of commas.
5580 \begin_layout Standard
5581 One common way to bind dead-keys is to use
5582 \begin_inset Flex Noun
5585 \begin_layout Plain Layout
5592 \begin_inset Flex Noun
5595 \begin_layout Plain Layout
5602 \begin_inset Flex Noun
5605 \begin_layout Plain Layout
5611 in combination with an accent, like
5612 \begin_inset Quotes eld
5616 \begin_inset Flex Noun
5619 \begin_layout Plain Layout
5626 \begin_inset Quotes erd
5630 \begin_inset Quotes eld
5634 \begin_inset Flex Noun
5637 \begin_layout Plain Layout
5644 \begin_inset Quotes erd
5648 \begin_inset Quotes eld
5652 \begin_inset Flex Noun
5655 \begin_layout Plain Layout
5662 \begin_inset Quotes erd
5666 Another way involves using
5667 \begin_inset Flex Code
5670 \begin_layout Plain Layout
5677 \begin_inset Flex Code
5680 \begin_layout Plain Layout
5686 to set up the special
5687 \begin_inset Flex Code
5690 \begin_layout Plain Layout
5698 \begin_inset Flex Code
5701 \begin_layout Plain Layout
5707 acts in some ways just like
5708 \begin_inset Flex Noun
5711 \begin_layout Plain Layout
5717 and permits you to bind keys to accented characters.
5718 You can also turn keys into dead-keys by binding them to something like
5720 \begin_inset Flex Code
5723 \begin_layout Plain Layout
5729 and then binding this symbolic key to the corresponding \SpecialChar LyX
5734 \begin_layout Plain Layout
5739 : This is exactly what I do in my
5740 \begin_inset Flex Code
5743 \begin_layout Plain Layout
5750 \begin_inset Flex Code
5753 \begin_layout Plain Layout
5761 \begin_inset Flex Noun
5764 \begin_layout Plain Layout
5766 \begin_inset space ~
5775 \begin_inset Flex Code
5778 \begin_layout Plain Layout
5784 and a bunch of these
5785 \begin_inset Quotes eld
5789 \begin_inset Flex Code
5792 \begin_layout Plain Layout
5799 \begin_inset Quotes erd
5802 symbolic keys bound such things as
5803 \begin_inset Flex Noun
5806 \begin_layout Plain Layout
5808 \begin_inset space ~
5817 \begin_inset Flex Noun
5820 \begin_layout Plain Layout
5822 \begin_inset space ~
5831 This is how I produce my accented characters.
5836 You can make just about anything into the
5837 \begin_inset Flex Code
5840 \begin_layout Plain Layout
5847 \begin_inset Flex Noun
5850 \begin_layout Plain Layout
5856 keys, a spare function key, etc.
5857 As for the \SpecialChar LyX
5858 commands that produce accents, check the entry for
5859 \begin_inset Flex Code
5862 \begin_layout Plain Layout
5873 You'll find the complete list there.
5876 \begin_layout Subsection
5877 Saving your Language Configuration
5880 \begin_layout Standard
5881 You can edit your preferences so that your desired language environment
5882 is automatically configured when \SpecialChar LyX
5884 \begin_inset Flex Noun
5887 \begin_layout Plain Layout
5888 Edit\SpecialChar menuseparator
5897 \begin_layout Chapter
5898 Installing New Document Classes, Layouts, and Templates
5899 \begin_inset CommandInset label
5901 name "cha:Installing-New-Document"
5906 \begin_inset Argument 1
5909 \begin_layout Plain Layout
5910 Installing New Document Classes
5918 \begin_layout Standard
5919 In this chapter, we describe the procedures for creating and installing
5920 new \SpecialChar LyX
5921 layout and template files, as well as offer a refresher on correctly
5922 installing new \SpecialChar LaTeX
5927 \begin_layout Standard
5928 First, let us a say a few words about how one ought to think about the relation
5929 between \SpecialChar LyX
5930 and \SpecialChar LaTeX
5932 The thing to understand is that, in a certain sense, \SpecialChar LyX
5933 doesn't know anything
5934 about \SpecialChar LaTeX
5936 Indeed, from \SpecialChar LyX
5937 's point of view, \SpecialChar LaTeX
5938 is just one of several
5939 \begin_inset Quotes eld
5943 \begin_inset Quotes erd
5946 in which it is capable of producing output.
5947 Other such formats are DocBook, plaintext, and XHTML.
5949 is, of course, a particularly important format, but very little of the
5950 information \SpecialChar LyX
5951 has about \SpecialChar LaTeX
5952 is actually contained in the program itself.
5956 \begin_layout Plain Layout
5957 Some commands are sufficiently complex that they are
5958 \begin_inset Quotes eld
5962 \begin_inset Quotes erd
5965 into \SpecialChar LyX
5967 But the developers generally regard this as a Bad Thing.
5972 Rather, that information, even for the standard classes like
5973 \begin_inset Flex Code
5976 \begin_layout Plain Layout
5982 , is contained in `layout files'.
5983 Similarly, \SpecialChar LyX
5984 itself does not know much about DocBook or XHTML.
5985 What it knows is contained in layout files.
5988 \begin_layout Standard
5989 You can think of the layout file for a given document class as a translation
5990 manual between \SpecialChar LyX
5991 constructs—paragraphs with their corresponding styles,
5992 certain sorts of insets, etc—and the corresponding \SpecialChar LaTeX
5995 Almost everything \SpecialChar LyX
5997 \begin_inset Flex Code
6000 \begin_layout Plain Layout
6006 , for example, is contained in the file
6007 \begin_inset Flex Code
6010 \begin_layout Plain Layout
6016 and in various other files it includes.
6017 For this reason, anyone intending to write layout files should plan to
6018 study the existing files.
6019 A good place to start is with
6020 \begin_inset Flex Code
6023 \begin_layout Plain Layout
6029 , which is included in
6030 \begin_inset Flex Code
6033 \begin_layout Plain Layout
6040 \begin_inset Flex Code
6043 \begin_layout Plain Layout
6049 , and many of the other layout files for document classes.
6050 This file is where sections and the like are defined:
6051 \begin_inset Flex Code
6054 \begin_layout Plain Layout
6060 tells \SpecialChar LyX
6061 how paragraphs that are marked with the Section, Subsection, etc,
6062 styles can be translated into corresponding \SpecialChar LaTeX
6063 , DocBook, and XHTML commands
6066 \begin_inset Flex Code
6069 \begin_layout Plain Layout
6075 file basically just includes several of these
6076 \begin_inset Flex Code
6079 \begin_layout Plain Layout
6088 \begin_layout Standard
6089 Defining the \SpecialChar LyX
6091 correspondence is not the only thing layout files do, though.
6092 Their other job is to define how the \SpecialChar LyX
6093 constructs themselves will appear
6095 The fact that layout files have these two jobs is often a source of confusion,
6096 because they are completely separate.
6097 Telling \SpecialChar LyX
6098 how to translate a certain paragraph style into \SpecialChar LaTeX
6101 how to display it; conversely, telling \SpecialChar LyX
6102 how to display a certain paragraph
6103 style does not tell \SpecialChar LyX
6104 how to translate it into \SpecialChar LaTeX
6105 (let alone tell \SpecialChar LaTeX
6108 So, in general, when you define a new \SpecialChar LyX
6109 construct, you must always do two
6110 quite separate things: (i)
6111 \begin_inset space ~
6114 tell \SpecialChar LyX
6115 how to translate it into \SpecialChar LaTeX
6117 \begin_inset space ~
6120 tell \SpecialChar LyX
6124 \begin_layout Standard
6125 Much the same is true, of course, as regards \SpecialChar LyX
6126 's other backend formats, though
6127 XHTML is in some ways different, because in that case \SpecialChar LyX
6132 able, to some extent, to use information about how it should display a
6133 paragraph on the screen to output information (in the form of CSS) about
6134 how the paragraph should be displayed in a browser.
6135 Even in this case, however, the distinction between what \SpecialChar LyX
6137 and how things are rendered externally remains in force, and the two can
6138 be controlled separately.
6140 \begin_inset CommandInset ref
6142 reference "sec:Tags-for-XHTML"
6149 \begin_layout Section
6150 Installing new \SpecialChar LaTeX
6154 \begin_layout Standard
6155 Some installations may not include a \SpecialChar LaTeX
6156 package or class file that you would
6157 like to use within \SpecialChar LyX
6159 For example, you might need Foil\SpecialChar TeX
6160 , a package for preparing slides for overhead
6162 Modern \SpecialChar LaTeX
6163 distributions like \SpecialChar TeX
6164 Live (2008 or newer) or MiK\SpecialChar TeX
6165 provide a user interface
6166 for installing such packages.
6167 For example, with MiK\SpecialChar TeX
6168 , you start the program
6169 \begin_inset Quotes eld
6173 \begin_inset space ~
6177 \begin_inset Quotes erd
6180 to get a list of available packages.
6181 To install one of them, right click on it or use the corresponding toolbar
6185 \begin_layout Standard
6186 If your \SpecialChar LaTeX
6187 distribution does not provide such a `package manager', or if the
6188 package is not available from your distribution, then follow these steps
6189 to install it manually:
6192 \begin_layout Enumerate
6193 Get the package from
6194 \begin_inset CommandInset href
6197 target "http://www.ctan.org/"
6205 \begin_layout Enumerate
6206 If the package contains a file with the ending
6207 \begin_inset Quotes eld
6211 \begin_inset Flex Code
6214 \begin_layout Plain Layout
6221 \begin_inset Quotes erd
6224 (is the case for Foil\SpecialChar TeX
6225 ) then open a console, change to the folder of this
6226 file and execute the command
6227 \begin_inset Flex Code
6230 \begin_layout Plain Layout
6237 You have now unpacked the package and have all files to install it.
6238 Most \SpecialChar LaTeX
6239 -packages are not packed and you can skip this step.
6242 \begin_layout Enumerate
6243 Now you need to decide if the package should be available for all users
6248 \begin_layout Enumerate
6249 On *nix systems (Linux, OSX, etc.), if you want the new package to be available
6250 for all users on your system, then install it in your `local' \SpecialChar TeX
6252 install it in your own `user' \SpecialChar TeX
6254 Where these trees should be created, if they do not already exist, depends
6256 To find this out, look in the file
6257 \begin_inset Flex Code
6260 \begin_layout Plain Layout
6270 \begin_layout Plain Layout
6271 This is usually in the directory
6272 \begin_inset Flex Code
6275 \begin_layout Plain Layout
6281 , though you can execute the command
6282 \begin_inset Flex Code
6285 \begin_layout Plain Layout
6296 The location of the `local' \SpecialChar TeX
6297 tree is defined by the
6298 \begin_inset Flex Code
6301 \begin_layout Plain Layout
6307 variable; this is usually somewhere like
6308 \begin_inset Flex Code
6311 \begin_layout Plain Layout
6312 /usr/local/share/texmf
6317 or /usr/local/texlive/XXXX where XXXX is the year of the installed \SpecialChar TeX
6320 The location of the `user' \SpecialChar TeX
6322 \begin_inset Flex Code
6325 \begin_layout Plain Layout
6332 \begin_inset Flex Code
6335 \begin_layout Plain Layout
6342 \begin_inset Flex Code
6345 \begin_layout Plain Layout
6354 (If these variables are not predefined, you have to define them.) You'll
6355 probably need root permissions to create or modify the `local' tree, but
6356 not for your `user' tree.
6357 \begin_inset Newline newline
6360 In general, it is recommended to install in the user tree because your user
6361 will not be modified or even overwritten when you upgrade your system.
6362 It will typically also be backed up together with everything else when
6363 you backup your home directory (which, of course, you do on a regular basis).
6366 \begin_layout Enumerate
6367 On Windows, if you want the new package to be available for all users on
6368 your system, change to the folder where \SpecialChar LaTeX
6369 is installed and then change to
6371 \begin_inset Flex Code
6374 \begin_layout Plain Layout
6385 (For MiK\SpecialChar TeX
6386 , this would be by default the folder
6387 \begin_inset Flex Code
6390 \begin_layout Plain Layout
6408 \begin_layout Plain Layout
6409 Note that this will be the correct path only on English installations.
6410 On a German one, it would be
6411 \begin_inset Flex Code
6414 \begin_layout Plain Layout
6428 , and similarly for other languages.
6433 Create there a new folder
6434 \begin_inset Flex Code
6437 \begin_layout Plain Layout
6443 and copy all files of the package into it.
6445 \begin_inset Newline newline
6448 If the package should only available for you or you don't have admin permissions
6449 , do the same, but in the local \SpecialChar LaTeX
6452 \begin_inset space \thinspace{}
6455 g., for MiK\SpecialChar TeX
6457 \begin_inset space ~
6460 2.8 under Windows XP, this would be the folder:
6461 \begin_inset Newline newline
6467 \begin_inset Flex Code
6470 \begin_layout Plain Layout
6473 Documents and Settings
6485 \begin_inset Newline newline
6491 \begin_inset Phantom HPhantom
6494 \begin_layout Plain Layout
6505 \begin_inset Flex Code
6508 \begin_layout Plain Layout
6521 \begin_inset Newline newline
6524 On Vista, it would be:
6525 \begin_inset Newline newline
6529 \begin_inset Flex Code
6532 \begin_layout Plain Layout
6558 \begin_layout Enumerate
6559 Now one only need to tell \SpecialChar LaTeX
6560 that there are new files.
6561 This depends on the used \SpecialChar LaTeX
6566 \begin_layout Enumerate
6567 For \SpecialChar TeX
6568 Live execute the command
6569 \begin_inset Flex Code
6572 \begin_layout Plain Layout
6579 If you installed the package for all users, then you will probably need
6580 to have root permissions for that.
6583 \begin_layout Enumerate
6584 For MiK\SpecialChar TeX
6585 , if you have installed the package for all users, start the program
6587 \begin_inset Quotes eld
6591 \begin_inset space ~
6595 \begin_inset Quotes erd
6598 and press the button marked
6599 \begin_inset Quotes eld
6603 \begin_inset Quotes erd
6607 Otherwise start the program
6608 \begin_inset Quotes eld
6612 \begin_inset Quotes erd
6619 \begin_layout Enumerate
6620 Finally, you need to tell \SpecialChar LyX
6621 that there are new packages available.
6622 So, in \SpecialChar LyX
6624 \begin_inset Flex Noun
6627 \begin_layout Plain Layout
6630 \SpecialChar menuseparator
6636 and then restart \SpecialChar LyX
6640 \begin_layout Standard
6641 Now the package is installed.
6642 In our example, the document class
6643 \begin_inset Flex Code
6646 \begin_layout Plain Layout
6652 will now be available under
6653 \begin_inset Flex Noun
6656 \begin_layout Plain Layout
6657 Document\SpecialChar menuseparator
6658 Settings\SpecialChar menuseparator
6665 \begin_inset Quotes eld
6669 \begin_inset Quotes erd
6676 \begin_layout Standard
6677 If you would like to use a \SpecialChar LaTeX
6678 document class that is not even listed in the
6680 \begin_inset Flex Noun
6683 \begin_layout Plain Layout
6684 Document\SpecialChar menuseparator
6685 Settings\SpecialChar menuseparator
6691 , then you need to create a `layout' file for it.
6692 That is the topic of the next section.
6695 \begin_layout Section
6696 Types of layout files
6699 \begin_layout Standard
6700 This section describes the various sorts of \SpecialChar LyX
6701 files that contain layout informati
6703 These files describe various paragraph and character styles, determining
6704 how \SpecialChar LyX
6705 should display them and how they should be translated into \SpecialChar LaTeX
6707 XHTML, or whatever output format is being used.
6711 \begin_layout Standard
6712 We shall try to provide a thorough description of the process of writing
6714 However, there are so many different types of documents supported even
6715 by just \SpecialChar LaTeX
6716 that we can't hope to cover every different possibility or problem
6717 you might encounter.
6718 The \SpecialChar LyX
6719 users' list is frequented by people with lots of experience with layout
6720 design who are willing to share what they've learned, so please feel free
6721 to ask questions there.
6724 \begin_layout Standard
6725 As you prepare to write a new layout, it is extremely helpful to look at
6726 the layouts distributed with \SpecialChar LyX
6728 If you write a \SpecialChar LyX
6729 layout for a \SpecialChar LaTeX
6730 document class that might also be used by
6731 others, or write a module that might be useful to others, then you should
6732 consider posting your layout to the
6733 \begin_inset CommandInset href
6735 name "layout section on the LyX wiki"
6736 target "https://wiki.lyx.org/Layouts/Layouts"
6741 or even to the \SpecialChar LyX
6742 developers' list, so that it might be included in \SpecialChar LyX
6747 \begin_layout Plain Layout
6748 Note that \SpecialChar LyX
6749 is licensed under the General Public License, so any material
6750 that is contributed to \SpecialChar LyX
6751 must be similarly licensed.
6759 \begin_layout Subsection
6761 \begin_inset CommandInset label
6763 name "subsec:Layout-modules"
6770 \begin_layout Standard
6771 We have spoken to this point about `layout files'.
6772 But there are different sorts of files that contain layout information.
6773 Layout files, strictly so called, have the
6774 \begin_inset Flex Code
6777 \begin_layout Plain Layout
6783 extension and provide \SpecialChar LyX
6784 with information about document classes.
6785 Since \SpecialChar LyX
6786 1.6 layout information can also be contained in layout
6791 \begin_inset Flex Code
6794 \begin_layout Plain Layout
6801 Modules are to \SpecialChar LaTeX
6802 packages much as layouts are to \SpecialChar LaTeX
6803 classes, and some modules—such
6805 \begin_inset Flex Code
6808 \begin_layout Plain Layout
6814 module—specifically provide support for one package.
6815 In a sense, layout modules are similar to included
6819 \begin_layout Plain Layout
6820 These can have any extension, but by convention have the
6821 \begin_inset Flex Code
6824 \begin_layout Plain Layout
6836 \begin_inset Flex Code
6839 \begin_layout Plain Layout
6845 —in that modules are not specific to a given document class but may be used
6846 with many different classes.
6847 The difference is that using an included file with
6848 \begin_inset Flex Code
6851 \begin_layout Plain Layout
6857 requires editing that file.
6858 Modules, by contrast, are selected in the
6859 \begin_inset Flex Noun
6862 \begin_layout Plain Layout
6863 Document\SpecialChar menuseparator
6872 \begin_layout Standard
6873 Building modules is the easiest way to get started with layout editing,
6874 since it can be as simple as adding a single new paragraph style or flex
6876 But modules may, in principle, contain anything a layout file can contain.
6879 \begin_layout Standard
6880 After creating a new module and copying it to the
6881 \begin_inset Flex Code
6884 \begin_layout Plain Layout
6890 folder, you will need to reconfigure and then restart \SpecialChar LyX
6893 However, changes you make to the module will be seen immediately, if you
6895 \begin_inset Flex Noun
6898 \begin_layout Plain Layout
6899 Document\SpecialChar menuseparator
6905 , highlight something, and then hit
6906 \begin_inset Quotes eld
6910 \begin_inset Quotes erd
6916 It is strongly recommended that you save your work before doing this
6921 it is strongly recommended that you not attempt to edit modules while simultaneo
6922 usly working on actual documents
6925 Though of course the developers strive to keep \SpecialChar LyX
6926 stable in such situations,
6927 syntax errors and the like in your module file could cause strange behavior.
6930 \begin_layout Subsubsection
6934 \begin_layout Standard
6935 Modules are to \SpecialChar LyX
6936 as packages are to \SpecialChar LaTeX
6938 Sometimes, however, you find yourself wanting a specific inset or character
6939 style just for one document and writing a module that will also be available
6940 to other documents makes little sense.
6941 What you need is \SpecialChar LyX
6943 \begin_inset Quotes eld
6947 \begin_inset Quotes erd
6953 \begin_layout Standard
6954 You will find it under
6956 Document\SpecialChar menuseparator
6957 Settings\SpecialChar menuseparator
6961 The large text box allows you to enter anything that you might enter in
6962 a layout file or module.
6963 You can think of a document's local layout, in fact, as a module that belongs
6965 So, in particular, you must enter a
6966 \begin_inset Flex Code
6969 \begin_layout Plain Layout
6976 Any format is acceptable, but one would normally use the format current
6978 (In \SpecialChar LyX
6979 2.3, the current layout format is 63.)
6982 \begin_layout Standard
6983 When you have entered something in the
6984 \begin_inset Flex Code
6987 \begin_layout Plain Layout
6993 pane, \SpecialChar LyX
6995 \begin_inset Quotes eld
6999 \begin_inset Quotes erd
7002 button at the bottom.
7003 Clicking this button will cause \SpecialChar LyX
7004 to determine whether what you have entered
7005 is valid layout information for the chosen format.
7007 will report the result but, unfortunately, will not tell you what errors
7008 there might have been.
7009 These will be written to the terminal, however, if \SpecialChar LyX
7010 is started from a terminal.
7011 You will not be permitted to save your local layout until you have entered
7015 \begin_layout Standard
7016 The warnings at the end of the previous section apply here, too.
7017 Do not play with local layout while you are actually working, especially
7018 if you have not saved your document.
7019 That said, using local layout with a test document can be a very convenient
7020 way to try out layout ideas, or even to start developing a module.
7023 \begin_layout Subsection
7025 \begin_inset Flex Noun
7028 \begin_layout Plain Layout
7037 \begin_layout Standard
7038 There are two situations you are likely to encounter when wanting to support
7039 a new \SpecialChar LaTeX
7040 document class, involving style (
7041 \begin_inset Flex Code
7044 \begin_layout Plain Layout
7050 ) files and \SpecialChar LaTeX2e
7052 \begin_inset Flex Code
7055 \begin_layout Plain Layout
7062 Supporting a style file is usually fairly easy.
7063 Supporting a new class file is a bit harder.
7064 We'll discuss the former in this section and the latter in the next.
7065 Similar remarks apply, of course, if you want to support a new DocBook
7069 \begin_layout Standard
7070 The easier case is the one in which your new document class is provided
7071 as a style file that is to be used in conjunction with an already supported
7073 For the sake of the example, we'll assume that the style file is called
7075 \begin_inset Flex Noun
7078 \begin_layout Plain Layout
7084 and that it is meant to be used with
7085 \begin_inset Flex Noun
7088 \begin_layout Plain Layout
7094 , which is a standard class.
7098 \begin_layout Standard
7099 Start by copying the existing class's layout file into your local directory:
7103 \begin_layout Plain Layout
7104 Of course, which directory is your local directory will vary by platform,
7105 and \SpecialChar LyX
7106 allows you to specify your local directory on startup, too, using
7108 \begin_inset Flex Code
7111 \begin_layout Plain Layout
7125 \begin_layout LyX-Code
7126 cp report.layout ~/.lyx/layouts/myclass.layout
7129 \begin_layout Standard
7131 \begin_inset Flex Code
7134 \begin_layout Plain Layout
7140 and change the line:
7143 \begin_layout LyX-Code
7146 DeclareLaTeXClass{Report (Standard Class)}
7149 \begin_layout Standard
7153 \begin_layout LyX-Code
7156 DeclareLaTeXClass[report, myclass.sty]{Report (My Class)}
7159 \begin_layout Standard
7163 \begin_layout LyX-Code
7165 \begin_inset Newline newline
7171 \begin_inset Newline newline
7177 \begin_layout Standard
7178 near the top of the file.
7181 \begin_layout Standard
7182 Start \SpecialChar LyX
7184 \begin_inset Flex Noun
7187 \begin_layout Plain Layout
7188 Tools\SpecialChar menuseparator
7195 Then restart \SpecialChar LyX
7196 and try creating a new document.
7198 \begin_inset Flex Noun
7201 \begin_layout Plain Layout
7207 " as a document class option in the
7208 \begin_inset Flex Noun
7211 \begin_layout Plain Layout
7212 Document\SpecialChar menuseparator
7219 It is likely that some of the sectioning commands and such in your new
7220 class will work differently from how they worked in the base class—
7221 \begin_inset Flex Code
7224 \begin_layout Plain Layout
7230 in this example—so you can fiddle around with the settings for the different
7231 sections if you wish.
7232 The layout information for sections is contained in
7233 \begin_inset Flex Code
7236 \begin_layout Plain Layout
7242 , but you do not need to copy and change this file.
7243 Instead, you can simply add your changes to your layout file, after the
7245 \begin_inset Flex Code
7248 \begin_layout Plain Layout
7254 , which itself includes
7255 \begin_inset Flex Code
7258 \begin_layout Plain Layout
7265 For example, you might add these lines:
7268 \begin_layout LyX-Code
7272 \begin_layout LyX-Code
7276 \begin_layout LyX-Code
7280 \begin_layout LyX-Code
7284 \begin_layout LyX-Code
7288 \begin_layout Standard
7289 to change the font for chapter headings to sans-serif.
7290 This will override (or, in this case, add to) the existing declaration
7291 for the Chapter style.
7295 \begin_layout Standard
7296 Your new package may also provide commands or environments not present in
7298 In this case, you will want to add these to the layout file.
7300 \begin_inset CommandInset ref
7302 reference "sec:TextClass"
7306 for information on how to do so.
7309 \begin_layout Standard
7311 \begin_inset Flex Noun
7314 \begin_layout Plain Layout
7320 can be used with several different document classes, and even if it cannot,
7321 you might find it easiest just to write a module that you can load with
7323 The simplest possible such module would be:
7326 \begin_layout LyX-Code
7329 DeclareLyXModule{My Class}
7332 \begin_layout LyX-Code
7336 \begin_layout LyX-Code
7337 #Support for myclass.sty.
7340 \begin_layout LyX-Code
7342 \begin_inset Newline newline
7348 \begin_layout LyX-Code
7350 \begin_inset Newline newline
7356 \begin_layout LyX-Code
7358 \begin_inset Newline newline
7364 \begin_inset Newline newline
7370 \begin_layout Standard
7371 A more complex module might modify the behavior of some existing constructs
7372 or define some new ones.
7374 \begin_inset CommandInset ref
7376 reference "sec:TextClass"
7383 \begin_layout Subsection
7385 \begin_inset Flex Noun
7388 \begin_layout Plain Layout
7397 \begin_layout Standard
7398 There are two possibilities here.
7399 One is that the class file is itself based upon an existing document class.
7400 For example, many thesis classes are based upon
7401 \begin_inset Flex Noun
7404 \begin_layout Plain Layout
7411 To see whether yours is, look for a line like
7414 \begin_layout LyX-Code
7420 \begin_layout Standard
7422 If so, then you may proceed largely as in the previous section, though
7424 \begin_inset Flex Code
7427 \begin_layout Plain Layout
7428 Declare\SpecialChar LaTeX
7434 line will be different.
7435 If your new class is
7436 \begin_inset Flex Code
7439 \begin_layout Plain Layout
7445 and it is based upon
7446 \begin_inset Flex Code
7449 \begin_layout Plain Layout
7455 , then the line should read:
7459 \begin_layout Plain Layout
7460 And it will be easiest if you save the file to
7461 \begin_inset Flex Code
7464 \begin_layout Plain Layout
7471 assumes that the document class has the same name as the layout file.
7480 \begin_layout LyX-Code
7483 DeclareLaTeXClass[thesis,book]{thesis}
7486 \begin_layout Standard
7487 If, on the other hand, the new class is not based upon an existing class,
7488 you will probably have to
7489 \begin_inset Quotes eld
7493 \begin_inset Quotes erd
7497 We strongly suggest copying an existing layout file which uses a similar
7499 class and then modifying it, if you can do so.
7500 At least use an existing file as a starting point so you can find out what
7501 items you need to worry about.
7502 Again, the specifics are covered below.
7505 \begin_layout Subsection
7507 \begin_inset CommandInset label
7509 name "subsec:Creating-Templates"
7516 \begin_layout Standard
7517 Once you have written a layout file for a new document class, you might
7518 want to consider writing a
7523 A template acts as a kind of tutorial for your layout, showing how it might
7524 be used, though containing dummy content.
7525 You can of course look at the various templates included with \SpecialChar LyX
7529 \begin_layout Standard
7530 Templates are created just like usual documents: using \SpecialChar LyX
7532 The only difference is that usual documents contain all possible settings,
7533 including the font scheme and the paper size.
7534 Usually a user doesn't want a template to overwrite his preferred settings
7535 for such parameters.
7536 For that reason, the designer of a template should remove the corresponding
7538 \begin_inset Flex Code
7541 \begin_layout Plain Layout
7550 \begin_inset Flex Code
7553 \begin_layout Plain Layout
7561 from the template \SpecialChar LyX
7563 This can be done with any simple text-editor, for example
7564 \begin_inset Flex Code
7567 \begin_layout Plain Layout
7574 \begin_inset Flex Code
7577 \begin_layout Plain Layout
7586 \begin_layout Standard
7587 Put the edited template files you create in
7588 \begin_inset Flex Code
7591 \begin_layout Plain Layout
7597 , copy the ones you use from the global template directory in
7598 \begin_inset Flex Code
7601 \begin_layout Plain Layout
7607 to the same place, and redefine the template path in the
7608 \begin_inset Flex Noun
7611 \begin_layout Plain Layout
7612 Tools\SpecialChar menuseparator
7613 Preferences\SpecialChar menuseparator
7622 \begin_layout Standard
7623 Note, by the way, that there is a template which has a particular meaning:
7624 \begin_inset Newline linebreak
7628 \begin_inset Flex Code
7631 \begin_layout Plain Layout
7638 This template is loaded every time you create a new document with
7639 \begin_inset Flex Noun
7642 \begin_layout Plain Layout
7643 File\SpecialChar menuseparator
7649 in order to provide useful defaults.
7650 To create this template from inside \SpecialChar LyX
7651 , all you have to do is to open a document
7652 with the correct settings, and use the
7653 \begin_inset Flex Noun
7656 \begin_layout Plain Layout
7657 Save as Document Defaults
7665 \begin_layout Subsection
7666 Upgrading old layout files
7669 \begin_layout Standard
7670 The format of layout files changes with each \SpecialChar LyX
7671 release, so old layout files
7672 need to be converted to the new format.
7674 reads a layout file in an older format, it automatically calls the
7676 \begin_inset Flex Code
7679 \begin_layout Plain Layout
7685 to convert it to a temporary file in current format.
7686 The original file is left untouched.
7687 If you use the layout file often, then, you may want to convert it permanently,
7688 so that \SpecialChar LyX
7689 does not have to do so itself every time.
7690 To do this, you can call the converter manually:
7693 \begin_layout Enumerate
7695 \begin_inset Flex Code
7698 \begin_layout Plain Layout
7705 \begin_inset Flex Code
7708 \begin_layout Plain Layout
7717 \begin_layout Enumerate
7719 \begin_inset Newline newline
7723 \begin_inset Flex Code
7726 \begin_layout Plain Layout
7727 python LyXDir/scripts/layout2layout.py myclass.old myclass.layout
7733 \begin_inset Newline newline
7737 \begin_inset Flex Code
7740 \begin_layout Plain Layout
7746 is the name of your \SpecialChar LyX
7750 \begin_layout Standard
7751 Note that manual conversion does not affect included files, so these will
7752 have to be converted separately.
7755 \begin_layout Subsection
7756 \begin_inset CommandInset label
7758 name "subsec:Cite-Engine-Files"
7765 \begin_layout Standard
7766 A specific form of layout files are the so-called
7767 \begin_inset Flex Code
7770 \begin_layout Plain Layout
7776 files that are located in the
7777 \begin_inset Flex Code
7780 \begin_layout Plain Layout
7787 Their purpose is to define the specifics of \SpecialChar LaTeX
7788 packages aimed at bibliography
7801 , but also the way how normal Bib\SpecialChar TeX
7802 citations (without additional packages)
7803 are handled in \SpecialChar LyX
7804 is defined in such a file.
7808 \begin_layout Standard
7809 More specifically, it is defined which packages \SpecialChar LyX
7810 needs to load, which citation
7811 commands are available, how these are to be displayed in \SpecialChar LyX
7813 the dialogs, the context menus) as well as in the XHTML and plain text
7815 Furthermore, the files specify available style variants (author-year, numerical
7816 , etc.) and their specifics.
7817 The cite engine files are also used to generate the options that are available
7820 Document\SpecialChar menuseparator
7821 Settings\SpecialChar menuseparator
7822 Bibliography\SpecialChar menuseparator
7828 \begin_layout Standard
7829 Even though a cite engine file is essentially a normal layout file that
7830 could theoretically include any layout information, it usually primarily
7831 includes some specific parameters such as
7832 \begin_inset Flex Code
7835 \begin_layout Plain Layout
7842 \begin_inset Flex Code
7845 \begin_layout Plain Layout
7852 \begin_inset Flex Code
7855 \begin_layout Plain Layout
7862 \begin_inset Flex Code
7865 \begin_layout Plain Layout
7872 The syntax of the latter two is described in
7873 \begin_inset CommandInset ref
7875 reference "subsec:Citation-engine-description"
7883 \begin_inset CommandInset ref
7885 reference "subsec:Citation-format-description"
7889 , as well as in the files themselves.
7892 \begin_layout Section
7893 \begin_inset CommandInset label
7895 name "sec:TextClass"
7899 The layout file format
7902 \begin_layout Standard
7903 The following sections describe how layout files are structured and written.
7904 Our advice is to go slowly, save and test often.
7905 It is really not that hard, except that the multitude of options can become
7906 overwhelming, especially if you try to check out too many at once.
7907 It becomes easier if you use existing layouts of \SpecialChar LyX
7908 as examples/reference
7909 or if you modify an existing layout to your needs.
7912 \begin_layout Standard
7913 Note that all the tags used in layout files are case-insensitive.
7915 \begin_inset Flex Code
7918 \begin_layout Plain Layout
7925 \begin_inset Flex Code
7928 \begin_layout Plain Layout
7935 \begin_inset Flex Code
7938 \begin_layout Plain Layout
7944 are really the same tag.
7945 The possible arguments are printed in brackets after the tag's name.
7946 The default argument is typeset
7947 \begin_inset Flex Code
7950 \begin_layout Plain Layout
7959 If the argument has a data type like
7960 \begin_inset Quotes eld
7964 \begin_inset Quotes erd
7968 \begin_inset Quotes eld
7972 \begin_inset Quotes erd
7975 , the default is shown like this:
7976 \begin_inset Flex Code
7979 \begin_layout Plain Layout
7990 \begin_layout Subsection
7991 The document class declaration and classification
7994 \begin_layout Standard
7995 Lines in a layout file which begin with
7996 \begin_inset Flex Code
7999 \begin_layout Plain Layout
8006 There is one exception to this rule.
8008 \begin_inset Flex Code
8011 \begin_layout Plain Layout
8017 files should begin with lines like:
8020 \begin_layout LyX-Code
8023 #% Do not delete the line below; configure depends on this
8026 \begin_layout LyX-Code
8031 DeclareLaTeXClass{Article (Standard Class)}
8034 \begin_layout LyX-Code
8039 DeclareCategory{Articles}
8042 \begin_layout Standard
8043 The second and third lines are used when you (re)configure \SpecialChar LyX
8045 The layout file is read by the \SpecialChar LaTeX
8047 \begin_inset Flex Code
8050 \begin_layout Plain Layout
8056 , in a special mode where
8057 \begin_inset Flex Code
8060 \begin_layout Plain Layout
8067 The first line is just a \SpecialChar LaTeX
8068 comment, the second one contains the mandatory
8069 declaration of the text class and the third line contains the optional
8070 classification of the class.
8071 If these lines appear in a file named
8072 \begin_inset Flex Code
8075 \begin_layout Plain Layout
8081 , then they define a text class of name
8082 \begin_inset Flex Code
8085 \begin_layout Plain Layout
8091 (the name of the layout file) which uses the \SpecialChar LaTeX
8093 \begin_inset Flex Code
8096 \begin_layout Plain Layout
8102 (the default is to use the same name as the layout).
8104 \begin_inset Quotes eld
8107 Article (Standard Class)
8108 \begin_inset Quotes erd
8111 that appears above is used as a description of the text class in the
8112 \begin_inset Flex Noun
8115 \begin_layout Plain Layout
8116 Document\SpecialChar menuseparator
8124 \begin_inset Quotes eld
8128 \begin_inset Quotes erd
8131 in the example) is also used in the
8132 \begin_inset Flex Noun
8135 \begin_layout Plain Layout
8136 Document\SpecialChar menuseparator
8142 dialog: the text classes are grouped by these categories (which are usually
8143 genres, so typical categories are
8144 \begin_inset Quotes eld
8148 \begin_inset Quotes erd
8152 \begin_inset Quotes eld
8156 \begin_inset Quotes erd
8160 \begin_inset Quotes eld
8164 \begin_inset Quotes erd
8168 \begin_inset Quotes eld
8172 \begin_inset Quotes erd
8176 \begin_inset Quotes eld
8180 \begin_inset Quotes erd
8184 \begin_inset Quotes eld
8188 \begin_inset Quotes erd
8192 If no category has been declared, the class will be put in the
8193 \begin_inset Quotes eld
8197 \begin_inset Quotes erd
8203 \begin_layout Standard
8204 Let's assume that you wrote your own text class that uses the
8205 \begin_inset Flex Code
8208 \begin_layout Plain Layout
8214 document class, but where you changed the appearance of the section headings.
8215 If you put it in a file
8216 \begin_inset Flex Code
8219 \begin_layout Plain Layout
8225 , the header of this file should be:
8228 \begin_layout LyX-Code
8231 #% Do not delete the line below; configure depends on this
8234 \begin_layout LyX-Code
8239 DeclareLaTeXClass[article]{Article (with My Own Headings)}
8242 \begin_layout LyX-Code
8247 DeclareCategory{Articles}
8250 \begin_layout Standard
8251 This declares a text class
8252 \begin_inset Flex Code
8255 \begin_layout Plain Layout
8261 , associated with the \SpecialChar LaTeX
8263 \begin_inset Flex Code
8266 \begin_layout Plain Layout
8273 \begin_inset Quotes eld
8276 Article (with My Own Headings)
8277 \begin_inset Quotes erd
8281 If your text class depends on several packages, you can declare it as:
8284 \begin_layout LyX-Code
8287 #% Do not delete the line below; configure depends on this
8290 \begin_layout LyX-Code
8295 DeclareLaTeXClass[article,foo.sty]{Article (with My Own Headings)}
8298 \begin_layout LyX-Code
8303 DeclareCategory{Articles}
8306 \begin_layout Standard
8307 This indicates that your text class uses the
8308 \begin_inset Flex Code
8311 \begin_layout Plain Layout
8318 Finally, it is also possible to declare classes for DocBook code.
8319 Typical declarations will look like:
8322 \begin_layout LyX-Code
8325 #% Do not delete the line below; configure depends on this
8328 \begin_layout LyX-Code
8333 DeclareDocBookClass[article]{SGML (DocBook Article)}
8336 \begin_layout LyX-Code
8341 DeclareCategory{Articles (DocBook)}
8344 \begin_layout Standard
8345 Note that these declarations can also be given an optional parameter declaring
8346 the name of the document class (but not a list).
8349 \begin_layout Standard
8350 So, to be as explicit as possible, the form of the layout declaration is:
8353 \begin_layout LyX-Code
8358 DeclareLaTeXClass[class,package.sty]{layout description}
8361 \begin_layout LyX-Code
8366 DeclareCategory{category}
8369 \begin_layout Standard
8370 The class need only be specified if the name of the \SpecialChar LaTeX
8372 name of the layout file are different or if there are packages to load.
8373 If the name of the class file is not specified, then \SpecialChar LyX
8375 that it is the same as the name of the layout file.
8378 \begin_layout Standard
8379 When the text class has been modified to your taste, all you have to do
8380 is to copy it either to
8381 \begin_inset Flex Code
8384 \begin_layout Plain Layout
8391 \begin_inset Flex Code
8394 \begin_layout Plain Layout
8401 \begin_inset Flex Noun
8404 \begin_layout Plain Layout
8405 Tools\SpecialChar menuseparator
8411 , exit \SpecialChar LyX
8413 Then your new text class should be available along with the others.
8416 \begin_layout Standard
8417 Once the layout file is installed, you can edit it and see your changes
8418 without having to reconfigure or to restart \SpecialChar LyX
8423 \begin_layout Plain Layout
8424 In versions of \SpecialChar LyX
8425 prior to 1.6, this was not true.
8426 As a result, editing layout files was very time consuming, since you had
8427 constantly to restart \SpecialChar LyX
8433 You can force a reload of the current layout by using the \SpecialChar LyX
8435 \begin_inset Flex Noun
8438 \begin_layout Plain Layout
8445 There is no default binding for this function—though, of course, you can
8446 bind it to a key yourself.
8447 But you will normally use this function simply by entering it in the mini-buffe
8452 \begin_layout Standard
8458 \begin_inset Flex Noun
8461 \begin_layout Plain Layout
8467 is very much an `advanced feature'.
8472 recommended that you save your work before using this function.
8477 recommended that you not attempt to edit layout information while simultaneousl
8478 y working on a document that you care about.
8479 Use a test document.
8480 Syntax errors and the like in your layout file could cause peculiar behavior.
8481 In particular, such errors could cause \SpecialChar LyX
8482 to regard the current layout as
8483 invalid and to attempt to switch to some other layout.
8487 \begin_layout Plain Layout
8488 Really bad syntax errors may even caused \SpecialChar LyX
8490 This is because certain sorts of errors may make \SpecialChar LyX
8501 The \SpecialChar LyX
8502 team strives to keep \SpecialChar LyX
8503 stable in such situations, but safe is better
8508 \begin_layout Plain Layout
8509 While we're giving advice: make regular backups.
8510 And be nice to your mother.
8518 \begin_layout Subsection
8519 The Module declaration
8522 \begin_layout Standard
8523 A module must begin with a line like the following:
8526 \begin_layout LyX-Code
8529 DeclareLyXModule[endnotes.sty]{Endnotes}
8532 \begin_layout Standard
8533 The mandatory argument, in curly brackets, is the name of the module, as
8535 \begin_inset Flex Noun
8538 \begin_layout Plain Layout
8539 Document\SpecialChar menuseparator
8540 Settings\SpecialChar menuseparator
8547 The argument in square brackets is optional: It declares any \SpecialChar LaTeX
8549 on which the module depends.
8550 It is also possible to use the form
8551 \begin_inset Flex Noun
8554 \begin_layout Plain Layout
8560 as an optional argument, which declares that the module can only be used
8561 when there exists a conversion chain between the formats `
8562 \begin_inset Flex Code
8565 \begin_layout Plain Layout
8572 \begin_inset Flex Code
8575 \begin_layout Plain Layout
8584 \begin_layout Standard
8585 The module declaration should then be followed by lines like the following:
8589 \begin_layout Plain Layout
8590 Preferably in English if the module should be published with \SpecialChar LyX
8592 This description will appear in the list of messages to be translated and
8593 will be thus translated with the next interface update.
8601 \begin_layout LyX-Code
8605 \begin_layout LyX-Code
8606 #Adds an endnote command, in addition to footnotes.
8610 \begin_layout LyX-Code
8611 #You will need to add
8613 theendnotes in TeX code where you
8616 \begin_layout LyX-Code
8617 #want the endnotes to appear.
8621 \begin_layout LyX-Code
8625 \begin_layout LyX-Code
8626 #Requires: somemodule | othermodule
8629 \begin_layout LyX-Code
8630 #Excludes: badmodule
8633 \begin_layout Standard
8634 The description is used in
8635 \begin_inset Flex Noun
8638 \begin_layout Plain Layout
8639 Document\SpecialChar menuseparator
8640 Settings\SpecialChar menuseparator
8646 to provide the user with information about what the module does.
8648 \begin_inset Flex Code
8651 \begin_layout Plain Layout
8657 line is used to identify other modules with which this one must be used;
8659 \begin_inset Flex Code
8662 \begin_layout Plain Layout
8668 line is used to identify modules with which this one may not be used.
8669 Both are optional, and, as shown, multiple modules should be separated
8670 with the pipe symbol: |.
8671 Note that the required modules are treated disjunctively:
8675 of the required modules must be used.
8680 excluded module may be used.
8681 Note that modules are identified here by their filenames without the
8682 \begin_inset Flex Code
8685 \begin_layout Plain Layout
8693 \begin_inset Flex Code
8696 \begin_layout Plain Layout
8703 \begin_inset Flex Code
8706 \begin_layout Plain Layout
8715 \begin_layout Subsection
8716 The CiteEngine file declaration
8719 \begin_layout Standard
8720 A cite engine file must begin with a line like the following:
8723 \begin_layout LyX-Code
8726 DeclareLyXCiteEngineModule[biblatex.sty]{Biblatex}
8729 \begin_layout Standard
8730 The mandatory argument, in curly brackets, is the name of the cite style,
8731 as it should appear in
8732 \begin_inset Flex Noun
8735 \begin_layout Plain Layout
8736 Document\SpecialChar menuseparator
8737 Settings\SpecialChar menuseparator
8744 The argument in square brackets is optional: It declares any \SpecialChar LaTeX
8746 on which the cite engine depends.
8749 \begin_layout Standard
8750 The cite engine declaration should then be followed by lines like the following:
8754 \begin_layout Plain Layout
8755 Preferably in English if the module should be published with \SpecialChar LyX
8757 This description will appear in the list of messages to be translated and
8758 will be thus translated with the next interface update.
8766 \begin_layout LyX-Code
8770 \begin_layout LyX-Code
8771 # Biblatex supports many author-year and numerical styles.
8774 \begin_layout LyX-Code
8775 # It is mainly aimed at the Humanities.
8779 \begin_layout LyX-Code
8780 # customizable, fully localized and provides many features
8783 \begin_layout LyX-Code
8784 # that are not possible with BibTeX.
8785 The use of 'biber' as
8788 \begin_layout LyX-Code
8789 # bibliography processor is advised.
8792 \begin_layout LyX-Code
8796 \begin_layout Standard
8797 The description is used in
8798 \begin_inset Flex Noun
8801 \begin_layout Plain Layout
8802 Document\SpecialChar menuseparator
8803 Settings\SpecialChar menuseparator
8809 to provide the user with information about the cite engine.
8812 \begin_layout Subsection
8816 \begin_layout Standard
8817 The first non-comment line of any layout file, included file, or module
8822 contain the file format number:
8825 \begin_layout Description
8826 \begin_inset Flex Code
8829 \begin_layout Plain Layout
8836 \begin_inset Flex Code
8839 \begin_layout Plain Layout
8845 ] The format number of the layout file.
8848 \begin_layout Standard
8849 This tag was introduced with \SpecialChar LyX
8851 \begin_inset space ~
8855 Layout files from older \SpecialChar LyX
8856 versions do not have an explicit file format and
8857 are considered to have
8858 \begin_inset Flex Code
8861 \begin_layout Plain Layout
8863 \begin_inset space ~
8872 The format for the present version of \SpecialChar LyX
8874 But each version of \SpecialChar LyX
8875 is capable of reading earlier versions' layout files,
8876 just as they are capable of reading files produced by earlier versions
8879 There is, however, no provision for converting to earlier formats.
8882 \begin_layout Subsection
8883 \begin_inset CommandInset label
8885 name "subsec:General-text-class"
8889 General text class parameters
8892 \begin_layout Standard
8893 These are general parameters that govern the behavior of an entire document
8899 mean that they must appear in
8900 \begin_inset Flex Code
8903 \begin_layout Plain Layout
8909 files rather than in modules.
8910 A module can contain any layout tag.)
8913 \begin_layout Description
8914 \begin_inset Flex Code
8917 \begin_layout Plain Layout
8923 Adds information that will be output in the
8924 \begin_inset Flex Code
8927 \begin_layout Plain Layout
8933 block when the document is output to XHTML.
8934 Typically, this would be used to output CSS style information, but it can
8935 be used for anything that can appear in
8936 \begin_inset Flex Code
8939 \begin_layout Plain Layout
8947 \begin_inset Quotes eld
8951 \begin_inset Flex Code
8954 \begin_layout Plain Layout
8961 \begin_inset Quotes erd
8967 \begin_layout Description
8968 \begin_inset Flex Code
8971 \begin_layout Plain Layout
8977 Adds information to the document preamble.
8979 \begin_inset Newline newline
8983 \begin_inset Quotes eld
8987 \begin_inset Flex Code
8990 \begin_layout Plain Layout
8997 \begin_inset Quotes erd
9003 \begin_layout Description
9004 \begin_inset Flex Code
9007 \begin_layout Plain Layout
9013 Defines the possibilities for displaying citation references.
9015 \begin_inset CommandInset ref
9017 reference "subsec:Citation-engine-description"
9026 \begin_inset Quotes eld
9030 \begin_inset Flex Code
9033 \begin_layout Plain Layout
9040 \begin_inset Quotes erd
9044 Primarily used in cite engine files (see
9045 \begin_inset CommandInset ref
9047 reference "subsec:Cite-Engine-Files"
9057 \begin_layout Description
9058 \begin_inset Flex Code
9061 \begin_layout Plain Layout
9067 Defines formats for use in the display of bibliographic information.
9069 \begin_inset CommandInset ref
9071 reference "subsec:Citation-format-description"
9077 \begin_inset Quotes eld
9081 \begin_inset Flex Code
9084 \begin_layout Plain Layout
9091 \begin_inset Quotes erd
9095 Primarily used in cite engine files (see
9096 \begin_inset CommandInset ref
9098 reference "subsec:Cite-Engine-Files"
9108 \begin_layout Description
9109 \begin_inset Flex Code
9112 \begin_layout Plain Layout
9119 \begin_inset Flex Code
9122 \begin_layout Plain Layout
9131 \begin_inset Flex Code
9134 \begin_layout Plain Layout
9140 ] Determines whether
9144 or Bib\SpecialChar TeX
9145 is used to generate a Bibliography.
9146 Primarily used in cite engine files (see
9147 \begin_inset CommandInset ref
9149 reference "subsec:Cite-Engine-Files"
9159 \begin_layout Description
9160 \begin_inset Flex Code
9163 \begin_layout Plain Layout
9169 Describes various global options supported by the document class.
9171 \begin_inset CommandInset ref
9173 reference "subsec:ClassOptions"
9179 \begin_inset Quotes eld
9183 \begin_inset Flex Code
9186 \begin_layout Plain Layout
9193 \begin_inset Quotes erd
9199 \begin_layout Description
9200 \begin_inset Flex Code
9203 \begin_layout Plain Layout
9210 \begin_inset Flex Code
9213 \begin_layout Plain Layout
9222 \begin_inset space \thinspace{}
9226 \begin_inset Flex Code
9229 \begin_layout Plain Layout
9235 ] Whether the class should
9239 to having one or two columns.
9240 Can be changed in the
9241 \begin_inset Flex Noun
9244 \begin_layout Plain Layout
9245 Document\SpecialChar menuseparator
9254 \begin_layout Description
9255 \begin_inset Flex Code
9258 \begin_layout Plain Layout
9265 \begin_inset Flex Code
9268 \begin_layout Plain Layout
9274 ] This sequence defines the properties for a counter.
9275 If the counter does not yet exist, it is created; if it does exist, it
9278 \begin_inset Quotes eld
9282 \begin_inset Flex Code
9285 \begin_layout Plain Layout
9292 \begin_inset Quotes erd
9296 \begin_inset Newline newline
9300 \begin_inset CommandInset ref
9302 reference "subsec:Counters"
9306 for details on counters.
9309 \begin_layout Description
9310 \begin_inset Flex Code
9313 \begin_layout Plain Layout
9319 Sets the default font used to display the document.
9321 \begin_inset CommandInset ref
9323 reference "subsec:Font-description"
9327 for how to declare fonts.
9329 \begin_inset Quotes eld
9333 \begin_inset Flex Code
9336 \begin_layout Plain Layout
9343 \begin_inset Quotes erd
9349 \begin_layout Description
9350 \begin_inset Flex Code
9353 \begin_layout Plain Layout
9360 \begin_inset Flex Code
9363 \begin_layout Plain Layout
9369 ] Specifies a module to be included by default with this document class.
9370 The module is specified as filename without the
9371 \begin_inset Flex Code
9374 \begin_layout Plain Layout
9381 The user can still remove the module, but it will be active at the outset.
9382 (This applies only when new files are created, or when this class is chosen
9383 for an existing document.)
9386 \begin_layout Description
9387 \begin_inset Flex Code
9390 \begin_layout Plain Layout
9397 \begin_inset Flex Code
9400 \begin_layout Plain Layout
9406 ] This is the style that will be assigned to new paragraphs, usually
9407 \begin_inset Flex Noun
9410 \begin_layout Plain Layout
9417 This will default to the first defined style if not given, but you are
9418 encouraged to use this directive.
9421 \begin_layout Description
9422 \begin_inset Flex Code
9425 \begin_layout Plain Layout
9432 \begin_inset Flex Code
9435 \begin_layout Plain Layout
9441 ] This tag indicates that the module (which is specified by filename without
9443 \begin_inset Flex Code
9446 \begin_layout Plain Layout
9452 extension) cannot be used with this document class.
9453 This might be used in a journal-specific layout file to prevent, say, the
9455 \begin_inset Flex Code
9458 \begin_layout Plain Layout
9464 module that numbers theorems by section.
9469 be used in a module.
9470 Modules have their own way of excluding other modules (see
9471 \begin_inset CommandInset ref
9473 reference "subsec:Layout-modules"
9480 \begin_layout Description
9481 \begin_inset Flex Code
9484 \begin_layout Plain Layout
9490 Defines a new float.
9492 \begin_inset CommandInset ref
9494 reference "subsec:Floats"
9500 \begin_inset Quotes eld
9504 \begin_inset Flex Code
9507 \begin_layout Plain Layout
9514 \begin_inset Quotes erd
9520 \begin_layout Description
9521 \begin_inset Flex Code
9524 \begin_layout Plain Layout
9530 Sets the information that will be output in the
9531 \begin_inset Flex Code
9534 \begin_layout Plain Layout
9540 block when this document class is output to XHTML.
9541 Note that this will completely override any prior
9542 \begin_inset Flex Code
9545 \begin_layout Plain Layout
9552 \begin_inset Flex Code
9555 \begin_layout Plain Layout
9563 \begin_inset Newline newline
9567 \begin_inset Flex Code
9570 \begin_layout Plain Layout
9576 if you just want to add material to the preamble.) Must end with
9577 \begin_inset Quotes eld
9581 \begin_inset Flex Code
9584 \begin_layout Plain Layout
9591 \begin_inset Quotes erd
9597 \begin_layout Description
9598 \begin_inset Flex Code
9601 \begin_layout Plain Layout
9608 \begin_inset Flex Code
9611 \begin_layout Plain Layout
9617 ] The style to use for the table of contents, bibliography, and so forth,
9618 when the document is output to HTML.
9619 For articles, this should normally be
9620 \begin_inset Flex Code
9623 \begin_layout Plain Layout
9630 \begin_inset Flex Code
9633 \begin_layout Plain Layout
9640 If it is not given, then \SpecialChar LyX
9641 will attempt to figure out which layout to use.
9644 \begin_layout Description
9645 \begin_inset Flex Code
9648 \begin_layout Plain Layout
9655 \begin_inset Flex Code
9658 \begin_layout Plain Layout
9664 ] Modifies the properties of the given counter.
9665 If the counter does not exist, the statement is ignored.
9667 \begin_inset Quotes eld
9671 \begin_inset Flex Code
9674 \begin_layout Plain Layout
9681 \begin_inset Quotes erd
9685 \begin_inset Newline newline
9689 \begin_inset CommandInset ref
9691 reference "subsec:Counters"
9695 for details on counters.
9698 \begin_layout Description
9699 \begin_inset Flex Code
9702 \begin_layout Plain Layout
9709 \begin_inset Flex Code
9712 \begin_layout Plain Layout
9718 ] This allows you to include another layout definition file within yours
9719 to avoid duplicating commands.
9720 Common examples are the standard layout files, for example,
9721 \begin_inset Flex Code
9724 \begin_layout Plain Layout
9730 , which contains most of the basic layouts.
9733 \begin_layout Description
9734 \begin_inset Flex Code
9737 \begin_layout Plain Layout
9744 \begin_inset Flex Code
9747 \begin_layout Plain Layout
9753 ] This section (re-)defines the layout of an inset.
9754 It can be applied to an existing inset or to a new, user-defined inset,
9755 e.g., a new character style.
9757 \begin_inset Quotes eld
9761 \begin_inset Flex Code
9764 \begin_layout Plain Layout
9771 \begin_inset Quotes erd
9775 \begin_inset Newline newline
9779 \begin_inset CommandInset ref
9781 reference "subsec:Flex-insets-and"
9785 for more information.
9789 \begin_layout Description
9790 \begin_inset Flex Code
9793 \begin_layout Plain Layout
9800 \begin_inset Flex Code
9803 \begin_layout Plain Layout
9809 ] A string that indicates the width of the left margin on the screen, for
9811 \begin_inset Quotes eld
9815 \begin_inset Flex Code
9818 \begin_layout Plain Layout
9825 \begin_inset Quotes erd
9829 (Note that this is not a `length', like
9830 \begin_inset Quotes eld
9834 \begin_inset Quotes erd
9840 \begin_layout Description
9841 \begin_inset Flex Code
9844 \begin_layout Plain Layout
9851 \begin_inset Flex Code
9854 \begin_layout Plain Layout
9860 ] An integer that determines the maximal number of names displayed in an
9861 author-year citation before the citation switches to
9862 \begin_inset Quotes eld
9866 \begin_inset Quotes erd
9870 Primarily used in cite engine files (see
9871 \begin_inset CommandInset ref
9873 reference "subsec:Cite-Engine-Files"
9883 \begin_layout Description
9884 \begin_inset Flex Code
9887 \begin_layout Plain Layout
9894 \begin_inset Flex Code
9897 \begin_layout Plain Layout
9903 ] Modifies the properties of the given paragraph style.
9904 If the style does not exist, this section is ignored.
9906 \begin_inset Quotes eld
9910 \begin_inset Flex Code
9913 \begin_layout Plain Layout
9920 \begin_inset Quotes erd
9926 \begin_layout Description
9927 \begin_inset Flex Code
9930 \begin_layout Plain Layout
9937 \begin_inset Flex Code
9940 \begin_layout Plain Layout
9946 ] Deletes an existing counter, usually one defined in an included file.
9949 \begin_layout Description
9950 \begin_inset Flex Code
9953 \begin_layout Plain Layout
9960 \begin_inset Flex Code
9963 \begin_layout Plain Layout
9969 ] Deletes an existing float.
9970 This is particularly useful when you want to suppress a float that has
9971 been defined in an input file.
9974 \begin_layout Description
9975 \begin_inset Flex Code
9978 \begin_layout Plain Layout
9985 \begin_inset Flex Code
9988 \begin_layout Plain Layout
9994 ] Deletes an existing style.
9997 \begin_layout Description
9998 \begin_inset Flex Code
10001 \begin_layout Plain Layout
10008 \begin_inset Flex Code
10011 \begin_layout Plain Layout
10018 \begin_inset Flex Code
10021 \begin_layout Plain Layout
10027 ] Define a new table of contents with type
10028 \begin_inset Flex Code
10031 \begin_layout Plain Layout
10038 \begin_inset Flex Code
10041 \begin_layout Plain Layout
10048 See also the AddToToc commands.
10051 \begin_layout Description
10052 \begin_inset Flex Code
10055 \begin_layout Plain Layout
10062 \begin_inset Flex Code
10065 \begin_layout Plain Layout
10071 ] The file format (as defined in the \SpecialChar LyX
10072 preferences) produced by this document
10074 It is mainly useful when
10075 \begin_inset Flex Code
10078 \begin_layout Plain Layout
10085 \begin_inset Flex Code
10088 \begin_layout Plain Layout
10094 and one wants to define a new type of literate document.
10095 The format is reset to
10096 \begin_inset Quotes eld
10100 \begin_inset Flex Code
10103 \begin_layout Plain Layout
10110 \begin_inset Quotes erd
10114 \begin_inset Quotes eld
10118 \begin_inset Flex Code
10121 \begin_layout Plain Layout
10128 \begin_inset Quotes erd
10131 when the corresponding
10132 \begin_inset Flex Code
10135 \begin_layout Plain Layout
10141 parameter is encountered.
10144 \begin_layout Description
10145 \begin_inset Flex Code
10148 \begin_layout Plain Layout
10155 \begin_inset Flex Code
10158 \begin_layout Plain Layout
10169 \begin_inset Flex Code
10172 \begin_layout Plain Layout
10179 \begin_inset Flex Code
10182 \begin_layout Plain Layout
10188 ] Specifies what sort of output documents using this class will produce.
10191 \begin_layout Description
10192 \begin_inset Flex Code
10195 \begin_layout Plain Layout
10202 \begin_inset Flex Code
10205 \begin_layout Plain Layout
10212 \begin_inset Flex Code
10215 \begin_layout Plain Layout
10221 ] Specifies options, given in the second string, for the package named by
10224 \begin_inset Quotes eld
10228 \begin_inset Flex Code
10231 \begin_layout Plain Layout
10232 PackageOptions natbib square
10238 \begin_inset Quotes erd
10242 \begin_inset Flex Code
10245 \begin_layout Plain Layout
10251 to be loaded with the
10252 \begin_inset Flex Code
10255 \begin_layout Plain Layout
10262 (For \SpecialChar TeX
10263 perts, this causes \SpecialChar LyX
10265 \begin_inset Flex Code
10268 \begin_layout Plain Layout
10271 PassOptionsToPackage{natbib}{square}
10277 \begin_inset Flex Code
10280 \begin_layout Plain Layout
10289 \begin_layout Description
10290 \begin_inset Flex Code
10293 \begin_layout Plain Layout
10300 \begin_inset Flex Code
10303 \begin_layout Plain Layout
10312 \begin_inset Flex Code
10315 \begin_layout Plain Layout
10322 \begin_inset Flex Code
10325 \begin_layout Plain Layout
10331 ] The default pagestyle.
10332 Can be changed in the
10333 \begin_inset Flex Noun
10336 \begin_layout Plain Layout
10337 Document\SpecialChar menuseparator
10346 \begin_layout Description
10347 \begin_inset Flex Code
10350 \begin_layout Plain Layout
10356 Sets the preamble for the \SpecialChar LaTeX
10358 Note that this will completely override any prior
10359 \begin_inset Flex Code
10362 \begin_layout Plain Layout
10369 \begin_inset Flex Code
10372 \begin_layout Plain Layout
10380 \begin_inset Flex Code
10383 \begin_layout Plain Layout
10389 if you just want to add material to the preamble.) Must end with
10390 \begin_inset Quotes eld
10394 \begin_inset Flex Code
10397 \begin_layout Plain Layout
10404 \begin_inset Quotes erd
10410 \begin_layout Description
10411 \begin_inset Flex Code
10414 \begin_layout Plain Layout
10421 \begin_inset Flex Code
10424 \begin_layout Plain Layout
10431 \begin_inset Flex Code
10434 \begin_layout Plain Layout
10443 \begin_inset space \thinspace{}
10447 \begin_inset Flex Code
10450 \begin_layout Plain Layout
10456 ] Whether the class already provides the feature
10457 \begin_inset Flex Code
10460 \begin_layout Plain Layout
10467 A feature is in general the name of a package (e.
10468 \begin_inset space \thinspace{}
10472 \begin_inset space \space{}
10476 \begin_inset Flex Code
10479 \begin_layout Plain Layout
10486 \begin_inset Flex Code
10489 \begin_layout Plain Layout
10496 \begin_inset space \thinspace{}
10500 \begin_inset space \space{}
10504 \begin_inset Flex Code
10507 \begin_layout Plain Layout
10514 \begin_inset Flex Code
10517 \begin_layout Plain Layout
10525 \begin_inset CommandInset ref
10527 reference "chap:List-of-functions"
10531 for the list of features.
10534 \begin_layout Description
10535 \begin_inset Flex Code
10538 \begin_layout Plain Layout
10545 \begin_inset Flex Code
10548 \begin_layout Plain Layout
10554 ] Indicates that this layout provides the functionality of the module mentioned,
10555 which should be specified by the filename without the
10556 \begin_inset Flex Code
10559 \begin_layout Plain Layout
10566 This will typically be used if the layout includes the module directly,
10567 rather than using the
10568 \begin_inset Flex Code
10571 \begin_layout Plain Layout
10577 tag to indicate that it ought to be used.
10578 It could also be used in a module that provided an alternate implementation
10579 of the same functionality.
10582 \begin_layout Description
10583 \begin_inset Flex Code
10586 \begin_layout Plain Layout
10593 \begin_inset Flex Code
10596 \begin_layout Plain Layout
10602 ] Creates a new paragraph style if it does not already exist.
10603 If the style does exist, this section is ignored.
10605 \begin_inset Quotes eld
10609 \begin_inset Flex Code
10612 \begin_layout Plain Layout
10619 \begin_inset Quotes erd
10625 \begin_layout Description
10626 \begin_inset Flex Code
10629 \begin_layout Plain Layout
10636 \begin_inset Flex Code
10639 \begin_layout Plain Layout
10645 ] Whether the class requires the feature
10646 \begin_inset Flex Code
10649 \begin_layout Plain Layout
10656 Multiple features must be separated by commas.
10657 Note that you can only request supported features.
10659 \begin_inset CommandInset ref
10661 reference "chap:List-of-functions"
10665 for the list of features.).
10666 If you require a package with specific options, you can additionally use
10668 \begin_inset Flex Code
10671 \begin_layout Plain Layout
10680 \begin_layout Description
10681 \begin_inset Flex Code
10684 \begin_layout Plain Layout
10691 \begin_inset Flex Code
10694 \begin_layout Plain Layout
10700 ] A string that indicates the width of the right margin on the screen, for
10702 \begin_inset Quotes eld
10706 \begin_inset Flex Code
10709 \begin_layout Plain Layout
10716 \begin_inset Quotes erd
10722 \begin_layout Description
10723 \begin_inset Flex Code
10726 \begin_layout Plain Layout
10733 \begin_inset Flex Code
10736 \begin_layout Plain Layout
10742 ] Sets which divisions get numbered.
10744 \begin_inset Newline newline
10748 \begin_inset Flex Code
10751 \begin_layout Plain Layout
10757 counter in \SpecialChar LaTeX
10761 \begin_layout Description
10762 \begin_inset Flex Code
10765 \begin_layout Plain Layout
10772 \begin_inset Flex Code
10775 \begin_layout Plain Layout
10784 \begin_inset space \thinspace{}
10788 \begin_inset Flex Code
10791 \begin_layout Plain Layout
10797 ] Whether the class-default should be printing on one or both sides of the
10799 Can be changed in the
10800 \begin_inset Flex Noun
10803 \begin_layout Plain Layout
10804 Document\SpecialChar menuseparator
10813 \begin_layout Description
10814 \begin_inset Flex Code
10817 \begin_layout Plain Layout
10824 \begin_inset Flex Code
10827 \begin_layout Plain Layout
10833 ] This sequence defines a paragraph style.
10834 If the style does not yet exist, it is created; if it does exist, its parameter
10837 \begin_inset Quotes eld
10841 \begin_inset Flex Code
10844 \begin_layout Plain Layout
10851 \begin_inset Quotes erd
10855 \begin_inset Newline newline
10859 \begin_inset CommandInset ref
10861 reference "subsec:Paragraph-Styles"
10865 for details on paragraph styles.
10868 \begin_layout Description
10869 \begin_inset Flex Code
10872 \begin_layout Plain Layout
10879 \begin_inset Flex Code
10882 \begin_layout Plain Layout
10888 ] The name of the command or environment to be used with
10889 \begin_inset Flex Code
10892 \begin_layout Plain Layout
10901 \begin_layout Description
10902 \begin_inset Flex Code
10905 \begin_layout Plain Layout
10912 \begin_inset Flex Code
10915 \begin_layout Plain Layout
10924 \begin_inset Flex Code
10927 \begin_layout Plain Layout
10933 ] Indicates what kind of markup is used to define the title of a document.
10935 \begin_inset Flex Code
10938 \begin_layout Plain Layout
10944 means that the macro with name
10945 \begin_inset Flex Code
10948 \begin_layout Plain Layout
10954 will be inserted after the last layout which has
10955 \begin_inset Quotes eld
10959 \begin_inset Flex Code
10962 \begin_layout Plain Layout
10964 \begin_inset space ~
10973 \begin_inset Quotes erd
10978 \begin_inset Flex Code
10981 \begin_layout Plain Layout
10987 corresponds to the case where all layouts which have
10988 \begin_inset Quotes eld
10992 \begin_inset Flex Code
10995 \begin_layout Plain Layout
10997 \begin_inset space ~
11006 \begin_inset Quotes erd
11009 should be enclosed into the
11010 \begin_inset Flex Code
11013 \begin_layout Plain Layout
11022 \begin_layout Description
11023 \begin_inset Flex Code
11026 \begin_layout Plain Layout
11033 \begin_inset Flex Code
11036 \begin_layout Plain Layout
11042 ] Sets which divisions are included in the table of contents.
11044 \begin_inset Flex Code
11047 \begin_layout Plain Layout
11053 counter in \SpecialChar LaTeX
11057 \begin_layout Subsection
11058 \begin_inset Flex Code
11061 \begin_layout Plain Layout
11068 \begin_inset CommandInset label
11070 name "subsec:ClassOptions"
11077 \begin_layout Standard
11079 \begin_inset Flex Code
11082 \begin_layout Plain Layout
11088 section can contain the following entries:
11091 \begin_layout Description
11092 \begin_inset Flex Code
11095 \begin_layout Plain Layout
11102 \begin_inset Flex Code
11105 \begin_layout Plain Layout
11111 ] The list of available font sizes for the document's main font, separated
11113 \begin_inset Quotes eld
11117 \begin_inset Flex Code
11120 \begin_layout Plain Layout
11127 \begin_inset Quotes erd
11133 \begin_layout Description
11134 \begin_inset Flex Code
11137 \begin_layout Plain Layout
11143 Used to set the DTD line with XML-based output classes.
11145 \begin_inset space \thinspace{}
11149 \begin_inset Quotes eld
11152 -//OASIS//DTD DocBook V4.2//EN
11153 \begin_inset Quotes erd
11159 \begin_layout Description
11160 \begin_inset Flex Code
11163 \begin_layout Plain Layout
11170 \begin_inset Flex Code
11173 \begin_layout Plain Layout
11174 string="empty|plain|headings|fancy"
11179 ] The list of available page sty\SpecialChar softhyphen
11181 \begin_inset Quotes eld
11185 \begin_inset Flex Code
11188 \begin_layout Plain Layout
11195 \begin_inset Quotes erd
11201 \begin_layout Description
11202 \begin_inset Flex Code
11205 \begin_layout Plain Layout
11212 \begin_inset Flex Code
11215 \begin_layout Plain Layout
11221 ] Some document class options, separated by a comma, that will be added
11222 to the optional part of the
11223 \begin_inset Flex Code
11226 \begin_layout Plain Layout
11237 \begin_layout Standard
11239 \begin_inset Flex Code
11242 \begin_layout Plain Layout
11248 section must end with
11249 \begin_inset Quotes eld
11253 \begin_inset Flex Code
11256 \begin_layout Plain Layout
11263 \begin_inset Quotes erd
11269 \begin_layout Subsection
11271 \begin_inset CommandInset label
11273 name "subsec:Paragraph-Styles"
11280 \begin_layout Standard
11281 A paragraph style description looks like this:
11285 \begin_layout Plain Layout
11286 Note that this will either define a new style or modify an existing one.
11294 \begin_layout LyX-Code
11301 \begin_layout LyX-Code
11305 \begin_layout LyX-Code
11309 \begin_layout Standard
11310 where the following commands are allowed:
11313 \begin_layout Description
11314 \begin_inset Flex Code
11317 \begin_layout Plain Layout
11324 \begin_inset Flex Code
11327 \begin_layout Plain Layout
11333 =""] This paragraph will appear in the table of contents of the given type.
11334 An empty string disables.
11335 See also the OutlinerName and the IsTocCaption commands.
11339 \begin_layout Description
11340 \begin_inset Flex Code
11343 \begin_layout Plain Layout
11350 \begin_inset Flex Code
11353 \begin_layout Plain Layout
11358 , left, right, center
11363 ] Paragraph alignment.
11366 \begin_layout Description
11367 \begin_inset Flex Code
11370 \begin_layout Plain Layout
11377 \begin_inset Flex Code
11380 \begin_layout Plain Layout
11385 , left, right, center
11390 ] A comma separated list of permitted alignments.
11391 (Some \SpecialChar LaTeX
11392 styles prohibit certain alignments, since those wouldn't make sense.
11393 For example a right-aligned or centered enumeration isn't possible.)
11396 \begin_layout Description
11397 \begin_inset Flex Code
11400 \begin_layout Plain Layout
11407 \begin_inset Flex Code
11410 \begin_layout Plain Layout
11416 ] Defines argument number <int> of a command\SpecialChar breakableslash
11417 environment associated with
11419 This is useful for things like section headings, and only makes sense with
11422 Every (optional or required) argument of a command or environment – except
11423 for the required argument that is associated with the content of the paragraph
11424 itself – has a separate definition, where the number specifies the order
11426 The definition must end with
11427 \begin_inset Flex Code
11430 \begin_layout Plain Layout
11437 So a command with two optional arguments has:
11441 \begin_layout Quote
11447 \begin_layout Quote
11453 \begin_layout Quote
11459 \begin_layout Quote
11465 \begin_layout Quote
11471 \begin_layout Quote
11477 \begin_layout Standard
11479 \begin_inset Flex Code
11482 \begin_layout Plain Layout
11488 definition, the following specifications are possible:
11491 \begin_layout Itemize
11492 \begin_inset Flex Code
11495 \begin_layout Plain Layout
11502 \begin_inset Flex Code
11505 \begin_layout Plain Layout
11511 The string that will appear both in the menu (to insert this argument)
11512 and on the argument inset button (unless you also specify a separate
11513 \begin_inset Flex Code
11516 \begin_layout Plain Layout
11523 For the menu, you can define an accelerator by appending the respective
11524 character to the string, divided by
11525 \begin_inset Quotes eld
11529 \begin_inset Quotes erd
11533 \begin_inset space \thinspace{}
11537 \begin_inset space \space{}
11541 \begin_inset Quotes eld
11545 \begin_inset Flex Code
11548 \begin_layout Plain Layout
11555 \begin_inset Quotes erd
11561 \begin_layout Itemize
11562 \begin_inset Flex Code
11565 \begin_layout Plain Layout
11572 \begin_inset Flex Code
11575 \begin_layout Plain Layout
11581 A separate string for the menu.
11582 You can define an accelerator by appending the respective character to
11583 the string, divided by
11584 \begin_inset Quotes eld
11588 \begin_inset Quotes erd
11592 \begin_inset space \thinspace{}
11596 \begin_inset space \space{}
11600 \begin_inset Quotes eld
11604 \begin_inset Flex Code
11607 \begin_layout Plain Layout
11614 \begin_inset Quotes erd
11618 This specification is optional.
11619 If it is not given the
11620 \begin_inset Flex Code
11623 \begin_layout Plain Layout
11629 will be used instead for the menu.
11632 \begin_layout Itemize
11633 \begin_inset Flex Code
11636 \begin_layout Plain Layout
11643 \begin_inset Flex Code
11646 \begin_layout Plain Layout
11652 A longer explanatory text that appears in the tooltip when hovering over
11653 the argument inset.
11656 \begin_layout Itemize
11657 \begin_inset Flex Code
11660 \begin_layout Plain Layout
11667 \begin_inset Flex Code
11670 \begin_layout Plain Layout
11679 \begin_inset space \thinspace{}
11683 \begin_inset Flex Code
11686 \begin_layout Plain Layout
11692 ] Declare if this is a mandatory (1) or an optional (0) argument.
11693 Mandatory arguments will be output empty if not given, while optional arguments
11694 will not be output at all.
11695 By default, mandatory arguments are delimited by
11696 \begin_inset Flex Code
11699 \begin_layout Plain Layout
11705 , while optional arguments are delimited by
11706 \begin_inset Flex Code
11709 \begin_layout Plain Layout
11718 \begin_layout Itemize
11719 \begin_inset Flex Code
11722 \begin_layout Plain Layout
11729 \begin_inset Flex Code
11732 \begin_layout Plain Layout
11738 defines another argument (by its number) which this argument requires to
11739 be output if it is itself output.
11741 \begin_inset space \thinspace{}
11744 g., in \SpecialChar LaTeX
11745 commands, optional arguments often require previous optional arguments
11746 to be output (at least empty), as in
11747 \begin_inset Flex Code
11750 \begin_layout Plain Layout
11753 command[][argument]{text}
11759 This can be achieved by the statement
11760 \begin_inset Flex Code
11763 \begin_layout Plain Layout
11770 \begin_inset Flex Code
11773 \begin_layout Plain Layout
11782 \begin_layout Itemize
11783 \begin_inset Flex Code
11786 \begin_layout Plain Layout
11793 \begin_inset Flex Code
11796 \begin_layout Plain Layout
11802 defines a custom left delimiter (instead of
11803 \begin_inset Flex Code
11806 \begin_layout Plain Layout
11813 \begin_inset Flex Code
11816 \begin_layout Plain Layout
11823 A line break in the output can be indicated by
11824 \begin_inset Flex Code
11827 \begin_layout Plain Layout
11836 \begin_layout Itemize
11837 \begin_inset Flex Code
11840 \begin_layout Plain Layout
11847 \begin_inset Flex Code
11850 \begin_layout Plain Layout
11856 defines a custom right delimiter (instead of
11857 \begin_inset Flex Code
11860 \begin_layout Plain Layout
11867 \begin_inset Flex Code
11870 \begin_layout Plain Layout
11877 A line break in the output can be indicated by
11878 \begin_inset Flex Code
11881 \begin_layout Plain Layout
11890 \begin_layout Itemize
11891 \begin_inset Flex Code
11894 \begin_layout Plain Layout
11901 \begin_inset Flex Code
11904 \begin_layout Plain Layout
11910 defines an argument that is inserted if and only if no user-specified arguments
11912 \begin_inset space \thinspace{}
11916 \begin_inset space \space{}
11919 if no argument inset has been inserted (note that also an empty argument
11920 inset omits the DefaultArg).
11921 Multiple arguments need to be separated by comma.
11924 \begin_layout Itemize
11925 \begin_inset Flex Code
11928 \begin_layout Plain Layout
11935 \begin_inset Flex Code
11938 \begin_layout Plain Layout
11944 defines an argument that is inserted in any case (alone or in addition
11945 to user-specified arguments).
11946 Multiple arguments need to be separated by comma.
11949 \begin_layout Itemize
11950 \begin_inset Flex Code
11953 \begin_layout Plain Layout
11959 The font used for the argument content, see
11960 \begin_inset CommandInset ref
11962 reference "subsec:Font-description"
11969 \begin_layout Itemize
11970 \begin_inset Flex Code
11973 \begin_layout Plain Layout
11979 The font used for the label; see
11980 \begin_inset CommandInset ref
11982 reference "subsec:Font-description"
11989 \begin_layout Itemize
11990 \begin_inset Flex Code
11993 \begin_layout Plain Layout
12000 \begin_inset Flex Code
12003 \begin_layout Plain Layout
12008 , Minimalistic, Conglomerate
12013 ] describes the rendering style used for the inset's frame and buttons.
12016 \begin_layout Itemize
12017 \begin_inset Flex Code
12020 \begin_layout Plain Layout
12027 \begin_inset Flex Code
12030 \begin_layout Plain Layout
12037 \begin_inset Flex Code
12040 \begin_layout Plain Layout
12046 , this argument is automatically inserted when the respective style is selected.
12047 Currently, only one argument per style\SpecialChar breakableslash
12048 layout can be automatically inserted.
12051 \begin_layout Itemize
12052 \begin_inset Flex Code
12055 \begin_layout Plain Layout
12062 \begin_inset Flex Code
12065 \begin_layout Plain Layout
12072 \begin_inset Flex Code
12075 \begin_layout Plain Layout
12081 , this argument will be inserted with a copy of the co-text (either selected
12082 text or the whole paragraph) as content.
12085 \begin_layout Itemize
12086 \begin_inset Flex Code
12089 \begin_layout Plain Layout
12096 \begin_inset Flex Code
12099 \begin_layout Plain Layout
12109 ] Whether the contents of this argument should be output in raw form, meaning
12110 without special translations that \SpecialChar LaTeX
12113 \begin_inset Flex Code
12116 \begin_layout Plain Layout
12122 status is inherited by the inset or paragraph layout the argument belongs
12123 to, true and false change the status for the given argument only.
12126 \begin_layout Itemize
12127 \begin_inset Flex Code
12130 \begin_layout Plain Layout
12137 \begin_inset Flex Code
12140 \begin_layout Plain Layout
12141 string of characters
12150 Defines individual characters
12151 \begin_inset Newline linebreak
12154 that should be output in raw form, meaning without special translations
12155 that \SpecialChar LaTeX
12157 Note that, contrary to PassThru, this needs to be explicitly defined for
12159 That is, arguments do not inherit PassThruChars from their parent inset
12163 \begin_layout Itemize
12164 \begin_inset Flex Code
12167 \begin_layout Plain Layout
12174 \begin_inset Flex Code
12177 \begin_layout Plain Layout
12186 \begin_inset space \thinspace{}
12190 \begin_inset Flex Code
12193 \begin_layout Plain Layout
12199 ] If this is set to 1, the argument will output its content in the corresponding
12200 item in the table of contents.
12204 \begin_layout Standard
12205 By default, the text entered in the \SpecialChar LyX
12206 workarea in the respective layout is
12207 the last (mandatory) argument of a command if the
12208 \begin_inset Flex Code
12211 \begin_layout Plain Layout
12218 \begin_inset Flex Code
12221 \begin_layout Plain Layout
12228 However, arguments with the prefix
12229 \begin_inset Flex Code
12232 \begin_layout Plain Layout
12238 are output after this workarea argument.
12239 Note that post-argument numbering restarts at 1, so the first argument
12240 following the workarea argument is
12241 \begin_inset Flex Code
12244 \begin_layout Plain Layout
12251 Post-arguments are ignored in any other
12252 \begin_inset Flex Code
12255 \begin_layout Plain Layout
12262 \begin_inset Flex Code
12265 \begin_layout Plain Layout
12274 \begin_layout Standard
12276 \begin_inset Flex Code
12279 \begin_layout Plain Layout
12288 \begin_inset Flex Code
12291 \begin_layout Plain Layout
12300 \begin_inset Flex Code
12303 \begin_layout Plain Layout
12309 followed by the number (e.
12310 \begin_inset space \thinspace{}
12314 \begin_inset space \space{}
12318 \begin_inset Flex Code
12321 \begin_layout Plain Layout
12331 \begin_layout Description
12332 \begin_inset Flex Code
12335 \begin_layout Plain Layout
12341 Includes a comma-separated list of layouts that should be nested in and
12342 after the current layout.
12343 Only makes sense for nestable layouts (such as environments).
12345 \begin_inset Quotes eld
12349 \begin_inset Flex Code
12352 \begin_layout Plain Layout
12359 \begin_inset Quotes erd
12364 \begin_inset Flex Code
12367 \begin_layout Plain Layout
12376 \begin_layout Description
12377 \begin_inset Flex Code
12380 \begin_layout Plain Layout
12386 Note that this will completely override any prior
12387 \begin_inset Flex Code
12390 \begin_layout Plain Layout
12396 declaration for this style.
12398 \begin_inset Quotes eld
12402 \begin_inset Flex Code
12405 \begin_layout Plain Layout
12412 \begin_inset Quotes erd
12417 \begin_inset CommandInset ref
12419 reference "subsec:I18n"
12423 for details on its use.
12426 \begin_layout Description
12427 \begin_inset Flex Code
12430 \begin_layout Plain Layout
12437 \begin_inset Flex Code
12440 \begin_layout Plain Layout
12450 \begin_layout Plain Layout
12451 Note that a `float' here is a real number, such as: 1.5.
12456 The vertical space with which the last of a chain of paragraphs with this
12457 style is separated from the following paragraph.
12458 If the next paragraph has another style, the separations are not simply
12459 added, but the maximum is taken.
12462 \begin_layout Description
12463 \begin_inset Flex Code
12466 \begin_layout Plain Layout
12473 \begin_inset Flex Code
12476 \begin_layout Plain Layout
12482 ] The category for this style.
12483 This is used to group related styles in the style combobox on the toolbar.
12484 Any string can be used, but you may want to use existing categories with
12489 \begin_layout Description
12490 \begin_inset Flex Code
12493 \begin_layout Plain Layout
12499 Depth of XML command.
12500 Used only with XML-type formats.
12503 \begin_layout Description
12504 \begin_inset Flex Code
12507 \begin_layout Plain Layout
12514 \begin_inset Flex Code
12517 \begin_layout Plain Layout
12523 ] Copies all the features of an existing style into the current one.
12527 \begin_layout Description
12528 \begin_inset Flex Code
12531 \begin_layout Plain Layout
12538 \begin_inset Flex Code
12541 \begin_layout Plain Layout
12547 ] The name of a style whose preamble should be output
12552 This allows to ensure some ordering of the preamble snippets when macros
12553 definitions depend on one another.
12557 \begin_layout Plain Layout
12558 Note that, besides that functionality, there is no way to ensure any ordering
12560 The ordering that you see in a given version of \SpecialChar LyX
12561 may change without warning
12570 \begin_layout Description
12571 \begin_inset Flex Code
12574 \begin_layout Plain Layout
12581 \begin_inset Flex Code
12584 \begin_layout Plain Layout
12589 , Box, Filled_Box, Static
12594 ] The type of label that stands at the end of the paragraph (or sequence
12596 \begin_inset Flex Code
12599 \begin_layout Plain Layout
12606 \begin_inset Newline newline
12610 \begin_inset Flex Code
12613 \begin_layout Plain Layout
12620 \begin_inset Flex Code
12623 \begin_layout Plain Layout
12630 \begin_inset Flex Code
12633 \begin_layout Plain Layout
12641 \begin_inset Flex Code
12644 \begin_layout Plain Layout
12651 \begin_inset Quotes eld
12655 \begin_inset Quotes erd
12659 \begin_inset Flex Code
12662 \begin_layout Plain Layout
12669 \begin_inset space \space{}
12673 \begin_inset Flex Code
12676 \begin_layout Plain Layout
12682 ) is a white (resp.
12683 \begin_inset space ~
12686 black) square suitable for end of proof markers,
12687 \begin_inset Flex Code
12690 \begin_layout Plain Layout
12696 is an explicit text string.
12699 \begin_layout Description
12700 \begin_inset Flex Code
12703 \begin_layout Plain Layout
12710 \begin_inset Flex Code
12713 \begin_layout Plain Layout
12719 ] The string used for a label with a
12720 \begin_inset Flex Code
12723 \begin_layout Plain Layout
12730 \begin_inset Newline newline
12734 \begin_inset Flex Code
12737 \begin_layout Plain Layout
12747 \begin_layout Description
12748 \begin_inset Flex Code
12751 \begin_layout Plain Layout
12757 The font used for both the text body
12763 \begin_inset CommandInset ref
12765 reference "subsec:Font-description"
12770 Note that defining this font automatically defines the
12771 \begin_inset Flex Code
12774 \begin_layout Plain Layout
12781 So you should define this one first if you also want to define
12782 \begin_inset Flex Code
12785 \begin_layout Plain Layout
12794 \begin_layout Description
12795 \begin_inset Flex Code
12798 \begin_layout Plain Layout
12805 \begin_inset Flex Code
12808 \begin_layout Plain Layout
12814 ] Used for backporting new styles to stable \SpecialChar LyX
12816 The first stable version that supports this tag is \SpecialChar LyX
12818 The argument is a number which may either be 0, -1 or any value greater
12821 \begin_inset Flex Code
12824 \begin_layout Plain Layout
12830 flag of a style is greater than zero, it will always be written to the
12832 If a .lyx file is read, the style definitions from the document header are
12833 added to the document class.
12834 Therefore even older \SpecialChar LyX
12835 versions can handle the style.
12837 \begin_inset Flex Code
12840 \begin_layout Plain Layout
12846 is a version number: if the style is read, and the version number is less
12847 than the version number of the already existing style in the document class,
12848 the new style is ignored.
12849 If the version number is greater, the new style replaces the existing style.
12850 A value of -1 means an infinite version number, i.
12851 \begin_inset space \thinspace{}
12855 \begin_inset space \space{}
12858 the style is always used.
12861 \begin_layout Description
12862 \begin_inset Flex Code
12865 \begin_layout Plain Layout
12872 \begin_inset Flex Code
12875 \begin_layout Plain Layout
12884 \begin_inset space \thinspace{}
12888 \begin_inset Flex Code
12891 \begin_layout Plain Layout
12897 ] Usually \SpecialChar LyX
12898 does not allow you to insert more than one space between words,
12899 since a space is considered as the separation between two words, not a
12900 character or symbol of its own.
12901 This is a very fine thing but sometimes annoying, for example, when typing
12902 program code or plain \SpecialChar LaTeX
12905 \begin_inset Flex Code
12908 \begin_layout Plain Layout
12915 Note that \SpecialChar LyX
12916 will create protected blanks for the additional blanks when
12917 in another mode than \SpecialChar LaTeX
12921 \begin_layout Description
12922 \begin_inset Flex Code
12925 \begin_layout Plain Layout
12931 These tags are used with XHTML output.
12933 \begin_inset CommandInset ref
12935 reference "subsec:Paragraph-Style-XHTML"
12942 \begin_layout Description
12943 \begin_inset Flex Code
12946 \begin_layout Plain Layout
12952 [FIXME] (Used only with XML-type formats.)
12955 \begin_layout Description
12956 \begin_inset Flex Code
12959 \begin_layout Plain Layout
12966 \begin_inset Flex Code
12969 \begin_layout Plain Layout
12978 \begin_inset space \thinspace{}
12982 \begin_inset Flex Code
12985 \begin_layout Plain Layout
12992 \begin_inset Flex Code
12995 \begin_layout Plain Layout
13001 , marks the style as to be included in the document preamble and not in
13003 This is useful for document classes that want such information as the title
13004 and author to appear in the preamble.
13005 Note that this works only for styles for which the
13006 \begin_inset Flex Code
13009 \begin_layout Plain Layout
13016 \begin_inset Flex Code
13019 \begin_layout Plain Layout
13026 \begin_inset Flex Code
13029 \begin_layout Plain Layout
13038 \begin_layout Description
13039 \begin_inset Flex Code
13042 \begin_layout Plain Layout
13049 \begin_inset Flex Code
13052 \begin_layout Plain Layout
13061 \begin_inset space \thinspace{}
13065 \begin_inset Flex Code
13068 \begin_layout Plain Layout
13075 \begin_inset Flex Code
13078 \begin_layout Plain Layout
13084 , marks the style as being part of a title block (see also the
13085 \begin_inset Flex Code
13088 \begin_layout Plain Layout
13095 \begin_inset Flex Code
13098 \begin_layout Plain Layout
13107 \begin_layout Description
13108 \begin_inset Flex Code
13111 \begin_layout Plain Layout
13117 Includes a comma-separated list of layouts after which this one should
13119 Only makes sense with regard to nestable layouts (such as environments).
13121 \begin_inset Quotes eld
13125 \begin_inset Flex Code
13128 \begin_layout Plain Layout
13135 \begin_inset Quotes erd
13140 \begin_inset Flex Code
13143 \begin_layout Plain Layout
13152 \begin_layout Description
13153 \begin_inset Flex Code
13156 \begin_layout Plain Layout
13163 \begin_inset Flex Code
13166 \begin_layout Plain Layout
13175 \begin_inset space \thinspace{}
13179 \begin_inset Flex Code
13182 \begin_layout Plain Layout
13188 ] If this is set to 1 and AddToToc is enabled, the paragraph adds a summary
13189 of its contents in its item in the table of contents.
13190 Otherwise, only the label, if it exists, appears.
13193 \begin_layout Description
13194 \begin_inset Flex Code
13197 \begin_layout Plain Layout
13204 \begin_inset Flex Code
13207 \begin_layout Plain Layout
13213 ] The \SpecialChar LaTeX
13214 command sequence declaring an item in a list.
13215 The command is to be defined without the preceding backslash (the default
13217 \begin_inset Quotes eld
13221 \begin_inset Quotes erd
13225 \begin_inset Flex Code
13228 \begin_layout Plain Layout
13236 in the \SpecialChar LaTeX
13240 \begin_layout Description
13241 \begin_inset Flex Code
13244 \begin_layout Plain Layout
13251 \begin_inset Flex Code
13254 \begin_layout Plain Layout
13260 ] This provides extra space between paragraphs that have the same style.
13261 If you put other styles into an environment, each is separated with the
13263 \begin_inset Flex Code
13266 \begin_layout Plain Layout
13273 But the whole items of the environment are additionally separated with
13275 \begin_inset Flex Code
13278 \begin_layout Plain Layout
13285 Note that this is a
13290 \begin_layout Description
13291 \begin_inset Flex Code
13294 \begin_layout Plain Layout
13300 [FIXME] (Used only with XML-type formats.)
13303 \begin_layout Description
13304 \begin_inset Flex Code
13307 \begin_layout Plain Layout
13314 \begin_inset Flex Code
13317 \begin_layout Plain Layout
13326 \begin_inset space \thinspace{}
13330 \begin_inset Flex Code
13333 \begin_layout Plain Layout
13339 ] Usually \SpecialChar LyX
13340 does not allow you to leave a paragraph empty, since it would
13341 lead to empty \SpecialChar LaTeX
13343 There are some cases where this could be desirable however: in a letter
13344 template, the required fields can be provided as empty fields, so that
13345 people do not forget them; in some special classes, a style can be used
13346 as some kind of break, which does not contain actual text.
13349 \begin_layout Description
13350 \begin_inset Flex Code
13353 \begin_layout Plain Layout
13360 \begin_inset Flex Code
13363 \begin_layout Plain Layout
13369 ] The vertical space between the label and the text body.
13370 Only used for labels that are above the text body (
13371 \begin_inset Flex Code
13374 \begin_layout Plain Layout
13381 \begin_inset Newline newline
13385 \begin_inset Flex Code
13388 \begin_layout Plain Layout
13389 Centered_Top_Environment
13397 \begin_layout Description
13398 \begin_inset Flex Code
13401 \begin_layout Plain Layout
13408 \begin_inset Flex Code
13411 \begin_layout Plain Layout
13417 ] The name of the counter for automatic numbering.
13418 In order to have the counter appear with your label, you will need to reference
13420 \begin_inset Flex Code
13423 \begin_layout Plain Layout
13432 This will work with
13433 \begin_inset Flex Code
13436 \begin_layout Plain Layout
13443 \begin_inset Flex Code
13446 \begin_layout Plain Layout
13453 \begin_inset Flex Code
13456 \begin_layout Plain Layout
13463 \begin_inset Flex Code
13466 \begin_layout Plain Layout
13473 \begin_inset Newline newline
13481 \begin_inset Flex Code
13484 \begin_layout Plain Layout
13491 \begin_inset Flex Code
13494 \begin_layout Plain Layout
13500 , though this case is a bit complicated.
13501 Suppose you declare
13502 \begin_inset Quotes eld
13506 \begin_inset Flex Code
13509 \begin_layout Plain Layout
13510 LabelCounter myenum
13516 \begin_inset Quotes erd
13520 Then the actual counters used are
13521 \begin_inset Flex Code
13524 \begin_layout Plain Layout
13531 \begin_inset Flex Code
13534 \begin_layout Plain Layout
13541 \begin_inset Flex Code
13544 \begin_layout Plain Layout
13551 \begin_inset Flex Code
13554 \begin_layout Plain Layout
13560 , much as in \SpecialChar LaTeX
13562 These counters must all be declared separately.
13563 \begin_inset Newline newline
13567 \begin_inset CommandInset ref
13569 reference "subsec:Counters"
13573 for details on counters.
13576 \begin_layout Description
13577 \begin_inset Flex Code
13580 \begin_layout Plain Layout
13586 The font used for the label.
13588 \begin_inset CommandInset ref
13590 reference "subsec:Font-description"
13597 \begin_layout Description
13598 \begin_inset Flex Code
13601 \begin_layout Plain Layout
13608 \begin_inset Flex Code
13611 \begin_layout Plain Layout
13617 ] Text that indicates how far a label should be indented.
13620 \begin_layout Description
13621 \begin_inset Flex Code
13624 \begin_layout Plain Layout
13631 \begin_inset Flex Code
13634 \begin_layout Plain Layout
13640 ] Text that indicates the amount of horizontal space between the label and
13642 Only used for labels that are not above the text body.
13645 \begin_layout Description
13646 \begin_inset Flex Code
13649 \begin_layout Plain Layout
13656 \begin_inset Flex Code
13659 \begin_layout Plain Layout
13665 ] The string used for the label.
13667 \begin_inset Flex Code
13670 \begin_layout Plain Layout
13676 is set, this string can be contain the special formatting commands described
13678 \begin_inset CommandInset ref
13680 reference "subsec:Counters"
13687 \begin_layout Description
13688 \begin_inset Flex Code
13691 \begin_layout Plain Layout
13692 LabelStringAppendix
13698 \begin_inset Flex Code
13701 \begin_layout Plain Layout
13707 ] This is used inside the appendix instead of
13708 \begin_inset Newline newline
13712 \begin_inset Flex Code
13715 \begin_layout Plain Layout
13723 \begin_inset Flex Code
13726 \begin_layout Plain Layout
13733 \begin_inset Newline newline
13737 \begin_inset Flex Code
13740 \begin_layout Plain Layout
13741 LabelStringAppendix
13749 \begin_layout Description
13750 \begin_inset Flex Code
13753 \begin_layout Plain Layout
13759 [FIXME] (Used only with XML-type formats.)
13762 \begin_layout Description
13763 \begin_inset Flex Code
13766 \begin_layout Plain Layout
13773 \begin_inset Flex Code
13776 \begin_layout Plain Layout
13781 , Manual, Static, Above,
13782 \begin_inset Newline newline
13785 Centered, Sensitive, Enumerate,
13786 \begin_inset Newline newline
13789 Itemize, Bibliography
13798 \begin_layout Description
13799 \begin_inset Flex Code
13802 \begin_layout Plain Layout
13808 means the label is the very first word (up to the first real blank).
13809 Use protected spaces if you want more than one word as the label.
13813 \begin_layout Description
13814 \begin_inset Flex Code
13817 \begin_layout Plain Layout
13823 means the label is simply what is declared as
13824 \begin_inset Flex Code
13827 \begin_layout Plain Layout
13834 This will be displayed
13835 \begin_inset Quotes eld
13839 \begin_inset Quotes erd
13842 , at the beginning of the paragraph.
13844 \begin_inset Flex Code
13847 \begin_layout Plain Layout
13854 \begin_inset Flex Code
13857 \begin_layout Plain Layout
13863 , then it will be displayed only in the first paragraph of any sequence
13864 of paragraphs with the same
13865 \begin_inset Flex Code
13868 \begin_layout Plain Layout
13877 \begin_layout Description
13878 \begin_inset Flex Code
13881 \begin_layout Plain Layout
13888 \begin_inset space ~
13892 \begin_inset space ~
13896 \begin_inset Flex Code
13899 \begin_layout Plain Layout
13905 are special cases of
13906 \begin_inset Flex Code
13909 \begin_layout Plain Layout
13916 The label will be printed above the paragraph either at the beginning of
13917 the line or centered.
13920 \begin_layout Description
13921 \begin_inset Flex Code
13924 \begin_layout Plain Layout
13930 is a special case for the caption-labels
13931 \begin_inset Quotes eld
13935 \begin_inset Quotes erd
13939 \begin_inset Quotes eld
13943 \begin_inset Quotes erd
13947 \begin_inset Newline newline
13951 \begin_inset Flex Code
13954 \begin_layout Plain Layout
13960 means the (hardcoded) label string depends on the kind of float: It is
13961 hardcoded to be `FloatType N', where N is the value of the counter associated
13963 For the case that a caption is inserted outside of a float the
13964 \begin_inset Flex Code
13967 \begin_layout Plain Layout
13974 \begin_inset Quotes eld
13978 \begin_inset Quotes erd
13984 \begin_layout Description
13985 \begin_inset Flex Code
13988 \begin_layout Plain Layout
13994 produces the usual sort of enumeration labels.
13995 The number type needs to be set in the
14000 \begin_inset CommandInset ref
14002 reference "subsec:Counters"
14009 \begin_layout Description
14010 \begin_inset Flex Code
14013 \begin_layout Plain Layout
14019 produces various bullets at the different levels.
14020 The bullet types displayed can be set via
14021 \begin_inset Flex Noun
14024 \begin_layout Plain Layout
14025 Document\SpecialChar menuseparator
14026 Settings\SpecialChar menuseparator
14035 \begin_layout Description
14036 \begin_inset Flex Code
14039 \begin_layout Plain Layout
14045 should be used only with
14046 \begin_inset Flex Code
14049 \begin_layout Plain Layout
14050 LatexType BibEnvironment
14059 \begin_layout Description
14060 \begin_inset Flex Code
14063 \begin_layout Plain Layout
14069 Note that this will completely override any prior
14070 \begin_inset Flex Code
14073 \begin_layout Plain Layout
14079 declaration for this style.
14081 \begin_inset Quotes eld
14085 \begin_inset Flex Code
14088 \begin_layout Plain Layout
14095 \begin_inset Quotes erd
14100 \begin_inset CommandInset ref
14102 reference "subsec:I18n"
14106 for details on its use.
14109 \begin_layout Description
14110 \begin_inset Flex Code
14113 \begin_layout Plain Layout
14120 \begin_inset Flex Code
14123 \begin_layout Plain Layout
14129 ] The name of the corresponding \SpecialChar LaTeX
14131 Either the environment or command name.
14134 \begin_layout Description
14135 \begin_inset Flex Code
14138 \begin_layout Plain Layout
14145 \begin_inset Flex Code
14148 \begin_layout Plain Layout
14154 ] An optional parameter for the corresponding
14155 \begin_inset Flex Code
14158 \begin_layout Plain Layout
14165 This parameter cannot be changed from within \SpecialChar LyX
14167 \begin_inset Flex Code
14170 \begin_layout Plain Layout
14176 for customizable parameters).
14177 This will be output as is after all \SpecialChar LaTeX
14179 \begin_inset Flex Code
14182 \begin_layout Plain Layout
14191 \begin_layout Description
14192 \begin_inset Flex Code
14195 \begin_layout Plain Layout
14202 \begin_inset Flex Code
14205 \begin_layout Plain Layout
14210 , Command, Environment, Item_Environment,
14211 \begin_inset Newline newline
14214 List_Environment, Bib_Environment
14219 ] How the style should be translated into \SpecialChar LaTeX
14224 \begin_layout Plain Layout
14225 \begin_inset Flex Code
14228 \begin_layout Plain Layout
14234 is perhaps a bit misleading, since these rules apply to SGML classes, too.
14235 Visit the SGML class files for specific examples.
14244 \begin_layout Description
14245 \begin_inset Flex Code
14248 \begin_layout Plain Layout
14254 means nothing special.
14257 \begin_layout Description
14258 \begin_inset Flex Code
14261 \begin_layout Plain Layout
14268 \begin_inset Flex Code
14271 \begin_layout Plain Layout
14278 {\SpecialChar ldots
14287 \begin_layout Description
14288 \begin_inset Flex Code
14291 \begin_layout Plain Layout
14298 \begin_inset Flex Code
14301 \begin_layout Plain Layout
14308 }\SpecialChar ldots
14324 \begin_layout Description
14325 \begin_inset Flex Code
14328 \begin_layout Plain Layout
14335 \begin_inset Flex Code
14338 \begin_layout Plain Layout
14345 \begin_inset Flex Code
14348 \begin_layout Plain Layout
14356 is generated for each paragraph of this environment.
14360 \begin_layout Description
14361 \begin_inset Flex Code
14364 \begin_layout Plain Layout
14371 \begin_inset Flex Code
14374 \begin_layout Plain Layout
14381 \begin_inset Newline newline
14385 \begin_inset Flex Code
14388 \begin_layout Plain Layout
14394 is passed as an argument to the environment.
14395 \begin_inset Newline newline
14399 \begin_inset Flex Code
14402 \begin_layout Plain Layout
14408 can be defined in the
14409 \begin_inset Flex Noun
14412 \begin_layout Plain Layout
14413 Edit\SpecialChar menuseparator
14415 \begin_inset space ~
14426 \begin_layout Description
14427 \begin_inset Flex Code
14430 \begin_layout Plain Layout
14437 \begin_inset Flex Code
14440 \begin_layout Plain Layout
14446 but adds the necessary mandatory argument (the longest label) to the begin
14447 statement of the bibliography environment:
14448 \begin_inset Newline newline
14452 \begin_inset Flex Code
14455 \begin_layout Plain Layout
14458 begin{thebibliography}{99}
14464 It is therefore only useful for bibliography environments.
14465 The default longest label
14466 \begin_inset Quotes eld
14470 \begin_inset Quotes erd
14473 can be changed by the user in the paragraph settings of a bibliography
14477 \begin_layout Standard
14478 Putting the last few things together, the \SpecialChar LaTeX
14479 output will be either:
14482 \begin_layout LyX-Code
14485 LatexName[LatexParam]{\SpecialChar ldots
14489 \begin_layout Standard
14493 \begin_layout LyX-Code
14496 begin{LatexName}[LatexParam] \SpecialChar ldots
14502 \begin_layout Standard
14503 depending upon the \SpecialChar LaTeX
14508 \begin_layout Description
14509 \begin_inset Flex Code
14512 \begin_layout Plain Layout
14519 \begin_inset Flex Code
14522 \begin_layout Plain Layout
14528 ] A string that is put at the beginning of the style content.
14529 A line break in the output can be indicated by
14530 \begin_inset Flex Code
14533 \begin_layout Plain Layout
14542 \begin_layout Description
14543 \begin_inset Flex Code
14546 \begin_layout Plain Layout
14553 \begin_inset Flex Code
14556 \begin_layout Plain Layout
14562 ] If you put styles into environments, the different
14563 \begin_inset Flex Code
14566 \begin_layout Plain Layout
14572 are not simply added, but added with a factor
14573 \begin_inset Formula $\frac{4}{\mathrm{depth}+4}$
14577 Note that this parameter is also used when
14578 \begin_inset Flex Code
14581 \begin_layout Plain Layout
14588 \begin_inset Flex Code
14591 \begin_layout Plain Layout
14598 \begin_inset Flex Code
14601 \begin_layout Plain Layout
14608 Then it is added to the manual or dynamic margin.
14609 \begin_inset Newline newline
14613 \begin_inset Quotes eld
14617 \begin_inset Flex Code
14620 \begin_layout Plain Layout
14627 \begin_inset Quotes erd
14630 means that the paragraph is indented with the width of
14631 \begin_inset Quotes eld
14635 \begin_inset Flex Code
14638 \begin_layout Plain Layout
14645 \begin_inset Quotes erd
14648 in the normal font.
14649 You can get a negative width by prefixing the string with
14650 \begin_inset Quotes eld
14654 \begin_inset Flex Code
14657 \begin_layout Plain Layout
14664 \begin_inset Quotes erd
14668 This way was chosen so that the look is the same with each used screen
14672 \begin_layout Description
14673 \begin_inset Flex Code
14676 \begin_layout Plain Layout
14683 \begin_inset Flex Code
14686 \begin_layout Plain Layout
14691 , Manual, Dynamic, First_Dynamic, Right_Address_Box
14697 \begin_inset Newline newline
14700 The kind of margin that the style has on the left side.
14704 \begin_layout Description
14705 \begin_inset Flex Code
14708 \begin_layout Plain Layout
14714 just means a fixed margin.
14717 \begin_layout Description
14718 \begin_inset Flex Code
14721 \begin_layout Plain Layout
14727 means that the left margin depends on the string entered in the
14728 \begin_inset Flex Noun
14731 \begin_layout Plain Layout
14732 Edit\SpecialChar menuseparator
14734 \begin_inset space ~
14743 This is used to typeset nice lists without tabulators.
14746 \begin_layout Description
14747 \begin_inset Flex Code
14750 \begin_layout Plain Layout
14756 means that the margin depends on the size of the label.
14757 This is used for automatic enumerated headlines.
14758 It is obvious that the headline
14759 \begin_inset Quotes eld
14762 5.4.3.2.1 Very long headline
14763 \begin_inset Quotes erd
14766 must have a wider left margin (as wide as
14767 \begin_inset Quotes eld
14771 \begin_inset Quotes erd
14774 plus the space) than
14775 \begin_inset Quotes eld
14778 3.2 Very long headline
14779 \begin_inset Quotes erd
14783 \begin_inset Quotes eld
14787 \begin_inset Quotes erd
14790 are not able to do this.
14793 \begin_layout Description
14794 \begin_inset Flex Code
14797 \begin_layout Plain Layout
14803 is similar, but only the very first row of the paragraph is dynamic, while
14804 the others are static; this is used, for example, for descriptions.
14807 \begin_layout Description
14808 \begin_inset Flex Code
14811 \begin_layout Plain Layout
14817 means the margin is chosen in a way that the longest row of this paragraph
14818 fits to the right margin.
14819 This is used to typeset an address on the right edge of the page.
14823 \begin_layout Description
14824 \begin_inset Flex Code
14827 \begin_layout Plain Layout
14834 \begin_inset Flex Code
14837 \begin_layout Plain Layout
14846 \begin_inset space \thinspace{}
14850 \begin_inset Flex Code
14853 \begin_layout Plain Layout
14859 ] Whether fragile commands in this style should be
14860 \begin_inset Flex Code
14863 \begin_layout Plain Layout
14876 whether this command should itself be protected.)
14877 \change_inserted -712698321 1523696949
14881 \begin_layout Description
14883 \change_inserted -712698321 1523696969
14884 \begin_inset Flex Code
14887 \begin_layout Plain Layout
14889 \change_inserted -712698321 1523696950
14896 \begin_inset Flex Code
14899 \begin_layout Plain Layout
14901 \change_inserted -712698321 1523696950
14910 \begin_inset space \thinspace{}
14914 \begin_inset Flex Code
14917 \begin_layout Plain Layout
14919 \change_inserted -712698321 1523696950
14925 ] This causes macros that contain this layout to be protected with
14926 \begin_inset Flex Code
14929 \begin_layout Plain Layout
14931 \change_inserted -712698321 1523696950
14944 ) if necessary and thus allows (some) verbatim stuff in macros.
14949 \begin_layout Description
14950 \begin_inset Flex Code
14953 \begin_layout Plain Layout
14960 \begin_inset Flex Code
14963 \begin_layout Plain Layout
14970 \begin_inset space \thinspace{}
14974 \begin_inset Flex Code
14977 \begin_layout Plain Layout
14985 ] Whether newlines are translated into \SpecialChar LaTeX
14987 \begin_inset Flex Code
14990 \begin_layout Plain Layout
15001 The translation can be switched off to allow more comfortable \SpecialChar LaTeX
15003 inside \SpecialChar LyX
15007 \begin_layout Description
15008 \begin_inset Flex Code
15011 \begin_layout Plain Layout
15018 \begin_inset Flex Code
15021 \begin_layout Plain Layout
15030 \begin_inset space \thinspace{}
15034 \begin_inset Flex Code
15037 \begin_layout Plain Layout
15043 ] If set to true, and if
15044 \begin_inset Flex Code
15047 \begin_layout Plain Layout
15054 \begin_inset Flex Code
15057 \begin_layout Plain Layout
15063 ) paragraphs are being indented, then the indentation of such a paragraph
15064 following one of this type will be suppressed.
15065 (So this will not affect the display of non-default paragraphs.)
15068 \begin_layout Description
15069 \begin_inset Flex Code
15072 \begin_layout Plain Layout
15079 \begin_inset Flex Code
15082 \begin_layout Plain Layout
15088 ] Name of a style that has replaced this style.
15089 This is used to rename a style, while keeping backward compatibility.
15092 \begin_layout Description
15093 \begin_inset Flex Code
15096 \begin_layout Plain Layout
15103 \begin_inset Flex Code
15106 \begin_layout Plain Layout
15113 \begin_inset space \thinspace{}
15117 \begin_inset Flex Code
15120 \begin_layout Plain Layout
15126 ] Determines whether consecutive paragraphs of the same type are treated
15127 as belonging together.
15128 This has the effect that the
15129 \begin_inset Flex Code
15132 \begin_layout Plain Layout
15138 is only printed once before such a group.
15139 By default, this is true for
15140 \begin_inset Flex Code
15143 \begin_layout Plain Layout
15150 \begin_inset Flex Code
15153 \begin_layout Plain Layout
15160 \begin_inset Flex Code
15163 \begin_layout Plain Layout
15169 and false for all other types.
15172 \begin_layout Description
15173 \begin_inset Flex Code
15176 \begin_layout Plain Layout
15183 \begin_inset Flex Code
15186 \begin_layout Plain Layout
15195 \begin_inset space \thinspace{}
15199 \begin_inset Flex Code
15202 \begin_layout Plain Layout
15208 ] Indicates that paragraphs will not be separated by an empty line in \SpecialChar LaTeX
15210 but only by a line break; together with
15211 \begin_inset Flex Code
15214 \begin_layout Plain Layout
15220 , this allows to emulate a plain text editor (like the ERT inset).
15223 \begin_layout Description
15224 \begin_inset Flex Code
15227 \begin_layout Plain Layout
15234 \begin_inset Flex Code
15237 \begin_layout Plain Layout
15243 ] The indent of the very first line of a paragraph.
15245 \begin_inset Newline newline
15249 \begin_inset Flex Code
15252 \begin_layout Plain Layout
15258 will be fixed for a certain style.
15259 The exception is the default style, since the indentation for these paragraphs
15260 can be prohibited with
15261 \begin_inset Flex Code
15264 \begin_layout Plain Layout
15272 \begin_inset Flex Code
15275 \begin_layout Plain Layout
15281 style paragraphs inside environments use the
15282 \begin_inset Flex Code
15285 \begin_layout Plain Layout
15291 of the environment, not their native one.
15293 \begin_inset Flex Code
15296 \begin_layout Plain Layout
15302 paragraphs inside an enumeration are not indented.
15305 \begin_layout Description
15306 \begin_inset Flex Code
15309 \begin_layout Plain Layout
15316 \begin_inset Flex Code
15319 \begin_layout Plain Layout
15325 ] The vertical space between two paragraphs of this style.
15328 \begin_layout Description
15329 \begin_inset Flex Code
15332 \begin_layout Plain Layout
15339 \begin_inset Flex Code
15342 \begin_layout Plain Layout
15349 allows the user to choose either
15350 \begin_inset Quotes eld
15354 \begin_inset Quotes erd
15358 \begin_inset Quotes eld
15362 \begin_inset Quotes erd
15365 to separate paragraphs.
15367 \begin_inset Quotes eld
15371 \begin_inset Quotes erd
15375 \begin_inset Flex Code
15378 \begin_layout Plain Layout
15386 \begin_inset Quotes eld
15390 \begin_inset Quotes erd
15394 \begin_inset Flex Code
15397 \begin_layout Plain Layout
15403 is ignored and all paragraphs are separated by the
15404 \begin_inset Flex Code
15407 \begin_layout Plain Layout
15414 The vertical space is calculated with
15415 \begin_inset Flex Code
15418 \begin_layout Plain Layout
15420 \begin_inset space ~
15429 \begin_inset Flex Code
15432 \begin_layout Plain Layout
15438 is the height of a row with the normal font.
15439 This way, the look stays the same with different screen fonts.
15442 \begin_layout Description
15443 \begin_inset Flex Code
15446 \begin_layout Plain Layout
15453 \begin_inset Flex Code
15456 \begin_layout Plain Layout
15465 \begin_inset space \thinspace{}
15469 \begin_inset Flex Code
15472 \begin_layout Plain Layout
15478 ] Whether the contents of this paragraph should be output in raw form, meaning
15479 without special translations that \SpecialChar LaTeX
15483 \begin_layout Description
15484 \begin_inset Flex Code
15487 \begin_layout Plain Layout
15494 \begin_inset Flex Code
15497 \begin_layout Plain Layout
15507 Defines individual characters that should be output in raw form, meaning
15508 without special translations that \SpecialChar LaTeX
15512 \begin_layout Description
15513 \begin_inset Flex Code
15516 \begin_layout Plain Layout
15522 Information to be included in the \SpecialChar LaTeX
15523 preamble when this style is used.
15524 Used to define macros, load packages, etc., required by this particular
15527 \begin_inset Quotes eld
15531 \begin_inset Flex Code
15534 \begin_layout Plain Layout
15541 \begin_inset Quotes erd
15547 \begin_layout Description
15548 \begin_inset Flex Code
15551 \begin_layout Plain Layout
15558 \begin_inset Flex Code
15561 \begin_layout Plain Layout
15567 ] The prefix to use when creating labels referring to paragraphs of this
15569 This allows the use of formatted references.
15572 \begin_layout Description
15573 \begin_inset Flex Code
15576 \begin_layout Plain Layout
15583 \begin_inset Flex Code
15586 \begin_layout Plain Layout
15592 ] Whether the style requires the feature
15593 \begin_inset Flex Code
15596 \begin_layout Plain Layout
15603 \begin_inset CommandInset ref
15605 reference "chap:List-of-functions"
15609 for the list of features).
15610 If you require a package with specific options, you can additionally use
15612 \begin_inset Flex Code
15615 \begin_layout Plain Layout
15621 as a general text class parameter (see
15622 \begin_inset CommandInset ref
15624 reference "subsec:General-text-class"
15631 \begin_layout Description
15632 \begin_inset Flex Code
15635 \begin_layout Plain Layout
15642 \begin_inset Flex Code
15645 \begin_layout Plain Layout
15654 \begin_inset Flex Code
15657 \begin_layout Plain Layout
15663 ] Resets the \SpecialChar LaTeX
15664 arguments of this style (as defined via the
15665 \begin_inset Flex Code
15668 \begin_layout Plain Layout
15675 This is useful if you have copied a style via
15676 \begin_inset Flex Code
15679 \begin_layout Plain Layout
15685 , but you do not want to inherit its (required and optional) arguments.
15688 \begin_layout Description
15689 \begin_inset Flex Code
15692 \begin_layout Plain Layout
15699 \begin_inset Flex Code
15702 \begin_layout Plain Layout
15711 \begin_inset Flex Code
15714 \begin_layout Plain Layout
15720 ] Resumes a counter that is usually reset at each new sequence of layouts.
15721 This is currently only useful when
15722 \begin_inset Flex Code
15725 \begin_layout Plain Layout
15732 \begin_inset Flex Code
15735 \begin_layout Plain Layout
15744 \begin_layout Description
15745 \begin_inset Flex Code
15748 \begin_layout Plain Layout
15755 \begin_inset Flex Code
15758 \begin_layout Plain Layout
15764 ] A string that is put at the end of the layout content.
15765 A line break in the output can be indicated by
15766 \begin_inset Flex Code
15769 \begin_layout Plain Layout
15778 \begin_layout Description
15779 \begin_inset Flex Code
15782 \begin_layout Plain Layout
15789 \begin_inset Flex Code
15792 \begin_layout Plain Layout
15799 \begin_inset Flex Code
15802 \begin_layout Plain Layout
15811 \begin_layout Description
15812 \begin_inset Flex Code
15815 \begin_layout Plain Layout
15822 \begin_inset Flex Code
15825 \begin_layout Plain Layout
15834 \begin_inset Flex Code
15837 \begin_layout Plain Layout
15844 \begin_inset Flex Code
15847 \begin_layout Plain Layout
15854 \begin_inset Flex Code
15857 \begin_layout Plain Layout
15859 \begin_inset space ~
15867 ] This defines what the default spacing should be in the style.
15869 \begin_inset Flex Code
15872 \begin_layout Plain Layout
15879 \begin_inset Flex Code
15882 \begin_layout Plain Layout
15889 \begin_inset Flex Code
15892 \begin_layout Plain Layout
15898 correspond respectively to a multiplier value of 1, 1.25 and 1.667.
15899 If you specify the argument
15900 \begin_inset Flex Code
15903 \begin_layout Plain Layout
15909 , then you must also provide a value argument which will be the actual multiplie
15911 Note that, contrary to other parameters,
15912 \begin_inset Flex Code
15915 \begin_layout Plain Layout
15921 implies the generation of specific \SpecialChar LaTeX
15922 code, using the \SpecialChar LaTeX
15926 \begin_inset Flex Code
15929 \begin_layout Plain Layout
15938 \begin_layout Description
15939 \begin_inset Flex Code
15942 \begin_layout Plain Layout
15949 \begin_inset Flex Code
15952 \begin_layout Plain Layout
15959 \begin_inset space \thinspace{}
15963 \begin_inset Flex Code
15966 \begin_layout Plain Layout
15974 ] Allow spell-checking paragraphs of this style.
15978 \begin_layout Description
15979 \begin_inset Flex Code
15982 \begin_layout Plain Layout
15989 \begin_inset Flex Code
15992 \begin_layout Plain Layout
16001 \begin_inset Flex Code
16004 \begin_layout Plain Layout
16010 ] Steps the master counter of a given counter at the beginning of a new
16011 sequence of layouts.
16012 This is currently only useful when
16013 \begin_inset Flex Code
16016 \begin_layout Plain Layout
16023 \begin_inset Flex Code
16026 \begin_layout Plain Layout
16035 \begin_layout Description
16036 \begin_inset Flex Code
16039 \begin_layout Plain Layout
16045 The font used for the text body .
16047 \begin_inset CommandInset ref
16049 reference "subsec:Font-description"
16056 \begin_layout Description
16057 \begin_inset Flex Code
16060 \begin_layout Plain Layout
16069 \begin_inset Flex Code
16072 \begin_layout Plain Layout
16082 The level of the style in the table of contents.
16083 This is used for automatic numbering of section headings.
16086 \begin_layout Description
16087 \begin_inset Flex Code
16090 \begin_layout Plain Layout
16099 \begin_inset Flex Code
16102 \begin_layout Plain Layout
16113 \begin_inset Flex Code
16116 \begin_layout Plain Layout
16123 \begin_inset Flex Code
16126 \begin_layout Plain Layout
16132 ] This tag determines whether the first line indentation of this paragraph
16133 can be toggled via the Paragraph settings dialog.
16137 \begin_inset Flex Code
16140 \begin_layout Plain Layout
16150 is set, indentation can be toggled if the document settings use
16151 \begin_inset Quotes eld
16155 \begin_inset Quotes erd
16158 paragraph style, with
16159 \begin_inset Flex Code
16162 \begin_layout Plain Layout
16168 , indentation can always be toggled, notwithstanding the document settings,
16170 \begin_inset Flex Code
16173 \begin_layout Plain Layout
16179 , indentation can never be toggled.
16182 \begin_layout Description
16183 \begin_inset Flex Code
16186 \begin_layout Plain Layout
16193 \begin_inset Flex Code
16196 \begin_layout Plain Layout
16202 ] The vertical space with which the very first of a chain of paragraphs
16203 with this style is separated from the previous paragraph.
16204 If the previous paragraph has another style, the separations are not simply
16205 added, but the maximum is taken.
16208 \begin_layout Subsection
16209 \begin_inset CommandInset label
16215 Internationalization of Paragraph Styles
16218 \begin_layout Standard
16220 has long supported internationalization of layout information, but, until
16221 version 2.0, this applied only to the user interface and not to, say, PDF
16223 Thus, French authors were forced to resort to ugly hacks if they wanted
16228 1' instead of `Theorem 1'.
16229 Thanks to Georg Baum, that is no longer the case.
16232 \begin_layout Standard
16234 \begin_inset Flex Code
16237 \begin_layout Plain Layout
16243 defines text that is to appear in the typeset document, it may use
16244 \begin_inset Flex Code
16247 \begin_layout Plain Layout
16254 \begin_inset Flex Code
16257 \begin_layout Plain Layout
16263 to support non-English and even multi-language documents correctly.
16264 The following excerpt (from the
16265 \begin_inset Flex Code
16268 \begin_layout Plain Layout
16274 file) shows how this works:
16277 \begin_layout LyX-Code
16282 \begin_layout LyX-Code
16285 theoremstyle{remark}
16288 \begin_layout LyX-Code
16291 newtheorem{claim}[thm]{
16298 \begin_layout LyX-Code
16302 \begin_layout LyX-Code
16306 \begin_layout LyX-Code
16311 claimname}{_(Claim)}
16314 \begin_layout LyX-Code
16318 \begin_layout LyX-Code
16322 \begin_layout LyX-Code
16331 claimname}{_(Claim)}}
16334 \begin_layout LyX-Code
16339 \begin_layout Standard
16340 In principle, any legal \SpecialChar LaTeX
16342 \begin_inset Flex Code
16345 \begin_layout Plain Layout
16352 \begin_inset Flex Code
16355 \begin_layout Plain Layout
16361 tags, but in practice they will typically look as they do here.
16362 The key to correct translation of the typeset text is the definition of
16363 the \SpecialChar LaTeX
16365 \begin_inset Flex Code
16368 \begin_layout Plain Layout
16377 \begin_inset Flex Code
16380 \begin_layout Plain Layout
16392 \begin_layout Standard
16394 \begin_inset Flex Code
16397 \begin_layout Plain Layout
16403 tag provides for internationalization based upon the overall language of
16405 The contents of the tag will be included in the preamble, just as with
16407 \begin_inset Flex Code
16410 \begin_layout Plain Layout
16417 What makes it special is the use of the
16418 \begin_inset Quotes eld
16422 \begin_inset Quotes erd
16426 \begin_inset Flex Code
16429 \begin_layout Plain Layout
16435 , which will be replaced, when \SpecialChar LyX
16436 produces \SpecialChar LaTeX
16437 output, with the translation of
16438 its argument into the document language.
16441 \begin_layout Standard
16443 \begin_inset Flex Code
16446 \begin_layout Plain Layout
16452 tag is more complex, since it is meant to provide support for multi-language
16453 documents and so offers an interface to the
16454 \begin_inset Flex Code
16457 \begin_layout Plain Layout
16464 Its contents will be added to the preamble once for each language that
16465 appears in the document.
16466 In this case, the argument to
16467 \begin_inset Flex Code
16470 \begin_layout Plain Layout
16476 will be replaced with its translation into the language in question; the
16478 \begin_inset Flex Code
16481 \begin_layout Plain Layout
16487 is replaced by the language name (as used by the babel package).
16490 \begin_layout Standard
16491 A German document that also included a French section would thus have the
16492 following in the preamble:
16495 \begin_layout LyX-Code
16504 claimname}{Affirmation}}
16505 \begin_inset Newline newline
16516 claimname}{Behauptung}}
16517 \begin_inset Newline newline
16524 claimname}{Behauptung}
16527 \begin_layout Standard
16530 \begin_inset Flex Code
16533 \begin_layout Plain Layout
16539 will then conspire to produce the correct text in the output.
16542 \begin_layout Standard
16543 One important point to note here is that the translations are provided by
16545 itself, through the file
16546 \begin_inset Flex Code
16549 \begin_layout Plain Layout
16556 This means, in effect, that
16557 \begin_inset Flex Code
16560 \begin_layout Plain Layout
16567 \begin_inset Flex Code
16570 \begin_layout Plain Layout
16576 are really only of use in layout files that are provided with \SpecialChar LyX
16578 entered in user-created layout files will not be seen by \SpecialChar LyX
16579 's internationalizatio
16580 n routines unless the
16581 \begin_inset Flex Code
16584 \begin_layout Plain Layout
16590 file is modified accordingly.
16591 That said, however, any layout created with the intention that it will
16592 be included with \SpecialChar LyX
16593 should use these tags where appropriate.
16594 Please note that the paragraph style translations provided by \SpecialChar LyX
16596 change with a minor update (e.
16597 \begin_inset space \thinspace{}
16601 \begin_inset space \space{}
16604 from version 2.1.x to 2.1.y).
16605 It is however quite likely that a major update (e.
16606 \begin_inset space \thinspace{}
16610 \begin_inset space \space{}
16613 from 2.0.x to 2.1.0) will introduce new translations or corrections.
16616 \begin_layout Subsection
16618 \begin_inset CommandInset label
16620 name "subsec:Floats"
16627 \begin_layout Standard
16628 It is necessary to define the floats (
16629 \begin_inset Flex Noun
16632 \begin_layout Plain Layout
16639 \begin_inset Flex Noun
16642 \begin_layout Plain Layout
16648 , \SpecialChar ldots
16649 ) in the text class itself.
16650 Standard floats are included in the file
16651 \begin_inset Flex Code
16654 \begin_layout Plain Layout
16660 , so you may have to do no more than add
16663 \begin_layout LyX-Code
16664 Input stdfloats.inc
16667 \begin_layout Standard
16668 to your layout file.
16669 If you want to implement a text class that proposes some other float types
16670 (like the AGU class bundled with \SpecialChar LyX
16671 ), the information below will hopefully
16675 \begin_layout Description
16676 \begin_inset Flex Code
16679 \begin_layout Plain Layout
16686 \begin_inset Flex Code
16689 \begin_layout Plain Layout
16695 =!htbpH] Allowed placement options for this float type.
16696 The value is a string of placement characters.
16697 Possible characters include:
16702 \begin_inset Quotes eld
16706 \begin_inset Quotes erd
16714 \begin_inset Quotes eld
16718 \begin_inset Quotes erd
16726 \begin_inset Quotes eld
16730 \begin_inset Quotes erd
16738 \begin_inset Quotes eld
16742 \begin_inset Quotes erd
16750 \begin_inset Quotes eld
16754 \begin_inset Quotes erd
16762 \begin_inset Quotes eld
16766 \begin_inset Quotes erd
16770 The order of the characters in the string does not matter.
16771 If no placement options are allowed, use the string
16778 \begin_layout Description
16779 \begin_inset Flex Code
16782 \begin_layout Plain Layout
16789 \begin_inset Flex Code
16792 \begin_layout Plain Layout
16801 \begin_inset space \thinspace{}
16807 \begin_inset Flex Code
16810 \begin_layout Plain Layout
16820 ] Defines whether the float allows to be rotated via the \SpecialChar LaTeX
16827 \begin_inset Flex Code
16830 \begin_layout Plain Layout
16836 if the float does not support this feature.
16839 \begin_layout Description
16840 \begin_inset Flex Code
16843 \begin_layout Plain Layout
16850 \begin_inset Flex Code
16853 \begin_layout Plain Layout
16862 \begin_inset space \thinspace{}
16868 \begin_inset Flex Code
16871 \begin_layout Plain Layout
16881 ] Defines whether the float has a starred variant that spans columns in
16882 a two column paragraph.
16884 \begin_inset Flex Code
16887 \begin_layout Plain Layout
16893 if the float does not support this feature.
16896 \begin_layout Description
16897 \begin_inset Flex Code
16900 \begin_layout Plain Layout
16907 \begin_inset Flex Code
16910 \begin_layout Plain Layout
16917 \begin_inset Quotes erd
16921 \begin_inset Quotes erd
16924 ] The file name extension of an auxiliary file for the list of figures (or
16927 writes the captions to this file.
16930 \begin_layout Description
16931 \begin_inset Flex Code
16934 \begin_layout Plain Layout
16941 \begin_inset Flex Code
16944 \begin_layout Plain Layout
16951 \begin_inset Quotes erd
16955 \begin_inset Quotes erd
16958 ] The string that will be used in the menus and also for the caption.
16959 This is translated to the current language if babel is used.
16962 \begin_layout Description
16963 \begin_inset Flex Code
16966 \begin_layout Plain Layout
16972 These tags control the XHTML output.
16974 \begin_inset CommandInset ref
16976 reference "sec:Tags-for-XHTML"
16983 \begin_layout Description
16984 \begin_inset Flex Code
16987 \begin_layout Plain Layout
16996 \begin_inset Flex Code
16999 \begin_layout Plain Layout
17008 \begin_inset space \thinspace{}
17012 \begin_inset Flex Code
17015 \begin_layout Plain Layout
17021 ] Indicates whether the float is already defined in the document class or
17022 if instead the \SpecialChar LaTeX
17024 \begin_inset Flex Code
17027 \begin_layout Plain Layout
17033 needs to be loaded to define it on-the-fly.
17035 \begin_inset Flex Code
17038 \begin_layout Plain Layout
17045 \begin_inset Flex Code
17048 \begin_layout Plain Layout
17055 It should be set to
17056 \begin_inset Flex Code
17059 \begin_layout Plain Layout
17065 if the float is already defined by the \SpecialChar LaTeX
17069 \begin_layout Description
17070 \begin_inset Flex Code
17073 \begin_layout Plain Layout
17080 \begin_inset Flex Code
17083 \begin_layout Plain Layout
17090 \begin_inset Quotes erd
17094 \begin_inset Quotes erd
17097 ] The command used to generate a list of floats of this type; the leading
17106 \begin_inset Flex Code
17109 \begin_layout Plain Layout
17115 is false, since there is no standard way to generate this command.
17117 \begin_inset Flex Code
17120 \begin_layout Plain Layout
17126 is true, since in that case there is a standard way to define the command.
17129 \begin_layout Description
17130 \begin_inset Flex Code
17133 \begin_layout Plain Layout
17140 \begin_inset Flex Code
17143 \begin_layout Plain Layout
17150 \begin_inset Quotes erd
17154 \begin_inset Quotes erd
17157 ] A title for a list of floats of this kind (list of figures, tables, or
17159 It is used for the screen label within \SpecialChar LyX
17160 , it is used by \SpecialChar LaTeX
17162 it is used as the title in the XHTML output.
17163 It will be translated to the document language.
17166 \begin_layout Description
17167 \begin_inset Flex Code
17170 \begin_layout Plain Layout
17177 \begin_inset Flex Code
17180 \begin_layout Plain Layout
17187 \begin_inset Quotes erd
17191 \begin_inset Quotes erd
17194 ] This (optional) argument determines whether floats of this class will
17195 be numbered within some sectional unit of the document.
17197 \begin_inset Flex Code
17200 \begin_layout Plain Layout
17207 \begin_inset Quotes eld
17211 \begin_inset Flex Code
17214 \begin_layout Plain Layout
17221 \begin_inset Quotes erd
17224 , the floats will be numbered within chapters.
17228 \begin_layout Description
17229 \begin_inset Flex Code
17232 \begin_layout Plain Layout
17239 \begin_inset Flex Code
17242 \begin_layout Plain Layout
17249 \begin_inset Quotes erd
17253 \begin_inset Quotes erd
17256 ] The default placement for the given class of floats.
17257 The string should be as in standard \SpecialChar LaTeX
17259 \begin_inset Flex Code
17262 \begin_layout Plain Layout
17269 \begin_inset Flex Code
17272 \begin_layout Plain Layout
17279 \begin_inset Flex Code
17282 \begin_layout Plain Layout
17289 \begin_inset Flex Code
17292 \begin_layout Plain Layout
17298 for top, bottom, page, and here, respectively.
17302 \begin_layout Plain Layout
17303 Note that the order of these letters in the string is irrelevant, like in
17310 On top of that there is a new type,
17311 \begin_inset Flex Code
17314 \begin_layout Plain Layout
17320 , which does not really correspond to a float, since it means: put it
17321 \begin_inset Quotes eld
17325 \begin_inset Quotes erd
17329 Note however that the
17330 \begin_inset Flex Code
17333 \begin_layout Plain Layout
17339 specifier is special and, because of implementation details, cannot be
17340 used in non-built in float types.
17341 If you do not understand what this means, just use
17342 \begin_inset Quotes eld
17346 \begin_inset Flex Code
17349 \begin_layout Plain Layout
17356 \begin_inset Quotes erd
17362 \begin_layout Description
17363 \begin_inset Flex Code
17366 \begin_layout Plain Layout
17373 \begin_inset Flex Code
17376 \begin_layout Plain Layout
17382 ] The prefix to use when creating labels referring to floats of this type.
17383 This allows the use of formatted references.
17384 Note that you can remove any
17385 \begin_inset Flex Code
17388 \begin_layout Plain Layout
17394 set by a copied style by using the special value
17395 \begin_inset Quotes eld
17399 \begin_inset Quotes erd
17402 , which must be all caps.
17405 \begin_layout Description
17406 \begin_inset Flex Code
17409 \begin_layout Plain Layout
17416 \begin_inset Flex Code
17419 \begin_layout Plain Layout
17426 \begin_inset Quotes erd
17430 \begin_inset Quotes erd
17433 ] The style used when defining the float using
17434 \begin_inset Flex Code
17437 \begin_layout Plain Layout
17448 \begin_layout Description
17449 \begin_inset Flex Code
17452 \begin_layout Plain Layout
17459 \begin_inset Flex Code
17462 \begin_layout Plain Layout
17469 \begin_inset Quotes erd
17473 \begin_inset Quotes erd
17477 \begin_inset Quotes eld
17481 \begin_inset Quotes erd
17484 of the new class of floats, like program or algorithm.
17485 After the appropriate
17486 \begin_inset Flex Code
17489 \begin_layout Plain Layout
17498 \begin_inset Flex Code
17501 \begin_layout Plain Layout
17510 \begin_inset Flex Code
17513 \begin_layout Plain Layout
17524 \begin_layout Description
17525 \begin_inset Flex Code
17528 \begin_layout Plain Layout
17535 \begin_inset Flex Code
17538 \begin_layout Plain Layout
17545 \begin_inset space \thinspace{}
17549 \begin_inset Flex Code
17552 \begin_layout Plain Layout
17560 ] Specifies whether this float is defined using the \SpecialChar LaTeX
17562 \begin_inset Flex Code
17565 \begin_layout Plain Layout
17571 , either by the class file, another package or on-the-fly by \SpecialChar LyX
17575 \begin_layout Standard
17576 Note that defining a float with type
17577 \begin_inset Flex Code
17580 \begin_layout Plain Layout
17588 automatically defines the corresponding counter with name
17589 \begin_inset Flex Code
17592 \begin_layout Plain Layout
17603 \begin_layout Subsection
17604 Flex insets and InsetLayout
17605 \begin_inset CommandInset label
17607 name "subsec:Flex-insets-and"
17614 \begin_layout Standard
17615 Flex insets come in three different kinds:
17618 \begin_layout Itemize
17620 \begin_inset Flex Code
17623 \begin_layout Plain Layout
17629 ): These define semantic markup corresponding to such \SpecialChar LaTeX
17631 \begin_inset Flex Code
17634 \begin_layout Plain Layout
17643 \begin_inset Flex Code
17646 \begin_layout Plain Layout
17657 \begin_layout Itemize
17659 \begin_inset Flex Code
17662 \begin_layout Plain Layout
17668 ): These can be used to define custom collapsible insets, similar to \SpecialChar TeX
17670 footnote, and the like.
17671 An obvious example is an endnote inset, which is defined in the
17672 \begin_inset Flex Code
17675 \begin_layout Plain Layout
17684 \begin_layout Itemize
17686 \begin_inset Flex Code
17689 \begin_layout Plain Layout
17695 ): For use with DocBook classes.
17698 \begin_layout Standard
17699 Flex insets are defined using the
17700 \begin_inset Flex Code
17703 \begin_layout Plain Layout
17709 tag, which shall be explained in a moment.
17712 \begin_layout Standard
17714 \begin_inset Flex Code
17717 \begin_layout Plain Layout
17723 tag also serves another function: It can be used to customize the general
17724 layout of many different types of insets.
17726 \begin_inset Flex Code
17729 \begin_layout Plain Layout
17735 can be used to customize the layout parameters for footnotes, marginal
17736 notes, note insets, \SpecialChar TeX
17737 code (ERT) insets, branches, listings, indexes, boxes,
17738 tables, algorithms, URLs, and captions, as well as to define Flex insets.
17741 \begin_layout Standard
17743 \begin_inset Flex Code
17746 \begin_layout Plain Layout
17752 definition must begin with a line of the form:
17755 \begin_layout LyX-Code
17759 \begin_layout Standard
17761 \begin_inset Flex Code
17764 \begin_layout Plain Layout
17770 indicates the inset whose layout is being defined, and here there are four
17774 \begin_layout Enumerate
17775 The layout for a pre-existing inset is being modified.
17776 In this case, can be
17777 \begin_inset Flex Code
17780 \begin_layout Plain Layout
17786 any one of the following:
17787 \begin_inset Flex Code
17790 \begin_layout Plain Layout
17797 \begin_inset Flex Code
17800 \begin_layout Plain Layout
17807 \begin_inset Flex Code
17810 \begin_layout Plain Layout
17817 \begin_inset Flex Code
17820 \begin_layout Plain Layout
17827 \begin_inset Flex Code
17830 \begin_layout Plain Layout
17837 \begin_inset Flex Code
17840 \begin_layout Plain Layout
17847 \begin_inset Flex Code
17850 \begin_layout Plain Layout
17857 \begin_inset Flex Code
17860 \begin_layout Plain Layout
17867 \begin_inset Flex Code
17870 \begin_layout Plain Layout
17877 \begin_inset Flex Code
17880 \begin_layout Plain Layout
17887 \begin_inset Flex Code
17890 \begin_layout Plain Layout
17897 \begin_inset Flex Code
17900 \begin_layout Plain Layout
17907 \begin_inset Flex Code
17910 \begin_layout Plain Layout
17917 \begin_inset Flex Code
17920 \begin_layout Plain Layout
17927 \begin_inset Flex Code
17930 \begin_layout Plain Layout
17937 \begin_inset Flex Code
17940 \begin_layout Plain Layout
17947 \begin_inset Flex Code
17950 \begin_layout Plain Layout
17957 \begin_inset Flex Code
17960 \begin_layout Plain Layout
17967 \begin_inset Flex Code
17970 \begin_layout Plain Layout
17977 \begin_inset Flex Code
17980 \begin_layout Plain Layout
17989 \begin_layout Enumerate
17990 The layout for a Flex inset is being defined.
17992 \begin_inset Flex Code
17995 \begin_layout Plain Layout
18001 must be of the form
18002 \begin_inset Quotes eld
18006 \begin_inset Flex Code
18009 \begin_layout Plain Layout
18016 \begin_inset Quotes erd
18020 \begin_inset Flex Code
18023 \begin_layout Plain Layout
18029 may be be any valid identifier not used by a pre-existing Flex inset.
18030 The identifier may include spaces, but in that case the whole thing must
18031 be wrapped in quotes.
18032 Note that the definition of a flex inset
18037 \begin_inset Flex Code
18040 \begin_layout Plain Layout
18046 entry, declaring which type of inset it defines.
18049 \begin_layout Enumerate
18050 The layout for user specific branch is being defined.
18052 \begin_inset Flex Code
18055 \begin_layout Plain Layout
18061 must be of the form
18062 \begin_inset Quotes eld
18066 \begin_inset Flex Code
18069 \begin_layout Plain Layout
18076 \begin_inset Quotes erd
18080 \begin_inset Flex Code
18083 \begin_layout Plain Layout
18089 may be be any valid identifier of branch defined in user's document.
18090 The identifier may include spaces, but in that case the whole thing must
18091 be wrapped in quotes.
18092 The main purpose of this feature is to allow \SpecialChar LaTeX
18093 wrapping around specific
18094 branches as user needs.
18097 \begin_layout Enumerate
18098 The layout of a user (or class) specific caption is being defined.
18100 \begin_inset Flex Code
18103 \begin_layout Plain Layout
18109 must be of the form
18110 \begin_inset Quotes eld
18114 \begin_inset Flex Code
18117 \begin_layout Plain Layout
18124 \begin_inset Quotes erd
18128 \begin_inset Flex Code
18131 \begin_layout Plain Layout
18137 specifies the name of the caption as it appears in the menu.
18138 Have a look at the standard caption (
18139 \begin_inset Flex Code
18142 \begin_layout Plain Layout
18148 ), the specific captions of the KOMA-Script classes (
18149 \begin_inset Flex Code
18152 \begin_layout Plain Layout
18159 \begin_inset Flex Code
18162 \begin_layout Plain Layout
18171 \begin_inset space ~
18175 \begin_inset Newline linebreak
18181 \begin_inset Flex Code
18184 \begin_layout Plain Layout
18190 ) for applications.
18193 \begin_layout Standard
18195 \begin_inset Flex Code
18198 \begin_layout Plain Layout
18204 definition can contain the following entries:
18207 \begin_layout Description
18208 \begin_inset Flex Code
18211 \begin_layout Plain Layout
18218 \begin_inset Flex Code
18221 \begin_layout Plain Layout
18227 =""] This inset will appear in the table of contents of the given type.
18228 An empty string disables.
18229 See also the OutlinerName and the IsTocCaption commands.
18230 This is only implemented for Flex insets.
18234 \begin_layout Description
18235 \begin_inset Flex Code
18238 \begin_layout Plain Layout
18245 \begin_inset Flex Code
18248 \begin_layout Plain Layout
18254 ] Defines argument number of a command\SpecialChar breakableslash
18255 environment associated with the current
18257 The definition must end with
18258 \begin_inset Flex Code
18261 \begin_layout Plain Layout
18269 \begin_inset CommandInset ref
18271 reference "subsec:Paragraph-Styles"
18278 \begin_layout Description
18279 \begin_inset Flex Code
18282 \begin_layout Plain Layout
18288 Preamble for changing language commands; see
18289 \begin_inset CommandInset ref
18291 reference "subsec:I18n"
18298 \begin_layout Description
18299 \begin_inset Flex Code
18302 \begin_layout Plain Layout
18309 \begin_inset Flex Code
18312 \begin_layout Plain Layout
18318 ] The color for the inset's background.
18320 \begin_inset CommandInset ref
18322 reference "chap:Names-of-colors"
18326 for a list of the available color names.
18329 \begin_layout Description
18330 \begin_inset Flex Code
18333 \begin_layout Plain Layout
18340 \begin_inset Flex Code
18343 \begin_layout Plain Layout
18352 \begin_inset space \thinspace{}
18356 \begin_inset Flex Code
18359 \begin_layout Plain Layout
18365 ] Whether to use the content of the inset as the label, when the inset is
18370 \begin_layout Description
18371 \begin_inset Flex Code
18374 \begin_layout Plain Layout
18381 \begin_inset Flex Code
18384 \begin_layout Plain Layout
18390 ] As with paragraph styles, see
18391 \begin_inset CommandInset ref
18393 reference "subsec:Paragraph-Styles"
18398 Note that you need to specify the complete type, e.
18399 \begin_inset space \thinspace{}
18403 \begin_inset space ~
18407 \begin_inset Flex Code
18410 \begin_layout Plain Layout
18411 CopyStyle Flex:<name>
18419 \begin_layout Description
18420 \begin_inset Flex Code
18423 \begin_layout Plain Layout
18430 \begin_inset Flex Code
18433 \begin_layout Plain Layout
18442 \begin_inset space \thinspace{}
18446 \begin_inset Flex Code
18449 \begin_layout Plain Layout
18455 ] Indicates whether the user may employ the Paragraph Settings dialog to
18456 customize the paragraph.
18459 \begin_layout Description
18460 \begin_inset Flex Code
18463 \begin_layout Plain Layout
18470 \begin_inset Flex Code
18473 \begin_layout Plain Layout
18480 \begin_inset Flex Code
18483 \begin_layout Plain Layout
18490 \begin_inset Flex Code
18493 \begin_layout Plain Layout
18499 , describing the rendering style used for the inset's frame and buttons.
18500 Footnotes generally use
18501 \begin_inset Flex Code
18504 \begin_layout Plain Layout
18510 , ERT insets generally
18511 \begin_inset Flex Code
18514 \begin_layout Plain Layout
18520 , and character styles
18521 \begin_inset Flex Code
18524 \begin_layout Plain Layout
18533 \begin_layout Description
18534 \begin_inset Flex Code
18537 \begin_layout Plain Layout
18544 \begin_inset Flex Code
18547 \begin_layout Plain Layout
18556 \begin_inset space \thinspace{}
18562 \begin_inset Flex Code
18565 \begin_layout Plain Layout
18574 \begin_inset Flex Code
18577 \begin_layout Plain Layout
18584 \begin_inset Flex Code
18587 \begin_layout Plain Layout
18594 Indicates whether the environment will stand on its own in the output or
18595 will appear inline with the surrounding text.
18596 If set to false, it is supposed that the \SpecialChar LaTeX
18597 environment ignores white space
18598 (including one newline character) after the
18599 \begin_inset Flex Code
18602 \begin_layout Plain Layout
18615 \begin_inset Flex Code
18618 \begin_layout Plain Layout
18634 \begin_layout Description
18635 \begin_inset Flex Code
18638 \begin_layout Plain Layout
18644 Required at the end of the
18645 \begin_inset Flex Code
18648 \begin_layout Plain Layout
18657 \begin_layout Description
18658 \begin_inset Flex Code
18661 \begin_layout Plain Layout
18667 The font used for both the text body
18673 \begin_inset CommandInset ref
18675 reference "subsec:Font-description"
18680 Note that defining this font automatically defines the
18681 \begin_inset Flex Code
18684 \begin_layout Plain Layout
18690 to the same value, so define this first and define
18691 \begin_inset Flex Code
18694 \begin_layout Plain Layout
18700 later if you want them to be different.
18703 \begin_layout Description
18704 \begin_inset Flex Code
18707 \begin_layout Plain Layout
18708 FixedWidthPreambleEncoding
18714 \begin_inset Flex Code
18717 \begin_layout Plain Layout
18726 \begin_inset space \thinspace{}
18730 \begin_inset Flex Code
18733 \begin_layout Plain Layout
18739 ] Force a fixed width encoding for the translated contents of
18740 \begin_inset Flex Code
18743 \begin_layout Plain Layout
18750 \begin_inset Flex Code
18753 \begin_layout Plain Layout
18759 code generated by this layout.
18760 This is needed for special \SpecialChar LaTeX
18765 that do not work with variable width encodings such as
18770 This setting is ignored if fully Unicode aware \SpecialChar LaTeX
18771 backends such as Xe\SpecialChar TeX
18773 Lua\SpecialChar TeX
18777 \begin_layout Description
18778 \begin_inset Flex Code
18781 \begin_layout Plain Layout
18782 ForceLocalFontSwitch
18788 \begin_inset Flex Code
18791 \begin_layout Plain Layout
18800 \begin_inset space \thinspace{}
18804 \begin_inset Flex Code
18807 \begin_layout Plain Layout
18813 ] When using babel, always use a local font switch (
18814 \begin_inset Flex Code
18817 \begin_layout Plain Layout
18825 ), never a global one (such as
18826 \begin_inset Flex Code
18829 \begin_layout Plain Layout
18840 \begin_layout Description
18841 \begin_inset Flex Code
18844 \begin_layout Plain Layout
18851 \begin_inset Flex Code
18854 \begin_layout Plain Layout
18863 \begin_inset space \thinspace{}
18867 \begin_inset Flex Code
18870 \begin_layout Plain Layout
18877 \begin_inset Quotes eld
18881 \begin_inset Quotes erd
18884 language, leading to Left-to-Right (Latin) output, e.
18885 \begin_inset space \thinspace{}
18889 \begin_inset space \space{}
18892 in \SpecialChar TeX
18897 \begin_layout Description
18898 \begin_inset Flex Code
18901 \begin_layout Plain Layout
18908 \begin_inset Flex Code
18911 \begin_layout Plain Layout
18920 \begin_inset space \thinspace{}
18924 \begin_inset Flex Code
18927 \begin_layout Plain Layout
18933 ] Force a a line break in the \SpecialChar LaTeX
18934 output before the inset starts and after
18936 This assures the inset itself is output on its own lines, for parsing purposes.
18939 \begin_layout Description
18940 \begin_inset Flex Code
18943 \begin_layout Plain Layout
18950 \begin_inset Flex Code
18953 \begin_layout Plain Layout
18962 \begin_inset space \thinspace{}
18966 \begin_inset Flex Code
18969 \begin_layout Plain Layout
18975 ] Indicates whether the
18976 \begin_inset Flex Code
18979 \begin_layout Plain Layout
18985 should be used or, instead, the user can change the paragraph style used
18990 \begin_layout Description
18991 \begin_inset Flex Code
18994 \begin_layout Plain Layout
19001 \begin_inset Flex Code
19004 \begin_layout Plain Layout
19013 \begin_inset space \thinspace{}
19017 \begin_inset Flex Code
19020 \begin_layout Plain Layout
19026 ] As with paragraph styles, see
19027 \begin_inset CommandInset ref
19029 reference "subsec:Paragraph-Styles"
19036 \begin_layout Description
19037 \begin_inset Flex Code
19040 \begin_layout Plain Layout
19046 These tags control the XHTML output.
19048 \begin_inset CommandInset ref
19050 reference "sec:Tags-for-XHTML"
19057 \begin_layout Description
19058 \begin_inset Flex Code
19061 \begin_layout Plain Layout
19068 \begin_inset Flex Code
19071 \begin_layout Plain Layout
19080 \begin_inset space \thinspace{}
19084 \begin_inset Flex Code
19087 \begin_layout Plain Layout
19093 ] Whether to include the contents of this inset in the strings generated
19094 for the `Outline' pane for all table of contents, regardless of the AddToToc
19096 One would not, for example, want the content of a footnote in a section
19097 header to be included in the TOC displayed in the outline, but one would
19098 normally want the content of a character style displayed.
19099 Default is false: not to include.
19102 \begin_layout Description
19103 \begin_inset Flex Code
19106 \begin_layout Plain Layout
19113 \begin_inset Flex Code
19116 \begin_layout Plain Layout
19125 \begin_inset space \thinspace{}
19129 \begin_inset Flex Code
19132 \begin_layout Plain Layout
19138 ] If this is set to 1 and AddToToc is enabled, the inset adds a summary
19139 of its contents in its item in the table of contents.
19140 Otherwise, only the label appears.
19143 \begin_layout Description
19144 \begin_inset Flex Code
19147 \begin_layout Plain Layout
19156 \begin_inset Flex Code
19159 \begin_layout Plain Layout
19168 \begin_inset space \thinspace{}
19172 \begin_inset Flex Code
19175 \begin_layout Plain Layout
19181 ] As with paragraph styles, see
19182 \begin_inset CommandInset ref
19184 reference "subsec:Paragraph-Styles"
19191 \begin_layout Description
19192 \begin_inset Flex Code
19195 \begin_layout Plain Layout
19201 The font used for the label.
19203 \begin_inset CommandInset ref
19205 reference "subsec:Font-description"
19210 Note that this definition can never appear before
19211 \begin_inset Flex Code
19214 \begin_layout Plain Layout
19220 , lest it be ineffective.
19223 \begin_layout Description
19224 \begin_inset Flex Code
19227 \begin_layout Plain Layout
19234 \begin_inset Flex Code
19237 \begin_layout Plain Layout
19244 \begin_inset Quotes erd
19248 \begin_inset Quotes erd
19251 ] What will be displayed on the button or elsewhere as the inset label.
19253 \begin_inset Flex Code
19256 \begin_layout Plain Layout
19264 \begin_inset Flex Code
19267 \begin_layout Plain Layout
19273 ) modify this label on the fly.
19276 \begin_layout Description
19277 \begin_inset Flex Code
19280 \begin_layout Plain Layout
19286 Language dependent preamble; see
19287 \begin_inset CommandInset ref
19289 reference "subsec:I18n"
19296 \begin_layout Description
19297 \begin_inset Flex Code
19300 \begin_layout Plain Layout
19307 \begin_inset Flex Code
19310 \begin_layout Plain Layout
19316 ] The name of the corresponding \SpecialChar LaTeX
19318 Either the environment or command name.
19321 \begin_layout Description
19322 \begin_inset Flex Code
19325 \begin_layout Plain Layout
19332 \begin_inset Flex Code
19335 \begin_layout Plain Layout
19341 ] The optional parameter for the corresponding
19342 \begin_inset Flex Code
19345 \begin_layout Plain Layout
19351 stuff, including possible bracket pairs like
19352 \begin_inset Flex Code
19355 \begin_layout Plain Layout
19362 This parameter cannot be changed from within \SpecialChar LyX
19364 \begin_inset Flex Code
19367 \begin_layout Plain Layout
19373 for customizable parameters).
19374 It will be output as is after all \SpecialChar LaTeX
19376 \begin_inset Flex Code
19379 \begin_layout Plain Layout
19388 \begin_layout Description
19389 \begin_inset Flex Code
19392 \begin_layout Plain Layout
19399 \begin_inset Flex Code
19402 \begin_layout Plain Layout
19403 Command, Environment, None
19408 ] How the style should be translated into \SpecialChar LaTeX
19413 \begin_layout Plain Layout
19414 \begin_inset Flex Code
19417 \begin_layout Plain Layout
19423 is perhaps a bit misleading, since these rules apply to SGML classes too.
19424 Visit the SGML class files for specific examples.
19433 \begin_layout Description
19434 \begin_inset Flex Code
19437 \begin_layout Plain Layout
19443 means nothing special
19446 \begin_layout Description
19447 \begin_inset Flex Code
19450 \begin_layout Plain Layout
19457 \begin_inset Flex Code
19460 \begin_layout Plain Layout
19467 {\SpecialChar ldots
19476 \begin_layout Description
19477 \begin_inset Flex Code
19480 \begin_layout Plain Layout
19487 \begin_inset Flex Code
19490 \begin_layout Plain Layout
19497 }\SpecialChar ldots
19512 \begin_layout Standard
19513 Putting the last few things together, the \SpecialChar LaTeX
19514 output will be either:
19517 \begin_layout LyX-Code
19520 LatexName[LatexParam]{\SpecialChar ldots
19524 \begin_layout Standard
19528 \begin_layout LyX-Code
19531 begin{LatexName}[LatexParam] \SpecialChar ldots
19537 \begin_layout Standard
19538 depending upon the \SpecialChar LaTeX
19543 \begin_layout Description
19544 \begin_inset Flex Code
19547 \begin_layout Plain Layout
19554 \begin_inset Flex Code
19557 \begin_layout Plain Layout
19563 ] A string that is put at the beginning of the layout content.
19564 A line break in the output can be indicated by
19565 \begin_inset Flex Code
19568 \begin_layout Plain Layout
19577 \begin_layout Description
19578 \begin_inset Flex Code
19581 \begin_layout Plain Layout
19588 \begin_inset Flex Code
19591 \begin_layout Plain Layout
19598 \begin_inset Flex Code
19601 \begin_layout Plain Layout
19608 \begin_inset Flex Code
19611 \begin_layout Plain Layout
19618 \begin_inset Flex Code
19621 \begin_layout Plain Layout
19627 (indicating a dummy definition ending definitions of charstyles, etc).
19628 This entry is required in and is only meaningful for Flex insets.
19629 Among other things, it determines on which menu this inset will appear.
19631 \begin_inset Flex Code
19634 \begin_layout Plain Layout
19641 \begin_inset Flex Code
19644 \begin_layout Plain Layout
19650 will automatically set
19651 \begin_inset Flex Code
19654 \begin_layout Plain Layout
19661 \begin_inset Flex Code
19664 \begin_layout Plain Layout
19672 \begin_inset Flex Code
19675 \begin_layout Plain Layout
19681 can be set to true, or
19682 \begin_inset Flex Code
19685 \begin_layout Plain Layout
19692 \begin_inset Flex Code
19695 \begin_layout Plain Layout
19701 insets by setting it
19706 \begin_inset Flex Code
19709 \begin_layout Plain Layout
19718 \begin_layout Description
19719 \begin_inset Flex Code
19722 \begin_layout Plain Layout
19729 \begin_inset Flex Code
19732 \begin_layout Plain Layout
19741 \begin_inset space \thinspace{}
19745 \begin_inset Flex Code
19748 \begin_layout Plain Layout
19754 ] Whether multiple paragraphs are permitted in this inset.
19756 \begin_inset Flex Code
19759 \begin_layout Plain Layout
19765 to the same value and
19766 \begin_inset Flex Code
19769 \begin_layout Plain Layout
19775 to the opposite value.
19776 These can be reset to other values, if they are used
19781 \begin_inset Flex Code
19784 \begin_layout Plain Layout
19794 \begin_layout Description
19795 \begin_inset Flex Code
19798 \begin_layout Plain Layout
19805 \begin_inset Flex Code
19808 \begin_layout Plain Layout
19817 \begin_inset space \thinspace{}
19821 \begin_inset Flex Code
19824 \begin_layout Plain Layout
19830 ] Whether fragile commands in this inset should be
19831 \begin_inset Flex Code
19834 \begin_layout Plain Layout
19847 whether the command should itself be protected.) Default is false.
19848 \change_inserted -712698321 1523633958
19852 \begin_layout Description
19854 \change_inserted -712698321 1523634088
19855 \begin_inset Flex Code
19858 \begin_layout Plain Layout
19860 \change_inserted -712698321 1523633961
19867 \begin_inset Flex Code
19870 \begin_layout Plain Layout
19872 \change_inserted -712698321 1523633958
19881 \begin_inset space \thinspace{}
19885 \begin_inset Flex Code
19888 \begin_layout Plain Layout
19890 \change_inserted -712698321 1523633958
19896 ] This causes macros that contain this inset to be protected with
19897 \begin_inset Flex Code
19900 \begin_layout Plain Layout
19902 \change_inserted -712698321 1523634038
19917 ) if necessary and thus allows (some) verbatim stuff in macros.
19923 \begin_layout Description
19924 \begin_inset Flex Code
19927 \begin_layout Plain Layout
19934 \begin_inset Flex Code
19937 \begin_layout Plain Layout
19943 ] Deletes an existing
19944 \begin_inset Flex Code
19947 \begin_layout Plain Layout
19956 \begin_layout Description
19957 \begin_inset Flex Code
19960 \begin_layout Plain Layout
19967 \begin_inset Flex Code
19970 \begin_layout Plain Layout
19977 \begin_inset Flex Code
19980 \begin_layout Plain Layout
19986 that has replaced this
19987 \begin_inset Flex Code
19990 \begin_layout Plain Layout
19997 This is used to rename an
19998 \begin_inset Flex Code
20001 \begin_layout Plain Layout
20007 , while keeping backward compatibility.
20010 \begin_layout Description
20011 \begin_inset Flex Code
20014 \begin_layout Plain Layout
20021 \begin_inset Flex Code
20024 \begin_layout Plain Layout
20033 \begin_inset space \thinspace{}
20037 \begin_inset Flex Code
20040 \begin_layout Plain Layout
20046 ] As with paragraph styles, see
20047 \begin_inset CommandInset ref
20049 reference "subsec:Paragraph-Styles"
20057 \begin_layout Description
20058 \begin_inset Flex Code
20061 \begin_layout Plain Layout
20068 \begin_inset Flex Code
20071 \begin_layout Plain Layout
20080 \begin_inset space \thinspace{}
20084 \begin_inset Flex Code
20087 \begin_layout Plain Layout
20093 ] As with paragraph styles, see
20094 \begin_inset CommandInset ref
20096 reference "subsec:Paragraph-Styles"
20104 \begin_layout Description
20105 \begin_inset Flex Code
20108 \begin_layout Plain Layout
20114 As with paragraph styles, see
20115 \begin_inset CommandInset ref
20117 reference "subsec:Paragraph-Styles"
20124 \begin_layout Description
20125 \begin_inset Flex Code
20128 \begin_layout Plain Layout
20135 \begin_inset Flex Code
20138 \begin_layout Plain Layout
20144 ] The prefix to use when creating labels referring to insets of this type.
20145 This allows the use of formatted references.
20148 \begin_layout Description
20149 \begin_inset Flex Code
20152 \begin_layout Plain Layout
20159 \begin_inset Flex Code
20162 \begin_layout Plain Layout
20168 ] As with paragraph styles, see
20169 \begin_inset CommandInset ref
20171 reference "subsec:Paragraph-Styles"
20178 \begin_layout Description
20179 \begin_inset Flex Code
20182 \begin_layout Plain Layout
20189 \begin_inset Flex Code
20192 \begin_layout Plain Layout
20201 \begin_inset space \thinspace{}
20205 \begin_inset Flex Code
20208 \begin_layout Plain Layout
20214 ] Resets the \SpecialChar LaTeX
20215 arguments of this layout (as defined via the
20216 \begin_inset Flex Code
20219 \begin_layout Plain Layout
20226 This is useful if you have copied a style via
20227 \begin_inset Flex Code
20230 \begin_layout Plain Layout
20236 , but you do not want to inherit its (required and optional) arguments.
20239 \begin_layout Description
20240 \begin_inset Flex Code
20243 \begin_layout Plain Layout
20250 \begin_inset Flex Code
20253 \begin_layout Plain Layout
20260 \begin_inset space \thinspace{}
20264 \begin_inset Flex Code
20267 \begin_layout Plain Layout
20275 ] Whether this inset should use the font of its surrounding environment
20277 Default is false: use the font of the surrounding environment.
20280 \begin_layout Description
20281 \begin_inset Flex Code
20284 \begin_layout Plain Layout
20291 \begin_inset Flex Code
20294 \begin_layout Plain Layout
20300 ] A string that is put at the end of the layout content.
20301 A line break in the output can be indicated by
20302 \begin_inset Flex Code
20305 \begin_layout Plain Layout
20314 \begin_layout Description
20315 \begin_inset Flex Code
20318 \begin_layout Plain Layout
20325 \begin_inset Flex Code
20328 \begin_layout Plain Layout
20335 \begin_inset space \thinspace{}
20339 \begin_inset Flex Code
20342 \begin_layout Plain Layout
20350 ] Allow spell-checking the contents of this inset.
20354 \begin_layout Subsection
20356 \begin_inset CommandInset label
20358 name "subsec:Counters"
20365 \begin_layout Standard
20366 It is necessary to define the counters (
20367 \begin_inset Flex Noun
20370 \begin_layout Plain Layout
20377 \begin_inset Flex Noun
20380 \begin_layout Plain Layout
20386 , \SpecialChar ldots
20387 ) in the text class itself.
20388 The standard counters are defined in the file
20389 \begin_inset Flex Code
20392 \begin_layout Plain Layout
20398 , so you may have to do no more than add
20401 \begin_layout LyX-Code
20402 Input stdcounters.inc
20405 \begin_layout Standard
20406 to your layout file to get them to work.
20407 But if you want to define custom counters, then you can do so.
20408 The counter declaration must begin with:
20411 \begin_layout LyX-Code
20412 Counter CounterName
20415 \begin_layout Standard
20417 \begin_inset Flex Code
20420 \begin_layout Plain Layout
20426 ' is replaced by the name of the counter.
20427 And it must end with
20428 \begin_inset Quotes eld
20432 \begin_inset Flex Code
20435 \begin_layout Plain Layout
20442 \begin_inset Quotes erd
20446 The following parameters can also be used:
20449 \begin_layout Description
20450 \begin_inset Flex Code
20453 \begin_layout Plain Layout
20460 \begin_inset Flex Code
20463 \begin_layout Plain Layout
20469 ] Sets the initial value for the counter, to which it will be reset whenever
20471 Normally, one will want the default, 1.
20474 \begin_layout Description
20475 \begin_inset Flex Code
20478 \begin_layout Plain Layout
20485 \begin_inset Flex Code
20488 \begin_layout Plain Layout
20495 \begin_inset Quotes erd
20499 \begin_inset Quotes erd
20502 ] When defined, this string defines how the counter is displayed.
20503 Setting this value sets
20504 \begin_inset Flex Code
20507 \begin_layout Plain Layout
20508 LabelStringAppendix
20514 The following special constructs can be used in the string:
20518 \begin_layout Itemize
20519 \begin_inset Flex Code
20522 \begin_layout Plain Layout
20530 will be replaced by the expansion of the
20531 \begin_inset Flex Code
20534 \begin_layout Plain Layout
20541 \begin_inset Flex Code
20544 \begin_layout Plain Layout
20545 LabelStringAppendix
20551 \begin_inset Flex Code
20554 \begin_layout Plain Layout
20564 \begin_layout Itemize
20565 counter values can be expressed using \SpecialChar LaTeX
20567 \begin_inset Newline newline
20571 \begin_inset Flex Code
20574 \begin_layout Plain Layout
20591 \begin_inset Flex Code
20594 \begin_layout Plain Layout
20606 \begin_layout Plain Layout
20616 Actually, the situation is a bit more complicated: any
20635 other than those described below will produce arabic numerals.
20636 It would not be surprising to see this change in the future.
20642 \begin_inset Flex Code
20645 \begin_layout Plain Layout
20651 : 1, 2, 3,\SpecialChar ldots
20653 \begin_inset Flex Code
20656 \begin_layout Plain Layout
20662 for lower-case letters: a, b, c, \SpecialChar ldots
20664 \begin_inset Flex Code
20667 \begin_layout Plain Layout
20673 for upper-case letters: A, B, C, \SpecialChar ldots
20675 \begin_inset Flex Code
20678 \begin_layout Plain Layout
20684 for lower-case roman numerals: i, ii, iii, \SpecialChar ldots
20686 \begin_inset Flex Code
20689 \begin_layout Plain Layout
20695 for upper-case roman numerals: I, II, III\SpecialChar ldots
20697 \begin_inset Flex Code
20700 \begin_layout Plain Layout
20706 for hebrew numerals.
20710 \begin_layout Standard
20711 If LabelString is not defined, a default value is constructed as follows:
20712 if the counter has a master counter
20713 \begin_inset Flex Code
20716 \begin_layout Plain Layout
20723 \begin_inset Flex Code
20726 \begin_layout Plain Layout
20733 \begin_inset Newline newline
20737 \begin_inset Flex Code
20740 \begin_layout Plain Layout
20750 is used; otherwise the string
20751 \begin_inset Flex Code
20754 \begin_layout Plain Layout
20765 \begin_layout Description
20766 \begin_inset Flex Code
20769 \begin_layout Plain Layout
20770 LabelStringAppendix
20776 \begin_inset Flex Code
20779 \begin_layout Plain Layout
20786 \begin_inset Quotes erd
20790 \begin_inset Quotes erd
20794 \begin_inset Flex Code
20797 \begin_layout Plain Layout
20803 , but for use in the Appendix.
20806 \begin_layout Description
20807 \begin_inset Flex Code
20810 \begin_layout Plain Layout
20817 \begin_inset Flex Code
20820 \begin_layout Plain Layout
20827 \begin_inset Quotes erd
20831 \begin_inset Quotes erd
20834 ] A format for use with formatted references to this counter.
20835 For example, one might want to have references to section numbers appear
20837 \begin_inset Quotes eld
20841 \begin_inset Quotes erd
20845 The string should contain
20846 \begin_inset Quotes eld
20850 \begin_inset Quotes erd
20854 This will be replaced by the counter number itself.
20855 So, for sections, it would be: Section ##.
20858 \begin_layout Description
20859 \begin_inset Flex Code
20862 \begin_layout Plain Layout
20869 \begin_inset Flex Code
20872 \begin_layout Plain Layout
20879 \begin_inset Quotes erd
20883 \begin_inset Quotes erd
20886 ] If this is set to the name of another counter, the present counter will
20887 be reset every time the other one is increased.
20889 \begin_inset Flex Code
20892 \begin_layout Plain Layout
20899 \begin_inset Flex Code
20902 \begin_layout Plain Layout
20911 \begin_layout Subsection
20913 \begin_inset CommandInset label
20915 name "subsec:Font-description"
20922 \begin_layout Standard
20923 A font description looks like this:
20926 \begin_layout LyX-Code
20943 \begin_layout LyX-Code
20947 \begin_layout LyX-Code
20951 \begin_layout Standard
20952 The following commands are available:
20955 \begin_layout Description
20956 \begin_inset Flex Code
20959 \begin_layout Plain Layout
20966 \begin_inset Flex Code
20969 \begin_layout Plain Layout
20978 \begin_inset Flex Code
20981 \begin_layout Plain Layout
20988 \begin_inset Flex Code
20991 \begin_layout Plain Layout
20998 \begin_inset Flex Code
21001 \begin_layout Plain Layout
21008 \begin_inset Flex Code
21011 \begin_layout Plain Layout
21018 \begin_inset Flex Code
21021 \begin_layout Plain Layout
21028 \begin_inset Flex Code
21031 \begin_layout Plain Layout
21038 \begin_inset Flex Code
21041 \begin_layout Plain Layout
21048 \begin_inset Flex Code
21051 \begin_layout Plain Layout
21058 \begin_inset Flex Code
21061 \begin_layout Plain Layout
21068 \begin_inset Flex Code
21071 \begin_layout Plain Layout
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
21118 \begin_inset Flex Code
21121 \begin_layout Plain Layout
21128 \begin_inset Flex Code
21131 \begin_layout Plain Layout
21138 \begin_inset Flex Code
21141 \begin_layout Plain Layout
21148 \begin_inset Flex Code
21151 \begin_layout Plain Layout
21158 \begin_inset Flex Code
21161 \begin_layout Plain Layout
21170 \begin_layout Description
21171 \begin_inset Flex Code
21174 \begin_layout Plain Layout
21181 \begin_inset Flex Code
21184 \begin_layout Plain Layout
21193 \begin_inset Flex Code
21196 \begin_layout Plain Layout
21203 \begin_inset Flex Code
21206 \begin_layout Plain Layout
21215 \begin_layout Description
21216 \begin_inset Flex Code
21219 \begin_layout Plain Layout
21226 \begin_inset Flex Code
21229 \begin_layout Plain Layout
21235 ] Valid arguments are:
21236 \begin_inset Flex Code
21239 \begin_layout Plain Layout
21246 \begin_inset Flex Code
21249 \begin_layout Plain Layout
21256 \begin_inset Flex Code
21259 \begin_layout Plain Layout
21266 \begin_inset Flex Code
21269 \begin_layout Plain Layout
21276 \begin_inset Flex Code
21279 \begin_layout Plain Layout
21286 \begin_inset Flex Code
21289 \begin_layout Plain Layout
21296 \begin_inset Flex Code
21299 \begin_layout Plain Layout
21306 \begin_inset Flex Code
21309 \begin_layout Plain Layout
21316 \begin_inset Flex Code
21319 \begin_layout Plain Layout
21326 \begin_inset Flex Code
21329 \begin_layout Plain Layout
21336 \begin_inset Flex Code
21339 \begin_layout Plain Layout
21346 \begin_inset Flex Code
21349 \begin_layout Plain Layout
21356 Each of these turns on or off the corresponding attribute.
21358 \begin_inset Flex Code
21361 \begin_layout Plain Layout
21367 turns on emphasis, and
21368 \begin_inset Flex Code
21371 \begin_layout Plain Layout
21379 \begin_inset Newline newline
21382 If the latter seems puzzling, remember that the font settings for the present
21383 context are generally inherited from the surrounding context.
21385 \begin_inset Flex Code
21388 \begin_layout Plain Layout
21394 would turn off the emphasis that was anyway in effect, say, in a theorem
21398 \begin_layout Description
21399 \begin_inset Flex Code
21402 \begin_layout Plain Layout
21409 \begin_inset Flex Code
21412 \begin_layout Plain Layout
21421 \begin_inset Flex Code
21424 \begin_layout Plain Layout
21433 \begin_layout Description
21434 \begin_inset Flex Code
21437 \begin_layout Plain Layout
21444 \begin_inset Flex Code
21447 \begin_layout Plain Layout
21456 \begin_inset Flex Code
21459 \begin_layout Plain Layout
21466 \begin_inset Flex Code
21469 \begin_layout Plain Layout
21476 \begin_inset Flex Code
21479 \begin_layout Plain Layout
21488 \begin_layout Description
21489 \begin_inset Flex Code
21492 \begin_layout Plain Layout
21499 \begin_inset Flex Code
21502 \begin_layout Plain Layout
21509 \begin_inset Flex Code
21512 \begin_layout Plain Layout
21519 \begin_inset Flex Code
21522 \begin_layout Plain Layout
21531 \begin_inset Flex Code
21534 \begin_layout Plain Layout
21541 \begin_inset Flex Code
21544 \begin_layout Plain Layout
21551 \begin_inset Flex Code
21554 \begin_layout Plain Layout
21561 \begin_inset Flex Code
21564 \begin_layout Plain Layout
21571 \begin_inset Flex Code
21574 \begin_layout Plain Layout
21583 \begin_layout Subsection
21584 \begin_inset CommandInset label
21586 name "subsec:Citation-engine-description"
21590 Cite engine description
21593 \begin_layout Standard
21595 \begin_inset Flex Code
21598 \begin_layout Plain Layout
21604 blocks, as used mainly in cite engine files (see
21605 \begin_inset CommandInset ref
21607 reference "subsec:Cite-Engine-Files"
21614 ), define the citation commands provided by a specific
21615 \begin_inset Quotes eld
21619 \begin_inset Quotes erd
21623 A cite engine, in \SpecialChar LyX
21624 terms, is way specific way to format citations, using
21625 numbers, author names and/or years.
21626 Currently, \SpecialChar LyX
21627 supports three such engine types, namely:
21630 \begin_layout Enumerate
21631 \begin_inset Flex Code
21634 \begin_layout Plain Layout
21640 : the default Bib\SpecialChar TeX
21641 way to format citations, a simple numeric style (e.
21642 \begin_inset space \thinspace{}
21646 \begin_inset Quotes eld
21650 \begin_inset Quotes erd
21656 \begin_layout Enumerate
21657 \begin_inset Flex Code
21660 \begin_layout Plain Layout
21666 : Harvard-styled citations using author names and publication year (e.
21667 \begin_inset space \thinspace{}
21671 \begin_inset Quotes eld
21674 Smith and Miller (2017b)
21675 \begin_inset Quotes erd
21681 \begin_layout Enumerate
21682 \begin_inset Flex Code
21685 \begin_layout Plain Layout
21691 : extended numerical citations that also allow for author or title next
21693 \begin_inset space \thinspace{}
21697 \begin_inset Quotes eld
21700 Smith and Miller [1]
21701 \begin_inset Quotes erd
21707 \begin_layout Standard
21708 \begin_inset Flex Code
21711 \begin_layout Plain Layout
21717 blocks look like this:
21720 \begin_layout LyX-Code
21724 \begin_layout LyX-Code
21728 \begin_layout LyX-Code
21732 \begin_layout LyX-Code
21733 citeyearpar[][]=parencite*
21736 \begin_layout LyX-Code
21740 \begin_layout LyX-Code
21744 \begin_layout Standard
21746 \begin_inset Flex Code
21749 \begin_layout Plain Layout
21755 denotes the engine.
21756 The individual lines respectively define a cite command or cite command
21757 paradigm supported by this engine.
21758 The line can be as simple as a cite command that is used both to name the
21759 respective \SpecialChar LyX
21760 command and the \SpecialChar LaTeX
21761 output or more complex in order to differentiate
21763 The full syntax is:
21766 \begin_layout LyX-Code
21767 LyXName|alias$*<!_stardesc!_stardesctooltip>[][]=latexcmd
21770 \begin_layout Itemize
21771 \begin_inset Flex Code
21774 \begin_layout Plain Layout
21780 : The name as used in the
21781 \begin_inset Flex Code
21784 \begin_layout Plain Layout
21794 \begin_layout Standard
21795 For portability reasons, we try to use the same name for same-formatted
21796 commands in different cite packages (thus many names stem from natbib,
21797 and thus we need to differentiate a
21798 \begin_inset Flex Code
21801 \begin_layout Plain Layout
21807 sometimes, if the \SpecialChar LaTeX
21808 command names differ).
21812 \begin_layout Itemize
21813 \begin_inset Flex Code
21816 \begin_layout Plain Layout
21822 : a (comma-separated) list of commands that fall back to the given
21823 \begin_inset Flex Code
21826 \begin_layout Plain Layout
21832 in the current engine.
21833 This eases the switch of citation packages and engines.
21835 \begin_inset Flex Code
21838 \begin_layout Plain Layout
21845 \begin_inset Flex Code
21848 \begin_layout Plain Layout
21854 in layout definitions.
21857 \begin_layout Itemize
21858 \begin_inset Flex Code
21861 \begin_layout Plain Layout
21867 : The actual \SpecialChar LaTeX
21868 command that is output.
21872 \begin_layout Standard
21873 \begin_inset Flex Code
21876 \begin_layout Plain Layout
21883 \begin_inset Flex Code
21886 \begin_layout Plain Layout
21894 \begin_inset Flex Code
21897 \begin_layout Plain Layout
21904 \begin_inset Flex Code
21907 \begin_layout Plain Layout
21913 will be output to \SpecialChar LaTeX
21917 \begin_layout Standard
21921 \begin_layout Itemize
21922 Capitalization indicates that the command also has a capitalized form (
21923 \begin_inset Flex Code
21926 \begin_layout Plain Layout
21936 \begin_inset Flex Code
21939 \begin_layout Plain Layout
21948 These usually enforce up-casing of name prefixes (
21953 \begin_inset Formula $\Rightarrow$
21963 \begin_layout Itemize
21965 \begin_inset Flex Code
21968 \begin_layout Plain Layout
21974 indicate the number of optional arguments (there can be 0–2).
21977 \begin_layout Itemize
21979 \begin_inset Flex Code
21982 \begin_layout Plain Layout
21988 indicates there is a starred version of the command (
21989 \begin_inset Flex Code
21992 \begin_layout Plain Layout
22002 \begin_inset Flex Code
22005 \begin_layout Plain Layout
22018 \begin_layout Standard
22019 By default, the starred version means: Output all authors even if it should
22021 \begin_inset Quotes eld
22025 \begin_inset Quotes erd
22029 \begin_inset Flex Code
22032 \begin_layout Plain Layout
22041 \begin_layout Standard
22042 If the star has a different meaning for a given command, it can be specified
22044 \begin_inset Flex Code
22047 \begin_layout Plain Layout
22048 <!_stardesc!_stardesctooltip>
22054 Maximal two translatable macro keywords, marked by the prefix
22055 \begin_inset Flex Code
22058 \begin_layout Plain Layout
22065 The first points to the string that replaces the
22066 \begin_inset Quotes eld
22070 \begin_inset Quotes erd
22073 checkbox label in the citation dialog, the second one to an optional tool
22074 tip for this checkbox.
22078 \begin_layout Standard
22079 Note that these two macros have to be defined in a
22080 \begin_inset Flex Code
22083 \begin_layout Plain Layout
22089 (see next section), dropping the
22090 \begin_inset Flex Code
22093 \begin_layout Plain Layout
22099 from the prefix, like this:
22102 \begin_layout LyX-Code
22103 _stardesc Sta&rred command label
22106 \begin_layout LyX-Code
22107 _stardesctooltip Tooltip for the starred command checkbox.
22111 \begin_layout Itemize
22113 \begin_inset Flex Code
22116 \begin_layout Plain Layout
22122 indicates that this command features
22123 \begin_inset Quotes eld
22126 qualified citation lists
22127 \begin_inset Quotes erd
22135 -specific feature for multi-reference citations where an individual pre-
22136 and postnote can be given to each reference in the list.
22137 Please refer to the
22141 manual for details.
22144 \begin_layout Subsection
22145 \begin_inset CommandInset label
22147 name "subsec:Citation-format-description"
22151 Cite format description
22154 \begin_layout Standard
22156 \begin_inset Flex Code
22159 \begin_layout Plain Layout
22165 blocks are used to describe how bibliographic information should be displayed,
22166 both within \SpecialChar LyX
22167 itself (in the citation dialog and in tooltips, for example)
22168 and in XHTML output.
22169 Such a block might look like this:
22172 \begin_layout LyX-Code
22176 \begin_layout LyX-Code
22180 \begin_layout LyX-Code
22184 \begin_layout LyX-Code
22188 \begin_layout Standard
22192 \begin_layout LyX-Code
22196 \begin_layout LyX-Code
22200 \begin_layout LyX-Code
22204 \begin_layout LyX-Code
22208 \begin_layout Standard
22209 In the first case, the individual lines define how the bibliographic information
22210 associated with an article or book, respectively, is to be displayed, and
22211 such a definition can be given for any
22212 \begin_inset Quotes els
22216 \begin_inset Quotes ers
22219 that might be present in a Bib\SpecialChar TeX
22222 defines a default format in the source code that will be used if no specific
22223 definition has been given.
22225 predefines several formats in the file
22226 \begin_inset Flex Code
22229 \begin_layout Plain Layout
22235 , which is included in most of \SpecialChar LyX
22236 's document classes.
22239 \begin_layout Standard
22240 In the second case, the lines define how a specific citation command (in
22242 \begin_inset Flex Code
22245 \begin_layout Plain Layout
22254 \begin_inset Flex Code
22257 \begin_layout Plain Layout
22265 ) is to be displayed on the citation inset label, in the citation dialog,
22266 menu or XHTML output.
22268 defines such formats for the citation style variants it supports via
22270 Document\SpecialChar menuseparator
22271 Setting\SpecialChar menuseparator
22272 Bibliography\SpecialChar ldots
22276 \begin_inset Flex Code
22279 \begin_layout Plain Layout
22285 files that are shipped with \SpecialChar LyX
22287 \begin_inset CommandInset ref
22289 reference "subsec:Cite-Engine-Files"
22299 \begin_layout Standard
22300 The definitions use a simple language that allows Bib\SpecialChar TeX
22301 keys to be replaced
22303 Keys should be enclosed in
22304 \begin_inset Flex Code
22307 \begin_layout Plain Layout
22314 \begin_inset Flex Code
22317 \begin_layout Plain Layout
22324 So a simple definition might look like this:
22327 \begin_layout LyX-Code
22329 \begin_inset Quotes eld
22333 \begin_inset Quotes erd
22339 \begin_layout Standard
22340 This would print the author, followed by a comma, followed by the title,
22341 in quotes, followed by a period.
22344 \begin_layout Standard
22345 Of course, sometimes you may want to print a key only if it exists.
22346 This can be done by using a conditional construction, such as:
22347 \begin_inset Flex Code
22350 \begin_layout Plain Layout
22352 \begin_inset space ~
22362 \begin_inset Flex Code
22365 \begin_layout Plain Layout
22371 key exists, then print
22372 \begin_inset Quotes eld
22376 \begin_inset space ~
22380 \begin_inset Quotes erd
22383 followed by the volume key.
22384 It is also possible to have an else clause in the conditional, such as:
22385 \begin_inset Newline newline
22389 \begin_inset Flex Code
22392 \begin_layout Plain Layout
22393 {%author%[[%author%]][[%editor%, ed.]]}
22399 \begin_inset Newline newline
22403 \begin_inset Flex Code
22406 \begin_layout Plain Layout
22412 key is printed if it exists; otherwise, the editor key is printed, followed
22414 \begin_inset Quotes eld
22418 \begin_inset space ~
22422 \begin_inset Quotes erd
22425 Note that the key is again enclosed in
22426 \begin_inset Flex Code
22429 \begin_layout Plain Layout
22435 signs; the entire conditional is enclosed in braces; and the if and else
22436 clauses are enclosed in double brackets,
22437 \begin_inset Quotes eld
22441 \begin_inset Flex Code
22444 \begin_layout Plain Layout
22451 \begin_inset Quotes eld
22455 \begin_inset Quotes eld
22459 \begin_inset Flex Code
22462 \begin_layout Plain Layout
22469 \begin_inset Quotes erd
22473 There must be no space between any of these.
22476 \begin_layout Standard
22477 Next to the entry keys, there are some special keys that can be used for
22478 these conditionals:
22481 \begin_layout Itemize
22482 \begin_inset Flex Code
22485 \begin_layout Plain Layout
22486 {%dialog%[[true]][[false]]}
22492 \begin_inset Quotes eld
22496 \begin_inset Quotes erd
22499 part for dialogs and menus, the
22500 \begin_inset Quotes eld
22504 \begin_inset Quotes erd
22507 part for other contexts (workarea, export)
22510 \begin_layout Itemize
22511 \begin_inset Flex Code
22514 \begin_layout Plain Layout
22515 {%export%[[true]][[false]]}
22521 \begin_inset Quotes eld
22525 \begin_inset Quotes erd
22528 part for export and menus, the
22529 \begin_inset Quotes eld
22533 \begin_inset Quotes erd
22536 part for other contexts (workarea, dialog)
22539 \begin_layout Itemize
22540 \begin_inset Flex Code
22543 \begin_layout Plain Layout
22550 \begin_inset Quotes eld
22554 \begin_inset Quotes erd
22557 part if another item follows (e.
22558 \begin_inset space \thinspace{}
22561 g., in a citation with multiple keys)
22564 \begin_layout Itemize
22565 \begin_inset Flex Code
22568 \begin_layout Plain Layout
22569 {%second%[[true]][[false]]}
22575 \begin_inset Quotes eld
22579 \begin_inset Quotes erd
22582 if this is the second of multiple items, else the
22583 \begin_inset Quotes eld
22587 \begin_inset Quotes erd
22593 \begin_layout Itemize
22594 \begin_inset Flex Code
22597 \begin_layout Plain Layout
22598 {%ifstar%[[true]][[false]]}
22604 \begin_inset Quotes eld
22608 \begin_inset Quotes erd
22611 part for starred citation commands (such as
22612 \begin_inset Flex Code
22615 \begin_layout Plain Layout
22623 ), the false part for unstarred
22626 \begin_layout Itemize
22627 \begin_inset Flex Code
22630 \begin_layout Plain Layout
22631 {%ifentrytype:<type>%[[true]][[false]]}
22637 \begin_inset Quotes eld
22641 \begin_inset Quotes erd
22644 if the current entry type matches
22645 \begin_inset Flex Code
22648 \begin_layout Plain Layout
22654 , else the false part (e.g., in a citation definition:
22655 \begin_inset Flex Code
22658 \begin_layout Plain Layout
22659 {%ifentrytype:book%[[this is a book]][[this is no book]]}
22667 \begin_layout Itemize
22668 \begin_inset Flex Code
22671 \begin_layout Plain Layout
22672 {%ifmultiple:<authortype>%[[true]][[false]]}
22678 \begin_inset Quotes eld
22682 \begin_inset Quotes erd
22685 if the current author type (author, editor etc.) has multiple authors, else
22686 the false part (e.g., in a bibliography definition:
22687 \begin_inset Flex Code
22690 \begin_layout Plain Layout
22691 {%ifmultiple:editor%[[eds.]][[ed.]]}
22699 \begin_layout Itemize
22700 \begin_inset Flex Code
22703 \begin_layout Plain Layout
22704 {%ifqualified%[[true]][[false]]}
22710 \begin_inset Quotes eld
22714 \begin_inset Quotes erd
22717 part if the current citation is a qualified citation list (a specific
22721 format for multi-reference citations), the false part if this is not the
22725 \begin_layout Standard
22727 \begin_inset Flex Code
22730 \begin_layout Plain Layout
22736 prints the author key as it is recorded in the bibliography file.
22737 This might not be what you want, since it will result in a string such
22739 \begin_inset Quotes eld
22742 Miller, Peter and Smith, Mary and White, Jane
22743 \begin_inset Quotes erd
22747 \begin_inset Quotes eld
22751 \begin_inset Quotes erd
22754 is used by Bib\SpecialChar TeX
22755 to delimit authors).
22757 therefore provides some methods to get properly formatted name lists (which
22758 will also get translated).
22759 The following keys are provided:
22762 \begin_layout Enumerate
22763 For name lists with pre- and surname, suitable for the main authors/editors
22764 of a bibliography item.
22766 \begin_inset Flex Code
22769 \begin_layout Plain Layout
22775 part denotes the kind of list that is requested (e.g.
22777 \begin_inset Flex Code
22780 \begin_layout Plain Layout
22790 \begin_layout Itemize
22791 \begin_inset Flex Code
22794 \begin_layout Plain Layout
22795 %abbrvnames:<nametype>%
22800 : Provides a name list which is abbreviated (with
22801 \begin_inset Quotes eld
22805 \begin_inset Quotes erd
22809 \begin_inset Flex Code
22812 \begin_layout Plain Layout
22821 \begin_layout Itemize
22822 \begin_inset Flex Code
22825 \begin_layout Plain Layout
22826 %fullnames:<nametype>%
22831 : Provides a full name list (never abbreviated with
22832 \begin_inset Quotes eld
22836 \begin_inset Quotes erd
22842 \begin_layout Itemize
22843 \begin_inset Flex Code
22846 \begin_layout Plain Layout
22847 %forceabbrvnames:<nametype>%
22852 : Provides a name list which is always abbreviated (with
22853 \begin_inset Quotes eld
22857 \begin_inset Quotes erd
22861 \begin_inset Flex Code
22864 \begin_layout Plain Layout
22874 \begin_layout Enumerate
22875 Alternative name lists with pre- and surname, if the order of pre- and surname
22876 inside the bibliography item differs (as in:
22877 \begin_inset Quotes eld
22880 Miller, John: Some text, in: Mary Smith, ed.: A volume
22881 \begin_inset Quotes erd
22888 \begin_layout Itemize
22889 \begin_inset Flex Code
22892 \begin_layout Plain Layout
22893 %abbrvbynames:<nametype>%
22898 : Provides a name list which is abbreviated (with
22899 \begin_inset Quotes eld
22903 \begin_inset Quotes erd
22907 \begin_inset Flex Code
22910 \begin_layout Plain Layout
22919 \begin_layout Itemize
22920 \begin_inset Flex Code
22923 \begin_layout Plain Layout
22924 %fullbynames:<nametype>%
22929 : Provides a full name list (never abbreviated with
22930 \begin_inset Quotes eld
22934 \begin_inset Quotes erd
22940 \begin_layout Itemize
22941 \begin_inset Flex Code
22944 \begin_layout Plain Layout
22945 %forceabbrvbynames:<nametype>%
22950 : Provides a name list which is always abbreviated (with
22951 \begin_inset Quotes eld
22955 \begin_inset Quotes erd
22959 \begin_inset Flex Code
22962 \begin_layout Plain Layout
22972 \begin_layout Enumerate
22973 And finally name lists which consist of family names only, as used in author-yea
22975 These do not take a
22976 \begin_inset Flex Code
22979 \begin_layout Plain Layout
22985 part, but always return either an author list or, if this does not exist,
22986 an editor list (as common in author-year labels):
22990 \begin_layout Itemize
22991 \begin_inset Flex Code
22994 \begin_layout Plain Layout
23000 : Provides a name list which is abbreviated (with
23001 \begin_inset Quotes eld
23005 \begin_inset Quotes erd
23009 \begin_inset Flex Code
23012 \begin_layout Plain Layout
23021 \begin_layout Itemize
23022 \begin_inset Flex Code
23025 \begin_layout Plain Layout
23031 : Provides a full name list (never abbreviated with
23032 \begin_inset Quotes eld
23036 \begin_inset Quotes erd
23042 \begin_layout Itemize
23043 \begin_inset Flex Code
23046 \begin_layout Plain Layout
23047 %forceabbrvciteauthor%
23052 : Provides a name list which is always abbreviated (with
23053 \begin_inset Quotes eld
23057 \begin_inset Quotes erd
23061 \begin_inset Flex Code
23064 \begin_layout Plain Layout
23074 \begin_layout Standard
23075 The order of pre- and surname in the former two lists can be adjusted by
23079 \begin_layout Itemize
23080 \begin_inset Flex Code
23083 \begin_layout Plain Layout
23084 !firstnameform %surname%, %prename%
23089 (first author in lists of type 1)
23092 \begin_layout Itemize
23093 \begin_inset Flex Code
23096 \begin_layout Plain Layout
23097 !othernameform %surname%, %prename%
23102 (other authors in lists of type 1)
23105 \begin_layout Itemize
23106 \begin_inset Flex Code
23109 \begin_layout Plain Layout
23110 !firstbynameform %prename% %surname%
23115 (first author in lists of type 2)
23118 \begin_layout Itemize
23119 \begin_inset Flex Code
23122 \begin_layout Plain Layout
23123 !otherbynameform %prename% %surname%
23128 (other authors in lists of type 2)
23131 \begin_layout Standard
23132 This allows you to configure namings like
23133 \begin_inset Quotes eld
23136 Miller, Peter and Mary Smith: \SpecialChar ldots
23137 , in: John Doe and Pat Green, eds.:\SpecialChar ldots
23139 \begin_inset Quotes erd
23145 \begin_layout Standard
23146 There is one other piece of syntax available in definitions, which looks
23148 \begin_inset Flex Code
23151 \begin_layout Plain Layout
23158 This defines a piece of formatting information that is to be used when
23160 \begin_inset Quotes eld
23164 \begin_inset Quotes erd
23168 Obviously, we do not want to output HTML tags when writing plain text,
23169 so they should be wrapped in
23170 \begin_inset Quotes eld
23174 \begin_inset Quotes erd
23178 \begin_inset Quotes eld
23182 \begin_inset Quotes erd
23188 \begin_layout Standard
23189 Two special sorts of definitions are also possible in a
23190 \begin_inset Flex Code
23193 \begin_layout Plain Layout
23200 An example of the first would be:
23203 \begin_layout LyX-Code
23205 \begin_inset Quotes eld
23209 \begin_inset Quotes erd
23215 \begin_layout Standard
23216 This is an abbreviation, or macro, and it can be used by treating it as
23218 \begin_inset Flex Code
23221 \begin_layout Plain Layout
23230 \begin_inset Flex Code
23233 \begin_layout Plain Layout
23239 exactly as it would treat its definition.
23240 So, let us issue the obvious
23248 \begin_layout LyX-Code
23252 \begin_layout Standard
23253 or anything like it.
23255 shouldn't go into an infinite loop, but it may go into a long one before
23259 \begin_layout Standard
23260 The second sort of special definition might look like this:
23263 \begin_layout LyX-Code
23267 \begin_layout Standard
23268 This defines a translatable piece of text, which allows relevant parts of
23269 the bibliography or citation to be translated.
23270 It can be included in a definition by treating it as a key:
23271 \begin_inset Flex Code
23274 \begin_layout Plain Layout
23281 Note that there are two different translation paths: All definitions starting
23283 \begin_inset Flex Code
23286 \begin_layout Plain Layout
23292 , such as in the example above, will be translated to the currently active
23293 buffer language (so the translation will match the generated document).
23294 All definitions starting with underscore only will be translated to the
23296 This is the proper translation for strings that only occur in the dialogs
23297 or on buttons, such as this one:
23300 \begin_layout LyX-Code
23301 _addtobib Add to bibliography only.
23304 \begin_layout Standard
23305 Several of these translatable strings are predefined in
23306 \begin_inset Flex Code
23309 \begin_layout Plain Layout
23316 \begin_inset Flex Code
23319 \begin_layout Plain Layout
23326 Note that these are not macros, in the sense just defined.
23327 They will not be expanded.
23330 \begin_layout Standard
23331 So here then is an example that uses several of these features:
23332 \begin_inset VSpace defskip
23338 \begin_layout Standard
23342 !authoredit {%author%[[%author%, ]][[{%editor%[[%editor%, %B_edtext%, ]]}]]}
23345 \begin_layout Standard
23346 \begin_inset VSpace defskip
23349 This defines a macro that prints the author, followed by a comma, if the
23351 \begin_inset Flex Code
23354 \begin_layout Plain Layout
23360 key is defined, or else prints the name of the editor, followed by the
23362 \begin_inset Flex Code
23365 \begin_layout Plain Layout
23371 or its translation (it is by default
23372 \begin_inset Quotes eld
23376 \begin_inset Quotes erd
23380 \begin_inset Flex Code
23383 \begin_layout Plain Layout
23390 Note that this is in fact defined in
23391 \begin_inset Flex Code
23394 \begin_layout Plain Layout
23400 , so you can use it in your own definitions, or re-definitions, if you load
23404 \begin_layout Section
23405 \begin_inset CommandInset label
23407 name "sec:Tags-for-XHTML"
23411 Tags for XHTML output
23414 \begin_layout Standard
23415 As with \SpecialChar LaTeX
23416 or DocBook, the format of \SpecialChar LyX
23417 's XHTML output is also controlled by
23418 layout information.
23419 In general, \SpecialChar LyX
23420 provides sensible defaults and, as mentioned earlier, it will
23421 even construct default CSS style rules from the other layout tags.
23422 For example, \SpecialChar LyX
23423 will attempt to use the information provided in the
23424 \begin_inset Flex Code
23427 \begin_layout Plain Layout
23433 declaration for the Chapter style to write CSS that will appropriately
23434 format chapter headings.
23437 \begin_layout Standard
23438 In many cases, then, you may not have to do anything at all to get acceptable
23439 XHTML output for your own environments, custom insets, and so forth.
23440 But in some cases you will, and so \SpecialChar LyX
23441 provides a number of layout tags that
23442 can be used to customize the XHTML and CSS that are generated.
23445 \begin_layout Standard
23446 Note that there are two tags,
23447 \begin_inset Flex Code
23450 \begin_layout Plain Layout
23457 \begin_inset Flex Code
23460 \begin_layout Plain Layout
23466 that may appear outside style and inset declarations.
23468 \begin_inset CommandInset ref
23470 reference "subsec:General-text-class"
23474 for details on these.
23477 \begin_layout Subsection
23478 \begin_inset CommandInset label
23480 name "subsec:Paragraph-Style-XHTML"
23487 \begin_layout Standard
23488 The sort of XHTML \SpecialChar LyX
23489 outputs for a paragraph depends upon whether we are dealing
23490 with a normal paragraph, a command, or an environment, where this is itself
23491 determined by the contents of the corresponding
23492 \begin_inset Flex Code
23495 \begin_layout Plain Layout
23506 \begin_layout Standard
23507 For a command or normal paragraph, the output XHTML has the following form:
23510 \begin_layout LyX-Code
23514 \begin_inset Quotes erd
23518 \begin_inset Quotes erd
23524 \begin_layout LyX-Code
23528 \begin_inset Quotes erd
23532 \begin_inset Quotes erd
23538 \begin_layout LyX-Code
23541 Contents of the paragraph.
23544 \begin_layout LyX-Code
23550 \begin_layout Standard
23551 The label tags are of course omitted if the paragraph does not have a label.
23554 \begin_layout Standard
23555 For an environment that is not some sort of list, the XHTML takes this form:
23558 \begin_layout LyX-Code
23562 \begin_inset Quotes erd
23566 \begin_inset Quotes erd
23572 \begin_layout LyX-Code
23576 \begin_inset Quotes erd
23580 \begin_inset Quotes erd
23584 \begin_inset Quotes erd
23588 \begin_inset Quotes erd
23591 >Environment Label</labeltag>First paragraph.</itemtag>
23594 \begin_layout LyX-Code
23597 <itemtag>Second paragraph.</itemtag>
23600 \begin_layout LyX-Code
23606 \begin_layout Standard
23607 Note that the label is output only for the first paragraph, as it should
23608 be for a theorem, for example.
23612 \begin_layout Standard
23613 For a list, we have one of these forms:
23616 \begin_layout LyX-Code
23620 \begin_inset Quotes erd
23624 \begin_inset Quotes erd
23630 \begin_layout LyX-Code
23634 \begin_inset Quotes erd
23638 \begin_inset Quotes erd
23642 \begin_inset Quotes erd
23646 \begin_inset Quotes erd
23649 >List Label</labeltag>First item.</itemtag>
23652 \begin_layout LyX-Code
23656 \begin_inset Quotes erd
23660 \begin_inset Quotes erd
23664 \begin_inset Quotes erd
23668 \begin_inset Quotes erd
23671 >List Label</labeltag>Second item.</itemtag>
23674 \begin_layout LyX-Code
23680 \begin_layout LyX-Code
23684 \begin_layout LyX-Code
23688 \begin_inset Quotes erd
23692 \begin_inset Quotes erd
23698 \begin_layout LyX-Code
23702 \begin_inset Quotes erd
23706 \begin_inset Quotes erd
23709 >List Label</labeltag><itemtag attr=
23710 \begin_inset Quotes erd
23714 \begin_inset Quotes erd
23717 >First item.</itemtag>
23720 \begin_layout LyX-Code
23724 \begin_inset Quotes erd
23728 \begin_inset Quotes erd
23731 >List Label</labeltag><itemtag attr=
23732 \begin_inset Quotes erd
23736 \begin_inset Quotes erd
23739 >Second item.</itemtag>
23742 \begin_layout LyX-Code
23748 \begin_layout Standard
23749 Note the different orders of
23750 \begin_inset Flex Code
23753 \begin_layout Plain Layout
23760 \begin_inset Flex Code
23763 \begin_layout Plain Layout
23770 Which order we get depends upon the setting of
23771 \begin_inset Flex Code
23774 \begin_layout Plain Layout
23781 \begin_inset Flex Code
23784 \begin_layout Plain Layout
23790 is false (the default), you get the first of these, with the label within
23791 the item; if true, you get the second, with the label outside the item.
23794 \begin_layout Standard
23795 The specific tags and attributes output for each paragraph type can be controlle
23796 d by means of the layout tags we are about to describe.
23797 As mentioned earlier, however, \SpecialChar LyX
23798 uses sensible defaults for many of these,
23799 so you often may not need to do very much to get good XHTML output.
23800 Think of the available tags as there so you can tweak things to your liking.
23803 \begin_layout Description
23804 \begin_inset Flex Code
23807 \begin_layout Plain Layout
23814 \begin_inset Flex Code
23817 \begin_layout Plain Layout
23823 ] Specifies attribute information to be output with the main tag.
23825 \begin_inset Quotes eld
23829 \begin_inset Flex Code
23832 \begin_layout Plain Layout
23839 \begin_inset Quotes erd
23843 By default, \SpecialChar LyX
23845 \begin_inset Quotes eld
23849 \begin_inset Flex Code
23852 \begin_layout Plain Layout
23859 \begin_inset Quotes erd
23863 \begin_inset Flex Code
23866 \begin_layout Plain Layout
23872 is the \SpecialChar LyX
23873 name of the layout, made lowercase, for example: chapter.
23878 contain any style information.
23880 \begin_inset Flex Code
23883 \begin_layout Plain Layout
23892 \begin_layout Description
23893 \begin_inset Flex Code
23896 \begin_layout Plain Layout
23903 \begin_inset Flex Code
23906 \begin_layout Plain Layout
23916 ] Whether to output the default CSS information \SpecialChar LyX
23917 generates for this layout,
23918 even if additional information is explicitly provided via
23919 \begin_inset Flex Code
23922 \begin_layout Plain Layout
23930 \begin_inset Flex Code
23933 \begin_layout Plain Layout
23939 allows you to alter or augment the generated CSS, rather than to override
23942 \begin_inset Flex Code
23945 \begin_layout Plain Layout
23954 \begin_layout Description
23955 \begin_inset Flex Code
23958 \begin_layout Plain Layout
23965 \begin_inset Flex Code
23968 \begin_layout Plain Layout
23974 ] The tag to be used for individual paragraphs of environments, replacing
23976 \begin_inset Flex Code
23979 \begin_layout Plain Layout
23985 in the examples above.
23987 \begin_inset Flex Code
23990 \begin_layout Plain Layout
23999 \begin_layout Description
24000 \begin_inset Flex Code
24003 \begin_layout Plain Layout
24010 \begin_inset Flex Code
24013 \begin_layout Plain Layout
24019 ] Attributes for the item tag.
24021 \begin_inset Newline newline
24025 \begin_inset Quotes eld
24029 \begin_inset Flex Code
24032 \begin_layout Plain Layout
24033 class=`layoutname_item'
24039 \begin_inset Quotes erd
24047 contain any style information.
24049 \begin_inset Flex Code
24052 \begin_layout Plain Layout
24061 \begin_layout Description
24062 \begin_inset Flex Code
24065 \begin_layout Plain Layout
24072 \begin_inset Flex Code
24075 \begin_layout Plain Layout
24081 ] The tag to be used for paragraph and item labels, replacing
24082 \begin_inset Flex Code
24085 \begin_layout Plain Layout
24091 in the examples above.
24093 \begin_inset Flex Code
24096 \begin_layout Plain Layout
24103 \begin_inset Flex Code
24106 \begin_layout Plain Layout
24113 \begin_inset Flex Code
24116 \begin_layout Plain Layout
24123 \begin_inset Flex Code
24126 \begin_layout Plain Layout
24127 Centered_Top_Environment
24132 , in which case it defaults to
24133 \begin_inset Flex Code
24136 \begin_layout Plain Layout
24145 \begin_layout Description
24146 \begin_inset Flex Code
24149 \begin_layout Plain Layout
24156 \begin_inset Flex Code
24159 \begin_layout Plain Layout
24165 ] Attributes for the label tag.
24167 \begin_inset Newline newline
24171 \begin_inset Quotes eld
24175 \begin_inset Flex Code
24178 \begin_layout Plain Layout
24179 class=`layoutname_label'
24185 \begin_inset Quotes erd
24193 contain any style information.
24195 \begin_inset Flex Code
24198 \begin_layout Plain Layout
24207 \begin_layout Description
24208 \begin_inset Flex Code
24211 \begin_layout Plain Layout
24218 \begin_inset Flex Code
24221 \begin_layout Plain Layout
24231 ] Meaningful only for list-like environments, this tag controls whether
24232 the label tag is output before or inside the item tag.
24233 This is used, for example, in the description environment, where we want
24235 \begin_inset Flex Code
24238 \begin_layout Plain Layout
24239 <dt>\SpecialChar ldots
24240 </dt><dd>\SpecialChar ldots
24248 \begin_inset Flex Code
24251 \begin_layout Plain Layout
24257 : The label tag is output inside the item tag.
24260 \begin_layout Description
24261 \begin_inset Flex Code
24264 \begin_layout Plain Layout
24270 Information to be output in the
24271 \begin_inset Flex Code
24274 \begin_layout Plain Layout
24280 section when this style is used.
24281 This might, for example, be used to include a
24282 \begin_inset Flex Code
24285 \begin_layout Plain Layout
24292 \begin_inset Flex Code
24295 \begin_layout Plain Layout
24304 \begin_layout Description
24305 \begin_inset Flex Code
24308 \begin_layout Plain Layout
24314 CSS style information to be included when this style is used.
24315 Note that this will automatically be wrapped in a layout-generated
24316 \begin_inset Flex Code
24319 \begin_layout Plain Layout
24325 block, so only the CSS itself need be included.
24327 \begin_inset Flex Code
24330 \begin_layout Plain Layout
24339 \begin_layout Description
24340 \begin_inset Flex Code
24343 \begin_layout Plain Layout
24350 \begin_inset Flex Code
24353 \begin_layout Plain Layout
24359 ] The tag to be used for the main label, replacing
24360 \begin_inset Flex Code
24363 \begin_layout Plain Layout
24369 in the examples above.
24371 \begin_inset Flex Code
24374 \begin_layout Plain Layout
24383 \begin_layout Description
24384 \begin_inset Flex Code
24387 \begin_layout Plain Layout
24394 \begin_inset Flex Code
24397 \begin_layout Plain Layout
24407 ] Marks this style as the one to be used to generate the
24408 \begin_inset Flex Code
24411 \begin_layout Plain Layout
24417 tag for the XHTML file.
24418 By default, it is false.
24420 \begin_inset Flex Code
24423 \begin_layout Plain Layout
24429 file sets it to true for the
24430 \begin_inset Flex Code
24433 \begin_layout Plain Layout
24443 \begin_layout Subsection
24447 \begin_layout Standard
24448 The XHTML output of insets can also be controlled by information in layout
24453 \begin_layout Plain Layout
24454 At present, this is true only for
24455 \begin_inset Quotes eld
24459 \begin_inset Quotes erd
24462 insets (insets you can type into) and is not true for
24463 \begin_inset Quotes eld
24467 \begin_inset Quotes erd
24470 insets (insets that are associated with dialog boxes).
24475 Here, too, \SpecialChar LyX
24476 tries to provide sensible defaults, and it constructs default
24478 But everything can be customized.
24481 \begin_layout Standard
24482 The XHTML \SpecialChar LyX
24483 outputs for an inset has the following form:
24486 \begin_layout LyX-Code
24488 \begin_inset Quotes erd
24492 \begin_inset Quotes erd
24498 \begin_layout LyX-Code
24499 <labeltag>Label</labeltag>
24502 \begin_layout LyX-Code
24504 \begin_inset Quotes erd
24508 \begin_inset Quotes erd
24511 >Contents of the inset.</innertag>
24514 \begin_layout LyX-Code
24518 \begin_layout Standard
24519 If the inset permits multiple paragraphs—that is, if
24520 \begin_inset Flex Code
24523 \begin_layout Plain Layout
24529 is true—then the contents of the inset will itself be output as paragraphs
24530 formatted according to the styles used for those paragraphs (standard,
24531 quote, and the like).
24532 The label tag is of course omitted if the paragraph does not have a label
24533 and, at present, is always
24534 \begin_inset Flex Code
24537 \begin_layout Plain Layout
24544 The inner tag is optional and, by default, does not appear.
24547 \begin_layout Standard
24548 The specific tags and attributes output for each inset can be controlled
24549 by means of the following layout tags.
24552 \begin_layout Description
24553 \begin_inset Flex Code
24556 \begin_layout Plain Layout
24563 \begin_inset Flex Code
24566 \begin_layout Plain Layout
24572 ] Specifies attribute information to be output with the main tag.
24574 \begin_inset Quotes eld
24578 \begin_inset Flex Code
24581 \begin_layout Plain Layout
24582 class=`myinset' onclick=`\SpecialChar ldots
24589 \begin_inset Quotes erd
24593 By default, \SpecialChar LyX
24595 \begin_inset Quotes eld
24599 \begin_inset Flex Code
24602 \begin_layout Plain Layout
24609 \begin_inset Quotes erd
24613 \begin_inset Flex Code
24616 \begin_layout Plain Layout
24622 is the \SpecialChar LyX
24623 name of the inset, made lowercase and with non-alphanumeric characters
24624 converted to underscores, for example: footnote.
24627 \begin_layout Description
24628 \begin_inset Flex Code
24631 \begin_layout Plain Layout
24638 \begin_inset Flex Code
24641 \begin_layout Plain Layout
24651 ] Whether to output the default CSS information \SpecialChar LyX
24652 generates for this layout,
24653 even if additional information is explicitly provided via
24654 \begin_inset Flex Code
24657 \begin_layout Plain Layout
24665 \begin_inset Flex Code
24668 \begin_layout Plain Layout
24674 allows you to alter or augment the generated CSS, rather than to override
24679 \begin_layout Description
24680 \begin_inset Flex Code
24683 \begin_layout Plain Layout
24690 \begin_inset Flex Code
24693 \begin_layout Plain Layout
24699 ] Attributes for the inner tag.
24701 \begin_inset Newline newline
24705 \begin_inset Quotes eld
24709 \begin_inset Flex Code
24712 \begin_layout Plain Layout
24713 class=`insetname_inner'
24719 \begin_inset Quotes erd
24725 \begin_layout Description
24726 \begin_inset Flex Code
24729 \begin_layout Plain Layout
24736 \begin_inset Flex Code
24739 \begin_layout Plain Layout
24745 ] The inner tag, replacing
24746 \begin_inset Flex Code
24749 \begin_layout Plain Layout
24755 in the examples above.
24756 By default, there is none.
24759 \begin_layout Description
24760 \begin_inset Flex Code
24763 \begin_layout Plain Layout
24770 \begin_inset Flex Code
24773 \begin_layout Plain Layout
24781 ] Whether this inset represents a standalone block of text (such as a footnote)
24782 or instead represents material that is included in the surrounding text
24783 (such as a branch).
24787 \begin_layout Description
24788 \begin_inset Flex Code
24791 \begin_layout Plain Layout
24798 \begin_inset Flex Code
24801 \begin_layout Plain Layout
24807 ] A label for this inset, possibly including a reference to a counter.
24808 For example, for footnote, it might be:
24809 \begin_inset Flex Code
24812 \begin_layout Plain Layout
24821 This is optional, and there is no default.
24824 \begin_layout Description
24825 \begin_inset Flex Code
24828 \begin_layout Plain Layout
24834 Information to be output in the
24835 \begin_inset Flex Code
24838 \begin_layout Plain Layout
24844 section when this style is used.
24845 This might, for example, be used to include a
24846 \begin_inset Flex Code
24849 \begin_layout Plain Layout
24856 \begin_inset Flex Code
24859 \begin_layout Plain Layout
24868 \begin_layout Description
24869 \begin_inset Flex Code
24872 \begin_layout Plain Layout
24878 CSS style information to be included when this style is used.
24879 Note that this will automatically be wrapped in a layout-generated
24880 \begin_inset Flex Code
24883 \begin_layout Plain Layout
24889 block, so only the CSS itself need be included.
24892 \begin_layout Description
24893 \begin_inset Flex Code
24896 \begin_layout Plain Layout
24903 \begin_inset Flex Code
24906 \begin_layout Plain Layout
24912 ] The tag to be used for the main label, replacing
24913 \begin_inset Flex Code
24916 \begin_layout Plain Layout
24922 in the examples above.
24923 The default depends upon the setting of
24924 \begin_inset Flex Code
24927 \begin_layout Plain Layout
24934 \begin_inset Flex Code
24937 \begin_layout Plain Layout
24943 is true, the default is
24944 \begin_inset Flex Code
24947 \begin_layout Plain Layout
24953 ; if it is false, the default is
24954 \begin_inset Flex Code
24957 \begin_layout Plain Layout
24966 \begin_layout Subsection
24970 \begin_layout Standard
24971 The XHTML output for floats too can be controlled by layout information.
24972 The output has the following form:
24975 \begin_layout LyX-Code
24977 \begin_inset Quotes erd
24981 \begin_inset Quotes erd
24987 \begin_layout LyX-Code
24988 Contents of the float.
24991 \begin_layout LyX-Code
24995 \begin_layout Standard
24996 The caption, if there is one, is a separate inset and will be output as
24998 Its appearance can be controlled via the InsetLayout for caption insets.
25002 \begin_layout Description
25003 \begin_inset Flex Code
25006 \begin_layout Plain Layout
25013 \begin_inset Flex Code
25016 \begin_layout Plain Layout
25022 ] Specifies attribute information to be output with the main tag.
25024 \begin_inset Quotes eld
25028 \begin_inset Flex Code
25031 \begin_layout Plain Layout
25032 class=`myfloat' onclick=`\SpecialChar ldots
25039 \begin_inset Quotes erd
25043 By default, \SpecialChar LyX
25045 \begin_inset Quotes eld
25049 \begin_inset Flex Code
25052 \begin_layout Plain Layout
25053 class=`float float-floattype'
25059 \begin_inset Quotes erd
25063 \begin_inset Flex Code
25066 \begin_layout Plain Layout
25072 is \SpecialChar LyX
25073 's name for this type of float, as determined by the float declaration
25075 \begin_inset CommandInset ref
25077 reference "subsec:Floats"
25081 ), though made lowercase and with non-alphanumeric characters converted
25082 to underscores, for example: float-table.
25085 \begin_layout Description
25086 \begin_inset Flex Code
25089 \begin_layout Plain Layout
25095 CSS style information to be included when this float is used.
25096 Note that this will automatically be wrapped in a layout-generated
25097 \begin_inset Flex Code
25100 \begin_layout Plain Layout
25106 block, so only the CSS itself need be included.
25109 \begin_layout Description
25110 \begin_inset Flex Code
25113 \begin_layout Plain Layout
25120 \begin_inset Flex Code
25123 \begin_layout Plain Layout
25129 ] The tag to be used for this float, replacing
25130 \begin_inset Quotes eld
25134 \begin_inset Flex Code
25137 \begin_layout Plain Layout
25144 \begin_inset Quotes erd
25147 in the example above.
25149 \begin_inset Flex Code
25152 \begin_layout Plain Layout
25158 and will rarely need changing.
25161 \begin_layout Subsection
25162 Bibliography formatting
25165 \begin_layout Standard
25166 The bibliography can be formatted using
25167 \begin_inset Flex Code
25170 \begin_layout Plain Layout
25178 \begin_inset CommandInset ref
25180 reference "subsec:Citation-format-description"
25187 \begin_layout Subsection
25192 \begin_layout Standard
25193 We have several times mentioned that \SpecialChar LyX
25194 will generate default CSS style rules
25195 for both insets and paragraph styles, based upon the other layout information
25197 In this section, we shall say a word about which layout information \SpecialChar LyX
25202 \begin_layout Standard
25203 At present, \SpecialChar LyX
25204 auto-generates CSS only for font information, making use of
25206 \begin_inset Flex Code
25209 \begin_layout Plain Layout
25216 \begin_inset Flex Code
25219 \begin_layout Plain Layout
25226 \begin_inset Flex Code
25229 \begin_layout Plain Layout
25236 \begin_inset Flex Code
25239 \begin_layout Plain Layout
25246 \begin_inset Flex Code
25249 \begin_layout Plain Layout
25256 \begin_inset CommandInset ref
25258 reference "subsec:Font-description"
25263 The translation is mostly straightforward and obvious.
25265 \begin_inset Quotes eld
25269 \begin_inset Flex Code
25272 \begin_layout Plain Layout
25279 \begin_inset Quotes erd
25283 \begin_inset Quotes eld
25287 \begin_inset Flex Code
25290 \begin_layout Plain Layout
25291 font-family: sans-serif;
25297 \begin_inset Quotes erd
25301 The correspondence of \SpecialChar LyX
25302 sizes and CSS sizes is a little less obvious but
25303 nonetheless intuitive.
25305 \begin_inset Flex Code
25308 \begin_layout Plain Layout
25315 \begin_inset Flex URL
25318 \begin_layout Plain Layout
25328 \begin_layout Chapter
25329 Including External Material
25330 \begin_inset CommandInset label
25332 name "chap:Including-External-Material"
25339 \begin_layout Standard
25340 \begin_inset Box Shadowbox
25350 height_special "totalheight"
25355 backgroundcolor "none"
25358 \begin_layout Plain Layout
25359 WARNING: This portion of the documentation has not been updated for some
25361 We certainly hope that it is still accurate, but there are no guarantees.
25369 \begin_layout Standard
25370 The use of material from sources external to \SpecialChar LyX
25371 is covered in detail in the
25377 This part of the manual covers what needs to happen behind the scenes for
25378 new sorts of material to be included.
25381 \begin_layout Section
25385 \begin_layout Standard
25386 The external material feature is based on the concept of a
25391 A template is a specification of how \SpecialChar LyX
25392 should interface with a certain kind
25394 As bundled, \SpecialChar LyX
25395 comes with predefined templates for Xfig figures, various
25396 raster format images, chess diagrams, and LilyPond music notation.
25397 You can check the actual list by using the menu
25398 \begin_inset Flex Noun
25401 \begin_layout Plain Layout
25402 Insert\SpecialChar menuseparator
25403 File\SpecialChar menuseparator
25410 Furthermore, it is possible to roll your own template to support a specific
25412 Later we'll describe in more detail what is involved, and hopefully you
25413 will submit all the templates you create so we can include them in a later
25418 \begin_layout Standard
25419 Another basic idea of the external material feature is to distinguish between
25420 the original file that serves as a base for final material and the produced
25421 file that is included in your exported or printed document.
25422 For example, consider the case of a figure produced with
25423 \begin_inset Flex Code
25426 \begin_layout Plain Layout
25433 The Xfig application itself works on an original file with the
25434 \begin_inset Flex Code
25437 \begin_layout Plain Layout
25444 Within Xfig, you create and change your figure, and when you are done,
25446 \begin_inset Flex Code
25449 \begin_layout Plain Layout
25456 When you want to include the figure in your document, you invoke
25457 \begin_inset Flex Code
25460 \begin_layout Plain Layout
25466 in order to create a PostScript file that can readily be included in your
25470 \begin_inset Flex Code
25473 \begin_layout Plain Layout
25479 file is the original file, and the PostScript file is the produced file.
25482 \begin_layout Standard
25483 This distinction is important in order to allow updating of the material
25484 while you are in the process of writing the document.
25485 Furthermore, it provides us with the flexibility that is needed to support
25486 multiple export formats.
25487 For instance, in the case of a plain text file, it is not exactly an award-winn
25488 ing idea to include the figure as raw PostScript.
25489 Instead, you would either prefer to just include a reference to the figure
25490 or try to invoke some graphics to ASCII converter to make the final result
25491 look similar to the real graphics.
25492 The external material management allows you to do this, because it is parametri
25493 zed on the different export formats that \SpecialChar LyX
25497 \begin_layout Standard
25498 Besides supporting the production of different products according to the
25499 exported format, it supports tight integration with editing and viewing
25501 In the case of an Xfig figure, you are able to invoke Xfig on the original
25502 file with a single click from within the external material dialog in \SpecialChar LyX
25504 and also preview the produced PostScript file with Ghostview with another
25506 No more fiddling around with the command line and/or file browsers to locate
25507 and manipulate the original or produced files.
25508 In this way, you are finally able to take full advantage of the many different
25509 applications that are relevant to use when you write your documents, and
25510 ultimately be more productive.
25513 \begin_layout Section
25514 The external template configuration files
25517 \begin_layout Standard
25518 It is relatively easy to add custom external template definitions to \SpecialChar LyX
25520 However, be aware that doing this in an careless manner most probably
25524 introduce an easily exploitable security hole.
25525 So before you do this, please read the discussion about security in
25526 \begin_inset CommandInset ref
25528 reference "sec:Security-discussion"
25535 \begin_layout Standard
25536 Having said that, we encourage you to submit any interesting templates that
25541 \begin_layout Standard
25542 The external templates are defined in the
25543 \begin_inset Flex Code
25546 \begin_layout Plain Layout
25552 files that are stored in the
25553 \begin_inset Flex Code
25556 \begin_layout Plain Layout
25557 LyXDir/lib/xtemplates/
25563 Each template is defined in a file of its own.
25564 You can place your own templates in
25565 \begin_inset Flex Code
25568 \begin_layout Plain Layout
25569 UserDir/xtemplates/
25574 or copy existing templates to that directory in order to modify them.
25577 \begin_layout Standard
25578 A typical template looks like this:
25581 \begin_layout LyX-Code
25585 \begin_layout LyX-Code
25586 GuiName "XFig: $$AbsOrRelPathParent$$Basename"
25589 \begin_layout LyX-Code
25593 \begin_layout LyX-Code
25597 \begin_layout LyX-Code
25601 \begin_layout LyX-Code
25605 \begin_layout LyX-Code
25609 \begin_layout LyX-Code
25610 AutomaticProduction true
25613 \begin_layout LyX-Code
25617 \begin_layout LyX-Code
25621 \begin_layout LyX-Code
25625 \begin_layout LyX-Code
25626 TransformCommand Rotate RotationLatexCommand
25629 \begin_layout LyX-Code
25630 TransformCommand Resize ResizeLatexCommand
25633 \begin_layout LyX-Code
25634 Product "$$RotateFront$$ResizeFront
25637 \begin_layout LyX-Code
25642 input{$$AbsOrRelPathMaster$$Basename.pstex_t}
25645 \begin_layout LyX-Code
25646 $$ResizeBack$$RotateBack"
25649 \begin_layout LyX-Code
25653 \begin_layout LyX-Code
25654 UpdateResult "$$AbsPath$$Basename.pstex_t"
25657 \begin_layout LyX-Code
25658 Requirement "graphicx"
25661 \begin_layout LyX-Code
25662 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
25665 \begin_layout LyX-Code
25666 ReferencedFile latex "$$AbsPath$$Basename.eps"
25669 \begin_layout LyX-Code
25670 ReferencedFile dvi "$$AbsPath$$Basename.eps"
25673 \begin_layout LyX-Code
25677 \begin_layout LyX-Code
25681 \begin_layout LyX-Code
25682 TransformCommand Rotate RotationLatexCommand
25685 \begin_layout LyX-Code
25686 TransformCommand Resize ResizeLatexCommand
25689 \begin_layout LyX-Code
25690 Product "$$RotateFront$$ResizeFront
25693 \begin_layout LyX-Code
25698 input{$$AbsOrRelPathMaster$$Basename.pdftex_t}
25701 \begin_layout LyX-Code
25702 $$ResizeBack$$RotateBack"
25705 \begin_layout LyX-Code
25706 UpdateFormat pdftex
25709 \begin_layout LyX-Code
25710 UpdateResult "$$AbsPath$$Basename.pdftex_t"
25713 \begin_layout LyX-Code
25714 Requirement "graphicx"
25717 \begin_layout LyX-Code
25718 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pdftex_t"
25721 \begin_layout LyX-Code
25722 ReferencedFile latex "$$AbsPath$$Basename.pdf"
25725 \begin_layout LyX-Code
25729 \begin_layout LyX-Code
25733 \begin_layout LyX-Code
25734 Product "[XFig: $$FName]"
25737 \begin_layout LyX-Code
25741 \begin_layout LyX-Code
25745 \begin_layout LyX-Code
25746 Product "<graphic fileref=
25748 "$$AbsOrRelPathMaster$$Basename.eps
25753 \begin_layout LyX-Code
25757 \begin_layout LyX-Code
25761 \begin_layout LyX-Code
25762 UpdateResult "$$AbsPath$$Basename.eps"
25765 \begin_layout LyX-Code
25766 ReferencedFile docbook "$$AbsPath$$Basename.eps"
25769 \begin_layout LyX-Code
25770 ReferencedFile docbook-xml "$$AbsPath$$Basename.eps"
25773 \begin_layout LyX-Code
25777 \begin_layout LyX-Code
25781 \begin_layout Standard
25782 As you can see, the template is enclosed in
25783 \begin_inset Flex Code
25786 \begin_layout Plain Layout
25794 \begin_inset Flex Code
25797 \begin_layout Plain Layout
25804 It contains a header specifying some general settings and, for each supported
25805 primary document file format, a section
25806 \begin_inset Flex Code
25809 \begin_layout Plain Layout
25817 \begin_inset Flex Code
25820 \begin_layout Plain Layout
25829 \begin_layout Subsection
25830 The template header
25833 \begin_layout Description
25834 \begin_inset Flex Code
25837 \begin_layout Plain Layout
25838 AutomaticProduction
25839 \begin_inset space ~
25847 Whether the file represented by the template must be generated by \SpecialChar LyX
25849 This command must occur exactly once.
25852 \begin_layout Description
25853 \begin_inset Flex Code
25856 \begin_layout Plain Layout
25858 \begin_inset space ~
25866 A glob pattern that is used in the file dialog to filter out the desired
25868 If there is more than one possible file extension (e.
25869 \begin_inset space \thinspace{}
25873 \begin_inset space \space{}
25877 \begin_inset Flex Code
25880 \begin_layout Plain Layout
25887 \begin_inset Flex Code
25890 \begin_layout Plain Layout
25896 ), use something like
25897 \begin_inset Flex Code
25900 \begin_layout Plain Layout
25907 This command must occur exactly once.
25910 \begin_layout Description
25911 \begin_inset Flex Code
25914 \begin_layout Plain Layout
25916 \begin_inset space ~
25924 The text that is displayed on the button.
25925 This command must occur exactly once.
25928 \begin_layout Description
25929 \begin_inset Flex Code
25932 \begin_layout Plain Layout
25934 \begin_inset space ~
25938 \begin_inset space ~
25946 The help text that is used in the External dialog.
25947 Provide enough information to explain to the user just what the template
25948 can provide him with.
25949 This command must occur exactly once.
25952 \begin_layout Description
25953 \begin_inset Flex Code
25956 \begin_layout Plain Layout
25958 \begin_inset space ~
25966 The file format of the original file.
25967 This must be the name of a format that is known to \SpecialChar LyX
25969 \begin_inset CommandInset ref
25971 reference "sec:Formats"
25977 \begin_inset Quotes eld
25981 \begin_inset Flex Code
25984 \begin_layout Plain Layout
25991 \begin_inset Quotes erd
25994 if the template can handle original files of more than one format.
25996 will attempt to interrogate the file itself in order to deduce its format
25998 This command must occur exactly once.
26001 \begin_layout Description
26002 \begin_inset Flex Code
26005 \begin_layout Plain Layout
26007 \begin_inset space ~
26015 A unique name for the template.
26016 It must not contain substitution macros (see below).
26019 \begin_layout Description
26020 \begin_inset Flex Code
26023 \begin_layout Plain Layout
26025 \begin_inset space ~
26028 Rotate|Resize|Clip|Extra
26033 This command specifies which transformations are supported by this template.
26034 It may occur zero or more times.
26035 This command enables the corresponding tabs in the external dialog.
26037 \begin_inset Flex Code
26040 \begin_layout Plain Layout
26046 command must have either a corresponding
26047 \begin_inset Flex Code
26050 \begin_layout Plain Layout
26057 \begin_inset Flex Code
26060 \begin_layout Plain Layout
26067 \begin_inset Flex Code
26070 \begin_layout Plain Layout
26077 Otherwise the transformation will not be supported by that format.
26080 \begin_layout Subsection
26084 \begin_layout Description
26085 \begin_inset Flex Code
26088 \begin_layout Plain Layout
26090 \begin_inset space ~
26093 LaTeX|PDFLaTeX|PlainText|DocBook|XHTML
26098 The primary document file format that this format definition is for.
26099 Not every template has a sensible representation in all document file formats.
26100 Please define nevertheless a
26101 \begin_inset Flex Code
26104 \begin_layout Plain Layout
26110 section for all templates.
26111 Use a dummy text when no representation is available.
26112 Then you can at least see a reference to the external material in the exported
26116 \begin_layout Description
26117 \begin_inset Flex Code
26120 \begin_layout Plain Layout
26122 \begin_inset space ~
26126 \begin_inset space ~
26134 This command defines an additional macro
26135 \begin_inset Flex Code
26138 \begin_layout Plain Layout
26144 for substitution in
26145 \begin_inset Flex Code
26148 \begin_layout Plain Layout
26156 \begin_inset Flex Code
26159 \begin_layout Plain Layout
26165 itself may contain substitution macros.
26166 The advantage over using
26167 \begin_inset Flex Code
26170 \begin_layout Plain Layout
26177 \begin_inset Flex Code
26180 \begin_layout Plain Layout
26186 is that the substituted value of
26187 \begin_inset Flex Code
26190 \begin_layout Plain Layout
26196 is sanitized so that it is a valid optional argument in the document format.
26197 This command may occur zero or more times.
26200 \begin_layout Description
26201 \begin_inset Flex Code
26204 \begin_layout Plain Layout
26206 \begin_inset space ~
26214 The text that is inserted in the exported document.
26215 This is actually the most important command and can be quite complex.
26216 This command must occur exactly once.
26219 \begin_layout Description
26220 \begin_inset Flex Code
26223 \begin_layout Plain Layout
26225 \begin_inset space ~
26233 This command specifies a preamble snippet that will be included in the
26236 It has to be defined using
26237 \begin_inset Flex Code
26240 \begin_layout Plain Layout
26248 \begin_inset Flex Code
26251 \begin_layout Plain Layout
26258 This command may occur zero or more times.
26261 \begin_layout Description
26262 \begin_inset Flex Code
26265 \begin_layout Plain Layout
26267 \begin_inset space ~
26271 \begin_inset space ~
26279 This command denotes files that are created by the conversion process and
26280 are needed for a particular export format.
26281 If the filename is relative, it is interpreted relative to the master document.
26282 This command may be given zero or more times.
26285 \begin_layout Description
26286 \begin_inset Flex Code
26289 \begin_layout Plain Layout
26291 \begin_inset space ~
26299 The name of a required \SpecialChar LaTeX
26301 The package is included via
26302 \begin_inset Flex Code
26305 \begin_layout Plain Layout
26313 in the \SpecialChar LaTeX
26315 This command may occur zero or more times.
26318 \begin_layout Description
26319 \begin_inset Flex Code
26322 \begin_layout Plain Layout
26324 \begin_inset space ~
26328 \begin_inset space ~
26331 RotationLatexCommand
26336 This command specifies that the built in \SpecialChar LaTeX
26337 command should be used for rotation.
26338 This command may occur once or not at all.
26341 \begin_layout Description
26342 \begin_inset Flex Code
26345 \begin_layout Plain Layout
26347 \begin_inset space ~
26351 \begin_inset space ~
26359 This command specifies that the built in \SpecialChar LaTeX
26360 command should be used for resizing.
26361 This command may occur once or not at all.
26364 \begin_layout Description
26365 \begin_inset Flex Code
26368 \begin_layout Plain Layout
26370 \begin_inset space ~
26374 \begin_inset space ~
26377 RotationLatexOption
26382 This command specifies that rotation is done via an optional argument.
26383 This command may occur once or not at all.
26386 \begin_layout Description
26387 \begin_inset Flex Code
26390 \begin_layout Plain Layout
26392 \begin_inset space ~
26396 \begin_inset space ~
26404 This command specifies that resizing is done via an optional argument.
26405 This command may occur once or not at all.
26408 \begin_layout Description
26409 \begin_inset Flex Code
26412 \begin_layout Plain Layout
26414 \begin_inset space ~
26418 \begin_inset space ~
26426 This command specifies that clipping is done via an optional argument.
26427 This command may occur once or not at all.
26430 \begin_layout Description
26431 \begin_inset Flex Code
26434 \begin_layout Plain Layout
26436 \begin_inset space ~
26440 \begin_inset space ~
26448 This command specifies that an extra optional argument is used.
26449 This command may occur once or not at all.
26452 \begin_layout Description
26453 \begin_inset Flex Code
26456 \begin_layout Plain Layout
26458 \begin_inset space ~
26466 The file format of the converted file.
26467 This must be the name of a format that is known to \SpecialChar LyX
26469 \begin_inset Flex Noun
26472 \begin_layout Plain Layout
26473 Tools\SpecialChar menuseparator
26474 Preferences\SpecialChar menuseparator
26475 File Handling\SpecialChar menuseparator
26482 This command must occur exactly once.
26483 If the resulting file format is PDF, you need to specify the format
26484 \begin_inset Flex Code
26487 \begin_layout Plain Layout
26494 This is the PDF format used for including graphics.
26495 The other defined PDF formats are for document export.
26498 \begin_layout Description
26499 \begin_inset Flex Code
26502 \begin_layout Plain Layout
26504 \begin_inset space ~
26512 The file name of the converted file.
26513 The file name must be absolute.
26514 This command must occur exactly once.
26517 \begin_layout Subsection
26518 Preamble definitions
26521 \begin_layout Standard
26522 The external template configuration file may contain additional preamble
26523 definitions enclosed by
26524 \begin_inset Flex Code
26527 \begin_layout Plain Layout
26535 \begin_inset Flex Code
26538 \begin_layout Plain Layout
26545 They can be used by the templates in the
26546 \begin_inset Flex Code
26549 \begin_layout Plain Layout
26558 \begin_layout Section
26559 The substitution mechanism
26562 \begin_layout Standard
26563 When the external material facility invokes an external program, it is done
26564 on the basis of a command defined in the template configuration file.
26565 These commands can contain various macros that are expanded before execution.
26566 Execution always take place in the directory of the containing document.
26569 \begin_layout Standard
26570 Also, whenever external material is to be displayed, the name will be produced
26571 by the substitution mechanism, and most other commands in the template
26572 definition support substitution as well.
26575 \begin_layout Standard
26576 The available macros are the following:
26579 \begin_layout Description
26580 \begin_inset Flex Code
26583 \begin_layout Plain Layout
26584 $$AbsOrRelPathMaster
26589 The file path, absolute or relative to the master \SpecialChar LyX
26593 \begin_layout Description
26594 \begin_inset Flex Code
26597 \begin_layout Plain Layout
26598 $$AbsOrRelPathParent
26603 The file path, absolute or relative to the \SpecialChar LyX
26607 \begin_layout Description
26608 \begin_inset Flex Code
26611 \begin_layout Plain Layout
26617 The absolute file path.
26620 \begin_layout Description
26621 \begin_inset Flex Code
26624 \begin_layout Plain Layout
26630 The filename without path and without the extension.
26633 \begin_layout Description
26634 \begin_inset Flex Code
26637 \begin_layout Plain Layout
26639 \begin_inset Quotes eld
26643 \begin_inset Quotes erd
26651 This macro will expand to the contents of the file with the name
26652 \begin_inset Flex Code
26655 \begin_layout Plain Layout
26664 \begin_layout Description
26665 \begin_inset Flex Code
26668 \begin_layout Plain Layout
26674 The file extension (including the dot).
26677 \begin_layout Description
26678 \begin_inset Flex Code
26681 \begin_layout Plain Layout
26687 This will be the string
26688 \begin_inset Quotes eld
26692 \begin_inset Quotes erd
26695 if the file is in JPEG format, otherwise it will be the string
26696 \begin_inset Quotes eld
26700 \begin_inset Quotes erd
26704 This is useful to avoid uneeded conversions for output formats that support
26705 both PNG and JPEG fomats.
26706 The predefined RasterImage template uses this macro for the pdf\SpecialChar TeX
26711 \begin_layout Description
26712 \begin_inset Flex Code
26715 \begin_layout Plain Layout
26721 The filename of the file specified in the external material dialog.
26722 This is either an absolute name, or it is relative to the \SpecialChar LyX
26726 \begin_layout Description
26727 \begin_inset Flex Code
26730 \begin_layout Plain Layout
26737 \begin_inset Flex Code
26740 \begin_layout Plain Layout
26746 (absolute name or relative to the \SpecialChar LyX
26750 \begin_layout Description
26751 \begin_inset Flex Code
26754 \begin_layout Plain Layout
26760 The file path, relative to the master \SpecialChar LyX
26764 \begin_layout Description
26765 \begin_inset Flex Code
26768 \begin_layout Plain Layout
26774 The file path, relative to the \SpecialChar LyX
26778 \begin_layout Description
26779 \begin_inset Flex Code
26782 \begin_layout Plain Layout
26788 This macro will expand to the absolute path of the system directory.
26789 This is typically used to point to the various helper scripts that are
26790 bundled with \SpecialChar LyX
26794 \begin_layout Description
26795 \begin_inset Flex Code
26798 \begin_layout Plain Layout
26804 A name and full path to a temporary file which will be automatically deleted
26805 whenever the containing document is closed, or the external material insertion
26809 \begin_layout Standard
26810 All path macros contain a trailing directory separator, so you can construct
26812 \begin_inset space \thinspace{}
26816 \begin_inset space \space{}
26819 the absolute filename with
26820 \begin_inset Flex Code
26823 \begin_layout Plain Layout
26824 $$AbsPath$$Basename$$Extension
26832 \begin_layout Standard
26833 The macros above are substituted in all commands unless otherwise noted.
26835 \begin_inset Flex Code
26838 \begin_layout Plain Layout
26844 supports additionally the following substitutions if they are enabled by
26846 \begin_inset Flex Code
26849 \begin_layout Plain Layout
26856 \begin_inset Flex Code
26859 \begin_layout Plain Layout
26868 \begin_layout Description
26869 \begin_inset Flex Code
26872 \begin_layout Plain Layout
26878 The front part of the resize command.
26881 \begin_layout Description
26882 \begin_inset Flex Code
26885 \begin_layout Plain Layout
26891 The back part of the resize command.
26894 \begin_layout Description
26895 \begin_inset Flex Code
26898 \begin_layout Plain Layout
26904 The front part of the rotation command.
26907 \begin_layout Description
26908 \begin_inset Flex Code
26911 \begin_layout Plain Layout
26917 The back part of the rotation command.
26920 \begin_layout Standard
26921 The value string of the
26922 \begin_inset Flex Code
26925 \begin_layout Plain Layout
26931 command supports additionally the following substitutions if they are enabled
26933 \begin_inset Flex Code
26936 \begin_layout Plain Layout
26943 \begin_inset Flex Code
26946 \begin_layout Plain Layout
26955 \begin_layout Description
26956 \begin_inset Flex Code
26959 \begin_layout Plain Layout
26968 \begin_layout Description
26969 \begin_inset Flex Code
26972 \begin_layout Plain Layout
26981 \begin_layout Description
26982 \begin_inset Flex Code
26985 \begin_layout Plain Layout
26994 \begin_layout Description
26995 \begin_inset Flex Code
26998 \begin_layout Plain Layout
27004 The rotation option.
27007 \begin_layout Standard
27008 You may ask why there are so many path macros.
27009 There are mainly two reasons:
27012 \begin_layout Enumerate
27013 Relative and absolute file names should remain relative or absolute, respectivel
27015 Users may have reasons to prefer either form.
27016 Relative names are useful for portable documents that should work on different
27017 machines, for example.
27018 Absolute names may be required by some programs.
27021 \begin_layout Enumerate
27023 treats relative file names differently than \SpecialChar LyX
27024 and other programs in nested
27026 For \SpecialChar LyX
27027 , a relative file name is always relative to the document that contains
27029 For \SpecialChar LaTeX
27030 , it is always relative to the master document.
27031 These two definitions are identical if you have only one document, but
27032 differ if you have a master document that includes part documents.
27033 That means that relative filenames must be transformed when presented to
27036 Fortunately \SpecialChar LyX
27037 does this automatically for you if you choose the right macros.
27040 \begin_layout Standard
27041 So which path macro should be used in new template definitions? The rule
27045 \begin_layout Itemize
27047 \begin_inset Flex Code
27050 \begin_layout Plain Layout
27056 if an absolute path is required.
27059 \begin_layout Itemize
27061 \begin_inset Flex Code
27064 \begin_layout Plain Layout
27065 $$AbsOrRelPathMaster
27070 if the substituted string is some kind of \SpecialChar LaTeX
27074 \begin_layout Itemize
27076 \begin_inset Flex Code
27079 \begin_layout Plain Layout
27080 $$AbsOrRelPathParent
27085 in order to preserve the user's choice.
27088 \begin_layout Standard
27089 There are special cases where this rule does not work and e.
27090 \begin_inset space \thinspace{}
27094 \begin_inset space \space{}
27097 relative names are needed, but normally it will work just fine.
27098 One example for such a case is the command
27099 \begin_inset Flex Code
27102 \begin_layout Plain Layout
27103 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
27108 in the XFig template above: We can't use the absolute name because the
27110 \begin_inset Flex Code
27113 \begin_layout Plain Layout
27119 files needs the relative name in order to rewrite the file content.
27122 \begin_layout Section
27123 Security discussion
27124 \begin_inset CommandInset label
27126 name "sec:Security-discussion"
27133 \begin_layout Standard
27134 The external material feature interfaces with a lot of external programs
27135 and does so automatically, so we have to consider the security implications
27137 In particular, since you have the option of including your own filenames
27138 and/or parameter strings and those are expanded into a command, it seems
27139 that it would be possible to create a malicious document which executes
27140 arbitrary commands when a user views or prints the document.
27141 This is something we definitely want to avoid.
27144 \begin_layout Standard
27145 However, since the external program commands are specified in the template
27146 configuration file only, there are no security issues if \SpecialChar LyX
27147 is properly configure
27148 d with safe templates only.
27149 This is so because the external programs are invoked with the
27150 \begin_inset Flex Code
27153 \begin_layout Plain Layout
27159 -system call rather than the
27160 \begin_inset Flex Code
27163 \begin_layout Plain Layout
27169 system-call, so it's not possible to execute arbitrary commands from the
27170 filename or parameter section via the shell.
27173 \begin_layout Standard
27174 This also implies that you are restricted in what command strings you can
27175 use in the external material templates.
27176 In particular, pipes and redirection are not readily available.
27177 This has to be so if \SpecialChar LyX
27178 should remain safe.
27179 If you want to use some of the shell features, you should write a safe
27180 script to do this in a controlled manner, and then invoke the script from
27181 the command string.
27185 \begin_layout Standard
27186 It is possible to design a template that interacts directly with the shell,
27187 but since this would allow a malicious user to execute arbitrary commands
27188 by writing clever filenames and/or parameters, we generally recommend that
27189 you only use safe scripts that work with the
27190 \begin_inset Flex Code
27193 \begin_layout Plain Layout
27199 system call in a controlled manner.
27200 Of course, for use in a controlled environment, it can be tempting to just
27201 fall back to use ordinary shell scripts.
27202 If you do so, be aware that you
27206 provide an easily exploitable security hole in your system.
27207 Of course it stands to reason that such unsafe templates will never be
27208 included in the standard \SpecialChar LyX
27209 distribution, although we do encourage people
27210 to submit new templates in the open source tradition.
27211 But \SpecialChar LyX
27212 as shipped from the official distribution channels will never have
27216 \begin_layout Standard
27217 Including external material provides a lot of power, and you have to be
27218 careful not to introduce security hazards with this power.
27219 A subtle error in a single line in an innocent looking script can open
27220 the door to huge security problems.
27221 So if you do not fully understand the issues, we recommend that you consult
27222 a knowledgeable security professional or the \SpecialChar LyX
27223 development team if you have
27224 any questions about whether a given template is safe or not.
27225 And do this before you use it in an uncontrolled environment.
27228 \begin_layout Chapter
27230 List of supported \SpecialChar LyX
27231 functions to be used in layouts
27232 \begin_inset CommandInset label
27234 name "chap:List-of-functions"
27241 \begin_layout Standard
27243 \begin_inset Tabular
27244 <lyxtabular version="3" rows="11" columns="8">
27245 <features tabularvalignment="middle">
27246 <column alignment="left" valignment="top">
27247 <column alignment="left" valignment="top">
27248 <column alignment="left" valignment="top">
27249 <column alignment="left" valignment="top">
27250 <column alignment="left" valignment="top">
27251 <column alignment="left" valignment="top">
27252 <column alignment="left" valignment="top">
27253 <column alignment="left" valignment="top">
27255 <cell alignment="left" valignment="top" usebox="none">
27258 \begin_layout Plain Layout
27264 <cell alignment="left" valignment="top" usebox="none">
27267 \begin_layout Plain Layout
27273 <cell alignment="left" valignment="top" usebox="none">
27276 \begin_layout Plain Layout
27282 <cell alignment="left" valignment="top" usebox="none">
27285 \begin_layout Plain Layout
27291 <cell alignment="center" valignment="top" usebox="none">
27294 \begin_layout Plain Layout
27300 <cell alignment="center" valignment="top" usebox="none">
27303 \begin_layout Plain Layout
27309 <cell alignment="center" valignment="top" usebox="none">
27312 \begin_layout Plain Layout
27318 <cell alignment="center" valignment="top" usebox="none">
27321 \begin_layout Plain Layout
27329 <cell alignment="left" valignment="top" usebox="none">
27332 \begin_layout Plain Layout
27338 <cell alignment="left" valignment="top" usebox="none">
27341 \begin_layout Plain Layout
27347 <cell alignment="left" valignment="top" usebox="none">
27350 \begin_layout Plain Layout
27356 <cell alignment="left" valignment="top" usebox="none">
27359 \begin_layout Plain Layout
27365 <cell alignment="center" valignment="top" usebox="none">
27368 \begin_layout Plain Layout
27374 <cell alignment="center" valignment="top" usebox="none">
27377 \begin_layout Plain Layout
27383 <cell alignment="center" valignment="top" usebox="none">
27386 \begin_layout Plain Layout
27392 <cell alignment="center" valignment="top" usebox="none">
27395 \begin_layout Plain Layout
27403 <cell alignment="left" valignment="top" usebox="none">
27406 \begin_layout Plain Layout
27412 <cell alignment="left" valignment="top" usebox="none">
27415 \begin_layout Plain Layout
27421 <cell alignment="left" valignment="top" usebox="none">
27424 \begin_layout Plain Layout
27430 <cell alignment="left" valignment="top" usebox="none">
27433 \begin_layout Plain Layout
27439 <cell alignment="center" valignment="top" usebox="none">
27442 \begin_layout Plain Layout
27448 <cell alignment="center" valignment="top" usebox="none">
27451 \begin_layout Plain Layout
27457 <cell alignment="center" valignment="top" usebox="none">
27460 \begin_layout Plain Layout
27466 <cell alignment="center" valignment="top" usebox="none">
27469 \begin_layout Plain Layout
27477 <cell alignment="left" valignment="top" usebox="none">
27480 \begin_layout Plain Layout
27486 <cell alignment="left" valignment="top" usebox="none">
27489 \begin_layout Plain Layout
27495 <cell alignment="left" valignment="top" usebox="none">
27498 \begin_layout Plain Layout
27504 <cell alignment="left" valignment="top" usebox="none">
27507 \begin_layout Plain Layout
27513 <cell alignment="center" valignment="top" usebox="none">
27516 \begin_layout Plain Layout
27522 <cell alignment="center" valignment="top" usebox="none">
27525 \begin_layout Plain Layout
27531 <cell alignment="center" valignment="top" usebox="none">
27534 \begin_layout Plain Layout
27540 <cell alignment="center" valignment="top" usebox="none">
27543 \begin_layout Plain Layout
27551 <cell alignment="left" valignment="top" usebox="none">
27554 \begin_layout Plain Layout
27560 <cell alignment="left" valignment="top" usebox="none">
27563 \begin_layout Plain Layout
27569 <cell alignment="left" valignment="top" usebox="none">
27572 \begin_layout Plain Layout
27578 <cell alignment="left" valignment="top" usebox="none">
27581 \begin_layout Plain Layout
27587 <cell alignment="center" valignment="top" usebox="none">
27590 \begin_layout Plain Layout
27596 <cell alignment="center" valignment="top" usebox="none">
27599 \begin_layout Plain Layout
27605 <cell alignment="center" valignment="top" usebox="none">
27608 \begin_layout Plain Layout
27614 <cell alignment="center" valignment="top" usebox="none">
27617 \begin_layout Plain Layout
27625 <cell alignment="left" valignment="top" usebox="none">
27628 \begin_layout Plain Layout
27634 <cell alignment="left" valignment="top" usebox="none">
27637 \begin_layout Plain Layout
27643 <cell alignment="left" valignment="top" usebox="none">
27646 \begin_layout Plain Layout
27652 <cell alignment="left" valignment="top" usebox="none">
27655 \begin_layout Plain Layout
27661 <cell alignment="center" valignment="top" usebox="none">
27664 \begin_layout Plain Layout
27670 <cell alignment="center" valignment="top" usebox="none">
27673 \begin_layout Plain Layout
27679 <cell alignment="center" valignment="top" usebox="none">
27682 \begin_layout Plain Layout
27688 <cell alignment="center" valignment="top" usebox="none">
27691 \begin_layout Plain Layout
27699 <cell alignment="left" valignment="top" usebox="none">
27702 \begin_layout Plain Layout
27708 <cell alignment="left" valignment="top" usebox="none">
27711 \begin_layout Plain Layout
27717 <cell alignment="left" valignment="top" usebox="none">
27720 \begin_layout Plain Layout
27726 <cell alignment="left" valignment="top" usebox="none">
27729 \begin_layout Plain Layout
27735 <cell alignment="center" valignment="top" usebox="none">
27738 \begin_layout Plain Layout
27744 <cell alignment="center" valignment="top" usebox="none">
27747 \begin_layout Plain Layout
27753 <cell alignment="center" valignment="top" usebox="none">
27756 \begin_layout Plain Layout
27762 <cell alignment="center" valignment="top" usebox="none">
27765 \begin_layout Plain Layout
27773 <cell alignment="left" valignment="top" usebox="none">
27776 \begin_layout Plain Layout
27782 <cell alignment="left" valignment="top" usebox="none">
27785 \begin_layout Plain Layout
27791 <cell alignment="left" valignment="top" usebox="none">
27794 \begin_layout Plain Layout
27800 <cell alignment="left" valignment="top" usebox="none">
27803 \begin_layout Plain Layout
27809 <cell alignment="center" valignment="top" usebox="none">
27812 \begin_layout Plain Layout
27818 <cell alignment="center" valignment="top" usebox="none">
27821 \begin_layout Plain Layout
27827 <cell alignment="center" valignment="top" usebox="none">
27830 \begin_layout Plain Layout
27836 <cell alignment="center" valignment="top" usebox="none">
27839 \begin_layout Plain Layout
27847 <cell alignment="left" valignment="top" usebox="none">
27850 \begin_layout Plain Layout
27856 <cell alignment="left" valignment="top" usebox="none">
27859 \begin_layout Plain Layout
27865 <cell alignment="left" valignment="top" usebox="none">
27868 \begin_layout Plain Layout
27874 <cell alignment="left" valignment="top" usebox="none">
27877 \begin_layout Plain Layout
27883 <cell alignment="center" valignment="top" usebox="none">
27886 \begin_layout Plain Layout
27892 <cell alignment="center" valignment="top" usebox="none">
27895 \begin_layout Plain Layout
27901 <cell alignment="center" valignment="top" usebox="none">
27904 \begin_layout Plain Layout
27910 <cell alignment="center" valignment="top" usebox="none">
27913 \begin_layout Plain Layout
27921 <cell alignment="left" valignment="top" usebox="none">
27924 \begin_layout Plain Layout
27930 <cell alignment="left" valignment="top" usebox="none">
27933 \begin_layout Plain Layout
27939 <cell alignment="left" valignment="top" usebox="none">
27942 \begin_layout Plain Layout
27948 <cell alignment="left" valignment="top" usebox="none">
27951 \begin_layout Plain Layout
27957 <cell alignment="center" valignment="top" usebox="none">
27960 \begin_layout Plain Layout
27966 <cell alignment="center" valignment="top" usebox="none">
27969 \begin_layout Plain Layout
27975 <cell alignment="center" valignment="top" usebox="none">
27978 \begin_layout Plain Layout
27984 <cell alignment="center" valignment="top" usebox="none">
27987 \begin_layout Plain Layout
27995 <cell alignment="center" valignment="top" usebox="none">
27998 \begin_layout Plain Layout
28004 <cell alignment="center" valignment="top" usebox="none">
28007 \begin_layout Plain Layout
28013 <cell alignment="center" valignment="top" usebox="none">
28016 \begin_layout Plain Layout
28022 <cell alignment="center" valignment="top" usebox="none">
28025 \begin_layout Plain Layout
28031 <cell alignment="center" valignment="top" usebox="none">
28034 \begin_layout Plain Layout
28040 <cell alignment="center" valignment="top" usebox="none">
28043 \begin_layout Plain Layout
28049 <cell alignment="center" valignment="top" usebox="none">
28052 \begin_layout Plain Layout
28058 <cell alignment="center" valignment="top" usebox="none">
28061 \begin_layout Plain Layout
28075 \begin_layout Chapter
28076 Names of available colors to be used in layouts
28077 \begin_inset CommandInset label
28079 name "chap:Names-of-colors"
28086 \begin_layout Standard
28087 The colors listed below are the standard colors and those that you can adjust
28088 in the \SpecialChar LyX
28092 \begin_layout Section
28096 \begin_layout Standard
28097 The following are no real colors, but rather act on color definitions:
28100 \begin_layout Description
28101 ignore The color is ignored
28104 \begin_layout Description
28105 inherit The color is inherited
28108 \begin_layout Description
28121 No particular color – clear or default
28124 \begin_layout Section
28128 \begin_layout Standard
28129 These are fixed colors that cannot me customized:
28132 \begin_layout Description
28136 \begin_layout Description
28140 \begin_layout Description
28144 \begin_layout Description
28148 \begin_layout Description
28152 \begin_layout Description
28156 \begin_layout Description
28160 \begin_layout Description
28164 \begin_layout Description
28168 \begin_layout Description
28172 \begin_layout Description
28176 \begin_layout Description
28180 \begin_layout Description
28184 \begin_layout Description
28188 \begin_layout Description
28192 \begin_layout Description
28196 \begin_layout Description
28200 \begin_layout Description
28204 \begin_layout Description
28208 \begin_layout Section
28212 \begin_layout Standard
28213 These are the colors allocated to specific elements in
28216 arg "dialog-show prefs"
28222 \begin_layout Description
28223 added_space Added space color
28226 \begin_layout Description
28227 addedtext Added text color
28230 \begin_layout Description
28231 appendix Appendix marker color
28234 \begin_layout Description
28235 background Background color
28238 \begin_layout Description
28239 bottomarea Bottom area color
28242 \begin_layout Description
28243 branchlabel Label color for branches
28246 \begin_layout Description
28247 buttonbg Color used for button background
28250 \begin_layout Description
28251 buttonframe Color for inset button frames
28254 \begin_layout Description
28255 buttonhoverbg Color used for button background under focus
28258 \begin_layout Description
28259 changebar Changebar color
28262 \begin_layout Description
28263 changedtextauthor1 Changed text color author 1
28266 \begin_layout Description
28267 changedtextauthor2 Changed text color author 2
28270 \begin_layout Description
28271 changedtextauthor3 Changed text color author 3
28274 \begin_layout Description
28275 changedtextauthor4 Changed text color author 4
28278 \begin_layout Description
28279 changedtextauthor5 Changed text color author 5
28282 \begin_layout Description
28283 collapsible Collapsible insets text color
28286 \begin_layout Description
28287 collapsibleframe Collapsible insets framecolor
28290 \begin_layout Description
28291 command Text color for command insets
28294 \begin_layout Description
28295 commandbg Background color for command insets
28298 \begin_layout Description
28299 commandframe Frame color for command insets
28302 \begin_layout Description
28303 comment Label color for comments
28306 \begin_layout Description
28307 commentbg Background color of comments
28310 \begin_layout Description
28311 cursor Cursor color
28314 \begin_layout Description
28315 deletedtext Deleted text color
28318 \begin_layout Description
28319 deletedtextmodifier Deleted text modifying color
28322 \begin_layout Description
28323 depthbar Color for the depth bars in the margin
28326 \begin_layout Description
28327 eolmarker End of line marker color
28330 \begin_layout Description
28331 error Color of the \SpecialChar LaTeX
28335 \begin_layout Description
28336 footlabel Label color for footnotes
28339 \begin_layout Description
28340 foreground Foreground color
28343 \begin_layout Description
28344 graphicsbg Graphics inset background color
28347 \begin_layout Description
28348 greyedoutbg Background color of greyedout inset
28351 \begin_layout Description
28352 greyedoutlabel Label color for greyedout insets
28355 \begin_layout Description
28356 greyedouttext Color for greyedout inset text
28359 \begin_layout Description
28360 indexlabel Label color for index insets
28363 \begin_layout Description
28364 inlinecompletion Inline completion color
28367 \begin_layout Description
28368 insetbg Inset marker background color
28371 \begin_layout Description
28372 insetframe Inset marker frame color
28375 \begin_layout Description
28376 language Color for marking foreign language words
28379 \begin_layout Description
28380 latex Text color in \SpecialChar LaTeX
28384 \begin_layout Description
28385 listingsbg Background color of listings inset
28388 \begin_layout Description
28389 marginlabel Label color for margin notes
28392 \begin_layout Description
28393 math Math inset text color
28396 \begin_layout Description
28397 mathbg Math inset background color
28400 \begin_layout Description
28401 mathcorners Math inset frame color not under focus
28404 \begin_layout Description
28405 mathframe Math inset frame color under focus
28408 \begin_layout Description
28409 mathline Math line color
28412 \begin_layout Description
28413 mathmacrobg Macro math inset background color
28416 \begin_layout Description
28417 mathmacroblend Macro math blended color
28420 \begin_layout Description
28421 mathmacroframe Macro math frame color
28424 \begin_layout Description
28425 mathmacrohoverbg Macro math inset background color hovered
28428 \begin_layout Description
28429 mathmacrolabel Macro math label color
28432 \begin_layout Description
28433 mathmacronewarg Macro template color for new parameters
28436 \begin_layout Description
28437 mathmacrooldarg Macro template color for old parameters
28440 \begin_layout Description
28441 newpage New page color
28444 \begin_layout Description
28445 nonunique_inlinecompletion Inline completion color for the non-unique part
28448 \begin_layout Description
28449 note Label color for notes
28452 \begin_layout Description
28453 notebg Background color of notes
28456 \begin_layout Description
28457 pagebreak Page break/line break color
28460 \begin_layout Description
28461 paragraphmarker Color used for the pilcrow sign to mark the end of a paragraph
28464 \begin_layout Description
28465 phantomtext Text color for phantom insets
28468 \begin_layout Description
28469 preview The color used for previews
28472 \begin_layout Description
28473 previewframe Preview frame color
28476 \begin_layout Description
28477 regexpframe Color for regexp frame
28480 \begin_layout Description
28481 scroll Color that indicates when a row can be scrolled
28484 \begin_layout Description
28485 selection Background color of selected text
28488 \begin_layout Description
28489 selectiontext Foreground color of selected text
28492 \begin_layout Description
28493 shadedbg Background color of shaded box
28496 \begin_layout Description
28497 special Special chars text color
28500 \begin_layout Description
28501 tabularline Table line color
28504 \begin_layout Description
28505 tabularonoffline Table line color
28508 \begin_layout Description
28509 urllabel Label color for URL insets
28512 \begin_layout Description
28513 urltext Color for URL inset text