1 #LyX 2.4 created this file. For more info see https://www.lyx.org/
5 \save_transient_properties true
6 \origin /systemlyxdir/doc/
9 % DO NOT ALTER THIS PREAMBLE!!!
11 % This preamble is designed to ensure that this document prints
12 % out as advertised. If you mess with this preamble,
13 % parts of this document may not print out as expected. If you
14 % have problems LaTeXing this file, please contact
15 % the documentation team
16 % email: lyx-docs@lists.lyx.org
18 % the pages of the TOC is numbered roman
19 % and a pdf-bookmark for the TOC is added
20 \let\myTOC\tableofcontents
21 \renewcommand\tableofcontents{%
23 \pdfbookmark[1]{\contentsname}{}
27 % increase link area for cross-references and autoname them,
28 \AtBeginDocument{\renewcommand{\ref}[1]{\mbox{\autoref{#1}}}}
29 \@ifundefined{extrasenglish}{\usepackage[english]{babel}}{}
30 \@ifpackageloaded{babel}{
31 \addto\extrasenglish{%
32 \renewcommand*{\equationautorefname}[1]{}%
33 \renewcommand{\sectionautorefname}{sec.\negthinspace}%
34 \renewcommand{\subsectionautorefname}{sec.\negthinspace}%
35 \renewcommand{\subsubsectionautorefname}{sec.\negthinspace}%
39 \options bibliography=totoc,index=totoc,BCOR7.5mm,titlepage,captions=tableheading
40 \use_default_options false
44 \maintain_unincluded_children false
46 \language_package default
49 \font_roman "lmodern" "default"
50 \font_sans "lmss" "default"
51 \font_typewriter "lmtt" "default"
52 \font_math "auto" "auto"
53 \font_default_family default
54 \use_non_tex_fonts false
58 \font_typewriter_osf false
59 \font_sf_scale 100 100
60 \font_tt_scale 100 100
62 \use_dash_ligatures true
64 \default_output_format pdf2
66 \bibtex_command default
67 \index_command default
71 \pdf_title "LyX Configuration Manual"
72 \pdf_author "LyX Team"
73 \pdf_subject "LyX-documentation Customization"
74 \pdf_keywords "LyX, documentation, customization"
76 \pdf_bookmarksnumbered true
77 \pdf_bookmarksopen true
78 \pdf_bookmarksopenlevel 1
83 \pdf_pdfusetitle false
84 \pdf_quoted_options "linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue,pdfpagelayout=OneColumn, pdfnewwindow=true, pdfstartview=XYZ, plainpages=false"
87 \use_package amsmath 1
88 \use_package amssymb 1
91 \use_package mathdots 1
92 \use_package mathtools 1
94 \use_package stackrel 1
95 \use_package stmaryrd 1
96 \use_package undertilde 1
98 \cite_engine_type default
102 \paperorientation portrait
108 \notefontcolor #0000ff
120 \paragraph_separation indent
121 \paragraph_indentation default
123 \math_indentation default
124 \math_numbering_side default
125 \quotes_style english
129 \paperpagestyle headings
131 \tracking_changes true
132 \output_changes false
136 \author -712698321 "Jürgen Spitzmüller"
137 \author -495245474 "Jean-Marc Lasgouttes"
138 \author 731793113 "Richard Kimberly Heck" rikiheck@lyx.org
144 Customizing \SpecialChar LyX
145 : Features for the Advanced User
149 by the \SpecialChar LyX
154 \begin_layout Plain Layout
156 If you have comments or error corrections, please send them to the \SpecialChar LyX
159 \begin_inset CommandInset href
161 target "lyx-docs@lists.lyx.org"
169 \begin_inset Quotes eld
173 \begin_inset Quotes erd
176 in the subject header, and please cc the current maintainer of this file,
177 Richard Heck <rgheck@comcast.net>.
183 \begin_inset Newline newline
187 \begin_inset Newline newline
193 \begin_layout Standard
194 \begin_inset CommandInset toc
195 LatexCommand tableofcontents
202 \begin_layout Standard
203 \begin_inset Note Note
206 \begin_layout Plain Layout
207 Please use change tracking when modifying this document.
208 This makes it easier for our translators to recognize things that have
209 been changed, and it helps the maintainer keep up-to-date with what's been
218 \begin_layout Chapter
222 \begin_layout Standard
223 This manual covers the customization features present in \SpecialChar LyX
225 In it, we discuss issues like keyboard shortcuts, screen previewing options,
226 printer options, sending commands to \SpecialChar LyX
227 via the \SpecialChar LyX
228 Server, internationalization,
229 installing new \SpecialChar LaTeX
230 classes and \SpecialChar LyX
232 We can't possibly hope to touch on everything you can change—our developers
233 add new features faster than we can document them—but we will explain the
234 most common customizations and hopefully point you in the right direction
235 for some of the more obscure ones.
238 \begin_layout Standard
239 \begin_inset Branch OutDated
243 \begin_layout Standard
244 Information from previous versions of this document that now seems to be
245 outdated is contained in the OutDated branch of this document.
246 By default, this information will not appear in the \SpecialChar LaTeX
255 \begin_layout Chapter
260 \begin_layout Standard
261 This chapter aims to help you to find your way through the \SpecialChar LyX
264 Before continuing to read this chapter, you should find out where your
266 library and user directories are by using
267 \begin_inset Flex Noun
270 \begin_layout Plain Layout
271 Help\SpecialChar menuseparator
282 The library directory is the place where \SpecialChar LyX
283 places its system-wide configuration
284 files; the user directory is where you can place your modified versions.
285 We will call the former
286 \begin_inset Flex Code
289 \begin_layout Plain Layout
296 \begin_inset Flex Noun
299 \begin_layout Plain Layout
305 in the remainder of this document.
309 \begin_layout Section
311 \begin_inset Flex Code
314 \begin_layout Plain Layout
323 \begin_layout Standard
324 \begin_inset Flex Code
327 \begin_layout Plain Layout
333 and its sub-directories contain a number of files and that can be used
334 to customize \SpecialChar LyX
336 You can change many of these files from within \SpecialChar LyX
338 \begin_inset Flex Noun
341 \begin_layout Plain Layout
342 Tools\SpecialChar menuseparator
349 Most customization that you will want to do in \SpecialChar LyX
350 is possible through this
352 However, many other inner aspects of \SpecialChar LyX
353 can be customized by modifying the
355 \begin_inset Flex Code
358 \begin_layout Plain Layout
365 These files fall in different categories, described in the following subsection
369 \begin_layout Subsection
370 Automatically generated files
373 \begin_layout Standard
374 The files, which are to be found in
375 \begin_inset Flex Noun
378 \begin_layout Plain Layout
384 , are generated when you configure \SpecialChar LyX
386 They contain various default values that are guessed by inspection.
387 In general, it is not a good idea to modify them, since they might be overwritt
391 \begin_layout Labeling
392 \labelwidthstring 00.00.0000
393 \begin_inset Flex Code
396 \begin_layout Plain Layout
402 contains defaults for various commands.
405 \begin_layout Labeling
406 \labelwidthstring 00.00.0000
407 \begin_inset Flex Code
410 \begin_layout Plain Layout
416 contains the list of packages that have been recognized by \SpecialChar LyX
418 It is currently unused by the \SpecialChar LyX
419 program itself, but the information extracted,
420 and more, is made available with
421 \begin_inset Flex Noun
424 \begin_layout Plain Layout
425 Help\SpecialChar menuseparator
439 \begin_layout Labeling
440 \labelwidthstring 00.00.0000
441 \begin_inset Flex Code
444 \begin_layout Plain Layout
450 the list of text classes that have been found in your
451 \begin_inset Flex Code
454 \begin_layout Plain Layout
460 directories, along with the associated \SpecialChar LaTeX
461 document class and their description.
464 \begin_layout Labeling
465 \labelwidthstring 00.00.0000
466 \begin_inset Flex Code
469 \begin_layout Plain Layout
475 the list of layout modules found in your
476 \begin_inset Flex Code
479 \begin_layout Plain Layout
488 \begin_layout Labeling
489 \labelwidthstring 00.00.0000
490 \begin_inset Flex Code
493 \begin_layout Plain Layout
499 lists of various sorts of \SpecialChar LaTeX
500 -related files found on your system
503 \begin_layout Labeling
504 \labelwidthstring 00.00.0000
505 \begin_inset Flex Code
508 \begin_layout Plain Layout
509 doc/\SpecialChar LaTeX
515 is automatically generated during configuration from the file
516 \begin_inset Flex Code
519 \begin_layout Plain Layout
527 It contains information on your \SpecialChar LaTeX
531 \begin_layout Subsection
535 \begin_layout Standard
536 These directories are duplicated between
537 \begin_inset Flex Code
540 \begin_layout Plain Layout
547 \begin_inset Flex Code
550 \begin_layout Plain Layout
557 If a particular files exists in both places, the one in
558 \begin_inset Flex Code
561 \begin_layout Plain Layout
570 \begin_layout Labeling
571 \labelwidthstring 00.00.0000
572 \begin_inset Flex Code
575 \begin_layout Plain Layout
581 this directory contains files with the extension
582 \begin_inset Flex Code
585 \begin_layout Plain Layout
591 that define the keybindings used in \SpecialChar LyX
593 If there exists an internationalized version of the bind file named
594 \begin_inset Flex Code
597 \begin_layout Plain Layout
603 , that will be used first.
606 \begin_layout Labeling
607 \labelwidthstring 00.00.0000
608 \begin_inset Flex Code
611 \begin_layout Plain Layout
617 contains files with the extension
618 \begin_inset Flex Code
621 \begin_layout Plain Layout
627 which define the diverse citation possibilities (natbib, biblatex etc.).
629 \begin_inset CommandInset ref
631 reference "subsec:Cite-Engine-Files"
641 \begin_layout Labeling
642 \labelwidthstring 00.00.0000
643 \begin_inset Flex Code
646 \begin_layout Plain Layout
652 contains graphics files that can be included in documents.
656 \begin_layout Labeling
657 \labelwidthstring 00.00.0000
658 \begin_inset Flex Code
661 \begin_layout Plain Layout
667 contains \SpecialChar LyX
668 documentation files (including the one you are currently reading).
670 \begin_inset Flex Code
673 \begin_layout Plain Layout
680 deserves special attention, as noted above.
681 The internationalized help docs are in subdirectories
682 \begin_inset Flex Code
685 \begin_layout Plain Layout
692 \begin_inset Quotes eld
696 \begin_inset Quotes erd
699 is the ISO language code.
701 \begin_inset CommandInset ref
703 reference "cha:Internationalizing-LyX"
710 \begin_layout Labeling
711 \labelwidthstring 00.00.0000
712 \begin_inset Flex Code
715 \begin_layout Plain Layout
721 contains example files that explain how to use some features.
722 In the file browser, press the
723 \begin_inset Flex Noun
726 \begin_layout Plain Layout
735 \begin_layout Labeling
736 \labelwidthstring 00.00.0000
737 \begin_inset Flex Code
740 \begin_layout Plain Layout
746 contains image files that are used by the
747 \begin_inset Flex Noun
750 \begin_layout Plain Layout
757 In addition, it also contains the individual icons used in the toolbar
758 and the banners that can be shown when \SpecialChar LyX
762 \begin_layout Labeling
763 \labelwidthstring 00.00.0000
764 \begin_inset Flex Code
767 \begin_layout Plain Layout
773 contains keyboard keymapping files.
775 \begin_inset CommandInset ref
777 reference "sec:International-Keymap-Stuff"
784 \begin_layout Labeling
785 \labelwidthstring 00.00.0000
786 \begin_inset Flex Code
789 \begin_layout Plain Layout
795 contains the text class and module files described in
796 \begin_inset CommandInset ref
798 reference "cha:Installing-New-Document"
805 \begin_layout Labeling
806 \labelwidthstring 00.00.0000
807 \begin_inset Flex Code
810 \begin_layout Plain Layout
817 \begin_inset Flex Code
820 \begin_layout Plain Layout
826 Python scripts used to convert between \SpecialChar LyX
828 These can be run from the command line if, say, you want to batch-convert
832 \begin_layout Labeling
833 \labelwidthstring 00.00.0000
834 \begin_inset Flex Code
837 \begin_layout Plain Layout
843 contains some files that demonstrate the capabilities of the
844 \begin_inset Flex Noun
847 \begin_layout Plain Layout
858 Also contains some scripts used by \SpecialChar LyX
862 \begin_layout Labeling
863 \labelwidthstring 00.00.0000
864 \begin_inset Flex Code
867 \begin_layout Plain Layout
873 contains the standard \SpecialChar LyX
874 template files described in
875 \begin_inset CommandInset ref
877 reference "subsec:Creating-Templates"
884 \begin_layout Labeling
885 \labelwidthstring 00.00.0000
886 \begin_inset Flex Code
889 \begin_layout Plain Layout
895 contains files with the extension
896 \begin_inset Flex Code
899 \begin_layout Plain Layout
905 that define the user interface to \SpecialChar LyX
907 That is, the files define which items appear in which menus and the items
908 appearing on the toolbar.
911 \begin_layout Labeling
912 \labelwidthstring 00.00.0000
913 \begin_inset Flex Code
916 \begin_layout Plain Layout
922 contains files with the extension
923 \begin_inset Flex Code
926 \begin_layout Plain Layout
932 which define the templates for the insertion of external material to a
935 \begin_inset CommandInset ref
937 reference "chap:Including-External-Material"
944 \begin_layout Subsection
945 Files you don't want to modify
948 \begin_layout Standard
949 These files are used internally by \SpecialChar LyX
950 and you generally do not need to modify
951 them unless you are a developer.
954 \begin_layout Labeling
955 \labelwidthstring 00.00.0000
956 \begin_inset Flex Code
959 \begin_layout Plain Layout
965 this file contains the list of \SpecialChar LyX
967 The contents are displayed with the menu entry
968 \begin_inset Flex Noun
971 \begin_layout Plain Layout
972 Help\SpecialChar menuseparator
985 \begin_layout Labeling
986 \labelwidthstring 00.00.0000
987 \begin_inset Flex Code
990 \begin_layout Plain Layout
996 this is a \SpecialChar LaTeX
997 script used during the configuration process.
1001 \begin_layout Labeling
1002 \labelwidthstring 00.00.0000
1003 \begin_inset Flex Code
1006 \begin_layout Plain Layout
1012 this is a Python script that is used to re-configure \SpecialChar LyX
1014 It creates configuration files in the directory it was run from.
1017 \begin_layout Subsection
1018 Other files needing a line or two
1021 \begin_layout Labeling
1022 \labelwidthstring 00.00.0000
1023 \begin_inset Flex Code
1026 \begin_layout Plain Layout
1032 this contains tables describing how different character encodings can be
1036 \begin_layout Labeling
1037 \labelwidthstring 00.00.0000
1038 \begin_inset Flex Code
1041 \begin_layout Plain Layout
1047 this file contains a list of all the languages currently supported by \SpecialChar LyX
1051 \begin_layout Labeling
1052 \labelwidthstring 00.00.0000
1053 \begin_inset Flex Code
1056 \begin_layout Plain Layout
1062 contains information about the supported fonts.
1065 \begin_layout Labeling
1066 \labelwidthstring 00.00.0000
1067 \begin_inset Flex Code
1070 \begin_layout Plain Layout
1076 this file contains translations for internationalized paragraph styles
1078 \begin_inset CommandInset ref
1080 reference "subsec:I18n"
1087 \begin_layout Labeling
1088 \labelwidthstring 00.00.0000
1089 \begin_inset Flex Code
1092 \begin_layout Plain Layout
1098 this file contains information about Unicode-encoded glyphs and the way
1099 they are supported by \SpecialChar LyX
1100 via \SpecialChar LaTeX
1104 \begin_layout Section
1105 Your local configuration directory
1108 \begin_layout Standard
1109 Even if you are using \SpecialChar LyX
1110 as an unprivileged user, you might want to change
1112 configuration for your own use.
1114 \begin_inset Flex Code
1117 \begin_layout Plain Layout
1123 directory contains all your personal configuration files.
1124 This is the directory described as
1125 \begin_inset Quotes eld
1129 \begin_inset Quotes erd
1133 \begin_inset Flex Noun
1136 \begin_layout Plain Layout
1137 Help\SpecialChar menuseparator
1139 \begin_inset space ~
1148 This directory is used as a mirror of
1149 \begin_inset Flex Code
1152 \begin_layout Plain Layout
1158 , which means that every file in
1159 \begin_inset Flex Code
1162 \begin_layout Plain Layout
1168 is a replacement for the corresponding file in
1169 \begin_inset Flex Code
1172 \begin_layout Plain Layout
1179 Any configuration file described in the above sections can be placed either
1180 in the system-wide directory, in which case it will affect all users, or
1181 in your local directory for your own use.
1184 \begin_layout Standard
1185 To make things clearer, let's provide a few examples:
1188 \begin_layout Itemize
1189 The preferences set in the
1190 \begin_inset Flex Noun
1193 \begin_layout Plain Layout
1194 Tools\SpecialChar menuseparator
1200 dialog are saved to a file
1201 \begin_inset Flex Code
1204 \begin_layout Plain Layout
1211 \begin_inset Flex Code
1214 \begin_layout Plain Layout
1223 \begin_layout Itemize
1224 When you reconfigure using
1225 \begin_inset Flex Noun
1228 \begin_layout Plain Layout
1229 Tools\SpecialChar menuseparator
1237 \begin_inset Flex Code
1240 \begin_layout Plain Layout
1246 script, and the resulting files are written in your local configuration
1248 This means that any additional text class file that you might have added
1250 \begin_inset Flex Code
1253 \begin_layout Plain Layout
1259 will be added to the list of classes in the
1260 \begin_inset Flex Noun
1263 \begin_layout Plain Layout
1264 Document\SpecialChar menuseparator
1273 \begin_layout Itemize
1274 If you get some updated documentation from \SpecialChar LyX
1275 ftp site and cannot install
1276 it because you do not have sysadmin rights on your system, you can just
1278 \begin_inset Flex Code
1281 \begin_layout Plain Layout
1287 and the items in the
1288 \begin_inset Flex Noun
1291 \begin_layout Plain Layout
1297 menu will open them!
1300 \begin_layout Section
1301 Running \SpecialChar LyX
1302 with multiple configurations
1305 \begin_layout Standard
1306 The configuration freedom of the local configuration directory may not suffice
1307 if you want to have more than one configuration at your disposal.
1308 For example, you may want to be use different key bindings or printer settings
1310 You can achieve this by having several such directories.
1311 You then specify which directory to use at run-time.
1314 \begin_layout Standard
1315 Invoking \SpecialChar LyX
1316 with the command line switch
1317 \begin_inset Flex Code
1320 \begin_layout Plain Layout
1330 instructs the program to read the configuration from that directory, and
1331 not from the default directory.
1332 (You can determine the default directory by running \SpecialChar LyX
1334 \begin_inset Flex Code
1337 \begin_layout Plain Layout
1343 switch.) If the specified directory does not exist, \SpecialChar LyX
1345 for you, just like it does for the default directory on the first time
1346 you run the program.
1347 You can modify the configuration options in this additional user directory
1348 exactly as you would for the default directory.
1349 These directories are completely independent (but read on).
1350 Note that setting the environment variable
1351 \begin_inset Flex Code
1354 \begin_layout Plain Layout
1360 to some value has exactly the same effect.
1363 \begin_layout Standard
1364 Having several configurations also requires more maintenance: if you want
1365 to add a new layout to
1366 \begin_inset Flex Code
1369 \begin_layout Plain Layout
1375 which you want available from all your configurations, you must add it
1376 to each directory separately.
1377 You can avoid this with the following trick: after \SpecialChar LyX
1378 creates the additional
1379 directory, most of the subdirectories (see above) are empty.
1380 If you want the new configuration to mirror an existing one, replace the
1381 empty subdirectory with a symbolic link to the matching subdirectory in
1382 the existing configuration.
1384 \begin_inset Flex Code
1387 \begin_layout Plain Layout
1393 subdirectory, however, since it contains a file written by the configuration
1394 script (also accessible through
1395 \begin_inset Flex Noun
1398 \begin_layout Plain Layout
1399 Tools\SpecialChar menuseparator
1405 ) which is configuration-specific.
1408 \begin_layout Chapter
1409 The Preferences dialog
1412 \begin_layout Standard
1413 All options of the preferences dialog are described in the Appendix
1415 The Preferences Dialog
1422 For some options you might find here more details.
1425 \begin_layout Section
1427 \begin_inset CommandInset label
1436 \begin_layout Standard
1437 The first step is to define your file formats if they are not already defined.
1439 \begin_inset Flex Noun
1442 \begin_layout Plain Layout
1443 Tools\SpecialChar menuseparator
1451 \begin_inset Flex Noun
1454 \begin_layout Plain Layout
1455 File Handling\SpecialChar menuseparator
1462 \begin_inset Flex Noun
1465 \begin_layout Plain Layout
1471 button to define your new format.
1473 \begin_inset Flex Noun
1476 \begin_layout Plain Layout
1482 field contains the name used to identify the format in the GUI.
1484 \begin_inset Flex Noun
1487 \begin_layout Plain Layout
1493 is used to identify the format internally.
1494 You will also need to enter a file extension.
1495 These are all required.
1497 \begin_inset Flex Noun
1500 \begin_layout Plain Layout
1506 field is used to provide a keyboard shortcut on the menus.
1507 (For example, pressing
1508 \begin_inset Flex Noun
1511 \begin_layout Plain Layout
1518 \begin_inset Flex Noun
1521 \begin_layout Plain Layout
1522 Document\SpecialChar menuseparator
1523 View (Other Formats)\SpecialChar menuseparator
1532 \begin_layout Standard
1534 \begin_inset Flex Noun
1537 \begin_layout Plain Layout
1544 \begin_inset Flex Noun
1547 \begin_layout Plain Layout
1554 For example, you might want to use
1555 \begin_inset Flex Noun
1558 \begin_layout Plain Layout
1564 to view PostScript files.
1565 You can enter the command needed to start the program in the corresponding
1567 In defining this command, you can use the four variables listed in the
1569 The viewer is launched when you view an image in \SpecialChar LyX
1571 \begin_inset Flex Noun
1574 \begin_layout Plain Layout
1575 Document\SpecialChar menuseparator
1582 The editor is for example launched when you right-click on an image and
1584 \begin_inset Flex Noun
1587 \begin_layout Plain Layout
1593 in the appearing context menu.
1596 \begin_layout Standard
1598 \begin_inset Flex Noun
1601 \begin_layout Plain Layout
1607 type of a format is optional, but if it is specified, it must be unique
1609 It is used to detect files of this format from the file contents.
1610 For some important file formats there is no MIME type officially registered
1612 \begin_inset CommandInset href
1615 target "http://www.iana.org/assignments/media-types/"
1621 Therefore \SpecialChar LyX
1622 uses the extended list of MIME types as specified by
1623 \begin_inset CommandInset href
1625 name "freedesktop.org"
1626 target "http://www.freedesktop.org/wiki/Specifications/shared-mime-info-spec"
1634 \begin_layout Standard
1636 \begin_inset Flex Noun
1639 \begin_layout Plain Layout
1645 option tells \SpecialChar LyX
1646 that a format is suitable for document export.
1647 If this is set and if a suitable conversion route exists (see
1648 \begin_inset CommandInset ref
1650 reference "sec:Converters"
1654 ), the format will appear in the
1655 \begin_inset Flex Noun
1658 \begin_layout Plain Layout
1659 File\SpecialChar menuseparator
1666 The format will also appear in the
1667 \begin_inset Flex Noun
1670 \begin_layout Plain Layout
1671 Document\SpecialChar menuseparator
1677 menu if a viewer is specified for the format.
1678 Pure image formats, such as
1679 \begin_inset Flex Code
1682 \begin_layout Plain Layout
1688 , should not use this option.
1689 Formats that can both represent vector graphics and documents like
1690 \begin_inset Flex Code
1693 \begin_layout Plain Layout
1702 \begin_layout Standard
1704 \begin_inset Flex Noun
1707 \begin_layout Plain Layout
1708 Vector graphics format
1713 tells \SpecialChar LyX
1714 that a format can contain vector graphics.
1715 This information is used to determine the target format of included graphics
1717 \begin_inset Flex Noun
1720 \begin_layout Plain Layout
1727 Included graphics may need to be converted to either
1728 \begin_inset Flex Noun
1731 \begin_layout Plain Layout
1738 \begin_inset Flex Noun
1741 \begin_layout Plain Layout
1748 \begin_inset Flex Noun
1751 \begin_layout Plain Layout
1758 \begin_inset Flex Noun
1761 \begin_layout Plain Layout
1767 cannot handle other image formats.
1768 If an included graphic is not already in
1769 \begin_inset Flex Noun
1772 \begin_layout Plain Layout
1779 \begin_inset Flex Noun
1782 \begin_layout Plain Layout
1789 \begin_inset Flex Noun
1792 \begin_layout Plain Layout
1798 format, it is converted to
1799 \begin_inset Flex Noun
1802 \begin_layout Plain Layout
1808 if the vector format option is set, and otherwise to
1809 \begin_inset Flex Noun
1812 \begin_layout Plain Layout
1821 \begin_layout Section
1825 \begin_layout Standard
1826 Since all conversions from one format to another take place in \SpecialChar LyX
1828 directory, it is sometimes necessary to modify a file before copying it
1829 to the temporary directory in order that the conversion may be performed.
1833 \begin_layout Plain Layout
1834 For example, the file may refer to other files—images, for example—using
1835 relative file names, and these may become invalid when the file is copied
1836 to the temporary directory.
1841 This is done by a Copier: It copies a file to (or from) the temporary directory
1842 and may modify it in the process.
1845 \begin_layout Standard
1846 The definitions of the copiers may use eight variables:
1849 \begin_layout Labeling
1850 \labelwidthstring 00.00.0000
1851 \begin_inset Flex Code
1854 \begin_layout Plain Layout
1860 The \SpecialChar LyX
1861 system directory (e.
1862 \begin_inset space \thinspace{}
1866 \begin_inset space \space{}
1870 \begin_inset Flex Noun
1873 \begin_layout Plain Layout
1882 \begin_layout Labeling
1883 \labelwidthstring 00.00.0000
1884 \begin_inset Flex Code
1887 \begin_layout Plain Layout
1896 \begin_layout Labeling
1897 \labelwidthstring 00.00.0000
1898 \begin_inset Flex Code
1901 \begin_layout Plain Layout
1910 \begin_layout Labeling
1911 \labelwidthstring 00.00.0000
1912 \begin_inset Flex Code
1915 \begin_layout Plain Layout
1921 The base name (without filename extension) in the \SpecialChar LyX
1925 \begin_layout Labeling
1926 \labelwidthstring 00.00.0000
1927 \begin_inset Flex Code
1930 \begin_layout Plain Layout
1936 The full directory path of the \SpecialChar LyX
1940 \begin_layout Labeling
1941 \labelwidthstring 00.00.0000
1942 \begin_inset Flex Code
1945 \begin_layout Plain Layout
1951 The full pathname to the original \SpecialChar LyX
1952 file being processed
1955 \begin_layout Labeling
1956 \labelwidthstring 00.00.0000
1957 \begin_inset Flex Code
1960 \begin_layout Plain Layout
1966 The filename (without any directory path) of the \SpecialChar LyX
1970 \begin_layout Labeling
1971 \labelwidthstring 00.00.0000
1972 \begin_inset Flex Code
1975 \begin_layout Plain Layout
1981 The `\SpecialChar LaTeX
1985 \begin_layout Standard
1986 The latter should be the filename as it would be used in a \SpecialChar LaTeX
1994 It is relevant only when exporting files suitable for such inclusion.
1997 \begin_layout Standard
1998 Copiers can be used to do almost anything with output files.
1999 For example, suppose you want generated pdf files to be copied to a special
2001 \begin_inset Flex Code
2004 \begin_layout Plain Layout
2011 Then you could write a shell script such as this one:
2014 \begin_layout Standard
2015 \begin_inset listings
2019 \begin_layout Plain Layout
2024 \begin_layout Plain Layout
2029 \begin_layout Plain Layout
2031 TOFILE=`basename $2`
2034 \begin_layout Plain Layout
2036 cp $FROMFILE /home/you/pdf/$TOFILE
2041 Save it in your local \SpecialChar LyX
2043 \begin_inset Flex Code
2046 \begin_layout Plain Layout
2047 /home/you/.lyx/scripts/pdfcopier.sh
2052 —and make it executable, if you need to do so on your platform.
2054 \begin_inset Flex Noun
2057 \begin_layout Plain Layout
2058 Tools\SpecialChar menuseparator
2064 dialog, select under
2065 \begin_inset Flex Noun
2068 \begin_layout Plain Layout
2069 File Handling\SpecialChar menuseparator
2076 \begin_inset Flex Noun
2079 \begin_layout Plain Layout
2085 format—or one of the other pdf formats—and enter
2086 \begin_inset Flex Code
2089 \begin_layout Plain Layout
2090 pdfcopier.sh $$i $$o
2096 \begin_inset Flex Noun
2099 \begin_layout Plain Layout
2109 \begin_layout Standard
2110 Copiers are used by \SpecialChar LyX
2111 in various of its own conversions.
2112 For example, if appropriate programs are found, \SpecialChar LyX
2113 will automatically install
2115 \begin_inset Flex Noun
2118 \begin_layout Plain Layout
2125 \begin_inset Flex Noun
2128 \begin_layout Plain Layout
2130 \begin_inset space ~
2139 When these formats are exported, the copier sees that not just the main
2140 HTML file but various associated files (style files, images, etc.) are also
2142 All these files are written to a subdirectory of the directory in which
2143 the original \SpecialChar LyX
2148 \begin_layout Plain Layout
2149 This copier can be customized.
2151 \begin_inset Quotes eld
2155 \begin_inset Quotes erd
2158 argument takes a comma-separated list of extensions to be copied; if it
2159 is omitted, all files will be copied.
2161 \begin_inset Quotes eld
2165 \begin_inset Quotes erd
2168 argument determines the extension added to the generated directory.
2170 \begin_inset Quotes eld
2174 \begin_inset Flex Noun
2177 \begin_layout Plain Layout
2184 \begin_inset Quotes erd
2187 , so HTML generated from
2188 \begin_inset Flex Noun
2191 \begin_layout Plain Layout
2192 /path/to/filename.lyx
2198 \begin_inset Flex Noun
2201 \begin_layout Plain Layout
2202 /path/to/filename.html.LyXconv
2216 \begin_layout Section
2218 \begin_inset CommandInset label
2220 name "sec:Converters"
2227 \begin_layout Standard
2228 You can define your own Converters to convert files between different formats.
2230 \begin_inset Flex Noun
2233 \begin_layout Plain Layout
2234 Tools\SpecialChar menuseparator
2235 Preferences\SpecialChar menuseparator
2236 File Handling\SpecialChar menuseparator
2245 \begin_layout Standard
2246 To define a new converter, select the
2247 \begin_inset Flex Noun
2250 \begin_layout Plain Layout
2252 \begin_inset space ~
2261 \begin_inset Flex Noun
2264 \begin_layout Plain Layout
2266 \begin_inset space ~
2274 from the drop-down lists, enter the command needed for the conversion,
2276 \begin_inset Flex Noun
2279 \begin_layout Plain Layout
2286 Several variables can be used in the definition of converters:
2289 \begin_layout Labeling
2290 \labelwidthstring 00.00.0000
2291 \begin_inset Flex Code
2294 \begin_layout Plain Layout
2300 The \SpecialChar LyX
2304 \begin_layout Labeling
2305 \labelwidthstring 00.00.0000
2306 \begin_inset Flex Code
2309 \begin_layout Plain Layout
2318 \begin_layout Labeling
2319 \labelwidthstring 00.00.0000
2320 \begin_inset Flex Code
2323 \begin_layout Plain Layout
2332 \begin_layout Labeling
2333 \labelwidthstring 00.00.0000
2334 \begin_inset Flex Code
2337 \begin_layout Plain Layout
2343 The base filename of the input file (i.
2344 \begin_inset space \thinspace{}
2347 g., without the extension)
2350 \begin_layout Labeling
2351 \labelwidthstring 00.00.0000
2352 \begin_inset Flex Code
2355 \begin_layout Plain Layout
2361 The path to the input file
2364 \begin_layout Labeling
2365 \labelwidthstring 00.00.0000
2366 \begin_inset Flex Code
2369 \begin_layout Plain Layout
2375 The path to the original input file (this is different from $$p when a
2376 chain of converters is called)
2379 \begin_layout Labeling
2380 \labelwidthstring 00.00.0000
2381 \begin_inset Flex Code
2384 \begin_layout Plain Layout
2390 The iconv name for the encoding of the document.
2393 \begin_layout Standard
2395 \begin_inset Flex Noun
2398 \begin_layout Plain Layout
2400 \begin_inset space ~
2408 field you can enter the following flags, separated by commas:
2411 \begin_layout Labeling
2412 \labelwidthstring 00.00.0000
2413 \begin_inset Flex Code
2416 \begin_layout Plain Layout
2418 \change_inserted -712698321 1524656940
2426 This converter runs some form of \SpecialChar LaTeX
2428 This will make \SpecialChar LyX
2429 's \SpecialChar LaTeX
2430 error logs available.
2432 \change_inserted -712698321 1524657018
2434 \begin_inset Flex Code
2437 \begin_layout Plain Layout
2439 \change_inserted -712698321 1524657012
2447 value specifies the form of \SpecialChar LaTeX
2449 \begin_inset Flex Code
2452 \begin_layout Plain Layout
2454 \change_inserted -712698321 1524657005
2455 latex, pdflatex, platex, xetex, luatex
2463 If no value is specified,
2464 \begin_inset Flex Code
2467 \begin_layout Plain Layout
2469 \change_inserted -712698321 1524657018
2482 \begin_layout Labeling
2483 \labelwidthstring 00.00.0000
2484 \begin_inset Flex Code
2487 \begin_layout Plain Layout
2489 \change_inserted -712698321 1524656935
2497 Needs the \SpecialChar LaTeX
2499 \begin_inset Flex Noun
2502 \begin_layout Plain Layout
2508 file for the conversion.
2510 \change_inserted -712698321 1524657047
2512 \begin_inset Flex Code
2515 \begin_layout Plain Layout
2517 \change_inserted -712698321 1524657030
2523 value specifies the form of \SpecialChar LaTeX
2524 that is run in order to generate the
2525 \begin_inset Flex Noun
2528 \begin_layout Plain Layout
2530 \change_inserted -712698321 1524657047
2537 \begin_inset Flex Code
2540 \begin_layout Plain Layout
2542 \change_inserted -712698321 1524657030
2543 latex, pdflatex, platex, xetex, luatex
2549 If no value is specified,
2550 \begin_inset Flex Code
2553 \begin_layout Plain Layout
2555 \change_inserted -712698321 1524657030
2566 \begin_layout Labeling
2567 \labelwidthstring 00.00.0000
2568 \begin_inset Flex Code
2571 \begin_layout Plain Layout
2578 \begin_inset Quotes eld
2582 \begin_inset Quotes erd
2585 file from the backend, which in practice means a \SpecialChar LaTeX
2586 file like the one we
2587 would export, without
2588 \begin_inset Flex Code
2591 \begin_layout Plain Layout
2600 \begin_layout Labeling
2601 \labelwidthstring 00.00.0000
2602 \begin_inset Flex Code
2605 \begin_layout Plain Layout
2614 \begin_layout Standard
2615 The following three flags are not really flags at all because they take
2617 \begin_inset Flex Noun
2620 \begin_layout Plain Layout
2622 \begin_inset space ~
2626 \begin_inset space ~
2637 \begin_layout Labeling
2638 \labelwidthstring 00.00.0000
2640 \change_inserted -712698321 1523206314
2641 \begin_inset Flex Code
2644 \begin_layout Plain Layout
2646 \change_inserted -712698321 1523206193
2652 The name of the driver that needs to be loaded with the
2656 package for this converter.
2657 The loading of the correct driver is necessary to get some PDF-specific
2666 \begin_layout Labeling
2667 \labelwidthstring 00.00.0000
2668 \begin_inset Flex Code
2671 \begin_layout Plain Layout
2677 If set, the converter's standard error will be redirected to a file
2678 \begin_inset Flex Code
2681 \begin_layout Plain Layout
2687 , and the script given as argument will be run as:
2688 \begin_inset Flex Code
2691 \begin_layout Plain Layout
2692 script < infile.out > infile.log
2698 The argument may contain
2699 \begin_inset Flex Code
2702 \begin_layout Plain Layout
2711 \begin_layout Labeling
2712 \labelwidthstring 00.00.0000
2713 \begin_inset Flex Code
2716 \begin_layout Plain Layout
2722 The name of the directory in which the converter will dump the generated
2725 will not create this directory, and it does not copy anything into it,
2726 though it will copy this directory to the destination.
2727 The argument may contain
2728 \begin_inset Flex Code
2731 \begin_layout Plain Layout
2737 , which will be replaced by the base name of the input and output files,
2738 respectively, when the directory is copied.
2739 \begin_inset Newline newline
2742 Note that resultdir and usetempdir make no sense together.
2743 The latter will be ignored if the former is given.
2746 \begin_layout Labeling
2747 \labelwidthstring 00.00.0000
2748 \begin_inset Flex Code
2751 \begin_layout Plain Layout
2757 Determines the output file name and may, contain
2758 \begin_inset Flex Code
2761 \begin_layout Plain Layout
2768 Sensible only with resultdir and optional even then; if not given, it defaults
2772 \begin_layout Standard
2774 \change_inserted -712698321 1523206384
2775 A suitable hyperref-driver is set for some converters that are installed
2776 with \SpecialChar LyX
2779 \change_deleted -712698321 1523206388
2781 \change_inserted -712698321 1523206389
2785 \change_inserted -712698321 1523206400
2789 \change_inserted -712698321 1523206407
2793 \change_inserted -712698321 1523206437
2797 \change_deleted -712698321 1523206442
2798 that are installed with \SpecialChar LyX
2805 \begin_layout Standard
2806 You do not have to define converters for all formats between which you want
2808 For example, you will note that there is no `\SpecialChar LyX
2809 to PostScript' converter,
2810 but \SpecialChar LyX
2811 will export PostScript.
2812 It does so by first creating a \SpecialChar LaTeX
2813 file (no converter needs to be defined
2814 for this) which is then converted to DVI using the `\SpecialChar LaTeX
2816 and finally converting the resulting DVI file to PostScript.
2818 finds such `chains' of converters automatically, and it will always choose
2819 the shortest possible chain.
2820 You can, though, still define multiple conversion methods between file
2822 For example, the standard \SpecialChar LyX
2823 configuration provides five ways to convert
2828 \begin_layout Enumerate
2830 \begin_inset Flex Noun
2833 \begin_layout Plain Layout
2842 \begin_layout Enumerate
2843 via (DVI and) PostScript, using
2844 \begin_inset Flex Noun
2847 \begin_layout Plain Layout
2856 \begin_layout Enumerate
2858 \begin_inset Flex Noun
2861 \begin_layout Plain Layout
2870 \begin_layout Enumerate
2872 \begin_inset Flex Noun
2875 \begin_layout Plain Layout
2885 \begin_layout Enumerate
2887 \begin_inset Flex Noun
2890 \begin_layout Plain Layout
2900 \begin_layout Standard
2901 To define such alternate chains, you must define multiple target `file formats',
2903 \begin_inset CommandInset ref
2905 reference "sec:Formats"
2910 For example, in the standard configuration, the formats named
2911 \begin_inset Flex Noun
2914 \begin_layout Plain Layout
2921 \begin_inset Flex Noun
2924 \begin_layout Plain Layout
2931 \begin_inset Flex Noun
2934 \begin_layout Plain Layout
2941 \begin_inset Flex Noun
2944 \begin_layout Plain Layout
2951 \begin_inset Flex Noun
2954 \begin_layout Plain Layout
2961 \begin_inset Flex Noun
2964 \begin_layout Plain Layout
2971 \begin_inset Flex Noun
2974 \begin_layout Plain Layout
2981 \begin_inset Flex Noun
2984 \begin_layout Plain Layout
2992 \begin_inset Flex Noun
2995 \begin_layout Plain Layout
3002 \begin_inset Flex Noun
3005 \begin_layout Plain Layout
3012 ) are defined, all of which share the extension
3013 \begin_inset Flex Noun
3016 \begin_layout Plain Layout
3022 , and which correspond to the conversion methods just mentioned.
3025 \begin_layout Chapter
3026 Internationalizing \SpecialChar LyX
3028 \begin_inset CommandInset label
3030 name "cha:Internationalizing-LyX"
3037 \begin_layout Standard
3039 supports using a translated interface.
3040 Last time we checked, \SpecialChar LyX
3041 provided text in thirty languages.
3042 The language of choice is called your
3047 (For further reading on locale settings, see also the documentation for
3048 locale that comes with your operating system.
3049 For Linux, the manual page for
3050 \begin_inset Flex Code
3053 \begin_layout Plain Layout
3059 could be a good place to start).
3062 \begin_layout Standard
3063 Notice that these translations will work, but do contain a few flaws.
3064 In particular, all dialogs have been designed with the English text in
3065 mind, which means that some of the translated text will be too large to
3066 fit within the space allocated.
3067 This is only a display problem and will not cause any harm.
3068 Also, you will find that some of the translations do not define shortcut
3069 keys for everything.
3070 Sometimes, there are simply not enough free letters to do it.
3071 Other times, the translator just hasn't got around to doing it yet.
3072 Our localization team, which you may wish to join,
3076 \begin_layout Plain Layout
3077 If you are a fluent speaker of a language other than English, joining these
3078 teams is a great way to give back to the \SpecialChar LyX
3084 will of course try to fix these shortcomings in future versions of \SpecialChar LyX
3088 \begin_layout Section
3089 Translating \SpecialChar LyX
3093 \begin_layout Subsection
3094 Translating the graphical user interface (text messages).
3097 \begin_layout Standard
3100 \begin_inset Flex Code
3103 \begin_layout Plain Layout
3109 library to handle the internationalization of the interface.
3110 To have \SpecialChar LyX
3111 speak your favorite language in all menus and dialogs, you need
3113 \begin_inset Flex Code
3116 \begin_layout Plain Layout
3122 -file for that language.
3123 When this is available, you'll have to generate a
3124 \begin_inset Flex Code
3127 \begin_layout Plain Layout
3133 -file from it and install the
3134 \begin_inset Flex Code
3137 \begin_layout Plain Layout
3144 The process of doing all of this is explained in the documentation for
3146 \begin_inset Flex Code
3149 \begin_layout Plain Layout
3156 It is possible to do this just for yourself, but if you're going to do
3157 it, you might as well share the results of your labors with the rest of
3158 the \SpecialChar LyX
3160 Send a message to the \SpecialChar LyX
3161 developers' list for more information about how
3165 \begin_layout Standard
3166 In short, this is what you should do (xx denotes the language code):
3169 \begin_layout Itemize
3170 Check out the \SpecialChar LyX
3173 \begin_inset CommandInset href
3175 name "information on the web"
3176 target "https://www.lyx.org/HowToUseGIT"
3184 \begin_layout Itemize
3186 \begin_inset Flex Code
3189 \begin_layout Plain Layout
3195 to the folder of the
3196 \begin_inset Flex Code
3199 \begin_layout Plain Layout
3207 \begin_inset Flex Code
3210 \begin_layout Plain Layout
3218 \begin_inset Flex Code
3221 \begin_layout Plain Layout
3227 doesn't exist anywhere, it can be remade with the console command
3228 \begin_inset Flex Code
3231 \begin_layout Plain Layout
3237 in that directory, or you can use an existing po-file for some other language
3241 \begin_layout Itemize
3243 \begin_inset Flex Code
3246 \begin_layout Plain Layout
3256 \begin_layout Plain Layout
3257 This is just a text file, so it can be edited in any text editor.
3258 But there are also specialized programs that support such editing, such
3263 (for all platforms) or
3272 contains a `mode' for editing
3273 \begin_inset Flex Code
3276 \begin_layout Plain Layout
3283 \begin_inset Flex URL
3286 \begin_layout Plain Layout
3288 https://www.gnu.org/software/gettext/manual/html_node/PO-Mode.html#PO-Mode
3298 For some menu- and widget-labels, there are also shortcut keys that should
3300 Those keys are marked after a `|', and should be translated according to
3301 the words and phrases of the language.
3302 You should also fill also out the information at the beginning of the new
3304 \begin_inset Flex Code
3307 \begin_layout Plain Layout
3313 -file with your email-address, etc., so people know where to reach you with
3314 suggestions and entertaining flames.
3317 \begin_layout Standard
3318 If you are just doing this on your own, then:
3321 \begin_layout Itemize
3323 \begin_inset Flex Code
3326 \begin_layout Plain Layout
3333 This can be done with
3334 \begin_inset Flex Code
3337 \begin_layout Plain Layout
3338 msgfmt -o xx.mo < xx.po
3346 \begin_layout Itemize
3348 \begin_inset Flex Code
3351 \begin_layout Plain Layout
3357 -file to your locale-tree, at the correct directory for application messages
3362 xx, and under the name
3363 \begin_inset Flex Code
3366 \begin_layout Plain Layout
3373 \begin_inset space \thinspace{}
3377 \begin_inset space \space{}
3381 \begin_inset Flex Code
3384 \begin_layout Plain Layout
3385 /usr/local/share/locale/xx/LC_MESSAGES/lyx.mo
3395 \begin_layout Standard
3396 As said, however, it would be best if the new
3397 \begin_inset Flex Code
3400 \begin_layout Plain Layout
3406 file could be added to the \SpecialChar LyX
3407 distribution, so others can use it.
3408 Adding it involves making additional changes to \SpecialChar LyX
3410 So send an email to the developers' mailing list if you're interested in
3414 \begin_layout Subsubsection
3418 \begin_layout Standard
3419 Sometimes it turns out that one English message needs to be translated into
3420 different messages in the target language.
3421 One example is the message
3422 \begin_inset Flex Code
3425 \begin_layout Plain Layout
3431 which has the German translation
3439 , depending upon exactly what the English
3440 \begin_inset Quotes eld
3444 \begin_inset Quotes erd
3449 \begin_inset Flex Code
3452 \begin_layout Plain Layout
3458 does not handle such ambiguous translations.
3459 Therefore you have to add some context information to the message: Instead
3461 \begin_inset Flex Code
3464 \begin_layout Plain Layout
3471 \begin_inset Flex Code
3474 \begin_layout Plain Layout
3475 To[[as in 'From format x to format y']]
3481 \begin_inset Flex Code
3484 \begin_layout Plain Layout
3485 To[[as in 'From page x to page y']].
3490 Now the two occurrences of
3491 \begin_inset Flex Code
3494 \begin_layout Plain Layout
3501 \begin_inset Flex Code
3504 \begin_layout Plain Layout
3510 and can be translated correctly to
3521 \begin_layout Standard
3522 Of course the context information needs to be stripped off the original
3523 message when no translation is used.
3524 Therefore you have to put it in double square brackets at the end of the
3525 message (see the example above).
3526 The translation mechanism of \SpecialChar LyX
3527 ensures that everything in double square
3528 brackets at the end of messages is removed before displaying the message.
3531 \begin_layout Subsection
3532 Translating the documentation.
3535 \begin_layout Standard
3536 The online documentation (in the
3537 \begin_inset Flex Noun
3540 \begin_layout Plain Layout
3546 -menu) can (and should!) be translated.
3547 If there are translated versions of the documentation available
3551 \begin_layout Plain Layout
3552 As of March 2008, at least some of the documents have been translated into
3553 fourteen languages, with the Tutorial available in a few more.
3558 and the locale is set accordingly, these will be used automagically by
3562 looks for translated versions as
3563 \begin_inset Flex Code
3566 \begin_layout Plain Layout
3567 LyXDir/doc/xx/DocName.lyx
3573 \begin_inset Flex Code
3576 \begin_layout Plain Layout
3582 is the code for the language currently in use.
3583 If there are no translated documents, the default English versions will
3585 Note that the translated versions must have the same filenames (
3586 \begin_inset Flex Code
3589 \begin_layout Plain Layout
3595 above) as the original.
3596 If you feel up to translating the documentation (an excellent way to proof-read
3597 the original documentation by the way!), there are a few things you should
3601 \begin_layout Itemize
3602 Check out the documentation translation web page at
3603 \begin_inset CommandInset href
3605 name "https://www.lyx.org/Translation"
3606 target "https://www.lyx.org/Translation"
3612 That way, you can find out which (if any) documents have already been translate
3613 d into your language.
3614 You can also find out who (if anyone) is organizing the effort to translate
3615 the documentation into your language.
3616 If no one is organizing the effort, please let us know that you're interested.
3619 \begin_layout Standard
3620 Once you get to actually translating, here's a few hints for you that may
3624 \begin_layout Itemize
3625 Join the documentation team! There is information on how to do that in
3626 \begin_inset Flex Code
3629 \begin_layout Plain Layout
3636 \begin_inset Flex Noun
3639 \begin_layout Plain Layout
3640 Help\SpecialChar menuseparator
3646 ), which by the way is the first document you should translate.
3649 \begin_layout Itemize
3650 Learn the typographic conventions for the language you are translating to.
3651 Typography is an ancient art and over the centuries, a great variety of
3652 conventions have developed throughout different parts of the world.
3653 Also study the professional terminology amongst typographers in your country.
3654 Inventing your own terminology will only confuse the users.
3657 (Warning! Typography is addictive!)
3660 \begin_layout Itemize
3661 Make a copy of the document.
3662 This will be your working copy.
3663 You can use this as your personal translated help-file by placing it in
3665 \begin_inset Flex Code
3668 \begin_layout Plain Layout
3675 \begin_inset Note Greyedout
3678 \begin_layout Plain Layout
3683 For a complex document with external material (images, etc.), if you make
3685 \begin_inset space \thinspace{}
3689 \begin_inset space \space{}
3692 in a temp dir, beware that the links to external material may be broken
3693 when the document is moved to a different place.
3694 The best way is to retrieve the \SpecialChar LyX
3696 \begin_inset Flex URL
3699 \begin_layout Plain Layout
3701 https://www.lyx.org/HowToUseGIT
3706 ) and to edit the doc file in place.
3714 \begin_layout Itemize
3715 Sometimes the original document (from the \SpecialChar LyX
3716 team) will be updated.
3717 Use the source viewer at
3718 \begin_inset CommandInset href
3720 name "https://www.lyx.org/trac/timeline"
3721 target "https://www.lyx.org/trac/timeline"
3726 to see what has been changed.
3727 That way you can easily see which parts of the translated document need
3731 \begin_layout Standard
3732 If you ever find an error in the original document, fix it and notify the
3733 rest of the documentation team of the changes! (You didn't forget to join
3734 the documentation team, did you?)
3737 \begin_layout Standard
3738 \begin_inset Branch OutDated
3742 \begin_layout Section
3743 International Keyboard Support
3746 \begin_layout Standard
3749 [Editor's Note: The following section is by
3757 It needs to be fixed to conform to the new Documentation Style sheet and
3758 to make use of the new v1.0 features.
3759 The whole thing also needs to be merged with the section following it.-jw
3760 It may also be badly out of date.-rh (2008)]
3763 \begin_layout Subsection
3764 Defining Own Keymaps: Keymap File Format
3767 \begin_layout Standard
3768 Let's look at a keyboard definition file a little closer.
3769 It is a plain text file defining
3772 \begin_layout Itemize
3773 key-to-key or key-to-string translations
3776 \begin_layout Itemize
3780 \begin_layout Itemize
3781 dead keys exceptions
3784 \begin_layout Standard
3785 To define key-to-key or key-to-string translation, use this command:
3788 \begin_layout Quotation
3789 \begin_inset Flex Code
3792 \begin_layout Plain Layout
3801 \begin_inset Flex Code
3804 \begin_layout Plain Layout
3813 \begin_layout Standard
3815 \begin_inset Flex Code
3818 \begin_layout Plain Layout
3824 is the key to be translated and
3825 \begin_inset Flex Code
3828 \begin_layout Plain Layout
3834 is the string to be inserted into the document.
3835 To define dead keys, use:
3838 \begin_layout Quotation
3839 \begin_inset Flex Code
3842 \begin_layout Plain Layout
3851 \begin_inset Flex Code
3854 \begin_layout Plain Layout
3863 \begin_layout Standard
3865 \begin_inset Flex Code
3868 \begin_layout Plain Layout
3874 is a keyboard key and
3875 \begin_inset Flex Code
3878 \begin_layout Plain Layout
3885 The following dead keys are supported (shortcut name is in parentheses):
3888 \begin_layout Quotation
3892 \begin_inset space \hfill{}
3898 \begin_layout Quotation
3900 \begin_inset space \hfill{}
3906 \begin_layout Quotation
3908 \begin_inset space \hfill{}
3914 \begin_layout Quotation
3916 \begin_inset space \hfill{}
3922 \begin_layout Quotation
3924 \begin_inset space \hfill{}
3930 \begin_layout Quotation
3932 \begin_inset space \hfill{}
3939 \begin_layout Plain Layout
3951 \begin_layout Quotation
3953 \begin_inset space \hfill{}
3959 \begin_layout Quotation
3961 \begin_inset space \hfill{}
3968 \begin_layout Plain Layout
3980 \begin_layout Quotation
3982 \begin_inset space \hfill{}
3988 \begin_layout Quotation
3990 \begin_inset space \hfill{}
3996 \begin_layout Quotation
3998 \begin_inset space \hfill{}
4005 \begin_layout Plain Layout
4017 \begin_layout Quotation
4019 \begin_inset space \hfill{}
4026 \begin_layout Plain Layout
4038 \begin_layout Quotation
4040 \begin_inset space \hfill{}
4046 \begin_layout Quotation
4047 hungarian umlaut (hug)
4048 \begin_inset space \hfill{}
4054 \begin_layout Quotation
4056 \begin_inset space \hfill{}
4062 \begin_layout Quotation
4064 \begin_inset space \hfill{}
4071 \begin_layout Plain Layout
4083 \begin_layout Standard
4084 Since in many international keyboards there are exceptions to what some
4085 dead keys should do, you can define them using
4088 \begin_layout Quotation
4089 \begin_inset Flex Code
4092 \begin_layout Plain Layout
4100 deadkey key outstring
4103 \begin_layout Standard
4104 For example, on Slovak keyboard, if you enter caron-o, it generates circumflex-o
4108 \begin_layout Quotation
4109 \begin_inset Flex Code
4112 \begin_layout Plain Layout
4125 \begin_layout Standard
4126 to make it work correctly.
4127 Also, you have to define as exceptions dead keys over i and j, to remove
4128 the dot from them before inserting an accent mark.
4129 I will change this when the time comes, but so far I haven't had time.
4132 \begin_layout Standard
4133 Oh, and about characters: backslash is escaped, so to enter it, you'll need
4136 \begin_inset Flex Code
4139 \begin_layout Plain Layout
4145 have different meaning.
4147 \begin_inset Flex Code
4150 \begin_layout Plain Layout
4156 marks comments, quotes start and end \SpecialChar LaTeX
4158 To enter quote, you'll need to use
4159 \begin_inset Flex Code
4162 \begin_layout Plain Layout
4171 \begin_inset Flex Code
4174 \begin_layout Plain Layout
4181 \begin_inset Flex Code
4184 \begin_layout Plain Layout
4195 \begin_layout Standard
4196 If you make a keyboard description file that works for your language, please
4197 mail it to me, so I can include it in the next keymap distribution.
4200 \begin_layout Standard
4201 More keywords will be supported in keymap configuration file in future,
4205 \begin_layout Itemize
4206 \begin_inset Flex Code
4209 \begin_layout Plain Layout
4220 \begin_inset space \hfill{}
4224 \begin_inset Flex Code
4227 \begin_layout Plain Layout
4236 \begin_layout Itemize
4237 \begin_inset Flex Code
4240 \begin_layout Plain Layout
4251 \begin_inset space \hfill{}
4255 \begin_inset Flex Code
4258 \begin_layout Plain Layout
4264 an external keymap translation program
4267 \begin_layout Standard
4268 Also, it should look into
4269 \begin_inset Flex Code
4272 \begin_layout Plain Layout
4278 file for defaults, too (for example, a
4279 \begin_inset Flex Code
4282 \begin_layout Plain Layout
4290 option to include default keyboard).
4298 \begin_layout Section
4299 International Keymap Stuff
4300 \begin_inset CommandInset label
4302 name "sec:International-Keymap-Stuff"
4309 \begin_layout Standard
4310 \begin_inset Note Note
4313 \begin_layout Plain Layout
4314 In doing the revisions on this document in March 2008, I did not look over
4315 this stuff, as I do not understand it.
4316 It would be good if someone else could do so.
4325 \begin_layout Standard
4326 The next two sections describe the
4327 \begin_inset Flex Code
4330 \begin_layout Plain Layout
4339 \begin_inset Flex Code
4342 \begin_layout Plain Layout
4350 file syntax in detail.
4351 These sections should help you design your own key map if the ones provided
4352 do not meet your needs.
4355 \begin_layout Subsection
4359 \begin_layout Standard
4363 \begin_inset Flex Code
4366 \begin_layout Plain Layout
4372 file maps keystrokes to characters or strings.
4373 As the name suggests, it sets a keyboard mapping.
4375 \begin_inset Flex Code
4378 \begin_layout Plain Layout
4389 \begin_inset Flex Code
4392 \begin_layout Plain Layout
4407 \begin_inset Flex Code
4410 \begin_layout Plain Layout
4423 \begin_inset Flex Code
4426 \begin_layout Plain Layout
4435 \begin_inset Flex Code
4438 \begin_layout Plain Layout
4446 are described in this section.
4449 \begin_layout Labeling
4450 \labelwidthstring 00.00.0000
4451 \begin_inset Flex Code
4454 \begin_layout Plain Layout
4462 Map a character to a string
4465 \begin_layout LyX-Code
4480 \begin_layout Standard
4513 the double-quote (")
4530 must be escaped with a preceding backslash (
4541 \begin_layout Standard
4543 \begin_inset Flex Noun
4546 \begin_layout Plain Layout
4554 statement to cause the symbol
4555 \begin_inset Flex Noun
4558 \begin_layout Plain Layout
4566 to be output for the keystroke
4567 \begin_inset Flex Noun
4570 \begin_layout Plain Layout
4581 \begin_layout LyX-Code
4587 \begin_layout Labeling
4588 \labelwidthstring 00.00.0000
4589 \begin_inset Flex Code
4592 \begin_layout Plain Layout
4600 Specify an accent character
4603 \begin_layout LyX-Code
4612 \begin_layout Standard
4613 This will make the cha
4651 This is the dead key
4655 \begin_layout Plain Layout
4662 refers to a key that does not produce a character by itself, but when followed
4663 with another key, produces the desired accent character.
4664 For example, a German characte
4666 r with an umlaut like
4676 can be produced in this manner.
4685 \begin_layout Standard
4698 and then another key not in
4715 followed by the other, not allowed key, as output.
4719 \begin_inset Flex Noun
4722 \begin_layout Plain Layout
4730 cancels a dead key, so if
4741 \begin_inset Flex Noun
4744 \begin_layout Plain Layout
4753 , the cursor will not go one position backwards but will instead cancel
4769 might have had on the next keystroke.
4773 \begin_layout Standard
4774 The following example specifies that the character ' is to be an acute accent,
4775 allowed on the characters a, e, i, o, u, A, E, I, O, and U:
4778 \begin_layout LyX-Code
4781 kmod ' acute aeiouAEIOU
4784 \begin_layout Labeling
4785 \labelwidthstring 00.00.0000
4786 \begin_inset Flex Code
4789 \begin_layout Plain Layout
4795 Specify an exception to the accent character
4798 \begin_layout LyX-Code
4807 \begin_layout Standard
4808 This defines an exce
4849 have been assigned a keystroke with a previous
4852 \begin_inset Flex Code
4855 \begin_layout Plain Layout
4879 must not belong in the
4926 If such a declaration does not exist in
4934 \begin_inset Flex Code
4937 \begin_layout Plain Layout
4971 \begin_inset Flex Code
4974 \begin_layout Plain Layout
4988 \begin_layout Standard
4989 The following command produces causes äi to be produced when you enter acute-i
4993 \begin_layout LyX-Code
5007 \begin_layout Labeling
5008 \labelwidthstring 00.00.0000
5009 \begin_inset Flex Code
5012 \begin_layout Plain Layout
5018 Combine two accent characters
5021 \begin_layout LyX-Code
5027 accent1 accent2 allowed
5030 \begin_layout Standard
5031 This one is getting pretty esoteric.
5032 It allows you to combine the effect
5088 \begin_inset Flex Code
5091 \begin_layout Plain Layout
5119 \begin_layout Standard
5120 Consider this example from the
5121 \begin_inset Flex Code
5124 \begin_layout Plain Layout
5135 \begin_layout LyX-Code
5138 kmod ; acute aeioyvhAEIOYVH
5142 kcomb acute umlaut iyIY
5145 \begin_layout Standard
5146 This allows you to press
5147 \begin_inset Flex Noun
5150 \begin_layout Plain Layout
5158 and get the effect of
5159 \begin_inset Flex Code
5162 \begin_layout Plain Layout
5181 in this case cancels the last dead key, so if you press
5182 \begin_inset Flex Noun
5185 \begin_layout Plain Layout
5194 \begin_inset Flex Code
5197 \begin_layout Plain Layout
5210 \begin_layout Subsection
5214 \begin_layout Standard
5216 \begin_inset Flex Code
5219 \begin_layout Plain Layout
5227 mapping is performed, a
5228 \begin_inset Flex Code
5231 \begin_layout Plain Layout
5241 file maps the strings that the symbols generate to characters in the current
5243 The \SpecialChar LyX
5244 distribution currently includes at least the
5245 \begin_inset Flex Code
5248 \begin_layout Plain Layout
5257 \begin_inset Flex Code
5260 \begin_layout Plain Layout
5271 \begin_layout Standard
5273 \begin_inset Flex Code
5276 \begin_layout Plain Layout
5284 file is a sequence of declarations of the form
5287 \begin_layout LyX-Code
5300 \begin_layout Standard
5301 For example, in order to map
5302 \begin_inset Flex Noun
5305 \begin_layout Plain Layout
5315 to the corresponding character in the iso-8859-1 set (233), the following
5319 \begin_layout LyX-Code
5327 \begin_layout Standard
5329 \begin_inset Flex Code
5332 \begin_layout Plain Layout
5341 \begin_inset Flex Code
5344 \begin_layout Plain Layout
5362 the same character can apply to more than one string.
5364 \begin_inset Flex Code
5367 \begin_layout Plain Layout
5378 \begin_layout LyX-Code
5390 \begin_inset Newline newline
5406 \begin_layout Standard
5408 cannot find a mapping for the string produced by the keystroke or a
5409 deadkey sequence, it will check if it looks like an accented char and try
5410 to draw an accent over the character on screen.
5413 \begin_layout Subsection
5417 \begin_layout Standard
5418 There is a second way to add support for international characters through
5419 so-called dead-keys.
5420 A dead-key works in combination with a letter to produce an accented character.
5421 Here, we'll explain how to create a really simple dead-key to illustrate
5425 \begin_layout Standard
5426 Suppose you happen to need the circumflex character,
5427 \begin_inset Quotes eld
5431 \begin_inset Quotes erd
5436 \begin_inset Flex Noun
5439 \begin_layout Plain Layout
5446 \begin_inset space ~
5450 \begin_inset Flex Noun
5453 \begin_layout Plain Layout
5459 ] to the \SpecialChar LyX
5461 \begin_inset Flex Code
5464 \begin_layout Plain Layout
5471 \begin_inset Flex Code
5474 \begin_layout Plain Layout
5481 Now, whenever you type the
5482 \begin_inset Flex Noun
5485 \begin_layout Plain Layout
5491 -key followed by a letter, that letter will have a circumflex accent on
5493 For example, the sequence
5494 \begin_inset Quotes eld
5498 \begin_inset Flex Noun
5501 \begin_layout Plain Layout
5508 \begin_inset Quotes erd
5511 produces the letter:
5512 \begin_inset Quotes eld
5516 \begin_inset Quotes erd
5520 If you tried to type
5521 \begin_inset Quotes eld
5525 \begin_inset Flex Noun
5528 \begin_layout Plain Layout
5535 \begin_inset Quotes erd
5538 , however, \SpecialChar LyX
5539 will complain with a beep, since a
5540 \begin_inset Quotes eld
5544 \begin_inset Flex Noun
5547 \begin_layout Plain Layout
5554 \begin_inset Quotes erd
5557 never takes a circumflex accent.
5559 \begin_inset Flex Noun
5562 \begin_layout Plain Layout
5568 after a dead-key produces the bare-accent.
5569 Please note this last point! If you bind a key to a dead-key, you'll need
5570 to rebind the character on that key to yet another key.
5572 \begin_inset Flex Noun
5575 \begin_layout Plain Layout
5581 to a cedilla is a bad idea, since you'll only get cedillas instead of commas.
5584 \begin_layout Standard
5585 One common way to bind dead-keys is to use
5586 \begin_inset Flex Noun
5589 \begin_layout Plain Layout
5596 \begin_inset Flex Noun
5599 \begin_layout Plain Layout
5606 \begin_inset Flex Noun
5609 \begin_layout Plain Layout
5615 in combination with an accent, like
5616 \begin_inset Quotes eld
5620 \begin_inset Flex Noun
5623 \begin_layout Plain Layout
5630 \begin_inset Quotes erd
5634 \begin_inset Quotes eld
5638 \begin_inset Flex Noun
5641 \begin_layout Plain Layout
5648 \begin_inset Quotes erd
5652 \begin_inset Quotes eld
5656 \begin_inset Flex Noun
5659 \begin_layout Plain Layout
5666 \begin_inset Quotes erd
5670 Another way involves using
5671 \begin_inset Flex Code
5674 \begin_layout Plain Layout
5681 \begin_inset Flex Code
5684 \begin_layout Plain Layout
5690 to set up the special
5691 \begin_inset Flex Code
5694 \begin_layout Plain Layout
5702 \begin_inset Flex Code
5705 \begin_layout Plain Layout
5711 acts in some ways just like
5712 \begin_inset Flex Noun
5715 \begin_layout Plain Layout
5721 and permits you to bind keys to accented characters.
5722 You can also turn keys into dead-keys by binding them to something like
5724 \begin_inset Flex Code
5727 \begin_layout Plain Layout
5733 and then binding this symbolic key to the corresponding \SpecialChar LyX
5738 \begin_layout Plain Layout
5743 : This is exactly what I do in my
5744 \begin_inset Flex Code
5747 \begin_layout Plain Layout
5754 \begin_inset Flex Code
5757 \begin_layout Plain Layout
5765 \begin_inset Flex Noun
5768 \begin_layout Plain Layout
5770 \begin_inset space ~
5779 \begin_inset Flex Code
5782 \begin_layout Plain Layout
5788 and a bunch of these
5789 \begin_inset Quotes eld
5793 \begin_inset Flex Code
5796 \begin_layout Plain Layout
5803 \begin_inset Quotes erd
5806 symbolic keys bound such things as
5807 \begin_inset Flex Noun
5810 \begin_layout Plain Layout
5812 \begin_inset space ~
5821 \begin_inset Flex Noun
5824 \begin_layout Plain Layout
5826 \begin_inset space ~
5835 This is how I produce my accented characters.
5840 You can make just about anything into the
5841 \begin_inset Flex Code
5844 \begin_layout Plain Layout
5851 \begin_inset Flex Noun
5854 \begin_layout Plain Layout
5860 keys, a spare function key, etc.
5861 As for the \SpecialChar LyX
5862 commands that produce accents, check the entry for
5863 \begin_inset Flex Code
5866 \begin_layout Plain Layout
5877 You'll find the complete list there.
5880 \begin_layout Subsection
5881 Saving your Language Configuration
5884 \begin_layout Standard
5885 You can edit your preferences so that your desired language environment
5886 is automatically configured when \SpecialChar LyX
5888 \begin_inset Flex Noun
5891 \begin_layout Plain Layout
5892 Edit\SpecialChar menuseparator
5901 \begin_layout Chapter
5902 Installing New Document Classes, Layouts, and Templates
5903 \begin_inset CommandInset label
5905 name "cha:Installing-New-Document"
5910 \begin_inset Argument 1
5913 \begin_layout Plain Layout
5914 Installing New Document Classes
5922 \begin_layout Standard
5923 In this chapter, we describe the procedures for creating and installing
5924 new \SpecialChar LyX
5925 layout and template files, as well as offer a refresher on correctly
5926 installing new \SpecialChar LaTeX
5931 \begin_layout Standard
5932 First, let us a say a few words about how one ought to think about the relation
5933 between \SpecialChar LyX
5934 and \SpecialChar LaTeX
5936 The thing to understand is that, in a certain sense, \SpecialChar LyX
5937 doesn't know anything
5938 about \SpecialChar LaTeX
5940 Indeed, from \SpecialChar LyX
5941 's point of view, \SpecialChar LaTeX
5942 is just one of several
5943 \begin_inset Quotes eld
5947 \begin_inset Quotes erd
5950 in which it is capable of producing output.
5951 Other such formats are DocBook, plaintext, and XHTML.
5953 is, of course, a particularly important format, but very little of the
5954 information \SpecialChar LyX
5955 has about \SpecialChar LaTeX
5956 is actually contained in the program itself.
5960 \begin_layout Plain Layout
5961 Some commands are sufficiently complex that they are
5962 \begin_inset Quotes eld
5966 \begin_inset Quotes erd
5969 into \SpecialChar LyX
5971 But the developers generally regard this as a Bad Thing.
5976 Rather, that information, even for the standard classes like
5977 \begin_inset Flex Code
5980 \begin_layout Plain Layout
5986 , is contained in `layout files'.
5987 Similarly, \SpecialChar LyX
5988 itself does not know much about DocBook or XHTML.
5989 What it knows is contained in layout files.
5992 \begin_layout Standard
5993 You can think of the layout file for a given document class as a translation
5994 manual between \SpecialChar LyX
5995 constructs—paragraphs with their corresponding styles,
5996 certain sorts of insets, etc—and the corresponding \SpecialChar LaTeX
5999 Almost everything \SpecialChar LyX
6001 \begin_inset Flex Code
6004 \begin_layout Plain Layout
6010 , for example, is contained in the file
6011 \begin_inset Flex Code
6014 \begin_layout Plain Layout
6020 and in various other files it includes.
6021 For this reason, anyone intending to write layout files should plan to
6022 study the existing files.
6023 A good place to start is with
6024 \begin_inset Flex Code
6027 \begin_layout Plain Layout
6033 , which is included in
6034 \begin_inset Flex Code
6037 \begin_layout Plain Layout
6044 \begin_inset Flex Code
6047 \begin_layout Plain Layout
6053 , and many of the other layout files for document classes.
6054 This file is where sections and the like are defined:
6055 \begin_inset Flex Code
6058 \begin_layout Plain Layout
6064 tells \SpecialChar LyX
6065 how paragraphs that are marked with the Section, Subsection, etc,
6066 styles can be translated into corresponding \SpecialChar LaTeX
6067 , DocBook, and XHTML commands
6070 \begin_inset Flex Code
6073 \begin_layout Plain Layout
6079 file basically just includes several of these
6080 \begin_inset Flex Code
6083 \begin_layout Plain Layout
6092 \begin_layout Standard
6093 Defining the \SpecialChar LyX
6095 correspondence is not the only thing layout files do, though.
6096 Their other job is to define how the \SpecialChar LyX
6097 constructs themselves will appear
6099 The fact that layout files have these two jobs is often a source of confusion,
6100 because they are completely separate.
6101 Telling \SpecialChar LyX
6102 how to translate a certain paragraph style into \SpecialChar LaTeX
6105 how to display it; conversely, telling \SpecialChar LyX
6106 how to display a certain paragraph
6107 style does not tell \SpecialChar LyX
6108 how to translate it into \SpecialChar LaTeX
6109 (let alone tell \SpecialChar LaTeX
6112 So, in general, when you define a new \SpecialChar LyX
6113 construct, you must always do two
6114 quite separate things: (i)
6115 \begin_inset space ~
6118 tell \SpecialChar LyX
6119 how to translate it into \SpecialChar LaTeX
6121 \begin_inset space ~
6124 tell \SpecialChar LyX
6128 \begin_layout Standard
6129 Much the same is true, of course, as regards \SpecialChar LyX
6130 's other backend formats, though
6131 XHTML is in some ways different, because in that case \SpecialChar LyX
6136 able, to some extent, to use information about how it should display a
6137 paragraph on the screen to output information (in the form of CSS) about
6138 how the paragraph should be displayed in a browser.
6139 Even in this case, however, the distinction between what \SpecialChar LyX
6141 and how things are rendered externally remains in force, and the two can
6142 be controlled separately.
6144 \begin_inset CommandInset ref
6146 reference "sec:Tags-for-XHTML"
6153 \begin_layout Section
6154 Installing new \SpecialChar LaTeX
6158 \begin_layout Standard
6159 Some installations may not include a \SpecialChar LaTeX
6160 package or class file that you would
6161 like to use within \SpecialChar LyX
6163 For example, you might need Foil\SpecialChar TeX
6164 , a package for preparing slides for overhead
6166 Modern \SpecialChar LaTeX
6167 distributions like \SpecialChar TeX
6168 Live (2008 or newer) or MiK\SpecialChar TeX
6169 provide a user interface
6170 for installing such packages.
6171 For example, with MiK\SpecialChar TeX
6172 , you start the program
6173 \begin_inset Quotes eld
6177 \begin_inset space ~
6181 \begin_inset Quotes erd
6184 to get a list of available packages.
6185 To install one of them, right click on it or use the corresponding toolbar
6189 \begin_layout Standard
6190 If your \SpecialChar LaTeX
6191 distribution does not provide such a `package manager', or if the
6192 package is not available from your distribution, then follow these steps
6193 to install it manually:
6196 \begin_layout Enumerate
6197 Get the package from
6198 \begin_inset CommandInset href
6201 target "http://www.ctan.org/"
6209 \begin_layout Enumerate
6210 If the package contains a file with the ending
6211 \begin_inset Quotes eld
6215 \begin_inset Flex Code
6218 \begin_layout Plain Layout
6225 \begin_inset Quotes erd
6228 (is the case for Foil\SpecialChar TeX
6229 ) then open a console, change to the folder of this
6230 file and execute the command
6231 \begin_inset Flex Code
6234 \begin_layout Plain Layout
6241 You have now unpacked the package and have all files to install it.
6242 Most \SpecialChar LaTeX
6243 -packages are not packed and you can skip this step.
6246 \begin_layout Enumerate
6247 Now you need to decide if the package should be available for all users
6252 \begin_layout Enumerate
6253 On *nix systems (Linux, OSX, etc.), if you want the new package to be available
6254 for all users on your system, then install it in your `local' \SpecialChar TeX
6256 install it in your own `user' \SpecialChar TeX
6258 Where these trees should be created, if they do not already exist, depends
6260 To find this out, look in the file
6261 \begin_inset Flex Code
6264 \begin_layout Plain Layout
6274 \begin_layout Plain Layout
6275 This is usually in the directory
6276 \begin_inset Flex Code
6279 \begin_layout Plain Layout
6285 , though you can execute the command
6286 \begin_inset Flex Code
6289 \begin_layout Plain Layout
6300 The location of the `local' \SpecialChar TeX
6301 tree is defined by the
6302 \begin_inset Flex Code
6305 \begin_layout Plain Layout
6311 variable; this is usually somewhere like
6312 \begin_inset Flex Code
6315 \begin_layout Plain Layout
6316 /usr/local/share/texmf
6321 or /usr/local/texlive/XXXX where XXXX is the year of the installed \SpecialChar TeX
6324 The location of the `user' \SpecialChar TeX
6326 \begin_inset Flex Code
6329 \begin_layout Plain Layout
6336 \begin_inset Flex Code
6339 \begin_layout Plain Layout
6346 \begin_inset Flex Code
6349 \begin_layout Plain Layout
6358 (If these variables are not predefined, you have to define them.) You'll
6359 probably need root permissions to create or modify the `local' tree, but
6360 not for your `user' tree.
6361 \begin_inset Newline newline
6364 In general, it is recommended to install in the user tree because your user
6365 will not be modified or even overwritten when you upgrade your system.
6366 It will typically also be backed up together with everything else when
6367 you backup your home directory (which, of course, you do on a regular basis).
6370 \begin_layout Enumerate
6371 On Windows, if you want the new package to be available for all users on
6372 your system, change to the folder where \SpecialChar LaTeX
6373 is installed and then change to
6375 \begin_inset Flex Code
6378 \begin_layout Plain Layout
6389 (For MiK\SpecialChar TeX
6390 , this would be by default the folder
6391 \begin_inset Flex Code
6394 \begin_layout Plain Layout
6412 \begin_layout Plain Layout
6413 Note that this will be the correct path only on English installations.
6414 On a German one, it would be
6415 \begin_inset Flex Code
6418 \begin_layout Plain Layout
6432 , and similarly for other languages.
6437 Create there a new folder
6438 \begin_inset Flex Code
6441 \begin_layout Plain Layout
6447 and copy all files of the package into it.
6449 \begin_inset Newline newline
6452 If the package should only available for you or you don't have admin permissions
6453 , do the same, but in the local \SpecialChar LaTeX
6456 \begin_inset space \thinspace{}
6459 g., for MiK\SpecialChar TeX
6461 \begin_inset space ~
6464 2.8 under Windows XP, this would be the folder:
6465 \begin_inset Newline newline
6471 \begin_inset Flex Code
6474 \begin_layout Plain Layout
6477 Documents and Settings
6489 \begin_inset Newline newline
6495 \begin_inset Phantom HPhantom
6498 \begin_layout Plain Layout
6509 \begin_inset Flex Code
6512 \begin_layout Plain Layout
6525 \begin_inset Newline newline
6528 On Vista, it would be:
6529 \begin_inset Newline newline
6533 \begin_inset Flex Code
6536 \begin_layout Plain Layout
6562 \begin_layout Enumerate
6563 Now one only need to tell \SpecialChar LaTeX
6564 that there are new files.
6565 This depends on the used \SpecialChar LaTeX
6570 \begin_layout Enumerate
6571 For \SpecialChar TeX
6572 Live execute the command
6573 \begin_inset Flex Code
6576 \begin_layout Plain Layout
6583 If you installed the package for all users, then you will probably need
6584 to have root permissions for that.
6587 \begin_layout Enumerate
6588 For MiK\SpecialChar TeX
6589 , if you have installed the package for all users, start the program
6591 \begin_inset Quotes eld
6595 \begin_inset space ~
6599 \begin_inset Quotes erd
6602 and press the button marked
6603 \begin_inset Quotes eld
6607 \begin_inset Quotes erd
6611 Otherwise start the program
6612 \begin_inset Quotes eld
6616 \begin_inset Quotes erd
6623 \begin_layout Enumerate
6624 Finally, you need to tell \SpecialChar LyX
6625 that there are new packages available.
6626 So, in \SpecialChar LyX
6628 \begin_inset Flex Noun
6631 \begin_layout Plain Layout
6634 \SpecialChar menuseparator
6640 and then restart \SpecialChar LyX
6644 \begin_layout Standard
6645 Now the package is installed.
6646 In our example, the document class
6647 \begin_inset Flex Code
6650 \begin_layout Plain Layout
6656 will now be available under
6657 \begin_inset Flex Noun
6660 \begin_layout Plain Layout
6661 Document\SpecialChar menuseparator
6662 Settings\SpecialChar menuseparator
6669 \begin_inset Quotes eld
6673 \begin_inset Quotes erd
6680 \begin_layout Standard
6681 If you would like to use a \SpecialChar LaTeX
6682 document class that is not even listed in the
6684 \begin_inset Flex Noun
6687 \begin_layout Plain Layout
6688 Document\SpecialChar menuseparator
6689 Settings\SpecialChar menuseparator
6695 , then you need to create a `layout' file for it.
6696 That is the topic of the next section.
6699 \begin_layout Section
6700 Types of layout files
6703 \begin_layout Standard
6704 This section describes the various sorts of \SpecialChar LyX
6705 files that contain layout informati
6707 These files describe various paragraph and character styles, determining
6708 how \SpecialChar LyX
6709 should display them and how they should be translated into \SpecialChar LaTeX
6711 XHTML, or whatever output format is being used.
6715 \begin_layout Standard
6716 We shall try to provide a thorough description of the process of writing
6718 However, there are so many different types of documents supported even
6719 by just \SpecialChar LaTeX
6720 that we can't hope to cover every different possibility or problem
6721 you might encounter.
6722 The \SpecialChar LyX
6723 users' list is frequented by people with lots of experience with layout
6724 design who are willing to share what they've learned, so please feel free
6725 to ask questions there.
6728 \begin_layout Standard
6729 As you prepare to write a new layout, it is extremely helpful to look at
6730 the layouts distributed with \SpecialChar LyX
6732 If you write a \SpecialChar LyX
6733 layout for a \SpecialChar LaTeX
6734 document class that might also be used by
6735 others, or write a module that might be useful to others, then you should
6736 consider posting your layout to the
6737 \begin_inset CommandInset href
6739 name "layout section on the LyX wiki"
6740 target "https://wiki.lyx.org/Layouts/Layouts"
6745 or even to the \SpecialChar LyX
6746 developers' list, so that it might be included in \SpecialChar LyX
6751 \begin_layout Plain Layout
6752 Note that \SpecialChar LyX
6753 is licensed under the General Public License, so any material
6754 that is contributed to \SpecialChar LyX
6755 must be similarly licensed.
6763 \begin_layout Subsection
6765 \begin_inset CommandInset label
6767 name "subsec:Layout-modules"
6774 \begin_layout Standard
6775 We have spoken to this point about `layout files'.
6776 But there are different sorts of files that contain layout information.
6777 Layout files, strictly so called, have the
6778 \begin_inset Flex Code
6781 \begin_layout Plain Layout
6787 extension and provide \SpecialChar LyX
6788 with information about document classes.
6789 Since \SpecialChar LyX
6790 1.6 layout information can also be contained in layout
6795 \begin_inset Flex Code
6798 \begin_layout Plain Layout
6805 Modules are to \SpecialChar LaTeX
6806 packages much as layouts are to \SpecialChar LaTeX
6807 classes, and some modules—such
6809 \begin_inset Flex Code
6812 \begin_layout Plain Layout
6818 module—specifically provide support for one package.
6819 In a sense, layout modules are similar to included
6823 \begin_layout Plain Layout
6824 These can have any extension, but by convention have the
6825 \begin_inset Flex Code
6828 \begin_layout Plain Layout
6840 \begin_inset Flex Code
6843 \begin_layout Plain Layout
6849 —in that modules are not specific to a given document class but may be used
6850 with many different classes.
6851 The difference is that using an included file with
6852 \begin_inset Flex Code
6855 \begin_layout Plain Layout
6861 requires editing that file.
6862 Modules, by contrast, are selected in the
6863 \begin_inset Flex Noun
6866 \begin_layout Plain Layout
6867 Document\SpecialChar menuseparator
6876 \begin_layout Standard
6877 Building modules is the easiest way to get started with layout editing,
6878 since it can be as simple as adding a single new paragraph style or flex
6880 But modules may, in principle, contain anything a layout file can contain.
6883 \begin_layout Standard
6884 After creating a new module and copying it to the
6885 \begin_inset Flex Code
6888 \begin_layout Plain Layout
6894 folder, you will need to reconfigure and then restart \SpecialChar LyX
6897 However, changes you make to the module will be seen immediately, if you
6899 \begin_inset Flex Noun
6902 \begin_layout Plain Layout
6903 Document\SpecialChar menuseparator
6909 , highlight something, and then hit
6910 \begin_inset Quotes eld
6914 \begin_inset Quotes erd
6920 It is strongly recommended that you save your work before doing this
6925 it is strongly recommended that you not attempt to edit modules while simultaneo
6926 usly working on actual documents
6929 Though of course the developers strive to keep \SpecialChar LyX
6930 stable in such situations,
6931 syntax errors and the like in your module file could cause strange behavior.
6934 \begin_layout Subsubsection
6938 \begin_layout Standard
6939 Modules are to \SpecialChar LyX
6940 as packages are to \SpecialChar LaTeX
6942 Sometimes, however, you find yourself wanting a specific inset or character
6943 style just for one document and writing a module that will also be available
6944 to other documents makes little sense.
6945 What you need is \SpecialChar LyX
6947 \begin_inset Quotes eld
6951 \begin_inset Quotes erd
6957 \begin_layout Standard
6958 You will find it under
6960 Document\SpecialChar menuseparator
6961 Settings\SpecialChar menuseparator
6965 The large text box allows you to enter anything that you might enter in
6966 a layout file or module.
6967 You can think of a document's local layout, in fact, as a module that belongs
6969 So, in particular, you must enter a
6970 \begin_inset Flex Code
6973 \begin_layout Plain Layout
6980 Any format is acceptable, but one would normally use the format current
6982 (In \SpecialChar LyX
6989 , the current layout format is
6998 \begin_layout Standard
6999 When you have entered something in the
7000 \begin_inset Flex Code
7003 \begin_layout Plain Layout
7009 pane, \SpecialChar LyX
7011 \begin_inset Quotes eld
7015 \begin_inset Quotes erd
7018 button at the bottom.
7019 Clicking this button will cause \SpecialChar LyX
7020 to determine whether what you have entered
7021 is valid layout information for the chosen format.
7023 will report the result but, unfortunately, will not tell you what errors
7024 there might have been.
7025 These will be written to the terminal, however, if \SpecialChar LyX
7026 is started from a terminal.
7027 You will not be permitted to save your local layout until you have entered
7031 \begin_layout Standard
7032 The warnings at the end of the previous section apply here, too.
7033 Do not play with local layout while you are actually working, especially
7034 if you have not saved your document.
7035 That said, using local layout with a test document can be a very convenient
7036 way to try out layout ideas, or even to start developing a module.
7039 \begin_layout Subsection
7041 \begin_inset Flex Noun
7044 \begin_layout Plain Layout
7053 \begin_layout Standard
7054 There are two situations you are likely to encounter when wanting to support
7055 a new \SpecialChar LaTeX
7056 document class, involving style (
7057 \begin_inset Flex Code
7060 \begin_layout Plain Layout
7066 ) files and \SpecialChar LaTeX2e
7068 \begin_inset Flex Code
7071 \begin_layout Plain Layout
7078 Supporting a style file is usually fairly easy.
7079 Supporting a new class file is a bit harder.
7080 We'll discuss the former in this section and the latter in the next.
7081 Similar remarks apply, of course, if you want to support a new DocBook
7085 \begin_layout Standard
7086 The easier case is the one in which your new document class is provided
7087 as a style file that is to be used in conjunction with an already supported
7089 For the sake of the example, we'll assume that the style file is called
7091 \begin_inset Flex Noun
7094 \begin_layout Plain Layout
7100 and that it is meant to be used with
7101 \begin_inset Flex Noun
7104 \begin_layout Plain Layout
7110 , which is a standard class.
7114 \begin_layout Standard
7115 Start by copying the existing class's layout file into your local directory:
7119 \begin_layout Plain Layout
7120 Of course, which directory is your local directory will vary by platform,
7121 and \SpecialChar LyX
7122 allows you to specify your local directory on startup, too, using
7124 \begin_inset Flex Code
7127 \begin_layout Plain Layout
7141 \begin_layout LyX-Code
7142 cp report.layout ~/.lyx/layouts/myclass.layout
7145 \begin_layout Standard
7147 \begin_inset Flex Code
7150 \begin_layout Plain Layout
7156 and change the line:
7159 \begin_layout LyX-Code
7162 DeclareLaTeXClass{Report (Standard Class)}
7165 \begin_layout Standard
7169 \begin_layout LyX-Code
7172 DeclareLaTeXClass[report, myclass.sty]{Report (My Class)}
7175 \begin_layout Standard
7179 \begin_layout LyX-Code
7181 \begin_inset Newline newline
7187 \begin_inset Newline newline
7193 \begin_layout Standard
7194 near the top of the file.
7197 \begin_layout Standard
7198 Start \SpecialChar LyX
7200 \begin_inset Flex Noun
7203 \begin_layout Plain Layout
7204 Tools\SpecialChar menuseparator
7211 Then restart \SpecialChar LyX
7212 and try creating a new document.
7214 \begin_inset Flex Noun
7217 \begin_layout Plain Layout
7223 " as a document class option in the
7224 \begin_inset Flex Noun
7227 \begin_layout Plain Layout
7228 Document\SpecialChar menuseparator
7235 It is likely that some of the sectioning commands and such in your new
7236 class will work differently from how they worked in the base class—
7237 \begin_inset Flex Code
7240 \begin_layout Plain Layout
7246 in this example—so you can fiddle around with the settings for the different
7247 sections if you wish.
7248 The layout information for sections is contained in
7249 \begin_inset Flex Code
7252 \begin_layout Plain Layout
7258 , but you do not need to copy and change this file.
7259 Instead, you can simply add your changes to your layout file, after the
7261 \begin_inset Flex Code
7264 \begin_layout Plain Layout
7270 , which itself includes
7271 \begin_inset Flex Code
7274 \begin_layout Plain Layout
7281 For example, you might add these lines:
7284 \begin_layout LyX-Code
7288 \begin_layout LyX-Code
7292 \begin_layout LyX-Code
7296 \begin_layout LyX-Code
7300 \begin_layout LyX-Code
7304 \begin_layout Standard
7305 to change the font for chapter headings to sans-serif.
7306 This will override (or, in this case, add to) the existing declaration
7307 for the Chapter style.
7311 \begin_layout Standard
7312 Your new package may also provide commands or environments not present in
7314 In this case, you will want to add these to the layout file.
7316 \begin_inset CommandInset ref
7318 reference "sec:TextClass"
7322 for information on how to do so.
7325 \begin_layout Standard
7327 \begin_inset Flex Noun
7330 \begin_layout Plain Layout
7336 can be used with several different document classes, and even if it cannot,
7337 you might find it easiest just to write a module that you can load with
7339 The simplest possible such module would be:
7342 \begin_layout LyX-Code
7345 DeclareLyXModule{My Class}
7348 \begin_layout LyX-Code
7352 \begin_layout LyX-Code
7353 #Support for myclass.sty.
7356 \begin_layout LyX-Code
7358 \begin_inset Newline newline
7364 \begin_layout LyX-Code
7372 \begin_inset Newline newline
7378 \begin_layout LyX-Code
7380 \begin_inset Newline newline
7386 \begin_inset Newline newline
7392 \begin_layout Standard
7393 A more complex module might modify the behavior of some existing constructs
7394 or define some new ones.
7396 \begin_inset CommandInset ref
7398 reference "sec:TextClass"
7405 \begin_layout Subsection
7407 \begin_inset Flex Noun
7410 \begin_layout Plain Layout
7419 \begin_layout Standard
7420 There are two possibilities here.
7421 One is that the class file is itself based upon an existing document class.
7422 For example, many thesis classes are based upon
7423 \begin_inset Flex Noun
7426 \begin_layout Plain Layout
7433 To see whether yours is, look for a line like
7436 \begin_layout LyX-Code
7442 \begin_layout Standard
7444 If so, then you may proceed largely as in the previous section, though
7446 \begin_inset Flex Code
7449 \begin_layout Plain Layout
7450 Declare\SpecialChar LaTeX
7456 line will be different.
7457 If your new class is
7458 \begin_inset Flex Code
7461 \begin_layout Plain Layout
7467 and it is based upon
7468 \begin_inset Flex Code
7471 \begin_layout Plain Layout
7477 , then the line should read:
7481 \begin_layout Plain Layout
7482 And it will be easiest if you save the file to
7483 \begin_inset Flex Code
7486 \begin_layout Plain Layout
7493 assumes that the document class has the same name as the layout file.
7502 \begin_layout LyX-Code
7505 DeclareLaTeXClass[thesis,book]{thesis}
7508 \begin_layout Standard
7509 If, on the other hand, the new class is not based upon an existing class,
7510 you will probably have to
7511 \begin_inset Quotes eld
7515 \begin_inset Quotes erd
7519 We strongly suggest copying an existing layout file which uses a similar
7521 class and then modifying it, if you can do so.
7522 At least use an existing file as a starting point so you can find out what
7523 items you need to worry about.
7524 Again, the specifics are covered below.
7527 \begin_layout Subsection
7529 \begin_inset CommandInset label
7531 name "subsec:Creating-Templates"
7538 \begin_layout Standard
7539 Once you have written a layout file for a new document class, you might
7540 want to consider writing a
7545 A template acts as a kind of tutorial for your layout, showing how it might
7546 be used, though containing dummy content.
7547 You can of course look at the various templates included with \SpecialChar LyX
7551 \begin_layout Standard
7552 Templates are created just like usual documents: using \SpecialChar LyX
7554 The only difference is that usual documents contain all possible settings,
7555 including the font scheme and the paper size.
7556 Usually a user doesn't want a template to overwrite his preferred settings
7557 for such parameters.
7558 For that reason, the designer of a template should remove the corresponding
7560 \begin_inset Flex Code
7563 \begin_layout Plain Layout
7572 \begin_inset Flex Code
7575 \begin_layout Plain Layout
7583 from the template \SpecialChar LyX
7585 This can be done with any simple text-editor, for example
7586 \begin_inset Flex Code
7589 \begin_layout Plain Layout
7596 \begin_inset Flex Code
7599 \begin_layout Plain Layout
7608 \begin_layout Standard
7609 Put the edited template files you create in
7610 \begin_inset Flex Code
7613 \begin_layout Plain Layout
7619 , copy the ones you use from the global template directory in
7620 \begin_inset Flex Code
7623 \begin_layout Plain Layout
7629 to the same place, and redefine the template path in the
7630 \begin_inset Flex Noun
7633 \begin_layout Plain Layout
7634 Tools\SpecialChar menuseparator
7635 Preferences\SpecialChar menuseparator
7644 \begin_layout Standard
7645 Note, by the way, that there is a template which has a particular meaning:
7646 \begin_inset Newline linebreak
7650 \begin_inset Flex Code
7653 \begin_layout Plain Layout
7660 This template is loaded every time you create a new document with
7661 \begin_inset Flex Noun
7664 \begin_layout Plain Layout
7665 File\SpecialChar menuseparator
7671 in order to provide useful defaults.
7672 To create this template from inside \SpecialChar LyX
7673 , all you have to do is to open a document
7674 with the correct settings, and use the
7675 \begin_inset Flex Noun
7678 \begin_layout Plain Layout
7679 Save as Document Defaults
7687 \begin_layout Subsection
7688 Upgrading old layout files
7691 \begin_layout Standard
7692 The format of layout files changes with each \SpecialChar LyX
7693 release, so old layout files
7694 need to be converted to the new format.
7696 reads a layout file in an older format, it automatically calls the
7698 \begin_inset Flex Code
7701 \begin_layout Plain Layout
7707 to convert it to a temporary file in current format.
7708 The original file is left untouched.
7709 If you use the layout file often, then, you may want to convert it permanently,
7710 so that \SpecialChar LyX
7711 does not have to do so itself every time.
7712 To do this, you can call the converter manually:
7715 \begin_layout Enumerate
7717 \begin_inset Flex Code
7720 \begin_layout Plain Layout
7727 \begin_inset Flex Code
7730 \begin_layout Plain Layout
7739 \begin_layout Enumerate
7741 \begin_inset Newline newline
7745 \begin_inset Flex Code
7748 \begin_layout Plain Layout
7749 python LyXDir/scripts/layout2layout.py myclass.old myclass.layout
7755 \begin_inset Newline newline
7759 \begin_inset Flex Code
7762 \begin_layout Plain Layout
7768 is the name of your \SpecialChar LyX
7772 \begin_layout Standard
7773 Note that manual conversion does not affect included files, so these will
7774 have to be converted separately.
7777 \begin_layout Subsection
7778 \begin_inset CommandInset label
7780 name "subsec:Cite-Engine-Files"
7787 \begin_layout Standard
7788 A specific form of layout files are the so-called
7789 \begin_inset Flex Code
7792 \begin_layout Plain Layout
7798 files that are located in the
7799 \begin_inset Flex Code
7802 \begin_layout Plain Layout
7809 Their purpose is to define the specifics of \SpecialChar LaTeX
7810 packages aimed at bibliography
7823 , but also the way how normal Bib\SpecialChar TeX
7824 citations (without additional packages)
7825 are handled in \SpecialChar LyX
7826 is defined in such a file.
7830 \begin_layout Standard
7831 More specifically, it is defined which packages \SpecialChar LyX
7832 needs to load, which citation
7833 commands are available, how these are to be displayed in \SpecialChar LyX
7835 the dialogs, the context menus) as well as in the XHTML and plain text
7837 Furthermore, the files specify available style variants (author-year, numerical
7838 , etc.) and their specifics.
7839 The cite engine files are also used to generate the options that are available
7842 Document\SpecialChar menuseparator
7843 Settings\SpecialChar menuseparator
7844 Bibliography\SpecialChar menuseparator
7850 \begin_layout Standard
7851 Even though a cite engine file is essentially a normal layout file that
7852 could theoretically include any layout information, it usually primarily
7853 includes some specific parameters such as
7854 \begin_inset Flex Code
7857 \begin_layout Plain Layout
7864 \begin_inset Flex Code
7867 \begin_layout Plain Layout
7874 \begin_inset Flex Code
7877 \begin_layout Plain Layout
7884 \begin_inset Flex Code
7887 \begin_layout Plain Layout
7894 The syntax of the latter two is described in
7895 \begin_inset CommandInset ref
7897 reference "subsec:Citation-engine-description"
7905 \begin_inset CommandInset ref
7907 reference "subsec:Citation-format-description"
7911 , as well as in the files themselves.
7914 \begin_layout Section
7915 \begin_inset CommandInset label
7917 name "sec:TextClass"
7921 The layout file format
7924 \begin_layout Standard
7925 The following sections describe how layout files are structured and written.
7926 Our advice is to go slowly, save and test often.
7927 It is really not that hard, except that the multitude of options can become
7928 overwhelming, especially if you try to check out too many at once.
7929 It becomes easier if you use existing layouts of \SpecialChar LyX
7930 as examples/reference
7931 or if you modify an existing layout to your needs.
7934 \begin_layout Standard
7935 Note that all the tags used in layout files are case-insensitive.
7937 \begin_inset Flex Code
7940 \begin_layout Plain Layout
7947 \begin_inset Flex Code
7950 \begin_layout Plain Layout
7957 \begin_inset Flex Code
7960 \begin_layout Plain Layout
7966 are really the same tag.
7967 The possible arguments are printed in brackets after the tag's name.
7968 The default argument is typeset
7969 \begin_inset Flex Code
7972 \begin_layout Plain Layout
7981 If the argument has a data type like
7982 \begin_inset Quotes eld
7986 \begin_inset Quotes erd
7990 \begin_inset Quotes eld
7994 \begin_inset Quotes erd
7997 , the default is shown like this:
7998 \begin_inset Flex Code
8001 \begin_layout Plain Layout
8012 \begin_layout Subsection
8013 The document class declaration and classification
8016 \begin_layout Standard
8017 Lines in a layout file which begin with
8018 \begin_inset Flex Code
8021 \begin_layout Plain Layout
8028 There is one exception to this rule.
8030 \begin_inset Flex Code
8033 \begin_layout Plain Layout
8039 files should begin with lines like:
8042 \begin_layout LyX-Code
8045 #% Do not delete the line below; configure depends on this
8048 \begin_layout LyX-Code
8053 DeclareLaTeXClass{Article (Standard Class)}
8056 \begin_layout LyX-Code
8061 DeclareCategory{Articles}
8064 \begin_layout Standard
8065 The second and third lines are used when you (re)configure \SpecialChar LyX
8067 The layout file is read by the \SpecialChar LaTeX
8069 \begin_inset Flex Code
8072 \begin_layout Plain Layout
8078 , in a special mode where
8079 \begin_inset Flex Code
8082 \begin_layout Plain Layout
8089 The first line is just a \SpecialChar LaTeX
8090 comment, the second one contains the mandatory
8091 declaration of the text class and the third line contains the optional
8092 classification of the class.
8093 If these lines appear in a file named
8094 \begin_inset Flex Code
8097 \begin_layout Plain Layout
8103 , then they define a text class of name
8104 \begin_inset Flex Code
8107 \begin_layout Plain Layout
8113 (the name of the layout file) which uses the \SpecialChar LaTeX
8115 \begin_inset Flex Code
8118 \begin_layout Plain Layout
8124 (the default is to use the same name as the layout).
8126 \begin_inset Quotes eld
8129 Article (Standard Class)
8130 \begin_inset Quotes erd
8133 that appears above is used as a description of the text class in the
8134 \begin_inset Flex Noun
8137 \begin_layout Plain Layout
8138 Document\SpecialChar menuseparator
8146 \begin_inset Quotes eld
8150 \begin_inset Quotes erd
8153 in the example) is also used in the
8154 \begin_inset Flex Noun
8157 \begin_layout Plain Layout
8158 Document\SpecialChar menuseparator
8164 dialog: the text classes are grouped by these categories (which are usually
8165 genres, so typical categories are
8166 \begin_inset Quotes eld
8170 \begin_inset Quotes erd
8174 \begin_inset Quotes eld
8178 \begin_inset Quotes erd
8182 \begin_inset Quotes eld
8186 \begin_inset Quotes erd
8190 \begin_inset Quotes eld
8194 \begin_inset Quotes erd
8198 \begin_inset Quotes eld
8202 \begin_inset Quotes erd
8206 \begin_inset Quotes eld
8210 \begin_inset Quotes erd
8214 If no category has been declared, the class will be put in the
8215 \begin_inset Quotes eld
8219 \begin_inset Quotes erd
8225 \begin_layout Standard
8226 Let's assume that you wrote your own text class that uses the
8227 \begin_inset Flex Code
8230 \begin_layout Plain Layout
8236 document class, but where you changed the appearance of the section headings.
8237 If you put it in a file
8238 \begin_inset Flex Code
8241 \begin_layout Plain Layout
8247 , the header of this file should be:
8250 \begin_layout LyX-Code
8253 #% Do not delete the line below; configure depends on this
8256 \begin_layout LyX-Code
8261 DeclareLaTeXClass[article]{Article (with My Own Headings)}
8264 \begin_layout LyX-Code
8269 DeclareCategory{Articles}
8272 \begin_layout Standard
8273 This declares a text class
8274 \begin_inset Flex Code
8277 \begin_layout Plain Layout
8283 , associated with the \SpecialChar LaTeX
8285 \begin_inset Flex Code
8288 \begin_layout Plain Layout
8295 \begin_inset Quotes eld
8298 Article (with My Own Headings)
8299 \begin_inset Quotes erd
8303 If your text class depends on several packages, you can declare it as:
8306 \begin_layout LyX-Code
8309 #% Do not delete the line below; configure depends on this
8312 \begin_layout LyX-Code
8317 DeclareLaTeXClass[article,foo.sty]{Article (with My Own Headings)}
8320 \begin_layout LyX-Code
8325 DeclareCategory{Articles}
8328 \begin_layout Standard
8329 This indicates that your text class uses the
8330 \begin_inset Flex Code
8333 \begin_layout Plain Layout
8340 Finally, it is also possible to declare classes for DocBook code.
8341 Typical declarations will look like:
8344 \begin_layout LyX-Code
8347 #% Do not delete the line below; configure depends on this
8350 \begin_layout LyX-Code
8355 DeclareDocBookClass[article]{SGML (DocBook Article)}
8358 \begin_layout LyX-Code
8363 DeclareCategory{Articles (DocBook)}
8366 \begin_layout Standard
8367 Note that these declarations can also be given an optional parameter declaring
8368 the name of the document class (but not a list).
8371 \begin_layout Standard
8372 So, to be as explicit as possible, the form of the layout declaration is:
8375 \begin_layout LyX-Code
8380 DeclareLaTeXClass[class,package.sty]{layout description}
8383 \begin_layout LyX-Code
8388 DeclareCategory{category}
8391 \begin_layout Standard
8392 The class need only be specified if the name of the \SpecialChar LaTeX
8394 name of the layout file are different or if there are packages to load.
8395 If the name of the class file is not specified, then \SpecialChar LyX
8397 that it is the same as the name of the layout file.
8400 \begin_layout Standard
8401 When the text class has been modified to your taste, all you have to do
8402 is to copy it either to
8403 \begin_inset Flex Code
8406 \begin_layout Plain Layout
8413 \begin_inset Flex Code
8416 \begin_layout Plain Layout
8423 \begin_inset Flex Noun
8426 \begin_layout Plain Layout
8427 Tools\SpecialChar menuseparator
8433 , exit \SpecialChar LyX
8435 Then your new text class should be available along with the others.
8438 \begin_layout Standard
8439 Once the layout file is installed, you can edit it and see your changes
8440 without having to reconfigure or to restart \SpecialChar LyX
8445 \begin_layout Plain Layout
8446 In versions of \SpecialChar LyX
8447 prior to 1.6, this was not true.
8448 As a result, editing layout files was very time consuming, since you had
8449 constantly to restart \SpecialChar LyX
8455 You can force a reload of the current layout by using the \SpecialChar LyX
8457 \begin_inset Flex Noun
8460 \begin_layout Plain Layout
8467 There is no default binding for this function—though, of course, you can
8468 bind it to a key yourself.
8469 But you will normally use this function simply by entering it in the mini-buffe
8474 \begin_layout Standard
8480 \begin_inset Flex Noun
8483 \begin_layout Plain Layout
8489 is very much an `advanced feature'.
8494 recommended that you save your work before using this function.
8499 recommended that you not attempt to edit layout information while simultaneousl
8500 y working on a document that you care about.
8501 Use a test document.
8502 Syntax errors and the like in your layout file could cause peculiar behavior.
8503 In particular, such errors could cause \SpecialChar LyX
8504 to regard the current layout as
8505 invalid and to attempt to switch to some other layout.
8509 \begin_layout Plain Layout
8510 Really bad syntax errors may even caused \SpecialChar LyX
8512 This is because certain sorts of errors may make \SpecialChar LyX
8523 The \SpecialChar LyX
8524 team strives to keep \SpecialChar LyX
8525 stable in such situations, but safe is better
8530 \begin_layout Plain Layout
8531 While we're giving advice: make regular backups.
8532 And be nice to your mother.
8540 \begin_layout Subsection
8541 The Module declaration
8544 \begin_layout Standard
8545 A module must begin with a line like the following:
8548 \begin_layout LyX-Code
8551 DeclareLyXModule[endnotes.sty]{Endnotes}
8552 \change_inserted -712698321 1554395911
8556 \begin_layout LyX-Code
8558 \change_inserted -712698321 1554395924
8563 DeclareCategory{Foot- and Endnotes}
8564 \change_deleted -712698321 1554395911
8572 \begin_layout Standard
8573 The mandatory argument
8574 \change_inserted -712698321 1554395956
8583 , in curly brackets, is the name of the module, as it should appear in
8584 \begin_inset Flex Noun
8587 \begin_layout Plain Layout
8588 Document\SpecialChar menuseparator
8589 Settings\SpecialChar menuseparator
8596 The argument in square brackets is optional: It declares any \SpecialChar LaTeX
8598 on which the module depends.
8599 It is also possible to use the form
8600 \begin_inset Flex Noun
8603 \begin_layout Plain Layout
8609 as an optional argument, which declares that the module can only be used
8610 when there exists a conversion chain between the formats `
8611 \begin_inset Flex Code
8614 \begin_layout Plain Layout
8621 \begin_inset Flex Code
8624 \begin_layout Plain Layout
8632 \change_inserted -712698321 1554396133
8639 declaration is not strictly mandatory, but you should add it, since it
8640 is helpful to find the module.
8641 Please have a look at the existing module categories and if appropriate,
8647 \begin_layout Standard
8649 \change_inserted -712698321 1554395988
8652 declaration should then be followed by lines like the following:
8656 \begin_layout Plain Layout
8657 Preferably in English if the module should be published with \SpecialChar LyX
8659 This description will appear in the list of messages to be translated and
8660 will be thus translated with the next interface update.
8668 \begin_layout LyX-Code
8672 \begin_layout LyX-Code
8673 #Adds an endnote command, in addition to footnotes.
8677 \begin_layout LyX-Code
8678 #You will need to add
8680 theendnotes in TeX code where you
8683 \begin_layout LyX-Code
8684 #want the endnotes to appear.
8688 \begin_layout LyX-Code
8692 \begin_layout LyX-Code
8693 #Requires: somemodule | othermodule
8696 \begin_layout LyX-Code
8697 #Excludes: badmodule
8700 \begin_layout Standard
8701 The description is used in
8702 \begin_inset Flex Noun
8705 \begin_layout Plain Layout
8706 Document\SpecialChar menuseparator
8707 Settings\SpecialChar menuseparator
8713 to provide the user with information about what the module does.
8715 \begin_inset Flex Code
8718 \begin_layout Plain Layout
8724 line is used to identify other modules with which this one must be used;
8726 \begin_inset Flex Code
8729 \begin_layout Plain Layout
8735 line is used to identify modules with which this one may not be used.
8736 Both are optional, and, as shown, multiple modules should be separated
8737 with the pipe symbol: |.
8738 Note that the required modules are treated disjunctively:
8742 of the required modules must be used.
8747 excluded module may be used.
8748 Note that modules are identified here by their filenames without the
8749 \begin_inset Flex Code
8752 \begin_layout Plain Layout
8760 \begin_inset Flex Code
8763 \begin_layout Plain Layout
8770 \begin_inset Flex Code
8773 \begin_layout Plain Layout
8782 \begin_layout Subsection
8783 The CiteEngine file declaration
8786 \begin_layout Standard
8787 A cite engine file must begin with a line like the following:
8790 \begin_layout LyX-Code
8793 DeclareLyXCiteEngineModule[biblatex.sty]{Biblatex}
8796 \begin_layout Standard
8797 The mandatory argument, in curly brackets, is the name of the cite style,
8798 as it should appear in
8799 \begin_inset Flex Noun
8802 \begin_layout Plain Layout
8803 Document\SpecialChar menuseparator
8804 Settings\SpecialChar menuseparator
8811 The argument in square brackets is optional: It declares any \SpecialChar LaTeX
8813 on which the cite engine depends.
8816 \begin_layout Standard
8817 The cite engine declaration should then be followed by lines like the following:
8821 \begin_layout Plain Layout
8822 Preferably in English if the module should be published with \SpecialChar LyX
8824 This description will appear in the list of messages to be translated and
8825 will be thus translated with the next interface update.
8833 \begin_layout LyX-Code
8837 \begin_layout LyX-Code
8838 # Biblatex supports many author-year and numerical styles.
8841 \begin_layout LyX-Code
8842 # It is mainly aimed at the Humanities.
8846 \begin_layout LyX-Code
8847 # customizable, fully localized and provides many features
8850 \begin_layout LyX-Code
8851 # that are not possible with BibTeX.
8852 The use of 'biber' as
8855 \begin_layout LyX-Code
8856 # bibliography processor is advised.
8859 \begin_layout LyX-Code
8863 \begin_layout Standard
8864 The description is used in
8865 \begin_inset Flex Noun
8868 \begin_layout Plain Layout
8869 Document\SpecialChar menuseparator
8870 Settings\SpecialChar menuseparator
8876 to provide the user with information about the cite engine.
8879 \begin_layout Subsection
8883 \begin_layout Standard
8884 The first non-comment line of any layout file, included file, or module
8889 contain the file format number:
8892 \begin_layout Description
8893 \begin_inset Flex Code
8896 \begin_layout Plain Layout
8903 \begin_inset Flex Code
8906 \begin_layout Plain Layout
8912 ] The format number of the layout file.
8915 \begin_layout Standard
8916 This tag was introduced with \SpecialChar LyX
8918 \begin_inset space ~
8922 Layout files from older \SpecialChar LyX
8923 versions do not have an explicit file format and
8924 are considered to have
8925 \begin_inset Flex Code
8928 \begin_layout Plain Layout
8930 \begin_inset space ~
8939 The format for the present version of \SpecialChar LyX
8941 But each version of \SpecialChar LyX
8942 is capable of reading earlier versions' layout files,
8943 just as they are capable of reading files produced by earlier versions
8946 There is, however, no provision for converting to earlier formats.
8949 \begin_layout Subsection
8950 \begin_inset CommandInset label
8952 name "subsec:General-text-class"
8956 General text class parameters
8959 \begin_layout Standard
8960 These are general parameters that govern the behavior of an entire document
8966 mean that they must appear in
8967 \begin_inset Flex Code
8970 \begin_layout Plain Layout
8976 files rather than in modules.
8977 A module can contain any layout tag.)
8980 \begin_layout Description
8982 \change_inserted -712698321 1526899478
8983 \begin_inset Flex Code
8986 \begin_layout Plain Layout
8988 \change_inserted -712698321 1526898610
8989 AddToCiteEngine <engine>
8994 Extends the possibilities for displaying citation references.
8996 \begin_inset CommandInset ref
8998 reference "subsec:Citation-engine-description"
9007 \begin_inset Flex Code
9010 \begin_layout Plain Layout
9012 \change_inserted -712698321 1526898823
9023 \begin_layout Description
9024 \begin_inset Flex Code
9027 \begin_layout Plain Layout
9033 Adds information that will be output in the
9034 \begin_inset Flex Code
9037 \begin_layout Plain Layout
9043 block when the document is output to XHTML.
9044 Typically, this would be used to output CSS style information, but it can
9045 be used for anything that can appear in
9046 \begin_inset Flex Code
9049 \begin_layout Plain Layout
9057 \begin_inset Quotes eld
9061 \begin_inset Flex Code
9064 \begin_layout Plain Layout
9071 \begin_inset Quotes erd
9077 \begin_layout Description
9078 \begin_inset Flex Code
9081 \begin_layout Plain Layout
9087 Adds information to the document preamble.
9089 \begin_inset Newline newline
9093 \begin_inset Quotes eld
9097 \begin_inset Flex Code
9100 \begin_layout Plain Layout
9107 \begin_inset Quotes erd
9111 \change_inserted -712698321 1562592950
9115 \begin_layout Description
9117 \change_inserted -712698321 1562593040
9118 \begin_inset Flex Code
9121 \begin_layout Plain Layout
9123 \change_inserted -712698321 1562592954
9130 \begin_inset Flex Code
9133 \begin_layout Plain Layout
9135 \change_inserted -712698321 1562592950
9144 \begin_inset space \thinspace{}
9148 \begin_inset Flex Code
9151 \begin_layout Plain Layout
9153 \change_inserted -712698321 1562592950
9159 ] If the document class adds the bibliography to the table of contents,
9160 add this option with value
9161 \begin_inset Flex Code
9164 \begin_layout Plain Layout
9166 \change_inserted -712698321 1562592996
9175 \begin_inset Flex Code
9178 \begin_layout Plain Layout
9180 \change_inserted -712698321 1562593006
9189 This prevents the bibliography from being added twice.
9194 \begin_layout Description
9195 \begin_inset Flex Code
9198 \begin_layout Plain Layout
9204 Defines the possibilities for displaying citation references.
9206 \begin_inset CommandInset ref
9208 reference "subsec:Citation-engine-description"
9217 \begin_inset Quotes eld
9221 \begin_inset Flex Code
9224 \begin_layout Plain Layout
9231 \begin_inset Quotes erd
9235 Primarily used in cite engine files (see
9236 \begin_inset CommandInset ref
9238 reference "subsec:Cite-Engine-Files"
9247 \change_inserted -712698321 1526898530
9248 Note that if you specify this in a layout file or module, any cite engine
9249 definition will be overridden.
9251 \begin_inset Flex Code
9254 \begin_layout Plain Layout
9256 \change_inserted -712698321 1526898530
9269 \begin_layout Description
9270 \begin_inset Flex Code
9273 \begin_layout Plain Layout
9279 Defines formats for use in the display of bibliographic information.
9281 \begin_inset CommandInset ref
9283 reference "subsec:Citation-format-description"
9289 \begin_inset Quotes eld
9293 \begin_inset Flex Code
9296 \begin_layout Plain Layout
9303 \begin_inset Quotes erd
9307 Primarily used in cite engine files (see
9308 \begin_inset CommandInset ref
9310 reference "subsec:Cite-Engine-Files"
9319 \change_inserted -712698321 1526898585
9320 A cite format defined in a layout or module will override the cite engine
9326 \begin_layout Description
9327 \begin_inset Flex Code
9330 \begin_layout Plain Layout
9337 \begin_inset Flex Code
9340 \begin_layout Plain Layout
9349 \begin_inset Flex Code
9352 \begin_layout Plain Layout
9358 ] Determines whether
9362 or Bib\SpecialChar TeX
9363 is used to generate a Bibliography.
9364 Primarily used in cite engine files (see
9365 \begin_inset CommandInset ref
9367 reference "subsec:Cite-Engine-Files"
9377 \begin_layout Description
9378 \begin_inset Flex Code
9381 \begin_layout Plain Layout
9387 Describes various global options supported by the document class.
9389 \begin_inset CommandInset ref
9391 reference "subsec:ClassOptions"
9397 \begin_inset Quotes eld
9401 \begin_inset Flex Code
9404 \begin_layout Plain Layout
9411 \begin_inset Quotes erd
9417 \begin_layout Description
9418 \begin_inset Flex Code
9421 \begin_layout Plain Layout
9428 \begin_inset Flex Code
9431 \begin_layout Plain Layout
9440 \begin_inset space \thinspace{}
9444 \begin_inset Flex Code
9447 \begin_layout Plain Layout
9453 ] Whether the class should
9457 to having one or two columns.
9458 Can be changed in the
9459 \begin_inset Flex Noun
9462 \begin_layout Plain Layout
9463 Document\SpecialChar menuseparator
9472 \begin_layout Description
9473 \begin_inset Flex Code
9476 \begin_layout Plain Layout
9483 \begin_inset Flex Code
9486 \begin_layout Plain Layout
9492 ] This sequence defines the properties for a counter.
9493 If the counter does not yet exist, it is created; if it does exist, it
9496 \begin_inset Quotes eld
9500 \begin_inset Flex Code
9503 \begin_layout Plain Layout
9510 \begin_inset Quotes erd
9514 \begin_inset Newline newline
9518 \begin_inset CommandInset ref
9520 reference "subsec:Counters"
9524 for details on counters.
9527 \begin_layout Description
9528 \begin_inset Flex Code
9531 \begin_layout Plain Layout
9537 Sets the default font used to display the document.
9539 \begin_inset CommandInset ref
9541 reference "subsec:Font-description"
9545 for how to declare fonts.
9547 \begin_inset Quotes eld
9551 \begin_inset Flex Code
9554 \begin_layout Plain Layout
9561 \begin_inset Quotes erd
9567 \begin_layout Description
9568 \begin_inset Flex Code
9571 \begin_layout Plain Layout
9578 \begin_inset Flex Code
9581 \begin_layout Plain Layout
9587 ] Specifies a module to be included by default with this document class.
9588 The module is specified as filename without the
9589 \begin_inset Flex Code
9592 \begin_layout Plain Layout
9599 The user can still remove the module, but it will be active at the outset.
9600 (This applies only when new files are created, or when this class is chosen
9601 for an existing document.)
9604 \begin_layout Description
9605 \begin_inset Flex Code
9608 \begin_layout Plain Layout
9615 \begin_inset Flex Code
9618 \begin_layout Plain Layout
9624 ] This is the style that will be assigned to new paragraphs, usually
9625 \begin_inset Flex Noun
9628 \begin_layout Plain Layout
9635 This will default to the first defined style if not given, but you are
9636 encouraged to use this directive.
9639 \begin_layout Description
9640 \begin_inset Flex Code
9643 \begin_layout Plain Layout
9650 \begin_inset Flex Code
9653 \begin_layout Plain Layout
9659 ] This tag indicates that the module (which is specified by filename without
9661 \begin_inset Flex Code
9664 \begin_layout Plain Layout
9670 extension) cannot be used with this document class.
9671 This might be used in a journal-specific layout file to prevent, say, the
9673 \begin_inset Flex Code
9676 \begin_layout Plain Layout
9682 module that numbers theorems by section.
9687 be used in a module.
9688 Modules have their own way of excluding other modules (see
9689 \begin_inset CommandInset ref
9691 reference "subsec:Layout-modules"
9698 \begin_layout Description
9699 \begin_inset Flex Code
9702 \begin_layout Plain Layout
9708 Defines a new float.
9710 \begin_inset CommandInset ref
9712 reference "subsec:Floats"
9718 \begin_inset Quotes eld
9722 \begin_inset Flex Code
9725 \begin_layout Plain Layout
9732 \begin_inset Quotes erd
9738 \begin_layout Description
9739 \begin_inset Flex Code
9742 \begin_layout Plain Layout
9748 Sets the information that will be output in the
9749 \begin_inset Flex Code
9752 \begin_layout Plain Layout
9758 block when this document class is output to XHTML.
9759 Note that this will completely override any prior
9760 \begin_inset Flex Code
9763 \begin_layout Plain Layout
9770 \begin_inset Flex Code
9773 \begin_layout Plain Layout
9781 \begin_inset Newline newline
9785 \begin_inset Flex Code
9788 \begin_layout Plain Layout
9794 if you just want to add material to the preamble.) Must end with
9795 \begin_inset Quotes eld
9799 \begin_inset Flex Code
9802 \begin_layout Plain Layout
9809 \begin_inset Quotes erd
9815 \begin_layout Description
9816 \begin_inset Flex Code
9819 \begin_layout Plain Layout
9826 \begin_inset Flex Code
9829 \begin_layout Plain Layout
9835 ] The style to use for the table of contents, bibliography, and so forth,
9836 when the document is output to HTML.
9837 For articles, this should normally be
9838 \begin_inset Flex Code
9841 \begin_layout Plain Layout
9848 \begin_inset Flex Code
9851 \begin_layout Plain Layout
9858 If it is not given, then \SpecialChar LyX
9859 will attempt to figure out which layout to use.
9862 \begin_layout Description
9863 \begin_inset Flex Code
9866 \begin_layout Plain Layout
9873 \begin_inset Flex Code
9876 \begin_layout Plain Layout
9882 ] Modifies the properties of the given counter.
9883 If the counter does not exist, the statement is ignored.
9885 \begin_inset Quotes eld
9889 \begin_inset Flex Code
9892 \begin_layout Plain Layout
9899 \begin_inset Quotes erd
9903 \begin_inset Newline newline
9907 \begin_inset CommandInset ref
9909 reference "subsec:Counters"
9913 for details on counters.
9916 \begin_layout Description
9917 \begin_inset Flex Code
9920 \begin_layout Plain Layout
9927 \begin_inset Flex Code
9930 \begin_layout Plain Layout
9936 ] This allows you to include another layout definition file within yours
9937 to avoid duplicating commands.
9938 Common examples are the standard layout files, for example,
9939 \begin_inset Flex Code
9942 \begin_layout Plain Layout
9948 , which contains most of the basic layouts.
9951 \begin_layout Description
9952 \begin_inset Flex Code
9955 \begin_layout Plain Layout
9962 \begin_inset Flex Code
9965 \begin_layout Plain Layout
9971 ] This section (re-)defines the layout of an inset.
9972 It can be applied to an existing inset or to a new, user-defined inset,
9973 e.g., a new character style.
9975 \begin_inset Quotes eld
9979 \begin_inset Flex Code
9982 \begin_layout Plain Layout
9989 \begin_inset Quotes erd
9993 \begin_inset Newline newline
9997 \begin_inset CommandInset ref
9999 reference "subsec:Flex-insets-and"
10003 for more information.
10007 \begin_layout Description
10008 \begin_inset Flex Code
10011 \begin_layout Plain Layout
10018 \begin_inset Flex Code
10021 \begin_layout Plain Layout
10027 ] A string that indicates the width of the left margin on the screen, for
10029 \begin_inset Quotes eld
10033 \begin_inset Flex Code
10036 \begin_layout Plain Layout
10043 \begin_inset Quotes erd
10047 (Note that this is not a `length', like
10048 \begin_inset Quotes eld
10052 \begin_inset Quotes erd
10058 \begin_layout Description
10059 \begin_inset Flex Code
10062 \begin_layout Plain Layout
10069 \begin_inset Flex Code
10072 \begin_layout Plain Layout
10078 ] An integer that determines the maximal number of names displayed in an
10079 author-year citation before the citation switches to
10080 \begin_inset Quotes eld
10084 \begin_inset Quotes erd
10088 Primarily used in cite engine files (see
10089 \begin_inset CommandInset ref
10091 reference "subsec:Cite-Engine-Files"
10101 \begin_layout Description
10102 \begin_inset Flex Code
10105 \begin_layout Plain Layout
10112 \begin_inset Flex Code
10115 \begin_layout Plain Layout
10121 ] Modifies the properties of the given paragraph style.
10122 If the style does not exist, this section is ignored.
10124 \begin_inset Quotes eld
10128 \begin_inset Flex Code
10131 \begin_layout Plain Layout
10138 \begin_inset Quotes erd
10144 \begin_layout Description
10145 \begin_inset Flex Code
10148 \begin_layout Plain Layout
10155 \begin_inset Flex Code
10158 \begin_layout Plain Layout
10164 ] Deletes an existing counter, usually one defined in an included file.
10167 \begin_layout Description
10168 \begin_inset Flex Code
10171 \begin_layout Plain Layout
10178 \begin_inset Flex Code
10181 \begin_layout Plain Layout
10187 ] Deletes an existing float.
10188 This is particularly useful when you want to suppress a float that has
10189 been defined in an input file.
10192 \begin_layout Description
10193 \begin_inset Flex Code
10196 \begin_layout Plain Layout
10203 \begin_inset Flex Code
10206 \begin_layout Plain Layout
10212 ] Deletes an existing style.
10215 \begin_layout Description
10216 \begin_inset Flex Code
10219 \begin_layout Plain Layout
10226 \begin_inset Flex Code
10229 \begin_layout Plain Layout
10236 \begin_inset Flex Code
10239 \begin_layout Plain Layout
10245 ] Define a new table of contents with type
10246 \begin_inset Flex Code
10249 \begin_layout Plain Layout
10256 \begin_inset Flex Code
10259 \begin_layout Plain Layout
10266 See also the AddToToc commands.
10269 \begin_layout Description
10270 \begin_inset Flex Code
10273 \begin_layout Plain Layout
10280 \begin_inset Flex Code
10283 \begin_layout Plain Layout
10289 ] The file format (as defined in the \SpecialChar LyX
10290 preferences) produced by this document
10292 It is mainly useful when
10293 \begin_inset Flex Code
10296 \begin_layout Plain Layout
10303 \begin_inset Flex Code
10306 \begin_layout Plain Layout
10312 and one wants to define a new type of literate document.
10313 The format is reset to
10314 \begin_inset Quotes eld
10318 \begin_inset Flex Code
10321 \begin_layout Plain Layout
10328 \begin_inset Quotes erd
10332 \begin_inset Quotes eld
10336 \begin_inset Flex Code
10339 \begin_layout Plain Layout
10346 \begin_inset Quotes erd
10349 when the corresponding
10350 \begin_inset Flex Code
10353 \begin_layout Plain Layout
10359 parameter is encountered.
10362 \begin_layout Description
10363 \begin_inset Flex Code
10366 \begin_layout Plain Layout
10373 \begin_inset Flex Code
10376 \begin_layout Plain Layout
10387 \begin_inset Flex Code
10390 \begin_layout Plain Layout
10397 \begin_inset Flex Code
10400 \begin_layout Plain Layout
10406 ] Specifies what sort of output documents using this class will produce.
10409 \begin_layout Description
10410 \begin_inset Flex Code
10413 \begin_layout Plain Layout
10420 \begin_inset Flex Code
10423 \begin_layout Plain Layout
10430 \begin_inset Flex Code
10433 \begin_layout Plain Layout
10439 ] Specifies options, given in the second string, for the package named by
10442 \begin_inset Quotes eld
10446 \begin_inset Flex Code
10449 \begin_layout Plain Layout
10450 PackageOptions natbib square
10456 \begin_inset Quotes erd
10460 \begin_inset Flex Code
10463 \begin_layout Plain Layout
10469 to be loaded with the
10470 \begin_inset Flex Code
10473 \begin_layout Plain Layout
10480 (For \SpecialChar TeX
10481 perts, this causes \SpecialChar LyX
10483 \begin_inset Flex Code
10486 \begin_layout Plain Layout
10489 PassOptionsToPackage{natbib}{square}
10495 \begin_inset Flex Code
10498 \begin_layout Plain Layout
10505 \change_inserted -712698321 1565102364
10509 \begin_layout Description
10511 \change_inserted -712698321 1565102470
10512 \begin_inset Flex Code
10515 \begin_layout Plain Layout
10517 \change_inserted -712698321 1565102365
10524 \begin_inset Flex Code
10527 \begin_layout Plain Layout
10529 \change_inserted -712698321 1565105222
10534 , letterpaper, legalpaper, executivepaper, a0paper, a1paper, a2paper, a3paper,
10535 a4paper, a5paper, a6paper, b0paper, b1paper, b2paper, b3paper, b4paper,
10536 b5paper, b6paper, c0paper, c1paper, c2paper, c3paper, c4paper, c5paper,
10537 c6paper, b0j, b1j, b2j, b3j, b4j, b5j, b6j
10542 ] The default page size.
10543 This is used by some converters.
10548 \begin_layout Description
10549 \begin_inset Flex Code
10552 \begin_layout Plain Layout
10559 \begin_inset Flex Code
10562 \begin_layout Plain Layout
10571 \begin_inset Flex Code
10574 \begin_layout Plain Layout
10581 \begin_inset Flex Code
10584 \begin_layout Plain Layout
10590 ] The default pagestyle.
10591 Can be changed in the
10592 \begin_inset Flex Noun
10595 \begin_layout Plain Layout
10596 Document\SpecialChar menuseparator
10605 \begin_layout Description
10606 \begin_inset Flex Code
10609 \begin_layout Plain Layout
10615 Sets the preamble for the \SpecialChar LaTeX
10617 Note that this will completely override any prior
10618 \begin_inset Flex Code
10621 \begin_layout Plain Layout
10628 \begin_inset Flex Code
10631 \begin_layout Plain Layout
10639 \begin_inset Flex Code
10642 \begin_layout Plain Layout
10648 if you just want to add material to the preamble.) Must end with
10649 \begin_inset Quotes eld
10653 \begin_inset Flex Code
10656 \begin_layout Plain Layout
10663 \begin_inset Quotes erd
10669 \begin_layout Description
10670 \begin_inset Flex Code
10673 \begin_layout Plain Layout
10680 \begin_inset Flex Code
10683 \begin_layout Plain Layout
10690 \begin_inset Flex Code
10693 \begin_layout Plain Layout
10702 \begin_inset space \thinspace{}
10706 \begin_inset Flex Code
10709 \begin_layout Plain Layout
10715 ] Whether the class already provides the feature
10716 \begin_inset Flex Code
10719 \begin_layout Plain Layout
10726 A feature is in general the name of a package (e.
10727 \begin_inset space \thinspace{}
10731 \begin_inset space \space{}
10735 \begin_inset Flex Code
10738 \begin_layout Plain Layout
10745 \begin_inset Flex Code
10748 \begin_layout Plain Layout
10755 \begin_inset space \thinspace{}
10759 \begin_inset space \space{}
10763 \begin_inset Flex Code
10766 \begin_layout Plain Layout
10773 \begin_inset Flex Code
10776 \begin_layout Plain Layout
10784 \begin_inset CommandInset ref
10786 reference "chap:List-of-functions"
10790 for the list of features.
10793 \begin_layout Description
10794 \begin_inset Flex Code
10797 \begin_layout Plain Layout
10804 \begin_inset Flex Code
10807 \begin_layout Plain Layout
10813 ] Indicates that this layout provides the functionality of the module mentioned,
10814 which should be specified by the filename without the
10815 \begin_inset Flex Code
10818 \begin_layout Plain Layout
10825 This will typically be used if the layout includes the module directly,
10826 rather than using the
10827 \begin_inset Flex Code
10830 \begin_layout Plain Layout
10836 tag to indicate that it ought to be used.
10837 It could also be used in a module that provided an alternate implementation
10838 of the same functionality.
10841 \begin_layout Description
10842 \begin_inset Flex Code
10845 \begin_layout Plain Layout
10852 \begin_inset Flex Code
10855 \begin_layout Plain Layout
10861 ] Creates a new paragraph style if it does not already exist.
10862 If the style does exist, this section is ignored.
10864 \begin_inset Quotes eld
10868 \begin_inset Flex Code
10871 \begin_layout Plain Layout
10878 \begin_inset Quotes erd
10884 \begin_layout Description
10885 \begin_inset Flex Code
10888 \begin_layout Plain Layout
10895 \begin_inset Flex Code
10898 \begin_layout Plain Layout
10904 ] Whether the class requires the feature
10905 \begin_inset Flex Code
10908 \begin_layout Plain Layout
10915 Multiple features must be separated by commas.
10916 Note that you can only request supported features.
10918 \begin_inset CommandInset ref
10920 reference "chap:List-of-functions"
10924 for the list of features.).
10925 If you require a package with specific options, you can additionally use
10927 \begin_inset Flex Code
10930 \begin_layout Plain Layout
10939 \begin_layout Description
10940 \begin_inset Flex Code
10943 \begin_layout Plain Layout
10950 \begin_inset Flex Code
10953 \begin_layout Plain Layout
10959 ] A string that indicates the width of the right margin on the screen, for
10961 \begin_inset Quotes eld
10965 \begin_inset Flex Code
10968 \begin_layout Plain Layout
10975 \begin_inset Quotes erd
10981 \begin_layout Description
10982 \begin_inset Flex Code
10985 \begin_layout Plain Layout
10992 \begin_inset Flex Code
10995 \begin_layout Plain Layout
11001 ] Sets which divisions get numbered.
11003 \begin_inset Newline newline
11007 \begin_inset Flex Code
11010 \begin_layout Plain Layout
11016 counter in \SpecialChar LaTeX
11020 \begin_layout Description
11021 \begin_inset Flex Code
11024 \begin_layout Plain Layout
11031 \begin_inset Flex Code
11034 \begin_layout Plain Layout
11043 \begin_inset space \thinspace{}
11047 \begin_inset Flex Code
11050 \begin_layout Plain Layout
11056 ] Whether the class-default should be printing on one or both sides of the
11058 Can be changed in the
11059 \begin_inset Flex Noun
11062 \begin_layout Plain Layout
11063 Document\SpecialChar menuseparator
11072 \begin_layout Description
11073 \begin_inset Flex Code
11076 \begin_layout Plain Layout
11083 \begin_inset Flex Code
11086 \begin_layout Plain Layout
11092 ] This sequence defines a paragraph style.
11093 If the style does not yet exist, it is created; if it does exist, its parameter
11096 \begin_inset Quotes eld
11100 \begin_inset Flex Code
11103 \begin_layout Plain Layout
11110 \begin_inset Quotes erd
11114 \begin_inset Newline newline
11118 \begin_inset CommandInset ref
11120 reference "subsec:Paragraph-Styles"
11124 for details on paragraph styles.
11125 \change_inserted -712698321 1553617804
11129 \begin_layout Description
11131 \change_inserted -712698321 1553617862
11132 \begin_inset Flex Code
11135 \begin_layout Plain Layout
11137 \change_inserted -712698321 1553617809
11144 \begin_inset Flex Code
11147 \begin_layout Plain Layout
11149 \change_inserted -712698321 1553617805
11155 ] defines the default table style that is used when inserting a table.
11156 The following styles are available:
11160 \begin_layout Itemize
11162 \change_inserted -712698321 1554308039
11163 \begin_inset Flex Code
11166 \begin_layout Plain Layout
11168 \change_inserted -712698321 1554307928
11169 Formal_with_Footline
11177 \begin_inset Quotes eld
11181 \begin_inset Quotes erd
11184 ) style with horizontal lines only, using a bold top and bottom line, the
11185 first and last row are additionally separated from the table body with
11186 a thin middle line.
11189 \begin_layout Itemize
11191 \change_inserted -712698321 1554308087
11192 \begin_inset Flex Code
11195 \begin_layout Plain Layout
11197 \change_inserted -712698321 1554308042
11198 Formal_without_Footline
11203 : same as the above, but the last row is not separated with a middle line
11207 \begin_layout Itemize
11209 \change_inserted -712698321 1553618031
11210 \begin_inset Flex Code
11213 \begin_layout Plain Layout
11215 \change_inserted -712698321 1553618006
11221 : Simple table lines.
11224 \begin_layout Itemize
11226 \change_inserted -712698321 1553618309
11227 \begin_inset Flex Code
11230 \begin_layout Plain Layout
11232 \change_inserted -712698321 1553618031
11239 \begin_inset Flex Code
11242 \begin_layout Plain Layout
11244 \change_inserted -712698321 1553618043
11250 , but with the header column offset with a second horizontal line.
11251 This is also the default style of \SpecialChar LyX
11255 \begin_layout Itemize
11257 \change_inserted -712698321 1553618280
11258 \begin_inset Flex Code
11261 \begin_layout Plain Layout
11263 \change_inserted -712698321 1553618261
11269 : Table without lines.
11275 \begin_layout Description
11276 \begin_inset Flex Code
11279 \begin_layout Plain Layout
11286 \begin_inset Flex Code
11289 \begin_layout Plain Layout
11295 ] The name of the command or environment to be used with
11296 \begin_inset Flex Code
11299 \begin_layout Plain Layout
11308 \begin_layout Description
11309 \begin_inset Flex Code
11312 \begin_layout Plain Layout
11319 \begin_inset Flex Code
11322 \begin_layout Plain Layout
11331 \begin_inset Flex Code
11334 \begin_layout Plain Layout
11340 ] Indicates what kind of markup is used to define the title of a document.
11342 \begin_inset Flex Code
11345 \begin_layout Plain Layout
11351 means that the macro with name
11352 \begin_inset Flex Code
11355 \begin_layout Plain Layout
11361 will be inserted after the last layout which has
11362 \begin_inset Quotes eld
11366 \begin_inset Flex Code
11369 \begin_layout Plain Layout
11371 \begin_inset space ~
11380 \begin_inset Quotes erd
11385 \begin_inset Flex Code
11388 \begin_layout Plain Layout
11394 corresponds to the case where all layouts which have
11395 \begin_inset Quotes eld
11399 \begin_inset Flex Code
11402 \begin_layout Plain Layout
11404 \begin_inset space ~
11413 \begin_inset Quotes erd
11416 should be enclosed into the
11417 \begin_inset Flex Code
11420 \begin_layout Plain Layout
11429 \begin_layout Description
11430 \begin_inset Flex Code
11433 \begin_layout Plain Layout
11440 \begin_inset Flex Code
11443 \begin_layout Plain Layout
11449 ] Sets which divisions are included in the table of contents.
11451 \begin_inset Flex Code
11454 \begin_layout Plain Layout
11460 counter in \SpecialChar LaTeX
11464 \begin_layout Subsection
11465 \begin_inset Flex Code
11468 \begin_layout Plain Layout
11475 \begin_inset CommandInset label
11477 name "subsec:ClassOptions"
11484 \begin_layout Standard
11486 \begin_inset Flex Code
11489 \begin_layout Plain Layout
11495 section can contain the following entries:
11498 \begin_layout Description
11499 \begin_inset Flex Code
11502 \begin_layout Plain Layout
11509 \begin_inset Flex Code
11512 \begin_layout Plain Layout
11518 ] The list of available font sizes for the document's main font, separated
11520 \begin_inset Quotes eld
11524 \begin_inset Flex Code
11527 \begin_layout Plain Layout
11534 \begin_inset Quotes erd
11539 \change_inserted -712698321 1565110196
11540 Any number is possible.
11543 \begin_layout Description
11545 \change_inserted -712698321 1565110259
11546 \begin_inset Flex Code
11549 \begin_layout Plain Layout
11551 \change_inserted -712698321 1565110199
11558 \begin_inset Flex Code
11561 \begin_layout Plain Layout
11563 \change_inserted -712698321 1565110196
11569 ] The format for the font size option.
11571 \begin_inset Flex Code
11574 \begin_layout Plain Layout
11576 \change_inserted -712698321 1565110238
11586 \begin_inset Flex Code
11589 \begin_layout Plain Layout
11591 \change_inserted -712698321 1565110248
11597 is a placeholder for the font size.
11602 \begin_layout Description
11603 \begin_inset Flex Code
11606 \begin_layout Plain Layout
11612 Used to set the DTD line with XML-based output classes.
11614 \begin_inset space \thinspace{}
11618 \begin_inset Quotes eld
11621 -//OASIS//DTD DocBook V4.2//EN
11622 \begin_inset Quotes erd
11626 \change_inserted -712698321 1565101761
11630 \begin_layout Description
11632 \change_inserted -712698321 1565105413
11633 \begin_inset Flex Code
11636 \begin_layout Plain Layout
11638 \change_inserted -712698321 1565101918
11645 \begin_inset Flex Code
11648 \begin_layout Plain Layout
11650 \change_inserted -712698321 1565105399
11651 string="letterpaper|\SpecialChar allowbreak
11652 legalpaper|\SpecialChar allowbreak
11653 executivepaper|\SpecialChar allowbreak
11654 a0paper|\SpecialChar allowbreak
11655 a1paper|\SpecialChar allowbreak
11656 a2paper|\SpecialChar allowbreak
11657 a3paper|\SpecialChar allowbreak
11659 paper|\SpecialChar allowbreak
11660 a5paper|\SpecialChar allowbreak
11661 a6paper|\SpecialChar allowbreak
11662 b0paper|\SpecialChar allowbreak
11663 b1paper|\SpecialChar allowbreak
11664 b2paper|\SpecialChar allowbreak
11665 b3paper|\SpecialChar allowbreak
11666 b4paper|\SpecialChar allowbreak
11667 b5paper|\SpecialChar allowbreak
11668 b6paper|\SpecialChar allowbreak
11670 paper|\SpecialChar allowbreak
11671 c1paper|\SpecialChar allowbreak
11672 c2paper|\SpecialChar allowbreak
11673 c3paper|\SpecialChar allowbreak
11674 c4paper|\SpecialChar allowbreak
11675 c5paper|\SpecialChar allowbreak
11676 c6paper|\SpecialChar allowbreak
11677 b0j|\SpecialChar allowbreak
11678 b1j|\SpecialChar allowbreak
11679 b2j|\SpecialChar allowbreak
11680 b3j|\SpecialChar allowbreak
11681 b4j|\SpecialChar allowbreak
11682 b5j|\SpecialChar allowbreak
11689 ] The list of available page sizes, separated by
11690 \begin_inset Quotes eld
11694 \begin_inset Flex Code
11697 \begin_layout Plain Layout
11699 \change_inserted -712698321 1565101779
11706 \begin_inset Quotes erd
11710 Currently, only the listed sizes are supported.
11711 Other sizes might be entered as custom class option.
11716 \begin_layout Description
11717 \begin_inset Flex Code
11720 \begin_layout Plain Layout
11727 \begin_inset Flex Code
11730 \begin_layout Plain Layout
11731 string="empty|plain|headings|fancy"
11736 ] The list of available page sty\SpecialChar softhyphen
11738 \begin_inset Quotes eld
11742 \begin_inset Flex Code
11745 \begin_layout Plain Layout
11752 \begin_inset Quotes erd
11758 \begin_layout Description
11759 \begin_inset Flex Code
11762 \begin_layout Plain Layout
11769 \begin_inset Flex Code
11772 \begin_layout Plain Layout
11778 ] Some document class options, separated by a comma, that will be added
11779 to the optional part of the
11780 \begin_inset Flex Code
11783 \begin_layout Plain Layout
11794 \begin_layout Standard
11796 \begin_inset Flex Code
11799 \begin_layout Plain Layout
11805 section must end with
11806 \begin_inset Quotes eld
11810 \begin_inset Flex Code
11813 \begin_layout Plain Layout
11820 \begin_inset Quotes erd
11826 \begin_layout Subsection
11828 \begin_inset CommandInset label
11830 name "subsec:Paragraph-Styles"
11837 \begin_layout Standard
11838 A paragraph style description looks like this:
11842 \begin_layout Plain Layout
11843 Note that this will either define a new style or modify an existing one.
11851 \begin_layout LyX-Code
11858 \begin_layout LyX-Code
11862 \begin_layout LyX-Code
11866 \begin_layout Standard
11867 where the following commands are allowed:
11870 \begin_layout Description
11871 \begin_inset Flex Code
11874 \begin_layout Plain Layout
11881 \begin_inset Flex Code
11884 \begin_layout Plain Layout
11890 =""] This paragraph will appear in the table of contents of the given type.
11891 An empty string disables.
11892 See also the OutlinerName and the IsTocCaption commands.
11896 \begin_layout Description
11897 \begin_inset Flex Code
11900 \begin_layout Plain Layout
11907 \begin_inset Flex Code
11910 \begin_layout Plain Layout
11915 , left, right, center
11920 ] Paragraph alignment.
11923 \begin_layout Description
11924 \begin_inset Flex Code
11927 \begin_layout Plain Layout
11934 \begin_inset Flex Code
11937 \begin_layout Plain Layout
11942 , left, right, center
11947 ] A comma separated list of permitted alignments.
11948 (Some \SpecialChar LaTeX
11949 styles prohibit certain alignments, since those wouldn't make sense.
11950 For example a right-aligned or centered enumeration isn't possible.)
11953 \begin_layout Description
11954 \begin_inset Flex Code
11957 \begin_layout Plain Layout
11964 \begin_inset Flex Code
11967 \begin_layout Plain Layout
11973 ] Defines argument number <int> of a command\SpecialChar breakableslash
11974 environment associated with
11976 This is useful for things like section headings, and only makes sense with
11979 Every (optional or required) argument of a command or environment – except
11980 for the required argument that is associated with the content of the paragraph
11981 itself – has a separate definition, where the number specifies the order
11983 The definition must end with
11984 \begin_inset Flex Code
11987 \begin_layout Plain Layout
11994 So a command with two optional arguments has:
11998 \begin_layout Quote
12004 \begin_layout Quote
12010 \begin_layout Quote
12016 \begin_layout Quote
12022 \begin_layout Quote
12028 \begin_layout Quote
12034 \begin_layout Standard
12036 \begin_inset Flex Code
12039 \begin_layout Plain Layout
12045 definition, the following specifications are possible:
12048 \begin_layout Itemize
12049 \begin_inset Flex Code
12052 \begin_layout Plain Layout
12059 \begin_inset Flex Code
12062 \begin_layout Plain Layout
12068 The string that will appear both in the menu (to insert this argument)
12069 and on the argument inset button (unless you also specify a separate
12070 \begin_inset Flex Code
12073 \begin_layout Plain Layout
12080 For the menu, you can define an accelerator by appending the respective
12081 character to the string, divided by
12082 \begin_inset Quotes eld
12086 \begin_inset Quotes erd
12090 \begin_inset space \thinspace{}
12094 \begin_inset space \space{}
12098 \begin_inset Quotes eld
12102 \begin_inset Flex Code
12105 \begin_layout Plain Layout
12112 \begin_inset Quotes erd
12118 \begin_layout Itemize
12119 \begin_inset Flex Code
12122 \begin_layout Plain Layout
12129 \begin_inset Flex Code
12132 \begin_layout Plain Layout
12138 A separate string for the menu.
12139 You can define an accelerator by appending the respective character to
12140 the string, divided by
12141 \begin_inset Quotes eld
12145 \begin_inset Quotes erd
12149 \begin_inset space \thinspace{}
12153 \begin_inset space \space{}
12157 \begin_inset Quotes eld
12161 \begin_inset Flex Code
12164 \begin_layout Plain Layout
12171 \begin_inset Quotes erd
12175 This specification is optional.
12176 If it is not given the
12177 \begin_inset Flex Code
12180 \begin_layout Plain Layout
12186 will be used instead for the menu.
12189 \begin_layout Itemize
12190 \begin_inset Flex Code
12193 \begin_layout Plain Layout
12200 \begin_inset Flex Code
12203 \begin_layout Plain Layout
12209 A longer explanatory text that appears in the tooltip when hovering over
12210 the argument inset.
12213 \begin_layout Itemize
12214 \begin_inset Flex Code
12217 \begin_layout Plain Layout
12224 \begin_inset Flex Code
12227 \begin_layout Plain Layout
12236 \begin_inset space \thinspace{}
12240 \begin_inset Flex Code
12243 \begin_layout Plain Layout
12249 ] Declare if this is a mandatory (1) or an optional (0) argument.
12250 Mandatory arguments will be output empty if not given, while optional arguments
12251 will not be output at all.
12252 By default, mandatory arguments are delimited by
12253 \begin_inset Flex Code
12256 \begin_layout Plain Layout
12262 , while optional arguments are delimited by
12263 \begin_inset Flex Code
12266 \begin_layout Plain Layout
12273 \change_inserted -712698321 1555579782
12277 \begin_layout Itemize
12279 \change_inserted -712698321 1555579780
12280 \begin_inset Flex Code
12283 \begin_layout Plain Layout
12285 \change_inserted -712698321 1555579780
12292 \begin_inset Flex Code
12295 \begin_layout Plain Layout
12297 \change_inserted -712698321 1555579780
12303 Option to define a different command (from the default
12304 \begin_inset Flex Code
12307 \begin_layout Plain Layout
12309 \change_inserted -712698321 1555579780
12319 ) to be used for line breaks.
12320 The initial backslash must not be specified.
12325 \begin_layout Itemize
12326 \begin_inset Flex Code
12329 \begin_layout Plain Layout
12336 \begin_inset Flex Code
12339 \begin_layout Plain Layout
12345 defines another argument (by its number) which this argument requires to
12346 be output if it is itself output.
12348 \begin_inset space \thinspace{}
12351 g., in \SpecialChar LaTeX
12352 commands, optional arguments often require previous optional arguments
12353 to be output (at least empty), as in
12354 \begin_inset Flex Code
12357 \begin_layout Plain Layout
12360 command[][argument]{text}
12366 This can be achieved by the statement
12367 \begin_inset Flex Code
12370 \begin_layout Plain Layout
12377 \begin_inset Flex Code
12380 \begin_layout Plain Layout
12389 \begin_layout Itemize
12390 \begin_inset Flex Code
12393 \begin_layout Plain Layout
12400 \begin_inset Flex Code
12403 \begin_layout Plain Layout
12409 defines a custom left delimiter (instead of
12410 \begin_inset Flex Code
12413 \begin_layout Plain Layout
12420 \begin_inset Flex Code
12423 \begin_layout Plain Layout
12430 A line break in the output can be indicated by
12431 \begin_inset Flex Code
12434 \begin_layout Plain Layout
12443 \begin_layout Itemize
12444 \begin_inset Flex Code
12447 \begin_layout Plain Layout
12454 \begin_inset Flex Code
12457 \begin_layout Plain Layout
12463 defines a custom right delimiter (instead of
12464 \begin_inset Flex Code
12467 \begin_layout Plain Layout
12474 \begin_inset Flex Code
12477 \begin_layout Plain Layout
12484 A line break in the output can be indicated by
12485 \begin_inset Flex Code
12488 \begin_layout Plain Layout
12497 \begin_layout Itemize
12498 \begin_inset Flex Code
12501 \begin_layout Plain Layout
12508 \begin_inset Flex Code
12511 \begin_layout Plain Layout
12517 defines an argument that is inserted if and only if no user-specified arguments
12519 \begin_inset space \thinspace{}
12523 \begin_inset space \space{}
12526 if no argument inset has been inserted (note that also an empty argument
12527 inset omits the DefaultArg).
12528 Multiple arguments need to be separated by comma.
12531 \begin_layout Itemize
12532 \begin_inset Flex Code
12535 \begin_layout Plain Layout
12542 \begin_inset Flex Code
12545 \begin_layout Plain Layout
12551 defines an argument that is inserted in any case (alone or in addition
12552 to user-specified arguments).
12553 Multiple arguments need to be separated by comma.
12556 \begin_layout Itemize
12557 \begin_inset Flex Code
12560 \begin_layout Plain Layout
12566 The font used for the argument content, see
12567 \begin_inset CommandInset ref
12569 reference "subsec:Font-description"
12574 \change_inserted -712698321 1559484228
12578 \begin_layout Itemize
12580 \change_inserted -712698321 1559484228
12581 \begin_inset Flex Code
12584 \begin_layout Plain Layout
12586 \change_inserted -712698321 1559484228
12593 \begin_inset Flex Code
12596 \begin_layout Plain Layout
12598 \change_inserted -712698321 1559484228
12607 \begin_inset space \thinspace{}
12611 \begin_inset Flex Code
12614 \begin_layout Plain Layout
12616 \change_inserted -712698321 1559484228
12622 ] As with paragraph styles, see
12623 \begin_inset CommandInset ref
12625 reference "subsec:Paragraph-Styles"
12634 \begin_layout Itemize
12635 \begin_inset Flex Code
12638 \begin_layout Plain Layout
12644 The font used for the label; see
12645 \begin_inset CommandInset ref
12647 reference "subsec:Font-description"
12654 \begin_layout Itemize
12655 \begin_inset Flex Code
12658 \begin_layout Plain Layout
12665 \begin_inset Flex Code
12668 \begin_layout Plain Layout
12673 , Minimalistic, Conglomerate
12678 ] describes the rendering style used for the inset's frame and buttons.
12681 \begin_layout Itemize
12682 \begin_inset Flex Code
12685 \begin_layout Plain Layout
12692 \begin_inset Flex Code
12695 \begin_layout Plain Layout
12702 \begin_inset Flex Code
12705 \begin_layout Plain Layout
12711 , this argument is automatically inserted when the respective style is selected.
12713 \change_deleted -712698321 1559484200
12714 Currently, only one argument per style\SpecialChar breakableslash
12715 layout can be automatically inserted.
12720 \begin_layout Itemize
12722 \change_inserted -712698321 1559491402
12723 \begin_inset Flex Code
12726 \begin_layout Plain Layout
12728 \change_inserted -712698321 1559490711
12735 \begin_inset Flex Code
12738 \begin_layout Plain Layout
12740 \change_inserted -712698321 1559490703
12747 \begin_inset Flex Code
12750 \begin_layout Plain Layout
12752 \change_inserted -712698321 1559490703
12758 , this argument will be inserted on a new line with
12759 \begin_inset Flex Code
12762 \begin_layout Plain Layout
12764 \change_inserted -712698321 1559491402
12770 (only available within Flex insets).
12773 \begin_layout Itemize
12774 \begin_inset Flex Code
12777 \begin_layout Plain Layout
12784 \begin_inset Flex Code
12787 \begin_layout Plain Layout
12794 \begin_inset Flex Code
12797 \begin_layout Plain Layout
12803 , this argument will be inserted with a copy of the co-text (either selected
12804 text or the whole paragraph) as content.
12807 \begin_layout Itemize
12808 \begin_inset Flex Code
12811 \begin_layout Plain Layout
12818 \begin_inset Flex Code
12821 \begin_layout Plain Layout
12831 ] Whether the contents of this argument should be output in raw form, meaning
12832 without special translations that \SpecialChar LaTeX
12835 \begin_inset Flex Code
12838 \begin_layout Plain Layout
12844 status is inherited by the inset or paragraph layout the argument belongs
12845 to, true and false change the status for the given argument only.
12848 \begin_layout Itemize
12849 \begin_inset Flex Code
12852 \begin_layout Plain Layout
12859 \begin_inset Flex Code
12862 \begin_layout Plain Layout
12863 string of characters
12872 Defines individual characters
12873 \begin_inset Newline linebreak
12876 that should be output in raw form, meaning without special translations
12877 that \SpecialChar LaTeX
12879 Note that, contrary to PassThru, this needs to be explicitly defined for
12881 That is, arguments do not inherit PassThruChars from their parent inset
12885 \begin_layout Itemize
12886 \begin_inset Flex Code
12889 \begin_layout Plain Layout
12896 \begin_inset Flex Code
12899 \begin_layout Plain Layout
12908 \begin_inset space \thinspace{}
12912 \begin_inset Flex Code
12915 \begin_layout Plain Layout
12921 ] If this is set to 1, the argument will output its content in the corresponding
12922 item in the table of contents.
12926 \begin_layout Standard
12927 By default, the text entered in the \SpecialChar LyX
12928 workarea in the respective layout is
12929 the last (mandatory) argument of a command if the
12930 \begin_inset Flex Code
12933 \begin_layout Plain Layout
12940 \begin_inset Flex Code
12943 \begin_layout Plain Layout
12950 However, arguments with the prefix
12951 \begin_inset Flex Code
12954 \begin_layout Plain Layout
12960 are output after this workarea argument.
12961 Note that post-argument numbering restarts at 1, so the first argument
12962 following the workarea argument is
12963 \begin_inset Flex Code
12966 \begin_layout Plain Layout
12973 Post-arguments are ignored in any other
12974 \begin_inset Flex Code
12977 \begin_layout Plain Layout
12984 \begin_inset Flex Code
12987 \begin_layout Plain Layout
12996 \begin_layout Standard
12998 \begin_inset Flex Code
13001 \begin_layout Plain Layout
13010 \begin_inset Flex Code
13013 \begin_layout Plain Layout
13022 \begin_inset Flex Code
13025 \begin_layout Plain Layout
13031 followed by the number (e.
13032 \begin_inset space \thinspace{}
13036 \begin_inset space \space{}
13040 \begin_inset Flex Code
13043 \begin_layout Plain Layout
13050 \change_inserted -712698321 1534487781
13054 \begin_layout Standard
13056 \change_inserted -712698321 1534488561
13057 Finally, there is a special argument type with the prefix
13058 \begin_inset Flex Code
13061 \begin_layout Plain Layout
13063 \change_inserted -712698321 1534487844
13072 It is not really an argument, but uses the argument interface (thus, the
13073 prefix is also followed by a number, e.
13074 \begin_inset space \thinspace{}
13079 \begin_inset Flex Code
13082 \begin_layout Plain Layout
13084 \change_inserted -712698321 1534488412
13085 Argument listpreamble:1
13091 As the name implies, it is targeted at lists such as
13108 Its content will be output at the list start, before the first
13109 \begin_inset Flex Code
13112 \begin_layout Plain Layout
13114 \change_inserted -712698321 1534488058
13124 , on an own line (a place that is otherwise not accessible in \SpecialChar LyX
13126 This way, users can insert redefinitions (of lengths etc.) to individual
13128 By default, these arguments do not have a delimiter.
13134 \begin_layout Description
13135 \begin_inset Flex Code
13138 \begin_layout Plain Layout
13144 Includes a comma-separated list of layouts that should be nested in and
13145 after the current layout.
13146 Only makes sense for nestable layouts (such as environments).
13148 \begin_inset Quotes eld
13152 \begin_inset Flex Code
13155 \begin_layout Plain Layout
13162 \begin_inset Quotes erd
13167 \begin_inset Flex Code
13170 \begin_layout Plain Layout
13179 \begin_layout Description
13180 \begin_inset Flex Code
13183 \begin_layout Plain Layout
13189 Note that this will completely override any prior
13190 \begin_inset Flex Code
13193 \begin_layout Plain Layout
13199 declaration for this style.
13201 \begin_inset Quotes eld
13205 \begin_inset Flex Code
13208 \begin_layout Plain Layout
13215 \begin_inset Quotes erd
13220 \begin_inset CommandInset ref
13222 reference "subsec:I18n"
13226 for details on its use.
13229 \begin_layout Description
13230 \begin_inset Flex Code
13233 \begin_layout Plain Layout
13240 \begin_inset Flex Code
13243 \begin_layout Plain Layout
13253 \begin_layout Plain Layout
13254 Note that a `float' here is a real number, such as: 1.5.
13259 The vertical space with which the last of a chain of paragraphs with this
13260 style is separated from the following paragraph.
13261 If the next paragraph has another style, the separations are not simply
13262 added, but the maximum is taken.
13265 \begin_layout Description
13266 \begin_inset Flex Code
13269 \begin_layout Plain Layout
13276 \begin_inset Flex Code
13279 \begin_layout Plain Layout
13285 ] The category for this style.
13286 This is used to group related styles in the style combobox on the toolbar.
13287 Any string can be used, but you may want to use existing categories with
13292 \begin_layout Description
13293 \begin_inset Flex Code
13296 \begin_layout Plain Layout
13302 Depth of XML command.
13303 Used only with XML-type formats.
13306 \begin_layout Description
13307 \begin_inset Flex Code
13310 \begin_layout Plain Layout
13317 \begin_inset Flex Code
13320 \begin_layout Plain Layout
13326 ] Copies all the features of an existing style into the current one.
13330 \begin_layout Description
13331 \begin_inset Flex Code
13334 \begin_layout Plain Layout
13341 \begin_inset Flex Code
13344 \begin_layout Plain Layout
13350 ] The name of a style whose preamble should be output
13355 This allows to ensure some ordering of the preamble snippets when macros
13356 definitions depend on one another.
13360 \begin_layout Plain Layout
13361 Note that, besides that functionality, there is no way to ensure any ordering
13363 The ordering that you see in a given version of \SpecialChar LyX
13364 may change without warning
13373 \begin_layout Description
13374 \begin_inset Flex Code
13377 \begin_layout Plain Layout
13384 \begin_inset Flex Code
13387 \begin_layout Plain Layout
13392 , Box, Filled_Box, Static
13397 ] The type of label that stands at the end of the paragraph (or sequence
13399 \begin_inset Flex Code
13402 \begin_layout Plain Layout
13409 \begin_inset Newline newline
13413 \begin_inset Flex Code
13416 \begin_layout Plain Layout
13423 \begin_inset Flex Code
13426 \begin_layout Plain Layout
13433 \begin_inset Flex Code
13436 \begin_layout Plain Layout
13444 \begin_inset Flex Code
13447 \begin_layout Plain Layout
13454 \begin_inset Quotes eld
13458 \begin_inset Quotes erd
13462 \begin_inset Flex Code
13465 \begin_layout Plain Layout
13472 \begin_inset space \space{}
13476 \begin_inset Flex Code
13479 \begin_layout Plain Layout
13485 ) is a white (resp.
13486 \begin_inset space ~
13489 black) square suitable for end of proof markers,
13490 \begin_inset Flex Code
13493 \begin_layout Plain Layout
13499 is an explicit text string.
13502 \begin_layout Description
13503 \begin_inset Flex Code
13506 \begin_layout Plain Layout
13513 \begin_inset Flex Code
13516 \begin_layout Plain Layout
13522 ] The string used for a label with a
13523 \begin_inset Flex Code
13526 \begin_layout Plain Layout
13533 \begin_inset Newline newline
13537 \begin_inset Flex Code
13540 \begin_layout Plain Layout
13550 \begin_layout Description
13551 \begin_inset Flex Code
13554 \begin_layout Plain Layout
13560 The font used for both the text body
13566 \begin_inset CommandInset ref
13568 reference "subsec:Font-description"
13573 Note that defining this font automatically defines the
13574 \begin_inset Flex Code
13577 \begin_layout Plain Layout
13584 So you should define this one first if you also want to define
13585 \begin_inset Flex Code
13588 \begin_layout Plain Layout
13597 \begin_layout Description
13598 \begin_inset Flex Code
13601 \begin_layout Plain Layout
13608 \begin_inset Flex Code
13611 \begin_layout Plain Layout
13617 ] Used for backporting new styles to stable \SpecialChar LyX
13619 The first stable version that supports this tag is \SpecialChar LyX
13621 The argument is a number which may either be 0, -1 or any value greater
13624 \begin_inset Flex Code
13627 \begin_layout Plain Layout
13633 flag of a style is greater than zero, it will always be written to the
13635 If a .lyx file is read, the style definitions from the document header are
13636 added to the document class.
13637 Therefore even older \SpecialChar LyX
13638 versions can handle the style.
13640 \begin_inset Flex Code
13643 \begin_layout Plain Layout
13649 is a version number: if the style is read, and the version number is less
13650 than the version number of the already existing style in the document class,
13651 the new style is ignored.
13652 If the version number is greater, the new style replaces the existing style.
13653 A value of -1 means an infinite version number, i.
13654 \begin_inset space \thinspace{}
13658 \begin_inset space \space{}
13661 the style is always used.
13664 \begin_layout Description
13665 \begin_inset Flex Code
13668 \begin_layout Plain Layout
13675 \begin_inset Flex Code
13678 \begin_layout Plain Layout
13687 \begin_inset space \thinspace{}
13691 \begin_inset Flex Code
13694 \begin_layout Plain Layout
13700 ] Usually \SpecialChar LyX
13701 does not allow you to insert more than one space between words,
13702 since a space is considered as the separation between two words, not a
13703 character or symbol of its own.
13704 This is a very fine thing but sometimes annoying, for example, when typing
13705 program code or plain \SpecialChar LaTeX
13708 \begin_inset Flex Code
13711 \begin_layout Plain Layout
13719 \change_deleted -495245474 1550490105
13723 will create protected blanks for the additional blanks when in
13724 \change_inserted -495245474 1550490096
13726 \begin_inset Flex Code
13729 \begin_layout Plain Layout
13731 \change_inserted -495245474 1550490089
13738 \change_deleted -495245474 1550490116
13739 another mode than \SpecialChar LaTeX
13742 \change_inserted -495245474 1550247760
13744 \begin_inset Flex Code
13747 \begin_layout Plain Layout
13749 \change_inserted -495245474 1550247736
13756 \begin_inset Flex Code
13759 \begin_layout Plain Layout
13761 \change_inserted -495245474 1550247755
13772 \begin_layout Description
13773 \begin_inset Flex Code
13776 \begin_layout Plain Layout
13782 These tags are used with XHTML output.
13784 \begin_inset CommandInset ref
13786 reference "subsec:Paragraph-Style-XHTML"
13793 \begin_layout Description
13794 \begin_inset Flex Code
13797 \begin_layout Plain Layout
13803 [FIXME] (Used only with XML-type formats.)
13806 \begin_layout Description
13807 \begin_inset Flex Code
13810 \begin_layout Plain Layout
13817 \begin_inset Flex Code
13820 \begin_layout Plain Layout
13829 \begin_inset space \thinspace{}
13833 \begin_inset Flex Code
13836 \begin_layout Plain Layout
13843 \begin_inset Flex Code
13846 \begin_layout Plain Layout
13852 , marks the style as to be included in the document preamble and not in
13854 This is useful for document classes that want such information as the title
13855 and author to appear in the preamble.
13856 Note that this works only for styles for which the
13857 \begin_inset Flex Code
13860 \begin_layout Plain Layout
13867 \begin_inset Flex Code
13870 \begin_layout Plain Layout
13877 \begin_inset Flex Code
13880 \begin_layout Plain Layout
13889 \begin_layout Description
13890 \begin_inset Flex Code
13893 \begin_layout Plain Layout
13900 \begin_inset Flex Code
13903 \begin_layout Plain Layout
13912 \begin_inset space \thinspace{}
13916 \begin_inset Flex Code
13919 \begin_layout Plain Layout
13926 \begin_inset Flex Code
13929 \begin_layout Plain Layout
13935 , marks the style as being part of a title block (see also the
13936 \begin_inset Flex Code
13939 \begin_layout Plain Layout
13946 \begin_inset Flex Code
13949 \begin_layout Plain Layout
13958 \begin_layout Description
13959 \begin_inset Flex Code
13962 \begin_layout Plain Layout
13968 Includes a comma-separated list of layouts after which this one should
13970 Only makes sense with regard to nestable layouts (such as environments).
13972 \begin_inset Quotes eld
13976 \begin_inset Flex Code
13979 \begin_layout Plain Layout
13986 \begin_inset Quotes erd
13991 \begin_inset Flex Code
13994 \begin_layout Plain Layout
14003 \begin_layout Description
14004 \begin_inset Flex Code
14007 \begin_layout Plain Layout
14014 \begin_inset Flex Code
14017 \begin_layout Plain Layout
14026 \begin_inset space \thinspace{}
14030 \begin_inset Flex Code
14033 \begin_layout Plain Layout
14039 ] If this is set to 1 and AddToToc is enabled, the paragraph adds a summary
14040 of its contents in its item in the table of contents.
14041 Otherwise, only the label, if it exists, appears.
14044 \begin_layout Description
14045 \begin_inset Flex Code
14048 \begin_layout Plain Layout
14055 \begin_inset Flex Code
14058 \begin_layout Plain Layout
14064 ] The \SpecialChar LaTeX
14065 command sequence declaring an item in a list.
14066 The command is to be defined without the preceding backslash (the default
14068 \begin_inset Quotes eld
14072 \begin_inset Quotes erd
14076 \begin_inset Flex Code
14079 \begin_layout Plain Layout
14087 in the \SpecialChar LaTeX
14091 \begin_layout Description
14092 \begin_inset Flex Code
14095 \begin_layout Plain Layout
14102 \begin_inset Flex Code
14105 \begin_layout Plain Layout
14111 ] This provides extra space between paragraphs that have the same style.
14112 If you put other styles into an environment, each is separated with the
14114 \begin_inset Flex Code
14117 \begin_layout Plain Layout
14124 But the whole items of the environment are additionally separated with
14126 \begin_inset Flex Code
14129 \begin_layout Plain Layout
14136 Note that this is a
14141 \begin_layout Description
14142 \begin_inset Flex Code
14145 \begin_layout Plain Layout
14151 [FIXME] (Used only with XML-type formats.)
14154 \begin_layout Description
14155 \begin_inset Flex Code
14158 \begin_layout Plain Layout
14165 \begin_inset Flex Code
14168 \begin_layout Plain Layout
14177 \begin_inset space \thinspace{}
14181 \begin_inset Flex Code
14184 \begin_layout Plain Layout
14190 ] Usually \SpecialChar LyX
14191 does not allow you to leave a paragraph empty, since it would
14192 lead to empty \SpecialChar LaTeX
14194 There are some cases where this could be desirable however: in a letter
14195 template, the required fields can be provided as empty fields, so that
14196 people do not forget them; in some special classes, a style can be used
14197 as some kind of break, which does not contain actual text.
14200 \begin_layout Description
14201 \begin_inset Flex Code
14204 \begin_layout Plain Layout
14211 \begin_inset Flex Code
14214 \begin_layout Plain Layout
14220 ] The vertical space between the label and the text body.
14221 Only used for labels that are above the text body (
14222 \begin_inset Flex Code
14225 \begin_layout Plain Layout
14232 \begin_inset Newline newline
14236 \begin_inset Flex Code
14239 \begin_layout Plain Layout
14240 Centered_Top_Environment
14248 \begin_layout Description
14249 \begin_inset Flex Code
14252 \begin_layout Plain Layout
14259 \begin_inset Flex Code
14262 \begin_layout Plain Layout
14268 ] The name of the counter for automatic numbering.
14269 In order to have the counter appear with your label, you will need to reference
14271 \begin_inset Flex Code
14274 \begin_layout Plain Layout
14283 This will work with
14284 \begin_inset Flex Code
14287 \begin_layout Plain Layout
14294 \begin_inset Flex Code
14297 \begin_layout Plain Layout
14304 \begin_inset Flex Code
14307 \begin_layout Plain Layout
14314 \begin_inset Flex Code
14317 \begin_layout Plain Layout
14324 \begin_inset Newline newline
14332 \begin_inset Flex Code
14335 \begin_layout Plain Layout
14342 \begin_inset Flex Code
14345 \begin_layout Plain Layout
14351 , though this case is a bit complicated.
14352 Suppose you declare
14353 \begin_inset Quotes eld
14357 \begin_inset Flex Code
14360 \begin_layout Plain Layout
14361 LabelCounter myenum
14367 \begin_inset Quotes erd
14371 Then the actual counters used are
14372 \begin_inset Flex Code
14375 \begin_layout Plain Layout
14382 \begin_inset Flex Code
14385 \begin_layout Plain Layout
14392 \begin_inset Flex Code
14395 \begin_layout Plain Layout
14402 \begin_inset Flex Code
14405 \begin_layout Plain Layout
14411 , much as in \SpecialChar LaTeX
14413 These counters must all be declared separately.
14414 \begin_inset Newline newline
14418 \begin_inset CommandInset ref
14420 reference "subsec:Counters"
14424 for details on counters.
14427 \begin_layout Description
14428 \begin_inset Flex Code
14431 \begin_layout Plain Layout
14437 The font used for the label.
14439 \begin_inset CommandInset ref
14441 reference "subsec:Font-description"
14448 \begin_layout Description
14449 \begin_inset Flex Code
14452 \begin_layout Plain Layout
14459 \begin_inset Flex Code
14462 \begin_layout Plain Layout
14468 ] Text that indicates how far a label should be indented.
14471 \begin_layout Description
14472 \begin_inset Flex Code
14475 \begin_layout Plain Layout
14482 \begin_inset Flex Code
14485 \begin_layout Plain Layout
14491 ] Text that indicates the amount of horizontal space between the label and
14493 Only used for labels that are not above the text body.
14496 \begin_layout Description
14497 \begin_inset Flex Code
14500 \begin_layout Plain Layout
14507 \begin_inset Flex Code
14510 \begin_layout Plain Layout
14516 ] The string used for the label.
14518 \begin_inset Flex Code
14521 \begin_layout Plain Layout
14527 is set, this string can be contain the special formatting commands described
14529 \begin_inset CommandInset ref
14531 reference "subsec:Counters"
14538 \begin_layout Description
14539 \begin_inset Flex Code
14542 \begin_layout Plain Layout
14543 LabelStringAppendix
14549 \begin_inset Flex Code
14552 \begin_layout Plain Layout
14558 ] This is used inside the appendix instead of
14559 \begin_inset Newline newline
14563 \begin_inset Flex Code
14566 \begin_layout Plain Layout
14574 \begin_inset Flex Code
14577 \begin_layout Plain Layout
14584 \begin_inset Newline newline
14588 \begin_inset Flex Code
14591 \begin_layout Plain Layout
14592 LabelStringAppendix
14600 \begin_layout Description
14601 \begin_inset Flex Code
14604 \begin_layout Plain Layout
14610 [FIXME] (Used only with XML-type formats.)
14613 \begin_layout Description
14614 \begin_inset Flex Code
14617 \begin_layout Plain Layout
14624 \begin_inset Flex Code
14627 \begin_layout Plain Layout
14632 , Manual, Static, Above,
14633 \begin_inset Newline newline
14636 Centered, Sensitive, Enumerate,
14637 \begin_inset Newline newline
14640 Itemize, Bibliography
14649 \begin_layout Description
14650 \begin_inset Flex Code
14653 \begin_layout Plain Layout
14659 means the label is the very first word (up to the first real blank).
14660 Use protected spaces if you want more than one word as the label.
14664 \begin_layout Description
14665 \begin_inset Flex Code
14668 \begin_layout Plain Layout
14674 means the label is simply what is declared as
14675 \begin_inset Flex Code
14678 \begin_layout Plain Layout
14685 This will be displayed
14686 \begin_inset Quotes eld
14690 \begin_inset Quotes erd
14693 , at the beginning of the paragraph.
14695 \begin_inset Flex Code
14698 \begin_layout Plain Layout
14705 \begin_inset Flex Code
14708 \begin_layout Plain Layout
14714 , then it will be displayed only in the first paragraph of any sequence
14715 of paragraphs with the same
14716 \begin_inset Flex Code
14719 \begin_layout Plain Layout
14728 \begin_layout Description
14729 \begin_inset Flex Code
14732 \begin_layout Plain Layout
14739 \begin_inset space ~
14743 \begin_inset space ~
14747 \begin_inset Flex Code
14750 \begin_layout Plain Layout
14756 are special cases of
14757 \begin_inset Flex Code
14760 \begin_layout Plain Layout
14767 The label will be printed above the paragraph either at the beginning of
14768 the line or centered.
14771 \begin_layout Description
14772 \begin_inset Flex Code
14775 \begin_layout Plain Layout
14781 is a special case for the caption-labels
14782 \begin_inset Quotes eld
14786 \begin_inset Quotes erd
14790 \begin_inset Quotes eld
14794 \begin_inset Quotes erd
14798 \begin_inset Newline newline
14802 \begin_inset Flex Code
14805 \begin_layout Plain Layout
14811 means the (hardcoded) label string depends on the kind of float: It is
14812 hardcoded to be `FloatType N', where N is the value of the counter associated
14814 For the case that a caption is inserted outside of a float the
14815 \begin_inset Flex Code
14818 \begin_layout Plain Layout
14825 \begin_inset Quotes eld
14829 \begin_inset Quotes erd
14835 \begin_layout Description
14836 \begin_inset Flex Code
14839 \begin_layout Plain Layout
14845 produces the usual sort of enumeration labels.
14846 The number type needs to be set in the
14851 \begin_inset CommandInset ref
14853 reference "subsec:Counters"
14860 \begin_layout Description
14861 \begin_inset Flex Code
14864 \begin_layout Plain Layout
14870 produces various bullets at the different levels.
14871 The bullet types displayed can be set via
14872 \begin_inset Flex Noun
14875 \begin_layout Plain Layout
14876 Document\SpecialChar menuseparator
14877 Settings\SpecialChar menuseparator
14886 \begin_layout Description
14887 \begin_inset Flex Code
14890 \begin_layout Plain Layout
14896 should be used only with
14897 \begin_inset Flex Code
14900 \begin_layout Plain Layout
14901 LatexType BibEnvironment
14910 \begin_layout Description
14911 \begin_inset Flex Code
14914 \begin_layout Plain Layout
14920 Note that this will completely override any prior
14921 \begin_inset Flex Code
14924 \begin_layout Plain Layout
14930 declaration for this style.
14932 \begin_inset Quotes eld
14936 \begin_inset Flex Code
14939 \begin_layout Plain Layout
14946 \begin_inset Quotes erd
14951 \begin_inset CommandInset ref
14953 reference "subsec:I18n"
14957 for details on its use.
14960 \begin_layout Description
14961 \begin_inset Flex Code
14964 \begin_layout Plain Layout
14971 \begin_inset Flex Code
14974 \begin_layout Plain Layout
14980 ] The name of the corresponding \SpecialChar LaTeX
14982 Either the environment or command name.
14985 \begin_layout Description
14986 \begin_inset Flex Code
14989 \begin_layout Plain Layout
14996 \begin_inset Flex Code
14999 \begin_layout Plain Layout
15005 ] An optional parameter for the corresponding
15006 \begin_inset Flex Code
15009 \begin_layout Plain Layout
15016 This parameter cannot be changed from within \SpecialChar LyX
15018 \begin_inset Flex Code
15021 \begin_layout Plain Layout
15027 for customizable parameters).
15028 This will be output as is after all \SpecialChar LaTeX
15030 \begin_inset Flex Code
15033 \begin_layout Plain Layout
15042 \begin_layout Description
15043 \begin_inset Flex Code
15046 \begin_layout Plain Layout
15053 \begin_inset Flex Code
15056 \begin_layout Plain Layout
15061 , Command, Environment, Item_Environment,
15062 \begin_inset Newline newline
15065 List_Environment, Bib_Environment
15070 ] How the style should be translated into \SpecialChar LaTeX
15075 \begin_layout Plain Layout
15076 \begin_inset Flex Code
15079 \begin_layout Plain Layout
15085 is perhaps a bit misleading, since these rules apply to SGML classes, too.
15086 Visit the SGML class files for specific examples.
15095 \begin_layout Description
15096 \begin_inset Flex Code
15099 \begin_layout Plain Layout
15105 means nothing special.
15108 \begin_layout Description
15109 \begin_inset Flex Code
15112 \begin_layout Plain Layout
15119 \begin_inset Flex Code
15122 \begin_layout Plain Layout
15129 {\SpecialChar ldots
15138 \begin_layout Description
15139 \begin_inset Flex Code
15142 \begin_layout Plain Layout
15149 \begin_inset Flex Code
15152 \begin_layout Plain Layout
15159 }\SpecialChar ldots
15175 \begin_layout Description
15176 \begin_inset Flex Code
15179 \begin_layout Plain Layout
15186 \begin_inset Flex Code
15189 \begin_layout Plain Layout
15196 \begin_inset Flex Code
15199 \begin_layout Plain Layout
15207 is generated for each paragraph of this environment.
15211 \begin_layout Description
15212 \begin_inset Flex Code
15215 \begin_layout Plain Layout
15222 \begin_inset Flex Code
15225 \begin_layout Plain Layout
15232 \begin_inset Newline newline
15236 \begin_inset Flex Code
15239 \begin_layout Plain Layout
15245 is passed as an argument to the environment.
15246 \begin_inset Newline newline
15250 \begin_inset Flex Code
15253 \begin_layout Plain Layout
15259 can be defined in the
15260 \begin_inset Flex Noun
15263 \begin_layout Plain Layout
15264 Edit\SpecialChar menuseparator
15266 \begin_inset space ~
15277 \begin_layout Description
15278 \begin_inset Flex Code
15281 \begin_layout Plain Layout
15288 \begin_inset Flex Code
15291 \begin_layout Plain Layout
15297 but adds the necessary mandatory argument (the longest label) to the begin
15298 statement of the bibliography environment:
15299 \begin_inset Newline newline
15303 \begin_inset Flex Code
15306 \begin_layout Plain Layout
15309 begin{thebibliography}{99}
15315 It is therefore only useful for bibliography environments.
15316 The default longest label
15317 \begin_inset Quotes eld
15321 \begin_inset Quotes erd
15324 can be changed by the user in the paragraph settings of a bibliography
15328 \begin_layout Standard
15329 Putting the last few things together, the \SpecialChar LaTeX
15330 output will be either:
15333 \begin_layout LyX-Code
15336 LatexName[LatexParam]{\SpecialChar ldots
15340 \begin_layout Standard
15344 \begin_layout LyX-Code
15347 begin{LatexName}[LatexParam] \SpecialChar ldots
15353 \begin_layout Standard
15354 depending upon the \SpecialChar LaTeX
15359 \begin_layout Description
15360 \begin_inset Flex Code
15363 \begin_layout Plain Layout
15370 \begin_inset Flex Code
15373 \begin_layout Plain Layout
15379 ] A string that is put at the beginning of the style content.
15380 A line break in the output can be indicated by
15381 \begin_inset Flex Code
15384 \begin_layout Plain Layout
15393 \begin_layout Description
15394 \begin_inset Flex Code
15397 \begin_layout Plain Layout
15404 \begin_inset Flex Code
15407 \begin_layout Plain Layout
15413 ] If you put styles into environments, the different
15414 \begin_inset Flex Code
15417 \begin_layout Plain Layout
15423 are not simply added, but added with a factor
15424 \begin_inset Formula $\frac{4}{\mathrm{depth}+4}$
15428 Note that this parameter is also used when
15429 \begin_inset Flex Code
15432 \begin_layout Plain Layout
15439 \begin_inset Flex Code
15442 \begin_layout Plain Layout
15449 \begin_inset Flex Code
15452 \begin_layout Plain Layout
15459 Then it is added to the manual or dynamic margin.
15460 \begin_inset Newline newline
15464 \begin_inset Quotes eld
15468 \begin_inset Flex Code
15471 \begin_layout Plain Layout
15478 \begin_inset Quotes erd
15481 means that the paragraph is indented with the width of
15482 \begin_inset Quotes eld
15486 \begin_inset Flex Code
15489 \begin_layout Plain Layout
15496 \begin_inset Quotes erd
15499 in the normal font.
15500 You can get a negative width by prefixing the string with
15501 \begin_inset Quotes eld
15505 \begin_inset Flex Code
15508 \begin_layout Plain Layout
15515 \begin_inset Quotes erd
15519 This way was chosen so that the look is the same with each used screen
15523 \begin_layout Description
15524 \begin_inset Flex Code
15527 \begin_layout Plain Layout
15534 \begin_inset Flex Code
15537 \begin_layout Plain Layout
15542 , Manual, Dynamic, First_Dynamic, Right_Address_Box
15548 \begin_inset Newline newline
15551 The kind of margin that the style has on the left side.
15555 \begin_layout Description
15556 \begin_inset Flex Code
15559 \begin_layout Plain Layout
15565 just means a fixed margin.
15568 \begin_layout Description
15569 \begin_inset Flex Code
15572 \begin_layout Plain Layout
15578 means that the left margin depends on the string entered in the
15579 \begin_inset Flex Noun
15582 \begin_layout Plain Layout
15583 Edit\SpecialChar menuseparator
15585 \begin_inset space ~
15594 This is used to typeset nice lists without tabulators.
15597 \begin_layout Description
15598 \begin_inset Flex Code
15601 \begin_layout Plain Layout
15607 means that the margin depends on the size of the label.
15608 This is used for automatic enumerated headlines.
15609 It is obvious that the headline
15610 \begin_inset Quotes eld
15613 5.4.3.2.1 Very long headline
15614 \begin_inset Quotes erd
15617 must have a wider left margin (as wide as
15618 \begin_inset Quotes eld
15622 \begin_inset Quotes erd
15625 plus the space) than
15626 \begin_inset Quotes eld
15629 3.2 Very long headline
15630 \begin_inset Quotes erd
15634 \begin_inset Quotes eld
15638 \begin_inset Quotes erd
15641 are not able to do this.
15644 \begin_layout Description
15645 \begin_inset Flex Code
15648 \begin_layout Plain Layout
15654 is similar, but only the very first row of the paragraph is dynamic, while
15655 the others are static; this is used, for example, for descriptions.
15658 \begin_layout Description
15659 \begin_inset Flex Code
15662 \begin_layout Plain Layout
15668 means the margin is chosen in a way that the longest row of this paragraph
15669 fits to the right margin.
15670 This is used to typeset an address on the right edge of the page.
15674 \begin_layout Description
15675 \begin_inset Flex Code
15678 \begin_layout Plain Layout
15685 \begin_inset Flex Code
15688 \begin_layout Plain Layout
15697 \begin_inset space \thinspace{}
15701 \begin_inset Flex Code
15704 \begin_layout Plain Layout
15710 ] Whether fragile commands in this style should be
15711 \begin_inset Flex Code
15714 \begin_layout Plain Layout
15727 whether this command should itself be protected.)
15728 \change_inserted -712698321 1523696949
15732 \begin_layout Description
15734 \change_inserted -712698321 1552395557
15735 \begin_inset Flex Code
15738 \begin_layout Plain Layout
15740 \change_inserted -712698321 1523696950
15747 \begin_inset Flex Code
15750 \begin_layout Plain Layout
15752 \change_inserted -712698321 1523696950
15761 \begin_inset space \thinspace{}
15765 \begin_inset Flex Code
15768 \begin_layout Plain Layout
15770 \change_inserted -712698321 1523696950
15776 ] This causes macros that contain this layout to be protected with
15777 \begin_inset Flex Code
15780 \begin_layout Plain Layout
15782 \change_inserted -712698321 1523696950
15795 ) if necessary and thus allows (some) verbatim stuff in macros.
15798 \begin_layout Description
15800 \change_inserted -712698321 1552395844
15801 \begin_inset Flex Code
15804 \begin_layout Plain Layout
15806 \change_inserted -712698321 1552395561
15813 \begin_inset Flex Code
15816 \begin_layout Plain Layout
15818 \change_inserted -712698321 1552395557
15827 \begin_inset space \thinspace{}
15831 \begin_inset Flex Code
15834 \begin_layout Plain Layout
15836 \change_inserted -712698321 1552395557
15842 ] Whether specific commands in this style (such as
15843 \begin_inset Flex Code
15846 \begin_layout Plain Layout
15848 \change_inserted -712698321 1552395655
15859 \begin_inset Flex Code
15862 \begin_layout Plain Layout
15864 \change_inserted -712698321 1552395661
15874 ) should be protected in an
15875 \begin_inset Flex Code
15878 \begin_layout Plain Layout
15880 \change_inserted -712698321 1552395631
15891 This is particularly needed for styles that draw on
15899 commands which parse their content in complex ways.
15904 \begin_layout Description
15905 \begin_inset Flex Code
15908 \begin_layout Plain Layout
15915 \begin_inset Flex Code
15918 \begin_layout Plain Layout
15925 \begin_inset space \thinspace{}
15929 \begin_inset Flex Code
15932 \begin_layout Plain Layout
15940 ] Whether newlines are translated into \SpecialChar LaTeX
15942 \begin_inset Flex Code
15945 \begin_layout Plain Layout
15956 The translation can be switched off to allow more comfortable \SpecialChar LaTeX
15958 inside \SpecialChar LyX
15962 \begin_layout Description
15963 \begin_inset Flex Code
15966 \begin_layout Plain Layout
15973 \begin_inset Flex Code
15976 \begin_layout Plain Layout
15985 \begin_inset space \thinspace{}
15989 \begin_inset Flex Code
15992 \begin_layout Plain Layout
15998 ] If set to true, and if
15999 \begin_inset Flex Code
16002 \begin_layout Plain Layout
16009 \begin_inset Flex Code
16012 \begin_layout Plain Layout
16018 ) paragraphs are being indented, then the indentation of such a paragraph
16019 following one of this type will be suppressed.
16020 (So this will not affect the display of non-default paragraphs.)
16023 \begin_layout Description
16024 \begin_inset Flex Code
16027 \begin_layout Plain Layout
16034 \begin_inset Flex Code
16037 \begin_layout Plain Layout
16043 ] Name of a style that has replaced this style.
16044 This is used to rename a style, while keeping backward compatibility.
16047 \begin_layout Description
16048 \begin_inset Flex Code
16051 \begin_layout Plain Layout
16058 \begin_inset Flex Code
16061 \begin_layout Plain Layout
16068 \begin_inset space \thinspace{}
16072 \begin_inset Flex Code
16075 \begin_layout Plain Layout
16081 ] Determines whether consecutive paragraphs of the same type are treated
16082 as belonging together.
16083 This has the effect that the
16084 \begin_inset Flex Code
16087 \begin_layout Plain Layout
16093 is only printed once before such a group.
16094 By default, this is true for
16095 \begin_inset Flex Code
16098 \begin_layout Plain Layout
16105 \begin_inset Flex Code
16108 \begin_layout Plain Layout
16115 \begin_inset Flex Code
16118 \begin_layout Plain Layout
16124 and false for all other types.
16127 \begin_layout Description
16128 \begin_inset Flex Code
16131 \begin_layout Plain Layout
16138 \begin_inset Flex Code
16141 \begin_layout Plain Layout
16150 \begin_inset space \thinspace{}
16154 \begin_inset Flex Code
16157 \begin_layout Plain Layout
16163 ] Indicates that paragraphs will not be separated by an empty line in \SpecialChar LaTeX
16165 but only by a line break; together with
16166 \begin_inset Flex Code
16169 \begin_layout Plain Layout
16175 , this allows to emulate a plain text editor (like the ERT inset).
16178 \begin_layout Description
16179 \begin_inset Flex Code
16182 \begin_layout Plain Layout
16189 \begin_inset Flex Code
16192 \begin_layout Plain Layout
16198 ] The indent of the very first line of a paragraph.
16200 \begin_inset Newline newline
16204 \begin_inset Flex Code
16207 \begin_layout Plain Layout
16213 will be fixed for a certain style.
16214 The exception is the default style, since the indentation for these paragraphs
16215 can be prohibited with
16216 \begin_inset Flex Code
16219 \begin_layout Plain Layout
16227 \begin_inset Flex Code
16230 \begin_layout Plain Layout
16236 style paragraphs inside environments use the
16237 \begin_inset Flex Code
16240 \begin_layout Plain Layout
16246 of the environment, not their native one.
16248 \begin_inset Flex Code
16251 \begin_layout Plain Layout
16257 paragraphs inside an enumeration are not indented.
16260 \begin_layout Description
16261 \begin_inset Flex Code
16264 \begin_layout Plain Layout
16271 \begin_inset Flex Code
16274 \begin_layout Plain Layout
16280 ] The vertical space between two paragraphs of this style.
16283 \begin_layout Description
16284 \begin_inset Flex Code
16287 \begin_layout Plain Layout
16294 \begin_inset Flex Code
16297 \begin_layout Plain Layout
16304 allows the user to choose either
16305 \begin_inset Quotes eld
16309 \begin_inset Quotes erd
16313 \begin_inset Quotes eld
16317 \begin_inset Quotes erd
16320 to separate paragraphs.
16322 \begin_inset Quotes eld
16326 \begin_inset Quotes erd
16330 \begin_inset Flex Code
16333 \begin_layout Plain Layout
16341 \begin_inset Quotes eld
16345 \begin_inset Quotes erd
16349 \begin_inset Flex Code
16352 \begin_layout Plain Layout
16358 is ignored and all paragraphs are separated by the
16359 \begin_inset Flex Code
16362 \begin_layout Plain Layout
16369 The vertical space is calculated with
16370 \begin_inset Flex Code
16373 \begin_layout Plain Layout
16375 \begin_inset space ~
16384 \begin_inset Flex Code
16387 \begin_layout Plain Layout
16393 is the height of a row with the normal font.
16394 This way, the look stays the same with different screen fonts.
16397 \begin_layout Description
16398 \begin_inset Flex Code
16401 \begin_layout Plain Layout
16408 \begin_inset Flex Code
16411 \begin_layout Plain Layout
16420 \begin_inset space \thinspace{}
16424 \begin_inset Flex Code
16427 \begin_layout Plain Layout
16433 ] Whether the contents of this paragraph should be output in raw form, meaning
16434 without special translations that \SpecialChar LaTeX
16438 \begin_layout Description
16439 \begin_inset Flex Code
16442 \begin_layout Plain Layout
16449 \begin_inset Flex Code
16452 \begin_layout Plain Layout
16462 Defines individual characters that should be output in raw form, meaning
16463 without special translations that \SpecialChar LaTeX
16467 \begin_layout Description
16468 \begin_inset Flex Code
16471 \begin_layout Plain Layout
16477 Information to be included in the \SpecialChar LaTeX
16478 preamble when this style is used.
16479 Used to define macros, load packages, etc., required by this particular
16482 \begin_inset Quotes eld
16486 \begin_inset Flex Code
16489 \begin_layout Plain Layout
16496 \begin_inset Quotes erd
16502 \begin_layout Description
16503 \begin_inset Flex Code
16506 \begin_layout Plain Layout
16513 \begin_inset Flex Code
16516 \begin_layout Plain Layout
16522 ] The prefix to use when creating labels referring to paragraphs of this
16524 This allows the use of formatted references.
16527 \begin_layout Description
16528 \begin_inset Flex Code
16531 \begin_layout Plain Layout
16538 \begin_inset Flex Code
16541 \begin_layout Plain Layout
16547 ] Whether the style requires the feature
16548 \begin_inset Flex Code
16551 \begin_layout Plain Layout
16558 \begin_inset CommandInset ref
16560 reference "chap:List-of-functions"
16564 for the list of features).
16565 If you require a package with specific options, you can additionally use
16567 \begin_inset Flex Code
16570 \begin_layout Plain Layout
16576 as a general text class parameter (see
16577 \begin_inset CommandInset ref
16579 reference "subsec:General-text-class"
16586 \begin_layout Description
16587 \begin_inset Flex Code
16590 \begin_layout Plain Layout
16597 \begin_inset Flex Code
16600 \begin_layout Plain Layout
16609 \begin_inset Flex Code
16612 \begin_layout Plain Layout
16618 ] Resets the \SpecialChar LaTeX
16619 arguments of this style (as defined via the
16620 \begin_inset Flex Code
16623 \begin_layout Plain Layout
16630 This is useful if you have copied a style via
16631 \begin_inset Flex Code
16634 \begin_layout Plain Layout
16640 , but you do not want to inherit its (required and optional) arguments.
16643 \begin_layout Description
16644 \begin_inset Flex Code
16647 \begin_layout Plain Layout
16654 \begin_inset Flex Code
16657 \begin_layout Plain Layout
16666 \begin_inset Flex Code
16669 \begin_layout Plain Layout
16675 ] Resumes a counter that is usually reset at each new sequence of layouts.
16676 This is currently only useful when
16677 \begin_inset Flex Code
16680 \begin_layout Plain Layout
16687 \begin_inset Flex Code
16690 \begin_layout Plain Layout
16699 \begin_layout Description
16700 \begin_inset Flex Code
16703 \begin_layout Plain Layout
16710 \begin_inset Flex Code
16713 \begin_layout Plain Layout
16719 ] A string that is put at the end of the layout content.
16720 A line break in the output can be indicated by
16721 \begin_inset Flex Code
16724 \begin_layout Plain Layout
16733 \begin_layout Description
16734 \begin_inset Flex Code
16737 \begin_layout Plain Layout
16744 \begin_inset Flex Code
16747 \begin_layout Plain Layout
16754 \begin_inset Flex Code
16757 \begin_layout Plain Layout
16766 \begin_layout Description
16767 \begin_inset Flex Code
16770 \begin_layout Plain Layout
16777 \begin_inset Flex Code
16780 \begin_layout Plain Layout
16789 \begin_inset Flex Code
16792 \begin_layout Plain Layout
16799 \begin_inset Flex Code
16802 \begin_layout Plain Layout
16809 \begin_inset Flex Code
16812 \begin_layout Plain Layout
16814 \begin_inset space ~
16822 ] This defines what the default spacing should be in the style.
16824 \begin_inset Flex Code
16827 \begin_layout Plain Layout
16834 \begin_inset Flex Code
16837 \begin_layout Plain Layout
16844 \begin_inset Flex Code
16847 \begin_layout Plain Layout
16853 correspond respectively to a multiplier value of 1, 1.25 and 1.667.
16854 If you specify the argument
16855 \begin_inset Flex Code
16858 \begin_layout Plain Layout
16864 , then you must also provide a value argument which will be the actual multiplie
16866 Note that, contrary to other parameters,
16867 \begin_inset Flex Code
16870 \begin_layout Plain Layout
16876 implies the generation of specific \SpecialChar LaTeX
16877 code, using the \SpecialChar LaTeX
16881 \begin_inset Flex Code
16884 \begin_layout Plain Layout
16893 \begin_layout Description
16894 \begin_inset Flex Code
16897 \begin_layout Plain Layout
16904 \begin_inset Flex Code
16907 \begin_layout Plain Layout
16914 \begin_inset space \thinspace{}
16918 \begin_inset Flex Code
16921 \begin_layout Plain Layout
16929 ] Allow spell-checking paragraphs of this style.
16933 \begin_layout Description
16934 \begin_inset Flex Code
16937 \begin_layout Plain Layout
16944 \begin_inset Flex Code
16947 \begin_layout Plain Layout
16956 \begin_inset Flex Code
16959 \begin_layout Plain Layout
16965 ] Steps the master counter of a given counter at the beginning of a new
16966 sequence of layouts.
16967 This is currently only useful when
16968 \begin_inset Flex Code
16971 \begin_layout Plain Layout
16978 \begin_inset Flex Code
16981 \begin_layout Plain Layout
16990 \begin_layout Description
16991 \begin_inset Flex Code
16994 \begin_layout Plain Layout
17000 The font used for the text body .
17002 \begin_inset CommandInset ref
17004 reference "subsec:Font-description"
17011 \begin_layout Description
17012 \begin_inset Flex Code
17015 \begin_layout Plain Layout
17024 \begin_inset Flex Code
17027 \begin_layout Plain Layout
17037 The level of the style in the table of contents.
17038 This is used for automatic numbering of section headings.
17041 \begin_layout Description
17042 \begin_inset Flex Code
17045 \begin_layout Plain Layout
17054 \begin_inset Flex Code
17057 \begin_layout Plain Layout
17068 \begin_inset Flex Code
17071 \begin_layout Plain Layout
17078 \begin_inset Flex Code
17081 \begin_layout Plain Layout
17087 ] This tag determines whether the first line indentation of this paragraph
17088 can be toggled via the Paragraph settings dialog.
17092 \begin_inset Flex Code
17095 \begin_layout Plain Layout
17105 is set, indentation can be toggled if the document settings use
17106 \begin_inset Quotes eld
17110 \begin_inset Quotes erd
17113 paragraph style, with
17114 \begin_inset Flex Code
17117 \begin_layout Plain Layout
17123 , indentation can always be toggled, notwithstanding the document settings,
17125 \begin_inset Flex Code
17128 \begin_layout Plain Layout
17134 , indentation can never be toggled.
17137 \begin_layout Description
17138 \begin_inset Flex Code
17141 \begin_layout Plain Layout
17148 \begin_inset Flex Code
17151 \begin_layout Plain Layout
17157 ] The vertical space with which the very first of a chain of paragraphs
17158 with this style is separated from the previous paragraph.
17159 If the previous paragraph has another style, the separations are not simply
17160 added, but the maximum is taken.
17163 \begin_layout Subsection
17164 \begin_inset CommandInset label
17170 Internationalization of Paragraph Styles
17173 \begin_layout Standard
17175 has long supported internationalization of layout information, but, until
17176 version 2.0, this applied only to the user interface and not to, say, PDF
17178 Thus, French authors were forced to resort to ugly hacks if they wanted
17183 1' instead of `Theorem 1'.
17184 Thanks to Georg Baum, that is no longer the case.
17187 \begin_layout Standard
17189 \begin_inset Flex Code
17192 \begin_layout Plain Layout
17198 defines text that is to appear in the typeset document, it may use
17199 \begin_inset Flex Code
17202 \begin_layout Plain Layout
17209 \begin_inset Flex Code
17212 \begin_layout Plain Layout
17218 to support non-English and even multi-language documents correctly.
17219 The following excerpt (from the
17220 \begin_inset Flex Code
17223 \begin_layout Plain Layout
17229 file) shows how this works:
17232 \begin_layout LyX-Code
17237 \begin_layout LyX-Code
17240 theoremstyle{remark}
17243 \begin_layout LyX-Code
17246 newtheorem{claim}[thm]{
17253 \begin_layout LyX-Code
17257 \begin_layout LyX-Code
17261 \begin_layout LyX-Code
17266 claimname}{_(Claim)}
17269 \begin_layout LyX-Code
17273 \begin_layout LyX-Code
17277 \begin_layout LyX-Code
17286 claimname}{_(Claim)}}
17289 \begin_layout LyX-Code
17294 \begin_layout Standard
17295 In principle, any legal \SpecialChar LaTeX
17297 \begin_inset Flex Code
17300 \begin_layout Plain Layout
17307 \begin_inset Flex Code
17310 \begin_layout Plain Layout
17316 tags, but in practice they will typically look as they do here.
17317 The key to correct translation of the typeset text is the definition of
17318 the \SpecialChar LaTeX
17320 \begin_inset Flex Code
17323 \begin_layout Plain Layout
17332 \begin_inset Flex Code
17335 \begin_layout Plain Layout
17347 \begin_layout Standard
17349 \begin_inset Flex Code
17352 \begin_layout Plain Layout
17358 tag provides for internationalization based upon the overall language of
17360 The contents of the tag will be included in the preamble, just as with
17362 \begin_inset Flex Code
17365 \begin_layout Plain Layout
17372 What makes it special is the use of the
17373 \begin_inset Quotes eld
17377 \begin_inset Quotes erd
17381 \begin_inset Flex Code
17384 \begin_layout Plain Layout
17390 , which will be replaced, when \SpecialChar LyX
17391 produces \SpecialChar LaTeX
17392 output, with the translation of
17393 its argument into the document language.
17396 \begin_layout Standard
17398 \begin_inset Flex Code
17401 \begin_layout Plain Layout
17407 tag is more complex, since it is meant to provide support for multi-language
17408 documents and so offers an interface to the
17409 \begin_inset Flex Code
17412 \begin_layout Plain Layout
17419 Its contents will be added to the preamble once for each language that
17420 appears in the document.
17421 In this case, the argument to
17422 \begin_inset Flex Code
17425 \begin_layout Plain Layout
17431 will be replaced with its translation into the language in question; the
17433 \begin_inset Flex Code
17436 \begin_layout Plain Layout
17442 is replaced by the language name (as used by the babel package).
17445 \begin_layout Standard
17446 A German document that also included a French section would thus have the
17447 following in the preamble:
17450 \begin_layout LyX-Code
17459 claimname}{Affirmation}}
17460 \begin_inset Newline newline
17471 claimname}{Behauptung}}
17472 \begin_inset Newline newline
17479 claimname}{Behauptung}
17482 \begin_layout Standard
17485 \begin_inset Flex Code
17488 \begin_layout Plain Layout
17494 will then conspire to produce the correct text in the output.
17497 \begin_layout Standard
17498 One important point to note here is that the translations are provided by
17500 itself, through the file
17501 \begin_inset Flex Code
17504 \begin_layout Plain Layout
17511 This means, in effect, that
17512 \begin_inset Flex Code
17515 \begin_layout Plain Layout
17522 \begin_inset Flex Code
17525 \begin_layout Plain Layout
17531 are really only of use in layout files that are provided with \SpecialChar LyX
17533 entered in user-created layout files will not be seen by \SpecialChar LyX
17534 's internationalizatio
17535 n routines unless the
17536 \begin_inset Flex Code
17539 \begin_layout Plain Layout
17545 file is modified accordingly.
17546 That said, however, any layout created with the intention that it will
17547 be included with \SpecialChar LyX
17548 should use these tags where appropriate.
17549 Please note that the paragraph style translations provided by \SpecialChar LyX
17551 change with a minor update (e.
17552 \begin_inset space \thinspace{}
17556 \begin_inset space \space{}
17559 from version 2.1.x to 2.1.y).
17560 It is however quite likely that a major update (e.
17561 \begin_inset space \thinspace{}
17565 \begin_inset space \space{}
17568 from 2.0.x to 2.1.0) will introduce new translations or corrections.
17571 \begin_layout Subsection
17573 \begin_inset CommandInset label
17575 name "subsec:Floats"
17582 \begin_layout Standard
17583 It is necessary to define the floats (
17584 \begin_inset Flex Noun
17587 \begin_layout Plain Layout
17594 \begin_inset Flex Noun
17597 \begin_layout Plain Layout
17603 , \SpecialChar ldots
17604 ) in the text class itself.
17605 Standard floats are included in the file
17606 \begin_inset Flex Code
17609 \begin_layout Plain Layout
17615 , so you may have to do no more than add
17618 \begin_layout LyX-Code
17619 Input stdfloats.inc
17622 \begin_layout Standard
17623 to your layout file.
17624 If you want to implement a text class that proposes some other float types
17625 (like the AGU class bundled with \SpecialChar LyX
17626 ), the information below will hopefully
17630 \begin_layout Description
17631 \begin_inset Flex Code
17634 \begin_layout Plain Layout
17641 \begin_inset Flex Code
17644 \begin_layout Plain Layout
17650 =!htbpH] Allowed placement options for this float type.
17651 The value is a string of placement characters.
17652 Possible characters include:
17657 \begin_inset Quotes eld
17661 \begin_inset Quotes erd
17669 \begin_inset Quotes eld
17673 \begin_inset Quotes erd
17681 \begin_inset Quotes eld
17685 \begin_inset Quotes erd
17693 \begin_inset Quotes eld
17697 \begin_inset Quotes erd
17705 \begin_inset Quotes eld
17709 \begin_inset Quotes erd
17717 \begin_inset Quotes eld
17721 \begin_inset Quotes erd
17725 The order of the characters in the string does not matter.
17726 If no placement options are allowed, use the string
17733 \begin_layout Description
17734 \begin_inset Flex Code
17737 \begin_layout Plain Layout
17744 \begin_inset Flex Code
17747 \begin_layout Plain Layout
17756 \begin_inset space \thinspace{}
17762 \begin_inset Flex Code
17765 \begin_layout Plain Layout
17775 ] Defines whether the float allows to be rotated via the \SpecialChar LaTeX
17782 \begin_inset Flex Code
17785 \begin_layout Plain Layout
17791 if the float does not support this feature.
17794 \begin_layout Description
17795 \begin_inset Flex Code
17798 \begin_layout Plain Layout
17805 \begin_inset Flex Code
17808 \begin_layout Plain Layout
17817 \begin_inset space \thinspace{}
17823 \begin_inset Flex Code
17826 \begin_layout Plain Layout
17836 ] Defines whether the float has a starred variant that spans columns in
17837 a two column paragraph.
17839 \begin_inset Flex Code
17842 \begin_layout Plain Layout
17848 if the float does not support this feature.
17851 \begin_layout Description
17852 \begin_inset Flex Code
17855 \begin_layout Plain Layout
17862 \begin_inset Flex Code
17865 \begin_layout Plain Layout
17872 \begin_inset Quotes erd
17876 \begin_inset Quotes erd
17879 ] The file name extension of an auxiliary file for the list of figures (or
17882 writes the captions to this file.
17885 \begin_layout Description
17886 \begin_inset Flex Code
17889 \begin_layout Plain Layout
17896 \begin_inset Flex Code
17899 \begin_layout Plain Layout
17906 \begin_inset Quotes erd
17910 \begin_inset Quotes erd
17913 ] The string that will be used in the menus and also for the caption.
17914 This is translated to the current language if babel is used.
17917 \begin_layout Description
17918 \begin_inset Flex Code
17921 \begin_layout Plain Layout
17927 These tags control the XHTML output.
17929 \begin_inset CommandInset ref
17931 reference "sec:Tags-for-XHTML"
17938 \begin_layout Description
17939 \begin_inset Flex Code
17942 \begin_layout Plain Layout
17951 \begin_inset Flex Code
17954 \begin_layout Plain Layout
17963 \begin_inset space \thinspace{}
17967 \begin_inset Flex Code
17970 \begin_layout Plain Layout
17976 ] Indicates whether the float is already defined in the document class or
17977 if instead the \SpecialChar LaTeX
17979 \begin_inset Flex Code
17982 \begin_layout Plain Layout
17988 needs to be loaded to define it on-the-fly.
17990 \begin_inset Flex Code
17993 \begin_layout Plain Layout
18000 \begin_inset Flex Code
18003 \begin_layout Plain Layout
18010 It should be set to
18011 \begin_inset Flex Code
18014 \begin_layout Plain Layout
18020 if the float is already defined by the \SpecialChar LaTeX
18024 \begin_layout Description
18025 \begin_inset Flex Code
18028 \begin_layout Plain Layout
18035 \begin_inset Flex Code
18038 \begin_layout Plain Layout
18045 \begin_inset Quotes erd
18049 \begin_inset Quotes erd
18052 ] The command used to generate a list of floats of this type; the leading
18061 \begin_inset Flex Code
18064 \begin_layout Plain Layout
18070 is false, since there is no standard way to generate this command.
18072 \begin_inset Flex Code
18075 \begin_layout Plain Layout
18081 is true, since in that case there is a standard way to define the command.
18084 \begin_layout Description
18085 \begin_inset Flex Code
18088 \begin_layout Plain Layout
18095 \begin_inset Flex Code
18098 \begin_layout Plain Layout
18105 \begin_inset Quotes erd
18109 \begin_inset Quotes erd
18112 ] A title for a list of floats of this kind (list of figures, tables, or
18114 It is used for the screen label within \SpecialChar LyX
18115 , it is used by \SpecialChar LaTeX
18117 it is used as the title in the XHTML output.
18118 It will be translated to the document language.
18121 \begin_layout Description
18122 \begin_inset Flex Code
18125 \begin_layout Plain Layout
18132 \begin_inset Flex Code
18135 \begin_layout Plain Layout
18142 \begin_inset Quotes erd
18146 \begin_inset Quotes erd
18149 ] This (optional) argument determines whether floats of this class will
18150 be numbered within some sectional unit of the document.
18152 \begin_inset Flex Code
18155 \begin_layout Plain Layout
18162 \begin_inset Quotes eld
18166 \begin_inset Flex Code
18169 \begin_layout Plain Layout
18176 \begin_inset Quotes erd
18179 , the floats will be numbered within chapters.
18183 \begin_layout Description
18184 \begin_inset Flex Code
18187 \begin_layout Plain Layout
18194 \begin_inset Flex Code
18197 \begin_layout Plain Layout
18204 \begin_inset Quotes erd
18208 \begin_inset Quotes erd
18211 ] The default placement for the given class of floats.
18212 The string should be as in standard \SpecialChar LaTeX
18214 \begin_inset Flex Code
18217 \begin_layout Plain Layout
18224 \begin_inset Flex Code
18227 \begin_layout Plain Layout
18234 \begin_inset Flex Code
18237 \begin_layout Plain Layout
18244 \begin_inset Flex Code
18247 \begin_layout Plain Layout
18253 for top, bottom, page, and here, respectively.
18257 \begin_layout Plain Layout
18258 Note that the order of these letters in the string is irrelevant, like in
18265 On top of that there is a new type,
18266 \begin_inset Flex Code
18269 \begin_layout Plain Layout
18275 , which does not really correspond to a float, since it means: put it
18276 \begin_inset Quotes eld
18280 \begin_inset Quotes erd
18284 Note however that the
18285 \begin_inset Flex Code
18288 \begin_layout Plain Layout
18294 specifier is special and, because of implementation details, cannot be
18295 used in non-built in float types.
18296 If you do not understand what this means, just use
18297 \begin_inset Quotes eld
18301 \begin_inset Flex Code
18304 \begin_layout Plain Layout
18311 \begin_inset Quotes erd
18317 \begin_layout Description
18318 \begin_inset Flex Code
18321 \begin_layout Plain Layout
18328 \begin_inset Flex Code
18331 \begin_layout Plain Layout
18337 ] The prefix to use when creating labels referring to floats of this type.
18338 This allows the use of formatted references.
18339 Note that you can remove any
18340 \begin_inset Flex Code
18343 \begin_layout Plain Layout
18349 set by a copied style by using the special value
18350 \begin_inset Quotes eld
18354 \begin_inset Quotes erd
18357 , which must be all caps.
18360 \begin_layout Description
18361 \begin_inset Flex Code
18364 \begin_layout Plain Layout
18371 \begin_inset Flex Code
18374 \begin_layout Plain Layout
18381 \begin_inset Quotes erd
18385 \begin_inset Quotes erd
18388 ] The style used when defining the float using
18389 \begin_inset Flex Code
18392 \begin_layout Plain Layout
18403 \begin_layout Description
18404 \begin_inset Flex Code
18407 \begin_layout Plain Layout
18414 \begin_inset Flex Code
18417 \begin_layout Plain Layout
18424 \begin_inset Quotes erd
18428 \begin_inset Quotes erd
18432 \begin_inset Quotes eld
18436 \begin_inset Quotes erd
18439 of the new class of floats, like program or algorithm.
18440 After the appropriate
18441 \begin_inset Flex Code
18444 \begin_layout Plain Layout
18453 \begin_inset Flex Code
18456 \begin_layout Plain Layout
18465 \begin_inset Flex Code
18468 \begin_layout Plain Layout
18479 \begin_layout Description
18480 \begin_inset Flex Code
18483 \begin_layout Plain Layout
18490 \begin_inset Flex Code
18493 \begin_layout Plain Layout
18500 \begin_inset space \thinspace{}
18504 \begin_inset Flex Code
18507 \begin_layout Plain Layout
18515 ] Specifies whether this float is defined using the \SpecialChar LaTeX
18517 \begin_inset Flex Code
18520 \begin_layout Plain Layout
18526 , either by the class file, another package or on-the-fly by \SpecialChar LyX
18530 \begin_layout Standard
18531 Note that defining a float with type
18532 \begin_inset Flex Code
18535 \begin_layout Plain Layout
18543 automatically defines the corresponding counter with name
18544 \begin_inset Flex Code
18547 \begin_layout Plain Layout
18558 \begin_layout Subsection
18559 Flex insets and InsetLayout
18560 \begin_inset CommandInset label
18562 name "subsec:Flex-insets-and"
18569 \begin_layout Standard
18570 Flex insets come in three different kinds:
18573 \begin_layout Itemize
18575 \begin_inset Flex Code
18578 \begin_layout Plain Layout
18584 ): These define semantic markup corresponding to such \SpecialChar LaTeX
18586 \begin_inset Flex Code
18589 \begin_layout Plain Layout
18598 \begin_inset Flex Code
18601 \begin_layout Plain Layout
18612 \begin_layout Itemize
18614 \begin_inset Flex Code
18617 \begin_layout Plain Layout
18623 ): These can be used to define custom collapsible insets, similar to \SpecialChar TeX
18625 footnote, and the like.
18626 An obvious example is an endnote inset, which is defined in the
18627 \begin_inset Flex Code
18630 \begin_layout Plain Layout
18639 \begin_layout Itemize
18641 \begin_inset Flex Code
18644 \begin_layout Plain Layout
18650 ): For use with DocBook classes.
18653 \begin_layout Standard
18654 Flex insets are defined using the
18655 \begin_inset Flex Code
18658 \begin_layout Plain Layout
18664 tag, which shall be explained in a moment.
18667 \begin_layout Standard
18669 \begin_inset Flex Code
18672 \begin_layout Plain Layout
18678 tag also serves another function: It can be used to customize the general
18679 layout of many different types of insets.
18681 \begin_inset Flex Code
18684 \begin_layout Plain Layout
18690 can be used to customize the layout parameters for footnotes, marginal
18691 notes, note insets, \SpecialChar TeX
18692 code (ERT) insets, branches, listings, indexes, boxes,
18693 tables, algorithms, URLs, and captions, as well as to define Flex insets.
18696 \begin_layout Standard
18698 \begin_inset Flex Code
18701 \begin_layout Plain Layout
18707 definition must begin with a line of the form:
18710 \begin_layout LyX-Code
18714 \begin_layout Standard
18716 \begin_inset Flex Code
18719 \begin_layout Plain Layout
18725 indicates the inset whose layout is being defined, and here there are four
18729 \begin_layout Enumerate
18730 The layout for a pre-existing inset is being modified.
18731 In this case, can be
18732 \begin_inset Flex Code
18735 \begin_layout Plain Layout
18741 any one of the following:
18742 \begin_inset Flex Code
18745 \begin_layout Plain Layout
18752 \begin_inset Flex Code
18755 \begin_layout Plain Layout
18762 \begin_inset Flex Code
18765 \begin_layout Plain Layout
18772 \begin_inset Flex Code
18775 \begin_layout Plain Layout
18782 \begin_inset Flex Code
18785 \begin_layout Plain Layout
18792 \begin_inset Flex Code
18795 \begin_layout Plain Layout
18802 \begin_inset Flex Code
18805 \begin_layout Plain Layout
18812 \begin_inset Flex Code
18815 \begin_layout Plain Layout
18822 \begin_inset Flex Code
18825 \begin_layout Plain Layout
18832 \begin_inset Flex Code
18835 \begin_layout Plain Layout
18842 \begin_inset Flex Code
18845 \begin_layout Plain Layout
18852 \begin_inset Flex Code
18855 \begin_layout Plain Layout
18862 \begin_inset Flex Code
18865 \begin_layout Plain Layout
18872 \begin_inset Flex Code
18875 \begin_layout Plain Layout
18882 \begin_inset Flex Code
18885 \begin_layout Plain Layout
18892 \begin_inset Flex Code
18895 \begin_layout Plain Layout
18902 \begin_inset Flex Code
18905 \begin_layout Plain Layout
18912 \begin_inset Flex Code
18915 \begin_layout Plain Layout
18922 \begin_inset Flex Code
18925 \begin_layout Plain Layout
18932 \begin_inset Flex Code
18935 \begin_layout Plain Layout
18944 \begin_layout Enumerate
18945 The layout for a Flex inset is being defined.
18947 \begin_inset Flex Code
18950 \begin_layout Plain Layout
18956 must be of the form
18957 \begin_inset Quotes eld
18961 \begin_inset Flex Code
18964 \begin_layout Plain Layout
18971 \begin_inset Quotes erd
18975 \begin_inset Flex Code
18978 \begin_layout Plain Layout
18984 may be be any valid identifier not used by a pre-existing Flex inset.
18985 The identifier may include spaces, but in that case the whole thing must
18986 be wrapped in quotes.
18987 Note that the definition of a flex inset
18992 \begin_inset Flex Code
18995 \begin_layout Plain Layout
19001 entry, declaring which type of inset it defines.
19004 \begin_layout Enumerate
19005 The layout for user specific branch is being defined.
19007 \begin_inset Flex Code
19010 \begin_layout Plain Layout
19016 must be of the form
19017 \begin_inset Quotes eld
19021 \begin_inset Flex Code
19024 \begin_layout Plain Layout
19031 \begin_inset Quotes erd
19035 \begin_inset Flex Code
19038 \begin_layout Plain Layout
19044 may be be any valid identifier of branch defined in user's document.
19045 The identifier may include spaces, but in that case the whole thing must
19046 be wrapped in quotes.
19047 The main purpose of this feature is to allow \SpecialChar LaTeX
19048 wrapping around specific
19049 branches as user needs.
19052 \begin_layout Enumerate
19053 The layout of a user (or class) specific caption is being defined.
19055 \begin_inset Flex Code
19058 \begin_layout Plain Layout
19064 must be of the form
19065 \begin_inset Quotes eld
19069 \begin_inset Flex Code
19072 \begin_layout Plain Layout
19079 \begin_inset Quotes erd
19083 \begin_inset Flex Code
19086 \begin_layout Plain Layout
19092 specifies the name of the caption as it appears in the menu.
19093 Have a look at the standard caption (
19094 \begin_inset Flex Code
19097 \begin_layout Plain Layout
19103 ), the specific captions of the KOMA-Script classes (
19104 \begin_inset Flex Code
19107 \begin_layout Plain Layout
19114 \begin_inset Flex Code
19117 \begin_layout Plain Layout
19126 \begin_inset space ~
19130 \begin_inset Newline linebreak
19136 \begin_inset Flex Code
19139 \begin_layout Plain Layout
19145 ) for applications.
19148 \begin_layout Standard
19150 \begin_inset Flex Code
19153 \begin_layout Plain Layout
19159 definition can contain the following entries:
19162 \begin_layout Description
19163 \begin_inset Flex Code
19166 \begin_layout Plain Layout
19173 \begin_inset Flex Code
19176 \begin_layout Plain Layout
19182 =""] This inset will appear in the table of contents of the given type.
19183 An empty string disables.
19184 See also the OutlinerName and the IsTocCaption commands.
19185 This is only implemented for Flex insets.
19189 \begin_layout Description
19190 \begin_inset Flex Code
19193 \begin_layout Plain Layout
19200 \begin_inset Flex Code
19203 \begin_layout Plain Layout
19209 ] Defines argument number of a command\SpecialChar breakableslash
19210 environment associated with the current
19212 The definition must end with
19213 \begin_inset Flex Code
19216 \begin_layout Plain Layout
19224 \begin_inset CommandInset ref
19226 reference "subsec:Paragraph-Styles"
19233 \begin_layout Description
19234 \begin_inset Flex Code
19237 \begin_layout Plain Layout
19243 Preamble for changing language commands; see
19244 \begin_inset CommandInset ref
19246 reference "subsec:I18n"
19253 \begin_layout Description
19254 \begin_inset Flex Code
19257 \begin_layout Plain Layout
19264 \begin_inset Flex Code
19267 \begin_layout Plain Layout
19273 ] The color for the inset's background.
19275 \begin_inset CommandInset ref
19277 reference "chap:Names-of-colors"
19281 for a list of the available color names.
19284 \begin_layout Description
19285 \begin_inset Flex Code
19288 \begin_layout Plain Layout
19295 \begin_inset Flex Code
19298 \begin_layout Plain Layout
19307 \begin_inset space \thinspace{}
19311 \begin_inset Flex Code
19314 \begin_layout Plain Layout
19320 ] Whether to use the content of the inset as the label, when the inset is
19325 \begin_layout Description
19326 \begin_inset Flex Code
19329 \begin_layout Plain Layout
19336 \begin_inset Flex Code
19339 \begin_layout Plain Layout
19345 ] As with paragraph styles, see
19346 \begin_inset CommandInset ref
19348 reference "subsec:Paragraph-Styles"
19353 Note that you need to specify the complete type, e.
19354 \begin_inset space \thinspace{}
19358 \begin_inset space ~
19362 \begin_inset Flex Code
19365 \begin_layout Plain Layout
19366 CopyStyle Flex:<name>
19374 \begin_layout Description
19375 \begin_inset Flex Code
19378 \begin_layout Plain Layout
19385 \begin_inset Flex Code
19388 \begin_layout Plain Layout
19397 \begin_inset space \thinspace{}
19401 \begin_inset Flex Code
19404 \begin_layout Plain Layout
19410 ] Indicates whether the user may employ the Paragraph Settings dialog to
19411 customize the paragraph.
19414 \begin_layout Description
19415 \begin_inset Flex Code
19418 \begin_layout Plain Layout
19425 \begin_inset Flex Code
19428 \begin_layout Plain Layout
19435 \begin_inset Flex Code
19438 \begin_layout Plain Layout
19445 \begin_inset Flex Code
19448 \begin_layout Plain Layout
19454 , describing the rendering style used for the inset's frame and buttons.
19455 Footnotes generally use
19456 \begin_inset Flex Code
19459 \begin_layout Plain Layout
19465 , ERT insets generally
19466 \begin_inset Flex Code
19469 \begin_layout Plain Layout
19475 , and character styles
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
19511 \begin_inset space \thinspace{}
19517 \begin_inset Flex Code
19520 \begin_layout Plain Layout
19529 \begin_inset Flex Code
19532 \begin_layout Plain Layout
19539 \begin_inset Flex Code
19542 \begin_layout Plain Layout
19549 Indicates whether the environment will stand on its own in the output or
19550 will appear inline with the surrounding text.
19551 If set to false, it is supposed that the \SpecialChar LaTeX
19552 environment ignores white space
19553 (including one newline character) after the
19554 \begin_inset Flex Code
19557 \begin_layout Plain Layout
19570 \begin_inset Flex Code
19573 \begin_layout Plain Layout
19587 \change_inserted 731793113 1538674858
19591 \begin_layout Description
19593 \change_inserted 731793113 1538674891
19594 \begin_inset Flex Code
19597 \begin_layout Plain Layout
19599 \change_inserted 731793113 1538674863
19611 ,1] Allow the contents of the inset to be edited externally (using whatever
19612 editor is defined for the document's output format).
19617 \begin_layout Description
19618 \begin_inset Flex Code
19621 \begin_layout Plain Layout
19627 Required at the end of the
19628 \begin_inset Flex Code
19631 \begin_layout Plain Layout
19640 \begin_layout Description
19641 \begin_inset Flex Code
19644 \begin_layout Plain Layout
19650 The font used for both the text body
19656 \begin_inset CommandInset ref
19658 reference "subsec:Font-description"
19663 Note that defining this font automatically defines the
19664 \begin_inset Flex Code
19667 \begin_layout Plain Layout
19673 to the same value, so define this first and define
19674 \begin_inset Flex Code
19677 \begin_layout Plain Layout
19683 later if you want them to be different.
19686 \begin_layout Description
19687 \begin_inset Flex Code
19690 \begin_layout Plain Layout
19691 FixedWidthPreambleEncoding
19697 \begin_inset Flex Code
19700 \begin_layout Plain Layout
19709 \begin_inset space \thinspace{}
19713 \begin_inset Flex Code
19716 \begin_layout Plain Layout
19722 ] Force a fixed width encoding for the translated contents of
19723 \begin_inset Flex Code
19726 \begin_layout Plain Layout
19733 \begin_inset Flex Code
19736 \begin_layout Plain Layout
19742 code generated by this layout.
19743 This is needed for special \SpecialChar LaTeX
19748 that do not work with variable width encodings such as
19753 This setting is ignored if fully Unicode aware \SpecialChar LaTeX
19754 backends such as Xe\SpecialChar TeX
19756 Lua\SpecialChar TeX
19760 \begin_layout Description
19761 \begin_inset Flex Code
19764 \begin_layout Plain Layout
19765 ForceLocalFontSwitch
19771 \begin_inset Flex Code
19774 \begin_layout Plain Layout
19783 \begin_inset space \thinspace{}
19787 \begin_inset Flex Code
19790 \begin_layout Plain Layout
19796 ] When using babel, always use a local font switch (
19797 \begin_inset Flex Code
19800 \begin_layout Plain Layout
19808 ), never a global one (such as
19809 \begin_inset Flex Code
19812 \begin_layout Plain Layout
19823 \begin_layout Description
19824 \begin_inset Flex Code
19827 \begin_layout Plain Layout
19834 \begin_inset Flex Code
19837 \begin_layout Plain Layout
19846 \begin_inset space \thinspace{}
19850 \begin_inset Flex Code
19853 \begin_layout Plain Layout
19860 \begin_inset Quotes eld
19864 \begin_inset Quotes erd
19867 language, leading to Left-to-Right (Latin) output, e.
19868 \begin_inset space \thinspace{}
19872 \begin_inset space \space{}
19875 in \SpecialChar TeX
19880 \begin_layout Description
19881 \begin_inset Flex Code
19884 \begin_layout Plain Layout
19891 \begin_inset Flex Code
19894 \begin_layout Plain Layout
19903 \begin_inset space \thinspace{}
19907 \begin_inset Flex Code
19910 \begin_layout Plain Layout
19916 ] Force a a line break in the \SpecialChar LaTeX
19917 output before the inset starts and after
19919 This assures the inset itself is output on its own lines, for parsing purposes.
19922 \begin_layout Description
19923 \begin_inset Flex Code
19926 \begin_layout Plain Layout
19933 \begin_inset Flex Code
19936 \begin_layout Plain Layout
19945 \begin_inset space \thinspace{}
19949 \begin_inset Flex Code
19952 \begin_layout Plain Layout
19958 ] Indicates whether the
19959 \begin_inset Flex Code
19962 \begin_layout Plain Layout
19968 should be used or, instead, the user can change the paragraph style used
19973 \begin_layout Description
19974 \begin_inset Flex Code
19977 \begin_layout Plain Layout
19984 \begin_inset Flex Code
19987 \begin_layout Plain Layout
19996 \begin_inset space \thinspace{}
20000 \begin_inset Flex Code
20003 \begin_layout Plain Layout
20009 ] As with paragraph styles, see
20010 \begin_inset CommandInset ref
20012 reference "subsec:Paragraph-Styles"
20019 \begin_layout Description
20020 \begin_inset Flex Code
20023 \begin_layout Plain Layout
20029 These tags control the XHTML output.
20031 \begin_inset CommandInset ref
20033 reference "sec:Tags-for-XHTML"
20040 \begin_layout Description
20041 \begin_inset Flex Code
20044 \begin_layout Plain Layout
20051 \begin_inset Flex Code
20054 \begin_layout Plain Layout
20063 \begin_inset space \thinspace{}
20067 \begin_inset Flex Code
20070 \begin_layout Plain Layout
20076 ] Whether to include the contents of this inset in the strings generated
20077 for the `Outline' pane for all table of contents, regardless of the AddToToc
20079 One would not, for example, want the content of a footnote in a section
20080 header to be included in the TOC displayed in the outline, but one would
20081 normally want the content of a character style displayed.
20082 Default is false: not to include.
20085 \begin_layout Description
20086 \begin_inset Flex Code
20089 \begin_layout Plain Layout
20096 \begin_inset Flex Code
20099 \begin_layout Plain Layout
20108 \begin_inset space \thinspace{}
20112 \begin_inset Flex Code
20115 \begin_layout Plain Layout
20121 ] If this is set to 1 and AddToToc is enabled, the inset adds a summary
20122 of its contents in its item in the table of contents.
20123 Otherwise, only the label appears.
20126 \begin_layout Description
20127 \begin_inset Flex Code
20130 \begin_layout Plain Layout
20139 \begin_inset Flex Code
20142 \begin_layout Plain Layout
20151 \begin_inset space \thinspace{}
20155 \begin_inset Flex Code
20158 \begin_layout Plain Layout
20164 ] As with paragraph styles, see
20165 \begin_inset CommandInset ref
20167 reference "subsec:Paragraph-Styles"
20174 \begin_layout Description
20175 \begin_inset Flex Code
20178 \begin_layout Plain Layout
20184 The font used for the label.
20186 \begin_inset CommandInset ref
20188 reference "subsec:Font-description"
20193 Note that this definition can never appear before
20194 \begin_inset Flex Code
20197 \begin_layout Plain Layout
20203 , lest it be ineffective.
20206 \begin_layout Description
20207 \begin_inset Flex Code
20210 \begin_layout Plain Layout
20217 \begin_inset Flex Code
20220 \begin_layout Plain Layout
20227 \begin_inset Quotes erd
20231 \begin_inset Quotes erd
20234 ] What will be displayed on the button or elsewhere as the inset label.
20236 \begin_inset Flex Code
20239 \begin_layout Plain Layout
20247 \begin_inset Flex Code
20250 \begin_layout Plain Layout
20256 ) modify this label on the fly.
20259 \begin_layout Description
20260 \begin_inset Flex Code
20263 \begin_layout Plain Layout
20269 Language dependent preamble; see
20270 \begin_inset CommandInset ref
20272 reference "subsec:I18n"
20279 \begin_layout Description
20280 \begin_inset Flex Code
20283 \begin_layout Plain Layout
20290 \begin_inset Flex Code
20293 \begin_layout Plain Layout
20299 ] The name of the corresponding \SpecialChar LaTeX
20301 Either the environment or command name.
20304 \begin_layout Description
20305 \begin_inset Flex Code
20308 \begin_layout Plain Layout
20315 \begin_inset Flex Code
20318 \begin_layout Plain Layout
20324 ] The optional parameter for the corresponding
20325 \begin_inset Flex Code
20328 \begin_layout Plain Layout
20334 stuff, including possible bracket pairs like
20335 \begin_inset Flex Code
20338 \begin_layout Plain Layout
20345 This parameter cannot be changed from within \SpecialChar LyX
20347 \begin_inset Flex Code
20350 \begin_layout Plain Layout
20356 for customizable parameters).
20357 It will be output as is after all \SpecialChar LaTeX
20359 \begin_inset Flex Code
20362 \begin_layout Plain Layout
20371 \begin_layout Description
20372 \begin_inset Flex Code
20375 \begin_layout Plain Layout
20382 \begin_inset Flex Code
20385 \begin_layout Plain Layout
20386 Command, Environment, None
20391 ] How the style should be translated into \SpecialChar LaTeX
20396 \begin_layout Plain Layout
20397 \begin_inset Flex Code
20400 \begin_layout Plain Layout
20406 is perhaps a bit misleading, since these rules apply to SGML classes too.
20407 Visit the SGML class files for specific examples.
20416 \begin_layout Description
20417 \begin_inset Flex Code
20420 \begin_layout Plain Layout
20426 means nothing special
20429 \begin_layout Description
20430 \begin_inset Flex Code
20433 \begin_layout Plain Layout
20440 \begin_inset Flex Code
20443 \begin_layout Plain Layout
20450 {\SpecialChar ldots
20459 \begin_layout Description
20460 \begin_inset Flex Code
20463 \begin_layout Plain Layout
20470 \begin_inset Flex Code
20473 \begin_layout Plain Layout
20480 }\SpecialChar ldots
20495 \begin_layout Standard
20496 Putting the last few things together, the \SpecialChar LaTeX
20497 output will be either:
20500 \begin_layout LyX-Code
20503 LatexName[LatexParam]{\SpecialChar ldots
20507 \begin_layout Standard
20511 \begin_layout LyX-Code
20514 begin{LatexName}[LatexParam] \SpecialChar ldots
20520 \begin_layout Standard
20521 depending upon the \SpecialChar LaTeX
20526 \begin_layout Description
20527 \begin_inset Flex Code
20530 \begin_layout Plain Layout
20537 \begin_inset Flex Code
20540 \begin_layout Plain Layout
20546 ] A string that is put at the beginning of the layout content.
20547 A line break in the output can be indicated by
20548 \begin_inset Flex Code
20551 \begin_layout Plain Layout
20560 \begin_layout Description
20561 \begin_inset Flex Code
20564 \begin_layout Plain Layout
20571 \begin_inset Flex Code
20574 \begin_layout Plain Layout
20581 \begin_inset Flex Code
20584 \begin_layout Plain Layout
20591 \begin_inset Flex Code
20594 \begin_layout Plain Layout
20601 \begin_inset Flex Code
20604 \begin_layout Plain Layout
20610 (indicating a dummy definition ending definitions of charstyles, etc).
20611 This entry is required in and is only meaningful for Flex insets.
20612 Among other things, it determines on which menu this inset will appear.
20614 \begin_inset Flex Code
20617 \begin_layout Plain Layout
20624 \begin_inset Flex Code
20627 \begin_layout Plain Layout
20633 will automatically set
20634 \begin_inset Flex Code
20637 \begin_layout Plain Layout
20644 \begin_inset Flex Code
20647 \begin_layout Plain Layout
20655 \begin_inset Flex Code
20658 \begin_layout Plain Layout
20664 can be set to true, or
20665 \begin_inset Flex Code
20668 \begin_layout Plain Layout
20675 \begin_inset Flex Code
20678 \begin_layout Plain Layout
20684 insets by setting it
20689 \begin_inset Flex Code
20692 \begin_layout Plain Layout
20699 \change_inserted -712698321 1555575738
20703 \begin_layout Description
20705 \change_inserted -712698321 1555575844
20706 \begin_inset Flex Code
20709 \begin_layout Plain Layout
20711 \change_inserted -712698321 1555575740
20718 \begin_inset Flex Code
20721 \begin_layout Plain Layout
20723 \change_inserted -712698321 1555575740
20729 A dedicated string for the menu.
20730 You can define an accelerator by appending the respective character to
20731 the string, divided by
20732 \begin_inset Quotes eld
20736 \begin_inset Quotes erd
20740 \begin_inset space \thinspace{}
20744 \begin_inset space \space{}
20748 \begin_inset Quotes eld
20752 \begin_inset Flex Code
20755 \begin_layout Plain Layout
20757 \change_inserted -712698321 1555575781
20764 \begin_inset Quotes erd
20768 This specification is optional.
20769 If it is not given the inset name as specified in the type declaration
20770 will be used instead for the menu.
20775 \begin_layout Description
20776 \begin_inset Flex Code
20779 \begin_layout Plain Layout
20786 \begin_inset Flex Code
20789 \begin_layout Plain Layout
20798 \begin_inset space \thinspace{}
20802 \begin_inset Flex Code
20805 \begin_layout Plain Layout
20811 ] Whether multiple paragraphs are permitted in this inset.
20813 \begin_inset Flex Code
20816 \begin_layout Plain Layout
20822 to the same value and
20823 \begin_inset Flex Code
20826 \begin_layout Plain Layout
20832 to the opposite value.
20833 These can be reset to other values, if they are used
20838 \begin_inset Flex Code
20841 \begin_layout Plain Layout
20851 \begin_layout Description
20852 \begin_inset Flex Code
20855 \begin_layout Plain Layout
20862 \begin_inset Flex Code
20865 \begin_layout Plain Layout
20874 \begin_inset space \thinspace{}
20878 \begin_inset Flex Code
20881 \begin_layout Plain Layout
20887 ] Whether fragile commands in this inset should be
20888 \begin_inset Flex Code
20891 \begin_layout Plain Layout
20904 whether the command should itself be protected.) Default is false.
20905 \change_inserted -712698321 1523633958
20909 \begin_layout Description
20911 \change_inserted -712698321 1552395786
20912 \begin_inset Flex Code
20915 \begin_layout Plain Layout
20917 \change_inserted -712698321 1523633961
20924 \begin_inset Flex Code
20927 \begin_layout Plain Layout
20929 \change_inserted -712698321 1523633958
20938 \begin_inset space \thinspace{}
20942 \begin_inset Flex Code
20945 \begin_layout Plain Layout
20947 \change_inserted -712698321 1523633958
20953 ] This causes macros that contain this inset to be protected with
20954 \begin_inset Flex Code
20957 \begin_layout Plain Layout
20959 \change_inserted -712698321 1523634038
20974 ) if necessary and thus allows (some) verbatim stuff in macros.
20978 \begin_layout Description
20980 \change_inserted -712698321 1555579651
20981 \begin_inset Flex Code
20984 \begin_layout Plain Layout
20986 \change_inserted -712698321 1552395787
20993 \begin_inset Flex Code
20996 \begin_layout Plain Layout
20998 \change_inserted -712698321 1552395787
21007 \begin_inset space \thinspace{}
21011 \begin_inset Flex Code
21014 \begin_layout Plain Layout
21016 \change_inserted -712698321 1552395787
21022 ] Whether specific commands in this inset (such as
21023 \begin_inset Flex Code
21026 \begin_layout Plain Layout
21028 \change_inserted -712698321 1552395787
21037 \begin_inset Flex Code
21040 \begin_layout Plain Layout
21042 \change_inserted -712698321 1552395787
21050 ) should be protected in an
21051 \begin_inset Flex Code
21054 \begin_layout Plain Layout
21056 \change_inserted -712698321 1552395787
21065 This is particularly needed for insets that draw on
21073 commands which parse their content in complex ways.
21077 \begin_layout Description
21079 \change_inserted -712698321 1555579742
21080 \begin_inset Flex Code
21083 \begin_layout Plain Layout
21085 \change_inserted -712698321 1555579658
21092 \begin_inset Flex Code
21095 \begin_layout Plain Layout
21097 \change_inserted -712698321 1555579651
21103 Option to define a different command (from the default
21104 \begin_inset Flex Code
21107 \begin_layout Plain Layout
21109 \change_inserted -712698321 1555579742
21121 ) to be used for line breaks.
21122 The initial backslash must not be specified.
21127 \begin_layout Description
21128 \begin_inset Flex Code
21131 \begin_layout Plain Layout
21138 \begin_inset Flex Code
21141 \begin_layout Plain Layout
21147 ] Deletes an existing
21148 \begin_inset Flex Code
21151 \begin_layout Plain Layout
21160 \begin_layout Description
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
21190 that has replaced this
21191 \begin_inset Flex Code
21194 \begin_layout Plain Layout
21201 This is used to rename an
21202 \begin_inset Flex Code
21205 \begin_layout Plain Layout
21211 , while keeping backward compatibility.
21212 \change_inserted -712698321 1559491850
21216 \begin_layout Description
21218 \change_inserted -712698321 1559492002
21219 \begin_inset Flex Code
21222 \begin_layout Plain Layout
21224 \change_inserted -712698321 1559491854
21231 \begin_inset Flex Code
21234 \begin_layout Plain Layout
21236 \change_inserted -712698321 1559491850
21245 \begin_inset space \thinspace{}
21249 \begin_inset Flex Code
21252 \begin_layout Plain Layout
21254 \change_inserted -712698321 1559491850
21260 ] If this is set to
21261 \begin_inset Flex Code
21264 \begin_layout Plain Layout
21266 \change_inserted -712698321 1559491881
21274 , paragraph breaks will be ignored in the output.
21275 This might be useful for insets where the content should be alignable on
21276 different lines only in the \SpecialChar LyX
21277 workarea, without any effect in the output.
21282 \begin_layout Description
21283 \begin_inset Flex Code
21286 \begin_layout Plain Layout
21293 \begin_inset Flex Code
21296 \begin_layout Plain Layout
21305 \begin_inset space \thinspace{}
21309 \begin_inset Flex Code
21312 \begin_layout Plain Layout
21318 ] As with paragraph styles, see
21319 \begin_inset CommandInset ref
21321 reference "subsec:Paragraph-Styles"
21329 \begin_layout Description
21330 \begin_inset Flex Code
21333 \begin_layout Plain Layout
21340 \begin_inset Flex Code
21343 \begin_layout Plain Layout
21352 \begin_inset space \thinspace{}
21356 \begin_inset Flex Code
21359 \begin_layout Plain Layout
21365 ] As with paragraph styles, see
21366 \begin_inset CommandInset ref
21368 reference "subsec:Paragraph-Styles"
21376 \begin_layout Description
21377 \begin_inset Flex Code
21380 \begin_layout Plain Layout
21386 As with paragraph styles, see
21387 \begin_inset CommandInset ref
21389 reference "subsec:Paragraph-Styles"
21396 \begin_layout Description
21397 \begin_inset Flex Code
21400 \begin_layout Plain Layout
21407 \begin_inset Flex Code
21410 \begin_layout Plain Layout
21416 ] The prefix to use when creating labels referring to insets of this type.
21417 This allows the use of formatted references.
21420 \begin_layout Description
21421 \begin_inset Flex Code
21424 \begin_layout Plain Layout
21431 \begin_inset Flex Code
21434 \begin_layout Plain Layout
21440 ] As with paragraph styles, see
21441 \begin_inset CommandInset ref
21443 reference "subsec:Paragraph-Styles"
21450 \begin_layout Description
21451 \begin_inset Flex Code
21454 \begin_layout Plain Layout
21461 \begin_inset Flex Code
21464 \begin_layout Plain Layout
21473 \begin_inset space \thinspace{}
21477 \begin_inset Flex Code
21480 \begin_layout Plain Layout
21486 ] Resets the \SpecialChar LaTeX
21487 arguments of this layout (as defined via the
21488 \begin_inset Flex Code
21491 \begin_layout Plain Layout
21498 This is useful if you have copied a style via
21499 \begin_inset Flex Code
21502 \begin_layout Plain Layout
21508 , but you do not want to inherit its (required and optional) arguments.
21511 \begin_layout Description
21512 \begin_inset Flex Code
21515 \begin_layout Plain Layout
21522 \begin_inset Flex Code
21525 \begin_layout Plain Layout
21532 \begin_inset space \thinspace{}
21536 \begin_inset Flex Code
21539 \begin_layout Plain Layout
21547 ] Whether this inset should use the font of its surrounding environment
21549 Default is false: use the font of the surrounding environment.
21552 \begin_layout Description
21553 \begin_inset Flex Code
21556 \begin_layout Plain Layout
21563 \begin_inset Flex Code
21566 \begin_layout Plain Layout
21572 ] A string that is put at the end of the layout content.
21573 A line break in the output can be indicated by
21574 \begin_inset Flex Code
21577 \begin_layout Plain Layout
21586 \begin_layout Description
21587 \begin_inset Flex Code
21590 \begin_layout Plain Layout
21597 \begin_inset Flex Code
21600 \begin_layout Plain Layout
21607 \begin_inset space \thinspace{}
21611 \begin_inset Flex Code
21614 \begin_layout Plain Layout
21622 ] Allow spell-checking the contents of this inset.
21626 \begin_layout Subsection
21628 \begin_inset CommandInset label
21630 name "subsec:Counters"
21637 \begin_layout Standard
21638 It is necessary to define the counters (
21639 \begin_inset Flex Noun
21642 \begin_layout Plain Layout
21649 \begin_inset Flex Noun
21652 \begin_layout Plain Layout
21658 , \SpecialChar ldots
21659 ) in the text class itself.
21660 The standard counters are defined in the file
21661 \begin_inset Flex Code
21664 \begin_layout Plain Layout
21670 , so you may have to do no more than add
21673 \begin_layout LyX-Code
21674 Input stdcounters.inc
21677 \begin_layout Standard
21678 to your layout file to get them to work.
21679 But if you want to define custom counters, then you can do so.
21680 The counter declaration must begin with:
21683 \begin_layout LyX-Code
21684 Counter CounterName
21687 \begin_layout Standard
21689 \begin_inset Flex Code
21692 \begin_layout Plain Layout
21698 ' is replaced by the name of the counter.
21699 And it must end with
21700 \begin_inset Quotes eld
21704 \begin_inset Flex Code
21707 \begin_layout Plain Layout
21714 \begin_inset Quotes erd
21718 The following parameters can also be used:
21721 \begin_layout Description
21722 \begin_inset Flex Code
21725 \begin_layout Plain Layout
21732 \begin_inset Flex Code
21735 \begin_layout Plain Layout
21741 ] Sets the initial value for the counter, to which it will be reset whenever
21743 Normally, one will want the default, 1.
21746 \begin_layout Description
21747 \begin_inset Flex Code
21750 \begin_layout Plain Layout
21757 \begin_inset Flex Code
21760 \begin_layout Plain Layout
21767 \begin_inset Quotes erd
21771 \begin_inset Quotes erd
21774 ] When defined, this string defines how the counter is displayed.
21775 Setting this value sets
21776 \begin_inset Flex Code
21779 \begin_layout Plain Layout
21780 LabelStringAppendix
21786 The following special constructs can be used in the string:
21790 \begin_layout Itemize
21791 \begin_inset Flex Code
21794 \begin_layout Plain Layout
21802 will be replaced by the expansion of the
21803 \begin_inset Flex Code
21806 \begin_layout Plain Layout
21813 \begin_inset Flex Code
21816 \begin_layout Plain Layout
21817 LabelStringAppendix
21823 \begin_inset Flex Code
21826 \begin_layout Plain Layout
21836 \begin_layout Itemize
21837 counter values can be expressed using \SpecialChar LaTeX
21839 \begin_inset Newline newline
21843 \begin_inset Flex Code
21846 \begin_layout Plain Layout
21863 \begin_inset Flex Code
21866 \begin_layout Plain Layout
21878 \begin_layout Plain Layout
21888 Actually, the situation is a bit more complicated: any
21907 other than those described below will produce arabic numerals.
21908 It would not be surprising to see this change in the future.
21914 \begin_inset Flex Code
21917 \begin_layout Plain Layout
21923 : 1, 2, 3,\SpecialChar ldots
21925 \begin_inset Flex Code
21928 \begin_layout Plain Layout
21934 for lower-case letters: a, b, c, \SpecialChar ldots
21936 \begin_inset Flex Code
21939 \begin_layout Plain Layout
21945 for upper-case letters: A, B, C, \SpecialChar ldots
21947 \begin_inset Flex Code
21950 \begin_layout Plain Layout
21956 for lower-case roman numerals: i, ii, iii, \SpecialChar ldots
21958 \begin_inset Flex Code
21961 \begin_layout Plain Layout
21967 for upper-case roman numerals: I, II, III\SpecialChar ldots
21969 \begin_inset Flex Code
21972 \begin_layout Plain Layout
21978 for hebrew numerals.
21982 \begin_layout Standard
21983 If LabelString is not defined, a default value is constructed as follows:
21984 if the counter has a master counter
21985 \begin_inset Flex Code
21988 \begin_layout Plain Layout
21995 \begin_inset Flex Code
21998 \begin_layout Plain Layout
22005 \begin_inset Newline newline
22009 \begin_inset Flex Code
22012 \begin_layout Plain Layout
22022 is used; otherwise the string
22023 \begin_inset Flex Code
22026 \begin_layout Plain Layout
22037 \begin_layout Description
22038 \begin_inset Flex Code
22041 \begin_layout Plain Layout
22042 LabelStringAppendix
22048 \begin_inset Flex Code
22051 \begin_layout Plain Layout
22058 \begin_inset Quotes erd
22062 \begin_inset Quotes erd
22066 \begin_inset Flex Code
22069 \begin_layout Plain Layout
22075 , but for use in the Appendix.
22078 \begin_layout Description
22079 \begin_inset Flex Code
22082 \begin_layout Plain Layout
22089 \begin_inset Flex Code
22092 \begin_layout Plain Layout
22099 \begin_inset Quotes erd
22103 \begin_inset Quotes erd
22106 ] A format for use with formatted references to this counter.
22107 For example, one might want to have references to section numbers appear
22109 \begin_inset Quotes eld
22113 \begin_inset Quotes erd
22117 The string should contain
22118 \begin_inset Quotes eld
22122 \begin_inset Quotes erd
22126 This will be replaced by the counter number itself.
22127 So, for sections, it would be: Section ##.
22130 \begin_layout Description
22131 \begin_inset Flex Code
22134 \begin_layout Plain Layout
22141 \begin_inset Flex Code
22144 \begin_layout Plain Layout
22151 \begin_inset Quotes erd
22155 \begin_inset Quotes erd
22158 ] If this is set to the name of another counter, the present counter will
22159 be reset every time the other one is increased.
22161 \begin_inset Flex Code
22164 \begin_layout Plain Layout
22171 \begin_inset Flex Code
22174 \begin_layout Plain Layout
22183 \begin_layout Subsection
22185 \begin_inset CommandInset label
22187 name "subsec:Font-description"
22194 \begin_layout Standard
22195 A font description looks like this:
22198 \begin_layout LyX-Code
22215 \begin_layout LyX-Code
22219 \begin_layout LyX-Code
22223 \begin_layout Standard
22224 The following commands are available:
22227 \begin_layout Description
22228 \begin_inset Flex Code
22231 \begin_layout Plain Layout
22238 \begin_inset Flex Code
22241 \begin_layout Plain Layout
22250 \begin_inset Flex Code
22253 \begin_layout Plain Layout
22260 \begin_inset Flex Code
22263 \begin_layout Plain Layout
22270 \begin_inset Flex Code
22273 \begin_layout Plain Layout
22280 \begin_inset Flex Code
22283 \begin_layout Plain Layout
22290 \begin_inset Flex Code
22293 \begin_layout Plain Layout
22300 \begin_inset Flex Code
22303 \begin_layout Plain Layout
22310 \begin_inset Flex Code
22313 \begin_layout Plain Layout
22320 \begin_inset Flex Code
22323 \begin_layout Plain Layout
22330 \begin_inset Flex Code
22333 \begin_layout Plain Layout
22340 \begin_inset Flex Code
22343 \begin_layout Plain Layout
22350 \begin_inset Flex Code
22353 \begin_layout Plain Layout
22360 \begin_inset Flex Code
22363 \begin_layout Plain Layout
22370 \begin_inset Flex Code
22373 \begin_layout Plain Layout
22380 \begin_inset Flex Code
22383 \begin_layout Plain Layout
22390 \begin_inset Flex Code
22393 \begin_layout Plain Layout
22400 \begin_inset Flex Code
22403 \begin_layout Plain Layout
22410 \begin_inset Flex Code
22413 \begin_layout Plain Layout
22420 \begin_inset Flex Code
22423 \begin_layout Plain Layout
22430 \begin_inset Flex Code
22433 \begin_layout Plain Layout
22442 \begin_layout Description
22443 \begin_inset Flex Code
22446 \begin_layout Plain Layout
22453 \begin_inset Flex Code
22456 \begin_layout Plain Layout
22465 \begin_inset Flex Code
22468 \begin_layout Plain Layout
22475 \begin_inset Flex Code
22478 \begin_layout Plain Layout
22487 \begin_layout Description
22488 \begin_inset Flex Code
22491 \begin_layout Plain Layout
22498 \begin_inset Flex Code
22501 \begin_layout Plain Layout
22507 ] Valid arguments are:
22508 \begin_inset Flex Code
22511 \begin_layout Plain Layout
22518 \begin_inset Flex Code
22521 \begin_layout Plain Layout
22528 \begin_inset Flex Code
22531 \begin_layout Plain Layout
22538 \begin_inset Flex Code
22541 \begin_layout Plain Layout
22548 \begin_inset Flex Code
22551 \begin_layout Plain Layout
22558 \begin_inset Flex Code
22561 \begin_layout Plain Layout
22568 \begin_inset Flex Code
22571 \begin_layout Plain Layout
22578 \begin_inset Flex Code
22581 \begin_layout Plain Layout
22588 \begin_inset Flex Code
22591 \begin_layout Plain Layout
22598 \begin_inset Flex Code
22601 \begin_layout Plain Layout
22608 \begin_inset Flex Code
22611 \begin_layout Plain Layout
22618 \begin_inset Flex Code
22621 \begin_layout Plain Layout
22628 Each of these turns on or off the corresponding attribute.
22630 \begin_inset Flex Code
22633 \begin_layout Plain Layout
22639 turns on emphasis, and
22640 \begin_inset Flex Code
22643 \begin_layout Plain Layout
22651 \begin_inset Newline newline
22654 If the latter seems puzzling, remember that the font settings for the present
22655 context are generally inherited from the surrounding context.
22657 \begin_inset Flex Code
22660 \begin_layout Plain Layout
22666 would turn off the emphasis that was anyway in effect, say, in a theorem
22670 \begin_layout Description
22671 \begin_inset Flex Code
22674 \begin_layout Plain Layout
22681 \begin_inset Flex Code
22684 \begin_layout Plain Layout
22693 \begin_inset Flex Code
22696 \begin_layout Plain Layout
22705 \begin_layout Description
22706 \begin_inset Flex Code
22709 \begin_layout Plain Layout
22716 \begin_inset Flex Code
22719 \begin_layout Plain Layout
22728 \begin_inset Flex Code
22731 \begin_layout Plain Layout
22738 \begin_inset Flex Code
22741 \begin_layout Plain Layout
22748 \begin_inset Flex Code
22751 \begin_layout Plain Layout
22760 \begin_layout Description
22761 \begin_inset Flex Code
22764 \begin_layout Plain Layout
22771 \begin_inset Flex Code
22774 \begin_layout Plain Layout
22781 \begin_inset Flex Code
22784 \begin_layout Plain Layout
22791 \begin_inset Flex Code
22794 \begin_layout Plain Layout
22803 \begin_inset Flex Code
22806 \begin_layout Plain Layout
22813 \begin_inset Flex Code
22816 \begin_layout Plain Layout
22823 \begin_inset Flex Code
22826 \begin_layout Plain Layout
22833 \begin_inset Flex Code
22836 \begin_layout Plain Layout
22843 \begin_inset Flex Code
22846 \begin_layout Plain Layout
22855 \begin_layout Subsection
22856 \begin_inset CommandInset label
22858 name "subsec:Citation-engine-description"
22862 Cite engine description
22865 \begin_layout Standard
22867 \begin_inset Flex Code
22870 \begin_layout Plain Layout
22876 blocks, as used mainly in cite engine files (see
22877 \begin_inset CommandInset ref
22879 reference "subsec:Cite-Engine-Files"
22886 ), define the citation commands provided by a specific
22887 \begin_inset Quotes eld
22891 \begin_inset Quotes erd
22895 A cite engine, in \SpecialChar LyX
22896 terms, is way specific way to format citations, using
22897 numbers, author names and/or years.
22898 Currently, \SpecialChar LyX
22899 supports three such engine types, namely:
22902 \begin_layout Enumerate
22903 \begin_inset Flex Code
22906 \begin_layout Plain Layout
22912 : the default Bib\SpecialChar TeX
22913 way to format citations, a simple numeric style (e.
22914 \begin_inset space \thinspace{}
22918 \begin_inset Quotes eld
22922 \begin_inset Quotes erd
22928 \begin_layout Enumerate
22929 \begin_inset Flex Code
22932 \begin_layout Plain Layout
22938 : Harvard-styled citations using author names and publication year (e.
22939 \begin_inset space \thinspace{}
22943 \begin_inset Quotes eld
22946 Smith and Miller (2017b)
22947 \begin_inset Quotes erd
22953 \begin_layout Enumerate
22954 \begin_inset Flex Code
22957 \begin_layout Plain Layout
22963 : extended numerical citations that also allow for author or title next
22965 \begin_inset space \thinspace{}
22969 \begin_inset Quotes eld
22972 Smith and Miller [1]
22973 \begin_inset Quotes erd
22979 \begin_layout Standard
22980 \begin_inset Flex Code
22983 \begin_layout Plain Layout
22989 blocks look like this:
22992 \begin_layout LyX-Code
22996 \begin_layout LyX-Code
23000 \begin_layout LyX-Code
23004 \begin_layout LyX-Code
23005 citeyearpar[][]=parencite*
23008 \begin_layout LyX-Code
23012 \begin_layout LyX-Code
23016 \begin_layout Standard
23018 \begin_inset Flex Code
23021 \begin_layout Plain Layout
23027 denotes the engine.
23028 The individual lines respectively define a cite command or cite command
23029 paradigm supported by this engine.
23030 The line can be as simple as a cite command that is used both to name the
23031 respective \SpecialChar LyX
23032 command and the \SpecialChar LaTeX
23033 output or more complex in order to differentiate
23035 The full syntax is:
23038 \begin_layout LyX-Code
23039 LyXName|alias$*<!_stardesc!_stardesctooltip>[][]=latexcmd
23042 \begin_layout Itemize
23043 \begin_inset Flex Code
23046 \begin_layout Plain Layout
23052 : The name as used in the
23053 \begin_inset Flex Code
23056 \begin_layout Plain Layout
23066 \begin_layout Standard
23067 For portability reasons, we try to use the same name for same-formatted
23068 commands in different cite packages (thus many names stem from natbib,
23069 and thus we need to differentiate a
23070 \begin_inset Flex Code
23073 \begin_layout Plain Layout
23079 sometimes, if the \SpecialChar LaTeX
23080 command names differ).
23084 \begin_layout Itemize
23085 \begin_inset Flex Code
23088 \begin_layout Plain Layout
23094 : a (comma-separated) list of commands that fall back to the given
23095 \begin_inset Flex Code
23098 \begin_layout Plain Layout
23104 in the current engine.
23105 This eases the switch of citation packages and engines.
23107 \begin_inset Flex Code
23110 \begin_layout Plain Layout
23117 \begin_inset Flex Code
23120 \begin_layout Plain Layout
23126 in layout definitions.
23129 \begin_layout Itemize
23130 \begin_inset Flex Code
23133 \begin_layout Plain Layout
23139 : The actual \SpecialChar LaTeX
23140 command that is output.
23144 \begin_layout Standard
23145 \begin_inset Flex Code
23148 \begin_layout Plain Layout
23155 \begin_inset Flex Code
23158 \begin_layout Plain Layout
23166 \begin_inset Flex Code
23169 \begin_layout Plain Layout
23176 \begin_inset Flex Code
23179 \begin_layout Plain Layout
23185 will be output to \SpecialChar LaTeX
23189 \begin_layout Standard
23193 \begin_layout Itemize
23194 Capitalization indicates that the command also has a capitalized form (
23195 \begin_inset Flex Code
23198 \begin_layout Plain Layout
23208 \begin_inset Flex Code
23211 \begin_layout Plain Layout
23220 These usually enforce up-casing of name prefixes (
23225 \begin_inset Formula $\Rightarrow$
23235 \begin_layout Itemize
23237 \begin_inset Flex Code
23240 \begin_layout Plain Layout
23246 indicate the number of optional arguments (there can be 0–2).
23249 \begin_layout Itemize
23251 \begin_inset Flex Code
23254 \begin_layout Plain Layout
23260 indicates there is a starred version of the command (
23261 \begin_inset Flex Code
23264 \begin_layout Plain Layout
23274 \begin_inset Flex Code
23277 \begin_layout Plain Layout
23290 \begin_layout Standard
23291 By default, the starred version means: Output all authors even if it should
23293 \begin_inset Quotes eld
23297 \begin_inset Quotes erd
23301 \begin_inset Flex Code
23304 \begin_layout Plain Layout
23313 \begin_layout Standard
23314 If the star has a different meaning for a given command, it can be specified
23316 \begin_inset Flex Code
23319 \begin_layout Plain Layout
23320 <!_stardesc!_stardesctooltip>
23326 Maximal two translatable macro keywords, marked by the prefix
23327 \begin_inset Flex Code
23330 \begin_layout Plain Layout
23337 The first points to the string that replaces the
23338 \begin_inset Quotes eld
23342 \begin_inset Quotes erd
23345 checkbox label in the citation dialog, the second one to an optional tool
23346 tip for this checkbox.
23350 \begin_layout Standard
23351 Note that these two macros have to be defined in a
23352 \begin_inset Flex Code
23355 \begin_layout Plain Layout
23361 (see next section), dropping the
23362 \begin_inset Flex Code
23365 \begin_layout Plain Layout
23371 from the prefix, like this:
23374 \begin_layout LyX-Code
23375 _stardesc Sta&rred command label
23378 \begin_layout LyX-Code
23379 _stardesctooltip Tooltip for the starred command checkbox.
23383 \begin_layout Itemize
23385 \begin_inset Flex Code
23388 \begin_layout Plain Layout
23394 indicates that this command features
23395 \begin_inset Quotes eld
23398 qualified citation lists
23399 \begin_inset Quotes erd
23407 -specific feature for multi-reference citations where an individual pre-
23408 and postnote can be given to each reference in the list.
23409 Please refer to the
23413 manual for details.
23414 \change_inserted -712698321 1526898670
23418 \begin_layout Standard
23420 \change_inserted -712698321 1526899524
23421 If you want to add a cite command to a cite engine (e.
23422 \begin_inset space \thinspace{}
23425 g., add a specific command provided by a class), you can use
23426 \begin_inset Flex Code
23429 \begin_layout Plain Layout
23431 \change_inserted -712698321 1526898768
23432 AddToCiteEngine <engine type> \SpecialChar ldots
23441 Note that only cite commands that do not exist yet are added.
23446 \begin_layout Subsection
23447 \begin_inset CommandInset label
23449 name "subsec:Citation-format-description"
23453 Cite format description
23456 \begin_layout Standard
23458 \begin_inset Flex Code
23461 \begin_layout Plain Layout
23467 blocks are used to describe how bibliographic information should be displayed,
23468 both within \SpecialChar LyX
23469 itself (in the citation dialog and in tooltips, for example)
23470 and in XHTML output.
23471 Such a block might look like this:
23474 \begin_layout LyX-Code
23478 \begin_layout LyX-Code
23482 \begin_layout LyX-Code
23486 \begin_layout LyX-Code
23490 \begin_layout Standard
23494 \begin_layout LyX-Code
23498 \begin_layout LyX-Code
23502 \begin_layout LyX-Code
23506 \begin_layout LyX-Code
23510 \begin_layout Standard
23511 In the first case, the individual lines define how the bibliographic information
23512 associated with an article or book, respectively, is to be displayed, and
23513 such a definition can be given for any
23514 \begin_inset Quotes els
23518 \begin_inset Quotes ers
23521 that might be present in a Bib\SpecialChar TeX
23524 defines a default format in the source code that will be used if no specific
23525 definition has been given.
23527 predefines several formats in the file
23528 \begin_inset Flex Code
23531 \begin_layout Plain Layout
23537 , which is included in most of \SpecialChar LyX
23538 's document classes.
23541 \begin_layout Standard
23542 In the second case, the lines define how a specific citation command (in
23544 \begin_inset Flex Code
23547 \begin_layout Plain Layout
23556 \begin_inset Flex Code
23559 \begin_layout Plain Layout
23567 ) is to be displayed on the citation inset label, in the citation dialog,
23568 menu or XHTML output.
23570 defines such formats for the citation style variants it supports via
23572 Document\SpecialChar menuseparator
23573 Setting\SpecialChar menuseparator
23574 Bibliography\SpecialChar ldots
23578 \begin_inset Flex Code
23581 \begin_layout Plain Layout
23587 files that are shipped with \SpecialChar LyX
23589 \begin_inset CommandInset ref
23591 reference "subsec:Cite-Engine-Files"
23601 \begin_layout Standard
23602 The definitions use a simple language that allows Bib\SpecialChar TeX
23603 keys to be replaced
23605 Keys should be enclosed in
23606 \begin_inset Flex Code
23609 \begin_layout Plain Layout
23616 \begin_inset Flex Code
23619 \begin_layout Plain Layout
23626 So a simple definition might look like this:
23629 \begin_layout LyX-Code
23631 \begin_inset Quotes eld
23635 \begin_inset Quotes erd
23641 \begin_layout Standard
23642 This would print the author, followed by a comma, followed by the title,
23643 in quotes, followed by a period.
23646 \begin_layout Standard
23647 Of course, sometimes you may want to print a key only if it exists.
23648 This can be done by using a conditional construction, such as:
23649 \begin_inset Flex Code
23652 \begin_layout Plain Layout
23654 \begin_inset space ~
23664 \begin_inset Flex Code
23667 \begin_layout Plain Layout
23673 key exists, then print
23674 \begin_inset Quotes eld
23678 \begin_inset space ~
23682 \begin_inset Quotes erd
23685 followed by the volume key.
23686 It is also possible to have an else clause in the conditional, such as:
23687 \begin_inset Newline newline
23691 \begin_inset Flex Code
23694 \begin_layout Plain Layout
23695 {%author%[[%author%]][[%editor%, ed.]]}
23701 \begin_inset Newline newline
23705 \begin_inset Flex Code
23708 \begin_layout Plain Layout
23714 key is printed if it exists; otherwise, the editor key is printed, followed
23716 \begin_inset Quotes eld
23720 \begin_inset space ~
23724 \begin_inset Quotes erd
23727 Note that the key is again enclosed in
23728 \begin_inset Flex Code
23731 \begin_layout Plain Layout
23737 signs; the entire conditional is enclosed in braces; and the if and else
23738 clauses are enclosed in double brackets,
23739 \begin_inset Quotes eld
23743 \begin_inset Flex Code
23746 \begin_layout Plain Layout
23753 \begin_inset Quotes eld
23757 \begin_inset Quotes eld
23761 \begin_inset Flex Code
23764 \begin_layout Plain Layout
23771 \begin_inset Quotes erd
23775 There must be no space between any of these.
23778 \begin_layout Standard
23779 Next to the entry keys, there are some special keys that can be used for
23780 these conditionals:
23783 \begin_layout Itemize
23784 \begin_inset Flex Code
23787 \begin_layout Plain Layout
23788 {%dialog%[[true]][[false]]}
23794 \begin_inset Quotes eld
23798 \begin_inset Quotes erd
23801 part for dialogs and menus, the
23802 \begin_inset Quotes eld
23806 \begin_inset Quotes erd
23809 part for other contexts (workarea, export)
23812 \begin_layout Itemize
23813 \begin_inset Flex Code
23816 \begin_layout Plain Layout
23817 {%export%[[true]][[false]]}
23823 \begin_inset Quotes eld
23827 \begin_inset Quotes erd
23830 part for export and menus, the
23831 \begin_inset Quotes eld
23835 \begin_inset Quotes erd
23838 part for other contexts (workarea, dialog)
23841 \begin_layout Itemize
23842 \begin_inset Flex Code
23845 \begin_layout Plain Layout
23852 \begin_inset Quotes eld
23856 \begin_inset Quotes erd
23859 part if another item follows (e.
23860 \begin_inset space \thinspace{}
23863 g., in a citation with multiple keys)
23866 \begin_layout Itemize
23867 \begin_inset Flex Code
23870 \begin_layout Plain Layout
23871 {%second%[[true]][[false]]}
23877 \begin_inset Quotes eld
23881 \begin_inset Quotes erd
23884 if this is the second of multiple items, else the
23885 \begin_inset Quotes eld
23889 \begin_inset Quotes erd
23895 \begin_layout Itemize
23896 \begin_inset Flex Code
23899 \begin_layout Plain Layout
23900 {%ifstar%[[true]][[false]]}
23906 \begin_inset Quotes eld
23910 \begin_inset Quotes erd
23913 part for starred citation commands (such as
23914 \begin_inset Flex Code
23917 \begin_layout Plain Layout
23925 ), the false part for unstarred
23928 \begin_layout Itemize
23929 \begin_inset Flex Code
23932 \begin_layout Plain Layout
23933 {%ifentrytype:<type>%[[true]][[false]]}
23939 \begin_inset Quotes eld
23943 \begin_inset Quotes erd
23946 if the current entry type matches
23947 \begin_inset Flex Code
23950 \begin_layout Plain Layout
23956 , else the false part (e.g., in a citation definition:
23957 \begin_inset Flex Code
23960 \begin_layout Plain Layout
23961 {%ifentrytype:book%[[this is a book]][[this is no book]]}
23969 \begin_layout Itemize
23970 \begin_inset Flex Code
23973 \begin_layout Plain Layout
23974 {%ifmultiple:<authortype>%[[true]][[false]]}
23980 \begin_inset Quotes eld
23984 \begin_inset Quotes erd
23987 if the current author type (author, editor etc.) has multiple authors, else
23988 the false part (e.g., in a bibliography definition:
23989 \begin_inset Flex Code
23992 \begin_layout Plain Layout
23993 {%ifmultiple:editor%[[eds.]][[ed.]]}
24001 \begin_layout Itemize
24002 \begin_inset Flex Code
24005 \begin_layout Plain Layout
24006 {%ifqualified%[[true]][[false]]}
24012 \begin_inset Quotes eld
24016 \begin_inset Quotes erd
24019 part if the current citation is a qualified citation list (a specific
24023 format for multi-reference citations), the false part if this is not the
24027 \begin_layout Standard
24029 \begin_inset Flex Code
24032 \begin_layout Plain Layout
24038 prints the author key as it is recorded in the bibliography file.
24039 This might not be what you want, since it will result in a string such
24041 \begin_inset Quotes eld
24044 Miller, Peter and Smith, Mary and White, Jane
24045 \begin_inset Quotes erd
24049 \begin_inset Quotes eld
24053 \begin_inset Quotes erd
24056 is used by Bib\SpecialChar TeX
24057 to delimit authors).
24059 therefore provides some methods to get properly formatted name lists (which
24060 will also get translated).
24061 The following keys are provided:
24064 \begin_layout Enumerate
24065 For name lists with pre- and surname, suitable for the main authors/editors
24066 of a bibliography item.
24068 \begin_inset Flex Code
24071 \begin_layout Plain Layout
24077 part denotes the kind of list that is requested (e.g.
24079 \begin_inset Flex Code
24082 \begin_layout Plain Layout
24092 \begin_layout Itemize
24093 \begin_inset Flex Code
24096 \begin_layout Plain Layout
24097 %abbrvnames:<nametype>%
24102 : Provides a name list which is abbreviated (with
24103 \begin_inset Quotes eld
24107 \begin_inset Quotes erd
24111 \begin_inset Flex Code
24114 \begin_layout Plain Layout
24123 \begin_layout Itemize
24124 \begin_inset Flex Code
24127 \begin_layout Plain Layout
24128 %fullnames:<nametype>%
24133 : Provides a full name list (never abbreviated with
24134 \begin_inset Quotes eld
24138 \begin_inset Quotes erd
24144 \begin_layout Itemize
24145 \begin_inset Flex Code
24148 \begin_layout Plain Layout
24149 %forceabbrvnames:<nametype>%
24154 : Provides a name list which is always abbreviated (with
24155 \begin_inset Quotes eld
24159 \begin_inset Quotes erd
24163 \begin_inset Flex Code
24166 \begin_layout Plain Layout
24176 \begin_layout Enumerate
24177 Alternative name lists with pre- and surname, if the order of pre- and surname
24178 inside the bibliography item differs (as in:
24179 \begin_inset Quotes eld
24182 Miller, John: Some text, in: Mary Smith, ed.: A volume
24183 \begin_inset Quotes erd
24190 \begin_layout Itemize
24191 \begin_inset Flex Code
24194 \begin_layout Plain Layout
24195 %abbrvbynames:<nametype>%
24200 : Provides a name list which is abbreviated (with
24201 \begin_inset Quotes eld
24205 \begin_inset Quotes erd
24209 \begin_inset Flex Code
24212 \begin_layout Plain Layout
24221 \begin_layout Itemize
24222 \begin_inset Flex Code
24225 \begin_layout Plain Layout
24226 %fullbynames:<nametype>%
24231 : Provides a full name list (never abbreviated with
24232 \begin_inset Quotes eld
24236 \begin_inset Quotes erd
24242 \begin_layout Itemize
24243 \begin_inset Flex Code
24246 \begin_layout Plain Layout
24247 %forceabbrvbynames:<nametype>%
24252 : Provides a name list which is always abbreviated (with
24253 \begin_inset Quotes eld
24257 \begin_inset Quotes erd
24261 \begin_inset Flex Code
24264 \begin_layout Plain Layout
24274 \begin_layout Enumerate
24275 And finally name lists which consist of family names only, as used in author-yea
24277 These do not take a
24278 \begin_inset Flex Code
24281 \begin_layout Plain Layout
24287 part, but always return either an author list or, if this does not exist,
24288 an editor list (as common in author-year labels):
24292 \begin_layout Itemize
24293 \begin_inset Flex Code
24296 \begin_layout Plain Layout
24302 : Provides a name list which is abbreviated (with
24303 \begin_inset Quotes eld
24307 \begin_inset Quotes erd
24311 \begin_inset Flex Code
24314 \begin_layout Plain Layout
24323 \begin_layout Itemize
24324 \begin_inset Flex Code
24327 \begin_layout Plain Layout
24333 : Provides a full name list (never abbreviated with
24334 \begin_inset Quotes eld
24338 \begin_inset Quotes erd
24344 \begin_layout Itemize
24345 \begin_inset Flex Code
24348 \begin_layout Plain Layout
24349 %forceabbrvciteauthor%
24354 : Provides a name list which is always abbreviated (with
24355 \begin_inset Quotes eld
24359 \begin_inset Quotes erd
24363 \begin_inset Flex Code
24366 \begin_layout Plain Layout
24376 \begin_layout Standard
24377 The order of pre- and surname in the former two lists can be adjusted by
24381 \begin_layout Itemize
24382 \begin_inset Flex Code
24385 \begin_layout Plain Layout
24386 !firstnameform %surname%, %prename%
24391 (first author in lists of type 1)
24394 \begin_layout Itemize
24395 \begin_inset Flex Code
24398 \begin_layout Plain Layout
24399 !othernameform %surname%, %prename%
24404 (other authors in lists of type 1)
24407 \begin_layout Itemize
24408 \begin_inset Flex Code
24411 \begin_layout Plain Layout
24412 !firstbynameform %prename% %surname%
24417 (first author in lists of type 2)
24420 \begin_layout Itemize
24421 \begin_inset Flex Code
24424 \begin_layout Plain Layout
24425 !otherbynameform %prename% %surname%
24430 (other authors in lists of type 2)
24433 \begin_layout Standard
24434 This allows you to configure namings like
24435 \begin_inset Quotes eld
24438 Miller, Peter and Mary Smith: \SpecialChar ldots
24439 , in: John Doe and Pat Green, eds.:\SpecialChar ldots
24441 \begin_inset Quotes erd
24447 \begin_layout Standard
24448 There is one other piece of syntax available in definitions, which looks
24450 \begin_inset Flex Code
24453 \begin_layout Plain Layout
24460 This defines a piece of formatting information that is to be used when
24462 \begin_inset Quotes eld
24466 \begin_inset Quotes erd
24470 Obviously, we do not want to output HTML tags when writing plain text,
24471 so they should be wrapped in
24472 \begin_inset Quotes eld
24476 \begin_inset Quotes erd
24480 \begin_inset Quotes eld
24484 \begin_inset Quotes erd
24490 \begin_layout Standard
24491 Two special sorts of definitions are also possible in a
24492 \begin_inset Flex Code
24495 \begin_layout Plain Layout
24502 An example of the first would be:
24505 \begin_layout LyX-Code
24507 \begin_inset Quotes eld
24511 \begin_inset Quotes erd
24517 \begin_layout Standard
24518 This is an abbreviation, or macro, and it can be used by treating it as
24520 \begin_inset Flex Code
24523 \begin_layout Plain Layout
24532 \begin_inset Flex Code
24535 \begin_layout Plain Layout
24541 exactly as it would treat its definition.
24542 So, let us issue the obvious
24550 \begin_layout LyX-Code
24554 \begin_layout Standard
24555 or anything like it.
24557 shouldn't go into an infinite loop, but it may go into a long one before
24561 \begin_layout Standard
24562 The second sort of special definition might look like this:
24565 \begin_layout LyX-Code
24569 \begin_layout Standard
24570 This defines a translatable piece of text, which allows relevant parts of
24571 the bibliography or citation to be translated.
24572 It can be included in a definition by treating it as a key:
24573 \begin_inset Flex Code
24576 \begin_layout Plain Layout
24583 Note that there are two different translation paths: All definitions starting
24585 \begin_inset Flex Code
24588 \begin_layout Plain Layout
24594 , such as in the example above, will be translated to the currently active
24595 buffer language (so the translation will match the generated document).
24596 All definitions starting with underscore only will be translated to the
24598 This is the proper translation for strings that only occur in the dialogs
24599 or on buttons, such as this one:
24602 \begin_layout LyX-Code
24603 _addtobib Add to bibliography only.
24606 \begin_layout Standard
24607 Several of these translatable strings are predefined in
24608 \begin_inset Flex Code
24611 \begin_layout Plain Layout
24618 \begin_inset Flex Code
24621 \begin_layout Plain Layout
24628 Note that these are not macros, in the sense just defined.
24629 They will not be expanded.
24632 \begin_layout Standard
24633 So here then is an example that uses several of these features:
24634 \begin_inset VSpace defskip
24640 \begin_layout Standard
24644 !authoredit {%author%[[%author%, ]][[{%editor%[[%editor%, %B_edtext%, ]]}]]}
24647 \begin_layout Standard
24648 \begin_inset VSpace defskip
24651 This defines a macro that prints the author, followed by a comma, if the
24653 \begin_inset Flex Code
24656 \begin_layout Plain Layout
24662 key is defined, or else prints the name of the editor, followed by the
24664 \begin_inset Flex Code
24667 \begin_layout Plain Layout
24673 or its translation (it is by default
24674 \begin_inset Quotes eld
24678 \begin_inset Quotes erd
24682 \begin_inset Flex Code
24685 \begin_layout Plain Layout
24692 Note that this is in fact defined in
24693 \begin_inset Flex Code
24696 \begin_layout Plain Layout
24702 , so you can use it in your own definitions, or re-definitions, if you load
24706 \begin_layout Section
24707 \begin_inset CommandInset label
24709 name "sec:Tags-for-XHTML"
24713 Tags for XHTML output
24716 \begin_layout Standard
24717 As with \SpecialChar LaTeX
24718 or DocBook, the format of \SpecialChar LyX
24719 's XHTML output is also controlled by
24720 layout information.
24721 In general, \SpecialChar LyX
24722 provides sensible defaults and, as mentioned earlier, it will
24723 even construct default CSS style rules from the other layout tags.
24724 For example, \SpecialChar LyX
24725 will attempt to use the information provided in the
24726 \begin_inset Flex Code
24729 \begin_layout Plain Layout
24735 declaration for the Chapter style to write CSS that will appropriately
24736 format chapter headings.
24739 \begin_layout Standard
24740 In many cases, then, you may not have to do anything at all to get acceptable
24741 XHTML output for your own environments, custom insets, and so forth.
24742 But in some cases you will, and so \SpecialChar LyX
24743 provides a number of layout tags that
24744 can be used to customize the XHTML and CSS that are generated.
24747 \begin_layout Standard
24748 Note that there are two tags,
24749 \begin_inset Flex Code
24752 \begin_layout Plain Layout
24759 \begin_inset Flex Code
24762 \begin_layout Plain Layout
24768 that may appear outside style and inset declarations.
24770 \begin_inset CommandInset ref
24772 reference "subsec:General-text-class"
24776 for details on these.
24779 \begin_layout Subsection
24780 \begin_inset CommandInset label
24782 name "subsec:Paragraph-Style-XHTML"
24789 \begin_layout Standard
24790 The sort of XHTML \SpecialChar LyX
24791 outputs for a paragraph depends upon whether we are dealing
24792 with a normal paragraph, a command, or an environment, where this is itself
24793 determined by the contents of the corresponding
24794 \begin_inset Flex Code
24797 \begin_layout Plain Layout
24808 \begin_layout Standard
24809 For a command or normal paragraph, the output XHTML has the following form:
24812 \begin_layout LyX-Code
24816 \begin_inset Quotes erd
24820 \begin_inset Quotes erd
24826 \begin_layout LyX-Code
24830 \begin_inset Quotes erd
24834 \begin_inset Quotes erd
24840 \begin_layout LyX-Code
24843 Contents of the paragraph.
24846 \begin_layout LyX-Code
24852 \begin_layout Standard
24853 The label tags are of course omitted if the paragraph does not have a label.
24856 \begin_layout Standard
24857 For an environment that is not some sort of list, the XHTML takes this form:
24860 \begin_layout LyX-Code
24864 \begin_inset Quotes erd
24868 \begin_inset Quotes erd
24874 \begin_layout LyX-Code
24878 \begin_inset Quotes erd
24882 \begin_inset Quotes erd
24886 \begin_inset Quotes erd
24890 \begin_inset Quotes erd
24893 >Environment Label</labeltag>First paragraph.</itemtag>
24896 \begin_layout LyX-Code
24899 <itemtag>Second paragraph.</itemtag>
24902 \begin_layout LyX-Code
24908 \begin_layout Standard
24909 Note that the label is output only for the first paragraph, as it should
24910 be for a theorem, for example.
24914 \begin_layout Standard
24915 For a list, we have one of these forms:
24918 \begin_layout LyX-Code
24922 \begin_inset Quotes erd
24926 \begin_inset Quotes erd
24932 \begin_layout LyX-Code
24936 \begin_inset Quotes erd
24940 \begin_inset Quotes erd
24944 \begin_inset Quotes erd
24948 \begin_inset Quotes erd
24951 >List Label</labeltag>First item.</itemtag>
24954 \begin_layout LyX-Code
24958 \begin_inset Quotes erd
24962 \begin_inset Quotes erd
24966 \begin_inset Quotes erd
24970 \begin_inset Quotes erd
24973 >List Label</labeltag>Second item.</itemtag>
24976 \begin_layout LyX-Code
24982 \begin_layout LyX-Code
24986 \begin_layout LyX-Code
24990 \begin_inset Quotes erd
24994 \begin_inset Quotes erd
25000 \begin_layout LyX-Code
25004 \begin_inset Quotes erd
25008 \begin_inset Quotes erd
25011 >List Label</labeltag><itemtag attr=
25012 \begin_inset Quotes erd
25016 \begin_inset Quotes erd
25019 >First item.</itemtag>
25022 \begin_layout LyX-Code
25026 \begin_inset Quotes erd
25030 \begin_inset Quotes erd
25033 >List Label</labeltag><itemtag attr=
25034 \begin_inset Quotes erd
25038 \begin_inset Quotes erd
25041 >Second item.</itemtag>
25044 \begin_layout LyX-Code
25050 \begin_layout Standard
25051 Note the different orders of
25052 \begin_inset Flex Code
25055 \begin_layout Plain Layout
25062 \begin_inset Flex Code
25065 \begin_layout Plain Layout
25072 Which order we get depends upon the setting of
25073 \begin_inset Flex Code
25076 \begin_layout Plain Layout
25083 \begin_inset Flex Code
25086 \begin_layout Plain Layout
25092 is false (the default), you get the first of these, with the label within
25093 the item; if true, you get the second, with the label outside the item.
25096 \begin_layout Standard
25097 The specific tags and attributes output for each paragraph type can be controlle
25098 d by means of the layout tags we are about to describe.
25099 As mentioned earlier, however, \SpecialChar LyX
25100 uses sensible defaults for many of these,
25101 so you often may not need to do very much to get good XHTML output.
25102 Think of the available tags as there so you can tweak things to your liking.
25105 \begin_layout Description
25106 \begin_inset Flex Code
25109 \begin_layout Plain Layout
25116 \begin_inset Flex Code
25119 \begin_layout Plain Layout
25125 ] Specifies attribute information to be output with the main tag.
25127 \begin_inset Quotes eld
25131 \begin_inset Flex Code
25134 \begin_layout Plain Layout
25141 \begin_inset Quotes erd
25145 By default, \SpecialChar LyX
25147 \begin_inset Quotes eld
25151 \begin_inset Flex Code
25154 \begin_layout Plain Layout
25161 \begin_inset Quotes erd
25165 \begin_inset Flex Code
25168 \begin_layout Plain Layout
25174 is the \SpecialChar LyX
25175 name of the layout, made lowercase, for example: chapter.
25180 contain any style information.
25182 \begin_inset Flex Code
25185 \begin_layout Plain Layout
25194 \begin_layout Description
25195 \begin_inset Flex Code
25198 \begin_layout Plain Layout
25205 \begin_inset Flex Code
25208 \begin_layout Plain Layout
25218 ] Whether to output the default CSS information \SpecialChar LyX
25219 generates for this layout,
25220 even if additional information is explicitly provided via
25221 \begin_inset Flex Code
25224 \begin_layout Plain Layout
25232 \begin_inset Flex Code
25235 \begin_layout Plain Layout
25241 allows you to alter or augment the generated CSS, rather than to override
25244 \begin_inset Flex Code
25247 \begin_layout Plain Layout
25256 \begin_layout Description
25257 \begin_inset Flex Code
25260 \begin_layout Plain Layout
25267 \begin_inset Flex Code
25270 \begin_layout Plain Layout
25276 ] The tag to be used for individual paragraphs of environments, replacing
25278 \begin_inset Flex Code
25281 \begin_layout Plain Layout
25287 in the examples above.
25289 \begin_inset Flex Code
25292 \begin_layout Plain Layout
25301 \begin_layout Description
25302 \begin_inset Flex Code
25305 \begin_layout Plain Layout
25312 \begin_inset Flex Code
25315 \begin_layout Plain Layout
25321 ] Attributes for the item tag.
25323 \begin_inset Newline newline
25327 \begin_inset Quotes eld
25331 \begin_inset Flex Code
25334 \begin_layout Plain Layout
25335 class=`layoutname_item'
25341 \begin_inset Quotes erd
25349 contain any style information.
25351 \begin_inset Flex Code
25354 \begin_layout Plain Layout
25363 \begin_layout Description
25364 \begin_inset Flex Code
25367 \begin_layout Plain Layout
25374 \begin_inset Flex Code
25377 \begin_layout Plain Layout
25383 ] The tag to be used for paragraph and item labels, replacing
25384 \begin_inset Flex Code
25387 \begin_layout Plain Layout
25393 in the examples above.
25395 \begin_inset Flex Code
25398 \begin_layout Plain Layout
25405 \begin_inset Flex Code
25408 \begin_layout Plain Layout
25415 \begin_inset Flex Code
25418 \begin_layout Plain Layout
25425 \begin_inset Flex Code
25428 \begin_layout Plain Layout
25429 Centered_Top_Environment
25434 , in which case it defaults to
25435 \begin_inset Flex Code
25438 \begin_layout Plain Layout
25447 \begin_layout Description
25448 \begin_inset Flex Code
25451 \begin_layout Plain Layout
25458 \begin_inset Flex Code
25461 \begin_layout Plain Layout
25467 ] Attributes for the label tag.
25469 \begin_inset Newline newline
25473 \begin_inset Quotes eld
25477 \begin_inset Flex Code
25480 \begin_layout Plain Layout
25481 class=`layoutname_label'
25487 \begin_inset Quotes erd
25495 contain any style information.
25497 \begin_inset Flex Code
25500 \begin_layout Plain Layout
25509 \begin_layout Description
25510 \begin_inset Flex Code
25513 \begin_layout Plain Layout
25520 \begin_inset Flex Code
25523 \begin_layout Plain Layout
25533 ] Meaningful only for list-like environments, this tag controls whether
25534 the label tag is output before or inside the item tag.
25535 This is used, for example, in the description environment, where we want
25537 \begin_inset Flex Code
25540 \begin_layout Plain Layout
25541 <dt>\SpecialChar ldots
25542 </dt><dd>\SpecialChar ldots
25550 \begin_inset Flex Code
25553 \begin_layout Plain Layout
25559 : The label tag is output inside the item tag.
25562 \begin_layout Description
25563 \begin_inset Flex Code
25566 \begin_layout Plain Layout
25572 Information to be output in the
25573 \begin_inset Flex Code
25576 \begin_layout Plain Layout
25582 section when this style is used.
25583 This might, for example, be used to include a
25584 \begin_inset Flex Code
25587 \begin_layout Plain Layout
25594 \begin_inset Flex Code
25597 \begin_layout Plain Layout
25606 \begin_layout Description
25607 \begin_inset Flex Code
25610 \begin_layout Plain Layout
25616 CSS style information to be included when this style is used.
25617 Note that this will automatically be wrapped in a layout-generated
25618 \begin_inset Flex Code
25621 \begin_layout Plain Layout
25627 block, so only the CSS itself need be included.
25629 \begin_inset Flex Code
25632 \begin_layout Plain Layout
25641 \begin_layout Description
25642 \begin_inset Flex Code
25645 \begin_layout Plain Layout
25652 \begin_inset Flex Code
25655 \begin_layout Plain Layout
25661 ] The tag to be used for the main label, replacing
25662 \begin_inset Flex Code
25665 \begin_layout Plain Layout
25671 in the examples above.
25673 \begin_inset Flex Code
25676 \begin_layout Plain Layout
25685 \begin_layout Description
25686 \begin_inset Flex Code
25689 \begin_layout Plain Layout
25696 \begin_inset Flex Code
25699 \begin_layout Plain Layout
25709 ] Marks this style as the one to be used to generate the
25710 \begin_inset Flex Code
25713 \begin_layout Plain Layout
25719 tag for the XHTML file.
25720 By default, it is false.
25722 \begin_inset Flex Code
25725 \begin_layout Plain Layout
25731 file sets it to true for the
25732 \begin_inset Flex Code
25735 \begin_layout Plain Layout
25745 \begin_layout Subsection
25749 \begin_layout Standard
25750 The XHTML output of insets can also be controlled by information in layout
25755 \begin_layout Plain Layout
25756 At present, this is true only for
25757 \begin_inset Quotes eld
25761 \begin_inset Quotes erd
25764 insets (insets you can type into) and is not true for
25765 \begin_inset Quotes eld
25769 \begin_inset Quotes erd
25772 insets (insets that are associated with dialog boxes).
25777 Here, too, \SpecialChar LyX
25778 tries to provide sensible defaults, and it constructs default
25780 But everything can be customized.
25783 \begin_layout Standard
25784 The XHTML \SpecialChar LyX
25785 outputs for an inset has the following form:
25788 \begin_layout LyX-Code
25790 \begin_inset Quotes erd
25794 \begin_inset Quotes erd
25800 \begin_layout LyX-Code
25801 <labeltag>Label</labeltag>
25804 \begin_layout LyX-Code
25806 \begin_inset Quotes erd
25810 \begin_inset Quotes erd
25813 >Contents of the inset.</innertag>
25816 \begin_layout LyX-Code
25820 \begin_layout Standard
25821 If the inset permits multiple paragraphs—that is, if
25822 \begin_inset Flex Code
25825 \begin_layout Plain Layout
25831 is true—then the contents of the inset will itself be output as paragraphs
25832 formatted according to the styles used for those paragraphs (standard,
25833 quote, and the like).
25834 The label tag is of course omitted if the paragraph does not have a label
25835 and, at present, is always
25836 \begin_inset Flex Code
25839 \begin_layout Plain Layout
25846 The inner tag is optional and, by default, does not appear.
25849 \begin_layout Standard
25850 The specific tags and attributes output for each inset can be controlled
25851 by means of the following layout tags.
25854 \begin_layout Description
25855 \begin_inset Flex Code
25858 \begin_layout Plain Layout
25865 \begin_inset Flex Code
25868 \begin_layout Plain Layout
25874 ] Specifies attribute information to be output with the main tag.
25876 \begin_inset Quotes eld
25880 \begin_inset Flex Code
25883 \begin_layout Plain Layout
25884 class=`myinset' onclick=`\SpecialChar ldots
25891 \begin_inset Quotes erd
25895 By default, \SpecialChar LyX
25897 \begin_inset Quotes eld
25901 \begin_inset Flex Code
25904 \begin_layout Plain Layout
25911 \begin_inset Quotes erd
25915 \begin_inset Flex Code
25918 \begin_layout Plain Layout
25924 is the \SpecialChar LyX
25925 name of the inset, made lowercase and with non-alphanumeric characters
25926 converted to underscores, for example: footnote.
25929 \begin_layout Description
25930 \begin_inset Flex Code
25933 \begin_layout Plain Layout
25940 \begin_inset Flex Code
25943 \begin_layout Plain Layout
25953 ] Whether to output the default CSS information \SpecialChar LyX
25954 generates for this layout,
25955 even if additional information is explicitly provided via
25956 \begin_inset Flex Code
25959 \begin_layout Plain Layout
25967 \begin_inset Flex Code
25970 \begin_layout Plain Layout
25976 allows you to alter or augment the generated CSS, rather than to override
25981 \begin_layout Description
25982 \begin_inset Flex Code
25985 \begin_layout Plain Layout
25992 \begin_inset Flex Code
25995 \begin_layout Plain Layout
26001 ] Attributes for the inner tag.
26003 \begin_inset Newline newline
26007 \begin_inset Quotes eld
26011 \begin_inset Flex Code
26014 \begin_layout Plain Layout
26015 class=`insetname_inner'
26021 \begin_inset Quotes erd
26027 \begin_layout Description
26028 \begin_inset Flex Code
26031 \begin_layout Plain Layout
26038 \begin_inset Flex Code
26041 \begin_layout Plain Layout
26047 ] The inner tag, replacing
26048 \begin_inset Flex Code
26051 \begin_layout Plain Layout
26057 in the examples above.
26058 By default, there is none.
26061 \begin_layout Description
26062 \begin_inset Flex Code
26065 \begin_layout Plain Layout
26072 \begin_inset Flex Code
26075 \begin_layout Plain Layout
26083 ] Whether this inset represents a standalone block of text (such as a footnote)
26084 or instead represents material that is included in the surrounding text
26085 (such as a branch).
26089 \begin_layout Description
26090 \begin_inset Flex Code
26093 \begin_layout Plain Layout
26100 \begin_inset Flex Code
26103 \begin_layout Plain Layout
26109 ] A label for this inset, possibly including a reference to a counter.
26110 For example, for footnote, it might be:
26111 \begin_inset Flex Code
26114 \begin_layout Plain Layout
26123 This is optional, and there is no default.
26126 \begin_layout Description
26127 \begin_inset Flex Code
26130 \begin_layout Plain Layout
26136 Information to be output in the
26137 \begin_inset Flex Code
26140 \begin_layout Plain Layout
26146 section when this style is used.
26147 This might, for example, be used to include a
26148 \begin_inset Flex Code
26151 \begin_layout Plain Layout
26158 \begin_inset Flex Code
26161 \begin_layout Plain Layout
26170 \begin_layout Description
26171 \begin_inset Flex Code
26174 \begin_layout Plain Layout
26180 CSS style information to be included when this style is used.
26181 Note that this will automatically be wrapped in a layout-generated
26182 \begin_inset Flex Code
26185 \begin_layout Plain Layout
26191 block, so only the CSS itself need be included.
26194 \begin_layout Description
26195 \begin_inset Flex Code
26198 \begin_layout Plain Layout
26205 \begin_inset Flex Code
26208 \begin_layout Plain Layout
26214 ] The tag to be used for the main label, replacing
26215 \begin_inset Flex Code
26218 \begin_layout Plain Layout
26224 in the examples above.
26225 The default depends upon the setting of
26226 \begin_inset Flex Code
26229 \begin_layout Plain Layout
26236 \begin_inset Flex Code
26239 \begin_layout Plain Layout
26245 is true, the default is
26246 \begin_inset Flex Code
26249 \begin_layout Plain Layout
26255 ; if it is false, the default is
26256 \begin_inset Flex Code
26259 \begin_layout Plain Layout
26268 \begin_layout Subsection
26272 \begin_layout Standard
26273 The XHTML output for floats too can be controlled by layout information.
26274 The output has the following form:
26277 \begin_layout LyX-Code
26279 \begin_inset Quotes erd
26283 \begin_inset Quotes erd
26289 \begin_layout LyX-Code
26290 Contents of the float.
26293 \begin_layout LyX-Code
26297 \begin_layout Standard
26298 The caption, if there is one, is a separate inset and will be output as
26300 Its appearance can be controlled via the InsetLayout for caption insets.
26304 \begin_layout Description
26305 \begin_inset Flex Code
26308 \begin_layout Plain Layout
26315 \begin_inset Flex Code
26318 \begin_layout Plain Layout
26324 ] Specifies attribute information to be output with the main tag.
26326 \begin_inset Quotes eld
26330 \begin_inset Flex Code
26333 \begin_layout Plain Layout
26334 class=`myfloat' onclick=`\SpecialChar ldots
26341 \begin_inset Quotes erd
26345 By default, \SpecialChar LyX
26347 \begin_inset Quotes eld
26351 \begin_inset Flex Code
26354 \begin_layout Plain Layout
26355 class=`float float-floattype'
26361 \begin_inset Quotes erd
26365 \begin_inset Flex Code
26368 \begin_layout Plain Layout
26374 is \SpecialChar LyX
26375 's name for this type of float, as determined by the float declaration
26377 \begin_inset CommandInset ref
26379 reference "subsec:Floats"
26383 ), though made lowercase and with non-alphanumeric characters converted
26384 to underscores, for example: float-table.
26387 \begin_layout Description
26388 \begin_inset Flex Code
26391 \begin_layout Plain Layout
26397 CSS style information to be included when this float is used.
26398 Note that this will automatically be wrapped in a layout-generated
26399 \begin_inset Flex Code
26402 \begin_layout Plain Layout
26408 block, so only the CSS itself need be included.
26411 \begin_layout Description
26412 \begin_inset Flex Code
26415 \begin_layout Plain Layout
26422 \begin_inset Flex Code
26425 \begin_layout Plain Layout
26431 ] The tag to be used for this float, replacing
26432 \begin_inset Quotes eld
26436 \begin_inset Flex Code
26439 \begin_layout Plain Layout
26446 \begin_inset Quotes erd
26449 in the example above.
26451 \begin_inset Flex Code
26454 \begin_layout Plain Layout
26460 and will rarely need changing.
26463 \begin_layout Subsection
26464 Bibliography formatting
26467 \begin_layout Standard
26468 The bibliography can be formatted using
26469 \begin_inset Flex Code
26472 \begin_layout Plain Layout
26480 \begin_inset CommandInset ref
26482 reference "subsec:Citation-format-description"
26489 \begin_layout Subsection
26494 \begin_layout Standard
26495 We have several times mentioned that \SpecialChar LyX
26496 will generate default CSS style rules
26497 for both insets and paragraph styles, based upon the other layout information
26499 In this section, we shall say a word about which layout information \SpecialChar LyX
26504 \begin_layout Standard
26505 At present, \SpecialChar LyX
26506 auto-generates CSS only for font information, making use of
26508 \begin_inset Flex Code
26511 \begin_layout Plain Layout
26518 \begin_inset Flex Code
26521 \begin_layout Plain Layout
26528 \begin_inset Flex Code
26531 \begin_layout Plain Layout
26538 \begin_inset Flex Code
26541 \begin_layout Plain Layout
26548 \begin_inset Flex Code
26551 \begin_layout Plain Layout
26558 \begin_inset CommandInset ref
26560 reference "subsec:Font-description"
26565 The translation is mostly straightforward and obvious.
26567 \begin_inset Quotes eld
26571 \begin_inset Flex Code
26574 \begin_layout Plain Layout
26581 \begin_inset Quotes erd
26585 \begin_inset Quotes eld
26589 \begin_inset Flex Code
26592 \begin_layout Plain Layout
26593 font-family: sans-serif;
26599 \begin_inset Quotes erd
26603 The correspondence of \SpecialChar LyX
26604 sizes and CSS sizes is a little less obvious but
26605 nonetheless intuitive.
26607 \begin_inset Flex Code
26610 \begin_layout Plain Layout
26617 \begin_inset Flex URL
26620 \begin_layout Plain Layout
26630 \begin_layout Chapter
26631 Including External Material
26632 \begin_inset CommandInset label
26634 name "chap:Including-External-Material"
26641 \begin_layout Standard
26642 \begin_inset Box Shadowbox
26652 height_special "totalheight"
26657 backgroundcolor "none"
26660 \begin_layout Plain Layout
26661 WARNING: This portion of the documentation has not been updated for some
26663 We certainly hope that it is still accurate, but there are no guarantees.
26671 \begin_layout Standard
26672 The use of material from sources external to \SpecialChar LyX
26673 is covered in detail in the
26679 This part of the manual covers what needs to happen behind the scenes for
26680 new sorts of material to be included.
26683 \begin_layout Section
26687 \begin_layout Standard
26688 The external material feature is based on the concept of a
26693 A template is a specification of how \SpecialChar LyX
26694 should interface with a certain kind
26696 As bundled, \SpecialChar LyX
26697 comes with predefined templates for Xfig figures, various
26698 raster format images, chess diagrams, and LilyPond music notation.
26699 You can check the actual list by using the menu
26700 \begin_inset Flex Noun
26703 \begin_layout Plain Layout
26704 Insert\SpecialChar menuseparator
26705 File\SpecialChar menuseparator
26712 Furthermore, it is possible to roll your own template to support a specific
26714 Later we'll describe in more detail what is involved, and hopefully you
26715 will submit all the templates you create so we can include them in a later
26720 \begin_layout Standard
26721 Another basic idea of the external material feature is to distinguish between
26722 the original file that serves as a base for final material and the produced
26723 file that is included in your exported or printed document.
26724 For example, consider the case of a figure produced with
26725 \begin_inset Flex Code
26728 \begin_layout Plain Layout
26735 The Xfig application itself works on an original file with the
26736 \begin_inset Flex Code
26739 \begin_layout Plain Layout
26746 Within Xfig, you create and change your figure, and when you are done,
26748 \begin_inset Flex Code
26751 \begin_layout Plain Layout
26758 When you want to include the figure in your document, you invoke
26759 \begin_inset Flex Code
26762 \begin_layout Plain Layout
26768 in order to create a PostScript file that can readily be included in your
26772 \begin_inset Flex Code
26775 \begin_layout Plain Layout
26781 file is the original file, and the PostScript file is the produced file.
26784 \begin_layout Standard
26785 This distinction is important in order to allow updating of the material
26786 while you are in the process of writing the document.
26787 Furthermore, it provides us with the flexibility that is needed to support
26788 multiple export formats.
26789 For instance, in the case of a plain text file, it is not exactly an award-winn
26790 ing idea to include the figure as raw PostScript.
26791 Instead, you would either prefer to just include a reference to the figure
26792 or try to invoke some graphics to ASCII converter to make the final result
26793 look similar to the real graphics.
26794 The external material management allows you to do this, because it is parametri
26795 zed on the different export formats that \SpecialChar LyX
26799 \begin_layout Standard
26800 Besides supporting the production of different products according to the
26801 exported format, it supports tight integration with editing and viewing
26803 In the case of an Xfig figure, you are able to invoke Xfig on the original
26804 file with a single click from within the external material dialog in \SpecialChar LyX
26806 and also preview the produced PostScript file with Ghostview with another
26808 No more fiddling around with the command line and/or file browsers to locate
26809 and manipulate the original or produced files.
26810 In this way, you are finally able to take full advantage of the many different
26811 applications that are relevant to use when you write your documents, and
26812 ultimately be more productive.
26815 \begin_layout Section
26816 The external template configuration files
26819 \begin_layout Standard
26820 It is relatively easy to add custom external template definitions to \SpecialChar LyX
26822 However, be aware that doing this in an careless manner most probably
26826 introduce an easily exploitable security hole.
26827 So before you do this, please read the discussion about security in
26828 \begin_inset CommandInset ref
26830 reference "sec:Security-discussion"
26837 \begin_layout Standard
26838 Having said that, we encourage you to submit any interesting templates that
26843 \begin_layout Standard
26844 The external templates are defined in the
26845 \begin_inset Flex Code
26848 \begin_layout Plain Layout
26854 files that are stored in the
26855 \begin_inset Flex Code
26858 \begin_layout Plain Layout
26859 LyXDir/lib/xtemplates/
26865 Each template is defined in a file of its own.
26866 You can place your own templates in
26867 \begin_inset Flex Code
26870 \begin_layout Plain Layout
26871 UserDir/xtemplates/
26876 or copy existing templates to that directory in order to modify them.
26879 \begin_layout Standard
26880 A typical template looks like this:
26883 \begin_layout LyX-Code
26887 \begin_layout LyX-Code
26888 GuiName "XFig: $$AbsOrRelPathParent$$Basename"
26891 \begin_layout LyX-Code
26895 \begin_layout LyX-Code
26899 \begin_layout LyX-Code
26903 \begin_layout LyX-Code
26907 \begin_layout LyX-Code
26911 \begin_layout LyX-Code
26912 AutomaticProduction true
26915 \begin_layout LyX-Code
26919 \begin_layout LyX-Code
26923 \begin_layout LyX-Code
26927 \begin_layout LyX-Code
26928 TransformCommand Rotate RotationLatexCommand
26931 \begin_layout LyX-Code
26932 TransformCommand Resize ResizeLatexCommand
26935 \begin_layout LyX-Code
26936 Product "$$RotateFront$$ResizeFront
26939 \begin_layout LyX-Code
26944 input{$$AbsOrRelPathMaster$$Basename.pstex_t}
26947 \begin_layout LyX-Code
26948 $$ResizeBack$$RotateBack"
26951 \begin_layout LyX-Code
26955 \begin_layout LyX-Code
26956 UpdateResult "$$AbsPath$$Basename.pstex_t"
26959 \begin_layout LyX-Code
26960 Requirement "graphicx"
26963 \begin_layout LyX-Code
26964 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
26967 \begin_layout LyX-Code
26968 ReferencedFile latex "$$AbsPath$$Basename.eps"
26971 \begin_layout LyX-Code
26972 ReferencedFile dvi "$$AbsPath$$Basename.eps"
26975 \begin_layout LyX-Code
26979 \begin_layout LyX-Code
26983 \begin_layout LyX-Code
26984 TransformCommand Rotate RotationLatexCommand
26987 \begin_layout LyX-Code
26988 TransformCommand Resize ResizeLatexCommand
26991 \begin_layout LyX-Code
26992 Product "$$RotateFront$$ResizeFront
26995 \begin_layout LyX-Code
27000 input{$$AbsOrRelPathMaster$$Basename.pdftex_t}
27003 \begin_layout LyX-Code
27004 $$ResizeBack$$RotateBack"
27007 \begin_layout LyX-Code
27008 UpdateFormat pdftex
27011 \begin_layout LyX-Code
27012 UpdateResult "$$AbsPath$$Basename.pdftex_t"
27015 \begin_layout LyX-Code
27016 Requirement "graphicx"
27019 \begin_layout LyX-Code
27020 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pdftex_t"
27023 \begin_layout LyX-Code
27024 ReferencedFile latex "$$AbsPath$$Basename.pdf"
27027 \begin_layout LyX-Code
27031 \begin_layout LyX-Code
27035 \begin_layout LyX-Code
27036 Product "[XFig: $$FName]"
27039 \begin_layout LyX-Code
27043 \begin_layout LyX-Code
27047 \begin_layout LyX-Code
27048 Product "<graphic fileref=
27050 "$$AbsOrRelPathMaster$$Basename.eps
27055 \begin_layout LyX-Code
27059 \begin_layout LyX-Code
27063 \begin_layout LyX-Code
27064 UpdateResult "$$AbsPath$$Basename.eps"
27067 \begin_layout LyX-Code
27068 ReferencedFile docbook "$$AbsPath$$Basename.eps"
27071 \begin_layout LyX-Code
27072 ReferencedFile docbook-xml "$$AbsPath$$Basename.eps"
27075 \begin_layout LyX-Code
27079 \begin_layout LyX-Code
27083 \begin_layout Standard
27084 As you can see, the template is enclosed in
27085 \begin_inset Flex Code
27088 \begin_layout Plain Layout
27096 \begin_inset Flex Code
27099 \begin_layout Plain Layout
27106 It contains a header specifying some general settings and, for each supported
27107 primary document file format, a section
27108 \begin_inset Flex Code
27111 \begin_layout Plain Layout
27119 \begin_inset Flex Code
27122 \begin_layout Plain Layout
27131 \begin_layout Subsection
27132 The template header
27135 \begin_layout Description
27136 \begin_inset Flex Code
27139 \begin_layout Plain Layout
27140 AutomaticProduction
27141 \begin_inset space ~
27149 Whether the file represented by the template must be generated by \SpecialChar LyX
27151 This command must occur exactly once.
27154 \begin_layout Description
27155 \begin_inset Flex Code
27158 \begin_layout Plain Layout
27160 \begin_inset space ~
27168 A glob pattern that is used in the file dialog to filter out the desired
27170 If there is more than one possible file extension (e.
27171 \begin_inset space \thinspace{}
27175 \begin_inset space \space{}
27179 \begin_inset Flex Code
27182 \begin_layout Plain Layout
27189 \begin_inset Flex Code
27192 \begin_layout Plain Layout
27198 ), use something like
27199 \begin_inset Flex Code
27202 \begin_layout Plain Layout
27209 This command must occur exactly once.
27212 \begin_layout Description
27213 \begin_inset Flex Code
27216 \begin_layout Plain Layout
27218 \begin_inset space ~
27226 The text that is displayed on the button.
27227 This command must occur exactly once.
27230 \begin_layout Description
27231 \begin_inset Flex Code
27234 \begin_layout Plain Layout
27236 \begin_inset space ~
27240 \begin_inset space ~
27248 The help text that is used in the External dialog.
27249 Provide enough information to explain to the user just what the template
27250 can provide him with.
27251 This command must occur exactly once.
27254 \begin_layout Description
27255 \begin_inset Flex Code
27258 \begin_layout Plain Layout
27260 \begin_inset space ~
27268 The file format of the original file.
27269 This must be the name of a format that is known to \SpecialChar LyX
27271 \begin_inset CommandInset ref
27273 reference "sec:Formats"
27279 \begin_inset Quotes eld
27283 \begin_inset Flex Code
27286 \begin_layout Plain Layout
27293 \begin_inset Quotes erd
27296 if the template can handle original files of more than one format.
27298 will attempt to interrogate the file itself in order to deduce its format
27300 This command must occur exactly once.
27303 \begin_layout Description
27304 \begin_inset Flex Code
27307 \begin_layout Plain Layout
27309 \begin_inset space ~
27317 A unique name for the template.
27318 It must not contain substitution macros (see below).
27321 \begin_layout Description
27322 \begin_inset Flex Code
27325 \begin_layout Plain Layout
27327 \begin_inset space ~
27330 Rotate|Resize|Clip|Extra
27335 This command specifies which transformations are supported by this template.
27336 It may occur zero or more times.
27337 This command enables the corresponding tabs in the external dialog.
27339 \begin_inset Flex Code
27342 \begin_layout Plain Layout
27348 command must have either a corresponding
27349 \begin_inset Flex Code
27352 \begin_layout Plain Layout
27359 \begin_inset Flex Code
27362 \begin_layout Plain Layout
27369 \begin_inset Flex Code
27372 \begin_layout Plain Layout
27379 Otherwise the transformation will not be supported by that format.
27382 \begin_layout Subsection
27386 \begin_layout Description
27387 \begin_inset Flex Code
27390 \begin_layout Plain Layout
27392 \begin_inset space ~
27395 LaTeX|PDFLaTeX|PlainText|DocBook|XHTML
27400 The primary document file format that this format definition is for.
27401 Not every template has a sensible representation in all document file formats.
27402 Please define nevertheless a
27403 \begin_inset Flex Code
27406 \begin_layout Plain Layout
27412 section for all templates.
27413 Use a dummy text when no representation is available.
27414 Then you can at least see a reference to the external material in the exported
27418 \begin_layout Description
27419 \begin_inset Flex Code
27422 \begin_layout Plain Layout
27424 \begin_inset space ~
27428 \begin_inset space ~
27436 This command defines an additional macro
27437 \begin_inset Flex Code
27440 \begin_layout Plain Layout
27446 for substitution in
27447 \begin_inset Flex Code
27450 \begin_layout Plain Layout
27458 \begin_inset Flex Code
27461 \begin_layout Plain Layout
27467 itself may contain substitution macros.
27468 The advantage over using
27469 \begin_inset Flex Code
27472 \begin_layout Plain Layout
27479 \begin_inset Flex Code
27482 \begin_layout Plain Layout
27488 is that the substituted value of
27489 \begin_inset Flex Code
27492 \begin_layout Plain Layout
27498 is sanitized so that it is a valid optional argument in the document format.
27499 This command may occur zero or more times.
27502 \begin_layout Description
27503 \begin_inset Flex Code
27506 \begin_layout Plain Layout
27508 \begin_inset space ~
27516 The text that is inserted in the exported document.
27517 This is actually the most important command and can be quite complex.
27518 This command must occur exactly once.
27521 \begin_layout Description
27522 \begin_inset Flex Code
27525 \begin_layout Plain Layout
27527 \begin_inset space ~
27535 This command specifies a preamble snippet that will be included in the
27538 It has to be defined using
27539 \begin_inset Flex Code
27542 \begin_layout Plain Layout
27550 \begin_inset Flex Code
27553 \begin_layout Plain Layout
27560 This command may occur zero or more times.
27563 \begin_layout Description
27564 \begin_inset Flex Code
27567 \begin_layout Plain Layout
27569 \begin_inset space ~
27573 \begin_inset space ~
27581 This command denotes files that are created by the conversion process and
27582 are needed for a particular export format.
27583 If the filename is relative, it is interpreted relative to the master document.
27584 This command may be given zero or more times.
27587 \begin_layout Description
27588 \begin_inset Flex Code
27591 \begin_layout Plain Layout
27593 \begin_inset space ~
27601 The name of a required \SpecialChar LaTeX
27603 The package is included via
27604 \begin_inset Flex Code
27607 \begin_layout Plain Layout
27615 in the \SpecialChar LaTeX
27617 This command may occur zero or more times.
27620 \begin_layout Description
27621 \begin_inset Flex Code
27624 \begin_layout Plain Layout
27626 \begin_inset space ~
27630 \begin_inset space ~
27633 RotationLatexCommand
27638 This command specifies that the built in \SpecialChar LaTeX
27639 command should be used for rotation.
27640 This command may occur once or not at all.
27643 \begin_layout Description
27644 \begin_inset Flex Code
27647 \begin_layout Plain Layout
27649 \begin_inset space ~
27653 \begin_inset space ~
27661 This command specifies that the built in \SpecialChar LaTeX
27662 command should be used for resizing.
27663 This command may occur once or not at all.
27666 \begin_layout Description
27667 \begin_inset Flex Code
27670 \begin_layout Plain Layout
27672 \begin_inset space ~
27676 \begin_inset space ~
27679 RotationLatexOption
27684 This command specifies that rotation is done via an optional argument.
27685 This command may occur once or not at all.
27688 \begin_layout Description
27689 \begin_inset Flex Code
27692 \begin_layout Plain Layout
27694 \begin_inset space ~
27698 \begin_inset space ~
27706 This command specifies that resizing is done via an optional argument.
27707 This command may occur once or not at all.
27710 \begin_layout Description
27711 \begin_inset Flex Code
27714 \begin_layout Plain Layout
27716 \begin_inset space ~
27720 \begin_inset space ~
27728 This command specifies that clipping is done via an optional argument.
27729 This command may occur once or not at all.
27732 \begin_layout Description
27733 \begin_inset Flex Code
27736 \begin_layout Plain Layout
27738 \begin_inset space ~
27742 \begin_inset space ~
27750 This command specifies that an extra optional argument is used.
27751 This command may occur once or not at all.
27754 \begin_layout Description
27755 \begin_inset Flex Code
27758 \begin_layout Plain Layout
27760 \begin_inset space ~
27768 The file format of the converted file.
27769 This must be the name of a format that is known to \SpecialChar LyX
27771 \begin_inset Flex Noun
27774 \begin_layout Plain Layout
27775 Tools\SpecialChar menuseparator
27776 Preferences\SpecialChar menuseparator
27777 File Handling\SpecialChar menuseparator
27784 This command must occur exactly once.
27785 If the resulting file format is PDF, you need to specify the format
27786 \begin_inset Flex Code
27789 \begin_layout Plain Layout
27796 This is the PDF format used for including graphics.
27797 The other defined PDF formats are for document export.
27800 \begin_layout Description
27801 \begin_inset Flex Code
27804 \begin_layout Plain Layout
27806 \begin_inset space ~
27814 The file name of the converted file.
27815 The file name must be absolute.
27816 This command must occur exactly once.
27819 \begin_layout Subsection
27820 Preamble definitions
27823 \begin_layout Standard
27824 The external template configuration file may contain additional preamble
27825 definitions enclosed by
27826 \begin_inset Flex Code
27829 \begin_layout Plain Layout
27837 \begin_inset Flex Code
27840 \begin_layout Plain Layout
27847 They can be used by the templates in the
27848 \begin_inset Flex Code
27851 \begin_layout Plain Layout
27860 \begin_layout Section
27861 The substitution mechanism
27864 \begin_layout Standard
27865 When the external material facility invokes an external program, it is done
27866 on the basis of a command defined in the template configuration file.
27867 These commands can contain various macros that are expanded before execution.
27868 Execution always take place in the directory of the containing document.
27871 \begin_layout Standard
27872 Also, whenever external material is to be displayed, the name will be produced
27873 by the substitution mechanism, and most other commands in the template
27874 definition support substitution as well.
27877 \begin_layout Standard
27878 The available macros are the following:
27881 \begin_layout Description
27882 \begin_inset Flex Code
27885 \begin_layout Plain Layout
27886 $$AbsOrRelPathMaster
27891 The file path, absolute or relative to the master \SpecialChar LyX
27895 \begin_layout Description
27896 \begin_inset Flex Code
27899 \begin_layout Plain Layout
27900 $$AbsOrRelPathParent
27905 The file path, absolute or relative to the \SpecialChar LyX
27909 \begin_layout Description
27910 \begin_inset Flex Code
27913 \begin_layout Plain Layout
27919 The absolute file path.
27922 \begin_layout Description
27923 \begin_inset Flex Code
27926 \begin_layout Plain Layout
27932 The filename without path and without the extension.
27935 \begin_layout Description
27936 \begin_inset Flex Code
27939 \begin_layout Plain Layout
27941 \begin_inset Quotes eld
27945 \begin_inset Quotes erd
27953 This macro will expand to the contents of the file with the name
27954 \begin_inset Flex Code
27957 \begin_layout Plain Layout
27966 \begin_layout Description
27967 \begin_inset Flex Code
27970 \begin_layout Plain Layout
27976 The file extension (including the dot).
27979 \begin_layout Description
27980 \begin_inset Flex Code
27983 \begin_layout Plain Layout
27989 This will be the string
27990 \begin_inset Quotes eld
27994 \begin_inset Quotes erd
27997 if the file is in JPEG format, otherwise it will be the string
27998 \begin_inset Quotes eld
28002 \begin_inset Quotes erd
28006 This is useful to avoid uneeded conversions for output formats that support
28007 both PNG and JPEG fomats.
28008 The predefined RasterImage template uses this macro for the pdf\SpecialChar TeX
28013 \begin_layout Description
28014 \begin_inset Flex Code
28017 \begin_layout Plain Layout
28023 The filename of the file specified in the external material dialog.
28024 This is either an absolute name, or it is relative to the \SpecialChar LyX
28028 \begin_layout Description
28029 \begin_inset Flex Code
28032 \begin_layout Plain Layout
28039 \begin_inset Flex Code
28042 \begin_layout Plain Layout
28048 (absolute name or relative to the \SpecialChar LyX
28052 \begin_layout Description
28053 \begin_inset Flex Code
28056 \begin_layout Plain Layout
28062 The file path, relative to the master \SpecialChar LyX
28066 \begin_layout Description
28067 \begin_inset Flex Code
28070 \begin_layout Plain Layout
28076 The file path, relative to the \SpecialChar LyX
28080 \begin_layout Description
28081 \begin_inset Flex Code
28084 \begin_layout Plain Layout
28090 This macro will expand to the absolute path of the system directory.
28091 This is typically used to point to the various helper scripts that are
28092 bundled with \SpecialChar LyX
28096 \begin_layout Description
28097 \begin_inset Flex Code
28100 \begin_layout Plain Layout
28106 A name and full path to a temporary file which will be automatically deleted
28107 whenever the containing document is closed, or the external material insertion
28111 \begin_layout Standard
28112 All path macros contain a trailing directory separator, so you can construct
28114 \begin_inset space \thinspace{}
28118 \begin_inset space \space{}
28121 the absolute filename with
28122 \begin_inset Flex Code
28125 \begin_layout Plain Layout
28126 $$AbsPath$$Basename$$Extension
28134 \begin_layout Standard
28135 The macros above are substituted in all commands unless otherwise noted.
28137 \begin_inset Flex Code
28140 \begin_layout Plain Layout
28146 supports additionally the following substitutions if they are enabled by
28148 \begin_inset Flex Code
28151 \begin_layout Plain Layout
28158 \begin_inset Flex Code
28161 \begin_layout Plain Layout
28170 \begin_layout Description
28171 \begin_inset Flex Code
28174 \begin_layout Plain Layout
28180 The front part of the resize command.
28183 \begin_layout Description
28184 \begin_inset Flex Code
28187 \begin_layout Plain Layout
28193 The back part of the resize command.
28196 \begin_layout Description
28197 \begin_inset Flex Code
28200 \begin_layout Plain Layout
28206 The front part of the rotation command.
28209 \begin_layout Description
28210 \begin_inset Flex Code
28213 \begin_layout Plain Layout
28219 The back part of the rotation command.
28222 \begin_layout Standard
28223 The value string of the
28224 \begin_inset Flex Code
28227 \begin_layout Plain Layout
28233 command supports additionally the following substitutions if they are enabled
28235 \begin_inset Flex Code
28238 \begin_layout Plain Layout
28245 \begin_inset Flex Code
28248 \begin_layout Plain Layout
28257 \begin_layout Description
28258 \begin_inset Flex Code
28261 \begin_layout Plain Layout
28270 \begin_layout Description
28271 \begin_inset Flex Code
28274 \begin_layout Plain Layout
28283 \begin_layout Description
28284 \begin_inset Flex Code
28287 \begin_layout Plain Layout
28296 \begin_layout Description
28297 \begin_inset Flex Code
28300 \begin_layout Plain Layout
28306 The rotation option.
28309 \begin_layout Standard
28310 You may ask why there are so many path macros.
28311 There are mainly two reasons:
28314 \begin_layout Enumerate
28315 Relative and absolute file names should remain relative or absolute, respectivel
28317 Users may have reasons to prefer either form.
28318 Relative names are useful for portable documents that should work on different
28319 machines, for example.
28320 Absolute names may be required by some programs.
28323 \begin_layout Enumerate
28325 treats relative file names differently than \SpecialChar LyX
28326 and other programs in nested
28328 For \SpecialChar LyX
28329 , a relative file name is always relative to the document that contains
28331 For \SpecialChar LaTeX
28332 , it is always relative to the master document.
28333 These two definitions are identical if you have only one document, but
28334 differ if you have a master document that includes part documents.
28335 That means that relative filenames must be transformed when presented to
28338 Fortunately \SpecialChar LyX
28339 does this automatically for you if you choose the right macros.
28342 \begin_layout Standard
28343 So which path macro should be used in new template definitions? The rule
28347 \begin_layout Itemize
28349 \begin_inset Flex Code
28352 \begin_layout Plain Layout
28358 if an absolute path is required.
28361 \begin_layout Itemize
28363 \begin_inset Flex Code
28366 \begin_layout Plain Layout
28367 $$AbsOrRelPathMaster
28372 if the substituted string is some kind of \SpecialChar LaTeX
28376 \begin_layout Itemize
28378 \begin_inset Flex Code
28381 \begin_layout Plain Layout
28382 $$AbsOrRelPathParent
28387 in order to preserve the user's choice.
28390 \begin_layout Standard
28391 There are special cases where this rule does not work and e.
28392 \begin_inset space \thinspace{}
28396 \begin_inset space \space{}
28399 relative names are needed, but normally it will work just fine.
28400 One example for such a case is the command
28401 \begin_inset Flex Code
28404 \begin_layout Plain Layout
28405 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
28410 in the XFig template above: We can't use the absolute name because the
28412 \begin_inset Flex Code
28415 \begin_layout Plain Layout
28421 files needs the relative name in order to rewrite the file content.
28424 \begin_layout Section
28425 Security discussion
28426 \begin_inset CommandInset label
28428 name "sec:Security-discussion"
28435 \begin_layout Standard
28436 The external material feature interfaces with a lot of external programs
28437 and does so automatically, so we have to consider the security implications
28439 In particular, since you have the option of including your own filenames
28440 and/or parameter strings and those are expanded into a command, it seems
28441 that it would be possible to create a malicious document which executes
28442 arbitrary commands when a user views or prints the document.
28443 This is something we definitely want to avoid.
28446 \begin_layout Standard
28447 However, since the external program commands are specified in the template
28448 configuration file only, there are no security issues if \SpecialChar LyX
28449 is properly configure
28450 d with safe templates only.
28451 This is so because the external programs are invoked with the
28452 \begin_inset Flex Code
28455 \begin_layout Plain Layout
28461 -system call rather than the
28462 \begin_inset Flex Code
28465 \begin_layout Plain Layout
28471 system-call, so it's not possible to execute arbitrary commands from the
28472 filename or parameter section via the shell.
28475 \begin_layout Standard
28476 This also implies that you are restricted in what command strings you can
28477 use in the external material templates.
28478 In particular, pipes and redirection are not readily available.
28479 This has to be so if \SpecialChar LyX
28480 should remain safe.
28481 If you want to use some of the shell features, you should write a safe
28482 script to do this in a controlled manner, and then invoke the script from
28483 the command string.
28487 \begin_layout Standard
28488 It is possible to design a template that interacts directly with the shell,
28489 but since this would allow a malicious user to execute arbitrary commands
28490 by writing clever filenames and/or parameters, we generally recommend that
28491 you only use safe scripts that work with the
28492 \begin_inset Flex Code
28495 \begin_layout Plain Layout
28501 system call in a controlled manner.
28502 Of course, for use in a controlled environment, it can be tempting to just
28503 fall back to use ordinary shell scripts.
28504 If you do so, be aware that you
28508 provide an easily exploitable security hole in your system.
28509 Of course it stands to reason that such unsafe templates will never be
28510 included in the standard \SpecialChar LyX
28511 distribution, although we do encourage people
28512 to submit new templates in the open source tradition.
28513 But \SpecialChar LyX
28514 as shipped from the official distribution channels will never have
28518 \begin_layout Standard
28519 Including external material provides a lot of power, and you have to be
28520 careful not to introduce security hazards with this power.
28521 A subtle error in a single line in an innocent looking script can open
28522 the door to huge security problems.
28523 So if you do not fully understand the issues, we recommend that you consult
28524 a knowledgeable security professional or the \SpecialChar LyX
28525 development team if you have
28526 any questions about whether a given template is safe or not.
28527 And do this before you use it in an uncontrolled environment.
28530 \begin_layout Chapter
28532 List of supported \SpecialChar LyX
28533 functions to be used in layouts
28534 \begin_inset CommandInset label
28536 name "chap:List-of-functions"
28543 \begin_layout Standard
28545 \begin_inset Tabular
28546 <lyxtabular version="3" rows="11" columns="8">
28547 <features tabularvalignment="middle">
28548 <column alignment="left" valignment="top">
28549 <column alignment="left" valignment="top">
28550 <column alignment="left" valignment="top">
28551 <column alignment="left" valignment="top">
28552 <column alignment="left" valignment="top">
28553 <column alignment="left" valignment="top">
28554 <column alignment="left" valignment="top">
28555 <column alignment="left" valignment="top">
28557 <cell alignment="left" valignment="top" usebox="none">
28560 \begin_layout Plain Layout
28566 <cell alignment="left" valignment="top" usebox="none">
28569 \begin_layout Plain Layout
28575 <cell alignment="left" valignment="top" usebox="none">
28578 \begin_layout Plain Layout
28584 <cell alignment="left" valignment="top" usebox="none">
28587 \begin_layout Plain Layout
28593 <cell alignment="center" valignment="top" usebox="none">
28596 \begin_layout Plain Layout
28602 <cell alignment="center" valignment="top" usebox="none">
28605 \begin_layout Plain Layout
28611 <cell alignment="center" valignment="top" usebox="none">
28614 \begin_layout Plain Layout
28620 <cell alignment="center" valignment="top" usebox="none">
28623 \begin_layout Plain Layout
28631 <cell alignment="left" valignment="top" usebox="none">
28634 \begin_layout Plain Layout
28640 <cell alignment="left" valignment="top" usebox="none">
28643 \begin_layout Plain Layout
28649 <cell alignment="left" valignment="top" usebox="none">
28652 \begin_layout Plain Layout
28658 <cell alignment="left" valignment="top" usebox="none">
28661 \begin_layout Plain Layout
28667 <cell alignment="center" valignment="top" usebox="none">
28670 \begin_layout Plain Layout
28676 <cell alignment="center" valignment="top" usebox="none">
28679 \begin_layout Plain Layout
28685 <cell alignment="center" valignment="top" usebox="none">
28688 \begin_layout Plain Layout
28694 <cell alignment="center" valignment="top" usebox="none">
28697 \begin_layout Plain Layout
28705 <cell alignment="left" valignment="top" usebox="none">
28708 \begin_layout Plain Layout
28714 <cell alignment="left" valignment="top" usebox="none">
28717 \begin_layout Plain Layout
28723 <cell alignment="left" valignment="top" usebox="none">
28726 \begin_layout Plain Layout
28732 <cell alignment="left" valignment="top" usebox="none">
28735 \begin_layout Plain Layout
28741 <cell alignment="center" valignment="top" usebox="none">
28744 \begin_layout Plain Layout
28750 <cell alignment="center" valignment="top" usebox="none">
28753 \begin_layout Plain Layout
28759 <cell alignment="center" valignment="top" usebox="none">
28762 \begin_layout Plain Layout
28768 <cell alignment="center" valignment="top" usebox="none">
28771 \begin_layout Plain Layout
28779 <cell alignment="left" valignment="top" usebox="none">
28782 \begin_layout Plain Layout
28788 <cell alignment="left" valignment="top" usebox="none">
28791 \begin_layout Plain Layout
28797 <cell alignment="left" valignment="top" usebox="none">
28800 \begin_layout Plain Layout
28806 <cell alignment="left" valignment="top" usebox="none">
28809 \begin_layout Plain Layout
28815 <cell alignment="center" valignment="top" usebox="none">
28818 \begin_layout Plain Layout
28824 <cell alignment="center" valignment="top" usebox="none">
28827 \begin_layout Plain Layout
28833 <cell alignment="center" valignment="top" usebox="none">
28836 \begin_layout Plain Layout
28842 <cell alignment="center" valignment="top" usebox="none">
28845 \begin_layout Plain Layout
28853 <cell alignment="left" valignment="top" usebox="none">
28856 \begin_layout Plain Layout
28862 <cell alignment="left" valignment="top" usebox="none">
28865 \begin_layout Plain Layout
28871 <cell alignment="left" valignment="top" usebox="none">
28874 \begin_layout Plain Layout
28880 <cell alignment="left" valignment="top" usebox="none">
28883 \begin_layout Plain Layout
28889 <cell alignment="center" valignment="top" usebox="none">
28892 \begin_layout Plain Layout
28898 <cell alignment="center" valignment="top" usebox="none">
28901 \begin_layout Plain Layout
28907 <cell alignment="center" valignment="top" usebox="none">
28910 \begin_layout Plain Layout
28916 <cell alignment="center" valignment="top" usebox="none">
28919 \begin_layout Plain Layout
28927 <cell alignment="left" valignment="top" usebox="none">
28930 \begin_layout Plain Layout
28936 <cell alignment="left" valignment="top" usebox="none">
28939 \begin_layout Plain Layout
28945 <cell alignment="left" valignment="top" usebox="none">
28948 \begin_layout Plain Layout
28954 <cell alignment="left" valignment="top" usebox="none">
28957 \begin_layout Plain Layout
28963 <cell alignment="center" valignment="top" usebox="none">
28966 \begin_layout Plain Layout
28972 <cell alignment="center" valignment="top" usebox="none">
28975 \begin_layout Plain Layout
28981 <cell alignment="center" valignment="top" usebox="none">
28984 \begin_layout Plain Layout
28990 <cell alignment="center" valignment="top" usebox="none">
28993 \begin_layout Plain Layout
29001 <cell alignment="left" valignment="top" usebox="none">
29004 \begin_layout Plain Layout
29010 <cell alignment="left" valignment="top" usebox="none">
29013 \begin_layout Plain Layout
29019 <cell alignment="left" valignment="top" usebox="none">
29022 \begin_layout Plain Layout
29028 <cell alignment="left" valignment="top" usebox="none">
29031 \begin_layout Plain Layout
29037 <cell alignment="center" valignment="top" usebox="none">
29040 \begin_layout Plain Layout
29046 <cell alignment="center" valignment="top" usebox="none">
29049 \begin_layout Plain Layout
29055 <cell alignment="center" valignment="top" usebox="none">
29058 \begin_layout Plain Layout
29064 <cell alignment="center" valignment="top" usebox="none">
29067 \begin_layout Plain Layout
29075 <cell alignment="left" valignment="top" usebox="none">
29078 \begin_layout Plain Layout
29084 <cell alignment="left" valignment="top" usebox="none">
29087 \begin_layout Plain Layout
29093 <cell alignment="left" valignment="top" usebox="none">
29096 \begin_layout Plain Layout
29102 <cell alignment="left" valignment="top" usebox="none">
29105 \begin_layout Plain Layout
29111 <cell alignment="center" valignment="top" usebox="none">
29114 \begin_layout Plain Layout
29120 <cell alignment="center" valignment="top" usebox="none">
29123 \begin_layout Plain Layout
29129 <cell alignment="center" valignment="top" usebox="none">
29132 \begin_layout Plain Layout
29138 <cell alignment="center" valignment="top" usebox="none">
29141 \begin_layout Plain Layout
29149 <cell alignment="left" valignment="top" usebox="none">
29152 \begin_layout Plain Layout
29158 <cell alignment="left" valignment="top" usebox="none">
29161 \begin_layout Plain Layout
29167 <cell alignment="left" valignment="top" usebox="none">
29170 \begin_layout Plain Layout
29176 <cell alignment="left" valignment="top" usebox="none">
29179 \begin_layout Plain Layout
29185 <cell alignment="center" valignment="top" usebox="none">
29188 \begin_layout Plain Layout
29194 <cell alignment="center" valignment="top" usebox="none">
29197 \begin_layout Plain Layout
29203 <cell alignment="center" valignment="top" usebox="none">
29206 \begin_layout Plain Layout
29212 <cell alignment="center" valignment="top" usebox="none">
29215 \begin_layout Plain Layout
29223 <cell alignment="left" valignment="top" usebox="none">
29226 \begin_layout Plain Layout
29232 <cell alignment="left" valignment="top" usebox="none">
29235 \begin_layout Plain Layout
29241 <cell alignment="left" valignment="top" usebox="none">
29244 \begin_layout Plain Layout
29250 <cell alignment="left" valignment="top" usebox="none">
29253 \begin_layout Plain Layout
29259 <cell alignment="center" valignment="top" usebox="none">
29262 \begin_layout Plain Layout
29268 <cell alignment="center" valignment="top" usebox="none">
29271 \begin_layout Plain Layout
29277 <cell alignment="center" valignment="top" usebox="none">
29280 \begin_layout Plain Layout
29286 <cell alignment="center" valignment="top" usebox="none">
29289 \begin_layout Plain Layout
29297 <cell alignment="center" valignment="top" usebox="none">
29300 \begin_layout Plain Layout
29306 <cell alignment="center" valignment="top" usebox="none">
29309 \begin_layout Plain Layout
29315 <cell alignment="center" valignment="top" usebox="none">
29318 \begin_layout Plain Layout
29324 <cell alignment="center" valignment="top" usebox="none">
29327 \begin_layout Plain Layout
29333 <cell alignment="center" valignment="top" usebox="none">
29336 \begin_layout Plain Layout
29342 <cell alignment="center" valignment="top" usebox="none">
29345 \begin_layout Plain Layout
29351 <cell alignment="center" valignment="top" usebox="none">
29354 \begin_layout Plain Layout
29360 <cell alignment="center" valignment="top" usebox="none">
29363 \begin_layout Plain Layout
29377 \begin_layout Chapter
29378 Names of available colors to be used in layouts
29379 \begin_inset CommandInset label
29381 name "chap:Names-of-colors"
29388 \begin_layout Standard
29389 The colors listed below are the standard colors and those that you can adjust
29390 in the \SpecialChar LyX
29394 \begin_layout Section
29398 \begin_layout Standard
29399 The following are no real colors, but rather act on color definitions:
29402 \begin_layout Description
29403 ignore The color is ignored
29406 \begin_layout Description
29407 inherit The color is inherited
29410 \begin_layout Description
29423 No particular color – clear or default
29426 \begin_layout Section
29430 \begin_layout Standard
29431 These are fixed colors that cannot me customized:
29434 \begin_layout Description
29438 \begin_layout Description
29442 \begin_layout Description
29446 \begin_layout Description
29450 \begin_layout Description
29454 \begin_layout Description
29458 \begin_layout Description
29462 \begin_layout Description
29466 \begin_layout Description
29470 \begin_layout Description
29474 \begin_layout Description
29478 \begin_layout Description
29482 \begin_layout Description
29486 \begin_layout Description
29490 \begin_layout Description
29494 \begin_layout Description
29498 \begin_layout Description
29502 \begin_layout Description
29506 \begin_layout Description
29510 \begin_layout Section
29514 \begin_layout Standard
29515 These are the colors allocated to specific elements in
29518 arg "dialog-show prefs"
29524 \begin_layout Description
29525 added_space Added space color
29528 \begin_layout Description
29529 addedtext Added text color
29532 \begin_layout Description
29533 appendix Appendix marker color
29536 \begin_layout Description
29537 background Background color
29540 \begin_layout Description
29541 bottomarea Bottom area color
29544 \begin_layout Description
29545 branchlabel Label color for branches
29548 \begin_layout Description
29549 buttonbg Color used for button background
29552 \begin_layout Description
29553 buttonframe Color for inset button frames
29556 \begin_layout Description
29557 buttonhoverbg Color used for button background under focus
29560 \begin_layout Description
29561 changebar Changebar color
29564 \begin_layout Description
29565 changedtextauthor1 Changed text color author 1
29568 \begin_layout Description
29569 changedtextauthor2 Changed text color author 2
29572 \begin_layout Description
29573 changedtextauthor3 Changed text color author 3
29576 \begin_layout Description
29577 changedtextauthor4 Changed text color author 4
29580 \begin_layout Description
29581 changedtextauthor5 Changed text color author 5
29584 \begin_layout Description
29585 collapsible Collapsible insets text color
29588 \begin_layout Description
29589 collapsibleframe Collapsible insets framecolor
29592 \begin_layout Description
29593 command Text color for command insets
29596 \begin_layout Description
29597 commandbg Background color for command insets
29600 \begin_layout Description
29601 commandframe Frame color for command insets
29604 \begin_layout Description
29605 comment Label color for comments
29608 \begin_layout Description
29609 commentbg Background color of comments
29612 \begin_layout Description
29613 cursor Cursor color
29616 \begin_layout Description
29617 deletedtext Deleted text color
29620 \begin_layout Description
29621 deletedtextmodifier Deleted text modifying color
29624 \begin_layout Description
29625 depthbar Color for the depth bars in the margin
29628 \begin_layout Description
29629 eolmarker End of line marker color
29632 \begin_layout Description
29633 error Color of the \SpecialChar LaTeX
29637 \begin_layout Description
29638 footlabel Label color for footnotes
29641 \begin_layout Description
29642 foreground Foreground color
29645 \begin_layout Description
29646 graphicsbg Graphics inset background color
29649 \begin_layout Description
29650 greyedoutbg Background color of greyedout inset
29653 \begin_layout Description
29654 greyedoutlabel Label color for greyedout insets
29657 \begin_layout Description
29658 greyedouttext Color for greyedout inset text
29661 \begin_layout Description
29662 indexlabel Label color for index insets
29665 \begin_layout Description
29666 inlinecompletion Inline completion color
29669 \begin_layout Description
29670 insetbg Inset marker background color
29673 \begin_layout Description
29674 insetframe Inset marker frame color
29677 \begin_layout Description
29678 language Color for marking foreign language words
29681 \begin_layout Description
29682 latex Text color in \SpecialChar LaTeX
29686 \begin_layout Description
29687 listingsbg Background color of listings inset
29690 \begin_layout Description
29691 marginlabel Label color for margin notes
29694 \begin_layout Description
29695 math Math inset text color
29698 \begin_layout Description
29699 mathbg Math inset background color
29702 \begin_layout Description
29703 mathcorners Math inset frame color not under focus
29706 \begin_layout Description
29707 mathframe Math inset frame color under focus
29710 \begin_layout Description
29711 mathline Math line color
29714 \begin_layout Description
29715 mathmacrobg Macro math inset background color
29718 \begin_layout Description
29719 mathmacroblend Macro math blended color
29722 \begin_layout Description
29723 mathmacroframe Macro math frame color
29726 \begin_layout Description
29727 mathmacrohoverbg Macro math inset background color hovered
29730 \begin_layout Description
29731 mathmacrolabel Macro math label color
29734 \begin_layout Description
29735 mathmacronewarg Macro template color for new parameters
29738 \begin_layout Description
29739 mathmacrooldarg Macro template color for old parameters
29742 \begin_layout Description
29743 newpage New page color
29746 \begin_layout Description
29747 nonunique_inlinecompletion Inline completion color for the non-unique part
29750 \begin_layout Description
29751 note Label color for notes
29754 \begin_layout Description
29755 notebg Background color of notes
29758 \begin_layout Description
29759 pagebreak Page break/line break color
29762 \begin_layout Description
29763 paragraphmarker Color used for the pilcrow sign to mark the end of a paragraph
29766 \begin_layout Description
29767 phantomtext Text color for phantom insets
29770 \begin_layout Description
29771 preview The color used for previews
29774 \begin_layout Description
29775 previewframe Preview frame color
29778 \begin_layout Description
29779 regexpframe Color for regexp frame
29782 \begin_layout Description
29783 scroll Color that indicates when a row can be scrolled
29786 \begin_layout Description
29787 selection Background color of selected text
29790 \begin_layout Description
29791 selectiontext Foreground color of selected text
29794 \begin_layout Description
29795 shadedbg Background color of shaded box
29798 \begin_layout Description
29799 special Special chars text color
29802 \begin_layout Description
29803 tabularline Table line color
29806 \begin_layout Description
29807 tabularonoffline Table line color
29810 \begin_layout Description
29811 urllabel Label color for URL insets
29814 \begin_layout Description
29815 urltext Color for URL inset text