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
8913 \change_inserted -712698321 1526899478
8914 \begin_inset Flex Code
8917 \begin_layout Plain Layout
8919 \change_inserted -712698321 1526898610
8920 AddToCiteEngine <engine>
8925 Extends the possibilities for displaying citation references.
8927 \begin_inset CommandInset ref
8929 reference "subsec:Citation-engine-description"
8938 \begin_inset Flex Code
8941 \begin_layout Plain Layout
8943 \change_inserted -712698321 1526898823
8954 \begin_layout Description
8955 \begin_inset Flex Code
8958 \begin_layout Plain Layout
8964 Adds information that will be output in the
8965 \begin_inset Flex Code
8968 \begin_layout Plain Layout
8974 block when the document is output to XHTML.
8975 Typically, this would be used to output CSS style information, but it can
8976 be used for anything that can appear in
8977 \begin_inset Flex Code
8980 \begin_layout Plain Layout
8988 \begin_inset Quotes eld
8992 \begin_inset Flex Code
8995 \begin_layout Plain Layout
9002 \begin_inset Quotes erd
9008 \begin_layout Description
9009 \begin_inset Flex Code
9012 \begin_layout Plain Layout
9018 Adds information to the document preamble.
9020 \begin_inset Newline newline
9024 \begin_inset Quotes eld
9028 \begin_inset Flex Code
9031 \begin_layout Plain Layout
9038 \begin_inset Quotes erd
9044 \begin_layout Description
9045 \begin_inset Flex Code
9048 \begin_layout Plain Layout
9054 Defines the possibilities for displaying citation references.
9056 \begin_inset CommandInset ref
9058 reference "subsec:Citation-engine-description"
9067 \begin_inset Quotes eld
9071 \begin_inset Flex Code
9074 \begin_layout Plain Layout
9081 \begin_inset Quotes erd
9085 Primarily used in cite engine files (see
9086 \begin_inset CommandInset ref
9088 reference "subsec:Cite-Engine-Files"
9097 \change_inserted -712698321 1526898530
9098 Note that if you specify this in a layout file or module, any cite engine
9099 definition will be overridden.
9101 \begin_inset Flex Code
9104 \begin_layout Plain Layout
9106 \change_inserted -712698321 1526898530
9119 \begin_layout Description
9120 \begin_inset Flex Code
9123 \begin_layout Plain Layout
9129 Defines formats for use in the display of bibliographic information.
9131 \begin_inset CommandInset ref
9133 reference "subsec:Citation-format-description"
9139 \begin_inset Quotes eld
9143 \begin_inset Flex Code
9146 \begin_layout Plain Layout
9153 \begin_inset Quotes erd
9157 Primarily used in cite engine files (see
9158 \begin_inset CommandInset ref
9160 reference "subsec:Cite-Engine-Files"
9169 \change_inserted -712698321 1526898585
9170 A cite format defined in a layout or module will override the cite engine
9176 \begin_layout Description
9177 \begin_inset Flex Code
9180 \begin_layout Plain Layout
9187 \begin_inset Flex Code
9190 \begin_layout Plain Layout
9199 \begin_inset Flex Code
9202 \begin_layout Plain Layout
9208 ] Determines whether
9212 or Bib\SpecialChar TeX
9213 is used to generate a Bibliography.
9214 Primarily used in cite engine files (see
9215 \begin_inset CommandInset ref
9217 reference "subsec:Cite-Engine-Files"
9227 \begin_layout Description
9228 \begin_inset Flex Code
9231 \begin_layout Plain Layout
9237 Describes various global options supported by the document class.
9239 \begin_inset CommandInset ref
9241 reference "subsec:ClassOptions"
9247 \begin_inset Quotes eld
9251 \begin_inset Flex Code
9254 \begin_layout Plain Layout
9261 \begin_inset Quotes erd
9267 \begin_layout Description
9268 \begin_inset Flex Code
9271 \begin_layout Plain Layout
9278 \begin_inset Flex Code
9281 \begin_layout Plain Layout
9290 \begin_inset space \thinspace{}
9294 \begin_inset Flex Code
9297 \begin_layout Plain Layout
9303 ] Whether the class should
9307 to having one or two columns.
9308 Can be changed in the
9309 \begin_inset Flex Noun
9312 \begin_layout Plain Layout
9313 Document\SpecialChar menuseparator
9322 \begin_layout Description
9323 \begin_inset Flex Code
9326 \begin_layout Plain Layout
9333 \begin_inset Flex Code
9336 \begin_layout Plain Layout
9342 ] This sequence defines the properties for a counter.
9343 If the counter does not yet exist, it is created; if it does exist, it
9346 \begin_inset Quotes eld
9350 \begin_inset Flex Code
9353 \begin_layout Plain Layout
9360 \begin_inset Quotes erd
9364 \begin_inset Newline newline
9368 \begin_inset CommandInset ref
9370 reference "subsec:Counters"
9374 for details on counters.
9377 \begin_layout Description
9378 \begin_inset Flex Code
9381 \begin_layout Plain Layout
9387 Sets the default font used to display the document.
9389 \begin_inset CommandInset ref
9391 reference "subsec:Font-description"
9395 for how to declare fonts.
9397 \begin_inset Quotes eld
9401 \begin_inset Flex Code
9404 \begin_layout Plain Layout
9411 \begin_inset Quotes erd
9417 \begin_layout Description
9418 \begin_inset Flex Code
9421 \begin_layout Plain Layout
9428 \begin_inset Flex Code
9431 \begin_layout Plain Layout
9437 ] Specifies a module to be included by default with this document class.
9438 The module is specified as filename without the
9439 \begin_inset Flex Code
9442 \begin_layout Plain Layout
9449 The user can still remove the module, but it will be active at the outset.
9450 (This applies only when new files are created, or when this class is chosen
9451 for an existing document.)
9454 \begin_layout Description
9455 \begin_inset Flex Code
9458 \begin_layout Plain Layout
9465 \begin_inset Flex Code
9468 \begin_layout Plain Layout
9474 ] This is the style that will be assigned to new paragraphs, usually
9475 \begin_inset Flex Noun
9478 \begin_layout Plain Layout
9485 This will default to the first defined style if not given, but you are
9486 encouraged to use this directive.
9489 \begin_layout Description
9490 \begin_inset Flex Code
9493 \begin_layout Plain Layout
9500 \begin_inset Flex Code
9503 \begin_layout Plain Layout
9509 ] This tag indicates that the module (which is specified by filename without
9511 \begin_inset Flex Code
9514 \begin_layout Plain Layout
9520 extension) cannot be used with this document class.
9521 This might be used in a journal-specific layout file to prevent, say, the
9523 \begin_inset Flex Code
9526 \begin_layout Plain Layout
9532 module that numbers theorems by section.
9537 be used in a module.
9538 Modules have their own way of excluding other modules (see
9539 \begin_inset CommandInset ref
9541 reference "subsec:Layout-modules"
9548 \begin_layout Description
9549 \begin_inset Flex Code
9552 \begin_layout Plain Layout
9558 Defines a new float.
9560 \begin_inset CommandInset ref
9562 reference "subsec:Floats"
9568 \begin_inset Quotes eld
9572 \begin_inset Flex Code
9575 \begin_layout Plain Layout
9582 \begin_inset Quotes erd
9588 \begin_layout Description
9589 \begin_inset Flex Code
9592 \begin_layout Plain Layout
9598 Sets the information that will be output in the
9599 \begin_inset Flex Code
9602 \begin_layout Plain Layout
9608 block when this document class is output to XHTML.
9609 Note that this will completely override any prior
9610 \begin_inset Flex Code
9613 \begin_layout Plain Layout
9620 \begin_inset Flex Code
9623 \begin_layout Plain Layout
9631 \begin_inset Newline newline
9635 \begin_inset Flex Code
9638 \begin_layout Plain Layout
9644 if you just want to add material to the preamble.) Must end with
9645 \begin_inset Quotes eld
9649 \begin_inset Flex Code
9652 \begin_layout Plain Layout
9659 \begin_inset Quotes erd
9665 \begin_layout Description
9666 \begin_inset Flex Code
9669 \begin_layout Plain Layout
9676 \begin_inset Flex Code
9679 \begin_layout Plain Layout
9685 ] The style to use for the table of contents, bibliography, and so forth,
9686 when the document is output to HTML.
9687 For articles, this should normally be
9688 \begin_inset Flex Code
9691 \begin_layout Plain Layout
9698 \begin_inset Flex Code
9701 \begin_layout Plain Layout
9708 If it is not given, then \SpecialChar LyX
9709 will attempt to figure out which layout to use.
9712 \begin_layout Description
9713 \begin_inset Flex Code
9716 \begin_layout Plain Layout
9723 \begin_inset Flex Code
9726 \begin_layout Plain Layout
9732 ] Modifies the properties of the given counter.
9733 If the counter does not exist, the statement is ignored.
9735 \begin_inset Quotes eld
9739 \begin_inset Flex Code
9742 \begin_layout Plain Layout
9749 \begin_inset Quotes erd
9753 \begin_inset Newline newline
9757 \begin_inset CommandInset ref
9759 reference "subsec:Counters"
9763 for details on counters.
9766 \begin_layout Description
9767 \begin_inset Flex Code
9770 \begin_layout Plain Layout
9777 \begin_inset Flex Code
9780 \begin_layout Plain Layout
9786 ] This allows you to include another layout definition file within yours
9787 to avoid duplicating commands.
9788 Common examples are the standard layout files, for example,
9789 \begin_inset Flex Code
9792 \begin_layout Plain Layout
9798 , which contains most of the basic layouts.
9801 \begin_layout Description
9802 \begin_inset Flex Code
9805 \begin_layout Plain Layout
9812 \begin_inset Flex Code
9815 \begin_layout Plain Layout
9821 ] This section (re-)defines the layout of an inset.
9822 It can be applied to an existing inset or to a new, user-defined inset,
9823 e.g., a new character style.
9825 \begin_inset Quotes eld
9829 \begin_inset Flex Code
9832 \begin_layout Plain Layout
9839 \begin_inset Quotes erd
9843 \begin_inset Newline newline
9847 \begin_inset CommandInset ref
9849 reference "subsec:Flex-insets-and"
9853 for more information.
9857 \begin_layout Description
9858 \begin_inset Flex Code
9861 \begin_layout Plain Layout
9868 \begin_inset Flex Code
9871 \begin_layout Plain Layout
9877 ] A string that indicates the width of the left margin on the screen, for
9879 \begin_inset Quotes eld
9883 \begin_inset Flex Code
9886 \begin_layout Plain Layout
9893 \begin_inset Quotes erd
9897 (Note that this is not a `length', like
9898 \begin_inset Quotes eld
9902 \begin_inset Quotes erd
9908 \begin_layout Description
9909 \begin_inset Flex Code
9912 \begin_layout Plain Layout
9919 \begin_inset Flex Code
9922 \begin_layout Plain Layout
9928 ] An integer that determines the maximal number of names displayed in an
9929 author-year citation before the citation switches to
9930 \begin_inset Quotes eld
9934 \begin_inset Quotes erd
9938 Primarily used in cite engine files (see
9939 \begin_inset CommandInset ref
9941 reference "subsec:Cite-Engine-Files"
9951 \begin_layout Description
9952 \begin_inset Flex Code
9955 \begin_layout Plain Layout
9962 \begin_inset Flex Code
9965 \begin_layout Plain Layout
9971 ] Modifies the properties of the given paragraph style.
9972 If the style does not exist, this section is ignored.
9974 \begin_inset Quotes eld
9978 \begin_inset Flex Code
9981 \begin_layout Plain Layout
9988 \begin_inset Quotes erd
9994 \begin_layout Description
9995 \begin_inset Flex Code
9998 \begin_layout Plain Layout
10005 \begin_inset Flex Code
10008 \begin_layout Plain Layout
10014 ] Deletes an existing counter, usually one defined in an included file.
10017 \begin_layout Description
10018 \begin_inset Flex Code
10021 \begin_layout Plain Layout
10028 \begin_inset Flex Code
10031 \begin_layout Plain Layout
10037 ] Deletes an existing float.
10038 This is particularly useful when you want to suppress a float that has
10039 been defined in an input file.
10042 \begin_layout Description
10043 \begin_inset Flex Code
10046 \begin_layout Plain Layout
10053 \begin_inset Flex Code
10056 \begin_layout Plain Layout
10062 ] Deletes an existing style.
10065 \begin_layout Description
10066 \begin_inset Flex Code
10069 \begin_layout Plain Layout
10076 \begin_inset Flex Code
10079 \begin_layout Plain Layout
10086 \begin_inset Flex Code
10089 \begin_layout Plain Layout
10095 ] Define a new table of contents with type
10096 \begin_inset Flex Code
10099 \begin_layout Plain Layout
10106 \begin_inset Flex Code
10109 \begin_layout Plain Layout
10116 See also the AddToToc commands.
10119 \begin_layout Description
10120 \begin_inset Flex Code
10123 \begin_layout Plain Layout
10130 \begin_inset Flex Code
10133 \begin_layout Plain Layout
10139 ] The file format (as defined in the \SpecialChar LyX
10140 preferences) produced by this document
10142 It is mainly useful when
10143 \begin_inset Flex Code
10146 \begin_layout Plain Layout
10153 \begin_inset Flex Code
10156 \begin_layout Plain Layout
10162 and one wants to define a new type of literate document.
10163 The format is reset to
10164 \begin_inset Quotes eld
10168 \begin_inset Flex Code
10171 \begin_layout Plain Layout
10178 \begin_inset Quotes erd
10182 \begin_inset Quotes eld
10186 \begin_inset Flex Code
10189 \begin_layout Plain Layout
10196 \begin_inset Quotes erd
10199 when the corresponding
10200 \begin_inset Flex Code
10203 \begin_layout Plain Layout
10209 parameter is encountered.
10212 \begin_layout Description
10213 \begin_inset Flex Code
10216 \begin_layout Plain Layout
10223 \begin_inset Flex Code
10226 \begin_layout Plain Layout
10237 \begin_inset Flex Code
10240 \begin_layout Plain Layout
10247 \begin_inset Flex Code
10250 \begin_layout Plain Layout
10256 ] Specifies what sort of output documents using this class will produce.
10259 \begin_layout Description
10260 \begin_inset Flex Code
10263 \begin_layout Plain Layout
10270 \begin_inset Flex Code
10273 \begin_layout Plain Layout
10280 \begin_inset Flex Code
10283 \begin_layout Plain Layout
10289 ] Specifies options, given in the second string, for the package named by
10292 \begin_inset Quotes eld
10296 \begin_inset Flex Code
10299 \begin_layout Plain Layout
10300 PackageOptions natbib square
10306 \begin_inset Quotes erd
10310 \begin_inset Flex Code
10313 \begin_layout Plain Layout
10319 to be loaded with the
10320 \begin_inset Flex Code
10323 \begin_layout Plain Layout
10330 (For \SpecialChar TeX
10331 perts, this causes \SpecialChar LyX
10333 \begin_inset Flex Code
10336 \begin_layout Plain Layout
10339 PassOptionsToPackage{natbib}{square}
10345 \begin_inset Flex Code
10348 \begin_layout Plain Layout
10357 \begin_layout Description
10358 \begin_inset Flex Code
10361 \begin_layout Plain Layout
10368 \begin_inset Flex Code
10371 \begin_layout Plain Layout
10380 \begin_inset Flex Code
10383 \begin_layout Plain Layout
10390 \begin_inset Flex Code
10393 \begin_layout Plain Layout
10399 ] The default pagestyle.
10400 Can be changed in the
10401 \begin_inset Flex Noun
10404 \begin_layout Plain Layout
10405 Document\SpecialChar menuseparator
10414 \begin_layout Description
10415 \begin_inset Flex Code
10418 \begin_layout Plain Layout
10424 Sets the preamble for the \SpecialChar LaTeX
10426 Note that this will completely override any prior
10427 \begin_inset Flex Code
10430 \begin_layout Plain Layout
10437 \begin_inset Flex Code
10440 \begin_layout Plain Layout
10448 \begin_inset Flex Code
10451 \begin_layout Plain Layout
10457 if you just want to add material to the preamble.) Must end with
10458 \begin_inset Quotes eld
10462 \begin_inset Flex Code
10465 \begin_layout Plain Layout
10472 \begin_inset Quotes erd
10478 \begin_layout Description
10479 \begin_inset Flex Code
10482 \begin_layout Plain Layout
10489 \begin_inset Flex Code
10492 \begin_layout Plain Layout
10499 \begin_inset Flex Code
10502 \begin_layout Plain Layout
10511 \begin_inset space \thinspace{}
10515 \begin_inset Flex Code
10518 \begin_layout Plain Layout
10524 ] Whether the class already provides the feature
10525 \begin_inset Flex Code
10528 \begin_layout Plain Layout
10535 A feature is in general the name of a package (e.
10536 \begin_inset space \thinspace{}
10540 \begin_inset space \space{}
10544 \begin_inset Flex Code
10547 \begin_layout Plain Layout
10554 \begin_inset Flex Code
10557 \begin_layout Plain Layout
10564 \begin_inset space \thinspace{}
10568 \begin_inset space \space{}
10572 \begin_inset Flex Code
10575 \begin_layout Plain Layout
10582 \begin_inset Flex Code
10585 \begin_layout Plain Layout
10593 \begin_inset CommandInset ref
10595 reference "chap:List-of-functions"
10599 for the list of features.
10602 \begin_layout Description
10603 \begin_inset Flex Code
10606 \begin_layout Plain Layout
10613 \begin_inset Flex Code
10616 \begin_layout Plain Layout
10622 ] Indicates that this layout provides the functionality of the module mentioned,
10623 which should be specified by the filename without the
10624 \begin_inset Flex Code
10627 \begin_layout Plain Layout
10634 This will typically be used if the layout includes the module directly,
10635 rather than using the
10636 \begin_inset Flex Code
10639 \begin_layout Plain Layout
10645 tag to indicate that it ought to be used.
10646 It could also be used in a module that provided an alternate implementation
10647 of the same functionality.
10650 \begin_layout Description
10651 \begin_inset Flex Code
10654 \begin_layout Plain Layout
10661 \begin_inset Flex Code
10664 \begin_layout Plain Layout
10670 ] Creates a new paragraph style if it does not already exist.
10671 If the style does exist, this section is ignored.
10673 \begin_inset Quotes eld
10677 \begin_inset Flex Code
10680 \begin_layout Plain Layout
10687 \begin_inset Quotes erd
10693 \begin_layout Description
10694 \begin_inset Flex Code
10697 \begin_layout Plain Layout
10704 \begin_inset Flex Code
10707 \begin_layout Plain Layout
10713 ] Whether the class requires the feature
10714 \begin_inset Flex Code
10717 \begin_layout Plain Layout
10724 Multiple features must be separated by commas.
10725 Note that you can only request supported features.
10727 \begin_inset CommandInset ref
10729 reference "chap:List-of-functions"
10733 for the list of features.).
10734 If you require a package with specific options, you can additionally use
10736 \begin_inset Flex Code
10739 \begin_layout Plain Layout
10748 \begin_layout Description
10749 \begin_inset Flex Code
10752 \begin_layout Plain Layout
10759 \begin_inset Flex Code
10762 \begin_layout Plain Layout
10768 ] A string that indicates the width of the right margin on the screen, for
10770 \begin_inset Quotes eld
10774 \begin_inset Flex Code
10777 \begin_layout Plain Layout
10784 \begin_inset Quotes erd
10790 \begin_layout Description
10791 \begin_inset Flex Code
10794 \begin_layout Plain Layout
10801 \begin_inset Flex Code
10804 \begin_layout Plain Layout
10810 ] Sets which divisions get numbered.
10812 \begin_inset Newline newline
10816 \begin_inset Flex Code
10819 \begin_layout Plain Layout
10825 counter in \SpecialChar LaTeX
10829 \begin_layout Description
10830 \begin_inset Flex Code
10833 \begin_layout Plain Layout
10840 \begin_inset Flex Code
10843 \begin_layout Plain Layout
10852 \begin_inset space \thinspace{}
10856 \begin_inset Flex Code
10859 \begin_layout Plain Layout
10865 ] Whether the class-default should be printing on one or both sides of the
10867 Can be changed in the
10868 \begin_inset Flex Noun
10871 \begin_layout Plain Layout
10872 Document\SpecialChar menuseparator
10881 \begin_layout Description
10882 \begin_inset Flex Code
10885 \begin_layout Plain Layout
10892 \begin_inset Flex Code
10895 \begin_layout Plain Layout
10901 ] This sequence defines a paragraph style.
10902 If the style does not yet exist, it is created; if it does exist, its parameter
10905 \begin_inset Quotes eld
10909 \begin_inset Flex Code
10912 \begin_layout Plain Layout
10919 \begin_inset Quotes erd
10923 \begin_inset Newline newline
10927 \begin_inset CommandInset ref
10929 reference "subsec:Paragraph-Styles"
10933 for details on paragraph styles.
10936 \begin_layout Description
10937 \begin_inset Flex Code
10940 \begin_layout Plain Layout
10947 \begin_inset Flex Code
10950 \begin_layout Plain Layout
10956 ] The name of the command or environment to be used with
10957 \begin_inset Flex Code
10960 \begin_layout Plain Layout
10969 \begin_layout Description
10970 \begin_inset Flex Code
10973 \begin_layout Plain Layout
10980 \begin_inset Flex Code
10983 \begin_layout Plain Layout
10992 \begin_inset Flex Code
10995 \begin_layout Plain Layout
11001 ] Indicates what kind of markup is used to define the title of a document.
11003 \begin_inset Flex Code
11006 \begin_layout Plain Layout
11012 means that the macro with name
11013 \begin_inset Flex Code
11016 \begin_layout Plain Layout
11022 will be inserted after the last layout which has
11023 \begin_inset Quotes eld
11027 \begin_inset Flex Code
11030 \begin_layout Plain Layout
11032 \begin_inset space ~
11041 \begin_inset Quotes erd
11046 \begin_inset Flex Code
11049 \begin_layout Plain Layout
11055 corresponds to the case where all layouts which have
11056 \begin_inset Quotes eld
11060 \begin_inset Flex Code
11063 \begin_layout Plain Layout
11065 \begin_inset space ~
11074 \begin_inset Quotes erd
11077 should be enclosed into the
11078 \begin_inset Flex Code
11081 \begin_layout Plain Layout
11090 \begin_layout Description
11091 \begin_inset Flex Code
11094 \begin_layout Plain Layout
11101 \begin_inset Flex Code
11104 \begin_layout Plain Layout
11110 ] Sets which divisions are included in the table of contents.
11112 \begin_inset Flex Code
11115 \begin_layout Plain Layout
11121 counter in \SpecialChar LaTeX
11125 \begin_layout Subsection
11126 \begin_inset Flex Code
11129 \begin_layout Plain Layout
11136 \begin_inset CommandInset label
11138 name "subsec:ClassOptions"
11145 \begin_layout Standard
11147 \begin_inset Flex Code
11150 \begin_layout Plain Layout
11156 section can contain the following entries:
11159 \begin_layout Description
11160 \begin_inset Flex Code
11163 \begin_layout Plain Layout
11170 \begin_inset Flex Code
11173 \begin_layout Plain Layout
11179 ] The list of available font sizes for the document's main font, separated
11181 \begin_inset Quotes eld
11185 \begin_inset Flex Code
11188 \begin_layout Plain Layout
11195 \begin_inset Quotes erd
11201 \begin_layout Description
11202 \begin_inset Flex Code
11205 \begin_layout Plain Layout
11211 Used to set the DTD line with XML-based output classes.
11213 \begin_inset space \thinspace{}
11217 \begin_inset Quotes eld
11220 -//OASIS//DTD DocBook V4.2//EN
11221 \begin_inset Quotes erd
11227 \begin_layout Description
11228 \begin_inset Flex Code
11231 \begin_layout Plain Layout
11238 \begin_inset Flex Code
11241 \begin_layout Plain Layout
11242 string="empty|plain|headings|fancy"
11247 ] The list of available page sty\SpecialChar softhyphen
11249 \begin_inset Quotes eld
11253 \begin_inset Flex Code
11256 \begin_layout Plain Layout
11263 \begin_inset Quotes erd
11269 \begin_layout Description
11270 \begin_inset Flex Code
11273 \begin_layout Plain Layout
11280 \begin_inset Flex Code
11283 \begin_layout Plain Layout
11289 ] Some document class options, separated by a comma, that will be added
11290 to the optional part of the
11291 \begin_inset Flex Code
11294 \begin_layout Plain Layout
11305 \begin_layout Standard
11307 \begin_inset Flex Code
11310 \begin_layout Plain Layout
11316 section must end with
11317 \begin_inset Quotes eld
11321 \begin_inset Flex Code
11324 \begin_layout Plain Layout
11331 \begin_inset Quotes erd
11337 \begin_layout Subsection
11339 \begin_inset CommandInset label
11341 name "subsec:Paragraph-Styles"
11348 \begin_layout Standard
11349 A paragraph style description looks like this:
11353 \begin_layout Plain Layout
11354 Note that this will either define a new style or modify an existing one.
11362 \begin_layout LyX-Code
11369 \begin_layout LyX-Code
11373 \begin_layout LyX-Code
11377 \begin_layout Standard
11378 where the following commands are allowed:
11381 \begin_layout Description
11382 \begin_inset Flex Code
11385 \begin_layout Plain Layout
11392 \begin_inset Flex Code
11395 \begin_layout Plain Layout
11401 =""] This paragraph will appear in the table of contents of the given type.
11402 An empty string disables.
11403 See also the OutlinerName and the IsTocCaption commands.
11407 \begin_layout Description
11408 \begin_inset Flex Code
11411 \begin_layout Plain Layout
11418 \begin_inset Flex Code
11421 \begin_layout Plain Layout
11426 , left, right, center
11431 ] Paragraph alignment.
11434 \begin_layout Description
11435 \begin_inset Flex Code
11438 \begin_layout Plain Layout
11445 \begin_inset Flex Code
11448 \begin_layout Plain Layout
11453 , left, right, center
11458 ] A comma separated list of permitted alignments.
11459 (Some \SpecialChar LaTeX
11460 styles prohibit certain alignments, since those wouldn't make sense.
11461 For example a right-aligned or centered enumeration isn't possible.)
11464 \begin_layout Description
11465 \begin_inset Flex Code
11468 \begin_layout Plain Layout
11475 \begin_inset Flex Code
11478 \begin_layout Plain Layout
11484 ] Defines argument number <int> of a command\SpecialChar breakableslash
11485 environment associated with
11487 This is useful for things like section headings, and only makes sense with
11490 Every (optional or required) argument of a command or environment – except
11491 for the required argument that is associated with the content of the paragraph
11492 itself – has a separate definition, where the number specifies the order
11494 The definition must end with
11495 \begin_inset Flex Code
11498 \begin_layout Plain Layout
11505 So a command with two optional arguments has:
11509 \begin_layout Quote
11515 \begin_layout Quote
11521 \begin_layout Quote
11527 \begin_layout Quote
11533 \begin_layout Quote
11539 \begin_layout Quote
11545 \begin_layout Standard
11547 \begin_inset Flex Code
11550 \begin_layout Plain Layout
11556 definition, the following specifications are possible:
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 The string that will appear both in the menu (to insert this argument)
11580 and on the argument inset button (unless you also specify a separate
11581 \begin_inset Flex Code
11584 \begin_layout Plain Layout
11591 For the menu, you can define an accelerator by appending the respective
11592 character to the string, divided by
11593 \begin_inset Quotes eld
11597 \begin_inset Quotes erd
11601 \begin_inset space \thinspace{}
11605 \begin_inset space \space{}
11609 \begin_inset Quotes eld
11613 \begin_inset Flex Code
11616 \begin_layout Plain Layout
11623 \begin_inset Quotes erd
11629 \begin_layout Itemize
11630 \begin_inset Flex Code
11633 \begin_layout Plain Layout
11640 \begin_inset Flex Code
11643 \begin_layout Plain Layout
11649 A separate string for the menu.
11650 You can define an accelerator by appending the respective character to
11651 the string, divided by
11652 \begin_inset Quotes eld
11656 \begin_inset Quotes erd
11660 \begin_inset space \thinspace{}
11664 \begin_inset space \space{}
11668 \begin_inset Quotes eld
11672 \begin_inset Flex Code
11675 \begin_layout Plain Layout
11682 \begin_inset Quotes erd
11686 This specification is optional.
11687 If it is not given the
11688 \begin_inset Flex Code
11691 \begin_layout Plain Layout
11697 will be used instead for the menu.
11700 \begin_layout Itemize
11701 \begin_inset Flex Code
11704 \begin_layout Plain Layout
11711 \begin_inset Flex Code
11714 \begin_layout Plain Layout
11720 A longer explanatory text that appears in the tooltip when hovering over
11721 the argument inset.
11724 \begin_layout Itemize
11725 \begin_inset Flex Code
11728 \begin_layout Plain Layout
11735 \begin_inset Flex Code
11738 \begin_layout Plain Layout
11747 \begin_inset space \thinspace{}
11751 \begin_inset Flex Code
11754 \begin_layout Plain Layout
11760 ] Declare if this is a mandatory (1) or an optional (0) argument.
11761 Mandatory arguments will be output empty if not given, while optional arguments
11762 will not be output at all.
11763 By default, mandatory arguments are delimited by
11764 \begin_inset Flex Code
11767 \begin_layout Plain Layout
11773 , while optional arguments are delimited by
11774 \begin_inset Flex Code
11777 \begin_layout Plain Layout
11786 \begin_layout Itemize
11787 \begin_inset Flex Code
11790 \begin_layout Plain Layout
11797 \begin_inset Flex Code
11800 \begin_layout Plain Layout
11806 defines another argument (by its number) which this argument requires to
11807 be output if it is itself output.
11809 \begin_inset space \thinspace{}
11812 g., in \SpecialChar LaTeX
11813 commands, optional arguments often require previous optional arguments
11814 to be output (at least empty), as in
11815 \begin_inset Flex Code
11818 \begin_layout Plain Layout
11821 command[][argument]{text}
11827 This can be achieved by the statement
11828 \begin_inset Flex Code
11831 \begin_layout Plain Layout
11838 \begin_inset Flex Code
11841 \begin_layout Plain Layout
11850 \begin_layout Itemize
11851 \begin_inset Flex Code
11854 \begin_layout Plain Layout
11861 \begin_inset Flex Code
11864 \begin_layout Plain Layout
11870 defines a custom left delimiter (instead of
11871 \begin_inset Flex Code
11874 \begin_layout Plain Layout
11881 \begin_inset Flex Code
11884 \begin_layout Plain Layout
11891 A line break in the output can be indicated by
11892 \begin_inset Flex Code
11895 \begin_layout Plain Layout
11904 \begin_layout Itemize
11905 \begin_inset Flex Code
11908 \begin_layout Plain Layout
11915 \begin_inset Flex Code
11918 \begin_layout Plain Layout
11924 defines a custom right delimiter (instead of
11925 \begin_inset Flex Code
11928 \begin_layout Plain Layout
11935 \begin_inset Flex Code
11938 \begin_layout Plain Layout
11945 A line break in the output can be indicated by
11946 \begin_inset Flex Code
11949 \begin_layout Plain Layout
11958 \begin_layout Itemize
11959 \begin_inset Flex Code
11962 \begin_layout Plain Layout
11969 \begin_inset Flex Code
11972 \begin_layout Plain Layout
11978 defines an argument that is inserted if and only if no user-specified arguments
11980 \begin_inset space \thinspace{}
11984 \begin_inset space \space{}
11987 if no argument inset has been inserted (note that also an empty argument
11988 inset omits the DefaultArg).
11989 Multiple arguments need to be separated by comma.
11992 \begin_layout Itemize
11993 \begin_inset Flex Code
11996 \begin_layout Plain Layout
12003 \begin_inset Flex Code
12006 \begin_layout Plain Layout
12012 defines an argument that is inserted in any case (alone or in addition
12013 to user-specified arguments).
12014 Multiple arguments need to be separated by comma.
12017 \begin_layout Itemize
12018 \begin_inset Flex Code
12021 \begin_layout Plain Layout
12027 The font used for the argument content, see
12028 \begin_inset CommandInset ref
12030 reference "subsec:Font-description"
12037 \begin_layout Itemize
12038 \begin_inset Flex Code
12041 \begin_layout Plain Layout
12047 The font used for the label; see
12048 \begin_inset CommandInset ref
12050 reference "subsec:Font-description"
12057 \begin_layout Itemize
12058 \begin_inset Flex Code
12061 \begin_layout Plain Layout
12068 \begin_inset Flex Code
12071 \begin_layout Plain Layout
12076 , Minimalistic, Conglomerate
12081 ] describes the rendering style used for the inset's frame and buttons.
12084 \begin_layout Itemize
12085 \begin_inset Flex Code
12088 \begin_layout Plain Layout
12095 \begin_inset Flex Code
12098 \begin_layout Plain Layout
12105 \begin_inset Flex Code
12108 \begin_layout Plain Layout
12114 , this argument is automatically inserted when the respective style is selected.
12115 Currently, only one argument per style\SpecialChar breakableslash
12116 layout can be automatically inserted.
12119 \begin_layout Itemize
12120 \begin_inset Flex Code
12123 \begin_layout Plain Layout
12130 \begin_inset Flex Code
12133 \begin_layout Plain Layout
12140 \begin_inset Flex Code
12143 \begin_layout Plain Layout
12149 , this argument will be inserted with a copy of the co-text (either selected
12150 text or the whole paragraph) as content.
12153 \begin_layout Itemize
12154 \begin_inset Flex Code
12157 \begin_layout Plain Layout
12164 \begin_inset Flex Code
12167 \begin_layout Plain Layout
12177 ] Whether the contents of this argument should be output in raw form, meaning
12178 without special translations that \SpecialChar LaTeX
12181 \begin_inset Flex Code
12184 \begin_layout Plain Layout
12190 status is inherited by the inset or paragraph layout the argument belongs
12191 to, true and false change the status for the given argument only.
12194 \begin_layout Itemize
12195 \begin_inset Flex Code
12198 \begin_layout Plain Layout
12205 \begin_inset Flex Code
12208 \begin_layout Plain Layout
12209 string of characters
12218 Defines individual characters
12219 \begin_inset Newline linebreak
12222 that should be output in raw form, meaning without special translations
12223 that \SpecialChar LaTeX
12225 Note that, contrary to PassThru, this needs to be explicitly defined for
12227 That is, arguments do not inherit PassThruChars from their parent inset
12231 \begin_layout Itemize
12232 \begin_inset Flex Code
12235 \begin_layout Plain Layout
12242 \begin_inset Flex Code
12245 \begin_layout Plain Layout
12254 \begin_inset space \thinspace{}
12258 \begin_inset Flex Code
12261 \begin_layout Plain Layout
12267 ] If this is set to 1, the argument will output its content in the corresponding
12268 item in the table of contents.
12272 \begin_layout Standard
12273 By default, the text entered in the \SpecialChar LyX
12274 workarea in the respective layout is
12275 the last (mandatory) argument of a command if the
12276 \begin_inset Flex Code
12279 \begin_layout Plain Layout
12286 \begin_inset Flex Code
12289 \begin_layout Plain Layout
12296 However, arguments with the prefix
12297 \begin_inset Flex Code
12300 \begin_layout Plain Layout
12306 are output after this workarea argument.
12307 Note that post-argument numbering restarts at 1, so the first argument
12308 following the workarea argument is
12309 \begin_inset Flex Code
12312 \begin_layout Plain Layout
12319 Post-arguments are ignored in any other
12320 \begin_inset Flex Code
12323 \begin_layout Plain Layout
12330 \begin_inset Flex Code
12333 \begin_layout Plain Layout
12342 \begin_layout Standard
12344 \begin_inset Flex Code
12347 \begin_layout Plain Layout
12356 \begin_inset Flex Code
12359 \begin_layout Plain Layout
12368 \begin_inset Flex Code
12371 \begin_layout Plain Layout
12377 followed by the number (e.
12378 \begin_inset space \thinspace{}
12382 \begin_inset space \space{}
12386 \begin_inset Flex Code
12389 \begin_layout Plain Layout
12399 \begin_layout Description
12400 \begin_inset Flex Code
12403 \begin_layout Plain Layout
12409 Includes a comma-separated list of layouts that should be nested in and
12410 after the current layout.
12411 Only makes sense for nestable layouts (such as environments).
12413 \begin_inset Quotes eld
12417 \begin_inset Flex Code
12420 \begin_layout Plain Layout
12427 \begin_inset Quotes erd
12432 \begin_inset Flex Code
12435 \begin_layout Plain Layout
12444 \begin_layout Description
12445 \begin_inset Flex Code
12448 \begin_layout Plain Layout
12454 Note that this will completely override any prior
12455 \begin_inset Flex Code
12458 \begin_layout Plain Layout
12464 declaration for this style.
12466 \begin_inset Quotes eld
12470 \begin_inset Flex Code
12473 \begin_layout Plain Layout
12480 \begin_inset Quotes erd
12485 \begin_inset CommandInset ref
12487 reference "subsec:I18n"
12491 for details on its use.
12494 \begin_layout Description
12495 \begin_inset Flex Code
12498 \begin_layout Plain Layout
12505 \begin_inset Flex Code
12508 \begin_layout Plain Layout
12518 \begin_layout Plain Layout
12519 Note that a `float' here is a real number, such as: 1.5.
12524 The vertical space with which the last of a chain of paragraphs with this
12525 style is separated from the following paragraph.
12526 If the next paragraph has another style, the separations are not simply
12527 added, but the maximum is taken.
12530 \begin_layout Description
12531 \begin_inset Flex Code
12534 \begin_layout Plain Layout
12541 \begin_inset Flex Code
12544 \begin_layout Plain Layout
12550 ] The category for this style.
12551 This is used to group related styles in the style combobox on the toolbar.
12552 Any string can be used, but you may want to use existing categories with
12557 \begin_layout Description
12558 \begin_inset Flex Code
12561 \begin_layout Plain Layout
12567 Depth of XML command.
12568 Used only with XML-type formats.
12571 \begin_layout Description
12572 \begin_inset Flex Code
12575 \begin_layout Plain Layout
12582 \begin_inset Flex Code
12585 \begin_layout Plain Layout
12591 ] Copies all the features of an existing style into the current one.
12595 \begin_layout Description
12596 \begin_inset Flex Code
12599 \begin_layout Plain Layout
12606 \begin_inset Flex Code
12609 \begin_layout Plain Layout
12615 ] The name of a style whose preamble should be output
12620 This allows to ensure some ordering of the preamble snippets when macros
12621 definitions depend on one another.
12625 \begin_layout Plain Layout
12626 Note that, besides that functionality, there is no way to ensure any ordering
12628 The ordering that you see in a given version of \SpecialChar LyX
12629 may change without warning
12638 \begin_layout Description
12639 \begin_inset Flex Code
12642 \begin_layout Plain Layout
12649 \begin_inset Flex Code
12652 \begin_layout Plain Layout
12657 , Box, Filled_Box, Static
12662 ] The type of label that stands at the end of the paragraph (or sequence
12664 \begin_inset Flex Code
12667 \begin_layout Plain Layout
12674 \begin_inset Newline newline
12678 \begin_inset Flex Code
12681 \begin_layout Plain Layout
12688 \begin_inset Flex Code
12691 \begin_layout Plain Layout
12698 \begin_inset Flex Code
12701 \begin_layout Plain Layout
12709 \begin_inset Flex Code
12712 \begin_layout Plain Layout
12719 \begin_inset Quotes eld
12723 \begin_inset Quotes erd
12727 \begin_inset Flex Code
12730 \begin_layout Plain Layout
12737 \begin_inset space \space{}
12741 \begin_inset Flex Code
12744 \begin_layout Plain Layout
12750 ) is a white (resp.
12751 \begin_inset space ~
12754 black) square suitable for end of proof markers,
12755 \begin_inset Flex Code
12758 \begin_layout Plain Layout
12764 is an explicit text string.
12767 \begin_layout Description
12768 \begin_inset Flex Code
12771 \begin_layout Plain Layout
12778 \begin_inset Flex Code
12781 \begin_layout Plain Layout
12787 ] The string used for a label with a
12788 \begin_inset Flex Code
12791 \begin_layout Plain Layout
12798 \begin_inset Newline newline
12802 \begin_inset Flex Code
12805 \begin_layout Plain Layout
12815 \begin_layout Description
12816 \begin_inset Flex Code
12819 \begin_layout Plain Layout
12825 The font used for both the text body
12831 \begin_inset CommandInset ref
12833 reference "subsec:Font-description"
12838 Note that defining this font automatically defines the
12839 \begin_inset Flex Code
12842 \begin_layout Plain Layout
12849 So you should define this one first if you also want to define
12850 \begin_inset Flex Code
12853 \begin_layout Plain Layout
12862 \begin_layout Description
12863 \begin_inset Flex Code
12866 \begin_layout Plain Layout
12873 \begin_inset Flex Code
12876 \begin_layout Plain Layout
12882 ] Used for backporting new styles to stable \SpecialChar LyX
12884 The first stable version that supports this tag is \SpecialChar LyX
12886 The argument is a number which may either be 0, -1 or any value greater
12889 \begin_inset Flex Code
12892 \begin_layout Plain Layout
12898 flag of a style is greater than zero, it will always be written to the
12900 If a .lyx file is read, the style definitions from the document header are
12901 added to the document class.
12902 Therefore even older \SpecialChar LyX
12903 versions can handle the style.
12905 \begin_inset Flex Code
12908 \begin_layout Plain Layout
12914 is a version number: if the style is read, and the version number is less
12915 than the version number of the already existing style in the document class,
12916 the new style is ignored.
12917 If the version number is greater, the new style replaces the existing style.
12918 A value of -1 means an infinite version number, i.
12919 \begin_inset space \thinspace{}
12923 \begin_inset space \space{}
12926 the style is always used.
12929 \begin_layout Description
12930 \begin_inset Flex Code
12933 \begin_layout Plain Layout
12940 \begin_inset Flex Code
12943 \begin_layout Plain Layout
12952 \begin_inset space \thinspace{}
12956 \begin_inset Flex Code
12959 \begin_layout Plain Layout
12965 ] Usually \SpecialChar LyX
12966 does not allow you to insert more than one space between words,
12967 since a space is considered as the separation between two words, not a
12968 character or symbol of its own.
12969 This is a very fine thing but sometimes annoying, for example, when typing
12970 program code or plain \SpecialChar LaTeX
12973 \begin_inset Flex Code
12976 \begin_layout Plain Layout
12983 Note that \SpecialChar LyX
12984 will create protected blanks for the additional blanks when
12985 in another mode than \SpecialChar LaTeX
12989 \begin_layout Description
12990 \begin_inset Flex Code
12993 \begin_layout Plain Layout
12999 These tags are used with XHTML output.
13001 \begin_inset CommandInset ref
13003 reference "subsec:Paragraph-Style-XHTML"
13010 \begin_layout Description
13011 \begin_inset Flex Code
13014 \begin_layout Plain Layout
13020 [FIXME] (Used only with XML-type formats.)
13023 \begin_layout Description
13024 \begin_inset Flex Code
13027 \begin_layout Plain Layout
13034 \begin_inset Flex Code
13037 \begin_layout Plain Layout
13046 \begin_inset space \thinspace{}
13050 \begin_inset Flex Code
13053 \begin_layout Plain Layout
13060 \begin_inset Flex Code
13063 \begin_layout Plain Layout
13069 , marks the style as to be included in the document preamble and not in
13071 This is useful for document classes that want such information as the title
13072 and author to appear in the preamble.
13073 Note that this works only for styles for which the
13074 \begin_inset Flex Code
13077 \begin_layout Plain Layout
13084 \begin_inset Flex Code
13087 \begin_layout Plain Layout
13094 \begin_inset Flex Code
13097 \begin_layout Plain Layout
13106 \begin_layout Description
13107 \begin_inset Flex Code
13110 \begin_layout Plain Layout
13117 \begin_inset Flex Code
13120 \begin_layout Plain Layout
13129 \begin_inset space \thinspace{}
13133 \begin_inset Flex Code
13136 \begin_layout Plain Layout
13143 \begin_inset Flex Code
13146 \begin_layout Plain Layout
13152 , marks the style as being part of a title block (see also the
13153 \begin_inset Flex Code
13156 \begin_layout Plain Layout
13163 \begin_inset Flex Code
13166 \begin_layout Plain Layout
13175 \begin_layout Description
13176 \begin_inset Flex Code
13179 \begin_layout Plain Layout
13185 Includes a comma-separated list of layouts after which this one should
13187 Only makes sense with regard to nestable layouts (such as environments).
13189 \begin_inset Quotes eld
13193 \begin_inset Flex Code
13196 \begin_layout Plain Layout
13203 \begin_inset Quotes erd
13208 \begin_inset Flex Code
13211 \begin_layout Plain Layout
13220 \begin_layout Description
13221 \begin_inset Flex Code
13224 \begin_layout Plain Layout
13231 \begin_inset Flex Code
13234 \begin_layout Plain Layout
13243 \begin_inset space \thinspace{}
13247 \begin_inset Flex Code
13250 \begin_layout Plain Layout
13256 ] If this is set to 1 and AddToToc is enabled, the paragraph adds a summary
13257 of its contents in its item in the table of contents.
13258 Otherwise, only the label, if it exists, appears.
13261 \begin_layout Description
13262 \begin_inset Flex Code
13265 \begin_layout Plain Layout
13272 \begin_inset Flex Code
13275 \begin_layout Plain Layout
13281 ] The \SpecialChar LaTeX
13282 command sequence declaring an item in a list.
13283 The command is to be defined without the preceding backslash (the default
13285 \begin_inset Quotes eld
13289 \begin_inset Quotes erd
13293 \begin_inset Flex Code
13296 \begin_layout Plain Layout
13304 in the \SpecialChar LaTeX
13308 \begin_layout Description
13309 \begin_inset Flex Code
13312 \begin_layout Plain Layout
13319 \begin_inset Flex Code
13322 \begin_layout Plain Layout
13328 ] This provides extra space between paragraphs that have the same style.
13329 If you put other styles into an environment, each is separated with the
13331 \begin_inset Flex Code
13334 \begin_layout Plain Layout
13341 But the whole items of the environment are additionally separated with
13343 \begin_inset Flex Code
13346 \begin_layout Plain Layout
13353 Note that this is a
13358 \begin_layout Description
13359 \begin_inset Flex Code
13362 \begin_layout Plain Layout
13368 [FIXME] (Used only with XML-type formats.)
13371 \begin_layout Description
13372 \begin_inset Flex Code
13375 \begin_layout Plain Layout
13382 \begin_inset Flex Code
13385 \begin_layout Plain Layout
13394 \begin_inset space \thinspace{}
13398 \begin_inset Flex Code
13401 \begin_layout Plain Layout
13407 ] Usually \SpecialChar LyX
13408 does not allow you to leave a paragraph empty, since it would
13409 lead to empty \SpecialChar LaTeX
13411 There are some cases where this could be desirable however: in a letter
13412 template, the required fields can be provided as empty fields, so that
13413 people do not forget them; in some special classes, a style can be used
13414 as some kind of break, which does not contain actual text.
13417 \begin_layout Description
13418 \begin_inset Flex Code
13421 \begin_layout Plain Layout
13428 \begin_inset Flex Code
13431 \begin_layout Plain Layout
13437 ] The vertical space between the label and the text body.
13438 Only used for labels that are above the text body (
13439 \begin_inset Flex Code
13442 \begin_layout Plain Layout
13449 \begin_inset Newline newline
13453 \begin_inset Flex Code
13456 \begin_layout Plain Layout
13457 Centered_Top_Environment
13465 \begin_layout Description
13466 \begin_inset Flex Code
13469 \begin_layout Plain Layout
13476 \begin_inset Flex Code
13479 \begin_layout Plain Layout
13485 ] The name of the counter for automatic numbering.
13486 In order to have the counter appear with your label, you will need to reference
13488 \begin_inset Flex Code
13491 \begin_layout Plain Layout
13500 This will work with
13501 \begin_inset Flex Code
13504 \begin_layout Plain Layout
13511 \begin_inset Flex Code
13514 \begin_layout Plain Layout
13521 \begin_inset Flex Code
13524 \begin_layout Plain Layout
13531 \begin_inset Flex Code
13534 \begin_layout Plain Layout
13541 \begin_inset Newline newline
13549 \begin_inset Flex Code
13552 \begin_layout Plain Layout
13559 \begin_inset Flex Code
13562 \begin_layout Plain Layout
13568 , though this case is a bit complicated.
13569 Suppose you declare
13570 \begin_inset Quotes eld
13574 \begin_inset Flex Code
13577 \begin_layout Plain Layout
13578 LabelCounter myenum
13584 \begin_inset Quotes erd
13588 Then the actual counters used are
13589 \begin_inset Flex Code
13592 \begin_layout Plain Layout
13599 \begin_inset Flex Code
13602 \begin_layout Plain Layout
13609 \begin_inset Flex Code
13612 \begin_layout Plain Layout
13619 \begin_inset Flex Code
13622 \begin_layout Plain Layout
13628 , much as in \SpecialChar LaTeX
13630 These counters must all be declared separately.
13631 \begin_inset Newline newline
13635 \begin_inset CommandInset ref
13637 reference "subsec:Counters"
13641 for details on counters.
13644 \begin_layout Description
13645 \begin_inset Flex Code
13648 \begin_layout Plain Layout
13654 The font used for the label.
13656 \begin_inset CommandInset ref
13658 reference "subsec:Font-description"
13665 \begin_layout Description
13666 \begin_inset Flex Code
13669 \begin_layout Plain Layout
13676 \begin_inset Flex Code
13679 \begin_layout Plain Layout
13685 ] Text that indicates how far a label should be indented.
13688 \begin_layout Description
13689 \begin_inset Flex Code
13692 \begin_layout Plain Layout
13699 \begin_inset Flex Code
13702 \begin_layout Plain Layout
13708 ] Text that indicates the amount of horizontal space between the label and
13710 Only used for labels that are not above the text body.
13713 \begin_layout Description
13714 \begin_inset Flex Code
13717 \begin_layout Plain Layout
13724 \begin_inset Flex Code
13727 \begin_layout Plain Layout
13733 ] The string used for the label.
13735 \begin_inset Flex Code
13738 \begin_layout Plain Layout
13744 is set, this string can be contain the special formatting commands described
13746 \begin_inset CommandInset ref
13748 reference "subsec:Counters"
13755 \begin_layout Description
13756 \begin_inset Flex Code
13759 \begin_layout Plain Layout
13760 LabelStringAppendix
13766 \begin_inset Flex Code
13769 \begin_layout Plain Layout
13775 ] This is used inside the appendix instead of
13776 \begin_inset Newline newline
13780 \begin_inset Flex Code
13783 \begin_layout Plain Layout
13791 \begin_inset Flex Code
13794 \begin_layout Plain Layout
13801 \begin_inset Newline newline
13805 \begin_inset Flex Code
13808 \begin_layout Plain Layout
13809 LabelStringAppendix
13817 \begin_layout Description
13818 \begin_inset Flex Code
13821 \begin_layout Plain Layout
13827 [FIXME] (Used only with XML-type formats.)
13830 \begin_layout Description
13831 \begin_inset Flex Code
13834 \begin_layout Plain Layout
13841 \begin_inset Flex Code
13844 \begin_layout Plain Layout
13849 , Manual, Static, Above,
13850 \begin_inset Newline newline
13853 Centered, Sensitive, Enumerate,
13854 \begin_inset Newline newline
13857 Itemize, Bibliography
13866 \begin_layout Description
13867 \begin_inset Flex Code
13870 \begin_layout Plain Layout
13876 means the label is the very first word (up to the first real blank).
13877 Use protected spaces if you want more than one word as the label.
13881 \begin_layout Description
13882 \begin_inset Flex Code
13885 \begin_layout Plain Layout
13891 means the label is simply what is declared as
13892 \begin_inset Flex Code
13895 \begin_layout Plain Layout
13902 This will be displayed
13903 \begin_inset Quotes eld
13907 \begin_inset Quotes erd
13910 , at the beginning of the paragraph.
13912 \begin_inset Flex Code
13915 \begin_layout Plain Layout
13922 \begin_inset Flex Code
13925 \begin_layout Plain Layout
13931 , then it will be displayed only in the first paragraph of any sequence
13932 of paragraphs with the same
13933 \begin_inset Flex Code
13936 \begin_layout Plain Layout
13945 \begin_layout Description
13946 \begin_inset Flex Code
13949 \begin_layout Plain Layout
13956 \begin_inset space ~
13960 \begin_inset space ~
13964 \begin_inset Flex Code
13967 \begin_layout Plain Layout
13973 are special cases of
13974 \begin_inset Flex Code
13977 \begin_layout Plain Layout
13984 The label will be printed above the paragraph either at the beginning of
13985 the line or centered.
13988 \begin_layout Description
13989 \begin_inset Flex Code
13992 \begin_layout Plain Layout
13998 is a special case for the caption-labels
13999 \begin_inset Quotes eld
14003 \begin_inset Quotes erd
14007 \begin_inset Quotes eld
14011 \begin_inset Quotes erd
14015 \begin_inset Newline newline
14019 \begin_inset Flex Code
14022 \begin_layout Plain Layout
14028 means the (hardcoded) label string depends on the kind of float: It is
14029 hardcoded to be `FloatType N', where N is the value of the counter associated
14031 For the case that a caption is inserted outside of a float the
14032 \begin_inset Flex Code
14035 \begin_layout Plain Layout
14042 \begin_inset Quotes eld
14046 \begin_inset Quotes erd
14052 \begin_layout Description
14053 \begin_inset Flex Code
14056 \begin_layout Plain Layout
14062 produces the usual sort of enumeration labels.
14063 The number type needs to be set in the
14068 \begin_inset CommandInset ref
14070 reference "subsec:Counters"
14077 \begin_layout Description
14078 \begin_inset Flex Code
14081 \begin_layout Plain Layout
14087 produces various bullets at the different levels.
14088 The bullet types displayed can be set via
14089 \begin_inset Flex Noun
14092 \begin_layout Plain Layout
14093 Document\SpecialChar menuseparator
14094 Settings\SpecialChar menuseparator
14103 \begin_layout Description
14104 \begin_inset Flex Code
14107 \begin_layout Plain Layout
14113 should be used only with
14114 \begin_inset Flex Code
14117 \begin_layout Plain Layout
14118 LatexType BibEnvironment
14127 \begin_layout Description
14128 \begin_inset Flex Code
14131 \begin_layout Plain Layout
14137 Note that this will completely override any prior
14138 \begin_inset Flex Code
14141 \begin_layout Plain Layout
14147 declaration for this style.
14149 \begin_inset Quotes eld
14153 \begin_inset Flex Code
14156 \begin_layout Plain Layout
14163 \begin_inset Quotes erd
14168 \begin_inset CommandInset ref
14170 reference "subsec:I18n"
14174 for details on its use.
14177 \begin_layout Description
14178 \begin_inset Flex Code
14181 \begin_layout Plain Layout
14188 \begin_inset Flex Code
14191 \begin_layout Plain Layout
14197 ] The name of the corresponding \SpecialChar LaTeX
14199 Either the environment or command name.
14202 \begin_layout Description
14203 \begin_inset Flex Code
14206 \begin_layout Plain Layout
14213 \begin_inset Flex Code
14216 \begin_layout Plain Layout
14222 ] An optional parameter for the corresponding
14223 \begin_inset Flex Code
14226 \begin_layout Plain Layout
14233 This parameter cannot be changed from within \SpecialChar LyX
14235 \begin_inset Flex Code
14238 \begin_layout Plain Layout
14244 for customizable parameters).
14245 This will be output as is after all \SpecialChar LaTeX
14247 \begin_inset Flex Code
14250 \begin_layout Plain Layout
14259 \begin_layout Description
14260 \begin_inset Flex Code
14263 \begin_layout Plain Layout
14270 \begin_inset Flex Code
14273 \begin_layout Plain Layout
14278 , Command, Environment, Item_Environment,
14279 \begin_inset Newline newline
14282 List_Environment, Bib_Environment
14287 ] How the style should be translated into \SpecialChar LaTeX
14292 \begin_layout Plain Layout
14293 \begin_inset Flex Code
14296 \begin_layout Plain Layout
14302 is perhaps a bit misleading, since these rules apply to SGML classes, too.
14303 Visit the SGML class files for specific examples.
14312 \begin_layout Description
14313 \begin_inset Flex Code
14316 \begin_layout Plain Layout
14322 means nothing special.
14325 \begin_layout Description
14326 \begin_inset Flex Code
14329 \begin_layout Plain Layout
14336 \begin_inset Flex Code
14339 \begin_layout Plain Layout
14346 {\SpecialChar ldots
14355 \begin_layout Description
14356 \begin_inset Flex Code
14359 \begin_layout Plain Layout
14366 \begin_inset Flex Code
14369 \begin_layout Plain Layout
14376 }\SpecialChar ldots
14392 \begin_layout Description
14393 \begin_inset Flex Code
14396 \begin_layout Plain Layout
14403 \begin_inset Flex Code
14406 \begin_layout Plain Layout
14413 \begin_inset Flex Code
14416 \begin_layout Plain Layout
14424 is generated for each paragraph of this environment.
14428 \begin_layout Description
14429 \begin_inset Flex Code
14432 \begin_layout Plain Layout
14439 \begin_inset Flex Code
14442 \begin_layout Plain Layout
14449 \begin_inset Newline newline
14453 \begin_inset Flex Code
14456 \begin_layout Plain Layout
14462 is passed as an argument to the environment.
14463 \begin_inset Newline newline
14467 \begin_inset Flex Code
14470 \begin_layout Plain Layout
14476 can be defined in the
14477 \begin_inset Flex Noun
14480 \begin_layout Plain Layout
14481 Edit\SpecialChar menuseparator
14483 \begin_inset space ~
14494 \begin_layout Description
14495 \begin_inset Flex Code
14498 \begin_layout Plain Layout
14505 \begin_inset Flex Code
14508 \begin_layout Plain Layout
14514 but adds the necessary mandatory argument (the longest label) to the begin
14515 statement of the bibliography environment:
14516 \begin_inset Newline newline
14520 \begin_inset Flex Code
14523 \begin_layout Plain Layout
14526 begin{thebibliography}{99}
14532 It is therefore only useful for bibliography environments.
14533 The default longest label
14534 \begin_inset Quotes eld
14538 \begin_inset Quotes erd
14541 can be changed by the user in the paragraph settings of a bibliography
14545 \begin_layout Standard
14546 Putting the last few things together, the \SpecialChar LaTeX
14547 output will be either:
14550 \begin_layout LyX-Code
14553 LatexName[LatexParam]{\SpecialChar ldots
14557 \begin_layout Standard
14561 \begin_layout LyX-Code
14564 begin{LatexName}[LatexParam] \SpecialChar ldots
14570 \begin_layout Standard
14571 depending upon the \SpecialChar LaTeX
14576 \begin_layout Description
14577 \begin_inset Flex Code
14580 \begin_layout Plain Layout
14587 \begin_inset Flex Code
14590 \begin_layout Plain Layout
14596 ] A string that is put at the beginning of the style content.
14597 A line break in the output can be indicated by
14598 \begin_inset Flex Code
14601 \begin_layout Plain Layout
14610 \begin_layout Description
14611 \begin_inset Flex Code
14614 \begin_layout Plain Layout
14621 \begin_inset Flex Code
14624 \begin_layout Plain Layout
14630 ] If you put styles into environments, the different
14631 \begin_inset Flex Code
14634 \begin_layout Plain Layout
14640 are not simply added, but added with a factor
14641 \begin_inset Formula $\frac{4}{\mathrm{depth}+4}$
14645 Note that this parameter is also used when
14646 \begin_inset Flex Code
14649 \begin_layout Plain Layout
14656 \begin_inset Flex Code
14659 \begin_layout Plain Layout
14666 \begin_inset Flex Code
14669 \begin_layout Plain Layout
14676 Then it is added to the manual or dynamic margin.
14677 \begin_inset Newline newline
14681 \begin_inset Quotes eld
14685 \begin_inset Flex Code
14688 \begin_layout Plain Layout
14695 \begin_inset Quotes erd
14698 means that the paragraph is indented with the width of
14699 \begin_inset Quotes eld
14703 \begin_inset Flex Code
14706 \begin_layout Plain Layout
14713 \begin_inset Quotes erd
14716 in the normal font.
14717 You can get a negative width by prefixing the string with
14718 \begin_inset Quotes eld
14722 \begin_inset Flex Code
14725 \begin_layout Plain Layout
14732 \begin_inset Quotes erd
14736 This way was chosen so that the look is the same with each used screen
14740 \begin_layout Description
14741 \begin_inset Flex Code
14744 \begin_layout Plain Layout
14751 \begin_inset Flex Code
14754 \begin_layout Plain Layout
14759 , Manual, Dynamic, First_Dynamic, Right_Address_Box
14765 \begin_inset Newline newline
14768 The kind of margin that the style has on the left side.
14772 \begin_layout Description
14773 \begin_inset Flex Code
14776 \begin_layout Plain Layout
14782 just means a fixed margin.
14785 \begin_layout Description
14786 \begin_inset Flex Code
14789 \begin_layout Plain Layout
14795 means that the left margin depends on the string entered in the
14796 \begin_inset Flex Noun
14799 \begin_layout Plain Layout
14800 Edit\SpecialChar menuseparator
14802 \begin_inset space ~
14811 This is used to typeset nice lists without tabulators.
14814 \begin_layout Description
14815 \begin_inset Flex Code
14818 \begin_layout Plain Layout
14824 means that the margin depends on the size of the label.
14825 This is used for automatic enumerated headlines.
14826 It is obvious that the headline
14827 \begin_inset Quotes eld
14830 5.4.3.2.1 Very long headline
14831 \begin_inset Quotes erd
14834 must have a wider left margin (as wide as
14835 \begin_inset Quotes eld
14839 \begin_inset Quotes erd
14842 plus the space) than
14843 \begin_inset Quotes eld
14846 3.2 Very long headline
14847 \begin_inset Quotes erd
14851 \begin_inset Quotes eld
14855 \begin_inset Quotes erd
14858 are not able to do this.
14861 \begin_layout Description
14862 \begin_inset Flex Code
14865 \begin_layout Plain Layout
14871 is similar, but only the very first row of the paragraph is dynamic, while
14872 the others are static; this is used, for example, for descriptions.
14875 \begin_layout Description
14876 \begin_inset Flex Code
14879 \begin_layout Plain Layout
14885 means the margin is chosen in a way that the longest row of this paragraph
14886 fits to the right margin.
14887 This is used to typeset an address on the right edge of the page.
14891 \begin_layout Description
14892 \begin_inset Flex Code
14895 \begin_layout Plain Layout
14902 \begin_inset Flex Code
14905 \begin_layout Plain Layout
14914 \begin_inset space \thinspace{}
14918 \begin_inset Flex Code
14921 \begin_layout Plain Layout
14927 ] Whether fragile commands in this style should be
14928 \begin_inset Flex Code
14931 \begin_layout Plain Layout
14944 whether this command should itself be protected.)
14945 \change_inserted -712698321 1523696949
14949 \begin_layout Description
14951 \change_inserted -712698321 1523696969
14952 \begin_inset Flex Code
14955 \begin_layout Plain Layout
14957 \change_inserted -712698321 1523696950
14964 \begin_inset Flex Code
14967 \begin_layout Plain Layout
14969 \change_inserted -712698321 1523696950
14978 \begin_inset space \thinspace{}
14982 \begin_inset Flex Code
14985 \begin_layout Plain Layout
14987 \change_inserted -712698321 1523696950
14993 ] This causes macros that contain this layout to be protected with
14994 \begin_inset Flex Code
14997 \begin_layout Plain Layout
14999 \change_inserted -712698321 1523696950
15012 ) if necessary and thus allows (some) verbatim stuff in macros.
15017 \begin_layout Description
15018 \begin_inset Flex Code
15021 \begin_layout Plain Layout
15028 \begin_inset Flex Code
15031 \begin_layout Plain Layout
15038 \begin_inset space \thinspace{}
15042 \begin_inset Flex Code
15045 \begin_layout Plain Layout
15053 ] Whether newlines are translated into \SpecialChar LaTeX
15055 \begin_inset Flex Code
15058 \begin_layout Plain Layout
15069 The translation can be switched off to allow more comfortable \SpecialChar LaTeX
15071 inside \SpecialChar LyX
15075 \begin_layout Description
15076 \begin_inset Flex Code
15079 \begin_layout Plain Layout
15086 \begin_inset Flex Code
15089 \begin_layout Plain Layout
15098 \begin_inset space \thinspace{}
15102 \begin_inset Flex Code
15105 \begin_layout Plain Layout
15111 ] If set to true, and if
15112 \begin_inset Flex Code
15115 \begin_layout Plain Layout
15122 \begin_inset Flex Code
15125 \begin_layout Plain Layout
15131 ) paragraphs are being indented, then the indentation of such a paragraph
15132 following one of this type will be suppressed.
15133 (So this will not affect the display of non-default paragraphs.)
15136 \begin_layout Description
15137 \begin_inset Flex Code
15140 \begin_layout Plain Layout
15147 \begin_inset Flex Code
15150 \begin_layout Plain Layout
15156 ] Name of a style that has replaced this style.
15157 This is used to rename a style, while keeping backward compatibility.
15160 \begin_layout Description
15161 \begin_inset Flex Code
15164 \begin_layout Plain Layout
15171 \begin_inset Flex Code
15174 \begin_layout Plain Layout
15181 \begin_inset space \thinspace{}
15185 \begin_inset Flex Code
15188 \begin_layout Plain Layout
15194 ] Determines whether consecutive paragraphs of the same type are treated
15195 as belonging together.
15196 This has the effect that the
15197 \begin_inset Flex Code
15200 \begin_layout Plain Layout
15206 is only printed once before such a group.
15207 By default, this is true for
15208 \begin_inset Flex Code
15211 \begin_layout Plain Layout
15218 \begin_inset Flex Code
15221 \begin_layout Plain Layout
15228 \begin_inset Flex Code
15231 \begin_layout Plain Layout
15237 and false for all other types.
15240 \begin_layout Description
15241 \begin_inset Flex Code
15244 \begin_layout Plain Layout
15251 \begin_inset Flex Code
15254 \begin_layout Plain Layout
15263 \begin_inset space \thinspace{}
15267 \begin_inset Flex Code
15270 \begin_layout Plain Layout
15276 ] Indicates that paragraphs will not be separated by an empty line in \SpecialChar LaTeX
15278 but only by a line break; together with
15279 \begin_inset Flex Code
15282 \begin_layout Plain Layout
15288 , this allows to emulate a plain text editor (like the ERT inset).
15291 \begin_layout Description
15292 \begin_inset Flex Code
15295 \begin_layout Plain Layout
15302 \begin_inset Flex Code
15305 \begin_layout Plain Layout
15311 ] The indent of the very first line of a paragraph.
15313 \begin_inset Newline newline
15317 \begin_inset Flex Code
15320 \begin_layout Plain Layout
15326 will be fixed for a certain style.
15327 The exception is the default style, since the indentation for these paragraphs
15328 can be prohibited with
15329 \begin_inset Flex Code
15332 \begin_layout Plain Layout
15340 \begin_inset Flex Code
15343 \begin_layout Plain Layout
15349 style paragraphs inside environments use the
15350 \begin_inset Flex Code
15353 \begin_layout Plain Layout
15359 of the environment, not their native one.
15361 \begin_inset Flex Code
15364 \begin_layout Plain Layout
15370 paragraphs inside an enumeration are not indented.
15373 \begin_layout Description
15374 \begin_inset Flex Code
15377 \begin_layout Plain Layout
15384 \begin_inset Flex Code
15387 \begin_layout Plain Layout
15393 ] The vertical space between two paragraphs of this style.
15396 \begin_layout Description
15397 \begin_inset Flex Code
15400 \begin_layout Plain Layout
15407 \begin_inset Flex Code
15410 \begin_layout Plain Layout
15417 allows the user to choose either
15418 \begin_inset Quotes eld
15422 \begin_inset Quotes erd
15426 \begin_inset Quotes eld
15430 \begin_inset Quotes erd
15433 to separate paragraphs.
15435 \begin_inset Quotes eld
15439 \begin_inset Quotes erd
15443 \begin_inset Flex Code
15446 \begin_layout Plain Layout
15454 \begin_inset Quotes eld
15458 \begin_inset Quotes erd
15462 \begin_inset Flex Code
15465 \begin_layout Plain Layout
15471 is ignored and all paragraphs are separated by the
15472 \begin_inset Flex Code
15475 \begin_layout Plain Layout
15482 The vertical space is calculated with
15483 \begin_inset Flex Code
15486 \begin_layout Plain Layout
15488 \begin_inset space ~
15497 \begin_inset Flex Code
15500 \begin_layout Plain Layout
15506 is the height of a row with the normal font.
15507 This way, the look stays the same with different screen fonts.
15510 \begin_layout Description
15511 \begin_inset Flex Code
15514 \begin_layout Plain Layout
15521 \begin_inset Flex Code
15524 \begin_layout Plain Layout
15533 \begin_inset space \thinspace{}
15537 \begin_inset Flex Code
15540 \begin_layout Plain Layout
15546 ] Whether the contents of this paragraph should be output in raw form, meaning
15547 without special translations that \SpecialChar LaTeX
15551 \begin_layout Description
15552 \begin_inset Flex Code
15555 \begin_layout Plain Layout
15562 \begin_inset Flex Code
15565 \begin_layout Plain Layout
15575 Defines individual characters that should be output in raw form, meaning
15576 without special translations that \SpecialChar LaTeX
15580 \begin_layout Description
15581 \begin_inset Flex Code
15584 \begin_layout Plain Layout
15590 Information to be included in the \SpecialChar LaTeX
15591 preamble when this style is used.
15592 Used to define macros, load packages, etc., required by this particular
15595 \begin_inset Quotes eld
15599 \begin_inset Flex Code
15602 \begin_layout Plain Layout
15609 \begin_inset Quotes erd
15615 \begin_layout Description
15616 \begin_inset Flex Code
15619 \begin_layout Plain Layout
15626 \begin_inset Flex Code
15629 \begin_layout Plain Layout
15635 ] The prefix to use when creating labels referring to paragraphs of this
15637 This allows the use of formatted references.
15640 \begin_layout Description
15641 \begin_inset Flex Code
15644 \begin_layout Plain Layout
15651 \begin_inset Flex Code
15654 \begin_layout Plain Layout
15660 ] Whether the style requires the feature
15661 \begin_inset Flex Code
15664 \begin_layout Plain Layout
15671 \begin_inset CommandInset ref
15673 reference "chap:List-of-functions"
15677 for the list of features).
15678 If you require a package with specific options, you can additionally use
15680 \begin_inset Flex Code
15683 \begin_layout Plain Layout
15689 as a general text class parameter (see
15690 \begin_inset CommandInset ref
15692 reference "subsec:General-text-class"
15699 \begin_layout Description
15700 \begin_inset Flex Code
15703 \begin_layout Plain Layout
15710 \begin_inset Flex Code
15713 \begin_layout Plain Layout
15722 \begin_inset Flex Code
15725 \begin_layout Plain Layout
15731 ] Resets the \SpecialChar LaTeX
15732 arguments of this style (as defined via the
15733 \begin_inset Flex Code
15736 \begin_layout Plain Layout
15743 This is useful if you have copied a style via
15744 \begin_inset Flex Code
15747 \begin_layout Plain Layout
15753 , but you do not want to inherit its (required and optional) arguments.
15756 \begin_layout Description
15757 \begin_inset Flex Code
15760 \begin_layout Plain Layout
15767 \begin_inset Flex Code
15770 \begin_layout Plain Layout
15779 \begin_inset Flex Code
15782 \begin_layout Plain Layout
15788 ] Resumes a counter that is usually reset at each new sequence of layouts.
15789 This is currently only useful when
15790 \begin_inset Flex Code
15793 \begin_layout Plain Layout
15800 \begin_inset Flex Code
15803 \begin_layout Plain Layout
15812 \begin_layout Description
15813 \begin_inset Flex Code
15816 \begin_layout Plain Layout
15823 \begin_inset Flex Code
15826 \begin_layout Plain Layout
15832 ] A string that is put at the end of the layout content.
15833 A line break in the output can be indicated by
15834 \begin_inset Flex Code
15837 \begin_layout Plain Layout
15846 \begin_layout Description
15847 \begin_inset Flex Code
15850 \begin_layout Plain Layout
15857 \begin_inset Flex Code
15860 \begin_layout Plain Layout
15867 \begin_inset Flex Code
15870 \begin_layout Plain Layout
15879 \begin_layout Description
15880 \begin_inset Flex Code
15883 \begin_layout Plain Layout
15890 \begin_inset Flex Code
15893 \begin_layout Plain Layout
15902 \begin_inset Flex Code
15905 \begin_layout Plain Layout
15912 \begin_inset Flex Code
15915 \begin_layout Plain Layout
15922 \begin_inset Flex Code
15925 \begin_layout Plain Layout
15927 \begin_inset space ~
15935 ] This defines what the default spacing should be in the style.
15937 \begin_inset Flex Code
15940 \begin_layout Plain Layout
15947 \begin_inset Flex Code
15950 \begin_layout Plain Layout
15957 \begin_inset Flex Code
15960 \begin_layout Plain Layout
15966 correspond respectively to a multiplier value of 1, 1.25 and 1.667.
15967 If you specify the argument
15968 \begin_inset Flex Code
15971 \begin_layout Plain Layout
15977 , then you must also provide a value argument which will be the actual multiplie
15979 Note that, contrary to other parameters,
15980 \begin_inset Flex Code
15983 \begin_layout Plain Layout
15989 implies the generation of specific \SpecialChar LaTeX
15990 code, using the \SpecialChar LaTeX
15994 \begin_inset Flex Code
15997 \begin_layout Plain Layout
16006 \begin_layout Description
16007 \begin_inset Flex Code
16010 \begin_layout Plain Layout
16017 \begin_inset Flex Code
16020 \begin_layout Plain Layout
16027 \begin_inset space \thinspace{}
16031 \begin_inset Flex Code
16034 \begin_layout Plain Layout
16042 ] Allow spell-checking paragraphs of this style.
16046 \begin_layout Description
16047 \begin_inset Flex Code
16050 \begin_layout Plain Layout
16057 \begin_inset Flex Code
16060 \begin_layout Plain Layout
16069 \begin_inset Flex Code
16072 \begin_layout Plain Layout
16078 ] Steps the master counter of a given counter at the beginning of a new
16079 sequence of layouts.
16080 This is currently only useful when
16081 \begin_inset Flex Code
16084 \begin_layout Plain Layout
16091 \begin_inset Flex Code
16094 \begin_layout Plain Layout
16103 \begin_layout Description
16104 \begin_inset Flex Code
16107 \begin_layout Plain Layout
16113 The font used for the text body .
16115 \begin_inset CommandInset ref
16117 reference "subsec:Font-description"
16124 \begin_layout Description
16125 \begin_inset Flex Code
16128 \begin_layout Plain Layout
16137 \begin_inset Flex Code
16140 \begin_layout Plain Layout
16150 The level of the style in the table of contents.
16151 This is used for automatic numbering of section headings.
16154 \begin_layout Description
16155 \begin_inset Flex Code
16158 \begin_layout Plain Layout
16167 \begin_inset Flex Code
16170 \begin_layout Plain Layout
16181 \begin_inset Flex Code
16184 \begin_layout Plain Layout
16191 \begin_inset Flex Code
16194 \begin_layout Plain Layout
16200 ] This tag determines whether the first line indentation of this paragraph
16201 can be toggled via the Paragraph settings dialog.
16205 \begin_inset Flex Code
16208 \begin_layout Plain Layout
16218 is set, indentation can be toggled if the document settings use
16219 \begin_inset Quotes eld
16223 \begin_inset Quotes erd
16226 paragraph style, with
16227 \begin_inset Flex Code
16230 \begin_layout Plain Layout
16236 , indentation can always be toggled, notwithstanding the document settings,
16238 \begin_inset Flex Code
16241 \begin_layout Plain Layout
16247 , indentation can never be toggled.
16250 \begin_layout Description
16251 \begin_inset Flex Code
16254 \begin_layout Plain Layout
16261 \begin_inset Flex Code
16264 \begin_layout Plain Layout
16270 ] The vertical space with which the very first of a chain of paragraphs
16271 with this style is separated from the previous paragraph.
16272 If the previous paragraph has another style, the separations are not simply
16273 added, but the maximum is taken.
16276 \begin_layout Subsection
16277 \begin_inset CommandInset label
16283 Internationalization of Paragraph Styles
16286 \begin_layout Standard
16288 has long supported internationalization of layout information, but, until
16289 version 2.0, this applied only to the user interface and not to, say, PDF
16291 Thus, French authors were forced to resort to ugly hacks if they wanted
16296 1' instead of `Theorem 1'.
16297 Thanks to Georg Baum, that is no longer the case.
16300 \begin_layout Standard
16302 \begin_inset Flex Code
16305 \begin_layout Plain Layout
16311 defines text that is to appear in the typeset document, it may use
16312 \begin_inset Flex Code
16315 \begin_layout Plain Layout
16322 \begin_inset Flex Code
16325 \begin_layout Plain Layout
16331 to support non-English and even multi-language documents correctly.
16332 The following excerpt (from the
16333 \begin_inset Flex Code
16336 \begin_layout Plain Layout
16342 file) shows how this works:
16345 \begin_layout LyX-Code
16350 \begin_layout LyX-Code
16353 theoremstyle{remark}
16356 \begin_layout LyX-Code
16359 newtheorem{claim}[thm]{
16366 \begin_layout LyX-Code
16370 \begin_layout LyX-Code
16374 \begin_layout LyX-Code
16379 claimname}{_(Claim)}
16382 \begin_layout LyX-Code
16386 \begin_layout LyX-Code
16390 \begin_layout LyX-Code
16399 claimname}{_(Claim)}}
16402 \begin_layout LyX-Code
16407 \begin_layout Standard
16408 In principle, any legal \SpecialChar LaTeX
16410 \begin_inset Flex Code
16413 \begin_layout Plain Layout
16420 \begin_inset Flex Code
16423 \begin_layout Plain Layout
16429 tags, but in practice they will typically look as they do here.
16430 The key to correct translation of the typeset text is the definition of
16431 the \SpecialChar LaTeX
16433 \begin_inset Flex Code
16436 \begin_layout Plain Layout
16445 \begin_inset Flex Code
16448 \begin_layout Plain Layout
16460 \begin_layout Standard
16462 \begin_inset Flex Code
16465 \begin_layout Plain Layout
16471 tag provides for internationalization based upon the overall language of
16473 The contents of the tag will be included in the preamble, just as with
16475 \begin_inset Flex Code
16478 \begin_layout Plain Layout
16485 What makes it special is the use of the
16486 \begin_inset Quotes eld
16490 \begin_inset Quotes erd
16494 \begin_inset Flex Code
16497 \begin_layout Plain Layout
16503 , which will be replaced, when \SpecialChar LyX
16504 produces \SpecialChar LaTeX
16505 output, with the translation of
16506 its argument into the document language.
16509 \begin_layout Standard
16511 \begin_inset Flex Code
16514 \begin_layout Plain Layout
16520 tag is more complex, since it is meant to provide support for multi-language
16521 documents and so offers an interface to the
16522 \begin_inset Flex Code
16525 \begin_layout Plain Layout
16532 Its contents will be added to the preamble once for each language that
16533 appears in the document.
16534 In this case, the argument to
16535 \begin_inset Flex Code
16538 \begin_layout Plain Layout
16544 will be replaced with its translation into the language in question; the
16546 \begin_inset Flex Code
16549 \begin_layout Plain Layout
16555 is replaced by the language name (as used by the babel package).
16558 \begin_layout Standard
16559 A German document that also included a French section would thus have the
16560 following in the preamble:
16563 \begin_layout LyX-Code
16572 claimname}{Affirmation}}
16573 \begin_inset Newline newline
16584 claimname}{Behauptung}}
16585 \begin_inset Newline newline
16592 claimname}{Behauptung}
16595 \begin_layout Standard
16598 \begin_inset Flex Code
16601 \begin_layout Plain Layout
16607 will then conspire to produce the correct text in the output.
16610 \begin_layout Standard
16611 One important point to note here is that the translations are provided by
16613 itself, through the file
16614 \begin_inset Flex Code
16617 \begin_layout Plain Layout
16624 This means, in effect, that
16625 \begin_inset Flex Code
16628 \begin_layout Plain Layout
16635 \begin_inset Flex Code
16638 \begin_layout Plain Layout
16644 are really only of use in layout files that are provided with \SpecialChar LyX
16646 entered in user-created layout files will not be seen by \SpecialChar LyX
16647 's internationalizatio
16648 n routines unless the
16649 \begin_inset Flex Code
16652 \begin_layout Plain Layout
16658 file is modified accordingly.
16659 That said, however, any layout created with the intention that it will
16660 be included with \SpecialChar LyX
16661 should use these tags where appropriate.
16662 Please note that the paragraph style translations provided by \SpecialChar LyX
16664 change with a minor update (e.
16665 \begin_inset space \thinspace{}
16669 \begin_inset space \space{}
16672 from version 2.1.x to 2.1.y).
16673 It is however quite likely that a major update (e.
16674 \begin_inset space \thinspace{}
16678 \begin_inset space \space{}
16681 from 2.0.x to 2.1.0) will introduce new translations or corrections.
16684 \begin_layout Subsection
16686 \begin_inset CommandInset label
16688 name "subsec:Floats"
16695 \begin_layout Standard
16696 It is necessary to define the floats (
16697 \begin_inset Flex Noun
16700 \begin_layout Plain Layout
16707 \begin_inset Flex Noun
16710 \begin_layout Plain Layout
16716 , \SpecialChar ldots
16717 ) in the text class itself.
16718 Standard floats are included in the file
16719 \begin_inset Flex Code
16722 \begin_layout Plain Layout
16728 , so you may have to do no more than add
16731 \begin_layout LyX-Code
16732 Input stdfloats.inc
16735 \begin_layout Standard
16736 to your layout file.
16737 If you want to implement a text class that proposes some other float types
16738 (like the AGU class bundled with \SpecialChar LyX
16739 ), the information below will hopefully
16743 \begin_layout Description
16744 \begin_inset Flex Code
16747 \begin_layout Plain Layout
16754 \begin_inset Flex Code
16757 \begin_layout Plain Layout
16763 =!htbpH] Allowed placement options for this float type.
16764 The value is a string of placement characters.
16765 Possible characters include:
16770 \begin_inset Quotes eld
16774 \begin_inset Quotes erd
16782 \begin_inset Quotes eld
16786 \begin_inset Quotes erd
16794 \begin_inset Quotes eld
16798 \begin_inset Quotes erd
16806 \begin_inset Quotes eld
16810 \begin_inset Quotes erd
16818 \begin_inset Quotes eld
16822 \begin_inset Quotes erd
16830 \begin_inset Quotes eld
16834 \begin_inset Quotes erd
16838 The order of the characters in the string does not matter.
16839 If no placement options are allowed, use the string
16846 \begin_layout Description
16847 \begin_inset Flex Code
16850 \begin_layout Plain Layout
16857 \begin_inset Flex Code
16860 \begin_layout Plain Layout
16869 \begin_inset space \thinspace{}
16875 \begin_inset Flex Code
16878 \begin_layout Plain Layout
16888 ] Defines whether the float allows to be rotated via the \SpecialChar LaTeX
16895 \begin_inset Flex Code
16898 \begin_layout Plain Layout
16904 if the float does not support this feature.
16907 \begin_layout Description
16908 \begin_inset Flex Code
16911 \begin_layout Plain Layout
16918 \begin_inset Flex Code
16921 \begin_layout Plain Layout
16930 \begin_inset space \thinspace{}
16936 \begin_inset Flex Code
16939 \begin_layout Plain Layout
16949 ] Defines whether the float has a starred variant that spans columns in
16950 a two column paragraph.
16952 \begin_inset Flex Code
16955 \begin_layout Plain Layout
16961 if the float does not support this feature.
16964 \begin_layout Description
16965 \begin_inset Flex Code
16968 \begin_layout Plain Layout
16975 \begin_inset Flex Code
16978 \begin_layout Plain Layout
16985 \begin_inset Quotes erd
16989 \begin_inset Quotes erd
16992 ] The file name extension of an auxiliary file for the list of figures (or
16995 writes the captions to this file.
16998 \begin_layout Description
16999 \begin_inset Flex Code
17002 \begin_layout Plain Layout
17009 \begin_inset Flex Code
17012 \begin_layout Plain Layout
17019 \begin_inset Quotes erd
17023 \begin_inset Quotes erd
17026 ] The string that will be used in the menus and also for the caption.
17027 This is translated to the current language if babel is used.
17030 \begin_layout Description
17031 \begin_inset Flex Code
17034 \begin_layout Plain Layout
17040 These tags control the XHTML output.
17042 \begin_inset CommandInset ref
17044 reference "sec:Tags-for-XHTML"
17051 \begin_layout Description
17052 \begin_inset Flex Code
17055 \begin_layout Plain Layout
17064 \begin_inset Flex Code
17067 \begin_layout Plain Layout
17076 \begin_inset space \thinspace{}
17080 \begin_inset Flex Code
17083 \begin_layout Plain Layout
17089 ] Indicates whether the float is already defined in the document class or
17090 if instead the \SpecialChar LaTeX
17092 \begin_inset Flex Code
17095 \begin_layout Plain Layout
17101 needs to be loaded to define it on-the-fly.
17103 \begin_inset Flex Code
17106 \begin_layout Plain Layout
17113 \begin_inset Flex Code
17116 \begin_layout Plain Layout
17123 It should be set to
17124 \begin_inset Flex Code
17127 \begin_layout Plain Layout
17133 if the float is already defined by the \SpecialChar LaTeX
17137 \begin_layout Description
17138 \begin_inset Flex Code
17141 \begin_layout Plain Layout
17148 \begin_inset Flex Code
17151 \begin_layout Plain Layout
17158 \begin_inset Quotes erd
17162 \begin_inset Quotes erd
17165 ] The command used to generate a list of floats of this type; the leading
17174 \begin_inset Flex Code
17177 \begin_layout Plain Layout
17183 is false, since there is no standard way to generate this command.
17185 \begin_inset Flex Code
17188 \begin_layout Plain Layout
17194 is true, since in that case there is a standard way to define the command.
17197 \begin_layout Description
17198 \begin_inset Flex Code
17201 \begin_layout Plain Layout
17208 \begin_inset Flex Code
17211 \begin_layout Plain Layout
17218 \begin_inset Quotes erd
17222 \begin_inset Quotes erd
17225 ] A title for a list of floats of this kind (list of figures, tables, or
17227 It is used for the screen label within \SpecialChar LyX
17228 , it is used by \SpecialChar LaTeX
17230 it is used as the title in the XHTML output.
17231 It will be translated to the document language.
17234 \begin_layout Description
17235 \begin_inset Flex Code
17238 \begin_layout Plain Layout
17245 \begin_inset Flex Code
17248 \begin_layout Plain Layout
17255 \begin_inset Quotes erd
17259 \begin_inset Quotes erd
17262 ] This (optional) argument determines whether floats of this class will
17263 be numbered within some sectional unit of the document.
17265 \begin_inset Flex Code
17268 \begin_layout Plain Layout
17275 \begin_inset Quotes eld
17279 \begin_inset Flex Code
17282 \begin_layout Plain Layout
17289 \begin_inset Quotes erd
17292 , the floats will be numbered within chapters.
17296 \begin_layout Description
17297 \begin_inset Flex Code
17300 \begin_layout Plain Layout
17307 \begin_inset Flex Code
17310 \begin_layout Plain Layout
17317 \begin_inset Quotes erd
17321 \begin_inset Quotes erd
17324 ] The default placement for the given class of floats.
17325 The string should be as in standard \SpecialChar LaTeX
17327 \begin_inset Flex Code
17330 \begin_layout Plain Layout
17337 \begin_inset Flex Code
17340 \begin_layout Plain Layout
17347 \begin_inset Flex Code
17350 \begin_layout Plain Layout
17357 \begin_inset Flex Code
17360 \begin_layout Plain Layout
17366 for top, bottom, page, and here, respectively.
17370 \begin_layout Plain Layout
17371 Note that the order of these letters in the string is irrelevant, like in
17378 On top of that there is a new type,
17379 \begin_inset Flex Code
17382 \begin_layout Plain Layout
17388 , which does not really correspond to a float, since it means: put it
17389 \begin_inset Quotes eld
17393 \begin_inset Quotes erd
17397 Note however that the
17398 \begin_inset Flex Code
17401 \begin_layout Plain Layout
17407 specifier is special and, because of implementation details, cannot be
17408 used in non-built in float types.
17409 If you do not understand what this means, just use
17410 \begin_inset Quotes eld
17414 \begin_inset Flex Code
17417 \begin_layout Plain Layout
17424 \begin_inset Quotes erd
17430 \begin_layout Description
17431 \begin_inset Flex Code
17434 \begin_layout Plain Layout
17441 \begin_inset Flex Code
17444 \begin_layout Plain Layout
17450 ] The prefix to use when creating labels referring to floats of this type.
17451 This allows the use of formatted references.
17452 Note that you can remove any
17453 \begin_inset Flex Code
17456 \begin_layout Plain Layout
17462 set by a copied style by using the special value
17463 \begin_inset Quotes eld
17467 \begin_inset Quotes erd
17470 , which must be all caps.
17473 \begin_layout Description
17474 \begin_inset Flex Code
17477 \begin_layout Plain Layout
17484 \begin_inset Flex Code
17487 \begin_layout Plain Layout
17494 \begin_inset Quotes erd
17498 \begin_inset Quotes erd
17501 ] The style used when defining the float using
17502 \begin_inset Flex Code
17505 \begin_layout Plain Layout
17516 \begin_layout Description
17517 \begin_inset Flex Code
17520 \begin_layout Plain Layout
17527 \begin_inset Flex Code
17530 \begin_layout Plain Layout
17537 \begin_inset Quotes erd
17541 \begin_inset Quotes erd
17545 \begin_inset Quotes eld
17549 \begin_inset Quotes erd
17552 of the new class of floats, like program or algorithm.
17553 After the appropriate
17554 \begin_inset Flex Code
17557 \begin_layout Plain Layout
17566 \begin_inset Flex Code
17569 \begin_layout Plain Layout
17578 \begin_inset Flex Code
17581 \begin_layout Plain Layout
17592 \begin_layout Description
17593 \begin_inset Flex Code
17596 \begin_layout Plain Layout
17603 \begin_inset Flex Code
17606 \begin_layout Plain Layout
17613 \begin_inset space \thinspace{}
17617 \begin_inset Flex Code
17620 \begin_layout Plain Layout
17628 ] Specifies whether this float is defined using the \SpecialChar LaTeX
17630 \begin_inset Flex Code
17633 \begin_layout Plain Layout
17639 , either by the class file, another package or on-the-fly by \SpecialChar LyX
17643 \begin_layout Standard
17644 Note that defining a float with type
17645 \begin_inset Flex Code
17648 \begin_layout Plain Layout
17656 automatically defines the corresponding counter with name
17657 \begin_inset Flex Code
17660 \begin_layout Plain Layout
17671 \begin_layout Subsection
17672 Flex insets and InsetLayout
17673 \begin_inset CommandInset label
17675 name "subsec:Flex-insets-and"
17682 \begin_layout Standard
17683 Flex insets come in three different kinds:
17686 \begin_layout Itemize
17688 \begin_inset Flex Code
17691 \begin_layout Plain Layout
17697 ): These define semantic markup corresponding to such \SpecialChar LaTeX
17699 \begin_inset Flex Code
17702 \begin_layout Plain Layout
17711 \begin_inset Flex Code
17714 \begin_layout Plain Layout
17725 \begin_layout Itemize
17727 \begin_inset Flex Code
17730 \begin_layout Plain Layout
17736 ): These can be used to define custom collapsible insets, similar to \SpecialChar TeX
17738 footnote, and the like.
17739 An obvious example is an endnote inset, which is defined in the
17740 \begin_inset Flex Code
17743 \begin_layout Plain Layout
17752 \begin_layout Itemize
17754 \begin_inset Flex Code
17757 \begin_layout Plain Layout
17763 ): For use with DocBook classes.
17766 \begin_layout Standard
17767 Flex insets are defined using the
17768 \begin_inset Flex Code
17771 \begin_layout Plain Layout
17777 tag, which shall be explained in a moment.
17780 \begin_layout Standard
17782 \begin_inset Flex Code
17785 \begin_layout Plain Layout
17791 tag also serves another function: It can be used to customize the general
17792 layout of many different types of insets.
17794 \begin_inset Flex Code
17797 \begin_layout Plain Layout
17803 can be used to customize the layout parameters for footnotes, marginal
17804 notes, note insets, \SpecialChar TeX
17805 code (ERT) insets, branches, listings, indexes, boxes,
17806 tables, algorithms, URLs, and captions, as well as to define Flex insets.
17809 \begin_layout Standard
17811 \begin_inset Flex Code
17814 \begin_layout Plain Layout
17820 definition must begin with a line of the form:
17823 \begin_layout LyX-Code
17827 \begin_layout Standard
17829 \begin_inset Flex Code
17832 \begin_layout Plain Layout
17838 indicates the inset whose layout is being defined, and here there are four
17842 \begin_layout Enumerate
17843 The layout for a pre-existing inset is being modified.
17844 In this case, can be
17845 \begin_inset Flex Code
17848 \begin_layout Plain Layout
17854 any one of the following:
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
17985 \begin_inset Flex Code
17988 \begin_layout Plain Layout
17995 \begin_inset Flex Code
17998 \begin_layout Plain Layout
18005 \begin_inset Flex Code
18008 \begin_layout Plain Layout
18015 \begin_inset Flex Code
18018 \begin_layout Plain Layout
18025 \begin_inset Flex Code
18028 \begin_layout Plain Layout
18035 \begin_inset Flex Code
18038 \begin_layout Plain Layout
18045 \begin_inset Flex Code
18048 \begin_layout Plain Layout
18057 \begin_layout Enumerate
18058 The layout for a Flex inset is being defined.
18060 \begin_inset Flex Code
18063 \begin_layout Plain Layout
18069 must be of the form
18070 \begin_inset Quotes eld
18074 \begin_inset Flex Code
18077 \begin_layout Plain Layout
18084 \begin_inset Quotes erd
18088 \begin_inset Flex Code
18091 \begin_layout Plain Layout
18097 may be be any valid identifier not used by a pre-existing Flex inset.
18098 The identifier may include spaces, but in that case the whole thing must
18099 be wrapped in quotes.
18100 Note that the definition of a flex inset
18105 \begin_inset Flex Code
18108 \begin_layout Plain Layout
18114 entry, declaring which type of inset it defines.
18117 \begin_layout Enumerate
18118 The layout for user specific branch is being defined.
18120 \begin_inset Flex Code
18123 \begin_layout Plain Layout
18129 must be of the form
18130 \begin_inset Quotes eld
18134 \begin_inset Flex Code
18137 \begin_layout Plain Layout
18144 \begin_inset Quotes erd
18148 \begin_inset Flex Code
18151 \begin_layout Plain Layout
18157 may be be any valid identifier of branch defined in user's document.
18158 The identifier may include spaces, but in that case the whole thing must
18159 be wrapped in quotes.
18160 The main purpose of this feature is to allow \SpecialChar LaTeX
18161 wrapping around specific
18162 branches as user needs.
18165 \begin_layout Enumerate
18166 The layout of a user (or class) specific caption is being defined.
18168 \begin_inset Flex Code
18171 \begin_layout Plain Layout
18177 must be of the form
18178 \begin_inset Quotes eld
18182 \begin_inset Flex Code
18185 \begin_layout Plain Layout
18192 \begin_inset Quotes erd
18196 \begin_inset Flex Code
18199 \begin_layout Plain Layout
18205 specifies the name of the caption as it appears in the menu.
18206 Have a look at the standard caption (
18207 \begin_inset Flex Code
18210 \begin_layout Plain Layout
18216 ), the specific captions of the KOMA-Script classes (
18217 \begin_inset Flex Code
18220 \begin_layout Plain Layout
18227 \begin_inset Flex Code
18230 \begin_layout Plain Layout
18239 \begin_inset space ~
18243 \begin_inset Newline linebreak
18249 \begin_inset Flex Code
18252 \begin_layout Plain Layout
18258 ) for applications.
18261 \begin_layout Standard
18263 \begin_inset Flex Code
18266 \begin_layout Plain Layout
18272 definition can contain the following entries:
18275 \begin_layout Description
18276 \begin_inset Flex Code
18279 \begin_layout Plain Layout
18286 \begin_inset Flex Code
18289 \begin_layout Plain Layout
18295 =""] This inset will appear in the table of contents of the given type.
18296 An empty string disables.
18297 See also the OutlinerName and the IsTocCaption commands.
18298 This is only implemented for Flex insets.
18302 \begin_layout Description
18303 \begin_inset Flex Code
18306 \begin_layout Plain Layout
18313 \begin_inset Flex Code
18316 \begin_layout Plain Layout
18322 ] Defines argument number of a command\SpecialChar breakableslash
18323 environment associated with the current
18325 The definition must end with
18326 \begin_inset Flex Code
18329 \begin_layout Plain Layout
18337 \begin_inset CommandInset ref
18339 reference "subsec:Paragraph-Styles"
18346 \begin_layout Description
18347 \begin_inset Flex Code
18350 \begin_layout Plain Layout
18356 Preamble for changing language commands; see
18357 \begin_inset CommandInset ref
18359 reference "subsec:I18n"
18366 \begin_layout Description
18367 \begin_inset Flex Code
18370 \begin_layout Plain Layout
18377 \begin_inset Flex Code
18380 \begin_layout Plain Layout
18386 ] The color for the inset's background.
18388 \begin_inset CommandInset ref
18390 reference "chap:Names-of-colors"
18394 for a list of the available color names.
18397 \begin_layout Description
18398 \begin_inset Flex Code
18401 \begin_layout Plain Layout
18408 \begin_inset Flex Code
18411 \begin_layout Plain Layout
18420 \begin_inset space \thinspace{}
18424 \begin_inset Flex Code
18427 \begin_layout Plain Layout
18433 ] Whether to use the content of the inset as the label, when the inset is
18438 \begin_layout Description
18439 \begin_inset Flex Code
18442 \begin_layout Plain Layout
18449 \begin_inset Flex Code
18452 \begin_layout Plain Layout
18458 ] As with paragraph styles, see
18459 \begin_inset CommandInset ref
18461 reference "subsec:Paragraph-Styles"
18466 Note that you need to specify the complete type, e.
18467 \begin_inset space \thinspace{}
18471 \begin_inset space ~
18475 \begin_inset Flex Code
18478 \begin_layout Plain Layout
18479 CopyStyle Flex:<name>
18487 \begin_layout Description
18488 \begin_inset Flex Code
18491 \begin_layout Plain Layout
18498 \begin_inset Flex Code
18501 \begin_layout Plain Layout
18510 \begin_inset space \thinspace{}
18514 \begin_inset Flex Code
18517 \begin_layout Plain Layout
18523 ] Indicates whether the user may employ the Paragraph Settings dialog to
18524 customize the paragraph.
18527 \begin_layout Description
18528 \begin_inset Flex Code
18531 \begin_layout Plain Layout
18538 \begin_inset Flex Code
18541 \begin_layout Plain Layout
18548 \begin_inset Flex Code
18551 \begin_layout Plain Layout
18558 \begin_inset Flex Code
18561 \begin_layout Plain Layout
18567 , describing the rendering style used for the inset's frame and buttons.
18568 Footnotes generally use
18569 \begin_inset Flex Code
18572 \begin_layout Plain Layout
18578 , ERT insets generally
18579 \begin_inset Flex Code
18582 \begin_layout Plain Layout
18588 , and character styles
18589 \begin_inset Flex Code
18592 \begin_layout Plain Layout
18601 \begin_layout Description
18602 \begin_inset Flex Code
18605 \begin_layout Plain Layout
18612 \begin_inset Flex Code
18615 \begin_layout Plain Layout
18624 \begin_inset space \thinspace{}
18630 \begin_inset Flex Code
18633 \begin_layout Plain Layout
18642 \begin_inset Flex Code
18645 \begin_layout Plain Layout
18652 \begin_inset Flex Code
18655 \begin_layout Plain Layout
18662 Indicates whether the environment will stand on its own in the output or
18663 will appear inline with the surrounding text.
18664 If set to false, it is supposed that the \SpecialChar LaTeX
18665 environment ignores white space
18666 (including one newline character) after the
18667 \begin_inset Flex Code
18670 \begin_layout Plain Layout
18683 \begin_inset Flex Code
18686 \begin_layout Plain Layout
18702 \begin_layout Description
18703 \begin_inset Flex Code
18706 \begin_layout Plain Layout
18712 Required at the end of the
18713 \begin_inset Flex Code
18716 \begin_layout Plain Layout
18725 \begin_layout Description
18726 \begin_inset Flex Code
18729 \begin_layout Plain Layout
18735 The font used for both the text body
18741 \begin_inset CommandInset ref
18743 reference "subsec:Font-description"
18748 Note that defining this font automatically defines the
18749 \begin_inset Flex Code
18752 \begin_layout Plain Layout
18758 to the same value, so define this first and define
18759 \begin_inset Flex Code
18762 \begin_layout Plain Layout
18768 later if you want them to be different.
18771 \begin_layout Description
18772 \begin_inset Flex Code
18775 \begin_layout Plain Layout
18776 FixedWidthPreambleEncoding
18782 \begin_inset Flex Code
18785 \begin_layout Plain Layout
18794 \begin_inset space \thinspace{}
18798 \begin_inset Flex Code
18801 \begin_layout Plain Layout
18807 ] Force a fixed width encoding for the translated contents of
18808 \begin_inset Flex Code
18811 \begin_layout Plain Layout
18818 \begin_inset Flex Code
18821 \begin_layout Plain Layout
18827 code generated by this layout.
18828 This is needed for special \SpecialChar LaTeX
18833 that do not work with variable width encodings such as
18838 This setting is ignored if fully Unicode aware \SpecialChar LaTeX
18839 backends such as Xe\SpecialChar TeX
18841 Lua\SpecialChar TeX
18845 \begin_layout Description
18846 \begin_inset Flex Code
18849 \begin_layout Plain Layout
18850 ForceLocalFontSwitch
18856 \begin_inset Flex Code
18859 \begin_layout Plain Layout
18868 \begin_inset space \thinspace{}
18872 \begin_inset Flex Code
18875 \begin_layout Plain Layout
18881 ] When using babel, always use a local font switch (
18882 \begin_inset Flex Code
18885 \begin_layout Plain Layout
18893 ), never a global one (such as
18894 \begin_inset Flex Code
18897 \begin_layout Plain Layout
18908 \begin_layout Description
18909 \begin_inset Flex Code
18912 \begin_layout Plain Layout
18919 \begin_inset Flex Code
18922 \begin_layout Plain Layout
18931 \begin_inset space \thinspace{}
18935 \begin_inset Flex Code
18938 \begin_layout Plain Layout
18945 \begin_inset Quotes eld
18949 \begin_inset Quotes erd
18952 language, leading to Left-to-Right (Latin) output, e.
18953 \begin_inset space \thinspace{}
18957 \begin_inset space \space{}
18960 in \SpecialChar TeX
18965 \begin_layout Description
18966 \begin_inset Flex Code
18969 \begin_layout Plain Layout
18976 \begin_inset Flex Code
18979 \begin_layout Plain Layout
18988 \begin_inset space \thinspace{}
18992 \begin_inset Flex Code
18995 \begin_layout Plain Layout
19001 ] Force a a line break in the \SpecialChar LaTeX
19002 output before the inset starts and after
19004 This assures the inset itself is output on its own lines, for parsing purposes.
19007 \begin_layout Description
19008 \begin_inset Flex Code
19011 \begin_layout Plain Layout
19018 \begin_inset Flex Code
19021 \begin_layout Plain Layout
19030 \begin_inset space \thinspace{}
19034 \begin_inset Flex Code
19037 \begin_layout Plain Layout
19043 ] Indicates whether the
19044 \begin_inset Flex Code
19047 \begin_layout Plain Layout
19053 should be used or, instead, the user can change the paragraph style used
19058 \begin_layout Description
19059 \begin_inset Flex Code
19062 \begin_layout Plain Layout
19069 \begin_inset Flex Code
19072 \begin_layout Plain Layout
19081 \begin_inset space \thinspace{}
19085 \begin_inset Flex Code
19088 \begin_layout Plain Layout
19094 ] As with paragraph styles, see
19095 \begin_inset CommandInset ref
19097 reference "subsec:Paragraph-Styles"
19104 \begin_layout Description
19105 \begin_inset Flex Code
19108 \begin_layout Plain Layout
19114 These tags control the XHTML output.
19116 \begin_inset CommandInset ref
19118 reference "sec:Tags-for-XHTML"
19125 \begin_layout Description
19126 \begin_inset Flex Code
19129 \begin_layout Plain Layout
19136 \begin_inset Flex Code
19139 \begin_layout Plain Layout
19148 \begin_inset space \thinspace{}
19152 \begin_inset Flex Code
19155 \begin_layout Plain Layout
19161 ] Whether to include the contents of this inset in the strings generated
19162 for the `Outline' pane for all table of contents, regardless of the AddToToc
19164 One would not, for example, want the content of a footnote in a section
19165 header to be included in the TOC displayed in the outline, but one would
19166 normally want the content of a character style displayed.
19167 Default is false: not to include.
19170 \begin_layout Description
19171 \begin_inset Flex Code
19174 \begin_layout Plain Layout
19181 \begin_inset Flex Code
19184 \begin_layout Plain Layout
19193 \begin_inset space \thinspace{}
19197 \begin_inset Flex Code
19200 \begin_layout Plain Layout
19206 ] If this is set to 1 and AddToToc is enabled, the inset adds a summary
19207 of its contents in its item in the table of contents.
19208 Otherwise, only the label appears.
19211 \begin_layout Description
19212 \begin_inset Flex Code
19215 \begin_layout Plain Layout
19224 \begin_inset Flex Code
19227 \begin_layout Plain Layout
19236 \begin_inset space \thinspace{}
19240 \begin_inset Flex Code
19243 \begin_layout Plain Layout
19249 ] As with paragraph styles, see
19250 \begin_inset CommandInset ref
19252 reference "subsec:Paragraph-Styles"
19259 \begin_layout Description
19260 \begin_inset Flex Code
19263 \begin_layout Plain Layout
19269 The font used for the label.
19271 \begin_inset CommandInset ref
19273 reference "subsec:Font-description"
19278 Note that this definition can never appear before
19279 \begin_inset Flex Code
19282 \begin_layout Plain Layout
19288 , lest it be ineffective.
19291 \begin_layout Description
19292 \begin_inset Flex Code
19295 \begin_layout Plain Layout
19302 \begin_inset Flex Code
19305 \begin_layout Plain Layout
19312 \begin_inset Quotes erd
19316 \begin_inset Quotes erd
19319 ] What will be displayed on the button or elsewhere as the inset label.
19321 \begin_inset Flex Code
19324 \begin_layout Plain Layout
19332 \begin_inset Flex Code
19335 \begin_layout Plain Layout
19341 ) modify this label on the fly.
19344 \begin_layout Description
19345 \begin_inset Flex Code
19348 \begin_layout Plain Layout
19354 Language dependent preamble; see
19355 \begin_inset CommandInset ref
19357 reference "subsec:I18n"
19364 \begin_layout Description
19365 \begin_inset Flex Code
19368 \begin_layout Plain Layout
19375 \begin_inset Flex Code
19378 \begin_layout Plain Layout
19384 ] The name of the corresponding \SpecialChar LaTeX
19386 Either the environment or command name.
19389 \begin_layout Description
19390 \begin_inset Flex Code
19393 \begin_layout Plain Layout
19400 \begin_inset Flex Code
19403 \begin_layout Plain Layout
19409 ] The optional parameter for the corresponding
19410 \begin_inset Flex Code
19413 \begin_layout Plain Layout
19419 stuff, including possible bracket pairs like
19420 \begin_inset Flex Code
19423 \begin_layout Plain Layout
19430 This parameter cannot be changed from within \SpecialChar LyX
19432 \begin_inset Flex Code
19435 \begin_layout Plain Layout
19441 for customizable parameters).
19442 It will be output as is after all \SpecialChar LaTeX
19444 \begin_inset Flex Code
19447 \begin_layout Plain Layout
19456 \begin_layout Description
19457 \begin_inset Flex Code
19460 \begin_layout Plain Layout
19467 \begin_inset Flex Code
19470 \begin_layout Plain Layout
19471 Command, Environment, None
19476 ] How the style should be translated into \SpecialChar LaTeX
19481 \begin_layout Plain Layout
19482 \begin_inset Flex Code
19485 \begin_layout Plain Layout
19491 is perhaps a bit misleading, since these rules apply to SGML classes too.
19492 Visit the SGML class files for specific examples.
19501 \begin_layout Description
19502 \begin_inset Flex Code
19505 \begin_layout Plain Layout
19511 means nothing special
19514 \begin_layout Description
19515 \begin_inset Flex Code
19518 \begin_layout Plain Layout
19525 \begin_inset Flex Code
19528 \begin_layout Plain Layout
19535 {\SpecialChar ldots
19544 \begin_layout Description
19545 \begin_inset Flex Code
19548 \begin_layout Plain Layout
19555 \begin_inset Flex Code
19558 \begin_layout Plain Layout
19565 }\SpecialChar ldots
19580 \begin_layout Standard
19581 Putting the last few things together, the \SpecialChar LaTeX
19582 output will be either:
19585 \begin_layout LyX-Code
19588 LatexName[LatexParam]{\SpecialChar ldots
19592 \begin_layout Standard
19596 \begin_layout LyX-Code
19599 begin{LatexName}[LatexParam] \SpecialChar ldots
19605 \begin_layout Standard
19606 depending upon the \SpecialChar LaTeX
19611 \begin_layout Description
19612 \begin_inset Flex Code
19615 \begin_layout Plain Layout
19622 \begin_inset Flex Code
19625 \begin_layout Plain Layout
19631 ] A string that is put at the beginning of the layout content.
19632 A line break in the output can be indicated by
19633 \begin_inset Flex Code
19636 \begin_layout Plain Layout
19645 \begin_layout Description
19646 \begin_inset Flex Code
19649 \begin_layout Plain Layout
19656 \begin_inset Flex Code
19659 \begin_layout Plain Layout
19666 \begin_inset Flex Code
19669 \begin_layout Plain Layout
19676 \begin_inset Flex Code
19679 \begin_layout Plain Layout
19686 \begin_inset Flex Code
19689 \begin_layout Plain Layout
19695 (indicating a dummy definition ending definitions of charstyles, etc).
19696 This entry is required in and is only meaningful for Flex insets.
19697 Among other things, it determines on which menu this inset will appear.
19699 \begin_inset Flex Code
19702 \begin_layout Plain Layout
19709 \begin_inset Flex Code
19712 \begin_layout Plain Layout
19718 will automatically set
19719 \begin_inset Flex Code
19722 \begin_layout Plain Layout
19729 \begin_inset Flex Code
19732 \begin_layout Plain Layout
19740 \begin_inset Flex Code
19743 \begin_layout Plain Layout
19749 can be set to true, or
19750 \begin_inset Flex Code
19753 \begin_layout Plain Layout
19760 \begin_inset Flex Code
19763 \begin_layout Plain Layout
19769 insets by setting it
19774 \begin_inset Flex Code
19777 \begin_layout Plain Layout
19786 \begin_layout Description
19787 \begin_inset Flex Code
19790 \begin_layout Plain Layout
19797 \begin_inset Flex Code
19800 \begin_layout Plain Layout
19809 \begin_inset space \thinspace{}
19813 \begin_inset Flex Code
19816 \begin_layout Plain Layout
19822 ] Whether multiple paragraphs are permitted in this inset.
19824 \begin_inset Flex Code
19827 \begin_layout Plain Layout
19833 to the same value and
19834 \begin_inset Flex Code
19837 \begin_layout Plain Layout
19843 to the opposite value.
19844 These can be reset to other values, if they are used
19849 \begin_inset Flex Code
19852 \begin_layout Plain Layout
19862 \begin_layout Description
19863 \begin_inset Flex Code
19866 \begin_layout Plain Layout
19873 \begin_inset Flex Code
19876 \begin_layout Plain Layout
19885 \begin_inset space \thinspace{}
19889 \begin_inset Flex Code
19892 \begin_layout Plain Layout
19898 ] Whether fragile commands in this inset should be
19899 \begin_inset Flex Code
19902 \begin_layout Plain Layout
19915 whether the command should itself be protected.) Default is false.
19916 \change_inserted -712698321 1523633958
19920 \begin_layout Description
19922 \change_inserted -712698321 1523634088
19923 \begin_inset Flex Code
19926 \begin_layout Plain Layout
19928 \change_inserted -712698321 1523633961
19935 \begin_inset Flex Code
19938 \begin_layout Plain Layout
19940 \change_inserted -712698321 1523633958
19949 \begin_inset space \thinspace{}
19953 \begin_inset Flex Code
19956 \begin_layout Plain Layout
19958 \change_inserted -712698321 1523633958
19964 ] This causes macros that contain this inset to be protected with
19965 \begin_inset Flex Code
19968 \begin_layout Plain Layout
19970 \change_inserted -712698321 1523634038
19985 ) if necessary and thus allows (some) verbatim stuff in macros.
19991 \begin_layout Description
19992 \begin_inset Flex Code
19995 \begin_layout Plain Layout
20002 \begin_inset Flex Code
20005 \begin_layout Plain Layout
20011 ] Deletes an existing
20012 \begin_inset Flex Code
20015 \begin_layout Plain Layout
20024 \begin_layout Description
20025 \begin_inset Flex Code
20028 \begin_layout Plain Layout
20035 \begin_inset Flex Code
20038 \begin_layout Plain Layout
20045 \begin_inset Flex Code
20048 \begin_layout Plain Layout
20054 that has replaced this
20055 \begin_inset Flex Code
20058 \begin_layout Plain Layout
20065 This is used to rename an
20066 \begin_inset Flex Code
20069 \begin_layout Plain Layout
20075 , while keeping backward compatibility.
20078 \begin_layout Description
20079 \begin_inset Flex Code
20082 \begin_layout Plain Layout
20089 \begin_inset Flex Code
20092 \begin_layout Plain Layout
20101 \begin_inset space \thinspace{}
20105 \begin_inset Flex Code
20108 \begin_layout Plain Layout
20114 ] As with paragraph styles, see
20115 \begin_inset CommandInset ref
20117 reference "subsec:Paragraph-Styles"
20125 \begin_layout Description
20126 \begin_inset Flex Code
20129 \begin_layout Plain Layout
20136 \begin_inset Flex Code
20139 \begin_layout Plain Layout
20148 \begin_inset space \thinspace{}
20152 \begin_inset Flex Code
20155 \begin_layout Plain Layout
20161 ] As with paragraph styles, see
20162 \begin_inset CommandInset ref
20164 reference "subsec:Paragraph-Styles"
20172 \begin_layout Description
20173 \begin_inset Flex Code
20176 \begin_layout Plain Layout
20182 As with paragraph styles, see
20183 \begin_inset CommandInset ref
20185 reference "subsec:Paragraph-Styles"
20192 \begin_layout Description
20193 \begin_inset Flex Code
20196 \begin_layout Plain Layout
20203 \begin_inset Flex Code
20206 \begin_layout Plain Layout
20212 ] The prefix to use when creating labels referring to insets of this type.
20213 This allows the use of formatted references.
20216 \begin_layout Description
20217 \begin_inset Flex Code
20220 \begin_layout Plain Layout
20227 \begin_inset Flex Code
20230 \begin_layout Plain Layout
20236 ] As with paragraph styles, see
20237 \begin_inset CommandInset ref
20239 reference "subsec:Paragraph-Styles"
20246 \begin_layout Description
20247 \begin_inset Flex Code
20250 \begin_layout Plain Layout
20257 \begin_inset Flex Code
20260 \begin_layout Plain Layout
20269 \begin_inset space \thinspace{}
20273 \begin_inset Flex Code
20276 \begin_layout Plain Layout
20282 ] Resets the \SpecialChar LaTeX
20283 arguments of this layout (as defined via the
20284 \begin_inset Flex Code
20287 \begin_layout Plain Layout
20294 This is useful if you have copied a style via
20295 \begin_inset Flex Code
20298 \begin_layout Plain Layout
20304 , but you do not want to inherit its (required and optional) arguments.
20307 \begin_layout Description
20308 \begin_inset Flex Code
20311 \begin_layout Plain Layout
20318 \begin_inset Flex Code
20321 \begin_layout Plain Layout
20328 \begin_inset space \thinspace{}
20332 \begin_inset Flex Code
20335 \begin_layout Plain Layout
20343 ] Whether this inset should use the font of its surrounding environment
20345 Default is false: use the font of the surrounding environment.
20348 \begin_layout Description
20349 \begin_inset Flex Code
20352 \begin_layout Plain Layout
20359 \begin_inset Flex Code
20362 \begin_layout Plain Layout
20368 ] A string that is put at the end of the layout content.
20369 A line break in the output can be indicated by
20370 \begin_inset Flex Code
20373 \begin_layout Plain Layout
20382 \begin_layout Description
20383 \begin_inset Flex Code
20386 \begin_layout Plain Layout
20393 \begin_inset Flex Code
20396 \begin_layout Plain Layout
20403 \begin_inset space \thinspace{}
20407 \begin_inset Flex Code
20410 \begin_layout Plain Layout
20418 ] Allow spell-checking the contents of this inset.
20422 \begin_layout Subsection
20424 \begin_inset CommandInset label
20426 name "subsec:Counters"
20433 \begin_layout Standard
20434 It is necessary to define the counters (
20435 \begin_inset Flex Noun
20438 \begin_layout Plain Layout
20445 \begin_inset Flex Noun
20448 \begin_layout Plain Layout
20454 , \SpecialChar ldots
20455 ) in the text class itself.
20456 The standard counters are defined in the file
20457 \begin_inset Flex Code
20460 \begin_layout Plain Layout
20466 , so you may have to do no more than add
20469 \begin_layout LyX-Code
20470 Input stdcounters.inc
20473 \begin_layout Standard
20474 to your layout file to get them to work.
20475 But if you want to define custom counters, then you can do so.
20476 The counter declaration must begin with:
20479 \begin_layout LyX-Code
20480 Counter CounterName
20483 \begin_layout Standard
20485 \begin_inset Flex Code
20488 \begin_layout Plain Layout
20494 ' is replaced by the name of the counter.
20495 And it must end with
20496 \begin_inset Quotes eld
20500 \begin_inset Flex Code
20503 \begin_layout Plain Layout
20510 \begin_inset Quotes erd
20514 The following parameters can also be used:
20517 \begin_layout Description
20518 \begin_inset Flex Code
20521 \begin_layout Plain Layout
20528 \begin_inset Flex Code
20531 \begin_layout Plain Layout
20537 ] Sets the initial value for the counter, to which it will be reset whenever
20539 Normally, one will want the default, 1.
20542 \begin_layout Description
20543 \begin_inset Flex Code
20546 \begin_layout Plain Layout
20553 \begin_inset Flex Code
20556 \begin_layout Plain Layout
20563 \begin_inset Quotes erd
20567 \begin_inset Quotes erd
20570 ] When defined, this string defines how the counter is displayed.
20571 Setting this value sets
20572 \begin_inset Flex Code
20575 \begin_layout Plain Layout
20576 LabelStringAppendix
20582 The following special constructs can be used in the string:
20586 \begin_layout Itemize
20587 \begin_inset Flex Code
20590 \begin_layout Plain Layout
20598 will be replaced by the expansion of the
20599 \begin_inset Flex Code
20602 \begin_layout Plain Layout
20609 \begin_inset Flex Code
20612 \begin_layout Plain Layout
20613 LabelStringAppendix
20619 \begin_inset Flex Code
20622 \begin_layout Plain Layout
20632 \begin_layout Itemize
20633 counter values can be expressed using \SpecialChar LaTeX
20635 \begin_inset Newline newline
20639 \begin_inset Flex Code
20642 \begin_layout Plain Layout
20659 \begin_inset Flex Code
20662 \begin_layout Plain Layout
20674 \begin_layout Plain Layout
20684 Actually, the situation is a bit more complicated: any
20703 other than those described below will produce arabic numerals.
20704 It would not be surprising to see this change in the future.
20710 \begin_inset Flex Code
20713 \begin_layout Plain Layout
20719 : 1, 2, 3,\SpecialChar ldots
20721 \begin_inset Flex Code
20724 \begin_layout Plain Layout
20730 for lower-case letters: a, b, c, \SpecialChar ldots
20732 \begin_inset Flex Code
20735 \begin_layout Plain Layout
20741 for upper-case letters: A, B, C, \SpecialChar ldots
20743 \begin_inset Flex Code
20746 \begin_layout Plain Layout
20752 for lower-case roman numerals: i, ii, iii, \SpecialChar ldots
20754 \begin_inset Flex Code
20757 \begin_layout Plain Layout
20763 for upper-case roman numerals: I, II, III\SpecialChar ldots
20765 \begin_inset Flex Code
20768 \begin_layout Plain Layout
20774 for hebrew numerals.
20778 \begin_layout Standard
20779 If LabelString is not defined, a default value is constructed as follows:
20780 if the counter has a master counter
20781 \begin_inset Flex Code
20784 \begin_layout Plain Layout
20791 \begin_inset Flex Code
20794 \begin_layout Plain Layout
20801 \begin_inset Newline newline
20805 \begin_inset Flex Code
20808 \begin_layout Plain Layout
20818 is used; otherwise the string
20819 \begin_inset Flex Code
20822 \begin_layout Plain Layout
20833 \begin_layout Description
20834 \begin_inset Flex Code
20837 \begin_layout Plain Layout
20838 LabelStringAppendix
20844 \begin_inset Flex Code
20847 \begin_layout Plain Layout
20854 \begin_inset Quotes erd
20858 \begin_inset Quotes erd
20862 \begin_inset Flex Code
20865 \begin_layout Plain Layout
20871 , but for use in the Appendix.
20874 \begin_layout Description
20875 \begin_inset Flex Code
20878 \begin_layout Plain Layout
20885 \begin_inset Flex Code
20888 \begin_layout Plain Layout
20895 \begin_inset Quotes erd
20899 \begin_inset Quotes erd
20902 ] A format for use with formatted references to this counter.
20903 For example, one might want to have references to section numbers appear
20905 \begin_inset Quotes eld
20909 \begin_inset Quotes erd
20913 The string should contain
20914 \begin_inset Quotes eld
20918 \begin_inset Quotes erd
20922 This will be replaced by the counter number itself.
20923 So, for sections, it would be: Section ##.
20926 \begin_layout Description
20927 \begin_inset Flex Code
20930 \begin_layout Plain Layout
20937 \begin_inset Flex Code
20940 \begin_layout Plain Layout
20947 \begin_inset Quotes erd
20951 \begin_inset Quotes erd
20954 ] If this is set to the name of another counter, the present counter will
20955 be reset every time the other one is increased.
20957 \begin_inset Flex Code
20960 \begin_layout Plain Layout
20967 \begin_inset Flex Code
20970 \begin_layout Plain Layout
20979 \begin_layout Subsection
20981 \begin_inset CommandInset label
20983 name "subsec:Font-description"
20990 \begin_layout Standard
20991 A font description looks like this:
20994 \begin_layout LyX-Code
21011 \begin_layout LyX-Code
21015 \begin_layout LyX-Code
21019 \begin_layout Standard
21020 The following commands are available:
21023 \begin_layout Description
21024 \begin_inset Flex Code
21027 \begin_layout Plain Layout
21034 \begin_inset Flex Code
21037 \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
21166 \begin_inset Flex Code
21169 \begin_layout Plain Layout
21176 \begin_inset Flex Code
21179 \begin_layout Plain Layout
21186 \begin_inset Flex Code
21189 \begin_layout Plain Layout
21196 \begin_inset Flex Code
21199 \begin_layout Plain Layout
21206 \begin_inset Flex Code
21209 \begin_layout Plain Layout
21216 \begin_inset Flex Code
21219 \begin_layout Plain Layout
21226 \begin_inset Flex Code
21229 \begin_layout Plain Layout
21238 \begin_layout Description
21239 \begin_inset Flex Code
21242 \begin_layout Plain Layout
21249 \begin_inset Flex Code
21252 \begin_layout Plain Layout
21261 \begin_inset Flex Code
21264 \begin_layout Plain Layout
21271 \begin_inset Flex Code
21274 \begin_layout Plain Layout
21283 \begin_layout Description
21284 \begin_inset Flex Code
21287 \begin_layout Plain Layout
21294 \begin_inset Flex Code
21297 \begin_layout Plain Layout
21303 ] Valid arguments are:
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 \begin_inset Flex Code
21357 \begin_layout Plain Layout
21364 \begin_inset Flex Code
21367 \begin_layout Plain Layout
21374 \begin_inset Flex Code
21377 \begin_layout Plain Layout
21384 \begin_inset Flex Code
21387 \begin_layout Plain Layout
21394 \begin_inset Flex Code
21397 \begin_layout Plain Layout
21404 \begin_inset Flex Code
21407 \begin_layout Plain Layout
21414 \begin_inset Flex Code
21417 \begin_layout Plain Layout
21424 Each of these turns on or off the corresponding attribute.
21426 \begin_inset Flex Code
21429 \begin_layout Plain Layout
21435 turns on emphasis, and
21436 \begin_inset Flex Code
21439 \begin_layout Plain Layout
21447 \begin_inset Newline newline
21450 If the latter seems puzzling, remember that the font settings for the present
21451 context are generally inherited from the surrounding context.
21453 \begin_inset Flex Code
21456 \begin_layout Plain Layout
21462 would turn off the emphasis that was anyway in effect, say, in a theorem
21466 \begin_layout Description
21467 \begin_inset Flex Code
21470 \begin_layout Plain Layout
21477 \begin_inset Flex Code
21480 \begin_layout Plain Layout
21489 \begin_inset Flex Code
21492 \begin_layout Plain Layout
21501 \begin_layout Description
21502 \begin_inset Flex Code
21505 \begin_layout Plain Layout
21512 \begin_inset Flex Code
21515 \begin_layout Plain Layout
21524 \begin_inset Flex Code
21527 \begin_layout Plain Layout
21534 \begin_inset Flex Code
21537 \begin_layout Plain Layout
21544 \begin_inset Flex Code
21547 \begin_layout Plain Layout
21556 \begin_layout Description
21557 \begin_inset Flex Code
21560 \begin_layout Plain Layout
21567 \begin_inset Flex Code
21570 \begin_layout Plain Layout
21577 \begin_inset Flex Code
21580 \begin_layout Plain Layout
21587 \begin_inset Flex Code
21590 \begin_layout Plain Layout
21599 \begin_inset Flex Code
21602 \begin_layout Plain Layout
21609 \begin_inset Flex Code
21612 \begin_layout Plain Layout
21619 \begin_inset Flex Code
21622 \begin_layout Plain Layout
21629 \begin_inset Flex Code
21632 \begin_layout Plain Layout
21639 \begin_inset Flex Code
21642 \begin_layout Plain Layout
21651 \begin_layout Subsection
21652 \begin_inset CommandInset label
21654 name "subsec:Citation-engine-description"
21658 Cite engine description
21661 \begin_layout Standard
21663 \begin_inset Flex Code
21666 \begin_layout Plain Layout
21672 blocks, as used mainly in cite engine files (see
21673 \begin_inset CommandInset ref
21675 reference "subsec:Cite-Engine-Files"
21682 ), define the citation commands provided by a specific
21683 \begin_inset Quotes eld
21687 \begin_inset Quotes erd
21691 A cite engine, in \SpecialChar LyX
21692 terms, is way specific way to format citations, using
21693 numbers, author names and/or years.
21694 Currently, \SpecialChar LyX
21695 supports three such engine types, namely:
21698 \begin_layout Enumerate
21699 \begin_inset Flex Code
21702 \begin_layout Plain Layout
21708 : the default Bib\SpecialChar TeX
21709 way to format citations, a simple numeric style (e.
21710 \begin_inset space \thinspace{}
21714 \begin_inset Quotes eld
21718 \begin_inset Quotes erd
21724 \begin_layout Enumerate
21725 \begin_inset Flex Code
21728 \begin_layout Plain Layout
21734 : Harvard-styled citations using author names and publication year (e.
21735 \begin_inset space \thinspace{}
21739 \begin_inset Quotes eld
21742 Smith and Miller (2017b)
21743 \begin_inset Quotes erd
21749 \begin_layout Enumerate
21750 \begin_inset Flex Code
21753 \begin_layout Plain Layout
21759 : extended numerical citations that also allow for author or title next
21761 \begin_inset space \thinspace{}
21765 \begin_inset Quotes eld
21768 Smith and Miller [1]
21769 \begin_inset Quotes erd
21775 \begin_layout Standard
21776 \begin_inset Flex Code
21779 \begin_layout Plain Layout
21785 blocks look like this:
21788 \begin_layout LyX-Code
21792 \begin_layout LyX-Code
21796 \begin_layout LyX-Code
21800 \begin_layout LyX-Code
21801 citeyearpar[][]=parencite*
21804 \begin_layout LyX-Code
21808 \begin_layout LyX-Code
21812 \begin_layout Standard
21814 \begin_inset Flex Code
21817 \begin_layout Plain Layout
21823 denotes the engine.
21824 The individual lines respectively define a cite command or cite command
21825 paradigm supported by this engine.
21826 The line can be as simple as a cite command that is used both to name the
21827 respective \SpecialChar LyX
21828 command and the \SpecialChar LaTeX
21829 output or more complex in order to differentiate
21831 The full syntax is:
21834 \begin_layout LyX-Code
21835 LyXName|alias$*<!_stardesc!_stardesctooltip>[][]=latexcmd
21838 \begin_layout Itemize
21839 \begin_inset Flex Code
21842 \begin_layout Plain Layout
21848 : The name as used in the
21849 \begin_inset Flex Code
21852 \begin_layout Plain Layout
21862 \begin_layout Standard
21863 For portability reasons, we try to use the same name for same-formatted
21864 commands in different cite packages (thus many names stem from natbib,
21865 and thus we need to differentiate a
21866 \begin_inset Flex Code
21869 \begin_layout Plain Layout
21875 sometimes, if the \SpecialChar LaTeX
21876 command names differ).
21880 \begin_layout Itemize
21881 \begin_inset Flex Code
21884 \begin_layout Plain Layout
21890 : a (comma-separated) list of commands that fall back to the given
21891 \begin_inset Flex Code
21894 \begin_layout Plain Layout
21900 in the current engine.
21901 This eases the switch of citation packages and engines.
21903 \begin_inset Flex Code
21906 \begin_layout Plain Layout
21913 \begin_inset Flex Code
21916 \begin_layout Plain Layout
21922 in layout definitions.
21925 \begin_layout Itemize
21926 \begin_inset Flex Code
21929 \begin_layout Plain Layout
21935 : The actual \SpecialChar LaTeX
21936 command that is output.
21940 \begin_layout Standard
21941 \begin_inset Flex Code
21944 \begin_layout Plain Layout
21951 \begin_inset Flex Code
21954 \begin_layout Plain Layout
21962 \begin_inset Flex Code
21965 \begin_layout Plain Layout
21972 \begin_inset Flex Code
21975 \begin_layout Plain Layout
21981 will be output to \SpecialChar LaTeX
21985 \begin_layout Standard
21989 \begin_layout Itemize
21990 Capitalization indicates that the command also has a capitalized form (
21991 \begin_inset Flex Code
21994 \begin_layout Plain Layout
22004 \begin_inset Flex Code
22007 \begin_layout Plain Layout
22016 These usually enforce up-casing of name prefixes (
22021 \begin_inset Formula $\Rightarrow$
22031 \begin_layout Itemize
22033 \begin_inset Flex Code
22036 \begin_layout Plain Layout
22042 indicate the number of optional arguments (there can be 0–2).
22045 \begin_layout Itemize
22047 \begin_inset Flex Code
22050 \begin_layout Plain Layout
22056 indicates there is a starred version of the command (
22057 \begin_inset Flex Code
22060 \begin_layout Plain Layout
22070 \begin_inset Flex Code
22073 \begin_layout Plain Layout
22086 \begin_layout Standard
22087 By default, the starred version means: Output all authors even if it should
22089 \begin_inset Quotes eld
22093 \begin_inset Quotes erd
22097 \begin_inset Flex Code
22100 \begin_layout Plain Layout
22109 \begin_layout Standard
22110 If the star has a different meaning for a given command, it can be specified
22112 \begin_inset Flex Code
22115 \begin_layout Plain Layout
22116 <!_stardesc!_stardesctooltip>
22122 Maximal two translatable macro keywords, marked by the prefix
22123 \begin_inset Flex Code
22126 \begin_layout Plain Layout
22133 The first points to the string that replaces the
22134 \begin_inset Quotes eld
22138 \begin_inset Quotes erd
22141 checkbox label in the citation dialog, the second one to an optional tool
22142 tip for this checkbox.
22146 \begin_layout Standard
22147 Note that these two macros have to be defined in a
22148 \begin_inset Flex Code
22151 \begin_layout Plain Layout
22157 (see next section), dropping the
22158 \begin_inset Flex Code
22161 \begin_layout Plain Layout
22167 from the prefix, like this:
22170 \begin_layout LyX-Code
22171 _stardesc Sta&rred command label
22174 \begin_layout LyX-Code
22175 _stardesctooltip Tooltip for the starred command checkbox.
22179 \begin_layout Itemize
22181 \begin_inset Flex Code
22184 \begin_layout Plain Layout
22190 indicates that this command features
22191 \begin_inset Quotes eld
22194 qualified citation lists
22195 \begin_inset Quotes erd
22203 -specific feature for multi-reference citations where an individual pre-
22204 and postnote can be given to each reference in the list.
22205 Please refer to the
22209 manual for details.
22210 \change_inserted -712698321 1526898670
22214 \begin_layout Standard
22216 \change_inserted -712698321 1526899524
22217 If you want to add a cite command to a cite engine (e.
22218 \begin_inset space \thinspace{}
22221 g., add a specific command provided by a class), you can use
22222 \begin_inset Flex Code
22225 \begin_layout Plain Layout
22227 \change_inserted -712698321 1526898768
22228 AddToCiteEngine <engine type> \SpecialChar ldots
22237 Note that only cite commands that do not exist yet are added.
22242 \begin_layout Subsection
22243 \begin_inset CommandInset label
22245 name "subsec:Citation-format-description"
22249 Cite format description
22252 \begin_layout Standard
22254 \begin_inset Flex Code
22257 \begin_layout Plain Layout
22263 blocks are used to describe how bibliographic information should be displayed,
22264 both within \SpecialChar LyX
22265 itself (in the citation dialog and in tooltips, for example)
22266 and in XHTML output.
22267 Such a block might look like this:
22270 \begin_layout LyX-Code
22274 \begin_layout LyX-Code
22278 \begin_layout LyX-Code
22282 \begin_layout LyX-Code
22286 \begin_layout Standard
22290 \begin_layout LyX-Code
22294 \begin_layout LyX-Code
22298 \begin_layout LyX-Code
22302 \begin_layout LyX-Code
22306 \begin_layout Standard
22307 In the first case, the individual lines define how the bibliographic information
22308 associated with an article or book, respectively, is to be displayed, and
22309 such a definition can be given for any
22310 \begin_inset Quotes els
22314 \begin_inset Quotes ers
22317 that might be present in a Bib\SpecialChar TeX
22320 defines a default format in the source code that will be used if no specific
22321 definition has been given.
22323 predefines several formats in the file
22324 \begin_inset Flex Code
22327 \begin_layout Plain Layout
22333 , which is included in most of \SpecialChar LyX
22334 's document classes.
22337 \begin_layout Standard
22338 In the second case, the lines define how a specific citation command (in
22340 \begin_inset Flex Code
22343 \begin_layout Plain Layout
22352 \begin_inset Flex Code
22355 \begin_layout Plain Layout
22363 ) is to be displayed on the citation inset label, in the citation dialog,
22364 menu or XHTML output.
22366 defines such formats for the citation style variants it supports via
22368 Document\SpecialChar menuseparator
22369 Setting\SpecialChar menuseparator
22370 Bibliography\SpecialChar ldots
22374 \begin_inset Flex Code
22377 \begin_layout Plain Layout
22383 files that are shipped with \SpecialChar LyX
22385 \begin_inset CommandInset ref
22387 reference "subsec:Cite-Engine-Files"
22397 \begin_layout Standard
22398 The definitions use a simple language that allows Bib\SpecialChar TeX
22399 keys to be replaced
22401 Keys should be enclosed in
22402 \begin_inset Flex Code
22405 \begin_layout Plain Layout
22412 \begin_inset Flex Code
22415 \begin_layout Plain Layout
22422 So a simple definition might look like this:
22425 \begin_layout LyX-Code
22427 \begin_inset Quotes eld
22431 \begin_inset Quotes erd
22437 \begin_layout Standard
22438 This would print the author, followed by a comma, followed by the title,
22439 in quotes, followed by a period.
22442 \begin_layout Standard
22443 Of course, sometimes you may want to print a key only if it exists.
22444 This can be done by using a conditional construction, such as:
22445 \begin_inset Flex Code
22448 \begin_layout Plain Layout
22450 \begin_inset space ~
22460 \begin_inset Flex Code
22463 \begin_layout Plain Layout
22469 key exists, then print
22470 \begin_inset Quotes eld
22474 \begin_inset space ~
22478 \begin_inset Quotes erd
22481 followed by the volume key.
22482 It is also possible to have an else clause in the conditional, such as:
22483 \begin_inset Newline newline
22487 \begin_inset Flex Code
22490 \begin_layout Plain Layout
22491 {%author%[[%author%]][[%editor%, ed.]]}
22497 \begin_inset Newline newline
22501 \begin_inset Flex Code
22504 \begin_layout Plain Layout
22510 key is printed if it exists; otherwise, the editor key is printed, followed
22512 \begin_inset Quotes eld
22516 \begin_inset space ~
22520 \begin_inset Quotes erd
22523 Note that the key is again enclosed in
22524 \begin_inset Flex Code
22527 \begin_layout Plain Layout
22533 signs; the entire conditional is enclosed in braces; and the if and else
22534 clauses are enclosed in double brackets,
22535 \begin_inset Quotes eld
22539 \begin_inset Flex Code
22542 \begin_layout Plain Layout
22549 \begin_inset Quotes eld
22553 \begin_inset Quotes eld
22557 \begin_inset Flex Code
22560 \begin_layout Plain Layout
22567 \begin_inset Quotes erd
22571 There must be no space between any of these.
22574 \begin_layout Standard
22575 Next to the entry keys, there are some special keys that can be used for
22576 these conditionals:
22579 \begin_layout Itemize
22580 \begin_inset Flex Code
22583 \begin_layout Plain Layout
22584 {%dialog%[[true]][[false]]}
22590 \begin_inset Quotes eld
22594 \begin_inset Quotes erd
22597 part for dialogs and menus, the
22598 \begin_inset Quotes eld
22602 \begin_inset Quotes erd
22605 part for other contexts (workarea, export)
22608 \begin_layout Itemize
22609 \begin_inset Flex Code
22612 \begin_layout Plain Layout
22613 {%export%[[true]][[false]]}
22619 \begin_inset Quotes eld
22623 \begin_inset Quotes erd
22626 part for export and menus, the
22627 \begin_inset Quotes eld
22631 \begin_inset Quotes erd
22634 part for other contexts (workarea, dialog)
22637 \begin_layout Itemize
22638 \begin_inset Flex Code
22641 \begin_layout Plain Layout
22648 \begin_inset Quotes eld
22652 \begin_inset Quotes erd
22655 part if another item follows (e.
22656 \begin_inset space \thinspace{}
22659 g., in a citation with multiple keys)
22662 \begin_layout Itemize
22663 \begin_inset Flex Code
22666 \begin_layout Plain Layout
22667 {%second%[[true]][[false]]}
22673 \begin_inset Quotes eld
22677 \begin_inset Quotes erd
22680 if this is the second of multiple items, else the
22681 \begin_inset Quotes eld
22685 \begin_inset Quotes erd
22691 \begin_layout Itemize
22692 \begin_inset Flex Code
22695 \begin_layout Plain Layout
22696 {%ifstar%[[true]][[false]]}
22702 \begin_inset Quotes eld
22706 \begin_inset Quotes erd
22709 part for starred citation commands (such as
22710 \begin_inset Flex Code
22713 \begin_layout Plain Layout
22721 ), the false part for unstarred
22724 \begin_layout Itemize
22725 \begin_inset Flex Code
22728 \begin_layout Plain Layout
22729 {%ifentrytype:<type>%[[true]][[false]]}
22735 \begin_inset Quotes eld
22739 \begin_inset Quotes erd
22742 if the current entry type matches
22743 \begin_inset Flex Code
22746 \begin_layout Plain Layout
22752 , else the false part (e.g., in a citation definition:
22753 \begin_inset Flex Code
22756 \begin_layout Plain Layout
22757 {%ifentrytype:book%[[this is a book]][[this is no book]]}
22765 \begin_layout Itemize
22766 \begin_inset Flex Code
22769 \begin_layout Plain Layout
22770 {%ifmultiple:<authortype>%[[true]][[false]]}
22776 \begin_inset Quotes eld
22780 \begin_inset Quotes erd
22783 if the current author type (author, editor etc.) has multiple authors, else
22784 the false part (e.g., in a bibliography definition:
22785 \begin_inset Flex Code
22788 \begin_layout Plain Layout
22789 {%ifmultiple:editor%[[eds.]][[ed.]]}
22797 \begin_layout Itemize
22798 \begin_inset Flex Code
22801 \begin_layout Plain Layout
22802 {%ifqualified%[[true]][[false]]}
22808 \begin_inset Quotes eld
22812 \begin_inset Quotes erd
22815 part if the current citation is a qualified citation list (a specific
22819 format for multi-reference citations), the false part if this is not the
22823 \begin_layout Standard
22825 \begin_inset Flex Code
22828 \begin_layout Plain Layout
22834 prints the author key as it is recorded in the bibliography file.
22835 This might not be what you want, since it will result in a string such
22837 \begin_inset Quotes eld
22840 Miller, Peter and Smith, Mary and White, Jane
22841 \begin_inset Quotes erd
22845 \begin_inset Quotes eld
22849 \begin_inset Quotes erd
22852 is used by Bib\SpecialChar TeX
22853 to delimit authors).
22855 therefore provides some methods to get properly formatted name lists (which
22856 will also get translated).
22857 The following keys are provided:
22860 \begin_layout Enumerate
22861 For name lists with pre- and surname, suitable for the main authors/editors
22862 of a bibliography item.
22864 \begin_inset Flex Code
22867 \begin_layout Plain Layout
22873 part denotes the kind of list that is requested (e.g.
22875 \begin_inset Flex Code
22878 \begin_layout Plain Layout
22888 \begin_layout Itemize
22889 \begin_inset Flex Code
22892 \begin_layout Plain Layout
22893 %abbrvnames:<nametype>%
22898 : Provides a name list which is abbreviated (with
22899 \begin_inset Quotes eld
22903 \begin_inset Quotes erd
22907 \begin_inset Flex Code
22910 \begin_layout Plain Layout
22919 \begin_layout Itemize
22920 \begin_inset Flex Code
22923 \begin_layout Plain Layout
22924 %fullnames:<nametype>%
22929 : Provides a full name list (never abbreviated with
22930 \begin_inset Quotes eld
22934 \begin_inset Quotes erd
22940 \begin_layout Itemize
22941 \begin_inset Flex Code
22944 \begin_layout Plain Layout
22945 %forceabbrvnames:<nametype>%
22950 : Provides a name list which is always abbreviated (with
22951 \begin_inset Quotes eld
22955 \begin_inset Quotes erd
22959 \begin_inset Flex Code
22962 \begin_layout Plain Layout
22972 \begin_layout Enumerate
22973 Alternative name lists with pre- and surname, if the order of pre- and surname
22974 inside the bibliography item differs (as in:
22975 \begin_inset Quotes eld
22978 Miller, John: Some text, in: Mary Smith, ed.: A volume
22979 \begin_inset Quotes erd
22986 \begin_layout Itemize
22987 \begin_inset Flex Code
22990 \begin_layout Plain Layout
22991 %abbrvbynames:<nametype>%
22996 : Provides a name list which is abbreviated (with
22997 \begin_inset Quotes eld
23001 \begin_inset Quotes erd
23005 \begin_inset Flex Code
23008 \begin_layout Plain Layout
23017 \begin_layout Itemize
23018 \begin_inset Flex Code
23021 \begin_layout Plain Layout
23022 %fullbynames:<nametype>%
23027 : Provides a full name list (never abbreviated with
23028 \begin_inset Quotes eld
23032 \begin_inset Quotes erd
23038 \begin_layout Itemize
23039 \begin_inset Flex Code
23042 \begin_layout Plain Layout
23043 %forceabbrvbynames:<nametype>%
23048 : Provides a name list which is always abbreviated (with
23049 \begin_inset Quotes eld
23053 \begin_inset Quotes erd
23057 \begin_inset Flex Code
23060 \begin_layout Plain Layout
23070 \begin_layout Enumerate
23071 And finally name lists which consist of family names only, as used in author-yea
23073 These do not take a
23074 \begin_inset Flex Code
23077 \begin_layout Plain Layout
23083 part, but always return either an author list or, if this does not exist,
23084 an editor list (as common in author-year labels):
23088 \begin_layout Itemize
23089 \begin_inset Flex Code
23092 \begin_layout Plain Layout
23098 : Provides a name list which is abbreviated (with
23099 \begin_inset Quotes eld
23103 \begin_inset Quotes erd
23107 \begin_inset Flex Code
23110 \begin_layout Plain Layout
23119 \begin_layout Itemize
23120 \begin_inset Flex Code
23123 \begin_layout Plain Layout
23129 : Provides a full name list (never abbreviated with
23130 \begin_inset Quotes eld
23134 \begin_inset Quotes erd
23140 \begin_layout Itemize
23141 \begin_inset Flex Code
23144 \begin_layout Plain Layout
23145 %forceabbrvciteauthor%
23150 : Provides a name list which is always abbreviated (with
23151 \begin_inset Quotes eld
23155 \begin_inset Quotes erd
23159 \begin_inset Flex Code
23162 \begin_layout Plain Layout
23172 \begin_layout Standard
23173 The order of pre- and surname in the former two lists can be adjusted by
23177 \begin_layout Itemize
23178 \begin_inset Flex Code
23181 \begin_layout Plain Layout
23182 !firstnameform %surname%, %prename%
23187 (first author in lists of type 1)
23190 \begin_layout Itemize
23191 \begin_inset Flex Code
23194 \begin_layout Plain Layout
23195 !othernameform %surname%, %prename%
23200 (other authors in lists of type 1)
23203 \begin_layout Itemize
23204 \begin_inset Flex Code
23207 \begin_layout Plain Layout
23208 !firstbynameform %prename% %surname%
23213 (first author in lists of type 2)
23216 \begin_layout Itemize
23217 \begin_inset Flex Code
23220 \begin_layout Plain Layout
23221 !otherbynameform %prename% %surname%
23226 (other authors in lists of type 2)
23229 \begin_layout Standard
23230 This allows you to configure namings like
23231 \begin_inset Quotes eld
23234 Miller, Peter and Mary Smith: \SpecialChar ldots
23235 , in: John Doe and Pat Green, eds.:\SpecialChar ldots
23237 \begin_inset Quotes erd
23243 \begin_layout Standard
23244 There is one other piece of syntax available in definitions, which looks
23246 \begin_inset Flex Code
23249 \begin_layout Plain Layout
23256 This defines a piece of formatting information that is to be used when
23258 \begin_inset Quotes eld
23262 \begin_inset Quotes erd
23266 Obviously, we do not want to output HTML tags when writing plain text,
23267 so they should be wrapped in
23268 \begin_inset Quotes eld
23272 \begin_inset Quotes erd
23276 \begin_inset Quotes eld
23280 \begin_inset Quotes erd
23286 \begin_layout Standard
23287 Two special sorts of definitions are also possible in a
23288 \begin_inset Flex Code
23291 \begin_layout Plain Layout
23298 An example of the first would be:
23301 \begin_layout LyX-Code
23303 \begin_inset Quotes eld
23307 \begin_inset Quotes erd
23313 \begin_layout Standard
23314 This is an abbreviation, or macro, and it can be used by treating it as
23316 \begin_inset Flex Code
23319 \begin_layout Plain Layout
23328 \begin_inset Flex Code
23331 \begin_layout Plain Layout
23337 exactly as it would treat its definition.
23338 So, let us issue the obvious
23346 \begin_layout LyX-Code
23350 \begin_layout Standard
23351 or anything like it.
23353 shouldn't go into an infinite loop, but it may go into a long one before
23357 \begin_layout Standard
23358 The second sort of special definition might look like this:
23361 \begin_layout LyX-Code
23365 \begin_layout Standard
23366 This defines a translatable piece of text, which allows relevant parts of
23367 the bibliography or citation to be translated.
23368 It can be included in a definition by treating it as a key:
23369 \begin_inset Flex Code
23372 \begin_layout Plain Layout
23379 Note that there are two different translation paths: All definitions starting
23381 \begin_inset Flex Code
23384 \begin_layout Plain Layout
23390 , such as in the example above, will be translated to the currently active
23391 buffer language (so the translation will match the generated document).
23392 All definitions starting with underscore only will be translated to the
23394 This is the proper translation for strings that only occur in the dialogs
23395 or on buttons, such as this one:
23398 \begin_layout LyX-Code
23399 _addtobib Add to bibliography only.
23402 \begin_layout Standard
23403 Several of these translatable strings are predefined in
23404 \begin_inset Flex Code
23407 \begin_layout Plain Layout
23414 \begin_inset Flex Code
23417 \begin_layout Plain Layout
23424 Note that these are not macros, in the sense just defined.
23425 They will not be expanded.
23428 \begin_layout Standard
23429 So here then is an example that uses several of these features:
23430 \begin_inset VSpace defskip
23436 \begin_layout Standard
23440 !authoredit {%author%[[%author%, ]][[{%editor%[[%editor%, %B_edtext%, ]]}]]}
23443 \begin_layout Standard
23444 \begin_inset VSpace defskip
23447 This defines a macro that prints the author, followed by a comma, if the
23449 \begin_inset Flex Code
23452 \begin_layout Plain Layout
23458 key is defined, or else prints the name of the editor, followed by the
23460 \begin_inset Flex Code
23463 \begin_layout Plain Layout
23469 or its translation (it is by default
23470 \begin_inset Quotes eld
23474 \begin_inset Quotes erd
23478 \begin_inset Flex Code
23481 \begin_layout Plain Layout
23488 Note that this is in fact defined in
23489 \begin_inset Flex Code
23492 \begin_layout Plain Layout
23498 , so you can use it in your own definitions, or re-definitions, if you load
23502 \begin_layout Section
23503 \begin_inset CommandInset label
23505 name "sec:Tags-for-XHTML"
23509 Tags for XHTML output
23512 \begin_layout Standard
23513 As with \SpecialChar LaTeX
23514 or DocBook, the format of \SpecialChar LyX
23515 's XHTML output is also controlled by
23516 layout information.
23517 In general, \SpecialChar LyX
23518 provides sensible defaults and, as mentioned earlier, it will
23519 even construct default CSS style rules from the other layout tags.
23520 For example, \SpecialChar LyX
23521 will attempt to use the information provided in the
23522 \begin_inset Flex Code
23525 \begin_layout Plain Layout
23531 declaration for the Chapter style to write CSS that will appropriately
23532 format chapter headings.
23535 \begin_layout Standard
23536 In many cases, then, you may not have to do anything at all to get acceptable
23537 XHTML output for your own environments, custom insets, and so forth.
23538 But in some cases you will, and so \SpecialChar LyX
23539 provides a number of layout tags that
23540 can be used to customize the XHTML and CSS that are generated.
23543 \begin_layout Standard
23544 Note that there are two tags,
23545 \begin_inset Flex Code
23548 \begin_layout Plain Layout
23555 \begin_inset Flex Code
23558 \begin_layout Plain Layout
23564 that may appear outside style and inset declarations.
23566 \begin_inset CommandInset ref
23568 reference "subsec:General-text-class"
23572 for details on these.
23575 \begin_layout Subsection
23576 \begin_inset CommandInset label
23578 name "subsec:Paragraph-Style-XHTML"
23585 \begin_layout Standard
23586 The sort of XHTML \SpecialChar LyX
23587 outputs for a paragraph depends upon whether we are dealing
23588 with a normal paragraph, a command, or an environment, where this is itself
23589 determined by the contents of the corresponding
23590 \begin_inset Flex Code
23593 \begin_layout Plain Layout
23604 \begin_layout Standard
23605 For a command or normal paragraph, the output XHTML has the following form:
23608 \begin_layout LyX-Code
23612 \begin_inset Quotes erd
23616 \begin_inset Quotes erd
23622 \begin_layout LyX-Code
23626 \begin_inset Quotes erd
23630 \begin_inset Quotes erd
23636 \begin_layout LyX-Code
23639 Contents of the paragraph.
23642 \begin_layout LyX-Code
23648 \begin_layout Standard
23649 The label tags are of course omitted if the paragraph does not have a label.
23652 \begin_layout Standard
23653 For an environment that is not some sort of list, the XHTML takes this form:
23656 \begin_layout LyX-Code
23660 \begin_inset Quotes erd
23664 \begin_inset Quotes erd
23670 \begin_layout LyX-Code
23674 \begin_inset Quotes erd
23678 \begin_inset Quotes erd
23682 \begin_inset Quotes erd
23686 \begin_inset Quotes erd
23689 >Environment Label</labeltag>First paragraph.</itemtag>
23692 \begin_layout LyX-Code
23695 <itemtag>Second paragraph.</itemtag>
23698 \begin_layout LyX-Code
23704 \begin_layout Standard
23705 Note that the label is output only for the first paragraph, as it should
23706 be for a theorem, for example.
23710 \begin_layout Standard
23711 For a list, we have one of these forms:
23714 \begin_layout LyX-Code
23718 \begin_inset Quotes erd
23722 \begin_inset Quotes erd
23728 \begin_layout LyX-Code
23732 \begin_inset Quotes erd
23736 \begin_inset Quotes erd
23740 \begin_inset Quotes erd
23744 \begin_inset Quotes erd
23747 >List Label</labeltag>First item.</itemtag>
23750 \begin_layout LyX-Code
23754 \begin_inset Quotes erd
23758 \begin_inset Quotes erd
23762 \begin_inset Quotes erd
23766 \begin_inset Quotes erd
23769 >List Label</labeltag>Second item.</itemtag>
23772 \begin_layout LyX-Code
23778 \begin_layout LyX-Code
23782 \begin_layout LyX-Code
23786 \begin_inset Quotes erd
23790 \begin_inset Quotes erd
23796 \begin_layout LyX-Code
23800 \begin_inset Quotes erd
23804 \begin_inset Quotes erd
23807 >List Label</labeltag><itemtag attr=
23808 \begin_inset Quotes erd
23812 \begin_inset Quotes erd
23815 >First item.</itemtag>
23818 \begin_layout LyX-Code
23822 \begin_inset Quotes erd
23826 \begin_inset Quotes erd
23829 >List Label</labeltag><itemtag attr=
23830 \begin_inset Quotes erd
23834 \begin_inset Quotes erd
23837 >Second item.</itemtag>
23840 \begin_layout LyX-Code
23846 \begin_layout Standard
23847 Note the different orders of
23848 \begin_inset Flex Code
23851 \begin_layout Plain Layout
23858 \begin_inset Flex Code
23861 \begin_layout Plain Layout
23868 Which order we get depends upon the setting of
23869 \begin_inset Flex Code
23872 \begin_layout Plain Layout
23879 \begin_inset Flex Code
23882 \begin_layout Plain Layout
23888 is false (the default), you get the first of these, with the label within
23889 the item; if true, you get the second, with the label outside the item.
23892 \begin_layout Standard
23893 The specific tags and attributes output for each paragraph type can be controlle
23894 d by means of the layout tags we are about to describe.
23895 As mentioned earlier, however, \SpecialChar LyX
23896 uses sensible defaults for many of these,
23897 so you often may not need to do very much to get good XHTML output.
23898 Think of the available tags as there so you can tweak things to your liking.
23901 \begin_layout Description
23902 \begin_inset Flex Code
23905 \begin_layout Plain Layout
23912 \begin_inset Flex Code
23915 \begin_layout Plain Layout
23921 ] Specifies attribute information to be output with the main tag.
23923 \begin_inset Quotes eld
23927 \begin_inset Flex Code
23930 \begin_layout Plain Layout
23937 \begin_inset Quotes erd
23941 By default, \SpecialChar LyX
23943 \begin_inset Quotes eld
23947 \begin_inset Flex Code
23950 \begin_layout Plain Layout
23957 \begin_inset Quotes erd
23961 \begin_inset Flex Code
23964 \begin_layout Plain Layout
23970 is the \SpecialChar LyX
23971 name of the layout, made lowercase, for example: chapter.
23976 contain any style information.
23978 \begin_inset Flex Code
23981 \begin_layout Plain Layout
23990 \begin_layout Description
23991 \begin_inset Flex Code
23994 \begin_layout Plain Layout
24001 \begin_inset Flex Code
24004 \begin_layout Plain Layout
24014 ] Whether to output the default CSS information \SpecialChar LyX
24015 generates for this layout,
24016 even if additional information is explicitly provided via
24017 \begin_inset Flex Code
24020 \begin_layout Plain Layout
24028 \begin_inset Flex Code
24031 \begin_layout Plain Layout
24037 allows you to alter or augment the generated CSS, rather than to override
24040 \begin_inset Flex Code
24043 \begin_layout Plain Layout
24052 \begin_layout Description
24053 \begin_inset Flex Code
24056 \begin_layout Plain Layout
24063 \begin_inset Flex Code
24066 \begin_layout Plain Layout
24072 ] The tag to be used for individual paragraphs of environments, replacing
24074 \begin_inset Flex Code
24077 \begin_layout Plain Layout
24083 in the examples above.
24085 \begin_inset Flex Code
24088 \begin_layout Plain Layout
24097 \begin_layout Description
24098 \begin_inset Flex Code
24101 \begin_layout Plain Layout
24108 \begin_inset Flex Code
24111 \begin_layout Plain Layout
24117 ] Attributes for the item tag.
24119 \begin_inset Newline newline
24123 \begin_inset Quotes eld
24127 \begin_inset Flex Code
24130 \begin_layout Plain Layout
24131 class=`layoutname_item'
24137 \begin_inset Quotes erd
24145 contain any style information.
24147 \begin_inset Flex Code
24150 \begin_layout Plain Layout
24159 \begin_layout Description
24160 \begin_inset Flex Code
24163 \begin_layout Plain Layout
24170 \begin_inset Flex Code
24173 \begin_layout Plain Layout
24179 ] The tag to be used for paragraph and item labels, replacing
24180 \begin_inset Flex Code
24183 \begin_layout Plain Layout
24189 in the examples above.
24191 \begin_inset Flex Code
24194 \begin_layout Plain Layout
24201 \begin_inset Flex Code
24204 \begin_layout Plain Layout
24211 \begin_inset Flex Code
24214 \begin_layout Plain Layout
24221 \begin_inset Flex Code
24224 \begin_layout Plain Layout
24225 Centered_Top_Environment
24230 , in which case it defaults to
24231 \begin_inset Flex Code
24234 \begin_layout Plain Layout
24243 \begin_layout Description
24244 \begin_inset Flex Code
24247 \begin_layout Plain Layout
24254 \begin_inset Flex Code
24257 \begin_layout Plain Layout
24263 ] Attributes for the label tag.
24265 \begin_inset Newline newline
24269 \begin_inset Quotes eld
24273 \begin_inset Flex Code
24276 \begin_layout Plain Layout
24277 class=`layoutname_label'
24283 \begin_inset Quotes erd
24291 contain any style information.
24293 \begin_inset Flex Code
24296 \begin_layout Plain Layout
24305 \begin_layout Description
24306 \begin_inset Flex Code
24309 \begin_layout Plain Layout
24316 \begin_inset Flex Code
24319 \begin_layout Plain Layout
24329 ] Meaningful only for list-like environments, this tag controls whether
24330 the label tag is output before or inside the item tag.
24331 This is used, for example, in the description environment, where we want
24333 \begin_inset Flex Code
24336 \begin_layout Plain Layout
24337 <dt>\SpecialChar ldots
24338 </dt><dd>\SpecialChar ldots
24346 \begin_inset Flex Code
24349 \begin_layout Plain Layout
24355 : The label tag is output inside the item tag.
24358 \begin_layout Description
24359 \begin_inset Flex Code
24362 \begin_layout Plain Layout
24368 Information to be output in the
24369 \begin_inset Flex Code
24372 \begin_layout Plain Layout
24378 section when this style is used.
24379 This might, for example, be used to include a
24380 \begin_inset Flex Code
24383 \begin_layout Plain Layout
24390 \begin_inset Flex Code
24393 \begin_layout Plain Layout
24402 \begin_layout Description
24403 \begin_inset Flex Code
24406 \begin_layout Plain Layout
24412 CSS style information to be included when this style is used.
24413 Note that this will automatically be wrapped in a layout-generated
24414 \begin_inset Flex Code
24417 \begin_layout Plain Layout
24423 block, so only the CSS itself need be included.
24425 \begin_inset Flex Code
24428 \begin_layout Plain Layout
24437 \begin_layout Description
24438 \begin_inset Flex Code
24441 \begin_layout Plain Layout
24448 \begin_inset Flex Code
24451 \begin_layout Plain Layout
24457 ] The tag to be used for the main label, replacing
24458 \begin_inset Flex Code
24461 \begin_layout Plain Layout
24467 in the examples above.
24469 \begin_inset Flex Code
24472 \begin_layout Plain Layout
24481 \begin_layout Description
24482 \begin_inset Flex Code
24485 \begin_layout Plain Layout
24492 \begin_inset Flex Code
24495 \begin_layout Plain Layout
24505 ] Marks this style as the one to be used to generate the
24506 \begin_inset Flex Code
24509 \begin_layout Plain Layout
24515 tag for the XHTML file.
24516 By default, it is false.
24518 \begin_inset Flex Code
24521 \begin_layout Plain Layout
24527 file sets it to true for the
24528 \begin_inset Flex Code
24531 \begin_layout Plain Layout
24541 \begin_layout Subsection
24545 \begin_layout Standard
24546 The XHTML output of insets can also be controlled by information in layout
24551 \begin_layout Plain Layout
24552 At present, this is true only for
24553 \begin_inset Quotes eld
24557 \begin_inset Quotes erd
24560 insets (insets you can type into) and is not true for
24561 \begin_inset Quotes eld
24565 \begin_inset Quotes erd
24568 insets (insets that are associated with dialog boxes).
24573 Here, too, \SpecialChar LyX
24574 tries to provide sensible defaults, and it constructs default
24576 But everything can be customized.
24579 \begin_layout Standard
24580 The XHTML \SpecialChar LyX
24581 outputs for an inset has the following form:
24584 \begin_layout LyX-Code
24586 \begin_inset Quotes erd
24590 \begin_inset Quotes erd
24596 \begin_layout LyX-Code
24597 <labeltag>Label</labeltag>
24600 \begin_layout LyX-Code
24602 \begin_inset Quotes erd
24606 \begin_inset Quotes erd
24609 >Contents of the inset.</innertag>
24612 \begin_layout LyX-Code
24616 \begin_layout Standard
24617 If the inset permits multiple paragraphs—that is, if
24618 \begin_inset Flex Code
24621 \begin_layout Plain Layout
24627 is true—then the contents of the inset will itself be output as paragraphs
24628 formatted according to the styles used for those paragraphs (standard,
24629 quote, and the like).
24630 The label tag is of course omitted if the paragraph does not have a label
24631 and, at present, is always
24632 \begin_inset Flex Code
24635 \begin_layout Plain Layout
24642 The inner tag is optional and, by default, does not appear.
24645 \begin_layout Standard
24646 The specific tags and attributes output for each inset can be controlled
24647 by means of the following layout tags.
24650 \begin_layout Description
24651 \begin_inset Flex Code
24654 \begin_layout Plain Layout
24661 \begin_inset Flex Code
24664 \begin_layout Plain Layout
24670 ] Specifies attribute information to be output with the main tag.
24672 \begin_inset Quotes eld
24676 \begin_inset Flex Code
24679 \begin_layout Plain Layout
24680 class=`myinset' onclick=`\SpecialChar ldots
24687 \begin_inset Quotes erd
24691 By default, \SpecialChar LyX
24693 \begin_inset Quotes eld
24697 \begin_inset Flex Code
24700 \begin_layout Plain Layout
24707 \begin_inset Quotes erd
24711 \begin_inset Flex Code
24714 \begin_layout Plain Layout
24720 is the \SpecialChar LyX
24721 name of the inset, made lowercase and with non-alphanumeric characters
24722 converted to underscores, for example: footnote.
24725 \begin_layout Description
24726 \begin_inset Flex Code
24729 \begin_layout Plain Layout
24736 \begin_inset Flex Code
24739 \begin_layout Plain Layout
24749 ] Whether to output the default CSS information \SpecialChar LyX
24750 generates for this layout,
24751 even if additional information is explicitly provided via
24752 \begin_inset Flex Code
24755 \begin_layout Plain Layout
24763 \begin_inset Flex Code
24766 \begin_layout Plain Layout
24772 allows you to alter or augment the generated CSS, rather than to override
24777 \begin_layout Description
24778 \begin_inset Flex Code
24781 \begin_layout Plain Layout
24788 \begin_inset Flex Code
24791 \begin_layout Plain Layout
24797 ] Attributes for the inner tag.
24799 \begin_inset Newline newline
24803 \begin_inset Quotes eld
24807 \begin_inset Flex Code
24810 \begin_layout Plain Layout
24811 class=`insetname_inner'
24817 \begin_inset Quotes erd
24823 \begin_layout Description
24824 \begin_inset Flex Code
24827 \begin_layout Plain Layout
24834 \begin_inset Flex Code
24837 \begin_layout Plain Layout
24843 ] The inner tag, replacing
24844 \begin_inset Flex Code
24847 \begin_layout Plain Layout
24853 in the examples above.
24854 By default, there is none.
24857 \begin_layout Description
24858 \begin_inset Flex Code
24861 \begin_layout Plain Layout
24868 \begin_inset Flex Code
24871 \begin_layout Plain Layout
24879 ] Whether this inset represents a standalone block of text (such as a footnote)
24880 or instead represents material that is included in the surrounding text
24881 (such as a branch).
24885 \begin_layout Description
24886 \begin_inset Flex Code
24889 \begin_layout Plain Layout
24896 \begin_inset Flex Code
24899 \begin_layout Plain Layout
24905 ] A label for this inset, possibly including a reference to a counter.
24906 For example, for footnote, it might be:
24907 \begin_inset Flex Code
24910 \begin_layout Plain Layout
24919 This is optional, and there is no default.
24922 \begin_layout Description
24923 \begin_inset Flex Code
24926 \begin_layout Plain Layout
24932 Information to be output in the
24933 \begin_inset Flex Code
24936 \begin_layout Plain Layout
24942 section when this style is used.
24943 This might, for example, be used to include a
24944 \begin_inset Flex Code
24947 \begin_layout Plain Layout
24954 \begin_inset Flex Code
24957 \begin_layout Plain Layout
24966 \begin_layout Description
24967 \begin_inset Flex Code
24970 \begin_layout Plain Layout
24976 CSS style information to be included when this style is used.
24977 Note that this will automatically be wrapped in a layout-generated
24978 \begin_inset Flex Code
24981 \begin_layout Plain Layout
24987 block, so only the CSS itself need be included.
24990 \begin_layout Description
24991 \begin_inset Flex Code
24994 \begin_layout Plain Layout
25001 \begin_inset Flex Code
25004 \begin_layout Plain Layout
25010 ] The tag to be used for the main label, replacing
25011 \begin_inset Flex Code
25014 \begin_layout Plain Layout
25020 in the examples above.
25021 The default depends upon the setting of
25022 \begin_inset Flex Code
25025 \begin_layout Plain Layout
25032 \begin_inset Flex Code
25035 \begin_layout Plain Layout
25041 is true, the default is
25042 \begin_inset Flex Code
25045 \begin_layout Plain Layout
25051 ; if it is false, the default is
25052 \begin_inset Flex Code
25055 \begin_layout Plain Layout
25064 \begin_layout Subsection
25068 \begin_layout Standard
25069 The XHTML output for floats too can be controlled by layout information.
25070 The output has the following form:
25073 \begin_layout LyX-Code
25075 \begin_inset Quotes erd
25079 \begin_inset Quotes erd
25085 \begin_layout LyX-Code
25086 Contents of the float.
25089 \begin_layout LyX-Code
25093 \begin_layout Standard
25094 The caption, if there is one, is a separate inset and will be output as
25096 Its appearance can be controlled via the InsetLayout for caption insets.
25100 \begin_layout Description
25101 \begin_inset Flex Code
25104 \begin_layout Plain Layout
25111 \begin_inset Flex Code
25114 \begin_layout Plain Layout
25120 ] Specifies attribute information to be output with the main tag.
25122 \begin_inset Quotes eld
25126 \begin_inset Flex Code
25129 \begin_layout Plain Layout
25130 class=`myfloat' onclick=`\SpecialChar ldots
25137 \begin_inset Quotes erd
25141 By default, \SpecialChar LyX
25143 \begin_inset Quotes eld
25147 \begin_inset Flex Code
25150 \begin_layout Plain Layout
25151 class=`float float-floattype'
25157 \begin_inset Quotes erd
25161 \begin_inset Flex Code
25164 \begin_layout Plain Layout
25170 is \SpecialChar LyX
25171 's name for this type of float, as determined by the float declaration
25173 \begin_inset CommandInset ref
25175 reference "subsec:Floats"
25179 ), though made lowercase and with non-alphanumeric characters converted
25180 to underscores, for example: float-table.
25183 \begin_layout Description
25184 \begin_inset Flex Code
25187 \begin_layout Plain Layout
25193 CSS style information to be included when this float is used.
25194 Note that this will automatically be wrapped in a layout-generated
25195 \begin_inset Flex Code
25198 \begin_layout Plain Layout
25204 block, so only the CSS itself need be included.
25207 \begin_layout Description
25208 \begin_inset Flex Code
25211 \begin_layout Plain Layout
25218 \begin_inset Flex Code
25221 \begin_layout Plain Layout
25227 ] The tag to be used for this float, replacing
25228 \begin_inset Quotes eld
25232 \begin_inset Flex Code
25235 \begin_layout Plain Layout
25242 \begin_inset Quotes erd
25245 in the example above.
25247 \begin_inset Flex Code
25250 \begin_layout Plain Layout
25256 and will rarely need changing.
25259 \begin_layout Subsection
25260 Bibliography formatting
25263 \begin_layout Standard
25264 The bibliography can be formatted using
25265 \begin_inset Flex Code
25268 \begin_layout Plain Layout
25276 \begin_inset CommandInset ref
25278 reference "subsec:Citation-format-description"
25285 \begin_layout Subsection
25290 \begin_layout Standard
25291 We have several times mentioned that \SpecialChar LyX
25292 will generate default CSS style rules
25293 for both insets and paragraph styles, based upon the other layout information
25295 In this section, we shall say a word about which layout information \SpecialChar LyX
25300 \begin_layout Standard
25301 At present, \SpecialChar LyX
25302 auto-generates CSS only for font information, making use of
25304 \begin_inset Flex Code
25307 \begin_layout Plain Layout
25314 \begin_inset Flex Code
25317 \begin_layout Plain Layout
25324 \begin_inset Flex Code
25327 \begin_layout Plain Layout
25334 \begin_inset Flex Code
25337 \begin_layout Plain Layout
25344 \begin_inset Flex Code
25347 \begin_layout Plain Layout
25354 \begin_inset CommandInset ref
25356 reference "subsec:Font-description"
25361 The translation is mostly straightforward and obvious.
25363 \begin_inset Quotes eld
25367 \begin_inset Flex Code
25370 \begin_layout Plain Layout
25377 \begin_inset Quotes erd
25381 \begin_inset Quotes eld
25385 \begin_inset Flex Code
25388 \begin_layout Plain Layout
25389 font-family: sans-serif;
25395 \begin_inset Quotes erd
25399 The correspondence of \SpecialChar LyX
25400 sizes and CSS sizes is a little less obvious but
25401 nonetheless intuitive.
25403 \begin_inset Flex Code
25406 \begin_layout Plain Layout
25413 \begin_inset Flex URL
25416 \begin_layout Plain Layout
25426 \begin_layout Chapter
25427 Including External Material
25428 \begin_inset CommandInset label
25430 name "chap:Including-External-Material"
25437 \begin_layout Standard
25438 \begin_inset Box Shadowbox
25448 height_special "totalheight"
25453 backgroundcolor "none"
25456 \begin_layout Plain Layout
25457 WARNING: This portion of the documentation has not been updated for some
25459 We certainly hope that it is still accurate, but there are no guarantees.
25467 \begin_layout Standard
25468 The use of material from sources external to \SpecialChar LyX
25469 is covered in detail in the
25475 This part of the manual covers what needs to happen behind the scenes for
25476 new sorts of material to be included.
25479 \begin_layout Section
25483 \begin_layout Standard
25484 The external material feature is based on the concept of a
25489 A template is a specification of how \SpecialChar LyX
25490 should interface with a certain kind
25492 As bundled, \SpecialChar LyX
25493 comes with predefined templates for Xfig figures, various
25494 raster format images, chess diagrams, and LilyPond music notation.
25495 You can check the actual list by using the menu
25496 \begin_inset Flex Noun
25499 \begin_layout Plain Layout
25500 Insert\SpecialChar menuseparator
25501 File\SpecialChar menuseparator
25508 Furthermore, it is possible to roll your own template to support a specific
25510 Later we'll describe in more detail what is involved, and hopefully you
25511 will submit all the templates you create so we can include them in a later
25516 \begin_layout Standard
25517 Another basic idea of the external material feature is to distinguish between
25518 the original file that serves as a base for final material and the produced
25519 file that is included in your exported or printed document.
25520 For example, consider the case of a figure produced with
25521 \begin_inset Flex Code
25524 \begin_layout Plain Layout
25531 The Xfig application itself works on an original file with the
25532 \begin_inset Flex Code
25535 \begin_layout Plain Layout
25542 Within Xfig, you create and change your figure, and when you are done,
25544 \begin_inset Flex Code
25547 \begin_layout Plain Layout
25554 When you want to include the figure in your document, you invoke
25555 \begin_inset Flex Code
25558 \begin_layout Plain Layout
25564 in order to create a PostScript file that can readily be included in your
25568 \begin_inset Flex Code
25571 \begin_layout Plain Layout
25577 file is the original file, and the PostScript file is the produced file.
25580 \begin_layout Standard
25581 This distinction is important in order to allow updating of the material
25582 while you are in the process of writing the document.
25583 Furthermore, it provides us with the flexibility that is needed to support
25584 multiple export formats.
25585 For instance, in the case of a plain text file, it is not exactly an award-winn
25586 ing idea to include the figure as raw PostScript.
25587 Instead, you would either prefer to just include a reference to the figure
25588 or try to invoke some graphics to ASCII converter to make the final result
25589 look similar to the real graphics.
25590 The external material management allows you to do this, because it is parametri
25591 zed on the different export formats that \SpecialChar LyX
25595 \begin_layout Standard
25596 Besides supporting the production of different products according to the
25597 exported format, it supports tight integration with editing and viewing
25599 In the case of an Xfig figure, you are able to invoke Xfig on the original
25600 file with a single click from within the external material dialog in \SpecialChar LyX
25602 and also preview the produced PostScript file with Ghostview with another
25604 No more fiddling around with the command line and/or file browsers to locate
25605 and manipulate the original or produced files.
25606 In this way, you are finally able to take full advantage of the many different
25607 applications that are relevant to use when you write your documents, and
25608 ultimately be more productive.
25611 \begin_layout Section
25612 The external template configuration files
25615 \begin_layout Standard
25616 It is relatively easy to add custom external template definitions to \SpecialChar LyX
25618 However, be aware that doing this in an careless manner most probably
25622 introduce an easily exploitable security hole.
25623 So before you do this, please read the discussion about security in
25624 \begin_inset CommandInset ref
25626 reference "sec:Security-discussion"
25633 \begin_layout Standard
25634 Having said that, we encourage you to submit any interesting templates that
25639 \begin_layout Standard
25640 The external templates are defined in the
25641 \begin_inset Flex Code
25644 \begin_layout Plain Layout
25650 files that are stored in the
25651 \begin_inset Flex Code
25654 \begin_layout Plain Layout
25655 LyXDir/lib/xtemplates/
25661 Each template is defined in a file of its own.
25662 You can place your own templates in
25663 \begin_inset Flex Code
25666 \begin_layout Plain Layout
25667 UserDir/xtemplates/
25672 or copy existing templates to that directory in order to modify them.
25675 \begin_layout Standard
25676 A typical template looks like this:
25679 \begin_layout LyX-Code
25683 \begin_layout LyX-Code
25684 GuiName "XFig: $$AbsOrRelPathParent$$Basename"
25687 \begin_layout LyX-Code
25691 \begin_layout LyX-Code
25695 \begin_layout LyX-Code
25699 \begin_layout LyX-Code
25703 \begin_layout LyX-Code
25707 \begin_layout LyX-Code
25708 AutomaticProduction true
25711 \begin_layout LyX-Code
25715 \begin_layout LyX-Code
25719 \begin_layout LyX-Code
25723 \begin_layout LyX-Code
25724 TransformCommand Rotate RotationLatexCommand
25727 \begin_layout LyX-Code
25728 TransformCommand Resize ResizeLatexCommand
25731 \begin_layout LyX-Code
25732 Product "$$RotateFront$$ResizeFront
25735 \begin_layout LyX-Code
25740 input{$$AbsOrRelPathMaster$$Basename.pstex_t}
25743 \begin_layout LyX-Code
25744 $$ResizeBack$$RotateBack"
25747 \begin_layout LyX-Code
25751 \begin_layout LyX-Code
25752 UpdateResult "$$AbsPath$$Basename.pstex_t"
25755 \begin_layout LyX-Code
25756 Requirement "graphicx"
25759 \begin_layout LyX-Code
25760 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
25763 \begin_layout LyX-Code
25764 ReferencedFile latex "$$AbsPath$$Basename.eps"
25767 \begin_layout LyX-Code
25768 ReferencedFile dvi "$$AbsPath$$Basename.eps"
25771 \begin_layout LyX-Code
25775 \begin_layout LyX-Code
25779 \begin_layout LyX-Code
25780 TransformCommand Rotate RotationLatexCommand
25783 \begin_layout LyX-Code
25784 TransformCommand Resize ResizeLatexCommand
25787 \begin_layout LyX-Code
25788 Product "$$RotateFront$$ResizeFront
25791 \begin_layout LyX-Code
25796 input{$$AbsOrRelPathMaster$$Basename.pdftex_t}
25799 \begin_layout LyX-Code
25800 $$ResizeBack$$RotateBack"
25803 \begin_layout LyX-Code
25804 UpdateFormat pdftex
25807 \begin_layout LyX-Code
25808 UpdateResult "$$AbsPath$$Basename.pdftex_t"
25811 \begin_layout LyX-Code
25812 Requirement "graphicx"
25815 \begin_layout LyX-Code
25816 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pdftex_t"
25819 \begin_layout LyX-Code
25820 ReferencedFile latex "$$AbsPath$$Basename.pdf"
25823 \begin_layout LyX-Code
25827 \begin_layout LyX-Code
25831 \begin_layout LyX-Code
25832 Product "[XFig: $$FName]"
25835 \begin_layout LyX-Code
25839 \begin_layout LyX-Code
25843 \begin_layout LyX-Code
25844 Product "<graphic fileref=
25846 "$$AbsOrRelPathMaster$$Basename.eps
25851 \begin_layout LyX-Code
25855 \begin_layout LyX-Code
25859 \begin_layout LyX-Code
25860 UpdateResult "$$AbsPath$$Basename.eps"
25863 \begin_layout LyX-Code
25864 ReferencedFile docbook "$$AbsPath$$Basename.eps"
25867 \begin_layout LyX-Code
25868 ReferencedFile docbook-xml "$$AbsPath$$Basename.eps"
25871 \begin_layout LyX-Code
25875 \begin_layout LyX-Code
25879 \begin_layout Standard
25880 As you can see, the template is enclosed in
25881 \begin_inset Flex Code
25884 \begin_layout Plain Layout
25892 \begin_inset Flex Code
25895 \begin_layout Plain Layout
25902 It contains a header specifying some general settings and, for each supported
25903 primary document file format, a section
25904 \begin_inset Flex Code
25907 \begin_layout Plain Layout
25915 \begin_inset Flex Code
25918 \begin_layout Plain Layout
25927 \begin_layout Subsection
25928 The template header
25931 \begin_layout Description
25932 \begin_inset Flex Code
25935 \begin_layout Plain Layout
25936 AutomaticProduction
25937 \begin_inset space ~
25945 Whether the file represented by the template must be generated by \SpecialChar LyX
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 A glob pattern that is used in the file dialog to filter out the desired
25966 If there is more than one possible file extension (e.
25967 \begin_inset space \thinspace{}
25971 \begin_inset space \space{}
25975 \begin_inset Flex Code
25978 \begin_layout Plain Layout
25985 \begin_inset Flex Code
25988 \begin_layout Plain Layout
25994 ), use something like
25995 \begin_inset Flex Code
25998 \begin_layout Plain Layout
26005 This command must occur exactly once.
26008 \begin_layout Description
26009 \begin_inset Flex Code
26012 \begin_layout Plain Layout
26014 \begin_inset space ~
26022 The text that is displayed on the button.
26023 This command must occur exactly once.
26026 \begin_layout Description
26027 \begin_inset Flex Code
26030 \begin_layout Plain Layout
26032 \begin_inset space ~
26036 \begin_inset space ~
26044 The help text that is used in the External dialog.
26045 Provide enough information to explain to the user just what the template
26046 can provide him with.
26047 This command must occur exactly once.
26050 \begin_layout Description
26051 \begin_inset Flex Code
26054 \begin_layout Plain Layout
26056 \begin_inset space ~
26064 The file format of the original file.
26065 This must be the name of a format that is known to \SpecialChar LyX
26067 \begin_inset CommandInset ref
26069 reference "sec:Formats"
26075 \begin_inset Quotes eld
26079 \begin_inset Flex Code
26082 \begin_layout Plain Layout
26089 \begin_inset Quotes erd
26092 if the template can handle original files of more than one format.
26094 will attempt to interrogate the file itself in order to deduce its format
26096 This command must occur exactly once.
26099 \begin_layout Description
26100 \begin_inset Flex Code
26103 \begin_layout Plain Layout
26105 \begin_inset space ~
26113 A unique name for the template.
26114 It must not contain substitution macros (see below).
26117 \begin_layout Description
26118 \begin_inset Flex Code
26121 \begin_layout Plain Layout
26123 \begin_inset space ~
26126 Rotate|Resize|Clip|Extra
26131 This command specifies which transformations are supported by this template.
26132 It may occur zero or more times.
26133 This command enables the corresponding tabs in the external dialog.
26135 \begin_inset Flex Code
26138 \begin_layout Plain Layout
26144 command must have either a corresponding
26145 \begin_inset Flex Code
26148 \begin_layout Plain Layout
26155 \begin_inset Flex Code
26158 \begin_layout Plain Layout
26165 \begin_inset Flex Code
26168 \begin_layout Plain Layout
26175 Otherwise the transformation will not be supported by that format.
26178 \begin_layout Subsection
26182 \begin_layout Description
26183 \begin_inset Flex Code
26186 \begin_layout Plain Layout
26188 \begin_inset space ~
26191 LaTeX|PDFLaTeX|PlainText|DocBook|XHTML
26196 The primary document file format that this format definition is for.
26197 Not every template has a sensible representation in all document file formats.
26198 Please define nevertheless a
26199 \begin_inset Flex Code
26202 \begin_layout Plain Layout
26208 section for all templates.
26209 Use a dummy text when no representation is available.
26210 Then you can at least see a reference to the external material in the exported
26214 \begin_layout Description
26215 \begin_inset Flex Code
26218 \begin_layout Plain Layout
26220 \begin_inset space ~
26224 \begin_inset space ~
26232 This command defines an additional macro
26233 \begin_inset Flex Code
26236 \begin_layout Plain Layout
26242 for substitution in
26243 \begin_inset Flex Code
26246 \begin_layout Plain Layout
26254 \begin_inset Flex Code
26257 \begin_layout Plain Layout
26263 itself may contain substitution macros.
26264 The advantage over using
26265 \begin_inset Flex Code
26268 \begin_layout Plain Layout
26275 \begin_inset Flex Code
26278 \begin_layout Plain Layout
26284 is that the substituted value of
26285 \begin_inset Flex Code
26288 \begin_layout Plain Layout
26294 is sanitized so that it is a valid optional argument in the document format.
26295 This command may occur zero or more times.
26298 \begin_layout Description
26299 \begin_inset Flex Code
26302 \begin_layout Plain Layout
26304 \begin_inset space ~
26312 The text that is inserted in the exported document.
26313 This is actually the most important command and can be quite complex.
26314 This command must occur exactly once.
26317 \begin_layout Description
26318 \begin_inset Flex Code
26321 \begin_layout Plain Layout
26323 \begin_inset space ~
26331 This command specifies a preamble snippet that will be included in the
26334 It has to be defined using
26335 \begin_inset Flex Code
26338 \begin_layout Plain Layout
26346 \begin_inset Flex Code
26349 \begin_layout Plain Layout
26356 This command may occur zero or more times.
26359 \begin_layout Description
26360 \begin_inset Flex Code
26363 \begin_layout Plain Layout
26365 \begin_inset space ~
26369 \begin_inset space ~
26377 This command denotes files that are created by the conversion process and
26378 are needed for a particular export format.
26379 If the filename is relative, it is interpreted relative to the master document.
26380 This command may be given zero or more times.
26383 \begin_layout Description
26384 \begin_inset Flex Code
26387 \begin_layout Plain Layout
26389 \begin_inset space ~
26397 The name of a required \SpecialChar LaTeX
26399 The package is included via
26400 \begin_inset Flex Code
26403 \begin_layout Plain Layout
26411 in the \SpecialChar LaTeX
26413 This command may occur zero or more times.
26416 \begin_layout Description
26417 \begin_inset Flex Code
26420 \begin_layout Plain Layout
26422 \begin_inset space ~
26426 \begin_inset space ~
26429 RotationLatexCommand
26434 This command specifies that the built in \SpecialChar LaTeX
26435 command should be used for rotation.
26436 This command may occur once or not at all.
26439 \begin_layout Description
26440 \begin_inset Flex Code
26443 \begin_layout Plain Layout
26445 \begin_inset space ~
26449 \begin_inset space ~
26457 This command specifies that the built in \SpecialChar LaTeX
26458 command should be used for resizing.
26459 This command may occur once or not at all.
26462 \begin_layout Description
26463 \begin_inset Flex Code
26466 \begin_layout Plain Layout
26468 \begin_inset space ~
26472 \begin_inset space ~
26475 RotationLatexOption
26480 This command specifies that rotation is done via an optional argument.
26481 This command may occur once or not at all.
26484 \begin_layout Description
26485 \begin_inset Flex Code
26488 \begin_layout Plain Layout
26490 \begin_inset space ~
26494 \begin_inset space ~
26502 This command specifies that resizing is done via an optional argument.
26503 This command may occur once or not at all.
26506 \begin_layout Description
26507 \begin_inset Flex Code
26510 \begin_layout Plain Layout
26512 \begin_inset space ~
26516 \begin_inset space ~
26524 This command specifies that clipping is done via an optional argument.
26525 This command may occur once or not at all.
26528 \begin_layout Description
26529 \begin_inset Flex Code
26532 \begin_layout Plain Layout
26534 \begin_inset space ~
26538 \begin_inset space ~
26546 This command specifies that an extra optional argument is used.
26547 This command may occur once or not at all.
26550 \begin_layout Description
26551 \begin_inset Flex Code
26554 \begin_layout Plain Layout
26556 \begin_inset space ~
26564 The file format of the converted file.
26565 This must be the name of a format that is known to \SpecialChar LyX
26567 \begin_inset Flex Noun
26570 \begin_layout Plain Layout
26571 Tools\SpecialChar menuseparator
26572 Preferences\SpecialChar menuseparator
26573 File Handling\SpecialChar menuseparator
26580 This command must occur exactly once.
26581 If the resulting file format is PDF, you need to specify the format
26582 \begin_inset Flex Code
26585 \begin_layout Plain Layout
26592 This is the PDF format used for including graphics.
26593 The other defined PDF formats are for document export.
26596 \begin_layout Description
26597 \begin_inset Flex Code
26600 \begin_layout Plain Layout
26602 \begin_inset space ~
26610 The file name of the converted file.
26611 The file name must be absolute.
26612 This command must occur exactly once.
26615 \begin_layout Subsection
26616 Preamble definitions
26619 \begin_layout Standard
26620 The external template configuration file may contain additional preamble
26621 definitions enclosed by
26622 \begin_inset Flex Code
26625 \begin_layout Plain Layout
26633 \begin_inset Flex Code
26636 \begin_layout Plain Layout
26643 They can be used by the templates in the
26644 \begin_inset Flex Code
26647 \begin_layout Plain Layout
26656 \begin_layout Section
26657 The substitution mechanism
26660 \begin_layout Standard
26661 When the external material facility invokes an external program, it is done
26662 on the basis of a command defined in the template configuration file.
26663 These commands can contain various macros that are expanded before execution.
26664 Execution always take place in the directory of the containing document.
26667 \begin_layout Standard
26668 Also, whenever external material is to be displayed, the name will be produced
26669 by the substitution mechanism, and most other commands in the template
26670 definition support substitution as well.
26673 \begin_layout Standard
26674 The available macros are the following:
26677 \begin_layout Description
26678 \begin_inset Flex Code
26681 \begin_layout Plain Layout
26682 $$AbsOrRelPathMaster
26687 The file path, absolute or relative to the master \SpecialChar LyX
26691 \begin_layout Description
26692 \begin_inset Flex Code
26695 \begin_layout Plain Layout
26696 $$AbsOrRelPathParent
26701 The file path, absolute or relative to the \SpecialChar LyX
26705 \begin_layout Description
26706 \begin_inset Flex Code
26709 \begin_layout Plain Layout
26715 The absolute file path.
26718 \begin_layout Description
26719 \begin_inset Flex Code
26722 \begin_layout Plain Layout
26728 The filename without path and without the extension.
26731 \begin_layout Description
26732 \begin_inset Flex Code
26735 \begin_layout Plain Layout
26737 \begin_inset Quotes eld
26741 \begin_inset Quotes erd
26749 This macro will expand to the contents of the file with the name
26750 \begin_inset Flex Code
26753 \begin_layout Plain Layout
26762 \begin_layout Description
26763 \begin_inset Flex Code
26766 \begin_layout Plain Layout
26772 The file extension (including the dot).
26775 \begin_layout Description
26776 \begin_inset Flex Code
26779 \begin_layout Plain Layout
26785 This will be the string
26786 \begin_inset Quotes eld
26790 \begin_inset Quotes erd
26793 if the file is in JPEG format, otherwise it will be the string
26794 \begin_inset Quotes eld
26798 \begin_inset Quotes erd
26802 This is useful to avoid uneeded conversions for output formats that support
26803 both PNG and JPEG fomats.
26804 The predefined RasterImage template uses this macro for the pdf\SpecialChar TeX
26809 \begin_layout Description
26810 \begin_inset Flex Code
26813 \begin_layout Plain Layout
26819 The filename of the file specified in the external material dialog.
26820 This is either an absolute name, or it is relative to the \SpecialChar LyX
26824 \begin_layout Description
26825 \begin_inset Flex Code
26828 \begin_layout Plain Layout
26835 \begin_inset Flex Code
26838 \begin_layout Plain Layout
26844 (absolute name or relative to the \SpecialChar LyX
26848 \begin_layout Description
26849 \begin_inset Flex Code
26852 \begin_layout Plain Layout
26858 The file path, relative to the master \SpecialChar LyX
26862 \begin_layout Description
26863 \begin_inset Flex Code
26866 \begin_layout Plain Layout
26872 The file path, relative to the \SpecialChar LyX
26876 \begin_layout Description
26877 \begin_inset Flex Code
26880 \begin_layout Plain Layout
26886 This macro will expand to the absolute path of the system directory.
26887 This is typically used to point to the various helper scripts that are
26888 bundled with \SpecialChar LyX
26892 \begin_layout Description
26893 \begin_inset Flex Code
26896 \begin_layout Plain Layout
26902 A name and full path to a temporary file which will be automatically deleted
26903 whenever the containing document is closed, or the external material insertion
26907 \begin_layout Standard
26908 All path macros contain a trailing directory separator, so you can construct
26910 \begin_inset space \thinspace{}
26914 \begin_inset space \space{}
26917 the absolute filename with
26918 \begin_inset Flex Code
26921 \begin_layout Plain Layout
26922 $$AbsPath$$Basename$$Extension
26930 \begin_layout Standard
26931 The macros above are substituted in all commands unless otherwise noted.
26933 \begin_inset Flex Code
26936 \begin_layout Plain Layout
26942 supports additionally the following substitutions if they are enabled by
26944 \begin_inset Flex Code
26947 \begin_layout Plain Layout
26954 \begin_inset Flex Code
26957 \begin_layout Plain Layout
26966 \begin_layout Description
26967 \begin_inset Flex Code
26970 \begin_layout Plain Layout
26976 The front part of the resize command.
26979 \begin_layout Description
26980 \begin_inset Flex Code
26983 \begin_layout Plain Layout
26989 The back part of the resize command.
26992 \begin_layout Description
26993 \begin_inset Flex Code
26996 \begin_layout Plain Layout
27002 The front part of the rotation command.
27005 \begin_layout Description
27006 \begin_inset Flex Code
27009 \begin_layout Plain Layout
27015 The back part of the rotation command.
27018 \begin_layout Standard
27019 The value string of the
27020 \begin_inset Flex Code
27023 \begin_layout Plain Layout
27029 command supports additionally the following substitutions if they are enabled
27031 \begin_inset Flex Code
27034 \begin_layout Plain Layout
27041 \begin_inset Flex Code
27044 \begin_layout Plain Layout
27053 \begin_layout Description
27054 \begin_inset Flex Code
27057 \begin_layout Plain Layout
27066 \begin_layout Description
27067 \begin_inset Flex Code
27070 \begin_layout Plain Layout
27079 \begin_layout Description
27080 \begin_inset Flex Code
27083 \begin_layout Plain Layout
27092 \begin_layout Description
27093 \begin_inset Flex Code
27096 \begin_layout Plain Layout
27102 The rotation option.
27105 \begin_layout Standard
27106 You may ask why there are so many path macros.
27107 There are mainly two reasons:
27110 \begin_layout Enumerate
27111 Relative and absolute file names should remain relative or absolute, respectivel
27113 Users may have reasons to prefer either form.
27114 Relative names are useful for portable documents that should work on different
27115 machines, for example.
27116 Absolute names may be required by some programs.
27119 \begin_layout Enumerate
27121 treats relative file names differently than \SpecialChar LyX
27122 and other programs in nested
27124 For \SpecialChar LyX
27125 , a relative file name is always relative to the document that contains
27127 For \SpecialChar LaTeX
27128 , it is always relative to the master document.
27129 These two definitions are identical if you have only one document, but
27130 differ if you have a master document that includes part documents.
27131 That means that relative filenames must be transformed when presented to
27134 Fortunately \SpecialChar LyX
27135 does this automatically for you if you choose the right macros.
27138 \begin_layout Standard
27139 So which path macro should be used in new template definitions? The rule
27143 \begin_layout Itemize
27145 \begin_inset Flex Code
27148 \begin_layout Plain Layout
27154 if an absolute path is required.
27157 \begin_layout Itemize
27159 \begin_inset Flex Code
27162 \begin_layout Plain Layout
27163 $$AbsOrRelPathMaster
27168 if the substituted string is some kind of \SpecialChar LaTeX
27172 \begin_layout Itemize
27174 \begin_inset Flex Code
27177 \begin_layout Plain Layout
27178 $$AbsOrRelPathParent
27183 in order to preserve the user's choice.
27186 \begin_layout Standard
27187 There are special cases where this rule does not work and e.
27188 \begin_inset space \thinspace{}
27192 \begin_inset space \space{}
27195 relative names are needed, but normally it will work just fine.
27196 One example for such a case is the command
27197 \begin_inset Flex Code
27200 \begin_layout Plain Layout
27201 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
27206 in the XFig template above: We can't use the absolute name because the
27208 \begin_inset Flex Code
27211 \begin_layout Plain Layout
27217 files needs the relative name in order to rewrite the file content.
27220 \begin_layout Section
27221 Security discussion
27222 \begin_inset CommandInset label
27224 name "sec:Security-discussion"
27231 \begin_layout Standard
27232 The external material feature interfaces with a lot of external programs
27233 and does so automatically, so we have to consider the security implications
27235 In particular, since you have the option of including your own filenames
27236 and/or parameter strings and those are expanded into a command, it seems
27237 that it would be possible to create a malicious document which executes
27238 arbitrary commands when a user views or prints the document.
27239 This is something we definitely want to avoid.
27242 \begin_layout Standard
27243 However, since the external program commands are specified in the template
27244 configuration file only, there are no security issues if \SpecialChar LyX
27245 is properly configure
27246 d with safe templates only.
27247 This is so because the external programs are invoked with the
27248 \begin_inset Flex Code
27251 \begin_layout Plain Layout
27257 -system call rather than the
27258 \begin_inset Flex Code
27261 \begin_layout Plain Layout
27267 system-call, so it's not possible to execute arbitrary commands from the
27268 filename or parameter section via the shell.
27271 \begin_layout Standard
27272 This also implies that you are restricted in what command strings you can
27273 use in the external material templates.
27274 In particular, pipes and redirection are not readily available.
27275 This has to be so if \SpecialChar LyX
27276 should remain safe.
27277 If you want to use some of the shell features, you should write a safe
27278 script to do this in a controlled manner, and then invoke the script from
27279 the command string.
27283 \begin_layout Standard
27284 It is possible to design a template that interacts directly with the shell,
27285 but since this would allow a malicious user to execute arbitrary commands
27286 by writing clever filenames and/or parameters, we generally recommend that
27287 you only use safe scripts that work with the
27288 \begin_inset Flex Code
27291 \begin_layout Plain Layout
27297 system call in a controlled manner.
27298 Of course, for use in a controlled environment, it can be tempting to just
27299 fall back to use ordinary shell scripts.
27300 If you do so, be aware that you
27304 provide an easily exploitable security hole in your system.
27305 Of course it stands to reason that such unsafe templates will never be
27306 included in the standard \SpecialChar LyX
27307 distribution, although we do encourage people
27308 to submit new templates in the open source tradition.
27309 But \SpecialChar LyX
27310 as shipped from the official distribution channels will never have
27314 \begin_layout Standard
27315 Including external material provides a lot of power, and you have to be
27316 careful not to introduce security hazards with this power.
27317 A subtle error in a single line in an innocent looking script can open
27318 the door to huge security problems.
27319 So if you do not fully understand the issues, we recommend that you consult
27320 a knowledgeable security professional or the \SpecialChar LyX
27321 development team if you have
27322 any questions about whether a given template is safe or not.
27323 And do this before you use it in an uncontrolled environment.
27326 \begin_layout Chapter
27328 List of supported \SpecialChar LyX
27329 functions to be used in layouts
27330 \begin_inset CommandInset label
27332 name "chap:List-of-functions"
27339 \begin_layout Standard
27341 \begin_inset Tabular
27342 <lyxtabular version="3" rows="11" columns="8">
27343 <features tabularvalignment="middle">
27344 <column alignment="left" valignment="top">
27345 <column alignment="left" valignment="top">
27346 <column alignment="left" valignment="top">
27347 <column alignment="left" valignment="top">
27348 <column alignment="left" valignment="top">
27349 <column alignment="left" valignment="top">
27350 <column alignment="left" valignment="top">
27351 <column alignment="left" valignment="top">
27353 <cell alignment="left" valignment="top" usebox="none">
27356 \begin_layout Plain Layout
27362 <cell alignment="left" valignment="top" usebox="none">
27365 \begin_layout Plain Layout
27371 <cell alignment="left" valignment="top" usebox="none">
27374 \begin_layout Plain Layout
27380 <cell alignment="left" valignment="top" usebox="none">
27383 \begin_layout Plain Layout
27389 <cell alignment="center" valignment="top" usebox="none">
27392 \begin_layout Plain Layout
27398 <cell alignment="center" valignment="top" usebox="none">
27401 \begin_layout Plain Layout
27407 <cell alignment="center" valignment="top" usebox="none">
27410 \begin_layout Plain Layout
27416 <cell alignment="center" valignment="top" usebox="none">
27419 \begin_layout Plain Layout
27427 <cell alignment="left" valignment="top" usebox="none">
27430 \begin_layout Plain Layout
27436 <cell alignment="left" valignment="top" usebox="none">
27439 \begin_layout Plain Layout
27445 <cell alignment="left" valignment="top" usebox="none">
27448 \begin_layout Plain Layout
27454 <cell alignment="left" valignment="top" usebox="none">
27457 \begin_layout Plain Layout
27463 <cell alignment="center" valignment="top" usebox="none">
27466 \begin_layout Plain Layout
27472 <cell alignment="center" valignment="top" usebox="none">
27475 \begin_layout Plain Layout
27481 <cell alignment="center" valignment="top" usebox="none">
27484 \begin_layout Plain Layout
27490 <cell alignment="center" valignment="top" usebox="none">
27493 \begin_layout Plain Layout
27501 <cell alignment="left" valignment="top" usebox="none">
27504 \begin_layout Plain Layout
27510 <cell alignment="left" valignment="top" usebox="none">
27513 \begin_layout Plain Layout
27519 <cell alignment="left" valignment="top" usebox="none">
27522 \begin_layout Plain Layout
27528 <cell alignment="left" valignment="top" usebox="none">
27531 \begin_layout Plain Layout
27537 <cell alignment="center" valignment="top" usebox="none">
27540 \begin_layout Plain Layout
27546 <cell alignment="center" valignment="top" usebox="none">
27549 \begin_layout Plain Layout
27555 <cell alignment="center" valignment="top" usebox="none">
27558 \begin_layout Plain Layout
27564 <cell alignment="center" valignment="top" usebox="none">
27567 \begin_layout Plain Layout
27575 <cell alignment="left" valignment="top" usebox="none">
27578 \begin_layout Plain Layout
27584 <cell alignment="left" valignment="top" usebox="none">
27587 \begin_layout Plain Layout
27593 <cell alignment="left" valignment="top" usebox="none">
27596 \begin_layout Plain Layout
27602 <cell alignment="left" valignment="top" usebox="none">
27605 \begin_layout Plain Layout
27611 <cell alignment="center" valignment="top" usebox="none">
27614 \begin_layout Plain Layout
27620 <cell alignment="center" valignment="top" usebox="none">
27623 \begin_layout Plain Layout
27629 <cell alignment="center" valignment="top" usebox="none">
27632 \begin_layout Plain Layout
27638 <cell alignment="center" valignment="top" usebox="none">
27641 \begin_layout Plain Layout
27649 <cell alignment="left" valignment="top" usebox="none">
27652 \begin_layout Plain Layout
27658 <cell alignment="left" valignment="top" usebox="none">
27661 \begin_layout Plain Layout
27667 <cell alignment="left" valignment="top" usebox="none">
27670 \begin_layout Plain Layout
27676 <cell alignment="left" valignment="top" usebox="none">
27679 \begin_layout Plain Layout
27685 <cell alignment="center" valignment="top" usebox="none">
27688 \begin_layout Plain Layout
27694 <cell alignment="center" valignment="top" usebox="none">
27697 \begin_layout Plain Layout
27703 <cell alignment="center" valignment="top" usebox="none">
27706 \begin_layout Plain Layout
27712 <cell alignment="center" valignment="top" usebox="none">
27715 \begin_layout Plain Layout
27723 <cell alignment="left" valignment="top" usebox="none">
27726 \begin_layout Plain Layout
27732 <cell alignment="left" valignment="top" usebox="none">
27735 \begin_layout Plain Layout
27741 <cell alignment="left" valignment="top" usebox="none">
27744 \begin_layout Plain Layout
27750 <cell alignment="left" valignment="top" usebox="none">
27753 \begin_layout Plain Layout
27759 <cell alignment="center" valignment="top" usebox="none">
27762 \begin_layout Plain Layout
27768 <cell alignment="center" valignment="top" usebox="none">
27771 \begin_layout Plain Layout
27777 <cell alignment="center" valignment="top" usebox="none">
27780 \begin_layout Plain Layout
27786 <cell alignment="center" valignment="top" usebox="none">
27789 \begin_layout Plain Layout
27797 <cell alignment="left" valignment="top" usebox="none">
27800 \begin_layout Plain Layout
27806 <cell alignment="left" valignment="top" usebox="none">
27809 \begin_layout Plain Layout
27815 <cell alignment="left" valignment="top" usebox="none">
27818 \begin_layout Plain Layout
27824 <cell alignment="left" valignment="top" usebox="none">
27827 \begin_layout Plain Layout
27833 <cell alignment="center" valignment="top" usebox="none">
27836 \begin_layout Plain Layout
27842 <cell alignment="center" valignment="top" usebox="none">
27845 \begin_layout Plain Layout
27851 <cell alignment="center" valignment="top" usebox="none">
27854 \begin_layout Plain Layout
27860 <cell alignment="center" valignment="top" usebox="none">
27863 \begin_layout Plain Layout
27871 <cell alignment="left" valignment="top" usebox="none">
27874 \begin_layout Plain Layout
27880 <cell alignment="left" valignment="top" usebox="none">
27883 \begin_layout Plain Layout
27889 <cell alignment="left" valignment="top" usebox="none">
27892 \begin_layout Plain Layout
27898 <cell alignment="left" valignment="top" usebox="none">
27901 \begin_layout Plain Layout
27907 <cell alignment="center" valignment="top" usebox="none">
27910 \begin_layout Plain Layout
27916 <cell alignment="center" valignment="top" usebox="none">
27919 \begin_layout Plain Layout
27925 <cell alignment="center" valignment="top" usebox="none">
27928 \begin_layout Plain Layout
27934 <cell alignment="center" valignment="top" usebox="none">
27937 \begin_layout Plain Layout
27945 <cell alignment="left" valignment="top" usebox="none">
27948 \begin_layout Plain Layout
27954 <cell alignment="left" valignment="top" usebox="none">
27957 \begin_layout Plain Layout
27963 <cell alignment="left" valignment="top" usebox="none">
27966 \begin_layout Plain Layout
27972 <cell alignment="left" valignment="top" usebox="none">
27975 \begin_layout Plain Layout
27981 <cell alignment="center" valignment="top" usebox="none">
27984 \begin_layout Plain Layout
27990 <cell alignment="center" valignment="top" usebox="none">
27993 \begin_layout Plain Layout
27999 <cell alignment="center" valignment="top" usebox="none">
28002 \begin_layout Plain Layout
28008 <cell alignment="center" valignment="top" usebox="none">
28011 \begin_layout Plain Layout
28019 <cell alignment="left" valignment="top" usebox="none">
28022 \begin_layout Plain Layout
28028 <cell alignment="left" valignment="top" usebox="none">
28031 \begin_layout Plain Layout
28037 <cell alignment="left" valignment="top" usebox="none">
28040 \begin_layout Plain Layout
28046 <cell alignment="left" valignment="top" usebox="none">
28049 \begin_layout Plain Layout
28055 <cell alignment="center" valignment="top" usebox="none">
28058 \begin_layout Plain Layout
28064 <cell alignment="center" valignment="top" usebox="none">
28067 \begin_layout Plain Layout
28073 <cell alignment="center" valignment="top" usebox="none">
28076 \begin_layout Plain Layout
28082 <cell alignment="center" valignment="top" usebox="none">
28085 \begin_layout Plain Layout
28093 <cell alignment="center" valignment="top" usebox="none">
28096 \begin_layout Plain Layout
28102 <cell alignment="center" valignment="top" usebox="none">
28105 \begin_layout Plain Layout
28111 <cell alignment="center" valignment="top" usebox="none">
28114 \begin_layout Plain Layout
28120 <cell alignment="center" valignment="top" usebox="none">
28123 \begin_layout Plain Layout
28129 <cell alignment="center" valignment="top" usebox="none">
28132 \begin_layout Plain Layout
28138 <cell alignment="center" valignment="top" usebox="none">
28141 \begin_layout Plain Layout
28147 <cell alignment="center" valignment="top" usebox="none">
28150 \begin_layout Plain Layout
28156 <cell alignment="center" valignment="top" usebox="none">
28159 \begin_layout Plain Layout
28173 \begin_layout Chapter
28174 Names of available colors to be used in layouts
28175 \begin_inset CommandInset label
28177 name "chap:Names-of-colors"
28184 \begin_layout Standard
28185 The colors listed below are the standard colors and those that you can adjust
28186 in the \SpecialChar LyX
28190 \begin_layout Section
28194 \begin_layout Standard
28195 The following are no real colors, but rather act on color definitions:
28198 \begin_layout Description
28199 ignore The color is ignored
28202 \begin_layout Description
28203 inherit The color is inherited
28206 \begin_layout Description
28219 No particular color – clear or default
28222 \begin_layout Section
28226 \begin_layout Standard
28227 These are fixed colors that cannot me customized:
28230 \begin_layout Description
28234 \begin_layout Description
28238 \begin_layout Description
28242 \begin_layout Description
28246 \begin_layout Description
28250 \begin_layout Description
28254 \begin_layout Description
28258 \begin_layout Description
28262 \begin_layout Description
28266 \begin_layout Description
28270 \begin_layout Description
28274 \begin_layout Description
28278 \begin_layout Description
28282 \begin_layout Description
28286 \begin_layout Description
28290 \begin_layout Description
28294 \begin_layout Description
28298 \begin_layout Description
28302 \begin_layout Description
28306 \begin_layout Section
28310 \begin_layout Standard
28311 These are the colors allocated to specific elements in
28314 arg "dialog-show prefs"
28320 \begin_layout Description
28321 added_space Added space color
28324 \begin_layout Description
28325 addedtext Added text color
28328 \begin_layout Description
28329 appendix Appendix marker color
28332 \begin_layout Description
28333 background Background color
28336 \begin_layout Description
28337 bottomarea Bottom area color
28340 \begin_layout Description
28341 branchlabel Label color for branches
28344 \begin_layout Description
28345 buttonbg Color used for button background
28348 \begin_layout Description
28349 buttonframe Color for inset button frames
28352 \begin_layout Description
28353 buttonhoverbg Color used for button background under focus
28356 \begin_layout Description
28357 changebar Changebar color
28360 \begin_layout Description
28361 changedtextauthor1 Changed text color author 1
28364 \begin_layout Description
28365 changedtextauthor2 Changed text color author 2
28368 \begin_layout Description
28369 changedtextauthor3 Changed text color author 3
28372 \begin_layout Description
28373 changedtextauthor4 Changed text color author 4
28376 \begin_layout Description
28377 changedtextauthor5 Changed text color author 5
28380 \begin_layout Description
28381 collapsible Collapsible insets text color
28384 \begin_layout Description
28385 collapsibleframe Collapsible insets framecolor
28388 \begin_layout Description
28389 command Text color for command insets
28392 \begin_layout Description
28393 commandbg Background color for command insets
28396 \begin_layout Description
28397 commandframe Frame color for command insets
28400 \begin_layout Description
28401 comment Label color for comments
28404 \begin_layout Description
28405 commentbg Background color of comments
28408 \begin_layout Description
28409 cursor Cursor color
28412 \begin_layout Description
28413 deletedtext Deleted text color
28416 \begin_layout Description
28417 deletedtextmodifier Deleted text modifying color
28420 \begin_layout Description
28421 depthbar Color for the depth bars in the margin
28424 \begin_layout Description
28425 eolmarker End of line marker color
28428 \begin_layout Description
28429 error Color of the \SpecialChar LaTeX
28433 \begin_layout Description
28434 footlabel Label color for footnotes
28437 \begin_layout Description
28438 foreground Foreground color
28441 \begin_layout Description
28442 graphicsbg Graphics inset background color
28445 \begin_layout Description
28446 greyedoutbg Background color of greyedout inset
28449 \begin_layout Description
28450 greyedoutlabel Label color for greyedout insets
28453 \begin_layout Description
28454 greyedouttext Color for greyedout inset text
28457 \begin_layout Description
28458 indexlabel Label color for index insets
28461 \begin_layout Description
28462 inlinecompletion Inline completion color
28465 \begin_layout Description
28466 insetbg Inset marker background color
28469 \begin_layout Description
28470 insetframe Inset marker frame color
28473 \begin_layout Description
28474 language Color for marking foreign language words
28477 \begin_layout Description
28478 latex Text color in \SpecialChar LaTeX
28482 \begin_layout Description
28483 listingsbg Background color of listings inset
28486 \begin_layout Description
28487 marginlabel Label color for margin notes
28490 \begin_layout Description
28491 math Math inset text color
28494 \begin_layout Description
28495 mathbg Math inset background color
28498 \begin_layout Description
28499 mathcorners Math inset frame color not under focus
28502 \begin_layout Description
28503 mathframe Math inset frame color under focus
28506 \begin_layout Description
28507 mathline Math line color
28510 \begin_layout Description
28511 mathmacrobg Macro math inset background color
28514 \begin_layout Description
28515 mathmacroblend Macro math blended color
28518 \begin_layout Description
28519 mathmacroframe Macro math frame color
28522 \begin_layout Description
28523 mathmacrohoverbg Macro math inset background color hovered
28526 \begin_layout Description
28527 mathmacrolabel Macro math label color
28530 \begin_layout Description
28531 mathmacronewarg Macro template color for new parameters
28534 \begin_layout Description
28535 mathmacrooldarg Macro template color for old parameters
28538 \begin_layout Description
28539 newpage New page color
28542 \begin_layout Description
28543 nonunique_inlinecompletion Inline completion color for the non-unique part
28546 \begin_layout Description
28547 note Label color for notes
28550 \begin_layout Description
28551 notebg Background color of notes
28554 \begin_layout Description
28555 pagebreak Page break/line break color
28558 \begin_layout Description
28559 paragraphmarker Color used for the pilcrow sign to mark the end of a paragraph
28562 \begin_layout Description
28563 phantomtext Text color for phantom insets
28566 \begin_layout Description
28567 preview The color used for previews
28570 \begin_layout Description
28571 previewframe Preview frame color
28574 \begin_layout Description
28575 regexpframe Color for regexp frame
28578 \begin_layout Description
28579 scroll Color that indicates when a row can be scrolled
28582 \begin_layout Description
28583 selection Background color of selected text
28586 \begin_layout Description
28587 selectiontext Foreground color of selected text
28590 \begin_layout Description
28591 shadedbg Background color of shaded box
28594 \begin_layout Description
28595 special Special chars text color
28598 \begin_layout Description
28599 tabularline Table line color
28602 \begin_layout Description
28603 tabularonoffline Table line color
28606 \begin_layout Description
28607 urllabel Label color for URL insets
28610 \begin_layout Description
28611 urltext Color for URL inset text