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 no
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
112 \color #f5fae7 #0a0518
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
134 \postpone_fragile_content false
138 \docbook_table_output 0
139 \docbook_mathml_prefix 1
140 \author -970929547 "Thibaut Cuvelier"
141 \author -712698321 "Jürgen Spitzmüller"
142 \author -584632292 "Richard Kimberly Heck"
143 \author -495245474 "Jean-Marc Lasgouttes"
146 \author 34634807 "Jean-Pierre"
147 \author 232239728 "Owner"
148 \author 731793113 "Richard Kimberly Heck" rikiheck@lyx.org
149 \author 1075283030 "Thibaut"
155 Customizing \SpecialChar LyX
156 : Features for the Advanced User
160 by the \SpecialChar LyX
165 \begin_layout Plain Layout
166 If you have comments or error corrections, please send them to the \SpecialChar LyX
169 \begin_inset CommandInset href
171 target "lyx-docs@lists.lyx.org"
179 \begin_inset Quotes eld
183 \begin_inset Quotes erd
186 in the subject header, and please cc the current maintainer of this file,
188 \change_inserted 5863208 1604930692
192 \change_inserted 5863208 1604930729
194 \change_deleted 5863208 1604930668
203 \begin_inset Newline newline
207 \begin_inset Newline newline
213 \begin_layout Standard
214 \begin_inset CommandInset toc
215 LatexCommand tableofcontents
222 \begin_layout Standard
223 \begin_inset Note Note
226 \begin_layout Plain Layout
227 Please use change tracking when modifying this document.
228 This makes it easier for our translators to recognize things that have
229 been changed, and it helps the maintainer keep up-to-date with what's been
238 \begin_layout Chapter
242 \begin_layout Standard
243 This manual covers the customization features present in \SpecialChar LyX
245 In it, we discuss issues like keyboard shortcuts, screen previewing options,
246 printer options, sending commands to \SpecialChar LyX
247 via the \SpecialChar LyX
248 Server, internationalization,
249 installing new \SpecialChar LaTeX
250 classes and \SpecialChar LyX
252 We can't possibly hope to touch on everything you can change—our developers
253 add new features faster than we can document them—but we will explain the
254 most common customizations and hopefully point you in the right direction
255 for some of the more obscure ones.
258 \begin_layout Standard
259 \begin_inset Branch OutDated
263 \begin_layout Standard
264 Information from previous versions of this document that now seems to be
265 outdated is contained in the OutDated branch of this document.
266 By default, this information will not appear in the \SpecialChar LaTeX
275 \begin_layout Chapter
280 \begin_layout Standard
281 This chapter aims to help you to find your way through the \SpecialChar LyX
284 Before continuing to read this chapter, you should find out where your
286 library and user directories are by using
287 \begin_inset Flex Noun
290 \begin_layout Plain Layout
291 Help\SpecialChar menuseparator
302 The library directory is the place where \SpecialChar LyX
303 places its system-wide configuration
304 files; the user directory is where you can place your modified versions.
305 We will call the former
306 \begin_inset Flex Code
309 \begin_layout Plain Layout
316 \begin_inset Flex Noun
319 \begin_layout Plain Layout
325 in the remainder of this document.
329 \begin_layout Section
331 \begin_inset Flex Code
334 \begin_layout Plain Layout
343 \begin_layout Standard
344 \begin_inset Flex Code
347 \begin_layout Plain Layout
353 and its sub-directories contain a number of files
354 \change_deleted 232239728 1604787780
357 that can be used to customize \SpecialChar LyX
359 You can change many of these files from within \SpecialChar LyX
361 \begin_inset Flex Noun
364 \begin_layout Plain Layout
365 Tools\SpecialChar menuseparator
372 Most customization that you will want to do in \SpecialChar LyX
373 is possible through this
375 However, many other inner aspects of \SpecialChar LyX
376 can be customized by modifying the
378 \begin_inset Flex Code
381 \begin_layout Plain Layout
388 These files fall in different categories, described in the following subsection
392 \begin_layout Subsection
393 Automatically generated files
396 \begin_layout Standard
398 \begin_inset Flex Noun
401 \begin_layout Plain Layout
407 are generated when you configure \SpecialChar LyX
409 They contain various default values that are
410 \change_inserted 5863208 1604919565
411 automatically detected during reconfiguration.
412 \change_deleted 232239728 1604788241
413 guessed by inspection
415 In general, it is not a good idea to modify them, since they might be overwritt
419 \begin_layout Labeling
420 \labelwidthstring 00.00.0000
421 \begin_inset Flex Code
424 \begin_layout Plain Layout
431 \change_deleted 5863208 1604919950
433 \begin_inset Note Note
436 \begin_layout Plain Layout
438 \change_inserted 232239728 1604853928
439 I capitalized the first word in all of these lists.
440 To me it looks better but it really is a stylistic thing, your call.
441 However if you are not going to capitalize them, the english in some needs
442 to be modified to make it read correctly as a sentence.
450 \change_deleted 232239728 1604853510
452 \change_inserted 232239728 1604853510
455 ontains defaults for various commands.
458 \begin_layout Labeling
459 \labelwidthstring 00.00.0000
460 \begin_inset Flex Code
463 \begin_layout Plain Layout
470 \change_deleted 232239728 1604853512
472 \change_inserted 232239728 1604853512
475 ontains the list of packages that have been recognized by \SpecialChar LyX
477 It is currently unused by the \SpecialChar LyX
478 program itself, but the information extracted,
479 and more, is made available with
480 \begin_inset Flex Noun
483 \begin_layout Plain Layout
484 Help\SpecialChar menuseparator
498 \begin_layout Labeling
499 \labelwidthstring 00.00.0000
500 \begin_inset Flex Code
503 \begin_layout Plain Layout
510 \change_deleted 232239728 1604853515
512 \change_inserted 232239728 1604853515
515 he list of text classes that have been found in your
516 \begin_inset Flex Code
519 \begin_layout Plain Layout
525 directories, along with the associated \SpecialChar LaTeX
526 document class and their description.
529 \begin_layout Labeling
530 \labelwidthstring 00.00.0000
531 \begin_inset Flex Code
534 \begin_layout Plain Layout
541 \change_deleted 232239728 1604853518
543 \change_inserted 232239728 1604853518
546 he list of layout modules found in your
547 \begin_inset Flex Code
550 \begin_layout Plain Layout
559 \begin_layout Labeling
560 \labelwidthstring 00.00.0000
561 \begin_inset Flex Code
564 \begin_layout Plain Layout
571 \change_deleted 232239728 1604853523
573 \change_inserted 232239728 1604853523
576 ists of various sorts of \SpecialChar LaTeX
577 -related files found on your system
580 \begin_layout Labeling
581 \labelwidthstring 00.00.0000
582 \begin_inset Flex Code
585 \begin_layout Plain Layout
586 doc/\SpecialChar LaTeX
592 is automatically generated during configuration from the file
593 \begin_inset Flex Code
596 \begin_layout Plain Layout
604 It contains information on your \SpecialChar LaTeX
608 \begin_layout Subsection
612 \begin_layout Standard
614 \change_deleted 5863208 1604928729
618 \change_inserted 5863208 1604928636
622 \change_inserted 5863208 1604928661
626 \begin_inset Flex Code
629 \begin_layout Plain Layout
636 \change_inserted 5863208 1604928662
638 \change_deleted 5863208 1604928642
642 \change_deleted 5863208 1604928669
644 \begin_inset Flex Code
647 \begin_layout Plain Layout
654 \change_inserted 5863208 1604928680
658 \begin_inset Flex Code
661 \begin_layout Plain Layout
669 \change_deleted 232239728 1604794430
672 exists in both places, the one in
673 \begin_inset Flex Code
676 \begin_layout Plain Layout
685 \begin_layout Labeling
686 \labelwidthstring 00.00.0000
687 \begin_inset Flex Code
690 \begin_layout Plain Layout
697 \change_deleted 232239728 1604794460
699 \change_inserted 232239728 1604794460
702 his directory contains files with the extension
703 \begin_inset Flex Code
706 \begin_layout Plain Layout
712 that define the keybindings used in \SpecialChar LyX
714 If there exists an internationalized version of the bind file
715 \change_inserted -712698321 1669371749
717 \change_deleted -712698321 1669371727
719 \begin_inset Flex Code
722 \begin_layout Plain Layout
729 \change_inserted -712698321 1669371728
731 \begin_inset Flex Code
734 \begin_layout Plain Layout
736 \change_inserted -712698321 1669371732
743 \begin_inset Quotes eld
747 \begin_inset Quotes erd
750 is the ISO language code
752 , that will be used first.
755 \begin_layout Labeling
756 \labelwidthstring 00.00.0000
757 \begin_inset Flex Code
760 \begin_layout Plain Layout
767 \change_deleted 232239728 1604794478
769 \change_inserted 232239728 1604794478
772 ontains files with the extension
773 \begin_inset Flex Code
776 \begin_layout Plain Layout
782 which define the diverse citation possibilities (natbib, biblatex etc.).
784 \begin_inset CommandInset ref
786 reference "subsec:Cite-Engine-Files"
796 \begin_layout Labeling
797 \labelwidthstring 00.00.0000
798 \begin_inset Flex Code
801 \begin_layout Plain Layout
808 \change_deleted 232239728 1604794483
810 \change_inserted 232239728 1604794486
813 ontains graphics files that can be included in documents.
817 \begin_layout Labeling
818 \labelwidthstring 00.00.0000
819 \begin_inset Flex Code
822 \begin_layout Plain Layout
829 \change_deleted 232239728 1604794492
831 \change_inserted 232239728 1604794492
834 ontains \SpecialChar LyX
835 documentation files (including the one you are currently reading).
837 \begin_inset Flex Code
840 \begin_layout Plain Layout
842 \change_deleted 232239728 1604794660
845 \change_inserted 232239728 1604794661
853 deserves special attention, as noted above.
854 The internationalized help docs are in subdirectories
855 \begin_inset Flex Code
858 \begin_layout Plain Layout
865 \begin_inset Quotes eld
869 \begin_inset Quotes erd
872 is the ISO language code.
874 \begin_inset CommandInset ref
876 reference "cha:Internationalizing-LyX"
883 \begin_layout Labeling
884 \labelwidthstring 00.00.0000
885 \begin_inset Flex Code
888 \begin_layout Plain Layout
895 \change_deleted 232239728 1604794497
897 \change_inserted 232239728 1604794497
900 ontains example files that explain how to use some features.
901 In the file browser, press the
902 \begin_inset Flex Noun
905 \begin_layout Plain Layout
914 \begin_layout Labeling
915 \labelwidthstring 00.00.0000
916 \begin_inset Flex Code
919 \begin_layout Plain Layout
926 \change_deleted 232239728 1604794500
928 \change_inserted 232239728 1604794500
931 ontains image files that are used by the
932 \begin_inset Flex Noun
935 \begin_layout Plain Layout
942 In addition, it also contains the individual icons used in the toolbar
943 and the banners that can be shown when \SpecialChar LyX
947 \begin_layout Labeling
948 \labelwidthstring 00.00.0000
949 \begin_inset Flex Code
952 \begin_layout Plain Layout
959 \change_deleted 232239728 1604794505
961 \change_inserted 232239728 1604794505
964 ontains keyboard keymapping files.
966 \begin_inset CommandInset ref
968 reference "sec:International-Keymap-Stuff"
975 \begin_layout Labeling
976 \labelwidthstring 00.00.0000
977 \begin_inset Flex Code
980 \begin_layout Plain Layout
987 \change_deleted 232239728 1604794508
989 \change_inserted 232239728 1604794508
992 ontains the text class and module files described in
993 \begin_inset CommandInset ref
995 reference "cha:Installing-New-Document"
1002 \begin_layout Labeling
1003 \labelwidthstring 00.00.0000
1004 \begin_inset Flex Code
1007 \begin_layout Plain Layout
1014 \change_deleted 232239728 1604794513
1016 \change_inserted 232239728 1604794513
1020 \begin_inset Flex Code
1023 \begin_layout Plain Layout
1029 Python scripts used to convert between \SpecialChar LyX
1031 These can be run from the command line if
1032 \change_deleted 232239728 1604794749
1035 you want to batch-convert files.
1038 \begin_layout Labeling
1039 \labelwidthstring 00.00.0000
1040 \begin_inset Flex Code
1043 \begin_layout Plain Layout
1050 \change_deleted 232239728 1604794516
1052 \change_inserted 232239728 1604794516
1055 ontains some files that demonstrate the capabilities of the
1056 \begin_inset Flex Noun
1059 \begin_layout Plain Layout
1061 \begin_inset space ~
1070 Also contains some scripts used by \SpecialChar LyX
1074 \begin_layout Labeling
1075 \labelwidthstring 00.00.0000
1076 \begin_inset Flex Code
1079 \begin_layout Plain Layout
1086 \change_deleted 232239728 1604794520
1088 \change_inserted 232239728 1604794520
1091 ontains the standard \SpecialChar LyX
1092 template files described in
1093 \begin_inset CommandInset ref
1095 reference "subsec:Creating-Templates"
1102 \begin_layout Labeling
1103 \labelwidthstring 00.00.0000
1104 \begin_inset Flex Code
1107 \begin_layout Plain Layout
1114 \change_deleted 232239728 1604794524
1116 \change_inserted 232239728 1604794524
1119 ontains files with the extension
1120 \begin_inset Flex Code
1123 \begin_layout Plain Layout
1129 that define the user interface to \SpecialChar LyX
1131 That is, the files define which items appear in which menus and the items
1132 appearing on the toolbar.
1135 \begin_layout Labeling
1136 \labelwidthstring 00.00.0000
1137 \begin_inset Flex Code
1140 \begin_layout Plain Layout
1147 \change_deleted 232239728 1604794528
1149 \change_inserted 232239728 1604794528
1152 ontains files with the extension
1153 \begin_inset Flex Code
1156 \begin_layout Plain Layout
1162 which define the templates for the insertion of external material to a
1165 \begin_inset CommandInset ref
1167 reference "chap:Including-External-Material"
1174 \begin_layout Subsection
1175 Files you don't want to modify
1178 \begin_layout Standard
1179 These files are used internally by \SpecialChar LyX
1180 and you generally do not need to modify
1181 them unless you are a developer.
1184 \begin_layout Labeling
1185 \labelwidthstring 00.00.0000
1186 \begin_inset Flex Code
1189 \begin_layout Plain Layout
1196 \change_deleted 232239728 1604797616
1198 \change_inserted 232239728 1604797616
1201 his file contains the list of \SpecialChar LyX
1203 The contents are displayed with the menu entry
1204 \begin_inset Flex Noun
1207 \begin_layout Plain Layout
1208 Help\SpecialChar menuseparator
1210 \begin_inset space ~
1221 \begin_layout Labeling
1222 \labelwidthstring 00.00.0000
1223 \begin_inset Flex Code
1226 \begin_layout Plain Layout
1233 \change_deleted 232239728 1604797620
1235 \change_inserted 232239728 1604797620
1238 his is a \SpecialChar LaTeX
1239 script used during the configuration process.
1240 Do not run directly.
1243 \begin_layout Labeling
1244 \labelwidthstring 00.00.0000
1245 \begin_inset Flex Code
1248 \begin_layout Plain Layout
1255 \change_deleted 232239728 1604797624
1257 \change_inserted 232239728 1604797624
1260 his is a Python script that is used to re-configure \SpecialChar LyX
1262 It creates configuration files in the directory it was run from.
1265 \begin_layout Subsection
1266 Other files needing a line or two
1269 \begin_layout Labeling
1270 \labelwidthstring 00.00.0000
1271 \begin_inset Flex Code
1274 \begin_layout Plain Layout
1281 \change_deleted 232239728 1604797580
1283 \change_inserted 232239728 1604797580
1286 his contains tables describing how different character encodings can be
1290 \begin_layout Labeling
1291 \labelwidthstring 00.00.0000
1292 \begin_inset Flex Code
1295 \begin_layout Plain Layout
1302 \change_deleted 232239728 1604797584
1304 \change_inserted 232239728 1604797584
1307 his file contains a list of all the languages currently supported by \SpecialChar LyX
1311 \begin_layout Labeling
1312 \labelwidthstring 00.00.0000
1313 \begin_inset Flex Code
1316 \begin_layout Plain Layout
1323 \change_deleted 232239728 1604797587
1325 \change_inserted 232239728 1604797587
1328 ontains information about the supported fonts.
1331 \begin_layout Labeling
1332 \labelwidthstring 00.00.0000
1333 \begin_inset Flex Code
1336 \begin_layout Plain Layout
1343 \change_deleted 232239728 1604797591
1345 \change_inserted 232239728 1604797591
1348 his file contains translations for internationalized paragraph styles (see
1350 \begin_inset CommandInset ref
1352 reference "subsec:I18n"
1359 \begin_layout Labeling
1360 \labelwidthstring 00.00.0000
1361 \begin_inset Flex Code
1364 \begin_layout Plain Layout
1371 \change_deleted 232239728 1604797594
1373 \change_inserted 232239728 1604797594
1376 his file contains information about Unicode-encoded glyphs and the way they
1377 are supported by \SpecialChar LyX
1378 via \SpecialChar LaTeX
1382 \begin_layout Section
1383 Your local configuration directory
1386 \begin_layout Standard
1387 Even if you are using \SpecialChar LyX
1388 as an unprivileged user, you might want to change
1390 configuration for your own use.
1392 \begin_inset Flex Code
1395 \begin_layout Plain Layout
1401 directory contains all your personal configuration files.
1402 This is the directory described as
1403 \begin_inset Quotes eld
1407 \begin_inset Quotes erd
1411 \begin_inset Flex Noun
1414 \begin_layout Plain Layout
1415 Help\SpecialChar menuseparator
1417 \begin_inset space ~
1426 This directory is used as a mirror of
1427 \begin_inset Flex Code
1430 \begin_layout Plain Layout
1436 , which means that every file in
1437 \begin_inset Flex Code
1440 \begin_layout Plain Layout
1446 is a replacement for the corresponding file in
1447 \begin_inset Flex Code
1450 \begin_layout Plain Layout
1457 Any configuration file described in the above sections can be placed either
1458 in the system-wide directory, in which case it will affect all users, or
1459 in your local directory for your own use.
1462 \begin_layout Standard
1463 To make things clearer, let's provide a few examples:
1466 \begin_layout Itemize
1467 The preferences set in the
1468 \begin_inset Flex Noun
1471 \begin_layout Plain Layout
1472 Tools\SpecialChar menuseparator
1478 dialog are saved to a file
1479 \begin_inset Flex Code
1482 \begin_layout Plain Layout
1489 \begin_inset Flex Code
1492 \begin_layout Plain Layout
1501 \begin_layout Itemize
1502 When you reconfigure using
1503 \begin_inset Flex Noun
1506 \begin_layout Plain Layout
1507 Tools\SpecialChar menuseparator
1515 \begin_inset Flex Code
1518 \begin_layout Plain Layout
1524 script, and the resulting files are written in your local configuration
1526 This means that any additional text class file that you might have added
1528 \begin_inset Flex Code
1531 \begin_layout Plain Layout
1537 will be added to the list of classes in the
1538 \begin_inset Flex Noun
1541 \begin_layout Plain Layout
1542 Document\SpecialChar menuseparator
1551 \begin_layout Itemize
1552 If you get some updated documentation from
1553 \change_inserted 232239728 1604798171
1557 ftp site and cannot install it because you do not have sysadmin rights
1558 on your system, you can just copy the files
1559 \change_deleted 232239728 1604798193
1561 \change_inserted 232239728 1604798193
1565 \begin_inset Flex Code
1568 \begin_layout Plain Layout
1574 and the items in the
1575 \begin_inset Flex Noun
1578 \begin_layout Plain Layout
1584 menu will open them!
1587 \begin_layout Section
1588 Running \SpecialChar LyX
1589 with multiple configurations
1592 \begin_layout Standard
1593 The configuration freedom of the local configuration directory may not suffice
1594 if you want to have more than one configuration at your disposal.
1595 For example, you may want to
1596 \change_deleted 232239728 1604798238
1599 use different key bindings or printer settings at different times.
1600 You can achieve this by having several such directories.
1601 You then specify which directory to use at run-time.
1604 \begin_layout Standard
1605 Invoking \SpecialChar LyX
1606 with the command line switch
1607 \begin_inset Flex Code
1610 \begin_layout Plain Layout
1620 instructs the program to read the configuration from that directory, and
1621 not from the default directory.
1622 (You can determine the default directory by running \SpecialChar LyX
1624 \begin_inset Flex Code
1627 \begin_layout Plain Layout
1633 switch.) If the specified directory does not exist, \SpecialChar LyX
1635 for you, just like it does for the default directory
1636 \change_deleted 232239728 1604798318
1639 the first time you run the program.
1640 You can modify the configuration options in this additional user directory
1641 exactly as you would for the default directory.
1642 These directories are completely independent (but read on).
1643 Note that setting the environment variable
1644 \begin_inset Flex Code
1647 \begin_layout Plain Layout
1653 to some value has exactly the same effect.
1656 \begin_layout Standard
1657 Having several configurations also requires more maintenance: if you want
1658 to add a new layout to
1659 \begin_inset Flex Code
1662 \begin_layout Plain Layout
1668 which you want available from all your configurations, you must add it
1669 to each directory separately.
1670 You can avoid this with the following trick: after \SpecialChar LyX
1671 creates the additional
1672 directory, most of the subdirectories (see above) are empty.
1673 If you want the new configuration to mirror an existing one, replace the
1674 empty subdirectory with a symbolic link to the matching subdirectory in
1675 the existing configuration.
1677 \begin_inset Flex Code
1680 \begin_layout Plain Layout
1686 subdirectory, however, since it contains a file written by the configuration
1687 script (also accessible through
1688 \begin_inset Flex Noun
1691 \begin_layout Plain Layout
1692 Tools\SpecialChar menuseparator
1698 ) which is configuration
1699 \change_deleted 232239728 1604798083
1701 \change_inserted 232239728 1604798100
1707 \begin_layout Chapter
1708 The Preferences dialog
1711 \begin_layout Standard
1712 All options of the preferences dialog are described in the Appendix
1714 The Preferences Dialog
1721 For some options you might find here more details.
1724 \begin_layout Section
1726 \begin_inset CommandInset label
1735 \begin_layout Standard
1736 The first step is to define your file formats if they are not already defined.
1738 \begin_inset Flex Noun
1741 \begin_layout Plain Layout
1742 Tools\SpecialChar menuseparator
1750 \begin_inset Flex Noun
1753 \begin_layout Plain Layout
1754 File Handling\SpecialChar menuseparator
1761 \begin_inset Flex Noun
1764 \begin_layout Plain Layout
1770 button to define your new format.
1772 \begin_inset Flex Noun
1775 \begin_layout Plain Layout
1781 field contains the name used to identify the format in the GUI.
1783 \begin_inset Flex Noun
1786 \begin_layout Plain Layout
1792 is used to identify the format internally.
1793 You will also need to enter a file extension.
1794 These are all required.
1796 \begin_inset Flex Noun
1799 \begin_layout Plain Layout
1805 field is used to provide a keyboard shortcut on the menus.
1806 (For example, pressing
1807 \begin_inset Flex Noun
1810 \begin_layout Plain Layout
1817 \begin_inset Flex Noun
1820 \begin_layout Plain Layout
1821 Document\SpecialChar menuseparator
1822 View (Other Formats)\SpecialChar menuseparator
1831 \begin_layout Standard
1833 \begin_inset Flex Noun
1836 \begin_layout Plain Layout
1843 \begin_inset Flex Noun
1846 \begin_layout Plain Layout
1853 For example, you might want to use
1854 \begin_inset Flex Noun
1857 \begin_layout Plain Layout
1863 to view PostScript files.
1864 You can enter the command needed to start the program in the corresponding
1866 In defining this command, you can use the four variables listed in the
1868 The viewer is launched when you view an image in \SpecialChar LyX
1870 \begin_inset Flex Noun
1873 \begin_layout Plain Layout
1874 Document\SpecialChar menuseparator
1881 The editor is for example launched when you right-click on an image and
1883 \begin_inset Flex Noun
1886 \begin_layout Plain Layout
1892 in the appearing context menu.
1895 \begin_layout Standard
1897 \begin_inset Flex Noun
1900 \begin_layout Plain Layout
1906 type of a format is optional, but if it is specified, it must be unique
1908 It is used to detect files of this format from the file contents.
1909 For some important file formats there is no MIME type officially registered
1911 \begin_inset CommandInset href
1914 target "http://www.iana.org/assignments/media-types/"
1920 Therefore \SpecialChar LyX
1921 uses the extended list of MIME types as specified by
1922 \begin_inset CommandInset href
1924 name "freedesktop.org"
1925 target "http://www.freedesktop.org/wiki/Specifications/shared-mime-info-spec"
1933 \begin_layout Standard
1935 \begin_inset Flex Noun
1938 \begin_layout Plain Layout
1944 option tells \SpecialChar LyX
1945 that a format is suitable for document export.
1946 If this is set and if a suitable conversion route exists (see
1947 \begin_inset CommandInset ref
1949 reference "sec:Converters"
1953 ), the format will appear in the
1954 \begin_inset Flex Noun
1957 \begin_layout Plain Layout
1958 File\SpecialChar menuseparator
1965 The format will also appear in the
1966 \begin_inset Flex Noun
1969 \begin_layout Plain Layout
1970 Document\SpecialChar menuseparator
1976 menu if a viewer is specified for the format.
1977 Pure image formats, such as
1978 \begin_inset Flex Code
1981 \begin_layout Plain Layout
1987 , should not use this option.
1988 Formats that can both represent vector graphics and documents like
1989 \begin_inset Flex Code
1992 \begin_layout Plain Layout
2001 \begin_layout Standard
2003 \begin_inset Flex Noun
2006 \begin_layout Plain Layout
2007 Vector graphics format
2012 tells \SpecialChar LyX
2013 that a format can contain vector graphics.
2014 This information is used to determine the target format of included graphics
2016 \begin_inset Flex Noun
2019 \begin_layout Plain Layout
2026 Included graphics may need to be converted to either
2027 \begin_inset Flex Noun
2030 \begin_layout Plain Layout
2037 \begin_inset Flex Noun
2040 \begin_layout Plain Layout
2047 \begin_inset Flex Noun
2050 \begin_layout Plain Layout
2057 \begin_inset Flex Noun
2060 \begin_layout Plain Layout
2066 cannot handle other image formats.
2067 If an included graphic is not already in
2068 \begin_inset Flex Noun
2071 \begin_layout Plain Layout
2078 \begin_inset Flex Noun
2081 \begin_layout Plain Layout
2088 \begin_inset Flex Noun
2091 \begin_layout Plain Layout
2097 format, it is converted to
2098 \begin_inset Flex Noun
2101 \begin_layout Plain Layout
2107 if the vector format option is set, and otherwise to
2108 \begin_inset Flex Noun
2111 \begin_layout Plain Layout
2120 \begin_layout Section
2124 \begin_layout Standard
2125 Since all conversions from one format to another take place in \SpecialChar LyX
2127 directory, it is sometimes necessary to modify a file before copying it
2128 to the temporary directory in order that the conversion may be performed.
2132 \begin_layout Plain Layout
2133 For example, the file may refer to other files—images, for example—using
2134 relative file names, and these may become invalid when the file is copied
2135 to the temporary directory.
2140 This is done by a Copier: It copies a file to (or from) the temporary directory
2141 and may modify it in the process.
2144 \begin_layout Standard
2145 The definitions of the copiers may use eight variables:
2148 \begin_layout Labeling
2149 \labelwidthstring 00.00.0000
2150 \begin_inset Flex Code
2153 \begin_layout Plain Layout
2159 The \SpecialChar LyX
2160 system directory (e.
2161 \begin_inset space \thinspace{}
2165 \begin_inset space \space{}
2169 \begin_inset Flex Noun
2172 \begin_layout Plain Layout
2181 \begin_layout Labeling
2182 \labelwidthstring 00.00.0000
2183 \begin_inset Flex Code
2186 \begin_layout Plain Layout
2195 \begin_layout Labeling
2196 \labelwidthstring 00.00.0000
2197 \begin_inset Flex Code
2200 \begin_layout Plain Layout
2209 \begin_layout Labeling
2210 \labelwidthstring 00.00.0000
2211 \begin_inset Flex Code
2214 \begin_layout Plain Layout
2220 The base name (without filename extension) in the \SpecialChar LyX
2224 \begin_layout Labeling
2225 \labelwidthstring 00.00.0000
2226 \begin_inset Flex Code
2229 \begin_layout Plain Layout
2235 The full directory path of the \SpecialChar LyX
2239 \begin_layout Labeling
2240 \labelwidthstring 00.00.0000
2241 \begin_inset Flex Code
2244 \begin_layout Plain Layout
2250 The full pathname to the original \SpecialChar LyX
2251 file being processed
2254 \begin_layout Labeling
2255 \labelwidthstring 00.00.0000
2256 \begin_inset Flex Code
2259 \begin_layout Plain Layout
2265 The filename (without any directory path) of the \SpecialChar LyX
2269 \begin_layout Labeling
2270 \labelwidthstring 00.00.0000
2271 \begin_inset Flex Code
2274 \begin_layout Plain Layout
2280 The `\SpecialChar LaTeX
2284 \begin_layout Standard
2285 The latter should be the filename as it would be used in a \SpecialChar LaTeX
2293 It is relevant only when exporting files suitable for such inclusion.
2296 \begin_layout Standard
2297 Copiers can be used to do almost anything with output files.
2298 For example, suppose you want generated pdf files to be copied to a special
2300 \begin_inset Flex Code
2303 \begin_layout Plain Layout
2310 Then you could write a shell script such as this one:
2313 \begin_layout Standard
2314 \begin_inset listings
2318 \begin_layout Plain Layout
2323 \begin_layout Plain Layout
2328 \begin_layout Plain Layout
2330 TOFILE=`basename $2`
2333 \begin_layout Plain Layout
2335 cp $FROMFILE /home/you/pdf/$TOFILE
2340 Save it in your local \SpecialChar LyX
2342 \begin_inset Flex Code
2345 \begin_layout Plain Layout
2346 /home/you/.lyx/scripts/pdfcopier.sh
2351 —and make it executable, if you need to do so on your platform.
2353 \begin_inset Flex Noun
2356 \begin_layout Plain Layout
2357 Tools\SpecialChar menuseparator
2363 dialog, select under
2364 \begin_inset Flex Noun
2367 \begin_layout Plain Layout
2368 File Handling\SpecialChar menuseparator
2375 \begin_inset Flex Noun
2378 \begin_layout Plain Layout
2384 format—or one of the other pdf formats—and enter
2385 \begin_inset Flex Code
2388 \begin_layout Plain Layout
2389 pdfcopier.sh $$i $$o
2395 \begin_inset Flex Noun
2398 \begin_layout Plain Layout
2408 \begin_layout Standard
2409 Copiers are used by \SpecialChar LyX
2410 in various of its own conversions.
2411 For example, if appropriate programs are found, \SpecialChar LyX
2412 will automatically install
2414 \begin_inset Flex Noun
2417 \begin_layout Plain Layout
2424 \begin_inset Flex Noun
2427 \begin_layout Plain Layout
2429 \begin_inset space ~
2438 When these formats are exported, the copier sees that not just the main
2439 HTML file but various associated files (style files, images, etc.) are also
2441 All these files are written to a subdirectory of the directory in which
2442 the original \SpecialChar LyX
2447 \begin_layout Plain Layout
2448 This copier can be customized.
2450 \begin_inset Quotes eld
2454 \begin_inset Quotes erd
2457 argument takes a comma-separated list of extensions to be copied; if it
2458 is omitted, all files will be copied.
2460 \begin_inset Quotes eld
2464 \begin_inset Quotes erd
2467 argument determines the extension added to the generated directory.
2469 \begin_inset Quotes eld
2473 \begin_inset Flex Noun
2476 \begin_layout Plain Layout
2483 \begin_inset Quotes erd
2486 , so HTML generated from
2487 \begin_inset Flex Noun
2490 \begin_layout Plain Layout
2491 /path/to/filename.lyx
2497 \begin_inset Flex Noun
2500 \begin_layout Plain Layout
2501 /path/to/filename.html.LyXconv
2515 \begin_layout Section
2517 \begin_inset CommandInset label
2519 name "sec:Converters"
2526 \begin_layout Standard
2527 You can define your own Converters to convert files between different formats.
2529 \begin_inset Flex Noun
2532 \begin_layout Plain Layout
2533 Tools\SpecialChar menuseparator
2534 Preferences\SpecialChar menuseparator
2535 File Handling\SpecialChar menuseparator
2544 \begin_layout Standard
2545 To define a new converter, select the
2546 \begin_inset Flex Noun
2549 \begin_layout Plain Layout
2551 \begin_inset space ~
2560 \begin_inset Flex Noun
2563 \begin_layout Plain Layout
2565 \begin_inset space ~
2573 from the drop-down lists, enter the command needed for the conversion,
2575 \begin_inset Flex Noun
2578 \begin_layout Plain Layout
2585 Several variables can be used in the definition of converters:
2588 \begin_layout Labeling
2589 \labelwidthstring 00.00.0000
2590 \begin_inset Flex Code
2593 \begin_layout Plain Layout
2599 The \SpecialChar LyX
2603 \begin_layout Labeling
2604 \labelwidthstring 00.00.0000
2605 \begin_inset Flex Code
2608 \begin_layout Plain Layout
2617 \begin_layout Labeling
2618 \labelwidthstring 00.00.0000
2619 \begin_inset Flex Code
2622 \begin_layout Plain Layout
2631 \begin_layout Labeling
2632 \labelwidthstring 00.00.0000
2633 \begin_inset Flex Code
2636 \begin_layout Plain Layout
2642 The base filename of the input file (i.
2643 \begin_inset space \thinspace{}
2646 g., without the extension)
2649 \begin_layout Labeling
2650 \labelwidthstring 00.00.0000
2651 \begin_inset Flex Code
2654 \begin_layout Plain Layout
2660 The path to the input file
2663 \begin_layout Labeling
2664 \labelwidthstring 00.00.0000
2665 \begin_inset Flex Code
2668 \begin_layout Plain Layout
2674 The path to the original input file (this is different from $$p when a
2675 chain of converters is called)
2678 \begin_layout Labeling
2679 \labelwidthstring 00.00.0000
2680 \begin_inset Flex Code
2683 \begin_layout Plain Layout
2689 The iconv name for the encoding of the document.
2692 \begin_layout Standard
2694 \begin_inset Flex Noun
2697 \begin_layout Plain Layout
2699 \begin_inset space ~
2707 field you can enter the following flags, separated by commas:
2710 \begin_layout Labeling
2711 \labelwidthstring 00.00.0000
2712 \begin_inset Flex Code
2715 \begin_layout Plain Layout
2717 \change_inserted -712698321 1524656940
2725 This converter runs some form of \SpecialChar LaTeX
2727 This will make \SpecialChar LyX
2728 's \SpecialChar LaTeX
2729 error logs available.
2731 \change_inserted -712698321 1524657018
2733 \begin_inset Flex Code
2736 \begin_layout Plain Layout
2738 \change_inserted -712698321 1524657012
2746 value specifies the form of \SpecialChar LaTeX
2748 \begin_inset Flex Code
2751 \begin_layout Plain Layout
2753 \change_inserted -712698321 1524657005
2754 latex, pdflatex, platex, xetex, luatex
2762 If no value is specified,
2763 \begin_inset Flex Code
2766 \begin_layout Plain Layout
2768 \change_inserted -712698321 1524657018
2781 \begin_layout Labeling
2782 \labelwidthstring 00.00.0000
2783 \begin_inset Flex Code
2786 \begin_layout Plain Layout
2788 \change_inserted -712698321 1524656935
2796 Needs the \SpecialChar LaTeX
2798 \begin_inset Flex Noun
2801 \begin_layout Plain Layout
2807 file for the conversion.
2809 \change_inserted -712698321 1524657047
2811 \begin_inset Flex Code
2814 \begin_layout Plain Layout
2816 \change_inserted -712698321 1524657030
2824 value specifies the form of \SpecialChar LaTeX
2825 that is run in order to generate the
2826 \begin_inset Flex Noun
2829 \begin_layout Plain Layout
2831 \change_inserted -712698321 1524657047
2840 \begin_inset Flex Code
2843 \begin_layout Plain Layout
2845 \change_inserted -712698321 1524657030
2846 latex, pdflatex, platex, xetex, luatex
2854 If no value is specified,
2855 \begin_inset Flex Code
2858 \begin_layout Plain Layout
2860 \change_inserted -712698321 1524657030
2873 \begin_layout Labeling
2874 \labelwidthstring 00.00.0000
2875 \begin_inset Flex Code
2878 \begin_layout Plain Layout
2885 \begin_inset Quotes eld
2889 \begin_inset Quotes erd
2892 file from the backend, which in practice means a \SpecialChar LaTeX
2893 file like the one we
2894 would export, without
2895 \begin_inset Flex Code
2898 \begin_layout Plain Layout
2907 \begin_layout Labeling
2908 \labelwidthstring 00.00.0000
2909 \begin_inset Flex Code
2912 \begin_layout Plain Layout
2921 \begin_layout Standard
2922 The following three flags are not really flags at all because they take
2924 \begin_inset Flex Noun
2927 \begin_layout Plain Layout
2929 \begin_inset space ~
2933 \begin_inset space ~
2944 \begin_layout Labeling
2945 \labelwidthstring 00.00.0000
2947 \change_inserted -712698321 1523206314
2948 \begin_inset Flex Code
2951 \begin_layout Plain Layout
2953 \change_inserted -712698321 1523206193
2961 The name of the driver that needs to be loaded with the
2965 package for this converter.
2966 The loading of the correct driver is necessary to get some PDF-specific
2975 \begin_layout Labeling
2976 \labelwidthstring 00.00.0000
2977 \begin_inset Flex Code
2980 \begin_layout Plain Layout
2986 If set, the converter's standard error will be redirected to a file
2987 \begin_inset Flex Code
2990 \begin_layout Plain Layout
2996 , and the script given as argument will be run as:
2997 \begin_inset Flex Code
3000 \begin_layout Plain Layout
3001 script < infile.out > infile.log
3007 The argument may contain
3008 \begin_inset Flex Code
3011 \begin_layout Plain Layout
3020 \begin_layout Labeling
3021 \labelwidthstring 00.00.0000
3022 \begin_inset Flex Code
3025 \begin_layout Plain Layout
3031 The name of the directory in which the converter will dump the generated
3034 will not create this directory, and it does not copy anything into it,
3035 though it will copy this directory to the destination.
3036 The argument may contain
3037 \begin_inset Flex Code
3040 \begin_layout Plain Layout
3046 , which will be replaced by the base name of the input and output files,
3047 respectively, when the directory is copied.
3048 \begin_inset Newline newline
3051 Note that resultdir and usetempdir make no sense together.
3052 The latter will be ignored if the former is given.
3055 \begin_layout Labeling
3056 \labelwidthstring 00.00.0000
3057 \begin_inset Flex Code
3060 \begin_layout Plain Layout
3066 Determines the output file name and may, contain
3067 \begin_inset Flex Code
3070 \begin_layout Plain Layout
3077 Sensible only with resultdir and optional even then; if not given, it defaults
3081 \begin_layout Standard
3083 \change_inserted -712698321 1523206384
3084 A suitable hyperref-driver is set for some converters that are installed
3085 with \SpecialChar LyX
3088 \change_deleted -712698321 1523206388
3090 \change_inserted -712698321 1523206389
3094 \change_inserted -712698321 1523206400
3098 \change_inserted -712698321 1523206407
3102 \change_inserted -712698321 1523206437
3106 \change_deleted -712698321 1523206442
3107 that are installed with \SpecialChar LyX
3114 \begin_layout Standard
3115 You do not have to define converters for all formats between which you want
3117 For example, you will note that there is no `\SpecialChar LyX
3118 to PostScript' converter,
3119 but \SpecialChar LyX
3120 will export PostScript.
3121 It does so by first creating a \SpecialChar LaTeX
3122 file (no converter needs to be defined
3123 for this) which is then converted to DVI using the `\SpecialChar LaTeX
3125 and finally converting the resulting DVI file to PostScript.
3127 finds such `chains' of converters automatically, and it will always choose
3128 the shortest possible chain.
3129 You can, though, still define multiple conversion methods between file
3131 For example, the standard \SpecialChar LyX
3132 configuration provides five ways to convert
3137 \begin_layout Enumerate
3139 \begin_inset Flex Noun
3142 \begin_layout Plain Layout
3151 \begin_layout Enumerate
3152 via (DVI and) PostScript, using
3153 \begin_inset Flex Noun
3156 \begin_layout Plain Layout
3165 \begin_layout Enumerate
3167 \begin_inset Flex Noun
3170 \begin_layout Plain Layout
3179 \begin_layout Enumerate
3181 \begin_inset Flex Noun
3184 \begin_layout Plain Layout
3194 \begin_layout Enumerate
3196 \begin_inset Flex Noun
3199 \begin_layout Plain Layout
3209 \begin_layout Standard
3210 To define such alternate chains, you must define multiple target `file formats',
3212 \begin_inset CommandInset ref
3214 reference "sec:Formats"
3219 For example, in the standard configuration, the formats named
3220 \begin_inset Flex Noun
3223 \begin_layout Plain Layout
3230 \begin_inset Flex Noun
3233 \begin_layout Plain Layout
3240 \begin_inset Flex Noun
3243 \begin_layout Plain Layout
3250 \begin_inset Flex Noun
3253 \begin_layout Plain Layout
3260 \begin_inset Flex Noun
3263 \begin_layout Plain Layout
3270 \begin_inset Flex Noun
3273 \begin_layout Plain Layout
3280 \begin_inset Flex Noun
3283 \begin_layout Plain Layout
3290 \begin_inset Flex Noun
3293 \begin_layout Plain Layout
3301 \begin_inset Flex Noun
3304 \begin_layout Plain Layout
3311 \begin_inset Flex Noun
3314 \begin_layout Plain Layout
3321 ) are defined, all of which share the extension
3322 \begin_inset Flex Noun
3325 \begin_layout Plain Layout
3331 , and which correspond to the conversion methods just mentioned.
3334 \begin_layout Chapter
3335 Internationalizing \SpecialChar LyX
3337 \begin_inset CommandInset label
3339 name "cha:Internationalizing-LyX"
3346 \begin_layout Standard
3348 supports using a translated interface.
3349 Last time we checked, \SpecialChar LyX
3350 provided text in thirty languages.
3351 The language of choice is called your
3356 (For further reading on locale settings, see also the documentation for
3357 locale that comes with your operating system.
3358 For Linux, the manual page for
3359 \begin_inset Flex Code
3362 \begin_layout Plain Layout
3368 could be a good place to start).
3371 \begin_layout Standard
3372 Notice that these translations will work, but do contain a few flaws.
3373 In particular, all dialogs have been designed with the English text in
3374 mind, which means that some of the translated text will be too large to
3375 fit within the space allocated.
3376 This is only a display problem and will not cause any harm.
3377 Also, you will find that some of the translations do not define shortcut
3378 keys for everything.
3379 Sometimes, there are simply not enough free letters to do it.
3380 Other times, the translator just hasn't got around to doing it yet.
3381 Our localization team, which you may wish to join,
3385 \begin_layout Plain Layout
3386 If you are a fluent speaker of a language other than English, joining these
3387 teams is a great way to give back to the \SpecialChar LyX
3393 will of course try to fix these shortcomings in future versions of \SpecialChar LyX
3397 \begin_layout Section
3398 Translating \SpecialChar LyX
3402 \begin_layout Subsection
3403 Translating the graphical user interface (text messages).
3406 \begin_layout Standard
3409 \begin_inset Flex Code
3412 \begin_layout Plain Layout
3418 library to handle the internationalization of the interface.
3419 To have \SpecialChar LyX
3420 speak your favorite language in all menus and dialogs, you need
3422 \begin_inset Flex Code
3425 \begin_layout Plain Layout
3431 -file for that language.
3432 When this is available, you'll have to generate a
3433 \begin_inset Flex Code
3436 \begin_layout Plain Layout
3442 -file from it and install the
3443 \begin_inset Flex Code
3446 \begin_layout Plain Layout
3453 The process of doing all of this is explained in the documentation for
3455 \begin_inset Flex Code
3458 \begin_layout Plain Layout
3465 It is possible to do this just for yourself, but if you're going to do
3466 it, you might as well share the results of your labors with the rest of
3467 the \SpecialChar LyX
3469 Send a message to the \SpecialChar LyX
3470 developers' list for more information about how
3474 \begin_layout Standard
3475 In short, this is what you should do (xx denotes the language code):
3478 \begin_layout Itemize
3479 Check out the \SpecialChar LyX
3482 \begin_inset CommandInset href
3484 name "information on the web"
3485 target "https://www.lyx.org/HowToUseGIT"
3493 \begin_layout Itemize
3495 \begin_inset Flex Code
3498 \begin_layout Plain Layout
3504 to the folder of the
3505 \begin_inset Flex Code
3508 \begin_layout Plain Layout
3516 \begin_inset Flex Code
3519 \begin_layout Plain Layout
3527 \begin_inset Flex Code
3530 \begin_layout Plain Layout
3536 doesn't exist anywhere, it can be remade with the console command
3537 \begin_inset Flex Code
3540 \begin_layout Plain Layout
3546 in that directory, or you can use an existing po-file for some other language
3550 \begin_layout Itemize
3552 \begin_inset Flex Code
3555 \begin_layout Plain Layout
3565 \begin_layout Plain Layout
3566 This is just a text file, so it can be edited in any text editor.
3567 But there are also specialized programs that support such editing, such
3572 (for all platforms) or
3581 contains a `mode' for editing
3582 \begin_inset Flex Code
3585 \begin_layout Plain Layout
3592 \begin_inset Flex URL
3595 \begin_layout Plain Layout
3597 https://www.gnu.org/software/gettext/manual/html_node/PO-Mode.html#PO-Mode
3607 For some menu- and widget-labels, there are also shortcut keys that should
3609 Those keys are marked after a `|', and should be translated according to
3610 the words and phrases of the language.
3611 You should also fill also out the information at the beginning of the new
3613 \begin_inset Flex Code
3616 \begin_layout Plain Layout
3622 -file with your email-address, etc., so people know where to reach you with
3623 suggestions and entertaining flames.
3626 \begin_layout Standard
3627 If you are just doing this on your own, then:
3630 \begin_layout Itemize
3632 \begin_inset Flex Code
3635 \begin_layout Plain Layout
3642 This can be done with
3643 \begin_inset Flex Code
3646 \begin_layout Plain Layout
3647 msgfmt -o xx.mo < xx.po
3655 \begin_layout Itemize
3657 \begin_inset Flex Code
3660 \begin_layout Plain Layout
3666 -file to your locale-tree, at the correct directory for application messages
3671 xx, and under the name
3672 \begin_inset Flex Code
3675 \begin_layout Plain Layout
3682 \begin_inset space \thinspace{}
3686 \begin_inset space \space{}
3690 \begin_inset Flex Code
3693 \begin_layout Plain Layout
3694 /usr/local/share/locale/xx/LC_MESSAGES/lyx.mo
3704 \begin_layout Standard
3705 As said, however, it would be best if the new
3706 \begin_inset Flex Code
3709 \begin_layout Plain Layout
3715 file could be added to the \SpecialChar LyX
3716 distribution, so others can use it.
3717 Adding it involves making additional changes to \SpecialChar LyX
3719 So send an email to the developers' mailing list if you're interested in
3723 \begin_layout Subsubsection
3727 \begin_layout Standard
3728 Sometimes it turns out that one English message needs to be translated into
3729 different messages in the target language.
3730 One example is the message
3731 \begin_inset Flex Code
3734 \begin_layout Plain Layout
3740 which has the German translation
3748 , depending upon exactly what the English
3749 \begin_inset Quotes eld
3753 \begin_inset Quotes erd
3758 \begin_inset Flex Code
3761 \begin_layout Plain Layout
3767 does not handle such ambiguous translations.
3768 Therefore you have to add some context information to the message: Instead
3770 \begin_inset Flex Code
3773 \begin_layout Plain Layout
3780 \begin_inset Flex Code
3783 \begin_layout Plain Layout
3784 To[[as in 'From format x to format y']]
3790 \begin_inset Flex Code
3793 \begin_layout Plain Layout
3794 To[[as in 'From page x to page y']].
3799 Now the two occurrences of
3800 \begin_inset Flex Code
3803 \begin_layout Plain Layout
3810 \begin_inset Flex Code
3813 \begin_layout Plain Layout
3819 and can be translated correctly to
3830 \begin_layout Standard
3831 Of course the context information needs to be stripped off the original
3832 message when no translation is used.
3833 Therefore you have to put it in double square brackets at the end of the
3834 message (see the example above).
3835 The translation mechanism of \SpecialChar LyX
3836 ensures that everything in double square
3837 brackets at the end of messages is removed before displaying the message.
3840 \begin_layout Subsection
3841 Translating the documentation.
3844 \begin_layout Standard
3845 The online documentation (in the
3846 \begin_inset Flex Noun
3849 \begin_layout Plain Layout
3855 -menu) can (and should!) be translated.
3856 If there are translated versions of the documentation available
3860 \begin_layout Plain Layout
3861 As of March 2008, at least some of the documents have been translated into
3862 fourteen languages, with the Tutorial available in a few more.
3867 and the locale is set accordingly, these will be used automagically by
3871 looks for translated versions as
3872 \begin_inset Flex Code
3875 \begin_layout Plain Layout
3876 LyXDir/doc/xx/DocName.lyx
3882 \begin_inset Flex Code
3885 \begin_layout Plain Layout
3891 is the code for the language currently in use.
3892 If there are no translated documents, the default English versions will
3894 Note that the translated versions must have the same filenames (
3895 \begin_inset Flex Code
3898 \begin_layout Plain Layout
3904 above) as the original.
3905 If you feel up to translating the documentation (an excellent way to proof-read
3906 the original documentation by the way!), there are a few things you should
3910 \begin_layout Itemize
3911 Check out the documentation translation web page at
3912 \begin_inset CommandInset href
3914 name "https://www.lyx.org/Translation"
3915 target "https://www.lyx.org/Translation"
3921 That way, you can find out which (if any) documents have already been translate
3922 d into your language.
3923 You can also find out who (if anyone) is organizing the effort to translate
3924 the documentation into your language.
3925 If no one is organizing the effort, please let us know that you're interested.
3928 \begin_layout Standard
3929 Once you get to actually translating, here's a few hints for you that may
3933 \begin_layout Itemize
3934 Join the documentation team! There is information on how to do that in
3935 \begin_inset Flex Code
3938 \begin_layout Plain Layout
3945 \begin_inset Flex Noun
3948 \begin_layout Plain Layout
3949 Help\SpecialChar menuseparator
3955 ), which by the way is the first document you should translate.
3958 \begin_layout Itemize
3959 Learn the typographic conventions for the language you are translating to.
3960 Typography is an ancient art and over the centuries, a great variety of
3961 conventions have developed throughout different parts of the world.
3962 Also study the professional terminology amongst typographers in your country.
3963 Inventing your own terminology will only confuse the users.
3966 (Warning! Typography is addictive!)
3969 \begin_layout Itemize
3970 Make a copy of the document.
3971 This will be your working copy.
3972 You can use this as your personal translated help-file by placing it in
3974 \begin_inset Flex Code
3977 \begin_layout Plain Layout
3984 \begin_inset Note Greyedout
3987 \begin_layout Plain Layout
3992 For a complex document with external material (images, etc.), if you make
3994 \begin_inset space \thinspace{}
3998 \begin_inset space \space{}
4001 in a temp dir, beware that the links to external material may be broken
4002 when the document is moved to a different place.
4003 The best way is to retrieve the \SpecialChar LyX
4005 \begin_inset Flex URL
4008 \begin_layout Plain Layout
4010 https://www.lyx.org/HowToUseGIT
4015 ) and to edit the doc file in place.
4023 \begin_layout Itemize
4024 Sometimes the original document (from the \SpecialChar LyX
4025 team) will be updated.
4026 Use the source viewer at
4027 \begin_inset CommandInset href
4029 name "https://www.lyx.org/trac/timeline"
4030 target "https://www.lyx.org/trac/timeline"
4035 to see what has been changed.
4036 That way you can easily see which parts of the translated document need
4040 \begin_layout Standard
4041 If you ever find an error in the original document, fix it and notify the
4042 rest of the documentation team of the changes! (You didn't forget to join
4043 the documentation team, did you?)
4046 \begin_layout Standard
4047 \begin_inset Branch OutDated
4051 \begin_layout Section
4052 International Keyboard Support
4055 \begin_layout Standard
4058 [Editor's Note: The following section is by
4066 It needs to be fixed to conform to the new Documentation Style sheet and
4067 to make use of the new v1.0 features.
4068 The whole thing also needs to be merged with the section following it.-jw
4069 It may also be badly out of date.-rh (2008)]
4072 \begin_layout Subsection
4073 Defining Own Keymaps: Keymap File Format
4076 \begin_layout Standard
4077 Let's look at a keyboard definition file a little closer.
4078 It is a plain text file defining
4081 \begin_layout Itemize
4082 key-to-key or key-to-string translations
4085 \begin_layout Itemize
4089 \begin_layout Itemize
4090 dead keys exceptions
4093 \begin_layout Standard
4094 To define key-to-key or key-to-string translation, use this command:
4097 \begin_layout Quotation
4098 \begin_inset Flex Code
4101 \begin_layout Plain Layout
4110 \begin_inset Flex Code
4113 \begin_layout Plain Layout
4122 \begin_layout Standard
4124 \begin_inset Flex Code
4127 \begin_layout Plain Layout
4133 is the key to be translated and
4134 \begin_inset Flex Code
4137 \begin_layout Plain Layout
4143 is the string to be inserted into the document.
4144 To define dead keys, use:
4147 \begin_layout Quotation
4148 \begin_inset Flex Code
4151 \begin_layout Plain Layout
4160 \begin_inset Flex Code
4163 \begin_layout Plain Layout
4172 \begin_layout Standard
4174 \begin_inset Flex Code
4177 \begin_layout Plain Layout
4183 is a keyboard key and
4184 \begin_inset Flex Code
4187 \begin_layout Plain Layout
4194 The following dead keys are supported (shortcut name is in parentheses):
4197 \begin_layout Quotation
4201 \begin_inset space \hfill{}
4207 \begin_layout Quotation
4209 \begin_inset space \hfill{}
4215 \begin_layout Quotation
4217 \begin_inset space \hfill{}
4223 \begin_layout Quotation
4225 \begin_inset space \hfill{}
4231 \begin_layout Quotation
4233 \begin_inset space \hfill{}
4239 \begin_layout Quotation
4241 \begin_inset space \hfill{}
4248 \begin_layout Plain Layout
4260 \begin_layout Quotation
4262 \begin_inset space \hfill{}
4268 \begin_layout Quotation
4270 \begin_inset space \hfill{}
4277 \begin_layout Plain Layout
4289 \begin_layout Quotation
4291 \begin_inset space \hfill{}
4297 \begin_layout Quotation
4299 \begin_inset space \hfill{}
4305 \begin_layout Quotation
4307 \begin_inset space \hfill{}
4314 \begin_layout Plain Layout
4326 \begin_layout Quotation
4328 \begin_inset space \hfill{}
4335 \begin_layout Plain Layout
4347 \begin_layout Quotation
4349 \begin_inset space \hfill{}
4355 \begin_layout Quotation
4356 hungarian umlaut (hug)
4357 \begin_inset space \hfill{}
4363 \begin_layout Quotation
4365 \begin_inset space \hfill{}
4371 \begin_layout Quotation
4373 \begin_inset space \hfill{}
4380 \begin_layout Plain Layout
4392 \begin_layout Standard
4393 Since in many international keyboards there are exceptions to what some
4394 dead keys should do, you can define them using
4397 \begin_layout Quotation
4398 \begin_inset Flex Code
4401 \begin_layout Plain Layout
4409 deadkey key outstring
4412 \begin_layout Standard
4413 For example, on Slovak keyboard, if you enter caron-o, it generates circumflex-o
4417 \begin_layout Quotation
4418 \begin_inset Flex Code
4421 \begin_layout Plain Layout
4434 \begin_layout Standard
4435 to make it work correctly.
4436 Also, you have to define as exceptions dead keys over i and j, to remove
4437 the dot from them before inserting an accent mark.
4438 I will change this when the time comes, but so far I haven't had time.
4441 \begin_layout Standard
4442 Oh, and about characters: backslash is escaped, so to enter it, you'll need
4445 \begin_inset Flex Code
4448 \begin_layout Plain Layout
4454 have different meaning.
4456 \begin_inset Flex Code
4459 \begin_layout Plain Layout
4465 marks comments, quotes start and end \SpecialChar LaTeX
4467 To enter quote, you'll need to use
4468 \begin_inset Flex Code
4471 \begin_layout Plain Layout
4480 \begin_inset Flex Code
4483 \begin_layout Plain Layout
4490 \begin_inset Flex Code
4493 \begin_layout Plain Layout
4504 \begin_layout Standard
4505 If you make a keyboard description file that works for your language, please
4506 mail it to me, so I can include it in the next keymap distribution.
4509 \begin_layout Standard
4510 More keywords will be supported in keymap configuration file in future,
4514 \begin_layout Itemize
4515 \begin_inset Flex Code
4518 \begin_layout Plain Layout
4529 \begin_inset space \hfill{}
4533 \begin_inset Flex Code
4536 \begin_layout Plain Layout
4545 \begin_layout Itemize
4546 \begin_inset Flex Code
4549 \begin_layout Plain Layout
4560 \begin_inset space \hfill{}
4564 \begin_inset Flex Code
4567 \begin_layout Plain Layout
4573 an external keymap translation program
4576 \begin_layout Standard
4577 Also, it should look into
4578 \begin_inset Flex Code
4581 \begin_layout Plain Layout
4587 file for defaults, too (for example, a
4588 \begin_inset Flex Code
4591 \begin_layout Plain Layout
4599 option to include default keyboard).
4607 \begin_layout Section
4608 International Keymap Stuff
4609 \begin_inset CommandInset label
4611 name "sec:International-Keymap-Stuff"
4618 \begin_layout Standard
4619 \begin_inset Note Note
4622 \begin_layout Plain Layout
4623 In doing the revisions on this document in March 2008, I did not look over
4624 this stuff, as I do not understand it.
4625 It would be good if someone else could do so.
4634 \begin_layout Standard
4635 The next two sections describe the
4636 \begin_inset Flex Code
4639 \begin_layout Plain Layout
4648 \begin_inset Flex Code
4651 \begin_layout Plain Layout
4659 file syntax in detail.
4660 These sections should help you design your own key map if the ones provided
4661 do not meet your needs.
4664 \begin_layout Subsection
4668 \begin_layout Standard
4672 \begin_inset Flex Code
4675 \begin_layout Plain Layout
4681 file maps keystrokes to characters or strings.
4682 As the name suggests, it sets a keyboard mapping.
4684 \begin_inset Flex Code
4687 \begin_layout Plain Layout
4698 \begin_inset Flex Code
4701 \begin_layout Plain Layout
4716 \begin_inset Flex Code
4719 \begin_layout Plain Layout
4732 \begin_inset Flex Code
4735 \begin_layout Plain Layout
4744 \begin_inset Flex Code
4747 \begin_layout Plain Layout
4755 are described in this section.
4758 \begin_layout Labeling
4759 \labelwidthstring 00.00.0000
4760 \begin_inset Flex Code
4763 \begin_layout Plain Layout
4771 Map a character to a string
4774 \begin_layout LyX-Code
4789 \begin_layout Standard
4822 the double-quote (")
4839 must be escaped with a preceding backslash (
4850 \begin_layout Standard
4852 \begin_inset Flex Noun
4855 \begin_layout Plain Layout
4863 statement to cause the symbol
4864 \begin_inset Flex Noun
4867 \begin_layout Plain Layout
4875 to be output for the keystroke
4876 \begin_inset Flex Noun
4879 \begin_layout Plain Layout
4890 \begin_layout LyX-Code
4896 \begin_layout Labeling
4897 \labelwidthstring 00.00.0000
4898 \begin_inset Flex Code
4901 \begin_layout Plain Layout
4909 Specify an accent character
4912 \begin_layout LyX-Code
4921 \begin_layout Standard
4922 This will make the cha
4960 This is the dead key
4964 \begin_layout Plain Layout
4971 refers to a key that does not produce a character by itself, but when followed
4972 with another key, produces the desired accent character.
4973 For example, a German characte
4975 r with an umlaut like
4985 can be produced in this manner.
4994 \begin_layout Standard
5007 and then another key not in
5024 followed by the other, not allowed key, as output.
5028 \begin_inset Flex Noun
5031 \begin_layout Plain Layout
5039 cancels a dead key, so if
5050 \begin_inset Flex Noun
5053 \begin_layout Plain Layout
5062 , the cursor will not go one position backwards but will instead cancel
5078 might have had on the next keystroke.
5082 \begin_layout Standard
5083 The following example specifies that the character ' is to be an acute accent,
5084 allowed on the characters a, e, i, o, u, A, E, I, O, and U:
5087 \begin_layout LyX-Code
5090 kmod ' acute aeiouAEIOU
5093 \begin_layout Labeling
5094 \labelwidthstring 00.00.0000
5095 \begin_inset Flex Code
5098 \begin_layout Plain Layout
5104 Specify an exception to the accent character
5107 \begin_layout LyX-Code
5116 \begin_layout Standard
5117 This defines an exce
5158 have been assigned a keystroke with a previous
5161 \begin_inset Flex Code
5164 \begin_layout Plain Layout
5188 must not belong in the
5235 If such a declaration does not exist in
5243 \begin_inset Flex Code
5246 \begin_layout Plain Layout
5280 \begin_inset Flex Code
5283 \begin_layout Plain Layout
5297 \begin_layout Standard
5298 The following command produces causes äi to be produced when you enter acute-i
5302 \begin_layout LyX-Code
5316 \begin_layout Labeling
5317 \labelwidthstring 00.00.0000
5318 \begin_inset Flex Code
5321 \begin_layout Plain Layout
5327 Combine two accent characters
5330 \begin_layout LyX-Code
5336 accent1 accent2 allowed
5339 \begin_layout Standard
5340 This one is getting pretty esoteric.
5341 It allows you to combine the effect
5397 \begin_inset Flex Code
5400 \begin_layout Plain Layout
5428 \begin_layout Standard
5429 Consider this example from the
5430 \begin_inset Flex Code
5433 \begin_layout Plain Layout
5444 \begin_layout LyX-Code
5447 kmod ; acute aeioyvhAEIOYVH
5451 kcomb acute umlaut iyIY
5454 \begin_layout Standard
5455 This allows you to press
5456 \begin_inset Flex Noun
5459 \begin_layout Plain Layout
5467 and get the effect of
5468 \begin_inset Flex Code
5471 \begin_layout Plain Layout
5490 in this case cancels the last dead key, so if you press
5491 \begin_inset Flex Noun
5494 \begin_layout Plain Layout
5503 \begin_inset Flex Code
5506 \begin_layout Plain Layout
5519 \begin_layout Subsection
5523 \begin_layout Standard
5525 \begin_inset Flex Code
5528 \begin_layout Plain Layout
5536 mapping is performed, a
5537 \begin_inset Flex Code
5540 \begin_layout Plain Layout
5550 file maps the strings that the symbols generate to characters in the current
5552 The \SpecialChar LyX
5553 distribution currently includes at least the
5554 \begin_inset Flex Code
5557 \begin_layout Plain Layout
5566 \begin_inset Flex Code
5569 \begin_layout Plain Layout
5580 \begin_layout Standard
5582 \begin_inset Flex Code
5585 \begin_layout Plain Layout
5593 file is a sequence of declarations of the form
5596 \begin_layout LyX-Code
5609 \begin_layout Standard
5610 For example, in order to map
5611 \begin_inset Flex Noun
5614 \begin_layout Plain Layout
5624 to the corresponding character in the iso-8859-1 set (233), the following
5628 \begin_layout LyX-Code
5636 \begin_layout Standard
5638 \begin_inset Flex Code
5641 \begin_layout Plain Layout
5650 \begin_inset Flex Code
5653 \begin_layout Plain Layout
5671 the same character can apply to more than one string.
5673 \begin_inset Flex Code
5676 \begin_layout Plain Layout
5687 \begin_layout LyX-Code
5699 \begin_inset Newline newline
5715 \begin_layout Standard
5717 cannot find a mapping for the string produced by the keystroke or a
5718 deadkey sequence, it will check if it looks like an accented char and try
5719 to draw an accent over the character on screen.
5722 \begin_layout Subsection
5726 \begin_layout Standard
5727 There is a second way to add support for international characters through
5728 so-called dead-keys.
5729 A dead-key works in combination with a letter to produce an accented character.
5730 Here, we'll explain how to create a really simple dead-key to illustrate
5734 \begin_layout Standard
5735 Suppose you happen to need the circumflex character,
5736 \begin_inset Quotes eld
5740 \begin_inset Quotes erd
5745 \begin_inset Flex Noun
5748 \begin_layout Plain Layout
5755 \begin_inset space ~
5759 \begin_inset Flex Noun
5762 \begin_layout Plain Layout
5768 ] to the \SpecialChar LyX
5770 \begin_inset Flex Code
5773 \begin_layout Plain Layout
5780 \begin_inset Flex Code
5783 \begin_layout Plain Layout
5790 Now, whenever you type the
5791 \begin_inset Flex Noun
5794 \begin_layout Plain Layout
5800 -key followed by a letter, that letter will have a circumflex accent on
5802 For example, the sequence
5803 \begin_inset Quotes eld
5807 \begin_inset Flex Noun
5810 \begin_layout Plain Layout
5817 \begin_inset Quotes erd
5820 produces the letter:
5821 \begin_inset Quotes eld
5825 \begin_inset Quotes erd
5829 If you tried to type
5830 \begin_inset Quotes eld
5834 \begin_inset Flex Noun
5837 \begin_layout Plain Layout
5844 \begin_inset Quotes erd
5847 , however, \SpecialChar LyX
5848 will complain with a beep, since a
5849 \begin_inset Quotes eld
5853 \begin_inset Flex Noun
5856 \begin_layout Plain Layout
5863 \begin_inset Quotes erd
5866 never takes a circumflex accent.
5868 \begin_inset Flex Noun
5871 \begin_layout Plain Layout
5877 after a dead-key produces the bare-accent.
5878 Please note this last point! If you bind a key to a dead-key, you'll need
5879 to rebind the character on that key to yet another key.
5881 \begin_inset Flex Noun
5884 \begin_layout Plain Layout
5890 to a cedilla is a bad idea, since you'll only get cedillas instead of commas.
5893 \begin_layout Standard
5894 One common way to bind dead-keys is to use
5895 \begin_inset Flex Noun
5898 \begin_layout Plain Layout
5905 \begin_inset Flex Noun
5908 \begin_layout Plain Layout
5915 \begin_inset Flex Noun
5918 \begin_layout Plain Layout
5924 in combination with an accent, like
5925 \begin_inset Quotes eld
5929 \begin_inset Flex Noun
5932 \begin_layout Plain Layout
5939 \begin_inset Quotes erd
5943 \begin_inset Quotes eld
5947 \begin_inset Flex Noun
5950 \begin_layout Plain Layout
5957 \begin_inset Quotes erd
5961 \begin_inset Quotes eld
5965 \begin_inset Flex Noun
5968 \begin_layout Plain Layout
5975 \begin_inset Quotes erd
5979 Another way involves using
5980 \begin_inset Flex Code
5983 \begin_layout Plain Layout
5990 \begin_inset Flex Code
5993 \begin_layout Plain Layout
5999 to set up the special
6000 \begin_inset Flex Code
6003 \begin_layout Plain Layout
6011 \begin_inset Flex Code
6014 \begin_layout Plain Layout
6020 acts in some ways just like
6021 \begin_inset Flex Noun
6024 \begin_layout Plain Layout
6030 and permits you to bind keys to accented characters.
6031 You can also turn keys into dead-keys by binding them to something like
6033 \begin_inset Flex Code
6036 \begin_layout Plain Layout
6042 and then binding this symbolic key to the corresponding \SpecialChar LyX
6047 \begin_layout Plain Layout
6052 : This is exactly what I do in my
6053 \begin_inset Flex Code
6056 \begin_layout Plain Layout
6063 \begin_inset Flex Code
6066 \begin_layout Plain Layout
6074 \begin_inset Flex Noun
6077 \begin_layout Plain Layout
6079 \begin_inset space ~
6088 \begin_inset Flex Code
6091 \begin_layout Plain Layout
6097 and a bunch of these
6098 \begin_inset Quotes eld
6102 \begin_inset Flex Code
6105 \begin_layout Plain Layout
6112 \begin_inset Quotes erd
6115 symbolic keys bound such things as
6116 \begin_inset Flex Noun
6119 \begin_layout Plain Layout
6121 \begin_inset space ~
6130 \begin_inset Flex Noun
6133 \begin_layout Plain Layout
6135 \begin_inset space ~
6144 This is how I produce my accented characters.
6149 You can make just about anything into the
6150 \begin_inset Flex Code
6153 \begin_layout Plain Layout
6160 \begin_inset Flex Noun
6163 \begin_layout Plain Layout
6169 keys, a spare function key, etc.
6170 As for the \SpecialChar LyX
6171 commands that produce accents, check the entry for
6172 \begin_inset Flex Code
6175 \begin_layout Plain Layout
6186 You'll find the complete list there.
6189 \begin_layout Subsection
6190 Saving your Language Configuration
6193 \begin_layout Standard
6194 You can edit your preferences so that your desired language environment
6195 is automatically configured when \SpecialChar LyX
6197 \begin_inset Flex Noun
6200 \begin_layout Plain Layout
6201 Edit\SpecialChar menuseparator
6210 \begin_layout Chapter
6212 \change_inserted -584632292 1610232084
6215 Installing New Document Classes, Layouts, and Templates
6216 \begin_inset CommandInset label
6218 name "cha:Installing-New-Document"
6223 \begin_inset Argument 1
6226 \begin_layout Plain Layout
6227 Installing New Document Classes
6235 \begin_layout Standard
6236 In this chapter, we describe the procedures for creating and installing
6237 new \SpecialChar LyX
6238 layout and template files, as well as offer a refresher on correctly
6239 installing new \SpecialChar LaTeX
6244 \begin_layout Standard
6245 First, let us a say a few words about how one ought to think about the relation
6246 between \SpecialChar LyX
6247 and \SpecialChar LaTeX
6249 The thing to understand is that, in a certain sense, \SpecialChar LyX
6250 doesn't know anything
6251 about \SpecialChar LaTeX
6253 Indeed, from \SpecialChar LyX
6254 's point of view, \SpecialChar LaTeX
6255 is just one of several
6256 \begin_inset Quotes eld
6260 \begin_inset Quotes erd
6263 in which it is capable of producing output.
6264 Other such formats are DocBook, plaintext, and XHTML.
6266 is, of course, a particularly important format, but very little of the
6267 information \SpecialChar LyX
6268 has about \SpecialChar LaTeX
6269 is actually contained in the program itself.
6273 \begin_layout Plain Layout
6274 Some commands are sufficiently complex that they are
6275 \begin_inset Quotes eld
6279 \begin_inset Quotes erd
6282 into \SpecialChar LyX
6284 But the developers generally regard this as a Bad Thing.
6289 Rather, that information, even for the standard classes like
6290 \begin_inset Flex Code
6293 \begin_layout Plain Layout
6299 , is contained in `layout files'.
6300 Similarly, \SpecialChar LyX
6301 itself does not know much about DocBook or XHTML.
6302 What it knows is contained in layout files.
6305 \begin_layout Standard
6306 You can think of the layout file for a given document class as a translation
6307 manual between \SpecialChar LyX
6308 constructs—paragraphs with their corresponding styles,
6309 certain sorts of insets, etc—and the corresponding \SpecialChar LaTeX
6312 Almost everything \SpecialChar LyX
6314 \begin_inset Flex Code
6317 \begin_layout Plain Layout
6323 , for example, is contained in the file
6324 \begin_inset Flex Code
6327 \begin_layout Plain Layout
6333 and in various other files it includes.
6334 For this reason, anyone intending to write layout files should plan to
6335 study the existing files.
6336 A good place to start is with
6337 \begin_inset Flex Code
6340 \begin_layout Plain Layout
6346 , which is included in
6347 \begin_inset Flex Code
6350 \begin_layout Plain Layout
6357 \begin_inset Flex Code
6360 \begin_layout Plain Layout
6366 , and many of the other layout files for document classes.
6367 This file is where sections and the like are defined:
6368 \begin_inset Flex Code
6371 \begin_layout Plain Layout
6377 tells \SpecialChar LyX
6378 how paragraphs that are marked with the Section, Subsection, etc,
6379 styles can be translated into corresponding \SpecialChar LaTeX
6380 , DocBook, and XHTML commands
6383 \begin_inset Flex Code
6386 \begin_layout Plain Layout
6392 file basically just includes several of these
6393 \begin_inset Flex Code
6396 \begin_layout Plain Layout
6405 \begin_layout Standard
6406 Defining the \SpecialChar LyX
6408 correspondence is not the only thing layout files do, though.
6409 Their other job is to define how the \SpecialChar LyX
6410 constructs themselves will appear
6412 The fact that layout files have these two jobs is often a source of confusion,
6413 because they are completely separate.
6414 Telling \SpecialChar LyX
6415 how to translate a certain paragraph style into \SpecialChar LaTeX
6418 how to display it; conversely, telling \SpecialChar LyX
6419 how to display a certain paragraph
6420 style does not tell \SpecialChar LyX
6421 how to translate it into \SpecialChar LaTeX
6422 (let alone tell \SpecialChar LaTeX
6425 So, in general, when you define a new \SpecialChar LyX
6426 construct, you must always do two
6427 quite separate things: (i)
6428 \begin_inset space ~
6431 tell \SpecialChar LyX
6432 how to translate it into \SpecialChar LaTeX
6434 \begin_inset space ~
6437 tell \SpecialChar LyX
6441 \begin_layout Standard
6442 Much the same is true, of course, as regards \SpecialChar LyX
6443 's other backend formats, though
6444 XHTML is in some ways different, because in that case \SpecialChar LyX
6449 able, to some extent, to use information about how it should display a
6450 paragraph on the screen to output information (in the form of CSS) about
6451 how the paragraph should be displayed in a browser.
6452 Even in this case, however, the distinction between what \SpecialChar LyX
6454 and how things are rendered externally remains in force, and the two can
6455 be controlled separately.
6457 \begin_inset CommandInset ref
6459 reference "sec:Tags-for-XHTML"
6466 \begin_layout Section
6467 Installing new \SpecialChar LaTeX
6471 \begin_layout Standard
6472 Some installations may not include a \SpecialChar LaTeX
6473 package or class file that you would
6474 like to use within \SpecialChar LyX
6476 For example, you might need Foil\SpecialChar TeX
6477 , a package for preparing slides for overhead
6479 Modern \SpecialChar LaTeX
6480 distributions like \SpecialChar TeX
6481 Live (2008 or newer) or MiK\SpecialChar TeX
6482 provide a user interface
6483 for installing such packages.
6484 For example, with MiK\SpecialChar TeX
6485 , you start the program
6486 \begin_inset Quotes eld
6490 \begin_inset space ~
6494 \begin_inset Quotes erd
6497 to get a list of available packages.
6498 To install one of them, right click on it or use the corresponding toolbar
6502 \begin_layout Standard
6503 If your \SpecialChar LaTeX
6504 distribution does not provide such a `package manager', or if the
6505 package is not available from your distribution, then follow these steps
6506 to install it manually:
6509 \begin_layout Enumerate
6510 Get the package from
6511 \begin_inset CommandInset href
6514 target "http://www.ctan.org/"
6522 \begin_layout Enumerate
6523 If the package contains a file with the ending
6524 \begin_inset Quotes eld
6528 \begin_inset Flex Code
6531 \begin_layout Plain Layout
6538 \begin_inset Quotes erd
6541 (is the case for Foil\SpecialChar TeX
6542 ) then open a console, change to the folder of this
6543 file and execute the command
6544 \begin_inset Flex Code
6547 \begin_layout Plain Layout
6554 You have now unpacked the package and have all files to install it.
6555 Most \SpecialChar LaTeX
6556 -packages are not packed and you can skip this step.
6559 \begin_layout Enumerate
6560 Now you need to decide if the package should be available for all users
6565 \begin_layout Enumerate
6566 On *nix systems (Linux, OSX, etc.), if you want the new package to be available
6567 for all users on your system, then install it in your `local' \SpecialChar TeX
6569 install it in your own `user' \SpecialChar TeX
6571 Where these trees should be created, if they do not already exist, depends
6573 To find this out, look in the file
6574 \begin_inset Flex Code
6577 \begin_layout Plain Layout
6587 \begin_layout Plain Layout
6588 This is usually in the directory
6589 \begin_inset Flex Code
6592 \begin_layout Plain Layout
6598 , though you can execute the command
6599 \begin_inset Flex Code
6602 \begin_layout Plain Layout
6613 The location of the `local' \SpecialChar TeX
6614 tree is defined by the
6615 \begin_inset Flex Code
6618 \begin_layout Plain Layout
6624 variable; this is usually somewhere like
6625 \begin_inset Flex Code
6628 \begin_layout Plain Layout
6629 /usr/local/share/texmf
6634 or /usr/local/texlive/XXXX where XXXX is the year of the installed \SpecialChar TeX
6637 The location of the `user' \SpecialChar TeX
6639 \begin_inset Flex Code
6642 \begin_layout Plain Layout
6649 \begin_inset Flex Code
6652 \begin_layout Plain Layout
6659 \begin_inset Flex Code
6662 \begin_layout Plain Layout
6671 (If these variables are not predefined, you have to define them.) You'll
6672 probably need root permissions to create or modify the `local' tree, but
6673 not for your `user' tree.
6674 \begin_inset Newline newline
6677 In general, it is recommended to install in the user tree because your user
6678 will not be modified or even overwritten when you upgrade your system.
6679 It will typically also be backed up together with everything else when
6680 you backup your home directory (which, of course, you do on a regular basis).
6683 \begin_layout Enumerate
6684 On Windows, if you want the new package to be available for all users on
6685 your system, change to the folder where \SpecialChar LaTeX
6686 is installed and then change to
6688 \begin_inset Flex Code
6691 \begin_layout Plain Layout
6702 (For MiK\SpecialChar TeX
6703 , this would be by default the folder
6704 \begin_inset Flex Code
6707 \begin_layout Plain Layout
6725 \begin_layout Plain Layout
6726 Note that this will be the correct path only on English installations.
6727 On a German one, it would be
6728 \begin_inset Flex Code
6731 \begin_layout Plain Layout
6745 , and similarly for other languages.
6750 Create there a new folder
6751 \begin_inset Flex Code
6754 \begin_layout Plain Layout
6760 and copy all files of the package into it.
6762 \begin_inset Newline newline
6765 If the package should only available for you or you don't have admin permissions
6766 , do the same, but in the local \SpecialChar LaTeX
6769 \begin_inset space \thinspace{}
6772 g., for MiK\SpecialChar TeX
6774 \begin_inset space ~
6777 2.8 under Windows XP, this would be the folder:
6778 \begin_inset Newline newline
6784 \begin_inset Flex Code
6787 \begin_layout Plain Layout
6790 Documents and Settings
6802 \begin_inset Newline newline
6808 \begin_inset Phantom HPhantom
6811 \begin_layout Plain Layout
6822 \begin_inset Flex Code
6825 \begin_layout Plain Layout
6838 \begin_inset Newline newline
6841 On Vista, it would be:
6842 \begin_inset Newline newline
6846 \begin_inset Flex Code
6849 \begin_layout Plain Layout
6875 \begin_layout Enumerate
6876 Now one only need to tell \SpecialChar LaTeX
6877 that there are new files.
6878 This depends on the used \SpecialChar LaTeX
6883 \begin_layout Enumerate
6884 For \SpecialChar TeX
6885 Live execute the command
6886 \begin_inset Flex Code
6889 \begin_layout Plain Layout
6896 If you installed the package for all users, then you will probably need
6897 to have root permissions for that.
6900 \begin_layout Enumerate
6901 For MiK\SpecialChar TeX
6902 , if you have installed the package for all users, start the program
6904 \begin_inset Quotes eld
6908 \begin_inset space ~
6912 \begin_inset Quotes erd
6915 and press the button marked
6916 \begin_inset Quotes eld
6920 \begin_inset Quotes erd
6924 Otherwise start the program
6925 \begin_inset Quotes eld
6929 \begin_inset Quotes erd
6936 \begin_layout Enumerate
6937 Finally, you need to tell \SpecialChar LyX
6938 that there are new packages available.
6939 So, in \SpecialChar LyX
6941 \begin_inset Flex Noun
6944 \begin_layout Plain Layout
6947 \SpecialChar menuseparator
6953 and then restart \SpecialChar LyX
6957 \begin_layout Standard
6958 Now the package is installed.
6959 In our example, the document class
6960 \begin_inset Flex Code
6963 \begin_layout Plain Layout
6969 will now be available under
6970 \begin_inset Flex Noun
6973 \begin_layout Plain Layout
6974 Document\SpecialChar menuseparator
6975 Settings\SpecialChar menuseparator
6982 \begin_inset Quotes eld
6986 \begin_inset Quotes erd
6993 \begin_layout Standard
6994 If you would like to use a \SpecialChar LaTeX
6995 document class that is not even listed in the
6997 \begin_inset Flex Noun
7000 \begin_layout Plain Layout
7001 Document\SpecialChar menuseparator
7002 Settings\SpecialChar menuseparator
7008 , then you need to create a `layout' file for it.
7009 That is the topic of the next section.
7012 \begin_layout Section
7013 Types of layout files
7016 \begin_layout Standard
7017 This section describes the various sorts of \SpecialChar LyX
7018 files that contain layout informati
7020 These files describe various paragraph and character styles, determining
7021 how \SpecialChar LyX
7022 should display them and how they should be translated into \SpecialChar LaTeX
7024 XHTML, or whatever output format is being used.
7028 \begin_layout Standard
7029 We shall try to provide a thorough description of the process of writing
7031 However, there are so many different types of documents supported even
7032 by just \SpecialChar LaTeX
7033 that we can't hope to cover every different possibility or problem
7034 you might encounter.
7035 The \SpecialChar LyX
7036 users' list is frequented by people with lots of experience with layout
7037 design who are willing to share what they've learned, so please feel free
7038 to ask questions there.
7041 \begin_layout Standard
7042 As you prepare to write a new layout, it is extremely helpful to look at
7043 the layouts distributed with \SpecialChar LyX
7045 If you write a \SpecialChar LyX
7046 layout for a \SpecialChar LaTeX
7047 document class that might also be used by
7048 others, or write a module that might be useful to others, then you should
7049 consider posting your layout to the
7050 \begin_inset CommandInset href
7052 name "layout section on the LyX wiki"
7053 target "https://wiki.lyx.org/Layouts/Layouts"
7058 or even to the \SpecialChar LyX
7059 developers' list, so that it might be included in \SpecialChar LyX
7064 \begin_layout Plain Layout
7065 Note that \SpecialChar LyX
7066 is licensed under the General Public License, so any material
7067 that is contributed to \SpecialChar LyX
7068 must be similarly licensed.
7076 \begin_layout Subsection
7078 \begin_inset CommandInset label
7080 name "subsec:Layout-modules"
7087 \begin_layout Standard
7088 We have spoken to this point about `layout files'.
7089 But there are different sorts of files that contain layout information.
7090 Layout files, strictly so called, have the
7091 \begin_inset Flex Code
7094 \begin_layout Plain Layout
7100 extension and provide \SpecialChar LyX
7101 with information about document classes.
7102 Since \SpecialChar LyX
7103 1.6 layout information can also be contained in layout
7108 \begin_inset Flex Code
7111 \begin_layout Plain Layout
7118 Modules are to \SpecialChar LaTeX
7119 packages much as layouts are to \SpecialChar LaTeX
7120 classes, and some modules—such
7122 \begin_inset Flex Code
7125 \begin_layout Plain Layout
7131 module—specifically provide support for one package.
7132 In a sense, layout modules are similar to included
7136 \begin_layout Plain Layout
7137 These can have any extension, but by convention have the
7138 \begin_inset Flex Code
7141 \begin_layout Plain Layout
7153 \begin_inset Flex Code
7156 \begin_layout Plain Layout
7162 —in that modules are not specific to a given document class but may be used
7163 with many different classes.
7164 The difference is that using an included file with
7165 \begin_inset Flex Code
7168 \begin_layout Plain Layout
7174 requires editing that file.
7175 Modules, by contrast, are selected in the
7176 \begin_inset Flex Noun
7179 \begin_layout Plain Layout
7180 Document\SpecialChar menuseparator
7189 \begin_layout Standard
7190 Building modules is the easiest way to get started with layout editing,
7191 since it can be as simple as adding a single new paragraph style or flex
7193 But modules may, in principle, contain anything a layout file can contain.
7196 \begin_layout Standard
7197 After creating a new module and copying it to the
7198 \begin_inset Flex Code
7201 \begin_layout Plain Layout
7207 folder, you will need to reconfigure and then restart \SpecialChar LyX
7210 However, changes you make to the module will be seen immediately, if you
7212 \begin_inset Flex Noun
7215 \begin_layout Plain Layout
7216 Document\SpecialChar menuseparator
7222 , highlight something, and then hit
7223 \begin_inset Quotes eld
7227 \begin_inset Quotes erd
7233 It is strongly recommended that you save your work before doing this
7238 it is strongly recommended that you not attempt to edit modules while simultaneo
7239 usly working on actual documents
7242 Though of course the developers strive to keep \SpecialChar LyX
7243 stable in such situations,
7244 syntax errors and the like in your module file could cause strange behavior.
7247 \begin_layout Subsubsection
7251 \begin_layout Standard
7252 Modules are to \SpecialChar LyX
7253 as packages are to \SpecialChar LaTeX
7255 Sometimes, however, you find yourself wanting a specific inset or character
7256 style just for one document and writing a module that will also be available
7257 to other documents makes little sense.
7258 What you need is \SpecialChar LyX
7260 \begin_inset Quotes eld
7264 \begin_inset Quotes erd
7270 \begin_layout Standard
7271 You will find it under
7273 Document\SpecialChar menuseparator
7274 Settings\SpecialChar menuseparator
7278 The large text box allows you to enter anything that you might enter in
7279 a layout file or module.
7280 You can think of a document's local layout, in fact, as a module that belongs
7282 So, in particular, you must enter a
7283 \begin_inset Flex Code
7286 \begin_layout Plain Layout
7293 Any format is acceptable, but one would normally use the format current
7295 (In \SpecialChar LyX
7302 , the current layout format is
7311 \begin_layout Standard
7312 When you have entered something in the
7313 \begin_inset Flex Code
7316 \begin_layout Plain Layout
7322 pane, \SpecialChar LyX
7324 \begin_inset Quotes eld
7328 \begin_inset Quotes erd
7331 button at the bottom.
7332 Clicking this button will cause \SpecialChar LyX
7333 to determine whether what you have entered
7334 is valid layout information for the chosen format.
7336 will report the result but, unfortunately, will not tell you what errors
7337 there might have been.
7338 These will be written to the terminal, however, if \SpecialChar LyX
7339 is started from a terminal.
7340 You will not be permitted to save your local layout until you have entered
7344 \begin_layout Standard
7345 The warnings at the end of the previous section apply here, too.
7346 Do not play with local layout while you are actually working, especially
7347 if you have not saved your document.
7348 That said, using local layout with a test document can be a very convenient
7349 way to try out layout ideas, or even to start developing a module.
7352 \begin_layout Subsection
7354 \begin_inset Flex Noun
7357 \begin_layout Plain Layout
7366 \begin_layout Standard
7367 There are two situations you are likely to encounter when wanting to support
7368 a new \SpecialChar LaTeX
7369 document class, involving style (
7370 \begin_inset Flex Code
7373 \begin_layout Plain Layout
7379 ) files and \SpecialChar LaTeX2e
7381 \begin_inset Flex Code
7384 \begin_layout Plain Layout
7391 Supporting a style file is usually fairly easy.
7392 Supporting a new class file is a bit harder.
7393 We'll discuss the former in this section and the latter in the next.
7395 \change_deleted 5863208 1594239023
7396 Similar remarks apply, of course, if you want to support a new DocBook DTD.
7401 \begin_layout Standard
7402 The easier case is the one in which your new document class is provided
7403 as a style file that is to be used in conjunction with an already supported
7405 For the sake of the example, we'll assume that the style file is called
7407 \begin_inset Flex Noun
7410 \begin_layout Plain Layout
7416 and that it is meant to be used with
7417 \begin_inset Flex Noun
7420 \begin_layout Plain Layout
7426 , which is a standard class.
7430 \begin_layout Standard
7431 Start by copying the existing class's layout file into your local directory:
7435 \begin_layout Plain Layout
7436 Of course, which directory is your local directory will vary by platform,
7437 and \SpecialChar LyX
7438 allows you to specify your local directory on startup, too, using
7440 \begin_inset Flex Code
7443 \begin_layout Plain Layout
7457 \begin_layout LyX-Code
7458 cp report.layout ~/.lyx/layouts/myclass.layout
7461 \begin_layout Standard
7463 \begin_inset Flex Code
7466 \begin_layout Plain Layout
7472 and change the line:
7475 \begin_layout LyX-Code
7478 DeclareLaTeXClass{Report (Standard Class)}
7481 \begin_layout Standard
7485 \begin_layout LyX-Code
7488 DeclareLaTeXClass[report, myclass.sty]{Report (My Class)}
7491 \begin_layout Standard
7495 \begin_layout LyX-Code
7497 \begin_inset Newline newline
7503 \begin_inset Newline newline
7509 \begin_layout Standard
7510 near the top of the file.
7513 \begin_layout Standard
7514 Start \SpecialChar LyX
7516 \begin_inset Flex Noun
7519 \begin_layout Plain Layout
7520 Tools\SpecialChar menuseparator
7527 Then restart \SpecialChar LyX
7528 and try creating a new document.
7530 \begin_inset Flex Noun
7533 \begin_layout Plain Layout
7539 " as a document class option in the
7540 \begin_inset Flex Noun
7543 \begin_layout Plain Layout
7544 Document\SpecialChar menuseparator
7551 It is likely that some of the sectioning commands and such in your new
7552 class will work differently from how they worked in the base class—
7553 \begin_inset Flex Code
7556 \begin_layout Plain Layout
7562 in this example—so you can fiddle around with the settings for the different
7563 sections if you wish.
7564 The layout information for sections is contained in
7565 \begin_inset Flex Code
7568 \begin_layout Plain Layout
7574 , but you do not need to copy and change this file.
7575 Instead, you can simply add your changes to your layout file, after the
7577 \begin_inset Flex Code
7580 \begin_layout Plain Layout
7586 , which itself includes
7587 \begin_inset Flex Code
7590 \begin_layout Plain Layout
7597 For example, you might add these lines:
7600 \begin_layout LyX-Code
7604 \begin_layout LyX-Code
7608 \begin_layout LyX-Code
7612 \begin_layout LyX-Code
7616 \begin_layout LyX-Code
7620 \begin_layout Standard
7621 to change the font for chapter headings to sans-serif.
7622 This will override (or, in this case, add to) the existing declaration
7623 for the Chapter style.
7627 \begin_layout Standard
7628 Your new package may also provide commands or environments not present in
7630 In this case, you will want to add these to the layout file.
7632 \begin_inset CommandInset ref
7634 reference "sec:TextClass"
7638 for information on how to do so.
7641 \begin_layout Standard
7643 \begin_inset Flex Noun
7646 \begin_layout Plain Layout
7652 can be used with several different document classes, and even if it cannot,
7653 you might find it easiest just to write a module that you can load with
7655 The simplest possible such module would be:
7658 \begin_layout LyX-Code
7661 DeclareLyXModule{My Class}
7664 \begin_layout LyX-Code
7668 \begin_layout LyX-Code
7669 #Support for myclass.sty.
7672 \begin_layout LyX-Code
7674 \begin_inset Newline newline
7680 \begin_layout LyX-Code
7688 \begin_inset Newline newline
7694 \begin_layout LyX-Code
7696 \begin_inset Newline newline
7702 \begin_inset Newline newline
7708 \begin_layout Standard
7709 A more complex module might modify the behavior of some existing constructs
7710 or define some new ones.
7712 \begin_inset CommandInset ref
7714 reference "sec:TextClass"
7721 \begin_layout Subsection
7723 \begin_inset Flex Noun
7726 \begin_layout Plain Layout
7735 \begin_layout Standard
7736 There are two possibilities here.
7737 One is that the class file is itself based upon an existing document class.
7738 For example, many thesis classes are based upon
7739 \begin_inset Flex Noun
7742 \begin_layout Plain Layout
7749 To see whether yours is, look for a line like
7752 \begin_layout LyX-Code
7758 \begin_layout Standard
7760 If so, then you may proceed largely as in the previous section, though
7762 \begin_inset Flex Code
7765 \begin_layout Plain Layout
7766 Declare\SpecialChar LaTeX
7772 line will be different.
7773 If your new class is
7774 \begin_inset Flex Code
7777 \begin_layout Plain Layout
7783 and it is based upon
7784 \begin_inset Flex Code
7787 \begin_layout Plain Layout
7793 , then the line should read:
7797 \begin_layout Plain Layout
7798 And it will be easiest if you save the file to
7799 \begin_inset Flex Code
7802 \begin_layout Plain Layout
7809 assumes that the document class has the same name as the layout file.
7818 \begin_layout LyX-Code
7821 DeclareLaTeXClass[thesis,book]{thesis}
7824 \begin_layout Standard
7825 If, on the other hand, the new class is not based upon an existing class,
7826 you will probably have to
7827 \begin_inset Quotes eld
7831 \begin_inset Quotes erd
7835 We strongly suggest copying an existing layout file which uses a similar
7837 class and then modifying it, if you can do so.
7838 At least use an existing file as a starting point so you can find out what
7839 items you need to worry about.
7840 Again, the specifics are covered below.
7843 \begin_layout Subsection
7845 \begin_inset CommandInset label
7847 name "subsec:Creating-Templates"
7854 \begin_layout Standard
7855 Once you have written a layout file for a new document class, you might
7856 want to consider writing a
7861 A template acts as a kind of tutorial for your layout, showing how it might
7862 be used, though containing dummy content.
7863 You can of course look at the various templates included with \SpecialChar LyX
7867 \begin_layout Standard
7868 Templates are created just like usual documents: using \SpecialChar LyX
7870 The only difference is that usual documents contain all possible settings,
7871 including the font scheme and the paper size.
7872 Usually a user doesn't want a template to overwrite his preferred settings
7873 for such parameters.
7874 For that reason, the designer of a template should remove the corresponding
7876 \begin_inset Flex Code
7879 \begin_layout Plain Layout
7888 \begin_inset Flex Code
7891 \begin_layout Plain Layout
7899 from the template \SpecialChar LyX
7901 This can be done with any simple text-editor, for example
7902 \begin_inset Flex Code
7905 \begin_layout Plain Layout
7912 \begin_inset Flex Code
7915 \begin_layout Plain Layout
7924 \begin_layout Standard
7925 Put the edited template files you create in
7926 \begin_inset Flex Code
7929 \begin_layout Plain Layout
7935 , copy the ones you use from the global template directory in
7936 \begin_inset Flex Code
7939 \begin_layout Plain Layout
7945 to the same place, and redefine the template path in the
7946 \begin_inset Flex Noun
7949 \begin_layout Plain Layout
7950 Tools\SpecialChar menuseparator
7951 Preferences\SpecialChar menuseparator
7960 \begin_layout Standard
7961 Note, by the way, that there is a template which has a particular meaning:
7962 \begin_inset Newline linebreak
7966 \begin_inset Flex Code
7969 \begin_layout Plain Layout
7976 This template is loaded every time you create a new document with
7977 \begin_inset Flex Noun
7980 \begin_layout Plain Layout
7981 File\SpecialChar menuseparator
7987 in order to provide useful defaults.
7988 To create this template from inside \SpecialChar LyX
7989 , all you have to do is to open a document
7990 with the correct settings, and use the
7991 \begin_inset Flex Noun
7994 \begin_layout Plain Layout
7995 Save as Document Defaults
8003 \begin_layout Subsection
8004 Upgrading old layout files
8007 \begin_layout Standard
8008 The format of layout files changes with each \SpecialChar LyX
8009 release, so old layout files
8010 need to be converted to the new format.
8012 reads a layout file in an older format, it automatically calls the
8014 \begin_inset Flex Code
8017 \begin_layout Plain Layout
8023 to convert it to a temporary file in current format.
8024 The original file is left untouched.
8025 If you use the layout file often, then, you may want to convert it permanently,
8026 so that \SpecialChar LyX
8027 does not have to do so itself every time.
8028 To do this, you can call the converter manually:
8031 \begin_layout Enumerate
8033 \begin_inset Flex Code
8036 \begin_layout Plain Layout
8043 \begin_inset Flex Code
8046 \begin_layout Plain Layout
8055 \begin_layout Enumerate
8057 \begin_inset Newline newline
8061 \begin_inset Flex Code
8064 \begin_layout Plain Layout
8065 python LyXDir/scripts/layout2layout.py myclass.old myclass.layout
8071 \begin_inset Newline newline
8075 \begin_inset Flex Code
8078 \begin_layout Plain Layout
8084 is the name of your \SpecialChar LyX
8088 \begin_layout Standard
8089 Note that manual conversion does not affect included files, so these will
8090 have to be converted separately.
8093 \begin_layout Subsection
8094 \begin_inset CommandInset label
8096 name "subsec:Cite-Engine-Files"
8103 \begin_layout Standard
8104 A specific form of layout files are the so-called
8105 \begin_inset Flex Code
8108 \begin_layout Plain Layout
8114 files that are located in the
8115 \begin_inset Flex Code
8118 \begin_layout Plain Layout
8125 Their purpose is to define the specifics of \SpecialChar LaTeX
8126 packages aimed at bibliography
8139 , but also the way how normal Bib\SpecialChar TeX
8140 citations (without additional packages)
8141 are handled in \SpecialChar LyX
8142 is defined in such a file.
8146 \begin_layout Standard
8147 More specifically, it is defined which packages \SpecialChar LyX
8148 needs to load, which citation
8149 commands are available, how these are to be displayed in \SpecialChar LyX
8151 the dialogs, the context menus) as well as in the XHTML and plain text
8153 Furthermore, the files specify available style variants (author-year, numerical
8154 , etc.) and their specifics.
8155 The cite engine files are also used to generate the options that are available
8158 Document\SpecialChar menuseparator
8159 Settings\SpecialChar menuseparator
8160 Bibliography\SpecialChar menuseparator
8166 \begin_layout Standard
8167 Even though a cite engine file is essentially a normal layout file that
8168 could theoretically include any layout information, it usually primarily
8169 includes some specific parameters such as
8170 \begin_inset Flex Code
8173 \begin_layout Plain Layout
8180 \begin_inset Flex Code
8183 \begin_layout Plain Layout
8190 \begin_inset Flex Code
8193 \begin_layout Plain Layout
8200 \begin_inset Flex Code
8203 \begin_layout Plain Layout
8210 The syntax of the latter two is described in
8211 \begin_inset CommandInset ref
8213 reference "subsec:Citation-engine-description"
8221 \begin_inset CommandInset ref
8223 reference "subsec:Citation-format-description"
8227 , as well as in the files themselves.
8230 \begin_layout Section
8231 \begin_inset CommandInset label
8233 name "sec:TextClass"
8237 The layout file format
8240 \begin_layout Standard
8241 The following sections describe how layout files are structured and written.
8242 Our advice is to go slowly, save and test often.
8243 It is really not that hard, except that the multitude of options can become
8244 overwhelming, especially if you try to check out too many at once.
8245 It becomes easier if you use existing layouts of \SpecialChar LyX
8246 as examples/reference
8247 or if you modify an existing layout to your needs.
8250 \begin_layout Standard
8251 Note that all the tags used in layout files are case-insensitive.
8253 \begin_inset Flex Code
8256 \begin_layout Plain Layout
8263 \begin_inset Flex Code
8266 \begin_layout Plain Layout
8273 \begin_inset Flex Code
8276 \begin_layout Plain Layout
8282 are really the same tag.
8283 The possible arguments are printed in brackets after the tag's name.
8284 The default argument is typeset
8285 \begin_inset Flex Code
8288 \begin_layout Plain Layout
8297 If the argument has a data type like
8298 \begin_inset Quotes eld
8302 \begin_inset Quotes erd
8306 \begin_inset Quotes eld
8310 \begin_inset Quotes erd
8313 , the default is shown like this:
8314 \begin_inset Flex Code
8317 \begin_layout Plain Layout
8328 \begin_layout Subsection
8329 The document class declaration and classification
8332 \begin_layout Standard
8333 Lines in a layout file which begin with
8334 \begin_inset Flex Code
8337 \begin_layout Plain Layout
8344 There is one exception to this rule.
8346 \begin_inset Flex Code
8349 \begin_layout Plain Layout
8355 files should begin with lines like:
8358 \begin_layout LyX-Code
8361 #% Do not delete the line below; configure depends on this
8364 \begin_layout LyX-Code
8369 DeclareLaTeXClass{Article (Standard Class)}
8372 \begin_layout LyX-Code
8377 DeclareCategory{Articles}
8380 \begin_layout Standard
8381 The second and third lines are used when you (re)configure \SpecialChar LyX
8383 The layout file is read by the \SpecialChar LaTeX
8385 \begin_inset Flex Code
8388 \begin_layout Plain Layout
8394 , in a special mode where
8395 \begin_inset Flex Code
8398 \begin_layout Plain Layout
8405 The first line is just a \SpecialChar LaTeX
8406 comment, the second one contains the mandatory
8407 declaration of the text class and the third line contains the optional
8408 classification of the class.
8409 If these lines appear in a file named
8410 \begin_inset Flex Code
8413 \begin_layout Plain Layout
8419 , then they define a text class of name
8420 \begin_inset Flex Code
8423 \begin_layout Plain Layout
8429 (the name of the layout file) which uses the \SpecialChar LaTeX
8431 \begin_inset Flex Code
8434 \begin_layout Plain Layout
8440 (the default is to use the same name as the layout).
8442 \begin_inset Quotes eld
8445 Article (Standard Class)
8446 \begin_inset Quotes erd
8449 that appears above is used as a description of the text class in the
8450 \begin_inset Flex Noun
8453 \begin_layout Plain Layout
8454 Document\SpecialChar menuseparator
8462 \begin_inset Quotes eld
8466 \begin_inset Quotes erd
8469 in the example) is also used in the
8470 \begin_inset Flex Noun
8473 \begin_layout Plain Layout
8474 Document\SpecialChar menuseparator
8480 dialog: the text classes are grouped by these categories (which are usually
8481 genres, so typical categories are
8482 \begin_inset Quotes eld
8486 \begin_inset Quotes erd
8490 \begin_inset Quotes eld
8494 \begin_inset Quotes erd
8498 \begin_inset Quotes eld
8502 \begin_inset Quotes erd
8506 \begin_inset Quotes eld
8510 \begin_inset Quotes erd
8514 \begin_inset Quotes eld
8518 \begin_inset Quotes erd
8522 \begin_inset Quotes eld
8526 \begin_inset Quotes erd
8530 If no category has been declared, the class will be put in the
8531 \begin_inset Quotes eld
8535 \begin_inset Quotes erd
8541 \begin_layout Standard
8542 Let's assume that you wrote your own text class that uses the
8543 \begin_inset Flex Code
8546 \begin_layout Plain Layout
8552 document class, but where you changed the appearance of the section headings.
8553 If you put it in a file
8554 \begin_inset Flex Code
8557 \begin_layout Plain Layout
8563 , the header of this file should be:
8566 \begin_layout LyX-Code
8569 #% Do not delete the line below; configure depends on this
8572 \begin_layout LyX-Code
8577 DeclareLaTeXClass[article]{Article (with My Own Headings)}
8580 \begin_layout LyX-Code
8585 DeclareCategory{Articles}
8588 \begin_layout Standard
8589 This declares a text class
8590 \begin_inset Flex Code
8593 \begin_layout Plain Layout
8599 , associated with the \SpecialChar LaTeX
8601 \begin_inset Flex Code
8604 \begin_layout Plain Layout
8611 \begin_inset Quotes eld
8614 Article (with My Own Headings)
8615 \begin_inset Quotes erd
8619 If your text class depends on several packages, you can declare it as:
8622 \begin_layout LyX-Code
8625 #% Do not delete the line below; configure depends on this
8628 \begin_layout LyX-Code
8633 DeclareLaTeXClass[article,foo.sty]{Article (with My Own Headings)}
8636 \begin_layout LyX-Code
8641 DeclareCategory{Articles}
8644 \begin_layout Standard
8645 This indicates that your text class uses the
8646 \begin_inset Flex Code
8649 \begin_layout Plain Layout
8657 \change_deleted 5863208 1594239179
8658 Finally, it is also possible to declare classes for DocBook code.
8659 Typical declarations will look like:
8662 \begin_layout LyX-Code
8664 \change_deleted 5863208 1594239179
8667 #% Do not delete the line below; configure depends on this
8670 \begin_layout LyX-Code
8672 \change_deleted 5863208 1594239179
8677 DeclareDocBookClass[article]{SGML (DocBook Article)}
8680 \begin_layout LyX-Code
8682 \change_deleted 5863208 1594239179
8687 DeclareCategory{Articles (DocBook)}
8692 \begin_layout Standard
8693 Note that these declarations can also be given an optional parameter declaring
8694 the name of the document class (but not a list).
8697 \begin_layout Standard
8698 So, to be as explicit as possible, the form of the layout declaration is:
8701 \begin_layout LyX-Code
8706 DeclareLaTeXClass[class,package.sty]{layout description}
8709 \begin_layout LyX-Code
8714 DeclareCategory{category}
8717 \begin_layout Standard
8718 The class need only be specified if the name of the \SpecialChar LaTeX
8720 name of the layout file are different or if there are packages to load.
8721 If the name of the class file is not specified, then \SpecialChar LyX
8723 that it is the same as the name of the layout file.
8726 \begin_layout Standard
8727 When the text class has been modified to your taste, all you have to do
8728 is to copy it either to
8729 \begin_inset Flex Code
8732 \begin_layout Plain Layout
8739 \begin_inset Flex Code
8742 \begin_layout Plain Layout
8749 \begin_inset Flex Noun
8752 \begin_layout Plain Layout
8753 Tools\SpecialChar menuseparator
8759 , exit \SpecialChar LyX
8761 Then your new text class should be available along with the others.
8764 \begin_layout Standard
8765 Once the layout file is installed, you can edit it and see your changes
8766 without having to reconfigure or to restart \SpecialChar LyX
8771 \begin_layout Plain Layout
8772 In versions of \SpecialChar LyX
8773 prior to 1.6, this was not true.
8774 As a result, editing layout files was very time consuming, since you had
8775 constantly to restart \SpecialChar LyX
8781 You can force a reload of the current layout by using the \SpecialChar LyX
8783 \begin_inset Flex Noun
8786 \begin_layout Plain Layout
8793 There is no default binding for this function—though, of course, you can
8794 bind it to a key yourself.
8795 But you will normally use this function simply by entering it in the mini-buffe
8800 \begin_layout Standard
8806 \begin_inset Flex Noun
8809 \begin_layout Plain Layout
8815 is very much an `advanced feature'.
8820 recommended that you save your work before using this function.
8825 recommended that you not attempt to edit layout information while simultaneousl
8826 y working on a document that you care about.
8827 Use a test document.
8828 Syntax errors and the like in your layout file could cause peculiar behavior.
8829 In particular, such errors could cause \SpecialChar LyX
8830 to regard the current layout as
8831 invalid and to attempt to switch to some other layout.
8835 \begin_layout Plain Layout
8836 Really bad syntax errors may even caused \SpecialChar LyX
8838 This is because certain sorts of errors may make \SpecialChar LyX
8849 The \SpecialChar LyX
8850 team strives to keep \SpecialChar LyX
8851 stable in such situations, but safe is better
8856 \begin_layout Plain Layout
8857 While we're giving advice: make regular backups.
8858 And be nice to your mother.
8866 \begin_layout Subsection
8867 The Module declaration
8870 \begin_layout Standard
8871 A module must begin with a line like the following:
8874 \begin_layout LyX-Code
8877 DeclareLyXModule[endnotes.sty]{Endnotes}
8878 \change_inserted -712698321 1554395911
8882 \begin_layout LyX-Code
8884 \change_inserted -712698321 1554395924
8889 DeclareCategory{Foot- and Endnotes}
8890 \change_deleted -712698321 1554395911
8898 \begin_layout Standard
8899 The mandatory argument
8900 \change_inserted -712698321 1554395956
8909 , in curly brackets, is the name of the module, as it should appear in
8910 \begin_inset Flex Noun
8913 \begin_layout Plain Layout
8914 Document\SpecialChar menuseparator
8915 Settings\SpecialChar menuseparator
8922 The argument in square brackets is optional: It declares any \SpecialChar LaTeX
8924 on which the module depends.
8925 It is also possible to use the form
8926 \begin_inset Flex Noun
8929 \begin_layout Plain Layout
8935 as an optional argument, which declares that the module can only be used
8936 when there exists a conversion chain between the formats `
8937 \begin_inset Flex Code
8940 \begin_layout Plain Layout
8947 \begin_inset Flex Code
8950 \begin_layout Plain Layout
8958 \change_inserted -712698321 1554396133
8965 declaration is not strictly mandatory, but you should add it, since it
8966 is helpful to find the module.
8967 Please have a look at the existing module categories and if appropriate,
8973 \begin_layout Standard
8975 \change_inserted -712698321 1554395988
8978 declaration should then be followed by lines like the following:
8982 \begin_layout Plain Layout
8983 Preferably in English if the module should be published with \SpecialChar LyX
8985 This description will appear in the list of messages to be translated and
8986 will be thus translated with the next interface update.
8994 \begin_layout LyX-Code
8998 \begin_layout LyX-Code
8999 #Adds an endnote command, in addition to footnotes.
9003 \begin_layout LyX-Code
9004 #You will need to add
9006 theendnotes in TeX code where you
9009 \begin_layout LyX-Code
9010 #want the endnotes to appear.
9014 \begin_layout LyX-Code
9018 \begin_layout LyX-Code
9019 #Requires: somemodule | othermodule
9022 \begin_layout LyX-Code
9023 #Excludes: badmodule
9026 \begin_layout Standard
9027 The description is used in
9028 \begin_inset Flex Noun
9031 \begin_layout Plain Layout
9032 Document\SpecialChar menuseparator
9033 Settings\SpecialChar menuseparator
9039 to provide the user with information about what the module does.
9041 \begin_inset Flex Code
9044 \begin_layout Plain Layout
9050 line is used to identify other modules with which this one must be used;
9052 \begin_inset Flex Code
9055 \begin_layout Plain Layout
9061 line is used to identify modules with which this one may not be used.
9062 Both are optional, and, as shown, multiple modules should be separated
9063 with the pipe symbol: |.
9064 Note that the required modules are treated disjunctively:
9068 of the required modules must be used.
9073 excluded module may be used.
9074 Note that modules are identified here by their filenames without the
9075 \begin_inset Flex Code
9078 \begin_layout Plain Layout
9086 \begin_inset Flex Code
9089 \begin_layout Plain Layout
9096 \begin_inset Flex Code
9099 \begin_layout Plain Layout
9108 \begin_layout Subsection
9109 The CiteEngine file declaration
9112 \begin_layout Standard
9113 A cite engine file must begin with a line like the following:
9116 \begin_layout LyX-Code
9119 DeclareLyXCiteEngineModule[biblatex.sty]{Biblatex}
9122 \begin_layout Standard
9123 The mandatory argument, in curly brackets, is the name of the cite style,
9124 as it should appear in
9125 \begin_inset Flex Noun
9128 \begin_layout Plain Layout
9129 Document\SpecialChar menuseparator
9130 Settings\SpecialChar menuseparator
9137 The argument in square brackets is optional: It declares any \SpecialChar LaTeX
9139 on which the cite engine depends.
9142 \begin_layout Standard
9143 The cite engine declaration should then be followed by lines like the following:
9147 \begin_layout Plain Layout
9148 Preferably in English if the module should be published with \SpecialChar LyX
9150 This description will appear in the list of messages to be translated and
9151 will be thus translated with the next interface update.
9159 \begin_layout LyX-Code
9163 \begin_layout LyX-Code
9164 # Biblatex supports many author-year and numerical styles.
9167 \begin_layout LyX-Code
9168 # It is mainly aimed at the Humanities.
9172 \begin_layout LyX-Code
9173 # customizable, fully localized and provides many features
9176 \begin_layout LyX-Code
9177 # that are not possible with BibTeX.
9178 The use of 'biber' as
9181 \begin_layout LyX-Code
9182 # bibliography processor is advised.
9185 \begin_layout LyX-Code
9189 \begin_layout Standard
9190 The description is used in
9191 \begin_inset Flex Noun
9194 \begin_layout Plain Layout
9195 Document\SpecialChar menuseparator
9196 Settings\SpecialChar menuseparator
9202 to provide the user with information about the cite engine.
9205 \begin_layout Subsection
9209 \begin_layout Standard
9210 The first non-comment line of any layout file, included file, or module
9215 contain the file format number:
9218 \begin_layout Description
9219 \begin_inset Flex Code
9222 \begin_layout Plain Layout
9229 \begin_inset Flex Code
9232 \begin_layout Plain Layout
9238 ] The format number of the layout file.
9241 \begin_layout Standard
9242 This tag was introduced with \SpecialChar LyX
9244 \begin_inset space ~
9248 Layout files from older \SpecialChar LyX
9249 versions do not have an explicit file format and
9250 are considered to have
9251 \begin_inset Flex Code
9254 \begin_layout Plain Layout
9256 \begin_inset space ~
9265 The format for the present version of \SpecialChar LyX
9267 But each version of \SpecialChar LyX
9268 is capable of reading earlier versions' layout files,
9269 just as they are capable of reading files produced by earlier versions
9272 There is, however, no provision for converting to earlier formats.
9275 \begin_layout Subsection
9276 \begin_inset CommandInset label
9278 name "subsec:General-text-class"
9282 General text class parameters
9285 \begin_layout Standard
9286 These are general parameters that govern the behavior of an entire document
9292 mean that they must appear in
9293 \begin_inset Flex Code
9296 \begin_layout Plain Layout
9302 files rather than in modules.
9303 A module can contain any layout tag.)
9306 \begin_layout Description
9308 \change_inserted -712698321 1526899478
9309 \begin_inset Flex Code
9312 \begin_layout Plain Layout
9314 \change_inserted -712698321 1526898610
9315 AddToCiteEngine <engine>
9322 Extends the possibilities for displaying citation references.
9324 \begin_inset CommandInset ref
9326 reference "subsec:Citation-engine-description"
9335 \begin_inset Flex Code
9338 \begin_layout Plain Layout
9340 \change_inserted -712698321 1526898823
9351 \begin_layout Description
9352 \begin_inset Flex Code
9355 \begin_layout Plain Layout
9361 Adds information that will be output in the
9362 \begin_inset Flex Code
9365 \begin_layout Plain Layout
9371 block when the document is output to XHTML.
9372 Typically, this would be used to output CSS style information, but it can
9373 be used for anything that can appear in
9374 \begin_inset Flex Code
9377 \begin_layout Plain Layout
9385 \begin_inset Quotes eld
9389 \begin_inset Flex Code
9392 \begin_layout Plain Layout
9399 \begin_inset Quotes erd
9405 \begin_layout Description
9406 \begin_inset Flex Code
9409 \begin_layout Plain Layout
9415 Adds information to the document preamble.
9417 \begin_inset Newline newline
9421 \begin_inset Quotes eld
9425 \begin_inset Flex Code
9428 \begin_layout Plain Layout
9435 \begin_inset Quotes erd
9439 \change_inserted -712698321 1562592950
9443 \begin_layout Description
9445 \change_inserted -712698321 1562593040
9446 \begin_inset Flex Code
9449 \begin_layout Plain Layout
9451 \change_inserted -712698321 1562592954
9460 \begin_inset Flex Code
9463 \begin_layout Plain Layout
9465 \change_inserted -712698321 1562592950
9476 \begin_inset space \thinspace{}
9480 \begin_inset Flex Code
9483 \begin_layout Plain Layout
9485 \change_inserted -712698321 1562592950
9493 ] If the document class adds the bibliography to the table of contents,
9494 add this option with value
9495 \begin_inset Flex Code
9498 \begin_layout Plain Layout
9500 \change_inserted -712698321 1562592996
9509 \begin_inset Flex Code
9512 \begin_layout Plain Layout
9514 \change_inserted -712698321 1562593006
9523 This prevents the bibliography from being added twice.
9528 \begin_layout Description
9529 \begin_inset Flex Code
9532 \begin_layout Plain Layout
9538 Defines the possibilities for displaying citation references.
9540 \begin_inset CommandInset ref
9542 reference "subsec:Citation-engine-description"
9551 \begin_inset Quotes eld
9555 \begin_inset Flex Code
9558 \begin_layout Plain Layout
9565 \begin_inset Quotes erd
9569 Primarily used in cite engine files (see
9570 \begin_inset CommandInset ref
9572 reference "subsec:Cite-Engine-Files"
9581 \change_inserted -712698321 1526898530
9582 Note that if you specify this in a layout file or module, any cite engine
9583 definition will be overridden.
9585 \begin_inset Flex Code
9588 \begin_layout Plain Layout
9590 \change_inserted -712698321 1526898530
9603 \begin_layout Description
9604 \begin_inset Flex Code
9607 \begin_layout Plain Layout
9613 Defines formats for use in the display of bibliographic information.
9615 \begin_inset CommandInset ref
9617 reference "subsec:Citation-format-description"
9623 \begin_inset Quotes eld
9627 \begin_inset Flex Code
9630 \begin_layout Plain Layout
9637 \begin_inset Quotes erd
9641 Primarily used in cite engine files (see
9642 \begin_inset CommandInset ref
9644 reference "subsec:Cite-Engine-Files"
9653 \change_inserted -712698321 1526898585
9654 A cite format defined in a layout or module will override the cite engine
9660 \begin_layout Description
9661 \begin_inset Flex Code
9664 \begin_layout Plain Layout
9671 \begin_inset Flex Code
9674 \begin_layout Plain Layout
9683 \begin_inset Flex Code
9686 \begin_layout Plain Layout
9692 ] Determines whether
9696 or Bib\SpecialChar TeX
9697 is used to generate a Bibliography.
9698 Primarily used in cite engine files (see
9699 \begin_inset CommandInset ref
9701 reference "subsec:Cite-Engine-Files"
9711 \begin_layout Description
9712 \begin_inset Flex Code
9715 \begin_layout Plain Layout
9721 Describes various global options supported by the document class.
9723 \begin_inset CommandInset ref
9725 reference "subsec:ClassOptions"
9731 \begin_inset Quotes eld
9735 \begin_inset Flex Code
9738 \begin_layout Plain Layout
9745 \begin_inset Quotes erd
9751 \begin_layout Description
9752 \begin_inset Flex Code
9755 \begin_layout Plain Layout
9762 \begin_inset Flex Code
9765 \begin_layout Plain Layout
9774 \begin_inset space \thinspace{}
9778 \begin_inset Flex Code
9781 \begin_layout Plain Layout
9787 ] Whether the class should
9791 to having one or two columns.
9792 Can be changed in the
9793 \begin_inset Flex Noun
9796 \begin_layout Plain Layout
9797 Document\SpecialChar menuseparator
9806 \begin_layout Description
9807 \begin_inset Flex Code
9810 \begin_layout Plain Layout
9817 \begin_inset Flex Code
9820 \begin_layout Plain Layout
9826 ] This sequence defines the properties for a counter.
9827 If the counter does not yet exist, it is created; if it does exist, it
9830 \begin_inset Quotes eld
9834 \begin_inset Flex Code
9837 \begin_layout Plain Layout
9844 \begin_inset Quotes erd
9848 \begin_inset Newline newline
9852 \begin_inset CommandInset ref
9854 reference "subsec:Counters"
9858 for details on counters.
9861 \begin_layout Description
9862 \begin_inset Flex Code
9865 \begin_layout Plain Layout
9871 Sets the default font used to display the document.
9873 \begin_inset CommandInset ref
9875 reference "subsec:Font-description"
9879 for how to declare fonts.
9881 \begin_inset Quotes eld
9885 \begin_inset Flex Code
9888 \begin_layout Plain Layout
9895 \begin_inset Quotes erd
9901 \begin_layout Description
9902 \begin_inset Flex Code
9905 \begin_layout Plain Layout
9912 \begin_inset Flex Code
9915 \begin_layout Plain Layout
9921 ] Specifies a module to be included by default with this document class.
9922 The module is specified as filename without the
9923 \begin_inset Flex Code
9926 \begin_layout Plain Layout
9933 The user can still remove the module, but it will be active at the outset.
9934 (This applies only when new files are created, or when this class is chosen
9935 for an existing document.)
9938 \begin_layout Description
9939 \begin_inset Flex Code
9942 \begin_layout Plain Layout
9949 \begin_inset Flex Code
9952 \begin_layout Plain Layout
9958 ] This is the style that will be assigned to new paragraphs, usually
9959 \begin_inset Flex Noun
9962 \begin_layout Plain Layout
9969 This will default to the first defined style if not given, but you are
9970 encouraged to use this directive.
9973 \begin_layout Description
9975 \change_inserted -970929547 1515112870
9976 \begin_inset Flex Code
9979 \begin_layout Plain Layout
9981 \change_inserted -970929547 1515112782
9990 \begin_inset Flex Code
9993 \begin_layout Plain Layout
9995 \change_inserted -970929547 1515112766
10003 ] The root element (at the top of the document) to use when outputting documents
10004 with this class in DocBook.
10005 The default value is
10006 \begin_inset Quotes eld
10010 \begin_inset Flex Code
10013 \begin_layout Plain Layout
10015 \change_inserted -970929547 1515112845
10024 \begin_inset Quotes erd
10029 \change_deleted 1075283030 1594226862
10031 \change_inserted 1075283030 1594226777
10035 \begin_layout Description
10037 \change_inserted 1075283030 1594226859
10038 \begin_inset Flex Code
10041 \begin_layout Plain Layout
10043 \change_inserted 1075283030 1594226785
10044 DocBookForceAbstract
10052 \begin_inset Flex Code
10055 \begin_layout Plain Layout
10057 \change_inserted 1075283030 1594226804
10066 \begin_inset Quotes eld
10074 \begin_inset Quotes erd
10077 , the root element will always have an
10082 The default value is
10083 \begin_inset Quotes eld
10091 \begin_inset Quotes erd
10099 \begin_layout Description
10100 \begin_inset Flex Code
10103 \begin_layout Plain Layout
10110 \begin_inset Flex Code
10113 \begin_layout Plain Layout
10119 ] This tag indicates that the module (which is specified by filename without
10121 \begin_inset Flex Code
10124 \begin_layout Plain Layout
10130 extension) cannot be used with this document class.
10131 This might be used in a journal-specific layout file to prevent, say, the
10133 \begin_inset Flex Code
10136 \begin_layout Plain Layout
10142 module that numbers theorems by section.
10147 be used in a module.
10148 Modules have their own way of excluding other modules (see
10149 \begin_inset CommandInset ref
10151 reference "subsec:Layout-modules"
10158 \begin_layout Description
10159 \begin_inset Flex Code
10162 \begin_layout Plain Layout
10168 Defines a new float.
10170 \begin_inset CommandInset ref
10172 reference "subsec:Floats"
10178 \begin_inset Quotes eld
10182 \begin_inset Flex Code
10185 \begin_layout Plain Layout
10192 \begin_inset Quotes erd
10198 \begin_layout Description
10199 \begin_inset Flex Code
10202 \begin_layout Plain Layout
10208 Sets the information that will be output in the
10209 \begin_inset Flex Code
10212 \begin_layout Plain Layout
10218 block when this document class is output to XHTML.
10219 Note that this will completely override any prior
10220 \begin_inset Flex Code
10223 \begin_layout Plain Layout
10230 \begin_inset Flex Code
10233 \begin_layout Plain Layout
10241 \begin_inset Newline newline
10245 \begin_inset Flex Code
10248 \begin_layout Plain Layout
10254 if you just want to add material to the preamble.) Must end with
10255 \begin_inset Quotes eld
10259 \begin_inset Flex Code
10262 \begin_layout Plain Layout
10269 \begin_inset Quotes erd
10275 \begin_layout Description
10276 \begin_inset Flex Code
10279 \begin_layout Plain Layout
10286 \begin_inset Flex Code
10289 \begin_layout Plain Layout
10295 ] The style to use for the table of contents, bibliography, and so forth,
10296 when the document is output to HTML.
10297 For articles, this should normally be
10298 \begin_inset Flex Code
10301 \begin_layout Plain Layout
10308 \begin_inset Flex Code
10311 \begin_layout Plain Layout
10318 If it is not given, then \SpecialChar LyX
10319 will attempt to figure out which layout to use.
10322 \begin_layout Description
10323 \begin_inset Flex Code
10326 \begin_layout Plain Layout
10333 \begin_inset Flex Code
10336 \begin_layout Plain Layout
10342 ] Modifies the properties of the given counter.
10343 If the counter does not exist, the statement is ignored.
10345 \begin_inset Quotes eld
10349 \begin_inset Flex Code
10352 \begin_layout Plain Layout
10359 \begin_inset Quotes erd
10363 \begin_inset Newline newline
10367 \begin_inset CommandInset ref
10369 reference "subsec:Counters"
10373 for details on counters.
10376 \begin_layout Description
10377 \begin_inset Flex Code
10380 \begin_layout Plain Layout
10387 \begin_inset Flex Code
10390 \begin_layout Plain Layout
10396 ] This allows you to include another layout definition file within yours
10397 to avoid duplicating commands.
10398 Common examples are the standard layout files, for example,
10399 \begin_inset Flex Code
10402 \begin_layout Plain Layout
10408 , which contains most of the basic layouts.
10409 \change_inserted -712698321 1611646803
10413 \begin_layout Description
10415 \change_inserted -712698321 1611646804
10416 \begin_inset Flex Code
10419 \begin_layout Plain Layout
10421 \change_inserted -712698321 1611646837
10430 \begin_inset Flex Code
10433 \begin_layout Plain Layout
10435 \change_inserted -712698321 1611646804
10443 ] is a variant of the
10444 \begin_inset Flex Code
10447 \begin_layout Plain Layout
10449 \change_inserted -712698321 1611646804
10457 command which does not look for files in the user directory.
10458 This allows to create a file
10459 \begin_inset Flex Code
10462 \begin_layout Plain Layout
10464 \change_inserted -712698321 1611646804
10473 \begin_inset Flex Code
10476 \begin_layout Plain Layout
10478 \change_inserted -712698321 1611646804
10486 in the user directory which includes a global file with the same name via
10488 \begin_inset Flex Code
10491 \begin_layout Plain Layout
10493 \change_inserted -712698321 1611646853
10502 \begin_inset Flex Code
10505 \begin_layout Plain Layout
10507 \change_inserted -712698321 1611646855
10508 InputGlobal name.inc
10515 , respectively (with
10516 \begin_inset Flex Code
10519 \begin_layout Plain Layout
10521 \change_inserted -712698321 1611646804
10529 , the file would recursively include itself).
10530 This way, you can modify global files without having to completely copy
10536 \begin_layout Description
10537 \begin_inset Flex Code
10540 \begin_layout Plain Layout
10547 \begin_inset Flex Code
10550 \begin_layout Plain Layout
10556 ] This section (re-)defines the layout of an inset.
10557 It can be applied to an existing inset or to a new, user-defined inset,
10558 e.g., a new character style.
10560 \begin_inset Quotes eld
10564 \begin_inset Flex Code
10567 \begin_layout Plain Layout
10574 \begin_inset Quotes erd
10578 \begin_inset Newline newline
10582 \begin_inset CommandInset ref
10584 reference "subsec:Flex-insets-and"
10588 for more information.
10592 \begin_layout Description
10593 \begin_inset Flex Code
10596 \begin_layout Plain Layout
10603 \begin_inset Flex Code
10606 \begin_layout Plain Layout
10612 ] A string that indicates the width of the left margin on the screen, for
10614 \begin_inset Quotes eld
10618 \begin_inset Flex Code
10621 \begin_layout Plain Layout
10628 \begin_inset Quotes erd
10632 (Note that this is not a `length', like
10633 \begin_inset Quotes eld
10637 \begin_inset Quotes erd
10643 \begin_layout Description
10644 \begin_inset Flex Code
10647 \begin_layout Plain Layout
10654 \begin_inset Flex Code
10657 \begin_layout Plain Layout
10663 ] An integer that determines the maximal number of names displayed in an
10664 author-year citation before the citation switches to
10665 \begin_inset Quotes eld
10669 \begin_inset Quotes erd
10673 Primarily used in cite engine files (see
10674 \begin_inset CommandInset ref
10676 reference "subsec:Cite-Engine-Files"
10686 \begin_layout Description
10688 \change_inserted -712698321 1612018485
10689 \begin_inset Flex Code
10692 \begin_layout Plain Layout
10694 \change_inserted -712698321 1612018457
10703 \begin_inset Flex Code
10706 \begin_layout Plain Layout
10708 \change_inserted -712698321 1612018466
10716 ] Modifies the layout of an inset.
10717 If the layout does not exist, this section is ignored.
10719 \begin_inset Quotes eld
10723 \begin_inset Flex Code
10726 \begin_layout Plain Layout
10728 \change_inserted -712698321 1612018452
10737 \begin_inset Quotes erd
10743 \begin_layout Description
10744 \begin_inset Flex Code
10747 \begin_layout Plain Layout
10754 \begin_inset Flex Code
10757 \begin_layout Plain Layout
10763 ] Modifies the properties of the given paragraph style.
10764 If the style does not exist, this section is ignored.
10766 \begin_inset Quotes eld
10770 \begin_inset Flex Code
10773 \begin_layout Plain Layout
10780 \begin_inset Quotes erd
10786 \begin_layout Description
10787 \begin_inset Flex Code
10790 \begin_layout Plain Layout
10797 \begin_inset Flex Code
10800 \begin_layout Plain Layout
10806 ] Deletes an existing counter, usually one defined in an included file.
10809 \begin_layout Description
10810 \begin_inset Flex Code
10813 \begin_layout Plain Layout
10820 \begin_inset Flex Code
10823 \begin_layout Plain Layout
10829 ] Deletes an existing float.
10830 This is particularly useful when you want to suppress a float that has
10831 been defined in an input file.
10834 \begin_layout Description
10835 \begin_inset Flex Code
10838 \begin_layout Plain Layout
10845 \begin_inset Flex Code
10848 \begin_layout Plain Layout
10854 ] Deletes an existing style.
10857 \begin_layout Description
10858 \begin_inset Flex Code
10861 \begin_layout Plain Layout
10868 \begin_inset Flex Code
10871 \begin_layout Plain Layout
10878 \begin_inset Flex Code
10881 \begin_layout Plain Layout
10887 ] Define a new table of contents with type
10888 \begin_inset Flex Code
10891 \begin_layout Plain Layout
10898 \begin_inset Flex Code
10901 \begin_layout Plain Layout
10908 See also the AddToToc commands.
10911 \begin_layout Description
10912 \begin_inset Flex Code
10915 \begin_layout Plain Layout
10922 \begin_inset Flex Code
10925 \begin_layout Plain Layout
10931 ] The file format (as defined in the \SpecialChar LyX
10932 preferences) produced by this document
10934 It is mainly useful when
10935 \begin_inset Flex Code
10938 \begin_layout Plain Layout
10945 \begin_inset Flex Code
10948 \begin_layout Plain Layout
10954 and one wants to define a new type of literate document.
10955 The format is reset to
10956 \change_deleted 5863208 1594239413
10958 \begin_inset Quotes eld
10962 \begin_inset Flex Code
10965 \begin_layout Plain Layout
10972 \begin_inset Quotes erd
10978 \begin_inset Quotes eld
10982 \begin_inset Flex Code
10985 \begin_layout Plain Layout
10992 \begin_inset Quotes erd
10995 when the corresponding
10996 \begin_inset Flex Code
10999 \begin_layout Plain Layout
11005 parameter is encountered.
11008 \begin_layout Description
11009 \begin_inset Flex Code
11012 \begin_layout Plain Layout
11019 \begin_inset Flex Code
11022 \begin_layout Plain Layout
11033 \change_deleted 5863208 1594239430
11035 \begin_inset Flex Code
11038 \begin_layout Plain Layout
11047 \begin_inset Flex Code
11050 \begin_layout Plain Layout
11056 ] Specifies what sort of output documents using this class will produce.
11059 \begin_layout Description
11060 \begin_inset Flex Code
11063 \begin_layout Plain Layout
11070 \begin_inset Flex Code
11073 \begin_layout Plain Layout
11080 \begin_inset Flex Code
11083 \begin_layout Plain Layout
11089 ] Specifies options, given in the second string, for the package named by
11092 \begin_inset Quotes eld
11096 \begin_inset Flex Code
11099 \begin_layout Plain Layout
11100 PackageOptions natbib square
11106 \begin_inset Quotes erd
11110 \begin_inset Flex Code
11113 \begin_layout Plain Layout
11119 to be loaded with the
11120 \begin_inset Flex Code
11123 \begin_layout Plain Layout
11130 (For \SpecialChar TeX
11131 perts, this causes \SpecialChar LyX
11133 \begin_inset Flex Code
11136 \begin_layout Plain Layout
11139 PassOptionsToPackage{natbib}{square}
11145 \begin_inset Flex Code
11148 \begin_layout Plain Layout
11155 \change_inserted -712698321 1565102364
11159 \begin_layout Description
11161 \change_inserted -712698321 1565102470
11162 \begin_inset Flex Code
11165 \begin_layout Plain Layout
11167 \change_inserted -712698321 1565102365
11176 \begin_inset Flex Code
11179 \begin_layout Plain Layout
11181 \change_inserted -712698321 1565105222
11186 , letter, legal, executive, a0, a1, a2, a3, a4, a5, a6, b0, b1, b2, b3,
11187 b4, b5, b6, c0, c1, c2, c3, c4, c5, c6, b0j, b1j, b2j, b3j, b4j, b5j, b6j
11194 ] The default page size.
11195 This is used by some converters.
11200 \begin_layout Description
11201 \begin_inset Flex Code
11204 \begin_layout Plain Layout
11211 \begin_inset Flex Code
11214 \begin_layout Plain Layout
11223 \begin_inset Flex Code
11226 \begin_layout Plain Layout
11233 \begin_inset Flex Code
11236 \begin_layout Plain Layout
11242 ] The default pagestyle.
11243 Can be changed in the
11244 \begin_inset Flex Noun
11247 \begin_layout Plain Layout
11248 Document\SpecialChar menuseparator
11257 \begin_layout Description
11258 \begin_inset Flex Code
11261 \begin_layout Plain Layout
11267 Sets the preamble for the \SpecialChar LaTeX
11269 Note that this will completely override any prior
11270 \begin_inset Flex Code
11273 \begin_layout Plain Layout
11280 \begin_inset Flex Code
11283 \begin_layout Plain Layout
11291 \begin_inset Flex Code
11294 \begin_layout Plain Layout
11300 if you just want to add material to the preamble.) Must end with
11301 \begin_inset Quotes eld
11305 \begin_inset Flex Code
11308 \begin_layout Plain Layout
11315 \begin_inset Quotes erd
11319 \change_inserted -712698321 1612018500
11323 \begin_layout Description
11325 \change_inserted -712698321 1612018547
11326 \begin_inset Flex Code
11329 \begin_layout Plain Layout
11331 \change_inserted -712698321 1612018506
11340 \begin_inset Flex Code
11343 \begin_layout Plain Layout
11345 \change_inserted -712698321 1612018509
11353 ] Defines the layout of an inset if it does not already exist.
11354 If the layout does exist, this section is ignored.
11356 \begin_inset Quotes eld
11360 \begin_inset Flex Code
11363 \begin_layout Plain Layout
11365 \change_inserted -712698321 1612018500
11374 \begin_inset Quotes erd
11382 \begin_layout Description
11383 \begin_inset Flex Code
11386 \begin_layout Plain Layout
11393 \begin_inset Flex Code
11396 \begin_layout Plain Layout
11403 \begin_inset Flex Code
11406 \begin_layout Plain Layout
11415 \begin_inset space \thinspace{}
11419 \begin_inset Flex Code
11422 \begin_layout Plain Layout
11428 ] Whether the class already provides the feature
11429 \begin_inset Flex Code
11432 \begin_layout Plain Layout
11439 A feature is in general the name of a package (e.
11440 \begin_inset space \thinspace{}
11444 \begin_inset space \space{}
11448 \begin_inset Flex Code
11451 \begin_layout Plain Layout
11458 \begin_inset Flex Code
11461 \begin_layout Plain Layout
11468 \begin_inset space \thinspace{}
11472 \begin_inset space \space{}
11476 \begin_inset Flex Code
11479 \begin_layout Plain Layout
11486 \begin_inset Flex Code
11489 \begin_layout Plain Layout
11497 \begin_inset CommandInset ref
11499 reference "chap:List-of-functions"
11503 for the list of features.
11506 \begin_layout Description
11507 \begin_inset Flex Code
11510 \begin_layout Plain Layout
11517 \begin_inset Flex Code
11520 \begin_layout Plain Layout
11526 ] Indicates that this layout provides the functionality of the module mentioned,
11527 which should be specified by the filename without the
11528 \begin_inset Flex Code
11531 \begin_layout Plain Layout
11538 This will typically be used if the layout includes the module directly,
11539 rather than using the
11540 \begin_inset Flex Code
11543 \begin_layout Plain Layout
11549 tag to indicate that it ought to be used.
11550 It could also be used in a module that provided an alternate implementation
11551 of the same functionality.
11554 \begin_layout Description
11555 \begin_inset Flex Code
11558 \begin_layout Plain Layout
11565 \begin_inset Flex Code
11568 \begin_layout Plain Layout
11574 ] Creates a new paragraph style if it does not already exist.
11575 If the style does exist, this section is ignored.
11577 \begin_inset Quotes eld
11581 \begin_inset Flex Code
11584 \begin_layout Plain Layout
11591 \begin_inset Quotes erd
11597 \begin_layout Description
11598 \begin_inset Flex Code
11601 \begin_layout Plain Layout
11608 \begin_inset Flex Code
11611 \begin_layout Plain Layout
11617 ] Whether the class requires the feature
11618 \begin_inset Flex Code
11621 \begin_layout Plain Layout
11628 Multiple features must be separated by commas.
11629 Note that you can only request supported features.
11631 \begin_inset CommandInset ref
11633 reference "chap:List-of-functions"
11637 for the list of features.).
11638 If you require a package with specific options, you can additionally use
11640 \begin_inset Flex Code
11643 \begin_layout Plain Layout
11652 \begin_layout Description
11653 \begin_inset Flex Code
11656 \begin_layout Plain Layout
11663 \begin_inset Flex Code
11666 \begin_layout Plain Layout
11672 ] A string that indicates the width of the right margin on the screen, for
11674 \begin_inset Quotes eld
11678 \begin_inset Flex Code
11681 \begin_layout Plain Layout
11688 \begin_inset Quotes erd
11694 \begin_layout Description
11695 \begin_inset Flex Code
11698 \begin_layout Plain Layout
11705 \begin_inset Flex Code
11708 \begin_layout Plain Layout
11714 ] Sets which divisions get numbered.
11716 \begin_inset Newline newline
11720 \begin_inset Flex Code
11723 \begin_layout Plain Layout
11729 counter in \SpecialChar LaTeX
11733 \begin_layout Description
11734 \begin_inset Flex Code
11737 \begin_layout Plain Layout
11744 \begin_inset Flex Code
11747 \begin_layout Plain Layout
11756 \begin_inset space \thinspace{}
11760 \begin_inset Flex Code
11763 \begin_layout Plain Layout
11769 ] Whether the class-default should be printing on one or both sides of the
11771 Can be changed in the
11772 \begin_inset Flex Noun
11775 \begin_layout Plain Layout
11776 Document\SpecialChar menuseparator
11785 \begin_layout Description
11786 \begin_inset Flex Code
11789 \begin_layout Plain Layout
11796 \begin_inset Flex Code
11799 \begin_layout Plain Layout
11805 ] This sequence defines a paragraph style.
11806 If the style does not yet exist, it is created; if it does exist, its parameter
11809 \begin_inset Quotes eld
11813 \begin_inset Flex Code
11816 \begin_layout Plain Layout
11823 \begin_inset Quotes erd
11827 \begin_inset Newline newline
11831 \begin_inset CommandInset ref
11833 reference "subsec:Paragraph-Styles"
11837 for details on paragraph styles.
11838 \change_inserted -712698321 1553617804
11842 \begin_layout Description
11844 \change_inserted -712698321 1553617862
11845 \begin_inset Flex Code
11848 \begin_layout Plain Layout
11850 \change_inserted -712698321 1553617809
11859 \begin_inset Flex Code
11862 \begin_layout Plain Layout
11864 \change_inserted -712698321 1553617805
11872 ] defines the default table style that is used when inserting a table.
11873 The following styles are available:
11877 \begin_layout Itemize
11879 \change_inserted -712698321 1554308039
11880 \begin_inset Flex Code
11883 \begin_layout Plain Layout
11885 \change_inserted -712698321 1554307928
11886 Formal_with_Footline
11894 \begin_inset Quotes eld
11898 \begin_inset Quotes erd
11901 ) style with horizontal lines only, using a bold top and bottom line, the
11902 first and last row are additionally separated from the table body with
11903 a thin middle line.
11906 \begin_layout Itemize
11908 \change_inserted -712698321 1554308087
11909 \begin_inset Flex Code
11912 \begin_layout Plain Layout
11914 \change_inserted -712698321 1554308042
11915 Formal_without_Footline
11922 : same as the above, but the last row is not separated with a middle line
11926 \begin_layout Itemize
11928 \change_inserted -712698321 1553618031
11929 \begin_inset Flex Code
11932 \begin_layout Plain Layout
11934 \change_inserted -712698321 1553618006
11942 : Simple table lines.
11945 \begin_layout Itemize
11947 \change_inserted -712698321 1553618309
11948 \begin_inset Flex Code
11951 \begin_layout Plain Layout
11953 \change_inserted -712698321 1553618031
11962 \begin_inset Flex Code
11965 \begin_layout Plain Layout
11967 \change_inserted -712698321 1553618043
11975 , but with the header
11976 \change_deleted 34634807 1619712593
11978 \change_inserted 34634807 1619712594
11980 \change_inserted -712698321 1553618309
11981 offset with a second horizontal line.
11982 This is also the default style of \SpecialChar LyX
11986 \begin_layout Itemize
11988 \change_inserted -712698321 1553618280
11989 \begin_inset Flex Code
11992 \begin_layout Plain Layout
11994 \change_inserted -712698321 1553618261
12002 : Table without lines.
12008 \begin_layout Description
12009 \begin_inset Flex Code
12012 \begin_layout Plain Layout
12019 \begin_inset Flex Code
12022 \begin_layout Plain Layout
12028 ] The name of the command or environment to be used with
12029 \begin_inset Flex Code
12032 \begin_layout Plain Layout
12041 \begin_layout Description
12042 \begin_inset Flex Code
12045 \begin_layout Plain Layout
12052 \begin_inset Flex Code
12055 \begin_layout Plain Layout
12064 \begin_inset Flex Code
12067 \begin_layout Plain Layout
12073 ] Indicates what kind of markup is used to define the title of a document.
12075 \begin_inset Flex Code
12078 \begin_layout Plain Layout
12084 means that the macro with name
12085 \begin_inset Flex Code
12088 \begin_layout Plain Layout
12094 will be inserted after the last layout which has
12095 \begin_inset Quotes eld
12099 \begin_inset Flex Code
12102 \begin_layout Plain Layout
12104 \begin_inset space ~
12113 \begin_inset Quotes erd
12118 \begin_inset Flex Code
12121 \begin_layout Plain Layout
12127 corresponds to the case where all layouts which have
12128 \begin_inset Quotes eld
12132 \begin_inset Flex Code
12135 \begin_layout Plain Layout
12137 \begin_inset space ~
12146 \begin_inset Quotes erd
12149 should be enclosed into the
12150 \begin_inset Flex Code
12153 \begin_layout Plain Layout
12162 \begin_layout Description
12163 \begin_inset Flex Code
12166 \begin_layout Plain Layout
12173 \begin_inset Flex Code
12176 \begin_layout Plain Layout
12182 ] Sets which divisions are included in the table of contents.
12184 \begin_inset Flex Code
12187 \begin_layout Plain Layout
12193 counter in \SpecialChar LaTeX
12197 \begin_layout Subsection
12198 \begin_inset Flex Code
12201 \begin_layout Plain Layout
12208 \begin_inset CommandInset label
12210 name "subsec:ClassOptions"
12217 \begin_layout Standard
12219 \begin_inset Flex Code
12222 \begin_layout Plain Layout
12228 section can contain the following entries:
12231 \begin_layout Description
12232 \begin_inset Flex Code
12235 \begin_layout Plain Layout
12242 \begin_inset Flex Code
12245 \begin_layout Plain Layout
12251 ] The list of available font sizes for the document's main font, separated
12253 \begin_inset Quotes eld
12257 \begin_inset Flex Code
12260 \begin_layout Plain Layout
12267 \begin_inset Quotes erd
12272 \change_inserted -712698321 1565110196
12273 Any number is possible.
12276 \begin_layout Description
12278 \change_inserted -712698321 1565110259
12279 \begin_inset Flex Code
12282 \begin_layout Plain Layout
12284 \change_inserted -712698321 1565110199
12293 \begin_inset Flex Code
12296 \begin_layout Plain Layout
12298 \change_inserted -712698321 1565110196
12306 ] The format for the font size option.
12308 \begin_inset Flex Code
12311 \begin_layout Plain Layout
12313 \change_inserted -712698321 1565110238
12323 \begin_inset Flex Code
12326 \begin_layout Plain Layout
12328 \change_inserted -712698321 1565110248
12336 is a placeholder for the font size.
12341 \begin_layout Description
12343 \change_deleted 5863208 1594239483
12344 \begin_inset Flex Code
12347 \begin_layout Plain Layout
12353 Used to set the DTD line with XML-based output classes.
12355 \begin_inset space \thinspace{}
12359 \begin_inset Quotes eld
12362 -//OASIS//DTD DocBook V4.2//EN
12363 \begin_inset Quotes erd
12367 \change_inserted -712698321 1565101761
12371 \begin_layout Description
12373 \change_inserted -712698321 1565180598
12374 \begin_inset Flex Code
12377 \begin_layout Plain Layout
12379 \change_inserted -712698321 1565101918
12388 \begin_inset Flex Code
12391 \begin_layout Plain Layout
12393 \change_inserted -712698321 1565105399
12394 string="letter|\SpecialChar allowbreak
12395 legal|\SpecialChar allowbreak
12396 executive|\SpecialChar allowbreak
12397 a0|\SpecialChar allowbreak
12398 a1|\SpecialChar allowbreak
12399 a2|\SpecialChar allowbreak
12400 a3|\SpecialChar allowbreak
12401 a4|\SpecialChar allowbreak
12402 a5|\SpecialChar allowbreak
12403 a6|\SpecialChar allowbreak
12404 b0|\SpecialChar allowbreak
12405 b1|\SpecialChar allowbreak
12406 b2|\SpecialChar allowbreak
12407 b3|\SpecialChar allowbreak
12408 b4|\SpecialChar allowbreak
12409 b5|\SpecialChar allowbreak
12410 b6|\SpecialChar allowbreak
12411 c0|\SpecialChar allowbreak
12412 c1|\SpecialChar allowbreak
12414 2|\SpecialChar allowbreak
12415 c3|\SpecialChar allowbreak
12416 c4|\SpecialChar allowbreak
12417 c5|\SpecialChar allowbreak
12418 c6|\SpecialChar allowbreak
12419 b0j|\SpecialChar allowbreak
12420 b1j|\SpecialChar allowbreak
12421 b2j|\SpecialChar allowbreak
12422 b3j|\SpecialChar allowbreak
12423 b4j|\SpecialChar allowbreak
12424 b5j|\SpecialChar allowbreak
12432 ] The list of available page sizes, separated by
12433 \begin_inset Quotes eld
12437 \begin_inset Flex Code
12440 \begin_layout Plain Layout
12442 \change_inserted -712698321 1565101779
12451 \begin_inset Quotes erd
12455 Currently, only the listed sizes are supported.
12456 Other sizes might be entered as custom class option.
12459 \begin_layout Description
12461 \change_inserted -712698321 1565180623
12462 \begin_inset Flex Code
12465 \begin_layout Plain Layout
12467 \change_inserted -712698321 1565180605
12476 \begin_inset Flex Code
12479 \begin_layout Plain Layout
12481 \change_inserted -712698321 1565180601
12489 ] The format for the page size option.
12491 \begin_inset Flex Code
12494 \begin_layout Plain Layout
12496 \change_inserted -712698321 1565180618
12506 \begin_inset Flex Code
12509 \begin_layout Plain Layout
12511 \change_inserted -712698321 1565180601
12519 is a placeholder for the paper size.
12524 \begin_layout Description
12525 \begin_inset Flex Code
12528 \begin_layout Plain Layout
12535 \begin_inset Flex Code
12538 \begin_layout Plain Layout
12539 string="empty|plain|headings|fancy"
12544 ] The list of available page sty\SpecialChar softhyphen
12546 \begin_inset Quotes eld
12550 \begin_inset Flex Code
12553 \begin_layout Plain Layout
12560 \begin_inset Quotes erd
12566 \begin_layout Description
12567 \begin_inset Flex Code
12570 \begin_layout Plain Layout
12577 \begin_inset Flex Code
12580 \begin_layout Plain Layout
12586 ] Some document class options, separated by a comma, that will be added
12587 to the optional part of the
12588 \begin_inset Flex Code
12591 \begin_layout Plain Layout
12602 \begin_layout Standard
12604 \begin_inset Flex Code
12607 \begin_layout Plain Layout
12613 section must end with
12614 \begin_inset Quotes eld
12618 \begin_inset Flex Code
12621 \begin_layout Plain Layout
12628 \begin_inset Quotes erd
12634 \begin_layout Subsection
12636 \begin_inset CommandInset label
12638 name "subsec:Paragraph-Styles"
12645 \begin_layout Standard
12646 A paragraph style description looks like this:
12650 \begin_layout Plain Layout
12651 Note that this will either define a new style or modify an existing one.
12659 \begin_layout LyX-Code
12666 \begin_layout LyX-Code
12670 \begin_layout LyX-Code
12674 \begin_layout Standard
12675 where the following commands are allowed:
12678 \begin_layout Description
12679 \begin_inset Flex Code
12682 \begin_layout Plain Layout
12689 \begin_inset Flex Code
12692 \begin_layout Plain Layout
12698 =""] This paragraph will appear in the table of contents of the given type.
12699 An empty string disables.
12700 See also the OutlinerName and the IsTocCaption commands.
12704 \begin_layout Description
12705 \begin_inset Flex Code
12708 \begin_layout Plain Layout
12715 \begin_inset Flex Code
12718 \begin_layout Plain Layout
12723 , left, right, center
12728 ] Paragraph alignment.
12731 \begin_layout Description
12732 \begin_inset Flex Code
12735 \begin_layout Plain Layout
12742 \begin_inset Flex Code
12745 \begin_layout Plain Layout
12750 , left, right, center
12755 ] A comma separated list of permitted alignments.
12756 (Some \SpecialChar LaTeX
12757 styles prohibit certain alignments, since those wouldn't make sense.
12758 For example a right-aligned or centered enumeration isn't possible.)
12761 \begin_layout Description
12762 \begin_inset Flex Code
12765 \begin_layout Plain Layout
12772 \begin_inset Flex Code
12775 \begin_layout Plain Layout
12781 ] Defines argument number <int> of a command\SpecialChar breakableslash
12782 environment associated with
12785 \change_inserted -584632292 1615846868
12786 The definition must end with
12787 \begin_inset Flex Code
12790 \begin_layout Plain Layout
12792 \change_inserted -584632292 1615846867
12804 \change_inserted -584632292 1615846880
12806 \begin_inset CommandInset ref
12808 reference "subsec:Arguments"
12815 for more information.
12817 \change_deleted -584632292 1615846694
12818 This is useful for things like section headings, and only makes sense with
12821 Every (optional or required) argument of a command or environment – except
12822 for the required argument that is associated with the content of the paragraph
12823 itself – has a separate definition, where the number specifies the order
12825 The definition must end with
12826 \begin_inset Flex Code
12829 \begin_layout Plain Layout
12836 So a command with two optional arguments has:
12840 \begin_layout Quote
12842 \change_deleted -584632292 1615846694
12848 \begin_layout Quote
12850 \change_deleted -584632292 1615846694
12856 \begin_layout Quote
12858 \change_deleted -584632292 1615846694
12864 \begin_layout Quote
12866 \change_deleted -584632292 1615846694
12872 \begin_layout Quote
12874 \change_deleted -584632292 1615846694
12880 \begin_layout Quote
12882 \change_deleted -584632292 1615846694
12888 \begin_layout Standard
12890 \change_deleted -584632292 1615846694
12892 \begin_inset Flex Code
12895 \begin_layout Plain Layout
12901 definition, the following specifications are possible:
12904 \begin_layout Itemize
12906 \change_deleted -584632292 1615846694
12907 \begin_inset Flex Code
12910 \begin_layout Plain Layout
12917 \begin_inset Flex Code
12920 \begin_layout Plain Layout
12926 The string that will appear both in the menu (to insert this argument)
12927 and on the argument inset button (unless you also specify a separate
12928 \begin_inset Flex Code
12931 \begin_layout Plain Layout
12938 For the menu, you can define an accelerator by appending the respective
12939 character to the string, divided by
12940 \begin_inset Quotes eld
12944 \begin_inset Quotes erd
12948 \begin_inset space \thinspace{}
12952 \begin_inset space \space{}
12956 \begin_inset Quotes eld
12960 \begin_inset Flex Code
12963 \begin_layout Plain Layout
12970 \begin_inset Quotes erd
12976 \begin_layout Itemize
12978 \change_deleted -584632292 1615846694
12979 \begin_inset Flex Code
12982 \begin_layout Plain Layout
12989 \begin_inset Flex Code
12992 \begin_layout Plain Layout
12998 A separate string for the menu.
12999 You can define an accelerator by appending the respective character to
13000 the string, divided by
13001 \begin_inset Quotes eld
13005 \begin_inset Quotes erd
13009 \begin_inset space \thinspace{}
13013 \begin_inset space \space{}
13017 \begin_inset Quotes eld
13021 \begin_inset Flex Code
13024 \begin_layout Plain Layout
13031 \begin_inset Quotes erd
13035 This specification is optional.
13036 If it is not given the
13037 \begin_inset Flex Code
13040 \begin_layout Plain Layout
13046 will be used instead for the menu.
13049 \begin_layout Itemize
13051 \change_deleted -584632292 1615846694
13052 \begin_inset Flex Code
13055 \begin_layout Plain Layout
13062 \begin_inset Flex Code
13065 \begin_layout Plain Layout
13071 A longer explanatory text that appears in the tooltip when hovering over
13072 the argument inset.
13075 \begin_layout Itemize
13077 \change_deleted -584632292 1615846694
13078 \begin_inset Flex Code
13081 \begin_layout Plain Layout
13088 \begin_inset Flex Code
13091 \begin_layout Plain Layout
13100 \begin_inset space \thinspace{}
13104 \begin_inset Flex Code
13107 \begin_layout Plain Layout
13113 ] Declare if this is a mandatory (1) or an optional (0) argument.
13114 Mandatory arguments will be output empty if not given, while optional arguments
13115 will not be output at all.
13116 By default, mandatory arguments are delimited by
13117 \begin_inset Flex Code
13120 \begin_layout Plain Layout
13126 , while optional arguments are delimited by
13127 \begin_inset Flex Code
13130 \begin_layout Plain Layout
13139 \begin_layout Itemize
13141 \change_deleted -584632292 1615846694
13142 \begin_inset Flex Code
13145 \begin_layout Plain Layout
13147 \change_inserted -712698321 1555579780
13156 \begin_inset Flex Code
13159 \begin_layout Plain Layout
13161 \change_inserted -712698321 1555579780
13169 Option to define a different command (from the default
13170 \begin_inset Flex Code
13173 \begin_layout Plain Layout
13175 \change_inserted -712698321 1555579780
13187 ) to be used for line breaks.
13188 The initial backslash must not be specified.
13191 \begin_layout Itemize
13193 \change_deleted -584632292 1615846694
13194 \begin_inset Flex Code
13197 \begin_layout Plain Layout
13204 \begin_inset Flex Code
13207 \begin_layout Plain Layout
13213 defines another argument (by its number) which this argument requires to
13214 be output if it is itself output.
13216 \begin_inset space \thinspace{}
13219 g., in \SpecialChar LaTeX
13220 commands, optional arguments often require previous optional arguments
13221 to be output (at least empty), as in
13222 \begin_inset Flex Code
13225 \begin_layout Plain Layout
13228 command[][argument]{text}
13234 This can be achieved by the statement
13235 \begin_inset Flex Code
13238 \begin_layout Plain Layout
13245 \begin_inset Flex Code
13248 \begin_layout Plain Layout
13257 \begin_layout Itemize
13259 \change_deleted -584632292 1615846694
13260 \begin_inset Flex Code
13263 \begin_layout Plain Layout
13270 \begin_inset Flex Code
13273 \begin_layout Plain Layout
13279 defines a custom left delimiter (instead of
13280 \begin_inset Flex Code
13283 \begin_layout Plain Layout
13290 \begin_inset Flex Code
13293 \begin_layout Plain Layout
13300 A line break in the output can be indicated by
13301 \begin_inset Flex Code
13304 \begin_layout Plain Layout
13313 \begin_layout Itemize
13315 \change_deleted -584632292 1615846694
13316 \begin_inset Flex Code
13319 \begin_layout Plain Layout
13326 \begin_inset Flex Code
13329 \begin_layout Plain Layout
13335 defines a custom right delimiter (instead of
13336 \begin_inset Flex Code
13339 \begin_layout Plain Layout
13346 \begin_inset Flex Code
13349 \begin_layout Plain Layout
13356 A line break in the output can be indicated by
13357 \begin_inset Flex Code
13360 \begin_layout Plain Layout
13369 \begin_layout Itemize
13371 \change_deleted -584632292 1615846694
13372 \begin_inset Flex Code
13375 \begin_layout Plain Layout
13382 \begin_inset Flex Code
13385 \begin_layout Plain Layout
13391 defines an argument that is inserted if and only if no user-specified arguments
13393 \begin_inset space \thinspace{}
13397 \begin_inset space \space{}
13400 if no argument inset has been inserted (note that also an empty argument
13401 inset omits the DefaultArg).
13402 Multiple arguments need to be separated by comma.
13405 \begin_layout Itemize
13407 \change_deleted -584632292 1615846694
13408 \begin_inset Flex Code
13411 \begin_layout Plain Layout
13418 \begin_inset Flex Code
13421 \begin_layout Plain Layout
13427 defines an argument that is inserted in any case (alone or in addition
13428 to user-specified arguments).
13429 Multiple arguments need to be separated by comma.
13432 \begin_layout Itemize
13434 \change_deleted -584632292 1615846694
13435 \begin_inset Flex Code
13438 \begin_layout Plain Layout
13444 The font used for the argument content, see
13445 \begin_inset CommandInset ref
13447 reference "subsec:Font-description"
13454 \begin_layout Itemize
13456 \change_deleted -584632292 1615846694
13457 \begin_inset Flex Code
13460 \begin_layout Plain Layout
13462 \change_inserted -712698321 1559484228
13471 \begin_inset Flex Code
13474 \begin_layout Plain Layout
13476 \change_inserted -712698321 1559484228
13487 \begin_inset space \thinspace{}
13491 \begin_inset Flex Code
13494 \begin_layout Plain Layout
13496 \change_inserted -712698321 1559484228
13504 ] As with paragraph styles, see
13505 \begin_inset CommandInset ref
13507 reference "subsec:Paragraph-Styles"
13514 \begin_layout Itemize
13516 \change_deleted -584632292 1615846694
13517 \begin_inset Flex Code
13520 \begin_layout Plain Layout
13526 The font used for the label; see
13527 \begin_inset CommandInset ref
13529 reference "subsec:Font-description"
13536 \begin_layout Itemize
13538 \change_deleted -584632292 1615846694
13539 \begin_inset Flex Code
13542 \begin_layout Plain Layout
13549 \begin_inset Flex Code
13552 \begin_layout Plain Layout
13557 , Minimalistic, Conglomerate
13562 ] describes the rendering style used for the inset's frame and buttons.
13565 \begin_layout Itemize
13567 \change_deleted -584632292 1615846694
13568 \begin_inset Flex Code
13571 \begin_layout Plain Layout
13578 \begin_inset Flex Code
13581 \begin_layout Plain Layout
13588 \begin_inset Flex Code
13591 \begin_layout Plain Layout
13597 , this argument is automatically inserted when the respective style is selected.
13599 \change_deleted -712698321 1559484200
13600 Currently, only one argument per style\SpecialChar breakableslash
13601 layout can be automatically inserted.
13602 \change_deleted -584632292 1615846694
13606 \begin_layout Itemize
13608 \change_deleted -584632292 1615846694
13609 \begin_inset Flex Code
13612 \begin_layout Plain Layout
13614 \change_inserted -712698321 1559490711
13623 \begin_inset Flex Code
13626 \begin_layout Plain Layout
13628 \change_inserted -712698321 1559490703
13637 \begin_inset Flex Code
13640 \begin_layout Plain Layout
13642 \change_inserted -712698321 1559490703
13650 , this argument will be inserted on a new line with
13651 \begin_inset Flex Code
13654 \begin_layout Plain Layout
13656 \change_inserted -712698321 1559491402
13664 (only available within Flex insets).
13667 \begin_layout Itemize
13669 \change_deleted -584632292 1615846694
13670 \begin_inset Flex Code
13673 \begin_layout Plain Layout
13680 \begin_inset Flex Code
13683 \begin_layout Plain Layout
13690 \begin_inset Flex Code
13693 \begin_layout Plain Layout
13699 , this argument will be inserted with a copy of the co-text (either selected
13700 text or the whole paragraph) as content.
13703 \begin_layout Itemize
13705 \change_deleted -584632292 1615846694
13706 \begin_inset Flex Code
13709 \begin_layout Plain Layout
13716 \begin_inset Flex Code
13719 \begin_layout Plain Layout
13729 ] Whether the contents of this argument should be output in raw form, meaning
13730 without special translations that \SpecialChar LaTeX
13733 \begin_inset Flex Code
13736 \begin_layout Plain Layout
13742 status is inherited by the inset or paragraph layout the argument belongs
13743 to, true and false change the status for the given argument only.
13746 \begin_layout Itemize
13748 \change_deleted -584632292 1615846694
13749 \begin_inset Flex Code
13752 \begin_layout Plain Layout
13759 \begin_inset Flex Code
13762 \begin_layout Plain Layout
13763 string of characters
13772 Defines individual characters
13773 \begin_inset Newline linebreak
13776 that should be output in raw form, meaning without special translations
13777 that \SpecialChar LaTeX
13779 Note that, contrary to PassThru, this needs to be explicitly defined for
13781 That is, arguments do not inherit PassThruChars from their parent inset
13785 \begin_layout Itemize
13787 \change_deleted -584632292 1615846694
13788 \begin_inset Flex Code
13791 \begin_layout Plain Layout
13798 \begin_inset Flex Code
13801 \begin_layout Plain Layout
13810 \begin_inset space \thinspace{}
13814 \begin_inset Flex Code
13817 \begin_layout Plain Layout
13823 ] If this is set to 1, the argument will output its content in the corresponding
13824 item in the table of contents.
13828 \begin_layout Standard
13830 \change_deleted -584632292 1615846694
13831 By default, the text entered in the \SpecialChar LyX
13832 workarea in the respective layout is
13833 the last (mandatory) argument of a command if the
13834 \begin_inset Flex Code
13837 \begin_layout Plain Layout
13844 \begin_inset Flex Code
13847 \begin_layout Plain Layout
13854 However, arguments with the prefix
13855 \begin_inset Flex Code
13858 \begin_layout Plain Layout
13864 are output after this workarea argument.
13865 Note that post-argument numbering restarts at 1, so the first argument
13866 following the workarea argument is
13867 \begin_inset Flex Code
13870 \begin_layout Plain Layout
13877 Post-arguments are ignored in any other
13878 \begin_inset Flex Code
13881 \begin_layout Plain Layout
13888 \begin_inset Flex Code
13891 \begin_layout Plain Layout
13900 \begin_layout Standard
13902 \change_deleted -584632292 1615846694
13904 \begin_inset Flex Code
13907 \begin_layout Plain Layout
13916 \begin_inset Flex Code
13919 \begin_layout Plain Layout
13928 \begin_inset Flex Code
13931 \begin_layout Plain Layout
13937 followed by the number (e.
13938 \begin_inset space \thinspace{}
13942 \begin_inset space \space{}
13946 \begin_inset Flex Code
13949 \begin_layout Plain Layout
13958 \begin_layout Standard
13960 \change_deleted -584632292 1615846694
13961 Finally, there is a special argument type with the prefix
13962 \begin_inset Flex Code
13965 \begin_layout Plain Layout
13967 \change_inserted -712698321 1534487844
13976 It is not really an argument, but uses the argument interface (thus, the
13977 prefix is also followed by a number, e.
13978 \begin_inset space \thinspace{}
13983 \begin_inset Flex Code
13986 \begin_layout Plain Layout
13988 \change_inserted -712698321 1534488412
13989 Argument listpreamble:1
13997 As the name implies, it is targeted at lists such as
14014 Its content will be output at the list start, before the first
14015 \begin_inset Flex Code
14018 \begin_layout Plain Layout
14020 \change_inserted -712698321 1534488058
14030 , on an own line (a place that is otherwise not accessible in \SpecialChar LyX
14032 This way, users can insert redefinitions (of lengths etc.) to individual
14034 By default, these arguments do not have a delimiter.
14040 \begin_layout Description
14041 \begin_inset Flex Code
14044 \begin_layout Plain Layout
14050 Includes a comma-separated list of layouts that should be nested in and
14051 after the current layout.
14052 Only makes sense for nestable layouts (such as environments).
14054 \begin_inset Quotes eld
14058 \begin_inset Flex Code
14061 \begin_layout Plain Layout
14068 \begin_inset Quotes erd
14073 \begin_inset Flex Code
14076 \begin_layout Plain Layout
14085 \begin_layout Description
14086 \begin_inset Flex Code
14089 \begin_layout Plain Layout
14095 Note that this will completely override any prior
14096 \begin_inset Flex Code
14099 \begin_layout Plain Layout
14105 declaration for this style.
14107 \begin_inset Quotes eld
14111 \begin_inset Flex Code
14114 \begin_layout Plain Layout
14121 \begin_inset Quotes erd
14126 \begin_inset CommandInset ref
14128 reference "subsec:I18n"
14132 for details on its use.
14135 \begin_layout Description
14136 \begin_inset Flex Code
14139 \begin_layout Plain Layout
14146 \begin_inset Flex Code
14149 \begin_layout Plain Layout
14159 \begin_layout Plain Layout
14160 Note that a `float' here is a real number, such as: 1.5.
14165 The vertical space with which the last of a chain of paragraphs with this
14166 style is separated from the following paragraph.
14167 If the next paragraph has another style, the separations are not simply
14168 added, but the maximum is taken.
14171 \begin_layout Description
14172 \begin_inset Flex Code
14175 \begin_layout Plain Layout
14182 \begin_inset Flex Code
14185 \begin_layout Plain Layout
14191 ] The category for this style.
14192 This is used to group related styles in the style combobox on the toolbar.
14193 Any string can be used, but you may want to use existing categories with
14198 \begin_layout Description
14199 \begin_inset Flex Code
14202 \begin_layout Plain Layout
14208 Depth of XML command.
14209 Used only with XML-type formats.
14212 \begin_layout Description
14213 \begin_inset Flex Code
14216 \begin_layout Plain Layout
14223 \begin_inset Flex Code
14226 \begin_layout Plain Layout
14232 ] Copies all the features of an existing style into the current one.
14236 \begin_layout Description
14237 \begin_inset Flex Code
14240 \begin_layout Plain Layout
14247 \begin_inset Flex Code
14250 \begin_layout Plain Layout
14256 ] The name of a style whose preamble should be output
14261 This allows to ensure some ordering of the preamble snippets when macros
14262 definitions depend on one another.
14266 \begin_layout Plain Layout
14267 Note that, besides that functionality, there is no way to ensure any ordering
14269 The ordering that you see in a given version of \SpecialChar LyX
14270 may change without warning
14279 \begin_layout Description
14280 \begin_inset Flex Code
14283 \begin_layout Plain Layout
14290 \begin_inset Flex Code
14293 \begin_layout Plain Layout
14298 , Box, Filled_Box, Static
14303 ] The type of label that stands at the end of the paragraph (or sequence
14305 \begin_inset Flex Code
14308 \begin_layout Plain Layout
14315 \begin_inset Newline newline
14319 \begin_inset Flex Code
14322 \begin_layout Plain Layout
14329 \begin_inset Flex Code
14332 \begin_layout Plain Layout
14339 \begin_inset Flex Code
14342 \begin_layout Plain Layout
14350 \begin_inset Flex Code
14353 \begin_layout Plain Layout
14360 \begin_inset Quotes eld
14364 \begin_inset Quotes erd
14368 \begin_inset Flex Code
14371 \begin_layout Plain Layout
14378 \begin_inset space \space{}
14382 \begin_inset Flex Code
14385 \begin_layout Plain Layout
14391 ) is a white (resp.
14392 \begin_inset space ~
14395 black) square suitable for end of proof markers,
14396 \begin_inset Flex Code
14399 \begin_layout Plain Layout
14405 is an explicit text string.
14408 \begin_layout Description
14409 \begin_inset Flex Code
14412 \begin_layout Plain Layout
14419 \begin_inset Flex Code
14422 \begin_layout Plain Layout
14428 ] The string used for a label with a
14429 \begin_inset Flex Code
14432 \begin_layout Plain Layout
14439 \begin_inset Newline newline
14443 \begin_inset Flex Code
14446 \begin_layout Plain Layout
14456 \begin_layout Description
14457 \begin_inset Flex Code
14460 \begin_layout Plain Layout
14466 The font used for both the text body
14472 \begin_inset CommandInset ref
14474 reference "subsec:Font-description"
14479 Note that defining this font automatically defines the
14480 \begin_inset Flex Code
14483 \begin_layout Plain Layout
14490 So you should define this one first if you also want to define
14491 \begin_inset Flex Code
14494 \begin_layout Plain Layout
14503 \begin_layout Description
14504 \begin_inset Flex Code
14507 \begin_layout Plain Layout
14514 \begin_inset Flex Code
14517 \begin_layout Plain Layout
14523 ] Used for backporting new styles to stable \SpecialChar LyX
14525 The first stable version that supports this tag is \SpecialChar LyX
14527 The argument is a number which may either be 0, -1 or any value greater
14530 \begin_inset Flex Code
14533 \begin_layout Plain Layout
14539 flag of a style is greater than zero, it will always be written to the
14541 If a .lyx file is read, the style definitions from the document header are
14542 added to the document class.
14543 Therefore even older \SpecialChar LyX
14544 versions can handle the style.
14546 \begin_inset Flex Code
14549 \begin_layout Plain Layout
14555 is a version number: if the style is read, and the version number is less
14556 than the version number of the already existing style in the document class,
14557 the new style is ignored.
14558 If the version number is greater, the new style replaces the existing style.
14559 A value of -1 means an infinite version number, i.
14560 \begin_inset space \thinspace{}
14564 \begin_inset space \space{}
14567 the style is always used.
14570 \begin_layout Description
14571 \begin_inset Flex Code
14574 \begin_layout Plain Layout
14581 \begin_inset Flex Code
14584 \begin_layout Plain Layout
14593 \begin_inset space \thinspace{}
14597 \begin_inset Flex Code
14600 \begin_layout Plain Layout
14606 ] Usually \SpecialChar LyX
14607 does not allow you to insert more than one space between words,
14608 since a space is considered as the separation between two words, not a
14609 character or symbol of its own.
14610 This is a very fine thing but sometimes annoying, for example, when typing
14611 program code or plain \SpecialChar LaTeX
14614 \begin_inset Flex Code
14617 \begin_layout Plain Layout
14625 \change_deleted -495245474 1550490105
14630 \change_deleted 177693 1654669077
14632 \change_inserted 177693 1654669079
14636 \change_deleted 177693 1654669082
14638 \change_inserted 177693 1654669082
14641 for the additional blanks when
14642 \change_deleted 34634807 1619626461
14646 \change_inserted -495245474 1550490096
14648 \begin_inset Flex Code
14651 \begin_layout Plain Layout
14653 \change_inserted -495245474 1550490089
14662 \change_deleted -495245474 1550490116
14663 another mode than \SpecialChar LaTeX
14666 \change_inserted -495245474 1550247760
14668 \begin_inset Flex Code
14671 \begin_layout Plain Layout
14673 \change_inserted -495245474 1550247736
14682 \begin_inset Flex Code
14685 \begin_layout Plain Layout
14687 \change_inserted -495245474 1550247755
14700 \begin_layout Description
14701 \begin_inset Flex Code
14704 \begin_layout Plain Layout
14710 These tags are used with XHTML output.
14712 \begin_inset CommandInset ref
14714 reference "subsec:Paragraph-Style-XHTML"
14721 \begin_layout Description
14722 \begin_inset Flex Code
14725 \begin_layout Plain Layout
14731 [FIXME] (Used only with XML-type formats.)
14734 \begin_layout Description
14735 \begin_inset Flex Code
14738 \begin_layout Plain Layout
14745 \begin_inset Flex Code
14748 \begin_layout Plain Layout
14757 \begin_inset space \thinspace{}
14761 \begin_inset Flex Code
14764 \begin_layout Plain Layout
14771 \begin_inset Flex Code
14774 \begin_layout Plain Layout
14780 , marks the style as to be included in the document preamble and not in
14782 This is useful for document classes that want such information as the title
14783 and author to appear in the preamble.
14784 Note that this works only for styles for which the
14785 \begin_inset Flex Code
14788 \begin_layout Plain Layout
14795 \begin_inset Flex Code
14798 \begin_layout Plain Layout
14805 \begin_inset Flex Code
14808 \begin_layout Plain Layout
14817 \begin_layout Description
14818 \begin_inset Flex Code
14821 \begin_layout Plain Layout
14828 \begin_inset Flex Code
14831 \begin_layout Plain Layout
14840 \begin_inset space \thinspace{}
14844 \begin_inset Flex Code
14847 \begin_layout Plain Layout
14854 \begin_inset Flex Code
14857 \begin_layout Plain Layout
14863 , marks the style as being part of a title block (see also the
14864 \begin_inset Flex Code
14867 \begin_layout Plain Layout
14874 \begin_inset Flex Code
14877 \begin_layout Plain Layout
14886 \begin_layout Description
14887 \begin_inset Flex Code
14890 \begin_layout Plain Layout
14896 Includes a comma-separated list of layouts after which this one should
14898 Only makes sense with regard to nestable layouts (such as environments).
14900 \begin_inset Quotes eld
14904 \begin_inset Flex Code
14907 \begin_layout Plain Layout
14914 \begin_inset Quotes erd
14919 \begin_inset Flex Code
14922 \begin_layout Plain Layout
14931 \begin_layout Description
14932 \begin_inset Flex Code
14935 \begin_layout Plain Layout
14942 \begin_inset Flex Code
14945 \begin_layout Plain Layout
14954 \begin_inset space \thinspace{}
14958 \begin_inset Flex Code
14961 \begin_layout Plain Layout
14967 ] If this is set to 1 and AddToToc is enabled, the paragraph adds a summary
14968 of its contents in its item in the table of contents.
14969 Otherwise, only the label, if it exists, appears.
14972 \begin_layout Description
14973 \begin_inset Flex Code
14976 \begin_layout Plain Layout
14983 \begin_inset Flex Code
14986 \begin_layout Plain Layout
14992 ] The \SpecialChar LaTeX
14993 command sequence declaring an item in a list.
14994 The command is to be defined without the preceding backslash (the default
14996 \begin_inset Quotes eld
15000 \begin_inset Quotes erd
15004 \begin_inset Flex Code
15007 \begin_layout Plain Layout
15015 in the \SpecialChar LaTeX
15019 \begin_layout Description
15020 \begin_inset Flex Code
15023 \begin_layout Plain Layout
15030 \begin_inset Flex Code
15033 \begin_layout Plain Layout
15039 ] This provides extra space between paragraphs that have the same style.
15040 If you put other styles into an environment, each is separated with the
15042 \begin_inset Flex Code
15045 \begin_layout Plain Layout
15052 But the whole items of the environment are additionally separated with
15054 \begin_inset Flex Code
15057 \begin_layout Plain Layout
15064 Note that this is a
15069 \begin_layout Description
15070 \begin_inset Flex Code
15073 \begin_layout Plain Layout
15079 [FIXME] (Used only with XML-type formats.)
15082 \begin_layout Description
15083 \begin_inset Flex Code
15086 \begin_layout Plain Layout
15093 \begin_inset Flex Code
15096 \begin_layout Plain Layout
15105 \begin_inset space \thinspace{}
15109 \begin_inset Flex Code
15112 \begin_layout Plain Layout
15118 ] Usually \SpecialChar LyX
15119 does not allow you to leave a paragraph empty, since it would
15120 lead to empty \SpecialChar LaTeX
15122 There are some cases where this could be desirable however: in a letter
15123 template, the required fields can be provided as empty fields, so that
15124 people do not forget them; in some special classes, a style can be used
15125 as some kind of break, which does not contain actual text.
15128 \begin_layout Description
15129 \begin_inset Flex Code
15132 \begin_layout Plain Layout
15139 \begin_inset Flex Code
15142 \begin_layout Plain Layout
15148 ] The vertical space between the label and the text body.
15149 Only used for labels that are above the text body (
15150 \begin_inset Flex Code
15153 \begin_layout Plain Layout
15160 \begin_inset Newline newline
15164 \begin_inset Flex Code
15167 \begin_layout Plain Layout
15168 Centered_Top_Environment
15176 \begin_layout Description
15177 \begin_inset Flex Code
15180 \begin_layout Plain Layout
15187 \begin_inset Flex Code
15190 \begin_layout Plain Layout
15196 ] The name of the counter for automatic numbering.
15197 In order to have the counter appear with your label, you will need to reference
15199 \begin_inset Flex Code
15202 \begin_layout Plain Layout
15211 This will work with
15212 \begin_inset Flex Code
15215 \begin_layout Plain Layout
15222 \begin_inset Flex Code
15225 \begin_layout Plain Layout
15232 \begin_inset Flex Code
15235 \begin_layout Plain Layout
15242 \begin_inset Flex Code
15245 \begin_layout Plain Layout
15252 \begin_inset Newline newline
15260 \begin_inset Flex Code
15263 \begin_layout Plain Layout
15270 \begin_inset Flex Code
15273 \begin_layout Plain Layout
15279 , though this case is a bit complicated.
15280 Suppose you declare
15281 \begin_inset Quotes eld
15285 \begin_inset Flex Code
15288 \begin_layout Plain Layout
15289 LabelCounter myenum
15295 \begin_inset Quotes erd
15299 Then the actual counters used are
15300 \begin_inset Flex Code
15303 \begin_layout Plain Layout
15310 \begin_inset Flex Code
15313 \begin_layout Plain Layout
15320 \begin_inset Flex Code
15323 \begin_layout Plain Layout
15330 \begin_inset Flex Code
15333 \begin_layout Plain Layout
15339 , much as in \SpecialChar LaTeX
15341 These counters must all be declared separately.
15342 \begin_inset Newline newline
15346 \begin_inset CommandInset ref
15348 reference "subsec:Counters"
15352 for details on counters.
15355 \begin_layout Description
15356 \begin_inset Flex Code
15359 \begin_layout Plain Layout
15365 The font used for the label.
15367 \begin_inset CommandInset ref
15369 reference "subsec:Font-description"
15376 \begin_layout Description
15377 \begin_inset Flex Code
15380 \begin_layout Plain Layout
15387 \begin_inset Flex Code
15390 \begin_layout Plain Layout
15396 ] Text that indicates how far a label should be indented.
15399 \begin_layout Description
15400 \begin_inset Flex Code
15403 \begin_layout Plain Layout
15410 \begin_inset Flex Code
15413 \begin_layout Plain Layout
15419 ] Text that indicates the amount of horizontal space between the label and
15421 Only used for labels that are not above the text body.
15424 \begin_layout Description
15425 \begin_inset Flex Code
15428 \begin_layout Plain Layout
15435 \begin_inset Flex Code
15438 \begin_layout Plain Layout
15444 ] The string used for the label.
15446 \begin_inset Flex Code
15449 \begin_layout Plain Layout
15455 is set, this string can be contain the special formatting commands described
15457 \begin_inset CommandInset ref
15459 reference "subsec:Counters"
15466 \begin_layout Description
15467 \begin_inset Flex Code
15470 \begin_layout Plain Layout
15471 LabelStringAppendix
15477 \begin_inset Flex Code
15480 \begin_layout Plain Layout
15486 ] This is used inside the appendix instead of
15487 \begin_inset Newline newline
15491 \begin_inset Flex Code
15494 \begin_layout Plain Layout
15502 \begin_inset Flex Code
15505 \begin_layout Plain Layout
15512 \begin_inset Newline newline
15516 \begin_inset Flex Code
15519 \begin_layout Plain Layout
15520 LabelStringAppendix
15528 \begin_layout Description
15529 \begin_inset Flex Code
15532 \begin_layout Plain Layout
15538 [FIXME] (Used only with XML-type formats.)
15541 \begin_layout Description
15542 \begin_inset Flex Code
15545 \begin_layout Plain Layout
15552 \begin_inset Flex Code
15555 \begin_layout Plain Layout
15560 , Manual, Static, Above,
15561 \begin_inset Newline newline
15564 Centered, Sensitive, Enumerate,
15565 \begin_inset Newline newline
15568 Itemize, Bibliography
15577 \begin_layout Description
15578 \begin_inset Flex Code
15581 \begin_layout Plain Layout
15587 means the label is the very first word (up to the first real blank).
15589 \change_deleted 177693 1654669087
15591 \change_inserted 177693 1654669089
15594 spaces if you want more than one word as the label.
15598 \begin_layout Description
15599 \begin_inset Flex Code
15602 \begin_layout Plain Layout
15608 means the label is simply what is declared as
15609 \begin_inset Flex Code
15612 \begin_layout Plain Layout
15619 This will be displayed
15620 \begin_inset Quotes eld
15624 \begin_inset Quotes erd
15627 , at the beginning of the paragraph.
15629 \begin_inset Flex Code
15632 \begin_layout Plain Layout
15639 \begin_inset Flex Code
15642 \begin_layout Plain Layout
15648 , then it will be displayed only in the first paragraph of any sequence
15649 of paragraphs with the same
15650 \begin_inset Flex Code
15653 \begin_layout Plain Layout
15662 \begin_layout Description
15663 \begin_inset Flex Code
15666 \begin_layout Plain Layout
15673 \begin_inset space ~
15677 \begin_inset space ~
15681 \begin_inset Flex Code
15684 \begin_layout Plain Layout
15690 are special cases of
15691 \begin_inset Flex Code
15694 \begin_layout Plain Layout
15701 The label will be printed above the paragraph either at the beginning of
15702 the line or centered.
15705 \begin_layout Description
15706 \begin_inset Flex Code
15709 \begin_layout Plain Layout
15715 is a special case for the caption-labels
15716 \begin_inset Quotes eld
15720 \begin_inset Quotes erd
15724 \begin_inset Quotes eld
15728 \begin_inset Quotes erd
15732 \begin_inset Newline newline
15736 \begin_inset Flex Code
15739 \begin_layout Plain Layout
15745 means the (hardcoded) label string depends on the kind of float: It is
15746 hardcoded to be `FloatType N', where N is the value of the counter associated
15748 For the case that a caption is inserted outside of a float the
15749 \begin_inset Flex Code
15752 \begin_layout Plain Layout
15759 \begin_inset Quotes eld
15763 \begin_inset Quotes erd
15769 \begin_layout Description
15770 \begin_inset Flex Code
15773 \begin_layout Plain Layout
15779 produces the usual sort of enumeration labels.
15780 The number type needs to be set in the
15785 \begin_inset CommandInset ref
15787 reference "subsec:Counters"
15794 \begin_layout Description
15795 \begin_inset Flex Code
15798 \begin_layout Plain Layout
15804 produces various bullets at the different levels.
15805 The bullet types displayed can be set via
15806 \begin_inset Flex Noun
15809 \begin_layout Plain Layout
15810 Document\SpecialChar menuseparator
15811 Settings\SpecialChar menuseparator
15820 \begin_layout Description
15821 \begin_inset Flex Code
15824 \begin_layout Plain Layout
15830 should be used only with
15831 \begin_inset Flex Code
15834 \begin_layout Plain Layout
15835 LatexType BibEnvironment
15844 \begin_layout Description
15845 \begin_inset Flex Code
15848 \begin_layout Plain Layout
15854 Note that this will completely override any prior
15855 \begin_inset Flex Code
15858 \begin_layout Plain Layout
15864 declaration for this style.
15866 \begin_inset Quotes eld
15870 \begin_inset Flex Code
15873 \begin_layout Plain Layout
15880 \begin_inset Quotes erd
15885 \begin_inset CommandInset ref
15887 reference "subsec:I18n"
15891 for details on its use.
15894 \begin_layout Description
15895 \begin_inset Flex Code
15898 \begin_layout Plain Layout
15905 \begin_inset Flex Code
15908 \begin_layout Plain Layout
15914 ] The name of the corresponding \SpecialChar LaTeX
15916 Either the environment or command name.
15919 \begin_layout Description
15920 \begin_inset Flex Code
15923 \begin_layout Plain Layout
15930 \begin_inset Flex Code
15933 \begin_layout Plain Layout
15939 ] An optional parameter for the corresponding
15940 \begin_inset Flex Code
15943 \begin_layout Plain Layout
15950 This parameter cannot be changed from within \SpecialChar LyX
15952 \begin_inset Flex Code
15955 \begin_layout Plain Layout
15961 for customizable parameters).
15962 This will be output as is after all \SpecialChar LaTeX
15964 \begin_inset Flex Code
15967 \begin_layout Plain Layout
15976 \begin_layout Description
15977 \begin_inset Flex Code
15980 \begin_layout Plain Layout
15987 \begin_inset Flex Code
15990 \begin_layout Plain Layout
15995 , Command, Environment, Item_Environment,
15996 \begin_inset Newline newline
15999 List_Environment, Bib_Environment
16004 ] How the style should be translated into \SpecialChar LaTeX
16009 \begin_layout Plain Layout
16010 \begin_inset Flex Code
16013 \begin_layout Plain Layout
16019 is perhaps a bit misleading, since these rules apply to SGML classes, too.
16020 Visit the SGML class files for specific examples.
16029 \begin_layout Description
16030 \begin_inset Flex Code
16033 \begin_layout Plain Layout
16039 means nothing special.
16042 \begin_layout Description
16043 \begin_inset Flex Code
16046 \begin_layout Plain Layout
16053 \begin_inset Flex Code
16056 \begin_layout Plain Layout
16063 {\SpecialChar ldots
16072 \begin_layout Description
16073 \begin_inset Flex Code
16076 \begin_layout Plain Layout
16083 \begin_inset Flex Code
16086 \begin_layout Plain Layout
16093 }\SpecialChar ldots
16109 \begin_layout Description
16110 \begin_inset Flex Code
16113 \begin_layout Plain Layout
16120 \begin_inset Flex Code
16123 \begin_layout Plain Layout
16130 \begin_inset Flex Code
16133 \begin_layout Plain Layout
16141 is generated for each paragraph of this environment.
16145 \begin_layout Description
16146 \begin_inset Flex Code
16149 \begin_layout Plain Layout
16156 \begin_inset Flex Code
16159 \begin_layout Plain Layout
16166 \begin_inset Newline newline
16170 \begin_inset Flex Code
16173 \begin_layout Plain Layout
16179 is passed as an argument to the environment.
16180 \begin_inset Newline newline
16184 \begin_inset Flex Code
16187 \begin_layout Plain Layout
16193 can be defined in the
16194 \begin_inset Flex Noun
16197 \begin_layout Plain Layout
16198 Edit\SpecialChar menuseparator
16200 \begin_inset space ~
16211 \begin_layout Description
16212 \begin_inset Flex Code
16215 \begin_layout Plain Layout
16222 \begin_inset Flex Code
16225 \begin_layout Plain Layout
16231 but adds the necessary mandatory argument (the longest label) to the begin
16232 statement of the bibliography environment:
16233 \begin_inset Newline newline
16237 \begin_inset Flex Code
16240 \begin_layout Plain Layout
16243 begin{thebibliography}{99}
16249 It is therefore only useful for bibliography environments.
16250 The default longest label
16251 \begin_inset Quotes eld
16255 \begin_inset Quotes erd
16258 can be changed by the user in the paragraph settings of a bibliography
16262 \begin_layout Standard
16263 Putting the last few things together, the \SpecialChar LaTeX
16264 output will be either:
16267 \begin_layout LyX-Code
16270 LatexName[LatexParam]{\SpecialChar ldots
16274 \begin_layout Standard
16278 \begin_layout LyX-Code
16281 begin{LatexName}[LatexParam] \SpecialChar ldots
16287 \begin_layout Standard
16288 depending upon the \SpecialChar LaTeX
16293 \begin_layout Description
16294 \begin_inset Flex Code
16297 \begin_layout Plain Layout
16304 \begin_inset Flex Code
16307 \begin_layout Plain Layout
16313 ] A string that is put at the beginning of the style content.
16314 A line break in the output can be indicated by
16315 \begin_inset Flex Code
16318 \begin_layout Plain Layout
16327 \begin_layout Description
16328 \begin_inset Flex Code
16331 \begin_layout Plain Layout
16338 \begin_inset Flex Code
16341 \begin_layout Plain Layout
16347 ] If you put styles into environments, the different
16348 \begin_inset Flex Code
16351 \begin_layout Plain Layout
16357 are not simply added, but added with a factor
16358 \begin_inset Formula $\frac{4}{\mathrm{depth}+4}$
16362 Note that this parameter is also used when
16363 \begin_inset Flex Code
16366 \begin_layout Plain Layout
16373 \begin_inset Flex Code
16376 \begin_layout Plain Layout
16383 \begin_inset Flex Code
16386 \begin_layout Plain Layout
16393 Then it is added to the manual or dynamic margin.
16394 \begin_inset Newline newline
16398 \begin_inset Quotes eld
16402 \begin_inset Flex Code
16405 \begin_layout Plain Layout
16412 \begin_inset Quotes erd
16415 means that the paragraph is indented with the width of
16416 \begin_inset Quotes eld
16420 \begin_inset Flex Code
16423 \begin_layout Plain Layout
16430 \begin_inset Quotes erd
16433 in the normal font.
16434 You can get a negative width by prefixing the string with
16435 \begin_inset Quotes eld
16439 \begin_inset Flex Code
16442 \begin_layout Plain Layout
16449 \begin_inset Quotes erd
16453 This way was chosen so that the look is the same with each used screen
16457 \begin_layout Description
16458 \begin_inset Flex Code
16461 \begin_layout Plain Layout
16468 \begin_inset Flex Code
16471 \begin_layout Plain Layout
16476 , Manual, Dynamic, First_Dynamic, Right_Address_Box
16482 \begin_inset Newline newline
16485 The kind of margin that the style has on the left side.
16489 \begin_layout Description
16490 \begin_inset Flex Code
16493 \begin_layout Plain Layout
16499 just means a fixed margin.
16502 \begin_layout Description
16503 \begin_inset Flex Code
16506 \begin_layout Plain Layout
16512 means that the left margin depends on the string entered in the
16513 \begin_inset Flex Noun
16516 \begin_layout Plain Layout
16517 Edit\SpecialChar menuseparator
16519 \begin_inset space ~
16528 This is used to typeset nice lists without tabulators.
16531 \begin_layout Description
16532 \begin_inset Flex Code
16535 \begin_layout Plain Layout
16541 means that the margin depends on the size of the label.
16542 This is used for automatic enumerated headlines.
16543 It is obvious that the headline
16544 \begin_inset Quotes eld
16547 5.4.3.2.1 Very long headline
16548 \begin_inset Quotes erd
16551 must have a wider left margin (as wide as
16552 \begin_inset Quotes eld
16556 \begin_inset Quotes erd
16559 plus the space) than
16560 \begin_inset Quotes eld
16563 3.2 Very long headline
16564 \begin_inset Quotes erd
16568 \begin_inset Quotes eld
16572 \begin_inset Quotes erd
16575 are not able to do this.
16578 \begin_layout Description
16579 \begin_inset Flex Code
16582 \begin_layout Plain Layout
16588 is similar, but only the very first row of the paragraph is dynamic, while
16589 the others are static; this is used, for example, for descriptions.
16592 \begin_layout Description
16593 \begin_inset Flex Code
16596 \begin_layout Plain Layout
16602 means the margin is chosen in a way that the longest row of this paragraph
16603 fits to the right margin.
16604 This is used to typeset an address on the right edge of the page.
16608 \begin_layout Description
16609 \begin_inset Flex Code
16612 \begin_layout Plain Layout
16619 \begin_inset Flex Code
16622 \begin_layout Plain Layout
16631 \begin_inset space \thinspace{}
16635 \begin_inset Flex Code
16638 \begin_layout Plain Layout
16644 ] Whether fragile commands in this style should be
16645 \begin_inset Flex Code
16648 \begin_layout Plain Layout
16661 whether this command should itself be protected.)
16662 \change_inserted -712698321 1523696949
16666 \begin_layout Description
16668 \change_inserted -712698321 1552395557
16669 \begin_inset Flex Code
16672 \begin_layout Plain Layout
16674 \change_inserted -712698321 1523696950
16683 \begin_inset Flex Code
16686 \begin_layout Plain Layout
16688 \change_inserted -712698321 1523696950
16699 \begin_inset space \thinspace{}
16703 \begin_inset Flex Code
16706 \begin_layout Plain Layout
16708 \change_inserted -712698321 1523696950
16716 ] This causes macros that contain this layout to be protected with
16717 \begin_inset Flex Code
16720 \begin_layout Plain Layout
16722 \change_inserted -712698321 1523696950
16737 ) if necessary and thus allows (some) verbatim stuff in macros.
16740 \begin_layout Description
16742 \change_inserted -712698321 1552395844
16743 \begin_inset Flex Code
16746 \begin_layout Plain Layout
16748 \change_inserted -712698321 1552395561
16757 \begin_inset Flex Code
16760 \begin_layout Plain Layout
16762 \change_inserted -712698321 1552395557
16773 \begin_inset space \thinspace{}
16777 \begin_inset Flex Code
16780 \begin_layout Plain Layout
16782 \change_inserted -712698321 1552395557
16790 ] Whether specific commands in this style (such as
16791 \begin_inset Flex Code
16794 \begin_layout Plain Layout
16796 \change_inserted -712698321 1552395655
16807 \begin_inset Flex Code
16810 \begin_layout Plain Layout
16812 \change_inserted -712698321 1552395661
16822 ) should be protected in an
16823 \begin_inset Flex Code
16826 \begin_layout Plain Layout
16828 \change_inserted -712698321 1552395631
16839 This is particularly needed for styles that draw on
16847 commands which parse their content in complex ways.
16852 \begin_layout Description
16853 \begin_inset Flex Code
16856 \begin_layout Plain Layout
16863 \begin_inset Flex Code
16866 \begin_layout Plain Layout
16873 \begin_inset space \thinspace{}
16877 \begin_inset Flex Code
16880 \begin_layout Plain Layout
16888 ] Whether newlines are translated into \SpecialChar LaTeX
16890 \begin_inset Flex Code
16893 \begin_layout Plain Layout
16904 The translation can be switched off to allow more comfortable \SpecialChar LaTeX
16906 inside \SpecialChar LyX
16910 \begin_layout Description
16911 \begin_inset Flex Code
16914 \begin_layout Plain Layout
16921 \begin_inset Flex Code
16924 \begin_layout Plain Layout
16933 \begin_inset space \thinspace{}
16937 \begin_inset Flex Code
16940 \begin_layout Plain Layout
16946 ] If set to true, and if
16947 \begin_inset Flex Code
16950 \begin_layout Plain Layout
16957 \begin_inset Flex Code
16960 \begin_layout Plain Layout
16966 ) paragraphs are being indented, then the indentation of such a paragraph
16967 following one of this type will be suppressed.
16968 (So this will not affect the display of non-default paragraphs.)
16971 \begin_layout Description
16972 \begin_inset Flex Code
16975 \begin_layout Plain Layout
16982 \begin_inset Flex Code
16985 \begin_layout Plain Layout
16991 ] Name of a style that has replaced this style.
16992 This is used to rename a style, while keeping backward compatibility.
16995 \begin_layout Description
16996 \begin_inset Flex Code
16999 \begin_layout Plain Layout
17006 \begin_inset Flex Code
17009 \begin_layout Plain Layout
17016 \begin_inset space \thinspace{}
17020 \begin_inset Flex Code
17023 \begin_layout Plain Layout
17029 ] Determines whether consecutive paragraphs of the same type are treated
17030 as belonging together.
17031 This has the effect that the
17032 \begin_inset Flex Code
17035 \begin_layout Plain Layout
17041 is only printed once before such a group.
17042 By default, this is true for
17043 \begin_inset Flex Code
17046 \begin_layout Plain Layout
17053 \begin_inset Flex Code
17056 \begin_layout Plain Layout
17063 \begin_inset Flex Code
17066 \begin_layout Plain Layout
17072 and false for all other types.
17075 \begin_layout Description
17076 \begin_inset Flex Code
17079 \begin_layout Plain Layout
17086 \begin_inset Flex Code
17089 \begin_layout Plain Layout
17098 \begin_inset space \thinspace{}
17102 \begin_inset Flex Code
17105 \begin_layout Plain Layout
17111 ] Indicates that paragraphs will not be separated by an empty line in \SpecialChar LaTeX
17113 but only by a line break; together with
17114 \begin_inset Flex Code
17117 \begin_layout Plain Layout
17123 , this allows to emulate a plain text editor (like the ERT inset).
17126 \begin_layout Description
17127 \begin_inset Flex Code
17130 \begin_layout Plain Layout
17137 \begin_inset Flex Code
17140 \begin_layout Plain Layout
17146 ] The indent of the very first line of a paragraph.
17148 \begin_inset Newline newline
17152 \begin_inset Flex Code
17155 \begin_layout Plain Layout
17161 will be fixed for a certain style.
17162 The exception is the default style, since the indentation for these paragraphs
17163 can be prohibited with
17164 \begin_inset Flex Code
17167 \begin_layout Plain Layout
17175 \begin_inset Flex Code
17178 \begin_layout Plain Layout
17184 style paragraphs inside environments use the
17185 \begin_inset Flex Code
17188 \begin_layout Plain Layout
17194 of the environment, not their native one.
17196 \begin_inset Flex Code
17199 \begin_layout Plain Layout
17205 paragraphs inside an enumeration are not indented.
17208 \begin_layout Description
17209 \begin_inset Flex Code
17212 \begin_layout Plain Layout
17219 \begin_inset Flex Code
17222 \begin_layout Plain Layout
17228 ] The vertical space between two paragraphs of this style.
17231 \begin_layout Description
17232 \begin_inset Flex Code
17235 \begin_layout Plain Layout
17242 \begin_inset Flex Code
17245 \begin_layout Plain Layout
17252 allows the user to choose either
17253 \begin_inset Quotes eld
17257 \begin_inset Quotes erd
17261 \begin_inset Quotes eld
17265 \begin_inset Quotes erd
17268 to separate paragraphs.
17270 \begin_inset Quotes eld
17274 \begin_inset Quotes erd
17278 \begin_inset Flex Code
17281 \begin_layout Plain Layout
17289 \begin_inset Quotes eld
17293 \begin_inset Quotes erd
17297 \begin_inset Flex Code
17300 \begin_layout Plain Layout
17306 is ignored and all paragraphs are separated by the
17307 \begin_inset Flex Code
17310 \begin_layout Plain Layout
17317 The vertical space is calculated with
17318 \begin_inset Flex Code
17321 \begin_layout Plain Layout
17323 \begin_inset space ~
17332 \begin_inset Flex Code
17335 \begin_layout Plain Layout
17341 is the height of a row with the normal font.
17342 This way, the look stays the same with different screen fonts.
17345 \begin_layout Description
17346 \begin_inset Flex Code
17349 \begin_layout Plain Layout
17356 \begin_inset Flex Code
17359 \begin_layout Plain Layout
17368 \begin_inset space \thinspace{}
17372 \begin_inset Flex Code
17375 \begin_layout Plain Layout
17381 ] Whether the contents of this paragraph should be output in raw form, meaning
17382 without special translations that \SpecialChar LaTeX
17386 \begin_layout Description
17387 \begin_inset Flex Code
17390 \begin_layout Plain Layout
17397 \begin_inset Flex Code
17400 \begin_layout Plain Layout
17410 Defines individual characters that should be output in raw form, meaning
17411 without special translations that \SpecialChar LaTeX
17415 \begin_layout Description
17416 \begin_inset Flex Code
17419 \begin_layout Plain Layout
17425 Information to be included in the \SpecialChar LaTeX
17426 preamble when this style is used.
17427 Used to define macros, load packages, etc., required by this particular
17430 \begin_inset Quotes eld
17434 \begin_inset Flex Code
17437 \begin_layout Plain Layout
17444 \begin_inset Quotes erd
17450 \begin_layout Description
17451 \begin_inset Flex Code
17454 \begin_layout Plain Layout
17461 \begin_inset Flex Code
17464 \begin_layout Plain Layout
17470 ] The prefix to use when creating labels referring to paragraphs of this
17472 This allows the use of formatted references.
17475 \begin_layout Description
17476 \begin_inset Flex Code
17479 \begin_layout Plain Layout
17486 \begin_inset Flex Code
17489 \begin_layout Plain Layout
17495 ] Whether the style requires the feature
17496 \begin_inset Flex Code
17499 \begin_layout Plain Layout
17506 \begin_inset CommandInset ref
17508 reference "chap:List-of-functions"
17512 for the list of features).
17513 If you require a package with specific options, you can additionally use
17515 \begin_inset Flex Code
17518 \begin_layout Plain Layout
17524 as a general text class parameter (see
17525 \begin_inset CommandInset ref
17527 reference "subsec:General-text-class"
17534 \begin_layout Description
17535 \begin_inset Flex Code
17538 \begin_layout Plain Layout
17545 \begin_inset Flex Code
17548 \begin_layout Plain Layout
17557 \begin_inset Flex Code
17560 \begin_layout Plain Layout
17566 ] Resets the \SpecialChar LaTeX
17567 arguments of this style (as defined via the
17568 \begin_inset Flex Code
17571 \begin_layout Plain Layout
17578 This is useful if you have copied a style via
17579 \begin_inset Flex Code
17582 \begin_layout Plain Layout
17588 , but you do not want to inherit its (required and optional) arguments.
17591 \begin_layout Description
17592 \begin_inset Flex Code
17595 \begin_layout Plain Layout
17602 \begin_inset Flex Code
17605 \begin_layout Plain Layout
17614 \begin_inset Flex Code
17617 \begin_layout Plain Layout
17623 ] Resumes a counter that is usually reset at each new sequence of layouts.
17624 This is currently only useful when
17625 \begin_inset Flex Code
17628 \begin_layout Plain Layout
17635 \begin_inset Flex Code
17638 \begin_layout Plain Layout
17647 \begin_layout Description
17648 \begin_inset Flex Code
17651 \begin_layout Plain Layout
17658 \begin_inset Flex Code
17661 \begin_layout Plain Layout
17667 ] A string that is put at the end of the layout content.
17668 A line break in the output can be indicated by
17669 \begin_inset Flex Code
17672 \begin_layout Plain Layout
17681 \begin_layout Description
17682 \begin_inset Flex Code
17685 \begin_layout Plain Layout
17692 \begin_inset Flex Code
17695 \begin_layout Plain Layout
17702 \begin_inset Flex Code
17705 \begin_layout Plain Layout
17714 \begin_layout Description
17715 \begin_inset Flex Code
17718 \begin_layout Plain Layout
17725 \begin_inset Flex Code
17728 \begin_layout Plain Layout
17737 \begin_inset Flex Code
17740 \begin_layout Plain Layout
17747 \begin_inset Flex Code
17750 \begin_layout Plain Layout
17757 \begin_inset Flex Code
17760 \begin_layout Plain Layout
17762 \begin_inset space ~
17770 ] This defines what the default spacing should be in the style.
17772 \begin_inset Flex Code
17775 \begin_layout Plain Layout
17782 \begin_inset Flex Code
17785 \begin_layout Plain Layout
17792 \begin_inset Flex Code
17795 \begin_layout Plain Layout
17801 correspond respectively to a multiplier value of 1, 1.25 and 1.667.
17802 If you specify the argument
17803 \begin_inset Flex Code
17806 \begin_layout Plain Layout
17812 , then you must also provide a value argument which will be the actual multiplie
17814 Note that, contrary to other parameters,
17815 \begin_inset Flex Code
17818 \begin_layout Plain Layout
17824 implies the generation of specific \SpecialChar LaTeX
17825 code, using the \SpecialChar LaTeX
17829 \begin_inset Flex Code
17832 \begin_layout Plain Layout
17841 \begin_layout Description
17842 \begin_inset Flex Code
17845 \begin_layout Plain Layout
17852 \begin_inset Flex Code
17855 \begin_layout Plain Layout
17862 \begin_inset space \thinspace{}
17866 \begin_inset Flex Code
17869 \begin_layout Plain Layout
17877 ] Allow spell-checking paragraphs of this style.
17881 \begin_layout Description
17882 \begin_inset Flex Code
17885 \begin_layout Plain Layout
17887 \change_deleted 731793113 1604355211
17889 \change_inserted 731793113 1604355212
17898 \begin_inset Flex Code
17901 \begin_layout Plain Layout
17910 \begin_inset Flex Code
17913 \begin_layout Plain Layout
17920 \change_deleted 731793113 1604355214
17922 \change_inserted 731793113 1604355216
17925 counter of a given counter at the beginning of a new sequence of layouts.
17926 This is currently only useful when
17927 \begin_inset Flex Code
17930 \begin_layout Plain Layout
17937 \begin_inset Flex Code
17940 \begin_layout Plain Layout
17949 \begin_layout Description
17950 \begin_inset Flex Code
17953 \begin_layout Plain Layout
17959 The font used for the text body .
17961 \begin_inset CommandInset ref
17963 reference "subsec:Font-description"
17970 \begin_layout Description
17971 \begin_inset Flex Code
17974 \begin_layout Plain Layout
17983 \begin_inset Flex Code
17986 \begin_layout Plain Layout
17996 The level of the style in the table of contents.
17997 This is used for automatic numbering of section headings.
18000 \begin_layout Description
18001 \begin_inset Flex Code
18004 \begin_layout Plain Layout
18013 \begin_inset Flex Code
18016 \begin_layout Plain Layout
18027 \begin_inset Flex Code
18030 \begin_layout Plain Layout
18037 \begin_inset Flex Code
18040 \begin_layout Plain Layout
18046 ] This tag determines whether the first line indentation of this paragraph
18047 can be toggled via the Paragraph settings dialog.
18051 \begin_inset Flex Code
18054 \begin_layout Plain Layout
18064 is set, indentation can be toggled if the document settings use
18065 \begin_inset Quotes eld
18069 \begin_inset Quotes erd
18072 paragraph style, with
18073 \begin_inset Flex Code
18076 \begin_layout Plain Layout
18082 , indentation can always be toggled, notwithstanding the document settings,
18084 \begin_inset Flex Code
18087 \begin_layout Plain Layout
18093 , indentation can never be toggled.
18096 \begin_layout Description
18097 \begin_inset Flex Code
18100 \begin_layout Plain Layout
18107 \begin_inset Flex Code
18110 \begin_layout Plain Layout
18116 ] The vertical space with which the very first of a chain of paragraphs
18117 with this style is separated from the previous paragraph.
18118 If the previous paragraph has another style, the separations are not simply
18119 added, but the maximum is taken.
18122 \begin_layout Subsection
18123 \begin_inset CommandInset label
18129 Internationalization of Paragraph Styles
18132 \begin_layout Standard
18134 has long supported internationalization of layout information, but, until
18135 version 2.0, this applied only to the user interface and not to, say, PDF
18137 Thus, French authors were forced to resort to ugly hacks if they wanted
18142 1' instead of `Theorem 1'.
18143 Thanks to Georg Baum, that is no longer the case.
18146 \begin_layout Standard
18148 \begin_inset Flex Code
18151 \begin_layout Plain Layout
18157 defines text that is to appear in the typeset document, it may use
18158 \begin_inset Flex Code
18161 \begin_layout Plain Layout
18168 \begin_inset Flex Code
18171 \begin_layout Plain Layout
18177 to support non-English and even multi-language documents correctly.
18178 The following excerpt (from the
18179 \begin_inset Flex Code
18182 \begin_layout Plain Layout
18188 file) shows how this works:
18191 \begin_layout LyX-Code
18196 \begin_layout LyX-Code
18199 theoremstyle{remark}
18202 \begin_layout LyX-Code
18205 newtheorem{claim}[thm]{
18212 \begin_layout LyX-Code
18216 \begin_layout LyX-Code
18220 \begin_layout LyX-Code
18225 claimname}{_(Claim)}
18228 \begin_layout LyX-Code
18232 \begin_layout LyX-Code
18236 \begin_layout LyX-Code
18245 claimname}{_(Claim)}}
18248 \begin_layout LyX-Code
18253 \begin_layout Standard
18254 In principle, any legal \SpecialChar LaTeX
18256 \begin_inset Flex Code
18259 \begin_layout Plain Layout
18266 \begin_inset Flex Code
18269 \begin_layout Plain Layout
18275 tags, but in practice they will typically look as they do here.
18276 The key to correct translation of the typeset text is the definition of
18277 the \SpecialChar LaTeX
18279 \begin_inset Flex Code
18282 \begin_layout Plain Layout
18291 \begin_inset Flex Code
18294 \begin_layout Plain Layout
18306 \begin_layout Standard
18308 \begin_inset Flex Code
18311 \begin_layout Plain Layout
18317 tag provides for internationalization based upon the overall language of
18319 The contents of the tag will be included in the preamble, just as with
18321 \begin_inset Flex Code
18324 \begin_layout Plain Layout
18331 What makes it special is the use of the
18332 \begin_inset Quotes eld
18336 \begin_inset Quotes erd
18340 \begin_inset Flex Code
18343 \begin_layout Plain Layout
18349 , which will be replaced, when \SpecialChar LyX
18350 produces \SpecialChar LaTeX
18351 output, with the translation of
18352 its argument into the document language.
18355 \begin_layout Standard
18357 \begin_inset Flex Code
18360 \begin_layout Plain Layout
18366 tag is more complex, since it is meant to provide support for multi-language
18367 documents and so offers an interface to the
18368 \begin_inset Flex Code
18371 \begin_layout Plain Layout
18378 Its contents will be added to the preamble once for each language that
18379 appears in the document.
18380 In this case, the argument to
18381 \begin_inset Flex Code
18384 \begin_layout Plain Layout
18390 will be replaced with its translation into the language in question; the
18392 \begin_inset Flex Code
18395 \begin_layout Plain Layout
18401 is replaced by the language name (as used by the babel package).
18404 \begin_layout Standard
18405 A German document that also included a French section would thus have the
18406 following in the preamble:
18409 \begin_layout LyX-Code
18418 claimname}{Affirmation}}
18419 \begin_inset Newline newline
18430 claimname}{Behauptung}}
18431 \begin_inset Newline newline
18438 claimname}{Behauptung}
18441 \begin_layout Standard
18444 \begin_inset Flex Code
18447 \begin_layout Plain Layout
18453 will then conspire to produce the correct text in the output.
18456 \begin_layout Standard
18457 One important point to note here is that the translations are provided by
18459 itself, through the file
18460 \begin_inset Flex Code
18463 \begin_layout Plain Layout
18470 This means, in effect, that
18471 \begin_inset Flex Code
18474 \begin_layout Plain Layout
18481 \begin_inset Flex Code
18484 \begin_layout Plain Layout
18490 are really only of use in layout files that are provided with \SpecialChar LyX
18492 entered in user-created layout files will not be seen by \SpecialChar LyX
18493 's internationalizatio
18494 n routines unless the
18495 \begin_inset Flex Code
18498 \begin_layout Plain Layout
18504 file is modified accordingly.
18505 That said, however, any layout created with the intention that it will
18506 be included with \SpecialChar LyX
18507 should use these tags where appropriate.
18508 Please note that the paragraph style translations provided by \SpecialChar LyX
18510 change with a minor update (e.
18511 \begin_inset space \thinspace{}
18515 \begin_inset space \space{}
18518 from version 2.1.x to 2.1.y).
18519 It is however quite likely that a major update (e.
18520 \begin_inset space \thinspace{}
18524 \begin_inset space \space{}
18527 from 2.0.x to 2.1.0) will introduce new translations or corrections.
18530 \begin_layout Subsection
18532 \begin_inset CommandInset label
18534 name "subsec:Floats"
18541 \begin_layout Standard
18542 It is necessary to define the floats (
18543 \begin_inset Flex Noun
18546 \begin_layout Plain Layout
18553 \begin_inset Flex Noun
18556 \begin_layout Plain Layout
18562 , \SpecialChar ldots
18563 ) in the text class itself.
18564 Standard floats are included in the file
18565 \begin_inset Flex Code
18568 \begin_layout Plain Layout
18574 , so you may have to do no more than add
18577 \begin_layout LyX-Code
18578 Input stdfloats.inc
18581 \begin_layout Standard
18582 to your layout file.
18583 If you want to implement a text class that proposes some other float types
18584 (like the AGU class bundled with \SpecialChar LyX
18585 ), the information below will hopefully
18589 \begin_layout Description
18590 \begin_inset Flex Code
18593 \begin_layout Plain Layout
18600 \begin_inset Flex Code
18603 \begin_layout Plain Layout
18609 =!htbpH] Allowed placement options for this float type.
18610 The value is a string of placement characters.
18611 Possible characters include:
18616 \begin_inset Quotes eld
18620 \begin_inset Quotes erd
18628 \begin_inset Quotes eld
18632 \begin_inset Quotes erd
18640 \begin_inset Quotes eld
18644 \begin_inset Quotes erd
18652 \begin_inset Quotes eld
18656 \begin_inset Quotes erd
18664 \begin_inset Quotes eld
18668 \begin_inset Quotes erd
18676 \begin_inset Quotes eld
18680 \begin_inset Quotes erd
18684 The order of the characters in the string does not matter.
18685 If no placement options are allowed, use the string
18692 \begin_layout Description
18693 \begin_inset Flex Code
18696 \begin_layout Plain Layout
18703 \begin_inset Flex Code
18706 \begin_layout Plain Layout
18715 \begin_inset space \thinspace{}
18721 \begin_inset Flex Code
18724 \begin_layout Plain Layout
18734 ] Defines whether the float allows to be rotated via the \SpecialChar LaTeX
18741 \begin_inset Flex Code
18744 \begin_layout Plain Layout
18750 if the float does not support this feature.
18753 \begin_layout Description
18754 \begin_inset Flex Code
18757 \begin_layout Plain Layout
18764 \begin_inset Flex Code
18767 \begin_layout Plain Layout
18776 \begin_inset space \thinspace{}
18782 \begin_inset Flex Code
18785 \begin_layout Plain Layout
18795 ] Defines whether the float has a starred variant that spans columns in
18796 a two column paragraph.
18798 \begin_inset Flex Code
18801 \begin_layout Plain Layout
18807 if the float does not support this feature.
18810 \begin_layout Description
18811 \begin_inset Flex Code
18814 \begin_layout Plain Layout
18821 \begin_inset Flex Code
18824 \begin_layout Plain Layout
18831 \begin_inset Quotes erd
18835 \begin_inset Quotes erd
18838 ] The file name extension of an auxiliary file for the list of figures (or
18841 writes the captions to this file.
18844 \begin_layout Description
18845 \begin_inset Flex Code
18848 \begin_layout Plain Layout
18855 \begin_inset Flex Code
18858 \begin_layout Plain Layout
18865 \begin_inset Quotes erd
18869 \begin_inset Quotes erd
18872 ] The string that will be used in the menus and also for the caption.
18873 This is translated to the current language if babel is used.
18876 \begin_layout Description
18877 \begin_inset Flex Code
18880 \begin_layout Plain Layout
18886 These tags control the XHTML output.
18888 \begin_inset CommandInset ref
18890 reference "sec:Tags-for-XHTML"
18897 \begin_layout Description
18898 \begin_inset Flex Code
18901 \begin_layout Plain Layout
18910 \begin_inset Flex Code
18913 \begin_layout Plain Layout
18922 \begin_inset space \thinspace{}
18926 \begin_inset Flex Code
18929 \begin_layout Plain Layout
18935 ] Indicates whether the float is already defined in the document class or
18936 if instead the \SpecialChar LaTeX
18938 \begin_inset Flex Code
18941 \begin_layout Plain Layout
18947 needs to be loaded to define it on-the-fly.
18949 \begin_inset Flex Code
18952 \begin_layout Plain Layout
18959 \begin_inset Flex Code
18962 \begin_layout Plain Layout
18969 It should be set to
18970 \begin_inset Flex Code
18973 \begin_layout Plain Layout
18979 if the float is already defined by the \SpecialChar LaTeX
18983 \begin_layout Description
18984 \begin_inset Flex Code
18987 \begin_layout Plain Layout
18994 \begin_inset Flex Code
18997 \begin_layout Plain Layout
19004 \begin_inset Quotes erd
19008 \begin_inset Quotes erd
19011 ] The command used to generate a list of floats of this type; the leading
19020 \begin_inset Flex Code
19023 \begin_layout Plain Layout
19029 is false, since there is no standard way to generate this command.
19031 \begin_inset Flex Code
19034 \begin_layout Plain Layout
19040 is true, since in that case there is a standard way to define the command.
19043 \begin_layout Description
19044 \begin_inset Flex Code
19047 \begin_layout Plain Layout
19054 \begin_inset Flex Code
19057 \begin_layout Plain Layout
19064 \begin_inset Quotes erd
19068 \begin_inset Quotes erd
19071 ] A title for a list of floats of this kind (list of figures, tables, or
19073 It is used for the screen label within \SpecialChar LyX
19074 , it is used by \SpecialChar LaTeX
19076 it is used as the title in the XHTML output.
19077 It will be translated to the document language.
19080 \begin_layout Description
19081 \begin_inset Flex Code
19084 \begin_layout Plain Layout
19091 \begin_inset Flex Code
19094 \begin_layout Plain Layout
19101 \begin_inset Quotes erd
19105 \begin_inset Quotes erd
19108 ] This (optional) argument determines whether floats of this class will
19109 be numbered within some sectional unit of the document.
19111 \begin_inset Flex Code
19114 \begin_layout Plain Layout
19121 \begin_inset Quotes eld
19125 \begin_inset Flex Code
19128 \begin_layout Plain Layout
19135 \begin_inset Quotes erd
19138 , the floats will be numbered within chapters.
19142 \begin_layout Description
19143 \begin_inset Flex Code
19146 \begin_layout Plain Layout
19153 \begin_inset Flex Code
19156 \begin_layout Plain Layout
19163 \begin_inset Quotes erd
19167 \begin_inset Quotes erd
19170 ] The default placement for the given class of floats.
19171 The string should be as in standard \SpecialChar LaTeX
19173 \begin_inset Flex Code
19176 \begin_layout Plain Layout
19183 \begin_inset Flex Code
19186 \begin_layout Plain Layout
19193 \begin_inset Flex Code
19196 \begin_layout Plain Layout
19203 \begin_inset Flex Code
19206 \begin_layout Plain Layout
19212 for top, bottom, page, and here, respectively.
19216 \begin_layout Plain Layout
19217 Note that the order of these letters in the string is irrelevant, like in
19224 On top of that there is a new type,
19225 \begin_inset Flex Code
19228 \begin_layout Plain Layout
19234 , which does not really correspond to a float, since it means: put it
19235 \begin_inset Quotes eld
19239 \begin_inset Quotes erd
19243 Note however that the
19244 \begin_inset Flex Code
19247 \begin_layout Plain Layout
19253 specifier is special and, because of implementation details, cannot be
19254 used in non-built in float types.
19255 If you do not understand what this means, just use
19256 \begin_inset Quotes eld
19260 \begin_inset Flex Code
19263 \begin_layout Plain Layout
19270 \begin_inset Quotes erd
19276 \begin_layout Description
19277 \begin_inset Flex Code
19280 \begin_layout Plain Layout
19287 \begin_inset Flex Code
19290 \begin_layout Plain Layout
19296 ] The prefix to use when creating labels referring to floats of this type.
19297 This allows the use of formatted references.
19298 Note that you can remove any
19299 \begin_inset Flex Code
19302 \begin_layout Plain Layout
19308 set by a copied style by using the special value
19309 \begin_inset Quotes eld
19313 \begin_inset Quotes erd
19316 , which must be all caps.
19317 \change_inserted -712698321 1565605014
19321 \begin_layout Description
19323 \change_inserted -712698321 1565605014
19324 \begin_inset Flex Code
19327 \begin_layout Plain Layout
19329 \change_inserted -712698321 1565605014
19338 \begin_inset Flex Code
19341 \begin_layout Plain Layout
19343 \change_inserted -712698321 1565605014
19351 ] As with paragraph styles, see
19352 \begin_inset CommandInset ref
19354 reference "subsec:Paragraph-Styles"
19363 \begin_layout Description
19364 \begin_inset Flex Code
19367 \begin_layout Plain Layout
19374 \begin_inset Flex Code
19377 \begin_layout Plain Layout
19384 \begin_inset Quotes erd
19388 \begin_inset Quotes erd
19391 ] The style used when defining the float using
19392 \begin_inset Flex Code
19395 \begin_layout Plain Layout
19406 \begin_layout Description
19407 \begin_inset Flex Code
19410 \begin_layout Plain Layout
19417 \begin_inset Flex Code
19420 \begin_layout Plain Layout
19427 \begin_inset Quotes erd
19431 \begin_inset Quotes erd
19435 \begin_inset Quotes eld
19439 \begin_inset Quotes erd
19442 of the new class of floats, like program or algorithm.
19443 After the appropriate
19444 \begin_inset Flex Code
19447 \begin_layout Plain Layout
19456 \begin_inset Flex Code
19459 \begin_layout Plain Layout
19468 \begin_inset Flex Code
19471 \begin_layout Plain Layout
19482 \begin_layout Description
19483 \begin_inset Flex Code
19486 \begin_layout Plain Layout
19493 \begin_inset Flex Code
19496 \begin_layout Plain Layout
19503 \begin_inset space \thinspace{}
19507 \begin_inset Flex Code
19510 \begin_layout Plain Layout
19518 ] Specifies whether this float is defined using the \SpecialChar LaTeX
19520 \begin_inset Flex Code
19523 \begin_layout Plain Layout
19529 , either by the class file, another package or on-the-fly by \SpecialChar LyX
19533 \begin_layout Standard
19534 Note that defining a float with type
19535 \begin_inset Flex Code
19538 \begin_layout Plain Layout
19546 automatically defines the corresponding counter with name
19547 \begin_inset Flex Code
19550 \begin_layout Plain Layout
19561 \begin_layout Subsection
19562 Flex insets and InsetLayout
19563 \begin_inset CommandInset label
19565 name "subsec:Flex-insets-and"
19572 \begin_layout Standard
19573 Flex insets come in
19574 \change_deleted 5863208 1594239511
19576 \change_inserted 5863208 1594239512
19582 \begin_layout Itemize
19584 \begin_inset Flex Code
19587 \begin_layout Plain Layout
19593 ): These define semantic markup corresponding to such \SpecialChar LaTeX
19595 \begin_inset Flex Code
19598 \begin_layout Plain Layout
19607 \begin_inset Flex Code
19610 \begin_layout Plain Layout
19621 \begin_layout Itemize
19623 \begin_inset Flex Code
19626 \begin_layout Plain Layout
19632 ): These can be used to define custom collapsible insets, similar to \SpecialChar TeX
19634 footnote, and the like.
19635 An obvious example is an endnote inset, which is defined in the
19636 \begin_inset Flex Code
19639 \begin_layout Plain Layout
19648 \begin_layout Itemize
19650 \change_deleted 5863208 1594239528
19652 \begin_inset Flex Code
19655 \begin_layout Plain Layout
19661 ): For use with DocBook classes.
19666 \begin_layout Standard
19667 Flex insets are defined using the
19668 \begin_inset Flex Code
19671 \begin_layout Plain Layout
19677 tag, which shall be explained in a moment.
19680 \begin_layout Standard
19682 \begin_inset Flex Code
19685 \begin_layout Plain Layout
19691 tag also serves another function: It can be used to customize the general
19692 layout of many different types of insets.
19694 \begin_inset Flex Code
19697 \begin_layout Plain Layout
19703 can be used to customize the layout parameters for footnotes, marginal
19704 notes, note insets, \SpecialChar TeX
19705 code (ERT) insets, branches, listings, indexes, boxes,
19706 tables, algorithms, URLs, and captions, as well as to define Flex insets.
19709 \begin_layout Standard
19711 \begin_inset Flex Code
19714 \begin_layout Plain Layout
19720 definition must begin with a line of the form:
19723 \begin_layout LyX-Code
19727 \begin_layout Standard
19729 \begin_inset Flex Code
19732 \begin_layout Plain Layout
19738 indicates the inset whose layout is being defined, and here there are four
19742 \begin_layout Enumerate
19743 The layout for a pre-existing inset is being modified.
19744 In this case, can be
19745 \begin_inset Flex Code
19748 \begin_layout Plain Layout
19754 any one of the following:
19755 \begin_inset Flex Code
19758 \begin_layout Plain Layout
19765 \begin_inset Flex Code
19768 \begin_layout Plain Layout
19775 \begin_inset Flex Code
19778 \begin_layout Plain Layout
19785 \begin_inset Flex Code
19788 \begin_layout Plain Layout
19795 \begin_inset Flex Code
19798 \begin_layout Plain Layout
19805 \begin_inset Flex Code
19808 \begin_layout Plain Layout
19815 \begin_inset Flex Code
19818 \begin_layout Plain Layout
19825 \begin_inset Flex Code
19828 \begin_layout Plain Layout
19835 \begin_inset Flex Code
19838 \begin_layout Plain Layout
19845 \begin_inset Flex Code
19848 \begin_layout Plain Layout
19855 \begin_inset Flex Code
19858 \begin_layout Plain Layout
19865 \begin_inset Flex Code
19868 \begin_layout Plain Layout
19875 \begin_inset Flex Code
19878 \begin_layout Plain Layout
19885 \begin_inset Flex Code
19888 \begin_layout Plain Layout
19895 \begin_inset Flex Code
19898 \begin_layout Plain Layout
19905 \begin_inset Flex Code
19908 \begin_layout Plain Layout
19915 \begin_inset Flex Code
19918 \begin_layout Plain Layout
19925 \begin_inset Flex Code
19928 \begin_layout Plain Layout
19935 \begin_inset Flex Code
19938 \begin_layout Plain Layout
19945 \begin_inset Flex Code
19948 \begin_layout Plain Layout
19957 \begin_layout Enumerate
19958 The layout for a Flex inset is being defined.
19960 \begin_inset Flex Code
19963 \begin_layout Plain Layout
19969 must be of the form
19970 \begin_inset Quotes eld
19974 \begin_inset Flex Code
19977 \begin_layout Plain Layout
19984 \begin_inset Quotes erd
19988 \begin_inset Flex Code
19991 \begin_layout Plain Layout
19997 may be any valid identifier not used by a pre-existing Flex inset.
19998 The identifier may include spaces, but in that case the whole thing must
19999 be wrapped in quotes.
20000 Note that the definition of a flex inset
20005 \begin_inset Flex Code
20008 \begin_layout Plain Layout
20014 entry, declaring which type of inset it defines.
20017 \begin_layout Enumerate
20018 The layout for user specific branch is being defined.
20020 \begin_inset Flex Code
20023 \begin_layout Plain Layout
20029 must be of the form
20030 \begin_inset Quotes eld
20034 \begin_inset Flex Code
20037 \begin_layout Plain Layout
20044 \begin_inset Quotes erd
20048 \begin_inset Flex Code
20051 \begin_layout Plain Layout
20057 may be any valid identifier of branch defined in user's document.
20058 The identifier may include spaces, but in that case the whole thing must
20059 be wrapped in quotes.
20060 The main purpose of this feature is to allow \SpecialChar LaTeX
20061 wrapping around specific
20062 branches as user needs.
20065 \begin_layout Enumerate
20066 The layout of a user (or class) specific caption is being defined.
20068 \begin_inset Flex Code
20071 \begin_layout Plain Layout
20077 must be of the form
20078 \begin_inset Quotes eld
20082 \begin_inset Flex Code
20085 \begin_layout Plain Layout
20092 \begin_inset Quotes erd
20096 \begin_inset Flex Code
20099 \begin_layout Plain Layout
20105 specifies the name of the caption as it appears in the menu.
20106 Have a look at the standard caption (
20107 \begin_inset Flex Code
20110 \begin_layout Plain Layout
20116 ), the specific captions of the KOMA-Script classes (
20117 \begin_inset Flex Code
20120 \begin_layout Plain Layout
20127 \begin_inset Flex Code
20130 \begin_layout Plain Layout
20139 \begin_inset space ~
20143 \begin_inset Newline linebreak
20149 \begin_inset Flex Code
20152 \begin_layout Plain Layout
20158 ) for applications.
20161 \begin_layout Standard
20163 \begin_inset Flex Code
20166 \begin_layout Plain Layout
20172 definition can contain the following entries:
20175 \begin_layout Description
20176 \begin_inset Flex Code
20179 \begin_layout Plain Layout
20186 \begin_inset Flex Code
20189 \begin_layout Plain Layout
20195 =""] This inset will appear in the table of contents of the given type.
20196 An empty string disables.
20197 See also the OutlinerName and the IsTocCaption commands.
20198 This is only implemented for Flex insets.
20202 \begin_layout Description
20203 \begin_inset Flex Code
20206 \begin_layout Plain Layout
20213 \begin_inset Flex Code
20216 \begin_layout Plain Layout
20222 ] Defines argument number of a command\SpecialChar breakableslash
20223 environment associated with the current
20225 The definition must end with
20226 \begin_inset Flex Code
20229 \begin_layout Plain Layout
20237 \change_inserted -584632292 1615846847
20239 \begin_inset CommandInset ref
20241 reference "subsec:Arguments"
20249 \change_deleted -584632292 1615846847
20251 \begin_inset CommandInset ref
20253 reference "subsec:Paragraph-Styles"
20260 \change_deleted -584632292 1615846902
20262 \change_inserted -584632292 1615846906
20268 \begin_layout Description
20269 \begin_inset Flex Code
20272 \begin_layout Plain Layout
20278 Preamble for changing language commands; see
20279 \begin_inset CommandInset ref
20281 reference "subsec:I18n"
20288 \begin_layout Description
20289 \begin_inset Flex Code
20292 \begin_layout Plain Layout
20299 \begin_inset Flex Code
20302 \begin_layout Plain Layout
20308 ] The color for the inset's background.
20310 \begin_inset CommandInset ref
20312 reference "chap:Names-of-colors"
20316 for a list of the available color names.
20319 \begin_layout Description
20320 \begin_inset Flex Code
20323 \begin_layout Plain Layout
20330 \begin_inset Flex Code
20333 \begin_layout Plain Layout
20342 \begin_inset space \thinspace{}
20346 \begin_inset Flex Code
20349 \begin_layout Plain Layout
20355 ] Whether to use the content of the inset as the label, when the inset is
20360 \begin_layout Description
20361 \begin_inset Flex Code
20364 \begin_layout Plain Layout
20371 \begin_inset Flex Code
20374 \begin_layout Plain Layout
20380 ] As with paragraph styles, see
20381 \begin_inset CommandInset ref
20383 reference "subsec:Paragraph-Styles"
20388 Note that you need to specify the complete type, e.
20389 \begin_inset space \thinspace{}
20393 \begin_inset space ~
20397 \begin_inset Flex Code
20400 \begin_layout Plain Layout
20401 CopyStyle Flex:<name>
20409 \begin_layout Description
20410 \begin_inset Flex Code
20413 \begin_layout Plain Layout
20420 \begin_inset Flex Code
20423 \begin_layout Plain Layout
20432 \begin_inset space \thinspace{}
20436 \begin_inset Flex Code
20439 \begin_layout Plain Layout
20445 ] Indicates whether the user may employ the Paragraph Settings dialog to
20446 customize the paragraph.
20449 \begin_layout Description
20450 \begin_inset Flex Code
20453 \begin_layout Plain Layout
20460 \begin_inset Flex Code
20463 \begin_layout Plain Layout
20470 \begin_inset Flex Code
20473 \begin_layout Plain Layout
20480 \begin_inset Flex Code
20483 \begin_layout Plain Layout
20489 , describing the rendering style used for the inset's frame and buttons.
20490 Footnotes generally use
20491 \begin_inset Flex Code
20494 \begin_layout Plain Layout
20500 , ERT insets generally
20501 \begin_inset Flex Code
20504 \begin_layout Plain Layout
20510 , and character styles
20511 \begin_inset Flex Code
20514 \begin_layout Plain Layout
20523 \begin_layout Description
20524 \begin_inset Flex Code
20527 \begin_layout Plain Layout
20534 \begin_inset Flex Code
20537 \begin_layout Plain Layout
20546 \begin_inset space \thinspace{}
20552 \begin_inset Flex Code
20555 \begin_layout Plain Layout
20564 \begin_inset Flex Code
20567 \begin_layout Plain Layout
20574 \begin_inset Flex Code
20577 \begin_layout Plain Layout
20584 Indicates whether the environment will stand on its own in the output or
20585 will appear inline with the surrounding text.
20586 If set to false, it is supposed that the \SpecialChar LaTeX
20587 environment ignores white space
20588 (including one newline character) after the
20589 \begin_inset Flex Code
20592 \begin_layout Plain Layout
20605 \begin_inset Flex Code
20608 \begin_layout Plain Layout
20622 \change_inserted 731793113 1538674858
20626 \begin_layout Description
20628 \change_inserted 731793113 1538674891
20629 \begin_inset Flex Code
20632 \begin_layout Plain Layout
20634 \change_inserted 731793113 1538674863
20646 ,1] Allow the contents of the inset to be edited externally (using whatever
20647 editor is defined for the document's output format).
20652 \begin_layout Description
20653 \begin_inset Flex Code
20656 \begin_layout Plain Layout
20662 Required at the end of the
20663 \begin_inset Flex Code
20666 \begin_layout Plain Layout
20675 \begin_layout Description
20676 \begin_inset Flex Code
20679 \begin_layout Plain Layout
20685 The font used for both the text body
20691 \begin_inset CommandInset ref
20693 reference "subsec:Font-description"
20698 Note that defining this font automatically defines the
20699 \begin_inset Flex Code
20702 \begin_layout Plain Layout
20708 to the same value, so define this first and define
20709 \begin_inset Flex Code
20712 \begin_layout Plain Layout
20718 later if you want them to be different.
20721 \begin_layout Description
20722 \begin_inset Flex Code
20725 \begin_layout Plain Layout
20726 FixedWidthPreambleEncoding
20732 \begin_inset Flex Code
20735 \begin_layout Plain Layout
20744 \begin_inset space \thinspace{}
20748 \begin_inset Flex Code
20751 \begin_layout Plain Layout
20757 ] Force a fixed width encoding for the translated contents of
20758 \begin_inset Flex Code
20761 \begin_layout Plain Layout
20768 \begin_inset Flex Code
20771 \begin_layout Plain Layout
20777 code generated by this layout.
20778 This is needed for special \SpecialChar LaTeX
20783 that do not work with variable width encodings such as
20788 This setting is ignored if fully Unicode aware \SpecialChar LaTeX
20789 backends such as Xe\SpecialChar TeX
20791 Lua\SpecialChar TeX
20795 \begin_layout Description
20796 \begin_inset Flex Code
20799 \begin_layout Plain Layout
20800 ForceLocalFontSwitch
20806 \begin_inset Flex Code
20809 \begin_layout Plain Layout
20818 \begin_inset space \thinspace{}
20822 \begin_inset Flex Code
20825 \begin_layout Plain Layout
20831 ] When using babel, always use a local font switch (
20832 \begin_inset Flex Code
20835 \begin_layout Plain Layout
20843 ), never a global one (such as
20844 \begin_inset Flex Code
20847 \begin_layout Plain Layout
20858 \begin_layout Description
20859 \begin_inset Flex Code
20862 \begin_layout Plain Layout
20869 \begin_inset Flex Code
20872 \begin_layout Plain Layout
20881 \begin_inset space \thinspace{}
20885 \begin_inset Flex Code
20888 \begin_layout Plain Layout
20895 \begin_inset Quotes eld
20899 \begin_inset Quotes erd
20902 language, leading to Left-to-Right (Latin) output, e.
20903 \begin_inset space \thinspace{}
20907 \begin_inset space \space{}
20910 in \SpecialChar TeX
20915 \begin_layout Description
20916 \begin_inset Flex Code
20919 \begin_layout Plain Layout
20926 \begin_inset Flex Code
20929 \begin_layout Plain Layout
20938 \begin_inset space \thinspace{}
20942 \begin_inset Flex Code
20945 \begin_layout Plain Layout
20951 ] Force a line break in the \SpecialChar LaTeX
20952 output before the inset starts and after the
20954 This assures the inset itself is output on its own lines, for parsing purposes.
20957 \begin_layout Description
20958 \begin_inset Flex Code
20961 \begin_layout Plain Layout
20968 \begin_inset Flex Code
20971 \begin_layout Plain Layout
20980 \begin_inset space \thinspace{}
20984 \begin_inset Flex Code
20987 \begin_layout Plain Layout
20993 ] Indicates whether the
20994 \begin_inset Flex Code
20997 \begin_layout Plain Layout
21003 should be used or, instead, the user can change the paragraph style used
21008 \begin_layout Description
21009 \begin_inset Flex Code
21012 \begin_layout Plain Layout
21019 \begin_inset Flex Code
21022 \begin_layout Plain Layout
21031 \begin_inset space \thinspace{}
21035 \begin_inset Flex Code
21038 \begin_layout Plain Layout
21044 ] As with paragraph styles, see
21045 \begin_inset CommandInset ref
21047 reference "subsec:Paragraph-Styles"
21054 \begin_layout Description
21055 \begin_inset Flex Code
21058 \begin_layout Plain Layout
21064 These tags control the XHTML output.
21066 \begin_inset CommandInset ref
21068 reference "sec:Tags-for-XHTML"
21075 \begin_layout Description
21076 \begin_inset Flex Code
21079 \begin_layout Plain Layout
21086 \begin_inset Flex Code
21089 \begin_layout Plain Layout
21098 \begin_inset space \thinspace{}
21102 \begin_inset Flex Code
21105 \begin_layout Plain Layout
21111 ] Whether to include the contents of this inset in the strings generated
21112 for the `Outline' pane for all table of contents, regardless of the AddToToc
21114 One would not, for example, want the content of a footnote in a section
21115 header to be included in the TOC displayed in the outline, but one would
21116 normally want the content of a character style displayed.
21117 Default is false: not to include.
21120 \begin_layout Description
21121 \begin_inset Flex Code
21124 \begin_layout Plain Layout
21131 \begin_inset Flex Code
21134 \begin_layout Plain Layout
21143 \begin_inset space \thinspace{}
21147 \begin_inset Flex Code
21150 \begin_layout Plain Layout
21156 ] If this is set to 1 and AddToToc is enabled, the inset adds a summary
21157 of its contents in its item in the table of contents.
21158 Otherwise, only the label appears.
21161 \begin_layout Description
21162 \begin_inset Flex Code
21165 \begin_layout Plain Layout
21174 \begin_inset Flex Code
21177 \begin_layout Plain Layout
21186 \begin_inset space \thinspace{}
21190 \begin_inset Flex Code
21193 \begin_layout Plain Layout
21199 ] As with paragraph styles, see
21200 \begin_inset CommandInset ref
21202 reference "subsec:Paragraph-Styles"
21209 \begin_layout Description
21210 \begin_inset Flex Code
21213 \begin_layout Plain Layout
21219 The font used for the label.
21221 \begin_inset CommandInset ref
21223 reference "subsec:Font-description"
21228 Note that this definition can never appear before
21229 \begin_inset Flex Code
21232 \begin_layout Plain Layout
21238 , lest it be ineffective.
21241 \begin_layout Description
21242 \begin_inset Flex Code
21245 \begin_layout Plain Layout
21252 \begin_inset Flex Code
21255 \begin_layout Plain Layout
21262 \begin_inset Quotes erd
21266 \begin_inset Quotes erd
21269 ] What will be displayed on the button or elsewhere as the inset label.
21271 \begin_inset Flex Code
21274 \begin_layout Plain Layout
21282 \begin_inset Flex Code
21285 \begin_layout Plain Layout
21291 ) modify this label on the fly.
21294 \begin_layout Description
21295 \begin_inset Flex Code
21298 \begin_layout Plain Layout
21304 Language dependent preamble; see
21305 \begin_inset CommandInset ref
21307 reference "subsec:I18n"
21314 \begin_layout Description
21315 \begin_inset Flex Code
21318 \begin_layout Plain Layout
21325 \begin_inset Flex Code
21328 \begin_layout Plain Layout
21334 ] The name of the corresponding \SpecialChar LaTeX
21336 Either the environment or command name.
21339 \begin_layout Description
21340 \begin_inset Flex Code
21343 \begin_layout Plain Layout
21350 \begin_inset Flex Code
21353 \begin_layout Plain Layout
21359 ] The optional parameter for the corresponding
21360 \begin_inset Flex Code
21363 \begin_layout Plain Layout
21369 stuff, including possible bracket pairs like
21370 \begin_inset Flex Code
21373 \begin_layout Plain Layout
21380 This parameter cannot be changed from within \SpecialChar LyX
21382 \begin_inset Flex Code
21385 \begin_layout Plain Layout
21391 for customizable parameters).
21392 It will be output as is after all \SpecialChar LaTeX
21394 \begin_inset Flex Code
21397 \begin_layout Plain Layout
21406 \begin_layout Description
21407 \begin_inset Flex Code
21410 \begin_layout Plain Layout
21417 \begin_inset Flex Code
21420 \begin_layout Plain Layout
21421 Command, Environment, None
21426 ] How the style should be translated into \SpecialChar LaTeX
21431 \begin_layout Plain Layout
21432 \begin_inset Flex Code
21435 \begin_layout Plain Layout
21441 is perhaps a bit misleading, since these rules apply to SGML classes too.
21442 Visit the SGML class files for specific examples.
21451 \begin_layout Description
21452 \begin_inset Flex Code
21455 \begin_layout Plain Layout
21461 means nothing special
21464 \begin_layout Description
21465 \begin_inset Flex Code
21468 \begin_layout Plain Layout
21475 \begin_inset Flex Code
21478 \begin_layout Plain Layout
21485 {\SpecialChar ldots
21494 \begin_layout Description
21495 \begin_inset Flex Code
21498 \begin_layout Plain Layout
21505 \begin_inset Flex Code
21508 \begin_layout Plain Layout
21515 }\SpecialChar ldots
21530 \begin_layout Standard
21531 Putting the last few things together, the \SpecialChar LaTeX
21532 output will be either:
21535 \begin_layout LyX-Code
21538 LatexName[LatexParam]{\SpecialChar ldots
21542 \begin_layout Standard
21546 \begin_layout LyX-Code
21549 begin{LatexName}[LatexParam] \SpecialChar ldots
21555 \begin_layout Standard
21556 depending upon the \SpecialChar LaTeX
21561 \begin_layout Description
21562 \begin_inset Flex Code
21565 \begin_layout Plain Layout
21572 \begin_inset Flex Code
21575 \begin_layout Plain Layout
21581 ] A string that is put at the beginning of the layout content.
21582 A line break in the output can be indicated by
21583 \begin_inset Flex Code
21586 \begin_layout Plain Layout
21595 \begin_layout Description
21596 \begin_inset Flex Code
21599 \begin_layout Plain Layout
21606 \begin_inset Flex Code
21609 \begin_layout Plain Layout
21616 \begin_inset Flex Code
21619 \begin_layout Plain Layout
21626 \change_deleted -584632292 1615846609
21628 \begin_inset Flex Code
21631 \begin_layout Plain Layout
21640 \begin_inset Flex Code
21643 \begin_layout Plain Layout
21649 (indicating a dummy definition ending definitions of charstyles, etc).
21650 This entry is required in and is only meaningful for Flex insets.
21651 Among other things, it determines on which menu this inset will appear.
21653 \begin_inset Flex Code
21656 \begin_layout Plain Layout
21663 \begin_inset Flex Code
21666 \begin_layout Plain Layout
21672 will automatically set
21673 \begin_inset Flex Code
21676 \begin_layout Plain Layout
21683 \begin_inset Flex Code
21686 \begin_layout Plain Layout
21694 \begin_inset Flex Code
21697 \begin_layout Plain Layout
21703 can be set to true, or
21704 \begin_inset Flex Code
21707 \begin_layout Plain Layout
21714 \begin_inset Flex Code
21717 \begin_layout Plain Layout
21723 insets by setting it
21728 \begin_inset Flex Code
21731 \begin_layout Plain Layout
21738 \change_inserted -712698321 1555575738
21742 \begin_layout Description
21744 \change_inserted -712698321 1555575844
21745 \begin_inset Flex Code
21748 \begin_layout Plain Layout
21750 \change_inserted -712698321 1555575740
21759 \begin_inset Flex Code
21762 \begin_layout Plain Layout
21764 \change_inserted -712698321 1555575740
21772 A dedicated string for the menu.
21773 You can define an accelerator by appending the respective character to
21774 the string, divided by
21775 \begin_inset Quotes eld
21779 \begin_inset Quotes erd
21783 \begin_inset space \thinspace{}
21787 \begin_inset space \space{}
21791 \begin_inset Quotes eld
21795 \begin_inset Flex Code
21798 \begin_layout Plain Layout
21800 \change_inserted -712698321 1555575781
21809 \begin_inset Quotes erd
21813 This specification is optional.
21814 If it is not given the inset name as specified in the type declaration
21815 will be used instead for the menu.
21820 \begin_layout Description
21821 \begin_inset Flex Code
21824 \begin_layout Plain Layout
21831 \begin_inset Flex Code
21834 \begin_layout Plain Layout
21843 \begin_inset space \thinspace{}
21847 \begin_inset Flex Code
21850 \begin_layout Plain Layout
21856 ] Whether multiple paragraphs are permitted in this inset.
21858 \begin_inset Flex Code
21861 \begin_layout Plain Layout
21867 to the same value and
21868 \begin_inset Flex Code
21871 \begin_layout Plain Layout
21877 to the opposite value.
21878 These can be reset to other values, if they are used
21883 \begin_inset Flex Code
21886 \begin_layout Plain Layout
21896 \begin_layout Description
21897 \begin_inset Flex Code
21900 \begin_layout Plain Layout
21907 \begin_inset Flex Code
21910 \begin_layout Plain Layout
21919 \begin_inset space \thinspace{}
21923 \begin_inset Flex Code
21926 \begin_layout Plain Layout
21932 ] Whether fragile commands in this inset should be
21933 \begin_inset Flex Code
21936 \begin_layout Plain Layout
21949 whether the command should itself be protected.) Default is false.
21950 \change_inserted -712698321 1523633958
21954 \begin_layout Description
21956 \change_inserted -712698321 1552395786
21957 \begin_inset Flex Code
21960 \begin_layout Plain Layout
21962 \change_inserted -712698321 1523633961
21971 \begin_inset Flex Code
21974 \begin_layout Plain Layout
21976 \change_inserted -712698321 1523633958
21987 \begin_inset space \thinspace{}
21991 \begin_inset Flex Code
21994 \begin_layout Plain Layout
21996 \change_inserted -712698321 1523633958
22004 ] This causes macros that contain this inset to be protected with
22005 \begin_inset Flex Code
22008 \begin_layout Plain Layout
22010 \change_inserted -712698321 1523634038
22025 ) if necessary and thus allows (some) verbatim stuff in macros.
22029 \begin_layout Description
22031 \change_inserted -712698321 1555579651
22032 \begin_inset Flex Code
22035 \begin_layout Plain Layout
22037 \change_inserted -712698321 1552395787
22046 \begin_inset Flex Code
22049 \begin_layout Plain Layout
22051 \change_inserted -712698321 1552395787
22062 \begin_inset space \thinspace{}
22066 \begin_inset Flex Code
22069 \begin_layout Plain Layout
22071 \change_inserted -712698321 1552395787
22079 ] Whether specific commands in this inset (such as
22080 \begin_inset Flex Code
22083 \begin_layout Plain Layout
22085 \change_inserted -712698321 1552395787
22096 \begin_inset Flex Code
22099 \begin_layout Plain Layout
22101 \change_inserted -712698321 1552395787
22111 ) should be protected in an
22112 \begin_inset Flex Code
22115 \begin_layout Plain Layout
22117 \change_inserted -712698321 1552395787
22128 This is particularly needed for insets that draw on
22136 commands which parse their content in complex ways.
22140 \begin_layout Description
22142 \change_inserted -712698321 1555579742
22143 \begin_inset Flex Code
22146 \begin_layout Plain Layout
22148 \change_inserted -712698321 1555579658
22157 \begin_inset Flex Code
22160 \begin_layout Plain Layout
22162 \change_inserted -712698321 1555579651
22170 Option to define a different command (from the default
22171 \begin_inset Flex Code
22174 \begin_layout Plain Layout
22176 \change_inserted -712698321 1555579742
22188 ) to be used for line breaks.
22189 The initial backslash must not be specified.
22194 \begin_layout Description
22195 \begin_inset Flex Code
22198 \begin_layout Plain Layout
22205 \begin_inset Flex Code
22208 \begin_layout Plain Layout
22214 ] Deletes an existing
22215 \begin_inset Flex Code
22218 \begin_layout Plain Layout
22227 \begin_layout Description
22228 \begin_inset Flex Code
22231 \begin_layout Plain Layout
22238 \begin_inset Flex Code
22241 \begin_layout Plain Layout
22248 \begin_inset Flex Code
22251 \begin_layout Plain Layout
22257 that has replaced this
22258 \begin_inset Flex Code
22261 \begin_layout Plain Layout
22268 This is used to rename an
22269 \begin_inset Flex Code
22272 \begin_layout Plain Layout
22278 , while keeping backward compatibility.
22279 \change_inserted -712698321 1559491850
22283 \begin_layout Description
22285 \change_inserted -712698321 1559492002
22286 \begin_inset Flex Code
22289 \begin_layout Plain Layout
22291 \change_inserted -712698321 1559491854
22300 \begin_inset Flex Code
22303 \begin_layout Plain Layout
22305 \change_inserted -712698321 1559491850
22316 \begin_inset space \thinspace{}
22320 \begin_inset Flex Code
22323 \begin_layout Plain Layout
22325 \change_inserted -712698321 1559491850
22333 ] If this is set to
22334 \begin_inset Flex Code
22337 \begin_layout Plain Layout
22339 \change_inserted -712698321 1559491881
22347 , paragraph breaks will be ignored in the output.
22348 This might be useful for insets where the content should be alignable on
22349 different lines only in the \SpecialChar LyX
22350 workarea, without any effect in the output.
22355 \begin_layout Description
22356 \begin_inset Flex Code
22359 \begin_layout Plain Layout
22366 \begin_inset Flex Code
22369 \begin_layout Plain Layout
22378 \begin_inset space \thinspace{}
22382 \begin_inset Flex Code
22385 \begin_layout Plain Layout
22391 ] As with paragraph styles, see
22392 \begin_inset CommandInset ref
22394 reference "subsec:Paragraph-Styles"
22402 \begin_layout Description
22403 \begin_inset Flex Code
22406 \begin_layout Plain Layout
22413 \begin_inset Flex Code
22416 \begin_layout Plain Layout
22425 \begin_inset space \thinspace{}
22429 \begin_inset Flex Code
22432 \begin_layout Plain Layout
22438 ] As with paragraph styles, see
22439 \begin_inset CommandInset ref
22441 reference "subsec:Paragraph-Styles"
22449 \begin_layout Description
22450 \begin_inset Flex Code
22453 \begin_layout Plain Layout
22459 As with paragraph styles, see
22460 \begin_inset CommandInset ref
22462 reference "subsec:Paragraph-Styles"
22469 \begin_layout Description
22470 \begin_inset Flex Code
22473 \begin_layout Plain Layout
22480 \begin_inset Flex Code
22483 \begin_layout Plain Layout
22489 ] The prefix to use when creating labels referring to insets of this type.
22490 This allows the use of formatted references.
22493 \begin_layout Description
22494 \begin_inset Flex Code
22497 \begin_layout Plain Layout
22504 \begin_inset Flex Code
22507 \begin_layout Plain Layout
22513 ] As with paragraph styles, see
22514 \begin_inset CommandInset ref
22516 reference "subsec:Paragraph-Styles"
22523 \begin_layout Description
22524 \begin_inset Flex Code
22527 \begin_layout Plain Layout
22534 \begin_inset Flex Code
22537 \begin_layout Plain Layout
22546 \begin_inset space \thinspace{}
22550 \begin_inset Flex Code
22553 \begin_layout Plain Layout
22559 ] Resets the \SpecialChar LaTeX
22560 arguments of this layout (as defined via the
22561 \begin_inset Flex Code
22564 \begin_layout Plain Layout
22571 This is useful if you have copied a style via
22572 \begin_inset Flex Code
22575 \begin_layout Plain Layout
22581 , but you do not want to inherit its (required and optional) arguments.
22584 \begin_layout Description
22585 \begin_inset Flex Code
22588 \begin_layout Plain Layout
22595 \begin_inset Flex Code
22598 \begin_layout Plain Layout
22607 \begin_inset space \thinspace{}
22611 \begin_inset Flex Code
22614 \begin_layout Plain Layout
22621 \change_inserted -712698321 1597733473
22623 \begin_inset Flex Code
22626 \begin_layout Plain Layout
22628 \change_inserted -712698321 1597732178
22636 , font changes are redone inside the respective inset (in the output) even
22637 if the inset itself is in the context of this font changes (e.
22638 \begin_inset space \thinspace{}
22642 \begin_inset Flex Code
22645 \begin_layout Plain Layout
22647 \change_inserted -712698321 1597733683
22650 textbf{Sourrounding text
22654 textbf{content}}\SpecialChar ldots
22663 \begin_inset Flex Code
22666 \begin_layout Plain Layout
22668 \change_inserted -712698321 1597733686
22671 textbf{Sourrounding text
22673 myinset{content}\SpecialChar ldots
22682 Setting this makes sense for commands that internally reset font settings
22684 \begin_inset space \thinspace{}
22688 Note that wrongly setting this might lead to unwanted result (e.
22689 \begin_inset space \thinspace{}
22693 \begin_inset Flex Code
22696 \begin_layout Plain Layout
22698 \change_inserted -712698321 1597733688
22701 emph{Sourrounding text
22705 emph{content}}\SpecialChar ldots
22713 , content is upright, as
22714 \begin_inset Flex Code
22717 \begin_layout Plain Layout
22719 \change_inserted -712698321 1597733278
22731 \change_deleted -712698321 1597733283
22732 Whether this inset should use the font of its surrounding environment or
22737 \change_deleted -712698321 1597733290
22739 \change_inserted -712698321 1597733290
22741 \begin_inset Flex Code
22744 \begin_layout Plain Layout
22746 \change_inserted -712698321 1597733292
22757 \change_deleted -712698321 1597733327
22758 use the font of the surrounding environment
22759 \change_inserted -712698321 1597733343
22760 font changes are not redone inside the inset
22765 \begin_layout Description
22766 \begin_inset Flex Code
22769 \begin_layout Plain Layout
22776 \begin_inset Flex Code
22779 \begin_layout Plain Layout
22785 ] A string that is put at the end of the layout content.
22786 A line break in the output can be indicated by
22787 \begin_inset Flex Code
22790 \begin_layout Plain Layout
22799 \begin_layout Description
22800 \begin_inset Flex Code
22803 \begin_layout Plain Layout
22810 \begin_inset Flex Code
22813 \begin_layout Plain Layout
22820 \begin_inset space \thinspace{}
22824 \begin_inset Flex Code
22827 \begin_layout Plain Layout
22835 ] Allow spell-checking the contents of this inset.
22837 \change_inserted -584632292 1615846659
22841 \begin_layout Subsection
22843 \change_inserted -584632292 1615846729
22845 \begin_inset CommandInset label
22847 name "subsec:Arguments"
22854 \begin_layout Standard
22856 \change_inserted -584632292 1615846807
22857 Both paragraph styles and inset layouts allow for
22861 as well as the main content.
22862 This is especially useful for things like section headings and only makes
22863 sense with \SpecialChar LaTeX
22865 Each (optional or required) argument of a command or environment—except
22866 for the required argument that is associated with the content—has a separate
22867 definition, where the number specifies the order of the arguments.
22868 The definition must end with
22869 \begin_inset Flex Code
22872 \begin_layout Plain Layout
22874 \change_inserted -584632292 1615846730
22883 So a command with two optional arguments looks like:
22886 \begin_layout Quote
22888 \change_inserted -584632292 1615846730
22894 \begin_layout Quote
22896 \change_inserted -584632292 1615846730
22902 \begin_layout Quote
22904 \change_inserted -584632292 1615846730
22910 \begin_layout Quote
22912 \change_inserted -584632292 1615846730
22918 \begin_layout Quote
22920 \change_inserted -584632292 1615846730
22926 \begin_layout Quote
22928 \change_inserted -584632292 1615846730
22934 \begin_layout Standard
22936 \change_inserted -584632292 1615846730
22938 \begin_inset Flex Code
22941 \begin_layout Plain Layout
22943 \change_inserted -584632292 1615846730
22951 definition, the following specifications are possible:
22954 \begin_layout Itemize
22956 \change_inserted -584632292 1615846730
22957 \begin_inset Flex Code
22960 \begin_layout Plain Layout
22962 \change_inserted -584632292 1615846730
22971 \begin_inset Flex Code
22974 \begin_layout Plain Layout
22976 \change_inserted -584632292 1615846730
22984 The string that will appear both in the menu (to insert this argument)
22985 and on the argument inset button (unless you also specify a separate
22986 \begin_inset Flex Code
22989 \begin_layout Plain Layout
22991 \change_inserted -584632292 1615846730
23000 For the menu, you can define an accelerator by appending the respective
23001 character to the string, divided by
23002 \begin_inset Quotes eld
23006 \begin_inset Quotes erd
23010 \begin_inset space \thinspace{}
23014 \begin_inset space \space{}
23018 \begin_inset Quotes eld
23022 \begin_inset Flex Code
23025 \begin_layout Plain Layout
23027 \change_inserted -584632292 1615846730
23036 \begin_inset Quotes erd
23042 \begin_layout Itemize
23044 \change_inserted -584632292 1615846730
23045 \begin_inset Flex Code
23048 \begin_layout Plain Layout
23050 \change_inserted -584632292 1615846730
23059 \begin_inset Flex Code
23062 \begin_layout Plain Layout
23064 \change_inserted -584632292 1615846730
23072 A separate string for the menu.
23073 You can define an accelerator by appending the respective character to
23074 the string, divided by
23075 \begin_inset Quotes eld
23079 \begin_inset Quotes erd
23083 \begin_inset space \thinspace{}
23087 \begin_inset space \space{}
23091 \begin_inset Quotes eld
23095 \begin_inset Flex Code
23098 \begin_layout Plain Layout
23100 \change_inserted -584632292 1615846730
23109 \begin_inset Quotes erd
23113 This specification is optional.
23114 If it is not given the
23115 \begin_inset Flex Code
23118 \begin_layout Plain Layout
23120 \change_inserted -584632292 1615846730
23128 will be used instead for the menu.
23131 \begin_layout Itemize
23133 \change_inserted -584632292 1615846730
23134 \begin_inset Flex Code
23137 \begin_layout Plain Layout
23139 \change_inserted -584632292 1615846730
23148 \begin_inset Flex Code
23151 \begin_layout Plain Layout
23153 \change_inserted -584632292 1615846730
23161 A longer explanatory text that appears in the tooltip when hovering over
23162 the argument inset.
23165 \begin_layout Itemize
23167 \change_inserted -584632292 1615846730
23168 \begin_inset Flex Code
23171 \begin_layout Plain Layout
23173 \change_inserted -584632292 1615846730
23182 \begin_inset Flex Code
23185 \begin_layout Plain Layout
23187 \change_inserted -584632292 1615846730
23198 \begin_inset space \thinspace{}
23202 \begin_inset Flex Code
23205 \begin_layout Plain Layout
23207 \change_inserted -584632292 1615846730
23215 ] Declare if this is a mandatory (1) or an optional (0) argument.
23216 Mandatory arguments will be output empty if not given, while optional arguments
23217 will not be output at all.
23218 By default, mandatory arguments are delimited by
23219 \begin_inset Flex Code
23222 \begin_layout Plain Layout
23224 \change_inserted -584632292 1615846730
23232 , while optional arguments are delimited by
23233 \begin_inset Flex Code
23236 \begin_layout Plain Layout
23238 \change_inserted -584632292 1615846730
23249 \begin_layout Itemize
23251 \change_inserted -584632292 1615846730
23252 \begin_inset Flex Code
23255 \begin_layout Plain Layout
23257 \change_inserted -584632292 1615846730
23266 \begin_inset Flex Code
23269 \begin_layout Plain Layout
23271 \change_inserted -584632292 1615846730
23279 Option to define a different command (from the default
23280 \begin_inset Flex Code
23283 \begin_layout Plain Layout
23285 \change_inserted -584632292 1615846730
23297 ) to be used for line breaks.
23298 The initial backslash must not be specified.
23301 \begin_layout Itemize
23303 \change_inserted -584632292 1615846730
23304 \begin_inset Flex Code
23307 \begin_layout Plain Layout
23309 \change_inserted -584632292 1615846730
23318 \begin_inset Flex Code
23321 \begin_layout Plain Layout
23323 \change_inserted -584632292 1615846730
23331 defines another argument (by its number) which this argument requires to
23332 be output if it is itself output.
23334 \begin_inset space \thinspace{}
23337 g., in \SpecialChar LaTeX
23338 commands, optional arguments often require previous optional arguments
23339 to be output (at least empty), as in
23340 \begin_inset Flex Code
23343 \begin_layout Plain Layout
23345 \change_inserted -584632292 1615846730
23348 command[][argument]{text}
23356 This can be achieved by the statement
23357 \begin_inset Flex Code
23360 \begin_layout Plain Layout
23362 \change_inserted -584632292 1615846730
23371 \begin_inset Flex Code
23374 \begin_layout Plain Layout
23376 \change_inserted -584632292 1615846730
23387 \begin_layout Itemize
23389 \change_inserted -584632292 1615846730
23390 \begin_inset Flex Code
23393 \begin_layout Plain Layout
23395 \change_inserted -584632292 1615846730
23404 \begin_inset Flex Code
23407 \begin_layout Plain Layout
23409 \change_inserted -584632292 1615846730
23417 defines a custom left delimiter (instead of
23418 \begin_inset Flex Code
23421 \begin_layout Plain Layout
23423 \change_inserted -584632292 1615846730
23432 \begin_inset Flex Code
23435 \begin_layout Plain Layout
23437 \change_inserted -584632292 1615846730
23446 A line break in the output can be indicated by
23447 \begin_inset Flex Code
23450 \begin_layout Plain Layout
23452 \change_inserted -584632292 1615846730
23463 \begin_layout Itemize
23465 \change_inserted -584632292 1615846730
23466 \begin_inset Flex Code
23469 \begin_layout Plain Layout
23471 \change_inserted -584632292 1615846730
23480 \begin_inset Flex Code
23483 \begin_layout Plain Layout
23485 \change_inserted -584632292 1615846730
23493 defines a custom right delimiter (instead of
23494 \begin_inset Flex Code
23497 \begin_layout Plain Layout
23499 \change_inserted -584632292 1615846730
23508 \begin_inset Flex Code
23511 \begin_layout Plain Layout
23513 \change_inserted -584632292 1615846730
23522 A line break in the output can be indicated by
23523 \begin_inset Flex Code
23526 \begin_layout Plain Layout
23528 \change_inserted -584632292 1615846730
23539 \begin_layout Itemize
23541 \change_inserted -584632292 1615846730
23542 \begin_inset Flex Code
23545 \begin_layout Plain Layout
23547 \change_inserted -584632292 1615846730
23556 \begin_inset Flex Code
23559 \begin_layout Plain Layout
23561 \change_inserted -584632292 1615846730
23569 defines an argument that is inserted if and only if no user-specified arguments
23571 \begin_inset space \thinspace{}
23575 \begin_inset space \space{}
23578 if no argument inset has been inserted (note that also an empty argument
23579 inset omits the DefaultArg).
23580 Multiple arguments need to be separated by comma.
23583 \begin_layout Itemize
23585 \change_inserted -584632292 1615846730
23586 \begin_inset Flex Code
23589 \begin_layout Plain Layout
23591 \change_inserted -584632292 1615846730
23600 \begin_inset Flex Code
23603 \begin_layout Plain Layout
23605 \change_inserted -584632292 1615846730
23613 defines an argument that is inserted in any case (alone or in addition
23614 to user-specified arguments).
23615 Multiple arguments need to be separated by comma.
23618 \begin_layout Itemize
23620 \change_inserted -584632292 1615846730
23621 \begin_inset Flex Code
23624 \begin_layout Plain Layout
23626 \change_inserted -584632292 1615846730
23634 The font used for the argument content, see
23635 \begin_inset CommandInset ref
23637 reference "subsec:Font-description"
23644 \begin_layout Itemize
23646 \change_inserted -584632292 1615846730
23647 \begin_inset Flex Code
23650 \begin_layout Plain Layout
23652 \change_inserted -584632292 1615846730
23661 \begin_inset Flex Code
23664 \begin_layout Plain Layout
23666 \change_inserted -584632292 1615846730
23677 \begin_inset space \thinspace{}
23681 \begin_inset Flex Code
23684 \begin_layout Plain Layout
23686 \change_inserted -584632292 1615846730
23694 ] As with paragraph styles, see
23695 \begin_inset CommandInset ref
23697 reference "subsec:Paragraph-Styles"
23704 \begin_layout Itemize
23706 \change_inserted -584632292 1615846730
23707 \begin_inset Flex Code
23710 \begin_layout Plain Layout
23712 \change_inserted -584632292 1615846730
23720 The font used for the label; see
23721 \begin_inset CommandInset ref
23723 reference "subsec:Font-description"
23730 \begin_layout Itemize
23732 \change_inserted -584632292 1615846730
23733 \begin_inset Flex Code
23736 \begin_layout Plain Layout
23738 \change_inserted -584632292 1615846730
23747 \begin_inset Flex Code
23750 \begin_layout Plain Layout
23752 \change_inserted -584632292 1615846730
23757 , Minimalistic, Conglomerate
23764 ] describes the rendering style used for the inset's frame and buttons.
23767 \begin_layout Itemize
23769 \change_inserted -584632292 1615846730
23770 \begin_inset Flex Code
23773 \begin_layout Plain Layout
23775 \change_inserted -584632292 1615846730
23784 \begin_inset Flex Code
23787 \begin_layout Plain Layout
23789 \change_inserted -584632292 1615846730
23798 \begin_inset Flex Code
23801 \begin_layout Plain Layout
23803 \change_inserted -584632292 1615846730
23811 , this argument is automatically inserted when the respective style is selected.
23814 \begin_layout Itemize
23816 \change_inserted -584632292 1615846730
23817 \begin_inset Flex Code
23820 \begin_layout Plain Layout
23822 \change_inserted -584632292 1615846730
23831 \begin_inset Flex Code
23834 \begin_layout Plain Layout
23836 \change_inserted -584632292 1615846730
23845 \begin_inset Flex Code
23848 \begin_layout Plain Layout
23850 \change_inserted -584632292 1615846730
23858 , this argument will be inserted on a new line with
23859 \begin_inset Flex Code
23862 \begin_layout Plain Layout
23864 \change_inserted -584632292 1615846730
23872 (only available within Flex insets).
23875 \begin_layout Itemize
23877 \change_inserted -584632292 1615846730
23878 \begin_inset Flex Code
23881 \begin_layout Plain Layout
23883 \change_inserted -584632292 1615846730
23892 \begin_inset Flex Code
23895 \begin_layout Plain Layout
23897 \change_inserted -584632292 1615846730
23906 \begin_inset Flex Code
23909 \begin_layout Plain Layout
23911 \change_inserted -584632292 1615846730
23919 , this argument will be inserted with a copy of the co-text (either selected
23920 text or the whole paragraph) as content.
23923 \begin_layout Itemize
23925 \change_inserted -584632292 1615846730
23926 \begin_inset Flex Code
23929 \begin_layout Plain Layout
23931 \change_inserted -584632292 1615846730
23940 \begin_inset Flex Code
23943 \begin_layout Plain Layout
23945 \change_inserted -584632292 1615846730
23957 ] Whether the contents of this argument should be output in raw form, meaning
23958 without special translations that \SpecialChar LaTeX
23961 \begin_inset Flex Code
23964 \begin_layout Plain Layout
23966 \change_inserted -584632292 1615846730
23974 status is inherited by the inset or paragraph layout the argument belongs
23975 to, true and false change the status for the given argument only.
23978 \begin_layout Itemize
23980 \change_inserted -584632292 1615846730
23981 \begin_inset Flex Code
23984 \begin_layout Plain Layout
23986 \change_inserted -584632292 1615846730
23995 \begin_inset Flex Code
23998 \begin_layout Plain Layout
24000 \change_inserted -584632292 1615846730
24001 string of characters
24012 Defines individual characters
24013 \begin_inset Newline linebreak
24016 that should be output in raw form, meaning without special translations
24017 that \SpecialChar LaTeX
24019 Note that, contrary to PassThru, this needs to be explicitly defined for
24021 That is, arguments do not inherit PassThruChars from their parent inset
24025 \begin_layout Itemize
24027 \change_inserted -584632292 1615846730
24028 \begin_inset Flex Code
24031 \begin_layout Plain Layout
24033 \change_inserted -584632292 1615846730
24042 \begin_inset Flex Code
24045 \begin_layout Plain Layout
24047 \change_inserted -584632292 1615846730
24058 \begin_inset space \thinspace{}
24062 \begin_inset Flex Code
24065 \begin_layout Plain Layout
24067 \change_inserted -584632292 1615846730
24075 ] If this is set to 1, the argument will output its content in the corresponding
24076 item in the table of contents.
24080 \begin_layout Standard
24082 \change_inserted -584632292 1615846730
24083 By default, the text entered in the \SpecialChar LyX
24084 workarea in the respective layout is
24085 the last (mandatory) argument of a command if the
24086 \begin_inset Flex Code
24089 \begin_layout Plain Layout
24091 \change_inserted -584632292 1615846730
24100 \begin_inset Flex Code
24103 \begin_layout Plain Layout
24105 \change_inserted -584632292 1615846730
24114 However, arguments with the prefix
24115 \begin_inset Flex Code
24118 \begin_layout Plain Layout
24120 \change_inserted -584632292 1615846730
24128 are output after this workarea argument.
24129 Note that post-argument numbering restarts at 1, so the first argument
24130 following the workarea argument is
24131 \begin_inset Flex Code
24134 \begin_layout Plain Layout
24136 \change_inserted -584632292 1615846730
24145 Post-arguments are ignored in any other
24146 \begin_inset Flex Code
24149 \begin_layout Plain Layout
24151 \change_inserted -584632292 1615846730
24160 \begin_inset Flex Code
24163 \begin_layout Plain Layout
24165 \change_inserted -584632292 1615846730
24176 \begin_layout Standard
24178 \change_inserted -584632292 1615846730
24180 \begin_inset Flex Code
24183 \begin_layout Plain Layout
24185 \change_inserted -584632292 1615846730
24196 \begin_inset Flex Code
24199 \begin_layout Plain Layout
24201 \change_inserted -584632292 1615846730
24212 \begin_inset Flex Code
24215 \begin_layout Plain Layout
24217 \change_inserted -584632292 1615846730
24225 followed by the number (e.
24226 \begin_inset space \thinspace{}
24230 \begin_inset space \space{}
24234 \begin_inset Flex Code
24237 \begin_layout Plain Layout
24239 \change_inserted -584632292 1615846730
24250 \begin_layout Standard
24252 \change_inserted -584632292 1615846730
24253 Finally, there is a special argument type with the prefix
24254 \begin_inset Flex Code
24257 \begin_layout Plain Layout
24259 \change_inserted -584632292 1615846730
24268 It is not really an argument, but uses the argument interface (thus, the
24269 prefix is also followed by a number, e.
24270 \begin_inset space \thinspace{}
24275 \begin_inset Flex Code
24278 \begin_layout Plain Layout
24280 \change_inserted -584632292 1615846730
24281 Argument listpreamble:1
24289 As the name implies, it is targeted at lists such as
24306 Its content will be output at the list start, before the first
24307 \begin_inset Flex Code
24310 \begin_layout Plain Layout
24312 \change_inserted -584632292 1615846730
24322 , on an own line (a place that is otherwise not accessible in \SpecialChar LyX
24324 This way, users can insert redefinitions (of lengths etc.) to individual
24326 By default, these arguments do not have a delimiter.
24331 \begin_layout Subsection
24333 \begin_inset CommandInset label
24335 name "subsec:Counters"
24342 \begin_layout Standard
24343 It is necessary to define the counters (
24344 \begin_inset Flex Noun
24347 \begin_layout Plain Layout
24354 \begin_inset Flex Noun
24357 \begin_layout Plain Layout
24363 , \SpecialChar ldots
24364 ) in the text class itself.
24365 The standard counters are defined in the file
24366 \begin_inset Flex Code
24369 \begin_layout Plain Layout
24375 , so you may have to do no more than add
24378 \begin_layout LyX-Code
24379 Input stdcounters.inc
24382 \begin_layout Standard
24383 to your layout file to get them to work.
24384 But if you want to define custom counters, then you can do so.
24385 The counter declaration must begin with:
24388 \begin_layout LyX-Code
24389 Counter CounterName
24392 \begin_layout Standard
24394 \begin_inset Flex Code
24397 \begin_layout Plain Layout
24403 ' is replaced by the name of the counter.
24404 And it must end with
24405 \begin_inset Quotes eld
24409 \begin_inset Flex Code
24412 \begin_layout Plain Layout
24419 \begin_inset Quotes erd
24423 The following parameters can also be used:
24426 \begin_layout Description
24427 \begin_inset Flex Code
24430 \begin_layout Plain Layout
24437 \begin_inset Flex Code
24440 \begin_layout Plain Layout
24446 ] Sets the initial value for the counter, to which it will be reset whenever
24448 Normally, one will want the default, 1.
24451 \begin_layout Description
24452 \begin_inset Flex Code
24455 \begin_layout Plain Layout
24462 \begin_inset Flex Code
24465 \begin_layout Plain Layout
24472 \begin_inset Quotes erd
24476 \begin_inset Quotes erd
24479 ] When defined, this string defines how the counter is displayed.
24480 Setting this value sets
24481 \begin_inset Flex Code
24484 \begin_layout Plain Layout
24485 LabelStringAppendix
24491 The following special constructs can be used in the string:
24495 \begin_layout Itemize
24496 \begin_inset Flex Code
24499 \begin_layout Plain Layout
24507 will be replaced by the expansion of the
24508 \begin_inset Flex Code
24511 \begin_layout Plain Layout
24518 \begin_inset Flex Code
24521 \begin_layout Plain Layout
24522 LabelStringAppendix
24528 \begin_inset Flex Code
24531 \begin_layout Plain Layout
24541 \begin_layout Itemize
24542 counter values can be expressed using \SpecialChar LaTeX
24544 \begin_inset Newline newline
24548 \begin_inset Flex Code
24551 \begin_layout Plain Layout
24568 \begin_inset Flex Code
24571 \begin_layout Plain Layout
24583 \begin_layout Plain Layout
24593 Actually, the situation is a bit more complicated: any
24612 other than those described below will produce arabic numerals.
24613 It would not be surprising to see this change in the future.
24619 \begin_inset Flex Code
24622 \begin_layout Plain Layout
24628 : 1, 2, 3,\SpecialChar ldots
24630 \begin_inset Flex Code
24633 \begin_layout Plain Layout
24639 for lower-case letters: a, b, c, \SpecialChar ldots
24641 \begin_inset Flex Code
24644 \begin_layout Plain Layout
24650 for upper-case letters: A, B, C, \SpecialChar ldots
24652 \begin_inset Flex Code
24655 \begin_layout Plain Layout
24661 for lower-case roman numerals: i, ii, iii, \SpecialChar ldots
24663 \begin_inset Flex Code
24666 \begin_layout Plain Layout
24672 for upper-case roman numerals: I, II, III\SpecialChar ldots
24674 \begin_inset Flex Code
24677 \begin_layout Plain Layout
24683 for hebrew numerals.
24687 \begin_layout Standard
24688 If LabelString is not defined, a default value is constructed as follows:
24689 if the counter has a
24690 \change_deleted 731793113 1604355218
24692 \change_inserted 731793113 1604355221
24696 \begin_inset Flex Code
24699 \begin_layout Plain Layout
24701 \change_deleted 731793113 1604355223
24703 \change_inserted 731793113 1604355226
24712 \begin_inset Flex Code
24715 \begin_layout Plain Layout
24722 \begin_inset Newline newline
24726 \begin_inset Flex Code
24729 \begin_layout Plain Layout
24733 \change_inserted 731793113 1604355228
24735 \change_deleted 731793113 1604355230
24745 is used; otherwise the string
24746 \begin_inset Flex Code
24749 \begin_layout Plain Layout
24760 \begin_layout Description
24761 \begin_inset Flex Code
24764 \begin_layout Plain Layout
24765 LabelStringAppendix
24771 \begin_inset Flex Code
24774 \begin_layout Plain Layout
24781 \begin_inset Quotes eld
24785 \begin_inset Quotes erd
24789 \begin_inset Flex Code
24792 \begin_layout Plain Layout
24798 , but for use in the Appendix.
24799 \change_inserted -584632292 1607202551
24803 \begin_layout Description
24805 \change_inserted -584632292 1607202682
24806 \begin_inset Flex Code
24809 \begin_layout Plain Layout
24816 \begin_inset Flex Code
24819 \begin_layout Plain Layout
24821 \change_inserted -584632292 1607202576
24830 \begin_inset Quotes eld
24834 \begin_inset Quotes erd
24837 ] The counter name as used in \SpecialChar LaTeX
24840 \change_inserted 34634807 1619711355
24842 \change_deleted 34634807 1619711355
24844 \change_inserted -584632292 1607202682
24845 .g., in \SpecialChar LyX
24846 , there is a counter named `theorem', but it is output to \SpecialChar LaTeX
24852 \begin_layout Description
24853 \begin_inset Flex Code
24856 \begin_layout Plain Layout
24863 \begin_inset Flex Code
24866 \begin_layout Plain Layout
24873 \begin_inset Quotes erd
24877 \begin_inset Quotes erd
24880 ] A format for use with formatted references to this counter.
24881 For example, one might want to have references to section numbers appear
24883 \begin_inset Quotes eld
24887 \begin_inset Quotes erd
24891 The string should contain
24892 \begin_inset Quotes eld
24896 \begin_inset Quotes erd
24900 This will be replaced by the counter number itself.
24901 So, for sections, it would be: Section ##.
24904 \begin_layout Description
24905 \begin_inset Flex Code
24908 \begin_layout Plain Layout
24915 \begin_inset Flex Code
24918 \begin_layout Plain Layout
24925 \begin_inset Quotes erd
24929 \begin_inset Quotes erd
24932 ] If this is set to the name of another counter, the present counter will
24933 be reset every time the other one is increased.
24935 \begin_inset Flex Code
24938 \begin_layout Plain Layout
24945 \begin_inset Flex Code
24948 \begin_layout Plain Layout
24957 \begin_layout Subsection
24959 \begin_inset CommandInset label
24961 name "subsec:Font-description"
24968 \begin_layout Standard
24969 A font description looks like this:
24972 \begin_layout LyX-Code
24989 \begin_layout LyX-Code
24993 \begin_layout LyX-Code
24997 \begin_layout Standard
24998 The following commands are available:
25001 \begin_layout Description
25002 \begin_inset Flex Code
25005 \begin_layout Plain Layout
25012 \change_deleted -712698321 1607682984
25014 \begin_inset Flex Code
25017 \begin_layout Plain Layout
25026 \begin_inset Flex Code
25029 \begin_layout Plain Layout
25036 \begin_inset Flex Code
25039 \begin_layout Plain Layout
25046 \begin_inset Flex Code
25049 \begin_layout Plain Layout
25056 \begin_inset Flex Code
25059 \begin_layout Plain Layout
25066 \begin_inset Flex Code
25069 \begin_layout Plain Layout
25076 \begin_inset Flex Code
25079 \begin_layout Plain Layout
25086 \begin_inset Flex Code
25089 \begin_layout Plain Layout
25096 \begin_inset Flex Code
25099 \begin_layout Plain Layout
25106 \begin_inset Flex Code
25109 \begin_layout Plain Layout
25116 \begin_inset Flex Code
25119 \begin_layout Plain Layout
25126 \begin_inset Flex Code
25129 \begin_layout Plain Layout
25136 \begin_inset Flex Code
25139 \begin_layout Plain Layout
25146 \begin_inset Flex Code
25149 \begin_layout Plain Layout
25156 \begin_inset Flex Code
25159 \begin_layout Plain Layout
25166 \begin_inset Flex Code
25169 \begin_layout Plain Layout
25176 \begin_inset Flex Code
25179 \begin_layout Plain Layout
25186 \begin_inset Flex Code
25189 \begin_layout Plain Layout
25196 \begin_inset Flex Code
25199 \begin_layout Plain Layout
25206 \begin_inset Flex Code
25209 \begin_layout Plain Layout
25216 \change_inserted -712698321 1607683139
25218 \begin_inset Flex Code
25221 \begin_layout Plain Layout
25223 \change_inserted -712698321 1607683135
25232 \begin_inset space ~
25236 \begin_inset CommandInset ref
25238 reference "chap:Names-of-colors"
25246 \change_deleted -712698321 1607683144
25248 \change_inserted -712698321 1607683146
25254 \begin_layout Description
25255 \begin_inset Flex Code
25258 \begin_layout Plain Layout
25265 \begin_inset Flex Code
25268 \begin_layout Plain Layout
25277 \begin_inset Flex Code
25280 \begin_layout Plain Layout
25287 \begin_inset Flex Code
25290 \begin_layout Plain Layout
25299 \begin_layout Description
25300 \begin_inset Flex Code
25303 \begin_layout Plain Layout
25310 \begin_inset Flex Code
25313 \begin_layout Plain Layout
25319 ] Valid arguments are:
25320 \begin_inset Flex Code
25323 \begin_layout Plain Layout
25330 \begin_inset Flex Code
25333 \begin_layout Plain Layout
25340 \begin_inset Flex Code
25343 \begin_layout Plain Layout
25350 \begin_inset Flex Code
25353 \begin_layout Plain Layout
25360 \begin_inset Flex Code
25363 \begin_layout Plain Layout
25370 \begin_inset Flex Code
25373 \begin_layout Plain Layout
25380 \begin_inset Flex Code
25383 \begin_layout Plain Layout
25390 \begin_inset Flex Code
25393 \begin_layout Plain Layout
25400 \begin_inset Flex Code
25403 \begin_layout Plain Layout
25410 \begin_inset Flex Code
25413 \begin_layout Plain Layout
25420 \begin_inset Flex Code
25423 \begin_layout Plain Layout
25430 \begin_inset Flex Code
25433 \begin_layout Plain Layout
25440 Each of these turns on or off the corresponding attribute.
25442 \begin_inset Flex Code
25445 \begin_layout Plain Layout
25451 turns on emphasis, and
25452 \begin_inset Flex Code
25455 \begin_layout Plain Layout
25463 \begin_inset Newline newline
25466 If the latter seems puzzling, remember that the font settings for the present
25467 context are generally inherited from the surrounding context.
25469 \begin_inset Flex Code
25472 \begin_layout Plain Layout
25478 would turn off the emphasis that was anyway in effect, say, in a theorem
25482 \begin_layout Description
25483 \begin_inset Flex Code
25486 \begin_layout Plain Layout
25493 \begin_inset Flex Code
25496 \begin_layout Plain Layout
25505 \begin_inset Flex Code
25508 \begin_layout Plain Layout
25517 \begin_layout Description
25518 \begin_inset Flex Code
25521 \begin_layout Plain Layout
25528 \begin_inset Flex Code
25531 \begin_layout Plain Layout
25540 \begin_inset Flex Code
25543 \begin_layout Plain Layout
25550 \begin_inset Flex Code
25553 \begin_layout Plain Layout
25560 \begin_inset Flex Code
25563 \begin_layout Plain Layout
25572 \begin_layout Description
25573 \begin_inset Flex Code
25576 \begin_layout Plain Layout
25583 \begin_inset Flex Code
25586 \begin_layout Plain Layout
25593 \begin_inset Flex Code
25596 \begin_layout Plain Layout
25603 \begin_inset Flex Code
25606 \begin_layout Plain Layout
25615 \begin_inset Flex Code
25618 \begin_layout Plain Layout
25625 \begin_inset Flex Code
25628 \begin_layout Plain Layout
25635 \begin_inset Flex Code
25638 \begin_layout Plain Layout
25645 \begin_inset Flex Code
25648 \begin_layout Plain Layout
25655 \begin_inset Flex Code
25658 \begin_layout Plain Layout
25667 \begin_layout Subsection
25668 \begin_inset CommandInset label
25670 name "subsec:Citation-engine-description"
25674 Cite engine description
25677 \begin_layout Standard
25679 \begin_inset Flex Code
25682 \begin_layout Plain Layout
25688 blocks, as used mainly in cite engine files (see
25689 \begin_inset CommandInset ref
25691 reference "subsec:Cite-Engine-Files"
25698 ), define the citation commands provided by a specific
25699 \begin_inset Quotes eld
25703 \begin_inset Quotes erd
25707 A cite engine, in \SpecialChar LyX
25708 terms, is way specific way to format citations, using
25709 numbers, author names and/or years.
25710 Currently, \SpecialChar LyX
25711 supports three such engine types, namely:
25714 \begin_layout Enumerate
25715 \begin_inset Flex Code
25718 \begin_layout Plain Layout
25724 : the default Bib\SpecialChar TeX
25725 way to format citations, a simple numeric style (e.
25726 \begin_inset space \thinspace{}
25730 \begin_inset Quotes eld
25734 \begin_inset Quotes erd
25740 \begin_layout Enumerate
25741 \begin_inset Flex Code
25744 \begin_layout Plain Layout
25750 : Harvard-styled citations using author names and publication year (e.
25751 \begin_inset space \thinspace{}
25755 \begin_inset Quotes eld
25758 Smith and Miller (2017b)
25759 \begin_inset Quotes erd
25765 \begin_layout Enumerate
25766 \begin_inset Flex Code
25769 \begin_layout Plain Layout
25775 : extended numerical citations that also allow for author or title next
25777 \begin_inset space \thinspace{}
25781 \begin_inset Quotes eld
25784 Smith and Miller [1]
25785 \begin_inset Quotes erd
25791 \begin_layout Standard
25792 \begin_inset Flex Code
25795 \begin_layout Plain Layout
25801 blocks look like this:
25804 \begin_layout LyX-Code
25808 \begin_layout LyX-Code
25812 \begin_layout LyX-Code
25816 \begin_layout LyX-Code
25817 citeyearpar[][]=parencite*
25820 \begin_layout LyX-Code
25824 \begin_layout LyX-Code
25828 \begin_layout Standard
25830 \begin_inset Flex Code
25833 \begin_layout Plain Layout
25839 denotes the engine.
25840 The individual lines respectively define a cite command or cite command
25841 paradigm supported by this engine.
25842 The line can be as simple as a cite command that is used both to name the
25843 respective \SpecialChar LyX
25844 command and the \SpecialChar LaTeX
25845 output or more complex in order to differentiate
25847 The full syntax is:
25850 \begin_layout LyX-Code
25851 LyXName|alias$*<!_stardesc!_stardesctooltip>[][]=latexcmd
25854 \begin_layout Itemize
25855 \begin_inset Flex Code
25858 \begin_layout Plain Layout
25864 : The name as used in the
25865 \begin_inset Flex Code
25868 \begin_layout Plain Layout
25878 \begin_layout Standard
25879 For portability reasons, we try to use the same name for same-formatted
25880 commands in different cite packages (thus many names stem from natbib,
25881 and thus we need to differentiate a
25882 \begin_inset Flex Code
25885 \begin_layout Plain Layout
25891 sometimes, if the \SpecialChar LaTeX
25892 command names differ).
25896 \begin_layout Itemize
25897 \begin_inset Flex Code
25900 \begin_layout Plain Layout
25906 : a (comma-separated) list of commands that fall back to the given
25907 \begin_inset Flex Code
25910 \begin_layout Plain Layout
25916 in the current engine.
25917 This eases the switch of citation packages and engines.
25919 \begin_inset Flex Code
25922 \begin_layout Plain Layout
25929 \begin_inset Flex Code
25932 \begin_layout Plain Layout
25938 in layout definitions.
25941 \begin_layout Itemize
25942 \begin_inset Flex Code
25945 \begin_layout Plain Layout
25951 : The actual \SpecialChar LaTeX
25952 command that is output.
25956 \begin_layout Standard
25957 \begin_inset Flex Code
25960 \begin_layout Plain Layout
25967 \begin_inset Flex Code
25970 \begin_layout Plain Layout
25978 \begin_inset Flex Code
25981 \begin_layout Plain Layout
25988 \begin_inset Flex Code
25991 \begin_layout Plain Layout
25997 will be output to \SpecialChar LaTeX
26001 \begin_layout Standard
26005 \begin_layout Itemize
26006 Capitalization indicates that the command also has a capitalized form (
26007 \begin_inset Flex Code
26010 \begin_layout Plain Layout
26020 \begin_inset Flex Code
26023 \begin_layout Plain Layout
26032 These usually enforce up-casing of name prefixes (
26037 \begin_inset Formula $\Rightarrow$
26047 \begin_layout Itemize
26049 \begin_inset Flex Code
26052 \begin_layout Plain Layout
26058 indicate the number of optional arguments (there can be 0–2).
26061 \begin_layout Itemize
26063 \begin_inset Flex Code
26066 \begin_layout Plain Layout
26072 indicates there is a starred version of the command (
26073 \begin_inset Flex Code
26076 \begin_layout Plain Layout
26086 \begin_inset Flex Code
26089 \begin_layout Plain Layout
26102 \begin_layout Standard
26103 By default, the starred version means: Output all authors even if it should
26105 \begin_inset Quotes eld
26109 \begin_inset Quotes erd
26113 \begin_inset Flex Code
26116 \begin_layout Plain Layout
26125 \begin_layout Standard
26126 If the star has a different meaning for a given command, it can be specified
26128 \begin_inset Flex Code
26131 \begin_layout Plain Layout
26132 <!_stardesc!_stardesctooltip>
26138 Maximal two translatable macro keywords, marked by the prefix
26139 \begin_inset Flex Code
26142 \begin_layout Plain Layout
26149 The first points to the string that replaces the
26150 \begin_inset Quotes eld
26154 \begin_inset Quotes erd
26157 checkbox label in the citation dialog, the second one to an optional tool
26158 tip for this checkbox.
26162 \begin_layout Standard
26163 Note that these two macros have to be defined in a
26164 \begin_inset Flex Code
26167 \begin_layout Plain Layout
26173 (see next section), dropping the
26174 \begin_inset Flex Code
26177 \begin_layout Plain Layout
26183 from the prefix, like this:
26186 \begin_layout LyX-Code
26187 _stardesc Sta&rred command label
26190 \begin_layout LyX-Code
26191 _stardesctooltip Tooltip for the starred command checkbox.
26195 \begin_layout Itemize
26197 \begin_inset Flex Code
26200 \begin_layout Plain Layout
26206 indicates that this command features
26207 \begin_inset Quotes eld
26210 qualified citation lists
26211 \begin_inset Quotes erd
26219 -specific feature for multi-reference citations where an individual pre-
26220 and postnote can be given to each reference in the list.
26221 Please refer to the
26225 manual for details.
26226 \change_inserted -712698321 1526898670
26230 \begin_layout Standard
26232 \change_inserted -712698321 1526899524
26233 If you want to add a cite command to a cite engine (e.
26234 \begin_inset space \thinspace{}
26237 g., add a specific command provided by a class), you can use
26238 \begin_inset Flex Code
26241 \begin_layout Plain Layout
26243 \change_inserted -712698321 1526898768
26244 AddToCiteEngine <engine type> \SpecialChar ldots
26253 Note that only cite commands that do not exist yet are added.
26258 \begin_layout Subsection
26259 \begin_inset CommandInset label
26261 name "subsec:Citation-format-description"
26265 Cite format description
26268 \begin_layout Standard
26270 \begin_inset Flex Code
26273 \begin_layout Plain Layout
26279 blocks are used to describe how bibliographic information should be displayed,
26280 both within \SpecialChar LyX
26281 itself (in the citation dialog and in tooltips, for example)
26282 and in XHTML output.
26283 Such a block might look like this:
26286 \begin_layout LyX-Code
26290 \begin_layout LyX-Code
26294 \begin_layout LyX-Code
26298 \begin_layout LyX-Code
26302 \begin_layout Standard
26306 \begin_layout LyX-Code
26310 \begin_layout LyX-Code
26314 \begin_layout LyX-Code
26318 \begin_layout LyX-Code
26322 \begin_layout Standard
26323 In the first case, the individual lines define how the bibliographic information
26324 associated with an article or book, respectively, is to be displayed, and
26325 such a definition can be given for any
26326 \begin_inset Quotes els
26330 \begin_inset Quotes ers
26333 that might be present in a Bib\SpecialChar TeX
26336 defines a default format in the source code that will be used if no specific
26337 definition has been given.
26339 predefines several formats in the file
26340 \begin_inset Flex Code
26343 \begin_layout Plain Layout
26349 , which is included in most of \SpecialChar LyX
26350 's document classes.
26353 \begin_layout Standard
26354 In the second case, the lines define how a specific citation command (in
26356 \begin_inset Flex Code
26359 \begin_layout Plain Layout
26368 \begin_inset Flex Code
26371 \begin_layout Plain Layout
26379 ) is to be displayed on the citation inset label, in the citation dialog,
26380 menu or XHTML output.
26382 defines such formats for the citation style variants it supports via
26384 Document\SpecialChar menuseparator
26385 Setting\SpecialChar menuseparator
26386 Bibliography\SpecialChar ldots
26390 \begin_inset Flex Code
26393 \begin_layout Plain Layout
26399 files that are shipped with \SpecialChar LyX
26401 \begin_inset CommandInset ref
26403 reference "subsec:Cite-Engine-Files"
26413 \begin_layout Standard
26414 The definitions use a simple language that allows Bib\SpecialChar TeX
26415 keys to be replaced
26417 Keys should be enclosed in
26418 \begin_inset Flex Code
26421 \begin_layout Plain Layout
26428 \begin_inset Flex Code
26431 \begin_layout Plain Layout
26438 So a simple definition might look like this:
26441 \begin_layout LyX-Code
26443 \begin_inset Quotes eld
26447 \begin_inset Quotes erd
26453 \begin_layout Standard
26454 This would print the author, followed by a comma, followed by the title,
26455 in quotes, followed by a period.
26458 \begin_layout Standard
26459 Of course, sometimes you may want to print a key only if it exists.
26460 This can be done by using a conditional construction, such as:
26461 \begin_inset Flex Code
26464 \begin_layout Plain Layout
26466 \begin_inset space ~
26476 \begin_inset Flex Code
26479 \begin_layout Plain Layout
26485 key exists, then print
26486 \begin_inset Quotes eld
26490 \begin_inset space ~
26494 \begin_inset Quotes erd
26497 followed by the volume key.
26498 It is also possible to have an else clause in the conditional, such as:
26499 \begin_inset Newline newline
26503 \begin_inset Flex Code
26506 \begin_layout Plain Layout
26507 {%author%[[%author%]][[%editor%, ed.]]}
26513 \begin_inset Newline newline
26517 \begin_inset Flex Code
26520 \begin_layout Plain Layout
26526 key is printed if it exists; otherwise, the editor key is printed, followed
26528 \begin_inset Quotes eld
26532 \begin_inset space ~
26536 \begin_inset Quotes erd
26539 Note that the key is again enclosed in
26540 \begin_inset Flex Code
26543 \begin_layout Plain Layout
26549 signs; the entire conditional is enclosed in braces; and the if and else
26550 clauses are enclosed in double brackets,
26551 \begin_inset Quotes eld
26555 \begin_inset Flex Code
26558 \begin_layout Plain Layout
26565 \begin_inset Quotes eld
26569 \begin_inset Quotes eld
26573 \begin_inset Flex Code
26576 \begin_layout Plain Layout
26583 \begin_inset Quotes erd
26587 There must be no space between any of these.
26590 \begin_layout Standard
26591 Next to the entry keys, there are some special keys that can be used for
26592 these conditionals:
26595 \begin_layout Itemize
26596 \begin_inset Flex Code
26599 \begin_layout Plain Layout
26600 {%dialog%[[true]][[false]]}
26606 \begin_inset Quotes eld
26610 \begin_inset Quotes erd
26613 part for dialogs and menus, the
26614 \begin_inset Quotes eld
26618 \begin_inset Quotes erd
26621 part for other contexts (workarea, export)
26624 \begin_layout Itemize
26625 \begin_inset Flex Code
26628 \begin_layout Plain Layout
26629 {%export%[[true]][[false]]}
26635 \begin_inset Quotes eld
26639 \begin_inset Quotes erd
26642 part for export and menus, the
26643 \begin_inset Quotes eld
26647 \begin_inset Quotes erd
26650 part for other contexts (workarea, dialog)
26653 \begin_layout Itemize
26654 \begin_inset Flex Code
26657 \begin_layout Plain Layout
26664 \begin_inset Quotes eld
26668 \begin_inset Quotes erd
26671 part if another item follows (e.
26672 \begin_inset space \thinspace{}
26675 g., in a citation with multiple keys)
26678 \begin_layout Itemize
26679 \begin_inset Flex Code
26682 \begin_layout Plain Layout
26683 {%second%[[true]][[false]]}
26689 \begin_inset Quotes eld
26693 \begin_inset Quotes erd
26696 if this is the second of multiple items, else the
26697 \begin_inset Quotes eld
26701 \begin_inset Quotes erd
26707 \begin_layout Itemize
26708 \begin_inset Flex Code
26711 \begin_layout Plain Layout
26712 {%ifstar%[[true]][[false]]}
26718 \begin_inset Quotes eld
26722 \begin_inset Quotes erd
26725 part for starred citation commands (such as
26726 \begin_inset Flex Code
26729 \begin_layout Plain Layout
26737 ), the false part for unstarred
26740 \begin_layout Itemize
26741 \begin_inset Flex Code
26744 \begin_layout Plain Layout
26745 {%ifentrytype:<type>%[[true]][[false]]}
26751 \begin_inset Quotes eld
26755 \begin_inset Quotes erd
26758 if the current entry type matches
26759 \begin_inset Flex Code
26762 \begin_layout Plain Layout
26768 , else the false part (e.g., in a citation definition:
26769 \begin_inset Flex Code
26772 \begin_layout Plain Layout
26773 {%ifentrytype:book%[[this is a book]][[this is no book]]}
26781 \begin_layout Itemize
26782 \begin_inset Flex Code
26785 \begin_layout Plain Layout
26786 {%ifmultiple:<authortype>%[[true]][[false]]}
26792 \begin_inset Quotes eld
26796 \begin_inset Quotes erd
26799 if the current author type (author, editor etc.) has multiple authors, else
26800 the false part (e.g., in a bibliography definition:
26801 \begin_inset Flex Code
26804 \begin_layout Plain Layout
26805 {%ifmultiple:editor%[[eds.]][[ed.]]}
26813 \begin_layout Itemize
26814 \begin_inset Flex Code
26817 \begin_layout Plain Layout
26818 {%ifqualified%[[true]][[false]]}
26824 \begin_inset Quotes eld
26828 \begin_inset Quotes erd
26831 part if the current citation is a qualified citation list (a specific
26835 format for multi-reference citations), the false part if this is not the
26839 \begin_layout Standard
26841 \begin_inset Flex Code
26844 \begin_layout Plain Layout
26850 prints the author key as it is recorded in the bibliography file.
26851 This might not be what you want, since it will result in a string such
26853 \begin_inset Quotes eld
26856 Miller, Peter and Smith, Mary and White, Jane
26857 \begin_inset Quotes erd
26861 \begin_inset Quotes eld
26865 \begin_inset Quotes erd
26868 is used by Bib\SpecialChar TeX
26869 to delimit authors).
26871 therefore provides some methods to get properly formatted name lists (which
26872 will also get translated).
26873 The following keys are provided:
26876 \begin_layout Enumerate
26877 For name lists with pre- and surname, suitable for the main authors/editors
26878 of a bibliography item.
26880 \begin_inset Flex Code
26883 \begin_layout Plain Layout
26889 part denotes the kind of list that is requested (e.g.
26891 \begin_inset Flex Code
26894 \begin_layout Plain Layout
26904 \begin_layout Itemize
26905 \begin_inset Flex Code
26908 \begin_layout Plain Layout
26909 %abbrvnames:<nametype>%
26914 : Provides a name list which is abbreviated (with
26915 \begin_inset Quotes eld
26919 \begin_inset Quotes erd
26923 \begin_inset Flex Code
26926 \begin_layout Plain Layout
26935 \begin_layout Itemize
26936 \begin_inset Flex Code
26939 \begin_layout Plain Layout
26940 %fullnames:<nametype>%
26945 : Provides a full name list (never abbreviated with
26946 \begin_inset Quotes eld
26950 \begin_inset Quotes erd
26956 \begin_layout Itemize
26957 \begin_inset Flex Code
26960 \begin_layout Plain Layout
26961 %forceabbrvnames:<nametype>%
26966 : Provides a name list which is always abbreviated (with
26967 \begin_inset Quotes eld
26971 \begin_inset Quotes erd
26975 \begin_inset Flex Code
26978 \begin_layout Plain Layout
26988 \begin_layout Enumerate
26989 Alternative name lists with pre- and surname, if the order of pre- and surname
26990 inside the bibliography item differs (as in:
26991 \begin_inset Quotes eld
26994 Miller, John: Some text, in: Mary Smith, ed.: A volume
26995 \begin_inset Quotes erd
27002 \begin_layout Itemize
27003 \begin_inset Flex Code
27006 \begin_layout Plain Layout
27007 %abbrvbynames:<nametype>%
27012 : Provides a name list which is abbreviated (with
27013 \begin_inset Quotes eld
27017 \begin_inset Quotes erd
27021 \begin_inset Flex Code
27024 \begin_layout Plain Layout
27033 \begin_layout Itemize
27034 \begin_inset Flex Code
27037 \begin_layout Plain Layout
27038 %fullbynames:<nametype>%
27043 : Provides a full name list (never abbreviated with
27044 \begin_inset Quotes eld
27048 \begin_inset Quotes erd
27054 \begin_layout Itemize
27055 \begin_inset Flex Code
27058 \begin_layout Plain Layout
27059 %forceabbrvbynames:<nametype>%
27064 : Provides a name list which is always abbreviated (with
27065 \begin_inset Quotes eld
27069 \begin_inset Quotes erd
27073 \begin_inset Flex Code
27076 \begin_layout Plain Layout
27086 \begin_layout Enumerate
27087 And finally name lists which consist of family names only, as used in author-yea
27089 These do not take a
27090 \begin_inset Flex Code
27093 \begin_layout Plain Layout
27099 part, but always return either an author list or, if this does not exist,
27100 an editor list (as common in author-year labels):
27104 \begin_layout Itemize
27105 \begin_inset Flex Code
27108 \begin_layout Plain Layout
27114 : Provides a name list which is abbreviated (with
27115 \begin_inset Quotes eld
27119 \begin_inset Quotes erd
27123 \begin_inset Flex Code
27126 \begin_layout Plain Layout
27135 \begin_layout Itemize
27136 \begin_inset Flex Code
27139 \begin_layout Plain Layout
27145 : Provides a full name list (never abbreviated with
27146 \begin_inset Quotes eld
27150 \begin_inset Quotes erd
27156 \begin_layout Itemize
27157 \begin_inset Flex Code
27160 \begin_layout Plain Layout
27161 %forceabbrvciteauthor%
27166 : Provides a name list which is always abbreviated (with
27167 \begin_inset Quotes eld
27171 \begin_inset Quotes erd
27175 \begin_inset Flex Code
27178 \begin_layout Plain Layout
27188 \begin_layout Standard
27189 The order of pre- and surname in the former two lists can be adjusted by
27193 \begin_layout Itemize
27194 \begin_inset Flex Code
27197 \begin_layout Plain Layout
27198 !firstnameform %surname%, %prename%
27203 (first author in lists of type 1)
27206 \begin_layout Itemize
27207 \begin_inset Flex Code
27210 \begin_layout Plain Layout
27211 !othernameform %surname%, %prename%
27216 (other authors in lists of type 1)
27219 \begin_layout Itemize
27220 \begin_inset Flex Code
27223 \begin_layout Plain Layout
27224 !firstbynameform %prename% %surname%
27229 (first author in lists of type 2)
27232 \begin_layout Itemize
27233 \begin_inset Flex Code
27236 \begin_layout Plain Layout
27237 !otherbynameform %prename% %surname%
27242 (other authors in lists of type 2)
27245 \begin_layout Standard
27246 This allows you to configure namings like
27247 \begin_inset Quotes eld
27250 Miller, Peter and Mary Smith: \SpecialChar ldots
27251 , in: John Doe and Pat Green, eds.:\SpecialChar ldots
27253 \begin_inset Quotes erd
27259 \begin_layout Standard
27260 There is one other piece of syntax available in definitions, which looks
27262 \begin_inset Flex Code
27265 \begin_layout Plain Layout
27272 This defines a piece of formatting information that is to be used when
27274 \begin_inset Quotes eld
27278 \begin_inset Quotes erd
27282 Obviously, we do not want to output HTML tags when writing plain text,
27283 so they should be wrapped in
27284 \begin_inset Quotes eld
27288 \begin_inset Quotes erd
27292 \begin_inset Quotes eld
27296 \begin_inset Quotes erd
27302 \begin_layout Standard
27303 Two special sorts of definitions are also possible in a
27304 \begin_inset Flex Code
27307 \begin_layout Plain Layout
27314 An example of the first would be:
27317 \begin_layout LyX-Code
27319 \begin_inset Quotes eld
27323 \begin_inset Quotes erd
27329 \begin_layout Standard
27330 This is an abbreviation, or macro, and it can be used by treating it as
27332 \begin_inset Flex Code
27335 \begin_layout Plain Layout
27344 \begin_inset Flex Code
27347 \begin_layout Plain Layout
27353 exactly as it would treat its definition.
27354 So, let us issue the obvious
27362 \begin_layout LyX-Code
27366 \begin_layout Standard
27367 or anything like it.
27369 shouldn't go into an infinite loop, but it may go into a long one before
27373 \begin_layout Standard
27374 The second sort of special definition might look like this:
27377 \begin_layout LyX-Code
27381 \begin_layout Standard
27382 This defines a translatable piece of text, which allows relevant parts of
27383 the bibliography or citation to be translated.
27384 It can be included in a definition by treating it as a key:
27385 \begin_inset Flex Code
27388 \begin_layout Plain Layout
27395 Note that there are two different translation paths: All definitions starting
27397 \begin_inset Flex Code
27400 \begin_layout Plain Layout
27406 , such as in the example above, will be translated to the currently active
27407 buffer language (so the translation will match the generated document).
27408 All definitions starting with underscore only will be translated to the
27410 This is the proper translation for strings that only occur in the dialogs
27411 or on buttons, such as this one:
27414 \begin_layout LyX-Code
27415 _addtobib Add to bibliography only.
27418 \begin_layout Standard
27419 Several of these translatable strings are predefined in
27420 \begin_inset Flex Code
27423 \begin_layout Plain Layout
27430 \begin_inset Flex Code
27433 \begin_layout Plain Layout
27440 Note that these are not macros, in the sense just defined.
27441 They will not be expanded.
27444 \begin_layout Standard
27445 So here then is an example that uses several of these features:
27446 \begin_inset VSpace defskip
27452 \begin_layout Standard
27456 !authoredit {%author%[[%author%, ]][[{%editor%[[%editor%, %B_edtext%, ]]}]]}
27459 \begin_layout Standard
27460 \begin_inset VSpace defskip
27463 This defines a macro that prints the author, followed by a comma, if the
27465 \begin_inset Flex Code
27468 \begin_layout Plain Layout
27474 key is defined, or else prints the name of the editor, followed by the
27476 \begin_inset Flex Code
27479 \begin_layout Plain Layout
27485 or its translation (it is by default
27486 \begin_inset Quotes eld
27490 \begin_inset Quotes erd
27494 \begin_inset Flex Code
27497 \begin_layout Plain Layout
27504 Note that this is in fact defined in
27505 \begin_inset Flex Code
27508 \begin_layout Plain Layout
27514 , so you can use it in your own definitions, or re-definitions, if you load
27518 \begin_layout Section
27519 \begin_inset CommandInset label
27521 name "sec:Tags-for-XHTML"
27525 Tags for XHTML output
27528 \begin_layout Standard
27529 As with \SpecialChar LaTeX
27530 or DocBook, the format of \SpecialChar LyX
27531 's XHTML output is also controlled by
27532 layout information.
27533 In general, \SpecialChar LyX
27534 provides sensible defaults and, as mentioned earlier, it will
27535 even construct default CSS style rules from the other layout tags.
27536 For example, \SpecialChar LyX
27537 will attempt to use the information provided in the
27538 \begin_inset Flex Code
27541 \begin_layout Plain Layout
27547 declaration for the Chapter style to write CSS that will appropriately
27548 format chapter headings.
27551 \begin_layout Standard
27552 In many cases, then, you may not have to do anything at all to get acceptable
27553 XHTML output for your own environments, custom insets, and so forth.
27554 But in some cases you will, and so \SpecialChar LyX
27555 provides a number of layout tags that
27556 can be used to customize the XHTML and CSS that are generated.
27559 \begin_layout Standard
27560 Note that there are two tags,
27561 \begin_inset Flex Code
27564 \begin_layout Plain Layout
27571 \begin_inset Flex Code
27574 \begin_layout Plain Layout
27580 that may appear outside style and inset declarations.
27582 \begin_inset CommandInset ref
27584 reference "subsec:General-text-class"
27588 for details on these.
27591 \begin_layout Subsection
27592 \begin_inset CommandInset label
27594 name "subsec:Paragraph-Style-XHTML"
27601 \begin_layout Standard
27602 The sort of XHTML \SpecialChar LyX
27603 outputs for a paragraph depends upon whether we are dealing
27604 with a normal paragraph, a command, or an environment, where this is itself
27605 determined by the contents of the corresponding
27606 \begin_inset Flex Code
27609 \begin_layout Plain Layout
27620 \begin_layout Standard
27621 For a command or normal paragraph, the output XHTML has the following form:
27624 \begin_layout LyX-Code
27628 \begin_inset Quotes erd
27632 \begin_inset Quotes erd
27638 \begin_layout LyX-Code
27642 \begin_inset Quotes erd
27646 \begin_inset Quotes erd
27652 \begin_layout LyX-Code
27655 Contents of the paragraph.
27658 \begin_layout LyX-Code
27664 \begin_layout Standard
27665 The label tags are of course omitted if the paragraph does not have a label.
27668 \begin_layout Standard
27669 For an environment that is not some sort of list, the XHTML takes this form:
27672 \begin_layout LyX-Code
27676 \begin_inset Quotes erd
27680 \begin_inset Quotes erd
27686 \begin_layout LyX-Code
27690 \begin_inset Quotes erd
27694 \begin_inset Quotes erd
27698 \begin_inset Quotes erd
27702 \begin_inset Quotes erd
27705 >Environment Label</labeltag>First paragraph.</itemtag>
27708 \begin_layout LyX-Code
27711 <itemtag>Second paragraph.</itemtag>
27714 \begin_layout LyX-Code
27720 \begin_layout Standard
27721 Note that the label is output only for the first paragraph, as it should
27722 be for a theorem, for example.
27726 \begin_layout Standard
27727 For a list, we have one of these forms:
27730 \begin_layout LyX-Code
27734 \begin_inset Quotes erd
27738 \begin_inset Quotes erd
27744 \begin_layout LyX-Code
27748 \begin_inset Quotes erd
27752 \begin_inset Quotes erd
27756 \begin_inset Quotes erd
27760 \begin_inset Quotes erd
27763 >List Label</labeltag>First item.</itemtag>
27766 \begin_layout LyX-Code
27770 \begin_inset Quotes erd
27774 \begin_inset Quotes erd
27778 \begin_inset Quotes erd
27782 \begin_inset Quotes erd
27785 >List Label</labeltag>Second item.</itemtag>
27788 \begin_layout LyX-Code
27794 \begin_layout LyX-Code
27798 \begin_layout LyX-Code
27802 \begin_inset Quotes erd
27806 \begin_inset Quotes erd
27812 \begin_layout LyX-Code
27816 \begin_inset Quotes erd
27820 \begin_inset Quotes erd
27823 >List Label</labeltag><itemtag attr=
27824 \begin_inset Quotes erd
27828 \begin_inset Quotes erd
27831 >First item.</itemtag>
27834 \begin_layout LyX-Code
27838 \begin_inset Quotes erd
27842 \begin_inset Quotes erd
27845 >List Label</labeltag><itemtag attr=
27846 \begin_inset Quotes erd
27850 \begin_inset Quotes erd
27853 >Second item.</itemtag>
27856 \begin_layout LyX-Code
27862 \begin_layout Standard
27863 Note the different orders of
27864 \begin_inset Flex Code
27867 \begin_layout Plain Layout
27874 \begin_inset Flex Code
27877 \begin_layout Plain Layout
27884 Which order we get depends upon the setting of
27885 \begin_inset Flex Code
27888 \begin_layout Plain Layout
27895 \begin_inset Flex Code
27898 \begin_layout Plain Layout
27904 is false (the default), you get the first of these, with the label within
27905 the item; if true, you get the second, with the label outside the item.
27908 \begin_layout Standard
27909 The specific tags and attributes output for each paragraph type can be controlle
27910 d by means of the layout tags we are about to describe.
27911 As mentioned earlier, however, \SpecialChar LyX
27912 uses sensible defaults for many of these,
27913 so you often may not need to do very much to get good XHTML output.
27914 Think of the available tags as there so you can tweak things to your liking.
27917 \begin_layout Description
27918 \begin_inset Flex Code
27921 \begin_layout Plain Layout
27928 \begin_inset Flex Code
27931 \begin_layout Plain Layout
27937 ] Specifies attribute information to be output with the main tag.
27939 \begin_inset Quotes eld
27943 \begin_inset Flex Code
27946 \begin_layout Plain Layout
27953 \begin_inset Quotes erd
27957 By default, \SpecialChar LyX
27959 \begin_inset Quotes eld
27963 \begin_inset Flex Code
27966 \begin_layout Plain Layout
27973 \begin_inset Quotes erd
27977 \begin_inset Flex Code
27980 \begin_layout Plain Layout
27986 is the \SpecialChar LyX
27987 name of the layout, made lowercase, for example: chapter.
27992 contain any style information.
27994 \begin_inset Flex Code
27997 \begin_layout Plain Layout
28006 \begin_layout Description
28007 \begin_inset Flex Code
28010 \begin_layout Plain Layout
28017 \begin_inset Flex Code
28020 \begin_layout Plain Layout
28030 ] Whether to output the default CSS information \SpecialChar LyX
28031 generates for this layout,
28032 even if additional information is explicitly provided via
28033 \begin_inset Flex Code
28036 \begin_layout Plain Layout
28044 \begin_inset Flex Code
28047 \begin_layout Plain Layout
28053 allows you to alter or augment the generated CSS, rather than to override
28056 \begin_inset Flex Code
28059 \begin_layout Plain Layout
28068 \begin_layout Description
28069 \begin_inset Flex Code
28072 \begin_layout Plain Layout
28079 \begin_inset Flex Code
28082 \begin_layout Plain Layout
28088 ] The tag to be used for individual paragraphs of environments, replacing
28090 \begin_inset Flex Code
28093 \begin_layout Plain Layout
28099 in the examples above.
28101 \begin_inset Flex Code
28104 \begin_layout Plain Layout
28113 \begin_layout Description
28114 \begin_inset Flex Code
28117 \begin_layout Plain Layout
28124 \begin_inset Flex Code
28127 \begin_layout Plain Layout
28133 ] Attributes for the item tag.
28135 \begin_inset Newline newline
28139 \begin_inset Quotes eld
28143 \begin_inset Flex Code
28146 \begin_layout Plain Layout
28147 class=`layoutname_item'
28153 \begin_inset Quotes erd
28161 contain any style information.
28163 \begin_inset Flex Code
28166 \begin_layout Plain Layout
28175 \begin_layout Description
28176 \begin_inset Flex Code
28179 \begin_layout Plain Layout
28186 \begin_inset Flex Code
28189 \begin_layout Plain Layout
28195 ] The tag to be used for paragraph and item labels, replacing
28196 \begin_inset Flex Code
28199 \begin_layout Plain Layout
28205 in the examples above.
28207 \begin_inset Flex Code
28210 \begin_layout Plain Layout
28217 \begin_inset Flex Code
28220 \begin_layout Plain Layout
28227 \begin_inset Flex Code
28230 \begin_layout Plain Layout
28237 \begin_inset Flex Code
28240 \begin_layout Plain Layout
28241 Centered_Top_Environment
28246 , in which case it defaults to
28247 \begin_inset Flex Code
28250 \begin_layout Plain Layout
28259 \begin_layout Description
28260 \begin_inset Flex Code
28263 \begin_layout Plain Layout
28270 \begin_inset Flex Code
28273 \begin_layout Plain Layout
28279 ] Attributes for the label tag.
28281 \begin_inset Newline newline
28285 \begin_inset Quotes eld
28289 \begin_inset Flex Code
28292 \begin_layout Plain Layout
28293 class=`layoutname_label'
28299 \begin_inset Quotes erd
28307 contain any style information.
28309 \begin_inset Flex Code
28312 \begin_layout Plain Layout
28321 \begin_layout Description
28322 \begin_inset Flex Code
28325 \begin_layout Plain Layout
28332 \begin_inset Flex Code
28335 \begin_layout Plain Layout
28345 ] Meaningful only for list-like environments, this tag controls whether
28346 the label tag is output before or inside the item tag.
28347 This is used, for example, in the description environment, where we want
28349 \begin_inset Flex Code
28352 \begin_layout Plain Layout
28353 <dt>\SpecialChar ldots
28354 </dt><dd>\SpecialChar ldots
28362 \begin_inset Flex Code
28365 \begin_layout Plain Layout
28371 : The label tag is output inside the item tag.
28374 \begin_layout Description
28375 \begin_inset Flex Code
28378 \begin_layout Plain Layout
28384 Information to be output in the
28385 \begin_inset Flex Code
28388 \begin_layout Plain Layout
28394 section when this style is used.
28395 This might, for example, be used to include a
28396 \begin_inset Flex Code
28399 \begin_layout Plain Layout
28406 \begin_inset Flex Code
28409 \begin_layout Plain Layout
28418 \begin_layout Description
28419 \begin_inset Flex Code
28422 \begin_layout Plain Layout
28428 CSS style information to be included when this style is used.
28429 Note that this will automatically be wrapped in a layout-generated
28430 \begin_inset Flex Code
28433 \begin_layout Plain Layout
28439 block, so only the CSS itself need be included.
28441 \begin_inset Flex Code
28444 \begin_layout Plain Layout
28453 \begin_layout Description
28454 \begin_inset Flex Code
28457 \begin_layout Plain Layout
28464 \begin_inset Flex Code
28467 \begin_layout Plain Layout
28473 ] The tag to be used for the main label, replacing
28474 \begin_inset Flex Code
28477 \begin_layout Plain Layout
28483 in the examples above.
28485 \begin_inset Flex Code
28488 \begin_layout Plain Layout
28497 \begin_layout Description
28498 \begin_inset Flex Code
28501 \begin_layout Plain Layout
28508 \begin_inset Flex Code
28511 \begin_layout Plain Layout
28521 ] Marks this style as the one to be used to generate the
28522 \begin_inset Flex Code
28525 \begin_layout Plain Layout
28531 tag for the XHTML file.
28532 By default, it is false.
28534 \begin_inset Flex Code
28537 \begin_layout Plain Layout
28543 file sets it to true for the
28544 \begin_inset Flex Code
28547 \begin_layout Plain Layout
28557 \begin_layout Subsection
28561 \begin_layout Standard
28562 The XHTML output of insets can also be controlled by information in layout
28567 \begin_layout Plain Layout
28568 At present, this is true only for
28569 \begin_inset Quotes eld
28573 \begin_inset Quotes erd
28576 insets (insets you can type into) and is not true for
28577 \begin_inset Quotes eld
28581 \begin_inset Quotes erd
28584 insets (insets that are associated with dialog boxes).
28589 Here, too, \SpecialChar LyX
28590 tries to provide sensible defaults, and it constructs default
28592 But everything can be customized.
28595 \begin_layout Standard
28596 The XHTML \SpecialChar LyX
28597 outputs for an inset has the following form:
28600 \begin_layout LyX-Code
28602 \begin_inset Quotes erd
28606 \begin_inset Quotes erd
28612 \begin_layout LyX-Code
28613 <labeltag>Label</labeltag>
28616 \begin_layout LyX-Code
28618 \begin_inset Quotes erd
28622 \begin_inset Quotes erd
28625 >Contents of the inset.</innertag>
28628 \begin_layout LyX-Code
28632 \begin_layout Standard
28633 If the inset permits multiple paragraphs—that is, if
28634 \begin_inset Flex Code
28637 \begin_layout Plain Layout
28643 is true—then the contents of the inset will itself be output as paragraphs
28644 formatted according to the styles used for those paragraphs (standard,
28645 quote, and the like).
28646 The label tag is of course omitted if the paragraph does not have a label
28647 and, at present, is always
28648 \begin_inset Flex Code
28651 \begin_layout Plain Layout
28658 The inner tag is optional and, by default, does not appear.
28661 \begin_layout Standard
28662 The specific tags and attributes output for each inset can be controlled
28663 by means of the following layout tags.
28666 \begin_layout Description
28667 \begin_inset Flex Code
28670 \begin_layout Plain Layout
28677 \begin_inset Flex Code
28680 \begin_layout Plain Layout
28686 ] Specifies attribute information to be output with the main tag.
28688 \begin_inset Quotes eld
28692 \begin_inset Flex Code
28695 \begin_layout Plain Layout
28696 class=`myinset' onclick=`\SpecialChar ldots
28703 \begin_inset Quotes erd
28707 By default, \SpecialChar LyX
28709 \begin_inset Quotes eld
28713 \begin_inset Flex Code
28716 \begin_layout Plain Layout
28723 \begin_inset Quotes erd
28727 \begin_inset Flex Code
28730 \begin_layout Plain Layout
28736 is the \SpecialChar LyX
28737 name of the inset, made lowercase and with non-alphanumeric characters
28738 converted to underscores, for example: footnote.
28741 \begin_layout Description
28742 \begin_inset Flex Code
28745 \begin_layout Plain Layout
28752 \begin_inset Flex Code
28755 \begin_layout Plain Layout
28765 ] Whether to output the default CSS information \SpecialChar LyX
28766 generates for this layout,
28767 even if additional information is explicitly provided via
28768 \begin_inset Flex Code
28771 \begin_layout Plain Layout
28779 \begin_inset Flex Code
28782 \begin_layout Plain Layout
28788 allows you to alter or augment the generated CSS, rather than to override
28793 \begin_layout Description
28794 \begin_inset Flex Code
28797 \begin_layout Plain Layout
28804 \begin_inset Flex Code
28807 \begin_layout Plain Layout
28813 ] Attributes for the inner tag.
28815 \begin_inset Newline newline
28819 \begin_inset Quotes eld
28823 \begin_inset Flex Code
28826 \begin_layout Plain Layout
28827 class=`insetname_inner'
28833 \begin_inset Quotes erd
28839 \begin_layout Description
28840 \begin_inset Flex Code
28843 \begin_layout Plain Layout
28850 \begin_inset Flex Code
28853 \begin_layout Plain Layout
28859 ] The inner tag, replacing
28860 \begin_inset Flex Code
28863 \begin_layout Plain Layout
28869 in the examples above.
28870 By default, there is none.
28873 \begin_layout Description
28874 \begin_inset Flex Code
28877 \begin_layout Plain Layout
28884 \begin_inset Flex Code
28887 \begin_layout Plain Layout
28895 ] Whether this inset represents a standalone block of text (such as a footnote)
28896 or instead represents material that is included in the surrounding text
28897 (such as a branch).
28901 \begin_layout Description
28902 \begin_inset Flex Code
28905 \begin_layout Plain Layout
28912 \begin_inset Flex Code
28915 \begin_layout Plain Layout
28921 ] A label for this inset, possibly including a reference to a counter.
28922 For example, for footnote, it might be:
28923 \begin_inset Flex Code
28926 \begin_layout Plain Layout
28935 This is optional, and there is no default.
28938 \begin_layout Description
28939 \begin_inset Flex Code
28942 \begin_layout Plain Layout
28948 Information to be output in the
28949 \begin_inset Flex Code
28952 \begin_layout Plain Layout
28958 section when this style is used.
28959 This might, for example, be used to include a
28960 \begin_inset Flex Code
28963 \begin_layout Plain Layout
28970 \begin_inset Flex Code
28973 \begin_layout Plain Layout
28982 \begin_layout Description
28983 \begin_inset Flex Code
28986 \begin_layout Plain Layout
28992 CSS style information to be included when this style is used.
28993 Note that this will automatically be wrapped in a layout-generated
28994 \begin_inset Flex Code
28997 \begin_layout Plain Layout
29003 block, so only the CSS itself need be included.
29006 \begin_layout Description
29007 \begin_inset Flex Code
29010 \begin_layout Plain Layout
29017 \begin_inset Flex Code
29020 \begin_layout Plain Layout
29026 ] The tag to be used for the main label, replacing
29027 \begin_inset Flex Code
29030 \begin_layout Plain Layout
29036 in the examples above.
29037 The default depends upon the setting of
29038 \begin_inset Flex Code
29041 \begin_layout Plain Layout
29048 \begin_inset Flex Code
29051 \begin_layout Plain Layout
29057 is true, the default is
29058 \begin_inset Flex Code
29061 \begin_layout Plain Layout
29067 ; if it is false, the default is
29068 \begin_inset Flex Code
29071 \begin_layout Plain Layout
29080 \begin_layout Subsection
29084 \begin_layout Standard
29085 The XHTML output for floats too can be controlled by layout information.
29086 The output has the following form:
29089 \begin_layout LyX-Code
29091 \begin_inset Quotes erd
29095 \begin_inset Quotes erd
29101 \begin_layout LyX-Code
29102 Contents of the float.
29105 \begin_layout LyX-Code
29109 \begin_layout Standard
29110 The caption, if there is one, is a separate inset and will be output as
29112 Its appearance can be controlled via the InsetLayout for caption insets.
29116 \begin_layout Description
29117 \begin_inset Flex Code
29120 \begin_layout Plain Layout
29127 \begin_inset Flex Code
29130 \begin_layout Plain Layout
29136 ] Specifies attribute information to be output with the main tag.
29138 \begin_inset Quotes eld
29142 \begin_inset Flex Code
29145 \begin_layout Plain Layout
29146 class=`myfloat' onclick=`\SpecialChar ldots
29153 \begin_inset Quotes erd
29157 By default, \SpecialChar LyX
29159 \begin_inset Quotes eld
29163 \begin_inset Flex Code
29166 \begin_layout Plain Layout
29167 class=`float float-floattype'
29173 \begin_inset Quotes erd
29177 \begin_inset Flex Code
29180 \begin_layout Plain Layout
29186 is \SpecialChar LyX
29187 's name for this type of float, as determined by the float declaration
29189 \begin_inset CommandInset ref
29191 reference "subsec:Floats"
29195 ), though made lowercase and with non-alphanumeric characters converted
29196 to underscores, for example: float-table.
29199 \begin_layout Description
29200 \begin_inset Flex Code
29203 \begin_layout Plain Layout
29209 CSS style information to be included when this float is used.
29210 Note that this will automatically be wrapped in a layout-generated
29211 \begin_inset Flex Code
29214 \begin_layout Plain Layout
29220 block, so only the CSS itself need be included.
29223 \begin_layout Description
29224 \begin_inset Flex Code
29227 \begin_layout Plain Layout
29234 \begin_inset Flex Code
29237 \begin_layout Plain Layout
29243 ] The tag to be used for this float, replacing
29244 \begin_inset Quotes eld
29248 \begin_inset Flex Code
29251 \begin_layout Plain Layout
29258 \begin_inset Quotes erd
29261 in the example above.
29263 \begin_inset Flex Code
29266 \begin_layout Plain Layout
29272 and will rarely need changing.
29275 \begin_layout Subsection
29276 Bibliography formatting
29279 \begin_layout Standard
29280 The bibliography can be formatted using
29281 \begin_inset Flex Code
29284 \begin_layout Plain Layout
29292 \begin_inset CommandInset ref
29294 reference "subsec:Citation-format-description"
29301 \begin_layout Subsection
29306 \begin_layout Standard
29307 We have several times mentioned that \SpecialChar LyX
29308 will generate default CSS style rules
29309 for both insets and paragraph styles, based upon the other layout information
29311 In this section, we shall say a word about which layout information \SpecialChar LyX
29316 \begin_layout Standard
29317 At present, \SpecialChar LyX
29318 auto-generates CSS only for font information, making use of
29320 \begin_inset Flex Code
29323 \begin_layout Plain Layout
29330 \begin_inset Flex Code
29333 \begin_layout Plain Layout
29340 \begin_inset Flex Code
29343 \begin_layout Plain Layout
29350 \begin_inset Flex Code
29353 \begin_layout Plain Layout
29360 \begin_inset Flex Code
29363 \begin_layout Plain Layout
29370 \begin_inset CommandInset ref
29372 reference "subsec:Font-description"
29377 The translation is mostly straightforward and obvious.
29379 \begin_inset Quotes eld
29383 \begin_inset Flex Code
29386 \begin_layout Plain Layout
29393 \begin_inset Quotes erd
29397 \begin_inset Quotes eld
29401 \begin_inset Flex Code
29404 \begin_layout Plain Layout
29405 font-family: sans-serif;
29411 \begin_inset Quotes erd
29415 The correspondence of \SpecialChar LyX
29416 sizes and CSS sizes is a little less obvious but
29417 nonetheless intuitive.
29419 \begin_inset Flex Code
29422 \begin_layout Plain Layout
29429 \begin_inset Flex URL
29432 \begin_layout Plain Layout
29440 \change_inserted -970929547 1496610908
29444 \begin_layout Section
29446 \change_inserted -970929547 1496610966
29447 \begin_inset CommandInset label
29449 name "sec:Tags-for-DocBook"
29453 Tags for DocBook output
29456 \begin_layout Standard
29458 \change_inserted -970929547 1496611615
29459 As with \SpecialChar LaTeX
29460 or XHTML, the format of \SpecialChar LyX
29461 's DocBook output is also controlled by
29462 layout information.
29463 In general, \SpecialChar LyX
29464 provides sensible defaults; however, much of the styling is
29465 lost during the conversion, as DocBook is strictly semantic and does not
29467 When possible, information from \SpecialChar LyX
29468 will be rendered in
29476 \begin_layout Standard
29478 \change_inserted -970929547 1496612080
29479 In many cases, then, you may not have to do anything at all to get acceptable
29480 DocBook output for your own environments, custom insets, and so forth.
29481 But in some cases you will, and so \SpecialChar LyX
29482 provides a number of layout tags that
29483 can be used to customize the DocBook that is generated.
29486 \begin_layout Standard
29488 \change_inserted -970929547 1515109912
29489 Labels are rarely output, as they are redundant in DocBook: this information
29490 is carried by the tags themselves, and whether labels appear in the final
29491 documents (after processing of DocBook files) is controlled by the stylesheets.
29492 However, sometimes, labels are not redundant content, such as definition
29493 lists: in this case, the term being defined will be the label.
29497 \begin_layout Subsection
29499 \change_inserted 1075283030 1597699417
29500 \begin_inset CommandInset label
29502 name "subsec:Paragraph-Style-DocBook"
29507 \change_deleted 1075283030 1597699417
29509 \begin_inset CommandInset label
29511 name "subsec:Paragraph-Style-XHTML-1"
29516 \change_inserted -970929547 1496610966
29520 \begin_layout Standard
29522 \change_inserted -970929547 1496612059
29523 The sort of DocBook \SpecialChar LyX
29524 outputs for a paragraph depends upon whether we are
29525 dealing with a normal paragraph, a command, or an environment, where this
29526 is itself determined by the contents of the corresponding
29527 \begin_inset Flex Code
29530 \begin_layout Plain Layout
29532 \change_inserted -970929547 1496610966
29545 \begin_layout Standard
29547 \change_inserted -970929547 1496612107
29548 For a command or normal paragraph, the output DocBook has the following
29552 \begin_layout LyX-Code
29554 \change_inserted -970929547 1515109666
29558 \begin_layout LyX-Code
29560 \change_inserted -970929547 1496610966
29561 Contents of the paragraph.
29564 \begin_layout LyX-Code
29566 \change_inserted -970929547 1496610966
29570 \begin_layout Standard
29572 \change_inserted -970929547 1515109821
29573 For an environment that is not some sort of list, the generated DocBook
29577 \begin_layout LyX-Code
29579 \change_inserted -970929547 1515109671
29583 \begin_layout LyX-Code
29585 \change_inserted -970929547 1496612114
29586 <itemtag>First paragraph.</itemtag>
29589 \begin_layout LyX-Code
29591 \change_inserted -970929547 1496610966
29592 <itemtag>Second paragraph.</itemtag>
29595 \begin_layout LyX-Code
29597 \change_inserted -970929547 1496610966
29601 \begin_layout Standard
29603 \change_inserted -970929547 1515109825
29604 For a list, the resulting DocBook takes this form:
29607 \begin_layout LyX-Code
29609 \change_inserted -970929547 1515109672
29613 \begin_layout LyX-Code
29615 \change_inserted -970929547 1515109676
29616 <itemtag attr>First item.</itemtag>
29619 \begin_layout LyX-Code
29621 \change_inserted -970929547 1515109678
29622 <itemtag attr>Second item.</itemtag>
29625 \begin_layout LyX-Code
29627 \change_inserted -970929547 1496610966
29631 \begin_layout Standard
29633 \change_inserted -970929547 1496612243
29634 The specific tags and roles output for each paragraph type can be controlled
29635 by means of the layout tags we are about to describe.
29636 Please note that, due to the very nature of DocBook, no sensible defaults
29637 really exist, and the values must always be carefully chosen.
29641 \begin_layout Description
29643 \change_inserted -970929547 1515110057
29644 \begin_inset Flex Code
29647 \begin_layout Plain Layout
29649 \change_inserted -970929547 1515109656
29658 \begin_inset Flex Code
29661 \begin_layout Plain Layout
29663 \change_inserted -970929547 1496610966
29671 ] Specifies attribute information to be output with the main tag, replacing
29673 \begin_inset Quotes eld
29677 \begin_inset Flex Code
29680 \begin_layout Plain Layout
29682 \change_inserted -970929547 1515110057
29691 \begin_inset Quotes erd
29694 in the example above.
29695 This information can be used in further processing of the DocBook files.
29701 \begin_layout Description
29703 \change_inserted -970929547 1496612296
29704 \begin_inset Flex Code
29707 \begin_layout Plain Layout
29709 \change_inserted -970929547 1496612269
29718 \begin_inset Flex Code
29721 \begin_layout Plain Layout
29723 \change_inserted -970929547 1496610966
29731 ] The tag to be used for this inset, replacing
29732 \begin_inset Quotes eld
29736 \begin_inset Flex Code
29739 \begin_layout Plain Layout
29741 \change_inserted -970929547 1496612296
29750 \begin_inset Quotes erd
29753 in the example above.
29754 The default is the name of the float and always needs to be changed, as
29755 DocBook provides no generic tag.
29756 \change_inserted 1075283030 1597698868
29760 \begin_layout Description
29762 \change_inserted 1075283030 1597699399
29763 \begin_inset Flex Code
29766 \begin_layout Plain Layout
29768 \change_inserted 1075283030 1597698872
29777 \begin_inset Flex Code
29780 \begin_layout Plain Layout
29782 \change_inserted 1075283030 1597700585
29783 block, paragraph, inline
29790 ] The new-line policy for this tag, see Section
29791 \begin_inset space ~
29795 \begin_inset CommandInset ref
29797 reference "subsec:DocBook-New-line-policy"
29810 \begin_layout Subsection
29812 \change_inserted 1075283030 1597699385
29814 \begin_inset CommandInset label
29816 name "subsec:DocBook-New-line-policy"
29823 \begin_layout Standard
29825 \change_inserted 1075283030 1597698993
29826 For all tags, there are three possible policies for outputting new lines
29828 \begin_inset Flex Code
29831 \begin_layout Plain Layout
29833 \change_inserted 1075283030 1597698987
29844 \begin_layout Itemize
29846 \change_inserted 1075283030 1597699279
29847 \begin_inset Quotes eld
29851 \begin_inset Flex Code
29854 \begin_layout Plain Layout
29856 \change_inserted 1075283030 1597699012
29865 \begin_inset Quotes erd
29868 : the opening and closing tags are on their own lines (i.e.
29869 a line feed after and before the opening and the closing tags).
29870 Typical elements are floats.
29874 \begin_layout LyX-Code
29876 \change_inserted 1075283030 1597699194
29880 \begin_layout LyX-Code
29882 \change_inserted 1075283030 1597699194
29886 \begin_layout LyX-Code
29888 \change_inserted 1075283030 1597699098
29889 Contents of the block.
29892 \begin_layout LyX-Code
29894 \change_inserted 1075283030 1597699196
29898 \begin_layout LyX-Code
29900 \change_inserted 1075283030 1597699198
29904 \begin_layout Itemize
29906 \change_inserted 1075283030 1597699289
29907 \begin_inset Quotes eld
29911 \begin_inset Flex Code
29914 \begin_layout Plain Layout
29916 \change_inserted 1075283030 1597699113
29925 \begin_inset Quotes erd
29928 : the opening and closing tags are on the same, new line; a line feed is
29929 output before the opening tag and after the closing tag.
29930 Typical elements are paragraphs and list items.
29934 \begin_layout LyX-Code
29936 \change_inserted 1075283030 1597699186
29940 \begin_layout LyX-Code
29942 \change_inserted 1075283030 1597699357
29943 <paratag>Contents of the paragraph.</paratag>
29946 \begin_layout LyX-Code
29948 \change_inserted 1075283030 1597699231
29952 \begin_layout Itemize
29954 \change_inserted 1075283030 1597699343
29955 \begin_inset Quotes eld
29959 \begin_inset Flex Code
29962 \begin_layout Plain Layout
29964 \change_inserted 1075283030 1597699307
29973 \begin_inset Quotes erd
29976 : the opening and closing tags are on the same line as the rest of the content.
29977 No line feeds are output.
29978 Typical elements are fonts.
29982 \begin_layout LyX-Code
29984 \change_inserted 1075283030 1597699585
29985 Content before<inlinetag>Contents of the paragraph.</inlinetag>Content after
29988 \begin_layout Standard
29990 \change_inserted 1075283030 1597699585
29991 The default value is always
29992 \begin_inset Quotes eld
29996 \begin_inset Flex Code
29999 \begin_layout Plain Layout
30001 \change_inserted 1075283030 1597699585
30010 \begin_inset Quotes erd
30018 \begin_layout Subsection
30020 \change_inserted -970929547 1515111533
30021 InsetLayout DocBook
30026 \begin_layout Standard
30028 \change_inserted -970929547 1496611894
30029 The DocBook output of insets can also be controlled by information in layout
30033 \begin_layout Standard
30035 \change_inserted -970929547 1496612045
30036 The DocBook \SpecialChar LyX
30037 outputs for an inset has the following form:
30040 \begin_layout LyX-Code
30042 \change_inserted -970929547 1515110861
30043 <wrappertag wrapperattr>
30046 \begin_layout LyX-Code
30048 \change_inserted -970929547 1515110868
30052 \begin_layout LyX-Code
30054 \change_inserted -970929547 1515110869
30055 <innertag innerattr>
30058 \begin_layout LyX-Code
30060 \change_inserted -970929547 1515110869
30061 Contents of the inset.
30064 \begin_layout LyX-Code
30066 \change_inserted -970929547 1515110870
30070 \begin_layout LyX-Code
30072 \change_inserted -970929547 1515110871
30076 \begin_layout LyX-Code
30078 \change_inserted -970929547 1515111172
30082 \begin_layout Standard
30084 \change_inserted -970929547 1515111186
30085 For an itemising inset, it rather looks like this:
30088 \begin_layout LyX-Code
30090 \change_inserted -970929547 1515111186
30091 <wrappertag wrapperattr>
30094 \begin_layout LyX-Code
30096 \change_inserted -970929547 1515111186
30100 \begin_layout LyX-Code
30102 \change_inserted -970929547 1515111186
30103 <innertag innerattr>
30106 \begin_layout LyX-Code
30108 \change_inserted -970929547 1515111362
30109 <itemwrappertag itemwrapperattr>
30112 \begin_layout LyX-Code
30114 \change_inserted -970929547 1515111364
30115 <itemlabeltag itemattr>
30118 \begin_layout LyX-Code
30120 \change_inserted -970929547 1515111367
30121 Label of the first item.
30124 \begin_layout LyX-Code
30126 \change_inserted -970929547 1515111362
30132 \begin_layout LyX-Code
30134 \change_inserted -970929547 1515111517
30138 \begin_layout LyX-Code
30140 \change_inserted -970929547 1515111517
30146 \begin_layout LyX-Code
30148 \change_inserted -970929547 1515111516
30149 Contents of the first item.
30152 \begin_layout LyX-Code
30154 \change_inserted -970929547 1515111514
30160 \begin_layout LyX-Code
30162 \change_inserted -970929547 1515111247
30168 \begin_layout LyX-Code
30170 \change_inserted -970929547 1515111221
30174 \begin_layout LyX-Code
30176 \change_inserted -970929547 1515111370
30177 <itemwrappertag itemwrapperattr>
30180 \begin_layout LyX-Code
30182 \change_inserted -970929547 1515111370
30183 <itemlabeltag itemattr>
30186 \begin_layout LyX-Code
30188 \change_inserted -970929547 1515111372
30189 Label of the second item.
30192 \begin_layout LyX-Code
30194 \change_inserted -970929547 1515111370
30200 \begin_layout LyX-Code
30202 \change_inserted -970929547 1515111504
30206 \begin_layout LyX-Code
30208 \change_inserted -970929547 1515111505
30214 \begin_layout LyX-Code
30216 \change_inserted -970929547 1515111507
30217 Contents of the second item.
30220 \begin_layout LyX-Code
30222 \change_inserted -970929547 1515111509
30228 \begin_layout LyX-Code
30230 \change_inserted -970929547 1515111251
30236 \begin_layout LyX-Code
30238 \change_inserted -970929547 1515111221
30244 \begin_layout LyX-Code
30246 \change_inserted -970929547 1515111219
30252 \begin_layout LyX-Code
30254 \change_inserted -970929547 1515111186
30258 \begin_layout LyX-Code
30260 \change_inserted -970929547 1515111186
30264 \begin_layout LyX-Code
30266 \change_inserted -970929547 1515111186
30270 \begin_layout Standard
30272 \change_inserted -970929547 1515111183
30273 If the inset permits multiple paragraphs—that is, if
30274 \begin_inset Flex Code
30277 \begin_layout Plain Layout
30279 \change_inserted -970929547 1496610966
30287 is true—then the contents of the inset will
30288 \change_deleted 34634807 1620029217
30290 \change_inserted 34634807 1620029219
30292 \change_inserted -970929547 1515111183
30293 be output as paragraphs formatted according to the styles used for those
30294 paragraphs (standard, quote, and the like).
30295 The inner tag is optional and, by default, does not appear.
30298 \begin_layout Standard
30300 \change_inserted -970929547 1496610966
30301 The specific tags and attributes output for each inset can be controlled
30302 by means of the following layout tags.
30305 \begin_layout Description
30307 \change_inserted -970929547 1515110317
30308 \begin_inset Flex Code
30311 \begin_layout Plain Layout
30313 \change_inserted -970929547 1515109695
30322 \begin_inset Flex Code
30325 \begin_layout Plain Layout
30327 \change_inserted -970929547 1496611854
30335 ] Specifies attribute information to be output with the main tag, replacing
30337 \begin_inset Quotes eld
30341 \begin_inset Flex Code
30344 \begin_layout Plain Layout
30346 \change_inserted -970929547 1515110044
30355 \begin_inset Quotes erd
30358 in the example above.
30359 This information can be used in further processing of the DocBook files.
30363 \begin_layout Description
30365 \change_inserted -970929547 1515110973
30366 \begin_inset Flex Code
30369 \begin_layout Plain Layout
30371 \change_inserted -970929547 1515110319
30380 \begin_inset Flex Code
30383 \begin_layout Plain Layout
30385 \change_inserted -970929547 1515110384
30386 never, always, maybe
30393 ] Specifies whether this tag goes into the
30394 \begin_inset Flex Code
30397 \begin_layout Plain Layout
30399 \change_inserted -970929547 1515110412
30407 tag at the beginning of the parent layout.
30409 \begin_inset Flex Code
30412 \begin_layout Plain Layout
30414 \change_inserted -970929547 1515110437
30422 indicates that the tag never goes into
30423 \begin_inset Flex Code
30426 \begin_layout Plain Layout
30428 \change_inserted -970929547 1515110497
30436 (this is default value, and corresponds to usual content).
30438 \begin_inset Flex Code
30441 \begin_layout Plain Layout
30443 \change_inserted -970929547 1515110517
30451 indicates that the tag always goes into
30452 \begin_inset Flex Code
30455 \begin_layout Plain Layout
30457 \change_inserted -970929547 1515110514
30465 (this corresponds to usual metadata): if there is no
30466 \begin_inset Flex Code
30469 \begin_layout Plain Layout
30471 \change_inserted -970929547 1515110550
30479 tag for the parent, one
30485 \begin_inset Flex Code
30488 \begin_layout Plain Layout
30490 \change_inserted -970929547 1515110540
30498 indicates that the tag may go into
30499 \begin_inset Flex Code
30502 \begin_layout Plain Layout
30504 \change_inserted -970929547 1515110538
30512 (this is only the case for titles): if there is no
30513 \begin_inset Flex Code
30516 \begin_layout Plain Layout
30518 \change_inserted -970929547 1515110585
30526 tag for the parent,
30530 will be generated, the corresponding tag will be output directly as content.
30534 \begin_layout Description
30536 \change_inserted -970929547 1515111461
30537 \begin_inset Flex Code
30540 \begin_layout Plain Layout
30542 \change_inserted -970929547 1515110974
30551 \begin_inset Flex Code
30554 \begin_layout Plain Layout
30556 \change_inserted -970929547 1515110973
30564 ] Specifies attribute information to be output with the item tag, replacing
30566 \begin_inset Quotes eld
30570 \begin_inset Flex Code
30573 \begin_layout Plain Layout
30575 \change_inserted -970929547 1515110984
30584 \begin_inset Quotes erd
30587 in the example above.
30588 This information can be used in further processing of the DocBook files.
30592 \begin_layout Description
30594 \change_inserted -970929547 1515111471
30595 \begin_inset Flex Code
30598 \begin_layout Plain Layout
30600 \change_inserted -970929547 1515111465
30601 DocBookItemInnerAttr
30609 \begin_inset Flex Code
30612 \begin_layout Plain Layout
30614 \change_inserted -970929547 1515111461
30622 ] Specifies attribute information to be output with the item inner tag,
30624 \begin_inset Quotes eld
30628 \begin_inset Flex Code
30631 \begin_layout Plain Layout
30633 \change_inserted -970929547 1515111476
30642 \begin_inset Quotes erd
30645 in the example above.
30646 This information can be used in further processing of the DocBook files.
30650 \begin_layout Description
30652 \change_inserted -970929547 1515111494
30653 \begin_inset Flex Code
30656 \begin_layout Plain Layout
30658 \change_inserted -970929547 1515111467
30659 DocBookItemInnerTag
30667 \begin_inset Flex Code
30670 \begin_layout Plain Layout
30672 \change_inserted -970929547 1515111461
30680 ] The tag to be used for the item inner tag within the inset, replacing
30682 \begin_inset Quotes eld
30686 \begin_inset Flex Code
30689 \begin_layout Plain Layout
30691 \change_inserted -970929547 1515111486
30700 \begin_inset Quotes erd
30703 in the example above.
30705 \begin_inset Flex Code
30708 \begin_layout Plain Layout
30710 \change_inserted -970929547 1515111461
30718 , indicating that there is no item inner tag: content is directly output
30719 without it for each itemised element.
30720 This parameter only makes sense when itemising layouts are used, such as
30723 \change_inserted 1075283030 1598469472
30724 The most likely value is
30725 \begin_inset Quotes eld
30729 \begin_inset Flex Code
30732 \begin_layout Plain Layout
30734 \change_inserted 1075283030 1598469476
30743 \begin_inset Quotes erd
30747 \begin_inset Newline newline
30750 When a list item is split using a new line, the item inner tag will be repeated
30751 for each part of the paragraph, parts being separated by new lines.
30755 \begin_layout Description
30757 \change_inserted 1075283030 1597699866
30758 \begin_inset Flex Code
30761 \begin_layout Plain Layout
30763 \change_inserted 1075283030 1597699853
30764 DocBookItemInnerTagType
30772 \begin_inset Flex Code
30775 \begin_layout Plain Layout
30777 \change_inserted 1075283030 1597699866
30778 block, paragraph, inline
30785 ] The new-line policy for this tag, see Section
30786 \begin_inset space ~
30790 \begin_inset CommandInset ref
30792 reference "subsec:DocBook-New-line-policy"
30805 \begin_layout Description
30807 \change_inserted -970929547 1515111290
30808 \begin_inset Flex Code
30811 \begin_layout Plain Layout
30813 \change_inserted -970929547 1515111283
30814 DocBookItemLabelAttr
30822 \begin_inset Flex Code
30825 \begin_layout Plain Layout
30827 \change_inserted -970929547 1515111279
30835 ] Specifies attribute information to be output with the item label tag,
30837 \begin_inset Quotes eld
30841 \begin_inset Flex Code
30844 \begin_layout Plain Layout
30846 \change_inserted -970929547 1515111304
30855 \begin_inset Quotes erd
30858 in the example above.
30859 This information can be used in further processing of the DocBook files.
30863 \begin_layout Description
30865 \change_inserted -970929547 1515111337
30866 \begin_inset Flex Code
30869 \begin_layout Plain Layout
30871 \change_inserted -970929547 1515111285
30872 DocBookItemLabelTag
30880 \begin_inset Flex Code
30883 \begin_layout Plain Layout
30885 \change_inserted -970929547 1515111279
30893 ] The tag to be used for the item label tag within the inset, replacing
30895 \begin_inset Quotes eld
30899 \begin_inset Flex Code
30902 \begin_layout Plain Layout
30904 \change_inserted -970929547 1515111311
30913 \begin_inset Quotes erd
30916 in the example above.
30917 This parameter only makes sense when itemising layouts are used with a
30918 notion of labels, such as definition lists.
30920 \change_inserted 1075283030 1597699874
30924 \begin_layout Description
30926 \change_inserted 1075283030 1597699874
30927 \begin_inset Flex Code
30930 \begin_layout Plain Layout
30932 \change_inserted 1075283030 1597699880
30933 DocBookItemLabelTagType
30941 \begin_inset Flex Code
30944 \begin_layout Plain Layout
30946 \change_inserted 1075283030 1597699874
30947 block, paragraph, inline
30954 ] The new-line policy for this tag, see Section
30955 \begin_inset space ~
30959 \begin_inset CommandInset ref
30961 reference "subsec:DocBook-New-line-policy"
30974 \begin_layout Description
30976 \change_inserted -970929547 1515111124
30977 \begin_inset Flex Code
30980 \begin_layout Plain Layout
30982 \change_inserted -970929547 1515111060
30991 \begin_inset Flex Code
30994 \begin_layout Plain Layout
30996 \change_inserted -970929547 1515111060
31004 ] The tag to be used for the item tag within the inset, replacing
31005 \begin_inset Quotes eld
31009 \begin_inset Flex Code
31012 \begin_layout Plain Layout
31014 \change_inserted -970929547 1515111060
31023 \begin_inset Quotes erd
31026 in the example above.
31028 \begin_inset Flex Code
31031 \begin_layout Plain Layout
31033 \change_inserted -970929547 1515111060
31041 , indicating that there is no item tag.
31042 This parameter only makes sense when itemising layouts are used, such as
31045 \change_inserted 1075283030 1597699890
31049 \begin_layout Description
31051 \change_inserted 1075283030 1597699890
31052 \begin_inset Flex Code
31055 \begin_layout Plain Layout
31057 \change_inserted 1075283030 1597699890
31066 \begin_inset Flex Code
31069 \begin_layout Plain Layout
31071 \change_inserted 1075283030 1597699890
31072 block, paragraph, inline
31079 ] The new-line policy for this tag, see Section
31080 \begin_inset space ~
31084 \begin_inset CommandInset ref
31086 reference "subsec:DocBook-New-line-policy"
31099 \begin_layout Description
31101 \change_inserted -970929547 1515111298
31102 \begin_inset Flex Code
31105 \begin_layout Plain Layout
31107 \change_inserted -970929547 1515111124
31108 DocBookItemWrapperAttr
31116 \begin_inset Flex Code
31119 \begin_layout Plain Layout
31121 \change_inserted -970929547 1515111124
31129 ] Specifies attribute information to be output with the item wrapper tag,
31131 \begin_inset Quotes eld
31135 \begin_inset Flex Code
31138 \begin_layout Plain Layout
31140 \change_inserted -970929547 1515111150
31149 \begin_inset Quotes erd
31152 in the example above.
31153 This information can be used in further processing of the DocBook files.
31159 \begin_layout Description
31161 \change_inserted -970929547 1515111113
31162 \begin_inset Flex Code
31165 \begin_layout Plain Layout
31167 \change_inserted -970929547 1515111073
31168 DocBookItemWrapperTag
31176 \begin_inset Flex Code
31179 \begin_layout Plain Layout
31181 \change_inserted -970929547 1515111073
31189 ] The tag to be used for the item wrapper tag within the inset, replacing
31191 \begin_inset Quotes eld
31195 \begin_inset Flex Code
31198 \begin_layout Plain Layout
31200 \change_inserted -970929547 1515111083
31209 \begin_inset Quotes erd
31212 in the example above.
31214 \begin_inset Flex Code
31217 \begin_layout Plain Layout
31219 \change_inserted -970929547 1515111073
31227 , indicating that there is no item wrapper tag: tag and content are directly
31228 output without it for each itemised element.
31229 This parameter only makes sense when itemising layouts are used, such as
31232 \change_inserted 1075283030 1597699897
31236 \begin_layout Description
31238 \change_inserted 1075283030 1597699897
31239 \begin_inset Flex Code
31242 \begin_layout Plain Layout
31244 \change_inserted 1075283030 1597699900
31245 DocBookItemWrapperTagType
31253 \begin_inset Flex Code
31256 \begin_layout Plain Layout
31258 \change_inserted 1075283030 1597699897
31259 block, paragraph, inline
31266 ] The new-line policy for this tag, see Section
31267 \begin_inset space ~
31271 \begin_inset CommandInset ref
31273 reference "subsec:DocBook-New-line-policy"
31286 \begin_layout Description
31288 \change_inserted -970929547 1515110104
31289 \begin_inset Flex Code
31292 \begin_layout Plain Layout
31294 \change_inserted -970929547 1515110104
31303 \begin_inset Flex Code
31306 \begin_layout Plain Layout
31308 \change_inserted -970929547 1515110104
31316 ] Specifies attribute information to be output with the inner tag, replacing
31318 \begin_inset Quotes eld
31322 \begin_inset Flex Code
31325 \begin_layout Plain Layout
31327 \change_inserted -970929547 1515110104
31336 \begin_inset Quotes erd
31339 in the example above.
31340 This information can be used in further processing of the DocBook files.
31344 \begin_layout Description
31346 \change_inserted -970929547 1515110906
31347 \begin_inset Flex Code
31350 \begin_layout Plain Layout
31352 \change_inserted -970929547 1515110104
31361 \begin_inset Flex Code
31364 \begin_layout Plain Layout
31366 \change_inserted -970929547 1515110104
31374 ] The tag to be used for the inner tag within the inset, replacing
31375 \begin_inset Quotes eld
31379 \begin_inset Flex Code
31382 \begin_layout Plain Layout
31384 \change_inserted -970929547 1515110104
31393 \begin_inset Quotes erd
31396 in the example above.
31398 \begin_inset Flex Code
31401 \begin_layout Plain Layout
31403 \change_inserted -970929547 1515110791
31411 , indicating that there is no inner tag: content is directly output without
31413 \change_inserted 1075283030 1597699904
31417 \begin_layout Description
31419 \change_inserted 1075283030 1597699904
31420 \begin_inset Flex Code
31423 \begin_layout Plain Layout
31425 \change_inserted 1075283030 1597699904
31426 DocBookInnerTagType
31434 \begin_inset Flex Code
31437 \begin_layout Plain Layout
31439 \change_inserted 1075283030 1597699904
31440 block, paragraph, inline
31447 ] The new-line policy for this tag, see Section
31448 \begin_inset space ~
31452 \begin_inset CommandInset ref
31454 reference "subsec:DocBook-New-line-policy"
31467 \begin_layout Description
31469 \change_inserted -970929547 1515110753
31470 \begin_inset Flex Code
31473 \begin_layout Plain Layout
31475 \change_inserted -970929547 1515110665
31484 \begin_inset Flex Code
31487 \begin_layout Plain Layout
31489 \change_inserted -970929547 1515110661
31497 ] Specifies the tag that corresponds to this kind of section.
31498 This parameter only makes sense for sectioning elements (part, chapter,
31500 The default value is
31501 \begin_inset Flex Code
31504 \begin_layout Plain Layout
31506 \change_inserted -970929547 1515110721
31514 , and is only overridden when DocBook uses something else for sectioning
31516 \change_inserted 1075283030 1597699921
31518 \change_inserted -970929547 1515110753
31519 parts and chapters of a book).
31525 \begin_layout Description
31527 \change_inserted -970929547 1515110811
31528 \begin_inset Flex Code
31531 \begin_layout Plain Layout
31533 \change_inserted -970929547 1496612023
31542 \begin_inset Flex Code
31545 \begin_layout Plain Layout
31547 \change_inserted -970929547 1496610966
31555 ] The tag to be used for this inset, replacing
31556 \begin_inset Quotes eld
31560 \begin_inset Flex Code
31563 \begin_layout Plain Layout
31565 \change_inserted -970929547 1496612033
31574 \begin_inset Quotes erd
31577 in the example above.
31578 The default is the name of the float and always needs to be changed, as
31579 DocBook provides no generic inset tag.
31580 \change_inserted 1075283030 1597699924
31584 \begin_layout Description
31586 \change_inserted 1075283030 1597699924
31587 \begin_inset Flex Code
31590 \begin_layout Plain Layout
31592 \change_inserted 1075283030 1597699924
31601 \begin_inset Flex Code
31604 \begin_layout Plain Layout
31606 \change_inserted 1075283030 1597699924
31607 block, paragraph, inline
31614 ] The new-line policy for this tag, see Section
31615 \begin_inset space ~
31619 \begin_inset CommandInset ref
31621 reference "subsec:DocBook-New-line-policy"
31634 \begin_layout Description
31636 \change_inserted -970929547 1515110832
31637 \begin_inset Flex Code
31640 \begin_layout Plain Layout
31642 \change_inserted -970929547 1515110822
31651 \begin_inset Flex Code
31654 \begin_layout Plain Layout
31656 \change_inserted -970929547 1515110811
31664 ] Specifies attribute information to be output with the outer
31665 \change_inserted 34634807 1620057958
31667 \change_inserted -970929547 1515110832
31669 \begin_inset Quotes eld
31673 \begin_inset Flex Code
31676 \begin_layout Plain Layout
31678 \change_inserted -970929547 1515110845
31687 \begin_inset Quotes erd
31690 in the example above.
31691 This information can be used in further processing of the DocBook files.
31695 \begin_layout Description
31697 \change_inserted -970929547 1515110917
31698 \begin_inset Flex Code
31701 \begin_layout Plain Layout
31703 \change_inserted -970929547 1515110826
31712 \begin_inset Flex Code
31715 \begin_layout Plain Layout
31717 \change_inserted -970929547 1515110811
31725 ] The tag to be used for the wrapper tag around the inset, replacing
31726 \begin_inset Quotes eld
31730 \begin_inset Flex Code
31733 \begin_layout Plain Layout
31735 \change_inserted -970929547 1515110842
31744 \begin_inset Quotes erd
31747 in the example above.
31749 \begin_inset Flex Code
31752 \begin_layout Plain Layout
31754 \change_inserted -970929547 1515110811
31762 , indicating that there is no wrapper tag: tag and content are directly
31764 \change_inserted 1075283030 1597699929
31768 \begin_layout Description
31770 \change_inserted 1075283030 1597699929
31771 \begin_inset Flex Code
31774 \begin_layout Plain Layout
31776 \change_inserted 1075283030 1597699932
31777 DocBookWrapperTagType
31785 \begin_inset Flex Code
31788 \begin_layout Plain Layout
31790 \change_inserted 1075283030 1597699929
31791 block, paragraph, inline
31798 ] The new-line policy for this tag, see Section
31799 \begin_inset space ~
31803 \begin_inset CommandInset ref
31805 reference "subsec:DocBook-New-line-policy"
31818 \begin_layout Subsection
31820 \change_inserted -970929547 1515110040
31824 \begin_layout Standard
31826 \change_inserted -970929547 1496611700
31827 The DocBook output for floats too can be controlled by layout information.
31828 The output has the following form:
31831 \begin_layout LyX-Code
31833 \change_inserted -970929547 1515109700
31837 \begin_layout LyX-Code
31839 \change_inserted -970929547 1515110138
31840 Contents of the float as DocBook.
31843 \begin_layout LyX-Code
31845 \change_inserted -970929547 1496610966
31849 \begin_layout Standard
31851 \change_inserted -970929547 1496611715
31852 The caption, if there is one, is a separate inset and will be output as
31857 \begin_layout Description
31859 \change_inserted -970929547 1515110033
31860 \begin_inset Flex Code
31863 \begin_layout Plain Layout
31865 \change_inserted -970929547 1515109702
31874 \begin_inset Flex Code
31877 \begin_layout Plain Layout
31879 \change_inserted -970929547 1496610966
31887 ] Specifies attribute information to be output with the main tag, replacing
31889 \begin_inset Quotes eld
31893 \begin_inset Flex Code
31896 \begin_layout Plain Layout
31898 \change_inserted -970929547 1515110035
31907 \begin_inset Quotes erd
31910 in the example above.
31911 This information can be used in further processing of the DocBook files.
31915 \begin_layout Description
31917 \change_inserted -970929547 1515110157
31918 \begin_inset Flex Code
31921 \begin_layout Plain Layout
31923 \change_inserted -970929547 1496611782
31932 \begin_inset Flex Code
31935 \begin_layout Plain Layout
31937 \change_inserted -970929547 1496610966
31945 ] The tag to be used for this float, replacing
31946 \begin_inset Quotes eld
31950 \begin_inset Flex Code
31953 \begin_layout Plain Layout
31955 \change_inserted -970929547 1496610966
31964 \begin_inset Quotes erd
31967 in the example above.
31968 The default is the name of the float and always needs to be changed, as
31969 DocBook provides no generic float tag.
31972 \begin_layout Subsection
31974 \change_inserted -970929547 1515110157
31975 Bibliography formatting
31978 \begin_layout Standard
31980 \change_deleted 1075283030 1597699984
31982 \change_inserted 1075283030 1597699985
31984 \change_inserted -970929547 1515110187
31986 \change_deleted 1075283030 1597699987
31988 \change_inserted 1075283030 1597699987
31990 \change_inserted -970929547 1515110187
31991 cannot be formatted: all fields are always output in the database-like
31992 DocBook format (equivalent to a BibTeX file)
31993 \change_inserted 1075283030 1597700117
31995 \begin_inset Flex Code
31998 \begin_layout Plain Layout
32000 \change_inserted 1075283030 1597700120
32009 \change_inserted -970929547 1515110187
32011 \change_inserted 1075283030 1597700092
32015 \begin_layout Standard
32017 \change_inserted 1075283030 1597700112
32018 When the bibliographic entries are manually inserted into the
32019 \change_deleted 34634807 1620057319
32021 \change_inserted 34634807 1620057319
32024 \change_inserted 1075283030 1597700112
32025 document as Bibliography Items, the user deals with formatting
32028 \change_inserted 1075283030 1597700112
32029 self: there is no attempt of parsing what the user wrote, the string is
32030 directly used (with the
32031 \begin_inset Flex Code
32034 \begin_layout Plain Layout
32036 \change_inserted 1075283030 1597700076
32050 \begin_layout Chapter
32051 Including External Material
32052 \begin_inset CommandInset label
32054 name "chap:Including-External-Material"
32061 \begin_layout Standard
32062 \begin_inset Box Shadowbox
32072 height_special "totalheight"
32077 backgroundcolor "none"
32080 \begin_layout Plain Layout
32081 WARNING: This portion of the documentation has not been updated for some
32083 We certainly hope that it is still accurate, but there are no guarantees.
32091 \begin_layout Standard
32092 The use of material from sources external to \SpecialChar LyX
32093 is covered in detail in the
32099 This part of the manual covers what needs to happen behind the scenes for
32100 new sorts of material to be included.
32103 \begin_layout Section
32107 \begin_layout Standard
32108 The external material feature is based on the concept of a
32113 A template is a specification of how \SpecialChar LyX
32114 should interface with a certain kind
32116 As bundled, \SpecialChar LyX
32117 comes with predefined templates for Xfig figures, various
32118 raster format images, chess diagrams, and LilyPond music notation.
32119 You can check the actual list by using the menu
32120 \begin_inset Flex Noun
32123 \begin_layout Plain Layout
32124 Insert\SpecialChar menuseparator
32125 File\SpecialChar menuseparator
32132 Furthermore, it is possible to roll your own template to support a specific
32134 Later we'll describe in more detail what is involved, and hopefully you
32135 will submit all the templates you create so we can include them in a later
32140 \begin_layout Standard
32141 Another basic idea of the external material feature is to distinguish between
32142 the original file that serves as a base for final material and the produced
32143 file that is included in your exported or printed document.
32144 For example, consider the case of a figure produced with
32145 \begin_inset Flex Code
32148 \begin_layout Plain Layout
32155 The Xfig application itself works on an original file with the
32156 \begin_inset Flex Code
32159 \begin_layout Plain Layout
32166 Within Xfig, you create and change your figure, and when you are done,
32168 \begin_inset Flex Code
32171 \begin_layout Plain Layout
32178 When you want to include the figure in your document, you invoke
32179 \begin_inset Flex Code
32182 \begin_layout Plain Layout
32188 in order to create a PostScript file that can readily be included in your
32192 \begin_inset Flex Code
32195 \begin_layout Plain Layout
32201 file is the original file, and the PostScript file is the produced file.
32204 \begin_layout Standard
32205 This distinction is important in order to allow updating of the material
32206 while you are in the process of writing the document.
32207 Furthermore, it provides us with the flexibility that is needed to support
32208 multiple export formats.
32209 For instance, in the case of a plain text file, it is not exactly an award-winn
32210 ing idea to include the figure as raw PostScript.
32211 Instead, you would either prefer to just include a reference to the figure
32212 or try to invoke some graphics to ASCII converter to make the final result
32213 look similar to the real graphics.
32214 The external material management allows you to do this, because it is parametri
32215 zed on the different export formats that \SpecialChar LyX
32219 \begin_layout Standard
32220 Besides supporting the production of different products according to the
32221 exported format, it supports tight integration with editing and viewing
32223 In the case of an Xfig figure, you are able to invoke Xfig on the original
32224 file with a single click from within the external material dialog in \SpecialChar LyX
32226 and also preview the produced PostScript file with Ghostview with another
32228 No more fiddling around with the command line and/or file browsers to locate
32229 and manipulate the original or produced files.
32230 In this way, you are finally able to take full advantage of the many different
32231 applications that are relevant to use when you write your documents, and
32232 ultimately be more productive.
32235 \begin_layout Section
32236 The external template configuration files
32239 \begin_layout Standard
32240 It is relatively easy to add custom external template definitions to \SpecialChar LyX
32242 However, be aware that doing this in an careless manner most probably
32246 introduce an easily exploitable security hole.
32247 So before you do this, please read the discussion about security in
32248 \begin_inset CommandInset ref
32250 reference "sec:Security-discussion"
32257 \begin_layout Standard
32258 Having said that, we encourage you to submit any interesting templates that
32263 \begin_layout Standard
32264 The external templates are defined in the
32265 \begin_inset Flex Code
32268 \begin_layout Plain Layout
32274 files that are stored in the
32275 \begin_inset Flex Code
32278 \begin_layout Plain Layout
32279 LyXDir/lib/xtemplates/
32285 Each template is defined in a file of its own.
32286 You can place your own templates in
32287 \begin_inset Flex Code
32290 \begin_layout Plain Layout
32291 UserDir/xtemplates/
32296 or copy existing templates to that directory in order to modify them.
32299 \begin_layout Standard
32300 A typical template looks like this:
32303 \begin_layout LyX-Code
32307 \begin_layout LyX-Code
32308 GuiName "XFig: $$AbsOrRelPathParent$$Basename"
32311 \begin_layout LyX-Code
32315 \begin_layout LyX-Code
32319 \begin_layout LyX-Code
32323 \begin_layout LyX-Code
32327 \begin_layout LyX-Code
32331 \begin_layout LyX-Code
32332 AutomaticProduction true
32335 \begin_layout LyX-Code
32339 \begin_layout LyX-Code
32343 \begin_layout LyX-Code
32347 \begin_layout LyX-Code
32348 TransformCommand Rotate RotationLatexCommand
32351 \begin_layout LyX-Code
32352 TransformCommand Resize ResizeLatexCommand
32355 \begin_layout LyX-Code
32356 Product "$$RotateFront$$ResizeFront
32359 \begin_layout LyX-Code
32364 input{$$AbsOrRelPathMaster$$Basename.pstex_t}
32367 \begin_layout LyX-Code
32368 $$ResizeBack$$RotateBack"
32371 \begin_layout LyX-Code
32375 \begin_layout LyX-Code
32376 UpdateResult "$$AbsPath$$Basename.pstex_t"
32379 \begin_layout LyX-Code
32380 Requirement "graphicx"
32383 \begin_layout LyX-Code
32384 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
32387 \begin_layout LyX-Code
32388 ReferencedFile latex "$$AbsPath$$Basename.eps"
32391 \begin_layout LyX-Code
32392 ReferencedFile dvi "$$AbsPath$$Basename.eps"
32395 \begin_layout LyX-Code
32399 \begin_layout LyX-Code
32403 \begin_layout LyX-Code
32404 TransformCommand Rotate RotationLatexCommand
32407 \begin_layout LyX-Code
32408 TransformCommand Resize ResizeLatexCommand
32411 \begin_layout LyX-Code
32412 Product "$$RotateFront$$ResizeFront
32415 \begin_layout LyX-Code
32420 input{$$AbsOrRelPathMaster$$Basename.pdftex_t}
32423 \begin_layout LyX-Code
32424 $$ResizeBack$$RotateBack"
32427 \begin_layout LyX-Code
32428 UpdateFormat pdftex
32431 \begin_layout LyX-Code
32432 UpdateResult "$$AbsPath$$Basename.pdftex_t"
32435 \begin_layout LyX-Code
32436 Requirement "graphicx"
32439 \begin_layout LyX-Code
32440 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pdftex_t"
32443 \begin_layout LyX-Code
32444 ReferencedFile latex "$$AbsPath$$Basename.pdf"
32447 \begin_layout LyX-Code
32451 \begin_layout LyX-Code
32455 \begin_layout LyX-Code
32456 Product "[XFig: $$FName]"
32459 \begin_layout LyX-Code
32463 \begin_layout LyX-Code
32467 \begin_layout LyX-Code
32468 Product "<graphic fileref=
32470 "$$AbsOrRelPathMaster$$Basename.eps
32475 \begin_layout LyX-Code
32479 \begin_layout LyX-Code
32483 \begin_layout LyX-Code
32484 UpdateResult "$$AbsPath$$Basename.eps"
32487 \begin_layout LyX-Code
32488 ReferencedFile docbook "$$AbsPath$$Basename.eps"
32491 \begin_layout LyX-Code
32492 ReferencedFile docbook-xml "$$AbsPath$$Basename.eps"
32495 \begin_layout LyX-Code
32499 \begin_layout LyX-Code
32503 \begin_layout Standard
32504 As you can see, the template is enclosed in
32505 \begin_inset Flex Code
32508 \begin_layout Plain Layout
32516 \begin_inset Flex Code
32519 \begin_layout Plain Layout
32526 It contains a header specifying some general settings and, for each supported
32527 primary document file format, a section
32528 \begin_inset Flex Code
32531 \begin_layout Plain Layout
32539 \begin_inset Flex Code
32542 \begin_layout Plain Layout
32551 \begin_layout Subsection
32552 The template header
32555 \begin_layout Description
32556 \begin_inset Flex Code
32559 \begin_layout Plain Layout
32560 AutomaticProduction
32561 \begin_inset space ~
32569 Whether the file represented by the template must be generated by \SpecialChar LyX
32571 This command must occur exactly once.
32574 \begin_layout Description
32575 \begin_inset Flex Code
32578 \begin_layout Plain Layout
32580 \begin_inset space ~
32588 A glob pattern that is used in the file dialog to filter out the desired
32590 If there is more than one possible file extension (e.
32591 \begin_inset space \thinspace{}
32595 \begin_inset space \space{}
32599 \begin_inset Flex Code
32602 \begin_layout Plain Layout
32609 \begin_inset Flex Code
32612 \begin_layout Plain Layout
32618 ), use something like
32619 \begin_inset Flex Code
32622 \begin_layout Plain Layout
32629 This command must occur exactly once.
32632 \begin_layout Description
32633 \begin_inset Flex Code
32636 \begin_layout Plain Layout
32638 \begin_inset space ~
32646 The text that is displayed on the button.
32647 This command must occur exactly once.
32650 \begin_layout Description
32651 \begin_inset Flex Code
32654 \begin_layout Plain Layout
32656 \begin_inset space ~
32660 \begin_inset space ~
32668 The help text that is used in the External dialog.
32669 Provide enough information to explain to the user just what the template
32670 can provide him with.
32671 This command must occur exactly once.
32674 \begin_layout Description
32675 \begin_inset Flex Code
32678 \begin_layout Plain Layout
32680 \begin_inset space ~
32688 The file format of the original file.
32689 This must be the name of a format that is known to \SpecialChar LyX
32691 \begin_inset CommandInset ref
32693 reference "sec:Formats"
32699 \begin_inset Quotes eld
32703 \begin_inset Flex Code
32706 \begin_layout Plain Layout
32713 \begin_inset Quotes erd
32716 if the template can handle original files of more than one format.
32718 will attempt to interrogate the file itself in order to deduce its format
32720 This command must occur exactly once.
32723 \begin_layout Description
32724 \begin_inset Flex Code
32727 \begin_layout Plain Layout
32729 \begin_inset space ~
32737 A unique name for the template.
32738 It must not contain substitution macros (see below).
32741 \begin_layout Description
32742 \begin_inset Flex Code
32745 \begin_layout Plain Layout
32747 \begin_inset space ~
32750 Rotate|Resize|Clip|Extra
32755 This command specifies which transformations are supported by this template.
32756 It may occur zero or more times.
32757 This command enables the corresponding tabs in the external dialog.
32759 \begin_inset Flex Code
32762 \begin_layout Plain Layout
32768 command must have either a corresponding
32769 \begin_inset Flex Code
32772 \begin_layout Plain Layout
32779 \begin_inset Flex Code
32782 \begin_layout Plain Layout
32789 \begin_inset Flex Code
32792 \begin_layout Plain Layout
32799 Otherwise the transformation will not be supported by that format.
32802 \begin_layout Subsection
32806 \begin_layout Description
32807 \begin_inset Flex Code
32810 \begin_layout Plain Layout
32812 \begin_inset space ~
32815 LaTeX|PDFLaTeX|PlainText|DocBook|XHTML
32820 The primary document file format that this format definition is for.
32821 Not every template has a sensible representation in all document file formats.
32822 Please define nevertheless a
32823 \begin_inset Flex Code
32826 \begin_layout Plain Layout
32832 section for all templates.
32833 Use a dummy text when no representation is available.
32834 Then you can at least see a reference to the external material in the exported
32838 \begin_layout Description
32839 \begin_inset Flex Code
32842 \begin_layout Plain Layout
32844 \begin_inset space ~
32848 \begin_inset space ~
32856 This command defines an additional macro
32857 \begin_inset Flex Code
32860 \begin_layout Plain Layout
32866 for substitution in
32867 \begin_inset Flex Code
32870 \begin_layout Plain Layout
32878 \begin_inset Flex Code
32881 \begin_layout Plain Layout
32887 itself may contain substitution macros.
32888 The advantage over using
32889 \begin_inset Flex Code
32892 \begin_layout Plain Layout
32899 \begin_inset Flex Code
32902 \begin_layout Plain Layout
32908 is that the substituted value of
32909 \begin_inset Flex Code
32912 \begin_layout Plain Layout
32918 is sanitized so that it is a valid optional argument in the document format.
32919 This command may occur zero or more times.
32922 \begin_layout Description
32923 \begin_inset Flex Code
32926 \begin_layout Plain Layout
32928 \begin_inset space ~
32936 The text that is inserted in the exported document.
32937 This is actually the most important command and can be quite complex.
32938 This command must occur exactly once.
32941 \begin_layout Description
32942 \begin_inset Flex Code
32945 \begin_layout Plain Layout
32947 \begin_inset space ~
32955 This command specifies a preamble snippet that will be included in the
32958 It has to be defined using
32959 \begin_inset Flex Code
32962 \begin_layout Plain Layout
32970 \begin_inset Flex Code
32973 \begin_layout Plain Layout
32980 This command may occur zero or more times.
32983 \begin_layout Description
32984 \begin_inset Flex Code
32987 \begin_layout Plain Layout
32989 \begin_inset space ~
32993 \begin_inset space ~
33001 This command denotes files that are created by the conversion process and
33002 are needed for a particular export format.
33003 If the filename is relative, it is interpreted relative to the master document.
33004 This command may be given zero or more times.
33007 \begin_layout Description
33008 \begin_inset Flex Code
33011 \begin_layout Plain Layout
33013 \begin_inset space ~
33021 The name of a required \SpecialChar LaTeX
33023 The package is included via
33024 \begin_inset Flex Code
33027 \begin_layout Plain Layout
33035 in the \SpecialChar LaTeX
33037 This command may occur zero or more times.
33040 \begin_layout Description
33041 \begin_inset Flex Code
33044 \begin_layout Plain Layout
33046 \begin_inset space ~
33050 \begin_inset space ~
33053 RotationLatexCommand
33058 This command specifies that the built in \SpecialChar LaTeX
33059 command should be used for rotation.
33060 This command may occur once or not at all.
33063 \begin_layout Description
33064 \begin_inset Flex Code
33067 \begin_layout Plain Layout
33069 \begin_inset space ~
33073 \begin_inset space ~
33081 This command specifies that the built in \SpecialChar LaTeX
33082 command should be used for resizing.
33083 This command may occur once or not at all.
33086 \begin_layout Description
33087 \begin_inset Flex Code
33090 \begin_layout Plain Layout
33092 \begin_inset space ~
33096 \begin_inset space ~
33099 RotationLatexOption
33104 This command specifies that rotation is done via an optional argument.
33105 This command may occur once or not at all.
33108 \begin_layout Description
33109 \begin_inset Flex Code
33112 \begin_layout Plain Layout
33114 \begin_inset space ~
33118 \begin_inset space ~
33126 This command specifies that resizing is done via an optional argument.
33127 This command may occur once or not at all.
33130 \begin_layout Description
33131 \begin_inset Flex Code
33134 \begin_layout Plain Layout
33136 \begin_inset space ~
33140 \begin_inset space ~
33148 This command specifies that clipping is done via an optional argument.
33149 This command may occur once or not at all.
33152 \begin_layout Description
33153 \begin_inset Flex Code
33156 \begin_layout Plain Layout
33158 \begin_inset space ~
33162 \begin_inset space ~
33170 This command specifies that an extra optional argument is used.
33171 This command may occur once or not at all.
33174 \begin_layout Description
33175 \begin_inset Flex Code
33178 \begin_layout Plain Layout
33180 \begin_inset space ~
33188 The file format of the converted file.
33189 This must be the name of a format that is known to \SpecialChar LyX
33191 \begin_inset Flex Noun
33194 \begin_layout Plain Layout
33195 Tools\SpecialChar menuseparator
33196 Preferences\SpecialChar menuseparator
33197 File Handling\SpecialChar menuseparator
33204 This command must occur exactly once.
33205 If the resulting file format is PDF, you need to specify the format
33206 \begin_inset Flex Code
33209 \begin_layout Plain Layout
33216 This is the PDF format used for including graphics.
33217 The other defined PDF formats are for document export.
33220 \begin_layout Description
33221 \begin_inset Flex Code
33224 \begin_layout Plain Layout
33226 \begin_inset space ~
33234 The file name of the converted file.
33235 The file name must be absolute.
33236 This command must occur exactly once.
33239 \begin_layout Subsection
33240 Preamble definitions
33243 \begin_layout Standard
33244 The external template configuration file may contain additional preamble
33245 definitions enclosed by
33246 \begin_inset Flex Code
33249 \begin_layout Plain Layout
33257 \begin_inset Flex Code
33260 \begin_layout Plain Layout
33267 They can be used by the templates in the
33268 \begin_inset Flex Code
33271 \begin_layout Plain Layout
33280 \begin_layout Section
33281 The substitution mechanism
33284 \begin_layout Standard
33285 When the external material facility invokes an external program, it is done
33286 on the basis of a command defined in the template configuration file.
33287 These commands can contain various macros that are expanded before execution.
33288 Execution always take place in the directory of the containing document.
33291 \begin_layout Standard
33292 Also, whenever external material is to be displayed, the name will be produced
33293 by the substitution mechanism, and most other commands in the template
33294 definition support substitution as well.
33297 \begin_layout Standard
33298 The available macros are the following:
33301 \begin_layout Description
33302 \begin_inset Flex Code
33305 \begin_layout Plain Layout
33306 $$AbsOrRelPathMaster
33311 The file path, absolute or relative to the master \SpecialChar LyX
33315 \begin_layout Description
33316 \begin_inset Flex Code
33319 \begin_layout Plain Layout
33320 $$AbsOrRelPathParent
33325 The file path, absolute or relative to the \SpecialChar LyX
33329 \begin_layout Description
33330 \begin_inset Flex Code
33333 \begin_layout Plain Layout
33339 The absolute file path.
33342 \begin_layout Description
33343 \begin_inset Flex Code
33346 \begin_layout Plain Layout
33352 The filename without path and without the extension.
33355 \begin_layout Description
33356 \begin_inset Flex Code
33359 \begin_layout Plain Layout
33361 \begin_inset Quotes eld
33365 \begin_inset Quotes erd
33373 This macro will expand to the contents of the file with the name
33374 \begin_inset Flex Code
33377 \begin_layout Plain Layout
33386 \begin_layout Description
33387 \begin_inset Flex Code
33390 \begin_layout Plain Layout
33396 The file extension (including the dot).
33399 \begin_layout Description
33400 \begin_inset Flex Code
33403 \begin_layout Plain Layout
33409 This will be the string
33410 \begin_inset Quotes eld
33414 \begin_inset Quotes erd
33417 if the file is in JPEG format, otherwise it will be the string
33418 \begin_inset Quotes eld
33422 \begin_inset Quotes erd
33426 This is useful to avoid uneeded conversions for output formats that support
33427 both PNG and JPEG fomats.
33428 The predefined RasterImage template uses this macro for the pdf\SpecialChar TeX
33433 \begin_layout Description
33434 \begin_inset Flex Code
33437 \begin_layout Plain Layout
33443 The filename of the file specified in the external material dialog.
33444 This is either an absolute name, or it is relative to the \SpecialChar LyX
33448 \begin_layout Description
33449 \begin_inset Flex Code
33452 \begin_layout Plain Layout
33459 \begin_inset Flex Code
33462 \begin_layout Plain Layout
33468 (absolute name or relative to the \SpecialChar LyX
33472 \begin_layout Description
33473 \begin_inset Flex Code
33476 \begin_layout Plain Layout
33482 The file path, relative to the master \SpecialChar LyX
33486 \begin_layout Description
33487 \begin_inset Flex Code
33490 \begin_layout Plain Layout
33496 The file path, relative to the \SpecialChar LyX
33500 \begin_layout Description
33501 \begin_inset Flex Code
33504 \begin_layout Plain Layout
33510 This macro will expand to the absolute path of the system directory.
33511 This is typically used to point to the various helper scripts that are
33512 bundled with \SpecialChar LyX
33516 \begin_layout Description
33517 \begin_inset Flex Code
33520 \begin_layout Plain Layout
33526 A name and full path to a temporary file which will be automatically deleted
33527 whenever the containing document is closed, or the external material insertion
33531 \begin_layout Standard
33532 All path macros contain a trailing directory separator, so you can construct
33534 \begin_inset space \thinspace{}
33538 \begin_inset space \space{}
33541 the absolute filename with
33542 \begin_inset Flex Code
33545 \begin_layout Plain Layout
33546 $$AbsPath$$Basename$$Extension
33554 \begin_layout Standard
33555 The macros above are substituted in all commands unless otherwise noted.
33557 \begin_inset Flex Code
33560 \begin_layout Plain Layout
33566 supports additionally the following substitutions if they are enabled by
33568 \begin_inset Flex Code
33571 \begin_layout Plain Layout
33578 \begin_inset Flex Code
33581 \begin_layout Plain Layout
33590 \begin_layout Description
33591 \begin_inset Flex Code
33594 \begin_layout Plain Layout
33600 The front part of the resize command.
33603 \begin_layout Description
33604 \begin_inset Flex Code
33607 \begin_layout Plain Layout
33613 The back part of the resize command.
33616 \begin_layout Description
33617 \begin_inset Flex Code
33620 \begin_layout Plain Layout
33626 The front part of the rotation command.
33629 \begin_layout Description
33630 \begin_inset Flex Code
33633 \begin_layout Plain Layout
33639 The back part of the rotation command.
33642 \begin_layout Standard
33643 The value string of the
33644 \begin_inset Flex Code
33647 \begin_layout Plain Layout
33653 command supports additionally the following substitutions if they are enabled
33655 \begin_inset Flex Code
33658 \begin_layout Plain Layout
33665 \begin_inset Flex Code
33668 \begin_layout Plain Layout
33677 \begin_layout Description
33678 \begin_inset Flex Code
33681 \begin_layout Plain Layout
33690 \begin_layout Description
33691 \begin_inset Flex Code
33694 \begin_layout Plain Layout
33703 \begin_layout Description
33704 \begin_inset Flex Code
33707 \begin_layout Plain Layout
33716 \begin_layout Description
33717 \begin_inset Flex Code
33720 \begin_layout Plain Layout
33726 The rotation option.
33729 \begin_layout Standard
33730 You may ask why there are so many path macros.
33731 There are mainly two reasons:
33734 \begin_layout Enumerate
33735 Relative and absolute file names should remain relative or absolute, respectivel
33737 Users may have reasons to prefer either form.
33738 Relative names are useful for portable documents that should work on different
33739 machines, for example.
33740 Absolute names may be required by some programs.
33743 \begin_layout Enumerate
33745 treats relative file names differently than \SpecialChar LyX
33746 and other programs in nested
33748 For \SpecialChar LyX
33749 , a relative file name is always relative to the document that contains
33751 For \SpecialChar LaTeX
33752 , it is always relative to the master document.
33753 These two definitions are identical if you have only one document, but
33754 differ if you have a master document that includes part documents.
33755 That means that relative filenames must be transformed when presented to
33758 Fortunately \SpecialChar LyX
33759 does this automatically for you if you choose the right macros.
33762 \begin_layout Standard
33763 So which path macro should be used in new template definitions? The rule
33767 \begin_layout Itemize
33769 \begin_inset Flex Code
33772 \begin_layout Plain Layout
33778 if an absolute path is required.
33781 \begin_layout Itemize
33783 \begin_inset Flex Code
33786 \begin_layout Plain Layout
33787 $$AbsOrRelPathMaster
33792 if the substituted string is some kind of \SpecialChar LaTeX
33796 \begin_layout Itemize
33798 \begin_inset Flex Code
33801 \begin_layout Plain Layout
33802 $$AbsOrRelPathParent
33807 in order to preserve the user's choice.
33810 \begin_layout Standard
33811 There are special cases where this rule does not work and e.
33812 \begin_inset space \thinspace{}
33816 \begin_inset space \space{}
33819 relative names are needed, but normally it will work just fine.
33820 One example for such a case is the command
33821 \begin_inset Flex Code
33824 \begin_layout Plain Layout
33825 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
33830 in the XFig template above: We can't use the absolute name because the
33832 \begin_inset Flex Code
33835 \begin_layout Plain Layout
33841 files needs the relative name in order to rewrite the file content.
33844 \begin_layout Section
33845 Security discussion
33846 \begin_inset CommandInset label
33848 name "sec:Security-discussion"
33855 \begin_layout Standard
33856 The external material feature interfaces with a lot of external programs
33857 and does so automatically, so we have to consider the security implications
33859 In particular, since you have the option of including your own filenames
33860 and/or parameter strings and those are expanded into a command, it seems
33861 that it would be possible to create a malicious document which executes
33862 arbitrary commands when a user views or prints the document.
33863 This is something we definitely want to avoid.
33866 \begin_layout Standard
33867 However, since the external program commands are specified in the template
33868 configuration file only, there are no security issues if \SpecialChar LyX
33869 is properly configure
33870 d with safe templates only.
33871 This is so because the external programs are invoked with the
33872 \begin_inset Flex Code
33875 \begin_layout Plain Layout
33881 -system call rather than the
33882 \begin_inset Flex Code
33885 \begin_layout Plain Layout
33891 system-call, so it's not possible to execute arbitrary commands from the
33892 filename or parameter section via the shell.
33895 \begin_layout Standard
33896 This also implies that you are restricted in what command strings you can
33897 use in the external material templates.
33898 In particular, pipes and redirection are not readily available.
33899 This has to be so if \SpecialChar LyX
33900 should remain safe.
33901 If you want to use some of the shell features, you should write a safe
33902 script to do this in a controlled manner, and then invoke the script from
33903 the command string.
33907 \begin_layout Standard
33908 It is possible to design a template that interacts directly with the shell,
33909 but since this would allow a malicious user to execute arbitrary commands
33910 by writing clever filenames and/or parameters, we generally recommend that
33911 you only use safe scripts that work with the
33912 \begin_inset Flex Code
33915 \begin_layout Plain Layout
33921 system call in a controlled manner.
33922 Of course, for use in a controlled environment, it can be tempting to just
33923 fall back to use ordinary shell scripts.
33924 If you do so, be aware that you
33928 provide an easily exploitable security hole in your system.
33929 Of course it stands to reason that such unsafe templates will never be
33930 included in the standard \SpecialChar LyX
33931 distribution, although we do encourage people
33932 to submit new templates in the open source tradition.
33933 But \SpecialChar LyX
33934 as shipped from the official distribution channels will never have
33938 \begin_layout Standard
33939 Including external material provides a lot of power, and you have to be
33940 careful not to introduce security hazards with this power.
33941 A subtle error in a single line in an innocent looking script can open
33942 the door to huge security problems.
33943 So if you do not fully understand the issues, we recommend that you consult
33944 a knowledgeable security professional or the \SpecialChar LyX
33945 development team if you have
33946 any questions about whether a given template is safe or not.
33947 And do this before you use it in an uncontrolled environment.
33950 \begin_layout Chapter
33952 List of supported \SpecialChar LyX
33953 functions to be used in layouts
33954 \begin_inset CommandInset label
33956 name "chap:List-of-functions"
33963 \begin_layout Standard
33965 \begin_inset Tabular
33966 <lyxtabular version="3" rows="11" columns="8">
33967 <features tabularvalignment="middle">
33968 <column alignment="left" valignment="top">
33969 <column alignment="left" valignment="top">
33970 <column alignment="left" valignment="top">
33971 <column alignment="left" valignment="top">
33972 <column alignment="left" valignment="top">
33973 <column alignment="left" valignment="top">
33974 <column alignment="left" valignment="top">
33975 <column alignment="left" valignment="top">
33977 <cell alignment="left" valignment="top" usebox="none">
33980 \begin_layout Plain Layout
33986 <cell alignment="left" valignment="top" usebox="none">
33989 \begin_layout Plain Layout
33995 <cell alignment="left" valignment="top" usebox="none">
33998 \begin_layout Plain Layout
34004 <cell alignment="left" valignment="top" usebox="none">
34007 \begin_layout Plain Layout
34013 <cell alignment="center" valignment="top" usebox="none">
34016 \begin_layout Plain Layout
34022 <cell alignment="center" valignment="top" usebox="none">
34025 \begin_layout Plain Layout
34031 <cell alignment="center" valignment="top" usebox="none">
34034 \begin_layout Plain Layout
34040 <cell alignment="center" valignment="top" usebox="none">
34043 \begin_layout Plain Layout
34051 <cell alignment="left" valignment="top" usebox="none">
34054 \begin_layout Plain Layout
34060 <cell alignment="left" valignment="top" usebox="none">
34063 \begin_layout Plain Layout
34069 <cell alignment="left" valignment="top" usebox="none">
34072 \begin_layout Plain Layout
34078 <cell alignment="left" valignment="top" usebox="none">
34081 \begin_layout Plain Layout
34087 <cell alignment="center" valignment="top" usebox="none">
34090 \begin_layout Plain Layout
34096 <cell alignment="center" valignment="top" usebox="none">
34099 \begin_layout Plain Layout
34105 <cell alignment="center" valignment="top" usebox="none">
34108 \begin_layout Plain Layout
34114 <cell alignment="center" valignment="top" usebox="none">
34117 \begin_layout Plain Layout
34125 <cell alignment="left" valignment="top" usebox="none">
34128 \begin_layout Plain Layout
34134 <cell alignment="left" valignment="top" usebox="none">
34137 \begin_layout Plain Layout
34143 <cell alignment="left" valignment="top" usebox="none">
34146 \begin_layout Plain Layout
34152 <cell alignment="left" valignment="top" usebox="none">
34155 \begin_layout Plain Layout
34161 <cell alignment="center" valignment="top" usebox="none">
34164 \begin_layout Plain Layout
34170 <cell alignment="center" valignment="top" usebox="none">
34173 \begin_layout Plain Layout
34179 <cell alignment="center" valignment="top" usebox="none">
34182 \begin_layout Plain Layout
34188 <cell alignment="center" valignment="top" usebox="none">
34191 \begin_layout Plain Layout
34199 <cell alignment="left" valignment="top" usebox="none">
34202 \begin_layout Plain Layout
34208 <cell alignment="left" valignment="top" usebox="none">
34211 \begin_layout Plain Layout
34217 <cell alignment="left" valignment="top" usebox="none">
34220 \begin_layout Plain Layout
34226 <cell alignment="left" valignment="top" usebox="none">
34229 \begin_layout Plain Layout
34235 <cell alignment="center" valignment="top" usebox="none">
34238 \begin_layout Plain Layout
34244 <cell alignment="center" valignment="top" usebox="none">
34247 \begin_layout Plain Layout
34253 <cell alignment="center" valignment="top" usebox="none">
34256 \begin_layout Plain Layout
34262 <cell alignment="center" valignment="top" usebox="none">
34265 \begin_layout Plain Layout
34273 <cell alignment="left" valignment="top" usebox="none">
34276 \begin_layout Plain Layout
34282 <cell alignment="left" valignment="top" usebox="none">
34285 \begin_layout Plain Layout
34291 <cell alignment="left" valignment="top" usebox="none">
34294 \begin_layout Plain Layout
34300 <cell alignment="left" valignment="top" usebox="none">
34303 \begin_layout Plain Layout
34309 <cell alignment="center" valignment="top" usebox="none">
34312 \begin_layout Plain Layout
34318 <cell alignment="center" valignment="top" usebox="none">
34321 \begin_layout Plain Layout
34327 <cell alignment="center" valignment="top" usebox="none">
34330 \begin_layout Plain Layout
34336 <cell alignment="center" valignment="top" usebox="none">
34339 \begin_layout Plain Layout
34347 <cell alignment="left" valignment="top" usebox="none">
34350 \begin_layout Plain Layout
34356 <cell alignment="left" valignment="top" usebox="none">
34359 \begin_layout Plain Layout
34365 <cell alignment="left" valignment="top" usebox="none">
34368 \begin_layout Plain Layout
34374 <cell alignment="left" valignment="top" usebox="none">
34377 \begin_layout Plain Layout
34383 <cell alignment="center" valignment="top" usebox="none">
34386 \begin_layout Plain Layout
34392 <cell alignment="center" valignment="top" usebox="none">
34395 \begin_layout Plain Layout
34401 <cell alignment="center" valignment="top" usebox="none">
34404 \begin_layout Plain Layout
34410 <cell alignment="center" valignment="top" usebox="none">
34413 \begin_layout Plain Layout
34421 <cell alignment="left" valignment="top" usebox="none">
34424 \begin_layout Plain Layout
34430 <cell alignment="left" valignment="top" usebox="none">
34433 \begin_layout Plain Layout
34439 <cell alignment="left" valignment="top" usebox="none">
34442 \begin_layout Plain Layout
34448 <cell alignment="left" valignment="top" usebox="none">
34451 \begin_layout Plain Layout
34457 <cell alignment="center" valignment="top" usebox="none">
34460 \begin_layout Plain Layout
34466 <cell alignment="center" valignment="top" usebox="none">
34469 \begin_layout Plain Layout
34475 <cell alignment="center" valignment="top" usebox="none">
34478 \begin_layout Plain Layout
34484 <cell alignment="center" valignment="top" usebox="none">
34487 \begin_layout Plain Layout
34495 <cell alignment="left" valignment="top" usebox="none">
34498 \begin_layout Plain Layout
34504 <cell alignment="left" valignment="top" usebox="none">
34507 \begin_layout Plain Layout
34513 <cell alignment="left" valignment="top" usebox="none">
34516 \begin_layout Plain Layout
34522 <cell alignment="left" valignment="top" usebox="none">
34525 \begin_layout Plain Layout
34531 <cell alignment="center" valignment="top" usebox="none">
34534 \begin_layout Plain Layout
34540 <cell alignment="center" valignment="top" usebox="none">
34543 \begin_layout Plain Layout
34549 <cell alignment="center" valignment="top" usebox="none">
34552 \begin_layout Plain Layout
34558 <cell alignment="center" valignment="top" usebox="none">
34561 \begin_layout Plain Layout
34569 <cell alignment="left" valignment="top" usebox="none">
34572 \begin_layout Plain Layout
34578 <cell alignment="left" valignment="top" usebox="none">
34581 \begin_layout Plain Layout
34587 <cell alignment="left" valignment="top" usebox="none">
34590 \begin_layout Plain Layout
34596 <cell alignment="left" valignment="top" usebox="none">
34599 \begin_layout Plain Layout
34605 <cell alignment="center" valignment="top" usebox="none">
34608 \begin_layout Plain Layout
34614 <cell alignment="center" valignment="top" usebox="none">
34617 \begin_layout Plain Layout
34623 <cell alignment="center" valignment="top" usebox="none">
34626 \begin_layout Plain Layout
34632 <cell alignment="center" valignment="top" usebox="none">
34635 \begin_layout Plain Layout
34643 <cell alignment="left" valignment="top" usebox="none">
34646 \begin_layout Plain Layout
34652 <cell alignment="left" valignment="top" usebox="none">
34655 \begin_layout Plain Layout
34661 <cell alignment="left" valignment="top" usebox="none">
34664 \begin_layout Plain Layout
34670 <cell alignment="left" valignment="top" usebox="none">
34673 \begin_layout Plain Layout
34679 <cell alignment="center" valignment="top" usebox="none">
34682 \begin_layout Plain Layout
34688 <cell alignment="center" valignment="top" usebox="none">
34691 \begin_layout Plain Layout
34697 <cell alignment="center" valignment="top" usebox="none">
34700 \begin_layout Plain Layout
34706 <cell alignment="center" valignment="top" usebox="none">
34709 \begin_layout Plain Layout
34717 <cell alignment="center" valignment="top" usebox="none">
34720 \begin_layout Plain Layout
34726 <cell alignment="center" valignment="top" usebox="none">
34729 \begin_layout Plain Layout
34735 <cell alignment="center" valignment="top" usebox="none">
34738 \begin_layout Plain Layout
34744 <cell alignment="center" valignment="top" usebox="none">
34747 \begin_layout Plain Layout
34753 <cell alignment="center" valignment="top" usebox="none">
34756 \begin_layout Plain Layout
34762 <cell alignment="center" valignment="top" usebox="none">
34765 \begin_layout Plain Layout
34771 <cell alignment="center" valignment="top" usebox="none">
34774 \begin_layout Plain Layout
34780 <cell alignment="center" valignment="top" usebox="none">
34783 \begin_layout Plain Layout
34797 \begin_layout Chapter
34798 Names of available colors to be used in layouts
34799 \begin_inset CommandInset label
34801 name "chap:Names-of-colors"
34808 \begin_layout Standard
34809 The colors listed below are the standard colors and those that you can adjust
34810 in the \SpecialChar LyX
34814 \begin_layout Section
34818 \begin_layout Standard
34819 The following are no real colors, but rather act on color definitions:
34822 \begin_layout Description
34823 ignore The color is ignored
34826 \begin_layout Description
34827 inherit The color is inherited
34830 \begin_layout Description
34843 No particular color – clear or default
34846 \begin_layout Section
34850 \begin_layout Standard
34851 These are fixed colors that cannot be customized
34852 \change_inserted -712698321 1607683177
34858 use these colors in layout definitions, since they will not work well with
34859 some color themes (such as dark themes)
34864 \begin_layout Description
34868 \begin_layout Description
34872 \begin_layout Description
34876 \begin_layout Description
34880 \begin_layout Description
34884 \begin_layout Description
34888 \begin_layout Description
34892 \begin_layout Description
34896 \begin_layout Description
34900 \begin_layout Description
34904 \begin_layout Description
34908 \begin_layout Description
34912 \begin_layout Description
34916 \begin_layout Description
34920 \begin_layout Description
34924 \begin_layout Description
34928 \begin_layout Description
34932 \begin_layout Description
34936 \begin_layout Description
34940 \begin_layout Section
34944 \begin_layout Standard
34945 These are the colors allocated to specific elements in
34948 arg "dialog-show prefs"
34954 \begin_layout Description
34955 added_space Added space color
34958 \begin_layout Description
34959 addedtext Added text color
34962 \begin_layout Description
34963 appendix Appendix marker color
34966 \begin_layout Description
34967 background Background color
34970 \begin_layout Description
34971 bottomarea Bottom area color
34974 \begin_layout Description
34975 branchlabel Label color for branches
34978 \begin_layout Description
34979 buttonbg Color used for button background
34982 \begin_layout Description
34983 buttonframe Color for inset button frames
34986 \begin_layout Description
34987 buttonhoverbg Color used for button background under focus
34990 \begin_layout Description
34991 changebar Changebar color
34994 \begin_layout Description
34995 changedtextauthor1 Changed text color author 1
34998 \begin_layout Description
34999 changedtextauthor2 Changed text color author 2
35002 \begin_layout Description
35003 changedtextauthor3 Changed text color author 3
35006 \begin_layout Description
35007 changedtextauthor4 Changed text color author 4
35010 \begin_layout Description
35011 changedtextauthor5 Changed text color author 5
35014 \begin_layout Description
35015 collapsible Collapsible insets text color
35018 \begin_layout Description
35019 collapsibleframe Collapsible insets framecolor
35022 \begin_layout Description
35023 command Text color for command insets
35026 \begin_layout Description
35027 commandbg Background color for command insets
35030 \begin_layout Description
35031 commandframe Frame color for command insets
35034 \begin_layout Description
35035 comment Label color for comments
35038 \begin_layout Description
35039 commentbg Background color of comments
35042 \begin_layout Description
35043 cursor Cursor color
35046 \begin_layout Description
35047 deletedtext Deleted text color
35050 \begin_layout Description
35051 deletedtextmodifier Deleted text modifying color
35054 \begin_layout Description
35055 depthbar Color for the depth bars in the margin
35058 \begin_layout Description
35059 eolmarker End of line marker color
35062 \begin_layout Description
35063 error Color of the \SpecialChar LaTeX
35067 \begin_layout Description
35068 footlabel Label color for footnotes
35071 \begin_layout Description
35072 foreground Foreground color
35075 \begin_layout Description
35076 graphicsbg Graphics inset background color
35079 \begin_layout Description
35080 greyedoutbg Background color of greyedout inset
35083 \begin_layout Description
35084 greyedoutlabel Label color for greyedout insets
35087 \begin_layout Description
35088 greyedouttext Color for greyedout inset text
35091 \begin_layout Description
35092 indexlabel Label color for index insets
35095 \begin_layout Description
35096 inlinecompletion Inline completion color
35099 \begin_layout Description
35100 insetbg Inset marker background color
35103 \begin_layout Description
35104 insetframe Inset marker frame color
35107 \begin_layout Description
35108 language Color for marking foreign language words
35111 \begin_layout Description
35112 latex Text color in \SpecialChar LaTeX
35116 \begin_layout Description
35117 listingsbg Background color of listings inset
35120 \begin_layout Description
35121 marginlabel Label color for margin notes
35124 \begin_layout Description
35125 math Math inset text color
35128 \begin_layout Description
35129 mathbg Math inset background color
35132 \begin_layout Description
35133 mathcorners Math inset frame color not under focus
35136 \begin_layout Description
35137 mathframe Math inset frame color under focus
35140 \begin_layout Description
35141 mathline Math line color
35144 \begin_layout Description
35145 mathmacrobg Macro math inset background color
35148 \begin_layout Description
35149 mathmacroblend Macro math blended color
35152 \begin_layout Description
35153 mathmacroframe Macro math frame color
35156 \begin_layout Description
35157 mathmacrohoverbg Macro math inset background color hovered
35160 \begin_layout Description
35161 mathmacrolabel Macro math label color
35164 \begin_layout Description
35165 mathmacronewarg Macro template color for new parameters
35168 \begin_layout Description
35169 mathmacrooldarg Macro template color for old parameters
35172 \begin_layout Description
35173 newpage New page color
35176 \begin_layout Description
35177 nonunique_inlinecompletion Inline completion color for the non-unique part
35180 \begin_layout Description
35181 note Label color for notes
35184 \begin_layout Description
35185 notebg Background color of notes
35188 \begin_layout Description
35189 pagebreak Page break/line break color
35192 \begin_layout Description
35193 paragraphmarker Color used for the pilcrow sign to mark the end of a paragraph
35196 \begin_layout Description
35197 phantomtext Text color for phantom insets
35200 \begin_layout Description
35201 preview The color used for previews
35204 \begin_layout Description
35205 previewframe Preview frame color
35208 \begin_layout Description
35209 regexpframe Color for regexp frame
35212 \begin_layout Description
35213 scroll Color that indicates when a row can be scrolled
35216 \begin_layout Description
35217 selection Background color of selected text
35220 \begin_layout Description
35221 selectiontext Foreground color of selected text
35224 \begin_layout Description
35225 shadedbg Background color of shaded box
35228 \begin_layout Description
35229 special Special chars text color
35232 \begin_layout Description
35233 tabularline Table line color
35236 \begin_layout Description
35237 tabularonoffline Table line color
35238 \change_inserted -712698321 1607682522
35242 \begin_layout Description
35244 \change_inserted -712698321 1607682563
35245 textlabel1 Color 1 of layout and custom inset labels
35248 \begin_layout Description
35250 \change_inserted -712698321 1607682565
35251 textlabel2 Color 2 of layout and custom inset labels
35254 \begin_layout Description
35256 \change_inserted -712698321 1607682568
35257 textlabel3 Color 3 of layout and custom inset labels
35262 \begin_layout Description
35263 urllabel Label color for URL insets
35266 \begin_layout Description
35267 urltext Color for URL inset text