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 fleqn,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
104 \notefontcolor #0000ff
116 \paragraph_separation indent
117 \paragraph_indentation default
118 \quotes_style english
122 \paperpagestyle headings
123 \tracking_changes true
124 \output_changes false
128 \author -712698321 "Jürgen Spitzmüller"
129 \author 2047637253 "Guillaume Munch"
130 \author 2089657418 "Usti"
136 Customizing \SpecialChar LyX
137 : Features for the Advanced User
141 by the \SpecialChar LyX
146 \begin_layout Plain Layout
148 If you have comments or error corrections, please send them to the \SpecialChar LyX
151 \begin_inset CommandInset href
153 target "lyx-docs@lists.lyx.org"
161 \begin_inset Quotes eld
165 \begin_inset Quotes erd
168 in the subject header, and please cc the current maintainer of this file,
169 Richard Heck <rgheck@comcast.net>.
175 \begin_inset Newline newline
179 \begin_inset Newline newline
185 \begin_layout Standard
186 \begin_inset CommandInset toc
187 LatexCommand tableofcontents
194 \begin_layout Standard
195 \begin_inset Note Note
198 \begin_layout Plain Layout
199 Please use change tracking when modifying this document.
200 This makes it easier for our translators to recognize things that have
201 been changed, and it helps the maintainer keep up-to-date with what's been
210 \begin_layout Chapter
214 \begin_layout Standard
215 This manual covers the customization features present in \SpecialChar LyX
217 In it, we discuss issues like keyboard shortcuts, screen previewing options,
218 printer options, sending commands to \SpecialChar LyX
219 via the \SpecialChar LyX
220 Server, internationalization,
221 installing new \SpecialChar LaTeX
222 classes and \SpecialChar LyX
224 We can't possibly hope to touch on everything you can change—our developers
225 add new features faster than we can document them—but we will explain the
226 most common customizations and hopefully point you in the right direction
227 for some of the more obscure ones.
230 \begin_layout Standard
231 \begin_inset Branch OutDated
235 \begin_layout Standard
236 Information from previous versions of this document that now seems to be
237 outdated is contained in the OutDated branch of this document.
238 By default, this information will not appear in the \SpecialChar LaTeX
247 \begin_layout Chapter
252 \begin_layout Standard
253 This chapter aims to help you to find your way through the \SpecialChar LyX
256 Before continuing to read this chapter, you should find out where your
258 library and user directories are by using
259 \begin_inset Flex Noun
262 \begin_layout Plain Layout
263 Help\SpecialChar menuseparator
274 The library directory is the place where \SpecialChar LyX
275 places its system-wide configuration
276 files; the user directory is where you can place your modified versions.
277 We will call the former
278 \begin_inset Flex Code
281 \begin_layout Plain Layout
288 \begin_inset Flex Noun
291 \begin_layout Plain Layout
297 in the remainder of this document.
301 \begin_layout Section
303 \begin_inset Flex Code
306 \begin_layout Plain Layout
315 \begin_layout Standard
316 \begin_inset Flex Code
319 \begin_layout Plain Layout
325 and its sub-directories contain a number of files and that can be used
326 to customize \SpecialChar LyX
328 You can change many of these files from within \SpecialChar LyX
330 \begin_inset Flex Noun
333 \begin_layout Plain Layout
334 Tools\SpecialChar menuseparator
341 Most customization that you will want to do in \SpecialChar LyX
342 is possible through this
344 However, many other inner aspects of \SpecialChar LyX
345 can be customized by modifying the
347 \begin_inset Flex Code
350 \begin_layout Plain Layout
357 These files fall in different categories, described in the following subsection
361 \begin_layout Subsection
362 Automatically generated files
365 \begin_layout Standard
366 The files, which are to be found in
367 \begin_inset Flex Noun
370 \begin_layout Plain Layout
376 , are generated when you configure \SpecialChar LyX
378 They contain various default values that are guessed by inspection.
379 In general, it is not a good idea to modify them, since they might be overwritt
383 \begin_layout Labeling
384 \labelwidthstring 00.00.0000
385 \begin_inset Flex Code
388 \begin_layout Plain Layout
394 contains defaults for various commands.
397 \begin_layout Labeling
398 \labelwidthstring 00.00.0000
399 \begin_inset Flex Code
402 \begin_layout Plain Layout
408 contains the list of packages that have been recognized by \SpecialChar LyX
410 It is currently unused by the \SpecialChar LyX
411 program itself, but the information extracted,
412 and more, is made available with
413 \begin_inset Flex Noun
416 \begin_layout Plain Layout
417 Help\SpecialChar menuseparator
431 \begin_layout Labeling
432 \labelwidthstring 00.00.0000
433 \begin_inset Flex Code
436 \begin_layout Plain Layout
442 the list of text classes that have been found in your
443 \begin_inset Flex Code
446 \begin_layout Plain Layout
452 directories, along with the associated \SpecialChar LaTeX
453 document class and their description.
456 \begin_layout Labeling
457 \labelwidthstring 00.00.0000
458 \begin_inset Flex Code
461 \begin_layout Plain Layout
467 the list of layout modules found in your
468 \begin_inset Flex Code
471 \begin_layout Plain Layout
480 \begin_layout Labeling
481 \labelwidthstring 00.00.0000
482 \begin_inset Flex Code
485 \begin_layout Plain Layout
491 lists of various sorts of \SpecialChar LaTeX
492 -related files found on your system
495 \begin_layout Labeling
496 \labelwidthstring 00.00.0000
497 \begin_inset Flex Code
500 \begin_layout Plain Layout
501 doc/\SpecialChar LaTeX
507 is automatically generated during configuration from the file
508 \begin_inset Flex Code
511 \begin_layout Plain Layout
519 It contains information on your \SpecialChar LaTeX
523 \begin_layout Subsection
527 \begin_layout Standard
528 These directories are duplicated between
529 \begin_inset Flex Code
532 \begin_layout Plain Layout
539 \begin_inset Flex Code
542 \begin_layout Plain Layout
549 If a particular files exists in both places, the one in
550 \begin_inset Flex Code
553 \begin_layout Plain Layout
562 \begin_layout Labeling
563 \labelwidthstring 00.00.0000
564 \begin_inset Flex Code
567 \begin_layout Plain Layout
573 this directory contains files with the extension
574 \begin_inset Flex Code
577 \begin_layout Plain Layout
583 that define the keybindings used in \SpecialChar LyX
585 If there exists an internationalized version of the bind file named
586 \begin_inset Flex Code
589 \begin_layout Plain Layout
595 , that will be used first.
596 \change_inserted -712698321 1483535138
600 \begin_layout Labeling
601 \labelwidthstring 00.00.0000
603 \change_inserted -712698321 1483874001
604 \begin_inset Flex Code
607 \begin_layout Plain Layout
609 \change_inserted -712698321 1483535144
615 contains files with the extension
616 \begin_inset Flex Code
619 \begin_layout Plain Layout
621 \change_inserted -712698321 1483869840
629 which define the diverse citation possibilities (natbib, biblatex etc.).
631 \begin_inset CommandInset ref
633 reference "subsec:Cite-Engine-Files"
645 \begin_layout Labeling
646 \labelwidthstring 00.00.0000
647 \begin_inset Flex Code
650 \begin_layout Plain Layout
656 contains graphics files that can be included in documents.
660 \begin_layout Labeling
661 \labelwidthstring 00.00.0000
662 \begin_inset Flex Code
665 \begin_layout Plain Layout
671 contains \SpecialChar LyX
672 documentation files (including the one you are currently reading).
674 \begin_inset Flex Code
677 \begin_layout Plain Layout
684 deserves special attention, as noted above.
685 The internationalized help docs are in subdirectories
686 \begin_inset Flex Code
689 \begin_layout Plain Layout
696 \begin_inset Quotes eld
700 \begin_inset Quotes erd
703 is the ISO language code.
705 \begin_inset CommandInset ref
707 reference "cha:Internationalizing-LyX"
714 \begin_layout Labeling
715 \labelwidthstring 00.00.0000
716 \begin_inset Flex Code
719 \begin_layout Plain Layout
725 contains example files that explain how to use some features.
726 In the file browser, press the
727 \begin_inset Flex Noun
730 \begin_layout Plain Layout
739 \begin_layout Labeling
740 \labelwidthstring 00.00.0000
741 \begin_inset Flex Code
744 \begin_layout Plain Layout
750 contains image files that are used by the
751 \begin_inset Flex Noun
754 \begin_layout Plain Layout
761 In addition, it also contains the individual icons used in the toolbar
762 and the banners that can be shown when \SpecialChar LyX
766 \begin_layout Labeling
767 \labelwidthstring 00.00.0000
768 \begin_inset Flex Code
771 \begin_layout Plain Layout
777 contains keyboard keymapping files.
779 \begin_inset CommandInset ref
781 reference "sec:International-Keymap-Stuff"
788 \begin_layout Labeling
789 \labelwidthstring 00.00.0000
790 \begin_inset Flex Code
793 \begin_layout Plain Layout
799 contains the text class and module files described in
800 \begin_inset CommandInset ref
802 reference "cha:Installing-New-Document"
809 \begin_layout Labeling
810 \labelwidthstring 00.00.0000
811 \begin_inset Flex Code
814 \begin_layout Plain Layout
821 \begin_inset Flex Code
824 \begin_layout Plain Layout
830 Python scripts used to convert between \SpecialChar LyX
832 These can be run from the command line if, say, you want to batch-convert
836 \begin_layout Labeling
837 \labelwidthstring 00.00.0000
838 \begin_inset Flex Code
841 \begin_layout Plain Layout
847 contains some files that demonstrate the capabilities of the
848 \begin_inset Flex Noun
851 \begin_layout Plain Layout
862 Also contains some scripts used by \SpecialChar LyX
866 \begin_layout Labeling
867 \labelwidthstring 00.00.0000
868 \begin_inset Flex Code
871 \begin_layout Plain Layout
877 contains the standard \SpecialChar LyX
878 template files described in
879 \begin_inset CommandInset ref
881 reference "subsec:Creating-Templates"
888 \begin_layout Labeling
889 \labelwidthstring 00.00.0000
890 \begin_inset Flex Code
893 \begin_layout Plain Layout
899 contains files with the extension
900 \begin_inset Flex Code
903 \begin_layout Plain Layout
909 that define the user interface to \SpecialChar LyX
911 That is, the files define which items appear in which menus and the items
912 appearing on the toolbar.
913 \change_inserted -712698321 1490533733
917 \begin_layout Labeling
918 \labelwidthstring 00.00.0000
920 \change_inserted -712698321 1490533849
921 \begin_inset Flex Code
924 \begin_layout Plain Layout
926 \change_inserted -712698321 1490533738
932 contains files with the extension
933 \begin_inset Flex Code
936 \begin_layout Plain Layout
938 \change_inserted -712698321 1490533759
944 which define the templates for the insertion of external material to a
947 \begin_inset CommandInset ref
949 reference "chap:Including-External-Material"
958 \begin_layout Subsection
959 Files you don't want to modify
962 \begin_layout Standard
963 These files are used internally by \SpecialChar LyX
964 and you generally do not need to modify
965 them unless you are a developer.
968 \begin_layout Labeling
969 \labelwidthstring 00.00.0000
970 \begin_inset Flex Code
973 \begin_layout Plain Layout
979 this file contains the list of \SpecialChar LyX
981 The contents are displayed with the menu entry
982 \begin_inset Flex Noun
985 \begin_layout Plain Layout
986 Help\SpecialChar menuseparator
999 \begin_layout Labeling
1000 \labelwidthstring 00.00.0000
1001 \begin_inset Flex Code
1004 \begin_layout Plain Layout
1010 this is a \SpecialChar LaTeX
1011 script used during the configuration process.
1012 Do not run directly.
1015 \begin_layout Labeling
1016 \labelwidthstring 00.00.0000
1017 \begin_inset Flex Code
1020 \begin_layout Plain Layout
1026 this is a Python script that is used to re-configure \SpecialChar LyX
1028 It creates configuration files in the directory it was run from.
1031 \begin_layout Subsection
1032 Other files needing a line or two
1035 \begin_layout Labeling
1036 \labelwidthstring 00.00.0000
1037 \begin_inset Flex Code
1040 \begin_layout Plain Layout
1046 this contains tables describing how different character encodings can be
1050 \begin_layout Labeling
1051 \labelwidthstring 00.00.0000
1053 \change_deleted -712698321 1490533856
1054 \begin_inset Flex Code
1057 \begin_layout Plain Layout
1063 this file contains the templates available to the new
1064 \begin_inset Flex Noun
1067 \begin_layout Plain Layout
1069 \begin_inset space ~
1078 \begin_inset CommandInset ref
1080 reference "chap:Including-External-Material"
1089 \begin_layout Labeling
1090 \labelwidthstring 00.00.0000
1091 \begin_inset Flex Code
1094 \begin_layout Plain Layout
1100 this file contains a list of all the languages currently supported by \SpecialChar LyX
1104 \begin_layout Labeling
1105 \labelwidthstring 00.00.0000
1106 \begin_inset Flex Code
1109 \begin_layout Plain Layout
1115 contains information about the supported fonts.
1118 \begin_layout Labeling
1119 \labelwidthstring 00.00.0000
1120 \begin_inset Flex Code
1123 \begin_layout Plain Layout
1129 this file contains translations for internationalized paragraph styles
1131 \begin_inset CommandInset ref
1133 reference "subsec:I18n"
1140 \begin_layout Labeling
1141 \labelwidthstring 00.00.0000
1142 \begin_inset Flex Code
1145 \begin_layout Plain Layout
1151 this file contains information about unicode-encoded glyphs and the way
1152 they are supported by \SpecialChar LyX
1153 via \SpecialChar LaTeX
1157 \begin_layout Section
1158 Your local configuration directory
1161 \begin_layout Standard
1162 Even if you are using \SpecialChar LyX
1163 as an unprivileged user, you might want to change
1165 configuration for your own use.
1167 \begin_inset Flex Code
1170 \begin_layout Plain Layout
1176 directory contains all your personal configuration files.
1177 This is the directory described as
1178 \begin_inset Quotes eld
1182 \begin_inset Quotes erd
1186 \begin_inset Flex Noun
1189 \begin_layout Plain Layout
1190 Help\SpecialChar menuseparator
1192 \begin_inset space ~
1201 This directory is used as a mirror of
1202 \begin_inset Flex Code
1205 \begin_layout Plain Layout
1211 , which means that every file in
1212 \begin_inset Flex Code
1215 \begin_layout Plain Layout
1221 is a replacement for the corresponding file in
1222 \begin_inset Flex Code
1225 \begin_layout Plain Layout
1232 Any configuration file described in the above sections can be placed either
1233 in the system-wide directory, in which case it will affect all users, or
1234 in your local directory for your own use.
1237 \begin_layout Standard
1238 To make things clearer, let's provide a few examples:
1241 \begin_layout Itemize
1242 The preferences set in the
1243 \begin_inset Flex Noun
1246 \begin_layout Plain Layout
1247 Tools\SpecialChar menuseparator
1253 dialog are saved to a file
1254 \begin_inset Flex Code
1257 \begin_layout Plain Layout
1264 \begin_inset Flex Code
1267 \begin_layout Plain Layout
1276 \begin_layout Itemize
1277 When you reconfigure using
1278 \begin_inset Flex Noun
1281 \begin_layout Plain Layout
1282 Tools\SpecialChar menuseparator
1290 \begin_inset Flex Code
1293 \begin_layout Plain Layout
1299 script, and the resulting files are written in your local configuration
1301 This means that any additional text class file that you might have added
1303 \begin_inset Flex Code
1306 \begin_layout Plain Layout
1312 will be added to the list of classes in the
1313 \begin_inset Flex Noun
1316 \begin_layout Plain Layout
1317 Document\SpecialChar menuseparator
1326 \begin_layout Itemize
1327 If you get some updated documentation from \SpecialChar LyX
1328 ftp site and cannot install
1329 it because you do not have sysadmin rights on your system, you can just
1331 \begin_inset Flex Code
1334 \begin_layout Plain Layout
1340 and the items in the
1341 \begin_inset Flex Noun
1344 \begin_layout Plain Layout
1350 menu will open them!
1353 \begin_layout Section
1354 Running \SpecialChar LyX
1355 with multiple configurations
1358 \begin_layout Standard
1359 The configuration freedom of the local configuration directory may not suffice
1360 if you want to have more than one configuration at your disposal.
1361 For example, you may want to be use different key bindings or printer settings
1363 You can achieve this by having several such directories.
1364 You then specify which directory to use at run-time.
1367 \begin_layout Standard
1368 Invoking \SpecialChar LyX
1369 with the command line switch
1370 \begin_inset Flex Code
1373 \begin_layout Plain Layout
1383 instructs the program to read the configuration from that directory, and
1384 not from the default directory.
1385 (You can determine the default directory by running \SpecialChar LyX
1387 \begin_inset Flex Code
1390 \begin_layout Plain Layout
1396 switch.) If the specified directory does not exist, \SpecialChar LyX
1398 for you, just like it does for the default directory on the first time
1399 you run the program.
1400 You can modify the configuration options in this additional user directory
1401 exactly as you would for the default directory.
1402 These directories are completely independent (but read on).
1403 Note that setting the environment variable
1404 \begin_inset Flex Code
1407 \begin_layout Plain Layout
1413 to some value has exactly the same effect.
1416 \begin_layout Standard
1417 Having several configurations also requires more maintenance: if you want
1418 to add a new layout to
1419 \begin_inset Flex Code
1422 \begin_layout Plain Layout
1428 which you want available from all your configurations, you must add it
1429 to each directory separately.
1430 You can avoid this with the following trick: after \SpecialChar LyX
1431 creates the additional
1432 directory, most of the subdirectories (see above) are empty.
1433 If you want the new configuration to mirror an existing one, replace the
1434 empty subdirectory with a symbolic link to the matching subdirectory in
1435 the existing configuration.
1437 \begin_inset Flex Code
1440 \begin_layout Plain Layout
1446 subdirectory, however, since it contains a file written by the configuration
1447 script (also accessible through
1448 \begin_inset Flex Noun
1451 \begin_layout Plain Layout
1452 Tools\SpecialChar menuseparator
1458 ) which is configuration-specific.
1461 \begin_layout Chapter
1462 The Preferences dialog
1465 \begin_layout Standard
1466 All options of the preferences dialog are described in the Appendix
1468 The Preferences Dialog
1475 For some options you might find here more details.
1478 \begin_layout Section
1480 \begin_inset CommandInset label
1489 \begin_layout Standard
1490 The first step is to define your file formats if they are not already defined.
1492 \begin_inset Flex Noun
1495 \begin_layout Plain Layout
1496 Tools\SpecialChar menuseparator
1504 \begin_inset Flex Noun
1507 \begin_layout Plain Layout
1508 File Handling\SpecialChar menuseparator
1515 \begin_inset Flex Noun
1518 \begin_layout Plain Layout
1524 button to define your new format.
1526 \begin_inset Flex Noun
1529 \begin_layout Plain Layout
1535 field contains the name used to identify the format in the GUI.
1537 \begin_inset Flex Noun
1540 \begin_layout Plain Layout
1546 is used to identify the format internally.
1547 You will also need to enter a file extension.
1548 These are all required.
1550 \begin_inset Flex Noun
1553 \begin_layout Plain Layout
1559 field is used to provide a keyboard shortcut on the menus.
1560 (For example, pressing
1561 \begin_inset Flex Noun
1564 \begin_layout Plain Layout
1571 \begin_inset Flex Noun
1574 \begin_layout Plain Layout
1575 Document\SpecialChar menuseparator
1576 View (Other Formats)\SpecialChar menuseparator
1585 \begin_layout Standard
1587 \begin_inset Flex Noun
1590 \begin_layout Plain Layout
1597 \begin_inset Flex Noun
1600 \begin_layout Plain Layout
1607 For example, you might want to use
1608 \begin_inset Flex Noun
1611 \begin_layout Plain Layout
1617 to view PostScript files.
1618 You can enter the command needed to start the program in the corresponding
1620 In defining this command, you can use the four variables listed in the
1622 The viewer is launched when you view an image in \SpecialChar LyX
1624 \begin_inset Flex Noun
1627 \begin_layout Plain Layout
1628 Document\SpecialChar menuseparator
1635 The editor is for example launched when you right-click on an image and
1637 \begin_inset Flex Noun
1640 \begin_layout Plain Layout
1646 in the appearing context menu.
1649 \begin_layout Standard
1651 \begin_inset Flex Noun
1654 \begin_layout Plain Layout
1660 type of a format is optional, but if it is specified, it must be unique
1662 It is used to detect files of this format from the file contents.
1663 For some important file formats there is no MIME type officially registered
1665 \begin_inset CommandInset href
1668 target "http://www.iana.org/assignments/media-types/"
1674 Therefore \SpecialChar LyX
1675 uses the extended list of MIME types as specified by
1676 \begin_inset CommandInset href
1678 name "freedesktop.org"
1679 target "http://www.freedesktop.org/wiki/Specifications/shared-mime-info-spec"
1687 \begin_layout Standard
1689 \begin_inset Flex Noun
1692 \begin_layout Plain Layout
1698 option tells \SpecialChar LyX
1699 that a format is suitable for document export.
1700 If this is set and if a suitable conversion route exists (see
1701 \begin_inset CommandInset ref
1703 reference "sec:Converters"
1707 ), the format will appear in the
1708 \begin_inset Flex Noun
1711 \begin_layout Plain Layout
1712 File\SpecialChar menuseparator
1719 The format will also appear in the
1720 \begin_inset Flex Noun
1723 \begin_layout Plain Layout
1724 Document\SpecialChar menuseparator
1730 menu if a viewer is specified for the format.
1731 Pure image formats, such as
1732 \begin_inset Flex Code
1735 \begin_layout Plain Layout
1741 , should not use this option.
1742 Formats that can both represent vector graphics and documents like
1743 \begin_inset Flex Code
1746 \begin_layout Plain Layout
1755 \begin_layout Standard
1757 \begin_inset Flex Noun
1760 \begin_layout Plain Layout
1761 Vector graphics format
1766 tells \SpecialChar LyX
1767 that a format can contain vector graphics.
1768 This information is used to determine the target format of included graphics
1770 \begin_inset Flex Noun
1773 \begin_layout Plain Layout
1780 Included graphics may need to be converted to either
1781 \begin_inset Flex Noun
1784 \begin_layout Plain Layout
1791 \begin_inset Flex Noun
1794 \begin_layout Plain Layout
1801 \begin_inset Flex Noun
1804 \begin_layout Plain Layout
1811 \begin_inset Flex Noun
1814 \begin_layout Plain Layout
1820 cannot handle other image formats.
1821 If an included graphic is not already in
1822 \begin_inset Flex Noun
1825 \begin_layout Plain Layout
1832 \begin_inset Flex Noun
1835 \begin_layout Plain Layout
1842 \begin_inset Flex Noun
1845 \begin_layout Plain Layout
1851 format, it is converted to
1852 \begin_inset Flex Noun
1855 \begin_layout Plain Layout
1861 if the vector format option is set, and otherwise to
1862 \begin_inset Flex Noun
1865 \begin_layout Plain Layout
1874 \begin_layout Section
1878 \begin_layout Standard
1879 Since all conversions from one format to another take place in \SpecialChar LyX
1881 directory, it is sometimes necessary to modify a file before copying it
1882 to the temporary directory in order that the conversion may be performed.
1886 \begin_layout Plain Layout
1887 For example, the file may refer to other files—images, for example—using
1888 relative file names, and these may become invalid when the file is copied
1889 to the temporary directory.
1894 This is done by a Copier: It copies a file to (or from) the temporary directory
1895 and may modify it in the process.
1898 \begin_layout Standard
1899 The definitions of the copiers may use eight variables:
1902 \begin_layout Labeling
1903 \labelwidthstring 00.00.0000
1904 \begin_inset Flex Code
1907 \begin_layout Plain Layout
1913 The \SpecialChar LyX
1914 system directory (e.
1915 \begin_inset space \thinspace{}
1919 \begin_inset space \space{}
1923 \begin_inset Flex Noun
1926 \begin_layout Plain Layout
1935 \begin_layout Labeling
1936 \labelwidthstring 00.00.0000
1937 \begin_inset Flex Code
1940 \begin_layout Plain Layout
1949 \begin_layout Labeling
1950 \labelwidthstring 00.00.0000
1951 \begin_inset Flex Code
1954 \begin_layout Plain Layout
1963 \begin_layout Labeling
1964 \labelwidthstring 00.00.0000
1965 \begin_inset Flex Code
1968 \begin_layout Plain Layout
1974 The base name (without filename extension) in the \SpecialChar LyX
1978 \begin_layout Labeling
1979 \labelwidthstring 00.00.0000
1980 \begin_inset Flex Code
1983 \begin_layout Plain Layout
1989 The full directory path of the \SpecialChar LyX
1993 \begin_layout Labeling
1994 \labelwidthstring 00.00.0000
1995 \begin_inset Flex Code
1998 \begin_layout Plain Layout
2004 The full pathname to the original \SpecialChar LyX
2005 file being processed
2008 \begin_layout Labeling
2009 \labelwidthstring 00.00.0000
2010 \begin_inset Flex Code
2013 \begin_layout Plain Layout
2019 The filename (without any directory path) of the \SpecialChar LyX
2023 \begin_layout Labeling
2024 \labelwidthstring 00.00.0000
2025 \begin_inset Flex Code
2028 \begin_layout Plain Layout
2034 The `\SpecialChar LaTeX
2038 \begin_layout Standard
2039 The latter should be the filename as it would be used in a \SpecialChar LaTeX
2047 It is relevant only when exporting files suitable for such inclusion.
2050 \begin_layout Standard
2051 Copiers can be used to do almost anything with output files.
2052 For example, suppose you want generated pdf files to be copied to a special
2054 \begin_inset Flex Code
2057 \begin_layout Plain Layout
2064 Then you could write a shell script such as this one:
2067 \begin_layout Standard
2068 \begin_inset listings
2072 \begin_layout Plain Layout
2077 \begin_layout Plain Layout
2082 \begin_layout Plain Layout
2084 TOFILE=`basename $2`
2087 \begin_layout Plain Layout
2089 cp $FROMFILE /home/you/pdf/$TOFILE
2094 Save it in your local \SpecialChar LyX
2096 \begin_inset Flex Code
2099 \begin_layout Plain Layout
2100 /home/you/.lyx/scripts/pdfcopier.sh
2105 —and make it executable, if you need to do so on your platform.
2107 \begin_inset Flex Noun
2110 \begin_layout Plain Layout
2111 Tools\SpecialChar menuseparator
2117 dialog, select under
2118 \begin_inset Flex Noun
2121 \begin_layout Plain Layout
2122 File Handling\SpecialChar menuseparator
2129 \begin_inset Flex Noun
2132 \begin_layout Plain Layout
2138 format—or one of the other pdf formats—and enter
2139 \begin_inset Flex Code
2142 \begin_layout Plain Layout
2143 pdfcopier.sh $$i $$o
2149 \begin_inset Flex Noun
2152 \begin_layout Plain Layout
2162 \begin_layout Standard
2163 Copiers are used by \SpecialChar LyX
2164 in various of its own conversions.
2165 For example, if appropriate programs are found, \SpecialChar LyX
2166 will automatically install
2168 \begin_inset Flex Noun
2171 \begin_layout Plain Layout
2178 \begin_inset Flex Noun
2181 \begin_layout Plain Layout
2183 \begin_inset space ~
2192 When these formats are exported, the copier sees that not just the main
2193 HTML file but various associated files (style files, images, etc.) are also
2195 All these files are written to a subdirectory of the directory in which
2196 the original \SpecialChar LyX
2201 \begin_layout Plain Layout
2202 This copier can be customized.
2204 \begin_inset Quotes eld
2208 \begin_inset Quotes erd
2211 argument takes a comma-separated list of extensions to be copied; if it
2212 is omitted, all files will be copied.
2214 \begin_inset Quotes eld
2218 \begin_inset Quotes erd
2221 argument determines the extension added to the generated directory.
2223 \begin_inset Quotes eld
2227 \begin_inset Flex Noun
2230 \begin_layout Plain Layout
2237 \begin_inset Quotes erd
2240 , so HTML generated from
2241 \begin_inset Flex Noun
2244 \begin_layout Plain Layout
2245 /path/to/filename.lyx
2251 \begin_inset Flex Noun
2254 \begin_layout Plain Layout
2255 /path/to/filename.html.LyXconv
2269 \begin_layout Section
2271 \begin_inset CommandInset label
2273 name "sec:Converters"
2280 \begin_layout Standard
2281 You can define your own Converters to convert files between different formats.
2283 \begin_inset Flex Noun
2286 \begin_layout Plain Layout
2287 Tools\SpecialChar menuseparator
2288 Preferences\SpecialChar menuseparator
2289 File Handling\SpecialChar menuseparator
2298 \begin_layout Standard
2299 To define a new converter, select the
2300 \begin_inset Flex Noun
2303 \begin_layout Plain Layout
2305 \begin_inset space ~
2314 \begin_inset Flex Noun
2317 \begin_layout Plain Layout
2319 \begin_inset space ~
2327 from the drop-down lists, enter the command needed for the conversion,
2329 \begin_inset Flex Noun
2332 \begin_layout Plain Layout
2339 Several variables can be used in the definition of converters:
2342 \begin_layout Labeling
2343 \labelwidthstring 00.00.0000
2344 \begin_inset Flex Code
2347 \begin_layout Plain Layout
2353 The \SpecialChar LyX
2357 \begin_layout Labeling
2358 \labelwidthstring 00.00.0000
2359 \begin_inset Flex Code
2362 \begin_layout Plain Layout
2371 \begin_layout Labeling
2372 \labelwidthstring 00.00.0000
2373 \begin_inset Flex Code
2376 \begin_layout Plain Layout
2385 \begin_layout Labeling
2386 \labelwidthstring 00.00.0000
2387 \begin_inset Flex Code
2390 \begin_layout Plain Layout
2396 The base filename of the input file (i.
2397 \begin_inset space \thinspace{}
2400 g., without the extension)
2403 \begin_layout Labeling
2404 \labelwidthstring 00.00.0000
2405 \begin_inset Flex Code
2408 \begin_layout Plain Layout
2414 The path to the input file
2417 \begin_layout Labeling
2418 \labelwidthstring 00.00.0000
2419 \begin_inset Flex Code
2422 \begin_layout Plain Layout
2428 The path to the original input file (this is different from $$p when a
2429 chain of converters is called)
2432 \begin_layout Labeling
2433 \labelwidthstring 00.00.0000
2434 \begin_inset Flex Code
2437 \begin_layout Plain Layout
2443 The iconv name for the encoding of the document.
2446 \begin_layout Standard
2448 \begin_inset Flex Noun
2451 \begin_layout Plain Layout
2453 \begin_inset space ~
2461 field you can enter the following flags, separated by commas:
2464 \begin_layout Labeling
2465 \labelwidthstring 00.00.0000
2466 \begin_inset Flex Code
2469 \begin_layout Plain Layout
2475 This converter runs some form of \SpecialChar LaTeX
2477 This will make \SpecialChar LyX
2478 's \SpecialChar LaTeX
2479 error logs available.
2482 \begin_layout Labeling
2483 \labelwidthstring 00.00.0000
2484 \begin_inset Flex Code
2487 \begin_layout Plain Layout
2493 Needs the \SpecialChar LaTeX
2495 \begin_inset Flex Noun
2498 \begin_layout Plain Layout
2504 file for the conversion.
2507 \begin_layout Labeling
2508 \labelwidthstring 00.00.0000
2509 \begin_inset Flex Code
2512 \begin_layout Plain Layout
2519 \begin_inset Quotes eld
2523 \begin_inset Quotes erd
2526 file from the backend, which in practice means a \SpecialChar LaTeX
2527 file like the one we
2528 would export, without
2529 \begin_inset Flex Code
2532 \begin_layout Plain Layout
2541 \begin_layout Labeling
2542 \labelwidthstring 00.00.0000
2543 \begin_inset Flex Code
2546 \begin_layout Plain Layout
2555 \begin_layout Standard
2556 The following three flags are not really flags at all because they take
2558 \begin_inset Flex Noun
2561 \begin_layout Plain Layout
2563 \begin_inset space ~
2567 \begin_inset space ~
2578 \begin_layout Labeling
2579 \labelwidthstring 00.00.0000
2580 \begin_inset Flex Code
2583 \begin_layout Plain Layout
2589 If set, the converter's standard error will be redirected to a file
2590 \begin_inset Flex Code
2593 \begin_layout Plain Layout
2599 , and the script given as argument will be run as:
2600 \begin_inset Flex Code
2603 \begin_layout Plain Layout
2604 script < infile.out > infile.log
2610 The argument may contain
2611 \begin_inset Flex Code
2614 \begin_layout Plain Layout
2623 \begin_layout Labeling
2624 \labelwidthstring 00.00.0000
2625 \begin_inset Flex Code
2628 \begin_layout Plain Layout
2634 The name of the directory in which the converter will dump the generated
2637 will not create this directory, and it does not copy anything into it,
2638 though it will copy this directory to the destination.
2639 The argument may contain
2640 \begin_inset Flex Code
2643 \begin_layout Plain Layout
2649 , which will be replaced by the base name of the input and output files,
2650 respectively, when the directory is copied.
2651 \begin_inset Newline newline
2654 Note that resultdir and usetempdir make no sense together.
2655 The latter will be ignored if the former is given.
2658 \begin_layout Labeling
2659 \labelwidthstring 00.00.0000
2660 \begin_inset Flex Code
2663 \begin_layout Plain Layout
2669 Determines the output file name and may, contain
2670 \begin_inset Flex Code
2673 \begin_layout Plain Layout
2680 Sensible only with resultdir and optional even then; if not given, it defaults
2684 \begin_layout Standard
2685 None of these last three are presently used in any of the converters that
2686 are installed with \SpecialChar LyX
2691 \begin_layout Standard
2692 You do not have to define converters for all formats between which you want
2694 For example, you will note that there is no `\SpecialChar LyX
2695 to PostScript' converter,
2696 but \SpecialChar LyX
2697 will export PostScript.
2698 It does so by first creating a \SpecialChar LaTeX
2699 file (no converter needs to be defined
2700 for this) which is then converted to DVI using the `\SpecialChar LaTeX
2702 and finally converting the resulting DVI file to PostScript.
2704 finds such `chains' of converters automatically, and it will always choose
2705 the shortest possible chain.
2706 You can, though, still define multiple conversion methods between file
2708 For example, the standard \SpecialChar LyX
2709 configuration provides five ways to convert
2714 \begin_layout Enumerate
2716 \begin_inset Flex Noun
2719 \begin_layout Plain Layout
2728 \begin_layout Enumerate
2729 via (DVI and) PostScript, using
2730 \begin_inset Flex Noun
2733 \begin_layout Plain Layout
2742 \begin_layout Enumerate
2744 \begin_inset Flex Noun
2747 \begin_layout Plain Layout
2756 \begin_layout Enumerate
2758 \begin_inset Flex Noun
2761 \begin_layout Plain Layout
2771 \begin_layout Enumerate
2773 \begin_inset Flex Noun
2776 \begin_layout Plain Layout
2786 \begin_layout Standard
2787 To define such alternate chains, you must define multiple target `file formats',
2789 \begin_inset CommandInset ref
2791 reference "sec:Formats"
2796 For example, in the standard configuration, the formats named
2797 \begin_inset Flex Noun
2800 \begin_layout Plain Layout
2807 \begin_inset Flex Noun
2810 \begin_layout Plain Layout
2817 \begin_inset Flex Noun
2820 \begin_layout Plain Layout
2827 \begin_inset Flex Noun
2830 \begin_layout Plain Layout
2837 \begin_inset Flex Noun
2840 \begin_layout Plain Layout
2847 \begin_inset Flex Noun
2850 \begin_layout Plain Layout
2857 \begin_inset Flex Noun
2860 \begin_layout Plain Layout
2867 \begin_inset Flex Noun
2870 \begin_layout Plain Layout
2878 \begin_inset Flex Noun
2881 \begin_layout Plain Layout
2888 \begin_inset Flex Noun
2891 \begin_layout Plain Layout
2898 ) are defined, all of which share the extension
2899 \begin_inset Flex Noun
2902 \begin_layout Plain Layout
2908 , and which correspond to the conversion methods just mentioned.
2911 \begin_layout Chapter
2912 Internationalizing \SpecialChar LyX
2914 \begin_inset CommandInset label
2916 name "cha:Internationalizing-LyX"
2923 \begin_layout Standard
2925 supports using a translated interface.
2926 Last time we checked, \SpecialChar LyX
2927 provided text in thirty languages.
2928 The language of choice is called your
2933 (For further reading on locale settings, see also the documentation for
2934 locale that comes with your operating system.
2935 For Linux, the manual page for
2936 \begin_inset Flex Code
2939 \begin_layout Plain Layout
2945 could be a good place to start).
2948 \begin_layout Standard
2949 Notice that these translations will work, but do contain a few flaws.
2950 In particular, all dialogs have been designed with the English text in
2951 mind, which means that some of the translated text will be too large to
2952 fit within the space allocated.
2953 This is only a display problem and will not cause any harm.
2954 Also, you will find that some of the translations do not define shortcut
2955 keys for everything.
2956 Sometimes, there are simply not enough free letters to do it.
2957 Other times, the translator just hasn't got around to doing it yet.
2958 Our localization team, which you may wish to join,
2962 \begin_layout Plain Layout
2963 If you are a fluent speaker of a language other than English, joining these
2964 teams is a great way to give back to the \SpecialChar LyX
2970 will of course try to fix these shortcomings in future versions of \SpecialChar LyX
2974 \begin_layout Section
2975 Translating \SpecialChar LyX
2979 \begin_layout Subsection
2980 Translating the graphical user interface (text messages).
2983 \begin_layout Standard
2986 \begin_inset Flex Code
2989 \begin_layout Plain Layout
2995 library to handle the internationalization of the interface.
2996 To have \SpecialChar LyX
2997 speak your favorite language in all menus and dialogs, you need
2999 \begin_inset Flex Code
3002 \begin_layout Plain Layout
3008 -file for that language.
3009 When this is available, you'll have to generate a
3010 \begin_inset Flex Code
3013 \begin_layout Plain Layout
3019 -file from it and install the
3020 \begin_inset Flex Code
3023 \begin_layout Plain Layout
3030 The process of doing all of this is explained in the documentation for
3032 \begin_inset Flex Code
3035 \begin_layout Plain Layout
3042 It is possible to do this just for yourself, but if you're going to do
3043 it, you might as well share the results of your labors with the rest of
3044 the \SpecialChar LyX
3046 Send a message to the \SpecialChar LyX
3047 developers' list for more information about how
3051 \begin_layout Standard
3052 In short, this is what you should do (xx denotes the language code):
3055 \begin_layout Itemize
3056 Check out the \SpecialChar LyX
3059 \begin_inset CommandInset href
3061 name "information on the web"
3062 target "http://www.lyx.org/HowToUseGIT"
3070 \begin_layout Itemize
3072 \begin_inset Flex Code
3075 \begin_layout Plain Layout
3081 to the folder of the
3082 \begin_inset Flex Code
3085 \begin_layout Plain Layout
3093 \begin_inset Flex Code
3096 \begin_layout Plain Layout
3104 \begin_inset Flex Code
3107 \begin_layout Plain Layout
3113 doesn't exist anywhere, it can be remade with the console command
3114 \begin_inset Flex Code
3117 \begin_layout Plain Layout
3123 in that directory, or you can use an existing po-file for some other language
3127 \begin_layout Itemize
3129 \begin_inset Flex Code
3132 \begin_layout Plain Layout
3142 \begin_layout Plain Layout
3143 This is just a text file, so it can be edited in any text editor.
3144 But there are also specialized programs that support such editing, such
3149 (for all platforms) or
3158 contains a `mode' for editing
3159 \begin_inset Flex Code
3162 \begin_layout Plain Layout
3169 \begin_inset Flex URL
3172 \begin_layout Plain Layout
3174 https://www.gnu.org/software/gettext/manual/html_node/PO-Mode.html
3186 For some menu- and widget-labels, there are also shortcut keys that should
3188 Those keys are marked after a `|', and should be translated according to
3189 the words and phrases of the language.
3190 You should also fill also out the information at the beginning of the new
3192 \begin_inset Flex Code
3195 \begin_layout Plain Layout
3201 -file with your email-address, etc., so people know where to reach you with
3202 suggestions and entertaining flames.
3205 \begin_layout Standard
3206 If you are just doing this on your own, then:
3209 \begin_layout Itemize
3211 \begin_inset Flex Code
3214 \begin_layout Plain Layout
3221 This can be done with
3222 \begin_inset Flex Code
3225 \begin_layout Plain Layout
3226 msgfmt -o xx.mo < xx.po
3234 \begin_layout Itemize
3236 \begin_inset Flex Code
3239 \begin_layout Plain Layout
3245 -file to your locale-tree, at the correct directory for application messages
3250 xx, and under the name
3251 \begin_inset Flex Code
3254 \begin_layout Plain Layout
3261 \begin_inset space \thinspace{}
3265 \begin_inset space \space{}
3269 \begin_inset Flex Code
3272 \begin_layout Plain Layout
3273 /usr/local/share/locale/xx/LC_MESSAGES/lyx.mo
3283 \begin_layout Standard
3284 As said, however, it would be best if the new
3285 \begin_inset Flex Code
3288 \begin_layout Plain Layout
3294 file could be added to the \SpecialChar LyX
3295 distribution, so others can use it.
3296 Adding it involves making additional changes to \SpecialChar LyX
3298 So send an email to the developers' mailing list if you're interested in
3302 \begin_layout Subsubsection
3306 \begin_layout Standard
3307 Sometimes it turns out that one English message needs to be translated into
3308 different messages in the target language.
3309 One example is the message
3310 \begin_inset Flex Code
3313 \begin_layout Plain Layout
3319 which has the German translation
3327 , depending upon exactly what the English
3328 \begin_inset Quotes eld
3332 \begin_inset Quotes erd
3337 \begin_inset Flex Code
3340 \begin_layout Plain Layout
3346 does not handle such ambiguous translations.
3347 Therefore you have to add some context information to the message: Instead
3349 \begin_inset Flex Code
3352 \begin_layout Plain Layout
3359 \begin_inset Flex Code
3362 \begin_layout Plain Layout
3363 To[[as in 'From format x to format y']]
3369 \begin_inset Flex Code
3372 \begin_layout Plain Layout
3373 To[[as in 'From page x to page y']].
3378 Now the two occurrences of
3379 \begin_inset Flex Code
3382 \begin_layout Plain Layout
3389 \begin_inset Flex Code
3392 \begin_layout Plain Layout
3398 and can be translated correctly to
3409 \begin_layout Standard
3410 Of course the context information needs to be stripped off the original
3411 message when no translation is used.
3412 Therefore you have to put it in double square brackets at the end of the
3413 message (see the example above).
3414 The translation mechanism of \SpecialChar LyX
3415 ensures that everything in double square
3416 brackets at the end of messages is removed before displaying the message.
3419 \begin_layout Subsection
3420 Translating the documentation.
3423 \begin_layout Standard
3424 The online documentation (in the
3425 \begin_inset Flex Noun
3428 \begin_layout Plain Layout
3434 -menu) can (and should!) be translated.
3435 If there are translated versions of the documentation available
3439 \begin_layout Plain Layout
3440 As of March 2008, at least some of the documents have been translated into
3441 fourteen languages, with the Tutorial available in a few more.
3446 and the locale is set accordingly, these will be used automagically by
3450 looks for translated versions as
3451 \begin_inset Flex Code
3454 \begin_layout Plain Layout
3455 LyXDir/doc/xx/DocName.lyx
3461 \begin_inset Flex Code
3464 \begin_layout Plain Layout
3470 is the code for the language currently in use.
3471 If there are no translated documents, the default English versions will
3473 Note that the translated versions must have the same filenames (
3474 \begin_inset Flex Code
3477 \begin_layout Plain Layout
3483 above) as the original.
3484 If you feel up to translating the documentation (an excellent way to proof-read
3485 the original documentation by the way!), there are a few things you should
3489 \begin_layout Itemize
3490 Check out the documentation translation web page at
3491 \begin_inset CommandInset href
3493 name "http://www.lyx.org/Translation"
3494 target "http://www.lyx.org/Translation"
3500 That way, you can find out which (if any) documents have already been translate
3501 d into your language.
3502 You can also find out who (if anyone) is organizing the effort to translate
3503 the documentation into your language.
3504 If no one is organizing the effort, please let us know that you're interested.
3507 \begin_layout Standard
3508 Once you get to actually translating, here's a few hints for you that may
3512 \begin_layout Itemize
3513 Join the documentation team! There is information on how to do that in
3514 \begin_inset Flex Code
3517 \begin_layout Plain Layout
3524 \begin_inset Flex Noun
3527 \begin_layout Plain Layout
3528 Help\SpecialChar menuseparator
3534 ), which by the way is the first document you should translate.
3537 \begin_layout Itemize
3538 Learn the typographic conventions for the language you are translating to.
3539 Typography is an ancient art and over the centuries, a great variety of
3540 conventions have developed throughout different parts of the world.
3541 Also study the professional terminology amongst typographers in your country.
3542 Inventing your own terminology will only confuse the users.
3545 (Warning! Typography is addictive!)
3548 \begin_layout Itemize
3549 Make a copy of the document.
3550 This will be your working copy.
3551 You can use this as your personal translated help-file by placing it in
3553 \begin_inset Flex Code
3556 \begin_layout Plain Layout
3563 \begin_inset Note Greyedout
3566 \begin_layout Plain Layout
3571 For a complex document with external material (images, etc.), if you make
3573 \begin_inset space \thinspace{}
3577 \begin_inset space \space{}
3580 in a temp dir, beware that the links to external material may be broken
3581 when the document is moved to a different place.
3582 The best way is to retrieve the \SpecialChar LyX
3584 \begin_inset Flex URL
3587 \begin_layout Plain Layout
3589 http://www.lyx.org/HowToUseGIT
3594 ) and to edit the doc file in place.
3602 \begin_layout Itemize
3603 Sometimes the original document (from the \SpecialChar LyX
3604 team) will be updated.
3605 Use the source viewer at
3606 \begin_inset CommandInset href
3608 name "http://www.lyx.org/trac/timeline"
3609 target "http://www.lyx.org/trac/timeline"
3614 to see what has been changed.
3615 That way you can easily see which parts of the translated document need
3619 \begin_layout Standard
3620 If you ever find an error in the original document, fix it and notify the
3621 rest of the documentation team of the changes! (You didn't forget to join
3622 the documentation team, did you?)
3625 \begin_layout Standard
3626 \begin_inset Branch OutDated
3630 \begin_layout Section
3631 International Keyboard Support
3634 \begin_layout Standard
3637 [Editor's Note: The following section is by
3645 It needs to be fixed to conform to the new Documentation Style sheet and
3646 to make use of the new v1.0 features.
3647 The whole thing also needs to be merged with the section following it.-jw
3648 It may also be badly out of date.-rh (2008)]
3651 \begin_layout Subsection
3652 Defining Own Keymaps: Keymap File Format
3655 \begin_layout Standard
3656 Let's look at a keyboard definition file a little closer.
3657 It is a plain text file defining
3660 \begin_layout Itemize
3661 key-to-key or key-to-string translations
3664 \begin_layout Itemize
3668 \begin_layout Itemize
3669 dead keys exceptions
3672 \begin_layout Standard
3673 To define key-to-key or key-to-string translation, use this command:
3676 \begin_layout Quotation
3677 \begin_inset Flex Code
3680 \begin_layout Plain Layout
3689 \begin_inset Flex Code
3692 \begin_layout Plain Layout
3701 \begin_layout Standard
3703 \begin_inset Flex Code
3706 \begin_layout Plain Layout
3712 is the key to be translated and
3713 \begin_inset Flex Code
3716 \begin_layout Plain Layout
3722 is the string to be inserted into the document.
3723 To define dead keys, use:
3726 \begin_layout Quotation
3727 \begin_inset Flex Code
3730 \begin_layout Plain Layout
3739 \begin_inset Flex Code
3742 \begin_layout Plain Layout
3751 \begin_layout Standard
3753 \begin_inset Flex Code
3756 \begin_layout Plain Layout
3762 is a keyboard key and
3763 \begin_inset Flex Code
3766 \begin_layout Plain Layout
3773 The following dead keys are supported (shortcut name is in parentheses):
3776 \begin_layout Quotation
3780 \begin_inset space \hfill{}
3786 \begin_layout Quotation
3788 \begin_inset space \hfill{}
3794 \begin_layout Quotation
3796 \begin_inset space \hfill{}
3802 \begin_layout Quotation
3804 \begin_inset space \hfill{}
3810 \begin_layout Quotation
3812 \begin_inset space \hfill{}
3818 \begin_layout Quotation
3820 \begin_inset space \hfill{}
3827 \begin_layout Plain Layout
3839 \begin_layout Quotation
3841 \begin_inset space \hfill{}
3847 \begin_layout Quotation
3849 \begin_inset space \hfill{}
3856 \begin_layout Plain Layout
3868 \begin_layout Quotation
3870 \begin_inset space \hfill{}
3876 \begin_layout Quotation
3878 \begin_inset space \hfill{}
3884 \begin_layout Quotation
3886 \begin_inset space \hfill{}
3893 \begin_layout Plain Layout
3905 \begin_layout Quotation
3907 \begin_inset space \hfill{}
3914 \begin_layout Plain Layout
3926 \begin_layout Quotation
3928 \begin_inset space \hfill{}
3934 \begin_layout Quotation
3935 hungarian umlaut (hug)
3936 \begin_inset space \hfill{}
3942 \begin_layout Quotation
3944 \begin_inset space \hfill{}
3950 \begin_layout Quotation
3952 \begin_inset space \hfill{}
3959 \begin_layout Plain Layout
3971 \begin_layout Standard
3972 Since in many international keyboards there are exceptions to what some
3973 dead keys should do, you can define them using
3976 \begin_layout Quotation
3977 \begin_inset Flex Code
3980 \begin_layout Plain Layout
3988 deadkey key outstring
3991 \begin_layout Standard
3992 For example, on Slovak keyboard, if you enter caron-o, it generates circumflex-o
3996 \begin_layout Quotation
3997 \begin_inset Flex Code
4000 \begin_layout Plain Layout
4013 \begin_layout Standard
4014 to make it work correctly.
4015 Also, you have to define as exceptions dead keys over i and j, to remove
4016 the dot from them before inserting an accent mark.
4017 I will change this when the time comes, but so far I haven't had time.
4020 \begin_layout Standard
4021 Oh, and about characters: backslash is escaped, so to enter it, you'll need
4024 \begin_inset Flex Code
4027 \begin_layout Plain Layout
4033 have different meaning.
4035 \begin_inset Flex Code
4038 \begin_layout Plain Layout
4044 marks comments, quotes start and end \SpecialChar LaTeX
4046 To enter quote, you'll need to use
4047 \begin_inset Flex Code
4050 \begin_layout Plain Layout
4059 \begin_inset Flex Code
4062 \begin_layout Plain Layout
4069 \begin_inset Flex Code
4072 \begin_layout Plain Layout
4083 \begin_layout Standard
4084 If you make a keyboard description file that works for your language, please
4085 mail it to me, so I can include it in the next keymap distribution.
4088 \begin_layout Standard
4089 More keywords will be supported in keymap configuration file in future,
4093 \begin_layout Itemize
4094 \begin_inset Flex Code
4097 \begin_layout Plain Layout
4108 \begin_inset space \hfill{}
4112 \begin_inset Flex Code
4115 \begin_layout Plain Layout
4124 \begin_layout Itemize
4125 \begin_inset Flex Code
4128 \begin_layout Plain Layout
4139 \begin_inset space \hfill{}
4143 \begin_inset Flex Code
4146 \begin_layout Plain Layout
4152 an external keymap translation program
4155 \begin_layout Standard
4156 Also, it should look into
4157 \begin_inset Flex Code
4160 \begin_layout Plain Layout
4166 file for defaults, too (for example, a
4167 \begin_inset Flex Code
4170 \begin_layout Plain Layout
4178 option to include default keyboard).
4186 \begin_layout Section
4187 International Keymap Stuff
4188 \begin_inset CommandInset label
4190 name "sec:International-Keymap-Stuff"
4197 \begin_layout Standard
4198 \begin_inset Note Note
4201 \begin_layout Plain Layout
4202 In doing the revisions on this document in March 2008, I did not look over
4203 this stuff, as I do not understand it.
4204 It would be good if someone else could do so.
4213 \begin_layout Standard
4214 The next two sections describe the
4215 \begin_inset Flex Code
4218 \begin_layout Plain Layout
4227 \begin_inset Flex Code
4230 \begin_layout Plain Layout
4238 file syntax in detail.
4239 These sections should help you design your own key map if the ones provided
4240 do not meet your needs.
4243 \begin_layout Subsection
4247 \begin_layout Standard
4251 \begin_inset Flex Code
4254 \begin_layout Plain Layout
4260 file maps keystrokes to characters or strings.
4261 As the name suggests, it sets a keyboard mapping.
4263 \begin_inset Flex Code
4266 \begin_layout Plain Layout
4277 \begin_inset Flex Code
4280 \begin_layout Plain Layout
4295 \begin_inset Flex Code
4298 \begin_layout Plain Layout
4311 \begin_inset Flex Code
4314 \begin_layout Plain Layout
4323 \begin_inset Flex Code
4326 \begin_layout Plain Layout
4334 are described in this section.
4337 \begin_layout Labeling
4338 \labelwidthstring 00.00.0000
4339 \begin_inset Flex Code
4342 \begin_layout Plain Layout
4350 Map a character to a string
4353 \begin_layout LyX-Code
4368 \begin_layout Standard
4401 the double-quote (")
4418 must be escaped with a preceding backslash (
4429 \begin_layout Standard
4431 \begin_inset Flex Noun
4434 \begin_layout Plain Layout
4442 statement to cause the symbol
4443 \begin_inset Flex Noun
4446 \begin_layout Plain Layout
4454 to be output for the keystroke
4455 \begin_inset Flex Noun
4458 \begin_layout Plain Layout
4469 \begin_layout LyX-Code
4475 \begin_layout Labeling
4476 \labelwidthstring 00.00.0000
4477 \begin_inset Flex Code
4480 \begin_layout Plain Layout
4488 Specify an accent character
4491 \begin_layout LyX-Code
4500 \begin_layout Standard
4501 This will make the cha
4539 This is the dead key
4543 \begin_layout Plain Layout
4550 refers to a key that does not produce a character by itself, but when followed
4551 with another key, produces the desired accent character.
4552 For example, a German characte
4554 r with an umlaut like
4564 can be produced in this manner.
4573 \begin_layout Standard
4586 and then another key not in
4603 followed by the other, not allowed key, as output.
4607 \begin_inset Flex Noun
4610 \begin_layout Plain Layout
4618 cancels a dead key, so if
4629 \begin_inset Flex Noun
4632 \begin_layout Plain Layout
4641 , the cursor will not go one position backwards but will instead cancel
4657 might have had on the next keystroke.
4661 \begin_layout Standard
4662 The following example specifies that the character ' is to be an acute accent,
4663 allowed on the characters a, e, i, o, u, A, E, I, O, and U:
4666 \begin_layout LyX-Code
4669 kmod ' acute aeiouAEIOU
4672 \begin_layout Labeling
4673 \labelwidthstring 00.00.0000
4674 \begin_inset Flex Code
4677 \begin_layout Plain Layout
4683 Specify an exception to the accent character
4686 \begin_layout LyX-Code
4695 \begin_layout Standard
4696 This defines an exce
4737 have been assigned a keystroke with a previous
4740 \begin_inset Flex Code
4743 \begin_layout Plain Layout
4767 must not belong in the
4814 If such a declaration does not exist in
4822 \begin_inset Flex Code
4825 \begin_layout Plain Layout
4859 \begin_inset Flex Code
4862 \begin_layout Plain Layout
4876 \begin_layout Standard
4877 The following command produces causes äi to be produced when you enter acute-i
4881 \begin_layout LyX-Code
4895 \begin_layout Labeling
4896 \labelwidthstring 00.00.0000
4897 \begin_inset Flex Code
4900 \begin_layout Plain Layout
4906 Combine two accent characters
4909 \begin_layout LyX-Code
4915 accent1 accent2 allowed
4918 \begin_layout Standard
4919 This one is getting pretty esoteric.
4920 It allows you to combine the effect
4976 \begin_inset Flex Code
4979 \begin_layout Plain Layout
5007 \begin_layout Standard
5008 Consider this example from the
5009 \begin_inset Flex Code
5012 \begin_layout Plain Layout
5023 \begin_layout LyX-Code
5026 kmod ; acute aeioyvhAEIOYVH
5030 kcomb acute umlaut iyIY
5033 \begin_layout Standard
5034 This allows you to press
5035 \begin_inset Flex Noun
5038 \begin_layout Plain Layout
5046 and get the effect of
5047 \begin_inset Flex Code
5050 \begin_layout Plain Layout
5069 in this case cancels the last dead key, so if you press
5070 \begin_inset Flex Noun
5073 \begin_layout Plain Layout
5082 \begin_inset Flex Code
5085 \begin_layout Plain Layout
5098 \begin_layout Subsection
5102 \begin_layout Standard
5104 \begin_inset Flex Code
5107 \begin_layout Plain Layout
5115 mapping is performed, a
5116 \begin_inset Flex Code
5119 \begin_layout Plain Layout
5129 file maps the strings that the symbols generate to characters in the current
5131 The \SpecialChar LyX
5132 distribution currently includes at least the
5133 \begin_inset Flex Code
5136 \begin_layout Plain Layout
5145 \begin_inset Flex Code
5148 \begin_layout Plain Layout
5159 \begin_layout Standard
5161 \begin_inset Flex Code
5164 \begin_layout Plain Layout
5172 file is a sequence of declarations of the form
5175 \begin_layout LyX-Code
5188 \begin_layout Standard
5189 For example, in order to map
5190 \begin_inset Flex Noun
5193 \begin_layout Plain Layout
5203 to the corresponding character in the iso-8859-1 set (233), the following
5207 \begin_layout LyX-Code
5215 \begin_layout Standard
5217 \begin_inset Flex Code
5220 \begin_layout Plain Layout
5229 \begin_inset Flex Code
5232 \begin_layout Plain Layout
5250 the same character can apply to more than one string.
5252 \begin_inset Flex Code
5255 \begin_layout Plain Layout
5266 \begin_layout LyX-Code
5278 \begin_inset Newline newline
5294 \begin_layout Standard
5296 cannot find a mapping for the string produced by the keystroke or a
5297 deadkey sequence, it will check if it looks like an accented char and try
5298 to draw an accent over the character on screen.
5301 \begin_layout Subsection
5305 \begin_layout Standard
5306 There is a second way to add support for international characters through
5307 so-called dead-keys.
5308 A dead-key works in combination with a letter to produce an accented character.
5309 Here, we'll explain how to create a really simple dead-key to illustrate
5313 \begin_layout Standard
5314 Suppose you happen to need the circumflex character,
5315 \begin_inset Quotes eld
5319 \begin_inset Quotes erd
5324 \begin_inset Flex Noun
5327 \begin_layout Plain Layout
5334 \begin_inset space ~
5338 \begin_inset Flex Noun
5341 \begin_layout Plain Layout
5347 ] to the \SpecialChar LyX
5349 \begin_inset Flex Code
5352 \begin_layout Plain Layout
5359 \begin_inset Flex Code
5362 \begin_layout Plain Layout
5369 Now, whenever you type the
5370 \begin_inset Flex Noun
5373 \begin_layout Plain Layout
5379 -key followed by a letter, that letter will have a circumflex accent on
5381 For example, the sequence
5382 \begin_inset Quotes eld
5386 \begin_inset Flex Noun
5389 \begin_layout Plain Layout
5396 \begin_inset Quotes erd
5399 produces the letter:
5400 \begin_inset Quotes eld
5404 \begin_inset Quotes erd
5408 If you tried to type
5409 \begin_inset Quotes eld
5413 \begin_inset Flex Noun
5416 \begin_layout Plain Layout
5423 \begin_inset Quotes erd
5426 , however, \SpecialChar LyX
5427 will complain with a beep, since a
5428 \begin_inset Quotes eld
5432 \begin_inset Flex Noun
5435 \begin_layout Plain Layout
5442 \begin_inset Quotes erd
5445 never takes a circumflex accent.
5447 \begin_inset Flex Noun
5450 \begin_layout Plain Layout
5456 after a dead-key produces the bare-accent.
5457 Please note this last point! If you bind a key to a dead-key, you'll need
5458 to rebind the character on that key to yet another key.
5460 \begin_inset Flex Noun
5463 \begin_layout Plain Layout
5469 to a cedilla is a bad idea, since you'll only get cedillas instead of commas.
5472 \begin_layout Standard
5473 One common way to bind dead-keys is to use
5474 \begin_inset Flex Noun
5477 \begin_layout Plain Layout
5484 \begin_inset Flex Noun
5487 \begin_layout Plain Layout
5494 \begin_inset Flex Noun
5497 \begin_layout Plain Layout
5503 in combination with an accent, like
5504 \begin_inset Quotes eld
5508 \begin_inset Flex Noun
5511 \begin_layout Plain Layout
5518 \begin_inset Quotes erd
5522 \begin_inset Quotes eld
5526 \begin_inset Flex Noun
5529 \begin_layout Plain Layout
5536 \begin_inset Quotes erd
5540 \begin_inset Quotes eld
5544 \begin_inset Flex Noun
5547 \begin_layout Plain Layout
5554 \begin_inset Quotes erd
5558 Another way involves using
5559 \begin_inset Flex Code
5562 \begin_layout Plain Layout
5569 \begin_inset Flex Code
5572 \begin_layout Plain Layout
5578 to set up the special
5579 \begin_inset Flex Code
5582 \begin_layout Plain Layout
5590 \begin_inset Flex Code
5593 \begin_layout Plain Layout
5599 acts in some ways just like
5600 \begin_inset Flex Noun
5603 \begin_layout Plain Layout
5609 and permits you to bind keys to accented characters.
5610 You can also turn keys into dead-keys by binding them to something like
5612 \begin_inset Flex Code
5615 \begin_layout Plain Layout
5621 and then binding this symbolic key to the corresponding \SpecialChar LyX
5626 \begin_layout Plain Layout
5631 : This is exactly what I do in my
5632 \begin_inset Flex Code
5635 \begin_layout Plain Layout
5642 \begin_inset Flex Code
5645 \begin_layout Plain Layout
5653 \begin_inset Flex Noun
5656 \begin_layout Plain Layout
5658 \begin_inset space ~
5667 \begin_inset Flex Code
5670 \begin_layout Plain Layout
5676 and a bunch of these
5677 \begin_inset Quotes eld
5681 \begin_inset Flex Code
5684 \begin_layout Plain Layout
5691 \begin_inset Quotes erd
5694 symbolic keys bound such things as
5695 \begin_inset Flex Noun
5698 \begin_layout Plain Layout
5700 \begin_inset space ~
5709 \begin_inset Flex Noun
5712 \begin_layout Plain Layout
5714 \begin_inset space ~
5723 This is how I produce my accented characters.
5728 You can make just about anything into the
5729 \begin_inset Flex Code
5732 \begin_layout Plain Layout
5739 \begin_inset Flex Noun
5742 \begin_layout Plain Layout
5748 keys, a spare function key, etc.
5749 As for the \SpecialChar LyX
5750 commands that produce accents, check the entry for
5751 \begin_inset Flex Code
5754 \begin_layout Plain Layout
5765 You'll find the complete list there.
5768 \begin_layout Subsection
5769 Saving your Language Configuration
5772 \begin_layout Standard
5773 You can edit your preferences so that your desired language environment
5774 is automatically configured when \SpecialChar LyX
5776 \begin_inset Flex Noun
5779 \begin_layout Plain Layout
5780 Edit\SpecialChar menuseparator
5789 \begin_layout Chapter
5790 Installing New Document Classes, Layouts, and Templates
5791 \begin_inset CommandInset label
5793 name "cha:Installing-New-Document"
5798 \begin_inset Argument 1
5801 \begin_layout Plain Layout
5802 Installing New Document Classes
5810 \begin_layout Standard
5811 In this chapter, we describe the procedures for creating and installing
5812 new \SpecialChar LyX
5813 layout and template files, as well as offer a refresher on correctly
5814 installing new \SpecialChar LaTeX
5819 \begin_layout Standard
5820 First, let us a say a few words about how one ought to think about the relation
5821 between \SpecialChar LyX
5822 and \SpecialChar LaTeX
5824 The thing to understand is that, in a certain sense, \SpecialChar LyX
5825 doesn't know anything
5826 about \SpecialChar LaTeX
5828 Indeed, from \SpecialChar LyX
5829 's point of view, \SpecialChar LaTeX
5830 is just one of several
5831 \begin_inset Quotes eld
5835 \begin_inset Quotes erd
5838 in which it is capable of producing output.
5839 Other such formats are DocBook, plaintext, and XHTML.
5841 is, of course, a particularly important format, but very little of the
5842 information \SpecialChar LyX
5843 has about \SpecialChar LaTeX
5844 is actually contained in the program itself.
5848 \begin_layout Plain Layout
5849 Some commands are sufficiently complex that they are
5850 \begin_inset Quotes eld
5854 \begin_inset Quotes erd
5857 into \SpecialChar LyX
5859 But the developers generally regard this as a Bad Thing.
5864 Rather, that information, even for the standard classes like
5865 \begin_inset Flex Code
5868 \begin_layout Plain Layout
5874 , is contained in `layout files'.
5875 Similarly, \SpecialChar LyX
5876 itself does not know much about DocBook or XHTML.
5877 What it knows is contained in layout files.
5880 \begin_layout Standard
5881 You can think of the layout file for a given document class as a translation
5882 manual between \SpecialChar LyX
5883 constructs—paragraphs with their corresponding styles,
5884 certain sorts of insets, etc—and the corresponding \SpecialChar LaTeX
5887 Almost everything \SpecialChar LyX
5889 \begin_inset Flex Code
5892 \begin_layout Plain Layout
5898 , for example, is contained in the file
5899 \begin_inset Flex Code
5902 \begin_layout Plain Layout
5908 and in various other files it includes.
5909 For this reason, anyone intending to write layout files should plan to
5910 study the existing files.
5911 A good place to start is with
5912 \begin_inset Flex Code
5915 \begin_layout Plain Layout
5921 , which is included in
5922 \begin_inset Flex Code
5925 \begin_layout Plain Layout
5932 \begin_inset Flex Code
5935 \begin_layout Plain Layout
5941 , and many of the other layout files for document classes.
5942 This file is where sections and the like are defined:
5943 \begin_inset Flex Code
5946 \begin_layout Plain Layout
5952 tells \SpecialChar LyX
5953 how paragraphs that are marked with the Section, Subsection, etc,
5954 styles can be translated into corresponding \SpecialChar LaTeX
5955 , DocBook, and XHTML commands
5958 \begin_inset Flex Code
5961 \begin_layout Plain Layout
5967 file basically just includes several of these
5968 \begin_inset Flex Code
5971 \begin_layout Plain Layout
5980 \begin_layout Standard
5981 Defining the \SpecialChar LyX
5983 correspondence is not the only thing layout files do, though.
5984 Their other job is to define how the \SpecialChar LyX
5985 constructs themselves will appear
5987 The fact that layout files have these two jobs is often a source of confusion,
5988 because they are completely separate.
5989 Telling \SpecialChar LyX
5990 how to translate a certain paragraph style into \SpecialChar LaTeX
5993 how to display it; conversely, telling \SpecialChar LyX
5994 how to display a certain paragraph
5995 style does not tell \SpecialChar LyX
5996 how to translate it into \SpecialChar LaTeX
5997 (let alone tell \SpecialChar LaTeX
6000 So, in general, when you define a new \SpecialChar LyX
6001 construct, you must always do two
6002 quite separate things: (i)
6003 \begin_inset space ~
6006 tell \SpecialChar LyX
6007 how to translate it into \SpecialChar LaTeX
6009 \begin_inset space ~
6012 tell \SpecialChar LyX
6016 \begin_layout Standard
6017 Much the same is true, of course, as regards \SpecialChar LyX
6018 's other backend formats, though
6019 XHTML is in some ways different, because in that case \SpecialChar LyX
6024 able, to some extent, to use information about how it should display a
6025 paragraph on the screen to output information (in the form of CSS) about
6026 how the paragraph should be displayed in a browser.
6027 Even in this case, however, the distinction between what \SpecialChar LyX
6029 and how things are rendered externally remains in force, and the two can
6030 be controlled separately.
6032 \begin_inset CommandInset ref
6034 reference "sec:Tags-for-XHTML"
6041 \begin_layout Section
6042 Installing new \SpecialChar LaTeX
6046 \begin_layout Standard
6047 Some installations may not include a \SpecialChar LaTeX
6048 package or class file that you would
6049 like to use within \SpecialChar LyX
6051 For example, you might need Foil\SpecialChar TeX
6052 , a package for preparing slides for overhead
6054 Modern \SpecialChar LaTeX
6055 distributions like \SpecialChar TeX
6056 Live (2008 or newer) or MiK\SpecialChar TeX
6057 provide a user interface
6058 for installing such packages.
6059 For example, with MiK\SpecialChar TeX
6060 , you start the program
6061 \begin_inset Quotes eld
6065 \begin_inset space ~
6069 \begin_inset Quotes erd
6072 to get a list of available packages.
6073 To install one of them, right click on it or use the corresponding toolbar
6077 \begin_layout Standard
6078 If your \SpecialChar LaTeX
6079 distribution does not provide such a `package manager', or if the
6080 package is not available from your distribution, then follow these steps
6081 to install it manually:
6084 \begin_layout Enumerate
6085 Get the package from
6086 \begin_inset CommandInset href
6089 target "http://www.ctan.org/"
6097 \begin_layout Enumerate
6098 If the package contains a file with the ending
6099 \begin_inset Quotes eld
6103 \begin_inset Flex Code
6106 \begin_layout Plain Layout
6113 \begin_inset Quotes erd
6116 (is the case for Foil\SpecialChar TeX
6117 ) then open a console, change to the folder of this
6118 file and execute the command
6119 \begin_inset Flex Code
6122 \begin_layout Plain Layout
6129 You have now unpacked the package and have all files to install it.
6130 Most \SpecialChar LaTeX
6131 -packages are not packed and you can skip this step.
6134 \begin_layout Enumerate
6135 Now you need to decide if the package should be available for all users
6140 \begin_layout Enumerate
6141 On *nix systems (Linux, OSX, etc.), if you want the new package to be available
6142 for all users on your system, then install it in your `local' \SpecialChar TeX
6144 install it in your own `user' \SpecialChar TeX
6146 Where these trees should be created, if they do not already exist, depends
6148 To find this out, look in the file
6149 \begin_inset Flex Code
6152 \begin_layout Plain Layout
6162 \begin_layout Plain Layout
6163 This is usually in the directory
6164 \begin_inset Flex Code
6167 \begin_layout Plain Layout
6173 , though you can execute the command
6174 \begin_inset Flex Code
6177 \begin_layout Plain Layout
6188 The location of the `local' \SpecialChar TeX
6189 tree is defined by the
6190 \begin_inset Flex Code
6193 \begin_layout Plain Layout
6199 variable; this is usually somewhere like
6200 \begin_inset Flex Code
6203 \begin_layout Plain Layout
6204 /usr/local/share/texmf
6209 or /usr/local/texlive/XXXX where XXXX is the year of the installed \SpecialChar TeX
6212 The location of the `user' \SpecialChar TeX
6214 \begin_inset Flex Code
6217 \begin_layout Plain Layout
6224 \begin_inset Flex Code
6227 \begin_layout Plain Layout
6234 \begin_inset Flex Code
6237 \begin_layout Plain Layout
6247 (If these variables are not predefined, you have to define them.) You'll
6248 probably need root permissions to create or modify the `local' tree, but
6249 not for your `user' tree.
6250 \begin_inset Newline newline
6253 In general, it is recommended to install in the user tree because your user
6254 will not be modified or even overwritten when you upgrade your system.
6255 It will typically also be backed up together with everything else when
6256 you backup your home directory (which, of course, you do on a regular basis).
6259 \begin_layout Enumerate
6260 On Windows, if you want the new package to be available for all users on
6261 your system, change to the folder where \SpecialChar LaTeX
6262 is installed and then change to
6264 \begin_inset Flex Code
6267 \begin_layout Plain Layout
6278 (For MiK\SpecialChar TeX
6279 , this would be by default the folder
6280 \begin_inset Flex Code
6283 \begin_layout Plain Layout
6301 \begin_layout Plain Layout
6302 Note that this will be the correct path only on English installations.
6303 On a German one, it would be
6304 \begin_inset Flex Code
6307 \begin_layout Plain Layout
6321 , and similarly for other languages.
6326 Create there a new folder
6327 \begin_inset Flex Code
6330 \begin_layout Plain Layout
6336 and copy all files of the package into it.
6338 \begin_inset Newline newline
6341 If the package should only available for you or you don't have admin permissions
6342 , do the same, but in the local \SpecialChar LaTeX
6345 \begin_inset space \thinspace{}
6348 g., for MiK\SpecialChar TeX
6350 \begin_inset space ~
6353 2.8 under Windows XP, this would be the folder:
6354 \begin_inset Newline newline
6360 \begin_inset Flex Code
6363 \begin_layout Plain Layout
6366 Documents and Settings
6378 \begin_inset Newline newline
6384 \begin_inset Phantom HPhantom
6387 \begin_layout Plain Layout
6398 \begin_inset Flex Code
6401 \begin_layout Plain Layout
6414 \begin_inset Newline newline
6417 On Vista, it would be:
6418 \begin_inset Newline newline
6422 \begin_inset Flex Code
6425 \begin_layout Plain Layout
6451 \begin_layout Enumerate
6452 Now one only need to tell \SpecialChar LaTeX
6453 that there are new files.
6454 This depends on the used \SpecialChar LaTeX
6459 \begin_layout Enumerate
6460 For \SpecialChar TeX
6461 Live execute the command
6462 \begin_inset Flex Code
6465 \begin_layout Plain Layout
6472 If you installed the package for all users, then you will probably need
6473 to have root permissions for that.
6476 \begin_layout Enumerate
6477 For MiK\SpecialChar TeX
6478 , if you have installed the package for all users, start the program
6480 \begin_inset Quotes eld
6484 \begin_inset space ~
6488 \begin_inset Quotes erd
6491 and press the button marked
6492 \begin_inset Quotes eld
6496 \begin_inset Quotes erd
6500 Otherwise start the program
6501 \begin_inset Quotes eld
6505 \begin_inset Quotes erd
6512 \begin_layout Enumerate
6513 Finally, you need to tell \SpecialChar LyX
6514 that there are new packages available.
6515 So, in \SpecialChar LyX
6517 \begin_inset Flex Noun
6520 \begin_layout Plain Layout
6523 \SpecialChar menuseparator
6529 and then restart \SpecialChar LyX
6533 \begin_layout Standard
6534 Now the package is installed.
6535 In our example, the document class
6536 \begin_inset Flex Code
6539 \begin_layout Plain Layout
6541 \begin_inset space ~
6549 will now be available under
6550 \begin_inset Flex Noun
6553 \begin_layout Plain Layout
6554 Document\SpecialChar menuseparator
6555 Settings\SpecialChar menuseparator
6565 \begin_layout Standard
6566 If you would like to use a \SpecialChar LaTeX
6567 document class that is not even listed in the
6569 \begin_inset Flex Noun
6572 \begin_layout Plain Layout
6573 Document\SpecialChar menuseparator
6574 Settings\SpecialChar menuseparator
6580 , then you need to create a `layout' file for it.
6581 That is the topic of the next section.
6584 \begin_layout Section
6585 Types of layout files
6588 \begin_layout Standard
6589 This section describes the various sorts of \SpecialChar LyX
6590 files that contain layout informati
6592 These files describe various paragraph and character styles, determining
6593 how \SpecialChar LyX
6594 should display them and how they should be translated into \SpecialChar LaTeX
6596 XHTML, or whatever output format is being used.
6600 \begin_layout Standard
6601 We shall try to provide a thorough description of the process of writing
6603 However, there are so many different types of documents supported even
6604 by just \SpecialChar LaTeX
6605 that we can't hope to cover every different possibility or problem
6606 you might encounter.
6607 The \SpecialChar LyX
6608 users' list is frequented by people with lots of experience with layout
6609 design who are willing to share what they've learned, so please feel free
6610 to ask questions there.
6613 \begin_layout Standard
6614 As you prepare to write a new layout, it is extremely helpful to look at
6615 the layouts distributed with \SpecialChar LyX
6617 If you write a \SpecialChar LyX
6618 layout for a \SpecialChar LaTeX
6619 document class that might also be used by
6620 others, or write a module that might be useful to others, then you should
6621 consider posting your layout to the
6622 \begin_inset CommandInset href
6624 name "layout section on the LyX wiki"
6625 target "http://wiki.lyx.org/Layouts/Layouts"
6630 or even to the \SpecialChar LyX
6631 developers' list, so that it might be included in \SpecialChar LyX
6636 \begin_layout Plain Layout
6637 Note that \SpecialChar LyX
6638 is licensed under the General Public License, so any material
6639 that is contributed to \SpecialChar LyX
6640 must be similarly licensed.
6648 \begin_layout Subsection
6650 \begin_inset CommandInset label
6652 name "subsec:Layout-modules"
6659 \begin_layout Standard
6660 We have spoken to this point about `layout files'.
6661 But there are different sorts of files that contain layout information.
6662 Layout files, strictly so called, have the
6663 \begin_inset Flex Code
6666 \begin_layout Plain Layout
6672 extension and provide \SpecialChar LyX
6673 with information about document classes.
6674 Since \SpecialChar LyX
6675 1.6 layout information can also be contained in layout
6680 \begin_inset Flex Code
6683 \begin_layout Plain Layout
6690 Modules are to \SpecialChar LaTeX
6691 packages much as layouts are to \SpecialChar LaTeX
6692 classes, and some modules—such
6694 \begin_inset Flex Code
6697 \begin_layout Plain Layout
6703 module—specifically provide support for one package.
6704 In a sense, layout modules are similar to included
6708 \begin_layout Plain Layout
6709 These can have any extension, but by convention have the
6710 \begin_inset Flex Code
6713 \begin_layout Plain Layout
6725 \begin_inset Flex Code
6728 \begin_layout Plain Layout
6734 —in that modules are not specific to a given document class but may be used
6735 with many different classes.
6736 The difference is that using an included file with
6737 \begin_inset Flex Code
6740 \begin_layout Plain Layout
6746 requires editing that file.
6747 Modules, by contrast, are selected in the
6748 \begin_inset Flex Noun
6751 \begin_layout Plain Layout
6752 Document\SpecialChar menuseparator
6761 \begin_layout Standard
6762 Building modules is the easiest way to get started with layout editing,
6763 since it can be as simple as adding a single new paragraph style or flex
6765 But modules may, in principle, contain anything a layout file can contain.
6768 \begin_layout Standard
6769 After creating a new module and copying it to the
6770 \begin_inset Flex Code
6773 \begin_layout Plain Layout
6779 folder, you will need to reconfigure and then restart \SpecialChar LyX
6782 However, changes you make to the module will be seen immediately, if you
6784 \begin_inset Flex Noun
6787 \begin_layout Plain Layout
6788 Document\SpecialChar menuseparator
6794 , highlight something, and then hit
6795 \begin_inset Quotes eld
6799 \begin_inset Quotes erd
6805 It is strongly recommended that you save your work before doing this
6810 it is strongly recommended that you not attempt to edit modules while simultaneo
6811 usly working on actual documents
6814 Though of course the developers strive to keep \SpecialChar LyX
6815 stable in such situations,
6816 syntax errors and the like in your module file could cause strange behavior.
6819 \begin_layout Subsubsection
6823 \begin_layout Standard
6824 Modules are to \SpecialChar LyX
6825 as packages are to \SpecialChar LaTeX
6827 Sometimes, however, you find yourself wanting a specific inset or character
6828 style just for one document and writing a module that will also be available
6829 to other documents makes little sense.
6830 What you need is \SpecialChar LyX
6832 \begin_inset Quotes eld
6836 \begin_inset Quotes erd
6842 \begin_layout Standard
6843 You will find it under
6845 Document\SpecialChar menuseparator
6846 Settings\SpecialChar menuseparator
6850 The large text box allows you to enter anything that you might enter in
6851 a layout file or module.
6852 You can think of a document's local layout, in fact, as a module that belongs
6854 So, in particular, you must enter a
6855 \begin_inset Flex Code
6858 \begin_layout Plain Layout
6865 Any format is acceptable, but one would normally use the format current
6867 (In \SpecialChar LyX
6868 2.2, the current layout format is 60.)
6871 \begin_layout Standard
6872 When you have entered something in the
6873 \begin_inset Flex Code
6876 \begin_layout Plain Layout
6882 pane, \SpecialChar LyX
6884 \begin_inset Quotes eld
6888 \begin_inset Quotes erd
6891 button at the bottom.
6892 Clicking this button will cause \SpecialChar LyX
6893 to determine whether what you have entered
6894 is valid layout information for the chosen format.
6896 will report the result but, unfortunately, will not tell you what errors
6897 there might have been.
6898 These will be written to the terminal, however, if \SpecialChar LyX
6899 is started from a terminal.
6900 You will not be permitted to save your local layout until you have entered
6904 \begin_layout Standard
6905 The warnings at the end of the previous section apply here, too.
6906 Do not play with local layout while you are actually working, especially
6907 if you have not saved your document.
6908 That said, using local layout with a test document can be a very convenient
6909 way to try out layout ideas, or even to start developing a module.
6912 \begin_layout Subsection
6914 \begin_inset Flex Noun
6917 \begin_layout Plain Layout
6926 \begin_layout Standard
6927 There are two situations you are likely to encounter when wanting to support
6928 a new \SpecialChar LaTeX
6929 document class, involving style (
6930 \begin_inset Flex Code
6933 \begin_layout Plain Layout
6939 ) files and \SpecialChar LaTeX2e
6941 \begin_inset Flex Code
6944 \begin_layout Plain Layout
6951 Supporting a style file is usually fairly easy.
6952 Supporting a new class file is a bit harder.
6953 We'll discuss the former in this section and the latter in the next.
6954 Similar remarks apply, of course, if you want to support a new DocBook
6958 \begin_layout Standard
6959 The easier case is the one in which your new document class is provided
6960 as a style file that is to be used in conjunction with an already supported
6962 For the sake of the example, we'll assume that the style file is called
6964 \begin_inset Flex Noun
6967 \begin_layout Plain Layout
6973 and that it is meant to be used with
6974 \begin_inset Flex Noun
6977 \begin_layout Plain Layout
6983 , which is a standard class.
6987 \begin_layout Standard
6988 Start by copying the existing class's layout file into your local directory:
6992 \begin_layout Plain Layout
6993 Of course, which directory is your local directory will vary by platform,
6994 and \SpecialChar LyX
6995 allows you to specify your local directory on startup, too, using
6997 \begin_inset Flex Code
7000 \begin_layout Plain Layout
7014 \begin_layout LyX-Code
7015 cp report.layout ~/.lyx/layouts/myclass.layout
7018 \begin_layout Standard
7020 \begin_inset Flex Code
7023 \begin_layout Plain Layout
7029 and change the line:
7032 \begin_layout LyX-Code
7035 DeclareLaTeXClass{report}
7038 \begin_layout Standard
7042 \begin_layout LyX-Code
7045 DeclareLaTeXClass[report, myclass.sty]{report (myclass)}
7048 \begin_layout Standard
7052 \begin_layout LyX-Code
7054 \begin_inset Newline newline
7060 \begin_inset Newline newline
7066 \begin_layout Standard
7067 near the top of the file.
7070 \begin_layout Standard
7071 Start \SpecialChar LyX
7073 \begin_inset Flex Noun
7076 \begin_layout Plain Layout
7077 Tools\SpecialChar menuseparator
7084 Then restart \SpecialChar LyX
7085 and try creating a new document.
7087 \begin_inset Flex Noun
7090 \begin_layout Plain Layout
7096 " as a document class option in the
7097 \begin_inset Flex Noun
7100 \begin_layout Plain Layout
7101 Document\SpecialChar menuseparator
7108 It is likely that some of the sectioning commands and such in your new
7109 class will work differently from how they worked in the base class—
7110 \begin_inset Flex Code
7113 \begin_layout Plain Layout
7119 in this example—so you can fiddle around with the settings for the different
7120 sections if you wish.
7121 The layout information for sections is contained in
7122 \begin_inset Flex Code
7125 \begin_layout Plain Layout
7131 , but you do not need to copy and change this file.
7132 Instead, you can simply add your changes to your layout file, after the
7134 \begin_inset Flex Code
7137 \begin_layout Plain Layout
7143 , which itself includes
7144 \begin_inset Flex Code
7147 \begin_layout Plain Layout
7154 For example, you might add these lines:
7157 \begin_layout LyX-Code
7161 \begin_layout LyX-Code
7165 \begin_layout LyX-Code
7169 \begin_layout LyX-Code
7173 \begin_layout LyX-Code
7177 \begin_layout Standard
7178 to change the font for chapter headings to sans-serif.
7179 This will override (or, in this case, add to) the existing declaration
7180 for the Chapter style.
7184 \begin_layout Standard
7185 Your new package may also provide commands or environments not present in
7187 In this case, you will want to add these to the layout file.
7189 \begin_inset CommandInset ref
7191 reference "sec:TextClass"
7195 for information on how to do so.
7198 \begin_layout Standard
7200 \begin_inset Flex Noun
7203 \begin_layout Plain Layout
7209 can be used with several different document classes, and even if it cannot,
7210 you might find it easiest just to write a module that you can load with
7212 The simplest possible such module would be:
7215 \begin_layout LyX-Code
7218 DeclareLyXModule{My Package}
7221 \begin_layout LyX-Code
7225 \begin_layout LyX-Code
7226 #Support for mypkg.sty.
7229 \begin_layout LyX-Code
7231 \begin_inset Newline newline
7237 \begin_layout LyX-Code
7239 \begin_inset Newline newline
7245 \begin_layout LyX-Code
7247 \begin_inset Newline newline
7253 \begin_inset Newline newline
7259 \begin_layout Standard
7260 A more complex module might modify the behavior of some existing constructs
7261 or define some new ones.
7263 \begin_inset CommandInset ref
7265 reference "sec:TextClass"
7272 \begin_layout Subsection
7274 \begin_inset Flex Noun
7277 \begin_layout Plain Layout
7286 \begin_layout Standard
7287 There are two possibilities here.
7288 One is that the class file is itself based upon an existing document class.
7289 For example, many thesis classes are based upon
7290 \begin_inset Flex Noun
7293 \begin_layout Plain Layout
7300 To see whether yours is, look for a line like
7303 \begin_layout LyX-Code
7309 \begin_layout Standard
7311 If so, then you may proceed largely as in the previous section, though
7313 \begin_inset Flex Code
7316 \begin_layout Plain Layout
7317 Declare\SpecialChar LaTeX
7323 line will be different.
7324 If your new class is
7325 \begin_inset Flex Code
7328 \begin_layout Plain Layout
7334 and it is based upon
7335 \begin_inset Flex Code
7338 \begin_layout Plain Layout
7344 , then the line should read:
7348 \begin_layout Plain Layout
7349 And it will be easiest if you save the file to
7350 \begin_inset Flex Code
7353 \begin_layout Plain Layout
7360 assumes that the document class has the same name as the layout file.
7369 \begin_layout LyX-Code
7372 DeclareLaTeXClass[thesis,book]{thesis}
7375 \begin_layout Standard
7376 If, on the other hand, the new class is not based upon an existing class,
7377 you will probably have to
7378 \begin_inset Quotes eld
7382 \begin_inset Quotes erd
7386 We strongly suggest copying an existing layout file which uses a similar
7388 class and then modifying it, if you can do so.
7389 At least use an existing file as a starting point so you can find out what
7390 items you need to worry about.
7391 Again, the specifics are covered below.
7394 \begin_layout Subsection
7396 \begin_inset CommandInset label
7398 name "subsec:Creating-Templates"
7405 \begin_layout Standard
7406 Once you have written a layout file for a new document class, you might
7407 want to consider writing a
7412 A template acts as a kind of tutorial for your layout, showing how it might
7413 be used, though containing dummy content.
7414 You can of course look at the various templates included with \SpecialChar LyX
7418 \begin_layout Standard
7419 Templates are created just like usual documents: using \SpecialChar LyX
7421 The only difference is that usual documents contain all possible settings,
7422 including the font scheme and the paper size.
7423 Usually a user doesn't want a template to overwrite his preferred settings
7424 for such parameters.
7425 For that reason, the designer of a template should remove the corresponding
7427 \begin_inset Flex Code
7430 \begin_layout Plain Layout
7439 \begin_inset Flex Code
7442 \begin_layout Plain Layout
7450 from the template \SpecialChar LyX
7452 This can be done with any simple text-editor, for example
7453 \begin_inset Flex Code
7456 \begin_layout Plain Layout
7463 \begin_inset Flex Code
7466 \begin_layout Plain Layout
7475 \begin_layout Standard
7476 Put the edited template files you create in
7477 \begin_inset Flex Code
7480 \begin_layout Plain Layout
7486 , copy the ones you use from the global template directory in
7487 \begin_inset Flex Code
7490 \begin_layout Plain Layout
7496 to the same place, and redefine the template path in the
7497 \begin_inset Flex Noun
7500 \begin_layout Plain Layout
7501 Tools\SpecialChar menuseparator
7502 Preferences\SpecialChar menuseparator
7511 \begin_layout Standard
7512 Note, by the way, that there is a template which has a particular meaning:
7514 \begin_inset Flex Code
7517 \begin_layout Plain Layout
7524 This template is loaded every time you create a new document with
7525 \begin_inset Flex Noun
7528 \begin_layout Plain Layout
7529 File\SpecialChar menuseparator
7535 in order to provide useful defaults.
7536 To create this template from inside \SpecialChar LyX
7537 , all you have to do is to open a document
7538 with the correct settings, and use the
7539 \begin_inset Flex Noun
7542 \begin_layout Plain Layout
7543 Save as Document Defaults
7551 \begin_layout Subsection
7552 Upgrading old layout files
7555 \begin_layout Standard
7556 The format of layout files changes with each \SpecialChar LyX
7557 release, so old layout files
7558 need to be converted to the new format.
7560 reads a layout file in an older format, it automatically calls the
7562 \begin_inset Flex Code
7565 \begin_layout Plain Layout
7571 to convert it to a temporary file in current format.
7572 The original file is left untouched.
7573 If you use the layout file often, then, you may want to convert it permanently,
7574 so that \SpecialChar LyX
7575 does not have to do so itself every time.
7576 To do this, you can call the converter manually:
7579 \begin_layout Enumerate
7581 \begin_inset Flex Code
7584 \begin_layout Plain Layout
7591 \begin_inset Flex Code
7594 \begin_layout Plain Layout
7603 \begin_layout Enumerate
7605 \begin_inset Newline newline
7609 \begin_inset Flex Code
7612 \begin_layout Plain Layout
7613 python LyXDir/scripts/layout2layout.py myclass.old myclass.layout
7619 \begin_inset Newline newline
7623 \begin_inset Flex Code
7626 \begin_layout Plain Layout
7632 is the name of your \SpecialChar LyX
7636 \begin_layout Standard
7637 Note that manual conversion does not affect included files, so these will
7638 have to be converted separately.
7639 \change_inserted -712698321 1483873435
7643 \begin_layout Subsection
7645 \change_inserted -712698321 1483875083
7646 \begin_inset CommandInset label
7648 name "subsec:Cite-Engine-Files"
7655 \begin_layout Standard
7657 \change_inserted -712698321 1483874213
7658 A specific form of layout files are the so-called
7659 \begin_inset Flex Code
7662 \begin_layout Plain Layout
7664 \change_inserted -712698321 1483873546
7670 files that are located in the
7671 \begin_inset Flex Code
7674 \begin_layout Plain Layout
7676 \change_inserted -712698321 1483873546
7683 Their purpose is to define the specifics of \SpecialChar LaTeX
7684 packages aimed at bibliography
7697 , but also the way how normal Bib\SpecialChar TeX
7698 citations (without additional packages)
7699 are handled in \SpecialChar LyX
7700 is defined in such a file.
7704 \begin_layout Standard
7706 \change_inserted -712698321 1483874969
7707 More specifically, it is defined which packages \SpecialChar LyX
7708 needs to load, which citation
7709 commands are available, how these are to be displayed in \SpecialChar LyX
7711 the dialogs, the context menus) as well as in the XHTML and plain text
7713 Furthermore, the files specify available style variants (author-year, numerical
7714 , etc.) and their specifics.
7715 The cite engine files are also used to generate the options that are available
7718 Document\SpecialChar menuseparator
7719 Settings\SpecialChar ldots
7720 \SpecialChar menuseparator
7721 Bibliography\SpecialChar menuseparator
7727 \begin_layout Standard
7729 \change_inserted -712698321 1483875180
7730 Even though a cite engine file is essentially a normal layout file that
7731 could theoretically include any layout information, it usually primarily
7732 includes some specific parameters such as
7733 \begin_inset Flex Code
7736 \begin_layout Plain Layout
7738 \change_inserted -712698321 1483874688
7747 \begin_inset Flex Code
7750 \begin_layout Plain Layout
7752 \change_inserted -712698321 1483875180
7761 \begin_inset Flex Code
7764 \begin_layout Plain Layout
7766 \change_inserted -712698321 1483874477
7775 \begin_inset Flex Code
7778 \begin_layout Plain Layout
7780 \change_inserted -712698321 1483874482
7789 The syntax of the latter two is described in
7790 \begin_inset CommandInset ref
7792 reference "subsec:Citation-engine-description"
7800 \begin_inset CommandInset ref
7802 reference "subsec:Citation-format-description"
7806 , as well as in the files themselves.
7811 \begin_layout Section
7812 \begin_inset CommandInset label
7814 name "sec:TextClass"
7818 The layout file format
7821 \begin_layout Standard
7822 The following sections describe how layout files are structured and written.
7823 Our advice is to go slowly, save and test often.
7824 It is really not that hard, except that the multitude of options can become
7825 overwhelming, especially if you try to check out too many at once.
7826 It becomes easier if you use existing layouts of \SpecialChar LyX
7827 as examples/reference
7828 or if you modify an existing layout to your needs.
7831 \begin_layout Standard
7832 Note that all the tags used in layout files are case-insensitive.
7834 \begin_inset Flex Code
7837 \begin_layout Plain Layout
7844 \begin_inset Flex Code
7847 \begin_layout Plain Layout
7854 \begin_inset Flex Code
7857 \begin_layout Plain Layout
7863 are really the same tag.
7864 The possible arguments are printed in brackets after the tag's name.
7865 The default argument is typeset
7866 \begin_inset Flex Code
7869 \begin_layout Plain Layout
7878 If the argument has a data type like
7879 \begin_inset Quotes eld
7883 \begin_inset Quotes erd
7887 \begin_inset Quotes eld
7891 \begin_inset Quotes erd
7894 , the default is shown like this:
7895 \begin_inset Flex Code
7898 \begin_layout Plain Layout
7909 \begin_layout Subsection
7910 The document class declaration and classification
7913 \begin_layout Standard
7914 Lines in a layout file which begin with
7915 \begin_inset Flex Code
7918 \begin_layout Plain Layout
7925 There is one exception to this rule.
7927 \begin_inset Flex Code
7930 \begin_layout Plain Layout
7936 files should begin with lines like:
7939 \begin_layout LyX-Code
7942 #% Do not delete the line below; configure depends on this
7945 \begin_layout LyX-Code
7950 DeclareLaTeXClass{Article (Standard Class)}
7953 \begin_layout LyX-Code
7958 DeclareCategory{Articles}
7961 \begin_layout Standard
7962 The second and third lines are used when you (re)configure \SpecialChar LyX
7964 The layout file is read by the \SpecialChar LaTeX
7966 \begin_inset Flex Code
7969 \begin_layout Plain Layout
7975 , in a special mode where
7976 \begin_inset Flex Code
7979 \begin_layout Plain Layout
7986 The first line is just a \SpecialChar LaTeX
7987 comment, the second one contains the mandatory
7988 declaration of the text class and the third line contains the optional
7989 classification of the class.
7990 If these lines appear in a file named
7991 \begin_inset Flex Code
7994 \begin_layout Plain Layout
8000 , then they define a text class of name
8001 \begin_inset Flex Code
8004 \begin_layout Plain Layout
8010 (the name of the layout file) which uses the \SpecialChar LaTeX
8012 \begin_inset Flex Code
8015 \begin_layout Plain Layout
8021 (the default is to use the same name as the layout).
8023 \begin_inset Quotes eld
8026 Article (Standard Class)
8027 \begin_inset Quotes erd
8030 that appears above is used as a description of the text class in the
8031 \begin_inset Flex Noun
8034 \begin_layout Plain Layout
8035 Document\SpecialChar menuseparator
8043 \begin_inset Quotes eld
8047 \begin_inset Quotes erd
8050 in the example) is also used in the
8051 \begin_inset Flex Noun
8054 \begin_layout Plain Layout
8055 Document\SpecialChar menuseparator
8061 dialog: the text classes are grouped by these categories (which are usually
8062 genres, so typical categories are
8063 \begin_inset Quotes eld
8067 \begin_inset Quotes erd
8071 \begin_inset Quotes eld
8075 \begin_inset Quotes erd
8079 \begin_inset Quotes eld
8083 \begin_inset Quotes erd
8087 \begin_inset Quotes eld
8091 \begin_inset Quotes erd
8095 \begin_inset Quotes eld
8099 \begin_inset Quotes erd
8103 \begin_inset Quotes eld
8107 \begin_inset Quotes erd
8111 If no category has been declared, the class will be put in the
8112 \begin_inset Quotes eld
8116 \begin_inset Quotes erd
8122 \begin_layout Standard
8123 Let's assume that you wrote your own text class that uses the
8124 \begin_inset Flex Code
8127 \begin_layout Plain Layout
8133 document class, but where you changed the appearance of the section headings.
8134 If you put it in a file
8135 \begin_inset Flex Code
8138 \begin_layout Plain Layout
8144 , the header of this file should be:
8147 \begin_layout LyX-Code
8150 #% Do not delete the line below; configure depends on this
8153 \begin_layout LyX-Code
8158 DeclareLaTeXClass[article]{Article (with My Own Headings)}
8161 \begin_layout LyX-Code
8166 DeclareCategory{Articles}
8169 \begin_layout Standard
8170 This declares a text class
8171 \begin_inset Flex Code
8174 \begin_layout Plain Layout
8180 , associated with the \SpecialChar LaTeX
8182 \begin_inset Flex Code
8185 \begin_layout Plain Layout
8192 \begin_inset Quotes eld
8195 Article (with My Own Headings)
8196 \begin_inset Quotes erd
8200 If your text class depends on several packages, you can declare it as:
8203 \begin_layout LyX-Code
8206 #% Do not delete the line below; configure depends on this
8209 \begin_layout LyX-Code
8214 DeclareLaTeXClass[article,foo.sty]{Article (with My Own Headings)}
8217 \begin_layout LyX-Code
8222 DeclareCategory{Articles}
8225 \begin_layout Standard
8226 This indicates that your text class uses the
8227 \begin_inset Flex Code
8230 \begin_layout Plain Layout
8237 Finally, it is also possible to declare classes for DocBook code.
8238 Typical declarations will look like:
8241 \begin_layout LyX-Code
8244 #% Do not delete the line below; configure depends on this
8247 \begin_layout LyX-Code
8252 DeclareDocBookClass[article]{SGML (DocBook Article)}
8255 \begin_layout LyX-Code
8260 DeclareCategory{Articles (DocBook)}
8263 \begin_layout Standard
8264 Note that these declarations can also be given an optional parameter declaring
8265 the name of the document class (but not a list).
8268 \begin_layout Standard
8269 So, to be as explicit as possible, the form of the layout declaration is:
8272 \begin_layout LyX-Code
8277 DeclareLaTeXClass[class,package.sty]{layout description}
8280 \begin_layout LyX-Code
8285 DeclareCategory{category}
8288 \begin_layout Standard
8289 The class need only be specified if the name of the \SpecialChar LaTeX
8291 name of the layout file are different or if there are packages to load.
8292 If the name of the class file is not specified, then \SpecialChar LyX
8294 that it is the same as the name of the layout file.
8297 \begin_layout Standard
8298 When the text class has been modified to your taste, all you have to do
8299 is to copy it either to
8300 \begin_inset Flex Code
8303 \begin_layout Plain Layout
8310 \begin_inset Flex Code
8313 \begin_layout Plain Layout
8320 \begin_inset Flex Noun
8323 \begin_layout Plain Layout
8324 Tools\SpecialChar menuseparator
8330 , exit \SpecialChar LyX
8332 Then your new text class should be available along with the others.
8335 \begin_layout Standard
8336 Once the layout file is installed, you can edit it and see your changes
8337 without having to reconfigure or to restart \SpecialChar LyX
8343 \begin_layout Plain Layout
8344 In versions of \SpecialChar LyX
8345 prior to 1.6, this was not true.
8346 As a result, editing layout files was very time consuming, since you had
8347 constantly to restart \SpecialChar LyX
8353 You can force a reload of the current layout by using the \SpecialChar LyX
8355 \begin_inset Flex Noun
8358 \begin_layout Plain Layout
8365 There is no default binding for this function—though, of course, you can
8366 bind it to a key yourself.
8367 But you will normally use this function simply by entering it in the mini-buffe
8372 \begin_layout Standard
8378 \begin_inset Flex Noun
8381 \begin_layout Plain Layout
8387 is very much an `advanced feature'.
8392 recommended that you save your work before using this function.
8397 recommended that you not attempt to edit layout information while simultaneousl
8398 y working on a document that you care about.
8399 Use a test document.
8400 Syntax errors and the like in your layout file could cause peculiar behavior.
8401 In particular, such errors could cause \SpecialChar LyX
8402 to regard the current layout as
8403 invalid and to attempt to switch to some other layout.
8407 \begin_layout Plain Layout
8408 Really bad syntax errors may even caused \SpecialChar LyX
8410 This is because certain sorts of errors may make \SpecialChar LyX
8421 The \SpecialChar LyX
8422 team strives to keep \SpecialChar LyX
8423 stable in such situations, but safe is better
8428 \begin_layout Plain Layout
8429 While we're giving advice: make regular backups.
8430 And be nice to your mother.
8438 \begin_layout Subsection
8439 The Module declaration
8442 \begin_layout Standard
8443 A module must begin with a line like the following:
8446 \begin_layout LyX-Code
8449 DeclareLyXModule[endnotes.sty]{Endnotes}
8452 \begin_layout Standard
8453 The mandatory argument, in curly brackets, is the name of the module, as
8455 \begin_inset Flex Noun
8458 \begin_layout Plain Layout
8459 Document\SpecialChar menuseparator
8460 Settings\SpecialChar menuseparator
8467 The argument in square brackets is optional: It declares any \SpecialChar LaTeX
8469 on which the module depends.
8470 It is also possible to use the form
8471 \begin_inset Flex Noun
8474 \begin_layout Plain Layout
8480 as an optional argument, which declares that the module can only be used
8481 when there exists a conversion chain between the formats `
8482 \begin_inset Flex Code
8485 \begin_layout Plain Layout
8492 \begin_inset Flex Code
8495 \begin_layout Plain Layout
8504 \begin_layout Standard
8505 The module declaration should then be followed by lines like the following
8509 \begin_layout Plain Layout
8510 Preferably in English if the module should be published with \SpecialChar LyX
8512 This description will appear in the list of messages to be translated and
8513 will be thus translated with the next interface update.
8521 \begin_layout LyX-Code
8525 \begin_layout LyX-Code
8526 #Adds an endnote command, in addition to footnotes.
8530 \begin_layout LyX-Code
8531 #You will need to add
8533 theendnotes in TeX code where you
8536 \begin_layout LyX-Code
8537 #want the endnotes to appear.
8541 \begin_layout LyX-Code
8545 \begin_layout LyX-Code
8546 #Requires: somemodule | othermodule
8549 \begin_layout LyX-Code
8550 #Excludes: badmodule
8553 \begin_layout Standard
8554 The description is used in
8555 \begin_inset Flex Noun
8558 \begin_layout Plain Layout
8559 Document\SpecialChar menuseparator
8560 Settings\SpecialChar menuseparator
8566 to provide the user with information about what the module does.
8568 \begin_inset Flex Code
8571 \begin_layout Plain Layout
8577 line is used to identify other modules with which this one must be used;
8579 \begin_inset Flex Code
8582 \begin_layout Plain Layout
8588 line is used to identify modules with which this one may not be used.
8589 Both are optional, and, as shown, multiple modules should be separated
8590 with the pipe symbol: |.
8591 Note that the required modules are treated disjunctively:
8595 of the required modules must be used.
8600 excluded module may be used.
8601 Note that modules are identified here by their filenames without the
8602 \begin_inset Flex Code
8605 \begin_layout Plain Layout
8613 \begin_inset Flex Code
8616 \begin_layout Plain Layout
8623 \begin_inset Flex Code
8626 \begin_layout Plain Layout
8633 \change_inserted -712698321 1483873000
8637 \begin_layout Subsection
8639 \change_inserted -712698321 1483873010
8640 The CiteEngine file declaration
8643 \begin_layout Standard
8645 \change_inserted -712698321 1483873022
8646 A cite engine file must begin with a line like the following:
8649 \begin_layout LyX-Code
8651 \change_inserted -712698321 1483873047
8654 DeclareLyXCiteEngineModule[biblatex.sty]{Biblatex}
8657 \begin_layout Standard
8659 \change_inserted -712698321 1483873077
8660 The mandatory argument, in curly brackets, is the name of the module, as
8662 \begin_inset Flex Noun
8665 \begin_layout Plain Layout
8667 \change_inserted -712698321 1483873068
8668 Document\SpecialChar menuseparator
8669 Settings\SpecialChar menuseparator
8676 The argument in square brackets is optional: It declares any \SpecialChar LaTeX
8678 on which the cite engine depends.
8681 \begin_layout Standard
8683 \change_inserted -712698321 1483873102
8684 The cite engine declaration should then be followed by lines like the following
8688 \begin_layout Plain Layout
8690 \change_inserted -712698321 1483873000
8691 Preferably in English if the module should be published with \SpecialChar LyX
8693 This description will appear in the list of messages to be translated and
8694 will be thus translated with the next interface update.
8702 \begin_layout LyX-Code
8704 \change_inserted -712698321 1483873128
8708 \begin_layout LyX-Code
8710 \change_inserted -712698321 1483873140
8711 # Biblatex supports many author-year and numerical styles.
8714 \begin_layout LyX-Code
8716 \change_inserted -712698321 1483873152
8717 # It is mainly aimed at the Humanities.
8721 \begin_layout LyX-Code
8723 \change_inserted -712698321 1483873160
8724 # customizable, fully localized and provides many features
8727 \begin_layout LyX-Code
8729 \change_inserted -712698321 1483873170
8730 # that are not possible with BibTeX.
8731 The use of 'biber' as
8734 \begin_layout LyX-Code
8736 \change_inserted -712698321 1483873174
8737 # bibliography processor is advised.
8740 \begin_layout LyX-Code
8742 \change_inserted -712698321 1483873224
8746 \begin_layout Standard
8748 \change_inserted -712698321 1483873207
8749 The description is used in
8750 \begin_inset Flex Noun
8753 \begin_layout Plain Layout
8755 \change_inserted -712698321 1483873194
8756 Document\SpecialChar menuseparator
8757 Settings\SpecialChar menuseparator
8763 to provide the user with information about the cite engine.
8768 \begin_layout Subsection
8772 \begin_layout Standard
8773 The first non-comment line of any layout file, included file, or module
8778 contain the file format number:
8781 \begin_layout Description
8782 \begin_inset Flex Code
8785 \begin_layout Plain Layout
8792 \begin_inset Flex Code
8795 \begin_layout Plain Layout
8801 ] The format number of the layout file.
8804 \begin_layout Standard
8805 This tag was introduced with \SpecialChar LyX
8807 \begin_inset space ~
8811 Layout files from older \SpecialChar LyX
8812 versions do not have an explicit file format and
8813 are considered to have
8814 \begin_inset Flex Code
8817 \begin_layout Plain Layout
8819 \begin_inset space ~
8828 The format for the present version of \SpecialChar LyX
8830 But each version of \SpecialChar LyX
8831 is capable of reading earlier versions' layout files,
8832 just as they are capable of reading files produced by earlier versions
8835 There is, however, no provision for converting to earlier formats.
8838 \begin_layout Subsection
8839 \begin_inset CommandInset label
8841 name "subsec:General-text-class"
8845 General text class parameters
8848 \begin_layout Standard
8849 These are general parameters that govern the behavior of an entire document
8855 mean that they must appear in
8856 \begin_inset Flex Code
8859 \begin_layout Plain Layout
8865 files rather than in modules.
8866 A module can contain any layout tag.)
8869 \begin_layout Description
8870 \begin_inset Flex Code
8873 \begin_layout Plain Layout
8879 Adds information that will be output in the
8880 \begin_inset Flex Code
8883 \begin_layout Plain Layout
8889 block when the document is output to XHTML.
8890 Typically, this would be used to output CSS style information, but it can
8891 be used for anything that can appear in
8892 \begin_inset Flex Code
8895 \begin_layout Plain Layout
8903 \begin_inset Quotes eld
8907 \begin_inset Flex Code
8910 \begin_layout Plain Layout
8917 \begin_inset Quotes erd
8923 \begin_layout Description
8924 \begin_inset Flex Code
8927 \begin_layout Plain Layout
8933 Adds information to the document preamble.
8935 \begin_inset Newline newline
8939 \begin_inset Quotes eld
8943 \begin_inset Flex Code
8946 \begin_layout Plain Layout
8953 \begin_inset Quotes erd
8957 \change_inserted -712698321 1483872509
8961 \begin_layout Description
8963 \change_inserted -712698321 1483874560
8964 \begin_inset Flex Code
8967 \begin_layout Plain Layout
8969 \change_inserted -712698321 1483872558
8975 Defines the possibilities for displaying citation references.
8977 \begin_inset CommandInset ref
8979 reference "subsec:Citation-engine-description"
8988 \begin_inset Quotes eld
8992 \begin_inset Flex Code
8995 \begin_layout Plain Layout
8997 \change_inserted -712698321 1483872548
9004 \begin_inset Quotes erd
9008 Primarily used in cite engine files (see
9009 \begin_inset CommandInset ref
9011 reference "subsec:Cite-Engine-Files"
9023 \begin_layout Description
9024 \begin_inset Flex Code
9027 \begin_layout Plain Layout
9033 Defines formats for use in the display of bibliographic information.
9035 \begin_inset CommandInset ref
9037 reference "subsec:Citation-format-description"
9043 \begin_inset Quotes eld
9047 \begin_inset Flex Code
9050 \begin_layout Plain Layout
9057 \begin_inset Quotes erd
9062 \change_inserted -712698321 1483875199
9063 Primarily used in cite engine files (see
9064 \begin_inset CommandInset ref
9066 reference "subsec:Cite-Engine-Files"
9078 \begin_layout Description
9080 \change_inserted -712698321 1483874578
9081 \begin_inset Flex Code
9084 \begin_layout Plain Layout
9086 \change_inserted -712698321 1483872820
9093 \begin_inset Flex Code
9096 \begin_layout Plain Layout
9098 \change_inserted -712698321 1483872852
9109 \begin_inset Flex Code
9112 \begin_layout Plain Layout
9114 \change_inserted -712698321 1483872857
9122 ] Determines whether
9126 or Bib\SpecialChar TeX
9127 is used to generate a Bibliography.
9128 Primarily used in cite engine files (see
9129 \begin_inset CommandInset ref
9131 reference "subsec:Cite-Engine-Files"
9143 \begin_layout Description
9144 \begin_inset Flex Code
9147 \begin_layout Plain Layout
9153 Describes various global options supported by the document class.
9155 \begin_inset CommandInset ref
9157 reference "subsec:ClassOptions"
9163 \begin_inset Quotes eld
9167 \begin_inset Flex Code
9170 \begin_layout Plain Layout
9177 \begin_inset Quotes erd
9183 \begin_layout Description
9184 \begin_inset Flex Code
9187 \begin_layout Plain Layout
9194 \begin_inset Flex Code
9197 \begin_layout Plain Layout
9206 \begin_inset space \thinspace{}
9210 \begin_inset Flex Code
9213 \begin_layout Plain Layout
9219 ] Whether the class should
9223 to having one or two columns.
9224 Can be changed in the
9225 \begin_inset Flex Noun
9228 \begin_layout Plain Layout
9229 Document\SpecialChar menuseparator
9238 \begin_layout Description
9239 \begin_inset Flex Code
9242 \begin_layout Plain Layout
9249 \begin_inset Flex Code
9252 \begin_layout Plain Layout
9258 ] This sequence defines the properties for a counter.
9259 If the counter does not yet exist, it is created; if it does exist, it
9262 \begin_inset Quotes eld
9266 \begin_inset Flex Code
9269 \begin_layout Plain Layout
9276 \begin_inset Quotes erd
9280 \begin_inset Newline newline
9284 \begin_inset CommandInset ref
9286 reference "subsec:Counters"
9290 for details on counters.
9293 \begin_layout Description
9294 \begin_inset Flex Code
9297 \begin_layout Plain Layout
9303 Sets the default font used to display the document.
9305 \begin_inset CommandInset ref
9307 reference "subsec:Font-description"
9311 for how to declare fonts.
9313 \begin_inset Quotes eld
9317 \begin_inset Flex Code
9320 \begin_layout Plain Layout
9327 \begin_inset Quotes erd
9333 \begin_layout Description
9334 \begin_inset Flex Code
9337 \begin_layout Plain Layout
9344 \begin_inset Flex Code
9347 \begin_layout Plain Layout
9353 ] Specifies a module to be included by default with this document class.
9354 The module is specified as filename without the
9355 \begin_inset Flex Code
9358 \begin_layout Plain Layout
9365 The user can still remove the module, but it will be active at the outset.
9366 (This applies only when new files are created, or when this class is chosen
9367 for an existing document.)
9370 \begin_layout Description
9371 \begin_inset Flex Code
9374 \begin_layout Plain Layout
9381 \begin_inset Flex Code
9384 \begin_layout Plain Layout
9390 ] This is the style that will be assigned to new paragraphs, usually
9391 \begin_inset Flex Noun
9394 \begin_layout Plain Layout
9401 This will default to the first defined style if not given, but you are
9402 encouraged to use this directive.
9405 \begin_layout Description
9406 \begin_inset Flex Code
9409 \begin_layout Plain Layout
9416 \begin_inset Flex Code
9419 \begin_layout Plain Layout
9425 ] This tag indicates that the module (which is specified by filename without
9427 \begin_inset Flex Code
9430 \begin_layout Plain Layout
9436 extension) cannot be used with this document class.
9437 This might be used in a journal-specific layout file to prevent, say, the
9439 \begin_inset Flex Code
9442 \begin_layout Plain Layout
9448 module that numbers theorems by section.
9453 be used in a module.
9454 Modules have their own way of excluding other modules (see
9455 \begin_inset CommandInset ref
9457 reference "subsec:Layout-modules"
9464 \begin_layout Description
9465 \begin_inset Flex Code
9468 \begin_layout Plain Layout
9474 Defines a new float.
9476 \begin_inset CommandInset ref
9478 reference "subsec:Floats"
9484 \begin_inset Quotes eld
9488 \begin_inset Flex Code
9491 \begin_layout Plain Layout
9498 \begin_inset Quotes erd
9504 \begin_layout Description
9505 \begin_inset Flex Code
9508 \begin_layout Plain Layout
9514 Sets the information that will be output in the
9515 \begin_inset Flex Code
9518 \begin_layout Plain Layout
9524 block when this document class is output to XHTML.
9525 Note that this will completely override any prior
9526 \begin_inset Flex Code
9529 \begin_layout Plain Layout
9536 \begin_inset Flex Code
9539 \begin_layout Plain Layout
9547 \begin_inset Newline newline
9551 \begin_inset Flex Code
9554 \begin_layout Plain Layout
9560 if you just want to add material to the preamble.) Must end with
9561 \begin_inset Quotes eld
9565 \begin_inset Flex Code
9568 \begin_layout Plain Layout
9575 \begin_inset Quotes erd
9581 \begin_layout Description
9582 \begin_inset Flex Code
9585 \begin_layout Plain Layout
9592 \begin_inset Flex Code
9595 \begin_layout Plain Layout
9601 ] The style to use for the table of contents, bibliography, and so forth,
9602 when the document is output to HTML.
9603 For articles, this should normally be
9604 \begin_inset Flex Code
9607 \begin_layout Plain Layout
9614 \begin_inset Flex Code
9617 \begin_layout Plain Layout
9624 If it is not given, then \SpecialChar LyX
9625 will attempt to figure out which layout to use.
9628 \begin_layout Description
9629 \begin_inset Flex Code
9632 \begin_layout Plain Layout
9639 \begin_inset Flex Code
9642 \begin_layout Plain Layout
9648 ] Modifies the properties of the given counter.
9649 If the counter does not exist, the statement is ignored.
9651 \begin_inset Quotes eld
9655 \begin_inset Flex Code
9658 \begin_layout Plain Layout
9665 \begin_inset Quotes erd
9669 \begin_inset Newline newline
9673 \begin_inset CommandInset ref
9675 reference "subsec:Counters"
9679 for details on counters.
9682 \begin_layout Description
9683 \begin_inset Flex Code
9686 \begin_layout Plain Layout
9693 \begin_inset Flex Code
9696 \begin_layout Plain Layout
9702 ] This allows you to include another layout definition file within yours
9703 to avoid duplicating commands.
9704 Common examples are the standard layout files, for example,
9705 \begin_inset Flex Code
9708 \begin_layout Plain Layout
9714 , which contains most of the basic layouts.
9717 \begin_layout Description
9718 \begin_inset Flex Code
9721 \begin_layout Plain Layout
9728 \begin_inset Flex Code
9731 \begin_layout Plain Layout
9737 ] This section (re-)defines the layout of an inset.
9738 It can be applied to an existing inset or to a new, user-defined inset,
9739 e.g., a new character style.
9741 \begin_inset Quotes eld
9745 \begin_inset Flex Code
9748 \begin_layout Plain Layout
9755 \begin_inset Quotes erd
9759 \begin_inset Newline newline
9763 \begin_inset CommandInset ref
9765 reference "subsec:Flex-insets-and"
9769 for more information.
9773 \begin_layout Description
9774 \begin_inset Flex Code
9777 \begin_layout Plain Layout
9784 \begin_inset Flex Code
9787 \begin_layout Plain Layout
9793 ] A string that indicates the width of the left margin on the screen, for
9795 \begin_inset Quotes eld
9799 \begin_inset Flex Code
9802 \begin_layout Plain Layout
9809 \begin_inset Quotes erd
9813 (Note that this is not a `length', like
9814 \begin_inset Quotes eld
9818 \begin_inset Quotes erd
9822 \change_inserted -712698321 1483872681
9826 \begin_layout Description
9828 \change_inserted -712698321 1483874598
9829 \begin_inset Flex Code
9832 \begin_layout Plain Layout
9834 \change_inserted -712698321 1483872687
9841 \begin_inset Flex Code
9844 \begin_layout Plain Layout
9846 \change_inserted -712698321 1483872692
9852 ] An integer that determines the maximal number of names displayed in an
9853 author-year citation before the citation switches to
9854 \begin_inset Quotes eld
9858 \begin_inset Quotes erd
9862 Primarily used in cite engine files (see
9863 \begin_inset CommandInset ref
9865 reference "subsec:Cite-Engine-Files"
9877 \begin_layout Description
9878 \begin_inset Flex Code
9881 \begin_layout Plain Layout
9888 \begin_inset Flex Code
9891 \begin_layout Plain Layout
9897 ] Modifies the properties of the given paragraph style.
9898 If the style does not exist, this section is ignored.
9900 \begin_inset Quotes eld
9904 \begin_inset Flex Code
9907 \begin_layout Plain Layout
9914 \begin_inset Quotes erd
9920 \begin_layout Description
9921 \begin_inset Flex Code
9924 \begin_layout Plain Layout
9931 \begin_inset Flex Code
9934 \begin_layout Plain Layout
9940 ] Deletes an existing counter, usually one defined in an included file.
9943 \begin_layout Description
9944 \begin_inset Flex Code
9947 \begin_layout Plain Layout
9954 \begin_inset Flex Code
9957 \begin_layout Plain Layout
9963 ] Deletes an existing float.
9964 This is particularly useful when you want to suppress a float that has
9965 been defined in an input file.
9968 \begin_layout Description
9969 \begin_inset Flex Code
9972 \begin_layout Plain Layout
9979 \begin_inset Flex Code
9982 \begin_layout Plain Layout
9988 ] Deletes an existing style.
9989 \change_inserted 2047637253 1483900342
9993 \begin_layout Description
9995 \change_inserted 2047637253 1483900479
9996 \begin_inset Flex Code
9999 \begin_layout Plain Layout
10001 \change_inserted 2047637253 1483900346
10008 \begin_inset Flex Code
10011 \begin_layout Plain Layout
10013 \change_inserted 2047637253 1483900369
10020 \begin_inset Flex Code
10023 \begin_layout Plain Layout
10025 \change_inserted 2047637253 1483900418
10031 ] Define a new table of contents with type
10032 \begin_inset Flex Code
10035 \begin_layout Plain Layout
10037 \change_inserted 2047637253 1483900414
10044 \begin_inset Flex Code
10047 \begin_layout Plain Layout
10049 \change_inserted 2047637253 1483900419
10056 See also the AddToToc commands.
10061 \begin_layout Description
10062 \begin_inset Flex Code
10065 \begin_layout Plain Layout
10072 \begin_inset Flex Code
10075 \begin_layout Plain Layout
10081 ] The file format (as defined in the \SpecialChar LyX
10082 preferences) produced by this document
10084 It is mainly useful when
10085 \begin_inset Flex Code
10088 \begin_layout Plain Layout
10095 \begin_inset Flex Code
10098 \begin_layout Plain Layout
10104 and one wants to define a new type of literate document.
10105 The format is reset to
10106 \begin_inset Quotes eld
10110 \begin_inset Flex Code
10113 \begin_layout Plain Layout
10120 \begin_inset Quotes erd
10124 \begin_inset Quotes eld
10128 \begin_inset Flex Code
10131 \begin_layout Plain Layout
10138 \begin_inset Quotes erd
10141 when the corresponding
10142 \begin_inset Flex Code
10145 \begin_layout Plain Layout
10151 parameter is encountered.
10154 \begin_layout Description
10155 \begin_inset Flex Code
10158 \begin_layout Plain Layout
10165 \begin_inset Flex Code
10168 \begin_layout Plain Layout
10179 \begin_inset Flex Code
10182 \begin_layout Plain Layout
10189 \begin_inset Flex Code
10192 \begin_layout Plain Layout
10198 ] Specifies what sort of output documents using this class will produce.
10201 \begin_layout Description
10202 \begin_inset Flex Code
10205 \begin_layout Plain Layout
10212 \begin_inset Flex Code
10215 \begin_layout Plain Layout
10222 \begin_inset Flex Code
10225 \begin_layout Plain Layout
10231 ] Specifies options, given in the second string, for the package named by
10234 \begin_inset Quotes eld
10238 \begin_inset Flex Code
10241 \begin_layout Plain Layout
10242 PackageOptions natbib square
10248 \begin_inset Quotes erd
10252 \begin_inset Flex Code
10255 \begin_layout Plain Layout
10261 to be loaded with the
10262 \begin_inset Flex Code
10265 \begin_layout Plain Layout
10272 (For \SpecialChar TeX
10273 perts, this causes \SpecialChar LyX
10275 \begin_inset Flex Code
10278 \begin_layout Plain Layout
10281 PassOptionsToPackage{natbib}{square}
10287 \begin_inset Flex Code
10290 \begin_layout Plain Layout
10299 \begin_layout Description
10300 \begin_inset Flex Code
10303 \begin_layout Plain Layout
10310 \begin_inset Flex Code
10313 \begin_layout Plain Layout
10322 \begin_inset Flex Code
10325 \begin_layout Plain Layout
10332 \begin_inset Flex Code
10335 \begin_layout Plain Layout
10341 ] The default pagestyle.
10342 Can be changed in the
10343 \begin_inset Flex Noun
10346 \begin_layout Plain Layout
10347 Document\SpecialChar menuseparator
10356 \begin_layout Description
10357 \begin_inset Flex Code
10360 \begin_layout Plain Layout
10366 Sets the preamble for the \SpecialChar LaTeX
10368 Note that this will completely override any prior
10369 \begin_inset Flex Code
10372 \begin_layout Plain Layout
10379 \begin_inset Flex Code
10382 \begin_layout Plain Layout
10390 \begin_inset Flex Code
10393 \begin_layout Plain Layout
10399 if you just want to add material to the preamble.) Must end with
10400 \begin_inset Quotes eld
10404 \begin_inset Flex Code
10407 \begin_layout Plain Layout
10414 \begin_inset Quotes erd
10420 \begin_layout Description
10421 \begin_inset Flex Code
10424 \begin_layout Plain Layout
10431 \begin_inset Flex Code
10434 \begin_layout Plain Layout
10441 \begin_inset Flex Code
10444 \begin_layout Plain Layout
10453 \begin_inset space \thinspace{}
10457 \begin_inset Flex Code
10460 \begin_layout Plain Layout
10466 ] Whether the class already provides the feature
10467 \begin_inset Flex Code
10470 \begin_layout Plain Layout
10477 A feature is in general the name of a package (e.
10478 \begin_inset space \thinspace{}
10482 \begin_inset space \space{}
10486 \begin_inset Flex Code
10489 \begin_layout Plain Layout
10496 \begin_inset Flex Code
10499 \begin_layout Plain Layout
10506 \begin_inset space \thinspace{}
10510 \begin_inset space \space{}
10514 \begin_inset Flex Code
10517 \begin_layout Plain Layout
10524 \begin_inset Flex Code
10527 \begin_layout Plain Layout
10535 \begin_inset CommandInset ref
10537 reference "chap:List-of-functions"
10541 for the list of features.
10544 \begin_layout Description
10545 \begin_inset Flex Code
10548 \begin_layout Plain Layout
10555 \begin_inset Flex Code
10558 \begin_layout Plain Layout
10564 ] Indicates that this layout provides the functionality of the module mentioned,
10565 which should be specified by the filename without the
10566 \begin_inset Flex Code
10569 \begin_layout Plain Layout
10576 This will typically be used if the layout includes the module directly,
10577 rather than using the
10578 \begin_inset Flex Code
10581 \begin_layout Plain Layout
10587 tag to indicate that it ought to be used.
10588 It could also be used in a module that provided an alternate implementation
10589 of the same functionality.
10592 \begin_layout Description
10593 \begin_inset Flex Code
10596 \begin_layout Plain Layout
10603 \begin_inset Flex Code
10606 \begin_layout Plain Layout
10612 ] Creates a new paragraph style if it does not already exist.
10613 If the style does exist, this section is ignored.
10615 \begin_inset Quotes eld
10619 \begin_inset Flex Code
10622 \begin_layout Plain Layout
10629 \begin_inset Quotes erd
10635 \begin_layout Description
10636 \begin_inset Flex Code
10639 \begin_layout Plain Layout
10646 \begin_inset Flex Code
10649 \begin_layout Plain Layout
10655 ] Whether the class requires the feature
10656 \begin_inset Flex Code
10659 \begin_layout Plain Layout
10666 Multiple features must be separated by commas.
10667 Note that you can only request supported features.
10669 \begin_inset CommandInset ref
10671 reference "chap:List-of-functions"
10675 for the list of features.).
10676 If you require a package with specific options, you can additionally use
10678 \begin_inset Flex Code
10681 \begin_layout Plain Layout
10690 \begin_layout Description
10691 \begin_inset Flex Code
10694 \begin_layout Plain Layout
10701 \begin_inset Flex Code
10704 \begin_layout Plain Layout
10710 ] A string that indicates the width of the right margin on the screen, for
10712 \begin_inset Quotes eld
10716 \begin_inset Flex Code
10719 \begin_layout Plain Layout
10726 \begin_inset Quotes erd
10732 \begin_layout Description
10733 \begin_inset Flex Code
10736 \begin_layout Plain Layout
10743 \begin_inset Flex Code
10746 \begin_layout Plain Layout
10752 ] Sets which divisions get numbered.
10754 \begin_inset Newline newline
10758 \begin_inset Flex Code
10761 \begin_layout Plain Layout
10767 counter in \SpecialChar LaTeX
10771 \begin_layout Description
10772 \begin_inset Flex Code
10775 \begin_layout Plain Layout
10782 \begin_inset Flex Code
10785 \begin_layout Plain Layout
10794 \begin_inset space \thinspace{}
10798 \begin_inset Flex Code
10801 \begin_layout Plain Layout
10807 ] Whether the class-default should be printing on one or both sides of the
10809 Can be changed in the
10810 \begin_inset Flex Noun
10813 \begin_layout Plain Layout
10814 Document\SpecialChar menuseparator
10823 \begin_layout Description
10824 \begin_inset Flex Code
10827 \begin_layout Plain Layout
10834 \begin_inset Flex Code
10837 \begin_layout Plain Layout
10843 ] This sequence defines a paragraph style.
10844 If the style does not yet exist, it is created; if it does exist, its parameter
10847 \begin_inset Quotes eld
10851 \begin_inset Flex Code
10854 \begin_layout Plain Layout
10861 \begin_inset Quotes erd
10865 \begin_inset Newline newline
10869 \begin_inset CommandInset ref
10871 reference "subsec:Paragraph-Styles"
10875 for details on paragraph styles.
10878 \begin_layout Description
10879 \begin_inset Flex Code
10882 \begin_layout Plain Layout
10889 \begin_inset Flex Code
10892 \begin_layout Plain Layout
10898 ] The name of the command or environment to be used with
10899 \begin_inset Flex Code
10902 \begin_layout Plain Layout
10911 \begin_layout Description
10912 \begin_inset Flex Code
10915 \begin_layout Plain Layout
10922 \begin_inset Flex Code
10925 \begin_layout Plain Layout
10934 \begin_inset Flex Code
10937 \begin_layout Plain Layout
10943 ] Indicates what kind of markup is used to define the title of a document.
10945 \begin_inset Flex Code
10948 \begin_layout Plain Layout
10954 means that the macro with name
10955 \begin_inset Flex Code
10958 \begin_layout Plain Layout
10964 will be inserted after the last layout which has
10965 \begin_inset Quotes eld
10969 \begin_inset Flex Code
10972 \begin_layout Plain Layout
10974 \begin_inset space ~
10983 \begin_inset Quotes erd
10988 \begin_inset Flex Code
10991 \begin_layout Plain Layout
10997 corresponds to the case where all layouts which have
10998 \begin_inset Quotes eld
11002 \begin_inset Flex Code
11005 \begin_layout Plain Layout
11007 \begin_inset space ~
11016 \begin_inset Quotes erd
11019 should be enclosed into the
11020 \begin_inset Flex Code
11023 \begin_layout Plain Layout
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 ] Sets which divisions are included in the table of contents.
11054 \begin_inset Flex Code
11057 \begin_layout Plain Layout
11063 counter in \SpecialChar LaTeX
11067 \begin_layout Subsection
11068 \begin_inset Flex Code
11071 \begin_layout Plain Layout
11078 \begin_inset CommandInset label
11080 name "subsec:ClassOptions"
11087 \begin_layout Standard
11089 \begin_inset Flex Code
11092 \begin_layout Plain Layout
11098 section can contain the following entries:
11101 \begin_layout Description
11102 \begin_inset Flex Code
11105 \begin_layout Plain Layout
11112 \begin_inset Flex Code
11115 \begin_layout Plain Layout
11121 ] The list of available font sizes for the document's main font, separated
11123 \begin_inset Quotes eld
11127 \begin_inset Flex Code
11130 \begin_layout Plain Layout
11137 \begin_inset Quotes erd
11143 \begin_layout Description
11144 \begin_inset Flex Code
11147 \begin_layout Plain Layout
11153 Used to set the DTD line with XML-based output classes.
11155 \begin_inset space \thinspace{}
11159 \begin_inset Quotes eld
11162 -//OASIS//DTD DocBook V4.2//EN
11163 \begin_inset Quotes erd
11169 \begin_layout Description
11170 \begin_inset Flex Code
11173 \begin_layout Plain Layout
11180 \begin_inset Flex Code
11183 \begin_layout Plain Layout
11184 string="empty|plain|headings|fancy"
11189 ] The list of available page sty\SpecialChar softhyphen
11191 \begin_inset Quotes eld
11195 \begin_inset Flex Code
11198 \begin_layout Plain Layout
11205 \begin_inset Quotes erd
11211 \begin_layout Description
11212 \begin_inset Flex Code
11215 \begin_layout Plain Layout
11222 \begin_inset Flex Code
11225 \begin_layout Plain Layout
11231 ] Some document class options, separated by a comma, that will be added
11232 to the optional part of the
11233 \begin_inset Flex Code
11236 \begin_layout Plain Layout
11247 \begin_layout Standard
11249 \begin_inset Flex Code
11252 \begin_layout Plain Layout
11258 section must end with
11259 \begin_inset Quotes eld
11263 \begin_inset Flex Code
11266 \begin_layout Plain Layout
11273 \begin_inset Quotes erd
11279 \begin_layout Subsection
11281 \begin_inset CommandInset label
11283 name "subsec:Paragraph-Styles"
11290 \begin_layout Standard
11291 A paragraph style description looks like this:
11295 \begin_layout Plain Layout
11296 Note that this will either define a new style or modify an existing one.
11304 \begin_layout LyX-Code
11311 \begin_layout LyX-Code
11315 \begin_layout LyX-Code
11319 \begin_layout Standard
11320 where the following commands are allowed:
11323 \begin_layout Description
11325 \change_inserted 2047637253 1483963019
11326 \begin_inset Flex Code
11329 \begin_layout Plain Layout
11331 \change_inserted 2047637253 1483901753
11338 \begin_inset Flex Code
11341 \begin_layout Plain Layout
11343 \change_inserted 2047637253 1483963007
11349 =""] This paragraph will appear in the table of contents of the given type.
11350 An empty string disables.
11351 See also the OutlinerName and the IsTocCaption commands.
11355 \begin_layout Description
11356 \begin_inset Flex Code
11359 \begin_layout Plain Layout
11366 \begin_inset Flex Code
11369 \begin_layout Plain Layout
11374 , left, right, center
11379 ] Paragraph alignment.
11382 \begin_layout Description
11383 \begin_inset Flex Code
11386 \begin_layout Plain Layout
11393 \begin_inset Flex Code
11396 \begin_layout Plain Layout
11401 , left, right, center
11406 ] A comma separated list of permitted alignments.
11407 (Some \SpecialChar LaTeX
11408 styles prohibit certain alignments, since those wouldn't make sense.
11409 For example a right-aligned or centered enumeration isn't possible.)
11412 \begin_layout Description
11413 \begin_inset Flex Code
11416 \begin_layout Plain Layout
11423 \begin_inset Flex Code
11426 \begin_layout Plain Layout
11432 ] Defines argument number <int> of a command\SpecialChar breakableslash
11433 environment associated with
11435 This is useful for things like section headings, and only makes sense with
11438 Every (optional or required) argument of a command or environment – except
11439 for the required argument that is associated with the content of the paragraph
11440 itself – has a separate definition, where the number specifies the order
11442 The definition must end with
11443 \begin_inset Flex Code
11446 \begin_layout Plain Layout
11453 So a command with two optional arguments has:
11457 \begin_layout Quote
11463 \begin_layout Quote
11469 \begin_layout Quote
11475 \begin_layout Quote
11481 \begin_layout Quote
11487 \begin_layout Quote
11493 \begin_layout Standard
11495 \begin_inset Flex Code
11498 \begin_layout Plain Layout
11504 definition, the following specifications are possible:
11507 \begin_layout Itemize
11508 \begin_inset Flex Code
11511 \begin_layout Plain Layout
11518 \begin_inset Flex Code
11521 \begin_layout Plain Layout
11527 The string that will appear both in the menu (to insert this argument)
11528 and on the argument inset button (unless you also specify a separate
11529 \begin_inset Flex Code
11532 \begin_layout Plain Layout
11539 For the menu, you can define an accelerator by appending the respective
11540 character to the string, divided by
11541 \begin_inset Quotes eld
11545 \begin_inset Quotes erd
11549 \begin_inset space \thinspace{}
11553 \begin_inset space \space{}
11557 \begin_inset Quotes eld
11561 \begin_inset Flex Code
11564 \begin_layout Plain Layout
11571 \begin_inset Quotes erd
11577 \begin_layout Itemize
11578 \begin_inset Flex Code
11581 \begin_layout Plain Layout
11588 \begin_inset Flex Code
11591 \begin_layout Plain Layout
11597 A separate string for the menu.
11598 You can define an accelerator by appending the respective character to
11599 the string, divided by
11600 \begin_inset Quotes eld
11604 \begin_inset Quotes erd
11608 \begin_inset space \thinspace{}
11612 \begin_inset space \space{}
11616 \begin_inset Quotes eld
11620 \begin_inset Flex Code
11623 \begin_layout Plain Layout
11630 \begin_inset Quotes erd
11634 This specification is optional.
11635 If it is not given the
11636 \begin_inset Flex Code
11639 \begin_layout Plain Layout
11645 will be used instead for the menu.
11648 \begin_layout Itemize
11649 \begin_inset Flex Code
11652 \begin_layout Plain Layout
11659 \begin_inset Flex Code
11662 \begin_layout Plain Layout
11668 A longer explanatory text that appears in the tooltip when hovering over
11669 the argument inset.
11672 \begin_layout Itemize
11673 \begin_inset Flex Code
11676 \begin_layout Plain Layout
11683 \begin_inset Flex Code
11686 \begin_layout Plain Layout
11695 \begin_inset space \thinspace{}
11699 \begin_inset Flex Code
11702 \begin_layout Plain Layout
11708 ] Declare if this is a mandatory (1) or an optional (0) argument.
11709 Mandatory arguments will be output empty if not given, while optional arguments
11710 will not be output at all.
11711 By default, mandatory arguments are delimited by
11712 \begin_inset Flex Code
11715 \begin_layout Plain Layout
11721 , while optional arguments are delimited by
11722 \begin_inset Flex Code
11725 \begin_layout Plain Layout
11734 \begin_layout Itemize
11735 \begin_inset Flex Code
11738 \begin_layout Plain Layout
11745 \begin_inset Flex Code
11748 \begin_layout Plain Layout
11754 defines another argument (by its number) which this argument requires to
11755 be output if it is itself output.
11757 \begin_inset space \thinspace{}
11760 g., in \SpecialChar LaTeX
11761 commands, optional arguments often require previous optional arguments
11762 to be output (at least empty), as in
11763 \begin_inset Flex Code
11766 \begin_layout Plain Layout
11769 command[][argument]{text}
11775 This can be achieved by the statement
11776 \begin_inset Flex Code
11779 \begin_layout Plain Layout
11786 \begin_inset Flex Code
11789 \begin_layout Plain Layout
11798 \begin_layout Itemize
11799 \begin_inset Flex Code
11802 \begin_layout Plain Layout
11809 \begin_inset Flex Code
11812 \begin_layout Plain Layout
11818 defines a custom left delimiter (instead of
11819 \begin_inset Flex Code
11822 \begin_layout Plain Layout
11829 \begin_inset Flex Code
11832 \begin_layout Plain Layout
11839 A line break in the output can be indicated by
11840 \begin_inset Flex Code
11843 \begin_layout Plain Layout
11852 \begin_layout Itemize
11853 \begin_inset Flex Code
11856 \begin_layout Plain Layout
11863 \begin_inset Flex Code
11866 \begin_layout Plain Layout
11872 defines a custom right delimiter (instead of
11873 \begin_inset Flex Code
11876 \begin_layout Plain Layout
11883 \begin_inset Flex Code
11886 \begin_layout Plain Layout
11893 A line break in the output can be indicated by
11894 \begin_inset Flex Code
11897 \begin_layout Plain Layout
11906 \begin_layout Itemize
11907 \begin_inset Flex Code
11910 \begin_layout Plain Layout
11917 \begin_inset Flex Code
11920 \begin_layout Plain Layout
11926 defines an argument that is inserted if and only if no user-specified arguments
11928 \begin_inset space \thinspace{}
11932 \begin_inset space \space{}
11935 if no argument inset has been inserted (note that also an empty argument
11936 inset omits the DefaultArg).
11937 Multiple arguments need to be separated by comma.
11940 \begin_layout Itemize
11941 \begin_inset Flex Code
11944 \begin_layout Plain Layout
11951 \begin_inset Flex Code
11954 \begin_layout Plain Layout
11960 defines an argument that is inserted in any case (alone or in addition
11961 to user-specified arguments).
11962 Multiple arguments need to be separated by comma.
11965 \begin_layout Itemize
11966 \begin_inset Flex Code
11969 \begin_layout Plain Layout
11975 The font used for the argument content, see
11976 \begin_inset CommandInset ref
11978 reference "subsec:Font-description"
11985 \begin_layout Itemize
11986 \begin_inset Flex Code
11989 \begin_layout Plain Layout
11995 The font used for the label; see
11996 \begin_inset CommandInset ref
11998 reference "subsec:Font-description"
12005 \begin_layout Itemize
12006 \begin_inset Flex Code
12009 \begin_layout Plain Layout
12016 \begin_inset Flex Code
12019 \begin_layout Plain Layout
12024 , Minimalistic, Conglomerate
12029 ] describes the rendering style used for the inset's frame and buttons.
12032 \begin_layout Itemize
12033 \begin_inset Flex Code
12036 \begin_layout Plain Layout
12043 \begin_inset Flex Code
12046 \begin_layout Plain Layout
12053 \begin_inset Flex Code
12056 \begin_layout Plain Layout
12062 , this argument is automatically inserted when the respective style is selected.
12063 Currently, only one argument per style\SpecialChar breakableslash
12064 layout can be automatically inserted.
12067 \begin_layout Itemize
12068 \begin_inset Flex Code
12071 \begin_layout Plain Layout
12078 \begin_inset Flex Code
12081 \begin_layout Plain Layout
12088 \begin_inset Flex Code
12091 \begin_layout Plain Layout
12097 , this argument will be inserted with a copy of the co-text (either selected
12098 text or the whole paragraph) as content.
12099 \change_inserted -712698321 1477038290
12103 \begin_layout Itemize
12105 \change_inserted -712698321 1477038425
12106 \begin_inset Flex Code
12109 \begin_layout Plain Layout
12111 \change_inserted -712698321 1477038295
12118 \begin_inset Flex Code
12121 \begin_layout Plain Layout
12123 \change_inserted -712698321 1477038311
12133 ] Whether the contents of this argument should be output in raw form, meaning
12134 without special translations that \SpecialChar LaTeX
12137 \begin_inset Flex Code
12140 \begin_layout Plain Layout
12142 \change_inserted -712698321 1477038356
12148 status is inherited by the inset or paragraph layout the argument belongs
12149 to, true and false change the status for the given argument only.
12154 \begin_layout Itemize
12155 \begin_inset Flex Code
12158 \begin_layout Plain Layout
12165 \begin_inset Flex Code
12168 \begin_layout Plain Layout
12169 string of characters
12178 Defines individual characters that should be output in raw form, meaning
12179 without special translations that \SpecialChar LaTeX
12181 Note that, contrary to PassThru, this needs to be explicitly defined for
12183 That is, arguments do not inherit PassThruChars from their parent inset
12185 \change_inserted 2047637253 1483899840
12189 \begin_layout Itemize
12191 \change_inserted 2047637253 1483900841
12192 \begin_inset Flex Code
12195 \begin_layout Plain Layout
12197 \change_inserted 2047637253 1483900841
12204 \begin_inset Flex Code
12207 \begin_layout Plain Layout
12209 \change_inserted 2047637253 1483900841
12218 \begin_inset space \thinspace{}
12222 \begin_inset Flex Code
12225 \begin_layout Plain Layout
12227 \change_inserted 2047637253 1483900841
12233 ] If this is set to 1, the argument will output its content in the corresponding
12234 item in the table of contents.
12240 \begin_layout Standard
12241 By default, the text entered in the \SpecialChar LyX
12242 workarea in the respective layout is
12243 the last (mandatory) argument of a command if the
12244 \begin_inset Flex Code
12247 \begin_layout Plain Layout
12254 \begin_inset Flex Code
12257 \begin_layout Plain Layout
12264 However, arguments with the prefix
12265 \begin_inset Flex Code
12268 \begin_layout Plain Layout
12274 are output after this workarea argument.
12275 Note that post-argument numbering restarts at 1, so the first argument
12276 following the workarea argument is
12277 \begin_inset Flex Code
12280 \begin_layout Plain Layout
12287 Post-arguments are ignored in any other
12288 \begin_inset Flex Code
12291 \begin_layout Plain Layout
12298 \begin_inset Flex Code
12301 \begin_layout Plain Layout
12310 \begin_layout Standard
12312 \begin_inset Flex Code
12315 \begin_layout Plain Layout
12324 \begin_inset Flex Code
12327 \begin_layout Plain Layout
12336 \begin_inset Flex Code
12339 \begin_layout Plain Layout
12345 followed by the number (e.
12346 \begin_inset space \thinspace{}
12350 \begin_inset space \space{}
12354 \begin_inset Flex Code
12357 \begin_layout Plain Layout
12367 \begin_layout Description
12368 \begin_inset Flex Code
12371 \begin_layout Plain Layout
12377 Note that this will completely override any prior
12378 \begin_inset Flex Code
12381 \begin_layout Plain Layout
12387 declaration for this style.
12389 \begin_inset Quotes eld
12393 \begin_inset Flex Code
12396 \begin_layout Plain Layout
12403 \begin_inset Quotes erd
12408 \begin_inset CommandInset ref
12410 reference "subsec:I18n"
12414 for details on its use.
12417 \begin_layout Description
12418 \begin_inset Flex Code
12421 \begin_layout Plain Layout
12428 \begin_inset Flex Code
12431 \begin_layout Plain Layout
12441 \begin_layout Plain Layout
12442 Note that a `float' here is a real number, such as: 1.5.
12447 The vertical space with which the last of a chain of paragraphs with this
12448 style is separated from the following paragraph.
12449 If the next paragraph has another style, the separations are not simply
12450 added, but the maximum is taken.
12453 \begin_layout Description
12454 \begin_inset Flex Code
12457 \begin_layout Plain Layout
12464 \begin_inset Flex Code
12467 \begin_layout Plain Layout
12473 ] The category for this style.
12474 This is used to group related styles in the style combobox on the toolbar.
12475 Any string can be used, but you may want to use existing categories with
12480 \begin_layout Description
12481 \begin_inset Flex Code
12484 \begin_layout Plain Layout
12490 Depth of XML command.
12491 Used only with XML-type formats.
12494 \begin_layout Description
12495 \begin_inset Flex Code
12498 \begin_layout Plain Layout
12505 \begin_inset Flex Code
12508 \begin_layout Plain Layout
12514 ] Copies all the features of an existing style into the current one.
12518 \begin_layout Description
12519 \begin_inset Flex Code
12522 \begin_layout Plain Layout
12529 \begin_inset Flex Code
12532 \begin_layout Plain Layout
12538 ] The name of a style whose preamble should be output
12543 This allows to ensure some ordering of the preamble snippets when macros
12544 definitions depend on one another.
12548 \begin_layout Plain Layout
12549 Note that, besides that functionality, there is no way to ensure any ordering
12551 The ordering that you see in a given version of \SpecialChar LyX
12552 may change without warning
12561 \begin_layout Description
12562 \begin_inset Flex Code
12565 \begin_layout Plain Layout
12572 \begin_inset Flex Code
12575 \begin_layout Plain Layout
12580 , Box, Filled_Box, Static
12585 ] The type of label that stands at the end of the paragraph (or sequence
12587 \begin_inset Flex Code
12590 \begin_layout Plain Layout
12597 \begin_inset Newline newline
12601 \begin_inset Flex Code
12604 \begin_layout Plain Layout
12611 \begin_inset Flex Code
12614 \begin_layout Plain Layout
12621 \begin_inset Flex Code
12624 \begin_layout Plain Layout
12632 \begin_inset Flex Code
12635 \begin_layout Plain Layout
12642 \begin_inset Quotes eld
12646 \begin_inset Quotes erd
12650 \begin_inset Flex Code
12653 \begin_layout Plain Layout
12660 \begin_inset space \space{}
12664 \begin_inset Flex Code
12667 \begin_layout Plain Layout
12673 ) is a white (resp.
12674 \begin_inset space ~
12677 black) square suitable for end of proof markers,
12678 \begin_inset Flex Code
12681 \begin_layout Plain Layout
12687 is an explicit text string.
12690 \begin_layout Description
12691 \begin_inset Flex Code
12694 \begin_layout Plain Layout
12701 \begin_inset Flex Code
12704 \begin_layout Plain Layout
12710 ] The string used for a label with a
12711 \begin_inset Flex Code
12714 \begin_layout Plain Layout
12721 \begin_inset Newline newline
12725 \begin_inset Flex Code
12728 \begin_layout Plain Layout
12738 \begin_layout Description
12739 \begin_inset Flex Code
12742 \begin_layout Plain Layout
12748 The font used for both the text body
12754 \begin_inset CommandInset ref
12756 reference "subsec:Font-description"
12761 Note that defining this font automatically defines the
12762 \begin_inset Flex Code
12765 \begin_layout Plain Layout
12772 So you should define this one first if you also want to define
12773 \begin_inset Flex Code
12776 \begin_layout Plain Layout
12785 \begin_layout Description
12786 \begin_inset Flex Code
12789 \begin_layout Plain Layout
12796 \begin_inset Flex Code
12799 \begin_layout Plain Layout
12805 ] Used for backporting new styles to stable \SpecialChar LyX
12807 The first stable version that supports this tag is \SpecialChar LyX
12809 The argument is a number which may either be 0, -1 or any value greater
12812 \begin_inset Flex Code
12815 \begin_layout Plain Layout
12821 flag of a style is greater than zero, it will always be written to the
12823 If a .lyx file is read, the style definitions from the document header are
12824 added to the document class.
12825 Therefore even older \SpecialChar LyX
12826 versions can handle the style.
12828 \begin_inset Flex Code
12831 \begin_layout Plain Layout
12837 is a version number: if the style is read, and the version number is less
12838 than the version number of the already existing style in the document class,
12839 the new style is ignored.
12840 If the version number is greater, the new style replaces the existing style.
12841 A value of -1 means an infinite version number, i.
12842 \begin_inset space \thinspace{}
12846 \begin_inset space \space{}
12849 the style is always used.
12852 \begin_layout Description
12853 \begin_inset Flex Code
12856 \begin_layout Plain Layout
12863 \begin_inset Flex Code
12866 \begin_layout Plain Layout
12875 \begin_inset space \thinspace{}
12879 \begin_inset Flex Code
12882 \begin_layout Plain Layout
12888 ] Usually \SpecialChar LyX
12889 does not allow you to insert more than one space between words,
12890 since a space is considered as the separation between two words, not a
12891 character or symbol of its own.
12892 This is a very fine thing but sometimes annoying, for example, when typing
12893 program code or plain \SpecialChar LaTeX
12896 \begin_inset Flex Code
12899 \begin_layout Plain Layout
12906 Note that \SpecialChar LyX
12907 will create protected blanks for the additional blanks when
12908 in another mode than \SpecialChar LaTeX
12912 \begin_layout Description
12913 \begin_inset Flex Code
12916 \begin_layout Plain Layout
12922 These tags are used with XHTML output.
12924 \begin_inset CommandInset ref
12926 reference "subsec:Paragraph-Style-XHTML"
12933 \begin_layout Description
12934 \begin_inset Flex Code
12937 \begin_layout Plain Layout
12943 [FIXME] (Used only with XML-type formats.)
12946 \begin_layout Description
12947 \begin_inset Flex Code
12950 \begin_layout Plain Layout
12957 \begin_inset Flex Code
12960 \begin_layout Plain Layout
12969 \begin_inset space \thinspace{}
12973 \begin_inset Flex Code
12976 \begin_layout Plain Layout
12983 \begin_inset Flex Code
12986 \begin_layout Plain Layout
12992 , marks the style as to be included in the document preamble and not in
12994 This is useful for document classes that want such information as the title
12995 and author to appear in the preamble.
12996 Note that this works only for styles for which the
12997 \begin_inset Flex Code
13000 \begin_layout Plain Layout
13007 \begin_inset Flex Code
13010 \begin_layout Plain Layout
13017 \begin_inset Flex Code
13020 \begin_layout Plain Layout
13029 \begin_layout Description
13030 \begin_inset Flex Code
13033 \begin_layout Plain Layout
13040 \begin_inset Flex Code
13043 \begin_layout Plain Layout
13052 \begin_inset space \thinspace{}
13056 \begin_inset Flex Code
13059 \begin_layout Plain Layout
13066 \begin_inset Flex Code
13069 \begin_layout Plain Layout
13075 , marks the style as being part of a title block (see also the
13076 \begin_inset Flex Code
13079 \begin_layout Plain Layout
13086 \begin_inset Flex Code
13089 \begin_layout Plain Layout
13098 \begin_layout Description
13100 \change_inserted 2047637253 1483902824
13101 \begin_inset Flex Code
13104 \begin_layout Plain Layout
13106 \change_inserted 2047637253 1483902211
13113 \begin_inset Flex Code
13116 \begin_layout Plain Layout
13118 \change_inserted 2047637253 1483902211
13127 \begin_inset space \thinspace{}
13131 \begin_inset Flex Code
13134 \begin_layout Plain Layout
13136 \change_inserted 2047637253 1483902211
13142 ] If this is set to 1 and AddToToc is enabled, the paragraph adds a summary
13143 of its contents in its item in the table of contents.
13144 Otherwise, only the label, if it exists, appears.
13147 \begin_layout Description
13148 \begin_inset Flex Code
13151 \begin_layout Plain Layout
13158 \begin_inset Flex Code
13161 \begin_layout Plain Layout
13167 ] The \SpecialChar LaTeX
13168 command sequence declaring an item in a list.
13169 The command is to be defined without the preceding backslash (the default
13171 \begin_inset Quotes eld
13175 \begin_inset Quotes erd
13179 \begin_inset Flex Code
13182 \begin_layout Plain Layout
13190 in the \SpecialChar LaTeX
13194 \begin_layout Description
13195 \begin_inset Flex Code
13198 \begin_layout Plain Layout
13205 \begin_inset Flex Code
13208 \begin_layout Plain Layout
13214 ] This provides extra space between paragraphs that have the same style.
13215 If you put other styles into an environment, each is separated with the
13217 \begin_inset Flex Code
13220 \begin_layout Plain Layout
13227 But the whole items of the environment are additionally separated with
13229 \begin_inset Flex Code
13232 \begin_layout Plain Layout
13239 Note that this is a
13244 \begin_layout Description
13245 \begin_inset Flex Code
13248 \begin_layout Plain Layout
13254 [FIXME] (Used only with XML-type formats.)
13257 \begin_layout Description
13258 \begin_inset Flex Code
13261 \begin_layout Plain Layout
13268 \begin_inset Flex Code
13271 \begin_layout Plain Layout
13280 \begin_inset space \thinspace{}
13284 \begin_inset Flex Code
13287 \begin_layout Plain Layout
13293 ] Usually \SpecialChar LyX
13294 does not allow you to leave a paragraph empty, since it would
13295 lead to empty \SpecialChar LaTeX
13297 There are some cases where this could be desirable however: in a letter
13298 template, the required fields can be provided as empty fields, so that
13299 people do not forget them; in some special classes, a style can be used
13300 as some kind of break, which does not contain actual text.
13303 \begin_layout Description
13304 \begin_inset Flex Code
13307 \begin_layout Plain Layout
13314 \begin_inset Flex Code
13317 \begin_layout Plain Layout
13323 ] The vertical space between the label and the text body.
13324 Only used for labels that are above the text body (
13325 \begin_inset Flex Code
13328 \begin_layout Plain Layout
13335 \begin_inset Newline newline
13339 \begin_inset Flex Code
13342 \begin_layout Plain Layout
13343 Centered_Top_Environment
13351 \begin_layout Description
13352 \begin_inset Flex Code
13355 \begin_layout Plain Layout
13362 \begin_inset Flex Code
13365 \begin_layout Plain Layout
13371 ] The name of the counter for automatic numbering.
13372 In order to have the counter appear with your label, you will need to reference
13374 \begin_inset Flex Code
13377 \begin_layout Plain Layout
13386 This will work with
13387 \begin_inset Flex Code
13390 \begin_layout Plain Layout
13397 \begin_inset Flex Code
13400 \begin_layout Plain Layout
13407 \begin_inset Flex Code
13410 \begin_layout Plain Layout
13417 \begin_inset Flex Code
13420 \begin_layout Plain Layout
13427 \begin_inset Newline newline
13435 \begin_inset Flex Code
13438 \begin_layout Plain Layout
13445 \begin_inset Flex Code
13448 \begin_layout Plain Layout
13454 , though this case is a bit complicated.
13455 Suppose you declare
13456 \begin_inset Quotes eld
13460 \begin_inset Flex Code
13463 \begin_layout Plain Layout
13464 LabelCounter myenum
13470 \begin_inset Quotes erd
13474 Then the actual counters used are
13475 \begin_inset Flex Code
13478 \begin_layout Plain Layout
13485 \begin_inset Flex Code
13488 \begin_layout Plain Layout
13495 \begin_inset Flex Code
13498 \begin_layout Plain Layout
13505 \begin_inset Flex Code
13508 \begin_layout Plain Layout
13514 , much as in \SpecialChar LaTeX
13516 These counters must all be declared separately.
13517 \begin_inset Newline newline
13521 \begin_inset CommandInset ref
13523 reference "subsec:Counters"
13527 for details on counters.
13530 \begin_layout Description
13531 \begin_inset Flex Code
13534 \begin_layout Plain Layout
13540 The font used for the label.
13542 \begin_inset CommandInset ref
13544 reference "subsec:Font-description"
13551 \begin_layout Description
13552 \begin_inset Flex Code
13555 \begin_layout Plain Layout
13562 \begin_inset Flex Code
13565 \begin_layout Plain Layout
13571 ] Text that indicates how far a label should be indented.
13574 \begin_layout Description
13575 \begin_inset Flex Code
13578 \begin_layout Plain Layout
13585 \begin_inset Flex Code
13588 \begin_layout Plain Layout
13594 ] Text that indicates the amount of horizontal space between the label and
13596 Only used for labels that are not above the text body.
13599 \begin_layout Description
13600 \begin_inset Flex Code
13603 \begin_layout Plain Layout
13610 \begin_inset Flex Code
13613 \begin_layout Plain Layout
13619 ] The string used for the label.
13621 \begin_inset Flex Code
13624 \begin_layout Plain Layout
13630 is set, this string can be contain the special formatting commands described
13632 \begin_inset CommandInset ref
13634 reference "subsec:Counters"
13641 \begin_layout Description
13642 \begin_inset Flex Code
13645 \begin_layout Plain Layout
13646 LabelStringAppendix
13652 \begin_inset Flex Code
13655 \begin_layout Plain Layout
13661 ] This is used inside the appendix instead of
13662 \begin_inset Newline newline
13666 \begin_inset Flex Code
13669 \begin_layout Plain Layout
13677 \begin_inset Flex Code
13680 \begin_layout Plain Layout
13687 \begin_inset Newline newline
13691 \begin_inset Flex Code
13694 \begin_layout Plain Layout
13695 LabelStringAppendix
13703 \begin_layout Description
13704 \begin_inset Flex Code
13707 \begin_layout Plain Layout
13713 [FIXME] (Used only with XML-type formats.)
13716 \begin_layout Description
13717 \begin_inset Flex Code
13720 \begin_layout Plain Layout
13727 \begin_inset Flex Code
13730 \begin_layout Plain Layout
13735 , Manual, Static, Above,
13736 \begin_inset Newline newline
13739 Centered, Sensitive, Enumerate,
13740 \begin_inset Newline newline
13743 Itemize, Bibliography
13752 \begin_layout Description
13753 \begin_inset Flex Code
13756 \begin_layout Plain Layout
13762 means the label is the very first word (up to the first real blank).
13763 Use protected spaces if you want more than one word as the label.
13767 \begin_layout Description
13768 \begin_inset Flex Code
13771 \begin_layout Plain Layout
13777 means the label is simply what is declared as
13778 \begin_inset Flex Code
13781 \begin_layout Plain Layout
13788 This will be displayed
13789 \begin_inset Quotes eld
13793 \begin_inset Quotes erd
13796 , at the beginning of the paragraph.
13798 \begin_inset Flex Code
13801 \begin_layout Plain Layout
13808 \begin_inset Flex Code
13811 \begin_layout Plain Layout
13817 , then it will be displayed only in the first paragraph of any sequence
13818 of paragraphs with the same
13819 \begin_inset Flex Code
13822 \begin_layout Plain Layout
13831 \begin_layout Description
13832 \begin_inset Flex Code
13835 \begin_layout Plain Layout
13842 \begin_inset space ~
13846 \begin_inset space ~
13850 \begin_inset Flex Code
13853 \begin_layout Plain Layout
13859 are special cases of
13860 \begin_inset Flex Code
13863 \begin_layout Plain Layout
13870 The label will be printed above the paragraph either at the beginning of
13871 the line or centered.
13874 \begin_layout Description
13875 \begin_inset Flex Code
13878 \begin_layout Plain Layout
13884 is a special case for the caption-labels
13885 \begin_inset Quotes eld
13889 \begin_inset Quotes erd
13893 \begin_inset Quotes eld
13897 \begin_inset Quotes erd
13901 \begin_inset Newline newline
13905 \begin_inset Flex Code
13908 \begin_layout Plain Layout
13914 means the (hardcoded) label string depends on the kind of float: It is
13915 hardcoded to be `FloatType N', where N is the value of the counter associated
13917 For the case that a caption is inserted outside of a float the
13918 \begin_inset Flex Code
13921 \begin_layout Plain Layout
13928 \begin_inset Quotes eld
13932 \begin_inset Quotes erd
13938 \begin_layout Description
13939 \begin_inset Flex Code
13942 \begin_layout Plain Layout
13948 produces the usual sort of enumeration labels.
13949 At present, it is hardcoded to use Arabic numerals, lowercase letters,
13950 small Roman numerals, and uppercase letters for the four possible depths.
13953 \begin_layout Description
13954 \begin_inset Flex Code
13957 \begin_layout Plain Layout
13963 produces various bullets at the different levels.
13964 It is also hardcoded.
13967 \begin_layout Description
13968 \begin_inset Flex Code
13971 \begin_layout Plain Layout
13977 should be used only with
13978 \begin_inset Flex Code
13981 \begin_layout Plain Layout
13982 LatexType BibEnvironment
13991 \begin_layout Description
13992 \begin_inset Flex Code
13995 \begin_layout Plain Layout
14001 Note that this will completely override any prior
14002 \begin_inset Flex Code
14005 \begin_layout Plain Layout
14011 declaration for this style.
14013 \begin_inset Quotes eld
14017 \begin_inset Flex Code
14020 \begin_layout Plain Layout
14027 \begin_inset Quotes erd
14032 \begin_inset CommandInset ref
14034 reference "subsec:I18n"
14038 for details on its use.
14041 \begin_layout Description
14042 \begin_inset Flex Code
14045 \begin_layout Plain Layout
14052 \begin_inset Flex Code
14055 \begin_layout Plain Layout
14061 ] The name of the corresponding \SpecialChar LaTeX
14063 Either the environment or command name.
14066 \begin_layout Description
14067 \begin_inset Flex Code
14070 \begin_layout Plain Layout
14077 \begin_inset Flex Code
14080 \begin_layout Plain Layout
14086 ] An optional parameter for the corresponding
14087 \begin_inset Flex Code
14090 \begin_layout Plain Layout
14097 This parameter cannot be changed from within \SpecialChar LyX
14099 \begin_inset Flex Code
14102 \begin_layout Plain Layout
14108 for customizable parameters).
14109 This will be output as is after all \SpecialChar LaTeX
14111 \begin_inset Flex Code
14114 \begin_layout Plain Layout
14123 \begin_layout Description
14124 \begin_inset Flex Code
14127 \begin_layout Plain Layout
14134 \begin_inset Flex Code
14137 \begin_layout Plain Layout
14142 , Command, Environment, Item_Environment,
14143 \begin_inset Newline newline
14146 List_Environment, Bib_Environment
14151 ] How the style should be translated into \SpecialChar LaTeX
14156 \begin_layout Plain Layout
14157 \begin_inset Flex Code
14160 \begin_layout Plain Layout
14166 is perhaps a bit misleading, since these rules apply to SGML classes, too.
14167 Visit the SGML class files for specific examples.
14176 \begin_layout Description
14177 \begin_inset Flex Code
14180 \begin_layout Plain Layout
14186 means nothing special.
14189 \begin_layout Description
14190 \begin_inset Flex Code
14193 \begin_layout Plain Layout
14200 \begin_inset Flex Code
14203 \begin_layout Plain Layout
14210 {\SpecialChar ldots
14219 \begin_layout Description
14220 \begin_inset Flex Code
14223 \begin_layout Plain Layout
14230 \begin_inset Flex Code
14233 \begin_layout Plain Layout
14240 }\SpecialChar ldots
14256 \begin_layout Description
14257 \begin_inset Flex Code
14260 \begin_layout Plain Layout
14267 \begin_inset Flex Code
14270 \begin_layout Plain Layout
14277 \begin_inset Flex Code
14280 \begin_layout Plain Layout
14288 is generated for each paragraph of this environment.
14292 \begin_layout Description
14293 \begin_inset Flex Code
14296 \begin_layout Plain Layout
14303 \begin_inset Flex Code
14306 \begin_layout Plain Layout
14313 \begin_inset Newline newline
14317 \begin_inset Flex Code
14320 \begin_layout Plain Layout
14326 is passed as an argument to the environment.
14327 \begin_inset Newline newline
14331 \begin_inset Flex Code
14334 \begin_layout Plain Layout
14340 can be defined in the
14341 \begin_inset Flex Noun
14344 \begin_layout Plain Layout
14345 Edit\SpecialChar menuseparator
14347 \begin_inset space ~
14358 \begin_layout Description
14359 \begin_inset Flex Code
14362 \begin_layout Plain Layout
14369 \begin_inset Flex Code
14372 \begin_layout Plain Layout
14378 but adds the necessary mandatory argument (the longest label) to the begin
14379 statement of the bibliography environment:
14380 \begin_inset Newline newline
14384 \begin_inset Flex Code
14387 \begin_layout Plain Layout
14390 begin{thebibliography}{99}
14396 It is therefore only useful for bibliography environments.
14397 The default longest label
14398 \begin_inset Quotes eld
14402 \begin_inset Quotes erd
14405 can be changed by the user in the paragraph settings of a bibliography
14409 \begin_layout Standard
14410 Putting the last few things together, the \SpecialChar LaTeX
14411 output will be either:
14414 \begin_layout LyX-Code
14417 LatexName[LatexParam]{\SpecialChar ldots
14421 \begin_layout Standard
14425 \begin_layout LyX-Code
14428 begin{LatexName}[LatexParam] \SpecialChar ldots
14434 \begin_layout Standard
14435 depending upon the \SpecialChar LaTeX
14440 \begin_layout Description
14441 \begin_inset Flex Code
14444 \begin_layout Plain Layout
14451 \begin_inset Flex Code
14454 \begin_layout Plain Layout
14460 ] A string that is put at the beginning of the style content.
14461 A line break in the output can be indicated by
14462 \begin_inset Flex Code
14465 \begin_layout Plain Layout
14474 \begin_layout Description
14475 \begin_inset Flex Code
14478 \begin_layout Plain Layout
14485 \begin_inset Flex Code
14488 \begin_layout Plain Layout
14494 ] If you put styles into environments, the different
14495 \begin_inset Flex Code
14498 \begin_layout Plain Layout
14504 are not simply added, but added with a factor
14505 \begin_inset Formula $\frac{4}{\mathrm{depth}+4}$
14509 Note that this parameter is also used when
14510 \begin_inset Flex Code
14513 \begin_layout Plain Layout
14520 \begin_inset Flex Code
14523 \begin_layout Plain Layout
14530 \begin_inset Flex Code
14533 \begin_layout Plain Layout
14540 Then it is added to the manual or dynamic margin.
14541 \begin_inset Newline newline
14545 \begin_inset Quotes eld
14549 \begin_inset Flex Code
14552 \begin_layout Plain Layout
14559 \begin_inset Quotes erd
14562 means that the paragraph is indented with the width of
14563 \begin_inset Quotes eld
14567 \begin_inset Flex Code
14570 \begin_layout Plain Layout
14577 \begin_inset Quotes erd
14580 in the normal font.
14581 You can get a negative width by prefixing the string with
14582 \begin_inset Quotes eld
14586 \begin_inset Flex Code
14589 \begin_layout Plain Layout
14596 \begin_inset Quotes erd
14600 This way was chosen so that the look is the same with each used screen
14604 \begin_layout Description
14605 \begin_inset Flex Code
14608 \begin_layout Plain Layout
14615 \begin_inset Flex Code
14618 \begin_layout Plain Layout
14623 , Manual, Dynamic, First_Dynamic, Right_Address_Box
14629 \begin_inset Newline newline
14632 The kind of margin that the style has on the left side.
14636 \begin_layout Description
14637 \begin_inset Flex Code
14640 \begin_layout Plain Layout
14646 just means a fixed margin.
14649 \begin_layout Description
14650 \begin_inset Flex Code
14653 \begin_layout Plain Layout
14659 means that the left margin depends on the string entered in the
14660 \begin_inset Flex Noun
14663 \begin_layout Plain Layout
14664 Edit\SpecialChar menuseparator
14666 \begin_inset space ~
14675 This is used to typeset nice lists without tabulators.
14678 \begin_layout Description
14679 \begin_inset Flex Code
14682 \begin_layout Plain Layout
14688 means that the margin depends on the size of the label.
14689 This is used for automatic enumerated headlines.
14690 It is obvious that the headline
14691 \begin_inset Quotes eld
14694 5.4.3.2.1 Very long headline
14695 \begin_inset Quotes erd
14698 must have a wider left margin (as wide as
14699 \begin_inset Quotes eld
14703 \begin_inset Quotes erd
14706 plus the space) than
14707 \begin_inset Quotes eld
14710 3.2 Very long headline
14711 \begin_inset Quotes erd
14715 \begin_inset Quotes eld
14719 \begin_inset Quotes erd
14722 are not able to do this.
14725 \begin_layout Description
14726 \begin_inset Flex Code
14729 \begin_layout Plain Layout
14735 is similar, but only the very first row of the paragraph is dynamic, while
14736 the others are static; this is used, for example, for descriptions.
14739 \begin_layout Description
14740 \begin_inset Flex Code
14743 \begin_layout Plain Layout
14749 means the margin is chosen in a way that the longest row of this paragraph
14750 fits to the right margin.
14751 This is used to typeset an address on the right edge of the page.
14755 \begin_layout Description
14756 \begin_inset Flex Code
14759 \begin_layout Plain Layout
14766 \begin_inset Flex Code
14769 \begin_layout Plain Layout
14778 \begin_inset space \thinspace{}
14782 \begin_inset Flex Code
14785 \begin_layout Plain Layout
14791 ] Whether fragile commands in this style should be
14792 \begin_inset Flex Code
14795 \begin_layout Plain Layout
14808 whether this command should itself be protected.)
14811 \begin_layout Description
14812 \begin_inset Flex Code
14815 \begin_layout Plain Layout
14822 \begin_inset Flex Code
14825 \begin_layout Plain Layout
14832 \begin_inset space \thinspace{}
14836 \begin_inset Flex Code
14839 \begin_layout Plain Layout
14847 ] Whether newlines are translated into \SpecialChar LaTeX
14849 \begin_inset Flex Code
14852 \begin_layout Plain Layout
14863 The translation can be switched off to allow more comfortable \SpecialChar LaTeX
14865 inside \SpecialChar LyX
14869 \begin_layout Description
14870 \begin_inset Flex Code
14873 \begin_layout Plain Layout
14880 \begin_inset Flex Code
14883 \begin_layout Plain Layout
14892 \begin_inset space \thinspace{}
14896 \begin_inset Flex Code
14899 \begin_layout Plain Layout
14905 ] If set to true, and if
14906 \begin_inset Flex Code
14909 \begin_layout Plain Layout
14916 \begin_inset Flex Code
14919 \begin_layout Plain Layout
14925 ) paragraphs are being indented, then the indentation of such a paragraph
14926 following one of this type will be suppressed.
14927 (So this will not affect the display of non-default paragraphs.)
14930 \begin_layout Description
14931 \begin_inset Flex Code
14934 \begin_layout Plain Layout
14941 \begin_inset Flex Code
14944 \begin_layout Plain Layout
14950 ] Name of a style that has replaced this style.
14951 This is used to rename a style, while keeping backward compatibility.
14954 \begin_layout Description
14955 \begin_inset Flex Code
14958 \begin_layout Plain Layout
14965 \begin_inset Flex Code
14968 \begin_layout Plain Layout
14975 \begin_inset space \thinspace{}
14979 \begin_inset Flex Code
14982 \begin_layout Plain Layout
14988 ] Determines whether consecutive pragraphs of the same type are treated
14989 as belonging together.
14990 This has the effect that the
14991 \begin_inset Flex Code
14994 \begin_layout Plain Layout
15000 is only printed once before such a group.
15001 By default, this is true for
15002 \begin_inset Flex Code
15005 \begin_layout Plain Layout
15012 \begin_inset Flex Code
15015 \begin_layout Plain Layout
15022 \begin_inset Flex Code
15025 \begin_layout Plain Layout
15031 and false for all other types.
15034 \begin_layout Description
15035 \begin_inset Flex Code
15038 \begin_layout Plain Layout
15045 \begin_inset Flex Code
15048 \begin_layout Plain Layout
15057 \begin_inset space \thinspace{}
15061 \begin_inset Flex Code
15064 \begin_layout Plain Layout
15070 ] Indicates that paragraphs will not be separated by an empty line in \SpecialChar LaTeX
15072 but only by a line break; together with
15073 \begin_inset Flex Code
15076 \begin_layout Plain Layout
15082 , this allows to emulate a plain text editor (like the ERT inset).
15085 \begin_layout Description
15086 \begin_inset Flex Code
15089 \begin_layout Plain Layout
15096 \begin_inset Flex Code
15099 \begin_layout Plain Layout
15105 ] The indent of the very first line of a paragraph.
15107 \begin_inset Newline newline
15111 \begin_inset Flex Code
15114 \begin_layout Plain Layout
15120 will be fixed for a certain style.
15121 The exception is the default style, since the indentation for these paragraphs
15122 can be prohibited with
15123 \begin_inset Flex Code
15126 \begin_layout Plain Layout
15134 \begin_inset Flex Code
15137 \begin_layout Plain Layout
15143 style paragraphs inside environments use the
15144 \begin_inset Flex Code
15147 \begin_layout Plain Layout
15153 of the environment, not their native one.
15155 \begin_inset Flex Code
15158 \begin_layout Plain Layout
15164 paragraphs inside an enumeration are not indented.
15167 \begin_layout Description
15168 \begin_inset Flex Code
15171 \begin_layout Plain Layout
15178 \begin_inset Flex Code
15181 \begin_layout Plain Layout
15187 ] The vertical space between two paragraphs of this style.
15190 \begin_layout Description
15191 \begin_inset Flex Code
15194 \begin_layout Plain Layout
15201 \begin_inset Flex Code
15204 \begin_layout Plain Layout
15211 allows the user to choose either
15212 \begin_inset Quotes eld
15216 \begin_inset Quotes erd
15220 \begin_inset Quotes eld
15224 \begin_inset Quotes erd
15227 to separate paragraphs.
15229 \begin_inset Quotes eld
15233 \begin_inset Quotes erd
15237 \begin_inset Flex Code
15240 \begin_layout Plain Layout
15248 \begin_inset Quotes eld
15252 \begin_inset Quotes erd
15256 \begin_inset Flex Code
15259 \begin_layout Plain Layout
15265 is ignored and all paragraphs are separated by the
15266 \begin_inset Flex Code
15269 \begin_layout Plain Layout
15276 The vertical space is calculated with
15277 \begin_inset Flex Code
15280 \begin_layout Plain Layout
15282 \begin_inset space ~
15291 \begin_inset Flex Code
15294 \begin_layout Plain Layout
15300 is the height of a row with the normal font.
15301 This way, the look stays the same with different screen fonts.
15304 \begin_layout Description
15305 \begin_inset Flex Code
15308 \begin_layout Plain Layout
15315 \begin_inset Flex Code
15318 \begin_layout Plain Layout
15327 \begin_inset space \thinspace{}
15331 \begin_inset Flex Code
15334 \begin_layout Plain Layout
15340 ] Whether the contents of this paragraph should be output in raw form, meaning
15341 without special translations that \SpecialChar LaTeX
15345 \begin_layout Description
15346 \begin_inset Flex Code
15349 \begin_layout Plain Layout
15356 \begin_inset Flex Code
15359 \begin_layout Plain Layout
15369 Defines individual characters that should be output in raw form, meaning
15370 without special translations that \SpecialChar LaTeX
15374 \begin_layout Description
15375 \begin_inset Flex Code
15378 \begin_layout Plain Layout
15384 Information to be included in the \SpecialChar LaTeX
15385 preamble when this style is used.
15386 Used to define macros, load packages, etc., required by this particular
15389 \begin_inset Quotes eld
15393 \begin_inset Flex Code
15396 \begin_layout Plain Layout
15403 \begin_inset Quotes erd
15409 \begin_layout Description
15410 \begin_inset Flex Code
15413 \begin_layout Plain Layout
15420 \begin_inset Flex Code
15423 \begin_layout Plain Layout
15429 ] The prefix to use when creating labels referring to paragraphs of this
15431 This allows the use of formatted references.
15434 \begin_layout Description
15435 \begin_inset Flex Code
15438 \begin_layout Plain Layout
15445 \begin_inset Flex Code
15448 \begin_layout Plain Layout
15454 ] Whether the style requires the feature
15455 \begin_inset Flex Code
15458 \begin_layout Plain Layout
15465 \begin_inset CommandInset ref
15467 reference "chap:List-of-functions"
15471 for the list of features).
15472 If you require a package with specific options, you can additionally use
15474 \begin_inset Flex Code
15477 \begin_layout Plain Layout
15483 as a general text class parameter (see
15484 \begin_inset CommandInset ref
15486 reference "subsec:General-text-class"
15493 \begin_layout Description
15494 \begin_inset Flex Code
15497 \begin_layout Plain Layout
15504 \begin_inset Flex Code
15507 \begin_layout Plain Layout
15516 \begin_inset Flex Code
15519 \begin_layout Plain Layout
15525 ] Resets the \SpecialChar LaTeX
15526 arguments of this style (as defined via the
15527 \begin_inset Flex Code
15530 \begin_layout Plain Layout
15537 This is useful if you have copied a style via
15538 \begin_inset Flex Code
15541 \begin_layout Plain Layout
15547 , but you do not want to inherit its (required and optional) arguments.
15548 \change_inserted 2089657418 1476488475
15552 \begin_layout Description
15554 \change_inserted 2089657418 1476488475
15555 \begin_inset Flex Code
15558 \begin_layout Plain Layout
15560 \change_inserted 2089657418 1476488475
15567 \begin_inset Flex Code
15570 \begin_layout Plain Layout
15572 \change_inserted 2089657418 1476488475
15581 \begin_inset Flex Code
15584 \begin_layout Plain Layout
15586 \change_inserted 2089657418 1476488475
15592 ] Resumes a counter that is usually reset at each new sequence of layouts.
15593 This is currently only useful when
15594 \begin_inset Flex Code
15597 \begin_layout Plain Layout
15599 \change_inserted 2089657418 1476488475
15606 \begin_inset Flex Code
15609 \begin_layout Plain Layout
15611 \change_inserted 2089657418 1476488475
15622 \begin_layout Description
15623 \begin_inset Flex Code
15626 \begin_layout Plain Layout
15633 \begin_inset Flex Code
15636 \begin_layout Plain Layout
15642 ] A string that is put at the end of the layout content.
15643 A line break in the output can be indicated by
15644 \begin_inset Flex Code
15647 \begin_layout Plain Layout
15656 \begin_layout Description
15657 \begin_inset Flex Code
15660 \begin_layout Plain Layout
15667 \begin_inset Flex Code
15670 \begin_layout Plain Layout
15677 \begin_inset Flex Code
15680 \begin_layout Plain Layout
15689 \begin_layout Description
15690 \begin_inset Flex Code
15693 \begin_layout Plain Layout
15700 \begin_inset Flex Code
15703 \begin_layout Plain Layout
15712 \begin_inset Flex Code
15715 \begin_layout Plain Layout
15722 \begin_inset Flex Code
15725 \begin_layout Plain Layout
15732 \begin_inset Flex Code
15735 \begin_layout Plain Layout
15737 \begin_inset space ~
15745 ] This defines what the default spacing should be in the style.
15747 \begin_inset Flex Code
15750 \begin_layout Plain Layout
15757 \begin_inset Flex Code
15760 \begin_layout Plain Layout
15767 \begin_inset Flex Code
15770 \begin_layout Plain Layout
15776 correspond respectively to a multiplier value of 1, 1.25 and 1.667.
15777 If you specify the argument
15778 \begin_inset Flex Code
15781 \begin_layout Plain Layout
15787 , then you must also provide a value argument which will be the actual multiplie
15789 Note that, contrary to other parameters,
15790 \begin_inset Flex Code
15793 \begin_layout Plain Layout
15799 implies the generation of specific \SpecialChar LaTeX
15800 code, using the \SpecialChar LaTeX
15804 \begin_inset Flex Code
15807 \begin_layout Plain Layout
15816 \begin_layout Description
15817 \begin_inset Flex Code
15820 \begin_layout Plain Layout
15827 \begin_inset Flex Code
15830 \begin_layout Plain Layout
15837 \begin_inset space \thinspace{}
15841 \begin_inset Flex Code
15844 \begin_layout Plain Layout
15852 ] Allow spell-checking paragraphs of this style.
15854 \change_inserted 2089657418 1476488264
15858 \begin_layout Description
15860 \change_inserted 2089657418 1476488264
15861 \begin_inset Flex Code
15864 \begin_layout Plain Layout
15866 \change_inserted 2089657418 1476488264
15873 \begin_inset Flex Code
15876 \begin_layout Plain Layout
15878 \change_inserted 2089657418 1476488264
15887 \begin_inset Flex Code
15890 \begin_layout Plain Layout
15892 \change_inserted 2089657418 1476488264
15898 ] Steps the master counter of a given counter at the beginning of a new
15899 sequence of layouts.
15900 This is currently only useful when
15901 \begin_inset Flex Code
15904 \begin_layout Plain Layout
15906 \change_inserted 2089657418 1476488264
15913 \begin_inset Flex Code
15916 \begin_layout Plain Layout
15918 \change_inserted 2089657418 1476488264
15929 \begin_layout Description
15930 \begin_inset Flex Code
15933 \begin_layout Plain Layout
15939 The font used for the text body .
15941 \begin_inset CommandInset ref
15943 reference "subsec:Font-description"
15950 \begin_layout Description
15951 \begin_inset Flex Code
15954 \begin_layout Plain Layout
15963 \begin_inset Flex Code
15966 \begin_layout Plain Layout
15976 The level of the style in the table of contents.
15977 This is used for automatic numbering of section headings.
15980 \begin_layout Description
15981 \begin_inset Flex Code
15984 \begin_layout Plain Layout
15993 \begin_inset Flex Code
15996 \begin_layout Plain Layout
16007 \begin_inset Flex Code
16010 \begin_layout Plain Layout
16017 \begin_inset Flex Code
16020 \begin_layout Plain Layout
16026 ] This tag determines whether the first line indentation of this paragraph
16027 can be toggled via the Paragraph settings dialog.
16031 \begin_inset Flex Code
16034 \begin_layout Plain Layout
16044 is set, indentation can be toggled if the document settings use
16045 \begin_inset Quotes eld
16049 \begin_inset Quotes erd
16052 paragraph style, with
16053 \begin_inset Flex Code
16056 \begin_layout Plain Layout
16062 , indentation can always be toggled, notwithstanding the document settings,
16064 \begin_inset Flex Code
16067 \begin_layout Plain Layout
16073 , indentation can never be toggled.
16076 \begin_layout Description
16077 \begin_inset Flex Code
16080 \begin_layout Plain Layout
16087 \begin_inset Flex Code
16090 \begin_layout Plain Layout
16096 ] The vertical space with which the very first of a chain of paragraphs
16097 with this style is separated from the previous paragraph.
16098 If the previous paragraph has another style, the separations are not simply
16099 added, but the maximum is taken.
16102 \begin_layout Subsection
16103 \begin_inset CommandInset label
16109 Internationalization of Paragraph Styles
16112 \begin_layout Standard
16114 has long supported internationalization of layout information, but, until
16115 version 2.0, this applied only to the user interface and not to, say, PDF
16117 Thus, French authors were forced to resort to ugly hacks if they wanted
16122 1' instead of `Theorem 1'.
16123 Thanks to Georg Baum, that is no longer the case.
16126 \begin_layout Standard
16128 \begin_inset Flex Code
16131 \begin_layout Plain Layout
16137 defines text that is to appear in the typeset document, it may use
16138 \begin_inset Flex Code
16141 \begin_layout Plain Layout
16148 \begin_inset Flex Code
16151 \begin_layout Plain Layout
16157 to support non-English and even multi-language documents correctly.
16158 The following excerpt (from the
16159 \begin_inset Flex Code
16162 \begin_layout Plain Layout
16168 file) shows how this works:
16171 \begin_layout LyX-Code
16176 \begin_layout LyX-Code
16179 theoremstyle{remark}
16182 \begin_layout LyX-Code
16185 newtheorem{claim}[thm]{
16192 \begin_layout LyX-Code
16196 \begin_layout LyX-Code
16200 \begin_layout LyX-Code
16205 claimname}{_(Claim)}
16208 \begin_layout LyX-Code
16212 \begin_layout LyX-Code
16216 \begin_layout LyX-Code
16225 claimname}{_(Claim)}}
16228 \begin_layout LyX-Code
16233 \begin_layout Standard
16234 In principle, any legal \SpecialChar LaTeX
16236 \begin_inset Flex Code
16239 \begin_layout Plain Layout
16246 \begin_inset Flex Code
16249 \begin_layout Plain Layout
16255 tags, but in practice they will typically look as they do here.
16256 The key to correct translation of the typeset text is the definition of
16257 the \SpecialChar LaTeX
16259 \begin_inset Flex Code
16262 \begin_layout Plain Layout
16271 \begin_inset Flex Code
16274 \begin_layout Plain Layout
16286 \begin_layout Standard
16288 \begin_inset Flex Code
16291 \begin_layout Plain Layout
16297 tag provides for internationalization based upon the overall language of
16299 The contents of the tag will be included in the preamble, just as with
16301 \begin_inset Flex Code
16304 \begin_layout Plain Layout
16311 What makes it special is the use of the
16312 \begin_inset Quotes eld
16316 \begin_inset Quotes erd
16320 \begin_inset Flex Code
16323 \begin_layout Plain Layout
16329 , which will be replaced, when \SpecialChar LyX
16330 produces \SpecialChar LaTeX
16331 output, with the translation of
16332 its argument into the document language.
16335 \begin_layout Standard
16337 \begin_inset Flex Code
16340 \begin_layout Plain Layout
16346 tag is more complex, since it is meant to provide support for multi-language
16347 documents and so offers an interface to the
16348 \begin_inset Flex Code
16351 \begin_layout Plain Layout
16358 Its contents will be added to the preamble once for each language that
16359 appears in the document.
16360 In this case, the argument to
16361 \begin_inset Flex Code
16364 \begin_layout Plain Layout
16370 will be replaced with its translation into the language in question; the
16372 \begin_inset Flex Code
16375 \begin_layout Plain Layout
16381 is replaced by the language name (as used by the babel package).
16384 \begin_layout Standard
16385 A German document that also included a French section would thus have the
16386 following in the preamble:
16389 \begin_layout LyX-Code
16398 claimname}{Affirmation}}
16399 \begin_inset Newline newline
16410 claimname}{Behauptung}}
16411 \begin_inset Newline newline
16418 claimname}{Behauptung}
16421 \begin_layout Standard
16424 \begin_inset Flex Code
16427 \begin_layout Plain Layout
16433 will then conspire to produce the correct text in the output.
16436 \begin_layout Standard
16437 One important point to note here is that the translations are provided by
16439 itself, through the file
16440 \begin_inset Flex Code
16443 \begin_layout Plain Layout
16450 This means, in effect, that
16451 \begin_inset Flex Code
16454 \begin_layout Plain Layout
16461 \begin_inset Flex Code
16464 \begin_layout Plain Layout
16470 are really only of use in layout files that are provided with \SpecialChar LyX
16472 entered in user-created layout files will not be seen by \SpecialChar LyX
16473 's internationalizatio
16474 n routines unless the
16475 \begin_inset Flex Code
16478 \begin_layout Plain Layout
16484 file is modified accordingly.
16485 That said, however, any layout created with the intention that it will
16486 be included with \SpecialChar LyX
16487 should use these tags where appropriate.
16488 Please note that the paragraph style translations provided by \SpecialChar LyX
16490 change with a minor update (e.
16491 \begin_inset space \thinspace{}
16495 \begin_inset space \space{}
16498 from version 2.1.x to 2.1.y).
16499 It is however quite likely that a major update (e.
16500 \begin_inset space \thinspace{}
16504 \begin_inset space \space{}
16507 from 2.0.x to 2.1.y) will introduce new translations or corrections.
16510 \begin_layout Subsection
16512 \begin_inset CommandInset label
16514 name "subsec:Floats"
16521 \begin_layout Standard
16522 It is necessary to define the floats (
16523 \begin_inset Flex Noun
16526 \begin_layout Plain Layout
16533 \begin_inset Flex Noun
16536 \begin_layout Plain Layout
16542 , \SpecialChar ldots
16543 ) in the text class itself.
16544 Standard floats are included in the file
16545 \begin_inset Flex Code
16548 \begin_layout Plain Layout
16554 , so you may have to do no more than add
16557 \begin_layout LyX-Code
16558 Input stdfloats.inc
16561 \begin_layout Standard
16562 to your layout file.
16563 If you want to implement a text class that proposes some other float types
16564 (like the AGU class bundled with \SpecialChar LyX
16565 ), the information below will hopefully
16569 \begin_layout Description
16570 \begin_inset Flex Code
16573 \begin_layout Plain Layout
16580 \begin_inset Flex Code
16583 \begin_layout Plain Layout
16589 =!htbpH] Allowed placement options for this float type.
16590 The value is a string of placement characters.
16591 Possible characters include:
16596 \begin_inset Quotes eld
16600 \begin_inset Quotes erd
16608 \begin_inset Quotes eld
16612 \begin_inset Quotes erd
16620 \begin_inset Quotes eld
16624 \begin_inset Quotes erd
16632 \begin_inset Quotes eld
16636 \begin_inset Quotes erd
16644 \begin_inset Quotes eld
16648 \begin_inset Quotes erd
16656 \begin_inset Quotes eld
16660 \begin_inset Quotes erd
16664 The order of the characters in the string does not matter.
16665 If no placement options are allowed, use the string
16672 \begin_layout Description
16673 \begin_inset Flex Code
16676 \begin_layout Plain Layout
16683 \begin_inset Flex Code
16686 \begin_layout Plain Layout
16695 \begin_inset space \thinspace{}
16701 \begin_inset Flex Code
16704 \begin_layout Plain Layout
16714 ] Defines whether the float allows to be rotated via the \SpecialChar LaTeX
16721 \begin_inset Flex Code
16724 \begin_layout Plain Layout
16730 if the float does not support this feature.
16733 \begin_layout Description
16734 \begin_inset Flex Code
16737 \begin_layout Plain Layout
16744 \begin_inset Flex Code
16747 \begin_layout Plain Layout
16756 \begin_inset space \thinspace{}
16762 \begin_inset Flex Code
16765 \begin_layout Plain Layout
16775 ] Defines whether the float has a starred variant that spans columns in
16776 a two column paragraph.
16778 \begin_inset Flex Code
16781 \begin_layout Plain Layout
16787 if the float does not support this feature.
16790 \begin_layout Description
16791 \begin_inset Flex Code
16794 \begin_layout Plain Layout
16801 \begin_inset Flex Code
16804 \begin_layout Plain Layout
16811 \begin_inset Quotes erd
16815 \begin_inset Quotes erd
16818 ] The file name extension of an auxiliary file for the list of figures (or
16821 writes the captions to this file.
16824 \begin_layout Description
16825 \begin_inset Flex Code
16828 \begin_layout Plain Layout
16835 \begin_inset Flex Code
16838 \begin_layout Plain Layout
16845 \begin_inset Quotes erd
16849 \begin_inset Quotes erd
16852 ] The string that will be used in the menus and also for the caption.
16853 This is translated to the current language if babel is used.
16856 \begin_layout Description
16857 \begin_inset Flex Code
16860 \begin_layout Plain Layout
16866 These tags control the XHTML output.
16868 \begin_inset CommandInset ref
16870 reference "sec:Tags-for-XHTML"
16877 \begin_layout Description
16878 \begin_inset Flex Code
16881 \begin_layout Plain Layout
16890 \begin_inset Flex Code
16893 \begin_layout Plain Layout
16902 \begin_inset space \thinspace{}
16906 \begin_inset Flex Code
16909 \begin_layout Plain Layout
16915 ] Indicates whether the float is already defined in the document class or
16916 if instead the \SpecialChar LaTeX
16918 \begin_inset Flex Code
16921 \begin_layout Plain Layout
16927 needs to be loaded to define it on-the-fly.
16929 \begin_inset Flex Code
16932 \begin_layout Plain Layout
16939 \begin_inset Flex Code
16942 \begin_layout Plain Layout
16949 It should be set to
16950 \begin_inset Flex Code
16953 \begin_layout Plain Layout
16959 if the float is already defined by the \SpecialChar LaTeX
16963 \begin_layout Description
16964 \begin_inset Flex Code
16967 \begin_layout Plain Layout
16974 \begin_inset Flex Code
16977 \begin_layout Plain Layout
16984 \begin_inset Quotes erd
16988 \begin_inset Quotes erd
16991 ] The command used to generate a list of floats of this type; the leading
17000 \begin_inset Flex Code
17003 \begin_layout Plain Layout
17009 is false, since there is no standard way to generate this command.
17011 \begin_inset Flex Code
17014 \begin_layout Plain Layout
17020 is true, since in that case there is a standard way to define the command.
17023 \begin_layout Description
17024 \begin_inset Flex Code
17027 \begin_layout Plain Layout
17034 \begin_inset Flex Code
17037 \begin_layout Plain Layout
17044 \begin_inset Quotes erd
17048 \begin_inset Quotes erd
17051 ] A title for a list of floats of this kind (list of figures, tables, or
17053 It is used for the screen label within \SpecialChar LyX
17054 , it is used by \SpecialChar LaTeX
17056 it is used as the title in the XHTML output.
17057 It will be translated to the document language.
17060 \begin_layout Description
17061 \begin_inset Flex Code
17064 \begin_layout Plain Layout
17071 \begin_inset Flex Code
17074 \begin_layout Plain Layout
17081 \begin_inset Quotes erd
17085 \begin_inset Quotes erd
17088 ] This (optional) argument determines whether floats of this class will
17089 be numbered within some sectional unit of the document.
17091 \begin_inset Flex Code
17094 \begin_layout Plain Layout
17101 \begin_inset Quotes eld
17105 \begin_inset Flex Code
17108 \begin_layout Plain Layout
17115 \begin_inset Quotes erd
17118 , the floats will be numbered within chapters.
17122 \begin_layout Description
17123 \begin_inset Flex Code
17126 \begin_layout Plain Layout
17133 \begin_inset Flex Code
17136 \begin_layout Plain Layout
17143 \begin_inset Quotes erd
17147 \begin_inset Quotes erd
17150 ] The default placement for the given class of floats.
17151 The string should be as in standard \SpecialChar LaTeX
17153 \begin_inset Flex Code
17156 \begin_layout Plain Layout
17163 \begin_inset Flex Code
17166 \begin_layout Plain Layout
17173 \begin_inset Flex Code
17176 \begin_layout Plain Layout
17183 \begin_inset Flex Code
17186 \begin_layout Plain Layout
17192 for top, bottom, page, and here, respectively.
17196 \begin_layout Plain Layout
17197 Note that the order of these letters in the string is irrelevant, like in
17204 On top of that there is a new type,
17205 \begin_inset Flex Code
17208 \begin_layout Plain Layout
17214 , which does not really correspond to a float, since it means: put it
17215 \begin_inset Quotes eld
17219 \begin_inset Quotes erd
17223 Note however that the
17224 \begin_inset Flex Code
17227 \begin_layout Plain Layout
17233 specifier is special and, because of implementation details, cannot be
17234 used in non-built in float types.
17235 If you do not understand what this means, just use
17236 \begin_inset Quotes eld
17240 \begin_inset Flex Code
17243 \begin_layout Plain Layout
17250 \begin_inset Quotes erd
17256 \begin_layout Description
17257 \begin_inset Flex Code
17260 \begin_layout Plain Layout
17267 \begin_inset Flex Code
17270 \begin_layout Plain Layout
17276 ] The prefix to use when creating labels referring to floats of this type.
17277 This allows the use of formatted references.
17278 Note that you can remove any
17279 \begin_inset Flex Code
17282 \begin_layout Plain Layout
17288 set by a copied style by using the special value
17289 \begin_inset Quotes eld
17293 \begin_inset Quotes erd
17296 , which must be all caps.
17299 \begin_layout Description
17300 \begin_inset Flex Code
17303 \begin_layout Plain Layout
17310 \begin_inset Flex Code
17313 \begin_layout Plain Layout
17320 \begin_inset Quotes erd
17324 \begin_inset Quotes erd
17327 ] The style used when defining the float using
17328 \begin_inset Flex Code
17331 \begin_layout Plain Layout
17342 \begin_layout Description
17343 \begin_inset Flex Code
17346 \begin_layout Plain Layout
17353 \begin_inset Flex Code
17356 \begin_layout Plain Layout
17363 \begin_inset Quotes erd
17367 \begin_inset Quotes erd
17371 \begin_inset Quotes eld
17375 \begin_inset Quotes erd
17378 of the new class of floats, like program or algorithm.
17379 After the appropriate
17380 \begin_inset Flex Code
17383 \begin_layout Plain Layout
17392 \begin_inset Flex Code
17395 \begin_layout Plain Layout
17404 \begin_inset Flex Code
17407 \begin_layout Plain Layout
17418 \begin_layout Description
17419 \begin_inset Flex Code
17422 \begin_layout Plain Layout
17429 \begin_inset Flex Code
17432 \begin_layout Plain Layout
17439 \begin_inset space \thinspace{}
17443 \begin_inset Flex Code
17446 \begin_layout Plain Layout
17454 ] Specifies whether this float is defined using the \SpecialChar LaTeX
17456 \begin_inset Flex Code
17459 \begin_layout Plain Layout
17465 , either by the class file, another package or on-the-fly by \SpecialChar LyX
17469 \begin_layout Standard
17470 Note that defining a float with type
17471 \begin_inset Flex Code
17474 \begin_layout Plain Layout
17482 automatically defines the corresponding counter with name
17483 \begin_inset Flex Code
17486 \begin_layout Plain Layout
17497 \begin_layout Subsection
17498 Flex insets and InsetLayout
17499 \begin_inset CommandInset label
17501 name "subsec:Flex-insets-and"
17508 \begin_layout Standard
17509 Flex insets come in three different kinds:
17512 \begin_layout Itemize
17514 \begin_inset Flex Code
17517 \begin_layout Plain Layout
17523 ): These define semantic markup corresponding to such \SpecialChar LaTeX
17525 \begin_inset Flex Code
17528 \begin_layout Plain Layout
17537 \begin_inset Flex Code
17540 \begin_layout Plain Layout
17551 \begin_layout Itemize
17553 \begin_inset Flex Code
17556 \begin_layout Plain Layout
17562 ): These can be used to define custom collapsible insets, similar to \SpecialChar TeX
17564 footnote, and the like.
17565 An obvious example is an endnote inset, which is defined in the
17566 \begin_inset Flex Code
17569 \begin_layout Plain Layout
17578 \begin_layout Itemize
17580 \begin_inset Flex Code
17583 \begin_layout Plain Layout
17589 ): For use with DocBook classes.
17592 \begin_layout Standard
17593 Flex insets are defined using the
17594 \begin_inset Flex Code
17597 \begin_layout Plain Layout
17603 tag, which shall be explained in a moment.
17606 \begin_layout Standard
17608 \begin_inset Flex Code
17611 \begin_layout Plain Layout
17617 tag also serves another function: It can be used to customize the general
17618 layout of many different types of insets.
17620 \begin_inset Flex Code
17623 \begin_layout Plain Layout
17629 can be used to customize the layout parameters for footnotes, marginal
17630 notes, note insets, \SpecialChar TeX
17631 code (ERT) insets, branches, listings, indexes, boxes,
17632 tables, algorithms, URLs, and captions, as well as to define Flex insets.
17635 \begin_layout Standard
17637 \begin_inset Flex Code
17640 \begin_layout Plain Layout
17646 definition must begin with a line of the form:
17649 \begin_layout LyX-Code
17653 \begin_layout Standard
17655 \begin_inset Flex Code
17658 \begin_layout Plain Layout
17664 indicates the inset whose layout is being defined, and here there are four
17668 \begin_layout Enumerate
17669 The layout for a pre-existing inset is being modified.
17670 In this case, can be
17671 \begin_inset Flex Code
17674 \begin_layout Plain Layout
17680 any one of the following:
17681 \begin_inset Flex Code
17684 \begin_layout Plain Layout
17691 \begin_inset Flex Code
17694 \begin_layout Plain Layout
17701 \begin_inset Flex Code
17704 \begin_layout Plain Layout
17711 \begin_inset Flex Code
17714 \begin_layout Plain Layout
17721 \begin_inset Flex Code
17724 \begin_layout Plain Layout
17731 \begin_inset Flex Code
17734 \begin_layout Plain Layout
17741 \begin_inset Flex Code
17744 \begin_layout Plain Layout
17751 \begin_inset Flex Code
17754 \begin_layout Plain Layout
17761 \begin_inset Flex Code
17764 \begin_layout Plain Layout
17771 \begin_inset Flex Code
17774 \begin_layout Plain Layout
17781 \begin_inset Flex Code
17784 \begin_layout Plain Layout
17791 \begin_inset Flex Code
17794 \begin_layout Plain Layout
17801 \begin_inset Flex Code
17804 \begin_layout Plain Layout
17811 \begin_inset Flex Code
17814 \begin_layout Plain Layout
17821 \begin_inset Flex Code
17824 \begin_layout Plain Layout
17831 \begin_inset Flex Code
17834 \begin_layout Plain Layout
17841 \begin_inset Flex Code
17844 \begin_layout Plain Layout
17851 \begin_inset Flex Code
17854 \begin_layout Plain Layout
17861 \begin_inset Flex Code
17864 \begin_layout Plain Layout
17871 \begin_inset Flex Code
17874 \begin_layout Plain Layout
17883 \begin_layout Enumerate
17884 The layout for a Flex inset is being defined.
17886 \begin_inset Flex Code
17889 \begin_layout Plain Layout
17895 must be of the form
17896 \begin_inset Quotes eld
17900 \begin_inset Flex Code
17903 \begin_layout Plain Layout
17910 \begin_inset Quotes erd
17914 \begin_inset Flex Code
17917 \begin_layout Plain Layout
17923 may be be any valid identifier not used by a pre-existing Flex inset.
17924 The identifier may include spaces, but in that case the whole thing must
17925 be wrapped in quotes.
17926 Note that the definition of a flex inset
17931 \begin_inset Flex Code
17934 \begin_layout Plain Layout
17940 entry, declaring which type of inset it defines.
17943 \begin_layout Enumerate
17944 The layout for user specific branch is being defined.
17946 \begin_inset Flex Code
17949 \begin_layout Plain Layout
17955 must be of the form
17956 \begin_inset Quotes eld
17960 \begin_inset Flex Code
17963 \begin_layout Plain Layout
17970 \begin_inset Quotes erd
17974 \begin_inset Flex Code
17977 \begin_layout Plain Layout
17983 may be be any valid identifier of branch defined in user's document.
17984 The identifier may include spaces, but in that case the whole thing must
17985 be wrapped in quotes.
17986 The main purpose of this feature is to allow \SpecialChar LaTeX
17987 wrapping around specific
17988 branches as user needs.
17991 \begin_layout Enumerate
17992 The layout of a user (or class) specific caption is being defined.
17994 \begin_inset Flex Code
17997 \begin_layout Plain Layout
18003 must be of the form
18004 \begin_inset Quotes eld
18008 \begin_inset Flex Code
18011 \begin_layout Plain Layout
18018 \begin_inset Quotes erd
18022 \begin_inset Flex Code
18025 \begin_layout Plain Layout
18031 specifies the name of the caption as it appears in the menu.
18032 Have a look at the standard caption (
18033 \begin_inset Flex Code
18036 \begin_layout Plain Layout
18042 ), the specific captions of the KOMA-Script classes (
18043 \begin_inset Flex Code
18046 \begin_layout Plain Layout
18053 \begin_inset Flex Code
18056 \begin_layout Plain Layout
18065 \begin_inset space ~
18071 \begin_inset Flex Code
18074 \begin_layout Plain Layout
18080 ) for applications.
18083 \begin_layout Standard
18085 \begin_inset Flex Code
18088 \begin_layout Plain Layout
18094 definition can contain the following entries:
18097 \begin_layout Description
18099 \change_inserted 2047637253 1483963036
18100 \begin_inset Flex Code
18103 \begin_layout Plain Layout
18105 \change_inserted 2047637253 1483900123
18112 \begin_inset Flex Code
18115 \begin_layout Plain Layout
18117 \change_inserted 2047637253 1483962897
18123 =""] This inset will appear in the table of contents of the given type.
18124 An empty string disables.
18125 See also the OutlinerName and the IsTocCaption commands.
18126 This is only implemented for Flex insets.
18130 \begin_layout Description
18131 \begin_inset Flex Code
18134 \begin_layout Plain Layout
18141 \begin_inset Flex Code
18144 \begin_layout Plain Layout
18150 ] Defines argument number of a command\SpecialChar breakableslash
18151 environment associated with the current
18153 The definition must end with
18154 \begin_inset Flex Code
18157 \begin_layout Plain Layout
18165 \begin_inset CommandInset ref
18167 reference "subsec:Paragraph-Styles"
18174 \begin_layout Description
18175 \begin_inset Flex Code
18178 \begin_layout Plain Layout
18184 Preamble for changing language commands; see
18185 \begin_inset CommandInset ref
18187 reference "subsec:I18n"
18194 \begin_layout Description
18195 \begin_inset Flex Code
18198 \begin_layout Plain Layout
18205 \begin_inset Flex Code
18208 \begin_layout Plain Layout
18214 ] The color for the inset's background.
18216 \begin_inset CommandInset ref
18218 reference "chap:Names-of-colors"
18222 for a list of the available color names.
18225 \begin_layout Description
18226 \begin_inset Flex Code
18229 \begin_layout Plain Layout
18236 \begin_inset Flex Code
18239 \begin_layout Plain Layout
18248 \begin_inset space \thinspace{}
18252 \begin_inset Flex Code
18255 \begin_layout Plain Layout
18261 ] Whether to use the content of the inset as the label, when the inset is
18266 \begin_layout Description
18267 \begin_inset Flex Code
18270 \begin_layout Plain Layout
18277 \begin_inset Flex Code
18280 \begin_layout Plain Layout
18286 ] As with paragraph styles, see
18287 \begin_inset CommandInset ref
18289 reference "subsec:Paragraph-Styles"
18294 Note that you need to specify the complete type, e.
18295 \begin_inset space \thinspace{}
18299 \begin_inset space ~
18303 \begin_inset Flex Code
18306 \begin_layout Plain Layout
18307 CopyStyle Flex:<name>
18315 \begin_layout Description
18316 \begin_inset Flex Code
18319 \begin_layout Plain Layout
18326 \begin_inset Flex Code
18329 \begin_layout Plain Layout
18338 \begin_inset space \thinspace{}
18342 \begin_inset Flex Code
18345 \begin_layout Plain Layout
18351 ] Indicates whether the user may employ the Paragraph Settings dialog to
18352 customize the paragraph.
18355 \begin_layout Description
18356 \begin_inset Flex Code
18359 \begin_layout Plain Layout
18366 \begin_inset Flex Code
18369 \begin_layout Plain Layout
18376 \begin_inset Flex Code
18379 \begin_layout Plain Layout
18386 \begin_inset Flex Code
18389 \begin_layout Plain Layout
18395 , describing the rendering style used for the inset's frame and buttons.
18396 Footnotes generally use
18397 \begin_inset Flex Code
18400 \begin_layout Plain Layout
18406 , ERT insets generally
18407 \begin_inset Flex Code
18410 \begin_layout Plain Layout
18416 , and character styles
18417 \begin_inset Flex Code
18420 \begin_layout Plain Layout
18429 \begin_layout Description
18430 \begin_inset Flex Code
18433 \begin_layout Plain Layout
18440 \begin_inset Flex Code
18443 \begin_layout Plain Layout
18452 \begin_inset space \thinspace{}
18458 \begin_inset Flex Code
18461 \begin_layout Plain Layout
18470 \begin_inset Flex Code
18473 \begin_layout Plain Layout
18480 \begin_inset Flex Code
18483 \begin_layout Plain Layout
18490 Indicates whether the environment will stand on its own in the output or
18491 will appear inline with the surrounding text.
18492 If set to false, it is supposed that the \SpecialChar LaTeX
18493 environment ignores white space
18494 (including one newline character) after the
18495 \begin_inset Flex Code
18498 \begin_layout Plain Layout
18511 \begin_inset Flex Code
18514 \begin_layout Plain Layout
18530 \begin_layout Description
18531 \begin_inset Flex Code
18534 \begin_layout Plain Layout
18540 Required at the end of the
18541 \begin_inset Flex Code
18544 \begin_layout Plain Layout
18553 \begin_layout Description
18554 \begin_inset Flex Code
18557 \begin_layout Plain Layout
18563 The font used for both the text body
18569 \begin_inset CommandInset ref
18571 reference "subsec:Font-description"
18576 Note that defining this font automatically defines the
18577 \begin_inset Flex Code
18580 \begin_layout Plain Layout
18586 to the same value, so define this first and define
18587 \begin_inset Flex Code
18590 \begin_layout Plain Layout
18596 later if you want them to be different.
18599 \begin_layout Description
18600 \begin_inset Flex Code
18603 \begin_layout Plain Layout
18604 FixedWidthPreambleEncoding
18610 \begin_inset Flex Code
18613 \begin_layout Plain Layout
18622 \begin_inset space \thinspace{}
18626 \begin_inset Flex Code
18629 \begin_layout Plain Layout
18635 ] Force a fixed width encoding for the translated contents of
18636 \begin_inset Flex Code
18639 \begin_layout Plain Layout
18646 \begin_inset Flex Code
18649 \begin_layout Plain Layout
18655 code generated by this layout.
18656 This is needed for special \SpecialChar LaTeX
18661 that do not work with variable width encodings such as
18666 This setting is ignored if fully Unicode aware \SpecialChar LaTeX
18667 backends such as Xe\SpecialChar TeX
18669 Lua\SpecialChar TeX
18673 \begin_layout Description
18674 \begin_inset Flex Code
18677 \begin_layout Plain Layout
18678 ForceLocalFontSwitch
18684 \begin_inset Flex Code
18687 \begin_layout Plain Layout
18696 \begin_inset space \thinspace{}
18700 \begin_inset Flex Code
18703 \begin_layout Plain Layout
18709 ] When using babel, always use a local font switch (
18710 \begin_inset Flex Code
18713 \begin_layout Plain Layout
18721 ), never a global one (such as
18722 \begin_inset Flex Code
18725 \begin_layout Plain Layout
18736 \begin_layout Description
18737 \begin_inset Flex Code
18740 \begin_layout Plain Layout
18747 \begin_inset Flex Code
18750 \begin_layout Plain Layout
18759 \begin_inset space \thinspace{}
18763 \begin_inset Flex Code
18766 \begin_layout Plain Layout
18773 \begin_inset Quotes eld
18777 \begin_inset Quotes erd
18780 language, leading to Left-to-Right (Latin) output, e.
18781 \begin_inset space \thinspace{}
18785 \begin_inset space \space{}
18788 in \SpecialChar TeX
18793 \begin_layout Description
18794 \begin_inset Flex Code
18797 \begin_layout Plain Layout
18804 \begin_inset Flex Code
18807 \begin_layout Plain Layout
18816 \begin_inset space \thinspace{}
18820 \begin_inset Flex Code
18823 \begin_layout Plain Layout
18829 ] Force a a line break in the \SpecialChar LaTeX
18830 output before the inset starts and after
18832 This assures the inset itself is output on its own lines, for parsing purposes.
18835 \begin_layout Description
18836 \begin_inset Flex Code
18839 \begin_layout Plain Layout
18846 \begin_inset Flex Code
18849 \begin_layout Plain Layout
18858 \begin_inset space \thinspace{}
18862 \begin_inset Flex Code
18865 \begin_layout Plain Layout
18871 ] Indicates whether the
18872 \begin_inset Flex Code
18875 \begin_layout Plain Layout
18881 should be used or, instead, the user can change the paragraph style used
18886 \begin_layout Description
18887 \begin_inset Flex Code
18890 \begin_layout Plain Layout
18897 \begin_inset Flex Code
18900 \begin_layout Plain Layout
18909 \begin_inset space \thinspace{}
18913 \begin_inset Flex Code
18916 \begin_layout Plain Layout
18922 ] As with paragraph styles, see
18923 \begin_inset CommandInset ref
18925 reference "subsec:Paragraph-Styles"
18932 \begin_layout Description
18933 \begin_inset Flex Code
18936 \begin_layout Plain Layout
18942 These tags control the XHTML output.
18944 \begin_inset CommandInset ref
18946 reference "sec:Tags-for-XHTML"
18953 \begin_layout Description
18954 \begin_inset Flex Code
18957 \begin_layout Plain Layout
18964 \begin_inset Flex Code
18967 \begin_layout Plain Layout
18976 \begin_inset space \thinspace{}
18980 \begin_inset Flex Code
18983 \begin_layout Plain Layout
18989 ] Whether to include the contents of this inset in the strings generated
18990 for the `Outline' pane
18991 \change_inserted 2047637253 1483900773
18992 for all table of contents, regardless of the AddToToc setting
18995 One would not, for example, want the content of a footnote in a section
18996 header to be included in the TOC displayed in the outline, but one would
18997 normally want the content of a character style displayed.
18998 Default is false: not to include.
18999 \change_inserted 2047637253 1483900609
19003 \begin_layout Description
19005 \change_inserted 2047637253 1483901257
19006 \begin_inset Flex Code
19009 \begin_layout Plain Layout
19011 \change_inserted 2047637253 1483900725
19018 \begin_inset Flex Code
19021 \begin_layout Plain Layout
19023 \change_inserted 2047637253 1483900620
19032 \begin_inset space \thinspace{}
19036 \begin_inset Flex Code
19039 \begin_layout Plain Layout
19041 \change_inserted 2047637253 1483900620
19047 ] If this is set to 1 and AddToToc is enabled, the inset adds a summary
19048 of its contents in its item in the table of contents.
19049 Otherwise, only the label appears.
19054 \begin_layout Description
19055 \begin_inset Flex Code
19058 \begin_layout Plain Layout
19067 \begin_inset Flex Code
19070 \begin_layout Plain Layout
19079 \begin_inset space \thinspace{}
19083 \begin_inset Flex Code
19086 \begin_layout Plain Layout
19092 ] As with paragraph styles, see
19093 \begin_inset CommandInset ref
19095 reference "subsec:Paragraph-Styles"
19102 \begin_layout Description
19103 \begin_inset Flex Code
19106 \begin_layout Plain Layout
19112 The font used for the label.
19114 \begin_inset CommandInset ref
19116 reference "subsec:Font-description"
19121 Note that this definition can never appear before
19122 \begin_inset Flex Code
19125 \begin_layout Plain Layout
19131 , lest it be ineffective.
19134 \begin_layout Description
19135 \begin_inset Flex Code
19138 \begin_layout Plain Layout
19145 \begin_inset Flex Code
19148 \begin_layout Plain Layout
19155 \begin_inset Quotes erd
19159 \begin_inset Quotes erd
19162 ] What will be displayed on the button or elsewhere as the inset label.
19164 \begin_inset Flex Code
19167 \begin_layout Plain Layout
19175 \begin_inset Flex Code
19178 \begin_layout Plain Layout
19184 ) modify this label on the fly.
19187 \begin_layout Description
19188 \begin_inset Flex Code
19191 \begin_layout Plain Layout
19197 Language dependent preamble; see
19198 \begin_inset CommandInset ref
19200 reference "subsec:I18n"
19207 \begin_layout Description
19208 \begin_inset Flex Code
19211 \begin_layout Plain Layout
19218 \begin_inset Flex Code
19221 \begin_layout Plain Layout
19227 ] The name of the corresponding \SpecialChar LaTeX
19229 Either the environment or command name.
19232 \begin_layout Description
19233 \begin_inset Flex Code
19236 \begin_layout Plain Layout
19243 \begin_inset Flex Code
19246 \begin_layout Plain Layout
19252 ] The optional parameter for the corresponding
19253 \begin_inset Flex Code
19256 \begin_layout Plain Layout
19262 stuff, including possible bracket pairs like
19263 \begin_inset Flex Code
19266 \begin_layout Plain Layout
19273 This parameter cannot be changed from within \SpecialChar LyX
19275 \begin_inset Flex Code
19278 \begin_layout Plain Layout
19284 for customizable parameters).
19285 It will be output as is after all \SpecialChar LaTeX
19287 \begin_inset Flex Code
19290 \begin_layout Plain Layout
19299 \begin_layout Description
19300 \begin_inset Flex Code
19303 \begin_layout Plain Layout
19310 \begin_inset Flex Code
19313 \begin_layout Plain Layout
19314 Command, Environment, None
19319 ] How the style should be translated into \SpecialChar LaTeX
19324 \begin_layout Plain Layout
19325 \begin_inset Flex Code
19328 \begin_layout Plain Layout
19334 is perhaps a bit misleading, since these rules apply to SGML classes too.
19335 Visit the SGML class files for specific examples.
19344 \begin_layout Description
19345 \begin_inset Flex Code
19348 \begin_layout Plain Layout
19354 means nothing special
19357 \begin_layout Description
19358 \begin_inset Flex Code
19361 \begin_layout Plain Layout
19368 \begin_inset Flex Code
19371 \begin_layout Plain Layout
19378 {\SpecialChar ldots
19387 \begin_layout Description
19388 \begin_inset Flex Code
19391 \begin_layout Plain Layout
19398 \begin_inset Flex Code
19401 \begin_layout Plain Layout
19408 }\SpecialChar ldots
19423 \begin_layout Standard
19424 Putting the last few things together, the \SpecialChar LaTeX
19425 output will be either:
19428 \begin_layout LyX-Code
19431 LatexName[LatexParam]{\SpecialChar ldots
19435 \begin_layout Standard
19439 \begin_layout LyX-Code
19442 begin{LatexName}[LatexParam] \SpecialChar ldots
19448 \begin_layout Standard
19449 depending upon the \SpecialChar LaTeX
19454 \begin_layout Description
19455 \begin_inset Flex Code
19458 \begin_layout Plain Layout
19465 \begin_inset Flex Code
19468 \begin_layout Plain Layout
19474 ] A string that is put at the beginning of the layout content.
19475 A line break in the output can be indicated by
19476 \begin_inset Flex Code
19479 \begin_layout Plain Layout
19488 \begin_layout Description
19489 \begin_inset Flex Code
19492 \begin_layout Plain Layout
19499 \begin_inset Flex Code
19502 \begin_layout Plain Layout
19509 \begin_inset Flex Code
19512 \begin_layout Plain Layout
19519 \begin_inset Flex Code
19522 \begin_layout Plain Layout
19529 \begin_inset Flex Code
19532 \begin_layout Plain Layout
19538 (indicating a dummy definition ending definitions of charstyles, etc).
19539 This entry is required in and is only meaningful for Flex insets.
19540 Among other things, it determines on which menu this inset will appear.
19542 \begin_inset Flex Code
19545 \begin_layout Plain Layout
19552 \begin_inset Flex Code
19555 \begin_layout Plain Layout
19561 will automatically set
19562 \begin_inset Flex Code
19565 \begin_layout Plain Layout
19572 \begin_inset Flex Code
19575 \begin_layout Plain Layout
19583 \begin_inset Flex Code
19586 \begin_layout Plain Layout
19592 can be set to true, or
19593 \begin_inset Flex Code
19596 \begin_layout Plain Layout
19603 \begin_inset Flex Code
19606 \begin_layout Plain Layout
19612 insets by setting it
19617 \begin_inset Flex Code
19620 \begin_layout Plain Layout
19629 \begin_layout Description
19630 \begin_inset Flex Code
19633 \begin_layout Plain Layout
19640 \begin_inset Flex Code
19643 \begin_layout Plain Layout
19652 \begin_inset space \thinspace{}
19656 \begin_inset Flex Code
19659 \begin_layout Plain Layout
19665 ] Whether multiple paragraphs are permitted in this inset.
19667 \begin_inset Flex Code
19670 \begin_layout Plain Layout
19676 to the same value and
19677 \begin_inset Flex Code
19680 \begin_layout Plain Layout
19686 to the opposite value.
19687 These can be reset to other values, if they are used
19692 \begin_inset Flex Code
19695 \begin_layout Plain Layout
19705 \begin_layout Description
19706 \begin_inset Flex Code
19709 \begin_layout Plain Layout
19716 \begin_inset Flex Code
19719 \begin_layout Plain Layout
19728 \begin_inset space \thinspace{}
19732 \begin_inset Flex Code
19735 \begin_layout Plain Layout
19741 ] Whether fragile commands in this inset should be
19742 \begin_inset Flex Code
19745 \begin_layout Plain Layout
19758 whether the command should itself be protected.) Default is false.
19761 \begin_layout Description
19762 \begin_inset Flex Code
19765 \begin_layout Plain Layout
19772 \begin_inset Flex Code
19775 \begin_layout Plain Layout
19781 ] Deletes an existing
19782 \begin_inset Flex Code
19785 \begin_layout Plain Layout
19794 \begin_layout Description
19795 \begin_inset Flex Code
19798 \begin_layout Plain Layout
19805 \begin_inset Flex Code
19808 \begin_layout Plain Layout
19815 \begin_inset Flex Code
19818 \begin_layout Plain Layout
19824 that has replaced this
19825 \begin_inset Flex Code
19828 \begin_layout Plain Layout
19835 This is used to rename an
19836 \begin_inset Flex Code
19839 \begin_layout Plain Layout
19845 , while keeping backward compatibility.
19848 \begin_layout Description
19849 \begin_inset Flex Code
19852 \begin_layout Plain Layout
19859 \begin_inset Flex Code
19862 \begin_layout Plain Layout
19871 \begin_inset space \thinspace{}
19875 \begin_inset Flex Code
19878 \begin_layout Plain Layout
19884 ] As with paragraph styles, see
19885 \begin_inset CommandInset ref
19887 reference "subsec:Paragraph-Styles"
19895 \begin_layout Description
19896 \begin_inset Flex Code
19899 \begin_layout Plain Layout
19906 \begin_inset Flex Code
19909 \begin_layout Plain Layout
19918 \begin_inset space \thinspace{}
19922 \begin_inset Flex Code
19925 \begin_layout Plain Layout
19931 ] As with paragraph styles, see
19932 \begin_inset CommandInset ref
19934 reference "subsec:Paragraph-Styles"
19942 \begin_layout Description
19943 \begin_inset Flex Code
19946 \begin_layout Plain Layout
19952 As with paragraph styles, see
19953 \begin_inset CommandInset ref
19955 reference "subsec:Paragraph-Styles"
19962 \begin_layout Description
19963 \begin_inset Flex Code
19966 \begin_layout Plain Layout
19973 \begin_inset Flex Code
19976 \begin_layout Plain Layout
19982 ] The prefix to use when creating labels referring to insets of this type.
19983 This allows the use of formatted references.
19986 \begin_layout Description
19987 \begin_inset Flex Code
19990 \begin_layout Plain Layout
19997 \begin_inset Flex Code
20000 \begin_layout Plain Layout
20006 ] As with paragraph styles, see
20007 \begin_inset CommandInset ref
20009 reference "subsec:Paragraph-Styles"
20016 \begin_layout Description
20017 \begin_inset Flex Code
20020 \begin_layout Plain Layout
20027 \begin_inset Flex Code
20030 \begin_layout Plain Layout
20039 \begin_inset space \thinspace{}
20043 \begin_inset Flex Code
20046 \begin_layout Plain Layout
20052 ] Resets the \SpecialChar LaTeX
20053 arguments of this layout (as defined via the
20054 \begin_inset Flex Code
20057 \begin_layout Plain Layout
20064 This is useful if you have copied a style via
20065 \begin_inset Flex Code
20068 \begin_layout Plain Layout
20074 , but you do not want to inherit its (required and optional) arguments.
20077 \begin_layout Description
20078 \begin_inset Flex Code
20081 \begin_layout Plain Layout
20088 \begin_inset Flex Code
20091 \begin_layout Plain Layout
20098 \begin_inset space \thinspace{}
20102 \begin_inset Flex Code
20105 \begin_layout Plain Layout
20113 ] Whether this inset should use the font of its surrounding environment
20115 Default is false: use the font of the surrounding environment.
20118 \begin_layout Description
20119 \begin_inset Flex Code
20122 \begin_layout Plain Layout
20129 \begin_inset Flex Code
20132 \begin_layout Plain Layout
20138 ] A string that is put at the end of the layout content.
20139 A line break in the output can be indicated by
20140 \begin_inset Flex Code
20143 \begin_layout Plain Layout
20152 \begin_layout Description
20153 \begin_inset Flex Code
20156 \begin_layout Plain Layout
20163 \begin_inset Flex Code
20166 \begin_layout Plain Layout
20173 \begin_inset space \thinspace{}
20177 \begin_inset Flex Code
20180 \begin_layout Plain Layout
20188 ] Allow spell-checking the contents of this inset.
20192 \begin_layout Subsection
20194 \begin_inset CommandInset label
20196 name "subsec:Counters"
20203 \begin_layout Standard
20204 It is necessary to define the counters (
20205 \begin_inset Flex Noun
20208 \begin_layout Plain Layout
20215 \begin_inset Flex Noun
20218 \begin_layout Plain Layout
20224 , \SpecialChar ldots
20225 ) in the text class itself.
20226 The standard counters are defined in the file
20227 \begin_inset Flex Code
20230 \begin_layout Plain Layout
20236 , so you may have to do no more than add
20239 \begin_layout LyX-Code
20240 Input stdcounters.inc
20243 \begin_layout Standard
20244 to your layout file to get them to work.
20245 But if you want to define custom counters, then you can do so.
20246 The counter declaration must begin with:
20249 \begin_layout LyX-Code
20250 Counter CounterName
20253 \begin_layout Standard
20255 \begin_inset Flex Code
20258 \begin_layout Plain Layout
20264 ' is replaced by the name of the counter.
20265 And it must end with
20266 \begin_inset Quotes eld
20270 \begin_inset Flex Code
20273 \begin_layout Plain Layout
20280 \begin_inset Quotes erd
20284 The following parameters can also be used:
20287 \begin_layout Description
20288 \begin_inset Flex Code
20291 \begin_layout Plain Layout
20298 \begin_inset Flex Code
20301 \begin_layout Plain Layout
20307 ] Sets the initial value for the counter, to which it will be reset whenever
20309 Normally, one will want the default, 1.
20312 \begin_layout Description
20313 \begin_inset Flex Code
20316 \begin_layout Plain Layout
20323 \begin_inset Flex Code
20326 \begin_layout Plain Layout
20333 \begin_inset Quotes erd
20337 \begin_inset Quotes erd
20340 ] When defined, this string defines how the counter is displayed.
20341 Setting this value sets
20342 \begin_inset Flex Code
20345 \begin_layout Plain Layout
20346 LabelStringAppendix
20352 The following special constructs can be used in the string:
20356 \begin_layout Itemize
20357 \begin_inset Flex Code
20360 \begin_layout Plain Layout
20368 will be replaced by the expansion of the
20369 \begin_inset Flex Code
20372 \begin_layout Plain Layout
20379 \begin_inset Flex Code
20382 \begin_layout Plain Layout
20383 LabelStringAppendix
20389 \begin_inset Flex Code
20392 \begin_layout Plain Layout
20402 \begin_layout Itemize
20403 counter values can be expressed using \SpecialChar LaTeX
20405 \begin_inset Newline newline
20409 \begin_inset Flex Code
20412 \begin_layout Plain Layout
20429 \begin_inset Flex Code
20432 \begin_layout Plain Layout
20444 \begin_layout Plain Layout
20454 Actually, the situation is a bit more complicated: any
20473 other than those described below will produce arabic numerals.
20474 It would not be surprising to see this change in the future.
20480 \begin_inset Flex Code
20483 \begin_layout Plain Layout
20489 : 1, 2, 3,\SpecialChar ldots
20491 \begin_inset Flex Code
20494 \begin_layout Plain Layout
20500 for lower-case letters: a, b, c, \SpecialChar ldots
20502 \begin_inset Flex Code
20505 \begin_layout Plain Layout
20511 for upper-case letters: A, B, C, \SpecialChar ldots
20513 \begin_inset Flex Code
20516 \begin_layout Plain Layout
20522 for lower-case roman numerals: i, ii, iii, \SpecialChar ldots
20524 \begin_inset Flex Code
20527 \begin_layout Plain Layout
20533 for upper-case roman numerals: I, II, III\SpecialChar ldots
20535 \begin_inset Flex Code
20538 \begin_layout Plain Layout
20544 for hebrew numerals.
20548 \begin_layout Standard
20549 If LabelString is not defined, a default value is constructed as follows:
20550 if the counter has a master counter
20551 \begin_inset Flex Code
20554 \begin_layout Plain Layout
20561 \begin_inset Flex Code
20564 \begin_layout Plain Layout
20571 \begin_inset Newline newline
20575 \begin_inset Flex Code
20578 \begin_layout Plain Layout
20588 is used; otherwise the string
20589 \begin_inset Flex Code
20592 \begin_layout Plain Layout
20603 \begin_layout Description
20604 \begin_inset Flex Code
20607 \begin_layout Plain Layout
20608 LabelStringAppendix
20614 \begin_inset Flex Code
20617 \begin_layout Plain Layout
20624 \begin_inset Quotes erd
20628 \begin_inset Quotes erd
20632 \begin_inset Flex Code
20635 \begin_layout Plain Layout
20641 , but for use in the Appendix.
20644 \begin_layout Description
20645 \begin_inset Flex Code
20648 \begin_layout Plain Layout
20655 \begin_inset Flex Code
20658 \begin_layout Plain Layout
20665 \begin_inset Quotes erd
20669 \begin_inset Quotes erd
20672 ] A format for use with formatted references to this counter.
20673 For example, one might want to have references to section numbers appear
20675 \begin_inset Quotes eld
20679 \begin_inset Quotes erd
20683 The string should contain
20684 \begin_inset Quotes eld
20688 \begin_inset Quotes erd
20692 This will be replaced by the counter number itself.
20693 So, for sections, it would be: Section ##.
20696 \begin_layout Description
20697 \begin_inset Flex Code
20700 \begin_layout Plain Layout
20707 \begin_inset Flex Code
20710 \begin_layout Plain Layout
20717 \begin_inset Quotes erd
20721 \begin_inset Quotes erd
20724 ] If this is set to the name of another counter, the present counter will
20725 be reset every time the other one is increased.
20727 \begin_inset Flex Code
20730 \begin_layout Plain Layout
20737 \begin_inset Flex Code
20740 \begin_layout Plain Layout
20749 \begin_layout Subsection
20751 \begin_inset CommandInset label
20753 name "subsec:Font-description"
20760 \begin_layout Standard
20761 A font description looks like this:
20764 \begin_layout LyX-Code
20778 \begin_layout LyX-Code
20782 \begin_layout LyX-Code
20786 \begin_layout Standard
20787 The following commands are available:
20790 \begin_layout Description
20791 \begin_inset Flex Code
20794 \begin_layout Plain Layout
20801 \begin_inset Flex Code
20804 \begin_layout Plain Layout
20813 \begin_inset Flex Code
20816 \begin_layout Plain Layout
20823 \begin_inset Flex Code
20826 \begin_layout Plain Layout
20833 \begin_inset Flex Code
20836 \begin_layout Plain Layout
20843 \begin_inset Flex Code
20846 \begin_layout Plain Layout
20853 \begin_inset Flex Code
20856 \begin_layout Plain Layout
20863 \begin_inset Flex Code
20866 \begin_layout Plain Layout
20873 \begin_inset Flex Code
20876 \begin_layout Plain Layout
20883 \begin_inset Flex Code
20886 \begin_layout Plain Layout
20893 \begin_inset Flex Code
20896 \begin_layout Plain Layout
20903 \begin_inset Flex Code
20906 \begin_layout Plain Layout
20913 \begin_inset Flex Code
20916 \begin_layout Plain Layout
20923 \begin_inset Flex Code
20926 \begin_layout Plain Layout
20933 \begin_inset Flex Code
20936 \begin_layout Plain Layout
20943 \begin_inset Flex Code
20946 \begin_layout Plain Layout
20953 \begin_inset Flex Code
20956 \begin_layout Plain Layout
20963 \begin_inset Flex Code
20966 \begin_layout Plain Layout
20973 \begin_inset Flex Code
20976 \begin_layout Plain Layout
20983 \begin_inset Flex Code
20986 \begin_layout Plain Layout
20993 \begin_inset Flex Code
20996 \begin_layout Plain Layout
21005 \begin_layout Description
21006 \begin_inset Flex Code
21009 \begin_layout Plain Layout
21016 \begin_inset Flex Code
21019 \begin_layout Plain Layout
21028 \begin_inset Flex Code
21031 \begin_layout Plain Layout
21038 \begin_inset Flex Code
21041 \begin_layout Plain Layout
21050 \begin_layout Description
21051 \begin_inset Flex Code
21054 \begin_layout Plain Layout
21061 \begin_inset Flex Code
21064 \begin_layout Plain Layout
21070 ] Valid arguments are:
21071 \begin_inset Flex Code
21074 \begin_layout Plain Layout
21081 \begin_inset Flex Code
21084 \begin_layout Plain Layout
21091 \begin_inset Flex Code
21094 \begin_layout Plain Layout
21101 \begin_inset Flex Code
21104 \begin_layout Plain Layout
21111 \begin_inset Flex Code
21114 \begin_layout Plain Layout
21121 \begin_inset Flex Code
21124 \begin_layout Plain Layout
21131 \begin_inset Flex Code
21134 \begin_layout Plain Layout
21141 \begin_inset Flex Code
21144 \begin_layout Plain Layout
21151 \begin_inset Flex Code
21154 \begin_layout Plain Layout
21161 \begin_inset Flex Code
21164 \begin_layout Plain Layout
21171 \begin_inset Flex Code
21174 \begin_layout Plain Layout
21181 \begin_inset Flex Code
21184 \begin_layout Plain Layout
21191 Each of these turns on or off the corresponding attribute.
21193 \begin_inset Flex Code
21196 \begin_layout Plain Layout
21202 turns on emphasis, and
21203 \begin_inset Flex Code
21206 \begin_layout Plain Layout
21214 \begin_inset Newline newline
21217 If the latter seems puzzling, remember that the font settings for the present
21218 context are generally inherited from the surrounding context.
21220 \begin_inset Flex Code
21223 \begin_layout Plain Layout
21229 would turn off the emphasis that was anyway in effect, say, in a theorem
21233 \begin_layout Description
21234 \begin_inset Flex Code
21237 \begin_layout Plain Layout
21244 \begin_inset Flex Code
21247 \begin_layout Plain Layout
21256 \begin_inset Flex Code
21259 \begin_layout Plain Layout
21268 \begin_layout Description
21269 \begin_inset Flex Code
21272 \begin_layout Plain Layout
21279 \begin_inset Flex Code
21282 \begin_layout Plain Layout
21291 \begin_inset Flex Code
21294 \begin_layout Plain Layout
21301 \begin_inset Flex Code
21304 \begin_layout Plain Layout
21311 \begin_inset Flex Code
21314 \begin_layout Plain Layout
21323 \begin_layout Description
21324 \begin_inset Flex Code
21327 \begin_layout Plain Layout
21334 \begin_inset Flex Code
21337 \begin_layout Plain Layout
21344 \begin_inset Flex Code
21347 \begin_layout Plain Layout
21354 \begin_inset Flex Code
21357 \begin_layout Plain Layout
21366 \begin_inset Flex Code
21369 \begin_layout Plain Layout
21376 \begin_inset Flex Code
21379 \begin_layout Plain Layout
21386 \begin_inset Flex Code
21389 \begin_layout Plain Layout
21396 \begin_inset Flex Code
21399 \begin_layout Plain Layout
21406 \begin_inset Flex Code
21409 \begin_layout Plain Layout
21418 \begin_layout Subsection
21420 \change_inserted -712698321 1483869872
21421 \begin_inset CommandInset label
21423 name "subsec:Citation-engine-description"
21427 Citation engine description
21430 \begin_layout Standard
21432 \change_inserted -712698321 1483875281
21434 \begin_inset Flex Code
21437 \begin_layout Plain Layout
21439 \change_inserted -712698321 1483869913
21447 blocks, as used mainly in cite engine files (see
21448 \begin_inset CommandInset ref
21450 reference "subsec:Cite-Engine-Files"
21457 ), define the citation commands provided by a specific
21458 \begin_inset Quotes eld
21462 \begin_inset Quotes erd
21466 A cite engine, in \SpecialChar LyX
21467 terms, is way specific way to format citations, using
21468 numbers, author names and/or years.
21469 Currently, \SpecialChar LyX
21470 supports three such engine types, namely:
21473 \begin_layout Enumerate
21475 \change_inserted -712698321 1483875764
21476 \begin_inset Flex Code
21479 \begin_layout Plain Layout
21481 \change_inserted -712698321 1483870430
21489 : the default Bib\SpecialChar TeX
21490 way to format citations, a simple numeric style (e.
21491 \begin_inset space \thinspace{}
21495 \begin_inset Quotes eld
21499 \begin_inset Quotes erd
21505 \begin_layout Enumerate
21507 \change_inserted -712698321 1483875766
21508 \begin_inset Flex Code
21511 \begin_layout Plain Layout
21513 \change_inserted -712698321 1483870434
21521 : Harvard-styled citations using author names and publication year (e.
21522 \begin_inset space \thinspace{}
21526 \begin_inset Quotes eld
21529 Smith and Miller (2017b)
21530 \begin_inset Quotes erd
21536 \begin_layout Enumerate
21538 \change_inserted -712698321 1483875769
21539 \begin_inset Flex Code
21542 \begin_layout Plain Layout
21544 \change_inserted -712698321 1483870457
21552 : extended numerical citations that also allow for author or title next
21554 \begin_inset space \thinspace{}
21558 \begin_inset Quotes eld
21561 Smith and Miller [1]
21562 \begin_inset Quotes erd
21568 \begin_layout Standard
21570 \change_inserted -712698321 1483870566
21571 \begin_inset Flex Code
21574 \begin_layout Plain Layout
21576 \change_inserted -712698321 1483870552
21582 blocks look like this:
21585 \begin_layout LyX-Code
21587 \change_inserted -712698321 1483870590
21591 \begin_layout LyX-Code
21593 \change_inserted -712698321 1483870615
21597 \begin_layout LyX-Code
21599 \change_inserted -712698321 1483870633
21603 \begin_layout LyX-Code
21605 \change_inserted -712698321 1483870652
21606 citeyearpar[][]=parencite*
21609 \begin_layout LyX-Code
21611 \change_inserted -712698321 1483870652
21615 \begin_layout LyX-Code
21617 \change_inserted -712698321 1483870668
21621 \begin_layout Standard
21623 \change_inserted -712698321 1483871113
21625 \begin_inset Flex Code
21628 \begin_layout Plain Layout
21630 \change_inserted -712698321 1483871085
21636 denotes the engine.
21637 The individual lines respectively define a cite command or cite command
21638 paradigm supported by this engine.
21639 The line can be as simple as a cite command that is used both to name the
21640 respective \SpecialChar LyX
21641 command and the \SpecialChar LaTeX
21642 output or more complex in order to differentiate
21645 \change_deleted -712698321 1483871114
21649 \begin_layout Standard
21651 \change_inserted -712698321 1483871119
21652 The full syntax is:
21655 \begin_layout LyX-Code
21657 \change_inserted -712698321 1484997816
21658 LyXName|alias$*<!_stardesc!_stardesctooltip>[][]=latexcmd
21661 \begin_layout Itemize
21663 \change_inserted -712698321 1483871222
21664 \begin_inset Flex Code
21667 \begin_layout Plain Layout
21669 \change_inserted -712698321 1483871181
21677 : The name as used in the
21678 \begin_inset Flex Code
21681 \begin_layout Plain Layout
21683 \change_inserted -712698321 1483871216
21695 \begin_layout Standard
21697 \change_inserted -712698321 1483871487
21698 For portability reasons, we try to use the same name for same-formatted
21699 commands in different cite packages (thus many names stem from natbib,
21700 and thus we need to differentiate a
21701 \begin_inset Flex Code
21704 \begin_layout Plain Layout
21706 \change_inserted -712698321 1483871402
21712 sometimes, if the \SpecialChar LaTeX
21713 command names differ).
21717 \begin_layout Itemize
21719 \change_inserted -712698321 1483871583
21720 \begin_inset Flex Code
21723 \begin_layout Plain Layout
21725 \change_inserted -712698321 1483871186
21733 : a (comma-separated) list of commands that fall back to the given
21734 \begin_inset Flex Code
21737 \begin_layout Plain Layout
21739 \change_inserted -712698321 1483871257
21745 in the current engine.
21746 This eases the switch of citation packages and engines.
21748 \begin_inset Flex Code
21751 \begin_layout Plain Layout
21753 \change_inserted -712698321 1483871559
21760 \begin_inset Flex Code
21763 \begin_layout Plain Layout
21765 \change_inserted -712698321 1483871278
21773 in layout definitions.
21776 \begin_layout Itemize
21778 \change_inserted -712698321 1483871307
21779 \begin_inset Flex Code
21782 \begin_layout Plain Layout
21784 \change_inserted -712698321 1483871296
21792 : The actual \SpecialChar LaTeX
21793 command that is output.
21797 \begin_layout Standard
21799 \change_inserted -712698321 1483871348
21800 \begin_inset Flex Code
21803 \begin_layout Plain Layout
21805 \change_inserted -712698321 1483871316
21814 \begin_inset Flex Code
21817 \begin_layout Plain Layout
21819 \change_inserted -712698321 1483871321
21829 \begin_inset Flex Code
21832 \begin_layout Plain Layout
21834 \change_inserted -712698321 1483871333
21841 \begin_inset Flex Code
21844 \begin_layout Plain Layout
21846 \change_inserted -712698321 1483871340
21852 will be output to \SpecialChar LaTeX
21856 \begin_layout Standard
21858 \change_inserted -712698321 1483871604
21862 \begin_layout Itemize
21864 \change_inserted -712698321 1483871664
21865 Capitalization indicates that the command also has a capitalized form (
21866 \begin_inset Flex Code
21869 \begin_layout Plain Layout
21871 \change_inserted -712698321 1483871622
21883 \begin_inset Flex Code
21886 \begin_layout Plain Layout
21888 \change_inserted -712698321 1483871626
21899 These usually enforce up-casing of name prefixes (
21904 \begin_inset Formula $\Rightarrow$
21914 \begin_layout Itemize
21916 \change_inserted -712698321 1483871690
21918 \begin_inset Flex Code
21921 \begin_layout Plain Layout
21923 \change_inserted -712698321 1483871670
21931 indicate the number of optional arguments (there can be 0–2).
21934 \begin_layout Itemize
21936 \change_inserted -712698321 1483871747
21938 \begin_inset Flex Code
21941 \begin_layout Plain Layout
21943 \change_inserted -712698321 1483871698
21951 indicates there is a starred version of the command (
21952 \begin_inset Flex Code
21955 \begin_layout Plain Layout
21957 \change_inserted -712698321 1483871718
21969 \begin_inset Flex Code
21972 \begin_layout Plain Layout
21974 \change_inserted -712698321 1483871724
21989 \begin_layout Standard
21991 \change_inserted -712698321 1483871864
21992 By default, the starred version means: Output all authors even if it should
21994 \begin_inset Quotes eld
21998 \begin_inset Quotes erd
22002 \begin_inset Flex Code
22005 \begin_layout Plain Layout
22007 \change_inserted -712698321 1483871835
22018 \begin_layout Standard
22020 \change_inserted -712698321 1483872045
22021 If the star has a different meaning for a given command, it can be specified
22023 \begin_inset Flex Code
22026 \begin_layout Plain Layout
22028 \change_inserted -712698321 1483871856
22029 <!_stardesc!_stardesctooltip>
22037 Maximal two translatable macro keywords, marked by the prefix
22038 \begin_inset Flex Code
22041 \begin_layout Plain Layout
22043 \change_inserted -712698321 1483872014
22052 The first points to the string that replaces the
22053 \begin_inset Quotes eld
22057 \begin_inset Quotes erd
22060 checkbox label in the citation dialog, the second one to an optional tool
22061 tip for this checkbox.
22065 \begin_layout Standard
22067 \change_inserted -712698321 1483872164
22068 Note that these two macros have to be defined in a
22069 \begin_inset Flex Code
22072 \begin_layout Plain Layout
22074 \change_inserted -712698321 1483871983
22082 (see next section), dropping the
22083 \begin_inset Flex Code
22086 \begin_layout Plain Layout
22088 \change_inserted -712698321 1483872023
22096 from the prefix, like this:
22099 \begin_layout LyX-Code
22101 \change_inserted -712698321 1483872092
22102 _stardesc Sta&rred command label
22105 \begin_layout LyX-Code
22107 \change_inserted -712698321 1484997832
22108 _stardesctooltip Tooltip for the starred command checkbox.
22112 \begin_layout Itemize
22114 \change_inserted -712698321 1484997948
22116 \begin_inset Flex Code
22119 \begin_layout Plain Layout
22121 \change_inserted -712698321 1484997871
22129 indicates that this command features
22130 \begin_inset Quotes eld
22133 qualified citation lists
22134 \begin_inset Quotes erd
22142 -specific feature for multi-reference citations where an individual pre-
22143 and postnote can be given to each reference in the list.
22144 Please refer to the
22148 manual for details.
22151 \begin_layout Subsection
22152 \begin_inset CommandInset label
22154 name "subsec:Citation-format-description"
22158 Citation format description
22161 \begin_layout Standard
22163 \begin_inset Flex Code
22166 \begin_layout Plain Layout
22172 blocks are used to describe how bibliographic information should be displayed,
22173 both within \SpecialChar LyX
22174 itself (in the citation dialog and in tooltips, for example)
22175 and in XHTML output.
22176 Such a block might look like this:
22179 \begin_layout LyX-Code
22183 \begin_layout LyX-Code
22187 \begin_layout LyX-Code
22191 \begin_layout LyX-Code
22193 \change_inserted -712698321 1483867197
22197 \begin_layout Standard
22199 \change_inserted -712698321 1483867200
22203 \begin_layout LyX-Code
22205 \change_inserted -712698321 1483867195
22209 \begin_layout LyX-Code
22211 \change_inserted -712698321 1483867204
22215 \begin_layout LyX-Code
22217 \change_inserted -712698321 1483867359
22221 \begin_layout LyX-Code
22223 \change_inserted -712698321 1483867195
22229 \begin_layout Standard
22231 \change_inserted -712698321 1483867269
22233 \change_deleted -712698321 1483867270
22235 \change_inserted -712698321 1483867270
22238 he individual lines define how the bibliographic information associated
22239 with an article or book, respectively, is to be displayed, and such a definitio
22240 n can be given for any
22241 \change_deleted -712698321 1483867550
22243 \change_inserted -712698321 1483867550
22245 \begin_inset Quotes els
22251 \change_deleted -712698321 1483867552
22253 \change_inserted -712698321 1483867552
22255 \begin_inset Quotes ers
22260 that might be present in a Bib\SpecialChar TeX
22263 defines a default format in the source code that will be used if no specific
22264 definition has been given.
22266 predefines several formats in the file
22267 \begin_inset Flex Code
22270 \begin_layout Plain Layout
22276 , which is included in most of \SpecialChar LyX
22277 's document classes.
22278 \change_inserted -712698321 1483867288
22282 \begin_layout Standard
22284 \change_inserted -712698321 1483875512
22285 In the second case, the lines define how a specific citation command (in
22287 \begin_inset Flex Code
22290 \begin_layout Plain Layout
22292 \change_inserted -712698321 1483867674
22303 \begin_inset Flex Code
22306 \begin_layout Plain Layout
22308 \change_inserted -712698321 1483867679
22318 ) is to be displayed on the citation inset label, in the citation dialog,
22319 menu or XHTML output.
22321 defines such formats for the citation style variants it supports via
22323 Document\SpecialChar menuseparator
22324 Setting\SpecialChar menuseparator
22325 Bibliography\SpecialChar ldots
22329 \begin_inset Flex Code
22332 \begin_layout Plain Layout
22334 \change_inserted -712698321 1483875503
22340 files that are shipped with \SpecialChar LyX
22342 \begin_inset CommandInset ref
22344 reference "subsec:Cite-Engine-Files"
22356 \begin_layout Standard
22357 The definitions use a simple language that allows Bib\SpecialChar TeX
22358 keys to be replaced
22360 Keys should be enclosed in
22361 \begin_inset Flex Code
22364 \begin_layout Plain Layout
22371 \begin_inset Flex Code
22374 \begin_layout Plain Layout
22381 So a simple definition might look like this:
22384 \begin_layout LyX-Code
22386 \begin_inset Quotes eld
22390 \begin_inset Quotes erd
22396 \begin_layout Standard
22397 This would print the author, followed by a comma, followed by the title,
22398 in quotes, followed by a period.
22401 \begin_layout Standard
22402 Of course, sometimes you may want to print a key only if it exists.
22403 This can be done by using a conditional construction, such as:
22404 \begin_inset Flex Code
22407 \begin_layout Plain Layout
22409 \begin_inset space ~
22419 \begin_inset Flex Code
22422 \begin_layout Plain Layout
22428 key exists, then print
22429 \begin_inset Quotes eld
22433 \begin_inset space ~
22437 \begin_inset Quotes erd
22440 followed by the volume key.
22441 It is also possible to have an else clause in the conditional, such as:
22442 \begin_inset Newline newline
22446 \begin_inset Flex Code
22449 \begin_layout Plain Layout
22450 {%author%[[%author%]][[%editor%, ed.]]}
22456 \begin_inset Newline newline
22460 \begin_inset Flex Code
22463 \begin_layout Plain Layout
22469 key is printed if it exists; otherwise, the editor key is printed, followed
22471 \begin_inset Quotes eld
22475 \begin_inset space ~
22479 \begin_inset Quotes erd
22482 Note that the key is again enclosed in
22483 \begin_inset Flex Code
22486 \begin_layout Plain Layout
22492 signs; the entire conditional is enclosed in braces; and the if and else
22493 clauses are enclosed in double brackets,
22494 \begin_inset Quotes eld
22498 \begin_inset Flex Code
22501 \begin_layout Plain Layout
22508 \begin_inset Quotes eld
22512 \begin_inset Quotes eld
22516 \begin_inset Flex Code
22519 \begin_layout Plain Layout
22526 \begin_inset Quotes erd
22530 There must be no space between any of these.
22531 \change_inserted -712698321 1483867855
22535 \begin_layout Standard
22537 \change_inserted -712698321 1483867910
22538 Next to the entry keys, there are some special keys that can be used for
22539 these conditionals:
22542 \begin_layout Itemize
22544 \change_inserted -712698321 1483868049
22545 \begin_inset Flex Code
22548 \begin_layout Plain Layout
22550 \change_inserted -712698321 1483867962
22551 {%dialog%[[true]][[false]]}
22559 \begin_inset Quotes eld
22563 \begin_inset Quotes erd
22566 part for dialogs and menus, the
22567 \begin_inset Quotes eld
22571 \begin_inset Quotes erd
22574 part for other contexts (workarea, export)
22577 \begin_layout Itemize
22579 \change_inserted -712698321 1483868068
22580 \begin_inset Flex Code
22583 \begin_layout Plain Layout
22585 \change_inserted -712698321 1483868052
22586 {%export%[[true]][[false]]}
22592 \begin_inset Quotes eld
22596 \begin_inset Quotes erd
22599 part for export and menus, the
22600 \begin_inset Quotes eld
22604 \begin_inset Quotes erd
22607 part for other contexts (workarea, dialog)
22610 \begin_layout Itemize
22612 \change_inserted -712698321 1483868138
22613 \begin_inset Flex Code
22616 \begin_layout Plain Layout
22618 \change_inserted -712698321 1483868076
22625 \begin_inset Quotes eld
22629 \begin_inset Quotes erd
22632 part if another item follows (e.
22633 \begin_inset space \thinspace{}
22636 g., in a citation with multiple keys)
22639 \begin_layout Itemize
22641 \change_inserted -712698321 1483868174
22642 \begin_inset Flex Code
22645 \begin_layout Plain Layout
22647 \change_inserted -712698321 1483868144
22648 {%second%[[true]][[false]]}
22654 \begin_inset Quotes eld
22658 \begin_inset Quotes erd
22661 if this is the second of multiple items, else the
22662 \begin_inset Quotes eld
22666 \begin_inset Quotes erd
22672 \begin_layout Itemize
22674 \change_inserted -712698321 1483868321
22675 \begin_inset Flex Code
22678 \begin_layout Plain Layout
22680 \change_inserted -712698321 1483868259
22681 {%ifstar%[[true]][[false]]}
22687 \begin_inset Quotes eld
22691 \begin_inset Quotes erd
22694 part for starred citation commands (such as
22695 \begin_inset Flex Code
22698 \begin_layout Plain Layout
22700 \change_inserted -712698321 1483868310
22710 ), the false part for unstarred
22713 \begin_layout Itemize
22715 \change_inserted -712698321 1483978485
22716 \begin_inset Flex Code
22719 \begin_layout Plain Layout
22721 \change_inserted -712698321 1483868330
22722 {%ifentrytype:<type>%[[true]][[false]]}
22728 \begin_inset Quotes eld
22732 \begin_inset Quotes erd
22735 if the current entry type matches
22736 \begin_inset Flex Code
22739 \begin_layout Plain Layout
22741 \change_inserted -712698321 1483868364
22749 , else the false part (e.g., in a citation definition:
22750 \begin_inset Flex Code
22753 \begin_layout Plain Layout
22755 \change_inserted -712698321 1483868420
22756 {%ifentrytype:book%[[this is a book]][[this is no book]]}
22766 \begin_layout Itemize
22768 \change_inserted -712698321 1484997600
22769 \begin_inset Flex Code
22772 \begin_layout Plain Layout
22774 \change_inserted -712698321 1483978499
22775 {%ifmultiple:<authortype>%[[true]][[false]]}
22781 \begin_inset Quotes eld
22785 \begin_inset Quotes erd
22788 if the current author type (author, editor etc.) has multiple authors, else
22789 the false part (e.g., in a bibliography definition:
22790 \begin_inset Flex Code
22793 \begin_layout Plain Layout
22795 \change_inserted -712698321 1483978571
22796 {%ifmultiple:editor%[[eds.]][[ed.]]}
22804 \begin_layout Itemize
22806 \change_inserted -712698321 1484997681
22807 \begin_inset Flex Code
22810 \begin_layout Plain Layout
22812 \change_inserted -712698321 1484997608
22813 {%ifqualified%[[true]][[false]]}
22819 \begin_inset Quotes eld
22823 \begin_inset Quotes erd
22826 part if the current citation is a qualified citation list (a specific
22830 format for multi-reference citations), the false part if this is not the
22836 \begin_layout Standard
22838 \change_inserted -712698321 1483978958
22840 \begin_inset Flex Code
22843 \begin_layout Plain Layout
22845 \change_inserted -712698321 1483978693
22851 prints the author key as it is recorded in the bibliography file.
22852 This might not be what you want, since it will result in a string such
22854 \begin_inset Quotes eld
22857 Miller, Peter and Smith, Mary and White, Jane
22858 \begin_inset Quotes erd
22862 \begin_inset Quotes eld
22866 \begin_inset Quotes erd
22869 is used by Bib\SpecialChar TeX
22870 to delimit authors).
22872 therefore provides some methods to get properly formatted name lists (which
22873 will also get translated).
22874 The following keys are provided:
22877 \begin_layout Enumerate
22879 \change_inserted -712698321 1483979807
22880 For name lists with pre- and surname, suitable for the main authors/editors
22881 of a bibliography item.
22883 \begin_inset Flex Code
22886 \begin_layout Plain Layout
22888 \change_inserted -712698321 1483979800
22896 part denotes the kind of list that is requested (e.g.
22898 \begin_inset Flex Code
22901 \begin_layout Plain Layout
22903 \change_inserted -712698321 1483979807
22915 \begin_layout Itemize
22917 \change_inserted -712698321 1483979186
22918 \begin_inset Flex Code
22921 \begin_layout Plain Layout
22923 \change_inserted -712698321 1483979743
22924 %abbrvnames:<nametype>%
22931 : Provides a name list which is abbreviated (with
22932 \begin_inset Quotes eld
22936 \begin_inset Quotes erd
22940 \begin_inset Flex Code
22943 \begin_layout Plain Layout
22945 \change_inserted -712698321 1483979186
22956 \begin_layout Itemize
22958 \change_inserted -712698321 1483979527
22959 \begin_inset Flex Code
22962 \begin_layout Plain Layout
22964 \change_inserted -712698321 1483979748
22965 %fullnames:<nametype>%
22972 : Provides a full name list (never abbreviated with
22973 \begin_inset Quotes eld
22977 \begin_inset Quotes erd
22983 \begin_layout Itemize
22985 \change_inserted -712698321 1483979553
22986 \begin_inset Flex Code
22989 \begin_layout Plain Layout
22991 \change_inserted -712698321 1483980138
22992 %forceabbrvnames:<nametype>%
22999 : Provides a name list which is always abbreviated (with
23000 \begin_inset Quotes eld
23004 \begin_inset Quotes erd
23008 \begin_inset Flex Code
23011 \begin_layout Plain Layout
23013 \change_inserted -712698321 1483979535
23025 \begin_layout Enumerate
23027 \change_inserted -712698321 1483979413
23028 Alternative name lists with pre- and surname, if the order of pre- and surname
23029 inside the bibliography item differs (as in:
23030 \begin_inset Quotes eld
23033 Miller, John: Some text, in: Mary Smith, ed.: A volume
23034 \begin_inset Quotes erd
23043 \begin_layout Itemize
23045 \change_inserted -712698321 1483979565
23046 \begin_inset Flex Code
23049 \begin_layout Plain Layout
23051 \change_inserted -712698321 1483979751
23052 %abbrvbynames:<nametype>%
23059 : Provides a name list which is abbreviated (with
23060 \begin_inset Quotes eld
23064 \begin_inset Quotes erd
23068 \begin_inset Flex Code
23071 \begin_layout Plain Layout
23073 \change_inserted -712698321 1483979565
23084 \begin_layout Itemize
23086 \change_inserted -712698321 1483979570
23087 \begin_inset Flex Code
23090 \begin_layout Plain Layout
23092 \change_inserted -712698321 1483979753
23093 %fullbynames:<nametype>%
23100 : Provides a full name list (never abbreviated with
23101 \begin_inset Quotes eld
23105 \begin_inset Quotes erd
23113 \begin_layout Itemize
23115 \change_inserted -712698321 1483979576
23116 \begin_inset Flex Code
23119 \begin_layout Plain Layout
23121 \change_inserted -712698321 1483980143
23122 %forceabbrvbynames:<nametype>%
23129 : Provides a name list which is always abbreviated (with
23130 \begin_inset Quotes eld
23134 \begin_inset Quotes erd
23138 \begin_inset Flex Code
23141 \begin_layout Plain Layout
23143 \change_inserted -712698321 1483979574
23153 \begin_layout Enumerate
23155 \change_inserted -712698321 1483980219
23156 And finally name lists which consist of family names only, as used in author-yea
23158 these do not take a
23159 \begin_inset Flex Code
23162 \begin_layout Plain Layout
23164 \change_inserted -712698321 1483979871
23172 part, but always return either an author list or, if this does not exist,
23173 an editor list (as common in author-year labels):
23179 \begin_layout Itemize
23181 \change_inserted -712698321 1483979715
23182 \begin_inset Flex Code
23185 \begin_layout Plain Layout
23187 \change_inserted -712698321 1483979700
23195 : Provides a name list which is abbreviated (with
23196 \begin_inset Quotes eld
23200 \begin_inset Quotes erd
23204 \begin_inset Flex Code
23207 \begin_layout Plain Layout
23209 \change_inserted -712698321 1483979715
23220 \begin_layout Itemize
23222 \change_inserted -712698321 1483979721
23223 \begin_inset Flex Code
23226 \begin_layout Plain Layout
23228 \change_inserted -712698321 1483979703
23236 : Provides a full name list (never abbreviated with
23237 \begin_inset Quotes eld
23241 \begin_inset Quotes erd
23249 \begin_layout Itemize
23251 \change_inserted -712698321 1483980272
23252 \begin_inset Flex Code
23255 \begin_layout Plain Layout
23257 \change_inserted -712698321 1483979705
23258 %forceabbrvciteauthor%
23265 : Provides a name list which is always abbreviated (with
23266 \begin_inset Quotes eld
23270 \begin_inset Quotes erd
23274 \begin_inset Flex Code
23277 \begin_layout Plain Layout
23279 \change_inserted -712698321 1483979726
23289 \begin_layout Standard
23291 \change_inserted -712698321 1483980314
23292 The order of pre- and surname in the former two lists can be adjusted by
23296 \begin_layout Itemize
23298 \change_inserted -712698321 1483980535
23299 \begin_inset Flex Code
23302 \begin_layout Plain Layout
23304 \change_inserted -712698321 1483980354
23305 !firstnameform %surname%, %prename%
23312 (first author in lists of type 1)
23315 \begin_layout Itemize
23317 \change_inserted -712698321 1483980557
23318 \begin_inset Flex Code
23321 \begin_layout Plain Layout
23323 \change_inserted -712698321 1483980367
23324 !othernameform %surname%, %prename%
23331 (other authors in lists of type 1)
23336 \begin_layout Itemize
23338 \change_inserted -712698321 1483980550
23339 \begin_inset Flex Code
23342 \begin_layout Plain Layout
23344 \change_inserted -712698321 1483980373
23345 !firstbynameform %prename% %surname%
23352 (first author in lists of type 2)
23355 \begin_layout Itemize
23357 \change_inserted -712698321 1483980570
23358 \begin_inset Flex Code
23361 \begin_layout Plain Layout
23363 \change_inserted -712698321 1483980381
23364 !otherbynameform %prename% %surname%
23371 (other authors in lists of type 2)
23374 \begin_layout Standard
23376 \change_inserted -712698321 1483980643
23377 This allows you to configure namings like
23378 \begin_inset Quotes eld
23381 Miller, Peter and Mary Smith: \SpecialChar ldots
23382 , in: John Doe and Pat Green, eds.:\SpecialChar ldots
23384 \begin_inset Quotes erd
23392 \begin_layout Standard
23393 There is one other piece of syntax available in definitions, which looks
23395 \begin_inset Flex Code
23398 \begin_layout Plain Layout
23405 This defines a piece of formatting information that is to be used when
23407 \begin_inset Quotes eld
23411 \begin_inset Quotes erd
23415 Obviously, we do not want to output HTML tags when writing plain text,
23416 so they should be wrapped in
23417 \begin_inset Quotes eld
23421 \begin_inset Quotes erd
23425 \begin_inset Quotes eld
23429 \begin_inset Quotes erd
23435 \begin_layout Standard
23436 Two special sorts of definitions are also possible in a
23437 \begin_inset Flex Code
23440 \begin_layout Plain Layout
23447 An example of the first would be:
23450 \begin_layout LyX-Code
23452 \begin_inset Quotes eld
23456 \begin_inset Quotes erd
23462 \begin_layout Standard
23463 This is an abbreviation, or macro, and it can be used by treating it as
23465 \begin_inset Flex Code
23468 \begin_layout Plain Layout
23477 \begin_inset Flex Code
23480 \begin_layout Plain Layout
23486 exactly as it would treat its definition.
23487 So, let us issue the obvious
23495 \begin_layout LyX-Code
23499 \begin_layout Standard
23500 or anything like it.
23502 shouldn't go into an infinite loop, but it may go into a long one before
23506 \begin_layout Standard
23507 The second sort of special definition might look like this:
23510 \begin_layout LyX-Code
23514 \begin_layout Standard
23515 This defines a translatable piece of text, which allows relevant parts of
23517 \change_inserted -712698321 1483868477
23521 It can be included in a definition by treating it as a key:
23522 \begin_inset Flex Code
23525 \begin_layout Plain Layout
23532 Several of these are predefined in
23533 \begin_inset Flex Code
23536 \begin_layout Plain Layout
23543 \change_inserted -712698321 1483868503
23545 \begin_inset Flex Code
23548 \begin_layout Plain Layout
23550 \change_inserted -712698321 1483868503
23561 Note that these are not macros, in the sense just defined.
23562 They will not be expanded.
23565 \begin_layout Standard
23566 So here then is an example that use all these features:
23567 \begin_inset VSpace defskip
23573 \begin_layout Standard
23577 !authoredit {%author%[[%author%, ]][[{%editor%[[%editor%, %_edtext%, ]]}]]}
23580 \begin_layout Standard
23581 \begin_inset VSpace defskip
23584 This defines a macro that prints the author, followed by a comma, if the
23586 \begin_inset Flex Code
23589 \begin_layout Plain Layout
23595 key is defined, or else prints the name of the editor, followed by the
23597 \begin_inset Flex Code
23600 \begin_layout Plain Layout
23606 or its translation (it is by default
23607 \begin_inset Quotes eld
23611 \begin_inset Quotes erd
23615 \begin_inset Flex Code
23618 \begin_layout Plain Layout
23625 Note that this is in fact defined in
23626 \begin_inset Flex Code
23629 \begin_layout Plain Layout
23635 , so you can use it in your own definitions, or re-definitions, if you load
23639 \begin_layout Section
23640 \begin_inset CommandInset label
23642 name "sec:Tags-for-XHTML"
23646 Tags for XHTML output
23649 \begin_layout Standard
23650 As with \SpecialChar LaTeX
23651 or DocBook, the format of \SpecialChar LyX
23652 's XHTML output is also controlled by
23653 layout information.
23654 In general, \SpecialChar LyX
23655 provides sensible defaults and, as mentioned earlier, it will
23656 even construct default CSS style rules from the other layout tags.
23657 For example, \SpecialChar LyX
23658 will attempt to use the information provided in the
23659 \begin_inset Flex Code
23662 \begin_layout Plain Layout
23668 declaration for the Chapter style to write CSS that will appropriately
23669 format chapter headings.
23672 \begin_layout Standard
23673 In many cases, then, you may not have to do anything at all to get acceptable
23674 XHTML output for your own environments, custom insets, and so forth.
23675 But in some cases you will, and so \SpecialChar LyX
23676 provides a number of layout tags that
23677 can be used to customize the XHTML and CSS that are generated.
23680 \begin_layout Standard
23681 Note that there are two tags,
23682 \begin_inset Flex Code
23685 \begin_layout Plain Layout
23692 \begin_inset Flex Code
23695 \begin_layout Plain Layout
23701 that may appear outside style and inset declarations.
23703 \begin_inset CommandInset ref
23705 reference "subsec:General-text-class"
23709 for details on these.
23712 \begin_layout Subsection
23713 \begin_inset CommandInset label
23715 name "subsec:Paragraph-Style-XHTML"
23722 \begin_layout Standard
23723 The sort of XHTML \SpecialChar LyX
23724 outputs for a paragraph depends upon whether we are dealing
23725 with a normal paragraph, a command, or an environment, where this is itself
23726 determined by the contents of the corresponding
23727 \begin_inset Flex Code
23730 \begin_layout Plain Layout
23741 \begin_layout Standard
23742 For a command or normal paragraph, the output XHTML has the following form:
23745 \begin_layout LyX-Code
23747 \begin_inset Quotes erd
23751 \begin_inset Quotes erd
23757 \begin_layout LyX-Code
23759 \begin_inset Quotes erd
23763 \begin_inset Quotes erd
23769 \begin_layout LyX-Code
23770 Contents of the paragraph.
23773 \begin_layout LyX-Code
23777 \begin_layout Standard
23778 The label tags are of course omitted if the paragraph does not have a label.
23781 \begin_layout Standard
23782 For an environment that is not some sort of list, the XHTML takes this form:
23785 \begin_layout LyX-Code
23787 \begin_inset Quotes erd
23791 \begin_inset Quotes erd
23797 \begin_layout LyX-Code
23799 \begin_inset Quotes erd
23803 \begin_inset Quotes erd
23807 \begin_inset Quotes erd
23811 \begin_inset Quotes erd
23814 >Environment Label</labeltag>First paragraph.</itemtag>
23817 \begin_layout LyX-Code
23818 <itemtag>Second paragraph.</itemtag>
23821 \begin_layout LyX-Code
23825 \begin_layout Standard
23826 Note that the label is output only for the first paragraph, as it should
23827 be for a theorem, for example.
23831 \begin_layout Standard
23832 For a list, we have one of these forms:
23835 \begin_layout LyX-Code
23837 \begin_inset Quotes erd
23841 \begin_inset Quotes erd
23847 \begin_layout LyX-Code
23849 \begin_inset Quotes erd
23853 \begin_inset Quotes erd
23857 \begin_inset Quotes erd
23861 \begin_inset Quotes erd
23864 >List Label</labeltag>First item.</itemtag>
23867 \begin_layout LyX-Code
23869 \begin_inset Quotes erd
23873 \begin_inset Quotes erd
23877 \begin_inset Quotes erd
23881 \begin_inset Quotes erd
23884 >List Label</labeltag>Second item.</itemtag>
23887 \begin_layout LyX-Code
23891 \begin_layout LyX-Code
23895 \begin_layout LyX-Code
23897 \begin_inset Quotes erd
23901 \begin_inset Quotes erd
23907 \begin_layout LyX-Code
23909 \begin_inset Quotes erd
23913 \begin_inset Quotes erd
23916 >List Label</labeltag><itemtag attr=
23917 \begin_inset Quotes erd
23921 \begin_inset Quotes erd
23924 >First item.</itemtag>
23927 \begin_layout LyX-Code
23929 \begin_inset Quotes erd
23933 \begin_inset Quotes erd
23936 >List Label</labeltag><itemtag attr=
23937 \begin_inset Quotes erd
23941 \begin_inset Quotes erd
23944 >Second item.</itemtag>
23947 \begin_layout LyX-Code
23951 \begin_layout Standard
23952 Note the different orders of
23953 \begin_inset Flex Code
23956 \begin_layout Plain Layout
23963 \begin_inset Flex Code
23966 \begin_layout Plain Layout
23973 Which order we get depends upon the setting of
23974 \begin_inset Flex Code
23977 \begin_layout Plain Layout
23984 \begin_inset Flex Code
23987 \begin_layout Plain Layout
23993 is false (the default), you get the first of these, with the label within
23994 the item; if true, you get the second, with the label outside the item.
23997 \begin_layout Standard
23998 The specific tags and attributes output for each paragraph type can be controlle
23999 d by means of the layout tags we are about to describe.
24000 As mentioned earlier, however, \SpecialChar LyX
24001 uses sensible defaults for many of these,
24002 so you often may not need to do very much to get good XHTML output.
24003 Think of the available tags as there so you can tweak things to your liking.
24006 \begin_layout Description
24007 \begin_inset Flex Code
24010 \begin_layout Plain Layout
24017 \begin_inset Flex Code
24020 \begin_layout Plain Layout
24026 ] Specifies attribute information to be output with the main tag.
24028 \begin_inset Quotes eld
24032 \begin_inset Flex Code
24035 \begin_layout Plain Layout
24042 \begin_inset Quotes erd
24046 By default, \SpecialChar LyX
24048 \begin_inset Quotes eld
24052 \begin_inset Flex Code
24055 \begin_layout Plain Layout
24062 \begin_inset Quotes erd
24066 \begin_inset Flex Code
24069 \begin_layout Plain Layout
24075 is the \SpecialChar LyX
24076 name of the layout, made lowercase, for example: chapter.
24081 contain any style information.
24083 \begin_inset Flex Code
24086 \begin_layout Plain Layout
24095 \begin_layout Description
24096 \begin_inset Flex Code
24099 \begin_layout Plain Layout
24106 \begin_inset Flex Code
24109 \begin_layout Plain Layout
24119 ] Whether to output the default CSS information \SpecialChar LyX
24120 generates for this layout,
24121 even if additional information is explicitly provided via
24122 \begin_inset Flex Code
24125 \begin_layout Plain Layout
24133 \begin_inset Flex Code
24136 \begin_layout Plain Layout
24142 allows you to alter or augment the generated CSS, rather than to override
24145 \begin_inset Flex Code
24148 \begin_layout Plain Layout
24157 \begin_layout Description
24158 \begin_inset Flex Code
24161 \begin_layout Plain Layout
24168 \begin_inset Flex Code
24171 \begin_layout Plain Layout
24177 ] The tag to be used for individual paragraphs of environments, replacing
24179 \begin_inset Flex Code
24182 \begin_layout Plain Layout
24188 in the examples above.
24190 \begin_inset Flex Code
24193 \begin_layout Plain Layout
24202 \begin_layout Description
24203 \begin_inset Flex Code
24206 \begin_layout Plain Layout
24213 \begin_inset Flex Code
24216 \begin_layout Plain Layout
24222 ] Attributes for the item tag.
24224 \begin_inset Quotes eld
24228 \begin_inset Flex Code
24231 \begin_layout Plain Layout
24232 class=`layoutname_item'
24238 \begin_inset Quotes erd
24246 contain any style information.
24248 \begin_inset Flex Code
24251 \begin_layout Plain Layout
24260 \begin_layout Description
24261 \begin_inset Flex Code
24264 \begin_layout Plain Layout
24271 \begin_inset Flex Code
24274 \begin_layout Plain Layout
24280 ] The tag to be used for paragraph and item labels, replacing
24281 \begin_inset Flex Code
24284 \begin_layout Plain Layout
24290 in the examples above.
24292 \begin_inset Flex Code
24295 \begin_layout Plain Layout
24302 \begin_inset Flex Code
24305 \begin_layout Plain Layout
24312 \begin_inset Flex Code
24315 \begin_layout Plain Layout
24322 \begin_inset Flex Code
24325 \begin_layout Plain Layout
24326 Centered_Top_Environment
24331 , in which case it defaults to
24332 \begin_inset Flex Code
24335 \begin_layout Plain Layout
24344 \begin_layout Description
24345 \begin_inset Flex Code
24348 \begin_layout Plain Layout
24355 \begin_inset Flex Code
24358 \begin_layout Plain Layout
24364 ] Attributes for the label tag.
24366 \begin_inset Quotes eld
24370 \begin_inset Flex Code
24373 \begin_layout Plain Layout
24374 class=`layoutname_label'
24380 \begin_inset Quotes erd
24388 contain any style information.
24390 \begin_inset Flex Code
24393 \begin_layout Plain Layout
24402 \begin_layout Description
24403 \begin_inset Flex Code
24406 \begin_layout Plain Layout
24413 \begin_inset Flex Code
24416 \begin_layout Plain Layout
24426 ] Meaningful only for list-like environments, this tag controls whether
24427 the label tag is output before or inside the item tag.
24428 This is used, for example, in the description environment, where we want
24430 \begin_inset Flex Code
24433 \begin_layout Plain Layout
24434 <dt>\SpecialChar ldots
24435 </dt><dd>\SpecialChar ldots
24443 \begin_inset Flex Code
24446 \begin_layout Plain Layout
24452 : The label tag is output inside the item tag.
24455 \begin_layout Description
24456 \begin_inset Flex Code
24459 \begin_layout Plain Layout
24465 Information to be output in the
24466 \begin_inset Flex Code
24469 \begin_layout Plain Layout
24475 section when this style is used.
24476 This might, for example, be used to include a
24477 \begin_inset Flex Code
24480 \begin_layout Plain Layout
24487 \begin_inset Flex Code
24490 \begin_layout Plain Layout
24499 \begin_layout Description
24500 \begin_inset Flex Code
24503 \begin_layout Plain Layout
24509 CSS style information to be included when this style is used.
24510 Note that this will automatically be wrapped in a layout-generated
24511 \begin_inset Flex Code
24514 \begin_layout Plain Layout
24520 block, so only the CSS itself need be included.
24522 \begin_inset Flex Code
24525 \begin_layout Plain Layout
24534 \begin_layout Description
24535 \begin_inset Flex Code
24538 \begin_layout Plain Layout
24545 \begin_inset Flex Code
24548 \begin_layout Plain Layout
24554 ] The tag to be used for the main label, replacing
24555 \begin_inset Flex Code
24558 \begin_layout Plain Layout
24564 in the examples above.
24566 \begin_inset Flex Code
24569 \begin_layout Plain Layout
24578 \begin_layout Description
24579 \begin_inset Flex Code
24582 \begin_layout Plain Layout
24589 \begin_inset Flex Code
24592 \begin_layout Plain Layout
24602 ] Marks this style as the one to be used to generate the
24603 \begin_inset Flex Code
24606 \begin_layout Plain Layout
24612 tag for the XHTML file.
24613 By default, it is false.
24615 \begin_inset Flex Code
24618 \begin_layout Plain Layout
24624 file sets it to true for the
24625 \begin_inset Flex Code
24628 \begin_layout Plain Layout
24638 \begin_layout Subsection
24642 \begin_layout Standard
24643 The XHTML output of insets can also be controlled by information in layout
24648 \begin_layout Plain Layout
24649 At present, this is true only for
24650 \begin_inset Quotes eld
24654 \begin_inset Quotes erd
24657 insets (insets you can type into) and is not true for
24658 \begin_inset Quotes eld
24662 \begin_inset Quotes erd
24665 insets (insets that are associated with dialog boxes).
24670 Here, too, \SpecialChar LyX
24671 tries to provide sensible defaults, and it constructs default
24673 But everything can be customized.
24676 \begin_layout Standard
24677 The XHTML \SpecialChar LyX
24678 outputs for an inset has the following form:
24681 \begin_layout LyX-Code
24683 \begin_inset Quotes erd
24687 \begin_inset Quotes erd
24693 \begin_layout LyX-Code
24694 <labeltag>Label</labeltag>
24697 \begin_layout LyX-Code
24699 \begin_inset Quotes erd
24703 \begin_inset Quotes erd
24706 >Contents of the inset.</innertag>
24709 \begin_layout LyX-Code
24713 \begin_layout Standard
24714 If the inset permits multiple paragraphs—that is, if
24715 \begin_inset Flex Code
24718 \begin_layout Plain Layout
24724 is true—then the contents of the inset will itself be output as paragraphs
24725 formatted according to the styles used for those paragraphs (standard,
24726 quote, and the like).
24727 The label tag is of course omitted if the paragraph does not have a label
24728 and, at present, is always
24729 \begin_inset Flex Code
24732 \begin_layout Plain Layout
24739 The inner tag is optional and, by default, does not appear.
24742 \begin_layout Standard
24743 The specific tags and attributes output for each inset can be controlled
24744 by means of the following layout tags.
24747 \begin_layout Description
24748 \begin_inset Flex Code
24751 \begin_layout Plain Layout
24758 \begin_inset Flex Code
24761 \begin_layout Plain Layout
24767 ] Specifies attribute information to be output with the main tag.
24769 \begin_inset Quotes eld
24773 \begin_inset Flex Code
24776 \begin_layout Plain Layout
24777 class=`myinset' onclick=`\SpecialChar ldots
24784 \begin_inset Quotes erd
24788 By default, \SpecialChar LyX
24790 \begin_inset Quotes eld
24794 \begin_inset Flex Code
24797 \begin_layout Plain Layout
24804 \begin_inset Quotes erd
24808 \begin_inset Flex Code
24811 \begin_layout Plain Layout
24817 is the \SpecialChar LyX
24818 name of the inset, made lowercase and with non-alphanumeric characters
24819 converted to underscores, for example: footnote.
24822 \begin_layout Description
24823 \begin_inset Flex Code
24826 \begin_layout Plain Layout
24833 \begin_inset Flex Code
24836 \begin_layout Plain Layout
24846 ] Whether to output the default CSS information \SpecialChar LyX
24847 generates for this layout,
24848 even if additional information is explicitly provided via
24849 \begin_inset Flex Code
24852 \begin_layout Plain Layout
24860 \begin_inset Flex Code
24863 \begin_layout Plain Layout
24869 allows you to alter or augment the generated CSS, rather than to override
24874 \begin_layout Description
24875 \begin_inset Flex Code
24878 \begin_layout Plain Layout
24885 \begin_inset Flex Code
24888 \begin_layout Plain Layout
24894 ] Attributes for the inner tag.
24896 \begin_inset Quotes eld
24900 \begin_inset Flex Code
24903 \begin_layout Plain Layout
24904 class=`insetname_inner'
24910 \begin_inset Quotes erd
24916 \begin_layout Description
24917 \begin_inset Flex Code
24920 \begin_layout Plain Layout
24927 \begin_inset Flex Code
24930 \begin_layout Plain Layout
24936 ] The inner tag, replacing
24937 \begin_inset Flex Code
24940 \begin_layout Plain Layout
24946 in the examples above.
24947 By default, there is none.
24950 \begin_layout Description
24951 \begin_inset Flex Code
24954 \begin_layout Plain Layout
24961 \begin_inset Flex Code
24964 \begin_layout Plain Layout
24972 ] Whether this inset represents a standalone block of text (such as a footnote)
24973 or instead represents material that is included in the surrounding text
24974 (such as a branch).
24978 \begin_layout Description
24979 \begin_inset Flex Code
24982 \begin_layout Plain Layout
24989 \begin_inset Flex Code
24992 \begin_layout Plain Layout
24998 ] A label for this inset, possibly including a reference to a counter.
24999 For example, for footnote, it might be:
25000 \begin_inset Flex Code
25003 \begin_layout Plain Layout
25012 This is optional, and there is no default.
25015 \begin_layout Description
25016 \begin_inset Flex Code
25019 \begin_layout Plain Layout
25025 Information to be output in the
25026 \begin_inset Flex Code
25029 \begin_layout Plain Layout
25035 section when this style is used.
25036 This might, for example, be used to include a
25037 \begin_inset Flex Code
25040 \begin_layout Plain Layout
25047 \begin_inset Flex Code
25050 \begin_layout Plain Layout
25059 \begin_layout Description
25060 \begin_inset Flex Code
25063 \begin_layout Plain Layout
25069 CSS style information to be included when this style is used.
25070 Note that this will automatically be wrapped in a layout-generated
25071 \begin_inset Flex Code
25074 \begin_layout Plain Layout
25080 block, so only the CSS itself need be included.
25083 \begin_layout Description
25084 \begin_inset Flex Code
25087 \begin_layout Plain Layout
25094 \begin_inset Flex Code
25097 \begin_layout Plain Layout
25103 ] The tag to be used for the main label, replacing
25104 \begin_inset Flex Code
25107 \begin_layout Plain Layout
25113 in the examples above.
25114 The default depends upon the setting of
25115 \begin_inset Flex Code
25118 \begin_layout Plain Layout
25125 \begin_inset Flex Code
25128 \begin_layout Plain Layout
25134 is true, the default is
25135 \begin_inset Flex Code
25138 \begin_layout Plain Layout
25144 ; if it is false, the default is
25145 \begin_inset Flex Code
25148 \begin_layout Plain Layout
25157 \begin_layout Subsection
25161 \begin_layout Standard
25162 The XHTML output for floats too can be controlled by layout information.
25163 The output has the following form:
25166 \begin_layout LyX-Code
25168 \begin_inset Quotes erd
25172 \begin_inset Quotes erd
25178 \begin_layout LyX-Code
25179 Contents of the float.
25182 \begin_layout LyX-Code
25186 \begin_layout Standard
25187 The caption, if there is one, is a separate inset and will be output as
25189 Its appearance can be controlled via the InsetLayout for caption insets.
25193 \begin_layout Description
25194 \begin_inset Flex Code
25197 \begin_layout Plain Layout
25204 \begin_inset Flex Code
25207 \begin_layout Plain Layout
25213 ] Specifies attribute information to be output with the main tag.
25215 \begin_inset Quotes eld
25219 \begin_inset Flex Code
25222 \begin_layout Plain Layout
25223 class=`myfloat' onclick=`\SpecialChar ldots
25230 \begin_inset Quotes erd
25234 By default, \SpecialChar LyX
25236 \begin_inset Quotes eld
25240 \begin_inset Flex Code
25243 \begin_layout Plain Layout
25244 class=`float float-floattype'
25250 \begin_inset Quotes erd
25254 \begin_inset Flex Code
25257 \begin_layout Plain Layout
25263 is \SpecialChar LyX
25264 's name for this type of float, as determined by the float declaration
25266 \begin_inset CommandInset ref
25268 reference "subsec:Floats"
25272 ), though made lowercase and with non-alphanumeric characters converted
25273 to underscores, for example: float-table.
25276 \begin_layout Description
25277 \begin_inset Flex Code
25280 \begin_layout Plain Layout
25286 CSS style information to be included when this float is used.
25287 Note that this will automatically be wrapped in a layout-generated
25288 \begin_inset Flex Code
25291 \begin_layout Plain Layout
25297 block, so only the CSS itself need be included.
25300 \begin_layout Description
25301 \begin_inset Flex Code
25304 \begin_layout Plain Layout
25311 \begin_inset Flex Code
25314 \begin_layout Plain Layout
25320 ] The tag to be used for this float, replacing
25321 \begin_inset Quotes eld
25325 \begin_inset Flex Code
25328 \begin_layout Plain Layout
25335 \begin_inset Quotes erd
25338 in the example above.
25340 \begin_inset Flex Code
25343 \begin_layout Plain Layout
25349 and will rarely need changing.
25352 \begin_layout Subsection
25353 Bibliography formatting
25356 \begin_layout Standard
25357 The bibliography can be formatted using
25358 \begin_inset Flex Code
25361 \begin_layout Plain Layout
25369 \begin_inset CommandInset ref
25371 reference "subsec:Citation-format-description"
25378 \begin_layout Subsection
25383 \begin_layout Standard
25384 We have several times mentioned that \SpecialChar LyX
25385 will generate default CSS style rules
25386 for both insets and paragraph styles, based upon the other layout information
25388 In this section, we shall say a word about which layout information \SpecialChar LyX
25393 \begin_layout Standard
25394 At present, \SpecialChar LyX
25395 auto-generates CSS only for font information, making use of
25397 \begin_inset Flex Code
25400 \begin_layout Plain Layout
25407 \begin_inset Flex Code
25410 \begin_layout Plain Layout
25417 \begin_inset Flex Code
25420 \begin_layout Plain Layout
25427 \begin_inset Flex Code
25430 \begin_layout Plain Layout
25437 \begin_inset Flex Code
25440 \begin_layout Plain Layout
25447 \begin_inset CommandInset ref
25449 reference "subsec:Font-description"
25454 The translation is mostly straightforward and obvious.
25456 \begin_inset Quotes eld
25460 \begin_inset Flex Code
25463 \begin_layout Plain Layout
25470 \begin_inset Quotes erd
25474 \begin_inset Quotes eld
25478 \begin_inset Flex Code
25481 \begin_layout Plain Layout
25482 font-family: sans-serif;
25488 \begin_inset Quotes erd
25492 The correspondence of \SpecialChar LyX
25493 sizes and CSS sizes is a little less obvious but
25494 nonetheless intuitive.
25496 \begin_inset Flex Code
25499 \begin_layout Plain Layout
25506 \begin_inset Flex URL
25509 \begin_layout Plain Layout
25519 \begin_layout Chapter
25520 Including External Material
25521 \begin_inset CommandInset label
25523 name "chap:Including-External-Material"
25530 \begin_layout Standard
25531 \begin_inset Box Shadowbox
25541 height_special "totalheight"
25546 backgroundcolor "none"
25549 \begin_layout Plain Layout
25550 WARNING: This portion of the documentation has not been updated for some
25552 We certainly hope that it is still accurate, but there are no guarantees.
25560 \begin_layout Standard
25561 The use of material from sources external to \SpecialChar LyX
25562 is covered in detail in the
25568 This part of the manual covers what needs to happen behind the scenes for
25569 new sorts of material to be included.
25572 \begin_layout Section
25576 \begin_layout Standard
25577 The external material feature is based on the concept of a
25582 A template is a specification of how \SpecialChar LyX
25583 should interface with a certain kind
25585 As bundled, \SpecialChar LyX
25586 comes with predefined templates for Xfig figures, various
25587 raster format images, chess diagrams, and LilyPond music notation.
25588 You can check the actual list by using the menu
25589 \begin_inset Flex Noun
25592 \begin_layout Plain Layout
25593 Insert\SpecialChar menuseparator
25594 File\SpecialChar menuseparator
25601 Furthermore, it is possible to roll your own template to support a specific
25603 Later we'll describe in more detail what is involved, and hopefully you
25604 will submit all the templates you create so we can include them in a later
25609 \begin_layout Standard
25610 Another basic idea of the external material feature is to distinguish between
25611 the original file that serves as a base for final material and the produced
25612 file that is included in your exported or printed document.
25613 For example, consider the case of a figure produced with
25614 \begin_inset Flex Code
25617 \begin_layout Plain Layout
25624 The Xfig application itself works on an original file with the
25625 \begin_inset Flex Code
25628 \begin_layout Plain Layout
25635 Within Xfig, you create and change your figure, and when you are done,
25637 \begin_inset Flex Code
25640 \begin_layout Plain Layout
25647 When you want to include the figure in your document, you invoke
25648 \begin_inset Flex Code
25651 \begin_layout Plain Layout
25657 in order to create a PostScript file that can readily be included in your
25661 \begin_inset Flex Code
25664 \begin_layout Plain Layout
25670 file is the original file, and the PostScript file is the produced file.
25673 \begin_layout Standard
25674 This distinction is important in order to allow updating of the material
25675 while you are in the process of writing the document.
25676 Furthermore, it provides us with the flexibility that is needed to support
25677 multiple export formats.
25678 For instance, in the case of a plain text file, it is not exactly an award-winn
25679 ing idea to include the figure as raw PostScript.
25680 Instead, you would either prefer to just include a reference to the figure
25681 or try to invoke some graphics to ASCII converter to make the final result
25682 look similar to the real graphics.
25683 The external material management allows you to do this, because it is parametri
25684 zed on the different export formats that \SpecialChar LyX
25688 \begin_layout Standard
25689 Besides supporting the production of different products according to the
25690 exported format, it supports tight integration with editing and viewing
25692 In the case of an Xfig figure, you are able to invoke Xfig on the original
25693 file with a single click from within the external material dialog in \SpecialChar LyX
25695 and also preview the produced PostScript file with Ghostview with another
25697 No more fiddling around with the command line and/or file browsers to locate
25698 and manipulate the original or produced files.
25699 In this way, you are finally able to take full advantage of the many different
25700 applications that are relevant to use when you write your documents, and
25701 ultimately be more productive.
25704 \begin_layout Section
25705 The external template configuration file
25706 \change_inserted -712698321 1490533960
25712 \begin_layout Standard
25713 It is relatively easy to add custom external template definitions to \SpecialChar LyX
25715 However, be aware that doing this in an careless manner most probably
25719 introduce an easily exploitable security hole.
25720 So before you do this, please read the discussion about security in
25721 \begin_inset CommandInset ref
25723 reference "sec:Security-discussion"
25730 \begin_layout Standard
25731 Having said that, we encourage you to submit any interesting templates that
25736 \begin_layout Standard
25737 The external templates are defined in the
25738 \change_inserted -712698321 1490534022
25740 \begin_inset Flex Code
25743 \begin_layout Plain Layout
25745 \change_inserted -712698321 1490533996
25751 files that are stored in the
25754 \begin_inset Flex Code
25757 \begin_layout Plain Layout
25759 \change_deleted -712698321 1490533984
25761 \change_inserted -712698321 1490533984
25765 \change_inserted -712698321 1490534077
25774 \change_deleted -712698321 1490534025
25776 \change_inserted -712698321 1490534028
25781 \change_inserted -712698321 1490534233
25782 Each template is defined in a file of its own.
25785 You can place your own
25786 \change_deleted -712698321 1490534089
25788 \change_inserted -712698321 1490534090
25792 \begin_inset Flex Code
25795 \begin_layout Plain Layout
25797 \change_deleted -712698321 1490534069
25799 \change_inserted -712698321 1490534069
25803 \change_inserted -712698321 1490534080
25812 \change_inserted -712698321 1490534112
25813 or copy existing templates to that directory in order to modify them
25818 \begin_layout Standard
25819 A typical template looks like this:
25822 \begin_layout LyX-Code
25826 \begin_layout LyX-Code
25827 GuiName "XFig: $$AbsOrRelPathParent$$Basename"
25830 \begin_layout LyX-Code
25834 \begin_layout LyX-Code
25838 \begin_layout LyX-Code
25842 \begin_layout LyX-Code
25846 \begin_layout LyX-Code
25850 \begin_layout LyX-Code
25851 AutomaticProduction true
25854 \begin_layout LyX-Code
25858 \begin_layout LyX-Code
25862 \begin_layout LyX-Code
25866 \begin_layout LyX-Code
25867 TransformCommand Rotate RotationLatexCommand
25870 \begin_layout LyX-Code
25871 TransformCommand Resize ResizeLatexCommand
25874 \begin_layout LyX-Code
25875 Product "$$RotateFront$$ResizeFront
25878 \begin_layout LyX-Code
25883 input{$$AbsOrRelPathMaster$$Basename.pstex_t}
25886 \begin_layout LyX-Code
25887 $$ResizeBack$$RotateBack"
25890 \begin_layout LyX-Code
25894 \begin_layout LyX-Code
25895 UpdateResult "$$AbsPath$$Basename.pstex_t"
25898 \begin_layout LyX-Code
25899 Requirement "graphicx"
25902 \begin_layout LyX-Code
25903 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
25906 \begin_layout LyX-Code
25907 ReferencedFile latex "$$AbsPath$$Basename.eps"
25910 \begin_layout LyX-Code
25911 ReferencedFile dvi "$$AbsPath$$Basename.eps"
25914 \begin_layout LyX-Code
25918 \begin_layout LyX-Code
25922 \begin_layout LyX-Code
25923 TransformCommand Rotate RotationLatexCommand
25926 \begin_layout LyX-Code
25927 TransformCommand Resize ResizeLatexCommand
25930 \begin_layout LyX-Code
25931 Product "$$RotateFront$$ResizeFront
25934 \begin_layout LyX-Code
25939 input{$$AbsOrRelPathMaster$$Basename.pdftex_t}
25942 \begin_layout LyX-Code
25943 $$ResizeBack$$RotateBack"
25946 \begin_layout LyX-Code
25947 UpdateFormat pdftex
25950 \begin_layout LyX-Code
25951 UpdateResult "$$AbsPath$$Basename.pdftex_t"
25954 \begin_layout LyX-Code
25955 Requirement "graphicx"
25958 \begin_layout LyX-Code
25959 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pdftex_t"
25962 \begin_layout LyX-Code
25963 ReferencedFile latex "$$AbsPath$$Basename.pdf"
25966 \begin_layout LyX-Code
25970 \begin_layout LyX-Code
25974 \begin_layout LyX-Code
25975 Product "[XFig: $$FName]"
25978 \begin_layout LyX-Code
25982 \begin_layout LyX-Code
25986 \begin_layout LyX-Code
25987 Product "<graphic fileref=
25989 "$$AbsOrRelPathMaster$$Basename.eps
25994 \begin_layout LyX-Code
25998 \begin_layout LyX-Code
26002 \begin_layout LyX-Code
26003 UpdateResult "$$AbsPath$$Basename.eps"
26006 \begin_layout LyX-Code
26007 ReferencedFile docbook "$$AbsPath$$Basename.eps"
26010 \begin_layout LyX-Code
26011 ReferencedFile docbook-xml "$$AbsPath$$Basename.eps"
26014 \begin_layout LyX-Code
26018 \begin_layout LyX-Code
26022 \begin_layout Standard
26023 As you can see, the template is enclosed in
26024 \begin_inset Flex Code
26027 \begin_layout Plain Layout
26035 \begin_inset Flex Code
26038 \begin_layout Plain Layout
26045 It contains a header specifying some general settings and, for each supported
26046 primary document file format, a section
26047 \begin_inset Flex Code
26050 \begin_layout Plain Layout
26058 \begin_inset Flex Code
26061 \begin_layout Plain Layout
26070 \begin_layout Subsection
26071 The template header
26074 \begin_layout Description
26075 \begin_inset Flex Code
26078 \begin_layout Plain Layout
26079 AutomaticProduction
26080 \begin_inset space ~
26088 Whether the file represented by the template must be generated by \SpecialChar LyX
26090 This command must occur exactly once.
26093 \begin_layout Description
26094 \begin_inset Flex Code
26097 \begin_layout Plain Layout
26099 \begin_inset space ~
26107 A glob pattern that is used in the file dialog to filter out the desired
26109 If there is more than one possible file extension (e.
26110 \begin_inset space \thinspace{}
26114 \begin_inset space \space{}
26118 \begin_inset Flex Code
26121 \begin_layout Plain Layout
26128 \begin_inset Flex Code
26131 \begin_layout Plain Layout
26137 ), use something like
26138 \begin_inset Flex Code
26141 \begin_layout Plain Layout
26148 This command must occur exactly once.
26151 \begin_layout Description
26152 \begin_inset Flex Code
26155 \begin_layout Plain Layout
26157 \begin_inset space ~
26165 The text that is displayed on the button.
26166 This command must occur exactly once.
26169 \begin_layout Description
26170 \begin_inset Flex Code
26173 \begin_layout Plain Layout
26175 \begin_inset space ~
26179 \begin_inset space ~
26187 The help text that is used in the External dialog.
26188 Provide enough information to explain to the user just what the template
26189 can provide him with.
26190 This command must occur exactly once.
26193 \begin_layout Description
26194 \begin_inset Flex Code
26197 \begin_layout Plain Layout
26199 \begin_inset space ~
26207 The file format of the original file.
26208 This must be the name of a format that is known to \SpecialChar LyX
26210 \begin_inset CommandInset ref
26212 reference "sec:Formats"
26218 \begin_inset Quotes eld
26222 \begin_inset Flex Code
26225 \begin_layout Plain Layout
26232 \begin_inset Quotes erd
26235 if the template can handle original files of more than one format.
26237 will attempt to interrogate the file itself in order to deduce its format
26239 This command must occur exactly once.
26242 \begin_layout Description
26243 \begin_inset Flex Code
26246 \begin_layout Plain Layout
26248 \begin_inset space ~
26256 A unique name for the template.
26257 It must not contain substitution macros (see below).
26260 \begin_layout Description
26261 \begin_inset Flex Code
26264 \begin_layout Plain Layout
26266 \begin_inset space ~
26269 Rotate|Resize|Clip|Extra
26274 This command specifies which transformations are supported by this template.
26275 It may occur zero or more times.
26276 This command enables the corresponding tabs in the external dialog.
26278 \begin_inset Flex Code
26281 \begin_layout Plain Layout
26287 command must have either a corresponding
26288 \begin_inset Flex Code
26291 \begin_layout Plain Layout
26298 \begin_inset Flex Code
26301 \begin_layout Plain Layout
26308 \begin_inset Flex Code
26311 \begin_layout Plain Layout
26318 Otherwise the transformation will not be supported by that format.
26321 \begin_layout Subsection
26325 \begin_layout Description
26326 \begin_inset Flex Code
26329 \begin_layout Plain Layout
26331 \begin_inset space ~
26334 LaTeX|PDFLaTeX|PlainText|DocBook|XHTML
26339 The primary document file format that this format definition is for.
26340 Not every template has a sensible representation in all document file formats.
26341 Please define nevertheless a
26342 \begin_inset Flex Code
26345 \begin_layout Plain Layout
26351 section for all templates.
26352 Use a dummy text when no representation is available.
26353 Then you can at least see a reference to the external material in the exported
26357 \begin_layout Description
26358 \begin_inset Flex Code
26361 \begin_layout Plain Layout
26363 \begin_inset space ~
26367 \begin_inset space ~
26375 This command defines an additional macro
26376 \begin_inset Flex Code
26379 \begin_layout Plain Layout
26385 for substitution in
26386 \begin_inset Flex Code
26389 \begin_layout Plain Layout
26397 \begin_inset Flex Code
26400 \begin_layout Plain Layout
26406 itself may contain substitution macros.
26407 The advantage over using
26408 \begin_inset Flex Code
26411 \begin_layout Plain Layout
26418 \begin_inset Flex Code
26421 \begin_layout Plain Layout
26427 is that the substituted value of
26428 \begin_inset Flex Code
26431 \begin_layout Plain Layout
26437 is sanitized so that it is a valid optional argument in the document format.
26438 This command may occur zero or more times.
26441 \begin_layout Description
26442 \begin_inset Flex Code
26445 \begin_layout Plain Layout
26447 \begin_inset space ~
26455 The text that is inserted in the exported document.
26456 This is actually the most important command and can be quite complex.
26457 This command must occur exactly once.
26460 \begin_layout Description
26461 \begin_inset Flex Code
26464 \begin_layout Plain Layout
26466 \begin_inset space ~
26474 This command specifies a preamble snippet that will be included in the
26477 It has to be defined using
26478 \begin_inset Flex Code
26481 \begin_layout Plain Layout
26489 \begin_inset Flex Code
26492 \begin_layout Plain Layout
26499 This command may occur zero or more times.
26502 \begin_layout Description
26503 \begin_inset Flex Code
26506 \begin_layout Plain Layout
26508 \begin_inset space ~
26512 \begin_inset space ~
26520 This command denotes files that are created by the conversion process and
26521 are needed for a particular export format.
26522 If the filename is relative, it is interpreted relative to the master document.
26523 This command may be given zero or more times.
26526 \begin_layout Description
26527 \begin_inset Flex Code
26530 \begin_layout Plain Layout
26532 \begin_inset space ~
26540 The name of a required \SpecialChar LaTeX
26542 The package is included via
26543 \begin_inset Flex Code
26546 \begin_layout Plain Layout
26554 in the \SpecialChar LaTeX
26556 This command may occur zero or more times.
26559 \begin_layout Description
26560 \begin_inset Flex Code
26563 \begin_layout Plain Layout
26565 \begin_inset space ~
26569 \begin_inset space ~
26572 RotationLatexCommand
26577 This command specifies that the built in \SpecialChar LaTeX
26578 command should be used for rotation.
26579 This command may occur once or not at all.
26582 \begin_layout Description
26583 \begin_inset Flex Code
26586 \begin_layout Plain Layout
26588 \begin_inset space ~
26592 \begin_inset space ~
26600 This command specifies that the built in \SpecialChar LaTeX
26601 command should be used for resizing.
26602 This command may occur once or not at all.
26605 \begin_layout Description
26606 \begin_inset Flex Code
26609 \begin_layout Plain Layout
26611 \begin_inset space ~
26615 \begin_inset space ~
26618 RotationLatexOption
26623 This command specifies that rotation is done via an optional argument.
26624 This command may occur once or not at all.
26627 \begin_layout Description
26628 \begin_inset Flex Code
26631 \begin_layout Plain Layout
26633 \begin_inset space ~
26637 \begin_inset space ~
26645 This command specifies that resizing is done via an optional argument.
26646 This command may occur once or not at all.
26649 \begin_layout Description
26650 \begin_inset Flex Code
26653 \begin_layout Plain Layout
26655 \begin_inset space ~
26659 \begin_inset space ~
26667 This command specifies that clipping is done via an optional argument.
26668 This command may occur once or not at all.
26671 \begin_layout Description
26672 \begin_inset Flex Code
26675 \begin_layout Plain Layout
26677 \begin_inset space ~
26681 \begin_inset space ~
26689 This command specifies that an extra optional argument is used.
26690 This command may occur once or not at all.
26693 \begin_layout Description
26694 \begin_inset Flex Code
26697 \begin_layout Plain Layout
26699 \begin_inset space ~
26707 The file format of the converted file.
26708 This must be the name of a format that is known to \SpecialChar LyX
26710 \begin_inset Flex Noun
26713 \begin_layout Plain Layout
26714 Tools\SpecialChar menuseparator
26715 Preferences\SpecialChar menuseparator
26716 File Handling\SpecialChar menuseparator
26723 This command must occur exactly once.
26724 If the resulting file format is PDF, you need to specify the format
26725 \begin_inset Flex Code
26728 \begin_layout Plain Layout
26735 This is the PDF format used for including graphics.
26736 The other defined PDF formats are for document export.
26739 \begin_layout Description
26740 \begin_inset Flex Code
26743 \begin_layout Plain Layout
26745 \begin_inset space ~
26753 The file name of the converted file.
26754 The file name must be absolute.
26755 This command must occur exactly once.
26758 \begin_layout Subsection
26759 Preamble definitions
26762 \begin_layout Standard
26763 The external template configuration file may contain additional preamble
26764 definitions enclosed by
26765 \begin_inset Flex Code
26768 \begin_layout Plain Layout
26776 \begin_inset Flex Code
26779 \begin_layout Plain Layout
26786 They can be used by the templates in the
26787 \begin_inset Flex Code
26790 \begin_layout Plain Layout
26799 \begin_layout Section
26800 The substitution mechanism
26803 \begin_layout Standard
26804 When the external material facility invokes an external program, it is done
26805 on the basis of a command defined in the template configuration file.
26806 These commands can contain various macros that are expanded before execution.
26807 Execution always take place in the directory of the containing document.
26810 \begin_layout Standard
26811 Also, whenever external material is to be displayed, the name will be produced
26812 by the substitution mechanism, and most other commands in the template
26813 definition support substitution as well.
26816 \begin_layout Standard
26817 The available macros are the following:
26820 \begin_layout Description
26821 \begin_inset Flex Code
26824 \begin_layout Plain Layout
26825 $$AbsOrRelPathMaster
26830 The file path, absolute or relative to the master \SpecialChar LyX
26834 \begin_layout Description
26835 \begin_inset Flex Code
26838 \begin_layout Plain Layout
26839 $$AbsOrRelPathParent
26844 The file path, absolute or relative to the \SpecialChar LyX
26848 \begin_layout Description
26849 \begin_inset Flex Code
26852 \begin_layout Plain Layout
26858 The absolute file path.
26861 \begin_layout Description
26862 \begin_inset Flex Code
26865 \begin_layout Plain Layout
26871 The filename without path and without the extension.
26874 \begin_layout Description
26875 \begin_inset Flex Code
26878 \begin_layout Plain Layout
26880 \begin_inset Quotes eld
26884 \begin_inset Quotes erd
26892 This macro will expand to the contents of the file with the name
26893 \begin_inset Flex Code
26896 \begin_layout Plain Layout
26905 \begin_layout Description
26906 \begin_inset Flex Code
26909 \begin_layout Plain Layout
26915 The file extension (including the dot).
26918 \begin_layout Description
26919 \begin_inset Flex Code
26922 \begin_layout Plain Layout
26928 This will be the string
26929 \begin_inset Quotes eld
26933 \begin_inset Quotes erd
26936 if the file is in JPEG format, otherwise it will be the string
26937 \begin_inset Quotes eld
26941 \begin_inset Quotes erd
26945 This is useful to avoid uneeded conversions for output formats that support
26946 both PNG and JPEG fomats.
26947 The predefined RasterImage template uses this macro for the pdf\SpecialChar TeX
26952 \begin_layout Description
26953 \begin_inset Flex Code
26956 \begin_layout Plain Layout
26962 The filename of the file specified in the external material dialog.
26963 This is either an absolute name, or it is relative to the \SpecialChar LyX
26967 \begin_layout Description
26968 \begin_inset Flex Code
26971 \begin_layout Plain Layout
26978 \begin_inset Flex Code
26981 \begin_layout Plain Layout
26987 (absolute name or relative to the \SpecialChar LyX
26991 \begin_layout Description
26992 \begin_inset Flex Code
26995 \begin_layout Plain Layout
27001 The file path, relative to the master \SpecialChar LyX
27005 \begin_layout Description
27006 \begin_inset Flex Code
27009 \begin_layout Plain Layout
27015 The file path, relative to the \SpecialChar LyX
27019 \begin_layout Description
27020 \begin_inset Flex Code
27023 \begin_layout Plain Layout
27029 This macro will expand to the absolute path of the system directory.
27030 This is typically used to point to the various helper scripts that are
27031 bundled with \SpecialChar LyX
27035 \begin_layout Description
27036 \begin_inset Flex Code
27039 \begin_layout Plain Layout
27045 A name and full path to a temporary file which will be automatically deleted
27046 whenever the containing document is closed, or the external material insertion
27050 \begin_layout Standard
27051 All path macros contain a trailing directory separator, so you can construct
27053 \begin_inset space \thinspace{}
27057 \begin_inset space \space{}
27060 the absolute filename with
27061 \begin_inset Flex Code
27064 \begin_layout Plain Layout
27065 $$AbsPath$$Basename$$Extension
27073 \begin_layout Standard
27074 The macros above are substituted in all commands unless otherwise noted.
27076 \begin_inset Flex Code
27079 \begin_layout Plain Layout
27085 supports additionally the following substitutions if they are enabled by
27087 \begin_inset Flex Code
27090 \begin_layout Plain Layout
27097 \begin_inset Flex Code
27100 \begin_layout Plain Layout
27109 \begin_layout Description
27110 \begin_inset Flex Code
27113 \begin_layout Plain Layout
27119 The front part of the resize command.
27122 \begin_layout Description
27123 \begin_inset Flex Code
27126 \begin_layout Plain Layout
27132 The back part of the resize command.
27135 \begin_layout Description
27136 \begin_inset Flex Code
27139 \begin_layout Plain Layout
27145 The front part of the rotation command.
27148 \begin_layout Description
27149 \begin_inset Flex Code
27152 \begin_layout Plain Layout
27158 The back part of the rotation command.
27161 \begin_layout Standard
27162 The value string of the
27163 \begin_inset Flex Code
27166 \begin_layout Plain Layout
27172 command supports additionally the following substitutions if they are enabled
27174 \begin_inset Flex Code
27177 \begin_layout Plain Layout
27184 \begin_inset Flex Code
27187 \begin_layout Plain Layout
27196 \begin_layout Description
27197 \begin_inset Flex Code
27200 \begin_layout Plain Layout
27209 \begin_layout Description
27210 \begin_inset Flex Code
27213 \begin_layout Plain Layout
27222 \begin_layout Description
27223 \begin_inset Flex Code
27226 \begin_layout Plain Layout
27235 \begin_layout Description
27236 \begin_inset Flex Code
27239 \begin_layout Plain Layout
27245 The rotation option.
27248 \begin_layout Standard
27249 You may ask why there are so many path macros.
27250 There are mainly two reasons:
27253 \begin_layout Enumerate
27254 Relative and absolute file names should remain relative or absolute, respectivel
27256 Users may have reasons to prefer either form.
27257 Relative names are useful for portable documents that should work on different
27258 machines, for example.
27259 Absolute names may be required by some programs.
27262 \begin_layout Enumerate
27264 treats relative file names differently than \SpecialChar LyX
27265 and other programs in nested
27267 For \SpecialChar LyX
27268 , a relative file name is always relative to the document that contains
27270 For \SpecialChar LaTeX
27271 , it is always relative to the master document.
27272 These two definitions are identical if you have only one document, but
27273 differ if you have a master document that includes part documents.
27274 That means that relative filenames must be transformed when presented to
27277 Fortunately \SpecialChar LyX
27278 does this automatically for you if you choose the right macros.
27281 \begin_layout Standard
27282 So which path macro should be used in new template definitions? The rule
27286 \begin_layout Itemize
27288 \begin_inset Flex Code
27291 \begin_layout Plain Layout
27297 if an absolute path is required.
27300 \begin_layout Itemize
27302 \begin_inset Flex Code
27305 \begin_layout Plain Layout
27306 $$AbsOrRelPathMaster
27311 if the substituted string is some kind of \SpecialChar LaTeX
27315 \begin_layout Itemize
27317 \begin_inset Flex Code
27320 \begin_layout Plain Layout
27321 $$AbsOrRelPathParent
27326 in order to preserve the user's choice.
27329 \begin_layout Standard
27330 There are special cases where this rule does not work and e.
27331 \begin_inset space \thinspace{}
27335 \begin_inset space \space{}
27338 relative names are needed, but normally it will work just fine.
27339 One example for such a case is the command
27340 \begin_inset Flex Code
27343 \begin_layout Plain Layout
27344 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
27349 in the XFig template above: We can't use the absolute name because the
27351 \begin_inset Flex Code
27354 \begin_layout Plain Layout
27360 files needs the relative name in order to rewrite the file content.
27363 \begin_layout Section
27364 Security discussion
27365 \begin_inset CommandInset label
27367 name "sec:Security-discussion"
27374 \begin_layout Standard
27375 The external material feature interfaces with a lot of external programs
27376 and does so automatically, so we have to consider the security implications
27378 In particular, since you have the option of including your own filenames
27379 and/or parameter strings and those are expanded into a command, it seems
27380 that it would be possible to create a malicious document which executes
27381 arbitrary commands when a user views or prints the document.
27382 This is something we definitely want to avoid.
27385 \begin_layout Standard
27386 However, since the external program commands are specified in the template
27387 configuration file only, there are no security issues if \SpecialChar LyX
27388 is properly configure
27389 d with safe templates only.
27390 This is so because the external programs are invoked with the
27391 \begin_inset Flex Code
27394 \begin_layout Plain Layout
27400 -system call rather than the
27401 \begin_inset Flex Code
27404 \begin_layout Plain Layout
27410 system-call, so it's not possible to execute arbitrary commands from the
27411 filename or parameter section via the shell.
27414 \begin_layout Standard
27415 This also implies that you are restricted in what command strings you can
27416 use in the external material templates.
27417 In particular, pipes and redirection are not readily available.
27418 This has to be so if \SpecialChar LyX
27419 should remain safe.
27420 If you want to use some of the shell features, you should write a safe
27421 script to do this in a controlled manner, and then invoke the script from
27422 the command string.
27426 \begin_layout Standard
27427 It is possible to design a template that interacts directly with the shell,
27428 but since this would allow a malicious user to execute arbitrary commands
27429 by writing clever filenames and/or parameters, we generally recommend that
27430 you only use safe scripts that work with the
27431 \begin_inset Flex Code
27434 \begin_layout Plain Layout
27440 system call in a controlled manner.
27441 Of course, for use in a controlled environment, it can be tempting to just
27442 fall back to use ordinary shell scripts.
27443 If you do so, be aware that you
27447 provide an easily exploitable security hole in your system.
27448 Of course it stands to reason that such unsafe templates will never be
27449 included in the standard \SpecialChar LyX
27450 distribution, although we do encourage people
27451 to submit new templates in the open source tradition.
27452 But \SpecialChar LyX
27453 as shipped from the official distribution channels will never have
27457 \begin_layout Standard
27458 Including external material provides a lot of power, and you have to be
27459 careful not to introduce security hazards with this power.
27460 A subtle error in a single line in an innocent looking script can open
27461 the door to huge security problems.
27462 So if you do not fully understand the issues, we recommend that you consult
27463 a knowledgeable security professional or the \SpecialChar LyX
27464 development team if you have
27465 any questions about whether a given template is safe or not.
27466 And do this before you use it in an uncontrolled environment.
27469 \begin_layout Chapter
27471 List of supported \SpecialChar LyX
27472 functions to be used in layouts
27473 \begin_inset CommandInset label
27475 name "chap:List-of-functions"
27482 \begin_layout Standard
27484 \begin_inset Tabular
27485 <lyxtabular version="3" rows="11" columns="8">
27486 <features tabularvalignment="middle">
27487 <column alignment="left" valignment="top">
27488 <column alignment="left" valignment="top">
27489 <column alignment="left" valignment="top">
27490 <column alignment="left" valignment="top">
27491 <column alignment="left" valignment="top">
27492 <column alignment="left" valignment="top">
27493 <column alignment="left" valignment="top">
27494 <column alignment="left" valignment="top">
27496 <cell alignment="left" valignment="top" usebox="none">
27499 \begin_layout Plain Layout
27505 <cell alignment="left" valignment="top" usebox="none">
27508 \begin_layout Plain Layout
27514 <cell alignment="left" valignment="top" usebox="none">
27517 \begin_layout Plain Layout
27523 <cell alignment="left" valignment="top" usebox="none">
27526 \begin_layout Plain Layout
27532 <cell alignment="center" valignment="top" usebox="none">
27535 \begin_layout Plain Layout
27541 <cell alignment="center" valignment="top" usebox="none">
27544 \begin_layout Plain Layout
27550 <cell alignment="center" valignment="top" usebox="none">
27553 \begin_layout Plain Layout
27559 <cell alignment="center" valignment="top" usebox="none">
27562 \begin_layout Plain Layout
27570 <cell alignment="left" valignment="top" usebox="none">
27573 \begin_layout Plain Layout
27579 <cell alignment="left" valignment="top" usebox="none">
27582 \begin_layout Plain Layout
27588 <cell alignment="left" valignment="top" usebox="none">
27591 \begin_layout Plain Layout
27597 <cell alignment="left" valignment="top" usebox="none">
27600 \begin_layout Plain Layout
27606 <cell alignment="center" valignment="top" usebox="none">
27609 \begin_layout Plain Layout
27615 <cell alignment="center" valignment="top" usebox="none">
27618 \begin_layout Plain Layout
27624 <cell alignment="center" valignment="top" usebox="none">
27627 \begin_layout Plain Layout
27633 <cell alignment="center" valignment="top" usebox="none">
27636 \begin_layout Plain Layout
27644 <cell alignment="left" valignment="top" usebox="none">
27647 \begin_layout Plain Layout
27653 <cell alignment="left" valignment="top" usebox="none">
27656 \begin_layout Plain Layout
27662 <cell alignment="left" valignment="top" usebox="none">
27665 \begin_layout Plain Layout
27671 <cell alignment="left" valignment="top" usebox="none">
27674 \begin_layout Plain Layout
27680 <cell alignment="center" valignment="top" usebox="none">
27683 \begin_layout Plain Layout
27689 <cell alignment="center" valignment="top" usebox="none">
27692 \begin_layout Plain Layout
27698 <cell alignment="center" valignment="top" usebox="none">
27701 \begin_layout Plain Layout
27707 <cell alignment="center" valignment="top" usebox="none">
27710 \begin_layout Plain Layout
27718 <cell alignment="left" valignment="top" usebox="none">
27721 \begin_layout Plain Layout
27727 <cell alignment="left" valignment="top" usebox="none">
27730 \begin_layout Plain Layout
27736 <cell alignment="left" valignment="top" usebox="none">
27739 \begin_layout Plain Layout
27745 <cell alignment="left" valignment="top" usebox="none">
27748 \begin_layout Plain Layout
27754 <cell alignment="center" valignment="top" usebox="none">
27757 \begin_layout Plain Layout
27763 <cell alignment="center" valignment="top" usebox="none">
27766 \begin_layout Plain Layout
27772 <cell alignment="center" valignment="top" usebox="none">
27775 \begin_layout Plain Layout
27781 <cell alignment="center" valignment="top" usebox="none">
27784 \begin_layout Plain Layout
27792 <cell alignment="left" valignment="top" usebox="none">
27795 \begin_layout Plain Layout
27801 <cell alignment="left" valignment="top" usebox="none">
27804 \begin_layout Plain Layout
27810 <cell alignment="left" valignment="top" usebox="none">
27813 \begin_layout Plain Layout
27819 <cell alignment="left" valignment="top" usebox="none">
27822 \begin_layout Plain Layout
27828 <cell alignment="center" valignment="top" usebox="none">
27831 \begin_layout Plain Layout
27837 <cell alignment="center" valignment="top" usebox="none">
27840 \begin_layout Plain Layout
27846 <cell alignment="center" valignment="top" usebox="none">
27849 \begin_layout Plain Layout
27855 <cell alignment="center" valignment="top" usebox="none">
27858 \begin_layout Plain Layout
27866 <cell alignment="left" valignment="top" usebox="none">
27869 \begin_layout Plain Layout
27875 <cell alignment="left" valignment="top" usebox="none">
27878 \begin_layout Plain Layout
27884 <cell alignment="left" valignment="top" usebox="none">
27887 \begin_layout Plain Layout
27893 <cell alignment="left" valignment="top" usebox="none">
27896 \begin_layout Plain Layout
27902 <cell alignment="center" valignment="top" usebox="none">
27905 \begin_layout Plain Layout
27911 <cell alignment="center" valignment="top" usebox="none">
27914 \begin_layout Plain Layout
27920 <cell alignment="center" valignment="top" usebox="none">
27923 \begin_layout Plain Layout
27929 <cell alignment="center" valignment="top" usebox="none">
27932 \begin_layout Plain Layout
27940 <cell alignment="left" valignment="top" usebox="none">
27943 \begin_layout Plain Layout
27949 <cell alignment="left" valignment="top" usebox="none">
27952 \begin_layout Plain Layout
27958 <cell alignment="left" valignment="top" usebox="none">
27961 \begin_layout Plain Layout
27967 <cell alignment="left" valignment="top" usebox="none">
27970 \begin_layout Plain Layout
27976 <cell alignment="center" valignment="top" usebox="none">
27979 \begin_layout Plain Layout
27985 <cell alignment="center" valignment="top" usebox="none">
27988 \begin_layout Plain Layout
27994 <cell alignment="center" valignment="top" usebox="none">
27997 \begin_layout Plain Layout
28003 <cell alignment="center" valignment="top" usebox="none">
28006 \begin_layout Plain Layout
28014 <cell alignment="left" valignment="top" usebox="none">
28017 \begin_layout Plain Layout
28023 <cell alignment="left" valignment="top" usebox="none">
28026 \begin_layout Plain Layout
28032 <cell alignment="left" valignment="top" usebox="none">
28035 \begin_layout Plain Layout
28041 <cell alignment="left" valignment="top" usebox="none">
28044 \begin_layout Plain Layout
28050 <cell alignment="center" valignment="top" usebox="none">
28053 \begin_layout Plain Layout
28059 <cell alignment="center" valignment="top" usebox="none">
28062 \begin_layout Plain Layout
28068 <cell alignment="center" valignment="top" usebox="none">
28071 \begin_layout Plain Layout
28077 <cell alignment="center" valignment="top" usebox="none">
28080 \begin_layout Plain Layout
28088 <cell alignment="left" valignment="top" usebox="none">
28091 \begin_layout Plain Layout
28097 <cell alignment="left" valignment="top" usebox="none">
28100 \begin_layout Plain Layout
28106 <cell alignment="left" valignment="top" usebox="none">
28109 \begin_layout Plain Layout
28115 <cell alignment="left" valignment="top" usebox="none">
28118 \begin_layout Plain Layout
28124 <cell alignment="center" valignment="top" usebox="none">
28127 \begin_layout Plain Layout
28133 <cell alignment="center" valignment="top" usebox="none">
28136 \begin_layout Plain Layout
28142 <cell alignment="center" valignment="top" usebox="none">
28145 \begin_layout Plain Layout
28151 <cell alignment="center" valignment="top" usebox="none">
28154 \begin_layout Plain Layout
28162 <cell alignment="left" valignment="top" usebox="none">
28165 \begin_layout Plain Layout
28171 <cell alignment="left" valignment="top" usebox="none">
28174 \begin_layout Plain Layout
28180 <cell alignment="left" valignment="top" usebox="none">
28183 \begin_layout Plain Layout
28189 <cell alignment="left" valignment="top" usebox="none">
28192 \begin_layout Plain Layout
28198 <cell alignment="center" valignment="top" usebox="none">
28201 \begin_layout Plain Layout
28207 <cell alignment="center" valignment="top" usebox="none">
28210 \begin_layout Plain Layout
28216 <cell alignment="center" valignment="top" usebox="none">
28219 \begin_layout Plain Layout
28225 <cell alignment="center" valignment="top" usebox="none">
28228 \begin_layout Plain Layout
28236 <cell alignment="center" valignment="top" usebox="none">
28239 \begin_layout Plain Layout
28245 <cell alignment="center" valignment="top" usebox="none">
28248 \begin_layout Plain Layout
28254 <cell alignment="center" valignment="top" usebox="none">
28257 \begin_layout Plain Layout
28263 <cell alignment="center" valignment="top" usebox="none">
28266 \begin_layout Plain Layout
28272 <cell alignment="center" valignment="top" usebox="none">
28275 \begin_layout Plain Layout
28281 <cell alignment="center" valignment="top" usebox="none">
28284 \begin_layout Plain Layout
28290 <cell alignment="center" valignment="top" usebox="none">
28293 \begin_layout Plain Layout
28299 <cell alignment="center" valignment="top" usebox="none">
28302 \begin_layout Plain Layout
28316 \begin_layout Chapter
28317 Names of available colors to be used in layouts
28318 \begin_inset CommandInset label
28320 name "chap:Names-of-colors"
28327 \begin_layout Standard
28328 The colors listed here are the standard colors and the those that you can
28329 adjust in the \SpecialChar LyX
28333 \begin_layout Description
28346 No particular color – clear or default
28349 \begin_layout Description
28353 \begin_layout Description
28357 \begin_layout Description
28361 \begin_layout Description
28365 \begin_layout Description
28369 \begin_layout Description
28373 \begin_layout Description
28377 \begin_layout Description
28381 \begin_layout Description
28382 added_space Added space marker color
28385 \begin_layout Description
28386 addedtext Added text color
28389 \begin_layout Description
28390 appendix Appendix marker color
28393 \begin_layout Description
28394 background Background color
28397 \begin_layout Description
28398 bottomarea Bottom area color
28401 \begin_layout Description
28402 branchlabel Label color for branches
28405 \begin_layout Description
28406 buttonbg Color used for button background
28409 \begin_layout Description
28410 buttonhoverbg Color used for button background under focus
28413 \begin_layout Description
28414 buttonframe Color for inset button frames
28417 \begin_layout Description
28418 changebar Changebar color
28421 \begin_layout Description
28422 changedtextauthor1 Changed text color author 1
28425 \begin_layout Description
28426 changedtextauthor2 Changed text color author 2
28429 \begin_layout Description
28430 changedtextauthor3 Changed text color author 3
28433 \begin_layout Description
28434 changedtextauthor4 Changed text color author 4
28437 \begin_layout Description
28438 changedtextauthor5 Changed text color author 5
28441 \begin_layout Description
28442 collapsable_inset_frame Collapsable insets framecolor
28445 \begin_layout Description
28446 collapsable_inset_text Collapsable insets text color
28449 \begin_layout Description
28450 command Text color for command insets
28453 \begin_layout Description
28454 commandbg Background color for command insets
28457 \begin_layout Description
28458 commandframe Frame color for command insets
28461 \begin_layout Description
28462 comment color for comments
28465 \begin_layout Description
28466 commentbg Background color of comments
28469 \begin_layout Description
28470 cursor Cursor color
28473 \begin_layout Description
28474 deletedtext Deleted text color
28477 \begin_layout Description
28478 deletedtextmodifier Deleted text modifying color
28481 \begin_layout Description
28482 depthbar Color for the depth bars in the margin
28485 \begin_layout Description
28486 eolmarker End of line marker color
28489 \begin_layout Description
28490 error Color of the \SpecialChar LaTeX
28494 \begin_layout Description
28495 footlabel Label color for footnotes
28498 \begin_layout Description
28499 graphicsbg Graphics inset background color
28502 \begin_layout Description
28503 greyedout Label color for greyedout insets
28506 \begin_layout Description
28507 greyedoutbg Background color of greyedout inset
28510 \begin_layout Description
28511 greyedouttext Color for greyedout inset text
28514 \begin_layout Description
28515 indexlabel Label color for index insets
28518 \begin_layout Description
28519 ignore The color is ignored
28522 \begin_layout Description
28523 inherit The color is inherited
28526 \begin_layout Description
28527 inlinecompletion Inline completion color
28530 \begin_layout Description
28531 insetbg Inset marker background color
28534 \begin_layout Description
28535 insetframe Inset marker frame color
28538 \begin_layout Description
28539 language Color for marking foreign language words
28542 \begin_layout Description
28543 latex Text color in \SpecialChar LaTeX
28547 \begin_layout Description
28548 listingsbg Background color of listings inset
28551 \begin_layout Description
28552 marginlabel Label color for margin notes
28555 \begin_layout Description
28556 math Math inset text color
28559 \begin_layout Description
28560 mathbg Math inset background color
28563 \begin_layout Description
28564 mathcorners Math inset frame color not under focus
28567 \begin_layout Description
28568 mathframe Math inset frame color under focus
28571 \begin_layout Description
28572 mathline Math line color
28575 \begin_layout Description
28576 mathmacrobg Macro math inset background color
28579 \begin_layout Description
28580 mathmacroblend Macro math blended color
28583 \begin_layout Description
28584 mathmacroframe Macro math frame color
28587 \begin_layout Description
28588 mathmacrohoverbg Macro math inset background color hovered
28591 \begin_layout Description
28592 mathmacrolabel Macro math label color
28595 \begin_layout Description
28596 mathmacronewarg Macro template color for new parameters
28599 \begin_layout Description
28600 mathmacrooldarg Macro template color for old parameters
28603 \begin_layout Description
28604 newpage New page color
28607 \begin_layout Description
28608 nonunique_inlinecompletion Inline completion color for the non-unique part
28611 \begin_layout Description
28612 notebg Background color of notes
28615 \begin_layout Description
28616 notelabel Label color for notes
28619 \begin_layout Description
28620 pagebreak Page break/line break color
28623 \begin_layout Description
28624 paragraphmarker Color used for the pilcrow sign to mark the end of a paragraph
28627 \begin_layout Description
28628 phantomtext Text color for phantom insets
28631 \begin_layout Description
28632 preview The color used for previews
28635 \begin_layout Description
28636 previewframe Preview frame color
28639 \begin_layout Description
28640 regexpframe Color for regexp frame
28643 \begin_layout Description
28644 selection Background color of selected text
28647 \begin_layout Description
28648 selectiontext Foreground color of selected text
28651 \begin_layout Description
28652 shadedbg Background color of shaded box
28655 \begin_layout Description
28656 special Special chars text color
28659 \begin_layout Description
28660 tabularline Table line color
28663 \begin_layout Description
28664 tabularonoffline Table line color
28667 \begin_layout Description
28668 urllabel Label color for URL insets
28671 \begin_layout Description
28672 urltext Color for URL inset text