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
109 \notefontcolor #0000ff
113 \color #f5fae7 #0a0518
121 \paragraph_separation indent
122 \paragraph_indentation default
124 \math_indentation default
125 \math_numbering_side default
126 \quotes_style english
130 \paperpagestyle headings
132 \tracking_changes true
133 \output_changes false
135 \postpone_fragile_content false
139 \docbook_table_output 0
140 \docbook_mathml_prefix 1
141 \author -970929547 "Thibaut Cuvelier"
142 \author -712698321 "Jürgen Spitzmüller"
143 \author -584632292 "Richard Kimberly Heck"
144 \author -495245474 "Jean-Marc Lasgouttes"
147 \author 34634807 "Jean-Pierre"
148 \author 47243155 "Jean-Marc"
149 \author 193502281 "pc1"
150 \author 232239728 "Owner"
151 \author 731793113 "Richard Kimberly Heck" rikiheck@lyx.org
152 \author 1075283030 "Thibaut"
158 Customizing \SpecialChar LyX
160 Features for the Advanced User
164 by the \SpecialChar LyX
169 \begin_layout Plain Layout
170 If you have comments or error corrections,
171 please send them to the \SpecialChar LyX
172 Documentation mailing list,
174 \begin_inset CommandInset href
176 target "lyx-docs@lists.lyx.org"
184 \begin_inset Quotes eld
188 \begin_inset Quotes erd
191 in the subject header,
192 and please cc the current maintainer of this file,
194 \change_inserted 5863208 1604930692
198 \change_inserted 5863208 1604930729
200 \change_deleted 5863208 1604930668
209 \begin_inset Newline newline
213 \begin_inset Newline newline
219 \begin_layout Standard
220 \begin_inset CommandInset toc
221 LatexCommand tableofcontents
228 \begin_layout Standard
229 \begin_inset Note Note
232 \begin_layout Plain Layout
233 Please use change tracking when modifying this document.
234 This makes it easier for our translators to recognize things that have been changed,
235 and it helps the maintainer keep up-to-date with what's been done.
243 \begin_layout Chapter
247 \begin_layout Standard
248 This manual covers the customization features present in \SpecialChar LyX
251 we discuss issues like keyboard shortcuts,
252 screen previewing options,
254 sending commands to \SpecialChar LyX
255 via the \SpecialChar LyX
257 internationalization,
258 installing new \SpecialChar LaTeX
259 classes and \SpecialChar LyX
262 We can't possibly hope to touch on everything you can change—
263 our developers add new features faster than we can document them—
264 but we will explain the most common customizations and hopefully point you in the right direction for some of the more obscure ones.
267 \begin_layout Standard
268 \begin_inset Branch OutDated
272 \begin_layout Standard
273 Information from previous versions of this document that now seems to be outdated is contained in the OutDated branch of this document.
275 this information will not appear in the \SpecialChar LaTeX
284 \begin_layout Chapter
289 \begin_layout Standard
290 This chapter aims to help you to find your way through the \SpecialChar LyX
292 Before continuing to read this chapter,
293 you should find out where your \SpecialChar LyX
295 \change_deleted -712698321 1693046672
297 \change_inserted -712698321 1693046674
300 and user directories are by using
301 \begin_inset Flex Noun
304 \begin_layout Plain Layout
305 Help\SpecialChar menuseparator
317 \change_deleted -712698321 1693046679
319 \change_inserted -712698321 1693046679
322 directory is the place where \SpecialChar LyX
323 places its system-wide configuration files;
324 the user directory is where you can place your modified versions.
325 We will call the former
326 \begin_inset Flex Code
329 \begin_layout Plain Layout
336 \begin_inset Flex Noun
339 \begin_layout Plain Layout
345 in the remainder of this document.
349 \begin_layout Section
351 \begin_inset Flex Code
354 \begin_layout Plain Layout
363 \begin_layout Standard
364 \begin_inset Flex Code
367 \begin_layout Plain Layout
373 and its sub-directories contain a number of files
374 \change_deleted 232239728 1604787780
377 that can be used to customize \SpecialChar LyX
379 You can change many of these files from within \SpecialChar LyX
381 \begin_inset Flex Noun
384 \begin_layout Plain Layout
385 Tools\SpecialChar menuseparator
392 Most customization that you will want to do in \SpecialChar LyX
393 is possible through this dialog.
395 many other inner aspects of \SpecialChar LyX
396 can be customized by modifying the files in
397 \begin_inset Flex Code
400 \begin_layout Plain Layout
407 These files fall in different categories,
408 described in the following subsections.
411 \begin_layout Subsection
412 Automatically generated files
415 \begin_layout Standard
417 \begin_inset Flex Noun
420 \begin_layout Plain Layout
426 are generated when you configure \SpecialChar LyX
428 They contain various default values that are
429 \change_inserted 5863208 1604919565
430 automatically detected during reconfiguration.
431 \change_deleted 232239728 1604788241
432 guessed by inspection
435 it is not a good idea to modify them,
436 since they might be overwritten at any time.
439 \begin_layout Labeling
440 \labelwidthstring 00.00.0000
441 \begin_inset Flex Code
444 \begin_layout Plain Layout
451 \change_deleted 5863208 1604919950
453 \begin_inset Note Note
456 \begin_layout Plain Layout
458 \change_inserted 232239728 1604853928
459 I capitalized the first word in all of these lists.
460 To me it looks better but it really is a stylistic thing,
462 However if you are not going to capitalize them,
463 the english in some needs to be modified to make it read correctly as a sentence.
471 \change_deleted 232239728 1604853510
473 \change_inserted 232239728 1604853510
476 ontains defaults for various commands.
479 \begin_layout Labeling
480 \labelwidthstring 00.00.0000
481 \begin_inset Flex Code
484 \begin_layout Plain Layout
491 \change_deleted 232239728 1604853512
493 \change_inserted 232239728 1604853512
496 ontains the list of packages that have been recognized by \SpecialChar LyX
498 It is currently unused by the \SpecialChar LyX
500 but the information extracted,
502 is made available with
503 \begin_inset Flex Noun
506 \begin_layout Plain Layout
507 Help\SpecialChar menuseparator
521 \begin_layout Labeling
522 \labelwidthstring 00.00.0000
523 \begin_inset Flex Code
526 \begin_layout Plain Layout
533 \change_deleted 232239728 1604853515
535 \change_inserted 232239728 1604853515
538 he list of text classes that have been found in your
539 \begin_inset Flex Code
542 \begin_layout Plain Layout
549 along with the associated \SpecialChar LaTeX
550 document class and their description.
553 \begin_layout Labeling
554 \labelwidthstring 00.00.0000
555 \begin_inset Flex Code
558 \begin_layout Plain Layout
565 \change_deleted 232239728 1604853518
567 \change_inserted 232239728 1604853518
570 he list of layout modules found in your
571 \begin_inset Flex Code
574 \begin_layout Plain Layout
583 \begin_layout Labeling
584 \labelwidthstring 00.00.0000
585 \begin_inset Flex Code
588 \begin_layout Plain Layout
595 \change_deleted 232239728 1604853523
597 \change_inserted 232239728 1604853523
600 ists of various sorts of \SpecialChar LaTeX
601 -related files found on your system
604 \begin_layout Labeling
605 \labelwidthstring 00.00.0000
606 \begin_inset Flex Code
609 \begin_layout Plain Layout
610 doc/\SpecialChar LaTeX
616 is automatically generated during configuration from the file
617 \begin_inset Flex Code
620 \begin_layout Plain Layout
628 It contains information on your \SpecialChar LaTeX
632 \begin_layout Subsection
636 \begin_layout Standard
638 \change_deleted 5863208 1604928729
642 \change_inserted 5863208 1604928636
646 \change_inserted 5863208 1604928661
650 \begin_inset Flex Code
653 \begin_layout Plain Layout
660 \change_inserted 5863208 1604928662
662 \change_deleted 5863208 1604928642
666 \change_deleted 5863208 1604928669
668 \begin_inset Flex Code
671 \begin_layout Plain Layout
678 \change_inserted 5863208 1604928680
682 \begin_inset Flex Code
685 \begin_layout Plain Layout
693 \change_deleted 232239728 1604794430
696 exists in both places,
698 \begin_inset Flex Code
701 \begin_layout Plain Layout
710 \begin_layout Labeling
711 \labelwidthstring 00.00.0000
712 \begin_inset Flex Code
715 \begin_layout Plain Layout
722 \change_deleted 232239728 1604794460
724 \change_inserted 232239728 1604794460
727 his directory contains files with the extension
728 \begin_inset Flex Code
731 \begin_layout Plain Layout
737 that define the keybindings used in \SpecialChar LyX
739 If there exists an internationalized version of the bind file
740 \change_inserted -712698321 1669371749
742 \change_deleted -712698321 1669371727
744 \begin_inset Flex Code
747 \begin_layout Plain Layout
754 \change_inserted -712698321 1669371728
756 \begin_inset Flex Code
759 \begin_layout Plain Layout
761 \change_inserted -712698321 1669371732
770 \begin_inset Quotes eld
774 \begin_inset Quotes erd
777 is the ISO language code
780 that will be used first.
783 \begin_layout Labeling
784 \labelwidthstring 00.00.0000
785 \begin_inset Flex Code
788 \begin_layout Plain Layout
795 \change_deleted 232239728 1604794478
797 \change_inserted 232239728 1604794478
800 ontains files with the extension
801 \begin_inset Flex Code
804 \begin_layout Plain Layout
810 which define the diverse citation possibilities (natbib,
813 \begin_inset CommandInset ref
815 reference "subsec:Cite-Engine-Files"
826 \begin_layout Labeling
827 \labelwidthstring 00.00.0000
828 \begin_inset Flex Code
831 \begin_layout Plain Layout
838 \change_deleted 232239728 1604794483
840 \change_inserted 232239728 1604794486
843 ontains graphics files that can be included in documents.
847 \begin_layout Labeling
848 \labelwidthstring 00.00.0000
849 \begin_inset Flex Code
852 \begin_layout Plain Layout
859 \change_deleted 232239728 1604794492
861 \change_inserted 232239728 1604794492
864 ontains \SpecialChar LyX
865 documentation files (including the one you are currently reading).
867 \begin_inset Flex Code
870 \begin_layout Plain Layout
872 \change_deleted 232239728 1604794660
875 \change_inserted 232239728 1604794661
883 deserves special attention,
885 The internationalized help docs are in subdirectories
886 \begin_inset Flex Code
889 \begin_layout Plain Layout
896 \begin_inset Quotes eld
900 \begin_inset Quotes erd
903 is the ISO language code.
905 \begin_inset CommandInset ref
907 reference "cha:Internationalizing-LyX"
915 \begin_layout Labeling
916 \labelwidthstring 00.00.0000
917 \begin_inset Flex Code
920 \begin_layout Plain Layout
927 \change_deleted 232239728 1604794497
929 \change_inserted 232239728 1604794497
932 ontains example files that explain how to use some features.
935 \begin_inset Flex Noun
938 \begin_layout Plain Layout
947 \begin_layout Labeling
948 \labelwidthstring 00.00.0000
949 \begin_inset Flex Code
952 \begin_layout Plain Layout
959 \change_deleted 232239728 1604794500
961 \change_inserted 232239728 1604794500
964 ontains image files that are used by the
965 \begin_inset Flex Noun
968 \begin_layout Plain Layout
976 it also contains the individual icons used in the toolbar and the banners that can be shown when \SpecialChar LyX
980 \begin_layout Labeling
981 \labelwidthstring 00.00.0000
982 \begin_inset Flex Code
985 \begin_layout Plain Layout
992 \change_deleted 232239728 1604794505
994 \change_inserted 232239728 1604794505
997 ontains keyboard keymapping files.
999 \begin_inset CommandInset ref
1001 reference "sec:International-Keymap-Stuff"
1009 \begin_layout Labeling
1010 \labelwidthstring 00.00.0000
1011 \begin_inset Flex Code
1014 \begin_layout Plain Layout
1021 \change_deleted 232239728 1604794508
1023 \change_inserted 232239728 1604794508
1026 ontains the text class and module files described in
1027 \begin_inset CommandInset ref
1029 reference "cha:Installing-New-Document"
1037 \begin_layout Labeling
1038 \labelwidthstring 00.00.0000
1039 \begin_inset Flex Code
1042 \begin_layout Plain Layout
1049 \change_deleted 232239728 1604794513
1051 \change_inserted 232239728 1604794513
1055 \begin_inset Flex Code
1058 \begin_layout Plain Layout
1064 Python scripts used to convert between \SpecialChar LyX
1066 These can be run from the command line if
1067 \change_deleted 232239728 1604794749
1072 you want to batch-convert files.
1075 \begin_layout Labeling
1076 \labelwidthstring 00.00.0000
1077 \begin_inset Flex Code
1080 \begin_layout Plain Layout
1087 \change_deleted 232239728 1604794516
1089 \change_inserted 232239728 1604794516
1092 ontains some files that demonstrate the capabilities of the
1093 \begin_inset Flex Noun
1096 \begin_layout Plain Layout
1098 \begin_inset space ~
1107 Also contains some scripts used by \SpecialChar LyX
1111 \begin_layout Labeling
1112 \labelwidthstring 00.00.0000
1113 \begin_inset Flex Code
1116 \begin_layout Plain Layout
1123 \change_deleted 232239728 1604794520
1125 \change_inserted 232239728 1604794520
1128 ontains the standard \SpecialChar LyX
1129 template files described in
1130 \begin_inset CommandInset ref
1132 reference "subsec:Creating-Templates"
1140 \begin_layout Labeling
1141 \labelwidthstring 00.00.0000
1142 \begin_inset Flex Code
1145 \begin_layout Plain Layout
1152 \change_deleted 232239728 1604794524
1154 \change_inserted 232239728 1604794524
1157 ontains files with the extension
1158 \begin_inset Flex Code
1161 \begin_layout Plain Layout
1167 that define the user interface to \SpecialChar LyX
1170 the files define which items appear in which menus and the items appearing on the toolbar.
1173 \begin_layout Labeling
1174 \labelwidthstring 00.00.0000
1175 \begin_inset Flex Code
1178 \begin_layout Plain Layout
1185 \change_deleted 232239728 1604794528
1187 \change_inserted 232239728 1604794528
1190 ontains files with the extension
1191 \begin_inset Flex Code
1194 \begin_layout Plain Layout
1200 which define the templates for the insertion of external material to a \SpecialChar LyX
1203 \begin_inset CommandInset ref
1205 reference "chap:Including-External-Material"
1213 \begin_layout Subsection
1214 Files you don't want to modify
1217 \begin_layout Standard
1218 These files are used internally by \SpecialChar LyX
1219 and you generally do not need to modify them unless you are a developer.
1222 \begin_layout Labeling
1223 \labelwidthstring 00.00.0000
1224 \begin_inset Flex Code
1227 \begin_layout Plain Layout
1234 \change_deleted 232239728 1604797616
1236 \change_inserted 232239728 1604797616
1239 his file contains the list of \SpecialChar LyX
1241 The contents are displayed with the menu entry
1242 \begin_inset Flex Noun
1245 \begin_layout Plain Layout
1246 Help\SpecialChar menuseparator
1248 \begin_inset space ~
1259 \begin_layout Labeling
1260 \labelwidthstring 00.00.0000
1261 \begin_inset Flex Code
1264 \begin_layout Plain Layout
1271 \change_deleted 232239728 1604797620
1273 \change_inserted 232239728 1604797620
1276 his is a \SpecialChar LaTeX
1277 script used during the configuration process.
1278 Do not run directly.
1281 \begin_layout Labeling
1282 \labelwidthstring 00.00.0000
1283 \begin_inset Flex Code
1286 \begin_layout Plain Layout
1293 \change_deleted 232239728 1604797624
1295 \change_inserted 232239728 1604797624
1298 his is a Python script that is used to re-configure \SpecialChar LyX
1300 It creates configuration files in the directory it was run from.
1303 \begin_layout Subsection
1304 Other files needing a line or two
1307 \begin_layout Labeling
1308 \labelwidthstring 00.00.0000
1309 \begin_inset Flex Code
1312 \begin_layout Plain Layout
1319 \change_deleted 232239728 1604797580
1321 \change_inserted 232239728 1604797580
1324 his contains tables describing how different character encodings can be mapped to Unicode
1327 \begin_layout Labeling
1328 \labelwidthstring 00.00.0000
1329 \begin_inset Flex Code
1332 \begin_layout Plain Layout
1339 \change_deleted 232239728 1604797584
1341 \change_inserted 232239728 1604797584
1344 his file contains a list of all the languages currently supported by \SpecialChar LyX
1348 \begin_layout Labeling
1349 \labelwidthstring 00.00.0000
1350 \begin_inset Flex Code
1353 \begin_layout Plain Layout
1360 \change_deleted 232239728 1604797587
1362 \change_inserted 232239728 1604797587
1365 ontains information about the supported fonts.
1368 \begin_layout Labeling
1369 \labelwidthstring 00.00.0000
1370 \begin_inset Flex Code
1373 \begin_layout Plain Layout
1380 \change_deleted 232239728 1604797591
1382 \change_inserted 232239728 1604797591
1385 his file contains translations for internationalized paragraph styles (see
1386 \begin_inset CommandInset ref
1388 reference "subsec:I18n"
1396 \begin_layout Labeling
1397 \labelwidthstring 00.00.0000
1398 \begin_inset Flex Code
1401 \begin_layout Plain Layout
1408 \change_deleted 232239728 1604797594
1410 \change_inserted 232239728 1604797594
1413 his file contains information about Unicode-encoded glyphs and the way they are supported by \SpecialChar LyX
1414 via \SpecialChar LaTeX
1418 \begin_layout Section
1419 Your local configuration directory
1422 \begin_layout Standard
1423 Even if you are using \SpecialChar LyX
1424 as an unprivileged user,
1425 you might want to change \SpecialChar LyX
1426 configuration for your own use.
1428 \begin_inset Flex Code
1431 \begin_layout Plain Layout
1437 directory contains all your personal configuration files.
1438 This is the directory described as
1439 \begin_inset Quotes eld
1443 \begin_inset Quotes erd
1447 \begin_inset Flex Noun
1450 \begin_layout Plain Layout
1451 Help\SpecialChar menuseparator
1453 \begin_inset space ~
1462 This directory is used as a mirror of
1463 \begin_inset Flex Code
1466 \begin_layout Plain Layout
1473 which means that every file in
1474 \begin_inset Flex Code
1477 \begin_layout Plain Layout
1483 is a replacement for the corresponding file in
1484 \begin_inset Flex Code
1487 \begin_layout Plain Layout
1494 Any configuration file described in the above sections can be placed either in the system-wide directory,
1495 in which case it will affect all users,
1496 or in your local directory for your own use.
1499 \begin_layout Standard
1500 To make things clearer,
1501 let's provide a few examples:
1504 \begin_layout Itemize
1505 The preferences set in the
1506 \begin_inset Flex Noun
1509 \begin_layout Plain Layout
1510 Tools\SpecialChar menuseparator
1516 dialog are saved to a file
1517 \begin_inset Flex Code
1520 \begin_layout Plain Layout
1527 \begin_inset Flex Code
1530 \begin_layout Plain Layout
1539 \begin_layout Itemize
1540 When you reconfigure using
1541 \begin_inset Flex Noun
1544 \begin_layout Plain Layout
1545 Tools\SpecialChar menuseparator
1554 \begin_inset Flex Code
1557 \begin_layout Plain Layout
1564 and the resulting files are written in your local configuration directory.
1565 This means that any additional text class file that you might have added in
1566 \begin_inset Flex Code
1569 \begin_layout Plain Layout
1575 will be added to the list of classes in the
1576 \begin_inset Flex Noun
1579 \begin_layout Plain Layout
1580 Document\SpecialChar menuseparator
1589 \begin_layout Itemize
1590 If you get some updated documentation from
1591 \change_inserted 232239728 1604798171
1595 ftp site and cannot install it because you do not have sysadmin rights on your system,
1596 you can just copy the files
1597 \change_deleted 232239728 1604798193
1599 \change_inserted 232239728 1604798193
1603 \begin_inset Flex Code
1606 \begin_layout Plain Layout
1612 and the items in the
1613 \begin_inset Flex Noun
1616 \begin_layout Plain Layout
1622 menu will open them!
1625 \begin_layout Section
1626 Running \SpecialChar LyX
1627 with multiple configurations
1630 \begin_layout Standard
1631 The configuration freedom of the local configuration directory may not suffice if you want to have more than one configuration at your disposal.
1634 \change_deleted 232239728 1604798238
1637 use different key bindings or printer settings at different times.
1638 You can achieve this by having several such directories.
1639 You then specify which directory to use at run-time.
1642 \begin_layout Standard
1643 Invoking \SpecialChar LyX
1644 with the command line switch
1645 \begin_inset Flex Code
1648 \begin_layout Plain Layout
1658 instructs the program to read the configuration from that directory,
1659 and not from the default directory.
1660 (You can determine the default directory by running \SpecialChar LyX
1662 \begin_inset Flex Code
1665 \begin_layout Plain Layout
1671 switch.) If the specified directory does not exist,
1673 offers to create it for you,
1674 just like it does for the default directory
1675 \change_deleted 232239728 1604798318
1678 the first time you run the program.
1679 You can modify the configuration options in this additional user directory exactly as you would for the default directory.
1680 These directories are completely independent (but read on).
1681 Note that setting the environment variable
1682 \begin_inset Flex Code
1685 \begin_layout Plain Layout
1691 to some value has exactly the same effect.
1694 \begin_layout Standard
1695 Having several configurations also requires more maintenance:
1696 if you want to add a new layout to
1697 \begin_inset Flex Code
1700 \begin_layout Plain Layout
1706 which you want available from all your configurations,
1707 you must add it to each directory separately.
1708 You can avoid this with the following trick:
1709 after \SpecialChar LyX
1710 creates the additional directory,
1711 most of the subdirectories (see above) are empty.
1712 If you want the new configuration to mirror an existing one,
1713 replace the empty subdirectory with a symbolic link to the matching subdirectory in the existing configuration.
1715 \begin_inset Flex Code
1718 \begin_layout Plain Layout
1726 since it contains a file written by the configuration script (also accessible through
1727 \begin_inset Flex Noun
1730 \begin_layout Plain Layout
1731 Tools\SpecialChar menuseparator
1737 ) which is configuration
1738 \change_deleted 232239728 1604798083
1740 \change_inserted 232239728 1604798100
1746 \begin_layout Chapter
1747 The Preferences dialog
1750 \begin_layout Standard
1751 All options of the preferences dialog are described in the Appendix
1753 The Preferences Dialog
1760 For some options you might find here more details.
1763 \begin_layout Section
1765 \begin_inset CommandInset label
1774 \begin_layout Standard
1775 The first step is to define your file formats if they are not already defined.
1778 \begin_inset Flex Noun
1781 \begin_layout Plain Layout
1782 Tools\SpecialChar menuseparator
1790 \begin_inset Flex Noun
1793 \begin_layout Plain Layout
1794 File Handling\SpecialChar menuseparator
1801 \begin_inset Flex Noun
1804 \begin_layout Plain Layout
1810 button to define your new format.
1812 \begin_inset Flex Noun
1815 \begin_layout Plain Layout
1821 field contains the name used to identify the format in the GUI.
1823 \begin_inset Flex Noun
1826 \begin_layout Plain Layout
1832 is used to identify the format internally.
1833 You will also need to enter a file extension.
1834 These are all required.
1836 \begin_inset Flex Noun
1839 \begin_layout Plain Layout
1845 field is used to provide a keyboard shortcut on the menus.
1848 \begin_inset Flex Noun
1851 \begin_layout Plain Layout
1858 \begin_inset Flex Noun
1861 \begin_layout Plain Layout
1862 Document\SpecialChar menuseparator
1863 View (Other Formats)\SpecialChar menuseparator
1872 \begin_layout Standard
1874 \begin_inset Flex Noun
1877 \begin_layout Plain Layout
1884 \begin_inset Flex Noun
1887 \begin_layout Plain Layout
1895 you might want to use
1896 \begin_inset Flex Noun
1899 \begin_layout Plain Layout
1905 to view PostScript files.
1906 You can enter the command needed to start the program in the corresponding fields.
1907 In defining this command,
1908 you can use the four variables listed in the next section.
1909 The viewer is launched when you view an image in \SpecialChar LyX
1911 \begin_inset Flex Noun
1914 \begin_layout Plain Layout
1915 Document\SpecialChar menuseparator
1922 The editor is for example launched when you right-click on an image and choose
1923 \begin_inset Flex Noun
1926 \begin_layout Plain Layout
1932 in the appearing context menu.
1935 \begin_layout Standard
1937 \begin_inset Flex Noun
1940 \begin_layout Plain Layout
1946 type of a format is optional,
1947 but if it is specified,
1948 it must be unique across all formats.
1949 It is used to detect files of this format from the file contents.
1950 For some important file formats there is no MIME type officially registered with the
1951 \begin_inset CommandInset href
1954 target "http://www.iana.org/assignments/media-types/"
1960 Therefore \SpecialChar LyX
1961 uses the extended list of MIME types as specified by
1962 \begin_inset CommandInset href
1964 name "freedesktop.org"
1965 target "http://www.freedesktop.org/wiki/Specifications/shared-mime-info-spec"
1973 \begin_layout Standard
1975 \begin_inset Flex Noun
1978 \begin_layout Plain Layout
1984 option tells \SpecialChar LyX
1985 that a format is suitable for document export.
1986 If this is set and if a suitable conversion route exists (see
1987 \begin_inset CommandInset ref
1989 reference "sec:Converters"
1995 the format will appear in the
1996 \begin_inset Flex Noun
1999 \begin_layout Plain Layout
2000 File\SpecialChar menuseparator
2007 The format will also appear in the
2008 \begin_inset Flex Noun
2011 \begin_layout Plain Layout
2012 Document\SpecialChar menuseparator
2018 menu if a viewer is specified for the format.
2021 \begin_inset Flex Code
2024 \begin_layout Plain Layout
2031 should not use this option.
2032 Formats that can both represent vector graphics and documents like
2033 \begin_inset Flex Code
2036 \begin_layout Plain Layout
2045 \begin_layout Standard
2047 \begin_inset Flex Noun
2050 \begin_layout Plain Layout
2051 Vector graphics format
2056 tells \SpecialChar LyX
2057 that a format can contain vector graphics.
2058 This information is used to determine the target format of included graphics for
2059 \begin_inset Flex Noun
2062 \begin_layout Plain Layout
2069 Included graphics may need to be converted to either
2070 \begin_inset Flex Noun
2073 \begin_layout Plain Layout
2081 \begin_inset Flex Noun
2084 \begin_layout Plain Layout
2092 \begin_inset Flex Noun
2095 \begin_layout Plain Layout
2103 \begin_inset Flex Noun
2106 \begin_layout Plain Layout
2112 cannot handle other image formats.
2113 If an included graphic is not already in
2114 \begin_inset Flex Noun
2117 \begin_layout Plain Layout
2125 \begin_inset Flex Noun
2128 \begin_layout Plain Layout
2136 \begin_inset Flex Noun
2139 \begin_layout Plain Layout
2147 \begin_inset Flex Noun
2150 \begin_layout Plain Layout
2156 if the vector format option is set,
2158 \begin_inset Flex Noun
2161 \begin_layout Plain Layout
2170 \begin_layout Section
2174 \begin_layout Standard
2175 Since all conversions from one format to another take place in \SpecialChar LyX
2176 's temporary directory,
2177 it is sometimes necessary to modify a file before copying it to the temporary directory in order that the conversion may be performed.
2181 \begin_layout Plain Layout
2183 the file may refer to other files—
2186 using relative file names,
2187 and these may become invalid when the file is copied to the temporary directory.
2192 This is done by a Copier:
2193 It copies a file to (or from) the temporary directory and may modify it in the process.
2196 \begin_layout Standard
2197 The definitions of the copiers may use eight variables:
2200 \begin_layout Labeling
2201 \labelwidthstring 00.00.0000
2202 \begin_inset Flex Code
2205 \begin_layout Plain Layout
2211 The \SpecialChar LyX
2212 system directory (e.
2213 \begin_inset space \thinspace{}
2217 \begin_inset space \space{}
2221 \begin_inset Flex Noun
2224 \begin_layout Plain Layout
2233 \begin_layout Labeling
2234 \labelwidthstring 00.00.0000
2235 \begin_inset Flex Code
2238 \begin_layout Plain Layout
2247 \begin_layout Labeling
2248 \labelwidthstring 00.00.0000
2249 \begin_inset Flex Code
2252 \begin_layout Plain Layout
2261 \begin_layout Labeling
2262 \labelwidthstring 00.00.0000
2263 \begin_inset Flex Code
2266 \begin_layout Plain Layout
2272 The base name (without filename extension) in the \SpecialChar LyX
2276 \begin_layout Labeling
2277 \labelwidthstring 00.00.0000
2278 \begin_inset Flex Code
2281 \begin_layout Plain Layout
2287 The full directory path of the \SpecialChar LyX
2291 \begin_layout Labeling
2292 \labelwidthstring 00.00.0000
2293 \begin_inset Flex Code
2296 \begin_layout Plain Layout
2302 The full pathname to the original \SpecialChar LyX
2303 file being processed
2306 \begin_layout Labeling
2307 \labelwidthstring 00.00.0000
2308 \begin_inset Flex Code
2311 \begin_layout Plain Layout
2317 The filename (without any directory path) of the \SpecialChar LyX
2321 \begin_layout Labeling
2322 \labelwidthstring 00.00.0000
2323 \begin_inset Flex Code
2326 \begin_layout Plain Layout
2332 The `\SpecialChar LaTeX
2336 \begin_layout Standard
2337 The latter should be the filename as it would be used in a \SpecialChar LaTeX
2345 It is relevant only when exporting files suitable for such inclusion.
2348 \begin_layout Standard
2349 Copiers can be used to do almost anything with output files.
2351 suppose you want generated pdf files to be copied to a special directory,
2353 \begin_inset Flex Code
2356 \begin_layout Plain Layout
2363 Then you could write a shell script such as this one:
2366 \begin_layout Standard
2367 \begin_inset listings
2371 \begin_layout Plain Layout
2376 \begin_layout Plain Layout
2381 \begin_layout Plain Layout
2383 TOFILE=`basename $2`
2386 \begin_layout Plain Layout
2388 cp $FROMFILE /home/you/pdf/$TOFILE
2393 Save it in your local \SpecialChar LyX
2397 \begin_inset Flex Code
2400 \begin_layout Plain Layout
2401 /home/you/.lyx/scripts/pdfcopier.sh
2407 and make it executable,
2408 if you need to do so on your platform.
2411 \begin_inset Flex Noun
2414 \begin_layout Plain Layout
2415 Tools\SpecialChar menuseparator
2423 \begin_inset Flex Noun
2426 \begin_layout Plain Layout
2427 File Handling\SpecialChar menuseparator
2434 \begin_inset Flex Noun
2437 \begin_layout Plain Layout
2444 or one of the other pdf formats—
2446 \begin_inset Flex Code
2449 \begin_layout Plain Layout
2450 pdfcopier.sh $$i $$o
2456 \begin_inset Flex Noun
2459 \begin_layout Plain Layout
2469 \begin_layout Standard
2470 Copiers are used by \SpecialChar LyX
2471 in various of its own conversions.
2473 if appropriate programs are found,
2475 will automatically install copiers for the
2476 \begin_inset Flex Noun
2479 \begin_layout Plain Layout
2486 \begin_inset Flex Noun
2489 \begin_layout Plain Layout
2491 \begin_inset space ~
2500 When these formats are exported,
2501 the copier sees that not just the main HTML file but various associated files (style files,
2503 etc.) are also copied.
2504 All these files are written to a subdirectory of the directory in which the original \SpecialChar LyX
2509 \begin_layout Plain Layout
2510 This copier can be customized.
2512 \begin_inset Quotes eld
2516 \begin_inset Quotes erd
2519 argument takes a comma-separated list of extensions to be copied;
2521 all files will be copied.
2523 \begin_inset Quotes eld
2527 \begin_inset Quotes erd
2530 argument determines the extension added to the generated directory.
2533 \begin_inset Quotes eld
2537 \begin_inset Flex Noun
2540 \begin_layout Plain Layout
2547 \begin_inset Quotes erd
2551 so HTML generated from
2552 \begin_inset Flex Noun
2555 \begin_layout Plain Layout
2556 /path/to/filename.lyx
2562 \begin_inset Flex Noun
2565 \begin_layout Plain Layout
2566 /path/to/filename.html.LyXconv
2580 \begin_layout Section
2582 \begin_inset CommandInset label
2584 name "sec:Converters"
2591 \begin_layout Standard
2592 You can define your own Converters to convert files between different formats.
2594 \begin_inset Flex Noun
2597 \begin_layout Plain Layout
2598 Tools\SpecialChar menuseparator
2599 Preferences\SpecialChar menuseparator
2600 File Handling\SpecialChar menuseparator
2609 \begin_layout Standard
2610 To define a new converter,
2612 \begin_inset Flex Noun
2615 \begin_layout Plain Layout
2617 \begin_inset space ~
2626 \begin_inset Flex Noun
2629 \begin_layout Plain Layout
2631 \begin_inset space ~
2639 from the drop-down lists,
2640 enter the command needed for the conversion,
2642 \begin_inset Flex Noun
2645 \begin_layout Plain Layout
2652 Several variables can be used in the definition of converters:
2655 \begin_layout Labeling
2656 \labelwidthstring 00.00.0000
2657 \begin_inset Flex Code
2660 \begin_layout Plain Layout
2666 The \SpecialChar LyX
2670 \begin_layout Labeling
2671 \labelwidthstring 00.00.0000
2672 \begin_inset Flex Code
2675 \begin_layout Plain Layout
2684 \begin_layout Labeling
2685 \labelwidthstring 00.00.0000
2686 \begin_inset Flex Code
2689 \begin_layout Plain Layout
2698 \begin_layout Labeling
2699 \labelwidthstring 00.00.0000
2700 \begin_inset Flex Code
2703 \begin_layout Plain Layout
2709 The base filename of the input file (i.
2710 \begin_inset space \thinspace{}
2714 without the extension)
2717 \begin_layout Labeling
2718 \labelwidthstring 00.00.0000
2719 \begin_inset Flex Code
2722 \begin_layout Plain Layout
2728 The path to the input file
2731 \begin_layout Labeling
2732 \labelwidthstring 00.00.0000
2733 \begin_inset Flex Code
2736 \begin_layout Plain Layout
2742 The path to the original input file (this is different from $$p when a chain of converters is called)
2745 \begin_layout Labeling
2746 \labelwidthstring 00.00.0000
2747 \begin_inset Flex Code
2750 \begin_layout Plain Layout
2756 The iconv name for the encoding of the document.
2759 \begin_layout Standard
2761 \begin_inset Flex Noun
2764 \begin_layout Plain Layout
2766 \begin_inset space ~
2774 field you can enter the following flags,
2775 separated by commas:
2778 \begin_layout Labeling
2779 \labelwidthstring 00.00.0000
2780 \begin_inset Flex Code
2783 \begin_layout Plain Layout
2785 \change_inserted -712698321 1524656940
2793 This converter runs some form of \SpecialChar LaTeX
2795 This will make \SpecialChar LyX
2796 's \SpecialChar LaTeX
2797 error logs available.
2799 \change_inserted -712698321 1524657018
2801 \begin_inset Flex Code
2804 \begin_layout Plain Layout
2806 \change_inserted -712698321 1524657012
2814 value specifies the form of \SpecialChar LaTeX
2816 \begin_inset Flex Code
2819 \begin_layout Plain Layout
2821 \change_inserted -712698321 1524657005
2834 If no value is specified,
2836 \begin_inset Flex Code
2839 \begin_layout Plain Layout
2841 \change_inserted -712698321 1524657018
2854 \begin_layout Labeling
2855 \labelwidthstring 00.00.0000
2857 \change_inserted -712698321 1676553236
2858 \begin_inset Flex Code
2861 \begin_layout Plain Layout
2863 \change_inserted -712698321 1676552303
2871 This converter is considered non-safe and needs authorization by the user.
2872 Depending on the settings in
2874 Tools\SpecialChar menuseparator
2875 Preferences\SpecialChar menuseparator
2876 File Handling\SpecialChar menuseparator
2880 users will (a.) be asked whether they trust the current document temporarily,
2883 (b.) be informed that conversion is not possible due to security concerns,
2884 or (c.) not be informed as they gave permanent consent.
2885 Set this flag for converters that might execute arbitrary programs.
2888 \begin_layout Labeling
2889 \labelwidthstring 00.00.0000
2890 \begin_inset Flex Code
2893 \begin_layout Plain Layout
2895 \change_inserted -712698321 1524656935
2903 Needs the \SpecialChar LaTeX
2905 \begin_inset Flex Noun
2908 \begin_layout Plain Layout
2914 file for the conversion.
2916 \change_inserted -712698321 1524657047
2918 \begin_inset Flex Code
2921 \begin_layout Plain Layout
2923 \change_inserted -712698321 1524657030
2931 value specifies the form of \SpecialChar LaTeX
2932 that is run in order to generate the
2933 \begin_inset Flex Noun
2936 \begin_layout Plain Layout
2938 \change_inserted -712698321 1524657047
2947 \begin_inset Flex Code
2950 \begin_layout Plain Layout
2952 \change_inserted -712698321 1524657030
2965 If no value is specified,
2967 \begin_inset Flex Code
2970 \begin_layout Plain Layout
2972 \change_inserted -712698321 1524657030
2985 \begin_layout Labeling
2986 \labelwidthstring 00.00.0000
2987 \begin_inset Flex Code
2990 \begin_layout Plain Layout
2997 \begin_inset Quotes eld
3001 \begin_inset Quotes erd
3004 file from the backend,
3005 which in practice means a \SpecialChar LaTeX
3006 file like the one we would export,
3008 \begin_inset Flex Code
3011 \begin_layout Plain Layout
3020 \begin_layout Labeling
3021 \labelwidthstring 00.00.0000
3022 \begin_inset Flex Code
3025 \begin_layout Plain Layout
3034 \begin_layout Standard
3035 The following three flags are not really flags at all because they take an argument in the
3036 \begin_inset Flex Noun
3039 \begin_layout Plain Layout
3041 \begin_inset space ~
3045 \begin_inset space ~
3056 \begin_layout Labeling
3057 \labelwidthstring 00.00.0000
3059 \change_inserted -712698321 1523206314
3060 \begin_inset Flex Code
3063 \begin_layout Plain Layout
3065 \change_inserted -712698321 1523206193
3073 The name of the driver that needs to be loaded with the
3077 package for this converter.
3078 The loading of the correct driver is necessary to get some PDF-specific features.
3086 \begin_layout Labeling
3087 \labelwidthstring 00.00.0000
3088 \begin_inset Flex Code
3091 \begin_layout Plain Layout
3098 the converter's standard error will be redirected to a file
3099 \begin_inset Flex Code
3102 \begin_layout Plain Layout
3109 and the script given as argument will be run as:
3111 \begin_inset Flex Code
3114 \begin_layout Plain Layout
3115 script < infile.out > infile.log
3121 The argument may contain
3122 \begin_inset Flex Code
3125 \begin_layout Plain Layout
3134 \begin_layout Labeling
3135 \labelwidthstring 00.00.0000
3136 \begin_inset Flex Code
3139 \begin_layout Plain Layout
3145 The name of the directory in which the converter will dump the generated files.
3147 will not create this directory,
3148 and it does not copy anything into it,
3149 though it will copy this directory to the destination.
3150 The argument may contain
3151 \begin_inset Flex Code
3154 \begin_layout Plain Layout
3161 which will be replaced by the base name of the input and output files,
3163 when the directory is copied.
3164 \begin_inset Newline newline
3167 Note that resultdir and usetempdir make no sense together.
3168 The latter will be ignored if the former is given.
3171 \begin_layout Labeling
3172 \labelwidthstring 00.00.0000
3173 \begin_inset Flex Code
3176 \begin_layout Plain Layout
3182 Determines the output file name and may,
3184 \begin_inset Flex Code
3187 \begin_layout Plain Layout
3194 Sensible only with resultdir and optional even then;
3196 it defaults to `index'.
3199 \begin_layout Standard
3201 \change_inserted -712698321 1523206384
3202 A suitable hyperref-driver is set for some converters that are installed with \SpecialChar LyX
3205 \change_deleted -712698321 1523206388
3207 \change_inserted -712698321 1523206389
3211 \change_inserted -712698321 1523206400
3217 \change_inserted -712698321 1523206407
3221 \change_inserted -712698321 1523206437
3225 \change_deleted -712698321 1523206442
3226 that are installed with \SpecialChar LyX
3233 \begin_layout Standard
3234 You do not have to define converters for all formats between which you want to convert.
3236 you will note that there is no `\SpecialChar LyX
3237 to PostScript' converter,
3238 but \SpecialChar LyX
3239 will export PostScript.
3240 It does so by first creating a \SpecialChar LaTeX
3241 file (no converter needs to be defined for this) which is then converted to DVI using the `\SpecialChar LaTeX
3243 and finally converting the resulting DVI file to PostScript.
3245 finds such `chains' of converters automatically,
3246 and it will always choose the shortest possible chain.
3249 still define multiple conversion methods between file formats.
3251 the standard \SpecialChar LyX
3252 configuration provides five ways to convert \SpecialChar LaTeX
3256 \begin_layout Enumerate
3259 \begin_inset Flex Noun
3262 \begin_layout Plain Layout
3271 \begin_layout Enumerate
3272 via (DVI and) PostScript,
3274 \begin_inset Flex Noun
3277 \begin_layout Plain Layout
3286 \begin_layout Enumerate
3289 \begin_inset Flex Noun
3292 \begin_layout Plain Layout
3301 \begin_layout Enumerate
3303 \begin_inset Flex Noun
3306 \begin_layout Plain Layout
3316 \begin_layout Enumerate
3318 \begin_inset Flex Noun
3321 \begin_layout Plain Layout
3331 \begin_layout Standard
3332 To define such alternate chains,
3333 you must define multiple target `file formats',
3335 \begin_inset CommandInset ref
3337 reference "sec:Formats"
3344 in the standard configuration,
3346 \begin_inset Flex Noun
3349 \begin_layout Plain Layout
3356 \begin_inset Flex Noun
3359 \begin_layout Plain Layout
3367 \begin_inset Flex Noun
3370 \begin_layout Plain Layout
3377 \begin_inset Flex Noun
3380 \begin_layout Plain Layout
3388 \begin_inset Flex Noun
3391 \begin_layout Plain Layout
3398 \begin_inset Flex Noun
3401 \begin_layout Plain Layout
3409 \begin_inset Flex Noun
3412 \begin_layout Plain Layout
3419 \begin_inset Flex Noun
3422 \begin_layout Plain Layout
3431 \begin_inset Flex Noun
3434 \begin_layout Plain Layout
3441 \begin_inset Flex Noun
3444 \begin_layout Plain Layout
3452 all of which share the extension
3453 \begin_inset Flex Noun
3456 \begin_layout Plain Layout
3463 and which correspond to the conversion methods just mentioned.
3466 \begin_layout Chapter
3467 Internationalizing \SpecialChar LyX
3469 \begin_inset CommandInset label
3471 name "cha:Internationalizing-LyX"
3478 \begin_layout Standard
3480 supports using a translated interface.
3481 Last time we checked,
3483 provided text in thirty languages.
3484 The language of choice is called your
3489 (For further reading on locale settings,
3490 see also the documentation for locale that comes with your operating system.
3493 \begin_inset Flex Code
3496 \begin_layout Plain Layout
3502 could be a good place to start).
3505 \begin_layout Standard
3506 Notice that these translations will work,
3507 but do contain a few flaws.
3509 all dialogs have been designed with the English text in mind,
3510 which means that some of the translated text will be too large to fit within the space allocated.
3511 This is only a display problem and will not cause any harm.
3513 you will find that some of the translations do not define shortcut keys for everything.
3515 there are simply not enough free letters to do it.
3517 the translator just hasn't got around to doing it yet.
3518 Our localization team,
3519 which you may wish to join,
3523 \begin_layout Plain Layout
3524 If you are a fluent speaker of a language other than English,
3525 joining these teams is a great way to give back to the \SpecialChar LyX
3531 will of course try to fix these shortcomings in future versions of \SpecialChar LyX
3535 \begin_layout Section
3536 Translating \SpecialChar LyX
3540 \begin_layout Subsection
3541 Translating the graphical user interface (text messages).
3544 \begin_layout Standard
3547 \begin_inset Flex Code
3550 \begin_layout Plain Layout
3556 library to handle the internationalization of the interface.
3557 To have \SpecialChar LyX
3558 speak your favorite language in all menus and dialogs,
3560 \begin_inset Flex Code
3563 \begin_layout Plain Layout
3569 -file for that language.
3570 When this is available,
3571 you'll have to generate a
3572 \begin_inset Flex Code
3575 \begin_layout Plain Layout
3581 -file from it and install the
3582 \begin_inset Flex Code
3585 \begin_layout Plain Layout
3592 The process of doing all of this is explained in the documentation for GNU
3593 \begin_inset Flex Code
3596 \begin_layout Plain Layout
3603 It is possible to do this just for yourself,
3604 but if you're going to do it,
3605 you might as well share the results of your labors with the rest of the \SpecialChar LyX
3607 Send a message to the \SpecialChar LyX
3608 developers' list for more information about how to proceed.
3611 \begin_layout Standard
3613 this is what you should do (xx denotes the language code):
3616 \begin_layout Itemize
3617 Check out the \SpecialChar LyX
3620 \begin_inset CommandInset href
3622 name "information on the web"
3623 target "https://www.lyx.org/HowToUseGIT"
3631 \begin_layout Itemize
3633 \begin_inset Flex Code
3636 \begin_layout Plain Layout
3642 to the folder of the
3643 \begin_inset Flex Code
3646 \begin_layout Plain Layout
3654 \begin_inset Flex Code
3657 \begin_layout Plain Layout
3665 \begin_inset Flex Code
3668 \begin_layout Plain Layout
3674 doesn't exist anywhere,
3675 it can be remade with the console command
3676 \begin_inset Flex Code
3679 \begin_layout Plain Layout
3686 or you can use an existing po-file for some other language as a template).
3689 \begin_layout Itemize
3691 \begin_inset Flex Code
3694 \begin_layout Plain Layout
3704 \begin_layout Plain Layout
3705 This is just a text file,
3706 so it can be edited in any text editor.
3707 But there are also specialized programs that support such editing,
3712 (for all platforms) or
3721 contains a `mode' for editing
3722 \begin_inset Flex Code
3725 \begin_layout Plain Layout
3734 \begin_inset Flex URL
3737 \begin_layout Plain Layout
3739 https://www.gnu.org/software/gettext/manual/html_node/PO-Mode.html#PO-Mode
3749 For some menu- and widget-labels,
3750 there are also shortcut keys that should be translated.
3751 Those keys are marked after a `|',
3752 and should be translated according to the words and phrases of the language.
3753 You should also fill also out the information at the beginning of the new
3754 \begin_inset Flex Code
3757 \begin_layout Plain Layout
3763 -file with your email-address,
3765 so people know where to reach you with suggestions and entertaining flames.
3768 \begin_layout Standard
3769 If you are just doing this on your own,
3773 \begin_layout Itemize
3775 \begin_inset Flex Code
3778 \begin_layout Plain Layout
3785 This can be done with
3786 \begin_inset Flex Code
3789 \begin_layout Plain Layout
3790 msgfmt -o xx.mo < xx.po
3798 \begin_layout Itemize
3800 \begin_inset Flex Code
3803 \begin_layout Plain Layout
3809 -file to your locale-tree,
3810 at the correct directory for application messages for the language
3816 \begin_inset Flex Code
3819 \begin_layout Plain Layout
3826 \begin_inset space \thinspace{}
3830 \begin_inset space \space{}
3834 \begin_inset Flex Code
3837 \begin_layout Plain Layout
3838 /usr/local/share/locale/xx/LC_MESSAGES/lyx.mo
3848 \begin_layout Standard
3851 it would be best if the new
3852 \begin_inset Flex Code
3855 \begin_layout Plain Layout
3861 file could be added to the \SpecialChar LyX
3863 so others can use it.
3864 Adding it involves making additional changes to \SpecialChar LyX
3866 So send an email to the developers' mailing list if you're interested in doing that.
3869 \begin_layout Subsubsection
3873 \begin_layout Standard
3874 Sometimes it turns out that one English message needs to be translated into different messages in the target language.
3875 One example is the message
3876 \begin_inset Flex Code
3879 \begin_layout Plain Layout
3885 which has the German translation
3894 depending upon exactly what the English
3895 \begin_inset Quotes eld
3899 \begin_inset Quotes erd
3904 \begin_inset Flex Code
3907 \begin_layout Plain Layout
3913 does not handle such ambiguous translations.
3914 Therefore you have to add some context information to the message:
3916 \begin_inset Flex Code
3919 \begin_layout Plain Layout
3926 \begin_inset Flex Code
3929 \begin_layout Plain Layout
3930 To[[as in 'From format x to format y']]
3936 \begin_inset Flex Code
3939 \begin_layout Plain Layout
3940 To[[as in 'From page x to page y']].
3945 Now the two occurrences of
3946 \begin_inset Flex Code
3949 \begin_layout Plain Layout
3956 \begin_inset Flex Code
3959 \begin_layout Plain Layout
3965 and can be translated correctly to
3977 \begin_layout Standard
3978 Of course the context information needs to be stripped off the original message when no translation is used.
3979 Therefore you have to put it in double square brackets at the end of the message (see the example above).
3980 The translation mechanism of \SpecialChar LyX
3981 ensures that everything in double square brackets at the end of messages is removed before displaying the message.
3984 \begin_layout Subsection
3985 Translating the documentation.
3988 \begin_layout Standard
3989 The online documentation (in the
3990 \begin_inset Flex Noun
3993 \begin_layout Plain Layout
3999 -menu) can (and should!) be translated.
4000 If there are translated versions of the documentation available
4004 \begin_layout Plain Layout
4006 at least some of the documents have been translated into fourteen languages,
4007 with the Tutorial available in a few more.
4012 and the locale is set accordingly,
4013 these will be used automagically by \SpecialChar LyX
4016 looks for translated versions as
4017 \begin_inset Flex Code
4020 \begin_layout Plain Layout
4021 LyXDir/doc/xx/DocName.lyx
4028 \begin_inset Flex Code
4031 \begin_layout Plain Layout
4037 is the code for the language currently in use.
4038 If there are no translated documents,
4039 the default English versions will be displayed.
4040 Note that the translated versions must have the same filenames (
4041 \begin_inset Flex Code
4044 \begin_layout Plain Layout
4050 above) as the original.
4051 If you feel up to translating the documentation (an excellent way to proof-read the original documentation by the way!),
4052 there are a few things you should do right away:
4055 \begin_layout Itemize
4056 Check out the documentation translation web page at
4057 \begin_inset CommandInset href
4059 name "https://www.lyx.org/Translation"
4060 target "https://www.lyx.org/Translation"
4067 you can find out which (if any) documents have already been translated into your language.
4068 You can also find out who (if anyone) is organizing the effort to translate the documentation into your language.
4069 If no one is organizing the effort,
4070 please let us know that you're interested.
4073 \begin_layout Standard
4074 Once you get to actually translating,
4075 here's a few hints for you that may save you trouble:
4078 \begin_layout Itemize
4079 Join the documentation team!
4080 There is information on how to do that in
4081 \begin_inset Flex Code
4084 \begin_layout Plain Layout
4091 \begin_inset Flex Noun
4094 \begin_layout Plain Layout
4095 Help\SpecialChar menuseparator
4102 which by the way is the first document you should translate.
4105 \begin_layout Itemize
4106 Learn the typographic conventions for the language you are translating to.
4107 Typography is an ancient art and over the centuries,
4108 a great variety of conventions have developed throughout different parts of the world.
4109 Also study the professional terminology amongst typographers in your country.
4110 Inventing your own terminology will only confuse the users.
4114 Typography is addictive!)
4117 \begin_layout Itemize
4118 Make a copy of the document.
4119 This will be your working copy.
4120 You can use this as your personal translated help-file by placing it in your
4121 \begin_inset Flex Code
4124 \begin_layout Plain Layout
4131 \begin_inset Note Greyedout
4134 \begin_layout Plain Layout
4140 For a complex document with external material (images,
4142 if you make a copy e.
4143 \begin_inset space \thinspace{}
4147 \begin_inset space \space{}
4151 beware that the links to external material may be broken when the document is moved to a different place.
4152 The best way is to retrieve the \SpecialChar LyX
4154 \begin_inset Flex URL
4157 \begin_layout Plain Layout
4159 https://www.lyx.org/HowToUseGIT
4164 ) and to edit the doc file in place.
4172 \begin_layout Itemize
4173 Sometimes the original document (from the \SpecialChar LyX
4174 team) will be updated.
4175 Use the source viewer at
4176 \begin_inset CommandInset href
4178 name "https://www.lyx.org/trac/timeline"
4179 target "https://www.lyx.org/trac/timeline"
4184 to see what has been changed.
4185 That way you can easily see which parts of the translated document need to be updated.
4188 \begin_layout Standard
4189 If you ever find an error in the original document,
4190 fix it and notify the rest of the documentation team of the changes!
4191 (You didn't forget to join the documentation team,
4195 \begin_layout Standard
4196 \begin_inset Branch OutDated
4200 \begin_layout Section
4201 International Keyboard Support
4204 \begin_layout Standard
4208 The following section is by
4216 It needs to be fixed to conform to the new Documentation Style sheet and to make use of the new v1.0 features.
4217 The whole thing also needs to be merged with the section following it.-jw It may also be badly out of date.-rh (2008)]
4220 \begin_layout Subsection
4221 Defining Own Keymaps:
4225 \begin_layout Standard
4226 Let's look at a keyboard definition file a little closer.
4227 It is a plain text file defining
4230 \begin_layout Itemize
4231 key-to-key or key-to-string translations
4234 \begin_layout Itemize
4238 \begin_layout Itemize
4239 dead keys exceptions
4242 \begin_layout Standard
4243 To define key-to-key or key-to-string translation,
4247 \begin_layout Quotation
4248 \begin_inset Flex Code
4251 \begin_layout Plain Layout
4260 \begin_inset Flex Code
4263 \begin_layout Plain Layout
4272 \begin_layout Standard
4274 \begin_inset Flex Code
4277 \begin_layout Plain Layout
4283 is the key to be translated and
4284 \begin_inset Flex Code
4287 \begin_layout Plain Layout
4293 is the string to be inserted into the document.
4294 To define dead keys,
4298 \begin_layout Quotation
4299 \begin_inset Flex Code
4302 \begin_layout Plain Layout
4311 \begin_inset Flex Code
4314 \begin_layout Plain Layout
4323 \begin_layout Standard
4325 \begin_inset Flex Code
4328 \begin_layout Plain Layout
4334 is a keyboard key and
4335 \begin_inset Flex Code
4338 \begin_layout Plain Layout
4345 The following dead keys are supported (shortcut name is in parentheses):
4348 \begin_layout Quotation
4352 \begin_inset space \hfill{}
4358 \begin_layout Quotation
4360 \begin_inset space \hfill{}
4366 \begin_layout Quotation
4368 \begin_inset space \hfill{}
4374 \begin_layout Quotation
4376 \begin_inset space \hfill{}
4382 \begin_layout Quotation
4384 \begin_inset space \hfill{}
4390 \begin_layout Quotation
4392 \begin_inset space \hfill{}
4399 \begin_layout Plain Layout
4411 \begin_layout Quotation
4413 \begin_inset space \hfill{}
4419 \begin_layout Quotation
4421 \begin_inset space \hfill{}
4428 \begin_layout Plain Layout
4440 \begin_layout Quotation
4442 \begin_inset space \hfill{}
4448 \begin_layout Quotation
4450 \begin_inset space \hfill{}
4456 \begin_layout Quotation
4458 \begin_inset space \hfill{}
4465 \begin_layout Plain Layout
4477 \begin_layout Quotation
4479 \begin_inset space \hfill{}
4486 \begin_layout Plain Layout
4498 \begin_layout Quotation
4500 \begin_inset space \hfill{}
4506 \begin_layout Quotation
4507 hungarian umlaut (hug)
4508 \begin_inset space \hfill{}
4514 \begin_layout Quotation
4516 \begin_inset space \hfill{}
4522 \begin_layout Quotation
4524 \begin_inset space \hfill{}
4531 \begin_layout Plain Layout
4543 \begin_layout Standard
4544 Since in many international keyboards there are exceptions to what some dead keys should do,
4545 you can define them using
4548 \begin_layout Quotation
4549 \begin_inset Flex Code
4552 \begin_layout Plain Layout
4560 deadkey key outstring
4563 \begin_layout Standard
4566 if you enter caron-o,
4567 it generates circumflex-o,
4571 \begin_layout Quotation
4572 \begin_inset Flex Code
4575 \begin_layout Plain Layout
4588 \begin_layout Standard
4589 to make it work correctly.
4591 you have to define as exceptions dead keys over i and j,
4592 to remove the dot from them before inserting an accent mark.
4593 I will change this when the time comes,
4594 but so far I haven't had time.
4597 \begin_layout Standard
4599 and about characters:
4600 backslash is escaped,
4602 you'll need double backslash.
4605 \begin_inset Flex Code
4608 \begin_layout Plain Layout
4614 have different meaning.
4616 \begin_inset Flex Code
4619 \begin_layout Plain Layout
4626 quotes start and end \SpecialChar LaTeX
4630 \begin_inset Flex Code
4633 \begin_layout Plain Layout
4643 \begin_inset Flex Code
4646 \begin_layout Plain Layout
4654 \begin_inset Flex Code
4657 \begin_layout Plain Layout
4668 \begin_layout Standard
4669 If you make a keyboard description file that works for your language,
4670 please mail it to me,
4671 so I can include it in the next keymap distribution.
4674 \begin_layout Standard
4675 More keywords will be supported in keymap configuration file in future,
4679 \begin_layout Itemize
4680 \begin_inset Flex Code
4683 \begin_layout Plain Layout
4694 \begin_inset space \hfill{}
4698 \begin_inset Flex Code
4701 \begin_layout Plain Layout
4710 \begin_layout Itemize
4711 \begin_inset Flex Code
4714 \begin_layout Plain Layout
4725 \begin_inset space \hfill{}
4729 \begin_inset Flex Code
4732 \begin_layout Plain Layout
4738 an external keymap translation program
4741 \begin_layout Standard
4744 \begin_inset Flex Code
4747 \begin_layout Plain Layout
4756 \begin_inset Flex Code
4759 \begin_layout Plain Layout
4767 option to include default keyboard).
4775 \begin_layout Section
4776 International Keymap Stuff
4777 \begin_inset CommandInset label
4779 name "sec:International-Keymap-Stuff"
4786 \begin_layout Standard
4787 \begin_inset Note Note
4790 \begin_layout Plain Layout
4791 In doing the revisions on this document in March 2008,
4792 I did not look over this stuff,
4793 as I do not understand it.
4794 It would be good if someone else could do so.
4803 \begin_layout Standard
4804 The next two sections describe the
4805 \begin_inset Flex Code
4808 \begin_layout Plain Layout
4817 \begin_inset Flex Code
4820 \begin_layout Plain Layout
4828 file syntax in detail.
4829 These sections should help you design your own key map if the ones provided do not meet your needs.
4832 \begin_layout Subsection
4836 \begin_layout Standard
4840 \begin_inset Flex Code
4843 \begin_layout Plain Layout
4849 file maps keystrokes to characters or strings.
4850 As the name suggests,
4851 it sets a keyboard mapping.
4853 \begin_inset Flex Code
4856 \begin_layout Plain Layout
4867 \begin_inset Flex Code
4870 \begin_layout Plain Layout
4886 \begin_inset Flex Code
4889 \begin_layout Plain Layout
4903 \begin_inset Flex Code
4906 \begin_layout Plain Layout
4916 \begin_inset Flex Code
4919 \begin_layout Plain Layout
4927 are described in this section.
4930 \begin_layout Labeling
4931 \labelwidthstring 00.00.0000
4932 \begin_inset Flex Code
4935 \begin_layout Plain Layout
4943 Map a character to a string
4946 \begin_layout LyX-Code
4961 \begin_layout Standard
4995 the double-quote (")
5012 must be escaped with a preceding backslash (
5023 \begin_layout Standard
5025 \begin_inset Flex Noun
5028 \begin_layout Plain Layout
5036 statement to cause the symbol
5037 \begin_inset Flex Noun
5040 \begin_layout Plain Layout
5048 to be output for the keystroke
5049 \begin_inset Flex Noun
5052 \begin_layout Plain Layout
5063 \begin_layout LyX-Code
5069 \begin_layout Labeling
5070 \labelwidthstring 00.00.0000
5071 \begin_inset Flex Code
5074 \begin_layout Plain Layout
5082 Specify an accent character
5085 \begin_layout LyX-Code
5094 \begin_layout Standard
5095 This will make the cha
5133 This is the dead key
5137 \begin_layout Plain Layout
5144 refers to a key that does not produce a character by itself,
5145 but when followed with another key,
5146 produces the desired accent character.
5150 r with an umlaut like
5160 can be produced in this manner.
5169 \begin_layout Standard
5182 and then another key not in
5200 followed by the other,
5206 \begin_inset Flex Noun
5209 \begin_layout Plain Layout
5229 \begin_inset Flex Noun
5232 \begin_layout Plain Layout
5242 the cursor will not go one position backwards but will instead cancel the effect t
5257 might have had on the next keystroke.
5261 \begin_layout Standard
5262 The following example specifies that the character ' is to be an acute accent,
5263 allowed on the characters a,
5275 \begin_layout LyX-Code
5278 kmod ' acute aeiouAEIOU
5281 \begin_layout Labeling
5282 \labelwidthstring 00.00.0000
5283 \begin_inset Flex Code
5286 \begin_layout Plain Layout
5292 Specify an exception to the accent character
5295 \begin_layout LyX-Code
5304 \begin_layout Standard
5305 This defines an exce
5346 have been assigned a keystroke with a previous
5349 \begin_inset Flex Code
5352 \begin_layout Plain Layout
5376 must not belong in the
5424 If such a declaration does not exist in
5432 \begin_inset Flex Code
5435 \begin_layout Plain Layout
5470 \begin_inset Flex Code
5473 \begin_layout Plain Layout
5487 \begin_layout Standard
5488 The following command produces causes äi to be produced when you enter acute-i ('i):
5491 \begin_layout LyX-Code
5505 \begin_layout Labeling
5506 \labelwidthstring 00.00.0000
5507 \begin_inset Flex Code
5510 \begin_layout Plain Layout
5516 Combine two accent characters
5519 \begin_layout LyX-Code
5525 accent1 accent2 allowed
5528 \begin_layout Standard
5529 This one is getting pretty esoteric.
5530 It allows you to combine the effect
5586 \begin_inset Flex Code
5589 \begin_layout Plain Layout
5617 \begin_layout Standard
5618 Consider this example from the
5619 \begin_inset Flex Code
5622 \begin_layout Plain Layout
5633 \begin_layout LyX-Code
5637 acute aeioyvhAEIOYVH
5642 kcomb acute umlaut iyIY
5645 \begin_layout Standard
5646 This allows you to press
5647 \begin_inset Flex Noun
5650 \begin_layout Plain Layout
5658 and get the effect of
5659 \begin_inset Flex Code
5662 \begin_layout Plain Layout
5681 in this case cancels the last dead key,
5683 \begin_inset Flex Noun
5686 \begin_layout Plain Layout
5696 \begin_inset Flex Code
5699 \begin_layout Plain Layout
5712 \begin_layout Subsection
5716 \begin_layout Standard
5718 \begin_inset Flex Code
5721 \begin_layout Plain Layout
5729 mapping is performed,
5731 \begin_inset Flex Code
5734 \begin_layout Plain Layout
5744 file maps the strings that the symbols generate to characters in the current font.
5745 The \SpecialChar LyX
5746 distribution currently includes at least the
5747 \begin_inset Flex Code
5750 \begin_layout Plain Layout
5759 \begin_inset Flex Code
5762 \begin_layout Plain Layout
5773 \begin_layout Standard
5775 \begin_inset Flex Code
5778 \begin_layout Plain Layout
5786 file is a sequence of declarations of the form
5789 \begin_layout LyX-Code
5802 \begin_layout Standard
5805 \begin_inset Flex Noun
5808 \begin_layout Plain Layout
5818 to the corresponding character in the iso-8859-1 set (233),
5819 the following declaration is used
5822 \begin_layout LyX-Code
5830 \begin_layout Standard
5832 \begin_inset Flex Code
5835 \begin_layout Plain Layout
5844 \begin_inset Flex Code
5847 \begin_layout Plain Layout
5865 the same character can apply to more than one string.
5867 \begin_inset Flex Code
5870 \begin_layout Plain Layout
5881 \begin_layout LyX-Code
5893 \begin_inset Newline newline
5909 \begin_layout Standard
5911 cannot find a mapping for the string produced by the keystroke or a deadkey sequence,
5912 it will check if it looks like an accented char and try to draw an accent over the character on screen.
5915 \begin_layout Subsection
5919 \begin_layout Standard
5920 There is a second way to add support for international characters through so-called dead-keys.
5921 A dead-key works in combination with a letter to produce an accented character.
5923 we'll explain how to create a really simple dead-key to illustrate how they work.
5926 \begin_layout Standard
5927 Suppose you happen to need the circumflex character,
5929 \begin_inset Quotes eld
5933 \begin_inset Quotes erd
5938 \begin_inset Flex Noun
5941 \begin_layout Plain Layout
5948 \begin_inset space ~
5952 \begin_inset Flex Noun
5955 \begin_layout Plain Layout
5961 ] to the \SpecialChar LyX
5963 \begin_inset Flex Code
5966 \begin_layout Plain Layout
5973 \begin_inset Flex Code
5976 \begin_layout Plain Layout
5984 whenever you type the
5985 \begin_inset Flex Noun
5988 \begin_layout Plain Layout
5994 -key followed by a letter,
5995 that letter will have a circumflex accent on it.
5998 \begin_inset Quotes eld
6002 \begin_inset Flex Noun
6005 \begin_layout Plain Layout
6012 \begin_inset Quotes erd
6015 produces the letter:
6017 \begin_inset Quotes eld
6021 \begin_inset Quotes erd
6025 If you tried to type
6026 \begin_inset Quotes eld
6030 \begin_inset Flex Noun
6033 \begin_layout Plain Layout
6040 \begin_inset Quotes erd
6046 will complain with a beep,
6048 \begin_inset Quotes eld
6052 \begin_inset Flex Noun
6055 \begin_layout Plain Layout
6062 \begin_inset Quotes erd
6065 never takes a circumflex accent.
6067 \begin_inset Flex Noun
6070 \begin_layout Plain Layout
6076 after a dead-key produces the bare-accent.
6077 Please note this last point!
6078 If you bind a key to a dead-key,
6079 you'll need to rebind the character on that key to yet another key.
6081 \begin_inset Flex Noun
6084 \begin_layout Plain Layout
6090 to a cedilla is a bad idea,
6091 since you'll only get cedillas instead of commas.
6094 \begin_layout Standard
6095 One common way to bind dead-keys is to use
6096 \begin_inset Flex Noun
6099 \begin_layout Plain Layout
6107 \begin_inset Flex Noun
6110 \begin_layout Plain Layout
6118 \begin_inset Flex Noun
6121 \begin_layout Plain Layout
6127 in combination with an accent,
6129 \begin_inset Quotes eld
6133 \begin_inset Flex Noun
6136 \begin_layout Plain Layout
6143 \begin_inset Quotes erd
6147 \begin_inset Quotes eld
6151 \begin_inset Flex Noun
6154 \begin_layout Plain Layout
6161 \begin_inset Quotes erd
6165 \begin_inset Quotes eld
6169 \begin_inset Flex Noun
6172 \begin_layout Plain Layout
6179 \begin_inset Quotes erd
6183 Another way involves using
6184 \begin_inset Flex Code
6187 \begin_layout Plain Layout
6194 \begin_inset Flex Code
6197 \begin_layout Plain Layout
6203 to set up the special
6204 \begin_inset Flex Code
6207 \begin_layout Plain Layout
6215 \begin_inset Flex Code
6218 \begin_layout Plain Layout
6224 acts in some ways just like
6225 \begin_inset Flex Noun
6228 \begin_layout Plain Layout
6234 and permits you to bind keys to accented characters.
6235 You can also turn keys into dead-keys by binding them to something like
6236 \begin_inset Flex Code
6239 \begin_layout Plain Layout
6245 and then binding this symbolic key to the corresponding \SpecialChar LyX
6250 \begin_layout Plain Layout
6256 This is exactly what I do in my
6257 \begin_inset Flex Code
6260 \begin_layout Plain Layout
6267 \begin_inset Flex Code
6270 \begin_layout Plain Layout
6278 \begin_inset Flex Noun
6281 \begin_layout Plain Layout
6283 \begin_inset space ~
6292 \begin_inset Flex Code
6295 \begin_layout Plain Layout
6301 and a bunch of these
6302 \begin_inset Quotes eld
6306 \begin_inset Flex Code
6309 \begin_layout Plain Layout
6316 \begin_inset Quotes erd
6319 symbolic keys bound such things as
6320 \begin_inset Flex Noun
6323 \begin_layout Plain Layout
6325 \begin_inset space ~
6334 \begin_inset Flex Noun
6337 \begin_layout Plain Layout
6339 \begin_inset space ~
6348 This is how I produce my accented characters.
6353 You can make just about anything into the
6354 \begin_inset Flex Code
6357 \begin_layout Plain Layout
6365 \begin_inset Flex Noun
6368 \begin_layout Plain Layout
6375 a spare function key,
6377 As for the \SpecialChar LyX
6378 commands that produce accents,
6380 \begin_inset Flex Code
6383 \begin_layout Plain Layout
6394 You'll find the complete list there.
6397 \begin_layout Subsection
6398 Saving your Language Configuration
6401 \begin_layout Standard
6402 You can edit your preferences so that your desired language environment is automatically configured when \SpecialChar LyX
6405 \begin_inset Flex Noun
6408 \begin_layout Plain Layout
6409 Edit\SpecialChar menuseparator
6418 \begin_layout Chapter
6420 \change_inserted -584632292 1610232084
6423 Installing New Document Classes,
6426 \begin_inset CommandInset label
6428 name "cha:Installing-New-Document"
6433 \begin_inset Argument 1
6436 \begin_layout Plain Layout
6437 Installing New Document Classes
6445 \begin_layout Standard
6447 we describe the procedures for creating and installing new \SpecialChar LyX
6448 layout and template files,
6449 as well as offer a refresher on correctly installing new \SpecialChar LaTeX
6454 \begin_layout Standard
6456 let us a say a few words about how one ought to think about the relation between \SpecialChar LyX
6457 and \SpecialChar LaTeX
6459 The thing to understand is that,
6462 doesn't know anything about \SpecialChar LaTeX
6465 from \SpecialChar LyX
6468 is just one of several
6469 \begin_inset Quotes eld
6473 \begin_inset Quotes erd
6476 in which it is capable of producing output.
6477 Other such formats are DocBook,
6483 a particularly important format,
6484 but very little of the information \SpecialChar LyX
6485 has about \SpecialChar LaTeX
6486 is actually contained in the program itself.
6490 \begin_layout Plain Layout
6491 Some commands are sufficiently complex that they are
6492 \begin_inset Quotes eld
6496 \begin_inset Quotes erd
6499 into \SpecialChar LyX
6501 But the developers generally regard this as a Bad Thing.
6508 even for the standard classes like
6509 \begin_inset Flex Code
6512 \begin_layout Plain Layout
6519 is contained in `layout files'.
6522 itself does not know much about DocBook or XHTML.
6523 What it knows is contained in layout files.
6526 \begin_layout Standard
6527 You can think of the layout file for a given document class as a translation manual between \SpecialChar LyX
6529 paragraphs with their corresponding styles,
6530 certain sorts of insets,
6532 and the corresponding \SpecialChar LaTeX
6535 or XHTML constructs.
6536 Almost everything \SpecialChar LyX
6538 \begin_inset Flex Code
6541 \begin_layout Plain Layout
6549 is contained in the file
6550 \begin_inset Flex Code
6553 \begin_layout Plain Layout
6559 and in various other files it includes.
6561 anyone intending to write layout files should plan to study the existing files.
6562 A good place to start is with
6563 \begin_inset Flex Code
6566 \begin_layout Plain Layout
6573 which is included in
6574 \begin_inset Flex Code
6577 \begin_layout Plain Layout
6585 \begin_inset Flex Code
6588 \begin_layout Plain Layout
6595 and many of the other layout files for document classes.
6596 This file is where sections and the like are defined:
6598 \begin_inset Flex Code
6601 \begin_layout Plain Layout
6607 tells \SpecialChar LyX
6608 how paragraphs that are marked with the Section,
6611 styles can be translated into corresponding \SpecialChar LaTeX
6614 and XHTML commands and tags.
6616 \begin_inset Flex Code
6619 \begin_layout Plain Layout
6625 file basically just includes several of these
6626 \begin_inset Flex Code
6629 \begin_layout Plain Layout
6638 \begin_layout Standard
6639 Defining the \SpecialChar LyX
6641 correspondence is not the only thing layout files do,
6643 Their other job is to define how the \SpecialChar LyX
6644 constructs themselves will appear on-screen.
6645 The fact that layout files have these two jobs is often a source of confusion,
6646 because they are completely separate.
6647 Telling \SpecialChar LyX
6648 how to translate a certain paragraph style into \SpecialChar LaTeX
6649 does not tell \SpecialChar LyX
6652 telling \SpecialChar LyX
6653 how to display a certain paragraph style does not tell \SpecialChar LyX
6654 how to translate it into \SpecialChar LaTeX
6655 (let alone tell \SpecialChar LaTeX
6659 when you define a new \SpecialChar LyX
6661 you must always do two quite separate things:
6663 \begin_inset space ~
6666 tell \SpecialChar LyX
6667 how to translate it into \SpecialChar LaTeX
6669 \begin_inset space ~
6672 tell \SpecialChar LyX
6676 \begin_layout Standard
6677 Much the same is true,
6679 as regards \SpecialChar LyX
6680 's other backend formats,
6681 though XHTML is in some ways different,
6682 because in that case \SpecialChar LyX
6689 to use information about how it should display a paragraph on the screen to output information (in the form of CSS) about how the paragraph should be displayed in a browser.
6692 the distinction between what \SpecialChar LyX
6693 does internally and how things are rendered externally remains in force,
6694 and the two can be controlled separately.
6696 \begin_inset CommandInset ref
6698 reference "sec:Tags-for-XHTML"
6706 \begin_layout Section
6707 Installing new \SpecialChar LaTeX
6711 \begin_layout Standard
6712 Some installations may not include a \SpecialChar LaTeX
6713 package or class file that you would like to use within \SpecialChar LyX
6716 you might need Foil\SpecialChar TeX
6718 a package for preparing slides for overhead projectors.
6719 Modern \SpecialChar LaTeX
6720 distributions like \SpecialChar TeX
6721 Live (2008 or newer) or MiK\SpecialChar TeX
6722 provide a user interface for installing such packages.
6724 with MiK\SpecialChar TeX
6726 you start the program
6727 \begin_inset Quotes eld
6731 \begin_inset space ~
6735 \begin_inset Quotes erd
6738 to get a list of available packages.
6739 To install one of them,
6740 right click on it or use the corresponding toolbar button.
6743 \begin_layout Standard
6744 If your \SpecialChar LaTeX
6745 distribution does not provide such a `package manager',
6746 or if the package is not available from your distribution,
6747 then follow these steps to install it manually:
6750 \begin_layout Enumerate
6751 Get the package from
6752 \begin_inset CommandInset href
6755 target "http://www.ctan.org/"
6763 \begin_layout Enumerate
6764 If the package contains a file with the ending
6765 \begin_inset Quotes eld
6769 \begin_inset Flex Code
6772 \begin_layout Plain Layout
6779 \begin_inset Quotes erd
6782 (is the case for Foil\SpecialChar TeX
6783 ) then open a console,
6784 change to the folder of this file and execute the command
6785 \begin_inset Flex Code
6788 \begin_layout Plain Layout
6795 You have now unpacked the package and have all files to install it.
6796 Most \SpecialChar LaTeX
6797 -packages are not packed and you can skip this step.
6800 \begin_layout Enumerate
6801 Now you need to decide if the package should be available for all users or only for you.
6805 \begin_layout Enumerate
6806 On *nix systems (Linux,
6809 if you want the new package to be available for all users on your system,
6810 then install it in your `local' \SpecialChar TeX
6812 otherwise install it in your own `user' \SpecialChar TeX
6814 Where these trees should be created,
6815 if they do not already exist,
6816 depends on your system.
6819 \begin_inset Flex Code
6822 \begin_layout Plain Layout
6832 \begin_layout Plain Layout
6833 This is usually in the directory
6834 \begin_inset Flex Code
6837 \begin_layout Plain Layout
6844 though you can execute the command
6845 \begin_inset Flex Code
6848 \begin_layout Plain Layout
6859 The location of the `local' \SpecialChar TeX
6860 tree is defined by the
6861 \begin_inset Flex Code
6864 \begin_layout Plain Layout
6871 this is usually somewhere like
6872 \begin_inset Flex Code
6875 \begin_layout Plain Layout
6876 /usr/local/share/texmf
6881 or /usr/local/texlive/XXXX where XXXX is the year of the installed \SpecialChar TeX
6883 The location of the `user' \SpecialChar TeX
6885 \begin_inset Flex Code
6888 \begin_layout Plain Layout
6895 \begin_inset Flex Code
6898 \begin_layout Plain Layout
6905 \begin_inset Flex Code
6908 \begin_layout Plain Layout
6917 (If these variables are not predefined,
6918 you have to define them.) You'll probably need root permissions to create or modify the `local' tree,
6919 but not for your `user' tree.
6920 \begin_inset Newline newline
6924 it is recommended to install in the user tree because your user will not be modified or even overwritten when you upgrade your system.
6925 It will typically also be backed up together with everything else when you backup your home directory (which,
6927 you do on a regular basis).
6930 \begin_layout Enumerate
6932 if you want the new package to be available for all users on your system,
6933 change to the folder where \SpecialChar LaTeX
6934 is installed and then change to the subfolder
6935 \begin_inset Flex Code
6938 \begin_layout Plain Layout
6949 (For MiK\SpecialChar TeX
6951 this would be by default the folder
6952 \begin_inset Flex Code
6955 \begin_layout Plain Layout
6973 \begin_layout Plain Layout
6974 Note that this will be the correct path only on English installations.
6977 \begin_inset Flex Code
6980 \begin_layout Plain Layout
6995 and similarly for other languages.
7000 Create there a new folder
7001 \begin_inset Flex Code
7004 \begin_layout Plain Layout
7010 and copy all files of the package into it.
7012 \begin_inset Newline newline
7015 If the package should only available for you or you don't have admin permissions,
7017 but in the local \SpecialChar LaTeX
7020 \begin_inset space \thinspace{}
7024 for MiK\SpecialChar TeX
7026 \begin_inset space ~
7029 2.8 under Windows XP,
7030 this would be the folder:
7031 \begin_inset Newline newline
7037 \begin_inset Flex Code
7040 \begin_layout Plain Layout
7043 Documents and Settings
7055 \begin_inset Newline newline
7061 \begin_inset Phantom HPhantom
7064 \begin_layout Plain Layout
7075 \begin_inset Flex Code
7078 \begin_layout Plain Layout
7091 \begin_inset Newline newline
7096 \begin_inset Newline newline
7100 \begin_inset Flex Code
7103 \begin_layout Plain Layout
7129 \begin_layout Enumerate
7130 Now one only need to tell \SpecialChar LaTeX
7131 that there are new files.
7132 This depends on the used \SpecialChar LaTeX
7137 \begin_layout Enumerate
7138 For \SpecialChar TeX
7139 Live execute the command
7140 \begin_inset Flex Code
7143 \begin_layout Plain Layout
7150 If you installed the package for all users,
7151 then you will probably need to have root permissions for that.
7154 \begin_layout Enumerate
7155 For MiK\SpecialChar TeX
7157 if you have installed the package for all users,
7159 \begin_inset Quotes eld
7163 \begin_inset space ~
7167 \begin_inset Quotes erd
7170 and press the button marked
7171 \begin_inset Quotes eld
7175 \begin_inset Quotes erd
7179 Otherwise start the program
7180 \begin_inset Quotes eld
7184 \begin_inset Quotes erd
7191 \begin_layout Enumerate
7193 you need to tell \SpecialChar LyX
7194 that there are new packages available.
7199 \begin_inset Flex Noun
7202 \begin_layout Plain Layout
7205 \SpecialChar menuseparator
7211 and then restart \SpecialChar LyX
7215 \begin_layout Standard
7216 Now the package is installed.
7219 \begin_inset Flex Code
7222 \begin_layout Plain Layout
7228 will now be available under
7229 \begin_inset Flex Noun
7232 \begin_layout Plain Layout
7233 Document\SpecialChar menuseparator
7234 Settings\SpecialChar menuseparator
7241 \begin_inset Quotes eld
7245 \begin_inset Quotes erd
7252 \begin_layout Standard
7253 If you would like to use a \SpecialChar LaTeX
7254 document class that is not even listed in the menu
7255 \begin_inset Flex Noun
7258 \begin_layout Plain Layout
7259 Document\SpecialChar menuseparator
7260 Settings\SpecialChar menuseparator
7267 then you need to create a `layout' file for it.
7268 That is the topic of the next section.
7271 \begin_layout Section
7272 Types of layout files
7275 \begin_layout Standard
7276 This section describes the various sorts of \SpecialChar LyX
7277 files that contain layout information.
7278 These files describe various paragraph and character styles,
7279 determining how \SpecialChar LyX
7280 should display them and how they should be translated into \SpecialChar LaTeX
7284 or whatever output format is being used.
7288 \begin_layout Standard
7289 We shall try to provide a thorough description of the process of writing layout files here.
7291 there are so many different types of documents supported even by just \SpecialChar LaTeX
7292 that we can't hope to cover every different possibility or problem you might encounter.
7293 The \SpecialChar LyX
7294 users' list is frequented by people with lots of experience with layout design who are willing to share what they've learned,
7295 so please feel free to ask questions there.
7298 \begin_layout Standard
7299 As you prepare to write a new layout,
7300 it is extremely helpful to look at the layouts distributed with \SpecialChar LyX
7302 If you write a \SpecialChar LyX
7303 layout for a \SpecialChar LaTeX
7304 document class that might also be used by others,
7305 or write a module that might be useful to others,
7306 then you should consider posting your layout to the
7307 \begin_inset CommandInset href
7309 name "layout section on the LyX wiki"
7310 target "https://wiki.lyx.org/Layouts/Layouts"
7315 or even to the \SpecialChar LyX
7317 so that it might be included in \SpecialChar LyX
7322 \begin_layout Plain Layout
7323 Note that \SpecialChar LyX
7324 is licensed under the General Public License,
7325 so any material that is contributed to \SpecialChar LyX
7326 must be similarly licensed.
7334 \begin_layout Subsection
7336 \begin_inset CommandInset label
7338 name "subsec:Layout-modules"
7345 \begin_layout Standard
7346 We have spoken to this point about `layout files'.
7347 But there are different sorts of files that contain layout information.
7351 \begin_inset Flex Code
7354 \begin_layout Plain Layout
7360 extension and provide \SpecialChar LyX
7361 with information about document classes.
7362 Since \SpecialChar LyX
7363 1.6 layout information can also be contained in layout
7369 \begin_inset Flex Code
7372 \begin_layout Plain Layout
7379 Modules are to \SpecialChar LaTeX
7380 packages much as layouts are to \SpecialChar LaTeX
7384 \begin_inset Flex Code
7387 \begin_layout Plain Layout
7394 specifically provide support for one package.
7396 layout modules are similar to included
7400 \begin_layout Plain Layout
7401 These can have any extension,
7402 but by convention have the
7403 \begin_inset Flex Code
7406 \begin_layout Plain Layout
7419 \begin_inset Flex Code
7422 \begin_layout Plain Layout
7429 in that modules are not specific to a given document class but may be used with many different classes.
7430 The difference is that using an included file with
7431 \begin_inset Flex Code
7434 \begin_layout Plain Layout
7440 requires editing that file.
7444 \begin_inset Flex Noun
7447 \begin_layout Plain Layout
7448 Document\SpecialChar menuseparator
7457 \begin_layout Standard
7458 Building modules is the easiest way to get started with layout editing,
7459 since it can be as simple as adding a single new paragraph style or flex inset.
7462 contain anything a layout file can contain.
7465 \begin_layout Standard
7466 After creating a new module and copying it to the
7467 \begin_inset Flex Code
7470 \begin_layout Plain Layout
7477 you will need to reconfigure and then restart \SpecialChar LyX
7478 for the module to appear in the menu.
7480 changes you make to the module will be seen immediately,
7482 \begin_inset Flex Noun
7485 \begin_layout Plain Layout
7486 Document\SpecialChar menuseparator
7493 highlight something,
7495 \begin_inset Quotes eld
7499 \begin_inset Quotes erd
7505 It is strongly recommended that you save your work before doing this
7511 it is strongly recommended that you not attempt to edit modules while simultaneously working on actual documents
7514 Though of course the developers strive to keep \SpecialChar LyX
7515 stable in such situations,
7516 syntax errors and the like in your module file could cause strange behavior.
7519 \begin_layout Subsubsection
7523 \begin_layout Standard
7524 Modules are to \SpecialChar LyX
7525 as packages are to \SpecialChar LaTeX
7529 you find yourself wanting a specific inset or character style just for one document and writing a module that will also be available to other documents makes little sense.
7530 What you need is \SpecialChar LyX
7532 \begin_inset Quotes eld
7536 \begin_inset Quotes erd
7542 \begin_layout Standard
7543 You will find it under
7545 Document\SpecialChar menuseparator
7546 Settings\SpecialChar menuseparator
7550 The large text box allows you to enter anything that you might enter in a layout file or module.
7551 You can think of a document's local layout,
7553 as a module that belongs just to it.
7557 \begin_inset Flex Code
7560 \begin_layout Plain Layout
7567 Any format is acceptable,
7568 but one would normally use the format current at the time.
7569 (In \SpecialChar LyX
7577 the current layout format is
7586 \begin_layout Standard
7587 When you have entered something in the
7588 \begin_inset Flex Code
7591 \begin_layout Plain Layout
7600 \begin_inset Quotes eld
7604 \begin_inset Quotes erd
7607 button at the bottom.
7608 Clicking this button will cause \SpecialChar LyX
7609 to determine whether what you have entered is valid layout information for the chosen format.
7611 will report the result but,
7613 will not tell you what errors there might have been.
7614 These will be written to the terminal,
7617 is started from a terminal.
7618 You will not be permitted to save your local layout until you have entered something valid.
7621 \begin_layout Standard
7622 The warnings at the end of the previous section apply here,
7624 Do not play with local layout while you are actually working,
7625 especially if you have not saved your document.
7627 using local layout with a test document can be a very convenient way to try out layout ideas,
7628 or even to start developing a module.
7631 \begin_layout Subsection
7633 \begin_inset Flex Noun
7636 \begin_layout Plain Layout
7645 \begin_layout Standard
7646 There are two situations you are likely to encounter when wanting to support a new \SpecialChar LaTeX
7649 \begin_inset Flex Code
7652 \begin_layout Plain Layout
7658 ) files and \SpecialChar LaTeX2e
7660 \begin_inset Flex Code
7663 \begin_layout Plain Layout
7670 Supporting a style file is usually fairly easy.
7671 Supporting a new class file is a bit harder.
7672 We'll discuss the former in this section and the latter in the next.
7674 \change_deleted 5863208 1594239023
7675 Similar remarks apply,
7677 if you want to support a new DocBook DTD.
7682 \begin_layout Standard
7683 The easier case is the one in which your new document class is provided as a style file that is to be used in conjunction with an already supported document class.
7684 For the sake of the example,
7685 we'll assume that the style file is called
7686 \begin_inset Flex Noun
7689 \begin_layout Plain Layout
7695 and that it is meant to be used with
7696 \begin_inset Flex Noun
7699 \begin_layout Plain Layout
7706 which is a standard class.
7710 \begin_layout Standard
7711 Start by copying the existing class's layout file into your local directory:
7715 \begin_layout Plain Layout
7717 which directory is your local directory will vary by platform,
7718 and \SpecialChar LyX
7719 allows you to specify your local directory on startup,
7722 \begin_inset Flex Code
7725 \begin_layout Plain Layout
7739 \begin_layout LyX-Code
7740 cp report.layout ~/.lyx/layouts/myclass.layout
7743 \begin_layout Standard
7745 \begin_inset Flex Code
7748 \begin_layout Plain Layout
7754 and change the line:
7758 \begin_layout LyX-Code
7761 DeclareLaTeXClass{Report (Standard Class)}
7764 \begin_layout Standard
7768 \begin_layout LyX-Code
7771 DeclareLaTeXClass[report,
7772 myclass.sty]{Report (My Class)}
7775 \begin_layout Standard
7779 \begin_layout LyX-Code
7781 \begin_inset Newline newline
7787 \begin_inset Newline newline
7793 \begin_layout Standard
7794 near the top of the file.
7797 \begin_layout Standard
7798 Start \SpecialChar LyX
7800 \begin_inset Flex Noun
7803 \begin_layout Plain Layout
7804 Tools\SpecialChar menuseparator
7811 Then restart \SpecialChar LyX
7812 and try creating a new document.
7814 \begin_inset Flex Noun
7817 \begin_layout Plain Layout
7823 " as a document class option in the
7824 \begin_inset Flex Noun
7827 \begin_layout Plain Layout
7828 Document\SpecialChar menuseparator
7835 It is likely that some of the sectioning commands and such in your new class will work differently from how they worked in the base class—
7837 \begin_inset Flex Code
7840 \begin_layout Plain Layout
7847 so you can fiddle around with the settings for the different sections if you wish.
7848 The layout information for sections is contained in
7849 \begin_inset Flex Code
7852 \begin_layout Plain Layout
7859 but you do not need to copy and change this file.
7861 you can simply add your changes to your layout file,
7863 \begin_inset Flex Code
7866 \begin_layout Plain Layout
7873 which itself includes
7874 \begin_inset Flex Code
7877 \begin_layout Plain Layout
7885 you might add these lines:
7888 \begin_layout LyX-Code
7892 \begin_layout LyX-Code
7896 \begin_layout LyX-Code
7900 \begin_layout LyX-Code
7904 \begin_layout LyX-Code
7908 \begin_layout Standard
7909 to change the font for chapter headings to sans-serif.
7910 This will override (or,
7912 add to) the existing declaration for the Chapter style.
7916 \begin_layout Standard
7917 Your new package may also provide commands or environments not present in the base class.
7919 you will want to add these to the layout file.
7921 \begin_inset CommandInset ref
7923 reference "sec:TextClass"
7928 for information on how to do so.
7931 \begin_layout Standard
7933 \begin_inset Flex Noun
7936 \begin_layout Plain Layout
7942 can be used with several different document classes,
7943 and even if it cannot,
7944 you might find it easiest just to write a module that you can load with the base class.
7945 The simplest possible such module would be:
7948 \begin_layout LyX-Code
7951 DeclareLyXModule{My Class}
7954 \begin_layout LyX-Code
7958 \begin_layout LyX-Code
7959 #Support for myclass.sty.
7962 \begin_layout LyX-Code
7964 \begin_inset Newline newline
7970 \begin_layout LyX-Code
7978 \begin_inset Newline newline
7984 \begin_layout LyX-Code
7986 \begin_inset Newline newline
7992 \begin_inset Newline newline
7998 \begin_layout Standard
7999 A more complex module might modify the behavior of some existing constructs or define some new ones.
8002 \begin_inset CommandInset ref
8004 reference "sec:TextClass"
8012 \begin_layout Subsection
8014 \begin_inset Flex Noun
8017 \begin_layout Plain Layout
8026 \begin_layout Standard
8027 There are two possibilities here.
8028 One is that the class file is itself based upon an existing document class.
8030 many thesis classes are based upon
8031 \begin_inset Flex Noun
8034 \begin_layout Plain Layout
8041 To see whether yours is,
8042 look for a line like
8045 \begin_layout LyX-Code
8051 \begin_layout Standard
8054 then you may proceed largely as in the previous section,
8056 \begin_inset Flex Code
8059 \begin_layout Plain Layout
8060 Declare\SpecialChar LaTeX
8066 line will be different.
8067 If your new class is
8068 \begin_inset Flex Code
8071 \begin_layout Plain Layout
8077 and it is based upon
8078 \begin_inset Flex Code
8081 \begin_layout Plain Layout
8088 then the line should read:
8092 \begin_layout Plain Layout
8093 And it will be easiest if you save the file to
8094 \begin_inset Flex Code
8097 \begin_layout Plain Layout
8105 assumes that the document class has the same name as the layout file.
8114 \begin_layout LyX-Code
8117 DeclareLaTeXClass[thesis,book]{thesis}
8120 \begin_layout Standard
8123 the new class is not based upon an existing class,
8124 you will probably have to
8125 \begin_inset Quotes eld
8129 \begin_inset Quotes erd
8133 We strongly suggest copying an existing layout file which uses a similar \SpecialChar LaTeX
8134 class and then modifying it,
8136 At least use an existing file as a starting point so you can find out what items you need to worry about.
8138 the specifics are covered below.
8141 \begin_layout Subsection
8143 \begin_inset CommandInset label
8145 name "subsec:Creating-Templates"
8152 \begin_layout Standard
8153 Once you have written a layout file for a new document class,
8154 you might want to consider writing a
8160 A template acts as a kind of tutorial for your layout,
8161 showing how it might be used,
8162 though containing dummy content.
8163 You can of course look at the various templates included with \SpecialChar LyX
8167 \begin_layout Standard
8168 Templates are created just like usual documents:
8169 using \SpecialChar LyX
8171 The only difference is that usual documents contain all possible settings,
8172 including the font scheme and the paper size.
8173 Usually a user doesn't want a template to overwrite his preferred settings for such parameters.
8175 the designer of a template should remove the corresponding commands like
8176 \begin_inset Flex Code
8179 \begin_layout Plain Layout
8188 \begin_inset Flex Code
8191 \begin_layout Plain Layout
8199 from the template \SpecialChar LyX
8201 This can be done with any simple text-editor,
8203 \begin_inset Flex Code
8206 \begin_layout Plain Layout
8213 \begin_inset Flex Code
8216 \begin_layout Plain Layout
8225 \begin_layout Standard
8226 Put the edited template files you create in
8227 \begin_inset Flex Code
8230 \begin_layout Plain Layout
8237 copy the ones you use from the global template directory in
8238 \begin_inset Flex Code
8241 \begin_layout Plain Layout
8248 and redefine the template path in the
8249 \begin_inset Flex Noun
8252 \begin_layout Plain Layout
8253 Tools\SpecialChar menuseparator
8254 Preferences\SpecialChar menuseparator
8263 \begin_layout Standard
8266 that there is a template which has a particular meaning:
8267 \begin_inset Newline linebreak
8271 \begin_inset Flex Code
8274 \begin_layout Plain Layout
8281 This template is loaded every time you create a new document with
8282 \begin_inset Flex Noun
8285 \begin_layout Plain Layout
8286 File\SpecialChar menuseparator
8292 in order to provide useful defaults.
8293 To create this template from inside \SpecialChar LyX
8295 all you have to do is to open a document with the correct settings,
8297 \begin_inset Flex Noun
8300 \begin_layout Plain Layout
8301 Save as Document Defaults
8309 \begin_layout Subsection
8310 Upgrading old layout files
8313 \begin_layout Standard
8314 The format of layout files changes with each \SpecialChar LyX
8316 so old layout files need to be converted to the new format.
8318 reads a layout file in an older format,
8319 it automatically calls the script
8320 \begin_inset Flex Code
8323 \begin_layout Plain Layout
8329 to convert it to a temporary file in current format.
8330 The original file is left untouched.
8331 If you use the layout file often,
8333 you may want to convert it permanently,
8334 so that \SpecialChar LyX
8335 does not have to do so itself every time.
8337 you can call the converter manually:
8340 \begin_layout Enumerate
8342 \begin_inset Flex Code
8345 \begin_layout Plain Layout
8352 \begin_inset Flex Code
8355 \begin_layout Plain Layout
8364 \begin_layout Enumerate
8366 \begin_inset Newline newline
8370 \begin_inset Flex Code
8373 \begin_layout Plain Layout
8374 python LyXDir/scripts/layout2layout.py myclass.old myclass.layout
8380 \begin_inset Newline newline
8384 \begin_inset Flex Code
8387 \begin_layout Plain Layout
8393 is the name of your \SpecialChar LyX
8397 \begin_layout Standard
8398 Note that manual conversion does not affect included files,
8399 so these will have to be converted separately.
8402 \begin_layout Subsection
8403 \begin_inset CommandInset label
8405 name "subsec:Cite-Engine-Files"
8412 \begin_layout Standard
8413 A specific form of layout files are the so-called
8414 \begin_inset Flex Code
8417 \begin_layout Plain Layout
8423 files that are located in the
8424 \begin_inset Flex Code
8427 \begin_layout Plain Layout
8434 Their purpose is to define the specifics of \SpecialChar LaTeX
8435 packages aimed at bibliography generation,
8450 but also the way how normal Bib\SpecialChar TeX
8451 citations (without additional packages) are handled in \SpecialChar LyX
8452 is defined in such a file.
8456 \begin_layout Standard
8458 it is defined which packages \SpecialChar LyX
8460 which citation commands are available,
8461 how these are to be displayed in \SpecialChar LyX
8464 the context menus) as well as in the XHTML and plain text output.
8466 the files specify available style variants (author-year,
8468 etc.) and their specifics.
8469 The cite engine files are also used to generate the options that are available in
8471 Document\SpecialChar menuseparator
8472 Settings\SpecialChar menuseparator
8473 Bibliography\SpecialChar menuseparator
8479 \begin_layout Standard
8480 Even though a cite engine file is essentially a normal layout file that could theoretically include any layout information,
8481 it usually primarily includes some specific parameters such as
8482 \begin_inset Flex Code
8485 \begin_layout Plain Layout
8493 \begin_inset Flex Code
8496 \begin_layout Plain Layout
8504 \begin_inset Flex Code
8507 \begin_layout Plain Layout
8514 \begin_inset Flex Code
8517 \begin_layout Plain Layout
8524 The syntax of the latter two is described in
8525 \begin_inset CommandInset ref
8527 reference "subsec:Citation-engine-description"
8536 \begin_inset CommandInset ref
8538 reference "subsec:Citation-format-description"
8544 as well as in the files themselves.
8547 \begin_layout Section
8548 \begin_inset CommandInset label
8550 name "sec:TextClass"
8554 The layout file format
8557 \begin_layout Standard
8558 The following sections describe how layout files are structured and written.
8559 Our advice is to go slowly,
8560 save and test often.
8561 It is really not that hard,
8562 except that the multitude of options can become overwhelming,
8563 especially if you try to check out too many at once.
8564 It becomes easier if you use existing layouts of \SpecialChar LyX
8565 as examples/reference or if you modify an existing layout to your needs.
8568 \begin_layout Standard
8569 Note that all the tags used in layout files are case-insensitive.
8571 \begin_inset Flex Code
8574 \begin_layout Plain Layout
8582 \begin_inset Flex Code
8585 \begin_layout Plain Layout
8592 \begin_inset Flex Code
8595 \begin_layout Plain Layout
8601 are really the same tag.
8602 The possible arguments are printed in brackets after the tag's name.
8603 The default argument is typeset
8604 \begin_inset Flex Code
8607 \begin_layout Plain Layout
8616 If the argument has a data type like
8617 \begin_inset Quotes eld
8621 \begin_inset Quotes erd
8625 \begin_inset Quotes eld
8629 \begin_inset Quotes erd
8633 the default is shown like this:
8635 \begin_inset Flex Code
8638 \begin_layout Plain Layout
8649 \begin_layout Subsection
8650 The document class declaration and classification
8653 \begin_layout Standard
8654 Lines in a layout file which begin with
8655 \begin_inset Flex Code
8658 \begin_layout Plain Layout
8665 There is one exception to this rule.
8667 \begin_inset Flex Code
8670 \begin_layout Plain Layout
8676 files should begin with lines like:
8679 \begin_layout LyX-Code
8682 #% Do not delete the line below;
8683 configure depends on this
8686 \begin_layout LyX-Code
8691 DeclareLaTeXClass{Article (Standard Class)}
8694 \begin_layout LyX-Code
8699 DeclareCategory{Articles}
8702 \begin_layout Standard
8703 The second and third lines are used when you (re)configure \SpecialChar LyX
8705 The layout file is read by the \SpecialChar LaTeX
8707 \begin_inset Flex Code
8710 \begin_layout Plain Layout
8717 in a special mode where
8718 \begin_inset Flex Code
8721 \begin_layout Plain Layout
8728 The first line is just a \SpecialChar LaTeX
8730 the second one contains the mandatory declaration of the text class and the third line contains the optional classification of the class.
8731 If these lines appear in a file named
8732 \begin_inset Flex Code
8735 \begin_layout Plain Layout
8742 then they define a text class of name
8743 \begin_inset Flex Code
8746 \begin_layout Plain Layout
8752 (the name of the layout file) which uses the \SpecialChar LaTeX
8754 \begin_inset Flex Code
8757 \begin_layout Plain Layout
8763 (the default is to use the same name as the layout).
8765 \begin_inset Quotes eld
8768 Article (Standard Class)
8769 \begin_inset Quotes erd
8772 that appears above is used as a description of the text class in the
8773 \begin_inset Flex Noun
8776 \begin_layout Plain Layout
8777 Document\SpecialChar menuseparator
8785 \begin_inset Quotes eld
8789 \begin_inset Quotes erd
8792 in the example) is also used in the
8793 \begin_inset Flex Noun
8796 \begin_layout Plain Layout
8797 Document\SpecialChar menuseparator
8804 the text classes are grouped by these categories (which are usually genres,
8805 so typical categories are
8806 \begin_inset Quotes eld
8810 \begin_inset Quotes erd
8815 \begin_inset Quotes eld
8819 \begin_inset Quotes erd
8824 \begin_inset Quotes eld
8828 \begin_inset Quotes erd
8833 \begin_inset Quotes eld
8837 \begin_inset Quotes erd
8842 \begin_inset Quotes eld
8846 \begin_inset Quotes erd
8851 \begin_inset Quotes eld
8855 \begin_inset Quotes erd
8859 If no category has been declared,
8860 the class will be put in the
8861 \begin_inset Quotes eld
8865 \begin_inset Quotes erd
8871 \begin_layout Standard
8872 Let's assume that you wrote your own text class that uses the
8873 \begin_inset Flex Code
8876 \begin_layout Plain Layout
8883 but where you changed the appearance of the section headings.
8884 If you put it in a file
8885 \begin_inset Flex Code
8888 \begin_layout Plain Layout
8895 the header of this file should be:
8898 \begin_layout LyX-Code
8901 #% Do not delete the line below;
8902 configure depends on this
8905 \begin_layout LyX-Code
8910 DeclareLaTeXClass[article]{Article (with My Own Headings)}
8913 \begin_layout LyX-Code
8918 DeclareCategory{Articles}
8921 \begin_layout Standard
8922 This declares a text class
8923 \begin_inset Flex Code
8926 \begin_layout Plain Layout
8933 associated with the \SpecialChar LaTeX
8935 \begin_inset Flex Code
8938 \begin_layout Plain Layout
8945 \begin_inset Quotes eld
8948 Article (with My Own Headings)
8949 \begin_inset Quotes erd
8953 If your text class depends on several packages,
8954 you can declare it as:
8957 \begin_layout LyX-Code
8960 #% Do not delete the line below;
8961 configure depends on this
8964 \begin_layout LyX-Code
8969 DeclareLaTeXClass[article,foo.sty]{Article (with My Own Headings)}
8972 \begin_layout LyX-Code
8977 DeclareCategory{Articles}
8980 \begin_layout Standard
8981 This indicates that your text class uses the
8982 \begin_inset Flex Code
8985 \begin_layout Plain Layout
8993 \change_deleted 5863208 1594239179
8995 it is also possible to declare classes for DocBook code.
8996 Typical declarations will look like:
8999 \begin_layout LyX-Code
9001 \change_deleted 5863208 1594239179
9004 #% Do not delete the line below;
9005 configure depends on this
9008 \begin_layout LyX-Code
9010 \change_deleted 5863208 1594239179
9015 DeclareDocBookClass[article]{SGML (DocBook Article)}
9018 \begin_layout LyX-Code
9020 \change_deleted 5863208 1594239179
9025 DeclareCategory{Articles (DocBook)}
9030 \begin_layout Standard
9031 Note that these declarations can also be given an optional parameter declaring the name of the document class (but not a list).
9034 \begin_layout Standard
9036 to be as explicit as possible,
9037 the form of the layout declaration is:
9040 \begin_layout LyX-Code
9045 DeclareLaTeXClass[class,package.sty]{layout description}
9048 \begin_layout LyX-Code
9053 DeclareCategory{category}
9056 \begin_layout Standard
9057 The class need only be specified if the name of the \SpecialChar LaTeX
9058 class file and the name of the layout file are different or if there are packages to load.
9059 If the name of the class file is not specified,
9060 then \SpecialChar LyX
9061 will simply assume that it is the same as the name of the layout file.
9064 \begin_layout Standard
9065 When the text class has been modified to your taste,
9066 all you have to do is to copy it either to
9067 \begin_inset Flex Code
9070 \begin_layout Plain Layout
9077 \begin_inset Flex Code
9080 \begin_layout Plain Layout
9088 \begin_inset Flex Noun
9091 \begin_layout Plain Layout
9092 Tools\SpecialChar menuseparator
9099 exit \SpecialChar LyX
9101 Then your new text class should be available along with the others.
9104 \begin_layout Standard
9105 Once the layout file is installed,
9106 you can edit it and see your changes without having to reconfigure or to restart \SpecialChar LyX
9111 \begin_layout Plain Layout
9112 In versions of \SpecialChar LyX
9116 editing layout files was very time consuming,
9117 since you had constantly to restart \SpecialChar LyX
9123 You can force a reload of the current layout by using the \SpecialChar LyX
9125 \begin_inset Flex Noun
9128 \begin_layout Plain Layout
9135 There is no default binding for this function—
9138 you can bind it to a key yourself.
9139 But you will normally use this function simply by entering it in the mini-buffer.
9143 \begin_layout Standard
9150 \begin_inset Flex Noun
9153 \begin_layout Plain Layout
9159 is very much an `advanced feature'.
9164 recommended that you save your work before using this function.
9170 recommended that you not attempt to edit layout information while simultaneously working on a document that you care about.
9171 Use a test document.
9172 Syntax errors and the like in your layout file could cause peculiar behavior.
9174 such errors could cause \SpecialChar LyX
9175 to regard the current layout as invalid and to attempt to switch to some other layout.
9179 \begin_layout Plain Layout
9180 Really bad syntax errors may even caused \SpecialChar LyX
9182 This is because certain sorts of errors may make \SpecialChar LyX
9193 The \SpecialChar LyX
9194 team strives to keep \SpecialChar LyX
9195 stable in such situations,
9196 but safe is better than sorry.
9200 \begin_layout Plain Layout
9201 While we're giving advice:
9202 make regular backups.
9203 And be nice to your mother.
9211 \begin_layout Subsection
9212 The Module declaration
9215 \begin_layout Standard
9216 A module must begin with a line like the following:
9219 \begin_layout LyX-Code
9222 DeclareLyXModule[endnotes.sty]{Endnotes}
9223 \change_inserted -712698321 1554395911
9227 \begin_layout LyX-Code
9229 \change_inserted -712698321 1554395924
9234 DeclareCategory{Foot- and Endnotes}
9235 \change_deleted -712698321 1554395911
9243 \begin_layout Standard
9244 The mandatory argument
9245 \change_inserted -712698321 1554395956
9256 is the name of the module,
9257 as it should appear in
9258 \begin_inset Flex Noun
9261 \begin_layout Plain Layout
9262 Document\SpecialChar menuseparator
9263 Settings\SpecialChar menuseparator
9270 The argument in square brackets is optional:
9271 It declares any \SpecialChar LaTeX
9272 packages on which the module depends.
9273 It is also possible to use the form
9274 \begin_inset Flex Noun
9277 \begin_layout Plain Layout
9283 as an optional argument,
9284 which declares that the module can only be used when there exists a conversion chain between the formats `
9285 \begin_inset Flex Code
9288 \begin_layout Plain Layout
9295 \begin_inset Flex Code
9298 \begin_layout Plain Layout
9306 \change_inserted -712698321 1554396133
9313 declaration is not strictly mandatory,
9314 but you should add it,
9315 since it is helpful to find the module.
9316 Please have a look at the existing module categories and if appropriate,
9322 \begin_layout Standard
9324 \change_inserted -712698321 1554395988
9327 declaration should then be followed by lines like the following:
9331 \begin_layout Plain Layout
9332 Preferably in English if the module should be published with \SpecialChar LyX
9334 This description will appear in the list of messages to be translated and will be thus translated with the next interface update.
9342 \begin_layout LyX-Code
9346 \begin_layout LyX-Code
9347 #Adds an endnote command,
9348 in addition to footnotes.
9352 \begin_layout LyX-Code
9353 #You will need to add
9355 theendnotes in TeX code where you
9358 \begin_layout LyX-Code
9359 #want the endnotes to appear.
9363 \begin_layout LyX-Code
9367 \begin_layout LyX-Code
9369 somemodule | othermodule
9372 \begin_layout LyX-Code
9377 \begin_layout Standard
9378 The description is used in
9379 \begin_inset Flex Noun
9382 \begin_layout Plain Layout
9383 Document\SpecialChar menuseparator
9384 Settings\SpecialChar menuseparator
9390 to provide the user with information about what the module does.
9392 \begin_inset Flex Code
9395 \begin_layout Plain Layout
9401 line is used to identify other modules with which this one must be used;
9403 \begin_inset Flex Code
9406 \begin_layout Plain Layout
9412 line is used to identify modules with which this one may not be used.
9416 multiple modules should be separated with the pipe symbol:
9418 Note that the required modules are treated disjunctively:
9423 of the required modules must be used.
9429 excluded module may be used.
9430 Note that modules are identified here by their filenames without the
9431 \begin_inset Flex Code
9434 \begin_layout Plain Layout
9442 \begin_inset Flex Code
9445 \begin_layout Plain Layout
9452 \begin_inset Flex Code
9455 \begin_layout Plain Layout
9464 \begin_layout Subsection
9465 The CiteEngine file declaration
9468 \begin_layout Standard
9469 A cite engine file must begin with a line like the following:
9472 \begin_layout LyX-Code
9475 DeclareLyXCiteEngineModule[biblatex.sty]{Biblatex}
9478 \begin_layout Standard
9479 The mandatory argument,
9481 is the name of the cite style,
9482 as it should appear in
9483 \begin_inset Flex Noun
9486 \begin_layout Plain Layout
9487 Document\SpecialChar menuseparator
9488 Settings\SpecialChar menuseparator
9495 The argument in square brackets is optional:
9496 It declares any \SpecialChar LaTeX
9497 packages on which the cite engine depends.
9500 \begin_layout Standard
9501 The cite engine declaration should then be followed by lines like the following:
9505 \begin_layout Plain Layout
9506 Preferably in English if the module should be published with \SpecialChar LyX
9508 This description will appear in the list of messages to be translated and will be thus translated with the next interface update.
9516 \begin_layout LyX-Code
9520 \begin_layout LyX-Code
9521 # Biblatex supports many author-year and numerical styles.
9524 \begin_layout LyX-Code
9525 # It is mainly aimed at the Humanities.
9529 \begin_layout LyX-Code
9531 fully localized and provides many features
9534 \begin_layout LyX-Code
9535 # that are not possible with BibTeX.
9536 The use of 'biber' as
9539 \begin_layout LyX-Code
9540 # bibliography processor is advised.
9543 \begin_layout LyX-Code
9547 \begin_layout Standard
9548 The description is used in
9549 \begin_inset Flex Noun
9552 \begin_layout Plain Layout
9553 Document\SpecialChar menuseparator
9554 Settings\SpecialChar menuseparator
9560 to provide the user with information about the cite engine.
9563 \begin_layout Subsection
9567 \begin_layout Standard
9568 The first non-comment line of any layout file,
9574 contain the file format number:
9577 \begin_layout Description
9578 \begin_inset Flex Code
9581 \begin_layout Plain Layout
9588 \begin_inset Flex Code
9591 \begin_layout Plain Layout
9597 ] The format number of the layout file.
9600 \begin_layout Standard
9601 This tag was introduced with \SpecialChar LyX
9603 \begin_inset space ~
9607 Layout files from older \SpecialChar LyX
9608 versions do not have an explicit file format and are considered to have
9609 \begin_inset Flex Code
9612 \begin_layout Plain Layout
9614 \begin_inset space ~
9623 The format for the present version of \SpecialChar LyX
9625 But each version of \SpecialChar LyX
9626 is capable of reading earlier versions' layout files,
9627 just as they are capable of reading files produced by earlier versions of \SpecialChar LyX
9631 no provision for converting to earlier formats.
9634 \begin_layout Subsection
9635 \begin_inset CommandInset label
9637 name "subsec:General-text-class"
9641 General text class parameters
9644 \begin_layout Standard
9645 These are general parameters that govern the behavior of an entire document class.
9650 mean that they must appear in
9651 \begin_inset Flex Code
9654 \begin_layout Plain Layout
9660 files rather than in modules.
9661 A module can contain any layout tag.)
9664 \begin_layout Description
9666 \change_inserted -712698321 1526899478
9667 \begin_inset Flex Code
9670 \begin_layout Plain Layout
9672 \change_inserted -712698321 1526898610
9673 AddToCiteEngine <engine>
9680 Extends the possibilities for displaying citation references.
9682 \begin_inset CommandInset ref
9684 reference "subsec:Citation-engine-description"
9694 \begin_inset Flex Code
9697 \begin_layout Plain Layout
9699 \change_inserted -712698321 1526898823
9710 \begin_layout Description
9711 \begin_inset Flex Code
9714 \begin_layout Plain Layout
9720 Adds information that will be output in the
9721 \begin_inset Flex Code
9724 \begin_layout Plain Layout
9730 block when the document is output to XHTML.
9732 this would be used to output CSS style information,
9733 but it can be used for anything that can appear in
9734 \begin_inset Flex Code
9737 \begin_layout Plain Layout
9745 \begin_inset Quotes eld
9749 \begin_inset Flex Code
9752 \begin_layout Plain Layout
9759 \begin_inset Quotes erd
9765 \begin_layout Description
9766 \begin_inset Flex Code
9769 \begin_layout Plain Layout
9775 Adds information to the document preamble.
9777 \begin_inset Newline newline
9781 \begin_inset Quotes eld
9785 \begin_inset Flex Code
9788 \begin_layout Plain Layout
9795 \begin_inset Quotes erd
9799 \change_inserted -712698321 1562592950
9803 \begin_layout Description
9805 \change_inserted -712698321 1562593040
9806 \begin_inset Flex Code
9809 \begin_layout Plain Layout
9811 \change_inserted -712698321 1562592954
9820 \begin_inset Flex Code
9823 \begin_layout Plain Layout
9825 \change_inserted -712698321 1562592950
9836 \begin_inset space \thinspace{}
9840 \begin_inset Flex Code
9843 \begin_layout Plain Layout
9845 \change_inserted -712698321 1562592950
9853 ] If the document class adds the bibliography to the table of contents,
9854 add this option with value
9855 \begin_inset Flex Code
9858 \begin_layout Plain Layout
9860 \change_inserted -712698321 1562592996
9869 \begin_inset Flex Code
9872 \begin_layout Plain Layout
9874 \change_inserted -712698321 1562593006
9883 This prevents the bibliography from being added twice.
9888 \begin_layout Description
9889 \begin_inset Flex Code
9892 \begin_layout Plain Layout
9898 Defines the possibilities for displaying citation references.
9900 \begin_inset CommandInset ref
9902 reference "subsec:Citation-engine-description"
9912 \begin_inset Quotes eld
9916 \begin_inset Flex Code
9919 \begin_layout Plain Layout
9926 \begin_inset Quotes erd
9930 Primarily used in cite engine files (see
9931 \begin_inset CommandInset ref
9933 reference "subsec:Cite-Engine-Files"
9943 \change_inserted -712698321 1526898530
9944 Note that if you specify this in a layout file or module,
9945 any cite engine definition will be overridden.
9947 \begin_inset Flex Code
9950 \begin_layout Plain Layout
9952 \change_inserted -712698321 1526898530
9965 \begin_layout Description
9966 \begin_inset Flex Code
9969 \begin_layout Plain Layout
9975 Defines formats for use in the display of bibliographic information.
9977 \begin_inset CommandInset ref
9979 reference "subsec:Citation-format-description"
9986 \begin_inset Quotes eld
9990 \begin_inset Flex Code
9993 \begin_layout Plain Layout
10000 \begin_inset Quotes erd
10004 Primarily used in cite engine files (see
10005 \begin_inset CommandInset ref
10007 reference "subsec:Cite-Engine-Files"
10017 \change_inserted -712698321 1526898585
10018 A cite format defined in a layout or module will override the cite engine definition.
10023 \begin_layout Description
10024 \begin_inset Flex Code
10027 \begin_layout Plain Layout
10034 \begin_inset Flex Code
10037 \begin_layout Plain Layout
10046 \begin_inset Flex Code
10049 \begin_layout Plain Layout
10055 ] Determines whether
10059 or Bib\SpecialChar TeX
10060 is used to generate a Bibliography.
10061 Primarily used in cite engine files (see
10062 \begin_inset CommandInset ref
10064 reference "subsec:Cite-Engine-Files"
10075 \begin_layout Description
10076 \begin_inset Flex Code
10079 \begin_layout Plain Layout
10085 Describes various global options supported by the document class.
10087 \begin_inset CommandInset ref
10089 reference "subsec:ClassOptions"
10096 \begin_inset Quotes eld
10100 \begin_inset Flex Code
10103 \begin_layout Plain Layout
10110 \begin_inset Quotes erd
10116 \begin_layout Description
10117 \begin_inset Flex Code
10120 \begin_layout Plain Layout
10127 \begin_inset Flex Code
10130 \begin_layout Plain Layout
10139 \begin_inset space \thinspace{}
10143 \begin_inset Flex Code
10146 \begin_layout Plain Layout
10152 ] Whether the class should
10156 to having one or two columns.
10157 Can be changed in the
10158 \begin_inset Flex Noun
10161 \begin_layout Plain Layout
10162 Document\SpecialChar menuseparator
10171 \begin_layout Description
10172 \begin_inset Flex Code
10175 \begin_layout Plain Layout
10182 \begin_inset Flex Code
10185 \begin_layout Plain Layout
10191 ] This sequence defines the properties for a counter.
10192 If the counter does not yet exist,
10197 \begin_inset Quotes eld
10201 \begin_inset Flex Code
10204 \begin_layout Plain Layout
10211 \begin_inset Quotes erd
10215 \begin_inset Newline newline
10219 \begin_inset CommandInset ref
10221 reference "subsec:Counters"
10226 for details on counters.
10229 \begin_layout Description
10230 \begin_inset Flex Code
10233 \begin_layout Plain Layout
10239 Sets the default font used to display the document.
10241 \begin_inset CommandInset ref
10243 reference "subsec:Font-description"
10248 for how to declare fonts.
10250 \begin_inset Quotes eld
10254 \begin_inset Flex Code
10257 \begin_layout Plain Layout
10264 \begin_inset Quotes erd
10270 \begin_layout Description
10271 \begin_inset Flex Code
10274 \begin_layout Plain Layout
10281 \begin_inset Flex Code
10284 \begin_layout Plain Layout
10290 ] Specifies a module to be included by default with this document class.
10291 The module is specified as filename without the
10292 \begin_inset Flex Code
10295 \begin_layout Plain Layout
10302 The user can still remove the module,
10303 but it will be active at the outset.
10304 (This applies only when new files are created,
10305 or when this class is chosen for an existing document.)
10308 \begin_layout Description
10309 \begin_inset Flex Code
10312 \begin_layout Plain Layout
10319 \begin_inset Flex Code
10322 \begin_layout Plain Layout
10328 ] This is the style that will be assigned to new paragraphs,
10330 \begin_inset Flex Noun
10333 \begin_layout Plain Layout
10340 This will default to the first defined style if not given,
10341 but you are encouraged to use this directive.
10344 \begin_layout Description
10346 \change_inserted -970929547 1515112870
10347 \begin_inset Flex Code
10350 \begin_layout Plain Layout
10352 \change_inserted -970929547 1515112782
10361 \begin_inset Flex Code
10364 \begin_layout Plain Layout
10366 \change_inserted -970929547 1515112766
10374 ] The root element (at the top of the document) to use when outputting documents with this class in DocBook.
10375 The default value is
10376 \begin_inset Quotes eld
10380 \begin_inset Flex Code
10383 \begin_layout Plain Layout
10385 \change_inserted -970929547 1515112845
10394 \begin_inset Quotes erd
10399 \change_deleted 1075283030 1594226862
10401 \change_inserted 1075283030 1594226777
10405 \begin_layout Description
10407 \change_inserted 1075283030 1594226859
10408 \begin_inset Flex Code
10411 \begin_layout Plain Layout
10413 \change_inserted 1075283030 1594226785
10414 DocBookForceAbstract
10422 \begin_inset Flex Code
10425 \begin_layout Plain Layout
10427 \change_inserted 1075283030 1594226804
10436 \begin_inset Quotes eld
10444 \begin_inset Quotes erd
10448 the root element will always have an
10453 The default value is
10454 \begin_inset Quotes eld
10462 \begin_inset Quotes erd
10470 \begin_layout Description
10471 \begin_inset Flex Code
10474 \begin_layout Plain Layout
10481 \begin_inset Flex Code
10484 \begin_layout Plain Layout
10490 ] This tag indicates that the module (which is specified by filename without the
10491 \begin_inset Flex Code
10494 \begin_layout Plain Layout
10500 extension) cannot be used with this document class.
10501 This might be used in a journal-specific layout file to prevent,
10504 \begin_inset Flex Code
10507 \begin_layout Plain Layout
10513 module that numbers theorems by section.
10518 be used in a module.
10519 Modules have their own way of excluding other modules (see
10520 \begin_inset CommandInset ref
10522 reference "subsec:Layout-modules"
10530 \begin_layout Description
10531 \begin_inset Flex Code
10534 \begin_layout Plain Layout
10540 Defines a new float.
10542 \begin_inset CommandInset ref
10544 reference "subsec:Floats"
10551 \begin_inset Quotes eld
10555 \begin_inset Flex Code
10558 \begin_layout Plain Layout
10565 \begin_inset Quotes erd
10571 \begin_layout Description
10572 \begin_inset Flex Code
10575 \begin_layout Plain Layout
10581 Sets the information that will be output in the
10582 \begin_inset Flex Code
10585 \begin_layout Plain Layout
10591 block when this document class is output to XHTML.
10592 Note that this will completely override any prior
10593 \begin_inset Flex Code
10596 \begin_layout Plain Layout
10603 \begin_inset Flex Code
10606 \begin_layout Plain Layout
10614 \begin_inset Newline newline
10618 \begin_inset Flex Code
10621 \begin_layout Plain Layout
10627 if you just want to add material to the preamble.) Must end with
10628 \begin_inset Quotes eld
10632 \begin_inset Flex Code
10635 \begin_layout Plain Layout
10642 \begin_inset Quotes erd
10648 \begin_layout Description
10649 \begin_inset Flex Code
10652 \begin_layout Plain Layout
10659 \begin_inset Flex Code
10662 \begin_layout Plain Layout
10668 ] The style to use for the table of contents,
10671 when the document is output to HTML.
10673 this should normally be
10674 \begin_inset Flex Code
10677 \begin_layout Plain Layout
10685 \begin_inset Flex Code
10688 \begin_layout Plain Layout
10695 If it is not given,
10696 then \SpecialChar LyX
10697 will attempt to figure out which layout to use.
10700 \begin_layout Description
10701 \begin_inset Flex Code
10704 \begin_layout Plain Layout
10711 \begin_inset Flex Code
10714 \begin_layout Plain Layout
10720 ] Modifies the properties of the given counter.
10721 If the counter does not exist,
10722 the statement is ignored.
10724 \begin_inset Quotes eld
10728 \begin_inset Flex Code
10731 \begin_layout Plain Layout
10738 \begin_inset Quotes erd
10742 \begin_inset Newline newline
10746 \begin_inset CommandInset ref
10748 reference "subsec:Counters"
10753 for details on counters.
10756 \begin_layout Description
10757 \begin_inset Flex Code
10760 \begin_layout Plain Layout
10767 \begin_inset Flex Code
10770 \begin_layout Plain Layout
10776 ] This allows you to include another layout definition file within yours to avoid duplicating commands.
10777 Common examples are the standard layout files,
10780 \begin_inset Flex Code
10783 \begin_layout Plain Layout
10790 which contains most of the basic layouts.
10791 \change_inserted -712698321 1611646803
10795 \begin_layout Description
10797 \change_inserted -712698321 1611646804
10798 \begin_inset Flex Code
10801 \begin_layout Plain Layout
10803 \change_inserted -712698321 1611646837
10812 \begin_inset Flex Code
10815 \begin_layout Plain Layout
10817 \change_inserted -712698321 1611646804
10825 ] is a variant of the
10826 \begin_inset Flex Code
10829 \begin_layout Plain Layout
10831 \change_inserted -712698321 1611646804
10839 command which does not look for files in the user directory.
10840 This allows to create a file
10841 \begin_inset Flex Code
10844 \begin_layout Plain Layout
10846 \change_inserted -712698321 1611646804
10855 \begin_inset Flex Code
10858 \begin_layout Plain Layout
10860 \change_inserted -712698321 1611646804
10868 in the user directory which includes a global file with the same name via
10869 \begin_inset Flex Code
10872 \begin_layout Plain Layout
10874 \change_inserted -712698321 1611646853
10883 \begin_inset Flex Code
10886 \begin_layout Plain Layout
10888 \change_inserted -712698321 1611646855
10889 InputGlobal name.inc
10898 \begin_inset Flex Code
10901 \begin_layout Plain Layout
10903 \change_inserted -712698321 1611646804
10912 the file would recursively include itself).
10914 you can modify global files without having to completely copy them.
10919 \begin_layout Description
10920 \begin_inset Flex Code
10923 \begin_layout Plain Layout
10930 \begin_inset Flex Code
10933 \begin_layout Plain Layout
10939 ] This section (re-)defines the layout of an inset.
10940 It can be applied to an existing inset or to a new,
10941 user-defined inset,
10943 a new character style.
10945 \begin_inset Quotes eld
10949 \begin_inset Flex Code
10952 \begin_layout Plain Layout
10959 \begin_inset Quotes erd
10963 \begin_inset Newline newline
10967 \begin_inset CommandInset ref
10969 reference "subsec:Flex-insets-and"
10974 for more information.
10978 \begin_layout Description
10979 \begin_inset Flex Code
10982 \begin_layout Plain Layout
10989 \begin_inset Flex Code
10992 \begin_layout Plain Layout
10998 ] A string that indicates the width of the left margin on the screen,
11001 \begin_inset Quotes eld
11005 \begin_inset Flex Code
11008 \begin_layout Plain Layout
11015 \begin_inset Quotes erd
11019 (Note that this is not a `length',
11021 \begin_inset Quotes eld
11025 \begin_inset Quotes erd
11031 \begin_layout Description
11032 \begin_inset Flex Code
11035 \begin_layout Plain Layout
11042 \begin_inset Flex Code
11045 \begin_layout Plain Layout
11051 ] An integer that determines the maximal number of names displayed in an author-year citation before the citation switches to
11052 \begin_inset Quotes eld
11056 \begin_inset Quotes erd
11060 Primarily used in cite engine files (see
11061 \begin_inset CommandInset ref
11063 reference "subsec:Cite-Engine-Files"
11074 \begin_layout Description
11076 \change_inserted -712698321 1612018485
11077 \begin_inset Flex Code
11080 \begin_layout Plain Layout
11082 \change_inserted -712698321 1612018457
11091 \begin_inset Flex Code
11094 \begin_layout Plain Layout
11096 \change_inserted -712698321 1612018466
11104 ] Modifies the layout of an inset.
11105 If the layout does not exist,
11106 this section is ignored.
11108 \begin_inset Quotes eld
11112 \begin_inset Flex Code
11115 \begin_layout Plain Layout
11117 \change_inserted -712698321 1612018452
11126 \begin_inset Quotes erd
11132 \begin_layout Description
11133 \begin_inset Flex Code
11136 \begin_layout Plain Layout
11143 \begin_inset Flex Code
11146 \begin_layout Plain Layout
11152 ] Modifies the properties of the given paragraph style.
11153 If the style does not exist,
11154 this section is ignored.
11156 \begin_inset Quotes eld
11160 \begin_inset Flex Code
11163 \begin_layout Plain Layout
11170 \begin_inset Quotes erd
11176 \begin_layout Description
11177 \begin_inset Flex Code
11180 \begin_layout Plain Layout
11187 \begin_inset Flex Code
11190 \begin_layout Plain Layout
11196 ] Deletes an existing counter,
11197 usually one defined in an included file.
11200 \begin_layout Description
11201 \begin_inset Flex Code
11204 \begin_layout Plain Layout
11211 \begin_inset Flex Code
11214 \begin_layout Plain Layout
11220 ] Deletes an existing float.
11221 This is particularly useful when you want to suppress a float that has been defined in an input file.
11224 \begin_layout Description
11225 \begin_inset Flex Code
11228 \begin_layout Plain Layout
11235 \begin_inset Flex Code
11238 \begin_layout Plain Layout
11244 ] Deletes an existing style.
11247 \begin_layout Description
11248 \begin_inset Flex Code
11251 \begin_layout Plain Layout
11258 \begin_inset Flex Code
11261 \begin_layout Plain Layout
11268 \begin_inset Flex Code
11271 \begin_layout Plain Layout
11277 ] Define a new table of contents with type
11278 \begin_inset Flex Code
11281 \begin_layout Plain Layout
11288 \begin_inset Flex Code
11291 \begin_layout Plain Layout
11298 See also the AddToToc commands.
11301 \begin_layout Description
11302 \begin_inset Flex Code
11305 \begin_layout Plain Layout
11312 \begin_inset Flex Code
11315 \begin_layout Plain Layout
11321 ] The file format (as defined in the \SpecialChar LyX
11322 preferences) produced by this document class.
11323 It is mainly useful when
11324 \begin_inset Flex Code
11327 \begin_layout Plain Layout
11334 \begin_inset Flex Code
11337 \begin_layout Plain Layout
11343 and one wants to define a new type of literate document.
11344 The format is reset to
11345 \change_deleted 5863208 1594239413
11347 \begin_inset Quotes eld
11351 \begin_inset Flex Code
11354 \begin_layout Plain Layout
11361 \begin_inset Quotes erd
11367 \begin_inset Quotes eld
11371 \begin_inset Flex Code
11374 \begin_layout Plain Layout
11381 \begin_inset Quotes erd
11384 when the corresponding
11385 \begin_inset Flex Code
11388 \begin_layout Plain Layout
11394 parameter is encountered.
11397 \begin_layout Description
11398 \begin_inset Flex Code
11401 \begin_layout Plain Layout
11408 \begin_inset Flex Code
11411 \begin_layout Plain Layout
11423 \change_deleted 5863208 1594239430
11425 \begin_inset Flex Code
11428 \begin_layout Plain Layout
11438 \begin_inset Flex Code
11441 \begin_layout Plain Layout
11447 ] Specifies what sort of output documents using this class will produce.
11450 \begin_layout Description
11451 \begin_inset Flex Code
11454 \begin_layout Plain Layout
11461 \begin_inset Flex Code
11464 \begin_layout Plain Layout
11471 \begin_inset Flex Code
11474 \begin_layout Plain Layout
11480 ] Specifies options,
11481 given in the second string,
11482 for the package named by the first string.
11485 \begin_inset Quotes eld
11489 \begin_inset Flex Code
11492 \begin_layout Plain Layout
11493 PackageOptions natbib square
11499 \begin_inset Quotes erd
11503 \begin_inset Flex Code
11506 \begin_layout Plain Layout
11512 to be loaded with the
11513 \begin_inset Flex Code
11516 \begin_layout Plain Layout
11523 (For \SpecialChar TeX
11525 this causes \SpecialChar LyX
11528 \begin_inset Flex Code
11531 \begin_layout Plain Layout
11534 PassOptionsToPackage{natbib}{square}
11540 \begin_inset Flex Code
11543 \begin_layout Plain Layout
11550 \change_inserted -712698321 1565102364
11554 \begin_layout Description
11556 \change_inserted -712698321 1565102470
11557 \begin_inset Flex Code
11560 \begin_layout Plain Layout
11562 \change_inserted -712698321 1565102365
11571 \begin_inset Flex Code
11574 \begin_layout Plain Layout
11576 \change_inserted -712698321 1565105222
11619 ] The default page size.
11620 This is used by some converters.
11625 \begin_layout Description
11626 \begin_inset Flex Code
11629 \begin_layout Plain Layout
11636 \begin_inset Flex Code
11639 \begin_layout Plain Layout
11649 \begin_inset Flex Code
11652 \begin_layout Plain Layout
11660 \begin_inset Flex Code
11663 \begin_layout Plain Layout
11669 ] The default pagestyle.
11670 Can be changed in the
11671 \begin_inset Flex Noun
11674 \begin_layout Plain Layout
11675 Document\SpecialChar menuseparator
11684 \begin_layout Description
11685 \begin_inset Flex Code
11688 \begin_layout Plain Layout
11694 Sets the preamble for the \SpecialChar LaTeX
11696 Note that this will completely override any prior
11697 \begin_inset Flex Code
11700 \begin_layout Plain Layout
11707 \begin_inset Flex Code
11710 \begin_layout Plain Layout
11718 \begin_inset Flex Code
11721 \begin_layout Plain Layout
11727 if you just want to add material to the preamble.) Must end with
11728 \begin_inset Quotes eld
11732 \begin_inset Flex Code
11735 \begin_layout Plain Layout
11742 \begin_inset Quotes erd
11746 \change_inserted -712698321 1612018500
11750 \begin_layout Description
11752 \change_inserted -712698321 1612018547
11753 \begin_inset Flex Code
11756 \begin_layout Plain Layout
11758 \change_inserted -712698321 1612018506
11767 \begin_inset Flex Code
11770 \begin_layout Plain Layout
11772 \change_inserted -712698321 1612018509
11780 ] Defines the layout of an inset if it does not already exist.
11781 If the layout does exist,
11782 this section is ignored.
11784 \begin_inset Quotes eld
11788 \begin_inset Flex Code
11791 \begin_layout Plain Layout
11793 \change_inserted -712698321 1612018500
11802 \begin_inset Quotes erd
11810 \begin_layout Description
11811 \begin_inset Flex Code
11814 \begin_layout Plain Layout
11821 \begin_inset Flex Code
11824 \begin_layout Plain Layout
11831 \begin_inset Flex Code
11834 \begin_layout Plain Layout
11843 \begin_inset space \thinspace{}
11847 \begin_inset Flex Code
11850 \begin_layout Plain Layout
11856 ] Whether the class already provides the feature
11857 \begin_inset Flex Code
11860 \begin_layout Plain Layout
11867 A feature is in general the name of a package (e.
11868 \begin_inset space \thinspace{}
11872 \begin_inset space \space{}
11876 \begin_inset Flex Code
11879 \begin_layout Plain Layout
11886 \begin_inset Flex Code
11889 \begin_layout Plain Layout
11896 \begin_inset space \thinspace{}
11900 \begin_inset space \space{}
11904 \begin_inset Flex Code
11907 \begin_layout Plain Layout
11914 \begin_inset Flex Code
11917 \begin_layout Plain Layout
11925 \begin_inset CommandInset ref
11927 reference "chap:List-of-functions"
11932 for the list of features.
11935 \begin_layout Description
11936 \begin_inset Flex Code
11939 \begin_layout Plain Layout
11946 \begin_inset Flex Code
11949 \begin_layout Plain Layout
11955 ] Indicates that this layout provides the functionality of the module mentioned,
11956 which should be specified by the filename without the
11957 \begin_inset Flex Code
11960 \begin_layout Plain Layout
11967 This will typically be used if the layout includes the module directly,
11968 rather than using the
11969 \begin_inset Flex Code
11972 \begin_layout Plain Layout
11978 tag to indicate that it ought to be used.
11979 It could also be used in a module that provided an alternate implementation of the same functionality.
11982 \begin_layout Description
11983 \begin_inset Flex Code
11986 \begin_layout Plain Layout
11993 \begin_inset Flex Code
11996 \begin_layout Plain Layout
12002 ] Creates a new paragraph style if it does not already exist.
12003 If the style does exist,
12004 this section is ignored.
12006 \begin_inset Quotes eld
12010 \begin_inset Flex Code
12013 \begin_layout Plain Layout
12020 \begin_inset Quotes erd
12026 \begin_layout Description
12027 \begin_inset Flex Code
12030 \begin_layout Plain Layout
12037 \begin_inset Flex Code
12040 \begin_layout Plain Layout
12046 ] Whether the class requires the feature
12047 \begin_inset Flex Code
12050 \begin_layout Plain Layout
12057 Multiple features must be separated by commas.
12058 Note that you can only request supported features.
12060 \begin_inset CommandInset ref
12062 reference "chap:List-of-functions"
12067 for the list of features.).
12068 If you require a package with specific options,
12069 you can additionally use
12070 \begin_inset Flex Code
12073 \begin_layout Plain Layout
12082 \begin_layout Description
12083 \begin_inset Flex Code
12086 \begin_layout Plain Layout
12093 \begin_inset Flex Code
12096 \begin_layout Plain Layout
12102 ] A string that indicates the width of the right margin on the screen,
12105 \begin_inset Quotes eld
12109 \begin_inset Flex Code
12112 \begin_layout Plain Layout
12119 \begin_inset Quotes erd
12125 \begin_layout Description
12126 \begin_inset Flex Code
12129 \begin_layout Plain Layout
12136 \begin_inset Flex Code
12139 \begin_layout Plain Layout
12145 ] Sets which divisions get numbered.
12147 \begin_inset Newline newline
12151 \begin_inset Flex Code
12154 \begin_layout Plain Layout
12160 counter in \SpecialChar LaTeX
12164 \begin_layout Description
12165 \begin_inset Flex Code
12168 \begin_layout Plain Layout
12175 \begin_inset Flex Code
12178 \begin_layout Plain Layout
12187 \begin_inset space \thinspace{}
12191 \begin_inset Flex Code
12194 \begin_layout Plain Layout
12200 ] Whether the class-default should be printing on one or both sides of the paper.
12201 Can be changed in the
12202 \begin_inset Flex Noun
12205 \begin_layout Plain Layout
12206 Document\SpecialChar menuseparator
12215 \begin_layout Description
12216 \begin_inset Flex Code
12219 \begin_layout Plain Layout
12226 \begin_inset Flex Code
12229 \begin_layout Plain Layout
12235 ] This sequence defines a paragraph style.
12236 If the style does not yet exist,
12239 its parameters are modified.
12241 \begin_inset Quotes eld
12245 \begin_inset Flex Code
12248 \begin_layout Plain Layout
12255 \begin_inset Quotes erd
12259 \begin_inset Newline newline
12263 \begin_inset CommandInset ref
12265 reference "subsec:Paragraph-Styles"
12270 for details on paragraph styles.
12271 \change_inserted -712698321 1553617804
12275 \begin_layout Description
12277 \change_inserted -712698321 1553617862
12278 \begin_inset Flex Code
12281 \begin_layout Plain Layout
12283 \change_inserted -712698321 1553617809
12292 \begin_inset Flex Code
12295 \begin_layout Plain Layout
12297 \change_inserted -712698321 1553617805
12305 ] defines the default table style that is used when inserting a table.
12306 The following styles are available:
12310 \begin_layout Itemize
12312 \change_inserted -712698321 1554308039
12313 \begin_inset Flex Code
12316 \begin_layout Plain Layout
12318 \change_inserted -712698321 1554307928
12319 Formal_with_Footline
12328 \begin_inset Quotes eld
12332 \begin_inset Quotes erd
12335 ) style with horizontal lines only,
12336 using a bold top and bottom line,
12337 the first and last row are additionally separated from the table body with a thin middle line.
12340 \begin_layout Itemize
12342 \change_inserted -712698321 1554308087
12343 \begin_inset Flex Code
12346 \begin_layout Plain Layout
12348 \change_inserted -712698321 1554308042
12349 Formal_without_Footline
12358 but the last row is not separated with a middle line from the body.
12361 \begin_layout Itemize
12363 \change_inserted -712698321 1553618031
12364 \begin_inset Flex Code
12367 \begin_layout Plain Layout
12369 \change_inserted -712698321 1553618006
12378 Simple table lines.
12381 \begin_layout Itemize
12383 \change_inserted -712698321 1553618309
12384 \begin_inset Flex Code
12387 \begin_layout Plain Layout
12389 \change_inserted -712698321 1553618031
12399 \begin_inset Flex Code
12402 \begin_layout Plain Layout
12404 \change_inserted -712698321 1553618043
12413 but with the header
12414 \change_deleted 34634807 1619712593
12416 \change_inserted 34634807 1619712594
12418 \change_inserted -712698321 1553618309
12419 offset with a second horizontal line.
12420 This is also the default style of \SpecialChar LyX
12424 \begin_layout Itemize
12426 \change_inserted -712698321 1553618280
12427 \begin_inset Flex Code
12430 \begin_layout Plain Layout
12432 \change_inserted -712698321 1553618261
12441 Table without lines.
12447 \begin_layout Description
12448 \begin_inset Flex Code
12451 \begin_layout Plain Layout
12458 \begin_inset Flex Code
12461 \begin_layout Plain Layout
12467 ] The name of the command or environment to be used with
12468 \begin_inset Flex Code
12471 \begin_layout Plain Layout
12480 \begin_layout Description
12481 \begin_inset Flex Code
12484 \begin_layout Plain Layout
12491 \begin_inset Flex Code
12494 \begin_layout Plain Layout
12504 \begin_inset Flex Code
12507 \begin_layout Plain Layout
12513 ] Indicates what kind of markup is used to define the title of a document.
12515 \begin_inset Flex Code
12518 \begin_layout Plain Layout
12524 means that the macro with name
12525 \begin_inset Flex Code
12528 \begin_layout Plain Layout
12534 will be inserted after the last layout which has
12535 \begin_inset Quotes eld
12539 \begin_inset Flex Code
12542 \begin_layout Plain Layout
12544 \begin_inset space ~
12553 \begin_inset Quotes erd
12558 \begin_inset Flex Code
12561 \begin_layout Plain Layout
12567 corresponds to the case where all layouts which have
12568 \begin_inset Quotes eld
12572 \begin_inset Flex Code
12575 \begin_layout Plain Layout
12577 \begin_inset space ~
12586 \begin_inset Quotes erd
12589 should be enclosed into the
12590 \begin_inset Flex Code
12593 \begin_layout Plain Layout
12602 \begin_layout Description
12603 \begin_inset Flex Code
12606 \begin_layout Plain Layout
12613 \begin_inset Flex Code
12616 \begin_layout Plain Layout
12622 ] Sets which divisions are included in the table of contents.
12624 \begin_inset Flex Code
12627 \begin_layout Plain Layout
12633 counter in \SpecialChar LaTeX
12637 \begin_layout Subsection
12638 \begin_inset Flex Code
12641 \begin_layout Plain Layout
12648 \begin_inset CommandInset label
12650 name "subsec:ClassOptions"
12657 \begin_layout Standard
12659 \begin_inset Flex Code
12662 \begin_layout Plain Layout
12668 section can contain the following entries:
12671 \begin_layout Description
12672 \begin_inset Flex Code
12675 \begin_layout Plain Layout
12682 \begin_inset Flex Code
12685 \begin_layout Plain Layout
12691 ] The list of available font sizes for the document's main font,
12693 \begin_inset Quotes eld
12697 \begin_inset Flex Code
12700 \begin_layout Plain Layout
12707 \begin_inset Quotes erd
12712 \change_inserted -712698321 1565110196
12713 Any number is possible.
12716 \begin_layout Description
12718 \change_inserted -712698321 1565110259
12719 \begin_inset Flex Code
12722 \begin_layout Plain Layout
12724 \change_inserted -712698321 1565110199
12733 \begin_inset Flex Code
12736 \begin_layout Plain Layout
12738 \change_inserted -712698321 1565110196
12746 ] The format for the font size option.
12749 \begin_inset Flex Code
12752 \begin_layout Plain Layout
12754 \change_inserted -712698321 1565110238
12764 \begin_inset Flex Code
12767 \begin_layout Plain Layout
12769 \change_inserted -712698321 1565110248
12777 is a placeholder for the font size.
12782 \begin_layout Description
12784 \change_deleted 5863208 1594239483
12785 \begin_inset Flex Code
12788 \begin_layout Plain Layout
12794 Used to set the DTD line with XML-based output classes.
12796 \begin_inset space \thinspace{}
12801 \begin_inset Quotes eld
12804 -//OASIS//DTD DocBook V4.2//EN
12805 \begin_inset Quotes erd
12809 \change_inserted -712698321 1565101761
12813 \begin_layout Description
12815 \change_inserted -712698321 1565180598
12816 \begin_inset Flex Code
12819 \begin_layout Plain Layout
12821 \change_inserted -712698321 1565101918
12830 \begin_inset Flex Code
12833 \begin_layout Plain Layout
12835 \change_inserted -712698321 1565105399
12836 string="letter|\SpecialChar allowbreak
12837 legal|\SpecialChar allowbreak
12838 executive|\SpecialChar allowbreak
12839 a0|\SpecialChar allowbreak
12840 a1|\SpecialChar allowbreak
12841 a2|\SpecialChar allowbreak
12842 a3|\SpecialChar allowbreak
12843 a4|\SpecialChar allowbreak
12844 a5|\SpecialChar allowbreak
12845 a6|\SpecialChar allowbreak
12846 b0|\SpecialChar allowbreak
12847 b1|\SpecialChar allowbreak
12848 b2|\SpecialChar allowbreak
12849 b3|\SpecialChar allowbreak
12850 b4|\SpecialChar allowbreak
12851 b5|\SpecialChar allowbreak
12852 b6|\SpecialChar allowbreak
12853 c0|\SpecialChar allowbreak
12854 c1|\SpecialChar allowbreak
12855 c2|\SpecialChar allowbreak
12856 c3|\SpecialChar allowbreak
12857 c4|\SpecialChar allowbreak
12858 c5|\SpecialChar allowbreak
12859 c6|\SpecialChar allowbreak
12860 b0j|\SpecialChar allowbreak
12861 b1j|\SpecialChar allowbreak
12862 b2j|\SpecialChar allowbreak
12863 b3j|\SpecialChar allowbreak
12864 b4j|\SpecialChar allowbreak
12865 b5j|\SpecialChar allowbreak
12873 ] The list of available page sizes,
12875 \begin_inset Quotes eld
12879 \begin_inset Flex Code
12882 \begin_layout Plain Layout
12884 \change_inserted -712698321 1565101779
12893 \begin_inset Quotes erd
12898 only the listed sizes are supported.
12899 Other sizes might be entered as custom class option.
12902 \begin_layout Description
12904 \change_inserted -712698321 1565180623
12905 \begin_inset Flex Code
12908 \begin_layout Plain Layout
12910 \change_inserted -712698321 1565180605
12919 \begin_inset Flex Code
12922 \begin_layout Plain Layout
12924 \change_inserted -712698321 1565180601
12932 ] The format for the page size option.
12935 \begin_inset Flex Code
12938 \begin_layout Plain Layout
12940 \change_inserted -712698321 1565180618
12950 \begin_inset Flex Code
12953 \begin_layout Plain Layout
12955 \change_inserted -712698321 1565180601
12963 is a placeholder for the paper size.
12968 \begin_layout Description
12969 \begin_inset Flex Code
12972 \begin_layout Plain Layout
12979 \begin_inset Flex Code
12982 \begin_layout Plain Layout
12983 string="empty|plain|headings|fancy"
12988 ] The list of available page sty\SpecialChar softhyphen
12991 \begin_inset Quotes eld
12995 \begin_inset Flex Code
12998 \begin_layout Plain Layout
13005 \begin_inset Quotes erd
13011 \begin_layout Description
13012 \begin_inset Flex Code
13015 \begin_layout Plain Layout
13022 \begin_inset Flex Code
13025 \begin_layout Plain Layout
13031 ] Some document class options,
13032 separated by a comma,
13033 that will be added to the optional part of the
13034 \begin_inset Flex Code
13037 \begin_layout Plain Layout
13048 \begin_layout Standard
13050 \begin_inset Flex Code
13053 \begin_layout Plain Layout
13059 section must end with
13060 \begin_inset Quotes eld
13064 \begin_inset Flex Code
13067 \begin_layout Plain Layout
13074 \begin_inset Quotes erd
13080 \begin_layout Subsection
13082 \begin_inset CommandInset label
13084 name "subsec:Paragraph-Styles"
13091 \begin_layout Standard
13092 A paragraph style description looks like this:
13096 \begin_layout Plain Layout
13097 Note that this will either define a new style or modify an existing one.
13105 \begin_layout LyX-Code
13112 \begin_layout LyX-Code
13116 \begin_layout LyX-Code
13120 \begin_layout Standard
13121 where the following commands are allowed:
13124 \begin_layout Description
13125 \begin_inset Flex Code
13128 \begin_layout Plain Layout
13135 \begin_inset Flex Code
13138 \begin_layout Plain Layout
13144 =""] This paragraph will appear in the table of contents of the given type.
13145 An empty string disables.
13146 See also the OutlinerName and the IsTocCaption commands.
13151 \begin_layout Description
13152 \begin_inset Flex Code
13155 \begin_layout Plain Layout
13162 \begin_inset Flex Code
13165 \begin_layout Plain Layout
13178 ] Paragraph alignment.
13181 \begin_layout Description
13182 \begin_inset Flex Code
13185 \begin_layout Plain Layout
13192 \begin_inset Flex Code
13195 \begin_layout Plain Layout
13208 ] A comma separated list of permitted alignments.
13209 (Some \SpecialChar LaTeX
13210 styles prohibit certain alignments,
13211 since those wouldn't make sense.
13212 For example a right-aligned or centered enumeration isn't possible.)
13215 \begin_layout Description
13216 \begin_inset Flex Code
13219 \begin_layout Plain Layout
13226 \begin_inset Flex Code
13229 \begin_layout Plain Layout
13235 ] Defines argument number <int> of a command\SpecialChar breakableslash
13236 environment associated with the current style.
13238 \change_inserted -584632292 1615846868
13239 The definition must end with
13240 \begin_inset Flex Code
13243 \begin_layout Plain Layout
13245 \change_inserted -584632292 1615846867
13257 \change_inserted -584632292 1615846880
13259 \begin_inset CommandInset ref
13261 reference "subsec:Arguments"
13269 for more information.
13271 \change_deleted -584632292 1615846694
13272 This is useful for things like section headings,
13273 and only makes sense with \SpecialChar LaTeX
13275 Every (optional or required) argument of a command or environment – except for the required argument that is associated with the content of the paragraph itself – has a separate definition,
13276 where the number specifies the order of the arguments.
13277 The definition must end with
13278 \begin_inset Flex Code
13281 \begin_layout Plain Layout
13288 So a command with two optional arguments has:
13292 \begin_layout Quote
13294 \change_deleted -584632292 1615846694
13300 \begin_layout Quote
13302 \change_deleted -584632292 1615846694
13308 \begin_layout Quote
13310 \change_deleted -584632292 1615846694
13316 \begin_layout Quote
13318 \change_deleted -584632292 1615846694
13324 \begin_layout Quote
13326 \change_deleted -584632292 1615846694
13332 \begin_layout Quote
13334 \change_deleted -584632292 1615846694
13340 \begin_layout Standard
13342 \change_deleted -584632292 1615846694
13344 \begin_inset Flex Code
13347 \begin_layout Plain Layout
13354 the following specifications are possible:
13357 \begin_layout Itemize
13359 \change_deleted -584632292 1615846694
13360 \begin_inset Flex Code
13363 \begin_layout Plain Layout
13370 \begin_inset Flex Code
13373 \begin_layout Plain Layout
13379 The string that will appear both in the menu (to insert this argument) and on the argument inset button (unless you also specify a separate
13380 \begin_inset Flex Code
13383 \begin_layout Plain Layout
13391 you can define an accelerator by appending the respective character to the string,
13393 \begin_inset Quotes eld
13397 \begin_inset Quotes erd
13401 \begin_inset space \thinspace{}
13405 \begin_inset space \space{}
13409 \begin_inset Quotes eld
13413 \begin_inset Flex Code
13416 \begin_layout Plain Layout
13423 \begin_inset Quotes erd
13429 \begin_layout Itemize
13431 \change_deleted -584632292 1615846694
13432 \begin_inset Flex Code
13435 \begin_layout Plain Layout
13442 \begin_inset Flex Code
13445 \begin_layout Plain Layout
13451 A separate string for the menu.
13452 You can define an accelerator by appending the respective character to the string,
13454 \begin_inset Quotes eld
13458 \begin_inset Quotes erd
13462 \begin_inset space \thinspace{}
13466 \begin_inset space \space{}
13470 \begin_inset Quotes eld
13474 \begin_inset Flex Code
13477 \begin_layout Plain Layout
13484 \begin_inset Quotes erd
13488 This specification is optional.
13489 If it is not given the
13490 \begin_inset Flex Code
13493 \begin_layout Plain Layout
13499 will be used instead for the menu.
13502 \begin_layout Itemize
13504 \change_deleted -584632292 1615846694
13505 \begin_inset Flex Code
13508 \begin_layout Plain Layout
13515 \begin_inset Flex Code
13518 \begin_layout Plain Layout
13524 A longer explanatory text that appears in the tooltip when hovering over the argument inset.
13527 \begin_layout Itemize
13529 \change_deleted -584632292 1615846694
13530 \begin_inset Flex Code
13533 \begin_layout Plain Layout
13540 \begin_inset Flex Code
13543 \begin_layout Plain Layout
13552 \begin_inset space \thinspace{}
13556 \begin_inset Flex Code
13559 \begin_layout Plain Layout
13565 ] Declare if this is a mandatory (1) or an optional (0) argument.
13566 Mandatory arguments will be output empty if not given,
13567 while optional arguments will not be output at all.
13569 mandatory arguments are delimited by
13570 \begin_inset Flex Code
13573 \begin_layout Plain Layout
13580 while optional arguments are delimited by
13581 \begin_inset Flex Code
13584 \begin_layout Plain Layout
13593 \begin_layout Itemize
13595 \change_deleted -584632292 1615846694
13596 \begin_inset Flex Code
13599 \begin_layout Plain Layout
13601 \change_inserted -712698321 1555579780
13610 \begin_inset Flex Code
13613 \begin_layout Plain Layout
13615 \change_inserted -712698321 1555579780
13623 Option to define a different command (from the default
13624 \begin_inset Flex Code
13627 \begin_layout Plain Layout
13629 \change_inserted -712698321 1555579780
13641 ) to be used for line breaks.
13642 The initial backslash must not be specified.
13645 \begin_layout Itemize
13647 \change_deleted -584632292 1615846694
13648 \begin_inset Flex Code
13651 \begin_layout Plain Layout
13658 \begin_inset Flex Code
13661 \begin_layout Plain Layout
13667 defines another argument (by its number) which this argument requires to be output if it is itself output.
13669 \begin_inset space \thinspace{}
13673 in \SpecialChar LaTeX
13675 optional arguments often require previous optional arguments to be output (at least empty),
13677 \begin_inset Flex Code
13680 \begin_layout Plain Layout
13683 command[][argument]{text}
13689 This can be achieved by the statement
13690 \begin_inset Flex Code
13693 \begin_layout Plain Layout
13700 \begin_inset Flex Code
13703 \begin_layout Plain Layout
13712 \begin_layout Itemize
13714 \change_deleted -584632292 1615846694
13715 \begin_inset Flex Code
13718 \begin_layout Plain Layout
13725 \begin_inset Flex Code
13728 \begin_layout Plain Layout
13734 defines a custom left delimiter (instead of
13735 \begin_inset Flex Code
13738 \begin_layout Plain Layout
13745 \begin_inset Flex Code
13748 \begin_layout Plain Layout
13755 A line break in the output can be indicated by
13756 \begin_inset Flex Code
13759 \begin_layout Plain Layout
13768 \begin_layout Itemize
13770 \change_deleted -584632292 1615846694
13771 \begin_inset Flex Code
13774 \begin_layout Plain Layout
13781 \begin_inset Flex Code
13784 \begin_layout Plain Layout
13790 defines a custom right delimiter (instead of
13791 \begin_inset Flex Code
13794 \begin_layout Plain Layout
13801 \begin_inset Flex Code
13804 \begin_layout Plain Layout
13811 A line break in the output can be indicated by
13812 \begin_inset Flex Code
13815 \begin_layout Plain Layout
13824 \begin_layout Itemize
13826 \change_deleted -584632292 1615846694
13827 \begin_inset Flex Code
13830 \begin_layout Plain Layout
13837 \begin_inset Flex Code
13840 \begin_layout Plain Layout
13846 defines an argument that is inserted if and only if no user-specified arguments were given,
13848 \begin_inset space \thinspace{}
13852 \begin_inset space \space{}
13855 if no argument inset has been inserted (note that also an empty argument inset omits the DefaultArg).
13856 Multiple arguments need to be separated by comma.
13859 \begin_layout Itemize
13861 \change_deleted -584632292 1615846694
13862 \begin_inset Flex Code
13865 \begin_layout Plain Layout
13872 \begin_inset Flex Code
13875 \begin_layout Plain Layout
13881 defines an argument that is inserted in any case (alone or in addition to user-specified arguments).
13882 Multiple arguments need to be separated by comma.
13885 \begin_layout Itemize
13887 \change_deleted -584632292 1615846694
13888 \begin_inset Flex Code
13891 \begin_layout Plain Layout
13897 The font used for the argument content,
13899 \begin_inset CommandInset ref
13901 reference "subsec:Font-description"
13909 \begin_layout Itemize
13911 \change_deleted -584632292 1615846694
13912 \begin_inset Flex Code
13915 \begin_layout Plain Layout
13917 \change_inserted -712698321 1559484228
13926 \begin_inset Flex Code
13929 \begin_layout Plain Layout
13931 \change_inserted -712698321 1559484228
13942 \begin_inset space \thinspace{}
13946 \begin_inset Flex Code
13949 \begin_layout Plain Layout
13951 \change_inserted -712698321 1559484228
13959 ] As with paragraph styles,
13961 \begin_inset CommandInset ref
13963 reference "subsec:Paragraph-Styles"
13971 \begin_layout Itemize
13973 \change_deleted -584632292 1615846694
13974 \begin_inset Flex Code
13977 \begin_layout Plain Layout
13983 The font used for the label;
13985 \begin_inset CommandInset ref
13987 reference "subsec:Font-description"
13995 \begin_layout Itemize
13997 \change_deleted -584632292 1615846694
13998 \begin_inset Flex Code
14001 \begin_layout Plain Layout
14008 \begin_inset Flex Code
14011 \begin_layout Plain Layout
14023 ] describes the rendering style used for the inset's frame and buttons.
14026 \begin_layout Itemize
14028 \change_deleted -584632292 1615846694
14029 \begin_inset Flex Code
14032 \begin_layout Plain Layout
14039 \begin_inset Flex Code
14042 \begin_layout Plain Layout
14049 \begin_inset Flex Code
14052 \begin_layout Plain Layout
14059 this argument is automatically inserted when the respective style is selected.
14061 \change_deleted -712698321 1559484200
14063 only one argument per style\SpecialChar breakableslash
14064 layout can be automatically inserted.
14065 \change_deleted -584632292 1615846694
14069 \begin_layout Itemize
14071 \change_deleted -584632292 1615846694
14072 \begin_inset Flex Code
14075 \begin_layout Plain Layout
14077 \change_inserted -712698321 1559490711
14086 \begin_inset Flex Code
14089 \begin_layout Plain Layout
14091 \change_inserted -712698321 1559490703
14100 \begin_inset Flex Code
14103 \begin_layout Plain Layout
14105 \change_inserted -712698321 1559490703
14114 this argument will be inserted on a new line with
14115 \begin_inset Flex Code
14118 \begin_layout Plain Layout
14120 \change_inserted -712698321 1559491402
14128 (only available within Flex insets).
14131 \begin_layout Itemize
14133 \change_deleted -584632292 1615846694
14134 \begin_inset Flex Code
14137 \begin_layout Plain Layout
14144 \begin_inset Flex Code
14147 \begin_layout Plain Layout
14154 \begin_inset Flex Code
14157 \begin_layout Plain Layout
14164 this argument will be inserted with a copy of the co-text (either selected text or the whole paragraph) as content.
14167 \begin_layout Itemize
14169 \change_deleted -584632292 1615846694
14170 \begin_inset Flex Code
14173 \begin_layout Plain Layout
14180 \begin_inset Flex Code
14183 \begin_layout Plain Layout
14195 ] Whether the contents of this argument should be output in raw form,
14196 meaning without special translations that \SpecialChar LaTeX
14200 \begin_inset Flex Code
14203 \begin_layout Plain Layout
14209 status is inherited by the inset or paragraph layout the argument belongs to,
14210 true and false change the status for the given argument only.
14213 \begin_layout Itemize
14215 \change_deleted -584632292 1615846694
14216 \begin_inset Flex Code
14219 \begin_layout Plain Layout
14226 \begin_inset Flex Code
14229 \begin_layout Plain Layout
14230 string of characters
14239 Defines individual characters
14240 \begin_inset Newline linebreak
14243 that should be output in raw form,
14244 meaning without special translations that \SpecialChar LaTeX
14247 contrary to PassThru,
14248 this needs to be explicitly defined for arguments.
14250 arguments do not inherit PassThruChars from their parent inset or layout.
14253 \begin_layout Itemize
14255 \change_deleted -584632292 1615846694
14256 \begin_inset Flex Code
14259 \begin_layout Plain Layout
14266 \begin_inset Flex Code
14269 \begin_layout Plain Layout
14278 \begin_inset space \thinspace{}
14282 \begin_inset Flex Code
14285 \begin_layout Plain Layout
14291 ] If this is set to 1,
14292 the argument will output its content in the corresponding item in the table of contents.
14296 \begin_layout Standard
14298 \change_deleted -584632292 1615846694
14300 the text entered in the \SpecialChar LyX
14301 workarea in the respective layout is the last (mandatory) argument of a command if the
14302 \begin_inset Flex Code
14305 \begin_layout Plain Layout
14312 \begin_inset Flex Code
14315 \begin_layout Plain Layout
14323 arguments with the prefix
14324 \begin_inset Flex Code
14327 \begin_layout Plain Layout
14333 are output after this workarea argument.
14334 Note that post-argument numbering restarts at 1,
14335 so the first argument following the workarea argument is
14336 \begin_inset Flex Code
14339 \begin_layout Plain Layout
14346 Post-arguments are ignored in any other
14347 \begin_inset Flex Code
14350 \begin_layout Plain Layout
14357 \begin_inset Flex Code
14360 \begin_layout Plain Layout
14369 \begin_layout Standard
14371 \change_deleted -584632292 1615846694
14373 \begin_inset Flex Code
14376 \begin_layout Plain Layout
14385 \begin_inset Flex Code
14388 \begin_layout Plain Layout
14397 \begin_inset Flex Code
14400 \begin_layout Plain Layout
14406 followed by the number (e.
14407 \begin_inset space \thinspace{}
14411 \begin_inset space \space{}
14415 \begin_inset Flex Code
14418 \begin_layout Plain Layout
14427 \begin_layout Standard
14429 \change_deleted -584632292 1615846694
14431 there is a special argument type with the prefix
14432 \begin_inset Flex Code
14435 \begin_layout Plain Layout
14437 \change_inserted -712698321 1534487844
14446 It is not really an argument,
14447 but uses the argument interface (thus,
14448 the prefix is also followed by a number,
14450 \begin_inset space \thinspace{}
14455 \begin_inset Flex Code
14458 \begin_layout Plain Layout
14460 \change_inserted -712698321 1534488412
14461 Argument listpreamble:1
14469 As the name implies,
14470 it is targeted at lists such as
14490 Its content will be output at the list start,
14492 \begin_inset Flex Code
14495 \begin_layout Plain Layout
14497 \change_inserted -712698321 1534488058
14508 on an own line (a place that is otherwise not accessible in \SpecialChar LyX
14511 users can insert redefinitions (of lengths etc.) to individual lists.
14513 these arguments do not have a delimiter.
14519 \begin_layout Description
14520 \begin_inset Flex Code
14523 \begin_layout Plain Layout
14529 Includes a comma-separated list of layouts that should be nested in and after the current layout.
14530 Only makes sense for nestable layouts (such as environments).
14532 \begin_inset Quotes eld
14536 \begin_inset Flex Code
14539 \begin_layout Plain Layout
14546 \begin_inset Quotes erd
14551 \begin_inset Flex Code
14554 \begin_layout Plain Layout
14563 \begin_layout Description
14564 \begin_inset Flex Code
14567 \begin_layout Plain Layout
14573 Note that this will completely override any prior
14574 \begin_inset Flex Code
14577 \begin_layout Plain Layout
14583 declaration for this style.
14585 \begin_inset Quotes eld
14589 \begin_inset Flex Code
14592 \begin_layout Plain Layout
14599 \begin_inset Quotes erd
14604 \begin_inset CommandInset ref
14606 reference "subsec:I18n"
14611 for details on its use.
14614 \begin_layout Description
14615 \begin_inset Flex Code
14618 \begin_layout Plain Layout
14625 \begin_inset Flex Code
14628 \begin_layout Plain Layout
14638 \begin_layout Plain Layout
14639 Note that a `float' here is a real number,
14646 The vertical space with which the last of a chain of paragraphs with this style is separated from the following paragraph.
14647 If the next paragraph has another style,
14648 the separations are not simply added,
14649 but the maximum is taken.
14652 \begin_layout Description
14653 \begin_inset Flex Code
14656 \begin_layout Plain Layout
14663 \begin_inset Flex Code
14666 \begin_layout Plain Layout
14672 ] The category for this style.
14673 This is used to group related styles in the style combobox on the toolbar.
14674 Any string can be used,
14675 but you may want to use existing categories with your own styles.
14679 \begin_layout Description
14681 \change_deleted 1075283030 1672014981
14682 \begin_inset Flex Code
14685 \begin_layout Plain Layout
14691 Depth of XML command.
14692 Used only with XML-type formats.
14695 \begin_layout Description
14696 \begin_inset Flex Code
14699 \begin_layout Plain Layout
14706 \begin_inset Flex Code
14709 \begin_layout Plain Layout
14715 ] Copies all the features of an existing style into the current one.
14717 \change_inserted -584632292 1678808972
14718 Note that this copies the style as it is defined at that point.
14719 Later changes to it will not affect styles into which it has been copied.
14724 \begin_layout Description
14726 \change_inserted 1075283030 1672014806
14727 \begin_inset Flex Code
14730 \begin_layout Plain Layout
14732 \change_inserted 1075283030 1671679781
14733 DocBookGenerateTitle
14741 \begin_inset Flex Code
14744 \begin_layout Plain Layout
14746 \change_inserted 1075283030 1672014763
14755 \begin_inset Flex Code
14758 \begin_layout Plain Layout
14760 \change_inserted 1075283030 1672014789
14768 tag after the wrapper tag.
14769 This parameter should only be used with
14770 \begin_inset Flex Code
14773 \begin_layout Plain Layout
14775 \change_inserted 1075283030 1671679828
14784 otherwise the title will be output
14788 the contents of the environment.
14789 The generated title is the same as the LyXHTML label:
14790 a combination of the environment type and its number.
14791 A major use is when DocBook has no close mapping for LaTeX environments and users must fallback to using a generic container such as
14792 \begin_inset Flex Code
14795 \begin_layout Plain Layout
14797 \change_inserted 1075283030 1672014801
14806 which requires a title although there is none in LaTeX.
14807 This feature is heavily used for theorem-like environments.
14812 \begin_layout Description
14813 \begin_inset Flex Code
14816 \begin_layout Plain Layout
14823 \begin_inset Flex Code
14826 \begin_layout Plain Layout
14832 ] The name of a style whose preamble should be output
14837 This allows to ensure some ordering of the preamble snippets when macros definitions depend on one another.
14841 \begin_layout Plain Layout
14843 besides that functionality,
14844 there is no way to ensure any ordering of preambles.
14845 The ordering that you see in a given version of \SpecialChar LyX
14846 may change without warning in later versions.
14854 \begin_layout Description
14855 \begin_inset Flex Code
14858 \begin_layout Plain Layout
14865 \begin_inset Flex Code
14868 \begin_layout Plain Layout
14881 ] The type of label that stands at the end of the paragraph (or sequence of paragraphs if
14882 \begin_inset Flex Code
14885 \begin_layout Plain Layout
14892 \begin_inset Newline newline
14896 \begin_inset Flex Code
14899 \begin_layout Plain Layout
14907 \begin_inset Flex Code
14910 \begin_layout Plain Layout
14917 \begin_inset Flex Code
14920 \begin_layout Plain Layout
14928 \begin_inset Flex Code
14931 \begin_layout Plain Layout
14938 \begin_inset Quotes eld
14942 \begin_inset Quotes erd
14947 \begin_inset Flex Code
14950 \begin_layout Plain Layout
14957 \begin_inset space \space{}
14961 \begin_inset Flex Code
14964 \begin_layout Plain Layout
14970 ) is a white (resp.
14971 \begin_inset space ~
14974 black) square suitable for end of proof markers,
14976 \begin_inset Flex Code
14979 \begin_layout Plain Layout
14985 is an explicit text string.
14988 \begin_layout Description
14989 \begin_inset Flex Code
14992 \begin_layout Plain Layout
14999 \begin_inset Flex Code
15002 \begin_layout Plain Layout
15008 ] The string used for a label with a
15009 \begin_inset Flex Code
15012 \begin_layout Plain Layout
15019 \begin_inset Newline newline
15023 \begin_inset Flex Code
15026 \begin_layout Plain Layout
15036 \begin_layout Description
15037 \begin_inset Flex Code
15040 \begin_layout Plain Layout
15046 The font used for both the text body
15052 \begin_inset CommandInset ref
15054 reference "subsec:Font-description"
15060 Note that defining this font automatically defines the
15061 \begin_inset Flex Code
15064 \begin_layout Plain Layout
15071 So you should define this one first if you also want to define
15072 \begin_inset Flex Code
15075 \begin_layout Plain Layout
15084 \begin_layout Description
15085 \begin_inset Flex Code
15088 \begin_layout Plain Layout
15095 \begin_inset Flex Code
15098 \begin_layout Plain Layout
15104 ] Used for backporting new styles to stable \SpecialChar LyX
15106 The first stable version that supports this tag is \SpecialChar LyX
15108 The argument is a number which may either be 0,
15109 -1 or any value greater than zero.
15111 \begin_inset Flex Code
15114 \begin_layout Plain Layout
15120 flag of a style is greater than zero,
15121 it will always be written to the document header.
15122 If a .lyx file is read,
15123 the style definitions from the document header are added to the document class.
15124 Therefore even older \SpecialChar LyX
15125 versions can handle the style.
15127 \begin_inset Flex Code
15130 \begin_layout Plain Layout
15136 is a version number:
15137 if the style is read,
15138 and the version number is less than the version number of the already existing style in the document class,
15139 the new style is ignored.
15140 If the version number is greater,
15141 the new style replaces the existing style.
15142 A value of -1 means an infinite version number,
15144 \begin_inset space \thinspace{}
15148 \begin_inset space \space{}
15151 the style is always used.
15154 \begin_layout Description
15155 \begin_inset Flex Code
15158 \begin_layout Plain Layout
15165 \begin_inset Flex Code
15168 \begin_layout Plain Layout
15177 \begin_inset space \thinspace{}
15181 \begin_inset Flex Code
15184 \begin_layout Plain Layout
15190 ] Usually \SpecialChar LyX
15191 does not allow you to insert more than one space between words,
15192 since a space is considered as the separation between two words,
15193 not a character or symbol of its own.
15194 This is a very fine thing but sometimes annoying,
15196 when typing program code or plain \SpecialChar LaTeX
15200 \begin_inset Flex Code
15203 \begin_layout Plain Layout
15211 \change_deleted -495245474 1550490105
15216 \change_deleted 177693 1654669077
15218 \change_inserted 177693 1654669079
15222 \change_deleted 177693 1654669082
15224 \change_inserted 177693 1654669082
15227 for the additional blanks when
15228 \change_deleted 34634807 1619626461
15232 \change_inserted -495245474 1550490096
15234 \begin_inset Flex Code
15237 \begin_layout Plain Layout
15239 \change_inserted -495245474 1550490089
15248 \change_deleted -495245474 1550490116
15249 another mode than \SpecialChar LaTeX
15252 \change_inserted -495245474 1550247760
15254 \begin_inset Flex Code
15257 \begin_layout Plain Layout
15259 \change_inserted -495245474 1550247736
15268 \begin_inset Flex Code
15271 \begin_layout Plain Layout
15273 \change_inserted -495245474 1550247755
15286 \begin_layout Description
15287 \begin_inset Flex Code
15290 \begin_layout Plain Layout
15296 These tags are used with XHTML output.
15298 \begin_inset CommandInset ref
15300 reference "subsec:Paragraph-Style-XHTML"
15308 \begin_layout Description
15310 \change_deleted 1075283030 1672014684
15311 \begin_inset Flex Code
15314 \begin_layout Plain Layout
15320 [FIXME] (Used only with XML-type formats.)
15325 \begin_layout Description
15326 \begin_inset Flex Code
15329 \begin_layout Plain Layout
15336 \begin_inset Flex Code
15339 \begin_layout Plain Layout
15348 \begin_inset space \thinspace{}
15352 \begin_inset Flex Code
15355 \begin_layout Plain Layout
15362 \begin_inset Flex Code
15365 \begin_layout Plain Layout
15372 marks the style as to be included in the document preamble and not in the document body.
15373 This is useful for document classes that want such information as the title and author to appear in the preamble.
15374 Note that this works only for styles for which the
15375 \begin_inset Flex Code
15378 \begin_layout Plain Layout
15385 \begin_inset Flex Code
15388 \begin_layout Plain Layout
15395 \begin_inset Flex Code
15398 \begin_layout Plain Layout
15407 \begin_layout Description
15408 \begin_inset Flex Code
15411 \begin_layout Plain Layout
15418 \begin_inset Flex Code
15421 \begin_layout Plain Layout
15430 \begin_inset space \thinspace{}
15434 \begin_inset Flex Code
15437 \begin_layout Plain Layout
15444 \begin_inset Flex Code
15447 \begin_layout Plain Layout
15454 marks the style as being part of a title block (see also the
15455 \begin_inset Flex Code
15458 \begin_layout Plain Layout
15465 \begin_inset Flex Code
15468 \begin_layout Plain Layout
15477 \begin_layout Description
15478 \begin_inset Flex Code
15481 \begin_layout Plain Layout
15487 Includes a comma-separated list of layouts after which this one should be nested.
15488 Only makes sense with regard to nestable layouts (such as environments).
15490 \begin_inset Quotes eld
15494 \begin_inset Flex Code
15497 \begin_layout Plain Layout
15504 \begin_inset Quotes erd
15509 \begin_inset Flex Code
15512 \begin_layout Plain Layout
15521 \begin_layout Description
15522 \begin_inset Flex Code
15525 \begin_layout Plain Layout
15532 \begin_inset Flex Code
15535 \begin_layout Plain Layout
15544 \begin_inset space \thinspace{}
15548 \begin_inset Flex Code
15551 \begin_layout Plain Layout
15557 ] If this is set to 1 and AddToToc is enabled,
15558 the paragraph adds a summary of its contents in its item in the table of contents.
15565 \begin_layout Description
15566 \begin_inset Flex Code
15569 \begin_layout Plain Layout
15576 \begin_inset Flex Code
15579 \begin_layout Plain Layout
15585 ] The \SpecialChar LaTeX
15586 command sequence declaring an item in a list.
15587 The command is to be defined without the preceding backslash (the default is
15588 \begin_inset Quotes eld
15592 \begin_inset Quotes erd
15597 \begin_inset Flex Code
15600 \begin_layout Plain Layout
15608 in the \SpecialChar LaTeX
15612 \begin_layout Description
15613 \begin_inset Flex Code
15616 \begin_layout Plain Layout
15623 \begin_inset Flex Code
15626 \begin_layout Plain Layout
15632 ] This provides extra space between paragraphs that have the same style.
15633 If you put other styles into an environment,
15634 each is separated with the environment's
15635 \begin_inset Flex Code
15638 \begin_layout Plain Layout
15645 But the whole items of the environment are additionally separated with this
15646 \begin_inset Flex Code
15649 \begin_layout Plain Layout
15656 Note that this is a
15661 \begin_layout Description
15663 \change_deleted 1075283030 1672014680
15664 \begin_inset Flex Code
15667 \begin_layout Plain Layout
15673 [FIXME] (Used only with XML-type formats.)
15678 \begin_layout Description
15679 \begin_inset Flex Code
15682 \begin_layout Plain Layout
15689 \begin_inset Flex Code
15692 \begin_layout Plain Layout
15701 \begin_inset space \thinspace{}
15705 \begin_inset Flex Code
15708 \begin_layout Plain Layout
15714 ] Usually \SpecialChar LyX
15715 does not allow you to leave a paragraph empty,
15716 since it would lead to empty \SpecialChar LaTeX
15718 There are some cases where this could be desirable however:
15719 in a letter template,
15720 the required fields can be provided as empty fields,
15721 so that people do not forget them;
15722 in some special classes,
15723 a style can be used as some kind of break,
15724 which does not contain actual text.
15727 \begin_layout Description
15728 \begin_inset Flex Code
15731 \begin_layout Plain Layout
15738 \begin_inset Flex Code
15741 \begin_layout Plain Layout
15747 ] The vertical space between the label and the text body.
15748 Only used for labels that are above the text body (
15749 \begin_inset Flex Code
15752 \begin_layout Plain Layout
15759 \begin_inset Newline newline
15763 \begin_inset Flex Code
15766 \begin_layout Plain Layout
15767 Centered_Top_Environment
15775 \begin_layout Description
15776 \begin_inset Flex Code
15779 \begin_layout Plain Layout
15786 \begin_inset Flex Code
15789 \begin_layout Plain Layout
15795 ] The name of the counter for automatic numbering.
15796 In order to have the counter appear with your label,
15797 you will need to reference it in the
15798 \begin_inset Flex Code
15801 \begin_layout Plain Layout
15810 This will work with
15811 \begin_inset Flex Code
15814 \begin_layout Plain Layout
15822 \begin_inset Flex Code
15825 \begin_layout Plain Layout
15833 \begin_inset Flex Code
15836 \begin_layout Plain Layout
15843 \begin_inset Flex Code
15846 \begin_layout Plain Layout
15854 \begin_inset Newline newline
15862 \begin_inset Flex Code
15865 \begin_layout Plain Layout
15872 \begin_inset Flex Code
15875 \begin_layout Plain Layout
15882 though this case is a bit complicated.
15883 Suppose you declare
15884 \begin_inset Quotes eld
15888 \begin_inset Flex Code
15891 \begin_layout Plain Layout
15892 LabelCounter myenum
15898 \begin_inset Quotes erd
15902 Then the actual counters used are
15903 \begin_inset Flex Code
15906 \begin_layout Plain Layout
15914 \begin_inset Flex Code
15917 \begin_layout Plain Layout
15925 \begin_inset Flex Code
15928 \begin_layout Plain Layout
15935 \begin_inset Flex Code
15938 \begin_layout Plain Layout
15945 much as in \SpecialChar LaTeX
15947 These counters must all be declared separately.
15948 \begin_inset Newline newline
15952 \begin_inset CommandInset ref
15954 reference "subsec:Counters"
15959 for details on counters.
15962 \begin_layout Description
15963 \begin_inset Flex Code
15966 \begin_layout Plain Layout
15972 The font used for the label.
15974 \begin_inset CommandInset ref
15976 reference "subsec:Font-description"
15984 \begin_layout Description
15985 \begin_inset Flex Code
15988 \begin_layout Plain Layout
15995 \begin_inset Flex Code
15998 \begin_layout Plain Layout
16004 ] Text that indicates how far a label should be indented.
16007 \begin_layout Description
16008 \begin_inset Flex Code
16011 \begin_layout Plain Layout
16018 \begin_inset Flex Code
16021 \begin_layout Plain Layout
16027 ] Text that indicates the amount of horizontal space between the label and the text body.
16028 Only used for labels that are not above the text body.
16031 \begin_layout Description
16032 \begin_inset Flex Code
16035 \begin_layout Plain Layout
16042 \begin_inset Flex Code
16045 \begin_layout Plain Layout
16051 ] The string used for the label.
16053 \begin_inset Flex Code
16056 \begin_layout Plain Layout
16063 this string can be contain the special formatting commands described in
16064 \begin_inset CommandInset ref
16066 reference "subsec:Counters"
16074 \begin_layout Description
16075 \begin_inset Flex Code
16078 \begin_layout Plain Layout
16079 LabelStringAppendix
16085 \begin_inset Flex Code
16088 \begin_layout Plain Layout
16094 ] This is used inside the appendix instead of
16095 \begin_inset Newline newline
16099 \begin_inset Flex Code
16102 \begin_layout Plain Layout
16110 \begin_inset Flex Code
16113 \begin_layout Plain Layout
16120 \begin_inset Newline newline
16124 \begin_inset Flex Code
16127 \begin_layout Plain Layout
16128 LabelStringAppendix
16134 \change_deleted 1075283030 1672015070
16138 \begin_layout Description
16140 \change_deleted 1075283030 1672015070
16141 \begin_inset Flex Code
16144 \begin_layout Plain Layout
16150 [FIXME] (Used only with XML-type formats.)
16155 \begin_layout Description
16156 \begin_inset Flex Code
16159 \begin_layout Plain Layout
16166 \begin_inset Flex Code
16169 \begin_layout Plain Layout
16179 \begin_inset Newline newline
16185 \begin_inset Newline newline
16198 \begin_layout Description
16199 \begin_inset Flex Code
16202 \begin_layout Plain Layout
16208 means the label is the very first word (up to the first real blank).
16210 \change_deleted 177693 1654669087
16212 \change_inserted 177693 1654669089
16215 spaces if you want more than one word as the label.
16219 \begin_layout Description
16220 \begin_inset Flex Code
16223 \begin_layout Plain Layout
16229 means the label is simply what is declared as
16230 \begin_inset Flex Code
16233 \begin_layout Plain Layout
16240 This will be displayed
16241 \begin_inset Quotes eld
16245 \begin_inset Quotes erd
16249 at the beginning of the paragraph.
16251 \begin_inset Flex Code
16254 \begin_layout Plain Layout
16261 \begin_inset Flex Code
16264 \begin_layout Plain Layout
16271 then it will be displayed only in the first paragraph of any sequence of paragraphs with the same
16272 \begin_inset Flex Code
16275 \begin_layout Plain Layout
16284 \begin_layout Description
16285 \begin_inset Flex Code
16288 \begin_layout Plain Layout
16295 \begin_inset space ~
16299 \begin_inset space ~
16303 \begin_inset Flex Code
16306 \begin_layout Plain Layout
16312 are special cases of
16313 \begin_inset Flex Code
16316 \begin_layout Plain Layout
16323 The label will be printed above the paragraph either at the beginning of the line or centered.
16326 \begin_layout Description
16327 \begin_inset Flex Code
16330 \begin_layout Plain Layout
16336 is a special case for the caption-labels
16337 \begin_inset Quotes eld
16341 \begin_inset Quotes erd
16345 \begin_inset Quotes eld
16349 \begin_inset Quotes erd
16353 \begin_inset Newline newline
16357 \begin_inset Flex Code
16360 \begin_layout Plain Layout
16366 means the (hardcoded) label string depends on the kind of float:
16367 It is hardcoded to be `FloatType N',
16368 where N is the value of the counter associated with the float.
16369 For the case that a caption is inserted outside of a float the
16370 \begin_inset Flex Code
16373 \begin_layout Plain Layout
16380 \begin_inset Quotes eld
16384 \begin_inset Quotes erd
16390 \begin_layout Description
16391 \begin_inset Flex Code
16394 \begin_layout Plain Layout
16400 produces the usual sort of enumeration labels.
16401 The number type needs to be set in the
16407 \begin_inset CommandInset ref
16409 reference "subsec:Counters"
16417 \begin_layout Description
16418 \begin_inset Flex Code
16421 \begin_layout Plain Layout
16427 produces various bullets at the different levels.
16428 The bullet types displayed can be set via
16429 \begin_inset Flex Noun
16432 \begin_layout Plain Layout
16433 Document\SpecialChar menuseparator
16434 Settings\SpecialChar menuseparator
16443 \begin_layout Description
16444 \begin_inset Flex Code
16447 \begin_layout Plain Layout
16453 should be used only with
16454 \begin_inset Flex Code
16457 \begin_layout Plain Layout
16458 LatexType BibEnvironment
16467 \begin_layout Description
16468 \begin_inset Flex Code
16471 \begin_layout Plain Layout
16477 Note that this will completely override any prior
16478 \begin_inset Flex Code
16481 \begin_layout Plain Layout
16487 declaration for this style.
16489 \begin_inset Quotes eld
16493 \begin_inset Flex Code
16496 \begin_layout Plain Layout
16503 \begin_inset Quotes erd
16508 \begin_inset CommandInset ref
16510 reference "subsec:I18n"
16515 for details on its use.
16518 \begin_layout Description
16519 \begin_inset Flex Code
16522 \begin_layout Plain Layout
16529 \begin_inset Flex Code
16532 \begin_layout Plain Layout
16538 ] The name of the corresponding \SpecialChar LaTeX
16540 Either the environment or command name.
16543 \begin_layout Description
16544 \begin_inset Flex Code
16547 \begin_layout Plain Layout
16554 \begin_inset Flex Code
16557 \begin_layout Plain Layout
16563 ] An optional parameter for the corresponding
16564 \begin_inset Flex Code
16567 \begin_layout Plain Layout
16574 This parameter cannot be changed from within \SpecialChar LyX
16576 \begin_inset Flex Code
16579 \begin_layout Plain Layout
16585 for customizable parameters).
16586 This will be output as is after all \SpecialChar LaTeX
16588 \begin_inset Flex Code
16591 \begin_layout Plain Layout
16600 \begin_layout Description
16601 \begin_inset Flex Code
16604 \begin_layout Plain Layout
16611 \begin_inset Flex Code
16614 \begin_layout Plain Layout
16623 \begin_inset Newline newline
16632 ] How the style should be translated into \SpecialChar LaTeX
16637 \begin_layout Plain Layout
16638 \begin_inset Flex Code
16641 \begin_layout Plain Layout
16647 is perhaps a bit misleading,
16648 since these rules apply to SGML classes,
16650 Visit the SGML class files for specific examples.
16659 \begin_layout Description
16660 \begin_inset Flex Code
16663 \begin_layout Plain Layout
16669 means nothing special.
16672 \begin_layout Description
16673 \begin_inset Flex Code
16676 \begin_layout Plain Layout
16683 \begin_inset Flex Code
16686 \begin_layout Plain Layout
16693 {\SpecialChar ldots
16702 \begin_layout Description
16703 \begin_inset Flex Code
16706 \begin_layout Plain Layout
16713 \begin_inset Flex Code
16716 \begin_layout Plain Layout
16723 }\SpecialChar ldots
16739 \begin_layout Description
16740 \begin_inset Flex Code
16743 \begin_layout Plain Layout
16750 \begin_inset Flex Code
16753 \begin_layout Plain Layout
16761 \begin_inset Flex Code
16764 \begin_layout Plain Layout
16772 is generated for each paragraph of this environment.
16776 \begin_layout Description
16777 \begin_inset Flex Code
16780 \begin_layout Plain Layout
16787 \begin_inset Flex Code
16790 \begin_layout Plain Layout
16798 \begin_inset Newline newline
16802 \begin_inset Flex Code
16805 \begin_layout Plain Layout
16811 is passed as an argument to the environment.
16812 \begin_inset Newline newline
16816 \begin_inset Flex Code
16819 \begin_layout Plain Layout
16825 can be defined in the
16826 \begin_inset Flex Noun
16829 \begin_layout Plain Layout
16830 Edit\SpecialChar menuseparator
16832 \begin_inset space ~
16843 \begin_layout Description
16844 \begin_inset Flex Code
16847 \begin_layout Plain Layout
16854 \begin_inset Flex Code
16857 \begin_layout Plain Layout
16863 but adds the necessary mandatory argument (the longest label) to the begin statement of the bibliography environment:
16864 \begin_inset Newline newline
16868 \begin_inset Flex Code
16871 \begin_layout Plain Layout
16874 begin{thebibliography}{99}
16880 It is therefore only useful for bibliography environments.
16881 The default longest label
16882 \begin_inset Quotes eld
16886 \begin_inset Quotes erd
16889 can be changed by the user in the paragraph settings of a bibliography item.
16892 \begin_layout Standard
16893 Putting the last few things together,
16894 the \SpecialChar LaTeX
16895 output will be either:
16899 \begin_layout LyX-Code
16902 LatexName[LatexParam]{\SpecialChar ldots
16906 \begin_layout Standard
16911 \begin_layout LyX-Code
16914 begin{LatexName}[LatexParam] \SpecialChar ldots
16920 \begin_layout Standard
16921 depending upon the \SpecialChar LaTeX
16926 \begin_layout Description
16927 \begin_inset Flex Code
16930 \begin_layout Plain Layout
16937 \begin_inset Flex Code
16940 \begin_layout Plain Layout
16946 ] A string that is put at the beginning of the style content.
16947 A line break in the output can be indicated by
16948 \begin_inset Flex Code
16951 \begin_layout Plain Layout
16960 \begin_layout Description
16961 \begin_inset Flex Code
16964 \begin_layout Plain Layout
16971 \begin_inset Flex Code
16974 \begin_layout Plain Layout
16980 ] If you put styles into environments,
16982 \begin_inset Flex Code
16985 \begin_layout Plain Layout
16991 are not simply added,
16992 but added with a factor
16993 \begin_inset Formula $\frac{4}{\mathrm{depth}+4}$
16997 Note that this parameter is also used when
16998 \begin_inset Flex Code
17001 \begin_layout Plain Layout
17008 \begin_inset Flex Code
17011 \begin_layout Plain Layout
17018 \begin_inset Flex Code
17021 \begin_layout Plain Layout
17028 Then it is added to the manual or dynamic margin.
17029 \begin_inset Newline newline
17033 \begin_inset Quotes eld
17037 \begin_inset Flex Code
17040 \begin_layout Plain Layout
17047 \begin_inset Quotes erd
17050 means that the paragraph is indented with the width of
17051 \begin_inset Quotes eld
17055 \begin_inset Flex Code
17058 \begin_layout Plain Layout
17065 \begin_inset Quotes erd
17068 in the normal font.
17069 You can get a negative width by prefixing the string with
17070 \begin_inset Quotes eld
17074 \begin_inset Flex Code
17077 \begin_layout Plain Layout
17084 \begin_inset Quotes erd
17088 This way was chosen so that the look is the same with each used screen font.
17091 \begin_layout Description
17092 \begin_inset Flex Code
17095 \begin_layout Plain Layout
17102 \begin_inset Flex Code
17105 \begin_layout Plain Layout
17120 \begin_inset Newline newline
17123 The kind of margin that the style has on the left side.
17127 \begin_layout Description
17128 \begin_inset Flex Code
17131 \begin_layout Plain Layout
17137 just means a fixed margin.
17140 \begin_layout Description
17141 \begin_inset Flex Code
17144 \begin_layout Plain Layout
17150 means that the left margin depends on the string entered in the
17151 \begin_inset Flex Noun
17154 \begin_layout Plain Layout
17155 Edit\SpecialChar menuseparator
17157 \begin_inset space ~
17166 This is used to typeset nice lists without tabulators.
17169 \begin_layout Description
17170 \begin_inset Flex Code
17173 \begin_layout Plain Layout
17179 means that the margin depends on the size of the label.
17180 This is used for automatic enumerated headlines.
17181 It is obvious that the headline
17182 \begin_inset Quotes eld
17185 5.4.3.2.1 Very long headline
17186 \begin_inset Quotes erd
17189 must have a wider left margin (as wide as
17190 \begin_inset Quotes eld
17194 \begin_inset Quotes erd
17197 plus the space) than
17198 \begin_inset Quotes eld
17201 3.2 Very long headline
17202 \begin_inset Quotes erd
17207 \begin_inset Quotes eld
17211 \begin_inset Quotes erd
17214 are not able to do this.
17217 \begin_layout Description
17218 \begin_inset Flex Code
17221 \begin_layout Plain Layout
17228 but only the very first row of the paragraph is dynamic,
17229 while the others are static;
17235 \begin_layout Description
17236 \begin_inset Flex Code
17239 \begin_layout Plain Layout
17245 means the margin is chosen in a way that the longest row of this paragraph fits to the right margin.
17246 This is used to typeset an address on the right edge of the page.
17250 \begin_layout Description
17251 \begin_inset Flex Code
17254 \begin_layout Plain Layout
17261 \begin_inset Flex Code
17264 \begin_layout Plain Layout
17273 \begin_inset space \thinspace{}
17277 \begin_inset Flex Code
17280 \begin_layout Plain Layout
17286 ] Whether fragile commands in this style should be
17287 \begin_inset Flex Code
17290 \begin_layout Plain Layout
17304 whether this command should itself be protected.)
17305 \change_inserted -712698321 1523696949
17309 \begin_layout Description
17311 \change_inserted -712698321 1552395557
17312 \begin_inset Flex Code
17315 \begin_layout Plain Layout
17317 \change_inserted -712698321 1523696950
17326 \begin_inset Flex Code
17329 \begin_layout Plain Layout
17331 \change_inserted -712698321 1523696950
17342 \begin_inset space \thinspace{}
17346 \begin_inset Flex Code
17349 \begin_layout Plain Layout
17351 \change_inserted -712698321 1523696950
17359 ] This causes macros that contain this layout to be protected with
17360 \begin_inset Flex Code
17363 \begin_layout Plain Layout
17365 \change_inserted -712698321 1523696950
17380 ) if necessary and thus allows (some) verbatim stuff in macros.
17383 \begin_layout Description
17385 \change_inserted -712698321 1552395844
17386 \begin_inset Flex Code
17389 \begin_layout Plain Layout
17391 \change_inserted -712698321 1552395561
17400 \begin_inset Flex Code
17403 \begin_layout Plain Layout
17405 \change_inserted -712698321 1552395557
17416 \begin_inset space \thinspace{}
17420 \begin_inset Flex Code
17423 \begin_layout Plain Layout
17425 \change_inserted -712698321 1552395557
17433 ] Whether specific commands in this style (such as
17434 \begin_inset Flex Code
17437 \begin_layout Plain Layout
17439 \change_inserted -712698321 1552395655
17450 \begin_inset Flex Code
17453 \begin_layout Plain Layout
17455 \change_inserted -712698321 1552395661
17465 ) should be protected in an
17466 \begin_inset Flex Code
17469 \begin_layout Plain Layout
17471 \change_inserted -712698321 1552395631
17482 This is particularly needed for styles that draw on
17490 commands which parse their content in complex ways.
17495 \begin_layout Description
17496 \begin_inset Flex Code
17499 \begin_layout Plain Layout
17506 \begin_inset Flex Code
17509 \begin_layout Plain Layout
17516 \begin_inset space \thinspace{}
17520 \begin_inset Flex Code
17523 \begin_layout Plain Layout
17531 ] Whether newlines are translated into \SpecialChar LaTeX
17533 \begin_inset Flex Code
17536 \begin_layout Plain Layout
17547 The translation can be switched off to allow more comfortable \SpecialChar LaTeX
17548 editing inside \SpecialChar LyX
17552 \begin_layout Description
17553 \begin_inset Flex Code
17556 \begin_layout Plain Layout
17563 \begin_inset Flex Code
17566 \begin_layout Plain Layout
17575 \begin_inset space \thinspace{}
17579 \begin_inset Flex Code
17582 \begin_layout Plain Layout
17590 \begin_inset Flex Code
17593 \begin_layout Plain Layout
17600 \begin_inset Flex Code
17603 \begin_layout Plain Layout
17609 ) paragraphs are being indented,
17610 then the indentation of such a paragraph following one of this type will be suppressed.
17611 (So this will not affect the display of non-default paragraphs.)
17614 \begin_layout Description
17615 \begin_inset Flex Code
17618 \begin_layout Plain Layout
17625 \begin_inset Flex Code
17628 \begin_layout Plain Layout
17634 ] Name of a style that has replaced this style.
17635 This is used to rename a style,
17636 while keeping backward compatibility.
17639 \begin_layout Description
17640 \begin_inset Flex Code
17643 \begin_layout Plain Layout
17650 \begin_inset Flex Code
17653 \begin_layout Plain Layout
17660 \begin_inset space \thinspace{}
17664 \begin_inset Flex Code
17667 \begin_layout Plain Layout
17673 ] Determines whether consecutive paragraphs of the same type are treated as belonging together.
17674 This has the effect that the
17675 \begin_inset Flex Code
17678 \begin_layout Plain Layout
17684 is only printed once before such a group.
17687 \begin_inset Flex Code
17690 \begin_layout Plain Layout
17697 \begin_inset Flex Code
17700 \begin_layout Plain Layout
17707 \begin_inset Flex Code
17710 \begin_layout Plain Layout
17716 and false for all other types.
17719 \begin_layout Description
17720 \begin_inset Flex Code
17723 \begin_layout Plain Layout
17730 \begin_inset Flex Code
17733 \begin_layout Plain Layout
17742 \begin_inset space \thinspace{}
17746 \begin_inset Flex Code
17749 \begin_layout Plain Layout
17755 ] Indicates that paragraphs will not be separated by an empty line in \SpecialChar LaTeX
17757 but only by a line break;
17759 \begin_inset Flex Code
17762 \begin_layout Plain Layout
17769 this allows to emulate a plain text editor (like the ERT inset).
17772 \begin_layout Description
17773 \begin_inset Flex Code
17776 \begin_layout Plain Layout
17783 \begin_inset Flex Code
17786 \begin_layout Plain Layout
17792 ] The indent of the very first line of a paragraph.
17794 \begin_inset Newline newline
17798 \begin_inset Flex Code
17801 \begin_layout Plain Layout
17807 will be fixed for a certain style.
17808 The exception is the default style,
17809 since the indentation for these paragraphs can be prohibited with
17810 \begin_inset Flex Code
17813 \begin_layout Plain Layout
17822 \begin_inset Flex Code
17825 \begin_layout Plain Layout
17831 style paragraphs inside environments use the
17832 \begin_inset Flex Code
17835 \begin_layout Plain Layout
17841 of the environment,
17842 not their native one.
17845 \begin_inset Flex Code
17848 \begin_layout Plain Layout
17854 paragraphs inside an enumeration are not indented.
17857 \begin_layout Description
17858 \begin_inset Flex Code
17861 \begin_layout Plain Layout
17868 \begin_inset Flex Code
17871 \begin_layout Plain Layout
17877 ] The vertical space between two paragraphs of this style.
17880 \begin_layout Description
17881 \begin_inset Flex Code
17884 \begin_layout Plain Layout
17891 \begin_inset Flex Code
17894 \begin_layout Plain Layout
17901 allows the user to choose either
17902 \begin_inset Quotes eld
17906 \begin_inset Quotes erd
17910 \begin_inset Quotes eld
17914 \begin_inset Quotes erd
17917 to separate paragraphs.
17919 \begin_inset Quotes eld
17923 \begin_inset Quotes erd
17928 \begin_inset Flex Code
17931 \begin_layout Plain Layout
17939 \begin_inset Quotes eld
17943 \begin_inset Quotes erd
17948 \begin_inset Flex Code
17951 \begin_layout Plain Layout
17957 is ignored and all paragraphs are separated by the
17958 \begin_inset Flex Code
17961 \begin_layout Plain Layout
17968 The vertical space is calculated with
17969 \begin_inset Flex Code
17972 \begin_layout Plain Layout
17974 \begin_inset space ~
17983 \begin_inset Flex Code
17986 \begin_layout Plain Layout
17992 is the height of a row with the normal font.
17994 the look stays the same with different screen fonts.
17997 \begin_layout Description
17998 \begin_inset Flex Code
18001 \begin_layout Plain Layout
18008 \begin_inset Flex Code
18011 \begin_layout Plain Layout
18020 \begin_inset space \thinspace{}
18024 \begin_inset Flex Code
18027 \begin_layout Plain Layout
18033 ] Whether the contents of this paragraph should be output in raw form,
18034 meaning without special translations that \SpecialChar LaTeX
18038 \begin_layout Description
18039 \begin_inset Flex Code
18042 \begin_layout Plain Layout
18049 \begin_inset Flex Code
18052 \begin_layout Plain Layout
18062 Defines individual characters that should be output in raw form,
18063 meaning without special translations that \SpecialChar LaTeX
18067 \begin_layout Description
18068 \begin_inset Flex Code
18071 \begin_layout Plain Layout
18077 Information to be included in the \SpecialChar LaTeX
18078 preamble when this style is used.
18079 Used to define macros,
18082 required by this particular style.
18084 \begin_inset Quotes eld
18088 \begin_inset Flex Code
18091 \begin_layout Plain Layout
18098 \begin_inset Quotes erd
18104 \begin_layout Description
18105 \begin_inset Flex Code
18108 \begin_layout Plain Layout
18115 \begin_inset Flex Code
18118 \begin_layout Plain Layout
18124 ] The prefix to use when creating labels referring to paragraphs of this type.
18125 This allows the use of formatted references.
18128 \begin_layout Description
18129 \begin_inset Flex Code
18132 \begin_layout Plain Layout
18139 \begin_inset Flex Code
18142 \begin_layout Plain Layout
18148 ] Whether the style requires the feature
18149 \begin_inset Flex Code
18152 \begin_layout Plain Layout
18159 \begin_inset CommandInset ref
18161 reference "chap:List-of-functions"
18166 for the list of features).
18167 If you require a package with specific options,
18168 you can additionally use
18169 \begin_inset Flex Code
18172 \begin_layout Plain Layout
18178 as a general text class parameter (see
18179 \begin_inset CommandInset ref
18181 reference "subsec:General-text-class"
18189 \begin_layout Description
18190 \begin_inset Flex Code
18193 \begin_layout Plain Layout
18200 \begin_inset Flex Code
18203 \begin_layout Plain Layout
18212 \begin_inset Flex Code
18215 \begin_layout Plain Layout
18221 ] Resets the \SpecialChar LaTeX
18222 arguments of this style (as defined via the
18223 \begin_inset Flex Code
18226 \begin_layout Plain Layout
18233 This is useful if you have copied a style via
18234 \begin_inset Flex Code
18237 \begin_layout Plain Layout
18244 but you do not want to inherit its (required and optional) arguments.
18247 \begin_layout Description
18248 \begin_inset Flex Code
18251 \begin_layout Plain Layout
18258 \begin_inset Flex Code
18261 \begin_layout Plain Layout
18270 \begin_inset Flex Code
18273 \begin_layout Plain Layout
18279 ] Resumes a counter that is usually reset at each new sequence of layouts.
18280 This is currently only useful when
18281 \begin_inset Flex Code
18284 \begin_layout Plain Layout
18291 \begin_inset Flex Code
18294 \begin_layout Plain Layout
18303 \begin_layout Description
18304 \begin_inset Flex Code
18307 \begin_layout Plain Layout
18314 \begin_inset Flex Code
18317 \begin_layout Plain Layout
18323 ] A string that is put at the end of the layout content.
18324 A line break in the output can be indicated by
18325 \begin_inset Flex Code
18328 \begin_layout Plain Layout
18337 \begin_layout Description
18338 \begin_inset Flex Code
18341 \begin_layout Plain Layout
18348 \begin_inset Flex Code
18351 \begin_layout Plain Layout
18358 \begin_inset Flex Code
18361 \begin_layout Plain Layout
18370 \begin_layout Description
18371 \begin_inset Flex Code
18374 \begin_layout Plain Layout
18381 \begin_inset Flex Code
18384 \begin_layout Plain Layout
18394 \begin_inset Flex Code
18397 \begin_layout Plain Layout
18405 \begin_inset Flex Code
18408 \begin_layout Plain Layout
18416 \begin_inset Flex Code
18419 \begin_layout Plain Layout
18421 \begin_inset space ~
18429 ] This defines what the default spacing should be in the style.
18431 \begin_inset Flex Code
18434 \begin_layout Plain Layout
18442 \begin_inset Flex Code
18445 \begin_layout Plain Layout
18452 \begin_inset Flex Code
18455 \begin_layout Plain Layout
18461 correspond respectively to a multiplier value of 1,
18463 If you specify the argument
18464 \begin_inset Flex Code
18467 \begin_layout Plain Layout
18474 then you must also provide a value argument which will be the actual multiplier value.
18476 contrary to other parameters,
18478 \begin_inset Flex Code
18481 \begin_layout Plain Layout
18487 implies the generation of specific \SpecialChar LaTeX
18489 using the \SpecialChar LaTeX
18493 \begin_inset Flex Code
18496 \begin_layout Plain Layout
18505 \begin_layout Description
18506 \begin_inset Flex Code
18509 \begin_layout Plain Layout
18516 \begin_inset Flex Code
18519 \begin_layout Plain Layout
18526 \begin_inset space \thinspace{}
18530 \begin_inset Flex Code
18533 \begin_layout Plain Layout
18541 ] Allow spell-checking paragraphs of this style.
18545 \begin_layout Description
18546 \begin_inset Flex Code
18549 \begin_layout Plain Layout
18551 \change_deleted 731793113 1604355211
18553 \change_inserted 731793113 1604355212
18562 \begin_inset Flex Code
18565 \begin_layout Plain Layout
18574 \begin_inset Flex Code
18577 \begin_layout Plain Layout
18584 \change_deleted 731793113 1604355214
18586 \change_inserted 731793113 1604355216
18589 counter of a given counter at the beginning of a new sequence of layouts.
18590 This is currently only useful when
18591 \begin_inset Flex Code
18594 \begin_layout Plain Layout
18601 \begin_inset Flex Code
18604 \begin_layout Plain Layout
18613 \begin_layout Description
18614 \begin_inset Flex Code
18617 \begin_layout Plain Layout
18623 The font used for the text body .
18625 \begin_inset CommandInset ref
18627 reference "subsec:Font-description"
18635 \begin_layout Description
18636 \begin_inset Flex Code
18639 \begin_layout Plain Layout
18648 \begin_inset Flex Code
18651 \begin_layout Plain Layout
18661 The level of the style in the table of contents.
18662 This is used for automatic numbering of section headings.
18665 \begin_layout Description
18666 \begin_inset Flex Code
18669 \begin_layout Plain Layout
18678 \begin_inset Flex Code
18681 \begin_layout Plain Layout
18693 \begin_inset Flex Code
18696 \begin_layout Plain Layout
18704 \begin_inset Flex Code
18707 \begin_layout Plain Layout
18713 ] This tag determines whether the first line indentation of this paragraph can be toggled via the Paragraph settings dialog.
18717 \begin_inset Flex Code
18720 \begin_layout Plain Layout
18731 indentation can be toggled if the document settings use
18732 \begin_inset Quotes eld
18736 \begin_inset Quotes erd
18741 \begin_inset Flex Code
18744 \begin_layout Plain Layout
18751 indentation can always be toggled,
18752 notwithstanding the document settings,
18754 \begin_inset Flex Code
18757 \begin_layout Plain Layout
18764 indentation can never be toggled.
18767 \begin_layout Description
18768 \begin_inset Flex Code
18771 \begin_layout Plain Layout
18778 \begin_inset Flex Code
18781 \begin_layout Plain Layout
18787 ] The vertical space with which the very first of a chain of paragraphs with this style is separated from the previous paragraph.
18788 If the previous paragraph has another style,
18789 the separations are not simply added,
18790 but the maximum is taken.
18793 \begin_layout Subsection
18794 \begin_inset CommandInset label
18800 Internationalization of Paragraph Styles
18803 \begin_layout Standard
18805 has long supported internationalization of layout information,
18808 this applied only to the user interface and not to,
18812 French authors were forced to resort to ugly hacks if they wanted `
18816 1' instead of `Theorem 1'.
18817 Thanks to Georg Baum,
18818 that is no longer the case.
18821 \begin_layout Standard
18823 \begin_inset Flex Code
18826 \begin_layout Plain Layout
18832 defines text that is to appear in the typeset document,
18834 \begin_inset Flex Code
18837 \begin_layout Plain Layout
18844 \begin_inset Flex Code
18847 \begin_layout Plain Layout
18853 to support non-English and even multi-language documents correctly.
18854 The following excerpt (from the
18855 \begin_inset Flex Code
18858 \begin_layout Plain Layout
18864 file) shows how this works:
18867 \begin_layout LyX-Code
18872 \begin_layout LyX-Code
18875 theoremstyle{remark}
18878 \begin_layout LyX-Code
18881 newtheorem{claim}[thm]{
18888 \begin_layout LyX-Code
18892 \begin_layout LyX-Code
18896 \begin_layout LyX-Code
18901 claimname}{_(Claim)}
18904 \begin_layout LyX-Code
18908 \begin_layout LyX-Code
18912 \begin_layout LyX-Code
18921 claimname}{_(Claim)}}
18924 \begin_layout LyX-Code
18929 \begin_layout Standard
18931 any legal \SpecialChar LaTeX
18933 \begin_inset Flex Code
18936 \begin_layout Plain Layout
18943 \begin_inset Flex Code
18946 \begin_layout Plain Layout
18953 but in practice they will typically look as they do here.
18954 The key to correct translation of the typeset text is the definition of the \SpecialChar LaTeX
18956 \begin_inset Flex Code
18959 \begin_layout Plain Layout
18968 \begin_inset Flex Code
18971 \begin_layout Plain Layout
18983 \begin_layout Standard
18985 \begin_inset Flex Code
18988 \begin_layout Plain Layout
18994 tag provides for internationalization based upon the overall language of the document.
18995 The contents of the tag will be included in the preamble,
18997 \begin_inset Flex Code
19000 \begin_layout Plain Layout
19007 What makes it special is the use of the
19008 \begin_inset Quotes eld
19012 \begin_inset Quotes erd
19016 \begin_inset Flex Code
19019 \begin_layout Plain Layout
19026 which will be replaced,
19027 when \SpecialChar LyX
19028 produces \SpecialChar LaTeX
19030 with the translation of its argument into the document language.
19033 \begin_layout Standard
19035 \begin_inset Flex Code
19038 \begin_layout Plain Layout
19044 tag is more complex,
19045 since it is meant to provide support for multi-language documents and so offers an interface to the
19046 \begin_inset Flex Code
19049 \begin_layout Plain Layout
19056 Its contents will be added to the preamble once for each language that appears in the document.
19059 \begin_inset Flex Code
19062 \begin_layout Plain Layout
19068 will be replaced with its translation into the language in question;
19070 \begin_inset Flex Code
19073 \begin_layout Plain Layout
19079 is replaced by the language name (as used by the babel package).
19082 \begin_layout Standard
19083 A German document that also included a French section would thus have the following in the preamble:
19086 \begin_layout LyX-Code
19095 claimname}{Affirmation}}
19096 \begin_inset Newline newline
19107 claimname}{Behauptung}}
19108 \begin_inset Newline newline
19115 claimname}{Behauptung}
19118 \begin_layout Standard
19121 \begin_inset Flex Code
19124 \begin_layout Plain Layout
19130 will then conspire to produce the correct text in the output.
19133 \begin_layout Standard
19134 One important point to note here is that the translations are provided by \SpecialChar LyX
19137 \begin_inset Flex Code
19140 \begin_layout Plain Layout
19150 \begin_inset Flex Code
19153 \begin_layout Plain Layout
19160 \begin_inset Flex Code
19163 \begin_layout Plain Layout
19169 are really only of use in layout files that are provided with \SpecialChar LyX
19171 since text entered in user-created layout files will not be seen by \SpecialChar LyX
19172 's internationalization routines unless the
19173 \begin_inset Flex Code
19176 \begin_layout Plain Layout
19182 file is modified accordingly.
19185 any layout created with the intention that it will be included with \SpecialChar LyX
19186 should use these tags where appropriate.
19187 Please note that the paragraph style translations provided by \SpecialChar LyX
19188 will never change with a minor update (e.
19189 \begin_inset space \thinspace{}
19193 \begin_inset space \space{}
19196 from version 2.1.x to 2.1.y).
19197 It is however quite likely that a major update (e.
19198 \begin_inset space \thinspace{}
19202 \begin_inset space \space{}
19205 from 2.0.x to 2.1.0) will introduce new translations or corrections.
19208 \begin_layout Subsection
19210 \begin_inset CommandInset label
19212 name "subsec:Floats"
19219 \begin_layout Standard
19220 It is necessary to define the floats (
19221 \begin_inset Flex Noun
19224 \begin_layout Plain Layout
19232 \begin_inset Flex Noun
19235 \begin_layout Plain Layout
19243 ) in the text class itself.
19244 Standard floats are included in the file
19245 \begin_inset Flex Code
19248 \begin_layout Plain Layout
19255 so you may have to do no more than add
19258 \begin_layout LyX-Code
19259 Input stdfloats.inc
19262 \begin_layout Standard
19263 to your layout file.
19264 If you want to implement a text class that proposes some other float types (like the AGU class bundled with \SpecialChar LyX
19266 the information below will hopefully help you:
19269 \begin_layout Description
19270 \begin_inset Flex Code
19273 \begin_layout Plain Layout
19280 \begin_inset Flex Code
19283 \begin_layout Plain Layout
19289 =!htbpH] Allowed placement options for this float type.
19290 The value is a string of placement characters.
19291 Possible characters include:
19297 \begin_inset Quotes eld
19301 \begin_inset Quotes erd
19310 \begin_inset Quotes eld
19314 \begin_inset Quotes erd
19323 \begin_inset Quotes eld
19327 \begin_inset Quotes erd
19336 \begin_inset Quotes eld
19340 \begin_inset Quotes erd
19349 \begin_inset Quotes eld
19353 \begin_inset Quotes erd
19362 \begin_inset Quotes eld
19366 \begin_inset Quotes erd
19370 The order of the characters in the string does not matter.
19371 If no placement options are allowed,
19379 \begin_layout Description
19380 \begin_inset Flex Code
19383 \begin_layout Plain Layout
19390 \begin_inset Flex Code
19393 \begin_layout Plain Layout
19402 \begin_inset space \thinspace{}
19408 \begin_inset Flex Code
19411 \begin_layout Plain Layout
19421 ] Defines whether the float allows to be rotated via the \SpecialChar LaTeX
19428 \begin_inset Flex Code
19431 \begin_layout Plain Layout
19437 if the float does not support this feature.
19440 \begin_layout Description
19441 \begin_inset Flex Code
19444 \begin_layout Plain Layout
19451 \begin_inset Flex Code
19454 \begin_layout Plain Layout
19463 \begin_inset space \thinspace{}
19469 \begin_inset Flex Code
19472 \begin_layout Plain Layout
19482 ] Defines whether the float has a starred variant that spans columns in a two column paragraph.
19484 \begin_inset Flex Code
19487 \begin_layout Plain Layout
19493 if the float does not support this feature.
19496 \begin_layout Description
19497 \begin_inset Flex Code
19500 \begin_layout Plain Layout
19507 \begin_inset Flex Code
19510 \begin_layout Plain Layout
19517 \begin_inset Quotes erd
19521 \begin_inset Quotes erd
19524 ] The file name extension of an auxiliary file for the list of figures (or whatever).
19526 writes the captions to this file.
19529 \begin_layout Description
19530 \begin_inset Flex Code
19533 \begin_layout Plain Layout
19540 \begin_inset Flex Code
19543 \begin_layout Plain Layout
19550 \begin_inset Quotes erd
19554 \begin_inset Quotes erd
19557 ] The string that will be used in the menus and also for the caption.
19558 This is translated to the current language if babel is used.
19561 \begin_layout Description
19562 \begin_inset Flex Code
19565 \begin_layout Plain Layout
19571 These tags control the XHTML output.
19573 \begin_inset CommandInset ref
19575 reference "sec:Tags-for-XHTML"
19583 \begin_layout Description
19584 \begin_inset Flex Code
19587 \begin_layout Plain Layout
19596 \begin_inset Flex Code
19599 \begin_layout Plain Layout
19608 \begin_inset space \thinspace{}
19612 \begin_inset Flex Code
19615 \begin_layout Plain Layout
19621 ] Indicates whether the float is already defined in the document class or if instead the \SpecialChar LaTeX
19623 \begin_inset Flex Code
19626 \begin_layout Plain Layout
19632 needs to be loaded to define it on-the-fly.
19634 \begin_inset Flex Code
19637 \begin_layout Plain Layout
19646 \begin_inset Flex Code
19649 \begin_layout Plain Layout
19656 It should be set to
19657 \begin_inset Flex Code
19660 \begin_layout Plain Layout
19666 if the float is already defined by the \SpecialChar LaTeX
19670 \begin_layout Description
19671 \begin_inset Flex Code
19674 \begin_layout Plain Layout
19681 \begin_inset Flex Code
19684 \begin_layout Plain Layout
19691 \begin_inset Quotes erd
19695 \begin_inset Quotes erd
19698 ] The command used to generate a list of floats of this type;
19707 \begin_inset Flex Code
19710 \begin_layout Plain Layout
19717 since there is no standard way to generate this command.
19719 \begin_inset Flex Code
19722 \begin_layout Plain Layout
19729 since in that case there is a standard way to define the command.
19732 \begin_layout Description
19733 \begin_inset Flex Code
19736 \begin_layout Plain Layout
19743 \begin_inset Flex Code
19746 \begin_layout Plain Layout
19753 \begin_inset Quotes erd
19757 \begin_inset Quotes erd
19760 ] A title for a list of floats of this kind (list of figures,
19763 It is used for the screen label within \SpecialChar LyX
19765 it is used by \SpecialChar LaTeX
19766 for the title and it is used as the title in the XHTML output.
19767 It will be translated to the document language.
19770 \begin_layout Description
19771 \begin_inset Flex Code
19774 \begin_layout Plain Layout
19781 \begin_inset Flex Code
19784 \begin_layout Plain Layout
19791 \begin_inset Quotes erd
19795 \begin_inset Quotes erd
19798 ] This (optional) argument determines whether floats of this class will be numbered within some sectional unit of the document.
19801 \begin_inset Flex Code
19804 \begin_layout Plain Layout
19811 \begin_inset Quotes eld
19815 \begin_inset Flex Code
19818 \begin_layout Plain Layout
19825 \begin_inset Quotes erd
19829 the floats will be numbered within chapters.
19833 \begin_layout Description
19834 \begin_inset Flex Code
19837 \begin_layout Plain Layout
19844 \begin_inset Flex Code
19847 \begin_layout Plain Layout
19854 \begin_inset Quotes erd
19858 \begin_inset Quotes erd
19861 ] The default placement for the given class of floats.
19862 The string should be as in standard \SpecialChar LaTeX
19865 \begin_inset Flex Code
19868 \begin_layout Plain Layout
19876 \begin_inset Flex Code
19879 \begin_layout Plain Layout
19887 \begin_inset Flex Code
19890 \begin_layout Plain Layout
19897 \begin_inset Flex Code
19900 \begin_layout Plain Layout
19914 \begin_layout Plain Layout
19915 Note that the order of these letters in the string is irrelevant,
19916 like in \SpecialChar LaTeX
19922 On top of that there is a new type,
19924 \begin_inset Flex Code
19927 \begin_layout Plain Layout
19934 which does not really correspond to a float,
19937 \begin_inset Quotes eld
19941 \begin_inset Quotes erd
19945 Note however that the
19946 \begin_inset Flex Code
19949 \begin_layout Plain Layout
19955 specifier is special and,
19956 because of implementation details,
19957 cannot be used in non-built in float types.
19958 If you do not understand what this means,
19960 \begin_inset Quotes eld
19964 \begin_inset Flex Code
19967 \begin_layout Plain Layout
19974 \begin_inset Quotes erd
19978 \change_inserted -584632292 1690588297
19982 \begin_layout Description
19984 \change_inserted -584632292 1690593080
19985 \begin_inset Flex Code
19988 \begin_layout Plain Layout
19990 \change_inserted -584632292 1690588298
19999 \begin_inset Flex Code
20002 \begin_layout Plain Layout
20004 \change_inserted -584632292 1690588298
20013 \begin_inset Quotes erd
20017 \begin_inset Quotes erd
20020 ] A format for use with formatted references to this counter.
20022 one might want to have references to tables appear as
20023 \begin_inset Quotes eld
20027 \begin_inset Quotes erd
20031 The string may contain
20032 \begin_inset Quotes eld
20036 \begin_inset Quotes erd
20039 or a counter specification.
20040 (See the documentation for
20041 \begin_inset Flex Code
20044 \begin_layout Plain Layout
20046 \change_inserted -584632292 1690588298
20055 \begin_inset CommandInset ref
20056 LatexCommand formatted
20057 reference "subsec:Counters"
20065 .) The former will be replaced by the counter number itself.
20073 arabic{section} (which might render as:
20077 \begin_layout Description
20078 \begin_inset Flex Code
20081 \begin_layout Plain Layout
20088 \begin_inset Flex Code
20091 \begin_layout Plain Layout
20097 ] The prefix to use when creating labels referring to floats of this type.
20098 This allows the use of formatted references.
20099 Note that you can remove any
20100 \begin_inset Flex Code
20103 \begin_layout Plain Layout
20109 set by a copied style by using the special value
20110 \begin_inset Quotes eld
20114 \begin_inset Quotes erd
20118 which must be all caps.
20119 \change_inserted -712698321 1565605014
20123 \begin_layout Description
20125 \change_inserted -712698321 1565605014
20126 \begin_inset Flex Code
20129 \begin_layout Plain Layout
20131 \change_inserted -712698321 1565605014
20140 \begin_inset Flex Code
20143 \begin_layout Plain Layout
20145 \change_inserted -712698321 1565605014
20153 ] As with paragraph styles,
20155 \begin_inset CommandInset ref
20157 reference "subsec:Paragraph-Styles"
20167 \begin_layout Description
20168 \begin_inset Flex Code
20171 \begin_layout Plain Layout
20178 \begin_inset Flex Code
20181 \begin_layout Plain Layout
20188 \begin_inset Quotes erd
20192 \begin_inset Quotes erd
20195 ] The style used when defining the float using
20196 \begin_inset Flex Code
20199 \begin_layout Plain Layout
20210 \begin_layout Description
20211 \begin_inset Flex Code
20214 \begin_layout Plain Layout
20221 \begin_inset Flex Code
20224 \begin_layout Plain Layout
20231 \begin_inset Quotes erd
20235 \begin_inset Quotes erd
20239 \begin_inset Quotes eld
20243 \begin_inset Quotes erd
20246 of the new class of floats,
20247 like program or algorithm.
20248 After the appropriate
20249 \begin_inset Flex Code
20252 \begin_layout Plain Layout
20262 \begin_inset Flex Code
20265 \begin_layout Plain Layout
20274 \begin_inset Flex Code
20277 \begin_layout Plain Layout
20288 \begin_layout Description
20289 \begin_inset Flex Code
20292 \begin_layout Plain Layout
20299 \begin_inset Flex Code
20302 \begin_layout Plain Layout
20309 \begin_inset space \thinspace{}
20313 \begin_inset Flex Code
20316 \begin_layout Plain Layout
20324 ] Specifies whether this float is defined using the \SpecialChar LaTeX
20326 \begin_inset Flex Code
20329 \begin_layout Plain Layout
20336 either by the class file,
20337 another package or on-the-fly by \SpecialChar LyX
20341 \begin_layout Standard
20342 Note that defining a float with type
20343 \begin_inset Flex Code
20346 \begin_layout Plain Layout
20354 automatically defines the corresponding counter with name
20355 \begin_inset Flex Code
20358 \begin_layout Plain Layout
20369 \begin_layout Subsection
20370 Flex insets and InsetLayout
20371 \begin_inset CommandInset label
20373 name "subsec:Flex-insets-and"
20380 \begin_layout Standard
20381 Flex insets come in
20382 \change_deleted 5863208 1594239511
20384 \change_inserted 5863208 1594239512
20391 \begin_layout Itemize
20393 \begin_inset Flex Code
20396 \begin_layout Plain Layout
20403 These define semantic markup corresponding to such \SpecialChar LaTeX
20405 \begin_inset Flex Code
20408 \begin_layout Plain Layout
20417 \begin_inset Flex Code
20420 \begin_layout Plain Layout
20431 \begin_layout Itemize
20433 \begin_inset Flex Code
20436 \begin_layout Plain Layout
20443 These can be used to define custom collapsible insets,
20444 similar to \SpecialChar TeX
20448 An obvious example is an endnote inset,
20449 which is defined in the
20450 \begin_inset Flex Code
20453 \begin_layout Plain Layout
20462 \begin_layout Itemize
20464 \change_deleted 5863208 1594239528
20466 \begin_inset Flex Code
20469 \begin_layout Plain Layout
20476 For use with DocBook classes.
20481 \begin_layout Standard
20482 Flex insets are defined using the
20483 \begin_inset Flex Code
20486 \begin_layout Plain Layout
20493 which shall be explained in a moment.
20496 \begin_layout Standard
20498 \begin_inset Flex Code
20501 \begin_layout Plain Layout
20507 tag also serves another function:
20508 It can be used to customize the general layout of many different types of insets.
20511 \begin_inset Flex Code
20514 \begin_layout Plain Layout
20520 can be used to customize the layout parameters for footnotes,
20533 as well as to define Flex insets.
20536 \begin_layout Standard
20538 \begin_inset Flex Code
20541 \begin_layout Plain Layout
20547 definition must begin with a line of the form:
20550 \begin_layout LyX-Code
20554 \begin_layout Standard
20556 \begin_inset Flex Code
20559 \begin_layout Plain Layout
20565 indicates the inset whose layout is being defined,
20566 and here there are four cases.
20569 \begin_layout Enumerate
20570 The layout for a pre-existing inset is being modified.
20573 \begin_inset Flex Code
20576 \begin_layout Plain Layout
20582 any one of the following:
20584 \begin_inset Flex Code
20587 \begin_layout Plain Layout
20595 \begin_inset Flex Code
20598 \begin_layout Plain Layout
20606 \begin_inset Flex Code
20609 \begin_layout Plain Layout
20617 \begin_inset Flex Code
20620 \begin_layout Plain Layout
20628 \begin_inset Flex Code
20631 \begin_layout Plain Layout
20639 \begin_inset Flex Code
20642 \begin_layout Plain Layout
20650 \begin_inset Flex Code
20653 \begin_layout Plain Layout
20661 \begin_inset Flex Code
20664 \begin_layout Plain Layout
20672 \begin_inset Flex Code
20675 \begin_layout Plain Layout
20683 \begin_inset Flex Code
20686 \begin_layout Plain Layout
20694 \begin_inset Flex Code
20697 \begin_layout Plain Layout
20705 \begin_inset Flex Code
20708 \begin_layout Plain Layout
20716 \begin_inset Flex Code
20719 \begin_layout Plain Layout
20727 \begin_inset Flex Code
20730 \begin_layout Plain Layout
20738 \begin_inset Flex Code
20741 \begin_layout Plain Layout
20749 \begin_inset Flex Code
20752 \begin_layout Plain Layout
20760 \begin_inset Flex Code
20763 \begin_layout Plain Layout
20771 \begin_inset Flex Code
20774 \begin_layout Plain Layout
20782 \begin_inset Flex Code
20785 \begin_layout Plain Layout
20793 \begin_inset Flex Code
20796 \begin_layout Plain Layout
20805 \begin_layout Enumerate
20806 The layout for a Flex inset is being defined.
20809 \begin_inset Flex Code
20812 \begin_layout Plain Layout
20818 must be of the form
20819 \begin_inset Quotes eld
20823 \begin_inset Flex Code
20826 \begin_layout Plain Layout
20833 \begin_inset Quotes erd
20838 \begin_inset Flex Code
20841 \begin_layout Plain Layout
20847 may be any valid identifier not used by a pre-existing Flex inset.
20848 The identifier may include spaces,
20849 but in that case the whole thing must be wrapped in quotes.
20850 Note that the definition of a flex inset
20855 \begin_inset Flex Code
20858 \begin_layout Plain Layout
20865 declaring which type of inset it defines.
20868 \begin_layout Enumerate
20869 The layout for user specific branch is being defined.
20872 \begin_inset Flex Code
20875 \begin_layout Plain Layout
20881 must be of the form
20882 \begin_inset Quotes eld
20886 \begin_inset Flex Code
20889 \begin_layout Plain Layout
20896 \begin_inset Quotes erd
20901 \begin_inset Flex Code
20904 \begin_layout Plain Layout
20910 may be any valid identifier of branch defined in user's document.
20911 The identifier may include spaces,
20912 but in that case the whole thing must be wrapped in quotes.
20913 The main purpose of this feature is to allow \SpecialChar LaTeX
20914 wrapping around specific branches as user needs.
20917 \begin_layout Enumerate
20918 The layout of a user (or class) specific caption is being defined.
20921 \begin_inset Flex Code
20924 \begin_layout Plain Layout
20930 must be of the form
20931 \begin_inset Quotes eld
20935 \begin_inset Flex Code
20938 \begin_layout Plain Layout
20945 \begin_inset Quotes erd
20950 \begin_inset Flex Code
20953 \begin_layout Plain Layout
20959 specifies the name of the caption as it appears in the menu.
20960 Have a look at the standard caption (
20961 \begin_inset Flex Code
20964 \begin_layout Plain Layout
20971 the specific captions of the KOMA-Script classes (
20972 \begin_inset Flex Code
20975 \begin_layout Plain Layout
20983 \begin_inset Flex Code
20986 \begin_layout Plain Layout
20995 \begin_inset space ~
20999 \begin_inset Newline linebreak
21005 \begin_inset Flex Code
21008 \begin_layout Plain Layout
21014 ) for applications.
21017 \begin_layout Standard
21019 \begin_inset Flex Code
21022 \begin_layout Plain Layout
21028 definition can contain the following entries:
21031 \begin_layout Description
21032 \begin_inset Flex Code
21035 \begin_layout Plain Layout
21042 \begin_inset Flex Code
21045 \begin_layout Plain Layout
21051 =""] This inset will appear in the table of contents of the given type.
21052 An empty string disables.
21053 See also the OutlinerName and the IsTocCaption commands.
21054 This is only implemented for Flex insets.
21057 \change_inserted -712698321 1690284265
21061 \begin_layout Description
21063 \change_inserted -712698321 1690284544
21064 \begin_inset Flex Code
21067 \begin_layout Plain Layout
21069 \change_inserted -712698321 1690284277
21077 Includes a comma-separated list of insets to which this inset can be inserted.
21079 \begin_inset Quotes eld
21083 \begin_inset Flex Code
21086 \begin_layout Plain Layout
21088 \change_inserted -712698321 1690284318
21097 \begin_inset Quotes erd
21101 If you you also want the insertion to be allowed in specific arguments of the target insets,
21102 append the argument name after @ (e.
21103 \begin_inset space \thinspace{}
21108 \begin_inset Flex Code
21111 \begin_layout Plain Layout
21113 \change_inserted -712698321 1690284445
21122 Note that this currently only supports immediately containing insets (no deeper nesting).
21124 \begin_inset Flex Code
21127 \begin_layout Plain Layout
21129 \change_inserted -712698321 1690284329
21140 \begin_layout Description
21142 \change_inserted -712698321 1690292495
21143 \begin_inset Flex Code
21146 \begin_layout Plain Layout
21148 \change_inserted -712698321 1690284338
21156 Includes a comma-separated list of layouts within which this inset can be inserted.
21158 \begin_inset Quotes eld
21162 \begin_inset Flex Code
21165 \begin_layout Plain Layout
21167 \change_inserted -712698321 1690284353
21168 EndAllowedInLayouts
21176 \begin_inset Quotes erd
21180 Note that this currently only supports immediately containing layouts (no deeper nesting).
21182 \begin_inset Flex Code
21185 \begin_layout Plain Layout
21187 \change_inserted -712698321 1690284358
21198 \begin_layout Description
21200 \change_inserted -712698321 1690357747
21201 \begin_inset Flex Code
21204 \begin_layout Plain Layout
21206 \change_inserted -712698321 1690292501
21215 \begin_inset Flex Code
21218 \begin_layout Plain Layout
21220 \change_inserted -712698321 1690292507
21229 \begin_inset Flex Code
21232 \begin_layout Plain Layout
21234 \change_inserted -712698321 1690292530
21243 \begin_inset Flex Code
21246 \begin_layout Plain Layout
21248 \change_inserted -712698321 1690292536
21257 this can be used to determine how many times the inset can be inserted to a given inset or the paragraph (group).
21260 \begin_layout Description
21262 \change_inserted -712698321 1690357828
21263 \begin_inset Flex Code
21266 \begin_layout Plain Layout
21268 \change_inserted -712698321 1690357753
21269 AllowedOccurrencesPerItem
21277 \begin_inset Flex Code
21280 \begin_layout Plain Layout
21282 \change_inserted -712698321 1690357747
21293 \begin_inset space \thinspace{}
21297 \begin_inset Flex Code
21300 \begin_layout Plain Layout
21302 \change_inserted -712698321 1690357747
21310 ] If this is set to true,
21312 \begin_inset Flex Code
21315 \begin_layout Plain Layout
21317 \change_inserted -712698321 1690357774
21325 applies to single paragraphs if we are in a list-type environment (with
21326 \begin_inset Flex Code
21329 \begin_layout Plain Layout
21331 \change_inserted -712698321 1690357825
21346 \begin_layout Description
21347 \begin_inset Flex Code
21350 \begin_layout Plain Layout
21357 \begin_inset Flex Code
21360 \begin_layout Plain Layout
21366 ] Defines argument number of a command\SpecialChar breakableslash
21367 environment associated with the current layout.
21368 The definition must end with
21369 \begin_inset Flex Code
21372 \begin_layout Plain Layout
21380 \change_inserted -584632292 1615846847
21382 \begin_inset CommandInset ref
21384 reference "subsec:Arguments"
21393 \change_deleted -584632292 1615846847
21395 \begin_inset CommandInset ref
21397 reference "subsec:Paragraph-Styles"
21405 \change_deleted -584632292 1615846902
21407 \change_inserted -584632292 1615846906
21413 \begin_layout Description
21414 \begin_inset Flex Code
21417 \begin_layout Plain Layout
21423 Preamble for changing language commands;
21425 \begin_inset CommandInset ref
21427 reference "subsec:I18n"
21435 \begin_layout Description
21436 \begin_inset Flex Code
21439 \begin_layout Plain Layout
21446 \begin_inset Flex Code
21449 \begin_layout Plain Layout
21455 ] The color for the inset's background.
21457 \begin_inset CommandInset ref
21459 reference "chap:Names-of-colors"
21464 for a list of the available color names.
21467 \begin_layout Description
21468 \begin_inset Flex Code
21471 \begin_layout Plain Layout
21478 \begin_inset Flex Code
21481 \begin_layout Plain Layout
21490 \begin_inset space \thinspace{}
21494 \begin_inset Flex Code
21497 \begin_layout Plain Layout
21503 ] Whether to use the content of the inset as the label,
21504 when the inset is closed.
21508 \begin_layout Description
21509 \begin_inset Flex Code
21512 \begin_layout Plain Layout
21519 \begin_inset Flex Code
21522 \begin_layout Plain Layout
21528 ] As with paragraph styles,
21530 \begin_inset CommandInset ref
21532 reference "subsec:Paragraph-Styles"
21538 Note that you need to specify the complete type,
21540 \begin_inset space \thinspace{}
21544 \begin_inset space ~
21548 \begin_inset Flex Code
21551 \begin_layout Plain Layout
21552 CopyStyle Flex:<name>
21560 \begin_layout Description
21561 \begin_inset Flex Code
21564 \begin_layout Plain Layout
21571 \begin_inset Flex Code
21574 \begin_layout Plain Layout
21583 \begin_inset space \thinspace{}
21587 \begin_inset Flex Code
21590 \begin_layout Plain Layout
21596 ] Indicates whether the user may employ the Paragraph Settings dialog to customize the paragraph.
21599 \begin_layout Description
21600 \begin_inset Flex Code
21603 \begin_layout Plain Layout
21610 \begin_inset Flex Code
21613 \begin_layout Plain Layout
21621 \begin_inset Flex Code
21624 \begin_layout Plain Layout
21632 \begin_inset Flex Code
21635 \begin_layout Plain Layout
21642 describing the rendering style used for the inset's frame and buttons.
21643 Footnotes generally use
21644 \begin_inset Flex Code
21647 \begin_layout Plain Layout
21654 ERT insets generally
21655 \begin_inset Flex Code
21658 \begin_layout Plain Layout
21665 and character styles
21666 \begin_inset Flex Code
21669 \begin_layout Plain Layout
21678 \begin_layout Description
21679 \begin_inset Flex Code
21682 \begin_layout Plain Layout
21689 \begin_inset Flex Code
21692 \begin_layout Plain Layout
21701 \begin_inset space \thinspace{}
21707 \begin_inset Flex Code
21710 \begin_layout Plain Layout
21719 \begin_inset Flex Code
21722 \begin_layout Plain Layout
21729 \begin_inset Flex Code
21732 \begin_layout Plain Layout
21739 Indicates whether the environment will stand on its own in the output or will appear inline with the surrounding text.
21741 it is supposed that the \SpecialChar LaTeX
21742 environment ignores white space (including one newline character) after the
21743 \begin_inset Flex Code
21746 \begin_layout Plain Layout
21759 \begin_inset Flex Code
21762 \begin_layout Plain Layout
21776 \change_inserted 731793113 1538674858
21780 \begin_layout Description
21782 \change_inserted 731793113 1538674891
21783 \begin_inset Flex Code
21786 \begin_layout Plain Layout
21788 \change_inserted 731793113 1538674863
21800 ,1] Allow the contents of the inset to be edited externally (using whatever editor is defined for the document's output format).
21805 \begin_layout Description
21806 \begin_inset Flex Code
21809 \begin_layout Plain Layout
21815 Required at the end of the
21816 \begin_inset Flex Code
21819 \begin_layout Plain Layout
21828 \begin_layout Description
21829 \begin_inset Flex Code
21832 \begin_layout Plain Layout
21838 The font used for both the text body
21844 \begin_inset CommandInset ref
21845 LatexCommand formatted
21846 reference "subsec:Font-description"
21852 Note that defining this font automatically defines the
21853 \begin_inset Flex Code
21856 \begin_layout Plain Layout
21863 so define this first and define
21864 \begin_inset Flex Code
21867 \begin_layout Plain Layout
21873 later if you want them to be different.
21876 \begin_layout Description
21877 \begin_inset Flex Code
21880 \begin_layout Plain Layout
21881 FixedWidthPreambleEncoding
21887 \begin_inset Flex Code
21890 \begin_layout Plain Layout
21899 \begin_inset space \thinspace{}
21903 \begin_inset Flex Code
21906 \begin_layout Plain Layout
21912 ] Force a fixed width encoding for the translated contents of
21913 \begin_inset Flex Code
21916 \begin_layout Plain Layout
21923 \begin_inset Flex Code
21926 \begin_layout Plain Layout
21932 code generated by this layout.
21933 This is needed for special \SpecialChar LaTeX
21938 that do not work with variable width encodings such as
21943 This setting is ignored if fully Unicode aware \SpecialChar LaTeX
21944 backends such as Xe\SpecialChar TeX
21945 or Lua\SpecialChar TeX
21949 \begin_layout Description
21950 \begin_inset Flex Code
21953 \begin_layout Plain Layout
21954 ForceLocalFontSwitch
21960 \begin_inset Flex Code
21963 \begin_layout Plain Layout
21972 \begin_inset space \thinspace{}
21976 \begin_inset Flex Code
21979 \begin_layout Plain Layout
21985 ] When using babel,
21986 always use a local font switch (
21987 \begin_inset Flex Code
21990 \begin_layout Plain Layout
21999 never a global one (such as
22000 \begin_inset Flex Code
22003 \begin_layout Plain Layout
22014 \begin_layout Description
22015 \begin_inset Flex Code
22018 \begin_layout Plain Layout
22025 \begin_inset Flex Code
22028 \begin_layout Plain Layout
22037 \begin_inset space \thinspace{}
22041 \begin_inset Flex Code
22044 \begin_layout Plain Layout
22051 \begin_inset Quotes eld
22055 \begin_inset Quotes erd
22059 leading to Left-to-Right (Latin) output,
22061 \begin_inset space \thinspace{}
22065 \begin_inset space \space{}
22068 in \SpecialChar TeX
22073 \begin_layout Description
22074 \begin_inset Flex Code
22077 \begin_layout Plain Layout
22084 \begin_inset Flex Code
22087 \begin_layout Plain Layout
22096 \begin_inset space \thinspace{}
22100 \begin_inset Flex Code
22103 \begin_layout Plain Layout
22109 ] Force a line break in the \SpecialChar LaTeX
22110 output before the inset starts and after the inset ends.
22111 This assures the inset itself is output on its own lines,
22112 for parsing purposes.
22115 \begin_layout Description
22116 \begin_inset Flex Code
22119 \begin_layout Plain Layout
22126 \begin_inset Flex Code
22129 \begin_layout Plain Layout
22138 \begin_inset space \thinspace{}
22142 \begin_inset Flex Code
22145 \begin_layout Plain Layout
22151 ] Indicates whether the
22152 \begin_inset Flex Code
22155 \begin_layout Plain Layout
22163 the user can change the paragraph style used in the inset.
22167 \begin_layout Description
22168 \begin_inset Flex Code
22171 \begin_layout Plain Layout
22178 \begin_inset Flex Code
22181 \begin_layout Plain Layout
22190 \begin_inset space \thinspace{}
22194 \begin_inset Flex Code
22197 \begin_layout Plain Layout
22203 ] As with paragraph styles,
22205 \begin_inset CommandInset ref
22207 reference "subsec:Paragraph-Styles"
22215 \begin_layout Description
22216 \begin_inset Flex Code
22219 \begin_layout Plain Layout
22225 These tags control the XHTML output.
22227 \begin_inset CommandInset ref
22229 reference "sec:Tags-for-XHTML"
22235 \change_inserted 47243155 1689528605
22239 \begin_layout Description
22241 \change_inserted 47243155 1689528735
22242 \begin_inset Flex Code
22245 \begin_layout Plain Layout
22247 \change_inserted 47243155 1689528630
22256 \begin_inset Flex Code
22259 \begin_layout Plain Layout
22261 \change_inserted 47243155 1689528607
22270 \begin_inset space \thinspace{}
22274 \begin_inset Flex Code
22277 \begin_layout Plain Layout
22279 \change_inserted 47243155 1689528607
22289 ] The font inside the inset is inherited from the parent for \SpecialChar LaTeX
22290 export if this parameter is 1,
22291 as well as on screen.
22292 Otherwise the document default font is used.
22297 \begin_layout Description
22298 \begin_inset Flex Code
22301 \begin_layout Plain Layout
22308 \begin_inset Flex Code
22311 \begin_layout Plain Layout
22320 \begin_inset space \thinspace{}
22324 \begin_inset Flex Code
22327 \begin_layout Plain Layout
22333 ] Whether to include the contents of this inset in the strings generated for the `Outline' pane for all table of contents,
22334 regardless of the AddToToc setting.
22337 want the content of a footnote in a section header to be included in the TOC displayed in the outline,
22338 but one would normally want the content of a character style displayed.
22343 \begin_layout Description
22344 \begin_inset Flex Code
22347 \begin_layout Plain Layout
22354 \begin_inset Flex Code
22357 \begin_layout Plain Layout
22366 \begin_inset space \thinspace{}
22370 \begin_inset Flex Code
22373 \begin_layout Plain Layout
22379 ] If this is set to 1 and AddToToc is enabled,
22380 the inset adds a summary of its contents in its item in the table of contents.
22382 only the label appears.
22385 \begin_layout Description
22386 \begin_inset Flex Code
22389 \begin_layout Plain Layout
22398 \begin_inset Flex Code
22401 \begin_layout Plain Layout
22410 \begin_inset space \thinspace{}
22414 \begin_inset Flex Code
22417 \begin_layout Plain Layout
22423 ] As with paragraph styles,
22425 \begin_inset CommandInset ref
22427 reference "subsec:Paragraph-Styles"
22435 \begin_layout Description
22436 \begin_inset Flex Code
22439 \begin_layout Plain Layout
22445 The font used for the label.
22447 \begin_inset CommandInset ref
22449 reference "subsec:Font-description"
22455 Note that this definition can never appear before
22456 \begin_inset Flex Code
22459 \begin_layout Plain Layout
22466 lest it be ineffective.
22469 \begin_layout Description
22470 \begin_inset Flex Code
22473 \begin_layout Plain Layout
22480 \begin_inset Flex Code
22483 \begin_layout Plain Layout
22490 \begin_inset Quotes erd
22494 \begin_inset Quotes erd
22497 ] What will be displayed on the button or elsewhere as the inset label.
22499 \begin_inset Flex Code
22502 \begin_layout Plain Layout
22510 \begin_inset Flex Code
22513 \begin_layout Plain Layout
22519 ) modify this label on the fly.
22522 \begin_layout Description
22523 \begin_inset Flex Code
22526 \begin_layout Plain Layout
22532 Language dependent preamble;
22534 \begin_inset CommandInset ref
22536 reference "subsec:I18n"
22544 \begin_layout Description
22545 \begin_inset Flex Code
22548 \begin_layout Plain Layout
22555 \begin_inset Flex Code
22558 \begin_layout Plain Layout
22564 ] The name of the corresponding \SpecialChar LaTeX
22566 Either the environment or command name.
22569 \begin_layout Description
22570 \begin_inset Flex Code
22573 \begin_layout Plain Layout
22580 \begin_inset Flex Code
22583 \begin_layout Plain Layout
22589 ] The optional parameter for the corresponding
22590 \begin_inset Flex Code
22593 \begin_layout Plain Layout
22600 including possible bracket pairs like
22601 \begin_inset Flex Code
22604 \begin_layout Plain Layout
22611 This parameter cannot be changed from within \SpecialChar LyX
22613 \begin_inset Flex Code
22616 \begin_layout Plain Layout
22622 for customizable parameters).
22623 It will be output as is after all \SpecialChar LaTeX
22625 \begin_inset Flex Code
22628 \begin_layout Plain Layout
22637 \begin_layout Description
22638 \begin_inset Flex Code
22641 \begin_layout Plain Layout
22648 \begin_inset Flex Code
22651 \begin_layout Plain Layout
22659 ] How the style should be translated into \SpecialChar LaTeX
22664 \begin_layout Plain Layout
22665 \begin_inset Flex Code
22668 \begin_layout Plain Layout
22674 is perhaps a bit misleading,
22675 since these rules apply to SGML classes too.
22676 Visit the SGML class files for specific examples.
22685 \begin_layout Description
22686 \begin_inset Flex Code
22689 \begin_layout Plain Layout
22695 means nothing special
22698 \begin_layout Description
22699 \begin_inset Flex Code
22702 \begin_layout Plain Layout
22709 \begin_inset Flex Code
22712 \begin_layout Plain Layout
22719 {\SpecialChar ldots
22728 \begin_layout Description
22729 \begin_inset Flex Code
22732 \begin_layout Plain Layout
22739 \begin_inset Flex Code
22742 \begin_layout Plain Layout
22749 }\SpecialChar ldots
22764 \begin_layout Standard
22765 Putting the last few things together,
22766 the \SpecialChar LaTeX
22767 output will be either:
22771 \begin_layout LyX-Code
22774 LatexName[LatexParam]{\SpecialChar ldots
22778 \begin_layout Standard
22783 \begin_layout LyX-Code
22786 begin{LatexName}[LatexParam] \SpecialChar ldots
22792 \begin_layout Standard
22793 depending upon the \SpecialChar LaTeX
22798 \begin_layout Description
22799 \begin_inset Flex Code
22802 \begin_layout Plain Layout
22809 \begin_inset Flex Code
22812 \begin_layout Plain Layout
22818 ] A string that is put at the beginning of the layout content.
22819 A line break in the output can be indicated by
22820 \begin_inset Flex Code
22823 \begin_layout Plain Layout
22832 \begin_layout Description
22833 \begin_inset Flex Code
22836 \begin_layout Plain Layout
22843 \begin_inset Flex Code
22846 \begin_layout Plain Layout
22854 \begin_inset Flex Code
22857 \begin_layout Plain Layout
22865 \change_deleted -584632292 1615846609
22867 \begin_inset Flex Code
22870 \begin_layout Plain Layout
22879 \begin_inset Flex Code
22882 \begin_layout Plain Layout
22888 (indicating a dummy definition ending definitions of charstyles,
22890 This entry is required in and is only meaningful for Flex insets.
22891 Among other things,
22892 it determines on which menu this inset will appear.
22894 \begin_inset Flex Code
22897 \begin_layout Plain Layout
22904 \begin_inset Flex Code
22907 \begin_layout Plain Layout
22913 will automatically set
22914 \begin_inset Flex Code
22917 \begin_layout Plain Layout
22924 \begin_inset Flex Code
22927 \begin_layout Plain Layout
22935 \begin_inset Flex Code
22938 \begin_layout Plain Layout
22944 can be set to true,
22946 \begin_inset Flex Code
22949 \begin_layout Plain Layout
22957 \begin_inset Flex Code
22960 \begin_layout Plain Layout
22966 insets by setting it
22971 \begin_inset Flex Code
22974 \begin_layout Plain Layout
22981 \change_inserted -712698321 1555575738
22985 \begin_layout Description
22987 \change_inserted -712698321 1555575844
22988 \begin_inset Flex Code
22991 \begin_layout Plain Layout
22993 \change_inserted -712698321 1555575740
23002 \begin_inset Flex Code
23005 \begin_layout Plain Layout
23007 \change_inserted -712698321 1555575740
23015 A dedicated string for the menu.
23016 You can define an accelerator by appending the respective character to the string,
23018 \begin_inset Quotes eld
23022 \begin_inset Quotes erd
23026 \begin_inset space \thinspace{}
23030 \begin_inset space \space{}
23034 \begin_inset Quotes eld
23038 \begin_inset Flex Code
23041 \begin_layout Plain Layout
23043 \change_inserted -712698321 1555575781
23052 \begin_inset Quotes erd
23056 This specification is optional.
23057 If it is not given the inset name as specified in the type declaration will be used instead for the menu.
23062 \begin_layout Description
23063 \begin_inset Flex Code
23066 \begin_layout Plain Layout
23073 \begin_inset Flex Code
23076 \begin_layout Plain Layout
23085 \begin_inset space \thinspace{}
23089 \begin_inset Flex Code
23092 \begin_layout Plain Layout
23098 ] Whether multiple paragraphs are permitted in this inset.
23100 \begin_inset Flex Code
23103 \begin_layout Plain Layout
23109 to the same value and
23110 \begin_inset Flex Code
23113 \begin_layout Plain Layout
23119 to the opposite value.
23120 These can be reset to other values,
23126 \begin_inset Flex Code
23129 \begin_layout Plain Layout
23139 \begin_layout Description
23140 \begin_inset Flex Code
23143 \begin_layout Plain Layout
23150 \begin_inset Flex Code
23153 \begin_layout Plain Layout
23162 \begin_inset space \thinspace{}
23166 \begin_inset Flex Code
23169 \begin_layout Plain Layout
23175 ] Whether fragile commands in this inset should be
23176 \begin_inset Flex Code
23179 \begin_layout Plain Layout
23193 whether the command should itself be protected.) Default is false.
23194 \change_inserted -712698321 1523633958
23198 \begin_layout Description
23200 \change_inserted -712698321 1552395786
23201 \begin_inset Flex Code
23204 \begin_layout Plain Layout
23206 \change_inserted -712698321 1523633961
23215 \begin_inset Flex Code
23218 \begin_layout Plain Layout
23220 \change_inserted -712698321 1523633958
23231 \begin_inset space \thinspace{}
23235 \begin_inset Flex Code
23238 \begin_layout Plain Layout
23240 \change_inserted -712698321 1523633958
23248 ] This causes macros that contain this inset to be protected with
23249 \begin_inset Flex Code
23252 \begin_layout Plain Layout
23254 \change_inserted -712698321 1523634038
23269 ) if necessary and thus allows (some) verbatim stuff in macros.
23273 \begin_layout Description
23275 \change_inserted -712698321 1555579651
23276 \begin_inset Flex Code
23279 \begin_layout Plain Layout
23281 \change_inserted -712698321 1552395787
23290 \begin_inset Flex Code
23293 \begin_layout Plain Layout
23295 \change_inserted -712698321 1552395787
23306 \begin_inset space \thinspace{}
23310 \begin_inset Flex Code
23313 \begin_layout Plain Layout
23315 \change_inserted -712698321 1552395787
23323 ] Whether specific commands in this inset (such as
23324 \begin_inset Flex Code
23327 \begin_layout Plain Layout
23329 \change_inserted -712698321 1552395787
23340 \begin_inset Flex Code
23343 \begin_layout Plain Layout
23345 \change_inserted -712698321 1552395787
23355 ) should be protected in an
23356 \begin_inset Flex Code
23359 \begin_layout Plain Layout
23361 \change_inserted -712698321 1552395787
23372 This is particularly needed for insets that draw on
23380 commands which parse their content in complex ways.
23384 \begin_layout Description
23386 \change_inserted -712698321 1555579742
23387 \begin_inset Flex Code
23390 \begin_layout Plain Layout
23392 \change_inserted -712698321 1555579658
23401 \begin_inset Flex Code
23404 \begin_layout Plain Layout
23406 \change_inserted -712698321 1555579651
23414 Option to define a different command (from the default
23415 \begin_inset Flex Code
23418 \begin_layout Plain Layout
23420 \change_inserted -712698321 1555579742
23432 ) to be used for line breaks.
23433 The initial backslash must not be specified.
23438 \begin_layout Description
23439 \begin_inset Flex Code
23442 \begin_layout Plain Layout
23449 \begin_inset Flex Code
23452 \begin_layout Plain Layout
23458 ] Deletes an existing
23459 \begin_inset Flex Code
23462 \begin_layout Plain Layout
23471 \begin_layout Description
23472 \begin_inset Flex Code
23475 \begin_layout Plain Layout
23482 \begin_inset Flex Code
23485 \begin_layout Plain Layout
23492 \begin_inset Flex Code
23495 \begin_layout Plain Layout
23501 that has replaced this
23502 \begin_inset Flex Code
23505 \begin_layout Plain Layout
23512 This is used to rename an
23513 \begin_inset Flex Code
23516 \begin_layout Plain Layout
23523 while keeping backward compatibility.
23524 \change_inserted -712698321 1559491850
23528 \begin_layout Description
23530 \change_inserted -712698321 1559492002
23531 \begin_inset Flex Code
23534 \begin_layout Plain Layout
23536 \change_inserted -712698321 1559491854
23545 \begin_inset Flex Code
23548 \begin_layout Plain Layout
23550 \change_inserted -712698321 1559491850
23561 \begin_inset space \thinspace{}
23565 \begin_inset Flex Code
23568 \begin_layout Plain Layout
23570 \change_inserted -712698321 1559491850
23578 ] If this is set to
23579 \begin_inset Flex Code
23582 \begin_layout Plain Layout
23584 \change_inserted -712698321 1559491881
23593 paragraph breaks will be ignored in the output.
23594 This might be useful for insets where the content should be alignable on different lines only in the \SpecialChar LyX
23596 without any effect in the output.
23601 \begin_layout Description
23602 \begin_inset Flex Code
23605 \begin_layout Plain Layout
23612 \begin_inset Flex Code
23615 \begin_layout Plain Layout
23624 \begin_inset space \thinspace{}
23628 \begin_inset Flex Code
23631 \begin_layout Plain Layout
23637 ] As with paragraph styles,
23639 \begin_inset CommandInset ref
23641 reference "subsec:Paragraph-Styles"
23650 \begin_layout Description
23651 \begin_inset Flex Code
23654 \begin_layout Plain Layout
23661 \begin_inset Flex Code
23664 \begin_layout Plain Layout
23673 \begin_inset space \thinspace{}
23677 \begin_inset Flex Code
23680 \begin_layout Plain Layout
23686 ] As with paragraph styles,
23688 \begin_inset CommandInset ref
23690 reference "subsec:Paragraph-Styles"
23699 \begin_layout Description
23700 \begin_inset Flex Code
23703 \begin_layout Plain Layout
23709 As with paragraph styles,
23711 \begin_inset CommandInset ref
23713 reference "subsec:Paragraph-Styles"
23721 \begin_layout Description
23722 \begin_inset Flex Code
23725 \begin_layout Plain Layout
23732 \begin_inset Flex Code
23735 \begin_layout Plain Layout
23741 ] The prefix to use when creating labels referring to insets of this type.
23742 This allows the use of formatted references.
23745 \begin_layout Description
23746 \begin_inset Flex Code
23749 \begin_layout Plain Layout
23756 \begin_inset Flex Code
23759 \begin_layout Plain Layout
23765 ] As with paragraph styles,
23767 \begin_inset CommandInset ref
23769 reference "subsec:Paragraph-Styles"
23777 \begin_layout Description
23778 \begin_inset Flex Code
23781 \begin_layout Plain Layout
23788 \begin_inset Flex Code
23791 \begin_layout Plain Layout
23800 \begin_inset space \thinspace{}
23804 \begin_inset Flex Code
23807 \begin_layout Plain Layout
23813 ] Resets the \SpecialChar LaTeX
23814 arguments of this layout (as defined via the
23815 \begin_inset Flex Code
23818 \begin_layout Plain Layout
23825 This is useful if you have copied a style via
23826 \begin_inset Flex Code
23829 \begin_layout Plain Layout
23836 but you do not want to inherit its (required and optional) arguments.
23839 \begin_layout Description
23840 \begin_inset Flex Code
23843 \begin_layout Plain Layout
23850 \begin_inset Flex Code
23853 \begin_layout Plain Layout
23862 \begin_inset space \thinspace{}
23866 \begin_inset Flex Code
23869 \begin_layout Plain Layout
23876 \change_inserted -712698321 1597733473
23878 \begin_inset Flex Code
23881 \begin_layout Plain Layout
23883 \change_inserted -712698321 1597732178
23892 font changes are redone inside the respective inset (in the output) even if the inset itself is in the context of this font changes (e.
23893 \begin_inset space \thinspace{}
23898 \begin_inset Flex Code
23901 \begin_layout Plain Layout
23903 \change_inserted -712698321 1597733683
23906 textbf{Sourrounding text
23910 textbf{content}}\SpecialChar ldots
23919 \begin_inset Flex Code
23922 \begin_layout Plain Layout
23924 \change_inserted -712698321 1597733686
23927 textbf{Sourrounding text
23929 myinset{content}\SpecialChar ldots
23938 Setting this makes sense for commands that internally reset font settings (e.
23939 \begin_inset space \thinspace{}
23944 Note that wrongly setting this might lead to unwanted result (e.
23945 \begin_inset space \thinspace{}
23950 \begin_inset Flex Code
23953 \begin_layout Plain Layout
23955 \change_inserted -712698321 1597733688
23958 emph{Sourrounding text
23962 emph{content}}\SpecialChar ldots
23971 content is upright,
23973 \begin_inset Flex Code
23976 \begin_layout Plain Layout
23978 \change_inserted -712698321 1597733278
23990 \change_deleted -712698321 1597733283
23991 Whether this inset should use the font of its surrounding environment or uses its own.
23995 \change_deleted -712698321 1597733290
23997 \change_inserted -712698321 1597733290
23999 \begin_inset Flex Code
24002 \begin_layout Plain Layout
24004 \change_inserted -712698321 1597733292
24016 \change_deleted -712698321 1597733327
24017 use the font of the surrounding environment
24018 \change_inserted -712698321 1597733343
24019 font changes are not redone inside the inset
24024 \begin_layout Description
24025 \begin_inset Flex Code
24028 \begin_layout Plain Layout
24035 \begin_inset Flex Code
24038 \begin_layout Plain Layout
24044 ] A string that is put at the end of the layout content.
24045 A line break in the output can be indicated by
24046 \begin_inset Flex Code
24049 \begin_layout Plain Layout
24058 \begin_layout Description
24059 \begin_inset Flex Code
24062 \begin_layout Plain Layout
24069 \begin_inset Flex Code
24072 \begin_layout Plain Layout
24079 \begin_inset space \thinspace{}
24083 \begin_inset Flex Code
24086 \begin_layout Plain Layout
24094 ] Allow spell-checking the contents of this inset.
24096 \change_inserted -584632292 1615846659
24100 \begin_layout Subsection
24102 \change_inserted -584632292 1615846729
24104 \begin_inset CommandInset label
24106 name "subsec:Arguments"
24113 \begin_layout Standard
24115 \change_inserted -584632292 1615846807
24116 Both paragraph styles and inset layouts allow for
24120 as well as the main content.
24121 This is especially useful for things like section headings and only makes sense with \SpecialChar LaTeX
24123 Each (optional or required) argument of a command or environment—
24124 except for the required argument that is associated with the content—
24125 has a separate definition,
24126 where the number specifies the order of the arguments.
24127 The definition must end with
24128 \begin_inset Flex Code
24131 \begin_layout Plain Layout
24133 \change_inserted -584632292 1615846730
24142 So a command with two optional arguments looks like:
24145 \begin_layout Quote
24147 \change_inserted -584632292 1615846730
24153 \begin_layout Quote
24155 \change_inserted -584632292 1615846730
24161 \begin_layout Quote
24163 \change_inserted -584632292 1615846730
24169 \begin_layout Quote
24171 \change_inserted -584632292 1615846730
24177 \begin_layout Quote
24179 \change_inserted -584632292 1615846730
24185 \begin_layout Quote
24187 \change_inserted -584632292 1615846730
24193 \begin_layout Standard
24195 \change_inserted -584632292 1615846730
24197 \begin_inset Flex Code
24200 \begin_layout Plain Layout
24202 \change_inserted -584632292 1615846730
24211 the following specifications are possible:
24214 \begin_layout Itemize
24216 \change_inserted -584632292 1615846730
24217 \begin_inset Flex Code
24220 \begin_layout Plain Layout
24222 \change_inserted -584632292 1615846730
24231 \begin_inset Flex Code
24234 \begin_layout Plain Layout
24236 \change_inserted -584632292 1615846730
24244 The string that will appear both in the menu (to insert this argument) and on the argument inset button (unless you also specify a separate
24245 \begin_inset Flex Code
24248 \begin_layout Plain Layout
24250 \change_inserted -584632292 1615846730
24260 you can define an accelerator by appending the respective character to the string,
24262 \begin_inset Quotes eld
24266 \begin_inset Quotes erd
24270 \begin_inset space \thinspace{}
24274 \begin_inset space \space{}
24278 \begin_inset Quotes eld
24282 \begin_inset Flex Code
24285 \begin_layout Plain Layout
24287 \change_inserted -584632292 1615846730
24296 \begin_inset Quotes erd
24302 \begin_layout Itemize
24304 \change_inserted -584632292 1615846730
24305 \begin_inset Flex Code
24308 \begin_layout Plain Layout
24310 \change_inserted -584632292 1615846730
24319 \begin_inset Flex Code
24322 \begin_layout Plain Layout
24324 \change_inserted -584632292 1615846730
24332 A separate string for the menu.
24333 You can define an accelerator by appending the respective character to the string,
24335 \begin_inset Quotes eld
24339 \begin_inset Quotes erd
24343 \begin_inset space \thinspace{}
24347 \begin_inset space \space{}
24351 \begin_inset Quotes eld
24355 \begin_inset Flex Code
24358 \begin_layout Plain Layout
24360 \change_inserted -584632292 1615846730
24369 \begin_inset Quotes erd
24373 This specification is optional.
24374 If it is not given the
24375 \begin_inset Flex Code
24378 \begin_layout Plain Layout
24380 \change_inserted -584632292 1615846730
24388 will be used instead for the menu.
24391 \begin_layout Itemize
24393 \change_inserted -584632292 1615846730
24394 \begin_inset Flex Code
24397 \begin_layout Plain Layout
24399 \change_inserted -584632292 1615846730
24408 \begin_inset Flex Code
24411 \begin_layout Plain Layout
24413 \change_inserted -584632292 1615846730
24421 A longer explanatory text that appears in the tooltip when hovering over the argument inset.
24424 \begin_layout Itemize
24426 \change_inserted -584632292 1615846730
24427 \begin_inset Flex Code
24430 \begin_layout Plain Layout
24432 \change_inserted -584632292 1615846730
24441 \begin_inset Flex Code
24444 \begin_layout Plain Layout
24446 \change_inserted -584632292 1615846730
24457 \begin_inset space \thinspace{}
24461 \begin_inset Flex Code
24464 \begin_layout Plain Layout
24466 \change_inserted -584632292 1615846730
24474 ] Declare if this is a mandatory (1) or an optional (0) argument.
24475 Mandatory arguments will be output empty if not given,
24476 while optional arguments will not be output at all.
24478 mandatory arguments are delimited by
24479 \begin_inset Flex Code
24482 \begin_layout Plain Layout
24484 \change_inserted -584632292 1615846730
24493 while optional arguments are delimited by
24494 \begin_inset Flex Code
24497 \begin_layout Plain Layout
24499 \change_inserted -584632292 1615846730
24510 \begin_layout Itemize
24512 \change_inserted -584632292 1615846730
24513 \begin_inset Flex Code
24516 \begin_layout Plain Layout
24518 \change_inserted -584632292 1615846730
24527 \begin_inset Flex Code
24530 \begin_layout Plain Layout
24532 \change_inserted -584632292 1615846730
24540 Option to define a different command (from the default
24541 \begin_inset Flex Code
24544 \begin_layout Plain Layout
24546 \change_inserted -584632292 1615846730
24558 ) to be used for line breaks.
24559 The initial backslash must not be specified.
24562 \begin_layout Itemize
24564 \change_inserted -584632292 1615846730
24565 \begin_inset Flex Code
24568 \begin_layout Plain Layout
24570 \change_inserted -584632292 1615846730
24579 \begin_inset Flex Code
24582 \begin_layout Plain Layout
24584 \change_inserted -584632292 1615846730
24592 defines another argument
24593 \change_inserted -712698321 1699562312
24595 \change_inserted -584632292 1615846730
24597 \change_deleted -712698321 1699562317
24599 \change_inserted -712698321 1699562318
24601 \change_inserted -584632292 1615846730
24602 number) which this argument requires to be output if it is itself output.
24604 \begin_inset space \thinspace{}
24608 in \SpecialChar LaTeX
24610 optional arguments often require previous optional arguments to be output (at least empty),
24612 \begin_inset Flex Code
24615 \begin_layout Plain Layout
24617 \change_inserted -584632292 1615846730
24620 command[][argument]{text}
24628 This can be achieved by the statement
24629 \begin_inset Flex Code
24632 \begin_layout Plain Layout
24634 \change_inserted -584632292 1615846730
24643 \begin_inset Flex Code
24646 \begin_layout Plain Layout
24648 \change_inserted -584632292 1615846730
24658 \change_inserted -712698321 1699562142
24659 If multiple arguments are required,
24660 separate them by comma (e.g.,
24662 \begin_inset Flex Code
24665 \begin_layout Plain Layout
24667 \change_inserted -712698321 1699562142
24680 \begin_layout Itemize
24682 \change_inserted -584632292 1615846730
24683 \begin_inset Flex Code
24686 \begin_layout Plain Layout
24688 \change_inserted -584632292 1615846730
24697 \begin_inset Flex Code
24700 \begin_layout Plain Layout
24702 \change_inserted -584632292 1615846730
24710 defines a custom left delimiter (instead of
24711 \begin_inset Flex Code
24714 \begin_layout Plain Layout
24716 \change_inserted -584632292 1615846730
24725 \begin_inset Flex Code
24728 \begin_layout Plain Layout
24730 \change_inserted -584632292 1615846730
24739 A line break in the output can be indicated by
24740 \begin_inset Flex Code
24743 \begin_layout Plain Layout
24745 \change_inserted -584632292 1615846730
24756 \begin_layout Itemize
24758 \change_inserted -584632292 1615846730
24759 \begin_inset Flex Code
24762 \begin_layout Plain Layout
24764 \change_inserted -584632292 1615846730
24773 \begin_inset Flex Code
24776 \begin_layout Plain Layout
24778 \change_inserted -584632292 1615846730
24786 defines a custom right delimiter (instead of
24787 \begin_inset Flex Code
24790 \begin_layout Plain Layout
24792 \change_inserted -584632292 1615846730
24801 \begin_inset Flex Code
24804 \begin_layout Plain Layout
24806 \change_inserted -584632292 1615846730
24815 A line break in the output can be indicated by
24816 \begin_inset Flex Code
24819 \begin_layout Plain Layout
24821 \change_inserted -584632292 1615846730
24832 \begin_layout Itemize
24834 \change_inserted -584632292 1615846730
24835 \begin_inset Flex Code
24838 \begin_layout Plain Layout
24840 \change_inserted -584632292 1615846730
24849 \begin_inset Flex Code
24852 \begin_layout Plain Layout
24854 \change_inserted -584632292 1615846730
24862 defines an argument that is inserted if and only if no user-specified arguments were given,
24864 \begin_inset space \thinspace{}
24868 \begin_inset space \space{}
24871 if no argument inset has been inserted (note that also an empty argument inset omits the DefaultArg).
24872 Multiple arguments need to be separated by comma.
24875 \begin_layout Itemize
24877 \change_inserted -584632292 1615846730
24878 \begin_inset Flex Code
24881 \begin_layout Plain Layout
24883 \change_inserted -584632292 1615846730
24892 \begin_inset Flex Code
24895 \begin_layout Plain Layout
24897 \change_inserted -584632292 1615846730
24905 defines an argument that is inserted in any case (alone or in addition to user-specified arguments).
24906 Multiple arguments need to be separated by comma.
24909 \begin_layout Itemize
24911 \change_inserted -584632292 1615846730
24912 \begin_inset Flex Code
24915 \begin_layout Plain Layout
24917 \change_inserted -584632292 1615846730
24925 The font used for the argument content,
24927 \begin_inset CommandInset ref
24929 reference "subsec:Font-description"
24937 \begin_layout Itemize
24939 \change_inserted -584632292 1615846730
24940 \begin_inset Flex Code
24943 \begin_layout Plain Layout
24945 \change_inserted -584632292 1615846730
24954 \begin_inset Flex Code
24957 \begin_layout Plain Layout
24959 \change_inserted -584632292 1615846730
24970 \begin_inset space \thinspace{}
24974 \begin_inset Flex Code
24977 \begin_layout Plain Layout
24979 \change_inserted -584632292 1615846730
24987 ] As with paragraph styles,
24989 \begin_inset CommandInset ref
24991 reference "subsec:Paragraph-Styles"
24999 \begin_layout Itemize
25001 \change_inserted -584632292 1615846730
25002 \begin_inset Flex Code
25005 \begin_layout Plain Layout
25007 \change_inserted -584632292 1615846730
25015 The font used for the label;
25017 \begin_inset CommandInset ref
25019 reference "subsec:Font-description"
25027 \begin_layout Itemize
25029 \change_inserted -584632292 1615846730
25030 \begin_inset Flex Code
25033 \begin_layout Plain Layout
25035 \change_inserted -584632292 1615846730
25044 \begin_inset Flex Code
25047 \begin_layout Plain Layout
25049 \change_inserted -584632292 1615846730
25063 ] describes the rendering style used for the inset's frame and buttons.
25066 \begin_layout Itemize
25068 \change_inserted -584632292 1615846730
25069 \begin_inset Flex Code
25072 \begin_layout Plain Layout
25074 \change_inserted -584632292 1615846730
25083 \begin_inset Flex Code
25086 \begin_layout Plain Layout
25088 \change_inserted -584632292 1615846730
25097 \begin_inset Flex Code
25100 \begin_layout Plain Layout
25102 \change_inserted -584632292 1615846730
25111 this argument is automatically inserted when the respective style is selected.
25114 \begin_layout Itemize
25116 \change_inserted -584632292 1615846730
25117 \begin_inset Flex Code
25120 \begin_layout Plain Layout
25122 \change_inserted -584632292 1615846730
25131 \begin_inset Flex Code
25134 \begin_layout Plain Layout
25136 \change_inserted -584632292 1615846730
25145 \begin_inset Flex Code
25148 \begin_layout Plain Layout
25150 \change_inserted -584632292 1615846730
25159 this argument will be inserted on a new line with
25160 \begin_inset Flex Code
25163 \begin_layout Plain Layout
25165 \change_inserted -584632292 1615846730
25173 (only available within Flex insets).
25176 \begin_layout Itemize
25178 \change_inserted -584632292 1615846730
25179 \begin_inset Flex Code
25182 \begin_layout Plain Layout
25184 \change_inserted -584632292 1615846730
25193 \begin_inset Flex Code
25196 \begin_layout Plain Layout
25198 \change_inserted -584632292 1615846730
25207 \begin_inset Flex Code
25210 \begin_layout Plain Layout
25212 \change_inserted -584632292 1615846730
25221 this argument will be inserted with a copy of the co-text (either selected text or the whole paragraph) as content.
25224 \begin_layout Itemize
25226 \change_inserted -584632292 1615846730
25227 \begin_inset Flex Code
25230 \begin_layout Plain Layout
25232 \change_inserted -584632292 1615846730
25241 \begin_inset Flex Code
25244 \begin_layout Plain Layout
25246 \change_inserted -584632292 1615846730
25260 ] Whether the contents of this argument should be output in raw form,
25261 meaning without special translations that \SpecialChar LaTeX
25265 \begin_inset Flex Code
25268 \begin_layout Plain Layout
25270 \change_inserted -584632292 1615846730
25278 status is inherited by the inset or paragraph layout the argument belongs to,
25279 true and false change the status for the given argument only.
25282 \begin_layout Itemize
25284 \change_inserted -584632292 1615846730
25285 \begin_inset Flex Code
25288 \begin_layout Plain Layout
25290 \change_inserted -584632292 1615846730
25299 \begin_inset Flex Code
25302 \begin_layout Plain Layout
25304 \change_inserted -584632292 1615846730
25305 string of characters
25316 Defines individual characters
25317 \begin_inset Newline linebreak
25320 that should be output in raw form,
25321 meaning without special translations that \SpecialChar LaTeX
25324 contrary to PassThru,
25325 this needs to be explicitly defined for arguments.
25327 arguments do not inherit PassThruChars from their parent inset or layout.
25330 \begin_layout Itemize
25332 \change_inserted -584632292 1615846730
25333 \begin_inset Flex Code
25336 \begin_layout Plain Layout
25338 \change_inserted -584632292 1615846730
25347 \begin_inset Flex Code
25350 \begin_layout Plain Layout
25352 \change_inserted -584632292 1615846730
25363 \begin_inset space \thinspace{}
25367 \begin_inset Flex Code
25370 \begin_layout Plain Layout
25372 \change_inserted -584632292 1615846730
25380 ] If this is set to 1,
25381 the argument will output its content in the corresponding item in the table of contents.
25385 \begin_layout Standard
25387 \change_inserted -584632292 1615846730
25389 the text entered in the \SpecialChar LyX
25390 workarea in the respective layout is the last (mandatory) argument of a command if the
25391 \begin_inset Flex Code
25394 \begin_layout Plain Layout
25396 \change_inserted -584632292 1615846730
25405 \begin_inset Flex Code
25408 \begin_layout Plain Layout
25410 \change_inserted -584632292 1615846730
25420 arguments with the prefix
25421 \begin_inset Flex Code
25424 \begin_layout Plain Layout
25426 \change_inserted -584632292 1615846730
25434 are output after this workarea argument.
25435 Note that post-argument numbering restarts at 1,
25436 so the first argument following the workarea argument is
25437 \begin_inset Flex Code
25440 \begin_layout Plain Layout
25442 \change_inserted -584632292 1615846730
25451 Post-arguments are ignored in any other
25452 \begin_inset Flex Code
25455 \begin_layout Plain Layout
25457 \change_inserted -584632292 1615846730
25466 \begin_inset Flex Code
25469 \begin_layout Plain Layout
25471 \change_inserted -584632292 1615846730
25482 \begin_layout Standard
25484 \change_inserted -584632292 1615846730
25486 \begin_inset Flex Code
25489 \begin_layout Plain Layout
25491 \change_inserted -584632292 1615846730
25502 \begin_inset Flex Code
25505 \begin_layout Plain Layout
25507 \change_inserted -584632292 1615846730
25518 \begin_inset Flex Code
25521 \begin_layout Plain Layout
25523 \change_inserted -584632292 1615846730
25531 followed by the number (e.
25532 \begin_inset space \thinspace{}
25536 \begin_inset space \space{}
25540 \begin_inset Flex Code
25543 \begin_layout Plain Layout
25545 \change_inserted -584632292 1615846730
25556 \begin_layout Standard
25558 \change_inserted -584632292 1615846730
25560 there is a special argument type with the prefix
25561 \begin_inset Flex Code
25564 \begin_layout Plain Layout
25566 \change_inserted -584632292 1615846730
25575 It is not really an argument,
25576 but uses the argument interface (thus,
25577 the prefix is also followed by a number,
25579 \begin_inset space \thinspace{}
25584 \begin_inset Flex Code
25587 \begin_layout Plain Layout
25589 \change_inserted -584632292 1615846730
25590 Argument listpreamble:1
25598 As the name implies,
25599 it is targeted at lists such as
25619 Its content will be output at the list start,
25621 \begin_inset Flex Code
25624 \begin_layout Plain Layout
25626 \change_inserted -584632292 1615846730
25637 on an own line (a place that is otherwise not accessible in \SpecialChar LyX
25640 users can insert redefinitions (of lengths etc.) to individual lists.
25642 these arguments do not have a delimiter.
25647 \begin_layout Subsection
25649 \begin_inset CommandInset label
25651 name "subsec:Counters"
25658 \begin_layout Standard
25659 It is necessary to define the counters (
25660 \begin_inset Flex Noun
25663 \begin_layout Plain Layout
25671 \begin_inset Flex Noun
25674 \begin_layout Plain Layout
25682 ) in the text class itself.
25683 The standard counters are defined in the file
25684 \begin_inset Flex Code
25687 \begin_layout Plain Layout
25694 so you may have to do no more than add
25697 \begin_layout LyX-Code
25698 Input stdcounters.inc
25701 \begin_layout Standard
25702 to your layout file to get them to work.
25703 But if you want to define custom counters,
25704 then you can do so.
25705 The counter declaration must begin with:
25708 \begin_layout LyX-Code
25709 Counter CounterName
25712 \begin_layout Standard
25714 \begin_inset Flex Code
25717 \begin_layout Plain Layout
25723 ' is replaced by the name of the counter.
25724 And it must end with
25725 \begin_inset Quotes eld
25729 \begin_inset Flex Code
25732 \begin_layout Plain Layout
25739 \begin_inset Quotes erd
25743 The following parameters can also be used:
25746 \begin_layout Description
25747 \begin_inset Flex Code
25750 \begin_layout Plain Layout
25757 \begin_inset Flex Code
25760 \begin_layout Plain Layout
25766 ] Sets the initial value for the counter,
25767 to which it will be reset whenever that happens.
25769 one will want the default,
25773 \begin_layout Description
25774 \begin_inset Flex Code
25777 \begin_layout Plain Layout
25784 \begin_inset Flex Code
25787 \begin_layout Plain Layout
25794 \begin_inset Quotes erd
25798 \begin_inset Quotes erd
25802 this string defines how the counter is displayed.
25803 Setting this value sets
25804 \begin_inset Flex Code
25807 \begin_layout Plain Layout
25808 LabelStringAppendix
25814 The following special constructs can be used in the string:
25818 \begin_layout Itemize
25819 \begin_inset Flex Code
25822 \begin_layout Plain Layout
25830 will be replaced by the expansion of the
25831 \begin_inset Flex Code
25834 \begin_layout Plain Layout
25841 \begin_inset Flex Code
25844 \begin_layout Plain Layout
25845 LabelStringAppendix
25851 \begin_inset Flex Code
25854 \begin_layout Plain Layout
25864 \begin_layout Itemize
25865 counter values can be expressed using \SpecialChar LaTeX
25867 \begin_inset Newline newline
25871 \begin_inset Flex Code
25874 \begin_layout Plain Layout
25892 \begin_inset Flex Code
25895 \begin_layout Plain Layout
25907 \begin_layout Plain Layout
25918 the situation is a bit more complicated:
25938 other than those described below will produce arabic numerals.
25939 It would not be surprising to see this change in the future.
25945 \begin_inset Flex Code
25948 \begin_layout Plain Layout
25957 3,\SpecialChar ldots
25960 \begin_inset Flex Code
25963 \begin_layout Plain Layout
25969 for lower-case letters:
25976 \begin_inset Flex Code
25979 \begin_layout Plain Layout
25985 for upper-case letters:
25992 \begin_inset Flex Code
25995 \begin_layout Plain Layout
26001 for lower-case roman numerals:
26008 \begin_inset Flex Code
26011 \begin_layout Plain Layout
26017 for upper-case roman numerals:
26020 III\SpecialChar ldots
26023 \begin_inset Flex Code
26026 \begin_layout Plain Layout
26032 for hebrew numerals.
26036 \begin_layout Standard
26037 If LabelString is not defined,
26038 a default value is constructed as follows:
26039 if the counter has a
26040 \change_deleted 731793113 1604355218
26042 \change_inserted 731793113 1604355221
26046 \begin_inset Flex Code
26049 \begin_layout Plain Layout
26051 \change_deleted 731793113 1604355223
26053 \change_inserted 731793113 1604355226
26062 \begin_inset Flex Code
26065 \begin_layout Plain Layout
26073 \begin_inset Newline newline
26077 \begin_inset Flex Code
26080 \begin_layout Plain Layout
26084 \change_inserted 731793113 1604355228
26086 \change_deleted 731793113 1604355230
26097 otherwise the string
26098 \begin_inset Flex Code
26101 \begin_layout Plain Layout
26112 \begin_layout Description
26113 \begin_inset Flex Code
26116 \begin_layout Plain Layout
26117 LabelStringAppendix
26123 \begin_inset Flex Code
26126 \begin_layout Plain Layout
26133 \begin_inset Quotes eld
26137 \begin_inset Quotes erd
26141 \begin_inset Flex Code
26144 \begin_layout Plain Layout
26151 but for use in the Appendix.
26152 \change_inserted -584632292 1607202551
26156 \begin_layout Description
26158 \change_inserted -584632292 1607202682
26159 \begin_inset Flex Code
26162 \begin_layout Plain Layout
26169 \begin_inset Flex Code
26172 \begin_layout Plain Layout
26174 \change_inserted -584632292 1607202576
26183 \begin_inset Quotes eld
26187 \begin_inset Quotes erd
26190 ] The counter name as used in \SpecialChar LaTeX
26193 \change_inserted 34634807 1619711355
26195 \change_deleted 34634807 1619711355
26197 \change_inserted -584632292 1607202682
26199 in \SpecialChar LyX
26201 there is a counter named `theorem',
26202 but it is output to \SpecialChar LaTeX
26208 \begin_layout Description
26209 \begin_inset Flex Code
26212 \begin_layout Plain Layout
26219 \begin_inset Flex Code
26222 \begin_layout Plain Layout
26229 \begin_inset Quotes erd
26233 \begin_inset Quotes erd
26236 ] A format for use with formatted references to this counter.
26238 one might want to have references to section numbers appear as
26239 \begin_inset Quotes eld
26243 \begin_inset Quotes erd
26248 \change_deleted -584632292 1690588038
26250 \change_inserted -584632292 1690588041
26254 \begin_inset Quotes eld
26258 \begin_inset Quotes erd
26262 \change_inserted -584632292 1690588059
26263 or a counter specification as in
26264 \begin_inset Flex Code
26267 \begin_layout Plain Layout
26269 \change_inserted -584632292 1690588059
26281 \change_inserted -584632292 1690588078
26283 \change_deleted -584632292 1690588076
26286 will be replaced by the counter number itself.
26291 \change_inserted -584632292 1690588159
26295 \change_deleted -712698321 1691671418
26301 \change_inserted -712698321 1691671418
26303 \begin_inset Flex Code
26306 \begin_layout Plain Layout
26308 \change_inserted -712698321 1691671418
26321 \change_inserted -584632292 1690588159
26322 (which might render as §2.7)
26325 \change_inserted -584632292 1690587966
26329 \begin_layout Description
26331 \change_inserted -584632292 1690588264
26332 \begin_inset Flex Code
26335 \begin_layout Plain Layout
26337 \change_inserted -584632292 1690587970
26346 \begin_inset Flex Code
26349 \begin_layout Plain Layout
26351 \change_inserted -584632292 1690587966
26361 \begin_inset Flex Code
26364 \begin_layout Plain Layout
26366 \change_inserted -584632292 1690587981
26374 ] For use with `formatted references',
26375 specifically when a single counter is used with multiple sorts of styles.
26378 \begin_inset Flex Code
26381 \begin_layout Plain Layout
26383 \change_inserted -584632292 1690588222
26391 counter is often used for all sorts of theorem-like environments:
26395 \change_deleted -712698321 1691671691
26397 \change_inserted -584632292 1690588264
26399 The first argument gives a prefix used in the labels (e.g.,
26401 \begin_inset Quotes eld
26405 \begin_inset Quotes erd
26409 \begin_inset Quotes eld
26413 \begin_inset Quotes erd
26417 and the second a formatting string,
26419 \begin_inset Flex Code
26422 \begin_layout Plain Layout
26424 \change_inserted -584632292 1690588181
26433 \begin_inset Flex Code
26436 \begin_layout Plain Layout
26438 \change_inserted -584632292 1690588177
26447 If this is not given,
26449 \begin_inset Flex Code
26452 \begin_layout Plain Layout
26454 \change_inserted -584632292 1690588264
26465 \begin_layout Description
26466 \begin_inset Flex Code
26469 \begin_layout Plain Layout
26476 \begin_inset Flex Code
26479 \begin_layout Plain Layout
26486 \begin_inset Quotes erd
26490 \begin_inset Quotes erd
26493 ] If this is set to the name of another counter,
26494 the present counter will be reset every time the other one is increased.
26497 \begin_inset Flex Code
26500 \begin_layout Plain Layout
26507 \begin_inset Flex Code
26510 \begin_layout Plain Layout
26519 \begin_layout Subsection
26521 \begin_inset CommandInset label
26523 name "subsec:Font-description"
26530 \begin_layout Standard
26531 A font description looks like this:
26534 \begin_layout LyX-Code
26551 \begin_layout LyX-Code
26555 \begin_layout LyX-Code
26559 \begin_layout Standard
26560 The following commands are available:
26563 \begin_layout Description
26564 \begin_inset Flex Code
26567 \begin_layout Plain Layout
26574 \change_deleted -712698321 1607682984
26576 \begin_inset Flex Code
26579 \begin_layout Plain Layout
26589 \begin_inset Flex Code
26592 \begin_layout Plain Layout
26600 \begin_inset Flex Code
26603 \begin_layout Plain Layout
26611 \begin_inset Flex Code
26614 \begin_layout Plain Layout
26622 \begin_inset Flex Code
26625 \begin_layout Plain Layout
26633 \begin_inset Flex Code
26636 \begin_layout Plain Layout
26644 \begin_inset Flex Code
26647 \begin_layout Plain Layout
26655 \begin_inset Flex Code
26658 \begin_layout Plain Layout
26666 \begin_inset Flex Code
26669 \begin_layout Plain Layout
26677 \begin_inset Flex Code
26680 \begin_layout Plain Layout
26688 \begin_inset Flex Code
26691 \begin_layout Plain Layout
26699 \begin_inset Flex Code
26702 \begin_layout Plain Layout
26710 \begin_inset Flex Code
26713 \begin_layout Plain Layout
26721 \begin_inset Flex Code
26724 \begin_layout Plain Layout
26732 \begin_inset Flex Code
26735 \begin_layout Plain Layout
26743 \begin_inset Flex Code
26746 \begin_layout Plain Layout
26754 \begin_inset Flex Code
26757 \begin_layout Plain Layout
26765 \begin_inset Flex Code
26768 \begin_layout Plain Layout
26776 \begin_inset Flex Code
26779 \begin_layout Plain Layout
26787 \begin_inset Flex Code
26790 \begin_layout Plain Layout
26797 \change_inserted -712698321 1607683139
26799 \begin_inset Flex Code
26802 \begin_layout Plain Layout
26804 \change_inserted -712698321 1607683135
26813 \begin_inset space ~
26817 \begin_inset CommandInset ref
26819 reference "chap:Names-of-colors"
26828 \change_deleted -712698321 1607683144
26830 \change_inserted -712698321 1607683146
26836 \begin_layout Description
26837 \begin_inset Flex Code
26840 \begin_layout Plain Layout
26847 \begin_inset Flex Code
26850 \begin_layout Plain Layout
26860 \begin_inset Flex Code
26863 \begin_layout Plain Layout
26871 \begin_inset Flex Code
26874 \begin_layout Plain Layout
26883 \begin_layout Description
26884 \begin_inset Flex Code
26887 \begin_layout Plain Layout
26894 \begin_inset Flex Code
26897 \begin_layout Plain Layout
26903 ] Valid arguments are:
26905 \begin_inset Flex Code
26908 \begin_layout Plain Layout
26916 \begin_inset Flex Code
26919 \begin_layout Plain Layout
26927 \begin_inset Flex Code
26930 \begin_layout Plain Layout
26938 \begin_inset Flex Code
26941 \begin_layout Plain Layout
26949 \begin_inset Flex Code
26952 \begin_layout Plain Layout
26960 \begin_inset Flex Code
26963 \begin_layout Plain Layout
26971 \begin_inset Flex Code
26974 \begin_layout Plain Layout
26982 \begin_inset Flex Code
26985 \begin_layout Plain Layout
26993 \begin_inset Flex Code
26996 \begin_layout Plain Layout
27004 \begin_inset Flex Code
27007 \begin_layout Plain Layout
27015 \begin_inset Flex Code
27018 \begin_layout Plain Layout
27025 \begin_inset Flex Code
27028 \begin_layout Plain Layout
27035 Each of these turns on or off the corresponding attribute.
27038 \begin_inset Flex Code
27041 \begin_layout Plain Layout
27049 \begin_inset Flex Code
27052 \begin_layout Plain Layout
27060 \begin_inset Newline newline
27063 If the latter seems puzzling,
27064 remember that the font settings for the present context are generally inherited from the surrounding context.
27066 \begin_inset Flex Code
27069 \begin_layout Plain Layout
27075 would turn off the emphasis that was anyway in effect,
27077 in a theorem environment.
27080 \begin_layout Description
27081 \begin_inset Flex Code
27084 \begin_layout Plain Layout
27091 \begin_inset Flex Code
27094 \begin_layout Plain Layout
27104 \begin_inset Flex Code
27107 \begin_layout Plain Layout
27116 \begin_layout Description
27117 \begin_inset Flex Code
27120 \begin_layout Plain Layout
27127 \begin_inset Flex Code
27130 \begin_layout Plain Layout
27140 \begin_inset Flex Code
27143 \begin_layout Plain Layout
27151 \begin_inset Flex Code
27154 \begin_layout Plain Layout
27162 \begin_inset Flex Code
27165 \begin_layout Plain Layout
27174 \begin_layout Description
27175 \begin_inset Flex Code
27178 \begin_layout Plain Layout
27185 \begin_inset Flex Code
27188 \begin_layout Plain Layout
27196 \begin_inset Flex Code
27199 \begin_layout Plain Layout
27207 \begin_inset Flex Code
27210 \begin_layout Plain Layout
27220 \begin_inset Flex Code
27223 \begin_layout Plain Layout
27231 \begin_inset Flex Code
27234 \begin_layout Plain Layout
27242 \begin_inset Flex Code
27245 \begin_layout Plain Layout
27253 \begin_inset Flex Code
27256 \begin_layout Plain Layout
27264 \begin_inset Flex Code
27267 \begin_layout Plain Layout
27276 \begin_layout Subsection
27277 \begin_inset CommandInset label
27279 name "subsec:Citation-engine-description"
27283 Cite engine description
27286 \begin_layout Standard
27288 \begin_inset Flex Code
27291 \begin_layout Plain Layout
27298 as used mainly in cite engine files (see
27299 \begin_inset CommandInset ref
27301 reference "subsec:Cite-Engine-Files"
27310 define the citation commands provided by a specific
27311 \begin_inset Quotes eld
27315 \begin_inset Quotes erd
27320 in \SpecialChar LyX
27322 is way specific way to format citations,
27324 author names and/or years.
27327 supports three such engine types,
27331 \begin_layout Enumerate
27332 \begin_inset Flex Code
27335 \begin_layout Plain Layout
27342 the default Bib\SpecialChar TeX
27343 way to format citations,
27344 a simple numeric style (e.
27345 \begin_inset space \thinspace{}
27350 \begin_inset Quotes eld
27354 \begin_inset Quotes erd
27360 \begin_layout Enumerate
27361 \begin_inset Flex Code
27364 \begin_layout Plain Layout
27371 Harvard-styled citations using author names and publication year (e.
27372 \begin_inset space \thinspace{}
27377 \begin_inset Quotes eld
27380 Smith and Miller (2017b)
27381 \begin_inset Quotes erd
27387 \begin_layout Enumerate
27388 \begin_inset Flex Code
27391 \begin_layout Plain Layout
27398 extended numerical citations that also allow for author or title next to the number (e.
27399 \begin_inset space \thinspace{}
27404 \begin_inset Quotes eld
27407 Smith and Miller [1]
27408 \begin_inset Quotes erd
27414 \begin_layout Standard
27415 \begin_inset Flex Code
27418 \begin_layout Plain Layout
27424 blocks look like this:
27427 \begin_layout LyX-Code
27431 \begin_layout LyX-Code
27435 \begin_layout LyX-Code
27439 \begin_layout LyX-Code
27440 citeyearpar[][]=parencite*
27443 \begin_layout LyX-Code
27447 \begin_layout LyX-Code
27451 \begin_layout Standard
27453 \begin_inset Flex Code
27456 \begin_layout Plain Layout
27462 denotes the engine.
27463 The individual lines respectively define a cite command or cite command paradigm supported by this engine.
27464 The line can be as simple as a cite command that is used both to name the respective \SpecialChar LyX
27465 command and the \SpecialChar LaTeX
27466 output or more complex in order to differentiate things.
27467 The full syntax is:
27470 \begin_layout LyX-Code
27471 LyXName|alias$*<!_stardesc!_stardesctooltip>[][]=latexcmd
27474 \begin_layout Itemize
27475 \begin_inset Flex Code
27478 \begin_layout Plain Layout
27485 The name as used in the
27486 \begin_inset Flex Code
27489 \begin_layout Plain Layout
27499 \begin_layout Standard
27500 For portability reasons,
27501 we try to use the same name for same-formatted commands in different cite packages (thus many names stem from natbib,
27502 and thus we need to differentiate a
27503 \begin_inset Flex Code
27506 \begin_layout Plain Layout
27513 if the \SpecialChar LaTeX
27514 command names differ).
27518 \begin_layout Itemize
27519 \begin_inset Flex Code
27522 \begin_layout Plain Layout
27529 a (comma-separated) list of commands that fall back to the given
27530 \begin_inset Flex Code
27533 \begin_layout Plain Layout
27539 in the current engine.
27540 This eases the switch of citation packages and engines.
27542 \begin_inset Flex Code
27545 \begin_layout Plain Layout
27552 \begin_inset Flex Code
27555 \begin_layout Plain Layout
27561 in layout definitions.
27564 \begin_layout Itemize
27565 \begin_inset Flex Code
27568 \begin_layout Plain Layout
27575 The actual \SpecialChar LaTeX
27576 command that is output.
27580 \begin_layout Standard
27581 \begin_inset Flex Code
27584 \begin_layout Plain Layout
27591 \begin_inset Flex Code
27594 \begin_layout Plain Layout
27602 \begin_inset Flex Code
27605 \begin_layout Plain Layout
27613 \begin_inset Flex Code
27616 \begin_layout Plain Layout
27622 will be output to \SpecialChar LaTeX
27626 \begin_layout Standard
27630 \begin_layout Itemize
27631 Capitalization indicates that the command also has a capitalized form (
27632 \begin_inset Flex Code
27635 \begin_layout Plain Layout
27645 \begin_inset Flex Code
27648 \begin_layout Plain Layout
27657 These usually enforce up-casing of name prefixes (
27662 \begin_inset Formula $\Rightarrow$
27672 \begin_layout Itemize
27674 \begin_inset Flex Code
27677 \begin_layout Plain Layout
27683 indicate the number of optional arguments (there can be 0–2).
27686 \begin_layout Itemize
27688 \begin_inset Flex Code
27691 \begin_layout Plain Layout
27697 indicates there is a starred version of the command (
27698 \begin_inset Flex Code
27701 \begin_layout Plain Layout
27711 \begin_inset Flex Code
27714 \begin_layout Plain Layout
27727 \begin_layout Standard
27729 the starred version means:
27730 Output all authors even if it should be shortened with
27731 \begin_inset Quotes eld
27735 \begin_inset Quotes erd
27739 \begin_inset Flex Code
27742 \begin_layout Plain Layout
27751 \begin_layout Standard
27752 If the star has a different meaning for a given command,
27753 it can be specified in angle brackets:
27755 \begin_inset Flex Code
27758 \begin_layout Plain Layout
27759 <!_stardesc!_stardesctooltip>
27765 Maximal two translatable macro keywords,
27766 marked by the prefix
27767 \begin_inset Flex Code
27770 \begin_layout Plain Layout
27778 The first points to the string that replaces the
27779 \begin_inset Quotes eld
27783 \begin_inset Quotes erd
27786 checkbox label in the citation dialog,
27787 the second one to an optional tool tip for this checkbox.
27791 \begin_layout Standard
27792 Note that these two macros have to be defined in a
27793 \begin_inset Flex Code
27796 \begin_layout Plain Layout
27802 (see next section),
27804 \begin_inset Flex Code
27807 \begin_layout Plain Layout
27818 \begin_layout LyX-Code
27819 _stardesc Sta&rred command label
27822 \begin_layout LyX-Code
27823 _stardesctooltip Tooltip for the starred command checkbox.
27827 \begin_layout Itemize
27829 \begin_inset Flex Code
27832 \begin_layout Plain Layout
27838 indicates that this command features
27839 \begin_inset Quotes eld
27842 qualified citation lists
27843 \begin_inset Quotes erd
27851 -specific feature for multi-reference citations where an individual pre- and postnote can be given to each reference in the list.
27852 Please refer to the
27856 manual for details.
27857 \change_inserted -712698321 1526898670
27861 \begin_layout Standard
27863 \change_inserted -712698321 1526899524
27864 If you want to add a cite command to a cite engine (e.
27865 \begin_inset space \thinspace{}
27869 add a specific command provided by a class),
27871 \begin_inset Flex Code
27874 \begin_layout Plain Layout
27876 \change_inserted -712698321 1526898768
27877 AddToCiteEngine <engine type> \SpecialChar ldots
27886 Note that only cite commands that do not exist yet are added.
27891 \begin_layout Subsection
27892 \begin_inset CommandInset label
27894 name "subsec:Citation-format-description"
27898 Cite format description
27901 \begin_layout Standard
27903 \begin_inset Flex Code
27906 \begin_layout Plain Layout
27912 blocks are used to describe how bibliographic information should be displayed,
27913 both within \SpecialChar LyX
27914 itself (in the citation dialog and in tooltips,
27915 for example) and in XHTML output.
27916 Such a block might look like this:
27919 \begin_layout LyX-Code
27923 \begin_layout LyX-Code
27927 \begin_layout LyX-Code
27931 \begin_layout LyX-Code
27935 \begin_layout Standard
27939 \begin_layout LyX-Code
27943 \begin_layout LyX-Code
27947 \begin_layout LyX-Code
27951 \begin_layout LyX-Code
27955 \begin_layout Standard
27957 the individual lines define how the bibliographic information associated with an article or book,
27959 is to be displayed,
27960 and such a definition can be given for any
27961 \begin_inset Quotes els
27965 \begin_inset Quotes ers
27968 that might be present in a Bib\SpecialChar TeX
27971 defines a default format in the source code that will be used if no specific definition has been given.
27973 predefines several formats in the file
27974 \begin_inset Flex Code
27977 \begin_layout Plain Layout
27984 which is included in most of \SpecialChar LyX
27985 's document classes.
27988 \begin_layout Standard
27989 In the second case,
27990 the lines define how a specific citation command (in the example
27991 \begin_inset Flex Code
27994 \begin_layout Plain Layout
28004 \begin_inset Flex Code
28007 \begin_layout Plain Layout
28015 ) is to be displayed on the citation inset label,
28016 in the citation dialog,
28017 menu or XHTML output.
28019 defines such formats for the citation style variants it supports via
28021 Document\SpecialChar menuseparator
28022 Setting\SpecialChar menuseparator
28023 Bibliography\SpecialChar ldots
28027 \begin_inset Flex Code
28030 \begin_layout Plain Layout
28036 files that are shipped with \SpecialChar LyX
28038 \begin_inset CommandInset ref
28040 reference "subsec:Cite-Engine-Files"
28051 \begin_layout Standard
28052 The definitions use a simple language that allows Bib\SpecialChar TeX
28053 keys to be replaced with their values.
28054 Keys should be enclosed in
28055 \begin_inset Flex Code
28058 \begin_layout Plain Layout
28067 \begin_inset Flex Code
28070 \begin_layout Plain Layout
28077 So a simple definition might look like this:
28080 \begin_layout LyX-Code
28083 \begin_inset Quotes eld
28087 \begin_inset Quotes erd
28093 \begin_layout Standard
28094 This would print the author,
28095 followed by a comma,
28096 followed by the title,
28098 followed by a period.
28101 \begin_layout Standard
28103 sometimes you may want to print a key only if it exists.
28104 This can be done by using a conditional construction,
28107 \begin_inset Flex Code
28110 \begin_layout Plain Layout
28112 \begin_inset space ~
28123 \begin_inset Flex Code
28126 \begin_layout Plain Layout
28134 \begin_inset Quotes eld
28138 \begin_inset space ~
28142 \begin_inset Quotes erd
28145 followed by the volume key.
28146 It is also possible to have an else clause in the conditional,
28148 \begin_inset Newline newline
28152 \begin_inset Flex Code
28155 \begin_layout Plain Layout
28156 {%author%[[%author%]][[%editor%,
28163 \begin_inset Newline newline
28168 \begin_inset Flex Code
28171 \begin_layout Plain Layout
28177 key is printed if it exists;
28179 the editor key is printed,
28181 \begin_inset Quotes eld
28185 \begin_inset space ~
28189 \begin_inset Quotes erd
28192 Note that the key is again enclosed in
28193 \begin_inset Flex Code
28196 \begin_layout Plain Layout
28203 the entire conditional is enclosed in braces;
28204 and the if and else clauses are enclosed in double brackets,
28206 \begin_inset Quotes eld
28210 \begin_inset Flex Code
28213 \begin_layout Plain Layout
28220 \begin_inset Quotes eld
28224 \begin_inset Quotes eld
28228 \begin_inset Flex Code
28231 \begin_layout Plain Layout
28238 \begin_inset Quotes erd
28242 There must be no space between any of these.
28245 \begin_layout Standard
28246 Next to the entry keys,
28247 there are some special keys that can be used for these conditionals:
28250 \begin_layout Itemize
28251 \begin_inset Flex Code
28254 \begin_layout Plain Layout
28255 {%dialog%[[true]][[false]]}
28262 \begin_inset Quotes eld
28266 \begin_inset Quotes erd
28269 part for dialogs and menus,
28271 \begin_inset Quotes eld
28275 \begin_inset Quotes erd
28278 part for other contexts (workarea,
28282 \begin_layout Itemize
28283 \begin_inset Flex Code
28286 \begin_layout Plain Layout
28287 {%export%[[true]][[false]]}
28294 \begin_inset Quotes eld
28298 \begin_inset Quotes erd
28301 part for export and menus,
28303 \begin_inset Quotes eld
28307 \begin_inset Quotes erd
28310 part for other contexts (workarea,
28314 \begin_layout Itemize
28315 \begin_inset Flex Code
28318 \begin_layout Plain Layout
28326 \begin_inset Quotes eld
28330 \begin_inset Quotes erd
28333 part if another item follows (e.
28334 \begin_inset space \thinspace{}
28338 in a citation with multiple keys)
28341 \begin_layout Itemize
28342 \begin_inset Flex Code
28345 \begin_layout Plain Layout
28346 {%second%[[true]][[false]]}
28353 \begin_inset Quotes eld
28357 \begin_inset Quotes erd
28360 if this is the second of multiple items,
28362 \begin_inset Quotes eld
28366 \begin_inset Quotes erd
28372 \begin_layout Itemize
28373 \begin_inset Flex Code
28376 \begin_layout Plain Layout
28377 {%ifstar%[[true]][[false]]}
28384 \begin_inset Quotes eld
28388 \begin_inset Quotes erd
28391 part for starred citation commands (such as
28392 \begin_inset Flex Code
28395 \begin_layout Plain Layout
28404 the false part for unstarred
28407 \begin_layout Itemize
28408 \begin_inset Flex Code
28411 \begin_layout Plain Layout
28412 {%ifentrytype:<type>%[[true]][[false]]}
28419 \begin_inset Quotes eld
28423 \begin_inset Quotes erd
28426 if the current entry type matches
28427 \begin_inset Flex Code
28430 \begin_layout Plain Layout
28437 else the false part (e.g.,
28438 in a citation definition:
28440 \begin_inset Flex Code
28443 \begin_layout Plain Layout
28444 {%ifentrytype:book%[[this is a book]][[this is no book]]}
28452 \begin_layout Itemize
28453 \begin_inset Flex Code
28456 \begin_layout Plain Layout
28457 {%ifmultiple:<authortype>%[[true]][[false]]}
28464 \begin_inset Quotes eld
28468 \begin_inset Quotes erd
28471 if the current author type (author,
28472 editor etc.) has multiple authors,
28473 else the false part (e.g.,
28474 in a bibliography definition:
28476 \begin_inset Flex Code
28479 \begin_layout Plain Layout
28480 {%ifmultiple:editor%[[eds.]][[ed.]]}
28488 \begin_layout Itemize
28489 \begin_inset Flex Code
28492 \begin_layout Plain Layout
28493 {%ifqualified%[[true]][[false]]}
28500 \begin_inset Quotes eld
28504 \begin_inset Quotes erd
28507 part if the current citation is a qualified citation list (a specific
28511 format for multi-reference citations),
28512 the false part if this is not the case.
28515 \begin_layout Standard
28517 \begin_inset Flex Code
28520 \begin_layout Plain Layout
28526 prints the author key as it is recorded in the bibliography file.
28527 This might not be what you want,
28528 since it will result in a string such as
28529 \begin_inset Quotes eld
28536 \begin_inset Quotes erd
28540 \begin_inset Quotes eld
28544 \begin_inset Quotes erd
28547 is used by Bib\SpecialChar TeX
28548 to delimit authors).
28550 therefore provides some methods to get properly formatted name lists (which will also get translated).
28551 The following keys are provided:
28554 \begin_layout Enumerate
28555 For name lists with pre- and surname,
28556 suitable for the main authors/editors of a bibliography item.
28558 \begin_inset Flex Code
28561 \begin_layout Plain Layout
28567 part denotes the kind of list that is requested (e.g.
28569 \begin_inset Flex Code
28572 \begin_layout Plain Layout
28582 \begin_layout Itemize
28583 \begin_inset Flex Code
28586 \begin_layout Plain Layout
28587 %abbrvnames:<nametype>%
28593 Provides a name list which is abbreviated (with
28594 \begin_inset Quotes eld
28598 \begin_inset Quotes erd
28602 \begin_inset Flex Code
28605 \begin_layout Plain Layout
28614 \begin_layout Itemize
28615 \begin_inset Flex Code
28618 \begin_layout Plain Layout
28619 %fullnames:<nametype>%
28625 Provides a full name list (never abbreviated with
28626 \begin_inset Quotes eld
28630 \begin_inset Quotes erd
28636 \begin_layout Itemize
28637 \begin_inset Flex Code
28640 \begin_layout Plain Layout
28641 %forceabbrvnames:<nametype>%
28647 Provides a name list which is always abbreviated (with
28648 \begin_inset Quotes eld
28652 \begin_inset Quotes erd
28656 \begin_inset Flex Code
28659 \begin_layout Plain Layout
28669 \begin_layout Enumerate
28670 Alternative name lists with pre- and surname,
28671 if the order of pre- and surname inside the bibliography item differs (as in:
28673 \begin_inset Quotes eld
28683 \begin_inset Quotes erd
28690 \begin_layout Itemize
28691 \begin_inset Flex Code
28694 \begin_layout Plain Layout
28695 %abbrvbynames:<nametype>%
28701 Provides a name list which is abbreviated (with
28702 \begin_inset Quotes eld
28706 \begin_inset Quotes erd
28710 \begin_inset Flex Code
28713 \begin_layout Plain Layout
28722 \begin_layout Itemize
28723 \begin_inset Flex Code
28726 \begin_layout Plain Layout
28727 %fullbynames:<nametype>%
28733 Provides a full name list (never abbreviated with
28734 \begin_inset Quotes eld
28738 \begin_inset Quotes erd
28744 \begin_layout Itemize
28745 \begin_inset Flex Code
28748 \begin_layout Plain Layout
28749 %forceabbrvbynames:<nametype>%
28755 Provides a name list which is always abbreviated (with
28756 \begin_inset Quotes eld
28760 \begin_inset Quotes erd
28764 \begin_inset Flex Code
28767 \begin_layout Plain Layout
28777 \begin_layout Enumerate
28778 And finally name lists which consist of family names only,
28779 as used in author-year citation labels.
28780 These do not take a
28781 \begin_inset Flex Code
28784 \begin_layout Plain Layout
28791 but always return either an author list or,
28792 if this does not exist,
28793 an editor list (as common in author-year labels):
28797 \begin_layout Itemize
28798 \begin_inset Flex Code
28801 \begin_layout Plain Layout
28808 Provides a name list which is abbreviated (with
28809 \begin_inset Quotes eld
28813 \begin_inset Quotes erd
28817 \begin_inset Flex Code
28820 \begin_layout Plain Layout
28829 \begin_layout Itemize
28830 \begin_inset Flex Code
28833 \begin_layout Plain Layout
28840 Provides a full name list (never abbreviated with
28841 \begin_inset Quotes eld
28845 \begin_inset Quotes erd
28851 \begin_layout Itemize
28852 \begin_inset Flex Code
28855 \begin_layout Plain Layout
28856 %forceabbrvciteauthor%
28862 Provides a name list which is always abbreviated (with
28863 \begin_inset Quotes eld
28867 \begin_inset Quotes erd
28871 \begin_inset Flex Code
28874 \begin_layout Plain Layout
28884 \begin_layout Standard
28885 The order of pre- and surname in the former two lists can be adjusted by these macros:
28888 \begin_layout Itemize
28889 \begin_inset Flex Code
28892 \begin_layout Plain Layout
28893 !firstnameform %surname%,
28899 (first author in lists of type 1)
28902 \begin_layout Itemize
28903 \begin_inset Flex Code
28906 \begin_layout Plain Layout
28907 !othernameform %surname%,
28913 (other authors in lists of type 1)
28916 \begin_layout Itemize
28917 \begin_inset Flex Code
28920 \begin_layout Plain Layout
28921 !firstbynameform %prename% %surname%
28926 (first author in lists of type 2)
28929 \begin_layout Itemize
28930 \begin_inset Flex Code
28933 \begin_layout Plain Layout
28934 !otherbynameform %prename% %surname%
28939 (other authors in lists of type 2)
28942 \begin_layout Standard
28943 This allows you to configure namings like
28944 \begin_inset Quotes eld
28948 Peter and Mary Smith:
28952 John Doe and Pat Green,
28953 eds.:\SpecialChar ldots
28955 \begin_inset Quotes erd
28961 \begin_layout Standard
28962 There is one other piece of syntax available in definitions,
28963 which looks like this:
28965 \begin_inset Flex Code
28968 \begin_layout Plain Layout
28975 This defines a piece of formatting information that is to be used when creating
28976 \begin_inset Quotes eld
28980 \begin_inset Quotes erd
28985 we do not want to output HTML tags when writing plain text,
28986 so they should be wrapped in
28987 \begin_inset Quotes eld
28991 \begin_inset Quotes erd
28995 \begin_inset Quotes eld
28999 \begin_inset Quotes erd
29005 \begin_layout Standard
29006 Two special sorts of definitions are also possible in a
29007 \begin_inset Flex Code
29010 \begin_layout Plain Layout
29017 An example of the first would be:
29020 \begin_layout LyX-Code
29022 \begin_inset Quotes eld
29026 \begin_inset Quotes erd
29032 \begin_layout Standard
29033 This is an abbreviation,
29035 and it can be used by treating it as if it were a key:
29037 \begin_inset Flex Code
29040 \begin_layout Plain Layout
29049 \begin_inset Flex Code
29052 \begin_layout Plain Layout
29058 exactly as it would treat its definition.
29060 let us issue the obvious
29068 \begin_layout LyX-Code
29072 \begin_layout Standard
29073 or anything like it.
29075 shouldn't go into an infinite loop,
29076 but it may go into a long one before it gives up.
29079 \begin_layout Standard
29080 The second sort of special definition might look like this:
29083 \begin_layout LyX-Code
29087 \begin_layout Standard
29088 This defines a translatable piece of text,
29089 which allows relevant parts of the bibliography or citation to be translated.
29090 It can be included in a definition by treating it as a key:
29092 \begin_inset Flex Code
29095 \begin_layout Plain Layout
29102 Note that there are two different translation paths:
29103 All definitions starting with
29104 \begin_inset Flex Code
29107 \begin_layout Plain Layout
29114 such as in the example above,
29115 will be translated to the currently active buffer language (so the translation will match the generated document).
29116 All definitions starting with underscore only will be translated to the GUI language.
29117 This is the proper translation for strings that only occur in the dialogs or on buttons,
29121 \begin_layout LyX-Code
29122 _addtobib Add to bibliography only.
29125 \begin_layout Standard
29126 Several of these translatable strings are predefined in
29127 \begin_inset Flex Code
29130 \begin_layout Plain Layout
29137 \begin_inset Flex Code
29140 \begin_layout Plain Layout
29147 Note that these are not macros,
29148 in the sense just defined.
29149 They will not be expanded.
29152 \begin_layout Standard
29153 So here then is an example that uses several of these features:
29154 \begin_inset VSpace defskip
29160 \begin_layout Standard
29164 !authoredit {%author%[[%author%,
29165 ]][[{%editor%[[%editor%,
29170 \begin_layout Standard
29171 \begin_inset VSpace defskip
29174 This defines a macro that prints the author,
29175 followed by a comma,
29177 \begin_inset Flex Code
29180 \begin_layout Plain Layout
29187 or else prints the name of the editor,
29189 \begin_inset Flex Code
29192 \begin_layout Plain Layout
29198 or its translation (it is by default
29199 \begin_inset Quotes eld
29203 \begin_inset Quotes erd
29208 \begin_inset Flex Code
29211 \begin_layout Plain Layout
29218 Note that this is in fact defined in
29219 \begin_inset Flex Code
29222 \begin_layout Plain Layout
29229 so you can use it in your own definitions,
29231 if you load that file first.
29234 \begin_layout Section
29235 \begin_inset CommandInset label
29237 name "sec:Tags-for-XHTML"
29241 Tags for XHTML output
29244 \begin_layout Standard
29245 As with \SpecialChar LaTeX
29247 the format of \SpecialChar LyX
29248 's XHTML output is also controlled by layout information.
29251 provides sensible defaults and,
29252 as mentioned earlier,
29253 it will even construct default CSS style rules from the other layout tags.
29256 will attempt to use the information provided in the
29257 \begin_inset Flex Code
29260 \begin_layout Plain Layout
29266 declaration for the Chapter style to write CSS that will appropriately format chapter headings.
29269 \begin_layout Standard
29272 you may not have to do anything at all to get acceptable XHTML output for your own environments,
29275 But in some cases you will,
29276 and so \SpecialChar LyX
29277 provides a number of layout tags that can be used to customize the XHTML and CSS that are generated.
29280 \begin_layout Standard
29281 Note that there are two tags,
29283 \begin_inset Flex Code
29286 \begin_layout Plain Layout
29293 \begin_inset Flex Code
29296 \begin_layout Plain Layout
29302 that may appear outside style and inset declarations.
29304 \begin_inset CommandInset ref
29306 reference "subsec:General-text-class"
29311 for details on these.
29314 \begin_layout Subsection
29315 \begin_inset CommandInset label
29317 name "subsec:Paragraph-Style-XHTML"
29324 \begin_layout Standard
29325 The sort of XHTML \SpecialChar LyX
29326 outputs for a paragraph depends upon whether we are dealing with a normal paragraph,
29329 where this is itself determined by the contents of the corresponding
29330 \begin_inset Flex Code
29333 \begin_layout Plain Layout
29344 \begin_layout Standard
29345 For a command or normal paragraph,
29346 the output XHTML has the following form:
29349 \begin_layout LyX-Code
29353 \begin_inset Quotes erd
29357 \begin_inset Quotes erd
29363 \begin_layout LyX-Code
29367 \begin_inset Quotes erd
29371 \begin_inset Quotes erd
29377 \begin_layout LyX-Code
29380 Contents of the paragraph.
29383 \begin_layout LyX-Code
29389 \begin_layout Standard
29390 The label tags are of course omitted if the paragraph does not have a label.
29393 \begin_layout Standard
29394 For an environment that is not some sort of list,
29395 the XHTML takes this form:
29398 \begin_layout LyX-Code
29402 \begin_inset Quotes erd
29406 \begin_inset Quotes erd
29412 \begin_layout LyX-Code
29416 \begin_inset Quotes erd
29420 \begin_inset Quotes erd
29424 \begin_inset Quotes erd
29428 \begin_inset Quotes erd
29431 >Environment Label</labeltag>First paragraph.</itemtag>
29434 \begin_layout LyX-Code
29437 <itemtag>Second paragraph.</itemtag>
29440 \begin_layout LyX-Code
29446 \begin_layout Standard
29447 Note that the label is output only for the first paragraph,
29448 as it should be for a theorem,
29453 \begin_layout Standard
29455 we have one of these forms:
29458 \begin_layout LyX-Code
29462 \begin_inset Quotes erd
29466 \begin_inset Quotes erd
29472 \begin_layout LyX-Code
29476 \begin_inset Quotes erd
29480 \begin_inset Quotes erd
29484 \begin_inset Quotes erd
29488 \begin_inset Quotes erd
29491 >List Label</labeltag>First item.</itemtag>
29494 \begin_layout LyX-Code
29498 \begin_inset Quotes erd
29502 \begin_inset Quotes erd
29506 \begin_inset Quotes erd
29510 \begin_inset Quotes erd
29513 >List Label</labeltag>Second item.</itemtag>
29516 \begin_layout LyX-Code
29522 \begin_layout LyX-Code
29526 \begin_layout LyX-Code
29530 \begin_inset Quotes erd
29534 \begin_inset Quotes erd
29540 \begin_layout LyX-Code
29544 \begin_inset Quotes erd
29548 \begin_inset Quotes erd
29551 >List Label</labeltag><itemtag attr=
29552 \begin_inset Quotes erd
29556 \begin_inset Quotes erd
29559 >First item.</itemtag>
29562 \begin_layout LyX-Code
29566 \begin_inset Quotes erd
29570 \begin_inset Quotes erd
29573 >List Label</labeltag><itemtag attr=
29574 \begin_inset Quotes erd
29578 \begin_inset Quotes erd
29581 >Second item.</itemtag>
29584 \begin_layout LyX-Code
29590 \begin_layout Standard
29591 Note the different orders of
29592 \begin_inset Flex Code
29595 \begin_layout Plain Layout
29602 \begin_inset Flex Code
29605 \begin_layout Plain Layout
29612 Which order we get depends upon the setting of
29613 \begin_inset Flex Code
29616 \begin_layout Plain Layout
29624 \begin_inset Flex Code
29627 \begin_layout Plain Layout
29633 is false (the default),
29634 you get the first of these,
29635 with the label within the item;
29637 you get the second,
29638 with the label outside the item.
29641 \begin_layout Standard
29642 The specific tags and attributes output for each paragraph type can be controlled by means of the layout tags we are about to describe.
29643 As mentioned earlier,
29646 uses sensible defaults for many of these,
29647 so you often may not need to do very much to get good XHTML output.
29648 Think of the available tags as there so you can tweak things to your liking.
29651 \begin_layout Description
29652 \begin_inset Flex Code
29655 \begin_layout Plain Layout
29662 \begin_inset Flex Code
29665 \begin_layout Plain Layout
29671 ] Specifies attribute information to be output with the main tag.
29674 \begin_inset Quotes eld
29678 \begin_inset Flex Code
29681 \begin_layout Plain Layout
29688 \begin_inset Quotes erd
29695 \begin_inset Quotes eld
29699 \begin_inset Flex Code
29702 \begin_layout Plain Layout
29709 \begin_inset Quotes erd
29714 \begin_inset Flex Code
29717 \begin_layout Plain Layout
29723 is the \SpecialChar LyX
29724 name of the layout,
29732 contain any style information.
29734 \begin_inset Flex Code
29737 \begin_layout Plain Layout
29744 \change_inserted -584632292 1670182206
29748 \begin_layout Description
29750 \change_inserted -584632292 1670182369
29751 \begin_inset Flex Code
29754 \begin_layout Plain Layout
29756 \change_inserted -584632292 1670182222
29765 \begin_inset Flex Code
29768 \begin_layout Plain Layout
29770 \change_inserted -584632292 1670182217
29778 ] The CSS class to use for this paragraph.
29780 if the paragarph is of enumerate or itemize type,
29781 then the default will be
29782 \begin_inset Quotes eld
29786 \begin_inset Quotes erd
29790 \begin_inset Quotes eld
29794 \begin_inset Quotes erd
29799 \begin_inset Quotes eld
29803 \begin_inset Quotes erd
29808 \begin_inset Quotes eld
29812 \begin_inset Quotes erd
29817 \begin_inset Quotes eld
29821 \begin_inset Quotes erd
29826 \begin_inset Quotes eld
29830 \begin_inset Quotes erd
29834 depending upon the depth.
29835 That can be over-ridden here.
29837 the suffix will not be added in that case.
29839 the CSS class will always be exactly what it is declared to be here.
29844 \begin_layout Description
29845 \begin_inset Flex Code
29848 \begin_layout Plain Layout
29855 \begin_inset Flex Code
29858 \begin_layout Plain Layout
29868 ] Whether to output the default CSS information \SpecialChar LyX
29869 generates for this layout,
29870 even if additional information is explicitly provided via
29871 \begin_inset Flex Code
29874 \begin_layout Plain Layout
29882 \begin_inset Flex Code
29885 \begin_layout Plain Layout
29891 allows you to alter or augment the generated CSS,
29892 rather than to override it completely.
29894 \begin_inset Flex Code
29897 \begin_layout Plain Layout
29904 \change_inserted -584632292 1670132213
29908 \begin_layout Description
29910 \change_inserted -584632292 1670132277
29911 \begin_inset Flex Code
29914 \begin_layout Plain Layout
29916 \change_inserted -584632292 1670132221
29925 \begin_inset Flex Code
29928 \begin_layout Plain Layout
29930 \change_inserted -584632292 1670132214
29940 ] Whether to include this paragraph (usually,
29941 a section or something of the sort) in the TOC.
29944 so it should be set to false e.g.
29945 \begin_inset space ~
29948 for starred sections.
29953 \begin_layout Description
29954 \begin_inset Flex Code
29957 \begin_layout Plain Layout
29964 \begin_inset Flex Code
29967 \begin_layout Plain Layout
29973 ] The tag to be used for individual paragraphs of environments,
29975 \begin_inset Flex Code
29978 \begin_layout Plain Layout
29984 in the examples above.
29986 \begin_inset Flex Code
29989 \begin_layout Plain Layout
29998 \begin_layout Description
29999 \begin_inset Flex Code
30002 \begin_layout Plain Layout
30009 \begin_inset Flex Code
30012 \begin_layout Plain Layout
30018 ] Attributes for the item tag.
30020 \begin_inset Newline newline
30024 \begin_inset Quotes eld
30028 \begin_inset Flex Code
30031 \begin_layout Plain Layout
30032 class=`layoutname_item'
30038 \begin_inset Quotes erd
30046 contain any style information.
30048 \begin_inset Flex Code
30051 \begin_layout Plain Layout
30060 \begin_layout Description
30061 \begin_inset Flex Code
30064 \begin_layout Plain Layout
30071 \begin_inset Flex Code
30074 \begin_layout Plain Layout
30080 ] The tag to be used for paragraph and item labels,
30082 \begin_inset Flex Code
30085 \begin_layout Plain Layout
30091 in the examples above.
30093 \begin_inset Flex Code
30096 \begin_layout Plain Layout
30104 \begin_inset Flex Code
30107 \begin_layout Plain Layout
30114 \begin_inset Flex Code
30117 \begin_layout Plain Layout
30124 \begin_inset Flex Code
30127 \begin_layout Plain Layout
30128 Centered_Top_Environment
30134 in which case it defaults to
30135 \begin_inset Flex Code
30138 \begin_layout Plain Layout
30147 \begin_layout Description
30148 \begin_inset Flex Code
30151 \begin_layout Plain Layout
30158 \begin_inset Flex Code
30161 \begin_layout Plain Layout
30167 ] Attributes for the label tag.
30169 \begin_inset Newline newline
30173 \begin_inset Quotes eld
30177 \begin_inset Flex Code
30180 \begin_layout Plain Layout
30181 class=`layoutname_label'
30187 \begin_inset Quotes erd
30195 contain any style information.
30197 \begin_inset Flex Code
30200 \begin_layout Plain Layout
30209 \begin_layout Description
30210 \begin_inset Flex Code
30213 \begin_layout Plain Layout
30220 \begin_inset Flex Code
30223 \begin_layout Plain Layout
30233 ] Meaningful only for list-like environments,
30234 this tag controls whether the label tag is output before or inside the item tag.
30237 in the description environment,
30239 \begin_inset Flex Code
30242 \begin_layout Plain Layout
30243 <dt>\SpecialChar ldots
30244 </dt><dd>\SpecialChar ldots
30252 \begin_inset Flex Code
30255 \begin_layout Plain Layout
30262 The label tag is output inside the item tag.
30265 \begin_layout Description
30266 \begin_inset Flex Code
30269 \begin_layout Plain Layout
30275 Information to be output in the
30276 \begin_inset Flex Code
30279 \begin_layout Plain Layout
30285 section when this style is used.
30288 be used to include a
30289 \begin_inset Flex Code
30292 \begin_layout Plain Layout
30299 \begin_inset Flex Code
30302 \begin_layout Plain Layout
30311 \begin_layout Description
30312 \begin_inset Flex Code
30315 \begin_layout Plain Layout
30321 CSS style information to be included when this style is used.
30322 Note that this will automatically be wrapped in a layout-generated
30323 \begin_inset Flex Code
30326 \begin_layout Plain Layout
30333 so only the CSS itself need be included.
30335 \begin_inset Flex Code
30338 \begin_layout Plain Layout
30347 \begin_layout Description
30348 \begin_inset Flex Code
30351 \begin_layout Plain Layout
30358 \begin_inset Flex Code
30361 \begin_layout Plain Layout
30367 ] The tag to be used for the main label,
30369 \begin_inset Flex Code
30372 \begin_layout Plain Layout
30378 in the examples above.
30380 \begin_inset Flex Code
30383 \begin_layout Plain Layout
30392 \begin_layout Description
30393 \begin_inset Flex Code
30396 \begin_layout Plain Layout
30403 \begin_inset Flex Code
30406 \begin_layout Plain Layout
30416 ] Marks this style as the one to be used to generate the
30417 \begin_inset Flex Code
30420 \begin_layout Plain Layout
30426 tag for the XHTML file.
30430 \begin_inset Flex Code
30433 \begin_layout Plain Layout
30439 file sets it to true for the
30440 \begin_inset Flex Code
30443 \begin_layout Plain Layout
30453 \begin_layout Subsection
30457 \begin_layout Standard
30458 The XHTML output of insets can also be controlled by information in layout files.
30462 \begin_layout Plain Layout
30464 this is true only for
30465 \begin_inset Quotes eld
30469 \begin_inset Quotes erd
30472 insets (insets you can type into) and is not true for
30473 \begin_inset Quotes eld
30477 \begin_inset Quotes erd
30480 insets (insets that are associated with dialog boxes).
30488 tries to provide sensible defaults,
30489 and it constructs default CSS style rules.
30490 But everything can be customized.
30493 \begin_layout Standard
30494 The XHTML \SpecialChar LyX
30495 outputs for an inset has the following form:
30498 \begin_layout LyX-Code
30500 \begin_inset Quotes erd
30504 \begin_inset Quotes erd
30510 \begin_layout LyX-Code
30511 <labeltag>Label</labeltag>
30514 \begin_layout LyX-Code
30516 \begin_inset Quotes erd
30520 \begin_inset Quotes erd
30523 >Contents of the inset.</innertag>
30526 \begin_layout LyX-Code
30530 \begin_layout Standard
30531 If the inset permits multiple paragraphs—
30534 \begin_inset Flex Code
30537 \begin_layout Plain Layout
30544 then the contents of the inset will itself be output as paragraphs formatted according to the styles used for those paragraphs (standard,
30547 The label tag is of course omitted if the paragraph does not have a label and,
30550 \begin_inset Flex Code
30553 \begin_layout Plain Layout
30560 The inner tag is optional and,
30565 \begin_layout Standard
30566 The specific tags and attributes output for each inset can be controlled by means of the following layout tags.
30569 \begin_layout Description
30570 \begin_inset Flex Code
30573 \begin_layout Plain Layout
30580 \begin_inset Flex Code
30583 \begin_layout Plain Layout
30589 ] Specifies attribute information to be output with the main tag.
30592 \begin_inset Quotes eld
30596 \begin_inset Flex Code
30599 \begin_layout Plain Layout
30600 class=`myinset' onclick=`\SpecialChar ldots
30607 \begin_inset Quotes erd
30614 \begin_inset Quotes eld
30618 \begin_inset Flex Code
30621 \begin_layout Plain Layout
30628 \begin_inset Quotes erd
30633 \begin_inset Flex Code
30636 \begin_layout Plain Layout
30642 is the \SpecialChar LyX
30644 made lowercase and with non-alphanumeric characters converted to underscores,
30649 \begin_layout Description
30650 \begin_inset Flex Code
30653 \begin_layout Plain Layout
30660 \begin_inset Flex Code
30663 \begin_layout Plain Layout
30673 ] Whether to output the default CSS information \SpecialChar LyX
30674 generates for this layout,
30675 even if additional information is explicitly provided via
30676 \begin_inset Flex Code
30679 \begin_layout Plain Layout
30687 \begin_inset Flex Code
30690 \begin_layout Plain Layout
30696 allows you to alter or augment the generated CSS,
30697 rather than to override it completely.
30701 \begin_layout Description
30702 \begin_inset Flex Code
30705 \begin_layout Plain Layout
30712 \begin_inset Flex Code
30715 \begin_layout Plain Layout
30721 ] Attributes for the inner tag.
30723 \begin_inset Newline newline
30727 \begin_inset Quotes eld
30731 \begin_inset Flex Code
30734 \begin_layout Plain Layout
30735 class=`insetname_inner'
30741 \begin_inset Quotes erd
30747 \begin_layout Description
30748 \begin_inset Flex Code
30751 \begin_layout Plain Layout
30758 \begin_inset Flex Code
30761 \begin_layout Plain Layout
30769 \begin_inset Flex Code
30772 \begin_layout Plain Layout
30778 in the examples above.
30783 \begin_layout Description
30784 \begin_inset Flex Code
30787 \begin_layout Plain Layout
30794 \begin_inset Flex Code
30797 \begin_layout Plain Layout
30805 ] Whether this inset represents a standalone block of text (such as a footnote) or instead represents material that is included in the surrounding text (such as a branch).
30809 \begin_layout Description
30810 \begin_inset Flex Code
30813 \begin_layout Plain Layout
30820 \begin_inset Flex Code
30823 \begin_layout Plain Layout
30829 ] A label for this inset,
30830 possibly including a reference to a counter.
30835 \begin_inset Flex Code
30838 \begin_layout Plain Layout
30848 and there is no default.
30851 \begin_layout Description
30852 \begin_inset Flex Code
30855 \begin_layout Plain Layout
30861 Information to be output in the
30862 \begin_inset Flex Code
30865 \begin_layout Plain Layout
30871 section when this style is used.
30874 be used to include a
30875 \begin_inset Flex Code
30878 \begin_layout Plain Layout
30885 \begin_inset Flex Code
30888 \begin_layout Plain Layout
30897 \begin_layout Description
30898 \begin_inset Flex Code
30901 \begin_layout Plain Layout
30907 CSS style information to be included when this style is used.
30908 Note that this will automatically be wrapped in a layout-generated
30909 \begin_inset Flex Code
30912 \begin_layout Plain Layout
30919 so only the CSS itself need be included.
30922 \begin_layout Description
30923 \begin_inset Flex Code
30926 \begin_layout Plain Layout
30933 \begin_inset Flex Code
30936 \begin_layout Plain Layout
30942 ] The tag to be used for the main label,
30944 \begin_inset Flex Code
30947 \begin_layout Plain Layout
30953 in the examples above.
30954 The default depends upon the setting of
30955 \begin_inset Flex Code
30958 \begin_layout Plain Layout
30966 \begin_inset Flex Code
30969 \begin_layout Plain Layout
30977 \begin_inset Flex Code
30980 \begin_layout Plain Layout
30989 \begin_inset Flex Code
30992 \begin_layout Plain Layout
31001 \begin_layout Subsection
31005 \begin_layout Standard
31006 The XHTML output for floats too can be controlled by layout information.
31007 The output has the following form:
31010 \begin_layout LyX-Code
31012 \begin_inset Quotes erd
31016 \begin_inset Quotes erd
31022 \begin_layout LyX-Code
31023 Contents of the float.
31026 \begin_layout LyX-Code
31030 \begin_layout Standard
31033 is a separate inset and will be output as such.
31034 Its appearance can be controlled via the InsetLayout for caption insets.
31038 \begin_layout Description
31039 \begin_inset Flex Code
31042 \begin_layout Plain Layout
31049 \begin_inset Flex Code
31052 \begin_layout Plain Layout
31058 ] Specifies attribute information to be output with the main tag.
31061 \begin_inset Quotes eld
31065 \begin_inset Flex Code
31068 \begin_layout Plain Layout
31069 class=`myfloat' onclick=`\SpecialChar ldots
31076 \begin_inset Quotes erd
31083 \begin_inset Quotes eld
31087 \begin_inset Flex Code
31090 \begin_layout Plain Layout
31091 class=`float float-floattype'
31097 \begin_inset Quotes erd
31102 \begin_inset Flex Code
31105 \begin_layout Plain Layout
31111 is \SpecialChar LyX
31112 's name for this type of float,
31113 as determined by the float declaration (see
31114 \begin_inset CommandInset ref
31116 reference "subsec:Floats"
31122 though made lowercase and with non-alphanumeric characters converted to underscores,
31127 \begin_layout Description
31128 \begin_inset Flex Code
31131 \begin_layout Plain Layout
31137 CSS style information to be included when this float is used.
31138 Note that this will automatically be wrapped in a layout-generated
31139 \begin_inset Flex Code
31142 \begin_layout Plain Layout
31149 so only the CSS itself need be included.
31152 \begin_layout Description
31153 \begin_inset Flex Code
31156 \begin_layout Plain Layout
31163 \begin_inset Flex Code
31166 \begin_layout Plain Layout
31172 ] The tag to be used for this float,
31174 \begin_inset Quotes eld
31178 \begin_inset Flex Code
31181 \begin_layout Plain Layout
31188 \begin_inset Quotes erd
31191 in the example above.
31193 \begin_inset Flex Code
31196 \begin_layout Plain Layout
31202 and will rarely need changing.
31205 \begin_layout Subsection
31206 Bibliography formatting
31209 \begin_layout Standard
31210 The bibliography can be formatted using
31211 \begin_inset Flex Code
31214 \begin_layout Plain Layout
31222 \begin_inset CommandInset ref
31224 reference "subsec:Citation-format-description"
31232 \begin_layout Subsection
31237 \begin_layout Standard
31238 We have several times mentioned that \SpecialChar LyX
31239 will generate default CSS style rules for both insets and paragraph styles,
31240 based upon the other layout information that is provided.
31242 we shall say a word about which layout information \SpecialChar LyX
31246 \begin_layout Standard
31249 auto-generates CSS only for font information,
31251 \begin_inset Flex Code
31254 \begin_layout Plain Layout
31262 \begin_inset Flex Code
31265 \begin_layout Plain Layout
31273 \begin_inset Flex Code
31276 \begin_layout Plain Layout
31284 \begin_inset Flex Code
31287 \begin_layout Plain Layout
31294 \begin_inset Flex Code
31297 \begin_layout Plain Layout
31304 \begin_inset CommandInset ref
31306 reference "subsec:Font-description"
31312 The translation is mostly straightforward and obvious.
31315 \begin_inset Quotes eld
31319 \begin_inset Flex Code
31322 \begin_layout Plain Layout
31329 \begin_inset Quotes erd
31333 \begin_inset Quotes eld
31337 \begin_inset Flex Code
31340 \begin_layout Plain Layout
31348 \begin_inset Quotes erd
31352 The correspondence of \SpecialChar LyX
31353 sizes and CSS sizes is a little less obvious but nonetheless intuitive.
31355 \begin_inset Flex Code
31358 \begin_layout Plain Layout
31365 \begin_inset Flex URL
31368 \begin_layout Plain Layout
31376 \change_inserted -970929547 1496610908
31380 \begin_layout Section
31382 \change_inserted -970929547 1496610966
31383 \begin_inset CommandInset label
31385 name "sec:Tags-for-DocBook"
31389 Tags for DocBook output
31392 \begin_layout Standard
31394 \change_inserted -970929547 1496611615
31395 As with \SpecialChar LaTeX
31397 the format of \SpecialChar LyX
31398 's DocBook output is also controlled by layout information.
31401 provides sensible defaults;
31403 much of the styling is lost during the conversion,
31404 as DocBook is strictly semantic and does not allow formatting.
31406 information from \SpecialChar LyX
31407 will be rendered in
31415 \begin_layout Standard
31417 \change_inserted -970929547 1496612080
31420 you may not have to do anything at all to get acceptable DocBook output for your own environments,
31423 But in some cases you will,
31424 and so \SpecialChar LyX
31425 provides a number of layout tags that can be used to customize the DocBook that is generated.
31428 \begin_layout Standard
31430 \change_inserted -970929547 1515109912
31431 Labels are rarely output,
31432 as they are redundant in DocBook:
31433 this information is carried by the tags themselves,
31434 and whether labels appear in the final documents (after processing of DocBook files) is controlled by the stylesheets.
31437 labels are not redundant content,
31438 such as definition lists:
31440 the term being defined will be the label.
31444 \begin_layout Subsection
31446 \change_inserted 1075283030 1597699417
31447 \begin_inset CommandInset label
31449 name "subsec:Paragraph-Style-DocBook"
31454 \change_deleted 1075283030 1597699417
31456 \begin_inset CommandInset label
31458 name "subsec:Paragraph-Style-XHTML-1"
31463 \change_inserted -970929547 1496610966
31467 \begin_layout Standard
31469 \change_inserted -970929547 1496612059
31470 The sort of DocBook \SpecialChar LyX
31471 outputs for a paragraph depends upon whether we are dealing with a normal paragraph,
31474 where this is itself determined by the contents of the corresponding
31475 \begin_inset Flex Code
31478 \begin_layout Plain Layout
31480 \change_inserted -970929547 1496610966
31493 \begin_layout Standard
31495 \change_inserted -970929547 1496612107
31496 For a command or normal paragraph,
31497 the output DocBook has the following form:
31500 \begin_layout LyX-Code
31502 \change_inserted -970929547 1515109666
31506 \begin_layout LyX-Code
31508 \change_inserted -970929547 1496610966
31509 Contents of the paragraph.
31512 \begin_layout LyX-Code
31514 \change_inserted -970929547 1496610966
31518 \begin_layout Standard
31520 \change_inserted -970929547 1515109821
31521 For an environment that is not some sort of list,
31522 the generated DocBook takes this form:
31525 \begin_layout LyX-Code
31527 \change_inserted -970929547 1515109671
31531 \begin_layout LyX-Code
31533 \change_inserted -970929547 1496612114
31534 <itemtag>First paragraph.</itemtag>
31537 \begin_layout LyX-Code
31539 \change_inserted -970929547 1496610966
31540 <itemtag>Second paragraph.</itemtag>
31543 \begin_layout LyX-Code
31545 \change_inserted -970929547 1496610966
31549 \begin_layout Standard
31551 \change_inserted -970929547 1515109825
31553 the resulting DocBook takes this form:
31556 \begin_layout LyX-Code
31558 \change_inserted -970929547 1515109672
31562 \begin_layout LyX-Code
31564 \change_inserted -970929547 1515109676
31565 <itemtag attr>First item.</itemtag>
31568 \begin_layout LyX-Code
31570 \change_inserted -970929547 1515109678
31571 <itemtag attr>Second item.</itemtag>
31574 \begin_layout LyX-Code
31576 \change_inserted -970929547 1496610966
31580 \begin_layout Standard
31582 \change_inserted -970929547 1496612243
31583 The specific tags and roles output for each paragraph type can be controlled by means of the layout tags we are about to describe.
31585 due to the very nature of DocBook,
31586 no sensible defaults really exist,
31587 and the values must always be carefully chosen.
31591 \begin_layout Description
31593 \change_inserted -970929547 1515110057
31594 \begin_inset Flex Code
31597 \begin_layout Plain Layout
31599 \change_inserted -970929547 1515109656
31608 \begin_inset Flex Code
31611 \begin_layout Plain Layout
31613 \change_inserted -970929547 1496610966
31621 ] Specifies attribute information to be output with the main tag,
31623 \begin_inset Quotes eld
31627 \begin_inset Flex Code
31630 \begin_layout Plain Layout
31632 \change_inserted -970929547 1515110057
31641 \begin_inset Quotes erd
31644 in the example above.
31645 This information can be used in further processing of the DocBook files.
31651 \begin_layout Description
31653 \change_inserted -970929547 1496612296
31654 \begin_inset Flex Code
31657 \begin_layout Plain Layout
31659 \change_inserted -970929547 1496612269
31668 \begin_inset Flex Code
31671 \begin_layout Plain Layout
31673 \change_inserted -970929547 1496610966
31681 ] The tag to be used for this inset,
31683 \begin_inset Quotes eld
31687 \begin_inset Flex Code
31690 \begin_layout Plain Layout
31692 \change_inserted -970929547 1496612296
31701 \begin_inset Quotes erd
31704 in the example above.
31705 The default is the name of the float and always needs to be changed,
31706 as DocBook provides no generic tag.
31707 \change_inserted 1075283030 1597698868
31711 \begin_layout Description
31713 \change_inserted 1075283030 1597699399
31714 \begin_inset Flex Code
31717 \begin_layout Plain Layout
31719 \change_inserted 1075283030 1597698872
31728 \begin_inset Flex Code
31731 \begin_layout Plain Layout
31733 \change_inserted 1075283030 1597700585
31743 ] The new-line policy for this tag,
31745 \begin_inset space ~
31749 \begin_inset CommandInset ref
31751 reference "subsec:DocBook-New-line-policy"
31765 \begin_layout Subsection
31767 \change_inserted 1075283030 1597699385
31769 \begin_inset CommandInset label
31771 name "subsec:DocBook-New-line-policy"
31778 \begin_layout Standard
31780 \change_inserted 1075283030 1597698993
31782 there are three possible policies for outputting new lines (given in the
31783 \begin_inset Flex Code
31786 \begin_layout Plain Layout
31788 \change_inserted 1075283030 1597698987
31800 \begin_layout Itemize
31802 \change_inserted 1075283030 1597699279
31803 \begin_inset Quotes eld
31807 \begin_inset Flex Code
31810 \begin_layout Plain Layout
31812 \change_inserted 1075283030 1597699012
31821 \begin_inset Quotes erd
31825 the opening and closing tags are on their own lines (i.e.
31826 a line feed after and before the opening and the closing tags).
31827 Typical elements are floats.
31832 \begin_layout LyX-Code
31834 \change_inserted 1075283030 1597699194
31838 \begin_layout LyX-Code
31840 \change_inserted 1075283030 1597699194
31844 \begin_layout LyX-Code
31846 \change_inserted 1075283030 1597699098
31847 Contents of the block.
31850 \begin_layout LyX-Code
31852 \change_inserted 1075283030 1597699196
31856 \begin_layout LyX-Code
31858 \change_inserted 1075283030 1597699198
31862 \begin_layout Itemize
31864 \change_inserted 1075283030 1597699289
31865 \begin_inset Quotes eld
31869 \begin_inset Flex Code
31872 \begin_layout Plain Layout
31874 \change_inserted 1075283030 1597699113
31883 \begin_inset Quotes erd
31887 the opening and closing tags are on the same,
31889 a line feed is output before the opening tag and after the closing tag.
31890 Typical elements are paragraphs and list items.
31895 \begin_layout LyX-Code
31897 \change_inserted 1075283030 1597699186
31901 \begin_layout LyX-Code
31903 \change_inserted 1075283030 1597699357
31904 <paratag>Contents of the paragraph.</paratag>
31907 \begin_layout LyX-Code
31909 \change_inserted 1075283030 1597699231
31913 \begin_layout Itemize
31915 \change_inserted 1075283030 1597699343
31916 \begin_inset Quotes eld
31920 \begin_inset Flex Code
31923 \begin_layout Plain Layout
31925 \change_inserted 1075283030 1597699307
31934 \begin_inset Quotes erd
31938 the opening and closing tags are on the same line as the rest of the content.
31939 No line feeds are output.
31940 Typical elements are fonts.
31945 \begin_layout LyX-Code
31947 \change_inserted 1075283030 1597699585
31948 Content before<inlinetag>Contents of the paragraph.</inlinetag>Content after
31951 \begin_layout Standard
31953 \change_inserted 1075283030 1597699585
31954 The default value is always
31955 \begin_inset Quotes eld
31959 \begin_inset Flex Code
31962 \begin_layout Plain Layout
31964 \change_inserted 1075283030 1597699585
31973 \begin_inset Quotes erd
31981 \begin_layout Subsection
31983 \change_inserted -970929547 1515111533
31984 InsetLayout DocBook
31989 \begin_layout Standard
31991 \change_inserted -970929547 1496611894
31992 The DocBook output of insets can also be controlled by information in layout files.
31995 \begin_layout Standard
31997 \change_inserted -970929547 1496612045
31998 The DocBook \SpecialChar LyX
31999 outputs for an inset has the following form:
32002 \begin_layout LyX-Code
32004 \change_inserted -970929547 1515110861
32005 <wrappertag wrapperattr>
32008 \begin_layout LyX-Code
32010 \change_inserted -970929547 1515110868
32014 \begin_layout LyX-Code
32016 \change_inserted -970929547 1515110869
32017 <innertag innerattr>
32020 \begin_layout LyX-Code
32022 \change_inserted -970929547 1515110869
32023 Contents of the inset.
32026 \begin_layout LyX-Code
32028 \change_inserted -970929547 1515110870
32032 \begin_layout LyX-Code
32034 \change_inserted -970929547 1515110871
32038 \begin_layout LyX-Code
32040 \change_inserted -970929547 1515111172
32044 \begin_layout Standard
32046 \change_inserted -970929547 1515111186
32047 For an itemising inset,
32048 it rather looks like this:
32052 \begin_layout LyX-Code
32054 \change_inserted -970929547 1515111186
32055 <wrappertag wrapperattr>
32058 \begin_layout LyX-Code
32060 \change_inserted -970929547 1515111186
32064 \begin_layout LyX-Code
32066 \change_inserted -970929547 1515111186
32067 <innertag innerattr>
32070 \begin_layout LyX-Code
32072 \change_inserted -970929547 1515111362
32073 <itemwrappertag itemwrapperattr>
32076 \begin_layout LyX-Code
32078 \change_inserted -970929547 1515111364
32079 <itemlabeltag itemattr>
32082 \begin_layout LyX-Code
32084 \change_inserted -970929547 1515111367
32085 Label of the first item.
32088 \begin_layout LyX-Code
32090 \change_inserted -970929547 1515111362
32096 \begin_layout LyX-Code
32098 \change_inserted -970929547 1515111517
32102 \begin_layout LyX-Code
32104 \change_inserted -970929547 1515111517
32110 \begin_layout LyX-Code
32112 \change_inserted -970929547 1515111516
32113 Contents of the first item.
32116 \begin_layout LyX-Code
32118 \change_inserted -970929547 1515111514
32124 \begin_layout LyX-Code
32126 \change_inserted -970929547 1515111247
32132 \begin_layout LyX-Code
32134 \change_inserted -970929547 1515111221
32138 \begin_layout LyX-Code
32140 \change_inserted -970929547 1515111370
32141 <itemwrappertag itemwrapperattr>
32144 \begin_layout LyX-Code
32146 \change_inserted -970929547 1515111370
32147 <itemlabeltag itemattr>
32150 \begin_layout LyX-Code
32152 \change_inserted -970929547 1515111372
32153 Label of the second item.
32156 \begin_layout LyX-Code
32158 \change_inserted -970929547 1515111370
32164 \begin_layout LyX-Code
32166 \change_inserted -970929547 1515111504
32170 \begin_layout LyX-Code
32172 \change_inserted -970929547 1515111505
32178 \begin_layout LyX-Code
32180 \change_inserted -970929547 1515111507
32181 Contents of the second item.
32184 \begin_layout LyX-Code
32186 \change_inserted -970929547 1515111509
32192 \begin_layout LyX-Code
32194 \change_inserted -970929547 1515111251
32200 \begin_layout LyX-Code
32202 \change_inserted -970929547 1515111221
32208 \begin_layout LyX-Code
32210 \change_inserted -970929547 1515111219
32216 \begin_layout LyX-Code
32218 \change_inserted -970929547 1515111186
32222 \begin_layout LyX-Code
32224 \change_inserted -970929547 1515111186
32228 \begin_layout LyX-Code
32230 \change_inserted -970929547 1515111186
32234 \begin_layout Standard
32236 \change_inserted -970929547 1515111183
32237 If the inset permits multiple paragraphs—
32240 \begin_inset Flex Code
32243 \begin_layout Plain Layout
32245 \change_inserted -970929547 1496610966
32254 then the contents of the inset will
32255 \change_deleted 34634807 1620029217
32257 \change_inserted 34634807 1620029219
32259 \change_inserted -970929547 1515111183
32260 be output as paragraphs formatted according to the styles used for those paragraphs (standard,
32263 The inner tag is optional and,
32268 \begin_layout Standard
32270 \change_inserted -970929547 1496610966
32271 The specific tags and attributes output for each inset can be controlled by means of the following layout tags.
32274 \begin_layout Description
32276 \change_inserted -970929547 1515110317
32277 \begin_inset Flex Code
32280 \begin_layout Plain Layout
32282 \change_inserted -970929547 1515109695
32291 \begin_inset Flex Code
32294 \begin_layout Plain Layout
32296 \change_inserted -970929547 1496611854
32304 ] Specifies attribute information to be output with the main tag,
32306 \begin_inset Quotes eld
32310 \begin_inset Flex Code
32313 \begin_layout Plain Layout
32315 \change_inserted -970929547 1515110044
32324 \begin_inset Quotes erd
32327 in the example above.
32328 This information can be used in further processing of the DocBook files.
32332 \begin_layout Description
32334 \change_inserted -970929547 1515110973
32335 \begin_inset Flex Code
32338 \begin_layout Plain Layout
32340 \change_inserted -970929547 1515110319
32349 \begin_inset Flex Code
32352 \begin_layout Plain Layout
32354 \change_inserted -970929547 1515110384
32364 ] Specifies whether this tag goes into the
32365 \begin_inset Flex Code
32368 \begin_layout Plain Layout
32370 \change_inserted -970929547 1515110412
32378 tag at the beginning of the parent layout.
32380 \begin_inset Flex Code
32383 \begin_layout Plain Layout
32385 \change_inserted -970929547 1515110437
32393 indicates that the tag never goes into
32394 \begin_inset Flex Code
32397 \begin_layout Plain Layout
32399 \change_inserted -970929547 1515110497
32407 (this is default value,
32408 and corresponds to usual content).
32410 \begin_inset Flex Code
32413 \begin_layout Plain Layout
32415 \change_inserted -970929547 1515110517
32423 indicates that the tag always goes into
32424 \begin_inset Flex Code
32427 \begin_layout Plain Layout
32429 \change_inserted -970929547 1515110514
32437 (this corresponds to usual metadata):
32439 \begin_inset Flex Code
32442 \begin_layout Plain Layout
32444 \change_inserted -970929547 1515110550
32452 tag for the parent,
32459 \begin_inset Flex Code
32462 \begin_layout Plain Layout
32464 \change_inserted -970929547 1515110540
32472 indicates that the tag may go into
32473 \begin_inset Flex Code
32476 \begin_layout Plain Layout
32478 \change_inserted -970929547 1515110538
32486 (this is only the case for titles):
32488 \begin_inset Flex Code
32491 \begin_layout Plain Layout
32493 \change_inserted -970929547 1515110585
32501 tag for the parent,
32507 the corresponding tag will be output directly as content.
32511 \begin_layout Description
32513 \change_inserted -970929547 1515111461
32514 \begin_inset Flex Code
32517 \begin_layout Plain Layout
32519 \change_inserted -970929547 1515110974
32528 \begin_inset Flex Code
32531 \begin_layout Plain Layout
32533 \change_inserted -970929547 1515110973
32541 ] Specifies attribute information to be output with the item tag,
32543 \begin_inset Quotes eld
32547 \begin_inset Flex Code
32550 \begin_layout Plain Layout
32552 \change_inserted -970929547 1515110984
32561 \begin_inset Quotes erd
32564 in the example above.
32565 This information can be used in further processing of the DocBook files.
32569 \begin_layout Description
32571 \change_inserted -970929547 1515111471
32572 \begin_inset Flex Code
32575 \begin_layout Plain Layout
32577 \change_inserted -970929547 1515111465
32578 DocBookItemInnerAttr
32586 \begin_inset Flex Code
32589 \begin_layout Plain Layout
32591 \change_inserted -970929547 1515111461
32599 ] Specifies attribute information to be output with the item inner tag,
32601 \begin_inset Quotes eld
32605 \begin_inset Flex Code
32608 \begin_layout Plain Layout
32610 \change_inserted -970929547 1515111476
32619 \begin_inset Quotes erd
32622 in the example above.
32623 This information can be used in further processing of the DocBook files.
32627 \begin_layout Description
32629 \change_inserted -970929547 1515111494
32630 \begin_inset Flex Code
32633 \begin_layout Plain Layout
32635 \change_inserted -970929547 1515111467
32636 DocBookItemInnerTag
32644 \begin_inset Flex Code
32647 \begin_layout Plain Layout
32649 \change_inserted -970929547 1515111461
32657 ] The tag to be used for the item inner tag within the inset,
32659 \begin_inset Quotes eld
32663 \begin_inset Flex Code
32666 \begin_layout Plain Layout
32668 \change_inserted -970929547 1515111486
32677 \begin_inset Quotes erd
32680 in the example above.
32682 \begin_inset Flex Code
32685 \begin_layout Plain Layout
32687 \change_inserted -970929547 1515111461
32696 indicating that there is no item inner tag:
32697 content is directly output without it for each itemised element.
32698 This parameter only makes sense when itemising layouts are used,
32701 \change_inserted 1075283030 1598469472
32702 The most likely value is
32703 \begin_inset Quotes eld
32707 \begin_inset Flex Code
32710 \begin_layout Plain Layout
32712 \change_inserted 1075283030 1598469476
32721 \begin_inset Quotes erd
32725 \begin_inset Newline newline
32728 When a list item is split using a new line,
32729 the item inner tag will be repeated for each part of the paragraph,
32730 parts being separated by new lines.
32734 \begin_layout Description
32736 \change_inserted 1075283030 1597699866
32737 \begin_inset Flex Code
32740 \begin_layout Plain Layout
32742 \change_inserted 1075283030 1597699853
32743 DocBookItemInnerTagType
32751 \begin_inset Flex Code
32754 \begin_layout Plain Layout
32756 \change_inserted 1075283030 1597699866
32766 ] The new-line policy for this tag,
32768 \begin_inset space ~
32772 \begin_inset CommandInset ref
32774 reference "subsec:DocBook-New-line-policy"
32788 \begin_layout Description
32790 \change_inserted -970929547 1515111290
32791 \begin_inset Flex Code
32794 \begin_layout Plain Layout
32796 \change_inserted -970929547 1515111283
32797 DocBookItemLabelAttr
32805 \begin_inset Flex Code
32808 \begin_layout Plain Layout
32810 \change_inserted -970929547 1515111279
32818 ] Specifies attribute information to be output with the item label tag,
32820 \begin_inset Quotes eld
32824 \begin_inset Flex Code
32827 \begin_layout Plain Layout
32829 \change_inserted -970929547 1515111304
32838 \begin_inset Quotes erd
32841 in the example above.
32842 This information can be used in further processing of the DocBook files.
32846 \begin_layout Description
32848 \change_inserted -970929547 1515111337
32849 \begin_inset Flex Code
32852 \begin_layout Plain Layout
32854 \change_inserted -970929547 1515111285
32855 DocBookItemLabelTag
32863 \begin_inset Flex Code
32866 \begin_layout Plain Layout
32868 \change_inserted -970929547 1515111279
32876 ] The tag to be used for the item label tag within the inset,
32878 \begin_inset Quotes eld
32882 \begin_inset Flex Code
32885 \begin_layout Plain Layout
32887 \change_inserted -970929547 1515111311
32896 \begin_inset Quotes erd
32899 in the example above.
32900 This parameter only makes sense when itemising layouts are used with a notion of labels,
32901 such as definition lists.
32903 \change_inserted 1075283030 1597699874
32907 \begin_layout Description
32909 \change_inserted 1075283030 1597699874
32910 \begin_inset Flex Code
32913 \begin_layout Plain Layout
32915 \change_inserted 1075283030 1597699880
32916 DocBookItemLabelTagType
32924 \begin_inset Flex Code
32927 \begin_layout Plain Layout
32929 \change_inserted 1075283030 1597699874
32939 ] The new-line policy for this tag,
32941 \begin_inset space ~
32945 \begin_inset CommandInset ref
32947 reference "subsec:DocBook-New-line-policy"
32961 \begin_layout Description
32963 \change_inserted -970929547 1515111124
32964 \begin_inset Flex Code
32967 \begin_layout Plain Layout
32969 \change_inserted -970929547 1515111060
32978 \begin_inset Flex Code
32981 \begin_layout Plain Layout
32983 \change_inserted -970929547 1515111060
32991 ] The tag to be used for the item tag within the inset,
32993 \begin_inset Quotes eld
32997 \begin_inset Flex Code
33000 \begin_layout Plain Layout
33002 \change_inserted -970929547 1515111060
33011 \begin_inset Quotes erd
33014 in the example above.
33016 \begin_inset Flex Code
33019 \begin_layout Plain Layout
33021 \change_inserted -970929547 1515111060
33030 indicating that there is no item tag.
33031 This parameter only makes sense when itemising layouts are used,
33034 \change_inserted 1075283030 1597699890
33038 \begin_layout Description
33040 \change_inserted 1075283030 1597699890
33041 \begin_inset Flex Code
33044 \begin_layout Plain Layout
33046 \change_inserted 1075283030 1597699890
33055 \begin_inset Flex Code
33058 \begin_layout Plain Layout
33060 \change_inserted 1075283030 1597699890
33070 ] The new-line policy for this tag,
33072 \begin_inset space ~
33076 \begin_inset CommandInset ref
33078 reference "subsec:DocBook-New-line-policy"
33092 \begin_layout Description
33094 \change_inserted -970929547 1515111298
33095 \begin_inset Flex Code
33098 \begin_layout Plain Layout
33100 \change_inserted -970929547 1515111124
33101 DocBookItemWrapperAttr
33109 \begin_inset Flex Code
33112 \begin_layout Plain Layout
33114 \change_inserted -970929547 1515111124
33122 ] Specifies attribute information to be output with the item wrapper tag,
33124 \begin_inset Quotes eld
33128 \begin_inset Flex Code
33131 \begin_layout Plain Layout
33133 \change_inserted -970929547 1515111150
33142 \begin_inset Quotes erd
33145 in the example above.
33146 This information can be used in further processing of the DocBook files.
33152 \begin_layout Description
33154 \change_inserted -970929547 1515111113
33155 \begin_inset Flex Code
33158 \begin_layout Plain Layout
33160 \change_inserted -970929547 1515111073
33161 DocBookItemWrapperTag
33169 \begin_inset Flex Code
33172 \begin_layout Plain Layout
33174 \change_inserted -970929547 1515111073
33182 ] The tag to be used for the item wrapper tag within the inset,
33184 \begin_inset Quotes eld
33188 \begin_inset Flex Code
33191 \begin_layout Plain Layout
33193 \change_inserted -970929547 1515111083
33202 \begin_inset Quotes erd
33205 in the example above.
33207 \begin_inset Flex Code
33210 \begin_layout Plain Layout
33212 \change_inserted -970929547 1515111073
33221 indicating that there is no item wrapper tag:
33222 tag and content are directly output without it for each itemised element.
33223 This parameter only makes sense when itemising layouts are used,
33226 \change_inserted 1075283030 1597699897
33230 \begin_layout Description
33232 \change_inserted 1075283030 1597699897
33233 \begin_inset Flex Code
33236 \begin_layout Plain Layout
33238 \change_inserted 1075283030 1597699900
33239 DocBookItemWrapperTagType
33247 \begin_inset Flex Code
33250 \begin_layout Plain Layout
33252 \change_inserted 1075283030 1597699897
33262 ] The new-line policy for this tag,
33264 \begin_inset space ~
33268 \begin_inset CommandInset ref
33270 reference "subsec:DocBook-New-line-policy"
33284 \begin_layout Description
33286 \change_inserted -970929547 1515110104
33287 \begin_inset Flex Code
33290 \begin_layout Plain Layout
33292 \change_inserted -970929547 1515110104
33301 \begin_inset Flex Code
33304 \begin_layout Plain Layout
33306 \change_inserted -970929547 1515110104
33314 ] Specifies attribute information to be output with the inner tag,
33316 \begin_inset Quotes eld
33320 \begin_inset Flex Code
33323 \begin_layout Plain Layout
33325 \change_inserted -970929547 1515110104
33334 \begin_inset Quotes erd
33337 in the example above.
33338 This information can be used in further processing of the DocBook files.
33342 \begin_layout Description
33344 \change_inserted -970929547 1515110906
33345 \begin_inset Flex Code
33348 \begin_layout Plain Layout
33350 \change_inserted -970929547 1515110104
33359 \begin_inset Flex Code
33362 \begin_layout Plain Layout
33364 \change_inserted -970929547 1515110104
33372 ] The tag to be used for the inner tag within the inset,
33374 \begin_inset Quotes eld
33378 \begin_inset Flex Code
33381 \begin_layout Plain Layout
33383 \change_inserted -970929547 1515110104
33392 \begin_inset Quotes erd
33395 in the example above.
33397 \begin_inset Flex Code
33400 \begin_layout Plain Layout
33402 \change_inserted -970929547 1515110791
33411 indicating that there is no inner tag:
33412 content is directly output without it.
33413 \change_inserted 1075283030 1597699904
33417 \begin_layout Description
33419 \change_inserted 1075283030 1597699904
33420 \begin_inset Flex Code
33423 \begin_layout Plain Layout
33425 \change_inserted 1075283030 1597699904
33426 DocBookInnerTagType
33434 \begin_inset Flex Code
33437 \begin_layout Plain Layout
33439 \change_inserted 1075283030 1597699904
33449 ] The new-line policy for this tag,
33451 \begin_inset space ~
33455 \begin_inset CommandInset ref
33457 reference "subsec:DocBook-New-line-policy"
33471 \begin_layout Description
33473 \change_inserted -970929547 1515110753
33474 \begin_inset Flex Code
33477 \begin_layout Plain Layout
33479 \change_inserted -970929547 1515110665
33488 \begin_inset Flex Code
33491 \begin_layout Plain Layout
33493 \change_inserted -970929547 1515110661
33501 ] Specifies the tag that corresponds to this kind of section.
33502 This parameter only makes sense for sectioning elements (part,
33506 The default value is
33507 \begin_inset Flex Code
33510 \begin_layout Plain Layout
33512 \change_inserted -970929547 1515110721
33521 and is only overridden when DocBook uses something else for sectioning (
33522 \change_inserted 1075283030 1597699921
33525 \change_inserted -970929547 1515110753
33526 parts and chapters of a book).
33532 \begin_layout Description
33534 \change_inserted -970929547 1515110811
33535 \begin_inset Flex Code
33538 \begin_layout Plain Layout
33540 \change_inserted -970929547 1496612023
33549 \begin_inset Flex Code
33552 \begin_layout Plain Layout
33554 \change_inserted -970929547 1496610966
33562 ] The tag to be used for this inset,
33564 \begin_inset Quotes eld
33568 \begin_inset Flex Code
33571 \begin_layout Plain Layout
33573 \change_inserted -970929547 1496612033
33582 \begin_inset Quotes erd
33585 in the example above.
33586 The default is the name of the float and always needs to be changed,
33587 as DocBook provides no generic inset tag.
33588 \change_inserted 1075283030 1597699924
33592 \begin_layout Description
33594 \change_inserted 1075283030 1597699924
33595 \begin_inset Flex Code
33598 \begin_layout Plain Layout
33600 \change_inserted 1075283030 1597699924
33609 \begin_inset Flex Code
33612 \begin_layout Plain Layout
33614 \change_inserted 1075283030 1597699924
33624 ] The new-line policy for this tag,
33626 \begin_inset space ~
33630 \begin_inset CommandInset ref
33632 reference "subsec:DocBook-New-line-policy"
33646 \begin_layout Description
33648 \change_inserted -970929547 1515110832
33649 \begin_inset Flex Code
33652 \begin_layout Plain Layout
33654 \change_inserted -970929547 1515110822
33663 \begin_inset Flex Code
33666 \begin_layout Plain Layout
33668 \change_inserted -970929547 1515110811
33676 ] Specifies attribute information to be output with the outer
33677 \change_inserted 34634807 1620057958
33679 \change_inserted -970929547 1515110832
33682 \begin_inset Quotes eld
33686 \begin_inset Flex Code
33689 \begin_layout Plain Layout
33691 \change_inserted -970929547 1515110845
33700 \begin_inset Quotes erd
33703 in the example above.
33704 This information can be used in further processing of the DocBook files.
33708 \begin_layout Description
33710 \change_inserted -970929547 1515110917
33711 \begin_inset Flex Code
33714 \begin_layout Plain Layout
33716 \change_inserted -970929547 1515110826
33725 \begin_inset Flex Code
33728 \begin_layout Plain Layout
33730 \change_inserted -970929547 1515110811
33738 ] The tag to be used for the wrapper tag around the inset,
33740 \begin_inset Quotes eld
33744 \begin_inset Flex Code
33747 \begin_layout Plain Layout
33749 \change_inserted -970929547 1515110842
33758 \begin_inset Quotes erd
33761 in the example above.
33763 \begin_inset Flex Code
33766 \begin_layout Plain Layout
33768 \change_inserted -970929547 1515110811
33777 indicating that there is no wrapper tag:
33778 tag and content are directly output without it.
33779 \change_inserted 1075283030 1597699929
33783 \begin_layout Description
33785 \change_inserted 1075283030 1597699929
33786 \begin_inset Flex Code
33789 \begin_layout Plain Layout
33791 \change_inserted 1075283030 1597699932
33792 DocBookWrapperTagType
33800 \begin_inset Flex Code
33803 \begin_layout Plain Layout
33805 \change_inserted 1075283030 1597699929
33815 ] The new-line policy for this tag,
33817 \begin_inset space ~
33821 \begin_inset CommandInset ref
33823 reference "subsec:DocBook-New-line-policy"
33837 \begin_layout Subsection
33839 \change_inserted -970929547 1515110040
33843 \begin_layout Standard
33845 \change_inserted -970929547 1496611700
33846 The DocBook output for floats too can be controlled by layout information.
33847 The output has the following form:
33850 \begin_layout LyX-Code
33852 \change_inserted -970929547 1515109700
33856 \begin_layout LyX-Code
33858 \change_inserted -970929547 1515110138
33859 Contents of the float as DocBook.
33862 \begin_layout LyX-Code
33864 \change_inserted -970929547 1496610966
33868 \begin_layout Standard
33870 \change_inserted -970929547 1496611715
33873 is a separate inset and will be output as a title.
33877 \begin_layout Description
33879 \change_inserted -970929547 1515110033
33880 \begin_inset Flex Code
33883 \begin_layout Plain Layout
33885 \change_inserted -970929547 1515109702
33894 \begin_inset Flex Code
33897 \begin_layout Plain Layout
33899 \change_inserted -970929547 1496610966
33907 ] Specifies attribute information to be output with the main tag,
33909 \begin_inset Quotes eld
33913 \begin_inset Flex Code
33916 \begin_layout Plain Layout
33918 \change_inserted -970929547 1515110035
33927 \begin_inset Quotes erd
33930 in the example above.
33931 This information can be used in further processing of the DocBook files.
33935 \begin_layout Description
33937 \change_inserted -970929547 1515110157
33938 \begin_inset Flex Code
33941 \begin_layout Plain Layout
33943 \change_inserted -970929547 1496611782
33952 \begin_inset Flex Code
33955 \begin_layout Plain Layout
33957 \change_inserted -970929547 1496610966
33965 ] The tag to be used for this float,
33967 \begin_inset Quotes eld
33971 \begin_inset Flex Code
33974 \begin_layout Plain Layout
33976 \change_inserted -970929547 1496610966
33985 \begin_inset Quotes erd
33988 in the example above.
33989 The default is the name of the float and always needs to be changed,
33990 as DocBook provides no generic float tag.
33993 \begin_layout Subsection
33995 \change_inserted -970929547 1515110157
33996 Bibliography formatting
33999 \begin_layout Standard
34001 \change_deleted 1075283030 1597699984
34003 \change_inserted 1075283030 1597699985
34005 \change_inserted -970929547 1515110187
34007 \change_deleted 1075283030 1597699987
34009 \change_inserted 1075283030 1597699987
34011 \change_inserted -970929547 1515110187
34012 cannot be formatted:
34013 all fields are always output in the database-like DocBook format (equivalent to a BibTeX file)
34014 \change_inserted 1075283030 1597700117
34017 \begin_inset Flex Code
34020 \begin_layout Plain Layout
34022 \change_inserted 1075283030 1597700120
34031 \change_inserted -970929547 1515110187
34033 \change_inserted 1075283030 1597700092
34037 \begin_layout Standard
34039 \change_inserted 1075283030 1597700112
34040 When the bibliographic entries are manually inserted into the
34041 \change_deleted 34634807 1620057319
34043 \change_inserted 34634807 1620057319
34046 \change_inserted 1075283030 1597700112
34047 document as Bibliography Items,
34048 the user deals with formatting
34051 \change_inserted 1075283030 1597700112
34053 there is no attempt of parsing what the user wrote,
34054 the string is directly used (with the
34055 \begin_inset Flex Code
34058 \begin_layout Plain Layout
34060 \change_inserted 1075283030 1597700076
34074 \begin_layout Chapter
34075 Including External Material
34076 \begin_inset CommandInset label
34078 name "chap:Including-External-Material"
34085 \begin_layout Standard
34086 \begin_inset Box Shadowbox
34096 height_special "totalheight"
34101 backgroundcolor "none"
34104 \begin_layout Plain Layout
34106 This portion of the documentation has not been updated for some time.
34107 We certainly hope that it is still accurate,
34108 but there are no guarantees.
34116 \begin_layout Standard
34117 The use of material from sources external to \SpecialChar LyX
34118 is covered in detail in the
34123 This part of the manual covers what needs to happen behind the scenes for new sorts of material to be included.
34126 \begin_layout Section
34130 \begin_layout Standard
34131 The external material feature is based on the concept of a
34136 A template is a specification of how \SpecialChar LyX
34137 should interface with a certain kind of material.
34140 comes with predefined templates for Xfig figures,
34141 various raster format images,
34143 and LilyPond music notation.
34144 You can check the actual list by using the menu
34145 \begin_inset Flex Noun
34148 \begin_layout Plain Layout
34149 Insert\SpecialChar menuseparator
34150 File\SpecialChar menuseparator
34158 it is possible to roll your own template to support a specific kind of material.
34159 Later we'll describe in more detail what is involved,
34160 and hopefully you will submit all the templates you create so we can include them in a later \SpecialChar LyX
34164 \begin_layout Standard
34165 Another basic idea of the external material feature is to distinguish between the original file that serves as a base for final material and the produced file that is included in your exported or printed document.
34167 consider the case of a figure produced with
34168 \begin_inset Flex Code
34171 \begin_layout Plain Layout
34178 The Xfig application itself works on an original file with the
34179 \begin_inset Flex Code
34182 \begin_layout Plain Layout
34190 you create and change your figure,
34191 and when you are done,
34193 \begin_inset Flex Code
34196 \begin_layout Plain Layout
34203 When you want to include the figure in your document,
34205 \begin_inset Flex Code
34208 \begin_layout Plain Layout
34214 in order to create a PostScript file that can readily be included in your \SpecialChar LaTeX
34218 \begin_inset Flex Code
34221 \begin_layout Plain Layout
34227 file is the original file,
34228 and the PostScript file is the produced file.
34231 \begin_layout Standard
34232 This distinction is important in order to allow updating of the material while you are in the process of writing the document.
34234 it provides us with the flexibility that is needed to support multiple export formats.
34236 in the case of a plain text file,
34237 it is not exactly an award-winning idea to include the figure as raw PostScript.
34239 you would either prefer to just include a reference to the figure or try to invoke some graphics to ASCII converter to make the final result look similar to the real graphics.
34240 The external material management allows you to do this,
34241 because it is parametrized on the different export formats that \SpecialChar LyX
34245 \begin_layout Standard
34246 Besides supporting the production of different products according to the exported format,
34247 it supports tight integration with editing and viewing applications.
34248 In the case of an Xfig figure,
34249 you are able to invoke Xfig on the original file with a single click from within the external material dialog in \SpecialChar LyX
34251 and also preview the produced PostScript file with Ghostview with another click.
34252 No more fiddling around with the command line and/or file browsers to locate and manipulate the original or produced files.
34254 you are finally able to take full advantage of the many different applications that are relevant to use when you write your documents,
34255 and ultimately be more productive.
34258 \begin_layout Section
34259 The external template configuration files
34262 \begin_layout Standard
34263 It is relatively easy to add custom external template definitions to \SpecialChar LyX
34266 be aware that doing this in an careless manner most probably
34270 introduce an easily exploitable security hole.
34271 So before you do this,
34272 please read the discussion about security in
34273 \begin_inset CommandInset ref
34275 reference "sec:Security-discussion"
34283 \begin_layout Standard
34285 we encourage you to submit any interesting templates that you create.
34289 \begin_layout Standard
34290 The external templates are defined in the
34291 \begin_inset Flex Code
34294 \begin_layout Plain Layout
34300 files that are stored in the
34301 \begin_inset Flex Code
34304 \begin_layout Plain Layout
34305 LyXDir/lib/xtemplates/
34311 Each template is defined in a file of its own.
34312 You can place your own templates in
34313 \begin_inset Flex Code
34316 \begin_layout Plain Layout
34317 UserDir/xtemplates/
34322 or copy existing templates to that directory in order to modify them.
34325 \begin_layout Standard
34326 A typical template looks like this:
34329 \begin_layout LyX-Code
34333 \begin_layout LyX-Code
34335 $$AbsOrRelPathParent$$Basename"
34338 \begin_layout LyX-Code
34342 \begin_layout LyX-Code
34346 \begin_layout LyX-Code
34350 \begin_layout LyX-Code
34354 \begin_layout LyX-Code
34358 \begin_layout LyX-Code
34359 AutomaticProduction true
34362 \begin_layout LyX-Code
34366 \begin_layout LyX-Code
34370 \begin_layout LyX-Code
34374 \begin_layout LyX-Code
34375 TransformCommand Rotate RotationLatexCommand
34378 \begin_layout LyX-Code
34379 TransformCommand Resize ResizeLatexCommand
34382 \begin_layout LyX-Code
34383 Product "$$RotateFront$$ResizeFront
34386 \begin_layout LyX-Code
34391 input{$$AbsOrRelPathMaster$$Basename.pstex_t}
34394 \begin_layout LyX-Code
34395 $$ResizeBack$$RotateBack"
34398 \begin_layout LyX-Code
34402 \begin_layout LyX-Code
34403 UpdateResult "$$AbsPath$$Basename.pstex_t"
34406 \begin_layout LyX-Code
34407 Requirement "graphicx"
34410 \begin_layout LyX-Code
34411 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
34414 \begin_layout LyX-Code
34415 ReferencedFile latex "$$AbsPath$$Basename.eps"
34418 \begin_layout LyX-Code
34419 ReferencedFile dvi "$$AbsPath$$Basename.eps"
34422 \begin_layout LyX-Code
34426 \begin_layout LyX-Code
34430 \begin_layout LyX-Code
34431 TransformCommand Rotate RotationLatexCommand
34434 \begin_layout LyX-Code
34435 TransformCommand Resize ResizeLatexCommand
34438 \begin_layout LyX-Code
34439 Product "$$RotateFront$$ResizeFront
34442 \begin_layout LyX-Code
34447 input{$$AbsOrRelPathMaster$$Basename.pdftex_t}
34450 \begin_layout LyX-Code
34451 $$ResizeBack$$RotateBack"
34454 \begin_layout LyX-Code
34455 UpdateFormat pdftex
34458 \begin_layout LyX-Code
34459 UpdateResult "$$AbsPath$$Basename.pdftex_t"
34462 \begin_layout LyX-Code
34463 Requirement "graphicx"
34466 \begin_layout LyX-Code
34467 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pdftex_t"
34470 \begin_layout LyX-Code
34471 ReferencedFile latex "$$AbsPath$$Basename.pdf"
34474 \begin_layout LyX-Code
34478 \begin_layout LyX-Code
34482 \begin_layout LyX-Code
34487 \begin_layout LyX-Code
34491 \begin_layout LyX-Code
34495 \begin_layout LyX-Code
34496 Product "<graphic fileref=
34498 "$$AbsOrRelPathMaster$$Basename.eps
34503 \begin_layout LyX-Code
34507 \begin_layout LyX-Code
34511 \begin_layout LyX-Code
34512 UpdateResult "$$AbsPath$$Basename.eps"
34515 \begin_layout LyX-Code
34516 ReferencedFile docbook "$$AbsPath$$Basename.eps"
34519 \begin_layout LyX-Code
34520 ReferencedFile docbook-xml "$$AbsPath$$Basename.eps"
34523 \begin_layout LyX-Code
34527 \begin_layout LyX-Code
34531 \begin_layout Standard
34533 the template is enclosed in
34534 \begin_inset Flex Code
34537 \begin_layout Plain Layout
34545 \begin_inset Flex Code
34548 \begin_layout Plain Layout
34555 It contains a header specifying some general settings and,
34556 for each supported primary document file format,
34558 \begin_inset Flex Code
34561 \begin_layout Plain Layout
34569 \begin_inset Flex Code
34572 \begin_layout Plain Layout
34581 \begin_layout Subsection
34582 The template header
34585 \begin_layout Description
34586 \begin_inset Flex Code
34589 \begin_layout Plain Layout
34590 AutomaticProduction
34591 \begin_inset space ~
34599 Whether the file represented by the template must be generated by \SpecialChar LyX
34601 This command must occur exactly once.
34604 \begin_layout Description
34605 \begin_inset Flex Code
34608 \begin_layout Plain Layout
34610 \begin_inset space ~
34618 A glob pattern that is used in the file dialog to filter out the desired files.
34619 If there is more than one possible file extension (e.
34620 \begin_inset space \thinspace{}
34624 \begin_inset space \space{}
34628 \begin_inset Flex Code
34631 \begin_layout Plain Layout
34638 \begin_inset Flex Code
34641 \begin_layout Plain Layout
34649 \begin_inset Flex Code
34652 \begin_layout Plain Layout
34659 This command must occur exactly once.
34662 \begin_layout Description
34663 \begin_inset Flex Code
34666 \begin_layout Plain Layout
34668 \begin_inset space ~
34676 The text that is displayed on the button.
34677 This command must occur exactly once.
34680 \begin_layout Description
34681 \begin_inset Flex Code
34684 \begin_layout Plain Layout
34686 \begin_inset space ~
34690 \begin_inset space ~
34698 The help text that is used in the External dialog.
34699 Provide enough information to explain to the user just what the template can provide him with.
34700 This command must occur exactly once.
34703 \begin_layout Description
34704 \begin_inset Flex Code
34707 \begin_layout Plain Layout
34709 \begin_inset space ~
34717 The file format of the original file.
34718 This must be the name of a format that is known to \SpecialChar LyX
34720 \begin_inset CommandInset ref
34722 reference "sec:Formats"
34729 \begin_inset Quotes eld
34733 \begin_inset Flex Code
34736 \begin_layout Plain Layout
34743 \begin_inset Quotes erd
34746 if the template can handle original files of more than one format.
34748 will attempt to interrogate the file itself in order to deduce its format in this case.
34749 This command must occur exactly once.
34752 \begin_layout Description
34753 \begin_inset Flex Code
34756 \begin_layout Plain Layout
34758 \begin_inset space ~
34766 A unique name for the template.
34767 It must not contain substitution macros (see below).
34770 \begin_layout Description
34771 \begin_inset Flex Code
34774 \begin_layout Plain Layout
34776 \begin_inset space ~
34779 Rotate|Resize|Clip|Extra
34784 This command specifies which transformations are supported by this template.
34785 It may occur zero or more times.
34786 This command enables the corresponding tabs in the external dialog.
34788 \begin_inset Flex Code
34791 \begin_layout Plain Layout
34797 command must have either a corresponding
34798 \begin_inset Flex Code
34801 \begin_layout Plain Layout
34808 \begin_inset Flex Code
34811 \begin_layout Plain Layout
34818 \begin_inset Flex Code
34821 \begin_layout Plain Layout
34828 Otherwise the transformation will not be supported by that format.
34831 \begin_layout Subsection
34835 \begin_layout Description
34836 \begin_inset Flex Code
34839 \begin_layout Plain Layout
34841 \begin_inset space ~
34844 LaTeX|PDFLaTeX|PlainText|DocBook|XHTML
34849 The primary document file format that this format definition is for.
34850 Not every template has a sensible representation in all document file formats.
34851 Please define nevertheless a
34852 \begin_inset Flex Code
34855 \begin_layout Plain Layout
34861 section for all templates.
34862 Use a dummy text when no representation is available.
34863 Then you can at least see a reference to the external material in the exported document.
34866 \begin_layout Description
34867 \begin_inset Flex Code
34870 \begin_layout Plain Layout
34872 \begin_inset space ~
34876 \begin_inset space ~
34884 This command defines an additional macro
34885 \begin_inset Flex Code
34888 \begin_layout Plain Layout
34894 for substitution in
34895 \begin_inset Flex Code
34898 \begin_layout Plain Layout
34906 \begin_inset Flex Code
34909 \begin_layout Plain Layout
34915 itself may contain substitution macros.
34916 The advantage over using
34917 \begin_inset Flex Code
34920 \begin_layout Plain Layout
34927 \begin_inset Flex Code
34930 \begin_layout Plain Layout
34936 is that the substituted value of
34937 \begin_inset Flex Code
34940 \begin_layout Plain Layout
34946 is sanitized so that it is a valid optional argument in the document format.
34947 This command may occur zero or more times.
34950 \begin_layout Description
34951 \begin_inset Flex Code
34954 \begin_layout Plain Layout
34956 \begin_inset space ~
34964 The text that is inserted in the exported document.
34965 This is actually the most important command and can be quite complex.
34966 This command must occur exactly once.
34969 \begin_layout Description
34970 \begin_inset Flex Code
34973 \begin_layout Plain Layout
34975 \begin_inset space ~
34983 This command specifies a preamble snippet that will be included in the \SpecialChar LaTeX
34985 It has to be defined using
34986 \begin_inset Flex Code
34989 \begin_layout Plain Layout
34997 \begin_inset Flex Code
35000 \begin_layout Plain Layout
35007 This command may occur zero or more times.
35010 \begin_layout Description
35011 \begin_inset Flex Code
35014 \begin_layout Plain Layout
35016 \begin_inset space ~
35020 \begin_inset space ~
35028 This command denotes files that are created by the conversion process and are needed for a particular export format.
35029 If the filename is relative,
35030 it is interpreted relative to the master document.
35031 This command may be given zero or more times.
35034 \begin_layout Description
35035 \begin_inset Flex Code
35038 \begin_layout Plain Layout
35040 \begin_inset space ~
35048 The name of a required \SpecialChar LaTeX
35050 The package is included via
35051 \begin_inset Flex Code
35054 \begin_layout Plain Layout
35062 in the \SpecialChar LaTeX
35064 This command may occur zero or more times.
35067 \begin_layout Description
35068 \begin_inset Flex Code
35071 \begin_layout Plain Layout
35073 \begin_inset space ~
35077 \begin_inset space ~
35080 RotationLatexCommand
35085 This command specifies that the built in \SpecialChar LaTeX
35086 command should be used for rotation.
35087 This command may occur once or not at all.
35090 \begin_layout Description
35091 \begin_inset Flex Code
35094 \begin_layout Plain Layout
35096 \begin_inset space ~
35100 \begin_inset space ~
35108 This command specifies that the built in \SpecialChar LaTeX
35109 command should be used for resizing.
35110 This command may occur once or not at all.
35113 \begin_layout Description
35114 \begin_inset Flex Code
35117 \begin_layout Plain Layout
35119 \begin_inset space ~
35123 \begin_inset space ~
35126 RotationLatexOption
35131 This command specifies that rotation is done via an optional argument.
35132 This command may occur once or not at all.
35135 \begin_layout Description
35136 \begin_inset Flex Code
35139 \begin_layout Plain Layout
35141 \begin_inset space ~
35145 \begin_inset space ~
35153 This command specifies that resizing is done via an optional argument.
35154 This command may occur once or not at all.
35157 \begin_layout Description
35158 \begin_inset Flex Code
35161 \begin_layout Plain Layout
35163 \begin_inset space ~
35167 \begin_inset space ~
35175 This command specifies that clipping is done via an optional argument.
35176 This command may occur once or not at all.
35179 \begin_layout Description
35180 \begin_inset Flex Code
35183 \begin_layout Plain Layout
35185 \begin_inset space ~
35189 \begin_inset space ~
35197 This command specifies that an extra optional argument is used.
35198 This command may occur once or not at all.
35201 \begin_layout Description
35202 \begin_inset Flex Code
35205 \begin_layout Plain Layout
35207 \begin_inset space ~
35215 The file format of the converted file.
35216 This must be the name of a format that is known to \SpecialChar LyX
35218 \begin_inset Flex Noun
35221 \begin_layout Plain Layout
35222 Tools\SpecialChar menuseparator
35223 Preferences\SpecialChar menuseparator
35224 File Handling\SpecialChar menuseparator
35231 This command must occur exactly once.
35232 If the resulting file format is PDF,
35233 you need to specify the format
35234 \begin_inset Flex Code
35237 \begin_layout Plain Layout
35244 This is the PDF format used for including graphics.
35245 The other defined PDF formats are for document export.
35248 \begin_layout Description
35249 \begin_inset Flex Code
35252 \begin_layout Plain Layout
35254 \begin_inset space ~
35262 The file name of the converted file.
35263 The file name must be absolute.
35264 This command must occur exactly once.
35267 \begin_layout Subsection
35268 Preamble definitions
35271 \begin_layout Standard
35272 The external template configuration file may contain additional preamble definitions enclosed by
35273 \begin_inset Flex Code
35276 \begin_layout Plain Layout
35284 \begin_inset Flex Code
35287 \begin_layout Plain Layout
35294 They can be used by the templates in the
35295 \begin_inset Flex Code
35298 \begin_layout Plain Layout
35307 \begin_layout Section
35308 The substitution mechanism
35311 \begin_layout Standard
35312 When the external material facility invokes an external program,
35313 it is done on the basis of a command defined in the template configuration file.
35314 These commands can contain various macros that are expanded before execution.
35315 Execution always take place in the directory of the containing document.
35318 \begin_layout Standard
35320 whenever external material is to be displayed,
35321 the name will be produced by the substitution mechanism,
35322 and most other commands in the template definition support substitution as well.
35325 \begin_layout Standard
35326 The available macros are the following:
35329 \begin_layout Description
35330 \begin_inset Flex Code
35333 \begin_layout Plain Layout
35334 $$AbsOrRelPathMaster
35340 absolute or relative to the master \SpecialChar LyX
35344 \begin_layout Description
35345 \begin_inset Flex Code
35348 \begin_layout Plain Layout
35349 $$AbsOrRelPathParent
35355 absolute or relative to the \SpecialChar LyX
35359 \begin_layout Description
35360 \begin_inset Flex Code
35363 \begin_layout Plain Layout
35369 The absolute file path.
35372 \begin_layout Description
35373 \begin_inset Flex Code
35376 \begin_layout Plain Layout
35382 The filename without path and without the extension.
35385 \begin_layout Description
35386 \begin_inset Flex Code
35389 \begin_layout Plain Layout
35391 \begin_inset Quotes eld
35395 \begin_inset Quotes erd
35403 This macro will expand to the contents of the file with the name
35404 \begin_inset Flex Code
35407 \begin_layout Plain Layout
35416 \begin_layout Description
35417 \begin_inset Flex Code
35420 \begin_layout Plain Layout
35426 The file extension (including the dot).
35429 \begin_layout Description
35430 \begin_inset Flex Code
35433 \begin_layout Plain Layout
35439 This will be the string
35440 \begin_inset Quotes eld
35444 \begin_inset Quotes erd
35447 if the file is in JPEG format,
35448 otherwise it will be the string
35449 \begin_inset Quotes eld
35453 \begin_inset Quotes erd
35457 This is useful to avoid uneeded conversions for output formats that support both PNG and JPEG fomats.
35458 The predefined RasterImage template uses this macro for the pdf\SpecialChar TeX
35462 \begin_layout Description
35463 \begin_inset Flex Code
35466 \begin_layout Plain Layout
35472 The filename of the file specified in the external material dialog.
35473 This is either an absolute name,
35474 or it is relative to the \SpecialChar LyX
35478 \begin_layout Description
35479 \begin_inset Flex Code
35482 \begin_layout Plain Layout
35489 \begin_inset Flex Code
35492 \begin_layout Plain Layout
35498 (absolute name or relative to the \SpecialChar LyX
35502 \begin_layout Description
35503 \begin_inset Flex Code
35506 \begin_layout Plain Layout
35513 relative to the master \SpecialChar LyX
35517 \begin_layout Description
35518 \begin_inset Flex Code
35521 \begin_layout Plain Layout
35528 relative to the \SpecialChar LyX
35532 \begin_layout Description
35533 \begin_inset Flex Code
35536 \begin_layout Plain Layout
35542 This macro will expand to the absolute path of the system directory.
35543 This is typically used to point to the various helper scripts that are bundled with \SpecialChar LyX
35547 \begin_layout Description
35548 \begin_inset Flex Code
35551 \begin_layout Plain Layout
35557 A name and full path to a temporary file which will be automatically deleted whenever the containing document is closed,
35558 or the external material insertion deleted.
35561 \begin_layout Standard
35562 All path macros contain a trailing directory separator,
35563 so you can construct e.
35564 \begin_inset space \thinspace{}
35568 \begin_inset space \space{}
35571 the absolute filename with
35572 \begin_inset Flex Code
35575 \begin_layout Plain Layout
35576 $$AbsPath$$Basename$$Extension
35584 \begin_layout Standard
35585 The macros above are substituted in all commands unless otherwise noted.
35587 \begin_inset Flex Code
35590 \begin_layout Plain Layout
35596 supports additionally the following substitutions if they are enabled by the
35597 \begin_inset Flex Code
35600 \begin_layout Plain Layout
35607 \begin_inset Flex Code
35610 \begin_layout Plain Layout
35619 \begin_layout Description
35620 \begin_inset Flex Code
35623 \begin_layout Plain Layout
35629 The front part of the resize command.
35632 \begin_layout Description
35633 \begin_inset Flex Code
35636 \begin_layout Plain Layout
35642 The back part of the resize command.
35645 \begin_layout Description
35646 \begin_inset Flex Code
35649 \begin_layout Plain Layout
35655 The front part of the rotation command.
35658 \begin_layout Description
35659 \begin_inset Flex Code
35662 \begin_layout Plain Layout
35668 The back part of the rotation command.
35671 \begin_layout Standard
35672 The value string of the
35673 \begin_inset Flex Code
35676 \begin_layout Plain Layout
35682 command supports additionally the following substitutions if they are enabled by the
35683 \begin_inset Flex Code
35686 \begin_layout Plain Layout
35693 \begin_inset Flex Code
35696 \begin_layout Plain Layout
35705 \begin_layout Description
35706 \begin_inset Flex Code
35709 \begin_layout Plain Layout
35718 \begin_layout Description
35719 \begin_inset Flex Code
35722 \begin_layout Plain Layout
35731 \begin_layout Description
35732 \begin_inset Flex Code
35735 \begin_layout Plain Layout
35744 \begin_layout Description
35745 \begin_inset Flex Code
35748 \begin_layout Plain Layout
35754 The rotation option.
35757 \begin_layout Standard
35758 You may ask why there are so many path macros.
35759 There are mainly two reasons:
35762 \begin_layout Enumerate
35763 Relative and absolute file names should remain relative or absolute,
35765 Users may have reasons to prefer either form.
35766 Relative names are useful for portable documents that should work on different machines,
35768 Absolute names may be required by some programs.
35771 \begin_layout Enumerate
35773 treats relative file names differently than \SpecialChar LyX
35774 and other programs in nested included files.
35775 For \SpecialChar LyX
35777 a relative file name is always relative to the document that contains the file name.
35778 For \SpecialChar LaTeX
35780 it is always relative to the master document.
35781 These two definitions are identical if you have only one document,
35782 but differ if you have a master document that includes part documents.
35783 That means that relative filenames must be transformed when presented to \SpecialChar LaTeX
35785 Fortunately \SpecialChar LyX
35786 does this automatically for you if you choose the right macros.
35789 \begin_layout Standard
35790 So which path macro should be used in new template definitions?
35791 The rule is not difficult:
35794 \begin_layout Itemize
35796 \begin_inset Flex Code
35799 \begin_layout Plain Layout
35805 if an absolute path is required.
35808 \begin_layout Itemize
35810 \begin_inset Flex Code
35813 \begin_layout Plain Layout
35814 $$AbsOrRelPathMaster
35819 if the substituted string is some kind of \SpecialChar LaTeX
35823 \begin_layout Itemize
35825 \begin_inset Flex Code
35828 \begin_layout Plain Layout
35829 $$AbsOrRelPathParent
35834 in order to preserve the user's choice.
35837 \begin_layout Standard
35838 There are special cases where this rule does not work and e.
35839 \begin_inset space \thinspace{}
35843 \begin_inset space \space{}
35846 relative names are needed,
35847 but normally it will work just fine.
35848 One example for such a case is the command
35849 \begin_inset Flex Code
35852 \begin_layout Plain Layout
35853 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
35858 in the XFig template above:
35859 We can't use the absolute name because the copier for
35860 \begin_inset Flex Code
35863 \begin_layout Plain Layout
35869 files needs the relative name in order to rewrite the file content.
35872 \begin_layout Section
35873 Security discussion
35874 \begin_inset CommandInset label
35876 name "sec:Security-discussion"
35883 \begin_layout Standard
35884 The external material feature interfaces with a lot of external programs and does so automatically,
35885 so we have to consider the security implications of this.
35887 since you have the option of including your own filenames and/or parameter strings and those are expanded into a command,
35888 it seems that it would be possible to create a malicious document which executes arbitrary commands when a user views or prints the document.
35889 This is something we definitely want to avoid.
35892 \begin_layout Standard
35894 since the external program commands are specified in the template configuration file only,
35895 there are no security issues if \SpecialChar LyX
35896 is properly configured with safe templates only.
35897 This is so because the external programs are invoked with the
35898 \begin_inset Flex Code
35901 \begin_layout Plain Layout
35907 -system call rather than the
35908 \begin_inset Flex Code
35911 \begin_layout Plain Layout
35918 so it's not possible to execute arbitrary commands from the filename or parameter section via the shell.
35921 \begin_layout Standard
35922 This also implies that you are restricted in what command strings you can use in the external material templates.
35924 pipes and redirection are not readily available.
35925 This has to be so if \SpecialChar LyX
35926 should remain safe.
35927 If you want to use some of the shell features,
35928 you should write a safe script to do this in a controlled manner,
35929 and then invoke the script from the command string.
35933 \begin_layout Standard
35934 It is possible to design a template that interacts directly with the shell,
35935 but since this would allow a malicious user to execute arbitrary commands by writing clever filenames and/or parameters,
35936 we generally recommend that you only use safe scripts that work with the
35937 \begin_inset Flex Code
35940 \begin_layout Plain Layout
35946 system call in a controlled manner.
35948 for use in a controlled environment,
35949 it can be tempting to just fall back to use ordinary shell scripts.
35955 provide an easily exploitable security hole in your system.
35956 Of course it stands to reason that such unsafe templates will never be included in the standard \SpecialChar LyX
35958 although we do encourage people to submit new templates in the open source tradition.
35959 But \SpecialChar LyX
35960 as shipped from the official distribution channels will never have unsafe templates.
35963 \begin_layout Standard
35964 Including external material provides a lot of power,
35965 and you have to be careful not to introduce security hazards with this power.
35966 A subtle error in a single line in an innocent looking script can open the door to huge security problems.
35967 So if you do not fully understand the issues,
35968 we recommend that you consult a knowledgeable security professional or the \SpecialChar LyX
35969 development team if you have any questions about whether a given template is safe or not.
35970 And do this before you use it in an uncontrolled environment.
35973 \begin_layout Chapter
35975 List of supported \SpecialChar LyX
35976 functions to be used in layouts
35977 \begin_inset CommandInset label
35979 name "chap:List-of-functions"
35986 \begin_layout Standard
35988 \begin_inset Tabular
35989 <lyxtabular version="3" rows="11" columns="8">
35990 <features tabularvalignment="middle">
35991 <column alignment="left" valignment="top">
35992 <column alignment="left" valignment="top">
35993 <column alignment="left" valignment="top">
35994 <column alignment="left" valignment="top">
35995 <column alignment="left" valignment="top">
35996 <column alignment="left" valignment="top">
35997 <column alignment="left" valignment="top">
35998 <column alignment="left" valignment="top">
36000 <cell alignment="left" valignment="top" usebox="none">
36003 \begin_layout Plain Layout
36009 <cell alignment="left" valignment="top" usebox="none">
36012 \begin_layout Plain Layout
36018 <cell alignment="left" valignment="top" usebox="none">
36021 \begin_layout Plain Layout
36027 <cell alignment="left" valignment="top" usebox="none">
36030 \begin_layout Plain Layout
36036 <cell alignment="center" valignment="top" usebox="none">
36039 \begin_layout Plain Layout
36045 <cell alignment="center" valignment="top" usebox="none">
36048 \begin_layout Plain Layout
36050 \change_deleted 193502281 1695765491
36052 \change_inserted 193502281 1695765500
36060 <cell alignment="center" valignment="top" usebox="none">
36063 \begin_layout Plain Layout
36069 <cell alignment="center" valignment="top" usebox="none">
36072 \begin_layout Plain Layout
36080 <cell alignment="left" valignment="top" usebox="none">
36083 \begin_layout Plain Layout
36089 <cell alignment="left" valignment="top" usebox="none">
36092 \begin_layout Plain Layout
36098 <cell alignment="left" valignment="top" usebox="none">
36101 \begin_layout Plain Layout
36107 <cell alignment="left" valignment="top" usebox="none">
36110 \begin_layout Plain Layout
36116 <cell alignment="center" valignment="top" usebox="none">
36119 \begin_layout Plain Layout
36125 <cell alignment="center" valignment="top" usebox="none">
36128 \begin_layout Plain Layout
36130 \change_deleted 193502281 1695765498
36132 \change_inserted 193502281 1695765504
36140 <cell alignment="center" valignment="top" usebox="none">
36143 \begin_layout Plain Layout
36149 <cell alignment="center" valignment="top" usebox="none">
36152 \begin_layout Plain Layout
36160 <cell alignment="left" valignment="top" usebox="none">
36163 \begin_layout Plain Layout
36169 <cell alignment="left" valignment="top" usebox="none">
36172 \begin_layout Plain Layout
36178 <cell alignment="left" valignment="top" usebox="none">
36181 \begin_layout Plain Layout
36187 <cell alignment="left" valignment="top" usebox="none">
36190 \begin_layout Plain Layout
36196 <cell alignment="center" valignment="top" usebox="none">
36199 \begin_layout Plain Layout
36201 \change_deleted 193502281 1695765346
36203 \change_inserted 193502281 1695765405
36211 <cell alignment="center" valignment="top" usebox="none">
36214 \begin_layout Plain Layout
36216 \change_deleted 193502281 1695765503
36218 \change_inserted 193502281 1695765508
36226 <cell alignment="center" valignment="top" usebox="none">
36229 \begin_layout Plain Layout
36235 <cell alignment="center" valignment="top" usebox="none">
36238 \begin_layout Plain Layout
36246 <cell alignment="left" valignment="top" usebox="none">
36249 \begin_layout Plain Layout
36255 <cell alignment="left" valignment="top" usebox="none">
36258 \begin_layout Plain Layout
36264 <cell alignment="left" valignment="top" usebox="none">
36267 \begin_layout Plain Layout
36273 <cell alignment="left" valignment="top" usebox="none">
36276 \begin_layout Plain Layout
36282 <cell alignment="center" valignment="top" usebox="none">
36285 \begin_layout Plain Layout
36287 \change_deleted 193502281 1695765403
36289 \change_inserted 193502281 1695765410
36297 <cell alignment="center" valignment="top" usebox="none">
36300 \begin_layout Plain Layout
36302 \change_deleted 193502281 1695765507
36304 \change_inserted 193502281 1695765512
36312 <cell alignment="center" valignment="top" usebox="none">
36315 \begin_layout Plain Layout
36321 <cell alignment="center" valignment="top" usebox="none">
36324 \begin_layout Plain Layout
36332 <cell alignment="left" valignment="top" usebox="none">
36335 \begin_layout Plain Layout
36341 <cell alignment="left" valignment="top" usebox="none">
36344 \begin_layout Plain Layout
36350 <cell alignment="left" valignment="top" usebox="none">
36353 \begin_layout Plain Layout
36359 <cell alignment="left" valignment="top" usebox="none">
36362 \begin_layout Plain Layout
36368 <cell alignment="center" valignment="top" usebox="none">
36371 \begin_layout Plain Layout
36373 \change_deleted 193502281 1695765408
36375 \change_inserted 193502281 1695765466
36383 <cell alignment="center" valignment="top" usebox="none">
36386 \begin_layout Plain Layout
36388 \change_deleted 193502281 1695765511
36390 \change_inserted 193502281 1695765515
36398 <cell alignment="center" valignment="top" usebox="none">
36401 \begin_layout Plain Layout
36407 <cell alignment="center" valignment="top" usebox="none">
36410 \begin_layout Plain Layout
36418 <cell alignment="left" valignment="top" usebox="none">
36421 \begin_layout Plain Layout
36427 <cell alignment="left" valignment="top" usebox="none">
36430 \begin_layout Plain Layout
36436 <cell alignment="left" valignment="top" usebox="none">
36439 \begin_layout Plain Layout
36445 <cell alignment="left" valignment="top" usebox="none">
36448 \begin_layout Plain Layout
36454 <cell alignment="center" valignment="top" usebox="none">
36457 \begin_layout Plain Layout
36459 \change_deleted 193502281 1695765464
36461 \change_inserted 193502281 1695765470
36469 <cell alignment="center" valignment="top" usebox="none">
36472 \begin_layout Plain Layout
36474 \change_deleted 193502281 1695765514
36476 \change_inserted 193502281 1695765520
36484 <cell alignment="center" valignment="top" usebox="none">
36487 \begin_layout Plain Layout
36493 <cell alignment="center" valignment="top" usebox="none">
36496 \begin_layout Plain Layout
36504 <cell alignment="left" valignment="top" usebox="none">
36507 \begin_layout Plain Layout
36513 <cell alignment="left" valignment="top" usebox="none">
36516 \begin_layout Plain Layout
36522 <cell alignment="left" valignment="top" usebox="none">
36525 \begin_layout Plain Layout
36531 <cell alignment="left" valignment="top" usebox="none">
36534 \begin_layout Plain Layout
36540 <cell alignment="center" valignment="top" usebox="none">
36543 \begin_layout Plain Layout
36545 \change_deleted 193502281 1695765469
36547 \change_inserted 193502281 1695765474
36555 <cell alignment="center" valignment="top" usebox="none">
36558 \begin_layout Plain Layout
36560 \change_deleted 193502281 1695765519
36562 \change_inserted 193502281 1695765524
36570 <cell alignment="center" valignment="top" usebox="none">
36573 \begin_layout Plain Layout
36579 <cell alignment="center" valignment="top" usebox="none">
36582 \begin_layout Plain Layout
36590 <cell alignment="left" valignment="top" usebox="none">
36593 \begin_layout Plain Layout
36599 <cell alignment="left" valignment="top" usebox="none">
36602 \begin_layout Plain Layout
36608 <cell alignment="left" valignment="top" usebox="none">
36611 \begin_layout Plain Layout
36617 <cell alignment="left" valignment="top" usebox="none">
36620 \begin_layout Plain Layout
36626 <cell alignment="center" valignment="top" usebox="none">
36629 \begin_layout Plain Layout
36631 \change_deleted 193502281 1695765473
36633 \change_inserted 193502281 1695765477
36641 <cell alignment="center" valignment="top" usebox="none">
36644 \begin_layout Plain Layout
36646 \change_deleted 193502281 1695765523
36648 \change_inserted 193502281 1695765528
36656 <cell alignment="center" valignment="top" usebox="none">
36659 \begin_layout Plain Layout
36665 <cell alignment="center" valignment="top" usebox="none">
36668 \begin_layout Plain Layout
36676 <cell alignment="left" valignment="top" usebox="none">
36679 \begin_layout Plain Layout
36685 <cell alignment="left" valignment="top" usebox="none">
36688 \begin_layout Plain Layout
36694 <cell alignment="left" valignment="top" usebox="none">
36697 \begin_layout Plain Layout
36703 <cell alignment="left" valignment="top" usebox="none">
36706 \begin_layout Plain Layout
36712 <cell alignment="center" valignment="top" usebox="none">
36715 \begin_layout Plain Layout
36717 \change_deleted 193502281 1695765476
36719 \change_inserted 193502281 1695765482
36727 <cell alignment="center" valignment="top" usebox="none">
36730 \begin_layout Plain Layout
36732 \change_deleted 193502281 1695765527
36734 \change_inserted 193502281 1695765557
36742 <cell alignment="center" valignment="top" usebox="none">
36745 \begin_layout Plain Layout
36751 <cell alignment="center" valignment="top" usebox="none">
36754 \begin_layout Plain Layout
36762 <cell alignment="left" valignment="top" usebox="none">
36765 \begin_layout Plain Layout
36771 <cell alignment="left" valignment="top" usebox="none">
36774 \begin_layout Plain Layout
36780 <cell alignment="left" valignment="top" usebox="none">
36783 \begin_layout Plain Layout
36789 <cell alignment="left" valignment="top" usebox="none">
36792 \begin_layout Plain Layout
36798 <cell alignment="center" valignment="top" usebox="none">
36801 \begin_layout Plain Layout
36803 \change_deleted 193502281 1695765481
36805 \change_inserted 193502281 1695765485
36813 <cell alignment="center" valignment="top" usebox="none">
36816 \begin_layout Plain Layout
36822 <cell alignment="center" valignment="top" usebox="none">
36825 \begin_layout Plain Layout
36831 <cell alignment="center" valignment="top" usebox="none">
36834 \begin_layout Plain Layout
36842 <cell alignment="center" valignment="top" usebox="none">
36845 \begin_layout Plain Layout
36851 <cell alignment="center" valignment="top" usebox="none">
36854 \begin_layout Plain Layout
36860 <cell alignment="center" valignment="top" usebox="none">
36863 \begin_layout Plain Layout
36869 <cell alignment="center" valignment="top" usebox="none">
36872 \begin_layout Plain Layout
36878 <cell alignment="center" valignment="top" usebox="none">
36881 \begin_layout Plain Layout
36883 \change_deleted 193502281 1695765484
36885 \change_inserted 193502281 1695765493
36893 <cell alignment="center" valignment="top" usebox="none">
36896 \begin_layout Plain Layout
36902 <cell alignment="center" valignment="top" usebox="none">
36905 \begin_layout Plain Layout
36911 <cell alignment="center" valignment="top" usebox="none">
36914 \begin_layout Plain Layout
36928 \begin_layout Chapter
36929 Names of available colors to be used in layouts
36930 \begin_inset CommandInset label
36932 name "chap:Names-of-colors"
36939 \begin_layout Standard
36940 The colors listed below are the standard colors and those that you can adjust in the \SpecialChar LyX
36944 \begin_layout Section
36948 \begin_layout Standard
36949 The following are no real colors,
36950 but rather act on color definitions:
36953 \begin_layout Description
36954 ignore The color is ignored
36957 \begin_layout Description
36958 inherit The color is inherited
36961 \begin_layout Description
36974 No particular color – clear or default
36977 \begin_layout Section
36981 \begin_layout Standard
36982 These are fixed colors that cannot be customized
36983 \change_inserted -712698321 1607683177
36989 use these colors in layout definitions,
36990 since they will not work well with some color themes (such as dark themes)
36995 \begin_layout Description
36999 \begin_layout Description
37003 \begin_layout Description
37007 \begin_layout Description
37011 \begin_layout Description
37015 \begin_layout Description
37019 \begin_layout Description
37023 \begin_layout Description
37027 \begin_layout Description
37031 \begin_layout Description
37035 \begin_layout Description
37039 \begin_layout Description
37043 \begin_layout Description
37047 \begin_layout Description
37051 \begin_layout Description
37055 \begin_layout Description
37059 \begin_layout Description
37063 \begin_layout Description
37067 \begin_layout Description
37071 \begin_layout Section
37075 \begin_layout Standard
37076 These are the colors allocated to specific elements in
37079 arg "dialog-show prefs"
37085 \begin_layout Description
37086 added_space Added space color
37089 \begin_layout Description
37090 addedtext Added text color
37093 \begin_layout Description
37094 appendix Appendix marker color
37097 \begin_layout Description
37098 background Background color
37099 \change_inserted 5863208 1681507589
37103 \begin_layout Description
37105 \change_inserted 5863208 1681507597
37106 bookmark Bookmark indicator color
37111 \begin_layout Description
37112 bottomarea Bottom area color
37115 \begin_layout Description
37116 branchlabel Label color for branches
37119 \begin_layout Description
37120 buttonbg Color used for button background
37123 \begin_layout Description
37124 buttonframe Color for inset button frames
37127 \begin_layout Description
37128 buttonhoverbg Color used for button background under focus
37129 \change_inserted -712698321 1681555554
37133 \begin_layout Description
37135 \change_inserted -712698321 1681555554
37136 buttonhoverbg_broken Color used for broken inset button under focus
37141 \begin_layout Description
37142 changebar Changebar color
37145 \begin_layout Description
37146 changedtextauthor1 Changed text color author 1
37149 \begin_layout Description
37150 changedtextauthor2 Changed text color author 2
37153 \begin_layout Description
37154 changedtextauthor3 Changed text color author 3
37157 \begin_layout Description
37158 changedtextauthor4 Changed text color author 4
37161 \begin_layout Description
37162 changedtextauthor5 Changed text color author 5
37163 \change_inserted 5863208 1681507402
37167 \begin_layout Description
37169 \change_inserted 5863208 1681507414
37170 changedtextcomparison Changed text color document comparison (workarea)
37175 \begin_layout Description
37176 collapsible Collapsible insets text color
37179 \begin_layout Description
37180 collapsibleframe Collapsible insets framecolor
37183 \begin_layout Description
37184 command Text color for command insets
37187 \begin_layout Description
37188 commandbg Background color for command insets
37191 \begin_layout Description
37192 commandframe Frame color for command insets
37193 \change_inserted 5863208 1681507735
37197 \begin_layout Description
37199 \change_inserted 5863208 1681507880
37200 command_broken Text color for broken
37201 \change_inserted -712698321 1681555620
37203 \change_inserted 5863208 1681507880
37205 \change_deleted -712698321 1681555620
37207 \change_inserted 5863208 1681507880
37211 \begin_layout Description
37213 \change_inserted 5863208 1681507827
37214 commandbg_broken Background color for broken insets
37217 \begin_layout Description
37219 \change_inserted 5863208 1681507835
37220 commandframe_broken Frame color for broken insets
37223 \begin_layout Description
37225 \change_deleted -712698321 1681555548
37226 buttonhoverbg_broken Color used for broken inset button under focus
37231 \begin_layout Description
37232 comment Label color for comments
37235 \begin_layout Description
37236 commentbg Background color of comments
37239 \begin_layout Description
37240 cursor Cursor color
37243 \begin_layout Description
37244 deletedtext Deleted text color
37247 \begin_layout Description
37248 deletedtextmodifier Deleted text modifying color
37249 \change_inserted 5863208 1681507525
37251 \change_deleted -712698321 1681555611
37253 \change_inserted -712698321 1681555611
37255 \change_inserted 5863208 1681507525
37261 \begin_layout Description
37262 depthbar Color for the depth bars in the margin
37265 \begin_layout Description
37266 eolmarker End of line marker color
37269 \begin_layout Description
37270 error Color of the \SpecialChar LaTeX
37274 \begin_layout Description
37275 footlabel Label color for footnotes
37278 \begin_layout Description
37279 foreground Foreground color
37282 \begin_layout Description
37283 graphicsbg Graphics inset background color
37286 \begin_layout Description
37287 greyedoutbg Background color of greyedout inset
37290 \begin_layout Description
37291 greyedoutlabel Label color for greyedout insets
37294 \begin_layout Description
37295 greyedouttext Color for greyedout inset text
37298 \begin_layout Description
37299 indexlabel Label color for index insets
37302 \begin_layout Description
37303 inlinecompletion Inline completion color
37306 \begin_layout Description
37307 insetbg Inset marker background color
37310 \begin_layout Description
37311 insetframe Inset marker frame color
37314 \begin_layout Description
37315 language Color for marking foreign language words
37318 \begin_layout Description
37319 latex Text color in \SpecialChar LaTeX
37323 \begin_layout Description
37324 listingsbg Background color of listings inset
37327 \begin_layout Description
37328 marginlabel Label color for margin notes
37331 \begin_layout Description
37332 math Math inset text color
37335 \begin_layout Description
37336 mathbg Math inset background color
37339 \begin_layout Description
37340 mathcorners Math inset frame color not under focus
37343 \begin_layout Description
37344 mathframe Math inset frame color under focus
37347 \begin_layout Description
37348 mathline Math line color
37351 \begin_layout Description
37352 mathmacrobg Macro math inset background color
37355 \begin_layout Description
37356 mathmacroblend Macro math blended color
37359 \begin_layout Description
37360 mathmacroframe Macro math frame color
37363 \begin_layout Description
37364 mathmacrohoverbg Macro math inset background color hovered
37367 \begin_layout Description
37368 mathmacrolabel Macro math label color
37371 \begin_layout Description
37372 mathmacronewarg Macro template color for new parameters
37375 \begin_layout Description
37376 mathmacrooldarg Macro template color for old parameters
37379 \begin_layout Description
37380 newpage New page color
37383 \begin_layout Description
37384 nonunique_inlinecompletion Inline completion color for the non-unique part
37387 \begin_layout Description
37388 note Label color for notes
37391 \begin_layout Description
37392 notebg Background color of notes
37395 \begin_layout Description
37396 pagebreak Page break/line break color
37399 \begin_layout Description
37400 paragraphmarker Color used for the pilcrow sign to mark the end of a paragraph
37403 \begin_layout Description
37404 phantomtext Text color for phantom insets
37407 \begin_layout Description
37408 preview The color used for previews
37411 \begin_layout Description
37412 previewframe Preview frame color
37415 \begin_layout Description
37416 regexpframe Color for regexp frame
37419 \begin_layout Description
37420 scroll Color that indicates when a row can be scrolled
37423 \begin_layout Description
37424 selection Background color of selected text
37425 \change_inserted -712698321 1696418767
37429 \begin_layout Description
37431 \change_inserted -712698321 1696418836
37432 selectionmath Foreground color of selected text in math insets
37437 \begin_layout Description
37438 selectiontext Foreground color of selected text
37441 \begin_layout Description
37442 shadedbg Background color of shaded box
37445 \begin_layout Description
37446 special Special chars text color
37449 \begin_layout Description
37450 tabularline Table line color
37453 \begin_layout Description
37454 tabularonoffline Table line color
37455 \change_inserted -712698321 1607682522
37459 \begin_layout Description
37461 \change_inserted -712698321 1607682563
37462 textlabel1 Color 1 of layout and custom inset labels
37465 \begin_layout Description
37467 \change_inserted -712698321 1607682565
37468 textlabel2 Color 2 of layout and custom inset labels
37471 \begin_layout Description
37473 \change_inserted -712698321 1607682568
37474 textlabel3 Color 3 of layout and custom inset labels
37479 \begin_layout Description
37480 urllabel Label color for URL insets
37483 \begin_layout Description
37484 urltext Color for URL inset text