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 named
715 \begin_inset Flex Code
718 \begin_layout Plain Layout
724 , that will be used first.
727 \begin_layout Labeling
728 \labelwidthstring 00.00.0000
729 \begin_inset Flex Code
732 \begin_layout Plain Layout
739 \change_deleted 232239728 1604794478
741 \change_inserted 232239728 1604794478
744 ontains files with the extension
745 \begin_inset Flex Code
748 \begin_layout Plain Layout
754 which define the diverse citation possibilities (natbib, biblatex etc.).
756 \begin_inset CommandInset ref
758 reference "subsec:Cite-Engine-Files"
768 \begin_layout Labeling
769 \labelwidthstring 00.00.0000
770 \begin_inset Flex Code
773 \begin_layout Plain Layout
780 \change_deleted 232239728 1604794483
782 \change_inserted 232239728 1604794486
785 ontains graphics files that can be included in documents.
789 \begin_layout Labeling
790 \labelwidthstring 00.00.0000
791 \begin_inset Flex Code
794 \begin_layout Plain Layout
801 \change_deleted 232239728 1604794492
803 \change_inserted 232239728 1604794492
806 ontains \SpecialChar LyX
807 documentation files (including the one you are currently reading).
809 \begin_inset Flex Code
812 \begin_layout Plain Layout
814 \change_deleted 232239728 1604794660
817 \change_inserted 232239728 1604794661
825 deserves special attention, as noted above.
826 The internationalized help docs are in subdirectories
827 \begin_inset Flex Code
830 \begin_layout Plain Layout
837 \begin_inset Quotes eld
841 \begin_inset Quotes erd
844 is the ISO language code.
846 \begin_inset CommandInset ref
848 reference "cha:Internationalizing-LyX"
855 \begin_layout Labeling
856 \labelwidthstring 00.00.0000
857 \begin_inset Flex Code
860 \begin_layout Plain Layout
867 \change_deleted 232239728 1604794497
869 \change_inserted 232239728 1604794497
872 ontains example files that explain how to use some features.
873 In the file browser, press the
874 \begin_inset Flex Noun
877 \begin_layout Plain Layout
886 \begin_layout Labeling
887 \labelwidthstring 00.00.0000
888 \begin_inset Flex Code
891 \begin_layout Plain Layout
898 \change_deleted 232239728 1604794500
900 \change_inserted 232239728 1604794500
903 ontains image files that are used by the
904 \begin_inset Flex Noun
907 \begin_layout Plain Layout
914 In addition, it also contains the individual icons used in the toolbar
915 and the banners that can be shown when \SpecialChar LyX
919 \begin_layout Labeling
920 \labelwidthstring 00.00.0000
921 \begin_inset Flex Code
924 \begin_layout Plain Layout
931 \change_deleted 232239728 1604794505
933 \change_inserted 232239728 1604794505
936 ontains keyboard keymapping files.
938 \begin_inset CommandInset ref
940 reference "sec:International-Keymap-Stuff"
947 \begin_layout Labeling
948 \labelwidthstring 00.00.0000
949 \begin_inset Flex Code
952 \begin_layout Plain Layout
959 \change_deleted 232239728 1604794508
961 \change_inserted 232239728 1604794508
964 ontains the text class and module files described in
965 \begin_inset CommandInset ref
967 reference "cha:Installing-New-Document"
974 \begin_layout Labeling
975 \labelwidthstring 00.00.0000
976 \begin_inset Flex Code
979 \begin_layout Plain Layout
986 \change_deleted 232239728 1604794513
988 \change_inserted 232239728 1604794513
992 \begin_inset Flex Code
995 \begin_layout Plain Layout
1001 Python scripts used to convert between \SpecialChar LyX
1003 These can be run from the command line if
1004 \change_deleted 232239728 1604794749
1007 you want to batch-convert files.
1010 \begin_layout Labeling
1011 \labelwidthstring 00.00.0000
1012 \begin_inset Flex Code
1015 \begin_layout Plain Layout
1022 \change_deleted 232239728 1604794516
1024 \change_inserted 232239728 1604794516
1027 ontains some files that demonstrate the capabilities of the
1028 \begin_inset Flex Noun
1031 \begin_layout Plain Layout
1033 \begin_inset space ~
1042 Also contains some scripts used by \SpecialChar LyX
1046 \begin_layout Labeling
1047 \labelwidthstring 00.00.0000
1048 \begin_inset Flex Code
1051 \begin_layout Plain Layout
1058 \change_deleted 232239728 1604794520
1060 \change_inserted 232239728 1604794520
1063 ontains the standard \SpecialChar LyX
1064 template files described in
1065 \begin_inset CommandInset ref
1067 reference "subsec:Creating-Templates"
1074 \begin_layout Labeling
1075 \labelwidthstring 00.00.0000
1076 \begin_inset Flex Code
1079 \begin_layout Plain Layout
1086 \change_deleted 232239728 1604794524
1088 \change_inserted 232239728 1604794524
1091 ontains files with the extension
1092 \begin_inset Flex Code
1095 \begin_layout Plain Layout
1101 that define the user interface to \SpecialChar LyX
1103 That is, the files define which items appear in which menus and the items
1104 appearing on the toolbar.
1107 \begin_layout Labeling
1108 \labelwidthstring 00.00.0000
1109 \begin_inset Flex Code
1112 \begin_layout Plain Layout
1119 \change_deleted 232239728 1604794528
1121 \change_inserted 232239728 1604794528
1124 ontains files with the extension
1125 \begin_inset Flex Code
1128 \begin_layout Plain Layout
1134 which define the templates for the insertion of external material to a
1137 \begin_inset CommandInset ref
1139 reference "chap:Including-External-Material"
1146 \begin_layout Subsection
1147 Files you don't want to modify
1150 \begin_layout Standard
1151 These files are used internally by \SpecialChar LyX
1152 and you generally do not need to modify
1153 them unless you are a developer.
1156 \begin_layout Labeling
1157 \labelwidthstring 00.00.0000
1158 \begin_inset Flex Code
1161 \begin_layout Plain Layout
1168 \change_deleted 232239728 1604797616
1170 \change_inserted 232239728 1604797616
1173 his file contains the list of \SpecialChar LyX
1175 The contents are displayed with the menu entry
1176 \begin_inset Flex Noun
1179 \begin_layout Plain Layout
1180 Help\SpecialChar menuseparator
1182 \begin_inset space ~
1193 \begin_layout Labeling
1194 \labelwidthstring 00.00.0000
1195 \begin_inset Flex Code
1198 \begin_layout Plain Layout
1205 \change_deleted 232239728 1604797620
1207 \change_inserted 232239728 1604797620
1210 his is a \SpecialChar LaTeX
1211 script used during the configuration process.
1212 Do not run directly.
1215 \begin_layout Labeling
1216 \labelwidthstring 00.00.0000
1217 \begin_inset Flex Code
1220 \begin_layout Plain Layout
1227 \change_deleted 232239728 1604797624
1229 \change_inserted 232239728 1604797624
1232 his is a Python script that is used to re-configure \SpecialChar LyX
1234 It creates configuration files in the directory it was run from.
1237 \begin_layout Subsection
1238 Other files needing a line or two
1241 \begin_layout Labeling
1242 \labelwidthstring 00.00.0000
1243 \begin_inset Flex Code
1246 \begin_layout Plain Layout
1253 \change_deleted 232239728 1604797580
1255 \change_inserted 232239728 1604797580
1258 his contains tables describing how different character encodings can be
1262 \begin_layout Labeling
1263 \labelwidthstring 00.00.0000
1264 \begin_inset Flex Code
1267 \begin_layout Plain Layout
1274 \change_deleted 232239728 1604797584
1276 \change_inserted 232239728 1604797584
1279 his file contains a list of all the languages currently supported by \SpecialChar LyX
1283 \begin_layout Labeling
1284 \labelwidthstring 00.00.0000
1285 \begin_inset Flex Code
1288 \begin_layout Plain Layout
1295 \change_deleted 232239728 1604797587
1297 \change_inserted 232239728 1604797587
1300 ontains information about the supported fonts.
1303 \begin_layout Labeling
1304 \labelwidthstring 00.00.0000
1305 \begin_inset Flex Code
1308 \begin_layout Plain Layout
1315 \change_deleted 232239728 1604797591
1317 \change_inserted 232239728 1604797591
1320 his file contains translations for internationalized paragraph styles (see
1322 \begin_inset CommandInset ref
1324 reference "subsec:I18n"
1331 \begin_layout Labeling
1332 \labelwidthstring 00.00.0000
1333 \begin_inset Flex Code
1336 \begin_layout Plain Layout
1343 \change_deleted 232239728 1604797594
1345 \change_inserted 232239728 1604797594
1348 his file contains information about Unicode-encoded glyphs and the way they
1349 are supported by \SpecialChar LyX
1350 via \SpecialChar LaTeX
1354 \begin_layout Section
1355 Your local configuration directory
1358 \begin_layout Standard
1359 Even if you are using \SpecialChar LyX
1360 as an unprivileged user, you might want to change
1362 configuration for your own use.
1364 \begin_inset Flex Code
1367 \begin_layout Plain Layout
1373 directory contains all your personal configuration files.
1374 This is the directory described as
1375 \begin_inset Quotes eld
1379 \begin_inset Quotes erd
1383 \begin_inset Flex Noun
1386 \begin_layout Plain Layout
1387 Help\SpecialChar menuseparator
1389 \begin_inset space ~
1398 This directory is used as a mirror of
1399 \begin_inset Flex Code
1402 \begin_layout Plain Layout
1408 , which means that every file in
1409 \begin_inset Flex Code
1412 \begin_layout Plain Layout
1418 is a replacement for the corresponding file in
1419 \begin_inset Flex Code
1422 \begin_layout Plain Layout
1429 Any configuration file described in the above sections can be placed either
1430 in the system-wide directory, in which case it will affect all users, or
1431 in your local directory for your own use.
1434 \begin_layout Standard
1435 To make things clearer, let's provide a few examples:
1438 \begin_layout Itemize
1439 The preferences set in the
1440 \begin_inset Flex Noun
1443 \begin_layout Plain Layout
1444 Tools\SpecialChar menuseparator
1450 dialog are saved to a file
1451 \begin_inset Flex Code
1454 \begin_layout Plain Layout
1461 \begin_inset Flex Code
1464 \begin_layout Plain Layout
1473 \begin_layout Itemize
1474 When you reconfigure using
1475 \begin_inset Flex Noun
1478 \begin_layout Plain Layout
1479 Tools\SpecialChar menuseparator
1487 \begin_inset Flex Code
1490 \begin_layout Plain Layout
1496 script, and the resulting files are written in your local configuration
1498 This means that any additional text class file that you might have added
1500 \begin_inset Flex Code
1503 \begin_layout Plain Layout
1509 will be added to the list of classes in the
1510 \begin_inset Flex Noun
1513 \begin_layout Plain Layout
1514 Document\SpecialChar menuseparator
1523 \begin_layout Itemize
1524 If you get some updated documentation from
1525 \change_inserted 232239728 1604798171
1529 ftp site and cannot install it because you do not have sysadmin rights
1530 on your system, you can just copy the files
1531 \change_deleted 232239728 1604798193
1533 \change_inserted 232239728 1604798193
1537 \begin_inset Flex Code
1540 \begin_layout Plain Layout
1546 and the items in the
1547 \begin_inset Flex Noun
1550 \begin_layout Plain Layout
1556 menu will open them!
1559 \begin_layout Section
1560 Running \SpecialChar LyX
1561 with multiple configurations
1564 \begin_layout Standard
1565 The configuration freedom of the local configuration directory may not suffice
1566 if you want to have more than one configuration at your disposal.
1567 For example, you may want to
1568 \change_deleted 232239728 1604798238
1571 use different key bindings or printer settings at different times.
1572 You can achieve this by having several such directories.
1573 You then specify which directory to use at run-time.
1576 \begin_layout Standard
1577 Invoking \SpecialChar LyX
1578 with the command line switch
1579 \begin_inset Flex Code
1582 \begin_layout Plain Layout
1592 instructs the program to read the configuration from that directory, and
1593 not from the default directory.
1594 (You can determine the default directory by running \SpecialChar LyX
1596 \begin_inset Flex Code
1599 \begin_layout Plain Layout
1605 switch.) If the specified directory does not exist, \SpecialChar LyX
1607 for you, just like it does for the default directory
1608 \change_deleted 232239728 1604798318
1611 the first time you run the program.
1612 You can modify the configuration options in this additional user directory
1613 exactly as you would for the default directory.
1614 These directories are completely independent (but read on).
1615 Note that setting the environment variable
1616 \begin_inset Flex Code
1619 \begin_layout Plain Layout
1625 to some value has exactly the same effect.
1628 \begin_layout Standard
1629 Having several configurations also requires more maintenance: if you want
1630 to add a new layout to
1631 \begin_inset Flex Code
1634 \begin_layout Plain Layout
1640 which you want available from all your configurations, you must add it
1641 to each directory separately.
1642 You can avoid this with the following trick: after \SpecialChar LyX
1643 creates the additional
1644 directory, most of the subdirectories (see above) are empty.
1645 If you want the new configuration to mirror an existing one, replace the
1646 empty subdirectory with a symbolic link to the matching subdirectory in
1647 the existing configuration.
1649 \begin_inset Flex Code
1652 \begin_layout Plain Layout
1658 subdirectory, however, since it contains a file written by the configuration
1659 script (also accessible through
1660 \begin_inset Flex Noun
1663 \begin_layout Plain Layout
1664 Tools\SpecialChar menuseparator
1670 ) which is configuration
1671 \change_deleted 232239728 1604798083
1673 \change_inserted 232239728 1604798100
1679 \begin_layout Chapter
1680 The Preferences dialog
1683 \begin_layout Standard
1684 All options of the preferences dialog are described in the Appendix
1686 The Preferences Dialog
1693 For some options you might find here more details.
1696 \begin_layout Section
1698 \begin_inset CommandInset label
1707 \begin_layout Standard
1708 The first step is to define your file formats if they are not already defined.
1710 \begin_inset Flex Noun
1713 \begin_layout Plain Layout
1714 Tools\SpecialChar menuseparator
1722 \begin_inset Flex Noun
1725 \begin_layout Plain Layout
1726 File Handling\SpecialChar menuseparator
1733 \begin_inset Flex Noun
1736 \begin_layout Plain Layout
1742 button to define your new format.
1744 \begin_inset Flex Noun
1747 \begin_layout Plain Layout
1753 field contains the name used to identify the format in the GUI.
1755 \begin_inset Flex Noun
1758 \begin_layout Plain Layout
1764 is used to identify the format internally.
1765 You will also need to enter a file extension.
1766 These are all required.
1768 \begin_inset Flex Noun
1771 \begin_layout Plain Layout
1777 field is used to provide a keyboard shortcut on the menus.
1778 (For example, pressing
1779 \begin_inset Flex Noun
1782 \begin_layout Plain Layout
1789 \begin_inset Flex Noun
1792 \begin_layout Plain Layout
1793 Document\SpecialChar menuseparator
1794 View (Other Formats)\SpecialChar menuseparator
1803 \begin_layout Standard
1805 \begin_inset Flex Noun
1808 \begin_layout Plain Layout
1815 \begin_inset Flex Noun
1818 \begin_layout Plain Layout
1825 For example, you might want to use
1826 \begin_inset Flex Noun
1829 \begin_layout Plain Layout
1835 to view PostScript files.
1836 You can enter the command needed to start the program in the corresponding
1838 In defining this command, you can use the four variables listed in the
1840 The viewer is launched when you view an image in \SpecialChar LyX
1842 \begin_inset Flex Noun
1845 \begin_layout Plain Layout
1846 Document\SpecialChar menuseparator
1853 The editor is for example launched when you right-click on an image and
1855 \begin_inset Flex Noun
1858 \begin_layout Plain Layout
1864 in the appearing context menu.
1867 \begin_layout Standard
1869 \begin_inset Flex Noun
1872 \begin_layout Plain Layout
1878 type of a format is optional, but if it is specified, it must be unique
1880 It is used to detect files of this format from the file contents.
1881 For some important file formats there is no MIME type officially registered
1883 \begin_inset CommandInset href
1886 target "http://www.iana.org/assignments/media-types/"
1892 Therefore \SpecialChar LyX
1893 uses the extended list of MIME types as specified by
1894 \begin_inset CommandInset href
1896 name "freedesktop.org"
1897 target "http://www.freedesktop.org/wiki/Specifications/shared-mime-info-spec"
1905 \begin_layout Standard
1907 \begin_inset Flex Noun
1910 \begin_layout Plain Layout
1916 option tells \SpecialChar LyX
1917 that a format is suitable for document export.
1918 If this is set and if a suitable conversion route exists (see
1919 \begin_inset CommandInset ref
1921 reference "sec:Converters"
1925 ), the format will appear in the
1926 \begin_inset Flex Noun
1929 \begin_layout Plain Layout
1930 File\SpecialChar menuseparator
1937 The format will also appear in the
1938 \begin_inset Flex Noun
1941 \begin_layout Plain Layout
1942 Document\SpecialChar menuseparator
1948 menu if a viewer is specified for the format.
1949 Pure image formats, such as
1950 \begin_inset Flex Code
1953 \begin_layout Plain Layout
1959 , should not use this option.
1960 Formats that can both represent vector graphics and documents like
1961 \begin_inset Flex Code
1964 \begin_layout Plain Layout
1973 \begin_layout Standard
1975 \begin_inset Flex Noun
1978 \begin_layout Plain Layout
1979 Vector graphics format
1984 tells \SpecialChar LyX
1985 that a format can contain vector graphics.
1986 This information is used to determine the target format of included graphics
1988 \begin_inset Flex Noun
1991 \begin_layout Plain Layout
1998 Included graphics may need to be converted to either
1999 \begin_inset Flex Noun
2002 \begin_layout Plain Layout
2009 \begin_inset Flex Noun
2012 \begin_layout Plain Layout
2019 \begin_inset Flex Noun
2022 \begin_layout Plain Layout
2029 \begin_inset Flex Noun
2032 \begin_layout Plain Layout
2038 cannot handle other image formats.
2039 If an included graphic is not already in
2040 \begin_inset Flex Noun
2043 \begin_layout Plain Layout
2050 \begin_inset Flex Noun
2053 \begin_layout Plain Layout
2060 \begin_inset Flex Noun
2063 \begin_layout Plain Layout
2069 format, it is converted to
2070 \begin_inset Flex Noun
2073 \begin_layout Plain Layout
2079 if the vector format option is set, and otherwise to
2080 \begin_inset Flex Noun
2083 \begin_layout Plain Layout
2092 \begin_layout Section
2096 \begin_layout Standard
2097 Since all conversions from one format to another take place in \SpecialChar LyX
2099 directory, it is sometimes necessary to modify a file before copying it
2100 to the temporary directory in order that the conversion may be performed.
2104 \begin_layout Plain Layout
2105 For example, the file may refer to other files—images, for example—using
2106 relative file names, and these may become invalid when the file is copied
2107 to the temporary directory.
2112 This is done by a Copier: It copies a file to (or from) the temporary directory
2113 and may modify it in the process.
2116 \begin_layout Standard
2117 The definitions of the copiers may use eight variables:
2120 \begin_layout Labeling
2121 \labelwidthstring 00.00.0000
2122 \begin_inset Flex Code
2125 \begin_layout Plain Layout
2131 The \SpecialChar LyX
2132 system directory (e.
2133 \begin_inset space \thinspace{}
2137 \begin_inset space \space{}
2141 \begin_inset Flex Noun
2144 \begin_layout Plain Layout
2153 \begin_layout Labeling
2154 \labelwidthstring 00.00.0000
2155 \begin_inset Flex Code
2158 \begin_layout Plain Layout
2167 \begin_layout Labeling
2168 \labelwidthstring 00.00.0000
2169 \begin_inset Flex Code
2172 \begin_layout Plain Layout
2181 \begin_layout Labeling
2182 \labelwidthstring 00.00.0000
2183 \begin_inset Flex Code
2186 \begin_layout Plain Layout
2192 The base name (without filename extension) in the \SpecialChar LyX
2196 \begin_layout Labeling
2197 \labelwidthstring 00.00.0000
2198 \begin_inset Flex Code
2201 \begin_layout Plain Layout
2207 The full directory path of the \SpecialChar LyX
2211 \begin_layout Labeling
2212 \labelwidthstring 00.00.0000
2213 \begin_inset Flex Code
2216 \begin_layout Plain Layout
2222 The full pathname to the original \SpecialChar LyX
2223 file being processed
2226 \begin_layout Labeling
2227 \labelwidthstring 00.00.0000
2228 \begin_inset Flex Code
2231 \begin_layout Plain Layout
2237 The filename (without any directory path) of the \SpecialChar LyX
2241 \begin_layout Labeling
2242 \labelwidthstring 00.00.0000
2243 \begin_inset Flex Code
2246 \begin_layout Plain Layout
2252 The `\SpecialChar LaTeX
2256 \begin_layout Standard
2257 The latter should be the filename as it would be used in a \SpecialChar LaTeX
2265 It is relevant only when exporting files suitable for such inclusion.
2268 \begin_layout Standard
2269 Copiers can be used to do almost anything with output files.
2270 For example, suppose you want generated pdf files to be copied to a special
2272 \begin_inset Flex Code
2275 \begin_layout Plain Layout
2282 Then you could write a shell script such as this one:
2285 \begin_layout Standard
2286 \begin_inset listings
2290 \begin_layout Plain Layout
2295 \begin_layout Plain Layout
2300 \begin_layout Plain Layout
2302 TOFILE=`basename $2`
2305 \begin_layout Plain Layout
2307 cp $FROMFILE /home/you/pdf/$TOFILE
2312 Save it in your local \SpecialChar LyX
2314 \begin_inset Flex Code
2317 \begin_layout Plain Layout
2318 /home/you/.lyx/scripts/pdfcopier.sh
2323 —and make it executable, if you need to do so on your platform.
2325 \begin_inset Flex Noun
2328 \begin_layout Plain Layout
2329 Tools\SpecialChar menuseparator
2335 dialog, select under
2336 \begin_inset Flex Noun
2339 \begin_layout Plain Layout
2340 File Handling\SpecialChar menuseparator
2347 \begin_inset Flex Noun
2350 \begin_layout Plain Layout
2356 format—or one of the other pdf formats—and enter
2357 \begin_inset Flex Code
2360 \begin_layout Plain Layout
2361 pdfcopier.sh $$i $$o
2367 \begin_inset Flex Noun
2370 \begin_layout Plain Layout
2380 \begin_layout Standard
2381 Copiers are used by \SpecialChar LyX
2382 in various of its own conversions.
2383 For example, if appropriate programs are found, \SpecialChar LyX
2384 will automatically install
2386 \begin_inset Flex Noun
2389 \begin_layout Plain Layout
2396 \begin_inset Flex Noun
2399 \begin_layout Plain Layout
2401 \begin_inset space ~
2410 When these formats are exported, the copier sees that not just the main
2411 HTML file but various associated files (style files, images, etc.) are also
2413 All these files are written to a subdirectory of the directory in which
2414 the original \SpecialChar LyX
2419 \begin_layout Plain Layout
2420 This copier can be customized.
2422 \begin_inset Quotes eld
2426 \begin_inset Quotes erd
2429 argument takes a comma-separated list of extensions to be copied; if it
2430 is omitted, all files will be copied.
2432 \begin_inset Quotes eld
2436 \begin_inset Quotes erd
2439 argument determines the extension added to the generated directory.
2441 \begin_inset Quotes eld
2445 \begin_inset Flex Noun
2448 \begin_layout Plain Layout
2455 \begin_inset Quotes erd
2458 , so HTML generated from
2459 \begin_inset Flex Noun
2462 \begin_layout Plain Layout
2463 /path/to/filename.lyx
2469 \begin_inset Flex Noun
2472 \begin_layout Plain Layout
2473 /path/to/filename.html.LyXconv
2487 \begin_layout Section
2489 \begin_inset CommandInset label
2491 name "sec:Converters"
2498 \begin_layout Standard
2499 You can define your own Converters to convert files between different formats.
2501 \begin_inset Flex Noun
2504 \begin_layout Plain Layout
2505 Tools\SpecialChar menuseparator
2506 Preferences\SpecialChar menuseparator
2507 File Handling\SpecialChar menuseparator
2516 \begin_layout Standard
2517 To define a new converter, select the
2518 \begin_inset Flex Noun
2521 \begin_layout Plain Layout
2523 \begin_inset space ~
2532 \begin_inset Flex Noun
2535 \begin_layout Plain Layout
2537 \begin_inset space ~
2545 from the drop-down lists, enter the command needed for the conversion,
2547 \begin_inset Flex Noun
2550 \begin_layout Plain Layout
2557 Several variables can be used in the definition of converters:
2560 \begin_layout Labeling
2561 \labelwidthstring 00.00.0000
2562 \begin_inset Flex Code
2565 \begin_layout Plain Layout
2571 The \SpecialChar LyX
2575 \begin_layout Labeling
2576 \labelwidthstring 00.00.0000
2577 \begin_inset Flex Code
2580 \begin_layout Plain Layout
2589 \begin_layout Labeling
2590 \labelwidthstring 00.00.0000
2591 \begin_inset Flex Code
2594 \begin_layout Plain Layout
2603 \begin_layout Labeling
2604 \labelwidthstring 00.00.0000
2605 \begin_inset Flex Code
2608 \begin_layout Plain Layout
2614 The base filename of the input file (i.
2615 \begin_inset space \thinspace{}
2618 g., without the extension)
2621 \begin_layout Labeling
2622 \labelwidthstring 00.00.0000
2623 \begin_inset Flex Code
2626 \begin_layout Plain Layout
2632 The path to the input file
2635 \begin_layout Labeling
2636 \labelwidthstring 00.00.0000
2637 \begin_inset Flex Code
2640 \begin_layout Plain Layout
2646 The path to the original input file (this is different from $$p when a
2647 chain of converters is called)
2650 \begin_layout Labeling
2651 \labelwidthstring 00.00.0000
2652 \begin_inset Flex Code
2655 \begin_layout Plain Layout
2661 The iconv name for the encoding of the document.
2664 \begin_layout Standard
2666 \begin_inset Flex Noun
2669 \begin_layout Plain Layout
2671 \begin_inset space ~
2679 field you can enter the following flags, separated by commas:
2682 \begin_layout Labeling
2683 \labelwidthstring 00.00.0000
2684 \begin_inset Flex Code
2687 \begin_layout Plain Layout
2689 \change_inserted -712698321 1524656940
2697 This converter runs some form of \SpecialChar LaTeX
2699 This will make \SpecialChar LyX
2700 's \SpecialChar LaTeX
2701 error logs available.
2703 \change_inserted -712698321 1524657018
2705 \begin_inset Flex Code
2708 \begin_layout Plain Layout
2710 \change_inserted -712698321 1524657012
2718 value specifies the form of \SpecialChar LaTeX
2720 \begin_inset Flex Code
2723 \begin_layout Plain Layout
2725 \change_inserted -712698321 1524657005
2726 latex, pdflatex, platex, xetex, luatex
2734 If no value is specified,
2735 \begin_inset Flex Code
2738 \begin_layout Plain Layout
2740 \change_inserted -712698321 1524657018
2753 \begin_layout Labeling
2754 \labelwidthstring 00.00.0000
2755 \begin_inset Flex Code
2758 \begin_layout Plain Layout
2760 \change_inserted -712698321 1524656935
2768 Needs the \SpecialChar LaTeX
2770 \begin_inset Flex Noun
2773 \begin_layout Plain Layout
2779 file for the conversion.
2781 \change_inserted -712698321 1524657047
2783 \begin_inset Flex Code
2786 \begin_layout Plain Layout
2788 \change_inserted -712698321 1524657030
2796 value specifies the form of \SpecialChar LaTeX
2797 that is run in order to generate the
2798 \begin_inset Flex Noun
2801 \begin_layout Plain Layout
2803 \change_inserted -712698321 1524657047
2812 \begin_inset Flex Code
2815 \begin_layout Plain Layout
2817 \change_inserted -712698321 1524657030
2818 latex, pdflatex, platex, xetex, luatex
2826 If no value is specified,
2827 \begin_inset Flex Code
2830 \begin_layout Plain Layout
2832 \change_inserted -712698321 1524657030
2845 \begin_layout Labeling
2846 \labelwidthstring 00.00.0000
2847 \begin_inset Flex Code
2850 \begin_layout Plain Layout
2857 \begin_inset Quotes eld
2861 \begin_inset Quotes erd
2864 file from the backend, which in practice means a \SpecialChar LaTeX
2865 file like the one we
2866 would export, without
2867 \begin_inset Flex Code
2870 \begin_layout Plain Layout
2879 \begin_layout Labeling
2880 \labelwidthstring 00.00.0000
2881 \begin_inset Flex Code
2884 \begin_layout Plain Layout
2893 \begin_layout Standard
2894 The following three flags are not really flags at all because they take
2896 \begin_inset Flex Noun
2899 \begin_layout Plain Layout
2901 \begin_inset space ~
2905 \begin_inset space ~
2916 \begin_layout Labeling
2917 \labelwidthstring 00.00.0000
2919 \change_inserted -712698321 1523206314
2920 \begin_inset Flex Code
2923 \begin_layout Plain Layout
2925 \change_inserted -712698321 1523206193
2933 The name of the driver that needs to be loaded with the
2937 package for this converter.
2938 The loading of the correct driver is necessary to get some PDF-specific
2947 \begin_layout Labeling
2948 \labelwidthstring 00.00.0000
2949 \begin_inset Flex Code
2952 \begin_layout Plain Layout
2958 If set, the converter's standard error will be redirected to a file
2959 \begin_inset Flex Code
2962 \begin_layout Plain Layout
2968 , and the script given as argument will be run as:
2969 \begin_inset Flex Code
2972 \begin_layout Plain Layout
2973 script < infile.out > infile.log
2979 The argument may contain
2980 \begin_inset Flex Code
2983 \begin_layout Plain Layout
2992 \begin_layout Labeling
2993 \labelwidthstring 00.00.0000
2994 \begin_inset Flex Code
2997 \begin_layout Plain Layout
3003 The name of the directory in which the converter will dump the generated
3006 will not create this directory, and it does not copy anything into it,
3007 though it will copy this directory to the destination.
3008 The argument may contain
3009 \begin_inset Flex Code
3012 \begin_layout Plain Layout
3018 , which will be replaced by the base name of the input and output files,
3019 respectively, when the directory is copied.
3020 \begin_inset Newline newline
3023 Note that resultdir and usetempdir make no sense together.
3024 The latter will be ignored if the former is given.
3027 \begin_layout Labeling
3028 \labelwidthstring 00.00.0000
3029 \begin_inset Flex Code
3032 \begin_layout Plain Layout
3038 Determines the output file name and may, contain
3039 \begin_inset Flex Code
3042 \begin_layout Plain Layout
3049 Sensible only with resultdir and optional even then; if not given, it defaults
3053 \begin_layout Standard
3055 \change_inserted -712698321 1523206384
3056 A suitable hyperref-driver is set for some converters that are installed
3057 with \SpecialChar LyX
3060 \change_deleted -712698321 1523206388
3062 \change_inserted -712698321 1523206389
3066 \change_inserted -712698321 1523206400
3070 \change_inserted -712698321 1523206407
3074 \change_inserted -712698321 1523206437
3078 \change_deleted -712698321 1523206442
3079 that are installed with \SpecialChar LyX
3086 \begin_layout Standard
3087 You do not have to define converters for all formats between which you want
3089 For example, you will note that there is no `\SpecialChar LyX
3090 to PostScript' converter,
3091 but \SpecialChar LyX
3092 will export PostScript.
3093 It does so by first creating a \SpecialChar LaTeX
3094 file (no converter needs to be defined
3095 for this) which is then converted to DVI using the `\SpecialChar LaTeX
3097 and finally converting the resulting DVI file to PostScript.
3099 finds such `chains' of converters automatically, and it will always choose
3100 the shortest possible chain.
3101 You can, though, still define multiple conversion methods between file
3103 For example, the standard \SpecialChar LyX
3104 configuration provides five ways to convert
3109 \begin_layout Enumerate
3111 \begin_inset Flex Noun
3114 \begin_layout Plain Layout
3123 \begin_layout Enumerate
3124 via (DVI and) PostScript, using
3125 \begin_inset Flex Noun
3128 \begin_layout Plain Layout
3137 \begin_layout Enumerate
3139 \begin_inset Flex Noun
3142 \begin_layout Plain Layout
3151 \begin_layout Enumerate
3153 \begin_inset Flex Noun
3156 \begin_layout Plain Layout
3166 \begin_layout Enumerate
3168 \begin_inset Flex Noun
3171 \begin_layout Plain Layout
3181 \begin_layout Standard
3182 To define such alternate chains, you must define multiple target `file formats',
3184 \begin_inset CommandInset ref
3186 reference "sec:Formats"
3191 For example, in the standard configuration, the formats named
3192 \begin_inset Flex Noun
3195 \begin_layout Plain Layout
3202 \begin_inset Flex Noun
3205 \begin_layout Plain Layout
3212 \begin_inset Flex Noun
3215 \begin_layout Plain Layout
3222 \begin_inset Flex Noun
3225 \begin_layout Plain Layout
3232 \begin_inset Flex Noun
3235 \begin_layout Plain Layout
3242 \begin_inset Flex Noun
3245 \begin_layout Plain Layout
3252 \begin_inset Flex Noun
3255 \begin_layout Plain Layout
3262 \begin_inset Flex Noun
3265 \begin_layout Plain Layout
3273 \begin_inset Flex Noun
3276 \begin_layout Plain Layout
3283 \begin_inset Flex Noun
3286 \begin_layout Plain Layout
3293 ) are defined, all of which share the extension
3294 \begin_inset Flex Noun
3297 \begin_layout Plain Layout
3303 , and which correspond to the conversion methods just mentioned.
3306 \begin_layout Chapter
3307 Internationalizing \SpecialChar LyX
3309 \begin_inset CommandInset label
3311 name "cha:Internationalizing-LyX"
3318 \begin_layout Standard
3320 supports using a translated interface.
3321 Last time we checked, \SpecialChar LyX
3322 provided text in thirty languages.
3323 The language of choice is called your
3328 (For further reading on locale settings, see also the documentation for
3329 locale that comes with your operating system.
3330 For Linux, the manual page for
3331 \begin_inset Flex Code
3334 \begin_layout Plain Layout
3340 could be a good place to start).
3343 \begin_layout Standard
3344 Notice that these translations will work, but do contain a few flaws.
3345 In particular, all dialogs have been designed with the English text in
3346 mind, which means that some of the translated text will be too large to
3347 fit within the space allocated.
3348 This is only a display problem and will not cause any harm.
3349 Also, you will find that some of the translations do not define shortcut
3350 keys for everything.
3351 Sometimes, there are simply not enough free letters to do it.
3352 Other times, the translator just hasn't got around to doing it yet.
3353 Our localization team, which you may wish to join,
3357 \begin_layout Plain Layout
3358 If you are a fluent speaker of a language other than English, joining these
3359 teams is a great way to give back to the \SpecialChar LyX
3365 will of course try to fix these shortcomings in future versions of \SpecialChar LyX
3369 \begin_layout Section
3370 Translating \SpecialChar LyX
3374 \begin_layout Subsection
3375 Translating the graphical user interface (text messages).
3378 \begin_layout Standard
3381 \begin_inset Flex Code
3384 \begin_layout Plain Layout
3390 library to handle the internationalization of the interface.
3391 To have \SpecialChar LyX
3392 speak your favorite language in all menus and dialogs, you need
3394 \begin_inset Flex Code
3397 \begin_layout Plain Layout
3403 -file for that language.
3404 When this is available, you'll have to generate a
3405 \begin_inset Flex Code
3408 \begin_layout Plain Layout
3414 -file from it and install the
3415 \begin_inset Flex Code
3418 \begin_layout Plain Layout
3425 The process of doing all of this is explained in the documentation for
3427 \begin_inset Flex Code
3430 \begin_layout Plain Layout
3437 It is possible to do this just for yourself, but if you're going to do
3438 it, you might as well share the results of your labors with the rest of
3439 the \SpecialChar LyX
3441 Send a message to the \SpecialChar LyX
3442 developers' list for more information about how
3446 \begin_layout Standard
3447 In short, this is what you should do (xx denotes the language code):
3450 \begin_layout Itemize
3451 Check out the \SpecialChar LyX
3454 \begin_inset CommandInset href
3456 name "information on the web"
3457 target "https://www.lyx.org/HowToUseGIT"
3465 \begin_layout Itemize
3467 \begin_inset Flex Code
3470 \begin_layout Plain Layout
3476 to the folder of the
3477 \begin_inset Flex Code
3480 \begin_layout Plain Layout
3488 \begin_inset Flex Code
3491 \begin_layout Plain Layout
3499 \begin_inset Flex Code
3502 \begin_layout Plain Layout
3508 doesn't exist anywhere, it can be remade with the console command
3509 \begin_inset Flex Code
3512 \begin_layout Plain Layout
3518 in that directory, or you can use an existing po-file for some other language
3522 \begin_layout Itemize
3524 \begin_inset Flex Code
3527 \begin_layout Plain Layout
3537 \begin_layout Plain Layout
3538 This is just a text file, so it can be edited in any text editor.
3539 But there are also specialized programs that support such editing, such
3544 (for all platforms) or
3553 contains a `mode' for editing
3554 \begin_inset Flex Code
3557 \begin_layout Plain Layout
3564 \begin_inset Flex URL
3567 \begin_layout Plain Layout
3569 https://www.gnu.org/software/gettext/manual/html_node/PO-Mode.html#PO-Mode
3579 For some menu- and widget-labels, there are also shortcut keys that should
3581 Those keys are marked after a `|', and should be translated according to
3582 the words and phrases of the language.
3583 You should also fill also out the information at the beginning of the new
3585 \begin_inset Flex Code
3588 \begin_layout Plain Layout
3594 -file with your email-address, etc., so people know where to reach you with
3595 suggestions and entertaining flames.
3598 \begin_layout Standard
3599 If you are just doing this on your own, then:
3602 \begin_layout Itemize
3604 \begin_inset Flex Code
3607 \begin_layout Plain Layout
3614 This can be done with
3615 \begin_inset Flex Code
3618 \begin_layout Plain Layout
3619 msgfmt -o xx.mo < xx.po
3627 \begin_layout Itemize
3629 \begin_inset Flex Code
3632 \begin_layout Plain Layout
3638 -file to your locale-tree, at the correct directory for application messages
3643 xx, and under the name
3644 \begin_inset Flex Code
3647 \begin_layout Plain Layout
3654 \begin_inset space \thinspace{}
3658 \begin_inset space \space{}
3662 \begin_inset Flex Code
3665 \begin_layout Plain Layout
3666 /usr/local/share/locale/xx/LC_MESSAGES/lyx.mo
3676 \begin_layout Standard
3677 As said, however, it would be best if the new
3678 \begin_inset Flex Code
3681 \begin_layout Plain Layout
3687 file could be added to the \SpecialChar LyX
3688 distribution, so others can use it.
3689 Adding it involves making additional changes to \SpecialChar LyX
3691 So send an email to the developers' mailing list if you're interested in
3695 \begin_layout Subsubsection
3699 \begin_layout Standard
3700 Sometimes it turns out that one English message needs to be translated into
3701 different messages in the target language.
3702 One example is the message
3703 \begin_inset Flex Code
3706 \begin_layout Plain Layout
3712 which has the German translation
3720 , depending upon exactly what the English
3721 \begin_inset Quotes eld
3725 \begin_inset Quotes erd
3730 \begin_inset Flex Code
3733 \begin_layout Plain Layout
3739 does not handle such ambiguous translations.
3740 Therefore you have to add some context information to the message: Instead
3742 \begin_inset Flex Code
3745 \begin_layout Plain Layout
3752 \begin_inset Flex Code
3755 \begin_layout Plain Layout
3756 To[[as in 'From format x to format y']]
3762 \begin_inset Flex Code
3765 \begin_layout Plain Layout
3766 To[[as in 'From page x to page y']].
3771 Now the two occurrences of
3772 \begin_inset Flex Code
3775 \begin_layout Plain Layout
3782 \begin_inset Flex Code
3785 \begin_layout Plain Layout
3791 and can be translated correctly to
3802 \begin_layout Standard
3803 Of course the context information needs to be stripped off the original
3804 message when no translation is used.
3805 Therefore you have to put it in double square brackets at the end of the
3806 message (see the example above).
3807 The translation mechanism of \SpecialChar LyX
3808 ensures that everything in double square
3809 brackets at the end of messages is removed before displaying the message.
3812 \begin_layout Subsection
3813 Translating the documentation.
3816 \begin_layout Standard
3817 The online documentation (in the
3818 \begin_inset Flex Noun
3821 \begin_layout Plain Layout
3827 -menu) can (and should!) be translated.
3828 If there are translated versions of the documentation available
3832 \begin_layout Plain Layout
3833 As of March 2008, at least some of the documents have been translated into
3834 fourteen languages, with the Tutorial available in a few more.
3839 and the locale is set accordingly, these will be used automagically by
3843 looks for translated versions as
3844 \begin_inset Flex Code
3847 \begin_layout Plain Layout
3848 LyXDir/doc/xx/DocName.lyx
3854 \begin_inset Flex Code
3857 \begin_layout Plain Layout
3863 is the code for the language currently in use.
3864 If there are no translated documents, the default English versions will
3866 Note that the translated versions must have the same filenames (
3867 \begin_inset Flex Code
3870 \begin_layout Plain Layout
3876 above) as the original.
3877 If you feel up to translating the documentation (an excellent way to proof-read
3878 the original documentation by the way!), there are a few things you should
3882 \begin_layout Itemize
3883 Check out the documentation translation web page at
3884 \begin_inset CommandInset href
3886 name "https://www.lyx.org/Translation"
3887 target "https://www.lyx.org/Translation"
3893 That way, you can find out which (if any) documents have already been translate
3894 d into your language.
3895 You can also find out who (if anyone) is organizing the effort to translate
3896 the documentation into your language.
3897 If no one is organizing the effort, please let us know that you're interested.
3900 \begin_layout Standard
3901 Once you get to actually translating, here's a few hints for you that may
3905 \begin_layout Itemize
3906 Join the documentation team! There is information on how to do that in
3907 \begin_inset Flex Code
3910 \begin_layout Plain Layout
3917 \begin_inset Flex Noun
3920 \begin_layout Plain Layout
3921 Help\SpecialChar menuseparator
3927 ), which by the way is the first document you should translate.
3930 \begin_layout Itemize
3931 Learn the typographic conventions for the language you are translating to.
3932 Typography is an ancient art and over the centuries, a great variety of
3933 conventions have developed throughout different parts of the world.
3934 Also study the professional terminology amongst typographers in your country.
3935 Inventing your own terminology will only confuse the users.
3938 (Warning! Typography is addictive!)
3941 \begin_layout Itemize
3942 Make a copy of the document.
3943 This will be your working copy.
3944 You can use this as your personal translated help-file by placing it in
3946 \begin_inset Flex Code
3949 \begin_layout Plain Layout
3956 \begin_inset Note Greyedout
3959 \begin_layout Plain Layout
3964 For a complex document with external material (images, etc.), if you make
3966 \begin_inset space \thinspace{}
3970 \begin_inset space \space{}
3973 in a temp dir, beware that the links to external material may be broken
3974 when the document is moved to a different place.
3975 The best way is to retrieve the \SpecialChar LyX
3977 \begin_inset Flex URL
3980 \begin_layout Plain Layout
3982 https://www.lyx.org/HowToUseGIT
3987 ) and to edit the doc file in place.
3995 \begin_layout Itemize
3996 Sometimes the original document (from the \SpecialChar LyX
3997 team) will be updated.
3998 Use the source viewer at
3999 \begin_inset CommandInset href
4001 name "https://www.lyx.org/trac/timeline"
4002 target "https://www.lyx.org/trac/timeline"
4007 to see what has been changed.
4008 That way you can easily see which parts of the translated document need
4012 \begin_layout Standard
4013 If you ever find an error in the original document, fix it and notify the
4014 rest of the documentation team of the changes! (You didn't forget to join
4015 the documentation team, did you?)
4018 \begin_layout Standard
4019 \begin_inset Branch OutDated
4023 \begin_layout Section
4024 International Keyboard Support
4027 \begin_layout Standard
4030 [Editor's Note: The following section is by
4038 It needs to be fixed to conform to the new Documentation Style sheet and
4039 to make use of the new v1.0 features.
4040 The whole thing also needs to be merged with the section following it.-jw
4041 It may also be badly out of date.-rh (2008)]
4044 \begin_layout Subsection
4045 Defining Own Keymaps: Keymap File Format
4048 \begin_layout Standard
4049 Let's look at a keyboard definition file a little closer.
4050 It is a plain text file defining
4053 \begin_layout Itemize
4054 key-to-key or key-to-string translations
4057 \begin_layout Itemize
4061 \begin_layout Itemize
4062 dead keys exceptions
4065 \begin_layout Standard
4066 To define key-to-key or key-to-string translation, use this command:
4069 \begin_layout Quotation
4070 \begin_inset Flex Code
4073 \begin_layout Plain Layout
4082 \begin_inset Flex Code
4085 \begin_layout Plain Layout
4094 \begin_layout Standard
4096 \begin_inset Flex Code
4099 \begin_layout Plain Layout
4105 is the key to be translated and
4106 \begin_inset Flex Code
4109 \begin_layout Plain Layout
4115 is the string to be inserted into the document.
4116 To define dead keys, use:
4119 \begin_layout Quotation
4120 \begin_inset Flex Code
4123 \begin_layout Plain Layout
4132 \begin_inset Flex Code
4135 \begin_layout Plain Layout
4144 \begin_layout Standard
4146 \begin_inset Flex Code
4149 \begin_layout Plain Layout
4155 is a keyboard key and
4156 \begin_inset Flex Code
4159 \begin_layout Plain Layout
4166 The following dead keys are supported (shortcut name is in parentheses):
4169 \begin_layout Quotation
4173 \begin_inset space \hfill{}
4179 \begin_layout Quotation
4181 \begin_inset space \hfill{}
4187 \begin_layout Quotation
4189 \begin_inset space \hfill{}
4195 \begin_layout Quotation
4197 \begin_inset space \hfill{}
4203 \begin_layout Quotation
4205 \begin_inset space \hfill{}
4211 \begin_layout Quotation
4213 \begin_inset space \hfill{}
4220 \begin_layout Plain Layout
4232 \begin_layout Quotation
4234 \begin_inset space \hfill{}
4240 \begin_layout Quotation
4242 \begin_inset space \hfill{}
4249 \begin_layout Plain Layout
4261 \begin_layout Quotation
4263 \begin_inset space \hfill{}
4269 \begin_layout Quotation
4271 \begin_inset space \hfill{}
4277 \begin_layout Quotation
4279 \begin_inset space \hfill{}
4286 \begin_layout Plain Layout
4298 \begin_layout Quotation
4300 \begin_inset space \hfill{}
4307 \begin_layout Plain Layout
4319 \begin_layout Quotation
4321 \begin_inset space \hfill{}
4327 \begin_layout Quotation
4328 hungarian umlaut (hug)
4329 \begin_inset space \hfill{}
4335 \begin_layout Quotation
4337 \begin_inset space \hfill{}
4343 \begin_layout Quotation
4345 \begin_inset space \hfill{}
4352 \begin_layout Plain Layout
4364 \begin_layout Standard
4365 Since in many international keyboards there are exceptions to what some
4366 dead keys should do, you can define them using
4369 \begin_layout Quotation
4370 \begin_inset Flex Code
4373 \begin_layout Plain Layout
4381 deadkey key outstring
4384 \begin_layout Standard
4385 For example, on Slovak keyboard, if you enter caron-o, it generates circumflex-o
4389 \begin_layout Quotation
4390 \begin_inset Flex Code
4393 \begin_layout Plain Layout
4406 \begin_layout Standard
4407 to make it work correctly.
4408 Also, you have to define as exceptions dead keys over i and j, to remove
4409 the dot from them before inserting an accent mark.
4410 I will change this when the time comes, but so far I haven't had time.
4413 \begin_layout Standard
4414 Oh, and about characters: backslash is escaped, so to enter it, you'll need
4417 \begin_inset Flex Code
4420 \begin_layout Plain Layout
4426 have different meaning.
4428 \begin_inset Flex Code
4431 \begin_layout Plain Layout
4437 marks comments, quotes start and end \SpecialChar LaTeX
4439 To enter quote, you'll need to use
4440 \begin_inset Flex Code
4443 \begin_layout Plain Layout
4452 \begin_inset Flex Code
4455 \begin_layout Plain Layout
4462 \begin_inset Flex Code
4465 \begin_layout Plain Layout
4476 \begin_layout Standard
4477 If you make a keyboard description file that works for your language, please
4478 mail it to me, so I can include it in the next keymap distribution.
4481 \begin_layout Standard
4482 More keywords will be supported in keymap configuration file in future,
4486 \begin_layout Itemize
4487 \begin_inset Flex Code
4490 \begin_layout Plain Layout
4501 \begin_inset space \hfill{}
4505 \begin_inset Flex Code
4508 \begin_layout Plain Layout
4517 \begin_layout Itemize
4518 \begin_inset Flex Code
4521 \begin_layout Plain Layout
4532 \begin_inset space \hfill{}
4536 \begin_inset Flex Code
4539 \begin_layout Plain Layout
4545 an external keymap translation program
4548 \begin_layout Standard
4549 Also, it should look into
4550 \begin_inset Flex Code
4553 \begin_layout Plain Layout
4559 file for defaults, too (for example, a
4560 \begin_inset Flex Code
4563 \begin_layout Plain Layout
4571 option to include default keyboard).
4579 \begin_layout Section
4580 International Keymap Stuff
4581 \begin_inset CommandInset label
4583 name "sec:International-Keymap-Stuff"
4590 \begin_layout Standard
4591 \begin_inset Note Note
4594 \begin_layout Plain Layout
4595 In doing the revisions on this document in March 2008, I did not look over
4596 this stuff, as I do not understand it.
4597 It would be good if someone else could do so.
4606 \begin_layout Standard
4607 The next two sections describe the
4608 \begin_inset Flex Code
4611 \begin_layout Plain Layout
4620 \begin_inset Flex Code
4623 \begin_layout Plain Layout
4631 file syntax in detail.
4632 These sections should help you design your own key map if the ones provided
4633 do not meet your needs.
4636 \begin_layout Subsection
4640 \begin_layout Standard
4644 \begin_inset Flex Code
4647 \begin_layout Plain Layout
4653 file maps keystrokes to characters or strings.
4654 As the name suggests, it sets a keyboard mapping.
4656 \begin_inset Flex Code
4659 \begin_layout Plain Layout
4670 \begin_inset Flex Code
4673 \begin_layout Plain Layout
4688 \begin_inset Flex Code
4691 \begin_layout Plain Layout
4704 \begin_inset Flex Code
4707 \begin_layout Plain Layout
4716 \begin_inset Flex Code
4719 \begin_layout Plain Layout
4727 are described in this section.
4730 \begin_layout Labeling
4731 \labelwidthstring 00.00.0000
4732 \begin_inset Flex Code
4735 \begin_layout Plain Layout
4743 Map a character to a string
4746 \begin_layout LyX-Code
4761 \begin_layout Standard
4794 the double-quote (")
4811 must be escaped with a preceding backslash (
4822 \begin_layout Standard
4824 \begin_inset Flex Noun
4827 \begin_layout Plain Layout
4835 statement to cause the symbol
4836 \begin_inset Flex Noun
4839 \begin_layout Plain Layout
4847 to be output for the keystroke
4848 \begin_inset Flex Noun
4851 \begin_layout Plain Layout
4862 \begin_layout LyX-Code
4868 \begin_layout Labeling
4869 \labelwidthstring 00.00.0000
4870 \begin_inset Flex Code
4873 \begin_layout Plain Layout
4881 Specify an accent character
4884 \begin_layout LyX-Code
4893 \begin_layout Standard
4894 This will make the cha
4932 This is the dead key
4936 \begin_layout Plain Layout
4943 refers to a key that does not produce a character by itself, but when followed
4944 with another key, produces the desired accent character.
4945 For example, a German characte
4947 r with an umlaut like
4957 can be produced in this manner.
4966 \begin_layout Standard
4979 and then another key not in
4996 followed by the other, not allowed key, as output.
5000 \begin_inset Flex Noun
5003 \begin_layout Plain Layout
5011 cancels a dead key, so if
5022 \begin_inset Flex Noun
5025 \begin_layout Plain Layout
5034 , the cursor will not go one position backwards but will instead cancel
5050 might have had on the next keystroke.
5054 \begin_layout Standard
5055 The following example specifies that the character ' is to be an acute accent,
5056 allowed on the characters a, e, i, o, u, A, E, I, O, and U:
5059 \begin_layout LyX-Code
5062 kmod ' acute aeiouAEIOU
5065 \begin_layout Labeling
5066 \labelwidthstring 00.00.0000
5067 \begin_inset Flex Code
5070 \begin_layout Plain Layout
5076 Specify an exception to the accent character
5079 \begin_layout LyX-Code
5088 \begin_layout Standard
5089 This defines an exce
5130 have been assigned a keystroke with a previous
5133 \begin_inset Flex Code
5136 \begin_layout Plain Layout
5160 must not belong in the
5207 If such a declaration does not exist in
5215 \begin_inset Flex Code
5218 \begin_layout Plain Layout
5252 \begin_inset Flex Code
5255 \begin_layout Plain Layout
5269 \begin_layout Standard
5270 The following command produces causes äi to be produced when you enter acute-i
5274 \begin_layout LyX-Code
5288 \begin_layout Labeling
5289 \labelwidthstring 00.00.0000
5290 \begin_inset Flex Code
5293 \begin_layout Plain Layout
5299 Combine two accent characters
5302 \begin_layout LyX-Code
5308 accent1 accent2 allowed
5311 \begin_layout Standard
5312 This one is getting pretty esoteric.
5313 It allows you to combine the effect
5369 \begin_inset Flex Code
5372 \begin_layout Plain Layout
5400 \begin_layout Standard
5401 Consider this example from the
5402 \begin_inset Flex Code
5405 \begin_layout Plain Layout
5416 \begin_layout LyX-Code
5419 kmod ; acute aeioyvhAEIOYVH
5423 kcomb acute umlaut iyIY
5426 \begin_layout Standard
5427 This allows you to press
5428 \begin_inset Flex Noun
5431 \begin_layout Plain Layout
5439 and get the effect of
5440 \begin_inset Flex Code
5443 \begin_layout Plain Layout
5462 in this case cancels the last dead key, so if you press
5463 \begin_inset Flex Noun
5466 \begin_layout Plain Layout
5475 \begin_inset Flex Code
5478 \begin_layout Plain Layout
5491 \begin_layout Subsection
5495 \begin_layout Standard
5497 \begin_inset Flex Code
5500 \begin_layout Plain Layout
5508 mapping is performed, a
5509 \begin_inset Flex Code
5512 \begin_layout Plain Layout
5522 file maps the strings that the symbols generate to characters in the current
5524 The \SpecialChar LyX
5525 distribution currently includes at least the
5526 \begin_inset Flex Code
5529 \begin_layout Plain Layout
5538 \begin_inset Flex Code
5541 \begin_layout Plain Layout
5552 \begin_layout Standard
5554 \begin_inset Flex Code
5557 \begin_layout Plain Layout
5565 file is a sequence of declarations of the form
5568 \begin_layout LyX-Code
5581 \begin_layout Standard
5582 For example, in order to map
5583 \begin_inset Flex Noun
5586 \begin_layout Plain Layout
5596 to the corresponding character in the iso-8859-1 set (233), the following
5600 \begin_layout LyX-Code
5608 \begin_layout Standard
5610 \begin_inset Flex Code
5613 \begin_layout Plain Layout
5622 \begin_inset Flex Code
5625 \begin_layout Plain Layout
5643 the same character can apply to more than one string.
5645 \begin_inset Flex Code
5648 \begin_layout Plain Layout
5659 \begin_layout LyX-Code
5671 \begin_inset Newline newline
5687 \begin_layout Standard
5689 cannot find a mapping for the string produced by the keystroke or a
5690 deadkey sequence, it will check if it looks like an accented char and try
5691 to draw an accent over the character on screen.
5694 \begin_layout Subsection
5698 \begin_layout Standard
5699 There is a second way to add support for international characters through
5700 so-called dead-keys.
5701 A dead-key works in combination with a letter to produce an accented character.
5702 Here, we'll explain how to create a really simple dead-key to illustrate
5706 \begin_layout Standard
5707 Suppose you happen to need the circumflex character,
5708 \begin_inset Quotes eld
5712 \begin_inset Quotes erd
5717 \begin_inset Flex Noun
5720 \begin_layout Plain Layout
5727 \begin_inset space ~
5731 \begin_inset Flex Noun
5734 \begin_layout Plain Layout
5740 ] to the \SpecialChar LyX
5742 \begin_inset Flex Code
5745 \begin_layout Plain Layout
5752 \begin_inset Flex Code
5755 \begin_layout Plain Layout
5762 Now, whenever you type the
5763 \begin_inset Flex Noun
5766 \begin_layout Plain Layout
5772 -key followed by a letter, that letter will have a circumflex accent on
5774 For example, the sequence
5775 \begin_inset Quotes eld
5779 \begin_inset Flex Noun
5782 \begin_layout Plain Layout
5789 \begin_inset Quotes erd
5792 produces the letter:
5793 \begin_inset Quotes eld
5797 \begin_inset Quotes erd
5801 If you tried to type
5802 \begin_inset Quotes eld
5806 \begin_inset Flex Noun
5809 \begin_layout Plain Layout
5816 \begin_inset Quotes erd
5819 , however, \SpecialChar LyX
5820 will complain with a beep, since a
5821 \begin_inset Quotes eld
5825 \begin_inset Flex Noun
5828 \begin_layout Plain Layout
5835 \begin_inset Quotes erd
5838 never takes a circumflex accent.
5840 \begin_inset Flex Noun
5843 \begin_layout Plain Layout
5849 after a dead-key produces the bare-accent.
5850 Please note this last point! If you bind a key to a dead-key, you'll need
5851 to rebind the character on that key to yet another key.
5853 \begin_inset Flex Noun
5856 \begin_layout Plain Layout
5862 to a cedilla is a bad idea, since you'll only get cedillas instead of commas.
5865 \begin_layout Standard
5866 One common way to bind dead-keys is to use
5867 \begin_inset Flex Noun
5870 \begin_layout Plain Layout
5877 \begin_inset Flex Noun
5880 \begin_layout Plain Layout
5887 \begin_inset Flex Noun
5890 \begin_layout Plain Layout
5896 in combination with an accent, like
5897 \begin_inset Quotes eld
5901 \begin_inset Flex Noun
5904 \begin_layout Plain Layout
5911 \begin_inset Quotes erd
5915 \begin_inset Quotes eld
5919 \begin_inset Flex Noun
5922 \begin_layout Plain Layout
5929 \begin_inset Quotes erd
5933 \begin_inset Quotes eld
5937 \begin_inset Flex Noun
5940 \begin_layout Plain Layout
5947 \begin_inset Quotes erd
5951 Another way involves using
5952 \begin_inset Flex Code
5955 \begin_layout Plain Layout
5962 \begin_inset Flex Code
5965 \begin_layout Plain Layout
5971 to set up the special
5972 \begin_inset Flex Code
5975 \begin_layout Plain Layout
5983 \begin_inset Flex Code
5986 \begin_layout Plain Layout
5992 acts in some ways just like
5993 \begin_inset Flex Noun
5996 \begin_layout Plain Layout
6002 and permits you to bind keys to accented characters.
6003 You can also turn keys into dead-keys by binding them to something like
6005 \begin_inset Flex Code
6008 \begin_layout Plain Layout
6014 and then binding this symbolic key to the corresponding \SpecialChar LyX
6019 \begin_layout Plain Layout
6024 : This is exactly what I do in my
6025 \begin_inset Flex Code
6028 \begin_layout Plain Layout
6035 \begin_inset Flex Code
6038 \begin_layout Plain Layout
6046 \begin_inset Flex Noun
6049 \begin_layout Plain Layout
6051 \begin_inset space ~
6060 \begin_inset Flex Code
6063 \begin_layout Plain Layout
6069 and a bunch of these
6070 \begin_inset Quotes eld
6074 \begin_inset Flex Code
6077 \begin_layout Plain Layout
6084 \begin_inset Quotes erd
6087 symbolic keys bound such things as
6088 \begin_inset Flex Noun
6091 \begin_layout Plain Layout
6093 \begin_inset space ~
6102 \begin_inset Flex Noun
6105 \begin_layout Plain Layout
6107 \begin_inset space ~
6116 This is how I produce my accented characters.
6121 You can make just about anything into the
6122 \begin_inset Flex Code
6125 \begin_layout Plain Layout
6132 \begin_inset Flex Noun
6135 \begin_layout Plain Layout
6141 keys, a spare function key, etc.
6142 As for the \SpecialChar LyX
6143 commands that produce accents, check the entry for
6144 \begin_inset Flex Code
6147 \begin_layout Plain Layout
6158 You'll find the complete list there.
6161 \begin_layout Subsection
6162 Saving your Language Configuration
6165 \begin_layout Standard
6166 You can edit your preferences so that your desired language environment
6167 is automatically configured when \SpecialChar LyX
6169 \begin_inset Flex Noun
6172 \begin_layout Plain Layout
6173 Edit\SpecialChar menuseparator
6182 \begin_layout Chapter
6184 \change_inserted -584632292 1610232084
6187 Installing New Document Classes, Layouts, and Templates
6188 \begin_inset CommandInset label
6190 name "cha:Installing-New-Document"
6195 \begin_inset Argument 1
6198 \begin_layout Plain Layout
6199 Installing New Document Classes
6207 \begin_layout Standard
6208 In this chapter, we describe the procedures for creating and installing
6209 new \SpecialChar LyX
6210 layout and template files, as well as offer a refresher on correctly
6211 installing new \SpecialChar LaTeX
6216 \begin_layout Standard
6217 First, let us a say a few words about how one ought to think about the relation
6218 between \SpecialChar LyX
6219 and \SpecialChar LaTeX
6221 The thing to understand is that, in a certain sense, \SpecialChar LyX
6222 doesn't know anything
6223 about \SpecialChar LaTeX
6225 Indeed, from \SpecialChar LyX
6226 's point of view, \SpecialChar LaTeX
6227 is just one of several
6228 \begin_inset Quotes eld
6232 \begin_inset Quotes erd
6235 in which it is capable of producing output.
6236 Other such formats are DocBook, plaintext, and XHTML.
6238 is, of course, a particularly important format, but very little of the
6239 information \SpecialChar LyX
6240 has about \SpecialChar LaTeX
6241 is actually contained in the program itself.
6245 \begin_layout Plain Layout
6246 Some commands are sufficiently complex that they are
6247 \begin_inset Quotes eld
6251 \begin_inset Quotes erd
6254 into \SpecialChar LyX
6256 But the developers generally regard this as a Bad Thing.
6261 Rather, that information, even for the standard classes like
6262 \begin_inset Flex Code
6265 \begin_layout Plain Layout
6271 , is contained in `layout files'.
6272 Similarly, \SpecialChar LyX
6273 itself does not know much about DocBook or XHTML.
6274 What it knows is contained in layout files.
6277 \begin_layout Standard
6278 You can think of the layout file for a given document class as a translation
6279 manual between \SpecialChar LyX
6280 constructs—paragraphs with their corresponding styles,
6281 certain sorts of insets, etc—and the corresponding \SpecialChar LaTeX
6284 Almost everything \SpecialChar LyX
6286 \begin_inset Flex Code
6289 \begin_layout Plain Layout
6295 , for example, is contained in the file
6296 \begin_inset Flex Code
6299 \begin_layout Plain Layout
6305 and in various other files it includes.
6306 For this reason, anyone intending to write layout files should plan to
6307 study the existing files.
6308 A good place to start is with
6309 \begin_inset Flex Code
6312 \begin_layout Plain Layout
6318 , which is included in
6319 \begin_inset Flex Code
6322 \begin_layout Plain Layout
6329 \begin_inset Flex Code
6332 \begin_layout Plain Layout
6338 , and many of the other layout files for document classes.
6339 This file is where sections and the like are defined:
6340 \begin_inset Flex Code
6343 \begin_layout Plain Layout
6349 tells \SpecialChar LyX
6350 how paragraphs that are marked with the Section, Subsection, etc,
6351 styles can be translated into corresponding \SpecialChar LaTeX
6352 , DocBook, and XHTML commands
6355 \begin_inset Flex Code
6358 \begin_layout Plain Layout
6364 file basically just includes several of these
6365 \begin_inset Flex Code
6368 \begin_layout Plain Layout
6377 \begin_layout Standard
6378 Defining the \SpecialChar LyX
6380 correspondence is not the only thing layout files do, though.
6381 Their other job is to define how the \SpecialChar LyX
6382 constructs themselves will appear
6384 The fact that layout files have these two jobs is often a source of confusion,
6385 because they are completely separate.
6386 Telling \SpecialChar LyX
6387 how to translate a certain paragraph style into \SpecialChar LaTeX
6390 how to display it; conversely, telling \SpecialChar LyX
6391 how to display a certain paragraph
6392 style does not tell \SpecialChar LyX
6393 how to translate it into \SpecialChar LaTeX
6394 (let alone tell \SpecialChar LaTeX
6397 So, in general, when you define a new \SpecialChar LyX
6398 construct, you must always do two
6399 quite separate things: (i)
6400 \begin_inset space ~
6403 tell \SpecialChar LyX
6404 how to translate it into \SpecialChar LaTeX
6406 \begin_inset space ~
6409 tell \SpecialChar LyX
6413 \begin_layout Standard
6414 Much the same is true, of course, as regards \SpecialChar LyX
6415 's other backend formats, though
6416 XHTML is in some ways different, because in that case \SpecialChar LyX
6421 able, to some extent, to use information about how it should display a
6422 paragraph on the screen to output information (in the form of CSS) about
6423 how the paragraph should be displayed in a browser.
6424 Even in this case, however, the distinction between what \SpecialChar LyX
6426 and how things are rendered externally remains in force, and the two can
6427 be controlled separately.
6429 \begin_inset CommandInset ref
6431 reference "sec:Tags-for-XHTML"
6438 \begin_layout Section
6439 Installing new \SpecialChar LaTeX
6443 \begin_layout Standard
6444 Some installations may not include a \SpecialChar LaTeX
6445 package or class file that you would
6446 like to use within \SpecialChar LyX
6448 For example, you might need Foil\SpecialChar TeX
6449 , a package for preparing slides for overhead
6451 Modern \SpecialChar LaTeX
6452 distributions like \SpecialChar TeX
6453 Live (2008 or newer) or MiK\SpecialChar TeX
6454 provide a user interface
6455 for installing such packages.
6456 For example, with MiK\SpecialChar TeX
6457 , you start the program
6458 \begin_inset Quotes eld
6462 \begin_inset space ~
6466 \begin_inset Quotes erd
6469 to get a list of available packages.
6470 To install one of them, right click on it or use the corresponding toolbar
6474 \begin_layout Standard
6475 If your \SpecialChar LaTeX
6476 distribution does not provide such a `package manager', or if the
6477 package is not available from your distribution, then follow these steps
6478 to install it manually:
6481 \begin_layout Enumerate
6482 Get the package from
6483 \begin_inset CommandInset href
6486 target "http://www.ctan.org/"
6494 \begin_layout Enumerate
6495 If the package contains a file with the ending
6496 \begin_inset Quotes eld
6500 \begin_inset Flex Code
6503 \begin_layout Plain Layout
6510 \begin_inset Quotes erd
6513 (is the case for Foil\SpecialChar TeX
6514 ) then open a console, change to the folder of this
6515 file and execute the command
6516 \begin_inset Flex Code
6519 \begin_layout Plain Layout
6526 You have now unpacked the package and have all files to install it.
6527 Most \SpecialChar LaTeX
6528 -packages are not packed and you can skip this step.
6531 \begin_layout Enumerate
6532 Now you need to decide if the package should be available for all users
6537 \begin_layout Enumerate
6538 On *nix systems (Linux, OSX, etc.), if you want the new package to be available
6539 for all users on your system, then install it in your `local' \SpecialChar TeX
6541 install it in your own `user' \SpecialChar TeX
6543 Where these trees should be created, if they do not already exist, depends
6545 To find this out, look in the file
6546 \begin_inset Flex Code
6549 \begin_layout Plain Layout
6559 \begin_layout Plain Layout
6560 This is usually in the directory
6561 \begin_inset Flex Code
6564 \begin_layout Plain Layout
6570 , though you can execute the command
6571 \begin_inset Flex Code
6574 \begin_layout Plain Layout
6585 The location of the `local' \SpecialChar TeX
6586 tree is defined by the
6587 \begin_inset Flex Code
6590 \begin_layout Plain Layout
6596 variable; this is usually somewhere like
6597 \begin_inset Flex Code
6600 \begin_layout Plain Layout
6601 /usr/local/share/texmf
6606 or /usr/local/texlive/XXXX where XXXX is the year of the installed \SpecialChar TeX
6609 The location of the `user' \SpecialChar TeX
6611 \begin_inset Flex Code
6614 \begin_layout Plain Layout
6621 \begin_inset Flex Code
6624 \begin_layout Plain Layout
6631 \begin_inset Flex Code
6634 \begin_layout Plain Layout
6643 (If these variables are not predefined, you have to define them.) You'll
6644 probably need root permissions to create or modify the `local' tree, but
6645 not for your `user' tree.
6646 \begin_inset Newline newline
6649 In general, it is recommended to install in the user tree because your user
6650 will not be modified or even overwritten when you upgrade your system.
6651 It will typically also be backed up together with everything else when
6652 you backup your home directory (which, of course, you do on a regular basis).
6655 \begin_layout Enumerate
6656 On Windows, if you want the new package to be available for all users on
6657 your system, change to the folder where \SpecialChar LaTeX
6658 is installed and then change to
6660 \begin_inset Flex Code
6663 \begin_layout Plain Layout
6674 (For MiK\SpecialChar TeX
6675 , this would be by default the folder
6676 \begin_inset Flex Code
6679 \begin_layout Plain Layout
6697 \begin_layout Plain Layout
6698 Note that this will be the correct path only on English installations.
6699 On a German one, it would be
6700 \begin_inset Flex Code
6703 \begin_layout Plain Layout
6717 , and similarly for other languages.
6722 Create there a new folder
6723 \begin_inset Flex Code
6726 \begin_layout Plain Layout
6732 and copy all files of the package into it.
6734 \begin_inset Newline newline
6737 If the package should only available for you or you don't have admin permissions
6738 , do the same, but in the local \SpecialChar LaTeX
6741 \begin_inset space \thinspace{}
6744 g., for MiK\SpecialChar TeX
6746 \begin_inset space ~
6749 2.8 under Windows XP, this would be the folder:
6750 \begin_inset Newline newline
6756 \begin_inset Flex Code
6759 \begin_layout Plain Layout
6762 Documents and Settings
6774 \begin_inset Newline newline
6780 \begin_inset Phantom HPhantom
6783 \begin_layout Plain Layout
6794 \begin_inset Flex Code
6797 \begin_layout Plain Layout
6810 \begin_inset Newline newline
6813 On Vista, it would be:
6814 \begin_inset Newline newline
6818 \begin_inset Flex Code
6821 \begin_layout Plain Layout
6847 \begin_layout Enumerate
6848 Now one only need to tell \SpecialChar LaTeX
6849 that there are new files.
6850 This depends on the used \SpecialChar LaTeX
6855 \begin_layout Enumerate
6856 For \SpecialChar TeX
6857 Live execute the command
6858 \begin_inset Flex Code
6861 \begin_layout Plain Layout
6868 If you installed the package for all users, then you will probably need
6869 to have root permissions for that.
6872 \begin_layout Enumerate
6873 For MiK\SpecialChar TeX
6874 , if you have installed the package for all users, start the program
6876 \begin_inset Quotes eld
6880 \begin_inset space ~
6884 \begin_inset Quotes erd
6887 and press the button marked
6888 \begin_inset Quotes eld
6892 \begin_inset Quotes erd
6896 Otherwise start the program
6897 \begin_inset Quotes eld
6901 \begin_inset Quotes erd
6908 \begin_layout Enumerate
6909 Finally, you need to tell \SpecialChar LyX
6910 that there are new packages available.
6911 So, in \SpecialChar LyX
6913 \begin_inset Flex Noun
6916 \begin_layout Plain Layout
6919 \SpecialChar menuseparator
6925 and then restart \SpecialChar LyX
6929 \begin_layout Standard
6930 Now the package is installed.
6931 In our example, the document class
6932 \begin_inset Flex Code
6935 \begin_layout Plain Layout
6941 will now be available under
6942 \begin_inset Flex Noun
6945 \begin_layout Plain Layout
6946 Document\SpecialChar menuseparator
6947 Settings\SpecialChar menuseparator
6954 \begin_inset Quotes eld
6958 \begin_inset Quotes erd
6965 \begin_layout Standard
6966 If you would like to use a \SpecialChar LaTeX
6967 document class that is not even listed in the
6969 \begin_inset Flex Noun
6972 \begin_layout Plain Layout
6973 Document\SpecialChar menuseparator
6974 Settings\SpecialChar menuseparator
6980 , then you need to create a `layout' file for it.
6981 That is the topic of the next section.
6984 \begin_layout Section
6985 Types of layout files
6988 \begin_layout Standard
6989 This section describes the various sorts of \SpecialChar LyX
6990 files that contain layout informati
6992 These files describe various paragraph and character styles, determining
6993 how \SpecialChar LyX
6994 should display them and how they should be translated into \SpecialChar LaTeX
6996 XHTML, or whatever output format is being used.
7000 \begin_layout Standard
7001 We shall try to provide a thorough description of the process of writing
7003 However, there are so many different types of documents supported even
7004 by just \SpecialChar LaTeX
7005 that we can't hope to cover every different possibility or problem
7006 you might encounter.
7007 The \SpecialChar LyX
7008 users' list is frequented by people with lots of experience with layout
7009 design who are willing to share what they've learned, so please feel free
7010 to ask questions there.
7013 \begin_layout Standard
7014 As you prepare to write a new layout, it is extremely helpful to look at
7015 the layouts distributed with \SpecialChar LyX
7017 If you write a \SpecialChar LyX
7018 layout for a \SpecialChar LaTeX
7019 document class that might also be used by
7020 others, or write a module that might be useful to others, then you should
7021 consider posting your layout to the
7022 \begin_inset CommandInset href
7024 name "layout section on the LyX wiki"
7025 target "https://wiki.lyx.org/Layouts/Layouts"
7030 or even to the \SpecialChar LyX
7031 developers' list, so that it might be included in \SpecialChar LyX
7036 \begin_layout Plain Layout
7037 Note that \SpecialChar LyX
7038 is licensed under the General Public License, so any material
7039 that is contributed to \SpecialChar LyX
7040 must be similarly licensed.
7048 \begin_layout Subsection
7050 \begin_inset CommandInset label
7052 name "subsec:Layout-modules"
7059 \begin_layout Standard
7060 We have spoken to this point about `layout files'.
7061 But there are different sorts of files that contain layout information.
7062 Layout files, strictly so called, have the
7063 \begin_inset Flex Code
7066 \begin_layout Plain Layout
7072 extension and provide \SpecialChar LyX
7073 with information about document classes.
7074 Since \SpecialChar LyX
7075 1.6 layout information can also be contained in layout
7080 \begin_inset Flex Code
7083 \begin_layout Plain Layout
7090 Modules are to \SpecialChar LaTeX
7091 packages much as layouts are to \SpecialChar LaTeX
7092 classes, and some modules—such
7094 \begin_inset Flex Code
7097 \begin_layout Plain Layout
7103 module—specifically provide support for one package.
7104 In a sense, layout modules are similar to included
7108 \begin_layout Plain Layout
7109 These can have any extension, but by convention have the
7110 \begin_inset Flex Code
7113 \begin_layout Plain Layout
7125 \begin_inset Flex Code
7128 \begin_layout Plain Layout
7134 —in that modules are not specific to a given document class but may be used
7135 with many different classes.
7136 The difference is that using an included file with
7137 \begin_inset Flex Code
7140 \begin_layout Plain Layout
7146 requires editing that file.
7147 Modules, by contrast, are selected in the
7148 \begin_inset Flex Noun
7151 \begin_layout Plain Layout
7152 Document\SpecialChar menuseparator
7161 \begin_layout Standard
7162 Building modules is the easiest way to get started with layout editing,
7163 since it can be as simple as adding a single new paragraph style or flex
7165 But modules may, in principle, contain anything a layout file can contain.
7168 \begin_layout Standard
7169 After creating a new module and copying it to the
7170 \begin_inset Flex Code
7173 \begin_layout Plain Layout
7179 folder, you will need to reconfigure and then restart \SpecialChar LyX
7182 However, changes you make to the module will be seen immediately, if you
7184 \begin_inset Flex Noun
7187 \begin_layout Plain Layout
7188 Document\SpecialChar menuseparator
7194 , highlight something, and then hit
7195 \begin_inset Quotes eld
7199 \begin_inset Quotes erd
7205 It is strongly recommended that you save your work before doing this
7210 it is strongly recommended that you not attempt to edit modules while simultaneo
7211 usly working on actual documents
7214 Though of course the developers strive to keep \SpecialChar LyX
7215 stable in such situations,
7216 syntax errors and the like in your module file could cause strange behavior.
7219 \begin_layout Subsubsection
7223 \begin_layout Standard
7224 Modules are to \SpecialChar LyX
7225 as packages are to \SpecialChar LaTeX
7227 Sometimes, however, you find yourself wanting a specific inset or character
7228 style just for one document and writing a module that will also be available
7229 to other documents makes little sense.
7230 What you need is \SpecialChar LyX
7232 \begin_inset Quotes eld
7236 \begin_inset Quotes erd
7242 \begin_layout Standard
7243 You will find it under
7245 Document\SpecialChar menuseparator
7246 Settings\SpecialChar menuseparator
7250 The large text box allows you to enter anything that you might enter in
7251 a layout file or module.
7252 You can think of a document's local layout, in fact, as a module that belongs
7254 So, in particular, you must enter a
7255 \begin_inset Flex Code
7258 \begin_layout Plain Layout
7265 Any format is acceptable, but one would normally use the format current
7267 (In \SpecialChar LyX
7274 , the current layout format is
7283 \begin_layout Standard
7284 When you have entered something in the
7285 \begin_inset Flex Code
7288 \begin_layout Plain Layout
7294 pane, \SpecialChar LyX
7296 \begin_inset Quotes eld
7300 \begin_inset Quotes erd
7303 button at the bottom.
7304 Clicking this button will cause \SpecialChar LyX
7305 to determine whether what you have entered
7306 is valid layout information for the chosen format.
7308 will report the result but, unfortunately, will not tell you what errors
7309 there might have been.
7310 These will be written to the terminal, however, if \SpecialChar LyX
7311 is started from a terminal.
7312 You will not be permitted to save your local layout until you have entered
7316 \begin_layout Standard
7317 The warnings at the end of the previous section apply here, too.
7318 Do not play with local layout while you are actually working, especially
7319 if you have not saved your document.
7320 That said, using local layout with a test document can be a very convenient
7321 way to try out layout ideas, or even to start developing a module.
7324 \begin_layout Subsection
7326 \begin_inset Flex Noun
7329 \begin_layout Plain Layout
7338 \begin_layout Standard
7339 There are two situations you are likely to encounter when wanting to support
7340 a new \SpecialChar LaTeX
7341 document class, involving style (
7342 \begin_inset Flex Code
7345 \begin_layout Plain Layout
7351 ) files and \SpecialChar LaTeX2e
7353 \begin_inset Flex Code
7356 \begin_layout Plain Layout
7363 Supporting a style file is usually fairly easy.
7364 Supporting a new class file is a bit harder.
7365 We'll discuss the former in this section and the latter in the next.
7367 \change_deleted 5863208 1594239023
7368 Similar remarks apply, of course, if you want to support a new DocBook DTD.
7373 \begin_layout Standard
7374 The easier case is the one in which your new document class is provided
7375 as a style file that is to be used in conjunction with an already supported
7377 For the sake of the example, we'll assume that the style file is called
7379 \begin_inset Flex Noun
7382 \begin_layout Plain Layout
7388 and that it is meant to be used with
7389 \begin_inset Flex Noun
7392 \begin_layout Plain Layout
7398 , which is a standard class.
7402 \begin_layout Standard
7403 Start by copying the existing class's layout file into your local directory:
7407 \begin_layout Plain Layout
7408 Of course, which directory is your local directory will vary by platform,
7409 and \SpecialChar LyX
7410 allows you to specify your local directory on startup, too, using
7412 \begin_inset Flex Code
7415 \begin_layout Plain Layout
7429 \begin_layout LyX-Code
7430 cp report.layout ~/.lyx/layouts/myclass.layout
7433 \begin_layout Standard
7435 \begin_inset Flex Code
7438 \begin_layout Plain Layout
7444 and change the line:
7447 \begin_layout LyX-Code
7450 DeclareLaTeXClass{Report (Standard Class)}
7453 \begin_layout Standard
7457 \begin_layout LyX-Code
7460 DeclareLaTeXClass[report, myclass.sty]{Report (My Class)}
7463 \begin_layout Standard
7467 \begin_layout LyX-Code
7469 \begin_inset Newline newline
7475 \begin_inset Newline newline
7481 \begin_layout Standard
7482 near the top of the file.
7485 \begin_layout Standard
7486 Start \SpecialChar LyX
7488 \begin_inset Flex Noun
7491 \begin_layout Plain Layout
7492 Tools\SpecialChar menuseparator
7499 Then restart \SpecialChar LyX
7500 and try creating a new document.
7502 \begin_inset Flex Noun
7505 \begin_layout Plain Layout
7511 " as a document class option in the
7512 \begin_inset Flex Noun
7515 \begin_layout Plain Layout
7516 Document\SpecialChar menuseparator
7523 It is likely that some of the sectioning commands and such in your new
7524 class will work differently from how they worked in the base class—
7525 \begin_inset Flex Code
7528 \begin_layout Plain Layout
7534 in this example—so you can fiddle around with the settings for the different
7535 sections if you wish.
7536 The layout information for sections is contained in
7537 \begin_inset Flex Code
7540 \begin_layout Plain Layout
7546 , but you do not need to copy and change this file.
7547 Instead, you can simply add your changes to your layout file, after the
7549 \begin_inset Flex Code
7552 \begin_layout Plain Layout
7558 , which itself includes
7559 \begin_inset Flex Code
7562 \begin_layout Plain Layout
7569 For example, you might add these lines:
7572 \begin_layout LyX-Code
7576 \begin_layout LyX-Code
7580 \begin_layout LyX-Code
7584 \begin_layout LyX-Code
7588 \begin_layout LyX-Code
7592 \begin_layout Standard
7593 to change the font for chapter headings to sans-serif.
7594 This will override (or, in this case, add to) the existing declaration
7595 for the Chapter style.
7599 \begin_layout Standard
7600 Your new package may also provide commands or environments not present in
7602 In this case, you will want to add these to the layout file.
7604 \begin_inset CommandInset ref
7606 reference "sec:TextClass"
7610 for information on how to do so.
7613 \begin_layout Standard
7615 \begin_inset Flex Noun
7618 \begin_layout Plain Layout
7624 can be used with several different document classes, and even if it cannot,
7625 you might find it easiest just to write a module that you can load with
7627 The simplest possible such module would be:
7630 \begin_layout LyX-Code
7633 DeclareLyXModule{My Class}
7636 \begin_layout LyX-Code
7640 \begin_layout LyX-Code
7641 #Support for myclass.sty.
7644 \begin_layout LyX-Code
7646 \begin_inset Newline newline
7652 \begin_layout LyX-Code
7660 \begin_inset Newline newline
7666 \begin_layout LyX-Code
7668 \begin_inset Newline newline
7674 \begin_inset Newline newline
7680 \begin_layout Standard
7681 A more complex module might modify the behavior of some existing constructs
7682 or define some new ones.
7684 \begin_inset CommandInset ref
7686 reference "sec:TextClass"
7693 \begin_layout Subsection
7695 \begin_inset Flex Noun
7698 \begin_layout Plain Layout
7707 \begin_layout Standard
7708 There are two possibilities here.
7709 One is that the class file is itself based upon an existing document class.
7710 For example, many thesis classes are based upon
7711 \begin_inset Flex Noun
7714 \begin_layout Plain Layout
7721 To see whether yours is, look for a line like
7724 \begin_layout LyX-Code
7730 \begin_layout Standard
7732 If so, then you may proceed largely as in the previous section, though
7734 \begin_inset Flex Code
7737 \begin_layout Plain Layout
7738 Declare\SpecialChar LaTeX
7744 line will be different.
7745 If your new class is
7746 \begin_inset Flex Code
7749 \begin_layout Plain Layout
7755 and it is based upon
7756 \begin_inset Flex Code
7759 \begin_layout Plain Layout
7765 , then the line should read:
7769 \begin_layout Plain Layout
7770 And it will be easiest if you save the file to
7771 \begin_inset Flex Code
7774 \begin_layout Plain Layout
7781 assumes that the document class has the same name as the layout file.
7790 \begin_layout LyX-Code
7793 DeclareLaTeXClass[thesis,book]{thesis}
7796 \begin_layout Standard
7797 If, on the other hand, the new class is not based upon an existing class,
7798 you will probably have to
7799 \begin_inset Quotes eld
7803 \begin_inset Quotes erd
7807 We strongly suggest copying an existing layout file which uses a similar
7809 class and then modifying it, if you can do so.
7810 At least use an existing file as a starting point so you can find out what
7811 items you need to worry about.
7812 Again, the specifics are covered below.
7815 \begin_layout Subsection
7817 \begin_inset CommandInset label
7819 name "subsec:Creating-Templates"
7826 \begin_layout Standard
7827 Once you have written a layout file for a new document class, you might
7828 want to consider writing a
7833 A template acts as a kind of tutorial for your layout, showing how it might
7834 be used, though containing dummy content.
7835 You can of course look at the various templates included with \SpecialChar LyX
7839 \begin_layout Standard
7840 Templates are created just like usual documents: using \SpecialChar LyX
7842 The only difference is that usual documents contain all possible settings,
7843 including the font scheme and the paper size.
7844 Usually a user doesn't want a template to overwrite his preferred settings
7845 for such parameters.
7846 For that reason, the designer of a template should remove the corresponding
7848 \begin_inset Flex Code
7851 \begin_layout Plain Layout
7860 \begin_inset Flex Code
7863 \begin_layout Plain Layout
7871 from the template \SpecialChar LyX
7873 This can be done with any simple text-editor, for example
7874 \begin_inset Flex Code
7877 \begin_layout Plain Layout
7884 \begin_inset Flex Code
7887 \begin_layout Plain Layout
7896 \begin_layout Standard
7897 Put the edited template files you create in
7898 \begin_inset Flex Code
7901 \begin_layout Plain Layout
7907 , copy the ones you use from the global template directory in
7908 \begin_inset Flex Code
7911 \begin_layout Plain Layout
7917 to the same place, and redefine the template path in the
7918 \begin_inset Flex Noun
7921 \begin_layout Plain Layout
7922 Tools\SpecialChar menuseparator
7923 Preferences\SpecialChar menuseparator
7932 \begin_layout Standard
7933 Note, by the way, that there is a template which has a particular meaning:
7934 \begin_inset Newline linebreak
7938 \begin_inset Flex Code
7941 \begin_layout Plain Layout
7948 This template is loaded every time you create a new document with
7949 \begin_inset Flex Noun
7952 \begin_layout Plain Layout
7953 File\SpecialChar menuseparator
7959 in order to provide useful defaults.
7960 To create this template from inside \SpecialChar LyX
7961 , all you have to do is to open a document
7962 with the correct settings, and use the
7963 \begin_inset Flex Noun
7966 \begin_layout Plain Layout
7967 Save as Document Defaults
7975 \begin_layout Subsection
7976 Upgrading old layout files
7979 \begin_layout Standard
7980 The format of layout files changes with each \SpecialChar LyX
7981 release, so old layout files
7982 need to be converted to the new format.
7984 reads a layout file in an older format, it automatically calls the
7986 \begin_inset Flex Code
7989 \begin_layout Plain Layout
7995 to convert it to a temporary file in current format.
7996 The original file is left untouched.
7997 If you use the layout file often, then, you may want to convert it permanently,
7998 so that \SpecialChar LyX
7999 does not have to do so itself every time.
8000 To do this, you can call the converter manually:
8003 \begin_layout Enumerate
8005 \begin_inset Flex Code
8008 \begin_layout Plain Layout
8015 \begin_inset Flex Code
8018 \begin_layout Plain Layout
8027 \begin_layout Enumerate
8029 \begin_inset Newline newline
8033 \begin_inset Flex Code
8036 \begin_layout Plain Layout
8037 python LyXDir/scripts/layout2layout.py myclass.old myclass.layout
8043 \begin_inset Newline newline
8047 \begin_inset Flex Code
8050 \begin_layout Plain Layout
8056 is the name of your \SpecialChar LyX
8060 \begin_layout Standard
8061 Note that manual conversion does not affect included files, so these will
8062 have to be converted separately.
8065 \begin_layout Subsection
8066 \begin_inset CommandInset label
8068 name "subsec:Cite-Engine-Files"
8075 \begin_layout Standard
8076 A specific form of layout files are the so-called
8077 \begin_inset Flex Code
8080 \begin_layout Plain Layout
8086 files that are located in the
8087 \begin_inset Flex Code
8090 \begin_layout Plain Layout
8097 Their purpose is to define the specifics of \SpecialChar LaTeX
8098 packages aimed at bibliography
8111 , but also the way how normal Bib\SpecialChar TeX
8112 citations (without additional packages)
8113 are handled in \SpecialChar LyX
8114 is defined in such a file.
8118 \begin_layout Standard
8119 More specifically, it is defined which packages \SpecialChar LyX
8120 needs to load, which citation
8121 commands are available, how these are to be displayed in \SpecialChar LyX
8123 the dialogs, the context menus) as well as in the XHTML and plain text
8125 Furthermore, the files specify available style variants (author-year, numerical
8126 , etc.) and their specifics.
8127 The cite engine files are also used to generate the options that are available
8130 Document\SpecialChar menuseparator
8131 Settings\SpecialChar menuseparator
8132 Bibliography\SpecialChar menuseparator
8138 \begin_layout Standard
8139 Even though a cite engine file is essentially a normal layout file that
8140 could theoretically include any layout information, it usually primarily
8141 includes some specific parameters such as
8142 \begin_inset Flex Code
8145 \begin_layout Plain Layout
8152 \begin_inset Flex Code
8155 \begin_layout Plain Layout
8162 \begin_inset Flex Code
8165 \begin_layout Plain Layout
8172 \begin_inset Flex Code
8175 \begin_layout Plain Layout
8182 The syntax of the latter two is described in
8183 \begin_inset CommandInset ref
8185 reference "subsec:Citation-engine-description"
8193 \begin_inset CommandInset ref
8195 reference "subsec:Citation-format-description"
8199 , as well as in the files themselves.
8202 \begin_layout Section
8203 \begin_inset CommandInset label
8205 name "sec:TextClass"
8209 The layout file format
8212 \begin_layout Standard
8213 The following sections describe how layout files are structured and written.
8214 Our advice is to go slowly, save and test often.
8215 It is really not that hard, except that the multitude of options can become
8216 overwhelming, especially if you try to check out too many at once.
8217 It becomes easier if you use existing layouts of \SpecialChar LyX
8218 as examples/reference
8219 or if you modify an existing layout to your needs.
8222 \begin_layout Standard
8223 Note that all the tags used in layout files are case-insensitive.
8225 \begin_inset Flex Code
8228 \begin_layout Plain Layout
8235 \begin_inset Flex Code
8238 \begin_layout Plain Layout
8245 \begin_inset Flex Code
8248 \begin_layout Plain Layout
8254 are really the same tag.
8255 The possible arguments are printed in brackets after the tag's name.
8256 The default argument is typeset
8257 \begin_inset Flex Code
8260 \begin_layout Plain Layout
8269 If the argument has a data type like
8270 \begin_inset Quotes eld
8274 \begin_inset Quotes erd
8278 \begin_inset Quotes eld
8282 \begin_inset Quotes erd
8285 , the default is shown like this:
8286 \begin_inset Flex Code
8289 \begin_layout Plain Layout
8300 \begin_layout Subsection
8301 The document class declaration and classification
8304 \begin_layout Standard
8305 Lines in a layout file which begin with
8306 \begin_inset Flex Code
8309 \begin_layout Plain Layout
8316 There is one exception to this rule.
8318 \begin_inset Flex Code
8321 \begin_layout Plain Layout
8327 files should begin with lines like:
8330 \begin_layout LyX-Code
8333 #% Do not delete the line below; configure depends on this
8336 \begin_layout LyX-Code
8341 DeclareLaTeXClass{Article (Standard Class)}
8344 \begin_layout LyX-Code
8349 DeclareCategory{Articles}
8352 \begin_layout Standard
8353 The second and third lines are used when you (re)configure \SpecialChar LyX
8355 The layout file is read by the \SpecialChar LaTeX
8357 \begin_inset Flex Code
8360 \begin_layout Plain Layout
8366 , in a special mode where
8367 \begin_inset Flex Code
8370 \begin_layout Plain Layout
8377 The first line is just a \SpecialChar LaTeX
8378 comment, the second one contains the mandatory
8379 declaration of the text class and the third line contains the optional
8380 classification of the class.
8381 If these lines appear in a file named
8382 \begin_inset Flex Code
8385 \begin_layout Plain Layout
8391 , then they define a text class of name
8392 \begin_inset Flex Code
8395 \begin_layout Plain Layout
8401 (the name of the layout file) which uses the \SpecialChar LaTeX
8403 \begin_inset Flex Code
8406 \begin_layout Plain Layout
8412 (the default is to use the same name as the layout).
8414 \begin_inset Quotes eld
8417 Article (Standard Class)
8418 \begin_inset Quotes erd
8421 that appears above is used as a description of the text class in the
8422 \begin_inset Flex Noun
8425 \begin_layout Plain Layout
8426 Document\SpecialChar menuseparator
8434 \begin_inset Quotes eld
8438 \begin_inset Quotes erd
8441 in the example) is also used in the
8442 \begin_inset Flex Noun
8445 \begin_layout Plain Layout
8446 Document\SpecialChar menuseparator
8452 dialog: the text classes are grouped by these categories (which are usually
8453 genres, so typical categories are
8454 \begin_inset Quotes eld
8458 \begin_inset Quotes erd
8462 \begin_inset Quotes eld
8466 \begin_inset Quotes erd
8470 \begin_inset Quotes eld
8474 \begin_inset Quotes erd
8478 \begin_inset Quotes eld
8482 \begin_inset Quotes erd
8486 \begin_inset Quotes eld
8490 \begin_inset Quotes erd
8494 \begin_inset Quotes eld
8498 \begin_inset Quotes erd
8502 If no category has been declared, the class will be put in the
8503 \begin_inset Quotes eld
8507 \begin_inset Quotes erd
8513 \begin_layout Standard
8514 Let's assume that you wrote your own text class that uses the
8515 \begin_inset Flex Code
8518 \begin_layout Plain Layout
8524 document class, but where you changed the appearance of the section headings.
8525 If you put it in a file
8526 \begin_inset Flex Code
8529 \begin_layout Plain Layout
8535 , the header of this file should be:
8538 \begin_layout LyX-Code
8541 #% Do not delete the line below; configure depends on this
8544 \begin_layout LyX-Code
8549 DeclareLaTeXClass[article]{Article (with My Own Headings)}
8552 \begin_layout LyX-Code
8557 DeclareCategory{Articles}
8560 \begin_layout Standard
8561 This declares a text class
8562 \begin_inset Flex Code
8565 \begin_layout Plain Layout
8571 , associated with the \SpecialChar LaTeX
8573 \begin_inset Flex Code
8576 \begin_layout Plain Layout
8583 \begin_inset Quotes eld
8586 Article (with My Own Headings)
8587 \begin_inset Quotes erd
8591 If your text class depends on several packages, you can declare it as:
8594 \begin_layout LyX-Code
8597 #% Do not delete the line below; configure depends on this
8600 \begin_layout LyX-Code
8605 DeclareLaTeXClass[article,foo.sty]{Article (with My Own Headings)}
8608 \begin_layout LyX-Code
8613 DeclareCategory{Articles}
8616 \begin_layout Standard
8617 This indicates that your text class uses the
8618 \begin_inset Flex Code
8621 \begin_layout Plain Layout
8629 \change_deleted 5863208 1594239179
8630 Finally, it is also possible to declare classes for DocBook code.
8631 Typical declarations will look like:
8634 \begin_layout LyX-Code
8636 \change_deleted 5863208 1594239179
8639 #% Do not delete the line below; configure depends on this
8642 \begin_layout LyX-Code
8644 \change_deleted 5863208 1594239179
8649 DeclareDocBookClass[article]{SGML (DocBook Article)}
8652 \begin_layout LyX-Code
8654 \change_deleted 5863208 1594239179
8659 DeclareCategory{Articles (DocBook)}
8664 \begin_layout Standard
8665 Note that these declarations can also be given an optional parameter declaring
8666 the name of the document class (but not a list).
8669 \begin_layout Standard
8670 So, to be as explicit as possible, the form of the layout declaration is:
8673 \begin_layout LyX-Code
8678 DeclareLaTeXClass[class,package.sty]{layout description}
8681 \begin_layout LyX-Code
8686 DeclareCategory{category}
8689 \begin_layout Standard
8690 The class need only be specified if the name of the \SpecialChar LaTeX
8692 name of the layout file are different or if there are packages to load.
8693 If the name of the class file is not specified, then \SpecialChar LyX
8695 that it is the same as the name of the layout file.
8698 \begin_layout Standard
8699 When the text class has been modified to your taste, all you have to do
8700 is to copy it either to
8701 \begin_inset Flex Code
8704 \begin_layout Plain Layout
8711 \begin_inset Flex Code
8714 \begin_layout Plain Layout
8721 \begin_inset Flex Noun
8724 \begin_layout Plain Layout
8725 Tools\SpecialChar menuseparator
8731 , exit \SpecialChar LyX
8733 Then your new text class should be available along with the others.
8736 \begin_layout Standard
8737 Once the layout file is installed, you can edit it and see your changes
8738 without having to reconfigure or to restart \SpecialChar LyX
8743 \begin_layout Plain Layout
8744 In versions of \SpecialChar LyX
8745 prior to 1.6, this was not true.
8746 As a result, editing layout files was very time consuming, since you had
8747 constantly to restart \SpecialChar LyX
8753 You can force a reload of the current layout by using the \SpecialChar LyX
8755 \begin_inset Flex Noun
8758 \begin_layout Plain Layout
8765 There is no default binding for this function—though, of course, you can
8766 bind it to a key yourself.
8767 But you will normally use this function simply by entering it in the mini-buffe
8772 \begin_layout Standard
8778 \begin_inset Flex Noun
8781 \begin_layout Plain Layout
8787 is very much an `advanced feature'.
8792 recommended that you save your work before using this function.
8797 recommended that you not attempt to edit layout information while simultaneousl
8798 y working on a document that you care about.
8799 Use a test document.
8800 Syntax errors and the like in your layout file could cause peculiar behavior.
8801 In particular, such errors could cause \SpecialChar LyX
8802 to regard the current layout as
8803 invalid and to attempt to switch to some other layout.
8807 \begin_layout Plain Layout
8808 Really bad syntax errors may even caused \SpecialChar LyX
8810 This is because certain sorts of errors may make \SpecialChar LyX
8821 The \SpecialChar LyX
8822 team strives to keep \SpecialChar LyX
8823 stable in such situations, but safe is better
8828 \begin_layout Plain Layout
8829 While we're giving advice: make regular backups.
8830 And be nice to your mother.
8838 \begin_layout Subsection
8839 The Module declaration
8842 \begin_layout Standard
8843 A module must begin with a line like the following:
8846 \begin_layout LyX-Code
8849 DeclareLyXModule[endnotes.sty]{Endnotes}
8850 \change_inserted -712698321 1554395911
8854 \begin_layout LyX-Code
8856 \change_inserted -712698321 1554395924
8861 DeclareCategory{Foot- and Endnotes}
8862 \change_deleted -712698321 1554395911
8870 \begin_layout Standard
8871 The mandatory argument
8872 \change_inserted -712698321 1554395956
8881 , in curly brackets, is the name of the module, as it should appear in
8882 \begin_inset Flex Noun
8885 \begin_layout Plain Layout
8886 Document\SpecialChar menuseparator
8887 Settings\SpecialChar menuseparator
8894 The argument in square brackets is optional: It declares any \SpecialChar LaTeX
8896 on which the module depends.
8897 It is also possible to use the form
8898 \begin_inset Flex Noun
8901 \begin_layout Plain Layout
8907 as an optional argument, which declares that the module can only be used
8908 when there exists a conversion chain between the formats `
8909 \begin_inset Flex Code
8912 \begin_layout Plain Layout
8919 \begin_inset Flex Code
8922 \begin_layout Plain Layout
8930 \change_inserted -712698321 1554396133
8937 declaration is not strictly mandatory, but you should add it, since it
8938 is helpful to find the module.
8939 Please have a look at the existing module categories and if appropriate,
8945 \begin_layout Standard
8947 \change_inserted -712698321 1554395988
8950 declaration should then be followed by lines like the following:
8954 \begin_layout Plain Layout
8955 Preferably in English if the module should be published with \SpecialChar LyX
8957 This description will appear in the list of messages to be translated and
8958 will be thus translated with the next interface update.
8966 \begin_layout LyX-Code
8970 \begin_layout LyX-Code
8971 #Adds an endnote command, in addition to footnotes.
8975 \begin_layout LyX-Code
8976 #You will need to add
8978 theendnotes in TeX code where you
8981 \begin_layout LyX-Code
8982 #want the endnotes to appear.
8986 \begin_layout LyX-Code
8990 \begin_layout LyX-Code
8991 #Requires: somemodule | othermodule
8994 \begin_layout LyX-Code
8995 #Excludes: badmodule
8998 \begin_layout Standard
8999 The description is used in
9000 \begin_inset Flex Noun
9003 \begin_layout Plain Layout
9004 Document\SpecialChar menuseparator
9005 Settings\SpecialChar menuseparator
9011 to provide the user with information about what the module does.
9013 \begin_inset Flex Code
9016 \begin_layout Plain Layout
9022 line is used to identify other modules with which this one must be used;
9024 \begin_inset Flex Code
9027 \begin_layout Plain Layout
9033 line is used to identify modules with which this one may not be used.
9034 Both are optional, and, as shown, multiple modules should be separated
9035 with the pipe symbol: |.
9036 Note that the required modules are treated disjunctively:
9040 of the required modules must be used.
9045 excluded module may be used.
9046 Note that modules are identified here by their filenames without the
9047 \begin_inset Flex Code
9050 \begin_layout Plain Layout
9058 \begin_inset Flex Code
9061 \begin_layout Plain Layout
9068 \begin_inset Flex Code
9071 \begin_layout Plain Layout
9080 \begin_layout Subsection
9081 The CiteEngine file declaration
9084 \begin_layout Standard
9085 A cite engine file must begin with a line like the following:
9088 \begin_layout LyX-Code
9091 DeclareLyXCiteEngineModule[biblatex.sty]{Biblatex}
9094 \begin_layout Standard
9095 The mandatory argument, in curly brackets, is the name of the cite style,
9096 as it should appear in
9097 \begin_inset Flex Noun
9100 \begin_layout Plain Layout
9101 Document\SpecialChar menuseparator
9102 Settings\SpecialChar menuseparator
9109 The argument in square brackets is optional: It declares any \SpecialChar LaTeX
9111 on which the cite engine depends.
9114 \begin_layout Standard
9115 The cite engine declaration should then be followed by lines like the following:
9119 \begin_layout Plain Layout
9120 Preferably in English if the module should be published with \SpecialChar LyX
9122 This description will appear in the list of messages to be translated and
9123 will be thus translated with the next interface update.
9131 \begin_layout LyX-Code
9135 \begin_layout LyX-Code
9136 # Biblatex supports many author-year and numerical styles.
9139 \begin_layout LyX-Code
9140 # It is mainly aimed at the Humanities.
9144 \begin_layout LyX-Code
9145 # customizable, fully localized and provides many features
9148 \begin_layout LyX-Code
9149 # that are not possible with BibTeX.
9150 The use of 'biber' as
9153 \begin_layout LyX-Code
9154 # bibliography processor is advised.
9157 \begin_layout LyX-Code
9161 \begin_layout Standard
9162 The description is used in
9163 \begin_inset Flex Noun
9166 \begin_layout Plain Layout
9167 Document\SpecialChar menuseparator
9168 Settings\SpecialChar menuseparator
9174 to provide the user with information about the cite engine.
9177 \begin_layout Subsection
9181 \begin_layout Standard
9182 The first non-comment line of any layout file, included file, or module
9187 contain the file format number:
9190 \begin_layout Description
9191 \begin_inset Flex Code
9194 \begin_layout Plain Layout
9201 \begin_inset Flex Code
9204 \begin_layout Plain Layout
9210 ] The format number of the layout file.
9213 \begin_layout Standard
9214 This tag was introduced with \SpecialChar LyX
9216 \begin_inset space ~
9220 Layout files from older \SpecialChar LyX
9221 versions do not have an explicit file format and
9222 are considered to have
9223 \begin_inset Flex Code
9226 \begin_layout Plain Layout
9228 \begin_inset space ~
9237 The format for the present version of \SpecialChar LyX
9239 But each version of \SpecialChar LyX
9240 is capable of reading earlier versions' layout files,
9241 just as they are capable of reading files produced by earlier versions
9244 There is, however, no provision for converting to earlier formats.
9247 \begin_layout Subsection
9248 \begin_inset CommandInset label
9250 name "subsec:General-text-class"
9254 General text class parameters
9257 \begin_layout Standard
9258 These are general parameters that govern the behavior of an entire document
9264 mean that they must appear in
9265 \begin_inset Flex Code
9268 \begin_layout Plain Layout
9274 files rather than in modules.
9275 A module can contain any layout tag.)
9278 \begin_layout Description
9280 \change_inserted -712698321 1526899478
9281 \begin_inset Flex Code
9284 \begin_layout Plain Layout
9286 \change_inserted -712698321 1526898610
9287 AddToCiteEngine <engine>
9294 Extends the possibilities for displaying citation references.
9296 \begin_inset CommandInset ref
9298 reference "subsec:Citation-engine-description"
9307 \begin_inset Flex Code
9310 \begin_layout Plain Layout
9312 \change_inserted -712698321 1526898823
9323 \begin_layout Description
9324 \begin_inset Flex Code
9327 \begin_layout Plain Layout
9333 Adds information that will be output in the
9334 \begin_inset Flex Code
9337 \begin_layout Plain Layout
9343 block when the document is output to XHTML.
9344 Typically, this would be used to output CSS style information, but it can
9345 be used for anything that can appear in
9346 \begin_inset Flex Code
9349 \begin_layout Plain Layout
9357 \begin_inset Quotes eld
9361 \begin_inset Flex Code
9364 \begin_layout Plain Layout
9371 \begin_inset Quotes erd
9377 \begin_layout Description
9378 \begin_inset Flex Code
9381 \begin_layout Plain Layout
9387 Adds information to the document preamble.
9389 \begin_inset Newline newline
9393 \begin_inset Quotes eld
9397 \begin_inset Flex Code
9400 \begin_layout Plain Layout
9407 \begin_inset Quotes erd
9411 \change_inserted -712698321 1562592950
9415 \begin_layout Description
9417 \change_inserted -712698321 1562593040
9418 \begin_inset Flex Code
9421 \begin_layout Plain Layout
9423 \change_inserted -712698321 1562592954
9432 \begin_inset Flex Code
9435 \begin_layout Plain Layout
9437 \change_inserted -712698321 1562592950
9448 \begin_inset space \thinspace{}
9452 \begin_inset Flex Code
9455 \begin_layout Plain Layout
9457 \change_inserted -712698321 1562592950
9465 ] If the document class adds the bibliography to the table of contents,
9466 add this option with value
9467 \begin_inset Flex Code
9470 \begin_layout Plain Layout
9472 \change_inserted -712698321 1562592996
9481 \begin_inset Flex Code
9484 \begin_layout Plain Layout
9486 \change_inserted -712698321 1562593006
9495 This prevents the bibliography from being added twice.
9500 \begin_layout Description
9501 \begin_inset Flex Code
9504 \begin_layout Plain Layout
9510 Defines the possibilities for displaying citation references.
9512 \begin_inset CommandInset ref
9514 reference "subsec:Citation-engine-description"
9523 \begin_inset Quotes eld
9527 \begin_inset Flex Code
9530 \begin_layout Plain Layout
9537 \begin_inset Quotes erd
9541 Primarily used in cite engine files (see
9542 \begin_inset CommandInset ref
9544 reference "subsec:Cite-Engine-Files"
9553 \change_inserted -712698321 1526898530
9554 Note that if you specify this in a layout file or module, any cite engine
9555 definition will be overridden.
9557 \begin_inset Flex Code
9560 \begin_layout Plain Layout
9562 \change_inserted -712698321 1526898530
9575 \begin_layout Description
9576 \begin_inset Flex Code
9579 \begin_layout Plain Layout
9585 Defines formats for use in the display of bibliographic information.
9587 \begin_inset CommandInset ref
9589 reference "subsec:Citation-format-description"
9595 \begin_inset Quotes eld
9599 \begin_inset Flex Code
9602 \begin_layout Plain Layout
9609 \begin_inset Quotes erd
9613 Primarily used in cite engine files (see
9614 \begin_inset CommandInset ref
9616 reference "subsec:Cite-Engine-Files"
9625 \change_inserted -712698321 1526898585
9626 A cite format defined in a layout or module will override the cite engine
9632 \begin_layout Description
9633 \begin_inset Flex Code
9636 \begin_layout Plain Layout
9643 \begin_inset Flex Code
9646 \begin_layout Plain Layout
9655 \begin_inset Flex Code
9658 \begin_layout Plain Layout
9664 ] Determines whether
9668 or Bib\SpecialChar TeX
9669 is used to generate a Bibliography.
9670 Primarily used in cite engine files (see
9671 \begin_inset CommandInset ref
9673 reference "subsec:Cite-Engine-Files"
9683 \begin_layout Description
9684 \begin_inset Flex Code
9687 \begin_layout Plain Layout
9693 Describes various global options supported by the document class.
9695 \begin_inset CommandInset ref
9697 reference "subsec:ClassOptions"
9703 \begin_inset Quotes eld
9707 \begin_inset Flex Code
9710 \begin_layout Plain Layout
9717 \begin_inset Quotes erd
9723 \begin_layout Description
9724 \begin_inset Flex Code
9727 \begin_layout Plain Layout
9734 \begin_inset Flex Code
9737 \begin_layout Plain Layout
9746 \begin_inset space \thinspace{}
9750 \begin_inset Flex Code
9753 \begin_layout Plain Layout
9759 ] Whether the class should
9763 to having one or two columns.
9764 Can be changed in the
9765 \begin_inset Flex Noun
9768 \begin_layout Plain Layout
9769 Document\SpecialChar menuseparator
9778 \begin_layout Description
9779 \begin_inset Flex Code
9782 \begin_layout Plain Layout
9789 \begin_inset Flex Code
9792 \begin_layout Plain Layout
9798 ] This sequence defines the properties for a counter.
9799 If the counter does not yet exist, it is created; if it does exist, it
9802 \begin_inset Quotes eld
9806 \begin_inset Flex Code
9809 \begin_layout Plain Layout
9816 \begin_inset Quotes erd
9820 \begin_inset Newline newline
9824 \begin_inset CommandInset ref
9826 reference "subsec:Counters"
9830 for details on counters.
9833 \begin_layout Description
9834 \begin_inset Flex Code
9837 \begin_layout Plain Layout
9843 Sets the default font used to display the document.
9845 \begin_inset CommandInset ref
9847 reference "subsec:Font-description"
9851 for how to declare fonts.
9853 \begin_inset Quotes eld
9857 \begin_inset Flex Code
9860 \begin_layout Plain Layout
9867 \begin_inset Quotes erd
9873 \begin_layout Description
9874 \begin_inset Flex Code
9877 \begin_layout Plain Layout
9884 \begin_inset Flex Code
9887 \begin_layout Plain Layout
9893 ] Specifies a module to be included by default with this document class.
9894 The module is specified as filename without the
9895 \begin_inset Flex Code
9898 \begin_layout Plain Layout
9905 The user can still remove the module, but it will be active at the outset.
9906 (This applies only when new files are created, or when this class is chosen
9907 for an existing document.)
9910 \begin_layout Description
9911 \begin_inset Flex Code
9914 \begin_layout Plain Layout
9921 \begin_inset Flex Code
9924 \begin_layout Plain Layout
9930 ] This is the style that will be assigned to new paragraphs, usually
9931 \begin_inset Flex Noun
9934 \begin_layout Plain Layout
9941 This will default to the first defined style if not given, but you are
9942 encouraged to use this directive.
9945 \begin_layout Description
9947 \change_inserted -970929547 1515112870
9948 \begin_inset Flex Code
9951 \begin_layout Plain Layout
9953 \change_inserted -970929547 1515112782
9962 \begin_inset Flex Code
9965 \begin_layout Plain Layout
9967 \change_inserted -970929547 1515112766
9975 ] The root element (at the top of the document) to use when outputting documents
9976 with this class in DocBook.
9977 The default value is
9978 \begin_inset Quotes eld
9982 \begin_inset Flex Code
9985 \begin_layout Plain Layout
9987 \change_inserted -970929547 1515112845
9996 \begin_inset Quotes erd
10001 \change_deleted 1075283030 1594226862
10003 \change_inserted 1075283030 1594226777
10007 \begin_layout Description
10009 \change_inserted 1075283030 1594226859
10010 \begin_inset Flex Code
10013 \begin_layout Plain Layout
10015 \change_inserted 1075283030 1594226785
10016 DocBookForceAbstract
10024 \begin_inset Flex Code
10027 \begin_layout Plain Layout
10029 \change_inserted 1075283030 1594226804
10038 \begin_inset Quotes eld
10046 \begin_inset Quotes erd
10049 , the root element will always have an
10054 The default value is
10055 \begin_inset Quotes eld
10063 \begin_inset Quotes erd
10071 \begin_layout Description
10072 \begin_inset Flex Code
10075 \begin_layout Plain Layout
10082 \begin_inset Flex Code
10085 \begin_layout Plain Layout
10091 ] This tag indicates that the module (which is specified by filename without
10093 \begin_inset Flex Code
10096 \begin_layout Plain Layout
10102 extension) cannot be used with this document class.
10103 This might be used in a journal-specific layout file to prevent, say, the
10105 \begin_inset Flex Code
10108 \begin_layout Plain Layout
10114 module that numbers theorems by section.
10119 be used in a module.
10120 Modules have their own way of excluding other modules (see
10121 \begin_inset CommandInset ref
10123 reference "subsec:Layout-modules"
10130 \begin_layout Description
10131 \begin_inset Flex Code
10134 \begin_layout Plain Layout
10140 Defines a new float.
10142 \begin_inset CommandInset ref
10144 reference "subsec:Floats"
10150 \begin_inset Quotes eld
10154 \begin_inset Flex Code
10157 \begin_layout Plain Layout
10164 \begin_inset Quotes erd
10170 \begin_layout Description
10171 \begin_inset Flex Code
10174 \begin_layout Plain Layout
10180 Sets the information that will be output in the
10181 \begin_inset Flex Code
10184 \begin_layout Plain Layout
10190 block when this document class is output to XHTML.
10191 Note that this will completely override any prior
10192 \begin_inset Flex Code
10195 \begin_layout Plain Layout
10202 \begin_inset Flex Code
10205 \begin_layout Plain Layout
10213 \begin_inset Newline newline
10217 \begin_inset Flex Code
10220 \begin_layout Plain Layout
10226 if you just want to add material to the preamble.) Must end with
10227 \begin_inset Quotes eld
10231 \begin_inset Flex Code
10234 \begin_layout Plain Layout
10241 \begin_inset Quotes erd
10247 \begin_layout Description
10248 \begin_inset Flex Code
10251 \begin_layout Plain Layout
10258 \begin_inset Flex Code
10261 \begin_layout Plain Layout
10267 ] The style to use for the table of contents, bibliography, and so forth,
10268 when the document is output to HTML.
10269 For articles, this should normally be
10270 \begin_inset Flex Code
10273 \begin_layout Plain Layout
10280 \begin_inset Flex Code
10283 \begin_layout Plain Layout
10290 If it is not given, then \SpecialChar LyX
10291 will attempt to figure out which layout to use.
10294 \begin_layout Description
10295 \begin_inset Flex Code
10298 \begin_layout Plain Layout
10305 \begin_inset Flex Code
10308 \begin_layout Plain Layout
10314 ] Modifies the properties of the given counter.
10315 If the counter does not exist, the statement is ignored.
10317 \begin_inset Quotes eld
10321 \begin_inset Flex Code
10324 \begin_layout Plain Layout
10331 \begin_inset Quotes erd
10335 \begin_inset Newline newline
10339 \begin_inset CommandInset ref
10341 reference "subsec:Counters"
10345 for details on counters.
10348 \begin_layout Description
10349 \begin_inset Flex Code
10352 \begin_layout Plain Layout
10359 \begin_inset Flex Code
10362 \begin_layout Plain Layout
10368 ] This allows you to include another layout definition file within yours
10369 to avoid duplicating commands.
10370 Common examples are the standard layout files, for example,
10371 \begin_inset Flex Code
10374 \begin_layout Plain Layout
10380 , which contains most of the basic layouts.
10381 \change_inserted -712698321 1611646803
10385 \begin_layout Description
10387 \change_inserted -712698321 1611646804
10388 \begin_inset Flex Code
10391 \begin_layout Plain Layout
10393 \change_inserted -712698321 1611646837
10402 \begin_inset Flex Code
10405 \begin_layout Plain Layout
10407 \change_inserted -712698321 1611646804
10415 ] is a variant of the
10416 \begin_inset Flex Code
10419 \begin_layout Plain Layout
10421 \change_inserted -712698321 1611646804
10429 command which does not look for files in the user directory.
10430 This allows to create a file
10431 \begin_inset Flex Code
10434 \begin_layout Plain Layout
10436 \change_inserted -712698321 1611646804
10445 \begin_inset Flex Code
10448 \begin_layout Plain Layout
10450 \change_inserted -712698321 1611646804
10458 in the user directory which includes a global file with the same name via
10460 \begin_inset Flex Code
10463 \begin_layout Plain Layout
10465 \change_inserted -712698321 1611646853
10474 \begin_inset Flex Code
10477 \begin_layout Plain Layout
10479 \change_inserted -712698321 1611646855
10480 InputGlobal name.inc
10487 , respectively (with
10488 \begin_inset Flex Code
10491 \begin_layout Plain Layout
10493 \change_inserted -712698321 1611646804
10501 , the file would recursively include itself).
10502 This way, you can modify global files without having to completely copy
10508 \begin_layout Description
10509 \begin_inset Flex Code
10512 \begin_layout Plain Layout
10519 \begin_inset Flex Code
10522 \begin_layout Plain Layout
10528 ] This section (re-)defines the layout of an inset.
10529 It can be applied to an existing inset or to a new, user-defined inset,
10530 e.g., a new character style.
10532 \begin_inset Quotes eld
10536 \begin_inset Flex Code
10539 \begin_layout Plain Layout
10546 \begin_inset Quotes erd
10550 \begin_inset Newline newline
10554 \begin_inset CommandInset ref
10556 reference "subsec:Flex-insets-and"
10560 for more information.
10564 \begin_layout Description
10565 \begin_inset Flex Code
10568 \begin_layout Plain Layout
10575 \begin_inset Flex Code
10578 \begin_layout Plain Layout
10584 ] A string that indicates the width of the left margin on the screen, for
10586 \begin_inset Quotes eld
10590 \begin_inset Flex Code
10593 \begin_layout Plain Layout
10600 \begin_inset Quotes erd
10604 (Note that this is not a `length', like
10605 \begin_inset Quotes eld
10609 \begin_inset Quotes erd
10615 \begin_layout Description
10616 \begin_inset Flex Code
10619 \begin_layout Plain Layout
10626 \begin_inset Flex Code
10629 \begin_layout Plain Layout
10635 ] An integer that determines the maximal number of names displayed in an
10636 author-year citation before the citation switches to
10637 \begin_inset Quotes eld
10641 \begin_inset Quotes erd
10645 Primarily used in cite engine files (see
10646 \begin_inset CommandInset ref
10648 reference "subsec:Cite-Engine-Files"
10658 \begin_layout Description
10660 \change_inserted -712698321 1612018485
10661 \begin_inset Flex Code
10664 \begin_layout Plain Layout
10666 \change_inserted -712698321 1612018457
10675 \begin_inset Flex Code
10678 \begin_layout Plain Layout
10680 \change_inserted -712698321 1612018466
10688 ] Modifies the layout of an inset.
10689 If the layout does not exist, this section is ignored.
10691 \begin_inset Quotes eld
10695 \begin_inset Flex Code
10698 \begin_layout Plain Layout
10700 \change_inserted -712698321 1612018452
10709 \begin_inset Quotes erd
10715 \begin_layout Description
10716 \begin_inset Flex Code
10719 \begin_layout Plain Layout
10726 \begin_inset Flex Code
10729 \begin_layout Plain Layout
10735 ] Modifies the properties of the given paragraph style.
10736 If the style does not exist, this section is ignored.
10738 \begin_inset Quotes eld
10742 \begin_inset Flex Code
10745 \begin_layout Plain Layout
10752 \begin_inset Quotes erd
10758 \begin_layout Description
10759 \begin_inset Flex Code
10762 \begin_layout Plain Layout
10769 \begin_inset Flex Code
10772 \begin_layout Plain Layout
10778 ] Deletes an existing counter, usually one defined in an included file.
10781 \begin_layout Description
10782 \begin_inset Flex Code
10785 \begin_layout Plain Layout
10792 \begin_inset Flex Code
10795 \begin_layout Plain Layout
10801 ] Deletes an existing float.
10802 This is particularly useful when you want to suppress a float that has
10803 been defined in an input file.
10806 \begin_layout Description
10807 \begin_inset Flex Code
10810 \begin_layout Plain Layout
10817 \begin_inset Flex Code
10820 \begin_layout Plain Layout
10826 ] Deletes an existing style.
10829 \begin_layout Description
10830 \begin_inset Flex Code
10833 \begin_layout Plain Layout
10840 \begin_inset Flex Code
10843 \begin_layout Plain Layout
10850 \begin_inset Flex Code
10853 \begin_layout Plain Layout
10859 ] Define a new table of contents with type
10860 \begin_inset Flex Code
10863 \begin_layout Plain Layout
10870 \begin_inset Flex Code
10873 \begin_layout Plain Layout
10880 See also the AddToToc commands.
10883 \begin_layout Description
10884 \begin_inset Flex Code
10887 \begin_layout Plain Layout
10894 \begin_inset Flex Code
10897 \begin_layout Plain Layout
10903 ] The file format (as defined in the \SpecialChar LyX
10904 preferences) produced by this document
10906 It is mainly useful when
10907 \begin_inset Flex Code
10910 \begin_layout Plain Layout
10917 \begin_inset Flex Code
10920 \begin_layout Plain Layout
10926 and one wants to define a new type of literate document.
10927 The format is reset to
10928 \change_deleted 5863208 1594239413
10930 \begin_inset Quotes eld
10934 \begin_inset Flex Code
10937 \begin_layout Plain Layout
10944 \begin_inset Quotes erd
10950 \begin_inset Quotes eld
10954 \begin_inset Flex Code
10957 \begin_layout Plain Layout
10964 \begin_inset Quotes erd
10967 when the corresponding
10968 \begin_inset Flex Code
10971 \begin_layout Plain Layout
10977 parameter is encountered.
10980 \begin_layout Description
10981 \begin_inset Flex Code
10984 \begin_layout Plain Layout
10991 \begin_inset Flex Code
10994 \begin_layout Plain Layout
11005 \change_deleted 5863208 1594239430
11007 \begin_inset Flex Code
11010 \begin_layout Plain Layout
11019 \begin_inset Flex Code
11022 \begin_layout Plain Layout
11028 ] Specifies what sort of output documents using this class will produce.
11031 \begin_layout Description
11032 \begin_inset Flex Code
11035 \begin_layout Plain Layout
11042 \begin_inset Flex Code
11045 \begin_layout Plain Layout
11052 \begin_inset Flex Code
11055 \begin_layout Plain Layout
11061 ] Specifies options, given in the second string, for the package named by
11064 \begin_inset Quotes eld
11068 \begin_inset Flex Code
11071 \begin_layout Plain Layout
11072 PackageOptions natbib square
11078 \begin_inset Quotes erd
11082 \begin_inset Flex Code
11085 \begin_layout Plain Layout
11091 to be loaded with the
11092 \begin_inset Flex Code
11095 \begin_layout Plain Layout
11102 (For \SpecialChar TeX
11103 perts, this causes \SpecialChar LyX
11105 \begin_inset Flex Code
11108 \begin_layout Plain Layout
11111 PassOptionsToPackage{natbib}{square}
11117 \begin_inset Flex Code
11120 \begin_layout Plain Layout
11127 \change_inserted -712698321 1565102364
11131 \begin_layout Description
11133 \change_inserted -712698321 1565102470
11134 \begin_inset Flex Code
11137 \begin_layout Plain Layout
11139 \change_inserted -712698321 1565102365
11148 \begin_inset Flex Code
11151 \begin_layout Plain Layout
11153 \change_inserted -712698321 1565105222
11158 , letter, legal, executive, a0, a1, a2, a3, a4, a5, a6, b0, b1, b2, b3,
11159 b4, b5, b6, c0, c1, c2, c3, c4, c5, c6, b0j, b1j, b2j, b3j, b4j, b5j, b6j
11166 ] The default page size.
11167 This is used by some converters.
11172 \begin_layout Description
11173 \begin_inset Flex Code
11176 \begin_layout Plain Layout
11183 \begin_inset Flex Code
11186 \begin_layout Plain Layout
11195 \begin_inset Flex Code
11198 \begin_layout Plain Layout
11205 \begin_inset Flex Code
11208 \begin_layout Plain Layout
11214 ] The default pagestyle.
11215 Can be changed in the
11216 \begin_inset Flex Noun
11219 \begin_layout Plain Layout
11220 Document\SpecialChar menuseparator
11229 \begin_layout Description
11230 \begin_inset Flex Code
11233 \begin_layout Plain Layout
11239 Sets the preamble for the \SpecialChar LaTeX
11241 Note that this will completely override any prior
11242 \begin_inset Flex Code
11245 \begin_layout Plain Layout
11252 \begin_inset Flex Code
11255 \begin_layout Plain Layout
11263 \begin_inset Flex Code
11266 \begin_layout Plain Layout
11272 if you just want to add material to the preamble.) Must end with
11273 \begin_inset Quotes eld
11277 \begin_inset Flex Code
11280 \begin_layout Plain Layout
11287 \begin_inset Quotes erd
11291 \change_inserted -712698321 1612018500
11295 \begin_layout Description
11297 \change_inserted -712698321 1612018547
11298 \begin_inset Flex Code
11301 \begin_layout Plain Layout
11303 \change_inserted -712698321 1612018506
11312 \begin_inset Flex Code
11315 \begin_layout Plain Layout
11317 \change_inserted -712698321 1612018509
11325 ] Defines the layout of an inset if it does not already exist.
11326 If the layout does exist, this section is ignored.
11328 \begin_inset Quotes eld
11332 \begin_inset Flex Code
11335 \begin_layout Plain Layout
11337 \change_inserted -712698321 1612018500
11346 \begin_inset Quotes erd
11354 \begin_layout Description
11355 \begin_inset Flex Code
11358 \begin_layout Plain Layout
11365 \begin_inset Flex Code
11368 \begin_layout Plain Layout
11375 \begin_inset Flex Code
11378 \begin_layout Plain Layout
11387 \begin_inset space \thinspace{}
11391 \begin_inset Flex Code
11394 \begin_layout Plain Layout
11400 ] Whether the class already provides the feature
11401 \begin_inset Flex Code
11404 \begin_layout Plain Layout
11411 A feature is in general the name of a package (e.
11412 \begin_inset space \thinspace{}
11416 \begin_inset space \space{}
11420 \begin_inset Flex Code
11423 \begin_layout Plain Layout
11430 \begin_inset Flex Code
11433 \begin_layout Plain Layout
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
11469 \begin_inset CommandInset ref
11471 reference "chap:List-of-functions"
11475 for the list of features.
11478 \begin_layout Description
11479 \begin_inset Flex Code
11482 \begin_layout Plain Layout
11489 \begin_inset Flex Code
11492 \begin_layout Plain Layout
11498 ] Indicates that this layout provides the functionality of the module mentioned,
11499 which should be specified by the filename without the
11500 \begin_inset Flex Code
11503 \begin_layout Plain Layout
11510 This will typically be used if the layout includes the module directly,
11511 rather than using the
11512 \begin_inset Flex Code
11515 \begin_layout Plain Layout
11521 tag to indicate that it ought to be used.
11522 It could also be used in a module that provided an alternate implementation
11523 of the same functionality.
11526 \begin_layout Description
11527 \begin_inset Flex Code
11530 \begin_layout Plain Layout
11537 \begin_inset Flex Code
11540 \begin_layout Plain Layout
11546 ] Creates a new paragraph style if it does not already exist.
11547 If the style does exist, this section is ignored.
11549 \begin_inset Quotes eld
11553 \begin_inset Flex Code
11556 \begin_layout Plain Layout
11563 \begin_inset Quotes erd
11569 \begin_layout Description
11570 \begin_inset Flex Code
11573 \begin_layout Plain Layout
11580 \begin_inset Flex Code
11583 \begin_layout Plain Layout
11589 ] Whether the class requires the feature
11590 \begin_inset Flex Code
11593 \begin_layout Plain Layout
11600 Multiple features must be separated by commas.
11601 Note that you can only request supported features.
11603 \begin_inset CommandInset ref
11605 reference "chap:List-of-functions"
11609 for the list of features.).
11610 If you require a package with specific options, you can additionally use
11612 \begin_inset Flex Code
11615 \begin_layout Plain Layout
11624 \begin_layout Description
11625 \begin_inset Flex Code
11628 \begin_layout Plain Layout
11635 \begin_inset Flex Code
11638 \begin_layout Plain Layout
11644 ] A string that indicates the width of the right margin on the screen, for
11646 \begin_inset Quotes eld
11650 \begin_inset Flex Code
11653 \begin_layout Plain Layout
11660 \begin_inset Quotes erd
11666 \begin_layout Description
11667 \begin_inset Flex Code
11670 \begin_layout Plain Layout
11677 \begin_inset Flex Code
11680 \begin_layout Plain Layout
11686 ] Sets which divisions get numbered.
11688 \begin_inset Newline newline
11692 \begin_inset Flex Code
11695 \begin_layout Plain Layout
11701 counter in \SpecialChar LaTeX
11705 \begin_layout Description
11706 \begin_inset Flex Code
11709 \begin_layout Plain Layout
11716 \begin_inset Flex Code
11719 \begin_layout Plain Layout
11728 \begin_inset space \thinspace{}
11732 \begin_inset Flex Code
11735 \begin_layout Plain Layout
11741 ] Whether the class-default should be printing on one or both sides of the
11743 Can be changed in the
11744 \begin_inset Flex Noun
11747 \begin_layout Plain Layout
11748 Document\SpecialChar menuseparator
11757 \begin_layout Description
11758 \begin_inset Flex Code
11761 \begin_layout Plain Layout
11768 \begin_inset Flex Code
11771 \begin_layout Plain Layout
11777 ] This sequence defines a paragraph style.
11778 If the style does not yet exist, it is created; if it does exist, its parameter
11781 \begin_inset Quotes eld
11785 \begin_inset Flex Code
11788 \begin_layout Plain Layout
11795 \begin_inset Quotes erd
11799 \begin_inset Newline newline
11803 \begin_inset CommandInset ref
11805 reference "subsec:Paragraph-Styles"
11809 for details on paragraph styles.
11810 \change_inserted -712698321 1553617804
11814 \begin_layout Description
11816 \change_inserted -712698321 1553617862
11817 \begin_inset Flex Code
11820 \begin_layout Plain Layout
11822 \change_inserted -712698321 1553617809
11831 \begin_inset Flex Code
11834 \begin_layout Plain Layout
11836 \change_inserted -712698321 1553617805
11844 ] defines the default table style that is used when inserting a table.
11845 The following styles are available:
11849 \begin_layout Itemize
11851 \change_inserted -712698321 1554308039
11852 \begin_inset Flex Code
11855 \begin_layout Plain Layout
11857 \change_inserted -712698321 1554307928
11858 Formal_with_Footline
11866 \begin_inset Quotes eld
11870 \begin_inset Quotes erd
11873 ) style with horizontal lines only, using a bold top and bottom line, the
11874 first and last row are additionally separated from the table body with
11875 a thin middle line.
11878 \begin_layout Itemize
11880 \change_inserted -712698321 1554308087
11881 \begin_inset Flex Code
11884 \begin_layout Plain Layout
11886 \change_inserted -712698321 1554308042
11887 Formal_without_Footline
11894 : same as the above, but the last row is not separated with a middle line
11898 \begin_layout Itemize
11900 \change_inserted -712698321 1553618031
11901 \begin_inset Flex Code
11904 \begin_layout Plain Layout
11906 \change_inserted -712698321 1553618006
11914 : Simple table lines.
11917 \begin_layout Itemize
11919 \change_inserted -712698321 1553618309
11920 \begin_inset Flex Code
11923 \begin_layout Plain Layout
11925 \change_inserted -712698321 1553618031
11934 \begin_inset Flex Code
11937 \begin_layout Plain Layout
11939 \change_inserted -712698321 1553618043
11947 , but with the header
11948 \change_deleted 34634807 1619712593
11950 \change_inserted 34634807 1619712594
11952 \change_inserted -712698321 1553618309
11953 offset with a second horizontal line.
11954 This is also the default style of \SpecialChar LyX
11958 \begin_layout Itemize
11960 \change_inserted -712698321 1553618280
11961 \begin_inset Flex Code
11964 \begin_layout Plain Layout
11966 \change_inserted -712698321 1553618261
11974 : Table without lines.
11980 \begin_layout Description
11981 \begin_inset Flex Code
11984 \begin_layout Plain Layout
11991 \begin_inset Flex Code
11994 \begin_layout Plain Layout
12000 ] The name of the command or environment to be used with
12001 \begin_inset Flex Code
12004 \begin_layout Plain Layout
12013 \begin_layout Description
12014 \begin_inset Flex Code
12017 \begin_layout Plain Layout
12024 \begin_inset Flex Code
12027 \begin_layout Plain Layout
12036 \begin_inset Flex Code
12039 \begin_layout Plain Layout
12045 ] Indicates what kind of markup is used to define the title of a document.
12047 \begin_inset Flex Code
12050 \begin_layout Plain Layout
12056 means that the macro with name
12057 \begin_inset Flex Code
12060 \begin_layout Plain Layout
12066 will be inserted after the last layout which has
12067 \begin_inset Quotes eld
12071 \begin_inset Flex Code
12074 \begin_layout Plain Layout
12076 \begin_inset space ~
12085 \begin_inset Quotes erd
12090 \begin_inset Flex Code
12093 \begin_layout Plain Layout
12099 corresponds to the case where all layouts which have
12100 \begin_inset Quotes eld
12104 \begin_inset Flex Code
12107 \begin_layout Plain Layout
12109 \begin_inset space ~
12118 \begin_inset Quotes erd
12121 should be enclosed into the
12122 \begin_inset Flex Code
12125 \begin_layout Plain Layout
12134 \begin_layout Description
12135 \begin_inset Flex Code
12138 \begin_layout Plain Layout
12145 \begin_inset Flex Code
12148 \begin_layout Plain Layout
12154 ] Sets which divisions are included in the table of contents.
12156 \begin_inset Flex Code
12159 \begin_layout Plain Layout
12165 counter in \SpecialChar LaTeX
12169 \begin_layout Subsection
12170 \begin_inset Flex Code
12173 \begin_layout Plain Layout
12180 \begin_inset CommandInset label
12182 name "subsec:ClassOptions"
12189 \begin_layout Standard
12191 \begin_inset Flex Code
12194 \begin_layout Plain Layout
12200 section can contain the following entries:
12203 \begin_layout Description
12204 \begin_inset Flex Code
12207 \begin_layout Plain Layout
12214 \begin_inset Flex Code
12217 \begin_layout Plain Layout
12223 ] The list of available font sizes for the document's main font, separated
12225 \begin_inset Quotes eld
12229 \begin_inset Flex Code
12232 \begin_layout Plain Layout
12239 \begin_inset Quotes erd
12244 \change_inserted -712698321 1565110196
12245 Any number is possible.
12248 \begin_layout Description
12250 \change_inserted -712698321 1565110259
12251 \begin_inset Flex Code
12254 \begin_layout Plain Layout
12256 \change_inserted -712698321 1565110199
12265 \begin_inset Flex Code
12268 \begin_layout Plain Layout
12270 \change_inserted -712698321 1565110196
12278 ] The format for the font size option.
12280 \begin_inset Flex Code
12283 \begin_layout Plain Layout
12285 \change_inserted -712698321 1565110238
12295 \begin_inset Flex Code
12298 \begin_layout Plain Layout
12300 \change_inserted -712698321 1565110248
12308 is a placeholder for the font size.
12313 \begin_layout Description
12315 \change_deleted 5863208 1594239483
12316 \begin_inset Flex Code
12319 \begin_layout Plain Layout
12325 Used to set the DTD line with XML-based output classes.
12327 \begin_inset space \thinspace{}
12331 \begin_inset Quotes eld
12334 -//OASIS//DTD DocBook V4.2//EN
12335 \begin_inset Quotes erd
12339 \change_inserted -712698321 1565101761
12343 \begin_layout Description
12345 \change_inserted -712698321 1565180598
12346 \begin_inset Flex Code
12349 \begin_layout Plain Layout
12351 \change_inserted -712698321 1565101918
12360 \begin_inset Flex Code
12363 \begin_layout Plain Layout
12365 \change_inserted -712698321 1565105399
12366 string="letter|\SpecialChar allowbreak
12367 legal|\SpecialChar allowbreak
12368 executive|\SpecialChar allowbreak
12369 a0|\SpecialChar allowbreak
12370 a1|\SpecialChar allowbreak
12371 a2|\SpecialChar allowbreak
12372 a3|\SpecialChar allowbreak
12373 a4|\SpecialChar allowbreak
12374 a5|\SpecialChar allowbreak
12375 a6|\SpecialChar allowbreak
12376 b0|\SpecialChar allowbreak
12377 b1|\SpecialChar allowbreak
12378 b2|\SpecialChar allowbreak
12379 b3|\SpecialChar allowbreak
12380 b4|\SpecialChar allowbreak
12381 b5|\SpecialChar allowbreak
12382 b6|\SpecialChar allowbreak
12383 c0|\SpecialChar allowbreak
12384 c1|\SpecialChar allowbreak
12386 2|\SpecialChar allowbreak
12387 c3|\SpecialChar allowbreak
12388 c4|\SpecialChar allowbreak
12389 c5|\SpecialChar allowbreak
12390 c6|\SpecialChar allowbreak
12391 b0j|\SpecialChar allowbreak
12392 b1j|\SpecialChar allowbreak
12393 b2j|\SpecialChar allowbreak
12394 b3j|\SpecialChar allowbreak
12395 b4j|\SpecialChar allowbreak
12396 b5j|\SpecialChar allowbreak
12404 ] The list of available page sizes, separated by
12405 \begin_inset Quotes eld
12409 \begin_inset Flex Code
12412 \begin_layout Plain Layout
12414 \change_inserted -712698321 1565101779
12423 \begin_inset Quotes erd
12427 Currently, only the listed sizes are supported.
12428 Other sizes might be entered as custom class option.
12431 \begin_layout Description
12433 \change_inserted -712698321 1565180623
12434 \begin_inset Flex Code
12437 \begin_layout Plain Layout
12439 \change_inserted -712698321 1565180605
12448 \begin_inset Flex Code
12451 \begin_layout Plain Layout
12453 \change_inserted -712698321 1565180601
12461 ] The format for the page size option.
12463 \begin_inset Flex Code
12466 \begin_layout Plain Layout
12468 \change_inserted -712698321 1565180618
12478 \begin_inset Flex Code
12481 \begin_layout Plain Layout
12483 \change_inserted -712698321 1565180601
12491 is a placeholder for the paper size.
12496 \begin_layout Description
12497 \begin_inset Flex Code
12500 \begin_layout Plain Layout
12507 \begin_inset Flex Code
12510 \begin_layout Plain Layout
12511 string="empty|plain|headings|fancy"
12516 ] The list of available page sty\SpecialChar softhyphen
12518 \begin_inset Quotes eld
12522 \begin_inset Flex Code
12525 \begin_layout Plain Layout
12532 \begin_inset Quotes erd
12538 \begin_layout Description
12539 \begin_inset Flex Code
12542 \begin_layout Plain Layout
12549 \begin_inset Flex Code
12552 \begin_layout Plain Layout
12558 ] Some document class options, separated by a comma, that will be added
12559 to the optional part of the
12560 \begin_inset Flex Code
12563 \begin_layout Plain Layout
12574 \begin_layout Standard
12576 \begin_inset Flex Code
12579 \begin_layout Plain Layout
12585 section must end with
12586 \begin_inset Quotes eld
12590 \begin_inset Flex Code
12593 \begin_layout Plain Layout
12600 \begin_inset Quotes erd
12606 \begin_layout Subsection
12608 \begin_inset CommandInset label
12610 name "subsec:Paragraph-Styles"
12617 \begin_layout Standard
12618 A paragraph style description looks like this:
12622 \begin_layout Plain Layout
12623 Note that this will either define a new style or modify an existing one.
12631 \begin_layout LyX-Code
12638 \begin_layout LyX-Code
12642 \begin_layout LyX-Code
12646 \begin_layout Standard
12647 where the following commands are allowed:
12650 \begin_layout Description
12651 \begin_inset Flex Code
12654 \begin_layout Plain Layout
12661 \begin_inset Flex Code
12664 \begin_layout Plain Layout
12670 =""] This paragraph will appear in the table of contents of the given type.
12671 An empty string disables.
12672 See also the OutlinerName and the IsTocCaption commands.
12676 \begin_layout Description
12677 \begin_inset Flex Code
12680 \begin_layout Plain Layout
12687 \begin_inset Flex Code
12690 \begin_layout Plain Layout
12695 , left, right, center
12700 ] Paragraph alignment.
12703 \begin_layout Description
12704 \begin_inset Flex Code
12707 \begin_layout Plain Layout
12714 \begin_inset Flex Code
12717 \begin_layout Plain Layout
12722 , left, right, center
12727 ] A comma separated list of permitted alignments.
12728 (Some \SpecialChar LaTeX
12729 styles prohibit certain alignments, since those wouldn't make sense.
12730 For example a right-aligned or centered enumeration isn't possible.)
12733 \begin_layout Description
12734 \begin_inset Flex Code
12737 \begin_layout Plain Layout
12744 \begin_inset Flex Code
12747 \begin_layout Plain Layout
12753 ] Defines argument number <int> of a command\SpecialChar breakableslash
12754 environment associated with
12757 \change_inserted -584632292 1615846868
12758 The definition must end with
12759 \begin_inset Flex Code
12762 \begin_layout Plain Layout
12764 \change_inserted -584632292 1615846867
12776 \change_inserted -584632292 1615846880
12778 \begin_inset CommandInset ref
12780 reference "subsec:Arguments"
12787 for more information.
12789 \change_deleted -584632292 1615846694
12790 This is useful for things like section headings, and only makes sense with
12793 Every (optional or required) argument of a command or environment – except
12794 for the required argument that is associated with the content of the paragraph
12795 itself – has a separate definition, where the number specifies the order
12797 The definition must end with
12798 \begin_inset Flex Code
12801 \begin_layout Plain Layout
12808 So a command with two optional arguments has:
12812 \begin_layout Quote
12814 \change_deleted -584632292 1615846694
12820 \begin_layout Quote
12822 \change_deleted -584632292 1615846694
12828 \begin_layout Quote
12830 \change_deleted -584632292 1615846694
12836 \begin_layout Quote
12838 \change_deleted -584632292 1615846694
12844 \begin_layout Quote
12846 \change_deleted -584632292 1615846694
12852 \begin_layout Quote
12854 \change_deleted -584632292 1615846694
12860 \begin_layout Standard
12862 \change_deleted -584632292 1615846694
12864 \begin_inset Flex Code
12867 \begin_layout Plain Layout
12873 definition, the following specifications are possible:
12876 \begin_layout Itemize
12878 \change_deleted -584632292 1615846694
12879 \begin_inset Flex Code
12882 \begin_layout Plain Layout
12889 \begin_inset Flex Code
12892 \begin_layout Plain Layout
12898 The string that will appear both in the menu (to insert this argument)
12899 and on the argument inset button (unless you also specify a separate
12900 \begin_inset Flex Code
12903 \begin_layout Plain Layout
12910 For the menu, you can define an accelerator by appending the respective
12911 character to the string, divided by
12912 \begin_inset Quotes eld
12916 \begin_inset Quotes erd
12920 \begin_inset space \thinspace{}
12924 \begin_inset space \space{}
12928 \begin_inset Quotes eld
12932 \begin_inset Flex Code
12935 \begin_layout Plain Layout
12942 \begin_inset Quotes erd
12948 \begin_layout Itemize
12950 \change_deleted -584632292 1615846694
12951 \begin_inset Flex Code
12954 \begin_layout Plain Layout
12961 \begin_inset Flex Code
12964 \begin_layout Plain Layout
12970 A separate string for the menu.
12971 You can define an accelerator by appending the respective character to
12972 the string, divided by
12973 \begin_inset Quotes eld
12977 \begin_inset Quotes erd
12981 \begin_inset space \thinspace{}
12985 \begin_inset space \space{}
12989 \begin_inset Quotes eld
12993 \begin_inset Flex Code
12996 \begin_layout Plain Layout
13003 \begin_inset Quotes erd
13007 This specification is optional.
13008 If it is not given the
13009 \begin_inset Flex Code
13012 \begin_layout Plain Layout
13018 will be used instead for the menu.
13021 \begin_layout Itemize
13023 \change_deleted -584632292 1615846694
13024 \begin_inset Flex Code
13027 \begin_layout Plain Layout
13034 \begin_inset Flex Code
13037 \begin_layout Plain Layout
13043 A longer explanatory text that appears in the tooltip when hovering over
13044 the argument inset.
13047 \begin_layout Itemize
13049 \change_deleted -584632292 1615846694
13050 \begin_inset Flex Code
13053 \begin_layout Plain Layout
13060 \begin_inset Flex Code
13063 \begin_layout Plain Layout
13072 \begin_inset space \thinspace{}
13076 \begin_inset Flex Code
13079 \begin_layout Plain Layout
13085 ] Declare if this is a mandatory (1) or an optional (0) argument.
13086 Mandatory arguments will be output empty if not given, while optional arguments
13087 will not be output at all.
13088 By default, mandatory arguments are delimited by
13089 \begin_inset Flex Code
13092 \begin_layout Plain Layout
13098 , while optional arguments are delimited by
13099 \begin_inset Flex Code
13102 \begin_layout Plain Layout
13111 \begin_layout Itemize
13113 \change_deleted -584632292 1615846694
13114 \begin_inset Flex Code
13117 \begin_layout Plain Layout
13119 \change_inserted -712698321 1555579780
13128 \begin_inset Flex Code
13131 \begin_layout Plain Layout
13133 \change_inserted -712698321 1555579780
13141 Option to define a different command (from the default
13142 \begin_inset Flex Code
13145 \begin_layout Plain Layout
13147 \change_inserted -712698321 1555579780
13159 ) to be used for line breaks.
13160 The initial backslash must not be specified.
13163 \begin_layout Itemize
13165 \change_deleted -584632292 1615846694
13166 \begin_inset Flex Code
13169 \begin_layout Plain Layout
13176 \begin_inset Flex Code
13179 \begin_layout Plain Layout
13185 defines another argument (by its number) which this argument requires to
13186 be output if it is itself output.
13188 \begin_inset space \thinspace{}
13191 g., in \SpecialChar LaTeX
13192 commands, optional arguments often require previous optional arguments
13193 to be output (at least empty), as in
13194 \begin_inset Flex Code
13197 \begin_layout Plain Layout
13200 command[][argument]{text}
13206 This can be achieved by the statement
13207 \begin_inset Flex Code
13210 \begin_layout Plain Layout
13217 \begin_inset Flex Code
13220 \begin_layout Plain Layout
13229 \begin_layout Itemize
13231 \change_deleted -584632292 1615846694
13232 \begin_inset Flex Code
13235 \begin_layout Plain Layout
13242 \begin_inset Flex Code
13245 \begin_layout Plain Layout
13251 defines a custom left delimiter (instead of
13252 \begin_inset Flex Code
13255 \begin_layout Plain Layout
13262 \begin_inset Flex Code
13265 \begin_layout Plain Layout
13272 A line break in the output can be indicated by
13273 \begin_inset Flex Code
13276 \begin_layout Plain Layout
13285 \begin_layout Itemize
13287 \change_deleted -584632292 1615846694
13288 \begin_inset Flex Code
13291 \begin_layout Plain Layout
13298 \begin_inset Flex Code
13301 \begin_layout Plain Layout
13307 defines a custom right delimiter (instead of
13308 \begin_inset Flex Code
13311 \begin_layout Plain Layout
13318 \begin_inset Flex Code
13321 \begin_layout Plain Layout
13328 A line break in the output can be indicated by
13329 \begin_inset Flex Code
13332 \begin_layout Plain Layout
13341 \begin_layout Itemize
13343 \change_deleted -584632292 1615846694
13344 \begin_inset Flex Code
13347 \begin_layout Plain Layout
13354 \begin_inset Flex Code
13357 \begin_layout Plain Layout
13363 defines an argument that is inserted if and only if no user-specified arguments
13365 \begin_inset space \thinspace{}
13369 \begin_inset space \space{}
13372 if no argument inset has been inserted (note that also an empty argument
13373 inset omits the DefaultArg).
13374 Multiple arguments need to be separated by comma.
13377 \begin_layout Itemize
13379 \change_deleted -584632292 1615846694
13380 \begin_inset Flex Code
13383 \begin_layout Plain Layout
13390 \begin_inset Flex Code
13393 \begin_layout Plain Layout
13399 defines an argument that is inserted in any case (alone or in addition
13400 to user-specified arguments).
13401 Multiple arguments need to be separated by comma.
13404 \begin_layout Itemize
13406 \change_deleted -584632292 1615846694
13407 \begin_inset Flex Code
13410 \begin_layout Plain Layout
13416 The font used for the argument content, see
13417 \begin_inset CommandInset ref
13419 reference "subsec:Font-description"
13426 \begin_layout Itemize
13428 \change_deleted -584632292 1615846694
13429 \begin_inset Flex Code
13432 \begin_layout Plain Layout
13434 \change_inserted -712698321 1559484228
13443 \begin_inset Flex Code
13446 \begin_layout Plain Layout
13448 \change_inserted -712698321 1559484228
13459 \begin_inset space \thinspace{}
13463 \begin_inset Flex Code
13466 \begin_layout Plain Layout
13468 \change_inserted -712698321 1559484228
13476 ] As with paragraph styles, see
13477 \begin_inset CommandInset ref
13479 reference "subsec:Paragraph-Styles"
13486 \begin_layout Itemize
13488 \change_deleted -584632292 1615846694
13489 \begin_inset Flex Code
13492 \begin_layout Plain Layout
13498 The font used for the label; see
13499 \begin_inset CommandInset ref
13501 reference "subsec:Font-description"
13508 \begin_layout Itemize
13510 \change_deleted -584632292 1615846694
13511 \begin_inset Flex Code
13514 \begin_layout Plain Layout
13521 \begin_inset Flex Code
13524 \begin_layout Plain Layout
13529 , Minimalistic, Conglomerate
13534 ] describes the rendering style used for the inset's frame and buttons.
13537 \begin_layout Itemize
13539 \change_deleted -584632292 1615846694
13540 \begin_inset Flex Code
13543 \begin_layout Plain Layout
13550 \begin_inset Flex Code
13553 \begin_layout Plain Layout
13560 \begin_inset Flex Code
13563 \begin_layout Plain Layout
13569 , this argument is automatically inserted when the respective style is selected.
13571 \change_deleted -712698321 1559484200
13572 Currently, only one argument per style\SpecialChar breakableslash
13573 layout can be automatically inserted.
13574 \change_deleted -584632292 1615846694
13578 \begin_layout Itemize
13580 \change_deleted -584632292 1615846694
13581 \begin_inset Flex Code
13584 \begin_layout Plain Layout
13586 \change_inserted -712698321 1559490711
13595 \begin_inset Flex Code
13598 \begin_layout Plain Layout
13600 \change_inserted -712698321 1559490703
13609 \begin_inset Flex Code
13612 \begin_layout Plain Layout
13614 \change_inserted -712698321 1559490703
13622 , this argument will be inserted on a new line with
13623 \begin_inset Flex Code
13626 \begin_layout Plain Layout
13628 \change_inserted -712698321 1559491402
13636 (only available within Flex insets).
13639 \begin_layout Itemize
13641 \change_deleted -584632292 1615846694
13642 \begin_inset Flex Code
13645 \begin_layout Plain Layout
13652 \begin_inset Flex Code
13655 \begin_layout Plain Layout
13662 \begin_inset Flex Code
13665 \begin_layout Plain Layout
13671 , this argument will be inserted with a copy of the co-text (either selected
13672 text or the whole paragraph) as content.
13675 \begin_layout Itemize
13677 \change_deleted -584632292 1615846694
13678 \begin_inset Flex Code
13681 \begin_layout Plain Layout
13688 \begin_inset Flex Code
13691 \begin_layout Plain Layout
13701 ] Whether the contents of this argument should be output in raw form, meaning
13702 without special translations that \SpecialChar LaTeX
13705 \begin_inset Flex Code
13708 \begin_layout Plain Layout
13714 status is inherited by the inset or paragraph layout the argument belongs
13715 to, true and false change the status for the given argument only.
13718 \begin_layout Itemize
13720 \change_deleted -584632292 1615846694
13721 \begin_inset Flex Code
13724 \begin_layout Plain Layout
13731 \begin_inset Flex Code
13734 \begin_layout Plain Layout
13735 string of characters
13744 Defines individual characters
13745 \begin_inset Newline linebreak
13748 that should be output in raw form, meaning without special translations
13749 that \SpecialChar LaTeX
13751 Note that, contrary to PassThru, this needs to be explicitly defined for
13753 That is, arguments do not inherit PassThruChars from their parent inset
13757 \begin_layout Itemize
13759 \change_deleted -584632292 1615846694
13760 \begin_inset Flex Code
13763 \begin_layout Plain Layout
13770 \begin_inset Flex Code
13773 \begin_layout Plain Layout
13782 \begin_inset space \thinspace{}
13786 \begin_inset Flex Code
13789 \begin_layout Plain Layout
13795 ] If this is set to 1, the argument will output its content in the corresponding
13796 item in the table of contents.
13800 \begin_layout Standard
13802 \change_deleted -584632292 1615846694
13803 By default, the text entered in the \SpecialChar LyX
13804 workarea in the respective layout is
13805 the last (mandatory) argument of a command if the
13806 \begin_inset Flex Code
13809 \begin_layout Plain Layout
13816 \begin_inset Flex Code
13819 \begin_layout Plain Layout
13826 However, arguments with the prefix
13827 \begin_inset Flex Code
13830 \begin_layout Plain Layout
13836 are output after this workarea argument.
13837 Note that post-argument numbering restarts at 1, so the first argument
13838 following the workarea argument is
13839 \begin_inset Flex Code
13842 \begin_layout Plain Layout
13849 Post-arguments are ignored in any other
13850 \begin_inset Flex Code
13853 \begin_layout Plain Layout
13860 \begin_inset Flex Code
13863 \begin_layout Plain Layout
13872 \begin_layout Standard
13874 \change_deleted -584632292 1615846694
13876 \begin_inset Flex Code
13879 \begin_layout Plain Layout
13888 \begin_inset Flex Code
13891 \begin_layout Plain Layout
13900 \begin_inset Flex Code
13903 \begin_layout Plain Layout
13909 followed by the number (e.
13910 \begin_inset space \thinspace{}
13914 \begin_inset space \space{}
13918 \begin_inset Flex Code
13921 \begin_layout Plain Layout
13930 \begin_layout Standard
13932 \change_deleted -584632292 1615846694
13933 Finally, there is a special argument type with the prefix
13934 \begin_inset Flex Code
13937 \begin_layout Plain Layout
13939 \change_inserted -712698321 1534487844
13948 It is not really an argument, but uses the argument interface (thus, the
13949 prefix is also followed by a number, e.
13950 \begin_inset space \thinspace{}
13955 \begin_inset Flex Code
13958 \begin_layout Plain Layout
13960 \change_inserted -712698321 1534488412
13961 Argument listpreamble:1
13969 As the name implies, it is targeted at lists such as
13986 Its content will be output at the list start, before the first
13987 \begin_inset Flex Code
13990 \begin_layout Plain Layout
13992 \change_inserted -712698321 1534488058
14002 , on an own line (a place that is otherwise not accessible in \SpecialChar LyX
14004 This way, users can insert redefinitions (of lengths etc.) to individual
14006 By default, these arguments do not have a delimiter.
14012 \begin_layout Description
14013 \begin_inset Flex Code
14016 \begin_layout Plain Layout
14022 Includes a comma-separated list of layouts that should be nested in and
14023 after the current layout.
14024 Only makes sense for nestable layouts (such as environments).
14026 \begin_inset Quotes eld
14030 \begin_inset Flex Code
14033 \begin_layout Plain Layout
14040 \begin_inset Quotes erd
14045 \begin_inset Flex Code
14048 \begin_layout Plain Layout
14057 \begin_layout Description
14058 \begin_inset Flex Code
14061 \begin_layout Plain Layout
14067 Note that this will completely override any prior
14068 \begin_inset Flex Code
14071 \begin_layout Plain Layout
14077 declaration for this style.
14079 \begin_inset Quotes eld
14083 \begin_inset Flex Code
14086 \begin_layout Plain Layout
14093 \begin_inset Quotes erd
14098 \begin_inset CommandInset ref
14100 reference "subsec:I18n"
14104 for details on its use.
14107 \begin_layout Description
14108 \begin_inset Flex Code
14111 \begin_layout Plain Layout
14118 \begin_inset Flex Code
14121 \begin_layout Plain Layout
14131 \begin_layout Plain Layout
14132 Note that a `float' here is a real number, such as: 1.5.
14137 The vertical space with which the last of a chain of paragraphs with this
14138 style is separated from the following paragraph.
14139 If the next paragraph has another style, the separations are not simply
14140 added, but the maximum is taken.
14143 \begin_layout Description
14144 \begin_inset Flex Code
14147 \begin_layout Plain Layout
14154 \begin_inset Flex Code
14157 \begin_layout Plain Layout
14163 ] The category for this style.
14164 This is used to group related styles in the style combobox on the toolbar.
14165 Any string can be used, but you may want to use existing categories with
14170 \begin_layout Description
14171 \begin_inset Flex Code
14174 \begin_layout Plain Layout
14180 Depth of XML command.
14181 Used only with XML-type formats.
14184 \begin_layout Description
14185 \begin_inset Flex Code
14188 \begin_layout Plain Layout
14195 \begin_inset Flex Code
14198 \begin_layout Plain Layout
14204 ] Copies all the features of an existing style into the current one.
14208 \begin_layout Description
14209 \begin_inset Flex Code
14212 \begin_layout Plain Layout
14219 \begin_inset Flex Code
14222 \begin_layout Plain Layout
14228 ] The name of a style whose preamble should be output
14233 This allows to ensure some ordering of the preamble snippets when macros
14234 definitions depend on one another.
14238 \begin_layout Plain Layout
14239 Note that, besides that functionality, there is no way to ensure any ordering
14241 The ordering that you see in a given version of \SpecialChar LyX
14242 may change without warning
14251 \begin_layout Description
14252 \begin_inset Flex Code
14255 \begin_layout Plain Layout
14262 \begin_inset Flex Code
14265 \begin_layout Plain Layout
14270 , Box, Filled_Box, Static
14275 ] The type of label that stands at the end of the paragraph (or sequence
14277 \begin_inset Flex Code
14280 \begin_layout Plain Layout
14287 \begin_inset Newline newline
14291 \begin_inset Flex Code
14294 \begin_layout Plain Layout
14301 \begin_inset Flex Code
14304 \begin_layout Plain Layout
14311 \begin_inset Flex Code
14314 \begin_layout Plain Layout
14322 \begin_inset Flex Code
14325 \begin_layout Plain Layout
14332 \begin_inset Quotes eld
14336 \begin_inset Quotes erd
14340 \begin_inset Flex Code
14343 \begin_layout Plain Layout
14350 \begin_inset space \space{}
14354 \begin_inset Flex Code
14357 \begin_layout Plain Layout
14363 ) is a white (resp.
14364 \begin_inset space ~
14367 black) square suitable for end of proof markers,
14368 \begin_inset Flex Code
14371 \begin_layout Plain Layout
14377 is an explicit text string.
14380 \begin_layout Description
14381 \begin_inset Flex Code
14384 \begin_layout Plain Layout
14391 \begin_inset Flex Code
14394 \begin_layout Plain Layout
14400 ] The string used for a label with a
14401 \begin_inset Flex Code
14404 \begin_layout Plain Layout
14411 \begin_inset Newline newline
14415 \begin_inset Flex Code
14418 \begin_layout Plain Layout
14428 \begin_layout Description
14429 \begin_inset Flex Code
14432 \begin_layout Plain Layout
14438 The font used for both the text body
14444 \begin_inset CommandInset ref
14446 reference "subsec:Font-description"
14451 Note that defining this font automatically defines the
14452 \begin_inset Flex Code
14455 \begin_layout Plain Layout
14462 So you should define this one first if you also want to define
14463 \begin_inset Flex Code
14466 \begin_layout Plain Layout
14475 \begin_layout Description
14476 \begin_inset Flex Code
14479 \begin_layout Plain Layout
14486 \begin_inset Flex Code
14489 \begin_layout Plain Layout
14495 ] Used for backporting new styles to stable \SpecialChar LyX
14497 The first stable version that supports this tag is \SpecialChar LyX
14499 The argument is a number which may either be 0, -1 or any value greater
14502 \begin_inset Flex Code
14505 \begin_layout Plain Layout
14511 flag of a style is greater than zero, it will always be written to the
14513 If a .lyx file is read, the style definitions from the document header are
14514 added to the document class.
14515 Therefore even older \SpecialChar LyX
14516 versions can handle the style.
14518 \begin_inset Flex Code
14521 \begin_layout Plain Layout
14527 is a version number: if the style is read, and the version number is less
14528 than the version number of the already existing style in the document class,
14529 the new style is ignored.
14530 If the version number is greater, the new style replaces the existing style.
14531 A value of -1 means an infinite version number, i.
14532 \begin_inset space \thinspace{}
14536 \begin_inset space \space{}
14539 the style is always used.
14542 \begin_layout Description
14543 \begin_inset Flex Code
14546 \begin_layout Plain Layout
14553 \begin_inset Flex Code
14556 \begin_layout Plain Layout
14565 \begin_inset space \thinspace{}
14569 \begin_inset Flex Code
14572 \begin_layout Plain Layout
14578 ] Usually \SpecialChar LyX
14579 does not allow you to insert more than one space between words,
14580 since a space is considered as the separation between two words, not a
14581 character or symbol of its own.
14582 This is a very fine thing but sometimes annoying, for example, when typing
14583 program code or plain \SpecialChar LaTeX
14586 \begin_inset Flex Code
14589 \begin_layout Plain Layout
14597 \change_deleted -495245474 1550490105
14602 \change_deleted 177693 1654669077
14604 \change_inserted 177693 1654669079
14608 \change_deleted 177693 1654669082
14610 \change_inserted 177693 1654669082
14613 for the additional blanks when
14614 \change_deleted 34634807 1619626461
14618 \change_inserted -495245474 1550490096
14620 \begin_inset Flex Code
14623 \begin_layout Plain Layout
14625 \change_inserted -495245474 1550490089
14634 \change_deleted -495245474 1550490116
14635 another mode than \SpecialChar LaTeX
14638 \change_inserted -495245474 1550247760
14640 \begin_inset Flex Code
14643 \begin_layout Plain Layout
14645 \change_inserted -495245474 1550247736
14654 \begin_inset Flex Code
14657 \begin_layout Plain Layout
14659 \change_inserted -495245474 1550247755
14672 \begin_layout Description
14673 \begin_inset Flex Code
14676 \begin_layout Plain Layout
14682 These tags are used with XHTML output.
14684 \begin_inset CommandInset ref
14686 reference "subsec:Paragraph-Style-XHTML"
14693 \begin_layout Description
14694 \begin_inset Flex Code
14697 \begin_layout Plain Layout
14703 [FIXME] (Used only with XML-type formats.)
14706 \begin_layout Description
14707 \begin_inset Flex Code
14710 \begin_layout Plain Layout
14717 \begin_inset Flex Code
14720 \begin_layout Plain Layout
14729 \begin_inset space \thinspace{}
14733 \begin_inset Flex Code
14736 \begin_layout Plain Layout
14743 \begin_inset Flex Code
14746 \begin_layout Plain Layout
14752 , marks the style as to be included in the document preamble and not in
14754 This is useful for document classes that want such information as the title
14755 and author to appear in the preamble.
14756 Note that this works only for styles for which the
14757 \begin_inset Flex Code
14760 \begin_layout Plain Layout
14767 \begin_inset Flex Code
14770 \begin_layout Plain Layout
14777 \begin_inset Flex Code
14780 \begin_layout Plain Layout
14789 \begin_layout Description
14790 \begin_inset Flex Code
14793 \begin_layout Plain Layout
14800 \begin_inset Flex Code
14803 \begin_layout Plain Layout
14812 \begin_inset space \thinspace{}
14816 \begin_inset Flex Code
14819 \begin_layout Plain Layout
14826 \begin_inset Flex Code
14829 \begin_layout Plain Layout
14835 , marks the style as being part of a title block (see also the
14836 \begin_inset Flex Code
14839 \begin_layout Plain Layout
14846 \begin_inset Flex Code
14849 \begin_layout Plain Layout
14858 \begin_layout Description
14859 \begin_inset Flex Code
14862 \begin_layout Plain Layout
14868 Includes a comma-separated list of layouts after which this one should
14870 Only makes sense with regard to nestable layouts (such as environments).
14872 \begin_inset Quotes eld
14876 \begin_inset Flex Code
14879 \begin_layout Plain Layout
14886 \begin_inset Quotes erd
14891 \begin_inset Flex Code
14894 \begin_layout Plain Layout
14903 \begin_layout Description
14904 \begin_inset Flex Code
14907 \begin_layout Plain Layout
14914 \begin_inset Flex Code
14917 \begin_layout Plain Layout
14926 \begin_inset space \thinspace{}
14930 \begin_inset Flex Code
14933 \begin_layout Plain Layout
14939 ] If this is set to 1 and AddToToc is enabled, the paragraph adds a summary
14940 of its contents in its item in the table of contents.
14941 Otherwise, only the label, if it exists, appears.
14944 \begin_layout Description
14945 \begin_inset Flex Code
14948 \begin_layout Plain Layout
14955 \begin_inset Flex Code
14958 \begin_layout Plain Layout
14964 ] The \SpecialChar LaTeX
14965 command sequence declaring an item in a list.
14966 The command is to be defined without the preceding backslash (the default
14968 \begin_inset Quotes eld
14972 \begin_inset Quotes erd
14976 \begin_inset Flex Code
14979 \begin_layout Plain Layout
14987 in the \SpecialChar LaTeX
14991 \begin_layout Description
14992 \begin_inset Flex Code
14995 \begin_layout Plain Layout
15002 \begin_inset Flex Code
15005 \begin_layout Plain Layout
15011 ] This provides extra space between paragraphs that have the same style.
15012 If you put other styles into an environment, each is separated with the
15014 \begin_inset Flex Code
15017 \begin_layout Plain Layout
15024 But the whole items of the environment are additionally separated with
15026 \begin_inset Flex Code
15029 \begin_layout Plain Layout
15036 Note that this is a
15041 \begin_layout Description
15042 \begin_inset Flex Code
15045 \begin_layout Plain Layout
15051 [FIXME] (Used only with XML-type formats.)
15054 \begin_layout Description
15055 \begin_inset Flex Code
15058 \begin_layout Plain Layout
15065 \begin_inset Flex Code
15068 \begin_layout Plain Layout
15077 \begin_inset space \thinspace{}
15081 \begin_inset Flex Code
15084 \begin_layout Plain Layout
15090 ] Usually \SpecialChar LyX
15091 does not allow you to leave a paragraph empty, since it would
15092 lead to empty \SpecialChar LaTeX
15094 There are some cases where this could be desirable however: in a letter
15095 template, the required fields can be provided as empty fields, so that
15096 people do not forget them; in some special classes, a style can be used
15097 as some kind of break, which does not contain actual text.
15100 \begin_layout Description
15101 \begin_inset Flex Code
15104 \begin_layout Plain Layout
15111 \begin_inset Flex Code
15114 \begin_layout Plain Layout
15120 ] The vertical space between the label and the text body.
15121 Only used for labels that are above the text body (
15122 \begin_inset Flex Code
15125 \begin_layout Plain Layout
15132 \begin_inset Newline newline
15136 \begin_inset Flex Code
15139 \begin_layout Plain Layout
15140 Centered_Top_Environment
15148 \begin_layout Description
15149 \begin_inset Flex Code
15152 \begin_layout Plain Layout
15159 \begin_inset Flex Code
15162 \begin_layout Plain Layout
15168 ] The name of the counter for automatic numbering.
15169 In order to have the counter appear with your label, you will need to reference
15171 \begin_inset Flex Code
15174 \begin_layout Plain Layout
15183 This will work with
15184 \begin_inset Flex Code
15187 \begin_layout Plain Layout
15194 \begin_inset Flex Code
15197 \begin_layout Plain Layout
15204 \begin_inset Flex Code
15207 \begin_layout Plain Layout
15214 \begin_inset Flex Code
15217 \begin_layout Plain Layout
15224 \begin_inset Newline newline
15232 \begin_inset Flex Code
15235 \begin_layout Plain Layout
15242 \begin_inset Flex Code
15245 \begin_layout Plain Layout
15251 , though this case is a bit complicated.
15252 Suppose you declare
15253 \begin_inset Quotes eld
15257 \begin_inset Flex Code
15260 \begin_layout Plain Layout
15261 LabelCounter myenum
15267 \begin_inset Quotes erd
15271 Then the actual counters used are
15272 \begin_inset Flex Code
15275 \begin_layout Plain Layout
15282 \begin_inset Flex Code
15285 \begin_layout Plain Layout
15292 \begin_inset Flex Code
15295 \begin_layout Plain Layout
15302 \begin_inset Flex Code
15305 \begin_layout Plain Layout
15311 , much as in \SpecialChar LaTeX
15313 These counters must all be declared separately.
15314 \begin_inset Newline newline
15318 \begin_inset CommandInset ref
15320 reference "subsec:Counters"
15324 for details on counters.
15327 \begin_layout Description
15328 \begin_inset Flex Code
15331 \begin_layout Plain Layout
15337 The font used for the label.
15339 \begin_inset CommandInset ref
15341 reference "subsec:Font-description"
15348 \begin_layout Description
15349 \begin_inset Flex Code
15352 \begin_layout Plain Layout
15359 \begin_inset Flex Code
15362 \begin_layout Plain Layout
15368 ] Text that indicates how far a label should be indented.
15371 \begin_layout Description
15372 \begin_inset Flex Code
15375 \begin_layout Plain Layout
15382 \begin_inset Flex Code
15385 \begin_layout Plain Layout
15391 ] Text that indicates the amount of horizontal space between the label and
15393 Only used for labels that are not above the text body.
15396 \begin_layout Description
15397 \begin_inset Flex Code
15400 \begin_layout Plain Layout
15407 \begin_inset Flex Code
15410 \begin_layout Plain Layout
15416 ] The string used for the label.
15418 \begin_inset Flex Code
15421 \begin_layout Plain Layout
15427 is set, this string can be contain the special formatting commands described
15429 \begin_inset CommandInset ref
15431 reference "subsec:Counters"
15438 \begin_layout Description
15439 \begin_inset Flex Code
15442 \begin_layout Plain Layout
15443 LabelStringAppendix
15449 \begin_inset Flex Code
15452 \begin_layout Plain Layout
15458 ] This is used inside the appendix instead of
15459 \begin_inset Newline newline
15463 \begin_inset Flex Code
15466 \begin_layout Plain Layout
15474 \begin_inset Flex Code
15477 \begin_layout Plain Layout
15484 \begin_inset Newline newline
15488 \begin_inset Flex Code
15491 \begin_layout Plain Layout
15492 LabelStringAppendix
15500 \begin_layout Description
15501 \begin_inset Flex Code
15504 \begin_layout Plain Layout
15510 [FIXME] (Used only with XML-type formats.)
15513 \begin_layout Description
15514 \begin_inset Flex Code
15517 \begin_layout Plain Layout
15524 \begin_inset Flex Code
15527 \begin_layout Plain Layout
15532 , Manual, Static, Above,
15533 \begin_inset Newline newline
15536 Centered, Sensitive, Enumerate,
15537 \begin_inset Newline newline
15540 Itemize, Bibliography
15549 \begin_layout Description
15550 \begin_inset Flex Code
15553 \begin_layout Plain Layout
15559 means the label is the very first word (up to the first real blank).
15561 \change_deleted 177693 1654669087
15563 \change_inserted 177693 1654669089
15566 spaces if you want more than one word as the label.
15570 \begin_layout Description
15571 \begin_inset Flex Code
15574 \begin_layout Plain Layout
15580 means the label is simply what is declared as
15581 \begin_inset Flex Code
15584 \begin_layout Plain Layout
15591 This will be displayed
15592 \begin_inset Quotes eld
15596 \begin_inset Quotes erd
15599 , at the beginning of the paragraph.
15601 \begin_inset Flex Code
15604 \begin_layout Plain Layout
15611 \begin_inset Flex Code
15614 \begin_layout Plain Layout
15620 , then it will be displayed only in the first paragraph of any sequence
15621 of paragraphs with the same
15622 \begin_inset Flex Code
15625 \begin_layout Plain Layout
15634 \begin_layout Description
15635 \begin_inset Flex Code
15638 \begin_layout Plain Layout
15645 \begin_inset space ~
15649 \begin_inset space ~
15653 \begin_inset Flex Code
15656 \begin_layout Plain Layout
15662 are special cases of
15663 \begin_inset Flex Code
15666 \begin_layout Plain Layout
15673 The label will be printed above the paragraph either at the beginning of
15674 the line or centered.
15677 \begin_layout Description
15678 \begin_inset Flex Code
15681 \begin_layout Plain Layout
15687 is a special case for the caption-labels
15688 \begin_inset Quotes eld
15692 \begin_inset Quotes erd
15696 \begin_inset Quotes eld
15700 \begin_inset Quotes erd
15704 \begin_inset Newline newline
15708 \begin_inset Flex Code
15711 \begin_layout Plain Layout
15717 means the (hardcoded) label string depends on the kind of float: It is
15718 hardcoded to be `FloatType N', where N is the value of the counter associated
15720 For the case that a caption is inserted outside of a float the
15721 \begin_inset Flex Code
15724 \begin_layout Plain Layout
15731 \begin_inset Quotes eld
15735 \begin_inset Quotes erd
15741 \begin_layout Description
15742 \begin_inset Flex Code
15745 \begin_layout Plain Layout
15751 produces the usual sort of enumeration labels.
15752 The number type needs to be set in the
15757 \begin_inset CommandInset ref
15759 reference "subsec:Counters"
15766 \begin_layout Description
15767 \begin_inset Flex Code
15770 \begin_layout Plain Layout
15776 produces various bullets at the different levels.
15777 The bullet types displayed can be set via
15778 \begin_inset Flex Noun
15781 \begin_layout Plain Layout
15782 Document\SpecialChar menuseparator
15783 Settings\SpecialChar menuseparator
15792 \begin_layout Description
15793 \begin_inset Flex Code
15796 \begin_layout Plain Layout
15802 should be used only with
15803 \begin_inset Flex Code
15806 \begin_layout Plain Layout
15807 LatexType BibEnvironment
15816 \begin_layout Description
15817 \begin_inset Flex Code
15820 \begin_layout Plain Layout
15826 Note that this will completely override any prior
15827 \begin_inset Flex Code
15830 \begin_layout Plain Layout
15836 declaration for this style.
15838 \begin_inset Quotes eld
15842 \begin_inset Flex Code
15845 \begin_layout Plain Layout
15852 \begin_inset Quotes erd
15857 \begin_inset CommandInset ref
15859 reference "subsec:I18n"
15863 for details on its use.
15866 \begin_layout Description
15867 \begin_inset Flex Code
15870 \begin_layout Plain Layout
15877 \begin_inset Flex Code
15880 \begin_layout Plain Layout
15886 ] The name of the corresponding \SpecialChar LaTeX
15888 Either the environment or command name.
15891 \begin_layout Description
15892 \begin_inset Flex Code
15895 \begin_layout Plain Layout
15902 \begin_inset Flex Code
15905 \begin_layout Plain Layout
15911 ] An optional parameter for the corresponding
15912 \begin_inset Flex Code
15915 \begin_layout Plain Layout
15922 This parameter cannot be changed from within \SpecialChar LyX
15924 \begin_inset Flex Code
15927 \begin_layout Plain Layout
15933 for customizable parameters).
15934 This will be output as is after all \SpecialChar LaTeX
15936 \begin_inset Flex Code
15939 \begin_layout Plain Layout
15948 \begin_layout Description
15949 \begin_inset Flex Code
15952 \begin_layout Plain Layout
15959 \begin_inset Flex Code
15962 \begin_layout Plain Layout
15967 , Command, Environment, Item_Environment,
15968 \begin_inset Newline newline
15971 List_Environment, Bib_Environment
15976 ] How the style should be translated into \SpecialChar LaTeX
15981 \begin_layout Plain Layout
15982 \begin_inset Flex Code
15985 \begin_layout Plain Layout
15991 is perhaps a bit misleading, since these rules apply to SGML classes, too.
15992 Visit the SGML class files for specific examples.
16001 \begin_layout Description
16002 \begin_inset Flex Code
16005 \begin_layout Plain Layout
16011 means nothing special.
16014 \begin_layout Description
16015 \begin_inset Flex Code
16018 \begin_layout Plain Layout
16025 \begin_inset Flex Code
16028 \begin_layout Plain Layout
16035 {\SpecialChar ldots
16044 \begin_layout Description
16045 \begin_inset Flex Code
16048 \begin_layout Plain Layout
16055 \begin_inset Flex Code
16058 \begin_layout Plain Layout
16065 }\SpecialChar ldots
16081 \begin_layout Description
16082 \begin_inset Flex Code
16085 \begin_layout Plain Layout
16092 \begin_inset Flex Code
16095 \begin_layout Plain Layout
16102 \begin_inset Flex Code
16105 \begin_layout Plain Layout
16113 is generated for each paragraph of this environment.
16117 \begin_layout Description
16118 \begin_inset Flex Code
16121 \begin_layout Plain Layout
16128 \begin_inset Flex Code
16131 \begin_layout Plain Layout
16138 \begin_inset Newline newline
16142 \begin_inset Flex Code
16145 \begin_layout Plain Layout
16151 is passed as an argument to the environment.
16152 \begin_inset Newline newline
16156 \begin_inset Flex Code
16159 \begin_layout Plain Layout
16165 can be defined in the
16166 \begin_inset Flex Noun
16169 \begin_layout Plain Layout
16170 Edit\SpecialChar menuseparator
16172 \begin_inset space ~
16183 \begin_layout Description
16184 \begin_inset Flex Code
16187 \begin_layout Plain Layout
16194 \begin_inset Flex Code
16197 \begin_layout Plain Layout
16203 but adds the necessary mandatory argument (the longest label) to the begin
16204 statement of the bibliography environment:
16205 \begin_inset Newline newline
16209 \begin_inset Flex Code
16212 \begin_layout Plain Layout
16215 begin{thebibliography}{99}
16221 It is therefore only useful for bibliography environments.
16222 The default longest label
16223 \begin_inset Quotes eld
16227 \begin_inset Quotes erd
16230 can be changed by the user in the paragraph settings of a bibliography
16234 \begin_layout Standard
16235 Putting the last few things together, the \SpecialChar LaTeX
16236 output will be either:
16239 \begin_layout LyX-Code
16242 LatexName[LatexParam]{\SpecialChar ldots
16246 \begin_layout Standard
16250 \begin_layout LyX-Code
16253 begin{LatexName}[LatexParam] \SpecialChar ldots
16259 \begin_layout Standard
16260 depending upon the \SpecialChar LaTeX
16265 \begin_layout Description
16266 \begin_inset Flex Code
16269 \begin_layout Plain Layout
16276 \begin_inset Flex Code
16279 \begin_layout Plain Layout
16285 ] A string that is put at the beginning of the style content.
16286 A line break in the output can be indicated by
16287 \begin_inset Flex Code
16290 \begin_layout Plain Layout
16299 \begin_layout Description
16300 \begin_inset Flex Code
16303 \begin_layout Plain Layout
16310 \begin_inset Flex Code
16313 \begin_layout Plain Layout
16319 ] If you put styles into environments, the different
16320 \begin_inset Flex Code
16323 \begin_layout Plain Layout
16329 are not simply added, but added with a factor
16330 \begin_inset Formula $\frac{4}{\mathrm{depth}+4}$
16334 Note that this parameter is also used when
16335 \begin_inset Flex Code
16338 \begin_layout Plain Layout
16345 \begin_inset Flex Code
16348 \begin_layout Plain Layout
16355 \begin_inset Flex Code
16358 \begin_layout Plain Layout
16365 Then it is added to the manual or dynamic margin.
16366 \begin_inset Newline newline
16370 \begin_inset Quotes eld
16374 \begin_inset Flex Code
16377 \begin_layout Plain Layout
16384 \begin_inset Quotes erd
16387 means that the paragraph is indented with the width of
16388 \begin_inset Quotes eld
16392 \begin_inset Flex Code
16395 \begin_layout Plain Layout
16402 \begin_inset Quotes erd
16405 in the normal font.
16406 You can get a negative width by prefixing the string with
16407 \begin_inset Quotes eld
16411 \begin_inset Flex Code
16414 \begin_layout Plain Layout
16421 \begin_inset Quotes erd
16425 This way was chosen so that the look is the same with each used screen
16429 \begin_layout Description
16430 \begin_inset Flex Code
16433 \begin_layout Plain Layout
16440 \begin_inset Flex Code
16443 \begin_layout Plain Layout
16448 , Manual, Dynamic, First_Dynamic, Right_Address_Box
16454 \begin_inset Newline newline
16457 The kind of margin that the style has on the left side.
16461 \begin_layout Description
16462 \begin_inset Flex Code
16465 \begin_layout Plain Layout
16471 just means a fixed margin.
16474 \begin_layout Description
16475 \begin_inset Flex Code
16478 \begin_layout Plain Layout
16484 means that the left margin depends on the string entered in the
16485 \begin_inset Flex Noun
16488 \begin_layout Plain Layout
16489 Edit\SpecialChar menuseparator
16491 \begin_inset space ~
16500 This is used to typeset nice lists without tabulators.
16503 \begin_layout Description
16504 \begin_inset Flex Code
16507 \begin_layout Plain Layout
16513 means that the margin depends on the size of the label.
16514 This is used for automatic enumerated headlines.
16515 It is obvious that the headline
16516 \begin_inset Quotes eld
16519 5.4.3.2.1 Very long headline
16520 \begin_inset Quotes erd
16523 must have a wider left margin (as wide as
16524 \begin_inset Quotes eld
16528 \begin_inset Quotes erd
16531 plus the space) than
16532 \begin_inset Quotes eld
16535 3.2 Very long headline
16536 \begin_inset Quotes erd
16540 \begin_inset Quotes eld
16544 \begin_inset Quotes erd
16547 are not able to do this.
16550 \begin_layout Description
16551 \begin_inset Flex Code
16554 \begin_layout Plain Layout
16560 is similar, but only the very first row of the paragraph is dynamic, while
16561 the others are static; this is used, for example, for descriptions.
16564 \begin_layout Description
16565 \begin_inset Flex Code
16568 \begin_layout Plain Layout
16574 means the margin is chosen in a way that the longest row of this paragraph
16575 fits to the right margin.
16576 This is used to typeset an address on the right edge of the page.
16580 \begin_layout Description
16581 \begin_inset Flex Code
16584 \begin_layout Plain Layout
16591 \begin_inset Flex Code
16594 \begin_layout Plain Layout
16603 \begin_inset space \thinspace{}
16607 \begin_inset Flex Code
16610 \begin_layout Plain Layout
16616 ] Whether fragile commands in this style should be
16617 \begin_inset Flex Code
16620 \begin_layout Plain Layout
16633 whether this command should itself be protected.)
16634 \change_inserted -712698321 1523696949
16638 \begin_layout Description
16640 \change_inserted -712698321 1552395557
16641 \begin_inset Flex Code
16644 \begin_layout Plain Layout
16646 \change_inserted -712698321 1523696950
16655 \begin_inset Flex Code
16658 \begin_layout Plain Layout
16660 \change_inserted -712698321 1523696950
16671 \begin_inset space \thinspace{}
16675 \begin_inset Flex Code
16678 \begin_layout Plain Layout
16680 \change_inserted -712698321 1523696950
16688 ] This causes macros that contain this layout to be protected with
16689 \begin_inset Flex Code
16692 \begin_layout Plain Layout
16694 \change_inserted -712698321 1523696950
16709 ) if necessary and thus allows (some) verbatim stuff in macros.
16712 \begin_layout Description
16714 \change_inserted -712698321 1552395844
16715 \begin_inset Flex Code
16718 \begin_layout Plain Layout
16720 \change_inserted -712698321 1552395561
16729 \begin_inset Flex Code
16732 \begin_layout Plain Layout
16734 \change_inserted -712698321 1552395557
16745 \begin_inset space \thinspace{}
16749 \begin_inset Flex Code
16752 \begin_layout Plain Layout
16754 \change_inserted -712698321 1552395557
16762 ] Whether specific commands in this style (such as
16763 \begin_inset Flex Code
16766 \begin_layout Plain Layout
16768 \change_inserted -712698321 1552395655
16779 \begin_inset Flex Code
16782 \begin_layout Plain Layout
16784 \change_inserted -712698321 1552395661
16794 ) should be protected in an
16795 \begin_inset Flex Code
16798 \begin_layout Plain Layout
16800 \change_inserted -712698321 1552395631
16811 This is particularly needed for styles that draw on
16819 commands which parse their content in complex ways.
16824 \begin_layout Description
16825 \begin_inset Flex Code
16828 \begin_layout Plain Layout
16835 \begin_inset Flex Code
16838 \begin_layout Plain Layout
16845 \begin_inset space \thinspace{}
16849 \begin_inset Flex Code
16852 \begin_layout Plain Layout
16860 ] Whether newlines are translated into \SpecialChar LaTeX
16862 \begin_inset Flex Code
16865 \begin_layout Plain Layout
16876 The translation can be switched off to allow more comfortable \SpecialChar LaTeX
16878 inside \SpecialChar LyX
16882 \begin_layout Description
16883 \begin_inset Flex Code
16886 \begin_layout Plain Layout
16893 \begin_inset Flex Code
16896 \begin_layout Plain Layout
16905 \begin_inset space \thinspace{}
16909 \begin_inset Flex Code
16912 \begin_layout Plain Layout
16918 ] If set to true, and if
16919 \begin_inset Flex Code
16922 \begin_layout Plain Layout
16929 \begin_inset Flex Code
16932 \begin_layout Plain Layout
16938 ) paragraphs are being indented, then the indentation of such a paragraph
16939 following one of this type will be suppressed.
16940 (So this will not affect the display of non-default paragraphs.)
16943 \begin_layout Description
16944 \begin_inset Flex Code
16947 \begin_layout Plain Layout
16954 \begin_inset Flex Code
16957 \begin_layout Plain Layout
16963 ] Name of a style that has replaced this style.
16964 This is used to rename a style, while keeping backward compatibility.
16967 \begin_layout Description
16968 \begin_inset Flex Code
16971 \begin_layout Plain Layout
16978 \begin_inset Flex Code
16981 \begin_layout Plain Layout
16988 \begin_inset space \thinspace{}
16992 \begin_inset Flex Code
16995 \begin_layout Plain Layout
17001 ] Determines whether consecutive paragraphs of the same type are treated
17002 as belonging together.
17003 This has the effect that the
17004 \begin_inset Flex Code
17007 \begin_layout Plain Layout
17013 is only printed once before such a group.
17014 By default, this is true for
17015 \begin_inset Flex Code
17018 \begin_layout Plain Layout
17025 \begin_inset Flex Code
17028 \begin_layout Plain Layout
17035 \begin_inset Flex Code
17038 \begin_layout Plain Layout
17044 and false for all other types.
17047 \begin_layout Description
17048 \begin_inset Flex Code
17051 \begin_layout Plain Layout
17058 \begin_inset Flex Code
17061 \begin_layout Plain Layout
17070 \begin_inset space \thinspace{}
17074 \begin_inset Flex Code
17077 \begin_layout Plain Layout
17083 ] Indicates that paragraphs will not be separated by an empty line in \SpecialChar LaTeX
17085 but only by a line break; together with
17086 \begin_inset Flex Code
17089 \begin_layout Plain Layout
17095 , this allows to emulate a plain text editor (like the ERT inset).
17098 \begin_layout Description
17099 \begin_inset Flex Code
17102 \begin_layout Plain Layout
17109 \begin_inset Flex Code
17112 \begin_layout Plain Layout
17118 ] The indent of the very first line of a paragraph.
17120 \begin_inset Newline newline
17124 \begin_inset Flex Code
17127 \begin_layout Plain Layout
17133 will be fixed for a certain style.
17134 The exception is the default style, since the indentation for these paragraphs
17135 can be prohibited with
17136 \begin_inset Flex Code
17139 \begin_layout Plain Layout
17147 \begin_inset Flex Code
17150 \begin_layout Plain Layout
17156 style paragraphs inside environments use the
17157 \begin_inset Flex Code
17160 \begin_layout Plain Layout
17166 of the environment, not their native one.
17168 \begin_inset Flex Code
17171 \begin_layout Plain Layout
17177 paragraphs inside an enumeration are not indented.
17180 \begin_layout Description
17181 \begin_inset Flex Code
17184 \begin_layout Plain Layout
17191 \begin_inset Flex Code
17194 \begin_layout Plain Layout
17200 ] The vertical space between two paragraphs of this style.
17203 \begin_layout Description
17204 \begin_inset Flex Code
17207 \begin_layout Plain Layout
17214 \begin_inset Flex Code
17217 \begin_layout Plain Layout
17224 allows the user to choose either
17225 \begin_inset Quotes eld
17229 \begin_inset Quotes erd
17233 \begin_inset Quotes eld
17237 \begin_inset Quotes erd
17240 to separate paragraphs.
17242 \begin_inset Quotes eld
17246 \begin_inset Quotes erd
17250 \begin_inset Flex Code
17253 \begin_layout Plain Layout
17261 \begin_inset Quotes eld
17265 \begin_inset Quotes erd
17269 \begin_inset Flex Code
17272 \begin_layout Plain Layout
17278 is ignored and all paragraphs are separated by the
17279 \begin_inset Flex Code
17282 \begin_layout Plain Layout
17289 The vertical space is calculated with
17290 \begin_inset Flex Code
17293 \begin_layout Plain Layout
17295 \begin_inset space ~
17304 \begin_inset Flex Code
17307 \begin_layout Plain Layout
17313 is the height of a row with the normal font.
17314 This way, the look stays the same with different screen fonts.
17317 \begin_layout Description
17318 \begin_inset Flex Code
17321 \begin_layout Plain Layout
17328 \begin_inset Flex Code
17331 \begin_layout Plain Layout
17340 \begin_inset space \thinspace{}
17344 \begin_inset Flex Code
17347 \begin_layout Plain Layout
17353 ] Whether the contents of this paragraph should be output in raw form, meaning
17354 without special translations that \SpecialChar LaTeX
17358 \begin_layout Description
17359 \begin_inset Flex Code
17362 \begin_layout Plain Layout
17369 \begin_inset Flex Code
17372 \begin_layout Plain Layout
17382 Defines individual characters that should be output in raw form, meaning
17383 without special translations that \SpecialChar LaTeX
17387 \begin_layout Description
17388 \begin_inset Flex Code
17391 \begin_layout Plain Layout
17397 Information to be included in the \SpecialChar LaTeX
17398 preamble when this style is used.
17399 Used to define macros, load packages, etc., required by this particular
17402 \begin_inset Quotes eld
17406 \begin_inset Flex Code
17409 \begin_layout Plain Layout
17416 \begin_inset Quotes erd
17422 \begin_layout Description
17423 \begin_inset Flex Code
17426 \begin_layout Plain Layout
17433 \begin_inset Flex Code
17436 \begin_layout Plain Layout
17442 ] The prefix to use when creating labels referring to paragraphs of this
17444 This allows the use of formatted references.
17447 \begin_layout Description
17448 \begin_inset Flex Code
17451 \begin_layout Plain Layout
17458 \begin_inset Flex Code
17461 \begin_layout Plain Layout
17467 ] Whether the style requires the feature
17468 \begin_inset Flex Code
17471 \begin_layout Plain Layout
17478 \begin_inset CommandInset ref
17480 reference "chap:List-of-functions"
17484 for the list of features).
17485 If you require a package with specific options, you can additionally use
17487 \begin_inset Flex Code
17490 \begin_layout Plain Layout
17496 as a general text class parameter (see
17497 \begin_inset CommandInset ref
17499 reference "subsec:General-text-class"
17506 \begin_layout Description
17507 \begin_inset Flex Code
17510 \begin_layout Plain Layout
17517 \begin_inset Flex Code
17520 \begin_layout Plain Layout
17529 \begin_inset Flex Code
17532 \begin_layout Plain Layout
17538 ] Resets the \SpecialChar LaTeX
17539 arguments of this style (as defined via the
17540 \begin_inset Flex Code
17543 \begin_layout Plain Layout
17550 This is useful if you have copied a style via
17551 \begin_inset Flex Code
17554 \begin_layout Plain Layout
17560 , but you do not want to inherit its (required and optional) arguments.
17563 \begin_layout Description
17564 \begin_inset Flex Code
17567 \begin_layout Plain Layout
17574 \begin_inset Flex Code
17577 \begin_layout Plain Layout
17586 \begin_inset Flex Code
17589 \begin_layout Plain Layout
17595 ] Resumes a counter that is usually reset at each new sequence of layouts.
17596 This is currently only useful when
17597 \begin_inset Flex Code
17600 \begin_layout Plain Layout
17607 \begin_inset Flex Code
17610 \begin_layout Plain Layout
17619 \begin_layout Description
17620 \begin_inset Flex Code
17623 \begin_layout Plain Layout
17630 \begin_inset Flex Code
17633 \begin_layout Plain Layout
17639 ] A string that is put at the end of the layout content.
17640 A line break in the output can be indicated by
17641 \begin_inset Flex Code
17644 \begin_layout Plain Layout
17653 \begin_layout Description
17654 \begin_inset Flex Code
17657 \begin_layout Plain Layout
17664 \begin_inset Flex Code
17667 \begin_layout Plain Layout
17674 \begin_inset Flex Code
17677 \begin_layout Plain Layout
17686 \begin_layout Description
17687 \begin_inset Flex Code
17690 \begin_layout Plain Layout
17697 \begin_inset Flex Code
17700 \begin_layout Plain Layout
17709 \begin_inset Flex Code
17712 \begin_layout Plain Layout
17719 \begin_inset Flex Code
17722 \begin_layout Plain Layout
17729 \begin_inset Flex Code
17732 \begin_layout Plain Layout
17734 \begin_inset space ~
17742 ] This defines what the default spacing should be in the style.
17744 \begin_inset Flex Code
17747 \begin_layout Plain Layout
17754 \begin_inset Flex Code
17757 \begin_layout Plain Layout
17764 \begin_inset Flex Code
17767 \begin_layout Plain Layout
17773 correspond respectively to a multiplier value of 1, 1.25 and 1.667.
17774 If you specify the argument
17775 \begin_inset Flex Code
17778 \begin_layout Plain Layout
17784 , then you must also provide a value argument which will be the actual multiplie
17786 Note that, contrary to other parameters,
17787 \begin_inset Flex Code
17790 \begin_layout Plain Layout
17796 implies the generation of specific \SpecialChar LaTeX
17797 code, using the \SpecialChar LaTeX
17801 \begin_inset Flex Code
17804 \begin_layout Plain Layout
17813 \begin_layout Description
17814 \begin_inset Flex Code
17817 \begin_layout Plain Layout
17824 \begin_inset Flex Code
17827 \begin_layout Plain Layout
17834 \begin_inset space \thinspace{}
17838 \begin_inset Flex Code
17841 \begin_layout Plain Layout
17849 ] Allow spell-checking paragraphs of this style.
17853 \begin_layout Description
17854 \begin_inset Flex Code
17857 \begin_layout Plain Layout
17859 \change_deleted 731793113 1604355211
17861 \change_inserted 731793113 1604355212
17870 \begin_inset Flex Code
17873 \begin_layout Plain Layout
17882 \begin_inset Flex Code
17885 \begin_layout Plain Layout
17892 \change_deleted 731793113 1604355214
17894 \change_inserted 731793113 1604355216
17897 counter of a given counter at the beginning of a new sequence of layouts.
17898 This is currently only useful when
17899 \begin_inset Flex Code
17902 \begin_layout Plain Layout
17909 \begin_inset Flex Code
17912 \begin_layout Plain Layout
17921 \begin_layout Description
17922 \begin_inset Flex Code
17925 \begin_layout Plain Layout
17931 The font used for the text body .
17933 \begin_inset CommandInset ref
17935 reference "subsec:Font-description"
17942 \begin_layout Description
17943 \begin_inset Flex Code
17946 \begin_layout Plain Layout
17955 \begin_inset Flex Code
17958 \begin_layout Plain Layout
17968 The level of the style in the table of contents.
17969 This is used for automatic numbering of section headings.
17972 \begin_layout Description
17973 \begin_inset Flex Code
17976 \begin_layout Plain Layout
17985 \begin_inset Flex Code
17988 \begin_layout Plain Layout
17999 \begin_inset Flex Code
18002 \begin_layout Plain Layout
18009 \begin_inset Flex Code
18012 \begin_layout Plain Layout
18018 ] This tag determines whether the first line indentation of this paragraph
18019 can be toggled via the Paragraph settings dialog.
18023 \begin_inset Flex Code
18026 \begin_layout Plain Layout
18036 is set, indentation can be toggled if the document settings use
18037 \begin_inset Quotes eld
18041 \begin_inset Quotes erd
18044 paragraph style, with
18045 \begin_inset Flex Code
18048 \begin_layout Plain Layout
18054 , indentation can always be toggled, notwithstanding the document settings,
18056 \begin_inset Flex Code
18059 \begin_layout Plain Layout
18065 , indentation can never be toggled.
18068 \begin_layout Description
18069 \begin_inset Flex Code
18072 \begin_layout Plain Layout
18079 \begin_inset Flex Code
18082 \begin_layout Plain Layout
18088 ] The vertical space with which the very first of a chain of paragraphs
18089 with this style is separated from the previous paragraph.
18090 If the previous paragraph has another style, the separations are not simply
18091 added, but the maximum is taken.
18094 \begin_layout Subsection
18095 \begin_inset CommandInset label
18101 Internationalization of Paragraph Styles
18104 \begin_layout Standard
18106 has long supported internationalization of layout information, but, until
18107 version 2.0, this applied only to the user interface and not to, say, PDF
18109 Thus, French authors were forced to resort to ugly hacks if they wanted
18114 1' instead of `Theorem 1'.
18115 Thanks to Georg Baum, that is no longer the case.
18118 \begin_layout Standard
18120 \begin_inset Flex Code
18123 \begin_layout Plain Layout
18129 defines text that is to appear in the typeset document, it may use
18130 \begin_inset Flex Code
18133 \begin_layout Plain Layout
18140 \begin_inset Flex Code
18143 \begin_layout Plain Layout
18149 to support non-English and even multi-language documents correctly.
18150 The following excerpt (from the
18151 \begin_inset Flex Code
18154 \begin_layout Plain Layout
18160 file) shows how this works:
18163 \begin_layout LyX-Code
18168 \begin_layout LyX-Code
18171 theoremstyle{remark}
18174 \begin_layout LyX-Code
18177 newtheorem{claim}[thm]{
18184 \begin_layout LyX-Code
18188 \begin_layout LyX-Code
18192 \begin_layout LyX-Code
18197 claimname}{_(Claim)}
18200 \begin_layout LyX-Code
18204 \begin_layout LyX-Code
18208 \begin_layout LyX-Code
18217 claimname}{_(Claim)}}
18220 \begin_layout LyX-Code
18225 \begin_layout Standard
18226 In principle, any legal \SpecialChar LaTeX
18228 \begin_inset Flex Code
18231 \begin_layout Plain Layout
18238 \begin_inset Flex Code
18241 \begin_layout Plain Layout
18247 tags, but in practice they will typically look as they do here.
18248 The key to correct translation of the typeset text is the definition of
18249 the \SpecialChar LaTeX
18251 \begin_inset Flex Code
18254 \begin_layout Plain Layout
18263 \begin_inset Flex Code
18266 \begin_layout Plain Layout
18278 \begin_layout Standard
18280 \begin_inset Flex Code
18283 \begin_layout Plain Layout
18289 tag provides for internationalization based upon the overall language of
18291 The contents of the tag will be included in the preamble, just as with
18293 \begin_inset Flex Code
18296 \begin_layout Plain Layout
18303 What makes it special is the use of the
18304 \begin_inset Quotes eld
18308 \begin_inset Quotes erd
18312 \begin_inset Flex Code
18315 \begin_layout Plain Layout
18321 , which will be replaced, when \SpecialChar LyX
18322 produces \SpecialChar LaTeX
18323 output, with the translation of
18324 its argument into the document language.
18327 \begin_layout Standard
18329 \begin_inset Flex Code
18332 \begin_layout Plain Layout
18338 tag is more complex, since it is meant to provide support for multi-language
18339 documents and so offers an interface to the
18340 \begin_inset Flex Code
18343 \begin_layout Plain Layout
18350 Its contents will be added to the preamble once for each language that
18351 appears in the document.
18352 In this case, the argument to
18353 \begin_inset Flex Code
18356 \begin_layout Plain Layout
18362 will be replaced with its translation into the language in question; the
18364 \begin_inset Flex Code
18367 \begin_layout Plain Layout
18373 is replaced by the language name (as used by the babel package).
18376 \begin_layout Standard
18377 A German document that also included a French section would thus have the
18378 following in the preamble:
18381 \begin_layout LyX-Code
18390 claimname}{Affirmation}}
18391 \begin_inset Newline newline
18402 claimname}{Behauptung}}
18403 \begin_inset Newline newline
18410 claimname}{Behauptung}
18413 \begin_layout Standard
18416 \begin_inset Flex Code
18419 \begin_layout Plain Layout
18425 will then conspire to produce the correct text in the output.
18428 \begin_layout Standard
18429 One important point to note here is that the translations are provided by
18431 itself, through the file
18432 \begin_inset Flex Code
18435 \begin_layout Plain Layout
18442 This means, in effect, that
18443 \begin_inset Flex Code
18446 \begin_layout Plain Layout
18453 \begin_inset Flex Code
18456 \begin_layout Plain Layout
18462 are really only of use in layout files that are provided with \SpecialChar LyX
18464 entered in user-created layout files will not be seen by \SpecialChar LyX
18465 's internationalizatio
18466 n routines unless the
18467 \begin_inset Flex Code
18470 \begin_layout Plain Layout
18476 file is modified accordingly.
18477 That said, however, any layout created with the intention that it will
18478 be included with \SpecialChar LyX
18479 should use these tags where appropriate.
18480 Please note that the paragraph style translations provided by \SpecialChar LyX
18482 change with a minor update (e.
18483 \begin_inset space \thinspace{}
18487 \begin_inset space \space{}
18490 from version 2.1.x to 2.1.y).
18491 It is however quite likely that a major update (e.
18492 \begin_inset space \thinspace{}
18496 \begin_inset space \space{}
18499 from 2.0.x to 2.1.0) will introduce new translations or corrections.
18502 \begin_layout Subsection
18504 \begin_inset CommandInset label
18506 name "subsec:Floats"
18513 \begin_layout Standard
18514 It is necessary to define the floats (
18515 \begin_inset Flex Noun
18518 \begin_layout Plain Layout
18525 \begin_inset Flex Noun
18528 \begin_layout Plain Layout
18534 , \SpecialChar ldots
18535 ) in the text class itself.
18536 Standard floats are included in the file
18537 \begin_inset Flex Code
18540 \begin_layout Plain Layout
18546 , so you may have to do no more than add
18549 \begin_layout LyX-Code
18550 Input stdfloats.inc
18553 \begin_layout Standard
18554 to your layout file.
18555 If you want to implement a text class that proposes some other float types
18556 (like the AGU class bundled with \SpecialChar LyX
18557 ), the information below will hopefully
18561 \begin_layout Description
18562 \begin_inset Flex Code
18565 \begin_layout Plain Layout
18572 \begin_inset Flex Code
18575 \begin_layout Plain Layout
18581 =!htbpH] Allowed placement options for this float type.
18582 The value is a string of placement characters.
18583 Possible characters include:
18588 \begin_inset Quotes eld
18592 \begin_inset Quotes erd
18600 \begin_inset Quotes eld
18604 \begin_inset Quotes erd
18612 \begin_inset Quotes eld
18616 \begin_inset Quotes erd
18624 \begin_inset Quotes eld
18628 \begin_inset Quotes erd
18636 \begin_inset Quotes eld
18640 \begin_inset Quotes erd
18648 \begin_inset Quotes eld
18652 \begin_inset Quotes erd
18656 The order of the characters in the string does not matter.
18657 If no placement options are allowed, use the string
18664 \begin_layout Description
18665 \begin_inset Flex Code
18668 \begin_layout Plain Layout
18675 \begin_inset Flex Code
18678 \begin_layout Plain Layout
18687 \begin_inset space \thinspace{}
18693 \begin_inset Flex Code
18696 \begin_layout Plain Layout
18706 ] Defines whether the float allows to be rotated via the \SpecialChar LaTeX
18713 \begin_inset Flex Code
18716 \begin_layout Plain Layout
18722 if the float does not support this feature.
18725 \begin_layout Description
18726 \begin_inset Flex Code
18729 \begin_layout Plain Layout
18736 \begin_inset Flex Code
18739 \begin_layout Plain Layout
18748 \begin_inset space \thinspace{}
18754 \begin_inset Flex Code
18757 \begin_layout Plain Layout
18767 ] Defines whether the float has a starred variant that spans columns in
18768 a two column paragraph.
18770 \begin_inset Flex Code
18773 \begin_layout Plain Layout
18779 if the float does not support this feature.
18782 \begin_layout Description
18783 \begin_inset Flex Code
18786 \begin_layout Plain Layout
18793 \begin_inset Flex Code
18796 \begin_layout Plain Layout
18803 \begin_inset Quotes erd
18807 \begin_inset Quotes erd
18810 ] The file name extension of an auxiliary file for the list of figures (or
18813 writes the captions to this file.
18816 \begin_layout Description
18817 \begin_inset Flex Code
18820 \begin_layout Plain Layout
18827 \begin_inset Flex Code
18830 \begin_layout Plain Layout
18837 \begin_inset Quotes erd
18841 \begin_inset Quotes erd
18844 ] The string that will be used in the menus and also for the caption.
18845 This is translated to the current language if babel is used.
18848 \begin_layout Description
18849 \begin_inset Flex Code
18852 \begin_layout Plain Layout
18858 These tags control the XHTML output.
18860 \begin_inset CommandInset ref
18862 reference "sec:Tags-for-XHTML"
18869 \begin_layout Description
18870 \begin_inset Flex Code
18873 \begin_layout Plain Layout
18882 \begin_inset Flex Code
18885 \begin_layout Plain Layout
18894 \begin_inset space \thinspace{}
18898 \begin_inset Flex Code
18901 \begin_layout Plain Layout
18907 ] Indicates whether the float is already defined in the document class or
18908 if instead the \SpecialChar LaTeX
18910 \begin_inset Flex Code
18913 \begin_layout Plain Layout
18919 needs to be loaded to define it on-the-fly.
18921 \begin_inset Flex Code
18924 \begin_layout Plain Layout
18931 \begin_inset Flex Code
18934 \begin_layout Plain Layout
18941 It should be set to
18942 \begin_inset Flex Code
18945 \begin_layout Plain Layout
18951 if the float is already defined by the \SpecialChar LaTeX
18955 \begin_layout Description
18956 \begin_inset Flex Code
18959 \begin_layout Plain Layout
18966 \begin_inset Flex Code
18969 \begin_layout Plain Layout
18976 \begin_inset Quotes erd
18980 \begin_inset Quotes erd
18983 ] The command used to generate a list of floats of this type; the leading
18992 \begin_inset Flex Code
18995 \begin_layout Plain Layout
19001 is false, since there is no standard way to generate this command.
19003 \begin_inset Flex Code
19006 \begin_layout Plain Layout
19012 is true, since in that case there is a standard way to define the command.
19015 \begin_layout Description
19016 \begin_inset Flex Code
19019 \begin_layout Plain Layout
19026 \begin_inset Flex Code
19029 \begin_layout Plain Layout
19036 \begin_inset Quotes erd
19040 \begin_inset Quotes erd
19043 ] A title for a list of floats of this kind (list of figures, tables, or
19045 It is used for the screen label within \SpecialChar LyX
19046 , it is used by \SpecialChar LaTeX
19048 it is used as the title in the XHTML output.
19049 It will be translated to the document language.
19052 \begin_layout Description
19053 \begin_inset Flex Code
19056 \begin_layout Plain Layout
19063 \begin_inset Flex Code
19066 \begin_layout Plain Layout
19073 \begin_inset Quotes erd
19077 \begin_inset Quotes erd
19080 ] This (optional) argument determines whether floats of this class will
19081 be numbered within some sectional unit of the document.
19083 \begin_inset Flex Code
19086 \begin_layout Plain Layout
19093 \begin_inset Quotes eld
19097 \begin_inset Flex Code
19100 \begin_layout Plain Layout
19107 \begin_inset Quotes erd
19110 , the floats will be numbered within chapters.
19114 \begin_layout Description
19115 \begin_inset Flex Code
19118 \begin_layout Plain Layout
19125 \begin_inset Flex Code
19128 \begin_layout Plain Layout
19135 \begin_inset Quotes erd
19139 \begin_inset Quotes erd
19142 ] The default placement for the given class of floats.
19143 The string should be as in standard \SpecialChar LaTeX
19145 \begin_inset Flex Code
19148 \begin_layout Plain Layout
19155 \begin_inset Flex Code
19158 \begin_layout Plain Layout
19165 \begin_inset Flex Code
19168 \begin_layout Plain Layout
19175 \begin_inset Flex Code
19178 \begin_layout Plain Layout
19184 for top, bottom, page, and here, respectively.
19188 \begin_layout Plain Layout
19189 Note that the order of these letters in the string is irrelevant, like in
19196 On top of that there is a new type,
19197 \begin_inset Flex Code
19200 \begin_layout Plain Layout
19206 , which does not really correspond to a float, since it means: put it
19207 \begin_inset Quotes eld
19211 \begin_inset Quotes erd
19215 Note however that the
19216 \begin_inset Flex Code
19219 \begin_layout Plain Layout
19225 specifier is special and, because of implementation details, cannot be
19226 used in non-built in float types.
19227 If you do not understand what this means, just use
19228 \begin_inset Quotes eld
19232 \begin_inset Flex Code
19235 \begin_layout Plain Layout
19242 \begin_inset Quotes erd
19248 \begin_layout Description
19249 \begin_inset Flex Code
19252 \begin_layout Plain Layout
19259 \begin_inset Flex Code
19262 \begin_layout Plain Layout
19268 ] The prefix to use when creating labels referring to floats of this type.
19269 This allows the use of formatted references.
19270 Note that you can remove any
19271 \begin_inset Flex Code
19274 \begin_layout Plain Layout
19280 set by a copied style by using the special value
19281 \begin_inset Quotes eld
19285 \begin_inset Quotes erd
19288 , which must be all caps.
19289 \change_inserted -712698321 1565605014
19293 \begin_layout Description
19295 \change_inserted -712698321 1565605014
19296 \begin_inset Flex Code
19299 \begin_layout Plain Layout
19301 \change_inserted -712698321 1565605014
19310 \begin_inset Flex Code
19313 \begin_layout Plain Layout
19315 \change_inserted -712698321 1565605014
19323 ] As with paragraph styles, see
19324 \begin_inset CommandInset ref
19326 reference "subsec:Paragraph-Styles"
19335 \begin_layout Description
19336 \begin_inset Flex Code
19339 \begin_layout Plain Layout
19346 \begin_inset Flex Code
19349 \begin_layout Plain Layout
19356 \begin_inset Quotes erd
19360 \begin_inset Quotes erd
19363 ] The style used when defining the float using
19364 \begin_inset Flex Code
19367 \begin_layout Plain Layout
19378 \begin_layout Description
19379 \begin_inset Flex Code
19382 \begin_layout Plain Layout
19389 \begin_inset Flex Code
19392 \begin_layout Plain Layout
19399 \begin_inset Quotes erd
19403 \begin_inset Quotes erd
19407 \begin_inset Quotes eld
19411 \begin_inset Quotes erd
19414 of the new class of floats, like program or algorithm.
19415 After the appropriate
19416 \begin_inset Flex Code
19419 \begin_layout Plain Layout
19428 \begin_inset Flex Code
19431 \begin_layout Plain Layout
19440 \begin_inset Flex Code
19443 \begin_layout Plain Layout
19454 \begin_layout Description
19455 \begin_inset Flex Code
19458 \begin_layout Plain Layout
19465 \begin_inset Flex Code
19468 \begin_layout Plain Layout
19475 \begin_inset space \thinspace{}
19479 \begin_inset Flex Code
19482 \begin_layout Plain Layout
19490 ] Specifies whether this float is defined using the \SpecialChar LaTeX
19492 \begin_inset Flex Code
19495 \begin_layout Plain Layout
19501 , either by the class file, another package or on-the-fly by \SpecialChar LyX
19505 \begin_layout Standard
19506 Note that defining a float with type
19507 \begin_inset Flex Code
19510 \begin_layout Plain Layout
19518 automatically defines the corresponding counter with name
19519 \begin_inset Flex Code
19522 \begin_layout Plain Layout
19533 \begin_layout Subsection
19534 Flex insets and InsetLayout
19535 \begin_inset CommandInset label
19537 name "subsec:Flex-insets-and"
19544 \begin_layout Standard
19545 Flex insets come in
19546 \change_deleted 5863208 1594239511
19548 \change_inserted 5863208 1594239512
19554 \begin_layout Itemize
19556 \begin_inset Flex Code
19559 \begin_layout Plain Layout
19565 ): These define semantic markup corresponding to such \SpecialChar LaTeX
19567 \begin_inset Flex Code
19570 \begin_layout Plain Layout
19579 \begin_inset Flex Code
19582 \begin_layout Plain Layout
19593 \begin_layout Itemize
19595 \begin_inset Flex Code
19598 \begin_layout Plain Layout
19604 ): These can be used to define custom collapsible insets, similar to \SpecialChar TeX
19606 footnote, and the like.
19607 An obvious example is an endnote inset, which is defined in the
19608 \begin_inset Flex Code
19611 \begin_layout Plain Layout
19620 \begin_layout Itemize
19622 \change_deleted 5863208 1594239528
19624 \begin_inset Flex Code
19627 \begin_layout Plain Layout
19633 ): For use with DocBook classes.
19638 \begin_layout Standard
19639 Flex insets are defined using the
19640 \begin_inset Flex Code
19643 \begin_layout Plain Layout
19649 tag, which shall be explained in a moment.
19652 \begin_layout Standard
19654 \begin_inset Flex Code
19657 \begin_layout Plain Layout
19663 tag also serves another function: It can be used to customize the general
19664 layout of many different types of insets.
19666 \begin_inset Flex Code
19669 \begin_layout Plain Layout
19675 can be used to customize the layout parameters for footnotes, marginal
19676 notes, note insets, \SpecialChar TeX
19677 code (ERT) insets, branches, listings, indexes, boxes,
19678 tables, algorithms, URLs, and captions, as well as to define Flex insets.
19681 \begin_layout Standard
19683 \begin_inset Flex Code
19686 \begin_layout Plain Layout
19692 definition must begin with a line of the form:
19695 \begin_layout LyX-Code
19699 \begin_layout Standard
19701 \begin_inset Flex Code
19704 \begin_layout Plain Layout
19710 indicates the inset whose layout is being defined, and here there are four
19714 \begin_layout Enumerate
19715 The layout for a pre-existing inset is being modified.
19716 In this case, can be
19717 \begin_inset Flex Code
19720 \begin_layout Plain Layout
19726 any one of the following:
19727 \begin_inset Flex Code
19730 \begin_layout Plain Layout
19737 \begin_inset Flex Code
19740 \begin_layout Plain Layout
19747 \begin_inset Flex Code
19750 \begin_layout Plain Layout
19757 \begin_inset Flex Code
19760 \begin_layout Plain Layout
19767 \begin_inset Flex Code
19770 \begin_layout Plain Layout
19777 \begin_inset Flex Code
19780 \begin_layout Plain Layout
19787 \begin_inset Flex Code
19790 \begin_layout Plain Layout
19797 \begin_inset Flex Code
19800 \begin_layout Plain Layout
19807 \begin_inset Flex Code
19810 \begin_layout Plain Layout
19817 \begin_inset Flex Code
19820 \begin_layout Plain Layout
19827 \begin_inset Flex Code
19830 \begin_layout Plain Layout
19837 \begin_inset Flex Code
19840 \begin_layout Plain Layout
19847 \begin_inset Flex Code
19850 \begin_layout Plain Layout
19857 \begin_inset Flex Code
19860 \begin_layout Plain Layout
19867 \begin_inset Flex Code
19870 \begin_layout Plain Layout
19877 \begin_inset Flex Code
19880 \begin_layout Plain Layout
19887 \begin_inset Flex Code
19890 \begin_layout Plain Layout
19897 \begin_inset Flex Code
19900 \begin_layout Plain Layout
19907 \begin_inset Flex Code
19910 \begin_layout Plain Layout
19917 \begin_inset Flex Code
19920 \begin_layout Plain Layout
19929 \begin_layout Enumerate
19930 The layout for a Flex inset is being defined.
19932 \begin_inset Flex Code
19935 \begin_layout Plain Layout
19941 must be of the form
19942 \begin_inset Quotes eld
19946 \begin_inset Flex Code
19949 \begin_layout Plain Layout
19956 \begin_inset Quotes erd
19960 \begin_inset Flex Code
19963 \begin_layout Plain Layout
19969 may be any valid identifier not used by a pre-existing Flex inset.
19970 The identifier may include spaces, but in that case the whole thing must
19971 be wrapped in quotes.
19972 Note that the definition of a flex inset
19977 \begin_inset Flex Code
19980 \begin_layout Plain Layout
19986 entry, declaring which type of inset it defines.
19989 \begin_layout Enumerate
19990 The layout for user specific branch is being defined.
19992 \begin_inset Flex Code
19995 \begin_layout Plain Layout
20001 must be of the form
20002 \begin_inset Quotes eld
20006 \begin_inset Flex Code
20009 \begin_layout Plain Layout
20016 \begin_inset Quotes erd
20020 \begin_inset Flex Code
20023 \begin_layout Plain Layout
20029 may be any valid identifier of branch defined in user's document.
20030 The identifier may include spaces, but in that case the whole thing must
20031 be wrapped in quotes.
20032 The main purpose of this feature is to allow \SpecialChar LaTeX
20033 wrapping around specific
20034 branches as user needs.
20037 \begin_layout Enumerate
20038 The layout of a user (or class) specific caption is being defined.
20040 \begin_inset Flex Code
20043 \begin_layout Plain Layout
20049 must be of the form
20050 \begin_inset Quotes eld
20054 \begin_inset Flex Code
20057 \begin_layout Plain Layout
20064 \begin_inset Quotes erd
20068 \begin_inset Flex Code
20071 \begin_layout Plain Layout
20077 specifies the name of the caption as it appears in the menu.
20078 Have a look at the standard caption (
20079 \begin_inset Flex Code
20082 \begin_layout Plain Layout
20088 ), the specific captions of the KOMA-Script classes (
20089 \begin_inset Flex Code
20092 \begin_layout Plain Layout
20099 \begin_inset Flex Code
20102 \begin_layout Plain Layout
20111 \begin_inset space ~
20115 \begin_inset Newline linebreak
20121 \begin_inset Flex Code
20124 \begin_layout Plain Layout
20130 ) for applications.
20133 \begin_layout Standard
20135 \begin_inset Flex Code
20138 \begin_layout Plain Layout
20144 definition can contain the following entries:
20147 \begin_layout Description
20148 \begin_inset Flex Code
20151 \begin_layout Plain Layout
20158 \begin_inset Flex Code
20161 \begin_layout Plain Layout
20167 =""] This inset will appear in the table of contents of the given type.
20168 An empty string disables.
20169 See also the OutlinerName and the IsTocCaption commands.
20170 This is only implemented for Flex insets.
20174 \begin_layout Description
20175 \begin_inset Flex Code
20178 \begin_layout Plain Layout
20185 \begin_inset Flex Code
20188 \begin_layout Plain Layout
20194 ] Defines argument number of a command\SpecialChar breakableslash
20195 environment associated with the current
20197 The definition must end with
20198 \begin_inset Flex Code
20201 \begin_layout Plain Layout
20209 \change_inserted -584632292 1615846847
20211 \begin_inset CommandInset ref
20213 reference "subsec:Arguments"
20221 \change_deleted -584632292 1615846847
20223 \begin_inset CommandInset ref
20225 reference "subsec:Paragraph-Styles"
20232 \change_deleted -584632292 1615846902
20234 \change_inserted -584632292 1615846906
20240 \begin_layout Description
20241 \begin_inset Flex Code
20244 \begin_layout Plain Layout
20250 Preamble for changing language commands; see
20251 \begin_inset CommandInset ref
20253 reference "subsec:I18n"
20260 \begin_layout Description
20261 \begin_inset Flex Code
20264 \begin_layout Plain Layout
20271 \begin_inset Flex Code
20274 \begin_layout Plain Layout
20280 ] The color for the inset's background.
20282 \begin_inset CommandInset ref
20284 reference "chap:Names-of-colors"
20288 for a list of the available color names.
20291 \begin_layout Description
20292 \begin_inset Flex Code
20295 \begin_layout Plain Layout
20302 \begin_inset Flex Code
20305 \begin_layout Plain Layout
20314 \begin_inset space \thinspace{}
20318 \begin_inset Flex Code
20321 \begin_layout Plain Layout
20327 ] Whether to use the content of the inset as the label, when the inset is
20332 \begin_layout Description
20333 \begin_inset Flex Code
20336 \begin_layout Plain Layout
20343 \begin_inset Flex Code
20346 \begin_layout Plain Layout
20352 ] As with paragraph styles, see
20353 \begin_inset CommandInset ref
20355 reference "subsec:Paragraph-Styles"
20360 Note that you need to specify the complete type, e.
20361 \begin_inset space \thinspace{}
20365 \begin_inset space ~
20369 \begin_inset Flex Code
20372 \begin_layout Plain Layout
20373 CopyStyle Flex:<name>
20381 \begin_layout Description
20382 \begin_inset Flex Code
20385 \begin_layout Plain Layout
20392 \begin_inset Flex Code
20395 \begin_layout Plain Layout
20404 \begin_inset space \thinspace{}
20408 \begin_inset Flex Code
20411 \begin_layout Plain Layout
20417 ] Indicates whether the user may employ the Paragraph Settings dialog to
20418 customize the paragraph.
20421 \begin_layout Description
20422 \begin_inset Flex Code
20425 \begin_layout Plain Layout
20432 \begin_inset Flex Code
20435 \begin_layout Plain Layout
20442 \begin_inset Flex Code
20445 \begin_layout Plain Layout
20452 \begin_inset Flex Code
20455 \begin_layout Plain Layout
20461 , describing the rendering style used for the inset's frame and buttons.
20462 Footnotes generally use
20463 \begin_inset Flex Code
20466 \begin_layout Plain Layout
20472 , ERT insets generally
20473 \begin_inset Flex Code
20476 \begin_layout Plain Layout
20482 , and character styles
20483 \begin_inset Flex Code
20486 \begin_layout Plain Layout
20495 \begin_layout Description
20496 \begin_inset Flex Code
20499 \begin_layout Plain Layout
20506 \begin_inset Flex Code
20509 \begin_layout Plain Layout
20518 \begin_inset space \thinspace{}
20524 \begin_inset Flex Code
20527 \begin_layout Plain Layout
20536 \begin_inset Flex Code
20539 \begin_layout Plain Layout
20546 \begin_inset Flex Code
20549 \begin_layout Plain Layout
20556 Indicates whether the environment will stand on its own in the output or
20557 will appear inline with the surrounding text.
20558 If set to false, it is supposed that the \SpecialChar LaTeX
20559 environment ignores white space
20560 (including one newline character) after the
20561 \begin_inset Flex Code
20564 \begin_layout Plain Layout
20577 \begin_inset Flex Code
20580 \begin_layout Plain Layout
20594 \change_inserted 731793113 1538674858
20598 \begin_layout Description
20600 \change_inserted 731793113 1538674891
20601 \begin_inset Flex Code
20604 \begin_layout Plain Layout
20606 \change_inserted 731793113 1538674863
20618 ,1] Allow the contents of the inset to be edited externally (using whatever
20619 editor is defined for the document's output format).
20624 \begin_layout Description
20625 \begin_inset Flex Code
20628 \begin_layout Plain Layout
20634 Required at the end of the
20635 \begin_inset Flex Code
20638 \begin_layout Plain Layout
20647 \begin_layout Description
20648 \begin_inset Flex Code
20651 \begin_layout Plain Layout
20657 The font used for both the text body
20663 \begin_inset CommandInset ref
20665 reference "subsec:Font-description"
20670 Note that defining this font automatically defines the
20671 \begin_inset Flex Code
20674 \begin_layout Plain Layout
20680 to the same value, so define this first and define
20681 \begin_inset Flex Code
20684 \begin_layout Plain Layout
20690 later if you want them to be different.
20693 \begin_layout Description
20694 \begin_inset Flex Code
20697 \begin_layout Plain Layout
20698 FixedWidthPreambleEncoding
20704 \begin_inset Flex Code
20707 \begin_layout Plain Layout
20716 \begin_inset space \thinspace{}
20720 \begin_inset Flex Code
20723 \begin_layout Plain Layout
20729 ] Force a fixed width encoding for the translated contents of
20730 \begin_inset Flex Code
20733 \begin_layout Plain Layout
20740 \begin_inset Flex Code
20743 \begin_layout Plain Layout
20749 code generated by this layout.
20750 This is needed for special \SpecialChar LaTeX
20755 that do not work with variable width encodings such as
20760 This setting is ignored if fully Unicode aware \SpecialChar LaTeX
20761 backends such as Xe\SpecialChar TeX
20763 Lua\SpecialChar TeX
20767 \begin_layout Description
20768 \begin_inset Flex Code
20771 \begin_layout Plain Layout
20772 ForceLocalFontSwitch
20778 \begin_inset Flex Code
20781 \begin_layout Plain Layout
20790 \begin_inset space \thinspace{}
20794 \begin_inset Flex Code
20797 \begin_layout Plain Layout
20803 ] When using babel, always use a local font switch (
20804 \begin_inset Flex Code
20807 \begin_layout Plain Layout
20815 ), never a global one (such as
20816 \begin_inset Flex Code
20819 \begin_layout Plain Layout
20830 \begin_layout Description
20831 \begin_inset Flex Code
20834 \begin_layout Plain Layout
20841 \begin_inset Flex Code
20844 \begin_layout Plain Layout
20853 \begin_inset space \thinspace{}
20857 \begin_inset Flex Code
20860 \begin_layout Plain Layout
20867 \begin_inset Quotes eld
20871 \begin_inset Quotes erd
20874 language, leading to Left-to-Right (Latin) output, e.
20875 \begin_inset space \thinspace{}
20879 \begin_inset space \space{}
20882 in \SpecialChar TeX
20887 \begin_layout Description
20888 \begin_inset Flex Code
20891 \begin_layout Plain Layout
20898 \begin_inset Flex Code
20901 \begin_layout Plain Layout
20910 \begin_inset space \thinspace{}
20914 \begin_inset Flex Code
20917 \begin_layout Plain Layout
20923 ] Force a line break in the \SpecialChar LaTeX
20924 output before the inset starts and after the
20926 This assures the inset itself is output on its own lines, for parsing purposes.
20929 \begin_layout Description
20930 \begin_inset Flex Code
20933 \begin_layout Plain Layout
20940 \begin_inset Flex Code
20943 \begin_layout Plain Layout
20952 \begin_inset space \thinspace{}
20956 \begin_inset Flex Code
20959 \begin_layout Plain Layout
20965 ] Indicates whether the
20966 \begin_inset Flex Code
20969 \begin_layout Plain Layout
20975 should be used or, instead, the user can change the paragraph style used
20980 \begin_layout Description
20981 \begin_inset Flex Code
20984 \begin_layout Plain Layout
20991 \begin_inset Flex Code
20994 \begin_layout Plain Layout
21003 \begin_inset space \thinspace{}
21007 \begin_inset Flex Code
21010 \begin_layout Plain Layout
21016 ] As with paragraph styles, see
21017 \begin_inset CommandInset ref
21019 reference "subsec:Paragraph-Styles"
21026 \begin_layout Description
21027 \begin_inset Flex Code
21030 \begin_layout Plain Layout
21036 These tags control the XHTML output.
21038 \begin_inset CommandInset ref
21040 reference "sec:Tags-for-XHTML"
21047 \begin_layout Description
21048 \begin_inset Flex Code
21051 \begin_layout Plain Layout
21058 \begin_inset Flex Code
21061 \begin_layout Plain Layout
21070 \begin_inset space \thinspace{}
21074 \begin_inset Flex Code
21077 \begin_layout Plain Layout
21083 ] Whether to include the contents of this inset in the strings generated
21084 for the `Outline' pane for all table of contents, regardless of the AddToToc
21086 One would not, for example, want the content of a footnote in a section
21087 header to be included in the TOC displayed in the outline, but one would
21088 normally want the content of a character style displayed.
21089 Default is false: not to include.
21092 \begin_layout Description
21093 \begin_inset Flex Code
21096 \begin_layout Plain Layout
21103 \begin_inset Flex Code
21106 \begin_layout Plain Layout
21115 \begin_inset space \thinspace{}
21119 \begin_inset Flex Code
21122 \begin_layout Plain Layout
21128 ] If this is set to 1 and AddToToc is enabled, the inset adds a summary
21129 of its contents in its item in the table of contents.
21130 Otherwise, only the label appears.
21133 \begin_layout Description
21134 \begin_inset Flex Code
21137 \begin_layout Plain Layout
21146 \begin_inset Flex Code
21149 \begin_layout Plain Layout
21158 \begin_inset space \thinspace{}
21162 \begin_inset Flex Code
21165 \begin_layout Plain Layout
21171 ] As with paragraph styles, see
21172 \begin_inset CommandInset ref
21174 reference "subsec:Paragraph-Styles"
21181 \begin_layout Description
21182 \begin_inset Flex Code
21185 \begin_layout Plain Layout
21191 The font used for the label.
21193 \begin_inset CommandInset ref
21195 reference "subsec:Font-description"
21200 Note that this definition can never appear before
21201 \begin_inset Flex Code
21204 \begin_layout Plain Layout
21210 , lest it be ineffective.
21213 \begin_layout Description
21214 \begin_inset Flex Code
21217 \begin_layout Plain Layout
21224 \begin_inset Flex Code
21227 \begin_layout Plain Layout
21234 \begin_inset Quotes erd
21238 \begin_inset Quotes erd
21241 ] What will be displayed on the button or elsewhere as the inset label.
21243 \begin_inset Flex Code
21246 \begin_layout Plain Layout
21254 \begin_inset Flex Code
21257 \begin_layout Plain Layout
21263 ) modify this label on the fly.
21266 \begin_layout Description
21267 \begin_inset Flex Code
21270 \begin_layout Plain Layout
21276 Language dependent preamble; see
21277 \begin_inset CommandInset ref
21279 reference "subsec:I18n"
21286 \begin_layout Description
21287 \begin_inset Flex Code
21290 \begin_layout Plain Layout
21297 \begin_inset Flex Code
21300 \begin_layout Plain Layout
21306 ] The name of the corresponding \SpecialChar LaTeX
21308 Either the environment or command name.
21311 \begin_layout Description
21312 \begin_inset Flex Code
21315 \begin_layout Plain Layout
21322 \begin_inset Flex Code
21325 \begin_layout Plain Layout
21331 ] The optional parameter for the corresponding
21332 \begin_inset Flex Code
21335 \begin_layout Plain Layout
21341 stuff, including possible bracket pairs like
21342 \begin_inset Flex Code
21345 \begin_layout Plain Layout
21352 This parameter cannot be changed from within \SpecialChar LyX
21354 \begin_inset Flex Code
21357 \begin_layout Plain Layout
21363 for customizable parameters).
21364 It will be output as is after all \SpecialChar LaTeX
21366 \begin_inset Flex Code
21369 \begin_layout Plain Layout
21378 \begin_layout Description
21379 \begin_inset Flex Code
21382 \begin_layout Plain Layout
21389 \begin_inset Flex Code
21392 \begin_layout Plain Layout
21393 Command, Environment, None
21398 ] How the style should be translated into \SpecialChar LaTeX
21403 \begin_layout Plain Layout
21404 \begin_inset Flex Code
21407 \begin_layout Plain Layout
21413 is perhaps a bit misleading, since these rules apply to SGML classes too.
21414 Visit the SGML class files for specific examples.
21423 \begin_layout Description
21424 \begin_inset Flex Code
21427 \begin_layout Plain Layout
21433 means nothing special
21436 \begin_layout Description
21437 \begin_inset Flex Code
21440 \begin_layout Plain Layout
21447 \begin_inset Flex Code
21450 \begin_layout Plain Layout
21457 {\SpecialChar ldots
21466 \begin_layout Description
21467 \begin_inset Flex Code
21470 \begin_layout Plain Layout
21477 \begin_inset Flex Code
21480 \begin_layout Plain Layout
21487 }\SpecialChar ldots
21502 \begin_layout Standard
21503 Putting the last few things together, the \SpecialChar LaTeX
21504 output will be either:
21507 \begin_layout LyX-Code
21510 LatexName[LatexParam]{\SpecialChar ldots
21514 \begin_layout Standard
21518 \begin_layout LyX-Code
21521 begin{LatexName}[LatexParam] \SpecialChar ldots
21527 \begin_layout Standard
21528 depending upon the \SpecialChar LaTeX
21533 \begin_layout Description
21534 \begin_inset Flex Code
21537 \begin_layout Plain Layout
21544 \begin_inset Flex Code
21547 \begin_layout Plain Layout
21553 ] A string that is put at the beginning of the layout content.
21554 A line break in the output can be indicated by
21555 \begin_inset Flex Code
21558 \begin_layout Plain Layout
21567 \begin_layout Description
21568 \begin_inset Flex Code
21571 \begin_layout Plain Layout
21578 \begin_inset Flex Code
21581 \begin_layout Plain Layout
21588 \begin_inset Flex Code
21591 \begin_layout Plain Layout
21598 \change_deleted -584632292 1615846609
21600 \begin_inset Flex Code
21603 \begin_layout Plain Layout
21612 \begin_inset Flex Code
21615 \begin_layout Plain Layout
21621 (indicating a dummy definition ending definitions of charstyles, etc).
21622 This entry is required in and is only meaningful for Flex insets.
21623 Among other things, it determines on which menu this inset will appear.
21625 \begin_inset Flex Code
21628 \begin_layout Plain Layout
21635 \begin_inset Flex Code
21638 \begin_layout Plain Layout
21644 will automatically set
21645 \begin_inset Flex Code
21648 \begin_layout Plain Layout
21655 \begin_inset Flex Code
21658 \begin_layout Plain Layout
21666 \begin_inset Flex Code
21669 \begin_layout Plain Layout
21675 can be set to true, or
21676 \begin_inset Flex Code
21679 \begin_layout Plain Layout
21686 \begin_inset Flex Code
21689 \begin_layout Plain Layout
21695 insets by setting it
21700 \begin_inset Flex Code
21703 \begin_layout Plain Layout
21710 \change_inserted -712698321 1555575738
21714 \begin_layout Description
21716 \change_inserted -712698321 1555575844
21717 \begin_inset Flex Code
21720 \begin_layout Plain Layout
21722 \change_inserted -712698321 1555575740
21731 \begin_inset Flex Code
21734 \begin_layout Plain Layout
21736 \change_inserted -712698321 1555575740
21744 A dedicated string for the menu.
21745 You can define an accelerator by appending the respective character to
21746 the string, divided by
21747 \begin_inset Quotes eld
21751 \begin_inset Quotes erd
21755 \begin_inset space \thinspace{}
21759 \begin_inset space \space{}
21763 \begin_inset Quotes eld
21767 \begin_inset Flex Code
21770 \begin_layout Plain Layout
21772 \change_inserted -712698321 1555575781
21781 \begin_inset Quotes erd
21785 This specification is optional.
21786 If it is not given the inset name as specified in the type declaration
21787 will be used instead for the menu.
21792 \begin_layout Description
21793 \begin_inset Flex Code
21796 \begin_layout Plain Layout
21803 \begin_inset Flex Code
21806 \begin_layout Plain Layout
21815 \begin_inset space \thinspace{}
21819 \begin_inset Flex Code
21822 \begin_layout Plain Layout
21828 ] Whether multiple paragraphs are permitted in this inset.
21830 \begin_inset Flex Code
21833 \begin_layout Plain Layout
21839 to the same value and
21840 \begin_inset Flex Code
21843 \begin_layout Plain Layout
21849 to the opposite value.
21850 These can be reset to other values, if they are used
21855 \begin_inset Flex Code
21858 \begin_layout Plain Layout
21868 \begin_layout Description
21869 \begin_inset Flex Code
21872 \begin_layout Plain Layout
21879 \begin_inset Flex Code
21882 \begin_layout Plain Layout
21891 \begin_inset space \thinspace{}
21895 \begin_inset Flex Code
21898 \begin_layout Plain Layout
21904 ] Whether fragile commands in this inset should be
21905 \begin_inset Flex Code
21908 \begin_layout Plain Layout
21921 whether the command should itself be protected.) Default is false.
21922 \change_inserted -712698321 1523633958
21926 \begin_layout Description
21928 \change_inserted -712698321 1552395786
21929 \begin_inset Flex Code
21932 \begin_layout Plain Layout
21934 \change_inserted -712698321 1523633961
21943 \begin_inset Flex Code
21946 \begin_layout Plain Layout
21948 \change_inserted -712698321 1523633958
21959 \begin_inset space \thinspace{}
21963 \begin_inset Flex Code
21966 \begin_layout Plain Layout
21968 \change_inserted -712698321 1523633958
21976 ] This causes macros that contain this inset to be protected with
21977 \begin_inset Flex Code
21980 \begin_layout Plain Layout
21982 \change_inserted -712698321 1523634038
21997 ) if necessary and thus allows (some) verbatim stuff in macros.
22001 \begin_layout Description
22003 \change_inserted -712698321 1555579651
22004 \begin_inset Flex Code
22007 \begin_layout Plain Layout
22009 \change_inserted -712698321 1552395787
22018 \begin_inset Flex Code
22021 \begin_layout Plain Layout
22023 \change_inserted -712698321 1552395787
22034 \begin_inset space \thinspace{}
22038 \begin_inset Flex Code
22041 \begin_layout Plain Layout
22043 \change_inserted -712698321 1552395787
22051 ] Whether specific commands in this inset (such as
22052 \begin_inset Flex Code
22055 \begin_layout Plain Layout
22057 \change_inserted -712698321 1552395787
22068 \begin_inset Flex Code
22071 \begin_layout Plain Layout
22073 \change_inserted -712698321 1552395787
22083 ) should be protected in an
22084 \begin_inset Flex Code
22087 \begin_layout Plain Layout
22089 \change_inserted -712698321 1552395787
22100 This is particularly needed for insets that draw on
22108 commands which parse their content in complex ways.
22112 \begin_layout Description
22114 \change_inserted -712698321 1555579742
22115 \begin_inset Flex Code
22118 \begin_layout Plain Layout
22120 \change_inserted -712698321 1555579658
22129 \begin_inset Flex Code
22132 \begin_layout Plain Layout
22134 \change_inserted -712698321 1555579651
22142 Option to define a different command (from the default
22143 \begin_inset Flex Code
22146 \begin_layout Plain Layout
22148 \change_inserted -712698321 1555579742
22160 ) to be used for line breaks.
22161 The initial backslash must not be specified.
22166 \begin_layout Description
22167 \begin_inset Flex Code
22170 \begin_layout Plain Layout
22177 \begin_inset Flex Code
22180 \begin_layout Plain Layout
22186 ] Deletes an existing
22187 \begin_inset Flex Code
22190 \begin_layout Plain Layout
22199 \begin_layout Description
22200 \begin_inset Flex Code
22203 \begin_layout Plain Layout
22210 \begin_inset Flex Code
22213 \begin_layout Plain Layout
22220 \begin_inset Flex Code
22223 \begin_layout Plain Layout
22229 that has replaced this
22230 \begin_inset Flex Code
22233 \begin_layout Plain Layout
22240 This is used to rename an
22241 \begin_inset Flex Code
22244 \begin_layout Plain Layout
22250 , while keeping backward compatibility.
22251 \change_inserted -712698321 1559491850
22255 \begin_layout Description
22257 \change_inserted -712698321 1559492002
22258 \begin_inset Flex Code
22261 \begin_layout Plain Layout
22263 \change_inserted -712698321 1559491854
22272 \begin_inset Flex Code
22275 \begin_layout Plain Layout
22277 \change_inserted -712698321 1559491850
22288 \begin_inset space \thinspace{}
22292 \begin_inset Flex Code
22295 \begin_layout Plain Layout
22297 \change_inserted -712698321 1559491850
22305 ] If this is set to
22306 \begin_inset Flex Code
22309 \begin_layout Plain Layout
22311 \change_inserted -712698321 1559491881
22319 , paragraph breaks will be ignored in the output.
22320 This might be useful for insets where the content should be alignable on
22321 different lines only in the \SpecialChar LyX
22322 workarea, without any effect in the output.
22327 \begin_layout Description
22328 \begin_inset Flex Code
22331 \begin_layout Plain Layout
22338 \begin_inset Flex Code
22341 \begin_layout Plain Layout
22350 \begin_inset space \thinspace{}
22354 \begin_inset Flex Code
22357 \begin_layout Plain Layout
22363 ] As with paragraph styles, see
22364 \begin_inset CommandInset ref
22366 reference "subsec:Paragraph-Styles"
22374 \begin_layout Description
22375 \begin_inset Flex Code
22378 \begin_layout Plain Layout
22385 \begin_inset Flex Code
22388 \begin_layout Plain Layout
22397 \begin_inset space \thinspace{}
22401 \begin_inset Flex Code
22404 \begin_layout Plain Layout
22410 ] As with paragraph styles, see
22411 \begin_inset CommandInset ref
22413 reference "subsec:Paragraph-Styles"
22421 \begin_layout Description
22422 \begin_inset Flex Code
22425 \begin_layout Plain Layout
22431 As with paragraph styles, see
22432 \begin_inset CommandInset ref
22434 reference "subsec:Paragraph-Styles"
22441 \begin_layout Description
22442 \begin_inset Flex Code
22445 \begin_layout Plain Layout
22452 \begin_inset Flex Code
22455 \begin_layout Plain Layout
22461 ] The prefix to use when creating labels referring to insets of this type.
22462 This allows the use of formatted references.
22465 \begin_layout Description
22466 \begin_inset Flex Code
22469 \begin_layout Plain Layout
22476 \begin_inset Flex Code
22479 \begin_layout Plain Layout
22485 ] As with paragraph styles, see
22486 \begin_inset CommandInset ref
22488 reference "subsec:Paragraph-Styles"
22495 \begin_layout Description
22496 \begin_inset Flex Code
22499 \begin_layout Plain Layout
22506 \begin_inset Flex Code
22509 \begin_layout Plain Layout
22518 \begin_inset space \thinspace{}
22522 \begin_inset Flex Code
22525 \begin_layout Plain Layout
22531 ] Resets the \SpecialChar LaTeX
22532 arguments of this layout (as defined via the
22533 \begin_inset Flex Code
22536 \begin_layout Plain Layout
22543 This is useful if you have copied a style via
22544 \begin_inset Flex Code
22547 \begin_layout Plain Layout
22553 , but you do not want to inherit its (required and optional) arguments.
22556 \begin_layout Description
22557 \begin_inset Flex Code
22560 \begin_layout Plain Layout
22567 \begin_inset Flex Code
22570 \begin_layout Plain Layout
22579 \begin_inset space \thinspace{}
22583 \begin_inset Flex Code
22586 \begin_layout Plain Layout
22593 \change_inserted -712698321 1597733473
22595 \begin_inset Flex Code
22598 \begin_layout Plain Layout
22600 \change_inserted -712698321 1597732178
22608 , font changes are redone inside the respective inset (in the output) even
22609 if the inset itself is in the context of this font changes (e.
22610 \begin_inset space \thinspace{}
22614 \begin_inset Flex Code
22617 \begin_layout Plain Layout
22619 \change_inserted -712698321 1597733683
22622 textbf{Sourrounding text
22626 textbf{content}}\SpecialChar ldots
22635 \begin_inset Flex Code
22638 \begin_layout Plain Layout
22640 \change_inserted -712698321 1597733686
22643 textbf{Sourrounding text
22645 myinset{content}\SpecialChar ldots
22654 Setting this makes sense for commands that internally reset font settings
22656 \begin_inset space \thinspace{}
22660 Note that wrongly setting this might lead to unwanted result (e.
22661 \begin_inset space \thinspace{}
22665 \begin_inset Flex Code
22668 \begin_layout Plain Layout
22670 \change_inserted -712698321 1597733688
22673 emph{Sourrounding text
22677 emph{content}}\SpecialChar ldots
22685 , content is upright, as
22686 \begin_inset Flex Code
22689 \begin_layout Plain Layout
22691 \change_inserted -712698321 1597733278
22703 \change_deleted -712698321 1597733283
22704 Whether this inset should use the font of its surrounding environment or
22709 \change_deleted -712698321 1597733290
22711 \change_inserted -712698321 1597733290
22713 \begin_inset Flex Code
22716 \begin_layout Plain Layout
22718 \change_inserted -712698321 1597733292
22729 \change_deleted -712698321 1597733327
22730 use the font of the surrounding environment
22731 \change_inserted -712698321 1597733343
22732 font changes are not redone inside the inset
22737 \begin_layout Description
22738 \begin_inset Flex Code
22741 \begin_layout Plain Layout
22748 \begin_inset Flex Code
22751 \begin_layout Plain Layout
22757 ] A string that is put at the end of the layout content.
22758 A line break in the output can be indicated by
22759 \begin_inset Flex Code
22762 \begin_layout Plain Layout
22771 \begin_layout Description
22772 \begin_inset Flex Code
22775 \begin_layout Plain Layout
22782 \begin_inset Flex Code
22785 \begin_layout Plain Layout
22792 \begin_inset space \thinspace{}
22796 \begin_inset Flex Code
22799 \begin_layout Plain Layout
22807 ] Allow spell-checking the contents of this inset.
22809 \change_inserted -584632292 1615846659
22813 \begin_layout Subsection
22815 \change_inserted -584632292 1615846729
22817 \begin_inset CommandInset label
22819 name "subsec:Arguments"
22826 \begin_layout Standard
22828 \change_inserted -584632292 1615846807
22829 Both paragraph styles and inset layouts allow for
22833 as well as the main content.
22834 This is especially useful for things like section headings and only makes
22835 sense with \SpecialChar LaTeX
22837 Each (optional or required) argument of a command or environment—except
22838 for the required argument that is associated with the content—has a separate
22839 definition, where the number specifies the order of the arguments.
22840 The definition must end with
22841 \begin_inset Flex Code
22844 \begin_layout Plain Layout
22846 \change_inserted -584632292 1615846730
22855 So a command with two optional arguments looks like:
22858 \begin_layout Quote
22860 \change_inserted -584632292 1615846730
22866 \begin_layout Quote
22868 \change_inserted -584632292 1615846730
22874 \begin_layout Quote
22876 \change_inserted -584632292 1615846730
22882 \begin_layout Quote
22884 \change_inserted -584632292 1615846730
22890 \begin_layout Quote
22892 \change_inserted -584632292 1615846730
22898 \begin_layout Quote
22900 \change_inserted -584632292 1615846730
22906 \begin_layout Standard
22908 \change_inserted -584632292 1615846730
22910 \begin_inset Flex Code
22913 \begin_layout Plain Layout
22915 \change_inserted -584632292 1615846730
22923 definition, the following specifications are possible:
22926 \begin_layout Itemize
22928 \change_inserted -584632292 1615846730
22929 \begin_inset Flex Code
22932 \begin_layout Plain Layout
22934 \change_inserted -584632292 1615846730
22943 \begin_inset Flex Code
22946 \begin_layout Plain Layout
22948 \change_inserted -584632292 1615846730
22956 The string that will appear both in the menu (to insert this argument)
22957 and on the argument inset button (unless you also specify a separate
22958 \begin_inset Flex Code
22961 \begin_layout Plain Layout
22963 \change_inserted -584632292 1615846730
22972 For the menu, you can define an accelerator by appending the respective
22973 character to the string, divided by
22974 \begin_inset Quotes eld
22978 \begin_inset Quotes erd
22982 \begin_inset space \thinspace{}
22986 \begin_inset space \space{}
22990 \begin_inset Quotes eld
22994 \begin_inset Flex Code
22997 \begin_layout Plain Layout
22999 \change_inserted -584632292 1615846730
23008 \begin_inset Quotes erd
23014 \begin_layout Itemize
23016 \change_inserted -584632292 1615846730
23017 \begin_inset Flex Code
23020 \begin_layout Plain Layout
23022 \change_inserted -584632292 1615846730
23031 \begin_inset Flex Code
23034 \begin_layout Plain Layout
23036 \change_inserted -584632292 1615846730
23044 A separate string for the menu.
23045 You can define an accelerator by appending the respective character to
23046 the string, divided by
23047 \begin_inset Quotes eld
23051 \begin_inset Quotes erd
23055 \begin_inset space \thinspace{}
23059 \begin_inset space \space{}
23063 \begin_inset Quotes eld
23067 \begin_inset Flex Code
23070 \begin_layout Plain Layout
23072 \change_inserted -584632292 1615846730
23081 \begin_inset Quotes erd
23085 This specification is optional.
23086 If it is not given the
23087 \begin_inset Flex Code
23090 \begin_layout Plain Layout
23092 \change_inserted -584632292 1615846730
23100 will be used instead for the menu.
23103 \begin_layout Itemize
23105 \change_inserted -584632292 1615846730
23106 \begin_inset Flex Code
23109 \begin_layout Plain Layout
23111 \change_inserted -584632292 1615846730
23120 \begin_inset Flex Code
23123 \begin_layout Plain Layout
23125 \change_inserted -584632292 1615846730
23133 A longer explanatory text that appears in the tooltip when hovering over
23134 the argument inset.
23137 \begin_layout Itemize
23139 \change_inserted -584632292 1615846730
23140 \begin_inset Flex Code
23143 \begin_layout Plain Layout
23145 \change_inserted -584632292 1615846730
23154 \begin_inset Flex Code
23157 \begin_layout Plain Layout
23159 \change_inserted -584632292 1615846730
23170 \begin_inset space \thinspace{}
23174 \begin_inset Flex Code
23177 \begin_layout Plain Layout
23179 \change_inserted -584632292 1615846730
23187 ] Declare if this is a mandatory (1) or an optional (0) argument.
23188 Mandatory arguments will be output empty if not given, while optional arguments
23189 will not be output at all.
23190 By default, mandatory arguments are delimited by
23191 \begin_inset Flex Code
23194 \begin_layout Plain Layout
23196 \change_inserted -584632292 1615846730
23204 , while optional arguments are delimited by
23205 \begin_inset Flex Code
23208 \begin_layout Plain Layout
23210 \change_inserted -584632292 1615846730
23221 \begin_layout Itemize
23223 \change_inserted -584632292 1615846730
23224 \begin_inset Flex Code
23227 \begin_layout Plain Layout
23229 \change_inserted -584632292 1615846730
23238 \begin_inset Flex Code
23241 \begin_layout Plain Layout
23243 \change_inserted -584632292 1615846730
23251 Option to define a different command (from the default
23252 \begin_inset Flex Code
23255 \begin_layout Plain Layout
23257 \change_inserted -584632292 1615846730
23269 ) to be used for line breaks.
23270 The initial backslash must not be specified.
23273 \begin_layout Itemize
23275 \change_inserted -584632292 1615846730
23276 \begin_inset Flex Code
23279 \begin_layout Plain Layout
23281 \change_inserted -584632292 1615846730
23290 \begin_inset Flex Code
23293 \begin_layout Plain Layout
23295 \change_inserted -584632292 1615846730
23303 defines another argument (by its number) which this argument requires to
23304 be output if it is itself output.
23306 \begin_inset space \thinspace{}
23309 g., in \SpecialChar LaTeX
23310 commands, optional arguments often require previous optional arguments
23311 to be output (at least empty), as in
23312 \begin_inset Flex Code
23315 \begin_layout Plain Layout
23317 \change_inserted -584632292 1615846730
23320 command[][argument]{text}
23328 This can be achieved by the statement
23329 \begin_inset Flex Code
23332 \begin_layout Plain Layout
23334 \change_inserted -584632292 1615846730
23343 \begin_inset Flex Code
23346 \begin_layout Plain Layout
23348 \change_inserted -584632292 1615846730
23359 \begin_layout Itemize
23361 \change_inserted -584632292 1615846730
23362 \begin_inset Flex Code
23365 \begin_layout Plain Layout
23367 \change_inserted -584632292 1615846730
23376 \begin_inset Flex Code
23379 \begin_layout Plain Layout
23381 \change_inserted -584632292 1615846730
23389 defines a custom left delimiter (instead of
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
23418 A line break in the output can be indicated by
23419 \begin_inset Flex Code
23422 \begin_layout Plain Layout
23424 \change_inserted -584632292 1615846730
23435 \begin_layout Itemize
23437 \change_inserted -584632292 1615846730
23438 \begin_inset Flex Code
23441 \begin_layout Plain Layout
23443 \change_inserted -584632292 1615846730
23452 \begin_inset Flex Code
23455 \begin_layout Plain Layout
23457 \change_inserted -584632292 1615846730
23465 defines a custom right delimiter (instead of
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
23494 A line break in the output can be indicated by
23495 \begin_inset Flex Code
23498 \begin_layout Plain Layout
23500 \change_inserted -584632292 1615846730
23511 \begin_layout Itemize
23513 \change_inserted -584632292 1615846730
23514 \begin_inset Flex Code
23517 \begin_layout Plain Layout
23519 \change_inserted -584632292 1615846730
23528 \begin_inset Flex Code
23531 \begin_layout Plain Layout
23533 \change_inserted -584632292 1615846730
23541 defines an argument that is inserted if and only if no user-specified arguments
23543 \begin_inset space \thinspace{}
23547 \begin_inset space \space{}
23550 if no argument inset has been inserted (note that also an empty argument
23551 inset omits the DefaultArg).
23552 Multiple arguments need to be separated by comma.
23555 \begin_layout Itemize
23557 \change_inserted -584632292 1615846730
23558 \begin_inset Flex Code
23561 \begin_layout Plain Layout
23563 \change_inserted -584632292 1615846730
23572 \begin_inset Flex Code
23575 \begin_layout Plain Layout
23577 \change_inserted -584632292 1615846730
23585 defines an argument that is inserted in any case (alone or in addition
23586 to user-specified arguments).
23587 Multiple arguments need to be separated by comma.
23590 \begin_layout Itemize
23592 \change_inserted -584632292 1615846730
23593 \begin_inset Flex Code
23596 \begin_layout Plain Layout
23598 \change_inserted -584632292 1615846730
23606 The font used for the argument content, see
23607 \begin_inset CommandInset ref
23609 reference "subsec:Font-description"
23616 \begin_layout Itemize
23618 \change_inserted -584632292 1615846730
23619 \begin_inset Flex Code
23622 \begin_layout Plain Layout
23624 \change_inserted -584632292 1615846730
23633 \begin_inset Flex Code
23636 \begin_layout Plain Layout
23638 \change_inserted -584632292 1615846730
23649 \begin_inset space \thinspace{}
23653 \begin_inset Flex Code
23656 \begin_layout Plain Layout
23658 \change_inserted -584632292 1615846730
23666 ] As with paragraph styles, see
23667 \begin_inset CommandInset ref
23669 reference "subsec:Paragraph-Styles"
23676 \begin_layout Itemize
23678 \change_inserted -584632292 1615846730
23679 \begin_inset Flex Code
23682 \begin_layout Plain Layout
23684 \change_inserted -584632292 1615846730
23692 The font used for the label; see
23693 \begin_inset CommandInset ref
23695 reference "subsec:Font-description"
23702 \begin_layout Itemize
23704 \change_inserted -584632292 1615846730
23705 \begin_inset Flex Code
23708 \begin_layout Plain Layout
23710 \change_inserted -584632292 1615846730
23719 \begin_inset Flex Code
23722 \begin_layout Plain Layout
23724 \change_inserted -584632292 1615846730
23729 , Minimalistic, Conglomerate
23736 ] describes the rendering style used for the inset's frame and buttons.
23739 \begin_layout Itemize
23741 \change_inserted -584632292 1615846730
23742 \begin_inset Flex Code
23745 \begin_layout Plain Layout
23747 \change_inserted -584632292 1615846730
23756 \begin_inset Flex Code
23759 \begin_layout Plain Layout
23761 \change_inserted -584632292 1615846730
23770 \begin_inset Flex Code
23773 \begin_layout Plain Layout
23775 \change_inserted -584632292 1615846730
23783 , this argument is automatically inserted when the respective style is selected.
23786 \begin_layout Itemize
23788 \change_inserted -584632292 1615846730
23789 \begin_inset Flex Code
23792 \begin_layout Plain Layout
23794 \change_inserted -584632292 1615846730
23803 \begin_inset Flex Code
23806 \begin_layout Plain Layout
23808 \change_inserted -584632292 1615846730
23817 \begin_inset Flex Code
23820 \begin_layout Plain Layout
23822 \change_inserted -584632292 1615846730
23830 , this argument will be inserted on a new line with
23831 \begin_inset Flex Code
23834 \begin_layout Plain Layout
23836 \change_inserted -584632292 1615846730
23844 (only available within Flex insets).
23847 \begin_layout Itemize
23849 \change_inserted -584632292 1615846730
23850 \begin_inset Flex Code
23853 \begin_layout Plain Layout
23855 \change_inserted -584632292 1615846730
23864 \begin_inset Flex Code
23867 \begin_layout Plain Layout
23869 \change_inserted -584632292 1615846730
23878 \begin_inset Flex Code
23881 \begin_layout Plain Layout
23883 \change_inserted -584632292 1615846730
23891 , this argument will be inserted with a copy of the co-text (either selected
23892 text or the whole paragraph) as content.
23895 \begin_layout Itemize
23897 \change_inserted -584632292 1615846730
23898 \begin_inset Flex Code
23901 \begin_layout Plain Layout
23903 \change_inserted -584632292 1615846730
23912 \begin_inset Flex Code
23915 \begin_layout Plain Layout
23917 \change_inserted -584632292 1615846730
23929 ] Whether the contents of this argument should be output in raw form, meaning
23930 without special translations that \SpecialChar LaTeX
23933 \begin_inset Flex Code
23936 \begin_layout Plain Layout
23938 \change_inserted -584632292 1615846730
23946 status is inherited by the inset or paragraph layout the argument belongs
23947 to, true and false change the status for the given argument only.
23950 \begin_layout Itemize
23952 \change_inserted -584632292 1615846730
23953 \begin_inset Flex Code
23956 \begin_layout Plain Layout
23958 \change_inserted -584632292 1615846730
23967 \begin_inset Flex Code
23970 \begin_layout Plain Layout
23972 \change_inserted -584632292 1615846730
23973 string of characters
23984 Defines individual characters
23985 \begin_inset Newline linebreak
23988 that should be output in raw form, meaning without special translations
23989 that \SpecialChar LaTeX
23991 Note that, contrary to PassThru, this needs to be explicitly defined for
23993 That is, arguments do not inherit PassThruChars from their parent inset
23997 \begin_layout Itemize
23999 \change_inserted -584632292 1615846730
24000 \begin_inset Flex Code
24003 \begin_layout Plain Layout
24005 \change_inserted -584632292 1615846730
24014 \begin_inset Flex Code
24017 \begin_layout Plain Layout
24019 \change_inserted -584632292 1615846730
24030 \begin_inset space \thinspace{}
24034 \begin_inset Flex Code
24037 \begin_layout Plain Layout
24039 \change_inserted -584632292 1615846730
24047 ] If this is set to 1, the argument will output its content in the corresponding
24048 item in the table of contents.
24052 \begin_layout Standard
24054 \change_inserted -584632292 1615846730
24055 By default, the text entered in the \SpecialChar LyX
24056 workarea in the respective layout is
24057 the last (mandatory) argument of a command if the
24058 \begin_inset Flex Code
24061 \begin_layout Plain Layout
24063 \change_inserted -584632292 1615846730
24072 \begin_inset Flex Code
24075 \begin_layout Plain Layout
24077 \change_inserted -584632292 1615846730
24086 However, arguments with the prefix
24087 \begin_inset Flex Code
24090 \begin_layout Plain Layout
24092 \change_inserted -584632292 1615846730
24100 are output after this workarea argument.
24101 Note that post-argument numbering restarts at 1, so the first argument
24102 following the workarea argument is
24103 \begin_inset Flex Code
24106 \begin_layout Plain Layout
24108 \change_inserted -584632292 1615846730
24117 Post-arguments are ignored in any other
24118 \begin_inset Flex Code
24121 \begin_layout Plain Layout
24123 \change_inserted -584632292 1615846730
24132 \begin_inset Flex Code
24135 \begin_layout Plain Layout
24137 \change_inserted -584632292 1615846730
24148 \begin_layout Standard
24150 \change_inserted -584632292 1615846730
24152 \begin_inset Flex Code
24155 \begin_layout Plain Layout
24157 \change_inserted -584632292 1615846730
24168 \begin_inset Flex Code
24171 \begin_layout Plain Layout
24173 \change_inserted -584632292 1615846730
24184 \begin_inset Flex Code
24187 \begin_layout Plain Layout
24189 \change_inserted -584632292 1615846730
24197 followed by the number (e.
24198 \begin_inset space \thinspace{}
24202 \begin_inset space \space{}
24206 \begin_inset Flex Code
24209 \begin_layout Plain Layout
24211 \change_inserted -584632292 1615846730
24222 \begin_layout Standard
24224 \change_inserted -584632292 1615846730
24225 Finally, there is a special argument type with the prefix
24226 \begin_inset Flex Code
24229 \begin_layout Plain Layout
24231 \change_inserted -584632292 1615846730
24240 It is not really an argument, but uses the argument interface (thus, the
24241 prefix is also followed by a number, e.
24242 \begin_inset space \thinspace{}
24247 \begin_inset Flex Code
24250 \begin_layout Plain Layout
24252 \change_inserted -584632292 1615846730
24253 Argument listpreamble:1
24261 As the name implies, it is targeted at lists such as
24278 Its content will be output at the list start, before the first
24279 \begin_inset Flex Code
24282 \begin_layout Plain Layout
24284 \change_inserted -584632292 1615846730
24294 , on an own line (a place that is otherwise not accessible in \SpecialChar LyX
24296 This way, users can insert redefinitions (of lengths etc.) to individual
24298 By default, these arguments do not have a delimiter.
24303 \begin_layout Subsection
24305 \begin_inset CommandInset label
24307 name "subsec:Counters"
24314 \begin_layout Standard
24315 It is necessary to define the counters (
24316 \begin_inset Flex Noun
24319 \begin_layout Plain Layout
24326 \begin_inset Flex Noun
24329 \begin_layout Plain Layout
24335 , \SpecialChar ldots
24336 ) in the text class itself.
24337 The standard counters are defined in the file
24338 \begin_inset Flex Code
24341 \begin_layout Plain Layout
24347 , so you may have to do no more than add
24350 \begin_layout LyX-Code
24351 Input stdcounters.inc
24354 \begin_layout Standard
24355 to your layout file to get them to work.
24356 But if you want to define custom counters, then you can do so.
24357 The counter declaration must begin with:
24360 \begin_layout LyX-Code
24361 Counter CounterName
24364 \begin_layout Standard
24366 \begin_inset Flex Code
24369 \begin_layout Plain Layout
24375 ' is replaced by the name of the counter.
24376 And it must end with
24377 \begin_inset Quotes eld
24381 \begin_inset Flex Code
24384 \begin_layout Plain Layout
24391 \begin_inset Quotes erd
24395 The following parameters can also be used:
24398 \begin_layout Description
24399 \begin_inset Flex Code
24402 \begin_layout Plain Layout
24409 \begin_inset Flex Code
24412 \begin_layout Plain Layout
24418 ] Sets the initial value for the counter, to which it will be reset whenever
24420 Normally, one will want the default, 1.
24423 \begin_layout Description
24424 \begin_inset Flex Code
24427 \begin_layout Plain Layout
24434 \begin_inset Flex Code
24437 \begin_layout Plain Layout
24444 \begin_inset Quotes erd
24448 \begin_inset Quotes erd
24451 ] When defined, this string defines how the counter is displayed.
24452 Setting this value sets
24453 \begin_inset Flex Code
24456 \begin_layout Plain Layout
24457 LabelStringAppendix
24463 The following special constructs can be used in the string:
24467 \begin_layout Itemize
24468 \begin_inset Flex Code
24471 \begin_layout Plain Layout
24479 will be replaced by the expansion of the
24480 \begin_inset Flex Code
24483 \begin_layout Plain Layout
24490 \begin_inset Flex Code
24493 \begin_layout Plain Layout
24494 LabelStringAppendix
24500 \begin_inset Flex Code
24503 \begin_layout Plain Layout
24513 \begin_layout Itemize
24514 counter values can be expressed using \SpecialChar LaTeX
24516 \begin_inset Newline newline
24520 \begin_inset Flex Code
24523 \begin_layout Plain Layout
24540 \begin_inset Flex Code
24543 \begin_layout Plain Layout
24555 \begin_layout Plain Layout
24565 Actually, the situation is a bit more complicated: any
24584 other than those described below will produce arabic numerals.
24585 It would not be surprising to see this change in the future.
24591 \begin_inset Flex Code
24594 \begin_layout Plain Layout
24600 : 1, 2, 3,\SpecialChar ldots
24602 \begin_inset Flex Code
24605 \begin_layout Plain Layout
24611 for lower-case letters: a, b, c, \SpecialChar ldots
24613 \begin_inset Flex Code
24616 \begin_layout Plain Layout
24622 for upper-case letters: A, B, C, \SpecialChar ldots
24624 \begin_inset Flex Code
24627 \begin_layout Plain Layout
24633 for lower-case roman numerals: i, ii, iii, \SpecialChar ldots
24635 \begin_inset Flex Code
24638 \begin_layout Plain Layout
24644 for upper-case roman numerals: I, II, III\SpecialChar ldots
24646 \begin_inset Flex Code
24649 \begin_layout Plain Layout
24655 for hebrew numerals.
24659 \begin_layout Standard
24660 If LabelString is not defined, a default value is constructed as follows:
24661 if the counter has a
24662 \change_deleted 731793113 1604355218
24664 \change_inserted 731793113 1604355221
24668 \begin_inset Flex Code
24671 \begin_layout Plain Layout
24673 \change_deleted 731793113 1604355223
24675 \change_inserted 731793113 1604355226
24684 \begin_inset Flex Code
24687 \begin_layout Plain Layout
24694 \begin_inset Newline newline
24698 \begin_inset Flex Code
24701 \begin_layout Plain Layout
24705 \change_inserted 731793113 1604355228
24707 \change_deleted 731793113 1604355230
24717 is used; otherwise the string
24718 \begin_inset Flex Code
24721 \begin_layout Plain Layout
24732 \begin_layout Description
24733 \begin_inset Flex Code
24736 \begin_layout Plain Layout
24737 LabelStringAppendix
24743 \begin_inset Flex Code
24746 \begin_layout Plain Layout
24753 \begin_inset Quotes eld
24757 \begin_inset Quotes erd
24761 \begin_inset Flex Code
24764 \begin_layout Plain Layout
24770 , but for use in the Appendix.
24771 \change_inserted -584632292 1607202551
24775 \begin_layout Description
24777 \change_inserted -584632292 1607202682
24778 \begin_inset Flex Code
24781 \begin_layout Plain Layout
24788 \begin_inset Flex Code
24791 \begin_layout Plain Layout
24793 \change_inserted -584632292 1607202576
24802 \begin_inset Quotes eld
24806 \begin_inset Quotes erd
24809 ] The counter name as used in \SpecialChar LaTeX
24812 \change_inserted 34634807 1619711355
24814 \change_deleted 34634807 1619711355
24816 \change_inserted -584632292 1607202682
24817 .g., in \SpecialChar LyX
24818 , there is a counter named `theorem', but it is output to \SpecialChar LaTeX
24824 \begin_layout Description
24825 \begin_inset Flex Code
24828 \begin_layout Plain Layout
24835 \begin_inset Flex Code
24838 \begin_layout Plain Layout
24845 \begin_inset Quotes erd
24849 \begin_inset Quotes erd
24852 ] A format for use with formatted references to this counter.
24853 For example, one might want to have references to section numbers appear
24855 \begin_inset Quotes eld
24859 \begin_inset Quotes erd
24863 The string should contain
24864 \begin_inset Quotes eld
24868 \begin_inset Quotes erd
24872 This will be replaced by the counter number itself.
24873 So, for sections, it would be: Section ##.
24876 \begin_layout Description
24877 \begin_inset Flex Code
24880 \begin_layout Plain Layout
24887 \begin_inset Flex Code
24890 \begin_layout Plain Layout
24897 \begin_inset Quotes erd
24901 \begin_inset Quotes erd
24904 ] If this is set to the name of another counter, the present counter will
24905 be reset every time the other one is increased.
24907 \begin_inset Flex Code
24910 \begin_layout Plain Layout
24917 \begin_inset Flex Code
24920 \begin_layout Plain Layout
24929 \begin_layout Subsection
24931 \begin_inset CommandInset label
24933 name "subsec:Font-description"
24940 \begin_layout Standard
24941 A font description looks like this:
24944 \begin_layout LyX-Code
24961 \begin_layout LyX-Code
24965 \begin_layout LyX-Code
24969 \begin_layout Standard
24970 The following commands are available:
24973 \begin_layout Description
24974 \begin_inset Flex Code
24977 \begin_layout Plain Layout
24984 \change_deleted -712698321 1607682984
24986 \begin_inset Flex Code
24989 \begin_layout Plain Layout
24998 \begin_inset Flex Code
25001 \begin_layout Plain Layout
25008 \begin_inset Flex Code
25011 \begin_layout Plain Layout
25018 \begin_inset Flex Code
25021 \begin_layout Plain Layout
25028 \begin_inset Flex Code
25031 \begin_layout Plain Layout
25038 \begin_inset Flex Code
25041 \begin_layout Plain Layout
25048 \begin_inset Flex Code
25051 \begin_layout Plain Layout
25058 \begin_inset Flex Code
25061 \begin_layout Plain Layout
25068 \begin_inset Flex Code
25071 \begin_layout Plain Layout
25078 \begin_inset Flex Code
25081 \begin_layout Plain Layout
25088 \begin_inset Flex Code
25091 \begin_layout Plain Layout
25098 \begin_inset Flex Code
25101 \begin_layout Plain Layout
25108 \begin_inset Flex Code
25111 \begin_layout Plain Layout
25118 \begin_inset Flex Code
25121 \begin_layout Plain Layout
25128 \begin_inset Flex Code
25131 \begin_layout Plain Layout
25138 \begin_inset Flex Code
25141 \begin_layout Plain Layout
25148 \begin_inset Flex Code
25151 \begin_layout Plain Layout
25158 \begin_inset Flex Code
25161 \begin_layout Plain Layout
25168 \begin_inset Flex Code
25171 \begin_layout Plain Layout
25178 \begin_inset Flex Code
25181 \begin_layout Plain Layout
25188 \change_inserted -712698321 1607683139
25190 \begin_inset Flex Code
25193 \begin_layout Plain Layout
25195 \change_inserted -712698321 1607683135
25204 \begin_inset space ~
25208 \begin_inset CommandInset ref
25210 reference "chap:Names-of-colors"
25218 \change_deleted -712698321 1607683144
25220 \change_inserted -712698321 1607683146
25226 \begin_layout Description
25227 \begin_inset Flex Code
25230 \begin_layout Plain Layout
25237 \begin_inset Flex Code
25240 \begin_layout Plain Layout
25249 \begin_inset Flex Code
25252 \begin_layout Plain Layout
25259 \begin_inset Flex Code
25262 \begin_layout Plain Layout
25271 \begin_layout Description
25272 \begin_inset Flex Code
25275 \begin_layout Plain Layout
25282 \begin_inset Flex Code
25285 \begin_layout Plain Layout
25291 ] Valid arguments are:
25292 \begin_inset Flex Code
25295 \begin_layout Plain Layout
25302 \begin_inset Flex Code
25305 \begin_layout Plain Layout
25312 \begin_inset Flex Code
25315 \begin_layout Plain Layout
25322 \begin_inset Flex Code
25325 \begin_layout Plain Layout
25332 \begin_inset Flex Code
25335 \begin_layout Plain Layout
25342 \begin_inset Flex Code
25345 \begin_layout Plain Layout
25352 \begin_inset Flex Code
25355 \begin_layout Plain Layout
25362 \begin_inset Flex Code
25365 \begin_layout Plain Layout
25372 \begin_inset Flex Code
25375 \begin_layout Plain Layout
25382 \begin_inset Flex Code
25385 \begin_layout Plain Layout
25392 \begin_inset Flex Code
25395 \begin_layout Plain Layout
25402 \begin_inset Flex Code
25405 \begin_layout Plain Layout
25412 Each of these turns on or off the corresponding attribute.
25414 \begin_inset Flex Code
25417 \begin_layout Plain Layout
25423 turns on emphasis, and
25424 \begin_inset Flex Code
25427 \begin_layout Plain Layout
25435 \begin_inset Newline newline
25438 If the latter seems puzzling, remember that the font settings for the present
25439 context are generally inherited from the surrounding context.
25441 \begin_inset Flex Code
25444 \begin_layout Plain Layout
25450 would turn off the emphasis that was anyway in effect, say, in a theorem
25454 \begin_layout Description
25455 \begin_inset Flex Code
25458 \begin_layout Plain Layout
25465 \begin_inset Flex Code
25468 \begin_layout Plain Layout
25477 \begin_inset Flex Code
25480 \begin_layout Plain Layout
25489 \begin_layout Description
25490 \begin_inset Flex Code
25493 \begin_layout Plain Layout
25500 \begin_inset Flex Code
25503 \begin_layout Plain Layout
25512 \begin_inset Flex Code
25515 \begin_layout Plain Layout
25522 \begin_inset Flex Code
25525 \begin_layout Plain Layout
25532 \begin_inset Flex Code
25535 \begin_layout Plain Layout
25544 \begin_layout Description
25545 \begin_inset Flex Code
25548 \begin_layout Plain Layout
25555 \begin_inset Flex Code
25558 \begin_layout Plain Layout
25565 \begin_inset Flex Code
25568 \begin_layout Plain Layout
25575 \begin_inset Flex Code
25578 \begin_layout Plain Layout
25587 \begin_inset Flex Code
25590 \begin_layout Plain Layout
25597 \begin_inset Flex Code
25600 \begin_layout Plain Layout
25607 \begin_inset Flex Code
25610 \begin_layout Plain Layout
25617 \begin_inset Flex Code
25620 \begin_layout Plain Layout
25627 \begin_inset Flex Code
25630 \begin_layout Plain Layout
25639 \begin_layout Subsection
25640 \begin_inset CommandInset label
25642 name "subsec:Citation-engine-description"
25646 Cite engine description
25649 \begin_layout Standard
25651 \begin_inset Flex Code
25654 \begin_layout Plain Layout
25660 blocks, as used mainly in cite engine files (see
25661 \begin_inset CommandInset ref
25663 reference "subsec:Cite-Engine-Files"
25670 ), define the citation commands provided by a specific
25671 \begin_inset Quotes eld
25675 \begin_inset Quotes erd
25679 A cite engine, in \SpecialChar LyX
25680 terms, is way specific way to format citations, using
25681 numbers, author names and/or years.
25682 Currently, \SpecialChar LyX
25683 supports three such engine types, namely:
25686 \begin_layout Enumerate
25687 \begin_inset Flex Code
25690 \begin_layout Plain Layout
25696 : the default Bib\SpecialChar TeX
25697 way to format citations, a simple numeric style (e.
25698 \begin_inset space \thinspace{}
25702 \begin_inset Quotes eld
25706 \begin_inset Quotes erd
25712 \begin_layout Enumerate
25713 \begin_inset Flex Code
25716 \begin_layout Plain Layout
25722 : Harvard-styled citations using author names and publication year (e.
25723 \begin_inset space \thinspace{}
25727 \begin_inset Quotes eld
25730 Smith and Miller (2017b)
25731 \begin_inset Quotes erd
25737 \begin_layout Enumerate
25738 \begin_inset Flex Code
25741 \begin_layout Plain Layout
25747 : extended numerical citations that also allow for author or title next
25749 \begin_inset space \thinspace{}
25753 \begin_inset Quotes eld
25756 Smith and Miller [1]
25757 \begin_inset Quotes erd
25763 \begin_layout Standard
25764 \begin_inset Flex Code
25767 \begin_layout Plain Layout
25773 blocks look like this:
25776 \begin_layout LyX-Code
25780 \begin_layout LyX-Code
25784 \begin_layout LyX-Code
25788 \begin_layout LyX-Code
25789 citeyearpar[][]=parencite*
25792 \begin_layout LyX-Code
25796 \begin_layout LyX-Code
25800 \begin_layout Standard
25802 \begin_inset Flex Code
25805 \begin_layout Plain Layout
25811 denotes the engine.
25812 The individual lines respectively define a cite command or cite command
25813 paradigm supported by this engine.
25814 The line can be as simple as a cite command that is used both to name the
25815 respective \SpecialChar LyX
25816 command and the \SpecialChar LaTeX
25817 output or more complex in order to differentiate
25819 The full syntax is:
25822 \begin_layout LyX-Code
25823 LyXName|alias$*<!_stardesc!_stardesctooltip>[][]=latexcmd
25826 \begin_layout Itemize
25827 \begin_inset Flex Code
25830 \begin_layout Plain Layout
25836 : The name as used in the
25837 \begin_inset Flex Code
25840 \begin_layout Plain Layout
25850 \begin_layout Standard
25851 For portability reasons, we try to use the same name for same-formatted
25852 commands in different cite packages (thus many names stem from natbib,
25853 and thus we need to differentiate a
25854 \begin_inset Flex Code
25857 \begin_layout Plain Layout
25863 sometimes, if the \SpecialChar LaTeX
25864 command names differ).
25868 \begin_layout Itemize
25869 \begin_inset Flex Code
25872 \begin_layout Plain Layout
25878 : a (comma-separated) list of commands that fall back to the given
25879 \begin_inset Flex Code
25882 \begin_layout Plain Layout
25888 in the current engine.
25889 This eases the switch of citation packages and engines.
25891 \begin_inset Flex Code
25894 \begin_layout Plain Layout
25901 \begin_inset Flex Code
25904 \begin_layout Plain Layout
25910 in layout definitions.
25913 \begin_layout Itemize
25914 \begin_inset Flex Code
25917 \begin_layout Plain Layout
25923 : The actual \SpecialChar LaTeX
25924 command that is output.
25928 \begin_layout Standard
25929 \begin_inset Flex Code
25932 \begin_layout Plain Layout
25939 \begin_inset Flex Code
25942 \begin_layout Plain Layout
25950 \begin_inset Flex Code
25953 \begin_layout Plain Layout
25960 \begin_inset Flex Code
25963 \begin_layout Plain Layout
25969 will be output to \SpecialChar LaTeX
25973 \begin_layout Standard
25977 \begin_layout Itemize
25978 Capitalization indicates that the command also has a capitalized form (
25979 \begin_inset Flex Code
25982 \begin_layout Plain Layout
25992 \begin_inset Flex Code
25995 \begin_layout Plain Layout
26004 These usually enforce up-casing of name prefixes (
26009 \begin_inset Formula $\Rightarrow$
26019 \begin_layout Itemize
26021 \begin_inset Flex Code
26024 \begin_layout Plain Layout
26030 indicate the number of optional arguments (there can be 0–2).
26033 \begin_layout Itemize
26035 \begin_inset Flex Code
26038 \begin_layout Plain Layout
26044 indicates there is a starred version of the command (
26045 \begin_inset Flex Code
26048 \begin_layout Plain Layout
26058 \begin_inset Flex Code
26061 \begin_layout Plain Layout
26074 \begin_layout Standard
26075 By default, the starred version means: Output all authors even if it should
26077 \begin_inset Quotes eld
26081 \begin_inset Quotes erd
26085 \begin_inset Flex Code
26088 \begin_layout Plain Layout
26097 \begin_layout Standard
26098 If the star has a different meaning for a given command, it can be specified
26100 \begin_inset Flex Code
26103 \begin_layout Plain Layout
26104 <!_stardesc!_stardesctooltip>
26110 Maximal two translatable macro keywords, marked by the prefix
26111 \begin_inset Flex Code
26114 \begin_layout Plain Layout
26121 The first points to the string that replaces the
26122 \begin_inset Quotes eld
26126 \begin_inset Quotes erd
26129 checkbox label in the citation dialog, the second one to an optional tool
26130 tip for this checkbox.
26134 \begin_layout Standard
26135 Note that these two macros have to be defined in a
26136 \begin_inset Flex Code
26139 \begin_layout Plain Layout
26145 (see next section), dropping the
26146 \begin_inset Flex Code
26149 \begin_layout Plain Layout
26155 from the prefix, like this:
26158 \begin_layout LyX-Code
26159 _stardesc Sta&rred command label
26162 \begin_layout LyX-Code
26163 _stardesctooltip Tooltip for the starred command checkbox.
26167 \begin_layout Itemize
26169 \begin_inset Flex Code
26172 \begin_layout Plain Layout
26178 indicates that this command features
26179 \begin_inset Quotes eld
26182 qualified citation lists
26183 \begin_inset Quotes erd
26191 -specific feature for multi-reference citations where an individual pre-
26192 and postnote can be given to each reference in the list.
26193 Please refer to the
26197 manual for details.
26198 \change_inserted -712698321 1526898670
26202 \begin_layout Standard
26204 \change_inserted -712698321 1526899524
26205 If you want to add a cite command to a cite engine (e.
26206 \begin_inset space \thinspace{}
26209 g., add a specific command provided by a class), you can use
26210 \begin_inset Flex Code
26213 \begin_layout Plain Layout
26215 \change_inserted -712698321 1526898768
26216 AddToCiteEngine <engine type> \SpecialChar ldots
26225 Note that only cite commands that do not exist yet are added.
26230 \begin_layout Subsection
26231 \begin_inset CommandInset label
26233 name "subsec:Citation-format-description"
26237 Cite format description
26240 \begin_layout Standard
26242 \begin_inset Flex Code
26245 \begin_layout Plain Layout
26251 blocks are used to describe how bibliographic information should be displayed,
26252 both within \SpecialChar LyX
26253 itself (in the citation dialog and in tooltips, for example)
26254 and in XHTML output.
26255 Such a block might look like this:
26258 \begin_layout LyX-Code
26262 \begin_layout LyX-Code
26266 \begin_layout LyX-Code
26270 \begin_layout LyX-Code
26274 \begin_layout Standard
26278 \begin_layout LyX-Code
26282 \begin_layout LyX-Code
26286 \begin_layout LyX-Code
26290 \begin_layout LyX-Code
26294 \begin_layout Standard
26295 In the first case, the individual lines define how the bibliographic information
26296 associated with an article or book, respectively, is to be displayed, and
26297 such a definition can be given for any
26298 \begin_inset Quotes els
26302 \begin_inset Quotes ers
26305 that might be present in a Bib\SpecialChar TeX
26308 defines a default format in the source code that will be used if no specific
26309 definition has been given.
26311 predefines several formats in the file
26312 \begin_inset Flex Code
26315 \begin_layout Plain Layout
26321 , which is included in most of \SpecialChar LyX
26322 's document classes.
26325 \begin_layout Standard
26326 In the second case, the lines define how a specific citation command (in
26328 \begin_inset Flex Code
26331 \begin_layout Plain Layout
26340 \begin_inset Flex Code
26343 \begin_layout Plain Layout
26351 ) is to be displayed on the citation inset label, in the citation dialog,
26352 menu or XHTML output.
26354 defines such formats for the citation style variants it supports via
26356 Document\SpecialChar menuseparator
26357 Setting\SpecialChar menuseparator
26358 Bibliography\SpecialChar ldots
26362 \begin_inset Flex Code
26365 \begin_layout Plain Layout
26371 files that are shipped with \SpecialChar LyX
26373 \begin_inset CommandInset ref
26375 reference "subsec:Cite-Engine-Files"
26385 \begin_layout Standard
26386 The definitions use a simple language that allows Bib\SpecialChar TeX
26387 keys to be replaced
26389 Keys should be enclosed in
26390 \begin_inset Flex Code
26393 \begin_layout Plain Layout
26400 \begin_inset Flex Code
26403 \begin_layout Plain Layout
26410 So a simple definition might look like this:
26413 \begin_layout LyX-Code
26415 \begin_inset Quotes eld
26419 \begin_inset Quotes erd
26425 \begin_layout Standard
26426 This would print the author, followed by a comma, followed by the title,
26427 in quotes, followed by a period.
26430 \begin_layout Standard
26431 Of course, sometimes you may want to print a key only if it exists.
26432 This can be done by using a conditional construction, such as:
26433 \begin_inset Flex Code
26436 \begin_layout Plain Layout
26438 \begin_inset space ~
26448 \begin_inset Flex Code
26451 \begin_layout Plain Layout
26457 key exists, then print
26458 \begin_inset Quotes eld
26462 \begin_inset space ~
26466 \begin_inset Quotes erd
26469 followed by the volume key.
26470 It is also possible to have an else clause in the conditional, such as:
26471 \begin_inset Newline newline
26475 \begin_inset Flex Code
26478 \begin_layout Plain Layout
26479 {%author%[[%author%]][[%editor%, ed.]]}
26485 \begin_inset Newline newline
26489 \begin_inset Flex Code
26492 \begin_layout Plain Layout
26498 key is printed if it exists; otherwise, the editor key is printed, followed
26500 \begin_inset Quotes eld
26504 \begin_inset space ~
26508 \begin_inset Quotes erd
26511 Note that the key is again enclosed in
26512 \begin_inset Flex Code
26515 \begin_layout Plain Layout
26521 signs; the entire conditional is enclosed in braces; and the if and else
26522 clauses are enclosed in double brackets,
26523 \begin_inset Quotes eld
26527 \begin_inset Flex Code
26530 \begin_layout Plain Layout
26537 \begin_inset Quotes eld
26541 \begin_inset Quotes eld
26545 \begin_inset Flex Code
26548 \begin_layout Plain Layout
26555 \begin_inset Quotes erd
26559 There must be no space between any of these.
26562 \begin_layout Standard
26563 Next to the entry keys, there are some special keys that can be used for
26564 these conditionals:
26567 \begin_layout Itemize
26568 \begin_inset Flex Code
26571 \begin_layout Plain Layout
26572 {%dialog%[[true]][[false]]}
26578 \begin_inset Quotes eld
26582 \begin_inset Quotes erd
26585 part for dialogs and menus, the
26586 \begin_inset Quotes eld
26590 \begin_inset Quotes erd
26593 part for other contexts (workarea, export)
26596 \begin_layout Itemize
26597 \begin_inset Flex Code
26600 \begin_layout Plain Layout
26601 {%export%[[true]][[false]]}
26607 \begin_inset Quotes eld
26611 \begin_inset Quotes erd
26614 part for export and menus, the
26615 \begin_inset Quotes eld
26619 \begin_inset Quotes erd
26622 part for other contexts (workarea, dialog)
26625 \begin_layout Itemize
26626 \begin_inset Flex Code
26629 \begin_layout Plain Layout
26636 \begin_inset Quotes eld
26640 \begin_inset Quotes erd
26643 part if another item follows (e.
26644 \begin_inset space \thinspace{}
26647 g., in a citation with multiple keys)
26650 \begin_layout Itemize
26651 \begin_inset Flex Code
26654 \begin_layout Plain Layout
26655 {%second%[[true]][[false]]}
26661 \begin_inset Quotes eld
26665 \begin_inset Quotes erd
26668 if this is the second of multiple items, else the
26669 \begin_inset Quotes eld
26673 \begin_inset Quotes erd
26679 \begin_layout Itemize
26680 \begin_inset Flex Code
26683 \begin_layout Plain Layout
26684 {%ifstar%[[true]][[false]]}
26690 \begin_inset Quotes eld
26694 \begin_inset Quotes erd
26697 part for starred citation commands (such as
26698 \begin_inset Flex Code
26701 \begin_layout Plain Layout
26709 ), the false part for unstarred
26712 \begin_layout Itemize
26713 \begin_inset Flex Code
26716 \begin_layout Plain Layout
26717 {%ifentrytype:<type>%[[true]][[false]]}
26723 \begin_inset Quotes eld
26727 \begin_inset Quotes erd
26730 if the current entry type matches
26731 \begin_inset Flex Code
26734 \begin_layout Plain Layout
26740 , else the false part (e.g., in a citation definition:
26741 \begin_inset Flex Code
26744 \begin_layout Plain Layout
26745 {%ifentrytype:book%[[this is a book]][[this is no book]]}
26753 \begin_layout Itemize
26754 \begin_inset Flex Code
26757 \begin_layout Plain Layout
26758 {%ifmultiple:<authortype>%[[true]][[false]]}
26764 \begin_inset Quotes eld
26768 \begin_inset Quotes erd
26771 if the current author type (author, editor etc.) has multiple authors, else
26772 the false part (e.g., in a bibliography definition:
26773 \begin_inset Flex Code
26776 \begin_layout Plain Layout
26777 {%ifmultiple:editor%[[eds.]][[ed.]]}
26785 \begin_layout Itemize
26786 \begin_inset Flex Code
26789 \begin_layout Plain Layout
26790 {%ifqualified%[[true]][[false]]}
26796 \begin_inset Quotes eld
26800 \begin_inset Quotes erd
26803 part if the current citation is a qualified citation list (a specific
26807 format for multi-reference citations), the false part if this is not the
26811 \begin_layout Standard
26813 \begin_inset Flex Code
26816 \begin_layout Plain Layout
26822 prints the author key as it is recorded in the bibliography file.
26823 This might not be what you want, since it will result in a string such
26825 \begin_inset Quotes eld
26828 Miller, Peter and Smith, Mary and White, Jane
26829 \begin_inset Quotes erd
26833 \begin_inset Quotes eld
26837 \begin_inset Quotes erd
26840 is used by Bib\SpecialChar TeX
26841 to delimit authors).
26843 therefore provides some methods to get properly formatted name lists (which
26844 will also get translated).
26845 The following keys are provided:
26848 \begin_layout Enumerate
26849 For name lists with pre- and surname, suitable for the main authors/editors
26850 of a bibliography item.
26852 \begin_inset Flex Code
26855 \begin_layout Plain Layout
26861 part denotes the kind of list that is requested (e.g.
26863 \begin_inset Flex Code
26866 \begin_layout Plain Layout
26876 \begin_layout Itemize
26877 \begin_inset Flex Code
26880 \begin_layout Plain Layout
26881 %abbrvnames:<nametype>%
26886 : Provides a name list which is abbreviated (with
26887 \begin_inset Quotes eld
26891 \begin_inset Quotes erd
26895 \begin_inset Flex Code
26898 \begin_layout Plain Layout
26907 \begin_layout Itemize
26908 \begin_inset Flex Code
26911 \begin_layout Plain Layout
26912 %fullnames:<nametype>%
26917 : Provides a full name list (never abbreviated with
26918 \begin_inset Quotes eld
26922 \begin_inset Quotes erd
26928 \begin_layout Itemize
26929 \begin_inset Flex Code
26932 \begin_layout Plain Layout
26933 %forceabbrvnames:<nametype>%
26938 : Provides a name list which is always abbreviated (with
26939 \begin_inset Quotes eld
26943 \begin_inset Quotes erd
26947 \begin_inset Flex Code
26950 \begin_layout Plain Layout
26960 \begin_layout Enumerate
26961 Alternative name lists with pre- and surname, if the order of pre- and surname
26962 inside the bibliography item differs (as in:
26963 \begin_inset Quotes eld
26966 Miller, John: Some text, in: Mary Smith, ed.: A volume
26967 \begin_inset Quotes erd
26974 \begin_layout Itemize
26975 \begin_inset Flex Code
26978 \begin_layout Plain Layout
26979 %abbrvbynames:<nametype>%
26984 : Provides a name list which is abbreviated (with
26985 \begin_inset Quotes eld
26989 \begin_inset Quotes erd
26993 \begin_inset Flex Code
26996 \begin_layout Plain Layout
27005 \begin_layout Itemize
27006 \begin_inset Flex Code
27009 \begin_layout Plain Layout
27010 %fullbynames:<nametype>%
27015 : Provides a full name list (never abbreviated with
27016 \begin_inset Quotes eld
27020 \begin_inset Quotes erd
27026 \begin_layout Itemize
27027 \begin_inset Flex Code
27030 \begin_layout Plain Layout
27031 %forceabbrvbynames:<nametype>%
27036 : Provides a name list which is always abbreviated (with
27037 \begin_inset Quotes eld
27041 \begin_inset Quotes erd
27045 \begin_inset Flex Code
27048 \begin_layout Plain Layout
27058 \begin_layout Enumerate
27059 And finally name lists which consist of family names only, as used in author-yea
27061 These do not take a
27062 \begin_inset Flex Code
27065 \begin_layout Plain Layout
27071 part, but always return either an author list or, if this does not exist,
27072 an editor list (as common in author-year labels):
27076 \begin_layout Itemize
27077 \begin_inset Flex Code
27080 \begin_layout Plain Layout
27086 : Provides a name list which is abbreviated (with
27087 \begin_inset Quotes eld
27091 \begin_inset Quotes erd
27095 \begin_inset Flex Code
27098 \begin_layout Plain Layout
27107 \begin_layout Itemize
27108 \begin_inset Flex Code
27111 \begin_layout Plain Layout
27117 : Provides a full name list (never abbreviated with
27118 \begin_inset Quotes eld
27122 \begin_inset Quotes erd
27128 \begin_layout Itemize
27129 \begin_inset Flex Code
27132 \begin_layout Plain Layout
27133 %forceabbrvciteauthor%
27138 : Provides a name list which is always abbreviated (with
27139 \begin_inset Quotes eld
27143 \begin_inset Quotes erd
27147 \begin_inset Flex Code
27150 \begin_layout Plain Layout
27160 \begin_layout Standard
27161 The order of pre- and surname in the former two lists can be adjusted by
27165 \begin_layout Itemize
27166 \begin_inset Flex Code
27169 \begin_layout Plain Layout
27170 !firstnameform %surname%, %prename%
27175 (first author in lists of type 1)
27178 \begin_layout Itemize
27179 \begin_inset Flex Code
27182 \begin_layout Plain Layout
27183 !othernameform %surname%, %prename%
27188 (other authors in lists of type 1)
27191 \begin_layout Itemize
27192 \begin_inset Flex Code
27195 \begin_layout Plain Layout
27196 !firstbynameform %prename% %surname%
27201 (first author in lists of type 2)
27204 \begin_layout Itemize
27205 \begin_inset Flex Code
27208 \begin_layout Plain Layout
27209 !otherbynameform %prename% %surname%
27214 (other authors in lists of type 2)
27217 \begin_layout Standard
27218 This allows you to configure namings like
27219 \begin_inset Quotes eld
27222 Miller, Peter and Mary Smith: \SpecialChar ldots
27223 , in: John Doe and Pat Green, eds.:\SpecialChar ldots
27225 \begin_inset Quotes erd
27231 \begin_layout Standard
27232 There is one other piece of syntax available in definitions, which looks
27234 \begin_inset Flex Code
27237 \begin_layout Plain Layout
27244 This defines a piece of formatting information that is to be used when
27246 \begin_inset Quotes eld
27250 \begin_inset Quotes erd
27254 Obviously, we do not want to output HTML tags when writing plain text,
27255 so they should be wrapped in
27256 \begin_inset Quotes eld
27260 \begin_inset Quotes erd
27264 \begin_inset Quotes eld
27268 \begin_inset Quotes erd
27274 \begin_layout Standard
27275 Two special sorts of definitions are also possible in a
27276 \begin_inset Flex Code
27279 \begin_layout Plain Layout
27286 An example of the first would be:
27289 \begin_layout LyX-Code
27291 \begin_inset Quotes eld
27295 \begin_inset Quotes erd
27301 \begin_layout Standard
27302 This is an abbreviation, or macro, and it can be used by treating it as
27304 \begin_inset Flex Code
27307 \begin_layout Plain Layout
27316 \begin_inset Flex Code
27319 \begin_layout Plain Layout
27325 exactly as it would treat its definition.
27326 So, let us issue the obvious
27334 \begin_layout LyX-Code
27338 \begin_layout Standard
27339 or anything like it.
27341 shouldn't go into an infinite loop, but it may go into a long one before
27345 \begin_layout Standard
27346 The second sort of special definition might look like this:
27349 \begin_layout LyX-Code
27353 \begin_layout Standard
27354 This defines a translatable piece of text, which allows relevant parts of
27355 the bibliography or citation to be translated.
27356 It can be included in a definition by treating it as a key:
27357 \begin_inset Flex Code
27360 \begin_layout Plain Layout
27367 Note that there are two different translation paths: All definitions starting
27369 \begin_inset Flex Code
27372 \begin_layout Plain Layout
27378 , such as in the example above, will be translated to the currently active
27379 buffer language (so the translation will match the generated document).
27380 All definitions starting with underscore only will be translated to the
27382 This is the proper translation for strings that only occur in the dialogs
27383 or on buttons, such as this one:
27386 \begin_layout LyX-Code
27387 _addtobib Add to bibliography only.
27390 \begin_layout Standard
27391 Several of these translatable strings are predefined in
27392 \begin_inset Flex Code
27395 \begin_layout Plain Layout
27402 \begin_inset Flex Code
27405 \begin_layout Plain Layout
27412 Note that these are not macros, in the sense just defined.
27413 They will not be expanded.
27416 \begin_layout Standard
27417 So here then is an example that uses several of these features:
27418 \begin_inset VSpace defskip
27424 \begin_layout Standard
27428 !authoredit {%author%[[%author%, ]][[{%editor%[[%editor%, %B_edtext%, ]]}]]}
27431 \begin_layout Standard
27432 \begin_inset VSpace defskip
27435 This defines a macro that prints the author, followed by a comma, if the
27437 \begin_inset Flex Code
27440 \begin_layout Plain Layout
27446 key is defined, or else prints the name of the editor, followed by the
27448 \begin_inset Flex Code
27451 \begin_layout Plain Layout
27457 or its translation (it is by default
27458 \begin_inset Quotes eld
27462 \begin_inset Quotes erd
27466 \begin_inset Flex Code
27469 \begin_layout Plain Layout
27476 Note that this is in fact defined in
27477 \begin_inset Flex Code
27480 \begin_layout Plain Layout
27486 , so you can use it in your own definitions, or re-definitions, if you load
27490 \begin_layout Section
27491 \begin_inset CommandInset label
27493 name "sec:Tags-for-XHTML"
27497 Tags for XHTML output
27500 \begin_layout Standard
27501 As with \SpecialChar LaTeX
27502 or DocBook, the format of \SpecialChar LyX
27503 's XHTML output is also controlled by
27504 layout information.
27505 In general, \SpecialChar LyX
27506 provides sensible defaults and, as mentioned earlier, it will
27507 even construct default CSS style rules from the other layout tags.
27508 For example, \SpecialChar LyX
27509 will attempt to use the information provided in the
27510 \begin_inset Flex Code
27513 \begin_layout Plain Layout
27519 declaration for the Chapter style to write CSS that will appropriately
27520 format chapter headings.
27523 \begin_layout Standard
27524 In many cases, then, you may not have to do anything at all to get acceptable
27525 XHTML output for your own environments, custom insets, and so forth.
27526 But in some cases you will, and so \SpecialChar LyX
27527 provides a number of layout tags that
27528 can be used to customize the XHTML and CSS that are generated.
27531 \begin_layout Standard
27532 Note that there are two tags,
27533 \begin_inset Flex Code
27536 \begin_layout Plain Layout
27543 \begin_inset Flex Code
27546 \begin_layout Plain Layout
27552 that may appear outside style and inset declarations.
27554 \begin_inset CommandInset ref
27556 reference "subsec:General-text-class"
27560 for details on these.
27563 \begin_layout Subsection
27564 \begin_inset CommandInset label
27566 name "subsec:Paragraph-Style-XHTML"
27573 \begin_layout Standard
27574 The sort of XHTML \SpecialChar LyX
27575 outputs for a paragraph depends upon whether we are dealing
27576 with a normal paragraph, a command, or an environment, where this is itself
27577 determined by the contents of the corresponding
27578 \begin_inset Flex Code
27581 \begin_layout Plain Layout
27592 \begin_layout Standard
27593 For a command or normal paragraph, the output XHTML has the following form:
27596 \begin_layout LyX-Code
27600 \begin_inset Quotes erd
27604 \begin_inset Quotes erd
27610 \begin_layout LyX-Code
27614 \begin_inset Quotes erd
27618 \begin_inset Quotes erd
27624 \begin_layout LyX-Code
27627 Contents of the paragraph.
27630 \begin_layout LyX-Code
27636 \begin_layout Standard
27637 The label tags are of course omitted if the paragraph does not have a label.
27640 \begin_layout Standard
27641 For an environment that is not some sort of list, the XHTML takes this form:
27644 \begin_layout LyX-Code
27648 \begin_inset Quotes erd
27652 \begin_inset Quotes erd
27658 \begin_layout LyX-Code
27662 \begin_inset Quotes erd
27666 \begin_inset Quotes erd
27670 \begin_inset Quotes erd
27674 \begin_inset Quotes erd
27677 >Environment Label</labeltag>First paragraph.</itemtag>
27680 \begin_layout LyX-Code
27683 <itemtag>Second paragraph.</itemtag>
27686 \begin_layout LyX-Code
27692 \begin_layout Standard
27693 Note that the label is output only for the first paragraph, as it should
27694 be for a theorem, for example.
27698 \begin_layout Standard
27699 For a list, we have one of these forms:
27702 \begin_layout LyX-Code
27706 \begin_inset Quotes erd
27710 \begin_inset Quotes erd
27716 \begin_layout LyX-Code
27720 \begin_inset Quotes erd
27724 \begin_inset Quotes erd
27728 \begin_inset Quotes erd
27732 \begin_inset Quotes erd
27735 >List Label</labeltag>First item.</itemtag>
27738 \begin_layout LyX-Code
27742 \begin_inset Quotes erd
27746 \begin_inset Quotes erd
27750 \begin_inset Quotes erd
27754 \begin_inset Quotes erd
27757 >List Label</labeltag>Second item.</itemtag>
27760 \begin_layout LyX-Code
27766 \begin_layout LyX-Code
27770 \begin_layout LyX-Code
27774 \begin_inset Quotes erd
27778 \begin_inset Quotes erd
27784 \begin_layout LyX-Code
27788 \begin_inset Quotes erd
27792 \begin_inset Quotes erd
27795 >List Label</labeltag><itemtag attr=
27796 \begin_inset Quotes erd
27800 \begin_inset Quotes erd
27803 >First item.</itemtag>
27806 \begin_layout LyX-Code
27810 \begin_inset Quotes erd
27814 \begin_inset Quotes erd
27817 >List Label</labeltag><itemtag attr=
27818 \begin_inset Quotes erd
27822 \begin_inset Quotes erd
27825 >Second item.</itemtag>
27828 \begin_layout LyX-Code
27834 \begin_layout Standard
27835 Note the different orders of
27836 \begin_inset Flex Code
27839 \begin_layout Plain Layout
27846 \begin_inset Flex Code
27849 \begin_layout Plain Layout
27856 Which order we get depends upon the setting of
27857 \begin_inset Flex Code
27860 \begin_layout Plain Layout
27867 \begin_inset Flex Code
27870 \begin_layout Plain Layout
27876 is false (the default), you get the first of these, with the label within
27877 the item; if true, you get the second, with the label outside the item.
27880 \begin_layout Standard
27881 The specific tags and attributes output for each paragraph type can be controlle
27882 d by means of the layout tags we are about to describe.
27883 As mentioned earlier, however, \SpecialChar LyX
27884 uses sensible defaults for many of these,
27885 so you often may not need to do very much to get good XHTML output.
27886 Think of the available tags as there so you can tweak things to your liking.
27889 \begin_layout Description
27890 \begin_inset Flex Code
27893 \begin_layout Plain Layout
27900 \begin_inset Flex Code
27903 \begin_layout Plain Layout
27909 ] Specifies attribute information to be output with the main tag.
27911 \begin_inset Quotes eld
27915 \begin_inset Flex Code
27918 \begin_layout Plain Layout
27925 \begin_inset Quotes erd
27929 By default, \SpecialChar LyX
27931 \begin_inset Quotes eld
27935 \begin_inset Flex Code
27938 \begin_layout Plain Layout
27945 \begin_inset Quotes erd
27949 \begin_inset Flex Code
27952 \begin_layout Plain Layout
27958 is the \SpecialChar LyX
27959 name of the layout, made lowercase, for example: chapter.
27964 contain any style information.
27966 \begin_inset Flex Code
27969 \begin_layout Plain Layout
27978 \begin_layout Description
27979 \begin_inset Flex Code
27982 \begin_layout Plain Layout
27989 \begin_inset Flex Code
27992 \begin_layout Plain Layout
28002 ] Whether to output the default CSS information \SpecialChar LyX
28003 generates for this layout,
28004 even if additional information is explicitly provided via
28005 \begin_inset Flex Code
28008 \begin_layout Plain Layout
28016 \begin_inset Flex Code
28019 \begin_layout Plain Layout
28025 allows you to alter or augment the generated CSS, rather than to override
28028 \begin_inset Flex Code
28031 \begin_layout Plain Layout
28040 \begin_layout Description
28041 \begin_inset Flex Code
28044 \begin_layout Plain Layout
28051 \begin_inset Flex Code
28054 \begin_layout Plain Layout
28060 ] The tag to be used for individual paragraphs of environments, replacing
28062 \begin_inset Flex Code
28065 \begin_layout Plain Layout
28071 in the examples above.
28073 \begin_inset Flex Code
28076 \begin_layout Plain Layout
28085 \begin_layout Description
28086 \begin_inset Flex Code
28089 \begin_layout Plain Layout
28096 \begin_inset Flex Code
28099 \begin_layout Plain Layout
28105 ] Attributes for the item tag.
28107 \begin_inset Newline newline
28111 \begin_inset Quotes eld
28115 \begin_inset Flex Code
28118 \begin_layout Plain Layout
28119 class=`layoutname_item'
28125 \begin_inset Quotes erd
28133 contain any style information.
28135 \begin_inset Flex Code
28138 \begin_layout Plain Layout
28147 \begin_layout Description
28148 \begin_inset Flex Code
28151 \begin_layout Plain Layout
28158 \begin_inset Flex Code
28161 \begin_layout Plain Layout
28167 ] The tag to be used for paragraph and item labels, replacing
28168 \begin_inset Flex Code
28171 \begin_layout Plain Layout
28177 in the examples above.
28179 \begin_inset Flex Code
28182 \begin_layout Plain Layout
28189 \begin_inset Flex Code
28192 \begin_layout Plain Layout
28199 \begin_inset Flex Code
28202 \begin_layout Plain Layout
28209 \begin_inset Flex Code
28212 \begin_layout Plain Layout
28213 Centered_Top_Environment
28218 , in which case it defaults to
28219 \begin_inset Flex Code
28222 \begin_layout Plain Layout
28231 \begin_layout Description
28232 \begin_inset Flex Code
28235 \begin_layout Plain Layout
28242 \begin_inset Flex Code
28245 \begin_layout Plain Layout
28251 ] Attributes for the label tag.
28253 \begin_inset Newline newline
28257 \begin_inset Quotes eld
28261 \begin_inset Flex Code
28264 \begin_layout Plain Layout
28265 class=`layoutname_label'
28271 \begin_inset Quotes erd
28279 contain any style information.
28281 \begin_inset Flex Code
28284 \begin_layout Plain Layout
28293 \begin_layout Description
28294 \begin_inset Flex Code
28297 \begin_layout Plain Layout
28304 \begin_inset Flex Code
28307 \begin_layout Plain Layout
28317 ] Meaningful only for list-like environments, this tag controls whether
28318 the label tag is output before or inside the item tag.
28319 This is used, for example, in the description environment, where we want
28321 \begin_inset Flex Code
28324 \begin_layout Plain Layout
28325 <dt>\SpecialChar ldots
28326 </dt><dd>\SpecialChar ldots
28334 \begin_inset Flex Code
28337 \begin_layout Plain Layout
28343 : The label tag is output inside the item tag.
28346 \begin_layout Description
28347 \begin_inset Flex Code
28350 \begin_layout Plain Layout
28356 Information to be output in the
28357 \begin_inset Flex Code
28360 \begin_layout Plain Layout
28366 section when this style is used.
28367 This might, for example, be used to include a
28368 \begin_inset Flex Code
28371 \begin_layout Plain Layout
28378 \begin_inset Flex Code
28381 \begin_layout Plain Layout
28390 \begin_layout Description
28391 \begin_inset Flex Code
28394 \begin_layout Plain Layout
28400 CSS style information to be included when this style is used.
28401 Note that this will automatically be wrapped in a layout-generated
28402 \begin_inset Flex Code
28405 \begin_layout Plain Layout
28411 block, so only the CSS itself need be included.
28413 \begin_inset Flex Code
28416 \begin_layout Plain Layout
28425 \begin_layout Description
28426 \begin_inset Flex Code
28429 \begin_layout Plain Layout
28436 \begin_inset Flex Code
28439 \begin_layout Plain Layout
28445 ] The tag to be used for the main label, replacing
28446 \begin_inset Flex Code
28449 \begin_layout Plain Layout
28455 in the examples above.
28457 \begin_inset Flex Code
28460 \begin_layout Plain Layout
28469 \begin_layout Description
28470 \begin_inset Flex Code
28473 \begin_layout Plain Layout
28480 \begin_inset Flex Code
28483 \begin_layout Plain Layout
28493 ] Marks this style as the one to be used to generate the
28494 \begin_inset Flex Code
28497 \begin_layout Plain Layout
28503 tag for the XHTML file.
28504 By default, it is false.
28506 \begin_inset Flex Code
28509 \begin_layout Plain Layout
28515 file sets it to true for the
28516 \begin_inset Flex Code
28519 \begin_layout Plain Layout
28529 \begin_layout Subsection
28533 \begin_layout Standard
28534 The XHTML output of insets can also be controlled by information in layout
28539 \begin_layout Plain Layout
28540 At present, this is true only for
28541 \begin_inset Quotes eld
28545 \begin_inset Quotes erd
28548 insets (insets you can type into) and is not true for
28549 \begin_inset Quotes eld
28553 \begin_inset Quotes erd
28556 insets (insets that are associated with dialog boxes).
28561 Here, too, \SpecialChar LyX
28562 tries to provide sensible defaults, and it constructs default
28564 But everything can be customized.
28567 \begin_layout Standard
28568 The XHTML \SpecialChar LyX
28569 outputs for an inset has the following form:
28572 \begin_layout LyX-Code
28574 \begin_inset Quotes erd
28578 \begin_inset Quotes erd
28584 \begin_layout LyX-Code
28585 <labeltag>Label</labeltag>
28588 \begin_layout LyX-Code
28590 \begin_inset Quotes erd
28594 \begin_inset Quotes erd
28597 >Contents of the inset.</innertag>
28600 \begin_layout LyX-Code
28604 \begin_layout Standard
28605 If the inset permits multiple paragraphs—that is, if
28606 \begin_inset Flex Code
28609 \begin_layout Plain Layout
28615 is true—then the contents of the inset will itself be output as paragraphs
28616 formatted according to the styles used for those paragraphs (standard,
28617 quote, and the like).
28618 The label tag is of course omitted if the paragraph does not have a label
28619 and, at present, is always
28620 \begin_inset Flex Code
28623 \begin_layout Plain Layout
28630 The inner tag is optional and, by default, does not appear.
28633 \begin_layout Standard
28634 The specific tags and attributes output for each inset can be controlled
28635 by means of the following layout tags.
28638 \begin_layout Description
28639 \begin_inset Flex Code
28642 \begin_layout Plain Layout
28649 \begin_inset Flex Code
28652 \begin_layout Plain Layout
28658 ] Specifies attribute information to be output with the main tag.
28660 \begin_inset Quotes eld
28664 \begin_inset Flex Code
28667 \begin_layout Plain Layout
28668 class=`myinset' onclick=`\SpecialChar ldots
28675 \begin_inset Quotes erd
28679 By default, \SpecialChar LyX
28681 \begin_inset Quotes eld
28685 \begin_inset Flex Code
28688 \begin_layout Plain Layout
28695 \begin_inset Quotes erd
28699 \begin_inset Flex Code
28702 \begin_layout Plain Layout
28708 is the \SpecialChar LyX
28709 name of the inset, made lowercase and with non-alphanumeric characters
28710 converted to underscores, for example: footnote.
28713 \begin_layout Description
28714 \begin_inset Flex Code
28717 \begin_layout Plain Layout
28724 \begin_inset Flex Code
28727 \begin_layout Plain Layout
28737 ] Whether to output the default CSS information \SpecialChar LyX
28738 generates for this layout,
28739 even if additional information is explicitly provided via
28740 \begin_inset Flex Code
28743 \begin_layout Plain Layout
28751 \begin_inset Flex Code
28754 \begin_layout Plain Layout
28760 allows you to alter or augment the generated CSS, rather than to override
28765 \begin_layout Description
28766 \begin_inset Flex Code
28769 \begin_layout Plain Layout
28776 \begin_inset Flex Code
28779 \begin_layout Plain Layout
28785 ] Attributes for the inner tag.
28787 \begin_inset Newline newline
28791 \begin_inset Quotes eld
28795 \begin_inset Flex Code
28798 \begin_layout Plain Layout
28799 class=`insetname_inner'
28805 \begin_inset Quotes erd
28811 \begin_layout Description
28812 \begin_inset Flex Code
28815 \begin_layout Plain Layout
28822 \begin_inset Flex Code
28825 \begin_layout Plain Layout
28831 ] The inner tag, replacing
28832 \begin_inset Flex Code
28835 \begin_layout Plain Layout
28841 in the examples above.
28842 By default, there is none.
28845 \begin_layout Description
28846 \begin_inset Flex Code
28849 \begin_layout Plain Layout
28856 \begin_inset Flex Code
28859 \begin_layout Plain Layout
28867 ] Whether this inset represents a standalone block of text (such as a footnote)
28868 or instead represents material that is included in the surrounding text
28869 (such as a branch).
28873 \begin_layout Description
28874 \begin_inset Flex Code
28877 \begin_layout Plain Layout
28884 \begin_inset Flex Code
28887 \begin_layout Plain Layout
28893 ] A label for this inset, possibly including a reference to a counter.
28894 For example, for footnote, it might be:
28895 \begin_inset Flex Code
28898 \begin_layout Plain Layout
28907 This is optional, and there is no default.
28910 \begin_layout Description
28911 \begin_inset Flex Code
28914 \begin_layout Plain Layout
28920 Information to be output in the
28921 \begin_inset Flex Code
28924 \begin_layout Plain Layout
28930 section when this style is used.
28931 This might, for example, be used to include a
28932 \begin_inset Flex Code
28935 \begin_layout Plain Layout
28942 \begin_inset Flex Code
28945 \begin_layout Plain Layout
28954 \begin_layout Description
28955 \begin_inset Flex Code
28958 \begin_layout Plain Layout
28964 CSS style information to be included when this style is used.
28965 Note that this will automatically be wrapped in a layout-generated
28966 \begin_inset Flex Code
28969 \begin_layout Plain Layout
28975 block, so only the CSS itself need be included.
28978 \begin_layout Description
28979 \begin_inset Flex Code
28982 \begin_layout Plain Layout
28989 \begin_inset Flex Code
28992 \begin_layout Plain Layout
28998 ] The tag to be used for the main label, replacing
28999 \begin_inset Flex Code
29002 \begin_layout Plain Layout
29008 in the examples above.
29009 The default depends upon the setting of
29010 \begin_inset Flex Code
29013 \begin_layout Plain Layout
29020 \begin_inset Flex Code
29023 \begin_layout Plain Layout
29029 is true, the default is
29030 \begin_inset Flex Code
29033 \begin_layout Plain Layout
29039 ; if it is false, the default is
29040 \begin_inset Flex Code
29043 \begin_layout Plain Layout
29052 \begin_layout Subsection
29056 \begin_layout Standard
29057 The XHTML output for floats too can be controlled by layout information.
29058 The output has the following form:
29061 \begin_layout LyX-Code
29063 \begin_inset Quotes erd
29067 \begin_inset Quotes erd
29073 \begin_layout LyX-Code
29074 Contents of the float.
29077 \begin_layout LyX-Code
29081 \begin_layout Standard
29082 The caption, if there is one, is a separate inset and will be output as
29084 Its appearance can be controlled via the InsetLayout for caption insets.
29088 \begin_layout Description
29089 \begin_inset Flex Code
29092 \begin_layout Plain Layout
29099 \begin_inset Flex Code
29102 \begin_layout Plain Layout
29108 ] Specifies attribute information to be output with the main tag.
29110 \begin_inset Quotes eld
29114 \begin_inset Flex Code
29117 \begin_layout Plain Layout
29118 class=`myfloat' onclick=`\SpecialChar ldots
29125 \begin_inset Quotes erd
29129 By default, \SpecialChar LyX
29131 \begin_inset Quotes eld
29135 \begin_inset Flex Code
29138 \begin_layout Plain Layout
29139 class=`float float-floattype'
29145 \begin_inset Quotes erd
29149 \begin_inset Flex Code
29152 \begin_layout Plain Layout
29158 is \SpecialChar LyX
29159 's name for this type of float, as determined by the float declaration
29161 \begin_inset CommandInset ref
29163 reference "subsec:Floats"
29167 ), though made lowercase and with non-alphanumeric characters converted
29168 to underscores, for example: float-table.
29171 \begin_layout Description
29172 \begin_inset Flex Code
29175 \begin_layout Plain Layout
29181 CSS style information to be included when this float is used.
29182 Note that this will automatically be wrapped in a layout-generated
29183 \begin_inset Flex Code
29186 \begin_layout Plain Layout
29192 block, so only the CSS itself need be included.
29195 \begin_layout Description
29196 \begin_inset Flex Code
29199 \begin_layout Plain Layout
29206 \begin_inset Flex Code
29209 \begin_layout Plain Layout
29215 ] The tag to be used for this float, replacing
29216 \begin_inset Quotes eld
29220 \begin_inset Flex Code
29223 \begin_layout Plain Layout
29230 \begin_inset Quotes erd
29233 in the example above.
29235 \begin_inset Flex Code
29238 \begin_layout Plain Layout
29244 and will rarely need changing.
29247 \begin_layout Subsection
29248 Bibliography formatting
29251 \begin_layout Standard
29252 The bibliography can be formatted using
29253 \begin_inset Flex Code
29256 \begin_layout Plain Layout
29264 \begin_inset CommandInset ref
29266 reference "subsec:Citation-format-description"
29273 \begin_layout Subsection
29278 \begin_layout Standard
29279 We have several times mentioned that \SpecialChar LyX
29280 will generate default CSS style rules
29281 for both insets and paragraph styles, based upon the other layout information
29283 In this section, we shall say a word about which layout information \SpecialChar LyX
29288 \begin_layout Standard
29289 At present, \SpecialChar LyX
29290 auto-generates CSS only for font information, making use of
29292 \begin_inset Flex Code
29295 \begin_layout Plain Layout
29302 \begin_inset Flex Code
29305 \begin_layout Plain Layout
29312 \begin_inset Flex Code
29315 \begin_layout Plain Layout
29322 \begin_inset Flex Code
29325 \begin_layout Plain Layout
29332 \begin_inset Flex Code
29335 \begin_layout Plain Layout
29342 \begin_inset CommandInset ref
29344 reference "subsec:Font-description"
29349 The translation is mostly straightforward and obvious.
29351 \begin_inset Quotes eld
29355 \begin_inset Flex Code
29358 \begin_layout Plain Layout
29365 \begin_inset Quotes erd
29369 \begin_inset Quotes eld
29373 \begin_inset Flex Code
29376 \begin_layout Plain Layout
29377 font-family: sans-serif;
29383 \begin_inset Quotes erd
29387 The correspondence of \SpecialChar LyX
29388 sizes and CSS sizes is a little less obvious but
29389 nonetheless intuitive.
29391 \begin_inset Flex Code
29394 \begin_layout Plain Layout
29401 \begin_inset Flex URL
29404 \begin_layout Plain Layout
29412 \change_inserted -970929547 1496610908
29416 \begin_layout Section
29418 \change_inserted -970929547 1496610966
29419 \begin_inset CommandInset label
29421 name "sec:Tags-for-DocBook"
29425 Tags for DocBook output
29428 \begin_layout Standard
29430 \change_inserted -970929547 1496611615
29431 As with \SpecialChar LaTeX
29432 or XHTML, the format of \SpecialChar LyX
29433 's DocBook output is also controlled by
29434 layout information.
29435 In general, \SpecialChar LyX
29436 provides sensible defaults; however, much of the styling is
29437 lost during the conversion, as DocBook is strictly semantic and does not
29439 When possible, information from \SpecialChar LyX
29440 will be rendered in
29448 \begin_layout Standard
29450 \change_inserted -970929547 1496612080
29451 In many cases, then, you may not have to do anything at all to get acceptable
29452 DocBook output for your own environments, custom insets, and so forth.
29453 But in some cases you will, and so \SpecialChar LyX
29454 provides a number of layout tags that
29455 can be used to customize the DocBook that is generated.
29458 \begin_layout Standard
29460 \change_inserted -970929547 1515109912
29461 Labels are rarely output, as they are redundant in DocBook: this information
29462 is carried by the tags themselves, and whether labels appear in the final
29463 documents (after processing of DocBook files) is controlled by the stylesheets.
29464 However, sometimes, labels are not redundant content, such as definition
29465 lists: in this case, the term being defined will be the label.
29469 \begin_layout Subsection
29471 \change_inserted 1075283030 1597699417
29472 \begin_inset CommandInset label
29474 name "subsec:Paragraph-Style-DocBook"
29479 \change_deleted 1075283030 1597699417
29481 \begin_inset CommandInset label
29483 name "subsec:Paragraph-Style-XHTML-1"
29488 \change_inserted -970929547 1496610966
29492 \begin_layout Standard
29494 \change_inserted -970929547 1496612059
29495 The sort of DocBook \SpecialChar LyX
29496 outputs for a paragraph depends upon whether we are
29497 dealing with a normal paragraph, a command, or an environment, where this
29498 is itself determined by the contents of the corresponding
29499 \begin_inset Flex Code
29502 \begin_layout Plain Layout
29504 \change_inserted -970929547 1496610966
29517 \begin_layout Standard
29519 \change_inserted -970929547 1496612107
29520 For a command or normal paragraph, the output DocBook has the following
29524 \begin_layout LyX-Code
29526 \change_inserted -970929547 1515109666
29530 \begin_layout LyX-Code
29532 \change_inserted -970929547 1496610966
29533 Contents of the paragraph.
29536 \begin_layout LyX-Code
29538 \change_inserted -970929547 1496610966
29542 \begin_layout Standard
29544 \change_inserted -970929547 1515109821
29545 For an environment that is not some sort of list, the generated DocBook
29549 \begin_layout LyX-Code
29551 \change_inserted -970929547 1515109671
29555 \begin_layout LyX-Code
29557 \change_inserted -970929547 1496612114
29558 <itemtag>First paragraph.</itemtag>
29561 \begin_layout LyX-Code
29563 \change_inserted -970929547 1496610966
29564 <itemtag>Second paragraph.</itemtag>
29567 \begin_layout LyX-Code
29569 \change_inserted -970929547 1496610966
29573 \begin_layout Standard
29575 \change_inserted -970929547 1515109825
29576 For a list, the resulting DocBook takes this form:
29579 \begin_layout LyX-Code
29581 \change_inserted -970929547 1515109672
29585 \begin_layout LyX-Code
29587 \change_inserted -970929547 1515109676
29588 <itemtag attr>First item.</itemtag>
29591 \begin_layout LyX-Code
29593 \change_inserted -970929547 1515109678
29594 <itemtag attr>Second item.</itemtag>
29597 \begin_layout LyX-Code
29599 \change_inserted -970929547 1496610966
29603 \begin_layout Standard
29605 \change_inserted -970929547 1496612243
29606 The specific tags and roles output for each paragraph type can be controlled
29607 by means of the layout tags we are about to describe.
29608 Please note that, due to the very nature of DocBook, no sensible defaults
29609 really exist, and the values must always be carefully chosen.
29613 \begin_layout Description
29615 \change_inserted -970929547 1515110057
29616 \begin_inset Flex Code
29619 \begin_layout Plain Layout
29621 \change_inserted -970929547 1515109656
29630 \begin_inset Flex Code
29633 \begin_layout Plain Layout
29635 \change_inserted -970929547 1496610966
29643 ] Specifies attribute information to be output with the main tag, replacing
29645 \begin_inset Quotes eld
29649 \begin_inset Flex Code
29652 \begin_layout Plain Layout
29654 \change_inserted -970929547 1515110057
29663 \begin_inset Quotes erd
29666 in the example above.
29667 This information can be used in further processing of the DocBook files.
29673 \begin_layout Description
29675 \change_inserted -970929547 1496612296
29676 \begin_inset Flex Code
29679 \begin_layout Plain Layout
29681 \change_inserted -970929547 1496612269
29690 \begin_inset Flex Code
29693 \begin_layout Plain Layout
29695 \change_inserted -970929547 1496610966
29703 ] The tag to be used for this inset, replacing
29704 \begin_inset Quotes eld
29708 \begin_inset Flex Code
29711 \begin_layout Plain Layout
29713 \change_inserted -970929547 1496612296
29722 \begin_inset Quotes erd
29725 in the example above.
29726 The default is the name of the float and always needs to be changed, as
29727 DocBook provides no generic tag.
29728 \change_inserted 1075283030 1597698868
29732 \begin_layout Description
29734 \change_inserted 1075283030 1597699399
29735 \begin_inset Flex Code
29738 \begin_layout Plain Layout
29740 \change_inserted 1075283030 1597698872
29749 \begin_inset Flex Code
29752 \begin_layout Plain Layout
29754 \change_inserted 1075283030 1597700585
29755 block, paragraph, inline
29762 ] The new-line policy for this tag, see Section
29763 \begin_inset space ~
29767 \begin_inset CommandInset ref
29769 reference "subsec:DocBook-New-line-policy"
29782 \begin_layout Subsection
29784 \change_inserted 1075283030 1597699385
29786 \begin_inset CommandInset label
29788 name "subsec:DocBook-New-line-policy"
29795 \begin_layout Standard
29797 \change_inserted 1075283030 1597698993
29798 For all tags, there are three possible policies for outputting new lines
29800 \begin_inset Flex Code
29803 \begin_layout Plain Layout
29805 \change_inserted 1075283030 1597698987
29816 \begin_layout Itemize
29818 \change_inserted 1075283030 1597699279
29819 \begin_inset Quotes eld
29823 \begin_inset Flex Code
29826 \begin_layout Plain Layout
29828 \change_inserted 1075283030 1597699012
29837 \begin_inset Quotes erd
29840 : the opening and closing tags are on their own lines (i.e.
29841 a line feed after and before the opening and the closing tags).
29842 Typical elements are floats.
29846 \begin_layout LyX-Code
29848 \change_inserted 1075283030 1597699194
29852 \begin_layout LyX-Code
29854 \change_inserted 1075283030 1597699194
29858 \begin_layout LyX-Code
29860 \change_inserted 1075283030 1597699098
29861 Contents of the block.
29864 \begin_layout LyX-Code
29866 \change_inserted 1075283030 1597699196
29870 \begin_layout LyX-Code
29872 \change_inserted 1075283030 1597699198
29876 \begin_layout Itemize
29878 \change_inserted 1075283030 1597699289
29879 \begin_inset Quotes eld
29883 \begin_inset Flex Code
29886 \begin_layout Plain Layout
29888 \change_inserted 1075283030 1597699113
29897 \begin_inset Quotes erd
29900 : the opening and closing tags are on the same, new line; a line feed is
29901 output before the opening tag and after the closing tag.
29902 Typical elements are paragraphs and list items.
29906 \begin_layout LyX-Code
29908 \change_inserted 1075283030 1597699186
29912 \begin_layout LyX-Code
29914 \change_inserted 1075283030 1597699357
29915 <paratag>Contents of the paragraph.</paratag>
29918 \begin_layout LyX-Code
29920 \change_inserted 1075283030 1597699231
29924 \begin_layout Itemize
29926 \change_inserted 1075283030 1597699343
29927 \begin_inset Quotes eld
29931 \begin_inset Flex Code
29934 \begin_layout Plain Layout
29936 \change_inserted 1075283030 1597699307
29945 \begin_inset Quotes erd
29948 : the opening and closing tags are on the same line as the rest of the content.
29949 No line feeds are output.
29950 Typical elements are fonts.
29954 \begin_layout LyX-Code
29956 \change_inserted 1075283030 1597699585
29957 Content before<inlinetag>Contents of the paragraph.</inlinetag>Content after
29960 \begin_layout Standard
29962 \change_inserted 1075283030 1597699585
29963 The default value is always
29964 \begin_inset Quotes eld
29968 \begin_inset Flex Code
29971 \begin_layout Plain Layout
29973 \change_inserted 1075283030 1597699585
29982 \begin_inset Quotes erd
29990 \begin_layout Subsection
29992 \change_inserted -970929547 1515111533
29993 InsetLayout DocBook
29998 \begin_layout Standard
30000 \change_inserted -970929547 1496611894
30001 The DocBook output of insets can also be controlled by information in layout
30005 \begin_layout Standard
30007 \change_inserted -970929547 1496612045
30008 The DocBook \SpecialChar LyX
30009 outputs for an inset has the following form:
30012 \begin_layout LyX-Code
30014 \change_inserted -970929547 1515110861
30015 <wrappertag wrapperattr>
30018 \begin_layout LyX-Code
30020 \change_inserted -970929547 1515110868
30024 \begin_layout LyX-Code
30026 \change_inserted -970929547 1515110869
30027 <innertag innerattr>
30030 \begin_layout LyX-Code
30032 \change_inserted -970929547 1515110869
30033 Contents of the inset.
30036 \begin_layout LyX-Code
30038 \change_inserted -970929547 1515110870
30042 \begin_layout LyX-Code
30044 \change_inserted -970929547 1515110871
30048 \begin_layout LyX-Code
30050 \change_inserted -970929547 1515111172
30054 \begin_layout Standard
30056 \change_inserted -970929547 1515111186
30057 For an itemising inset, it rather looks like this:
30060 \begin_layout LyX-Code
30062 \change_inserted -970929547 1515111186
30063 <wrappertag wrapperattr>
30066 \begin_layout LyX-Code
30068 \change_inserted -970929547 1515111186
30072 \begin_layout LyX-Code
30074 \change_inserted -970929547 1515111186
30075 <innertag innerattr>
30078 \begin_layout LyX-Code
30080 \change_inserted -970929547 1515111362
30081 <itemwrappertag itemwrapperattr>
30084 \begin_layout LyX-Code
30086 \change_inserted -970929547 1515111364
30087 <itemlabeltag itemattr>
30090 \begin_layout LyX-Code
30092 \change_inserted -970929547 1515111367
30093 Label of the first item.
30096 \begin_layout LyX-Code
30098 \change_inserted -970929547 1515111362
30104 \begin_layout LyX-Code
30106 \change_inserted -970929547 1515111517
30110 \begin_layout LyX-Code
30112 \change_inserted -970929547 1515111517
30118 \begin_layout LyX-Code
30120 \change_inserted -970929547 1515111516
30121 Contents of the first item.
30124 \begin_layout LyX-Code
30126 \change_inserted -970929547 1515111514
30132 \begin_layout LyX-Code
30134 \change_inserted -970929547 1515111247
30140 \begin_layout LyX-Code
30142 \change_inserted -970929547 1515111221
30146 \begin_layout LyX-Code
30148 \change_inserted -970929547 1515111370
30149 <itemwrappertag itemwrapperattr>
30152 \begin_layout LyX-Code
30154 \change_inserted -970929547 1515111370
30155 <itemlabeltag itemattr>
30158 \begin_layout LyX-Code
30160 \change_inserted -970929547 1515111372
30161 Label of the second item.
30164 \begin_layout LyX-Code
30166 \change_inserted -970929547 1515111370
30172 \begin_layout LyX-Code
30174 \change_inserted -970929547 1515111504
30178 \begin_layout LyX-Code
30180 \change_inserted -970929547 1515111505
30186 \begin_layout LyX-Code
30188 \change_inserted -970929547 1515111507
30189 Contents of the second item.
30192 \begin_layout LyX-Code
30194 \change_inserted -970929547 1515111509
30200 \begin_layout LyX-Code
30202 \change_inserted -970929547 1515111251
30208 \begin_layout LyX-Code
30210 \change_inserted -970929547 1515111221
30216 \begin_layout LyX-Code
30218 \change_inserted -970929547 1515111219
30224 \begin_layout LyX-Code
30226 \change_inserted -970929547 1515111186
30230 \begin_layout LyX-Code
30232 \change_inserted -970929547 1515111186
30236 \begin_layout LyX-Code
30238 \change_inserted -970929547 1515111186
30242 \begin_layout Standard
30244 \change_inserted -970929547 1515111183
30245 If the inset permits multiple paragraphs—that is, if
30246 \begin_inset Flex Code
30249 \begin_layout Plain Layout
30251 \change_inserted -970929547 1496610966
30259 is true—then the contents of the inset will
30260 \change_deleted 34634807 1620029217
30262 \change_inserted 34634807 1620029219
30264 \change_inserted -970929547 1515111183
30265 be output as paragraphs formatted according to the styles used for those
30266 paragraphs (standard, quote, and the like).
30267 The inner tag is optional and, by default, does not appear.
30270 \begin_layout Standard
30272 \change_inserted -970929547 1496610966
30273 The specific tags and attributes output for each inset can be controlled
30274 by means of the following layout tags.
30277 \begin_layout Description
30279 \change_inserted -970929547 1515110317
30280 \begin_inset Flex Code
30283 \begin_layout Plain Layout
30285 \change_inserted -970929547 1515109695
30294 \begin_inset Flex Code
30297 \begin_layout Plain Layout
30299 \change_inserted -970929547 1496611854
30307 ] Specifies attribute information to be output with the main tag, replacing
30309 \begin_inset Quotes eld
30313 \begin_inset Flex Code
30316 \begin_layout Plain Layout
30318 \change_inserted -970929547 1515110044
30327 \begin_inset Quotes erd
30330 in the example above.
30331 This information can be used in further processing of the DocBook files.
30335 \begin_layout Description
30337 \change_inserted -970929547 1515110973
30338 \begin_inset Flex Code
30341 \begin_layout Plain Layout
30343 \change_inserted -970929547 1515110319
30352 \begin_inset Flex Code
30355 \begin_layout Plain Layout
30357 \change_inserted -970929547 1515110384
30358 never, always, maybe
30365 ] Specifies whether this tag goes into the
30366 \begin_inset Flex Code
30369 \begin_layout Plain Layout
30371 \change_inserted -970929547 1515110412
30379 tag at the beginning of the parent layout.
30381 \begin_inset Flex Code
30384 \begin_layout Plain Layout
30386 \change_inserted -970929547 1515110437
30394 indicates that the tag never goes into
30395 \begin_inset Flex Code
30398 \begin_layout Plain Layout
30400 \change_inserted -970929547 1515110497
30408 (this is default value, and corresponds to usual content).
30410 \begin_inset Flex Code
30413 \begin_layout Plain Layout
30415 \change_inserted -970929547 1515110517
30423 indicates that the tag always goes into
30424 \begin_inset Flex Code
30427 \begin_layout Plain Layout
30429 \change_inserted -970929547 1515110514
30437 (this corresponds to usual metadata): if there is no
30438 \begin_inset Flex Code
30441 \begin_layout Plain Layout
30443 \change_inserted -970929547 1515110550
30451 tag for the parent, one
30457 \begin_inset Flex Code
30460 \begin_layout Plain Layout
30462 \change_inserted -970929547 1515110540
30470 indicates that the tag may go into
30471 \begin_inset Flex Code
30474 \begin_layout Plain Layout
30476 \change_inserted -970929547 1515110538
30484 (this is only the case for titles): if there is no
30485 \begin_inset Flex Code
30488 \begin_layout Plain Layout
30490 \change_inserted -970929547 1515110585
30498 tag for the parent,
30502 will be generated, the corresponding tag will be output directly as content.
30506 \begin_layout Description
30508 \change_inserted -970929547 1515111461
30509 \begin_inset Flex Code
30512 \begin_layout Plain Layout
30514 \change_inserted -970929547 1515110974
30523 \begin_inset Flex Code
30526 \begin_layout Plain Layout
30528 \change_inserted -970929547 1515110973
30536 ] Specifies attribute information to be output with the item tag, replacing
30538 \begin_inset Quotes eld
30542 \begin_inset Flex Code
30545 \begin_layout Plain Layout
30547 \change_inserted -970929547 1515110984
30556 \begin_inset Quotes erd
30559 in the example above.
30560 This information can be used in further processing of the DocBook files.
30564 \begin_layout Description
30566 \change_inserted -970929547 1515111471
30567 \begin_inset Flex Code
30570 \begin_layout Plain Layout
30572 \change_inserted -970929547 1515111465
30573 DocBookItemInnerAttr
30581 \begin_inset Flex Code
30584 \begin_layout Plain Layout
30586 \change_inserted -970929547 1515111461
30594 ] Specifies attribute information to be output with the item inner tag,
30596 \begin_inset Quotes eld
30600 \begin_inset Flex Code
30603 \begin_layout Plain Layout
30605 \change_inserted -970929547 1515111476
30614 \begin_inset Quotes erd
30617 in the example above.
30618 This information can be used in further processing of the DocBook files.
30622 \begin_layout Description
30624 \change_inserted -970929547 1515111494
30625 \begin_inset Flex Code
30628 \begin_layout Plain Layout
30630 \change_inserted -970929547 1515111467
30631 DocBookItemInnerTag
30639 \begin_inset Flex Code
30642 \begin_layout Plain Layout
30644 \change_inserted -970929547 1515111461
30652 ] The tag to be used for the item inner tag within the inset, replacing
30654 \begin_inset Quotes eld
30658 \begin_inset Flex Code
30661 \begin_layout Plain Layout
30663 \change_inserted -970929547 1515111486
30672 \begin_inset Quotes erd
30675 in the example above.
30677 \begin_inset Flex Code
30680 \begin_layout Plain Layout
30682 \change_inserted -970929547 1515111461
30690 , indicating that there is no item inner tag: content is directly output
30691 without it for each itemised element.
30692 This parameter only makes sense when itemising layouts are used, such as
30695 \change_inserted 1075283030 1598469472
30696 The most likely value is
30697 \begin_inset Quotes eld
30701 \begin_inset Flex Code
30704 \begin_layout Plain Layout
30706 \change_inserted 1075283030 1598469476
30715 \begin_inset Quotes erd
30719 \begin_inset Newline newline
30722 When a list item is split using a new line, the item inner tag will be repeated
30723 for each part of the paragraph, parts being separated by new lines.
30727 \begin_layout Description
30729 \change_inserted 1075283030 1597699866
30730 \begin_inset Flex Code
30733 \begin_layout Plain Layout
30735 \change_inserted 1075283030 1597699853
30736 DocBookItemInnerTagType
30744 \begin_inset Flex Code
30747 \begin_layout Plain Layout
30749 \change_inserted 1075283030 1597699866
30750 block, paragraph, inline
30757 ] The new-line policy for this tag, see Section
30758 \begin_inset space ~
30762 \begin_inset CommandInset ref
30764 reference "subsec:DocBook-New-line-policy"
30777 \begin_layout Description
30779 \change_inserted -970929547 1515111290
30780 \begin_inset Flex Code
30783 \begin_layout Plain Layout
30785 \change_inserted -970929547 1515111283
30786 DocBookItemLabelAttr
30794 \begin_inset Flex Code
30797 \begin_layout Plain Layout
30799 \change_inserted -970929547 1515111279
30807 ] Specifies attribute information to be output with the item label tag,
30809 \begin_inset Quotes eld
30813 \begin_inset Flex Code
30816 \begin_layout Plain Layout
30818 \change_inserted -970929547 1515111304
30827 \begin_inset Quotes erd
30830 in the example above.
30831 This information can be used in further processing of the DocBook files.
30835 \begin_layout Description
30837 \change_inserted -970929547 1515111337
30838 \begin_inset Flex Code
30841 \begin_layout Plain Layout
30843 \change_inserted -970929547 1515111285
30844 DocBookItemLabelTag
30852 \begin_inset Flex Code
30855 \begin_layout Plain Layout
30857 \change_inserted -970929547 1515111279
30865 ] The tag to be used for the item label tag within the inset, replacing
30867 \begin_inset Quotes eld
30871 \begin_inset Flex Code
30874 \begin_layout Plain Layout
30876 \change_inserted -970929547 1515111311
30885 \begin_inset Quotes erd
30888 in the example above.
30889 This parameter only makes sense when itemising layouts are used with a
30890 notion of labels, such as definition lists.
30892 \change_inserted 1075283030 1597699874
30896 \begin_layout Description
30898 \change_inserted 1075283030 1597699874
30899 \begin_inset Flex Code
30902 \begin_layout Plain Layout
30904 \change_inserted 1075283030 1597699880
30905 DocBookItemLabelTagType
30913 \begin_inset Flex Code
30916 \begin_layout Plain Layout
30918 \change_inserted 1075283030 1597699874
30919 block, paragraph, inline
30926 ] The new-line policy for this tag, see Section
30927 \begin_inset space ~
30931 \begin_inset CommandInset ref
30933 reference "subsec:DocBook-New-line-policy"
30946 \begin_layout Description
30948 \change_inserted -970929547 1515111124
30949 \begin_inset Flex Code
30952 \begin_layout Plain Layout
30954 \change_inserted -970929547 1515111060
30963 \begin_inset Flex Code
30966 \begin_layout Plain Layout
30968 \change_inserted -970929547 1515111060
30976 ] The tag to be used for the item tag within the inset, replacing
30977 \begin_inset Quotes eld
30981 \begin_inset Flex Code
30984 \begin_layout Plain Layout
30986 \change_inserted -970929547 1515111060
30995 \begin_inset Quotes erd
30998 in the example above.
31000 \begin_inset Flex Code
31003 \begin_layout Plain Layout
31005 \change_inserted -970929547 1515111060
31013 , indicating that there is no item tag.
31014 This parameter only makes sense when itemising layouts are used, such as
31017 \change_inserted 1075283030 1597699890
31021 \begin_layout Description
31023 \change_inserted 1075283030 1597699890
31024 \begin_inset Flex Code
31027 \begin_layout Plain Layout
31029 \change_inserted 1075283030 1597699890
31038 \begin_inset Flex Code
31041 \begin_layout Plain Layout
31043 \change_inserted 1075283030 1597699890
31044 block, paragraph, inline
31051 ] The new-line policy for this tag, see Section
31052 \begin_inset space ~
31056 \begin_inset CommandInset ref
31058 reference "subsec:DocBook-New-line-policy"
31071 \begin_layout Description
31073 \change_inserted -970929547 1515111298
31074 \begin_inset Flex Code
31077 \begin_layout Plain Layout
31079 \change_inserted -970929547 1515111124
31080 DocBookItemWrapperAttr
31088 \begin_inset Flex Code
31091 \begin_layout Plain Layout
31093 \change_inserted -970929547 1515111124
31101 ] Specifies attribute information to be output with the item wrapper tag,
31103 \begin_inset Quotes eld
31107 \begin_inset Flex Code
31110 \begin_layout Plain Layout
31112 \change_inserted -970929547 1515111150
31121 \begin_inset Quotes erd
31124 in the example above.
31125 This information can be used in further processing of the DocBook files.
31131 \begin_layout Description
31133 \change_inserted -970929547 1515111113
31134 \begin_inset Flex Code
31137 \begin_layout Plain Layout
31139 \change_inserted -970929547 1515111073
31140 DocBookItemWrapperTag
31148 \begin_inset Flex Code
31151 \begin_layout Plain Layout
31153 \change_inserted -970929547 1515111073
31161 ] The tag to be used for the item wrapper tag within the inset, replacing
31163 \begin_inset Quotes eld
31167 \begin_inset Flex Code
31170 \begin_layout Plain Layout
31172 \change_inserted -970929547 1515111083
31181 \begin_inset Quotes erd
31184 in the example above.
31186 \begin_inset Flex Code
31189 \begin_layout Plain Layout
31191 \change_inserted -970929547 1515111073
31199 , indicating that there is no item wrapper tag: tag and content are directly
31200 output without it for each itemised element.
31201 This parameter only makes sense when itemising layouts are used, such as
31204 \change_inserted 1075283030 1597699897
31208 \begin_layout Description
31210 \change_inserted 1075283030 1597699897
31211 \begin_inset Flex Code
31214 \begin_layout Plain Layout
31216 \change_inserted 1075283030 1597699900
31217 DocBookItemWrapperTagType
31225 \begin_inset Flex Code
31228 \begin_layout Plain Layout
31230 \change_inserted 1075283030 1597699897
31231 block, paragraph, inline
31238 ] The new-line policy for this tag, see Section
31239 \begin_inset space ~
31243 \begin_inset CommandInset ref
31245 reference "subsec:DocBook-New-line-policy"
31258 \begin_layout Description
31260 \change_inserted -970929547 1515110104
31261 \begin_inset Flex Code
31264 \begin_layout Plain Layout
31266 \change_inserted -970929547 1515110104
31275 \begin_inset Flex Code
31278 \begin_layout Plain Layout
31280 \change_inserted -970929547 1515110104
31288 ] Specifies attribute information to be output with the inner tag, replacing
31290 \begin_inset Quotes eld
31294 \begin_inset Flex Code
31297 \begin_layout Plain Layout
31299 \change_inserted -970929547 1515110104
31308 \begin_inset Quotes erd
31311 in the example above.
31312 This information can be used in further processing of the DocBook files.
31316 \begin_layout Description
31318 \change_inserted -970929547 1515110906
31319 \begin_inset Flex Code
31322 \begin_layout Plain Layout
31324 \change_inserted -970929547 1515110104
31333 \begin_inset Flex Code
31336 \begin_layout Plain Layout
31338 \change_inserted -970929547 1515110104
31346 ] The tag to be used for the inner tag within the inset, replacing
31347 \begin_inset Quotes eld
31351 \begin_inset Flex Code
31354 \begin_layout Plain Layout
31356 \change_inserted -970929547 1515110104
31365 \begin_inset Quotes erd
31368 in the example above.
31370 \begin_inset Flex Code
31373 \begin_layout Plain Layout
31375 \change_inserted -970929547 1515110791
31383 , indicating that there is no inner tag: content is directly output without
31385 \change_inserted 1075283030 1597699904
31389 \begin_layout Description
31391 \change_inserted 1075283030 1597699904
31392 \begin_inset Flex Code
31395 \begin_layout Plain Layout
31397 \change_inserted 1075283030 1597699904
31398 DocBookInnerTagType
31406 \begin_inset Flex Code
31409 \begin_layout Plain Layout
31411 \change_inserted 1075283030 1597699904
31412 block, paragraph, inline
31419 ] The new-line policy for this tag, see Section
31420 \begin_inset space ~
31424 \begin_inset CommandInset ref
31426 reference "subsec:DocBook-New-line-policy"
31439 \begin_layout Description
31441 \change_inserted -970929547 1515110753
31442 \begin_inset Flex Code
31445 \begin_layout Plain Layout
31447 \change_inserted -970929547 1515110665
31456 \begin_inset Flex Code
31459 \begin_layout Plain Layout
31461 \change_inserted -970929547 1515110661
31469 ] Specifies the tag that corresponds to this kind of section.
31470 This parameter only makes sense for sectioning elements (part, chapter,
31472 The default value is
31473 \begin_inset Flex Code
31476 \begin_layout Plain Layout
31478 \change_inserted -970929547 1515110721
31486 , and is only overridden when DocBook uses something else for sectioning
31488 \change_inserted 1075283030 1597699921
31490 \change_inserted -970929547 1515110753
31491 parts and chapters of a book).
31497 \begin_layout Description
31499 \change_inserted -970929547 1515110811
31500 \begin_inset Flex Code
31503 \begin_layout Plain Layout
31505 \change_inserted -970929547 1496612023
31514 \begin_inset Flex Code
31517 \begin_layout Plain Layout
31519 \change_inserted -970929547 1496610966
31527 ] The tag to be used for this inset, replacing
31528 \begin_inset Quotes eld
31532 \begin_inset Flex Code
31535 \begin_layout Plain Layout
31537 \change_inserted -970929547 1496612033
31546 \begin_inset Quotes erd
31549 in the example above.
31550 The default is the name of the float and always needs to be changed, as
31551 DocBook provides no generic inset tag.
31552 \change_inserted 1075283030 1597699924
31556 \begin_layout Description
31558 \change_inserted 1075283030 1597699924
31559 \begin_inset Flex Code
31562 \begin_layout Plain Layout
31564 \change_inserted 1075283030 1597699924
31573 \begin_inset Flex Code
31576 \begin_layout Plain Layout
31578 \change_inserted 1075283030 1597699924
31579 block, paragraph, inline
31586 ] The new-line policy for this tag, see Section
31587 \begin_inset space ~
31591 \begin_inset CommandInset ref
31593 reference "subsec:DocBook-New-line-policy"
31606 \begin_layout Description
31608 \change_inserted -970929547 1515110832
31609 \begin_inset Flex Code
31612 \begin_layout Plain Layout
31614 \change_inserted -970929547 1515110822
31623 \begin_inset Flex Code
31626 \begin_layout Plain Layout
31628 \change_inserted -970929547 1515110811
31636 ] Specifies attribute information to be output with the outer
31637 \change_inserted 34634807 1620057958
31639 \change_inserted -970929547 1515110832
31641 \begin_inset Quotes eld
31645 \begin_inset Flex Code
31648 \begin_layout Plain Layout
31650 \change_inserted -970929547 1515110845
31659 \begin_inset Quotes erd
31662 in the example above.
31663 This information can be used in further processing of the DocBook files.
31667 \begin_layout Description
31669 \change_inserted -970929547 1515110917
31670 \begin_inset Flex Code
31673 \begin_layout Plain Layout
31675 \change_inserted -970929547 1515110826
31684 \begin_inset Flex Code
31687 \begin_layout Plain Layout
31689 \change_inserted -970929547 1515110811
31697 ] The tag to be used for the wrapper tag around the inset, replacing
31698 \begin_inset Quotes eld
31702 \begin_inset Flex Code
31705 \begin_layout Plain Layout
31707 \change_inserted -970929547 1515110842
31716 \begin_inset Quotes erd
31719 in the example above.
31721 \begin_inset Flex Code
31724 \begin_layout Plain Layout
31726 \change_inserted -970929547 1515110811
31734 , indicating that there is no wrapper tag: tag and content are directly
31736 \change_inserted 1075283030 1597699929
31740 \begin_layout Description
31742 \change_inserted 1075283030 1597699929
31743 \begin_inset Flex Code
31746 \begin_layout Plain Layout
31748 \change_inserted 1075283030 1597699932
31749 DocBookWrapperTagType
31757 \begin_inset Flex Code
31760 \begin_layout Plain Layout
31762 \change_inserted 1075283030 1597699929
31763 block, paragraph, inline
31770 ] The new-line policy for this tag, see Section
31771 \begin_inset space ~
31775 \begin_inset CommandInset ref
31777 reference "subsec:DocBook-New-line-policy"
31790 \begin_layout Subsection
31792 \change_inserted -970929547 1515110040
31796 \begin_layout Standard
31798 \change_inserted -970929547 1496611700
31799 The DocBook output for floats too can be controlled by layout information.
31800 The output has the following form:
31803 \begin_layout LyX-Code
31805 \change_inserted -970929547 1515109700
31809 \begin_layout LyX-Code
31811 \change_inserted -970929547 1515110138
31812 Contents of the float as DocBook.
31815 \begin_layout LyX-Code
31817 \change_inserted -970929547 1496610966
31821 \begin_layout Standard
31823 \change_inserted -970929547 1496611715
31824 The caption, if there is one, is a separate inset and will be output as
31829 \begin_layout Description
31831 \change_inserted -970929547 1515110033
31832 \begin_inset Flex Code
31835 \begin_layout Plain Layout
31837 \change_inserted -970929547 1515109702
31846 \begin_inset Flex Code
31849 \begin_layout Plain Layout
31851 \change_inserted -970929547 1496610966
31859 ] Specifies attribute information to be output with the main tag, replacing
31861 \begin_inset Quotes eld
31865 \begin_inset Flex Code
31868 \begin_layout Plain Layout
31870 \change_inserted -970929547 1515110035
31879 \begin_inset Quotes erd
31882 in the example above.
31883 This information can be used in further processing of the DocBook files.
31887 \begin_layout Description
31889 \change_inserted -970929547 1515110157
31890 \begin_inset Flex Code
31893 \begin_layout Plain Layout
31895 \change_inserted -970929547 1496611782
31904 \begin_inset Flex Code
31907 \begin_layout Plain Layout
31909 \change_inserted -970929547 1496610966
31917 ] The tag to be used for this float, replacing
31918 \begin_inset Quotes eld
31922 \begin_inset Flex Code
31925 \begin_layout Plain Layout
31927 \change_inserted -970929547 1496610966
31936 \begin_inset Quotes erd
31939 in the example above.
31940 The default is the name of the float and always needs to be changed, as
31941 DocBook provides no generic float tag.
31944 \begin_layout Subsection
31946 \change_inserted -970929547 1515110157
31947 Bibliography formatting
31950 \begin_layout Standard
31952 \change_deleted 1075283030 1597699984
31954 \change_inserted 1075283030 1597699985
31956 \change_inserted -970929547 1515110187
31958 \change_deleted 1075283030 1597699987
31960 \change_inserted 1075283030 1597699987
31962 \change_inserted -970929547 1515110187
31963 cannot be formatted: all fields are always output in the database-like
31964 DocBook format (equivalent to a BibTeX file)
31965 \change_inserted 1075283030 1597700117
31967 \begin_inset Flex Code
31970 \begin_layout Plain Layout
31972 \change_inserted 1075283030 1597700120
31981 \change_inserted -970929547 1515110187
31983 \change_inserted 1075283030 1597700092
31987 \begin_layout Standard
31989 \change_inserted 1075283030 1597700112
31990 When the bibliographic entries are manually inserted into the
31991 \change_deleted 34634807 1620057319
31993 \change_inserted 34634807 1620057319
31996 \change_inserted 1075283030 1597700112
31997 document as Bibliography Items, the user deals with formatting
32000 \change_inserted 1075283030 1597700112
32001 self: there is no attempt of parsing what the user wrote, the string is
32002 directly used (with the
32003 \begin_inset Flex Code
32006 \begin_layout Plain Layout
32008 \change_inserted 1075283030 1597700076
32022 \begin_layout Chapter
32023 Including External Material
32024 \begin_inset CommandInset label
32026 name "chap:Including-External-Material"
32033 \begin_layout Standard
32034 \begin_inset Box Shadowbox
32044 height_special "totalheight"
32049 backgroundcolor "none"
32052 \begin_layout Plain Layout
32053 WARNING: This portion of the documentation has not been updated for some
32055 We certainly hope that it is still accurate, but there are no guarantees.
32063 \begin_layout Standard
32064 The use of material from sources external to \SpecialChar LyX
32065 is covered in detail in the
32071 This part of the manual covers what needs to happen behind the scenes for
32072 new sorts of material to be included.
32075 \begin_layout Section
32079 \begin_layout Standard
32080 The external material feature is based on the concept of a
32085 A template is a specification of how \SpecialChar LyX
32086 should interface with a certain kind
32088 As bundled, \SpecialChar LyX
32089 comes with predefined templates for Xfig figures, various
32090 raster format images, chess diagrams, and LilyPond music notation.
32091 You can check the actual list by using the menu
32092 \begin_inset Flex Noun
32095 \begin_layout Plain Layout
32096 Insert\SpecialChar menuseparator
32097 File\SpecialChar menuseparator
32104 Furthermore, it is possible to roll your own template to support a specific
32106 Later we'll describe in more detail what is involved, and hopefully you
32107 will submit all the templates you create so we can include them in a later
32112 \begin_layout Standard
32113 Another basic idea of the external material feature is to distinguish between
32114 the original file that serves as a base for final material and the produced
32115 file that is included in your exported or printed document.
32116 For example, consider the case of a figure produced with
32117 \begin_inset Flex Code
32120 \begin_layout Plain Layout
32127 The Xfig application itself works on an original file with the
32128 \begin_inset Flex Code
32131 \begin_layout Plain Layout
32138 Within Xfig, you create and change your figure, and when you are done,
32140 \begin_inset Flex Code
32143 \begin_layout Plain Layout
32150 When you want to include the figure in your document, you invoke
32151 \begin_inset Flex Code
32154 \begin_layout Plain Layout
32160 in order to create a PostScript file that can readily be included in your
32164 \begin_inset Flex Code
32167 \begin_layout Plain Layout
32173 file is the original file, and the PostScript file is the produced file.
32176 \begin_layout Standard
32177 This distinction is important in order to allow updating of the material
32178 while you are in the process of writing the document.
32179 Furthermore, it provides us with the flexibility that is needed to support
32180 multiple export formats.
32181 For instance, in the case of a plain text file, it is not exactly an award-winn
32182 ing idea to include the figure as raw PostScript.
32183 Instead, you would either prefer to just include a reference to the figure
32184 or try to invoke some graphics to ASCII converter to make the final result
32185 look similar to the real graphics.
32186 The external material management allows you to do this, because it is parametri
32187 zed on the different export formats that \SpecialChar LyX
32191 \begin_layout Standard
32192 Besides supporting the production of different products according to the
32193 exported format, it supports tight integration with editing and viewing
32195 In the case of an Xfig figure, you are able to invoke Xfig on the original
32196 file with a single click from within the external material dialog in \SpecialChar LyX
32198 and also preview the produced PostScript file with Ghostview with another
32200 No more fiddling around with the command line and/or file browsers to locate
32201 and manipulate the original or produced files.
32202 In this way, you are finally able to take full advantage of the many different
32203 applications that are relevant to use when you write your documents, and
32204 ultimately be more productive.
32207 \begin_layout Section
32208 The external template configuration files
32211 \begin_layout Standard
32212 It is relatively easy to add custom external template definitions to \SpecialChar LyX
32214 However, be aware that doing this in an careless manner most probably
32218 introduce an easily exploitable security hole.
32219 So before you do this, please read the discussion about security in
32220 \begin_inset CommandInset ref
32222 reference "sec:Security-discussion"
32229 \begin_layout Standard
32230 Having said that, we encourage you to submit any interesting templates that
32235 \begin_layout Standard
32236 The external templates are defined in the
32237 \begin_inset Flex Code
32240 \begin_layout Plain Layout
32246 files that are stored in the
32247 \begin_inset Flex Code
32250 \begin_layout Plain Layout
32251 LyXDir/lib/xtemplates/
32257 Each template is defined in a file of its own.
32258 You can place your own templates in
32259 \begin_inset Flex Code
32262 \begin_layout Plain Layout
32263 UserDir/xtemplates/
32268 or copy existing templates to that directory in order to modify them.
32271 \begin_layout Standard
32272 A typical template looks like this:
32275 \begin_layout LyX-Code
32279 \begin_layout LyX-Code
32280 GuiName "XFig: $$AbsOrRelPathParent$$Basename"
32283 \begin_layout LyX-Code
32287 \begin_layout LyX-Code
32291 \begin_layout LyX-Code
32295 \begin_layout LyX-Code
32299 \begin_layout LyX-Code
32303 \begin_layout LyX-Code
32304 AutomaticProduction true
32307 \begin_layout LyX-Code
32311 \begin_layout LyX-Code
32315 \begin_layout LyX-Code
32319 \begin_layout LyX-Code
32320 TransformCommand Rotate RotationLatexCommand
32323 \begin_layout LyX-Code
32324 TransformCommand Resize ResizeLatexCommand
32327 \begin_layout LyX-Code
32328 Product "$$RotateFront$$ResizeFront
32331 \begin_layout LyX-Code
32336 input{$$AbsOrRelPathMaster$$Basename.pstex_t}
32339 \begin_layout LyX-Code
32340 $$ResizeBack$$RotateBack"
32343 \begin_layout LyX-Code
32347 \begin_layout LyX-Code
32348 UpdateResult "$$AbsPath$$Basename.pstex_t"
32351 \begin_layout LyX-Code
32352 Requirement "graphicx"
32355 \begin_layout LyX-Code
32356 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
32359 \begin_layout LyX-Code
32360 ReferencedFile latex "$$AbsPath$$Basename.eps"
32363 \begin_layout LyX-Code
32364 ReferencedFile dvi "$$AbsPath$$Basename.eps"
32367 \begin_layout LyX-Code
32371 \begin_layout LyX-Code
32375 \begin_layout LyX-Code
32376 TransformCommand Rotate RotationLatexCommand
32379 \begin_layout LyX-Code
32380 TransformCommand Resize ResizeLatexCommand
32383 \begin_layout LyX-Code
32384 Product "$$RotateFront$$ResizeFront
32387 \begin_layout LyX-Code
32392 input{$$AbsOrRelPathMaster$$Basename.pdftex_t}
32395 \begin_layout LyX-Code
32396 $$ResizeBack$$RotateBack"
32399 \begin_layout LyX-Code
32400 UpdateFormat pdftex
32403 \begin_layout LyX-Code
32404 UpdateResult "$$AbsPath$$Basename.pdftex_t"
32407 \begin_layout LyX-Code
32408 Requirement "graphicx"
32411 \begin_layout LyX-Code
32412 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pdftex_t"
32415 \begin_layout LyX-Code
32416 ReferencedFile latex "$$AbsPath$$Basename.pdf"
32419 \begin_layout LyX-Code
32423 \begin_layout LyX-Code
32427 \begin_layout LyX-Code
32428 Product "[XFig: $$FName]"
32431 \begin_layout LyX-Code
32435 \begin_layout LyX-Code
32439 \begin_layout LyX-Code
32440 Product "<graphic fileref=
32442 "$$AbsOrRelPathMaster$$Basename.eps
32447 \begin_layout LyX-Code
32451 \begin_layout LyX-Code
32455 \begin_layout LyX-Code
32456 UpdateResult "$$AbsPath$$Basename.eps"
32459 \begin_layout LyX-Code
32460 ReferencedFile docbook "$$AbsPath$$Basename.eps"
32463 \begin_layout LyX-Code
32464 ReferencedFile docbook-xml "$$AbsPath$$Basename.eps"
32467 \begin_layout LyX-Code
32471 \begin_layout LyX-Code
32475 \begin_layout Standard
32476 As you can see, the template is enclosed in
32477 \begin_inset Flex Code
32480 \begin_layout Plain Layout
32488 \begin_inset Flex Code
32491 \begin_layout Plain Layout
32498 It contains a header specifying some general settings and, for each supported
32499 primary document file format, a section
32500 \begin_inset Flex Code
32503 \begin_layout Plain Layout
32511 \begin_inset Flex Code
32514 \begin_layout Plain Layout
32523 \begin_layout Subsection
32524 The template header
32527 \begin_layout Description
32528 \begin_inset Flex Code
32531 \begin_layout Plain Layout
32532 AutomaticProduction
32533 \begin_inset space ~
32541 Whether the file represented by the template must be generated by \SpecialChar LyX
32543 This command must occur exactly once.
32546 \begin_layout Description
32547 \begin_inset Flex Code
32550 \begin_layout Plain Layout
32552 \begin_inset space ~
32560 A glob pattern that is used in the file dialog to filter out the desired
32562 If there is more than one possible file extension (e.
32563 \begin_inset space \thinspace{}
32567 \begin_inset space \space{}
32571 \begin_inset Flex Code
32574 \begin_layout Plain Layout
32581 \begin_inset Flex Code
32584 \begin_layout Plain Layout
32590 ), use something like
32591 \begin_inset Flex Code
32594 \begin_layout Plain Layout
32601 This command must occur exactly once.
32604 \begin_layout Description
32605 \begin_inset Flex Code
32608 \begin_layout Plain Layout
32610 \begin_inset space ~
32618 The text that is displayed on the button.
32619 This command must occur exactly once.
32622 \begin_layout Description
32623 \begin_inset Flex Code
32626 \begin_layout Plain Layout
32628 \begin_inset space ~
32632 \begin_inset space ~
32640 The help text that is used in the External dialog.
32641 Provide enough information to explain to the user just what the template
32642 can provide him with.
32643 This command must occur exactly once.
32646 \begin_layout Description
32647 \begin_inset Flex Code
32650 \begin_layout Plain Layout
32652 \begin_inset space ~
32660 The file format of the original file.
32661 This must be the name of a format that is known to \SpecialChar LyX
32663 \begin_inset CommandInset ref
32665 reference "sec:Formats"
32671 \begin_inset Quotes eld
32675 \begin_inset Flex Code
32678 \begin_layout Plain Layout
32685 \begin_inset Quotes erd
32688 if the template can handle original files of more than one format.
32690 will attempt to interrogate the file itself in order to deduce its format
32692 This command must occur exactly once.
32695 \begin_layout Description
32696 \begin_inset Flex Code
32699 \begin_layout Plain Layout
32701 \begin_inset space ~
32709 A unique name for the template.
32710 It must not contain substitution macros (see below).
32713 \begin_layout Description
32714 \begin_inset Flex Code
32717 \begin_layout Plain Layout
32719 \begin_inset space ~
32722 Rotate|Resize|Clip|Extra
32727 This command specifies which transformations are supported by this template.
32728 It may occur zero or more times.
32729 This command enables the corresponding tabs in the external dialog.
32731 \begin_inset Flex Code
32734 \begin_layout Plain Layout
32740 command must have either a corresponding
32741 \begin_inset Flex Code
32744 \begin_layout Plain Layout
32751 \begin_inset Flex Code
32754 \begin_layout Plain Layout
32761 \begin_inset Flex Code
32764 \begin_layout Plain Layout
32771 Otherwise the transformation will not be supported by that format.
32774 \begin_layout Subsection
32778 \begin_layout Description
32779 \begin_inset Flex Code
32782 \begin_layout Plain Layout
32784 \begin_inset space ~
32787 LaTeX|PDFLaTeX|PlainText|DocBook|XHTML
32792 The primary document file format that this format definition is for.
32793 Not every template has a sensible representation in all document file formats.
32794 Please define nevertheless a
32795 \begin_inset Flex Code
32798 \begin_layout Plain Layout
32804 section for all templates.
32805 Use a dummy text when no representation is available.
32806 Then you can at least see a reference to the external material in the exported
32810 \begin_layout Description
32811 \begin_inset Flex Code
32814 \begin_layout Plain Layout
32816 \begin_inset space ~
32820 \begin_inset space ~
32828 This command defines an additional macro
32829 \begin_inset Flex Code
32832 \begin_layout Plain Layout
32838 for substitution in
32839 \begin_inset Flex Code
32842 \begin_layout Plain Layout
32850 \begin_inset Flex Code
32853 \begin_layout Plain Layout
32859 itself may contain substitution macros.
32860 The advantage over using
32861 \begin_inset Flex Code
32864 \begin_layout Plain Layout
32871 \begin_inset Flex Code
32874 \begin_layout Plain Layout
32880 is that the substituted value of
32881 \begin_inset Flex Code
32884 \begin_layout Plain Layout
32890 is sanitized so that it is a valid optional argument in the document format.
32891 This command may occur zero or more times.
32894 \begin_layout Description
32895 \begin_inset Flex Code
32898 \begin_layout Plain Layout
32900 \begin_inset space ~
32908 The text that is inserted in the exported document.
32909 This is actually the most important command and can be quite complex.
32910 This command must occur exactly once.
32913 \begin_layout Description
32914 \begin_inset Flex Code
32917 \begin_layout Plain Layout
32919 \begin_inset space ~
32927 This command specifies a preamble snippet that will be included in the
32930 It has to be defined using
32931 \begin_inset Flex Code
32934 \begin_layout Plain Layout
32942 \begin_inset Flex Code
32945 \begin_layout Plain Layout
32952 This command may occur zero or more times.
32955 \begin_layout Description
32956 \begin_inset Flex Code
32959 \begin_layout Plain Layout
32961 \begin_inset space ~
32965 \begin_inset space ~
32973 This command denotes files that are created by the conversion process and
32974 are needed for a particular export format.
32975 If the filename is relative, it is interpreted relative to the master document.
32976 This command may be given zero or more times.
32979 \begin_layout Description
32980 \begin_inset Flex Code
32983 \begin_layout Plain Layout
32985 \begin_inset space ~
32993 The name of a required \SpecialChar LaTeX
32995 The package is included via
32996 \begin_inset Flex Code
32999 \begin_layout Plain Layout
33007 in the \SpecialChar LaTeX
33009 This command may occur zero or more times.
33012 \begin_layout Description
33013 \begin_inset Flex Code
33016 \begin_layout Plain Layout
33018 \begin_inset space ~
33022 \begin_inset space ~
33025 RotationLatexCommand
33030 This command specifies that the built in \SpecialChar LaTeX
33031 command should be used for rotation.
33032 This command may occur once or not at all.
33035 \begin_layout Description
33036 \begin_inset Flex Code
33039 \begin_layout Plain Layout
33041 \begin_inset space ~
33045 \begin_inset space ~
33053 This command specifies that the built in \SpecialChar LaTeX
33054 command should be used for resizing.
33055 This command may occur once or not at all.
33058 \begin_layout Description
33059 \begin_inset Flex Code
33062 \begin_layout Plain Layout
33064 \begin_inset space ~
33068 \begin_inset space ~
33071 RotationLatexOption
33076 This command specifies that rotation is done via an optional argument.
33077 This command may occur once or not at all.
33080 \begin_layout Description
33081 \begin_inset Flex Code
33084 \begin_layout Plain Layout
33086 \begin_inset space ~
33090 \begin_inset space ~
33098 This command specifies that resizing is done via an optional argument.
33099 This command may occur once or not at all.
33102 \begin_layout Description
33103 \begin_inset Flex Code
33106 \begin_layout Plain Layout
33108 \begin_inset space ~
33112 \begin_inset space ~
33120 This command specifies that clipping is done via an optional argument.
33121 This command may occur once or not at all.
33124 \begin_layout Description
33125 \begin_inset Flex Code
33128 \begin_layout Plain Layout
33130 \begin_inset space ~
33134 \begin_inset space ~
33142 This command specifies that an extra optional argument is used.
33143 This command may occur once or not at all.
33146 \begin_layout Description
33147 \begin_inset Flex Code
33150 \begin_layout Plain Layout
33152 \begin_inset space ~
33160 The file format of the converted file.
33161 This must be the name of a format that is known to \SpecialChar LyX
33163 \begin_inset Flex Noun
33166 \begin_layout Plain Layout
33167 Tools\SpecialChar menuseparator
33168 Preferences\SpecialChar menuseparator
33169 File Handling\SpecialChar menuseparator
33176 This command must occur exactly once.
33177 If the resulting file format is PDF, you need to specify the format
33178 \begin_inset Flex Code
33181 \begin_layout Plain Layout
33188 This is the PDF format used for including graphics.
33189 The other defined PDF formats are for document export.
33192 \begin_layout Description
33193 \begin_inset Flex Code
33196 \begin_layout Plain Layout
33198 \begin_inset space ~
33206 The file name of the converted file.
33207 The file name must be absolute.
33208 This command must occur exactly once.
33211 \begin_layout Subsection
33212 Preamble definitions
33215 \begin_layout Standard
33216 The external template configuration file may contain additional preamble
33217 definitions enclosed by
33218 \begin_inset Flex Code
33221 \begin_layout Plain Layout
33229 \begin_inset Flex Code
33232 \begin_layout Plain Layout
33239 They can be used by the templates in the
33240 \begin_inset Flex Code
33243 \begin_layout Plain Layout
33252 \begin_layout Section
33253 The substitution mechanism
33256 \begin_layout Standard
33257 When the external material facility invokes an external program, it is done
33258 on the basis of a command defined in the template configuration file.
33259 These commands can contain various macros that are expanded before execution.
33260 Execution always take place in the directory of the containing document.
33263 \begin_layout Standard
33264 Also, whenever external material is to be displayed, the name will be produced
33265 by the substitution mechanism, and most other commands in the template
33266 definition support substitution as well.
33269 \begin_layout Standard
33270 The available macros are the following:
33273 \begin_layout Description
33274 \begin_inset Flex Code
33277 \begin_layout Plain Layout
33278 $$AbsOrRelPathMaster
33283 The file path, absolute or relative to the master \SpecialChar LyX
33287 \begin_layout Description
33288 \begin_inset Flex Code
33291 \begin_layout Plain Layout
33292 $$AbsOrRelPathParent
33297 The file path, absolute or relative to the \SpecialChar LyX
33301 \begin_layout Description
33302 \begin_inset Flex Code
33305 \begin_layout Plain Layout
33311 The absolute file path.
33314 \begin_layout Description
33315 \begin_inset Flex Code
33318 \begin_layout Plain Layout
33324 The filename without path and without the extension.
33327 \begin_layout Description
33328 \begin_inset Flex Code
33331 \begin_layout Plain Layout
33333 \begin_inset Quotes eld
33337 \begin_inset Quotes erd
33345 This macro will expand to the contents of the file with the name
33346 \begin_inset Flex Code
33349 \begin_layout Plain Layout
33358 \begin_layout Description
33359 \begin_inset Flex Code
33362 \begin_layout Plain Layout
33368 The file extension (including the dot).
33371 \begin_layout Description
33372 \begin_inset Flex Code
33375 \begin_layout Plain Layout
33381 This will be the string
33382 \begin_inset Quotes eld
33386 \begin_inset Quotes erd
33389 if the file is in JPEG format, otherwise it will be the string
33390 \begin_inset Quotes eld
33394 \begin_inset Quotes erd
33398 This is useful to avoid uneeded conversions for output formats that support
33399 both PNG and JPEG fomats.
33400 The predefined RasterImage template uses this macro for the pdf\SpecialChar TeX
33405 \begin_layout Description
33406 \begin_inset Flex Code
33409 \begin_layout Plain Layout
33415 The filename of the file specified in the external material dialog.
33416 This is either an absolute name, or it is relative to the \SpecialChar LyX
33420 \begin_layout Description
33421 \begin_inset Flex Code
33424 \begin_layout Plain Layout
33431 \begin_inset Flex Code
33434 \begin_layout Plain Layout
33440 (absolute name or relative to the \SpecialChar LyX
33444 \begin_layout Description
33445 \begin_inset Flex Code
33448 \begin_layout Plain Layout
33454 The file path, relative to the master \SpecialChar LyX
33458 \begin_layout Description
33459 \begin_inset Flex Code
33462 \begin_layout Plain Layout
33468 The file path, relative to the \SpecialChar LyX
33472 \begin_layout Description
33473 \begin_inset Flex Code
33476 \begin_layout Plain Layout
33482 This macro will expand to the absolute path of the system directory.
33483 This is typically used to point to the various helper scripts that are
33484 bundled with \SpecialChar LyX
33488 \begin_layout Description
33489 \begin_inset Flex Code
33492 \begin_layout Plain Layout
33498 A name and full path to a temporary file which will be automatically deleted
33499 whenever the containing document is closed, or the external material insertion
33503 \begin_layout Standard
33504 All path macros contain a trailing directory separator, so you can construct
33506 \begin_inset space \thinspace{}
33510 \begin_inset space \space{}
33513 the absolute filename with
33514 \begin_inset Flex Code
33517 \begin_layout Plain Layout
33518 $$AbsPath$$Basename$$Extension
33526 \begin_layout Standard
33527 The macros above are substituted in all commands unless otherwise noted.
33529 \begin_inset Flex Code
33532 \begin_layout Plain Layout
33538 supports additionally the following substitutions if they are enabled by
33540 \begin_inset Flex Code
33543 \begin_layout Plain Layout
33550 \begin_inset Flex Code
33553 \begin_layout Plain Layout
33562 \begin_layout Description
33563 \begin_inset Flex Code
33566 \begin_layout Plain Layout
33572 The front part of the resize command.
33575 \begin_layout Description
33576 \begin_inset Flex Code
33579 \begin_layout Plain Layout
33585 The back part of the resize command.
33588 \begin_layout Description
33589 \begin_inset Flex Code
33592 \begin_layout Plain Layout
33598 The front part of the rotation command.
33601 \begin_layout Description
33602 \begin_inset Flex Code
33605 \begin_layout Plain Layout
33611 The back part of the rotation command.
33614 \begin_layout Standard
33615 The value string of the
33616 \begin_inset Flex Code
33619 \begin_layout Plain Layout
33625 command supports additionally the following substitutions if they are enabled
33627 \begin_inset Flex Code
33630 \begin_layout Plain Layout
33637 \begin_inset Flex Code
33640 \begin_layout Plain Layout
33649 \begin_layout Description
33650 \begin_inset Flex Code
33653 \begin_layout Plain Layout
33662 \begin_layout Description
33663 \begin_inset Flex Code
33666 \begin_layout Plain Layout
33675 \begin_layout Description
33676 \begin_inset Flex Code
33679 \begin_layout Plain Layout
33688 \begin_layout Description
33689 \begin_inset Flex Code
33692 \begin_layout Plain Layout
33698 The rotation option.
33701 \begin_layout Standard
33702 You may ask why there are so many path macros.
33703 There are mainly two reasons:
33706 \begin_layout Enumerate
33707 Relative and absolute file names should remain relative or absolute, respectivel
33709 Users may have reasons to prefer either form.
33710 Relative names are useful for portable documents that should work on different
33711 machines, for example.
33712 Absolute names may be required by some programs.
33715 \begin_layout Enumerate
33717 treats relative file names differently than \SpecialChar LyX
33718 and other programs in nested
33720 For \SpecialChar LyX
33721 , a relative file name is always relative to the document that contains
33723 For \SpecialChar LaTeX
33724 , it is always relative to the master document.
33725 These two definitions are identical if you have only one document, but
33726 differ if you have a master document that includes part documents.
33727 That means that relative filenames must be transformed when presented to
33730 Fortunately \SpecialChar LyX
33731 does this automatically for you if you choose the right macros.
33734 \begin_layout Standard
33735 So which path macro should be used in new template definitions? The rule
33739 \begin_layout Itemize
33741 \begin_inset Flex Code
33744 \begin_layout Plain Layout
33750 if an absolute path is required.
33753 \begin_layout Itemize
33755 \begin_inset Flex Code
33758 \begin_layout Plain Layout
33759 $$AbsOrRelPathMaster
33764 if the substituted string is some kind of \SpecialChar LaTeX
33768 \begin_layout Itemize
33770 \begin_inset Flex Code
33773 \begin_layout Plain Layout
33774 $$AbsOrRelPathParent
33779 in order to preserve the user's choice.
33782 \begin_layout Standard
33783 There are special cases where this rule does not work and e.
33784 \begin_inset space \thinspace{}
33788 \begin_inset space \space{}
33791 relative names are needed, but normally it will work just fine.
33792 One example for such a case is the command
33793 \begin_inset Flex Code
33796 \begin_layout Plain Layout
33797 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
33802 in the XFig template above: We can't use the absolute name because the
33804 \begin_inset Flex Code
33807 \begin_layout Plain Layout
33813 files needs the relative name in order to rewrite the file content.
33816 \begin_layout Section
33817 Security discussion
33818 \begin_inset CommandInset label
33820 name "sec:Security-discussion"
33827 \begin_layout Standard
33828 The external material feature interfaces with a lot of external programs
33829 and does so automatically, so we have to consider the security implications
33831 In particular, since you have the option of including your own filenames
33832 and/or parameter strings and those are expanded into a command, it seems
33833 that it would be possible to create a malicious document which executes
33834 arbitrary commands when a user views or prints the document.
33835 This is something we definitely want to avoid.
33838 \begin_layout Standard
33839 However, since the external program commands are specified in the template
33840 configuration file only, there are no security issues if \SpecialChar LyX
33841 is properly configure
33842 d with safe templates only.
33843 This is so because the external programs are invoked with the
33844 \begin_inset Flex Code
33847 \begin_layout Plain Layout
33853 -system call rather than the
33854 \begin_inset Flex Code
33857 \begin_layout Plain Layout
33863 system-call, so it's not possible to execute arbitrary commands from the
33864 filename or parameter section via the shell.
33867 \begin_layout Standard
33868 This also implies that you are restricted in what command strings you can
33869 use in the external material templates.
33870 In particular, pipes and redirection are not readily available.
33871 This has to be so if \SpecialChar LyX
33872 should remain safe.
33873 If you want to use some of the shell features, you should write a safe
33874 script to do this in a controlled manner, and then invoke the script from
33875 the command string.
33879 \begin_layout Standard
33880 It is possible to design a template that interacts directly with the shell,
33881 but since this would allow a malicious user to execute arbitrary commands
33882 by writing clever filenames and/or parameters, we generally recommend that
33883 you only use safe scripts that work with the
33884 \begin_inset Flex Code
33887 \begin_layout Plain Layout
33893 system call in a controlled manner.
33894 Of course, for use in a controlled environment, it can be tempting to just
33895 fall back to use ordinary shell scripts.
33896 If you do so, be aware that you
33900 provide an easily exploitable security hole in your system.
33901 Of course it stands to reason that such unsafe templates will never be
33902 included in the standard \SpecialChar LyX
33903 distribution, although we do encourage people
33904 to submit new templates in the open source tradition.
33905 But \SpecialChar LyX
33906 as shipped from the official distribution channels will never have
33910 \begin_layout Standard
33911 Including external material provides a lot of power, and you have to be
33912 careful not to introduce security hazards with this power.
33913 A subtle error in a single line in an innocent looking script can open
33914 the door to huge security problems.
33915 So if you do not fully understand the issues, we recommend that you consult
33916 a knowledgeable security professional or the \SpecialChar LyX
33917 development team if you have
33918 any questions about whether a given template is safe or not.
33919 And do this before you use it in an uncontrolled environment.
33922 \begin_layout Chapter
33924 List of supported \SpecialChar LyX
33925 functions to be used in layouts
33926 \begin_inset CommandInset label
33928 name "chap:List-of-functions"
33935 \begin_layout Standard
33937 \begin_inset Tabular
33938 <lyxtabular version="3" rows="11" columns="8">
33939 <features tabularvalignment="middle">
33940 <column alignment="left" valignment="top">
33941 <column alignment="left" valignment="top">
33942 <column alignment="left" valignment="top">
33943 <column alignment="left" valignment="top">
33944 <column alignment="left" valignment="top">
33945 <column alignment="left" valignment="top">
33946 <column alignment="left" valignment="top">
33947 <column alignment="left" valignment="top">
33949 <cell alignment="left" valignment="top" usebox="none">
33952 \begin_layout Plain Layout
33958 <cell alignment="left" valignment="top" usebox="none">
33961 \begin_layout Plain Layout
33967 <cell alignment="left" valignment="top" usebox="none">
33970 \begin_layout Plain Layout
33976 <cell alignment="left" valignment="top" usebox="none">
33979 \begin_layout Plain Layout
33985 <cell alignment="center" valignment="top" usebox="none">
33988 \begin_layout Plain Layout
33994 <cell alignment="center" valignment="top" usebox="none">
33997 \begin_layout Plain Layout
34003 <cell alignment="center" valignment="top" usebox="none">
34006 \begin_layout Plain Layout
34012 <cell alignment="center" valignment="top" usebox="none">
34015 \begin_layout Plain Layout
34023 <cell alignment="left" valignment="top" usebox="none">
34026 \begin_layout Plain Layout
34032 <cell alignment="left" valignment="top" usebox="none">
34035 \begin_layout Plain Layout
34041 <cell alignment="left" valignment="top" usebox="none">
34044 \begin_layout Plain Layout
34050 <cell alignment="left" valignment="top" usebox="none">
34053 \begin_layout Plain Layout
34059 <cell alignment="center" valignment="top" usebox="none">
34062 \begin_layout Plain Layout
34068 <cell alignment="center" valignment="top" usebox="none">
34071 \begin_layout Plain Layout
34077 <cell alignment="center" valignment="top" usebox="none">
34080 \begin_layout Plain Layout
34086 <cell alignment="center" valignment="top" usebox="none">
34089 \begin_layout Plain Layout
34097 <cell alignment="left" valignment="top" usebox="none">
34100 \begin_layout Plain Layout
34106 <cell alignment="left" valignment="top" usebox="none">
34109 \begin_layout Plain Layout
34115 <cell alignment="left" valignment="top" usebox="none">
34118 \begin_layout Plain Layout
34124 <cell alignment="left" valignment="top" usebox="none">
34127 \begin_layout Plain Layout
34133 <cell alignment="center" valignment="top" usebox="none">
34136 \begin_layout Plain Layout
34142 <cell alignment="center" valignment="top" usebox="none">
34145 \begin_layout Plain Layout
34151 <cell alignment="center" valignment="top" usebox="none">
34154 \begin_layout Plain Layout
34160 <cell alignment="center" valignment="top" usebox="none">
34163 \begin_layout Plain Layout
34171 <cell alignment="left" valignment="top" usebox="none">
34174 \begin_layout Plain Layout
34180 <cell alignment="left" valignment="top" usebox="none">
34183 \begin_layout Plain Layout
34189 <cell alignment="left" valignment="top" usebox="none">
34192 \begin_layout Plain Layout
34198 <cell alignment="left" valignment="top" usebox="none">
34201 \begin_layout Plain Layout
34207 <cell alignment="center" valignment="top" usebox="none">
34210 \begin_layout Plain Layout
34216 <cell alignment="center" valignment="top" usebox="none">
34219 \begin_layout Plain Layout
34225 <cell alignment="center" valignment="top" usebox="none">
34228 \begin_layout Plain Layout
34234 <cell alignment="center" valignment="top" usebox="none">
34237 \begin_layout Plain Layout
34245 <cell alignment="left" valignment="top" usebox="none">
34248 \begin_layout Plain Layout
34254 <cell alignment="left" valignment="top" usebox="none">
34257 \begin_layout Plain Layout
34263 <cell alignment="left" valignment="top" usebox="none">
34266 \begin_layout Plain Layout
34272 <cell alignment="left" valignment="top" usebox="none">
34275 \begin_layout Plain Layout
34281 <cell alignment="center" valignment="top" usebox="none">
34284 \begin_layout Plain Layout
34290 <cell alignment="center" valignment="top" usebox="none">
34293 \begin_layout Plain Layout
34299 <cell alignment="center" valignment="top" usebox="none">
34302 \begin_layout Plain Layout
34308 <cell alignment="center" valignment="top" usebox="none">
34311 \begin_layout Plain Layout
34319 <cell alignment="left" valignment="top" usebox="none">
34322 \begin_layout Plain Layout
34328 <cell alignment="left" valignment="top" usebox="none">
34331 \begin_layout Plain Layout
34337 <cell alignment="left" valignment="top" usebox="none">
34340 \begin_layout Plain Layout
34346 <cell alignment="left" valignment="top" usebox="none">
34349 \begin_layout Plain Layout
34355 <cell alignment="center" valignment="top" usebox="none">
34358 \begin_layout Plain Layout
34364 <cell alignment="center" valignment="top" usebox="none">
34367 \begin_layout Plain Layout
34373 <cell alignment="center" valignment="top" usebox="none">
34376 \begin_layout Plain Layout
34382 <cell alignment="center" valignment="top" usebox="none">
34385 \begin_layout Plain Layout
34393 <cell alignment="left" valignment="top" usebox="none">
34396 \begin_layout Plain Layout
34402 <cell alignment="left" valignment="top" usebox="none">
34405 \begin_layout Plain Layout
34411 <cell alignment="left" valignment="top" usebox="none">
34414 \begin_layout Plain Layout
34420 <cell alignment="left" valignment="top" usebox="none">
34423 \begin_layout Plain Layout
34429 <cell alignment="center" valignment="top" usebox="none">
34432 \begin_layout Plain Layout
34438 <cell alignment="center" valignment="top" usebox="none">
34441 \begin_layout Plain Layout
34447 <cell alignment="center" valignment="top" usebox="none">
34450 \begin_layout Plain Layout
34456 <cell alignment="center" valignment="top" usebox="none">
34459 \begin_layout Plain Layout
34467 <cell alignment="left" valignment="top" usebox="none">
34470 \begin_layout Plain Layout
34476 <cell alignment="left" valignment="top" usebox="none">
34479 \begin_layout Plain Layout
34485 <cell alignment="left" valignment="top" usebox="none">
34488 \begin_layout Plain Layout
34494 <cell alignment="left" valignment="top" usebox="none">
34497 \begin_layout Plain Layout
34503 <cell alignment="center" valignment="top" usebox="none">
34506 \begin_layout Plain Layout
34512 <cell alignment="center" valignment="top" usebox="none">
34515 \begin_layout Plain Layout
34521 <cell alignment="center" valignment="top" usebox="none">
34524 \begin_layout Plain Layout
34530 <cell alignment="center" valignment="top" usebox="none">
34533 \begin_layout Plain Layout
34541 <cell alignment="left" valignment="top" usebox="none">
34544 \begin_layout Plain Layout
34550 <cell alignment="left" valignment="top" usebox="none">
34553 \begin_layout Plain Layout
34559 <cell alignment="left" valignment="top" usebox="none">
34562 \begin_layout Plain Layout
34568 <cell alignment="left" valignment="top" usebox="none">
34571 \begin_layout Plain Layout
34577 <cell alignment="center" valignment="top" usebox="none">
34580 \begin_layout Plain Layout
34586 <cell alignment="center" valignment="top" usebox="none">
34589 \begin_layout Plain Layout
34595 <cell alignment="center" valignment="top" usebox="none">
34598 \begin_layout Plain Layout
34604 <cell alignment="center" valignment="top" usebox="none">
34607 \begin_layout Plain Layout
34615 <cell alignment="left" valignment="top" usebox="none">
34618 \begin_layout Plain Layout
34624 <cell alignment="left" valignment="top" usebox="none">
34627 \begin_layout Plain Layout
34633 <cell alignment="left" valignment="top" usebox="none">
34636 \begin_layout Plain Layout
34642 <cell alignment="left" valignment="top" usebox="none">
34645 \begin_layout Plain Layout
34651 <cell alignment="center" valignment="top" usebox="none">
34654 \begin_layout Plain Layout
34660 <cell alignment="center" valignment="top" usebox="none">
34663 \begin_layout Plain Layout
34669 <cell alignment="center" valignment="top" usebox="none">
34672 \begin_layout Plain Layout
34678 <cell alignment="center" valignment="top" usebox="none">
34681 \begin_layout Plain Layout
34689 <cell alignment="center" valignment="top" usebox="none">
34692 \begin_layout Plain Layout
34698 <cell alignment="center" valignment="top" usebox="none">
34701 \begin_layout Plain Layout
34707 <cell alignment="center" valignment="top" usebox="none">
34710 \begin_layout Plain Layout
34716 <cell alignment="center" valignment="top" usebox="none">
34719 \begin_layout Plain Layout
34725 <cell alignment="center" valignment="top" usebox="none">
34728 \begin_layout Plain Layout
34734 <cell alignment="center" valignment="top" usebox="none">
34737 \begin_layout Plain Layout
34743 <cell alignment="center" valignment="top" usebox="none">
34746 \begin_layout Plain Layout
34752 <cell alignment="center" valignment="top" usebox="none">
34755 \begin_layout Plain Layout
34769 \begin_layout Chapter
34770 Names of available colors to be used in layouts
34771 \begin_inset CommandInset label
34773 name "chap:Names-of-colors"
34780 \begin_layout Standard
34781 The colors listed below are the standard colors and those that you can adjust
34782 in the \SpecialChar LyX
34786 \begin_layout Section
34790 \begin_layout Standard
34791 The following are no real colors, but rather act on color definitions:
34794 \begin_layout Description
34795 ignore The color is ignored
34798 \begin_layout Description
34799 inherit The color is inherited
34802 \begin_layout Description
34815 No particular color – clear or default
34818 \begin_layout Section
34822 \begin_layout Standard
34823 These are fixed colors that cannot be customized
34824 \change_inserted -712698321 1607683177
34830 use these colors in layout definitions, since they will not work well with
34831 some color themes (such as dark themes)
34836 \begin_layout Description
34840 \begin_layout Description
34844 \begin_layout Description
34848 \begin_layout Description
34852 \begin_layout Description
34856 \begin_layout Description
34860 \begin_layout Description
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 Section
34916 \begin_layout Standard
34917 These are the colors allocated to specific elements in
34920 arg "dialog-show prefs"
34926 \begin_layout Description
34927 added_space Added space color
34930 \begin_layout Description
34931 addedtext Added text color
34934 \begin_layout Description
34935 appendix Appendix marker color
34938 \begin_layout Description
34939 background Background color
34942 \begin_layout Description
34943 bottomarea Bottom area color
34946 \begin_layout Description
34947 branchlabel Label color for branches
34950 \begin_layout Description
34951 buttonbg Color used for button background
34954 \begin_layout Description
34955 buttonframe Color for inset button frames
34958 \begin_layout Description
34959 buttonhoverbg Color used for button background under focus
34962 \begin_layout Description
34963 changebar Changebar color
34966 \begin_layout Description
34967 changedtextauthor1 Changed text color author 1
34970 \begin_layout Description
34971 changedtextauthor2 Changed text color author 2
34974 \begin_layout Description
34975 changedtextauthor3 Changed text color author 3
34978 \begin_layout Description
34979 changedtextauthor4 Changed text color author 4
34982 \begin_layout Description
34983 changedtextauthor5 Changed text color author 5
34986 \begin_layout Description
34987 collapsible Collapsible insets text color
34990 \begin_layout Description
34991 collapsibleframe Collapsible insets framecolor
34994 \begin_layout Description
34995 command Text color for command insets
34998 \begin_layout Description
34999 commandbg Background color for command insets
35002 \begin_layout Description
35003 commandframe Frame color for command insets
35006 \begin_layout Description
35007 comment Label color for comments
35010 \begin_layout Description
35011 commentbg Background color of comments
35014 \begin_layout Description
35015 cursor Cursor color
35018 \begin_layout Description
35019 deletedtext Deleted text color
35022 \begin_layout Description
35023 deletedtextmodifier Deleted text modifying color
35026 \begin_layout Description
35027 depthbar Color for the depth bars in the margin
35030 \begin_layout Description
35031 eolmarker End of line marker color
35034 \begin_layout Description
35035 error Color of the \SpecialChar LaTeX
35039 \begin_layout Description
35040 footlabel Label color for footnotes
35043 \begin_layout Description
35044 foreground Foreground color
35047 \begin_layout Description
35048 graphicsbg Graphics inset background color
35051 \begin_layout Description
35052 greyedoutbg Background color of greyedout inset
35055 \begin_layout Description
35056 greyedoutlabel Label color for greyedout insets
35059 \begin_layout Description
35060 greyedouttext Color for greyedout inset text
35063 \begin_layout Description
35064 indexlabel Label color for index insets
35067 \begin_layout Description
35068 inlinecompletion Inline completion color
35071 \begin_layout Description
35072 insetbg Inset marker background color
35075 \begin_layout Description
35076 insetframe Inset marker frame color
35079 \begin_layout Description
35080 language Color for marking foreign language words
35083 \begin_layout Description
35084 latex Text color in \SpecialChar LaTeX
35088 \begin_layout Description
35089 listingsbg Background color of listings inset
35092 \begin_layout Description
35093 marginlabel Label color for margin notes
35096 \begin_layout Description
35097 math Math inset text color
35100 \begin_layout Description
35101 mathbg Math inset background color
35104 \begin_layout Description
35105 mathcorners Math inset frame color not under focus
35108 \begin_layout Description
35109 mathframe Math inset frame color under focus
35112 \begin_layout Description
35113 mathline Math line color
35116 \begin_layout Description
35117 mathmacrobg Macro math inset background color
35120 \begin_layout Description
35121 mathmacroblend Macro math blended color
35124 \begin_layout Description
35125 mathmacroframe Macro math frame color
35128 \begin_layout Description
35129 mathmacrohoverbg Macro math inset background color hovered
35132 \begin_layout Description
35133 mathmacrolabel Macro math label color
35136 \begin_layout Description
35137 mathmacronewarg Macro template color for new parameters
35140 \begin_layout Description
35141 mathmacrooldarg Macro template color for old parameters
35144 \begin_layout Description
35145 newpage New page color
35148 \begin_layout Description
35149 nonunique_inlinecompletion Inline completion color for the non-unique part
35152 \begin_layout Description
35153 note Label color for notes
35156 \begin_layout Description
35157 notebg Background color of notes
35160 \begin_layout Description
35161 pagebreak Page break/line break color
35164 \begin_layout Description
35165 paragraphmarker Color used for the pilcrow sign to mark the end of a paragraph
35168 \begin_layout Description
35169 phantomtext Text color for phantom insets
35172 \begin_layout Description
35173 preview The color used for previews
35176 \begin_layout Description
35177 previewframe Preview frame color
35180 \begin_layout Description
35181 regexpframe Color for regexp frame
35184 \begin_layout Description
35185 scroll Color that indicates when a row can be scrolled
35188 \begin_layout Description
35189 selection Background color of selected text
35192 \begin_layout Description
35193 selectiontext Foreground color of selected text
35196 \begin_layout Description
35197 shadedbg Background color of shaded box
35200 \begin_layout Description
35201 special Special chars text color
35204 \begin_layout Description
35205 tabularline Table line color
35208 \begin_layout Description
35209 tabularonoffline Table line color
35210 \change_inserted -712698321 1607682522
35214 \begin_layout Description
35216 \change_inserted -712698321 1607682563
35217 textlabel1 Color 1 of layout and custom inset labels
35220 \begin_layout Description
35222 \change_inserted -712698321 1607682565
35223 textlabel2 Color 2 of layout and custom inset labels
35226 \begin_layout Description
35228 \change_inserted -712698321 1607682568
35229 textlabel3 Color 3 of layout and custom inset labels
35234 \begin_layout Description
35235 urllabel Label color for URL insets
35238 \begin_layout Description
35239 urltext Color for URL inset text