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 0
86 \use_package amssymb 0
89 \use_package mathdots 1
90 \use_package mathtools 0
92 \use_package stackrel 0
93 \use_package stmaryrd 0
94 \use_package undertilde 0
96 \cite_engine_type default
100 \paperorientation portrait
105 \notefontcolor #0000ff
117 \paragraph_separation indent
118 \paragraph_indentation default
120 \math_indentation default
121 \math_numbering_side default
122 \quotes_style english
126 \paperpagestyle headings
127 \tracking_changes true
128 \output_changes false
132 \author -712698321 "Jürgen Spitzmüller"
138 Customizing \SpecialChar LyX
139 : Features for the Advanced User
143 by the \SpecialChar LyX
148 \begin_layout Plain Layout
150 If you have comments or error corrections, please send them to the \SpecialChar LyX
153 \begin_inset CommandInset href
155 target "lyx-docs@lists.lyx.org"
163 \begin_inset Quotes eld
167 \begin_inset Quotes erd
170 in the subject header, and please cc the current maintainer of this file,
171 Richard Heck <rgheck@comcast.net>.
177 \begin_inset Newline newline
181 \begin_inset Newline newline
187 \begin_layout Standard
188 \begin_inset CommandInset toc
189 LatexCommand tableofcontents
196 \begin_layout Standard
197 \begin_inset Note Note
200 \begin_layout Plain Layout
201 Please use change tracking when modifying this document.
202 This makes it easier for our translators to recognize things that have
203 been changed, and it helps the maintainer keep up-to-date with what's been
212 \begin_layout Chapter
216 \begin_layout Standard
217 This manual covers the customization features present in \SpecialChar LyX
219 In it, we discuss issues like keyboard shortcuts, screen previewing options,
220 printer options, sending commands to \SpecialChar LyX
221 via the \SpecialChar LyX
222 Server, internationalization,
223 installing new \SpecialChar LaTeX
224 classes and \SpecialChar LyX
226 We can't possibly hope to touch on everything you can change—our developers
227 add new features faster than we can document them—but we will explain the
228 most common customizations and hopefully point you in the right direction
229 for some of the more obscure ones.
232 \begin_layout Standard
233 \begin_inset Branch OutDated
237 \begin_layout Standard
238 Information from previous versions of this document that now seems to be
239 outdated is contained in the OutDated branch of this document.
240 By default, this information will not appear in the \SpecialChar LaTeX
249 \begin_layout Chapter
254 \begin_layout Standard
255 This chapter aims to help you to find your way through the \SpecialChar LyX
258 Before continuing to read this chapter, you should find out where your
260 library and user directories are by using
261 \begin_inset Flex Noun
264 \begin_layout Plain Layout
265 Help\SpecialChar menuseparator
276 The library directory is the place where \SpecialChar LyX
277 places its system-wide configuration
278 files; the user directory is where you can place your modified versions.
279 We will call the former
280 \begin_inset Flex Code
283 \begin_layout Plain Layout
290 \begin_inset Flex Noun
293 \begin_layout Plain Layout
299 in the remainder of this document.
303 \begin_layout Section
305 \begin_inset Flex Code
308 \begin_layout Plain Layout
317 \begin_layout Standard
318 \begin_inset Flex Code
321 \begin_layout Plain Layout
327 and its sub-directories contain a number of files and that can be used
328 to customize \SpecialChar LyX
330 You can change many of these files from within \SpecialChar LyX
332 \begin_inset Flex Noun
335 \begin_layout Plain Layout
336 Tools\SpecialChar menuseparator
343 Most customization that you will want to do in \SpecialChar LyX
344 is possible through this
346 However, many other inner aspects of \SpecialChar LyX
347 can be customized by modifying the
349 \begin_inset Flex Code
352 \begin_layout Plain Layout
359 These files fall in different categories, described in the following subsection
363 \begin_layout Subsection
364 Automatically generated files
367 \begin_layout Standard
368 The files, which are to be found in
369 \begin_inset Flex Noun
372 \begin_layout Plain Layout
378 , are generated when you configure \SpecialChar LyX
380 They contain various default values that are guessed by inspection.
381 In general, it is not a good idea to modify them, since they might be overwritt
385 \begin_layout Labeling
386 \labelwidthstring 00.00.0000
387 \begin_inset Flex Code
390 \begin_layout Plain Layout
396 contains defaults for various commands.
399 \begin_layout Labeling
400 \labelwidthstring 00.00.0000
401 \begin_inset Flex Code
404 \begin_layout Plain Layout
410 contains the list of packages that have been recognized by \SpecialChar LyX
412 It is currently unused by the \SpecialChar LyX
413 program itself, but the information extracted,
414 and more, is made available with
415 \begin_inset Flex Noun
418 \begin_layout Plain Layout
419 Help\SpecialChar menuseparator
433 \begin_layout Labeling
434 \labelwidthstring 00.00.0000
435 \begin_inset Flex Code
438 \begin_layout Plain Layout
444 the list of text classes that have been found in your
445 \begin_inset Flex Code
448 \begin_layout Plain Layout
454 directories, along with the associated \SpecialChar LaTeX
455 document class and their description.
458 \begin_layout Labeling
459 \labelwidthstring 00.00.0000
460 \begin_inset Flex Code
463 \begin_layout Plain Layout
469 the list of layout modules found in your
470 \begin_inset Flex Code
473 \begin_layout Plain Layout
482 \begin_layout Labeling
483 \labelwidthstring 00.00.0000
484 \begin_inset Flex Code
487 \begin_layout Plain Layout
493 lists of various sorts of \SpecialChar LaTeX
494 -related files found on your system
497 \begin_layout Labeling
498 \labelwidthstring 00.00.0000
499 \begin_inset Flex Code
502 \begin_layout Plain Layout
503 doc/\SpecialChar LaTeX
509 is automatically generated during configuration from the file
510 \begin_inset Flex Code
513 \begin_layout Plain Layout
521 It contains information on your \SpecialChar LaTeX
525 \begin_layout Subsection
529 \begin_layout Standard
530 These directories are duplicated between
531 \begin_inset Flex Code
534 \begin_layout Plain Layout
541 \begin_inset Flex Code
544 \begin_layout Plain Layout
551 If a particular files exists in both places, the one in
552 \begin_inset Flex Code
555 \begin_layout Plain Layout
564 \begin_layout Labeling
565 \labelwidthstring 00.00.0000
566 \begin_inset Flex Code
569 \begin_layout Plain Layout
575 this directory contains files with the extension
576 \begin_inset Flex Code
579 \begin_layout Plain Layout
585 that define the keybindings used in \SpecialChar LyX
587 If there exists an internationalized version of the bind file named
588 \begin_inset Flex Code
591 \begin_layout Plain Layout
597 , that will be used first.
600 \begin_layout Labeling
601 \labelwidthstring 00.00.0000
602 \begin_inset Flex Code
605 \begin_layout Plain Layout
611 contains files with the extension
612 \begin_inset Flex Code
615 \begin_layout Plain Layout
621 which define the diverse citation possibilities (natbib, biblatex etc.).
623 \begin_inset CommandInset ref
625 reference "subsec:Cite-Engine-Files"
635 \begin_layout Labeling
636 \labelwidthstring 00.00.0000
637 \begin_inset Flex Code
640 \begin_layout Plain Layout
646 contains graphics files that can be included in documents.
650 \begin_layout Labeling
651 \labelwidthstring 00.00.0000
652 \begin_inset Flex Code
655 \begin_layout Plain Layout
661 contains \SpecialChar LyX
662 documentation files (including the one you are currently reading).
664 \begin_inset Flex Code
667 \begin_layout Plain Layout
674 deserves special attention, as noted above.
675 The internationalized help docs are in subdirectories
676 \begin_inset Flex Code
679 \begin_layout Plain Layout
686 \begin_inset Quotes eld
690 \begin_inset Quotes erd
693 is the ISO language code.
695 \begin_inset CommandInset ref
697 reference "cha:Internationalizing-LyX"
704 \begin_layout Labeling
705 \labelwidthstring 00.00.0000
706 \begin_inset Flex Code
709 \begin_layout Plain Layout
715 contains example files that explain how to use some features.
716 In the file browser, press the
717 \begin_inset Flex Noun
720 \begin_layout Plain Layout
729 \begin_layout Labeling
730 \labelwidthstring 00.00.0000
731 \begin_inset Flex Code
734 \begin_layout Plain Layout
740 contains image files that are used by the
741 \begin_inset Flex Noun
744 \begin_layout Plain Layout
751 In addition, it also contains the individual icons used in the toolbar
752 and the banners that can be shown when \SpecialChar LyX
756 \begin_layout Labeling
757 \labelwidthstring 00.00.0000
758 \begin_inset Flex Code
761 \begin_layout Plain Layout
767 contains keyboard keymapping files.
769 \begin_inset CommandInset ref
771 reference "sec:International-Keymap-Stuff"
778 \begin_layout Labeling
779 \labelwidthstring 00.00.0000
780 \begin_inset Flex Code
783 \begin_layout Plain Layout
789 contains the text class and module files described in
790 \begin_inset CommandInset ref
792 reference "cha:Installing-New-Document"
799 \begin_layout Labeling
800 \labelwidthstring 00.00.0000
801 \begin_inset Flex Code
804 \begin_layout Plain Layout
811 \begin_inset Flex Code
814 \begin_layout Plain Layout
820 Python scripts used to convert between \SpecialChar LyX
822 These can be run from the command line if, say, you want to batch-convert
826 \begin_layout Labeling
827 \labelwidthstring 00.00.0000
828 \begin_inset Flex Code
831 \begin_layout Plain Layout
837 contains some files that demonstrate the capabilities of the
838 \begin_inset Flex Noun
841 \begin_layout Plain Layout
852 Also contains some scripts used by \SpecialChar LyX
856 \begin_layout Labeling
857 \labelwidthstring 00.00.0000
858 \begin_inset Flex Code
861 \begin_layout Plain Layout
867 contains the standard \SpecialChar LyX
868 template files described in
869 \begin_inset CommandInset ref
871 reference "subsec:Creating-Templates"
878 \begin_layout Labeling
879 \labelwidthstring 00.00.0000
880 \begin_inset Flex Code
883 \begin_layout Plain Layout
889 contains files with the extension
890 \begin_inset Flex Code
893 \begin_layout Plain Layout
899 that define the user interface to \SpecialChar LyX
901 That is, the files define which items appear in which menus and the items
902 appearing on the toolbar.
905 \begin_layout Labeling
906 \labelwidthstring 00.00.0000
907 \begin_inset Flex Code
910 \begin_layout Plain Layout
916 contains files with the extension
917 \begin_inset Flex Code
920 \begin_layout Plain Layout
926 which define the templates for the insertion of external material to a
929 \begin_inset CommandInset ref
931 reference "chap:Including-External-Material"
938 \begin_layout Subsection
939 Files you don't want to modify
942 \begin_layout Standard
943 These files are used internally by \SpecialChar LyX
944 and you generally do not need to modify
945 them unless you are a developer.
948 \begin_layout Labeling
949 \labelwidthstring 00.00.0000
950 \begin_inset Flex Code
953 \begin_layout Plain Layout
959 this file contains the list of \SpecialChar LyX
961 The contents are displayed with the menu entry
962 \begin_inset Flex Noun
965 \begin_layout Plain Layout
966 Help\SpecialChar menuseparator
979 \begin_layout Labeling
980 \labelwidthstring 00.00.0000
981 \begin_inset Flex Code
984 \begin_layout Plain Layout
990 this is a \SpecialChar LaTeX
991 script used during the configuration process.
995 \begin_layout Labeling
996 \labelwidthstring 00.00.0000
997 \begin_inset Flex Code
1000 \begin_layout Plain Layout
1006 this is a Python script that is used to re-configure \SpecialChar LyX
1008 It creates configuration files in the directory it was run from.
1011 \begin_layout Subsection
1012 Other files needing a line or two
1015 \begin_layout Labeling
1016 \labelwidthstring 00.00.0000
1017 \begin_inset Flex Code
1020 \begin_layout Plain Layout
1026 this contains tables describing how different character encodings can be
1030 \begin_layout Labeling
1031 \labelwidthstring 00.00.0000
1032 \begin_inset Flex Code
1035 \begin_layout Plain Layout
1041 this file contains a list of all the languages currently supported by \SpecialChar LyX
1045 \begin_layout Labeling
1046 \labelwidthstring 00.00.0000
1047 \begin_inset Flex Code
1050 \begin_layout Plain Layout
1056 contains information about the supported fonts.
1059 \begin_layout Labeling
1060 \labelwidthstring 00.00.0000
1061 \begin_inset Flex Code
1064 \begin_layout Plain Layout
1070 this file contains translations for internationalized paragraph styles
1072 \begin_inset CommandInset ref
1074 reference "subsec:I18n"
1081 \begin_layout Labeling
1082 \labelwidthstring 00.00.0000
1083 \begin_inset Flex Code
1086 \begin_layout Plain Layout
1092 this file contains information about unicode-encoded glyphs and the way
1093 they are supported by \SpecialChar LyX
1094 via \SpecialChar LaTeX
1098 \begin_layout Section
1099 Your local configuration directory
1102 \begin_layout Standard
1103 Even if you are using \SpecialChar LyX
1104 as an unprivileged user, you might want to change
1106 configuration for your own use.
1108 \begin_inset Flex Code
1111 \begin_layout Plain Layout
1117 directory contains all your personal configuration files.
1118 This is the directory described as
1119 \begin_inset Quotes eld
1123 \begin_inset Quotes erd
1127 \begin_inset Flex Noun
1130 \begin_layout Plain Layout
1131 Help\SpecialChar menuseparator
1133 \begin_inset space ~
1142 This directory is used as a mirror of
1143 \begin_inset Flex Code
1146 \begin_layout Plain Layout
1152 , which means that every file in
1153 \begin_inset Flex Code
1156 \begin_layout Plain Layout
1162 is a replacement for the corresponding file in
1163 \begin_inset Flex Code
1166 \begin_layout Plain Layout
1173 Any configuration file described in the above sections can be placed either
1174 in the system-wide directory, in which case it will affect all users, or
1175 in your local directory for your own use.
1178 \begin_layout Standard
1179 To make things clearer, let's provide a few examples:
1182 \begin_layout Itemize
1183 The preferences set in the
1184 \begin_inset Flex Noun
1187 \begin_layout Plain Layout
1188 Tools\SpecialChar menuseparator
1194 dialog are saved to a file
1195 \begin_inset Flex Code
1198 \begin_layout Plain Layout
1205 \begin_inset Flex Code
1208 \begin_layout Plain Layout
1217 \begin_layout Itemize
1218 When you reconfigure using
1219 \begin_inset Flex Noun
1222 \begin_layout Plain Layout
1223 Tools\SpecialChar menuseparator
1231 \begin_inset Flex Code
1234 \begin_layout Plain Layout
1240 script, and the resulting files are written in your local configuration
1242 This means that any additional text class file that you might have added
1244 \begin_inset Flex Code
1247 \begin_layout Plain Layout
1253 will be added to the list of classes in the
1254 \begin_inset Flex Noun
1257 \begin_layout Plain Layout
1258 Document\SpecialChar menuseparator
1267 \begin_layout Itemize
1268 If you get some updated documentation from \SpecialChar LyX
1269 ftp site and cannot install
1270 it because you do not have sysadmin rights on your system, you can just
1272 \begin_inset Flex Code
1275 \begin_layout Plain Layout
1281 and the items in the
1282 \begin_inset Flex Noun
1285 \begin_layout Plain Layout
1291 menu will open them!
1294 \begin_layout Section
1295 Running \SpecialChar LyX
1296 with multiple configurations
1299 \begin_layout Standard
1300 The configuration freedom of the local configuration directory may not suffice
1301 if you want to have more than one configuration at your disposal.
1302 For example, you may want to be use different key bindings or printer settings
1304 You can achieve this by having several such directories.
1305 You then specify which directory to use at run-time.
1308 \begin_layout Standard
1309 Invoking \SpecialChar LyX
1310 with the command line switch
1311 \begin_inset Flex Code
1314 \begin_layout Plain Layout
1324 instructs the program to read the configuration from that directory, and
1325 not from the default directory.
1326 (You can determine the default directory by running \SpecialChar LyX
1328 \begin_inset Flex Code
1331 \begin_layout Plain Layout
1337 switch.) If the specified directory does not exist, \SpecialChar LyX
1339 for you, just like it does for the default directory on the first time
1340 you run the program.
1341 You can modify the configuration options in this additional user directory
1342 exactly as you would for the default directory.
1343 These directories are completely independent (but read on).
1344 Note that setting the environment variable
1345 \begin_inset Flex Code
1348 \begin_layout Plain Layout
1354 to some value has exactly the same effect.
1357 \begin_layout Standard
1358 Having several configurations also requires more maintenance: if you want
1359 to add a new layout to
1360 \begin_inset Flex Code
1363 \begin_layout Plain Layout
1369 which you want available from all your configurations, you must add it
1370 to each directory separately.
1371 You can avoid this with the following trick: after \SpecialChar LyX
1372 creates the additional
1373 directory, most of the subdirectories (see above) are empty.
1374 If you want the new configuration to mirror an existing one, replace the
1375 empty subdirectory with a symbolic link to the matching subdirectory in
1376 the existing configuration.
1378 \begin_inset Flex Code
1381 \begin_layout Plain Layout
1387 subdirectory, however, since it contains a file written by the configuration
1388 script (also accessible through
1389 \begin_inset Flex Noun
1392 \begin_layout Plain Layout
1393 Tools\SpecialChar menuseparator
1399 ) which is configuration-specific.
1402 \begin_layout Chapter
1403 The Preferences dialog
1406 \begin_layout Standard
1407 All options of the preferences dialog are described in the Appendix
1409 The Preferences Dialog
1416 For some options you might find here more details.
1419 \begin_layout Section
1421 \begin_inset CommandInset label
1430 \begin_layout Standard
1431 The first step is to define your file formats if they are not already defined.
1433 \begin_inset Flex Noun
1436 \begin_layout Plain Layout
1437 Tools\SpecialChar menuseparator
1445 \begin_inset Flex Noun
1448 \begin_layout Plain Layout
1449 File Handling\SpecialChar menuseparator
1456 \begin_inset Flex Noun
1459 \begin_layout Plain Layout
1465 button to define your new format.
1467 \begin_inset Flex Noun
1470 \begin_layout Plain Layout
1476 field contains the name used to identify the format in the GUI.
1478 \begin_inset Flex Noun
1481 \begin_layout Plain Layout
1487 is used to identify the format internally.
1488 You will also need to enter a file extension.
1489 These are all required.
1491 \begin_inset Flex Noun
1494 \begin_layout Plain Layout
1500 field is used to provide a keyboard shortcut on the menus.
1501 (For example, pressing
1502 \begin_inset Flex Noun
1505 \begin_layout Plain Layout
1512 \begin_inset Flex Noun
1515 \begin_layout Plain Layout
1516 Document\SpecialChar menuseparator
1517 View (Other Formats)\SpecialChar menuseparator
1526 \begin_layout Standard
1528 \begin_inset Flex Noun
1531 \begin_layout Plain Layout
1538 \begin_inset Flex Noun
1541 \begin_layout Plain Layout
1548 For example, you might want to use
1549 \begin_inset Flex Noun
1552 \begin_layout Plain Layout
1558 to view PostScript files.
1559 You can enter the command needed to start the program in the corresponding
1561 In defining this command, you can use the four variables listed in the
1563 The viewer is launched when you view an image in \SpecialChar LyX
1565 \begin_inset Flex Noun
1568 \begin_layout Plain Layout
1569 Document\SpecialChar menuseparator
1576 The editor is for example launched when you right-click on an image and
1578 \begin_inset Flex Noun
1581 \begin_layout Plain Layout
1587 in the appearing context menu.
1590 \begin_layout Standard
1592 \begin_inset Flex Noun
1595 \begin_layout Plain Layout
1601 type of a format is optional, but if it is specified, it must be unique
1603 It is used to detect files of this format from the file contents.
1604 For some important file formats there is no MIME type officially registered
1606 \begin_inset CommandInset href
1609 target "http://www.iana.org/assignments/media-types/"
1615 Therefore \SpecialChar LyX
1616 uses the extended list of MIME types as specified by
1617 \begin_inset CommandInset href
1619 name "freedesktop.org"
1620 target "http://www.freedesktop.org/wiki/Specifications/shared-mime-info-spec"
1628 \begin_layout Standard
1630 \begin_inset Flex Noun
1633 \begin_layout Plain Layout
1639 option tells \SpecialChar LyX
1640 that a format is suitable for document export.
1641 If this is set and if a suitable conversion route exists (see
1642 \begin_inset CommandInset ref
1644 reference "sec:Converters"
1648 ), the format will appear in the
1649 \begin_inset Flex Noun
1652 \begin_layout Plain Layout
1653 File\SpecialChar menuseparator
1660 The format will also appear in the
1661 \begin_inset Flex Noun
1664 \begin_layout Plain Layout
1665 Document\SpecialChar menuseparator
1671 menu if a viewer is specified for the format.
1672 Pure image formats, such as
1673 \begin_inset Flex Code
1676 \begin_layout Plain Layout
1682 , should not use this option.
1683 Formats that can both represent vector graphics and documents like
1684 \begin_inset Flex Code
1687 \begin_layout Plain Layout
1696 \begin_layout Standard
1698 \begin_inset Flex Noun
1701 \begin_layout Plain Layout
1702 Vector graphics format
1707 tells \SpecialChar LyX
1708 that a format can contain vector graphics.
1709 This information is used to determine the target format of included graphics
1711 \begin_inset Flex Noun
1714 \begin_layout Plain Layout
1721 Included graphics may need to be converted to either
1722 \begin_inset Flex Noun
1725 \begin_layout Plain Layout
1732 \begin_inset Flex Noun
1735 \begin_layout Plain Layout
1742 \begin_inset Flex Noun
1745 \begin_layout Plain Layout
1752 \begin_inset Flex Noun
1755 \begin_layout Plain Layout
1761 cannot handle other image formats.
1762 If an included graphic is not already in
1763 \begin_inset Flex Noun
1766 \begin_layout Plain Layout
1773 \begin_inset Flex Noun
1776 \begin_layout Plain Layout
1783 \begin_inset Flex Noun
1786 \begin_layout Plain Layout
1792 format, it is converted to
1793 \begin_inset Flex Noun
1796 \begin_layout Plain Layout
1802 if the vector format option is set, and otherwise to
1803 \begin_inset Flex Noun
1806 \begin_layout Plain Layout
1815 \begin_layout Section
1819 \begin_layout Standard
1820 Since all conversions from one format to another take place in \SpecialChar LyX
1822 directory, it is sometimes necessary to modify a file before copying it
1823 to the temporary directory in order that the conversion may be performed.
1827 \begin_layout Plain Layout
1828 For example, the file may refer to other files—images, for example—using
1829 relative file names, and these may become invalid when the file is copied
1830 to the temporary directory.
1835 This is done by a Copier: It copies a file to (or from) the temporary directory
1836 and may modify it in the process.
1839 \begin_layout Standard
1840 The definitions of the copiers may use eight variables:
1843 \begin_layout Labeling
1844 \labelwidthstring 00.00.0000
1845 \begin_inset Flex Code
1848 \begin_layout Plain Layout
1854 The \SpecialChar LyX
1855 system directory (e.
1856 \begin_inset space \thinspace{}
1860 \begin_inset space \space{}
1864 \begin_inset Flex Noun
1867 \begin_layout Plain Layout
1876 \begin_layout Labeling
1877 \labelwidthstring 00.00.0000
1878 \begin_inset Flex Code
1881 \begin_layout Plain Layout
1890 \begin_layout Labeling
1891 \labelwidthstring 00.00.0000
1892 \begin_inset Flex Code
1895 \begin_layout Plain Layout
1904 \begin_layout Labeling
1905 \labelwidthstring 00.00.0000
1906 \begin_inset Flex Code
1909 \begin_layout Plain Layout
1915 The base name (without filename extension) in the \SpecialChar LyX
1919 \begin_layout Labeling
1920 \labelwidthstring 00.00.0000
1921 \begin_inset Flex Code
1924 \begin_layout Plain Layout
1930 The full directory path of the \SpecialChar LyX
1934 \begin_layout Labeling
1935 \labelwidthstring 00.00.0000
1936 \begin_inset Flex Code
1939 \begin_layout Plain Layout
1945 The full pathname to the original \SpecialChar LyX
1946 file being processed
1949 \begin_layout Labeling
1950 \labelwidthstring 00.00.0000
1951 \begin_inset Flex Code
1954 \begin_layout Plain Layout
1960 The filename (without any directory path) of the \SpecialChar LyX
1964 \begin_layout Labeling
1965 \labelwidthstring 00.00.0000
1966 \begin_inset Flex Code
1969 \begin_layout Plain Layout
1975 The `\SpecialChar LaTeX
1979 \begin_layout Standard
1980 The latter should be the filename as it would be used in a \SpecialChar LaTeX
1988 It is relevant only when exporting files suitable for such inclusion.
1991 \begin_layout Standard
1992 Copiers can be used to do almost anything with output files.
1993 For example, suppose you want generated pdf files to be copied to a special
1995 \begin_inset Flex Code
1998 \begin_layout Plain Layout
2005 Then you could write a shell script such as this one:
2008 \begin_layout Standard
2009 \begin_inset listings
2013 \begin_layout Plain Layout
2018 \begin_layout Plain Layout
2023 \begin_layout Plain Layout
2025 TOFILE=`basename $2`
2028 \begin_layout Plain Layout
2030 cp $FROMFILE /home/you/pdf/$TOFILE
2035 Save it in your local \SpecialChar LyX
2037 \begin_inset Flex Code
2040 \begin_layout Plain Layout
2041 /home/you/.lyx/scripts/pdfcopier.sh
2046 —and make it executable, if you need to do so on your platform.
2048 \begin_inset Flex Noun
2051 \begin_layout Plain Layout
2052 Tools\SpecialChar menuseparator
2058 dialog, select under
2059 \begin_inset Flex Noun
2062 \begin_layout Plain Layout
2063 File Handling\SpecialChar menuseparator
2070 \begin_inset Flex Noun
2073 \begin_layout Plain Layout
2079 format—or one of the other pdf formats—and enter
2080 \begin_inset Flex Code
2083 \begin_layout Plain Layout
2084 pdfcopier.sh $$i $$o
2090 \begin_inset Flex Noun
2093 \begin_layout Plain Layout
2103 \begin_layout Standard
2104 Copiers are used by \SpecialChar LyX
2105 in various of its own conversions.
2106 For example, if appropriate programs are found, \SpecialChar LyX
2107 will automatically install
2109 \begin_inset Flex Noun
2112 \begin_layout Plain Layout
2119 \begin_inset Flex Noun
2122 \begin_layout Plain Layout
2124 \begin_inset space ~
2133 When these formats are exported, the copier sees that not just the main
2134 HTML file but various associated files (style files, images, etc.) are also
2136 All these files are written to a subdirectory of the directory in which
2137 the original \SpecialChar LyX
2142 \begin_layout Plain Layout
2143 This copier can be customized.
2145 \begin_inset Quotes eld
2149 \begin_inset Quotes erd
2152 argument takes a comma-separated list of extensions to be copied; if it
2153 is omitted, all files will be copied.
2155 \begin_inset Quotes eld
2159 \begin_inset Quotes erd
2162 argument determines the extension added to the generated directory.
2164 \begin_inset Quotes eld
2168 \begin_inset Flex Noun
2171 \begin_layout Plain Layout
2178 \begin_inset Quotes erd
2181 , so HTML generated from
2182 \begin_inset Flex Noun
2185 \begin_layout Plain Layout
2186 /path/to/filename.lyx
2192 \begin_inset Flex Noun
2195 \begin_layout Plain Layout
2196 /path/to/filename.html.LyXconv
2210 \begin_layout Section
2212 \begin_inset CommandInset label
2214 name "sec:Converters"
2221 \begin_layout Standard
2222 You can define your own Converters to convert files between different formats.
2224 \begin_inset Flex Noun
2227 \begin_layout Plain Layout
2228 Tools\SpecialChar menuseparator
2229 Preferences\SpecialChar menuseparator
2230 File Handling\SpecialChar menuseparator
2239 \begin_layout Standard
2240 To define a new converter, select the
2241 \begin_inset Flex Noun
2244 \begin_layout Plain Layout
2246 \begin_inset space ~
2255 \begin_inset Flex Noun
2258 \begin_layout Plain Layout
2260 \begin_inset space ~
2268 from the drop-down lists, enter the command needed for the conversion,
2270 \begin_inset Flex Noun
2273 \begin_layout Plain Layout
2280 Several variables can be used in the definition of converters:
2283 \begin_layout Labeling
2284 \labelwidthstring 00.00.0000
2285 \begin_inset Flex Code
2288 \begin_layout Plain Layout
2294 The \SpecialChar LyX
2298 \begin_layout Labeling
2299 \labelwidthstring 00.00.0000
2300 \begin_inset Flex Code
2303 \begin_layout Plain Layout
2312 \begin_layout Labeling
2313 \labelwidthstring 00.00.0000
2314 \begin_inset Flex Code
2317 \begin_layout Plain Layout
2326 \begin_layout Labeling
2327 \labelwidthstring 00.00.0000
2328 \begin_inset Flex Code
2331 \begin_layout Plain Layout
2337 The base filename of the input file (i.
2338 \begin_inset space \thinspace{}
2341 g., without the extension)
2344 \begin_layout Labeling
2345 \labelwidthstring 00.00.0000
2346 \begin_inset Flex Code
2349 \begin_layout Plain Layout
2355 The path to the input file
2358 \begin_layout Labeling
2359 \labelwidthstring 00.00.0000
2360 \begin_inset Flex Code
2363 \begin_layout Plain Layout
2369 The path to the original input file (this is different from $$p when a
2370 chain of converters is called)
2373 \begin_layout Labeling
2374 \labelwidthstring 00.00.0000
2375 \begin_inset Flex Code
2378 \begin_layout Plain Layout
2384 The iconv name for the encoding of the document.
2387 \begin_layout Standard
2389 \begin_inset Flex Noun
2392 \begin_layout Plain Layout
2394 \begin_inset space ~
2402 field you can enter the following flags, separated by commas:
2405 \begin_layout Labeling
2406 \labelwidthstring 00.00.0000
2407 \begin_inset Flex Code
2410 \begin_layout Plain Layout
2416 This converter runs some form of \SpecialChar LaTeX
2418 This will make \SpecialChar LyX
2419 's \SpecialChar LaTeX
2420 error logs available.
2423 \begin_layout Labeling
2424 \labelwidthstring 00.00.0000
2425 \begin_inset Flex Code
2428 \begin_layout Plain Layout
2434 Needs the \SpecialChar LaTeX
2436 \begin_inset Flex Noun
2439 \begin_layout Plain Layout
2445 file for the conversion.
2448 \begin_layout Labeling
2449 \labelwidthstring 00.00.0000
2450 \begin_inset Flex Code
2453 \begin_layout Plain Layout
2460 \begin_inset Quotes eld
2464 \begin_inset Quotes erd
2467 file from the backend, which in practice means a \SpecialChar LaTeX
2468 file like the one we
2469 would export, without
2470 \begin_inset Flex Code
2473 \begin_layout Plain Layout
2482 \begin_layout Labeling
2483 \labelwidthstring 00.00.0000
2484 \begin_inset Flex Code
2487 \begin_layout Plain Layout
2496 \begin_layout Standard
2497 The following three flags are not really flags at all because they take
2499 \begin_inset Flex Noun
2502 \begin_layout Plain Layout
2504 \begin_inset space ~
2508 \begin_inset space ~
2519 \begin_layout Labeling
2520 \labelwidthstring 00.00.0000
2521 \begin_inset Flex Code
2524 \begin_layout Plain Layout
2530 If set, the converter's standard error will be redirected to a file
2531 \begin_inset Flex Code
2534 \begin_layout Plain Layout
2540 , and the script given as argument will be run as:
2541 \begin_inset Flex Code
2544 \begin_layout Plain Layout
2545 script < infile.out > infile.log
2551 The argument may contain
2552 \begin_inset Flex Code
2555 \begin_layout Plain Layout
2564 \begin_layout Labeling
2565 \labelwidthstring 00.00.0000
2566 \begin_inset Flex Code
2569 \begin_layout Plain Layout
2575 The name of the directory in which the converter will dump the generated
2578 will not create this directory, and it does not copy anything into it,
2579 though it will copy this directory to the destination.
2580 The argument may contain
2581 \begin_inset Flex Code
2584 \begin_layout Plain Layout
2590 , which will be replaced by the base name of the input and output files,
2591 respectively, when the directory is copied.
2592 \begin_inset Newline newline
2595 Note that resultdir and usetempdir make no sense together.
2596 The latter will be ignored if the former is given.
2599 \begin_layout Labeling
2600 \labelwidthstring 00.00.0000
2601 \begin_inset Flex Code
2604 \begin_layout Plain Layout
2610 Determines the output file name and may, contain
2611 \begin_inset Flex Code
2614 \begin_layout Plain Layout
2621 Sensible only with resultdir and optional even then; if not given, it defaults
2625 \begin_layout Standard
2626 None of these last three are presently used in any of the converters that
2627 are installed with \SpecialChar LyX
2632 \begin_layout Standard
2633 You do not have to define converters for all formats between which you want
2635 For example, you will note that there is no `\SpecialChar LyX
2636 to PostScript' converter,
2637 but \SpecialChar LyX
2638 will export PostScript.
2639 It does so by first creating a \SpecialChar LaTeX
2640 file (no converter needs to be defined
2641 for this) which is then converted to DVI using the `\SpecialChar LaTeX
2643 and finally converting the resulting DVI file to PostScript.
2645 finds such `chains' of converters automatically, and it will always choose
2646 the shortest possible chain.
2647 You can, though, still define multiple conversion methods between file
2649 For example, the standard \SpecialChar LyX
2650 configuration provides five ways to convert
2655 \begin_layout Enumerate
2657 \begin_inset Flex Noun
2660 \begin_layout Plain Layout
2669 \begin_layout Enumerate
2670 via (DVI and) PostScript, using
2671 \begin_inset Flex Noun
2674 \begin_layout Plain Layout
2683 \begin_layout Enumerate
2685 \begin_inset Flex Noun
2688 \begin_layout Plain Layout
2697 \begin_layout Enumerate
2699 \begin_inset Flex Noun
2702 \begin_layout Plain Layout
2712 \begin_layout Enumerate
2714 \begin_inset Flex Noun
2717 \begin_layout Plain Layout
2727 \begin_layout Standard
2728 To define such alternate chains, you must define multiple target `file formats',
2730 \begin_inset CommandInset ref
2732 reference "sec:Formats"
2737 For example, in the standard configuration, the formats named
2738 \begin_inset Flex Noun
2741 \begin_layout Plain Layout
2748 \begin_inset Flex Noun
2751 \begin_layout Plain Layout
2758 \begin_inset Flex Noun
2761 \begin_layout Plain Layout
2768 \begin_inset Flex Noun
2771 \begin_layout Plain Layout
2778 \begin_inset Flex Noun
2781 \begin_layout Plain Layout
2788 \begin_inset Flex Noun
2791 \begin_layout Plain Layout
2798 \begin_inset Flex Noun
2801 \begin_layout Plain Layout
2808 \begin_inset Flex Noun
2811 \begin_layout Plain Layout
2819 \begin_inset Flex Noun
2822 \begin_layout Plain Layout
2829 \begin_inset Flex Noun
2832 \begin_layout Plain Layout
2839 ) are defined, all of which share the extension
2840 \begin_inset Flex Noun
2843 \begin_layout Plain Layout
2849 , and which correspond to the conversion methods just mentioned.
2852 \begin_layout Chapter
2853 Internationalizing \SpecialChar LyX
2855 \begin_inset CommandInset label
2857 name "cha:Internationalizing-LyX"
2864 \begin_layout Standard
2866 supports using a translated interface.
2867 Last time we checked, \SpecialChar LyX
2868 provided text in thirty languages.
2869 The language of choice is called your
2874 (For further reading on locale settings, see also the documentation for
2875 locale that comes with your operating system.
2876 For Linux, the manual page for
2877 \begin_inset Flex Code
2880 \begin_layout Plain Layout
2886 could be a good place to start).
2889 \begin_layout Standard
2890 Notice that these translations will work, but do contain a few flaws.
2891 In particular, all dialogs have been designed with the English text in
2892 mind, which means that some of the translated text will be too large to
2893 fit within the space allocated.
2894 This is only a display problem and will not cause any harm.
2895 Also, you will find that some of the translations do not define shortcut
2896 keys for everything.
2897 Sometimes, there are simply not enough free letters to do it.
2898 Other times, the translator just hasn't got around to doing it yet.
2899 Our localization team, which you may wish to join,
2903 \begin_layout Plain Layout
2904 If you are a fluent speaker of a language other than English, joining these
2905 teams is a great way to give back to the \SpecialChar LyX
2911 will of course try to fix these shortcomings in future versions of \SpecialChar LyX
2915 \begin_layout Section
2916 Translating \SpecialChar LyX
2920 \begin_layout Subsection
2921 Translating the graphical user interface (text messages).
2924 \begin_layout Standard
2927 \begin_inset Flex Code
2930 \begin_layout Plain Layout
2936 library to handle the internationalization of the interface.
2937 To have \SpecialChar LyX
2938 speak your favorite language in all menus and dialogs, you need
2940 \begin_inset Flex Code
2943 \begin_layout Plain Layout
2949 -file for that language.
2950 When this is available, you'll have to generate a
2951 \begin_inset Flex Code
2954 \begin_layout Plain Layout
2960 -file from it and install the
2961 \begin_inset Flex Code
2964 \begin_layout Plain Layout
2971 The process of doing all of this is explained in the documentation for
2973 \begin_inset Flex Code
2976 \begin_layout Plain Layout
2983 It is possible to do this just for yourself, but if you're going to do
2984 it, you might as well share the results of your labors with the rest of
2985 the \SpecialChar LyX
2987 Send a message to the \SpecialChar LyX
2988 developers' list for more information about how
2992 \begin_layout Standard
2993 In short, this is what you should do (xx denotes the language code):
2996 \begin_layout Itemize
2997 Check out the \SpecialChar LyX
3000 \begin_inset CommandInset href
3002 name "information on the web"
3003 target "http://www.lyx.org/HowToUseGIT"
3011 \begin_layout Itemize
3013 \begin_inset Flex Code
3016 \begin_layout Plain Layout
3022 to the folder of the
3023 \begin_inset Flex Code
3026 \begin_layout Plain Layout
3034 \begin_inset Flex Code
3037 \begin_layout Plain Layout
3045 \begin_inset Flex Code
3048 \begin_layout Plain Layout
3054 doesn't exist anywhere, it can be remade with the console command
3055 \begin_inset Flex Code
3058 \begin_layout Plain Layout
3064 in that directory, or you can use an existing po-file for some other language
3068 \begin_layout Itemize
3070 \begin_inset Flex Code
3073 \begin_layout Plain Layout
3083 \begin_layout Plain Layout
3084 This is just a text file, so it can be edited in any text editor.
3085 But there are also specialized programs that support such editing, such
3090 (for all platforms) or
3099 contains a `mode' for editing
3100 \begin_inset Flex Code
3103 \begin_layout Plain Layout
3110 \begin_inset Flex URL
3113 \begin_layout Plain Layout
3115 https://www.gnu.org/software/gettext/manual/html_node/PO-Mode.html
3127 For some menu- and widget-labels, there are also shortcut keys that should
3129 Those keys are marked after a `|', and should be translated according to
3130 the words and phrases of the language.
3131 You should also fill also out the information at the beginning of the new
3133 \begin_inset Flex Code
3136 \begin_layout Plain Layout
3142 -file with your email-address, etc., so people know where to reach you with
3143 suggestions and entertaining flames.
3146 \begin_layout Standard
3147 If you are just doing this on your own, then:
3150 \begin_layout Itemize
3152 \begin_inset Flex Code
3155 \begin_layout Plain Layout
3162 This can be done with
3163 \begin_inset Flex Code
3166 \begin_layout Plain Layout
3167 msgfmt -o xx.mo < xx.po
3175 \begin_layout Itemize
3177 \begin_inset Flex Code
3180 \begin_layout Plain Layout
3186 -file to your locale-tree, at the correct directory for application messages
3191 xx, and under the name
3192 \begin_inset Flex Code
3195 \begin_layout Plain Layout
3202 \begin_inset space \thinspace{}
3206 \begin_inset space \space{}
3210 \begin_inset Flex Code
3213 \begin_layout Plain Layout
3214 /usr/local/share/locale/xx/LC_MESSAGES/lyx.mo
3224 \begin_layout Standard
3225 As said, however, it would be best if the new
3226 \begin_inset Flex Code
3229 \begin_layout Plain Layout
3235 file could be added to the \SpecialChar LyX
3236 distribution, so others can use it.
3237 Adding it involves making additional changes to \SpecialChar LyX
3239 So send an email to the developers' mailing list if you're interested in
3243 \begin_layout Subsubsection
3247 \begin_layout Standard
3248 Sometimes it turns out that one English message needs to be translated into
3249 different messages in the target language.
3250 One example is the message
3251 \begin_inset Flex Code
3254 \begin_layout Plain Layout
3260 which has the German translation
3268 , depending upon exactly what the English
3269 \begin_inset Quotes eld
3273 \begin_inset Quotes erd
3278 \begin_inset Flex Code
3281 \begin_layout Plain Layout
3287 does not handle such ambiguous translations.
3288 Therefore you have to add some context information to the message: Instead
3290 \begin_inset Flex Code
3293 \begin_layout Plain Layout
3300 \begin_inset Flex Code
3303 \begin_layout Plain Layout
3304 To[[as in 'From format x to format y']]
3310 \begin_inset Flex Code
3313 \begin_layout Plain Layout
3314 To[[as in 'From page x to page y']].
3319 Now the two occurrences of
3320 \begin_inset Flex Code
3323 \begin_layout Plain Layout
3330 \begin_inset Flex Code
3333 \begin_layout Plain Layout
3339 and can be translated correctly to
3350 \begin_layout Standard
3351 Of course the context information needs to be stripped off the original
3352 message when no translation is used.
3353 Therefore you have to put it in double square brackets at the end of the
3354 message (see the example above).
3355 The translation mechanism of \SpecialChar LyX
3356 ensures that everything in double square
3357 brackets at the end of messages is removed before displaying the message.
3360 \begin_layout Subsection
3361 Translating the documentation.
3364 \begin_layout Standard
3365 The online documentation (in the
3366 \begin_inset Flex Noun
3369 \begin_layout Plain Layout
3375 -menu) can (and should!) be translated.
3376 If there are translated versions of the documentation available
3380 \begin_layout Plain Layout
3381 As of March 2008, at least some of the documents have been translated into
3382 fourteen languages, with the Tutorial available in a few more.
3387 and the locale is set accordingly, these will be used automagically by
3391 looks for translated versions as
3392 \begin_inset Flex Code
3395 \begin_layout Plain Layout
3396 LyXDir/doc/xx/DocName.lyx
3402 \begin_inset Flex Code
3405 \begin_layout Plain Layout
3411 is the code for the language currently in use.
3412 If there are no translated documents, the default English versions will
3414 Note that the translated versions must have the same filenames (
3415 \begin_inset Flex Code
3418 \begin_layout Plain Layout
3424 above) as the original.
3425 If you feel up to translating the documentation (an excellent way to proof-read
3426 the original documentation by the way!), there are a few things you should
3430 \begin_layout Itemize
3431 Check out the documentation translation web page at
3432 \begin_inset CommandInset href
3434 name "http://www.lyx.org/Translation"
3435 target "http://www.lyx.org/Translation"
3441 That way, you can find out which (if any) documents have already been translate
3442 d into your language.
3443 You can also find out who (if anyone) is organizing the effort to translate
3444 the documentation into your language.
3445 If no one is organizing the effort, please let us know that you're interested.
3448 \begin_layout Standard
3449 Once you get to actually translating, here's a few hints for you that may
3453 \begin_layout Itemize
3454 Join the documentation team! There is information on how to do that in
3455 \begin_inset Flex Code
3458 \begin_layout Plain Layout
3465 \begin_inset Flex Noun
3468 \begin_layout Plain Layout
3469 Help\SpecialChar menuseparator
3475 ), which by the way is the first document you should translate.
3478 \begin_layout Itemize
3479 Learn the typographic conventions for the language you are translating to.
3480 Typography is an ancient art and over the centuries, a great variety of
3481 conventions have developed throughout different parts of the world.
3482 Also study the professional terminology amongst typographers in your country.
3483 Inventing your own terminology will only confuse the users.
3486 (Warning! Typography is addictive!)
3489 \begin_layout Itemize
3490 Make a copy of the document.
3491 This will be your working copy.
3492 You can use this as your personal translated help-file by placing it in
3494 \begin_inset Flex Code
3497 \begin_layout Plain Layout
3504 \begin_inset Note Greyedout
3507 \begin_layout Plain Layout
3512 For a complex document with external material (images, etc.), if you make
3514 \begin_inset space \thinspace{}
3518 \begin_inset space \space{}
3521 in a temp dir, beware that the links to external material may be broken
3522 when the document is moved to a different place.
3523 The best way is to retrieve the \SpecialChar LyX
3525 \begin_inset Flex URL
3528 \begin_layout Plain Layout
3530 http://www.lyx.org/HowToUseGIT
3535 ) and to edit the doc file in place.
3543 \begin_layout Itemize
3544 Sometimes the original document (from the \SpecialChar LyX
3545 team) will be updated.
3546 Use the source viewer at
3547 \begin_inset CommandInset href
3549 name "http://www.lyx.org/trac/timeline"
3550 target "http://www.lyx.org/trac/timeline"
3555 to see what has been changed.
3556 That way you can easily see which parts of the translated document need
3560 \begin_layout Standard
3561 If you ever find an error in the original document, fix it and notify the
3562 rest of the documentation team of the changes! (You didn't forget to join
3563 the documentation team, did you?)
3566 \begin_layout Standard
3567 \begin_inset Branch OutDated
3571 \begin_layout Section
3572 International Keyboard Support
3575 \begin_layout Standard
3578 [Editor's Note: The following section is by
3586 It needs to be fixed to conform to the new Documentation Style sheet and
3587 to make use of the new v1.0 features.
3588 The whole thing also needs to be merged with the section following it.-jw
3589 It may also be badly out of date.-rh (2008)]
3592 \begin_layout Subsection
3593 Defining Own Keymaps: Keymap File Format
3596 \begin_layout Standard
3597 Let's look at a keyboard definition file a little closer.
3598 It is a plain text file defining
3601 \begin_layout Itemize
3602 key-to-key or key-to-string translations
3605 \begin_layout Itemize
3609 \begin_layout Itemize
3610 dead keys exceptions
3613 \begin_layout Standard
3614 To define key-to-key or key-to-string translation, use this command:
3617 \begin_layout Quotation
3618 \begin_inset Flex Code
3621 \begin_layout Plain Layout
3630 \begin_inset Flex Code
3633 \begin_layout Plain Layout
3642 \begin_layout Standard
3644 \begin_inset Flex Code
3647 \begin_layout Plain Layout
3653 is the key to be translated and
3654 \begin_inset Flex Code
3657 \begin_layout Plain Layout
3663 is the string to be inserted into the document.
3664 To define dead keys, use:
3667 \begin_layout Quotation
3668 \begin_inset Flex Code
3671 \begin_layout Plain Layout
3680 \begin_inset Flex Code
3683 \begin_layout Plain Layout
3692 \begin_layout Standard
3694 \begin_inset Flex Code
3697 \begin_layout Plain Layout
3703 is a keyboard key and
3704 \begin_inset Flex Code
3707 \begin_layout Plain Layout
3714 The following dead keys are supported (shortcut name is in parentheses):
3717 \begin_layout Quotation
3721 \begin_inset space \hfill{}
3727 \begin_layout Quotation
3729 \begin_inset space \hfill{}
3735 \begin_layout Quotation
3737 \begin_inset space \hfill{}
3743 \begin_layout Quotation
3745 \begin_inset space \hfill{}
3751 \begin_layout Quotation
3753 \begin_inset space \hfill{}
3759 \begin_layout Quotation
3761 \begin_inset space \hfill{}
3768 \begin_layout Plain Layout
3780 \begin_layout Quotation
3782 \begin_inset space \hfill{}
3788 \begin_layout Quotation
3790 \begin_inset space \hfill{}
3797 \begin_layout Plain Layout
3809 \begin_layout Quotation
3811 \begin_inset space \hfill{}
3817 \begin_layout Quotation
3819 \begin_inset space \hfill{}
3825 \begin_layout Quotation
3827 \begin_inset space \hfill{}
3834 \begin_layout Plain Layout
3846 \begin_layout Quotation
3848 \begin_inset space \hfill{}
3855 \begin_layout Plain Layout
3867 \begin_layout Quotation
3869 \begin_inset space \hfill{}
3875 \begin_layout Quotation
3876 hungarian umlaut (hug)
3877 \begin_inset space \hfill{}
3883 \begin_layout Quotation
3885 \begin_inset space \hfill{}
3891 \begin_layout Quotation
3893 \begin_inset space \hfill{}
3900 \begin_layout Plain Layout
3912 \begin_layout Standard
3913 Since in many international keyboards there are exceptions to what some
3914 dead keys should do, you can define them using
3917 \begin_layout Quotation
3918 \begin_inset Flex Code
3921 \begin_layout Plain Layout
3929 deadkey key outstring
3932 \begin_layout Standard
3933 For example, on Slovak keyboard, if you enter caron-o, it generates circumflex-o
3937 \begin_layout Quotation
3938 \begin_inset Flex Code
3941 \begin_layout Plain Layout
3954 \begin_layout Standard
3955 to make it work correctly.
3956 Also, you have to define as exceptions dead keys over i and j, to remove
3957 the dot from them before inserting an accent mark.
3958 I will change this when the time comes, but so far I haven't had time.
3961 \begin_layout Standard
3962 Oh, and about characters: backslash is escaped, so to enter it, you'll need
3965 \begin_inset Flex Code
3968 \begin_layout Plain Layout
3974 have different meaning.
3976 \begin_inset Flex Code
3979 \begin_layout Plain Layout
3985 marks comments, quotes start and end \SpecialChar LaTeX
3987 To enter quote, you'll need to use
3988 \begin_inset Flex Code
3991 \begin_layout Plain Layout
4000 \begin_inset Flex Code
4003 \begin_layout Plain Layout
4010 \begin_inset Flex Code
4013 \begin_layout Plain Layout
4024 \begin_layout Standard
4025 If you make a keyboard description file that works for your language, please
4026 mail it to me, so I can include it in the next keymap distribution.
4029 \begin_layout Standard
4030 More keywords will be supported in keymap configuration file in future,
4034 \begin_layout Itemize
4035 \begin_inset Flex Code
4038 \begin_layout Plain Layout
4049 \begin_inset space \hfill{}
4053 \begin_inset Flex Code
4056 \begin_layout Plain Layout
4065 \begin_layout Itemize
4066 \begin_inset Flex Code
4069 \begin_layout Plain Layout
4080 \begin_inset space \hfill{}
4084 \begin_inset Flex Code
4087 \begin_layout Plain Layout
4093 an external keymap translation program
4096 \begin_layout Standard
4097 Also, it should look into
4098 \begin_inset Flex Code
4101 \begin_layout Plain Layout
4107 file for defaults, too (for example, a
4108 \begin_inset Flex Code
4111 \begin_layout Plain Layout
4119 option to include default keyboard).
4127 \begin_layout Section
4128 International Keymap Stuff
4129 \begin_inset CommandInset label
4131 name "sec:International-Keymap-Stuff"
4138 \begin_layout Standard
4139 \begin_inset Note Note
4142 \begin_layout Plain Layout
4143 In doing the revisions on this document in March 2008, I did not look over
4144 this stuff, as I do not understand it.
4145 It would be good if someone else could do so.
4154 \begin_layout Standard
4155 The next two sections describe the
4156 \begin_inset Flex Code
4159 \begin_layout Plain Layout
4168 \begin_inset Flex Code
4171 \begin_layout Plain Layout
4179 file syntax in detail.
4180 These sections should help you design your own key map if the ones provided
4181 do not meet your needs.
4184 \begin_layout Subsection
4188 \begin_layout Standard
4192 \begin_inset Flex Code
4195 \begin_layout Plain Layout
4201 file maps keystrokes to characters or strings.
4202 As the name suggests, it sets a keyboard mapping.
4204 \begin_inset Flex Code
4207 \begin_layout Plain Layout
4218 \begin_inset Flex Code
4221 \begin_layout Plain Layout
4236 \begin_inset Flex Code
4239 \begin_layout Plain Layout
4252 \begin_inset Flex Code
4255 \begin_layout Plain Layout
4264 \begin_inset Flex Code
4267 \begin_layout Plain Layout
4275 are described in this section.
4278 \begin_layout Labeling
4279 \labelwidthstring 00.00.0000
4280 \begin_inset Flex Code
4283 \begin_layout Plain Layout
4291 Map a character to a string
4294 \begin_layout LyX-Code
4309 \begin_layout Standard
4342 the double-quote (")
4359 must be escaped with a preceding backslash (
4370 \begin_layout Standard
4372 \begin_inset Flex Noun
4375 \begin_layout Plain Layout
4383 statement to cause the symbol
4384 \begin_inset Flex Noun
4387 \begin_layout Plain Layout
4395 to be output for the keystroke
4396 \begin_inset Flex Noun
4399 \begin_layout Plain Layout
4410 \begin_layout LyX-Code
4416 \begin_layout Labeling
4417 \labelwidthstring 00.00.0000
4418 \begin_inset Flex Code
4421 \begin_layout Plain Layout
4429 Specify an accent character
4432 \begin_layout LyX-Code
4441 \begin_layout Standard
4442 This will make the cha
4480 This is the dead key
4484 \begin_layout Plain Layout
4491 refers to a key that does not produce a character by itself, but when followed
4492 with another key, produces the desired accent character.
4493 For example, a German characte
4495 r with an umlaut like
4505 can be produced in this manner.
4514 \begin_layout Standard
4527 and then another key not in
4544 followed by the other, not allowed key, as output.
4548 \begin_inset Flex Noun
4551 \begin_layout Plain Layout
4559 cancels a dead key, so if
4570 \begin_inset Flex Noun
4573 \begin_layout Plain Layout
4582 , the cursor will not go one position backwards but will instead cancel
4598 might have had on the next keystroke.
4602 \begin_layout Standard
4603 The following example specifies that the character ' is to be an acute accent,
4604 allowed on the characters a, e, i, o, u, A, E, I, O, and U:
4607 \begin_layout LyX-Code
4610 kmod ' acute aeiouAEIOU
4613 \begin_layout Labeling
4614 \labelwidthstring 00.00.0000
4615 \begin_inset Flex Code
4618 \begin_layout Plain Layout
4624 Specify an exception to the accent character
4627 \begin_layout LyX-Code
4636 \begin_layout Standard
4637 This defines an exce
4678 have been assigned a keystroke with a previous
4681 \begin_inset Flex Code
4684 \begin_layout Plain Layout
4708 must not belong in the
4755 If such a declaration does not exist in
4763 \begin_inset Flex Code
4766 \begin_layout Plain Layout
4800 \begin_inset Flex Code
4803 \begin_layout Plain Layout
4817 \begin_layout Standard
4818 The following command produces causes äi to be produced when you enter acute-i
4822 \begin_layout LyX-Code
4836 \begin_layout Labeling
4837 \labelwidthstring 00.00.0000
4838 \begin_inset Flex Code
4841 \begin_layout Plain Layout
4847 Combine two accent characters
4850 \begin_layout LyX-Code
4856 accent1 accent2 allowed
4859 \begin_layout Standard
4860 This one is getting pretty esoteric.
4861 It allows you to combine the effect
4917 \begin_inset Flex Code
4920 \begin_layout Plain Layout
4948 \begin_layout Standard
4949 Consider this example from the
4950 \begin_inset Flex Code
4953 \begin_layout Plain Layout
4964 \begin_layout LyX-Code
4967 kmod ; acute aeioyvhAEIOYVH
4971 kcomb acute umlaut iyIY
4974 \begin_layout Standard
4975 This allows you to press
4976 \begin_inset Flex Noun
4979 \begin_layout Plain Layout
4987 and get the effect of
4988 \begin_inset Flex Code
4991 \begin_layout Plain Layout
5010 in this case cancels the last dead key, so if you press
5011 \begin_inset Flex Noun
5014 \begin_layout Plain Layout
5023 \begin_inset Flex Code
5026 \begin_layout Plain Layout
5039 \begin_layout Subsection
5043 \begin_layout Standard
5045 \begin_inset Flex Code
5048 \begin_layout Plain Layout
5056 mapping is performed, a
5057 \begin_inset Flex Code
5060 \begin_layout Plain Layout
5070 file maps the strings that the symbols generate to characters in the current
5072 The \SpecialChar LyX
5073 distribution currently includes at least the
5074 \begin_inset Flex Code
5077 \begin_layout Plain Layout
5086 \begin_inset Flex Code
5089 \begin_layout Plain Layout
5100 \begin_layout Standard
5102 \begin_inset Flex Code
5105 \begin_layout Plain Layout
5113 file is a sequence of declarations of the form
5116 \begin_layout LyX-Code
5129 \begin_layout Standard
5130 For example, in order to map
5131 \begin_inset Flex Noun
5134 \begin_layout Plain Layout
5144 to the corresponding character in the iso-8859-1 set (233), the following
5148 \begin_layout LyX-Code
5156 \begin_layout Standard
5158 \begin_inset Flex Code
5161 \begin_layout Plain Layout
5170 \begin_inset Flex Code
5173 \begin_layout Plain Layout
5191 the same character can apply to more than one string.
5193 \begin_inset Flex Code
5196 \begin_layout Plain Layout
5207 \begin_layout LyX-Code
5219 \begin_inset Newline newline
5235 \begin_layout Standard
5237 cannot find a mapping for the string produced by the keystroke or a
5238 deadkey sequence, it will check if it looks like an accented char and try
5239 to draw an accent over the character on screen.
5242 \begin_layout Subsection
5246 \begin_layout Standard
5247 There is a second way to add support for international characters through
5248 so-called dead-keys.
5249 A dead-key works in combination with a letter to produce an accented character.
5250 Here, we'll explain how to create a really simple dead-key to illustrate
5254 \begin_layout Standard
5255 Suppose you happen to need the circumflex character,
5256 \begin_inset Quotes eld
5260 \begin_inset Quotes erd
5265 \begin_inset Flex Noun
5268 \begin_layout Plain Layout
5275 \begin_inset space ~
5279 \begin_inset Flex Noun
5282 \begin_layout Plain Layout
5288 ] to the \SpecialChar LyX
5290 \begin_inset Flex Code
5293 \begin_layout Plain Layout
5300 \begin_inset Flex Code
5303 \begin_layout Plain Layout
5310 Now, whenever you type the
5311 \begin_inset Flex Noun
5314 \begin_layout Plain Layout
5320 -key followed by a letter, that letter will have a circumflex accent on
5322 For example, the sequence
5323 \begin_inset Quotes eld
5327 \begin_inset Flex Noun
5330 \begin_layout Plain Layout
5337 \begin_inset Quotes erd
5340 produces the letter:
5341 \begin_inset Quotes eld
5345 \begin_inset Quotes erd
5349 If you tried to type
5350 \begin_inset Quotes eld
5354 \begin_inset Flex Noun
5357 \begin_layout Plain Layout
5364 \begin_inset Quotes erd
5367 , however, \SpecialChar LyX
5368 will complain with a beep, since a
5369 \begin_inset Quotes eld
5373 \begin_inset Flex Noun
5376 \begin_layout Plain Layout
5383 \begin_inset Quotes erd
5386 never takes a circumflex accent.
5388 \begin_inset Flex Noun
5391 \begin_layout Plain Layout
5397 after a dead-key produces the bare-accent.
5398 Please note this last point! If you bind a key to a dead-key, you'll need
5399 to rebind the character on that key to yet another key.
5401 \begin_inset Flex Noun
5404 \begin_layout Plain Layout
5410 to a cedilla is a bad idea, since you'll only get cedillas instead of commas.
5413 \begin_layout Standard
5414 One common way to bind dead-keys is to use
5415 \begin_inset Flex Noun
5418 \begin_layout Plain Layout
5425 \begin_inset Flex Noun
5428 \begin_layout Plain Layout
5435 \begin_inset Flex Noun
5438 \begin_layout Plain Layout
5444 in combination with an accent, like
5445 \begin_inset Quotes eld
5449 \begin_inset Flex Noun
5452 \begin_layout Plain Layout
5459 \begin_inset Quotes erd
5463 \begin_inset Quotes eld
5467 \begin_inset Flex Noun
5470 \begin_layout Plain Layout
5477 \begin_inset Quotes erd
5481 \begin_inset Quotes eld
5485 \begin_inset Flex Noun
5488 \begin_layout Plain Layout
5495 \begin_inset Quotes erd
5499 Another way involves using
5500 \begin_inset Flex Code
5503 \begin_layout Plain Layout
5510 \begin_inset Flex Code
5513 \begin_layout Plain Layout
5519 to set up the special
5520 \begin_inset Flex Code
5523 \begin_layout Plain Layout
5531 \begin_inset Flex Code
5534 \begin_layout Plain Layout
5540 acts in some ways just like
5541 \begin_inset Flex Noun
5544 \begin_layout Plain Layout
5550 and permits you to bind keys to accented characters.
5551 You can also turn keys into dead-keys by binding them to something like
5553 \begin_inset Flex Code
5556 \begin_layout Plain Layout
5562 and then binding this symbolic key to the corresponding \SpecialChar LyX
5567 \begin_layout Plain Layout
5572 : This is exactly what I do in my
5573 \begin_inset Flex Code
5576 \begin_layout Plain Layout
5583 \begin_inset Flex Code
5586 \begin_layout Plain Layout
5594 \begin_inset Flex Noun
5597 \begin_layout Plain Layout
5599 \begin_inset space ~
5608 \begin_inset Flex Code
5611 \begin_layout Plain Layout
5617 and a bunch of these
5618 \begin_inset Quotes eld
5622 \begin_inset Flex Code
5625 \begin_layout Plain Layout
5632 \begin_inset Quotes erd
5635 symbolic keys bound such things as
5636 \begin_inset Flex Noun
5639 \begin_layout Plain Layout
5641 \begin_inset space ~
5650 \begin_inset Flex Noun
5653 \begin_layout Plain Layout
5655 \begin_inset space ~
5664 This is how I produce my accented characters.
5669 You can make just about anything into the
5670 \begin_inset Flex Code
5673 \begin_layout Plain Layout
5680 \begin_inset Flex Noun
5683 \begin_layout Plain Layout
5689 keys, a spare function key, etc.
5690 As for the \SpecialChar LyX
5691 commands that produce accents, check the entry for
5692 \begin_inset Flex Code
5695 \begin_layout Plain Layout
5706 You'll find the complete list there.
5709 \begin_layout Subsection
5710 Saving your Language Configuration
5713 \begin_layout Standard
5714 You can edit your preferences so that your desired language environment
5715 is automatically configured when \SpecialChar LyX
5717 \begin_inset Flex Noun
5720 \begin_layout Plain Layout
5721 Edit\SpecialChar menuseparator
5730 \begin_layout Chapter
5731 Installing New Document Classes, Layouts, and Templates
5732 \begin_inset CommandInset label
5734 name "cha:Installing-New-Document"
5739 \begin_inset Argument 1
5742 \begin_layout Plain Layout
5743 Installing New Document Classes
5751 \begin_layout Standard
5752 In this chapter, we describe the procedures for creating and installing
5753 new \SpecialChar LyX
5754 layout and template files, as well as offer a refresher on correctly
5755 installing new \SpecialChar LaTeX
5760 \begin_layout Standard
5761 First, let us a say a few words about how one ought to think about the relation
5762 between \SpecialChar LyX
5763 and \SpecialChar LaTeX
5765 The thing to understand is that, in a certain sense, \SpecialChar LyX
5766 doesn't know anything
5767 about \SpecialChar LaTeX
5769 Indeed, from \SpecialChar LyX
5770 's point of view, \SpecialChar LaTeX
5771 is just one of several
5772 \begin_inset Quotes eld
5776 \begin_inset Quotes erd
5779 in which it is capable of producing output.
5780 Other such formats are DocBook, plaintext, and XHTML.
5782 is, of course, a particularly important format, but very little of the
5783 information \SpecialChar LyX
5784 has about \SpecialChar LaTeX
5785 is actually contained in the program itself.
5789 \begin_layout Plain Layout
5790 Some commands are sufficiently complex that they are
5791 \begin_inset Quotes eld
5795 \begin_inset Quotes erd
5798 into \SpecialChar LyX
5800 But the developers generally regard this as a Bad Thing.
5805 Rather, that information, even for the standard classes like
5806 \begin_inset Flex Code
5809 \begin_layout Plain Layout
5815 , is contained in `layout files'.
5816 Similarly, \SpecialChar LyX
5817 itself does not know much about DocBook or XHTML.
5818 What it knows is contained in layout files.
5821 \begin_layout Standard
5822 You can think of the layout file for a given document class as a translation
5823 manual between \SpecialChar LyX
5824 constructs—paragraphs with their corresponding styles,
5825 certain sorts of insets, etc—and the corresponding \SpecialChar LaTeX
5828 Almost everything \SpecialChar LyX
5830 \begin_inset Flex Code
5833 \begin_layout Plain Layout
5839 , for example, is contained in the file
5840 \begin_inset Flex Code
5843 \begin_layout Plain Layout
5849 and in various other files it includes.
5850 For this reason, anyone intending to write layout files should plan to
5851 study the existing files.
5852 A good place to start is with
5853 \begin_inset Flex Code
5856 \begin_layout Plain Layout
5862 , which is included in
5863 \begin_inset Flex Code
5866 \begin_layout Plain Layout
5873 \begin_inset Flex Code
5876 \begin_layout Plain Layout
5882 , and many of the other layout files for document classes.
5883 This file is where sections and the like are defined:
5884 \begin_inset Flex Code
5887 \begin_layout Plain Layout
5893 tells \SpecialChar LyX
5894 how paragraphs that are marked with the Section, Subsection, etc,
5895 styles can be translated into corresponding \SpecialChar LaTeX
5896 , DocBook, and XHTML commands
5899 \begin_inset Flex Code
5902 \begin_layout Plain Layout
5908 file basically just includes several of these
5909 \begin_inset Flex Code
5912 \begin_layout Plain Layout
5921 \begin_layout Standard
5922 Defining the \SpecialChar LyX
5924 correspondence is not the only thing layout files do, though.
5925 Their other job is to define how the \SpecialChar LyX
5926 constructs themselves will appear
5928 The fact that layout files have these two jobs is often a source of confusion,
5929 because they are completely separate.
5930 Telling \SpecialChar LyX
5931 how to translate a certain paragraph style into \SpecialChar LaTeX
5934 how to display it; conversely, telling \SpecialChar LyX
5935 how to display a certain paragraph
5936 style does not tell \SpecialChar LyX
5937 how to translate it into \SpecialChar LaTeX
5938 (let alone tell \SpecialChar LaTeX
5941 So, in general, when you define a new \SpecialChar LyX
5942 construct, you must always do two
5943 quite separate things: (i)
5944 \begin_inset space ~
5947 tell \SpecialChar LyX
5948 how to translate it into \SpecialChar LaTeX
5950 \begin_inset space ~
5953 tell \SpecialChar LyX
5957 \begin_layout Standard
5958 Much the same is true, of course, as regards \SpecialChar LyX
5959 's other backend formats, though
5960 XHTML is in some ways different, because in that case \SpecialChar LyX
5965 able, to some extent, to use information about how it should display a
5966 paragraph on the screen to output information (in the form of CSS) about
5967 how the paragraph should be displayed in a browser.
5968 Even in this case, however, the distinction between what \SpecialChar LyX
5970 and how things are rendered externally remains in force, and the two can
5971 be controlled separately.
5973 \begin_inset CommandInset ref
5975 reference "sec:Tags-for-XHTML"
5982 \begin_layout Section
5983 Installing new \SpecialChar LaTeX
5987 \begin_layout Standard
5988 Some installations may not include a \SpecialChar LaTeX
5989 package or class file that you would
5990 like to use within \SpecialChar LyX
5992 For example, you might need Foil\SpecialChar TeX
5993 , a package for preparing slides for overhead
5995 Modern \SpecialChar LaTeX
5996 distributions like \SpecialChar TeX
5997 Live (2008 or newer) or MiK\SpecialChar TeX
5998 provide a user interface
5999 for installing such packages.
6000 For example, with MiK\SpecialChar TeX
6001 , you start the program
6002 \begin_inset Quotes eld
6006 \begin_inset space ~
6010 \begin_inset Quotes erd
6013 to get a list of available packages.
6014 To install one of them, right click on it or use the corresponding toolbar
6018 \begin_layout Standard
6019 If your \SpecialChar LaTeX
6020 distribution does not provide such a `package manager', or if the
6021 package is not available from your distribution, then follow these steps
6022 to install it manually:
6025 \begin_layout Enumerate
6026 Get the package from
6027 \begin_inset CommandInset href
6030 target "http://www.ctan.org/"
6038 \begin_layout Enumerate
6039 If the package contains a file with the ending
6040 \begin_inset Quotes eld
6044 \begin_inset Flex Code
6047 \begin_layout Plain Layout
6054 \begin_inset Quotes erd
6057 (is the case for Foil\SpecialChar TeX
6058 ) then open a console, change to the folder of this
6059 file and execute the command
6060 \begin_inset Flex Code
6063 \begin_layout Plain Layout
6070 You have now unpacked the package and have all files to install it.
6071 Most \SpecialChar LaTeX
6072 -packages are not packed and you can skip this step.
6075 \begin_layout Enumerate
6076 Now you need to decide if the package should be available for all users
6081 \begin_layout Enumerate
6082 On *nix systems (Linux, OSX, etc.), if you want the new package to be available
6083 for all users on your system, then install it in your `local' \SpecialChar TeX
6085 install it in your own `user' \SpecialChar TeX
6087 Where these trees should be created, if they do not already exist, depends
6089 To find this out, look in the file
6090 \begin_inset Flex Code
6093 \begin_layout Plain Layout
6103 \begin_layout Plain Layout
6104 This is usually in the directory
6105 \begin_inset Flex Code
6108 \begin_layout Plain Layout
6114 , though you can execute the command
6115 \begin_inset Flex Code
6118 \begin_layout Plain Layout
6129 The location of the `local' \SpecialChar TeX
6130 tree is defined by the
6131 \begin_inset Flex Code
6134 \begin_layout Plain Layout
6140 variable; this is usually somewhere like
6141 \begin_inset Flex Code
6144 \begin_layout Plain Layout
6145 /usr/local/share/texmf
6150 or /usr/local/texlive/XXXX where XXXX is the year of the installed \SpecialChar TeX
6153 The location of the `user' \SpecialChar TeX
6155 \begin_inset Flex Code
6158 \begin_layout Plain Layout
6165 \begin_inset Flex Code
6168 \begin_layout Plain Layout
6175 \begin_inset Flex Code
6178 \begin_layout Plain Layout
6187 (If these variables are not predefined, you have to define them.) You'll
6188 probably need root permissions to create or modify the `local' tree, but
6189 not for your `user' tree.
6190 \begin_inset Newline newline
6193 In general, it is recommended to install in the user tree because your user
6194 will not be modified or even overwritten when you upgrade your system.
6195 It will typically also be backed up together with everything else when
6196 you backup your home directory (which, of course, you do on a regular basis).
6199 \begin_layout Enumerate
6200 On Windows, if you want the new package to be available for all users on
6201 your system, change to the folder where \SpecialChar LaTeX
6202 is installed and then change to
6204 \begin_inset Flex Code
6207 \begin_layout Plain Layout
6218 (For MiK\SpecialChar TeX
6219 , this would be by default the folder
6220 \begin_inset Flex Code
6223 \begin_layout Plain Layout
6241 \begin_layout Plain Layout
6242 Note that this will be the correct path only on English installations.
6243 On a German one, it would be
6244 \begin_inset Flex Code
6247 \begin_layout Plain Layout
6261 , and similarly for other languages.
6266 Create there a new folder
6267 \begin_inset Flex Code
6270 \begin_layout Plain Layout
6276 and copy all files of the package into it.
6278 \begin_inset Newline newline
6281 If the package should only available for you or you don't have admin permissions
6282 , do the same, but in the local \SpecialChar LaTeX
6285 \begin_inset space \thinspace{}
6288 g., for MiK\SpecialChar TeX
6290 \begin_inset space ~
6293 2.8 under Windows XP, this would be the folder:
6294 \begin_inset Newline newline
6300 \begin_inset Flex Code
6303 \begin_layout Plain Layout
6306 Documents and Settings
6318 \begin_inset Newline newline
6324 \begin_inset Phantom HPhantom
6327 \begin_layout Plain Layout
6338 \begin_inset Flex Code
6341 \begin_layout Plain Layout
6354 \begin_inset Newline newline
6357 On Vista, it would be:
6358 \begin_inset Newline newline
6362 \begin_inset Flex Code
6365 \begin_layout Plain Layout
6391 \begin_layout Enumerate
6392 Now one only need to tell \SpecialChar LaTeX
6393 that there are new files.
6394 This depends on the used \SpecialChar LaTeX
6399 \begin_layout Enumerate
6400 For \SpecialChar TeX
6401 Live execute the command
6402 \begin_inset Flex Code
6405 \begin_layout Plain Layout
6412 If you installed the package for all users, then you will probably need
6413 to have root permissions for that.
6416 \begin_layout Enumerate
6417 For MiK\SpecialChar TeX
6418 , if you have installed the package for all users, start the program
6420 \begin_inset Quotes eld
6424 \begin_inset space ~
6428 \begin_inset Quotes erd
6431 and press the button marked
6432 \begin_inset Quotes eld
6436 \begin_inset Quotes erd
6440 Otherwise start the program
6441 \begin_inset Quotes eld
6445 \begin_inset Quotes erd
6452 \begin_layout Enumerate
6453 Finally, you need to tell \SpecialChar LyX
6454 that there are new packages available.
6455 So, in \SpecialChar LyX
6457 \begin_inset Flex Noun
6460 \begin_layout Plain Layout
6463 \SpecialChar menuseparator
6469 and then restart \SpecialChar LyX
6473 \begin_layout Standard
6474 Now the package is installed.
6475 In our example, the document class
6476 \begin_inset Flex Code
6479 \begin_layout Plain Layout
6485 will now be available under
6486 \begin_inset Flex Noun
6489 \begin_layout Plain Layout
6490 Document\SpecialChar menuseparator
6491 Settings\SpecialChar menuseparator
6498 \begin_inset Quotes eld
6502 \begin_inset Quotes erd
6509 \begin_layout Standard
6510 If you would like to use a \SpecialChar LaTeX
6511 document class that is not even listed in the
6513 \begin_inset Flex Noun
6516 \begin_layout Plain Layout
6517 Document\SpecialChar menuseparator
6518 Settings\SpecialChar menuseparator
6524 , then you need to create a `layout' file for it.
6525 That is the topic of the next section.
6528 \begin_layout Section
6529 Types of layout files
6532 \begin_layout Standard
6533 This section describes the various sorts of \SpecialChar LyX
6534 files that contain layout informati
6536 These files describe various paragraph and character styles, determining
6537 how \SpecialChar LyX
6538 should display them and how they should be translated into \SpecialChar LaTeX
6540 XHTML, or whatever output format is being used.
6544 \begin_layout Standard
6545 We shall try to provide a thorough description of the process of writing
6547 However, there are so many different types of documents supported even
6548 by just \SpecialChar LaTeX
6549 that we can't hope to cover every different possibility or problem
6550 you might encounter.
6551 The \SpecialChar LyX
6552 users' list is frequented by people with lots of experience with layout
6553 design who are willing to share what they've learned, so please feel free
6554 to ask questions there.
6557 \begin_layout Standard
6558 As you prepare to write a new layout, it is extremely helpful to look at
6559 the layouts distributed with \SpecialChar LyX
6561 If you write a \SpecialChar LyX
6562 layout for a \SpecialChar LaTeX
6563 document class that might also be used by
6564 others, or write a module that might be useful to others, then you should
6565 consider posting your layout to the
6566 \begin_inset CommandInset href
6568 name "layout section on the LyX wiki"
6569 target "http://wiki.lyx.org/Layouts/Layouts"
6574 or even to the \SpecialChar LyX
6575 developers' list, so that it might be included in \SpecialChar LyX
6580 \begin_layout Plain Layout
6581 Note that \SpecialChar LyX
6582 is licensed under the General Public License, so any material
6583 that is contributed to \SpecialChar LyX
6584 must be similarly licensed.
6592 \begin_layout Subsection
6594 \begin_inset CommandInset label
6596 name "subsec:Layout-modules"
6603 \begin_layout Standard
6604 We have spoken to this point about `layout files'.
6605 But there are different sorts of files that contain layout information.
6606 Layout files, strictly so called, have the
6607 \begin_inset Flex Code
6610 \begin_layout Plain Layout
6616 extension and provide \SpecialChar LyX
6617 with information about document classes.
6618 Since \SpecialChar LyX
6619 1.6 layout information can also be contained in layout
6624 \begin_inset Flex Code
6627 \begin_layout Plain Layout
6634 Modules are to \SpecialChar LaTeX
6635 packages much as layouts are to \SpecialChar LaTeX
6636 classes, and some modules—such
6638 \begin_inset Flex Code
6641 \begin_layout Plain Layout
6647 module—specifically provide support for one package.
6648 In a sense, layout modules are similar to included
6652 \begin_layout Plain Layout
6653 These can have any extension, but by convention have the
6654 \begin_inset Flex Code
6657 \begin_layout Plain Layout
6669 \begin_inset Flex Code
6672 \begin_layout Plain Layout
6678 —in that modules are not specific to a given document class but may be used
6679 with many different classes.
6680 The difference is that using an included file with
6681 \begin_inset Flex Code
6684 \begin_layout Plain Layout
6690 requires editing that file.
6691 Modules, by contrast, are selected in the
6692 \begin_inset Flex Noun
6695 \begin_layout Plain Layout
6696 Document\SpecialChar menuseparator
6705 \begin_layout Standard
6706 Building modules is the easiest way to get started with layout editing,
6707 since it can be as simple as adding a single new paragraph style or flex
6709 But modules may, in principle, contain anything a layout file can contain.
6712 \begin_layout Standard
6713 After creating a new module and copying it to the
6714 \begin_inset Flex Code
6717 \begin_layout Plain Layout
6723 folder, you will need to reconfigure and then restart \SpecialChar LyX
6726 However, changes you make to the module will be seen immediately, if you
6728 \begin_inset Flex Noun
6731 \begin_layout Plain Layout
6732 Document\SpecialChar menuseparator
6738 , highlight something, and then hit
6739 \begin_inset Quotes eld
6743 \begin_inset Quotes erd
6749 It is strongly recommended that you save your work before doing this
6754 it is strongly recommended that you not attempt to edit modules while simultaneo
6755 usly working on actual documents
6758 Though of course the developers strive to keep \SpecialChar LyX
6759 stable in such situations,
6760 syntax errors and the like in your module file could cause strange behavior.
6763 \begin_layout Subsubsection
6767 \begin_layout Standard
6768 Modules are to \SpecialChar LyX
6769 as packages are to \SpecialChar LaTeX
6771 Sometimes, however, you find yourself wanting a specific inset or character
6772 style just for one document and writing a module that will also be available
6773 to other documents makes little sense.
6774 What you need is \SpecialChar LyX
6776 \begin_inset Quotes eld
6780 \begin_inset Quotes erd
6786 \begin_layout Standard
6787 You will find it under
6789 Document\SpecialChar menuseparator
6790 Settings\SpecialChar menuseparator
6794 The large text box allows you to enter anything that you might enter in
6795 a layout file or module.
6796 You can think of a document's local layout, in fact, as a module that belongs
6798 So, in particular, you must enter a
6799 \begin_inset Flex Code
6802 \begin_layout Plain Layout
6809 Any format is acceptable, but one would normally use the format current
6811 (In \SpecialChar LyX
6812 2.3, the current layout format is 63.)
6815 \begin_layout Standard
6816 When you have entered something in the
6817 \begin_inset Flex Code
6820 \begin_layout Plain Layout
6826 pane, \SpecialChar LyX
6828 \begin_inset Quotes eld
6832 \begin_inset Quotes erd
6835 button at the bottom.
6836 Clicking this button will cause \SpecialChar LyX
6837 to determine whether what you have entered
6838 is valid layout information for the chosen format.
6840 will report the result but, unfortunately, will not tell you what errors
6841 there might have been.
6842 These will be written to the terminal, however, if \SpecialChar LyX
6843 is started from a terminal.
6844 You will not be permitted to save your local layout until you have entered
6848 \begin_layout Standard
6849 The warnings at the end of the previous section apply here, too.
6850 Do not play with local layout while you are actually working, especially
6851 if you have not saved your document.
6852 That said, using local layout with a test document can be a very convenient
6853 way to try out layout ideas, or even to start developing a module.
6856 \begin_layout Subsection
6858 \begin_inset Flex Noun
6861 \begin_layout Plain Layout
6870 \begin_layout Standard
6871 There are two situations you are likely to encounter when wanting to support
6872 a new \SpecialChar LaTeX
6873 document class, involving style (
6874 \begin_inset Flex Code
6877 \begin_layout Plain Layout
6883 ) files and \SpecialChar LaTeX2e
6885 \begin_inset Flex Code
6888 \begin_layout Plain Layout
6895 Supporting a style file is usually fairly easy.
6896 Supporting a new class file is a bit harder.
6897 We'll discuss the former in this section and the latter in the next.
6898 Similar remarks apply, of course, if you want to support a new DocBook
6902 \begin_layout Standard
6903 The easier case is the one in which your new document class is provided
6904 as a style file that is to be used in conjunction with an already supported
6906 For the sake of the example, we'll assume that the style file is called
6908 \begin_inset Flex Noun
6911 \begin_layout Plain Layout
6917 and that it is meant to be used with
6918 \begin_inset Flex Noun
6921 \begin_layout Plain Layout
6927 , which is a standard class.
6931 \begin_layout Standard
6932 Start by copying the existing class's layout file into your local directory:
6936 \begin_layout Plain Layout
6937 Of course, which directory is your local directory will vary by platform,
6938 and \SpecialChar LyX
6939 allows you to specify your local directory on startup, too, using
6941 \begin_inset Flex Code
6944 \begin_layout Plain Layout
6958 \begin_layout LyX-Code
6959 cp report.layout ~/.lyx/layouts/myclass.layout
6962 \begin_layout Standard
6964 \begin_inset Flex Code
6967 \begin_layout Plain Layout
6973 and change the line:
6976 \begin_layout LyX-Code
6979 DeclareLaTeXClass{Report (Standard Class)}
6982 \begin_layout Standard
6986 \begin_layout LyX-Code
6989 DeclareLaTeXClass[report, myclass.sty]{Report (My Class)}
6992 \begin_layout Standard
6996 \begin_layout LyX-Code
6998 \begin_inset Newline newline
7004 \begin_inset Newline newline
7010 \begin_layout Standard
7011 near the top of the file.
7014 \begin_layout Standard
7015 Start \SpecialChar LyX
7017 \begin_inset Flex Noun
7020 \begin_layout Plain Layout
7021 Tools\SpecialChar menuseparator
7028 Then restart \SpecialChar LyX
7029 and try creating a new document.
7031 \begin_inset Flex Noun
7034 \begin_layout Plain Layout
7040 " as a document class option in the
7041 \begin_inset Flex Noun
7044 \begin_layout Plain Layout
7045 Document\SpecialChar menuseparator
7052 It is likely that some of the sectioning commands and such in your new
7053 class will work differently from how they worked in the base class—
7054 \begin_inset Flex Code
7057 \begin_layout Plain Layout
7063 in this example—so you can fiddle around with the settings for the different
7064 sections if you wish.
7065 The layout information for sections is contained in
7066 \begin_inset Flex Code
7069 \begin_layout Plain Layout
7075 , but you do not need to copy and change this file.
7076 Instead, you can simply add your changes to your layout file, after the
7078 \begin_inset Flex Code
7081 \begin_layout Plain Layout
7087 , which itself includes
7088 \begin_inset Flex Code
7091 \begin_layout Plain Layout
7098 For example, you might add these lines:
7101 \begin_layout LyX-Code
7105 \begin_layout LyX-Code
7109 \begin_layout LyX-Code
7113 \begin_layout LyX-Code
7117 \begin_layout LyX-Code
7121 \begin_layout Standard
7122 to change the font for chapter headings to sans-serif.
7123 This will override (or, in this case, add to) the existing declaration
7124 for the Chapter style.
7128 \begin_layout Standard
7129 Your new package may also provide commands or environments not present in
7131 In this case, you will want to add these to the layout file.
7133 \begin_inset CommandInset ref
7135 reference "sec:TextClass"
7139 for information on how to do so.
7142 \begin_layout Standard
7144 \begin_inset Flex Noun
7147 \begin_layout Plain Layout
7153 can be used with several different document classes, and even if it cannot,
7154 you might find it easiest just to write a module that you can load with
7156 The simplest possible such module would be:
7159 \begin_layout LyX-Code
7162 DeclareLyXModule{My Class}
7165 \begin_layout LyX-Code
7169 \begin_layout LyX-Code
7170 #Support for myclass.sty.
7173 \begin_layout LyX-Code
7175 \begin_inset Newline newline
7181 \begin_layout LyX-Code
7183 \begin_inset Newline newline
7189 \begin_layout LyX-Code
7191 \begin_inset Newline newline
7197 \begin_inset Newline newline
7203 \begin_layout Standard
7204 A more complex module might modify the behavior of some existing constructs
7205 or define some new ones.
7207 \begin_inset CommandInset ref
7209 reference "sec:TextClass"
7216 \begin_layout Subsection
7218 \begin_inset Flex Noun
7221 \begin_layout Plain Layout
7230 \begin_layout Standard
7231 There are two possibilities here.
7232 One is that the class file is itself based upon an existing document class.
7233 For example, many thesis classes are based upon
7234 \begin_inset Flex Noun
7237 \begin_layout Plain Layout
7244 To see whether yours is, look for a line like
7247 \begin_layout LyX-Code
7253 \begin_layout Standard
7255 If so, then you may proceed largely as in the previous section, though
7257 \begin_inset Flex Code
7260 \begin_layout Plain Layout
7261 Declare\SpecialChar LaTeX
7267 line will be different.
7268 If your new class is
7269 \begin_inset Flex Code
7272 \begin_layout Plain Layout
7278 and it is based upon
7279 \begin_inset Flex Code
7282 \begin_layout Plain Layout
7288 , then the line should read:
7292 \begin_layout Plain Layout
7293 And it will be easiest if you save the file to
7294 \begin_inset Flex Code
7297 \begin_layout Plain Layout
7304 assumes that the document class has the same name as the layout file.
7313 \begin_layout LyX-Code
7316 DeclareLaTeXClass[thesis,book]{thesis}
7319 \begin_layout Standard
7320 If, on the other hand, the new class is not based upon an existing class,
7321 you will probably have to
7322 \begin_inset Quotes eld
7326 \begin_inset Quotes erd
7330 We strongly suggest copying an existing layout file which uses a similar
7332 class and then modifying it, if you can do so.
7333 At least use an existing file as a starting point so you can find out what
7334 items you need to worry about.
7335 Again, the specifics are covered below.
7338 \begin_layout Subsection
7340 \begin_inset CommandInset label
7342 name "subsec:Creating-Templates"
7349 \begin_layout Standard
7350 Once you have written a layout file for a new document class, you might
7351 want to consider writing a
7356 A template acts as a kind of tutorial for your layout, showing how it might
7357 be used, though containing dummy content.
7358 You can of course look at the various templates included with \SpecialChar LyX
7362 \begin_layout Standard
7363 Templates are created just like usual documents: using \SpecialChar LyX
7365 The only difference is that usual documents contain all possible settings,
7366 including the font scheme and the paper size.
7367 Usually a user doesn't want a template to overwrite his preferred settings
7368 for such parameters.
7369 For that reason, the designer of a template should remove the corresponding
7371 \begin_inset Flex Code
7374 \begin_layout Plain Layout
7383 \begin_inset Flex Code
7386 \begin_layout Plain Layout
7394 from the template \SpecialChar LyX
7396 This can be done with any simple text-editor, for example
7397 \begin_inset Flex Code
7400 \begin_layout Plain Layout
7407 \begin_inset Flex Code
7410 \begin_layout Plain Layout
7419 \begin_layout Standard
7420 Put the edited template files you create in
7421 \begin_inset Flex Code
7424 \begin_layout Plain Layout
7430 , copy the ones you use from the global template directory in
7431 \begin_inset Flex Code
7434 \begin_layout Plain Layout
7440 to the same place, and redefine the template path in the
7441 \begin_inset Flex Noun
7444 \begin_layout Plain Layout
7445 Tools\SpecialChar menuseparator
7446 Preferences\SpecialChar menuseparator
7455 \begin_layout Standard
7456 Note, by the way, that there is a template which has a particular meaning:
7458 \begin_inset Flex Code
7461 \begin_layout Plain Layout
7468 This template is loaded every time you create a new document with
7469 \begin_inset Flex Noun
7472 \begin_layout Plain Layout
7473 File\SpecialChar menuseparator
7479 in order to provide useful defaults.
7480 To create this template from inside \SpecialChar LyX
7481 , all you have to do is to open a document
7482 with the correct settings, and use the
7483 \begin_inset Flex Noun
7486 \begin_layout Plain Layout
7487 Save as Document Defaults
7495 \begin_layout Subsection
7496 Upgrading old layout files
7499 \begin_layout Standard
7500 The format of layout files changes with each \SpecialChar LyX
7501 release, so old layout files
7502 need to be converted to the new format.
7504 reads a layout file in an older format, it automatically calls the
7506 \begin_inset Flex Code
7509 \begin_layout Plain Layout
7515 to convert it to a temporary file in current format.
7516 The original file is left untouched.
7517 If you use the layout file often, then, you may want to convert it permanently,
7518 so that \SpecialChar LyX
7519 does not have to do so itself every time.
7520 To do this, you can call the converter manually:
7523 \begin_layout Enumerate
7525 \begin_inset Flex Code
7528 \begin_layout Plain Layout
7535 \begin_inset Flex Code
7538 \begin_layout Plain Layout
7547 \begin_layout Enumerate
7549 \begin_inset Newline newline
7553 \begin_inset Flex Code
7556 \begin_layout Plain Layout
7557 python LyXDir/scripts/layout2layout.py myclass.old myclass.layout
7563 \begin_inset Newline newline
7567 \begin_inset Flex Code
7570 \begin_layout Plain Layout
7576 is the name of your \SpecialChar LyX
7580 \begin_layout Standard
7581 Note that manual conversion does not affect included files, so these will
7582 have to be converted separately.
7585 \begin_layout Subsection
7586 \begin_inset CommandInset label
7588 name "subsec:Cite-Engine-Files"
7595 \begin_layout Standard
7596 A specific form of layout files are the so-called
7597 \begin_inset Flex Code
7600 \begin_layout Plain Layout
7606 files that are located in the
7607 \begin_inset Flex Code
7610 \begin_layout Plain Layout
7617 Their purpose is to define the specifics of \SpecialChar LaTeX
7618 packages aimed at bibliography
7631 , but also the way how normal Bib\SpecialChar TeX
7632 citations (without additional packages)
7633 are handled in \SpecialChar LyX
7634 is defined in such a file.
7638 \begin_layout Standard
7639 More specifically, it is defined which packages \SpecialChar LyX
7640 needs to load, which citation
7641 commands are available, how these are to be displayed in \SpecialChar LyX
7643 the dialogs, the context menus) as well as in the XHTML and plain text
7645 Furthermore, the files specify available style variants (author-year, numerical
7646 , etc.) and their specifics.
7647 The cite engine files are also used to generate the options that are available
7650 Document\SpecialChar menuseparator
7651 Settings\SpecialChar ldots
7652 \SpecialChar menuseparator
7653 Bibliography\SpecialChar menuseparator
7659 \begin_layout Standard
7660 Even though a cite engine file is essentially a normal layout file that
7661 could theoretically include any layout information, it usually primarily
7662 includes some specific parameters such as
7663 \begin_inset Flex Code
7666 \begin_layout Plain Layout
7673 \begin_inset Flex Code
7676 \begin_layout Plain Layout
7683 \begin_inset Flex Code
7686 \begin_layout Plain Layout
7693 \begin_inset Flex Code
7696 \begin_layout Plain Layout
7703 The syntax of the latter two is described in
7704 \begin_inset CommandInset ref
7706 reference "subsec:Citation-engine-description"
7714 \begin_inset CommandInset ref
7716 reference "subsec:Citation-format-description"
7720 , as well as in the files themselves.
7723 \begin_layout Section
7724 \begin_inset CommandInset label
7726 name "sec:TextClass"
7730 The layout file format
7733 \begin_layout Standard
7734 The following sections describe how layout files are structured and written.
7735 Our advice is to go slowly, save and test often.
7736 It is really not that hard, except that the multitude of options can become
7737 overwhelming, especially if you try to check out too many at once.
7738 It becomes easier if you use existing layouts of \SpecialChar LyX
7739 as examples/reference
7740 or if you modify an existing layout to your needs.
7743 \begin_layout Standard
7744 Note that all the tags used in layout files are case-insensitive.
7746 \begin_inset Flex Code
7749 \begin_layout Plain Layout
7756 \begin_inset Flex Code
7759 \begin_layout Plain Layout
7766 \begin_inset Flex Code
7769 \begin_layout Plain Layout
7775 are really the same tag.
7776 The possible arguments are printed in brackets after the tag's name.
7777 The default argument is typeset
7778 \begin_inset Flex Code
7781 \begin_layout Plain Layout
7790 If the argument has a data type like
7791 \begin_inset Quotes eld
7795 \begin_inset Quotes erd
7799 \begin_inset Quotes eld
7803 \begin_inset Quotes erd
7806 , the default is shown like this:
7807 \begin_inset Flex Code
7810 \begin_layout Plain Layout
7821 \begin_layout Subsection
7822 The document class declaration and classification
7825 \begin_layout Standard
7826 Lines in a layout file which begin with
7827 \begin_inset Flex Code
7830 \begin_layout Plain Layout
7837 There is one exception to this rule.
7839 \begin_inset Flex Code
7842 \begin_layout Plain Layout
7848 files should begin with lines like:
7851 \begin_layout LyX-Code
7854 #% Do not delete the line below; configure depends on this
7857 \begin_layout LyX-Code
7862 DeclareLaTeXClass{Article (Standard Class)}
7865 \begin_layout LyX-Code
7870 DeclareCategory{Articles}
7873 \begin_layout Standard
7874 The second and third lines are used when you (re)configure \SpecialChar LyX
7876 The layout file is read by the \SpecialChar LaTeX
7878 \begin_inset Flex Code
7881 \begin_layout Plain Layout
7887 , in a special mode where
7888 \begin_inset Flex Code
7891 \begin_layout Plain Layout
7898 The first line is just a \SpecialChar LaTeX
7899 comment, the second one contains the mandatory
7900 declaration of the text class and the third line contains the optional
7901 classification of the class.
7902 If these lines appear in a file named
7903 \begin_inset Flex Code
7906 \begin_layout Plain Layout
7912 , then they define a text class of name
7913 \begin_inset Flex Code
7916 \begin_layout Plain Layout
7922 (the name of the layout file) which uses the \SpecialChar LaTeX
7924 \begin_inset Flex Code
7927 \begin_layout Plain Layout
7933 (the default is to use the same name as the layout).
7935 \begin_inset Quotes eld
7938 Article (Standard Class)
7939 \begin_inset Quotes erd
7942 that appears above is used as a description of the text class in the
7943 \begin_inset Flex Noun
7946 \begin_layout Plain Layout
7947 Document\SpecialChar menuseparator
7955 \begin_inset Quotes eld
7959 \begin_inset Quotes erd
7962 in the example) is also used in the
7963 \begin_inset Flex Noun
7966 \begin_layout Plain Layout
7967 Document\SpecialChar menuseparator
7973 dialog: the text classes are grouped by these categories (which are usually
7974 genres, so typical categories are
7975 \begin_inset Quotes eld
7979 \begin_inset Quotes erd
7983 \begin_inset Quotes eld
7987 \begin_inset Quotes erd
7991 \begin_inset Quotes eld
7995 \begin_inset Quotes erd
7999 \begin_inset Quotes eld
8003 \begin_inset Quotes erd
8007 \begin_inset Quotes eld
8011 \begin_inset Quotes erd
8015 \begin_inset Quotes eld
8019 \begin_inset Quotes erd
8023 If no category has been declared, the class will be put in the
8024 \begin_inset Quotes eld
8028 \begin_inset Quotes erd
8034 \begin_layout Standard
8035 Let's assume that you wrote your own text class that uses the
8036 \begin_inset Flex Code
8039 \begin_layout Plain Layout
8045 document class, but where you changed the appearance of the section headings.
8046 If you put it in a file
8047 \begin_inset Flex Code
8050 \begin_layout Plain Layout
8056 , the header of this file should be:
8059 \begin_layout LyX-Code
8062 #% Do not delete the line below; configure depends on this
8065 \begin_layout LyX-Code
8070 DeclareLaTeXClass[article]{Article (with My Own Headings)}
8073 \begin_layout LyX-Code
8078 DeclareCategory{Articles}
8081 \begin_layout Standard
8082 This declares a text class
8083 \begin_inset Flex Code
8086 \begin_layout Plain Layout
8092 , associated with the \SpecialChar LaTeX
8094 \begin_inset Flex Code
8097 \begin_layout Plain Layout
8104 \begin_inset Quotes eld
8107 Article (with My Own Headings)
8108 \begin_inset Quotes erd
8112 If your text class depends on several packages, you can declare it as:
8115 \begin_layout LyX-Code
8118 #% Do not delete the line below; configure depends on this
8121 \begin_layout LyX-Code
8126 DeclareLaTeXClass[article,foo.sty]{Article (with My Own Headings)}
8129 \begin_layout LyX-Code
8134 DeclareCategory{Articles}
8137 \begin_layout Standard
8138 This indicates that your text class uses the
8139 \begin_inset Flex Code
8142 \begin_layout Plain Layout
8149 Finally, it is also possible to declare classes for DocBook code.
8150 Typical declarations will look like:
8153 \begin_layout LyX-Code
8156 #% Do not delete the line below; configure depends on this
8159 \begin_layout LyX-Code
8164 DeclareDocBookClass[article]{SGML (DocBook Article)}
8167 \begin_layout LyX-Code
8172 DeclareCategory{Articles (DocBook)}
8175 \begin_layout Standard
8176 Note that these declarations can also be given an optional parameter declaring
8177 the name of the document class (but not a list).
8180 \begin_layout Standard
8181 So, to be as explicit as possible, the form of the layout declaration is:
8184 \begin_layout LyX-Code
8189 DeclareLaTeXClass[class,package.sty]{layout description}
8192 \begin_layout LyX-Code
8197 DeclareCategory{category}
8200 \begin_layout Standard
8201 The class need only be specified if the name of the \SpecialChar LaTeX
8203 name of the layout file are different or if there are packages to load.
8204 If the name of the class file is not specified, then \SpecialChar LyX
8206 that it is the same as the name of the layout file.
8209 \begin_layout Standard
8210 When the text class has been modified to your taste, all you have to do
8211 is to copy it either to
8212 \begin_inset Flex Code
8215 \begin_layout Plain Layout
8222 \begin_inset Flex Code
8225 \begin_layout Plain Layout
8232 \begin_inset Flex Noun
8235 \begin_layout Plain Layout
8236 Tools\SpecialChar menuseparator
8242 , exit \SpecialChar LyX
8244 Then your new text class should be available along with the others.
8247 \begin_layout Standard
8248 Once the layout file is installed, you can edit it and see your changes
8249 without having to reconfigure or to restart \SpecialChar LyX
8254 \begin_layout Plain Layout
8255 In versions of \SpecialChar LyX
8256 prior to 1.6, this was not true.
8257 As a result, editing layout files was very time consuming, since you had
8258 constantly to restart \SpecialChar LyX
8264 You can force a reload of the current layout by using the \SpecialChar LyX
8266 \begin_inset Flex Noun
8269 \begin_layout Plain Layout
8276 There is no default binding for this function—though, of course, you can
8277 bind it to a key yourself.
8278 But you will normally use this function simply by entering it in the mini-buffe
8283 \begin_layout Standard
8289 \begin_inset Flex Noun
8292 \begin_layout Plain Layout
8298 is very much an `advanced feature'.
8303 recommended that you save your work before using this function.
8308 recommended that you not attempt to edit layout information while simultaneousl
8309 y working on a document that you care about.
8310 Use a test document.
8311 Syntax errors and the like in your layout file could cause peculiar behavior.
8312 In particular, such errors could cause \SpecialChar LyX
8313 to regard the current layout as
8314 invalid and to attempt to switch to some other layout.
8318 \begin_layout Plain Layout
8319 Really bad syntax errors may even caused \SpecialChar LyX
8321 This is because certain sorts of errors may make \SpecialChar LyX
8332 The \SpecialChar LyX
8333 team strives to keep \SpecialChar LyX
8334 stable in such situations, but safe is better
8339 \begin_layout Plain Layout
8340 While we're giving advice: make regular backups.
8341 And be nice to your mother.
8349 \begin_layout Subsection
8350 The Module declaration
8353 \begin_layout Standard
8354 A module must begin with a line like the following:
8357 \begin_layout LyX-Code
8360 DeclareLyXModule[endnotes.sty]{Endnotes}
8363 \begin_layout Standard
8364 The mandatory argument, in curly brackets, is the name of the module, as
8366 \begin_inset Flex Noun
8369 \begin_layout Plain Layout
8370 Document\SpecialChar menuseparator
8371 Settings\SpecialChar menuseparator
8378 The argument in square brackets is optional: It declares any \SpecialChar LaTeX
8380 on which the module depends.
8381 It is also possible to use the form
8382 \begin_inset Flex Noun
8385 \begin_layout Plain Layout
8391 as an optional argument, which declares that the module can only be used
8392 when there exists a conversion chain between the formats `
8393 \begin_inset Flex Code
8396 \begin_layout Plain Layout
8403 \begin_inset Flex Code
8406 \begin_layout Plain Layout
8415 \begin_layout Standard
8416 The module declaration should then be followed by lines like the following
8420 \begin_layout Plain Layout
8421 Preferably in English if the module should be published with \SpecialChar LyX
8423 This description will appear in the list of messages to be translated and
8424 will be thus translated with the next interface update.
8432 \begin_layout LyX-Code
8436 \begin_layout LyX-Code
8437 #Adds an endnote command, in addition to footnotes.
8441 \begin_layout LyX-Code
8442 #You will need to add
8444 theendnotes in TeX code where you
8447 \begin_layout LyX-Code
8448 #want the endnotes to appear.
8452 \begin_layout LyX-Code
8456 \begin_layout LyX-Code
8457 #Requires: somemodule | othermodule
8460 \begin_layout LyX-Code
8461 #Excludes: badmodule
8464 \begin_layout Standard
8465 The description is used in
8466 \begin_inset Flex Noun
8469 \begin_layout Plain Layout
8470 Document\SpecialChar menuseparator
8471 Settings\SpecialChar menuseparator
8477 to provide the user with information about what the module does.
8479 \begin_inset Flex Code
8482 \begin_layout Plain Layout
8488 line is used to identify other modules with which this one must be used;
8490 \begin_inset Flex Code
8493 \begin_layout Plain Layout
8499 line is used to identify modules with which this one may not be used.
8500 Both are optional, and, as shown, multiple modules should be separated
8501 with the pipe symbol: |.
8502 Note that the required modules are treated disjunctively:
8506 of the required modules must be used.
8511 excluded module may be used.
8512 Note that modules are identified here by their filenames without the
8513 \begin_inset Flex Code
8516 \begin_layout Plain Layout
8524 \begin_inset Flex Code
8527 \begin_layout Plain Layout
8534 \begin_inset Flex Code
8537 \begin_layout Plain Layout
8546 \begin_layout Subsection
8547 The CiteEngine file declaration
8550 \begin_layout Standard
8551 A cite engine file must begin with a line like the following:
8554 \begin_layout LyX-Code
8557 DeclareLyXCiteEngineModule[biblatex.sty]{Biblatex}
8560 \begin_layout Standard
8561 The mandatory argument, in curly brackets, is the name of the cite style,
8562 as it should appear in
8563 \begin_inset Flex Noun
8566 \begin_layout Plain Layout
8567 Document\SpecialChar menuseparator
8568 Settings\SpecialChar menuseparator
8575 The argument in square brackets is optional: It declares any \SpecialChar LaTeX
8577 on which the cite engine depends.
8580 \begin_layout Standard
8581 The cite engine declaration should then be followed by lines like the following
8585 \begin_layout Plain Layout
8586 Preferably in English if the module should be published with \SpecialChar LyX
8588 This description will appear in the list of messages to be translated and
8589 will be thus translated with the next interface update.
8597 \begin_layout LyX-Code
8601 \begin_layout LyX-Code
8602 # Biblatex supports many author-year and numerical styles.
8605 \begin_layout LyX-Code
8606 # It is mainly aimed at the Humanities.
8610 \begin_layout LyX-Code
8611 # customizable, fully localized and provides many features
8614 \begin_layout LyX-Code
8615 # that are not possible with BibTeX.
8616 The use of 'biber' as
8619 \begin_layout LyX-Code
8620 # bibliography processor is advised.
8623 \begin_layout LyX-Code
8627 \begin_layout Standard
8628 The description is used in
8629 \begin_inset Flex Noun
8632 \begin_layout Plain Layout
8633 Document\SpecialChar menuseparator
8634 Settings\SpecialChar menuseparator
8640 to provide the user with information about the cite engine.
8643 \begin_layout Subsection
8647 \begin_layout Standard
8648 The first non-comment line of any layout file, included file, or module
8653 contain the file format number:
8656 \begin_layout Description
8657 \begin_inset Flex Code
8660 \begin_layout Plain Layout
8667 \begin_inset Flex Code
8670 \begin_layout Plain Layout
8676 ] The format number of the layout file.
8679 \begin_layout Standard
8680 This tag was introduced with \SpecialChar LyX
8682 \begin_inset space ~
8686 Layout files from older \SpecialChar LyX
8687 versions do not have an explicit file format and
8688 are considered to have
8689 \begin_inset Flex Code
8692 \begin_layout Plain Layout
8694 \begin_inset space ~
8703 The format for the present version of \SpecialChar LyX
8705 But each version of \SpecialChar LyX
8706 is capable of reading earlier versions' layout files,
8707 just as they are capable of reading files produced by earlier versions
8710 There is, however, no provision for converting to earlier formats.
8713 \begin_layout Subsection
8714 \begin_inset CommandInset label
8716 name "subsec:General-text-class"
8720 General text class parameters
8723 \begin_layout Standard
8724 These are general parameters that govern the behavior of an entire document
8730 mean that they must appear in
8731 \begin_inset Flex Code
8734 \begin_layout Plain Layout
8740 files rather than in modules.
8741 A module can contain any layout tag.)
8744 \begin_layout Description
8745 \begin_inset Flex Code
8748 \begin_layout Plain Layout
8754 Adds information that will be output in the
8755 \begin_inset Flex Code
8758 \begin_layout Plain Layout
8764 block when the document is output to XHTML.
8765 Typically, this would be used to output CSS style information, but it can
8766 be used for anything that can appear in
8767 \begin_inset Flex Code
8770 \begin_layout Plain Layout
8778 \begin_inset Quotes eld
8782 \begin_inset Flex Code
8785 \begin_layout Plain Layout
8792 \begin_inset Quotes erd
8798 \begin_layout Description
8799 \begin_inset Flex Code
8802 \begin_layout Plain Layout
8808 Adds information to the document preamble.
8810 \begin_inset Newline newline
8814 \begin_inset Quotes eld
8818 \begin_inset Flex Code
8821 \begin_layout Plain Layout
8828 \begin_inset Quotes erd
8834 \begin_layout Description
8835 \begin_inset Flex Code
8838 \begin_layout Plain Layout
8844 Defines the possibilities for displaying citation references.
8846 \begin_inset CommandInset ref
8848 reference "subsec:Citation-engine-description"
8857 \begin_inset Quotes eld
8861 \begin_inset Flex Code
8864 \begin_layout Plain Layout
8871 \begin_inset Quotes erd
8875 Primarily used in cite engine files (see
8876 \begin_inset CommandInset ref
8878 reference "subsec:Cite-Engine-Files"
8888 \begin_layout Description
8889 \begin_inset Flex Code
8892 \begin_layout Plain Layout
8898 Defines formats for use in the display of bibliographic information.
8900 \begin_inset CommandInset ref
8902 reference "subsec:Citation-format-description"
8908 \begin_inset Quotes eld
8912 \begin_inset Flex Code
8915 \begin_layout Plain Layout
8922 \begin_inset Quotes erd
8926 Primarily used in cite engine files (see
8927 \begin_inset CommandInset ref
8929 reference "subsec:Cite-Engine-Files"
8939 \begin_layout Description
8940 \begin_inset Flex Code
8943 \begin_layout Plain Layout
8950 \begin_inset Flex Code
8953 \begin_layout Plain Layout
8962 \begin_inset Flex Code
8965 \begin_layout Plain Layout
8971 ] Determines whether
8975 or Bib\SpecialChar TeX
8976 is used to generate a Bibliography.
8977 Primarily used in cite engine files (see
8978 \begin_inset CommandInset ref
8980 reference "subsec:Cite-Engine-Files"
8990 \begin_layout Description
8991 \begin_inset Flex Code
8994 \begin_layout Plain Layout
9000 Describes various global options supported by the document class.
9002 \begin_inset CommandInset ref
9004 reference "subsec:ClassOptions"
9010 \begin_inset Quotes eld
9014 \begin_inset Flex Code
9017 \begin_layout Plain Layout
9024 \begin_inset Quotes erd
9030 \begin_layout Description
9031 \begin_inset Flex Code
9034 \begin_layout Plain Layout
9041 \begin_inset Flex Code
9044 \begin_layout Plain Layout
9053 \begin_inset space \thinspace{}
9057 \begin_inset Flex Code
9060 \begin_layout Plain Layout
9066 ] Whether the class should
9070 to having one or two columns.
9071 Can be changed in the
9072 \begin_inset Flex Noun
9075 \begin_layout Plain Layout
9076 Document\SpecialChar menuseparator
9085 \begin_layout Description
9086 \begin_inset Flex Code
9089 \begin_layout Plain Layout
9096 \begin_inset Flex Code
9099 \begin_layout Plain Layout
9105 ] This sequence defines the properties for a counter.
9106 If the counter does not yet exist, it is created; if it does exist, it
9109 \begin_inset Quotes eld
9113 \begin_inset Flex Code
9116 \begin_layout Plain Layout
9123 \begin_inset Quotes erd
9127 \begin_inset Newline newline
9131 \begin_inset CommandInset ref
9133 reference "subsec:Counters"
9137 for details on counters.
9140 \begin_layout Description
9141 \begin_inset Flex Code
9144 \begin_layout Plain Layout
9150 Sets the default font used to display the document.
9152 \begin_inset CommandInset ref
9154 reference "subsec:Font-description"
9158 for how to declare fonts.
9160 \begin_inset Quotes eld
9164 \begin_inset Flex Code
9167 \begin_layout Plain Layout
9174 \begin_inset Quotes erd
9180 \begin_layout Description
9181 \begin_inset Flex Code
9184 \begin_layout Plain Layout
9191 \begin_inset Flex Code
9194 \begin_layout Plain Layout
9200 ] Specifies a module to be included by default with this document class.
9201 The module is specified as filename without the
9202 \begin_inset Flex Code
9205 \begin_layout Plain Layout
9212 The user can still remove the module, but it will be active at the outset.
9213 (This applies only when new files are created, or when this class is chosen
9214 for an existing document.)
9217 \begin_layout Description
9218 \begin_inset Flex Code
9221 \begin_layout Plain Layout
9228 \begin_inset Flex Code
9231 \begin_layout Plain Layout
9237 ] This is the style that will be assigned to new paragraphs, usually
9238 \begin_inset Flex Noun
9241 \begin_layout Plain Layout
9248 This will default to the first defined style if not given, but you are
9249 encouraged to use this directive.
9252 \begin_layout Description
9253 \begin_inset Flex Code
9256 \begin_layout Plain Layout
9263 \begin_inset Flex Code
9266 \begin_layout Plain Layout
9272 ] This tag indicates that the module (which is specified by filename without
9274 \begin_inset Flex Code
9277 \begin_layout Plain Layout
9283 extension) cannot be used with this document class.
9284 This might be used in a journal-specific layout file to prevent, say, the
9286 \begin_inset Flex Code
9289 \begin_layout Plain Layout
9295 module that numbers theorems by section.
9300 be used in a module.
9301 Modules have their own way of excluding other modules (see
9302 \begin_inset CommandInset ref
9304 reference "subsec:Layout-modules"
9311 \begin_layout Description
9312 \begin_inset Flex Code
9315 \begin_layout Plain Layout
9321 Defines a new float.
9323 \begin_inset CommandInset ref
9325 reference "subsec:Floats"
9331 \begin_inset Quotes eld
9335 \begin_inset Flex Code
9338 \begin_layout Plain Layout
9345 \begin_inset Quotes erd
9351 \begin_layout Description
9352 \begin_inset Flex Code
9355 \begin_layout Plain Layout
9361 Sets the information that will be output in the
9362 \begin_inset Flex Code
9365 \begin_layout Plain Layout
9371 block when this document class is output to XHTML.
9372 Note that this will completely override any prior
9373 \begin_inset Flex Code
9376 \begin_layout Plain Layout
9383 \begin_inset Flex Code
9386 \begin_layout Plain Layout
9394 \begin_inset Newline newline
9398 \begin_inset Flex Code
9401 \begin_layout Plain Layout
9407 if you just want to add material to the preamble.) Must end with
9408 \begin_inset Quotes eld
9412 \begin_inset Flex Code
9415 \begin_layout Plain Layout
9422 \begin_inset Quotes erd
9428 \begin_layout Description
9429 \begin_inset Flex Code
9432 \begin_layout Plain Layout
9439 \begin_inset Flex Code
9442 \begin_layout Plain Layout
9448 ] The style to use for the table of contents, bibliography, and so forth,
9449 when the document is output to HTML.
9450 For articles, this should normally be
9451 \begin_inset Flex Code
9454 \begin_layout Plain Layout
9461 \begin_inset Flex Code
9464 \begin_layout Plain Layout
9471 If it is not given, then \SpecialChar LyX
9472 will attempt to figure out which layout to use.
9475 \begin_layout Description
9476 \begin_inset Flex Code
9479 \begin_layout Plain Layout
9486 \begin_inset Flex Code
9489 \begin_layout Plain Layout
9495 ] Modifies the properties of the given counter.
9496 If the counter does not exist, the statement is ignored.
9498 \begin_inset Quotes eld
9502 \begin_inset Flex Code
9505 \begin_layout Plain Layout
9512 \begin_inset Quotes erd
9516 \begin_inset Newline newline
9520 \begin_inset CommandInset ref
9522 reference "subsec:Counters"
9526 for details on counters.
9529 \begin_layout Description
9530 \begin_inset Flex Code
9533 \begin_layout Plain Layout
9540 \begin_inset Flex Code
9543 \begin_layout Plain Layout
9549 ] This allows you to include another layout definition file within yours
9550 to avoid duplicating commands.
9551 Common examples are the standard layout files, for example,
9552 \begin_inset Flex Code
9555 \begin_layout Plain Layout
9561 , which contains most of the basic layouts.
9564 \begin_layout Description
9565 \begin_inset Flex Code
9568 \begin_layout Plain Layout
9575 \begin_inset Flex Code
9578 \begin_layout Plain Layout
9584 ] This section (re-)defines the layout of an inset.
9585 It can be applied to an existing inset or to a new, user-defined inset,
9586 e.g., a new character style.
9588 \begin_inset Quotes eld
9592 \begin_inset Flex Code
9595 \begin_layout Plain Layout
9602 \begin_inset Quotes erd
9606 \begin_inset Newline newline
9610 \begin_inset CommandInset ref
9612 reference "subsec:Flex-insets-and"
9616 for more information.
9620 \begin_layout Description
9621 \begin_inset Flex Code
9624 \begin_layout Plain Layout
9631 \begin_inset Flex Code
9634 \begin_layout Plain Layout
9640 ] A string that indicates the width of the left margin on the screen, for
9642 \begin_inset Quotes eld
9646 \begin_inset Flex Code
9649 \begin_layout Plain Layout
9656 \begin_inset Quotes erd
9660 (Note that this is not a `length', like
9661 \begin_inset Quotes eld
9665 \begin_inset Quotes erd
9671 \begin_layout Description
9672 \begin_inset Flex Code
9675 \begin_layout Plain Layout
9682 \begin_inset Flex Code
9685 \begin_layout Plain Layout
9691 ] An integer that determines the maximal number of names displayed in an
9692 author-year citation before the citation switches to
9693 \begin_inset Quotes eld
9697 \begin_inset Quotes erd
9701 Primarily used in cite engine files (see
9702 \begin_inset CommandInset ref
9704 reference "subsec:Cite-Engine-Files"
9714 \begin_layout Description
9715 \begin_inset Flex Code
9718 \begin_layout Plain Layout
9725 \begin_inset Flex Code
9728 \begin_layout Plain Layout
9734 ] Modifies the properties of the given paragraph style.
9735 If the style does not exist, this section is ignored.
9737 \begin_inset Quotes eld
9741 \begin_inset Flex Code
9744 \begin_layout Plain Layout
9751 \begin_inset Quotes erd
9757 \begin_layout Description
9758 \begin_inset Flex Code
9761 \begin_layout Plain Layout
9768 \begin_inset Flex Code
9771 \begin_layout Plain Layout
9777 ] Deletes an existing counter, usually one defined in an included file.
9780 \begin_layout Description
9781 \begin_inset Flex Code
9784 \begin_layout Plain Layout
9791 \begin_inset Flex Code
9794 \begin_layout Plain Layout
9800 ] Deletes an existing float.
9801 This is particularly useful when you want to suppress a float that has
9802 been defined in an input file.
9805 \begin_layout Description
9806 \begin_inset Flex Code
9809 \begin_layout Plain Layout
9816 \begin_inset Flex Code
9819 \begin_layout Plain Layout
9825 ] Deletes an existing style.
9828 \begin_layout Description
9829 \begin_inset Flex Code
9832 \begin_layout Plain Layout
9839 \begin_inset Flex Code
9842 \begin_layout Plain Layout
9849 \begin_inset Flex Code
9852 \begin_layout Plain Layout
9858 ] Define a new table of contents with type
9859 \begin_inset Flex Code
9862 \begin_layout Plain Layout
9869 \begin_inset Flex Code
9872 \begin_layout Plain Layout
9879 See also the AddToToc commands.
9882 \begin_layout Description
9883 \begin_inset Flex Code
9886 \begin_layout Plain Layout
9893 \begin_inset Flex Code
9896 \begin_layout Plain Layout
9902 ] The file format (as defined in the \SpecialChar LyX
9903 preferences) produced by this document
9905 It is mainly useful when
9906 \begin_inset Flex Code
9909 \begin_layout Plain Layout
9916 \begin_inset Flex Code
9919 \begin_layout Plain Layout
9925 and one wants to define a new type of literate document.
9926 The format is reset to
9927 \begin_inset Quotes eld
9931 \begin_inset Flex Code
9934 \begin_layout Plain Layout
9941 \begin_inset Quotes erd
9945 \begin_inset Quotes eld
9949 \begin_inset Flex Code
9952 \begin_layout Plain Layout
9959 \begin_inset Quotes erd
9962 when the corresponding
9963 \begin_inset Flex Code
9966 \begin_layout Plain Layout
9972 parameter is encountered.
9975 \begin_layout Description
9976 \begin_inset Flex Code
9979 \begin_layout Plain Layout
9986 \begin_inset Flex Code
9989 \begin_layout Plain Layout
10000 \begin_inset Flex Code
10003 \begin_layout Plain Layout
10010 \begin_inset Flex Code
10013 \begin_layout Plain Layout
10019 ] Specifies what sort of output documents using this class will produce.
10022 \begin_layout Description
10023 \begin_inset Flex Code
10026 \begin_layout Plain Layout
10033 \begin_inset Flex Code
10036 \begin_layout Plain Layout
10043 \begin_inset Flex Code
10046 \begin_layout Plain Layout
10052 ] Specifies options, given in the second string, for the package named by
10055 \begin_inset Quotes eld
10059 \begin_inset Flex Code
10062 \begin_layout Plain Layout
10063 PackageOptions natbib square
10069 \begin_inset Quotes erd
10073 \begin_inset Flex Code
10076 \begin_layout Plain Layout
10082 to be loaded with the
10083 \begin_inset Flex Code
10086 \begin_layout Plain Layout
10093 (For \SpecialChar TeX
10094 perts, this causes \SpecialChar LyX
10096 \begin_inset Flex Code
10099 \begin_layout Plain Layout
10102 PassOptionsToPackage{natbib}{square}
10108 \begin_inset Flex Code
10111 \begin_layout Plain Layout
10120 \begin_layout Description
10121 \begin_inset Flex Code
10124 \begin_layout Plain Layout
10131 \begin_inset Flex Code
10134 \begin_layout Plain Layout
10143 \begin_inset Flex Code
10146 \begin_layout Plain Layout
10153 \begin_inset Flex Code
10156 \begin_layout Plain Layout
10162 ] The default pagestyle.
10163 Can be changed in the
10164 \begin_inset Flex Noun
10167 \begin_layout Plain Layout
10168 Document\SpecialChar menuseparator
10177 \begin_layout Description
10178 \begin_inset Flex Code
10181 \begin_layout Plain Layout
10187 Sets the preamble for the \SpecialChar LaTeX
10189 Note that this will completely override any prior
10190 \begin_inset Flex Code
10193 \begin_layout Plain Layout
10200 \begin_inset Flex Code
10203 \begin_layout Plain Layout
10211 \begin_inset Flex Code
10214 \begin_layout Plain Layout
10220 if you just want to add material to the preamble.) Must end with
10221 \begin_inset Quotes eld
10225 \begin_inset Flex Code
10228 \begin_layout Plain Layout
10235 \begin_inset Quotes erd
10241 \begin_layout Description
10242 \begin_inset Flex Code
10245 \begin_layout Plain Layout
10252 \begin_inset Flex Code
10255 \begin_layout Plain Layout
10262 \begin_inset Flex Code
10265 \begin_layout Plain Layout
10274 \begin_inset space \thinspace{}
10278 \begin_inset Flex Code
10281 \begin_layout Plain Layout
10287 ] Whether the class already provides the feature
10288 \begin_inset Flex Code
10291 \begin_layout Plain Layout
10298 A feature is in general the name of a package (e.
10299 \begin_inset space \thinspace{}
10303 \begin_inset space \space{}
10307 \begin_inset Flex Code
10310 \begin_layout Plain Layout
10317 \begin_inset Flex Code
10320 \begin_layout Plain Layout
10327 \begin_inset space \thinspace{}
10331 \begin_inset space \space{}
10335 \begin_inset Flex Code
10338 \begin_layout Plain Layout
10345 \begin_inset Flex Code
10348 \begin_layout Plain Layout
10356 \begin_inset CommandInset ref
10358 reference "chap:List-of-functions"
10362 for the list of features.
10365 \begin_layout Description
10366 \begin_inset Flex Code
10369 \begin_layout Plain Layout
10376 \begin_inset Flex Code
10379 \begin_layout Plain Layout
10385 ] Indicates that this layout provides the functionality of the module mentioned,
10386 which should be specified by the filename without the
10387 \begin_inset Flex Code
10390 \begin_layout Plain Layout
10397 This will typically be used if the layout includes the module directly,
10398 rather than using the
10399 \begin_inset Flex Code
10402 \begin_layout Plain Layout
10408 tag to indicate that it ought to be used.
10409 It could also be used in a module that provided an alternate implementation
10410 of the same functionality.
10413 \begin_layout Description
10414 \begin_inset Flex Code
10417 \begin_layout Plain Layout
10424 \begin_inset Flex Code
10427 \begin_layout Plain Layout
10433 ] Creates a new paragraph style if it does not already exist.
10434 If the style does exist, this section is ignored.
10436 \begin_inset Quotes eld
10440 \begin_inset Flex Code
10443 \begin_layout Plain Layout
10450 \begin_inset Quotes erd
10456 \begin_layout Description
10457 \begin_inset Flex Code
10460 \begin_layout Plain Layout
10467 \begin_inset Flex Code
10470 \begin_layout Plain Layout
10476 ] Whether the class requires the feature
10477 \begin_inset Flex Code
10480 \begin_layout Plain Layout
10487 Multiple features must be separated by commas.
10488 Note that you can only request supported features.
10490 \begin_inset CommandInset ref
10492 reference "chap:List-of-functions"
10496 for the list of features.).
10497 If you require a package with specific options, you can additionally use
10499 \begin_inset Flex Code
10502 \begin_layout Plain Layout
10511 \begin_layout Description
10512 \begin_inset Flex Code
10515 \begin_layout Plain Layout
10522 \begin_inset Flex Code
10525 \begin_layout Plain Layout
10531 ] A string that indicates the width of the right margin on the screen, for
10533 \begin_inset Quotes eld
10537 \begin_inset Flex Code
10540 \begin_layout Plain Layout
10547 \begin_inset Quotes erd
10553 \begin_layout Description
10554 \begin_inset Flex Code
10557 \begin_layout Plain Layout
10564 \begin_inset Flex Code
10567 \begin_layout Plain Layout
10573 ] Sets which divisions get numbered.
10575 \begin_inset Newline newline
10579 \begin_inset Flex Code
10582 \begin_layout Plain Layout
10588 counter in \SpecialChar LaTeX
10592 \begin_layout Description
10593 \begin_inset Flex Code
10596 \begin_layout Plain Layout
10603 \begin_inset Flex Code
10606 \begin_layout Plain Layout
10615 \begin_inset space \thinspace{}
10619 \begin_inset Flex Code
10622 \begin_layout Plain Layout
10628 ] Whether the class-default should be printing on one or both sides of the
10630 Can be changed in the
10631 \begin_inset Flex Noun
10634 \begin_layout Plain Layout
10635 Document\SpecialChar menuseparator
10644 \begin_layout Description
10645 \begin_inset Flex Code
10648 \begin_layout Plain Layout
10655 \begin_inset Flex Code
10658 \begin_layout Plain Layout
10664 ] This sequence defines a paragraph style.
10665 If the style does not yet exist, it is created; if it does exist, its parameter
10668 \begin_inset Quotes eld
10672 \begin_inset Flex Code
10675 \begin_layout Plain Layout
10682 \begin_inset Quotes erd
10686 \begin_inset Newline newline
10690 \begin_inset CommandInset ref
10692 reference "subsec:Paragraph-Styles"
10696 for details on paragraph styles.
10699 \begin_layout Description
10700 \begin_inset Flex Code
10703 \begin_layout Plain Layout
10710 \begin_inset Flex Code
10713 \begin_layout Plain Layout
10719 ] The name of the command or environment to be used with
10720 \begin_inset Flex Code
10723 \begin_layout Plain Layout
10732 \begin_layout Description
10733 \begin_inset Flex Code
10736 \begin_layout Plain Layout
10743 \begin_inset Flex Code
10746 \begin_layout Plain Layout
10755 \begin_inset Flex Code
10758 \begin_layout Plain Layout
10764 ] Indicates what kind of markup is used to define the title of a document.
10766 \begin_inset Flex Code
10769 \begin_layout Plain Layout
10775 means that the macro with name
10776 \begin_inset Flex Code
10779 \begin_layout Plain Layout
10785 will be inserted after the last layout which has
10786 \begin_inset Quotes eld
10790 \begin_inset Flex Code
10793 \begin_layout Plain Layout
10795 \begin_inset space ~
10804 \begin_inset Quotes erd
10809 \begin_inset Flex Code
10812 \begin_layout Plain Layout
10818 corresponds to the case where all layouts which have
10819 \begin_inset Quotes eld
10823 \begin_inset Flex Code
10826 \begin_layout Plain Layout
10828 \begin_inset space ~
10837 \begin_inset Quotes erd
10840 should be enclosed into the
10841 \begin_inset Flex Code
10844 \begin_layout Plain Layout
10853 \begin_layout Description
10854 \begin_inset Flex Code
10857 \begin_layout Plain Layout
10864 \begin_inset Flex Code
10867 \begin_layout Plain Layout
10873 ] Sets which divisions are included in the table of contents.
10875 \begin_inset Flex Code
10878 \begin_layout Plain Layout
10884 counter in \SpecialChar LaTeX
10888 \begin_layout Subsection
10889 \begin_inset Flex Code
10892 \begin_layout Plain Layout
10899 \begin_inset CommandInset label
10901 name "subsec:ClassOptions"
10908 \begin_layout Standard
10910 \begin_inset Flex Code
10913 \begin_layout Plain Layout
10919 section can contain the following entries:
10922 \begin_layout Description
10923 \begin_inset Flex Code
10926 \begin_layout Plain Layout
10933 \begin_inset Flex Code
10936 \begin_layout Plain Layout
10942 ] The list of available font sizes for the document's main font, separated
10944 \begin_inset Quotes eld
10948 \begin_inset Flex Code
10951 \begin_layout Plain Layout
10958 \begin_inset Quotes erd
10964 \begin_layout Description
10965 \begin_inset Flex Code
10968 \begin_layout Plain Layout
10974 Used to set the DTD line with XML-based output classes.
10976 \begin_inset space \thinspace{}
10980 \begin_inset Quotes eld
10983 -//OASIS//DTD DocBook V4.2//EN
10984 \begin_inset Quotes erd
10990 \begin_layout Description
10991 \begin_inset Flex Code
10994 \begin_layout Plain Layout
11001 \begin_inset Flex Code
11004 \begin_layout Plain Layout
11005 string="empty|plain|headings|fancy"
11010 ] The list of available page sty\SpecialChar softhyphen
11012 \begin_inset Quotes eld
11016 \begin_inset Flex Code
11019 \begin_layout Plain Layout
11026 \begin_inset Quotes erd
11032 \begin_layout Description
11033 \begin_inset Flex Code
11036 \begin_layout Plain Layout
11043 \begin_inset Flex Code
11046 \begin_layout Plain Layout
11052 ] Some document class options, separated by a comma, that will be added
11053 to the optional part of the
11054 \begin_inset Flex Code
11057 \begin_layout Plain Layout
11068 \begin_layout Standard
11070 \begin_inset Flex Code
11073 \begin_layout Plain Layout
11079 section must end with
11080 \begin_inset Quotes eld
11084 \begin_inset Flex Code
11087 \begin_layout Plain Layout
11094 \begin_inset Quotes erd
11100 \begin_layout Subsection
11102 \begin_inset CommandInset label
11104 name "subsec:Paragraph-Styles"
11111 \begin_layout Standard
11112 A paragraph style description looks like this:
11116 \begin_layout Plain Layout
11117 Note that this will either define a new style or modify an existing one.
11125 \begin_layout LyX-Code
11132 \begin_layout LyX-Code
11136 \begin_layout LyX-Code
11140 \begin_layout Standard
11141 where the following commands are allowed:
11144 \begin_layout Description
11145 \begin_inset Flex Code
11148 \begin_layout Plain Layout
11155 \begin_inset Flex Code
11158 \begin_layout Plain Layout
11164 =""] This paragraph will appear in the table of contents of the given type.
11165 An empty string disables.
11166 See also the OutlinerName and the IsTocCaption commands.
11170 \begin_layout Description
11171 \begin_inset Flex Code
11174 \begin_layout Plain Layout
11181 \begin_inset Flex Code
11184 \begin_layout Plain Layout
11189 , left, right, center
11194 ] Paragraph alignment.
11197 \begin_layout Description
11198 \begin_inset Flex Code
11201 \begin_layout Plain Layout
11208 \begin_inset Flex Code
11211 \begin_layout Plain Layout
11216 , left, right, center
11221 ] A comma separated list of permitted alignments.
11222 (Some \SpecialChar LaTeX
11223 styles prohibit certain alignments, since those wouldn't make sense.
11224 For example a right-aligned or centered enumeration isn't possible.)
11227 \begin_layout Description
11228 \begin_inset Flex Code
11231 \begin_layout Plain Layout
11238 \begin_inset Flex Code
11241 \begin_layout Plain Layout
11247 ] Defines argument number <int> of a command\SpecialChar breakableslash
11248 environment associated with
11250 This is useful for things like section headings, and only makes sense with
11253 Every (optional or required) argument of a command or environment – except
11254 for the required argument that is associated with the content of the paragraph
11255 itself – has a separate definition, where the number specifies the order
11257 The definition must end with
11258 \begin_inset Flex Code
11261 \begin_layout Plain Layout
11268 So a command with two optional arguments has:
11272 \begin_layout Quote
11278 \begin_layout Quote
11284 \begin_layout Quote
11290 \begin_layout Quote
11296 \begin_layout Quote
11302 \begin_layout Quote
11308 \begin_layout Standard
11310 \begin_inset Flex Code
11313 \begin_layout Plain Layout
11319 definition, the following specifications are possible:
11322 \begin_layout Itemize
11323 \begin_inset Flex Code
11326 \begin_layout Plain Layout
11333 \begin_inset Flex Code
11336 \begin_layout Plain Layout
11342 The string that will appear both in the menu (to insert this argument)
11343 and on the argument inset button (unless you also specify a separate
11344 \begin_inset Flex Code
11347 \begin_layout Plain Layout
11354 For the menu, you can define an accelerator by appending the respective
11355 character to the string, divided by
11356 \begin_inset Quotes eld
11360 \begin_inset Quotes erd
11364 \begin_inset space \thinspace{}
11368 \begin_inset space \space{}
11372 \begin_inset Quotes eld
11376 \begin_inset Flex Code
11379 \begin_layout Plain Layout
11386 \begin_inset Quotes erd
11392 \begin_layout Itemize
11393 \begin_inset Flex Code
11396 \begin_layout Plain Layout
11403 \begin_inset Flex Code
11406 \begin_layout Plain Layout
11412 A separate string for the menu.
11413 You can define an accelerator by appending the respective character to
11414 the string, divided by
11415 \begin_inset Quotes eld
11419 \begin_inset Quotes erd
11423 \begin_inset space \thinspace{}
11427 \begin_inset space \space{}
11431 \begin_inset Quotes eld
11435 \begin_inset Flex Code
11438 \begin_layout Plain Layout
11445 \begin_inset Quotes erd
11449 This specification is optional.
11450 If it is not given the
11451 \begin_inset Flex Code
11454 \begin_layout Plain Layout
11460 will be used instead for the menu.
11463 \begin_layout Itemize
11464 \begin_inset Flex Code
11467 \begin_layout Plain Layout
11474 \begin_inset Flex Code
11477 \begin_layout Plain Layout
11483 A longer explanatory text that appears in the tooltip when hovering over
11484 the argument inset.
11487 \begin_layout Itemize
11488 \begin_inset Flex Code
11491 \begin_layout Plain Layout
11498 \begin_inset Flex Code
11501 \begin_layout Plain Layout
11510 \begin_inset space \thinspace{}
11514 \begin_inset Flex Code
11517 \begin_layout Plain Layout
11523 ] Declare if this is a mandatory (1) or an optional (0) argument.
11524 Mandatory arguments will be output empty if not given, while optional arguments
11525 will not be output at all.
11526 By default, mandatory arguments are delimited by
11527 \begin_inset Flex Code
11530 \begin_layout Plain Layout
11536 , while optional arguments are delimited by
11537 \begin_inset Flex Code
11540 \begin_layout Plain Layout
11549 \begin_layout Itemize
11550 \begin_inset Flex Code
11553 \begin_layout Plain Layout
11560 \begin_inset Flex Code
11563 \begin_layout Plain Layout
11569 defines another argument (by its number) which this argument requires to
11570 be output if it is itself output.
11572 \begin_inset space \thinspace{}
11575 g., in \SpecialChar LaTeX
11576 commands, optional arguments often require previous optional arguments
11577 to be output (at least empty), as in
11578 \begin_inset Flex Code
11581 \begin_layout Plain Layout
11584 command[][argument]{text}
11590 This can be achieved by the statement
11591 \begin_inset Flex Code
11594 \begin_layout Plain Layout
11601 \begin_inset Flex Code
11604 \begin_layout Plain Layout
11613 \begin_layout Itemize
11614 \begin_inset Flex Code
11617 \begin_layout Plain Layout
11624 \begin_inset Flex Code
11627 \begin_layout Plain Layout
11633 defines a custom left delimiter (instead of
11634 \begin_inset Flex Code
11637 \begin_layout Plain Layout
11644 \begin_inset Flex Code
11647 \begin_layout Plain Layout
11654 A line break in the output can be indicated by
11655 \begin_inset Flex Code
11658 \begin_layout Plain Layout
11667 \begin_layout Itemize
11668 \begin_inset Flex Code
11671 \begin_layout Plain Layout
11678 \begin_inset Flex Code
11681 \begin_layout Plain Layout
11687 defines a custom right delimiter (instead of
11688 \begin_inset Flex Code
11691 \begin_layout Plain Layout
11698 \begin_inset Flex Code
11701 \begin_layout Plain Layout
11708 A line break in the output can be indicated by
11709 \begin_inset Flex Code
11712 \begin_layout Plain Layout
11721 \begin_layout Itemize
11722 \begin_inset Flex Code
11725 \begin_layout Plain Layout
11732 \begin_inset Flex Code
11735 \begin_layout Plain Layout
11741 defines an argument that is inserted if and only if no user-specified arguments
11743 \begin_inset space \thinspace{}
11747 \begin_inset space \space{}
11750 if no argument inset has been inserted (note that also an empty argument
11751 inset omits the DefaultArg).
11752 Multiple arguments need to be separated by comma.
11755 \begin_layout Itemize
11756 \begin_inset Flex Code
11759 \begin_layout Plain Layout
11766 \begin_inset Flex Code
11769 \begin_layout Plain Layout
11775 defines an argument that is inserted in any case (alone or in addition
11776 to user-specified arguments).
11777 Multiple arguments need to be separated by comma.
11780 \begin_layout Itemize
11781 \begin_inset Flex Code
11784 \begin_layout Plain Layout
11790 The font used for the argument content, see
11791 \begin_inset CommandInset ref
11793 reference "subsec:Font-description"
11800 \begin_layout Itemize
11801 \begin_inset Flex Code
11804 \begin_layout Plain Layout
11810 The font used for the label; see
11811 \begin_inset CommandInset ref
11813 reference "subsec:Font-description"
11820 \begin_layout Itemize
11821 \begin_inset Flex Code
11824 \begin_layout Plain Layout
11831 \begin_inset Flex Code
11834 \begin_layout Plain Layout
11839 , Minimalistic, Conglomerate
11844 ] describes the rendering style used for the inset's frame and buttons.
11847 \begin_layout Itemize
11848 \begin_inset Flex Code
11851 \begin_layout Plain Layout
11858 \begin_inset Flex Code
11861 \begin_layout Plain Layout
11868 \begin_inset Flex Code
11871 \begin_layout Plain Layout
11877 , this argument is automatically inserted when the respective style is selected.
11878 Currently, only one argument per style\SpecialChar breakableslash
11879 layout can be automatically inserted.
11882 \begin_layout Itemize
11883 \begin_inset Flex Code
11886 \begin_layout Plain Layout
11893 \begin_inset Flex Code
11896 \begin_layout Plain Layout
11903 \begin_inset Flex Code
11906 \begin_layout Plain Layout
11912 , this argument will be inserted with a copy of the co-text (either selected
11913 text or the whole paragraph) as content.
11916 \begin_layout Itemize
11917 \begin_inset Flex Code
11920 \begin_layout Plain Layout
11927 \begin_inset Flex Code
11930 \begin_layout Plain Layout
11940 ] Whether the contents of this argument should be output in raw form, meaning
11941 without special translations that \SpecialChar LaTeX
11944 \begin_inset Flex Code
11947 \begin_layout Plain Layout
11953 status is inherited by the inset or paragraph layout the argument belongs
11954 to, true and false change the status for the given argument only.
11957 \begin_layout Itemize
11958 \begin_inset Flex Code
11961 \begin_layout Plain Layout
11968 \begin_inset Flex Code
11971 \begin_layout Plain Layout
11972 string of characters
11981 Defines individual characters that should be output in raw form, meaning
11982 without special translations that \SpecialChar LaTeX
11984 Note that, contrary to PassThru, this needs to be explicitly defined for
11986 That is, arguments do not inherit PassThruChars from their parent inset
11990 \begin_layout Itemize
11991 \begin_inset Flex Code
11994 \begin_layout Plain Layout
12001 \begin_inset Flex Code
12004 \begin_layout Plain Layout
12013 \begin_inset space \thinspace{}
12017 \begin_inset Flex Code
12020 \begin_layout Plain Layout
12026 ] If this is set to 1, the argument will output its content in the corresponding
12027 item in the table of contents.
12031 \begin_layout Standard
12032 By default, the text entered in the \SpecialChar LyX
12033 workarea in the respective layout is
12034 the last (mandatory) argument of a command if the
12035 \begin_inset Flex Code
12038 \begin_layout Plain Layout
12045 \begin_inset Flex Code
12048 \begin_layout Plain Layout
12055 However, arguments with the prefix
12056 \begin_inset Flex Code
12059 \begin_layout Plain Layout
12065 are output after this workarea argument.
12066 Note that post-argument numbering restarts at 1, so the first argument
12067 following the workarea argument is
12068 \begin_inset Flex Code
12071 \begin_layout Plain Layout
12078 Post-arguments are ignored in any other
12079 \begin_inset Flex Code
12082 \begin_layout Plain Layout
12089 \begin_inset Flex Code
12092 \begin_layout Plain Layout
12101 \begin_layout Standard
12103 \begin_inset Flex Code
12106 \begin_layout Plain Layout
12115 \begin_inset Flex Code
12118 \begin_layout Plain Layout
12127 \begin_inset Flex Code
12130 \begin_layout Plain Layout
12136 followed by the number (e.
12137 \begin_inset space \thinspace{}
12141 \begin_inset space \space{}
12145 \begin_inset Flex Code
12148 \begin_layout Plain Layout
12158 \begin_layout Description
12159 \begin_inset Flex Code
12162 \begin_layout Plain Layout
12168 Note that this will completely override any prior
12169 \begin_inset Flex Code
12172 \begin_layout Plain Layout
12178 declaration for this style.
12180 \begin_inset Quotes eld
12184 \begin_inset Flex Code
12187 \begin_layout Plain Layout
12194 \begin_inset Quotes erd
12199 \begin_inset CommandInset ref
12201 reference "subsec:I18n"
12205 for details on its use.
12208 \begin_layout Description
12209 \begin_inset Flex Code
12212 \begin_layout Plain Layout
12219 \begin_inset Flex Code
12222 \begin_layout Plain Layout
12232 \begin_layout Plain Layout
12233 Note that a `float' here is a real number, such as: 1.5.
12238 The vertical space with which the last of a chain of paragraphs with this
12239 style is separated from the following paragraph.
12240 If the next paragraph has another style, the separations are not simply
12241 added, but the maximum is taken.
12244 \begin_layout Description
12245 \begin_inset Flex Code
12248 \begin_layout Plain Layout
12255 \begin_inset Flex Code
12258 \begin_layout Plain Layout
12264 ] The category for this style.
12265 This is used to group related styles in the style combobox on the toolbar.
12266 Any string can be used, but you may want to use existing categories with
12271 \begin_layout Description
12272 \begin_inset Flex Code
12275 \begin_layout Plain Layout
12281 Depth of XML command.
12282 Used only with XML-type formats.
12285 \begin_layout Description
12286 \begin_inset Flex Code
12289 \begin_layout Plain Layout
12296 \begin_inset Flex Code
12299 \begin_layout Plain Layout
12305 ] Copies all the features of an existing style into the current one.
12309 \begin_layout Description
12310 \begin_inset Flex Code
12313 \begin_layout Plain Layout
12320 \begin_inset Flex Code
12323 \begin_layout Plain Layout
12329 ] The name of a style whose preamble should be output
12334 This allows to ensure some ordering of the preamble snippets when macros
12335 definitions depend on one another.
12339 \begin_layout Plain Layout
12340 Note that, besides that functionality, there is no way to ensure any ordering
12342 The ordering that you see in a given version of \SpecialChar LyX
12343 may change without warning
12352 \begin_layout Description
12353 \begin_inset Flex Code
12356 \begin_layout Plain Layout
12363 \begin_inset Flex Code
12366 \begin_layout Plain Layout
12371 , Box, Filled_Box, Static
12376 ] The type of label that stands at the end of the paragraph (or sequence
12378 \begin_inset Flex Code
12381 \begin_layout Plain Layout
12388 \begin_inset Newline newline
12392 \begin_inset Flex Code
12395 \begin_layout Plain Layout
12402 \begin_inset Flex Code
12405 \begin_layout Plain Layout
12412 \begin_inset Flex Code
12415 \begin_layout Plain Layout
12423 \begin_inset Flex Code
12426 \begin_layout Plain Layout
12433 \begin_inset Quotes eld
12437 \begin_inset Quotes erd
12441 \begin_inset Flex Code
12444 \begin_layout Plain Layout
12451 \begin_inset space \space{}
12455 \begin_inset Flex Code
12458 \begin_layout Plain Layout
12464 ) is a white (resp.
12465 \begin_inset space ~
12468 black) square suitable for end of proof markers,
12469 \begin_inset Flex Code
12472 \begin_layout Plain Layout
12478 is an explicit text string.
12481 \begin_layout Description
12482 \begin_inset Flex Code
12485 \begin_layout Plain Layout
12492 \begin_inset Flex Code
12495 \begin_layout Plain Layout
12501 ] The string used for a label with a
12502 \begin_inset Flex Code
12505 \begin_layout Plain Layout
12512 \begin_inset Newline newline
12516 \begin_inset Flex Code
12519 \begin_layout Plain Layout
12529 \begin_layout Description
12530 \begin_inset Flex Code
12533 \begin_layout Plain Layout
12539 The font used for both the text body
12545 \begin_inset CommandInset ref
12547 reference "subsec:Font-description"
12552 Note that defining this font automatically defines the
12553 \begin_inset Flex Code
12556 \begin_layout Plain Layout
12563 So you should define this one first if you also want to define
12564 \begin_inset Flex Code
12567 \begin_layout Plain Layout
12576 \begin_layout Description
12577 \begin_inset Flex Code
12580 \begin_layout Plain Layout
12587 \begin_inset Flex Code
12590 \begin_layout Plain Layout
12596 ] Used for backporting new styles to stable \SpecialChar LyX
12598 The first stable version that supports this tag is \SpecialChar LyX
12600 The argument is a number which may either be 0, -1 or any value greater
12603 \begin_inset Flex Code
12606 \begin_layout Plain Layout
12612 flag of a style is greater than zero, it will always be written to the
12614 If a .lyx file is read, the style definitions from the document header are
12615 added to the document class.
12616 Therefore even older \SpecialChar LyX
12617 versions can handle the style.
12619 \begin_inset Flex Code
12622 \begin_layout Plain Layout
12628 is a version number: if the style is read, and the version number is less
12629 than the version number of the already existing style in the document class,
12630 the new style is ignored.
12631 If the version number is greater, the new style replaces the existing style.
12632 A value of -1 means an infinite version number, i.
12633 \begin_inset space \thinspace{}
12637 \begin_inset space \space{}
12640 the style is always used.
12643 \begin_layout Description
12644 \begin_inset Flex Code
12647 \begin_layout Plain Layout
12654 \begin_inset Flex Code
12657 \begin_layout Plain Layout
12666 \begin_inset space \thinspace{}
12670 \begin_inset Flex Code
12673 \begin_layout Plain Layout
12679 ] Usually \SpecialChar LyX
12680 does not allow you to insert more than one space between words,
12681 since a space is considered as the separation between two words, not a
12682 character or symbol of its own.
12683 This is a very fine thing but sometimes annoying, for example, when typing
12684 program code or plain \SpecialChar LaTeX
12687 \begin_inset Flex Code
12690 \begin_layout Plain Layout
12697 Note that \SpecialChar LyX
12698 will create protected blanks for the additional blanks when
12699 in another mode than \SpecialChar LaTeX
12703 \begin_layout Description
12704 \begin_inset Flex Code
12707 \begin_layout Plain Layout
12713 These tags are used with XHTML output.
12715 \begin_inset CommandInset ref
12717 reference "subsec:Paragraph-Style-XHTML"
12724 \begin_layout Description
12725 \begin_inset Flex Code
12728 \begin_layout Plain Layout
12734 [FIXME] (Used only with XML-type formats.)
12737 \begin_layout Description
12738 \begin_inset Flex Code
12741 \begin_layout Plain Layout
12748 \begin_inset Flex Code
12751 \begin_layout Plain Layout
12760 \begin_inset space \thinspace{}
12764 \begin_inset Flex Code
12767 \begin_layout Plain Layout
12774 \begin_inset Flex Code
12777 \begin_layout Plain Layout
12783 , marks the style as to be included in the document preamble and not in
12785 This is useful for document classes that want such information as the title
12786 and author to appear in the preamble.
12787 Note that this works only for styles for which the
12788 \begin_inset Flex Code
12791 \begin_layout Plain Layout
12798 \begin_inset Flex Code
12801 \begin_layout Plain Layout
12808 \begin_inset Flex Code
12811 \begin_layout Plain Layout
12820 \begin_layout Description
12821 \begin_inset Flex Code
12824 \begin_layout Plain Layout
12831 \begin_inset Flex Code
12834 \begin_layout Plain Layout
12843 \begin_inset space \thinspace{}
12847 \begin_inset Flex Code
12850 \begin_layout Plain Layout
12857 \begin_inset Flex Code
12860 \begin_layout Plain Layout
12866 , marks the style as being part of a title block (see also the
12867 \begin_inset Flex Code
12870 \begin_layout Plain Layout
12877 \begin_inset Flex Code
12880 \begin_layout Plain Layout
12889 \begin_layout Description
12890 \begin_inset Flex Code
12893 \begin_layout Plain Layout
12900 \begin_inset Flex Code
12903 \begin_layout Plain Layout
12912 \begin_inset space \thinspace{}
12916 \begin_inset Flex Code
12919 \begin_layout Plain Layout
12925 ] If this is set to 1 and AddToToc is enabled, the paragraph adds a summary
12926 of its contents in its item in the table of contents.
12927 Otherwise, only the label, if it exists, appears.
12930 \begin_layout Description
12931 \begin_inset Flex Code
12934 \begin_layout Plain Layout
12941 \begin_inset Flex Code
12944 \begin_layout Plain Layout
12950 ] The \SpecialChar LaTeX
12951 command sequence declaring an item in a list.
12952 The command is to be defined without the preceding backslash (the default
12954 \begin_inset Quotes eld
12958 \begin_inset Quotes erd
12962 \begin_inset Flex Code
12965 \begin_layout Plain Layout
12973 in the \SpecialChar LaTeX
12977 \begin_layout Description
12978 \begin_inset Flex Code
12981 \begin_layout Plain Layout
12988 \begin_inset Flex Code
12991 \begin_layout Plain Layout
12997 ] This provides extra space between paragraphs that have the same style.
12998 If you put other styles into an environment, each is separated with the
13000 \begin_inset Flex Code
13003 \begin_layout Plain Layout
13010 But the whole items of the environment are additionally separated with
13012 \begin_inset Flex Code
13015 \begin_layout Plain Layout
13022 Note that this is a
13027 \begin_layout Description
13028 \begin_inset Flex Code
13031 \begin_layout Plain Layout
13037 [FIXME] (Used only with XML-type formats.)
13040 \begin_layout Description
13041 \begin_inset Flex Code
13044 \begin_layout Plain Layout
13051 \begin_inset Flex Code
13054 \begin_layout Plain Layout
13063 \begin_inset space \thinspace{}
13067 \begin_inset Flex Code
13070 \begin_layout Plain Layout
13076 ] Usually \SpecialChar LyX
13077 does not allow you to leave a paragraph empty, since it would
13078 lead to empty \SpecialChar LaTeX
13080 There are some cases where this could be desirable however: in a letter
13081 template, the required fields can be provided as empty fields, so that
13082 people do not forget them; in some special classes, a style can be used
13083 as some kind of break, which does not contain actual text.
13086 \begin_layout Description
13087 \begin_inset Flex Code
13090 \begin_layout Plain Layout
13097 \begin_inset Flex Code
13100 \begin_layout Plain Layout
13106 ] The vertical space between the label and the text body.
13107 Only used for labels that are above the text body (
13108 \begin_inset Flex Code
13111 \begin_layout Plain Layout
13118 \begin_inset Newline newline
13122 \begin_inset Flex Code
13125 \begin_layout Plain Layout
13126 Centered_Top_Environment
13134 \begin_layout Description
13135 \begin_inset Flex Code
13138 \begin_layout Plain Layout
13145 \begin_inset Flex Code
13148 \begin_layout Plain Layout
13154 ] The name of the counter for automatic numbering.
13155 In order to have the counter appear with your label, you will need to reference
13157 \begin_inset Flex Code
13160 \begin_layout Plain Layout
13169 This will work with
13170 \begin_inset Flex Code
13173 \begin_layout Plain Layout
13180 \begin_inset Flex Code
13183 \begin_layout Plain Layout
13190 \begin_inset Flex Code
13193 \begin_layout Plain Layout
13200 \begin_inset Flex Code
13203 \begin_layout Plain Layout
13210 \begin_inset Newline newline
13218 \begin_inset Flex Code
13221 \begin_layout Plain Layout
13228 \begin_inset Flex Code
13231 \begin_layout Plain Layout
13237 , though this case is a bit complicated.
13238 Suppose you declare
13239 \begin_inset Quotes eld
13243 \begin_inset Flex Code
13246 \begin_layout Plain Layout
13247 LabelCounter myenum
13253 \begin_inset Quotes erd
13257 Then the actual counters used are
13258 \begin_inset Flex Code
13261 \begin_layout Plain Layout
13268 \begin_inset Flex Code
13271 \begin_layout Plain Layout
13278 \begin_inset Flex Code
13281 \begin_layout Plain Layout
13288 \begin_inset Flex Code
13291 \begin_layout Plain Layout
13297 , much as in \SpecialChar LaTeX
13299 These counters must all be declared separately.
13300 \begin_inset Newline newline
13304 \begin_inset CommandInset ref
13306 reference "subsec:Counters"
13310 for details on counters.
13313 \begin_layout Description
13314 \begin_inset Flex Code
13317 \begin_layout Plain Layout
13323 The font used for the label.
13325 \begin_inset CommandInset ref
13327 reference "subsec:Font-description"
13334 \begin_layout Description
13335 \begin_inset Flex Code
13338 \begin_layout Plain Layout
13345 \begin_inset Flex Code
13348 \begin_layout Plain Layout
13354 ] Text that indicates how far a label should be indented.
13357 \begin_layout Description
13358 \begin_inset Flex Code
13361 \begin_layout Plain Layout
13368 \begin_inset Flex Code
13371 \begin_layout Plain Layout
13377 ] Text that indicates the amount of horizontal space between the label and
13379 Only used for labels that are not above the text body.
13382 \begin_layout Description
13383 \begin_inset Flex Code
13386 \begin_layout Plain Layout
13393 \begin_inset Flex Code
13396 \begin_layout Plain Layout
13402 ] The string used for the label.
13404 \begin_inset Flex Code
13407 \begin_layout Plain Layout
13413 is set, this string can be contain the special formatting commands described
13415 \begin_inset CommandInset ref
13417 reference "subsec:Counters"
13424 \begin_layout Description
13425 \begin_inset Flex Code
13428 \begin_layout Plain Layout
13429 LabelStringAppendix
13435 \begin_inset Flex Code
13438 \begin_layout Plain Layout
13444 ] This is used inside the appendix instead of
13445 \begin_inset Newline newline
13449 \begin_inset Flex Code
13452 \begin_layout Plain Layout
13460 \begin_inset Flex Code
13463 \begin_layout Plain Layout
13470 \begin_inset Newline newline
13474 \begin_inset Flex Code
13477 \begin_layout Plain Layout
13478 LabelStringAppendix
13486 \begin_layout Description
13487 \begin_inset Flex Code
13490 \begin_layout Plain Layout
13496 [FIXME] (Used only with XML-type formats.)
13499 \begin_layout Description
13500 \begin_inset Flex Code
13503 \begin_layout Plain Layout
13510 \begin_inset Flex Code
13513 \begin_layout Plain Layout
13518 , Manual, Static, Above,
13519 \begin_inset Newline newline
13522 Centered, Sensitive, Enumerate,
13523 \begin_inset Newline newline
13526 Itemize, Bibliography
13535 \begin_layout Description
13536 \begin_inset Flex Code
13539 \begin_layout Plain Layout
13545 means the label is the very first word (up to the first real blank).
13546 Use protected spaces if you want more than one word as the label.
13550 \begin_layout Description
13551 \begin_inset Flex Code
13554 \begin_layout Plain Layout
13560 means the label is simply what is declared as
13561 \begin_inset Flex Code
13564 \begin_layout Plain Layout
13571 This will be displayed
13572 \begin_inset Quotes eld
13576 \begin_inset Quotes erd
13579 , at the beginning of the paragraph.
13581 \begin_inset Flex Code
13584 \begin_layout Plain Layout
13591 \begin_inset Flex Code
13594 \begin_layout Plain Layout
13600 , then it will be displayed only in the first paragraph of any sequence
13601 of paragraphs with the same
13602 \begin_inset Flex Code
13605 \begin_layout Plain Layout
13614 \begin_layout Description
13615 \begin_inset Flex Code
13618 \begin_layout Plain Layout
13625 \begin_inset space ~
13629 \begin_inset space ~
13633 \begin_inset Flex Code
13636 \begin_layout Plain Layout
13642 are special cases of
13643 \begin_inset Flex Code
13646 \begin_layout Plain Layout
13653 The label will be printed above the paragraph either at the beginning of
13654 the line or centered.
13657 \begin_layout Description
13658 \begin_inset Flex Code
13661 \begin_layout Plain Layout
13667 is a special case for the caption-labels
13668 \begin_inset Quotes eld
13672 \begin_inset Quotes erd
13676 \begin_inset Quotes eld
13680 \begin_inset Quotes erd
13684 \begin_inset Newline newline
13688 \begin_inset Flex Code
13691 \begin_layout Plain Layout
13697 means the (hardcoded) label string depends on the kind of float: It is
13698 hardcoded to be `FloatType N', where N is the value of the counter associated
13700 For the case that a caption is inserted outside of a float the
13701 \begin_inset Flex Code
13704 \begin_layout Plain Layout
13711 \begin_inset Quotes eld
13715 \begin_inset Quotes erd
13721 \begin_layout Description
13722 \begin_inset Flex Code
13725 \begin_layout Plain Layout
13731 produces the usual sort of enumeration labels.
13732 At present, it is hardcoded to use Arabic numerals, lowercase letters,
13733 small Roman numerals, and uppercase letters for the four possible depths.
13736 \begin_layout Description
13737 \begin_inset Flex Code
13740 \begin_layout Plain Layout
13746 produces various bullets at the different levels.
13747 It is also hardcoded.
13750 \begin_layout Description
13751 \begin_inset Flex Code
13754 \begin_layout Plain Layout
13760 should be used only with
13761 \begin_inset Flex Code
13764 \begin_layout Plain Layout
13765 LatexType BibEnvironment
13774 \begin_layout Description
13775 \begin_inset Flex Code
13778 \begin_layout Plain Layout
13784 Note that this will completely override any prior
13785 \begin_inset Flex Code
13788 \begin_layout Plain Layout
13794 declaration for this style.
13796 \begin_inset Quotes eld
13800 \begin_inset Flex Code
13803 \begin_layout Plain Layout
13810 \begin_inset Quotes erd
13815 \begin_inset CommandInset ref
13817 reference "subsec:I18n"
13821 for details on its use.
13824 \begin_layout Description
13825 \begin_inset Flex Code
13828 \begin_layout Plain Layout
13835 \begin_inset Flex Code
13838 \begin_layout Plain Layout
13844 ] The name of the corresponding \SpecialChar LaTeX
13846 Either the environment or command name.
13849 \begin_layout Description
13850 \begin_inset Flex Code
13853 \begin_layout Plain Layout
13860 \begin_inset Flex Code
13863 \begin_layout Plain Layout
13869 ] An optional parameter for the corresponding
13870 \begin_inset Flex Code
13873 \begin_layout Plain Layout
13880 This parameter cannot be changed from within \SpecialChar LyX
13882 \begin_inset Flex Code
13885 \begin_layout Plain Layout
13891 for customizable parameters).
13892 This will be output as is after all \SpecialChar LaTeX
13894 \begin_inset Flex Code
13897 \begin_layout Plain Layout
13906 \begin_layout Description
13907 \begin_inset Flex Code
13910 \begin_layout Plain Layout
13917 \begin_inset Flex Code
13920 \begin_layout Plain Layout
13925 , Command, Environment, Item_Environment,
13926 \begin_inset Newline newline
13929 List_Environment, Bib_Environment
13934 ] How the style should be translated into \SpecialChar LaTeX
13939 \begin_layout Plain Layout
13940 \begin_inset Flex Code
13943 \begin_layout Plain Layout
13949 is perhaps a bit misleading, since these rules apply to SGML classes, too.
13950 Visit the SGML class files for specific examples.
13959 \begin_layout Description
13960 \begin_inset Flex Code
13963 \begin_layout Plain Layout
13969 means nothing special.
13972 \begin_layout Description
13973 \begin_inset Flex Code
13976 \begin_layout Plain Layout
13983 \begin_inset Flex Code
13986 \begin_layout Plain Layout
13993 {\SpecialChar ldots
14002 \begin_layout Description
14003 \begin_inset Flex Code
14006 \begin_layout Plain Layout
14013 \begin_inset Flex Code
14016 \begin_layout Plain Layout
14023 }\SpecialChar ldots
14039 \begin_layout Description
14040 \begin_inset Flex Code
14043 \begin_layout Plain Layout
14050 \begin_inset Flex Code
14053 \begin_layout Plain Layout
14060 \begin_inset Flex Code
14063 \begin_layout Plain Layout
14071 is generated for each paragraph of this environment.
14075 \begin_layout Description
14076 \begin_inset Flex Code
14079 \begin_layout Plain Layout
14086 \begin_inset Flex Code
14089 \begin_layout Plain Layout
14096 \begin_inset Newline newline
14100 \begin_inset Flex Code
14103 \begin_layout Plain Layout
14109 is passed as an argument to the environment.
14110 \begin_inset Newline newline
14114 \begin_inset Flex Code
14117 \begin_layout Plain Layout
14123 can be defined in the
14124 \begin_inset Flex Noun
14127 \begin_layout Plain Layout
14128 Edit\SpecialChar menuseparator
14130 \begin_inset space ~
14141 \begin_layout Description
14142 \begin_inset Flex Code
14145 \begin_layout Plain Layout
14152 \begin_inset Flex Code
14155 \begin_layout Plain Layout
14161 but adds the necessary mandatory argument (the longest label) to the begin
14162 statement of the bibliography environment:
14163 \begin_inset Newline newline
14167 \begin_inset Flex Code
14170 \begin_layout Plain Layout
14173 begin{thebibliography}{99}
14179 It is therefore only useful for bibliography environments.
14180 The default longest label
14181 \begin_inset Quotes eld
14185 \begin_inset Quotes erd
14188 can be changed by the user in the paragraph settings of a bibliography
14192 \begin_layout Standard
14193 Putting the last few things together, the \SpecialChar LaTeX
14194 output will be either:
14197 \begin_layout LyX-Code
14200 LatexName[LatexParam]{\SpecialChar ldots
14204 \begin_layout Standard
14208 \begin_layout LyX-Code
14211 begin{LatexName}[LatexParam] \SpecialChar ldots
14217 \begin_layout Standard
14218 depending upon the \SpecialChar LaTeX
14223 \begin_layout Description
14224 \begin_inset Flex Code
14227 \begin_layout Plain Layout
14234 \begin_inset Flex Code
14237 \begin_layout Plain Layout
14243 ] A string that is put at the beginning of the style content.
14244 A line break in the output can be indicated by
14245 \begin_inset Flex Code
14248 \begin_layout Plain Layout
14257 \begin_layout Description
14258 \begin_inset Flex Code
14261 \begin_layout Plain Layout
14268 \begin_inset Flex Code
14271 \begin_layout Plain Layout
14277 ] If you put styles into environments, the different
14278 \begin_inset Flex Code
14281 \begin_layout Plain Layout
14287 are not simply added, but added with a factor
14288 \begin_inset Formula $\frac{4}{\mathrm{depth}+4}$
14292 Note that this parameter is also used when
14293 \begin_inset Flex Code
14296 \begin_layout Plain Layout
14303 \begin_inset Flex Code
14306 \begin_layout Plain Layout
14313 \begin_inset Flex Code
14316 \begin_layout Plain Layout
14323 Then it is added to the manual or dynamic margin.
14324 \begin_inset Newline newline
14328 \begin_inset Quotes eld
14332 \begin_inset Flex Code
14335 \begin_layout Plain Layout
14342 \begin_inset Quotes erd
14345 means that the paragraph is indented with the width of
14346 \begin_inset Quotes eld
14350 \begin_inset Flex Code
14353 \begin_layout Plain Layout
14360 \begin_inset Quotes erd
14363 in the normal font.
14364 You can get a negative width by prefixing the string with
14365 \begin_inset Quotes eld
14369 \begin_inset Flex Code
14372 \begin_layout Plain Layout
14379 \begin_inset Quotes erd
14383 This way was chosen so that the look is the same with each used screen
14387 \begin_layout Description
14388 \begin_inset Flex Code
14391 \begin_layout Plain Layout
14398 \begin_inset Flex Code
14401 \begin_layout Plain Layout
14406 , Manual, Dynamic, First_Dynamic, Right_Address_Box
14412 \begin_inset Newline newline
14415 The kind of margin that the style has on the left side.
14419 \begin_layout Description
14420 \begin_inset Flex Code
14423 \begin_layout Plain Layout
14429 just means a fixed margin.
14432 \begin_layout Description
14433 \begin_inset Flex Code
14436 \begin_layout Plain Layout
14442 means that the left margin depends on the string entered in the
14443 \begin_inset Flex Noun
14446 \begin_layout Plain Layout
14447 Edit\SpecialChar menuseparator
14449 \begin_inset space ~
14458 This is used to typeset nice lists without tabulators.
14461 \begin_layout Description
14462 \begin_inset Flex Code
14465 \begin_layout Plain Layout
14471 means that the margin depends on the size of the label.
14472 This is used for automatic enumerated headlines.
14473 It is obvious that the headline
14474 \begin_inset Quotes eld
14477 5.4.3.2.1 Very long headline
14478 \begin_inset Quotes erd
14481 must have a wider left margin (as wide as
14482 \begin_inset Quotes eld
14486 \begin_inset Quotes erd
14489 plus the space) than
14490 \begin_inset Quotes eld
14493 3.2 Very long headline
14494 \begin_inset Quotes erd
14498 \begin_inset Quotes eld
14502 \begin_inset Quotes erd
14505 are not able to do this.
14508 \begin_layout Description
14509 \begin_inset Flex Code
14512 \begin_layout Plain Layout
14518 is similar, but only the very first row of the paragraph is dynamic, while
14519 the others are static; this is used, for example, for descriptions.
14522 \begin_layout Description
14523 \begin_inset Flex Code
14526 \begin_layout Plain Layout
14532 means the margin is chosen in a way that the longest row of this paragraph
14533 fits to the right margin.
14534 This is used to typeset an address on the right edge of the page.
14538 \begin_layout Description
14539 \begin_inset Flex Code
14542 \begin_layout Plain Layout
14549 \begin_inset Flex Code
14552 \begin_layout Plain Layout
14561 \begin_inset space \thinspace{}
14565 \begin_inset Flex Code
14568 \begin_layout Plain Layout
14574 ] Whether fragile commands in this style should be
14575 \begin_inset Flex Code
14578 \begin_layout Plain Layout
14591 whether this command should itself be protected.)
14594 \begin_layout Description
14595 \begin_inset Flex Code
14598 \begin_layout Plain Layout
14605 \begin_inset Flex Code
14608 \begin_layout Plain Layout
14615 \begin_inset space \thinspace{}
14619 \begin_inset Flex Code
14622 \begin_layout Plain Layout
14630 ] Whether newlines are translated into \SpecialChar LaTeX
14632 \begin_inset Flex Code
14635 \begin_layout Plain Layout
14646 The translation can be switched off to allow more comfortable \SpecialChar LaTeX
14648 inside \SpecialChar LyX
14652 \begin_layout Description
14653 \begin_inset Flex Code
14656 \begin_layout Plain Layout
14663 \begin_inset Flex Code
14666 \begin_layout Plain Layout
14675 \begin_inset space \thinspace{}
14679 \begin_inset Flex Code
14682 \begin_layout Plain Layout
14688 ] If set to true, and if
14689 \begin_inset Flex Code
14692 \begin_layout Plain Layout
14699 \begin_inset Flex Code
14702 \begin_layout Plain Layout
14708 ) paragraphs are being indented, then the indentation of such a paragraph
14709 following one of this type will be suppressed.
14710 (So this will not affect the display of non-default paragraphs.)
14713 \begin_layout Description
14714 \begin_inset Flex Code
14717 \begin_layout Plain Layout
14724 \begin_inset Flex Code
14727 \begin_layout Plain Layout
14733 ] Name of a style that has replaced this style.
14734 This is used to rename a style, while keeping backward compatibility.
14737 \begin_layout Description
14738 \begin_inset Flex Code
14741 \begin_layout Plain Layout
14748 \begin_inset Flex Code
14751 \begin_layout Plain Layout
14758 \begin_inset space \thinspace{}
14762 \begin_inset Flex Code
14765 \begin_layout Plain Layout
14771 ] Determines whether consecutive pragraphs of the same type are treated
14772 as belonging together.
14773 This has the effect that the
14774 \begin_inset Flex Code
14777 \begin_layout Plain Layout
14783 is only printed once before such a group.
14784 By default, this is true for
14785 \begin_inset Flex Code
14788 \begin_layout Plain Layout
14795 \begin_inset Flex Code
14798 \begin_layout Plain Layout
14805 \begin_inset Flex Code
14808 \begin_layout Plain Layout
14814 and false for all other types.
14817 \begin_layout Description
14818 \begin_inset Flex Code
14821 \begin_layout Plain Layout
14828 \begin_inset Flex Code
14831 \begin_layout Plain Layout
14840 \begin_inset space \thinspace{}
14844 \begin_inset Flex Code
14847 \begin_layout Plain Layout
14853 ] Indicates that paragraphs will not be separated by an empty line in \SpecialChar LaTeX
14855 but only by a line break; together with
14856 \begin_inset Flex Code
14859 \begin_layout Plain Layout
14865 , this allows to emulate a plain text editor (like the ERT inset).
14868 \begin_layout Description
14869 \begin_inset Flex Code
14872 \begin_layout Plain Layout
14879 \begin_inset Flex Code
14882 \begin_layout Plain Layout
14888 ] The indent of the very first line of a paragraph.
14890 \begin_inset Newline newline
14894 \begin_inset Flex Code
14897 \begin_layout Plain Layout
14903 will be fixed for a certain style.
14904 The exception is the default style, since the indentation for these paragraphs
14905 can be prohibited with
14906 \begin_inset Flex Code
14909 \begin_layout Plain Layout
14917 \begin_inset Flex Code
14920 \begin_layout Plain Layout
14926 style paragraphs inside environments use the
14927 \begin_inset Flex Code
14930 \begin_layout Plain Layout
14936 of the environment, not their native one.
14938 \begin_inset Flex Code
14941 \begin_layout Plain Layout
14947 paragraphs inside an enumeration are not indented.
14950 \begin_layout Description
14951 \begin_inset Flex Code
14954 \begin_layout Plain Layout
14961 \begin_inset Flex Code
14964 \begin_layout Plain Layout
14970 ] The vertical space between two paragraphs of this style.
14973 \begin_layout Description
14974 \begin_inset Flex Code
14977 \begin_layout Plain Layout
14984 \begin_inset Flex Code
14987 \begin_layout Plain Layout
14994 allows the user to choose either
14995 \begin_inset Quotes eld
14999 \begin_inset Quotes erd
15003 \begin_inset Quotes eld
15007 \begin_inset Quotes erd
15010 to separate paragraphs.
15012 \begin_inset Quotes eld
15016 \begin_inset Quotes erd
15020 \begin_inset Flex Code
15023 \begin_layout Plain Layout
15031 \begin_inset Quotes eld
15035 \begin_inset Quotes erd
15039 \begin_inset Flex Code
15042 \begin_layout Plain Layout
15048 is ignored and all paragraphs are separated by the
15049 \begin_inset Flex Code
15052 \begin_layout Plain Layout
15059 The vertical space is calculated with
15060 \begin_inset Flex Code
15063 \begin_layout Plain Layout
15065 \begin_inset space ~
15074 \begin_inset Flex Code
15077 \begin_layout Plain Layout
15083 is the height of a row with the normal font.
15084 This way, the look stays the same with different screen fonts.
15087 \begin_layout Description
15088 \begin_inset Flex Code
15091 \begin_layout Plain Layout
15098 \begin_inset Flex Code
15101 \begin_layout Plain Layout
15110 \begin_inset space \thinspace{}
15114 \begin_inset Flex Code
15117 \begin_layout Plain Layout
15123 ] Whether the contents of this paragraph should be output in raw form, meaning
15124 without special translations that \SpecialChar LaTeX
15128 \begin_layout Description
15129 \begin_inset Flex Code
15132 \begin_layout Plain Layout
15139 \begin_inset Flex Code
15142 \begin_layout Plain Layout
15152 Defines individual characters that should be output in raw form, meaning
15153 without special translations that \SpecialChar LaTeX
15157 \begin_layout Description
15158 \begin_inset Flex Code
15161 \begin_layout Plain Layout
15167 Information to be included in the \SpecialChar LaTeX
15168 preamble when this style is used.
15169 Used to define macros, load packages, etc., required by this particular
15172 \begin_inset Quotes eld
15176 \begin_inset Flex Code
15179 \begin_layout Plain Layout
15186 \begin_inset Quotes erd
15192 \begin_layout Description
15193 \begin_inset Flex Code
15196 \begin_layout Plain Layout
15203 \begin_inset Flex Code
15206 \begin_layout Plain Layout
15212 ] The prefix to use when creating labels referring to paragraphs of this
15214 This allows the use of formatted references.
15217 \begin_layout Description
15218 \begin_inset Flex Code
15221 \begin_layout Plain Layout
15228 \begin_inset Flex Code
15231 \begin_layout Plain Layout
15237 ] Whether the style requires the feature
15238 \begin_inset Flex Code
15241 \begin_layout Plain Layout
15248 \begin_inset CommandInset ref
15250 reference "chap:List-of-functions"
15254 for the list of features).
15255 If you require a package with specific options, you can additionally use
15257 \begin_inset Flex Code
15260 \begin_layout Plain Layout
15266 as a general text class parameter (see
15267 \begin_inset CommandInset ref
15269 reference "subsec:General-text-class"
15276 \begin_layout Description
15277 \begin_inset Flex Code
15280 \begin_layout Plain Layout
15287 \begin_inset Flex Code
15290 \begin_layout Plain Layout
15299 \begin_inset Flex Code
15302 \begin_layout Plain Layout
15308 ] Resets the \SpecialChar LaTeX
15309 arguments of this style (as defined via the
15310 \begin_inset Flex Code
15313 \begin_layout Plain Layout
15320 This is useful if you have copied a style via
15321 \begin_inset Flex Code
15324 \begin_layout Plain Layout
15330 , but you do not want to inherit its (required and optional) arguments.
15333 \begin_layout Description
15334 \begin_inset Flex Code
15337 \begin_layout Plain Layout
15344 \begin_inset Flex Code
15347 \begin_layout Plain Layout
15356 \begin_inset Flex Code
15359 \begin_layout Plain Layout
15365 ] Resumes a counter that is usually reset at each new sequence of layouts.
15366 This is currently only useful when
15367 \begin_inset Flex Code
15370 \begin_layout Plain Layout
15377 \begin_inset Flex Code
15380 \begin_layout Plain Layout
15389 \begin_layout Description
15390 \begin_inset Flex Code
15393 \begin_layout Plain Layout
15400 \begin_inset Flex Code
15403 \begin_layout Plain Layout
15409 ] A string that is put at the end of the layout content.
15410 A line break in the output can be indicated by
15411 \begin_inset Flex Code
15414 \begin_layout Plain Layout
15423 \begin_layout Description
15424 \begin_inset Flex Code
15427 \begin_layout Plain Layout
15434 \begin_inset Flex Code
15437 \begin_layout Plain Layout
15444 \begin_inset Flex Code
15447 \begin_layout Plain Layout
15456 \begin_layout Description
15457 \begin_inset Flex Code
15460 \begin_layout Plain Layout
15467 \begin_inset Flex Code
15470 \begin_layout Plain Layout
15479 \begin_inset Flex Code
15482 \begin_layout Plain Layout
15489 \begin_inset Flex Code
15492 \begin_layout Plain Layout
15499 \begin_inset Flex Code
15502 \begin_layout Plain Layout
15504 \begin_inset space ~
15512 ] This defines what the default spacing should be in the style.
15514 \begin_inset Flex Code
15517 \begin_layout Plain Layout
15524 \begin_inset Flex Code
15527 \begin_layout Plain Layout
15534 \begin_inset Flex Code
15537 \begin_layout Plain Layout
15543 correspond respectively to a multiplier value of 1, 1.25 and 1.667.
15544 If you specify the argument
15545 \begin_inset Flex Code
15548 \begin_layout Plain Layout
15554 , then you must also provide a value argument which will be the actual multiplie
15556 Note that, contrary to other parameters,
15557 \begin_inset Flex Code
15560 \begin_layout Plain Layout
15566 implies the generation of specific \SpecialChar LaTeX
15567 code, using the \SpecialChar LaTeX
15571 \begin_inset Flex Code
15574 \begin_layout Plain Layout
15583 \begin_layout Description
15584 \begin_inset Flex Code
15587 \begin_layout Plain Layout
15594 \begin_inset Flex Code
15597 \begin_layout Plain Layout
15604 \begin_inset space \thinspace{}
15608 \begin_inset Flex Code
15611 \begin_layout Plain Layout
15619 ] Allow spell-checking paragraphs of this style.
15623 \begin_layout Description
15624 \begin_inset Flex Code
15627 \begin_layout Plain Layout
15634 \begin_inset Flex Code
15637 \begin_layout Plain Layout
15646 \begin_inset Flex Code
15649 \begin_layout Plain Layout
15655 ] Steps the master counter of a given counter at the beginning of a new
15656 sequence of layouts.
15657 This is currently only useful when
15658 \begin_inset Flex Code
15661 \begin_layout Plain Layout
15668 \begin_inset Flex Code
15671 \begin_layout Plain Layout
15680 \begin_layout Description
15681 \begin_inset Flex Code
15684 \begin_layout Plain Layout
15690 The font used for the text body .
15692 \begin_inset CommandInset ref
15694 reference "subsec:Font-description"
15701 \begin_layout Description
15702 \begin_inset Flex Code
15705 \begin_layout Plain Layout
15714 \begin_inset Flex Code
15717 \begin_layout Plain Layout
15727 The level of the style in the table of contents.
15728 This is used for automatic numbering of section headings.
15731 \begin_layout Description
15732 \begin_inset Flex Code
15735 \begin_layout Plain Layout
15744 \begin_inset Flex Code
15747 \begin_layout Plain Layout
15758 \begin_inset Flex Code
15761 \begin_layout Plain Layout
15768 \begin_inset Flex Code
15771 \begin_layout Plain Layout
15777 ] This tag determines whether the first line indentation of this paragraph
15778 can be toggled via the Paragraph settings dialog.
15782 \begin_inset Flex Code
15785 \begin_layout Plain Layout
15795 is set, indentation can be toggled if the document settings use
15796 \begin_inset Quotes eld
15800 \begin_inset Quotes erd
15803 paragraph style, with
15804 \begin_inset Flex Code
15807 \begin_layout Plain Layout
15813 , indentation can always be toggled, notwithstanding the document settings,
15815 \begin_inset Flex Code
15818 \begin_layout Plain Layout
15824 , indentation can never be toggled.
15827 \begin_layout Description
15828 \begin_inset Flex Code
15831 \begin_layout Plain Layout
15838 \begin_inset Flex Code
15841 \begin_layout Plain Layout
15847 ] The vertical space with which the very first of a chain of paragraphs
15848 with this style is separated from the previous paragraph.
15849 If the previous paragraph has another style, the separations are not simply
15850 added, but the maximum is taken.
15853 \begin_layout Subsection
15854 \begin_inset CommandInset label
15860 Internationalization of Paragraph Styles
15863 \begin_layout Standard
15865 has long supported internationalization of layout information, but, until
15866 version 2.0, this applied only to the user interface and not to, say, PDF
15868 Thus, French authors were forced to resort to ugly hacks if they wanted
15873 1' instead of `Theorem 1'.
15874 Thanks to Georg Baum, that is no longer the case.
15877 \begin_layout Standard
15879 \begin_inset Flex Code
15882 \begin_layout Plain Layout
15888 defines text that is to appear in the typeset document, it may use
15889 \begin_inset Flex Code
15892 \begin_layout Plain Layout
15899 \begin_inset Flex Code
15902 \begin_layout Plain Layout
15908 to support non-English and even multi-language documents correctly.
15909 The following excerpt (from the
15910 \begin_inset Flex Code
15913 \begin_layout Plain Layout
15919 file) shows how this works:
15922 \begin_layout LyX-Code
15927 \begin_layout LyX-Code
15930 theoremstyle{remark}
15933 \begin_layout LyX-Code
15936 newtheorem{claim}[thm]{
15943 \begin_layout LyX-Code
15947 \begin_layout LyX-Code
15951 \begin_layout LyX-Code
15956 claimname}{_(Claim)}
15959 \begin_layout LyX-Code
15963 \begin_layout LyX-Code
15967 \begin_layout LyX-Code
15976 claimname}{_(Claim)}}
15979 \begin_layout LyX-Code
15984 \begin_layout Standard
15985 In principle, any legal \SpecialChar LaTeX
15987 \begin_inset Flex Code
15990 \begin_layout Plain Layout
15997 \begin_inset Flex Code
16000 \begin_layout Plain Layout
16006 tags, but in practice they will typically look as they do here.
16007 The key to correct translation of the typeset text is the definition of
16008 the \SpecialChar LaTeX
16010 \begin_inset Flex Code
16013 \begin_layout Plain Layout
16022 \begin_inset Flex Code
16025 \begin_layout Plain Layout
16037 \begin_layout Standard
16039 \begin_inset Flex Code
16042 \begin_layout Plain Layout
16048 tag provides for internationalization based upon the overall language of
16050 The contents of the tag will be included in the preamble, just as with
16052 \begin_inset Flex Code
16055 \begin_layout Plain Layout
16062 What makes it special is the use of the
16063 \begin_inset Quotes eld
16067 \begin_inset Quotes erd
16071 \begin_inset Flex Code
16074 \begin_layout Plain Layout
16080 , which will be replaced, when \SpecialChar LyX
16081 produces \SpecialChar LaTeX
16082 output, with the translation of
16083 its argument into the document language.
16086 \begin_layout Standard
16088 \begin_inset Flex Code
16091 \begin_layout Plain Layout
16097 tag is more complex, since it is meant to provide support for multi-language
16098 documents and so offers an interface to the
16099 \begin_inset Flex Code
16102 \begin_layout Plain Layout
16109 Its contents will be added to the preamble once for each language that
16110 appears in the document.
16111 In this case, the argument to
16112 \begin_inset Flex Code
16115 \begin_layout Plain Layout
16121 will be replaced with its translation into the language in question; the
16123 \begin_inset Flex Code
16126 \begin_layout Plain Layout
16132 is replaced by the language name (as used by the babel package).
16135 \begin_layout Standard
16136 A German document that also included a French section would thus have the
16137 following in the preamble:
16140 \begin_layout LyX-Code
16149 claimname}{Affirmation}}
16150 \begin_inset Newline newline
16161 claimname}{Behauptung}}
16162 \begin_inset Newline newline
16169 claimname}{Behauptung}
16172 \begin_layout Standard
16175 \begin_inset Flex Code
16178 \begin_layout Plain Layout
16184 will then conspire to produce the correct text in the output.
16187 \begin_layout Standard
16188 One important point to note here is that the translations are provided by
16190 itself, through the file
16191 \begin_inset Flex Code
16194 \begin_layout Plain Layout
16201 This means, in effect, that
16202 \begin_inset Flex Code
16205 \begin_layout Plain Layout
16212 \begin_inset Flex Code
16215 \begin_layout Plain Layout
16221 are really only of use in layout files that are provided with \SpecialChar LyX
16223 entered in user-created layout files will not be seen by \SpecialChar LyX
16224 's internationalizatio
16225 n routines unless the
16226 \begin_inset Flex Code
16229 \begin_layout Plain Layout
16235 file is modified accordingly.
16236 That said, however, any layout created with the intention that it will
16237 be included with \SpecialChar LyX
16238 should use these tags where appropriate.
16239 Please note that the paragraph style translations provided by \SpecialChar LyX
16241 change with a minor update (e.
16242 \begin_inset space \thinspace{}
16246 \begin_inset space \space{}
16249 from version 2.1.x to 2.1.y).
16250 It is however quite likely that a major update (e.
16251 \begin_inset space \thinspace{}
16255 \begin_inset space \space{}
16258 from 2.0.x to 2.1.0) will introduce new translations or corrections.
16261 \begin_layout Subsection
16263 \begin_inset CommandInset label
16265 name "subsec:Floats"
16272 \begin_layout Standard
16273 It is necessary to define the floats (
16274 \begin_inset Flex Noun
16277 \begin_layout Plain Layout
16284 \begin_inset Flex Noun
16287 \begin_layout Plain Layout
16293 , \SpecialChar ldots
16294 ) in the text class itself.
16295 Standard floats are included in the file
16296 \begin_inset Flex Code
16299 \begin_layout Plain Layout
16305 , so you may have to do no more than add
16308 \begin_layout LyX-Code
16309 Input stdfloats.inc
16312 \begin_layout Standard
16313 to your layout file.
16314 If you want to implement a text class that proposes some other float types
16315 (like the AGU class bundled with \SpecialChar LyX
16316 ), the information below will hopefully
16320 \begin_layout Description
16321 \begin_inset Flex Code
16324 \begin_layout Plain Layout
16331 \begin_inset Flex Code
16334 \begin_layout Plain Layout
16340 =!htbpH] Allowed placement options for this float type.
16341 The value is a string of placement characters.
16342 Possible characters include:
16347 \begin_inset Quotes eld
16351 \begin_inset Quotes erd
16359 \begin_inset Quotes eld
16363 \begin_inset Quotes erd
16371 \begin_inset Quotes eld
16375 \begin_inset Quotes erd
16383 \begin_inset Quotes eld
16387 \begin_inset Quotes erd
16395 \begin_inset Quotes eld
16399 \begin_inset Quotes erd
16407 \begin_inset Quotes eld
16411 \begin_inset Quotes erd
16415 The order of the characters in the string does not matter.
16416 If no placement options are allowed, use the string
16423 \begin_layout Description
16424 \begin_inset Flex Code
16427 \begin_layout Plain Layout
16434 \begin_inset Flex Code
16437 \begin_layout Plain Layout
16446 \begin_inset space \thinspace{}
16452 \begin_inset Flex Code
16455 \begin_layout Plain Layout
16465 ] Defines whether the float allows to be rotated via the \SpecialChar LaTeX
16472 \begin_inset Flex Code
16475 \begin_layout Plain Layout
16481 if the float does not support this feature.
16484 \begin_layout Description
16485 \begin_inset Flex Code
16488 \begin_layout Plain Layout
16495 \begin_inset Flex Code
16498 \begin_layout Plain Layout
16507 \begin_inset space \thinspace{}
16513 \begin_inset Flex Code
16516 \begin_layout Plain Layout
16526 ] Defines whether the float has a starred variant that spans columns in
16527 a two column paragraph.
16529 \begin_inset Flex Code
16532 \begin_layout Plain Layout
16538 if the float does not support this feature.
16541 \begin_layout Description
16542 \begin_inset Flex Code
16545 \begin_layout Plain Layout
16552 \begin_inset Flex Code
16555 \begin_layout Plain Layout
16562 \begin_inset Quotes erd
16566 \begin_inset Quotes erd
16569 ] The file name extension of an auxiliary file for the list of figures (or
16572 writes the captions to this file.
16575 \begin_layout Description
16576 \begin_inset Flex Code
16579 \begin_layout Plain Layout
16586 \begin_inset Flex Code
16589 \begin_layout Plain Layout
16596 \begin_inset Quotes erd
16600 \begin_inset Quotes erd
16603 ] The string that will be used in the menus and also for the caption.
16604 This is translated to the current language if babel is used.
16607 \begin_layout Description
16608 \begin_inset Flex Code
16611 \begin_layout Plain Layout
16617 These tags control the XHTML output.
16619 \begin_inset CommandInset ref
16621 reference "sec:Tags-for-XHTML"
16628 \begin_layout Description
16629 \begin_inset Flex Code
16632 \begin_layout Plain Layout
16641 \begin_inset Flex Code
16644 \begin_layout Plain Layout
16653 \begin_inset space \thinspace{}
16657 \begin_inset Flex Code
16660 \begin_layout Plain Layout
16666 ] Indicates whether the float is already defined in the document class or
16667 if instead the \SpecialChar LaTeX
16669 \begin_inset Flex Code
16672 \begin_layout Plain Layout
16678 needs to be loaded to define it on-the-fly.
16680 \begin_inset Flex Code
16683 \begin_layout Plain Layout
16690 \begin_inset Flex Code
16693 \begin_layout Plain Layout
16700 It should be set to
16701 \begin_inset Flex Code
16704 \begin_layout Plain Layout
16710 if the float is already defined by the \SpecialChar LaTeX
16714 \begin_layout Description
16715 \begin_inset Flex Code
16718 \begin_layout Plain Layout
16725 \begin_inset Flex Code
16728 \begin_layout Plain Layout
16735 \begin_inset Quotes erd
16739 \begin_inset Quotes erd
16742 ] The command used to generate a list of floats of this type; the leading
16751 \begin_inset Flex Code
16754 \begin_layout Plain Layout
16760 is false, since there is no standard way to generate this command.
16762 \begin_inset Flex Code
16765 \begin_layout Plain Layout
16771 is true, since in that case there is a standard way to define the command.
16774 \begin_layout Description
16775 \begin_inset Flex Code
16778 \begin_layout Plain Layout
16785 \begin_inset Flex Code
16788 \begin_layout Plain Layout
16795 \begin_inset Quotes erd
16799 \begin_inset Quotes erd
16802 ] A title for a list of floats of this kind (list of figures, tables, or
16804 It is used for the screen label within \SpecialChar LyX
16805 , it is used by \SpecialChar LaTeX
16807 it is used as the title in the XHTML output.
16808 It will be translated to the document language.
16811 \begin_layout Description
16812 \begin_inset Flex Code
16815 \begin_layout Plain Layout
16822 \begin_inset Flex Code
16825 \begin_layout Plain Layout
16832 \begin_inset Quotes erd
16836 \begin_inset Quotes erd
16839 ] This (optional) argument determines whether floats of this class will
16840 be numbered within some sectional unit of the document.
16842 \begin_inset Flex Code
16845 \begin_layout Plain Layout
16852 \begin_inset Quotes eld
16856 \begin_inset Flex Code
16859 \begin_layout Plain Layout
16866 \begin_inset Quotes erd
16869 , the floats will be numbered within chapters.
16873 \begin_layout Description
16874 \begin_inset Flex Code
16877 \begin_layout Plain Layout
16884 \begin_inset Flex Code
16887 \begin_layout Plain Layout
16894 \begin_inset Quotes erd
16898 \begin_inset Quotes erd
16901 ] The default placement for the given class of floats.
16902 The string should be as in standard \SpecialChar LaTeX
16904 \begin_inset Flex Code
16907 \begin_layout Plain Layout
16914 \begin_inset Flex Code
16917 \begin_layout Plain Layout
16924 \begin_inset Flex Code
16927 \begin_layout Plain Layout
16934 \begin_inset Flex Code
16937 \begin_layout Plain Layout
16943 for top, bottom, page, and here, respectively.
16947 \begin_layout Plain Layout
16948 Note that the order of these letters in the string is irrelevant, like in
16955 On top of that there is a new type,
16956 \begin_inset Flex Code
16959 \begin_layout Plain Layout
16965 , which does not really correspond to a float, since it means: put it
16966 \begin_inset Quotes eld
16970 \begin_inset Quotes erd
16974 Note however that the
16975 \begin_inset Flex Code
16978 \begin_layout Plain Layout
16984 specifier is special and, because of implementation details, cannot be
16985 used in non-built in float types.
16986 If you do not understand what this means, just use
16987 \begin_inset Quotes eld
16991 \begin_inset Flex Code
16994 \begin_layout Plain Layout
17001 \begin_inset Quotes erd
17007 \begin_layout Description
17008 \begin_inset Flex Code
17011 \begin_layout Plain Layout
17018 \begin_inset Flex Code
17021 \begin_layout Plain Layout
17027 ] The prefix to use when creating labels referring to floats of this type.
17028 This allows the use of formatted references.
17029 Note that you can remove any
17030 \begin_inset Flex Code
17033 \begin_layout Plain Layout
17039 set by a copied style by using the special value
17040 \begin_inset Quotes eld
17044 \begin_inset Quotes erd
17047 , which must be all caps.
17050 \begin_layout Description
17051 \begin_inset Flex Code
17054 \begin_layout Plain Layout
17061 \begin_inset Flex Code
17064 \begin_layout Plain Layout
17071 \begin_inset Quotes erd
17075 \begin_inset Quotes erd
17078 ] The style used when defining the float using
17079 \begin_inset Flex Code
17082 \begin_layout Plain Layout
17093 \begin_layout Description
17094 \begin_inset Flex Code
17097 \begin_layout Plain Layout
17104 \begin_inset Flex Code
17107 \begin_layout Plain Layout
17114 \begin_inset Quotes erd
17118 \begin_inset Quotes erd
17122 \begin_inset Quotes eld
17126 \begin_inset Quotes erd
17129 of the new class of floats, like program or algorithm.
17130 After the appropriate
17131 \begin_inset Flex Code
17134 \begin_layout Plain Layout
17143 \begin_inset Flex Code
17146 \begin_layout Plain Layout
17155 \begin_inset Flex Code
17158 \begin_layout Plain Layout
17169 \begin_layout Description
17170 \begin_inset Flex Code
17173 \begin_layout Plain Layout
17180 \begin_inset Flex Code
17183 \begin_layout Plain Layout
17190 \begin_inset space \thinspace{}
17194 \begin_inset Flex Code
17197 \begin_layout Plain Layout
17205 ] Specifies whether this float is defined using the \SpecialChar LaTeX
17207 \begin_inset Flex Code
17210 \begin_layout Plain Layout
17216 , either by the class file, another package or on-the-fly by \SpecialChar LyX
17220 \begin_layout Standard
17221 Note that defining a float with type
17222 \begin_inset Flex Code
17225 \begin_layout Plain Layout
17233 automatically defines the corresponding counter with name
17234 \begin_inset Flex Code
17237 \begin_layout Plain Layout
17248 \begin_layout Subsection
17249 Flex insets and InsetLayout
17250 \begin_inset CommandInset label
17252 name "subsec:Flex-insets-and"
17259 \begin_layout Standard
17260 Flex insets come in three different kinds:
17263 \begin_layout Itemize
17265 \begin_inset Flex Code
17268 \begin_layout Plain Layout
17274 ): These define semantic markup corresponding to such \SpecialChar LaTeX
17276 \begin_inset Flex Code
17279 \begin_layout Plain Layout
17288 \begin_inset Flex Code
17291 \begin_layout Plain Layout
17302 \begin_layout Itemize
17304 \begin_inset Flex Code
17307 \begin_layout Plain Layout
17313 ): These can be used to define custom collapsible insets, similar to \SpecialChar TeX
17315 footnote, and the like.
17316 An obvious example is an endnote inset, which is defined in the
17317 \begin_inset Flex Code
17320 \begin_layout Plain Layout
17329 \begin_layout Itemize
17331 \begin_inset Flex Code
17334 \begin_layout Plain Layout
17340 ): For use with DocBook classes.
17343 \begin_layout Standard
17344 Flex insets are defined using the
17345 \begin_inset Flex Code
17348 \begin_layout Plain Layout
17354 tag, which shall be explained in a moment.
17357 \begin_layout Standard
17359 \begin_inset Flex Code
17362 \begin_layout Plain Layout
17368 tag also serves another function: It can be used to customize the general
17369 layout of many different types of insets.
17371 \begin_inset Flex Code
17374 \begin_layout Plain Layout
17380 can be used to customize the layout parameters for footnotes, marginal
17381 notes, note insets, \SpecialChar TeX
17382 code (ERT) insets, branches, listings, indexes, boxes,
17383 tables, algorithms, URLs, and captions, as well as to define Flex insets.
17386 \begin_layout Standard
17388 \begin_inset Flex Code
17391 \begin_layout Plain Layout
17397 definition must begin with a line of the form:
17400 \begin_layout LyX-Code
17404 \begin_layout Standard
17406 \begin_inset Flex Code
17409 \begin_layout Plain Layout
17415 indicates the inset whose layout is being defined, and here there are four
17419 \begin_layout Enumerate
17420 The layout for a pre-existing inset is being modified.
17421 In this case, can be
17422 \begin_inset Flex Code
17425 \begin_layout Plain Layout
17431 any one of the following:
17432 \begin_inset Flex Code
17435 \begin_layout Plain Layout
17442 \begin_inset Flex Code
17445 \begin_layout Plain Layout
17452 \begin_inset Flex Code
17455 \begin_layout Plain Layout
17462 \begin_inset Flex Code
17465 \begin_layout Plain Layout
17472 \begin_inset Flex Code
17475 \begin_layout Plain Layout
17482 \begin_inset Flex Code
17485 \begin_layout Plain Layout
17492 \begin_inset Flex Code
17495 \begin_layout Plain Layout
17502 \begin_inset Flex Code
17505 \begin_layout Plain Layout
17512 \begin_inset Flex Code
17515 \begin_layout Plain Layout
17522 \begin_inset Flex Code
17525 \begin_layout Plain Layout
17532 \begin_inset Flex Code
17535 \begin_layout Plain Layout
17542 \begin_inset Flex Code
17545 \begin_layout Plain Layout
17552 \begin_inset Flex Code
17555 \begin_layout Plain Layout
17562 \begin_inset Flex Code
17565 \begin_layout Plain Layout
17572 \begin_inset Flex Code
17575 \begin_layout Plain Layout
17582 \begin_inset Flex Code
17585 \begin_layout Plain Layout
17592 \begin_inset Flex Code
17595 \begin_layout Plain Layout
17602 \begin_inset Flex Code
17605 \begin_layout Plain Layout
17612 \begin_inset Flex Code
17615 \begin_layout Plain Layout
17622 \begin_inset Flex Code
17625 \begin_layout Plain Layout
17634 \begin_layout Enumerate
17635 The layout for a Flex inset is being defined.
17637 \begin_inset Flex Code
17640 \begin_layout Plain Layout
17646 must be of the form
17647 \begin_inset Quotes eld
17651 \begin_inset Flex Code
17654 \begin_layout Plain Layout
17661 \begin_inset Quotes erd
17665 \begin_inset Flex Code
17668 \begin_layout Plain Layout
17674 may be be any valid identifier not used by a pre-existing Flex inset.
17675 The identifier may include spaces, but in that case the whole thing must
17676 be wrapped in quotes.
17677 Note that the definition of a flex inset
17682 \begin_inset Flex Code
17685 \begin_layout Plain Layout
17691 entry, declaring which type of inset it defines.
17694 \begin_layout Enumerate
17695 The layout for user specific branch is being defined.
17697 \begin_inset Flex Code
17700 \begin_layout Plain Layout
17706 must be of the form
17707 \begin_inset Quotes eld
17711 \begin_inset Flex Code
17714 \begin_layout Plain Layout
17721 \begin_inset Quotes erd
17725 \begin_inset Flex Code
17728 \begin_layout Plain Layout
17734 may be be any valid identifier of branch defined in user's document.
17735 The identifier may include spaces, but in that case the whole thing must
17736 be wrapped in quotes.
17737 The main purpose of this feature is to allow \SpecialChar LaTeX
17738 wrapping around specific
17739 branches as user needs.
17742 \begin_layout Enumerate
17743 The layout of a user (or class) specific caption is being defined.
17745 \begin_inset Flex Code
17748 \begin_layout Plain Layout
17754 must be of the form
17755 \begin_inset Quotes eld
17759 \begin_inset Flex Code
17762 \begin_layout Plain Layout
17769 \begin_inset Quotes erd
17773 \begin_inset Flex Code
17776 \begin_layout Plain Layout
17782 specifies the name of the caption as it appears in the menu.
17783 Have a look at the standard caption (
17784 \begin_inset Flex Code
17787 \begin_layout Plain Layout
17793 ), the specific captions of the KOMA-Script classes (
17794 \begin_inset Flex Code
17797 \begin_layout Plain Layout
17804 \begin_inset Flex Code
17807 \begin_layout Plain Layout
17816 \begin_inset space ~
17822 \begin_inset Flex Code
17825 \begin_layout Plain Layout
17831 ) for applications.
17834 \begin_layout Standard
17836 \begin_inset Flex Code
17839 \begin_layout Plain Layout
17845 definition can contain the following entries:
17848 \begin_layout Description
17849 \begin_inset Flex Code
17852 \begin_layout Plain Layout
17859 \begin_inset Flex Code
17862 \begin_layout Plain Layout
17868 =""] This inset will appear in the table of contents of the given type.
17869 An empty string disables.
17870 See also the OutlinerName and the IsTocCaption commands.
17871 This is only implemented for Flex insets.
17875 \begin_layout Description
17876 \begin_inset Flex Code
17879 \begin_layout Plain Layout
17886 \begin_inset Flex Code
17889 \begin_layout Plain Layout
17895 ] Defines argument number of a command\SpecialChar breakableslash
17896 environment associated with the current
17898 The definition must end with
17899 \begin_inset Flex Code
17902 \begin_layout Plain Layout
17910 \begin_inset CommandInset ref
17912 reference "subsec:Paragraph-Styles"
17919 \begin_layout Description
17920 \begin_inset Flex Code
17923 \begin_layout Plain Layout
17929 Preamble for changing language commands; see
17930 \begin_inset CommandInset ref
17932 reference "subsec:I18n"
17939 \begin_layout Description
17940 \begin_inset Flex Code
17943 \begin_layout Plain Layout
17950 \begin_inset Flex Code
17953 \begin_layout Plain Layout
17959 ] The color for the inset's background.
17961 \begin_inset CommandInset ref
17963 reference "chap:Names-of-colors"
17967 for a list of the available color names.
17970 \begin_layout Description
17971 \begin_inset Flex Code
17974 \begin_layout Plain Layout
17981 \begin_inset Flex Code
17984 \begin_layout Plain Layout
17993 \begin_inset space \thinspace{}
17997 \begin_inset Flex Code
18000 \begin_layout Plain Layout
18006 ] Whether to use the content of the inset as the label, when the inset is
18011 \begin_layout Description
18012 \begin_inset Flex Code
18015 \begin_layout Plain Layout
18022 \begin_inset Flex Code
18025 \begin_layout Plain Layout
18031 ] As with paragraph styles, see
18032 \begin_inset CommandInset ref
18034 reference "subsec:Paragraph-Styles"
18039 Note that you need to specify the complete type, e.
18040 \begin_inset space \thinspace{}
18044 \begin_inset space ~
18048 \begin_inset Flex Code
18051 \begin_layout Plain Layout
18052 CopyStyle Flex:<name>
18060 \begin_layout Description
18061 \begin_inset Flex Code
18064 \begin_layout Plain Layout
18071 \begin_inset Flex Code
18074 \begin_layout Plain Layout
18083 \begin_inset space \thinspace{}
18087 \begin_inset Flex Code
18090 \begin_layout Plain Layout
18096 ] Indicates whether the user may employ the Paragraph Settings dialog to
18097 customize the paragraph.
18100 \begin_layout Description
18101 \begin_inset Flex Code
18104 \begin_layout Plain Layout
18111 \begin_inset Flex Code
18114 \begin_layout Plain Layout
18121 \begin_inset Flex Code
18124 \begin_layout Plain Layout
18131 \begin_inset Flex Code
18134 \begin_layout Plain Layout
18140 , describing the rendering style used for the inset's frame and buttons.
18141 Footnotes generally use
18142 \begin_inset Flex Code
18145 \begin_layout Plain Layout
18151 , ERT insets generally
18152 \begin_inset Flex Code
18155 \begin_layout Plain Layout
18161 , and character styles
18162 \begin_inset Flex Code
18165 \begin_layout Plain Layout
18174 \begin_layout Description
18175 \begin_inset Flex Code
18178 \begin_layout Plain Layout
18185 \begin_inset Flex Code
18188 \begin_layout Plain Layout
18197 \begin_inset space \thinspace{}
18203 \begin_inset Flex Code
18206 \begin_layout Plain Layout
18215 \begin_inset Flex Code
18218 \begin_layout Plain Layout
18225 \begin_inset Flex Code
18228 \begin_layout Plain Layout
18235 Indicates whether the environment will stand on its own in the output or
18236 will appear inline with the surrounding text.
18237 If set to false, it is supposed that the \SpecialChar LaTeX
18238 environment ignores white space
18239 (including one newline character) after the
18240 \begin_inset Flex Code
18243 \begin_layout Plain Layout
18256 \begin_inset Flex Code
18259 \begin_layout Plain Layout
18275 \begin_layout Description
18276 \begin_inset Flex Code
18279 \begin_layout Plain Layout
18285 Required at the end of the
18286 \begin_inset Flex Code
18289 \begin_layout Plain Layout
18298 \begin_layout Description
18299 \begin_inset Flex Code
18302 \begin_layout Plain Layout
18308 The font used for both the text body
18314 \begin_inset CommandInset ref
18316 reference "subsec:Font-description"
18321 Note that defining this font automatically defines the
18322 \begin_inset Flex Code
18325 \begin_layout Plain Layout
18331 to the same value, so define this first and define
18332 \begin_inset Flex Code
18335 \begin_layout Plain Layout
18341 later if you want them to be different.
18344 \begin_layout Description
18345 \begin_inset Flex Code
18348 \begin_layout Plain Layout
18349 FixedWidthPreambleEncoding
18355 \begin_inset Flex Code
18358 \begin_layout Plain Layout
18367 \begin_inset space \thinspace{}
18371 \begin_inset Flex Code
18374 \begin_layout Plain Layout
18380 ] Force a fixed width encoding for the translated contents of
18381 \begin_inset Flex Code
18384 \begin_layout Plain Layout
18391 \begin_inset Flex Code
18394 \begin_layout Plain Layout
18400 code generated by this layout.
18401 This is needed for special \SpecialChar LaTeX
18406 that do not work with variable width encodings such as
18411 This setting is ignored if fully Unicode aware \SpecialChar LaTeX
18412 backends such as Xe\SpecialChar TeX
18414 Lua\SpecialChar TeX
18418 \begin_layout Description
18419 \begin_inset Flex Code
18422 \begin_layout Plain Layout
18423 ForceLocalFontSwitch
18429 \begin_inset Flex Code
18432 \begin_layout Plain Layout
18441 \begin_inset space \thinspace{}
18445 \begin_inset Flex Code
18448 \begin_layout Plain Layout
18454 ] When using babel, always use a local font switch (
18455 \begin_inset Flex Code
18458 \begin_layout Plain Layout
18466 ), never a global one (such as
18467 \begin_inset Flex Code
18470 \begin_layout Plain Layout
18481 \begin_layout Description
18482 \begin_inset Flex Code
18485 \begin_layout Plain Layout
18492 \begin_inset Flex Code
18495 \begin_layout Plain Layout
18504 \begin_inset space \thinspace{}
18508 \begin_inset Flex Code
18511 \begin_layout Plain Layout
18518 \begin_inset Quotes eld
18522 \begin_inset Quotes erd
18525 language, leading to Left-to-Right (Latin) output, e.
18526 \begin_inset space \thinspace{}
18530 \begin_inset space \space{}
18533 in \SpecialChar TeX
18538 \begin_layout Description
18539 \begin_inset Flex Code
18542 \begin_layout Plain Layout
18549 \begin_inset Flex Code
18552 \begin_layout Plain Layout
18561 \begin_inset space \thinspace{}
18565 \begin_inset Flex Code
18568 \begin_layout Plain Layout
18574 ] Force a a line break in the \SpecialChar LaTeX
18575 output before the inset starts and after
18577 This assures the inset itself is output on its own lines, for parsing purposes.
18580 \begin_layout Description
18581 \begin_inset Flex Code
18584 \begin_layout Plain Layout
18591 \begin_inset Flex Code
18594 \begin_layout Plain Layout
18603 \begin_inset space \thinspace{}
18607 \begin_inset Flex Code
18610 \begin_layout Plain Layout
18616 ] Indicates whether the
18617 \begin_inset Flex Code
18620 \begin_layout Plain Layout
18626 should be used or, instead, the user can change the paragraph style used
18631 \begin_layout Description
18632 \begin_inset Flex Code
18635 \begin_layout Plain Layout
18642 \begin_inset Flex Code
18645 \begin_layout Plain Layout
18654 \begin_inset space \thinspace{}
18658 \begin_inset Flex Code
18661 \begin_layout Plain Layout
18667 ] As with paragraph styles, see
18668 \begin_inset CommandInset ref
18670 reference "subsec:Paragraph-Styles"
18677 \begin_layout Description
18678 \begin_inset Flex Code
18681 \begin_layout Plain Layout
18687 These tags control the XHTML output.
18689 \begin_inset CommandInset ref
18691 reference "sec:Tags-for-XHTML"
18698 \begin_layout Description
18699 \begin_inset Flex Code
18702 \begin_layout Plain Layout
18709 \begin_inset Flex Code
18712 \begin_layout Plain Layout
18721 \begin_inset space \thinspace{}
18725 \begin_inset Flex Code
18728 \begin_layout Plain Layout
18734 ] Whether to include the contents of this inset in the strings generated
18735 for the `Outline' pane for all table of contents, regardless of the AddToToc
18737 One would not, for example, want the content of a footnote in a section
18738 header to be included in the TOC displayed in the outline, but one would
18739 normally want the content of a character style displayed.
18740 Default is false: not to include.
18743 \begin_layout Description
18744 \begin_inset Flex Code
18747 \begin_layout Plain Layout
18754 \begin_inset Flex Code
18757 \begin_layout Plain Layout
18766 \begin_inset space \thinspace{}
18770 \begin_inset Flex Code
18773 \begin_layout Plain Layout
18779 ] If this is set to 1 and AddToToc is enabled, the inset adds a summary
18780 of its contents in its item in the table of contents.
18781 Otherwise, only the label appears.
18784 \begin_layout Description
18785 \begin_inset Flex Code
18788 \begin_layout Plain Layout
18797 \begin_inset Flex Code
18800 \begin_layout Plain Layout
18809 \begin_inset space \thinspace{}
18813 \begin_inset Flex Code
18816 \begin_layout Plain Layout
18822 ] As with paragraph styles, see
18823 \begin_inset CommandInset ref
18825 reference "subsec:Paragraph-Styles"
18832 \begin_layout Description
18833 \begin_inset Flex Code
18836 \begin_layout Plain Layout
18842 The font used for the label.
18844 \begin_inset CommandInset ref
18846 reference "subsec:Font-description"
18851 Note that this definition can never appear before
18852 \begin_inset Flex Code
18855 \begin_layout Plain Layout
18861 , lest it be ineffective.
18864 \begin_layout Description
18865 \begin_inset Flex Code
18868 \begin_layout Plain Layout
18875 \begin_inset Flex Code
18878 \begin_layout Plain Layout
18885 \begin_inset Quotes erd
18889 \begin_inset Quotes erd
18892 ] What will be displayed on the button or elsewhere as the inset label.
18894 \begin_inset Flex Code
18897 \begin_layout Plain Layout
18905 \begin_inset Flex Code
18908 \begin_layout Plain Layout
18914 ) modify this label on the fly.
18917 \begin_layout Description
18918 \begin_inset Flex Code
18921 \begin_layout Plain Layout
18927 Language dependent preamble; see
18928 \begin_inset CommandInset ref
18930 reference "subsec:I18n"
18937 \begin_layout Description
18938 \begin_inset Flex Code
18941 \begin_layout Plain Layout
18948 \begin_inset Flex Code
18951 \begin_layout Plain Layout
18957 ] The name of the corresponding \SpecialChar LaTeX
18959 Either the environment or command name.
18962 \begin_layout Description
18963 \begin_inset Flex Code
18966 \begin_layout Plain Layout
18973 \begin_inset Flex Code
18976 \begin_layout Plain Layout
18982 ] The optional parameter for the corresponding
18983 \begin_inset Flex Code
18986 \begin_layout Plain Layout
18992 stuff, including possible bracket pairs like
18993 \begin_inset Flex Code
18996 \begin_layout Plain Layout
19003 This parameter cannot be changed from within \SpecialChar LyX
19005 \begin_inset Flex Code
19008 \begin_layout Plain Layout
19014 for customizable parameters).
19015 It will be output as is after all \SpecialChar LaTeX
19017 \begin_inset Flex Code
19020 \begin_layout Plain Layout
19029 \begin_layout Description
19030 \begin_inset Flex Code
19033 \begin_layout Plain Layout
19040 \begin_inset Flex Code
19043 \begin_layout Plain Layout
19044 Command, Environment, None
19049 ] How the style should be translated into \SpecialChar LaTeX
19054 \begin_layout Plain Layout
19055 \begin_inset Flex Code
19058 \begin_layout Plain Layout
19064 is perhaps a bit misleading, since these rules apply to SGML classes too.
19065 Visit the SGML class files for specific examples.
19074 \begin_layout Description
19075 \begin_inset Flex Code
19078 \begin_layout Plain Layout
19084 means nothing special
19087 \begin_layout Description
19088 \begin_inset Flex Code
19091 \begin_layout Plain Layout
19098 \begin_inset Flex Code
19101 \begin_layout Plain Layout
19108 {\SpecialChar ldots
19117 \begin_layout Description
19118 \begin_inset Flex Code
19121 \begin_layout Plain Layout
19128 \begin_inset Flex Code
19131 \begin_layout Plain Layout
19138 }\SpecialChar ldots
19153 \begin_layout Standard
19154 Putting the last few things together, the \SpecialChar LaTeX
19155 output will be either:
19158 \begin_layout LyX-Code
19161 LatexName[LatexParam]{\SpecialChar ldots
19165 \begin_layout Standard
19169 \begin_layout LyX-Code
19172 begin{LatexName}[LatexParam] \SpecialChar ldots
19178 \begin_layout Standard
19179 depending upon the \SpecialChar LaTeX
19184 \begin_layout Description
19185 \begin_inset Flex Code
19188 \begin_layout Plain Layout
19195 \begin_inset Flex Code
19198 \begin_layout Plain Layout
19204 ] A string that is put at the beginning of the layout content.
19205 A line break in the output can be indicated by
19206 \begin_inset Flex Code
19209 \begin_layout Plain Layout
19218 \begin_layout Description
19219 \begin_inset Flex Code
19222 \begin_layout Plain Layout
19229 \begin_inset Flex Code
19232 \begin_layout Plain Layout
19239 \begin_inset Flex Code
19242 \begin_layout Plain Layout
19249 \begin_inset Flex Code
19252 \begin_layout Plain Layout
19259 \begin_inset Flex Code
19262 \begin_layout Plain Layout
19268 (indicating a dummy definition ending definitions of charstyles, etc).
19269 This entry is required in and is only meaningful for Flex insets.
19270 Among other things, it determines on which menu this inset will appear.
19272 \begin_inset Flex Code
19275 \begin_layout Plain Layout
19282 \begin_inset Flex Code
19285 \begin_layout Plain Layout
19291 will automatically set
19292 \begin_inset Flex Code
19295 \begin_layout Plain Layout
19302 \begin_inset Flex Code
19305 \begin_layout Plain Layout
19313 \begin_inset Flex Code
19316 \begin_layout Plain Layout
19322 can be set to true, or
19323 \begin_inset Flex Code
19326 \begin_layout Plain Layout
19333 \begin_inset Flex Code
19336 \begin_layout Plain Layout
19342 insets by setting it
19347 \begin_inset Flex Code
19350 \begin_layout Plain Layout
19359 \begin_layout Description
19360 \begin_inset Flex Code
19363 \begin_layout Plain Layout
19370 \begin_inset Flex Code
19373 \begin_layout Plain Layout
19382 \begin_inset space \thinspace{}
19386 \begin_inset Flex Code
19389 \begin_layout Plain Layout
19395 ] Whether multiple paragraphs are permitted in this inset.
19397 \begin_inset Flex Code
19400 \begin_layout Plain Layout
19406 to the same value and
19407 \begin_inset Flex Code
19410 \begin_layout Plain Layout
19416 to the opposite value.
19417 These can be reset to other values, if they are used
19422 \begin_inset Flex Code
19425 \begin_layout Plain Layout
19435 \begin_layout Description
19436 \begin_inset Flex Code
19439 \begin_layout Plain Layout
19446 \begin_inset Flex Code
19449 \begin_layout Plain Layout
19458 \begin_inset space \thinspace{}
19462 \begin_inset Flex Code
19465 \begin_layout Plain Layout
19471 ] Whether fragile commands in this inset should be
19472 \begin_inset Flex Code
19475 \begin_layout Plain Layout
19488 whether the command should itself be protected.) Default is false.
19491 \begin_layout Description
19492 \begin_inset Flex Code
19495 \begin_layout Plain Layout
19502 \begin_inset Flex Code
19505 \begin_layout Plain Layout
19511 ] Deletes an existing
19512 \begin_inset Flex Code
19515 \begin_layout Plain Layout
19524 \begin_layout Description
19525 \begin_inset Flex Code
19528 \begin_layout Plain Layout
19535 \begin_inset Flex Code
19538 \begin_layout Plain Layout
19545 \begin_inset Flex Code
19548 \begin_layout Plain Layout
19554 that has replaced this
19555 \begin_inset Flex Code
19558 \begin_layout Plain Layout
19565 This is used to rename an
19566 \begin_inset Flex Code
19569 \begin_layout Plain Layout
19575 , while keeping backward compatibility.
19578 \begin_layout Description
19579 \begin_inset Flex Code
19582 \begin_layout Plain Layout
19589 \begin_inset Flex Code
19592 \begin_layout Plain Layout
19601 \begin_inset space \thinspace{}
19605 \begin_inset Flex Code
19608 \begin_layout Plain Layout
19614 ] As with paragraph styles, see
19615 \begin_inset CommandInset ref
19617 reference "subsec:Paragraph-Styles"
19625 \begin_layout Description
19626 \begin_inset Flex Code
19629 \begin_layout Plain Layout
19636 \begin_inset Flex Code
19639 \begin_layout Plain Layout
19648 \begin_inset space \thinspace{}
19652 \begin_inset Flex Code
19655 \begin_layout Plain Layout
19661 ] As with paragraph styles, see
19662 \begin_inset CommandInset ref
19664 reference "subsec:Paragraph-Styles"
19672 \begin_layout Description
19673 \begin_inset Flex Code
19676 \begin_layout Plain Layout
19682 As with paragraph styles, see
19683 \begin_inset CommandInset ref
19685 reference "subsec:Paragraph-Styles"
19692 \begin_layout Description
19693 \begin_inset Flex Code
19696 \begin_layout Plain Layout
19703 \begin_inset Flex Code
19706 \begin_layout Plain Layout
19712 ] The prefix to use when creating labels referring to insets of this type.
19713 This allows the use of formatted references.
19716 \begin_layout Description
19717 \begin_inset Flex Code
19720 \begin_layout Plain Layout
19727 \begin_inset Flex Code
19730 \begin_layout Plain Layout
19736 ] As with paragraph styles, see
19737 \begin_inset CommandInset ref
19739 reference "subsec:Paragraph-Styles"
19746 \begin_layout Description
19747 \begin_inset Flex Code
19750 \begin_layout Plain Layout
19757 \begin_inset Flex Code
19760 \begin_layout Plain Layout
19769 \begin_inset space \thinspace{}
19773 \begin_inset Flex Code
19776 \begin_layout Plain Layout
19782 ] Resets the \SpecialChar LaTeX
19783 arguments of this layout (as defined via the
19784 \begin_inset Flex Code
19787 \begin_layout Plain Layout
19794 This is useful if you have copied a style via
19795 \begin_inset Flex Code
19798 \begin_layout Plain Layout
19804 , but you do not want to inherit its (required and optional) arguments.
19807 \begin_layout Description
19808 \begin_inset Flex Code
19811 \begin_layout Plain Layout
19818 \begin_inset Flex Code
19821 \begin_layout Plain Layout
19828 \begin_inset space \thinspace{}
19832 \begin_inset Flex Code
19835 \begin_layout Plain Layout
19843 ] Whether this inset should use the font of its surrounding environment
19845 Default is false: use the font of the surrounding environment.
19848 \begin_layout Description
19849 \begin_inset Flex Code
19852 \begin_layout Plain Layout
19859 \begin_inset Flex Code
19862 \begin_layout Plain Layout
19868 ] A string that is put at the end of the layout content.
19869 A line break in the output can be indicated by
19870 \begin_inset Flex Code
19873 \begin_layout Plain Layout
19882 \begin_layout Description
19883 \begin_inset Flex Code
19886 \begin_layout Plain Layout
19893 \begin_inset Flex Code
19896 \begin_layout Plain Layout
19903 \begin_inset space \thinspace{}
19907 \begin_inset Flex Code
19910 \begin_layout Plain Layout
19918 ] Allow spell-checking the contents of this inset.
19922 \begin_layout Subsection
19924 \begin_inset CommandInset label
19926 name "subsec:Counters"
19933 \begin_layout Standard
19934 It is necessary to define the counters (
19935 \begin_inset Flex Noun
19938 \begin_layout Plain Layout
19945 \begin_inset Flex Noun
19948 \begin_layout Plain Layout
19954 , \SpecialChar ldots
19955 ) in the text class itself.
19956 The standard counters are defined in the file
19957 \begin_inset Flex Code
19960 \begin_layout Plain Layout
19966 , so you may have to do no more than add
19969 \begin_layout LyX-Code
19970 Input stdcounters.inc
19973 \begin_layout Standard
19974 to your layout file to get them to work.
19975 But if you want to define custom counters, then you can do so.
19976 The counter declaration must begin with:
19979 \begin_layout LyX-Code
19980 Counter CounterName
19983 \begin_layout Standard
19985 \begin_inset Flex Code
19988 \begin_layout Plain Layout
19994 ' is replaced by the name of the counter.
19995 And it must end with
19996 \begin_inset Quotes eld
20000 \begin_inset Flex Code
20003 \begin_layout Plain Layout
20010 \begin_inset Quotes erd
20014 The following parameters can also be used:
20017 \begin_layout Description
20018 \begin_inset Flex Code
20021 \begin_layout Plain Layout
20028 \begin_inset Flex Code
20031 \begin_layout Plain Layout
20037 ] Sets the initial value for the counter, to which it will be reset whenever
20039 Normally, one will want the default, 1.
20042 \begin_layout Description
20043 \begin_inset Flex Code
20046 \begin_layout Plain Layout
20053 \begin_inset Flex Code
20056 \begin_layout Plain Layout
20063 \begin_inset Quotes erd
20067 \begin_inset Quotes erd
20070 ] When defined, this string defines how the counter is displayed.
20071 Setting this value sets
20072 \begin_inset Flex Code
20075 \begin_layout Plain Layout
20076 LabelStringAppendix
20082 The following special constructs can be used in the string:
20086 \begin_layout Itemize
20087 \begin_inset Flex Code
20090 \begin_layout Plain Layout
20098 will be replaced by the expansion of the
20099 \begin_inset Flex Code
20102 \begin_layout Plain Layout
20109 \begin_inset Flex Code
20112 \begin_layout Plain Layout
20113 LabelStringAppendix
20119 \begin_inset Flex Code
20122 \begin_layout Plain Layout
20132 \begin_layout Itemize
20133 counter values can be expressed using \SpecialChar LaTeX
20135 \begin_inset Newline newline
20139 \begin_inset Flex Code
20142 \begin_layout Plain Layout
20159 \begin_inset Flex Code
20162 \begin_layout Plain Layout
20174 \begin_layout Plain Layout
20184 Actually, the situation is a bit more complicated: any
20203 other than those described below will produce arabic numerals.
20204 It would not be surprising to see this change in the future.
20210 \begin_inset Flex Code
20213 \begin_layout Plain Layout
20219 : 1, 2, 3,\SpecialChar ldots
20221 \begin_inset Flex Code
20224 \begin_layout Plain Layout
20230 for lower-case letters: a, b, c, \SpecialChar ldots
20232 \begin_inset Flex Code
20235 \begin_layout Plain Layout
20241 for upper-case letters: A, B, C, \SpecialChar ldots
20243 \begin_inset Flex Code
20246 \begin_layout Plain Layout
20252 for lower-case roman numerals: i, ii, iii, \SpecialChar ldots
20254 \begin_inset Flex Code
20257 \begin_layout Plain Layout
20263 for upper-case roman numerals: I, II, III\SpecialChar ldots
20265 \begin_inset Flex Code
20268 \begin_layout Plain Layout
20274 for hebrew numerals.
20278 \begin_layout Standard
20279 If LabelString is not defined, a default value is constructed as follows:
20280 if the counter has a master counter
20281 \begin_inset Flex Code
20284 \begin_layout Plain Layout
20291 \begin_inset Flex Code
20294 \begin_layout Plain Layout
20301 \begin_inset Newline newline
20305 \begin_inset Flex Code
20308 \begin_layout Plain Layout
20318 is used; otherwise the string
20319 \begin_inset Flex Code
20322 \begin_layout Plain Layout
20333 \begin_layout Description
20334 \begin_inset Flex Code
20337 \begin_layout Plain Layout
20338 LabelStringAppendix
20344 \begin_inset Flex Code
20347 \begin_layout Plain Layout
20354 \begin_inset Quotes erd
20358 \begin_inset Quotes erd
20362 \begin_inset Flex Code
20365 \begin_layout Plain Layout
20371 , but for use in the Appendix.
20374 \begin_layout Description
20375 \begin_inset Flex Code
20378 \begin_layout Plain Layout
20385 \begin_inset Flex Code
20388 \begin_layout Plain Layout
20395 \begin_inset Quotes erd
20399 \begin_inset Quotes erd
20402 ] A format for use with formatted references to this counter.
20403 For example, one might want to have references to section numbers appear
20405 \begin_inset Quotes eld
20409 \begin_inset Quotes erd
20413 The string should contain
20414 \begin_inset Quotes eld
20418 \begin_inset Quotes erd
20422 This will be replaced by the counter number itself.
20423 So, for sections, it would be: Section ##.
20426 \begin_layout Description
20427 \begin_inset Flex Code
20430 \begin_layout Plain Layout
20437 \begin_inset Flex Code
20440 \begin_layout Plain Layout
20447 \begin_inset Quotes erd
20451 \begin_inset Quotes erd
20454 ] If this is set to the name of another counter, the present counter will
20455 be reset every time the other one is increased.
20457 \begin_inset Flex Code
20460 \begin_layout Plain Layout
20467 \begin_inset Flex Code
20470 \begin_layout Plain Layout
20479 \begin_layout Subsection
20481 \begin_inset CommandInset label
20483 name "subsec:Font-description"
20490 \begin_layout Standard
20491 A font description looks like this:
20494 \begin_layout LyX-Code
20511 \begin_layout LyX-Code
20515 \begin_layout LyX-Code
20519 \begin_layout Standard
20520 The following commands are available:
20523 \begin_layout Description
20524 \begin_inset Flex Code
20527 \begin_layout Plain Layout
20534 \begin_inset Flex Code
20537 \begin_layout Plain Layout
20546 \begin_inset Flex Code
20549 \begin_layout Plain Layout
20556 \begin_inset Flex Code
20559 \begin_layout Plain Layout
20566 \begin_inset Flex Code
20569 \begin_layout Plain Layout
20576 \begin_inset Flex Code
20579 \begin_layout Plain Layout
20586 \begin_inset Flex Code
20589 \begin_layout Plain Layout
20596 \begin_inset Flex Code
20599 \begin_layout Plain Layout
20606 \begin_inset Flex Code
20609 \begin_layout Plain Layout
20616 \begin_inset Flex Code
20619 \begin_layout Plain Layout
20626 \begin_inset Flex Code
20629 \begin_layout Plain Layout
20636 \begin_inset Flex Code
20639 \begin_layout Plain Layout
20646 \begin_inset Flex Code
20649 \begin_layout Plain Layout
20656 \begin_inset Flex Code
20659 \begin_layout Plain Layout
20666 \begin_inset Flex Code
20669 \begin_layout Plain Layout
20676 \begin_inset Flex Code
20679 \begin_layout Plain Layout
20686 \begin_inset Flex Code
20689 \begin_layout Plain Layout
20696 \begin_inset Flex Code
20699 \begin_layout Plain Layout
20706 \begin_inset Flex Code
20709 \begin_layout Plain Layout
20716 \begin_inset Flex Code
20719 \begin_layout Plain Layout
20726 \begin_inset Flex Code
20729 \begin_layout Plain Layout
20738 \begin_layout Description
20739 \begin_inset Flex Code
20742 \begin_layout Plain Layout
20749 \begin_inset Flex Code
20752 \begin_layout Plain Layout
20761 \begin_inset Flex Code
20764 \begin_layout Plain Layout
20771 \begin_inset Flex Code
20774 \begin_layout Plain Layout
20783 \begin_layout Description
20784 \begin_inset Flex Code
20787 \begin_layout Plain Layout
20794 \begin_inset Flex Code
20797 \begin_layout Plain Layout
20803 ] Valid arguments are:
20804 \begin_inset Flex Code
20807 \begin_layout Plain Layout
20814 \begin_inset Flex Code
20817 \begin_layout Plain Layout
20824 \begin_inset Flex Code
20827 \begin_layout Plain Layout
20834 \begin_inset Flex Code
20837 \begin_layout Plain Layout
20844 \begin_inset Flex Code
20847 \begin_layout Plain Layout
20854 \begin_inset Flex Code
20857 \begin_layout Plain Layout
20864 \begin_inset Flex Code
20867 \begin_layout Plain Layout
20874 \begin_inset Flex Code
20877 \begin_layout Plain Layout
20884 \begin_inset Flex Code
20887 \begin_layout Plain Layout
20894 \begin_inset Flex Code
20897 \begin_layout Plain Layout
20904 \begin_inset Flex Code
20907 \begin_layout Plain Layout
20914 \begin_inset Flex Code
20917 \begin_layout Plain Layout
20924 Each of these turns on or off the corresponding attribute.
20926 \begin_inset Flex Code
20929 \begin_layout Plain Layout
20935 turns on emphasis, and
20936 \begin_inset Flex Code
20939 \begin_layout Plain Layout
20947 \begin_inset Newline newline
20950 If the latter seems puzzling, remember that the font settings for the present
20951 context are generally inherited from the surrounding context.
20953 \begin_inset Flex Code
20956 \begin_layout Plain Layout
20962 would turn off the emphasis that was anyway in effect, say, in a theorem
20966 \begin_layout Description
20967 \begin_inset Flex Code
20970 \begin_layout Plain Layout
20977 \begin_inset Flex Code
20980 \begin_layout Plain Layout
20989 \begin_inset Flex Code
20992 \begin_layout Plain Layout
21001 \begin_layout Description
21002 \begin_inset Flex Code
21005 \begin_layout Plain Layout
21012 \begin_inset Flex Code
21015 \begin_layout Plain Layout
21024 \begin_inset Flex Code
21027 \begin_layout Plain Layout
21034 \begin_inset Flex Code
21037 \begin_layout Plain Layout
21044 \begin_inset Flex Code
21047 \begin_layout Plain Layout
21056 \begin_layout Description
21057 \begin_inset Flex Code
21060 \begin_layout Plain Layout
21067 \begin_inset Flex Code
21070 \begin_layout Plain Layout
21077 \begin_inset Flex Code
21080 \begin_layout Plain Layout
21087 \begin_inset Flex Code
21090 \begin_layout Plain Layout
21099 \begin_inset Flex Code
21102 \begin_layout Plain Layout
21109 \begin_inset Flex Code
21112 \begin_layout Plain Layout
21119 \begin_inset Flex Code
21122 \begin_layout Plain Layout
21129 \begin_inset Flex Code
21132 \begin_layout Plain Layout
21139 \begin_inset Flex Code
21142 \begin_layout Plain Layout
21151 \begin_layout Subsection
21152 \begin_inset CommandInset label
21154 name "subsec:Citation-engine-description"
21158 Cite engine description
21161 \begin_layout Standard
21163 \begin_inset Flex Code
21166 \begin_layout Plain Layout
21172 blocks, as used mainly in cite engine files (see
21173 \begin_inset CommandInset ref
21175 reference "subsec:Cite-Engine-Files"
21182 ), define the citation commands provided by a specific
21183 \begin_inset Quotes eld
21187 \begin_inset Quotes erd
21191 A cite engine, in \SpecialChar LyX
21192 terms, is way specific way to format citations, using
21193 numbers, author names and/or years.
21194 Currently, \SpecialChar LyX
21195 supports three such engine types, namely:
21198 \begin_layout Enumerate
21199 \begin_inset Flex Code
21202 \begin_layout Plain Layout
21208 : the default Bib\SpecialChar TeX
21209 way to format citations, a simple numeric style (e.
21210 \begin_inset space \thinspace{}
21214 \begin_inset Quotes eld
21218 \begin_inset Quotes erd
21224 \begin_layout Enumerate
21225 \begin_inset Flex Code
21228 \begin_layout Plain Layout
21234 : Harvard-styled citations using author names and publication year (e.
21235 \begin_inset space \thinspace{}
21239 \begin_inset Quotes eld
21242 Smith and Miller (2017b)
21243 \begin_inset Quotes erd
21249 \begin_layout Enumerate
21250 \begin_inset Flex Code
21253 \begin_layout Plain Layout
21259 : extended numerical citations that also allow for author or title next
21261 \begin_inset space \thinspace{}
21265 \begin_inset Quotes eld
21268 Smith and Miller [1]
21269 \begin_inset Quotes erd
21275 \begin_layout Standard
21276 \begin_inset Flex Code
21279 \begin_layout Plain Layout
21285 blocks look like this:
21288 \begin_layout LyX-Code
21292 \begin_layout LyX-Code
21296 \begin_layout LyX-Code
21300 \begin_layout LyX-Code
21301 citeyearpar[][]=parencite*
21304 \begin_layout LyX-Code
21308 \begin_layout LyX-Code
21312 \begin_layout Standard
21314 \begin_inset Flex Code
21317 \begin_layout Plain Layout
21323 denotes the engine.
21324 The individual lines respectively define a cite command or cite command
21325 paradigm supported by this engine.
21326 The line can be as simple as a cite command that is used both to name the
21327 respective \SpecialChar LyX
21328 command and the \SpecialChar LaTeX
21329 output or more complex in order to differentiate
21331 The full syntax is:
21334 \begin_layout LyX-Code
21335 LyXName|alias$*<!_stardesc!_stardesctooltip>[][]=latexcmd
21338 \begin_layout Itemize
21339 \begin_inset Flex Code
21342 \begin_layout Plain Layout
21348 : The name as used in the
21349 \begin_inset Flex Code
21352 \begin_layout Plain Layout
21362 \begin_layout Standard
21363 For portability reasons, we try to use the same name for same-formatted
21364 commands in different cite packages (thus many names stem from natbib,
21365 and thus we need to differentiate a
21366 \begin_inset Flex Code
21369 \begin_layout Plain Layout
21375 sometimes, if the \SpecialChar LaTeX
21376 command names differ).
21380 \begin_layout Itemize
21381 \begin_inset Flex Code
21384 \begin_layout Plain Layout
21390 : a (comma-separated) list of commands that fall back to the given
21391 \begin_inset Flex Code
21394 \begin_layout Plain Layout
21400 in the current engine.
21401 This eases the switch of citation packages and engines.
21403 \begin_inset Flex Code
21406 \begin_layout Plain Layout
21413 \begin_inset Flex Code
21416 \begin_layout Plain Layout
21422 in layout definitions.
21425 \begin_layout Itemize
21426 \begin_inset Flex Code
21429 \begin_layout Plain Layout
21435 : The actual \SpecialChar LaTeX
21436 command that is output.
21440 \begin_layout Standard
21441 \begin_inset Flex Code
21444 \begin_layout Plain Layout
21451 \begin_inset Flex Code
21454 \begin_layout Plain Layout
21462 \begin_inset Flex Code
21465 \begin_layout Plain Layout
21472 \begin_inset Flex Code
21475 \begin_layout Plain Layout
21481 will be output to \SpecialChar LaTeX
21485 \begin_layout Standard
21489 \begin_layout Itemize
21490 Capitalization indicates that the command also has a capitalized form (
21491 \begin_inset Flex Code
21494 \begin_layout Plain Layout
21504 \begin_inset Flex Code
21507 \begin_layout Plain Layout
21516 These usually enforce up-casing of name prefixes (
21521 \begin_inset Formula $\Rightarrow$
21531 \begin_layout Itemize
21533 \begin_inset Flex Code
21536 \begin_layout Plain Layout
21542 indicate the number of optional arguments (there can be 0–2).
21545 \begin_layout Itemize
21547 \begin_inset Flex Code
21550 \begin_layout Plain Layout
21556 indicates there is a starred version of the command (
21557 \begin_inset Flex Code
21560 \begin_layout Plain Layout
21570 \begin_inset Flex Code
21573 \begin_layout Plain Layout
21586 \begin_layout Standard
21587 By default, the starred version means: Output all authors even if it should
21589 \begin_inset Quotes eld
21593 \begin_inset Quotes erd
21597 \begin_inset Flex Code
21600 \begin_layout Plain Layout
21609 \begin_layout Standard
21610 If the star has a different meaning for a given command, it can be specified
21612 \begin_inset Flex Code
21615 \begin_layout Plain Layout
21616 <!_stardesc!_stardesctooltip>
21622 Maximal two translatable macro keywords, marked by the prefix
21623 \begin_inset Flex Code
21626 \begin_layout Plain Layout
21633 The first points to the string that replaces the
21634 \begin_inset Quotes eld
21638 \begin_inset Quotes erd
21641 checkbox label in the citation dialog, the second one to an optional tool
21642 tip for this checkbox.
21646 \begin_layout Standard
21647 Note that these two macros have to be defined in a
21648 \begin_inset Flex Code
21651 \begin_layout Plain Layout
21657 (see next section), dropping the
21658 \begin_inset Flex Code
21661 \begin_layout Plain Layout
21667 from the prefix, like this:
21670 \begin_layout LyX-Code
21671 _stardesc Sta&rred command label
21674 \begin_layout LyX-Code
21675 _stardesctooltip Tooltip for the starred command checkbox.
21679 \begin_layout Itemize
21681 \begin_inset Flex Code
21684 \begin_layout Plain Layout
21690 indicates that this command features
21691 \begin_inset Quotes eld
21694 qualified citation lists
21695 \begin_inset Quotes erd
21703 -specific feature for multi-reference citations where an individual pre-
21704 and postnote can be given to each reference in the list.
21705 Please refer to the
21709 manual for details.
21712 \begin_layout Subsection
21713 \begin_inset CommandInset label
21715 name "subsec:Citation-format-description"
21719 Cite format description
21722 \begin_layout Standard
21724 \begin_inset Flex Code
21727 \begin_layout Plain Layout
21733 blocks are used to describe how bibliographic information should be displayed,
21734 both within \SpecialChar LyX
21735 itself (in the citation dialog and in tooltips, for example)
21736 and in XHTML output.
21737 Such a block might look like this:
21740 \begin_layout LyX-Code
21744 \begin_layout LyX-Code
21748 \begin_layout LyX-Code
21752 \begin_layout LyX-Code
21756 \begin_layout Standard
21760 \begin_layout LyX-Code
21764 \begin_layout LyX-Code
21768 \begin_layout LyX-Code
21772 \begin_layout LyX-Code
21776 \begin_layout Standard
21777 In the first case, the individual lines define how the bibliographic information
21778 associated with an article or book, respectively, is to be displayed, and
21779 such a definition can be given for any
21780 \begin_inset Quotes els
21784 \begin_inset Quotes ers
21787 that might be present in a Bib\SpecialChar TeX
21790 defines a default format in the source code that will be used if no specific
21791 definition has been given.
21793 predefines several formats in the file
21794 \begin_inset Flex Code
21797 \begin_layout Plain Layout
21803 , which is included in most of \SpecialChar LyX
21804 's document classes.
21807 \begin_layout Standard
21808 In the second case, the lines define how a specific citation command (in
21810 \begin_inset Flex Code
21813 \begin_layout Plain Layout
21822 \begin_inset Flex Code
21825 \begin_layout Plain Layout
21833 ) is to be displayed on the citation inset label, in the citation dialog,
21834 menu or XHTML output.
21836 defines such formats for the citation style variants it supports via
21838 Document\SpecialChar menuseparator
21839 Setting\SpecialChar menuseparator
21840 Bibliography\SpecialChar ldots
21844 \begin_inset Flex Code
21847 \begin_layout Plain Layout
21853 files that are shipped with \SpecialChar LyX
21855 \begin_inset CommandInset ref
21857 reference "subsec:Cite-Engine-Files"
21867 \begin_layout Standard
21868 The definitions use a simple language that allows Bib\SpecialChar TeX
21869 keys to be replaced
21871 Keys should be enclosed in
21872 \begin_inset Flex Code
21875 \begin_layout Plain Layout
21882 \begin_inset Flex Code
21885 \begin_layout Plain Layout
21892 So a simple definition might look like this:
21895 \begin_layout LyX-Code
21897 \begin_inset Quotes eld
21901 \begin_inset Quotes erd
21907 \begin_layout Standard
21908 This would print the author, followed by a comma, followed by the title,
21909 in quotes, followed by a period.
21912 \begin_layout Standard
21913 Of course, sometimes you may want to print a key only if it exists.
21914 This can be done by using a conditional construction, such as:
21915 \begin_inset Flex Code
21918 \begin_layout Plain Layout
21920 \begin_inset space ~
21930 \begin_inset Flex Code
21933 \begin_layout Plain Layout
21939 key exists, then print
21940 \begin_inset Quotes eld
21944 \begin_inset space ~
21948 \begin_inset Quotes erd
21951 followed by the volume key.
21952 It is also possible to have an else clause in the conditional, such as:
21953 \begin_inset Newline newline
21957 \begin_inset Flex Code
21960 \begin_layout Plain Layout
21961 {%author%[[%author%]][[%editor%, ed.]]}
21967 \begin_inset Newline newline
21971 \begin_inset Flex Code
21974 \begin_layout Plain Layout
21980 key is printed if it exists; otherwise, the editor key is printed, followed
21982 \begin_inset Quotes eld
21986 \begin_inset space ~
21990 \begin_inset Quotes erd
21993 Note that the key is again enclosed in
21994 \begin_inset Flex Code
21997 \begin_layout Plain Layout
22003 signs; the entire conditional is enclosed in braces; and the if and else
22004 clauses are enclosed in double brackets,
22005 \begin_inset Quotes eld
22009 \begin_inset Flex Code
22012 \begin_layout Plain Layout
22019 \begin_inset Quotes eld
22023 \begin_inset Quotes eld
22027 \begin_inset Flex Code
22030 \begin_layout Plain Layout
22037 \begin_inset Quotes erd
22041 There must be no space between any of these.
22044 \begin_layout Standard
22045 Next to the entry keys, there are some special keys that can be used for
22046 these conditionals:
22049 \begin_layout Itemize
22050 \begin_inset Flex Code
22053 \begin_layout Plain Layout
22054 {%dialog%[[true]][[false]]}
22060 \begin_inset Quotes eld
22064 \begin_inset Quotes erd
22067 part for dialogs and menus, the
22068 \begin_inset Quotes eld
22072 \begin_inset Quotes erd
22075 part for other contexts (workarea, export)
22078 \begin_layout Itemize
22079 \begin_inset Flex Code
22082 \begin_layout Plain Layout
22083 {%export%[[true]][[false]]}
22089 \begin_inset Quotes eld
22093 \begin_inset Quotes erd
22096 part for export and menus, the
22097 \begin_inset Quotes eld
22101 \begin_inset Quotes erd
22104 part for other contexts (workarea, dialog)
22107 \begin_layout Itemize
22108 \begin_inset Flex Code
22111 \begin_layout Plain Layout
22118 \begin_inset Quotes eld
22122 \begin_inset Quotes erd
22125 part if another item follows (e.
22126 \begin_inset space \thinspace{}
22129 g., in a citation with multiple keys)
22132 \begin_layout Itemize
22133 \begin_inset Flex Code
22136 \begin_layout Plain Layout
22137 {%second%[[true]][[false]]}
22143 \begin_inset Quotes eld
22147 \begin_inset Quotes erd
22150 if this is the second of multiple items, else the
22151 \begin_inset Quotes eld
22155 \begin_inset Quotes erd
22161 \begin_layout Itemize
22162 \begin_inset Flex Code
22165 \begin_layout Plain Layout
22166 {%ifstar%[[true]][[false]]}
22172 \begin_inset Quotes eld
22176 \begin_inset Quotes erd
22179 part for starred citation commands (such as
22180 \begin_inset Flex Code
22183 \begin_layout Plain Layout
22191 ), the false part for unstarred
22194 \begin_layout Itemize
22195 \begin_inset Flex Code
22198 \begin_layout Plain Layout
22199 {%ifentrytype:<type>%[[true]][[false]]}
22205 \begin_inset Quotes eld
22209 \begin_inset Quotes erd
22212 if the current entry type matches
22213 \begin_inset Flex Code
22216 \begin_layout Plain Layout
22222 , else the false part (e.g., in a citation definition:
22223 \begin_inset Flex Code
22226 \begin_layout Plain Layout
22227 {%ifentrytype:book%[[this is a book]][[this is no book]]}
22235 \begin_layout Itemize
22236 \begin_inset Flex Code
22239 \begin_layout Plain Layout
22240 {%ifmultiple:<authortype>%[[true]][[false]]}
22246 \begin_inset Quotes eld
22250 \begin_inset Quotes erd
22253 if the current author type (author, editor etc.) has multiple authors, else
22254 the false part (e.g., in a bibliography definition:
22255 \begin_inset Flex Code
22258 \begin_layout Plain Layout
22259 {%ifmultiple:editor%[[eds.]][[ed.]]}
22267 \begin_layout Itemize
22268 \begin_inset Flex Code
22271 \begin_layout Plain Layout
22272 {%ifqualified%[[true]][[false]]}
22278 \begin_inset Quotes eld
22282 \begin_inset Quotes erd
22285 part if the current citation is a qualified citation list (a specific
22289 format for multi-reference citations), the false part if this is not the
22293 \begin_layout Standard
22295 \begin_inset Flex Code
22298 \begin_layout Plain Layout
22304 prints the author key as it is recorded in the bibliography file.
22305 This might not be what you want, since it will result in a string such
22307 \begin_inset Quotes eld
22310 Miller, Peter and Smith, Mary and White, Jane
22311 \begin_inset Quotes erd
22315 \begin_inset Quotes eld
22319 \begin_inset Quotes erd
22322 is used by Bib\SpecialChar TeX
22323 to delimit authors).
22325 therefore provides some methods to get properly formatted name lists (which
22326 will also get translated).
22327 The following keys are provided:
22330 \begin_layout Enumerate
22331 For name lists with pre- and surname, suitable for the main authors/editors
22332 of a bibliography item.
22334 \begin_inset Flex Code
22337 \begin_layout Plain Layout
22343 part denotes the kind of list that is requested (e.g.
22345 \begin_inset Flex Code
22348 \begin_layout Plain Layout
22358 \begin_layout Itemize
22359 \begin_inset Flex Code
22362 \begin_layout Plain Layout
22363 %abbrvnames:<nametype>%
22368 : Provides a name list which is abbreviated (with
22369 \begin_inset Quotes eld
22373 \begin_inset Quotes erd
22377 \begin_inset Flex Code
22380 \begin_layout Plain Layout
22389 \begin_layout Itemize
22390 \begin_inset Flex Code
22393 \begin_layout Plain Layout
22394 %fullnames:<nametype>%
22399 : Provides a full name list (never abbreviated with
22400 \begin_inset Quotes eld
22404 \begin_inset Quotes erd
22410 \begin_layout Itemize
22411 \begin_inset Flex Code
22414 \begin_layout Plain Layout
22415 %forceabbrvnames:<nametype>%
22420 : Provides a name list which is always abbreviated (with
22421 \begin_inset Quotes eld
22425 \begin_inset Quotes erd
22429 \begin_inset Flex Code
22432 \begin_layout Plain Layout
22442 \begin_layout Enumerate
22443 Alternative name lists with pre- and surname, if the order of pre- and surname
22444 inside the bibliography item differs (as in:
22445 \begin_inset Quotes eld
22448 Miller, John: Some text, in: Mary Smith, ed.: A volume
22449 \begin_inset Quotes erd
22456 \begin_layout Itemize
22457 \begin_inset Flex Code
22460 \begin_layout Plain Layout
22461 %abbrvbynames:<nametype>%
22466 : Provides a name list which is abbreviated (with
22467 \begin_inset Quotes eld
22471 \begin_inset Quotes erd
22475 \begin_inset Flex Code
22478 \begin_layout Plain Layout
22487 \begin_layout Itemize
22488 \begin_inset Flex Code
22491 \begin_layout Plain Layout
22492 %fullbynames:<nametype>%
22497 : Provides a full name list (never abbreviated with
22498 \begin_inset Quotes eld
22502 \begin_inset Quotes erd
22508 \begin_layout Itemize
22509 \begin_inset Flex Code
22512 \begin_layout Plain Layout
22513 %forceabbrvbynames:<nametype>%
22518 : Provides a name list which is always abbreviated (with
22519 \begin_inset Quotes eld
22523 \begin_inset Quotes erd
22527 \begin_inset Flex Code
22530 \begin_layout Plain Layout
22540 \begin_layout Enumerate
22541 And finally name lists which consist of family names only, as used in author-yea
22543 These do not take a
22544 \begin_inset Flex Code
22547 \begin_layout Plain Layout
22553 part, but always return either an author list or, if this does not exist,
22554 an editor list (as common in author-year labels):
22558 \begin_layout Itemize
22559 \begin_inset Flex Code
22562 \begin_layout Plain Layout
22568 : Provides a name list which is abbreviated (with
22569 \begin_inset Quotes eld
22573 \begin_inset Quotes erd
22577 \begin_inset Flex Code
22580 \begin_layout Plain Layout
22589 \begin_layout Itemize
22590 \begin_inset Flex Code
22593 \begin_layout Plain Layout
22599 : Provides a full name list (never abbreviated with
22600 \begin_inset Quotes eld
22604 \begin_inset Quotes erd
22610 \begin_layout Itemize
22611 \begin_inset Flex Code
22614 \begin_layout Plain Layout
22615 %forceabbrvciteauthor%
22620 : Provides a name list which is always abbreviated (with
22621 \begin_inset Quotes eld
22625 \begin_inset Quotes erd
22629 \begin_inset Flex Code
22632 \begin_layout Plain Layout
22642 \begin_layout Standard
22643 The order of pre- and surname in the former two lists can be adjusted by
22647 \begin_layout Itemize
22648 \begin_inset Flex Code
22651 \begin_layout Plain Layout
22652 !firstnameform %surname%, %prename%
22657 (first author in lists of type 1)
22660 \begin_layout Itemize
22661 \begin_inset Flex Code
22664 \begin_layout Plain Layout
22665 !othernameform %surname%, %prename%
22670 (other authors in lists of type 1)
22673 \begin_layout Itemize
22674 \begin_inset Flex Code
22677 \begin_layout Plain Layout
22678 !firstbynameform %prename% %surname%
22683 (first author in lists of type 2)
22686 \begin_layout Itemize
22687 \begin_inset Flex Code
22690 \begin_layout Plain Layout
22691 !otherbynameform %prename% %surname%
22696 (other authors in lists of type 2)
22699 \begin_layout Standard
22700 This allows you to configure namings like
22701 \begin_inset Quotes eld
22704 Miller, Peter and Mary Smith: \SpecialChar ldots
22705 , in: John Doe and Pat Green, eds.:\SpecialChar ldots
22707 \begin_inset Quotes erd
22713 \begin_layout Standard
22714 There is one other piece of syntax available in definitions, which looks
22716 \begin_inset Flex Code
22719 \begin_layout Plain Layout
22726 This defines a piece of formatting information that is to be used when
22728 \begin_inset Quotes eld
22732 \begin_inset Quotes erd
22736 Obviously, we do not want to output HTML tags when writing plain text,
22737 so they should be wrapped in
22738 \begin_inset Quotes eld
22742 \begin_inset Quotes erd
22746 \begin_inset Quotes eld
22750 \begin_inset Quotes erd
22756 \begin_layout Standard
22757 Two special sorts of definitions are also possible in a
22758 \begin_inset Flex Code
22761 \begin_layout Plain Layout
22768 An example of the first would be:
22771 \begin_layout LyX-Code
22773 \begin_inset Quotes eld
22777 \begin_inset Quotes erd
22783 \begin_layout Standard
22784 This is an abbreviation, or macro, and it can be used by treating it as
22786 \begin_inset Flex Code
22789 \begin_layout Plain Layout
22798 \begin_inset Flex Code
22801 \begin_layout Plain Layout
22807 exactly as it would treat its definition.
22808 So, let us issue the obvious
22816 \begin_layout LyX-Code
22820 \begin_layout Standard
22821 or anything like it.
22823 shouldn't go into an infinite loop, but it may go into a long one before
22827 \begin_layout Standard
22828 The second sort of special definition might look like this:
22831 \begin_layout LyX-Code
22835 \begin_layout Standard
22836 This defines a translatable piece of text, which allows relevant parts of
22837 the bibliography or citation to be translated.
22838 It can be included in a definition by treating it as a key:
22839 \begin_inset Flex Code
22842 \begin_layout Plain Layout
22849 Several of these are predefined in
22850 \begin_inset Flex Code
22853 \begin_layout Plain Layout
22860 \begin_inset Flex Code
22863 \begin_layout Plain Layout
22870 Note that these are not macros, in the sense just defined.
22871 They will not be expanded.
22874 \begin_layout Standard
22875 So here then is an example that use all these features:
22876 \begin_inset VSpace defskip
22882 \begin_layout Standard
22886 !authoredit {%author%[[%author%, ]][[{%editor%[[%editor%, %_edtext%, ]]}]]}
22889 \begin_layout Standard
22890 \begin_inset VSpace defskip
22893 This defines a macro that prints the author, followed by a comma, if the
22895 \begin_inset Flex Code
22898 \begin_layout Plain Layout
22904 key is defined, or else prints the name of the editor, followed by the
22906 \begin_inset Flex Code
22909 \begin_layout Plain Layout
22915 or its translation (it is by default
22916 \begin_inset Quotes eld
22920 \begin_inset Quotes erd
22924 \begin_inset Flex Code
22927 \begin_layout Plain Layout
22934 Note that this is in fact defined in
22935 \begin_inset Flex Code
22938 \begin_layout Plain Layout
22944 , so you can use it in your own definitions, or re-definitions, if you load
22948 \begin_layout Section
22949 \begin_inset CommandInset label
22951 name "sec:Tags-for-XHTML"
22955 Tags for XHTML output
22958 \begin_layout Standard
22959 As with \SpecialChar LaTeX
22960 or DocBook, the format of \SpecialChar LyX
22961 's XHTML output is also controlled by
22962 layout information.
22963 In general, \SpecialChar LyX
22964 provides sensible defaults and, as mentioned earlier, it will
22965 even construct default CSS style rules from the other layout tags.
22966 For example, \SpecialChar LyX
22967 will attempt to use the information provided in the
22968 \begin_inset Flex Code
22971 \begin_layout Plain Layout
22977 declaration for the Chapter style to write CSS that will appropriately
22978 format chapter headings.
22981 \begin_layout Standard
22982 In many cases, then, you may not have to do anything at all to get acceptable
22983 XHTML output for your own environments, custom insets, and so forth.
22984 But in some cases you will, and so \SpecialChar LyX
22985 provides a number of layout tags that
22986 can be used to customize the XHTML and CSS that are generated.
22989 \begin_layout Standard
22990 Note that there are two tags,
22991 \begin_inset Flex Code
22994 \begin_layout Plain Layout
23001 \begin_inset Flex Code
23004 \begin_layout Plain Layout
23010 that may appear outside style and inset declarations.
23012 \begin_inset CommandInset ref
23014 reference "subsec:General-text-class"
23018 for details on these.
23021 \begin_layout Subsection
23022 \begin_inset CommandInset label
23024 name "subsec:Paragraph-Style-XHTML"
23031 \begin_layout Standard
23032 The sort of XHTML \SpecialChar LyX
23033 outputs for a paragraph depends upon whether we are dealing
23034 with a normal paragraph, a command, or an environment, where this is itself
23035 determined by the contents of the corresponding
23036 \begin_inset Flex Code
23039 \begin_layout Plain Layout
23050 \begin_layout Standard
23051 For a command or normal paragraph, the output XHTML has the following form:
23054 \begin_layout LyX-Code
23056 \begin_inset Quotes erd
23060 \begin_inset Quotes erd
23066 \begin_layout LyX-Code
23068 \begin_inset Quotes erd
23072 \begin_inset Quotes erd
23078 \begin_layout LyX-Code
23079 Contents of the paragraph.
23082 \begin_layout LyX-Code
23086 \begin_layout Standard
23087 The label tags are of course omitted if the paragraph does not have a label.
23090 \begin_layout Standard
23091 For an environment that is not some sort of list, the XHTML takes this form:
23094 \begin_layout LyX-Code
23096 \begin_inset Quotes erd
23100 \begin_inset Quotes erd
23106 \begin_layout LyX-Code
23108 \begin_inset Quotes erd
23112 \begin_inset Quotes erd
23116 \begin_inset Quotes erd
23120 \begin_inset Quotes erd
23123 >Environment Label</labeltag>First paragraph.</itemtag>
23126 \begin_layout LyX-Code
23127 <itemtag>Second paragraph.</itemtag>
23130 \begin_layout LyX-Code
23134 \begin_layout Standard
23135 Note that the label is output only for the first paragraph, as it should
23136 be for a theorem, for example.
23140 \begin_layout Standard
23141 For a list, we have one of these forms:
23144 \begin_layout LyX-Code
23146 \begin_inset Quotes erd
23150 \begin_inset Quotes erd
23156 \begin_layout LyX-Code
23158 \begin_inset Quotes erd
23162 \begin_inset Quotes erd
23166 \begin_inset Quotes erd
23170 \begin_inset Quotes erd
23173 >List Label</labeltag>First item.</itemtag>
23176 \begin_layout LyX-Code
23178 \begin_inset Quotes erd
23182 \begin_inset Quotes erd
23186 \begin_inset Quotes erd
23190 \begin_inset Quotes erd
23193 >List Label</labeltag>Second item.</itemtag>
23196 \begin_layout LyX-Code
23200 \begin_layout LyX-Code
23204 \begin_layout LyX-Code
23206 \begin_inset Quotes erd
23210 \begin_inset Quotes erd
23216 \begin_layout LyX-Code
23218 \begin_inset Quotes erd
23222 \begin_inset Quotes erd
23225 >List Label</labeltag><itemtag attr=
23226 \begin_inset Quotes erd
23230 \begin_inset Quotes erd
23233 >First item.</itemtag>
23236 \begin_layout LyX-Code
23238 \begin_inset Quotes erd
23242 \begin_inset Quotes erd
23245 >List Label</labeltag><itemtag attr=
23246 \begin_inset Quotes erd
23250 \begin_inset Quotes erd
23253 >Second item.</itemtag>
23256 \begin_layout LyX-Code
23260 \begin_layout Standard
23261 Note the different orders of
23262 \begin_inset Flex Code
23265 \begin_layout Plain Layout
23272 \begin_inset Flex Code
23275 \begin_layout Plain Layout
23282 Which order we get depends upon the setting of
23283 \begin_inset Flex Code
23286 \begin_layout Plain Layout
23293 \begin_inset Flex Code
23296 \begin_layout Plain Layout
23302 is false (the default), you get the first of these, with the label within
23303 the item; if true, you get the second, with the label outside the item.
23306 \begin_layout Standard
23307 The specific tags and attributes output for each paragraph type can be controlle
23308 d by means of the layout tags we are about to describe.
23309 As mentioned earlier, however, \SpecialChar LyX
23310 uses sensible defaults for many of these,
23311 so you often may not need to do very much to get good XHTML output.
23312 Think of the available tags as there so you can tweak things to your liking.
23315 \begin_layout Description
23316 \begin_inset Flex Code
23319 \begin_layout Plain Layout
23326 \begin_inset Flex Code
23329 \begin_layout Plain Layout
23335 ] Specifies attribute information to be output with the main tag.
23337 \begin_inset Quotes eld
23341 \begin_inset Flex Code
23344 \begin_layout Plain Layout
23351 \begin_inset Quotes erd
23355 By default, \SpecialChar LyX
23357 \begin_inset Quotes eld
23361 \begin_inset Flex Code
23364 \begin_layout Plain Layout
23371 \begin_inset Quotes erd
23375 \begin_inset Flex Code
23378 \begin_layout Plain Layout
23384 is the \SpecialChar LyX
23385 name of the layout, made lowercase, for example: chapter.
23390 contain any style information.
23392 \begin_inset Flex Code
23395 \begin_layout Plain Layout
23404 \begin_layout Description
23405 \begin_inset Flex Code
23408 \begin_layout Plain Layout
23415 \begin_inset Flex Code
23418 \begin_layout Plain Layout
23428 ] Whether to output the default CSS information \SpecialChar LyX
23429 generates for this layout,
23430 even if additional information is explicitly provided via
23431 \begin_inset Flex Code
23434 \begin_layout Plain Layout
23442 \begin_inset Flex Code
23445 \begin_layout Plain Layout
23451 allows you to alter or augment the generated CSS, rather than to override
23454 \begin_inset Flex Code
23457 \begin_layout Plain Layout
23466 \begin_layout Description
23467 \begin_inset Flex Code
23470 \begin_layout Plain Layout
23477 \begin_inset Flex Code
23480 \begin_layout Plain Layout
23486 ] The tag to be used for individual paragraphs of environments, replacing
23488 \begin_inset Flex Code
23491 \begin_layout Plain Layout
23497 in the examples above.
23499 \begin_inset Flex Code
23502 \begin_layout Plain Layout
23511 \begin_layout Description
23512 \begin_inset Flex Code
23515 \begin_layout Plain Layout
23522 \begin_inset Flex Code
23525 \begin_layout Plain Layout
23531 ] Attributes for the item tag.
23533 \begin_inset Quotes eld
23537 \begin_inset Flex Code
23540 \begin_layout Plain Layout
23541 class=`layoutname_item'
23547 \begin_inset Quotes erd
23555 contain any style information.
23557 \begin_inset Flex Code
23560 \begin_layout Plain Layout
23569 \begin_layout Description
23570 \begin_inset Flex Code
23573 \begin_layout Plain Layout
23580 \begin_inset Flex Code
23583 \begin_layout Plain Layout
23589 ] The tag to be used for paragraph and item labels, replacing
23590 \begin_inset Flex Code
23593 \begin_layout Plain Layout
23599 in the examples above.
23601 \begin_inset Flex Code
23604 \begin_layout Plain Layout
23611 \begin_inset Flex Code
23614 \begin_layout Plain Layout
23621 \begin_inset Flex Code
23624 \begin_layout Plain Layout
23631 \begin_inset Flex Code
23634 \begin_layout Plain Layout
23635 Centered_Top_Environment
23640 , in which case it defaults to
23641 \begin_inset Flex Code
23644 \begin_layout Plain Layout
23653 \begin_layout Description
23654 \begin_inset Flex Code
23657 \begin_layout Plain Layout
23664 \begin_inset Flex Code
23667 \begin_layout Plain Layout
23673 ] Attributes for the label tag.
23675 \begin_inset Quotes eld
23679 \begin_inset Flex Code
23682 \begin_layout Plain Layout
23683 class=`layoutname_label'
23689 \begin_inset Quotes erd
23697 contain any style information.
23699 \begin_inset Flex Code
23702 \begin_layout Plain Layout
23711 \begin_layout Description
23712 \begin_inset Flex Code
23715 \begin_layout Plain Layout
23722 \begin_inset Flex Code
23725 \begin_layout Plain Layout
23735 ] Meaningful only for list-like environments, this tag controls whether
23736 the label tag is output before or inside the item tag.
23737 This is used, for example, in the description environment, where we want
23739 \begin_inset Flex Code
23742 \begin_layout Plain Layout
23743 <dt>\SpecialChar ldots
23744 </dt><dd>\SpecialChar ldots
23752 \begin_inset Flex Code
23755 \begin_layout Plain Layout
23761 : The label tag is output inside the item tag.
23764 \begin_layout Description
23765 \begin_inset Flex Code
23768 \begin_layout Plain Layout
23774 Information to be output in the
23775 \begin_inset Flex Code
23778 \begin_layout Plain Layout
23784 section when this style is used.
23785 This might, for example, be used to include a
23786 \begin_inset Flex Code
23789 \begin_layout Plain Layout
23796 \begin_inset Flex Code
23799 \begin_layout Plain Layout
23808 \begin_layout Description
23809 \begin_inset Flex Code
23812 \begin_layout Plain Layout
23818 CSS style information to be included when this style is used.
23819 Note that this will automatically be wrapped in a layout-generated
23820 \begin_inset Flex Code
23823 \begin_layout Plain Layout
23829 block, so only the CSS itself need be included.
23831 \begin_inset Flex Code
23834 \begin_layout Plain Layout
23843 \begin_layout Description
23844 \begin_inset Flex Code
23847 \begin_layout Plain Layout
23854 \begin_inset Flex Code
23857 \begin_layout Plain Layout
23863 ] The tag to be used for the main label, replacing
23864 \begin_inset Flex Code
23867 \begin_layout Plain Layout
23873 in the examples above.
23875 \begin_inset Flex Code
23878 \begin_layout Plain Layout
23887 \begin_layout Description
23888 \begin_inset Flex Code
23891 \begin_layout Plain Layout
23898 \begin_inset Flex Code
23901 \begin_layout Plain Layout
23911 ] Marks this style as the one to be used to generate the
23912 \begin_inset Flex Code
23915 \begin_layout Plain Layout
23921 tag for the XHTML file.
23922 By default, it is false.
23924 \begin_inset Flex Code
23927 \begin_layout Plain Layout
23933 file sets it to true for the
23934 \begin_inset Flex Code
23937 \begin_layout Plain Layout
23947 \begin_layout Subsection
23951 \begin_layout Standard
23952 The XHTML output of insets can also be controlled by information in layout
23957 \begin_layout Plain Layout
23958 At present, this is true only for
23959 \begin_inset Quotes eld
23963 \begin_inset Quotes erd
23966 insets (insets you can type into) and is not true for
23967 \begin_inset Quotes eld
23971 \begin_inset Quotes erd
23974 insets (insets that are associated with dialog boxes).
23979 Here, too, \SpecialChar LyX
23980 tries to provide sensible defaults, and it constructs default
23982 But everything can be customized.
23985 \begin_layout Standard
23986 The XHTML \SpecialChar LyX
23987 outputs for an inset has the following form:
23990 \begin_layout LyX-Code
23992 \begin_inset Quotes erd
23996 \begin_inset Quotes erd
24002 \begin_layout LyX-Code
24003 <labeltag>Label</labeltag>
24006 \begin_layout LyX-Code
24008 \begin_inset Quotes erd
24012 \begin_inset Quotes erd
24015 >Contents of the inset.</innertag>
24018 \begin_layout LyX-Code
24022 \begin_layout Standard
24023 If the inset permits multiple paragraphs—that is, if
24024 \begin_inset Flex Code
24027 \begin_layout Plain Layout
24033 is true—then the contents of the inset will itself be output as paragraphs
24034 formatted according to the styles used for those paragraphs (standard,
24035 quote, and the like).
24036 The label tag is of course omitted if the paragraph does not have a label
24037 and, at present, is always
24038 \begin_inset Flex Code
24041 \begin_layout Plain Layout
24048 The inner tag is optional and, by default, does not appear.
24051 \begin_layout Standard
24052 The specific tags and attributes output for each inset can be controlled
24053 by means of the following layout tags.
24056 \begin_layout Description
24057 \begin_inset Flex Code
24060 \begin_layout Plain Layout
24067 \begin_inset Flex Code
24070 \begin_layout Plain Layout
24076 ] Specifies attribute information to be output with the main tag.
24078 \begin_inset Quotes eld
24082 \begin_inset Flex Code
24085 \begin_layout Plain Layout
24086 class=`myinset' onclick=`\SpecialChar ldots
24093 \begin_inset Quotes erd
24097 By default, \SpecialChar LyX
24099 \begin_inset Quotes eld
24103 \begin_inset Flex Code
24106 \begin_layout Plain Layout
24113 \begin_inset Quotes erd
24117 \begin_inset Flex Code
24120 \begin_layout Plain Layout
24126 is the \SpecialChar LyX
24127 name of the inset, made lowercase and with non-alphanumeric characters
24128 converted to underscores, for example: footnote.
24131 \begin_layout Description
24132 \begin_inset Flex Code
24135 \begin_layout Plain Layout
24142 \begin_inset Flex Code
24145 \begin_layout Plain Layout
24155 ] Whether to output the default CSS information \SpecialChar LyX
24156 generates for this layout,
24157 even if additional information is explicitly provided via
24158 \begin_inset Flex Code
24161 \begin_layout Plain Layout
24169 \begin_inset Flex Code
24172 \begin_layout Plain Layout
24178 allows you to alter or augment the generated CSS, rather than to override
24183 \begin_layout Description
24184 \begin_inset Flex Code
24187 \begin_layout Plain Layout
24194 \begin_inset Flex Code
24197 \begin_layout Plain Layout
24203 ] Attributes for the inner tag.
24205 \begin_inset Quotes eld
24209 \begin_inset Flex Code
24212 \begin_layout Plain Layout
24213 class=`insetname_inner'
24219 \begin_inset Quotes erd
24225 \begin_layout Description
24226 \begin_inset Flex Code
24229 \begin_layout Plain Layout
24236 \begin_inset Flex Code
24239 \begin_layout Plain Layout
24245 ] The inner tag, replacing
24246 \begin_inset Flex Code
24249 \begin_layout Plain Layout
24255 in the examples above.
24256 By default, there is none.
24259 \begin_layout Description
24260 \begin_inset Flex Code
24263 \begin_layout Plain Layout
24270 \begin_inset Flex Code
24273 \begin_layout Plain Layout
24281 ] Whether this inset represents a standalone block of text (such as a footnote)
24282 or instead represents material that is included in the surrounding text
24283 (such as a branch).
24287 \begin_layout Description
24288 \begin_inset Flex Code
24291 \begin_layout Plain Layout
24298 \begin_inset Flex Code
24301 \begin_layout Plain Layout
24307 ] A label for this inset, possibly including a reference to a counter.
24308 For example, for footnote, it might be:
24309 \begin_inset Flex Code
24312 \begin_layout Plain Layout
24321 This is optional, and there is no default.
24324 \begin_layout Description
24325 \begin_inset Flex Code
24328 \begin_layout Plain Layout
24334 Information to be output in the
24335 \begin_inset Flex Code
24338 \begin_layout Plain Layout
24344 section when this style is used.
24345 This might, for example, be used to include a
24346 \begin_inset Flex Code
24349 \begin_layout Plain Layout
24356 \begin_inset Flex Code
24359 \begin_layout Plain Layout
24368 \begin_layout Description
24369 \begin_inset Flex Code
24372 \begin_layout Plain Layout
24378 CSS style information to be included when this style is used.
24379 Note that this will automatically be wrapped in a layout-generated
24380 \begin_inset Flex Code
24383 \begin_layout Plain Layout
24389 block, so only the CSS itself need be included.
24392 \begin_layout Description
24393 \begin_inset Flex Code
24396 \begin_layout Plain Layout
24403 \begin_inset Flex Code
24406 \begin_layout Plain Layout
24412 ] The tag to be used for the main label, replacing
24413 \begin_inset Flex Code
24416 \begin_layout Plain Layout
24422 in the examples above.
24423 The default depends upon the setting of
24424 \begin_inset Flex Code
24427 \begin_layout Plain Layout
24434 \begin_inset Flex Code
24437 \begin_layout Plain Layout
24443 is true, the default is
24444 \begin_inset Flex Code
24447 \begin_layout Plain Layout
24453 ; if it is false, the default is
24454 \begin_inset Flex Code
24457 \begin_layout Plain Layout
24466 \begin_layout Subsection
24470 \begin_layout Standard
24471 The XHTML output for floats too can be controlled by layout information.
24472 The output has the following form:
24475 \begin_layout LyX-Code
24477 \begin_inset Quotes erd
24481 \begin_inset Quotes erd
24487 \begin_layout LyX-Code
24488 Contents of the float.
24491 \begin_layout LyX-Code
24495 \begin_layout Standard
24496 The caption, if there is one, is a separate inset and will be output as
24498 Its appearance can be controlled via the InsetLayout for caption insets.
24502 \begin_layout Description
24503 \begin_inset Flex Code
24506 \begin_layout Plain Layout
24513 \begin_inset Flex Code
24516 \begin_layout Plain Layout
24522 ] Specifies attribute information to be output with the main tag.
24524 \begin_inset Quotes eld
24528 \begin_inset Flex Code
24531 \begin_layout Plain Layout
24532 class=`myfloat' onclick=`\SpecialChar ldots
24539 \begin_inset Quotes erd
24543 By default, \SpecialChar LyX
24545 \begin_inset Quotes eld
24549 \begin_inset Flex Code
24552 \begin_layout Plain Layout
24553 class=`float float-floattype'
24559 \begin_inset Quotes erd
24563 \begin_inset Flex Code
24566 \begin_layout Plain Layout
24572 is \SpecialChar LyX
24573 's name for this type of float, as determined by the float declaration
24575 \begin_inset CommandInset ref
24577 reference "subsec:Floats"
24581 ), though made lowercase and with non-alphanumeric characters converted
24582 to underscores, for example: float-table.
24585 \begin_layout Description
24586 \begin_inset Flex Code
24589 \begin_layout Plain Layout
24595 CSS style information to be included when this float is used.
24596 Note that this will automatically be wrapped in a layout-generated
24597 \begin_inset Flex Code
24600 \begin_layout Plain Layout
24606 block, so only the CSS itself need be included.
24609 \begin_layout Description
24610 \begin_inset Flex Code
24613 \begin_layout Plain Layout
24620 \begin_inset Flex Code
24623 \begin_layout Plain Layout
24629 ] The tag to be used for this float, replacing
24630 \begin_inset Quotes eld
24634 \begin_inset Flex Code
24637 \begin_layout Plain Layout
24644 \begin_inset Quotes erd
24647 in the example above.
24649 \begin_inset Flex Code
24652 \begin_layout Plain Layout
24658 and will rarely need changing.
24661 \begin_layout Subsection
24662 Bibliography formatting
24665 \begin_layout Standard
24666 The bibliography can be formatted using
24667 \begin_inset Flex Code
24670 \begin_layout Plain Layout
24678 \begin_inset CommandInset ref
24680 reference "subsec:Citation-format-description"
24687 \begin_layout Subsection
24692 \begin_layout Standard
24693 We have several times mentioned that \SpecialChar LyX
24694 will generate default CSS style rules
24695 for both insets and paragraph styles, based upon the other layout information
24697 In this section, we shall say a word about which layout information \SpecialChar LyX
24702 \begin_layout Standard
24703 At present, \SpecialChar LyX
24704 auto-generates CSS only for font information, making use of
24706 \begin_inset Flex Code
24709 \begin_layout Plain Layout
24716 \begin_inset Flex Code
24719 \begin_layout Plain Layout
24726 \begin_inset Flex Code
24729 \begin_layout Plain Layout
24736 \begin_inset Flex Code
24739 \begin_layout Plain Layout
24746 \begin_inset Flex Code
24749 \begin_layout Plain Layout
24756 \begin_inset CommandInset ref
24758 reference "subsec:Font-description"
24763 The translation is mostly straightforward and obvious.
24765 \begin_inset Quotes eld
24769 \begin_inset Flex Code
24772 \begin_layout Plain Layout
24779 \begin_inset Quotes erd
24783 \begin_inset Quotes eld
24787 \begin_inset Flex Code
24790 \begin_layout Plain Layout
24791 font-family: sans-serif;
24797 \begin_inset Quotes erd
24801 The correspondence of \SpecialChar LyX
24802 sizes and CSS sizes is a little less obvious but
24803 nonetheless intuitive.
24805 \begin_inset Flex Code
24808 \begin_layout Plain Layout
24815 \begin_inset Flex URL
24818 \begin_layout Plain Layout
24828 \begin_layout Chapter
24829 Including External Material
24830 \begin_inset CommandInset label
24832 name "chap:Including-External-Material"
24839 \begin_layout Standard
24840 \begin_inset Box Shadowbox
24850 height_special "totalheight"
24855 backgroundcolor "none"
24858 \begin_layout Plain Layout
24859 WARNING: This portion of the documentation has not been updated for some
24861 We certainly hope that it is still accurate, but there are no guarantees.
24869 \begin_layout Standard
24870 The use of material from sources external to \SpecialChar LyX
24871 is covered in detail in the
24877 This part of the manual covers what needs to happen behind the scenes for
24878 new sorts of material to be included.
24881 \begin_layout Section
24885 \begin_layout Standard
24886 The external material feature is based on the concept of a
24891 A template is a specification of how \SpecialChar LyX
24892 should interface with a certain kind
24894 As bundled, \SpecialChar LyX
24895 comes with predefined templates for Xfig figures, various
24896 raster format images, chess diagrams, and LilyPond music notation.
24897 You can check the actual list by using the menu
24898 \begin_inset Flex Noun
24901 \begin_layout Plain Layout
24902 Insert\SpecialChar menuseparator
24903 File\SpecialChar menuseparator
24910 Furthermore, it is possible to roll your own template to support a specific
24912 Later we'll describe in more detail what is involved, and hopefully you
24913 will submit all the templates you create so we can include them in a later
24918 \begin_layout Standard
24919 Another basic idea of the external material feature is to distinguish between
24920 the original file that serves as a base for final material and the produced
24921 file that is included in your exported or printed document.
24922 For example, consider the case of a figure produced with
24923 \begin_inset Flex Code
24926 \begin_layout Plain Layout
24933 The Xfig application itself works on an original file with the
24934 \begin_inset Flex Code
24937 \begin_layout Plain Layout
24944 Within Xfig, you create and change your figure, and when you are done,
24946 \begin_inset Flex Code
24949 \begin_layout Plain Layout
24956 When you want to include the figure in your document, you invoke
24957 \begin_inset Flex Code
24960 \begin_layout Plain Layout
24966 in order to create a PostScript file that can readily be included in your
24970 \begin_inset Flex Code
24973 \begin_layout Plain Layout
24979 file is the original file, and the PostScript file is the produced file.
24982 \begin_layout Standard
24983 This distinction is important in order to allow updating of the material
24984 while you are in the process of writing the document.
24985 Furthermore, it provides us with the flexibility that is needed to support
24986 multiple export formats.
24987 For instance, in the case of a plain text file, it is not exactly an award-winn
24988 ing idea to include the figure as raw PostScript.
24989 Instead, you would either prefer to just include a reference to the figure
24990 or try to invoke some graphics to ASCII converter to make the final result
24991 look similar to the real graphics.
24992 The external material management allows you to do this, because it is parametri
24993 zed on the different export formats that \SpecialChar LyX
24997 \begin_layout Standard
24998 Besides supporting the production of different products according to the
24999 exported format, it supports tight integration with editing and viewing
25001 In the case of an Xfig figure, you are able to invoke Xfig on the original
25002 file with a single click from within the external material dialog in \SpecialChar LyX
25004 and also preview the produced PostScript file with Ghostview with another
25006 No more fiddling around with the command line and/or file browsers to locate
25007 and manipulate the original or produced files.
25008 In this way, you are finally able to take full advantage of the many different
25009 applications that are relevant to use when you write your documents, and
25010 ultimately be more productive.
25013 \begin_layout Section
25014 The external template configuration files
25017 \begin_layout Standard
25018 It is relatively easy to add custom external template definitions to \SpecialChar LyX
25020 However, be aware that doing this in an careless manner most probably
25024 introduce an easily exploitable security hole.
25025 So before you do this, please read the discussion about security in
25026 \begin_inset CommandInset ref
25028 reference "sec:Security-discussion"
25035 \begin_layout Standard
25036 Having said that, we encourage you to submit any interesting templates that
25041 \begin_layout Standard
25042 The external templates are defined in the
25043 \begin_inset Flex Code
25046 \begin_layout Plain Layout
25052 files that are stored in the
25053 \begin_inset Flex Code
25056 \begin_layout Plain Layout
25057 LyXDir/lib/xtemplates/
25063 Each template is defined in a file of its own.
25064 You can place your own templates in
25065 \begin_inset Flex Code
25068 \begin_layout Plain Layout
25069 UserDir/xtemplates/
25074 or copy existing templates to that directory in order to modify them.
25077 \begin_layout Standard
25078 A typical template looks like this:
25081 \begin_layout LyX-Code
25085 \begin_layout LyX-Code
25086 GuiName "XFig: $$AbsOrRelPathParent$$Basename"
25089 \begin_layout LyX-Code
25093 \begin_layout LyX-Code
25097 \begin_layout LyX-Code
25101 \begin_layout LyX-Code
25105 \begin_layout LyX-Code
25109 \begin_layout LyX-Code
25110 AutomaticProduction true
25113 \begin_layout LyX-Code
25117 \begin_layout LyX-Code
25121 \begin_layout LyX-Code
25125 \begin_layout LyX-Code
25126 TransformCommand Rotate RotationLatexCommand
25129 \begin_layout LyX-Code
25130 TransformCommand Resize ResizeLatexCommand
25133 \begin_layout LyX-Code
25134 Product "$$RotateFront$$ResizeFront
25137 \begin_layout LyX-Code
25142 input{$$AbsOrRelPathMaster$$Basename.pstex_t}
25145 \begin_layout LyX-Code
25146 $$ResizeBack$$RotateBack"
25149 \begin_layout LyX-Code
25153 \begin_layout LyX-Code
25154 UpdateResult "$$AbsPath$$Basename.pstex_t"
25157 \begin_layout LyX-Code
25158 Requirement "graphicx"
25161 \begin_layout LyX-Code
25162 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
25165 \begin_layout LyX-Code
25166 ReferencedFile latex "$$AbsPath$$Basename.eps"
25169 \begin_layout LyX-Code
25170 ReferencedFile dvi "$$AbsPath$$Basename.eps"
25173 \begin_layout LyX-Code
25177 \begin_layout LyX-Code
25181 \begin_layout LyX-Code
25182 TransformCommand Rotate RotationLatexCommand
25185 \begin_layout LyX-Code
25186 TransformCommand Resize ResizeLatexCommand
25189 \begin_layout LyX-Code
25190 Product "$$RotateFront$$ResizeFront
25193 \begin_layout LyX-Code
25198 input{$$AbsOrRelPathMaster$$Basename.pdftex_t}
25201 \begin_layout LyX-Code
25202 $$ResizeBack$$RotateBack"
25205 \begin_layout LyX-Code
25206 UpdateFormat pdftex
25209 \begin_layout LyX-Code
25210 UpdateResult "$$AbsPath$$Basename.pdftex_t"
25213 \begin_layout LyX-Code
25214 Requirement "graphicx"
25217 \begin_layout LyX-Code
25218 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pdftex_t"
25221 \begin_layout LyX-Code
25222 ReferencedFile latex "$$AbsPath$$Basename.pdf"
25225 \begin_layout LyX-Code
25229 \begin_layout LyX-Code
25233 \begin_layout LyX-Code
25234 Product "[XFig: $$FName]"
25237 \begin_layout LyX-Code
25241 \begin_layout LyX-Code
25245 \begin_layout LyX-Code
25246 Product "<graphic fileref=
25248 "$$AbsOrRelPathMaster$$Basename.eps
25253 \begin_layout LyX-Code
25257 \begin_layout LyX-Code
25261 \begin_layout LyX-Code
25262 UpdateResult "$$AbsPath$$Basename.eps"
25265 \begin_layout LyX-Code
25266 ReferencedFile docbook "$$AbsPath$$Basename.eps"
25269 \begin_layout LyX-Code
25270 ReferencedFile docbook-xml "$$AbsPath$$Basename.eps"
25273 \begin_layout LyX-Code
25277 \begin_layout LyX-Code
25281 \begin_layout Standard
25282 As you can see, the template is enclosed in
25283 \begin_inset Flex Code
25286 \begin_layout Plain Layout
25294 \begin_inset Flex Code
25297 \begin_layout Plain Layout
25304 It contains a header specifying some general settings and, for each supported
25305 primary document file format, a section
25306 \begin_inset Flex Code
25309 \begin_layout Plain Layout
25317 \begin_inset Flex Code
25320 \begin_layout Plain Layout
25329 \begin_layout Subsection
25330 The template header
25333 \begin_layout Description
25334 \begin_inset Flex Code
25337 \begin_layout Plain Layout
25338 AutomaticProduction
25339 \begin_inset space ~
25347 Whether the file represented by the template must be generated by \SpecialChar LyX
25349 This command must occur exactly once.
25352 \begin_layout Description
25353 \begin_inset Flex Code
25356 \begin_layout Plain Layout
25358 \begin_inset space ~
25366 A glob pattern that is used in the file dialog to filter out the desired
25368 If there is more than one possible file extension (e.
25369 \begin_inset space \thinspace{}
25373 \begin_inset space \space{}
25377 \begin_inset Flex Code
25380 \begin_layout Plain Layout
25387 \begin_inset Flex Code
25390 \begin_layout Plain Layout
25396 ), use something like
25397 \begin_inset Flex Code
25400 \begin_layout Plain Layout
25407 This command must occur exactly once.
25410 \begin_layout Description
25411 \begin_inset Flex Code
25414 \begin_layout Plain Layout
25416 \begin_inset space ~
25424 The text that is displayed on the button.
25425 This command must occur exactly once.
25428 \begin_layout Description
25429 \begin_inset Flex Code
25432 \begin_layout Plain Layout
25434 \begin_inset space ~
25438 \begin_inset space ~
25446 The help text that is used in the External dialog.
25447 Provide enough information to explain to the user just what the template
25448 can provide him with.
25449 This command must occur exactly once.
25452 \begin_layout Description
25453 \begin_inset Flex Code
25456 \begin_layout Plain Layout
25458 \begin_inset space ~
25466 The file format of the original file.
25467 This must be the name of a format that is known to \SpecialChar LyX
25469 \begin_inset CommandInset ref
25471 reference "sec:Formats"
25477 \begin_inset Quotes eld
25481 \begin_inset Flex Code
25484 \begin_layout Plain Layout
25491 \begin_inset Quotes erd
25494 if the template can handle original files of more than one format.
25496 will attempt to interrogate the file itself in order to deduce its format
25498 This command must occur exactly once.
25501 \begin_layout Description
25502 \begin_inset Flex Code
25505 \begin_layout Plain Layout
25507 \begin_inset space ~
25515 A unique name for the template.
25516 It must not contain substitution macros (see below).
25519 \begin_layout Description
25520 \begin_inset Flex Code
25523 \begin_layout Plain Layout
25525 \begin_inset space ~
25528 Rotate|Resize|Clip|Extra
25533 This command specifies which transformations are supported by this template.
25534 It may occur zero or more times.
25535 This command enables the corresponding tabs in the external dialog.
25537 \begin_inset Flex Code
25540 \begin_layout Plain Layout
25546 command must have either a corresponding
25547 \begin_inset Flex Code
25550 \begin_layout Plain Layout
25557 \begin_inset Flex Code
25560 \begin_layout Plain Layout
25567 \begin_inset Flex Code
25570 \begin_layout Plain Layout
25577 Otherwise the transformation will not be supported by that format.
25580 \begin_layout Subsection
25584 \begin_layout Description
25585 \begin_inset Flex Code
25588 \begin_layout Plain Layout
25590 \begin_inset space ~
25593 LaTeX|PDFLaTeX|PlainText|DocBook|XHTML
25598 The primary document file format that this format definition is for.
25599 Not every template has a sensible representation in all document file formats.
25600 Please define nevertheless a
25601 \begin_inset Flex Code
25604 \begin_layout Plain Layout
25610 section for all templates.
25611 Use a dummy text when no representation is available.
25612 Then you can at least see a reference to the external material in the exported
25616 \begin_layout Description
25617 \begin_inset Flex Code
25620 \begin_layout Plain Layout
25622 \begin_inset space ~
25626 \begin_inset space ~
25634 This command defines an additional macro
25635 \begin_inset Flex Code
25638 \begin_layout Plain Layout
25644 for substitution in
25645 \begin_inset Flex Code
25648 \begin_layout Plain Layout
25656 \begin_inset Flex Code
25659 \begin_layout Plain Layout
25665 itself may contain substitution macros.
25666 The advantage over using
25667 \begin_inset Flex Code
25670 \begin_layout Plain Layout
25677 \begin_inset Flex Code
25680 \begin_layout Plain Layout
25686 is that the substituted value of
25687 \begin_inset Flex Code
25690 \begin_layout Plain Layout
25696 is sanitized so that it is a valid optional argument in the document format.
25697 This command may occur zero or more times.
25700 \begin_layout Description
25701 \begin_inset Flex Code
25704 \begin_layout Plain Layout
25706 \begin_inset space ~
25714 The text that is inserted in the exported document.
25715 This is actually the most important command and can be quite complex.
25716 This command must occur exactly once.
25719 \begin_layout Description
25720 \begin_inset Flex Code
25723 \begin_layout Plain Layout
25725 \begin_inset space ~
25733 This command specifies a preamble snippet that will be included in the
25736 It has to be defined using
25737 \begin_inset Flex Code
25740 \begin_layout Plain Layout
25748 \begin_inset Flex Code
25751 \begin_layout Plain Layout
25758 This command may occur zero or more times.
25761 \begin_layout Description
25762 \begin_inset Flex Code
25765 \begin_layout Plain Layout
25767 \begin_inset space ~
25771 \begin_inset space ~
25779 This command denotes files that are created by the conversion process and
25780 are needed for a particular export format.
25781 If the filename is relative, it is interpreted relative to the master document.
25782 This command may be given zero or more times.
25785 \begin_layout Description
25786 \begin_inset Flex Code
25789 \begin_layout Plain Layout
25791 \begin_inset space ~
25799 The name of a required \SpecialChar LaTeX
25801 The package is included via
25802 \begin_inset Flex Code
25805 \begin_layout Plain Layout
25813 in the \SpecialChar LaTeX
25815 This command may occur zero or more times.
25818 \begin_layout Description
25819 \begin_inset Flex Code
25822 \begin_layout Plain Layout
25824 \begin_inset space ~
25828 \begin_inset space ~
25831 RotationLatexCommand
25836 This command specifies that the built in \SpecialChar LaTeX
25837 command should be used for rotation.
25838 This command may occur once or not at all.
25841 \begin_layout Description
25842 \begin_inset Flex Code
25845 \begin_layout Plain Layout
25847 \begin_inset space ~
25851 \begin_inset space ~
25859 This command specifies that the built in \SpecialChar LaTeX
25860 command should be used for resizing.
25861 This command may occur once or not at all.
25864 \begin_layout Description
25865 \begin_inset Flex Code
25868 \begin_layout Plain Layout
25870 \begin_inset space ~
25874 \begin_inset space ~
25877 RotationLatexOption
25882 This command specifies that rotation is done via an optional argument.
25883 This command may occur once or not at all.
25886 \begin_layout Description
25887 \begin_inset Flex Code
25890 \begin_layout Plain Layout
25892 \begin_inset space ~
25896 \begin_inset space ~
25904 This command specifies that resizing is done via an optional argument.
25905 This command may occur once or not at all.
25908 \begin_layout Description
25909 \begin_inset Flex Code
25912 \begin_layout Plain Layout
25914 \begin_inset space ~
25918 \begin_inset space ~
25926 This command specifies that clipping is done via an optional argument.
25927 This command may occur once or not at all.
25930 \begin_layout Description
25931 \begin_inset Flex Code
25934 \begin_layout Plain Layout
25936 \begin_inset space ~
25940 \begin_inset space ~
25948 This command specifies that an extra optional argument is used.
25949 This command may occur once or not at all.
25952 \begin_layout Description
25953 \begin_inset Flex Code
25956 \begin_layout Plain Layout
25958 \begin_inset space ~
25966 The file format of the converted file.
25967 This must be the name of a format that is known to \SpecialChar LyX
25969 \begin_inset Flex Noun
25972 \begin_layout Plain Layout
25973 Tools\SpecialChar menuseparator
25974 Preferences\SpecialChar menuseparator
25975 File Handling\SpecialChar menuseparator
25982 This command must occur exactly once.
25983 If the resulting file format is PDF, you need to specify the format
25984 \begin_inset Flex Code
25987 \begin_layout Plain Layout
25994 This is the PDF format used for including graphics.
25995 The other defined PDF formats are for document export.
25998 \begin_layout Description
25999 \begin_inset Flex Code
26002 \begin_layout Plain Layout
26004 \begin_inset space ~
26012 The file name of the converted file.
26013 The file name must be absolute.
26014 This command must occur exactly once.
26017 \begin_layout Subsection
26018 Preamble definitions
26021 \begin_layout Standard
26022 The external template configuration file may contain additional preamble
26023 definitions enclosed by
26024 \begin_inset Flex Code
26027 \begin_layout Plain Layout
26035 \begin_inset Flex Code
26038 \begin_layout Plain Layout
26045 They can be used by the templates in the
26046 \begin_inset Flex Code
26049 \begin_layout Plain Layout
26058 \begin_layout Section
26059 The substitution mechanism
26062 \begin_layout Standard
26063 When the external material facility invokes an external program, it is done
26064 on the basis of a command defined in the template configuration file.
26065 These commands can contain various macros that are expanded before execution.
26066 Execution always take place in the directory of the containing document.
26069 \begin_layout Standard
26070 Also, whenever external material is to be displayed, the name will be produced
26071 by the substitution mechanism, and most other commands in the template
26072 definition support substitution as well.
26075 \begin_layout Standard
26076 The available macros are the following:
26079 \begin_layout Description
26080 \begin_inset Flex Code
26083 \begin_layout Plain Layout
26084 $$AbsOrRelPathMaster
26089 The file path, absolute or relative to the master \SpecialChar LyX
26093 \begin_layout Description
26094 \begin_inset Flex Code
26097 \begin_layout Plain Layout
26098 $$AbsOrRelPathParent
26103 The file path, absolute or relative to the \SpecialChar LyX
26107 \begin_layout Description
26108 \begin_inset Flex Code
26111 \begin_layout Plain Layout
26117 The absolute file path.
26120 \begin_layout Description
26121 \begin_inset Flex Code
26124 \begin_layout Plain Layout
26130 The filename without path and without the extension.
26133 \begin_layout Description
26134 \begin_inset Flex Code
26137 \begin_layout Plain Layout
26139 \begin_inset Quotes eld
26143 \begin_inset Quotes erd
26151 This macro will expand to the contents of the file with the name
26152 \begin_inset Flex Code
26155 \begin_layout Plain Layout
26164 \begin_layout Description
26165 \begin_inset Flex Code
26168 \begin_layout Plain Layout
26174 The file extension (including the dot).
26177 \begin_layout Description
26178 \begin_inset Flex Code
26181 \begin_layout Plain Layout
26187 This will be the string
26188 \begin_inset Quotes eld
26192 \begin_inset Quotes erd
26195 if the file is in JPEG format, otherwise it will be the string
26196 \begin_inset Quotes eld
26200 \begin_inset Quotes erd
26204 This is useful to avoid uneeded conversions for output formats that support
26205 both PNG and JPEG fomats.
26206 The predefined RasterImage template uses this macro for the pdf\SpecialChar TeX
26211 \begin_layout Description
26212 \begin_inset Flex Code
26215 \begin_layout Plain Layout
26221 The filename of the file specified in the external material dialog.
26222 This is either an absolute name, or it is relative to the \SpecialChar LyX
26226 \begin_layout Description
26227 \begin_inset Flex Code
26230 \begin_layout Plain Layout
26237 \begin_inset Flex Code
26240 \begin_layout Plain Layout
26246 (absolute name or relative to the \SpecialChar LyX
26250 \begin_layout Description
26251 \begin_inset Flex Code
26254 \begin_layout Plain Layout
26260 The file path, relative to the master \SpecialChar LyX
26264 \begin_layout Description
26265 \begin_inset Flex Code
26268 \begin_layout Plain Layout
26274 The file path, relative to the \SpecialChar LyX
26278 \begin_layout Description
26279 \begin_inset Flex Code
26282 \begin_layout Plain Layout
26288 This macro will expand to the absolute path of the system directory.
26289 This is typically used to point to the various helper scripts that are
26290 bundled with \SpecialChar LyX
26294 \begin_layout Description
26295 \begin_inset Flex Code
26298 \begin_layout Plain Layout
26304 A name and full path to a temporary file which will be automatically deleted
26305 whenever the containing document is closed, or the external material insertion
26309 \begin_layout Standard
26310 All path macros contain a trailing directory separator, so you can construct
26312 \begin_inset space \thinspace{}
26316 \begin_inset space \space{}
26319 the absolute filename with
26320 \begin_inset Flex Code
26323 \begin_layout Plain Layout
26324 $$AbsPath$$Basename$$Extension
26332 \begin_layout Standard
26333 The macros above are substituted in all commands unless otherwise noted.
26335 \begin_inset Flex Code
26338 \begin_layout Plain Layout
26344 supports additionally the following substitutions if they are enabled by
26346 \begin_inset Flex Code
26349 \begin_layout Plain Layout
26356 \begin_inset Flex Code
26359 \begin_layout Plain Layout
26368 \begin_layout Description
26369 \begin_inset Flex Code
26372 \begin_layout Plain Layout
26378 The front part of the resize command.
26381 \begin_layout Description
26382 \begin_inset Flex Code
26385 \begin_layout Plain Layout
26391 The back part of the resize command.
26394 \begin_layout Description
26395 \begin_inset Flex Code
26398 \begin_layout Plain Layout
26404 The front part of the rotation command.
26407 \begin_layout Description
26408 \begin_inset Flex Code
26411 \begin_layout Plain Layout
26417 The back part of the rotation command.
26420 \begin_layout Standard
26421 The value string of the
26422 \begin_inset Flex Code
26425 \begin_layout Plain Layout
26431 command supports additionally the following substitutions if they are enabled
26433 \begin_inset Flex Code
26436 \begin_layout Plain Layout
26443 \begin_inset Flex Code
26446 \begin_layout Plain Layout
26455 \begin_layout Description
26456 \begin_inset Flex Code
26459 \begin_layout Plain Layout
26468 \begin_layout Description
26469 \begin_inset Flex Code
26472 \begin_layout Plain Layout
26481 \begin_layout Description
26482 \begin_inset Flex Code
26485 \begin_layout Plain Layout
26494 \begin_layout Description
26495 \begin_inset Flex Code
26498 \begin_layout Plain Layout
26504 The rotation option.
26507 \begin_layout Standard
26508 You may ask why there are so many path macros.
26509 There are mainly two reasons:
26512 \begin_layout Enumerate
26513 Relative and absolute file names should remain relative or absolute, respectivel
26515 Users may have reasons to prefer either form.
26516 Relative names are useful for portable documents that should work on different
26517 machines, for example.
26518 Absolute names may be required by some programs.
26521 \begin_layout Enumerate
26523 treats relative file names differently than \SpecialChar LyX
26524 and other programs in nested
26526 For \SpecialChar LyX
26527 , a relative file name is always relative to the document that contains
26529 For \SpecialChar LaTeX
26530 , it is always relative to the master document.
26531 These two definitions are identical if you have only one document, but
26532 differ if you have a master document that includes part documents.
26533 That means that relative filenames must be transformed when presented to
26536 Fortunately \SpecialChar LyX
26537 does this automatically for you if you choose the right macros.
26540 \begin_layout Standard
26541 So which path macro should be used in new template definitions? The rule
26545 \begin_layout Itemize
26547 \begin_inset Flex Code
26550 \begin_layout Plain Layout
26556 if an absolute path is required.
26559 \begin_layout Itemize
26561 \begin_inset Flex Code
26564 \begin_layout Plain Layout
26565 $$AbsOrRelPathMaster
26570 if the substituted string is some kind of \SpecialChar LaTeX
26574 \begin_layout Itemize
26576 \begin_inset Flex Code
26579 \begin_layout Plain Layout
26580 $$AbsOrRelPathParent
26585 in order to preserve the user's choice.
26588 \begin_layout Standard
26589 There are special cases where this rule does not work and e.
26590 \begin_inset space \thinspace{}
26594 \begin_inset space \space{}
26597 relative names are needed, but normally it will work just fine.
26598 One example for such a case is the command
26599 \begin_inset Flex Code
26602 \begin_layout Plain Layout
26603 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
26608 in the XFig template above: We can't use the absolute name because the
26610 \begin_inset Flex Code
26613 \begin_layout Plain Layout
26619 files needs the relative name in order to rewrite the file content.
26622 \begin_layout Section
26623 Security discussion
26624 \begin_inset CommandInset label
26626 name "sec:Security-discussion"
26633 \begin_layout Standard
26634 The external material feature interfaces with a lot of external programs
26635 and does so automatically, so we have to consider the security implications
26637 In particular, since you have the option of including your own filenames
26638 and/or parameter strings and those are expanded into a command, it seems
26639 that it would be possible to create a malicious document which executes
26640 arbitrary commands when a user views or prints the document.
26641 This is something we definitely want to avoid.
26644 \begin_layout Standard
26645 However, since the external program commands are specified in the template
26646 configuration file only, there are no security issues if \SpecialChar LyX
26647 is properly configure
26648 d with safe templates only.
26649 This is so because the external programs are invoked with the
26650 \begin_inset Flex Code
26653 \begin_layout Plain Layout
26659 -system call rather than the
26660 \begin_inset Flex Code
26663 \begin_layout Plain Layout
26669 system-call, so it's not possible to execute arbitrary commands from the
26670 filename or parameter section via the shell.
26673 \begin_layout Standard
26674 This also implies that you are restricted in what command strings you can
26675 use in the external material templates.
26676 In particular, pipes and redirection are not readily available.
26677 This has to be so if \SpecialChar LyX
26678 should remain safe.
26679 If you want to use some of the shell features, you should write a safe
26680 script to do this in a controlled manner, and then invoke the script from
26681 the command string.
26685 \begin_layout Standard
26686 It is possible to design a template that interacts directly with the shell,
26687 but since this would allow a malicious user to execute arbitrary commands
26688 by writing clever filenames and/or parameters, we generally recommend that
26689 you only use safe scripts that work with the
26690 \begin_inset Flex Code
26693 \begin_layout Plain Layout
26699 system call in a controlled manner.
26700 Of course, for use in a controlled environment, it can be tempting to just
26701 fall back to use ordinary shell scripts.
26702 If you do so, be aware that you
26706 provide an easily exploitable security hole in your system.
26707 Of course it stands to reason that such unsafe templates will never be
26708 included in the standard \SpecialChar LyX
26709 distribution, although we do encourage people
26710 to submit new templates in the open source tradition.
26711 But \SpecialChar LyX
26712 as shipped from the official distribution channels will never have
26716 \begin_layout Standard
26717 Including external material provides a lot of power, and you have to be
26718 careful not to introduce security hazards with this power.
26719 A subtle error in a single line in an innocent looking script can open
26720 the door to huge security problems.
26721 So if you do not fully understand the issues, we recommend that you consult
26722 a knowledgeable security professional or the \SpecialChar LyX
26723 development team if you have
26724 any questions about whether a given template is safe or not.
26725 And do this before you use it in an uncontrolled environment.
26728 \begin_layout Chapter
26730 List of supported \SpecialChar LyX
26731 functions to be used in layouts
26732 \begin_inset CommandInset label
26734 name "chap:List-of-functions"
26741 \begin_layout Standard
26743 \begin_inset Tabular
26744 <lyxtabular version="3" rows="11" columns="8">
26745 <features tabularvalignment="middle">
26746 <column alignment="left" valignment="top">
26747 <column alignment="left" valignment="top">
26748 <column alignment="left" valignment="top">
26749 <column alignment="left" valignment="top">
26750 <column alignment="left" valignment="top">
26751 <column alignment="left" valignment="top">
26752 <column alignment="left" valignment="top">
26753 <column alignment="left" valignment="top">
26755 <cell alignment="left" valignment="top" usebox="none">
26758 \begin_layout Plain Layout
26764 <cell alignment="left" valignment="top" usebox="none">
26767 \begin_layout Plain Layout
26773 <cell alignment="left" valignment="top" usebox="none">
26776 \begin_layout Plain Layout
26782 <cell alignment="left" valignment="top" usebox="none">
26785 \begin_layout Plain Layout
26791 <cell alignment="center" valignment="top" usebox="none">
26794 \begin_layout Plain Layout
26800 <cell alignment="center" valignment="top" usebox="none">
26803 \begin_layout Plain Layout
26809 <cell alignment="center" valignment="top" usebox="none">
26812 \begin_layout Plain Layout
26818 <cell alignment="center" valignment="top" usebox="none">
26821 \begin_layout Plain Layout
26829 <cell alignment="left" valignment="top" usebox="none">
26832 \begin_layout Plain Layout
26838 <cell alignment="left" valignment="top" usebox="none">
26841 \begin_layout Plain Layout
26847 <cell alignment="left" valignment="top" usebox="none">
26850 \begin_layout Plain Layout
26856 <cell alignment="left" valignment="top" usebox="none">
26859 \begin_layout Plain Layout
26865 <cell alignment="center" valignment="top" usebox="none">
26868 \begin_layout Plain Layout
26874 <cell alignment="center" valignment="top" usebox="none">
26877 \begin_layout Plain Layout
26883 <cell alignment="center" valignment="top" usebox="none">
26886 \begin_layout Plain Layout
26892 <cell alignment="center" valignment="top" usebox="none">
26895 \begin_layout Plain Layout
26903 <cell alignment="left" valignment="top" usebox="none">
26906 \begin_layout Plain Layout
26912 <cell alignment="left" valignment="top" usebox="none">
26915 \begin_layout Plain Layout
26921 <cell alignment="left" valignment="top" usebox="none">
26924 \begin_layout Plain Layout
26930 <cell alignment="left" valignment="top" usebox="none">
26933 \begin_layout Plain Layout
26939 <cell alignment="center" valignment="top" usebox="none">
26942 \begin_layout Plain Layout
26948 <cell alignment="center" valignment="top" usebox="none">
26951 \begin_layout Plain Layout
26957 <cell alignment="center" valignment="top" usebox="none">
26960 \begin_layout Plain Layout
26966 <cell alignment="center" valignment="top" usebox="none">
26969 \begin_layout Plain Layout
26977 <cell alignment="left" valignment="top" usebox="none">
26980 \begin_layout Plain Layout
26986 <cell alignment="left" valignment="top" usebox="none">
26989 \begin_layout Plain Layout
26995 <cell alignment="left" valignment="top" usebox="none">
26998 \begin_layout Plain Layout
27004 <cell alignment="left" valignment="top" usebox="none">
27007 \begin_layout Plain Layout
27013 <cell alignment="center" valignment="top" usebox="none">
27016 \begin_layout Plain Layout
27022 <cell alignment="center" valignment="top" usebox="none">
27025 \begin_layout Plain Layout
27031 <cell alignment="center" valignment="top" usebox="none">
27034 \begin_layout Plain Layout
27040 <cell alignment="center" valignment="top" usebox="none">
27043 \begin_layout Plain Layout
27051 <cell alignment="left" valignment="top" usebox="none">
27054 \begin_layout Plain Layout
27060 <cell alignment="left" valignment="top" usebox="none">
27063 \begin_layout Plain Layout
27069 <cell alignment="left" valignment="top" usebox="none">
27072 \begin_layout Plain Layout
27078 <cell alignment="left" valignment="top" usebox="none">
27081 \begin_layout Plain Layout
27087 <cell alignment="center" valignment="top" usebox="none">
27090 \begin_layout Plain Layout
27096 <cell alignment="center" valignment="top" usebox="none">
27099 \begin_layout Plain Layout
27105 <cell alignment="center" valignment="top" usebox="none">
27108 \begin_layout Plain Layout
27114 <cell alignment="center" valignment="top" usebox="none">
27117 \begin_layout Plain Layout
27125 <cell alignment="left" valignment="top" usebox="none">
27128 \begin_layout Plain Layout
27134 <cell alignment="left" valignment="top" usebox="none">
27137 \begin_layout Plain Layout
27143 <cell alignment="left" valignment="top" usebox="none">
27146 \begin_layout Plain Layout
27152 <cell alignment="left" valignment="top" usebox="none">
27155 \begin_layout Plain Layout
27161 <cell alignment="center" valignment="top" usebox="none">
27164 \begin_layout Plain Layout
27170 <cell alignment="center" valignment="top" usebox="none">
27173 \begin_layout Plain Layout
27179 <cell alignment="center" valignment="top" usebox="none">
27182 \begin_layout Plain Layout
27188 <cell alignment="center" valignment="top" usebox="none">
27191 \begin_layout Plain Layout
27199 <cell alignment="left" valignment="top" usebox="none">
27202 \begin_layout Plain Layout
27208 <cell alignment="left" valignment="top" usebox="none">
27211 \begin_layout Plain Layout
27217 <cell alignment="left" valignment="top" usebox="none">
27220 \begin_layout Plain Layout
27226 <cell alignment="left" valignment="top" usebox="none">
27229 \begin_layout Plain Layout
27235 <cell alignment="center" valignment="top" usebox="none">
27238 \begin_layout Plain Layout
27244 <cell alignment="center" valignment="top" usebox="none">
27247 \begin_layout Plain Layout
27253 <cell alignment="center" valignment="top" usebox="none">
27256 \begin_layout Plain Layout
27262 <cell alignment="center" valignment="top" usebox="none">
27265 \begin_layout Plain Layout
27273 <cell alignment="left" valignment="top" usebox="none">
27276 \begin_layout Plain Layout
27282 <cell alignment="left" valignment="top" usebox="none">
27285 \begin_layout Plain Layout
27291 <cell alignment="left" valignment="top" usebox="none">
27294 \begin_layout Plain Layout
27300 <cell alignment="left" valignment="top" usebox="none">
27303 \begin_layout Plain Layout
27309 <cell alignment="center" valignment="top" usebox="none">
27312 \begin_layout Plain Layout
27318 <cell alignment="center" valignment="top" usebox="none">
27321 \begin_layout Plain Layout
27327 <cell alignment="center" valignment="top" usebox="none">
27330 \begin_layout Plain Layout
27336 <cell alignment="center" valignment="top" usebox="none">
27339 \begin_layout Plain Layout
27347 <cell alignment="left" valignment="top" usebox="none">
27350 \begin_layout Plain Layout
27356 <cell alignment="left" valignment="top" usebox="none">
27359 \begin_layout Plain Layout
27365 <cell alignment="left" valignment="top" usebox="none">
27368 \begin_layout Plain Layout
27374 <cell alignment="left" valignment="top" usebox="none">
27377 \begin_layout Plain Layout
27383 <cell alignment="center" valignment="top" usebox="none">
27386 \begin_layout Plain Layout
27392 <cell alignment="center" valignment="top" usebox="none">
27395 \begin_layout Plain Layout
27401 <cell alignment="center" valignment="top" usebox="none">
27404 \begin_layout Plain Layout
27410 <cell alignment="center" valignment="top" usebox="none">
27413 \begin_layout Plain Layout
27421 <cell alignment="left" valignment="top" usebox="none">
27424 \begin_layout Plain Layout
27430 <cell alignment="left" valignment="top" usebox="none">
27433 \begin_layout Plain Layout
27439 <cell alignment="left" valignment="top" usebox="none">
27442 \begin_layout Plain Layout
27448 <cell alignment="left" valignment="top" usebox="none">
27451 \begin_layout Plain Layout
27457 <cell alignment="center" valignment="top" usebox="none">
27460 \begin_layout Plain Layout
27466 <cell alignment="center" valignment="top" usebox="none">
27469 \begin_layout Plain Layout
27475 <cell alignment="center" valignment="top" usebox="none">
27478 \begin_layout Plain Layout
27484 <cell alignment="center" valignment="top" usebox="none">
27487 \begin_layout Plain Layout
27495 <cell alignment="center" valignment="top" usebox="none">
27498 \begin_layout Plain Layout
27504 <cell alignment="center" valignment="top" usebox="none">
27507 \begin_layout Plain Layout
27513 <cell alignment="center" valignment="top" usebox="none">
27516 \begin_layout Plain Layout
27522 <cell alignment="center" valignment="top" usebox="none">
27525 \begin_layout Plain Layout
27531 <cell alignment="center" valignment="top" usebox="none">
27534 \begin_layout Plain Layout
27540 <cell alignment="center" valignment="top" usebox="none">
27543 \begin_layout Plain Layout
27549 <cell alignment="center" valignment="top" usebox="none">
27552 \begin_layout Plain Layout
27558 <cell alignment="center" valignment="top" usebox="none">
27561 \begin_layout Plain Layout
27575 \begin_layout Chapter
27576 Names of available colors to be used in layouts
27577 \begin_inset CommandInset label
27579 name "chap:Names-of-colors"
27586 \begin_layout Standard
27588 \change_deleted -712698321 1505048041
27590 \change_inserted -712698321 1505048041
27593 are the standard colors and
27594 \change_deleted -712698321 1505048036
27597 those that you can adjust in the \SpecialChar LyX
27599 \change_inserted -712698321 1505047917
27603 \begin_layout Section
27605 \change_inserted -712698321 1505048046
27609 \begin_layout Standard
27611 \change_inserted -712698321 1505048063
27612 The following are no real colors, but rather act on color definitions:
27617 \begin_layout Description
27619 \change_inserted -712698321 1505049948
27620 ignore The color is ignored
27623 \begin_layout Description
27625 \change_inserted -712698321 1505049948
27626 inherit The color is inherited
27629 \begin_layout Description
27642 No particular color – clear or default
27643 \change_inserted -712698321 1505049946
27647 \begin_layout Section
27649 \change_inserted -712698321 1505048068
27653 \begin_layout Standard
27655 \change_inserted -712698321 1505048080
27656 These are fixed colors that cannot me customized:
27661 \begin_layout Description
27665 \begin_layout Description
27667 \change_inserted -712698321 1505047780
27671 \begin_layout Description
27673 \change_inserted -712698321 1505047787
27677 \begin_layout Description
27679 \change_inserted -712698321 1505047791
27683 \begin_layout Description
27685 \change_inserted -712698321 1505047799
27689 \begin_layout Description
27691 \change_inserted -712698321 1505047807
27695 \begin_layout Description
27697 \change_inserted -712698321 1505047809
27703 \begin_layout Description
27705 \change_deleted -712698321 1505047820
27711 \begin_layout Description
27713 \change_inserted -712698321 1505047824
27717 \begin_layout Description
27719 \change_inserted -712698321 1505047828
27725 \begin_layout Description
27727 \change_deleted -712698321 1505047798
27731 \begin_layout Description
27733 \change_deleted -712698321 1505047798
27735 \change_inserted -712698321 1505047834
27739 \begin_layout Description
27741 \change_inserted -712698321 1505047835
27747 \begin_layout Description
27749 \change_inserted -712698321 1505047840
27753 \begin_layout Description
27755 \change_inserted -712698321 1505047846
27759 \begin_layout Description
27761 \change_inserted -712698321 1505047850
27765 \begin_layout Description
27767 \change_inserted -712698321 1505047861
27771 \begin_layout Description
27773 \change_inserted -712698321 1505047863
27777 \begin_layout Description
27779 \change_inserted -712698321 1505047867
27783 \begin_layout Description
27785 \change_inserted -712698321 1505047881
27789 \begin_layout Description
27791 \change_inserted -712698321 1505047878
27797 \begin_layout Description
27799 \change_inserted -712698321 1505047947
27803 \begin_layout Section
27805 \change_inserted -712698321 1505048092
27809 \begin_layout Standard
27811 \change_inserted -712698321 1505048589
27812 These are the colors allocated to specific elements in
27815 arg "dialog-show prefs"
27823 \begin_layout Description
27824 added_space Added space
27825 \change_deleted -712698321 1505049692
27831 \begin_layout Description
27832 addedtext Added text color
27835 \begin_layout Description
27836 appendix Appendix marker color
27839 \begin_layout Description
27840 background Background color
27843 \begin_layout Description
27844 bottomarea Bottom area color
27847 \begin_layout Description
27848 branchlabel Label color for branches
27851 \begin_layout Description
27852 buttonbg Color used for button background
27853 \change_inserted -712698321 1505049724
27857 \begin_layout Description
27859 \change_inserted -712698321 1505049724
27860 buttonframe Color for inset button frames
27865 \begin_layout Description
27866 buttonhoverbg Color used for button background under focus
27869 \begin_layout Description
27871 \change_deleted -712698321 1505049722
27872 buttonframe Color for inset button frames
27877 \begin_layout Description
27878 changebar Changebar color
27881 \begin_layout Description
27882 changedtextauthor1 Changed text color author 1
27885 \begin_layout Description
27886 changedtextauthor2 Changed text color author 2
27889 \begin_layout Description
27890 changedtextauthor3 Changed text color author 3
27893 \begin_layout Description
27894 changedtextauthor4 Changed text color author 4
27897 \begin_layout Description
27898 changedtextauthor5 Changed text color author 5
27899 \change_inserted -712698321 1505049811
27903 \begin_layout Description
27905 \change_inserted -712698321 1505049811
27906 collapsable Collapsable insets text color
27909 \begin_layout Description
27911 \change_deleted -712698321 1505049817
27914 frame Collapsable insets framecolor
27917 \begin_layout Description
27919 \change_deleted -712698321 1505049809
27920 collapsable_inset_text Collapsable insets text color
27925 \begin_layout Description
27926 command Text color for command insets
27929 \begin_layout Description
27930 commandbg Background color for command insets
27933 \begin_layout Description
27934 commandframe Frame color for command insets
27935 \change_inserted -712698321 1505048865
27939 \begin_layout Description
27941 \change_deleted -712698321 1505049843
27942 comment color for comments
27947 \begin_layout Description
27948 commentbg Background color of comments
27949 \change_inserted -712698321 1505048888
27953 \begin_layout Description
27955 \change_inserted -712698321 1505048891
27956 commentlabel Label color for comments
27961 \begin_layout Description
27962 cursor Cursor color
27965 \begin_layout Description
27966 deletedtext Deleted text color
27969 \begin_layout Description
27970 deletedtextmodifier Deleted text modifying color
27973 \begin_layout Description
27974 depthbar Color for the depth bars in the margin
27977 \begin_layout Description
27978 eolmarker End of line marker color
27981 \begin_layout Description
27982 error Color of the \SpecialChar LaTeX
27986 \begin_layout Description
27987 footlabel Label color for footnotes
27988 \change_inserted -712698321 1505048777
27992 \begin_layout Description
27994 \change_inserted -712698321 1505048785
27995 foreground Foreground color
28000 \begin_layout Description
28001 graphicsbg Graphics inset background color
28004 \begin_layout Description
28006 \change_deleted -712698321 1505049909
28007 greyedout Label color for greyedout insets
28012 \begin_layout Description
28013 greyedoutbg Background color of greyedout inset
28014 \change_inserted -712698321 1505048914
28018 \begin_layout Description
28020 \change_inserted -712698321 1505049907
28021 greyedoutlabel Label color for greyedout insets
28026 \begin_layout Description
28027 greyedouttext Color for greyedout inset text
28030 \begin_layout Description
28031 indexlabel Label color for index insets
28034 \begin_layout Description
28036 \change_deleted -712698321 1505049940
28037 ignore The color is ignored
28040 \begin_layout Description
28042 \change_deleted -712698321 1505049940
28043 inherit The color is inherited
28048 \begin_layout Description
28049 inlinecompletion Inline completion color
28052 \begin_layout Description
28053 insetbg Inset marker background color
28056 \begin_layout Description
28057 insetframe Inset marker frame color
28060 \begin_layout Description
28061 language Color for marking foreign language words
28064 \begin_layout Description
28065 latex Text color in \SpecialChar LaTeX
28069 \begin_layout Description
28070 listingsbg Background color of listings inset
28073 \begin_layout Description
28074 marginlabel Label color for margin notes
28077 \begin_layout Description
28078 math Math inset text color
28081 \begin_layout Description
28082 mathbg Math inset background color
28085 \begin_layout Description
28086 mathcorners Math inset frame color not under focus
28089 \begin_layout Description
28090 mathframe Math inset frame color under focus
28093 \begin_layout Description
28094 mathline Math line color
28097 \begin_layout Description
28098 mathmacrobg Macro math inset background color
28101 \begin_layout Description
28102 mathmacroblend Macro math blended color
28105 \begin_layout Description
28106 mathmacroframe Macro math frame color
28109 \begin_layout Description
28110 mathmacrohoverbg Macro math inset background color hovered
28113 \begin_layout Description
28114 mathmacrolabel Macro math label color
28117 \begin_layout Description
28118 mathmacronewarg Macro template color for new parameters
28121 \begin_layout Description
28122 mathmacrooldarg Macro template color for old parameters
28125 \begin_layout Description
28126 newpage New page color
28129 \begin_layout Description
28130 nonunique_inlinecompletion Inline completion color for the non-unique part
28133 \begin_layout Description
28134 notebg Background color of notes
28137 \begin_layout Description
28138 notelabel Label color for notes
28141 \begin_layout Description
28142 pagebreak Page break/line break color
28145 \begin_layout Description
28146 paragraphmarker Color used for the pilcrow sign to mark the end of a paragraph
28149 \begin_layout Description
28150 phantomtext Text color for phantom insets
28153 \begin_layout Description
28154 preview The color used for previews
28157 \begin_layout Description
28158 previewframe Preview frame color
28161 \begin_layout Description
28162 regexpframe Color for regexp frame
28163 \change_inserted -712698321 1505050082
28167 \begin_layout Description
28169 \change_inserted -712698321 1505050082
28170 scroll Color that indicates when a row can be scrolled
28175 \begin_layout Description
28176 selection Background color of selected text
28179 \begin_layout Description
28180 selectiontext Foreground color of selected text
28183 \begin_layout Description
28184 shadedbg Background color of shaded box
28187 \begin_layout Description
28188 special Special chars text color
28191 \begin_layout Description
28192 tabularline Table line color
28195 \begin_layout Description
28196 tabularonoffline Table line color
28199 \begin_layout Description
28200 urllabel Label color for URL insets
28203 \begin_layout Description
28204 urltext Color for URL inset text