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"
145 \author 34634807 "Jean-Pierre"
146 \author 232239728 "Owner"
147 \author 731793113 "Richard Kimberly Heck" rikiheck@lyx.org
148 \author 1075283030 "Thibaut"
154 Customizing \SpecialChar LyX
155 : Features for the Advanced User
159 by the \SpecialChar LyX
164 \begin_layout Plain Layout
165 If you have comments or error corrections, please send them to the \SpecialChar LyX
168 \begin_inset CommandInset href
170 target "lyx-docs@lists.lyx.org"
178 \begin_inset Quotes eld
182 \begin_inset Quotes erd
185 in the subject header, and please cc the current maintainer of this file,
187 \change_inserted 5863208 1604930692
191 \change_inserted 5863208 1604930729
193 \change_deleted 5863208 1604930668
202 \begin_inset Newline newline
206 \begin_inset Newline newline
212 \begin_layout Standard
213 \begin_inset CommandInset toc
214 LatexCommand tableofcontents
221 \begin_layout Standard
222 \begin_inset Note Note
225 \begin_layout Plain Layout
226 Please use change tracking when modifying this document.
227 This makes it easier for our translators to recognize things that have
228 been changed, and it helps the maintainer keep up-to-date with what's been
237 \begin_layout Chapter
241 \begin_layout Standard
242 This manual covers the customization features present in \SpecialChar LyX
244 In it, we discuss issues like keyboard shortcuts, screen previewing options,
245 printer options, sending commands to \SpecialChar LyX
246 via the \SpecialChar LyX
247 Server, internationalization,
248 installing new \SpecialChar LaTeX
249 classes and \SpecialChar LyX
251 We can't possibly hope to touch on everything you can change—our developers
252 add new features faster than we can document them—but we will explain the
253 most common customizations and hopefully point you in the right direction
254 for some of the more obscure ones.
257 \begin_layout Standard
258 \begin_inset Branch OutDated
262 \begin_layout Standard
263 Information from previous versions of this document that now seems to be
264 outdated is contained in the OutDated branch of this document.
265 By default, this information will not appear in the \SpecialChar LaTeX
274 \begin_layout Chapter
279 \begin_layout Standard
280 This chapter aims to help you to find your way through the \SpecialChar LyX
283 Before continuing to read this chapter, you should find out where your
285 library and user directories are by using
286 \begin_inset Flex Noun
289 \begin_layout Plain Layout
290 Help\SpecialChar menuseparator
301 The library directory is the place where \SpecialChar LyX
302 places its system-wide configuration
303 files; the user directory is where you can place your modified versions.
304 We will call the former
305 \begin_inset Flex Code
308 \begin_layout Plain Layout
315 \begin_inset Flex Noun
318 \begin_layout Plain Layout
324 in the remainder of this document.
328 \begin_layout Section
330 \begin_inset Flex Code
333 \begin_layout Plain Layout
342 \begin_layout Standard
343 \begin_inset Flex Code
346 \begin_layout Plain Layout
352 and its sub-directories contain a number of files
353 \change_deleted 232239728 1604787780
356 that can be used to customize \SpecialChar LyX
358 You can change many of these files from within \SpecialChar LyX
360 \begin_inset Flex Noun
363 \begin_layout Plain Layout
364 Tools\SpecialChar menuseparator
371 Most customization that you will want to do in \SpecialChar LyX
372 is possible through this
374 However, many other inner aspects of \SpecialChar LyX
375 can be customized by modifying the
377 \begin_inset Flex Code
380 \begin_layout Plain Layout
387 These files fall in different categories, described in the following subsection
391 \begin_layout Subsection
392 Automatically generated files
395 \begin_layout Standard
397 \begin_inset Flex Noun
400 \begin_layout Plain Layout
406 are generated when you configure \SpecialChar LyX
408 They contain various default values that are
409 \change_inserted 5863208 1604919565
410 automatically detected during reconfiguration.
411 \change_deleted 232239728 1604788241
412 guessed by inspection
414 In general, it is not a good idea to modify them, since they might be overwritt
418 \begin_layout Labeling
419 \labelwidthstring 00.00.0000
420 \begin_inset Flex Code
423 \begin_layout Plain Layout
430 \change_deleted 5863208 1604919950
432 \begin_inset Note Note
435 \begin_layout Plain Layout
437 \change_inserted 232239728 1604853928
438 I capitalized the first word in all of these lists.
439 To me it looks better but it really is a stylistic thing, your call.
440 However if you are not going to capitalize them, the english in some needs
441 to be modified to make it read correctly as a sentence.
449 \change_deleted 232239728 1604853510
451 \change_inserted 232239728 1604853510
454 ontains defaults for various commands.
457 \begin_layout Labeling
458 \labelwidthstring 00.00.0000
459 \begin_inset Flex Code
462 \begin_layout Plain Layout
469 \change_deleted 232239728 1604853512
471 \change_inserted 232239728 1604853512
474 ontains the list of packages that have been recognized by \SpecialChar LyX
476 It is currently unused by the \SpecialChar LyX
477 program itself, but the information extracted,
478 and more, is made available with
479 \begin_inset Flex Noun
482 \begin_layout Plain Layout
483 Help\SpecialChar menuseparator
497 \begin_layout Labeling
498 \labelwidthstring 00.00.0000
499 \begin_inset Flex Code
502 \begin_layout Plain Layout
509 \change_deleted 232239728 1604853515
511 \change_inserted 232239728 1604853515
514 he list of text classes that have been found in your
515 \begin_inset Flex Code
518 \begin_layout Plain Layout
524 directories, along with the associated \SpecialChar LaTeX
525 document class and their description.
528 \begin_layout Labeling
529 \labelwidthstring 00.00.0000
530 \begin_inset Flex Code
533 \begin_layout Plain Layout
540 \change_deleted 232239728 1604853518
542 \change_inserted 232239728 1604853518
545 he list of layout modules found in your
546 \begin_inset Flex Code
549 \begin_layout Plain Layout
558 \begin_layout Labeling
559 \labelwidthstring 00.00.0000
560 \begin_inset Flex Code
563 \begin_layout Plain Layout
570 \change_deleted 232239728 1604853523
572 \change_inserted 232239728 1604853523
575 ists of various sorts of \SpecialChar LaTeX
576 -related files found on your system
579 \begin_layout Labeling
580 \labelwidthstring 00.00.0000
581 \begin_inset Flex Code
584 \begin_layout Plain Layout
585 doc/\SpecialChar LaTeX
591 is automatically generated during configuration from the file
592 \begin_inset Flex Code
595 \begin_layout Plain Layout
603 It contains information on your \SpecialChar LaTeX
607 \begin_layout Subsection
611 \begin_layout Standard
613 \change_deleted 5863208 1604928729
617 \change_inserted 5863208 1604928636
621 \change_inserted 5863208 1604928661
625 \begin_inset Flex Code
628 \begin_layout Plain Layout
635 \change_inserted 5863208 1604928662
637 \change_deleted 5863208 1604928642
641 \change_deleted 5863208 1604928669
643 \begin_inset Flex Code
646 \begin_layout Plain Layout
653 \change_inserted 5863208 1604928680
657 \begin_inset Flex Code
660 \begin_layout Plain Layout
668 \change_deleted 232239728 1604794430
671 exists in both places, the one in
672 \begin_inset Flex Code
675 \begin_layout Plain Layout
684 \begin_layout Labeling
685 \labelwidthstring 00.00.0000
686 \begin_inset Flex Code
689 \begin_layout Plain Layout
696 \change_deleted 232239728 1604794460
698 \change_inserted 232239728 1604794460
701 his directory contains files with the extension
702 \begin_inset Flex Code
705 \begin_layout Plain Layout
711 that define the keybindings used in \SpecialChar LyX
713 If there exists an internationalized version of the bind file named
714 \begin_inset Flex Code
717 \begin_layout Plain Layout
723 , that will be used first.
726 \begin_layout Labeling
727 \labelwidthstring 00.00.0000
728 \begin_inset Flex Code
731 \begin_layout Plain Layout
738 \change_deleted 232239728 1604794478
740 \change_inserted 232239728 1604794478
743 ontains files with the extension
744 \begin_inset Flex Code
747 \begin_layout Plain Layout
753 which define the diverse citation possibilities (natbib, biblatex etc.).
755 \begin_inset CommandInset ref
757 reference "subsec:Cite-Engine-Files"
767 \begin_layout Labeling
768 \labelwidthstring 00.00.0000
769 \begin_inset Flex Code
772 \begin_layout Plain Layout
779 \change_deleted 232239728 1604794483
781 \change_inserted 232239728 1604794486
784 ontains graphics files that can be included in documents.
788 \begin_layout Labeling
789 \labelwidthstring 00.00.0000
790 \begin_inset Flex Code
793 \begin_layout Plain Layout
800 \change_deleted 232239728 1604794492
802 \change_inserted 232239728 1604794492
805 ontains \SpecialChar LyX
806 documentation files (including the one you are currently reading).
808 \begin_inset Flex Code
811 \begin_layout Plain Layout
813 \change_deleted 232239728 1604794660
816 \change_inserted 232239728 1604794661
824 deserves special attention, as noted above.
825 The internationalized help docs are in subdirectories
826 \begin_inset Flex Code
829 \begin_layout Plain Layout
836 \begin_inset Quotes eld
840 \begin_inset Quotes erd
843 is the ISO language code.
845 \begin_inset CommandInset ref
847 reference "cha:Internationalizing-LyX"
854 \begin_layout Labeling
855 \labelwidthstring 00.00.0000
856 \begin_inset Flex Code
859 \begin_layout Plain Layout
866 \change_deleted 232239728 1604794497
868 \change_inserted 232239728 1604794497
871 ontains example files that explain how to use some features.
872 In the file browser, press the
873 \begin_inset Flex Noun
876 \begin_layout Plain Layout
885 \begin_layout Labeling
886 \labelwidthstring 00.00.0000
887 \begin_inset Flex Code
890 \begin_layout Plain Layout
897 \change_deleted 232239728 1604794500
899 \change_inserted 232239728 1604794500
902 ontains image files that are used by the
903 \begin_inset Flex Noun
906 \begin_layout Plain Layout
913 In addition, it also contains the individual icons used in the toolbar
914 and the banners that can be shown when \SpecialChar LyX
918 \begin_layout Labeling
919 \labelwidthstring 00.00.0000
920 \begin_inset Flex Code
923 \begin_layout Plain Layout
930 \change_deleted 232239728 1604794505
932 \change_inserted 232239728 1604794505
935 ontains keyboard keymapping files.
937 \begin_inset CommandInset ref
939 reference "sec:International-Keymap-Stuff"
946 \begin_layout Labeling
947 \labelwidthstring 00.00.0000
948 \begin_inset Flex Code
951 \begin_layout Plain Layout
958 \change_deleted 232239728 1604794508
960 \change_inserted 232239728 1604794508
963 ontains the text class and module files described in
964 \begin_inset CommandInset ref
966 reference "cha:Installing-New-Document"
973 \begin_layout Labeling
974 \labelwidthstring 00.00.0000
975 \begin_inset Flex Code
978 \begin_layout Plain Layout
985 \change_deleted 232239728 1604794513
987 \change_inserted 232239728 1604794513
991 \begin_inset Flex Code
994 \begin_layout Plain Layout
1000 Python scripts used to convert between \SpecialChar LyX
1002 These can be run from the command line if
1003 \change_deleted 232239728 1604794749
1006 you want to batch-convert files.
1009 \begin_layout Labeling
1010 \labelwidthstring 00.00.0000
1011 \begin_inset Flex Code
1014 \begin_layout Plain Layout
1021 \change_deleted 232239728 1604794516
1023 \change_inserted 232239728 1604794516
1026 ontains some files that demonstrate the capabilities of the
1027 \begin_inset Flex Noun
1030 \begin_layout Plain Layout
1032 \begin_inset space ~
1041 Also contains some scripts used by \SpecialChar LyX
1045 \begin_layout Labeling
1046 \labelwidthstring 00.00.0000
1047 \begin_inset Flex Code
1050 \begin_layout Plain Layout
1057 \change_deleted 232239728 1604794520
1059 \change_inserted 232239728 1604794520
1062 ontains the standard \SpecialChar LyX
1063 template files described in
1064 \begin_inset CommandInset ref
1066 reference "subsec:Creating-Templates"
1073 \begin_layout Labeling
1074 \labelwidthstring 00.00.0000
1075 \begin_inset Flex Code
1078 \begin_layout Plain Layout
1085 \change_deleted 232239728 1604794524
1087 \change_inserted 232239728 1604794524
1090 ontains files with the extension
1091 \begin_inset Flex Code
1094 \begin_layout Plain Layout
1100 that define the user interface to \SpecialChar LyX
1102 That is, the files define which items appear in which menus and the items
1103 appearing on the toolbar.
1106 \begin_layout Labeling
1107 \labelwidthstring 00.00.0000
1108 \begin_inset Flex Code
1111 \begin_layout Plain Layout
1118 \change_deleted 232239728 1604794528
1120 \change_inserted 232239728 1604794528
1123 ontains files with the extension
1124 \begin_inset Flex Code
1127 \begin_layout Plain Layout
1133 which define the templates for the insertion of external material to a
1136 \begin_inset CommandInset ref
1138 reference "chap:Including-External-Material"
1145 \begin_layout Subsection
1146 Files you don't want to modify
1149 \begin_layout Standard
1150 These files are used internally by \SpecialChar LyX
1151 and you generally do not need to modify
1152 them unless you are a developer.
1155 \begin_layout Labeling
1156 \labelwidthstring 00.00.0000
1157 \begin_inset Flex Code
1160 \begin_layout Plain Layout
1167 \change_deleted 232239728 1604797616
1169 \change_inserted 232239728 1604797616
1172 his file contains the list of \SpecialChar LyX
1174 The contents are displayed with the menu entry
1175 \begin_inset Flex Noun
1178 \begin_layout Plain Layout
1179 Help\SpecialChar menuseparator
1181 \begin_inset space ~
1192 \begin_layout Labeling
1193 \labelwidthstring 00.00.0000
1194 \begin_inset Flex Code
1197 \begin_layout Plain Layout
1204 \change_deleted 232239728 1604797620
1206 \change_inserted 232239728 1604797620
1209 his is a \SpecialChar LaTeX
1210 script used during the configuration process.
1211 Do not run directly.
1214 \begin_layout Labeling
1215 \labelwidthstring 00.00.0000
1216 \begin_inset Flex Code
1219 \begin_layout Plain Layout
1226 \change_deleted 232239728 1604797624
1228 \change_inserted 232239728 1604797624
1231 his is a Python script that is used to re-configure \SpecialChar LyX
1233 It creates configuration files in the directory it was run from.
1236 \begin_layout Subsection
1237 Other files needing a line or two
1240 \begin_layout Labeling
1241 \labelwidthstring 00.00.0000
1242 \begin_inset Flex Code
1245 \begin_layout Plain Layout
1252 \change_deleted 232239728 1604797580
1254 \change_inserted 232239728 1604797580
1257 his contains tables describing how different character encodings can be
1261 \begin_layout Labeling
1262 \labelwidthstring 00.00.0000
1263 \begin_inset Flex Code
1266 \begin_layout Plain Layout
1273 \change_deleted 232239728 1604797584
1275 \change_inserted 232239728 1604797584
1278 his file contains a list of all the languages currently supported by \SpecialChar LyX
1282 \begin_layout Labeling
1283 \labelwidthstring 00.00.0000
1284 \begin_inset Flex Code
1287 \begin_layout Plain Layout
1294 \change_deleted 232239728 1604797587
1296 \change_inserted 232239728 1604797587
1299 ontains information about the supported fonts.
1302 \begin_layout Labeling
1303 \labelwidthstring 00.00.0000
1304 \begin_inset Flex Code
1307 \begin_layout Plain Layout
1314 \change_deleted 232239728 1604797591
1316 \change_inserted 232239728 1604797591
1319 his file contains translations for internationalized paragraph styles (see
1321 \begin_inset CommandInset ref
1323 reference "subsec:I18n"
1330 \begin_layout Labeling
1331 \labelwidthstring 00.00.0000
1332 \begin_inset Flex Code
1335 \begin_layout Plain Layout
1342 \change_deleted 232239728 1604797594
1344 \change_inserted 232239728 1604797594
1347 his file contains information about Unicode-encoded glyphs and the way they
1348 are supported by \SpecialChar LyX
1349 via \SpecialChar LaTeX
1353 \begin_layout Section
1354 Your local configuration directory
1357 \begin_layout Standard
1358 Even if you are using \SpecialChar LyX
1359 as an unprivileged user, you might want to change
1361 configuration for your own use.
1363 \begin_inset Flex Code
1366 \begin_layout Plain Layout
1372 directory contains all your personal configuration files.
1373 This is the directory described as
1374 \begin_inset Quotes eld
1378 \begin_inset Quotes erd
1382 \begin_inset Flex Noun
1385 \begin_layout Plain Layout
1386 Help\SpecialChar menuseparator
1388 \begin_inset space ~
1397 This directory is used as a mirror of
1398 \begin_inset Flex Code
1401 \begin_layout Plain Layout
1407 , which means that every file in
1408 \begin_inset Flex Code
1411 \begin_layout Plain Layout
1417 is a replacement for the corresponding file in
1418 \begin_inset Flex Code
1421 \begin_layout Plain Layout
1428 Any configuration file described in the above sections can be placed either
1429 in the system-wide directory, in which case it will affect all users, or
1430 in your local directory for your own use.
1433 \begin_layout Standard
1434 To make things clearer, let's provide a few examples:
1437 \begin_layout Itemize
1438 The preferences set in the
1439 \begin_inset Flex Noun
1442 \begin_layout Plain Layout
1443 Tools\SpecialChar menuseparator
1449 dialog are saved to a file
1450 \begin_inset Flex Code
1453 \begin_layout Plain Layout
1460 \begin_inset Flex Code
1463 \begin_layout Plain Layout
1472 \begin_layout Itemize
1473 When you reconfigure using
1474 \begin_inset Flex Noun
1477 \begin_layout Plain Layout
1478 Tools\SpecialChar menuseparator
1486 \begin_inset Flex Code
1489 \begin_layout Plain Layout
1495 script, and the resulting files are written in your local configuration
1497 This means that any additional text class file that you might have added
1499 \begin_inset Flex Code
1502 \begin_layout Plain Layout
1508 will be added to the list of classes in the
1509 \begin_inset Flex Noun
1512 \begin_layout Plain Layout
1513 Document\SpecialChar menuseparator
1522 \begin_layout Itemize
1523 If you get some updated documentation from
1524 \change_inserted 232239728 1604798171
1528 ftp site and cannot install it because you do not have sysadmin rights
1529 on your system, you can just copy the files
1530 \change_deleted 232239728 1604798193
1532 \change_inserted 232239728 1604798193
1536 \begin_inset Flex Code
1539 \begin_layout Plain Layout
1545 and the items in the
1546 \begin_inset Flex Noun
1549 \begin_layout Plain Layout
1555 menu will open them!
1558 \begin_layout Section
1559 Running \SpecialChar LyX
1560 with multiple configurations
1563 \begin_layout Standard
1564 The configuration freedom of the local configuration directory may not suffice
1565 if you want to have more than one configuration at your disposal.
1566 For example, you may want to
1567 \change_deleted 232239728 1604798238
1570 use different key bindings or printer settings at different times.
1571 You can achieve this by having several such directories.
1572 You then specify which directory to use at run-time.
1575 \begin_layout Standard
1576 Invoking \SpecialChar LyX
1577 with the command line switch
1578 \begin_inset Flex Code
1581 \begin_layout Plain Layout
1591 instructs the program to read the configuration from that directory, and
1592 not from the default directory.
1593 (You can determine the default directory by running \SpecialChar LyX
1595 \begin_inset Flex Code
1598 \begin_layout Plain Layout
1604 switch.) If the specified directory does not exist, \SpecialChar LyX
1606 for you, just like it does for the default directory
1607 \change_deleted 232239728 1604798318
1610 the first time you run the program.
1611 You can modify the configuration options in this additional user directory
1612 exactly as you would for the default directory.
1613 These directories are completely independent (but read on).
1614 Note that setting the environment variable
1615 \begin_inset Flex Code
1618 \begin_layout Plain Layout
1624 to some value has exactly the same effect.
1627 \begin_layout Standard
1628 Having several configurations also requires more maintenance: if you want
1629 to add a new layout to
1630 \begin_inset Flex Code
1633 \begin_layout Plain Layout
1639 which you want available from all your configurations, you must add it
1640 to each directory separately.
1641 You can avoid this with the following trick: after \SpecialChar LyX
1642 creates the additional
1643 directory, most of the subdirectories (see above) are empty.
1644 If you want the new configuration to mirror an existing one, replace the
1645 empty subdirectory with a symbolic link to the matching subdirectory in
1646 the existing configuration.
1648 \begin_inset Flex Code
1651 \begin_layout Plain Layout
1657 subdirectory, however, since it contains a file written by the configuration
1658 script (also accessible through
1659 \begin_inset Flex Noun
1662 \begin_layout Plain Layout
1663 Tools\SpecialChar menuseparator
1669 ) which is configuration
1670 \change_deleted 232239728 1604798083
1672 \change_inserted 232239728 1604798100
1678 \begin_layout Chapter
1679 The Preferences dialog
1682 \begin_layout Standard
1683 All options of the preferences dialog are described in the Appendix
1685 The Preferences Dialog
1692 For some options you might find here more details.
1695 \begin_layout Section
1697 \begin_inset CommandInset label
1706 \begin_layout Standard
1707 The first step is to define your file formats if they are not already defined.
1709 \begin_inset Flex Noun
1712 \begin_layout Plain Layout
1713 Tools\SpecialChar menuseparator
1721 \begin_inset Flex Noun
1724 \begin_layout Plain Layout
1725 File Handling\SpecialChar menuseparator
1732 \begin_inset Flex Noun
1735 \begin_layout Plain Layout
1741 button to define your new format.
1743 \begin_inset Flex Noun
1746 \begin_layout Plain Layout
1752 field contains the name used to identify the format in the GUI.
1754 \begin_inset Flex Noun
1757 \begin_layout Plain Layout
1763 is used to identify the format internally.
1764 You will also need to enter a file extension.
1765 These are all required.
1767 \begin_inset Flex Noun
1770 \begin_layout Plain Layout
1776 field is used to provide a keyboard shortcut on the menus.
1777 (For example, pressing
1778 \begin_inset Flex Noun
1781 \begin_layout Plain Layout
1788 \begin_inset Flex Noun
1791 \begin_layout Plain Layout
1792 Document\SpecialChar menuseparator
1793 View (Other Formats)\SpecialChar menuseparator
1802 \begin_layout Standard
1804 \begin_inset Flex Noun
1807 \begin_layout Plain Layout
1814 \begin_inset Flex Noun
1817 \begin_layout Plain Layout
1824 For example, you might want to use
1825 \begin_inset Flex Noun
1828 \begin_layout Plain Layout
1834 to view PostScript files.
1835 You can enter the command needed to start the program in the corresponding
1837 In defining this command, you can use the four variables listed in the
1839 The viewer is launched when you view an image in \SpecialChar LyX
1841 \begin_inset Flex Noun
1844 \begin_layout Plain Layout
1845 Document\SpecialChar menuseparator
1852 The editor is for example launched when you right-click on an image and
1854 \begin_inset Flex Noun
1857 \begin_layout Plain Layout
1863 in the appearing context menu.
1866 \begin_layout Standard
1868 \begin_inset Flex Noun
1871 \begin_layout Plain Layout
1877 type of a format is optional, but if it is specified, it must be unique
1879 It is used to detect files of this format from the file contents.
1880 For some important file formats there is no MIME type officially registered
1882 \begin_inset CommandInset href
1885 target "http://www.iana.org/assignments/media-types/"
1891 Therefore \SpecialChar LyX
1892 uses the extended list of MIME types as specified by
1893 \begin_inset CommandInset href
1895 name "freedesktop.org"
1896 target "http://www.freedesktop.org/wiki/Specifications/shared-mime-info-spec"
1904 \begin_layout Standard
1906 \begin_inset Flex Noun
1909 \begin_layout Plain Layout
1915 option tells \SpecialChar LyX
1916 that a format is suitable for document export.
1917 If this is set and if a suitable conversion route exists (see
1918 \begin_inset CommandInset ref
1920 reference "sec:Converters"
1924 ), the format will appear in the
1925 \begin_inset Flex Noun
1928 \begin_layout Plain Layout
1929 File\SpecialChar menuseparator
1936 The format will also appear in the
1937 \begin_inset Flex Noun
1940 \begin_layout Plain Layout
1941 Document\SpecialChar menuseparator
1947 menu if a viewer is specified for the format.
1948 Pure image formats, such as
1949 \begin_inset Flex Code
1952 \begin_layout Plain Layout
1958 , should not use this option.
1959 Formats that can both represent vector graphics and documents like
1960 \begin_inset Flex Code
1963 \begin_layout Plain Layout
1972 \begin_layout Standard
1974 \begin_inset Flex Noun
1977 \begin_layout Plain Layout
1978 Vector graphics format
1983 tells \SpecialChar LyX
1984 that a format can contain vector graphics.
1985 This information is used to determine the target format of included graphics
1987 \begin_inset Flex Noun
1990 \begin_layout Plain Layout
1997 Included graphics may need to be converted to either
1998 \begin_inset Flex Noun
2001 \begin_layout Plain Layout
2008 \begin_inset Flex Noun
2011 \begin_layout Plain Layout
2018 \begin_inset Flex Noun
2021 \begin_layout Plain Layout
2028 \begin_inset Flex Noun
2031 \begin_layout Plain Layout
2037 cannot handle other image formats.
2038 If an included graphic is not already in
2039 \begin_inset Flex Noun
2042 \begin_layout Plain Layout
2049 \begin_inset Flex Noun
2052 \begin_layout Plain Layout
2059 \begin_inset Flex Noun
2062 \begin_layout Plain Layout
2068 format, it is converted to
2069 \begin_inset Flex Noun
2072 \begin_layout Plain Layout
2078 if the vector format option is set, and otherwise to
2079 \begin_inset Flex Noun
2082 \begin_layout Plain Layout
2091 \begin_layout Section
2095 \begin_layout Standard
2096 Since all conversions from one format to another take place in \SpecialChar LyX
2098 directory, it is sometimes necessary to modify a file before copying it
2099 to the temporary directory in order that the conversion may be performed.
2103 \begin_layout Plain Layout
2104 For example, the file may refer to other files—images, for example—using
2105 relative file names, and these may become invalid when the file is copied
2106 to the temporary directory.
2111 This is done by a Copier: It copies a file to (or from) the temporary directory
2112 and may modify it in the process.
2115 \begin_layout Standard
2116 The definitions of the copiers may use eight variables:
2119 \begin_layout Labeling
2120 \labelwidthstring 00.00.0000
2121 \begin_inset Flex Code
2124 \begin_layout Plain Layout
2130 The \SpecialChar LyX
2131 system directory (e.
2132 \begin_inset space \thinspace{}
2136 \begin_inset space \space{}
2140 \begin_inset Flex Noun
2143 \begin_layout Plain Layout
2152 \begin_layout Labeling
2153 \labelwidthstring 00.00.0000
2154 \begin_inset Flex Code
2157 \begin_layout Plain Layout
2166 \begin_layout Labeling
2167 \labelwidthstring 00.00.0000
2168 \begin_inset Flex Code
2171 \begin_layout Plain Layout
2180 \begin_layout Labeling
2181 \labelwidthstring 00.00.0000
2182 \begin_inset Flex Code
2185 \begin_layout Plain Layout
2191 The base name (without filename extension) in the \SpecialChar LyX
2195 \begin_layout Labeling
2196 \labelwidthstring 00.00.0000
2197 \begin_inset Flex Code
2200 \begin_layout Plain Layout
2206 The full directory path of the \SpecialChar LyX
2210 \begin_layout Labeling
2211 \labelwidthstring 00.00.0000
2212 \begin_inset Flex Code
2215 \begin_layout Plain Layout
2221 The full pathname to the original \SpecialChar LyX
2222 file being processed
2225 \begin_layout Labeling
2226 \labelwidthstring 00.00.0000
2227 \begin_inset Flex Code
2230 \begin_layout Plain Layout
2236 The filename (without any directory path) of the \SpecialChar LyX
2240 \begin_layout Labeling
2241 \labelwidthstring 00.00.0000
2242 \begin_inset Flex Code
2245 \begin_layout Plain Layout
2251 The `\SpecialChar LaTeX
2255 \begin_layout Standard
2256 The latter should be the filename as it would be used in a \SpecialChar LaTeX
2264 It is relevant only when exporting files suitable for such inclusion.
2267 \begin_layout Standard
2268 Copiers can be used to do almost anything with output files.
2269 For example, suppose you want generated pdf files to be copied to a special
2271 \begin_inset Flex Code
2274 \begin_layout Plain Layout
2281 Then you could write a shell script such as this one:
2284 \begin_layout Standard
2285 \begin_inset listings
2289 \begin_layout Plain Layout
2294 \begin_layout Plain Layout
2299 \begin_layout Plain Layout
2301 TOFILE=`basename $2`
2304 \begin_layout Plain Layout
2306 cp $FROMFILE /home/you/pdf/$TOFILE
2311 Save it in your local \SpecialChar LyX
2313 \begin_inset Flex Code
2316 \begin_layout Plain Layout
2317 /home/you/.lyx/scripts/pdfcopier.sh
2322 —and make it executable, if you need to do so on your platform.
2324 \begin_inset Flex Noun
2327 \begin_layout Plain Layout
2328 Tools\SpecialChar menuseparator
2334 dialog, select under
2335 \begin_inset Flex Noun
2338 \begin_layout Plain Layout
2339 File Handling\SpecialChar menuseparator
2346 \begin_inset Flex Noun
2349 \begin_layout Plain Layout
2355 format—or one of the other pdf formats—and enter
2356 \begin_inset Flex Code
2359 \begin_layout Plain Layout
2360 pdfcopier.sh $$i $$o
2366 \begin_inset Flex Noun
2369 \begin_layout Plain Layout
2379 \begin_layout Standard
2380 Copiers are used by \SpecialChar LyX
2381 in various of its own conversions.
2382 For example, if appropriate programs are found, \SpecialChar LyX
2383 will automatically install
2385 \begin_inset Flex Noun
2388 \begin_layout Plain Layout
2395 \begin_inset Flex Noun
2398 \begin_layout Plain Layout
2400 \begin_inset space ~
2409 When these formats are exported, the copier sees that not just the main
2410 HTML file but various associated files (style files, images, etc.) are also
2412 All these files are written to a subdirectory of the directory in which
2413 the original \SpecialChar LyX
2418 \begin_layout Plain Layout
2419 This copier can be customized.
2421 \begin_inset Quotes eld
2425 \begin_inset Quotes erd
2428 argument takes a comma-separated list of extensions to be copied; if it
2429 is omitted, all files will be copied.
2431 \begin_inset Quotes eld
2435 \begin_inset Quotes erd
2438 argument determines the extension added to the generated directory.
2440 \begin_inset Quotes eld
2444 \begin_inset Flex Noun
2447 \begin_layout Plain Layout
2454 \begin_inset Quotes erd
2457 , so HTML generated from
2458 \begin_inset Flex Noun
2461 \begin_layout Plain Layout
2462 /path/to/filename.lyx
2468 \begin_inset Flex Noun
2471 \begin_layout Plain Layout
2472 /path/to/filename.html.LyXconv
2486 \begin_layout Section
2488 \begin_inset CommandInset label
2490 name "sec:Converters"
2497 \begin_layout Standard
2498 You can define your own Converters to convert files between different formats.
2500 \begin_inset Flex Noun
2503 \begin_layout Plain Layout
2504 Tools\SpecialChar menuseparator
2505 Preferences\SpecialChar menuseparator
2506 File Handling\SpecialChar menuseparator
2515 \begin_layout Standard
2516 To define a new converter, select the
2517 \begin_inset Flex Noun
2520 \begin_layout Plain Layout
2522 \begin_inset space ~
2531 \begin_inset Flex Noun
2534 \begin_layout Plain Layout
2536 \begin_inset space ~
2544 from the drop-down lists, enter the command needed for the conversion,
2546 \begin_inset Flex Noun
2549 \begin_layout Plain Layout
2556 Several variables can be used in the definition of converters:
2559 \begin_layout Labeling
2560 \labelwidthstring 00.00.0000
2561 \begin_inset Flex Code
2564 \begin_layout Plain Layout
2570 The \SpecialChar LyX
2574 \begin_layout Labeling
2575 \labelwidthstring 00.00.0000
2576 \begin_inset Flex Code
2579 \begin_layout Plain Layout
2588 \begin_layout Labeling
2589 \labelwidthstring 00.00.0000
2590 \begin_inset Flex Code
2593 \begin_layout Plain Layout
2602 \begin_layout Labeling
2603 \labelwidthstring 00.00.0000
2604 \begin_inset Flex Code
2607 \begin_layout Plain Layout
2613 The base filename of the input file (i.
2614 \begin_inset space \thinspace{}
2617 g., without the extension)
2620 \begin_layout Labeling
2621 \labelwidthstring 00.00.0000
2622 \begin_inset Flex Code
2625 \begin_layout Plain Layout
2631 The path to the input file
2634 \begin_layout Labeling
2635 \labelwidthstring 00.00.0000
2636 \begin_inset Flex Code
2639 \begin_layout Plain Layout
2645 The path to the original input file (this is different from $$p when a
2646 chain of converters is called)
2649 \begin_layout Labeling
2650 \labelwidthstring 00.00.0000
2651 \begin_inset Flex Code
2654 \begin_layout Plain Layout
2660 The iconv name for the encoding of the document.
2663 \begin_layout Standard
2665 \begin_inset Flex Noun
2668 \begin_layout Plain Layout
2670 \begin_inset space ~
2678 field you can enter the following flags, separated by commas:
2681 \begin_layout Labeling
2682 \labelwidthstring 00.00.0000
2683 \begin_inset Flex Code
2686 \begin_layout Plain Layout
2688 \change_inserted -712698321 1524656940
2696 This converter runs some form of \SpecialChar LaTeX
2698 This will make \SpecialChar LyX
2699 's \SpecialChar LaTeX
2700 error logs available.
2702 \change_inserted -712698321 1524657018
2704 \begin_inset Flex Code
2707 \begin_layout Plain Layout
2709 \change_inserted -712698321 1524657012
2717 value specifies the form of \SpecialChar LaTeX
2719 \begin_inset Flex Code
2722 \begin_layout Plain Layout
2724 \change_inserted -712698321 1524657005
2725 latex, pdflatex, platex, xetex, luatex
2733 If no value is specified,
2734 \begin_inset Flex Code
2737 \begin_layout Plain Layout
2739 \change_inserted -712698321 1524657018
2752 \begin_layout Labeling
2753 \labelwidthstring 00.00.0000
2754 \begin_inset Flex Code
2757 \begin_layout Plain Layout
2759 \change_inserted -712698321 1524656935
2767 Needs the \SpecialChar LaTeX
2769 \begin_inset Flex Noun
2772 \begin_layout Plain Layout
2778 file for the conversion.
2780 \change_inserted -712698321 1524657047
2782 \begin_inset Flex Code
2785 \begin_layout Plain Layout
2787 \change_inserted -712698321 1524657030
2795 value specifies the form of \SpecialChar LaTeX
2796 that is run in order to generate the
2797 \begin_inset Flex Noun
2800 \begin_layout Plain Layout
2802 \change_inserted -712698321 1524657047
2811 \begin_inset Flex Code
2814 \begin_layout Plain Layout
2816 \change_inserted -712698321 1524657030
2817 latex, pdflatex, platex, xetex, luatex
2825 If no value is specified,
2826 \begin_inset Flex Code
2829 \begin_layout Plain Layout
2831 \change_inserted -712698321 1524657030
2844 \begin_layout Labeling
2845 \labelwidthstring 00.00.0000
2846 \begin_inset Flex Code
2849 \begin_layout Plain Layout
2856 \begin_inset Quotes eld
2860 \begin_inset Quotes erd
2863 file from the backend, which in practice means a \SpecialChar LaTeX
2864 file like the one we
2865 would export, without
2866 \begin_inset Flex Code
2869 \begin_layout Plain Layout
2878 \begin_layout Labeling
2879 \labelwidthstring 00.00.0000
2880 \begin_inset Flex Code
2883 \begin_layout Plain Layout
2892 \begin_layout Standard
2893 The following three flags are not really flags at all because they take
2895 \begin_inset Flex Noun
2898 \begin_layout Plain Layout
2900 \begin_inset space ~
2904 \begin_inset space ~
2915 \begin_layout Labeling
2916 \labelwidthstring 00.00.0000
2918 \change_inserted -712698321 1523206314
2919 \begin_inset Flex Code
2922 \begin_layout Plain Layout
2924 \change_inserted -712698321 1523206193
2932 The name of the driver that needs to be loaded with the
2936 package for this converter.
2937 The loading of the correct driver is necessary to get some PDF-specific
2946 \begin_layout Labeling
2947 \labelwidthstring 00.00.0000
2948 \begin_inset Flex Code
2951 \begin_layout Plain Layout
2957 If set, the converter's standard error will be redirected to a file
2958 \begin_inset Flex Code
2961 \begin_layout Plain Layout
2967 , and the script given as argument will be run as:
2968 \begin_inset Flex Code
2971 \begin_layout Plain Layout
2972 script < infile.out > infile.log
2978 The argument may contain
2979 \begin_inset Flex Code
2982 \begin_layout Plain Layout
2991 \begin_layout Labeling
2992 \labelwidthstring 00.00.0000
2993 \begin_inset Flex Code
2996 \begin_layout Plain Layout
3002 The name of the directory in which the converter will dump the generated
3005 will not create this directory, and it does not copy anything into it,
3006 though it will copy this directory to the destination.
3007 The argument may contain
3008 \begin_inset Flex Code
3011 \begin_layout Plain Layout
3017 , which will be replaced by the base name of the input and output files,
3018 respectively, when the directory is copied.
3019 \begin_inset Newline newline
3022 Note that resultdir and usetempdir make no sense together.
3023 The latter will be ignored if the former is given.
3026 \begin_layout Labeling
3027 \labelwidthstring 00.00.0000
3028 \begin_inset Flex Code
3031 \begin_layout Plain Layout
3037 Determines the output file name and may, contain
3038 \begin_inset Flex Code
3041 \begin_layout Plain Layout
3048 Sensible only with resultdir and optional even then; if not given, it defaults
3052 \begin_layout Standard
3054 \change_inserted -712698321 1523206384
3055 A suitable hyperref-driver is set for some converters that are installed
3056 with \SpecialChar LyX
3059 \change_deleted -712698321 1523206388
3061 \change_inserted -712698321 1523206389
3065 \change_inserted -712698321 1523206400
3069 \change_inserted -712698321 1523206407
3073 \change_inserted -712698321 1523206437
3077 \change_deleted -712698321 1523206442
3078 that are installed with \SpecialChar LyX
3085 \begin_layout Standard
3086 You do not have to define converters for all formats between which you want
3088 For example, you will note that there is no `\SpecialChar LyX
3089 to PostScript' converter,
3090 but \SpecialChar LyX
3091 will export PostScript.
3092 It does so by first creating a \SpecialChar LaTeX
3093 file (no converter needs to be defined
3094 for this) which is then converted to DVI using the `\SpecialChar LaTeX
3096 and finally converting the resulting DVI file to PostScript.
3098 finds such `chains' of converters automatically, and it will always choose
3099 the shortest possible chain.
3100 You can, though, still define multiple conversion methods between file
3102 For example, the standard \SpecialChar LyX
3103 configuration provides five ways to convert
3108 \begin_layout Enumerate
3110 \begin_inset Flex Noun
3113 \begin_layout Plain Layout
3122 \begin_layout Enumerate
3123 via (DVI and) PostScript, using
3124 \begin_inset Flex Noun
3127 \begin_layout Plain Layout
3136 \begin_layout Enumerate
3138 \begin_inset Flex Noun
3141 \begin_layout Plain Layout
3150 \begin_layout Enumerate
3152 \begin_inset Flex Noun
3155 \begin_layout Plain Layout
3165 \begin_layout Enumerate
3167 \begin_inset Flex Noun
3170 \begin_layout Plain Layout
3180 \begin_layout Standard
3181 To define such alternate chains, you must define multiple target `file formats',
3183 \begin_inset CommandInset ref
3185 reference "sec:Formats"
3190 For example, in the standard configuration, the formats named
3191 \begin_inset Flex Noun
3194 \begin_layout Plain Layout
3201 \begin_inset Flex Noun
3204 \begin_layout Plain Layout
3211 \begin_inset Flex Noun
3214 \begin_layout Plain Layout
3221 \begin_inset Flex Noun
3224 \begin_layout Plain Layout
3231 \begin_inset Flex Noun
3234 \begin_layout Plain Layout
3241 \begin_inset Flex Noun
3244 \begin_layout Plain Layout
3251 \begin_inset Flex Noun
3254 \begin_layout Plain Layout
3261 \begin_inset Flex Noun
3264 \begin_layout Plain Layout
3272 \begin_inset Flex Noun
3275 \begin_layout Plain Layout
3282 \begin_inset Flex Noun
3285 \begin_layout Plain Layout
3292 ) are defined, all of which share the extension
3293 \begin_inset Flex Noun
3296 \begin_layout Plain Layout
3302 , and which correspond to the conversion methods just mentioned.
3305 \begin_layout Chapter
3306 Internationalizing \SpecialChar LyX
3308 \begin_inset CommandInset label
3310 name "cha:Internationalizing-LyX"
3317 \begin_layout Standard
3319 supports using a translated interface.
3320 Last time we checked, \SpecialChar LyX
3321 provided text in thirty languages.
3322 The language of choice is called your
3327 (For further reading on locale settings, see also the documentation for
3328 locale that comes with your operating system.
3329 For Linux, the manual page for
3330 \begin_inset Flex Code
3333 \begin_layout Plain Layout
3339 could be a good place to start).
3342 \begin_layout Standard
3343 Notice that these translations will work, but do contain a few flaws.
3344 In particular, all dialogs have been designed with the English text in
3345 mind, which means that some of the translated text will be too large to
3346 fit within the space allocated.
3347 This is only a display problem and will not cause any harm.
3348 Also, you will find that some of the translations do not define shortcut
3349 keys for everything.
3350 Sometimes, there are simply not enough free letters to do it.
3351 Other times, the translator just hasn't got around to doing it yet.
3352 Our localization team, which you may wish to join,
3356 \begin_layout Plain Layout
3357 If you are a fluent speaker of a language other than English, joining these
3358 teams is a great way to give back to the \SpecialChar LyX
3364 will of course try to fix these shortcomings in future versions of \SpecialChar LyX
3368 \begin_layout Section
3369 Translating \SpecialChar LyX
3373 \begin_layout Subsection
3374 Translating the graphical user interface (text messages).
3377 \begin_layout Standard
3380 \begin_inset Flex Code
3383 \begin_layout Plain Layout
3389 library to handle the internationalization of the interface.
3390 To have \SpecialChar LyX
3391 speak your favorite language in all menus and dialogs, you need
3393 \begin_inset Flex Code
3396 \begin_layout Plain Layout
3402 -file for that language.
3403 When this is available, you'll have to generate a
3404 \begin_inset Flex Code
3407 \begin_layout Plain Layout
3413 -file from it and install the
3414 \begin_inset Flex Code
3417 \begin_layout Plain Layout
3424 The process of doing all of this is explained in the documentation for
3426 \begin_inset Flex Code
3429 \begin_layout Plain Layout
3436 It is possible to do this just for yourself, but if you're going to do
3437 it, you might as well share the results of your labors with the rest of
3438 the \SpecialChar LyX
3440 Send a message to the \SpecialChar LyX
3441 developers' list for more information about how
3445 \begin_layout Standard
3446 In short, this is what you should do (xx denotes the language code):
3449 \begin_layout Itemize
3450 Check out the \SpecialChar LyX
3453 \begin_inset CommandInset href
3455 name "information on the web"
3456 target "https://www.lyx.org/HowToUseGIT"
3464 \begin_layout Itemize
3466 \begin_inset Flex Code
3469 \begin_layout Plain Layout
3475 to the folder of the
3476 \begin_inset Flex Code
3479 \begin_layout Plain Layout
3487 \begin_inset Flex Code
3490 \begin_layout Plain Layout
3498 \begin_inset Flex Code
3501 \begin_layout Plain Layout
3507 doesn't exist anywhere, it can be remade with the console command
3508 \begin_inset Flex Code
3511 \begin_layout Plain Layout
3517 in that directory, or you can use an existing po-file for some other language
3521 \begin_layout Itemize
3523 \begin_inset Flex Code
3526 \begin_layout Plain Layout
3536 \begin_layout Plain Layout
3537 This is just a text file, so it can be edited in any text editor.
3538 But there are also specialized programs that support such editing, such
3543 (for all platforms) or
3552 contains a `mode' for editing
3553 \begin_inset Flex Code
3556 \begin_layout Plain Layout
3563 \begin_inset Flex URL
3566 \begin_layout Plain Layout
3568 https://www.gnu.org/software/gettext/manual/html_node/PO-Mode.html#PO-Mode
3578 For some menu- and widget-labels, there are also shortcut keys that should
3580 Those keys are marked after a `|', and should be translated according to
3581 the words and phrases of the language.
3582 You should also fill also out the information at the beginning of the new
3584 \begin_inset Flex Code
3587 \begin_layout Plain Layout
3593 -file with your email-address, etc., so people know where to reach you with
3594 suggestions and entertaining flames.
3597 \begin_layout Standard
3598 If you are just doing this on your own, then:
3601 \begin_layout Itemize
3603 \begin_inset Flex Code
3606 \begin_layout Plain Layout
3613 This can be done with
3614 \begin_inset Flex Code
3617 \begin_layout Plain Layout
3618 msgfmt -o xx.mo < xx.po
3626 \begin_layout Itemize
3628 \begin_inset Flex Code
3631 \begin_layout Plain Layout
3637 -file to your locale-tree, at the correct directory for application messages
3642 xx, and under the name
3643 \begin_inset Flex Code
3646 \begin_layout Plain Layout
3653 \begin_inset space \thinspace{}
3657 \begin_inset space \space{}
3661 \begin_inset Flex Code
3664 \begin_layout Plain Layout
3665 /usr/local/share/locale/xx/LC_MESSAGES/lyx.mo
3675 \begin_layout Standard
3676 As said, however, it would be best if the new
3677 \begin_inset Flex Code
3680 \begin_layout Plain Layout
3686 file could be added to the \SpecialChar LyX
3687 distribution, so others can use it.
3688 Adding it involves making additional changes to \SpecialChar LyX
3690 So send an email to the developers' mailing list if you're interested in
3694 \begin_layout Subsubsection
3698 \begin_layout Standard
3699 Sometimes it turns out that one English message needs to be translated into
3700 different messages in the target language.
3701 One example is the message
3702 \begin_inset Flex Code
3705 \begin_layout Plain Layout
3711 which has the German translation
3719 , depending upon exactly what the English
3720 \begin_inset Quotes eld
3724 \begin_inset Quotes erd
3729 \begin_inset Flex Code
3732 \begin_layout Plain Layout
3738 does not handle such ambiguous translations.
3739 Therefore you have to add some context information to the message: Instead
3741 \begin_inset Flex Code
3744 \begin_layout Plain Layout
3751 \begin_inset Flex Code
3754 \begin_layout Plain Layout
3755 To[[as in 'From format x to format y']]
3761 \begin_inset Flex Code
3764 \begin_layout Plain Layout
3765 To[[as in 'From page x to page y']].
3770 Now the two occurrences of
3771 \begin_inset Flex Code
3774 \begin_layout Plain Layout
3781 \begin_inset Flex Code
3784 \begin_layout Plain Layout
3790 and can be translated correctly to
3801 \begin_layout Standard
3802 Of course the context information needs to be stripped off the original
3803 message when no translation is used.
3804 Therefore you have to put it in double square brackets at the end of the
3805 message (see the example above).
3806 The translation mechanism of \SpecialChar LyX
3807 ensures that everything in double square
3808 brackets at the end of messages is removed before displaying the message.
3811 \begin_layout Subsection
3812 Translating the documentation.
3815 \begin_layout Standard
3816 The online documentation (in the
3817 \begin_inset Flex Noun
3820 \begin_layout Plain Layout
3826 -menu) can (and should!) be translated.
3827 If there are translated versions of the documentation available
3831 \begin_layout Plain Layout
3832 As of March 2008, at least some of the documents have been translated into
3833 fourteen languages, with the Tutorial available in a few more.
3838 and the locale is set accordingly, these will be used automagically by
3842 looks for translated versions as
3843 \begin_inset Flex Code
3846 \begin_layout Plain Layout
3847 LyXDir/doc/xx/DocName.lyx
3853 \begin_inset Flex Code
3856 \begin_layout Plain Layout
3862 is the code for the language currently in use.
3863 If there are no translated documents, the default English versions will
3865 Note that the translated versions must have the same filenames (
3866 \begin_inset Flex Code
3869 \begin_layout Plain Layout
3875 above) as the original.
3876 If you feel up to translating the documentation (an excellent way to proof-read
3877 the original documentation by the way!), there are a few things you should
3881 \begin_layout Itemize
3882 Check out the documentation translation web page at
3883 \begin_inset CommandInset href
3885 name "https://www.lyx.org/Translation"
3886 target "https://www.lyx.org/Translation"
3892 That way, you can find out which (if any) documents have already been translate
3893 d into your language.
3894 You can also find out who (if anyone) is organizing the effort to translate
3895 the documentation into your language.
3896 If no one is organizing the effort, please let us know that you're interested.
3899 \begin_layout Standard
3900 Once you get to actually translating, here's a few hints for you that may
3904 \begin_layout Itemize
3905 Join the documentation team! There is information on how to do that in
3906 \begin_inset Flex Code
3909 \begin_layout Plain Layout
3916 \begin_inset Flex Noun
3919 \begin_layout Plain Layout
3920 Help\SpecialChar menuseparator
3926 ), which by the way is the first document you should translate.
3929 \begin_layout Itemize
3930 Learn the typographic conventions for the language you are translating to.
3931 Typography is an ancient art and over the centuries, a great variety of
3932 conventions have developed throughout different parts of the world.
3933 Also study the professional terminology amongst typographers in your country.
3934 Inventing your own terminology will only confuse the users.
3937 (Warning! Typography is addictive!)
3940 \begin_layout Itemize
3941 Make a copy of the document.
3942 This will be your working copy.
3943 You can use this as your personal translated help-file by placing it in
3945 \begin_inset Flex Code
3948 \begin_layout Plain Layout
3955 \begin_inset Note Greyedout
3958 \begin_layout Plain Layout
3963 For a complex document with external material (images, etc.), if you make
3965 \begin_inset space \thinspace{}
3969 \begin_inset space \space{}
3972 in a temp dir, beware that the links to external material may be broken
3973 when the document is moved to a different place.
3974 The best way is to retrieve the \SpecialChar LyX
3976 \begin_inset Flex URL
3979 \begin_layout Plain Layout
3981 https://www.lyx.org/HowToUseGIT
3986 ) and to edit the doc file in place.
3994 \begin_layout Itemize
3995 Sometimes the original document (from the \SpecialChar LyX
3996 team) will be updated.
3997 Use the source viewer at
3998 \begin_inset CommandInset href
4000 name "https://www.lyx.org/trac/timeline"
4001 target "https://www.lyx.org/trac/timeline"
4006 to see what has been changed.
4007 That way you can easily see which parts of the translated document need
4011 \begin_layout Standard
4012 If you ever find an error in the original document, fix it and notify the
4013 rest of the documentation team of the changes! (You didn't forget to join
4014 the documentation team, did you?)
4017 \begin_layout Standard
4018 \begin_inset Branch OutDated
4022 \begin_layout Section
4023 International Keyboard Support
4026 \begin_layout Standard
4029 [Editor's Note: The following section is by
4037 It needs to be fixed to conform to the new Documentation Style sheet and
4038 to make use of the new v1.0 features.
4039 The whole thing also needs to be merged with the section following it.-jw
4040 It may also be badly out of date.-rh (2008)]
4043 \begin_layout Subsection
4044 Defining Own Keymaps: Keymap File Format
4047 \begin_layout Standard
4048 Let's look at a keyboard definition file a little closer.
4049 It is a plain text file defining
4052 \begin_layout Itemize
4053 key-to-key or key-to-string translations
4056 \begin_layout Itemize
4060 \begin_layout Itemize
4061 dead keys exceptions
4064 \begin_layout Standard
4065 To define key-to-key or key-to-string translation, use this command:
4068 \begin_layout Quotation
4069 \begin_inset Flex Code
4072 \begin_layout Plain Layout
4081 \begin_inset Flex Code
4084 \begin_layout Plain Layout
4093 \begin_layout Standard
4095 \begin_inset Flex Code
4098 \begin_layout Plain Layout
4104 is the key to be translated and
4105 \begin_inset Flex Code
4108 \begin_layout Plain Layout
4114 is the string to be inserted into the document.
4115 To define dead keys, use:
4118 \begin_layout Quotation
4119 \begin_inset Flex Code
4122 \begin_layout Plain Layout
4131 \begin_inset Flex Code
4134 \begin_layout Plain Layout
4143 \begin_layout Standard
4145 \begin_inset Flex Code
4148 \begin_layout Plain Layout
4154 is a keyboard key and
4155 \begin_inset Flex Code
4158 \begin_layout Plain Layout
4165 The following dead keys are supported (shortcut name is in parentheses):
4168 \begin_layout Quotation
4172 \begin_inset space \hfill{}
4178 \begin_layout Quotation
4180 \begin_inset space \hfill{}
4186 \begin_layout Quotation
4188 \begin_inset space \hfill{}
4194 \begin_layout Quotation
4196 \begin_inset space \hfill{}
4202 \begin_layout Quotation
4204 \begin_inset space \hfill{}
4210 \begin_layout Quotation
4212 \begin_inset space \hfill{}
4219 \begin_layout Plain Layout
4231 \begin_layout Quotation
4233 \begin_inset space \hfill{}
4239 \begin_layout Quotation
4241 \begin_inset space \hfill{}
4248 \begin_layout Plain Layout
4260 \begin_layout Quotation
4262 \begin_inset space \hfill{}
4268 \begin_layout Quotation
4270 \begin_inset space \hfill{}
4276 \begin_layout Quotation
4278 \begin_inset space \hfill{}
4285 \begin_layout Plain Layout
4297 \begin_layout Quotation
4299 \begin_inset space \hfill{}
4306 \begin_layout Plain Layout
4318 \begin_layout Quotation
4320 \begin_inset space \hfill{}
4326 \begin_layout Quotation
4327 hungarian umlaut (hug)
4328 \begin_inset space \hfill{}
4334 \begin_layout Quotation
4336 \begin_inset space \hfill{}
4342 \begin_layout Quotation
4344 \begin_inset space \hfill{}
4351 \begin_layout Plain Layout
4363 \begin_layout Standard
4364 Since in many international keyboards there are exceptions to what some
4365 dead keys should do, you can define them using
4368 \begin_layout Quotation
4369 \begin_inset Flex Code
4372 \begin_layout Plain Layout
4380 deadkey key outstring
4383 \begin_layout Standard
4384 For example, on Slovak keyboard, if you enter caron-o, it generates circumflex-o
4388 \begin_layout Quotation
4389 \begin_inset Flex Code
4392 \begin_layout Plain Layout
4405 \begin_layout Standard
4406 to make it work correctly.
4407 Also, you have to define as exceptions dead keys over i and j, to remove
4408 the dot from them before inserting an accent mark.
4409 I will change this when the time comes, but so far I haven't had time.
4412 \begin_layout Standard
4413 Oh, and about characters: backslash is escaped, so to enter it, you'll need
4416 \begin_inset Flex Code
4419 \begin_layout Plain Layout
4425 have different meaning.
4427 \begin_inset Flex Code
4430 \begin_layout Plain Layout
4436 marks comments, quotes start and end \SpecialChar LaTeX
4438 To enter quote, you'll need to use
4439 \begin_inset Flex Code
4442 \begin_layout Plain Layout
4451 \begin_inset Flex Code
4454 \begin_layout Plain Layout
4461 \begin_inset Flex Code
4464 \begin_layout Plain Layout
4475 \begin_layout Standard
4476 If you make a keyboard description file that works for your language, please
4477 mail it to me, so I can include it in the next keymap distribution.
4480 \begin_layout Standard
4481 More keywords will be supported in keymap configuration file in future,
4485 \begin_layout Itemize
4486 \begin_inset Flex Code
4489 \begin_layout Plain Layout
4500 \begin_inset space \hfill{}
4504 \begin_inset Flex Code
4507 \begin_layout Plain Layout
4516 \begin_layout Itemize
4517 \begin_inset Flex Code
4520 \begin_layout Plain Layout
4531 \begin_inset space \hfill{}
4535 \begin_inset Flex Code
4538 \begin_layout Plain Layout
4544 an external keymap translation program
4547 \begin_layout Standard
4548 Also, it should look into
4549 \begin_inset Flex Code
4552 \begin_layout Plain Layout
4558 file for defaults, too (for example, a
4559 \begin_inset Flex Code
4562 \begin_layout Plain Layout
4570 option to include default keyboard).
4578 \begin_layout Section
4579 International Keymap Stuff
4580 \begin_inset CommandInset label
4582 name "sec:International-Keymap-Stuff"
4589 \begin_layout Standard
4590 \begin_inset Note Note
4593 \begin_layout Plain Layout
4594 In doing the revisions on this document in March 2008, I did not look over
4595 this stuff, as I do not understand it.
4596 It would be good if someone else could do so.
4605 \begin_layout Standard
4606 The next two sections describe the
4607 \begin_inset Flex Code
4610 \begin_layout Plain Layout
4619 \begin_inset Flex Code
4622 \begin_layout Plain Layout
4630 file syntax in detail.
4631 These sections should help you design your own key map if the ones provided
4632 do not meet your needs.
4635 \begin_layout Subsection
4639 \begin_layout Standard
4643 \begin_inset Flex Code
4646 \begin_layout Plain Layout
4652 file maps keystrokes to characters or strings.
4653 As the name suggests, it sets a keyboard mapping.
4655 \begin_inset Flex Code
4658 \begin_layout Plain Layout
4669 \begin_inset Flex Code
4672 \begin_layout Plain Layout
4687 \begin_inset Flex Code
4690 \begin_layout Plain Layout
4703 \begin_inset Flex Code
4706 \begin_layout Plain Layout
4715 \begin_inset Flex Code
4718 \begin_layout Plain Layout
4726 are described in this section.
4729 \begin_layout Labeling
4730 \labelwidthstring 00.00.0000
4731 \begin_inset Flex Code
4734 \begin_layout Plain Layout
4742 Map a character to a string
4745 \begin_layout LyX-Code
4760 \begin_layout Standard
4793 the double-quote (")
4810 must be escaped with a preceding backslash (
4821 \begin_layout Standard
4823 \begin_inset Flex Noun
4826 \begin_layout Plain Layout
4834 statement to cause the symbol
4835 \begin_inset Flex Noun
4838 \begin_layout Plain Layout
4846 to be output for the keystroke
4847 \begin_inset Flex Noun
4850 \begin_layout Plain Layout
4861 \begin_layout LyX-Code
4867 \begin_layout Labeling
4868 \labelwidthstring 00.00.0000
4869 \begin_inset Flex Code
4872 \begin_layout Plain Layout
4880 Specify an accent character
4883 \begin_layout LyX-Code
4892 \begin_layout Standard
4893 This will make the cha
4931 This is the dead key
4935 \begin_layout Plain Layout
4942 refers to a key that does not produce a character by itself, but when followed
4943 with another key, produces the desired accent character.
4944 For example, a German characte
4946 r with an umlaut like
4956 can be produced in this manner.
4965 \begin_layout Standard
4978 and then another key not in
4995 followed by the other, not allowed key, as output.
4999 \begin_inset Flex Noun
5002 \begin_layout Plain Layout
5010 cancels a dead key, so if
5021 \begin_inset Flex Noun
5024 \begin_layout Plain Layout
5033 , the cursor will not go one position backwards but will instead cancel
5049 might have had on the next keystroke.
5053 \begin_layout Standard
5054 The following example specifies that the character ' is to be an acute accent,
5055 allowed on the characters a, e, i, o, u, A, E, I, O, and U:
5058 \begin_layout LyX-Code
5061 kmod ' acute aeiouAEIOU
5064 \begin_layout Labeling
5065 \labelwidthstring 00.00.0000
5066 \begin_inset Flex Code
5069 \begin_layout Plain Layout
5075 Specify an exception to the accent character
5078 \begin_layout LyX-Code
5087 \begin_layout Standard
5088 This defines an exce
5129 have been assigned a keystroke with a previous
5132 \begin_inset Flex Code
5135 \begin_layout Plain Layout
5159 must not belong in the
5206 If such a declaration does not exist in
5214 \begin_inset Flex Code
5217 \begin_layout Plain Layout
5251 \begin_inset Flex Code
5254 \begin_layout Plain Layout
5268 \begin_layout Standard
5269 The following command produces causes äi to be produced when you enter acute-i
5273 \begin_layout LyX-Code
5287 \begin_layout Labeling
5288 \labelwidthstring 00.00.0000
5289 \begin_inset Flex Code
5292 \begin_layout Plain Layout
5298 Combine two accent characters
5301 \begin_layout LyX-Code
5307 accent1 accent2 allowed
5310 \begin_layout Standard
5311 This one is getting pretty esoteric.
5312 It allows you to combine the effect
5368 \begin_inset Flex Code
5371 \begin_layout Plain Layout
5399 \begin_layout Standard
5400 Consider this example from the
5401 \begin_inset Flex Code
5404 \begin_layout Plain Layout
5415 \begin_layout LyX-Code
5418 kmod ; acute aeioyvhAEIOYVH
5422 kcomb acute umlaut iyIY
5425 \begin_layout Standard
5426 This allows you to press
5427 \begin_inset Flex Noun
5430 \begin_layout Plain Layout
5438 and get the effect of
5439 \begin_inset Flex Code
5442 \begin_layout Plain Layout
5461 in this case cancels the last dead key, so if you press
5462 \begin_inset Flex Noun
5465 \begin_layout Plain Layout
5474 \begin_inset Flex Code
5477 \begin_layout Plain Layout
5490 \begin_layout Subsection
5494 \begin_layout Standard
5496 \begin_inset Flex Code
5499 \begin_layout Plain Layout
5507 mapping is performed, a
5508 \begin_inset Flex Code
5511 \begin_layout Plain Layout
5521 file maps the strings that the symbols generate to characters in the current
5523 The \SpecialChar LyX
5524 distribution currently includes at least the
5525 \begin_inset Flex Code
5528 \begin_layout Plain Layout
5537 \begin_inset Flex Code
5540 \begin_layout Plain Layout
5551 \begin_layout Standard
5553 \begin_inset Flex Code
5556 \begin_layout Plain Layout
5564 file is a sequence of declarations of the form
5567 \begin_layout LyX-Code
5580 \begin_layout Standard
5581 For example, in order to map
5582 \begin_inset Flex Noun
5585 \begin_layout Plain Layout
5595 to the corresponding character in the iso-8859-1 set (233), the following
5599 \begin_layout LyX-Code
5607 \begin_layout Standard
5609 \begin_inset Flex Code
5612 \begin_layout Plain Layout
5621 \begin_inset Flex Code
5624 \begin_layout Plain Layout
5642 the same character can apply to more than one string.
5644 \begin_inset Flex Code
5647 \begin_layout Plain Layout
5658 \begin_layout LyX-Code
5670 \begin_inset Newline newline
5686 \begin_layout Standard
5688 cannot find a mapping for the string produced by the keystroke or a
5689 deadkey sequence, it will check if it looks like an accented char and try
5690 to draw an accent over the character on screen.
5693 \begin_layout Subsection
5697 \begin_layout Standard
5698 There is a second way to add support for international characters through
5699 so-called dead-keys.
5700 A dead-key works in combination with a letter to produce an accented character.
5701 Here, we'll explain how to create a really simple dead-key to illustrate
5705 \begin_layout Standard
5706 Suppose you happen to need the circumflex character,
5707 \begin_inset Quotes eld
5711 \begin_inset Quotes erd
5716 \begin_inset Flex Noun
5719 \begin_layout Plain Layout
5726 \begin_inset space ~
5730 \begin_inset Flex Noun
5733 \begin_layout Plain Layout
5739 ] to the \SpecialChar LyX
5741 \begin_inset Flex Code
5744 \begin_layout Plain Layout
5751 \begin_inset Flex Code
5754 \begin_layout Plain Layout
5761 Now, whenever you type the
5762 \begin_inset Flex Noun
5765 \begin_layout Plain Layout
5771 -key followed by a letter, that letter will have a circumflex accent on
5773 For example, the sequence
5774 \begin_inset Quotes eld
5778 \begin_inset Flex Noun
5781 \begin_layout Plain Layout
5788 \begin_inset Quotes erd
5791 produces the letter:
5792 \begin_inset Quotes eld
5796 \begin_inset Quotes erd
5800 If you tried to type
5801 \begin_inset Quotes eld
5805 \begin_inset Flex Noun
5808 \begin_layout Plain Layout
5815 \begin_inset Quotes erd
5818 , however, \SpecialChar LyX
5819 will complain with a beep, since a
5820 \begin_inset Quotes eld
5824 \begin_inset Flex Noun
5827 \begin_layout Plain Layout
5834 \begin_inset Quotes erd
5837 never takes a circumflex accent.
5839 \begin_inset Flex Noun
5842 \begin_layout Plain Layout
5848 after a dead-key produces the bare-accent.
5849 Please note this last point! If you bind a key to a dead-key, you'll need
5850 to rebind the character on that key to yet another key.
5852 \begin_inset Flex Noun
5855 \begin_layout Plain Layout
5861 to a cedilla is a bad idea, since you'll only get cedillas instead of commas.
5864 \begin_layout Standard
5865 One common way to bind dead-keys is to use
5866 \begin_inset Flex Noun
5869 \begin_layout Plain Layout
5876 \begin_inset Flex Noun
5879 \begin_layout Plain Layout
5886 \begin_inset Flex Noun
5889 \begin_layout Plain Layout
5895 in combination with an accent, like
5896 \begin_inset Quotes eld
5900 \begin_inset Flex Noun
5903 \begin_layout Plain Layout
5910 \begin_inset Quotes erd
5914 \begin_inset Quotes eld
5918 \begin_inset Flex Noun
5921 \begin_layout Plain Layout
5928 \begin_inset Quotes erd
5932 \begin_inset Quotes eld
5936 \begin_inset Flex Noun
5939 \begin_layout Plain Layout
5946 \begin_inset Quotes erd
5950 Another way involves using
5951 \begin_inset Flex Code
5954 \begin_layout Plain Layout
5961 \begin_inset Flex Code
5964 \begin_layout Plain Layout
5970 to set up the special
5971 \begin_inset Flex Code
5974 \begin_layout Plain Layout
5982 \begin_inset Flex Code
5985 \begin_layout Plain Layout
5991 acts in some ways just like
5992 \begin_inset Flex Noun
5995 \begin_layout Plain Layout
6001 and permits you to bind keys to accented characters.
6002 You can also turn keys into dead-keys by binding them to something like
6004 \begin_inset Flex Code
6007 \begin_layout Plain Layout
6013 and then binding this symbolic key to the corresponding \SpecialChar LyX
6018 \begin_layout Plain Layout
6023 : This is exactly what I do in my
6024 \begin_inset Flex Code
6027 \begin_layout Plain Layout
6034 \begin_inset Flex Code
6037 \begin_layout Plain Layout
6045 \begin_inset Flex Noun
6048 \begin_layout Plain Layout
6050 \begin_inset space ~
6059 \begin_inset Flex Code
6062 \begin_layout Plain Layout
6068 and a bunch of these
6069 \begin_inset Quotes eld
6073 \begin_inset Flex Code
6076 \begin_layout Plain Layout
6083 \begin_inset Quotes erd
6086 symbolic keys bound such things as
6087 \begin_inset Flex Noun
6090 \begin_layout Plain Layout
6092 \begin_inset space ~
6101 \begin_inset Flex Noun
6104 \begin_layout Plain Layout
6106 \begin_inset space ~
6115 This is how I produce my accented characters.
6120 You can make just about anything into the
6121 \begin_inset Flex Code
6124 \begin_layout Plain Layout
6131 \begin_inset Flex Noun
6134 \begin_layout Plain Layout
6140 keys, a spare function key, etc.
6141 As for the \SpecialChar LyX
6142 commands that produce accents, check the entry for
6143 \begin_inset Flex Code
6146 \begin_layout Plain Layout
6157 You'll find the complete list there.
6160 \begin_layout Subsection
6161 Saving your Language Configuration
6164 \begin_layout Standard
6165 You can edit your preferences so that your desired language environment
6166 is automatically configured when \SpecialChar LyX
6168 \begin_inset Flex Noun
6171 \begin_layout Plain Layout
6172 Edit\SpecialChar menuseparator
6181 \begin_layout Chapter
6183 \change_inserted -584632292 1610232084
6186 Installing New Document Classes, Layouts, and Templates
6187 \begin_inset CommandInset label
6189 name "cha:Installing-New-Document"
6194 \begin_inset Argument 1
6197 \begin_layout Plain Layout
6198 Installing New Document Classes
6206 \begin_layout Standard
6207 In this chapter, we describe the procedures for creating and installing
6208 new \SpecialChar LyX
6209 layout and template files, as well as offer a refresher on correctly
6210 installing new \SpecialChar LaTeX
6215 \begin_layout Standard
6216 First, let us a say a few words about how one ought to think about the relation
6217 between \SpecialChar LyX
6218 and \SpecialChar LaTeX
6220 The thing to understand is that, in a certain sense, \SpecialChar LyX
6221 doesn't know anything
6222 about \SpecialChar LaTeX
6224 Indeed, from \SpecialChar LyX
6225 's point of view, \SpecialChar LaTeX
6226 is just one of several
6227 \begin_inset Quotes eld
6231 \begin_inset Quotes erd
6234 in which it is capable of producing output.
6235 Other such formats are DocBook, plaintext, and XHTML.
6237 is, of course, a particularly important format, but very little of the
6238 information \SpecialChar LyX
6239 has about \SpecialChar LaTeX
6240 is actually contained in the program itself.
6244 \begin_layout Plain Layout
6245 Some commands are sufficiently complex that they are
6246 \begin_inset Quotes eld
6250 \begin_inset Quotes erd
6253 into \SpecialChar LyX
6255 But the developers generally regard this as a Bad Thing.
6260 Rather, that information, even for the standard classes like
6261 \begin_inset Flex Code
6264 \begin_layout Plain Layout
6270 , is contained in `layout files'.
6271 Similarly, \SpecialChar LyX
6272 itself does not know much about DocBook or XHTML.
6273 What it knows is contained in layout files.
6276 \begin_layout Standard
6277 You can think of the layout file for a given document class as a translation
6278 manual between \SpecialChar LyX
6279 constructs—paragraphs with their corresponding styles,
6280 certain sorts of insets, etc—and the corresponding \SpecialChar LaTeX
6283 Almost everything \SpecialChar LyX
6285 \begin_inset Flex Code
6288 \begin_layout Plain Layout
6294 , for example, is contained in the file
6295 \begin_inset Flex Code
6298 \begin_layout Plain Layout
6304 and in various other files it includes.
6305 For this reason, anyone intending to write layout files should plan to
6306 study the existing files.
6307 A good place to start is with
6308 \begin_inset Flex Code
6311 \begin_layout Plain Layout
6317 , which is included in
6318 \begin_inset Flex Code
6321 \begin_layout Plain Layout
6328 \begin_inset Flex Code
6331 \begin_layout Plain Layout
6337 , and many of the other layout files for document classes.
6338 This file is where sections and the like are defined:
6339 \begin_inset Flex Code
6342 \begin_layout Plain Layout
6348 tells \SpecialChar LyX
6349 how paragraphs that are marked with the Section, Subsection, etc,
6350 styles can be translated into corresponding \SpecialChar LaTeX
6351 , DocBook, and XHTML commands
6354 \begin_inset Flex Code
6357 \begin_layout Plain Layout
6363 file basically just includes several of these
6364 \begin_inset Flex Code
6367 \begin_layout Plain Layout
6376 \begin_layout Standard
6377 Defining the \SpecialChar LyX
6379 correspondence is not the only thing layout files do, though.
6380 Their other job is to define how the \SpecialChar LyX
6381 constructs themselves will appear
6383 The fact that layout files have these two jobs is often a source of confusion,
6384 because they are completely separate.
6385 Telling \SpecialChar LyX
6386 how to translate a certain paragraph style into \SpecialChar LaTeX
6389 how to display it; conversely, telling \SpecialChar LyX
6390 how to display a certain paragraph
6391 style does not tell \SpecialChar LyX
6392 how to translate it into \SpecialChar LaTeX
6393 (let alone tell \SpecialChar LaTeX
6396 So, in general, when you define a new \SpecialChar LyX
6397 construct, you must always do two
6398 quite separate things: (i)
6399 \begin_inset space ~
6402 tell \SpecialChar LyX
6403 how to translate it into \SpecialChar LaTeX
6405 \begin_inset space ~
6408 tell \SpecialChar LyX
6412 \begin_layout Standard
6413 Much the same is true, of course, as regards \SpecialChar LyX
6414 's other backend formats, though
6415 XHTML is in some ways different, because in that case \SpecialChar LyX
6420 able, to some extent, to use information about how it should display a
6421 paragraph on the screen to output information (in the form of CSS) about
6422 how the paragraph should be displayed in a browser.
6423 Even in this case, however, the distinction between what \SpecialChar LyX
6425 and how things are rendered externally remains in force, and the two can
6426 be controlled separately.
6428 \begin_inset CommandInset ref
6430 reference "sec:Tags-for-XHTML"
6437 \begin_layout Section
6438 Installing new \SpecialChar LaTeX
6442 \begin_layout Standard
6443 Some installations may not include a \SpecialChar LaTeX
6444 package or class file that you would
6445 like to use within \SpecialChar LyX
6447 For example, you might need Foil\SpecialChar TeX
6448 , a package for preparing slides for overhead
6450 Modern \SpecialChar LaTeX
6451 distributions like \SpecialChar TeX
6452 Live (2008 or newer) or MiK\SpecialChar TeX
6453 provide a user interface
6454 for installing such packages.
6455 For example, with MiK\SpecialChar TeX
6456 , you start the program
6457 \begin_inset Quotes eld
6461 \begin_inset space ~
6465 \begin_inset Quotes erd
6468 to get a list of available packages.
6469 To install one of them, right click on it or use the corresponding toolbar
6473 \begin_layout Standard
6474 If your \SpecialChar LaTeX
6475 distribution does not provide such a `package manager', or if the
6476 package is not available from your distribution, then follow these steps
6477 to install it manually:
6480 \begin_layout Enumerate
6481 Get the package from
6482 \begin_inset CommandInset href
6485 target "http://www.ctan.org/"
6493 \begin_layout Enumerate
6494 If the package contains a file with the ending
6495 \begin_inset Quotes eld
6499 \begin_inset Flex Code
6502 \begin_layout Plain Layout
6509 \begin_inset Quotes erd
6512 (is the case for Foil\SpecialChar TeX
6513 ) then open a console, change to the folder of this
6514 file and execute the command
6515 \begin_inset Flex Code
6518 \begin_layout Plain Layout
6525 You have now unpacked the package and have all files to install it.
6526 Most \SpecialChar LaTeX
6527 -packages are not packed and you can skip this step.
6530 \begin_layout Enumerate
6531 Now you need to decide if the package should be available for all users
6536 \begin_layout Enumerate
6537 On *nix systems (Linux, OSX, etc.), if you want the new package to be available
6538 for all users on your system, then install it in your `local' \SpecialChar TeX
6540 install it in your own `user' \SpecialChar TeX
6542 Where these trees should be created, if they do not already exist, depends
6544 To find this out, look in the file
6545 \begin_inset Flex Code
6548 \begin_layout Plain Layout
6558 \begin_layout Plain Layout
6559 This is usually in the directory
6560 \begin_inset Flex Code
6563 \begin_layout Plain Layout
6569 , though you can execute the command
6570 \begin_inset Flex Code
6573 \begin_layout Plain Layout
6584 The location of the `local' \SpecialChar TeX
6585 tree is defined by the
6586 \begin_inset Flex Code
6589 \begin_layout Plain Layout
6595 variable; this is usually somewhere like
6596 \begin_inset Flex Code
6599 \begin_layout Plain Layout
6600 /usr/local/share/texmf
6605 or /usr/local/texlive/XXXX where XXXX is the year of the installed \SpecialChar TeX
6608 The location of the `user' \SpecialChar TeX
6610 \begin_inset Flex Code
6613 \begin_layout Plain Layout
6620 \begin_inset Flex Code
6623 \begin_layout Plain Layout
6630 \begin_inset Flex Code
6633 \begin_layout Plain Layout
6642 (If these variables are not predefined, you have to define them.) You'll
6643 probably need root permissions to create or modify the `local' tree, but
6644 not for your `user' tree.
6645 \begin_inset Newline newline
6648 In general, it is recommended to install in the user tree because your user
6649 will not be modified or even overwritten when you upgrade your system.
6650 It will typically also be backed up together with everything else when
6651 you backup your home directory (which, of course, you do on a regular basis).
6654 \begin_layout Enumerate
6655 On Windows, if you want the new package to be available for all users on
6656 your system, change to the folder where \SpecialChar LaTeX
6657 is installed and then change to
6659 \begin_inset Flex Code
6662 \begin_layout Plain Layout
6673 (For MiK\SpecialChar TeX
6674 , this would be by default the folder
6675 \begin_inset Flex Code
6678 \begin_layout Plain Layout
6696 \begin_layout Plain Layout
6697 Note that this will be the correct path only on English installations.
6698 On a German one, it would be
6699 \begin_inset Flex Code
6702 \begin_layout Plain Layout
6716 , and similarly for other languages.
6721 Create there a new folder
6722 \begin_inset Flex Code
6725 \begin_layout Plain Layout
6731 and copy all files of the package into it.
6733 \begin_inset Newline newline
6736 If the package should only available for you or you don't have admin permissions
6737 , do the same, but in the local \SpecialChar LaTeX
6740 \begin_inset space \thinspace{}
6743 g., for MiK\SpecialChar TeX
6745 \begin_inset space ~
6748 2.8 under Windows XP, this would be the folder:
6749 \begin_inset Newline newline
6755 \begin_inset Flex Code
6758 \begin_layout Plain Layout
6761 Documents and Settings
6773 \begin_inset Newline newline
6779 \begin_inset Phantom HPhantom
6782 \begin_layout Plain Layout
6793 \begin_inset Flex Code
6796 \begin_layout Plain Layout
6809 \begin_inset Newline newline
6812 On Vista, it would be:
6813 \begin_inset Newline newline
6817 \begin_inset Flex Code
6820 \begin_layout Plain Layout
6846 \begin_layout Enumerate
6847 Now one only need to tell \SpecialChar LaTeX
6848 that there are new files.
6849 This depends on the used \SpecialChar LaTeX
6854 \begin_layout Enumerate
6855 For \SpecialChar TeX
6856 Live execute the command
6857 \begin_inset Flex Code
6860 \begin_layout Plain Layout
6867 If you installed the package for all users, then you will probably need
6868 to have root permissions for that.
6871 \begin_layout Enumerate
6872 For MiK\SpecialChar TeX
6873 , if you have installed the package for all users, start the program
6875 \begin_inset Quotes eld
6879 \begin_inset space ~
6883 \begin_inset Quotes erd
6886 and press the button marked
6887 \begin_inset Quotes eld
6891 \begin_inset Quotes erd
6895 Otherwise start the program
6896 \begin_inset Quotes eld
6900 \begin_inset Quotes erd
6907 \begin_layout Enumerate
6908 Finally, you need to tell \SpecialChar LyX
6909 that there are new packages available.
6910 So, in \SpecialChar LyX
6912 \begin_inset Flex Noun
6915 \begin_layout Plain Layout
6918 \SpecialChar menuseparator
6924 and then restart \SpecialChar LyX
6928 \begin_layout Standard
6929 Now the package is installed.
6930 In our example, the document class
6931 \begin_inset Flex Code
6934 \begin_layout Plain Layout
6940 will now be available under
6941 \begin_inset Flex Noun
6944 \begin_layout Plain Layout
6945 Document\SpecialChar menuseparator
6946 Settings\SpecialChar menuseparator
6953 \begin_inset Quotes eld
6957 \begin_inset Quotes erd
6964 \begin_layout Standard
6965 If you would like to use a \SpecialChar LaTeX
6966 document class that is not even listed in the
6968 \begin_inset Flex Noun
6971 \begin_layout Plain Layout
6972 Document\SpecialChar menuseparator
6973 Settings\SpecialChar menuseparator
6979 , then you need to create a `layout' file for it.
6980 That is the topic of the next section.
6983 \begin_layout Section
6984 Types of layout files
6987 \begin_layout Standard
6988 This section describes the various sorts of \SpecialChar LyX
6989 files that contain layout informati
6991 These files describe various paragraph and character styles, determining
6992 how \SpecialChar LyX
6993 should display them and how they should be translated into \SpecialChar LaTeX
6995 XHTML, or whatever output format is being used.
6999 \begin_layout Standard
7000 We shall try to provide a thorough description of the process of writing
7002 However, there are so many different types of documents supported even
7003 by just \SpecialChar LaTeX
7004 that we can't hope to cover every different possibility or problem
7005 you might encounter.
7006 The \SpecialChar LyX
7007 users' list is frequented by people with lots of experience with layout
7008 design who are willing to share what they've learned, so please feel free
7009 to ask questions there.
7012 \begin_layout Standard
7013 As you prepare to write a new layout, it is extremely helpful to look at
7014 the layouts distributed with \SpecialChar LyX
7016 If you write a \SpecialChar LyX
7017 layout for a \SpecialChar LaTeX
7018 document class that might also be used by
7019 others, or write a module that might be useful to others, then you should
7020 consider posting your layout to the
7021 \begin_inset CommandInset href
7023 name "layout section on the LyX wiki"
7024 target "https://wiki.lyx.org/Layouts/Layouts"
7029 or even to the \SpecialChar LyX
7030 developers' list, so that it might be included in \SpecialChar LyX
7035 \begin_layout Plain Layout
7036 Note that \SpecialChar LyX
7037 is licensed under the General Public License, so any material
7038 that is contributed to \SpecialChar LyX
7039 must be similarly licensed.
7047 \begin_layout Subsection
7049 \begin_inset CommandInset label
7051 name "subsec:Layout-modules"
7058 \begin_layout Standard
7059 We have spoken to this point about `layout files'.
7060 But there are different sorts of files that contain layout information.
7061 Layout files, strictly so called, have the
7062 \begin_inset Flex Code
7065 \begin_layout Plain Layout
7071 extension and provide \SpecialChar LyX
7072 with information about document classes.
7073 Since \SpecialChar LyX
7074 1.6 layout information can also be contained in layout
7079 \begin_inset Flex Code
7082 \begin_layout Plain Layout
7089 Modules are to \SpecialChar LaTeX
7090 packages much as layouts are to \SpecialChar LaTeX
7091 classes, and some modules—such
7093 \begin_inset Flex Code
7096 \begin_layout Plain Layout
7102 module—specifically provide support for one package.
7103 In a sense, layout modules are similar to included
7107 \begin_layout Plain Layout
7108 These can have any extension, but by convention have the
7109 \begin_inset Flex Code
7112 \begin_layout Plain Layout
7124 \begin_inset Flex Code
7127 \begin_layout Plain Layout
7133 —in that modules are not specific to a given document class but may be used
7134 with many different classes.
7135 The difference is that using an included file with
7136 \begin_inset Flex Code
7139 \begin_layout Plain Layout
7145 requires editing that file.
7146 Modules, by contrast, are selected in the
7147 \begin_inset Flex Noun
7150 \begin_layout Plain Layout
7151 Document\SpecialChar menuseparator
7160 \begin_layout Standard
7161 Building modules is the easiest way to get started with layout editing,
7162 since it can be as simple as adding a single new paragraph style or flex
7164 But modules may, in principle, contain anything a layout file can contain.
7167 \begin_layout Standard
7168 After creating a new module and copying it to the
7169 \begin_inset Flex Code
7172 \begin_layout Plain Layout
7178 folder, you will need to reconfigure and then restart \SpecialChar LyX
7181 However, changes you make to the module will be seen immediately, if you
7183 \begin_inset Flex Noun
7186 \begin_layout Plain Layout
7187 Document\SpecialChar menuseparator
7193 , highlight something, and then hit
7194 \begin_inset Quotes eld
7198 \begin_inset Quotes erd
7204 It is strongly recommended that you save your work before doing this
7209 it is strongly recommended that you not attempt to edit modules while simultaneo
7210 usly working on actual documents
7213 Though of course the developers strive to keep \SpecialChar LyX
7214 stable in such situations,
7215 syntax errors and the like in your module file could cause strange behavior.
7218 \begin_layout Subsubsection
7222 \begin_layout Standard
7223 Modules are to \SpecialChar LyX
7224 as packages are to \SpecialChar LaTeX
7226 Sometimes, however, you find yourself wanting a specific inset or character
7227 style just for one document and writing a module that will also be available
7228 to other documents makes little sense.
7229 What you need is \SpecialChar LyX
7231 \begin_inset Quotes eld
7235 \begin_inset Quotes erd
7241 \begin_layout Standard
7242 You will find it under
7244 Document\SpecialChar menuseparator
7245 Settings\SpecialChar menuseparator
7249 The large text box allows you to enter anything that you might enter in
7250 a layout file or module.
7251 You can think of a document's local layout, in fact, as a module that belongs
7253 So, in particular, you must enter a
7254 \begin_inset Flex Code
7257 \begin_layout Plain Layout
7264 Any format is acceptable, but one would normally use the format current
7266 (In \SpecialChar LyX
7273 , the current layout format is
7282 \begin_layout Standard
7283 When you have entered something in the
7284 \begin_inset Flex Code
7287 \begin_layout Plain Layout
7293 pane, \SpecialChar LyX
7295 \begin_inset Quotes eld
7299 \begin_inset Quotes erd
7302 button at the bottom.
7303 Clicking this button will cause \SpecialChar LyX
7304 to determine whether what you have entered
7305 is valid layout information for the chosen format.
7307 will report the result but, unfortunately, will not tell you what errors
7308 there might have been.
7309 These will be written to the terminal, however, if \SpecialChar LyX
7310 is started from a terminal.
7311 You will not be permitted to save your local layout until you have entered
7315 \begin_layout Standard
7316 The warnings at the end of the previous section apply here, too.
7317 Do not play with local layout while you are actually working, especially
7318 if you have not saved your document.
7319 That said, using local layout with a test document can be a very convenient
7320 way to try out layout ideas, or even to start developing a module.
7323 \begin_layout Subsection
7325 \begin_inset Flex Noun
7328 \begin_layout Plain Layout
7337 \begin_layout Standard
7338 There are two situations you are likely to encounter when wanting to support
7339 a new \SpecialChar LaTeX
7340 document class, involving style (
7341 \begin_inset Flex Code
7344 \begin_layout Plain Layout
7350 ) files and \SpecialChar LaTeX2e
7352 \begin_inset Flex Code
7355 \begin_layout Plain Layout
7362 Supporting a style file is usually fairly easy.
7363 Supporting a new class file is a bit harder.
7364 We'll discuss the former in this section and the latter in the next.
7366 \change_deleted 5863208 1594239023
7367 Similar remarks apply, of course, if you want to support a new DocBook DTD.
7372 \begin_layout Standard
7373 The easier case is the one in which your new document class is provided
7374 as a style file that is to be used in conjunction with an already supported
7376 For the sake of the example, we'll assume that the style file is called
7378 \begin_inset Flex Noun
7381 \begin_layout Plain Layout
7387 and that it is meant to be used with
7388 \begin_inset Flex Noun
7391 \begin_layout Plain Layout
7397 , which is a standard class.
7401 \begin_layout Standard
7402 Start by copying the existing class's layout file into your local directory:
7406 \begin_layout Plain Layout
7407 Of course, which directory is your local directory will vary by platform,
7408 and \SpecialChar LyX
7409 allows you to specify your local directory on startup, too, using
7411 \begin_inset Flex Code
7414 \begin_layout Plain Layout
7428 \begin_layout LyX-Code
7429 cp report.layout ~/.lyx/layouts/myclass.layout
7432 \begin_layout Standard
7434 \begin_inset Flex Code
7437 \begin_layout Plain Layout
7443 and change the line:
7446 \begin_layout LyX-Code
7449 DeclareLaTeXClass{Report (Standard Class)}
7452 \begin_layout Standard
7456 \begin_layout LyX-Code
7459 DeclareLaTeXClass[report, myclass.sty]{Report (My Class)}
7462 \begin_layout Standard
7466 \begin_layout LyX-Code
7468 \begin_inset Newline newline
7474 \begin_inset Newline newline
7480 \begin_layout Standard
7481 near the top of the file.
7484 \begin_layout Standard
7485 Start \SpecialChar LyX
7487 \begin_inset Flex Noun
7490 \begin_layout Plain Layout
7491 Tools\SpecialChar menuseparator
7498 Then restart \SpecialChar LyX
7499 and try creating a new document.
7501 \begin_inset Flex Noun
7504 \begin_layout Plain Layout
7510 " as a document class option in the
7511 \begin_inset Flex Noun
7514 \begin_layout Plain Layout
7515 Document\SpecialChar menuseparator
7522 It is likely that some of the sectioning commands and such in your new
7523 class will work differently from how they worked in the base class—
7524 \begin_inset Flex Code
7527 \begin_layout Plain Layout
7533 in this example—so you can fiddle around with the settings for the different
7534 sections if you wish.
7535 The layout information for sections is contained in
7536 \begin_inset Flex Code
7539 \begin_layout Plain Layout
7545 , but you do not need to copy and change this file.
7546 Instead, you can simply add your changes to your layout file, after the
7548 \begin_inset Flex Code
7551 \begin_layout Plain Layout
7557 , which itself includes
7558 \begin_inset Flex Code
7561 \begin_layout Plain Layout
7568 For example, you might add these lines:
7571 \begin_layout LyX-Code
7575 \begin_layout LyX-Code
7579 \begin_layout LyX-Code
7583 \begin_layout LyX-Code
7587 \begin_layout LyX-Code
7591 \begin_layout Standard
7592 to change the font for chapter headings to sans-serif.
7593 This will override (or, in this case, add to) the existing declaration
7594 for the Chapter style.
7598 \begin_layout Standard
7599 Your new package may also provide commands or environments not present in
7601 In this case, you will want to add these to the layout file.
7603 \begin_inset CommandInset ref
7605 reference "sec:TextClass"
7609 for information on how to do so.
7612 \begin_layout Standard
7614 \begin_inset Flex Noun
7617 \begin_layout Plain Layout
7623 can be used with several different document classes, and even if it cannot,
7624 you might find it easiest just to write a module that you can load with
7626 The simplest possible such module would be:
7629 \begin_layout LyX-Code
7632 DeclareLyXModule{My Class}
7635 \begin_layout LyX-Code
7639 \begin_layout LyX-Code
7640 #Support for myclass.sty.
7643 \begin_layout LyX-Code
7645 \begin_inset Newline newline
7651 \begin_layout LyX-Code
7659 \begin_inset Newline newline
7665 \begin_layout LyX-Code
7667 \begin_inset Newline newline
7673 \begin_inset Newline newline
7679 \begin_layout Standard
7680 A more complex module might modify the behavior of some existing constructs
7681 or define some new ones.
7683 \begin_inset CommandInset ref
7685 reference "sec:TextClass"
7692 \begin_layout Subsection
7694 \begin_inset Flex Noun
7697 \begin_layout Plain Layout
7706 \begin_layout Standard
7707 There are two possibilities here.
7708 One is that the class file is itself based upon an existing document class.
7709 For example, many thesis classes are based upon
7710 \begin_inset Flex Noun
7713 \begin_layout Plain Layout
7720 To see whether yours is, look for a line like
7723 \begin_layout LyX-Code
7729 \begin_layout Standard
7731 If so, then you may proceed largely as in the previous section, though
7733 \begin_inset Flex Code
7736 \begin_layout Plain Layout
7737 Declare\SpecialChar LaTeX
7743 line will be different.
7744 If your new class is
7745 \begin_inset Flex Code
7748 \begin_layout Plain Layout
7754 and it is based upon
7755 \begin_inset Flex Code
7758 \begin_layout Plain Layout
7764 , then the line should read:
7768 \begin_layout Plain Layout
7769 And it will be easiest if you save the file to
7770 \begin_inset Flex Code
7773 \begin_layout Plain Layout
7780 assumes that the document class has the same name as the layout file.
7789 \begin_layout LyX-Code
7792 DeclareLaTeXClass[thesis,book]{thesis}
7795 \begin_layout Standard
7796 If, on the other hand, the new class is not based upon an existing class,
7797 you will probably have to
7798 \begin_inset Quotes eld
7802 \begin_inset Quotes erd
7806 We strongly suggest copying an existing layout file which uses a similar
7808 class and then modifying it, if you can do so.
7809 At least use an existing file as a starting point so you can find out what
7810 items you need to worry about.
7811 Again, the specifics are covered below.
7814 \begin_layout Subsection
7816 \begin_inset CommandInset label
7818 name "subsec:Creating-Templates"
7825 \begin_layout Standard
7826 Once you have written a layout file for a new document class, you might
7827 want to consider writing a
7832 A template acts as a kind of tutorial for your layout, showing how it might
7833 be used, though containing dummy content.
7834 You can of course look at the various templates included with \SpecialChar LyX
7838 \begin_layout Standard
7839 Templates are created just like usual documents: using \SpecialChar LyX
7841 The only difference is that usual documents contain all possible settings,
7842 including the font scheme and the paper size.
7843 Usually a user doesn't want a template to overwrite his preferred settings
7844 for such parameters.
7845 For that reason, the designer of a template should remove the corresponding
7847 \begin_inset Flex Code
7850 \begin_layout Plain Layout
7859 \begin_inset Flex Code
7862 \begin_layout Plain Layout
7870 from the template \SpecialChar LyX
7872 This can be done with any simple text-editor, for example
7873 \begin_inset Flex Code
7876 \begin_layout Plain Layout
7883 \begin_inset Flex Code
7886 \begin_layout Plain Layout
7895 \begin_layout Standard
7896 Put the edited template files you create in
7897 \begin_inset Flex Code
7900 \begin_layout Plain Layout
7906 , copy the ones you use from the global template directory in
7907 \begin_inset Flex Code
7910 \begin_layout Plain Layout
7916 to the same place, and redefine the template path in the
7917 \begin_inset Flex Noun
7920 \begin_layout Plain Layout
7921 Tools\SpecialChar menuseparator
7922 Preferences\SpecialChar menuseparator
7931 \begin_layout Standard
7932 Note, by the way, that there is a template which has a particular meaning:
7933 \begin_inset Newline linebreak
7937 \begin_inset Flex Code
7940 \begin_layout Plain Layout
7947 This template is loaded every time you create a new document with
7948 \begin_inset Flex Noun
7951 \begin_layout Plain Layout
7952 File\SpecialChar menuseparator
7958 in order to provide useful defaults.
7959 To create this template from inside \SpecialChar LyX
7960 , all you have to do is to open a document
7961 with the correct settings, and use the
7962 \begin_inset Flex Noun
7965 \begin_layout Plain Layout
7966 Save as Document Defaults
7974 \begin_layout Subsection
7975 Upgrading old layout files
7978 \begin_layout Standard
7979 The format of layout files changes with each \SpecialChar LyX
7980 release, so old layout files
7981 need to be converted to the new format.
7983 reads a layout file in an older format, it automatically calls the
7985 \begin_inset Flex Code
7988 \begin_layout Plain Layout
7994 to convert it to a temporary file in current format.
7995 The original file is left untouched.
7996 If you use the layout file often, then, you may want to convert it permanently,
7997 so that \SpecialChar LyX
7998 does not have to do so itself every time.
7999 To do this, you can call the converter manually:
8002 \begin_layout Enumerate
8004 \begin_inset Flex Code
8007 \begin_layout Plain Layout
8014 \begin_inset Flex Code
8017 \begin_layout Plain Layout
8026 \begin_layout Enumerate
8028 \begin_inset Newline newline
8032 \begin_inset Flex Code
8035 \begin_layout Plain Layout
8036 python LyXDir/scripts/layout2layout.py myclass.old myclass.layout
8042 \begin_inset Newline newline
8046 \begin_inset Flex Code
8049 \begin_layout Plain Layout
8055 is the name of your \SpecialChar LyX
8059 \begin_layout Standard
8060 Note that manual conversion does not affect included files, so these will
8061 have to be converted separately.
8064 \begin_layout Subsection
8065 \begin_inset CommandInset label
8067 name "subsec:Cite-Engine-Files"
8074 \begin_layout Standard
8075 A specific form of layout files are the so-called
8076 \begin_inset Flex Code
8079 \begin_layout Plain Layout
8085 files that are located in the
8086 \begin_inset Flex Code
8089 \begin_layout Plain Layout
8096 Their purpose is to define the specifics of \SpecialChar LaTeX
8097 packages aimed at bibliography
8110 , but also the way how normal Bib\SpecialChar TeX
8111 citations (without additional packages)
8112 are handled in \SpecialChar LyX
8113 is defined in such a file.
8117 \begin_layout Standard
8118 More specifically, it is defined which packages \SpecialChar LyX
8119 needs to load, which citation
8120 commands are available, how these are to be displayed in \SpecialChar LyX
8122 the dialogs, the context menus) as well as in the XHTML and plain text
8124 Furthermore, the files specify available style variants (author-year, numerical
8125 , etc.) and their specifics.
8126 The cite engine files are also used to generate the options that are available
8129 Document\SpecialChar menuseparator
8130 Settings\SpecialChar menuseparator
8131 Bibliography\SpecialChar menuseparator
8137 \begin_layout Standard
8138 Even though a cite engine file is essentially a normal layout file that
8139 could theoretically include any layout information, it usually primarily
8140 includes some specific parameters such as
8141 \begin_inset Flex Code
8144 \begin_layout Plain Layout
8151 \begin_inset Flex Code
8154 \begin_layout Plain Layout
8161 \begin_inset Flex Code
8164 \begin_layout Plain Layout
8171 \begin_inset Flex Code
8174 \begin_layout Plain Layout
8181 The syntax of the latter two is described in
8182 \begin_inset CommandInset ref
8184 reference "subsec:Citation-engine-description"
8192 \begin_inset CommandInset ref
8194 reference "subsec:Citation-format-description"
8198 , as well as in the files themselves.
8201 \begin_layout Section
8202 \begin_inset CommandInset label
8204 name "sec:TextClass"
8208 The layout file format
8211 \begin_layout Standard
8212 The following sections describe how layout files are structured and written.
8213 Our advice is to go slowly, save and test often.
8214 It is really not that hard, except that the multitude of options can become
8215 overwhelming, especially if you try to check out too many at once.
8216 It becomes easier if you use existing layouts of \SpecialChar LyX
8217 as examples/reference
8218 or if you modify an existing layout to your needs.
8221 \begin_layout Standard
8222 Note that all the tags used in layout files are case-insensitive.
8224 \begin_inset Flex Code
8227 \begin_layout Plain Layout
8234 \begin_inset Flex Code
8237 \begin_layout Plain Layout
8244 \begin_inset Flex Code
8247 \begin_layout Plain Layout
8253 are really the same tag.
8254 The possible arguments are printed in brackets after the tag's name.
8255 The default argument is typeset
8256 \begin_inset Flex Code
8259 \begin_layout Plain Layout
8268 If the argument has a data type like
8269 \begin_inset Quotes eld
8273 \begin_inset Quotes erd
8277 \begin_inset Quotes eld
8281 \begin_inset Quotes erd
8284 , the default is shown like this:
8285 \begin_inset Flex Code
8288 \begin_layout Plain Layout
8299 \begin_layout Subsection
8300 The document class declaration and classification
8303 \begin_layout Standard
8304 Lines in a layout file which begin with
8305 \begin_inset Flex Code
8308 \begin_layout Plain Layout
8315 There is one exception to this rule.
8317 \begin_inset Flex Code
8320 \begin_layout Plain Layout
8326 files should begin with lines like:
8329 \begin_layout LyX-Code
8332 #% Do not delete the line below; configure depends on this
8335 \begin_layout LyX-Code
8340 DeclareLaTeXClass{Article (Standard Class)}
8343 \begin_layout LyX-Code
8348 DeclareCategory{Articles}
8351 \begin_layout Standard
8352 The second and third lines are used when you (re)configure \SpecialChar LyX
8354 The layout file is read by the \SpecialChar LaTeX
8356 \begin_inset Flex Code
8359 \begin_layout Plain Layout
8365 , in a special mode where
8366 \begin_inset Flex Code
8369 \begin_layout Plain Layout
8376 The first line is just a \SpecialChar LaTeX
8377 comment, the second one contains the mandatory
8378 declaration of the text class and the third line contains the optional
8379 classification of the class.
8380 If these lines appear in a file named
8381 \begin_inset Flex Code
8384 \begin_layout Plain Layout
8390 , then they define a text class of name
8391 \begin_inset Flex Code
8394 \begin_layout Plain Layout
8400 (the name of the layout file) which uses the \SpecialChar LaTeX
8402 \begin_inset Flex Code
8405 \begin_layout Plain Layout
8411 (the default is to use the same name as the layout).
8413 \begin_inset Quotes eld
8416 Article (Standard Class)
8417 \begin_inset Quotes erd
8420 that appears above is used as a description of the text class in the
8421 \begin_inset Flex Noun
8424 \begin_layout Plain Layout
8425 Document\SpecialChar menuseparator
8433 \begin_inset Quotes eld
8437 \begin_inset Quotes erd
8440 in the example) is also used in the
8441 \begin_inset Flex Noun
8444 \begin_layout Plain Layout
8445 Document\SpecialChar menuseparator
8451 dialog: the text classes are grouped by these categories (which are usually
8452 genres, so typical categories are
8453 \begin_inset Quotes eld
8457 \begin_inset Quotes erd
8461 \begin_inset Quotes eld
8465 \begin_inset Quotes erd
8469 \begin_inset Quotes eld
8473 \begin_inset Quotes erd
8477 \begin_inset Quotes eld
8481 \begin_inset Quotes erd
8485 \begin_inset Quotes eld
8489 \begin_inset Quotes erd
8493 \begin_inset Quotes eld
8497 \begin_inset Quotes erd
8501 If no category has been declared, the class will be put in the
8502 \begin_inset Quotes eld
8506 \begin_inset Quotes erd
8512 \begin_layout Standard
8513 Let's assume that you wrote your own text class that uses the
8514 \begin_inset Flex Code
8517 \begin_layout Plain Layout
8523 document class, but where you changed the appearance of the section headings.
8524 If you put it in a file
8525 \begin_inset Flex Code
8528 \begin_layout Plain Layout
8534 , the header of this file should be:
8537 \begin_layout LyX-Code
8540 #% Do not delete the line below; configure depends on this
8543 \begin_layout LyX-Code
8548 DeclareLaTeXClass[article]{Article (with My Own Headings)}
8551 \begin_layout LyX-Code
8556 DeclareCategory{Articles}
8559 \begin_layout Standard
8560 This declares a text class
8561 \begin_inset Flex Code
8564 \begin_layout Plain Layout
8570 , associated with the \SpecialChar LaTeX
8572 \begin_inset Flex Code
8575 \begin_layout Plain Layout
8582 \begin_inset Quotes eld
8585 Article (with My Own Headings)
8586 \begin_inset Quotes erd
8590 If your text class depends on several packages, you can declare it as:
8593 \begin_layout LyX-Code
8596 #% Do not delete the line below; configure depends on this
8599 \begin_layout LyX-Code
8604 DeclareLaTeXClass[article,foo.sty]{Article (with My Own Headings)}
8607 \begin_layout LyX-Code
8612 DeclareCategory{Articles}
8615 \begin_layout Standard
8616 This indicates that your text class uses the
8617 \begin_inset Flex Code
8620 \begin_layout Plain Layout
8628 \change_deleted 5863208 1594239179
8629 Finally, it is also possible to declare classes for DocBook code.
8630 Typical declarations will look like:
8633 \begin_layout LyX-Code
8635 \change_deleted 5863208 1594239179
8638 #% Do not delete the line below; configure depends on this
8641 \begin_layout LyX-Code
8643 \change_deleted 5863208 1594239179
8648 DeclareDocBookClass[article]{SGML (DocBook Article)}
8651 \begin_layout LyX-Code
8653 \change_deleted 5863208 1594239179
8658 DeclareCategory{Articles (DocBook)}
8663 \begin_layout Standard
8664 Note that these declarations can also be given an optional parameter declaring
8665 the name of the document class (but not a list).
8668 \begin_layout Standard
8669 So, to be as explicit as possible, the form of the layout declaration is:
8672 \begin_layout LyX-Code
8677 DeclareLaTeXClass[class,package.sty]{layout description}
8680 \begin_layout LyX-Code
8685 DeclareCategory{category}
8688 \begin_layout Standard
8689 The class need only be specified if the name of the \SpecialChar LaTeX
8691 name of the layout file are different or if there are packages to load.
8692 If the name of the class file is not specified, then \SpecialChar LyX
8694 that it is the same as the name of the layout file.
8697 \begin_layout Standard
8698 When the text class has been modified to your taste, all you have to do
8699 is to copy it either to
8700 \begin_inset Flex Code
8703 \begin_layout Plain Layout
8710 \begin_inset Flex Code
8713 \begin_layout Plain Layout
8720 \begin_inset Flex Noun
8723 \begin_layout Plain Layout
8724 Tools\SpecialChar menuseparator
8730 , exit \SpecialChar LyX
8732 Then your new text class should be available along with the others.
8735 \begin_layout Standard
8736 Once the layout file is installed, you can edit it and see your changes
8737 without having to reconfigure or to restart \SpecialChar LyX
8742 \begin_layout Plain Layout
8743 In versions of \SpecialChar LyX
8744 prior to 1.6, this was not true.
8745 As a result, editing layout files was very time consuming, since you had
8746 constantly to restart \SpecialChar LyX
8752 You can force a reload of the current layout by using the \SpecialChar LyX
8754 \begin_inset Flex Noun
8757 \begin_layout Plain Layout
8764 There is no default binding for this function—though, of course, you can
8765 bind it to a key yourself.
8766 But you will normally use this function simply by entering it in the mini-buffe
8771 \begin_layout Standard
8777 \begin_inset Flex Noun
8780 \begin_layout Plain Layout
8786 is very much an `advanced feature'.
8791 recommended that you save your work before using this function.
8796 recommended that you not attempt to edit layout information while simultaneousl
8797 y working on a document that you care about.
8798 Use a test document.
8799 Syntax errors and the like in your layout file could cause peculiar behavior.
8800 In particular, such errors could cause \SpecialChar LyX
8801 to regard the current layout as
8802 invalid and to attempt to switch to some other layout.
8806 \begin_layout Plain Layout
8807 Really bad syntax errors may even caused \SpecialChar LyX
8809 This is because certain sorts of errors may make \SpecialChar LyX
8820 The \SpecialChar LyX
8821 team strives to keep \SpecialChar LyX
8822 stable in such situations, but safe is better
8827 \begin_layout Plain Layout
8828 While we're giving advice: make regular backups.
8829 And be nice to your mother.
8837 \begin_layout Subsection
8838 The Module declaration
8841 \begin_layout Standard
8842 A module must begin with a line like the following:
8845 \begin_layout LyX-Code
8848 DeclareLyXModule[endnotes.sty]{Endnotes}
8849 \change_inserted -712698321 1554395911
8853 \begin_layout LyX-Code
8855 \change_inserted -712698321 1554395924
8860 DeclareCategory{Foot- and Endnotes}
8861 \change_deleted -712698321 1554395911
8869 \begin_layout Standard
8870 The mandatory argument
8871 \change_inserted -712698321 1554395956
8880 , in curly brackets, is the name of the module, as it should appear in
8881 \begin_inset Flex Noun
8884 \begin_layout Plain Layout
8885 Document\SpecialChar menuseparator
8886 Settings\SpecialChar menuseparator
8893 The argument in square brackets is optional: It declares any \SpecialChar LaTeX
8895 on which the module depends.
8896 It is also possible to use the form
8897 \begin_inset Flex Noun
8900 \begin_layout Plain Layout
8906 as an optional argument, which declares that the module can only be used
8907 when there exists a conversion chain between the formats `
8908 \begin_inset Flex Code
8911 \begin_layout Plain Layout
8918 \begin_inset Flex Code
8921 \begin_layout Plain Layout
8929 \change_inserted -712698321 1554396133
8936 declaration is not strictly mandatory, but you should add it, since it
8937 is helpful to find the module.
8938 Please have a look at the existing module categories and if appropriate,
8944 \begin_layout Standard
8946 \change_inserted -712698321 1554395988
8949 declaration should then be followed by lines like the following:
8953 \begin_layout Plain Layout
8954 Preferably in English if the module should be published with \SpecialChar LyX
8956 This description will appear in the list of messages to be translated and
8957 will be thus translated with the next interface update.
8965 \begin_layout LyX-Code
8969 \begin_layout LyX-Code
8970 #Adds an endnote command, in addition to footnotes.
8974 \begin_layout LyX-Code
8975 #You will need to add
8977 theendnotes in TeX code where you
8980 \begin_layout LyX-Code
8981 #want the endnotes to appear.
8985 \begin_layout LyX-Code
8989 \begin_layout LyX-Code
8990 #Requires: somemodule | othermodule
8993 \begin_layout LyX-Code
8994 #Excludes: badmodule
8997 \begin_layout Standard
8998 The description is used in
8999 \begin_inset Flex Noun
9002 \begin_layout Plain Layout
9003 Document\SpecialChar menuseparator
9004 Settings\SpecialChar menuseparator
9010 to provide the user with information about what the module does.
9012 \begin_inset Flex Code
9015 \begin_layout Plain Layout
9021 line is used to identify other modules with which this one must be used;
9023 \begin_inset Flex Code
9026 \begin_layout Plain Layout
9032 line is used to identify modules with which this one may not be used.
9033 Both are optional, and, as shown, multiple modules should be separated
9034 with the pipe symbol: |.
9035 Note that the required modules are treated disjunctively:
9039 of the required modules must be used.
9044 excluded module may be used.
9045 Note that modules are identified here by their filenames without the
9046 \begin_inset Flex Code
9049 \begin_layout Plain Layout
9057 \begin_inset Flex Code
9060 \begin_layout Plain Layout
9067 \begin_inset Flex Code
9070 \begin_layout Plain Layout
9079 \begin_layout Subsection
9080 The CiteEngine file declaration
9083 \begin_layout Standard
9084 A cite engine file must begin with a line like the following:
9087 \begin_layout LyX-Code
9090 DeclareLyXCiteEngineModule[biblatex.sty]{Biblatex}
9093 \begin_layout Standard
9094 The mandatory argument, in curly brackets, is the name of the cite style,
9095 as it should appear in
9096 \begin_inset Flex Noun
9099 \begin_layout Plain Layout
9100 Document\SpecialChar menuseparator
9101 Settings\SpecialChar menuseparator
9108 The argument in square brackets is optional: It declares any \SpecialChar LaTeX
9110 on which the cite engine depends.
9113 \begin_layout Standard
9114 The cite engine declaration should then be followed by lines like the following:
9118 \begin_layout Plain Layout
9119 Preferably in English if the module should be published with \SpecialChar LyX
9121 This description will appear in the list of messages to be translated and
9122 will be thus translated with the next interface update.
9130 \begin_layout LyX-Code
9134 \begin_layout LyX-Code
9135 # Biblatex supports many author-year and numerical styles.
9138 \begin_layout LyX-Code
9139 # It is mainly aimed at the Humanities.
9143 \begin_layout LyX-Code
9144 # customizable, fully localized and provides many features
9147 \begin_layout LyX-Code
9148 # that are not possible with BibTeX.
9149 The use of 'biber' as
9152 \begin_layout LyX-Code
9153 # bibliography processor is advised.
9156 \begin_layout LyX-Code
9160 \begin_layout Standard
9161 The description is used in
9162 \begin_inset Flex Noun
9165 \begin_layout Plain Layout
9166 Document\SpecialChar menuseparator
9167 Settings\SpecialChar menuseparator
9173 to provide the user with information about the cite engine.
9176 \begin_layout Subsection
9180 \begin_layout Standard
9181 The first non-comment line of any layout file, included file, or module
9186 contain the file format number:
9189 \begin_layout Description
9190 \begin_inset Flex Code
9193 \begin_layout Plain Layout
9200 \begin_inset Flex Code
9203 \begin_layout Plain Layout
9209 ] The format number of the layout file.
9212 \begin_layout Standard
9213 This tag was introduced with \SpecialChar LyX
9215 \begin_inset space ~
9219 Layout files from older \SpecialChar LyX
9220 versions do not have an explicit file format and
9221 are considered to have
9222 \begin_inset Flex Code
9225 \begin_layout Plain Layout
9227 \begin_inset space ~
9236 The format for the present version of \SpecialChar LyX
9238 But each version of \SpecialChar LyX
9239 is capable of reading earlier versions' layout files,
9240 just as they are capable of reading files produced by earlier versions
9243 There is, however, no provision for converting to earlier formats.
9246 \begin_layout Subsection
9247 \begin_inset CommandInset label
9249 name "subsec:General-text-class"
9253 General text class parameters
9256 \begin_layout Standard
9257 These are general parameters that govern the behavior of an entire document
9263 mean that they must appear in
9264 \begin_inset Flex Code
9267 \begin_layout Plain Layout
9273 files rather than in modules.
9274 A module can contain any layout tag.)
9277 \begin_layout Description
9279 \change_inserted -712698321 1526899478
9280 \begin_inset Flex Code
9283 \begin_layout Plain Layout
9285 \change_inserted -712698321 1526898610
9286 AddToCiteEngine <engine>
9293 Extends the possibilities for displaying citation references.
9295 \begin_inset CommandInset ref
9297 reference "subsec:Citation-engine-description"
9306 \begin_inset Flex Code
9309 \begin_layout Plain Layout
9311 \change_inserted -712698321 1526898823
9322 \begin_layout Description
9323 \begin_inset Flex Code
9326 \begin_layout Plain Layout
9332 Adds information that will be output in the
9333 \begin_inset Flex Code
9336 \begin_layout Plain Layout
9342 block when the document is output to XHTML.
9343 Typically, this would be used to output CSS style information, but it can
9344 be used for anything that can appear in
9345 \begin_inset Flex Code
9348 \begin_layout Plain Layout
9356 \begin_inset Quotes eld
9360 \begin_inset Flex Code
9363 \begin_layout Plain Layout
9370 \begin_inset Quotes erd
9376 \begin_layout Description
9377 \begin_inset Flex Code
9380 \begin_layout Plain Layout
9386 Adds information to the document preamble.
9388 \begin_inset Newline newline
9392 \begin_inset Quotes eld
9396 \begin_inset Flex Code
9399 \begin_layout Plain Layout
9406 \begin_inset Quotes erd
9410 \change_inserted -712698321 1562592950
9414 \begin_layout Description
9416 \change_inserted -712698321 1562593040
9417 \begin_inset Flex Code
9420 \begin_layout Plain Layout
9422 \change_inserted -712698321 1562592954
9431 \begin_inset Flex Code
9434 \begin_layout Plain Layout
9436 \change_inserted -712698321 1562592950
9447 \begin_inset space \thinspace{}
9451 \begin_inset Flex Code
9454 \begin_layout Plain Layout
9456 \change_inserted -712698321 1562592950
9464 ] If the document class adds the bibliography to the table of contents,
9465 add this option with value
9466 \begin_inset Flex Code
9469 \begin_layout Plain Layout
9471 \change_inserted -712698321 1562592996
9480 \begin_inset Flex Code
9483 \begin_layout Plain Layout
9485 \change_inserted -712698321 1562593006
9494 This prevents the bibliography from being added twice.
9499 \begin_layout Description
9500 \begin_inset Flex Code
9503 \begin_layout Plain Layout
9509 Defines the possibilities for displaying citation references.
9511 \begin_inset CommandInset ref
9513 reference "subsec:Citation-engine-description"
9522 \begin_inset Quotes eld
9526 \begin_inset Flex Code
9529 \begin_layout Plain Layout
9536 \begin_inset Quotes erd
9540 Primarily used in cite engine files (see
9541 \begin_inset CommandInset ref
9543 reference "subsec:Cite-Engine-Files"
9552 \change_inserted -712698321 1526898530
9553 Note that if you specify this in a layout file or module, any cite engine
9554 definition will be overridden.
9556 \begin_inset Flex Code
9559 \begin_layout Plain Layout
9561 \change_inserted -712698321 1526898530
9574 \begin_layout Description
9575 \begin_inset Flex Code
9578 \begin_layout Plain Layout
9584 Defines formats for use in the display of bibliographic information.
9586 \begin_inset CommandInset ref
9588 reference "subsec:Citation-format-description"
9594 \begin_inset Quotes eld
9598 \begin_inset Flex Code
9601 \begin_layout Plain Layout
9608 \begin_inset Quotes erd
9612 Primarily used in cite engine files (see
9613 \begin_inset CommandInset ref
9615 reference "subsec:Cite-Engine-Files"
9624 \change_inserted -712698321 1526898585
9625 A cite format defined in a layout or module will override the cite engine
9631 \begin_layout Description
9632 \begin_inset Flex Code
9635 \begin_layout Plain Layout
9642 \begin_inset Flex Code
9645 \begin_layout Plain Layout
9654 \begin_inset Flex Code
9657 \begin_layout Plain Layout
9663 ] Determines whether
9667 or Bib\SpecialChar TeX
9668 is used to generate a Bibliography.
9669 Primarily used in cite engine files (see
9670 \begin_inset CommandInset ref
9672 reference "subsec:Cite-Engine-Files"
9682 \begin_layout Description
9683 \begin_inset Flex Code
9686 \begin_layout Plain Layout
9692 Describes various global options supported by the document class.
9694 \begin_inset CommandInset ref
9696 reference "subsec:ClassOptions"
9702 \begin_inset Quotes eld
9706 \begin_inset Flex Code
9709 \begin_layout Plain Layout
9716 \begin_inset Quotes erd
9722 \begin_layout Description
9723 \begin_inset Flex Code
9726 \begin_layout Plain Layout
9733 \begin_inset Flex Code
9736 \begin_layout Plain Layout
9745 \begin_inset space \thinspace{}
9749 \begin_inset Flex Code
9752 \begin_layout Plain Layout
9758 ] Whether the class should
9762 to having one or two columns.
9763 Can be changed in the
9764 \begin_inset Flex Noun
9767 \begin_layout Plain Layout
9768 Document\SpecialChar menuseparator
9777 \begin_layout Description
9778 \begin_inset Flex Code
9781 \begin_layout Plain Layout
9788 \begin_inset Flex Code
9791 \begin_layout Plain Layout
9797 ] This sequence defines the properties for a counter.
9798 If the counter does not yet exist, it is created; if it does exist, it
9801 \begin_inset Quotes eld
9805 \begin_inset Flex Code
9808 \begin_layout Plain Layout
9815 \begin_inset Quotes erd
9819 \begin_inset Newline newline
9823 \begin_inset CommandInset ref
9825 reference "subsec:Counters"
9829 for details on counters.
9832 \begin_layout Description
9833 \begin_inset Flex Code
9836 \begin_layout Plain Layout
9842 Sets the default font used to display the document.
9844 \begin_inset CommandInset ref
9846 reference "subsec:Font-description"
9850 for how to declare fonts.
9852 \begin_inset Quotes eld
9856 \begin_inset Flex Code
9859 \begin_layout Plain Layout
9866 \begin_inset Quotes erd
9872 \begin_layout Description
9873 \begin_inset Flex Code
9876 \begin_layout Plain Layout
9883 \begin_inset Flex Code
9886 \begin_layout Plain Layout
9892 ] Specifies a module to be included by default with this document class.
9893 The module is specified as filename without the
9894 \begin_inset Flex Code
9897 \begin_layout Plain Layout
9904 The user can still remove the module, but it will be active at the outset.
9905 (This applies only when new files are created, or when this class is chosen
9906 for an existing document.)
9909 \begin_layout Description
9910 \begin_inset Flex Code
9913 \begin_layout Plain Layout
9920 \begin_inset Flex Code
9923 \begin_layout Plain Layout
9929 ] This is the style that will be assigned to new paragraphs, usually
9930 \begin_inset Flex Noun
9933 \begin_layout Plain Layout
9940 This will default to the first defined style if not given, but you are
9941 encouraged to use this directive.
9944 \begin_layout Description
9946 \change_inserted -970929547 1515112870
9947 \begin_inset Flex Code
9950 \begin_layout Plain Layout
9952 \change_inserted -970929547 1515112782
9961 \begin_inset Flex Code
9964 \begin_layout Plain Layout
9966 \change_inserted -970929547 1515112766
9974 ] The root element (at the top of the document) to use when outputting documents
9975 with this class in DocBook.
9976 The default value is
9977 \begin_inset Quotes eld
9981 \begin_inset Flex Code
9984 \begin_layout Plain Layout
9986 \change_inserted -970929547 1515112845
9995 \begin_inset Quotes erd
10000 \change_deleted 1075283030 1594226862
10002 \change_inserted 1075283030 1594226777
10006 \begin_layout Description
10008 \change_inserted 1075283030 1594226859
10009 \begin_inset Flex Code
10012 \begin_layout Plain Layout
10014 \change_inserted 1075283030 1594226785
10015 DocBookForceAbstract
10023 \begin_inset Flex Code
10026 \begin_layout Plain Layout
10028 \change_inserted 1075283030 1594226804
10037 \begin_inset Quotes eld
10045 \begin_inset Quotes erd
10048 , the root element will always have an
10053 The default value is
10054 \begin_inset Quotes eld
10062 \begin_inset Quotes erd
10070 \begin_layout Description
10071 \begin_inset Flex Code
10074 \begin_layout Plain Layout
10081 \begin_inset Flex Code
10084 \begin_layout Plain Layout
10090 ] This tag indicates that the module (which is specified by filename without
10092 \begin_inset Flex Code
10095 \begin_layout Plain Layout
10101 extension) cannot be used with this document class.
10102 This might be used in a journal-specific layout file to prevent, say, the
10104 \begin_inset Flex Code
10107 \begin_layout Plain Layout
10113 module that numbers theorems by section.
10118 be used in a module.
10119 Modules have their own way of excluding other modules (see
10120 \begin_inset CommandInset ref
10122 reference "subsec:Layout-modules"
10129 \begin_layout Description
10130 \begin_inset Flex Code
10133 \begin_layout Plain Layout
10139 Defines a new float.
10141 \begin_inset CommandInset ref
10143 reference "subsec:Floats"
10149 \begin_inset Quotes eld
10153 \begin_inset Flex Code
10156 \begin_layout Plain Layout
10163 \begin_inset Quotes erd
10169 \begin_layout Description
10170 \begin_inset Flex Code
10173 \begin_layout Plain Layout
10179 Sets the information that will be output in the
10180 \begin_inset Flex Code
10183 \begin_layout Plain Layout
10189 block when this document class is output to XHTML.
10190 Note that this will completely override any prior
10191 \begin_inset Flex Code
10194 \begin_layout Plain Layout
10201 \begin_inset Flex Code
10204 \begin_layout Plain Layout
10212 \begin_inset Newline newline
10216 \begin_inset Flex Code
10219 \begin_layout Plain Layout
10225 if you just want to add material to the preamble.) Must end with
10226 \begin_inset Quotes eld
10230 \begin_inset Flex Code
10233 \begin_layout Plain Layout
10240 \begin_inset Quotes erd
10246 \begin_layout Description
10247 \begin_inset Flex Code
10250 \begin_layout Plain Layout
10257 \begin_inset Flex Code
10260 \begin_layout Plain Layout
10266 ] The style to use for the table of contents, bibliography, and so forth,
10267 when the document is output to HTML.
10268 For articles, this should normally be
10269 \begin_inset Flex Code
10272 \begin_layout Plain Layout
10279 \begin_inset Flex Code
10282 \begin_layout Plain Layout
10289 If it is not given, then \SpecialChar LyX
10290 will attempt to figure out which layout to use.
10293 \begin_layout Description
10294 \begin_inset Flex Code
10297 \begin_layout Plain Layout
10304 \begin_inset Flex Code
10307 \begin_layout Plain Layout
10313 ] Modifies the properties of the given counter.
10314 If the counter does not exist, the statement is ignored.
10316 \begin_inset Quotes eld
10320 \begin_inset Flex Code
10323 \begin_layout Plain Layout
10330 \begin_inset Quotes erd
10334 \begin_inset Newline newline
10338 \begin_inset CommandInset ref
10340 reference "subsec:Counters"
10344 for details on counters.
10347 \begin_layout Description
10348 \begin_inset Flex Code
10351 \begin_layout Plain Layout
10358 \begin_inset Flex Code
10361 \begin_layout Plain Layout
10367 ] This allows you to include another layout definition file within yours
10368 to avoid duplicating commands.
10369 Common examples are the standard layout files, for example,
10370 \begin_inset Flex Code
10373 \begin_layout Plain Layout
10379 , which contains most of the basic layouts.
10380 \change_inserted -712698321 1611646803
10384 \begin_layout Description
10386 \change_inserted -712698321 1611646804
10387 \begin_inset Flex Code
10390 \begin_layout Plain Layout
10392 \change_inserted -712698321 1611646837
10401 \begin_inset Flex Code
10404 \begin_layout Plain Layout
10406 \change_inserted -712698321 1611646804
10414 ] is a variant of the
10415 \begin_inset Flex Code
10418 \begin_layout Plain Layout
10420 \change_inserted -712698321 1611646804
10428 command which does not look for files in the user directory.
10429 This allows to create a file
10430 \begin_inset Flex Code
10433 \begin_layout Plain Layout
10435 \change_inserted -712698321 1611646804
10444 \begin_inset Flex Code
10447 \begin_layout Plain Layout
10449 \change_inserted -712698321 1611646804
10457 in the user directory which includes a global file with the same name via
10459 \begin_inset Flex Code
10462 \begin_layout Plain Layout
10464 \change_inserted -712698321 1611646853
10473 \begin_inset Flex Code
10476 \begin_layout Plain Layout
10478 \change_inserted -712698321 1611646855
10479 InputGlobal name.inc
10486 , respectively (with
10487 \begin_inset Flex Code
10490 \begin_layout Plain Layout
10492 \change_inserted -712698321 1611646804
10500 , the file would recursively include itself).
10501 This way, you can modify global files without having to completely copy
10507 \begin_layout Description
10508 \begin_inset Flex Code
10511 \begin_layout Plain Layout
10518 \begin_inset Flex Code
10521 \begin_layout Plain Layout
10527 ] This section (re-)defines the layout of an inset.
10528 It can be applied to an existing inset or to a new, user-defined inset,
10529 e.g., a new character style.
10531 \begin_inset Quotes eld
10535 \begin_inset Flex Code
10538 \begin_layout Plain Layout
10545 \begin_inset Quotes erd
10549 \begin_inset Newline newline
10553 \begin_inset CommandInset ref
10555 reference "subsec:Flex-insets-and"
10559 for more information.
10563 \begin_layout Description
10564 \begin_inset Flex Code
10567 \begin_layout Plain Layout
10574 \begin_inset Flex Code
10577 \begin_layout Plain Layout
10583 ] A string that indicates the width of the left margin on the screen, for
10585 \begin_inset Quotes eld
10589 \begin_inset Flex Code
10592 \begin_layout Plain Layout
10599 \begin_inset Quotes erd
10603 (Note that this is not a `length', like
10604 \begin_inset Quotes eld
10608 \begin_inset Quotes erd
10614 \begin_layout Description
10615 \begin_inset Flex Code
10618 \begin_layout Plain Layout
10625 \begin_inset Flex Code
10628 \begin_layout Plain Layout
10634 ] An integer that determines the maximal number of names displayed in an
10635 author-year citation before the citation switches to
10636 \begin_inset Quotes eld
10640 \begin_inset Quotes erd
10644 Primarily used in cite engine files (see
10645 \begin_inset CommandInset ref
10647 reference "subsec:Cite-Engine-Files"
10657 \begin_layout Description
10659 \change_inserted -712698321 1612018485
10660 \begin_inset Flex Code
10663 \begin_layout Plain Layout
10665 \change_inserted -712698321 1612018457
10674 \begin_inset Flex Code
10677 \begin_layout Plain Layout
10679 \change_inserted -712698321 1612018466
10687 ] Modifies the layout of an inset.
10688 If the layout does not exist, this section is ignored.
10690 \begin_inset Quotes eld
10694 \begin_inset Flex Code
10697 \begin_layout Plain Layout
10699 \change_inserted -712698321 1612018452
10708 \begin_inset Quotes erd
10714 \begin_layout Description
10715 \begin_inset Flex Code
10718 \begin_layout Plain Layout
10725 \begin_inset Flex Code
10728 \begin_layout Plain Layout
10734 ] Modifies the properties of the given paragraph style.
10735 If the style does not exist, this section is ignored.
10737 \begin_inset Quotes eld
10741 \begin_inset Flex Code
10744 \begin_layout Plain Layout
10751 \begin_inset Quotes erd
10757 \begin_layout Description
10758 \begin_inset Flex Code
10761 \begin_layout Plain Layout
10768 \begin_inset Flex Code
10771 \begin_layout Plain Layout
10777 ] Deletes an existing counter, usually one defined in an included file.
10780 \begin_layout Description
10781 \begin_inset Flex Code
10784 \begin_layout Plain Layout
10791 \begin_inset Flex Code
10794 \begin_layout Plain Layout
10800 ] Deletes an existing float.
10801 This is particularly useful when you want to suppress a float that has
10802 been defined in an input file.
10805 \begin_layout Description
10806 \begin_inset Flex Code
10809 \begin_layout Plain Layout
10816 \begin_inset Flex Code
10819 \begin_layout Plain Layout
10825 ] Deletes an existing style.
10828 \begin_layout Description
10829 \begin_inset Flex Code
10832 \begin_layout Plain Layout
10839 \begin_inset Flex Code
10842 \begin_layout Plain Layout
10849 \begin_inset Flex Code
10852 \begin_layout Plain Layout
10858 ] Define a new table of contents with type
10859 \begin_inset Flex Code
10862 \begin_layout Plain Layout
10869 \begin_inset Flex Code
10872 \begin_layout Plain Layout
10879 See also the AddToToc commands.
10882 \begin_layout Description
10883 \begin_inset Flex Code
10886 \begin_layout Plain Layout
10893 \begin_inset Flex Code
10896 \begin_layout Plain Layout
10902 ] The file format (as defined in the \SpecialChar LyX
10903 preferences) produced by this document
10905 It is mainly useful when
10906 \begin_inset Flex Code
10909 \begin_layout Plain Layout
10916 \begin_inset Flex Code
10919 \begin_layout Plain Layout
10925 and one wants to define a new type of literate document.
10926 The format is reset to
10927 \change_deleted 5863208 1594239413
10929 \begin_inset Quotes eld
10933 \begin_inset Flex Code
10936 \begin_layout Plain Layout
10943 \begin_inset Quotes erd
10949 \begin_inset Quotes eld
10953 \begin_inset Flex Code
10956 \begin_layout Plain Layout
10963 \begin_inset Quotes erd
10966 when the corresponding
10967 \begin_inset Flex Code
10970 \begin_layout Plain Layout
10976 parameter is encountered.
10979 \begin_layout Description
10980 \begin_inset Flex Code
10983 \begin_layout Plain Layout
10990 \begin_inset Flex Code
10993 \begin_layout Plain Layout
11004 \change_deleted 5863208 1594239430
11006 \begin_inset Flex Code
11009 \begin_layout Plain Layout
11018 \begin_inset Flex Code
11021 \begin_layout Plain Layout
11027 ] Specifies what sort of output documents using this class will produce.
11030 \begin_layout Description
11031 \begin_inset Flex Code
11034 \begin_layout Plain Layout
11041 \begin_inset Flex Code
11044 \begin_layout Plain Layout
11051 \begin_inset Flex Code
11054 \begin_layout Plain Layout
11060 ] Specifies options, given in the second string, for the package named by
11063 \begin_inset Quotes eld
11067 \begin_inset Flex Code
11070 \begin_layout Plain Layout
11071 PackageOptions natbib square
11077 \begin_inset Quotes erd
11081 \begin_inset Flex Code
11084 \begin_layout Plain Layout
11090 to be loaded with the
11091 \begin_inset Flex Code
11094 \begin_layout Plain Layout
11101 (For \SpecialChar TeX
11102 perts, this causes \SpecialChar LyX
11104 \begin_inset Flex Code
11107 \begin_layout Plain Layout
11110 PassOptionsToPackage{natbib}{square}
11116 \begin_inset Flex Code
11119 \begin_layout Plain Layout
11126 \change_inserted -712698321 1565102364
11130 \begin_layout Description
11132 \change_inserted -712698321 1565102470
11133 \begin_inset Flex Code
11136 \begin_layout Plain Layout
11138 \change_inserted -712698321 1565102365
11147 \begin_inset Flex Code
11150 \begin_layout Plain Layout
11152 \change_inserted -712698321 1565105222
11157 , letter, legal, executive, a0, a1, a2, a3, a4, a5, a6, b0, b1, b2, b3,
11158 b4, b5, b6, c0, c1, c2, c3, c4, c5, c6, b0j, b1j, b2j, b3j, b4j, b5j, b6j
11165 ] The default page size.
11166 This is used by some converters.
11171 \begin_layout Description
11172 \begin_inset Flex Code
11175 \begin_layout Plain Layout
11182 \begin_inset Flex Code
11185 \begin_layout Plain Layout
11194 \begin_inset Flex Code
11197 \begin_layout Plain Layout
11204 \begin_inset Flex Code
11207 \begin_layout Plain Layout
11213 ] The default pagestyle.
11214 Can be changed in the
11215 \begin_inset Flex Noun
11218 \begin_layout Plain Layout
11219 Document\SpecialChar menuseparator
11228 \begin_layout Description
11229 \begin_inset Flex Code
11232 \begin_layout Plain Layout
11238 Sets the preamble for the \SpecialChar LaTeX
11240 Note that this will completely override any prior
11241 \begin_inset Flex Code
11244 \begin_layout Plain Layout
11251 \begin_inset Flex Code
11254 \begin_layout Plain Layout
11262 \begin_inset Flex Code
11265 \begin_layout Plain Layout
11271 if you just want to add material to the preamble.) Must end with
11272 \begin_inset Quotes eld
11276 \begin_inset Flex Code
11279 \begin_layout Plain Layout
11286 \begin_inset Quotes erd
11290 \change_inserted -712698321 1612018500
11294 \begin_layout Description
11296 \change_inserted -712698321 1612018547
11297 \begin_inset Flex Code
11300 \begin_layout Plain Layout
11302 \change_inserted -712698321 1612018506
11311 \begin_inset Flex Code
11314 \begin_layout Plain Layout
11316 \change_inserted -712698321 1612018509
11324 ] Defines the layout of an inset if it does not already exist.
11325 If the layout does exist, this section is ignored.
11327 \begin_inset Quotes eld
11331 \begin_inset Flex Code
11334 \begin_layout Plain Layout
11336 \change_inserted -712698321 1612018500
11345 \begin_inset Quotes erd
11353 \begin_layout Description
11354 \begin_inset Flex Code
11357 \begin_layout Plain Layout
11364 \begin_inset Flex Code
11367 \begin_layout Plain Layout
11374 \begin_inset Flex Code
11377 \begin_layout Plain Layout
11386 \begin_inset space \thinspace{}
11390 \begin_inset Flex Code
11393 \begin_layout Plain Layout
11399 ] Whether the class already provides the feature
11400 \begin_inset Flex Code
11403 \begin_layout Plain Layout
11410 A feature is in general the name of a package (e.
11411 \begin_inset space \thinspace{}
11415 \begin_inset space \space{}
11419 \begin_inset Flex Code
11422 \begin_layout Plain Layout
11429 \begin_inset Flex Code
11432 \begin_layout Plain Layout
11439 \begin_inset space \thinspace{}
11443 \begin_inset space \space{}
11447 \begin_inset Flex Code
11450 \begin_layout Plain Layout
11457 \begin_inset Flex Code
11460 \begin_layout Plain Layout
11468 \begin_inset CommandInset ref
11470 reference "chap:List-of-functions"
11474 for the list of features.
11477 \begin_layout Description
11478 \begin_inset Flex Code
11481 \begin_layout Plain Layout
11488 \begin_inset Flex Code
11491 \begin_layout Plain Layout
11497 ] Indicates that this layout provides the functionality of the module mentioned,
11498 which should be specified by the filename without the
11499 \begin_inset Flex Code
11502 \begin_layout Plain Layout
11509 This will typically be used if the layout includes the module directly,
11510 rather than using the
11511 \begin_inset Flex Code
11514 \begin_layout Plain Layout
11520 tag to indicate that it ought to be used.
11521 It could also be used in a module that provided an alternate implementation
11522 of the same functionality.
11525 \begin_layout Description
11526 \begin_inset Flex Code
11529 \begin_layout Plain Layout
11536 \begin_inset Flex Code
11539 \begin_layout Plain Layout
11545 ] Creates a new paragraph style if it does not already exist.
11546 If the style does exist, this section is ignored.
11548 \begin_inset Quotes eld
11552 \begin_inset Flex Code
11555 \begin_layout Plain Layout
11562 \begin_inset Quotes erd
11568 \begin_layout Description
11569 \begin_inset Flex Code
11572 \begin_layout Plain Layout
11579 \begin_inset Flex Code
11582 \begin_layout Plain Layout
11588 ] Whether the class requires the feature
11589 \begin_inset Flex Code
11592 \begin_layout Plain Layout
11599 Multiple features must be separated by commas.
11600 Note that you can only request supported features.
11602 \begin_inset CommandInset ref
11604 reference "chap:List-of-functions"
11608 for the list of features.).
11609 If you require a package with specific options, you can additionally use
11611 \begin_inset Flex Code
11614 \begin_layout Plain Layout
11623 \begin_layout Description
11624 \begin_inset Flex Code
11627 \begin_layout Plain Layout
11634 \begin_inset Flex Code
11637 \begin_layout Plain Layout
11643 ] A string that indicates the width of the right margin on the screen, for
11645 \begin_inset Quotes eld
11649 \begin_inset Flex Code
11652 \begin_layout Plain Layout
11659 \begin_inset Quotes erd
11665 \begin_layout Description
11666 \begin_inset Flex Code
11669 \begin_layout Plain Layout
11676 \begin_inset Flex Code
11679 \begin_layout Plain Layout
11685 ] Sets which divisions get numbered.
11687 \begin_inset Newline newline
11691 \begin_inset Flex Code
11694 \begin_layout Plain Layout
11700 counter in \SpecialChar LaTeX
11704 \begin_layout Description
11705 \begin_inset Flex Code
11708 \begin_layout Plain Layout
11715 \begin_inset Flex Code
11718 \begin_layout Plain Layout
11727 \begin_inset space \thinspace{}
11731 \begin_inset Flex Code
11734 \begin_layout Plain Layout
11740 ] Whether the class-default should be printing on one or both sides of the
11742 Can be changed in the
11743 \begin_inset Flex Noun
11746 \begin_layout Plain Layout
11747 Document\SpecialChar menuseparator
11756 \begin_layout Description
11757 \begin_inset Flex Code
11760 \begin_layout Plain Layout
11767 \begin_inset Flex Code
11770 \begin_layout Plain Layout
11776 ] This sequence defines a paragraph style.
11777 If the style does not yet exist, it is created; if it does exist, its parameter
11780 \begin_inset Quotes eld
11784 \begin_inset Flex Code
11787 \begin_layout Plain Layout
11794 \begin_inset Quotes erd
11798 \begin_inset Newline newline
11802 \begin_inset CommandInset ref
11804 reference "subsec:Paragraph-Styles"
11808 for details on paragraph styles.
11809 \change_inserted -712698321 1553617804
11813 \begin_layout Description
11815 \change_inserted -712698321 1553617862
11816 \begin_inset Flex Code
11819 \begin_layout Plain Layout
11821 \change_inserted -712698321 1553617809
11830 \begin_inset Flex Code
11833 \begin_layout Plain Layout
11835 \change_inserted -712698321 1553617805
11843 ] defines the default table style that is used when inserting a table.
11844 The following styles are available:
11848 \begin_layout Itemize
11850 \change_inserted -712698321 1554308039
11851 \begin_inset Flex Code
11854 \begin_layout Plain Layout
11856 \change_inserted -712698321 1554307928
11857 Formal_with_Footline
11865 \begin_inset Quotes eld
11869 \begin_inset Quotes erd
11872 ) style with horizontal lines only, using a bold top and bottom line, the
11873 first and last row are additionally separated from the table body with
11874 a thin middle line.
11877 \begin_layout Itemize
11879 \change_inserted -712698321 1554308087
11880 \begin_inset Flex Code
11883 \begin_layout Plain Layout
11885 \change_inserted -712698321 1554308042
11886 Formal_without_Footline
11893 : same as the above, but the last row is not separated with a middle line
11897 \begin_layout Itemize
11899 \change_inserted -712698321 1553618031
11900 \begin_inset Flex Code
11903 \begin_layout Plain Layout
11905 \change_inserted -712698321 1553618006
11913 : Simple table lines.
11916 \begin_layout Itemize
11918 \change_inserted -712698321 1553618309
11919 \begin_inset Flex Code
11922 \begin_layout Plain Layout
11924 \change_inserted -712698321 1553618031
11933 \begin_inset Flex Code
11936 \begin_layout Plain Layout
11938 \change_inserted -712698321 1553618043
11946 , but with the header
11947 \change_deleted 34634807 1619712593
11949 \change_inserted 34634807 1619712594
11951 \change_inserted -712698321 1553618309
11952 offset with a second horizontal line.
11953 This is also the default style of \SpecialChar LyX
11957 \begin_layout Itemize
11959 \change_inserted -712698321 1553618280
11960 \begin_inset Flex Code
11963 \begin_layout Plain Layout
11965 \change_inserted -712698321 1553618261
11973 : Table without lines.
11979 \begin_layout Description
11980 \begin_inset Flex Code
11983 \begin_layout Plain Layout
11990 \begin_inset Flex Code
11993 \begin_layout Plain Layout
11999 ] The name of the command or environment to be used with
12000 \begin_inset Flex Code
12003 \begin_layout Plain Layout
12012 \begin_layout Description
12013 \begin_inset Flex Code
12016 \begin_layout Plain Layout
12023 \begin_inset Flex Code
12026 \begin_layout Plain Layout
12035 \begin_inset Flex Code
12038 \begin_layout Plain Layout
12044 ] Indicates what kind of markup is used to define the title of a document.
12046 \begin_inset Flex Code
12049 \begin_layout Plain Layout
12055 means that the macro with name
12056 \begin_inset Flex Code
12059 \begin_layout Plain Layout
12065 will be inserted after the last layout which has
12066 \begin_inset Quotes eld
12070 \begin_inset Flex Code
12073 \begin_layout Plain Layout
12075 \begin_inset space ~
12084 \begin_inset Quotes erd
12089 \begin_inset Flex Code
12092 \begin_layout Plain Layout
12098 corresponds to the case where all layouts which have
12099 \begin_inset Quotes eld
12103 \begin_inset Flex Code
12106 \begin_layout Plain Layout
12108 \begin_inset space ~
12117 \begin_inset Quotes erd
12120 should be enclosed into the
12121 \begin_inset Flex Code
12124 \begin_layout Plain Layout
12133 \begin_layout Description
12134 \begin_inset Flex Code
12137 \begin_layout Plain Layout
12144 \begin_inset Flex Code
12147 \begin_layout Plain Layout
12153 ] Sets which divisions are included in the table of contents.
12155 \begin_inset Flex Code
12158 \begin_layout Plain Layout
12164 counter in \SpecialChar LaTeX
12168 \begin_layout Subsection
12169 \begin_inset Flex Code
12172 \begin_layout Plain Layout
12179 \begin_inset CommandInset label
12181 name "subsec:ClassOptions"
12188 \begin_layout Standard
12190 \begin_inset Flex Code
12193 \begin_layout Plain Layout
12199 section can contain the following entries:
12202 \begin_layout Description
12203 \begin_inset Flex Code
12206 \begin_layout Plain Layout
12213 \begin_inset Flex Code
12216 \begin_layout Plain Layout
12222 ] The list of available font sizes for the document's main font, separated
12224 \begin_inset Quotes eld
12228 \begin_inset Flex Code
12231 \begin_layout Plain Layout
12238 \begin_inset Quotes erd
12243 \change_inserted -712698321 1565110196
12244 Any number is possible.
12247 \begin_layout Description
12249 \change_inserted -712698321 1565110259
12250 \begin_inset Flex Code
12253 \begin_layout Plain Layout
12255 \change_inserted -712698321 1565110199
12264 \begin_inset Flex Code
12267 \begin_layout Plain Layout
12269 \change_inserted -712698321 1565110196
12277 ] The format for the font size option.
12279 \begin_inset Flex Code
12282 \begin_layout Plain Layout
12284 \change_inserted -712698321 1565110238
12294 \begin_inset Flex Code
12297 \begin_layout Plain Layout
12299 \change_inserted -712698321 1565110248
12307 is a placeholder for the font size.
12312 \begin_layout Description
12314 \change_deleted 5863208 1594239483
12315 \begin_inset Flex Code
12318 \begin_layout Plain Layout
12324 Used to set the DTD line with XML-based output classes.
12326 \begin_inset space \thinspace{}
12330 \begin_inset Quotes eld
12333 -//OASIS//DTD DocBook V4.2//EN
12334 \begin_inset Quotes erd
12338 \change_inserted -712698321 1565101761
12342 \begin_layout Description
12344 \change_inserted -712698321 1565180598
12345 \begin_inset Flex Code
12348 \begin_layout Plain Layout
12350 \change_inserted -712698321 1565101918
12359 \begin_inset Flex Code
12362 \begin_layout Plain Layout
12364 \change_inserted -712698321 1565105399
12365 string="letter|\SpecialChar allowbreak
12366 legal|\SpecialChar allowbreak
12367 executive|\SpecialChar allowbreak
12368 a0|\SpecialChar allowbreak
12369 a1|\SpecialChar allowbreak
12370 a2|\SpecialChar allowbreak
12371 a3|\SpecialChar allowbreak
12372 a4|\SpecialChar allowbreak
12373 a5|\SpecialChar allowbreak
12374 a6|\SpecialChar allowbreak
12375 b0|\SpecialChar allowbreak
12376 b1|\SpecialChar allowbreak
12377 b2|\SpecialChar allowbreak
12378 b3|\SpecialChar allowbreak
12379 b4|\SpecialChar allowbreak
12380 b5|\SpecialChar allowbreak
12381 b6|\SpecialChar allowbreak
12382 c0|\SpecialChar allowbreak
12383 c1|\SpecialChar allowbreak
12385 2|\SpecialChar allowbreak
12386 c3|\SpecialChar allowbreak
12387 c4|\SpecialChar allowbreak
12388 c5|\SpecialChar allowbreak
12389 c6|\SpecialChar allowbreak
12390 b0j|\SpecialChar allowbreak
12391 b1j|\SpecialChar allowbreak
12392 b2j|\SpecialChar allowbreak
12393 b3j|\SpecialChar allowbreak
12394 b4j|\SpecialChar allowbreak
12395 b5j|\SpecialChar allowbreak
12403 ] The list of available page sizes, separated by
12404 \begin_inset Quotes eld
12408 \begin_inset Flex Code
12411 \begin_layout Plain Layout
12413 \change_inserted -712698321 1565101779
12422 \begin_inset Quotes erd
12426 Currently, only the listed sizes are supported.
12427 Other sizes might be entered as custom class option.
12430 \begin_layout Description
12432 \change_inserted -712698321 1565180623
12433 \begin_inset Flex Code
12436 \begin_layout Plain Layout
12438 \change_inserted -712698321 1565180605
12447 \begin_inset Flex Code
12450 \begin_layout Plain Layout
12452 \change_inserted -712698321 1565180601
12460 ] The format for the page size option.
12462 \begin_inset Flex Code
12465 \begin_layout Plain Layout
12467 \change_inserted -712698321 1565180618
12477 \begin_inset Flex Code
12480 \begin_layout Plain Layout
12482 \change_inserted -712698321 1565180601
12490 is a placeholder for the paper size.
12495 \begin_layout Description
12496 \begin_inset Flex Code
12499 \begin_layout Plain Layout
12506 \begin_inset Flex Code
12509 \begin_layout Plain Layout
12510 string="empty|plain|headings|fancy"
12515 ] The list of available page sty\SpecialChar softhyphen
12517 \begin_inset Quotes eld
12521 \begin_inset Flex Code
12524 \begin_layout Plain Layout
12531 \begin_inset Quotes erd
12537 \begin_layout Description
12538 \begin_inset Flex Code
12541 \begin_layout Plain Layout
12548 \begin_inset Flex Code
12551 \begin_layout Plain Layout
12557 ] Some document class options, separated by a comma, that will be added
12558 to the optional part of the
12559 \begin_inset Flex Code
12562 \begin_layout Plain Layout
12573 \begin_layout Standard
12575 \begin_inset Flex Code
12578 \begin_layout Plain Layout
12584 section must end with
12585 \begin_inset Quotes eld
12589 \begin_inset Flex Code
12592 \begin_layout Plain Layout
12599 \begin_inset Quotes erd
12605 \begin_layout Subsection
12607 \begin_inset CommandInset label
12609 name "subsec:Paragraph-Styles"
12616 \begin_layout Standard
12617 A paragraph style description looks like this:
12621 \begin_layout Plain Layout
12622 Note that this will either define a new style or modify an existing one.
12630 \begin_layout LyX-Code
12637 \begin_layout LyX-Code
12641 \begin_layout LyX-Code
12645 \begin_layout Standard
12646 where the following commands are allowed:
12649 \begin_layout Description
12650 \begin_inset Flex Code
12653 \begin_layout Plain Layout
12660 \begin_inset Flex Code
12663 \begin_layout Plain Layout
12669 =""] This paragraph will appear in the table of contents of the given type.
12670 An empty string disables.
12671 See also the OutlinerName and the IsTocCaption commands.
12675 \begin_layout Description
12676 \begin_inset Flex Code
12679 \begin_layout Plain Layout
12686 \begin_inset Flex Code
12689 \begin_layout Plain Layout
12694 , left, right, center
12699 ] Paragraph alignment.
12702 \begin_layout Description
12703 \begin_inset Flex Code
12706 \begin_layout Plain Layout
12713 \begin_inset Flex Code
12716 \begin_layout Plain Layout
12721 , left, right, center
12726 ] A comma separated list of permitted alignments.
12727 (Some \SpecialChar LaTeX
12728 styles prohibit certain alignments, since those wouldn't make sense.
12729 For example a right-aligned or centered enumeration isn't possible.)
12732 \begin_layout Description
12733 \begin_inset Flex Code
12736 \begin_layout Plain Layout
12743 \begin_inset Flex Code
12746 \begin_layout Plain Layout
12752 ] Defines argument number <int> of a command\SpecialChar breakableslash
12753 environment associated with
12756 \change_inserted -584632292 1615846868
12757 The definition must end with
12758 \begin_inset Flex Code
12761 \begin_layout Plain Layout
12763 \change_inserted -584632292 1615846867
12775 \change_inserted -584632292 1615846880
12777 \begin_inset CommandInset ref
12779 reference "subsec:Arguments"
12786 for more information.
12788 \change_deleted -584632292 1615846694
12789 This is useful for things like section headings, and only makes sense with
12792 Every (optional or required) argument of a command or environment – except
12793 for the required argument that is associated with the content of the paragraph
12794 itself – has a separate definition, where the number specifies the order
12796 The definition must end with
12797 \begin_inset Flex Code
12800 \begin_layout Plain Layout
12807 So a command with two optional arguments has:
12811 \begin_layout Quote
12813 \change_deleted -584632292 1615846694
12819 \begin_layout Quote
12821 \change_deleted -584632292 1615846694
12827 \begin_layout Quote
12829 \change_deleted -584632292 1615846694
12835 \begin_layout Quote
12837 \change_deleted -584632292 1615846694
12843 \begin_layout Quote
12845 \change_deleted -584632292 1615846694
12851 \begin_layout Quote
12853 \change_deleted -584632292 1615846694
12859 \begin_layout Standard
12861 \change_deleted -584632292 1615846694
12863 \begin_inset Flex Code
12866 \begin_layout Plain Layout
12872 definition, the following specifications are possible:
12875 \begin_layout Itemize
12877 \change_deleted -584632292 1615846694
12878 \begin_inset Flex Code
12881 \begin_layout Plain Layout
12888 \begin_inset Flex Code
12891 \begin_layout Plain Layout
12897 The string that will appear both in the menu (to insert this argument)
12898 and on the argument inset button (unless you also specify a separate
12899 \begin_inset Flex Code
12902 \begin_layout Plain Layout
12909 For the menu, you can define an accelerator by appending the respective
12910 character to the string, divided by
12911 \begin_inset Quotes eld
12915 \begin_inset Quotes erd
12919 \begin_inset space \thinspace{}
12923 \begin_inset space \space{}
12927 \begin_inset Quotes eld
12931 \begin_inset Flex Code
12934 \begin_layout Plain Layout
12941 \begin_inset Quotes erd
12947 \begin_layout Itemize
12949 \change_deleted -584632292 1615846694
12950 \begin_inset Flex Code
12953 \begin_layout Plain Layout
12960 \begin_inset Flex Code
12963 \begin_layout Plain Layout
12969 A separate string for the menu.
12970 You can define an accelerator by appending the respective character to
12971 the string, divided by
12972 \begin_inset Quotes eld
12976 \begin_inset Quotes erd
12980 \begin_inset space \thinspace{}
12984 \begin_inset space \space{}
12988 \begin_inset Quotes eld
12992 \begin_inset Flex Code
12995 \begin_layout Plain Layout
13002 \begin_inset Quotes erd
13006 This specification is optional.
13007 If it is not given the
13008 \begin_inset Flex Code
13011 \begin_layout Plain Layout
13017 will be used instead for the menu.
13020 \begin_layout Itemize
13022 \change_deleted -584632292 1615846694
13023 \begin_inset Flex Code
13026 \begin_layout Plain Layout
13033 \begin_inset Flex Code
13036 \begin_layout Plain Layout
13042 A longer explanatory text that appears in the tooltip when hovering over
13043 the argument inset.
13046 \begin_layout Itemize
13048 \change_deleted -584632292 1615846694
13049 \begin_inset Flex Code
13052 \begin_layout Plain Layout
13059 \begin_inset Flex Code
13062 \begin_layout Plain Layout
13071 \begin_inset space \thinspace{}
13075 \begin_inset Flex Code
13078 \begin_layout Plain Layout
13084 ] Declare if this is a mandatory (1) or an optional (0) argument.
13085 Mandatory arguments will be output empty if not given, while optional arguments
13086 will not be output at all.
13087 By default, mandatory arguments are delimited by
13088 \begin_inset Flex Code
13091 \begin_layout Plain Layout
13097 , while optional arguments are delimited by
13098 \begin_inset Flex Code
13101 \begin_layout Plain Layout
13110 \begin_layout Itemize
13112 \change_deleted -584632292 1615846694
13113 \begin_inset Flex Code
13116 \begin_layout Plain Layout
13118 \change_inserted -712698321 1555579780
13127 \begin_inset Flex Code
13130 \begin_layout Plain Layout
13132 \change_inserted -712698321 1555579780
13140 Option to define a different command (from the default
13141 \begin_inset Flex Code
13144 \begin_layout Plain Layout
13146 \change_inserted -712698321 1555579780
13158 ) to be used for line breaks.
13159 The initial backslash must not be specified.
13162 \begin_layout Itemize
13164 \change_deleted -584632292 1615846694
13165 \begin_inset Flex Code
13168 \begin_layout Plain Layout
13175 \begin_inset Flex Code
13178 \begin_layout Plain Layout
13184 defines another argument (by its number) which this argument requires to
13185 be output if it is itself output.
13187 \begin_inset space \thinspace{}
13190 g., in \SpecialChar LaTeX
13191 commands, optional arguments often require previous optional arguments
13192 to be output (at least empty), as in
13193 \begin_inset Flex Code
13196 \begin_layout Plain Layout
13199 command[][argument]{text}
13205 This can be achieved by the statement
13206 \begin_inset Flex Code
13209 \begin_layout Plain Layout
13216 \begin_inset Flex Code
13219 \begin_layout Plain Layout
13228 \begin_layout Itemize
13230 \change_deleted -584632292 1615846694
13231 \begin_inset Flex Code
13234 \begin_layout Plain Layout
13241 \begin_inset Flex Code
13244 \begin_layout Plain Layout
13250 defines a custom left delimiter (instead of
13251 \begin_inset Flex Code
13254 \begin_layout Plain Layout
13261 \begin_inset Flex Code
13264 \begin_layout Plain Layout
13271 A line break in the output can be indicated by
13272 \begin_inset Flex Code
13275 \begin_layout Plain Layout
13284 \begin_layout Itemize
13286 \change_deleted -584632292 1615846694
13287 \begin_inset Flex Code
13290 \begin_layout Plain Layout
13297 \begin_inset Flex Code
13300 \begin_layout Plain Layout
13306 defines a custom right delimiter (instead of
13307 \begin_inset Flex Code
13310 \begin_layout Plain Layout
13317 \begin_inset Flex Code
13320 \begin_layout Plain Layout
13327 A line break in the output can be indicated by
13328 \begin_inset Flex Code
13331 \begin_layout Plain Layout
13340 \begin_layout Itemize
13342 \change_deleted -584632292 1615846694
13343 \begin_inset Flex Code
13346 \begin_layout Plain Layout
13353 \begin_inset Flex Code
13356 \begin_layout Plain Layout
13362 defines an argument that is inserted if and only if no user-specified arguments
13364 \begin_inset space \thinspace{}
13368 \begin_inset space \space{}
13371 if no argument inset has been inserted (note that also an empty argument
13372 inset omits the DefaultArg).
13373 Multiple arguments need to be separated by comma.
13376 \begin_layout Itemize
13378 \change_deleted -584632292 1615846694
13379 \begin_inset Flex Code
13382 \begin_layout Plain Layout
13389 \begin_inset Flex Code
13392 \begin_layout Plain Layout
13398 defines an argument that is inserted in any case (alone or in addition
13399 to user-specified arguments).
13400 Multiple arguments need to be separated by comma.
13403 \begin_layout Itemize
13405 \change_deleted -584632292 1615846694
13406 \begin_inset Flex Code
13409 \begin_layout Plain Layout
13415 The font used for the argument content, see
13416 \begin_inset CommandInset ref
13418 reference "subsec:Font-description"
13425 \begin_layout Itemize
13427 \change_deleted -584632292 1615846694
13428 \begin_inset Flex Code
13431 \begin_layout Plain Layout
13433 \change_inserted -712698321 1559484228
13442 \begin_inset Flex Code
13445 \begin_layout Plain Layout
13447 \change_inserted -712698321 1559484228
13458 \begin_inset space \thinspace{}
13462 \begin_inset Flex Code
13465 \begin_layout Plain Layout
13467 \change_inserted -712698321 1559484228
13475 ] As with paragraph styles, see
13476 \begin_inset CommandInset ref
13478 reference "subsec:Paragraph-Styles"
13485 \begin_layout Itemize
13487 \change_deleted -584632292 1615846694
13488 \begin_inset Flex Code
13491 \begin_layout Plain Layout
13497 The font used for the label; see
13498 \begin_inset CommandInset ref
13500 reference "subsec:Font-description"
13507 \begin_layout Itemize
13509 \change_deleted -584632292 1615846694
13510 \begin_inset Flex Code
13513 \begin_layout Plain Layout
13520 \begin_inset Flex Code
13523 \begin_layout Plain Layout
13528 , Minimalistic, Conglomerate
13533 ] describes the rendering style used for the inset's frame and buttons.
13536 \begin_layout Itemize
13538 \change_deleted -584632292 1615846694
13539 \begin_inset Flex Code
13542 \begin_layout Plain Layout
13549 \begin_inset Flex Code
13552 \begin_layout Plain Layout
13559 \begin_inset Flex Code
13562 \begin_layout Plain Layout
13568 , this argument is automatically inserted when the respective style is selected.
13570 \change_deleted -712698321 1559484200
13571 Currently, only one argument per style\SpecialChar breakableslash
13572 layout can be automatically inserted.
13573 \change_deleted -584632292 1615846694
13577 \begin_layout Itemize
13579 \change_deleted -584632292 1615846694
13580 \begin_inset Flex Code
13583 \begin_layout Plain Layout
13585 \change_inserted -712698321 1559490711
13594 \begin_inset Flex Code
13597 \begin_layout Plain Layout
13599 \change_inserted -712698321 1559490703
13608 \begin_inset Flex Code
13611 \begin_layout Plain Layout
13613 \change_inserted -712698321 1559490703
13621 , this argument will be inserted on a new line with
13622 \begin_inset Flex Code
13625 \begin_layout Plain Layout
13627 \change_inserted -712698321 1559491402
13635 (only available within Flex insets).
13638 \begin_layout Itemize
13640 \change_deleted -584632292 1615846694
13641 \begin_inset Flex Code
13644 \begin_layout Plain Layout
13651 \begin_inset Flex Code
13654 \begin_layout Plain Layout
13661 \begin_inset Flex Code
13664 \begin_layout Plain Layout
13670 , this argument will be inserted with a copy of the co-text (either selected
13671 text or the whole paragraph) as content.
13674 \begin_layout Itemize
13676 \change_deleted -584632292 1615846694
13677 \begin_inset Flex Code
13680 \begin_layout Plain Layout
13687 \begin_inset Flex Code
13690 \begin_layout Plain Layout
13700 ] Whether the contents of this argument should be output in raw form, meaning
13701 without special translations that \SpecialChar LaTeX
13704 \begin_inset Flex Code
13707 \begin_layout Plain Layout
13713 status is inherited by the inset or paragraph layout the argument belongs
13714 to, true and false change the status for the given argument only.
13717 \begin_layout Itemize
13719 \change_deleted -584632292 1615846694
13720 \begin_inset Flex Code
13723 \begin_layout Plain Layout
13730 \begin_inset Flex Code
13733 \begin_layout Plain Layout
13734 string of characters
13743 Defines individual characters
13744 \begin_inset Newline linebreak
13747 that should be output in raw form, meaning without special translations
13748 that \SpecialChar LaTeX
13750 Note that, contrary to PassThru, this needs to be explicitly defined for
13752 That is, arguments do not inherit PassThruChars from their parent inset
13756 \begin_layout Itemize
13758 \change_deleted -584632292 1615846694
13759 \begin_inset Flex Code
13762 \begin_layout Plain Layout
13769 \begin_inset Flex Code
13772 \begin_layout Plain Layout
13781 \begin_inset space \thinspace{}
13785 \begin_inset Flex Code
13788 \begin_layout Plain Layout
13794 ] If this is set to 1, the argument will output its content in the corresponding
13795 item in the table of contents.
13799 \begin_layout Standard
13801 \change_deleted -584632292 1615846694
13802 By default, the text entered in the \SpecialChar LyX
13803 workarea in the respective layout is
13804 the last (mandatory) argument of a command if the
13805 \begin_inset Flex Code
13808 \begin_layout Plain Layout
13815 \begin_inset Flex Code
13818 \begin_layout Plain Layout
13825 However, arguments with the prefix
13826 \begin_inset Flex Code
13829 \begin_layout Plain Layout
13835 are output after this workarea argument.
13836 Note that post-argument numbering restarts at 1, so the first argument
13837 following the workarea argument is
13838 \begin_inset Flex Code
13841 \begin_layout Plain Layout
13848 Post-arguments are ignored in any other
13849 \begin_inset Flex Code
13852 \begin_layout Plain Layout
13859 \begin_inset Flex Code
13862 \begin_layout Plain Layout
13871 \begin_layout Standard
13873 \change_deleted -584632292 1615846694
13875 \begin_inset Flex Code
13878 \begin_layout Plain Layout
13887 \begin_inset Flex Code
13890 \begin_layout Plain Layout
13899 \begin_inset Flex Code
13902 \begin_layout Plain Layout
13908 followed by the number (e.
13909 \begin_inset space \thinspace{}
13913 \begin_inset space \space{}
13917 \begin_inset Flex Code
13920 \begin_layout Plain Layout
13929 \begin_layout Standard
13931 \change_deleted -584632292 1615846694
13932 Finally, there is a special argument type with the prefix
13933 \begin_inset Flex Code
13936 \begin_layout Plain Layout
13938 \change_inserted -712698321 1534487844
13947 It is not really an argument, but uses the argument interface (thus, the
13948 prefix is also followed by a number, e.
13949 \begin_inset space \thinspace{}
13954 \begin_inset Flex Code
13957 \begin_layout Plain Layout
13959 \change_inserted -712698321 1534488412
13960 Argument listpreamble:1
13968 As the name implies, it is targeted at lists such as
13985 Its content will be output at the list start, before the first
13986 \begin_inset Flex Code
13989 \begin_layout Plain Layout
13991 \change_inserted -712698321 1534488058
14001 , on an own line (a place that is otherwise not accessible in \SpecialChar LyX
14003 This way, users can insert redefinitions (of lengths etc.) to individual
14005 By default, these arguments do not have a delimiter.
14011 \begin_layout Description
14012 \begin_inset Flex Code
14015 \begin_layout Plain Layout
14021 Includes a comma-separated list of layouts that should be nested in and
14022 after the current layout.
14023 Only makes sense for nestable layouts (such as environments).
14025 \begin_inset Quotes eld
14029 \begin_inset Flex Code
14032 \begin_layout Plain Layout
14039 \begin_inset Quotes erd
14044 \begin_inset Flex Code
14047 \begin_layout Plain Layout
14056 \begin_layout Description
14057 \begin_inset Flex Code
14060 \begin_layout Plain Layout
14066 Note that this will completely override any prior
14067 \begin_inset Flex Code
14070 \begin_layout Plain Layout
14076 declaration for this style.
14078 \begin_inset Quotes eld
14082 \begin_inset Flex Code
14085 \begin_layout Plain Layout
14092 \begin_inset Quotes erd
14097 \begin_inset CommandInset ref
14099 reference "subsec:I18n"
14103 for details on its use.
14106 \begin_layout Description
14107 \begin_inset Flex Code
14110 \begin_layout Plain Layout
14117 \begin_inset Flex Code
14120 \begin_layout Plain Layout
14130 \begin_layout Plain Layout
14131 Note that a `float' here is a real number, such as: 1.5.
14136 The vertical space with which the last of a chain of paragraphs with this
14137 style is separated from the following paragraph.
14138 If the next paragraph has another style, the separations are not simply
14139 added, but the maximum is taken.
14142 \begin_layout Description
14143 \begin_inset Flex Code
14146 \begin_layout Plain Layout
14153 \begin_inset Flex Code
14156 \begin_layout Plain Layout
14162 ] The category for this style.
14163 This is used to group related styles in the style combobox on the toolbar.
14164 Any string can be used, but you may want to use existing categories with
14169 \begin_layout Description
14170 \begin_inset Flex Code
14173 \begin_layout Plain Layout
14179 Depth of XML command.
14180 Used only with XML-type formats.
14183 \begin_layout Description
14184 \begin_inset Flex Code
14187 \begin_layout Plain Layout
14194 \begin_inset Flex Code
14197 \begin_layout Plain Layout
14203 ] Copies all the features of an existing style into the current one.
14207 \begin_layout Description
14208 \begin_inset Flex Code
14211 \begin_layout Plain Layout
14218 \begin_inset Flex Code
14221 \begin_layout Plain Layout
14227 ] The name of a style whose preamble should be output
14232 This allows to ensure some ordering of the preamble snippets when macros
14233 definitions depend on one another.
14237 \begin_layout Plain Layout
14238 Note that, besides that functionality, there is no way to ensure any ordering
14240 The ordering that you see in a given version of \SpecialChar LyX
14241 may change without warning
14250 \begin_layout Description
14251 \begin_inset Flex Code
14254 \begin_layout Plain Layout
14261 \begin_inset Flex Code
14264 \begin_layout Plain Layout
14269 , Box, Filled_Box, Static
14274 ] The type of label that stands at the end of the paragraph (or sequence
14276 \begin_inset Flex Code
14279 \begin_layout Plain Layout
14286 \begin_inset Newline newline
14290 \begin_inset Flex Code
14293 \begin_layout Plain Layout
14300 \begin_inset Flex Code
14303 \begin_layout Plain Layout
14310 \begin_inset Flex Code
14313 \begin_layout Plain Layout
14321 \begin_inset Flex Code
14324 \begin_layout Plain Layout
14331 \begin_inset Quotes eld
14335 \begin_inset Quotes erd
14339 \begin_inset Flex Code
14342 \begin_layout Plain Layout
14349 \begin_inset space \space{}
14353 \begin_inset Flex Code
14356 \begin_layout Plain Layout
14362 ) is a white (resp.
14363 \begin_inset space ~
14366 black) square suitable for end of proof markers,
14367 \begin_inset Flex Code
14370 \begin_layout Plain Layout
14376 is an explicit text string.
14379 \begin_layout Description
14380 \begin_inset Flex Code
14383 \begin_layout Plain Layout
14390 \begin_inset Flex Code
14393 \begin_layout Plain Layout
14399 ] The string used for a label with a
14400 \begin_inset Flex Code
14403 \begin_layout Plain Layout
14410 \begin_inset Newline newline
14414 \begin_inset Flex Code
14417 \begin_layout Plain Layout
14427 \begin_layout Description
14428 \begin_inset Flex Code
14431 \begin_layout Plain Layout
14437 The font used for both the text body
14443 \begin_inset CommandInset ref
14445 reference "subsec:Font-description"
14450 Note that defining this font automatically defines the
14451 \begin_inset Flex Code
14454 \begin_layout Plain Layout
14461 So you should define this one first if you also want to define
14462 \begin_inset Flex Code
14465 \begin_layout Plain Layout
14474 \begin_layout Description
14475 \begin_inset Flex Code
14478 \begin_layout Plain Layout
14485 \begin_inset Flex Code
14488 \begin_layout Plain Layout
14494 ] Used for backporting new styles to stable \SpecialChar LyX
14496 The first stable version that supports this tag is \SpecialChar LyX
14498 The argument is a number which may either be 0, -1 or any value greater
14501 \begin_inset Flex Code
14504 \begin_layout Plain Layout
14510 flag of a style is greater than zero, it will always be written to the
14512 If a .lyx file is read, the style definitions from the document header are
14513 added to the document class.
14514 Therefore even older \SpecialChar LyX
14515 versions can handle the style.
14517 \begin_inset Flex Code
14520 \begin_layout Plain Layout
14526 is a version number: if the style is read, and the version number is less
14527 than the version number of the already existing style in the document class,
14528 the new style is ignored.
14529 If the version number is greater, the new style replaces the existing style.
14530 A value of -1 means an infinite version number, i.
14531 \begin_inset space \thinspace{}
14535 \begin_inset space \space{}
14538 the style is always used.
14541 \begin_layout Description
14542 \begin_inset Flex Code
14545 \begin_layout Plain Layout
14552 \begin_inset Flex Code
14555 \begin_layout Plain Layout
14564 \begin_inset space \thinspace{}
14568 \begin_inset Flex Code
14571 \begin_layout Plain Layout
14577 ] Usually \SpecialChar LyX
14578 does not allow you to insert more than one space between words,
14579 since a space is considered as the separation between two words, not a
14580 character or symbol of its own.
14581 This is a very fine thing but sometimes annoying, for example, when typing
14582 program code or plain \SpecialChar LaTeX
14585 \begin_inset Flex Code
14588 \begin_layout Plain Layout
14596 \change_deleted -495245474 1550490105
14600 will create protected blanks for the additional blanks when
14601 \change_deleted 34634807 1619626461
14605 \change_inserted -495245474 1550490096
14607 \begin_inset Flex Code
14610 \begin_layout Plain Layout
14612 \change_inserted -495245474 1550490089
14621 \change_deleted -495245474 1550490116
14622 another mode than \SpecialChar LaTeX
14625 \change_inserted -495245474 1550247760
14627 \begin_inset Flex Code
14630 \begin_layout Plain Layout
14632 \change_inserted -495245474 1550247736
14641 \begin_inset Flex Code
14644 \begin_layout Plain Layout
14646 \change_inserted -495245474 1550247755
14659 \begin_layout Description
14660 \begin_inset Flex Code
14663 \begin_layout Plain Layout
14669 These tags are used with XHTML output.
14671 \begin_inset CommandInset ref
14673 reference "subsec:Paragraph-Style-XHTML"
14680 \begin_layout Description
14681 \begin_inset Flex Code
14684 \begin_layout Plain Layout
14690 [FIXME] (Used only with XML-type formats.)
14693 \begin_layout Description
14694 \begin_inset Flex Code
14697 \begin_layout Plain Layout
14704 \begin_inset Flex Code
14707 \begin_layout Plain Layout
14716 \begin_inset space \thinspace{}
14720 \begin_inset Flex Code
14723 \begin_layout Plain Layout
14730 \begin_inset Flex Code
14733 \begin_layout Plain Layout
14739 , marks the style as to be included in the document preamble and not in
14741 This is useful for document classes that want such information as the title
14742 and author to appear in the preamble.
14743 Note that this works only for styles for which the
14744 \begin_inset Flex Code
14747 \begin_layout Plain Layout
14754 \begin_inset Flex Code
14757 \begin_layout Plain Layout
14764 \begin_inset Flex Code
14767 \begin_layout Plain Layout
14776 \begin_layout Description
14777 \begin_inset Flex Code
14780 \begin_layout Plain Layout
14787 \begin_inset Flex Code
14790 \begin_layout Plain Layout
14799 \begin_inset space \thinspace{}
14803 \begin_inset Flex Code
14806 \begin_layout Plain Layout
14813 \begin_inset Flex Code
14816 \begin_layout Plain Layout
14822 , marks the style as being part of a title block (see also the
14823 \begin_inset Flex Code
14826 \begin_layout Plain Layout
14833 \begin_inset Flex Code
14836 \begin_layout Plain Layout
14845 \begin_layout Description
14846 \begin_inset Flex Code
14849 \begin_layout Plain Layout
14855 Includes a comma-separated list of layouts after which this one should
14857 Only makes sense with regard to nestable layouts (such as environments).
14859 \begin_inset Quotes eld
14863 \begin_inset Flex Code
14866 \begin_layout Plain Layout
14873 \begin_inset Quotes erd
14878 \begin_inset Flex Code
14881 \begin_layout Plain Layout
14890 \begin_layout Description
14891 \begin_inset Flex Code
14894 \begin_layout Plain Layout
14901 \begin_inset Flex Code
14904 \begin_layout Plain Layout
14913 \begin_inset space \thinspace{}
14917 \begin_inset Flex Code
14920 \begin_layout Plain Layout
14926 ] If this is set to 1 and AddToToc is enabled, the paragraph adds a summary
14927 of its contents in its item in the table of contents.
14928 Otherwise, only the label, if it exists, appears.
14931 \begin_layout Description
14932 \begin_inset Flex Code
14935 \begin_layout Plain Layout
14942 \begin_inset Flex Code
14945 \begin_layout Plain Layout
14951 ] The \SpecialChar LaTeX
14952 command sequence declaring an item in a list.
14953 The command is to be defined without the preceding backslash (the default
14955 \begin_inset Quotes eld
14959 \begin_inset Quotes erd
14963 \begin_inset Flex Code
14966 \begin_layout Plain Layout
14974 in the \SpecialChar LaTeX
14978 \begin_layout Description
14979 \begin_inset Flex Code
14982 \begin_layout Plain Layout
14989 \begin_inset Flex Code
14992 \begin_layout Plain Layout
14998 ] This provides extra space between paragraphs that have the same style.
14999 If you put other styles into an environment, each is separated with the
15001 \begin_inset Flex Code
15004 \begin_layout Plain Layout
15011 But the whole items of the environment are additionally separated with
15013 \begin_inset Flex Code
15016 \begin_layout Plain Layout
15023 Note that this is a
15028 \begin_layout Description
15029 \begin_inset Flex Code
15032 \begin_layout Plain Layout
15038 [FIXME] (Used only with XML-type formats.)
15041 \begin_layout Description
15042 \begin_inset Flex Code
15045 \begin_layout Plain Layout
15052 \begin_inset Flex Code
15055 \begin_layout Plain Layout
15064 \begin_inset space \thinspace{}
15068 \begin_inset Flex Code
15071 \begin_layout Plain Layout
15077 ] Usually \SpecialChar LyX
15078 does not allow you to leave a paragraph empty, since it would
15079 lead to empty \SpecialChar LaTeX
15081 There are some cases where this could be desirable however: in a letter
15082 template, the required fields can be provided as empty fields, so that
15083 people do not forget them; in some special classes, a style can be used
15084 as some kind of break, which does not contain actual text.
15087 \begin_layout Description
15088 \begin_inset Flex Code
15091 \begin_layout Plain Layout
15098 \begin_inset Flex Code
15101 \begin_layout Plain Layout
15107 ] The vertical space between the label and the text body.
15108 Only used for labels that are above the text body (
15109 \begin_inset Flex Code
15112 \begin_layout Plain Layout
15119 \begin_inset Newline newline
15123 \begin_inset Flex Code
15126 \begin_layout Plain Layout
15127 Centered_Top_Environment
15135 \begin_layout Description
15136 \begin_inset Flex Code
15139 \begin_layout Plain Layout
15146 \begin_inset Flex Code
15149 \begin_layout Plain Layout
15155 ] The name of the counter for automatic numbering.
15156 In order to have the counter appear with your label, you will need to reference
15158 \begin_inset Flex Code
15161 \begin_layout Plain Layout
15170 This will work with
15171 \begin_inset Flex Code
15174 \begin_layout Plain Layout
15181 \begin_inset Flex Code
15184 \begin_layout Plain Layout
15191 \begin_inset Flex Code
15194 \begin_layout Plain Layout
15201 \begin_inset Flex Code
15204 \begin_layout Plain Layout
15211 \begin_inset Newline newline
15219 \begin_inset Flex Code
15222 \begin_layout Plain Layout
15229 \begin_inset Flex Code
15232 \begin_layout Plain Layout
15238 , though this case is a bit complicated.
15239 Suppose you declare
15240 \begin_inset Quotes eld
15244 \begin_inset Flex Code
15247 \begin_layout Plain Layout
15248 LabelCounter myenum
15254 \begin_inset Quotes erd
15258 Then the actual counters used are
15259 \begin_inset Flex Code
15262 \begin_layout Plain Layout
15269 \begin_inset Flex Code
15272 \begin_layout Plain Layout
15279 \begin_inset Flex Code
15282 \begin_layout Plain Layout
15289 \begin_inset Flex Code
15292 \begin_layout Plain Layout
15298 , much as in \SpecialChar LaTeX
15300 These counters must all be declared separately.
15301 \begin_inset Newline newline
15305 \begin_inset CommandInset ref
15307 reference "subsec:Counters"
15311 for details on counters.
15314 \begin_layout Description
15315 \begin_inset Flex Code
15318 \begin_layout Plain Layout
15324 The font used for the label.
15326 \begin_inset CommandInset ref
15328 reference "subsec:Font-description"
15335 \begin_layout Description
15336 \begin_inset Flex Code
15339 \begin_layout Plain Layout
15346 \begin_inset Flex Code
15349 \begin_layout Plain Layout
15355 ] Text that indicates how far a label should be indented.
15358 \begin_layout Description
15359 \begin_inset Flex Code
15362 \begin_layout Plain Layout
15369 \begin_inset Flex Code
15372 \begin_layout Plain Layout
15378 ] Text that indicates the amount of horizontal space between the label and
15380 Only used for labels that are not above the text body.
15383 \begin_layout Description
15384 \begin_inset Flex Code
15387 \begin_layout Plain Layout
15394 \begin_inset Flex Code
15397 \begin_layout Plain Layout
15403 ] The string used for the label.
15405 \begin_inset Flex Code
15408 \begin_layout Plain Layout
15414 is set, this string can be contain the special formatting commands described
15416 \begin_inset CommandInset ref
15418 reference "subsec:Counters"
15425 \begin_layout Description
15426 \begin_inset Flex Code
15429 \begin_layout Plain Layout
15430 LabelStringAppendix
15436 \begin_inset Flex Code
15439 \begin_layout Plain Layout
15445 ] This is used inside the appendix instead of
15446 \begin_inset Newline newline
15450 \begin_inset Flex Code
15453 \begin_layout Plain Layout
15461 \begin_inset Flex Code
15464 \begin_layout Plain Layout
15471 \begin_inset Newline newline
15475 \begin_inset Flex Code
15478 \begin_layout Plain Layout
15479 LabelStringAppendix
15487 \begin_layout Description
15488 \begin_inset Flex Code
15491 \begin_layout Plain Layout
15497 [FIXME] (Used only with XML-type formats.)
15500 \begin_layout Description
15501 \begin_inset Flex Code
15504 \begin_layout Plain Layout
15511 \begin_inset Flex Code
15514 \begin_layout Plain Layout
15519 , Manual, Static, Above,
15520 \begin_inset Newline newline
15523 Centered, Sensitive, Enumerate,
15524 \begin_inset Newline newline
15527 Itemize, Bibliography
15536 \begin_layout Description
15537 \begin_inset Flex Code
15540 \begin_layout Plain Layout
15546 means the label is the very first word (up to the first real blank).
15547 Use protected spaces if you want more than one word as the label.
15551 \begin_layout Description
15552 \begin_inset Flex Code
15555 \begin_layout Plain Layout
15561 means the label is simply what is declared as
15562 \begin_inset Flex Code
15565 \begin_layout Plain Layout
15572 This will be displayed
15573 \begin_inset Quotes eld
15577 \begin_inset Quotes erd
15580 , at the beginning of the paragraph.
15582 \begin_inset Flex Code
15585 \begin_layout Plain Layout
15592 \begin_inset Flex Code
15595 \begin_layout Plain Layout
15601 , then it will be displayed only in the first paragraph of any sequence
15602 of paragraphs with the same
15603 \begin_inset Flex Code
15606 \begin_layout Plain Layout
15615 \begin_layout Description
15616 \begin_inset Flex Code
15619 \begin_layout Plain Layout
15626 \begin_inset space ~
15630 \begin_inset space ~
15634 \begin_inset Flex Code
15637 \begin_layout Plain Layout
15643 are special cases of
15644 \begin_inset Flex Code
15647 \begin_layout Plain Layout
15654 The label will be printed above the paragraph either at the beginning of
15655 the line or centered.
15658 \begin_layout Description
15659 \begin_inset Flex Code
15662 \begin_layout Plain Layout
15668 is a special case for the caption-labels
15669 \begin_inset Quotes eld
15673 \begin_inset Quotes erd
15677 \begin_inset Quotes eld
15681 \begin_inset Quotes erd
15685 \begin_inset Newline newline
15689 \begin_inset Flex Code
15692 \begin_layout Plain Layout
15698 means the (hardcoded) label string depends on the kind of float: It is
15699 hardcoded to be `FloatType N', where N is the value of the counter associated
15701 For the case that a caption is inserted outside of a float the
15702 \begin_inset Flex Code
15705 \begin_layout Plain Layout
15712 \begin_inset Quotes eld
15716 \begin_inset Quotes erd
15722 \begin_layout Description
15723 \begin_inset Flex Code
15726 \begin_layout Plain Layout
15732 produces the usual sort of enumeration labels.
15733 The number type needs to be set in the
15738 \begin_inset CommandInset ref
15740 reference "subsec:Counters"
15747 \begin_layout Description
15748 \begin_inset Flex Code
15751 \begin_layout Plain Layout
15757 produces various bullets at the different levels.
15758 The bullet types displayed can be set via
15759 \begin_inset Flex Noun
15762 \begin_layout Plain Layout
15763 Document\SpecialChar menuseparator
15764 Settings\SpecialChar menuseparator
15773 \begin_layout Description
15774 \begin_inset Flex Code
15777 \begin_layout Plain Layout
15783 should be used only with
15784 \begin_inset Flex Code
15787 \begin_layout Plain Layout
15788 LatexType BibEnvironment
15797 \begin_layout Description
15798 \begin_inset Flex Code
15801 \begin_layout Plain Layout
15807 Note that this will completely override any prior
15808 \begin_inset Flex Code
15811 \begin_layout Plain Layout
15817 declaration for this style.
15819 \begin_inset Quotes eld
15823 \begin_inset Flex Code
15826 \begin_layout Plain Layout
15833 \begin_inset Quotes erd
15838 \begin_inset CommandInset ref
15840 reference "subsec:I18n"
15844 for details on its use.
15847 \begin_layout Description
15848 \begin_inset Flex Code
15851 \begin_layout Plain Layout
15858 \begin_inset Flex Code
15861 \begin_layout Plain Layout
15867 ] The name of the corresponding \SpecialChar LaTeX
15869 Either the environment or command name.
15872 \begin_layout Description
15873 \begin_inset Flex Code
15876 \begin_layout Plain Layout
15883 \begin_inset Flex Code
15886 \begin_layout Plain Layout
15892 ] An optional parameter for the corresponding
15893 \begin_inset Flex Code
15896 \begin_layout Plain Layout
15903 This parameter cannot be changed from within \SpecialChar LyX
15905 \begin_inset Flex Code
15908 \begin_layout Plain Layout
15914 for customizable parameters).
15915 This will be output as is after all \SpecialChar LaTeX
15917 \begin_inset Flex Code
15920 \begin_layout Plain Layout
15929 \begin_layout Description
15930 \begin_inset Flex Code
15933 \begin_layout Plain Layout
15940 \begin_inset Flex Code
15943 \begin_layout Plain Layout
15948 , Command, Environment, Item_Environment,
15949 \begin_inset Newline newline
15952 List_Environment, Bib_Environment
15957 ] How the style should be translated into \SpecialChar LaTeX
15962 \begin_layout Plain Layout
15963 \begin_inset Flex Code
15966 \begin_layout Plain Layout
15972 is perhaps a bit misleading, since these rules apply to SGML classes, too.
15973 Visit the SGML class files for specific examples.
15982 \begin_layout Description
15983 \begin_inset Flex Code
15986 \begin_layout Plain Layout
15992 means nothing special.
15995 \begin_layout Description
15996 \begin_inset Flex Code
15999 \begin_layout Plain Layout
16006 \begin_inset Flex Code
16009 \begin_layout Plain Layout
16016 {\SpecialChar ldots
16025 \begin_layout Description
16026 \begin_inset Flex Code
16029 \begin_layout Plain Layout
16036 \begin_inset Flex Code
16039 \begin_layout Plain Layout
16046 }\SpecialChar ldots
16062 \begin_layout Description
16063 \begin_inset Flex Code
16066 \begin_layout Plain Layout
16073 \begin_inset Flex Code
16076 \begin_layout Plain Layout
16083 \begin_inset Flex Code
16086 \begin_layout Plain Layout
16094 is generated for each paragraph of this environment.
16098 \begin_layout Description
16099 \begin_inset Flex Code
16102 \begin_layout Plain Layout
16109 \begin_inset Flex Code
16112 \begin_layout Plain Layout
16119 \begin_inset Newline newline
16123 \begin_inset Flex Code
16126 \begin_layout Plain Layout
16132 is passed as an argument to the environment.
16133 \begin_inset Newline newline
16137 \begin_inset Flex Code
16140 \begin_layout Plain Layout
16146 can be defined in the
16147 \begin_inset Flex Noun
16150 \begin_layout Plain Layout
16151 Edit\SpecialChar menuseparator
16153 \begin_inset space ~
16164 \begin_layout Description
16165 \begin_inset Flex Code
16168 \begin_layout Plain Layout
16175 \begin_inset Flex Code
16178 \begin_layout Plain Layout
16184 but adds the necessary mandatory argument (the longest label) to the begin
16185 statement of the bibliography environment:
16186 \begin_inset Newline newline
16190 \begin_inset Flex Code
16193 \begin_layout Plain Layout
16196 begin{thebibliography}{99}
16202 It is therefore only useful for bibliography environments.
16203 The default longest label
16204 \begin_inset Quotes eld
16208 \begin_inset Quotes erd
16211 can be changed by the user in the paragraph settings of a bibliography
16215 \begin_layout Standard
16216 Putting the last few things together, the \SpecialChar LaTeX
16217 output will be either:
16220 \begin_layout LyX-Code
16223 LatexName[LatexParam]{\SpecialChar ldots
16227 \begin_layout Standard
16231 \begin_layout LyX-Code
16234 begin{LatexName}[LatexParam] \SpecialChar ldots
16240 \begin_layout Standard
16241 depending upon the \SpecialChar LaTeX
16246 \begin_layout Description
16247 \begin_inset Flex Code
16250 \begin_layout Plain Layout
16257 \begin_inset Flex Code
16260 \begin_layout Plain Layout
16266 ] A string that is put at the beginning of the style content.
16267 A line break in the output can be indicated by
16268 \begin_inset Flex Code
16271 \begin_layout Plain Layout
16280 \begin_layout Description
16281 \begin_inset Flex Code
16284 \begin_layout Plain Layout
16291 \begin_inset Flex Code
16294 \begin_layout Plain Layout
16300 ] If you put styles into environments, the different
16301 \begin_inset Flex Code
16304 \begin_layout Plain Layout
16310 are not simply added, but added with a factor
16311 \begin_inset Formula $\frac{4}{\mathrm{depth}+4}$
16315 Note that this parameter is also used when
16316 \begin_inset Flex Code
16319 \begin_layout Plain Layout
16326 \begin_inset Flex Code
16329 \begin_layout Plain Layout
16336 \begin_inset Flex Code
16339 \begin_layout Plain Layout
16346 Then it is added to the manual or dynamic margin.
16347 \begin_inset Newline newline
16351 \begin_inset Quotes eld
16355 \begin_inset Flex Code
16358 \begin_layout Plain Layout
16365 \begin_inset Quotes erd
16368 means that the paragraph is indented with the width of
16369 \begin_inset Quotes eld
16373 \begin_inset Flex Code
16376 \begin_layout Plain Layout
16383 \begin_inset Quotes erd
16386 in the normal font.
16387 You can get a negative width by prefixing the string with
16388 \begin_inset Quotes eld
16392 \begin_inset Flex Code
16395 \begin_layout Plain Layout
16402 \begin_inset Quotes erd
16406 This way was chosen so that the look is the same with each used screen
16410 \begin_layout Description
16411 \begin_inset Flex Code
16414 \begin_layout Plain Layout
16421 \begin_inset Flex Code
16424 \begin_layout Plain Layout
16429 , Manual, Dynamic, First_Dynamic, Right_Address_Box
16435 \begin_inset Newline newline
16438 The kind of margin that the style has on the left side.
16442 \begin_layout Description
16443 \begin_inset Flex Code
16446 \begin_layout Plain Layout
16452 just means a fixed margin.
16455 \begin_layout Description
16456 \begin_inset Flex Code
16459 \begin_layout Plain Layout
16465 means that the left margin depends on the string entered in the
16466 \begin_inset Flex Noun
16469 \begin_layout Plain Layout
16470 Edit\SpecialChar menuseparator
16472 \begin_inset space ~
16481 This is used to typeset nice lists without tabulators.
16484 \begin_layout Description
16485 \begin_inset Flex Code
16488 \begin_layout Plain Layout
16494 means that the margin depends on the size of the label.
16495 This is used for automatic enumerated headlines.
16496 It is obvious that the headline
16497 \begin_inset Quotes eld
16500 5.4.3.2.1 Very long headline
16501 \begin_inset Quotes erd
16504 must have a wider left margin (as wide as
16505 \begin_inset Quotes eld
16509 \begin_inset Quotes erd
16512 plus the space) than
16513 \begin_inset Quotes eld
16516 3.2 Very long headline
16517 \begin_inset Quotes erd
16521 \begin_inset Quotes eld
16525 \begin_inset Quotes erd
16528 are not able to do this.
16531 \begin_layout Description
16532 \begin_inset Flex Code
16535 \begin_layout Plain Layout
16541 is similar, but only the very first row of the paragraph is dynamic, while
16542 the others are static; this is used, for example, for descriptions.
16545 \begin_layout Description
16546 \begin_inset Flex Code
16549 \begin_layout Plain Layout
16555 means the margin is chosen in a way that the longest row of this paragraph
16556 fits to the right margin.
16557 This is used to typeset an address on the right edge of the page.
16561 \begin_layout Description
16562 \begin_inset Flex Code
16565 \begin_layout Plain Layout
16572 \begin_inset Flex Code
16575 \begin_layout Plain Layout
16584 \begin_inset space \thinspace{}
16588 \begin_inset Flex Code
16591 \begin_layout Plain Layout
16597 ] Whether fragile commands in this style should be
16598 \begin_inset Flex Code
16601 \begin_layout Plain Layout
16614 whether this command should itself be protected.)
16615 \change_inserted -712698321 1523696949
16619 \begin_layout Description
16621 \change_inserted -712698321 1552395557
16622 \begin_inset Flex Code
16625 \begin_layout Plain Layout
16627 \change_inserted -712698321 1523696950
16636 \begin_inset Flex Code
16639 \begin_layout Plain Layout
16641 \change_inserted -712698321 1523696950
16652 \begin_inset space \thinspace{}
16656 \begin_inset Flex Code
16659 \begin_layout Plain Layout
16661 \change_inserted -712698321 1523696950
16669 ] This causes macros that contain this layout to be protected with
16670 \begin_inset Flex Code
16673 \begin_layout Plain Layout
16675 \change_inserted -712698321 1523696950
16690 ) if necessary and thus allows (some) verbatim stuff in macros.
16693 \begin_layout Description
16695 \change_inserted -712698321 1552395844
16696 \begin_inset Flex Code
16699 \begin_layout Plain Layout
16701 \change_inserted -712698321 1552395561
16710 \begin_inset Flex Code
16713 \begin_layout Plain Layout
16715 \change_inserted -712698321 1552395557
16726 \begin_inset space \thinspace{}
16730 \begin_inset Flex Code
16733 \begin_layout Plain Layout
16735 \change_inserted -712698321 1552395557
16743 ] Whether specific commands in this style (such as
16744 \begin_inset Flex Code
16747 \begin_layout Plain Layout
16749 \change_inserted -712698321 1552395655
16760 \begin_inset Flex Code
16763 \begin_layout Plain Layout
16765 \change_inserted -712698321 1552395661
16775 ) should be protected in an
16776 \begin_inset Flex Code
16779 \begin_layout Plain Layout
16781 \change_inserted -712698321 1552395631
16792 This is particularly needed for styles that draw on
16800 commands which parse their content in complex ways.
16805 \begin_layout Description
16806 \begin_inset Flex Code
16809 \begin_layout Plain Layout
16816 \begin_inset Flex Code
16819 \begin_layout Plain Layout
16826 \begin_inset space \thinspace{}
16830 \begin_inset Flex Code
16833 \begin_layout Plain Layout
16841 ] Whether newlines are translated into \SpecialChar LaTeX
16843 \begin_inset Flex Code
16846 \begin_layout Plain Layout
16857 The translation can be switched off to allow more comfortable \SpecialChar LaTeX
16859 inside \SpecialChar LyX
16863 \begin_layout Description
16864 \begin_inset Flex Code
16867 \begin_layout Plain Layout
16874 \begin_inset Flex Code
16877 \begin_layout Plain Layout
16886 \begin_inset space \thinspace{}
16890 \begin_inset Flex Code
16893 \begin_layout Plain Layout
16899 ] If set to true, and if
16900 \begin_inset Flex Code
16903 \begin_layout Plain Layout
16910 \begin_inset Flex Code
16913 \begin_layout Plain Layout
16919 ) paragraphs are being indented, then the indentation of such a paragraph
16920 following one of this type will be suppressed.
16921 (So this will not affect the display of non-default paragraphs.)
16924 \begin_layout Description
16925 \begin_inset Flex Code
16928 \begin_layout Plain Layout
16935 \begin_inset Flex Code
16938 \begin_layout Plain Layout
16944 ] Name of a style that has replaced this style.
16945 This is used to rename a style, while keeping backward compatibility.
16948 \begin_layout Description
16949 \begin_inset Flex Code
16952 \begin_layout Plain Layout
16959 \begin_inset Flex Code
16962 \begin_layout Plain Layout
16969 \begin_inset space \thinspace{}
16973 \begin_inset Flex Code
16976 \begin_layout Plain Layout
16982 ] Determines whether consecutive paragraphs of the same type are treated
16983 as belonging together.
16984 This has the effect that the
16985 \begin_inset Flex Code
16988 \begin_layout Plain Layout
16994 is only printed once before such a group.
16995 By default, this is true for
16996 \begin_inset Flex Code
16999 \begin_layout Plain Layout
17006 \begin_inset Flex Code
17009 \begin_layout Plain Layout
17016 \begin_inset Flex Code
17019 \begin_layout Plain Layout
17025 and false for all other types.
17028 \begin_layout Description
17029 \begin_inset Flex Code
17032 \begin_layout Plain Layout
17039 \begin_inset Flex Code
17042 \begin_layout Plain Layout
17051 \begin_inset space \thinspace{}
17055 \begin_inset Flex Code
17058 \begin_layout Plain Layout
17064 ] Indicates that paragraphs will not be separated by an empty line in \SpecialChar LaTeX
17066 but only by a line break; together with
17067 \begin_inset Flex Code
17070 \begin_layout Plain Layout
17076 , this allows to emulate a plain text editor (like the ERT inset).
17079 \begin_layout Description
17080 \begin_inset Flex Code
17083 \begin_layout Plain Layout
17090 \begin_inset Flex Code
17093 \begin_layout Plain Layout
17099 ] The indent of the very first line of a paragraph.
17101 \begin_inset Newline newline
17105 \begin_inset Flex Code
17108 \begin_layout Plain Layout
17114 will be fixed for a certain style.
17115 The exception is the default style, since the indentation for these paragraphs
17116 can be prohibited with
17117 \begin_inset Flex Code
17120 \begin_layout Plain Layout
17128 \begin_inset Flex Code
17131 \begin_layout Plain Layout
17137 style paragraphs inside environments use the
17138 \begin_inset Flex Code
17141 \begin_layout Plain Layout
17147 of the environment, not their native one.
17149 \begin_inset Flex Code
17152 \begin_layout Plain Layout
17158 paragraphs inside an enumeration are not indented.
17161 \begin_layout Description
17162 \begin_inset Flex Code
17165 \begin_layout Plain Layout
17172 \begin_inset Flex Code
17175 \begin_layout Plain Layout
17181 ] The vertical space between two paragraphs of this style.
17184 \begin_layout Description
17185 \begin_inset Flex Code
17188 \begin_layout Plain Layout
17195 \begin_inset Flex Code
17198 \begin_layout Plain Layout
17205 allows the user to choose either
17206 \begin_inset Quotes eld
17210 \begin_inset Quotes erd
17214 \begin_inset Quotes eld
17218 \begin_inset Quotes erd
17221 to separate paragraphs.
17223 \begin_inset Quotes eld
17227 \begin_inset Quotes erd
17231 \begin_inset Flex Code
17234 \begin_layout Plain Layout
17242 \begin_inset Quotes eld
17246 \begin_inset Quotes erd
17250 \begin_inset Flex Code
17253 \begin_layout Plain Layout
17259 is ignored and all paragraphs are separated by the
17260 \begin_inset Flex Code
17263 \begin_layout Plain Layout
17270 The vertical space is calculated with
17271 \begin_inset Flex Code
17274 \begin_layout Plain Layout
17276 \begin_inset space ~
17285 \begin_inset Flex Code
17288 \begin_layout Plain Layout
17294 is the height of a row with the normal font.
17295 This way, the look stays the same with different screen fonts.
17298 \begin_layout Description
17299 \begin_inset Flex Code
17302 \begin_layout Plain Layout
17309 \begin_inset Flex Code
17312 \begin_layout Plain Layout
17321 \begin_inset space \thinspace{}
17325 \begin_inset Flex Code
17328 \begin_layout Plain Layout
17334 ] Whether the contents of this paragraph should be output in raw form, meaning
17335 without special translations that \SpecialChar LaTeX
17339 \begin_layout Description
17340 \begin_inset Flex Code
17343 \begin_layout Plain Layout
17350 \begin_inset Flex Code
17353 \begin_layout Plain Layout
17363 Defines individual characters that should be output in raw form, meaning
17364 without special translations that \SpecialChar LaTeX
17368 \begin_layout Description
17369 \begin_inset Flex Code
17372 \begin_layout Plain Layout
17378 Information to be included in the \SpecialChar LaTeX
17379 preamble when this style is used.
17380 Used to define macros, load packages, etc., required by this particular
17383 \begin_inset Quotes eld
17387 \begin_inset Flex Code
17390 \begin_layout Plain Layout
17397 \begin_inset Quotes erd
17403 \begin_layout Description
17404 \begin_inset Flex Code
17407 \begin_layout Plain Layout
17414 \begin_inset Flex Code
17417 \begin_layout Plain Layout
17423 ] The prefix to use when creating labels referring to paragraphs of this
17425 This allows the use of formatted references.
17428 \begin_layout Description
17429 \begin_inset Flex Code
17432 \begin_layout Plain Layout
17439 \begin_inset Flex Code
17442 \begin_layout Plain Layout
17448 ] Whether the style requires the feature
17449 \begin_inset Flex Code
17452 \begin_layout Plain Layout
17459 \begin_inset CommandInset ref
17461 reference "chap:List-of-functions"
17465 for the list of features).
17466 If you require a package with specific options, you can additionally use
17468 \begin_inset Flex Code
17471 \begin_layout Plain Layout
17477 as a general text class parameter (see
17478 \begin_inset CommandInset ref
17480 reference "subsec:General-text-class"
17487 \begin_layout Description
17488 \begin_inset Flex Code
17491 \begin_layout Plain Layout
17498 \begin_inset Flex Code
17501 \begin_layout Plain Layout
17510 \begin_inset Flex Code
17513 \begin_layout Plain Layout
17519 ] Resets the \SpecialChar LaTeX
17520 arguments of this style (as defined via the
17521 \begin_inset Flex Code
17524 \begin_layout Plain Layout
17531 This is useful if you have copied a style via
17532 \begin_inset Flex Code
17535 \begin_layout Plain Layout
17541 , but you do not want to inherit its (required and optional) arguments.
17544 \begin_layout Description
17545 \begin_inset Flex Code
17548 \begin_layout Plain Layout
17555 \begin_inset Flex Code
17558 \begin_layout Plain Layout
17567 \begin_inset Flex Code
17570 \begin_layout Plain Layout
17576 ] Resumes a counter that is usually reset at each new sequence of layouts.
17577 This is currently only useful when
17578 \begin_inset Flex Code
17581 \begin_layout Plain Layout
17588 \begin_inset Flex Code
17591 \begin_layout Plain Layout
17600 \begin_layout Description
17601 \begin_inset Flex Code
17604 \begin_layout Plain Layout
17611 \begin_inset Flex Code
17614 \begin_layout Plain Layout
17620 ] A string that is put at the end of the layout content.
17621 A line break in the output can be indicated by
17622 \begin_inset Flex Code
17625 \begin_layout Plain Layout
17634 \begin_layout Description
17635 \begin_inset Flex Code
17638 \begin_layout Plain Layout
17645 \begin_inset Flex Code
17648 \begin_layout Plain Layout
17655 \begin_inset Flex Code
17658 \begin_layout Plain Layout
17667 \begin_layout Description
17668 \begin_inset Flex Code
17671 \begin_layout Plain Layout
17678 \begin_inset Flex Code
17681 \begin_layout Plain Layout
17690 \begin_inset Flex Code
17693 \begin_layout Plain Layout
17700 \begin_inset Flex Code
17703 \begin_layout Plain Layout
17710 \begin_inset Flex Code
17713 \begin_layout Plain Layout
17715 \begin_inset space ~
17723 ] This defines what the default spacing should be in the style.
17725 \begin_inset Flex Code
17728 \begin_layout Plain Layout
17735 \begin_inset Flex Code
17738 \begin_layout Plain Layout
17745 \begin_inset Flex Code
17748 \begin_layout Plain Layout
17754 correspond respectively to a multiplier value of 1, 1.25 and 1.667.
17755 If you specify the argument
17756 \begin_inset Flex Code
17759 \begin_layout Plain Layout
17765 , then you must also provide a value argument which will be the actual multiplie
17767 Note that, contrary to other parameters,
17768 \begin_inset Flex Code
17771 \begin_layout Plain Layout
17777 implies the generation of specific \SpecialChar LaTeX
17778 code, using the \SpecialChar LaTeX
17782 \begin_inset Flex Code
17785 \begin_layout Plain Layout
17794 \begin_layout Description
17795 \begin_inset Flex Code
17798 \begin_layout Plain Layout
17805 \begin_inset Flex Code
17808 \begin_layout Plain Layout
17815 \begin_inset space \thinspace{}
17819 \begin_inset Flex Code
17822 \begin_layout Plain Layout
17830 ] Allow spell-checking paragraphs of this style.
17834 \begin_layout Description
17835 \begin_inset Flex Code
17838 \begin_layout Plain Layout
17840 \change_deleted 731793113 1604355211
17842 \change_inserted 731793113 1604355212
17851 \begin_inset Flex Code
17854 \begin_layout Plain Layout
17863 \begin_inset Flex Code
17866 \begin_layout Plain Layout
17873 \change_deleted 731793113 1604355214
17875 \change_inserted 731793113 1604355216
17878 counter of a given counter at the beginning of a new sequence of layouts.
17879 This is currently only useful when
17880 \begin_inset Flex Code
17883 \begin_layout Plain Layout
17890 \begin_inset Flex Code
17893 \begin_layout Plain Layout
17902 \begin_layout Description
17903 \begin_inset Flex Code
17906 \begin_layout Plain Layout
17912 The font used for the text body .
17914 \begin_inset CommandInset ref
17916 reference "subsec:Font-description"
17923 \begin_layout Description
17924 \begin_inset Flex Code
17927 \begin_layout Plain Layout
17936 \begin_inset Flex Code
17939 \begin_layout Plain Layout
17949 The level of the style in the table of contents.
17950 This is used for automatic numbering of section headings.
17953 \begin_layout Description
17954 \begin_inset Flex Code
17957 \begin_layout Plain Layout
17966 \begin_inset Flex Code
17969 \begin_layout Plain Layout
17980 \begin_inset Flex Code
17983 \begin_layout Plain Layout
17990 \begin_inset Flex Code
17993 \begin_layout Plain Layout
17999 ] This tag determines whether the first line indentation of this paragraph
18000 can be toggled via the Paragraph settings dialog.
18004 \begin_inset Flex Code
18007 \begin_layout Plain Layout
18017 is set, indentation can be toggled if the document settings use
18018 \begin_inset Quotes eld
18022 \begin_inset Quotes erd
18025 paragraph style, with
18026 \begin_inset Flex Code
18029 \begin_layout Plain Layout
18035 , indentation can always be toggled, notwithstanding the document settings,
18037 \begin_inset Flex Code
18040 \begin_layout Plain Layout
18046 , indentation can never be toggled.
18049 \begin_layout Description
18050 \begin_inset Flex Code
18053 \begin_layout Plain Layout
18060 \begin_inset Flex Code
18063 \begin_layout Plain Layout
18069 ] The vertical space with which the very first of a chain of paragraphs
18070 with this style is separated from the previous paragraph.
18071 If the previous paragraph has another style, the separations are not simply
18072 added, but the maximum is taken.
18075 \begin_layout Subsection
18076 \begin_inset CommandInset label
18082 Internationalization of Paragraph Styles
18085 \begin_layout Standard
18087 has long supported internationalization of layout information, but, until
18088 version 2.0, this applied only to the user interface and not to, say, PDF
18090 Thus, French authors were forced to resort to ugly hacks if they wanted
18095 1' instead of `Theorem 1'.
18096 Thanks to Georg Baum, that is no longer the case.
18099 \begin_layout Standard
18101 \begin_inset Flex Code
18104 \begin_layout Plain Layout
18110 defines text that is to appear in the typeset document, it may use
18111 \begin_inset Flex Code
18114 \begin_layout Plain Layout
18121 \begin_inset Flex Code
18124 \begin_layout Plain Layout
18130 to support non-English and even multi-language documents correctly.
18131 The following excerpt (from the
18132 \begin_inset Flex Code
18135 \begin_layout Plain Layout
18141 file) shows how this works:
18144 \begin_layout LyX-Code
18149 \begin_layout LyX-Code
18152 theoremstyle{remark}
18155 \begin_layout LyX-Code
18158 newtheorem{claim}[thm]{
18165 \begin_layout LyX-Code
18169 \begin_layout LyX-Code
18173 \begin_layout LyX-Code
18178 claimname}{_(Claim)}
18181 \begin_layout LyX-Code
18185 \begin_layout LyX-Code
18189 \begin_layout LyX-Code
18198 claimname}{_(Claim)}}
18201 \begin_layout LyX-Code
18206 \begin_layout Standard
18207 In principle, any legal \SpecialChar LaTeX
18209 \begin_inset Flex Code
18212 \begin_layout Plain Layout
18219 \begin_inset Flex Code
18222 \begin_layout Plain Layout
18228 tags, but in practice they will typically look as they do here.
18229 The key to correct translation of the typeset text is the definition of
18230 the \SpecialChar LaTeX
18232 \begin_inset Flex Code
18235 \begin_layout Plain Layout
18244 \begin_inset Flex Code
18247 \begin_layout Plain Layout
18259 \begin_layout Standard
18261 \begin_inset Flex Code
18264 \begin_layout Plain Layout
18270 tag provides for internationalization based upon the overall language of
18272 The contents of the tag will be included in the preamble, just as with
18274 \begin_inset Flex Code
18277 \begin_layout Plain Layout
18284 What makes it special is the use of the
18285 \begin_inset Quotes eld
18289 \begin_inset Quotes erd
18293 \begin_inset Flex Code
18296 \begin_layout Plain Layout
18302 , which will be replaced, when \SpecialChar LyX
18303 produces \SpecialChar LaTeX
18304 output, with the translation of
18305 its argument into the document language.
18308 \begin_layout Standard
18310 \begin_inset Flex Code
18313 \begin_layout Plain Layout
18319 tag is more complex, since it is meant to provide support for multi-language
18320 documents and so offers an interface to the
18321 \begin_inset Flex Code
18324 \begin_layout Plain Layout
18331 Its contents will be added to the preamble once for each language that
18332 appears in the document.
18333 In this case, the argument to
18334 \begin_inset Flex Code
18337 \begin_layout Plain Layout
18343 will be replaced with its translation into the language in question; the
18345 \begin_inset Flex Code
18348 \begin_layout Plain Layout
18354 is replaced by the language name (as used by the babel package).
18357 \begin_layout Standard
18358 A German document that also included a French section would thus have the
18359 following in the preamble:
18362 \begin_layout LyX-Code
18371 claimname}{Affirmation}}
18372 \begin_inset Newline newline
18383 claimname}{Behauptung}}
18384 \begin_inset Newline newline
18391 claimname}{Behauptung}
18394 \begin_layout Standard
18397 \begin_inset Flex Code
18400 \begin_layout Plain Layout
18406 will then conspire to produce the correct text in the output.
18409 \begin_layout Standard
18410 One important point to note here is that the translations are provided by
18412 itself, through the file
18413 \begin_inset Flex Code
18416 \begin_layout Plain Layout
18423 This means, in effect, that
18424 \begin_inset Flex Code
18427 \begin_layout Plain Layout
18434 \begin_inset Flex Code
18437 \begin_layout Plain Layout
18443 are really only of use in layout files that are provided with \SpecialChar LyX
18445 entered in user-created layout files will not be seen by \SpecialChar LyX
18446 's internationalizatio
18447 n routines unless the
18448 \begin_inset Flex Code
18451 \begin_layout Plain Layout
18457 file is modified accordingly.
18458 That said, however, any layout created with the intention that it will
18459 be included with \SpecialChar LyX
18460 should use these tags where appropriate.
18461 Please note that the paragraph style translations provided by \SpecialChar LyX
18463 change with a minor update (e.
18464 \begin_inset space \thinspace{}
18468 \begin_inset space \space{}
18471 from version 2.1.x to 2.1.y).
18472 It is however quite likely that a major update (e.
18473 \begin_inset space \thinspace{}
18477 \begin_inset space \space{}
18480 from 2.0.x to 2.1.0) will introduce new translations or corrections.
18483 \begin_layout Subsection
18485 \begin_inset CommandInset label
18487 name "subsec:Floats"
18494 \begin_layout Standard
18495 It is necessary to define the floats (
18496 \begin_inset Flex Noun
18499 \begin_layout Plain Layout
18506 \begin_inset Flex Noun
18509 \begin_layout Plain Layout
18515 , \SpecialChar ldots
18516 ) in the text class itself.
18517 Standard floats are included in the file
18518 \begin_inset Flex Code
18521 \begin_layout Plain Layout
18527 , so you may have to do no more than add
18530 \begin_layout LyX-Code
18531 Input stdfloats.inc
18534 \begin_layout Standard
18535 to your layout file.
18536 If you want to implement a text class that proposes some other float types
18537 (like the AGU class bundled with \SpecialChar LyX
18538 ), the information below will hopefully
18542 \begin_layout Description
18543 \begin_inset Flex Code
18546 \begin_layout Plain Layout
18553 \begin_inset Flex Code
18556 \begin_layout Plain Layout
18562 =!htbpH] Allowed placement options for this float type.
18563 The value is a string of placement characters.
18564 Possible characters include:
18569 \begin_inset Quotes eld
18573 \begin_inset Quotes erd
18581 \begin_inset Quotes eld
18585 \begin_inset Quotes erd
18593 \begin_inset Quotes eld
18597 \begin_inset Quotes erd
18605 \begin_inset Quotes eld
18609 \begin_inset Quotes erd
18617 \begin_inset Quotes eld
18621 \begin_inset Quotes erd
18629 \begin_inset Quotes eld
18633 \begin_inset Quotes erd
18637 The order of the characters in the string does not matter.
18638 If no placement options are allowed, use the string
18645 \begin_layout Description
18646 \begin_inset Flex Code
18649 \begin_layout Plain Layout
18656 \begin_inset Flex Code
18659 \begin_layout Plain Layout
18668 \begin_inset space \thinspace{}
18674 \begin_inset Flex Code
18677 \begin_layout Plain Layout
18687 ] Defines whether the float allows to be rotated via the \SpecialChar LaTeX
18694 \begin_inset Flex Code
18697 \begin_layout Plain Layout
18703 if the float does not support this feature.
18706 \begin_layout Description
18707 \begin_inset Flex Code
18710 \begin_layout Plain Layout
18717 \begin_inset Flex Code
18720 \begin_layout Plain Layout
18729 \begin_inset space \thinspace{}
18735 \begin_inset Flex Code
18738 \begin_layout Plain Layout
18748 ] Defines whether the float has a starred variant that spans columns in
18749 a two column paragraph.
18751 \begin_inset Flex Code
18754 \begin_layout Plain Layout
18760 if the float does not support this feature.
18763 \begin_layout Description
18764 \begin_inset Flex Code
18767 \begin_layout Plain Layout
18774 \begin_inset Flex Code
18777 \begin_layout Plain Layout
18784 \begin_inset Quotes erd
18788 \begin_inset Quotes erd
18791 ] The file name extension of an auxiliary file for the list of figures (or
18794 writes the captions to this file.
18797 \begin_layout Description
18798 \begin_inset Flex Code
18801 \begin_layout Plain Layout
18808 \begin_inset Flex Code
18811 \begin_layout Plain Layout
18818 \begin_inset Quotes erd
18822 \begin_inset Quotes erd
18825 ] The string that will be used in the menus and also for the caption.
18826 This is translated to the current language if babel is used.
18829 \begin_layout Description
18830 \begin_inset Flex Code
18833 \begin_layout Plain Layout
18839 These tags control the XHTML output.
18841 \begin_inset CommandInset ref
18843 reference "sec:Tags-for-XHTML"
18850 \begin_layout Description
18851 \begin_inset Flex Code
18854 \begin_layout Plain Layout
18863 \begin_inset Flex Code
18866 \begin_layout Plain Layout
18875 \begin_inset space \thinspace{}
18879 \begin_inset Flex Code
18882 \begin_layout Plain Layout
18888 ] Indicates whether the float is already defined in the document class or
18889 if instead the \SpecialChar LaTeX
18891 \begin_inset Flex Code
18894 \begin_layout Plain Layout
18900 needs to be loaded to define it on-the-fly.
18902 \begin_inset Flex Code
18905 \begin_layout Plain Layout
18912 \begin_inset Flex Code
18915 \begin_layout Plain Layout
18922 It should be set to
18923 \begin_inset Flex Code
18926 \begin_layout Plain Layout
18932 if the float is already defined by the \SpecialChar LaTeX
18936 \begin_layout Description
18937 \begin_inset Flex Code
18940 \begin_layout Plain Layout
18947 \begin_inset Flex Code
18950 \begin_layout Plain Layout
18957 \begin_inset Quotes erd
18961 \begin_inset Quotes erd
18964 ] The command used to generate a list of floats of this type; the leading
18973 \begin_inset Flex Code
18976 \begin_layout Plain Layout
18982 is false, since there is no standard way to generate this command.
18984 \begin_inset Flex Code
18987 \begin_layout Plain Layout
18993 is true, since in that case there is a standard way to define the command.
18996 \begin_layout Description
18997 \begin_inset Flex Code
19000 \begin_layout Plain Layout
19007 \begin_inset Flex Code
19010 \begin_layout Plain Layout
19017 \begin_inset Quotes erd
19021 \begin_inset Quotes erd
19024 ] A title for a list of floats of this kind (list of figures, tables, or
19026 It is used for the screen label within \SpecialChar LyX
19027 , it is used by \SpecialChar LaTeX
19029 it is used as the title in the XHTML output.
19030 It will be translated to the document language.
19033 \begin_layout Description
19034 \begin_inset Flex Code
19037 \begin_layout Plain Layout
19044 \begin_inset Flex Code
19047 \begin_layout Plain Layout
19054 \begin_inset Quotes erd
19058 \begin_inset Quotes erd
19061 ] This (optional) argument determines whether floats of this class will
19062 be numbered within some sectional unit of the document.
19064 \begin_inset Flex Code
19067 \begin_layout Plain Layout
19074 \begin_inset Quotes eld
19078 \begin_inset Flex Code
19081 \begin_layout Plain Layout
19088 \begin_inset Quotes erd
19091 , the floats will be numbered within chapters.
19095 \begin_layout Description
19096 \begin_inset Flex Code
19099 \begin_layout Plain Layout
19106 \begin_inset Flex Code
19109 \begin_layout Plain Layout
19116 \begin_inset Quotes erd
19120 \begin_inset Quotes erd
19123 ] The default placement for the given class of floats.
19124 The string should be as in standard \SpecialChar LaTeX
19126 \begin_inset Flex Code
19129 \begin_layout Plain Layout
19136 \begin_inset Flex Code
19139 \begin_layout Plain Layout
19146 \begin_inset Flex Code
19149 \begin_layout Plain Layout
19156 \begin_inset Flex Code
19159 \begin_layout Plain Layout
19165 for top, bottom, page, and here, respectively.
19169 \begin_layout Plain Layout
19170 Note that the order of these letters in the string is irrelevant, like in
19177 On top of that there is a new type,
19178 \begin_inset Flex Code
19181 \begin_layout Plain Layout
19187 , which does not really correspond to a float, since it means: put it
19188 \begin_inset Quotes eld
19192 \begin_inset Quotes erd
19196 Note however that the
19197 \begin_inset Flex Code
19200 \begin_layout Plain Layout
19206 specifier is special and, because of implementation details, cannot be
19207 used in non-built in float types.
19208 If you do not understand what this means, just use
19209 \begin_inset Quotes eld
19213 \begin_inset Flex Code
19216 \begin_layout Plain Layout
19223 \begin_inset Quotes erd
19229 \begin_layout Description
19230 \begin_inset Flex Code
19233 \begin_layout Plain Layout
19240 \begin_inset Flex Code
19243 \begin_layout Plain Layout
19249 ] The prefix to use when creating labels referring to floats of this type.
19250 This allows the use of formatted references.
19251 Note that you can remove any
19252 \begin_inset Flex Code
19255 \begin_layout Plain Layout
19261 set by a copied style by using the special value
19262 \begin_inset Quotes eld
19266 \begin_inset Quotes erd
19269 , which must be all caps.
19270 \change_inserted -712698321 1565605014
19274 \begin_layout Description
19276 \change_inserted -712698321 1565605014
19277 \begin_inset Flex Code
19280 \begin_layout Plain Layout
19282 \change_inserted -712698321 1565605014
19291 \begin_inset Flex Code
19294 \begin_layout Plain Layout
19296 \change_inserted -712698321 1565605014
19304 ] As with paragraph styles, see
19305 \begin_inset CommandInset ref
19307 reference "subsec:Paragraph-Styles"
19316 \begin_layout Description
19317 \begin_inset Flex Code
19320 \begin_layout Plain Layout
19327 \begin_inset Flex Code
19330 \begin_layout Plain Layout
19337 \begin_inset Quotes erd
19341 \begin_inset Quotes erd
19344 ] The style used when defining the float using
19345 \begin_inset Flex Code
19348 \begin_layout Plain Layout
19359 \begin_layout Description
19360 \begin_inset Flex Code
19363 \begin_layout Plain Layout
19370 \begin_inset Flex Code
19373 \begin_layout Plain Layout
19380 \begin_inset Quotes erd
19384 \begin_inset Quotes erd
19388 \begin_inset Quotes eld
19392 \begin_inset Quotes erd
19395 of the new class of floats, like program or algorithm.
19396 After the appropriate
19397 \begin_inset Flex Code
19400 \begin_layout Plain Layout
19409 \begin_inset Flex Code
19412 \begin_layout Plain Layout
19421 \begin_inset Flex Code
19424 \begin_layout Plain Layout
19435 \begin_layout Description
19436 \begin_inset Flex Code
19439 \begin_layout Plain Layout
19446 \begin_inset Flex Code
19449 \begin_layout Plain Layout
19456 \begin_inset space \thinspace{}
19460 \begin_inset Flex Code
19463 \begin_layout Plain Layout
19471 ] Specifies whether this float is defined using the \SpecialChar LaTeX
19473 \begin_inset Flex Code
19476 \begin_layout Plain Layout
19482 , either by the class file, another package or on-the-fly by \SpecialChar LyX
19486 \begin_layout Standard
19487 Note that defining a float with type
19488 \begin_inset Flex Code
19491 \begin_layout Plain Layout
19499 automatically defines the corresponding counter with name
19500 \begin_inset Flex Code
19503 \begin_layout Plain Layout
19514 \begin_layout Subsection
19515 Flex insets and InsetLayout
19516 \begin_inset CommandInset label
19518 name "subsec:Flex-insets-and"
19525 \begin_layout Standard
19526 Flex insets come in
19527 \change_deleted 5863208 1594239511
19529 \change_inserted 5863208 1594239512
19535 \begin_layout Itemize
19537 \begin_inset Flex Code
19540 \begin_layout Plain Layout
19546 ): These define semantic markup corresponding to such \SpecialChar LaTeX
19548 \begin_inset Flex Code
19551 \begin_layout Plain Layout
19560 \begin_inset Flex Code
19563 \begin_layout Plain Layout
19574 \begin_layout Itemize
19576 \begin_inset Flex Code
19579 \begin_layout Plain Layout
19585 ): These can be used to define custom collapsible insets, similar to \SpecialChar TeX
19587 footnote, and the like.
19588 An obvious example is an endnote inset, which is defined in the
19589 \begin_inset Flex Code
19592 \begin_layout Plain Layout
19601 \begin_layout Itemize
19603 \change_deleted 5863208 1594239528
19605 \begin_inset Flex Code
19608 \begin_layout Plain Layout
19614 ): For use with DocBook classes.
19619 \begin_layout Standard
19620 Flex insets are defined using the
19621 \begin_inset Flex Code
19624 \begin_layout Plain Layout
19630 tag, which shall be explained in a moment.
19633 \begin_layout Standard
19635 \begin_inset Flex Code
19638 \begin_layout Plain Layout
19644 tag also serves another function: It can be used to customize the general
19645 layout of many different types of insets.
19647 \begin_inset Flex Code
19650 \begin_layout Plain Layout
19656 can be used to customize the layout parameters for footnotes, marginal
19657 notes, note insets, \SpecialChar TeX
19658 code (ERT) insets, branches, listings, indexes, boxes,
19659 tables, algorithms, URLs, and captions, as well as to define Flex insets.
19662 \begin_layout Standard
19664 \begin_inset Flex Code
19667 \begin_layout Plain Layout
19673 definition must begin with a line of the form:
19676 \begin_layout LyX-Code
19680 \begin_layout Standard
19682 \begin_inset Flex Code
19685 \begin_layout Plain Layout
19691 indicates the inset whose layout is being defined, and here there are four
19695 \begin_layout Enumerate
19696 The layout for a pre-existing inset is being modified.
19697 In this case, can be
19698 \begin_inset Flex Code
19701 \begin_layout Plain Layout
19707 any one of the following:
19708 \begin_inset Flex Code
19711 \begin_layout Plain Layout
19718 \begin_inset Flex Code
19721 \begin_layout Plain Layout
19728 \begin_inset Flex Code
19731 \begin_layout Plain Layout
19738 \begin_inset Flex Code
19741 \begin_layout Plain Layout
19748 \begin_inset Flex Code
19751 \begin_layout Plain Layout
19758 \begin_inset Flex Code
19761 \begin_layout Plain Layout
19768 \begin_inset Flex Code
19771 \begin_layout Plain Layout
19778 \begin_inset Flex Code
19781 \begin_layout Plain Layout
19788 \begin_inset Flex Code
19791 \begin_layout Plain Layout
19798 \begin_inset Flex Code
19801 \begin_layout Plain Layout
19808 \begin_inset Flex Code
19811 \begin_layout Plain Layout
19818 \begin_inset Flex Code
19821 \begin_layout Plain Layout
19828 \begin_inset Flex Code
19831 \begin_layout Plain Layout
19838 \begin_inset Flex Code
19841 \begin_layout Plain Layout
19848 \begin_inset Flex Code
19851 \begin_layout Plain Layout
19858 \begin_inset Flex Code
19861 \begin_layout Plain Layout
19868 \begin_inset Flex Code
19871 \begin_layout Plain Layout
19878 \begin_inset Flex Code
19881 \begin_layout Plain Layout
19888 \begin_inset Flex Code
19891 \begin_layout Plain Layout
19898 \begin_inset Flex Code
19901 \begin_layout Plain Layout
19910 \begin_layout Enumerate
19911 The layout for a Flex inset is being defined.
19913 \begin_inset Flex Code
19916 \begin_layout Plain Layout
19922 must be of the form
19923 \begin_inset Quotes eld
19927 \begin_inset Flex Code
19930 \begin_layout Plain Layout
19937 \begin_inset Quotes erd
19941 \begin_inset Flex Code
19944 \begin_layout Plain Layout
19950 may be any valid identifier not used by a pre-existing Flex inset.
19951 The identifier may include spaces, but in that case the whole thing must
19952 be wrapped in quotes.
19953 Note that the definition of a flex inset
19958 \begin_inset Flex Code
19961 \begin_layout Plain Layout
19967 entry, declaring which type of inset it defines.
19970 \begin_layout Enumerate
19971 The layout for user specific branch is being defined.
19973 \begin_inset Flex Code
19976 \begin_layout Plain Layout
19982 must be of the form
19983 \begin_inset Quotes eld
19987 \begin_inset Flex Code
19990 \begin_layout Plain Layout
19997 \begin_inset Quotes erd
20001 \begin_inset Flex Code
20004 \begin_layout Plain Layout
20010 may be any valid identifier of branch defined in user's document.
20011 The identifier may include spaces, but in that case the whole thing must
20012 be wrapped in quotes.
20013 The main purpose of this feature is to allow \SpecialChar LaTeX
20014 wrapping around specific
20015 branches as user needs.
20018 \begin_layout Enumerate
20019 The layout of a user (or class) specific caption is being defined.
20021 \begin_inset Flex Code
20024 \begin_layout Plain Layout
20030 must be of the form
20031 \begin_inset Quotes eld
20035 \begin_inset Flex Code
20038 \begin_layout Plain Layout
20045 \begin_inset Quotes erd
20049 \begin_inset Flex Code
20052 \begin_layout Plain Layout
20058 specifies the name of the caption as it appears in the menu.
20059 Have a look at the standard caption (
20060 \begin_inset Flex Code
20063 \begin_layout Plain Layout
20069 ), the specific captions of the KOMA-Script classes (
20070 \begin_inset Flex Code
20073 \begin_layout Plain Layout
20080 \begin_inset Flex Code
20083 \begin_layout Plain Layout
20092 \begin_inset space ~
20096 \begin_inset Newline linebreak
20102 \begin_inset Flex Code
20105 \begin_layout Plain Layout
20111 ) for applications.
20114 \begin_layout Standard
20116 \begin_inset Flex Code
20119 \begin_layout Plain Layout
20125 definition can contain the following entries:
20128 \begin_layout Description
20129 \begin_inset Flex Code
20132 \begin_layout Plain Layout
20139 \begin_inset Flex Code
20142 \begin_layout Plain Layout
20148 =""] This inset will appear in the table of contents of the given type.
20149 An empty string disables.
20150 See also the OutlinerName and the IsTocCaption commands.
20151 This is only implemented for Flex insets.
20155 \begin_layout Description
20156 \begin_inset Flex Code
20159 \begin_layout Plain Layout
20166 \begin_inset Flex Code
20169 \begin_layout Plain Layout
20175 ] Defines argument number of a command\SpecialChar breakableslash
20176 environment associated with the current
20178 The definition must end with
20179 \begin_inset Flex Code
20182 \begin_layout Plain Layout
20190 \change_inserted -584632292 1615846847
20192 \begin_inset CommandInset ref
20194 reference "subsec:Arguments"
20202 \change_deleted -584632292 1615846847
20204 \begin_inset CommandInset ref
20206 reference "subsec:Paragraph-Styles"
20213 \change_deleted -584632292 1615846902
20215 \change_inserted -584632292 1615846906
20221 \begin_layout Description
20222 \begin_inset Flex Code
20225 \begin_layout Plain Layout
20231 Preamble for changing language commands; see
20232 \begin_inset CommandInset ref
20234 reference "subsec:I18n"
20241 \begin_layout Description
20242 \begin_inset Flex Code
20245 \begin_layout Plain Layout
20252 \begin_inset Flex Code
20255 \begin_layout Plain Layout
20261 ] The color for the inset's background.
20263 \begin_inset CommandInset ref
20265 reference "chap:Names-of-colors"
20269 for a list of the available color names.
20272 \begin_layout Description
20273 \begin_inset Flex Code
20276 \begin_layout Plain Layout
20283 \begin_inset Flex Code
20286 \begin_layout Plain Layout
20295 \begin_inset space \thinspace{}
20299 \begin_inset Flex Code
20302 \begin_layout Plain Layout
20308 ] Whether to use the content of the inset as the label, when the inset is
20313 \begin_layout Description
20314 \begin_inset Flex Code
20317 \begin_layout Plain Layout
20324 \begin_inset Flex Code
20327 \begin_layout Plain Layout
20333 ] As with paragraph styles, see
20334 \begin_inset CommandInset ref
20336 reference "subsec:Paragraph-Styles"
20341 Note that you need to specify the complete type, e.
20342 \begin_inset space \thinspace{}
20346 \begin_inset space ~
20350 \begin_inset Flex Code
20353 \begin_layout Plain Layout
20354 CopyStyle Flex:<name>
20362 \begin_layout Description
20363 \begin_inset Flex Code
20366 \begin_layout Plain Layout
20373 \begin_inset Flex Code
20376 \begin_layout Plain Layout
20385 \begin_inset space \thinspace{}
20389 \begin_inset Flex Code
20392 \begin_layout Plain Layout
20398 ] Indicates whether the user may employ the Paragraph Settings dialog to
20399 customize the paragraph.
20402 \begin_layout Description
20403 \begin_inset Flex Code
20406 \begin_layout Plain Layout
20413 \begin_inset Flex Code
20416 \begin_layout Plain Layout
20423 \begin_inset Flex Code
20426 \begin_layout Plain Layout
20433 \begin_inset Flex Code
20436 \begin_layout Plain Layout
20442 , describing the rendering style used for the inset's frame and buttons.
20443 Footnotes generally use
20444 \begin_inset Flex Code
20447 \begin_layout Plain Layout
20453 , ERT insets generally
20454 \begin_inset Flex Code
20457 \begin_layout Plain Layout
20463 , and character styles
20464 \begin_inset Flex Code
20467 \begin_layout Plain Layout
20476 \begin_layout Description
20477 \begin_inset Flex Code
20480 \begin_layout Plain Layout
20487 \begin_inset Flex Code
20490 \begin_layout Plain Layout
20499 \begin_inset space \thinspace{}
20505 \begin_inset Flex Code
20508 \begin_layout Plain Layout
20517 \begin_inset Flex Code
20520 \begin_layout Plain Layout
20527 \begin_inset Flex Code
20530 \begin_layout Plain Layout
20537 Indicates whether the environment will stand on its own in the output or
20538 will appear inline with the surrounding text.
20539 If set to false, it is supposed that the \SpecialChar LaTeX
20540 environment ignores white space
20541 (including one newline character) after the
20542 \begin_inset Flex Code
20545 \begin_layout Plain Layout
20558 \begin_inset Flex Code
20561 \begin_layout Plain Layout
20575 \change_inserted 731793113 1538674858
20579 \begin_layout Description
20581 \change_inserted 731793113 1538674891
20582 \begin_inset Flex Code
20585 \begin_layout Plain Layout
20587 \change_inserted 731793113 1538674863
20599 ,1] Allow the contents of the inset to be edited externally (using whatever
20600 editor is defined for the document's output format).
20605 \begin_layout Description
20606 \begin_inset Flex Code
20609 \begin_layout Plain Layout
20615 Required at the end of the
20616 \begin_inset Flex Code
20619 \begin_layout Plain Layout
20628 \begin_layout Description
20629 \begin_inset Flex Code
20632 \begin_layout Plain Layout
20638 The font used for both the text body
20644 \begin_inset CommandInset ref
20646 reference "subsec:Font-description"
20651 Note that defining this font automatically defines the
20652 \begin_inset Flex Code
20655 \begin_layout Plain Layout
20661 to the same value, so define this first and define
20662 \begin_inset Flex Code
20665 \begin_layout Plain Layout
20671 later if you want them to be different.
20674 \begin_layout Description
20675 \begin_inset Flex Code
20678 \begin_layout Plain Layout
20679 FixedWidthPreambleEncoding
20685 \begin_inset Flex Code
20688 \begin_layout Plain Layout
20697 \begin_inset space \thinspace{}
20701 \begin_inset Flex Code
20704 \begin_layout Plain Layout
20710 ] Force a fixed width encoding for the translated contents of
20711 \begin_inset Flex Code
20714 \begin_layout Plain Layout
20721 \begin_inset Flex Code
20724 \begin_layout Plain Layout
20730 code generated by this layout.
20731 This is needed for special \SpecialChar LaTeX
20736 that do not work with variable width encodings such as
20741 This setting is ignored if fully Unicode aware \SpecialChar LaTeX
20742 backends such as Xe\SpecialChar TeX
20744 Lua\SpecialChar TeX
20748 \begin_layout Description
20749 \begin_inset Flex Code
20752 \begin_layout Plain Layout
20753 ForceLocalFontSwitch
20759 \begin_inset Flex Code
20762 \begin_layout Plain Layout
20771 \begin_inset space \thinspace{}
20775 \begin_inset Flex Code
20778 \begin_layout Plain Layout
20784 ] When using babel, always use a local font switch (
20785 \begin_inset Flex Code
20788 \begin_layout Plain Layout
20796 ), never a global one (such as
20797 \begin_inset Flex Code
20800 \begin_layout Plain Layout
20811 \begin_layout Description
20812 \begin_inset Flex Code
20815 \begin_layout Plain Layout
20822 \begin_inset Flex Code
20825 \begin_layout Plain Layout
20834 \begin_inset space \thinspace{}
20838 \begin_inset Flex Code
20841 \begin_layout Plain Layout
20848 \begin_inset Quotes eld
20852 \begin_inset Quotes erd
20855 language, leading to Left-to-Right (Latin) output, e.
20856 \begin_inset space \thinspace{}
20860 \begin_inset space \space{}
20863 in \SpecialChar TeX
20868 \begin_layout Description
20869 \begin_inset Flex Code
20872 \begin_layout Plain Layout
20879 \begin_inset Flex Code
20882 \begin_layout Plain Layout
20891 \begin_inset space \thinspace{}
20895 \begin_inset Flex Code
20898 \begin_layout Plain Layout
20904 ] Force a line break in the \SpecialChar LaTeX
20905 output before the inset starts and after the
20907 This assures the inset itself is output on its own lines, for parsing purposes.
20910 \begin_layout Description
20911 \begin_inset Flex Code
20914 \begin_layout Plain Layout
20921 \begin_inset Flex Code
20924 \begin_layout Plain Layout
20933 \begin_inset space \thinspace{}
20937 \begin_inset Flex Code
20940 \begin_layout Plain Layout
20946 ] Indicates whether the
20947 \begin_inset Flex Code
20950 \begin_layout Plain Layout
20956 should be used or, instead, the user can change the paragraph style used
20961 \begin_layout Description
20962 \begin_inset Flex Code
20965 \begin_layout Plain Layout
20972 \begin_inset Flex Code
20975 \begin_layout Plain Layout
20984 \begin_inset space \thinspace{}
20988 \begin_inset Flex Code
20991 \begin_layout Plain Layout
20997 ] As with paragraph styles, see
20998 \begin_inset CommandInset ref
21000 reference "subsec:Paragraph-Styles"
21007 \begin_layout Description
21008 \begin_inset Flex Code
21011 \begin_layout Plain Layout
21017 These tags control the XHTML output.
21019 \begin_inset CommandInset ref
21021 reference "sec:Tags-for-XHTML"
21028 \begin_layout Description
21029 \begin_inset Flex Code
21032 \begin_layout Plain Layout
21039 \begin_inset Flex Code
21042 \begin_layout Plain Layout
21051 \begin_inset space \thinspace{}
21055 \begin_inset Flex Code
21058 \begin_layout Plain Layout
21064 ] Whether to include the contents of this inset in the strings generated
21065 for the `Outline' pane for all table of contents, regardless of the AddToToc
21067 One would not, for example, want the content of a footnote in a section
21068 header to be included in the TOC displayed in the outline, but one would
21069 normally want the content of a character style displayed.
21070 Default is false: not to include.
21073 \begin_layout Description
21074 \begin_inset Flex Code
21077 \begin_layout Plain Layout
21084 \begin_inset Flex Code
21087 \begin_layout Plain Layout
21096 \begin_inset space \thinspace{}
21100 \begin_inset Flex Code
21103 \begin_layout Plain Layout
21109 ] If this is set to 1 and AddToToc is enabled, the inset adds a summary
21110 of its contents in its item in the table of contents.
21111 Otherwise, only the label appears.
21114 \begin_layout Description
21115 \begin_inset Flex Code
21118 \begin_layout Plain Layout
21127 \begin_inset Flex Code
21130 \begin_layout Plain Layout
21139 \begin_inset space \thinspace{}
21143 \begin_inset Flex Code
21146 \begin_layout Plain Layout
21152 ] As with paragraph styles, see
21153 \begin_inset CommandInset ref
21155 reference "subsec:Paragraph-Styles"
21162 \begin_layout Description
21163 \begin_inset Flex Code
21166 \begin_layout Plain Layout
21172 The font used for the label.
21174 \begin_inset CommandInset ref
21176 reference "subsec:Font-description"
21181 Note that this definition can never appear before
21182 \begin_inset Flex Code
21185 \begin_layout Plain Layout
21191 , lest it be ineffective.
21194 \begin_layout Description
21195 \begin_inset Flex Code
21198 \begin_layout Plain Layout
21205 \begin_inset Flex Code
21208 \begin_layout Plain Layout
21215 \begin_inset Quotes erd
21219 \begin_inset Quotes erd
21222 ] What will be displayed on the button or elsewhere as the inset label.
21224 \begin_inset Flex Code
21227 \begin_layout Plain Layout
21235 \begin_inset Flex Code
21238 \begin_layout Plain Layout
21244 ) modify this label on the fly.
21247 \begin_layout Description
21248 \begin_inset Flex Code
21251 \begin_layout Plain Layout
21257 Language dependent preamble; see
21258 \begin_inset CommandInset ref
21260 reference "subsec:I18n"
21267 \begin_layout Description
21268 \begin_inset Flex Code
21271 \begin_layout Plain Layout
21278 \begin_inset Flex Code
21281 \begin_layout Plain Layout
21287 ] The name of the corresponding \SpecialChar LaTeX
21289 Either the environment or command name.
21292 \begin_layout Description
21293 \begin_inset Flex Code
21296 \begin_layout Plain Layout
21303 \begin_inset Flex Code
21306 \begin_layout Plain Layout
21312 ] The optional parameter for the corresponding
21313 \begin_inset Flex Code
21316 \begin_layout Plain Layout
21322 stuff, including possible bracket pairs like
21323 \begin_inset Flex Code
21326 \begin_layout Plain Layout
21333 This parameter cannot be changed from within \SpecialChar LyX
21335 \begin_inset Flex Code
21338 \begin_layout Plain Layout
21344 for customizable parameters).
21345 It will be output as is after all \SpecialChar LaTeX
21347 \begin_inset Flex Code
21350 \begin_layout Plain Layout
21359 \begin_layout Description
21360 \begin_inset Flex Code
21363 \begin_layout Plain Layout
21370 \begin_inset Flex Code
21373 \begin_layout Plain Layout
21374 Command, Environment, None
21379 ] How the style should be translated into \SpecialChar LaTeX
21384 \begin_layout Plain Layout
21385 \begin_inset Flex Code
21388 \begin_layout Plain Layout
21394 is perhaps a bit misleading, since these rules apply to SGML classes too.
21395 Visit the SGML class files for specific examples.
21404 \begin_layout Description
21405 \begin_inset Flex Code
21408 \begin_layout Plain Layout
21414 means nothing special
21417 \begin_layout Description
21418 \begin_inset Flex Code
21421 \begin_layout Plain Layout
21428 \begin_inset Flex Code
21431 \begin_layout Plain Layout
21438 {\SpecialChar ldots
21447 \begin_layout Description
21448 \begin_inset Flex Code
21451 \begin_layout Plain Layout
21458 \begin_inset Flex Code
21461 \begin_layout Plain Layout
21468 }\SpecialChar ldots
21483 \begin_layout Standard
21484 Putting the last few things together, the \SpecialChar LaTeX
21485 output will be either:
21488 \begin_layout LyX-Code
21491 LatexName[LatexParam]{\SpecialChar ldots
21495 \begin_layout Standard
21499 \begin_layout LyX-Code
21502 begin{LatexName}[LatexParam] \SpecialChar ldots
21508 \begin_layout Standard
21509 depending upon the \SpecialChar LaTeX
21514 \begin_layout Description
21515 \begin_inset Flex Code
21518 \begin_layout Plain Layout
21525 \begin_inset Flex Code
21528 \begin_layout Plain Layout
21534 ] A string that is put at the beginning of the layout content.
21535 A line break in the output can be indicated by
21536 \begin_inset Flex Code
21539 \begin_layout Plain Layout
21548 \begin_layout Description
21549 \begin_inset Flex Code
21552 \begin_layout Plain Layout
21559 \begin_inset Flex Code
21562 \begin_layout Plain Layout
21569 \begin_inset Flex Code
21572 \begin_layout Plain Layout
21579 \change_deleted -584632292 1615846609
21581 \begin_inset Flex Code
21584 \begin_layout Plain Layout
21593 \begin_inset Flex Code
21596 \begin_layout Plain Layout
21602 (indicating a dummy definition ending definitions of charstyles, etc).
21603 This entry is required in and is only meaningful for Flex insets.
21604 Among other things, it determines on which menu this inset will appear.
21606 \begin_inset Flex Code
21609 \begin_layout Plain Layout
21616 \begin_inset Flex Code
21619 \begin_layout Plain Layout
21625 will automatically set
21626 \begin_inset Flex Code
21629 \begin_layout Plain Layout
21636 \begin_inset Flex Code
21639 \begin_layout Plain Layout
21647 \begin_inset Flex Code
21650 \begin_layout Plain Layout
21656 can be set to true, or
21657 \begin_inset Flex Code
21660 \begin_layout Plain Layout
21667 \begin_inset Flex Code
21670 \begin_layout Plain Layout
21676 insets by setting it
21681 \begin_inset Flex Code
21684 \begin_layout Plain Layout
21691 \change_inserted -712698321 1555575738
21695 \begin_layout Description
21697 \change_inserted -712698321 1555575844
21698 \begin_inset Flex Code
21701 \begin_layout Plain Layout
21703 \change_inserted -712698321 1555575740
21712 \begin_inset Flex Code
21715 \begin_layout Plain Layout
21717 \change_inserted -712698321 1555575740
21725 A dedicated string for the menu.
21726 You can define an accelerator by appending the respective character to
21727 the string, divided by
21728 \begin_inset Quotes eld
21732 \begin_inset Quotes erd
21736 \begin_inset space \thinspace{}
21740 \begin_inset space \space{}
21744 \begin_inset Quotes eld
21748 \begin_inset Flex Code
21751 \begin_layout Plain Layout
21753 \change_inserted -712698321 1555575781
21762 \begin_inset Quotes erd
21766 This specification is optional.
21767 If it is not given the inset name as specified in the type declaration
21768 will be used instead for the menu.
21773 \begin_layout Description
21774 \begin_inset Flex Code
21777 \begin_layout Plain Layout
21784 \begin_inset Flex Code
21787 \begin_layout Plain Layout
21796 \begin_inset space \thinspace{}
21800 \begin_inset Flex Code
21803 \begin_layout Plain Layout
21809 ] Whether multiple paragraphs are permitted in this inset.
21811 \begin_inset Flex Code
21814 \begin_layout Plain Layout
21820 to the same value and
21821 \begin_inset Flex Code
21824 \begin_layout Plain Layout
21830 to the opposite value.
21831 These can be reset to other values, if they are used
21836 \begin_inset Flex Code
21839 \begin_layout Plain Layout
21849 \begin_layout Description
21850 \begin_inset Flex Code
21853 \begin_layout Plain Layout
21860 \begin_inset Flex Code
21863 \begin_layout Plain Layout
21872 \begin_inset space \thinspace{}
21876 \begin_inset Flex Code
21879 \begin_layout Plain Layout
21885 ] Whether fragile commands in this inset should be
21886 \begin_inset Flex Code
21889 \begin_layout Plain Layout
21902 whether the command should itself be protected.) Default is false.
21903 \change_inserted -712698321 1523633958
21907 \begin_layout Description
21909 \change_inserted -712698321 1552395786
21910 \begin_inset Flex Code
21913 \begin_layout Plain Layout
21915 \change_inserted -712698321 1523633961
21924 \begin_inset Flex Code
21927 \begin_layout Plain Layout
21929 \change_inserted -712698321 1523633958
21940 \begin_inset space \thinspace{}
21944 \begin_inset Flex Code
21947 \begin_layout Plain Layout
21949 \change_inserted -712698321 1523633958
21957 ] This causes macros that contain this inset to be protected with
21958 \begin_inset Flex Code
21961 \begin_layout Plain Layout
21963 \change_inserted -712698321 1523634038
21978 ) if necessary and thus allows (some) verbatim stuff in macros.
21982 \begin_layout Description
21984 \change_inserted -712698321 1555579651
21985 \begin_inset Flex Code
21988 \begin_layout Plain Layout
21990 \change_inserted -712698321 1552395787
21999 \begin_inset Flex Code
22002 \begin_layout Plain Layout
22004 \change_inserted -712698321 1552395787
22015 \begin_inset space \thinspace{}
22019 \begin_inset Flex Code
22022 \begin_layout Plain Layout
22024 \change_inserted -712698321 1552395787
22032 ] Whether specific commands in this inset (such as
22033 \begin_inset Flex Code
22036 \begin_layout Plain Layout
22038 \change_inserted -712698321 1552395787
22049 \begin_inset Flex Code
22052 \begin_layout Plain Layout
22054 \change_inserted -712698321 1552395787
22064 ) should be protected in an
22065 \begin_inset Flex Code
22068 \begin_layout Plain Layout
22070 \change_inserted -712698321 1552395787
22081 This is particularly needed for insets that draw on
22089 commands which parse their content in complex ways.
22093 \begin_layout Description
22095 \change_inserted -712698321 1555579742
22096 \begin_inset Flex Code
22099 \begin_layout Plain Layout
22101 \change_inserted -712698321 1555579658
22110 \begin_inset Flex Code
22113 \begin_layout Plain Layout
22115 \change_inserted -712698321 1555579651
22123 Option to define a different command (from the default
22124 \begin_inset Flex Code
22127 \begin_layout Plain Layout
22129 \change_inserted -712698321 1555579742
22141 ) to be used for line breaks.
22142 The initial backslash must not be specified.
22147 \begin_layout Description
22148 \begin_inset Flex Code
22151 \begin_layout Plain Layout
22158 \begin_inset Flex Code
22161 \begin_layout Plain Layout
22167 ] Deletes an existing
22168 \begin_inset Flex Code
22171 \begin_layout Plain Layout
22180 \begin_layout Description
22181 \begin_inset Flex Code
22184 \begin_layout Plain Layout
22191 \begin_inset Flex Code
22194 \begin_layout Plain Layout
22201 \begin_inset Flex Code
22204 \begin_layout Plain Layout
22210 that has replaced this
22211 \begin_inset Flex Code
22214 \begin_layout Plain Layout
22221 This is used to rename an
22222 \begin_inset Flex Code
22225 \begin_layout Plain Layout
22231 , while keeping backward compatibility.
22232 \change_inserted -712698321 1559491850
22236 \begin_layout Description
22238 \change_inserted -712698321 1559492002
22239 \begin_inset Flex Code
22242 \begin_layout Plain Layout
22244 \change_inserted -712698321 1559491854
22253 \begin_inset Flex Code
22256 \begin_layout Plain Layout
22258 \change_inserted -712698321 1559491850
22269 \begin_inset space \thinspace{}
22273 \begin_inset Flex Code
22276 \begin_layout Plain Layout
22278 \change_inserted -712698321 1559491850
22286 ] If this is set to
22287 \begin_inset Flex Code
22290 \begin_layout Plain Layout
22292 \change_inserted -712698321 1559491881
22300 , paragraph breaks will be ignored in the output.
22301 This might be useful for insets where the content should be alignable on
22302 different lines only in the \SpecialChar LyX
22303 workarea, without any effect in the output.
22308 \begin_layout Description
22309 \begin_inset Flex Code
22312 \begin_layout Plain Layout
22319 \begin_inset Flex Code
22322 \begin_layout Plain Layout
22331 \begin_inset space \thinspace{}
22335 \begin_inset Flex Code
22338 \begin_layout Plain Layout
22344 ] As with paragraph styles, see
22345 \begin_inset CommandInset ref
22347 reference "subsec:Paragraph-Styles"
22355 \begin_layout Description
22356 \begin_inset Flex Code
22359 \begin_layout Plain Layout
22366 \begin_inset Flex Code
22369 \begin_layout Plain Layout
22378 \begin_inset space \thinspace{}
22382 \begin_inset Flex Code
22385 \begin_layout Plain Layout
22391 ] As with paragraph styles, see
22392 \begin_inset CommandInset ref
22394 reference "subsec:Paragraph-Styles"
22402 \begin_layout Description
22403 \begin_inset Flex Code
22406 \begin_layout Plain Layout
22412 As with paragraph styles, see
22413 \begin_inset CommandInset ref
22415 reference "subsec:Paragraph-Styles"
22422 \begin_layout Description
22423 \begin_inset Flex Code
22426 \begin_layout Plain Layout
22433 \begin_inset Flex Code
22436 \begin_layout Plain Layout
22442 ] The prefix to use when creating labels referring to insets of this type.
22443 This allows the use of formatted references.
22446 \begin_layout Description
22447 \begin_inset Flex Code
22450 \begin_layout Plain Layout
22457 \begin_inset Flex Code
22460 \begin_layout Plain Layout
22466 ] As with paragraph styles, see
22467 \begin_inset CommandInset ref
22469 reference "subsec:Paragraph-Styles"
22476 \begin_layout Description
22477 \begin_inset Flex Code
22480 \begin_layout Plain Layout
22487 \begin_inset Flex Code
22490 \begin_layout Plain Layout
22499 \begin_inset space \thinspace{}
22503 \begin_inset Flex Code
22506 \begin_layout Plain Layout
22512 ] Resets the \SpecialChar LaTeX
22513 arguments of this layout (as defined via the
22514 \begin_inset Flex Code
22517 \begin_layout Plain Layout
22524 This is useful if you have copied a style via
22525 \begin_inset Flex Code
22528 \begin_layout Plain Layout
22534 , but you do not want to inherit its (required and optional) arguments.
22537 \begin_layout Description
22538 \begin_inset Flex Code
22541 \begin_layout Plain Layout
22548 \begin_inset Flex Code
22551 \begin_layout Plain Layout
22560 \begin_inset space \thinspace{}
22564 \begin_inset Flex Code
22567 \begin_layout Plain Layout
22574 \change_inserted -712698321 1597733473
22576 \begin_inset Flex Code
22579 \begin_layout Plain Layout
22581 \change_inserted -712698321 1597732178
22589 , font changes are redone inside the respective inset (in the output) even
22590 if the inset itself is in the context of this font changes (e.
22591 \begin_inset space \thinspace{}
22595 \begin_inset Flex Code
22598 \begin_layout Plain Layout
22600 \change_inserted -712698321 1597733683
22603 textbf{Sourrounding text
22607 textbf{content}}\SpecialChar ldots
22616 \begin_inset Flex Code
22619 \begin_layout Plain Layout
22621 \change_inserted -712698321 1597733686
22624 textbf{Sourrounding text
22626 myinset{content}\SpecialChar ldots
22635 Setting this makes sense for commands that internally reset font settings
22637 \begin_inset space \thinspace{}
22641 Note that wrongly setting this might lead to unwanted result (e.
22642 \begin_inset space \thinspace{}
22646 \begin_inset Flex Code
22649 \begin_layout Plain Layout
22651 \change_inserted -712698321 1597733688
22654 emph{Sourrounding text
22658 emph{content}}\SpecialChar ldots
22666 , content is upright, as
22667 \begin_inset Flex Code
22670 \begin_layout Plain Layout
22672 \change_inserted -712698321 1597733278
22684 \change_deleted -712698321 1597733283
22685 Whether this inset should use the font of its surrounding environment or
22690 \change_deleted -712698321 1597733290
22692 \change_inserted -712698321 1597733290
22694 \begin_inset Flex Code
22697 \begin_layout Plain Layout
22699 \change_inserted -712698321 1597733292
22710 \change_deleted -712698321 1597733327
22711 use the font of the surrounding environment
22712 \change_inserted -712698321 1597733343
22713 font changes are not redone inside the inset
22718 \begin_layout Description
22719 \begin_inset Flex Code
22722 \begin_layout Plain Layout
22729 \begin_inset Flex Code
22732 \begin_layout Plain Layout
22738 ] A string that is put at the end of the layout content.
22739 A line break in the output can be indicated by
22740 \begin_inset Flex Code
22743 \begin_layout Plain Layout
22752 \begin_layout Description
22753 \begin_inset Flex Code
22756 \begin_layout Plain Layout
22763 \begin_inset Flex Code
22766 \begin_layout Plain Layout
22773 \begin_inset space \thinspace{}
22777 \begin_inset Flex Code
22780 \begin_layout Plain Layout
22788 ] Allow spell-checking the contents of this inset.
22790 \change_inserted -584632292 1615846659
22794 \begin_layout Subsection
22796 \change_inserted -584632292 1615846729
22798 \begin_inset CommandInset label
22800 name "subsec:Arguments"
22807 \begin_layout Standard
22809 \change_inserted -584632292 1615846807
22810 Both paragraph styles and inset layouts allow for
22814 as well as the main content.
22815 This is especially useful for things like section headings and only makes
22816 sense with \SpecialChar LaTeX
22818 Each (optional or required) argument of a command or environment—except
22819 for the required argument that is associated with the content—has a separate
22820 definition, where the number specifies the order of the arguments.
22821 The definition must end with
22822 \begin_inset Flex Code
22825 \begin_layout Plain Layout
22827 \change_inserted -584632292 1615846730
22836 So a command with two optional arguments looks like:
22839 \begin_layout Quote
22841 \change_inserted -584632292 1615846730
22847 \begin_layout Quote
22849 \change_inserted -584632292 1615846730
22855 \begin_layout Quote
22857 \change_inserted -584632292 1615846730
22863 \begin_layout Quote
22865 \change_inserted -584632292 1615846730
22871 \begin_layout Quote
22873 \change_inserted -584632292 1615846730
22879 \begin_layout Quote
22881 \change_inserted -584632292 1615846730
22887 \begin_layout Standard
22889 \change_inserted -584632292 1615846730
22891 \begin_inset Flex Code
22894 \begin_layout Plain Layout
22896 \change_inserted -584632292 1615846730
22904 definition, the following specifications are possible:
22907 \begin_layout Itemize
22909 \change_inserted -584632292 1615846730
22910 \begin_inset Flex Code
22913 \begin_layout Plain Layout
22915 \change_inserted -584632292 1615846730
22924 \begin_inset Flex Code
22927 \begin_layout Plain Layout
22929 \change_inserted -584632292 1615846730
22937 The string that will appear both in the menu (to insert this argument)
22938 and on the argument inset button (unless you also specify a separate
22939 \begin_inset Flex Code
22942 \begin_layout Plain Layout
22944 \change_inserted -584632292 1615846730
22953 For the menu, you can define an accelerator by appending the respective
22954 character to the string, divided by
22955 \begin_inset Quotes eld
22959 \begin_inset Quotes erd
22963 \begin_inset space \thinspace{}
22967 \begin_inset space \space{}
22971 \begin_inset Quotes eld
22975 \begin_inset Flex Code
22978 \begin_layout Plain Layout
22980 \change_inserted -584632292 1615846730
22989 \begin_inset Quotes erd
22995 \begin_layout Itemize
22997 \change_inserted -584632292 1615846730
22998 \begin_inset Flex Code
23001 \begin_layout Plain Layout
23003 \change_inserted -584632292 1615846730
23012 \begin_inset Flex Code
23015 \begin_layout Plain Layout
23017 \change_inserted -584632292 1615846730
23025 A separate string for the menu.
23026 You can define an accelerator by appending the respective character to
23027 the string, divided by
23028 \begin_inset Quotes eld
23032 \begin_inset Quotes erd
23036 \begin_inset space \thinspace{}
23040 \begin_inset space \space{}
23044 \begin_inset Quotes eld
23048 \begin_inset Flex Code
23051 \begin_layout Plain Layout
23053 \change_inserted -584632292 1615846730
23062 \begin_inset Quotes erd
23066 This specification is optional.
23067 If it is not given the
23068 \begin_inset Flex Code
23071 \begin_layout Plain Layout
23073 \change_inserted -584632292 1615846730
23081 will be used instead for the menu.
23084 \begin_layout Itemize
23086 \change_inserted -584632292 1615846730
23087 \begin_inset Flex Code
23090 \begin_layout Plain Layout
23092 \change_inserted -584632292 1615846730
23101 \begin_inset Flex Code
23104 \begin_layout Plain Layout
23106 \change_inserted -584632292 1615846730
23114 A longer explanatory text that appears in the tooltip when hovering over
23115 the argument inset.
23118 \begin_layout Itemize
23120 \change_inserted -584632292 1615846730
23121 \begin_inset Flex Code
23124 \begin_layout Plain Layout
23126 \change_inserted -584632292 1615846730
23135 \begin_inset Flex Code
23138 \begin_layout Plain Layout
23140 \change_inserted -584632292 1615846730
23151 \begin_inset space \thinspace{}
23155 \begin_inset Flex Code
23158 \begin_layout Plain Layout
23160 \change_inserted -584632292 1615846730
23168 ] Declare if this is a mandatory (1) or an optional (0) argument.
23169 Mandatory arguments will be output empty if not given, while optional arguments
23170 will not be output at all.
23171 By default, mandatory arguments are delimited by
23172 \begin_inset Flex Code
23175 \begin_layout Plain Layout
23177 \change_inserted -584632292 1615846730
23185 , while optional arguments are delimited by
23186 \begin_inset Flex Code
23189 \begin_layout Plain Layout
23191 \change_inserted -584632292 1615846730
23202 \begin_layout Itemize
23204 \change_inserted -584632292 1615846730
23205 \begin_inset Flex Code
23208 \begin_layout Plain Layout
23210 \change_inserted -584632292 1615846730
23219 \begin_inset Flex Code
23222 \begin_layout Plain Layout
23224 \change_inserted -584632292 1615846730
23232 Option to define a different command (from the default
23233 \begin_inset Flex Code
23236 \begin_layout Plain Layout
23238 \change_inserted -584632292 1615846730
23250 ) to be used for line breaks.
23251 The initial backslash must not be specified.
23254 \begin_layout Itemize
23256 \change_inserted -584632292 1615846730
23257 \begin_inset Flex Code
23260 \begin_layout Plain Layout
23262 \change_inserted -584632292 1615846730
23271 \begin_inset Flex Code
23274 \begin_layout Plain Layout
23276 \change_inserted -584632292 1615846730
23284 defines another argument (by its number) which this argument requires to
23285 be output if it is itself output.
23287 \begin_inset space \thinspace{}
23290 g., in \SpecialChar LaTeX
23291 commands, optional arguments often require previous optional arguments
23292 to be output (at least empty), as in
23293 \begin_inset Flex Code
23296 \begin_layout Plain Layout
23298 \change_inserted -584632292 1615846730
23301 command[][argument]{text}
23309 This can be achieved by the statement
23310 \begin_inset Flex Code
23313 \begin_layout Plain Layout
23315 \change_inserted -584632292 1615846730
23324 \begin_inset Flex Code
23327 \begin_layout Plain Layout
23329 \change_inserted -584632292 1615846730
23340 \begin_layout Itemize
23342 \change_inserted -584632292 1615846730
23343 \begin_inset Flex Code
23346 \begin_layout Plain Layout
23348 \change_inserted -584632292 1615846730
23357 \begin_inset Flex Code
23360 \begin_layout Plain Layout
23362 \change_inserted -584632292 1615846730
23370 defines a custom left delimiter (instead of
23371 \begin_inset Flex Code
23374 \begin_layout Plain Layout
23376 \change_inserted -584632292 1615846730
23385 \begin_inset Flex Code
23388 \begin_layout Plain Layout
23390 \change_inserted -584632292 1615846730
23399 A line break in the output can be indicated by
23400 \begin_inset Flex Code
23403 \begin_layout Plain Layout
23405 \change_inserted -584632292 1615846730
23416 \begin_layout Itemize
23418 \change_inserted -584632292 1615846730
23419 \begin_inset Flex Code
23422 \begin_layout Plain Layout
23424 \change_inserted -584632292 1615846730
23433 \begin_inset Flex Code
23436 \begin_layout Plain Layout
23438 \change_inserted -584632292 1615846730
23446 defines a custom right delimiter (instead of
23447 \begin_inset Flex Code
23450 \begin_layout Plain Layout
23452 \change_inserted -584632292 1615846730
23461 \begin_inset Flex Code
23464 \begin_layout Plain Layout
23466 \change_inserted -584632292 1615846730
23475 A line break in the output can be indicated by
23476 \begin_inset Flex Code
23479 \begin_layout Plain Layout
23481 \change_inserted -584632292 1615846730
23492 \begin_layout Itemize
23494 \change_inserted -584632292 1615846730
23495 \begin_inset Flex Code
23498 \begin_layout Plain Layout
23500 \change_inserted -584632292 1615846730
23509 \begin_inset Flex Code
23512 \begin_layout Plain Layout
23514 \change_inserted -584632292 1615846730
23522 defines an argument that is inserted if and only if no user-specified arguments
23524 \begin_inset space \thinspace{}
23528 \begin_inset space \space{}
23531 if no argument inset has been inserted (note that also an empty argument
23532 inset omits the DefaultArg).
23533 Multiple arguments need to be separated by comma.
23536 \begin_layout Itemize
23538 \change_inserted -584632292 1615846730
23539 \begin_inset Flex Code
23542 \begin_layout Plain Layout
23544 \change_inserted -584632292 1615846730
23553 \begin_inset Flex Code
23556 \begin_layout Plain Layout
23558 \change_inserted -584632292 1615846730
23566 defines an argument that is inserted in any case (alone or in addition
23567 to user-specified arguments).
23568 Multiple arguments need to be separated by comma.
23571 \begin_layout Itemize
23573 \change_inserted -584632292 1615846730
23574 \begin_inset Flex Code
23577 \begin_layout Plain Layout
23579 \change_inserted -584632292 1615846730
23587 The font used for the argument content, see
23588 \begin_inset CommandInset ref
23590 reference "subsec:Font-description"
23597 \begin_layout Itemize
23599 \change_inserted -584632292 1615846730
23600 \begin_inset Flex Code
23603 \begin_layout Plain Layout
23605 \change_inserted -584632292 1615846730
23614 \begin_inset Flex Code
23617 \begin_layout Plain Layout
23619 \change_inserted -584632292 1615846730
23630 \begin_inset space \thinspace{}
23634 \begin_inset Flex Code
23637 \begin_layout Plain Layout
23639 \change_inserted -584632292 1615846730
23647 ] As with paragraph styles, see
23648 \begin_inset CommandInset ref
23650 reference "subsec:Paragraph-Styles"
23657 \begin_layout Itemize
23659 \change_inserted -584632292 1615846730
23660 \begin_inset Flex Code
23663 \begin_layout Plain Layout
23665 \change_inserted -584632292 1615846730
23673 The font used for the label; see
23674 \begin_inset CommandInset ref
23676 reference "subsec:Font-description"
23683 \begin_layout Itemize
23685 \change_inserted -584632292 1615846730
23686 \begin_inset Flex Code
23689 \begin_layout Plain Layout
23691 \change_inserted -584632292 1615846730
23700 \begin_inset Flex Code
23703 \begin_layout Plain Layout
23705 \change_inserted -584632292 1615846730
23710 , Minimalistic, Conglomerate
23717 ] describes the rendering style used for the inset's frame and buttons.
23720 \begin_layout Itemize
23722 \change_inserted -584632292 1615846730
23723 \begin_inset Flex Code
23726 \begin_layout Plain Layout
23728 \change_inserted -584632292 1615846730
23737 \begin_inset Flex Code
23740 \begin_layout Plain Layout
23742 \change_inserted -584632292 1615846730
23751 \begin_inset Flex Code
23754 \begin_layout Plain Layout
23756 \change_inserted -584632292 1615846730
23764 , this argument is automatically inserted when the respective style is selected.
23767 \begin_layout Itemize
23769 \change_inserted -584632292 1615846730
23770 \begin_inset Flex Code
23773 \begin_layout Plain Layout
23775 \change_inserted -584632292 1615846730
23784 \begin_inset Flex Code
23787 \begin_layout Plain Layout
23789 \change_inserted -584632292 1615846730
23798 \begin_inset Flex Code
23801 \begin_layout Plain Layout
23803 \change_inserted -584632292 1615846730
23811 , this argument will be inserted on a new line with
23812 \begin_inset Flex Code
23815 \begin_layout Plain Layout
23817 \change_inserted -584632292 1615846730
23825 (only available within Flex insets).
23828 \begin_layout Itemize
23830 \change_inserted -584632292 1615846730
23831 \begin_inset Flex Code
23834 \begin_layout Plain Layout
23836 \change_inserted -584632292 1615846730
23845 \begin_inset Flex Code
23848 \begin_layout Plain Layout
23850 \change_inserted -584632292 1615846730
23859 \begin_inset Flex Code
23862 \begin_layout Plain Layout
23864 \change_inserted -584632292 1615846730
23872 , this argument will be inserted with a copy of the co-text (either selected
23873 text or the whole paragraph) as content.
23876 \begin_layout Itemize
23878 \change_inserted -584632292 1615846730
23879 \begin_inset Flex Code
23882 \begin_layout Plain Layout
23884 \change_inserted -584632292 1615846730
23893 \begin_inset Flex Code
23896 \begin_layout Plain Layout
23898 \change_inserted -584632292 1615846730
23910 ] Whether the contents of this argument should be output in raw form, meaning
23911 without special translations that \SpecialChar LaTeX
23914 \begin_inset Flex Code
23917 \begin_layout Plain Layout
23919 \change_inserted -584632292 1615846730
23927 status is inherited by the inset or paragraph layout the argument belongs
23928 to, true and false change the status for the given argument only.
23931 \begin_layout Itemize
23933 \change_inserted -584632292 1615846730
23934 \begin_inset Flex Code
23937 \begin_layout Plain Layout
23939 \change_inserted -584632292 1615846730
23948 \begin_inset Flex Code
23951 \begin_layout Plain Layout
23953 \change_inserted -584632292 1615846730
23954 string of characters
23965 Defines individual characters
23966 \begin_inset Newline linebreak
23969 that should be output in raw form, meaning without special translations
23970 that \SpecialChar LaTeX
23972 Note that, contrary to PassThru, this needs to be explicitly defined for
23974 That is, arguments do not inherit PassThruChars from their parent inset
23978 \begin_layout Itemize
23980 \change_inserted -584632292 1615846730
23981 \begin_inset Flex Code
23984 \begin_layout Plain Layout
23986 \change_inserted -584632292 1615846730
23995 \begin_inset Flex Code
23998 \begin_layout Plain Layout
24000 \change_inserted -584632292 1615846730
24011 \begin_inset space \thinspace{}
24015 \begin_inset Flex Code
24018 \begin_layout Plain Layout
24020 \change_inserted -584632292 1615846730
24028 ] If this is set to 1, the argument will output its content in the corresponding
24029 item in the table of contents.
24033 \begin_layout Standard
24035 \change_inserted -584632292 1615846730
24036 By default, the text entered in the \SpecialChar LyX
24037 workarea in the respective layout is
24038 the last (mandatory) argument of a command if the
24039 \begin_inset Flex Code
24042 \begin_layout Plain Layout
24044 \change_inserted -584632292 1615846730
24053 \begin_inset Flex Code
24056 \begin_layout Plain Layout
24058 \change_inserted -584632292 1615846730
24067 However, arguments with the prefix
24068 \begin_inset Flex Code
24071 \begin_layout Plain Layout
24073 \change_inserted -584632292 1615846730
24081 are output after this workarea argument.
24082 Note that post-argument numbering restarts at 1, so the first argument
24083 following the workarea argument is
24084 \begin_inset Flex Code
24087 \begin_layout Plain Layout
24089 \change_inserted -584632292 1615846730
24098 Post-arguments are ignored in any other
24099 \begin_inset Flex Code
24102 \begin_layout Plain Layout
24104 \change_inserted -584632292 1615846730
24113 \begin_inset Flex Code
24116 \begin_layout Plain Layout
24118 \change_inserted -584632292 1615846730
24129 \begin_layout Standard
24131 \change_inserted -584632292 1615846730
24133 \begin_inset Flex Code
24136 \begin_layout Plain Layout
24138 \change_inserted -584632292 1615846730
24149 \begin_inset Flex Code
24152 \begin_layout Plain Layout
24154 \change_inserted -584632292 1615846730
24165 \begin_inset Flex Code
24168 \begin_layout Plain Layout
24170 \change_inserted -584632292 1615846730
24178 followed by the number (e.
24179 \begin_inset space \thinspace{}
24183 \begin_inset space \space{}
24187 \begin_inset Flex Code
24190 \begin_layout Plain Layout
24192 \change_inserted -584632292 1615846730
24203 \begin_layout Standard
24205 \change_inserted -584632292 1615846730
24206 Finally, there is a special argument type with the prefix
24207 \begin_inset Flex Code
24210 \begin_layout Plain Layout
24212 \change_inserted -584632292 1615846730
24221 It is not really an argument, but uses the argument interface (thus, the
24222 prefix is also followed by a number, e.
24223 \begin_inset space \thinspace{}
24228 \begin_inset Flex Code
24231 \begin_layout Plain Layout
24233 \change_inserted -584632292 1615846730
24234 Argument listpreamble:1
24242 As the name implies, it is targeted at lists such as
24259 Its content will be output at the list start, before the first
24260 \begin_inset Flex Code
24263 \begin_layout Plain Layout
24265 \change_inserted -584632292 1615846730
24275 , on an own line (a place that is otherwise not accessible in \SpecialChar LyX
24277 This way, users can insert redefinitions (of lengths etc.) to individual
24279 By default, these arguments do not have a delimiter.
24284 \begin_layout Subsection
24286 \begin_inset CommandInset label
24288 name "subsec:Counters"
24295 \begin_layout Standard
24296 It is necessary to define the counters (
24297 \begin_inset Flex Noun
24300 \begin_layout Plain Layout
24307 \begin_inset Flex Noun
24310 \begin_layout Plain Layout
24316 , \SpecialChar ldots
24317 ) in the text class itself.
24318 The standard counters are defined in the file
24319 \begin_inset Flex Code
24322 \begin_layout Plain Layout
24328 , so you may have to do no more than add
24331 \begin_layout LyX-Code
24332 Input stdcounters.inc
24335 \begin_layout Standard
24336 to your layout file to get them to work.
24337 But if you want to define custom counters, then you can do so.
24338 The counter declaration must begin with:
24341 \begin_layout LyX-Code
24342 Counter CounterName
24345 \begin_layout Standard
24347 \begin_inset Flex Code
24350 \begin_layout Plain Layout
24356 ' is replaced by the name of the counter.
24357 And it must end with
24358 \begin_inset Quotes eld
24362 \begin_inset Flex Code
24365 \begin_layout Plain Layout
24372 \begin_inset Quotes erd
24376 The following parameters can also be used:
24379 \begin_layout Description
24380 \begin_inset Flex Code
24383 \begin_layout Plain Layout
24390 \begin_inset Flex Code
24393 \begin_layout Plain Layout
24399 ] Sets the initial value for the counter, to which it will be reset whenever
24401 Normally, one will want the default, 1.
24404 \begin_layout Description
24405 \begin_inset Flex Code
24408 \begin_layout Plain Layout
24415 \begin_inset Flex Code
24418 \begin_layout Plain Layout
24425 \begin_inset Quotes erd
24429 \begin_inset Quotes erd
24432 ] When defined, this string defines how the counter is displayed.
24433 Setting this value sets
24434 \begin_inset Flex Code
24437 \begin_layout Plain Layout
24438 LabelStringAppendix
24444 The following special constructs can be used in the string:
24448 \begin_layout Itemize
24449 \begin_inset Flex Code
24452 \begin_layout Plain Layout
24460 will be replaced by the expansion of the
24461 \begin_inset Flex Code
24464 \begin_layout Plain Layout
24471 \begin_inset Flex Code
24474 \begin_layout Plain Layout
24475 LabelStringAppendix
24481 \begin_inset Flex Code
24484 \begin_layout Plain Layout
24494 \begin_layout Itemize
24495 counter values can be expressed using \SpecialChar LaTeX
24497 \begin_inset Newline newline
24501 \begin_inset Flex Code
24504 \begin_layout Plain Layout
24521 \begin_inset Flex Code
24524 \begin_layout Plain Layout
24536 \begin_layout Plain Layout
24546 Actually, the situation is a bit more complicated: any
24565 other than those described below will produce arabic numerals.
24566 It would not be surprising to see this change in the future.
24572 \begin_inset Flex Code
24575 \begin_layout Plain Layout
24581 : 1, 2, 3,\SpecialChar ldots
24583 \begin_inset Flex Code
24586 \begin_layout Plain Layout
24592 for lower-case letters: a, b, c, \SpecialChar ldots
24594 \begin_inset Flex Code
24597 \begin_layout Plain Layout
24603 for upper-case letters: A, B, C, \SpecialChar ldots
24605 \begin_inset Flex Code
24608 \begin_layout Plain Layout
24614 for lower-case roman numerals: i, ii, iii, \SpecialChar ldots
24616 \begin_inset Flex Code
24619 \begin_layout Plain Layout
24625 for upper-case roman numerals: I, II, III\SpecialChar ldots
24627 \begin_inset Flex Code
24630 \begin_layout Plain Layout
24636 for hebrew numerals.
24640 \begin_layout Standard
24641 If LabelString is not defined, a default value is constructed as follows:
24642 if the counter has a
24643 \change_deleted 731793113 1604355218
24645 \change_inserted 731793113 1604355221
24649 \begin_inset Flex Code
24652 \begin_layout Plain Layout
24654 \change_deleted 731793113 1604355223
24656 \change_inserted 731793113 1604355226
24665 \begin_inset Flex Code
24668 \begin_layout Plain Layout
24675 \begin_inset Newline newline
24679 \begin_inset Flex Code
24682 \begin_layout Plain Layout
24686 \change_inserted 731793113 1604355228
24688 \change_deleted 731793113 1604355230
24698 is used; otherwise the string
24699 \begin_inset Flex Code
24702 \begin_layout Plain Layout
24713 \begin_layout Description
24714 \begin_inset Flex Code
24717 \begin_layout Plain Layout
24718 LabelStringAppendix
24724 \begin_inset Flex Code
24727 \begin_layout Plain Layout
24734 \begin_inset Quotes eld
24738 \begin_inset Quotes erd
24742 \begin_inset Flex Code
24745 \begin_layout Plain Layout
24751 , but for use in the Appendix.
24752 \change_inserted -584632292 1607202551
24756 \begin_layout Description
24758 \change_inserted -584632292 1607202682
24759 \begin_inset Flex Code
24762 \begin_layout Plain Layout
24769 \begin_inset Flex Code
24772 \begin_layout Plain Layout
24774 \change_inserted -584632292 1607202576
24783 \begin_inset Quotes eld
24787 \begin_inset Quotes erd
24790 ] The counter name as used in \SpecialChar LaTeX
24793 \change_inserted 34634807 1619711355
24795 \change_deleted 34634807 1619711355
24797 \change_inserted -584632292 1607202682
24798 .g., in \SpecialChar LyX
24799 , there is a counter named `theorem', but it is output to \SpecialChar LaTeX
24805 \begin_layout Description
24806 \begin_inset Flex Code
24809 \begin_layout Plain Layout
24816 \begin_inset Flex Code
24819 \begin_layout Plain Layout
24826 \begin_inset Quotes erd
24830 \begin_inset Quotes erd
24833 ] A format for use with formatted references to this counter.
24834 For example, one might want to have references to section numbers appear
24836 \begin_inset Quotes eld
24840 \begin_inset Quotes erd
24844 The string should contain
24845 \begin_inset Quotes eld
24849 \begin_inset Quotes erd
24853 This will be replaced by the counter number itself.
24854 So, for sections, it would be: Section ##.
24857 \begin_layout Description
24858 \begin_inset Flex Code
24861 \begin_layout Plain Layout
24868 \begin_inset Flex Code
24871 \begin_layout Plain Layout
24878 \begin_inset Quotes erd
24882 \begin_inset Quotes erd
24885 ] If this is set to the name of another counter, the present counter will
24886 be reset every time the other one is increased.
24888 \begin_inset Flex Code
24891 \begin_layout Plain Layout
24898 \begin_inset Flex Code
24901 \begin_layout Plain Layout
24910 \begin_layout Subsection
24912 \begin_inset CommandInset label
24914 name "subsec:Font-description"
24921 \begin_layout Standard
24922 A font description looks like this:
24925 \begin_layout LyX-Code
24942 \begin_layout LyX-Code
24946 \begin_layout LyX-Code
24950 \begin_layout Standard
24951 The following commands are available:
24954 \begin_layout Description
24955 \begin_inset Flex Code
24958 \begin_layout Plain Layout
24965 \change_deleted -712698321 1607682984
24967 \begin_inset Flex Code
24970 \begin_layout Plain Layout
24979 \begin_inset Flex Code
24982 \begin_layout Plain Layout
24989 \begin_inset Flex Code
24992 \begin_layout Plain Layout
24999 \begin_inset Flex Code
25002 \begin_layout Plain Layout
25009 \begin_inset Flex Code
25012 \begin_layout Plain Layout
25019 \begin_inset Flex Code
25022 \begin_layout Plain Layout
25029 \begin_inset Flex Code
25032 \begin_layout Plain Layout
25039 \begin_inset Flex Code
25042 \begin_layout Plain Layout
25049 \begin_inset Flex Code
25052 \begin_layout Plain Layout
25059 \begin_inset Flex Code
25062 \begin_layout Plain Layout
25069 \begin_inset Flex Code
25072 \begin_layout Plain Layout
25079 \begin_inset Flex Code
25082 \begin_layout Plain Layout
25089 \begin_inset Flex Code
25092 \begin_layout Plain Layout
25099 \begin_inset Flex Code
25102 \begin_layout Plain Layout
25109 \begin_inset Flex Code
25112 \begin_layout Plain Layout
25119 \begin_inset Flex Code
25122 \begin_layout Plain Layout
25129 \begin_inset Flex Code
25132 \begin_layout Plain Layout
25139 \begin_inset Flex Code
25142 \begin_layout Plain Layout
25149 \begin_inset Flex Code
25152 \begin_layout Plain Layout
25159 \begin_inset Flex Code
25162 \begin_layout Plain Layout
25169 \change_inserted -712698321 1607683139
25171 \begin_inset Flex Code
25174 \begin_layout Plain Layout
25176 \change_inserted -712698321 1607683135
25185 \begin_inset space ~
25189 \begin_inset CommandInset ref
25191 reference "chap:Names-of-colors"
25199 \change_deleted -712698321 1607683144
25201 \change_inserted -712698321 1607683146
25207 \begin_layout Description
25208 \begin_inset Flex Code
25211 \begin_layout Plain Layout
25218 \begin_inset Flex Code
25221 \begin_layout Plain Layout
25230 \begin_inset Flex Code
25233 \begin_layout Plain Layout
25240 \begin_inset Flex Code
25243 \begin_layout Plain Layout
25252 \begin_layout Description
25253 \begin_inset Flex Code
25256 \begin_layout Plain Layout
25263 \begin_inset Flex Code
25266 \begin_layout Plain Layout
25272 ] Valid arguments are:
25273 \begin_inset Flex Code
25276 \begin_layout Plain Layout
25283 \begin_inset Flex Code
25286 \begin_layout Plain Layout
25293 \begin_inset Flex Code
25296 \begin_layout Plain Layout
25303 \begin_inset Flex Code
25306 \begin_layout Plain Layout
25313 \begin_inset Flex Code
25316 \begin_layout Plain Layout
25323 \begin_inset Flex Code
25326 \begin_layout Plain Layout
25333 \begin_inset Flex Code
25336 \begin_layout Plain Layout
25343 \begin_inset Flex Code
25346 \begin_layout Plain Layout
25353 \begin_inset Flex Code
25356 \begin_layout Plain Layout
25363 \begin_inset Flex Code
25366 \begin_layout Plain Layout
25373 \begin_inset Flex Code
25376 \begin_layout Plain Layout
25383 \begin_inset Flex Code
25386 \begin_layout Plain Layout
25393 Each of these turns on or off the corresponding attribute.
25395 \begin_inset Flex Code
25398 \begin_layout Plain Layout
25404 turns on emphasis, and
25405 \begin_inset Flex Code
25408 \begin_layout Plain Layout
25416 \begin_inset Newline newline
25419 If the latter seems puzzling, remember that the font settings for the present
25420 context are generally inherited from the surrounding context.
25422 \begin_inset Flex Code
25425 \begin_layout Plain Layout
25431 would turn off the emphasis that was anyway in effect, say, in a theorem
25435 \begin_layout Description
25436 \begin_inset Flex Code
25439 \begin_layout Plain Layout
25446 \begin_inset Flex Code
25449 \begin_layout Plain Layout
25458 \begin_inset Flex Code
25461 \begin_layout Plain Layout
25470 \begin_layout Description
25471 \begin_inset Flex Code
25474 \begin_layout Plain Layout
25481 \begin_inset Flex Code
25484 \begin_layout Plain Layout
25493 \begin_inset Flex Code
25496 \begin_layout Plain Layout
25503 \begin_inset Flex Code
25506 \begin_layout Plain Layout
25513 \begin_inset Flex Code
25516 \begin_layout Plain Layout
25525 \begin_layout Description
25526 \begin_inset Flex Code
25529 \begin_layout Plain Layout
25536 \begin_inset Flex Code
25539 \begin_layout Plain Layout
25546 \begin_inset Flex Code
25549 \begin_layout Plain Layout
25556 \begin_inset Flex Code
25559 \begin_layout Plain Layout
25568 \begin_inset Flex Code
25571 \begin_layout Plain Layout
25578 \begin_inset Flex Code
25581 \begin_layout Plain Layout
25588 \begin_inset Flex Code
25591 \begin_layout Plain Layout
25598 \begin_inset Flex Code
25601 \begin_layout Plain Layout
25608 \begin_inset Flex Code
25611 \begin_layout Plain Layout
25620 \begin_layout Subsection
25621 \begin_inset CommandInset label
25623 name "subsec:Citation-engine-description"
25627 Cite engine description
25630 \begin_layout Standard
25632 \begin_inset Flex Code
25635 \begin_layout Plain Layout
25641 blocks, as used mainly in cite engine files (see
25642 \begin_inset CommandInset ref
25644 reference "subsec:Cite-Engine-Files"
25651 ), define the citation commands provided by a specific
25652 \begin_inset Quotes eld
25656 \begin_inset Quotes erd
25660 A cite engine, in \SpecialChar LyX
25661 terms, is way specific way to format citations, using
25662 numbers, author names and/or years.
25663 Currently, \SpecialChar LyX
25664 supports three such engine types, namely:
25667 \begin_layout Enumerate
25668 \begin_inset Flex Code
25671 \begin_layout Plain Layout
25677 : the default Bib\SpecialChar TeX
25678 way to format citations, a simple numeric style (e.
25679 \begin_inset space \thinspace{}
25683 \begin_inset Quotes eld
25687 \begin_inset Quotes erd
25693 \begin_layout Enumerate
25694 \begin_inset Flex Code
25697 \begin_layout Plain Layout
25703 : Harvard-styled citations using author names and publication year (e.
25704 \begin_inset space \thinspace{}
25708 \begin_inset Quotes eld
25711 Smith and Miller (2017b)
25712 \begin_inset Quotes erd
25718 \begin_layout Enumerate
25719 \begin_inset Flex Code
25722 \begin_layout Plain Layout
25728 : extended numerical citations that also allow for author or title next
25730 \begin_inset space \thinspace{}
25734 \begin_inset Quotes eld
25737 Smith and Miller [1]
25738 \begin_inset Quotes erd
25744 \begin_layout Standard
25745 \begin_inset Flex Code
25748 \begin_layout Plain Layout
25754 blocks look like this:
25757 \begin_layout LyX-Code
25761 \begin_layout LyX-Code
25765 \begin_layout LyX-Code
25769 \begin_layout LyX-Code
25770 citeyearpar[][]=parencite*
25773 \begin_layout LyX-Code
25777 \begin_layout LyX-Code
25781 \begin_layout Standard
25783 \begin_inset Flex Code
25786 \begin_layout Plain Layout
25792 denotes the engine.
25793 The individual lines respectively define a cite command or cite command
25794 paradigm supported by this engine.
25795 The line can be as simple as a cite command that is used both to name the
25796 respective \SpecialChar LyX
25797 command and the \SpecialChar LaTeX
25798 output or more complex in order to differentiate
25800 The full syntax is:
25803 \begin_layout LyX-Code
25804 LyXName|alias$*<!_stardesc!_stardesctooltip>[][]=latexcmd
25807 \begin_layout Itemize
25808 \begin_inset Flex Code
25811 \begin_layout Plain Layout
25817 : The name as used in the
25818 \begin_inset Flex Code
25821 \begin_layout Plain Layout
25831 \begin_layout Standard
25832 For portability reasons, we try to use the same name for same-formatted
25833 commands in different cite packages (thus many names stem from natbib,
25834 and thus we need to differentiate a
25835 \begin_inset Flex Code
25838 \begin_layout Plain Layout
25844 sometimes, if the \SpecialChar LaTeX
25845 command names differ).
25849 \begin_layout Itemize
25850 \begin_inset Flex Code
25853 \begin_layout Plain Layout
25859 : a (comma-separated) list of commands that fall back to the given
25860 \begin_inset Flex Code
25863 \begin_layout Plain Layout
25869 in the current engine.
25870 This eases the switch of citation packages and engines.
25872 \begin_inset Flex Code
25875 \begin_layout Plain Layout
25882 \begin_inset Flex Code
25885 \begin_layout Plain Layout
25891 in layout definitions.
25894 \begin_layout Itemize
25895 \begin_inset Flex Code
25898 \begin_layout Plain Layout
25904 : The actual \SpecialChar LaTeX
25905 command that is output.
25909 \begin_layout Standard
25910 \begin_inset Flex Code
25913 \begin_layout Plain Layout
25920 \begin_inset Flex Code
25923 \begin_layout Plain Layout
25931 \begin_inset Flex Code
25934 \begin_layout Plain Layout
25941 \begin_inset Flex Code
25944 \begin_layout Plain Layout
25950 will be output to \SpecialChar LaTeX
25954 \begin_layout Standard
25958 \begin_layout Itemize
25959 Capitalization indicates that the command also has a capitalized form (
25960 \begin_inset Flex Code
25963 \begin_layout Plain Layout
25973 \begin_inset Flex Code
25976 \begin_layout Plain Layout
25985 These usually enforce up-casing of name prefixes (
25990 \begin_inset Formula $\Rightarrow$
26000 \begin_layout Itemize
26002 \begin_inset Flex Code
26005 \begin_layout Plain Layout
26011 indicate the number of optional arguments (there can be 0–2).
26014 \begin_layout Itemize
26016 \begin_inset Flex Code
26019 \begin_layout Plain Layout
26025 indicates there is a starred version of the command (
26026 \begin_inset Flex Code
26029 \begin_layout Plain Layout
26039 \begin_inset Flex Code
26042 \begin_layout Plain Layout
26055 \begin_layout Standard
26056 By default, the starred version means: Output all authors even if it should
26058 \begin_inset Quotes eld
26062 \begin_inset Quotes erd
26066 \begin_inset Flex Code
26069 \begin_layout Plain Layout
26078 \begin_layout Standard
26079 If the star has a different meaning for a given command, it can be specified
26081 \begin_inset Flex Code
26084 \begin_layout Plain Layout
26085 <!_stardesc!_stardesctooltip>
26091 Maximal two translatable macro keywords, marked by the prefix
26092 \begin_inset Flex Code
26095 \begin_layout Plain Layout
26102 The first points to the string that replaces the
26103 \begin_inset Quotes eld
26107 \begin_inset Quotes erd
26110 checkbox label in the citation dialog, the second one to an optional tool
26111 tip for this checkbox.
26115 \begin_layout Standard
26116 Note that these two macros have to be defined in a
26117 \begin_inset Flex Code
26120 \begin_layout Plain Layout
26126 (see next section), dropping the
26127 \begin_inset Flex Code
26130 \begin_layout Plain Layout
26136 from the prefix, like this:
26139 \begin_layout LyX-Code
26140 _stardesc Sta&rred command label
26143 \begin_layout LyX-Code
26144 _stardesctooltip Tooltip for the starred command checkbox.
26148 \begin_layout Itemize
26150 \begin_inset Flex Code
26153 \begin_layout Plain Layout
26159 indicates that this command features
26160 \begin_inset Quotes eld
26163 qualified citation lists
26164 \begin_inset Quotes erd
26172 -specific feature for multi-reference citations where an individual pre-
26173 and postnote can be given to each reference in the list.
26174 Please refer to the
26178 manual for details.
26179 \change_inserted -712698321 1526898670
26183 \begin_layout Standard
26185 \change_inserted -712698321 1526899524
26186 If you want to add a cite command to a cite engine (e.
26187 \begin_inset space \thinspace{}
26190 g., add a specific command provided by a class), you can use
26191 \begin_inset Flex Code
26194 \begin_layout Plain Layout
26196 \change_inserted -712698321 1526898768
26197 AddToCiteEngine <engine type> \SpecialChar ldots
26206 Note that only cite commands that do not exist yet are added.
26211 \begin_layout Subsection
26212 \begin_inset CommandInset label
26214 name "subsec:Citation-format-description"
26218 Cite format description
26221 \begin_layout Standard
26223 \begin_inset Flex Code
26226 \begin_layout Plain Layout
26232 blocks are used to describe how bibliographic information should be displayed,
26233 both within \SpecialChar LyX
26234 itself (in the citation dialog and in tooltips, for example)
26235 and in XHTML output.
26236 Such a block might look like this:
26239 \begin_layout LyX-Code
26243 \begin_layout LyX-Code
26247 \begin_layout LyX-Code
26251 \begin_layout LyX-Code
26255 \begin_layout Standard
26259 \begin_layout LyX-Code
26263 \begin_layout LyX-Code
26267 \begin_layout LyX-Code
26271 \begin_layout LyX-Code
26275 \begin_layout Standard
26276 In the first case, the individual lines define how the bibliographic information
26277 associated with an article or book, respectively, is to be displayed, and
26278 such a definition can be given for any
26279 \begin_inset Quotes els
26283 \begin_inset Quotes ers
26286 that might be present in a Bib\SpecialChar TeX
26289 defines a default format in the source code that will be used if no specific
26290 definition has been given.
26292 predefines several formats in the file
26293 \begin_inset Flex Code
26296 \begin_layout Plain Layout
26302 , which is included in most of \SpecialChar LyX
26303 's document classes.
26306 \begin_layout Standard
26307 In the second case, the lines define how a specific citation command (in
26309 \begin_inset Flex Code
26312 \begin_layout Plain Layout
26321 \begin_inset Flex Code
26324 \begin_layout Plain Layout
26332 ) is to be displayed on the citation inset label, in the citation dialog,
26333 menu or XHTML output.
26335 defines such formats for the citation style variants it supports via
26337 Document\SpecialChar menuseparator
26338 Setting\SpecialChar menuseparator
26339 Bibliography\SpecialChar ldots
26343 \begin_inset Flex Code
26346 \begin_layout Plain Layout
26352 files that are shipped with \SpecialChar LyX
26354 \begin_inset CommandInset ref
26356 reference "subsec:Cite-Engine-Files"
26366 \begin_layout Standard
26367 The definitions use a simple language that allows Bib\SpecialChar TeX
26368 keys to be replaced
26370 Keys should be enclosed in
26371 \begin_inset Flex Code
26374 \begin_layout Plain Layout
26381 \begin_inset Flex Code
26384 \begin_layout Plain Layout
26391 So a simple definition might look like this:
26394 \begin_layout LyX-Code
26396 \begin_inset Quotes eld
26400 \begin_inset Quotes erd
26406 \begin_layout Standard
26407 This would print the author, followed by a comma, followed by the title,
26408 in quotes, followed by a period.
26411 \begin_layout Standard
26412 Of course, sometimes you may want to print a key only if it exists.
26413 This can be done by using a conditional construction, such as:
26414 \begin_inset Flex Code
26417 \begin_layout Plain Layout
26419 \begin_inset space ~
26429 \begin_inset Flex Code
26432 \begin_layout Plain Layout
26438 key exists, then print
26439 \begin_inset Quotes eld
26443 \begin_inset space ~
26447 \begin_inset Quotes erd
26450 followed by the volume key.
26451 It is also possible to have an else clause in the conditional, such as:
26452 \begin_inset Newline newline
26456 \begin_inset Flex Code
26459 \begin_layout Plain Layout
26460 {%author%[[%author%]][[%editor%, ed.]]}
26466 \begin_inset Newline newline
26470 \begin_inset Flex Code
26473 \begin_layout Plain Layout
26479 key is printed if it exists; otherwise, the editor key is printed, followed
26481 \begin_inset Quotes eld
26485 \begin_inset space ~
26489 \begin_inset Quotes erd
26492 Note that the key is again enclosed in
26493 \begin_inset Flex Code
26496 \begin_layout Plain Layout
26502 signs; the entire conditional is enclosed in braces; and the if and else
26503 clauses are enclosed in double brackets,
26504 \begin_inset Quotes eld
26508 \begin_inset Flex Code
26511 \begin_layout Plain Layout
26518 \begin_inset Quotes eld
26522 \begin_inset Quotes eld
26526 \begin_inset Flex Code
26529 \begin_layout Plain Layout
26536 \begin_inset Quotes erd
26540 There must be no space between any of these.
26543 \begin_layout Standard
26544 Next to the entry keys, there are some special keys that can be used for
26545 these conditionals:
26548 \begin_layout Itemize
26549 \begin_inset Flex Code
26552 \begin_layout Plain Layout
26553 {%dialog%[[true]][[false]]}
26559 \begin_inset Quotes eld
26563 \begin_inset Quotes erd
26566 part for dialogs and menus, the
26567 \begin_inset Quotes eld
26571 \begin_inset Quotes erd
26574 part for other contexts (workarea, export)
26577 \begin_layout Itemize
26578 \begin_inset Flex Code
26581 \begin_layout Plain Layout
26582 {%export%[[true]][[false]]}
26588 \begin_inset Quotes eld
26592 \begin_inset Quotes erd
26595 part for export and menus, the
26596 \begin_inset Quotes eld
26600 \begin_inset Quotes erd
26603 part for other contexts (workarea, dialog)
26606 \begin_layout Itemize
26607 \begin_inset Flex Code
26610 \begin_layout Plain Layout
26617 \begin_inset Quotes eld
26621 \begin_inset Quotes erd
26624 part if another item follows (e.
26625 \begin_inset space \thinspace{}
26628 g., in a citation with multiple keys)
26631 \begin_layout Itemize
26632 \begin_inset Flex Code
26635 \begin_layout Plain Layout
26636 {%second%[[true]][[false]]}
26642 \begin_inset Quotes eld
26646 \begin_inset Quotes erd
26649 if this is the second of multiple items, else the
26650 \begin_inset Quotes eld
26654 \begin_inset Quotes erd
26660 \begin_layout Itemize
26661 \begin_inset Flex Code
26664 \begin_layout Plain Layout
26665 {%ifstar%[[true]][[false]]}
26671 \begin_inset Quotes eld
26675 \begin_inset Quotes erd
26678 part for starred citation commands (such as
26679 \begin_inset Flex Code
26682 \begin_layout Plain Layout
26690 ), the false part for unstarred
26693 \begin_layout Itemize
26694 \begin_inset Flex Code
26697 \begin_layout Plain Layout
26698 {%ifentrytype:<type>%[[true]][[false]]}
26704 \begin_inset Quotes eld
26708 \begin_inset Quotes erd
26711 if the current entry type matches
26712 \begin_inset Flex Code
26715 \begin_layout Plain Layout
26721 , else the false part (e.g., in a citation definition:
26722 \begin_inset Flex Code
26725 \begin_layout Plain Layout
26726 {%ifentrytype:book%[[this is a book]][[this is no book]]}
26734 \begin_layout Itemize
26735 \begin_inset Flex Code
26738 \begin_layout Plain Layout
26739 {%ifmultiple:<authortype>%[[true]][[false]]}
26745 \begin_inset Quotes eld
26749 \begin_inset Quotes erd
26752 if the current author type (author, editor etc.) has multiple authors, else
26753 the false part (e.g., in a bibliography definition:
26754 \begin_inset Flex Code
26757 \begin_layout Plain Layout
26758 {%ifmultiple:editor%[[eds.]][[ed.]]}
26766 \begin_layout Itemize
26767 \begin_inset Flex Code
26770 \begin_layout Plain Layout
26771 {%ifqualified%[[true]][[false]]}
26777 \begin_inset Quotes eld
26781 \begin_inset Quotes erd
26784 part if the current citation is a qualified citation list (a specific
26788 format for multi-reference citations), the false part if this is not the
26792 \begin_layout Standard
26794 \begin_inset Flex Code
26797 \begin_layout Plain Layout
26803 prints the author key as it is recorded in the bibliography file.
26804 This might not be what you want, since it will result in a string such
26806 \begin_inset Quotes eld
26809 Miller, Peter and Smith, Mary and White, Jane
26810 \begin_inset Quotes erd
26814 \begin_inset Quotes eld
26818 \begin_inset Quotes erd
26821 is used by Bib\SpecialChar TeX
26822 to delimit authors).
26824 therefore provides some methods to get properly formatted name lists (which
26825 will also get translated).
26826 The following keys are provided:
26829 \begin_layout Enumerate
26830 For name lists with pre- and surname, suitable for the main authors/editors
26831 of a bibliography item.
26833 \begin_inset Flex Code
26836 \begin_layout Plain Layout
26842 part denotes the kind of list that is requested (e.g.
26844 \begin_inset Flex Code
26847 \begin_layout Plain Layout
26857 \begin_layout Itemize
26858 \begin_inset Flex Code
26861 \begin_layout Plain Layout
26862 %abbrvnames:<nametype>%
26867 : Provides a name list which is abbreviated (with
26868 \begin_inset Quotes eld
26872 \begin_inset Quotes erd
26876 \begin_inset Flex Code
26879 \begin_layout Plain Layout
26888 \begin_layout Itemize
26889 \begin_inset Flex Code
26892 \begin_layout Plain Layout
26893 %fullnames:<nametype>%
26898 : Provides a full name list (never abbreviated with
26899 \begin_inset Quotes eld
26903 \begin_inset Quotes erd
26909 \begin_layout Itemize
26910 \begin_inset Flex Code
26913 \begin_layout Plain Layout
26914 %forceabbrvnames:<nametype>%
26919 : Provides a name list which is always abbreviated (with
26920 \begin_inset Quotes eld
26924 \begin_inset Quotes erd
26928 \begin_inset Flex Code
26931 \begin_layout Plain Layout
26941 \begin_layout Enumerate
26942 Alternative name lists with pre- and surname, if the order of pre- and surname
26943 inside the bibliography item differs (as in:
26944 \begin_inset Quotes eld
26947 Miller, John: Some text, in: Mary Smith, ed.: A volume
26948 \begin_inset Quotes erd
26955 \begin_layout Itemize
26956 \begin_inset Flex Code
26959 \begin_layout Plain Layout
26960 %abbrvbynames:<nametype>%
26965 : Provides a name list which is abbreviated (with
26966 \begin_inset Quotes eld
26970 \begin_inset Quotes erd
26974 \begin_inset Flex Code
26977 \begin_layout Plain Layout
26986 \begin_layout Itemize
26987 \begin_inset Flex Code
26990 \begin_layout Plain Layout
26991 %fullbynames:<nametype>%
26996 : Provides a full name list (never abbreviated with
26997 \begin_inset Quotes eld
27001 \begin_inset Quotes erd
27007 \begin_layout Itemize
27008 \begin_inset Flex Code
27011 \begin_layout Plain Layout
27012 %forceabbrvbynames:<nametype>%
27017 : Provides a name list which is always abbreviated (with
27018 \begin_inset Quotes eld
27022 \begin_inset Quotes erd
27026 \begin_inset Flex Code
27029 \begin_layout Plain Layout
27039 \begin_layout Enumerate
27040 And finally name lists which consist of family names only, as used in author-yea
27042 These do not take a
27043 \begin_inset Flex Code
27046 \begin_layout Plain Layout
27052 part, but always return either an author list or, if this does not exist,
27053 an editor list (as common in author-year labels):
27057 \begin_layout Itemize
27058 \begin_inset Flex Code
27061 \begin_layout Plain Layout
27067 : Provides a name list which is abbreviated (with
27068 \begin_inset Quotes eld
27072 \begin_inset Quotes erd
27076 \begin_inset Flex Code
27079 \begin_layout Plain Layout
27088 \begin_layout Itemize
27089 \begin_inset Flex Code
27092 \begin_layout Plain Layout
27098 : Provides a full name list (never abbreviated with
27099 \begin_inset Quotes eld
27103 \begin_inset Quotes erd
27109 \begin_layout Itemize
27110 \begin_inset Flex Code
27113 \begin_layout Plain Layout
27114 %forceabbrvciteauthor%
27119 : Provides a name list which is always abbreviated (with
27120 \begin_inset Quotes eld
27124 \begin_inset Quotes erd
27128 \begin_inset Flex Code
27131 \begin_layout Plain Layout
27141 \begin_layout Standard
27142 The order of pre- and surname in the former two lists can be adjusted by
27146 \begin_layout Itemize
27147 \begin_inset Flex Code
27150 \begin_layout Plain Layout
27151 !firstnameform %surname%, %prename%
27156 (first author in lists of type 1)
27159 \begin_layout Itemize
27160 \begin_inset Flex Code
27163 \begin_layout Plain Layout
27164 !othernameform %surname%, %prename%
27169 (other authors in lists of type 1)
27172 \begin_layout Itemize
27173 \begin_inset Flex Code
27176 \begin_layout Plain Layout
27177 !firstbynameform %prename% %surname%
27182 (first author in lists of type 2)
27185 \begin_layout Itemize
27186 \begin_inset Flex Code
27189 \begin_layout Plain Layout
27190 !otherbynameform %prename% %surname%
27195 (other authors in lists of type 2)
27198 \begin_layout Standard
27199 This allows you to configure namings like
27200 \begin_inset Quotes eld
27203 Miller, Peter and Mary Smith: \SpecialChar ldots
27204 , in: John Doe and Pat Green, eds.:\SpecialChar ldots
27206 \begin_inset Quotes erd
27212 \begin_layout Standard
27213 There is one other piece of syntax available in definitions, which looks
27215 \begin_inset Flex Code
27218 \begin_layout Plain Layout
27225 This defines a piece of formatting information that is to be used when
27227 \begin_inset Quotes eld
27231 \begin_inset Quotes erd
27235 Obviously, we do not want to output HTML tags when writing plain text,
27236 so they should be wrapped in
27237 \begin_inset Quotes eld
27241 \begin_inset Quotes erd
27245 \begin_inset Quotes eld
27249 \begin_inset Quotes erd
27255 \begin_layout Standard
27256 Two special sorts of definitions are also possible in a
27257 \begin_inset Flex Code
27260 \begin_layout Plain Layout
27267 An example of the first would be:
27270 \begin_layout LyX-Code
27272 \begin_inset Quotes eld
27276 \begin_inset Quotes erd
27282 \begin_layout Standard
27283 This is an abbreviation, or macro, and it can be used by treating it as
27285 \begin_inset Flex Code
27288 \begin_layout Plain Layout
27297 \begin_inset Flex Code
27300 \begin_layout Plain Layout
27306 exactly as it would treat its definition.
27307 So, let us issue the obvious
27315 \begin_layout LyX-Code
27319 \begin_layout Standard
27320 or anything like it.
27322 shouldn't go into an infinite loop, but it may go into a long one before
27326 \begin_layout Standard
27327 The second sort of special definition might look like this:
27330 \begin_layout LyX-Code
27334 \begin_layout Standard
27335 This defines a translatable piece of text, which allows relevant parts of
27336 the bibliography or citation to be translated.
27337 It can be included in a definition by treating it as a key:
27338 \begin_inset Flex Code
27341 \begin_layout Plain Layout
27348 Note that there are two different translation paths: All definitions starting
27350 \begin_inset Flex Code
27353 \begin_layout Plain Layout
27359 , such as in the example above, will be translated to the currently active
27360 buffer language (so the translation will match the generated document).
27361 All definitions starting with underscore only will be translated to the
27363 This is the proper translation for strings that only occur in the dialogs
27364 or on buttons, such as this one:
27367 \begin_layout LyX-Code
27368 _addtobib Add to bibliography only.
27371 \begin_layout Standard
27372 Several of these translatable strings are predefined in
27373 \begin_inset Flex Code
27376 \begin_layout Plain Layout
27383 \begin_inset Flex Code
27386 \begin_layout Plain Layout
27393 Note that these are not macros, in the sense just defined.
27394 They will not be expanded.
27397 \begin_layout Standard
27398 So here then is an example that uses several of these features:
27399 \begin_inset VSpace defskip
27405 \begin_layout Standard
27409 !authoredit {%author%[[%author%, ]][[{%editor%[[%editor%, %B_edtext%, ]]}]]}
27412 \begin_layout Standard
27413 \begin_inset VSpace defskip
27416 This defines a macro that prints the author, followed by a comma, if the
27418 \begin_inset Flex Code
27421 \begin_layout Plain Layout
27427 key is defined, or else prints the name of the editor, followed by the
27429 \begin_inset Flex Code
27432 \begin_layout Plain Layout
27438 or its translation (it is by default
27439 \begin_inset Quotes eld
27443 \begin_inset Quotes erd
27447 \begin_inset Flex Code
27450 \begin_layout Plain Layout
27457 Note that this is in fact defined in
27458 \begin_inset Flex Code
27461 \begin_layout Plain Layout
27467 , so you can use it in your own definitions, or re-definitions, if you load
27471 \begin_layout Section
27472 \begin_inset CommandInset label
27474 name "sec:Tags-for-XHTML"
27478 Tags for XHTML output
27481 \begin_layout Standard
27482 As with \SpecialChar LaTeX
27483 or DocBook, the format of \SpecialChar LyX
27484 's XHTML output is also controlled by
27485 layout information.
27486 In general, \SpecialChar LyX
27487 provides sensible defaults and, as mentioned earlier, it will
27488 even construct default CSS style rules from the other layout tags.
27489 For example, \SpecialChar LyX
27490 will attempt to use the information provided in the
27491 \begin_inset Flex Code
27494 \begin_layout Plain Layout
27500 declaration for the Chapter style to write CSS that will appropriately
27501 format chapter headings.
27504 \begin_layout Standard
27505 In many cases, then, you may not have to do anything at all to get acceptable
27506 XHTML output for your own environments, custom insets, and so forth.
27507 But in some cases you will, and so \SpecialChar LyX
27508 provides a number of layout tags that
27509 can be used to customize the XHTML and CSS that are generated.
27512 \begin_layout Standard
27513 Note that there are two tags,
27514 \begin_inset Flex Code
27517 \begin_layout Plain Layout
27524 \begin_inset Flex Code
27527 \begin_layout Plain Layout
27533 that may appear outside style and inset declarations.
27535 \begin_inset CommandInset ref
27537 reference "subsec:General-text-class"
27541 for details on these.
27544 \begin_layout Subsection
27545 \begin_inset CommandInset label
27547 name "subsec:Paragraph-Style-XHTML"
27554 \begin_layout Standard
27555 The sort of XHTML \SpecialChar LyX
27556 outputs for a paragraph depends upon whether we are dealing
27557 with a normal paragraph, a command, or an environment, where this is itself
27558 determined by the contents of the corresponding
27559 \begin_inset Flex Code
27562 \begin_layout Plain Layout
27573 \begin_layout Standard
27574 For a command or normal paragraph, the output XHTML has the following form:
27577 \begin_layout LyX-Code
27581 \begin_inset Quotes erd
27585 \begin_inset Quotes erd
27591 \begin_layout LyX-Code
27595 \begin_inset Quotes erd
27599 \begin_inset Quotes erd
27605 \begin_layout LyX-Code
27608 Contents of the paragraph.
27611 \begin_layout LyX-Code
27617 \begin_layout Standard
27618 The label tags are of course omitted if the paragraph does not have a label.
27621 \begin_layout Standard
27622 For an environment that is not some sort of list, the XHTML takes this form:
27625 \begin_layout LyX-Code
27629 \begin_inset Quotes erd
27633 \begin_inset Quotes erd
27639 \begin_layout LyX-Code
27643 \begin_inset Quotes erd
27647 \begin_inset Quotes erd
27651 \begin_inset Quotes erd
27655 \begin_inset Quotes erd
27658 >Environment Label</labeltag>First paragraph.</itemtag>
27661 \begin_layout LyX-Code
27664 <itemtag>Second paragraph.</itemtag>
27667 \begin_layout LyX-Code
27673 \begin_layout Standard
27674 Note that the label is output only for the first paragraph, as it should
27675 be for a theorem, for example.
27679 \begin_layout Standard
27680 For a list, we have one of these forms:
27683 \begin_layout LyX-Code
27687 \begin_inset Quotes erd
27691 \begin_inset Quotes erd
27697 \begin_layout LyX-Code
27701 \begin_inset Quotes erd
27705 \begin_inset Quotes erd
27709 \begin_inset Quotes erd
27713 \begin_inset Quotes erd
27716 >List Label</labeltag>First item.</itemtag>
27719 \begin_layout LyX-Code
27723 \begin_inset Quotes erd
27727 \begin_inset Quotes erd
27731 \begin_inset Quotes erd
27735 \begin_inset Quotes erd
27738 >List Label</labeltag>Second item.</itemtag>
27741 \begin_layout LyX-Code
27747 \begin_layout LyX-Code
27751 \begin_layout LyX-Code
27755 \begin_inset Quotes erd
27759 \begin_inset Quotes erd
27765 \begin_layout LyX-Code
27769 \begin_inset Quotes erd
27773 \begin_inset Quotes erd
27776 >List Label</labeltag><itemtag attr=
27777 \begin_inset Quotes erd
27781 \begin_inset Quotes erd
27784 >First item.</itemtag>
27787 \begin_layout LyX-Code
27791 \begin_inset Quotes erd
27795 \begin_inset Quotes erd
27798 >List Label</labeltag><itemtag attr=
27799 \begin_inset Quotes erd
27803 \begin_inset Quotes erd
27806 >Second item.</itemtag>
27809 \begin_layout LyX-Code
27815 \begin_layout Standard
27816 Note the different orders of
27817 \begin_inset Flex Code
27820 \begin_layout Plain Layout
27827 \begin_inset Flex Code
27830 \begin_layout Plain Layout
27837 Which order we get depends upon the setting of
27838 \begin_inset Flex Code
27841 \begin_layout Plain Layout
27848 \begin_inset Flex Code
27851 \begin_layout Plain Layout
27857 is false (the default), you get the first of these, with the label within
27858 the item; if true, you get the second, with the label outside the item.
27861 \begin_layout Standard
27862 The specific tags and attributes output for each paragraph type can be controlle
27863 d by means of the layout tags we are about to describe.
27864 As mentioned earlier, however, \SpecialChar LyX
27865 uses sensible defaults for many of these,
27866 so you often may not need to do very much to get good XHTML output.
27867 Think of the available tags as there so you can tweak things to your liking.
27870 \begin_layout Description
27871 \begin_inset Flex Code
27874 \begin_layout Plain Layout
27881 \begin_inset Flex Code
27884 \begin_layout Plain Layout
27890 ] Specifies attribute information to be output with the main tag.
27892 \begin_inset Quotes eld
27896 \begin_inset Flex Code
27899 \begin_layout Plain Layout
27906 \begin_inset Quotes erd
27910 By default, \SpecialChar LyX
27912 \begin_inset Quotes eld
27916 \begin_inset Flex Code
27919 \begin_layout Plain Layout
27926 \begin_inset Quotes erd
27930 \begin_inset Flex Code
27933 \begin_layout Plain Layout
27939 is the \SpecialChar LyX
27940 name of the layout, made lowercase, for example: chapter.
27945 contain any style information.
27947 \begin_inset Flex Code
27950 \begin_layout Plain Layout
27959 \begin_layout Description
27960 \begin_inset Flex Code
27963 \begin_layout Plain Layout
27970 \begin_inset Flex Code
27973 \begin_layout Plain Layout
27983 ] Whether to output the default CSS information \SpecialChar LyX
27984 generates for this layout,
27985 even if additional information is explicitly provided via
27986 \begin_inset Flex Code
27989 \begin_layout Plain Layout
27997 \begin_inset Flex Code
28000 \begin_layout Plain Layout
28006 allows you to alter or augment the generated CSS, rather than to override
28009 \begin_inset Flex Code
28012 \begin_layout Plain Layout
28021 \begin_layout Description
28022 \begin_inset Flex Code
28025 \begin_layout Plain Layout
28032 \begin_inset Flex Code
28035 \begin_layout Plain Layout
28041 ] The tag to be used for individual paragraphs of environments, replacing
28043 \begin_inset Flex Code
28046 \begin_layout Plain Layout
28052 in the examples above.
28054 \begin_inset Flex Code
28057 \begin_layout Plain Layout
28066 \begin_layout Description
28067 \begin_inset Flex Code
28070 \begin_layout Plain Layout
28077 \begin_inset Flex Code
28080 \begin_layout Plain Layout
28086 ] Attributes for the item tag.
28088 \begin_inset Newline newline
28092 \begin_inset Quotes eld
28096 \begin_inset Flex Code
28099 \begin_layout Plain Layout
28100 class=`layoutname_item'
28106 \begin_inset Quotes erd
28114 contain any style information.
28116 \begin_inset Flex Code
28119 \begin_layout Plain Layout
28128 \begin_layout Description
28129 \begin_inset Flex Code
28132 \begin_layout Plain Layout
28139 \begin_inset Flex Code
28142 \begin_layout Plain Layout
28148 ] The tag to be used for paragraph and item labels, replacing
28149 \begin_inset Flex Code
28152 \begin_layout Plain Layout
28158 in the examples above.
28160 \begin_inset Flex Code
28163 \begin_layout Plain Layout
28170 \begin_inset Flex Code
28173 \begin_layout Plain Layout
28180 \begin_inset Flex Code
28183 \begin_layout Plain Layout
28190 \begin_inset Flex Code
28193 \begin_layout Plain Layout
28194 Centered_Top_Environment
28199 , in which case it defaults to
28200 \begin_inset Flex Code
28203 \begin_layout Plain Layout
28212 \begin_layout Description
28213 \begin_inset Flex Code
28216 \begin_layout Plain Layout
28223 \begin_inset Flex Code
28226 \begin_layout Plain Layout
28232 ] Attributes for the label tag.
28234 \begin_inset Newline newline
28238 \begin_inset Quotes eld
28242 \begin_inset Flex Code
28245 \begin_layout Plain Layout
28246 class=`layoutname_label'
28252 \begin_inset Quotes erd
28260 contain any style information.
28262 \begin_inset Flex Code
28265 \begin_layout Plain Layout
28274 \begin_layout Description
28275 \begin_inset Flex Code
28278 \begin_layout Plain Layout
28285 \begin_inset Flex Code
28288 \begin_layout Plain Layout
28298 ] Meaningful only for list-like environments, this tag controls whether
28299 the label tag is output before or inside the item tag.
28300 This is used, for example, in the description environment, where we want
28302 \begin_inset Flex Code
28305 \begin_layout Plain Layout
28306 <dt>\SpecialChar ldots
28307 </dt><dd>\SpecialChar ldots
28315 \begin_inset Flex Code
28318 \begin_layout Plain Layout
28324 : The label tag is output inside the item tag.
28327 \begin_layout Description
28328 \begin_inset Flex Code
28331 \begin_layout Plain Layout
28337 Information to be output in the
28338 \begin_inset Flex Code
28341 \begin_layout Plain Layout
28347 section when this style is used.
28348 This might, for example, be used to include a
28349 \begin_inset Flex Code
28352 \begin_layout Plain Layout
28359 \begin_inset Flex Code
28362 \begin_layout Plain Layout
28371 \begin_layout Description
28372 \begin_inset Flex Code
28375 \begin_layout Plain Layout
28381 CSS style information to be included when this style is used.
28382 Note that this will automatically be wrapped in a layout-generated
28383 \begin_inset Flex Code
28386 \begin_layout Plain Layout
28392 block, so only the CSS itself need be included.
28394 \begin_inset Flex Code
28397 \begin_layout Plain Layout
28406 \begin_layout Description
28407 \begin_inset Flex Code
28410 \begin_layout Plain Layout
28417 \begin_inset Flex Code
28420 \begin_layout Plain Layout
28426 ] The tag to be used for the main label, replacing
28427 \begin_inset Flex Code
28430 \begin_layout Plain Layout
28436 in the examples above.
28438 \begin_inset Flex Code
28441 \begin_layout Plain Layout
28450 \begin_layout Description
28451 \begin_inset Flex Code
28454 \begin_layout Plain Layout
28461 \begin_inset Flex Code
28464 \begin_layout Plain Layout
28474 ] Marks this style as the one to be used to generate the
28475 \begin_inset Flex Code
28478 \begin_layout Plain Layout
28484 tag for the XHTML file.
28485 By default, it is false.
28487 \begin_inset Flex Code
28490 \begin_layout Plain Layout
28496 file sets it to true for the
28497 \begin_inset Flex Code
28500 \begin_layout Plain Layout
28510 \begin_layout Subsection
28514 \begin_layout Standard
28515 The XHTML output of insets can also be controlled by information in layout
28520 \begin_layout Plain Layout
28521 At present, this is true only for
28522 \begin_inset Quotes eld
28526 \begin_inset Quotes erd
28529 insets (insets you can type into) and is not true for
28530 \begin_inset Quotes eld
28534 \begin_inset Quotes erd
28537 insets (insets that are associated with dialog boxes).
28542 Here, too, \SpecialChar LyX
28543 tries to provide sensible defaults, and it constructs default
28545 But everything can be customized.
28548 \begin_layout Standard
28549 The XHTML \SpecialChar LyX
28550 outputs for an inset has the following form:
28553 \begin_layout LyX-Code
28555 \begin_inset Quotes erd
28559 \begin_inset Quotes erd
28565 \begin_layout LyX-Code
28566 <labeltag>Label</labeltag>
28569 \begin_layout LyX-Code
28571 \begin_inset Quotes erd
28575 \begin_inset Quotes erd
28578 >Contents of the inset.</innertag>
28581 \begin_layout LyX-Code
28585 \begin_layout Standard
28586 If the inset permits multiple paragraphs—that is, if
28587 \begin_inset Flex Code
28590 \begin_layout Plain Layout
28596 is true—then the contents of the inset will itself be output as paragraphs
28597 formatted according to the styles used for those paragraphs (standard,
28598 quote, and the like).
28599 The label tag is of course omitted if the paragraph does not have a label
28600 and, at present, is always
28601 \begin_inset Flex Code
28604 \begin_layout Plain Layout
28611 The inner tag is optional and, by default, does not appear.
28614 \begin_layout Standard
28615 The specific tags and attributes output for each inset can be controlled
28616 by means of the following layout tags.
28619 \begin_layout Description
28620 \begin_inset Flex Code
28623 \begin_layout Plain Layout
28630 \begin_inset Flex Code
28633 \begin_layout Plain Layout
28639 ] Specifies attribute information to be output with the main tag.
28641 \begin_inset Quotes eld
28645 \begin_inset Flex Code
28648 \begin_layout Plain Layout
28649 class=`myinset' onclick=`\SpecialChar ldots
28656 \begin_inset Quotes erd
28660 By default, \SpecialChar LyX
28662 \begin_inset Quotes eld
28666 \begin_inset Flex Code
28669 \begin_layout Plain Layout
28676 \begin_inset Quotes erd
28680 \begin_inset Flex Code
28683 \begin_layout Plain Layout
28689 is the \SpecialChar LyX
28690 name of the inset, made lowercase and with non-alphanumeric characters
28691 converted to underscores, for example: footnote.
28694 \begin_layout Description
28695 \begin_inset Flex Code
28698 \begin_layout Plain Layout
28705 \begin_inset Flex Code
28708 \begin_layout Plain Layout
28718 ] Whether to output the default CSS information \SpecialChar LyX
28719 generates for this layout,
28720 even if additional information is explicitly provided via
28721 \begin_inset Flex Code
28724 \begin_layout Plain Layout
28732 \begin_inset Flex Code
28735 \begin_layout Plain Layout
28741 allows you to alter or augment the generated CSS, rather than to override
28746 \begin_layout Description
28747 \begin_inset Flex Code
28750 \begin_layout Plain Layout
28757 \begin_inset Flex Code
28760 \begin_layout Plain Layout
28766 ] Attributes for the inner tag.
28768 \begin_inset Newline newline
28772 \begin_inset Quotes eld
28776 \begin_inset Flex Code
28779 \begin_layout Plain Layout
28780 class=`insetname_inner'
28786 \begin_inset Quotes erd
28792 \begin_layout Description
28793 \begin_inset Flex Code
28796 \begin_layout Plain Layout
28803 \begin_inset Flex Code
28806 \begin_layout Plain Layout
28812 ] The inner tag, replacing
28813 \begin_inset Flex Code
28816 \begin_layout Plain Layout
28822 in the examples above.
28823 By default, there is none.
28826 \begin_layout Description
28827 \begin_inset Flex Code
28830 \begin_layout Plain Layout
28837 \begin_inset Flex Code
28840 \begin_layout Plain Layout
28848 ] Whether this inset represents a standalone block of text (such as a footnote)
28849 or instead represents material that is included in the surrounding text
28850 (such as a branch).
28854 \begin_layout Description
28855 \begin_inset Flex Code
28858 \begin_layout Plain Layout
28865 \begin_inset Flex Code
28868 \begin_layout Plain Layout
28874 ] A label for this inset, possibly including a reference to a counter.
28875 For example, for footnote, it might be:
28876 \begin_inset Flex Code
28879 \begin_layout Plain Layout
28888 This is optional, and there is no default.
28891 \begin_layout Description
28892 \begin_inset Flex Code
28895 \begin_layout Plain Layout
28901 Information to be output in the
28902 \begin_inset Flex Code
28905 \begin_layout Plain Layout
28911 section when this style is used.
28912 This might, for example, be used to include a
28913 \begin_inset Flex Code
28916 \begin_layout Plain Layout
28923 \begin_inset Flex Code
28926 \begin_layout Plain Layout
28935 \begin_layout Description
28936 \begin_inset Flex Code
28939 \begin_layout Plain Layout
28945 CSS style information to be included when this style is used.
28946 Note that this will automatically be wrapped in a layout-generated
28947 \begin_inset Flex Code
28950 \begin_layout Plain Layout
28956 block, so only the CSS itself need be included.
28959 \begin_layout Description
28960 \begin_inset Flex Code
28963 \begin_layout Plain Layout
28970 \begin_inset Flex Code
28973 \begin_layout Plain Layout
28979 ] The tag to be used for the main label, replacing
28980 \begin_inset Flex Code
28983 \begin_layout Plain Layout
28989 in the examples above.
28990 The default depends upon the setting of
28991 \begin_inset Flex Code
28994 \begin_layout Plain Layout
29001 \begin_inset Flex Code
29004 \begin_layout Plain Layout
29010 is true, the default is
29011 \begin_inset Flex Code
29014 \begin_layout Plain Layout
29020 ; if it is false, the default is
29021 \begin_inset Flex Code
29024 \begin_layout Plain Layout
29033 \begin_layout Subsection
29037 \begin_layout Standard
29038 The XHTML output for floats too can be controlled by layout information.
29039 The output has the following form:
29042 \begin_layout LyX-Code
29044 \begin_inset Quotes erd
29048 \begin_inset Quotes erd
29054 \begin_layout LyX-Code
29055 Contents of the float.
29058 \begin_layout LyX-Code
29062 \begin_layout Standard
29063 The caption, if there is one, is a separate inset and will be output as
29065 Its appearance can be controlled via the InsetLayout for caption insets.
29069 \begin_layout Description
29070 \begin_inset Flex Code
29073 \begin_layout Plain Layout
29080 \begin_inset Flex Code
29083 \begin_layout Plain Layout
29089 ] Specifies attribute information to be output with the main tag.
29091 \begin_inset Quotes eld
29095 \begin_inset Flex Code
29098 \begin_layout Plain Layout
29099 class=`myfloat' onclick=`\SpecialChar ldots
29106 \begin_inset Quotes erd
29110 By default, \SpecialChar LyX
29112 \begin_inset Quotes eld
29116 \begin_inset Flex Code
29119 \begin_layout Plain Layout
29120 class=`float float-floattype'
29126 \begin_inset Quotes erd
29130 \begin_inset Flex Code
29133 \begin_layout Plain Layout
29139 is \SpecialChar LyX
29140 's name for this type of float, as determined by the float declaration
29142 \begin_inset CommandInset ref
29144 reference "subsec:Floats"
29148 ), though made lowercase and with non-alphanumeric characters converted
29149 to underscores, for example: float-table.
29152 \begin_layout Description
29153 \begin_inset Flex Code
29156 \begin_layout Plain Layout
29162 CSS style information to be included when this float is used.
29163 Note that this will automatically be wrapped in a layout-generated
29164 \begin_inset Flex Code
29167 \begin_layout Plain Layout
29173 block, so only the CSS itself need be included.
29176 \begin_layout Description
29177 \begin_inset Flex Code
29180 \begin_layout Plain Layout
29187 \begin_inset Flex Code
29190 \begin_layout Plain Layout
29196 ] The tag to be used for this float, replacing
29197 \begin_inset Quotes eld
29201 \begin_inset Flex Code
29204 \begin_layout Plain Layout
29211 \begin_inset Quotes erd
29214 in the example above.
29216 \begin_inset Flex Code
29219 \begin_layout Plain Layout
29225 and will rarely need changing.
29228 \begin_layout Subsection
29229 Bibliography formatting
29232 \begin_layout Standard
29233 The bibliography can be formatted using
29234 \begin_inset Flex Code
29237 \begin_layout Plain Layout
29245 \begin_inset CommandInset ref
29247 reference "subsec:Citation-format-description"
29254 \begin_layout Subsection
29259 \begin_layout Standard
29260 We have several times mentioned that \SpecialChar LyX
29261 will generate default CSS style rules
29262 for both insets and paragraph styles, based upon the other layout information
29264 In this section, we shall say a word about which layout information \SpecialChar LyX
29269 \begin_layout Standard
29270 At present, \SpecialChar LyX
29271 auto-generates CSS only for font information, making use of
29273 \begin_inset Flex Code
29276 \begin_layout Plain Layout
29283 \begin_inset Flex Code
29286 \begin_layout Plain Layout
29293 \begin_inset Flex Code
29296 \begin_layout Plain Layout
29303 \begin_inset Flex Code
29306 \begin_layout Plain Layout
29313 \begin_inset Flex Code
29316 \begin_layout Plain Layout
29323 \begin_inset CommandInset ref
29325 reference "subsec:Font-description"
29330 The translation is mostly straightforward and obvious.
29332 \begin_inset Quotes eld
29336 \begin_inset Flex Code
29339 \begin_layout Plain Layout
29346 \begin_inset Quotes erd
29350 \begin_inset Quotes eld
29354 \begin_inset Flex Code
29357 \begin_layout Plain Layout
29358 font-family: sans-serif;
29364 \begin_inset Quotes erd
29368 The correspondence of \SpecialChar LyX
29369 sizes and CSS sizes is a little less obvious but
29370 nonetheless intuitive.
29372 \begin_inset Flex Code
29375 \begin_layout Plain Layout
29382 \begin_inset Flex URL
29385 \begin_layout Plain Layout
29393 \change_inserted -970929547 1496610908
29397 \begin_layout Section
29399 \change_inserted -970929547 1496610966
29400 \begin_inset CommandInset label
29402 name "sec:Tags-for-DocBook"
29406 Tags for DocBook output
29409 \begin_layout Standard
29411 \change_inserted -970929547 1496611615
29412 As with \SpecialChar LaTeX
29413 or XHTML, the format of \SpecialChar LyX
29414 's DocBook output is also controlled by
29415 layout information.
29416 In general, \SpecialChar LyX
29417 provides sensible defaults; however, much of the styling is
29418 lost during the conversion, as DocBook is strictly semantic and does not
29420 When possible, information from \SpecialChar LyX
29421 will be rendered in
29429 \begin_layout Standard
29431 \change_inserted -970929547 1496612080
29432 In many cases, then, you may not have to do anything at all to get acceptable
29433 DocBook output for your own environments, custom insets, and so forth.
29434 But in some cases you will, and so \SpecialChar LyX
29435 provides a number of layout tags that
29436 can be used to customize the DocBook that is generated.
29439 \begin_layout Standard
29441 \change_inserted -970929547 1515109912
29442 Labels are rarely output, as they are redundant in DocBook: this information
29443 is carried by the tags themselves, and whether labels appear in the final
29444 documents (after processing of DocBook files) is controlled by the stylesheets.
29445 However, sometimes, labels are not redundant content, such as definition
29446 lists: in this case, the term being defined will be the label.
29450 \begin_layout Subsection
29452 \change_inserted 1075283030 1597699417
29453 \begin_inset CommandInset label
29455 name "subsec:Paragraph-Style-DocBook"
29460 \change_deleted 1075283030 1597699417
29462 \begin_inset CommandInset label
29464 name "subsec:Paragraph-Style-XHTML-1"
29469 \change_inserted -970929547 1496610966
29473 \begin_layout Standard
29475 \change_inserted -970929547 1496612059
29476 The sort of DocBook \SpecialChar LyX
29477 outputs for a paragraph depends upon whether we are
29478 dealing with a normal paragraph, a command, or an environment, where this
29479 is itself determined by the contents of the corresponding
29480 \begin_inset Flex Code
29483 \begin_layout Plain Layout
29485 \change_inserted -970929547 1496610966
29498 \begin_layout Standard
29500 \change_inserted -970929547 1496612107
29501 For a command or normal paragraph, the output DocBook has the following
29505 \begin_layout LyX-Code
29507 \change_inserted -970929547 1515109666
29511 \begin_layout LyX-Code
29513 \change_inserted -970929547 1496610966
29514 Contents of the paragraph.
29517 \begin_layout LyX-Code
29519 \change_inserted -970929547 1496610966
29523 \begin_layout Standard
29525 \change_inserted -970929547 1515109821
29526 For an environment that is not some sort of list, the generated DocBook
29530 \begin_layout LyX-Code
29532 \change_inserted -970929547 1515109671
29536 \begin_layout LyX-Code
29538 \change_inserted -970929547 1496612114
29539 <itemtag>First paragraph.</itemtag>
29542 \begin_layout LyX-Code
29544 \change_inserted -970929547 1496610966
29545 <itemtag>Second paragraph.</itemtag>
29548 \begin_layout LyX-Code
29550 \change_inserted -970929547 1496610966
29554 \begin_layout Standard
29556 \change_inserted -970929547 1515109825
29557 For a list, the resulting DocBook takes this form:
29560 \begin_layout LyX-Code
29562 \change_inserted -970929547 1515109672
29566 \begin_layout LyX-Code
29568 \change_inserted -970929547 1515109676
29569 <itemtag attr>First item.</itemtag>
29572 \begin_layout LyX-Code
29574 \change_inserted -970929547 1515109678
29575 <itemtag attr>Second item.</itemtag>
29578 \begin_layout LyX-Code
29580 \change_inserted -970929547 1496610966
29584 \begin_layout Standard
29586 \change_inserted -970929547 1496612243
29587 The specific tags and roles output for each paragraph type can be controlled
29588 by means of the layout tags we are about to describe.
29589 Please note that, due to the very nature of DocBook, no sensible defaults
29590 really exist, and the values must always be carefully chosen.
29594 \begin_layout Description
29596 \change_inserted -970929547 1515110057
29597 \begin_inset Flex Code
29600 \begin_layout Plain Layout
29602 \change_inserted -970929547 1515109656
29611 \begin_inset Flex Code
29614 \begin_layout Plain Layout
29616 \change_inserted -970929547 1496610966
29624 ] Specifies attribute information to be output with the main tag, replacing
29626 \begin_inset Quotes eld
29630 \begin_inset Flex Code
29633 \begin_layout Plain Layout
29635 \change_inserted -970929547 1515110057
29644 \begin_inset Quotes erd
29647 in the example above.
29648 This information can be used in further processing of the DocBook files.
29654 \begin_layout Description
29656 \change_inserted -970929547 1496612296
29657 \begin_inset Flex Code
29660 \begin_layout Plain Layout
29662 \change_inserted -970929547 1496612269
29671 \begin_inset Flex Code
29674 \begin_layout Plain Layout
29676 \change_inserted -970929547 1496610966
29684 ] The tag to be used for this inset, replacing
29685 \begin_inset Quotes eld
29689 \begin_inset Flex Code
29692 \begin_layout Plain Layout
29694 \change_inserted -970929547 1496612296
29703 \begin_inset Quotes erd
29706 in the example above.
29707 The default is the name of the float and always needs to be changed, as
29708 DocBook provides no generic tag.
29709 \change_inserted 1075283030 1597698868
29713 \begin_layout Description
29715 \change_inserted 1075283030 1597699399
29716 \begin_inset Flex Code
29719 \begin_layout Plain Layout
29721 \change_inserted 1075283030 1597698872
29730 \begin_inset Flex Code
29733 \begin_layout Plain Layout
29735 \change_inserted 1075283030 1597700585
29736 block, paragraph, inline
29743 ] The new-line policy for this tag, see Section
29744 \begin_inset space ~
29748 \begin_inset CommandInset ref
29750 reference "subsec:DocBook-New-line-policy"
29763 \begin_layout Subsection
29765 \change_inserted 1075283030 1597699385
29767 \begin_inset CommandInset label
29769 name "subsec:DocBook-New-line-policy"
29776 \begin_layout Standard
29778 \change_inserted 1075283030 1597698993
29779 For all tags, there are three possible policies for outputting new lines
29781 \begin_inset Flex Code
29784 \begin_layout Plain Layout
29786 \change_inserted 1075283030 1597698987
29797 \begin_layout Itemize
29799 \change_inserted 1075283030 1597699279
29800 \begin_inset Quotes eld
29804 \begin_inset Flex Code
29807 \begin_layout Plain Layout
29809 \change_inserted 1075283030 1597699012
29818 \begin_inset Quotes erd
29821 : the opening and closing tags are on their own lines (i.e.
29822 a line feed after and before the opening and the closing tags).
29823 Typical elements are floats.
29827 \begin_layout LyX-Code
29829 \change_inserted 1075283030 1597699194
29833 \begin_layout LyX-Code
29835 \change_inserted 1075283030 1597699194
29839 \begin_layout LyX-Code
29841 \change_inserted 1075283030 1597699098
29842 Contents of the block.
29845 \begin_layout LyX-Code
29847 \change_inserted 1075283030 1597699196
29851 \begin_layout LyX-Code
29853 \change_inserted 1075283030 1597699198
29857 \begin_layout Itemize
29859 \change_inserted 1075283030 1597699289
29860 \begin_inset Quotes eld
29864 \begin_inset Flex Code
29867 \begin_layout Plain Layout
29869 \change_inserted 1075283030 1597699113
29878 \begin_inset Quotes erd
29881 : the opening and closing tags are on the same, new line; a line feed is
29882 output before the opening tag and after the closing tag.
29883 Typical elements are paragraphs and list items.
29887 \begin_layout LyX-Code
29889 \change_inserted 1075283030 1597699186
29893 \begin_layout LyX-Code
29895 \change_inserted 1075283030 1597699357
29896 <paratag>Contents of the paragraph.</paratag>
29899 \begin_layout LyX-Code
29901 \change_inserted 1075283030 1597699231
29905 \begin_layout Itemize
29907 \change_inserted 1075283030 1597699343
29908 \begin_inset Quotes eld
29912 \begin_inset Flex Code
29915 \begin_layout Plain Layout
29917 \change_inserted 1075283030 1597699307
29926 \begin_inset Quotes erd
29929 : the opening and closing tags are on the same line as the rest of the content.
29930 No line feeds are output.
29931 Typical elements are fonts.
29935 \begin_layout LyX-Code
29937 \change_inserted 1075283030 1597699585
29938 Content before<inlinetag>Contents of the paragraph.</inlinetag>Content after
29941 \begin_layout Standard
29943 \change_inserted 1075283030 1597699585
29944 The default value is always
29945 \begin_inset Quotes eld
29949 \begin_inset Flex Code
29952 \begin_layout Plain Layout
29954 \change_inserted 1075283030 1597699585
29963 \begin_inset Quotes erd
29971 \begin_layout Subsection
29973 \change_inserted -970929547 1515111533
29974 InsetLayout DocBook
29979 \begin_layout Standard
29981 \change_inserted -970929547 1496611894
29982 The DocBook output of insets can also be controlled by information in layout
29986 \begin_layout Standard
29988 \change_inserted -970929547 1496612045
29989 The DocBook \SpecialChar LyX
29990 outputs for an inset has the following form:
29993 \begin_layout LyX-Code
29995 \change_inserted -970929547 1515110861
29996 <wrappertag wrapperattr>
29999 \begin_layout LyX-Code
30001 \change_inserted -970929547 1515110868
30005 \begin_layout LyX-Code
30007 \change_inserted -970929547 1515110869
30008 <innertag innerattr>
30011 \begin_layout LyX-Code
30013 \change_inserted -970929547 1515110869
30014 Contents of the inset.
30017 \begin_layout LyX-Code
30019 \change_inserted -970929547 1515110870
30023 \begin_layout LyX-Code
30025 \change_inserted -970929547 1515110871
30029 \begin_layout LyX-Code
30031 \change_inserted -970929547 1515111172
30035 \begin_layout Standard
30037 \change_inserted -970929547 1515111186
30038 For an itemising inset, it rather looks like this:
30041 \begin_layout LyX-Code
30043 \change_inserted -970929547 1515111186
30044 <wrappertag wrapperattr>
30047 \begin_layout LyX-Code
30049 \change_inserted -970929547 1515111186
30053 \begin_layout LyX-Code
30055 \change_inserted -970929547 1515111186
30056 <innertag innerattr>
30059 \begin_layout LyX-Code
30061 \change_inserted -970929547 1515111362
30062 <itemwrappertag itemwrapperattr>
30065 \begin_layout LyX-Code
30067 \change_inserted -970929547 1515111364
30068 <itemlabeltag itemattr>
30071 \begin_layout LyX-Code
30073 \change_inserted -970929547 1515111367
30074 Label of the first item.
30077 \begin_layout LyX-Code
30079 \change_inserted -970929547 1515111362
30085 \begin_layout LyX-Code
30087 \change_inserted -970929547 1515111517
30091 \begin_layout LyX-Code
30093 \change_inserted -970929547 1515111517
30099 \begin_layout LyX-Code
30101 \change_inserted -970929547 1515111516
30102 Contents of the first item.
30105 \begin_layout LyX-Code
30107 \change_inserted -970929547 1515111514
30113 \begin_layout LyX-Code
30115 \change_inserted -970929547 1515111247
30121 \begin_layout LyX-Code
30123 \change_inserted -970929547 1515111221
30127 \begin_layout LyX-Code
30129 \change_inserted -970929547 1515111370
30130 <itemwrappertag itemwrapperattr>
30133 \begin_layout LyX-Code
30135 \change_inserted -970929547 1515111370
30136 <itemlabeltag itemattr>
30139 \begin_layout LyX-Code
30141 \change_inserted -970929547 1515111372
30142 Label of the second item.
30145 \begin_layout LyX-Code
30147 \change_inserted -970929547 1515111370
30153 \begin_layout LyX-Code
30155 \change_inserted -970929547 1515111504
30159 \begin_layout LyX-Code
30161 \change_inserted -970929547 1515111505
30167 \begin_layout LyX-Code
30169 \change_inserted -970929547 1515111507
30170 Contents of the second item.
30173 \begin_layout LyX-Code
30175 \change_inserted -970929547 1515111509
30181 \begin_layout LyX-Code
30183 \change_inserted -970929547 1515111251
30189 \begin_layout LyX-Code
30191 \change_inserted -970929547 1515111221
30197 \begin_layout LyX-Code
30199 \change_inserted -970929547 1515111219
30205 \begin_layout LyX-Code
30207 \change_inserted -970929547 1515111186
30211 \begin_layout LyX-Code
30213 \change_inserted -970929547 1515111186
30217 \begin_layout LyX-Code
30219 \change_inserted -970929547 1515111186
30223 \begin_layout Standard
30225 \change_inserted -970929547 1515111183
30226 If the inset permits multiple paragraphs—that is, if
30227 \begin_inset Flex Code
30230 \begin_layout Plain Layout
30232 \change_inserted -970929547 1496610966
30240 is true—then the contents of the inset will
30241 \change_deleted 34634807 1620029217
30243 \change_inserted 34634807 1620029219
30245 \change_inserted -970929547 1515111183
30246 be output as paragraphs formatted according to the styles used for those
30247 paragraphs (standard, quote, and the like).
30248 The inner tag is optional and, by default, does not appear.
30251 \begin_layout Standard
30253 \change_inserted -970929547 1496610966
30254 The specific tags and attributes output for each inset can be controlled
30255 by means of the following layout tags.
30258 \begin_layout Description
30260 \change_inserted -970929547 1515110317
30261 \begin_inset Flex Code
30264 \begin_layout Plain Layout
30266 \change_inserted -970929547 1515109695
30275 \begin_inset Flex Code
30278 \begin_layout Plain Layout
30280 \change_inserted -970929547 1496611854
30288 ] Specifies attribute information to be output with the main tag, replacing
30290 \begin_inset Quotes eld
30294 \begin_inset Flex Code
30297 \begin_layout Plain Layout
30299 \change_inserted -970929547 1515110044
30308 \begin_inset Quotes erd
30311 in the example above.
30312 This information can be used in further processing of the DocBook files.
30316 \begin_layout Description
30318 \change_inserted -970929547 1515110973
30319 \begin_inset Flex Code
30322 \begin_layout Plain Layout
30324 \change_inserted -970929547 1515110319
30333 \begin_inset Flex Code
30336 \begin_layout Plain Layout
30338 \change_inserted -970929547 1515110384
30339 never, always, maybe
30346 ] Specifies whether this tag goes into the
30347 \begin_inset Flex Code
30350 \begin_layout Plain Layout
30352 \change_inserted -970929547 1515110412
30360 tag at the beginning of the parent layout.
30362 \begin_inset Flex Code
30365 \begin_layout Plain Layout
30367 \change_inserted -970929547 1515110437
30375 indicates that the tag never goes into
30376 \begin_inset Flex Code
30379 \begin_layout Plain Layout
30381 \change_inserted -970929547 1515110497
30389 (this is default value, and corresponds to usual content).
30391 \begin_inset Flex Code
30394 \begin_layout Plain Layout
30396 \change_inserted -970929547 1515110517
30404 indicates that the tag always goes into
30405 \begin_inset Flex Code
30408 \begin_layout Plain Layout
30410 \change_inserted -970929547 1515110514
30418 (this corresponds to usual metadata): if there is no
30419 \begin_inset Flex Code
30422 \begin_layout Plain Layout
30424 \change_inserted -970929547 1515110550
30432 tag for the parent, one
30438 \begin_inset Flex Code
30441 \begin_layout Plain Layout
30443 \change_inserted -970929547 1515110540
30451 indicates that the tag may go into
30452 \begin_inset Flex Code
30455 \begin_layout Plain Layout
30457 \change_inserted -970929547 1515110538
30465 (this is only the case for titles): if there is no
30466 \begin_inset Flex Code
30469 \begin_layout Plain Layout
30471 \change_inserted -970929547 1515110585
30479 tag for the parent,
30483 will be generated, the corresponding tag will be output directly as content.
30487 \begin_layout Description
30489 \change_inserted -970929547 1515111461
30490 \begin_inset Flex Code
30493 \begin_layout Plain Layout
30495 \change_inserted -970929547 1515110974
30504 \begin_inset Flex Code
30507 \begin_layout Plain Layout
30509 \change_inserted -970929547 1515110973
30517 ] Specifies attribute information to be output with the item tag, replacing
30519 \begin_inset Quotes eld
30523 \begin_inset Flex Code
30526 \begin_layout Plain Layout
30528 \change_inserted -970929547 1515110984
30537 \begin_inset Quotes erd
30540 in the example above.
30541 This information can be used in further processing of the DocBook files.
30545 \begin_layout Description
30547 \change_inserted -970929547 1515111471
30548 \begin_inset Flex Code
30551 \begin_layout Plain Layout
30553 \change_inserted -970929547 1515111465
30554 DocBookItemInnerAttr
30562 \begin_inset Flex Code
30565 \begin_layout Plain Layout
30567 \change_inserted -970929547 1515111461
30575 ] Specifies attribute information to be output with the item inner tag,
30577 \begin_inset Quotes eld
30581 \begin_inset Flex Code
30584 \begin_layout Plain Layout
30586 \change_inserted -970929547 1515111476
30595 \begin_inset Quotes erd
30598 in the example above.
30599 This information can be used in further processing of the DocBook files.
30603 \begin_layout Description
30605 \change_inserted -970929547 1515111494
30606 \begin_inset Flex Code
30609 \begin_layout Plain Layout
30611 \change_inserted -970929547 1515111467
30612 DocBookItemInnerTag
30620 \begin_inset Flex Code
30623 \begin_layout Plain Layout
30625 \change_inserted -970929547 1515111461
30633 ] The tag to be used for the item inner tag within the inset, replacing
30635 \begin_inset Quotes eld
30639 \begin_inset Flex Code
30642 \begin_layout Plain Layout
30644 \change_inserted -970929547 1515111486
30653 \begin_inset Quotes erd
30656 in the example above.
30658 \begin_inset Flex Code
30661 \begin_layout Plain Layout
30663 \change_inserted -970929547 1515111461
30671 , indicating that there is no item inner tag: content is directly output
30672 without it for each itemised element.
30673 This parameter only makes sense when itemising layouts are used, such as
30676 \change_inserted 1075283030 1598469472
30677 The most likely value is
30678 \begin_inset Quotes eld
30682 \begin_inset Flex Code
30685 \begin_layout Plain Layout
30687 \change_inserted 1075283030 1598469476
30696 \begin_inset Quotes erd
30700 \begin_inset Newline newline
30703 When a list item is split using a new line, the item inner tag will be repeated
30704 for each part of the paragraph, parts being separated by new lines.
30708 \begin_layout Description
30710 \change_inserted 1075283030 1597699866
30711 \begin_inset Flex Code
30714 \begin_layout Plain Layout
30716 \change_inserted 1075283030 1597699853
30717 DocBookItemInnerTagType
30725 \begin_inset Flex Code
30728 \begin_layout Plain Layout
30730 \change_inserted 1075283030 1597699866
30731 block, paragraph, inline
30738 ] The new-line policy for this tag, see Section
30739 \begin_inset space ~
30743 \begin_inset CommandInset ref
30745 reference "subsec:DocBook-New-line-policy"
30758 \begin_layout Description
30760 \change_inserted -970929547 1515111290
30761 \begin_inset Flex Code
30764 \begin_layout Plain Layout
30766 \change_inserted -970929547 1515111283
30767 DocBookItemLabelAttr
30775 \begin_inset Flex Code
30778 \begin_layout Plain Layout
30780 \change_inserted -970929547 1515111279
30788 ] Specifies attribute information to be output with the item label tag,
30790 \begin_inset Quotes eld
30794 \begin_inset Flex Code
30797 \begin_layout Plain Layout
30799 \change_inserted -970929547 1515111304
30808 \begin_inset Quotes erd
30811 in the example above.
30812 This information can be used in further processing of the DocBook files.
30816 \begin_layout Description
30818 \change_inserted -970929547 1515111337
30819 \begin_inset Flex Code
30822 \begin_layout Plain Layout
30824 \change_inserted -970929547 1515111285
30825 DocBookItemLabelTag
30833 \begin_inset Flex Code
30836 \begin_layout Plain Layout
30838 \change_inserted -970929547 1515111279
30846 ] The tag to be used for the item label tag within the inset, replacing
30848 \begin_inset Quotes eld
30852 \begin_inset Flex Code
30855 \begin_layout Plain Layout
30857 \change_inserted -970929547 1515111311
30866 \begin_inset Quotes erd
30869 in the example above.
30870 This parameter only makes sense when itemising layouts are used with a
30871 notion of labels, such as definition lists.
30873 \change_inserted 1075283030 1597699874
30877 \begin_layout Description
30879 \change_inserted 1075283030 1597699874
30880 \begin_inset Flex Code
30883 \begin_layout Plain Layout
30885 \change_inserted 1075283030 1597699880
30886 DocBookItemLabelTagType
30894 \begin_inset Flex Code
30897 \begin_layout Plain Layout
30899 \change_inserted 1075283030 1597699874
30900 block, paragraph, inline
30907 ] The new-line policy for this tag, see Section
30908 \begin_inset space ~
30912 \begin_inset CommandInset ref
30914 reference "subsec:DocBook-New-line-policy"
30927 \begin_layout Description
30929 \change_inserted -970929547 1515111124
30930 \begin_inset Flex Code
30933 \begin_layout Plain Layout
30935 \change_inserted -970929547 1515111060
30944 \begin_inset Flex Code
30947 \begin_layout Plain Layout
30949 \change_inserted -970929547 1515111060
30957 ] The tag to be used for the item tag within the inset, replacing
30958 \begin_inset Quotes eld
30962 \begin_inset Flex Code
30965 \begin_layout Plain Layout
30967 \change_inserted -970929547 1515111060
30976 \begin_inset Quotes erd
30979 in the example above.
30981 \begin_inset Flex Code
30984 \begin_layout Plain Layout
30986 \change_inserted -970929547 1515111060
30994 , indicating that there is no item tag.
30995 This parameter only makes sense when itemising layouts are used, such as
30998 \change_inserted 1075283030 1597699890
31002 \begin_layout Description
31004 \change_inserted 1075283030 1597699890
31005 \begin_inset Flex Code
31008 \begin_layout Plain Layout
31010 \change_inserted 1075283030 1597699890
31019 \begin_inset Flex Code
31022 \begin_layout Plain Layout
31024 \change_inserted 1075283030 1597699890
31025 block, paragraph, inline
31032 ] The new-line policy for this tag, see Section
31033 \begin_inset space ~
31037 \begin_inset CommandInset ref
31039 reference "subsec:DocBook-New-line-policy"
31052 \begin_layout Description
31054 \change_inserted -970929547 1515111298
31055 \begin_inset Flex Code
31058 \begin_layout Plain Layout
31060 \change_inserted -970929547 1515111124
31061 DocBookItemWrapperAttr
31069 \begin_inset Flex Code
31072 \begin_layout Plain Layout
31074 \change_inserted -970929547 1515111124
31082 ] Specifies attribute information to be output with the item wrapper tag,
31084 \begin_inset Quotes eld
31088 \begin_inset Flex Code
31091 \begin_layout Plain Layout
31093 \change_inserted -970929547 1515111150
31102 \begin_inset Quotes erd
31105 in the example above.
31106 This information can be used in further processing of the DocBook files.
31112 \begin_layout Description
31114 \change_inserted -970929547 1515111113
31115 \begin_inset Flex Code
31118 \begin_layout Plain Layout
31120 \change_inserted -970929547 1515111073
31121 DocBookItemWrapperTag
31129 \begin_inset Flex Code
31132 \begin_layout Plain Layout
31134 \change_inserted -970929547 1515111073
31142 ] The tag to be used for the item wrapper tag within the inset, replacing
31144 \begin_inset Quotes eld
31148 \begin_inset Flex Code
31151 \begin_layout Plain Layout
31153 \change_inserted -970929547 1515111083
31162 \begin_inset Quotes erd
31165 in the example above.
31167 \begin_inset Flex Code
31170 \begin_layout Plain Layout
31172 \change_inserted -970929547 1515111073
31180 , indicating that there is no item wrapper tag: tag and content are directly
31181 output without it for each itemised element.
31182 This parameter only makes sense when itemising layouts are used, such as
31185 \change_inserted 1075283030 1597699897
31189 \begin_layout Description
31191 \change_inserted 1075283030 1597699897
31192 \begin_inset Flex Code
31195 \begin_layout Plain Layout
31197 \change_inserted 1075283030 1597699900
31198 DocBookItemWrapperTagType
31206 \begin_inset Flex Code
31209 \begin_layout Plain Layout
31211 \change_inserted 1075283030 1597699897
31212 block, paragraph, inline
31219 ] The new-line policy for this tag, see Section
31220 \begin_inset space ~
31224 \begin_inset CommandInset ref
31226 reference "subsec:DocBook-New-line-policy"
31239 \begin_layout Description
31241 \change_inserted -970929547 1515110104
31242 \begin_inset Flex Code
31245 \begin_layout Plain Layout
31247 \change_inserted -970929547 1515110104
31256 \begin_inset Flex Code
31259 \begin_layout Plain Layout
31261 \change_inserted -970929547 1515110104
31269 ] Specifies attribute information to be output with the inner tag, replacing
31271 \begin_inset Quotes eld
31275 \begin_inset Flex Code
31278 \begin_layout Plain Layout
31280 \change_inserted -970929547 1515110104
31289 \begin_inset Quotes erd
31292 in the example above.
31293 This information can be used in further processing of the DocBook files.
31297 \begin_layout Description
31299 \change_inserted -970929547 1515110906
31300 \begin_inset Flex Code
31303 \begin_layout Plain Layout
31305 \change_inserted -970929547 1515110104
31314 \begin_inset Flex Code
31317 \begin_layout Plain Layout
31319 \change_inserted -970929547 1515110104
31327 ] The tag to be used for the inner tag within the inset, replacing
31328 \begin_inset Quotes eld
31332 \begin_inset Flex Code
31335 \begin_layout Plain Layout
31337 \change_inserted -970929547 1515110104
31346 \begin_inset Quotes erd
31349 in the example above.
31351 \begin_inset Flex Code
31354 \begin_layout Plain Layout
31356 \change_inserted -970929547 1515110791
31364 , indicating that there is no inner tag: content is directly output without
31366 \change_inserted 1075283030 1597699904
31370 \begin_layout Description
31372 \change_inserted 1075283030 1597699904
31373 \begin_inset Flex Code
31376 \begin_layout Plain Layout
31378 \change_inserted 1075283030 1597699904
31379 DocBookInnerTagType
31387 \begin_inset Flex Code
31390 \begin_layout Plain Layout
31392 \change_inserted 1075283030 1597699904
31393 block, paragraph, inline
31400 ] The new-line policy for this tag, see Section
31401 \begin_inset space ~
31405 \begin_inset CommandInset ref
31407 reference "subsec:DocBook-New-line-policy"
31420 \begin_layout Description
31422 \change_inserted -970929547 1515110753
31423 \begin_inset Flex Code
31426 \begin_layout Plain Layout
31428 \change_inserted -970929547 1515110665
31437 \begin_inset Flex Code
31440 \begin_layout Plain Layout
31442 \change_inserted -970929547 1515110661
31450 ] Specifies the tag that corresponds to this kind of section.
31451 This parameter only makes sense for sectioning elements (part, chapter,
31453 The default value is
31454 \begin_inset Flex Code
31457 \begin_layout Plain Layout
31459 \change_inserted -970929547 1515110721
31467 , and is only overridden when DocBook uses something else for sectioning
31469 \change_inserted 1075283030 1597699921
31471 \change_inserted -970929547 1515110753
31472 parts and chapters of a book).
31478 \begin_layout Description
31480 \change_inserted -970929547 1515110811
31481 \begin_inset Flex Code
31484 \begin_layout Plain Layout
31486 \change_inserted -970929547 1496612023
31495 \begin_inset Flex Code
31498 \begin_layout Plain Layout
31500 \change_inserted -970929547 1496610966
31508 ] The tag to be used for this inset, replacing
31509 \begin_inset Quotes eld
31513 \begin_inset Flex Code
31516 \begin_layout Plain Layout
31518 \change_inserted -970929547 1496612033
31527 \begin_inset Quotes erd
31530 in the example above.
31531 The default is the name of the float and always needs to be changed, as
31532 DocBook provides no generic inset tag.
31533 \change_inserted 1075283030 1597699924
31537 \begin_layout Description
31539 \change_inserted 1075283030 1597699924
31540 \begin_inset Flex Code
31543 \begin_layout Plain Layout
31545 \change_inserted 1075283030 1597699924
31554 \begin_inset Flex Code
31557 \begin_layout Plain Layout
31559 \change_inserted 1075283030 1597699924
31560 block, paragraph, inline
31567 ] The new-line policy for this tag, see Section
31568 \begin_inset space ~
31572 \begin_inset CommandInset ref
31574 reference "subsec:DocBook-New-line-policy"
31587 \begin_layout Description
31589 \change_inserted -970929547 1515110832
31590 \begin_inset Flex Code
31593 \begin_layout Plain Layout
31595 \change_inserted -970929547 1515110822
31604 \begin_inset Flex Code
31607 \begin_layout Plain Layout
31609 \change_inserted -970929547 1515110811
31617 ] Specifies attribute information to be output with the outer
31618 \change_inserted 34634807 1620057958
31620 \change_inserted -970929547 1515110832
31622 \begin_inset Quotes eld
31626 \begin_inset Flex Code
31629 \begin_layout Plain Layout
31631 \change_inserted -970929547 1515110845
31640 \begin_inset Quotes erd
31643 in the example above.
31644 This information can be used in further processing of the DocBook files.
31648 \begin_layout Description
31650 \change_inserted -970929547 1515110917
31651 \begin_inset Flex Code
31654 \begin_layout Plain Layout
31656 \change_inserted -970929547 1515110826
31665 \begin_inset Flex Code
31668 \begin_layout Plain Layout
31670 \change_inserted -970929547 1515110811
31678 ] The tag to be used for the wrapper tag around the inset, replacing
31679 \begin_inset Quotes eld
31683 \begin_inset Flex Code
31686 \begin_layout Plain Layout
31688 \change_inserted -970929547 1515110842
31697 \begin_inset Quotes erd
31700 in the example above.
31702 \begin_inset Flex Code
31705 \begin_layout Plain Layout
31707 \change_inserted -970929547 1515110811
31715 , indicating that there is no wrapper tag: tag and content are directly
31717 \change_inserted 1075283030 1597699929
31721 \begin_layout Description
31723 \change_inserted 1075283030 1597699929
31724 \begin_inset Flex Code
31727 \begin_layout Plain Layout
31729 \change_inserted 1075283030 1597699932
31730 DocBookWrapperTagType
31738 \begin_inset Flex Code
31741 \begin_layout Plain Layout
31743 \change_inserted 1075283030 1597699929
31744 block, paragraph, inline
31751 ] The new-line policy for this tag, see Section
31752 \begin_inset space ~
31756 \begin_inset CommandInset ref
31758 reference "subsec:DocBook-New-line-policy"
31771 \begin_layout Subsection
31773 \change_inserted -970929547 1515110040
31777 \begin_layout Standard
31779 \change_inserted -970929547 1496611700
31780 The DocBook output for floats too can be controlled by layout information.
31781 The output has the following form:
31784 \begin_layout LyX-Code
31786 \change_inserted -970929547 1515109700
31790 \begin_layout LyX-Code
31792 \change_inserted -970929547 1515110138
31793 Contents of the float as DocBook.
31796 \begin_layout LyX-Code
31798 \change_inserted -970929547 1496610966
31802 \begin_layout Standard
31804 \change_inserted -970929547 1496611715
31805 The caption, if there is one, is a separate inset and will be output as
31810 \begin_layout Description
31812 \change_inserted -970929547 1515110033
31813 \begin_inset Flex Code
31816 \begin_layout Plain Layout
31818 \change_inserted -970929547 1515109702
31827 \begin_inset Flex Code
31830 \begin_layout Plain Layout
31832 \change_inserted -970929547 1496610966
31840 ] Specifies attribute information to be output with the main tag, replacing
31842 \begin_inset Quotes eld
31846 \begin_inset Flex Code
31849 \begin_layout Plain Layout
31851 \change_inserted -970929547 1515110035
31860 \begin_inset Quotes erd
31863 in the example above.
31864 This information can be used in further processing of the DocBook files.
31868 \begin_layout Description
31870 \change_inserted -970929547 1515110157
31871 \begin_inset Flex Code
31874 \begin_layout Plain Layout
31876 \change_inserted -970929547 1496611782
31885 \begin_inset Flex Code
31888 \begin_layout Plain Layout
31890 \change_inserted -970929547 1496610966
31898 ] The tag to be used for this float, replacing
31899 \begin_inset Quotes eld
31903 \begin_inset Flex Code
31906 \begin_layout Plain Layout
31908 \change_inserted -970929547 1496610966
31917 \begin_inset Quotes erd
31920 in the example above.
31921 The default is the name of the float and always needs to be changed, as
31922 DocBook provides no generic float tag.
31925 \begin_layout Subsection
31927 \change_inserted -970929547 1515110157
31928 Bibliography formatting
31931 \begin_layout Standard
31933 \change_deleted 1075283030 1597699984
31935 \change_inserted 1075283030 1597699985
31937 \change_inserted -970929547 1515110187
31939 \change_deleted 1075283030 1597699987
31941 \change_inserted 1075283030 1597699987
31943 \change_inserted -970929547 1515110187
31944 cannot be formatted: all fields are always output in the database-like
31945 DocBook format (equivalent to a BibTeX file)
31946 \change_inserted 1075283030 1597700117
31948 \begin_inset Flex Code
31951 \begin_layout Plain Layout
31953 \change_inserted 1075283030 1597700120
31962 \change_inserted -970929547 1515110187
31964 \change_inserted 1075283030 1597700092
31968 \begin_layout Standard
31970 \change_inserted 1075283030 1597700112
31971 When the bibliographic entries are manually inserted into the
31972 \change_deleted 34634807 1620057319
31974 \change_inserted 34634807 1620057319
31977 \change_inserted 1075283030 1597700112
31978 document as Bibliography Items, the user deals with formatting
31981 \change_inserted 1075283030 1597700112
31982 self: there is no attempt of parsing what the user wrote, the string is
31983 directly used (with the
31984 \begin_inset Flex Code
31987 \begin_layout Plain Layout
31989 \change_inserted 1075283030 1597700076
32003 \begin_layout Chapter
32004 Including External Material
32005 \begin_inset CommandInset label
32007 name "chap:Including-External-Material"
32014 \begin_layout Standard
32015 \begin_inset Box Shadowbox
32025 height_special "totalheight"
32030 backgroundcolor "none"
32033 \begin_layout Plain Layout
32034 WARNING: This portion of the documentation has not been updated for some
32036 We certainly hope that it is still accurate, but there are no guarantees.
32044 \begin_layout Standard
32045 The use of material from sources external to \SpecialChar LyX
32046 is covered in detail in the
32052 This part of the manual covers what needs to happen behind the scenes for
32053 new sorts of material to be included.
32056 \begin_layout Section
32060 \begin_layout Standard
32061 The external material feature is based on the concept of a
32066 A template is a specification of how \SpecialChar LyX
32067 should interface with a certain kind
32069 As bundled, \SpecialChar LyX
32070 comes with predefined templates for Xfig figures, various
32071 raster format images, chess diagrams, and LilyPond music notation.
32072 You can check the actual list by using the menu
32073 \begin_inset Flex Noun
32076 \begin_layout Plain Layout
32077 Insert\SpecialChar menuseparator
32078 File\SpecialChar menuseparator
32085 Furthermore, it is possible to roll your own template to support a specific
32087 Later we'll describe in more detail what is involved, and hopefully you
32088 will submit all the templates you create so we can include them in a later
32093 \begin_layout Standard
32094 Another basic idea of the external material feature is to distinguish between
32095 the original file that serves as a base for final material and the produced
32096 file that is included in your exported or printed document.
32097 For example, consider the case of a figure produced with
32098 \begin_inset Flex Code
32101 \begin_layout Plain Layout
32108 The Xfig application itself works on an original file with the
32109 \begin_inset Flex Code
32112 \begin_layout Plain Layout
32119 Within Xfig, you create and change your figure, and when you are done,
32121 \begin_inset Flex Code
32124 \begin_layout Plain Layout
32131 When you want to include the figure in your document, you invoke
32132 \begin_inset Flex Code
32135 \begin_layout Plain Layout
32141 in order to create a PostScript file that can readily be included in your
32145 \begin_inset Flex Code
32148 \begin_layout Plain Layout
32154 file is the original file, and the PostScript file is the produced file.
32157 \begin_layout Standard
32158 This distinction is important in order to allow updating of the material
32159 while you are in the process of writing the document.
32160 Furthermore, it provides us with the flexibility that is needed to support
32161 multiple export formats.
32162 For instance, in the case of a plain text file, it is not exactly an award-winn
32163 ing idea to include the figure as raw PostScript.
32164 Instead, you would either prefer to just include a reference to the figure
32165 or try to invoke some graphics to ASCII converter to make the final result
32166 look similar to the real graphics.
32167 The external material management allows you to do this, because it is parametri
32168 zed on the different export formats that \SpecialChar LyX
32172 \begin_layout Standard
32173 Besides supporting the production of different products according to the
32174 exported format, it supports tight integration with editing and viewing
32176 In the case of an Xfig figure, you are able to invoke Xfig on the original
32177 file with a single click from within the external material dialog in \SpecialChar LyX
32179 and also preview the produced PostScript file with Ghostview with another
32181 No more fiddling around with the command line and/or file browsers to locate
32182 and manipulate the original or produced files.
32183 In this way, you are finally able to take full advantage of the many different
32184 applications that are relevant to use when you write your documents, and
32185 ultimately be more productive.
32188 \begin_layout Section
32189 The external template configuration files
32192 \begin_layout Standard
32193 It is relatively easy to add custom external template definitions to \SpecialChar LyX
32195 However, be aware that doing this in an careless manner most probably
32199 introduce an easily exploitable security hole.
32200 So before you do this, please read the discussion about security in
32201 \begin_inset CommandInset ref
32203 reference "sec:Security-discussion"
32210 \begin_layout Standard
32211 Having said that, we encourage you to submit any interesting templates that
32216 \begin_layout Standard
32217 The external templates are defined in the
32218 \begin_inset Flex Code
32221 \begin_layout Plain Layout
32227 files that are stored in the
32228 \begin_inset Flex Code
32231 \begin_layout Plain Layout
32232 LyXDir/lib/xtemplates/
32238 Each template is defined in a file of its own.
32239 You can place your own templates in
32240 \begin_inset Flex Code
32243 \begin_layout Plain Layout
32244 UserDir/xtemplates/
32249 or copy existing templates to that directory in order to modify them.
32252 \begin_layout Standard
32253 A typical template looks like this:
32256 \begin_layout LyX-Code
32260 \begin_layout LyX-Code
32261 GuiName "XFig: $$AbsOrRelPathParent$$Basename"
32264 \begin_layout LyX-Code
32268 \begin_layout LyX-Code
32272 \begin_layout LyX-Code
32276 \begin_layout LyX-Code
32280 \begin_layout LyX-Code
32284 \begin_layout LyX-Code
32285 AutomaticProduction true
32288 \begin_layout LyX-Code
32292 \begin_layout LyX-Code
32296 \begin_layout LyX-Code
32300 \begin_layout LyX-Code
32301 TransformCommand Rotate RotationLatexCommand
32304 \begin_layout LyX-Code
32305 TransformCommand Resize ResizeLatexCommand
32308 \begin_layout LyX-Code
32309 Product "$$RotateFront$$ResizeFront
32312 \begin_layout LyX-Code
32317 input{$$AbsOrRelPathMaster$$Basename.pstex_t}
32320 \begin_layout LyX-Code
32321 $$ResizeBack$$RotateBack"
32324 \begin_layout LyX-Code
32328 \begin_layout LyX-Code
32329 UpdateResult "$$AbsPath$$Basename.pstex_t"
32332 \begin_layout LyX-Code
32333 Requirement "graphicx"
32336 \begin_layout LyX-Code
32337 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
32340 \begin_layout LyX-Code
32341 ReferencedFile latex "$$AbsPath$$Basename.eps"
32344 \begin_layout LyX-Code
32345 ReferencedFile dvi "$$AbsPath$$Basename.eps"
32348 \begin_layout LyX-Code
32352 \begin_layout LyX-Code
32356 \begin_layout LyX-Code
32357 TransformCommand Rotate RotationLatexCommand
32360 \begin_layout LyX-Code
32361 TransformCommand Resize ResizeLatexCommand
32364 \begin_layout LyX-Code
32365 Product "$$RotateFront$$ResizeFront
32368 \begin_layout LyX-Code
32373 input{$$AbsOrRelPathMaster$$Basename.pdftex_t}
32376 \begin_layout LyX-Code
32377 $$ResizeBack$$RotateBack"
32380 \begin_layout LyX-Code
32381 UpdateFormat pdftex
32384 \begin_layout LyX-Code
32385 UpdateResult "$$AbsPath$$Basename.pdftex_t"
32388 \begin_layout LyX-Code
32389 Requirement "graphicx"
32392 \begin_layout LyX-Code
32393 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pdftex_t"
32396 \begin_layout LyX-Code
32397 ReferencedFile latex "$$AbsPath$$Basename.pdf"
32400 \begin_layout LyX-Code
32404 \begin_layout LyX-Code
32408 \begin_layout LyX-Code
32409 Product "[XFig: $$FName]"
32412 \begin_layout LyX-Code
32416 \begin_layout LyX-Code
32420 \begin_layout LyX-Code
32421 Product "<graphic fileref=
32423 "$$AbsOrRelPathMaster$$Basename.eps
32428 \begin_layout LyX-Code
32432 \begin_layout LyX-Code
32436 \begin_layout LyX-Code
32437 UpdateResult "$$AbsPath$$Basename.eps"
32440 \begin_layout LyX-Code
32441 ReferencedFile docbook "$$AbsPath$$Basename.eps"
32444 \begin_layout LyX-Code
32445 ReferencedFile docbook-xml "$$AbsPath$$Basename.eps"
32448 \begin_layout LyX-Code
32452 \begin_layout LyX-Code
32456 \begin_layout Standard
32457 As you can see, the template is enclosed in
32458 \begin_inset Flex Code
32461 \begin_layout Plain Layout
32469 \begin_inset Flex Code
32472 \begin_layout Plain Layout
32479 It contains a header specifying some general settings and, for each supported
32480 primary document file format, a section
32481 \begin_inset Flex Code
32484 \begin_layout Plain Layout
32492 \begin_inset Flex Code
32495 \begin_layout Plain Layout
32504 \begin_layout Subsection
32505 The template header
32508 \begin_layout Description
32509 \begin_inset Flex Code
32512 \begin_layout Plain Layout
32513 AutomaticProduction
32514 \begin_inset space ~
32522 Whether the file represented by the template must be generated by \SpecialChar LyX
32524 This command must occur exactly once.
32527 \begin_layout Description
32528 \begin_inset Flex Code
32531 \begin_layout Plain Layout
32533 \begin_inset space ~
32541 A glob pattern that is used in the file dialog to filter out the desired
32543 If there is more than one possible file extension (e.
32544 \begin_inset space \thinspace{}
32548 \begin_inset space \space{}
32552 \begin_inset Flex Code
32555 \begin_layout Plain Layout
32562 \begin_inset Flex Code
32565 \begin_layout Plain Layout
32571 ), use something like
32572 \begin_inset Flex Code
32575 \begin_layout Plain Layout
32582 This command must occur exactly once.
32585 \begin_layout Description
32586 \begin_inset Flex Code
32589 \begin_layout Plain Layout
32591 \begin_inset space ~
32599 The text that is displayed on the button.
32600 This command must occur exactly once.
32603 \begin_layout Description
32604 \begin_inset Flex Code
32607 \begin_layout Plain Layout
32609 \begin_inset space ~
32613 \begin_inset space ~
32621 The help text that is used in the External dialog.
32622 Provide enough information to explain to the user just what the template
32623 can provide him with.
32624 This command must occur exactly once.
32627 \begin_layout Description
32628 \begin_inset Flex Code
32631 \begin_layout Plain Layout
32633 \begin_inset space ~
32641 The file format of the original file.
32642 This must be the name of a format that is known to \SpecialChar LyX
32644 \begin_inset CommandInset ref
32646 reference "sec:Formats"
32652 \begin_inset Quotes eld
32656 \begin_inset Flex Code
32659 \begin_layout Plain Layout
32666 \begin_inset Quotes erd
32669 if the template can handle original files of more than one format.
32671 will attempt to interrogate the file itself in order to deduce its format
32673 This command must occur exactly once.
32676 \begin_layout Description
32677 \begin_inset Flex Code
32680 \begin_layout Plain Layout
32682 \begin_inset space ~
32690 A unique name for the template.
32691 It must not contain substitution macros (see below).
32694 \begin_layout Description
32695 \begin_inset Flex Code
32698 \begin_layout Plain Layout
32700 \begin_inset space ~
32703 Rotate|Resize|Clip|Extra
32708 This command specifies which transformations are supported by this template.
32709 It may occur zero or more times.
32710 This command enables the corresponding tabs in the external dialog.
32712 \begin_inset Flex Code
32715 \begin_layout Plain Layout
32721 command must have either a corresponding
32722 \begin_inset Flex Code
32725 \begin_layout Plain Layout
32732 \begin_inset Flex Code
32735 \begin_layout Plain Layout
32742 \begin_inset Flex Code
32745 \begin_layout Plain Layout
32752 Otherwise the transformation will not be supported by that format.
32755 \begin_layout Subsection
32759 \begin_layout Description
32760 \begin_inset Flex Code
32763 \begin_layout Plain Layout
32765 \begin_inset space ~
32768 LaTeX|PDFLaTeX|PlainText|DocBook|XHTML
32773 The primary document file format that this format definition is for.
32774 Not every template has a sensible representation in all document file formats.
32775 Please define nevertheless a
32776 \begin_inset Flex Code
32779 \begin_layout Plain Layout
32785 section for all templates.
32786 Use a dummy text when no representation is available.
32787 Then you can at least see a reference to the external material in the exported
32791 \begin_layout Description
32792 \begin_inset Flex Code
32795 \begin_layout Plain Layout
32797 \begin_inset space ~
32801 \begin_inset space ~
32809 This command defines an additional macro
32810 \begin_inset Flex Code
32813 \begin_layout Plain Layout
32819 for substitution in
32820 \begin_inset Flex Code
32823 \begin_layout Plain Layout
32831 \begin_inset Flex Code
32834 \begin_layout Plain Layout
32840 itself may contain substitution macros.
32841 The advantage over using
32842 \begin_inset Flex Code
32845 \begin_layout Plain Layout
32852 \begin_inset Flex Code
32855 \begin_layout Plain Layout
32861 is that the substituted value of
32862 \begin_inset Flex Code
32865 \begin_layout Plain Layout
32871 is sanitized so that it is a valid optional argument in the document format.
32872 This command may occur zero or more times.
32875 \begin_layout Description
32876 \begin_inset Flex Code
32879 \begin_layout Plain Layout
32881 \begin_inset space ~
32889 The text that is inserted in the exported document.
32890 This is actually the most important command and can be quite complex.
32891 This command must occur exactly once.
32894 \begin_layout Description
32895 \begin_inset Flex Code
32898 \begin_layout Plain Layout
32900 \begin_inset space ~
32908 This command specifies a preamble snippet that will be included in the
32911 It has to be defined using
32912 \begin_inset Flex Code
32915 \begin_layout Plain Layout
32923 \begin_inset Flex Code
32926 \begin_layout Plain Layout
32933 This command may occur zero or more times.
32936 \begin_layout Description
32937 \begin_inset Flex Code
32940 \begin_layout Plain Layout
32942 \begin_inset space ~
32946 \begin_inset space ~
32954 This command denotes files that are created by the conversion process and
32955 are needed for a particular export format.
32956 If the filename is relative, it is interpreted relative to the master document.
32957 This command may be given zero or more times.
32960 \begin_layout Description
32961 \begin_inset Flex Code
32964 \begin_layout Plain Layout
32966 \begin_inset space ~
32974 The name of a required \SpecialChar LaTeX
32976 The package is included via
32977 \begin_inset Flex Code
32980 \begin_layout Plain Layout
32988 in the \SpecialChar LaTeX
32990 This command may occur zero or more times.
32993 \begin_layout Description
32994 \begin_inset Flex Code
32997 \begin_layout Plain Layout
32999 \begin_inset space ~
33003 \begin_inset space ~
33006 RotationLatexCommand
33011 This command specifies that the built in \SpecialChar LaTeX
33012 command should be used for rotation.
33013 This command may occur once or not at all.
33016 \begin_layout Description
33017 \begin_inset Flex Code
33020 \begin_layout Plain Layout
33022 \begin_inset space ~
33026 \begin_inset space ~
33034 This command specifies that the built in \SpecialChar LaTeX
33035 command should be used for resizing.
33036 This command may occur once or not at all.
33039 \begin_layout Description
33040 \begin_inset Flex Code
33043 \begin_layout Plain Layout
33045 \begin_inset space ~
33049 \begin_inset space ~
33052 RotationLatexOption
33057 This command specifies that rotation is done via an optional argument.
33058 This command may occur once or not at all.
33061 \begin_layout Description
33062 \begin_inset Flex Code
33065 \begin_layout Plain Layout
33067 \begin_inset space ~
33071 \begin_inset space ~
33079 This command specifies that resizing is done via an optional argument.
33080 This command may occur once or not at all.
33083 \begin_layout Description
33084 \begin_inset Flex Code
33087 \begin_layout Plain Layout
33089 \begin_inset space ~
33093 \begin_inset space ~
33101 This command specifies that clipping is done via an optional argument.
33102 This command may occur once or not at all.
33105 \begin_layout Description
33106 \begin_inset Flex Code
33109 \begin_layout Plain Layout
33111 \begin_inset space ~
33115 \begin_inset space ~
33123 This command specifies that an extra optional argument is used.
33124 This command may occur once or not at all.
33127 \begin_layout Description
33128 \begin_inset Flex Code
33131 \begin_layout Plain Layout
33133 \begin_inset space ~
33141 The file format of the converted file.
33142 This must be the name of a format that is known to \SpecialChar LyX
33144 \begin_inset Flex Noun
33147 \begin_layout Plain Layout
33148 Tools\SpecialChar menuseparator
33149 Preferences\SpecialChar menuseparator
33150 File Handling\SpecialChar menuseparator
33157 This command must occur exactly once.
33158 If the resulting file format is PDF, you need to specify the format
33159 \begin_inset Flex Code
33162 \begin_layout Plain Layout
33169 This is the PDF format used for including graphics.
33170 The other defined PDF formats are for document export.
33173 \begin_layout Description
33174 \begin_inset Flex Code
33177 \begin_layout Plain Layout
33179 \begin_inset space ~
33187 The file name of the converted file.
33188 The file name must be absolute.
33189 This command must occur exactly once.
33192 \begin_layout Subsection
33193 Preamble definitions
33196 \begin_layout Standard
33197 The external template configuration file may contain additional preamble
33198 definitions enclosed by
33199 \begin_inset Flex Code
33202 \begin_layout Plain Layout
33210 \begin_inset Flex Code
33213 \begin_layout Plain Layout
33220 They can be used by the templates in the
33221 \begin_inset Flex Code
33224 \begin_layout Plain Layout
33233 \begin_layout Section
33234 The substitution mechanism
33237 \begin_layout Standard
33238 When the external material facility invokes an external program, it is done
33239 on the basis of a command defined in the template configuration file.
33240 These commands can contain various macros that are expanded before execution.
33241 Execution always take place in the directory of the containing document.
33244 \begin_layout Standard
33245 Also, whenever external material is to be displayed, the name will be produced
33246 by the substitution mechanism, and most other commands in the template
33247 definition support substitution as well.
33250 \begin_layout Standard
33251 The available macros are the following:
33254 \begin_layout Description
33255 \begin_inset Flex Code
33258 \begin_layout Plain Layout
33259 $$AbsOrRelPathMaster
33264 The file path, absolute or relative to the master \SpecialChar LyX
33268 \begin_layout Description
33269 \begin_inset Flex Code
33272 \begin_layout Plain Layout
33273 $$AbsOrRelPathParent
33278 The file path, absolute or relative to the \SpecialChar LyX
33282 \begin_layout Description
33283 \begin_inset Flex Code
33286 \begin_layout Plain Layout
33292 The absolute file path.
33295 \begin_layout Description
33296 \begin_inset Flex Code
33299 \begin_layout Plain Layout
33305 The filename without path and without the extension.
33308 \begin_layout Description
33309 \begin_inset Flex Code
33312 \begin_layout Plain Layout
33314 \begin_inset Quotes eld
33318 \begin_inset Quotes erd
33326 This macro will expand to the contents of the file with the name
33327 \begin_inset Flex Code
33330 \begin_layout Plain Layout
33339 \begin_layout Description
33340 \begin_inset Flex Code
33343 \begin_layout Plain Layout
33349 The file extension (including the dot).
33352 \begin_layout Description
33353 \begin_inset Flex Code
33356 \begin_layout Plain Layout
33362 This will be the string
33363 \begin_inset Quotes eld
33367 \begin_inset Quotes erd
33370 if the file is in JPEG format, otherwise it will be the string
33371 \begin_inset Quotes eld
33375 \begin_inset Quotes erd
33379 This is useful to avoid uneeded conversions for output formats that support
33380 both PNG and JPEG fomats.
33381 The predefined RasterImage template uses this macro for the pdf\SpecialChar TeX
33386 \begin_layout Description
33387 \begin_inset Flex Code
33390 \begin_layout Plain Layout
33396 The filename of the file specified in the external material dialog.
33397 This is either an absolute name, or it is relative to the \SpecialChar LyX
33401 \begin_layout Description
33402 \begin_inset Flex Code
33405 \begin_layout Plain Layout
33412 \begin_inset Flex Code
33415 \begin_layout Plain Layout
33421 (absolute name or relative to the \SpecialChar LyX
33425 \begin_layout Description
33426 \begin_inset Flex Code
33429 \begin_layout Plain Layout
33435 The file path, relative to the master \SpecialChar LyX
33439 \begin_layout Description
33440 \begin_inset Flex Code
33443 \begin_layout Plain Layout
33449 The file path, relative to the \SpecialChar LyX
33453 \begin_layout Description
33454 \begin_inset Flex Code
33457 \begin_layout Plain Layout
33463 This macro will expand to the absolute path of the system directory.
33464 This is typically used to point to the various helper scripts that are
33465 bundled with \SpecialChar LyX
33469 \begin_layout Description
33470 \begin_inset Flex Code
33473 \begin_layout Plain Layout
33479 A name and full path to a temporary file which will be automatically deleted
33480 whenever the containing document is closed, or the external material insertion
33484 \begin_layout Standard
33485 All path macros contain a trailing directory separator, so you can construct
33487 \begin_inset space \thinspace{}
33491 \begin_inset space \space{}
33494 the absolute filename with
33495 \begin_inset Flex Code
33498 \begin_layout Plain Layout
33499 $$AbsPath$$Basename$$Extension
33507 \begin_layout Standard
33508 The macros above are substituted in all commands unless otherwise noted.
33510 \begin_inset Flex Code
33513 \begin_layout Plain Layout
33519 supports additionally the following substitutions if they are enabled by
33521 \begin_inset Flex Code
33524 \begin_layout Plain Layout
33531 \begin_inset Flex Code
33534 \begin_layout Plain Layout
33543 \begin_layout Description
33544 \begin_inset Flex Code
33547 \begin_layout Plain Layout
33553 The front part of the resize command.
33556 \begin_layout Description
33557 \begin_inset Flex Code
33560 \begin_layout Plain Layout
33566 The back part of the resize command.
33569 \begin_layout Description
33570 \begin_inset Flex Code
33573 \begin_layout Plain Layout
33579 The front part of the rotation command.
33582 \begin_layout Description
33583 \begin_inset Flex Code
33586 \begin_layout Plain Layout
33592 The back part of the rotation command.
33595 \begin_layout Standard
33596 The value string of the
33597 \begin_inset Flex Code
33600 \begin_layout Plain Layout
33606 command supports additionally the following substitutions if they are enabled
33608 \begin_inset Flex Code
33611 \begin_layout Plain Layout
33618 \begin_inset Flex Code
33621 \begin_layout Plain Layout
33630 \begin_layout Description
33631 \begin_inset Flex Code
33634 \begin_layout Plain Layout
33643 \begin_layout Description
33644 \begin_inset Flex Code
33647 \begin_layout Plain Layout
33656 \begin_layout Description
33657 \begin_inset Flex Code
33660 \begin_layout Plain Layout
33669 \begin_layout Description
33670 \begin_inset Flex Code
33673 \begin_layout Plain Layout
33679 The rotation option.
33682 \begin_layout Standard
33683 You may ask why there are so many path macros.
33684 There are mainly two reasons:
33687 \begin_layout Enumerate
33688 Relative and absolute file names should remain relative or absolute, respectivel
33690 Users may have reasons to prefer either form.
33691 Relative names are useful for portable documents that should work on different
33692 machines, for example.
33693 Absolute names may be required by some programs.
33696 \begin_layout Enumerate
33698 treats relative file names differently than \SpecialChar LyX
33699 and other programs in nested
33701 For \SpecialChar LyX
33702 , a relative file name is always relative to the document that contains
33704 For \SpecialChar LaTeX
33705 , it is always relative to the master document.
33706 These two definitions are identical if you have only one document, but
33707 differ if you have a master document that includes part documents.
33708 That means that relative filenames must be transformed when presented to
33711 Fortunately \SpecialChar LyX
33712 does this automatically for you if you choose the right macros.
33715 \begin_layout Standard
33716 So which path macro should be used in new template definitions? The rule
33720 \begin_layout Itemize
33722 \begin_inset Flex Code
33725 \begin_layout Plain Layout
33731 if an absolute path is required.
33734 \begin_layout Itemize
33736 \begin_inset Flex Code
33739 \begin_layout Plain Layout
33740 $$AbsOrRelPathMaster
33745 if the substituted string is some kind of \SpecialChar LaTeX
33749 \begin_layout Itemize
33751 \begin_inset Flex Code
33754 \begin_layout Plain Layout
33755 $$AbsOrRelPathParent
33760 in order to preserve the user's choice.
33763 \begin_layout Standard
33764 There are special cases where this rule does not work and e.
33765 \begin_inset space \thinspace{}
33769 \begin_inset space \space{}
33772 relative names are needed, but normally it will work just fine.
33773 One example for such a case is the command
33774 \begin_inset Flex Code
33777 \begin_layout Plain Layout
33778 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
33783 in the XFig template above: We can't use the absolute name because the
33785 \begin_inset Flex Code
33788 \begin_layout Plain Layout
33794 files needs the relative name in order to rewrite the file content.
33797 \begin_layout Section
33798 Security discussion
33799 \begin_inset CommandInset label
33801 name "sec:Security-discussion"
33808 \begin_layout Standard
33809 The external material feature interfaces with a lot of external programs
33810 and does so automatically, so we have to consider the security implications
33812 In particular, since you have the option of including your own filenames
33813 and/or parameter strings and those are expanded into a command, it seems
33814 that it would be possible to create a malicious document which executes
33815 arbitrary commands when a user views or prints the document.
33816 This is something we definitely want to avoid.
33819 \begin_layout Standard
33820 However, since the external program commands are specified in the template
33821 configuration file only, there are no security issues if \SpecialChar LyX
33822 is properly configure
33823 d with safe templates only.
33824 This is so because the external programs are invoked with the
33825 \begin_inset Flex Code
33828 \begin_layout Plain Layout
33834 -system call rather than the
33835 \begin_inset Flex Code
33838 \begin_layout Plain Layout
33844 system-call, so it's not possible to execute arbitrary commands from the
33845 filename or parameter section via the shell.
33848 \begin_layout Standard
33849 This also implies that you are restricted in what command strings you can
33850 use in the external material templates.
33851 In particular, pipes and redirection are not readily available.
33852 This has to be so if \SpecialChar LyX
33853 should remain safe.
33854 If you want to use some of the shell features, you should write a safe
33855 script to do this in a controlled manner, and then invoke the script from
33856 the command string.
33860 \begin_layout Standard
33861 It is possible to design a template that interacts directly with the shell,
33862 but since this would allow a malicious user to execute arbitrary commands
33863 by writing clever filenames and/or parameters, we generally recommend that
33864 you only use safe scripts that work with the
33865 \begin_inset Flex Code
33868 \begin_layout Plain Layout
33874 system call in a controlled manner.
33875 Of course, for use in a controlled environment, it can be tempting to just
33876 fall back to use ordinary shell scripts.
33877 If you do so, be aware that you
33881 provide an easily exploitable security hole in your system.
33882 Of course it stands to reason that such unsafe templates will never be
33883 included in the standard \SpecialChar LyX
33884 distribution, although we do encourage people
33885 to submit new templates in the open source tradition.
33886 But \SpecialChar LyX
33887 as shipped from the official distribution channels will never have
33891 \begin_layout Standard
33892 Including external material provides a lot of power, and you have to be
33893 careful not to introduce security hazards with this power.
33894 A subtle error in a single line in an innocent looking script can open
33895 the door to huge security problems.
33896 So if you do not fully understand the issues, we recommend that you consult
33897 a knowledgeable security professional or the \SpecialChar LyX
33898 development team if you have
33899 any questions about whether a given template is safe or not.
33900 And do this before you use it in an uncontrolled environment.
33903 \begin_layout Chapter
33905 List of supported \SpecialChar LyX
33906 functions to be used in layouts
33907 \begin_inset CommandInset label
33909 name "chap:List-of-functions"
33916 \begin_layout Standard
33918 \begin_inset Tabular
33919 <lyxtabular version="3" rows="11" columns="8">
33920 <features tabularvalignment="middle">
33921 <column alignment="left" valignment="top">
33922 <column alignment="left" valignment="top">
33923 <column alignment="left" valignment="top">
33924 <column alignment="left" valignment="top">
33925 <column alignment="left" valignment="top">
33926 <column alignment="left" valignment="top">
33927 <column alignment="left" valignment="top">
33928 <column alignment="left" valignment="top">
33930 <cell alignment="left" valignment="top" usebox="none">
33933 \begin_layout Plain Layout
33939 <cell alignment="left" valignment="top" usebox="none">
33942 \begin_layout Plain Layout
33948 <cell alignment="left" valignment="top" usebox="none">
33951 \begin_layout Plain Layout
33957 <cell alignment="left" valignment="top" usebox="none">
33960 \begin_layout Plain Layout
33966 <cell alignment="center" valignment="top" usebox="none">
33969 \begin_layout Plain Layout
33975 <cell alignment="center" valignment="top" usebox="none">
33978 \begin_layout Plain Layout
33984 <cell alignment="center" valignment="top" usebox="none">
33987 \begin_layout Plain Layout
33993 <cell alignment="center" valignment="top" usebox="none">
33996 \begin_layout Plain Layout
34004 <cell alignment="left" valignment="top" usebox="none">
34007 \begin_layout Plain Layout
34013 <cell alignment="left" valignment="top" usebox="none">
34016 \begin_layout Plain Layout
34022 <cell alignment="left" valignment="top" usebox="none">
34025 \begin_layout Plain Layout
34031 <cell alignment="left" valignment="top" usebox="none">
34034 \begin_layout Plain Layout
34040 <cell alignment="center" valignment="top" usebox="none">
34043 \begin_layout Plain Layout
34049 <cell alignment="center" valignment="top" usebox="none">
34052 \begin_layout Plain Layout
34058 <cell alignment="center" valignment="top" usebox="none">
34061 \begin_layout Plain Layout
34067 <cell alignment="center" valignment="top" usebox="none">
34070 \begin_layout Plain Layout
34078 <cell alignment="left" valignment="top" usebox="none">
34081 \begin_layout Plain Layout
34087 <cell alignment="left" valignment="top" usebox="none">
34090 \begin_layout Plain Layout
34096 <cell alignment="left" valignment="top" usebox="none">
34099 \begin_layout Plain Layout
34105 <cell alignment="left" valignment="top" usebox="none">
34108 \begin_layout Plain Layout
34114 <cell alignment="center" valignment="top" usebox="none">
34117 \begin_layout Plain Layout
34123 <cell alignment="center" valignment="top" usebox="none">
34126 \begin_layout Plain Layout
34132 <cell alignment="center" valignment="top" usebox="none">
34135 \begin_layout Plain Layout
34141 <cell alignment="center" valignment="top" usebox="none">
34144 \begin_layout Plain Layout
34152 <cell alignment="left" valignment="top" usebox="none">
34155 \begin_layout Plain Layout
34161 <cell alignment="left" valignment="top" usebox="none">
34164 \begin_layout Plain Layout
34170 <cell alignment="left" valignment="top" usebox="none">
34173 \begin_layout Plain Layout
34179 <cell alignment="left" valignment="top" usebox="none">
34182 \begin_layout Plain Layout
34188 <cell alignment="center" valignment="top" usebox="none">
34191 \begin_layout Plain Layout
34197 <cell alignment="center" valignment="top" usebox="none">
34200 \begin_layout Plain Layout
34206 <cell alignment="center" valignment="top" usebox="none">
34209 \begin_layout Plain Layout
34215 <cell alignment="center" valignment="top" usebox="none">
34218 \begin_layout Plain Layout
34226 <cell alignment="left" valignment="top" usebox="none">
34229 \begin_layout Plain Layout
34235 <cell alignment="left" valignment="top" usebox="none">
34238 \begin_layout Plain Layout
34244 <cell alignment="left" valignment="top" usebox="none">
34247 \begin_layout Plain Layout
34253 <cell alignment="left" valignment="top" usebox="none">
34256 \begin_layout Plain Layout
34262 <cell alignment="center" valignment="top" usebox="none">
34265 \begin_layout Plain Layout
34271 <cell alignment="center" valignment="top" usebox="none">
34274 \begin_layout Plain Layout
34280 <cell alignment="center" valignment="top" usebox="none">
34283 \begin_layout Plain Layout
34289 <cell alignment="center" valignment="top" usebox="none">
34292 \begin_layout Plain Layout
34300 <cell alignment="left" valignment="top" usebox="none">
34303 \begin_layout Plain Layout
34309 <cell alignment="left" valignment="top" usebox="none">
34312 \begin_layout Plain Layout
34318 <cell alignment="left" valignment="top" usebox="none">
34321 \begin_layout Plain Layout
34327 <cell alignment="left" valignment="top" usebox="none">
34330 \begin_layout Plain Layout
34336 <cell alignment="center" valignment="top" usebox="none">
34339 \begin_layout Plain Layout
34345 <cell alignment="center" valignment="top" usebox="none">
34348 \begin_layout Plain Layout
34354 <cell alignment="center" valignment="top" usebox="none">
34357 \begin_layout Plain Layout
34363 <cell alignment="center" valignment="top" usebox="none">
34366 \begin_layout Plain Layout
34374 <cell alignment="left" valignment="top" usebox="none">
34377 \begin_layout Plain Layout
34383 <cell alignment="left" valignment="top" usebox="none">
34386 \begin_layout Plain Layout
34392 <cell alignment="left" valignment="top" usebox="none">
34395 \begin_layout Plain Layout
34401 <cell alignment="left" valignment="top" usebox="none">
34404 \begin_layout Plain Layout
34410 <cell alignment="center" valignment="top" usebox="none">
34413 \begin_layout Plain Layout
34419 <cell alignment="center" valignment="top" usebox="none">
34422 \begin_layout Plain Layout
34428 <cell alignment="center" valignment="top" usebox="none">
34431 \begin_layout Plain Layout
34437 <cell alignment="center" valignment="top" usebox="none">
34440 \begin_layout Plain Layout
34448 <cell alignment="left" valignment="top" usebox="none">
34451 \begin_layout Plain Layout
34457 <cell alignment="left" valignment="top" usebox="none">
34460 \begin_layout Plain Layout
34466 <cell alignment="left" valignment="top" usebox="none">
34469 \begin_layout Plain Layout
34475 <cell alignment="left" valignment="top" usebox="none">
34478 \begin_layout Plain Layout
34484 <cell alignment="center" valignment="top" usebox="none">
34487 \begin_layout Plain Layout
34493 <cell alignment="center" valignment="top" usebox="none">
34496 \begin_layout Plain Layout
34502 <cell alignment="center" valignment="top" usebox="none">
34505 \begin_layout Plain Layout
34511 <cell alignment="center" valignment="top" usebox="none">
34514 \begin_layout Plain Layout
34522 <cell alignment="left" valignment="top" usebox="none">
34525 \begin_layout Plain Layout
34531 <cell alignment="left" valignment="top" usebox="none">
34534 \begin_layout Plain Layout
34540 <cell alignment="left" valignment="top" usebox="none">
34543 \begin_layout Plain Layout
34549 <cell alignment="left" valignment="top" usebox="none">
34552 \begin_layout Plain Layout
34558 <cell alignment="center" valignment="top" usebox="none">
34561 \begin_layout Plain Layout
34567 <cell alignment="center" valignment="top" usebox="none">
34570 \begin_layout Plain Layout
34576 <cell alignment="center" valignment="top" usebox="none">
34579 \begin_layout Plain Layout
34585 <cell alignment="center" valignment="top" usebox="none">
34588 \begin_layout Plain Layout
34596 <cell alignment="left" valignment="top" usebox="none">
34599 \begin_layout Plain Layout
34605 <cell alignment="left" valignment="top" usebox="none">
34608 \begin_layout Plain Layout
34614 <cell alignment="left" valignment="top" usebox="none">
34617 \begin_layout Plain Layout
34623 <cell alignment="left" valignment="top" usebox="none">
34626 \begin_layout Plain Layout
34632 <cell alignment="center" valignment="top" usebox="none">
34635 \begin_layout Plain Layout
34641 <cell alignment="center" valignment="top" usebox="none">
34644 \begin_layout Plain Layout
34650 <cell alignment="center" valignment="top" usebox="none">
34653 \begin_layout Plain Layout
34659 <cell alignment="center" valignment="top" usebox="none">
34662 \begin_layout Plain Layout
34670 <cell alignment="center" valignment="top" usebox="none">
34673 \begin_layout Plain Layout
34679 <cell alignment="center" valignment="top" usebox="none">
34682 \begin_layout Plain Layout
34688 <cell alignment="center" valignment="top" usebox="none">
34691 \begin_layout Plain Layout
34697 <cell alignment="center" valignment="top" usebox="none">
34700 \begin_layout Plain Layout
34706 <cell alignment="center" valignment="top" usebox="none">
34709 \begin_layout Plain Layout
34715 <cell alignment="center" valignment="top" usebox="none">
34718 \begin_layout Plain Layout
34724 <cell alignment="center" valignment="top" usebox="none">
34727 \begin_layout Plain Layout
34733 <cell alignment="center" valignment="top" usebox="none">
34736 \begin_layout Plain Layout
34750 \begin_layout Chapter
34751 Names of available colors to be used in layouts
34752 \begin_inset CommandInset label
34754 name "chap:Names-of-colors"
34761 \begin_layout Standard
34762 The colors listed below are the standard colors and those that you can adjust
34763 in the \SpecialChar LyX
34767 \begin_layout Section
34771 \begin_layout Standard
34772 The following are no real colors, but rather act on color definitions:
34775 \begin_layout Description
34776 ignore The color is ignored
34779 \begin_layout Description
34780 inherit The color is inherited
34783 \begin_layout Description
34796 No particular color – clear or default
34799 \begin_layout Section
34803 \begin_layout Standard
34804 These are fixed colors that cannot be customized
34805 \change_inserted -712698321 1607683177
34811 use these colors in layout definitions, since they will not work well with
34812 some color themes (such as dark themes)
34817 \begin_layout Description
34821 \begin_layout Description
34825 \begin_layout Description
34829 \begin_layout Description
34833 \begin_layout Description
34837 \begin_layout Description
34841 \begin_layout Description
34845 \begin_layout Description
34849 \begin_layout Description
34853 \begin_layout Description
34857 \begin_layout Description
34861 \begin_layout Description
34865 \begin_layout Description
34869 \begin_layout Description
34873 \begin_layout Description
34877 \begin_layout Description
34881 \begin_layout Description
34885 \begin_layout Description
34889 \begin_layout Description
34893 \begin_layout Section
34897 \begin_layout Standard
34898 These are the colors allocated to specific elements in
34901 arg "dialog-show prefs"
34907 \begin_layout Description
34908 added_space Added space color
34911 \begin_layout Description
34912 addedtext Added text color
34915 \begin_layout Description
34916 appendix Appendix marker color
34919 \begin_layout Description
34920 background Background color
34923 \begin_layout Description
34924 bottomarea Bottom area color
34927 \begin_layout Description
34928 branchlabel Label color for branches
34931 \begin_layout Description
34932 buttonbg Color used for button background
34935 \begin_layout Description
34936 buttonframe Color for inset button frames
34939 \begin_layout Description
34940 buttonhoverbg Color used for button background under focus
34943 \begin_layout Description
34944 changebar Changebar color
34947 \begin_layout Description
34948 changedtextauthor1 Changed text color author 1
34951 \begin_layout Description
34952 changedtextauthor2 Changed text color author 2
34955 \begin_layout Description
34956 changedtextauthor3 Changed text color author 3
34959 \begin_layout Description
34960 changedtextauthor4 Changed text color author 4
34963 \begin_layout Description
34964 changedtextauthor5 Changed text color author 5
34967 \begin_layout Description
34968 collapsible Collapsible insets text color
34971 \begin_layout Description
34972 collapsibleframe Collapsible insets framecolor
34975 \begin_layout Description
34976 command Text color for command insets
34979 \begin_layout Description
34980 commandbg Background color for command insets
34983 \begin_layout Description
34984 commandframe Frame color for command insets
34987 \begin_layout Description
34988 comment Label color for comments
34991 \begin_layout Description
34992 commentbg Background color of comments
34995 \begin_layout Description
34996 cursor Cursor color
34999 \begin_layout Description
35000 deletedtext Deleted text color
35003 \begin_layout Description
35004 deletedtextmodifier Deleted text modifying color
35007 \begin_layout Description
35008 depthbar Color for the depth bars in the margin
35011 \begin_layout Description
35012 eolmarker End of line marker color
35015 \begin_layout Description
35016 error Color of the \SpecialChar LaTeX
35020 \begin_layout Description
35021 footlabel Label color for footnotes
35024 \begin_layout Description
35025 foreground Foreground color
35028 \begin_layout Description
35029 graphicsbg Graphics inset background color
35032 \begin_layout Description
35033 greyedoutbg Background color of greyedout inset
35036 \begin_layout Description
35037 greyedoutlabel Label color for greyedout insets
35040 \begin_layout Description
35041 greyedouttext Color for greyedout inset text
35044 \begin_layout Description
35045 indexlabel Label color for index insets
35048 \begin_layout Description
35049 inlinecompletion Inline completion color
35052 \begin_layout Description
35053 insetbg Inset marker background color
35056 \begin_layout Description
35057 insetframe Inset marker frame color
35060 \begin_layout Description
35061 language Color for marking foreign language words
35064 \begin_layout Description
35065 latex Text color in \SpecialChar LaTeX
35069 \begin_layout Description
35070 listingsbg Background color of listings inset
35073 \begin_layout Description
35074 marginlabel Label color for margin notes
35077 \begin_layout Description
35078 math Math inset text color
35081 \begin_layout Description
35082 mathbg Math inset background color
35085 \begin_layout Description
35086 mathcorners Math inset frame color not under focus
35089 \begin_layout Description
35090 mathframe Math inset frame color under focus
35093 \begin_layout Description
35094 mathline Math line color
35097 \begin_layout Description
35098 mathmacrobg Macro math inset background color
35101 \begin_layout Description
35102 mathmacroblend Macro math blended color
35105 \begin_layout Description
35106 mathmacroframe Macro math frame color
35109 \begin_layout Description
35110 mathmacrohoverbg Macro math inset background color hovered
35113 \begin_layout Description
35114 mathmacrolabel Macro math label color
35117 \begin_layout Description
35118 mathmacronewarg Macro template color for new parameters
35121 \begin_layout Description
35122 mathmacrooldarg Macro template color for old parameters
35125 \begin_layout Description
35126 newpage New page color
35129 \begin_layout Description
35130 nonunique_inlinecompletion Inline completion color for the non-unique part
35133 \begin_layout Description
35134 note Label color for notes
35137 \begin_layout Description
35138 notebg Background color of notes
35141 \begin_layout Description
35142 pagebreak Page break/line break color
35145 \begin_layout Description
35146 paragraphmarker Color used for the pilcrow sign to mark the end of a paragraph
35149 \begin_layout Description
35150 phantomtext Text color for phantom insets
35153 \begin_layout Description
35154 preview The color used for previews
35157 \begin_layout Description
35158 previewframe Preview frame color
35161 \begin_layout Description
35162 regexpframe Color for regexp frame
35165 \begin_layout Description
35166 scroll Color that indicates when a row can be scrolled
35169 \begin_layout Description
35170 selection Background color of selected text
35173 \begin_layout Description
35174 selectiontext Foreground color of selected text
35177 \begin_layout Description
35178 shadedbg Background color of shaded box
35181 \begin_layout Description
35182 special Special chars text color
35185 \begin_layout Description
35186 tabularline Table line color
35189 \begin_layout Description
35190 tabularonoffline Table line color
35191 \change_inserted -712698321 1607682522
35195 \begin_layout Description
35197 \change_inserted -712698321 1607682563
35198 textlabel1 Color 1 of layout and custom inset labels
35201 \begin_layout Description
35203 \change_inserted -712698321 1607682565
35204 textlabel2 Color 2 of layout and custom inset labels
35207 \begin_layout Description
35209 \change_inserted -712698321 1607682568
35210 textlabel3 Color 3 of layout and custom inset labels
35215 \begin_layout Description
35216 urllabel Label color for URL insets
35219 \begin_layout Description
35220 urltext Color for URL inset text