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#PO-Mode
3292 For some menu- and widget-labels, there are also shortcut keys that should
3294 Those keys are marked after a `|', and should be translated according to
3295 the words and phrases of the language.
3296 You should also fill also out the information at the beginning of the new
3298 \begin_inset Flex Code
3301 \begin_layout Plain Layout
3307 -file with your email-address, etc., so people know where to reach you with
3308 suggestions and entertaining flames.
3311 \begin_layout Standard
3312 If you are just doing this on your own, then:
3315 \begin_layout Itemize
3317 \begin_inset Flex Code
3320 \begin_layout Plain Layout
3327 This can be done with
3328 \begin_inset Flex Code
3331 \begin_layout Plain Layout
3332 msgfmt -o xx.mo < xx.po
3340 \begin_layout Itemize
3342 \begin_inset Flex Code
3345 \begin_layout Plain Layout
3351 -file to your locale-tree, at the correct directory for application messages
3356 xx, and under the name
3357 \begin_inset Flex Code
3360 \begin_layout Plain Layout
3367 \begin_inset space \thinspace{}
3371 \begin_inset space \space{}
3375 \begin_inset Flex Code
3378 \begin_layout Plain Layout
3379 /usr/local/share/locale/xx/LC_MESSAGES/lyx.mo
3389 \begin_layout Standard
3390 As said, however, it would be best if the new
3391 \begin_inset Flex Code
3394 \begin_layout Plain Layout
3400 file could be added to the \SpecialChar LyX
3401 distribution, so others can use it.
3402 Adding it involves making additional changes to \SpecialChar LyX
3404 So send an email to the developers' mailing list if you're interested in
3408 \begin_layout Subsubsection
3412 \begin_layout Standard
3413 Sometimes it turns out that one English message needs to be translated into
3414 different messages in the target language.
3415 One example is the message
3416 \begin_inset Flex Code
3419 \begin_layout Plain Layout
3425 which has the German translation
3433 , depending upon exactly what the English
3434 \begin_inset Quotes eld
3438 \begin_inset Quotes erd
3443 \begin_inset Flex Code
3446 \begin_layout Plain Layout
3452 does not handle such ambiguous translations.
3453 Therefore you have to add some context information to the message: Instead
3455 \begin_inset Flex Code
3458 \begin_layout Plain Layout
3465 \begin_inset Flex Code
3468 \begin_layout Plain Layout
3469 To[[as in 'From format x to format y']]
3475 \begin_inset Flex Code
3478 \begin_layout Plain Layout
3479 To[[as in 'From page x to page y']].
3484 Now the two occurrences of
3485 \begin_inset Flex Code
3488 \begin_layout Plain Layout
3495 \begin_inset Flex Code
3498 \begin_layout Plain Layout
3504 and can be translated correctly to
3515 \begin_layout Standard
3516 Of course the context information needs to be stripped off the original
3517 message when no translation is used.
3518 Therefore you have to put it in double square brackets at the end of the
3519 message (see the example above).
3520 The translation mechanism of \SpecialChar LyX
3521 ensures that everything in double square
3522 brackets at the end of messages is removed before displaying the message.
3525 \begin_layout Subsection
3526 Translating the documentation.
3529 \begin_layout Standard
3530 The online documentation (in the
3531 \begin_inset Flex Noun
3534 \begin_layout Plain Layout
3540 -menu) can (and should!) be translated.
3541 If there are translated versions of the documentation available
3545 \begin_layout Plain Layout
3546 As of March 2008, at least some of the documents have been translated into
3547 fourteen languages, with the Tutorial available in a few more.
3552 and the locale is set accordingly, these will be used automagically by
3556 looks for translated versions as
3557 \begin_inset Flex Code
3560 \begin_layout Plain Layout
3561 LyXDir/doc/xx/DocName.lyx
3567 \begin_inset Flex Code
3570 \begin_layout Plain Layout
3576 is the code for the language currently in use.
3577 If there are no translated documents, the default English versions will
3579 Note that the translated versions must have the same filenames (
3580 \begin_inset Flex Code
3583 \begin_layout Plain Layout
3589 above) as the original.
3590 If you feel up to translating the documentation (an excellent way to proof-read
3591 the original documentation by the way!), there are a few things you should
3595 \begin_layout Itemize
3596 Check out the documentation translation web page at
3597 \begin_inset CommandInset href
3599 name "https://www.lyx.org/Translation"
3600 target "https://www.lyx.org/Translation"
3606 That way, you can find out which (if any) documents have already been translate
3607 d into your language.
3608 You can also find out who (if anyone) is organizing the effort to translate
3609 the documentation into your language.
3610 If no one is organizing the effort, please let us know that you're interested.
3613 \begin_layout Standard
3614 Once you get to actually translating, here's a few hints for you that may
3618 \begin_layout Itemize
3619 Join the documentation team! There is information on how to do that in
3620 \begin_inset Flex Code
3623 \begin_layout Plain Layout
3630 \begin_inset Flex Noun
3633 \begin_layout Plain Layout
3634 Help\SpecialChar menuseparator
3640 ), which by the way is the first document you should translate.
3643 \begin_layout Itemize
3644 Learn the typographic conventions for the language you are translating to.
3645 Typography is an ancient art and over the centuries, a great variety of
3646 conventions have developed throughout different parts of the world.
3647 Also study the professional terminology amongst typographers in your country.
3648 Inventing your own terminology will only confuse the users.
3651 (Warning! Typography is addictive!)
3654 \begin_layout Itemize
3655 Make a copy of the document.
3656 This will be your working copy.
3657 You can use this as your personal translated help-file by placing it in
3659 \begin_inset Flex Code
3662 \begin_layout Plain Layout
3669 \begin_inset Note Greyedout
3672 \begin_layout Plain Layout
3677 For a complex document with external material (images, etc.), if you make
3679 \begin_inset space \thinspace{}
3683 \begin_inset space \space{}
3686 in a temp dir, beware that the links to external material may be broken
3687 when the document is moved to a different place.
3688 The best way is to retrieve the \SpecialChar LyX
3690 \begin_inset Flex URL
3693 \begin_layout Plain Layout
3695 https://www.lyx.org/HowToUseGIT
3700 ) and to edit the doc file in place.
3708 \begin_layout Itemize
3709 Sometimes the original document (from the \SpecialChar LyX
3710 team) will be updated.
3711 Use the source viewer at
3712 \begin_inset CommandInset href
3714 name "https://www.lyx.org/trac/timeline"
3715 target "https://www.lyx.org/trac/timeline"
3720 to see what has been changed.
3721 That way you can easily see which parts of the translated document need
3725 \begin_layout Standard
3726 If you ever find an error in the original document, fix it and notify the
3727 rest of the documentation team of the changes! (You didn't forget to join
3728 the documentation team, did you?)
3731 \begin_layout Standard
3732 \begin_inset Branch OutDated
3736 \begin_layout Section
3737 International Keyboard Support
3740 \begin_layout Standard
3743 [Editor's Note: The following section is by
3751 It needs to be fixed to conform to the new Documentation Style sheet and
3752 to make use of the new v1.0 features.
3753 The whole thing also needs to be merged with the section following it.-jw
3754 It may also be badly out of date.-rh (2008)]
3757 \begin_layout Subsection
3758 Defining Own Keymaps: Keymap File Format
3761 \begin_layout Standard
3762 Let's look at a keyboard definition file a little closer.
3763 It is a plain text file defining
3766 \begin_layout Itemize
3767 key-to-key or key-to-string translations
3770 \begin_layout Itemize
3774 \begin_layout Itemize
3775 dead keys exceptions
3778 \begin_layout Standard
3779 To define key-to-key or key-to-string translation, use this command:
3782 \begin_layout Quotation
3783 \begin_inset Flex Code
3786 \begin_layout Plain Layout
3795 \begin_inset Flex Code
3798 \begin_layout Plain Layout
3807 \begin_layout Standard
3809 \begin_inset Flex Code
3812 \begin_layout Plain Layout
3818 is the key to be translated and
3819 \begin_inset Flex Code
3822 \begin_layout Plain Layout
3828 is the string to be inserted into the document.
3829 To define dead keys, use:
3832 \begin_layout Quotation
3833 \begin_inset Flex Code
3836 \begin_layout Plain Layout
3845 \begin_inset Flex Code
3848 \begin_layout Plain Layout
3857 \begin_layout Standard
3859 \begin_inset Flex Code
3862 \begin_layout Plain Layout
3868 is a keyboard key and
3869 \begin_inset Flex Code
3872 \begin_layout Plain Layout
3879 The following dead keys are supported (shortcut name is in parentheses):
3882 \begin_layout Quotation
3886 \begin_inset space \hfill{}
3892 \begin_layout Quotation
3894 \begin_inset space \hfill{}
3900 \begin_layout Quotation
3902 \begin_inset space \hfill{}
3908 \begin_layout Quotation
3910 \begin_inset space \hfill{}
3916 \begin_layout Quotation
3918 \begin_inset space \hfill{}
3924 \begin_layout Quotation
3926 \begin_inset space \hfill{}
3933 \begin_layout Plain Layout
3945 \begin_layout Quotation
3947 \begin_inset space \hfill{}
3953 \begin_layout Quotation
3955 \begin_inset space \hfill{}
3962 \begin_layout Plain Layout
3974 \begin_layout Quotation
3976 \begin_inset space \hfill{}
3982 \begin_layout Quotation
3984 \begin_inset space \hfill{}
3990 \begin_layout Quotation
3992 \begin_inset space \hfill{}
3999 \begin_layout Plain Layout
4011 \begin_layout Quotation
4013 \begin_inset space \hfill{}
4020 \begin_layout Plain Layout
4032 \begin_layout Quotation
4034 \begin_inset space \hfill{}
4040 \begin_layout Quotation
4041 hungarian umlaut (hug)
4042 \begin_inset space \hfill{}
4048 \begin_layout Quotation
4050 \begin_inset space \hfill{}
4056 \begin_layout Quotation
4058 \begin_inset space \hfill{}
4065 \begin_layout Plain Layout
4077 \begin_layout Standard
4078 Since in many international keyboards there are exceptions to what some
4079 dead keys should do, you can define them using
4082 \begin_layout Quotation
4083 \begin_inset Flex Code
4086 \begin_layout Plain Layout
4094 deadkey key outstring
4097 \begin_layout Standard
4098 For example, on Slovak keyboard, if you enter caron-o, it generates circumflex-o
4102 \begin_layout Quotation
4103 \begin_inset Flex Code
4106 \begin_layout Plain Layout
4119 \begin_layout Standard
4120 to make it work correctly.
4121 Also, you have to define as exceptions dead keys over i and j, to remove
4122 the dot from them before inserting an accent mark.
4123 I will change this when the time comes, but so far I haven't had time.
4126 \begin_layout Standard
4127 Oh, and about characters: backslash is escaped, so to enter it, you'll need
4130 \begin_inset Flex Code
4133 \begin_layout Plain Layout
4139 have different meaning.
4141 \begin_inset Flex Code
4144 \begin_layout Plain Layout
4150 marks comments, quotes start and end \SpecialChar LaTeX
4152 To enter quote, you'll need to use
4153 \begin_inset Flex Code
4156 \begin_layout Plain Layout
4165 \begin_inset Flex Code
4168 \begin_layout Plain Layout
4175 \begin_inset Flex Code
4178 \begin_layout Plain Layout
4189 \begin_layout Standard
4190 If you make a keyboard description file that works for your language, please
4191 mail it to me, so I can include it in the next keymap distribution.
4194 \begin_layout Standard
4195 More keywords will be supported in keymap configuration file in future,
4199 \begin_layout Itemize
4200 \begin_inset Flex Code
4203 \begin_layout Plain Layout
4214 \begin_inset space \hfill{}
4218 \begin_inset Flex Code
4221 \begin_layout Plain Layout
4230 \begin_layout Itemize
4231 \begin_inset Flex Code
4234 \begin_layout Plain Layout
4245 \begin_inset space \hfill{}
4249 \begin_inset Flex Code
4252 \begin_layout Plain Layout
4258 an external keymap translation program
4261 \begin_layout Standard
4262 Also, it should look into
4263 \begin_inset Flex Code
4266 \begin_layout Plain Layout
4272 file for defaults, too (for example, a
4273 \begin_inset Flex Code
4276 \begin_layout Plain Layout
4284 option to include default keyboard).
4292 \begin_layout Section
4293 International Keymap Stuff
4294 \begin_inset CommandInset label
4296 name "sec:International-Keymap-Stuff"
4303 \begin_layout Standard
4304 \begin_inset Note Note
4307 \begin_layout Plain Layout
4308 In doing the revisions on this document in March 2008, I did not look over
4309 this stuff, as I do not understand it.
4310 It would be good if someone else could do so.
4319 \begin_layout Standard
4320 The next two sections describe the
4321 \begin_inset Flex Code
4324 \begin_layout Plain Layout
4333 \begin_inset Flex Code
4336 \begin_layout Plain Layout
4344 file syntax in detail.
4345 These sections should help you design your own key map if the ones provided
4346 do not meet your needs.
4349 \begin_layout Subsection
4353 \begin_layout Standard
4357 \begin_inset Flex Code
4360 \begin_layout Plain Layout
4366 file maps keystrokes to characters or strings.
4367 As the name suggests, it sets a keyboard mapping.
4369 \begin_inset Flex Code
4372 \begin_layout Plain Layout
4383 \begin_inset Flex Code
4386 \begin_layout Plain Layout
4401 \begin_inset Flex Code
4404 \begin_layout Plain Layout
4417 \begin_inset Flex Code
4420 \begin_layout Plain Layout
4429 \begin_inset Flex Code
4432 \begin_layout Plain Layout
4440 are described in this section.
4443 \begin_layout Labeling
4444 \labelwidthstring 00.00.0000
4445 \begin_inset Flex Code
4448 \begin_layout Plain Layout
4456 Map a character to a string
4459 \begin_layout LyX-Code
4474 \begin_layout Standard
4507 the double-quote (")
4524 must be escaped with a preceding backslash (
4535 \begin_layout Standard
4537 \begin_inset Flex Noun
4540 \begin_layout Plain Layout
4548 statement to cause the symbol
4549 \begin_inset Flex Noun
4552 \begin_layout Plain Layout
4560 to be output for the keystroke
4561 \begin_inset Flex Noun
4564 \begin_layout Plain Layout
4575 \begin_layout LyX-Code
4581 \begin_layout Labeling
4582 \labelwidthstring 00.00.0000
4583 \begin_inset Flex Code
4586 \begin_layout Plain Layout
4594 Specify an accent character
4597 \begin_layout LyX-Code
4606 \begin_layout Standard
4607 This will make the cha
4645 This is the dead key
4649 \begin_layout Plain Layout
4656 refers to a key that does not produce a character by itself, but when followed
4657 with another key, produces the desired accent character.
4658 For example, a German characte
4660 r with an umlaut like
4670 can be produced in this manner.
4679 \begin_layout Standard
4692 and then another key not in
4709 followed by the other, not allowed key, as output.
4713 \begin_inset Flex Noun
4716 \begin_layout Plain Layout
4724 cancels a dead key, so if
4735 \begin_inset Flex Noun
4738 \begin_layout Plain Layout
4747 , the cursor will not go one position backwards but will instead cancel
4763 might have had on the next keystroke.
4767 \begin_layout Standard
4768 The following example specifies that the character ' is to be an acute accent,
4769 allowed on the characters a, e, i, o, u, A, E, I, O, and U:
4772 \begin_layout LyX-Code
4775 kmod ' acute aeiouAEIOU
4778 \begin_layout Labeling
4779 \labelwidthstring 00.00.0000
4780 \begin_inset Flex Code
4783 \begin_layout Plain Layout
4789 Specify an exception to the accent character
4792 \begin_layout LyX-Code
4801 \begin_layout Standard
4802 This defines an exce
4843 have been assigned a keystroke with a previous
4846 \begin_inset Flex Code
4849 \begin_layout Plain Layout
4873 must not belong in the
4920 If such a declaration does not exist in
4928 \begin_inset Flex Code
4931 \begin_layout Plain Layout
4965 \begin_inset Flex Code
4968 \begin_layout Plain Layout
4982 \begin_layout Standard
4983 The following command produces causes äi to be produced when you enter acute-i
4987 \begin_layout LyX-Code
5001 \begin_layout Labeling
5002 \labelwidthstring 00.00.0000
5003 \begin_inset Flex Code
5006 \begin_layout Plain Layout
5012 Combine two accent characters
5015 \begin_layout LyX-Code
5021 accent1 accent2 allowed
5024 \begin_layout Standard
5025 This one is getting pretty esoteric.
5026 It allows you to combine the effect
5082 \begin_inset Flex Code
5085 \begin_layout Plain Layout
5113 \begin_layout Standard
5114 Consider this example from the
5115 \begin_inset Flex Code
5118 \begin_layout Plain Layout
5129 \begin_layout LyX-Code
5132 kmod ; acute aeioyvhAEIOYVH
5136 kcomb acute umlaut iyIY
5139 \begin_layout Standard
5140 This allows you to press
5141 \begin_inset Flex Noun
5144 \begin_layout Plain Layout
5152 and get the effect of
5153 \begin_inset Flex Code
5156 \begin_layout Plain Layout
5175 in this case cancels the last dead key, so if you press
5176 \begin_inset Flex Noun
5179 \begin_layout Plain Layout
5188 \begin_inset Flex Code
5191 \begin_layout Plain Layout
5204 \begin_layout Subsection
5208 \begin_layout Standard
5210 \begin_inset Flex Code
5213 \begin_layout Plain Layout
5221 mapping is performed, a
5222 \begin_inset Flex Code
5225 \begin_layout Plain Layout
5235 file maps the strings that the symbols generate to characters in the current
5237 The \SpecialChar LyX
5238 distribution currently includes at least the
5239 \begin_inset Flex Code
5242 \begin_layout Plain Layout
5251 \begin_inset Flex Code
5254 \begin_layout Plain Layout
5265 \begin_layout Standard
5267 \begin_inset Flex Code
5270 \begin_layout Plain Layout
5278 file is a sequence of declarations of the form
5281 \begin_layout LyX-Code
5294 \begin_layout Standard
5295 For example, in order to map
5296 \begin_inset Flex Noun
5299 \begin_layout Plain Layout
5309 to the corresponding character in the iso-8859-1 set (233), the following
5313 \begin_layout LyX-Code
5321 \begin_layout Standard
5323 \begin_inset Flex Code
5326 \begin_layout Plain Layout
5335 \begin_inset Flex Code
5338 \begin_layout Plain Layout
5356 the same character can apply to more than one string.
5358 \begin_inset Flex Code
5361 \begin_layout Plain Layout
5372 \begin_layout LyX-Code
5384 \begin_inset Newline newline
5400 \begin_layout Standard
5402 cannot find a mapping for the string produced by the keystroke or a
5403 deadkey sequence, it will check if it looks like an accented char and try
5404 to draw an accent over the character on screen.
5407 \begin_layout Subsection
5411 \begin_layout Standard
5412 There is a second way to add support for international characters through
5413 so-called dead-keys.
5414 A dead-key works in combination with a letter to produce an accented character.
5415 Here, we'll explain how to create a really simple dead-key to illustrate
5419 \begin_layout Standard
5420 Suppose you happen to need the circumflex character,
5421 \begin_inset Quotes eld
5425 \begin_inset Quotes erd
5430 \begin_inset Flex Noun
5433 \begin_layout Plain Layout
5440 \begin_inset space ~
5444 \begin_inset Flex Noun
5447 \begin_layout Plain Layout
5453 ] to the \SpecialChar LyX
5455 \begin_inset Flex Code
5458 \begin_layout Plain Layout
5465 \begin_inset Flex Code
5468 \begin_layout Plain Layout
5475 Now, whenever you type the
5476 \begin_inset Flex Noun
5479 \begin_layout Plain Layout
5485 -key followed by a letter, that letter will have a circumflex accent on
5487 For example, the sequence
5488 \begin_inset Quotes eld
5492 \begin_inset Flex Noun
5495 \begin_layout Plain Layout
5502 \begin_inset Quotes erd
5505 produces the letter:
5506 \begin_inset Quotes eld
5510 \begin_inset Quotes erd
5514 If you tried to type
5515 \begin_inset Quotes eld
5519 \begin_inset Flex Noun
5522 \begin_layout Plain Layout
5529 \begin_inset Quotes erd
5532 , however, \SpecialChar LyX
5533 will complain with a beep, since a
5534 \begin_inset Quotes eld
5538 \begin_inset Flex Noun
5541 \begin_layout Plain Layout
5548 \begin_inset Quotes erd
5551 never takes a circumflex accent.
5553 \begin_inset Flex Noun
5556 \begin_layout Plain Layout
5562 after a dead-key produces the bare-accent.
5563 Please note this last point! If you bind a key to a dead-key, you'll need
5564 to rebind the character on that key to yet another key.
5566 \begin_inset Flex Noun
5569 \begin_layout Plain Layout
5575 to a cedilla is a bad idea, since you'll only get cedillas instead of commas.
5578 \begin_layout Standard
5579 One common way to bind dead-keys is to use
5580 \begin_inset Flex Noun
5583 \begin_layout Plain Layout
5590 \begin_inset Flex Noun
5593 \begin_layout Plain Layout
5600 \begin_inset Flex Noun
5603 \begin_layout Plain Layout
5609 in combination with an accent, like
5610 \begin_inset Quotes eld
5614 \begin_inset Flex Noun
5617 \begin_layout Plain Layout
5624 \begin_inset Quotes erd
5628 \begin_inset Quotes eld
5632 \begin_inset Flex Noun
5635 \begin_layout Plain Layout
5642 \begin_inset Quotes erd
5646 \begin_inset Quotes eld
5650 \begin_inset Flex Noun
5653 \begin_layout Plain Layout
5660 \begin_inset Quotes erd
5664 Another way involves using
5665 \begin_inset Flex Code
5668 \begin_layout Plain Layout
5675 \begin_inset Flex Code
5678 \begin_layout Plain Layout
5684 to set up the special
5685 \begin_inset Flex Code
5688 \begin_layout Plain Layout
5696 \begin_inset Flex Code
5699 \begin_layout Plain Layout
5705 acts in some ways just like
5706 \begin_inset Flex Noun
5709 \begin_layout Plain Layout
5715 and permits you to bind keys to accented characters.
5716 You can also turn keys into dead-keys by binding them to something like
5718 \begin_inset Flex Code
5721 \begin_layout Plain Layout
5727 and then binding this symbolic key to the corresponding \SpecialChar LyX
5732 \begin_layout Plain Layout
5737 : This is exactly what I do in my
5738 \begin_inset Flex Code
5741 \begin_layout Plain Layout
5748 \begin_inset Flex Code
5751 \begin_layout Plain Layout
5759 \begin_inset Flex Noun
5762 \begin_layout Plain Layout
5764 \begin_inset space ~
5773 \begin_inset Flex Code
5776 \begin_layout Plain Layout
5782 and a bunch of these
5783 \begin_inset Quotes eld
5787 \begin_inset Flex Code
5790 \begin_layout Plain Layout
5797 \begin_inset Quotes erd
5800 symbolic keys bound such things as
5801 \begin_inset Flex Noun
5804 \begin_layout Plain Layout
5806 \begin_inset space ~
5815 \begin_inset Flex Noun
5818 \begin_layout Plain Layout
5820 \begin_inset space ~
5829 This is how I produce my accented characters.
5834 You can make just about anything into the
5835 \begin_inset Flex Code
5838 \begin_layout Plain Layout
5845 \begin_inset Flex Noun
5848 \begin_layout Plain Layout
5854 keys, a spare function key, etc.
5855 As for the \SpecialChar LyX
5856 commands that produce accents, check the entry for
5857 \begin_inset Flex Code
5860 \begin_layout Plain Layout
5871 You'll find the complete list there.
5874 \begin_layout Subsection
5875 Saving your Language Configuration
5878 \begin_layout Standard
5879 You can edit your preferences so that your desired language environment
5880 is automatically configured when \SpecialChar LyX
5882 \begin_inset Flex Noun
5885 \begin_layout Plain Layout
5886 Edit\SpecialChar menuseparator
5895 \begin_layout Chapter
5896 Installing New Document Classes, Layouts, and Templates
5897 \begin_inset CommandInset label
5899 name "cha:Installing-New-Document"
5904 \begin_inset Argument 1
5907 \begin_layout Plain Layout
5908 Installing New Document Classes
5916 \begin_layout Standard
5917 In this chapter, we describe the procedures for creating and installing
5918 new \SpecialChar LyX
5919 layout and template files, as well as offer a refresher on correctly
5920 installing new \SpecialChar LaTeX
5925 \begin_layout Standard
5926 First, let us a say a few words about how one ought to think about the relation
5927 between \SpecialChar LyX
5928 and \SpecialChar LaTeX
5930 The thing to understand is that, in a certain sense, \SpecialChar LyX
5931 doesn't know anything
5932 about \SpecialChar LaTeX
5934 Indeed, from \SpecialChar LyX
5935 's point of view, \SpecialChar LaTeX
5936 is just one of several
5937 \begin_inset Quotes eld
5941 \begin_inset Quotes erd
5944 in which it is capable of producing output.
5945 Other such formats are DocBook, plaintext, and XHTML.
5947 is, of course, a particularly important format, but very little of the
5948 information \SpecialChar LyX
5949 has about \SpecialChar LaTeX
5950 is actually contained in the program itself.
5954 \begin_layout Plain Layout
5955 Some commands are sufficiently complex that they are
5956 \begin_inset Quotes eld
5960 \begin_inset Quotes erd
5963 into \SpecialChar LyX
5965 But the developers generally regard this as a Bad Thing.
5970 Rather, that information, even for the standard classes like
5971 \begin_inset Flex Code
5974 \begin_layout Plain Layout
5980 , is contained in `layout files'.
5981 Similarly, \SpecialChar LyX
5982 itself does not know much about DocBook or XHTML.
5983 What it knows is contained in layout files.
5986 \begin_layout Standard
5987 You can think of the layout file for a given document class as a translation
5988 manual between \SpecialChar LyX
5989 constructs—paragraphs with their corresponding styles,
5990 certain sorts of insets, etc—and the corresponding \SpecialChar LaTeX
5993 Almost everything \SpecialChar LyX
5995 \begin_inset Flex Code
5998 \begin_layout Plain Layout
6004 , for example, is contained in the file
6005 \begin_inset Flex Code
6008 \begin_layout Plain Layout
6014 and in various other files it includes.
6015 For this reason, anyone intending to write layout files should plan to
6016 study the existing files.
6017 A good place to start is with
6018 \begin_inset Flex Code
6021 \begin_layout Plain Layout
6027 , which is included in
6028 \begin_inset Flex Code
6031 \begin_layout Plain Layout
6038 \begin_inset Flex Code
6041 \begin_layout Plain Layout
6047 , and many of the other layout files for document classes.
6048 This file is where sections and the like are defined:
6049 \begin_inset Flex Code
6052 \begin_layout Plain Layout
6058 tells \SpecialChar LyX
6059 how paragraphs that are marked with the Section, Subsection, etc,
6060 styles can be translated into corresponding \SpecialChar LaTeX
6061 , DocBook, and XHTML commands
6064 \begin_inset Flex Code
6067 \begin_layout Plain Layout
6073 file basically just includes several of these
6074 \begin_inset Flex Code
6077 \begin_layout Plain Layout
6086 \begin_layout Standard
6087 Defining the \SpecialChar LyX
6089 correspondence is not the only thing layout files do, though.
6090 Their other job is to define how the \SpecialChar LyX
6091 constructs themselves will appear
6093 The fact that layout files have these two jobs is often a source of confusion,
6094 because they are completely separate.
6095 Telling \SpecialChar LyX
6096 how to translate a certain paragraph style into \SpecialChar LaTeX
6099 how to display it; conversely, telling \SpecialChar LyX
6100 how to display a certain paragraph
6101 style does not tell \SpecialChar LyX
6102 how to translate it into \SpecialChar LaTeX
6103 (let alone tell \SpecialChar LaTeX
6106 So, in general, when you define a new \SpecialChar LyX
6107 construct, you must always do two
6108 quite separate things: (i)
6109 \begin_inset space ~
6112 tell \SpecialChar LyX
6113 how to translate it into \SpecialChar LaTeX
6115 \begin_inset space ~
6118 tell \SpecialChar LyX
6122 \begin_layout Standard
6123 Much the same is true, of course, as regards \SpecialChar LyX
6124 's other backend formats, though
6125 XHTML is in some ways different, because in that case \SpecialChar LyX
6130 able, to some extent, to use information about how it should display a
6131 paragraph on the screen to output information (in the form of CSS) about
6132 how the paragraph should be displayed in a browser.
6133 Even in this case, however, the distinction between what \SpecialChar LyX
6135 and how things are rendered externally remains in force, and the two can
6136 be controlled separately.
6138 \begin_inset CommandInset ref
6140 reference "sec:Tags-for-XHTML"
6147 \begin_layout Section
6148 Installing new \SpecialChar LaTeX
6152 \begin_layout Standard
6153 Some installations may not include a \SpecialChar LaTeX
6154 package or class file that you would
6155 like to use within \SpecialChar LyX
6157 For example, you might need Foil\SpecialChar TeX
6158 , a package for preparing slides for overhead
6160 Modern \SpecialChar LaTeX
6161 distributions like \SpecialChar TeX
6162 Live (2008 or newer) or MiK\SpecialChar TeX
6163 provide a user interface
6164 for installing such packages.
6165 For example, with MiK\SpecialChar TeX
6166 , you start the program
6167 \begin_inset Quotes eld
6171 \begin_inset space ~
6175 \begin_inset Quotes erd
6178 to get a list of available packages.
6179 To install one of them, right click on it or use the corresponding toolbar
6183 \begin_layout Standard
6184 If your \SpecialChar LaTeX
6185 distribution does not provide such a `package manager', or if the
6186 package is not available from your distribution, then follow these steps
6187 to install it manually:
6190 \begin_layout Enumerate
6191 Get the package from
6192 \begin_inset CommandInset href
6195 target "http://www.ctan.org/"
6203 \begin_layout Enumerate
6204 If the package contains a file with the ending
6205 \begin_inset Quotes eld
6209 \begin_inset Flex Code
6212 \begin_layout Plain Layout
6219 \begin_inset Quotes erd
6222 (is the case for Foil\SpecialChar TeX
6223 ) then open a console, change to the folder of this
6224 file and execute the command
6225 \begin_inset Flex Code
6228 \begin_layout Plain Layout
6235 You have now unpacked the package and have all files to install it.
6236 Most \SpecialChar LaTeX
6237 -packages are not packed and you can skip this step.
6240 \begin_layout Enumerate
6241 Now you need to decide if the package should be available for all users
6246 \begin_layout Enumerate
6247 On *nix systems (Linux, OSX, etc.), if you want the new package to be available
6248 for all users on your system, then install it in your `local' \SpecialChar TeX
6250 install it in your own `user' \SpecialChar TeX
6252 Where these trees should be created, if they do not already exist, depends
6254 To find this out, look in the file
6255 \begin_inset Flex Code
6258 \begin_layout Plain Layout
6268 \begin_layout Plain Layout
6269 This is usually in the directory
6270 \begin_inset Flex Code
6273 \begin_layout Plain Layout
6279 , though you can execute the command
6280 \begin_inset Flex Code
6283 \begin_layout Plain Layout
6294 The location of the `local' \SpecialChar TeX
6295 tree is defined by the
6296 \begin_inset Flex Code
6299 \begin_layout Plain Layout
6305 variable; this is usually somewhere like
6306 \begin_inset Flex Code
6309 \begin_layout Plain Layout
6310 /usr/local/share/texmf
6315 or /usr/local/texlive/XXXX where XXXX is the year of the installed \SpecialChar TeX
6318 The location of the `user' \SpecialChar TeX
6320 \begin_inset Flex Code
6323 \begin_layout Plain Layout
6330 \begin_inset Flex Code
6333 \begin_layout Plain Layout
6340 \begin_inset Flex Code
6343 \begin_layout Plain Layout
6352 (If these variables are not predefined, you have to define them.) You'll
6353 probably need root permissions to create or modify the `local' tree, but
6354 not for your `user' tree.
6355 \begin_inset Newline newline
6358 In general, it is recommended to install in the user tree because your user
6359 will not be modified or even overwritten when you upgrade your system.
6360 It will typically also be backed up together with everything else when
6361 you backup your home directory (which, of course, you do on a regular basis).
6364 \begin_layout Enumerate
6365 On Windows, if you want the new package to be available for all users on
6366 your system, change to the folder where \SpecialChar LaTeX
6367 is installed and then change to
6369 \begin_inset Flex Code
6372 \begin_layout Plain Layout
6383 (For MiK\SpecialChar TeX
6384 , this would be by default the folder
6385 \begin_inset Flex Code
6388 \begin_layout Plain Layout
6406 \begin_layout Plain Layout
6407 Note that this will be the correct path only on English installations.
6408 On a German one, it would be
6409 \begin_inset Flex Code
6412 \begin_layout Plain Layout
6426 , and similarly for other languages.
6431 Create there a new folder
6432 \begin_inset Flex Code
6435 \begin_layout Plain Layout
6441 and copy all files of the package into it.
6443 \begin_inset Newline newline
6446 If the package should only available for you or you don't have admin permissions
6447 , do the same, but in the local \SpecialChar LaTeX
6450 \begin_inset space \thinspace{}
6453 g., for MiK\SpecialChar TeX
6455 \begin_inset space ~
6458 2.8 under Windows XP, this would be the folder:
6459 \begin_inset Newline newline
6465 \begin_inset Flex Code
6468 \begin_layout Plain Layout
6471 Documents and Settings
6483 \begin_inset Newline newline
6489 \begin_inset Phantom HPhantom
6492 \begin_layout Plain Layout
6503 \begin_inset Flex Code
6506 \begin_layout Plain Layout
6519 \begin_inset Newline newline
6522 On Vista, it would be:
6523 \begin_inset Newline newline
6527 \begin_inset Flex Code
6530 \begin_layout Plain Layout
6556 \begin_layout Enumerate
6557 Now one only need to tell \SpecialChar LaTeX
6558 that there are new files.
6559 This depends on the used \SpecialChar LaTeX
6564 \begin_layout Enumerate
6565 For \SpecialChar TeX
6566 Live execute the command
6567 \begin_inset Flex Code
6570 \begin_layout Plain Layout
6577 If you installed the package for all users, then you will probably need
6578 to have root permissions for that.
6581 \begin_layout Enumerate
6582 For MiK\SpecialChar TeX
6583 , if you have installed the package for all users, start the program
6585 \begin_inset Quotes eld
6589 \begin_inset space ~
6593 \begin_inset Quotes erd
6596 and press the button marked
6597 \begin_inset Quotes eld
6601 \begin_inset Quotes erd
6605 Otherwise start the program
6606 \begin_inset Quotes eld
6610 \begin_inset Quotes erd
6617 \begin_layout Enumerate
6618 Finally, you need to tell \SpecialChar LyX
6619 that there are new packages available.
6620 So, in \SpecialChar LyX
6622 \begin_inset Flex Noun
6625 \begin_layout Plain Layout
6628 \SpecialChar menuseparator
6634 and then restart \SpecialChar LyX
6638 \begin_layout Standard
6639 Now the package is installed.
6640 In our example, the document class
6641 \begin_inset Flex Code
6644 \begin_layout Plain Layout
6650 will now be available under
6651 \begin_inset Flex Noun
6654 \begin_layout Plain Layout
6655 Document\SpecialChar menuseparator
6656 Settings\SpecialChar menuseparator
6663 \begin_inset Quotes eld
6667 \begin_inset Quotes erd
6674 \begin_layout Standard
6675 If you would like to use a \SpecialChar LaTeX
6676 document class that is not even listed in the
6678 \begin_inset Flex Noun
6681 \begin_layout Plain Layout
6682 Document\SpecialChar menuseparator
6683 Settings\SpecialChar menuseparator
6689 , then you need to create a `layout' file for it.
6690 That is the topic of the next section.
6693 \begin_layout Section
6694 Types of layout files
6697 \begin_layout Standard
6698 This section describes the various sorts of \SpecialChar LyX
6699 files that contain layout informati
6701 These files describe various paragraph and character styles, determining
6702 how \SpecialChar LyX
6703 should display them and how they should be translated into \SpecialChar LaTeX
6705 XHTML, or whatever output format is being used.
6709 \begin_layout Standard
6710 We shall try to provide a thorough description of the process of writing
6712 However, there are so many different types of documents supported even
6713 by just \SpecialChar LaTeX
6714 that we can't hope to cover every different possibility or problem
6715 you might encounter.
6716 The \SpecialChar LyX
6717 users' list is frequented by people with lots of experience with layout
6718 design who are willing to share what they've learned, so please feel free
6719 to ask questions there.
6722 \begin_layout Standard
6723 As you prepare to write a new layout, it is extremely helpful to look at
6724 the layouts distributed with \SpecialChar LyX
6726 If you write a \SpecialChar LyX
6727 layout for a \SpecialChar LaTeX
6728 document class that might also be used by
6729 others, or write a module that might be useful to others, then you should
6730 consider posting your layout to the
6731 \begin_inset CommandInset href
6733 name "layout section on the LyX wiki"
6734 target "https://wiki.lyx.org/Layouts/Layouts"
6739 or even to the \SpecialChar LyX
6740 developers' list, so that it might be included in \SpecialChar LyX
6745 \begin_layout Plain Layout
6746 Note that \SpecialChar LyX
6747 is licensed under the General Public License, so any material
6748 that is contributed to \SpecialChar LyX
6749 must be similarly licensed.
6757 \begin_layout Subsection
6759 \begin_inset CommandInset label
6761 name "subsec:Layout-modules"
6768 \begin_layout Standard
6769 We have spoken to this point about `layout files'.
6770 But there are different sorts of files that contain layout information.
6771 Layout files, strictly so called, have the
6772 \begin_inset Flex Code
6775 \begin_layout Plain Layout
6781 extension and provide \SpecialChar LyX
6782 with information about document classes.
6783 Since \SpecialChar LyX
6784 1.6 layout information can also be contained in layout
6789 \begin_inset Flex Code
6792 \begin_layout Plain Layout
6799 Modules are to \SpecialChar LaTeX
6800 packages much as layouts are to \SpecialChar LaTeX
6801 classes, and some modules—such
6803 \begin_inset Flex Code
6806 \begin_layout Plain Layout
6812 module—specifically provide support for one package.
6813 In a sense, layout modules are similar to included
6817 \begin_layout Plain Layout
6818 These can have any extension, but by convention have the
6819 \begin_inset Flex Code
6822 \begin_layout Plain Layout
6834 \begin_inset Flex Code
6837 \begin_layout Plain Layout
6843 —in that modules are not specific to a given document class but may be used
6844 with many different classes.
6845 The difference is that using an included file with
6846 \begin_inset Flex Code
6849 \begin_layout Plain Layout
6855 requires editing that file.
6856 Modules, by contrast, are selected in the
6857 \begin_inset Flex Noun
6860 \begin_layout Plain Layout
6861 Document\SpecialChar menuseparator
6870 \begin_layout Standard
6871 Building modules is the easiest way to get started with layout editing,
6872 since it can be as simple as adding a single new paragraph style or flex
6874 But modules may, in principle, contain anything a layout file can contain.
6877 \begin_layout Standard
6878 After creating a new module and copying it to the
6879 \begin_inset Flex Code
6882 \begin_layout Plain Layout
6888 folder, you will need to reconfigure and then restart \SpecialChar LyX
6891 However, changes you make to the module will be seen immediately, if you
6893 \begin_inset Flex Noun
6896 \begin_layout Plain Layout
6897 Document\SpecialChar menuseparator
6903 , highlight something, and then hit
6904 \begin_inset Quotes eld
6908 \begin_inset Quotes erd
6914 It is strongly recommended that you save your work before doing this
6919 it is strongly recommended that you not attempt to edit modules while simultaneo
6920 usly working on actual documents
6923 Though of course the developers strive to keep \SpecialChar LyX
6924 stable in such situations,
6925 syntax errors and the like in your module file could cause strange behavior.
6928 \begin_layout Subsubsection
6932 \begin_layout Standard
6933 Modules are to \SpecialChar LyX
6934 as packages are to \SpecialChar LaTeX
6936 Sometimes, however, you find yourself wanting a specific inset or character
6937 style just for one document and writing a module that will also be available
6938 to other documents makes little sense.
6939 What you need is \SpecialChar LyX
6941 \begin_inset Quotes eld
6945 \begin_inset Quotes erd
6951 \begin_layout Standard
6952 You will find it under
6954 Document\SpecialChar menuseparator
6955 Settings\SpecialChar menuseparator
6959 The large text box allows you to enter anything that you might enter in
6960 a layout file or module.
6961 You can think of a document's local layout, in fact, as a module that belongs
6963 So, in particular, you must enter a
6964 \begin_inset Flex Code
6967 \begin_layout Plain Layout
6974 Any format is acceptable, but one would normally use the format current
6976 (In \SpecialChar LyX
6977 2.3, the current layout format is 63.)
6980 \begin_layout Standard
6981 When you have entered something in the
6982 \begin_inset Flex Code
6985 \begin_layout Plain Layout
6991 pane, \SpecialChar LyX
6993 \begin_inset Quotes eld
6997 \begin_inset Quotes erd
7000 button at the bottom.
7001 Clicking this button will cause \SpecialChar LyX
7002 to determine whether what you have entered
7003 is valid layout information for the chosen format.
7005 will report the result but, unfortunately, will not tell you what errors
7006 there might have been.
7007 These will be written to the terminal, however, if \SpecialChar LyX
7008 is started from a terminal.
7009 You will not be permitted to save your local layout until you have entered
7013 \begin_layout Standard
7014 The warnings at the end of the previous section apply here, too.
7015 Do not play with local layout while you are actually working, especially
7016 if you have not saved your document.
7017 That said, using local layout with a test document can be a very convenient
7018 way to try out layout ideas, or even to start developing a module.
7021 \begin_layout Subsection
7023 \begin_inset Flex Noun
7026 \begin_layout Plain Layout
7035 \begin_layout Standard
7036 There are two situations you are likely to encounter when wanting to support
7037 a new \SpecialChar LaTeX
7038 document class, involving style (
7039 \begin_inset Flex Code
7042 \begin_layout Plain Layout
7048 ) files and \SpecialChar LaTeX2e
7050 \begin_inset Flex Code
7053 \begin_layout Plain Layout
7060 Supporting a style file is usually fairly easy.
7061 Supporting a new class file is a bit harder.
7062 We'll discuss the former in this section and the latter in the next.
7063 Similar remarks apply, of course, if you want to support a new DocBook
7067 \begin_layout Standard
7068 The easier case is the one in which your new document class is provided
7069 as a style file that is to be used in conjunction with an already supported
7071 For the sake of the example, we'll assume that the style file is called
7073 \begin_inset Flex Noun
7076 \begin_layout Plain Layout
7082 and that it is meant to be used with
7083 \begin_inset Flex Noun
7086 \begin_layout Plain Layout
7092 , which is a standard class.
7096 \begin_layout Standard
7097 Start by copying the existing class's layout file into your local directory:
7101 \begin_layout Plain Layout
7102 Of course, which directory is your local directory will vary by platform,
7103 and \SpecialChar LyX
7104 allows you to specify your local directory on startup, too, using
7106 \begin_inset Flex Code
7109 \begin_layout Plain Layout
7123 \begin_layout LyX-Code
7124 cp report.layout ~/.lyx/layouts/myclass.layout
7127 \begin_layout Standard
7129 \begin_inset Flex Code
7132 \begin_layout Plain Layout
7138 and change the line:
7141 \begin_layout LyX-Code
7144 DeclareLaTeXClass{Report (Standard Class)}
7147 \begin_layout Standard
7151 \begin_layout LyX-Code
7154 DeclareLaTeXClass[report, myclass.sty]{Report (My Class)}
7157 \begin_layout Standard
7161 \begin_layout LyX-Code
7163 \begin_inset Newline newline
7169 \begin_inset Newline newline
7175 \begin_layout Standard
7176 near the top of the file.
7179 \begin_layout Standard
7180 Start \SpecialChar LyX
7182 \begin_inset Flex Noun
7185 \begin_layout Plain Layout
7186 Tools\SpecialChar menuseparator
7193 Then restart \SpecialChar LyX
7194 and try creating a new document.
7196 \begin_inset Flex Noun
7199 \begin_layout Plain Layout
7205 " as a document class option in the
7206 \begin_inset Flex Noun
7209 \begin_layout Plain Layout
7210 Document\SpecialChar menuseparator
7217 It is likely that some of the sectioning commands and such in your new
7218 class will work differently from how they worked in the base class—
7219 \begin_inset Flex Code
7222 \begin_layout Plain Layout
7228 in this example—so you can fiddle around with the settings for the different
7229 sections if you wish.
7230 The layout information for sections is contained in
7231 \begin_inset Flex Code
7234 \begin_layout Plain Layout
7240 , but you do not need to copy and change this file.
7241 Instead, you can simply add your changes to your layout file, after the
7243 \begin_inset Flex Code
7246 \begin_layout Plain Layout
7252 , which itself includes
7253 \begin_inset Flex Code
7256 \begin_layout Plain Layout
7263 For example, you might add these lines:
7266 \begin_layout LyX-Code
7270 \begin_layout LyX-Code
7274 \begin_layout LyX-Code
7278 \begin_layout LyX-Code
7282 \begin_layout LyX-Code
7286 \begin_layout Standard
7287 to change the font for chapter headings to sans-serif.
7288 This will override (or, in this case, add to) the existing declaration
7289 for the Chapter style.
7293 \begin_layout Standard
7294 Your new package may also provide commands or environments not present in
7296 In this case, you will want to add these to the layout file.
7298 \begin_inset CommandInset ref
7300 reference "sec:TextClass"
7304 for information on how to do so.
7307 \begin_layout Standard
7309 \begin_inset Flex Noun
7312 \begin_layout Plain Layout
7318 can be used with several different document classes, and even if it cannot,
7319 you might find it easiest just to write a module that you can load with
7321 The simplest possible such module would be:
7324 \begin_layout LyX-Code
7327 DeclareLyXModule{My Class}
7330 \begin_layout LyX-Code
7334 \begin_layout LyX-Code
7335 #Support for myclass.sty.
7338 \begin_layout LyX-Code
7340 \begin_inset Newline newline
7346 \begin_layout LyX-Code
7348 \begin_inset Newline newline
7354 \begin_layout LyX-Code
7356 \begin_inset Newline newline
7362 \begin_inset Newline newline
7368 \begin_layout Standard
7369 A more complex module might modify the behavior of some existing constructs
7370 or define some new ones.
7372 \begin_inset CommandInset ref
7374 reference "sec:TextClass"
7381 \begin_layout Subsection
7383 \begin_inset Flex Noun
7386 \begin_layout Plain Layout
7395 \begin_layout Standard
7396 There are two possibilities here.
7397 One is that the class file is itself based upon an existing document class.
7398 For example, many thesis classes are based upon
7399 \begin_inset Flex Noun
7402 \begin_layout Plain Layout
7409 To see whether yours is, look for a line like
7412 \begin_layout LyX-Code
7418 \begin_layout Standard
7420 If so, then you may proceed largely as in the previous section, though
7422 \begin_inset Flex Code
7425 \begin_layout Plain Layout
7426 Declare\SpecialChar LaTeX
7432 line will be different.
7433 If your new class is
7434 \begin_inset Flex Code
7437 \begin_layout Plain Layout
7443 and it is based upon
7444 \begin_inset Flex Code
7447 \begin_layout Plain Layout
7453 , then the line should read:
7457 \begin_layout Plain Layout
7458 And it will be easiest if you save the file to
7459 \begin_inset Flex Code
7462 \begin_layout Plain Layout
7469 assumes that the document class has the same name as the layout file.
7478 \begin_layout LyX-Code
7481 DeclareLaTeXClass[thesis,book]{thesis}
7484 \begin_layout Standard
7485 If, on the other hand, the new class is not based upon an existing class,
7486 you will probably have to
7487 \begin_inset Quotes eld
7491 \begin_inset Quotes erd
7495 We strongly suggest copying an existing layout file which uses a similar
7497 class and then modifying it, if you can do so.
7498 At least use an existing file as a starting point so you can find out what
7499 items you need to worry about.
7500 Again, the specifics are covered below.
7503 \begin_layout Subsection
7505 \begin_inset CommandInset label
7507 name "subsec:Creating-Templates"
7514 \begin_layout Standard
7515 Once you have written a layout file for a new document class, you might
7516 want to consider writing a
7521 A template acts as a kind of tutorial for your layout, showing how it might
7522 be used, though containing dummy content.
7523 You can of course look at the various templates included with \SpecialChar LyX
7527 \begin_layout Standard
7528 Templates are created just like usual documents: using \SpecialChar LyX
7530 The only difference is that usual documents contain all possible settings,
7531 including the font scheme and the paper size.
7532 Usually a user doesn't want a template to overwrite his preferred settings
7533 for such parameters.
7534 For that reason, the designer of a template should remove the corresponding
7536 \begin_inset Flex Code
7539 \begin_layout Plain Layout
7548 \begin_inset Flex Code
7551 \begin_layout Plain Layout
7559 from the template \SpecialChar LyX
7561 This can be done with any simple text-editor, for example
7562 \begin_inset Flex Code
7565 \begin_layout Plain Layout
7572 \begin_inset Flex Code
7575 \begin_layout Plain Layout
7584 \begin_layout Standard
7585 Put the edited template files you create in
7586 \begin_inset Flex Code
7589 \begin_layout Plain Layout
7595 , copy the ones you use from the global template directory in
7596 \begin_inset Flex Code
7599 \begin_layout Plain Layout
7605 to the same place, and redefine the template path in the
7606 \begin_inset Flex Noun
7609 \begin_layout Plain Layout
7610 Tools\SpecialChar menuseparator
7611 Preferences\SpecialChar menuseparator
7620 \begin_layout Standard
7621 Note, by the way, that there is a template which has a particular meaning:
7622 \begin_inset Newline linebreak
7626 \begin_inset Flex Code
7629 \begin_layout Plain Layout
7636 This template is loaded every time you create a new document with
7637 \begin_inset Flex Noun
7640 \begin_layout Plain Layout
7641 File\SpecialChar menuseparator
7647 in order to provide useful defaults.
7648 To create this template from inside \SpecialChar LyX
7649 , all you have to do is to open a document
7650 with the correct settings, and use the
7651 \begin_inset Flex Noun
7654 \begin_layout Plain Layout
7655 Save as Document Defaults
7663 \begin_layout Subsection
7664 Upgrading old layout files
7667 \begin_layout Standard
7668 The format of layout files changes with each \SpecialChar LyX
7669 release, so old layout files
7670 need to be converted to the new format.
7672 reads a layout file in an older format, it automatically calls the
7674 \begin_inset Flex Code
7677 \begin_layout Plain Layout
7683 to convert it to a temporary file in current format.
7684 The original file is left untouched.
7685 If you use the layout file often, then, you may want to convert it permanently,
7686 so that \SpecialChar LyX
7687 does not have to do so itself every time.
7688 To do this, you can call the converter manually:
7691 \begin_layout Enumerate
7693 \begin_inset Flex Code
7696 \begin_layout Plain Layout
7703 \begin_inset Flex Code
7706 \begin_layout Plain Layout
7715 \begin_layout Enumerate
7717 \begin_inset Newline newline
7721 \begin_inset Flex Code
7724 \begin_layout Plain Layout
7725 python LyXDir/scripts/layout2layout.py myclass.old myclass.layout
7731 \begin_inset Newline newline
7735 \begin_inset Flex Code
7738 \begin_layout Plain Layout
7744 is the name of your \SpecialChar LyX
7748 \begin_layout Standard
7749 Note that manual conversion does not affect included files, so these will
7750 have to be converted separately.
7753 \begin_layout Subsection
7754 \begin_inset CommandInset label
7756 name "subsec:Cite-Engine-Files"
7763 \begin_layout Standard
7764 A specific form of layout files are the so-called
7765 \begin_inset Flex Code
7768 \begin_layout Plain Layout
7774 files that are located in the
7775 \begin_inset Flex Code
7778 \begin_layout Plain Layout
7785 Their purpose is to define the specifics of \SpecialChar LaTeX
7786 packages aimed at bibliography
7799 , but also the way how normal Bib\SpecialChar TeX
7800 citations (without additional packages)
7801 are handled in \SpecialChar LyX
7802 is defined in such a file.
7806 \begin_layout Standard
7807 More specifically, it is defined which packages \SpecialChar LyX
7808 needs to load, which citation
7809 commands are available, how these are to be displayed in \SpecialChar LyX
7811 the dialogs, the context menus) as well as in the XHTML and plain text
7813 Furthermore, the files specify available style variants (author-year, numerical
7814 , etc.) and their specifics.
7815 The cite engine files are also used to generate the options that are available
7818 Document\SpecialChar menuseparator
7819 Settings\SpecialChar menuseparator
7820 Bibliography\SpecialChar menuseparator
7826 \begin_layout Standard
7827 Even though a cite engine file is essentially a normal layout file that
7828 could theoretically include any layout information, it usually primarily
7829 includes some specific parameters such as
7830 \begin_inset Flex Code
7833 \begin_layout Plain Layout
7840 \begin_inset Flex Code
7843 \begin_layout Plain Layout
7850 \begin_inset Flex Code
7853 \begin_layout Plain Layout
7860 \begin_inset Flex Code
7863 \begin_layout Plain Layout
7870 The syntax of the latter two is described in
7871 \begin_inset CommandInset ref
7873 reference "subsec:Citation-engine-description"
7881 \begin_inset CommandInset ref
7883 reference "subsec:Citation-format-description"
7887 , as well as in the files themselves.
7890 \begin_layout Section
7891 \begin_inset CommandInset label
7893 name "sec:TextClass"
7897 The layout file format
7900 \begin_layout Standard
7901 The following sections describe how layout files are structured and written.
7902 Our advice is to go slowly, save and test often.
7903 It is really not that hard, except that the multitude of options can become
7904 overwhelming, especially if you try to check out too many at once.
7905 It becomes easier if you use existing layouts of \SpecialChar LyX
7906 as examples/reference
7907 or if you modify an existing layout to your needs.
7910 \begin_layout Standard
7911 Note that all the tags used in layout files are case-insensitive.
7913 \begin_inset Flex Code
7916 \begin_layout Plain Layout
7923 \begin_inset Flex Code
7926 \begin_layout Plain Layout
7933 \begin_inset Flex Code
7936 \begin_layout Plain Layout
7942 are really the same tag.
7943 The possible arguments are printed in brackets after the tag's name.
7944 The default argument is typeset
7945 \begin_inset Flex Code
7948 \begin_layout Plain Layout
7957 If the argument has a data type like
7958 \begin_inset Quotes eld
7962 \begin_inset Quotes erd
7966 \begin_inset Quotes eld
7970 \begin_inset Quotes erd
7973 , the default is shown like this:
7974 \begin_inset Flex Code
7977 \begin_layout Plain Layout
7988 \begin_layout Subsection
7989 The document class declaration and classification
7992 \begin_layout Standard
7993 Lines in a layout file which begin with
7994 \begin_inset Flex Code
7997 \begin_layout Plain Layout
8004 There is one exception to this rule.
8006 \begin_inset Flex Code
8009 \begin_layout Plain Layout
8015 files should begin with lines like:
8018 \begin_layout LyX-Code
8021 #% Do not delete the line below; configure depends on this
8024 \begin_layout LyX-Code
8029 DeclareLaTeXClass{Article (Standard Class)}
8032 \begin_layout LyX-Code
8037 DeclareCategory{Articles}
8040 \begin_layout Standard
8041 The second and third lines are used when you (re)configure \SpecialChar LyX
8043 The layout file is read by the \SpecialChar LaTeX
8045 \begin_inset Flex Code
8048 \begin_layout Plain Layout
8054 , in a special mode where
8055 \begin_inset Flex Code
8058 \begin_layout Plain Layout
8065 The first line is just a \SpecialChar LaTeX
8066 comment, the second one contains the mandatory
8067 declaration of the text class and the third line contains the optional
8068 classification of the class.
8069 If these lines appear in a file named
8070 \begin_inset Flex Code
8073 \begin_layout Plain Layout
8079 , then they define a text class of name
8080 \begin_inset Flex Code
8083 \begin_layout Plain Layout
8089 (the name of the layout file) which uses the \SpecialChar LaTeX
8091 \begin_inset Flex Code
8094 \begin_layout Plain Layout
8100 (the default is to use the same name as the layout).
8102 \begin_inset Quotes eld
8105 Article (Standard Class)
8106 \begin_inset Quotes erd
8109 that appears above is used as a description of the text class in the
8110 \begin_inset Flex Noun
8113 \begin_layout Plain Layout
8114 Document\SpecialChar menuseparator
8122 \begin_inset Quotes eld
8126 \begin_inset Quotes erd
8129 in the example) is also used in the
8130 \begin_inset Flex Noun
8133 \begin_layout Plain Layout
8134 Document\SpecialChar menuseparator
8140 dialog: the text classes are grouped by these categories (which are usually
8141 genres, so typical categories are
8142 \begin_inset Quotes eld
8146 \begin_inset Quotes erd
8150 \begin_inset Quotes eld
8154 \begin_inset Quotes erd
8158 \begin_inset Quotes eld
8162 \begin_inset Quotes erd
8166 \begin_inset Quotes eld
8170 \begin_inset Quotes erd
8174 \begin_inset Quotes eld
8178 \begin_inset Quotes erd
8182 \begin_inset Quotes eld
8186 \begin_inset Quotes erd
8190 If no category has been declared, the class will be put in the
8191 \begin_inset Quotes eld
8195 \begin_inset Quotes erd
8201 \begin_layout Standard
8202 Let's assume that you wrote your own text class that uses the
8203 \begin_inset Flex Code
8206 \begin_layout Plain Layout
8212 document class, but where you changed the appearance of the section headings.
8213 If you put it in a file
8214 \begin_inset Flex Code
8217 \begin_layout Plain Layout
8223 , the header of this file should be:
8226 \begin_layout LyX-Code
8229 #% Do not delete the line below; configure depends on this
8232 \begin_layout LyX-Code
8237 DeclareLaTeXClass[article]{Article (with My Own Headings)}
8240 \begin_layout LyX-Code
8245 DeclareCategory{Articles}
8248 \begin_layout Standard
8249 This declares a text class
8250 \begin_inset Flex Code
8253 \begin_layout Plain Layout
8259 , associated with the \SpecialChar LaTeX
8261 \begin_inset Flex Code
8264 \begin_layout Plain Layout
8271 \begin_inset Quotes eld
8274 Article (with My Own Headings)
8275 \begin_inset Quotes erd
8279 If your text class depends on several packages, you can declare it as:
8282 \begin_layout LyX-Code
8285 #% Do not delete the line below; configure depends on this
8288 \begin_layout LyX-Code
8293 DeclareLaTeXClass[article,foo.sty]{Article (with My Own Headings)}
8296 \begin_layout LyX-Code
8301 DeclareCategory{Articles}
8304 \begin_layout Standard
8305 This indicates that your text class uses the
8306 \begin_inset Flex Code
8309 \begin_layout Plain Layout
8316 Finally, it is also possible to declare classes for DocBook code.
8317 Typical declarations will look like:
8320 \begin_layout LyX-Code
8323 #% Do not delete the line below; configure depends on this
8326 \begin_layout LyX-Code
8331 DeclareDocBookClass[article]{SGML (DocBook Article)}
8334 \begin_layout LyX-Code
8339 DeclareCategory{Articles (DocBook)}
8342 \begin_layout Standard
8343 Note that these declarations can also be given an optional parameter declaring
8344 the name of the document class (but not a list).
8347 \begin_layout Standard
8348 So, to be as explicit as possible, the form of the layout declaration is:
8351 \begin_layout LyX-Code
8356 DeclareLaTeXClass[class,package.sty]{layout description}
8359 \begin_layout LyX-Code
8364 DeclareCategory{category}
8367 \begin_layout Standard
8368 The class need only be specified if the name of the \SpecialChar LaTeX
8370 name of the layout file are different or if there are packages to load.
8371 If the name of the class file is not specified, then \SpecialChar LyX
8373 that it is the same as the name of the layout file.
8376 \begin_layout Standard
8377 When the text class has been modified to your taste, all you have to do
8378 is to copy it either to
8379 \begin_inset Flex Code
8382 \begin_layout Plain Layout
8389 \begin_inset Flex Code
8392 \begin_layout Plain Layout
8399 \begin_inset Flex Noun
8402 \begin_layout Plain Layout
8403 Tools\SpecialChar menuseparator
8409 , exit \SpecialChar LyX
8411 Then your new text class should be available along with the others.
8414 \begin_layout Standard
8415 Once the layout file is installed, you can edit it and see your changes
8416 without having to reconfigure or to restart \SpecialChar LyX
8421 \begin_layout Plain Layout
8422 In versions of \SpecialChar LyX
8423 prior to 1.6, this was not true.
8424 As a result, editing layout files was very time consuming, since you had
8425 constantly to restart \SpecialChar LyX
8431 You can force a reload of the current layout by using the \SpecialChar LyX
8433 \begin_inset Flex Noun
8436 \begin_layout Plain Layout
8443 There is no default binding for this function—though, of course, you can
8444 bind it to a key yourself.
8445 But you will normally use this function simply by entering it in the mini-buffe
8450 \begin_layout Standard
8456 \begin_inset Flex Noun
8459 \begin_layout Plain Layout
8465 is very much an `advanced feature'.
8470 recommended that you save your work before using this function.
8475 recommended that you not attempt to edit layout information while simultaneousl
8476 y working on a document that you care about.
8477 Use a test document.
8478 Syntax errors and the like in your layout file could cause peculiar behavior.
8479 In particular, such errors could cause \SpecialChar LyX
8480 to regard the current layout as
8481 invalid and to attempt to switch to some other layout.
8485 \begin_layout Plain Layout
8486 Really bad syntax errors may even caused \SpecialChar LyX
8488 This is because certain sorts of errors may make \SpecialChar LyX
8499 The \SpecialChar LyX
8500 team strives to keep \SpecialChar LyX
8501 stable in such situations, but safe is better
8506 \begin_layout Plain Layout
8507 While we're giving advice: make regular backups.
8508 And be nice to your mother.
8516 \begin_layout Subsection
8517 The Module declaration
8520 \begin_layout Standard
8521 A module must begin with a line like the following:
8524 \begin_layout LyX-Code
8527 DeclareLyXModule[endnotes.sty]{Endnotes}
8530 \begin_layout Standard
8531 The mandatory argument, in curly brackets, is the name of the module, as
8533 \begin_inset Flex Noun
8536 \begin_layout Plain Layout
8537 Document\SpecialChar menuseparator
8538 Settings\SpecialChar menuseparator
8545 The argument in square brackets is optional: It declares any \SpecialChar LaTeX
8547 on which the module depends.
8548 It is also possible to use the form
8549 \begin_inset Flex Noun
8552 \begin_layout Plain Layout
8558 as an optional argument, which declares that the module can only be used
8559 when there exists a conversion chain between the formats `
8560 \begin_inset Flex Code
8563 \begin_layout Plain Layout
8570 \begin_inset Flex Code
8573 \begin_layout Plain Layout
8582 \begin_layout Standard
8583 The module declaration should then be followed by lines like the following:
8587 \begin_layout Plain Layout
8588 Preferably in English if the module should be published with \SpecialChar LyX
8590 This description will appear in the list of messages to be translated and
8591 will be thus translated with the next interface update.
8599 \begin_layout LyX-Code
8603 \begin_layout LyX-Code
8604 #Adds an endnote command, in addition to footnotes.
8608 \begin_layout LyX-Code
8609 #You will need to add
8611 theendnotes in TeX code where you
8614 \begin_layout LyX-Code
8615 #want the endnotes to appear.
8619 \begin_layout LyX-Code
8623 \begin_layout LyX-Code
8624 #Requires: somemodule | othermodule
8627 \begin_layout LyX-Code
8628 #Excludes: badmodule
8631 \begin_layout Standard
8632 The description is used in
8633 \begin_inset Flex Noun
8636 \begin_layout Plain Layout
8637 Document\SpecialChar menuseparator
8638 Settings\SpecialChar menuseparator
8644 to provide the user with information about what the module does.
8646 \begin_inset Flex Code
8649 \begin_layout Plain Layout
8655 line is used to identify other modules with which this one must be used;
8657 \begin_inset Flex Code
8660 \begin_layout Plain Layout
8666 line is used to identify modules with which this one may not be used.
8667 Both are optional, and, as shown, multiple modules should be separated
8668 with the pipe symbol: |.
8669 Note that the required modules are treated disjunctively:
8673 of the required modules must be used.
8678 excluded module may be used.
8679 Note that modules are identified here by their filenames without the
8680 \begin_inset Flex Code
8683 \begin_layout Plain Layout
8691 \begin_inset Flex Code
8694 \begin_layout Plain Layout
8701 \begin_inset Flex Code
8704 \begin_layout Plain Layout
8713 \begin_layout Subsection
8714 The CiteEngine file declaration
8717 \begin_layout Standard
8718 A cite engine file must begin with a line like the following:
8721 \begin_layout LyX-Code
8724 DeclareLyXCiteEngineModule[biblatex.sty]{Biblatex}
8727 \begin_layout Standard
8728 The mandatory argument, in curly brackets, is the name of the cite style,
8729 as it should appear in
8730 \begin_inset Flex Noun
8733 \begin_layout Plain Layout
8734 Document\SpecialChar menuseparator
8735 Settings\SpecialChar menuseparator
8742 The argument in square brackets is optional: It declares any \SpecialChar LaTeX
8744 on which the cite engine depends.
8747 \begin_layout Standard
8748 The cite engine declaration should then be followed by lines like the following:
8752 \begin_layout Plain Layout
8753 Preferably in English if the module should be published with \SpecialChar LyX
8755 This description will appear in the list of messages to be translated and
8756 will be thus translated with the next interface update.
8764 \begin_layout LyX-Code
8768 \begin_layout LyX-Code
8769 # Biblatex supports many author-year and numerical styles.
8772 \begin_layout LyX-Code
8773 # It is mainly aimed at the Humanities.
8777 \begin_layout LyX-Code
8778 # customizable, fully localized and provides many features
8781 \begin_layout LyX-Code
8782 # that are not possible with BibTeX.
8783 The use of 'biber' as
8786 \begin_layout LyX-Code
8787 # bibliography processor is advised.
8790 \begin_layout LyX-Code
8794 \begin_layout Standard
8795 The description is used in
8796 \begin_inset Flex Noun
8799 \begin_layout Plain Layout
8800 Document\SpecialChar menuseparator
8801 Settings\SpecialChar menuseparator
8807 to provide the user with information about the cite engine.
8810 \begin_layout Subsection
8814 \begin_layout Standard
8815 The first non-comment line of any layout file, included file, or module
8820 contain the file format number:
8823 \begin_layout Description
8824 \begin_inset Flex Code
8827 \begin_layout Plain Layout
8834 \begin_inset Flex Code
8837 \begin_layout Plain Layout
8843 ] The format number of the layout file.
8846 \begin_layout Standard
8847 This tag was introduced with \SpecialChar LyX
8849 \begin_inset space ~
8853 Layout files from older \SpecialChar LyX
8854 versions do not have an explicit file format and
8855 are considered to have
8856 \begin_inset Flex Code
8859 \begin_layout Plain Layout
8861 \begin_inset space ~
8870 The format for the present version of \SpecialChar LyX
8872 But each version of \SpecialChar LyX
8873 is capable of reading earlier versions' layout files,
8874 just as they are capable of reading files produced by earlier versions
8877 There is, however, no provision for converting to earlier formats.
8880 \begin_layout Subsection
8881 \begin_inset CommandInset label
8883 name "subsec:General-text-class"
8887 General text class parameters
8890 \begin_layout Standard
8891 These are general parameters that govern the behavior of an entire document
8897 mean that they must appear in
8898 \begin_inset Flex Code
8901 \begin_layout Plain Layout
8907 files rather than in modules.
8908 A module can contain any layout tag.)
8911 \begin_layout Description
8912 \begin_inset Flex Code
8915 \begin_layout Plain Layout
8921 Adds information that will be output in the
8922 \begin_inset Flex Code
8925 \begin_layout Plain Layout
8931 block when the document is output to XHTML.
8932 Typically, this would be used to output CSS style information, but it can
8933 be used for anything that can appear in
8934 \begin_inset Flex Code
8937 \begin_layout Plain Layout
8945 \begin_inset Quotes eld
8949 \begin_inset Flex Code
8952 \begin_layout Plain Layout
8959 \begin_inset Quotes erd
8965 \begin_layout Description
8966 \begin_inset Flex Code
8969 \begin_layout Plain Layout
8975 Adds information to the document preamble.
8977 \begin_inset Newline newline
8981 \begin_inset Quotes eld
8985 \begin_inset Flex Code
8988 \begin_layout Plain Layout
8995 \begin_inset Quotes erd
9001 \begin_layout Description
9002 \begin_inset Flex Code
9005 \begin_layout Plain Layout
9011 Defines the possibilities for displaying citation references.
9013 \begin_inset CommandInset ref
9015 reference "subsec:Citation-engine-description"
9024 \begin_inset Quotes eld
9028 \begin_inset Flex Code
9031 \begin_layout Plain Layout
9038 \begin_inset Quotes erd
9042 Primarily used in cite engine files (see
9043 \begin_inset CommandInset ref
9045 reference "subsec:Cite-Engine-Files"
9055 \begin_layout Description
9056 \begin_inset Flex Code
9059 \begin_layout Plain Layout
9065 Defines formats for use in the display of bibliographic information.
9067 \begin_inset CommandInset ref
9069 reference "subsec:Citation-format-description"
9075 \begin_inset Quotes eld
9079 \begin_inset Flex Code
9082 \begin_layout Plain Layout
9089 \begin_inset Quotes erd
9093 Primarily used in cite engine files (see
9094 \begin_inset CommandInset ref
9096 reference "subsec:Cite-Engine-Files"
9106 \begin_layout Description
9107 \begin_inset Flex Code
9110 \begin_layout Plain Layout
9117 \begin_inset Flex Code
9120 \begin_layout Plain Layout
9129 \begin_inset Flex Code
9132 \begin_layout Plain Layout
9138 ] Determines whether
9142 or Bib\SpecialChar TeX
9143 is used to generate a Bibliography.
9144 Primarily used in cite engine files (see
9145 \begin_inset CommandInset ref
9147 reference "subsec:Cite-Engine-Files"
9157 \begin_layout Description
9158 \begin_inset Flex Code
9161 \begin_layout Plain Layout
9167 Describes various global options supported by the document class.
9169 \begin_inset CommandInset ref
9171 reference "subsec:ClassOptions"
9177 \begin_inset Quotes eld
9181 \begin_inset Flex Code
9184 \begin_layout Plain Layout
9191 \begin_inset Quotes erd
9197 \begin_layout Description
9198 \begin_inset Flex Code
9201 \begin_layout Plain Layout
9208 \begin_inset Flex Code
9211 \begin_layout Plain Layout
9220 \begin_inset space \thinspace{}
9224 \begin_inset Flex Code
9227 \begin_layout Plain Layout
9233 ] Whether the class should
9237 to having one or two columns.
9238 Can be changed in the
9239 \begin_inset Flex Noun
9242 \begin_layout Plain Layout
9243 Document\SpecialChar menuseparator
9252 \begin_layout Description
9253 \begin_inset Flex Code
9256 \begin_layout Plain Layout
9263 \begin_inset Flex Code
9266 \begin_layout Plain Layout
9272 ] This sequence defines the properties for a counter.
9273 If the counter does not yet exist, it is created; if it does exist, it
9276 \begin_inset Quotes eld
9280 \begin_inset Flex Code
9283 \begin_layout Plain Layout
9290 \begin_inset Quotes erd
9294 \begin_inset Newline newline
9298 \begin_inset CommandInset ref
9300 reference "subsec:Counters"
9304 for details on counters.
9307 \begin_layout Description
9308 \begin_inset Flex Code
9311 \begin_layout Plain Layout
9317 Sets the default font used to display the document.
9319 \begin_inset CommandInset ref
9321 reference "subsec:Font-description"
9325 for how to declare fonts.
9327 \begin_inset Quotes eld
9331 \begin_inset Flex Code
9334 \begin_layout Plain Layout
9341 \begin_inset Quotes erd
9347 \begin_layout Description
9348 \begin_inset Flex Code
9351 \begin_layout Plain Layout
9358 \begin_inset Flex Code
9361 \begin_layout Plain Layout
9367 ] Specifies a module to be included by default with this document class.
9368 The module is specified as filename without the
9369 \begin_inset Flex Code
9372 \begin_layout Plain Layout
9379 The user can still remove the module, but it will be active at the outset.
9380 (This applies only when new files are created, or when this class is chosen
9381 for an existing document.)
9384 \begin_layout Description
9385 \begin_inset Flex Code
9388 \begin_layout Plain Layout
9395 \begin_inset Flex Code
9398 \begin_layout Plain Layout
9404 ] This is the style that will be assigned to new paragraphs, usually
9405 \begin_inset Flex Noun
9408 \begin_layout Plain Layout
9415 This will default to the first defined style if not given, but you are
9416 encouraged to use this directive.
9419 \begin_layout Description
9420 \begin_inset Flex Code
9423 \begin_layout Plain Layout
9430 \begin_inset Flex Code
9433 \begin_layout Plain Layout
9439 ] This tag indicates that the module (which is specified by filename without
9441 \begin_inset Flex Code
9444 \begin_layout Plain Layout
9450 extension) cannot be used with this document class.
9451 This might be used in a journal-specific layout file to prevent, say, the
9453 \begin_inset Flex Code
9456 \begin_layout Plain Layout
9462 module that numbers theorems by section.
9467 be used in a module.
9468 Modules have their own way of excluding other modules (see
9469 \begin_inset CommandInset ref
9471 reference "subsec:Layout-modules"
9478 \begin_layout Description
9479 \begin_inset Flex Code
9482 \begin_layout Plain Layout
9488 Defines a new float.
9490 \begin_inset CommandInset ref
9492 reference "subsec:Floats"
9498 \begin_inset Quotes eld
9502 \begin_inset Flex Code
9505 \begin_layout Plain Layout
9512 \begin_inset Quotes erd
9518 \begin_layout Description
9519 \begin_inset Flex Code
9522 \begin_layout Plain Layout
9528 Sets the information that will be output in the
9529 \begin_inset Flex Code
9532 \begin_layout Plain Layout
9538 block when this document class is output to XHTML.
9539 Note that this will completely override any prior
9540 \begin_inset Flex Code
9543 \begin_layout Plain Layout
9550 \begin_inset Flex Code
9553 \begin_layout Plain Layout
9561 \begin_inset Newline newline
9565 \begin_inset Flex Code
9568 \begin_layout Plain Layout
9574 if you just want to add material to the preamble.) Must end with
9575 \begin_inset Quotes eld
9579 \begin_inset Flex Code
9582 \begin_layout Plain Layout
9589 \begin_inset Quotes erd
9595 \begin_layout Description
9596 \begin_inset Flex Code
9599 \begin_layout Plain Layout
9606 \begin_inset Flex Code
9609 \begin_layout Plain Layout
9615 ] The style to use for the table of contents, bibliography, and so forth,
9616 when the document is output to HTML.
9617 For articles, this should normally be
9618 \begin_inset Flex Code
9621 \begin_layout Plain Layout
9628 \begin_inset Flex Code
9631 \begin_layout Plain Layout
9638 If it is not given, then \SpecialChar LyX
9639 will attempt to figure out which layout to use.
9642 \begin_layout Description
9643 \begin_inset Flex Code
9646 \begin_layout Plain Layout
9653 \begin_inset Flex Code
9656 \begin_layout Plain Layout
9662 ] Modifies the properties of the given counter.
9663 If the counter does not exist, the statement is ignored.
9665 \begin_inset Quotes eld
9669 \begin_inset Flex Code
9672 \begin_layout Plain Layout
9679 \begin_inset Quotes erd
9683 \begin_inset Newline newline
9687 \begin_inset CommandInset ref
9689 reference "subsec:Counters"
9693 for details on counters.
9696 \begin_layout Description
9697 \begin_inset Flex Code
9700 \begin_layout Plain Layout
9707 \begin_inset Flex Code
9710 \begin_layout Plain Layout
9716 ] This allows you to include another layout definition file within yours
9717 to avoid duplicating commands.
9718 Common examples are the standard layout files, for example,
9719 \begin_inset Flex Code
9722 \begin_layout Plain Layout
9728 , which contains most of the basic layouts.
9731 \begin_layout Description
9732 \begin_inset Flex Code
9735 \begin_layout Plain Layout
9742 \begin_inset Flex Code
9745 \begin_layout Plain Layout
9751 ] This section (re-)defines the layout of an inset.
9752 It can be applied to an existing inset or to a new, user-defined inset,
9753 e.g., a new character style.
9755 \begin_inset Quotes eld
9759 \begin_inset Flex Code
9762 \begin_layout Plain Layout
9769 \begin_inset Quotes erd
9773 \begin_inset Newline newline
9777 \begin_inset CommandInset ref
9779 reference "subsec:Flex-insets-and"
9783 for more information.
9787 \begin_layout Description
9788 \begin_inset Flex Code
9791 \begin_layout Plain Layout
9798 \begin_inset Flex Code
9801 \begin_layout Plain Layout
9807 ] A string that indicates the width of the left margin on the screen, for
9809 \begin_inset Quotes eld
9813 \begin_inset Flex Code
9816 \begin_layout Plain Layout
9823 \begin_inset Quotes erd
9827 (Note that this is not a `length', like
9828 \begin_inset Quotes eld
9832 \begin_inset Quotes erd
9838 \begin_layout Description
9839 \begin_inset Flex Code
9842 \begin_layout Plain Layout
9849 \begin_inset Flex Code
9852 \begin_layout Plain Layout
9858 ] An integer that determines the maximal number of names displayed in an
9859 author-year citation before the citation switches to
9860 \begin_inset Quotes eld
9864 \begin_inset Quotes erd
9868 Primarily used in cite engine files (see
9869 \begin_inset CommandInset ref
9871 reference "subsec:Cite-Engine-Files"
9881 \begin_layout Description
9882 \begin_inset Flex Code
9885 \begin_layout Plain Layout
9892 \begin_inset Flex Code
9895 \begin_layout Plain Layout
9901 ] Modifies the properties of the given paragraph style.
9902 If the style does not exist, this section is ignored.
9904 \begin_inset Quotes eld
9908 \begin_inset Flex Code
9911 \begin_layout Plain Layout
9918 \begin_inset Quotes erd
9924 \begin_layout Description
9925 \begin_inset Flex Code
9928 \begin_layout Plain Layout
9935 \begin_inset Flex Code
9938 \begin_layout Plain Layout
9944 ] Deletes an existing counter, usually one defined in an included file.
9947 \begin_layout Description
9948 \begin_inset Flex Code
9951 \begin_layout Plain Layout
9958 \begin_inset Flex Code
9961 \begin_layout Plain Layout
9967 ] Deletes an existing float.
9968 This is particularly useful when you want to suppress a float that has
9969 been defined in an input file.
9972 \begin_layout Description
9973 \begin_inset Flex Code
9976 \begin_layout Plain Layout
9983 \begin_inset Flex Code
9986 \begin_layout Plain Layout
9992 ] Deletes an existing style.
9995 \begin_layout Description
9996 \begin_inset Flex Code
9999 \begin_layout Plain Layout
10006 \begin_inset Flex Code
10009 \begin_layout Plain Layout
10016 \begin_inset Flex Code
10019 \begin_layout Plain Layout
10025 ] Define a new table of contents with type
10026 \begin_inset Flex Code
10029 \begin_layout Plain Layout
10036 \begin_inset Flex Code
10039 \begin_layout Plain Layout
10046 See also the AddToToc commands.
10049 \begin_layout Description
10050 \begin_inset Flex Code
10053 \begin_layout Plain Layout
10060 \begin_inset Flex Code
10063 \begin_layout Plain Layout
10069 ] The file format (as defined in the \SpecialChar LyX
10070 preferences) produced by this document
10072 It is mainly useful when
10073 \begin_inset Flex Code
10076 \begin_layout Plain Layout
10083 \begin_inset Flex Code
10086 \begin_layout Plain Layout
10092 and one wants to define a new type of literate document.
10093 The format is reset to
10094 \begin_inset Quotes eld
10098 \begin_inset Flex Code
10101 \begin_layout Plain Layout
10108 \begin_inset Quotes erd
10112 \begin_inset Quotes eld
10116 \begin_inset Flex Code
10119 \begin_layout Plain Layout
10126 \begin_inset Quotes erd
10129 when the corresponding
10130 \begin_inset Flex Code
10133 \begin_layout Plain Layout
10139 parameter is encountered.
10142 \begin_layout Description
10143 \begin_inset Flex Code
10146 \begin_layout Plain Layout
10153 \begin_inset Flex Code
10156 \begin_layout Plain Layout
10167 \begin_inset Flex Code
10170 \begin_layout Plain Layout
10177 \begin_inset Flex Code
10180 \begin_layout Plain Layout
10186 ] Specifies what sort of output documents using this class will produce.
10189 \begin_layout Description
10190 \begin_inset Flex Code
10193 \begin_layout Plain Layout
10200 \begin_inset Flex Code
10203 \begin_layout Plain Layout
10210 \begin_inset Flex Code
10213 \begin_layout Plain Layout
10219 ] Specifies options, given in the second string, for the package named by
10222 \begin_inset Quotes eld
10226 \begin_inset Flex Code
10229 \begin_layout Plain Layout
10230 PackageOptions natbib square
10236 \begin_inset Quotes erd
10240 \begin_inset Flex Code
10243 \begin_layout Plain Layout
10249 to be loaded with the
10250 \begin_inset Flex Code
10253 \begin_layout Plain Layout
10260 (For \SpecialChar TeX
10261 perts, this causes \SpecialChar LyX
10263 \begin_inset Flex Code
10266 \begin_layout Plain Layout
10269 PassOptionsToPackage{natbib}{square}
10275 \begin_inset Flex Code
10278 \begin_layout Plain Layout
10287 \begin_layout Description
10288 \begin_inset Flex Code
10291 \begin_layout Plain Layout
10298 \begin_inset Flex Code
10301 \begin_layout Plain Layout
10310 \begin_inset Flex Code
10313 \begin_layout Plain Layout
10320 \begin_inset Flex Code
10323 \begin_layout Plain Layout
10329 ] The default pagestyle.
10330 Can be changed in the
10331 \begin_inset Flex Noun
10334 \begin_layout Plain Layout
10335 Document\SpecialChar menuseparator
10344 \begin_layout Description
10345 \begin_inset Flex Code
10348 \begin_layout Plain Layout
10354 Sets the preamble for the \SpecialChar LaTeX
10356 Note that this will completely override any prior
10357 \begin_inset Flex Code
10360 \begin_layout Plain Layout
10367 \begin_inset Flex Code
10370 \begin_layout Plain Layout
10378 \begin_inset Flex Code
10381 \begin_layout Plain Layout
10387 if you just want to add material to the preamble.) Must end with
10388 \begin_inset Quotes eld
10392 \begin_inset Flex Code
10395 \begin_layout Plain Layout
10402 \begin_inset Quotes erd
10408 \begin_layout Description
10409 \begin_inset Flex Code
10412 \begin_layout Plain Layout
10419 \begin_inset Flex Code
10422 \begin_layout Plain Layout
10429 \begin_inset Flex Code
10432 \begin_layout Plain Layout
10441 \begin_inset space \thinspace{}
10445 \begin_inset Flex Code
10448 \begin_layout Plain Layout
10454 ] Whether the class already provides the feature
10455 \begin_inset Flex Code
10458 \begin_layout Plain Layout
10465 A feature is in general the name of a package (e.
10466 \begin_inset space \thinspace{}
10470 \begin_inset space \space{}
10474 \begin_inset Flex Code
10477 \begin_layout Plain Layout
10484 \begin_inset Flex Code
10487 \begin_layout Plain Layout
10494 \begin_inset space \thinspace{}
10498 \begin_inset space \space{}
10502 \begin_inset Flex Code
10505 \begin_layout Plain Layout
10512 \begin_inset Flex Code
10515 \begin_layout Plain Layout
10523 \begin_inset CommandInset ref
10525 reference "chap:List-of-functions"
10529 for the list of features.
10532 \begin_layout Description
10533 \begin_inset Flex Code
10536 \begin_layout Plain Layout
10543 \begin_inset Flex Code
10546 \begin_layout Plain Layout
10552 ] Indicates that this layout provides the functionality of the module mentioned,
10553 which should be specified by the filename without the
10554 \begin_inset Flex Code
10557 \begin_layout Plain Layout
10564 This will typically be used if the layout includes the module directly,
10565 rather than using the
10566 \begin_inset Flex Code
10569 \begin_layout Plain Layout
10575 tag to indicate that it ought to be used.
10576 It could also be used in a module that provided an alternate implementation
10577 of the same functionality.
10580 \begin_layout Description
10581 \begin_inset Flex Code
10584 \begin_layout Plain Layout
10591 \begin_inset Flex Code
10594 \begin_layout Plain Layout
10600 ] Creates a new paragraph style if it does not already exist.
10601 If the style does exist, this section is ignored.
10603 \begin_inset Quotes eld
10607 \begin_inset Flex Code
10610 \begin_layout Plain Layout
10617 \begin_inset Quotes erd
10623 \begin_layout Description
10624 \begin_inset Flex Code
10627 \begin_layout Plain Layout
10634 \begin_inset Flex Code
10637 \begin_layout Plain Layout
10643 ] Whether the class requires the feature
10644 \begin_inset Flex Code
10647 \begin_layout Plain Layout
10654 Multiple features must be separated by commas.
10655 Note that you can only request supported features.
10657 \begin_inset CommandInset ref
10659 reference "chap:List-of-functions"
10663 for the list of features.).
10664 If you require a package with specific options, you can additionally use
10666 \begin_inset Flex Code
10669 \begin_layout Plain Layout
10678 \begin_layout Description
10679 \begin_inset Flex Code
10682 \begin_layout Plain Layout
10689 \begin_inset Flex Code
10692 \begin_layout Plain Layout
10698 ] A string that indicates the width of the right margin on the screen, for
10700 \begin_inset Quotes eld
10704 \begin_inset Flex Code
10707 \begin_layout Plain Layout
10714 \begin_inset Quotes erd
10720 \begin_layout Description
10721 \begin_inset Flex Code
10724 \begin_layout Plain Layout
10731 \begin_inset Flex Code
10734 \begin_layout Plain Layout
10740 ] Sets which divisions get numbered.
10742 \begin_inset Newline newline
10746 \begin_inset Flex Code
10749 \begin_layout Plain Layout
10755 counter in \SpecialChar LaTeX
10759 \begin_layout Description
10760 \begin_inset Flex Code
10763 \begin_layout Plain Layout
10770 \begin_inset Flex Code
10773 \begin_layout Plain Layout
10782 \begin_inset space \thinspace{}
10786 \begin_inset Flex Code
10789 \begin_layout Plain Layout
10795 ] Whether the class-default should be printing on one or both sides of the
10797 Can be changed in the
10798 \begin_inset Flex Noun
10801 \begin_layout Plain Layout
10802 Document\SpecialChar menuseparator
10811 \begin_layout Description
10812 \begin_inset Flex Code
10815 \begin_layout Plain Layout
10822 \begin_inset Flex Code
10825 \begin_layout Plain Layout
10831 ] This sequence defines a paragraph style.
10832 If the style does not yet exist, it is created; if it does exist, its parameter
10835 \begin_inset Quotes eld
10839 \begin_inset Flex Code
10842 \begin_layout Plain Layout
10849 \begin_inset Quotes erd
10853 \begin_inset Newline newline
10857 \begin_inset CommandInset ref
10859 reference "subsec:Paragraph-Styles"
10863 for details on paragraph styles.
10866 \begin_layout Description
10867 \begin_inset Flex Code
10870 \begin_layout Plain Layout
10877 \begin_inset Flex Code
10880 \begin_layout Plain Layout
10886 ] The name of the command or environment to be used with
10887 \begin_inset Flex Code
10890 \begin_layout Plain Layout
10899 \begin_layout Description
10900 \begin_inset Flex Code
10903 \begin_layout Plain Layout
10910 \begin_inset Flex Code
10913 \begin_layout Plain Layout
10922 \begin_inset Flex Code
10925 \begin_layout Plain Layout
10931 ] Indicates what kind of markup is used to define the title of a document.
10933 \begin_inset Flex Code
10936 \begin_layout Plain Layout
10942 means that the macro with name
10943 \begin_inset Flex Code
10946 \begin_layout Plain Layout
10952 will be inserted after the last layout which has
10953 \begin_inset Quotes eld
10957 \begin_inset Flex Code
10960 \begin_layout Plain Layout
10962 \begin_inset space ~
10971 \begin_inset Quotes erd
10976 \begin_inset Flex Code
10979 \begin_layout Plain Layout
10985 corresponds to the case where all layouts which have
10986 \begin_inset Quotes eld
10990 \begin_inset Flex Code
10993 \begin_layout Plain Layout
10995 \begin_inset space ~
11004 \begin_inset Quotes erd
11007 should be enclosed into the
11008 \begin_inset Flex Code
11011 \begin_layout Plain Layout
11020 \begin_layout Description
11021 \begin_inset Flex Code
11024 \begin_layout Plain Layout
11031 \begin_inset Flex Code
11034 \begin_layout Plain Layout
11040 ] Sets which divisions are included in the table of contents.
11042 \begin_inset Flex Code
11045 \begin_layout Plain Layout
11051 counter in \SpecialChar LaTeX
11055 \begin_layout Subsection
11056 \begin_inset Flex Code
11059 \begin_layout Plain Layout
11066 \begin_inset CommandInset label
11068 name "subsec:ClassOptions"
11075 \begin_layout Standard
11077 \begin_inset Flex Code
11080 \begin_layout Plain Layout
11086 section can contain the following entries:
11089 \begin_layout Description
11090 \begin_inset Flex Code
11093 \begin_layout Plain Layout
11100 \begin_inset Flex Code
11103 \begin_layout Plain Layout
11109 ] The list of available font sizes for the document's main font, separated
11111 \begin_inset Quotes eld
11115 \begin_inset Flex Code
11118 \begin_layout Plain Layout
11125 \begin_inset Quotes erd
11131 \begin_layout Description
11132 \begin_inset Flex Code
11135 \begin_layout Plain Layout
11141 Used to set the DTD line with XML-based output classes.
11143 \begin_inset space \thinspace{}
11147 \begin_inset Quotes eld
11150 -//OASIS//DTD DocBook V4.2//EN
11151 \begin_inset Quotes erd
11157 \begin_layout Description
11158 \begin_inset Flex Code
11161 \begin_layout Plain Layout
11168 \begin_inset Flex Code
11171 \begin_layout Plain Layout
11172 string="empty|plain|headings|fancy"
11177 ] The list of available page sty\SpecialChar softhyphen
11179 \begin_inset Quotes eld
11183 \begin_inset Flex Code
11186 \begin_layout Plain Layout
11193 \begin_inset Quotes erd
11199 \begin_layout Description
11200 \begin_inset Flex Code
11203 \begin_layout Plain Layout
11210 \begin_inset Flex Code
11213 \begin_layout Plain Layout
11219 ] Some document class options, separated by a comma, that will be added
11220 to the optional part of the
11221 \begin_inset Flex Code
11224 \begin_layout Plain Layout
11235 \begin_layout Standard
11237 \begin_inset Flex Code
11240 \begin_layout Plain Layout
11246 section must end with
11247 \begin_inset Quotes eld
11251 \begin_inset Flex Code
11254 \begin_layout Plain Layout
11261 \begin_inset Quotes erd
11267 \begin_layout Subsection
11269 \begin_inset CommandInset label
11271 name "subsec:Paragraph-Styles"
11278 \begin_layout Standard
11279 A paragraph style description looks like this:
11283 \begin_layout Plain Layout
11284 Note that this will either define a new style or modify an existing one.
11292 \begin_layout LyX-Code
11299 \begin_layout LyX-Code
11303 \begin_layout LyX-Code
11307 \begin_layout Standard
11308 where the following commands are allowed:
11311 \begin_layout Description
11312 \begin_inset Flex Code
11315 \begin_layout Plain Layout
11322 \begin_inset Flex Code
11325 \begin_layout Plain Layout
11331 =""] This paragraph will appear in the table of contents of the given type.
11332 An empty string disables.
11333 See also the OutlinerName and the IsTocCaption commands.
11337 \begin_layout Description
11338 \begin_inset Flex Code
11341 \begin_layout Plain Layout
11348 \begin_inset Flex Code
11351 \begin_layout Plain Layout
11356 , left, right, center
11361 ] Paragraph alignment.
11364 \begin_layout Description
11365 \begin_inset Flex Code
11368 \begin_layout Plain Layout
11375 \begin_inset Flex Code
11378 \begin_layout Plain Layout
11383 , left, right, center
11388 ] A comma separated list of permitted alignments.
11389 (Some \SpecialChar LaTeX
11390 styles prohibit certain alignments, since those wouldn't make sense.
11391 For example a right-aligned or centered enumeration isn't possible.)
11394 \begin_layout Description
11395 \begin_inset Flex Code
11398 \begin_layout Plain Layout
11405 \begin_inset Flex Code
11408 \begin_layout Plain Layout
11414 ] Defines argument number <int> of a command\SpecialChar breakableslash
11415 environment associated with
11417 This is useful for things like section headings, and only makes sense with
11420 Every (optional or required) argument of a command or environment – except
11421 for the required argument that is associated with the content of the paragraph
11422 itself – has a separate definition, where the number specifies the order
11424 The definition must end with
11425 \begin_inset Flex Code
11428 \begin_layout Plain Layout
11435 So a command with two optional arguments has:
11439 \begin_layout Quote
11445 \begin_layout Quote
11451 \begin_layout Quote
11457 \begin_layout Quote
11463 \begin_layout Quote
11469 \begin_layout Quote
11475 \begin_layout Standard
11477 \begin_inset Flex Code
11480 \begin_layout Plain Layout
11486 definition, the following specifications are possible:
11489 \begin_layout Itemize
11490 \begin_inset Flex Code
11493 \begin_layout Plain Layout
11500 \begin_inset Flex Code
11503 \begin_layout Plain Layout
11509 The string that will appear both in the menu (to insert this argument)
11510 and on the argument inset button (unless you also specify a separate
11511 \begin_inset Flex Code
11514 \begin_layout Plain Layout
11521 For the menu, you can define an accelerator by appending the respective
11522 character to the string, divided by
11523 \begin_inset Quotes eld
11527 \begin_inset Quotes erd
11531 \begin_inset space \thinspace{}
11535 \begin_inset space \space{}
11539 \begin_inset Quotes eld
11543 \begin_inset Flex Code
11546 \begin_layout Plain Layout
11553 \begin_inset Quotes erd
11559 \begin_layout Itemize
11560 \begin_inset Flex Code
11563 \begin_layout Plain Layout
11570 \begin_inset Flex Code
11573 \begin_layout Plain Layout
11579 A separate string for the menu.
11580 You can define an accelerator by appending the respective character to
11581 the string, divided by
11582 \begin_inset Quotes eld
11586 \begin_inset Quotes erd
11590 \begin_inset space \thinspace{}
11594 \begin_inset space \space{}
11598 \begin_inset Quotes eld
11602 \begin_inset Flex Code
11605 \begin_layout Plain Layout
11612 \begin_inset Quotes erd
11616 This specification is optional.
11617 If it is not given the
11618 \begin_inset Flex Code
11621 \begin_layout Plain Layout
11627 will be used instead for the menu.
11630 \begin_layout Itemize
11631 \begin_inset Flex Code
11634 \begin_layout Plain Layout
11641 \begin_inset Flex Code
11644 \begin_layout Plain Layout
11650 A longer explanatory text that appears in the tooltip when hovering over
11651 the argument inset.
11654 \begin_layout Itemize
11655 \begin_inset Flex Code
11658 \begin_layout Plain Layout
11665 \begin_inset Flex Code
11668 \begin_layout Plain Layout
11677 \begin_inset space \thinspace{}
11681 \begin_inset Flex Code
11684 \begin_layout Plain Layout
11690 ] Declare if this is a mandatory (1) or an optional (0) argument.
11691 Mandatory arguments will be output empty if not given, while optional arguments
11692 will not be output at all.
11693 By default, mandatory arguments are delimited by
11694 \begin_inset Flex Code
11697 \begin_layout Plain Layout
11703 , while optional arguments are delimited by
11704 \begin_inset Flex Code
11707 \begin_layout Plain Layout
11716 \begin_layout Itemize
11717 \begin_inset Flex Code
11720 \begin_layout Plain Layout
11727 \begin_inset Flex Code
11730 \begin_layout Plain Layout
11736 defines another argument (by its number) which this argument requires to
11737 be output if it is itself output.
11739 \begin_inset space \thinspace{}
11742 g., in \SpecialChar LaTeX
11743 commands, optional arguments often require previous optional arguments
11744 to be output (at least empty), as in
11745 \begin_inset Flex Code
11748 \begin_layout Plain Layout
11751 command[][argument]{text}
11757 This can be achieved by the statement
11758 \begin_inset Flex Code
11761 \begin_layout Plain Layout
11768 \begin_inset Flex Code
11771 \begin_layout Plain Layout
11780 \begin_layout Itemize
11781 \begin_inset Flex Code
11784 \begin_layout Plain Layout
11791 \begin_inset Flex Code
11794 \begin_layout Plain Layout
11800 defines a custom left delimiter (instead of
11801 \begin_inset Flex Code
11804 \begin_layout Plain Layout
11811 \begin_inset Flex Code
11814 \begin_layout Plain Layout
11821 A line break in the output can be indicated by
11822 \begin_inset Flex Code
11825 \begin_layout Plain Layout
11834 \begin_layout Itemize
11835 \begin_inset Flex Code
11838 \begin_layout Plain Layout
11845 \begin_inset Flex Code
11848 \begin_layout Plain Layout
11854 defines a custom right delimiter (instead of
11855 \begin_inset Flex Code
11858 \begin_layout Plain Layout
11865 \begin_inset Flex Code
11868 \begin_layout Plain Layout
11875 A line break in the output can be indicated by
11876 \begin_inset Flex Code
11879 \begin_layout Plain Layout
11888 \begin_layout Itemize
11889 \begin_inset Flex Code
11892 \begin_layout Plain Layout
11899 \begin_inset Flex Code
11902 \begin_layout Plain Layout
11908 defines an argument that is inserted if and only if no user-specified arguments
11910 \begin_inset space \thinspace{}
11914 \begin_inset space \space{}
11917 if no argument inset has been inserted (note that also an empty argument
11918 inset omits the DefaultArg).
11919 Multiple arguments need to be separated by comma.
11922 \begin_layout Itemize
11923 \begin_inset Flex Code
11926 \begin_layout Plain Layout
11933 \begin_inset Flex Code
11936 \begin_layout Plain Layout
11942 defines an argument that is inserted in any case (alone or in addition
11943 to user-specified arguments).
11944 Multiple arguments need to be separated by comma.
11947 \begin_layout Itemize
11948 \begin_inset Flex Code
11951 \begin_layout Plain Layout
11957 The font used for the argument content, see
11958 \begin_inset CommandInset ref
11960 reference "subsec:Font-description"
11967 \begin_layout Itemize
11968 \begin_inset Flex Code
11971 \begin_layout Plain Layout
11977 The font used for the label; see
11978 \begin_inset CommandInset ref
11980 reference "subsec:Font-description"
11987 \begin_layout Itemize
11988 \begin_inset Flex Code
11991 \begin_layout Plain Layout
11998 \begin_inset Flex Code
12001 \begin_layout Plain Layout
12006 , Minimalistic, Conglomerate
12011 ] describes the rendering style used for the inset's frame and buttons.
12014 \begin_layout Itemize
12015 \begin_inset Flex Code
12018 \begin_layout Plain Layout
12025 \begin_inset Flex Code
12028 \begin_layout Plain Layout
12035 \begin_inset Flex Code
12038 \begin_layout Plain Layout
12044 , this argument is automatically inserted when the respective style is selected.
12045 Currently, only one argument per style\SpecialChar breakableslash
12046 layout can be automatically inserted.
12049 \begin_layout Itemize
12050 \begin_inset Flex Code
12053 \begin_layout Plain Layout
12060 \begin_inset Flex Code
12063 \begin_layout Plain Layout
12070 \begin_inset Flex Code
12073 \begin_layout Plain Layout
12079 , this argument will be inserted with a copy of the co-text (either selected
12080 text or the whole paragraph) as content.
12083 \begin_layout Itemize
12084 \begin_inset Flex Code
12087 \begin_layout Plain Layout
12094 \begin_inset Flex Code
12097 \begin_layout Plain Layout
12107 ] Whether the contents of this argument should be output in raw form, meaning
12108 without special translations that \SpecialChar LaTeX
12111 \begin_inset Flex Code
12114 \begin_layout Plain Layout
12120 status is inherited by the inset or paragraph layout the argument belongs
12121 to, true and false change the status for the given argument only.
12124 \begin_layout Itemize
12125 \begin_inset Flex Code
12128 \begin_layout Plain Layout
12135 \begin_inset Flex Code
12138 \begin_layout Plain Layout
12139 string of characters
12148 Defines individual characters
12149 \begin_inset Newline linebreak
12152 that should be output in raw form, meaning without special translations
12153 that \SpecialChar LaTeX
12155 Note that, contrary to PassThru, this needs to be explicitly defined for
12157 That is, arguments do not inherit PassThruChars from their parent inset
12161 \begin_layout Itemize
12162 \begin_inset Flex Code
12165 \begin_layout Plain Layout
12172 \begin_inset Flex Code
12175 \begin_layout Plain Layout
12184 \begin_inset space \thinspace{}
12188 \begin_inset Flex Code
12191 \begin_layout Plain Layout
12197 ] If this is set to 1, the argument will output its content in the corresponding
12198 item in the table of contents.
12202 \begin_layout Standard
12203 By default, the text entered in the \SpecialChar LyX
12204 workarea in the respective layout is
12205 the last (mandatory) argument of a command if the
12206 \begin_inset Flex Code
12209 \begin_layout Plain Layout
12216 \begin_inset Flex Code
12219 \begin_layout Plain Layout
12226 However, arguments with the prefix
12227 \begin_inset Flex Code
12230 \begin_layout Plain Layout
12236 are output after this workarea argument.
12237 Note that post-argument numbering restarts at 1, so the first argument
12238 following the workarea argument is
12239 \begin_inset Flex Code
12242 \begin_layout Plain Layout
12249 Post-arguments are ignored in any other
12250 \begin_inset Flex Code
12253 \begin_layout Plain Layout
12260 \begin_inset Flex Code
12263 \begin_layout Plain Layout
12272 \begin_layout Standard
12274 \begin_inset Flex Code
12277 \begin_layout Plain Layout
12286 \begin_inset Flex Code
12289 \begin_layout Plain Layout
12298 \begin_inset Flex Code
12301 \begin_layout Plain Layout
12307 followed by the number (e.
12308 \begin_inset space \thinspace{}
12312 \begin_inset space \space{}
12316 \begin_inset Flex Code
12319 \begin_layout Plain Layout
12329 \begin_layout Description
12330 \begin_inset Flex Code
12333 \begin_layout Plain Layout
12339 Includes a comma-separated list of layouts that should be nested in and
12340 after the current layout.
12341 Only makes sense for nestable layouts (such as environments).
12343 \begin_inset Quotes eld
12347 \begin_inset Flex Code
12350 \begin_layout Plain Layout
12357 \begin_inset Quotes erd
12362 \begin_inset Flex Code
12365 \begin_layout Plain Layout
12374 \begin_layout Description
12375 \begin_inset Flex Code
12378 \begin_layout Plain Layout
12384 Note that this will completely override any prior
12385 \begin_inset Flex Code
12388 \begin_layout Plain Layout
12394 declaration for this style.
12396 \begin_inset Quotes eld
12400 \begin_inset Flex Code
12403 \begin_layout Plain Layout
12410 \begin_inset Quotes erd
12415 \begin_inset CommandInset ref
12417 reference "subsec:I18n"
12421 for details on its use.
12424 \begin_layout Description
12425 \begin_inset Flex Code
12428 \begin_layout Plain Layout
12435 \begin_inset Flex Code
12438 \begin_layout Plain Layout
12448 \begin_layout Plain Layout
12449 Note that a `float' here is a real number, such as: 1.5.
12454 The vertical space with which the last of a chain of paragraphs with this
12455 style is separated from the following paragraph.
12456 If the next paragraph has another style, the separations are not simply
12457 added, but the maximum is taken.
12460 \begin_layout Description
12461 \begin_inset Flex Code
12464 \begin_layout Plain Layout
12471 \begin_inset Flex Code
12474 \begin_layout Plain Layout
12480 ] The category for this style.
12481 This is used to group related styles in the style combobox on the toolbar.
12482 Any string can be used, but you may want to use existing categories with
12487 \begin_layout Description
12488 \begin_inset Flex Code
12491 \begin_layout Plain Layout
12497 Depth of XML command.
12498 Used only with XML-type formats.
12501 \begin_layout Description
12502 \begin_inset Flex Code
12505 \begin_layout Plain Layout
12512 \begin_inset Flex Code
12515 \begin_layout Plain Layout
12521 ] Copies all the features of an existing style into the current one.
12525 \begin_layout Description
12526 \begin_inset Flex Code
12529 \begin_layout Plain Layout
12536 \begin_inset Flex Code
12539 \begin_layout Plain Layout
12545 ] The name of a style whose preamble should be output
12550 This allows to ensure some ordering of the preamble snippets when macros
12551 definitions depend on one another.
12555 \begin_layout Plain Layout
12556 Note that, besides that functionality, there is no way to ensure any ordering
12558 The ordering that you see in a given version of \SpecialChar LyX
12559 may change without warning
12568 \begin_layout Description
12569 \begin_inset Flex Code
12572 \begin_layout Plain Layout
12579 \begin_inset Flex Code
12582 \begin_layout Plain Layout
12587 , Box, Filled_Box, Static
12592 ] The type of label that stands at the end of the paragraph (or sequence
12594 \begin_inset Flex Code
12597 \begin_layout Plain Layout
12604 \begin_inset Newline newline
12608 \begin_inset Flex Code
12611 \begin_layout Plain Layout
12618 \begin_inset Flex Code
12621 \begin_layout Plain Layout
12628 \begin_inset Flex Code
12631 \begin_layout Plain Layout
12639 \begin_inset Flex Code
12642 \begin_layout Plain Layout
12649 \begin_inset Quotes eld
12653 \begin_inset Quotes erd
12657 \begin_inset Flex Code
12660 \begin_layout Plain Layout
12667 \begin_inset space \space{}
12671 \begin_inset Flex Code
12674 \begin_layout Plain Layout
12680 ) is a white (resp.
12681 \begin_inset space ~
12684 black) square suitable for end of proof markers,
12685 \begin_inset Flex Code
12688 \begin_layout Plain Layout
12694 is an explicit text string.
12697 \begin_layout Description
12698 \begin_inset Flex Code
12701 \begin_layout Plain Layout
12708 \begin_inset Flex Code
12711 \begin_layout Plain Layout
12717 ] The string used for a label with a
12718 \begin_inset Flex Code
12721 \begin_layout Plain Layout
12728 \begin_inset Newline newline
12732 \begin_inset Flex Code
12735 \begin_layout Plain Layout
12745 \begin_layout Description
12746 \begin_inset Flex Code
12749 \begin_layout Plain Layout
12755 The font used for both the text body
12761 \begin_inset CommandInset ref
12763 reference "subsec:Font-description"
12768 Note that defining this font automatically defines the
12769 \begin_inset Flex Code
12772 \begin_layout Plain Layout
12779 So you should define this one first if you also want to define
12780 \begin_inset Flex Code
12783 \begin_layout Plain Layout
12792 \begin_layout Description
12793 \begin_inset Flex Code
12796 \begin_layout Plain Layout
12803 \begin_inset Flex Code
12806 \begin_layout Plain Layout
12812 ] Used for backporting new styles to stable \SpecialChar LyX
12814 The first stable version that supports this tag is \SpecialChar LyX
12816 The argument is a number which may either be 0, -1 or any value greater
12819 \begin_inset Flex Code
12822 \begin_layout Plain Layout
12828 flag of a style is greater than zero, it will always be written to the
12830 If a .lyx file is read, the style definitions from the document header are
12831 added to the document class.
12832 Therefore even older \SpecialChar LyX
12833 versions can handle the style.
12835 \begin_inset Flex Code
12838 \begin_layout Plain Layout
12844 is a version number: if the style is read, and the version number is less
12845 than the version number of the already existing style in the document class,
12846 the new style is ignored.
12847 If the version number is greater, the new style replaces the existing style.
12848 A value of -1 means an infinite version number, i.
12849 \begin_inset space \thinspace{}
12853 \begin_inset space \space{}
12856 the style is always used.
12859 \begin_layout Description
12860 \begin_inset Flex Code
12863 \begin_layout Plain Layout
12870 \begin_inset Flex Code
12873 \begin_layout Plain Layout
12882 \begin_inset space \thinspace{}
12886 \begin_inset Flex Code
12889 \begin_layout Plain Layout
12895 ] Usually \SpecialChar LyX
12896 does not allow you to insert more than one space between words,
12897 since a space is considered as the separation between two words, not a
12898 character or symbol of its own.
12899 This is a very fine thing but sometimes annoying, for example, when typing
12900 program code or plain \SpecialChar LaTeX
12903 \begin_inset Flex Code
12906 \begin_layout Plain Layout
12913 Note that \SpecialChar LyX
12914 will create protected blanks for the additional blanks when
12915 in another mode than \SpecialChar LaTeX
12919 \begin_layout Description
12920 \begin_inset Flex Code
12923 \begin_layout Plain Layout
12929 These tags are used with XHTML output.
12931 \begin_inset CommandInset ref
12933 reference "subsec:Paragraph-Style-XHTML"
12940 \begin_layout Description
12941 \begin_inset Flex Code
12944 \begin_layout Plain Layout
12950 [FIXME] (Used only with XML-type formats.)
12953 \begin_layout Description
12954 \begin_inset Flex Code
12957 \begin_layout Plain Layout
12964 \begin_inset Flex Code
12967 \begin_layout Plain Layout
12976 \begin_inset space \thinspace{}
12980 \begin_inset Flex Code
12983 \begin_layout Plain Layout
12990 \begin_inset Flex Code
12993 \begin_layout Plain Layout
12999 , marks the style as to be included in the document preamble and not in
13001 This is useful for document classes that want such information as the title
13002 and author to appear in the preamble.
13003 Note that this works only for styles for which the
13004 \begin_inset Flex Code
13007 \begin_layout Plain Layout
13014 \begin_inset Flex Code
13017 \begin_layout Plain Layout
13024 \begin_inset Flex Code
13027 \begin_layout Plain Layout
13036 \begin_layout Description
13037 \begin_inset Flex Code
13040 \begin_layout Plain Layout
13047 \begin_inset Flex Code
13050 \begin_layout Plain Layout
13059 \begin_inset space \thinspace{}
13063 \begin_inset Flex Code
13066 \begin_layout Plain Layout
13073 \begin_inset Flex Code
13076 \begin_layout Plain Layout
13082 , marks the style as being part of a title block (see also the
13083 \begin_inset Flex Code
13086 \begin_layout Plain Layout
13093 \begin_inset Flex Code
13096 \begin_layout Plain Layout
13105 \begin_layout Description
13106 \begin_inset Flex Code
13109 \begin_layout Plain Layout
13115 Includes a comma-separated list of layouts after which this one should
13117 Only makes sense with regard to nestable layouts (such as environments).
13119 \begin_inset Quotes eld
13123 \begin_inset Flex Code
13126 \begin_layout Plain Layout
13133 \begin_inset Quotes erd
13138 \begin_inset Flex Code
13141 \begin_layout Plain Layout
13150 \begin_layout Description
13151 \begin_inset Flex Code
13154 \begin_layout Plain Layout
13161 \begin_inset Flex Code
13164 \begin_layout Plain Layout
13173 \begin_inset space \thinspace{}
13177 \begin_inset Flex Code
13180 \begin_layout Plain Layout
13186 ] If this is set to 1 and AddToToc is enabled, the paragraph adds a summary
13187 of its contents in its item in the table of contents.
13188 Otherwise, only the label, if it exists, appears.
13191 \begin_layout Description
13192 \begin_inset Flex Code
13195 \begin_layout Plain Layout
13202 \begin_inset Flex Code
13205 \begin_layout Plain Layout
13211 ] The \SpecialChar LaTeX
13212 command sequence declaring an item in a list.
13213 The command is to be defined without the preceding backslash (the default
13215 \begin_inset Quotes eld
13219 \begin_inset Quotes erd
13223 \begin_inset Flex Code
13226 \begin_layout Plain Layout
13234 in the \SpecialChar LaTeX
13238 \begin_layout Description
13239 \begin_inset Flex Code
13242 \begin_layout Plain Layout
13249 \begin_inset Flex Code
13252 \begin_layout Plain Layout
13258 ] This provides extra space between paragraphs that have the same style.
13259 If you put other styles into an environment, each is separated with the
13261 \begin_inset Flex Code
13264 \begin_layout Plain Layout
13271 But the whole items of the environment are additionally separated with
13273 \begin_inset Flex Code
13276 \begin_layout Plain Layout
13283 Note that this is a
13288 \begin_layout Description
13289 \begin_inset Flex Code
13292 \begin_layout Plain Layout
13298 [FIXME] (Used only with XML-type formats.)
13301 \begin_layout Description
13302 \begin_inset Flex Code
13305 \begin_layout Plain Layout
13312 \begin_inset Flex Code
13315 \begin_layout Plain Layout
13324 \begin_inset space \thinspace{}
13328 \begin_inset Flex Code
13331 \begin_layout Plain Layout
13337 ] Usually \SpecialChar LyX
13338 does not allow you to leave a paragraph empty, since it would
13339 lead to empty \SpecialChar LaTeX
13341 There are some cases where this could be desirable however: in a letter
13342 template, the required fields can be provided as empty fields, so that
13343 people do not forget them; in some special classes, a style can be used
13344 as some kind of break, which does not contain actual text.
13347 \begin_layout Description
13348 \begin_inset Flex Code
13351 \begin_layout Plain Layout
13358 \begin_inset Flex Code
13361 \begin_layout Plain Layout
13367 ] The vertical space between the label and the text body.
13368 Only used for labels that are above the text body (
13369 \begin_inset Flex Code
13372 \begin_layout Plain Layout
13379 \begin_inset Newline newline
13383 \begin_inset Flex Code
13386 \begin_layout Plain Layout
13387 Centered_Top_Environment
13395 \begin_layout Description
13396 \begin_inset Flex Code
13399 \begin_layout Plain Layout
13406 \begin_inset Flex Code
13409 \begin_layout Plain Layout
13415 ] The name of the counter for automatic numbering.
13416 In order to have the counter appear with your label, you will need to reference
13418 \begin_inset Flex Code
13421 \begin_layout Plain Layout
13430 This will work with
13431 \begin_inset Flex Code
13434 \begin_layout Plain Layout
13441 \begin_inset Flex Code
13444 \begin_layout Plain Layout
13451 \begin_inset Flex Code
13454 \begin_layout Plain Layout
13461 \begin_inset Flex Code
13464 \begin_layout Plain Layout
13471 \begin_inset Newline newline
13479 \begin_inset Flex Code
13482 \begin_layout Plain Layout
13489 \begin_inset Flex Code
13492 \begin_layout Plain Layout
13498 , though this case is a bit complicated.
13499 Suppose you declare
13500 \begin_inset Quotes eld
13504 \begin_inset Flex Code
13507 \begin_layout Plain Layout
13508 LabelCounter myenum
13514 \begin_inset Quotes erd
13518 Then the actual counters used are
13519 \begin_inset Flex Code
13522 \begin_layout Plain Layout
13529 \begin_inset Flex Code
13532 \begin_layout Plain Layout
13539 \begin_inset Flex Code
13542 \begin_layout Plain Layout
13549 \begin_inset Flex Code
13552 \begin_layout Plain Layout
13558 , much as in \SpecialChar LaTeX
13560 These counters must all be declared separately.
13561 \begin_inset Newline newline
13565 \begin_inset CommandInset ref
13567 reference "subsec:Counters"
13571 for details on counters.
13574 \begin_layout Description
13575 \begin_inset Flex Code
13578 \begin_layout Plain Layout
13584 The font used for the label.
13586 \begin_inset CommandInset ref
13588 reference "subsec:Font-description"
13595 \begin_layout Description
13596 \begin_inset Flex Code
13599 \begin_layout Plain Layout
13606 \begin_inset Flex Code
13609 \begin_layout Plain Layout
13615 ] Text that indicates how far a label should be indented.
13618 \begin_layout Description
13619 \begin_inset Flex Code
13622 \begin_layout Plain Layout
13629 \begin_inset Flex Code
13632 \begin_layout Plain Layout
13638 ] Text that indicates the amount of horizontal space between the label and
13640 Only used for labels that are not above the text body.
13643 \begin_layout Description
13644 \begin_inset Flex Code
13647 \begin_layout Plain Layout
13654 \begin_inset Flex Code
13657 \begin_layout Plain Layout
13663 ] The string used for the label.
13665 \begin_inset Flex Code
13668 \begin_layout Plain Layout
13674 is set, this string can be contain the special formatting commands described
13676 \begin_inset CommandInset ref
13678 reference "subsec:Counters"
13685 \begin_layout Description
13686 \begin_inset Flex Code
13689 \begin_layout Plain Layout
13690 LabelStringAppendix
13696 \begin_inset Flex Code
13699 \begin_layout Plain Layout
13705 ] This is used inside the appendix instead of
13706 \begin_inset Newline newline
13710 \begin_inset Flex Code
13713 \begin_layout Plain Layout
13721 \begin_inset Flex Code
13724 \begin_layout Plain Layout
13731 \begin_inset Newline newline
13735 \begin_inset Flex Code
13738 \begin_layout Plain Layout
13739 LabelStringAppendix
13747 \begin_layout Description
13748 \begin_inset Flex Code
13751 \begin_layout Plain Layout
13757 [FIXME] (Used only with XML-type formats.)
13760 \begin_layout Description
13761 \begin_inset Flex Code
13764 \begin_layout Plain Layout
13771 \begin_inset Flex Code
13774 \begin_layout Plain Layout
13779 , Manual, Static, Above,
13780 \begin_inset Newline newline
13783 Centered, Sensitive, Enumerate,
13784 \begin_inset Newline newline
13787 Itemize, Bibliography
13796 \begin_layout Description
13797 \begin_inset Flex Code
13800 \begin_layout Plain Layout
13806 means the label is the very first word (up to the first real blank).
13807 Use protected spaces if you want more than one word as the label.
13811 \begin_layout Description
13812 \begin_inset Flex Code
13815 \begin_layout Plain Layout
13821 means the label is simply what is declared as
13822 \begin_inset Flex Code
13825 \begin_layout Plain Layout
13832 This will be displayed
13833 \begin_inset Quotes eld
13837 \begin_inset Quotes erd
13840 , at the beginning of the paragraph.
13842 \begin_inset Flex Code
13845 \begin_layout Plain Layout
13852 \begin_inset Flex Code
13855 \begin_layout Plain Layout
13861 , then it will be displayed only in the first paragraph of any sequence
13862 of paragraphs with the same
13863 \begin_inset Flex Code
13866 \begin_layout Plain Layout
13875 \begin_layout Description
13876 \begin_inset Flex Code
13879 \begin_layout Plain Layout
13886 \begin_inset space ~
13890 \begin_inset space ~
13894 \begin_inset Flex Code
13897 \begin_layout Plain Layout
13903 are special cases of
13904 \begin_inset Flex Code
13907 \begin_layout Plain Layout
13914 The label will be printed above the paragraph either at the beginning of
13915 the line or centered.
13918 \begin_layout Description
13919 \begin_inset Flex Code
13922 \begin_layout Plain Layout
13928 is a special case for the caption-labels
13929 \begin_inset Quotes eld
13933 \begin_inset Quotes erd
13937 \begin_inset Quotes eld
13941 \begin_inset Quotes erd
13945 \begin_inset Newline newline
13949 \begin_inset Flex Code
13952 \begin_layout Plain Layout
13958 means the (hardcoded) label string depends on the kind of float: It is
13959 hardcoded to be `FloatType N', where N is the value of the counter associated
13961 For the case that a caption is inserted outside of a float the
13962 \begin_inset Flex Code
13965 \begin_layout Plain Layout
13972 \begin_inset Quotes eld
13976 \begin_inset Quotes erd
13982 \begin_layout Description
13983 \begin_inset Flex Code
13986 \begin_layout Plain Layout
13992 produces the usual sort of enumeration labels.
13993 The number type needs to be set in the
13998 \begin_inset CommandInset ref
14000 reference "subsec:Counters"
14007 \begin_layout Description
14008 \begin_inset Flex Code
14011 \begin_layout Plain Layout
14017 produces various bullets at the different levels.
14018 The bullet types displayed can be set via
14019 \begin_inset Flex Noun
14022 \begin_layout Plain Layout
14023 Document\SpecialChar menuseparator
14024 Settings\SpecialChar menuseparator
14033 \begin_layout Description
14034 \begin_inset Flex Code
14037 \begin_layout Plain Layout
14043 should be used only with
14044 \begin_inset Flex Code
14047 \begin_layout Plain Layout
14048 LatexType BibEnvironment
14057 \begin_layout Description
14058 \begin_inset Flex Code
14061 \begin_layout Plain Layout
14067 Note that this will completely override any prior
14068 \begin_inset Flex Code
14071 \begin_layout Plain Layout
14077 declaration for this style.
14079 \begin_inset Quotes eld
14083 \begin_inset Flex Code
14086 \begin_layout Plain Layout
14093 \begin_inset Quotes erd
14098 \begin_inset CommandInset ref
14100 reference "subsec:I18n"
14104 for details on its use.
14107 \begin_layout Description
14108 \begin_inset Flex Code
14111 \begin_layout Plain Layout
14118 \begin_inset Flex Code
14121 \begin_layout Plain Layout
14127 ] The name of the corresponding \SpecialChar LaTeX
14129 Either the environment or command name.
14132 \begin_layout Description
14133 \begin_inset Flex Code
14136 \begin_layout Plain Layout
14143 \begin_inset Flex Code
14146 \begin_layout Plain Layout
14152 ] An optional parameter for the corresponding
14153 \begin_inset Flex Code
14156 \begin_layout Plain Layout
14163 This parameter cannot be changed from within \SpecialChar LyX
14165 \begin_inset Flex Code
14168 \begin_layout Plain Layout
14174 for customizable parameters).
14175 This will be output as is after all \SpecialChar LaTeX
14177 \begin_inset Flex Code
14180 \begin_layout Plain Layout
14189 \begin_layout Description
14190 \begin_inset Flex Code
14193 \begin_layout Plain Layout
14200 \begin_inset Flex Code
14203 \begin_layout Plain Layout
14208 , Command, Environment, Item_Environment,
14209 \begin_inset Newline newline
14212 List_Environment, Bib_Environment
14217 ] How the style should be translated into \SpecialChar LaTeX
14222 \begin_layout Plain Layout
14223 \begin_inset Flex Code
14226 \begin_layout Plain Layout
14232 is perhaps a bit misleading, since these rules apply to SGML classes, too.
14233 Visit the SGML class files for specific examples.
14242 \begin_layout Description
14243 \begin_inset Flex Code
14246 \begin_layout Plain Layout
14252 means nothing special.
14255 \begin_layout Description
14256 \begin_inset Flex Code
14259 \begin_layout Plain Layout
14266 \begin_inset Flex Code
14269 \begin_layout Plain Layout
14276 {\SpecialChar ldots
14285 \begin_layout Description
14286 \begin_inset Flex Code
14289 \begin_layout Plain Layout
14296 \begin_inset Flex Code
14299 \begin_layout Plain Layout
14306 }\SpecialChar ldots
14322 \begin_layout Description
14323 \begin_inset Flex Code
14326 \begin_layout Plain Layout
14333 \begin_inset Flex Code
14336 \begin_layout Plain Layout
14343 \begin_inset Flex Code
14346 \begin_layout Plain Layout
14354 is generated for each paragraph of this environment.
14358 \begin_layout Description
14359 \begin_inset Flex Code
14362 \begin_layout Plain Layout
14369 \begin_inset Flex Code
14372 \begin_layout Plain Layout
14379 \begin_inset Newline newline
14383 \begin_inset Flex Code
14386 \begin_layout Plain Layout
14392 is passed as an argument to the environment.
14393 \begin_inset Newline newline
14397 \begin_inset Flex Code
14400 \begin_layout Plain Layout
14406 can be defined in the
14407 \begin_inset Flex Noun
14410 \begin_layout Plain Layout
14411 Edit\SpecialChar menuseparator
14413 \begin_inset space ~
14424 \begin_layout Description
14425 \begin_inset Flex Code
14428 \begin_layout Plain Layout
14435 \begin_inset Flex Code
14438 \begin_layout Plain Layout
14444 but adds the necessary mandatory argument (the longest label) to the begin
14445 statement of the bibliography environment:
14446 \begin_inset Newline newline
14450 \begin_inset Flex Code
14453 \begin_layout Plain Layout
14456 begin{thebibliography}{99}
14462 It is therefore only useful for bibliography environments.
14463 The default longest label
14464 \begin_inset Quotes eld
14468 \begin_inset Quotes erd
14471 can be changed by the user in the paragraph settings of a bibliography
14475 \begin_layout Standard
14476 Putting the last few things together, the \SpecialChar LaTeX
14477 output will be either:
14480 \begin_layout LyX-Code
14483 LatexName[LatexParam]{\SpecialChar ldots
14487 \begin_layout Standard
14491 \begin_layout LyX-Code
14494 begin{LatexName}[LatexParam] \SpecialChar ldots
14500 \begin_layout Standard
14501 depending upon the \SpecialChar LaTeX
14506 \begin_layout Description
14507 \begin_inset Flex Code
14510 \begin_layout Plain Layout
14517 \begin_inset Flex Code
14520 \begin_layout Plain Layout
14526 ] A string that is put at the beginning of the style content.
14527 A line break in the output can be indicated by
14528 \begin_inset Flex Code
14531 \begin_layout Plain Layout
14540 \begin_layout Description
14541 \begin_inset Flex Code
14544 \begin_layout Plain Layout
14551 \begin_inset Flex Code
14554 \begin_layout Plain Layout
14560 ] If you put styles into environments, the different
14561 \begin_inset Flex Code
14564 \begin_layout Plain Layout
14570 are not simply added, but added with a factor
14571 \begin_inset Formula $\frac{4}{\mathrm{depth}+4}$
14575 Note that this parameter is also used when
14576 \begin_inset Flex Code
14579 \begin_layout Plain Layout
14586 \begin_inset Flex Code
14589 \begin_layout Plain Layout
14596 \begin_inset Flex Code
14599 \begin_layout Plain Layout
14606 Then it is added to the manual or dynamic margin.
14607 \begin_inset Newline newline
14611 \begin_inset Quotes eld
14615 \begin_inset Flex Code
14618 \begin_layout Plain Layout
14625 \begin_inset Quotes erd
14628 means that the paragraph is indented with the width of
14629 \begin_inset Quotes eld
14633 \begin_inset Flex Code
14636 \begin_layout Plain Layout
14643 \begin_inset Quotes erd
14646 in the normal font.
14647 You can get a negative width by prefixing the string with
14648 \begin_inset Quotes eld
14652 \begin_inset Flex Code
14655 \begin_layout Plain Layout
14662 \begin_inset Quotes erd
14666 This way was chosen so that the look is the same with each used screen
14670 \begin_layout Description
14671 \begin_inset Flex Code
14674 \begin_layout Plain Layout
14681 \begin_inset Flex Code
14684 \begin_layout Plain Layout
14689 , Manual, Dynamic, First_Dynamic, Right_Address_Box
14695 \begin_inset Newline newline
14698 The kind of margin that the style has on the left side.
14702 \begin_layout Description
14703 \begin_inset Flex Code
14706 \begin_layout Plain Layout
14712 just means a fixed margin.
14715 \begin_layout Description
14716 \begin_inset Flex Code
14719 \begin_layout Plain Layout
14725 means that the left margin depends on the string entered in the
14726 \begin_inset Flex Noun
14729 \begin_layout Plain Layout
14730 Edit\SpecialChar menuseparator
14732 \begin_inset space ~
14741 This is used to typeset nice lists without tabulators.
14744 \begin_layout Description
14745 \begin_inset Flex Code
14748 \begin_layout Plain Layout
14754 means that the margin depends on the size of the label.
14755 This is used for automatic enumerated headlines.
14756 It is obvious that the headline
14757 \begin_inset Quotes eld
14760 5.4.3.2.1 Very long headline
14761 \begin_inset Quotes erd
14764 must have a wider left margin (as wide as
14765 \begin_inset Quotes eld
14769 \begin_inset Quotes erd
14772 plus the space) than
14773 \begin_inset Quotes eld
14776 3.2 Very long headline
14777 \begin_inset Quotes erd
14781 \begin_inset Quotes eld
14785 \begin_inset Quotes erd
14788 are not able to do this.
14791 \begin_layout Description
14792 \begin_inset Flex Code
14795 \begin_layout Plain Layout
14801 is similar, but only the very first row of the paragraph is dynamic, while
14802 the others are static; this is used, for example, for descriptions.
14805 \begin_layout Description
14806 \begin_inset Flex Code
14809 \begin_layout Plain Layout
14815 means the margin is chosen in a way that the longest row of this paragraph
14816 fits to the right margin.
14817 This is used to typeset an address on the right edge of the page.
14821 \begin_layout Description
14822 \begin_inset Flex Code
14825 \begin_layout Plain Layout
14832 \begin_inset Flex Code
14835 \begin_layout Plain Layout
14844 \begin_inset space \thinspace{}
14848 \begin_inset Flex Code
14851 \begin_layout Plain Layout
14857 ] Whether fragile commands in this style should be
14858 \begin_inset Flex Code
14861 \begin_layout Plain Layout
14874 whether this command should itself be protected.)
14875 \change_inserted -712698321 1523696949
14879 \begin_layout Description
14881 \change_inserted -712698321 1523696969
14882 \begin_inset Flex Code
14885 \begin_layout Plain Layout
14887 \change_inserted -712698321 1523696950
14894 \begin_inset Flex Code
14897 \begin_layout Plain Layout
14899 \change_inserted -712698321 1523696950
14908 \begin_inset space \thinspace{}
14912 \begin_inset Flex Code
14915 \begin_layout Plain Layout
14917 \change_inserted -712698321 1523696950
14923 ] This causes macros that contain this layout to be protected with
14924 \begin_inset Flex Code
14927 \begin_layout Plain Layout
14929 \change_inserted -712698321 1523696950
14942 ) if necessary and thus allows (some) verbatim stuff in macros.
14947 \begin_layout Description
14948 \begin_inset Flex Code
14951 \begin_layout Plain Layout
14958 \begin_inset Flex Code
14961 \begin_layout Plain Layout
14968 \begin_inset space \thinspace{}
14972 \begin_inset Flex Code
14975 \begin_layout Plain Layout
14983 ] Whether newlines are translated into \SpecialChar LaTeX
14985 \begin_inset Flex Code
14988 \begin_layout Plain Layout
14999 The translation can be switched off to allow more comfortable \SpecialChar LaTeX
15001 inside \SpecialChar LyX
15005 \begin_layout Description
15006 \begin_inset Flex Code
15009 \begin_layout Plain Layout
15016 \begin_inset Flex Code
15019 \begin_layout Plain Layout
15028 \begin_inset space \thinspace{}
15032 \begin_inset Flex Code
15035 \begin_layout Plain Layout
15041 ] If set to true, and if
15042 \begin_inset Flex Code
15045 \begin_layout Plain Layout
15052 \begin_inset Flex Code
15055 \begin_layout Plain Layout
15061 ) paragraphs are being indented, then the indentation of such a paragraph
15062 following one of this type will be suppressed.
15063 (So this will not affect the display of non-default paragraphs.)
15066 \begin_layout Description
15067 \begin_inset Flex Code
15070 \begin_layout Plain Layout
15077 \begin_inset Flex Code
15080 \begin_layout Plain Layout
15086 ] Name of a style that has replaced this style.
15087 This is used to rename a style, while keeping backward compatibility.
15090 \begin_layout Description
15091 \begin_inset Flex Code
15094 \begin_layout Plain Layout
15101 \begin_inset Flex Code
15104 \begin_layout Plain Layout
15111 \begin_inset space \thinspace{}
15115 \begin_inset Flex Code
15118 \begin_layout Plain Layout
15124 ] Determines whether consecutive paragraphs of the same type are treated
15125 as belonging together.
15126 This has the effect that the
15127 \begin_inset Flex Code
15130 \begin_layout Plain Layout
15136 is only printed once before such a group.
15137 By default, this is true for
15138 \begin_inset Flex Code
15141 \begin_layout Plain Layout
15148 \begin_inset Flex Code
15151 \begin_layout Plain Layout
15158 \begin_inset Flex Code
15161 \begin_layout Plain Layout
15167 and false for all other types.
15170 \begin_layout Description
15171 \begin_inset Flex Code
15174 \begin_layout Plain Layout
15181 \begin_inset Flex Code
15184 \begin_layout Plain Layout
15193 \begin_inset space \thinspace{}
15197 \begin_inset Flex Code
15200 \begin_layout Plain Layout
15206 ] Indicates that paragraphs will not be separated by an empty line in \SpecialChar LaTeX
15208 but only by a line break; together with
15209 \begin_inset Flex Code
15212 \begin_layout Plain Layout
15218 , this allows to emulate a plain text editor (like the ERT inset).
15221 \begin_layout Description
15222 \begin_inset Flex Code
15225 \begin_layout Plain Layout
15232 \begin_inset Flex Code
15235 \begin_layout Plain Layout
15241 ] The indent of the very first line of a paragraph.
15243 \begin_inset Newline newline
15247 \begin_inset Flex Code
15250 \begin_layout Plain Layout
15256 will be fixed for a certain style.
15257 The exception is the default style, since the indentation for these paragraphs
15258 can be prohibited with
15259 \begin_inset Flex Code
15262 \begin_layout Plain Layout
15270 \begin_inset Flex Code
15273 \begin_layout Plain Layout
15279 style paragraphs inside environments use the
15280 \begin_inset Flex Code
15283 \begin_layout Plain Layout
15289 of the environment, not their native one.
15291 \begin_inset Flex Code
15294 \begin_layout Plain Layout
15300 paragraphs inside an enumeration are not indented.
15303 \begin_layout Description
15304 \begin_inset Flex Code
15307 \begin_layout Plain Layout
15314 \begin_inset Flex Code
15317 \begin_layout Plain Layout
15323 ] The vertical space between two paragraphs of this style.
15326 \begin_layout Description
15327 \begin_inset Flex Code
15330 \begin_layout Plain Layout
15337 \begin_inset Flex Code
15340 \begin_layout Plain Layout
15347 allows the user to choose either
15348 \begin_inset Quotes eld
15352 \begin_inset Quotes erd
15356 \begin_inset Quotes eld
15360 \begin_inset Quotes erd
15363 to separate paragraphs.
15365 \begin_inset Quotes eld
15369 \begin_inset Quotes erd
15373 \begin_inset Flex Code
15376 \begin_layout Plain Layout
15384 \begin_inset Quotes eld
15388 \begin_inset Quotes erd
15392 \begin_inset Flex Code
15395 \begin_layout Plain Layout
15401 is ignored and all paragraphs are separated by the
15402 \begin_inset Flex Code
15405 \begin_layout Plain Layout
15412 The vertical space is calculated with
15413 \begin_inset Flex Code
15416 \begin_layout Plain Layout
15418 \begin_inset space ~
15427 \begin_inset Flex Code
15430 \begin_layout Plain Layout
15436 is the height of a row with the normal font.
15437 This way, the look stays the same with different screen fonts.
15440 \begin_layout Description
15441 \begin_inset Flex Code
15444 \begin_layout Plain Layout
15451 \begin_inset Flex Code
15454 \begin_layout Plain Layout
15463 \begin_inset space \thinspace{}
15467 \begin_inset Flex Code
15470 \begin_layout Plain Layout
15476 ] Whether the contents of this paragraph should be output in raw form, meaning
15477 without special translations that \SpecialChar LaTeX
15481 \begin_layout Description
15482 \begin_inset Flex Code
15485 \begin_layout Plain Layout
15492 \begin_inset Flex Code
15495 \begin_layout Plain Layout
15505 Defines individual characters that should be output in raw form, meaning
15506 without special translations that \SpecialChar LaTeX
15510 \begin_layout Description
15511 \begin_inset Flex Code
15514 \begin_layout Plain Layout
15520 Information to be included in the \SpecialChar LaTeX
15521 preamble when this style is used.
15522 Used to define macros, load packages, etc., required by this particular
15525 \begin_inset Quotes eld
15529 \begin_inset Flex Code
15532 \begin_layout Plain Layout
15539 \begin_inset Quotes erd
15545 \begin_layout Description
15546 \begin_inset Flex Code
15549 \begin_layout Plain Layout
15556 \begin_inset Flex Code
15559 \begin_layout Plain Layout
15565 ] The prefix to use when creating labels referring to paragraphs of this
15567 This allows the use of formatted references.
15570 \begin_layout Description
15571 \begin_inset Flex Code
15574 \begin_layout Plain Layout
15581 \begin_inset Flex Code
15584 \begin_layout Plain Layout
15590 ] Whether the style requires the feature
15591 \begin_inset Flex Code
15594 \begin_layout Plain Layout
15601 \begin_inset CommandInset ref
15603 reference "chap:List-of-functions"
15607 for the list of features).
15608 If you require a package with specific options, you can additionally use
15610 \begin_inset Flex Code
15613 \begin_layout Plain Layout
15619 as a general text class parameter (see
15620 \begin_inset CommandInset ref
15622 reference "subsec:General-text-class"
15629 \begin_layout Description
15630 \begin_inset Flex Code
15633 \begin_layout Plain Layout
15640 \begin_inset Flex Code
15643 \begin_layout Plain Layout
15652 \begin_inset Flex Code
15655 \begin_layout Plain Layout
15661 ] Resets the \SpecialChar LaTeX
15662 arguments of this style (as defined via the
15663 \begin_inset Flex Code
15666 \begin_layout Plain Layout
15673 This is useful if you have copied a style via
15674 \begin_inset Flex Code
15677 \begin_layout Plain Layout
15683 , but you do not want to inherit its (required and optional) arguments.
15686 \begin_layout Description
15687 \begin_inset Flex Code
15690 \begin_layout Plain Layout
15697 \begin_inset Flex Code
15700 \begin_layout Plain Layout
15709 \begin_inset Flex Code
15712 \begin_layout Plain Layout
15718 ] Resumes a counter that is usually reset at each new sequence of layouts.
15719 This is currently only useful when
15720 \begin_inset Flex Code
15723 \begin_layout Plain Layout
15730 \begin_inset Flex Code
15733 \begin_layout Plain Layout
15742 \begin_layout Description
15743 \begin_inset Flex Code
15746 \begin_layout Plain Layout
15753 \begin_inset Flex Code
15756 \begin_layout Plain Layout
15762 ] A string that is put at the end of the layout content.
15763 A line break in the output can be indicated by
15764 \begin_inset Flex Code
15767 \begin_layout Plain Layout
15776 \begin_layout Description
15777 \begin_inset Flex Code
15780 \begin_layout Plain Layout
15787 \begin_inset Flex Code
15790 \begin_layout Plain Layout
15797 \begin_inset Flex Code
15800 \begin_layout Plain Layout
15809 \begin_layout Description
15810 \begin_inset Flex Code
15813 \begin_layout Plain Layout
15820 \begin_inset Flex Code
15823 \begin_layout Plain Layout
15832 \begin_inset Flex Code
15835 \begin_layout Plain Layout
15842 \begin_inset Flex Code
15845 \begin_layout Plain Layout
15852 \begin_inset Flex Code
15855 \begin_layout Plain Layout
15857 \begin_inset space ~
15865 ] This defines what the default spacing should be in the style.
15867 \begin_inset Flex Code
15870 \begin_layout Plain Layout
15877 \begin_inset Flex Code
15880 \begin_layout Plain Layout
15887 \begin_inset Flex Code
15890 \begin_layout Plain Layout
15896 correspond respectively to a multiplier value of 1, 1.25 and 1.667.
15897 If you specify the argument
15898 \begin_inset Flex Code
15901 \begin_layout Plain Layout
15907 , then you must also provide a value argument which will be the actual multiplie
15909 Note that, contrary to other parameters,
15910 \begin_inset Flex Code
15913 \begin_layout Plain Layout
15919 implies the generation of specific \SpecialChar LaTeX
15920 code, using the \SpecialChar LaTeX
15924 \begin_inset Flex Code
15927 \begin_layout Plain Layout
15936 \begin_layout Description
15937 \begin_inset Flex Code
15940 \begin_layout Plain Layout
15947 \begin_inset Flex Code
15950 \begin_layout Plain Layout
15957 \begin_inset space \thinspace{}
15961 \begin_inset Flex Code
15964 \begin_layout Plain Layout
15972 ] Allow spell-checking paragraphs of this style.
15976 \begin_layout Description
15977 \begin_inset Flex Code
15980 \begin_layout Plain Layout
15987 \begin_inset Flex Code
15990 \begin_layout Plain Layout
15999 \begin_inset Flex Code
16002 \begin_layout Plain Layout
16008 ] Steps the master counter of a given counter at the beginning of a new
16009 sequence of layouts.
16010 This is currently only useful when
16011 \begin_inset Flex Code
16014 \begin_layout Plain Layout
16021 \begin_inset Flex Code
16024 \begin_layout Plain Layout
16033 \begin_layout Description
16034 \begin_inset Flex Code
16037 \begin_layout Plain Layout
16043 The font used for the text body .
16045 \begin_inset CommandInset ref
16047 reference "subsec:Font-description"
16054 \begin_layout Description
16055 \begin_inset Flex Code
16058 \begin_layout Plain Layout
16067 \begin_inset Flex Code
16070 \begin_layout Plain Layout
16080 The level of the style in the table of contents.
16081 This is used for automatic numbering of section headings.
16084 \begin_layout Description
16085 \begin_inset Flex Code
16088 \begin_layout Plain Layout
16097 \begin_inset Flex Code
16100 \begin_layout Plain Layout
16111 \begin_inset Flex Code
16114 \begin_layout Plain Layout
16121 \begin_inset Flex Code
16124 \begin_layout Plain Layout
16130 ] This tag determines whether the first line indentation of this paragraph
16131 can be toggled via the Paragraph settings dialog.
16135 \begin_inset Flex Code
16138 \begin_layout Plain Layout
16148 is set, indentation can be toggled if the document settings use
16149 \begin_inset Quotes eld
16153 \begin_inset Quotes erd
16156 paragraph style, with
16157 \begin_inset Flex Code
16160 \begin_layout Plain Layout
16166 , indentation can always be toggled, notwithstanding the document settings,
16168 \begin_inset Flex Code
16171 \begin_layout Plain Layout
16177 , indentation can never be toggled.
16180 \begin_layout Description
16181 \begin_inset Flex Code
16184 \begin_layout Plain Layout
16191 \begin_inset Flex Code
16194 \begin_layout Plain Layout
16200 ] The vertical space with which the very first of a chain of paragraphs
16201 with this style is separated from the previous paragraph.
16202 If the previous paragraph has another style, the separations are not simply
16203 added, but the maximum is taken.
16206 \begin_layout Subsection
16207 \begin_inset CommandInset label
16213 Internationalization of Paragraph Styles
16216 \begin_layout Standard
16218 has long supported internationalization of layout information, but, until
16219 version 2.0, this applied only to the user interface and not to, say, PDF
16221 Thus, French authors were forced to resort to ugly hacks if they wanted
16226 1' instead of `Theorem 1'.
16227 Thanks to Georg Baum, that is no longer the case.
16230 \begin_layout Standard
16232 \begin_inset Flex Code
16235 \begin_layout Plain Layout
16241 defines text that is to appear in the typeset document, it may use
16242 \begin_inset Flex Code
16245 \begin_layout Plain Layout
16252 \begin_inset Flex Code
16255 \begin_layout Plain Layout
16261 to support non-English and even multi-language documents correctly.
16262 The following excerpt (from the
16263 \begin_inset Flex Code
16266 \begin_layout Plain Layout
16272 file) shows how this works:
16275 \begin_layout LyX-Code
16280 \begin_layout LyX-Code
16283 theoremstyle{remark}
16286 \begin_layout LyX-Code
16289 newtheorem{claim}[thm]{
16296 \begin_layout LyX-Code
16300 \begin_layout LyX-Code
16304 \begin_layout LyX-Code
16309 claimname}{_(Claim)}
16312 \begin_layout LyX-Code
16316 \begin_layout LyX-Code
16320 \begin_layout LyX-Code
16329 claimname}{_(Claim)}}
16332 \begin_layout LyX-Code
16337 \begin_layout Standard
16338 In principle, any legal \SpecialChar LaTeX
16340 \begin_inset Flex Code
16343 \begin_layout Plain Layout
16350 \begin_inset Flex Code
16353 \begin_layout Plain Layout
16359 tags, but in practice they will typically look as they do here.
16360 The key to correct translation of the typeset text is the definition of
16361 the \SpecialChar LaTeX
16363 \begin_inset Flex Code
16366 \begin_layout Plain Layout
16375 \begin_inset Flex Code
16378 \begin_layout Plain Layout
16390 \begin_layout Standard
16392 \begin_inset Flex Code
16395 \begin_layout Plain Layout
16401 tag provides for internationalization based upon the overall language of
16403 The contents of the tag will be included in the preamble, just as with
16405 \begin_inset Flex Code
16408 \begin_layout Plain Layout
16415 What makes it special is the use of the
16416 \begin_inset Quotes eld
16420 \begin_inset Quotes erd
16424 \begin_inset Flex Code
16427 \begin_layout Plain Layout
16433 , which will be replaced, when \SpecialChar LyX
16434 produces \SpecialChar LaTeX
16435 output, with the translation of
16436 its argument into the document language.
16439 \begin_layout Standard
16441 \begin_inset Flex Code
16444 \begin_layout Plain Layout
16450 tag is more complex, since it is meant to provide support for multi-language
16451 documents and so offers an interface to the
16452 \begin_inset Flex Code
16455 \begin_layout Plain Layout
16462 Its contents will be added to the preamble once for each language that
16463 appears in the document.
16464 In this case, the argument to
16465 \begin_inset Flex Code
16468 \begin_layout Plain Layout
16474 will be replaced with its translation into the language in question; the
16476 \begin_inset Flex Code
16479 \begin_layout Plain Layout
16485 is replaced by the language name (as used by the babel package).
16488 \begin_layout Standard
16489 A German document that also included a French section would thus have the
16490 following in the preamble:
16493 \begin_layout LyX-Code
16502 claimname}{Affirmation}}
16503 \begin_inset Newline newline
16514 claimname}{Behauptung}}
16515 \begin_inset Newline newline
16522 claimname}{Behauptung}
16525 \begin_layout Standard
16528 \begin_inset Flex Code
16531 \begin_layout Plain Layout
16537 will then conspire to produce the correct text in the output.
16540 \begin_layout Standard
16541 One important point to note here is that the translations are provided by
16543 itself, through the file
16544 \begin_inset Flex Code
16547 \begin_layout Plain Layout
16554 This means, in effect, that
16555 \begin_inset Flex Code
16558 \begin_layout Plain Layout
16565 \begin_inset Flex Code
16568 \begin_layout Plain Layout
16574 are really only of use in layout files that are provided with \SpecialChar LyX
16576 entered in user-created layout files will not be seen by \SpecialChar LyX
16577 's internationalizatio
16578 n routines unless the
16579 \begin_inset Flex Code
16582 \begin_layout Plain Layout
16588 file is modified accordingly.
16589 That said, however, any layout created with the intention that it will
16590 be included with \SpecialChar LyX
16591 should use these tags where appropriate.
16592 Please note that the paragraph style translations provided by \SpecialChar LyX
16594 change with a minor update (e.
16595 \begin_inset space \thinspace{}
16599 \begin_inset space \space{}
16602 from version 2.1.x to 2.1.y).
16603 It is however quite likely that a major update (e.
16604 \begin_inset space \thinspace{}
16608 \begin_inset space \space{}
16611 from 2.0.x to 2.1.0) will introduce new translations or corrections.
16614 \begin_layout Subsection
16616 \begin_inset CommandInset label
16618 name "subsec:Floats"
16625 \begin_layout Standard
16626 It is necessary to define the floats (
16627 \begin_inset Flex Noun
16630 \begin_layout Plain Layout
16637 \begin_inset Flex Noun
16640 \begin_layout Plain Layout
16646 , \SpecialChar ldots
16647 ) in the text class itself.
16648 Standard floats are included in the file
16649 \begin_inset Flex Code
16652 \begin_layout Plain Layout
16658 , so you may have to do no more than add
16661 \begin_layout LyX-Code
16662 Input stdfloats.inc
16665 \begin_layout Standard
16666 to your layout file.
16667 If you want to implement a text class that proposes some other float types
16668 (like the AGU class bundled with \SpecialChar LyX
16669 ), the information below will hopefully
16673 \begin_layout Description
16674 \begin_inset Flex Code
16677 \begin_layout Plain Layout
16684 \begin_inset Flex Code
16687 \begin_layout Plain Layout
16693 =!htbpH] Allowed placement options for this float type.
16694 The value is a string of placement characters.
16695 Possible characters include:
16700 \begin_inset Quotes eld
16704 \begin_inset Quotes erd
16712 \begin_inset Quotes eld
16716 \begin_inset Quotes erd
16724 \begin_inset Quotes eld
16728 \begin_inset Quotes erd
16736 \begin_inset Quotes eld
16740 \begin_inset Quotes erd
16748 \begin_inset Quotes eld
16752 \begin_inset Quotes erd
16760 \begin_inset Quotes eld
16764 \begin_inset Quotes erd
16768 The order of the characters in the string does not matter.
16769 If no placement options are allowed, use the string
16776 \begin_layout Description
16777 \begin_inset Flex Code
16780 \begin_layout Plain Layout
16787 \begin_inset Flex Code
16790 \begin_layout Plain Layout
16799 \begin_inset space \thinspace{}
16805 \begin_inset Flex Code
16808 \begin_layout Plain Layout
16818 ] Defines whether the float allows to be rotated via the \SpecialChar LaTeX
16825 \begin_inset Flex Code
16828 \begin_layout Plain Layout
16834 if the float does not support this feature.
16837 \begin_layout Description
16838 \begin_inset Flex Code
16841 \begin_layout Plain Layout
16848 \begin_inset Flex Code
16851 \begin_layout Plain Layout
16860 \begin_inset space \thinspace{}
16866 \begin_inset Flex Code
16869 \begin_layout Plain Layout
16879 ] Defines whether the float has a starred variant that spans columns in
16880 a two column paragraph.
16882 \begin_inset Flex Code
16885 \begin_layout Plain Layout
16891 if the float does not support this feature.
16894 \begin_layout Description
16895 \begin_inset Flex Code
16898 \begin_layout Plain Layout
16905 \begin_inset Flex Code
16908 \begin_layout Plain Layout
16915 \begin_inset Quotes erd
16919 \begin_inset Quotes erd
16922 ] The file name extension of an auxiliary file for the list of figures (or
16925 writes the captions to this file.
16928 \begin_layout Description
16929 \begin_inset Flex Code
16932 \begin_layout Plain Layout
16939 \begin_inset Flex Code
16942 \begin_layout Plain Layout
16949 \begin_inset Quotes erd
16953 \begin_inset Quotes erd
16956 ] The string that will be used in the menus and also for the caption.
16957 This is translated to the current language if babel is used.
16960 \begin_layout Description
16961 \begin_inset Flex Code
16964 \begin_layout Plain Layout
16970 These tags control the XHTML output.
16972 \begin_inset CommandInset ref
16974 reference "sec:Tags-for-XHTML"
16981 \begin_layout Description
16982 \begin_inset Flex Code
16985 \begin_layout Plain Layout
16994 \begin_inset Flex Code
16997 \begin_layout Plain Layout
17006 \begin_inset space \thinspace{}
17010 \begin_inset Flex Code
17013 \begin_layout Plain Layout
17019 ] Indicates whether the float is already defined in the document class or
17020 if instead the \SpecialChar LaTeX
17022 \begin_inset Flex Code
17025 \begin_layout Plain Layout
17031 needs to be loaded to define it on-the-fly.
17033 \begin_inset Flex Code
17036 \begin_layout Plain Layout
17043 \begin_inset Flex Code
17046 \begin_layout Plain Layout
17053 It should be set to
17054 \begin_inset Flex Code
17057 \begin_layout Plain Layout
17063 if the float is already defined by the \SpecialChar LaTeX
17067 \begin_layout Description
17068 \begin_inset Flex Code
17071 \begin_layout Plain Layout
17078 \begin_inset Flex Code
17081 \begin_layout Plain Layout
17088 \begin_inset Quotes erd
17092 \begin_inset Quotes erd
17095 ] The command used to generate a list of floats of this type; the leading
17104 \begin_inset Flex Code
17107 \begin_layout Plain Layout
17113 is false, since there is no standard way to generate this command.
17115 \begin_inset Flex Code
17118 \begin_layout Plain Layout
17124 is true, since in that case there is a standard way to define the command.
17127 \begin_layout Description
17128 \begin_inset Flex Code
17131 \begin_layout Plain Layout
17138 \begin_inset Flex Code
17141 \begin_layout Plain Layout
17148 \begin_inset Quotes erd
17152 \begin_inset Quotes erd
17155 ] A title for a list of floats of this kind (list of figures, tables, or
17157 It is used for the screen label within \SpecialChar LyX
17158 , it is used by \SpecialChar LaTeX
17160 it is used as the title in the XHTML output.
17161 It will be translated to the document language.
17164 \begin_layout Description
17165 \begin_inset Flex Code
17168 \begin_layout Plain Layout
17175 \begin_inset Flex Code
17178 \begin_layout Plain Layout
17185 \begin_inset Quotes erd
17189 \begin_inset Quotes erd
17192 ] This (optional) argument determines whether floats of this class will
17193 be numbered within some sectional unit of the document.
17195 \begin_inset Flex Code
17198 \begin_layout Plain Layout
17205 \begin_inset Quotes eld
17209 \begin_inset Flex Code
17212 \begin_layout Plain Layout
17219 \begin_inset Quotes erd
17222 , the floats will be numbered within chapters.
17226 \begin_layout Description
17227 \begin_inset Flex Code
17230 \begin_layout Plain Layout
17237 \begin_inset Flex Code
17240 \begin_layout Plain Layout
17247 \begin_inset Quotes erd
17251 \begin_inset Quotes erd
17254 ] The default placement for the given class of floats.
17255 The string should be as in standard \SpecialChar LaTeX
17257 \begin_inset Flex Code
17260 \begin_layout Plain Layout
17267 \begin_inset Flex Code
17270 \begin_layout Plain Layout
17277 \begin_inset Flex Code
17280 \begin_layout Plain Layout
17287 \begin_inset Flex Code
17290 \begin_layout Plain Layout
17296 for top, bottom, page, and here, respectively.
17300 \begin_layout Plain Layout
17301 Note that the order of these letters in the string is irrelevant, like in
17308 On top of that there is a new type,
17309 \begin_inset Flex Code
17312 \begin_layout Plain Layout
17318 , which does not really correspond to a float, since it means: put it
17319 \begin_inset Quotes eld
17323 \begin_inset Quotes erd
17327 Note however that the
17328 \begin_inset Flex Code
17331 \begin_layout Plain Layout
17337 specifier is special and, because of implementation details, cannot be
17338 used in non-built in float types.
17339 If you do not understand what this means, just use
17340 \begin_inset Quotes eld
17344 \begin_inset Flex Code
17347 \begin_layout Plain Layout
17354 \begin_inset Quotes erd
17360 \begin_layout Description
17361 \begin_inset Flex Code
17364 \begin_layout Plain Layout
17371 \begin_inset Flex Code
17374 \begin_layout Plain Layout
17380 ] The prefix to use when creating labels referring to floats of this type.
17381 This allows the use of formatted references.
17382 Note that you can remove any
17383 \begin_inset Flex Code
17386 \begin_layout Plain Layout
17392 set by a copied style by using the special value
17393 \begin_inset Quotes eld
17397 \begin_inset Quotes erd
17400 , which must be all caps.
17403 \begin_layout Description
17404 \begin_inset Flex Code
17407 \begin_layout Plain Layout
17414 \begin_inset Flex Code
17417 \begin_layout Plain Layout
17424 \begin_inset Quotes erd
17428 \begin_inset Quotes erd
17431 ] The style used when defining the float using
17432 \begin_inset Flex Code
17435 \begin_layout Plain Layout
17446 \begin_layout Description
17447 \begin_inset Flex Code
17450 \begin_layout Plain Layout
17457 \begin_inset Flex Code
17460 \begin_layout Plain Layout
17467 \begin_inset Quotes erd
17471 \begin_inset Quotes erd
17475 \begin_inset Quotes eld
17479 \begin_inset Quotes erd
17482 of the new class of floats, like program or algorithm.
17483 After the appropriate
17484 \begin_inset Flex Code
17487 \begin_layout Plain Layout
17496 \begin_inset Flex Code
17499 \begin_layout Plain Layout
17508 \begin_inset Flex Code
17511 \begin_layout Plain Layout
17522 \begin_layout Description
17523 \begin_inset Flex Code
17526 \begin_layout Plain Layout
17533 \begin_inset Flex Code
17536 \begin_layout Plain Layout
17543 \begin_inset space \thinspace{}
17547 \begin_inset Flex Code
17550 \begin_layout Plain Layout
17558 ] Specifies whether this float is defined using the \SpecialChar LaTeX
17560 \begin_inset Flex Code
17563 \begin_layout Plain Layout
17569 , either by the class file, another package or on-the-fly by \SpecialChar LyX
17573 \begin_layout Standard
17574 Note that defining a float with type
17575 \begin_inset Flex Code
17578 \begin_layout Plain Layout
17586 automatically defines the corresponding counter with name
17587 \begin_inset Flex Code
17590 \begin_layout Plain Layout
17601 \begin_layout Subsection
17602 Flex insets and InsetLayout
17603 \begin_inset CommandInset label
17605 name "subsec:Flex-insets-and"
17612 \begin_layout Standard
17613 Flex insets come in three different kinds:
17616 \begin_layout Itemize
17618 \begin_inset Flex Code
17621 \begin_layout Plain Layout
17627 ): These define semantic markup corresponding to such \SpecialChar LaTeX
17629 \begin_inset Flex Code
17632 \begin_layout Plain Layout
17641 \begin_inset Flex Code
17644 \begin_layout Plain Layout
17655 \begin_layout Itemize
17657 \begin_inset Flex Code
17660 \begin_layout Plain Layout
17666 ): These can be used to define custom collapsible insets, similar to \SpecialChar TeX
17668 footnote, and the like.
17669 An obvious example is an endnote inset, which is defined in the
17670 \begin_inset Flex Code
17673 \begin_layout Plain Layout
17682 \begin_layout Itemize
17684 \begin_inset Flex Code
17687 \begin_layout Plain Layout
17693 ): For use with DocBook classes.
17696 \begin_layout Standard
17697 Flex insets are defined using the
17698 \begin_inset Flex Code
17701 \begin_layout Plain Layout
17707 tag, which shall be explained in a moment.
17710 \begin_layout Standard
17712 \begin_inset Flex Code
17715 \begin_layout Plain Layout
17721 tag also serves another function: It can be used to customize the general
17722 layout of many different types of insets.
17724 \begin_inset Flex Code
17727 \begin_layout Plain Layout
17733 can be used to customize the layout parameters for footnotes, marginal
17734 notes, note insets, \SpecialChar TeX
17735 code (ERT) insets, branches, listings, indexes, boxes,
17736 tables, algorithms, URLs, and captions, as well as to define Flex insets.
17739 \begin_layout Standard
17741 \begin_inset Flex Code
17744 \begin_layout Plain Layout
17750 definition must begin with a line of the form:
17753 \begin_layout LyX-Code
17757 \begin_layout Standard
17759 \begin_inset Flex Code
17762 \begin_layout Plain Layout
17768 indicates the inset whose layout is being defined, and here there are four
17772 \begin_layout Enumerate
17773 The layout for a pre-existing inset is being modified.
17774 In this case, can be
17775 \begin_inset Flex Code
17778 \begin_layout Plain Layout
17784 any one of the following:
17785 \begin_inset Flex Code
17788 \begin_layout Plain Layout
17795 \begin_inset Flex Code
17798 \begin_layout Plain Layout
17805 \begin_inset Flex Code
17808 \begin_layout Plain Layout
17815 \begin_inset Flex Code
17818 \begin_layout Plain Layout
17825 \begin_inset Flex Code
17828 \begin_layout Plain Layout
17835 \begin_inset Flex Code
17838 \begin_layout Plain Layout
17845 \begin_inset Flex Code
17848 \begin_layout Plain Layout
17855 \begin_inset Flex Code
17858 \begin_layout Plain Layout
17865 \begin_inset Flex Code
17868 \begin_layout Plain Layout
17875 \begin_inset Flex Code
17878 \begin_layout Plain Layout
17885 \begin_inset Flex Code
17888 \begin_layout Plain Layout
17895 \begin_inset Flex Code
17898 \begin_layout Plain Layout
17905 \begin_inset Flex Code
17908 \begin_layout Plain Layout
17915 \begin_inset Flex Code
17918 \begin_layout Plain Layout
17925 \begin_inset Flex Code
17928 \begin_layout Plain Layout
17935 \begin_inset Flex Code
17938 \begin_layout Plain Layout
17945 \begin_inset Flex Code
17948 \begin_layout Plain Layout
17955 \begin_inset Flex Code
17958 \begin_layout Plain Layout
17965 \begin_inset Flex Code
17968 \begin_layout Plain Layout
17975 \begin_inset Flex Code
17978 \begin_layout Plain Layout
17987 \begin_layout Enumerate
17988 The layout for a Flex inset is being defined.
17990 \begin_inset Flex Code
17993 \begin_layout Plain Layout
17999 must be of the form
18000 \begin_inset Quotes eld
18004 \begin_inset Flex Code
18007 \begin_layout Plain Layout
18014 \begin_inset Quotes erd
18018 \begin_inset Flex Code
18021 \begin_layout Plain Layout
18027 may be be any valid identifier not used by a pre-existing Flex inset.
18028 The identifier may include spaces, but in that case the whole thing must
18029 be wrapped in quotes.
18030 Note that the definition of a flex inset
18035 \begin_inset Flex Code
18038 \begin_layout Plain Layout
18044 entry, declaring which type of inset it defines.
18047 \begin_layout Enumerate
18048 The layout for user specific branch is being defined.
18050 \begin_inset Flex Code
18053 \begin_layout Plain Layout
18059 must be of the form
18060 \begin_inset Quotes eld
18064 \begin_inset Flex Code
18067 \begin_layout Plain Layout
18074 \begin_inset Quotes erd
18078 \begin_inset Flex Code
18081 \begin_layout Plain Layout
18087 may be be any valid identifier of branch defined in user's document.
18088 The identifier may include spaces, but in that case the whole thing must
18089 be wrapped in quotes.
18090 The main purpose of this feature is to allow \SpecialChar LaTeX
18091 wrapping around specific
18092 branches as user needs.
18095 \begin_layout Enumerate
18096 The layout of a user (or class) specific caption is being defined.
18098 \begin_inset Flex Code
18101 \begin_layout Plain Layout
18107 must be of the form
18108 \begin_inset Quotes eld
18112 \begin_inset Flex Code
18115 \begin_layout Plain Layout
18122 \begin_inset Quotes erd
18126 \begin_inset Flex Code
18129 \begin_layout Plain Layout
18135 specifies the name of the caption as it appears in the menu.
18136 Have a look at the standard caption (
18137 \begin_inset Flex Code
18140 \begin_layout Plain Layout
18146 ), the specific captions of the KOMA-Script classes (
18147 \begin_inset Flex Code
18150 \begin_layout Plain Layout
18157 \begin_inset Flex Code
18160 \begin_layout Plain Layout
18169 \begin_inset space ~
18173 \begin_inset Newline linebreak
18179 \begin_inset Flex Code
18182 \begin_layout Plain Layout
18188 ) for applications.
18191 \begin_layout Standard
18193 \begin_inset Flex Code
18196 \begin_layout Plain Layout
18202 definition can contain the following entries:
18205 \begin_layout Description
18206 \begin_inset Flex Code
18209 \begin_layout Plain Layout
18216 \begin_inset Flex Code
18219 \begin_layout Plain Layout
18225 =""] This inset will appear in the table of contents of the given type.
18226 An empty string disables.
18227 See also the OutlinerName and the IsTocCaption commands.
18228 This is only implemented for Flex insets.
18232 \begin_layout Description
18233 \begin_inset Flex Code
18236 \begin_layout Plain Layout
18243 \begin_inset Flex Code
18246 \begin_layout Plain Layout
18252 ] Defines argument number of a command\SpecialChar breakableslash
18253 environment associated with the current
18255 The definition must end with
18256 \begin_inset Flex Code
18259 \begin_layout Plain Layout
18267 \begin_inset CommandInset ref
18269 reference "subsec:Paragraph-Styles"
18276 \begin_layout Description
18277 \begin_inset Flex Code
18280 \begin_layout Plain Layout
18286 Preamble for changing language commands; see
18287 \begin_inset CommandInset ref
18289 reference "subsec:I18n"
18296 \begin_layout Description
18297 \begin_inset Flex Code
18300 \begin_layout Plain Layout
18307 \begin_inset Flex Code
18310 \begin_layout Plain Layout
18316 ] The color for the inset's background.
18318 \begin_inset CommandInset ref
18320 reference "chap:Names-of-colors"
18324 for a list of the available color names.
18327 \begin_layout Description
18328 \begin_inset Flex Code
18331 \begin_layout Plain Layout
18338 \begin_inset Flex Code
18341 \begin_layout Plain Layout
18350 \begin_inset space \thinspace{}
18354 \begin_inset Flex Code
18357 \begin_layout Plain Layout
18363 ] Whether to use the content of the inset as the label, when the inset is
18368 \begin_layout Description
18369 \begin_inset Flex Code
18372 \begin_layout Plain Layout
18379 \begin_inset Flex Code
18382 \begin_layout Plain Layout
18388 ] As with paragraph styles, see
18389 \begin_inset CommandInset ref
18391 reference "subsec:Paragraph-Styles"
18396 Note that you need to specify the complete type, e.
18397 \begin_inset space \thinspace{}
18401 \begin_inset space ~
18405 \begin_inset Flex Code
18408 \begin_layout Plain Layout
18409 CopyStyle Flex:<name>
18417 \begin_layout Description
18418 \begin_inset Flex Code
18421 \begin_layout Plain Layout
18428 \begin_inset Flex Code
18431 \begin_layout Plain Layout
18440 \begin_inset space \thinspace{}
18444 \begin_inset Flex Code
18447 \begin_layout Plain Layout
18453 ] Indicates whether the user may employ the Paragraph Settings dialog to
18454 customize the paragraph.
18457 \begin_layout Description
18458 \begin_inset Flex Code
18461 \begin_layout Plain Layout
18468 \begin_inset Flex Code
18471 \begin_layout Plain Layout
18478 \begin_inset Flex Code
18481 \begin_layout Plain Layout
18488 \begin_inset Flex Code
18491 \begin_layout Plain Layout
18497 , describing the rendering style used for the inset's frame and buttons.
18498 Footnotes generally use
18499 \begin_inset Flex Code
18502 \begin_layout Plain Layout
18508 , ERT insets generally
18509 \begin_inset Flex Code
18512 \begin_layout Plain Layout
18518 , and character styles
18519 \begin_inset Flex Code
18522 \begin_layout Plain Layout
18531 \begin_layout Description
18532 \begin_inset Flex Code
18535 \begin_layout Plain Layout
18542 \begin_inset Flex Code
18545 \begin_layout Plain Layout
18554 \begin_inset space \thinspace{}
18560 \begin_inset Flex Code
18563 \begin_layout Plain Layout
18572 \begin_inset Flex Code
18575 \begin_layout Plain Layout
18582 \begin_inset Flex Code
18585 \begin_layout Plain Layout
18592 Indicates whether the environment will stand on its own in the output or
18593 will appear inline with the surrounding text.
18594 If set to false, it is supposed that the \SpecialChar LaTeX
18595 environment ignores white space
18596 (including one newline character) after the
18597 \begin_inset Flex Code
18600 \begin_layout Plain Layout
18613 \begin_inset Flex Code
18616 \begin_layout Plain Layout
18632 \begin_layout Description
18633 \begin_inset Flex Code
18636 \begin_layout Plain Layout
18642 Required at the end of the
18643 \begin_inset Flex Code
18646 \begin_layout Plain Layout
18655 \begin_layout Description
18656 \begin_inset Flex Code
18659 \begin_layout Plain Layout
18665 The font used for both the text body
18671 \begin_inset CommandInset ref
18673 reference "subsec:Font-description"
18678 Note that defining this font automatically defines the
18679 \begin_inset Flex Code
18682 \begin_layout Plain Layout
18688 to the same value, so define this first and define
18689 \begin_inset Flex Code
18692 \begin_layout Plain Layout
18698 later if you want them to be different.
18701 \begin_layout Description
18702 \begin_inset Flex Code
18705 \begin_layout Plain Layout
18706 FixedWidthPreambleEncoding
18712 \begin_inset Flex Code
18715 \begin_layout Plain Layout
18724 \begin_inset space \thinspace{}
18728 \begin_inset Flex Code
18731 \begin_layout Plain Layout
18737 ] Force a fixed width encoding for the translated contents of
18738 \begin_inset Flex Code
18741 \begin_layout Plain Layout
18748 \begin_inset Flex Code
18751 \begin_layout Plain Layout
18757 code generated by this layout.
18758 This is needed for special \SpecialChar LaTeX
18763 that do not work with variable width encodings such as
18768 This setting is ignored if fully Unicode aware \SpecialChar LaTeX
18769 backends such as Xe\SpecialChar TeX
18771 Lua\SpecialChar TeX
18775 \begin_layout Description
18776 \begin_inset Flex Code
18779 \begin_layout Plain Layout
18780 ForceLocalFontSwitch
18786 \begin_inset Flex Code
18789 \begin_layout Plain Layout
18798 \begin_inset space \thinspace{}
18802 \begin_inset Flex Code
18805 \begin_layout Plain Layout
18811 ] When using babel, always use a local font switch (
18812 \begin_inset Flex Code
18815 \begin_layout Plain Layout
18823 ), never a global one (such as
18824 \begin_inset Flex Code
18827 \begin_layout Plain Layout
18838 \begin_layout Description
18839 \begin_inset Flex Code
18842 \begin_layout Plain Layout
18849 \begin_inset Flex Code
18852 \begin_layout Plain Layout
18861 \begin_inset space \thinspace{}
18865 \begin_inset Flex Code
18868 \begin_layout Plain Layout
18875 \begin_inset Quotes eld
18879 \begin_inset Quotes erd
18882 language, leading to Left-to-Right (Latin) output, e.
18883 \begin_inset space \thinspace{}
18887 \begin_inset space \space{}
18890 in \SpecialChar TeX
18895 \begin_layout Description
18896 \begin_inset Flex Code
18899 \begin_layout Plain Layout
18906 \begin_inset Flex Code
18909 \begin_layout Plain Layout
18918 \begin_inset space \thinspace{}
18922 \begin_inset Flex Code
18925 \begin_layout Plain Layout
18931 ] Force a a line break in the \SpecialChar LaTeX
18932 output before the inset starts and after
18934 This assures the inset itself is output on its own lines, for parsing purposes.
18937 \begin_layout Description
18938 \begin_inset Flex Code
18941 \begin_layout Plain Layout
18948 \begin_inset Flex Code
18951 \begin_layout Plain Layout
18960 \begin_inset space \thinspace{}
18964 \begin_inset Flex Code
18967 \begin_layout Plain Layout
18973 ] Indicates whether the
18974 \begin_inset Flex Code
18977 \begin_layout Plain Layout
18983 should be used or, instead, the user can change the paragraph style used
18988 \begin_layout Description
18989 \begin_inset Flex Code
18992 \begin_layout Plain Layout
18999 \begin_inset Flex Code
19002 \begin_layout Plain Layout
19011 \begin_inset space \thinspace{}
19015 \begin_inset Flex Code
19018 \begin_layout Plain Layout
19024 ] As with paragraph styles, see
19025 \begin_inset CommandInset ref
19027 reference "subsec:Paragraph-Styles"
19034 \begin_layout Description
19035 \begin_inset Flex Code
19038 \begin_layout Plain Layout
19044 These tags control the XHTML output.
19046 \begin_inset CommandInset ref
19048 reference "sec:Tags-for-XHTML"
19055 \begin_layout Description
19056 \begin_inset Flex Code
19059 \begin_layout Plain Layout
19066 \begin_inset Flex Code
19069 \begin_layout Plain Layout
19078 \begin_inset space \thinspace{}
19082 \begin_inset Flex Code
19085 \begin_layout Plain Layout
19091 ] Whether to include the contents of this inset in the strings generated
19092 for the `Outline' pane for all table of contents, regardless of the AddToToc
19094 One would not, for example, want the content of a footnote in a section
19095 header to be included in the TOC displayed in the outline, but one would
19096 normally want the content of a character style displayed.
19097 Default is false: not to include.
19100 \begin_layout Description
19101 \begin_inset Flex Code
19104 \begin_layout Plain Layout
19111 \begin_inset Flex Code
19114 \begin_layout Plain Layout
19123 \begin_inset space \thinspace{}
19127 \begin_inset Flex Code
19130 \begin_layout Plain Layout
19136 ] If this is set to 1 and AddToToc is enabled, the inset adds a summary
19137 of its contents in its item in the table of contents.
19138 Otherwise, only the label appears.
19141 \begin_layout Description
19142 \begin_inset Flex Code
19145 \begin_layout Plain Layout
19154 \begin_inset Flex Code
19157 \begin_layout Plain Layout
19166 \begin_inset space \thinspace{}
19170 \begin_inset Flex Code
19173 \begin_layout Plain Layout
19179 ] As with paragraph styles, see
19180 \begin_inset CommandInset ref
19182 reference "subsec:Paragraph-Styles"
19189 \begin_layout Description
19190 \begin_inset Flex Code
19193 \begin_layout Plain Layout
19199 The font used for the label.
19201 \begin_inset CommandInset ref
19203 reference "subsec:Font-description"
19208 Note that this definition can never appear before
19209 \begin_inset Flex Code
19212 \begin_layout Plain Layout
19218 , lest it be ineffective.
19221 \begin_layout Description
19222 \begin_inset Flex Code
19225 \begin_layout Plain Layout
19232 \begin_inset Flex Code
19235 \begin_layout Plain Layout
19242 \begin_inset Quotes erd
19246 \begin_inset Quotes erd
19249 ] What will be displayed on the button or elsewhere as the inset label.
19251 \begin_inset Flex Code
19254 \begin_layout Plain Layout
19262 \begin_inset Flex Code
19265 \begin_layout Plain Layout
19271 ) modify this label on the fly.
19274 \begin_layout Description
19275 \begin_inset Flex Code
19278 \begin_layout Plain Layout
19284 Language dependent preamble; see
19285 \begin_inset CommandInset ref
19287 reference "subsec:I18n"
19294 \begin_layout Description
19295 \begin_inset Flex Code
19298 \begin_layout Plain Layout
19305 \begin_inset Flex Code
19308 \begin_layout Plain Layout
19314 ] The name of the corresponding \SpecialChar LaTeX
19316 Either the environment or command name.
19319 \begin_layout Description
19320 \begin_inset Flex Code
19323 \begin_layout Plain Layout
19330 \begin_inset Flex Code
19333 \begin_layout Plain Layout
19339 ] The optional parameter for the corresponding
19340 \begin_inset Flex Code
19343 \begin_layout Plain Layout
19349 stuff, including possible bracket pairs like
19350 \begin_inset Flex Code
19353 \begin_layout Plain Layout
19360 This parameter cannot be changed from within \SpecialChar LyX
19362 \begin_inset Flex Code
19365 \begin_layout Plain Layout
19371 for customizable parameters).
19372 It will be output as is after all \SpecialChar LaTeX
19374 \begin_inset Flex Code
19377 \begin_layout Plain Layout
19386 \begin_layout Description
19387 \begin_inset Flex Code
19390 \begin_layout Plain Layout
19397 \begin_inset Flex Code
19400 \begin_layout Plain Layout
19401 Command, Environment, None
19406 ] How the style should be translated into \SpecialChar LaTeX
19411 \begin_layout Plain Layout
19412 \begin_inset Flex Code
19415 \begin_layout Plain Layout
19421 is perhaps a bit misleading, since these rules apply to SGML classes too.
19422 Visit the SGML class files for specific examples.
19431 \begin_layout Description
19432 \begin_inset Flex Code
19435 \begin_layout Plain Layout
19441 means nothing special
19444 \begin_layout Description
19445 \begin_inset Flex Code
19448 \begin_layout Plain Layout
19455 \begin_inset Flex Code
19458 \begin_layout Plain Layout
19465 {\SpecialChar ldots
19474 \begin_layout Description
19475 \begin_inset Flex Code
19478 \begin_layout Plain Layout
19485 \begin_inset Flex Code
19488 \begin_layout Plain Layout
19495 }\SpecialChar ldots
19510 \begin_layout Standard
19511 Putting the last few things together, the \SpecialChar LaTeX
19512 output will be either:
19515 \begin_layout LyX-Code
19518 LatexName[LatexParam]{\SpecialChar ldots
19522 \begin_layout Standard
19526 \begin_layout LyX-Code
19529 begin{LatexName}[LatexParam] \SpecialChar ldots
19535 \begin_layout Standard
19536 depending upon the \SpecialChar LaTeX
19541 \begin_layout Description
19542 \begin_inset Flex Code
19545 \begin_layout Plain Layout
19552 \begin_inset Flex Code
19555 \begin_layout Plain Layout
19561 ] A string that is put at the beginning of the layout content.
19562 A line break in the output can be indicated by
19563 \begin_inset Flex Code
19566 \begin_layout Plain Layout
19575 \begin_layout Description
19576 \begin_inset Flex Code
19579 \begin_layout Plain Layout
19586 \begin_inset Flex Code
19589 \begin_layout Plain Layout
19596 \begin_inset Flex Code
19599 \begin_layout Plain Layout
19606 \begin_inset Flex Code
19609 \begin_layout Plain Layout
19616 \begin_inset Flex Code
19619 \begin_layout Plain Layout
19625 (indicating a dummy definition ending definitions of charstyles, etc).
19626 This entry is required in and is only meaningful for Flex insets.
19627 Among other things, it determines on which menu this inset will appear.
19629 \begin_inset Flex Code
19632 \begin_layout Plain Layout
19639 \begin_inset Flex Code
19642 \begin_layout Plain Layout
19648 will automatically set
19649 \begin_inset Flex Code
19652 \begin_layout Plain Layout
19659 \begin_inset Flex Code
19662 \begin_layout Plain Layout
19670 \begin_inset Flex Code
19673 \begin_layout Plain Layout
19679 can be set to true, or
19680 \begin_inset Flex Code
19683 \begin_layout Plain Layout
19690 \begin_inset Flex Code
19693 \begin_layout Plain Layout
19699 insets by setting it
19704 \begin_inset Flex Code
19707 \begin_layout Plain Layout
19716 \begin_layout Description
19717 \begin_inset Flex Code
19720 \begin_layout Plain Layout
19727 \begin_inset Flex Code
19730 \begin_layout Plain Layout
19739 \begin_inset space \thinspace{}
19743 \begin_inset Flex Code
19746 \begin_layout Plain Layout
19752 ] Whether multiple paragraphs are permitted in this inset.
19754 \begin_inset Flex Code
19757 \begin_layout Plain Layout
19763 to the same value and
19764 \begin_inset Flex Code
19767 \begin_layout Plain Layout
19773 to the opposite value.
19774 These can be reset to other values, if they are used
19779 \begin_inset Flex Code
19782 \begin_layout Plain Layout
19792 \begin_layout Description
19793 \begin_inset Flex Code
19796 \begin_layout Plain Layout
19803 \begin_inset Flex Code
19806 \begin_layout Plain Layout
19815 \begin_inset space \thinspace{}
19819 \begin_inset Flex Code
19822 \begin_layout Plain Layout
19828 ] Whether fragile commands in this inset should be
19829 \begin_inset Flex Code
19832 \begin_layout Plain Layout
19845 whether the command should itself be protected.) Default is false.
19846 \change_inserted -712698321 1523633958
19850 \begin_layout Description
19852 \change_inserted -712698321 1523634088
19853 \begin_inset Flex Code
19856 \begin_layout Plain Layout
19858 \change_inserted -712698321 1523633961
19865 \begin_inset Flex Code
19868 \begin_layout Plain Layout
19870 \change_inserted -712698321 1523633958
19879 \begin_inset space \thinspace{}
19883 \begin_inset Flex Code
19886 \begin_layout Plain Layout
19888 \change_inserted -712698321 1523633958
19894 ] This causes macros that contain this inset to be protected with
19895 \begin_inset Flex Code
19898 \begin_layout Plain Layout
19900 \change_inserted -712698321 1523634038
19915 ) if necessary and thus allows (some) verbatim stuff in macros.
19921 \begin_layout Description
19922 \begin_inset Flex Code
19925 \begin_layout Plain Layout
19932 \begin_inset Flex Code
19935 \begin_layout Plain Layout
19941 ] Deletes an existing
19942 \begin_inset Flex Code
19945 \begin_layout Plain Layout
19954 \begin_layout Description
19955 \begin_inset Flex Code
19958 \begin_layout Plain Layout
19965 \begin_inset Flex Code
19968 \begin_layout Plain Layout
19975 \begin_inset Flex Code
19978 \begin_layout Plain Layout
19984 that has replaced this
19985 \begin_inset Flex Code
19988 \begin_layout Plain Layout
19995 This is used to rename an
19996 \begin_inset Flex Code
19999 \begin_layout Plain Layout
20005 , while keeping backward compatibility.
20008 \begin_layout Description
20009 \begin_inset Flex Code
20012 \begin_layout Plain Layout
20019 \begin_inset Flex Code
20022 \begin_layout Plain Layout
20031 \begin_inset space \thinspace{}
20035 \begin_inset Flex Code
20038 \begin_layout Plain Layout
20044 ] As with paragraph styles, see
20045 \begin_inset CommandInset ref
20047 reference "subsec:Paragraph-Styles"
20055 \begin_layout Description
20056 \begin_inset Flex Code
20059 \begin_layout Plain Layout
20066 \begin_inset Flex Code
20069 \begin_layout Plain Layout
20078 \begin_inset space \thinspace{}
20082 \begin_inset Flex Code
20085 \begin_layout Plain Layout
20091 ] As with paragraph styles, see
20092 \begin_inset CommandInset ref
20094 reference "subsec:Paragraph-Styles"
20102 \begin_layout Description
20103 \begin_inset Flex Code
20106 \begin_layout Plain Layout
20112 As with paragraph styles, see
20113 \begin_inset CommandInset ref
20115 reference "subsec:Paragraph-Styles"
20122 \begin_layout Description
20123 \begin_inset Flex Code
20126 \begin_layout Plain Layout
20133 \begin_inset Flex Code
20136 \begin_layout Plain Layout
20142 ] The prefix to use when creating labels referring to insets of this type.
20143 This allows the use of formatted references.
20146 \begin_layout Description
20147 \begin_inset Flex Code
20150 \begin_layout Plain Layout
20157 \begin_inset Flex Code
20160 \begin_layout Plain Layout
20166 ] As with paragraph styles, see
20167 \begin_inset CommandInset ref
20169 reference "subsec:Paragraph-Styles"
20176 \begin_layout Description
20177 \begin_inset Flex Code
20180 \begin_layout Plain Layout
20187 \begin_inset Flex Code
20190 \begin_layout Plain Layout
20199 \begin_inset space \thinspace{}
20203 \begin_inset Flex Code
20206 \begin_layout Plain Layout
20212 ] Resets the \SpecialChar LaTeX
20213 arguments of this layout (as defined via the
20214 \begin_inset Flex Code
20217 \begin_layout Plain Layout
20224 This is useful if you have copied a style via
20225 \begin_inset Flex Code
20228 \begin_layout Plain Layout
20234 , but you do not want to inherit its (required and optional) arguments.
20237 \begin_layout Description
20238 \begin_inset Flex Code
20241 \begin_layout Plain Layout
20248 \begin_inset Flex Code
20251 \begin_layout Plain Layout
20258 \begin_inset space \thinspace{}
20262 \begin_inset Flex Code
20265 \begin_layout Plain Layout
20273 ] Whether this inset should use the font of its surrounding environment
20275 Default is false: use the font of the surrounding environment.
20278 \begin_layout Description
20279 \begin_inset Flex Code
20282 \begin_layout Plain Layout
20289 \begin_inset Flex Code
20292 \begin_layout Plain Layout
20298 ] A string that is put at the end of the layout content.
20299 A line break in the output can be indicated by
20300 \begin_inset Flex Code
20303 \begin_layout Plain Layout
20312 \begin_layout Description
20313 \begin_inset Flex Code
20316 \begin_layout Plain Layout
20323 \begin_inset Flex Code
20326 \begin_layout Plain Layout
20333 \begin_inset space \thinspace{}
20337 \begin_inset Flex Code
20340 \begin_layout Plain Layout
20348 ] Allow spell-checking the contents of this inset.
20352 \begin_layout Subsection
20354 \begin_inset CommandInset label
20356 name "subsec:Counters"
20363 \begin_layout Standard
20364 It is necessary to define the counters (
20365 \begin_inset Flex Noun
20368 \begin_layout Plain Layout
20375 \begin_inset Flex Noun
20378 \begin_layout Plain Layout
20384 , \SpecialChar ldots
20385 ) in the text class itself.
20386 The standard counters are defined in the file
20387 \begin_inset Flex Code
20390 \begin_layout Plain Layout
20396 , so you may have to do no more than add
20399 \begin_layout LyX-Code
20400 Input stdcounters.inc
20403 \begin_layout Standard
20404 to your layout file to get them to work.
20405 But if you want to define custom counters, then you can do so.
20406 The counter declaration must begin with:
20409 \begin_layout LyX-Code
20410 Counter CounterName
20413 \begin_layout Standard
20415 \begin_inset Flex Code
20418 \begin_layout Plain Layout
20424 ' is replaced by the name of the counter.
20425 And it must end with
20426 \begin_inset Quotes eld
20430 \begin_inset Flex Code
20433 \begin_layout Plain Layout
20440 \begin_inset Quotes erd
20444 The following parameters can also be used:
20447 \begin_layout Description
20448 \begin_inset Flex Code
20451 \begin_layout Plain Layout
20458 \begin_inset Flex Code
20461 \begin_layout Plain Layout
20467 ] Sets the initial value for the counter, to which it will be reset whenever
20469 Normally, one will want the default, 1.
20472 \begin_layout Description
20473 \begin_inset Flex Code
20476 \begin_layout Plain Layout
20483 \begin_inset Flex Code
20486 \begin_layout Plain Layout
20493 \begin_inset Quotes erd
20497 \begin_inset Quotes erd
20500 ] When defined, this string defines how the counter is displayed.
20501 Setting this value sets
20502 \begin_inset Flex Code
20505 \begin_layout Plain Layout
20506 LabelStringAppendix
20512 The following special constructs can be used in the string:
20516 \begin_layout Itemize
20517 \begin_inset Flex Code
20520 \begin_layout Plain Layout
20528 will be replaced by the expansion of the
20529 \begin_inset Flex Code
20532 \begin_layout Plain Layout
20539 \begin_inset Flex Code
20542 \begin_layout Plain Layout
20543 LabelStringAppendix
20549 \begin_inset Flex Code
20552 \begin_layout Plain Layout
20562 \begin_layout Itemize
20563 counter values can be expressed using \SpecialChar LaTeX
20565 \begin_inset Newline newline
20569 \begin_inset Flex Code
20572 \begin_layout Plain Layout
20589 \begin_inset Flex Code
20592 \begin_layout Plain Layout
20604 \begin_layout Plain Layout
20614 Actually, the situation is a bit more complicated: any
20633 other than those described below will produce arabic numerals.
20634 It would not be surprising to see this change in the future.
20640 \begin_inset Flex Code
20643 \begin_layout Plain Layout
20649 : 1, 2, 3,\SpecialChar ldots
20651 \begin_inset Flex Code
20654 \begin_layout Plain Layout
20660 for lower-case letters: a, b, c, \SpecialChar ldots
20662 \begin_inset Flex Code
20665 \begin_layout Plain Layout
20671 for upper-case letters: A, B, C, \SpecialChar ldots
20673 \begin_inset Flex Code
20676 \begin_layout Plain Layout
20682 for lower-case roman numerals: i, ii, iii, \SpecialChar ldots
20684 \begin_inset Flex Code
20687 \begin_layout Plain Layout
20693 for upper-case roman numerals: I, II, III\SpecialChar ldots
20695 \begin_inset Flex Code
20698 \begin_layout Plain Layout
20704 for hebrew numerals.
20708 \begin_layout Standard
20709 If LabelString is not defined, a default value is constructed as follows:
20710 if the counter has a master counter
20711 \begin_inset Flex Code
20714 \begin_layout Plain Layout
20721 \begin_inset Flex Code
20724 \begin_layout Plain Layout
20731 \begin_inset Newline newline
20735 \begin_inset Flex Code
20738 \begin_layout Plain Layout
20748 is used; otherwise the string
20749 \begin_inset Flex Code
20752 \begin_layout Plain Layout
20763 \begin_layout Description
20764 \begin_inset Flex Code
20767 \begin_layout Plain Layout
20768 LabelStringAppendix
20774 \begin_inset Flex Code
20777 \begin_layout Plain Layout
20784 \begin_inset Quotes erd
20788 \begin_inset Quotes erd
20792 \begin_inset Flex Code
20795 \begin_layout Plain Layout
20801 , but for use in the Appendix.
20804 \begin_layout Description
20805 \begin_inset Flex Code
20808 \begin_layout Plain Layout
20815 \begin_inset Flex Code
20818 \begin_layout Plain Layout
20825 \begin_inset Quotes erd
20829 \begin_inset Quotes erd
20832 ] A format for use with formatted references to this counter.
20833 For example, one might want to have references to section numbers appear
20835 \begin_inset Quotes eld
20839 \begin_inset Quotes erd
20843 The string should contain
20844 \begin_inset Quotes eld
20848 \begin_inset Quotes erd
20852 This will be replaced by the counter number itself.
20853 So, for sections, it would be: Section ##.
20856 \begin_layout Description
20857 \begin_inset Flex Code
20860 \begin_layout Plain Layout
20867 \begin_inset Flex Code
20870 \begin_layout Plain Layout
20877 \begin_inset Quotes erd
20881 \begin_inset Quotes erd
20884 ] If this is set to the name of another counter, the present counter will
20885 be reset every time the other one is increased.
20887 \begin_inset Flex Code
20890 \begin_layout Plain Layout
20897 \begin_inset Flex Code
20900 \begin_layout Plain Layout
20909 \begin_layout Subsection
20911 \begin_inset CommandInset label
20913 name "subsec:Font-description"
20920 \begin_layout Standard
20921 A font description looks like this:
20924 \begin_layout LyX-Code
20941 \begin_layout LyX-Code
20945 \begin_layout LyX-Code
20949 \begin_layout Standard
20950 The following commands are available:
20953 \begin_layout Description
20954 \begin_inset Flex Code
20957 \begin_layout Plain Layout
20964 \begin_inset Flex Code
20967 \begin_layout Plain Layout
20976 \begin_inset Flex Code
20979 \begin_layout Plain Layout
20986 \begin_inset Flex Code
20989 \begin_layout Plain Layout
20996 \begin_inset Flex Code
20999 \begin_layout Plain Layout
21006 \begin_inset Flex Code
21009 \begin_layout Plain Layout
21016 \begin_inset Flex Code
21019 \begin_layout Plain Layout
21026 \begin_inset Flex Code
21029 \begin_layout Plain Layout
21036 \begin_inset Flex Code
21039 \begin_layout Plain Layout
21046 \begin_inset Flex Code
21049 \begin_layout Plain Layout
21056 \begin_inset Flex Code
21059 \begin_layout Plain Layout
21066 \begin_inset Flex Code
21069 \begin_layout Plain Layout
21076 \begin_inset Flex Code
21079 \begin_layout Plain Layout
21086 \begin_inset Flex Code
21089 \begin_layout Plain Layout
21096 \begin_inset Flex Code
21099 \begin_layout Plain Layout
21106 \begin_inset Flex Code
21109 \begin_layout Plain Layout
21116 \begin_inset Flex Code
21119 \begin_layout Plain Layout
21126 \begin_inset Flex Code
21129 \begin_layout Plain Layout
21136 \begin_inset Flex Code
21139 \begin_layout Plain Layout
21146 \begin_inset Flex Code
21149 \begin_layout Plain Layout
21156 \begin_inset Flex Code
21159 \begin_layout Plain Layout
21168 \begin_layout Description
21169 \begin_inset Flex Code
21172 \begin_layout Plain Layout
21179 \begin_inset Flex Code
21182 \begin_layout Plain Layout
21191 \begin_inset Flex Code
21194 \begin_layout Plain Layout
21201 \begin_inset Flex Code
21204 \begin_layout Plain Layout
21213 \begin_layout Description
21214 \begin_inset Flex Code
21217 \begin_layout Plain Layout
21224 \begin_inset Flex Code
21227 \begin_layout Plain Layout
21233 ] Valid arguments are:
21234 \begin_inset Flex Code
21237 \begin_layout Plain Layout
21244 \begin_inset Flex Code
21247 \begin_layout Plain Layout
21254 \begin_inset Flex Code
21257 \begin_layout Plain Layout
21264 \begin_inset Flex Code
21267 \begin_layout Plain Layout
21274 \begin_inset Flex Code
21277 \begin_layout Plain Layout
21284 \begin_inset Flex Code
21287 \begin_layout Plain Layout
21294 \begin_inset Flex Code
21297 \begin_layout Plain Layout
21304 \begin_inset Flex Code
21307 \begin_layout Plain Layout
21314 \begin_inset Flex Code
21317 \begin_layout Plain Layout
21324 \begin_inset Flex Code
21327 \begin_layout Plain Layout
21334 \begin_inset Flex Code
21337 \begin_layout Plain Layout
21344 \begin_inset Flex Code
21347 \begin_layout Plain Layout
21354 Each of these turns on or off the corresponding attribute.
21356 \begin_inset Flex Code
21359 \begin_layout Plain Layout
21365 turns on emphasis, and
21366 \begin_inset Flex Code
21369 \begin_layout Plain Layout
21377 \begin_inset Newline newline
21380 If the latter seems puzzling, remember that the font settings for the present
21381 context are generally inherited from the surrounding context.
21383 \begin_inset Flex Code
21386 \begin_layout Plain Layout
21392 would turn off the emphasis that was anyway in effect, say, in a theorem
21396 \begin_layout Description
21397 \begin_inset Flex Code
21400 \begin_layout Plain Layout
21407 \begin_inset Flex Code
21410 \begin_layout Plain Layout
21419 \begin_inset Flex Code
21422 \begin_layout Plain Layout
21431 \begin_layout Description
21432 \begin_inset Flex Code
21435 \begin_layout Plain Layout
21442 \begin_inset Flex Code
21445 \begin_layout Plain Layout
21454 \begin_inset Flex Code
21457 \begin_layout Plain Layout
21464 \begin_inset Flex Code
21467 \begin_layout Plain Layout
21474 \begin_inset Flex Code
21477 \begin_layout Plain Layout
21486 \begin_layout Description
21487 \begin_inset Flex Code
21490 \begin_layout Plain Layout
21497 \begin_inset Flex Code
21500 \begin_layout Plain Layout
21507 \begin_inset Flex Code
21510 \begin_layout Plain Layout
21517 \begin_inset Flex Code
21520 \begin_layout Plain Layout
21529 \begin_inset Flex Code
21532 \begin_layout Plain Layout
21539 \begin_inset Flex Code
21542 \begin_layout Plain Layout
21549 \begin_inset Flex Code
21552 \begin_layout Plain Layout
21559 \begin_inset Flex Code
21562 \begin_layout Plain Layout
21569 \begin_inset Flex Code
21572 \begin_layout Plain Layout
21581 \begin_layout Subsection
21582 \begin_inset CommandInset label
21584 name "subsec:Citation-engine-description"
21588 Cite engine description
21591 \begin_layout Standard
21593 \begin_inset Flex Code
21596 \begin_layout Plain Layout
21602 blocks, as used mainly in cite engine files (see
21603 \begin_inset CommandInset ref
21605 reference "subsec:Cite-Engine-Files"
21612 ), define the citation commands provided by a specific
21613 \begin_inset Quotes eld
21617 \begin_inset Quotes erd
21621 A cite engine, in \SpecialChar LyX
21622 terms, is way specific way to format citations, using
21623 numbers, author names and/or years.
21624 Currently, \SpecialChar LyX
21625 supports three such engine types, namely:
21628 \begin_layout Enumerate
21629 \begin_inset Flex Code
21632 \begin_layout Plain Layout
21638 : the default Bib\SpecialChar TeX
21639 way to format citations, a simple numeric style (e.
21640 \begin_inset space \thinspace{}
21644 \begin_inset Quotes eld
21648 \begin_inset Quotes erd
21654 \begin_layout Enumerate
21655 \begin_inset Flex Code
21658 \begin_layout Plain Layout
21664 : Harvard-styled citations using author names and publication year (e.
21665 \begin_inset space \thinspace{}
21669 \begin_inset Quotes eld
21672 Smith and Miller (2017b)
21673 \begin_inset Quotes erd
21679 \begin_layout Enumerate
21680 \begin_inset Flex Code
21683 \begin_layout Plain Layout
21689 : extended numerical citations that also allow for author or title next
21691 \begin_inset space \thinspace{}
21695 \begin_inset Quotes eld
21698 Smith and Miller [1]
21699 \begin_inset Quotes erd
21705 \begin_layout Standard
21706 \begin_inset Flex Code
21709 \begin_layout Plain Layout
21715 blocks look like this:
21718 \begin_layout LyX-Code
21722 \begin_layout LyX-Code
21726 \begin_layout LyX-Code
21730 \begin_layout LyX-Code
21731 citeyearpar[][]=parencite*
21734 \begin_layout LyX-Code
21738 \begin_layout LyX-Code
21742 \begin_layout Standard
21744 \begin_inset Flex Code
21747 \begin_layout Plain Layout
21753 denotes the engine.
21754 The individual lines respectively define a cite command or cite command
21755 paradigm supported by this engine.
21756 The line can be as simple as a cite command that is used both to name the
21757 respective \SpecialChar LyX
21758 command and the \SpecialChar LaTeX
21759 output or more complex in order to differentiate
21761 The full syntax is:
21764 \begin_layout LyX-Code
21765 LyXName|alias$*<!_stardesc!_stardesctooltip>[][]=latexcmd
21768 \begin_layout Itemize
21769 \begin_inset Flex Code
21772 \begin_layout Plain Layout
21778 : The name as used in the
21779 \begin_inset Flex Code
21782 \begin_layout Plain Layout
21792 \begin_layout Standard
21793 For portability reasons, we try to use the same name for same-formatted
21794 commands in different cite packages (thus many names stem from natbib,
21795 and thus we need to differentiate a
21796 \begin_inset Flex Code
21799 \begin_layout Plain Layout
21805 sometimes, if the \SpecialChar LaTeX
21806 command names differ).
21810 \begin_layout Itemize
21811 \begin_inset Flex Code
21814 \begin_layout Plain Layout
21820 : a (comma-separated) list of commands that fall back to the given
21821 \begin_inset Flex Code
21824 \begin_layout Plain Layout
21830 in the current engine.
21831 This eases the switch of citation packages and engines.
21833 \begin_inset Flex Code
21836 \begin_layout Plain Layout
21843 \begin_inset Flex Code
21846 \begin_layout Plain Layout
21852 in layout definitions.
21855 \begin_layout Itemize
21856 \begin_inset Flex Code
21859 \begin_layout Plain Layout
21865 : The actual \SpecialChar LaTeX
21866 command that is output.
21870 \begin_layout Standard
21871 \begin_inset Flex Code
21874 \begin_layout Plain Layout
21881 \begin_inset Flex Code
21884 \begin_layout Plain Layout
21892 \begin_inset Flex Code
21895 \begin_layout Plain Layout
21902 \begin_inset Flex Code
21905 \begin_layout Plain Layout
21911 will be output to \SpecialChar LaTeX
21915 \begin_layout Standard
21919 \begin_layout Itemize
21920 Capitalization indicates that the command also has a capitalized form (
21921 \begin_inset Flex Code
21924 \begin_layout Plain Layout
21934 \begin_inset Flex Code
21937 \begin_layout Plain Layout
21946 These usually enforce up-casing of name prefixes (
21951 \begin_inset Formula $\Rightarrow$
21961 \begin_layout Itemize
21963 \begin_inset Flex Code
21966 \begin_layout Plain Layout
21972 indicate the number of optional arguments (there can be 0–2).
21975 \begin_layout Itemize
21977 \begin_inset Flex Code
21980 \begin_layout Plain Layout
21986 indicates there is a starred version of the command (
21987 \begin_inset Flex Code
21990 \begin_layout Plain Layout
22000 \begin_inset Flex Code
22003 \begin_layout Plain Layout
22016 \begin_layout Standard
22017 By default, the starred version means: Output all authors even if it should
22019 \begin_inset Quotes eld
22023 \begin_inset Quotes erd
22027 \begin_inset Flex Code
22030 \begin_layout Plain Layout
22039 \begin_layout Standard
22040 If the star has a different meaning for a given command, it can be specified
22042 \begin_inset Flex Code
22045 \begin_layout Plain Layout
22046 <!_stardesc!_stardesctooltip>
22052 Maximal two translatable macro keywords, marked by the prefix
22053 \begin_inset Flex Code
22056 \begin_layout Plain Layout
22063 The first points to the string that replaces the
22064 \begin_inset Quotes eld
22068 \begin_inset Quotes erd
22071 checkbox label in the citation dialog, the second one to an optional tool
22072 tip for this checkbox.
22076 \begin_layout Standard
22077 Note that these two macros have to be defined in a
22078 \begin_inset Flex Code
22081 \begin_layout Plain Layout
22087 (see next section), dropping the
22088 \begin_inset Flex Code
22091 \begin_layout Plain Layout
22097 from the prefix, like this:
22100 \begin_layout LyX-Code
22101 _stardesc Sta&rred command label
22104 \begin_layout LyX-Code
22105 _stardesctooltip Tooltip for the starred command checkbox.
22109 \begin_layout Itemize
22111 \begin_inset Flex Code
22114 \begin_layout Plain Layout
22120 indicates that this command features
22121 \begin_inset Quotes eld
22124 qualified citation lists
22125 \begin_inset Quotes erd
22133 -specific feature for multi-reference citations where an individual pre-
22134 and postnote can be given to each reference in the list.
22135 Please refer to the
22139 manual for details.
22142 \begin_layout Subsection
22143 \begin_inset CommandInset label
22145 name "subsec:Citation-format-description"
22149 Cite format description
22152 \begin_layout Standard
22154 \begin_inset Flex Code
22157 \begin_layout Plain Layout
22163 blocks are used to describe how bibliographic information should be displayed,
22164 both within \SpecialChar LyX
22165 itself (in the citation dialog and in tooltips, for example)
22166 and in XHTML output.
22167 Such a block might look like this:
22170 \begin_layout LyX-Code
22174 \begin_layout LyX-Code
22178 \begin_layout LyX-Code
22182 \begin_layout LyX-Code
22186 \begin_layout Standard
22190 \begin_layout LyX-Code
22194 \begin_layout LyX-Code
22198 \begin_layout LyX-Code
22202 \begin_layout LyX-Code
22206 \begin_layout Standard
22207 In the first case, the individual lines define how the bibliographic information
22208 associated with an article or book, respectively, is to be displayed, and
22209 such a definition can be given for any
22210 \begin_inset Quotes els
22214 \begin_inset Quotes ers
22217 that might be present in a Bib\SpecialChar TeX
22220 defines a default format in the source code that will be used if no specific
22221 definition has been given.
22223 predefines several formats in the file
22224 \begin_inset Flex Code
22227 \begin_layout Plain Layout
22233 , which is included in most of \SpecialChar LyX
22234 's document classes.
22237 \begin_layout Standard
22238 In the second case, the lines define how a specific citation command (in
22240 \begin_inset Flex Code
22243 \begin_layout Plain Layout
22252 \begin_inset Flex Code
22255 \begin_layout Plain Layout
22263 ) is to be displayed on the citation inset label, in the citation dialog,
22264 menu or XHTML output.
22266 defines such formats for the citation style variants it supports via
22268 Document\SpecialChar menuseparator
22269 Setting\SpecialChar menuseparator
22270 Bibliography\SpecialChar ldots
22274 \begin_inset Flex Code
22277 \begin_layout Plain Layout
22283 files that are shipped with \SpecialChar LyX
22285 \begin_inset CommandInset ref
22287 reference "subsec:Cite-Engine-Files"
22297 \begin_layout Standard
22298 The definitions use a simple language that allows Bib\SpecialChar TeX
22299 keys to be replaced
22301 Keys should be enclosed in
22302 \begin_inset Flex Code
22305 \begin_layout Plain Layout
22312 \begin_inset Flex Code
22315 \begin_layout Plain Layout
22322 So a simple definition might look like this:
22325 \begin_layout LyX-Code
22327 \begin_inset Quotes eld
22331 \begin_inset Quotes erd
22337 \begin_layout Standard
22338 This would print the author, followed by a comma, followed by the title,
22339 in quotes, followed by a period.
22342 \begin_layout Standard
22343 Of course, sometimes you may want to print a key only if it exists.
22344 This can be done by using a conditional construction, such as:
22345 \begin_inset Flex Code
22348 \begin_layout Plain Layout
22350 \begin_inset space ~
22360 \begin_inset Flex Code
22363 \begin_layout Plain Layout
22369 key exists, then print
22370 \begin_inset Quotes eld
22374 \begin_inset space ~
22378 \begin_inset Quotes erd
22381 followed by the volume key.
22382 It is also possible to have an else clause in the conditional, such as:
22383 \begin_inset Newline newline
22387 \begin_inset Flex Code
22390 \begin_layout Plain Layout
22391 {%author%[[%author%]][[%editor%, ed.]]}
22397 \begin_inset Newline newline
22401 \begin_inset Flex Code
22404 \begin_layout Plain Layout
22410 key is printed if it exists; otherwise, the editor key is printed, followed
22412 \begin_inset Quotes eld
22416 \begin_inset space ~
22420 \begin_inset Quotes erd
22423 Note that the key is again enclosed in
22424 \begin_inset Flex Code
22427 \begin_layout Plain Layout
22433 signs; the entire conditional is enclosed in braces; and the if and else
22434 clauses are enclosed in double brackets,
22435 \begin_inset Quotes eld
22439 \begin_inset Flex Code
22442 \begin_layout Plain Layout
22449 \begin_inset Quotes eld
22453 \begin_inset Quotes eld
22457 \begin_inset Flex Code
22460 \begin_layout Plain Layout
22467 \begin_inset Quotes erd
22471 There must be no space between any of these.
22474 \begin_layout Standard
22475 Next to the entry keys, there are some special keys that can be used for
22476 these conditionals:
22479 \begin_layout Itemize
22480 \begin_inset Flex Code
22483 \begin_layout Plain Layout
22484 {%dialog%[[true]][[false]]}
22490 \begin_inset Quotes eld
22494 \begin_inset Quotes erd
22497 part for dialogs and menus, the
22498 \begin_inset Quotes eld
22502 \begin_inset Quotes erd
22505 part for other contexts (workarea, export)
22508 \begin_layout Itemize
22509 \begin_inset Flex Code
22512 \begin_layout Plain Layout
22513 {%export%[[true]][[false]]}
22519 \begin_inset Quotes eld
22523 \begin_inset Quotes erd
22526 part for export and menus, the
22527 \begin_inset Quotes eld
22531 \begin_inset Quotes erd
22534 part for other contexts (workarea, dialog)
22537 \begin_layout Itemize
22538 \begin_inset Flex Code
22541 \begin_layout Plain Layout
22548 \begin_inset Quotes eld
22552 \begin_inset Quotes erd
22555 part if another item follows (e.
22556 \begin_inset space \thinspace{}
22559 g., in a citation with multiple keys)
22562 \begin_layout Itemize
22563 \begin_inset Flex Code
22566 \begin_layout Plain Layout
22567 {%second%[[true]][[false]]}
22573 \begin_inset Quotes eld
22577 \begin_inset Quotes erd
22580 if this is the second of multiple items, else the
22581 \begin_inset Quotes eld
22585 \begin_inset Quotes erd
22591 \begin_layout Itemize
22592 \begin_inset Flex Code
22595 \begin_layout Plain Layout
22596 {%ifstar%[[true]][[false]]}
22602 \begin_inset Quotes eld
22606 \begin_inset Quotes erd
22609 part for starred citation commands (such as
22610 \begin_inset Flex Code
22613 \begin_layout Plain Layout
22621 ), the false part for unstarred
22624 \begin_layout Itemize
22625 \begin_inset Flex Code
22628 \begin_layout Plain Layout
22629 {%ifentrytype:<type>%[[true]][[false]]}
22635 \begin_inset Quotes eld
22639 \begin_inset Quotes erd
22642 if the current entry type matches
22643 \begin_inset Flex Code
22646 \begin_layout Plain Layout
22652 , else the false part (e.g., in a citation definition:
22653 \begin_inset Flex Code
22656 \begin_layout Plain Layout
22657 {%ifentrytype:book%[[this is a book]][[this is no book]]}
22665 \begin_layout Itemize
22666 \begin_inset Flex Code
22669 \begin_layout Plain Layout
22670 {%ifmultiple:<authortype>%[[true]][[false]]}
22676 \begin_inset Quotes eld
22680 \begin_inset Quotes erd
22683 if the current author type (author, editor etc.) has multiple authors, else
22684 the false part (e.g., in a bibliography definition:
22685 \begin_inset Flex Code
22688 \begin_layout Plain Layout
22689 {%ifmultiple:editor%[[eds.]][[ed.]]}
22697 \begin_layout Itemize
22698 \begin_inset Flex Code
22701 \begin_layout Plain Layout
22702 {%ifqualified%[[true]][[false]]}
22708 \begin_inset Quotes eld
22712 \begin_inset Quotes erd
22715 part if the current citation is a qualified citation list (a specific
22719 format for multi-reference citations), the false part if this is not the
22723 \begin_layout Standard
22725 \begin_inset Flex Code
22728 \begin_layout Plain Layout
22734 prints the author key as it is recorded in the bibliography file.
22735 This might not be what you want, since it will result in a string such
22737 \begin_inset Quotes eld
22740 Miller, Peter and Smith, Mary and White, Jane
22741 \begin_inset Quotes erd
22745 \begin_inset Quotes eld
22749 \begin_inset Quotes erd
22752 is used by Bib\SpecialChar TeX
22753 to delimit authors).
22755 therefore provides some methods to get properly formatted name lists (which
22756 will also get translated).
22757 The following keys are provided:
22760 \begin_layout Enumerate
22761 For name lists with pre- and surname, suitable for the main authors/editors
22762 of a bibliography item.
22764 \begin_inset Flex Code
22767 \begin_layout Plain Layout
22773 part denotes the kind of list that is requested (e.g.
22775 \begin_inset Flex Code
22778 \begin_layout Plain Layout
22788 \begin_layout Itemize
22789 \begin_inset Flex Code
22792 \begin_layout Plain Layout
22793 %abbrvnames:<nametype>%
22798 : Provides a name list which is abbreviated (with
22799 \begin_inset Quotes eld
22803 \begin_inset Quotes erd
22807 \begin_inset Flex Code
22810 \begin_layout Plain Layout
22819 \begin_layout Itemize
22820 \begin_inset Flex Code
22823 \begin_layout Plain Layout
22824 %fullnames:<nametype>%
22829 : Provides a full name list (never abbreviated with
22830 \begin_inset Quotes eld
22834 \begin_inset Quotes erd
22840 \begin_layout Itemize
22841 \begin_inset Flex Code
22844 \begin_layout Plain Layout
22845 %forceabbrvnames:<nametype>%
22850 : Provides a name list which is always abbreviated (with
22851 \begin_inset Quotes eld
22855 \begin_inset Quotes erd
22859 \begin_inset Flex Code
22862 \begin_layout Plain Layout
22872 \begin_layout Enumerate
22873 Alternative name lists with pre- and surname, if the order of pre- and surname
22874 inside the bibliography item differs (as in:
22875 \begin_inset Quotes eld
22878 Miller, John: Some text, in: Mary Smith, ed.: A volume
22879 \begin_inset Quotes erd
22886 \begin_layout Itemize
22887 \begin_inset Flex Code
22890 \begin_layout Plain Layout
22891 %abbrvbynames:<nametype>%
22896 : Provides a name list which is abbreviated (with
22897 \begin_inset Quotes eld
22901 \begin_inset Quotes erd
22905 \begin_inset Flex Code
22908 \begin_layout Plain Layout
22917 \begin_layout Itemize
22918 \begin_inset Flex Code
22921 \begin_layout Plain Layout
22922 %fullbynames:<nametype>%
22927 : Provides a full name list (never abbreviated with
22928 \begin_inset Quotes eld
22932 \begin_inset Quotes erd
22938 \begin_layout Itemize
22939 \begin_inset Flex Code
22942 \begin_layout Plain Layout
22943 %forceabbrvbynames:<nametype>%
22948 : Provides a name list which is always abbreviated (with
22949 \begin_inset Quotes eld
22953 \begin_inset Quotes erd
22957 \begin_inset Flex Code
22960 \begin_layout Plain Layout
22970 \begin_layout Enumerate
22971 And finally name lists which consist of family names only, as used in author-yea
22973 These do not take a
22974 \begin_inset Flex Code
22977 \begin_layout Plain Layout
22983 part, but always return either an author list or, if this does not exist,
22984 an editor list (as common in author-year labels):
22988 \begin_layout Itemize
22989 \begin_inset Flex Code
22992 \begin_layout Plain Layout
22998 : Provides a name list which is abbreviated (with
22999 \begin_inset Quotes eld
23003 \begin_inset Quotes erd
23007 \begin_inset Flex Code
23010 \begin_layout Plain Layout
23019 \begin_layout Itemize
23020 \begin_inset Flex Code
23023 \begin_layout Plain Layout
23029 : Provides a full name list (never abbreviated with
23030 \begin_inset Quotes eld
23034 \begin_inset Quotes erd
23040 \begin_layout Itemize
23041 \begin_inset Flex Code
23044 \begin_layout Plain Layout
23045 %forceabbrvciteauthor%
23050 : Provides a name list which is always abbreviated (with
23051 \begin_inset Quotes eld
23055 \begin_inset Quotes erd
23059 \begin_inset Flex Code
23062 \begin_layout Plain Layout
23072 \begin_layout Standard
23073 The order of pre- and surname in the former two lists can be adjusted by
23077 \begin_layout Itemize
23078 \begin_inset Flex Code
23081 \begin_layout Plain Layout
23082 !firstnameform %surname%, %prename%
23087 (first author in lists of type 1)
23090 \begin_layout Itemize
23091 \begin_inset Flex Code
23094 \begin_layout Plain Layout
23095 !othernameform %surname%, %prename%
23100 (other authors in lists of type 1)
23103 \begin_layout Itemize
23104 \begin_inset Flex Code
23107 \begin_layout Plain Layout
23108 !firstbynameform %prename% %surname%
23113 (first author in lists of type 2)
23116 \begin_layout Itemize
23117 \begin_inset Flex Code
23120 \begin_layout Plain Layout
23121 !otherbynameform %prename% %surname%
23126 (other authors in lists of type 2)
23129 \begin_layout Standard
23130 This allows you to configure namings like
23131 \begin_inset Quotes eld
23134 Miller, Peter and Mary Smith: \SpecialChar ldots
23135 , in: John Doe and Pat Green, eds.:\SpecialChar ldots
23137 \begin_inset Quotes erd
23143 \begin_layout Standard
23144 There is one other piece of syntax available in definitions, which looks
23146 \begin_inset Flex Code
23149 \begin_layout Plain Layout
23156 This defines a piece of formatting information that is to be used when
23158 \begin_inset Quotes eld
23162 \begin_inset Quotes erd
23166 Obviously, we do not want to output HTML tags when writing plain text,
23167 so they should be wrapped in
23168 \begin_inset Quotes eld
23172 \begin_inset Quotes erd
23176 \begin_inset Quotes eld
23180 \begin_inset Quotes erd
23186 \begin_layout Standard
23187 Two special sorts of definitions are also possible in a
23188 \begin_inset Flex Code
23191 \begin_layout Plain Layout
23198 An example of the first would be:
23201 \begin_layout LyX-Code
23203 \begin_inset Quotes eld
23207 \begin_inset Quotes erd
23213 \begin_layout Standard
23214 This is an abbreviation, or macro, and it can be used by treating it as
23216 \begin_inset Flex Code
23219 \begin_layout Plain Layout
23228 \begin_inset Flex Code
23231 \begin_layout Plain Layout
23237 exactly as it would treat its definition.
23238 So, let us issue the obvious
23246 \begin_layout LyX-Code
23250 \begin_layout Standard
23251 or anything like it.
23253 shouldn't go into an infinite loop, but it may go into a long one before
23257 \begin_layout Standard
23258 The second sort of special definition might look like this:
23261 \begin_layout LyX-Code
23265 \begin_layout Standard
23266 This defines a translatable piece of text, which allows relevant parts of
23267 the bibliography or citation to be translated.
23268 It can be included in a definition by treating it as a key:
23269 \begin_inset Flex Code
23272 \begin_layout Plain Layout
23279 Note that there are two different translation paths: All definitions starting
23281 \begin_inset Flex Code
23284 \begin_layout Plain Layout
23290 , such as in the example above, will be translated to the currently active
23291 buffer language (so the translation will match the generated document).
23292 All definitions starting with underscore only will be translated to the
23294 This is the proper translation for strings that only occur in the dialogs
23295 or on buttons, such as this one:
23298 \begin_layout LyX-Code
23299 _addtobib Add to bibliography only.
23302 \begin_layout Standard
23303 Several of these translatable strings are predefined in
23304 \begin_inset Flex Code
23307 \begin_layout Plain Layout
23314 \begin_inset Flex Code
23317 \begin_layout Plain Layout
23324 Note that these are not macros, in the sense just defined.
23325 They will not be expanded.
23328 \begin_layout Standard
23329 So here then is an example that uses several of these features:
23330 \begin_inset VSpace defskip
23336 \begin_layout Standard
23340 !authoredit {%author%[[%author%, ]][[{%editor%[[%editor%, %B_edtext%, ]]}]]}
23343 \begin_layout Standard
23344 \begin_inset VSpace defskip
23347 This defines a macro that prints the author, followed by a comma, if the
23349 \begin_inset Flex Code
23352 \begin_layout Plain Layout
23358 key is defined, or else prints the name of the editor, followed by the
23360 \begin_inset Flex Code
23363 \begin_layout Plain Layout
23369 or its translation (it is by default
23370 \begin_inset Quotes eld
23374 \begin_inset Quotes erd
23378 \begin_inset Flex Code
23381 \begin_layout Plain Layout
23388 Note that this is in fact defined in
23389 \begin_inset Flex Code
23392 \begin_layout Plain Layout
23398 , so you can use it in your own definitions, or re-definitions, if you load
23402 \begin_layout Section
23403 \begin_inset CommandInset label
23405 name "sec:Tags-for-XHTML"
23409 Tags for XHTML output
23412 \begin_layout Standard
23413 As with \SpecialChar LaTeX
23414 or DocBook, the format of \SpecialChar LyX
23415 's XHTML output is also controlled by
23416 layout information.
23417 In general, \SpecialChar LyX
23418 provides sensible defaults and, as mentioned earlier, it will
23419 even construct default CSS style rules from the other layout tags.
23420 For example, \SpecialChar LyX
23421 will attempt to use the information provided in the
23422 \begin_inset Flex Code
23425 \begin_layout Plain Layout
23431 declaration for the Chapter style to write CSS that will appropriately
23432 format chapter headings.
23435 \begin_layout Standard
23436 In many cases, then, you may not have to do anything at all to get acceptable
23437 XHTML output for your own environments, custom insets, and so forth.
23438 But in some cases you will, and so \SpecialChar LyX
23439 provides a number of layout tags that
23440 can be used to customize the XHTML and CSS that are generated.
23443 \begin_layout Standard
23444 Note that there are two tags,
23445 \begin_inset Flex Code
23448 \begin_layout Plain Layout
23455 \begin_inset Flex Code
23458 \begin_layout Plain Layout
23464 that may appear outside style and inset declarations.
23466 \begin_inset CommandInset ref
23468 reference "subsec:General-text-class"
23472 for details on these.
23475 \begin_layout Subsection
23476 \begin_inset CommandInset label
23478 name "subsec:Paragraph-Style-XHTML"
23485 \begin_layout Standard
23486 The sort of XHTML \SpecialChar LyX
23487 outputs for a paragraph depends upon whether we are dealing
23488 with a normal paragraph, a command, or an environment, where this is itself
23489 determined by the contents of the corresponding
23490 \begin_inset Flex Code
23493 \begin_layout Plain Layout
23504 \begin_layout Standard
23505 For a command or normal paragraph, the output XHTML has the following form:
23508 \begin_layout LyX-Code
23512 \begin_inset Quotes erd
23516 \begin_inset Quotes erd
23522 \begin_layout LyX-Code
23526 \begin_inset Quotes erd
23530 \begin_inset Quotes erd
23536 \begin_layout LyX-Code
23539 Contents of the paragraph.
23542 \begin_layout LyX-Code
23548 \begin_layout Standard
23549 The label tags are of course omitted if the paragraph does not have a label.
23552 \begin_layout Standard
23553 For an environment that is not some sort of list, the XHTML takes this form:
23556 \begin_layout LyX-Code
23560 \begin_inset Quotes erd
23564 \begin_inset Quotes erd
23570 \begin_layout LyX-Code
23574 \begin_inset Quotes erd
23578 \begin_inset Quotes erd
23582 \begin_inset Quotes erd
23586 \begin_inset Quotes erd
23589 >Environment Label</labeltag>First paragraph.</itemtag>
23592 \begin_layout LyX-Code
23595 <itemtag>Second paragraph.</itemtag>
23598 \begin_layout LyX-Code
23604 \begin_layout Standard
23605 Note that the label is output only for the first paragraph, as it should
23606 be for a theorem, for example.
23610 \begin_layout Standard
23611 For a list, we have one of these forms:
23614 \begin_layout LyX-Code
23618 \begin_inset Quotes erd
23622 \begin_inset Quotes erd
23628 \begin_layout LyX-Code
23632 \begin_inset Quotes erd
23636 \begin_inset Quotes erd
23640 \begin_inset Quotes erd
23644 \begin_inset Quotes erd
23647 >List Label</labeltag>First item.</itemtag>
23650 \begin_layout LyX-Code
23654 \begin_inset Quotes erd
23658 \begin_inset Quotes erd
23662 \begin_inset Quotes erd
23666 \begin_inset Quotes erd
23669 >List Label</labeltag>Second item.</itemtag>
23672 \begin_layout LyX-Code
23678 \begin_layout LyX-Code
23682 \begin_layout LyX-Code
23686 \begin_inset Quotes erd
23690 \begin_inset Quotes erd
23696 \begin_layout LyX-Code
23700 \begin_inset Quotes erd
23704 \begin_inset Quotes erd
23707 >List Label</labeltag><itemtag attr=
23708 \begin_inset Quotes erd
23712 \begin_inset Quotes erd
23715 >First item.</itemtag>
23718 \begin_layout LyX-Code
23722 \begin_inset Quotes erd
23726 \begin_inset Quotes erd
23729 >List Label</labeltag><itemtag attr=
23730 \begin_inset Quotes erd
23734 \begin_inset Quotes erd
23737 >Second item.</itemtag>
23740 \begin_layout LyX-Code
23746 \begin_layout Standard
23747 Note the different orders of
23748 \begin_inset Flex Code
23751 \begin_layout Plain Layout
23758 \begin_inset Flex Code
23761 \begin_layout Plain Layout
23768 Which order we get depends upon the setting of
23769 \begin_inset Flex Code
23772 \begin_layout Plain Layout
23779 \begin_inset Flex Code
23782 \begin_layout Plain Layout
23788 is false (the default), you get the first of these, with the label within
23789 the item; if true, you get the second, with the label outside the item.
23792 \begin_layout Standard
23793 The specific tags and attributes output for each paragraph type can be controlle
23794 d by means of the layout tags we are about to describe.
23795 As mentioned earlier, however, \SpecialChar LyX
23796 uses sensible defaults for many of these,
23797 so you often may not need to do very much to get good XHTML output.
23798 Think of the available tags as there so you can tweak things to your liking.
23801 \begin_layout Description
23802 \begin_inset Flex Code
23805 \begin_layout Plain Layout
23812 \begin_inset Flex Code
23815 \begin_layout Plain Layout
23821 ] Specifies attribute information to be output with the main tag.
23823 \begin_inset Quotes eld
23827 \begin_inset Flex Code
23830 \begin_layout Plain Layout
23837 \begin_inset Quotes erd
23841 By default, \SpecialChar LyX
23843 \begin_inset Quotes eld
23847 \begin_inset Flex Code
23850 \begin_layout Plain Layout
23857 \begin_inset Quotes erd
23861 \begin_inset Flex Code
23864 \begin_layout Plain Layout
23870 is the \SpecialChar LyX
23871 name of the layout, made lowercase, for example: chapter.
23876 contain any style information.
23878 \begin_inset Flex Code
23881 \begin_layout Plain Layout
23890 \begin_layout Description
23891 \begin_inset Flex Code
23894 \begin_layout Plain Layout
23901 \begin_inset Flex Code
23904 \begin_layout Plain Layout
23914 ] Whether to output the default CSS information \SpecialChar LyX
23915 generates for this layout,
23916 even if additional information is explicitly provided via
23917 \begin_inset Flex Code
23920 \begin_layout Plain Layout
23928 \begin_inset Flex Code
23931 \begin_layout Plain Layout
23937 allows you to alter or augment the generated CSS, rather than to override
23940 \begin_inset Flex Code
23943 \begin_layout Plain Layout
23952 \begin_layout Description
23953 \begin_inset Flex Code
23956 \begin_layout Plain Layout
23963 \begin_inset Flex Code
23966 \begin_layout Plain Layout
23972 ] The tag to be used for individual paragraphs of environments, replacing
23974 \begin_inset Flex Code
23977 \begin_layout Plain Layout
23983 in the examples above.
23985 \begin_inset Flex Code
23988 \begin_layout Plain Layout
23997 \begin_layout Description
23998 \begin_inset Flex Code
24001 \begin_layout Plain Layout
24008 \begin_inset Flex Code
24011 \begin_layout Plain Layout
24017 ] Attributes for the item tag.
24019 \begin_inset Newline newline
24023 \begin_inset Quotes eld
24027 \begin_inset Flex Code
24030 \begin_layout Plain Layout
24031 class=`layoutname_item'
24037 \begin_inset Quotes erd
24045 contain any style information.
24047 \begin_inset Flex Code
24050 \begin_layout Plain Layout
24059 \begin_layout Description
24060 \begin_inset Flex Code
24063 \begin_layout Plain Layout
24070 \begin_inset Flex Code
24073 \begin_layout Plain Layout
24079 ] The tag to be used for paragraph and item labels, replacing
24080 \begin_inset Flex Code
24083 \begin_layout Plain Layout
24089 in the examples above.
24091 \begin_inset Flex Code
24094 \begin_layout Plain Layout
24101 \begin_inset Flex Code
24104 \begin_layout Plain Layout
24111 \begin_inset Flex Code
24114 \begin_layout Plain Layout
24121 \begin_inset Flex Code
24124 \begin_layout Plain Layout
24125 Centered_Top_Environment
24130 , in which case it defaults to
24131 \begin_inset Flex Code
24134 \begin_layout Plain Layout
24143 \begin_layout Description
24144 \begin_inset Flex Code
24147 \begin_layout Plain Layout
24154 \begin_inset Flex Code
24157 \begin_layout Plain Layout
24163 ] Attributes for the label tag.
24165 \begin_inset Newline newline
24169 \begin_inset Quotes eld
24173 \begin_inset Flex Code
24176 \begin_layout Plain Layout
24177 class=`layoutname_label'
24183 \begin_inset Quotes erd
24191 contain any style information.
24193 \begin_inset Flex Code
24196 \begin_layout Plain Layout
24205 \begin_layout Description
24206 \begin_inset Flex Code
24209 \begin_layout Plain Layout
24216 \begin_inset Flex Code
24219 \begin_layout Plain Layout
24229 ] Meaningful only for list-like environments, this tag controls whether
24230 the label tag is output before or inside the item tag.
24231 This is used, for example, in the description environment, where we want
24233 \begin_inset Flex Code
24236 \begin_layout Plain Layout
24237 <dt>\SpecialChar ldots
24238 </dt><dd>\SpecialChar ldots
24246 \begin_inset Flex Code
24249 \begin_layout Plain Layout
24255 : The label tag is output inside the item tag.
24258 \begin_layout Description
24259 \begin_inset Flex Code
24262 \begin_layout Plain Layout
24268 Information to be output in the
24269 \begin_inset Flex Code
24272 \begin_layout Plain Layout
24278 section when this style is used.
24279 This might, for example, be used to include a
24280 \begin_inset Flex Code
24283 \begin_layout Plain Layout
24290 \begin_inset Flex Code
24293 \begin_layout Plain Layout
24302 \begin_layout Description
24303 \begin_inset Flex Code
24306 \begin_layout Plain Layout
24312 CSS style information to be included when this style is used.
24313 Note that this will automatically be wrapped in a layout-generated
24314 \begin_inset Flex Code
24317 \begin_layout Plain Layout
24323 block, so only the CSS itself need be included.
24325 \begin_inset Flex Code
24328 \begin_layout Plain Layout
24337 \begin_layout Description
24338 \begin_inset Flex Code
24341 \begin_layout Plain Layout
24348 \begin_inset Flex Code
24351 \begin_layout Plain Layout
24357 ] The tag to be used for the main label, replacing
24358 \begin_inset Flex Code
24361 \begin_layout Plain Layout
24367 in the examples above.
24369 \begin_inset Flex Code
24372 \begin_layout Plain Layout
24381 \begin_layout Description
24382 \begin_inset Flex Code
24385 \begin_layout Plain Layout
24392 \begin_inset Flex Code
24395 \begin_layout Plain Layout
24405 ] Marks this style as the one to be used to generate the
24406 \begin_inset Flex Code
24409 \begin_layout Plain Layout
24415 tag for the XHTML file.
24416 By default, it is false.
24418 \begin_inset Flex Code
24421 \begin_layout Plain Layout
24427 file sets it to true for the
24428 \begin_inset Flex Code
24431 \begin_layout Plain Layout
24441 \begin_layout Subsection
24445 \begin_layout Standard
24446 The XHTML output of insets can also be controlled by information in layout
24451 \begin_layout Plain Layout
24452 At present, this is true only for
24453 \begin_inset Quotes eld
24457 \begin_inset Quotes erd
24460 insets (insets you can type into) and is not true for
24461 \begin_inset Quotes eld
24465 \begin_inset Quotes erd
24468 insets (insets that are associated with dialog boxes).
24473 Here, too, \SpecialChar LyX
24474 tries to provide sensible defaults, and it constructs default
24476 But everything can be customized.
24479 \begin_layout Standard
24480 The XHTML \SpecialChar LyX
24481 outputs for an inset has the following form:
24484 \begin_layout LyX-Code
24486 \begin_inset Quotes erd
24490 \begin_inset Quotes erd
24496 \begin_layout LyX-Code
24497 <labeltag>Label</labeltag>
24500 \begin_layout LyX-Code
24502 \begin_inset Quotes erd
24506 \begin_inset Quotes erd
24509 >Contents of the inset.</innertag>
24512 \begin_layout LyX-Code
24516 \begin_layout Standard
24517 If the inset permits multiple paragraphs—that is, if
24518 \begin_inset Flex Code
24521 \begin_layout Plain Layout
24527 is true—then the contents of the inset will itself be output as paragraphs
24528 formatted according to the styles used for those paragraphs (standard,
24529 quote, and the like).
24530 The label tag is of course omitted if the paragraph does not have a label
24531 and, at present, is always
24532 \begin_inset Flex Code
24535 \begin_layout Plain Layout
24542 The inner tag is optional and, by default, does not appear.
24545 \begin_layout Standard
24546 The specific tags and attributes output for each inset can be controlled
24547 by means of the following layout tags.
24550 \begin_layout Description
24551 \begin_inset Flex Code
24554 \begin_layout Plain Layout
24561 \begin_inset Flex Code
24564 \begin_layout Plain Layout
24570 ] Specifies attribute information to be output with the main tag.
24572 \begin_inset Quotes eld
24576 \begin_inset Flex Code
24579 \begin_layout Plain Layout
24580 class=`myinset' onclick=`\SpecialChar ldots
24587 \begin_inset Quotes erd
24591 By default, \SpecialChar LyX
24593 \begin_inset Quotes eld
24597 \begin_inset Flex Code
24600 \begin_layout Plain Layout
24607 \begin_inset Quotes erd
24611 \begin_inset Flex Code
24614 \begin_layout Plain Layout
24620 is the \SpecialChar LyX
24621 name of the inset, made lowercase and with non-alphanumeric characters
24622 converted to underscores, for example: footnote.
24625 \begin_layout Description
24626 \begin_inset Flex Code
24629 \begin_layout Plain Layout
24636 \begin_inset Flex Code
24639 \begin_layout Plain Layout
24649 ] Whether to output the default CSS information \SpecialChar LyX
24650 generates for this layout,
24651 even if additional information is explicitly provided via
24652 \begin_inset Flex Code
24655 \begin_layout Plain Layout
24663 \begin_inset Flex Code
24666 \begin_layout Plain Layout
24672 allows you to alter or augment the generated CSS, rather than to override
24677 \begin_layout Description
24678 \begin_inset Flex Code
24681 \begin_layout Plain Layout
24688 \begin_inset Flex Code
24691 \begin_layout Plain Layout
24697 ] Attributes for the inner tag.
24699 \begin_inset Newline newline
24703 \begin_inset Quotes eld
24707 \begin_inset Flex Code
24710 \begin_layout Plain Layout
24711 class=`insetname_inner'
24717 \begin_inset Quotes erd
24723 \begin_layout Description
24724 \begin_inset Flex Code
24727 \begin_layout Plain Layout
24734 \begin_inset Flex Code
24737 \begin_layout Plain Layout
24743 ] The inner tag, replacing
24744 \begin_inset Flex Code
24747 \begin_layout Plain Layout
24753 in the examples above.
24754 By default, there is none.
24757 \begin_layout Description
24758 \begin_inset Flex Code
24761 \begin_layout Plain Layout
24768 \begin_inset Flex Code
24771 \begin_layout Plain Layout
24779 ] Whether this inset represents a standalone block of text (such as a footnote)
24780 or instead represents material that is included in the surrounding text
24781 (such as a branch).
24785 \begin_layout Description
24786 \begin_inset Flex Code
24789 \begin_layout Plain Layout
24796 \begin_inset Flex Code
24799 \begin_layout Plain Layout
24805 ] A label for this inset, possibly including a reference to a counter.
24806 For example, for footnote, it might be:
24807 \begin_inset Flex Code
24810 \begin_layout Plain Layout
24819 This is optional, and there is no default.
24822 \begin_layout Description
24823 \begin_inset Flex Code
24826 \begin_layout Plain Layout
24832 Information to be output in the
24833 \begin_inset Flex Code
24836 \begin_layout Plain Layout
24842 section when this style is used.
24843 This might, for example, be used to include a
24844 \begin_inset Flex Code
24847 \begin_layout Plain Layout
24854 \begin_inset Flex Code
24857 \begin_layout Plain Layout
24866 \begin_layout Description
24867 \begin_inset Flex Code
24870 \begin_layout Plain Layout
24876 CSS style information to be included when this style is used.
24877 Note that this will automatically be wrapped in a layout-generated
24878 \begin_inset Flex Code
24881 \begin_layout Plain Layout
24887 block, so only the CSS itself need be included.
24890 \begin_layout Description
24891 \begin_inset Flex Code
24894 \begin_layout Plain Layout
24901 \begin_inset Flex Code
24904 \begin_layout Plain Layout
24910 ] The tag to be used for the main label, replacing
24911 \begin_inset Flex Code
24914 \begin_layout Plain Layout
24920 in the examples above.
24921 The default depends upon the setting of
24922 \begin_inset Flex Code
24925 \begin_layout Plain Layout
24932 \begin_inset Flex Code
24935 \begin_layout Plain Layout
24941 is true, the default is
24942 \begin_inset Flex Code
24945 \begin_layout Plain Layout
24951 ; if it is false, the default is
24952 \begin_inset Flex Code
24955 \begin_layout Plain Layout
24964 \begin_layout Subsection
24968 \begin_layout Standard
24969 The XHTML output for floats too can be controlled by layout information.
24970 The output has the following form:
24973 \begin_layout LyX-Code
24975 \begin_inset Quotes erd
24979 \begin_inset Quotes erd
24985 \begin_layout LyX-Code
24986 Contents of the float.
24989 \begin_layout LyX-Code
24993 \begin_layout Standard
24994 The caption, if there is one, is a separate inset and will be output as
24996 Its appearance can be controlled via the InsetLayout for caption insets.
25000 \begin_layout Description
25001 \begin_inset Flex Code
25004 \begin_layout Plain Layout
25011 \begin_inset Flex Code
25014 \begin_layout Plain Layout
25020 ] Specifies attribute information to be output with the main tag.
25022 \begin_inset Quotes eld
25026 \begin_inset Flex Code
25029 \begin_layout Plain Layout
25030 class=`myfloat' onclick=`\SpecialChar ldots
25037 \begin_inset Quotes erd
25041 By default, \SpecialChar LyX
25043 \begin_inset Quotes eld
25047 \begin_inset Flex Code
25050 \begin_layout Plain Layout
25051 class=`float float-floattype'
25057 \begin_inset Quotes erd
25061 \begin_inset Flex Code
25064 \begin_layout Plain Layout
25070 is \SpecialChar LyX
25071 's name for this type of float, as determined by the float declaration
25073 \begin_inset CommandInset ref
25075 reference "subsec:Floats"
25079 ), though made lowercase and with non-alphanumeric characters converted
25080 to underscores, for example: float-table.
25083 \begin_layout Description
25084 \begin_inset Flex Code
25087 \begin_layout Plain Layout
25093 CSS style information to be included when this float is used.
25094 Note that this will automatically be wrapped in a layout-generated
25095 \begin_inset Flex Code
25098 \begin_layout Plain Layout
25104 block, so only the CSS itself need be included.
25107 \begin_layout Description
25108 \begin_inset Flex Code
25111 \begin_layout Plain Layout
25118 \begin_inset Flex Code
25121 \begin_layout Plain Layout
25127 ] The tag to be used for this float, replacing
25128 \begin_inset Quotes eld
25132 \begin_inset Flex Code
25135 \begin_layout Plain Layout
25142 \begin_inset Quotes erd
25145 in the example above.
25147 \begin_inset Flex Code
25150 \begin_layout Plain Layout
25156 and will rarely need changing.
25159 \begin_layout Subsection
25160 Bibliography formatting
25163 \begin_layout Standard
25164 The bibliography can be formatted using
25165 \begin_inset Flex Code
25168 \begin_layout Plain Layout
25176 \begin_inset CommandInset ref
25178 reference "subsec:Citation-format-description"
25185 \begin_layout Subsection
25190 \begin_layout Standard
25191 We have several times mentioned that \SpecialChar LyX
25192 will generate default CSS style rules
25193 for both insets and paragraph styles, based upon the other layout information
25195 In this section, we shall say a word about which layout information \SpecialChar LyX
25200 \begin_layout Standard
25201 At present, \SpecialChar LyX
25202 auto-generates CSS only for font information, making use of
25204 \begin_inset Flex Code
25207 \begin_layout Plain Layout
25214 \begin_inset Flex Code
25217 \begin_layout Plain Layout
25224 \begin_inset Flex Code
25227 \begin_layout Plain Layout
25234 \begin_inset Flex Code
25237 \begin_layout Plain Layout
25244 \begin_inset Flex Code
25247 \begin_layout Plain Layout
25254 \begin_inset CommandInset ref
25256 reference "subsec:Font-description"
25261 The translation is mostly straightforward and obvious.
25263 \begin_inset Quotes eld
25267 \begin_inset Flex Code
25270 \begin_layout Plain Layout
25277 \begin_inset Quotes erd
25281 \begin_inset Quotes eld
25285 \begin_inset Flex Code
25288 \begin_layout Plain Layout
25289 font-family: sans-serif;
25295 \begin_inset Quotes erd
25299 The correspondence of \SpecialChar LyX
25300 sizes and CSS sizes is a little less obvious but
25301 nonetheless intuitive.
25303 \begin_inset Flex Code
25306 \begin_layout Plain Layout
25313 \begin_inset Flex URL
25316 \begin_layout Plain Layout
25326 \begin_layout Chapter
25327 Including External Material
25328 \begin_inset CommandInset label
25330 name "chap:Including-External-Material"
25337 \begin_layout Standard
25338 \begin_inset Box Shadowbox
25348 height_special "totalheight"
25353 backgroundcolor "none"
25356 \begin_layout Plain Layout
25357 WARNING: This portion of the documentation has not been updated for some
25359 We certainly hope that it is still accurate, but there are no guarantees.
25367 \begin_layout Standard
25368 The use of material from sources external to \SpecialChar LyX
25369 is covered in detail in the
25375 This part of the manual covers what needs to happen behind the scenes for
25376 new sorts of material to be included.
25379 \begin_layout Section
25383 \begin_layout Standard
25384 The external material feature is based on the concept of a
25389 A template is a specification of how \SpecialChar LyX
25390 should interface with a certain kind
25392 As bundled, \SpecialChar LyX
25393 comes with predefined templates for Xfig figures, various
25394 raster format images, chess diagrams, and LilyPond music notation.
25395 You can check the actual list by using the menu
25396 \begin_inset Flex Noun
25399 \begin_layout Plain Layout
25400 Insert\SpecialChar menuseparator
25401 File\SpecialChar menuseparator
25408 Furthermore, it is possible to roll your own template to support a specific
25410 Later we'll describe in more detail what is involved, and hopefully you
25411 will submit all the templates you create so we can include them in a later
25416 \begin_layout Standard
25417 Another basic idea of the external material feature is to distinguish between
25418 the original file that serves as a base for final material and the produced
25419 file that is included in your exported or printed document.
25420 For example, consider the case of a figure produced with
25421 \begin_inset Flex Code
25424 \begin_layout Plain Layout
25431 The Xfig application itself works on an original file with the
25432 \begin_inset Flex Code
25435 \begin_layout Plain Layout
25442 Within Xfig, you create and change your figure, and when you are done,
25444 \begin_inset Flex Code
25447 \begin_layout Plain Layout
25454 When you want to include the figure in your document, you invoke
25455 \begin_inset Flex Code
25458 \begin_layout Plain Layout
25464 in order to create a PostScript file that can readily be included in your
25468 \begin_inset Flex Code
25471 \begin_layout Plain Layout
25477 file is the original file, and the PostScript file is the produced file.
25480 \begin_layout Standard
25481 This distinction is important in order to allow updating of the material
25482 while you are in the process of writing the document.
25483 Furthermore, it provides us with the flexibility that is needed to support
25484 multiple export formats.
25485 For instance, in the case of a plain text file, it is not exactly an award-winn
25486 ing idea to include the figure as raw PostScript.
25487 Instead, you would either prefer to just include a reference to the figure
25488 or try to invoke some graphics to ASCII converter to make the final result
25489 look similar to the real graphics.
25490 The external material management allows you to do this, because it is parametri
25491 zed on the different export formats that \SpecialChar LyX
25495 \begin_layout Standard
25496 Besides supporting the production of different products according to the
25497 exported format, it supports tight integration with editing and viewing
25499 In the case of an Xfig figure, you are able to invoke Xfig on the original
25500 file with a single click from within the external material dialog in \SpecialChar LyX
25502 and also preview the produced PostScript file with Ghostview with another
25504 No more fiddling around with the command line and/or file browsers to locate
25505 and manipulate the original or produced files.
25506 In this way, you are finally able to take full advantage of the many different
25507 applications that are relevant to use when you write your documents, and
25508 ultimately be more productive.
25511 \begin_layout Section
25512 The external template configuration files
25515 \begin_layout Standard
25516 It is relatively easy to add custom external template definitions to \SpecialChar LyX
25518 However, be aware that doing this in an careless manner most probably
25522 introduce an easily exploitable security hole.
25523 So before you do this, please read the discussion about security in
25524 \begin_inset CommandInset ref
25526 reference "sec:Security-discussion"
25533 \begin_layout Standard
25534 Having said that, we encourage you to submit any interesting templates that
25539 \begin_layout Standard
25540 The external templates are defined in the
25541 \begin_inset Flex Code
25544 \begin_layout Plain Layout
25550 files that are stored in the
25551 \begin_inset Flex Code
25554 \begin_layout Plain Layout
25555 LyXDir/lib/xtemplates/
25561 Each template is defined in a file of its own.
25562 You can place your own templates in
25563 \begin_inset Flex Code
25566 \begin_layout Plain Layout
25567 UserDir/xtemplates/
25572 or copy existing templates to that directory in order to modify them.
25575 \begin_layout Standard
25576 A typical template looks like this:
25579 \begin_layout LyX-Code
25583 \begin_layout LyX-Code
25584 GuiName "XFig: $$AbsOrRelPathParent$$Basename"
25587 \begin_layout LyX-Code
25591 \begin_layout LyX-Code
25595 \begin_layout LyX-Code
25599 \begin_layout LyX-Code
25603 \begin_layout LyX-Code
25607 \begin_layout LyX-Code
25608 AutomaticProduction true
25611 \begin_layout LyX-Code
25615 \begin_layout LyX-Code
25619 \begin_layout LyX-Code
25623 \begin_layout LyX-Code
25624 TransformCommand Rotate RotationLatexCommand
25627 \begin_layout LyX-Code
25628 TransformCommand Resize ResizeLatexCommand
25631 \begin_layout LyX-Code
25632 Product "$$RotateFront$$ResizeFront
25635 \begin_layout LyX-Code
25640 input{$$AbsOrRelPathMaster$$Basename.pstex_t}
25643 \begin_layout LyX-Code
25644 $$ResizeBack$$RotateBack"
25647 \begin_layout LyX-Code
25651 \begin_layout LyX-Code
25652 UpdateResult "$$AbsPath$$Basename.pstex_t"
25655 \begin_layout LyX-Code
25656 Requirement "graphicx"
25659 \begin_layout LyX-Code
25660 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
25663 \begin_layout LyX-Code
25664 ReferencedFile latex "$$AbsPath$$Basename.eps"
25667 \begin_layout LyX-Code
25668 ReferencedFile dvi "$$AbsPath$$Basename.eps"
25671 \begin_layout LyX-Code
25675 \begin_layout LyX-Code
25679 \begin_layout LyX-Code
25680 TransformCommand Rotate RotationLatexCommand
25683 \begin_layout LyX-Code
25684 TransformCommand Resize ResizeLatexCommand
25687 \begin_layout LyX-Code
25688 Product "$$RotateFront$$ResizeFront
25691 \begin_layout LyX-Code
25696 input{$$AbsOrRelPathMaster$$Basename.pdftex_t}
25699 \begin_layout LyX-Code
25700 $$ResizeBack$$RotateBack"
25703 \begin_layout LyX-Code
25704 UpdateFormat pdftex
25707 \begin_layout LyX-Code
25708 UpdateResult "$$AbsPath$$Basename.pdftex_t"
25711 \begin_layout LyX-Code
25712 Requirement "graphicx"
25715 \begin_layout LyX-Code
25716 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pdftex_t"
25719 \begin_layout LyX-Code
25720 ReferencedFile latex "$$AbsPath$$Basename.pdf"
25723 \begin_layout LyX-Code
25727 \begin_layout LyX-Code
25731 \begin_layout LyX-Code
25732 Product "[XFig: $$FName]"
25735 \begin_layout LyX-Code
25739 \begin_layout LyX-Code
25743 \begin_layout LyX-Code
25744 Product "<graphic fileref=
25746 "$$AbsOrRelPathMaster$$Basename.eps
25751 \begin_layout LyX-Code
25755 \begin_layout LyX-Code
25759 \begin_layout LyX-Code
25760 UpdateResult "$$AbsPath$$Basename.eps"
25763 \begin_layout LyX-Code
25764 ReferencedFile docbook "$$AbsPath$$Basename.eps"
25767 \begin_layout LyX-Code
25768 ReferencedFile docbook-xml "$$AbsPath$$Basename.eps"
25771 \begin_layout LyX-Code
25775 \begin_layout LyX-Code
25779 \begin_layout Standard
25780 As you can see, the template is enclosed in
25781 \begin_inset Flex Code
25784 \begin_layout Plain Layout
25792 \begin_inset Flex Code
25795 \begin_layout Plain Layout
25802 It contains a header specifying some general settings and, for each supported
25803 primary document file format, a section
25804 \begin_inset Flex Code
25807 \begin_layout Plain Layout
25815 \begin_inset Flex Code
25818 \begin_layout Plain Layout
25827 \begin_layout Subsection
25828 The template header
25831 \begin_layout Description
25832 \begin_inset Flex Code
25835 \begin_layout Plain Layout
25836 AutomaticProduction
25837 \begin_inset space ~
25845 Whether the file represented by the template must be generated by \SpecialChar LyX
25847 This command must occur exactly once.
25850 \begin_layout Description
25851 \begin_inset Flex Code
25854 \begin_layout Plain Layout
25856 \begin_inset space ~
25864 A glob pattern that is used in the file dialog to filter out the desired
25866 If there is more than one possible file extension (e.
25867 \begin_inset space \thinspace{}
25871 \begin_inset space \space{}
25875 \begin_inset Flex Code
25878 \begin_layout Plain Layout
25885 \begin_inset Flex Code
25888 \begin_layout Plain Layout
25894 ), use something like
25895 \begin_inset Flex Code
25898 \begin_layout Plain Layout
25905 This command must occur exactly once.
25908 \begin_layout Description
25909 \begin_inset Flex Code
25912 \begin_layout Plain Layout
25914 \begin_inset space ~
25922 The text that is displayed on the button.
25923 This command must occur exactly once.
25926 \begin_layout Description
25927 \begin_inset Flex Code
25930 \begin_layout Plain Layout
25932 \begin_inset space ~
25936 \begin_inset space ~
25944 The help text that is used in the External dialog.
25945 Provide enough information to explain to the user just what the template
25946 can provide him with.
25947 This command must occur exactly once.
25950 \begin_layout Description
25951 \begin_inset Flex Code
25954 \begin_layout Plain Layout
25956 \begin_inset space ~
25964 The file format of the original file.
25965 This must be the name of a format that is known to \SpecialChar LyX
25967 \begin_inset CommandInset ref
25969 reference "sec:Formats"
25975 \begin_inset Quotes eld
25979 \begin_inset Flex Code
25982 \begin_layout Plain Layout
25989 \begin_inset Quotes erd
25992 if the template can handle original files of more than one format.
25994 will attempt to interrogate the file itself in order to deduce its format
25996 This command must occur exactly once.
25999 \begin_layout Description
26000 \begin_inset Flex Code
26003 \begin_layout Plain Layout
26005 \begin_inset space ~
26013 A unique name for the template.
26014 It must not contain substitution macros (see below).
26017 \begin_layout Description
26018 \begin_inset Flex Code
26021 \begin_layout Plain Layout
26023 \begin_inset space ~
26026 Rotate|Resize|Clip|Extra
26031 This command specifies which transformations are supported by this template.
26032 It may occur zero or more times.
26033 This command enables the corresponding tabs in the external dialog.
26035 \begin_inset Flex Code
26038 \begin_layout Plain Layout
26044 command must have either a corresponding
26045 \begin_inset Flex Code
26048 \begin_layout Plain Layout
26055 \begin_inset Flex Code
26058 \begin_layout Plain Layout
26065 \begin_inset Flex Code
26068 \begin_layout Plain Layout
26075 Otherwise the transformation will not be supported by that format.
26078 \begin_layout Subsection
26082 \begin_layout Description
26083 \begin_inset Flex Code
26086 \begin_layout Plain Layout
26088 \begin_inset space ~
26091 LaTeX|PDFLaTeX|PlainText|DocBook|XHTML
26096 The primary document file format that this format definition is for.
26097 Not every template has a sensible representation in all document file formats.
26098 Please define nevertheless a
26099 \begin_inset Flex Code
26102 \begin_layout Plain Layout
26108 section for all templates.
26109 Use a dummy text when no representation is available.
26110 Then you can at least see a reference to the external material in the exported
26114 \begin_layout Description
26115 \begin_inset Flex Code
26118 \begin_layout Plain Layout
26120 \begin_inset space ~
26124 \begin_inset space ~
26132 This command defines an additional macro
26133 \begin_inset Flex Code
26136 \begin_layout Plain Layout
26142 for substitution in
26143 \begin_inset Flex Code
26146 \begin_layout Plain Layout
26154 \begin_inset Flex Code
26157 \begin_layout Plain Layout
26163 itself may contain substitution macros.
26164 The advantage over using
26165 \begin_inset Flex Code
26168 \begin_layout Plain Layout
26175 \begin_inset Flex Code
26178 \begin_layout Plain Layout
26184 is that the substituted value of
26185 \begin_inset Flex Code
26188 \begin_layout Plain Layout
26194 is sanitized so that it is a valid optional argument in the document format.
26195 This command may occur zero or more times.
26198 \begin_layout Description
26199 \begin_inset Flex Code
26202 \begin_layout Plain Layout
26204 \begin_inset space ~
26212 The text that is inserted in the exported document.
26213 This is actually the most important command and can be quite complex.
26214 This command must occur exactly once.
26217 \begin_layout Description
26218 \begin_inset Flex Code
26221 \begin_layout Plain Layout
26223 \begin_inset space ~
26231 This command specifies a preamble snippet that will be included in the
26234 It has to be defined using
26235 \begin_inset Flex Code
26238 \begin_layout Plain Layout
26246 \begin_inset Flex Code
26249 \begin_layout Plain Layout
26256 This command may occur zero or more times.
26259 \begin_layout Description
26260 \begin_inset Flex Code
26263 \begin_layout Plain Layout
26265 \begin_inset space ~
26269 \begin_inset space ~
26277 This command denotes files that are created by the conversion process and
26278 are needed for a particular export format.
26279 If the filename is relative, it is interpreted relative to the master document.
26280 This command may be given zero or more times.
26283 \begin_layout Description
26284 \begin_inset Flex Code
26287 \begin_layout Plain Layout
26289 \begin_inset space ~
26297 The name of a required \SpecialChar LaTeX
26299 The package is included via
26300 \begin_inset Flex Code
26303 \begin_layout Plain Layout
26311 in the \SpecialChar LaTeX
26313 This command may occur zero or more times.
26316 \begin_layout Description
26317 \begin_inset Flex Code
26320 \begin_layout Plain Layout
26322 \begin_inset space ~
26326 \begin_inset space ~
26329 RotationLatexCommand
26334 This command specifies that the built in \SpecialChar LaTeX
26335 command should be used for rotation.
26336 This command may occur once or not at all.
26339 \begin_layout Description
26340 \begin_inset Flex Code
26343 \begin_layout Plain Layout
26345 \begin_inset space ~
26349 \begin_inset space ~
26357 This command specifies that the built in \SpecialChar LaTeX
26358 command should be used for resizing.
26359 This command may occur once or not at all.
26362 \begin_layout Description
26363 \begin_inset Flex Code
26366 \begin_layout Plain Layout
26368 \begin_inset space ~
26372 \begin_inset space ~
26375 RotationLatexOption
26380 This command specifies that rotation is done via an optional argument.
26381 This command may occur once or not at all.
26384 \begin_layout Description
26385 \begin_inset Flex Code
26388 \begin_layout Plain Layout
26390 \begin_inset space ~
26394 \begin_inset space ~
26402 This command specifies that resizing is done via an optional argument.
26403 This command may occur once or not at all.
26406 \begin_layout Description
26407 \begin_inset Flex Code
26410 \begin_layout Plain Layout
26412 \begin_inset space ~
26416 \begin_inset space ~
26424 This command specifies that clipping is done via an optional argument.
26425 This command may occur once or not at all.
26428 \begin_layout Description
26429 \begin_inset Flex Code
26432 \begin_layout Plain Layout
26434 \begin_inset space ~
26438 \begin_inset space ~
26446 This command specifies that an extra optional argument is used.
26447 This command may occur once or not at all.
26450 \begin_layout Description
26451 \begin_inset Flex Code
26454 \begin_layout Plain Layout
26456 \begin_inset space ~
26464 The file format of the converted file.
26465 This must be the name of a format that is known to \SpecialChar LyX
26467 \begin_inset Flex Noun
26470 \begin_layout Plain Layout
26471 Tools\SpecialChar menuseparator
26472 Preferences\SpecialChar menuseparator
26473 File Handling\SpecialChar menuseparator
26480 This command must occur exactly once.
26481 If the resulting file format is PDF, you need to specify the format
26482 \begin_inset Flex Code
26485 \begin_layout Plain Layout
26492 This is the PDF format used for including graphics.
26493 The other defined PDF formats are for document export.
26496 \begin_layout Description
26497 \begin_inset Flex Code
26500 \begin_layout Plain Layout
26502 \begin_inset space ~
26510 The file name of the converted file.
26511 The file name must be absolute.
26512 This command must occur exactly once.
26515 \begin_layout Subsection
26516 Preamble definitions
26519 \begin_layout Standard
26520 The external template configuration file may contain additional preamble
26521 definitions enclosed by
26522 \begin_inset Flex Code
26525 \begin_layout Plain Layout
26533 \begin_inset Flex Code
26536 \begin_layout Plain Layout
26543 They can be used by the templates in the
26544 \begin_inset Flex Code
26547 \begin_layout Plain Layout
26556 \begin_layout Section
26557 The substitution mechanism
26560 \begin_layout Standard
26561 When the external material facility invokes an external program, it is done
26562 on the basis of a command defined in the template configuration file.
26563 These commands can contain various macros that are expanded before execution.
26564 Execution always take place in the directory of the containing document.
26567 \begin_layout Standard
26568 Also, whenever external material is to be displayed, the name will be produced
26569 by the substitution mechanism, and most other commands in the template
26570 definition support substitution as well.
26573 \begin_layout Standard
26574 The available macros are the following:
26577 \begin_layout Description
26578 \begin_inset Flex Code
26581 \begin_layout Plain Layout
26582 $$AbsOrRelPathMaster
26587 The file path, absolute or relative to the master \SpecialChar LyX
26591 \begin_layout Description
26592 \begin_inset Flex Code
26595 \begin_layout Plain Layout
26596 $$AbsOrRelPathParent
26601 The file path, absolute or relative to the \SpecialChar LyX
26605 \begin_layout Description
26606 \begin_inset Flex Code
26609 \begin_layout Plain Layout
26615 The absolute file path.
26618 \begin_layout Description
26619 \begin_inset Flex Code
26622 \begin_layout Plain Layout
26628 The filename without path and without the extension.
26631 \begin_layout Description
26632 \begin_inset Flex Code
26635 \begin_layout Plain Layout
26637 \begin_inset Quotes eld
26641 \begin_inset Quotes erd
26649 This macro will expand to the contents of the file with the name
26650 \begin_inset Flex Code
26653 \begin_layout Plain Layout
26662 \begin_layout Description
26663 \begin_inset Flex Code
26666 \begin_layout Plain Layout
26672 The file extension (including the dot).
26675 \begin_layout Description
26676 \begin_inset Flex Code
26679 \begin_layout Plain Layout
26685 This will be the string
26686 \begin_inset Quotes eld
26690 \begin_inset Quotes erd
26693 if the file is in JPEG format, otherwise it will be the string
26694 \begin_inset Quotes eld
26698 \begin_inset Quotes erd
26702 This is useful to avoid uneeded conversions for output formats that support
26703 both PNG and JPEG fomats.
26704 The predefined RasterImage template uses this macro for the pdf\SpecialChar TeX
26709 \begin_layout Description
26710 \begin_inset Flex Code
26713 \begin_layout Plain Layout
26719 The filename of the file specified in the external material dialog.
26720 This is either an absolute name, or it is relative to the \SpecialChar LyX
26724 \begin_layout Description
26725 \begin_inset Flex Code
26728 \begin_layout Plain Layout
26735 \begin_inset Flex Code
26738 \begin_layout Plain Layout
26744 (absolute name or relative to the \SpecialChar LyX
26748 \begin_layout Description
26749 \begin_inset Flex Code
26752 \begin_layout Plain Layout
26758 The file path, relative to the master \SpecialChar LyX
26762 \begin_layout Description
26763 \begin_inset Flex Code
26766 \begin_layout Plain Layout
26772 The file path, relative to the \SpecialChar LyX
26776 \begin_layout Description
26777 \begin_inset Flex Code
26780 \begin_layout Plain Layout
26786 This macro will expand to the absolute path of the system directory.
26787 This is typically used to point to the various helper scripts that are
26788 bundled with \SpecialChar LyX
26792 \begin_layout Description
26793 \begin_inset Flex Code
26796 \begin_layout Plain Layout
26802 A name and full path to a temporary file which will be automatically deleted
26803 whenever the containing document is closed, or the external material insertion
26807 \begin_layout Standard
26808 All path macros contain a trailing directory separator, so you can construct
26810 \begin_inset space \thinspace{}
26814 \begin_inset space \space{}
26817 the absolute filename with
26818 \begin_inset Flex Code
26821 \begin_layout Plain Layout
26822 $$AbsPath$$Basename$$Extension
26830 \begin_layout Standard
26831 The macros above are substituted in all commands unless otherwise noted.
26833 \begin_inset Flex Code
26836 \begin_layout Plain Layout
26842 supports additionally the following substitutions if they are enabled by
26844 \begin_inset Flex Code
26847 \begin_layout Plain Layout
26854 \begin_inset Flex Code
26857 \begin_layout Plain Layout
26866 \begin_layout Description
26867 \begin_inset Flex Code
26870 \begin_layout Plain Layout
26876 The front part of the resize command.
26879 \begin_layout Description
26880 \begin_inset Flex Code
26883 \begin_layout Plain Layout
26889 The back part of the resize command.
26892 \begin_layout Description
26893 \begin_inset Flex Code
26896 \begin_layout Plain Layout
26902 The front part of the rotation command.
26905 \begin_layout Description
26906 \begin_inset Flex Code
26909 \begin_layout Plain Layout
26915 The back part of the rotation command.
26918 \begin_layout Standard
26919 The value string of the
26920 \begin_inset Flex Code
26923 \begin_layout Plain Layout
26929 command supports additionally the following substitutions if they are enabled
26931 \begin_inset Flex Code
26934 \begin_layout Plain Layout
26941 \begin_inset Flex Code
26944 \begin_layout Plain Layout
26953 \begin_layout Description
26954 \begin_inset Flex Code
26957 \begin_layout Plain Layout
26966 \begin_layout Description
26967 \begin_inset Flex Code
26970 \begin_layout Plain Layout
26979 \begin_layout Description
26980 \begin_inset Flex Code
26983 \begin_layout Plain Layout
26992 \begin_layout Description
26993 \begin_inset Flex Code
26996 \begin_layout Plain Layout
27002 The rotation option.
27005 \begin_layout Standard
27006 You may ask why there are so many path macros.
27007 There are mainly two reasons:
27010 \begin_layout Enumerate
27011 Relative and absolute file names should remain relative or absolute, respectivel
27013 Users may have reasons to prefer either form.
27014 Relative names are useful for portable documents that should work on different
27015 machines, for example.
27016 Absolute names may be required by some programs.
27019 \begin_layout Enumerate
27021 treats relative file names differently than \SpecialChar LyX
27022 and other programs in nested
27024 For \SpecialChar LyX
27025 , a relative file name is always relative to the document that contains
27027 For \SpecialChar LaTeX
27028 , it is always relative to the master document.
27029 These two definitions are identical if you have only one document, but
27030 differ if you have a master document that includes part documents.
27031 That means that relative filenames must be transformed when presented to
27034 Fortunately \SpecialChar LyX
27035 does this automatically for you if you choose the right macros.
27038 \begin_layout Standard
27039 So which path macro should be used in new template definitions? The rule
27043 \begin_layout Itemize
27045 \begin_inset Flex Code
27048 \begin_layout Plain Layout
27054 if an absolute path is required.
27057 \begin_layout Itemize
27059 \begin_inset Flex Code
27062 \begin_layout Plain Layout
27063 $$AbsOrRelPathMaster
27068 if the substituted string is some kind of \SpecialChar LaTeX
27072 \begin_layout Itemize
27074 \begin_inset Flex Code
27077 \begin_layout Plain Layout
27078 $$AbsOrRelPathParent
27083 in order to preserve the user's choice.
27086 \begin_layout Standard
27087 There are special cases where this rule does not work and e.
27088 \begin_inset space \thinspace{}
27092 \begin_inset space \space{}
27095 relative names are needed, but normally it will work just fine.
27096 One example for such a case is the command
27097 \begin_inset Flex Code
27100 \begin_layout Plain Layout
27101 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
27106 in the XFig template above: We can't use the absolute name because the
27108 \begin_inset Flex Code
27111 \begin_layout Plain Layout
27117 files needs the relative name in order to rewrite the file content.
27120 \begin_layout Section
27121 Security discussion
27122 \begin_inset CommandInset label
27124 name "sec:Security-discussion"
27131 \begin_layout Standard
27132 The external material feature interfaces with a lot of external programs
27133 and does so automatically, so we have to consider the security implications
27135 In particular, since you have the option of including your own filenames
27136 and/or parameter strings and those are expanded into a command, it seems
27137 that it would be possible to create a malicious document which executes
27138 arbitrary commands when a user views or prints the document.
27139 This is something we definitely want to avoid.
27142 \begin_layout Standard
27143 However, since the external program commands are specified in the template
27144 configuration file only, there are no security issues if \SpecialChar LyX
27145 is properly configure
27146 d with safe templates only.
27147 This is so because the external programs are invoked with the
27148 \begin_inset Flex Code
27151 \begin_layout Plain Layout
27157 -system call rather than the
27158 \begin_inset Flex Code
27161 \begin_layout Plain Layout
27167 system-call, so it's not possible to execute arbitrary commands from the
27168 filename or parameter section via the shell.
27171 \begin_layout Standard
27172 This also implies that you are restricted in what command strings you can
27173 use in the external material templates.
27174 In particular, pipes and redirection are not readily available.
27175 This has to be so if \SpecialChar LyX
27176 should remain safe.
27177 If you want to use some of the shell features, you should write a safe
27178 script to do this in a controlled manner, and then invoke the script from
27179 the command string.
27183 \begin_layout Standard
27184 It is possible to design a template that interacts directly with the shell,
27185 but since this would allow a malicious user to execute arbitrary commands
27186 by writing clever filenames and/or parameters, we generally recommend that
27187 you only use safe scripts that work with the
27188 \begin_inset Flex Code
27191 \begin_layout Plain Layout
27197 system call in a controlled manner.
27198 Of course, for use in a controlled environment, it can be tempting to just
27199 fall back to use ordinary shell scripts.
27200 If you do so, be aware that you
27204 provide an easily exploitable security hole in your system.
27205 Of course it stands to reason that such unsafe templates will never be
27206 included in the standard \SpecialChar LyX
27207 distribution, although we do encourage people
27208 to submit new templates in the open source tradition.
27209 But \SpecialChar LyX
27210 as shipped from the official distribution channels will never have
27214 \begin_layout Standard
27215 Including external material provides a lot of power, and you have to be
27216 careful not to introduce security hazards with this power.
27217 A subtle error in a single line in an innocent looking script can open
27218 the door to huge security problems.
27219 So if you do not fully understand the issues, we recommend that you consult
27220 a knowledgeable security professional or the \SpecialChar LyX
27221 development team if you have
27222 any questions about whether a given template is safe or not.
27223 And do this before you use it in an uncontrolled environment.
27226 \begin_layout Chapter
27228 List of supported \SpecialChar LyX
27229 functions to be used in layouts
27230 \begin_inset CommandInset label
27232 name "chap:List-of-functions"
27239 \begin_layout Standard
27241 \begin_inset Tabular
27242 <lyxtabular version="3" rows="11" columns="8">
27243 <features tabularvalignment="middle">
27244 <column alignment="left" valignment="top">
27245 <column alignment="left" valignment="top">
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">
27253 <cell alignment="left" valignment="top" usebox="none">
27256 \begin_layout Plain Layout
27262 <cell alignment="left" valignment="top" usebox="none">
27265 \begin_layout Plain Layout
27271 <cell alignment="left" valignment="top" usebox="none">
27274 \begin_layout Plain Layout
27280 <cell alignment="left" valignment="top" usebox="none">
27283 \begin_layout Plain Layout
27289 <cell alignment="center" valignment="top" usebox="none">
27292 \begin_layout Plain Layout
27298 <cell alignment="center" valignment="top" usebox="none">
27301 \begin_layout Plain Layout
27307 <cell alignment="center" valignment="top" usebox="none">
27310 \begin_layout Plain Layout
27316 <cell alignment="center" valignment="top" usebox="none">
27319 \begin_layout Plain Layout
27327 <cell alignment="left" valignment="top" usebox="none">
27330 \begin_layout Plain Layout
27336 <cell alignment="left" valignment="top" usebox="none">
27339 \begin_layout Plain Layout
27345 <cell alignment="left" valignment="top" usebox="none">
27348 \begin_layout Plain Layout
27354 <cell alignment="left" valignment="top" usebox="none">
27357 \begin_layout Plain Layout
27363 <cell alignment="center" valignment="top" usebox="none">
27366 \begin_layout Plain Layout
27372 <cell alignment="center" valignment="top" usebox="none">
27375 \begin_layout Plain Layout
27381 <cell alignment="center" valignment="top" usebox="none">
27384 \begin_layout Plain Layout
27390 <cell alignment="center" valignment="top" usebox="none">
27393 \begin_layout Plain Layout
27401 <cell alignment="left" valignment="top" usebox="none">
27404 \begin_layout Plain Layout
27410 <cell alignment="left" valignment="top" usebox="none">
27413 \begin_layout Plain Layout
27419 <cell alignment="left" valignment="top" usebox="none">
27422 \begin_layout Plain Layout
27428 <cell alignment="left" valignment="top" usebox="none">
27431 \begin_layout Plain Layout
27437 <cell alignment="center" valignment="top" usebox="none">
27440 \begin_layout Plain Layout
27446 <cell alignment="center" valignment="top" usebox="none">
27449 \begin_layout Plain Layout
27455 <cell alignment="center" valignment="top" usebox="none">
27458 \begin_layout Plain Layout
27464 <cell alignment="center" valignment="top" usebox="none">
27467 \begin_layout Plain Layout
27475 <cell alignment="left" valignment="top" usebox="none">
27478 \begin_layout Plain Layout
27484 <cell alignment="left" valignment="top" usebox="none">
27487 \begin_layout Plain Layout
27493 <cell alignment="left" valignment="top" usebox="none">
27496 \begin_layout Plain Layout
27502 <cell alignment="left" valignment="top" usebox="none">
27505 \begin_layout Plain Layout
27511 <cell alignment="center" valignment="top" usebox="none">
27514 \begin_layout Plain Layout
27520 <cell alignment="center" valignment="top" usebox="none">
27523 \begin_layout Plain Layout
27529 <cell alignment="center" valignment="top" usebox="none">
27532 \begin_layout Plain Layout
27538 <cell alignment="center" valignment="top" usebox="none">
27541 \begin_layout Plain Layout
27549 <cell alignment="left" valignment="top" usebox="none">
27552 \begin_layout Plain Layout
27558 <cell alignment="left" valignment="top" usebox="none">
27561 \begin_layout Plain Layout
27567 <cell alignment="left" valignment="top" usebox="none">
27570 \begin_layout Plain Layout
27576 <cell alignment="left" valignment="top" usebox="none">
27579 \begin_layout Plain Layout
27585 <cell alignment="center" valignment="top" usebox="none">
27588 \begin_layout Plain Layout
27594 <cell alignment="center" valignment="top" usebox="none">
27597 \begin_layout Plain Layout
27603 <cell alignment="center" valignment="top" usebox="none">
27606 \begin_layout Plain Layout
27612 <cell alignment="center" valignment="top" usebox="none">
27615 \begin_layout Plain Layout
27623 <cell alignment="left" valignment="top" usebox="none">
27626 \begin_layout Plain Layout
27632 <cell alignment="left" valignment="top" usebox="none">
27635 \begin_layout Plain Layout
27641 <cell alignment="left" valignment="top" usebox="none">
27644 \begin_layout Plain Layout
27650 <cell alignment="left" valignment="top" usebox="none">
27653 \begin_layout Plain Layout
27659 <cell alignment="center" valignment="top" usebox="none">
27662 \begin_layout Plain Layout
27668 <cell alignment="center" valignment="top" usebox="none">
27671 \begin_layout Plain Layout
27677 <cell alignment="center" valignment="top" usebox="none">
27680 \begin_layout Plain Layout
27686 <cell alignment="center" valignment="top" usebox="none">
27689 \begin_layout Plain Layout
27697 <cell alignment="left" valignment="top" usebox="none">
27700 \begin_layout Plain Layout
27706 <cell alignment="left" valignment="top" usebox="none">
27709 \begin_layout Plain Layout
27715 <cell alignment="left" valignment="top" usebox="none">
27718 \begin_layout Plain Layout
27724 <cell alignment="left" valignment="top" usebox="none">
27727 \begin_layout Plain Layout
27733 <cell alignment="center" valignment="top" usebox="none">
27736 \begin_layout Plain Layout
27742 <cell alignment="center" valignment="top" usebox="none">
27745 \begin_layout Plain Layout
27751 <cell alignment="center" valignment="top" usebox="none">
27754 \begin_layout Plain Layout
27760 <cell alignment="center" valignment="top" usebox="none">
27763 \begin_layout Plain Layout
27771 <cell alignment="left" valignment="top" usebox="none">
27774 \begin_layout Plain Layout
27780 <cell alignment="left" valignment="top" usebox="none">
27783 \begin_layout Plain Layout
27789 <cell alignment="left" valignment="top" usebox="none">
27792 \begin_layout Plain Layout
27798 <cell alignment="left" valignment="top" usebox="none">
27801 \begin_layout Plain Layout
27807 <cell alignment="center" valignment="top" usebox="none">
27810 \begin_layout Plain Layout
27816 <cell alignment="center" valignment="top" usebox="none">
27819 \begin_layout Plain Layout
27825 <cell alignment="center" valignment="top" usebox="none">
27828 \begin_layout Plain Layout
27834 <cell alignment="center" valignment="top" usebox="none">
27837 \begin_layout Plain Layout
27845 <cell alignment="left" valignment="top" usebox="none">
27848 \begin_layout Plain Layout
27854 <cell alignment="left" valignment="top" usebox="none">
27857 \begin_layout Plain Layout
27863 <cell alignment="left" valignment="top" usebox="none">
27866 \begin_layout Plain Layout
27872 <cell alignment="left" valignment="top" usebox="none">
27875 \begin_layout Plain Layout
27881 <cell alignment="center" valignment="top" usebox="none">
27884 \begin_layout Plain Layout
27890 <cell alignment="center" valignment="top" usebox="none">
27893 \begin_layout Plain Layout
27899 <cell alignment="center" valignment="top" usebox="none">
27902 \begin_layout Plain Layout
27908 <cell alignment="center" valignment="top" usebox="none">
27911 \begin_layout Plain Layout
27919 <cell alignment="left" valignment="top" usebox="none">
27922 \begin_layout Plain Layout
27928 <cell alignment="left" valignment="top" usebox="none">
27931 \begin_layout Plain Layout
27937 <cell alignment="left" valignment="top" usebox="none">
27940 \begin_layout Plain Layout
27946 <cell alignment="left" valignment="top" usebox="none">
27949 \begin_layout Plain Layout
27955 <cell alignment="center" valignment="top" usebox="none">
27958 \begin_layout Plain Layout
27964 <cell alignment="center" valignment="top" usebox="none">
27967 \begin_layout Plain Layout
27973 <cell alignment="center" valignment="top" usebox="none">
27976 \begin_layout Plain Layout
27982 <cell alignment="center" valignment="top" usebox="none">
27985 \begin_layout Plain Layout
27993 <cell alignment="center" valignment="top" usebox="none">
27996 \begin_layout Plain Layout
28002 <cell alignment="center" valignment="top" usebox="none">
28005 \begin_layout Plain Layout
28011 <cell alignment="center" valignment="top" usebox="none">
28014 \begin_layout Plain Layout
28020 <cell alignment="center" valignment="top" usebox="none">
28023 \begin_layout Plain Layout
28029 <cell alignment="center" valignment="top" usebox="none">
28032 \begin_layout Plain Layout
28038 <cell alignment="center" valignment="top" usebox="none">
28041 \begin_layout Plain Layout
28047 <cell alignment="center" valignment="top" usebox="none">
28050 \begin_layout Plain Layout
28056 <cell alignment="center" valignment="top" usebox="none">
28059 \begin_layout Plain Layout
28073 \begin_layout Chapter
28074 Names of available colors to be used in layouts
28075 \begin_inset CommandInset label
28077 name "chap:Names-of-colors"
28084 \begin_layout Standard
28085 The colors listed below are the standard colors and those that you can adjust
28086 in the \SpecialChar LyX
28090 \begin_layout Section
28094 \begin_layout Standard
28095 The following are no real colors, but rather act on color definitions:
28098 \begin_layout Description
28099 ignore The color is ignored
28102 \begin_layout Description
28103 inherit The color is inherited
28106 \begin_layout Description
28119 No particular color – clear or default
28122 \begin_layout Section
28126 \begin_layout Standard
28127 These are fixed colors that cannot me customized:
28130 \begin_layout Description
28134 \begin_layout Description
28138 \begin_layout Description
28142 \begin_layout Description
28146 \begin_layout Description
28150 \begin_layout Description
28154 \begin_layout Description
28158 \begin_layout Description
28162 \begin_layout Description
28166 \begin_layout Description
28170 \begin_layout Description
28174 \begin_layout Description
28178 \begin_layout Description
28182 \begin_layout Description
28186 \begin_layout Description
28190 \begin_layout Description
28194 \begin_layout Description
28198 \begin_layout Description
28202 \begin_layout Description
28206 \begin_layout Section
28210 \begin_layout Standard
28211 These are the colors allocated to specific elements in
28214 arg "dialog-show prefs"
28220 \begin_layout Description
28221 added_space Added space color
28224 \begin_layout Description
28225 addedtext Added text color
28228 \begin_layout Description
28229 appendix Appendix marker color
28232 \begin_layout Description
28233 background Background color
28236 \begin_layout Description
28237 bottomarea Bottom area color
28240 \begin_layout Description
28241 branchlabel Label color for branches
28244 \begin_layout Description
28245 buttonbg Color used for button background
28248 \begin_layout Description
28249 buttonframe Color for inset button frames
28252 \begin_layout Description
28253 buttonhoverbg Color used for button background under focus
28256 \begin_layout Description
28257 changebar Changebar color
28260 \begin_layout Description
28261 changedtextauthor1 Changed text color author 1
28264 \begin_layout Description
28265 changedtextauthor2 Changed text color author 2
28268 \begin_layout Description
28269 changedtextauthor3 Changed text color author 3
28272 \begin_layout Description
28273 changedtextauthor4 Changed text color author 4
28276 \begin_layout Description
28277 changedtextauthor5 Changed text color author 5
28280 \begin_layout Description
28281 collapsible Collapsible insets text color
28284 \begin_layout Description
28285 collapsibleframe Collapsible insets framecolor
28288 \begin_layout Description
28289 command Text color for command insets
28292 \begin_layout Description
28293 commandbg Background color for command insets
28296 \begin_layout Description
28297 commandframe Frame color for command insets
28300 \begin_layout Description
28301 comment Label color for comments
28304 \begin_layout Description
28305 commentbg Background color of comments
28308 \begin_layout Description
28309 cursor Cursor color
28312 \begin_layout Description
28313 deletedtext Deleted text color
28316 \begin_layout Description
28317 deletedtextmodifier Deleted text modifying color
28320 \begin_layout Description
28321 depthbar Color for the depth bars in the margin
28324 \begin_layout Description
28325 eolmarker End of line marker color
28328 \begin_layout Description
28329 error Color of the \SpecialChar LaTeX
28333 \begin_layout Description
28334 footlabel Label color for footnotes
28337 \begin_layout Description
28338 foreground Foreground color
28341 \begin_layout Description
28342 graphicsbg Graphics inset background color
28345 \begin_layout Description
28346 greyedoutbg Background color of greyedout inset
28349 \begin_layout Description
28350 greyedoutlabel Label color for greyedout insets
28353 \begin_layout Description
28354 greyedouttext Color for greyedout inset text
28357 \begin_layout Description
28358 indexlabel Label color for index insets
28361 \begin_layout Description
28362 inlinecompletion Inline completion color
28365 \begin_layout Description
28366 insetbg Inset marker background color
28369 \begin_layout Description
28370 insetframe Inset marker frame color
28373 \begin_layout Description
28374 language Color for marking foreign language words
28377 \begin_layout Description
28378 latex Text color in \SpecialChar LaTeX
28382 \begin_layout Description
28383 listingsbg Background color of listings inset
28386 \begin_layout Description
28387 marginlabel Label color for margin notes
28390 \begin_layout Description
28391 math Math inset text color
28394 \begin_layout Description
28395 mathbg Math inset background color
28398 \begin_layout Description
28399 mathcorners Math inset frame color not under focus
28402 \begin_layout Description
28403 mathframe Math inset frame color under focus
28406 \begin_layout Description
28407 mathline Math line color
28410 \begin_layout Description
28411 mathmacrobg Macro math inset background color
28414 \begin_layout Description
28415 mathmacroblend Macro math blended color
28418 \begin_layout Description
28419 mathmacroframe Macro math frame color
28422 \begin_layout Description
28423 mathmacrohoverbg Macro math inset background color hovered
28426 \begin_layout Description
28427 mathmacrolabel Macro math label color
28430 \begin_layout Description
28431 mathmacronewarg Macro template color for new parameters
28434 \begin_layout Description
28435 mathmacrooldarg Macro template color for old parameters
28438 \begin_layout Description
28439 newpage New page color
28442 \begin_layout Description
28443 nonunique_inlinecompletion Inline completion color for the non-unique part
28446 \begin_layout Description
28447 note Label color for notes
28450 \begin_layout Description
28451 notebg Background color of notes
28454 \begin_layout Description
28455 pagebreak Page break/line break color
28458 \begin_layout Description
28459 paragraphmarker Color used for the pilcrow sign to mark the end of a paragraph
28462 \begin_layout Description
28463 phantomtext Text color for phantom insets
28466 \begin_layout Description
28467 preview The color used for previews
28470 \begin_layout Description
28471 previewframe Preview frame color
28474 \begin_layout Description
28475 regexpframe Color for regexp frame
28478 \begin_layout Description
28479 scroll Color that indicates when a row can be scrolled
28482 \begin_layout Description
28483 selection Background color of selected text
28486 \begin_layout Description
28487 selectiontext Foreground color of selected text
28490 \begin_layout Description
28491 shadedbg Background color of shaded box
28494 \begin_layout Description
28495 special Special chars text color
28498 \begin_layout Description
28499 tabularline Table line color
28502 \begin_layout Description
28503 tabularonoffline Table line color
28506 \begin_layout Description
28507 urllabel Label color for URL insets
28510 \begin_layout Description
28511 urltext Color for URL inset text