1 #LyX 2.4 created this file. For more info see https://www.lyx.org/
5 \save_transient_properties true
6 \origin /systemlyxdir/doc/
9 % DO NOT ALTER THIS PREAMBLE!!!
11 % This preamble is designed to ensure that this document prints
12 % out as advertised. If you mess with this preamble,
13 % parts of this document may not print out as expected. If you
14 % have problems LaTeXing this file, please contact
15 % the documentation team
16 % email: lyx-docs@lists.lyx.org
18 % the pages of the TOC is numbered roman
19 % and a pdf-bookmark for the TOC is added
20 \let\myTOC\tableofcontents
21 \renewcommand\tableofcontents{%
23 \pdfbookmark[1]{\contentsname}{}
27 % increase link area for cross-references and autoname them,
28 \AtBeginDocument{\renewcommand{\ref}[1]{\mbox{\autoref{#1}}}}
29 \@ifundefined{extrasenglish}{\usepackage[english]{babel}}{}
30 \@ifpackageloaded{babel}{
31 \addto\extrasenglish{%
32 \renewcommand*{\equationautorefname}[1]{}%
33 \renewcommand{\sectionautorefname}{sec.\negthinspace}%
34 \renewcommand{\subsectionautorefname}{sec.\negthinspace}%
35 \renewcommand{\subsubsectionautorefname}{sec.\negthinspace}%
39 \options bibliography=totoc,index=totoc,BCOR7.5mm,titlepage,captions=tableheading
40 \use_default_options false
44 \maintain_unincluded_children no
46 \language_package default
49 \font_roman "lmodern" "default"
50 \font_sans "lmss" "default"
51 \font_typewriter "lmtt" "default"
52 \font_math "auto" "auto"
53 \font_default_family default
54 \use_non_tex_fonts false
58 \font_typewriter_osf false
59 \font_sf_scale 100 100
60 \font_tt_scale 100 100
62 \use_dash_ligatures true
64 \default_output_format pdf2
66 \bibtex_command default
67 \index_command default
71 \pdf_title "LyX Configuration Manual"
72 \pdf_author "LyX Team"
73 \pdf_subject "LyX-documentation Customization"
74 \pdf_keywords "LyX, documentation, customization"
76 \pdf_bookmarksnumbered true
77 \pdf_bookmarksopen true
78 \pdf_bookmarksopenlevel 1
83 \pdf_pdfusetitle false
84 \pdf_quoted_options "linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue,pdfpagelayout=OneColumn, pdfnewwindow=true, pdfstartview=XYZ, plainpages=false"
87 \use_package amsmath 1
88 \use_package amssymb 1
91 \use_package mathdots 1
92 \use_package mathtools 1
94 \use_package stackrel 1
95 \use_package stmaryrd 1
96 \use_package undertilde 1
98 \cite_engine_type default
102 \paperorientation portrait
108 \notefontcolor #0000ff
112 \color #f5fae7 #0a0518
120 \paragraph_separation indent
121 \paragraph_indentation default
123 \math_indentation default
124 \math_numbering_side default
125 \quotes_style english
129 \paperpagestyle headings
131 \tracking_changes true
132 \output_changes false
134 \postpone_fragile_content false
138 \docbook_table_output 0
139 \docbook_mathml_prefix 1
140 \author -970929547 "Thibaut Cuvelier"
141 \author -712698321 "Jürgen Spitzmüller"
142 \author -584632292 "Richard Kimberly Heck"
143 \author -495245474 "Jean-Marc Lasgouttes"
146 \author 34634807 "Jean-Pierre"
147 \author 232239728 "Owner"
148 \author 731793113 "Richard Kimberly Heck" rikiheck@lyx.org
149 \author 1075283030 "Thibaut"
155 Customizing \SpecialChar LyX
157 Features for the Advanced User
161 by the \SpecialChar LyX
166 \begin_layout Plain Layout
167 If you have comments or error corrections,
168 please send them to the \SpecialChar LyX
169 Documentation mailing list,
171 \begin_inset CommandInset href
173 target "lyx-docs@lists.lyx.org"
181 \begin_inset Quotes eld
185 \begin_inset Quotes erd
188 in the subject header,
189 and please cc the current maintainer of this file,
191 \change_inserted 5863208 1604930692
195 \change_inserted 5863208 1604930729
197 \change_deleted 5863208 1604930668
206 \begin_inset Newline newline
210 \begin_inset Newline newline
216 \begin_layout Standard
217 \begin_inset CommandInset toc
218 LatexCommand tableofcontents
225 \begin_layout Standard
226 \begin_inset Note Note
229 \begin_layout Plain Layout
230 Please use change tracking when modifying this document.
231 This makes it easier for our translators to recognize things that have been changed,
232 and it helps the maintainer keep up-to-date with what's been done.
240 \begin_layout Chapter
244 \begin_layout Standard
245 This manual covers the customization features present in \SpecialChar LyX
248 we discuss issues like keyboard shortcuts,
249 screen previewing options,
251 sending commands to \SpecialChar LyX
252 via the \SpecialChar LyX
254 internationalization,
255 installing new \SpecialChar LaTeX
256 classes and \SpecialChar LyX
259 We can't possibly hope to touch on everything you can change—
260 our developers add new features faster than we can document them—
261 but we will explain the most common customizations and hopefully point you in the right direction for some of the more obscure ones.
264 \begin_layout Standard
265 \begin_inset Branch OutDated
269 \begin_layout Standard
270 Information from previous versions of this document that now seems to be outdated is contained in the OutDated branch of this document.
272 this information will not appear in the \SpecialChar LaTeX
281 \begin_layout Chapter
286 \begin_layout Standard
287 This chapter aims to help you to find your way through the \SpecialChar LyX
289 Before continuing to read this chapter,
290 you should find out where your \SpecialChar LyX
291 library and user directories are by using
292 \begin_inset Flex Noun
295 \begin_layout Plain Layout
296 Help\SpecialChar menuseparator
307 The library directory is the place where \SpecialChar LyX
308 places its system-wide configuration files;
309 the user directory is where you can place your modified versions.
310 We will call the former
311 \begin_inset Flex Code
314 \begin_layout Plain Layout
321 \begin_inset Flex Noun
324 \begin_layout Plain Layout
330 in the remainder of this document.
334 \begin_layout Section
336 \begin_inset Flex Code
339 \begin_layout Plain Layout
348 \begin_layout Standard
349 \begin_inset Flex Code
352 \begin_layout Plain Layout
358 and its sub-directories contain a number of files
359 \change_deleted 232239728 1604787780
362 that can be used to customize \SpecialChar LyX
364 You can change many of these files from within \SpecialChar LyX
366 \begin_inset Flex Noun
369 \begin_layout Plain Layout
370 Tools\SpecialChar menuseparator
377 Most customization that you will want to do in \SpecialChar LyX
378 is possible through this dialog.
380 many other inner aspects of \SpecialChar LyX
381 can be customized by modifying the files in
382 \begin_inset Flex Code
385 \begin_layout Plain Layout
392 These files fall in different categories,
393 described in the following subsections.
396 \begin_layout Subsection
397 Automatically generated files
400 \begin_layout Standard
402 \begin_inset Flex Noun
405 \begin_layout Plain Layout
411 are generated when you configure \SpecialChar LyX
413 They contain various default values that are
414 \change_inserted 5863208 1604919565
415 automatically detected during reconfiguration.
416 \change_deleted 232239728 1604788241
417 guessed by inspection
420 it is not a good idea to modify them,
421 since they might be overwritten at any time.
424 \begin_layout Labeling
425 \labelwidthstring 00.00.0000
426 \begin_inset Flex Code
429 \begin_layout Plain Layout
436 \change_deleted 5863208 1604919950
438 \begin_inset Note Note
441 \begin_layout Plain Layout
443 \change_inserted 232239728 1604853928
444 I capitalized the first word in all of these lists.
445 To me it looks better but it really is a stylistic thing,
447 However if you are not going to capitalize them,
448 the english in some needs to be modified to make it read correctly as a sentence.
456 \change_deleted 232239728 1604853510
458 \change_inserted 232239728 1604853510
461 ontains defaults for various commands.
464 \begin_layout Labeling
465 \labelwidthstring 00.00.0000
466 \begin_inset Flex Code
469 \begin_layout Plain Layout
476 \change_deleted 232239728 1604853512
478 \change_inserted 232239728 1604853512
481 ontains the list of packages that have been recognized by \SpecialChar LyX
483 It is currently unused by the \SpecialChar LyX
485 but the information extracted,
487 is made available with
488 \begin_inset Flex Noun
491 \begin_layout Plain Layout
492 Help\SpecialChar menuseparator
506 \begin_layout Labeling
507 \labelwidthstring 00.00.0000
508 \begin_inset Flex Code
511 \begin_layout Plain Layout
518 \change_deleted 232239728 1604853515
520 \change_inserted 232239728 1604853515
523 he list of text classes that have been found in your
524 \begin_inset Flex Code
527 \begin_layout Plain Layout
534 along with the associated \SpecialChar LaTeX
535 document class and their description.
538 \begin_layout Labeling
539 \labelwidthstring 00.00.0000
540 \begin_inset Flex Code
543 \begin_layout Plain Layout
550 \change_deleted 232239728 1604853518
552 \change_inserted 232239728 1604853518
555 he list of layout modules found in your
556 \begin_inset Flex Code
559 \begin_layout Plain Layout
568 \begin_layout Labeling
569 \labelwidthstring 00.00.0000
570 \begin_inset Flex Code
573 \begin_layout Plain Layout
580 \change_deleted 232239728 1604853523
582 \change_inserted 232239728 1604853523
585 ists of various sorts of \SpecialChar LaTeX
586 -related files found on your system
589 \begin_layout Labeling
590 \labelwidthstring 00.00.0000
591 \begin_inset Flex Code
594 \begin_layout Plain Layout
595 doc/\SpecialChar LaTeX
601 is automatically generated during configuration from the file
602 \begin_inset Flex Code
605 \begin_layout Plain Layout
613 It contains information on your \SpecialChar LaTeX
617 \begin_layout Subsection
621 \begin_layout Standard
623 \change_deleted 5863208 1604928729
627 \change_inserted 5863208 1604928636
631 \change_inserted 5863208 1604928661
635 \begin_inset Flex Code
638 \begin_layout Plain Layout
645 \change_inserted 5863208 1604928662
647 \change_deleted 5863208 1604928642
651 \change_deleted 5863208 1604928669
653 \begin_inset Flex Code
656 \begin_layout Plain Layout
663 \change_inserted 5863208 1604928680
667 \begin_inset Flex Code
670 \begin_layout Plain Layout
678 \change_deleted 232239728 1604794430
681 exists in both places,
683 \begin_inset Flex Code
686 \begin_layout Plain Layout
695 \begin_layout Labeling
696 \labelwidthstring 00.00.0000
697 \begin_inset Flex Code
700 \begin_layout Plain Layout
707 \change_deleted 232239728 1604794460
709 \change_inserted 232239728 1604794460
712 his directory contains files with the extension
713 \begin_inset Flex Code
716 \begin_layout Plain Layout
722 that define the keybindings used in \SpecialChar LyX
724 If there exists an internationalized version of the bind file
725 \change_inserted -712698321 1669371749
727 \change_deleted -712698321 1669371727
729 \begin_inset Flex Code
732 \begin_layout Plain Layout
739 \change_inserted -712698321 1669371728
741 \begin_inset Flex Code
744 \begin_layout Plain Layout
746 \change_inserted -712698321 1669371732
755 \begin_inset Quotes eld
759 \begin_inset Quotes erd
762 is the ISO language code
765 that will be used first.
768 \begin_layout Labeling
769 \labelwidthstring 00.00.0000
770 \begin_inset Flex Code
773 \begin_layout Plain Layout
780 \change_deleted 232239728 1604794478
782 \change_inserted 232239728 1604794478
785 ontains files with the extension
786 \begin_inset Flex Code
789 \begin_layout Plain Layout
795 which define the diverse citation possibilities (natbib,
798 \begin_inset CommandInset ref
800 reference "subsec:Cite-Engine-Files"
811 \begin_layout Labeling
812 \labelwidthstring 00.00.0000
813 \begin_inset Flex Code
816 \begin_layout Plain Layout
823 \change_deleted 232239728 1604794483
825 \change_inserted 232239728 1604794486
828 ontains graphics files that can be included in documents.
832 \begin_layout Labeling
833 \labelwidthstring 00.00.0000
834 \begin_inset Flex Code
837 \begin_layout Plain Layout
844 \change_deleted 232239728 1604794492
846 \change_inserted 232239728 1604794492
849 ontains \SpecialChar LyX
850 documentation files (including the one you are currently reading).
852 \begin_inset Flex Code
855 \begin_layout Plain Layout
857 \change_deleted 232239728 1604794660
860 \change_inserted 232239728 1604794661
868 deserves special attention,
870 The internationalized help docs are in subdirectories
871 \begin_inset Flex Code
874 \begin_layout Plain Layout
881 \begin_inset Quotes eld
885 \begin_inset Quotes erd
888 is the ISO language code.
890 \begin_inset CommandInset ref
892 reference "cha:Internationalizing-LyX"
900 \begin_layout Labeling
901 \labelwidthstring 00.00.0000
902 \begin_inset Flex Code
905 \begin_layout Plain Layout
912 \change_deleted 232239728 1604794497
914 \change_inserted 232239728 1604794497
917 ontains example files that explain how to use some features.
920 \begin_inset Flex Noun
923 \begin_layout Plain Layout
932 \begin_layout Labeling
933 \labelwidthstring 00.00.0000
934 \begin_inset Flex Code
937 \begin_layout Plain Layout
944 \change_deleted 232239728 1604794500
946 \change_inserted 232239728 1604794500
949 ontains image files that are used by the
950 \begin_inset Flex Noun
953 \begin_layout Plain Layout
961 it also contains the individual icons used in the toolbar and the banners that can be shown when \SpecialChar LyX
965 \begin_layout Labeling
966 \labelwidthstring 00.00.0000
967 \begin_inset Flex Code
970 \begin_layout Plain Layout
977 \change_deleted 232239728 1604794505
979 \change_inserted 232239728 1604794505
982 ontains keyboard keymapping files.
984 \begin_inset CommandInset ref
986 reference "sec:International-Keymap-Stuff"
994 \begin_layout Labeling
995 \labelwidthstring 00.00.0000
996 \begin_inset Flex Code
999 \begin_layout Plain Layout
1006 \change_deleted 232239728 1604794508
1008 \change_inserted 232239728 1604794508
1011 ontains the text class and module files described in
1012 \begin_inset CommandInset ref
1014 reference "cha:Installing-New-Document"
1022 \begin_layout Labeling
1023 \labelwidthstring 00.00.0000
1024 \begin_inset Flex Code
1027 \begin_layout Plain Layout
1034 \change_deleted 232239728 1604794513
1036 \change_inserted 232239728 1604794513
1040 \begin_inset Flex Code
1043 \begin_layout Plain Layout
1049 Python scripts used to convert between \SpecialChar LyX
1051 These can be run from the command line if
1052 \change_deleted 232239728 1604794749
1057 you want to batch-convert files.
1060 \begin_layout Labeling
1061 \labelwidthstring 00.00.0000
1062 \begin_inset Flex Code
1065 \begin_layout Plain Layout
1072 \change_deleted 232239728 1604794516
1074 \change_inserted 232239728 1604794516
1077 ontains some files that demonstrate the capabilities of the
1078 \begin_inset Flex Noun
1081 \begin_layout Plain Layout
1083 \begin_inset space ~
1092 Also contains some scripts used by \SpecialChar LyX
1096 \begin_layout Labeling
1097 \labelwidthstring 00.00.0000
1098 \begin_inset Flex Code
1101 \begin_layout Plain Layout
1108 \change_deleted 232239728 1604794520
1110 \change_inserted 232239728 1604794520
1113 ontains the standard \SpecialChar LyX
1114 template files described in
1115 \begin_inset CommandInset ref
1117 reference "subsec:Creating-Templates"
1125 \begin_layout Labeling
1126 \labelwidthstring 00.00.0000
1127 \begin_inset Flex Code
1130 \begin_layout Plain Layout
1137 \change_deleted 232239728 1604794524
1139 \change_inserted 232239728 1604794524
1142 ontains files with the extension
1143 \begin_inset Flex Code
1146 \begin_layout Plain Layout
1152 that define the user interface to \SpecialChar LyX
1155 the files define which items appear in which menus and the items appearing on the toolbar.
1158 \begin_layout Labeling
1159 \labelwidthstring 00.00.0000
1160 \begin_inset Flex Code
1163 \begin_layout Plain Layout
1170 \change_deleted 232239728 1604794528
1172 \change_inserted 232239728 1604794528
1175 ontains files with the extension
1176 \begin_inset Flex Code
1179 \begin_layout Plain Layout
1185 which define the templates for the insertion of external material to a \SpecialChar LyX
1188 \begin_inset CommandInset ref
1190 reference "chap:Including-External-Material"
1198 \begin_layout Subsection
1199 Files you don't want to modify
1202 \begin_layout Standard
1203 These files are used internally by \SpecialChar LyX
1204 and you generally do not need to modify them unless you are a developer.
1207 \begin_layout Labeling
1208 \labelwidthstring 00.00.0000
1209 \begin_inset Flex Code
1212 \begin_layout Plain Layout
1219 \change_deleted 232239728 1604797616
1221 \change_inserted 232239728 1604797616
1224 his file contains the list of \SpecialChar LyX
1226 The contents are displayed with the menu entry
1227 \begin_inset Flex Noun
1230 \begin_layout Plain Layout
1231 Help\SpecialChar menuseparator
1233 \begin_inset space ~
1244 \begin_layout Labeling
1245 \labelwidthstring 00.00.0000
1246 \begin_inset Flex Code
1249 \begin_layout Plain Layout
1256 \change_deleted 232239728 1604797620
1258 \change_inserted 232239728 1604797620
1261 his is a \SpecialChar LaTeX
1262 script used during the configuration process.
1263 Do not run directly.
1266 \begin_layout Labeling
1267 \labelwidthstring 00.00.0000
1268 \begin_inset Flex Code
1271 \begin_layout Plain Layout
1278 \change_deleted 232239728 1604797624
1280 \change_inserted 232239728 1604797624
1283 his is a Python script that is used to re-configure \SpecialChar LyX
1285 It creates configuration files in the directory it was run from.
1288 \begin_layout Subsection
1289 Other files needing a line or two
1292 \begin_layout Labeling
1293 \labelwidthstring 00.00.0000
1294 \begin_inset Flex Code
1297 \begin_layout Plain Layout
1304 \change_deleted 232239728 1604797580
1306 \change_inserted 232239728 1604797580
1309 his contains tables describing how different character encodings can be mapped to Unicode
1312 \begin_layout Labeling
1313 \labelwidthstring 00.00.0000
1314 \begin_inset Flex Code
1317 \begin_layout Plain Layout
1324 \change_deleted 232239728 1604797584
1326 \change_inserted 232239728 1604797584
1329 his file contains a list of all the languages currently supported by \SpecialChar LyX
1333 \begin_layout Labeling
1334 \labelwidthstring 00.00.0000
1335 \begin_inset Flex Code
1338 \begin_layout Plain Layout
1345 \change_deleted 232239728 1604797587
1347 \change_inserted 232239728 1604797587
1350 ontains information about the supported fonts.
1353 \begin_layout Labeling
1354 \labelwidthstring 00.00.0000
1355 \begin_inset Flex Code
1358 \begin_layout Plain Layout
1365 \change_deleted 232239728 1604797591
1367 \change_inserted 232239728 1604797591
1370 his file contains translations for internationalized paragraph styles (see
1371 \begin_inset CommandInset ref
1373 reference "subsec:I18n"
1381 \begin_layout Labeling
1382 \labelwidthstring 00.00.0000
1383 \begin_inset Flex Code
1386 \begin_layout Plain Layout
1393 \change_deleted 232239728 1604797594
1395 \change_inserted 232239728 1604797594
1398 his file contains information about Unicode-encoded glyphs and the way they are supported by \SpecialChar LyX
1399 via \SpecialChar LaTeX
1403 \begin_layout Section
1404 Your local configuration directory
1407 \begin_layout Standard
1408 Even if you are using \SpecialChar LyX
1409 as an unprivileged user,
1410 you might want to change \SpecialChar LyX
1411 configuration for your own use.
1413 \begin_inset Flex Code
1416 \begin_layout Plain Layout
1422 directory contains all your personal configuration files.
1423 This is the directory described as
1424 \begin_inset Quotes eld
1428 \begin_inset Quotes erd
1432 \begin_inset Flex Noun
1435 \begin_layout Plain Layout
1436 Help\SpecialChar menuseparator
1438 \begin_inset space ~
1447 This directory is used as a mirror of
1448 \begin_inset Flex Code
1451 \begin_layout Plain Layout
1458 which means that every file in
1459 \begin_inset Flex Code
1462 \begin_layout Plain Layout
1468 is a replacement for the corresponding file in
1469 \begin_inset Flex Code
1472 \begin_layout Plain Layout
1479 Any configuration file described in the above sections can be placed either in the system-wide directory,
1480 in which case it will affect all users,
1481 or in your local directory for your own use.
1484 \begin_layout Standard
1485 To make things clearer,
1486 let's provide a few examples:
1489 \begin_layout Itemize
1490 The preferences set in the
1491 \begin_inset Flex Noun
1494 \begin_layout Plain Layout
1495 Tools\SpecialChar menuseparator
1501 dialog are saved to a file
1502 \begin_inset Flex Code
1505 \begin_layout Plain Layout
1512 \begin_inset Flex Code
1515 \begin_layout Plain Layout
1524 \begin_layout Itemize
1525 When you reconfigure using
1526 \begin_inset Flex Noun
1529 \begin_layout Plain Layout
1530 Tools\SpecialChar menuseparator
1539 \begin_inset Flex Code
1542 \begin_layout Plain Layout
1549 and the resulting files are written in your local configuration directory.
1550 This means that any additional text class file that you might have added in
1551 \begin_inset Flex Code
1554 \begin_layout Plain Layout
1560 will be added to the list of classes in the
1561 \begin_inset Flex Noun
1564 \begin_layout Plain Layout
1565 Document\SpecialChar menuseparator
1574 \begin_layout Itemize
1575 If you get some updated documentation from
1576 \change_inserted 232239728 1604798171
1580 ftp site and cannot install it because you do not have sysadmin rights on your system,
1581 you can just copy the files
1582 \change_deleted 232239728 1604798193
1584 \change_inserted 232239728 1604798193
1588 \begin_inset Flex Code
1591 \begin_layout Plain Layout
1597 and the items in the
1598 \begin_inset Flex Noun
1601 \begin_layout Plain Layout
1607 menu will open them!
1610 \begin_layout Section
1611 Running \SpecialChar LyX
1612 with multiple configurations
1615 \begin_layout Standard
1616 The configuration freedom of the local configuration directory may not suffice if you want to have more than one configuration at your disposal.
1619 \change_deleted 232239728 1604798238
1622 use different key bindings or printer settings at different times.
1623 You can achieve this by having several such directories.
1624 You then specify which directory to use at run-time.
1627 \begin_layout Standard
1628 Invoking \SpecialChar LyX
1629 with the command line switch
1630 \begin_inset Flex Code
1633 \begin_layout Plain Layout
1643 instructs the program to read the configuration from that directory,
1644 and not from the default directory.
1645 (You can determine the default directory by running \SpecialChar LyX
1647 \begin_inset Flex Code
1650 \begin_layout Plain Layout
1656 switch.) If the specified directory does not exist,
1658 offers to create it for you,
1659 just like it does for the default directory
1660 \change_deleted 232239728 1604798318
1663 the first time you run the program.
1664 You can modify the configuration options in this additional user directory exactly as you would for the default directory.
1665 These directories are completely independent (but read on).
1666 Note that setting the environment variable
1667 \begin_inset Flex Code
1670 \begin_layout Plain Layout
1676 to some value has exactly the same effect.
1679 \begin_layout Standard
1680 Having several configurations also requires more maintenance:
1681 if you want to add a new layout to
1682 \begin_inset Flex Code
1685 \begin_layout Plain Layout
1691 which you want available from all your configurations,
1692 you must add it to each directory separately.
1693 You can avoid this with the following trick:
1694 after \SpecialChar LyX
1695 creates the additional directory,
1696 most of the subdirectories (see above) are empty.
1697 If you want the new configuration to mirror an existing one,
1698 replace the empty subdirectory with a symbolic link to the matching subdirectory in the existing configuration.
1700 \begin_inset Flex Code
1703 \begin_layout Plain Layout
1711 since it contains a file written by the configuration script (also accessible through
1712 \begin_inset Flex Noun
1715 \begin_layout Plain Layout
1716 Tools\SpecialChar menuseparator
1722 ) which is configuration
1723 \change_deleted 232239728 1604798083
1725 \change_inserted 232239728 1604798100
1731 \begin_layout Chapter
1732 The Preferences dialog
1735 \begin_layout Standard
1736 All options of the preferences dialog are described in the Appendix
1738 The Preferences Dialog
1745 For some options you might find here more details.
1748 \begin_layout Section
1750 \begin_inset CommandInset label
1759 \begin_layout Standard
1760 The first step is to define your file formats if they are not already defined.
1763 \begin_inset Flex Noun
1766 \begin_layout Plain Layout
1767 Tools\SpecialChar menuseparator
1775 \begin_inset Flex Noun
1778 \begin_layout Plain Layout
1779 File Handling\SpecialChar menuseparator
1786 \begin_inset Flex Noun
1789 \begin_layout Plain Layout
1795 button to define your new format.
1797 \begin_inset Flex Noun
1800 \begin_layout Plain Layout
1806 field contains the name used to identify the format in the GUI.
1808 \begin_inset Flex Noun
1811 \begin_layout Plain Layout
1817 is used to identify the format internally.
1818 You will also need to enter a file extension.
1819 These are all required.
1821 \begin_inset Flex Noun
1824 \begin_layout Plain Layout
1830 field is used to provide a keyboard shortcut on the menus.
1833 \begin_inset Flex Noun
1836 \begin_layout Plain Layout
1843 \begin_inset Flex Noun
1846 \begin_layout Plain Layout
1847 Document\SpecialChar menuseparator
1848 View (Other Formats)\SpecialChar menuseparator
1857 \begin_layout Standard
1859 \begin_inset Flex Noun
1862 \begin_layout Plain Layout
1869 \begin_inset Flex Noun
1872 \begin_layout Plain Layout
1880 you might want to use
1881 \begin_inset Flex Noun
1884 \begin_layout Plain Layout
1890 to view PostScript files.
1891 You can enter the command needed to start the program in the corresponding fields.
1892 In defining this command,
1893 you can use the four variables listed in the next section.
1894 The viewer is launched when you view an image in \SpecialChar LyX
1896 \begin_inset Flex Noun
1899 \begin_layout Plain Layout
1900 Document\SpecialChar menuseparator
1907 The editor is for example launched when you right-click on an image and choose
1908 \begin_inset Flex Noun
1911 \begin_layout Plain Layout
1917 in the appearing context menu.
1920 \begin_layout Standard
1922 \begin_inset Flex Noun
1925 \begin_layout Plain Layout
1931 type of a format is optional,
1932 but if it is specified,
1933 it must be unique across all formats.
1934 It is used to detect files of this format from the file contents.
1935 For some important file formats there is no MIME type officially registered with the
1936 \begin_inset CommandInset href
1939 target "http://www.iana.org/assignments/media-types/"
1945 Therefore \SpecialChar LyX
1946 uses the extended list of MIME types as specified by
1947 \begin_inset CommandInset href
1949 name "freedesktop.org"
1950 target "http://www.freedesktop.org/wiki/Specifications/shared-mime-info-spec"
1958 \begin_layout Standard
1960 \begin_inset Flex Noun
1963 \begin_layout Plain Layout
1969 option tells \SpecialChar LyX
1970 that a format is suitable for document export.
1971 If this is set and if a suitable conversion route exists (see
1972 \begin_inset CommandInset ref
1974 reference "sec:Converters"
1980 the format will appear in the
1981 \begin_inset Flex Noun
1984 \begin_layout Plain Layout
1985 File\SpecialChar menuseparator
1992 The format will also appear in the
1993 \begin_inset Flex Noun
1996 \begin_layout Plain Layout
1997 Document\SpecialChar menuseparator
2003 menu if a viewer is specified for the format.
2006 \begin_inset Flex Code
2009 \begin_layout Plain Layout
2016 should not use this option.
2017 Formats that can both represent vector graphics and documents like
2018 \begin_inset Flex Code
2021 \begin_layout Plain Layout
2030 \begin_layout Standard
2032 \begin_inset Flex Noun
2035 \begin_layout Plain Layout
2036 Vector graphics format
2041 tells \SpecialChar LyX
2042 that a format can contain vector graphics.
2043 This information is used to determine the target format of included graphics for
2044 \begin_inset Flex Noun
2047 \begin_layout Plain Layout
2054 Included graphics may need to be converted to either
2055 \begin_inset Flex Noun
2058 \begin_layout Plain Layout
2066 \begin_inset Flex Noun
2069 \begin_layout Plain Layout
2077 \begin_inset Flex Noun
2080 \begin_layout Plain Layout
2088 \begin_inset Flex Noun
2091 \begin_layout Plain Layout
2097 cannot handle other image formats.
2098 If an included graphic is not already in
2099 \begin_inset Flex Noun
2102 \begin_layout Plain Layout
2110 \begin_inset Flex Noun
2113 \begin_layout Plain Layout
2121 \begin_inset Flex Noun
2124 \begin_layout Plain Layout
2132 \begin_inset Flex Noun
2135 \begin_layout Plain Layout
2141 if the vector format option is set,
2143 \begin_inset Flex Noun
2146 \begin_layout Plain Layout
2155 \begin_layout Section
2159 \begin_layout Standard
2160 Since all conversions from one format to another take place in \SpecialChar LyX
2161 's temporary directory,
2162 it is sometimes necessary to modify a file before copying it to the temporary directory in order that the conversion may be performed.
2166 \begin_layout Plain Layout
2168 the file may refer to other files—
2171 using relative file names,
2172 and these may become invalid when the file is copied to the temporary directory.
2177 This is done by a Copier:
2178 It copies a file to (or from) the temporary directory and may modify it in the process.
2181 \begin_layout Standard
2182 The definitions of the copiers may use eight variables:
2185 \begin_layout Labeling
2186 \labelwidthstring 00.00.0000
2187 \begin_inset Flex Code
2190 \begin_layout Plain Layout
2196 The \SpecialChar LyX
2197 system directory (e.
2198 \begin_inset space \thinspace{}
2202 \begin_inset space \space{}
2206 \begin_inset Flex Noun
2209 \begin_layout Plain Layout
2218 \begin_layout Labeling
2219 \labelwidthstring 00.00.0000
2220 \begin_inset Flex Code
2223 \begin_layout Plain Layout
2232 \begin_layout Labeling
2233 \labelwidthstring 00.00.0000
2234 \begin_inset Flex Code
2237 \begin_layout Plain Layout
2246 \begin_layout Labeling
2247 \labelwidthstring 00.00.0000
2248 \begin_inset Flex Code
2251 \begin_layout Plain Layout
2257 The base name (without filename extension) in the \SpecialChar LyX
2261 \begin_layout Labeling
2262 \labelwidthstring 00.00.0000
2263 \begin_inset Flex Code
2266 \begin_layout Plain Layout
2272 The full directory path of 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 pathname to the original \SpecialChar LyX
2288 file being processed
2291 \begin_layout Labeling
2292 \labelwidthstring 00.00.0000
2293 \begin_inset Flex Code
2296 \begin_layout Plain Layout
2302 The filename (without any directory path) of the \SpecialChar LyX
2306 \begin_layout Labeling
2307 \labelwidthstring 00.00.0000
2308 \begin_inset Flex Code
2311 \begin_layout Plain Layout
2317 The `\SpecialChar LaTeX
2321 \begin_layout Standard
2322 The latter should be the filename as it would be used in a \SpecialChar LaTeX
2330 It is relevant only when exporting files suitable for such inclusion.
2333 \begin_layout Standard
2334 Copiers can be used to do almost anything with output files.
2336 suppose you want generated pdf files to be copied to a special directory,
2338 \begin_inset Flex Code
2341 \begin_layout Plain Layout
2348 Then you could write a shell script such as this one:
2351 \begin_layout Standard
2352 \begin_inset listings
2356 \begin_layout Plain Layout
2361 \begin_layout Plain Layout
2366 \begin_layout Plain Layout
2368 TOFILE=`basename $2`
2371 \begin_layout Plain Layout
2373 cp $FROMFILE /home/you/pdf/$TOFILE
2378 Save it in your local \SpecialChar LyX
2382 \begin_inset Flex Code
2385 \begin_layout Plain Layout
2386 /home/you/.lyx/scripts/pdfcopier.sh
2392 and make it executable,
2393 if you need to do so on your platform.
2396 \begin_inset Flex Noun
2399 \begin_layout Plain Layout
2400 Tools\SpecialChar menuseparator
2408 \begin_inset Flex Noun
2411 \begin_layout Plain Layout
2412 File Handling\SpecialChar menuseparator
2419 \begin_inset Flex Noun
2422 \begin_layout Plain Layout
2429 or one of the other pdf formats—
2431 \begin_inset Flex Code
2434 \begin_layout Plain Layout
2435 pdfcopier.sh $$i $$o
2441 \begin_inset Flex Noun
2444 \begin_layout Plain Layout
2454 \begin_layout Standard
2455 Copiers are used by \SpecialChar LyX
2456 in various of its own conversions.
2458 if appropriate programs are found,
2460 will automatically install copiers for the
2461 \begin_inset Flex Noun
2464 \begin_layout Plain Layout
2471 \begin_inset Flex Noun
2474 \begin_layout Plain Layout
2476 \begin_inset space ~
2485 When these formats are exported,
2486 the copier sees that not just the main HTML file but various associated files (style files,
2488 etc.) are also copied.
2489 All these files are written to a subdirectory of the directory in which the original \SpecialChar LyX
2494 \begin_layout Plain Layout
2495 This copier can be customized.
2497 \begin_inset Quotes eld
2501 \begin_inset Quotes erd
2504 argument takes a comma-separated list of extensions to be copied;
2506 all files will be copied.
2508 \begin_inset Quotes eld
2512 \begin_inset Quotes erd
2515 argument determines the extension added to the generated directory.
2518 \begin_inset Quotes eld
2522 \begin_inset Flex Noun
2525 \begin_layout Plain Layout
2532 \begin_inset Quotes erd
2536 so HTML generated from
2537 \begin_inset Flex Noun
2540 \begin_layout Plain Layout
2541 /path/to/filename.lyx
2547 \begin_inset Flex Noun
2550 \begin_layout Plain Layout
2551 /path/to/filename.html.LyXconv
2565 \begin_layout Section
2567 \begin_inset CommandInset label
2569 name "sec:Converters"
2576 \begin_layout Standard
2577 You can define your own Converters to convert files between different formats.
2579 \begin_inset Flex Noun
2582 \begin_layout Plain Layout
2583 Tools\SpecialChar menuseparator
2584 Preferences\SpecialChar menuseparator
2585 File Handling\SpecialChar menuseparator
2594 \begin_layout Standard
2595 To define a new converter,
2597 \begin_inset Flex Noun
2600 \begin_layout Plain Layout
2602 \begin_inset space ~
2611 \begin_inset Flex Noun
2614 \begin_layout Plain Layout
2616 \begin_inset space ~
2624 from the drop-down lists,
2625 enter the command needed for the conversion,
2627 \begin_inset Flex Noun
2630 \begin_layout Plain Layout
2637 Several variables can be used in the definition of converters:
2640 \begin_layout Labeling
2641 \labelwidthstring 00.00.0000
2642 \begin_inset Flex Code
2645 \begin_layout Plain Layout
2651 The \SpecialChar LyX
2655 \begin_layout Labeling
2656 \labelwidthstring 00.00.0000
2657 \begin_inset Flex Code
2660 \begin_layout Plain Layout
2669 \begin_layout Labeling
2670 \labelwidthstring 00.00.0000
2671 \begin_inset Flex Code
2674 \begin_layout Plain Layout
2683 \begin_layout Labeling
2684 \labelwidthstring 00.00.0000
2685 \begin_inset Flex Code
2688 \begin_layout Plain Layout
2694 The base filename of the input file (i.
2695 \begin_inset space \thinspace{}
2699 without the extension)
2702 \begin_layout Labeling
2703 \labelwidthstring 00.00.0000
2704 \begin_inset Flex Code
2707 \begin_layout Plain Layout
2713 The path to the input file
2716 \begin_layout Labeling
2717 \labelwidthstring 00.00.0000
2718 \begin_inset Flex Code
2721 \begin_layout Plain Layout
2727 The path to the original input file (this is different from $$p when a chain of converters is called)
2730 \begin_layout Labeling
2731 \labelwidthstring 00.00.0000
2732 \begin_inset Flex Code
2735 \begin_layout Plain Layout
2741 The iconv name for the encoding of the document.
2744 \begin_layout Standard
2746 \begin_inset Flex Noun
2749 \begin_layout Plain Layout
2751 \begin_inset space ~
2759 field you can enter the following flags,
2760 separated by commas:
2763 \begin_layout Labeling
2764 \labelwidthstring 00.00.0000
2765 \begin_inset Flex Code
2768 \begin_layout Plain Layout
2770 \change_inserted -712698321 1524656940
2778 This converter runs some form of \SpecialChar LaTeX
2780 This will make \SpecialChar LyX
2781 's \SpecialChar LaTeX
2782 error logs available.
2784 \change_inserted -712698321 1524657018
2786 \begin_inset Flex Code
2789 \begin_layout Plain Layout
2791 \change_inserted -712698321 1524657012
2799 value specifies the form of \SpecialChar LaTeX
2801 \begin_inset Flex Code
2804 \begin_layout Plain Layout
2806 \change_inserted -712698321 1524657005
2819 If no value is specified,
2821 \begin_inset Flex Code
2824 \begin_layout Plain Layout
2826 \change_inserted -712698321 1524657018
2839 \begin_layout Labeling
2840 \labelwidthstring 00.00.0000
2841 \begin_inset Flex Code
2844 \begin_layout Plain Layout
2846 \change_inserted -712698321 1524656935
2854 Needs the \SpecialChar LaTeX
2856 \begin_inset Flex Noun
2859 \begin_layout Plain Layout
2865 file for the conversion.
2867 \change_inserted -712698321 1524657047
2869 \begin_inset Flex Code
2872 \begin_layout Plain Layout
2874 \change_inserted -712698321 1524657030
2882 value specifies the form of \SpecialChar LaTeX
2883 that is run in order to generate the
2884 \begin_inset Flex Noun
2887 \begin_layout Plain Layout
2889 \change_inserted -712698321 1524657047
2898 \begin_inset Flex Code
2901 \begin_layout Plain Layout
2903 \change_inserted -712698321 1524657030
2916 If no value is specified,
2918 \begin_inset Flex Code
2921 \begin_layout Plain Layout
2923 \change_inserted -712698321 1524657030
2936 \begin_layout Labeling
2937 \labelwidthstring 00.00.0000
2938 \begin_inset Flex Code
2941 \begin_layout Plain Layout
2948 \begin_inset Quotes eld
2952 \begin_inset Quotes erd
2955 file from the backend,
2956 which in practice means a \SpecialChar LaTeX
2957 file like the one we would export,
2959 \begin_inset Flex Code
2962 \begin_layout Plain Layout
2971 \begin_layout Labeling
2972 \labelwidthstring 00.00.0000
2973 \begin_inset Flex Code
2976 \begin_layout Plain Layout
2985 \begin_layout Standard
2986 The following three flags are not really flags at all because they take an argument in the
2987 \begin_inset Flex Noun
2990 \begin_layout Plain Layout
2992 \begin_inset space ~
2996 \begin_inset space ~
3007 \begin_layout Labeling
3008 \labelwidthstring 00.00.0000
3010 \change_inserted -712698321 1523206314
3011 \begin_inset Flex Code
3014 \begin_layout Plain Layout
3016 \change_inserted -712698321 1523206193
3024 The name of the driver that needs to be loaded with the
3028 package for this converter.
3029 The loading of the correct driver is necessary to get some PDF-specific features.
3037 \begin_layout Labeling
3038 \labelwidthstring 00.00.0000
3039 \begin_inset Flex Code
3042 \begin_layout Plain Layout
3049 the converter's standard error will be redirected to a file
3050 \begin_inset Flex Code
3053 \begin_layout Plain Layout
3060 and the script given as argument will be run as:
3062 \begin_inset Flex Code
3065 \begin_layout Plain Layout
3066 script < infile.out > infile.log
3072 The argument may contain
3073 \begin_inset Flex Code
3076 \begin_layout Plain Layout
3085 \begin_layout Labeling
3086 \labelwidthstring 00.00.0000
3087 \begin_inset Flex Code
3090 \begin_layout Plain Layout
3096 The name of the directory in which the converter will dump the generated files.
3098 will not create this directory,
3099 and it does not copy anything into it,
3100 though it will copy this directory to the destination.
3101 The argument may contain
3102 \begin_inset Flex Code
3105 \begin_layout Plain Layout
3112 which will be replaced by the base name of the input and output files,
3114 when the directory is copied.
3115 \begin_inset Newline newline
3118 Note that resultdir and usetempdir make no sense together.
3119 The latter will be ignored if the former is given.
3122 \begin_layout Labeling
3123 \labelwidthstring 00.00.0000
3124 \begin_inset Flex Code
3127 \begin_layout Plain Layout
3133 Determines the output file name and may,
3135 \begin_inset Flex Code
3138 \begin_layout Plain Layout
3145 Sensible only with resultdir and optional even then;
3147 it defaults to `index'.
3150 \begin_layout Standard
3152 \change_inserted -712698321 1523206384
3153 A suitable hyperref-driver is set for some converters that are installed with \SpecialChar LyX
3156 \change_deleted -712698321 1523206388
3158 \change_inserted -712698321 1523206389
3162 \change_inserted -712698321 1523206400
3168 \change_inserted -712698321 1523206407
3172 \change_inserted -712698321 1523206437
3176 \change_deleted -712698321 1523206442
3177 that are installed with \SpecialChar LyX
3184 \begin_layout Standard
3185 You do not have to define converters for all formats between which you want to convert.
3187 you will note that there is no `\SpecialChar LyX
3188 to PostScript' converter,
3189 but \SpecialChar LyX
3190 will export PostScript.
3191 It does so by first creating a \SpecialChar LaTeX
3192 file (no converter needs to be defined for this) which is then converted to DVI using the `\SpecialChar LaTeX
3194 and finally converting the resulting DVI file to PostScript.
3196 finds such `chains' of converters automatically,
3197 and it will always choose the shortest possible chain.
3200 still define multiple conversion methods between file formats.
3202 the standard \SpecialChar LyX
3203 configuration provides five ways to convert \SpecialChar LaTeX
3207 \begin_layout Enumerate
3210 \begin_inset Flex Noun
3213 \begin_layout Plain Layout
3222 \begin_layout Enumerate
3223 via (DVI and) PostScript,
3225 \begin_inset Flex Noun
3228 \begin_layout Plain Layout
3237 \begin_layout Enumerate
3240 \begin_inset Flex Noun
3243 \begin_layout Plain Layout
3252 \begin_layout Enumerate
3254 \begin_inset Flex Noun
3257 \begin_layout Plain Layout
3267 \begin_layout Enumerate
3269 \begin_inset Flex Noun
3272 \begin_layout Plain Layout
3282 \begin_layout Standard
3283 To define such alternate chains,
3284 you must define multiple target `file formats',
3286 \begin_inset CommandInset ref
3288 reference "sec:Formats"
3295 in the standard configuration,
3297 \begin_inset Flex Noun
3300 \begin_layout Plain Layout
3307 \begin_inset Flex Noun
3310 \begin_layout Plain Layout
3318 \begin_inset Flex Noun
3321 \begin_layout Plain Layout
3328 \begin_inset Flex Noun
3331 \begin_layout Plain Layout
3339 \begin_inset Flex Noun
3342 \begin_layout Plain Layout
3349 \begin_inset Flex Noun
3352 \begin_layout Plain Layout
3360 \begin_inset Flex Noun
3363 \begin_layout Plain Layout
3370 \begin_inset Flex Noun
3373 \begin_layout Plain Layout
3382 \begin_inset Flex Noun
3385 \begin_layout Plain Layout
3392 \begin_inset Flex Noun
3395 \begin_layout Plain Layout
3403 all of which share the extension
3404 \begin_inset Flex Noun
3407 \begin_layout Plain Layout
3414 and which correspond to the conversion methods just mentioned.
3417 \begin_layout Chapter
3418 Internationalizing \SpecialChar LyX
3420 \begin_inset CommandInset label
3422 name "cha:Internationalizing-LyX"
3429 \begin_layout Standard
3431 supports using a translated interface.
3432 Last time we checked,
3434 provided text in thirty languages.
3435 The language of choice is called your
3440 (For further reading on locale settings,
3441 see also the documentation for locale that comes with your operating system.
3444 \begin_inset Flex Code
3447 \begin_layout Plain Layout
3453 could be a good place to start).
3456 \begin_layout Standard
3457 Notice that these translations will work,
3458 but do contain a few flaws.
3460 all dialogs have been designed with the English text in mind,
3461 which means that some of the translated text will be too large to fit within the space allocated.
3462 This is only a display problem and will not cause any harm.
3464 you will find that some of the translations do not define shortcut keys for everything.
3466 there are simply not enough free letters to do it.
3468 the translator just hasn't got around to doing it yet.
3469 Our localization team,
3470 which you may wish to join,
3474 \begin_layout Plain Layout
3475 If you are a fluent speaker of a language other than English,
3476 joining these teams is a great way to give back to the \SpecialChar LyX
3482 will of course try to fix these shortcomings in future versions of \SpecialChar LyX
3486 \begin_layout Section
3487 Translating \SpecialChar LyX
3491 \begin_layout Subsection
3492 Translating the graphical user interface (text messages).
3495 \begin_layout Standard
3498 \begin_inset Flex Code
3501 \begin_layout Plain Layout
3507 library to handle the internationalization of the interface.
3508 To have \SpecialChar LyX
3509 speak your favorite language in all menus and dialogs,
3511 \begin_inset Flex Code
3514 \begin_layout Plain Layout
3520 -file for that language.
3521 When this is available,
3522 you'll have to generate a
3523 \begin_inset Flex Code
3526 \begin_layout Plain Layout
3532 -file from it and install the
3533 \begin_inset Flex Code
3536 \begin_layout Plain Layout
3543 The process of doing all of this is explained in the documentation for GNU
3544 \begin_inset Flex Code
3547 \begin_layout Plain Layout
3554 It is possible to do this just for yourself,
3555 but if you're going to do it,
3556 you might as well share the results of your labors with the rest of the \SpecialChar LyX
3558 Send a message to the \SpecialChar LyX
3559 developers' list for more information about how to proceed.
3562 \begin_layout Standard
3564 this is what you should do (xx denotes the language code):
3567 \begin_layout Itemize
3568 Check out the \SpecialChar LyX
3571 \begin_inset CommandInset href
3573 name "information on the web"
3574 target "https://www.lyx.org/HowToUseGIT"
3582 \begin_layout Itemize
3584 \begin_inset Flex Code
3587 \begin_layout Plain Layout
3593 to the folder of the
3594 \begin_inset Flex Code
3597 \begin_layout Plain Layout
3605 \begin_inset Flex Code
3608 \begin_layout Plain Layout
3616 \begin_inset Flex Code
3619 \begin_layout Plain Layout
3625 doesn't exist anywhere,
3626 it can be remade with the console command
3627 \begin_inset Flex Code
3630 \begin_layout Plain Layout
3637 or you can use an existing po-file for some other language as a template).
3640 \begin_layout Itemize
3642 \begin_inset Flex Code
3645 \begin_layout Plain Layout
3655 \begin_layout Plain Layout
3656 This is just a text file,
3657 so it can be edited in any text editor.
3658 But there are also specialized programs that support such editing,
3663 (for all platforms) or
3672 contains a `mode' for editing
3673 \begin_inset Flex Code
3676 \begin_layout Plain Layout
3685 \begin_inset Flex URL
3688 \begin_layout Plain Layout
3690 https://www.gnu.org/software/gettext/manual/html_node/PO-Mode.html#PO-Mode
3700 For some menu- and widget-labels,
3701 there are also shortcut keys that should be translated.
3702 Those keys are marked after a `|',
3703 and should be translated according to the words and phrases of the language.
3704 You should also fill also out the information at the beginning of the new
3705 \begin_inset Flex Code
3708 \begin_layout Plain Layout
3714 -file with your email-address,
3716 so people know where to reach you with suggestions and entertaining flames.
3719 \begin_layout Standard
3720 If you are just doing this on your own,
3724 \begin_layout Itemize
3726 \begin_inset Flex Code
3729 \begin_layout Plain Layout
3736 This can be done with
3737 \begin_inset Flex Code
3740 \begin_layout Plain Layout
3741 msgfmt -o xx.mo < xx.po
3749 \begin_layout Itemize
3751 \begin_inset Flex Code
3754 \begin_layout Plain Layout
3760 -file to your locale-tree,
3761 at the correct directory for application messages for the language
3767 \begin_inset Flex Code
3770 \begin_layout Plain Layout
3777 \begin_inset space \thinspace{}
3781 \begin_inset space \space{}
3785 \begin_inset Flex Code
3788 \begin_layout Plain Layout
3789 /usr/local/share/locale/xx/LC_MESSAGES/lyx.mo
3799 \begin_layout Standard
3802 it would be best if the new
3803 \begin_inset Flex Code
3806 \begin_layout Plain Layout
3812 file could be added to the \SpecialChar LyX
3814 so others can use it.
3815 Adding it involves making additional changes to \SpecialChar LyX
3817 So send an email to the developers' mailing list if you're interested in doing that.
3820 \begin_layout Subsubsection
3824 \begin_layout Standard
3825 Sometimes it turns out that one English message needs to be translated into different messages in the target language.
3826 One example is the message
3827 \begin_inset Flex Code
3830 \begin_layout Plain Layout
3836 which has the German translation
3845 depending upon exactly what the English
3846 \begin_inset Quotes eld
3850 \begin_inset Quotes erd
3855 \begin_inset Flex Code
3858 \begin_layout Plain Layout
3864 does not handle such ambiguous translations.
3865 Therefore you have to add some context information to the message:
3867 \begin_inset Flex Code
3870 \begin_layout Plain Layout
3877 \begin_inset Flex Code
3880 \begin_layout Plain Layout
3881 To[[as in 'From format x to format y']]
3887 \begin_inset Flex Code
3890 \begin_layout Plain Layout
3891 To[[as in 'From page x to page y']].
3896 Now the two occurrences of
3897 \begin_inset Flex Code
3900 \begin_layout Plain Layout
3907 \begin_inset Flex Code
3910 \begin_layout Plain Layout
3916 and can be translated correctly to
3928 \begin_layout Standard
3929 Of course the context information needs to be stripped off the original message when no translation is used.
3930 Therefore you have to put it in double square brackets at the end of the message (see the example above).
3931 The translation mechanism of \SpecialChar LyX
3932 ensures that everything in double square brackets at the end of messages is removed before displaying the message.
3935 \begin_layout Subsection
3936 Translating the documentation.
3939 \begin_layout Standard
3940 The online documentation (in the
3941 \begin_inset Flex Noun
3944 \begin_layout Plain Layout
3950 -menu) can (and should!) be translated.
3951 If there are translated versions of the documentation available
3955 \begin_layout Plain Layout
3957 at least some of the documents have been translated into fourteen languages,
3958 with the Tutorial available in a few more.
3963 and the locale is set accordingly,
3964 these will be used automagically by \SpecialChar LyX
3967 looks for translated versions as
3968 \begin_inset Flex Code
3971 \begin_layout Plain Layout
3972 LyXDir/doc/xx/DocName.lyx
3979 \begin_inset Flex Code
3982 \begin_layout Plain Layout
3988 is the code for the language currently in use.
3989 If there are no translated documents,
3990 the default English versions will be displayed.
3991 Note that the translated versions must have the same filenames (
3992 \begin_inset Flex Code
3995 \begin_layout Plain Layout
4001 above) as the original.
4002 If you feel up to translating the documentation (an excellent way to proof-read the original documentation by the way!),
4003 there are a few things you should do right away:
4006 \begin_layout Itemize
4007 Check out the documentation translation web page at
4008 \begin_inset CommandInset href
4010 name "https://www.lyx.org/Translation"
4011 target "https://www.lyx.org/Translation"
4018 you can find out which (if any) documents have already been translated into your language.
4019 You can also find out who (if anyone) is organizing the effort to translate the documentation into your language.
4020 If no one is organizing the effort,
4021 please let us know that you're interested.
4024 \begin_layout Standard
4025 Once you get to actually translating,
4026 here's a few hints for you that may save you trouble:
4029 \begin_layout Itemize
4030 Join the documentation team!
4031 There is information on how to do that in
4032 \begin_inset Flex Code
4035 \begin_layout Plain Layout
4042 \begin_inset Flex Noun
4045 \begin_layout Plain Layout
4046 Help\SpecialChar menuseparator
4053 which by the way is the first document you should translate.
4056 \begin_layout Itemize
4057 Learn the typographic conventions for the language you are translating to.
4058 Typography is an ancient art and over the centuries,
4059 a great variety of conventions have developed throughout different parts of the world.
4060 Also study the professional terminology amongst typographers in your country.
4061 Inventing your own terminology will only confuse the users.
4065 Typography is addictive!)
4068 \begin_layout Itemize
4069 Make a copy of the document.
4070 This will be your working copy.
4071 You can use this as your personal translated help-file by placing it in your
4072 \begin_inset Flex Code
4075 \begin_layout Plain Layout
4082 \begin_inset Note Greyedout
4085 \begin_layout Plain Layout
4091 For a complex document with external material (images,
4093 if you make a copy e.
4094 \begin_inset space \thinspace{}
4098 \begin_inset space \space{}
4102 beware that the links to external material may be broken when the document is moved to a different place.
4103 The best way is to retrieve the \SpecialChar LyX
4105 \begin_inset Flex URL
4108 \begin_layout Plain Layout
4110 https://www.lyx.org/HowToUseGIT
4115 ) and to edit the doc file in place.
4123 \begin_layout Itemize
4124 Sometimes the original document (from the \SpecialChar LyX
4125 team) will be updated.
4126 Use the source viewer at
4127 \begin_inset CommandInset href
4129 name "https://www.lyx.org/trac/timeline"
4130 target "https://www.lyx.org/trac/timeline"
4135 to see what has been changed.
4136 That way you can easily see which parts of the translated document need to be updated.
4139 \begin_layout Standard
4140 If you ever find an error in the original document,
4141 fix it and notify the rest of the documentation team of the changes!
4142 (You didn't forget to join the documentation team,
4146 \begin_layout Standard
4147 \begin_inset Branch OutDated
4151 \begin_layout Section
4152 International Keyboard Support
4155 \begin_layout Standard
4159 The following section is by
4167 It needs to be fixed to conform to the new Documentation Style sheet and to make use of the new v1.0 features.
4168 The whole thing also needs to be merged with the section following it.-jw It may also be badly out of date.-rh (2008)]
4171 \begin_layout Subsection
4172 Defining Own Keymaps:
4176 \begin_layout Standard
4177 Let's look at a keyboard definition file a little closer.
4178 It is a plain text file defining
4181 \begin_layout Itemize
4182 key-to-key or key-to-string translations
4185 \begin_layout Itemize
4189 \begin_layout Itemize
4190 dead keys exceptions
4193 \begin_layout Standard
4194 To define key-to-key or key-to-string translation,
4198 \begin_layout Quotation
4199 \begin_inset Flex Code
4202 \begin_layout Plain Layout
4211 \begin_inset Flex Code
4214 \begin_layout Plain Layout
4223 \begin_layout Standard
4225 \begin_inset Flex Code
4228 \begin_layout Plain Layout
4234 is the key to be translated and
4235 \begin_inset Flex Code
4238 \begin_layout Plain Layout
4244 is the string to be inserted into the document.
4245 To define dead keys,
4249 \begin_layout Quotation
4250 \begin_inset Flex Code
4253 \begin_layout Plain Layout
4262 \begin_inset Flex Code
4265 \begin_layout Plain Layout
4274 \begin_layout Standard
4276 \begin_inset Flex Code
4279 \begin_layout Plain Layout
4285 is a keyboard key and
4286 \begin_inset Flex Code
4289 \begin_layout Plain Layout
4296 The following dead keys are supported (shortcut name is in parentheses):
4299 \begin_layout Quotation
4303 \begin_inset space \hfill{}
4309 \begin_layout Quotation
4311 \begin_inset space \hfill{}
4317 \begin_layout Quotation
4319 \begin_inset space \hfill{}
4325 \begin_layout Quotation
4327 \begin_inset space \hfill{}
4333 \begin_layout Quotation
4335 \begin_inset space \hfill{}
4341 \begin_layout Quotation
4343 \begin_inset space \hfill{}
4350 \begin_layout Plain Layout
4362 \begin_layout Quotation
4364 \begin_inset space \hfill{}
4370 \begin_layout Quotation
4372 \begin_inset space \hfill{}
4379 \begin_layout Plain Layout
4391 \begin_layout Quotation
4393 \begin_inset space \hfill{}
4399 \begin_layout Quotation
4401 \begin_inset space \hfill{}
4407 \begin_layout Quotation
4409 \begin_inset space \hfill{}
4416 \begin_layout Plain Layout
4428 \begin_layout Quotation
4430 \begin_inset space \hfill{}
4437 \begin_layout Plain Layout
4449 \begin_layout Quotation
4451 \begin_inset space \hfill{}
4457 \begin_layout Quotation
4458 hungarian umlaut (hug)
4459 \begin_inset space \hfill{}
4465 \begin_layout Quotation
4467 \begin_inset space \hfill{}
4473 \begin_layout Quotation
4475 \begin_inset space \hfill{}
4482 \begin_layout Plain Layout
4494 \begin_layout Standard
4495 Since in many international keyboards there are exceptions to what some dead keys should do,
4496 you can define them using
4499 \begin_layout Quotation
4500 \begin_inset Flex Code
4503 \begin_layout Plain Layout
4511 deadkey key outstring
4514 \begin_layout Standard
4517 if you enter caron-o,
4518 it generates circumflex-o,
4522 \begin_layout Quotation
4523 \begin_inset Flex Code
4526 \begin_layout Plain Layout
4539 \begin_layout Standard
4540 to make it work correctly.
4542 you have to define as exceptions dead keys over i and j,
4543 to remove the dot from them before inserting an accent mark.
4544 I will change this when the time comes,
4545 but so far I haven't had time.
4548 \begin_layout Standard
4550 and about characters:
4551 backslash is escaped,
4553 you'll need double backslash.
4556 \begin_inset Flex Code
4559 \begin_layout Plain Layout
4565 have different meaning.
4567 \begin_inset Flex Code
4570 \begin_layout Plain Layout
4577 quotes start and end \SpecialChar LaTeX
4581 \begin_inset Flex Code
4584 \begin_layout Plain Layout
4594 \begin_inset Flex Code
4597 \begin_layout Plain Layout
4605 \begin_inset Flex Code
4608 \begin_layout Plain Layout
4619 \begin_layout Standard
4620 If you make a keyboard description file that works for your language,
4621 please mail it to me,
4622 so I can include it in the next keymap distribution.
4625 \begin_layout Standard
4626 More keywords will be supported in keymap configuration file in future,
4630 \begin_layout Itemize
4631 \begin_inset Flex Code
4634 \begin_layout Plain Layout
4645 \begin_inset space \hfill{}
4649 \begin_inset Flex Code
4652 \begin_layout Plain Layout
4661 \begin_layout Itemize
4662 \begin_inset Flex Code
4665 \begin_layout Plain Layout
4676 \begin_inset space \hfill{}
4680 \begin_inset Flex Code
4683 \begin_layout Plain Layout
4689 an external keymap translation program
4692 \begin_layout Standard
4695 \begin_inset Flex Code
4698 \begin_layout Plain Layout
4707 \begin_inset Flex Code
4710 \begin_layout Plain Layout
4718 option to include default keyboard).
4726 \begin_layout Section
4727 International Keymap Stuff
4728 \begin_inset CommandInset label
4730 name "sec:International-Keymap-Stuff"
4737 \begin_layout Standard
4738 \begin_inset Note Note
4741 \begin_layout Plain Layout
4742 In doing the revisions on this document in March 2008,
4743 I did not look over this stuff,
4744 as I do not understand it.
4745 It would be good if someone else could do so.
4754 \begin_layout Standard
4755 The next two sections describe the
4756 \begin_inset Flex Code
4759 \begin_layout Plain Layout
4768 \begin_inset Flex Code
4771 \begin_layout Plain Layout
4779 file syntax in detail.
4780 These sections should help you design your own key map if the ones provided do not meet your needs.
4783 \begin_layout Subsection
4787 \begin_layout Standard
4791 \begin_inset Flex Code
4794 \begin_layout Plain Layout
4800 file maps keystrokes to characters or strings.
4801 As the name suggests,
4802 it sets a keyboard mapping.
4804 \begin_inset Flex Code
4807 \begin_layout Plain Layout
4818 \begin_inset Flex Code
4821 \begin_layout Plain Layout
4837 \begin_inset Flex Code
4840 \begin_layout Plain Layout
4854 \begin_inset Flex Code
4857 \begin_layout Plain Layout
4867 \begin_inset Flex Code
4870 \begin_layout Plain Layout
4878 are described in this section.
4881 \begin_layout Labeling
4882 \labelwidthstring 00.00.0000
4883 \begin_inset Flex Code
4886 \begin_layout Plain Layout
4894 Map a character to a string
4897 \begin_layout LyX-Code
4912 \begin_layout Standard
4946 the double-quote (")
4963 must be escaped with a preceding backslash (
4974 \begin_layout Standard
4976 \begin_inset Flex Noun
4979 \begin_layout Plain Layout
4987 statement to cause the symbol
4988 \begin_inset Flex Noun
4991 \begin_layout Plain Layout
4999 to be output for the keystroke
5000 \begin_inset Flex Noun
5003 \begin_layout Plain Layout
5014 \begin_layout LyX-Code
5020 \begin_layout Labeling
5021 \labelwidthstring 00.00.0000
5022 \begin_inset Flex Code
5025 \begin_layout Plain Layout
5033 Specify an accent character
5036 \begin_layout LyX-Code
5045 \begin_layout Standard
5046 This will make the cha
5084 This is the dead key
5088 \begin_layout Plain Layout
5095 refers to a key that does not produce a character by itself,
5096 but when followed with another key,
5097 produces the desired accent character.
5101 r with an umlaut like
5111 can be produced in this manner.
5120 \begin_layout Standard
5133 and then another key not in
5151 followed by the other,
5157 \begin_inset Flex Noun
5160 \begin_layout Plain Layout
5180 \begin_inset Flex Noun
5183 \begin_layout Plain Layout
5193 the cursor will not go one position backwards but will instead cancel the effect t
5208 might have had on the next keystroke.
5212 \begin_layout Standard
5213 The following example specifies that the character ' is to be an acute accent,
5214 allowed on the characters a,
5226 \begin_layout LyX-Code
5229 kmod ' acute aeiouAEIOU
5232 \begin_layout Labeling
5233 \labelwidthstring 00.00.0000
5234 \begin_inset Flex Code
5237 \begin_layout Plain Layout
5243 Specify an exception to the accent character
5246 \begin_layout LyX-Code
5255 \begin_layout Standard
5256 This defines an exce
5297 have been assigned a keystroke with a previous
5300 \begin_inset Flex Code
5303 \begin_layout Plain Layout
5327 must not belong in the
5375 If such a declaration does not exist in
5383 \begin_inset Flex Code
5386 \begin_layout Plain Layout
5421 \begin_inset Flex Code
5424 \begin_layout Plain Layout
5438 \begin_layout Standard
5439 The following command produces causes äi to be produced when you enter acute-i ('i):
5442 \begin_layout LyX-Code
5456 \begin_layout Labeling
5457 \labelwidthstring 00.00.0000
5458 \begin_inset Flex Code
5461 \begin_layout Plain Layout
5467 Combine two accent characters
5470 \begin_layout LyX-Code
5476 accent1 accent2 allowed
5479 \begin_layout Standard
5480 This one is getting pretty esoteric.
5481 It allows you to combine the effect
5537 \begin_inset Flex Code
5540 \begin_layout Plain Layout
5568 \begin_layout Standard
5569 Consider this example from the
5570 \begin_inset Flex Code
5573 \begin_layout Plain Layout
5584 \begin_layout LyX-Code
5588 acute aeioyvhAEIOYVH
5593 kcomb acute umlaut iyIY
5596 \begin_layout Standard
5597 This allows you to press
5598 \begin_inset Flex Noun
5601 \begin_layout Plain Layout
5609 and get the effect of
5610 \begin_inset Flex Code
5613 \begin_layout Plain Layout
5632 in this case cancels the last dead key,
5634 \begin_inset Flex Noun
5637 \begin_layout Plain Layout
5647 \begin_inset Flex Code
5650 \begin_layout Plain Layout
5663 \begin_layout Subsection
5667 \begin_layout Standard
5669 \begin_inset Flex Code
5672 \begin_layout Plain Layout
5680 mapping is performed,
5682 \begin_inset Flex Code
5685 \begin_layout Plain Layout
5695 file maps the strings that the symbols generate to characters in the current font.
5696 The \SpecialChar LyX
5697 distribution currently includes at least the
5698 \begin_inset Flex Code
5701 \begin_layout Plain Layout
5710 \begin_inset Flex Code
5713 \begin_layout Plain Layout
5724 \begin_layout Standard
5726 \begin_inset Flex Code
5729 \begin_layout Plain Layout
5737 file is a sequence of declarations of the form
5740 \begin_layout LyX-Code
5753 \begin_layout Standard
5756 \begin_inset Flex Noun
5759 \begin_layout Plain Layout
5769 to the corresponding character in the iso-8859-1 set (233),
5770 the following declaration is used
5773 \begin_layout LyX-Code
5781 \begin_layout Standard
5783 \begin_inset Flex Code
5786 \begin_layout Plain Layout
5795 \begin_inset Flex Code
5798 \begin_layout Plain Layout
5816 the same character can apply to more than one string.
5818 \begin_inset Flex Code
5821 \begin_layout Plain Layout
5832 \begin_layout LyX-Code
5844 \begin_inset Newline newline
5860 \begin_layout Standard
5862 cannot find a mapping for the string produced by the keystroke or a deadkey sequence,
5863 it will check if it looks like an accented char and try to draw an accent over the character on screen.
5866 \begin_layout Subsection
5870 \begin_layout Standard
5871 There is a second way to add support for international characters through so-called dead-keys.
5872 A dead-key works in combination with a letter to produce an accented character.
5874 we'll explain how to create a really simple dead-key to illustrate how they work.
5877 \begin_layout Standard
5878 Suppose you happen to need the circumflex character,
5880 \begin_inset Quotes eld
5884 \begin_inset Quotes erd
5889 \begin_inset Flex Noun
5892 \begin_layout Plain Layout
5899 \begin_inset space ~
5903 \begin_inset Flex Noun
5906 \begin_layout Plain Layout
5912 ] to the \SpecialChar LyX
5914 \begin_inset Flex Code
5917 \begin_layout Plain Layout
5924 \begin_inset Flex Code
5927 \begin_layout Plain Layout
5935 whenever you type the
5936 \begin_inset Flex Noun
5939 \begin_layout Plain Layout
5945 -key followed by a letter,
5946 that letter will have a circumflex accent on it.
5949 \begin_inset Quotes eld
5953 \begin_inset Flex Noun
5956 \begin_layout Plain Layout
5963 \begin_inset Quotes erd
5966 produces the letter:
5968 \begin_inset Quotes eld
5972 \begin_inset Quotes erd
5976 If you tried to type
5977 \begin_inset Quotes eld
5981 \begin_inset Flex Noun
5984 \begin_layout Plain Layout
5991 \begin_inset Quotes erd
5997 will complain with a beep,
5999 \begin_inset Quotes eld
6003 \begin_inset Flex Noun
6006 \begin_layout Plain Layout
6013 \begin_inset Quotes erd
6016 never takes a circumflex accent.
6018 \begin_inset Flex Noun
6021 \begin_layout Plain Layout
6027 after a dead-key produces the bare-accent.
6028 Please note this last point!
6029 If you bind a key to a dead-key,
6030 you'll need to rebind the character on that key to yet another key.
6032 \begin_inset Flex Noun
6035 \begin_layout Plain Layout
6041 to a cedilla is a bad idea,
6042 since you'll only get cedillas instead of commas.
6045 \begin_layout Standard
6046 One common way to bind dead-keys is to use
6047 \begin_inset Flex Noun
6050 \begin_layout Plain Layout
6058 \begin_inset Flex Noun
6061 \begin_layout Plain Layout
6069 \begin_inset Flex Noun
6072 \begin_layout Plain Layout
6078 in combination with an accent,
6080 \begin_inset Quotes eld
6084 \begin_inset Flex Noun
6087 \begin_layout Plain Layout
6094 \begin_inset Quotes erd
6098 \begin_inset Quotes eld
6102 \begin_inset Flex Noun
6105 \begin_layout Plain Layout
6112 \begin_inset Quotes erd
6116 \begin_inset Quotes eld
6120 \begin_inset Flex Noun
6123 \begin_layout Plain Layout
6130 \begin_inset Quotes erd
6134 Another way involves using
6135 \begin_inset Flex Code
6138 \begin_layout Plain Layout
6145 \begin_inset Flex Code
6148 \begin_layout Plain Layout
6154 to set up the special
6155 \begin_inset Flex Code
6158 \begin_layout Plain Layout
6166 \begin_inset Flex Code
6169 \begin_layout Plain Layout
6175 acts in some ways just like
6176 \begin_inset Flex Noun
6179 \begin_layout Plain Layout
6185 and permits you to bind keys to accented characters.
6186 You can also turn keys into dead-keys by binding them to something like
6187 \begin_inset Flex Code
6190 \begin_layout Plain Layout
6196 and then binding this symbolic key to the corresponding \SpecialChar LyX
6201 \begin_layout Plain Layout
6207 This is exactly what I do in my
6208 \begin_inset Flex Code
6211 \begin_layout Plain Layout
6218 \begin_inset Flex Code
6221 \begin_layout Plain Layout
6229 \begin_inset Flex Noun
6232 \begin_layout Plain Layout
6234 \begin_inset space ~
6243 \begin_inset Flex Code
6246 \begin_layout Plain Layout
6252 and a bunch of these
6253 \begin_inset Quotes eld
6257 \begin_inset Flex Code
6260 \begin_layout Plain Layout
6267 \begin_inset Quotes erd
6270 symbolic keys bound such things as
6271 \begin_inset Flex Noun
6274 \begin_layout Plain Layout
6276 \begin_inset space ~
6285 \begin_inset Flex Noun
6288 \begin_layout Plain Layout
6290 \begin_inset space ~
6299 This is how I produce my accented characters.
6304 You can make just about anything into the
6305 \begin_inset Flex Code
6308 \begin_layout Plain Layout
6316 \begin_inset Flex Noun
6319 \begin_layout Plain Layout
6326 a spare function key,
6328 As for the \SpecialChar LyX
6329 commands that produce accents,
6331 \begin_inset Flex Code
6334 \begin_layout Plain Layout
6345 You'll find the complete list there.
6348 \begin_layout Subsection
6349 Saving your Language Configuration
6352 \begin_layout Standard
6353 You can edit your preferences so that your desired language environment is automatically configured when \SpecialChar LyX
6356 \begin_inset Flex Noun
6359 \begin_layout Plain Layout
6360 Edit\SpecialChar menuseparator
6369 \begin_layout Chapter
6371 \change_inserted -584632292 1610232084
6374 Installing New Document Classes,
6377 \begin_inset CommandInset label
6379 name "cha:Installing-New-Document"
6384 \begin_inset Argument 1
6387 \begin_layout Plain Layout
6388 Installing New Document Classes
6396 \begin_layout Standard
6398 we describe the procedures for creating and installing new \SpecialChar LyX
6399 layout and template files,
6400 as well as offer a refresher on correctly installing new \SpecialChar LaTeX
6405 \begin_layout Standard
6407 let us a say a few words about how one ought to think about the relation between \SpecialChar LyX
6408 and \SpecialChar LaTeX
6410 The thing to understand is that,
6413 doesn't know anything about \SpecialChar LaTeX
6416 from \SpecialChar LyX
6419 is just one of several
6420 \begin_inset Quotes eld
6424 \begin_inset Quotes erd
6427 in which it is capable of producing output.
6428 Other such formats are DocBook,
6434 a particularly important format,
6435 but very little of the information \SpecialChar LyX
6436 has about \SpecialChar LaTeX
6437 is actually contained in the program itself.
6441 \begin_layout Plain Layout
6442 Some commands are sufficiently complex that they are
6443 \begin_inset Quotes eld
6447 \begin_inset Quotes erd
6450 into \SpecialChar LyX
6452 But the developers generally regard this as a Bad Thing.
6459 even for the standard classes like
6460 \begin_inset Flex Code
6463 \begin_layout Plain Layout
6470 is contained in `layout files'.
6473 itself does not know much about DocBook or XHTML.
6474 What it knows is contained in layout files.
6477 \begin_layout Standard
6478 You can think of the layout file for a given document class as a translation manual between \SpecialChar LyX
6480 paragraphs with their corresponding styles,
6481 certain sorts of insets,
6483 and the corresponding \SpecialChar LaTeX
6486 or XHTML constructs.
6487 Almost everything \SpecialChar LyX
6489 \begin_inset Flex Code
6492 \begin_layout Plain Layout
6500 is contained in the file
6501 \begin_inset Flex Code
6504 \begin_layout Plain Layout
6510 and in various other files it includes.
6512 anyone intending to write layout files should plan to study the existing files.
6513 A good place to start is with
6514 \begin_inset Flex Code
6517 \begin_layout Plain Layout
6524 which is included in
6525 \begin_inset Flex Code
6528 \begin_layout Plain Layout
6536 \begin_inset Flex Code
6539 \begin_layout Plain Layout
6546 and many of the other layout files for document classes.
6547 This file is where sections and the like are defined:
6549 \begin_inset Flex Code
6552 \begin_layout Plain Layout
6558 tells \SpecialChar LyX
6559 how paragraphs that are marked with the Section,
6562 styles can be translated into corresponding \SpecialChar LaTeX
6565 and XHTML commands and tags.
6567 \begin_inset Flex Code
6570 \begin_layout Plain Layout
6576 file basically just includes several of these
6577 \begin_inset Flex Code
6580 \begin_layout Plain Layout
6589 \begin_layout Standard
6590 Defining the \SpecialChar LyX
6592 correspondence is not the only thing layout files do,
6594 Their other job is to define how the \SpecialChar LyX
6595 constructs themselves will appear on-screen.
6596 The fact that layout files have these two jobs is often a source of confusion,
6597 because they are completely separate.
6598 Telling \SpecialChar LyX
6599 how to translate a certain paragraph style into \SpecialChar LaTeX
6600 does not tell \SpecialChar LyX
6603 telling \SpecialChar LyX
6604 how to display a certain paragraph style does not tell \SpecialChar LyX
6605 how to translate it into \SpecialChar LaTeX
6606 (let alone tell \SpecialChar LaTeX
6610 when you define a new \SpecialChar LyX
6612 you must always do two quite separate things:
6614 \begin_inset space ~
6617 tell \SpecialChar LyX
6618 how to translate it into \SpecialChar LaTeX
6620 \begin_inset space ~
6623 tell \SpecialChar LyX
6627 \begin_layout Standard
6628 Much the same is true,
6630 as regards \SpecialChar LyX
6631 's other backend formats,
6632 though XHTML is in some ways different,
6633 because in that case \SpecialChar LyX
6640 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.
6643 the distinction between what \SpecialChar LyX
6644 does internally and how things are rendered externally remains in force,
6645 and the two can be controlled separately.
6647 \begin_inset CommandInset ref
6649 reference "sec:Tags-for-XHTML"
6657 \begin_layout Section
6658 Installing new \SpecialChar LaTeX
6662 \begin_layout Standard
6663 Some installations may not include a \SpecialChar LaTeX
6664 package or class file that you would like to use within \SpecialChar LyX
6667 you might need Foil\SpecialChar TeX
6669 a package for preparing slides for overhead projectors.
6670 Modern \SpecialChar LaTeX
6671 distributions like \SpecialChar TeX
6672 Live (2008 or newer) or MiK\SpecialChar TeX
6673 provide a user interface for installing such packages.
6675 with MiK\SpecialChar TeX
6677 you start the program
6678 \begin_inset Quotes eld
6682 \begin_inset space ~
6686 \begin_inset Quotes erd
6689 to get a list of available packages.
6690 To install one of them,
6691 right click on it or use the corresponding toolbar button.
6694 \begin_layout Standard
6695 If your \SpecialChar LaTeX
6696 distribution does not provide such a `package manager',
6697 or if the package is not available from your distribution,
6698 then follow these steps to install it manually:
6701 \begin_layout Enumerate
6702 Get the package from
6703 \begin_inset CommandInset href
6706 target "http://www.ctan.org/"
6714 \begin_layout Enumerate
6715 If the package contains a file with the ending
6716 \begin_inset Quotes eld
6720 \begin_inset Flex Code
6723 \begin_layout Plain Layout
6730 \begin_inset Quotes erd
6733 (is the case for Foil\SpecialChar TeX
6734 ) then open a console,
6735 change to the folder of this file and execute the command
6736 \begin_inset Flex Code
6739 \begin_layout Plain Layout
6746 You have now unpacked the package and have all files to install it.
6747 Most \SpecialChar LaTeX
6748 -packages are not packed and you can skip this step.
6751 \begin_layout Enumerate
6752 Now you need to decide if the package should be available for all users or only for you.
6756 \begin_layout Enumerate
6757 On *nix systems (Linux,
6760 if you want the new package to be available for all users on your system,
6761 then install it in your `local' \SpecialChar TeX
6763 otherwise install it in your own `user' \SpecialChar TeX
6765 Where these trees should be created,
6766 if they do not already exist,
6767 depends on your system.
6770 \begin_inset Flex Code
6773 \begin_layout Plain Layout
6783 \begin_layout Plain Layout
6784 This is usually in the directory
6785 \begin_inset Flex Code
6788 \begin_layout Plain Layout
6795 though you can execute the command
6796 \begin_inset Flex Code
6799 \begin_layout Plain Layout
6810 The location of the `local' \SpecialChar TeX
6811 tree is defined by the
6812 \begin_inset Flex Code
6815 \begin_layout Plain Layout
6822 this is usually somewhere like
6823 \begin_inset Flex Code
6826 \begin_layout Plain Layout
6827 /usr/local/share/texmf
6832 or /usr/local/texlive/XXXX where XXXX is the year of the installed \SpecialChar TeX
6834 The location of the `user' \SpecialChar TeX
6836 \begin_inset Flex Code
6839 \begin_layout Plain Layout
6846 \begin_inset Flex Code
6849 \begin_layout Plain Layout
6856 \begin_inset Flex Code
6859 \begin_layout Plain Layout
6868 (If these variables are not predefined,
6869 you have to define them.) You'll probably need root permissions to create or modify the `local' tree,
6870 but not for your `user' tree.
6871 \begin_inset Newline newline
6875 it is recommended to install in the user tree because your user will not be modified or even overwritten when you upgrade your system.
6876 It will typically also be backed up together with everything else when you backup your home directory (which,
6878 you do on a regular basis).
6881 \begin_layout Enumerate
6883 if you want the new package to be available for all users on your system,
6884 change to the folder where \SpecialChar LaTeX
6885 is installed and then change to the subfolder
6886 \begin_inset Flex Code
6889 \begin_layout Plain Layout
6900 (For MiK\SpecialChar TeX
6902 this would be by default the folder
6903 \begin_inset Flex Code
6906 \begin_layout Plain Layout
6924 \begin_layout Plain Layout
6925 Note that this will be the correct path only on English installations.
6928 \begin_inset Flex Code
6931 \begin_layout Plain Layout
6946 and similarly for other languages.
6951 Create there a new folder
6952 \begin_inset Flex Code
6955 \begin_layout Plain Layout
6961 and copy all files of the package into it.
6963 \begin_inset Newline newline
6966 If the package should only available for you or you don't have admin permissions,
6968 but in the local \SpecialChar LaTeX
6971 \begin_inset space \thinspace{}
6975 for MiK\SpecialChar TeX
6977 \begin_inset space ~
6980 2.8 under Windows XP,
6981 this would be the folder:
6982 \begin_inset Newline newline
6988 \begin_inset Flex Code
6991 \begin_layout Plain Layout
6994 Documents and Settings
7006 \begin_inset Newline newline
7012 \begin_inset Phantom HPhantom
7015 \begin_layout Plain Layout
7026 \begin_inset Flex Code
7029 \begin_layout Plain Layout
7042 \begin_inset Newline newline
7047 \begin_inset Newline newline
7051 \begin_inset Flex Code
7054 \begin_layout Plain Layout
7080 \begin_layout Enumerate
7081 Now one only need to tell \SpecialChar LaTeX
7082 that there are new files.
7083 This depends on the used \SpecialChar LaTeX
7088 \begin_layout Enumerate
7089 For \SpecialChar TeX
7090 Live execute the command
7091 \begin_inset Flex Code
7094 \begin_layout Plain Layout
7101 If you installed the package for all users,
7102 then you will probably need to have root permissions for that.
7105 \begin_layout Enumerate
7106 For MiK\SpecialChar TeX
7108 if you have installed the package for all users,
7110 \begin_inset Quotes eld
7114 \begin_inset space ~
7118 \begin_inset Quotes erd
7121 and press the button marked
7122 \begin_inset Quotes eld
7126 \begin_inset Quotes erd
7130 Otherwise start the program
7131 \begin_inset Quotes eld
7135 \begin_inset Quotes erd
7142 \begin_layout Enumerate
7144 you need to tell \SpecialChar LyX
7145 that there are new packages available.
7150 \begin_inset Flex Noun
7153 \begin_layout Plain Layout
7156 \SpecialChar menuseparator
7162 and then restart \SpecialChar LyX
7166 \begin_layout Standard
7167 Now the package is installed.
7170 \begin_inset Flex Code
7173 \begin_layout Plain Layout
7179 will now be available under
7180 \begin_inset Flex Noun
7183 \begin_layout Plain Layout
7184 Document\SpecialChar menuseparator
7185 Settings\SpecialChar menuseparator
7192 \begin_inset Quotes eld
7196 \begin_inset Quotes erd
7203 \begin_layout Standard
7204 If you would like to use a \SpecialChar LaTeX
7205 document class that is not even listed in the menu
7206 \begin_inset Flex Noun
7209 \begin_layout Plain Layout
7210 Document\SpecialChar menuseparator
7211 Settings\SpecialChar menuseparator
7218 then you need to create a `layout' file for it.
7219 That is the topic of the next section.
7222 \begin_layout Section
7223 Types of layout files
7226 \begin_layout Standard
7227 This section describes the various sorts of \SpecialChar LyX
7228 files that contain layout information.
7229 These files describe various paragraph and character styles,
7230 determining how \SpecialChar LyX
7231 should display them and how they should be translated into \SpecialChar LaTeX
7235 or whatever output format is being used.
7239 \begin_layout Standard
7240 We shall try to provide a thorough description of the process of writing layout files here.
7242 there are so many different types of documents supported even by just \SpecialChar LaTeX
7243 that we can't hope to cover every different possibility or problem you might encounter.
7244 The \SpecialChar LyX
7245 users' list is frequented by people with lots of experience with layout design who are willing to share what they've learned,
7246 so please feel free to ask questions there.
7249 \begin_layout Standard
7250 As you prepare to write a new layout,
7251 it is extremely helpful to look at the layouts distributed with \SpecialChar LyX
7253 If you write a \SpecialChar LyX
7254 layout for a \SpecialChar LaTeX
7255 document class that might also be used by others,
7256 or write a module that might be useful to others,
7257 then you should consider posting your layout to the
7258 \begin_inset CommandInset href
7260 name "layout section on the LyX wiki"
7261 target "https://wiki.lyx.org/Layouts/Layouts"
7266 or even to the \SpecialChar LyX
7268 so that it might be included in \SpecialChar LyX
7273 \begin_layout Plain Layout
7274 Note that \SpecialChar LyX
7275 is licensed under the General Public License,
7276 so any material that is contributed to \SpecialChar LyX
7277 must be similarly licensed.
7285 \begin_layout Subsection
7287 \begin_inset CommandInset label
7289 name "subsec:Layout-modules"
7296 \begin_layout Standard
7297 We have spoken to this point about `layout files'.
7298 But there are different sorts of files that contain layout information.
7302 \begin_inset Flex Code
7305 \begin_layout Plain Layout
7311 extension and provide \SpecialChar LyX
7312 with information about document classes.
7313 Since \SpecialChar LyX
7314 1.6 layout information can also be contained in layout
7320 \begin_inset Flex Code
7323 \begin_layout Plain Layout
7330 Modules are to \SpecialChar LaTeX
7331 packages much as layouts are to \SpecialChar LaTeX
7335 \begin_inset Flex Code
7338 \begin_layout Plain Layout
7345 specifically provide support for one package.
7347 layout modules are similar to included
7351 \begin_layout Plain Layout
7352 These can have any extension,
7353 but by convention have the
7354 \begin_inset Flex Code
7357 \begin_layout Plain Layout
7370 \begin_inset Flex Code
7373 \begin_layout Plain Layout
7380 in that modules are not specific to a given document class but may be used with many different classes.
7381 The difference is that using an included file with
7382 \begin_inset Flex Code
7385 \begin_layout Plain Layout
7391 requires editing that file.
7395 \begin_inset Flex Noun
7398 \begin_layout Plain Layout
7399 Document\SpecialChar menuseparator
7408 \begin_layout Standard
7409 Building modules is the easiest way to get started with layout editing,
7410 since it can be as simple as adding a single new paragraph style or flex inset.
7413 contain anything a layout file can contain.
7416 \begin_layout Standard
7417 After creating a new module and copying it to the
7418 \begin_inset Flex Code
7421 \begin_layout Plain Layout
7428 you will need to reconfigure and then restart \SpecialChar LyX
7429 for the module to appear in the menu.
7431 changes you make to the module will be seen immediately,
7433 \begin_inset Flex Noun
7436 \begin_layout Plain Layout
7437 Document\SpecialChar menuseparator
7444 highlight something,
7446 \begin_inset Quotes eld
7450 \begin_inset Quotes erd
7456 It is strongly recommended that you save your work before doing this
7462 it is strongly recommended that you not attempt to edit modules while simultaneously working on actual documents
7465 Though of course the developers strive to keep \SpecialChar LyX
7466 stable in such situations,
7467 syntax errors and the like in your module file could cause strange behavior.
7470 \begin_layout Subsubsection
7474 \begin_layout Standard
7475 Modules are to \SpecialChar LyX
7476 as packages are to \SpecialChar LaTeX
7480 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.
7481 What you need is \SpecialChar LyX
7483 \begin_inset Quotes eld
7487 \begin_inset Quotes erd
7493 \begin_layout Standard
7494 You will find it under
7496 Document\SpecialChar menuseparator
7497 Settings\SpecialChar menuseparator
7501 The large text box allows you to enter anything that you might enter in a layout file or module.
7502 You can think of a document's local layout,
7504 as a module that belongs just to it.
7508 \begin_inset Flex Code
7511 \begin_layout Plain Layout
7518 Any format is acceptable,
7519 but one would normally use the format current at the time.
7520 (In \SpecialChar LyX
7528 the current layout format is
7537 \begin_layout Standard
7538 When you have entered something in the
7539 \begin_inset Flex Code
7542 \begin_layout Plain Layout
7551 \begin_inset Quotes eld
7555 \begin_inset Quotes erd
7558 button at the bottom.
7559 Clicking this button will cause \SpecialChar LyX
7560 to determine whether what you have entered is valid layout information for the chosen format.
7562 will report the result but,
7564 will not tell you what errors there might have been.
7565 These will be written to the terminal,
7568 is started from a terminal.
7569 You will not be permitted to save your local layout until you have entered something valid.
7572 \begin_layout Standard
7573 The warnings at the end of the previous section apply here,
7575 Do not play with local layout while you are actually working,
7576 especially if you have not saved your document.
7578 using local layout with a test document can be a very convenient way to try out layout ideas,
7579 or even to start developing a module.
7582 \begin_layout Subsection
7584 \begin_inset Flex Noun
7587 \begin_layout Plain Layout
7596 \begin_layout Standard
7597 There are two situations you are likely to encounter when wanting to support a new \SpecialChar LaTeX
7600 \begin_inset Flex Code
7603 \begin_layout Plain Layout
7609 ) files and \SpecialChar LaTeX2e
7611 \begin_inset Flex Code
7614 \begin_layout Plain Layout
7621 Supporting a style file is usually fairly easy.
7622 Supporting a new class file is a bit harder.
7623 We'll discuss the former in this section and the latter in the next.
7625 \change_deleted 5863208 1594239023
7626 Similar remarks apply,
7628 if you want to support a new DocBook DTD.
7633 \begin_layout Standard
7634 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.
7635 For the sake of the example,
7636 we'll assume that the style file is called
7637 \begin_inset Flex Noun
7640 \begin_layout Plain Layout
7646 and that it is meant to be used with
7647 \begin_inset Flex Noun
7650 \begin_layout Plain Layout
7657 which is a standard class.
7661 \begin_layout Standard
7662 Start by copying the existing class's layout file into your local directory:
7666 \begin_layout Plain Layout
7668 which directory is your local directory will vary by platform,
7669 and \SpecialChar LyX
7670 allows you to specify your local directory on startup,
7673 \begin_inset Flex Code
7676 \begin_layout Plain Layout
7690 \begin_layout LyX-Code
7691 cp report.layout ~/.lyx/layouts/myclass.layout
7694 \begin_layout Standard
7696 \begin_inset Flex Code
7699 \begin_layout Plain Layout
7705 and change the line:
7709 \begin_layout LyX-Code
7712 DeclareLaTeXClass{Report (Standard Class)}
7715 \begin_layout Standard
7719 \begin_layout LyX-Code
7722 DeclareLaTeXClass[report,
7723 myclass.sty]{Report (My Class)}
7726 \begin_layout Standard
7730 \begin_layout LyX-Code
7732 \begin_inset Newline newline
7738 \begin_inset Newline newline
7744 \begin_layout Standard
7745 near the top of the file.
7748 \begin_layout Standard
7749 Start \SpecialChar LyX
7751 \begin_inset Flex Noun
7754 \begin_layout Plain Layout
7755 Tools\SpecialChar menuseparator
7762 Then restart \SpecialChar LyX
7763 and try creating a new document.
7765 \begin_inset Flex Noun
7768 \begin_layout Plain Layout
7774 " as a document class option in the
7775 \begin_inset Flex Noun
7778 \begin_layout Plain Layout
7779 Document\SpecialChar menuseparator
7786 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—
7788 \begin_inset Flex Code
7791 \begin_layout Plain Layout
7798 so you can fiddle around with the settings for the different sections if you wish.
7799 The layout information for sections is contained in
7800 \begin_inset Flex Code
7803 \begin_layout Plain Layout
7810 but you do not need to copy and change this file.
7812 you can simply add your changes to your layout file,
7814 \begin_inset Flex Code
7817 \begin_layout Plain Layout
7824 which itself includes
7825 \begin_inset Flex Code
7828 \begin_layout Plain Layout
7836 you might add these lines:
7839 \begin_layout LyX-Code
7843 \begin_layout LyX-Code
7847 \begin_layout LyX-Code
7851 \begin_layout LyX-Code
7855 \begin_layout LyX-Code
7859 \begin_layout Standard
7860 to change the font for chapter headings to sans-serif.
7861 This will override (or,
7863 add to) the existing declaration for the Chapter style.
7867 \begin_layout Standard
7868 Your new package may also provide commands or environments not present in the base class.
7870 you will want to add these to the layout file.
7872 \begin_inset CommandInset ref
7874 reference "sec:TextClass"
7879 for information on how to do so.
7882 \begin_layout Standard
7884 \begin_inset Flex Noun
7887 \begin_layout Plain Layout
7893 can be used with several different document classes,
7894 and even if it cannot,
7895 you might find it easiest just to write a module that you can load with the base class.
7896 The simplest possible such module would be:
7899 \begin_layout LyX-Code
7902 DeclareLyXModule{My Class}
7905 \begin_layout LyX-Code
7909 \begin_layout LyX-Code
7910 #Support for myclass.sty.
7913 \begin_layout LyX-Code
7915 \begin_inset Newline newline
7921 \begin_layout LyX-Code
7929 \begin_inset Newline newline
7935 \begin_layout LyX-Code
7937 \begin_inset Newline newline
7943 \begin_inset Newline newline
7949 \begin_layout Standard
7950 A more complex module might modify the behavior of some existing constructs or define some new ones.
7953 \begin_inset CommandInset ref
7955 reference "sec:TextClass"
7963 \begin_layout Subsection
7965 \begin_inset Flex Noun
7968 \begin_layout Plain Layout
7977 \begin_layout Standard
7978 There are two possibilities here.
7979 One is that the class file is itself based upon an existing document class.
7981 many thesis classes are based upon
7982 \begin_inset Flex Noun
7985 \begin_layout Plain Layout
7992 To see whether yours is,
7993 look for a line like
7996 \begin_layout LyX-Code
8002 \begin_layout Standard
8005 then you may proceed largely as in the previous section,
8007 \begin_inset Flex Code
8010 \begin_layout Plain Layout
8011 Declare\SpecialChar LaTeX
8017 line will be different.
8018 If your new class is
8019 \begin_inset Flex Code
8022 \begin_layout Plain Layout
8028 and it is based upon
8029 \begin_inset Flex Code
8032 \begin_layout Plain Layout
8039 then the line should read:
8043 \begin_layout Plain Layout
8044 And it will be easiest if you save the file to
8045 \begin_inset Flex Code
8048 \begin_layout Plain Layout
8056 assumes that the document class has the same name as the layout file.
8065 \begin_layout LyX-Code
8068 DeclareLaTeXClass[thesis,book]{thesis}
8071 \begin_layout Standard
8074 the new class is not based upon an existing class,
8075 you will probably have to
8076 \begin_inset Quotes eld
8080 \begin_inset Quotes erd
8084 We strongly suggest copying an existing layout file which uses a similar \SpecialChar LaTeX
8085 class and then modifying it,
8087 At least use an existing file as a starting point so you can find out what items you need to worry about.
8089 the specifics are covered below.
8092 \begin_layout Subsection
8094 \begin_inset CommandInset label
8096 name "subsec:Creating-Templates"
8103 \begin_layout Standard
8104 Once you have written a layout file for a new document class,
8105 you might want to consider writing a
8111 A template acts as a kind of tutorial for your layout,
8112 showing how it might be used,
8113 though containing dummy content.
8114 You can of course look at the various templates included with \SpecialChar LyX
8118 \begin_layout Standard
8119 Templates are created just like usual documents:
8120 using \SpecialChar LyX
8122 The only difference is that usual documents contain all possible settings,
8123 including the font scheme and the paper size.
8124 Usually a user doesn't want a template to overwrite his preferred settings for such parameters.
8126 the designer of a template should remove the corresponding commands like
8127 \begin_inset Flex Code
8130 \begin_layout Plain Layout
8139 \begin_inset Flex Code
8142 \begin_layout Plain Layout
8150 from the template \SpecialChar LyX
8152 This can be done with any simple text-editor,
8154 \begin_inset Flex Code
8157 \begin_layout Plain Layout
8164 \begin_inset Flex Code
8167 \begin_layout Plain Layout
8176 \begin_layout Standard
8177 Put the edited template files you create in
8178 \begin_inset Flex Code
8181 \begin_layout Plain Layout
8188 copy the ones you use from the global template directory in
8189 \begin_inset Flex Code
8192 \begin_layout Plain Layout
8199 and redefine the template path in the
8200 \begin_inset Flex Noun
8203 \begin_layout Plain Layout
8204 Tools\SpecialChar menuseparator
8205 Preferences\SpecialChar menuseparator
8214 \begin_layout Standard
8217 that there is a template which has a particular meaning:
8218 \begin_inset Newline linebreak
8222 \begin_inset Flex Code
8225 \begin_layout Plain Layout
8232 This template is loaded every time you create a new document with
8233 \begin_inset Flex Noun
8236 \begin_layout Plain Layout
8237 File\SpecialChar menuseparator
8243 in order to provide useful defaults.
8244 To create this template from inside \SpecialChar LyX
8246 all you have to do is to open a document with the correct settings,
8248 \begin_inset Flex Noun
8251 \begin_layout Plain Layout
8252 Save as Document Defaults
8260 \begin_layout Subsection
8261 Upgrading old layout files
8264 \begin_layout Standard
8265 The format of layout files changes with each \SpecialChar LyX
8267 so old layout files need to be converted to the new format.
8269 reads a layout file in an older format,
8270 it automatically calls the script
8271 \begin_inset Flex Code
8274 \begin_layout Plain Layout
8280 to convert it to a temporary file in current format.
8281 The original file is left untouched.
8282 If you use the layout file often,
8284 you may want to convert it permanently,
8285 so that \SpecialChar LyX
8286 does not have to do so itself every time.
8288 you can call the converter manually:
8291 \begin_layout Enumerate
8293 \begin_inset Flex Code
8296 \begin_layout Plain Layout
8303 \begin_inset Flex Code
8306 \begin_layout Plain Layout
8315 \begin_layout Enumerate
8317 \begin_inset Newline newline
8321 \begin_inset Flex Code
8324 \begin_layout Plain Layout
8325 python LyXDir/scripts/layout2layout.py myclass.old myclass.layout
8331 \begin_inset Newline newline
8335 \begin_inset Flex Code
8338 \begin_layout Plain Layout
8344 is the name of your \SpecialChar LyX
8348 \begin_layout Standard
8349 Note that manual conversion does not affect included files,
8350 so these will have to be converted separately.
8353 \begin_layout Subsection
8354 \begin_inset CommandInset label
8356 name "subsec:Cite-Engine-Files"
8363 \begin_layout Standard
8364 A specific form of layout files are the so-called
8365 \begin_inset Flex Code
8368 \begin_layout Plain Layout
8374 files that are located in the
8375 \begin_inset Flex Code
8378 \begin_layout Plain Layout
8385 Their purpose is to define the specifics of \SpecialChar LaTeX
8386 packages aimed at bibliography generation,
8401 but also the way how normal Bib\SpecialChar TeX
8402 citations (without additional packages) are handled in \SpecialChar LyX
8403 is defined in such a file.
8407 \begin_layout Standard
8409 it is defined which packages \SpecialChar LyX
8411 which citation commands are available,
8412 how these are to be displayed in \SpecialChar LyX
8415 the context menus) as well as in the XHTML and plain text output.
8417 the files specify available style variants (author-year,
8419 etc.) and their specifics.
8420 The cite engine files are also used to generate the options that are available in
8422 Document\SpecialChar menuseparator
8423 Settings\SpecialChar menuseparator
8424 Bibliography\SpecialChar menuseparator
8430 \begin_layout Standard
8431 Even though a cite engine file is essentially a normal layout file that could theoretically include any layout information,
8432 it usually primarily includes some specific parameters such as
8433 \begin_inset Flex Code
8436 \begin_layout Plain Layout
8444 \begin_inset Flex Code
8447 \begin_layout Plain Layout
8455 \begin_inset Flex Code
8458 \begin_layout Plain Layout
8465 \begin_inset Flex Code
8468 \begin_layout Plain Layout
8475 The syntax of the latter two is described in
8476 \begin_inset CommandInset ref
8478 reference "subsec:Citation-engine-description"
8487 \begin_inset CommandInset ref
8489 reference "subsec:Citation-format-description"
8495 as well as in the files themselves.
8498 \begin_layout Section
8499 \begin_inset CommandInset label
8501 name "sec:TextClass"
8505 The layout file format
8508 \begin_layout Standard
8509 The following sections describe how layout files are structured and written.
8510 Our advice is to go slowly,
8511 save and test often.
8512 It is really not that hard,
8513 except that the multitude of options can become overwhelming,
8514 especially if you try to check out too many at once.
8515 It becomes easier if you use existing layouts of \SpecialChar LyX
8516 as examples/reference or if you modify an existing layout to your needs.
8519 \begin_layout Standard
8520 Note that all the tags used in layout files are case-insensitive.
8522 \begin_inset Flex Code
8525 \begin_layout Plain Layout
8533 \begin_inset Flex Code
8536 \begin_layout Plain Layout
8543 \begin_inset Flex Code
8546 \begin_layout Plain Layout
8552 are really the same tag.
8553 The possible arguments are printed in brackets after the tag's name.
8554 The default argument is typeset
8555 \begin_inset Flex Code
8558 \begin_layout Plain Layout
8567 If the argument has a data type like
8568 \begin_inset Quotes eld
8572 \begin_inset Quotes erd
8576 \begin_inset Quotes eld
8580 \begin_inset Quotes erd
8584 the default is shown like this:
8586 \begin_inset Flex Code
8589 \begin_layout Plain Layout
8600 \begin_layout Subsection
8601 The document class declaration and classification
8604 \begin_layout Standard
8605 Lines in a layout file which begin with
8606 \begin_inset Flex Code
8609 \begin_layout Plain Layout
8616 There is one exception to this rule.
8618 \begin_inset Flex Code
8621 \begin_layout Plain Layout
8627 files should begin with lines like:
8630 \begin_layout LyX-Code
8633 #% Do not delete the line below;
8634 configure depends on this
8637 \begin_layout LyX-Code
8642 DeclareLaTeXClass{Article (Standard Class)}
8645 \begin_layout LyX-Code
8650 DeclareCategory{Articles}
8653 \begin_layout Standard
8654 The second and third lines are used when you (re)configure \SpecialChar LyX
8656 The layout file is read by the \SpecialChar LaTeX
8658 \begin_inset Flex Code
8661 \begin_layout Plain Layout
8668 in a special mode where
8669 \begin_inset Flex Code
8672 \begin_layout Plain Layout
8679 The first line is just a \SpecialChar LaTeX
8681 the second one contains the mandatory declaration of the text class and the third line contains the optional classification of the class.
8682 If these lines appear in a file named
8683 \begin_inset Flex Code
8686 \begin_layout Plain Layout
8693 then they define a text class of name
8694 \begin_inset Flex Code
8697 \begin_layout Plain Layout
8703 (the name of the layout file) which uses the \SpecialChar LaTeX
8705 \begin_inset Flex Code
8708 \begin_layout Plain Layout
8714 (the default is to use the same name as the layout).
8716 \begin_inset Quotes eld
8719 Article (Standard Class)
8720 \begin_inset Quotes erd
8723 that appears above is used as a description of the text class in the
8724 \begin_inset Flex Noun
8727 \begin_layout Plain Layout
8728 Document\SpecialChar menuseparator
8736 \begin_inset Quotes eld
8740 \begin_inset Quotes erd
8743 in the example) is also used in the
8744 \begin_inset Flex Noun
8747 \begin_layout Plain Layout
8748 Document\SpecialChar menuseparator
8755 the text classes are grouped by these categories (which are usually genres,
8756 so typical categories are
8757 \begin_inset Quotes eld
8761 \begin_inset Quotes erd
8766 \begin_inset Quotes eld
8770 \begin_inset Quotes erd
8775 \begin_inset Quotes eld
8779 \begin_inset Quotes erd
8784 \begin_inset Quotes eld
8788 \begin_inset Quotes erd
8793 \begin_inset Quotes eld
8797 \begin_inset Quotes erd
8802 \begin_inset Quotes eld
8806 \begin_inset Quotes erd
8810 If no category has been declared,
8811 the class will be put in the
8812 \begin_inset Quotes eld
8816 \begin_inset Quotes erd
8822 \begin_layout Standard
8823 Let's assume that you wrote your own text class that uses the
8824 \begin_inset Flex Code
8827 \begin_layout Plain Layout
8834 but where you changed the appearance of the section headings.
8835 If you put it in a file
8836 \begin_inset Flex Code
8839 \begin_layout Plain Layout
8846 the header of this file should be:
8849 \begin_layout LyX-Code
8852 #% Do not delete the line below;
8853 configure depends on this
8856 \begin_layout LyX-Code
8861 DeclareLaTeXClass[article]{Article (with My Own Headings)}
8864 \begin_layout LyX-Code
8869 DeclareCategory{Articles}
8872 \begin_layout Standard
8873 This declares a text class
8874 \begin_inset Flex Code
8877 \begin_layout Plain Layout
8884 associated with the \SpecialChar LaTeX
8886 \begin_inset Flex Code
8889 \begin_layout Plain Layout
8896 \begin_inset Quotes eld
8899 Article (with My Own Headings)
8900 \begin_inset Quotes erd
8904 If your text class depends on several packages,
8905 you can declare it as:
8908 \begin_layout LyX-Code
8911 #% Do not delete the line below;
8912 configure depends on this
8915 \begin_layout LyX-Code
8920 DeclareLaTeXClass[article,foo.sty]{Article (with My Own Headings)}
8923 \begin_layout LyX-Code
8928 DeclareCategory{Articles}
8931 \begin_layout Standard
8932 This indicates that your text class uses the
8933 \begin_inset Flex Code
8936 \begin_layout Plain Layout
8944 \change_deleted 5863208 1594239179
8946 it is also possible to declare classes for DocBook code.
8947 Typical declarations will look like:
8950 \begin_layout LyX-Code
8952 \change_deleted 5863208 1594239179
8955 #% Do not delete the line below;
8956 configure depends on this
8959 \begin_layout LyX-Code
8961 \change_deleted 5863208 1594239179
8966 DeclareDocBookClass[article]{SGML (DocBook Article)}
8969 \begin_layout LyX-Code
8971 \change_deleted 5863208 1594239179
8976 DeclareCategory{Articles (DocBook)}
8981 \begin_layout Standard
8982 Note that these declarations can also be given an optional parameter declaring the name of the document class (but not a list).
8985 \begin_layout Standard
8987 to be as explicit as possible,
8988 the form of the layout declaration is:
8991 \begin_layout LyX-Code
8996 DeclareLaTeXClass[class,package.sty]{layout description}
8999 \begin_layout LyX-Code
9004 DeclareCategory{category}
9007 \begin_layout Standard
9008 The class need only be specified if the name of the \SpecialChar LaTeX
9009 class file and the name of the layout file are different or if there are packages to load.
9010 If the name of the class file is not specified,
9011 then \SpecialChar LyX
9012 will simply assume that it is the same as the name of the layout file.
9015 \begin_layout Standard
9016 When the text class has been modified to your taste,
9017 all you have to do is to copy it either to
9018 \begin_inset Flex Code
9021 \begin_layout Plain Layout
9028 \begin_inset Flex Code
9031 \begin_layout Plain Layout
9039 \begin_inset Flex Noun
9042 \begin_layout Plain Layout
9043 Tools\SpecialChar menuseparator
9050 exit \SpecialChar LyX
9052 Then your new text class should be available along with the others.
9055 \begin_layout Standard
9056 Once the layout file is installed,
9057 you can edit it and see your changes without having to reconfigure or to restart \SpecialChar LyX
9062 \begin_layout Plain Layout
9063 In versions of \SpecialChar LyX
9067 editing layout files was very time consuming,
9068 since you had constantly to restart \SpecialChar LyX
9074 You can force a reload of the current layout by using the \SpecialChar LyX
9076 \begin_inset Flex Noun
9079 \begin_layout Plain Layout
9086 There is no default binding for this function—
9089 you can bind it to a key yourself.
9090 But you will normally use this function simply by entering it in the mini-buffer.
9094 \begin_layout Standard
9101 \begin_inset Flex Noun
9104 \begin_layout Plain Layout
9110 is very much an `advanced feature'.
9115 recommended that you save your work before using this function.
9121 recommended that you not attempt to edit layout information while simultaneously working on a document that you care about.
9122 Use a test document.
9123 Syntax errors and the like in your layout file could cause peculiar behavior.
9125 such errors could cause \SpecialChar LyX
9126 to regard the current layout as invalid and to attempt to switch to some other layout.
9130 \begin_layout Plain Layout
9131 Really bad syntax errors may even caused \SpecialChar LyX
9133 This is because certain sorts of errors may make \SpecialChar LyX
9144 The \SpecialChar LyX
9145 team strives to keep \SpecialChar LyX
9146 stable in such situations,
9147 but safe is better than sorry.
9151 \begin_layout Plain Layout
9152 While we're giving advice:
9153 make regular backups.
9154 And be nice to your mother.
9162 \begin_layout Subsection
9163 The Module declaration
9166 \begin_layout Standard
9167 A module must begin with a line like the following:
9170 \begin_layout LyX-Code
9173 DeclareLyXModule[endnotes.sty]{Endnotes}
9174 \change_inserted -712698321 1554395911
9178 \begin_layout LyX-Code
9180 \change_inserted -712698321 1554395924
9185 DeclareCategory{Foot- and Endnotes}
9186 \change_deleted -712698321 1554395911
9194 \begin_layout Standard
9195 The mandatory argument
9196 \change_inserted -712698321 1554395956
9207 is the name of the module,
9208 as it should appear in
9209 \begin_inset Flex Noun
9212 \begin_layout Plain Layout
9213 Document\SpecialChar menuseparator
9214 Settings\SpecialChar menuseparator
9221 The argument in square brackets is optional:
9222 It declares any \SpecialChar LaTeX
9223 packages on which the module depends.
9224 It is also possible to use the form
9225 \begin_inset Flex Noun
9228 \begin_layout Plain Layout
9234 as an optional argument,
9235 which declares that the module can only be used when there exists a conversion chain between the formats `
9236 \begin_inset Flex Code
9239 \begin_layout Plain Layout
9246 \begin_inset Flex Code
9249 \begin_layout Plain Layout
9257 \change_inserted -712698321 1554396133
9264 declaration is not strictly mandatory,
9265 but you should add it,
9266 since it is helpful to find the module.
9267 Please have a look at the existing module categories and if appropriate,
9273 \begin_layout Standard
9275 \change_inserted -712698321 1554395988
9278 declaration should then be followed by lines like the following:
9282 \begin_layout Plain Layout
9283 Preferably in English if the module should be published with \SpecialChar LyX
9285 This description will appear in the list of messages to be translated and will be thus translated with the next interface update.
9293 \begin_layout LyX-Code
9297 \begin_layout LyX-Code
9298 #Adds an endnote command,
9299 in addition to footnotes.
9303 \begin_layout LyX-Code
9304 #You will need to add
9306 theendnotes in TeX code where you
9309 \begin_layout LyX-Code
9310 #want the endnotes to appear.
9314 \begin_layout LyX-Code
9318 \begin_layout LyX-Code
9320 somemodule | othermodule
9323 \begin_layout LyX-Code
9328 \begin_layout Standard
9329 The description is used in
9330 \begin_inset Flex Noun
9333 \begin_layout Plain Layout
9334 Document\SpecialChar menuseparator
9335 Settings\SpecialChar menuseparator
9341 to provide the user with information about what the module does.
9343 \begin_inset Flex Code
9346 \begin_layout Plain Layout
9352 line is used to identify other modules with which this one must be used;
9354 \begin_inset Flex Code
9357 \begin_layout Plain Layout
9363 line is used to identify modules with which this one may not be used.
9367 multiple modules should be separated with the pipe symbol:
9369 Note that the required modules are treated disjunctively:
9374 of the required modules must be used.
9380 excluded module may be used.
9381 Note that modules are identified here by their filenames without the
9382 \begin_inset Flex Code
9385 \begin_layout Plain Layout
9393 \begin_inset Flex Code
9396 \begin_layout Plain Layout
9403 \begin_inset Flex Code
9406 \begin_layout Plain Layout
9415 \begin_layout Subsection
9416 The CiteEngine file declaration
9419 \begin_layout Standard
9420 A cite engine file must begin with a line like the following:
9423 \begin_layout LyX-Code
9426 DeclareLyXCiteEngineModule[biblatex.sty]{Biblatex}
9429 \begin_layout Standard
9430 The mandatory argument,
9432 is the name of the cite style,
9433 as it should appear in
9434 \begin_inset Flex Noun
9437 \begin_layout Plain Layout
9438 Document\SpecialChar menuseparator
9439 Settings\SpecialChar menuseparator
9446 The argument in square brackets is optional:
9447 It declares any \SpecialChar LaTeX
9448 packages on which the cite engine depends.
9451 \begin_layout Standard
9452 The cite engine declaration should then be followed by lines like the following:
9456 \begin_layout Plain Layout
9457 Preferably in English if the module should be published with \SpecialChar LyX
9459 This description will appear in the list of messages to be translated and will be thus translated with the next interface update.
9467 \begin_layout LyX-Code
9471 \begin_layout LyX-Code
9472 # Biblatex supports many author-year and numerical styles.
9475 \begin_layout LyX-Code
9476 # It is mainly aimed at the Humanities.
9480 \begin_layout LyX-Code
9482 fully localized and provides many features
9485 \begin_layout LyX-Code
9486 # that are not possible with BibTeX.
9487 The use of 'biber' as
9490 \begin_layout LyX-Code
9491 # bibliography processor is advised.
9494 \begin_layout LyX-Code
9498 \begin_layout Standard
9499 The description is used in
9500 \begin_inset Flex Noun
9503 \begin_layout Plain Layout
9504 Document\SpecialChar menuseparator
9505 Settings\SpecialChar menuseparator
9511 to provide the user with information about the cite engine.
9514 \begin_layout Subsection
9518 \begin_layout Standard
9519 The first non-comment line of any layout file,
9525 contain the file format number:
9528 \begin_layout Description
9529 \begin_inset Flex Code
9532 \begin_layout Plain Layout
9539 \begin_inset Flex Code
9542 \begin_layout Plain Layout
9548 ] The format number of the layout file.
9551 \begin_layout Standard
9552 This tag was introduced with \SpecialChar LyX
9554 \begin_inset space ~
9558 Layout files from older \SpecialChar LyX
9559 versions do not have an explicit file format and are considered to have
9560 \begin_inset Flex Code
9563 \begin_layout Plain Layout
9565 \begin_inset space ~
9574 The format for the present version of \SpecialChar LyX
9576 But each version of \SpecialChar LyX
9577 is capable of reading earlier versions' layout files,
9578 just as they are capable of reading files produced by earlier versions of \SpecialChar LyX
9582 no provision for converting to earlier formats.
9585 \begin_layout Subsection
9586 \begin_inset CommandInset label
9588 name "subsec:General-text-class"
9592 General text class parameters
9595 \begin_layout Standard
9596 These are general parameters that govern the behavior of an entire document class.
9601 mean that they must appear in
9602 \begin_inset Flex Code
9605 \begin_layout Plain Layout
9611 files rather than in modules.
9612 A module can contain any layout tag.)
9615 \begin_layout Description
9617 \change_inserted -712698321 1526899478
9618 \begin_inset Flex Code
9621 \begin_layout Plain Layout
9623 \change_inserted -712698321 1526898610
9624 AddToCiteEngine <engine>
9631 Extends the possibilities for displaying citation references.
9633 \begin_inset CommandInset ref
9635 reference "subsec:Citation-engine-description"
9645 \begin_inset Flex Code
9648 \begin_layout Plain Layout
9650 \change_inserted -712698321 1526898823
9661 \begin_layout Description
9662 \begin_inset Flex Code
9665 \begin_layout Plain Layout
9671 Adds information that will be output in the
9672 \begin_inset Flex Code
9675 \begin_layout Plain Layout
9681 block when the document is output to XHTML.
9683 this would be used to output CSS style information,
9684 but it can be used for anything that can appear in
9685 \begin_inset Flex Code
9688 \begin_layout Plain Layout
9696 \begin_inset Quotes eld
9700 \begin_inset Flex Code
9703 \begin_layout Plain Layout
9710 \begin_inset Quotes erd
9716 \begin_layout Description
9717 \begin_inset Flex Code
9720 \begin_layout Plain Layout
9726 Adds information to the document preamble.
9728 \begin_inset Newline newline
9732 \begin_inset Quotes eld
9736 \begin_inset Flex Code
9739 \begin_layout Plain Layout
9746 \begin_inset Quotes erd
9750 \change_inserted -712698321 1562592950
9754 \begin_layout Description
9756 \change_inserted -712698321 1562593040
9757 \begin_inset Flex Code
9760 \begin_layout Plain Layout
9762 \change_inserted -712698321 1562592954
9771 \begin_inset Flex Code
9774 \begin_layout Plain Layout
9776 \change_inserted -712698321 1562592950
9787 \begin_inset space \thinspace{}
9791 \begin_inset Flex Code
9794 \begin_layout Plain Layout
9796 \change_inserted -712698321 1562592950
9804 ] If the document class adds the bibliography to the table of contents,
9805 add this option with value
9806 \begin_inset Flex Code
9809 \begin_layout Plain Layout
9811 \change_inserted -712698321 1562592996
9820 \begin_inset Flex Code
9823 \begin_layout Plain Layout
9825 \change_inserted -712698321 1562593006
9834 This prevents the bibliography from being added twice.
9839 \begin_layout Description
9840 \begin_inset Flex Code
9843 \begin_layout Plain Layout
9849 Defines the possibilities for displaying citation references.
9851 \begin_inset CommandInset ref
9853 reference "subsec:Citation-engine-description"
9863 \begin_inset Quotes eld
9867 \begin_inset Flex Code
9870 \begin_layout Plain Layout
9877 \begin_inset Quotes erd
9881 Primarily used in cite engine files (see
9882 \begin_inset CommandInset ref
9884 reference "subsec:Cite-Engine-Files"
9894 \change_inserted -712698321 1526898530
9895 Note that if you specify this in a layout file or module,
9896 any cite engine definition will be overridden.
9898 \begin_inset Flex Code
9901 \begin_layout Plain Layout
9903 \change_inserted -712698321 1526898530
9916 \begin_layout Description
9917 \begin_inset Flex Code
9920 \begin_layout Plain Layout
9926 Defines formats for use in the display of bibliographic information.
9928 \begin_inset CommandInset ref
9930 reference "subsec:Citation-format-description"
9937 \begin_inset Quotes eld
9941 \begin_inset Flex Code
9944 \begin_layout Plain Layout
9951 \begin_inset Quotes erd
9955 Primarily used in cite engine files (see
9956 \begin_inset CommandInset ref
9958 reference "subsec:Cite-Engine-Files"
9968 \change_inserted -712698321 1526898585
9969 A cite format defined in a layout or module will override the cite engine definition.
9974 \begin_layout Description
9975 \begin_inset Flex Code
9978 \begin_layout Plain Layout
9985 \begin_inset Flex Code
9988 \begin_layout Plain Layout
9997 \begin_inset Flex Code
10000 \begin_layout Plain Layout
10006 ] Determines whether
10010 or Bib\SpecialChar TeX
10011 is used to generate a Bibliography.
10012 Primarily used in cite engine files (see
10013 \begin_inset CommandInset ref
10015 reference "subsec:Cite-Engine-Files"
10026 \begin_layout Description
10027 \begin_inset Flex Code
10030 \begin_layout Plain Layout
10036 Describes various global options supported by the document class.
10038 \begin_inset CommandInset ref
10040 reference "subsec:ClassOptions"
10047 \begin_inset Quotes eld
10051 \begin_inset Flex Code
10054 \begin_layout Plain Layout
10061 \begin_inset Quotes erd
10067 \begin_layout Description
10068 \begin_inset Flex Code
10071 \begin_layout Plain Layout
10078 \begin_inset Flex Code
10081 \begin_layout Plain Layout
10090 \begin_inset space \thinspace{}
10094 \begin_inset Flex Code
10097 \begin_layout Plain Layout
10103 ] Whether the class should
10107 to having one or two columns.
10108 Can be changed in the
10109 \begin_inset Flex Noun
10112 \begin_layout Plain Layout
10113 Document\SpecialChar menuseparator
10122 \begin_layout Description
10123 \begin_inset Flex Code
10126 \begin_layout Plain Layout
10133 \begin_inset Flex Code
10136 \begin_layout Plain Layout
10142 ] This sequence defines the properties for a counter.
10143 If the counter does not yet exist,
10148 \begin_inset Quotes eld
10152 \begin_inset Flex Code
10155 \begin_layout Plain Layout
10162 \begin_inset Quotes erd
10166 \begin_inset Newline newline
10170 \begin_inset CommandInset ref
10172 reference "subsec:Counters"
10177 for details on counters.
10180 \begin_layout Description
10181 \begin_inset Flex Code
10184 \begin_layout Plain Layout
10190 Sets the default font used to display the document.
10192 \begin_inset CommandInset ref
10194 reference "subsec:Font-description"
10199 for how to declare fonts.
10201 \begin_inset Quotes eld
10205 \begin_inset Flex Code
10208 \begin_layout Plain Layout
10215 \begin_inset Quotes erd
10221 \begin_layout Description
10222 \begin_inset Flex Code
10225 \begin_layout Plain Layout
10232 \begin_inset Flex Code
10235 \begin_layout Plain Layout
10241 ] Specifies a module to be included by default with this document class.
10242 The module is specified as filename without the
10243 \begin_inset Flex Code
10246 \begin_layout Plain Layout
10253 The user can still remove the module,
10254 but it will be active at the outset.
10255 (This applies only when new files are created,
10256 or when this class is chosen for an existing document.)
10259 \begin_layout Description
10260 \begin_inset Flex Code
10263 \begin_layout Plain Layout
10270 \begin_inset Flex Code
10273 \begin_layout Plain Layout
10279 ] This is the style that will be assigned to new paragraphs,
10281 \begin_inset Flex Noun
10284 \begin_layout Plain Layout
10291 This will default to the first defined style if not given,
10292 but you are encouraged to use this directive.
10295 \begin_layout Description
10297 \change_inserted -970929547 1515112870
10298 \begin_inset Flex Code
10301 \begin_layout Plain Layout
10303 \change_inserted -970929547 1515112782
10312 \begin_inset Flex Code
10315 \begin_layout Plain Layout
10317 \change_inserted -970929547 1515112766
10325 ] The root element (at the top of the document) to use when outputting documents with this class in DocBook.
10326 The default value is
10327 \begin_inset Quotes eld
10331 \begin_inset Flex Code
10334 \begin_layout Plain Layout
10336 \change_inserted -970929547 1515112845
10345 \begin_inset Quotes erd
10350 \change_deleted 1075283030 1594226862
10352 \change_inserted 1075283030 1594226777
10356 \begin_layout Description
10358 \change_inserted 1075283030 1594226859
10359 \begin_inset Flex Code
10362 \begin_layout Plain Layout
10364 \change_inserted 1075283030 1594226785
10365 DocBookForceAbstract
10373 \begin_inset Flex Code
10376 \begin_layout Plain Layout
10378 \change_inserted 1075283030 1594226804
10387 \begin_inset Quotes eld
10395 \begin_inset Quotes erd
10399 the root element will always have an
10404 The default value is
10405 \begin_inset Quotes eld
10413 \begin_inset Quotes erd
10421 \begin_layout Description
10422 \begin_inset Flex Code
10425 \begin_layout Plain Layout
10432 \begin_inset Flex Code
10435 \begin_layout Plain Layout
10441 ] This tag indicates that the module (which is specified by filename without the
10442 \begin_inset Flex Code
10445 \begin_layout Plain Layout
10451 extension) cannot be used with this document class.
10452 This might be used in a journal-specific layout file to prevent,
10455 \begin_inset Flex Code
10458 \begin_layout Plain Layout
10464 module that numbers theorems by section.
10469 be used in a module.
10470 Modules have their own way of excluding other modules (see
10471 \begin_inset CommandInset ref
10473 reference "subsec:Layout-modules"
10481 \begin_layout Description
10482 \begin_inset Flex Code
10485 \begin_layout Plain Layout
10491 Defines a new float.
10493 \begin_inset CommandInset ref
10495 reference "subsec:Floats"
10502 \begin_inset Quotes eld
10506 \begin_inset Flex Code
10509 \begin_layout Plain Layout
10516 \begin_inset Quotes erd
10522 \begin_layout Description
10523 \begin_inset Flex Code
10526 \begin_layout Plain Layout
10532 Sets the information that will be output in the
10533 \begin_inset Flex Code
10536 \begin_layout Plain Layout
10542 block when this document class is output to XHTML.
10543 Note that this will completely override any prior
10544 \begin_inset Flex Code
10547 \begin_layout Plain Layout
10554 \begin_inset Flex Code
10557 \begin_layout Plain Layout
10565 \begin_inset Newline newline
10569 \begin_inset Flex Code
10572 \begin_layout Plain Layout
10578 if you just want to add material to the preamble.) Must end with
10579 \begin_inset Quotes eld
10583 \begin_inset Flex Code
10586 \begin_layout Plain Layout
10593 \begin_inset Quotes erd
10599 \begin_layout Description
10600 \begin_inset Flex Code
10603 \begin_layout Plain Layout
10610 \begin_inset Flex Code
10613 \begin_layout Plain Layout
10619 ] The style to use for the table of contents,
10622 when the document is output to HTML.
10624 this should normally be
10625 \begin_inset Flex Code
10628 \begin_layout Plain Layout
10636 \begin_inset Flex Code
10639 \begin_layout Plain Layout
10646 If it is not given,
10647 then \SpecialChar LyX
10648 will attempt to figure out which layout to use.
10651 \begin_layout Description
10652 \begin_inset Flex Code
10655 \begin_layout Plain Layout
10662 \begin_inset Flex Code
10665 \begin_layout Plain Layout
10671 ] Modifies the properties of the given counter.
10672 If the counter does not exist,
10673 the statement is ignored.
10675 \begin_inset Quotes eld
10679 \begin_inset Flex Code
10682 \begin_layout Plain Layout
10689 \begin_inset Quotes erd
10693 \begin_inset Newline newline
10697 \begin_inset CommandInset ref
10699 reference "subsec:Counters"
10704 for details on counters.
10707 \begin_layout Description
10708 \begin_inset Flex Code
10711 \begin_layout Plain Layout
10718 \begin_inset Flex Code
10721 \begin_layout Plain Layout
10727 ] This allows you to include another layout definition file within yours to avoid duplicating commands.
10728 Common examples are the standard layout files,
10731 \begin_inset Flex Code
10734 \begin_layout Plain Layout
10741 which contains most of the basic layouts.
10742 \change_inserted -712698321 1611646803
10746 \begin_layout Description
10748 \change_inserted -712698321 1611646804
10749 \begin_inset Flex Code
10752 \begin_layout Plain Layout
10754 \change_inserted -712698321 1611646837
10763 \begin_inset Flex Code
10766 \begin_layout Plain Layout
10768 \change_inserted -712698321 1611646804
10776 ] is a variant of the
10777 \begin_inset Flex Code
10780 \begin_layout Plain Layout
10782 \change_inserted -712698321 1611646804
10790 command which does not look for files in the user directory.
10791 This allows to create a file
10792 \begin_inset Flex Code
10795 \begin_layout Plain Layout
10797 \change_inserted -712698321 1611646804
10806 \begin_inset Flex Code
10809 \begin_layout Plain Layout
10811 \change_inserted -712698321 1611646804
10819 in the user directory which includes a global file with the same name via
10820 \begin_inset Flex Code
10823 \begin_layout Plain Layout
10825 \change_inserted -712698321 1611646853
10834 \begin_inset Flex Code
10837 \begin_layout Plain Layout
10839 \change_inserted -712698321 1611646855
10840 InputGlobal name.inc
10849 \begin_inset Flex Code
10852 \begin_layout Plain Layout
10854 \change_inserted -712698321 1611646804
10863 the file would recursively include itself).
10865 you can modify global files without having to completely copy them.
10870 \begin_layout Description
10871 \begin_inset Flex Code
10874 \begin_layout Plain Layout
10881 \begin_inset Flex Code
10884 \begin_layout Plain Layout
10890 ] This section (re-)defines the layout of an inset.
10891 It can be applied to an existing inset or to a new,
10892 user-defined inset,
10894 a new character style.
10896 \begin_inset Quotes eld
10900 \begin_inset Flex Code
10903 \begin_layout Plain Layout
10910 \begin_inset Quotes erd
10914 \begin_inset Newline newline
10918 \begin_inset CommandInset ref
10920 reference "subsec:Flex-insets-and"
10925 for more information.
10929 \begin_layout Description
10930 \begin_inset Flex Code
10933 \begin_layout Plain Layout
10940 \begin_inset Flex Code
10943 \begin_layout Plain Layout
10949 ] A string that indicates the width of the left margin on the screen,
10952 \begin_inset Quotes eld
10956 \begin_inset Flex Code
10959 \begin_layout Plain Layout
10966 \begin_inset Quotes erd
10970 (Note that this is not a `length',
10972 \begin_inset Quotes eld
10976 \begin_inset Quotes erd
10982 \begin_layout Description
10983 \begin_inset Flex Code
10986 \begin_layout Plain Layout
10993 \begin_inset Flex Code
10996 \begin_layout Plain Layout
11002 ] An integer that determines the maximal number of names displayed in an author-year citation before the citation switches to
11003 \begin_inset Quotes eld
11007 \begin_inset Quotes erd
11011 Primarily used in cite engine files (see
11012 \begin_inset CommandInset ref
11014 reference "subsec:Cite-Engine-Files"
11025 \begin_layout Description
11027 \change_inserted -712698321 1612018485
11028 \begin_inset Flex Code
11031 \begin_layout Plain Layout
11033 \change_inserted -712698321 1612018457
11042 \begin_inset Flex Code
11045 \begin_layout Plain Layout
11047 \change_inserted -712698321 1612018466
11055 ] Modifies the layout of an inset.
11056 If the layout does not exist,
11057 this section is ignored.
11059 \begin_inset Quotes eld
11063 \begin_inset Flex Code
11066 \begin_layout Plain Layout
11068 \change_inserted -712698321 1612018452
11077 \begin_inset Quotes erd
11083 \begin_layout Description
11084 \begin_inset Flex Code
11087 \begin_layout Plain Layout
11094 \begin_inset Flex Code
11097 \begin_layout Plain Layout
11103 ] Modifies the properties of the given paragraph style.
11104 If the style does not exist,
11105 this section is ignored.
11107 \begin_inset Quotes eld
11111 \begin_inset Flex Code
11114 \begin_layout Plain Layout
11121 \begin_inset Quotes erd
11127 \begin_layout Description
11128 \begin_inset Flex Code
11131 \begin_layout Plain Layout
11138 \begin_inset Flex Code
11141 \begin_layout Plain Layout
11147 ] Deletes an existing counter,
11148 usually one defined in an included file.
11151 \begin_layout Description
11152 \begin_inset Flex Code
11155 \begin_layout Plain Layout
11162 \begin_inset Flex Code
11165 \begin_layout Plain Layout
11171 ] Deletes an existing float.
11172 This is particularly useful when you want to suppress a float that has been defined in an input file.
11175 \begin_layout Description
11176 \begin_inset Flex Code
11179 \begin_layout Plain Layout
11186 \begin_inset Flex Code
11189 \begin_layout Plain Layout
11195 ] Deletes an existing style.
11198 \begin_layout Description
11199 \begin_inset Flex Code
11202 \begin_layout Plain Layout
11209 \begin_inset Flex Code
11212 \begin_layout Plain Layout
11219 \begin_inset Flex Code
11222 \begin_layout Plain Layout
11228 ] Define a new table of contents with type
11229 \begin_inset Flex Code
11232 \begin_layout Plain Layout
11239 \begin_inset Flex Code
11242 \begin_layout Plain Layout
11249 See also the AddToToc commands.
11252 \begin_layout Description
11253 \begin_inset Flex Code
11256 \begin_layout Plain Layout
11263 \begin_inset Flex Code
11266 \begin_layout Plain Layout
11272 ] The file format (as defined in the \SpecialChar LyX
11273 preferences) produced by this document class.
11274 It is mainly useful when
11275 \begin_inset Flex Code
11278 \begin_layout Plain Layout
11285 \begin_inset Flex Code
11288 \begin_layout Plain Layout
11294 and one wants to define a new type of literate document.
11295 The format is reset to
11296 \change_deleted 5863208 1594239413
11298 \begin_inset Quotes eld
11302 \begin_inset Flex Code
11305 \begin_layout Plain Layout
11312 \begin_inset Quotes erd
11318 \begin_inset Quotes eld
11322 \begin_inset Flex Code
11325 \begin_layout Plain Layout
11332 \begin_inset Quotes erd
11335 when the corresponding
11336 \begin_inset Flex Code
11339 \begin_layout Plain Layout
11345 parameter is encountered.
11348 \begin_layout Description
11349 \begin_inset Flex Code
11352 \begin_layout Plain Layout
11359 \begin_inset Flex Code
11362 \begin_layout Plain Layout
11374 \change_deleted 5863208 1594239430
11376 \begin_inset Flex Code
11379 \begin_layout Plain Layout
11389 \begin_inset Flex Code
11392 \begin_layout Plain Layout
11398 ] Specifies what sort of output documents using this class will produce.
11401 \begin_layout Description
11402 \begin_inset Flex Code
11405 \begin_layout Plain Layout
11412 \begin_inset Flex Code
11415 \begin_layout Plain Layout
11422 \begin_inset Flex Code
11425 \begin_layout Plain Layout
11431 ] Specifies options,
11432 given in the second string,
11433 for the package named by the first string.
11436 \begin_inset Quotes eld
11440 \begin_inset Flex Code
11443 \begin_layout Plain Layout
11444 PackageOptions natbib square
11450 \begin_inset Quotes erd
11454 \begin_inset Flex Code
11457 \begin_layout Plain Layout
11463 to be loaded with the
11464 \begin_inset Flex Code
11467 \begin_layout Plain Layout
11474 (For \SpecialChar TeX
11476 this causes \SpecialChar LyX
11479 \begin_inset Flex Code
11482 \begin_layout Plain Layout
11485 PassOptionsToPackage{natbib}{square}
11491 \begin_inset Flex Code
11494 \begin_layout Plain Layout
11501 \change_inserted -712698321 1565102364
11505 \begin_layout Description
11507 \change_inserted -712698321 1565102470
11508 \begin_inset Flex Code
11511 \begin_layout Plain Layout
11513 \change_inserted -712698321 1565102365
11522 \begin_inset Flex Code
11525 \begin_layout Plain Layout
11527 \change_inserted -712698321 1565105222
11570 ] The default page size.
11571 This is used by some converters.
11576 \begin_layout Description
11577 \begin_inset Flex Code
11580 \begin_layout Plain Layout
11587 \begin_inset Flex Code
11590 \begin_layout Plain Layout
11600 \begin_inset Flex Code
11603 \begin_layout Plain Layout
11611 \begin_inset Flex Code
11614 \begin_layout Plain Layout
11620 ] The default pagestyle.
11621 Can be changed in the
11622 \begin_inset Flex Noun
11625 \begin_layout Plain Layout
11626 Document\SpecialChar menuseparator
11635 \begin_layout Description
11636 \begin_inset Flex Code
11639 \begin_layout Plain Layout
11645 Sets the preamble for the \SpecialChar LaTeX
11647 Note that this will completely override any prior
11648 \begin_inset Flex Code
11651 \begin_layout Plain Layout
11658 \begin_inset Flex Code
11661 \begin_layout Plain Layout
11669 \begin_inset Flex Code
11672 \begin_layout Plain Layout
11678 if you just want to add material to the preamble.) Must end with
11679 \begin_inset Quotes eld
11683 \begin_inset Flex Code
11686 \begin_layout Plain Layout
11693 \begin_inset Quotes erd
11697 \change_inserted -712698321 1612018500
11701 \begin_layout Description
11703 \change_inserted -712698321 1612018547
11704 \begin_inset Flex Code
11707 \begin_layout Plain Layout
11709 \change_inserted -712698321 1612018506
11718 \begin_inset Flex Code
11721 \begin_layout Plain Layout
11723 \change_inserted -712698321 1612018509
11731 ] Defines the layout of an inset if it does not already exist.
11732 If the layout does exist,
11733 this section is ignored.
11735 \begin_inset Quotes eld
11739 \begin_inset Flex Code
11742 \begin_layout Plain Layout
11744 \change_inserted -712698321 1612018500
11753 \begin_inset Quotes erd
11761 \begin_layout Description
11762 \begin_inset Flex Code
11765 \begin_layout Plain Layout
11772 \begin_inset Flex Code
11775 \begin_layout Plain Layout
11782 \begin_inset Flex Code
11785 \begin_layout Plain Layout
11794 \begin_inset space \thinspace{}
11798 \begin_inset Flex Code
11801 \begin_layout Plain Layout
11807 ] Whether the class already provides the feature
11808 \begin_inset Flex Code
11811 \begin_layout Plain Layout
11818 A feature is in general the name of a package (e.
11819 \begin_inset space \thinspace{}
11823 \begin_inset space \space{}
11827 \begin_inset Flex Code
11830 \begin_layout Plain Layout
11837 \begin_inset Flex Code
11840 \begin_layout Plain Layout
11847 \begin_inset space \thinspace{}
11851 \begin_inset space \space{}
11855 \begin_inset Flex Code
11858 \begin_layout Plain Layout
11865 \begin_inset Flex Code
11868 \begin_layout Plain Layout
11876 \begin_inset CommandInset ref
11878 reference "chap:List-of-functions"
11883 for the list of features.
11886 \begin_layout Description
11887 \begin_inset Flex Code
11890 \begin_layout Plain Layout
11897 \begin_inset Flex Code
11900 \begin_layout Plain Layout
11906 ] Indicates that this layout provides the functionality of the module mentioned,
11907 which should be specified by the filename without the
11908 \begin_inset Flex Code
11911 \begin_layout Plain Layout
11918 This will typically be used if the layout includes the module directly,
11919 rather than using the
11920 \begin_inset Flex Code
11923 \begin_layout Plain Layout
11929 tag to indicate that it ought to be used.
11930 It could also be used in a module that provided an alternate implementation of the same functionality.
11933 \begin_layout Description
11934 \begin_inset Flex Code
11937 \begin_layout Plain Layout
11944 \begin_inset Flex Code
11947 \begin_layout Plain Layout
11953 ] Creates a new paragraph style if it does not already exist.
11954 If the style does exist,
11955 this section is ignored.
11957 \begin_inset Quotes eld
11961 \begin_inset Flex Code
11964 \begin_layout Plain Layout
11971 \begin_inset Quotes erd
11977 \begin_layout Description
11978 \begin_inset Flex Code
11981 \begin_layout Plain Layout
11988 \begin_inset Flex Code
11991 \begin_layout Plain Layout
11997 ] Whether the class requires the feature
11998 \begin_inset Flex Code
12001 \begin_layout Plain Layout
12008 Multiple features must be separated by commas.
12009 Note that you can only request supported features.
12011 \begin_inset CommandInset ref
12013 reference "chap:List-of-functions"
12018 for the list of features.).
12019 If you require a package with specific options,
12020 you can additionally use
12021 \begin_inset Flex Code
12024 \begin_layout Plain Layout
12033 \begin_layout Description
12034 \begin_inset Flex Code
12037 \begin_layout Plain Layout
12044 \begin_inset Flex Code
12047 \begin_layout Plain Layout
12053 ] A string that indicates the width of the right margin on the screen,
12056 \begin_inset Quotes eld
12060 \begin_inset Flex Code
12063 \begin_layout Plain Layout
12070 \begin_inset Quotes erd
12076 \begin_layout Description
12077 \begin_inset Flex Code
12080 \begin_layout Plain Layout
12087 \begin_inset Flex Code
12090 \begin_layout Plain Layout
12096 ] Sets which divisions get numbered.
12098 \begin_inset Newline newline
12102 \begin_inset Flex Code
12105 \begin_layout Plain Layout
12111 counter in \SpecialChar LaTeX
12115 \begin_layout Description
12116 \begin_inset Flex Code
12119 \begin_layout Plain Layout
12126 \begin_inset Flex Code
12129 \begin_layout Plain Layout
12138 \begin_inset space \thinspace{}
12142 \begin_inset Flex Code
12145 \begin_layout Plain Layout
12151 ] Whether the class-default should be printing on one or both sides of the paper.
12152 Can be changed in the
12153 \begin_inset Flex Noun
12156 \begin_layout Plain Layout
12157 Document\SpecialChar menuseparator
12166 \begin_layout Description
12167 \begin_inset Flex Code
12170 \begin_layout Plain Layout
12177 \begin_inset Flex Code
12180 \begin_layout Plain Layout
12186 ] This sequence defines a paragraph style.
12187 If the style does not yet exist,
12190 its parameters are modified.
12192 \begin_inset Quotes eld
12196 \begin_inset Flex Code
12199 \begin_layout Plain Layout
12206 \begin_inset Quotes erd
12210 \begin_inset Newline newline
12214 \begin_inset CommandInset ref
12216 reference "subsec:Paragraph-Styles"
12221 for details on paragraph styles.
12222 \change_inserted -712698321 1553617804
12226 \begin_layout Description
12228 \change_inserted -712698321 1553617862
12229 \begin_inset Flex Code
12232 \begin_layout Plain Layout
12234 \change_inserted -712698321 1553617809
12243 \begin_inset Flex Code
12246 \begin_layout Plain Layout
12248 \change_inserted -712698321 1553617805
12256 ] defines the default table style that is used when inserting a table.
12257 The following styles are available:
12261 \begin_layout Itemize
12263 \change_inserted -712698321 1554308039
12264 \begin_inset Flex Code
12267 \begin_layout Plain Layout
12269 \change_inserted -712698321 1554307928
12270 Formal_with_Footline
12279 \begin_inset Quotes eld
12283 \begin_inset Quotes erd
12286 ) style with horizontal lines only,
12287 using a bold top and bottom line,
12288 the first and last row are additionally separated from the table body with a thin middle line.
12291 \begin_layout Itemize
12293 \change_inserted -712698321 1554308087
12294 \begin_inset Flex Code
12297 \begin_layout Plain Layout
12299 \change_inserted -712698321 1554308042
12300 Formal_without_Footline
12309 but the last row is not separated with a middle line from the body.
12312 \begin_layout Itemize
12314 \change_inserted -712698321 1553618031
12315 \begin_inset Flex Code
12318 \begin_layout Plain Layout
12320 \change_inserted -712698321 1553618006
12329 Simple table lines.
12332 \begin_layout Itemize
12334 \change_inserted -712698321 1553618309
12335 \begin_inset Flex Code
12338 \begin_layout Plain Layout
12340 \change_inserted -712698321 1553618031
12350 \begin_inset Flex Code
12353 \begin_layout Plain Layout
12355 \change_inserted -712698321 1553618043
12364 but with the header
12365 \change_deleted 34634807 1619712593
12367 \change_inserted 34634807 1619712594
12369 \change_inserted -712698321 1553618309
12370 offset with a second horizontal line.
12371 This is also the default style of \SpecialChar LyX
12375 \begin_layout Itemize
12377 \change_inserted -712698321 1553618280
12378 \begin_inset Flex Code
12381 \begin_layout Plain Layout
12383 \change_inserted -712698321 1553618261
12392 Table without lines.
12398 \begin_layout Description
12399 \begin_inset Flex Code
12402 \begin_layout Plain Layout
12409 \begin_inset Flex Code
12412 \begin_layout Plain Layout
12418 ] The name of the command or environment to be used with
12419 \begin_inset Flex Code
12422 \begin_layout Plain Layout
12431 \begin_layout Description
12432 \begin_inset Flex Code
12435 \begin_layout Plain Layout
12442 \begin_inset Flex Code
12445 \begin_layout Plain Layout
12455 \begin_inset Flex Code
12458 \begin_layout Plain Layout
12464 ] Indicates what kind of markup is used to define the title of a document.
12466 \begin_inset Flex Code
12469 \begin_layout Plain Layout
12475 means that the macro with name
12476 \begin_inset Flex Code
12479 \begin_layout Plain Layout
12485 will be inserted after the last layout which has
12486 \begin_inset Quotes eld
12490 \begin_inset Flex Code
12493 \begin_layout Plain Layout
12495 \begin_inset space ~
12504 \begin_inset Quotes erd
12509 \begin_inset Flex Code
12512 \begin_layout Plain Layout
12518 corresponds to the case where all layouts which have
12519 \begin_inset Quotes eld
12523 \begin_inset Flex Code
12526 \begin_layout Plain Layout
12528 \begin_inset space ~
12537 \begin_inset Quotes erd
12540 should be enclosed into the
12541 \begin_inset Flex Code
12544 \begin_layout Plain Layout
12553 \begin_layout Description
12554 \begin_inset Flex Code
12557 \begin_layout Plain Layout
12564 \begin_inset Flex Code
12567 \begin_layout Plain Layout
12573 ] Sets which divisions are included in the table of contents.
12575 \begin_inset Flex Code
12578 \begin_layout Plain Layout
12584 counter in \SpecialChar LaTeX
12588 \begin_layout Subsection
12589 \begin_inset Flex Code
12592 \begin_layout Plain Layout
12599 \begin_inset CommandInset label
12601 name "subsec:ClassOptions"
12608 \begin_layout Standard
12610 \begin_inset Flex Code
12613 \begin_layout Plain Layout
12619 section can contain the following entries:
12622 \begin_layout Description
12623 \begin_inset Flex Code
12626 \begin_layout Plain Layout
12633 \begin_inset Flex Code
12636 \begin_layout Plain Layout
12642 ] The list of available font sizes for the document's main font,
12644 \begin_inset Quotes eld
12648 \begin_inset Flex Code
12651 \begin_layout Plain Layout
12658 \begin_inset Quotes erd
12663 \change_inserted -712698321 1565110196
12664 Any number is possible.
12667 \begin_layout Description
12669 \change_inserted -712698321 1565110259
12670 \begin_inset Flex Code
12673 \begin_layout Plain Layout
12675 \change_inserted -712698321 1565110199
12684 \begin_inset Flex Code
12687 \begin_layout Plain Layout
12689 \change_inserted -712698321 1565110196
12697 ] The format for the font size option.
12700 \begin_inset Flex Code
12703 \begin_layout Plain Layout
12705 \change_inserted -712698321 1565110238
12715 \begin_inset Flex Code
12718 \begin_layout Plain Layout
12720 \change_inserted -712698321 1565110248
12728 is a placeholder for the font size.
12733 \begin_layout Description
12735 \change_deleted 5863208 1594239483
12736 \begin_inset Flex Code
12739 \begin_layout Plain Layout
12745 Used to set the DTD line with XML-based output classes.
12747 \begin_inset space \thinspace{}
12752 \begin_inset Quotes eld
12755 -//OASIS//DTD DocBook V4.2//EN
12756 \begin_inset Quotes erd
12760 \change_inserted -712698321 1565101761
12764 \begin_layout Description
12766 \change_inserted -712698321 1565180598
12767 \begin_inset Flex Code
12770 \begin_layout Plain Layout
12772 \change_inserted -712698321 1565101918
12781 \begin_inset Flex Code
12784 \begin_layout Plain Layout
12786 \change_inserted -712698321 1565105399
12787 string="letter|\SpecialChar allowbreak
12788 legal|\SpecialChar allowbreak
12789 executive|\SpecialChar allowbreak
12790 a0|\SpecialChar allowbreak
12791 a1|\SpecialChar allowbreak
12792 a2|\SpecialChar allowbreak
12793 a3|\SpecialChar allowbreak
12794 a4|\SpecialChar allowbreak
12795 a5|\SpecialChar allowbreak
12796 a6|\SpecialChar allowbreak
12797 b0|\SpecialChar allowbreak
12798 b1|\SpecialChar allowbreak
12799 b2|\SpecialChar allowbreak
12800 b3|\SpecialChar allowbreak
12801 b4|\SpecialChar allowbreak
12802 b5|\SpecialChar allowbreak
12803 b6|\SpecialChar allowbreak
12804 c0|\SpecialChar allowbreak
12805 c1|\SpecialChar allowbreak
12806 c2|\SpecialChar allowbreak
12807 c3|\SpecialChar allowbreak
12808 c4|\SpecialChar allowbreak
12809 c5|\SpecialChar allowbreak
12810 c6|\SpecialChar allowbreak
12811 b0j|\SpecialChar allowbreak
12812 b1j|\SpecialChar allowbreak
12813 b2j|\SpecialChar allowbreak
12814 b3j|\SpecialChar allowbreak
12815 b4j|\SpecialChar allowbreak
12816 b5j|\SpecialChar allowbreak
12824 ] The list of available page sizes,
12826 \begin_inset Quotes eld
12830 \begin_inset Flex Code
12833 \begin_layout Plain Layout
12835 \change_inserted -712698321 1565101779
12844 \begin_inset Quotes erd
12849 only the listed sizes are supported.
12850 Other sizes might be entered as custom class option.
12853 \begin_layout Description
12855 \change_inserted -712698321 1565180623
12856 \begin_inset Flex Code
12859 \begin_layout Plain Layout
12861 \change_inserted -712698321 1565180605
12870 \begin_inset Flex Code
12873 \begin_layout Plain Layout
12875 \change_inserted -712698321 1565180601
12883 ] The format for the page size option.
12886 \begin_inset Flex Code
12889 \begin_layout Plain Layout
12891 \change_inserted -712698321 1565180618
12901 \begin_inset Flex Code
12904 \begin_layout Plain Layout
12906 \change_inserted -712698321 1565180601
12914 is a placeholder for the paper size.
12919 \begin_layout Description
12920 \begin_inset Flex Code
12923 \begin_layout Plain Layout
12930 \begin_inset Flex Code
12933 \begin_layout Plain Layout
12934 string="empty|plain|headings|fancy"
12939 ] The list of available page sty\SpecialChar softhyphen
12942 \begin_inset Quotes eld
12946 \begin_inset Flex Code
12949 \begin_layout Plain Layout
12956 \begin_inset Quotes erd
12962 \begin_layout Description
12963 \begin_inset Flex Code
12966 \begin_layout Plain Layout
12973 \begin_inset Flex Code
12976 \begin_layout Plain Layout
12982 ] Some document class options,
12983 separated by a comma,
12984 that will be added to the optional part of the
12985 \begin_inset Flex Code
12988 \begin_layout Plain Layout
12999 \begin_layout Standard
13001 \begin_inset Flex Code
13004 \begin_layout Plain Layout
13010 section must end with
13011 \begin_inset Quotes eld
13015 \begin_inset Flex Code
13018 \begin_layout Plain Layout
13025 \begin_inset Quotes erd
13031 \begin_layout Subsection
13033 \begin_inset CommandInset label
13035 name "subsec:Paragraph-Styles"
13042 \begin_layout Standard
13043 A paragraph style description looks like this:
13047 \begin_layout Plain Layout
13048 Note that this will either define a new style or modify an existing one.
13056 \begin_layout LyX-Code
13063 \begin_layout LyX-Code
13067 \begin_layout LyX-Code
13071 \begin_layout Standard
13072 where the following commands are allowed:
13075 \begin_layout Description
13076 \begin_inset Flex Code
13079 \begin_layout Plain Layout
13086 \begin_inset Flex Code
13089 \begin_layout Plain Layout
13095 =""] This paragraph will appear in the table of contents of the given type.
13096 An empty string disables.
13097 See also the OutlinerName and the IsTocCaption commands.
13102 \begin_layout Description
13103 \begin_inset Flex Code
13106 \begin_layout Plain Layout
13113 \begin_inset Flex Code
13116 \begin_layout Plain Layout
13129 ] Paragraph alignment.
13132 \begin_layout Description
13133 \begin_inset Flex Code
13136 \begin_layout Plain Layout
13143 \begin_inset Flex Code
13146 \begin_layout Plain Layout
13159 ] A comma separated list of permitted alignments.
13160 (Some \SpecialChar LaTeX
13161 styles prohibit certain alignments,
13162 since those wouldn't make sense.
13163 For example a right-aligned or centered enumeration isn't possible.)
13166 \begin_layout Description
13167 \begin_inset Flex Code
13170 \begin_layout Plain Layout
13177 \begin_inset Flex Code
13180 \begin_layout Plain Layout
13186 ] Defines argument number <int> of a command\SpecialChar breakableslash
13187 environment associated with the current style.
13189 \change_inserted -584632292 1615846868
13190 The definition must end with
13191 \begin_inset Flex Code
13194 \begin_layout Plain Layout
13196 \change_inserted -584632292 1615846867
13208 \change_inserted -584632292 1615846880
13210 \begin_inset CommandInset ref
13212 reference "subsec:Arguments"
13220 for more information.
13222 \change_deleted -584632292 1615846694
13223 This is useful for things like section headings,
13224 and only makes sense with \SpecialChar LaTeX
13226 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,
13227 where the number specifies the order of the arguments.
13228 The definition must end with
13229 \begin_inset Flex Code
13232 \begin_layout Plain Layout
13239 So a command with two optional arguments has:
13243 \begin_layout Quote
13245 \change_deleted -584632292 1615846694
13251 \begin_layout Quote
13253 \change_deleted -584632292 1615846694
13259 \begin_layout Quote
13261 \change_deleted -584632292 1615846694
13267 \begin_layout Quote
13269 \change_deleted -584632292 1615846694
13275 \begin_layout Quote
13277 \change_deleted -584632292 1615846694
13283 \begin_layout Quote
13285 \change_deleted -584632292 1615846694
13291 \begin_layout Standard
13293 \change_deleted -584632292 1615846694
13295 \begin_inset Flex Code
13298 \begin_layout Plain Layout
13305 the following specifications are possible:
13308 \begin_layout Itemize
13310 \change_deleted -584632292 1615846694
13311 \begin_inset Flex Code
13314 \begin_layout Plain Layout
13321 \begin_inset Flex Code
13324 \begin_layout Plain Layout
13330 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
13331 \begin_inset Flex Code
13334 \begin_layout Plain Layout
13342 you can define an accelerator by appending the respective character to the string,
13344 \begin_inset Quotes eld
13348 \begin_inset Quotes erd
13352 \begin_inset space \thinspace{}
13356 \begin_inset space \space{}
13360 \begin_inset Quotes eld
13364 \begin_inset Flex Code
13367 \begin_layout Plain Layout
13374 \begin_inset Quotes erd
13380 \begin_layout Itemize
13382 \change_deleted -584632292 1615846694
13383 \begin_inset Flex Code
13386 \begin_layout Plain Layout
13393 \begin_inset Flex Code
13396 \begin_layout Plain Layout
13402 A separate string for the menu.
13403 You can define an accelerator by appending the respective character to the string,
13405 \begin_inset Quotes eld
13409 \begin_inset Quotes erd
13413 \begin_inset space \thinspace{}
13417 \begin_inset space \space{}
13421 \begin_inset Quotes eld
13425 \begin_inset Flex Code
13428 \begin_layout Plain Layout
13435 \begin_inset Quotes erd
13439 This specification is optional.
13440 If it is not given the
13441 \begin_inset Flex Code
13444 \begin_layout Plain Layout
13450 will be used instead for the menu.
13453 \begin_layout Itemize
13455 \change_deleted -584632292 1615846694
13456 \begin_inset Flex Code
13459 \begin_layout Plain Layout
13466 \begin_inset Flex Code
13469 \begin_layout Plain Layout
13475 A longer explanatory text that appears in the tooltip when hovering over the argument inset.
13478 \begin_layout Itemize
13480 \change_deleted -584632292 1615846694
13481 \begin_inset Flex Code
13484 \begin_layout Plain Layout
13491 \begin_inset Flex Code
13494 \begin_layout Plain Layout
13503 \begin_inset space \thinspace{}
13507 \begin_inset Flex Code
13510 \begin_layout Plain Layout
13516 ] Declare if this is a mandatory (1) or an optional (0) argument.
13517 Mandatory arguments will be output empty if not given,
13518 while optional arguments will not be output at all.
13520 mandatory arguments are delimited by
13521 \begin_inset Flex Code
13524 \begin_layout Plain Layout
13531 while optional arguments are delimited by
13532 \begin_inset Flex Code
13535 \begin_layout Plain Layout
13544 \begin_layout Itemize
13546 \change_deleted -584632292 1615846694
13547 \begin_inset Flex Code
13550 \begin_layout Plain Layout
13552 \change_inserted -712698321 1555579780
13561 \begin_inset Flex Code
13564 \begin_layout Plain Layout
13566 \change_inserted -712698321 1555579780
13574 Option to define a different command (from the default
13575 \begin_inset Flex Code
13578 \begin_layout Plain Layout
13580 \change_inserted -712698321 1555579780
13592 ) to be used for line breaks.
13593 The initial backslash must not be specified.
13596 \begin_layout Itemize
13598 \change_deleted -584632292 1615846694
13599 \begin_inset Flex Code
13602 \begin_layout Plain Layout
13609 \begin_inset Flex Code
13612 \begin_layout Plain Layout
13618 defines another argument (by its number) which this argument requires to be output if it is itself output.
13620 \begin_inset space \thinspace{}
13624 in \SpecialChar LaTeX
13626 optional arguments often require previous optional arguments to be output (at least empty),
13628 \begin_inset Flex Code
13631 \begin_layout Plain Layout
13634 command[][argument]{text}
13640 This can be achieved by the statement
13641 \begin_inset Flex Code
13644 \begin_layout Plain Layout
13651 \begin_inset Flex Code
13654 \begin_layout Plain Layout
13663 \begin_layout Itemize
13665 \change_deleted -584632292 1615846694
13666 \begin_inset Flex Code
13669 \begin_layout Plain Layout
13676 \begin_inset Flex Code
13679 \begin_layout Plain Layout
13685 defines a custom left delimiter (instead of
13686 \begin_inset Flex Code
13689 \begin_layout Plain Layout
13696 \begin_inset Flex Code
13699 \begin_layout Plain Layout
13706 A line break in the output can be indicated by
13707 \begin_inset Flex Code
13710 \begin_layout Plain Layout
13719 \begin_layout Itemize
13721 \change_deleted -584632292 1615846694
13722 \begin_inset Flex Code
13725 \begin_layout Plain Layout
13732 \begin_inset Flex Code
13735 \begin_layout Plain Layout
13741 defines a custom right delimiter (instead of
13742 \begin_inset Flex Code
13745 \begin_layout Plain Layout
13752 \begin_inset Flex Code
13755 \begin_layout Plain Layout
13762 A line break in the output can be indicated by
13763 \begin_inset Flex Code
13766 \begin_layout Plain Layout
13775 \begin_layout Itemize
13777 \change_deleted -584632292 1615846694
13778 \begin_inset Flex Code
13781 \begin_layout Plain Layout
13788 \begin_inset Flex Code
13791 \begin_layout Plain Layout
13797 defines an argument that is inserted if and only if no user-specified arguments were given,
13799 \begin_inset space \thinspace{}
13803 \begin_inset space \space{}
13806 if no argument inset has been inserted (note that also an empty argument inset omits the DefaultArg).
13807 Multiple arguments need to be separated by comma.
13810 \begin_layout Itemize
13812 \change_deleted -584632292 1615846694
13813 \begin_inset Flex Code
13816 \begin_layout Plain Layout
13823 \begin_inset Flex Code
13826 \begin_layout Plain Layout
13832 defines an argument that is inserted in any case (alone or in addition to user-specified arguments).
13833 Multiple arguments need to be separated by comma.
13836 \begin_layout Itemize
13838 \change_deleted -584632292 1615846694
13839 \begin_inset Flex Code
13842 \begin_layout Plain Layout
13848 The font used for the argument content,
13850 \begin_inset CommandInset ref
13852 reference "subsec:Font-description"
13860 \begin_layout Itemize
13862 \change_deleted -584632292 1615846694
13863 \begin_inset Flex Code
13866 \begin_layout Plain Layout
13868 \change_inserted -712698321 1559484228
13877 \begin_inset Flex Code
13880 \begin_layout Plain Layout
13882 \change_inserted -712698321 1559484228
13893 \begin_inset space \thinspace{}
13897 \begin_inset Flex Code
13900 \begin_layout Plain Layout
13902 \change_inserted -712698321 1559484228
13910 ] As with paragraph styles,
13912 \begin_inset CommandInset ref
13914 reference "subsec:Paragraph-Styles"
13922 \begin_layout Itemize
13924 \change_deleted -584632292 1615846694
13925 \begin_inset Flex Code
13928 \begin_layout Plain Layout
13934 The font used for the label;
13936 \begin_inset CommandInset ref
13938 reference "subsec:Font-description"
13946 \begin_layout Itemize
13948 \change_deleted -584632292 1615846694
13949 \begin_inset Flex Code
13952 \begin_layout Plain Layout
13959 \begin_inset Flex Code
13962 \begin_layout Plain Layout
13974 ] describes the rendering style used for the inset's frame and buttons.
13977 \begin_layout Itemize
13979 \change_deleted -584632292 1615846694
13980 \begin_inset Flex Code
13983 \begin_layout Plain Layout
13990 \begin_inset Flex Code
13993 \begin_layout Plain Layout
14000 \begin_inset Flex Code
14003 \begin_layout Plain Layout
14010 this argument is automatically inserted when the respective style is selected.
14012 \change_deleted -712698321 1559484200
14014 only one argument per style\SpecialChar breakableslash
14015 layout can be automatically inserted.
14016 \change_deleted -584632292 1615846694
14020 \begin_layout Itemize
14022 \change_deleted -584632292 1615846694
14023 \begin_inset Flex Code
14026 \begin_layout Plain Layout
14028 \change_inserted -712698321 1559490711
14037 \begin_inset Flex Code
14040 \begin_layout Plain Layout
14042 \change_inserted -712698321 1559490703
14051 \begin_inset Flex Code
14054 \begin_layout Plain Layout
14056 \change_inserted -712698321 1559490703
14065 this argument will be inserted on a new line with
14066 \begin_inset Flex Code
14069 \begin_layout Plain Layout
14071 \change_inserted -712698321 1559491402
14079 (only available within Flex insets).
14082 \begin_layout Itemize
14084 \change_deleted -584632292 1615846694
14085 \begin_inset Flex Code
14088 \begin_layout Plain Layout
14095 \begin_inset Flex Code
14098 \begin_layout Plain Layout
14105 \begin_inset Flex Code
14108 \begin_layout Plain Layout
14115 this argument will be inserted with a copy of the co-text (either selected text or the whole paragraph) as content.
14118 \begin_layout Itemize
14120 \change_deleted -584632292 1615846694
14121 \begin_inset Flex Code
14124 \begin_layout Plain Layout
14131 \begin_inset Flex Code
14134 \begin_layout Plain Layout
14146 ] Whether the contents of this argument should be output in raw form,
14147 meaning without special translations that \SpecialChar LaTeX
14151 \begin_inset Flex Code
14154 \begin_layout Plain Layout
14160 status is inherited by the inset or paragraph layout the argument belongs to,
14161 true and false change the status for the given argument only.
14164 \begin_layout Itemize
14166 \change_deleted -584632292 1615846694
14167 \begin_inset Flex Code
14170 \begin_layout Plain Layout
14177 \begin_inset Flex Code
14180 \begin_layout Plain Layout
14181 string of characters
14190 Defines individual characters
14191 \begin_inset Newline linebreak
14194 that should be output in raw form,
14195 meaning without special translations that \SpecialChar LaTeX
14198 contrary to PassThru,
14199 this needs to be explicitly defined for arguments.
14201 arguments do not inherit PassThruChars from their parent inset or layout.
14204 \begin_layout Itemize
14206 \change_deleted -584632292 1615846694
14207 \begin_inset Flex Code
14210 \begin_layout Plain Layout
14217 \begin_inset Flex Code
14220 \begin_layout Plain Layout
14229 \begin_inset space \thinspace{}
14233 \begin_inset Flex Code
14236 \begin_layout Plain Layout
14242 ] If this is set to 1,
14243 the argument will output its content in the corresponding item in the table of contents.
14247 \begin_layout Standard
14249 \change_deleted -584632292 1615846694
14251 the text entered in the \SpecialChar LyX
14252 workarea in the respective layout is the last (mandatory) argument of a command if the
14253 \begin_inset Flex Code
14256 \begin_layout Plain Layout
14263 \begin_inset Flex Code
14266 \begin_layout Plain Layout
14274 arguments with the prefix
14275 \begin_inset Flex Code
14278 \begin_layout Plain Layout
14284 are output after this workarea argument.
14285 Note that post-argument numbering restarts at 1,
14286 so the first argument following the workarea argument is
14287 \begin_inset Flex Code
14290 \begin_layout Plain Layout
14297 Post-arguments are ignored in any other
14298 \begin_inset Flex Code
14301 \begin_layout Plain Layout
14308 \begin_inset Flex Code
14311 \begin_layout Plain Layout
14320 \begin_layout Standard
14322 \change_deleted -584632292 1615846694
14324 \begin_inset Flex Code
14327 \begin_layout Plain Layout
14336 \begin_inset Flex Code
14339 \begin_layout Plain Layout
14348 \begin_inset Flex Code
14351 \begin_layout Plain Layout
14357 followed by the number (e.
14358 \begin_inset space \thinspace{}
14362 \begin_inset space \space{}
14366 \begin_inset Flex Code
14369 \begin_layout Plain Layout
14378 \begin_layout Standard
14380 \change_deleted -584632292 1615846694
14382 there is a special argument type with the prefix
14383 \begin_inset Flex Code
14386 \begin_layout Plain Layout
14388 \change_inserted -712698321 1534487844
14397 It is not really an argument,
14398 but uses the argument interface (thus,
14399 the prefix is also followed by a number,
14401 \begin_inset space \thinspace{}
14406 \begin_inset Flex Code
14409 \begin_layout Plain Layout
14411 \change_inserted -712698321 1534488412
14412 Argument listpreamble:1
14420 As the name implies,
14421 it is targeted at lists such as
14441 Its content will be output at the list start,
14443 \begin_inset Flex Code
14446 \begin_layout Plain Layout
14448 \change_inserted -712698321 1534488058
14459 on an own line (a place that is otherwise not accessible in \SpecialChar LyX
14462 users can insert redefinitions (of lengths etc.) to individual lists.
14464 these arguments do not have a delimiter.
14470 \begin_layout Description
14471 \begin_inset Flex Code
14474 \begin_layout Plain Layout
14480 Includes a comma-separated list of layouts that should be nested in and after the current layout.
14481 Only makes sense for nestable layouts (such as environments).
14483 \begin_inset Quotes eld
14487 \begin_inset Flex Code
14490 \begin_layout Plain Layout
14497 \begin_inset Quotes erd
14502 \begin_inset Flex Code
14505 \begin_layout Plain Layout
14514 \begin_layout Description
14515 \begin_inset Flex Code
14518 \begin_layout Plain Layout
14524 Note that this will completely override any prior
14525 \begin_inset Flex Code
14528 \begin_layout Plain Layout
14534 declaration for this style.
14536 \begin_inset Quotes eld
14540 \begin_inset Flex Code
14543 \begin_layout Plain Layout
14550 \begin_inset Quotes erd
14555 \begin_inset CommandInset ref
14557 reference "subsec:I18n"
14562 for details on its use.
14565 \begin_layout Description
14566 \begin_inset Flex Code
14569 \begin_layout Plain Layout
14576 \begin_inset Flex Code
14579 \begin_layout Plain Layout
14589 \begin_layout Plain Layout
14590 Note that a `float' here is a real number,
14597 The vertical space with which the last of a chain of paragraphs with this style is separated from the following paragraph.
14598 If the next paragraph has another style,
14599 the separations are not simply added,
14600 but the maximum is taken.
14603 \begin_layout Description
14604 \begin_inset Flex Code
14607 \begin_layout Plain Layout
14614 \begin_inset Flex Code
14617 \begin_layout Plain Layout
14623 ] The category for this style.
14624 This is used to group related styles in the style combobox on the toolbar.
14625 Any string can be used,
14626 but you may want to use existing categories with your own styles.
14630 \begin_layout Description
14632 \change_deleted 1075283030 1672014981
14633 \begin_inset Flex Code
14636 \begin_layout Plain Layout
14642 Depth of XML command.
14643 Used only with XML-type formats.
14646 \begin_layout Description
14647 \begin_inset Flex Code
14650 \begin_layout Plain Layout
14657 \begin_inset Flex Code
14660 \begin_layout Plain Layout
14666 ] Copies all the features of an existing style into the current one.
14667 \change_inserted 1075283030 1671679774
14671 \begin_layout Description
14673 \change_inserted 1075283030 1672014806
14674 \begin_inset Flex Code
14677 \begin_layout Plain Layout
14679 \change_inserted 1075283030 1671679781
14680 DocBookGenerateTitle
14688 \begin_inset Flex Code
14691 \begin_layout Plain Layout
14693 \change_inserted 1075283030 1672014763
14702 \begin_inset Flex Code
14705 \begin_layout Plain Layout
14707 \change_inserted 1075283030 1672014789
14713 tag after the wrapper tag.
14714 This parameter should only be used with
14715 \begin_inset Flex Code
14718 \begin_layout Plain Layout
14720 \change_inserted 1075283030 1671679828
14729 otherwise the title will be output
14733 the contents of the environment.
14734 The generated title is the same as the LyXHTML label:
14735 a combination of the environment type and its number.
14736 A major use is when DocBook has no close mapping for LaTeX environments and users must fallback to using a generic container such as
14737 \begin_inset Flex Code
14740 \begin_layout Plain Layout
14742 \change_inserted 1075283030 1672014801
14749 which requires a title although there is none in LaTeX.
14750 This feature is heavily used for theorem-like environments.
14755 \begin_layout Description
14756 \begin_inset Flex Code
14759 \begin_layout Plain Layout
14766 \begin_inset Flex Code
14769 \begin_layout Plain Layout
14775 ] The name of a style whose preamble should be output
14780 This allows to ensure some ordering of the preamble snippets when macros definitions depend on one another.
14784 \begin_layout Plain Layout
14786 besides that functionality,
14787 there is no way to ensure any ordering of preambles.
14788 The ordering that you see in a given version of \SpecialChar LyX
14789 may change without warning in later versions.
14797 \begin_layout Description
14798 \begin_inset Flex Code
14801 \begin_layout Plain Layout
14808 \begin_inset Flex Code
14811 \begin_layout Plain Layout
14824 ] The type of label that stands at the end of the paragraph (or sequence of paragraphs if
14825 \begin_inset Flex Code
14828 \begin_layout Plain Layout
14835 \begin_inset Newline newline
14839 \begin_inset Flex Code
14842 \begin_layout Plain Layout
14850 \begin_inset Flex Code
14853 \begin_layout Plain Layout
14860 \begin_inset Flex Code
14863 \begin_layout Plain Layout
14871 \begin_inset Flex Code
14874 \begin_layout Plain Layout
14881 \begin_inset Quotes eld
14885 \begin_inset Quotes erd
14890 \begin_inset Flex Code
14893 \begin_layout Plain Layout
14900 \begin_inset space \space{}
14904 \begin_inset Flex Code
14907 \begin_layout Plain Layout
14913 ) is a white (resp.
14914 \begin_inset space ~
14917 black) square suitable for end of proof markers,
14919 \begin_inset Flex Code
14922 \begin_layout Plain Layout
14928 is an explicit text string.
14931 \begin_layout Description
14932 \begin_inset Flex Code
14935 \begin_layout Plain Layout
14942 \begin_inset Flex Code
14945 \begin_layout Plain Layout
14951 ] The string used for a label with a
14952 \begin_inset Flex Code
14955 \begin_layout Plain Layout
14962 \begin_inset Newline newline
14966 \begin_inset Flex Code
14969 \begin_layout Plain Layout
14979 \begin_layout Description
14980 \begin_inset Flex Code
14983 \begin_layout Plain Layout
14989 The font used for both the text body
14995 \begin_inset CommandInset ref
14997 reference "subsec:Font-description"
15003 Note that defining this font automatically defines the
15004 \begin_inset Flex Code
15007 \begin_layout Plain Layout
15014 So you should define this one first if you also want to define
15015 \begin_inset Flex Code
15018 \begin_layout Plain Layout
15027 \begin_layout Description
15028 \begin_inset Flex Code
15031 \begin_layout Plain Layout
15038 \begin_inset Flex Code
15041 \begin_layout Plain Layout
15047 ] Used for backporting new styles to stable \SpecialChar LyX
15049 The first stable version that supports this tag is \SpecialChar LyX
15051 The argument is a number which may either be 0,
15052 -1 or any value greater than zero.
15054 \begin_inset Flex Code
15057 \begin_layout Plain Layout
15063 flag of a style is greater than zero,
15064 it will always be written to the document header.
15065 If a .lyx file is read,
15066 the style definitions from the document header are added to the document class.
15067 Therefore even older \SpecialChar LyX
15068 versions can handle the style.
15070 \begin_inset Flex Code
15073 \begin_layout Plain Layout
15079 is a version number:
15080 if the style is read,
15081 and the version number is less than the version number of the already existing style in the document class,
15082 the new style is ignored.
15083 If the version number is greater,
15084 the new style replaces the existing style.
15085 A value of -1 means an infinite version number,
15087 \begin_inset space \thinspace{}
15091 \begin_inset space \space{}
15094 the style is always used.
15097 \begin_layout Description
15098 \begin_inset Flex Code
15101 \begin_layout Plain Layout
15108 \begin_inset Flex Code
15111 \begin_layout Plain Layout
15120 \begin_inset space \thinspace{}
15124 \begin_inset Flex Code
15127 \begin_layout Plain Layout
15133 ] Usually \SpecialChar LyX
15134 does not allow you to insert more than one space between words,
15135 since a space is considered as the separation between two words,
15136 not a character or symbol of its own.
15137 This is a very fine thing but sometimes annoying,
15139 when typing program code or plain \SpecialChar LaTeX
15143 \begin_inset Flex Code
15146 \begin_layout Plain Layout
15154 \change_deleted -495245474 1550490105
15159 \change_deleted 177693 1654669077
15161 \change_inserted 177693 1654669079
15165 \change_deleted 177693 1654669082
15167 \change_inserted 177693 1654669082
15170 for the additional blanks when
15171 \change_deleted 34634807 1619626461
15175 \change_inserted -495245474 1550490096
15177 \begin_inset Flex Code
15180 \begin_layout Plain Layout
15182 \change_inserted -495245474 1550490089
15191 \change_deleted -495245474 1550490116
15192 another mode than \SpecialChar LaTeX
15195 \change_inserted -495245474 1550247760
15197 \begin_inset Flex Code
15200 \begin_layout Plain Layout
15202 \change_inserted -495245474 1550247736
15211 \begin_inset Flex Code
15214 \begin_layout Plain Layout
15216 \change_inserted -495245474 1550247755
15229 \begin_layout Description
15230 \begin_inset Flex Code
15233 \begin_layout Plain Layout
15239 These tags are used with XHTML output.
15241 \begin_inset CommandInset ref
15243 reference "subsec:Paragraph-Style-XHTML"
15251 \begin_layout Description
15253 \change_deleted 1075283030 1672014684
15254 \begin_inset Flex Code
15257 \begin_layout Plain Layout
15263 [FIXME] (Used only with XML-type formats.)
15268 \begin_layout Description
15269 \begin_inset Flex Code
15272 \begin_layout Plain Layout
15279 \begin_inset Flex Code
15282 \begin_layout Plain Layout
15291 \begin_inset space \thinspace{}
15295 \begin_inset Flex Code
15298 \begin_layout Plain Layout
15305 \begin_inset Flex Code
15308 \begin_layout Plain Layout
15315 marks the style as to be included in the document preamble and not in the document body.
15316 This is useful for document classes that want such information as the title and author to appear in the preamble.
15317 Note that this works only for styles for which the
15318 \begin_inset Flex Code
15321 \begin_layout Plain Layout
15328 \begin_inset Flex Code
15331 \begin_layout Plain Layout
15338 \begin_inset Flex Code
15341 \begin_layout Plain Layout
15350 \begin_layout Description
15351 \begin_inset Flex Code
15354 \begin_layout Plain Layout
15361 \begin_inset Flex Code
15364 \begin_layout Plain Layout
15373 \begin_inset space \thinspace{}
15377 \begin_inset Flex Code
15380 \begin_layout Plain Layout
15387 \begin_inset Flex Code
15390 \begin_layout Plain Layout
15397 marks the style as being part of a title block (see also the
15398 \begin_inset Flex Code
15401 \begin_layout Plain Layout
15408 \begin_inset Flex Code
15411 \begin_layout Plain Layout
15420 \begin_layout Description
15421 \begin_inset Flex Code
15424 \begin_layout Plain Layout
15430 Includes a comma-separated list of layouts after which this one should be nested.
15431 Only makes sense with regard to nestable layouts (such as environments).
15433 \begin_inset Quotes eld
15437 \begin_inset Flex Code
15440 \begin_layout Plain Layout
15447 \begin_inset Quotes erd
15452 \begin_inset Flex Code
15455 \begin_layout Plain Layout
15464 \begin_layout Description
15465 \begin_inset Flex Code
15468 \begin_layout Plain Layout
15475 \begin_inset Flex Code
15478 \begin_layout Plain Layout
15487 \begin_inset space \thinspace{}
15491 \begin_inset Flex Code
15494 \begin_layout Plain Layout
15500 ] If this is set to 1 and AddToToc is enabled,
15501 the paragraph adds a summary of its contents in its item in the table of contents.
15508 \begin_layout Description
15509 \begin_inset Flex Code
15512 \begin_layout Plain Layout
15519 \begin_inset Flex Code
15522 \begin_layout Plain Layout
15528 ] The \SpecialChar LaTeX
15529 command sequence declaring an item in a list.
15530 The command is to be defined without the preceding backslash (the default is
15531 \begin_inset Quotes eld
15535 \begin_inset Quotes erd
15540 \begin_inset Flex Code
15543 \begin_layout Plain Layout
15551 in the \SpecialChar LaTeX
15555 \begin_layout Description
15556 \begin_inset Flex Code
15559 \begin_layout Plain Layout
15566 \begin_inset Flex Code
15569 \begin_layout Plain Layout
15575 ] This provides extra space between paragraphs that have the same style.
15576 If you put other styles into an environment,
15577 each is separated with the environment's
15578 \begin_inset Flex Code
15581 \begin_layout Plain Layout
15588 But the whole items of the environment are additionally separated with this
15589 \begin_inset Flex Code
15592 \begin_layout Plain Layout
15599 Note that this is a
15604 \begin_layout Description
15606 \change_deleted 1075283030 1672014680
15607 \begin_inset Flex Code
15610 \begin_layout Plain Layout
15616 [FIXME] (Used only with XML-type formats.)
15621 \begin_layout Description
15622 \begin_inset Flex Code
15625 \begin_layout Plain Layout
15632 \begin_inset Flex Code
15635 \begin_layout Plain Layout
15644 \begin_inset space \thinspace{}
15648 \begin_inset Flex Code
15651 \begin_layout Plain Layout
15657 ] Usually \SpecialChar LyX
15658 does not allow you to leave a paragraph empty,
15659 since it would lead to empty \SpecialChar LaTeX
15661 There are some cases where this could be desirable however:
15662 in a letter template,
15663 the required fields can be provided as empty fields,
15664 so that people do not forget them;
15665 in some special classes,
15666 a style can be used as some kind of break,
15667 which does not contain actual text.
15670 \begin_layout Description
15671 \begin_inset Flex Code
15674 \begin_layout Plain Layout
15681 \begin_inset Flex Code
15684 \begin_layout Plain Layout
15690 ] The vertical space between the label and the text body.
15691 Only used for labels that are above the text body (
15692 \begin_inset Flex Code
15695 \begin_layout Plain Layout
15702 \begin_inset Newline newline
15706 \begin_inset Flex Code
15709 \begin_layout Plain Layout
15710 Centered_Top_Environment
15718 \begin_layout Description
15719 \begin_inset Flex Code
15722 \begin_layout Plain Layout
15729 \begin_inset Flex Code
15732 \begin_layout Plain Layout
15738 ] The name of the counter for automatic numbering.
15739 In order to have the counter appear with your label,
15740 you will need to reference it in the
15741 \begin_inset Flex Code
15744 \begin_layout Plain Layout
15753 This will work with
15754 \begin_inset Flex Code
15757 \begin_layout Plain Layout
15765 \begin_inset Flex Code
15768 \begin_layout Plain Layout
15776 \begin_inset Flex Code
15779 \begin_layout Plain Layout
15786 \begin_inset Flex Code
15789 \begin_layout Plain Layout
15797 \begin_inset Newline newline
15805 \begin_inset Flex Code
15808 \begin_layout Plain Layout
15815 \begin_inset Flex Code
15818 \begin_layout Plain Layout
15825 though this case is a bit complicated.
15826 Suppose you declare
15827 \begin_inset Quotes eld
15831 \begin_inset Flex Code
15834 \begin_layout Plain Layout
15835 LabelCounter myenum
15841 \begin_inset Quotes erd
15845 Then the actual counters used are
15846 \begin_inset Flex Code
15849 \begin_layout Plain Layout
15857 \begin_inset Flex Code
15860 \begin_layout Plain Layout
15868 \begin_inset Flex Code
15871 \begin_layout Plain Layout
15878 \begin_inset Flex Code
15881 \begin_layout Plain Layout
15888 much as in \SpecialChar LaTeX
15890 These counters must all be declared separately.
15891 \begin_inset Newline newline
15895 \begin_inset CommandInset ref
15897 reference "subsec:Counters"
15902 for details on counters.
15905 \begin_layout Description
15906 \begin_inset Flex Code
15909 \begin_layout Plain Layout
15915 The font used for the label.
15917 \begin_inset CommandInset ref
15919 reference "subsec:Font-description"
15927 \begin_layout Description
15928 \begin_inset Flex Code
15931 \begin_layout Plain Layout
15938 \begin_inset Flex Code
15941 \begin_layout Plain Layout
15947 ] Text that indicates how far a label should be indented.
15950 \begin_layout Description
15951 \begin_inset Flex Code
15954 \begin_layout Plain Layout
15961 \begin_inset Flex Code
15964 \begin_layout Plain Layout
15970 ] Text that indicates the amount of horizontal space between the label and the text body.
15971 Only used for labels that are not above the text body.
15974 \begin_layout Description
15975 \begin_inset Flex Code
15978 \begin_layout Plain Layout
15985 \begin_inset Flex Code
15988 \begin_layout Plain Layout
15994 ] The string used for the label.
15996 \begin_inset Flex Code
15999 \begin_layout Plain Layout
16006 this string can be contain the special formatting commands described in
16007 \begin_inset CommandInset ref
16009 reference "subsec:Counters"
16017 \begin_layout Description
16018 \begin_inset Flex Code
16021 \begin_layout Plain Layout
16022 LabelStringAppendix
16028 \begin_inset Flex Code
16031 \begin_layout Plain Layout
16037 ] This is used inside the appendix instead of
16038 \begin_inset Newline newline
16042 \begin_inset Flex Code
16045 \begin_layout Plain Layout
16053 \begin_inset Flex Code
16056 \begin_layout Plain Layout
16063 \begin_inset Newline newline
16067 \begin_inset Flex Code
16070 \begin_layout Plain Layout
16071 LabelStringAppendix
16077 \change_deleted 1075283030 1672015070
16081 \begin_layout Description
16083 \change_deleted 1075283030 1672015070
16084 \begin_inset Flex Code
16087 \begin_layout Plain Layout
16093 [FIXME] (Used only with XML-type formats.)
16098 \begin_layout Description
16099 \begin_inset Flex Code
16102 \begin_layout Plain Layout
16109 \begin_inset Flex Code
16112 \begin_layout Plain Layout
16122 \begin_inset Newline newline
16128 \begin_inset Newline newline
16141 \begin_layout Description
16142 \begin_inset Flex Code
16145 \begin_layout Plain Layout
16151 means the label is the very first word (up to the first real blank).
16153 \change_deleted 177693 1654669087
16155 \change_inserted 177693 1654669089
16158 spaces if you want more than one word as the label.
16162 \begin_layout Description
16163 \begin_inset Flex Code
16166 \begin_layout Plain Layout
16172 means the label is simply what is declared as
16173 \begin_inset Flex Code
16176 \begin_layout Plain Layout
16183 This will be displayed
16184 \begin_inset Quotes eld
16188 \begin_inset Quotes erd
16192 at the beginning of the paragraph.
16194 \begin_inset Flex Code
16197 \begin_layout Plain Layout
16204 \begin_inset Flex Code
16207 \begin_layout Plain Layout
16214 then it will be displayed only in the first paragraph of any sequence of paragraphs with the same
16215 \begin_inset Flex Code
16218 \begin_layout Plain Layout
16227 \begin_layout Description
16228 \begin_inset Flex Code
16231 \begin_layout Plain Layout
16238 \begin_inset space ~
16242 \begin_inset space ~
16246 \begin_inset Flex Code
16249 \begin_layout Plain Layout
16255 are special cases of
16256 \begin_inset Flex Code
16259 \begin_layout Plain Layout
16266 The label will be printed above the paragraph either at the beginning of the line or centered.
16269 \begin_layout Description
16270 \begin_inset Flex Code
16273 \begin_layout Plain Layout
16279 is a special case for the caption-labels
16280 \begin_inset Quotes eld
16284 \begin_inset Quotes erd
16288 \begin_inset Quotes eld
16292 \begin_inset Quotes erd
16296 \begin_inset Newline newline
16300 \begin_inset Flex Code
16303 \begin_layout Plain Layout
16309 means the (hardcoded) label string depends on the kind of float:
16310 It is hardcoded to be `FloatType N',
16311 where N is the value of the counter associated with the float.
16312 For the case that a caption is inserted outside of a float the
16313 \begin_inset Flex Code
16316 \begin_layout Plain Layout
16323 \begin_inset Quotes eld
16327 \begin_inset Quotes erd
16333 \begin_layout Description
16334 \begin_inset Flex Code
16337 \begin_layout Plain Layout
16343 produces the usual sort of enumeration labels.
16344 The number type needs to be set in the
16350 \begin_inset CommandInset ref
16352 reference "subsec:Counters"
16360 \begin_layout Description
16361 \begin_inset Flex Code
16364 \begin_layout Plain Layout
16370 produces various bullets at the different levels.
16371 The bullet types displayed can be set via
16372 \begin_inset Flex Noun
16375 \begin_layout Plain Layout
16376 Document\SpecialChar menuseparator
16377 Settings\SpecialChar menuseparator
16386 \begin_layout Description
16387 \begin_inset Flex Code
16390 \begin_layout Plain Layout
16396 should be used only with
16397 \begin_inset Flex Code
16400 \begin_layout Plain Layout
16401 LatexType BibEnvironment
16410 \begin_layout Description
16411 \begin_inset Flex Code
16414 \begin_layout Plain Layout
16420 Note that this will completely override any prior
16421 \begin_inset Flex Code
16424 \begin_layout Plain Layout
16430 declaration for this style.
16432 \begin_inset Quotes eld
16436 \begin_inset Flex Code
16439 \begin_layout Plain Layout
16446 \begin_inset Quotes erd
16451 \begin_inset CommandInset ref
16453 reference "subsec:I18n"
16458 for details on its use.
16461 \begin_layout Description
16462 \begin_inset Flex Code
16465 \begin_layout Plain Layout
16472 \begin_inset Flex Code
16475 \begin_layout Plain Layout
16481 ] The name of the corresponding \SpecialChar LaTeX
16483 Either the environment or command name.
16486 \begin_layout Description
16487 \begin_inset Flex Code
16490 \begin_layout Plain Layout
16497 \begin_inset Flex Code
16500 \begin_layout Plain Layout
16506 ] An optional parameter for the corresponding
16507 \begin_inset Flex Code
16510 \begin_layout Plain Layout
16517 This parameter cannot be changed from within \SpecialChar LyX
16519 \begin_inset Flex Code
16522 \begin_layout Plain Layout
16528 for customizable parameters).
16529 This will be output as is after all \SpecialChar LaTeX
16531 \begin_inset Flex Code
16534 \begin_layout Plain Layout
16543 \begin_layout Description
16544 \begin_inset Flex Code
16547 \begin_layout Plain Layout
16554 \begin_inset Flex Code
16557 \begin_layout Plain Layout
16566 \begin_inset Newline newline
16575 ] How the style should be translated into \SpecialChar LaTeX
16580 \begin_layout Plain Layout
16581 \begin_inset Flex Code
16584 \begin_layout Plain Layout
16590 is perhaps a bit misleading,
16591 since these rules apply to SGML classes,
16593 Visit the SGML class files for specific examples.
16602 \begin_layout Description
16603 \begin_inset Flex Code
16606 \begin_layout Plain Layout
16612 means nothing special.
16615 \begin_layout Description
16616 \begin_inset Flex Code
16619 \begin_layout Plain Layout
16626 \begin_inset Flex Code
16629 \begin_layout Plain Layout
16636 {\SpecialChar ldots
16645 \begin_layout Description
16646 \begin_inset Flex Code
16649 \begin_layout Plain Layout
16656 \begin_inset Flex Code
16659 \begin_layout Plain Layout
16666 }\SpecialChar ldots
16682 \begin_layout Description
16683 \begin_inset Flex Code
16686 \begin_layout Plain Layout
16693 \begin_inset Flex Code
16696 \begin_layout Plain Layout
16704 \begin_inset Flex Code
16707 \begin_layout Plain Layout
16715 is generated for each paragraph of this environment.
16719 \begin_layout Description
16720 \begin_inset Flex Code
16723 \begin_layout Plain Layout
16730 \begin_inset Flex Code
16733 \begin_layout Plain Layout
16741 \begin_inset Newline newline
16745 \begin_inset Flex Code
16748 \begin_layout Plain Layout
16754 is passed as an argument to the environment.
16755 \begin_inset Newline newline
16759 \begin_inset Flex Code
16762 \begin_layout Plain Layout
16768 can be defined in the
16769 \begin_inset Flex Noun
16772 \begin_layout Plain Layout
16773 Edit\SpecialChar menuseparator
16775 \begin_inset space ~
16786 \begin_layout Description
16787 \begin_inset Flex Code
16790 \begin_layout Plain Layout
16797 \begin_inset Flex Code
16800 \begin_layout Plain Layout
16806 but adds the necessary mandatory argument (the longest label) to the begin statement of the bibliography environment:
16807 \begin_inset Newline newline
16811 \begin_inset Flex Code
16814 \begin_layout Plain Layout
16817 begin{thebibliography}{99}
16823 It is therefore only useful for bibliography environments.
16824 The default longest label
16825 \begin_inset Quotes eld
16829 \begin_inset Quotes erd
16832 can be changed by the user in the paragraph settings of a bibliography item.
16835 \begin_layout Standard
16836 Putting the last few things together,
16837 the \SpecialChar LaTeX
16838 output will be either:
16842 \begin_layout LyX-Code
16845 LatexName[LatexParam]{\SpecialChar ldots
16849 \begin_layout Standard
16854 \begin_layout LyX-Code
16857 begin{LatexName}[LatexParam] \SpecialChar ldots
16863 \begin_layout Standard
16864 depending upon the \SpecialChar LaTeX
16869 \begin_layout Description
16870 \begin_inset Flex Code
16873 \begin_layout Plain Layout
16880 \begin_inset Flex Code
16883 \begin_layout Plain Layout
16889 ] A string that is put at the beginning of the style content.
16890 A line break in the output can be indicated by
16891 \begin_inset Flex Code
16894 \begin_layout Plain Layout
16903 \begin_layout Description
16904 \begin_inset Flex Code
16907 \begin_layout Plain Layout
16914 \begin_inset Flex Code
16917 \begin_layout Plain Layout
16923 ] If you put styles into environments,
16925 \begin_inset Flex Code
16928 \begin_layout Plain Layout
16934 are not simply added,
16935 but added with a factor
16936 \begin_inset Formula $\frac{4}{\mathrm{depth}+4}$
16940 Note that this parameter is also used when
16941 \begin_inset Flex Code
16944 \begin_layout Plain Layout
16951 \begin_inset Flex Code
16954 \begin_layout Plain Layout
16961 \begin_inset Flex Code
16964 \begin_layout Plain Layout
16971 Then it is added to the manual or dynamic margin.
16972 \begin_inset Newline newline
16976 \begin_inset Quotes eld
16980 \begin_inset Flex Code
16983 \begin_layout Plain Layout
16990 \begin_inset Quotes erd
16993 means that the paragraph is indented with the width of
16994 \begin_inset Quotes eld
16998 \begin_inset Flex Code
17001 \begin_layout Plain Layout
17008 \begin_inset Quotes erd
17011 in the normal font.
17012 You can get a negative width by prefixing the string with
17013 \begin_inset Quotes eld
17017 \begin_inset Flex Code
17020 \begin_layout Plain Layout
17027 \begin_inset Quotes erd
17031 This way was chosen so that the look is the same with each used screen font.
17034 \begin_layout Description
17035 \begin_inset Flex Code
17038 \begin_layout Plain Layout
17045 \begin_inset Flex Code
17048 \begin_layout Plain Layout
17063 \begin_inset Newline newline
17066 The kind of margin that the style has on the left side.
17070 \begin_layout Description
17071 \begin_inset Flex Code
17074 \begin_layout Plain Layout
17080 just means a fixed margin.
17083 \begin_layout Description
17084 \begin_inset Flex Code
17087 \begin_layout Plain Layout
17093 means that the left margin depends on the string entered in the
17094 \begin_inset Flex Noun
17097 \begin_layout Plain Layout
17098 Edit\SpecialChar menuseparator
17100 \begin_inset space ~
17109 This is used to typeset nice lists without tabulators.
17112 \begin_layout Description
17113 \begin_inset Flex Code
17116 \begin_layout Plain Layout
17122 means that the margin depends on the size of the label.
17123 This is used for automatic enumerated headlines.
17124 It is obvious that the headline
17125 \begin_inset Quotes eld
17128 5.4.3.2.1 Very long headline
17129 \begin_inset Quotes erd
17132 must have a wider left margin (as wide as
17133 \begin_inset Quotes eld
17137 \begin_inset Quotes erd
17140 plus the space) than
17141 \begin_inset Quotes eld
17144 3.2 Very long headline
17145 \begin_inset Quotes erd
17150 \begin_inset Quotes eld
17154 \begin_inset Quotes erd
17157 are not able to do this.
17160 \begin_layout Description
17161 \begin_inset Flex Code
17164 \begin_layout Plain Layout
17171 but only the very first row of the paragraph is dynamic,
17172 while the others are static;
17178 \begin_layout Description
17179 \begin_inset Flex Code
17182 \begin_layout Plain Layout
17188 means the margin is chosen in a way that the longest row of this paragraph fits to the right margin.
17189 This is used to typeset an address on the right edge of the page.
17193 \begin_layout Description
17194 \begin_inset Flex Code
17197 \begin_layout Plain Layout
17204 \begin_inset Flex Code
17207 \begin_layout Plain Layout
17216 \begin_inset space \thinspace{}
17220 \begin_inset Flex Code
17223 \begin_layout Plain Layout
17229 ] Whether fragile commands in this style should be
17230 \begin_inset Flex Code
17233 \begin_layout Plain Layout
17247 whether this command should itself be protected.)
17248 \change_inserted -712698321 1523696949
17252 \begin_layout Description
17254 \change_inserted -712698321 1552395557
17255 \begin_inset Flex Code
17258 \begin_layout Plain Layout
17260 \change_inserted -712698321 1523696950
17269 \begin_inset Flex Code
17272 \begin_layout Plain Layout
17274 \change_inserted -712698321 1523696950
17285 \begin_inset space \thinspace{}
17289 \begin_inset Flex Code
17292 \begin_layout Plain Layout
17294 \change_inserted -712698321 1523696950
17302 ] This causes macros that contain this layout to be protected with
17303 \begin_inset Flex Code
17306 \begin_layout Plain Layout
17308 \change_inserted -712698321 1523696950
17323 ) if necessary and thus allows (some) verbatim stuff in macros.
17326 \begin_layout Description
17328 \change_inserted -712698321 1552395844
17329 \begin_inset Flex Code
17332 \begin_layout Plain Layout
17334 \change_inserted -712698321 1552395561
17343 \begin_inset Flex Code
17346 \begin_layout Plain Layout
17348 \change_inserted -712698321 1552395557
17359 \begin_inset space \thinspace{}
17363 \begin_inset Flex Code
17366 \begin_layout Plain Layout
17368 \change_inserted -712698321 1552395557
17376 ] Whether specific commands in this style (such as
17377 \begin_inset Flex Code
17380 \begin_layout Plain Layout
17382 \change_inserted -712698321 1552395655
17393 \begin_inset Flex Code
17396 \begin_layout Plain Layout
17398 \change_inserted -712698321 1552395661
17408 ) should be protected in an
17409 \begin_inset Flex Code
17412 \begin_layout Plain Layout
17414 \change_inserted -712698321 1552395631
17425 This is particularly needed for styles that draw on
17433 commands which parse their content in complex ways.
17438 \begin_layout Description
17439 \begin_inset Flex Code
17442 \begin_layout Plain Layout
17449 \begin_inset Flex Code
17452 \begin_layout Plain Layout
17459 \begin_inset space \thinspace{}
17463 \begin_inset Flex Code
17466 \begin_layout Plain Layout
17474 ] Whether newlines are translated into \SpecialChar LaTeX
17476 \begin_inset Flex Code
17479 \begin_layout Plain Layout
17490 The translation can be switched off to allow more comfortable \SpecialChar LaTeX
17491 editing inside \SpecialChar LyX
17495 \begin_layout Description
17496 \begin_inset Flex Code
17499 \begin_layout Plain Layout
17506 \begin_inset Flex Code
17509 \begin_layout Plain Layout
17518 \begin_inset space \thinspace{}
17522 \begin_inset Flex Code
17525 \begin_layout Plain Layout
17533 \begin_inset Flex Code
17536 \begin_layout Plain Layout
17543 \begin_inset Flex Code
17546 \begin_layout Plain Layout
17552 ) paragraphs are being indented,
17553 then the indentation of such a paragraph following one of this type will be suppressed.
17554 (So this will not affect the display of non-default paragraphs.)
17557 \begin_layout Description
17558 \begin_inset Flex Code
17561 \begin_layout Plain Layout
17568 \begin_inset Flex Code
17571 \begin_layout Plain Layout
17577 ] Name of a style that has replaced this style.
17578 This is used to rename a style,
17579 while keeping backward compatibility.
17582 \begin_layout Description
17583 \begin_inset Flex Code
17586 \begin_layout Plain Layout
17593 \begin_inset Flex Code
17596 \begin_layout Plain Layout
17603 \begin_inset space \thinspace{}
17607 \begin_inset Flex Code
17610 \begin_layout Plain Layout
17616 ] Determines whether consecutive paragraphs of the same type are treated as belonging together.
17617 This has the effect that the
17618 \begin_inset Flex Code
17621 \begin_layout Plain Layout
17627 is only printed once before such a group.
17630 \begin_inset Flex Code
17633 \begin_layout Plain Layout
17640 \begin_inset Flex Code
17643 \begin_layout Plain Layout
17650 \begin_inset Flex Code
17653 \begin_layout Plain Layout
17659 and false for all other types.
17662 \begin_layout Description
17663 \begin_inset Flex Code
17666 \begin_layout Plain Layout
17673 \begin_inset Flex Code
17676 \begin_layout Plain Layout
17685 \begin_inset space \thinspace{}
17689 \begin_inset Flex Code
17692 \begin_layout Plain Layout
17698 ] Indicates that paragraphs will not be separated by an empty line in \SpecialChar LaTeX
17700 but only by a line break;
17702 \begin_inset Flex Code
17705 \begin_layout Plain Layout
17712 this allows to emulate a plain text editor (like the ERT inset).
17715 \begin_layout Description
17716 \begin_inset Flex Code
17719 \begin_layout Plain Layout
17726 \begin_inset Flex Code
17729 \begin_layout Plain Layout
17735 ] The indent of the very first line of a paragraph.
17737 \begin_inset Newline newline
17741 \begin_inset Flex Code
17744 \begin_layout Plain Layout
17750 will be fixed for a certain style.
17751 The exception is the default style,
17752 since the indentation for these paragraphs can be prohibited with
17753 \begin_inset Flex Code
17756 \begin_layout Plain Layout
17765 \begin_inset Flex Code
17768 \begin_layout Plain Layout
17774 style paragraphs inside environments use the
17775 \begin_inset Flex Code
17778 \begin_layout Plain Layout
17784 of the environment,
17785 not their native one.
17788 \begin_inset Flex Code
17791 \begin_layout Plain Layout
17797 paragraphs inside an enumeration are not indented.
17800 \begin_layout Description
17801 \begin_inset Flex Code
17804 \begin_layout Plain Layout
17811 \begin_inset Flex Code
17814 \begin_layout Plain Layout
17820 ] The vertical space between two paragraphs of this style.
17823 \begin_layout Description
17824 \begin_inset Flex Code
17827 \begin_layout Plain Layout
17834 \begin_inset Flex Code
17837 \begin_layout Plain Layout
17844 allows the user to choose either
17845 \begin_inset Quotes eld
17849 \begin_inset Quotes erd
17853 \begin_inset Quotes eld
17857 \begin_inset Quotes erd
17860 to separate paragraphs.
17862 \begin_inset Quotes eld
17866 \begin_inset Quotes erd
17871 \begin_inset Flex Code
17874 \begin_layout Plain Layout
17882 \begin_inset Quotes eld
17886 \begin_inset Quotes erd
17891 \begin_inset Flex Code
17894 \begin_layout Plain Layout
17900 is ignored and all paragraphs are separated by the
17901 \begin_inset Flex Code
17904 \begin_layout Plain Layout
17911 The vertical space is calculated with
17912 \begin_inset Flex Code
17915 \begin_layout Plain Layout
17917 \begin_inset space ~
17926 \begin_inset Flex Code
17929 \begin_layout Plain Layout
17935 is the height of a row with the normal font.
17937 the look stays the same with different screen fonts.
17940 \begin_layout Description
17941 \begin_inset Flex Code
17944 \begin_layout Plain Layout
17951 \begin_inset Flex Code
17954 \begin_layout Plain Layout
17963 \begin_inset space \thinspace{}
17967 \begin_inset Flex Code
17970 \begin_layout Plain Layout
17976 ] Whether the contents of this paragraph should be output in raw form,
17977 meaning without special translations that \SpecialChar LaTeX
17981 \begin_layout Description
17982 \begin_inset Flex Code
17985 \begin_layout Plain Layout
17992 \begin_inset Flex Code
17995 \begin_layout Plain Layout
18005 Defines individual characters that should be output in raw form,
18006 meaning without special translations that \SpecialChar LaTeX
18010 \begin_layout Description
18011 \begin_inset Flex Code
18014 \begin_layout Plain Layout
18020 Information to be included in the \SpecialChar LaTeX
18021 preamble when this style is used.
18022 Used to define macros,
18025 required by this particular style.
18027 \begin_inset Quotes eld
18031 \begin_inset Flex Code
18034 \begin_layout Plain Layout
18041 \begin_inset Quotes erd
18047 \begin_layout Description
18048 \begin_inset Flex Code
18051 \begin_layout Plain Layout
18058 \begin_inset Flex Code
18061 \begin_layout Plain Layout
18067 ] The prefix to use when creating labels referring to paragraphs of this type.
18068 This allows the use of formatted references.
18071 \begin_layout Description
18072 \begin_inset Flex Code
18075 \begin_layout Plain Layout
18082 \begin_inset Flex Code
18085 \begin_layout Plain Layout
18091 ] Whether the style requires the feature
18092 \begin_inset Flex Code
18095 \begin_layout Plain Layout
18102 \begin_inset CommandInset ref
18104 reference "chap:List-of-functions"
18109 for the list of features).
18110 If you require a package with specific options,
18111 you can additionally use
18112 \begin_inset Flex Code
18115 \begin_layout Plain Layout
18121 as a general text class parameter (see
18122 \begin_inset CommandInset ref
18124 reference "subsec:General-text-class"
18132 \begin_layout Description
18133 \begin_inset Flex Code
18136 \begin_layout Plain Layout
18143 \begin_inset Flex Code
18146 \begin_layout Plain Layout
18155 \begin_inset Flex Code
18158 \begin_layout Plain Layout
18164 ] Resets the \SpecialChar LaTeX
18165 arguments of this style (as defined via the
18166 \begin_inset Flex Code
18169 \begin_layout Plain Layout
18176 This is useful if you have copied a style via
18177 \begin_inset Flex Code
18180 \begin_layout Plain Layout
18187 but you do not want to inherit its (required and optional) arguments.
18190 \begin_layout Description
18191 \begin_inset Flex Code
18194 \begin_layout Plain Layout
18201 \begin_inset Flex Code
18204 \begin_layout Plain Layout
18213 \begin_inset Flex Code
18216 \begin_layout Plain Layout
18222 ] Resumes a counter that is usually reset at each new sequence of layouts.
18223 This is currently only useful when
18224 \begin_inset Flex Code
18227 \begin_layout Plain Layout
18234 \begin_inset Flex Code
18237 \begin_layout Plain Layout
18246 \begin_layout Description
18247 \begin_inset Flex Code
18250 \begin_layout Plain Layout
18257 \begin_inset Flex Code
18260 \begin_layout Plain Layout
18266 ] A string that is put at the end of the layout content.
18267 A line break in the output can be indicated by
18268 \begin_inset Flex Code
18271 \begin_layout Plain Layout
18280 \begin_layout Description
18281 \begin_inset Flex Code
18284 \begin_layout Plain Layout
18291 \begin_inset Flex Code
18294 \begin_layout Plain Layout
18301 \begin_inset Flex Code
18304 \begin_layout Plain Layout
18313 \begin_layout Description
18314 \begin_inset Flex Code
18317 \begin_layout Plain Layout
18324 \begin_inset Flex Code
18327 \begin_layout Plain Layout
18337 \begin_inset Flex Code
18340 \begin_layout Plain Layout
18348 \begin_inset Flex Code
18351 \begin_layout Plain Layout
18359 \begin_inset Flex Code
18362 \begin_layout Plain Layout
18364 \begin_inset space ~
18372 ] This defines what the default spacing should be in the style.
18374 \begin_inset Flex Code
18377 \begin_layout Plain Layout
18385 \begin_inset Flex Code
18388 \begin_layout Plain Layout
18395 \begin_inset Flex Code
18398 \begin_layout Plain Layout
18404 correspond respectively to a multiplier value of 1,
18406 If you specify the argument
18407 \begin_inset Flex Code
18410 \begin_layout Plain Layout
18417 then you must also provide a value argument which will be the actual multiplier value.
18419 contrary to other parameters,
18421 \begin_inset Flex Code
18424 \begin_layout Plain Layout
18430 implies the generation of specific \SpecialChar LaTeX
18432 using the \SpecialChar LaTeX
18436 \begin_inset Flex Code
18439 \begin_layout Plain Layout
18448 \begin_layout Description
18449 \begin_inset Flex Code
18452 \begin_layout Plain Layout
18459 \begin_inset Flex Code
18462 \begin_layout Plain Layout
18469 \begin_inset space \thinspace{}
18473 \begin_inset Flex Code
18476 \begin_layout Plain Layout
18484 ] Allow spell-checking paragraphs of this style.
18488 \begin_layout Description
18489 \begin_inset Flex Code
18492 \begin_layout Plain Layout
18494 \change_deleted 731793113 1604355211
18496 \change_inserted 731793113 1604355212
18505 \begin_inset Flex Code
18508 \begin_layout Plain Layout
18517 \begin_inset Flex Code
18520 \begin_layout Plain Layout
18527 \change_deleted 731793113 1604355214
18529 \change_inserted 731793113 1604355216
18532 counter of a given counter at the beginning of a new sequence of layouts.
18533 This is currently only useful when
18534 \begin_inset Flex Code
18537 \begin_layout Plain Layout
18544 \begin_inset Flex Code
18547 \begin_layout Plain Layout
18556 \begin_layout Description
18557 \begin_inset Flex Code
18560 \begin_layout Plain Layout
18566 The font used for the text body .
18568 \begin_inset CommandInset ref
18570 reference "subsec:Font-description"
18578 \begin_layout Description
18579 \begin_inset Flex Code
18582 \begin_layout Plain Layout
18591 \begin_inset Flex Code
18594 \begin_layout Plain Layout
18604 The level of the style in the table of contents.
18605 This is used for automatic numbering of section headings.
18608 \begin_layout Description
18609 \begin_inset Flex Code
18612 \begin_layout Plain Layout
18621 \begin_inset Flex Code
18624 \begin_layout Plain Layout
18636 \begin_inset Flex Code
18639 \begin_layout Plain Layout
18647 \begin_inset Flex Code
18650 \begin_layout Plain Layout
18656 ] This tag determines whether the first line indentation of this paragraph can be toggled via the Paragraph settings dialog.
18660 \begin_inset Flex Code
18663 \begin_layout Plain Layout
18674 indentation can be toggled if the document settings use
18675 \begin_inset Quotes eld
18679 \begin_inset Quotes erd
18684 \begin_inset Flex Code
18687 \begin_layout Plain Layout
18694 indentation can always be toggled,
18695 notwithstanding the document settings,
18697 \begin_inset Flex Code
18700 \begin_layout Plain Layout
18707 indentation can never be toggled.
18710 \begin_layout Description
18711 \begin_inset Flex Code
18714 \begin_layout Plain Layout
18721 \begin_inset Flex Code
18724 \begin_layout Plain Layout
18730 ] The vertical space with which the very first of a chain of paragraphs with this style is separated from the previous paragraph.
18731 If the previous paragraph has another style,
18732 the separations are not simply added,
18733 but the maximum is taken.
18736 \begin_layout Subsection
18737 \begin_inset CommandInset label
18743 Internationalization of Paragraph Styles
18746 \begin_layout Standard
18748 has long supported internationalization of layout information,
18751 this applied only to the user interface and not to,
18755 French authors were forced to resort to ugly hacks if they wanted `
18759 1' instead of `Theorem 1'.
18760 Thanks to Georg Baum,
18761 that is no longer the case.
18764 \begin_layout Standard
18766 \begin_inset Flex Code
18769 \begin_layout Plain Layout
18775 defines text that is to appear in the typeset document,
18777 \begin_inset Flex Code
18780 \begin_layout Plain Layout
18787 \begin_inset Flex Code
18790 \begin_layout Plain Layout
18796 to support non-English and even multi-language documents correctly.
18797 The following excerpt (from the
18798 \begin_inset Flex Code
18801 \begin_layout Plain Layout
18807 file) shows how this works:
18810 \begin_layout LyX-Code
18815 \begin_layout LyX-Code
18818 theoremstyle{remark}
18821 \begin_layout LyX-Code
18824 newtheorem{claim}[thm]{
18831 \begin_layout LyX-Code
18835 \begin_layout LyX-Code
18839 \begin_layout LyX-Code
18844 claimname}{_(Claim)}
18847 \begin_layout LyX-Code
18851 \begin_layout LyX-Code
18855 \begin_layout LyX-Code
18864 claimname}{_(Claim)}}
18867 \begin_layout LyX-Code
18872 \begin_layout Standard
18874 any legal \SpecialChar LaTeX
18876 \begin_inset Flex Code
18879 \begin_layout Plain Layout
18886 \begin_inset Flex Code
18889 \begin_layout Plain Layout
18896 but in practice they will typically look as they do here.
18897 The key to correct translation of the typeset text is the definition of the \SpecialChar LaTeX
18899 \begin_inset Flex Code
18902 \begin_layout Plain Layout
18911 \begin_inset Flex Code
18914 \begin_layout Plain Layout
18926 \begin_layout Standard
18928 \begin_inset Flex Code
18931 \begin_layout Plain Layout
18937 tag provides for internationalization based upon the overall language of the document.
18938 The contents of the tag will be included in the preamble,
18940 \begin_inset Flex Code
18943 \begin_layout Plain Layout
18950 What makes it special is the use of the
18951 \begin_inset Quotes eld
18955 \begin_inset Quotes erd
18959 \begin_inset Flex Code
18962 \begin_layout Plain Layout
18969 which will be replaced,
18970 when \SpecialChar LyX
18971 produces \SpecialChar LaTeX
18973 with the translation of its argument into the document language.
18976 \begin_layout Standard
18978 \begin_inset Flex Code
18981 \begin_layout Plain Layout
18987 tag is more complex,
18988 since it is meant to provide support for multi-language documents and so offers an interface to the
18989 \begin_inset Flex Code
18992 \begin_layout Plain Layout
18999 Its contents will be added to the preamble once for each language that appears in the document.
19002 \begin_inset Flex Code
19005 \begin_layout Plain Layout
19011 will be replaced with its translation into the language in question;
19013 \begin_inset Flex Code
19016 \begin_layout Plain Layout
19022 is replaced by the language name (as used by the babel package).
19025 \begin_layout Standard
19026 A German document that also included a French section would thus have the following in the preamble:
19029 \begin_layout LyX-Code
19038 claimname}{Affirmation}}
19039 \begin_inset Newline newline
19050 claimname}{Behauptung}}
19051 \begin_inset Newline newline
19058 claimname}{Behauptung}
19061 \begin_layout Standard
19064 \begin_inset Flex Code
19067 \begin_layout Plain Layout
19073 will then conspire to produce the correct text in the output.
19076 \begin_layout Standard
19077 One important point to note here is that the translations are provided by \SpecialChar LyX
19080 \begin_inset Flex Code
19083 \begin_layout Plain Layout
19093 \begin_inset Flex Code
19096 \begin_layout Plain Layout
19103 \begin_inset Flex Code
19106 \begin_layout Plain Layout
19112 are really only of use in layout files that are provided with \SpecialChar LyX
19114 since text entered in user-created layout files will not be seen by \SpecialChar LyX
19115 's internationalization routines unless the
19116 \begin_inset Flex Code
19119 \begin_layout Plain Layout
19125 file is modified accordingly.
19128 any layout created with the intention that it will be included with \SpecialChar LyX
19129 should use these tags where appropriate.
19130 Please note that the paragraph style translations provided by \SpecialChar LyX
19131 will never change with a minor update (e.
19132 \begin_inset space \thinspace{}
19136 \begin_inset space \space{}
19139 from version 2.1.x to 2.1.y).
19140 It is however quite likely that a major update (e.
19141 \begin_inset space \thinspace{}
19145 \begin_inset space \space{}
19148 from 2.0.x to 2.1.0) will introduce new translations or corrections.
19151 \begin_layout Subsection
19153 \begin_inset CommandInset label
19155 name "subsec:Floats"
19162 \begin_layout Standard
19163 It is necessary to define the floats (
19164 \begin_inset Flex Noun
19167 \begin_layout Plain Layout
19175 \begin_inset Flex Noun
19178 \begin_layout Plain Layout
19186 ) in the text class itself.
19187 Standard floats are included in the file
19188 \begin_inset Flex Code
19191 \begin_layout Plain Layout
19198 so you may have to do no more than add
19201 \begin_layout LyX-Code
19202 Input stdfloats.inc
19205 \begin_layout Standard
19206 to your layout file.
19207 If you want to implement a text class that proposes some other float types (like the AGU class bundled with \SpecialChar LyX
19209 the information below will hopefully help you:
19212 \begin_layout Description
19213 \begin_inset Flex Code
19216 \begin_layout Plain Layout
19223 \begin_inset Flex Code
19226 \begin_layout Plain Layout
19232 =!htbpH] Allowed placement options for this float type.
19233 The value is a string of placement characters.
19234 Possible characters include:
19240 \begin_inset Quotes eld
19244 \begin_inset Quotes erd
19253 \begin_inset Quotes eld
19257 \begin_inset Quotes erd
19266 \begin_inset Quotes eld
19270 \begin_inset Quotes erd
19279 \begin_inset Quotes eld
19283 \begin_inset Quotes erd
19292 \begin_inset Quotes eld
19296 \begin_inset Quotes erd
19305 \begin_inset Quotes eld
19309 \begin_inset Quotes erd
19313 The order of the characters in the string does not matter.
19314 If no placement options are allowed,
19322 \begin_layout Description
19323 \begin_inset Flex Code
19326 \begin_layout Plain Layout
19333 \begin_inset Flex Code
19336 \begin_layout Plain Layout
19345 \begin_inset space \thinspace{}
19351 \begin_inset Flex Code
19354 \begin_layout Plain Layout
19364 ] Defines whether the float allows to be rotated via the \SpecialChar LaTeX
19371 \begin_inset Flex Code
19374 \begin_layout Plain Layout
19380 if the float does not support this feature.
19383 \begin_layout Description
19384 \begin_inset Flex Code
19387 \begin_layout Plain Layout
19394 \begin_inset Flex Code
19397 \begin_layout Plain Layout
19406 \begin_inset space \thinspace{}
19412 \begin_inset Flex Code
19415 \begin_layout Plain Layout
19425 ] Defines whether the float has a starred variant that spans columns in a two column paragraph.
19427 \begin_inset Flex Code
19430 \begin_layout Plain Layout
19436 if the float does not support this feature.
19439 \begin_layout Description
19440 \begin_inset Flex Code
19443 \begin_layout Plain Layout
19450 \begin_inset Flex Code
19453 \begin_layout Plain Layout
19460 \begin_inset Quotes erd
19464 \begin_inset Quotes erd
19467 ] The file name extension of an auxiliary file for the list of figures (or whatever).
19469 writes the captions to this file.
19472 \begin_layout Description
19473 \begin_inset Flex Code
19476 \begin_layout Plain Layout
19483 \begin_inset Flex Code
19486 \begin_layout Plain Layout
19493 \begin_inset Quotes erd
19497 \begin_inset Quotes erd
19500 ] The string that will be used in the menus and also for the caption.
19501 This is translated to the current language if babel is used.
19504 \begin_layout Description
19505 \begin_inset Flex Code
19508 \begin_layout Plain Layout
19514 These tags control the XHTML output.
19516 \begin_inset CommandInset ref
19518 reference "sec:Tags-for-XHTML"
19526 \begin_layout Description
19527 \begin_inset Flex Code
19530 \begin_layout Plain Layout
19539 \begin_inset Flex Code
19542 \begin_layout Plain Layout
19551 \begin_inset space \thinspace{}
19555 \begin_inset Flex Code
19558 \begin_layout Plain Layout
19564 ] Indicates whether the float is already defined in the document class or if instead the \SpecialChar LaTeX
19566 \begin_inset Flex Code
19569 \begin_layout Plain Layout
19575 needs to be loaded to define it on-the-fly.
19577 \begin_inset Flex Code
19580 \begin_layout Plain Layout
19589 \begin_inset Flex Code
19592 \begin_layout Plain Layout
19599 It should be set to
19600 \begin_inset Flex Code
19603 \begin_layout Plain Layout
19609 if the float is already defined by the \SpecialChar LaTeX
19613 \begin_layout Description
19614 \begin_inset Flex Code
19617 \begin_layout Plain Layout
19624 \begin_inset Flex Code
19627 \begin_layout Plain Layout
19634 \begin_inset Quotes erd
19638 \begin_inset Quotes erd
19641 ] The command used to generate a list of floats of this type;
19650 \begin_inset Flex Code
19653 \begin_layout Plain Layout
19660 since there is no standard way to generate this command.
19662 \begin_inset Flex Code
19665 \begin_layout Plain Layout
19672 since in that case there is a standard way to define the command.
19675 \begin_layout Description
19676 \begin_inset Flex Code
19679 \begin_layout Plain Layout
19686 \begin_inset Flex Code
19689 \begin_layout Plain Layout
19696 \begin_inset Quotes erd
19700 \begin_inset Quotes erd
19703 ] A title for a list of floats of this kind (list of figures,
19706 It is used for the screen label within \SpecialChar LyX
19708 it is used by \SpecialChar LaTeX
19709 for the title and it is used as the title in the XHTML output.
19710 It will be translated to the document language.
19713 \begin_layout Description
19714 \begin_inset Flex Code
19717 \begin_layout Plain Layout
19724 \begin_inset Flex Code
19727 \begin_layout Plain Layout
19734 \begin_inset Quotes erd
19738 \begin_inset Quotes erd
19741 ] This (optional) argument determines whether floats of this class will be numbered within some sectional unit of the document.
19744 \begin_inset Flex Code
19747 \begin_layout Plain Layout
19754 \begin_inset Quotes eld
19758 \begin_inset Flex Code
19761 \begin_layout Plain Layout
19768 \begin_inset Quotes erd
19772 the floats will be numbered within chapters.
19776 \begin_layout Description
19777 \begin_inset Flex Code
19780 \begin_layout Plain Layout
19787 \begin_inset Flex Code
19790 \begin_layout Plain Layout
19797 \begin_inset Quotes erd
19801 \begin_inset Quotes erd
19804 ] The default placement for the given class of floats.
19805 The string should be as in standard \SpecialChar LaTeX
19808 \begin_inset Flex Code
19811 \begin_layout Plain Layout
19819 \begin_inset Flex Code
19822 \begin_layout Plain Layout
19830 \begin_inset Flex Code
19833 \begin_layout Plain Layout
19840 \begin_inset Flex Code
19843 \begin_layout Plain Layout
19857 \begin_layout Plain Layout
19858 Note that the order of these letters in the string is irrelevant,
19859 like in \SpecialChar LaTeX
19865 On top of that there is a new type,
19867 \begin_inset Flex Code
19870 \begin_layout Plain Layout
19877 which does not really correspond to a float,
19880 \begin_inset Quotes eld
19884 \begin_inset Quotes erd
19888 Note however that the
19889 \begin_inset Flex Code
19892 \begin_layout Plain Layout
19898 specifier is special and,
19899 because of implementation details,
19900 cannot be used in non-built in float types.
19901 If you do not understand what this means,
19903 \begin_inset Quotes eld
19907 \begin_inset Flex Code
19910 \begin_layout Plain Layout
19917 \begin_inset Quotes erd
19923 \begin_layout Description
19924 \begin_inset Flex Code
19927 \begin_layout Plain Layout
19934 \begin_inset Flex Code
19937 \begin_layout Plain Layout
19943 ] The prefix to use when creating labels referring to floats of this type.
19944 This allows the use of formatted references.
19945 Note that you can remove any
19946 \begin_inset Flex Code
19949 \begin_layout Plain Layout
19955 set by a copied style by using the special value
19956 \begin_inset Quotes eld
19960 \begin_inset Quotes erd
19964 which must be all caps.
19965 \change_inserted -712698321 1565605014
19969 \begin_layout Description
19971 \change_inserted -712698321 1565605014
19972 \begin_inset Flex Code
19975 \begin_layout Plain Layout
19977 \change_inserted -712698321 1565605014
19986 \begin_inset Flex Code
19989 \begin_layout Plain Layout
19991 \change_inserted -712698321 1565605014
19999 ] As with paragraph styles,
20001 \begin_inset CommandInset ref
20003 reference "subsec:Paragraph-Styles"
20013 \begin_layout Description
20014 \begin_inset Flex Code
20017 \begin_layout Plain Layout
20024 \begin_inset Flex Code
20027 \begin_layout Plain Layout
20034 \begin_inset Quotes erd
20038 \begin_inset Quotes erd
20041 ] The style used when defining the float using
20042 \begin_inset Flex Code
20045 \begin_layout Plain Layout
20056 \begin_layout Description
20057 \begin_inset Flex Code
20060 \begin_layout Plain Layout
20067 \begin_inset Flex Code
20070 \begin_layout Plain Layout
20077 \begin_inset Quotes erd
20081 \begin_inset Quotes erd
20085 \begin_inset Quotes eld
20089 \begin_inset Quotes erd
20092 of the new class of floats,
20093 like program or algorithm.
20094 After the appropriate
20095 \begin_inset Flex Code
20098 \begin_layout Plain Layout
20108 \begin_inset Flex Code
20111 \begin_layout Plain Layout
20120 \begin_inset Flex Code
20123 \begin_layout Plain Layout
20134 \begin_layout Description
20135 \begin_inset Flex Code
20138 \begin_layout Plain Layout
20145 \begin_inset Flex Code
20148 \begin_layout Plain Layout
20155 \begin_inset space \thinspace{}
20159 \begin_inset Flex Code
20162 \begin_layout Plain Layout
20170 ] Specifies whether this float is defined using the \SpecialChar LaTeX
20172 \begin_inset Flex Code
20175 \begin_layout Plain Layout
20182 either by the class file,
20183 another package or on-the-fly by \SpecialChar LyX
20187 \begin_layout Standard
20188 Note that defining a float with type
20189 \begin_inset Flex Code
20192 \begin_layout Plain Layout
20200 automatically defines the corresponding counter with name
20201 \begin_inset Flex Code
20204 \begin_layout Plain Layout
20215 \begin_layout Subsection
20216 Flex insets and InsetLayout
20217 \begin_inset CommandInset label
20219 name "subsec:Flex-insets-and"
20226 \begin_layout Standard
20227 Flex insets come in
20228 \change_deleted 5863208 1594239511
20230 \change_inserted 5863208 1594239512
20237 \begin_layout Itemize
20239 \begin_inset Flex Code
20242 \begin_layout Plain Layout
20249 These define semantic markup corresponding to such \SpecialChar LaTeX
20251 \begin_inset Flex Code
20254 \begin_layout Plain Layout
20263 \begin_inset Flex Code
20266 \begin_layout Plain Layout
20277 \begin_layout Itemize
20279 \begin_inset Flex Code
20282 \begin_layout Plain Layout
20289 These can be used to define custom collapsible insets,
20290 similar to \SpecialChar TeX
20294 An obvious example is an endnote inset,
20295 which is defined in the
20296 \begin_inset Flex Code
20299 \begin_layout Plain Layout
20308 \begin_layout Itemize
20310 \change_deleted 5863208 1594239528
20312 \begin_inset Flex Code
20315 \begin_layout Plain Layout
20322 For use with DocBook classes.
20327 \begin_layout Standard
20328 Flex insets are defined using the
20329 \begin_inset Flex Code
20332 \begin_layout Plain Layout
20339 which shall be explained in a moment.
20342 \begin_layout Standard
20344 \begin_inset Flex Code
20347 \begin_layout Plain Layout
20353 tag also serves another function:
20354 It can be used to customize the general layout of many different types of insets.
20357 \begin_inset Flex Code
20360 \begin_layout Plain Layout
20366 can be used to customize the layout parameters for footnotes,
20379 as well as to define Flex insets.
20382 \begin_layout Standard
20384 \begin_inset Flex Code
20387 \begin_layout Plain Layout
20393 definition must begin with a line of the form:
20396 \begin_layout LyX-Code
20400 \begin_layout Standard
20402 \begin_inset Flex Code
20405 \begin_layout Plain Layout
20411 indicates the inset whose layout is being defined,
20412 and here there are four cases.
20415 \begin_layout Enumerate
20416 The layout for a pre-existing inset is being modified.
20419 \begin_inset Flex Code
20422 \begin_layout Plain Layout
20428 any one of the following:
20430 \begin_inset Flex Code
20433 \begin_layout Plain Layout
20441 \begin_inset Flex Code
20444 \begin_layout Plain Layout
20452 \begin_inset Flex Code
20455 \begin_layout Plain Layout
20463 \begin_inset Flex Code
20466 \begin_layout Plain Layout
20474 \begin_inset Flex Code
20477 \begin_layout Plain Layout
20485 \begin_inset Flex Code
20488 \begin_layout Plain Layout
20496 \begin_inset Flex Code
20499 \begin_layout Plain Layout
20507 \begin_inset Flex Code
20510 \begin_layout Plain Layout
20518 \begin_inset Flex Code
20521 \begin_layout Plain Layout
20529 \begin_inset Flex Code
20532 \begin_layout Plain Layout
20540 \begin_inset Flex Code
20543 \begin_layout Plain Layout
20551 \begin_inset Flex Code
20554 \begin_layout Plain Layout
20562 \begin_inset Flex Code
20565 \begin_layout Plain Layout
20573 \begin_inset Flex Code
20576 \begin_layout Plain Layout
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
20651 \begin_layout Enumerate
20652 The layout for a Flex inset is being defined.
20655 \begin_inset Flex Code
20658 \begin_layout Plain Layout
20664 must be of the form
20665 \begin_inset Quotes eld
20669 \begin_inset Flex Code
20672 \begin_layout Plain Layout
20679 \begin_inset Quotes erd
20684 \begin_inset Flex Code
20687 \begin_layout Plain Layout
20693 may be any valid identifier not used by a pre-existing Flex inset.
20694 The identifier may include spaces,
20695 but in that case the whole thing must be wrapped in quotes.
20696 Note that the definition of a flex inset
20701 \begin_inset Flex Code
20704 \begin_layout Plain Layout
20711 declaring which type of inset it defines.
20714 \begin_layout Enumerate
20715 The layout for user specific branch is being defined.
20718 \begin_inset Flex Code
20721 \begin_layout Plain Layout
20727 must be of the form
20728 \begin_inset Quotes eld
20732 \begin_inset Flex Code
20735 \begin_layout Plain Layout
20742 \begin_inset Quotes erd
20747 \begin_inset Flex Code
20750 \begin_layout Plain Layout
20756 may be any valid identifier of branch defined in user's document.
20757 The identifier may include spaces,
20758 but in that case the whole thing must be wrapped in quotes.
20759 The main purpose of this feature is to allow \SpecialChar LaTeX
20760 wrapping around specific branches as user needs.
20763 \begin_layout Enumerate
20764 The layout of a user (or class) specific caption is being defined.
20767 \begin_inset Flex Code
20770 \begin_layout Plain Layout
20776 must be of the form
20777 \begin_inset Quotes eld
20781 \begin_inset Flex Code
20784 \begin_layout Plain Layout
20791 \begin_inset Quotes erd
20796 \begin_inset Flex Code
20799 \begin_layout Plain Layout
20805 specifies the name of the caption as it appears in the menu.
20806 Have a look at the standard caption (
20807 \begin_inset Flex Code
20810 \begin_layout Plain Layout
20817 the specific captions of the KOMA-Script classes (
20818 \begin_inset Flex Code
20821 \begin_layout Plain Layout
20829 \begin_inset Flex Code
20832 \begin_layout Plain Layout
20841 \begin_inset space ~
20845 \begin_inset Newline linebreak
20851 \begin_inset Flex Code
20854 \begin_layout Plain Layout
20860 ) for applications.
20863 \begin_layout Standard
20865 \begin_inset Flex Code
20868 \begin_layout Plain Layout
20874 definition can contain the following entries:
20877 \begin_layout Description
20878 \begin_inset Flex Code
20881 \begin_layout Plain Layout
20888 \begin_inset Flex Code
20891 \begin_layout Plain Layout
20897 =""] This inset will appear in the table of contents of the given type.
20898 An empty string disables.
20899 See also the OutlinerName and the IsTocCaption commands.
20900 This is only implemented for Flex insets.
20905 \begin_layout Description
20906 \begin_inset Flex Code
20909 \begin_layout Plain Layout
20916 \begin_inset Flex Code
20919 \begin_layout Plain Layout
20925 ] Defines argument number of a command\SpecialChar breakableslash
20926 environment associated with the current layout.
20927 The definition must end with
20928 \begin_inset Flex Code
20931 \begin_layout Plain Layout
20939 \change_inserted -584632292 1615846847
20941 \begin_inset CommandInset ref
20943 reference "subsec:Arguments"
20952 \change_deleted -584632292 1615846847
20954 \begin_inset CommandInset ref
20956 reference "subsec:Paragraph-Styles"
20964 \change_deleted -584632292 1615846902
20966 \change_inserted -584632292 1615846906
20972 \begin_layout Description
20973 \begin_inset Flex Code
20976 \begin_layout Plain Layout
20982 Preamble for changing language commands;
20984 \begin_inset CommandInset ref
20986 reference "subsec:I18n"
20994 \begin_layout Description
20995 \begin_inset Flex Code
20998 \begin_layout Plain Layout
21005 \begin_inset Flex Code
21008 \begin_layout Plain Layout
21014 ] The color for the inset's background.
21016 \begin_inset CommandInset ref
21018 reference "chap:Names-of-colors"
21023 for a list of the available color names.
21026 \begin_layout Description
21027 \begin_inset Flex Code
21030 \begin_layout Plain Layout
21037 \begin_inset Flex Code
21040 \begin_layout Plain Layout
21049 \begin_inset space \thinspace{}
21053 \begin_inset Flex Code
21056 \begin_layout Plain Layout
21062 ] Whether to use the content of the inset as the label,
21063 when the inset is closed.
21067 \begin_layout Description
21068 \begin_inset Flex Code
21071 \begin_layout Plain Layout
21078 \begin_inset Flex Code
21081 \begin_layout Plain Layout
21087 ] As with paragraph styles,
21089 \begin_inset CommandInset ref
21091 reference "subsec:Paragraph-Styles"
21097 Note that you need to specify the complete type,
21099 \begin_inset space \thinspace{}
21103 \begin_inset space ~
21107 \begin_inset Flex Code
21110 \begin_layout Plain Layout
21111 CopyStyle Flex:<name>
21119 \begin_layout Description
21120 \begin_inset Flex Code
21123 \begin_layout Plain Layout
21130 \begin_inset Flex Code
21133 \begin_layout Plain Layout
21142 \begin_inset space \thinspace{}
21146 \begin_inset Flex Code
21149 \begin_layout Plain Layout
21155 ] Indicates whether the user may employ the Paragraph Settings dialog to customize the paragraph.
21158 \begin_layout Description
21159 \begin_inset Flex Code
21162 \begin_layout Plain Layout
21169 \begin_inset Flex Code
21172 \begin_layout Plain Layout
21180 \begin_inset Flex Code
21183 \begin_layout Plain Layout
21191 \begin_inset Flex Code
21194 \begin_layout Plain Layout
21201 describing the rendering style used for the inset's frame and buttons.
21202 Footnotes generally use
21203 \begin_inset Flex Code
21206 \begin_layout Plain Layout
21213 ERT insets generally
21214 \begin_inset Flex Code
21217 \begin_layout Plain Layout
21224 and character styles
21225 \begin_inset Flex Code
21228 \begin_layout Plain Layout
21237 \begin_layout Description
21238 \begin_inset Flex Code
21241 \begin_layout Plain Layout
21248 \begin_inset Flex Code
21251 \begin_layout Plain Layout
21260 \begin_inset space \thinspace{}
21266 \begin_inset Flex Code
21269 \begin_layout Plain Layout
21278 \begin_inset Flex Code
21281 \begin_layout Plain Layout
21288 \begin_inset Flex Code
21291 \begin_layout Plain Layout
21298 Indicates whether the environment will stand on its own in the output or will appear inline with the surrounding text.
21300 it is supposed that the \SpecialChar LaTeX
21301 environment ignores white space (including one newline character) after the
21302 \begin_inset Flex Code
21305 \begin_layout Plain Layout
21318 \begin_inset Flex Code
21321 \begin_layout Plain Layout
21335 \change_inserted 731793113 1538674858
21339 \begin_layout Description
21341 \change_inserted 731793113 1538674891
21342 \begin_inset Flex Code
21345 \begin_layout Plain Layout
21347 \change_inserted 731793113 1538674863
21359 ,1] Allow the contents of the inset to be edited externally (using whatever editor is defined for the document's output format).
21364 \begin_layout Description
21365 \begin_inset Flex Code
21368 \begin_layout Plain Layout
21374 Required at the end of the
21375 \begin_inset Flex Code
21378 \begin_layout Plain Layout
21387 \begin_layout Description
21388 \begin_inset Flex Code
21391 \begin_layout Plain Layout
21397 The font used for both the text body
21403 \begin_inset CommandInset ref
21405 reference "subsec:Font-description"
21411 Note that defining this font automatically defines the
21412 \begin_inset Flex Code
21415 \begin_layout Plain Layout
21422 so define this first and define
21423 \begin_inset Flex Code
21426 \begin_layout Plain Layout
21432 later if you want them to be different.
21435 \begin_layout Description
21436 \begin_inset Flex Code
21439 \begin_layout Plain Layout
21440 FixedWidthPreambleEncoding
21446 \begin_inset Flex Code
21449 \begin_layout Plain Layout
21458 \begin_inset space \thinspace{}
21462 \begin_inset Flex Code
21465 \begin_layout Plain Layout
21471 ] Force a fixed width encoding for the translated contents of
21472 \begin_inset Flex Code
21475 \begin_layout Plain Layout
21482 \begin_inset Flex Code
21485 \begin_layout Plain Layout
21491 code generated by this layout.
21492 This is needed for special \SpecialChar LaTeX
21497 that do not work with variable width encodings such as
21502 This setting is ignored if fully Unicode aware \SpecialChar LaTeX
21503 backends such as Xe\SpecialChar TeX
21504 or Lua\SpecialChar TeX
21508 \begin_layout Description
21509 \begin_inset Flex Code
21512 \begin_layout Plain Layout
21513 ForceLocalFontSwitch
21519 \begin_inset Flex Code
21522 \begin_layout Plain Layout
21531 \begin_inset space \thinspace{}
21535 \begin_inset Flex Code
21538 \begin_layout Plain Layout
21544 ] When using babel,
21545 always use a local font switch (
21546 \begin_inset Flex Code
21549 \begin_layout Plain Layout
21558 never a global one (such as
21559 \begin_inset Flex Code
21562 \begin_layout Plain Layout
21573 \begin_layout Description
21574 \begin_inset Flex Code
21577 \begin_layout Plain Layout
21584 \begin_inset Flex Code
21587 \begin_layout Plain Layout
21596 \begin_inset space \thinspace{}
21600 \begin_inset Flex Code
21603 \begin_layout Plain Layout
21610 \begin_inset Quotes eld
21614 \begin_inset Quotes erd
21618 leading to Left-to-Right (Latin) output,
21620 \begin_inset space \thinspace{}
21624 \begin_inset space \space{}
21627 in \SpecialChar TeX
21632 \begin_layout Description
21633 \begin_inset Flex Code
21636 \begin_layout Plain Layout
21643 \begin_inset Flex Code
21646 \begin_layout Plain Layout
21655 \begin_inset space \thinspace{}
21659 \begin_inset Flex Code
21662 \begin_layout Plain Layout
21668 ] Force a line break in the \SpecialChar LaTeX
21669 output before the inset starts and after the inset ends.
21670 This assures the inset itself is output on its own lines,
21671 for parsing purposes.
21674 \begin_layout Description
21675 \begin_inset Flex Code
21678 \begin_layout Plain Layout
21685 \begin_inset Flex Code
21688 \begin_layout Plain Layout
21697 \begin_inset space \thinspace{}
21701 \begin_inset Flex Code
21704 \begin_layout Plain Layout
21710 ] Indicates whether the
21711 \begin_inset Flex Code
21714 \begin_layout Plain Layout
21722 the user can change the paragraph style used in the inset.
21726 \begin_layout Description
21727 \begin_inset Flex Code
21730 \begin_layout Plain Layout
21737 \begin_inset Flex Code
21740 \begin_layout Plain Layout
21749 \begin_inset space \thinspace{}
21753 \begin_inset Flex Code
21756 \begin_layout Plain Layout
21762 ] As with paragraph styles,
21764 \begin_inset CommandInset ref
21766 reference "subsec:Paragraph-Styles"
21774 \begin_layout Description
21775 \begin_inset Flex Code
21778 \begin_layout Plain Layout
21784 These tags control the XHTML output.
21786 \begin_inset CommandInset ref
21788 reference "sec:Tags-for-XHTML"
21796 \begin_layout Description
21797 \begin_inset Flex Code
21800 \begin_layout Plain Layout
21807 \begin_inset Flex Code
21810 \begin_layout Plain Layout
21819 \begin_inset space \thinspace{}
21823 \begin_inset Flex Code
21826 \begin_layout Plain Layout
21832 ] Whether to include the contents of this inset in the strings generated for the `Outline' pane for all table of contents,
21833 regardless of the AddToToc setting.
21836 want the content of a footnote in a section header to be included in the TOC displayed in the outline,
21837 but one would normally want the content of a character style displayed.
21842 \begin_layout Description
21843 \begin_inset Flex Code
21846 \begin_layout Plain Layout
21853 \begin_inset Flex Code
21856 \begin_layout Plain Layout
21865 \begin_inset space \thinspace{}
21869 \begin_inset Flex Code
21872 \begin_layout Plain Layout
21878 ] If this is set to 1 and AddToToc is enabled,
21879 the inset adds a summary of its contents in its item in the table of contents.
21881 only the label appears.
21884 \begin_layout Description
21885 \begin_inset Flex Code
21888 \begin_layout Plain Layout
21897 \begin_inset Flex Code
21900 \begin_layout Plain Layout
21909 \begin_inset space \thinspace{}
21913 \begin_inset Flex Code
21916 \begin_layout Plain Layout
21922 ] As with paragraph styles,
21924 \begin_inset CommandInset ref
21926 reference "subsec:Paragraph-Styles"
21934 \begin_layout Description
21935 \begin_inset Flex Code
21938 \begin_layout Plain Layout
21944 The font used for the label.
21946 \begin_inset CommandInset ref
21948 reference "subsec:Font-description"
21954 Note that this definition can never appear before
21955 \begin_inset Flex Code
21958 \begin_layout Plain Layout
21965 lest it be ineffective.
21968 \begin_layout Description
21969 \begin_inset Flex Code
21972 \begin_layout Plain Layout
21979 \begin_inset Flex Code
21982 \begin_layout Plain Layout
21989 \begin_inset Quotes erd
21993 \begin_inset Quotes erd
21996 ] What will be displayed on the button or elsewhere as the inset label.
21998 \begin_inset Flex Code
22001 \begin_layout Plain Layout
22009 \begin_inset Flex Code
22012 \begin_layout Plain Layout
22018 ) modify this label on the fly.
22021 \begin_layout Description
22022 \begin_inset Flex Code
22025 \begin_layout Plain Layout
22031 Language dependent preamble;
22033 \begin_inset CommandInset ref
22035 reference "subsec:I18n"
22043 \begin_layout Description
22044 \begin_inset Flex Code
22047 \begin_layout Plain Layout
22054 \begin_inset Flex Code
22057 \begin_layout Plain Layout
22063 ] The name of the corresponding \SpecialChar LaTeX
22065 Either the environment or command name.
22068 \begin_layout Description
22069 \begin_inset Flex Code
22072 \begin_layout Plain Layout
22079 \begin_inset Flex Code
22082 \begin_layout Plain Layout
22088 ] The optional parameter for the corresponding
22089 \begin_inset Flex Code
22092 \begin_layout Plain Layout
22099 including possible bracket pairs like
22100 \begin_inset Flex Code
22103 \begin_layout Plain Layout
22110 This parameter cannot be changed from within \SpecialChar LyX
22112 \begin_inset Flex Code
22115 \begin_layout Plain Layout
22121 for customizable parameters).
22122 It will be output as is after all \SpecialChar LaTeX
22124 \begin_inset Flex Code
22127 \begin_layout Plain Layout
22136 \begin_layout Description
22137 \begin_inset Flex Code
22140 \begin_layout Plain Layout
22147 \begin_inset Flex Code
22150 \begin_layout Plain Layout
22158 ] How the style should be translated into \SpecialChar LaTeX
22163 \begin_layout Plain Layout
22164 \begin_inset Flex Code
22167 \begin_layout Plain Layout
22173 is perhaps a bit misleading,
22174 since these rules apply to SGML classes too.
22175 Visit the SGML class files for specific examples.
22184 \begin_layout Description
22185 \begin_inset Flex Code
22188 \begin_layout Plain Layout
22194 means nothing special
22197 \begin_layout Description
22198 \begin_inset Flex Code
22201 \begin_layout Plain Layout
22208 \begin_inset Flex Code
22211 \begin_layout Plain Layout
22218 {\SpecialChar ldots
22227 \begin_layout Description
22228 \begin_inset Flex Code
22231 \begin_layout Plain Layout
22238 \begin_inset Flex Code
22241 \begin_layout Plain Layout
22248 }\SpecialChar ldots
22263 \begin_layout Standard
22264 Putting the last few things together,
22265 the \SpecialChar LaTeX
22266 output will be either:
22270 \begin_layout LyX-Code
22273 LatexName[LatexParam]{\SpecialChar ldots
22277 \begin_layout Standard
22282 \begin_layout LyX-Code
22285 begin{LatexName}[LatexParam] \SpecialChar ldots
22291 \begin_layout Standard
22292 depending upon the \SpecialChar LaTeX
22297 \begin_layout Description
22298 \begin_inset Flex Code
22301 \begin_layout Plain Layout
22308 \begin_inset Flex Code
22311 \begin_layout Plain Layout
22317 ] A string that is put at the beginning of the layout content.
22318 A line break in the output can be indicated by
22319 \begin_inset Flex Code
22322 \begin_layout Plain Layout
22331 \begin_layout Description
22332 \begin_inset Flex Code
22335 \begin_layout Plain Layout
22342 \begin_inset Flex Code
22345 \begin_layout Plain Layout
22353 \begin_inset Flex Code
22356 \begin_layout Plain Layout
22364 \change_deleted -584632292 1615846609
22366 \begin_inset Flex Code
22369 \begin_layout Plain Layout
22378 \begin_inset Flex Code
22381 \begin_layout Plain Layout
22387 (indicating a dummy definition ending definitions of charstyles,
22389 This entry is required in and is only meaningful for Flex insets.
22390 Among other things,
22391 it determines on which menu this inset will appear.
22393 \begin_inset Flex Code
22396 \begin_layout Plain Layout
22403 \begin_inset Flex Code
22406 \begin_layout Plain Layout
22412 will automatically set
22413 \begin_inset Flex Code
22416 \begin_layout Plain Layout
22423 \begin_inset Flex Code
22426 \begin_layout Plain Layout
22434 \begin_inset Flex Code
22437 \begin_layout Plain Layout
22443 can be set to true,
22445 \begin_inset Flex Code
22448 \begin_layout Plain Layout
22456 \begin_inset Flex Code
22459 \begin_layout Plain Layout
22465 insets by setting it
22470 \begin_inset Flex Code
22473 \begin_layout Plain Layout
22480 \change_inserted -712698321 1555575738
22484 \begin_layout Description
22486 \change_inserted -712698321 1555575844
22487 \begin_inset Flex Code
22490 \begin_layout Plain Layout
22492 \change_inserted -712698321 1555575740
22501 \begin_inset Flex Code
22504 \begin_layout Plain Layout
22506 \change_inserted -712698321 1555575740
22514 A dedicated string for the menu.
22515 You can define an accelerator by appending the respective character to the string,
22517 \begin_inset Quotes eld
22521 \begin_inset Quotes erd
22525 \begin_inset space \thinspace{}
22529 \begin_inset space \space{}
22533 \begin_inset Quotes eld
22537 \begin_inset Flex Code
22540 \begin_layout Plain Layout
22542 \change_inserted -712698321 1555575781
22551 \begin_inset Quotes erd
22555 This specification is optional.
22556 If it is not given the inset name as specified in the type declaration will be used instead for the menu.
22561 \begin_layout Description
22562 \begin_inset Flex Code
22565 \begin_layout Plain Layout
22572 \begin_inset Flex Code
22575 \begin_layout Plain Layout
22584 \begin_inset space \thinspace{}
22588 \begin_inset Flex Code
22591 \begin_layout Plain Layout
22597 ] Whether multiple paragraphs are permitted in this inset.
22599 \begin_inset Flex Code
22602 \begin_layout Plain Layout
22608 to the same value and
22609 \begin_inset Flex Code
22612 \begin_layout Plain Layout
22618 to the opposite value.
22619 These can be reset to other values,
22625 \begin_inset Flex Code
22628 \begin_layout Plain Layout
22638 \begin_layout Description
22639 \begin_inset Flex Code
22642 \begin_layout Plain Layout
22649 \begin_inset Flex Code
22652 \begin_layout Plain Layout
22661 \begin_inset space \thinspace{}
22665 \begin_inset Flex Code
22668 \begin_layout Plain Layout
22674 ] Whether fragile commands in this inset should be
22675 \begin_inset Flex Code
22678 \begin_layout Plain Layout
22692 whether the command should itself be protected.) Default is false.
22693 \change_inserted -712698321 1523633958
22697 \begin_layout Description
22699 \change_inserted -712698321 1552395786
22700 \begin_inset Flex Code
22703 \begin_layout Plain Layout
22705 \change_inserted -712698321 1523633961
22714 \begin_inset Flex Code
22717 \begin_layout Plain Layout
22719 \change_inserted -712698321 1523633958
22730 \begin_inset space \thinspace{}
22734 \begin_inset Flex Code
22737 \begin_layout Plain Layout
22739 \change_inserted -712698321 1523633958
22747 ] This causes macros that contain this inset to be protected with
22748 \begin_inset Flex Code
22751 \begin_layout Plain Layout
22753 \change_inserted -712698321 1523634038
22768 ) if necessary and thus allows (some) verbatim stuff in macros.
22772 \begin_layout Description
22774 \change_inserted -712698321 1555579651
22775 \begin_inset Flex Code
22778 \begin_layout Plain Layout
22780 \change_inserted -712698321 1552395787
22789 \begin_inset Flex Code
22792 \begin_layout Plain Layout
22794 \change_inserted -712698321 1552395787
22805 \begin_inset space \thinspace{}
22809 \begin_inset Flex Code
22812 \begin_layout Plain Layout
22814 \change_inserted -712698321 1552395787
22822 ] Whether specific commands in this inset (such as
22823 \begin_inset Flex Code
22826 \begin_layout Plain Layout
22828 \change_inserted -712698321 1552395787
22839 \begin_inset Flex Code
22842 \begin_layout Plain Layout
22844 \change_inserted -712698321 1552395787
22854 ) should be protected in an
22855 \begin_inset Flex Code
22858 \begin_layout Plain Layout
22860 \change_inserted -712698321 1552395787
22871 This is particularly needed for insets that draw on
22879 commands which parse their content in complex ways.
22883 \begin_layout Description
22885 \change_inserted -712698321 1555579742
22886 \begin_inset Flex Code
22889 \begin_layout Plain Layout
22891 \change_inserted -712698321 1555579658
22900 \begin_inset Flex Code
22903 \begin_layout Plain Layout
22905 \change_inserted -712698321 1555579651
22913 Option to define a different command (from the default
22914 \begin_inset Flex Code
22917 \begin_layout Plain Layout
22919 \change_inserted -712698321 1555579742
22931 ) to be used for line breaks.
22932 The initial backslash must not be specified.
22937 \begin_layout Description
22938 \begin_inset Flex Code
22941 \begin_layout Plain Layout
22948 \begin_inset Flex Code
22951 \begin_layout Plain Layout
22957 ] Deletes an existing
22958 \begin_inset Flex Code
22961 \begin_layout Plain Layout
22970 \begin_layout Description
22971 \begin_inset Flex Code
22974 \begin_layout Plain Layout
22981 \begin_inset Flex Code
22984 \begin_layout Plain Layout
22991 \begin_inset Flex Code
22994 \begin_layout Plain Layout
23000 that has replaced this
23001 \begin_inset Flex Code
23004 \begin_layout Plain Layout
23011 This is used to rename an
23012 \begin_inset Flex Code
23015 \begin_layout Plain Layout
23022 while keeping backward compatibility.
23023 \change_inserted -712698321 1559491850
23027 \begin_layout Description
23029 \change_inserted -712698321 1559492002
23030 \begin_inset Flex Code
23033 \begin_layout Plain Layout
23035 \change_inserted -712698321 1559491854
23044 \begin_inset Flex Code
23047 \begin_layout Plain Layout
23049 \change_inserted -712698321 1559491850
23060 \begin_inset space \thinspace{}
23064 \begin_inset Flex Code
23067 \begin_layout Plain Layout
23069 \change_inserted -712698321 1559491850
23077 ] If this is set to
23078 \begin_inset Flex Code
23081 \begin_layout Plain Layout
23083 \change_inserted -712698321 1559491881
23092 paragraph breaks will be ignored in the output.
23093 This might be useful for insets where the content should be alignable on different lines only in the \SpecialChar LyX
23095 without any effect in the output.
23100 \begin_layout Description
23101 \begin_inset Flex Code
23104 \begin_layout Plain Layout
23111 \begin_inset Flex Code
23114 \begin_layout Plain Layout
23123 \begin_inset space \thinspace{}
23127 \begin_inset Flex Code
23130 \begin_layout Plain Layout
23136 ] As with paragraph styles,
23138 \begin_inset CommandInset ref
23140 reference "subsec:Paragraph-Styles"
23149 \begin_layout Description
23150 \begin_inset Flex Code
23153 \begin_layout Plain Layout
23160 \begin_inset Flex Code
23163 \begin_layout Plain Layout
23172 \begin_inset space \thinspace{}
23176 \begin_inset Flex Code
23179 \begin_layout Plain Layout
23185 ] As with paragraph styles,
23187 \begin_inset CommandInset ref
23189 reference "subsec:Paragraph-Styles"
23198 \begin_layout Description
23199 \begin_inset Flex Code
23202 \begin_layout Plain Layout
23208 As with paragraph styles,
23210 \begin_inset CommandInset ref
23212 reference "subsec:Paragraph-Styles"
23220 \begin_layout Description
23221 \begin_inset Flex Code
23224 \begin_layout Plain Layout
23231 \begin_inset Flex Code
23234 \begin_layout Plain Layout
23240 ] The prefix to use when creating labels referring to insets of this type.
23241 This allows the use of formatted references.
23244 \begin_layout Description
23245 \begin_inset Flex Code
23248 \begin_layout Plain Layout
23255 \begin_inset Flex Code
23258 \begin_layout Plain Layout
23264 ] As with paragraph styles,
23266 \begin_inset CommandInset ref
23268 reference "subsec:Paragraph-Styles"
23276 \begin_layout Description
23277 \begin_inset Flex Code
23280 \begin_layout Plain Layout
23287 \begin_inset Flex Code
23290 \begin_layout Plain Layout
23299 \begin_inset space \thinspace{}
23303 \begin_inset Flex Code
23306 \begin_layout Plain Layout
23312 ] Resets the \SpecialChar LaTeX
23313 arguments of this layout (as defined via the
23314 \begin_inset Flex Code
23317 \begin_layout Plain Layout
23324 This is useful if you have copied a style via
23325 \begin_inset Flex Code
23328 \begin_layout Plain Layout
23335 but you do not want to inherit its (required and optional) arguments.
23338 \begin_layout Description
23339 \begin_inset Flex Code
23342 \begin_layout Plain Layout
23349 \begin_inset Flex Code
23352 \begin_layout Plain Layout
23361 \begin_inset space \thinspace{}
23365 \begin_inset Flex Code
23368 \begin_layout Plain Layout
23375 \change_inserted -712698321 1597733473
23377 \begin_inset Flex Code
23380 \begin_layout Plain Layout
23382 \change_inserted -712698321 1597732178
23391 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.
23392 \begin_inset space \thinspace{}
23397 \begin_inset Flex Code
23400 \begin_layout Plain Layout
23402 \change_inserted -712698321 1597733683
23405 textbf{Sourrounding text
23409 textbf{content}}\SpecialChar ldots
23418 \begin_inset Flex Code
23421 \begin_layout Plain Layout
23423 \change_inserted -712698321 1597733686
23426 textbf{Sourrounding text
23428 myinset{content}\SpecialChar ldots
23437 Setting this makes sense for commands that internally reset font settings (e.
23438 \begin_inset space \thinspace{}
23443 Note that wrongly setting this might lead to unwanted result (e.
23444 \begin_inset space \thinspace{}
23449 \begin_inset Flex Code
23452 \begin_layout Plain Layout
23454 \change_inserted -712698321 1597733688
23457 emph{Sourrounding text
23461 emph{content}}\SpecialChar ldots
23470 content is upright,
23472 \begin_inset Flex Code
23475 \begin_layout Plain Layout
23477 \change_inserted -712698321 1597733278
23489 \change_deleted -712698321 1597733283
23490 Whether this inset should use the font of its surrounding environment or uses its own.
23494 \change_deleted -712698321 1597733290
23496 \change_inserted -712698321 1597733290
23498 \begin_inset Flex Code
23501 \begin_layout Plain Layout
23503 \change_inserted -712698321 1597733292
23515 \change_deleted -712698321 1597733327
23516 use the font of the surrounding environment
23517 \change_inserted -712698321 1597733343
23518 font changes are not redone inside the inset
23523 \begin_layout Description
23524 \begin_inset Flex Code
23527 \begin_layout Plain Layout
23534 \begin_inset Flex Code
23537 \begin_layout Plain Layout
23543 ] A string that is put at the end of the layout content.
23544 A line break in the output can be indicated by
23545 \begin_inset Flex Code
23548 \begin_layout Plain Layout
23557 \begin_layout Description
23558 \begin_inset Flex Code
23561 \begin_layout Plain Layout
23568 \begin_inset Flex Code
23571 \begin_layout Plain Layout
23578 \begin_inset space \thinspace{}
23582 \begin_inset Flex Code
23585 \begin_layout Plain Layout
23593 ] Allow spell-checking the contents of this inset.
23595 \change_inserted -584632292 1615846659
23599 \begin_layout Subsection
23601 \change_inserted -584632292 1615846729
23603 \begin_inset CommandInset label
23605 name "subsec:Arguments"
23612 \begin_layout Standard
23614 \change_inserted -584632292 1615846807
23615 Both paragraph styles and inset layouts allow for
23619 as well as the main content.
23620 This is especially useful for things like section headings and only makes sense with \SpecialChar LaTeX
23622 Each (optional or required) argument of a command or environment—
23623 except for the required argument that is associated with the content—
23624 has a separate definition,
23625 where the number specifies the order of the arguments.
23626 The definition must end with
23627 \begin_inset Flex Code
23630 \begin_layout Plain Layout
23632 \change_inserted -584632292 1615846730
23641 So a command with two optional arguments looks like:
23644 \begin_layout Quote
23646 \change_inserted -584632292 1615846730
23652 \begin_layout Quote
23654 \change_inserted -584632292 1615846730
23660 \begin_layout Quote
23662 \change_inserted -584632292 1615846730
23668 \begin_layout Quote
23670 \change_inserted -584632292 1615846730
23676 \begin_layout Quote
23678 \change_inserted -584632292 1615846730
23684 \begin_layout Quote
23686 \change_inserted -584632292 1615846730
23692 \begin_layout Standard
23694 \change_inserted -584632292 1615846730
23696 \begin_inset Flex Code
23699 \begin_layout Plain Layout
23701 \change_inserted -584632292 1615846730
23710 the following specifications are possible:
23713 \begin_layout Itemize
23715 \change_inserted -584632292 1615846730
23716 \begin_inset Flex Code
23719 \begin_layout Plain Layout
23721 \change_inserted -584632292 1615846730
23730 \begin_inset Flex Code
23733 \begin_layout Plain Layout
23735 \change_inserted -584632292 1615846730
23743 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
23744 \begin_inset Flex Code
23747 \begin_layout Plain Layout
23749 \change_inserted -584632292 1615846730
23759 you can define an accelerator by appending the respective character to the string,
23761 \begin_inset Quotes eld
23765 \begin_inset Quotes erd
23769 \begin_inset space \thinspace{}
23773 \begin_inset space \space{}
23777 \begin_inset Quotes eld
23781 \begin_inset Flex Code
23784 \begin_layout Plain Layout
23786 \change_inserted -584632292 1615846730
23795 \begin_inset Quotes erd
23801 \begin_layout Itemize
23803 \change_inserted -584632292 1615846730
23804 \begin_inset Flex Code
23807 \begin_layout Plain Layout
23809 \change_inserted -584632292 1615846730
23818 \begin_inset Flex Code
23821 \begin_layout Plain Layout
23823 \change_inserted -584632292 1615846730
23831 A separate string for the menu.
23832 You can define an accelerator by appending the respective character to the string,
23834 \begin_inset Quotes eld
23838 \begin_inset Quotes erd
23842 \begin_inset space \thinspace{}
23846 \begin_inset space \space{}
23850 \begin_inset Quotes eld
23854 \begin_inset Flex Code
23857 \begin_layout Plain Layout
23859 \change_inserted -584632292 1615846730
23868 \begin_inset Quotes erd
23872 This specification is optional.
23873 If it is not given the
23874 \begin_inset Flex Code
23877 \begin_layout Plain Layout
23879 \change_inserted -584632292 1615846730
23887 will be used instead for the menu.
23890 \begin_layout Itemize
23892 \change_inserted -584632292 1615846730
23893 \begin_inset Flex Code
23896 \begin_layout Plain Layout
23898 \change_inserted -584632292 1615846730
23907 \begin_inset Flex Code
23910 \begin_layout Plain Layout
23912 \change_inserted -584632292 1615846730
23920 A longer explanatory text that appears in the tooltip when hovering over the argument inset.
23923 \begin_layout Itemize
23925 \change_inserted -584632292 1615846730
23926 \begin_inset Flex Code
23929 \begin_layout Plain Layout
23931 \change_inserted -584632292 1615846730
23940 \begin_inset Flex Code
23943 \begin_layout Plain Layout
23945 \change_inserted -584632292 1615846730
23956 \begin_inset space \thinspace{}
23960 \begin_inset Flex Code
23963 \begin_layout Plain Layout
23965 \change_inserted -584632292 1615846730
23973 ] Declare if this is a mandatory (1) or an optional (0) argument.
23974 Mandatory arguments will be output empty if not given,
23975 while optional arguments will not be output at all.
23977 mandatory arguments are delimited by
23978 \begin_inset Flex Code
23981 \begin_layout Plain Layout
23983 \change_inserted -584632292 1615846730
23992 while optional arguments are delimited by
23993 \begin_inset Flex Code
23996 \begin_layout Plain Layout
23998 \change_inserted -584632292 1615846730
24009 \begin_layout Itemize
24011 \change_inserted -584632292 1615846730
24012 \begin_inset Flex Code
24015 \begin_layout Plain Layout
24017 \change_inserted -584632292 1615846730
24026 \begin_inset Flex Code
24029 \begin_layout Plain Layout
24031 \change_inserted -584632292 1615846730
24039 Option to define a different command (from the default
24040 \begin_inset Flex Code
24043 \begin_layout Plain Layout
24045 \change_inserted -584632292 1615846730
24057 ) to be used for line breaks.
24058 The initial backslash must not be specified.
24061 \begin_layout Itemize
24063 \change_inserted -584632292 1615846730
24064 \begin_inset Flex Code
24067 \begin_layout Plain Layout
24069 \change_inserted -584632292 1615846730
24078 \begin_inset Flex Code
24081 \begin_layout Plain Layout
24083 \change_inserted -584632292 1615846730
24091 defines another argument (by its number) which this argument requires to be output if it is itself output.
24093 \begin_inset space \thinspace{}
24097 in \SpecialChar LaTeX
24099 optional arguments often require previous optional arguments to be output (at least empty),
24101 \begin_inset Flex Code
24104 \begin_layout Plain Layout
24106 \change_inserted -584632292 1615846730
24109 command[][argument]{text}
24117 This can be achieved by the statement
24118 \begin_inset Flex Code
24121 \begin_layout Plain Layout
24123 \change_inserted -584632292 1615846730
24132 \begin_inset Flex Code
24135 \begin_layout Plain Layout
24137 \change_inserted -584632292 1615846730
24148 \begin_layout Itemize
24150 \change_inserted -584632292 1615846730
24151 \begin_inset Flex Code
24154 \begin_layout Plain Layout
24156 \change_inserted -584632292 1615846730
24165 \begin_inset Flex Code
24168 \begin_layout Plain Layout
24170 \change_inserted -584632292 1615846730
24178 defines a custom left delimiter (instead of
24179 \begin_inset Flex Code
24182 \begin_layout Plain Layout
24184 \change_inserted -584632292 1615846730
24193 \begin_inset Flex Code
24196 \begin_layout Plain Layout
24198 \change_inserted -584632292 1615846730
24207 A line break in the output can be indicated by
24208 \begin_inset Flex Code
24211 \begin_layout Plain Layout
24213 \change_inserted -584632292 1615846730
24224 \begin_layout Itemize
24226 \change_inserted -584632292 1615846730
24227 \begin_inset Flex Code
24230 \begin_layout Plain Layout
24232 \change_inserted -584632292 1615846730
24241 \begin_inset Flex Code
24244 \begin_layout Plain Layout
24246 \change_inserted -584632292 1615846730
24254 defines a custom right delimiter (instead of
24255 \begin_inset Flex Code
24258 \begin_layout Plain Layout
24260 \change_inserted -584632292 1615846730
24269 \begin_inset Flex Code
24272 \begin_layout Plain Layout
24274 \change_inserted -584632292 1615846730
24283 A line break in the output can be indicated by
24284 \begin_inset Flex Code
24287 \begin_layout Plain Layout
24289 \change_inserted -584632292 1615846730
24300 \begin_layout Itemize
24302 \change_inserted -584632292 1615846730
24303 \begin_inset Flex Code
24306 \begin_layout Plain Layout
24308 \change_inserted -584632292 1615846730
24317 \begin_inset Flex Code
24320 \begin_layout Plain Layout
24322 \change_inserted -584632292 1615846730
24330 defines an argument that is inserted if and only if no user-specified arguments were given,
24332 \begin_inset space \thinspace{}
24336 \begin_inset space \space{}
24339 if no argument inset has been inserted (note that also an empty argument inset omits the DefaultArg).
24340 Multiple arguments need to be separated by comma.
24343 \begin_layout Itemize
24345 \change_inserted -584632292 1615846730
24346 \begin_inset Flex Code
24349 \begin_layout Plain Layout
24351 \change_inserted -584632292 1615846730
24360 \begin_inset Flex Code
24363 \begin_layout Plain Layout
24365 \change_inserted -584632292 1615846730
24373 defines an argument that is inserted in any case (alone or in addition to user-specified arguments).
24374 Multiple arguments need to be separated by comma.
24377 \begin_layout Itemize
24379 \change_inserted -584632292 1615846730
24380 \begin_inset Flex Code
24383 \begin_layout Plain Layout
24385 \change_inserted -584632292 1615846730
24393 The font used for the argument content,
24395 \begin_inset CommandInset ref
24397 reference "subsec:Font-description"
24405 \begin_layout Itemize
24407 \change_inserted -584632292 1615846730
24408 \begin_inset Flex Code
24411 \begin_layout Plain Layout
24413 \change_inserted -584632292 1615846730
24422 \begin_inset Flex Code
24425 \begin_layout Plain Layout
24427 \change_inserted -584632292 1615846730
24438 \begin_inset space \thinspace{}
24442 \begin_inset Flex Code
24445 \begin_layout Plain Layout
24447 \change_inserted -584632292 1615846730
24455 ] As with paragraph styles,
24457 \begin_inset CommandInset ref
24459 reference "subsec:Paragraph-Styles"
24467 \begin_layout Itemize
24469 \change_inserted -584632292 1615846730
24470 \begin_inset Flex Code
24473 \begin_layout Plain Layout
24475 \change_inserted -584632292 1615846730
24483 The font used for the label;
24485 \begin_inset CommandInset ref
24487 reference "subsec:Font-description"
24495 \begin_layout Itemize
24497 \change_inserted -584632292 1615846730
24498 \begin_inset Flex Code
24501 \begin_layout Plain Layout
24503 \change_inserted -584632292 1615846730
24512 \begin_inset Flex Code
24515 \begin_layout Plain Layout
24517 \change_inserted -584632292 1615846730
24531 ] describes the rendering style used for the inset's frame and buttons.
24534 \begin_layout Itemize
24536 \change_inserted -584632292 1615846730
24537 \begin_inset Flex Code
24540 \begin_layout Plain Layout
24542 \change_inserted -584632292 1615846730
24551 \begin_inset Flex Code
24554 \begin_layout Plain Layout
24556 \change_inserted -584632292 1615846730
24565 \begin_inset Flex Code
24568 \begin_layout Plain Layout
24570 \change_inserted -584632292 1615846730
24579 this argument is automatically inserted when the respective style is selected.
24582 \begin_layout Itemize
24584 \change_inserted -584632292 1615846730
24585 \begin_inset Flex Code
24588 \begin_layout Plain Layout
24590 \change_inserted -584632292 1615846730
24599 \begin_inset Flex Code
24602 \begin_layout Plain Layout
24604 \change_inserted -584632292 1615846730
24613 \begin_inset Flex Code
24616 \begin_layout Plain Layout
24618 \change_inserted -584632292 1615846730
24627 this argument will be inserted on a new line with
24628 \begin_inset Flex Code
24631 \begin_layout Plain Layout
24633 \change_inserted -584632292 1615846730
24641 (only available within Flex insets).
24644 \begin_layout Itemize
24646 \change_inserted -584632292 1615846730
24647 \begin_inset Flex Code
24650 \begin_layout Plain Layout
24652 \change_inserted -584632292 1615846730
24661 \begin_inset Flex Code
24664 \begin_layout Plain Layout
24666 \change_inserted -584632292 1615846730
24675 \begin_inset Flex Code
24678 \begin_layout Plain Layout
24680 \change_inserted -584632292 1615846730
24689 this argument will be inserted with a copy of the co-text (either selected text or the whole paragraph) as content.
24692 \begin_layout Itemize
24694 \change_inserted -584632292 1615846730
24695 \begin_inset Flex Code
24698 \begin_layout Plain Layout
24700 \change_inserted -584632292 1615846730
24709 \begin_inset Flex Code
24712 \begin_layout Plain Layout
24714 \change_inserted -584632292 1615846730
24728 ] Whether the contents of this argument should be output in raw form,
24729 meaning without special translations that \SpecialChar LaTeX
24733 \begin_inset Flex Code
24736 \begin_layout Plain Layout
24738 \change_inserted -584632292 1615846730
24746 status is inherited by the inset or paragraph layout the argument belongs to,
24747 true and false change the status for the given argument only.
24750 \begin_layout Itemize
24752 \change_inserted -584632292 1615846730
24753 \begin_inset Flex Code
24756 \begin_layout Plain Layout
24758 \change_inserted -584632292 1615846730
24767 \begin_inset Flex Code
24770 \begin_layout Plain Layout
24772 \change_inserted -584632292 1615846730
24773 string of characters
24784 Defines individual characters
24785 \begin_inset Newline linebreak
24788 that should be output in raw form,
24789 meaning without special translations that \SpecialChar LaTeX
24792 contrary to PassThru,
24793 this needs to be explicitly defined for arguments.
24795 arguments do not inherit PassThruChars from their parent inset or layout.
24798 \begin_layout Itemize
24800 \change_inserted -584632292 1615846730
24801 \begin_inset Flex Code
24804 \begin_layout Plain Layout
24806 \change_inserted -584632292 1615846730
24815 \begin_inset Flex Code
24818 \begin_layout Plain Layout
24820 \change_inserted -584632292 1615846730
24831 \begin_inset space \thinspace{}
24835 \begin_inset Flex Code
24838 \begin_layout Plain Layout
24840 \change_inserted -584632292 1615846730
24848 ] If this is set to 1,
24849 the argument will output its content in the corresponding item in the table of contents.
24853 \begin_layout Standard
24855 \change_inserted -584632292 1615846730
24857 the text entered in the \SpecialChar LyX
24858 workarea in the respective layout is the last (mandatory) argument of a command if the
24859 \begin_inset Flex Code
24862 \begin_layout Plain Layout
24864 \change_inserted -584632292 1615846730
24873 \begin_inset Flex Code
24876 \begin_layout Plain Layout
24878 \change_inserted -584632292 1615846730
24888 arguments with the prefix
24889 \begin_inset Flex Code
24892 \begin_layout Plain Layout
24894 \change_inserted -584632292 1615846730
24902 are output after this workarea argument.
24903 Note that post-argument numbering restarts at 1,
24904 so the first argument following the workarea argument is
24905 \begin_inset Flex Code
24908 \begin_layout Plain Layout
24910 \change_inserted -584632292 1615846730
24919 Post-arguments are ignored in any other
24920 \begin_inset Flex Code
24923 \begin_layout Plain Layout
24925 \change_inserted -584632292 1615846730
24934 \begin_inset Flex Code
24937 \begin_layout Plain Layout
24939 \change_inserted -584632292 1615846730
24950 \begin_layout Standard
24952 \change_inserted -584632292 1615846730
24954 \begin_inset Flex Code
24957 \begin_layout Plain Layout
24959 \change_inserted -584632292 1615846730
24970 \begin_inset Flex Code
24973 \begin_layout Plain Layout
24975 \change_inserted -584632292 1615846730
24986 \begin_inset Flex Code
24989 \begin_layout Plain Layout
24991 \change_inserted -584632292 1615846730
24999 followed by the number (e.
25000 \begin_inset space \thinspace{}
25004 \begin_inset space \space{}
25008 \begin_inset Flex Code
25011 \begin_layout Plain Layout
25013 \change_inserted -584632292 1615846730
25024 \begin_layout Standard
25026 \change_inserted -584632292 1615846730
25028 there is a special argument type with the prefix
25029 \begin_inset Flex Code
25032 \begin_layout Plain Layout
25034 \change_inserted -584632292 1615846730
25043 It is not really an argument,
25044 but uses the argument interface (thus,
25045 the prefix is also followed by a number,
25047 \begin_inset space \thinspace{}
25052 \begin_inset Flex Code
25055 \begin_layout Plain Layout
25057 \change_inserted -584632292 1615846730
25058 Argument listpreamble:1
25066 As the name implies,
25067 it is targeted at lists such as
25087 Its content will be output at the list start,
25089 \begin_inset Flex Code
25092 \begin_layout Plain Layout
25094 \change_inserted -584632292 1615846730
25105 on an own line (a place that is otherwise not accessible in \SpecialChar LyX
25108 users can insert redefinitions (of lengths etc.) to individual lists.
25110 these arguments do not have a delimiter.
25115 \begin_layout Subsection
25117 \begin_inset CommandInset label
25119 name "subsec:Counters"
25126 \begin_layout Standard
25127 It is necessary to define the counters (
25128 \begin_inset Flex Noun
25131 \begin_layout Plain Layout
25139 \begin_inset Flex Noun
25142 \begin_layout Plain Layout
25150 ) in the text class itself.
25151 The standard counters are defined in the file
25152 \begin_inset Flex Code
25155 \begin_layout Plain Layout
25162 so you may have to do no more than add
25165 \begin_layout LyX-Code
25166 Input stdcounters.inc
25169 \begin_layout Standard
25170 to your layout file to get them to work.
25171 But if you want to define custom counters,
25172 then you can do so.
25173 The counter declaration must begin with:
25176 \begin_layout LyX-Code
25177 Counter CounterName
25180 \begin_layout Standard
25182 \begin_inset Flex Code
25185 \begin_layout Plain Layout
25191 ' is replaced by the name of the counter.
25192 And it must end with
25193 \begin_inset Quotes eld
25197 \begin_inset Flex Code
25200 \begin_layout Plain Layout
25207 \begin_inset Quotes erd
25211 The following parameters can also be used:
25214 \begin_layout Description
25215 \begin_inset Flex Code
25218 \begin_layout Plain Layout
25225 \begin_inset Flex Code
25228 \begin_layout Plain Layout
25234 ] Sets the initial value for the counter,
25235 to which it will be reset whenever that happens.
25237 one will want the default,
25241 \begin_layout Description
25242 \begin_inset Flex Code
25245 \begin_layout Plain Layout
25252 \begin_inset Flex Code
25255 \begin_layout Plain Layout
25262 \begin_inset Quotes erd
25266 \begin_inset Quotes erd
25270 this string defines how the counter is displayed.
25271 Setting this value sets
25272 \begin_inset Flex Code
25275 \begin_layout Plain Layout
25276 LabelStringAppendix
25282 The following special constructs can be used in the string:
25286 \begin_layout Itemize
25287 \begin_inset Flex Code
25290 \begin_layout Plain Layout
25298 will be replaced by the expansion of the
25299 \begin_inset Flex Code
25302 \begin_layout Plain Layout
25309 \begin_inset Flex Code
25312 \begin_layout Plain Layout
25313 LabelStringAppendix
25319 \begin_inset Flex Code
25322 \begin_layout Plain Layout
25332 \begin_layout Itemize
25333 counter values can be expressed using \SpecialChar LaTeX
25335 \begin_inset Newline newline
25339 \begin_inset Flex Code
25342 \begin_layout Plain Layout
25360 \begin_inset Flex Code
25363 \begin_layout Plain Layout
25375 \begin_layout Plain Layout
25386 the situation is a bit more complicated:
25406 other than those described below will produce arabic numerals.
25407 It would not be surprising to see this change in the future.
25413 \begin_inset Flex Code
25416 \begin_layout Plain Layout
25425 3,\SpecialChar ldots
25428 \begin_inset Flex Code
25431 \begin_layout Plain Layout
25437 for lower-case letters:
25444 \begin_inset Flex Code
25447 \begin_layout Plain Layout
25453 for upper-case letters:
25460 \begin_inset Flex Code
25463 \begin_layout Plain Layout
25469 for lower-case roman numerals:
25476 \begin_inset Flex Code
25479 \begin_layout Plain Layout
25485 for upper-case roman numerals:
25488 III\SpecialChar ldots
25491 \begin_inset Flex Code
25494 \begin_layout Plain Layout
25500 for hebrew numerals.
25504 \begin_layout Standard
25505 If LabelString is not defined,
25506 a default value is constructed as follows:
25507 if the counter has a
25508 \change_deleted 731793113 1604355218
25510 \change_inserted 731793113 1604355221
25514 \begin_inset Flex Code
25517 \begin_layout Plain Layout
25519 \change_deleted 731793113 1604355223
25521 \change_inserted 731793113 1604355226
25530 \begin_inset Flex Code
25533 \begin_layout Plain Layout
25541 \begin_inset Newline newline
25545 \begin_inset Flex Code
25548 \begin_layout Plain Layout
25552 \change_inserted 731793113 1604355228
25554 \change_deleted 731793113 1604355230
25565 otherwise the string
25566 \begin_inset Flex Code
25569 \begin_layout Plain Layout
25580 \begin_layout Description
25581 \begin_inset Flex Code
25584 \begin_layout Plain Layout
25585 LabelStringAppendix
25591 \begin_inset Flex Code
25594 \begin_layout Plain Layout
25601 \begin_inset Quotes eld
25605 \begin_inset Quotes erd
25609 \begin_inset Flex Code
25612 \begin_layout Plain Layout
25619 but for use in the Appendix.
25620 \change_inserted -584632292 1607202551
25624 \begin_layout Description
25626 \change_inserted -584632292 1607202682
25627 \begin_inset Flex Code
25630 \begin_layout Plain Layout
25637 \begin_inset Flex Code
25640 \begin_layout Plain Layout
25642 \change_inserted -584632292 1607202576
25651 \begin_inset Quotes eld
25655 \begin_inset Quotes erd
25658 ] The counter name as used in \SpecialChar LaTeX
25661 \change_inserted 34634807 1619711355
25663 \change_deleted 34634807 1619711355
25665 \change_inserted -584632292 1607202682
25667 in \SpecialChar LyX
25669 there is a counter named `theorem',
25670 but it is output to \SpecialChar LaTeX
25676 \begin_layout Description
25677 \begin_inset Flex Code
25680 \begin_layout Plain Layout
25687 \begin_inset Flex Code
25690 \begin_layout Plain Layout
25697 \begin_inset Quotes erd
25701 \begin_inset Quotes erd
25704 ] A format for use with formatted references to this counter.
25706 one might want to have references to section numbers appear as
25707 \begin_inset Quotes eld
25711 \begin_inset Quotes erd
25715 The string should contain
25716 \begin_inset Quotes eld
25720 \begin_inset Quotes erd
25724 This will be replaced by the counter number itself.
25731 \begin_layout Description
25732 \begin_inset Flex Code
25735 \begin_layout Plain Layout
25742 \begin_inset Flex Code
25745 \begin_layout Plain Layout
25752 \begin_inset Quotes erd
25756 \begin_inset Quotes erd
25759 ] If this is set to the name of another counter,
25760 the present counter will be reset every time the other one is increased.
25763 \begin_inset Flex Code
25766 \begin_layout Plain Layout
25773 \begin_inset Flex Code
25776 \begin_layout Plain Layout
25785 \begin_layout Subsection
25787 \begin_inset CommandInset label
25789 name "subsec:Font-description"
25796 \begin_layout Standard
25797 A font description looks like this:
25800 \begin_layout LyX-Code
25817 \begin_layout LyX-Code
25821 \begin_layout LyX-Code
25825 \begin_layout Standard
25826 The following commands are available:
25829 \begin_layout Description
25830 \begin_inset Flex Code
25833 \begin_layout Plain Layout
25840 \change_deleted -712698321 1607682984
25842 \begin_inset Flex Code
25845 \begin_layout Plain Layout
25855 \begin_inset Flex Code
25858 \begin_layout Plain Layout
25866 \begin_inset Flex Code
25869 \begin_layout Plain Layout
25877 \begin_inset Flex Code
25880 \begin_layout Plain Layout
25888 \begin_inset Flex Code
25891 \begin_layout Plain Layout
25899 \begin_inset Flex Code
25902 \begin_layout Plain Layout
25910 \begin_inset Flex Code
25913 \begin_layout Plain Layout
25921 \begin_inset Flex Code
25924 \begin_layout Plain Layout
25932 \begin_inset Flex Code
25935 \begin_layout Plain Layout
25943 \begin_inset Flex Code
25946 \begin_layout Plain Layout
25954 \begin_inset Flex Code
25957 \begin_layout Plain Layout
25965 \begin_inset Flex Code
25968 \begin_layout Plain Layout
25976 \begin_inset Flex Code
25979 \begin_layout Plain Layout
25987 \begin_inset Flex Code
25990 \begin_layout Plain Layout
25998 \begin_inset Flex Code
26001 \begin_layout Plain Layout
26009 \begin_inset Flex Code
26012 \begin_layout Plain Layout
26020 \begin_inset Flex Code
26023 \begin_layout Plain Layout
26031 \begin_inset Flex Code
26034 \begin_layout Plain Layout
26042 \begin_inset Flex Code
26045 \begin_layout Plain Layout
26053 \begin_inset Flex Code
26056 \begin_layout Plain Layout
26063 \change_inserted -712698321 1607683139
26065 \begin_inset Flex Code
26068 \begin_layout Plain Layout
26070 \change_inserted -712698321 1607683135
26079 \begin_inset space ~
26083 \begin_inset CommandInset ref
26085 reference "chap:Names-of-colors"
26094 \change_deleted -712698321 1607683144
26096 \change_inserted -712698321 1607683146
26102 \begin_layout Description
26103 \begin_inset Flex Code
26106 \begin_layout Plain Layout
26113 \begin_inset Flex Code
26116 \begin_layout Plain Layout
26126 \begin_inset Flex Code
26129 \begin_layout Plain Layout
26137 \begin_inset Flex Code
26140 \begin_layout Plain Layout
26149 \begin_layout Description
26150 \begin_inset Flex Code
26153 \begin_layout Plain Layout
26160 \begin_inset Flex Code
26163 \begin_layout Plain Layout
26169 ] Valid arguments are:
26171 \begin_inset Flex Code
26174 \begin_layout Plain Layout
26182 \begin_inset Flex Code
26185 \begin_layout Plain Layout
26193 \begin_inset Flex Code
26196 \begin_layout Plain Layout
26204 \begin_inset Flex Code
26207 \begin_layout Plain Layout
26215 \begin_inset Flex Code
26218 \begin_layout Plain Layout
26226 \begin_inset Flex Code
26229 \begin_layout Plain Layout
26237 \begin_inset Flex Code
26240 \begin_layout Plain Layout
26248 \begin_inset Flex Code
26251 \begin_layout Plain Layout
26259 \begin_inset Flex Code
26262 \begin_layout Plain Layout
26270 \begin_inset Flex Code
26273 \begin_layout Plain Layout
26281 \begin_inset Flex Code
26284 \begin_layout Plain Layout
26291 \begin_inset Flex Code
26294 \begin_layout Plain Layout
26301 Each of these turns on or off the corresponding attribute.
26304 \begin_inset Flex Code
26307 \begin_layout Plain Layout
26315 \begin_inset Flex Code
26318 \begin_layout Plain Layout
26326 \begin_inset Newline newline
26329 If the latter seems puzzling,
26330 remember that the font settings for the present context are generally inherited from the surrounding context.
26332 \begin_inset Flex Code
26335 \begin_layout Plain Layout
26341 would turn off the emphasis that was anyway in effect,
26343 in a theorem environment.
26346 \begin_layout Description
26347 \begin_inset Flex Code
26350 \begin_layout Plain Layout
26357 \begin_inset Flex Code
26360 \begin_layout Plain Layout
26370 \begin_inset Flex Code
26373 \begin_layout Plain Layout
26382 \begin_layout Description
26383 \begin_inset Flex Code
26386 \begin_layout Plain Layout
26393 \begin_inset Flex Code
26396 \begin_layout Plain Layout
26406 \begin_inset Flex Code
26409 \begin_layout Plain Layout
26417 \begin_inset Flex Code
26420 \begin_layout Plain Layout
26428 \begin_inset Flex Code
26431 \begin_layout Plain Layout
26440 \begin_layout Description
26441 \begin_inset Flex Code
26444 \begin_layout Plain Layout
26451 \begin_inset Flex Code
26454 \begin_layout Plain Layout
26462 \begin_inset Flex Code
26465 \begin_layout Plain Layout
26473 \begin_inset Flex Code
26476 \begin_layout Plain Layout
26486 \begin_inset Flex Code
26489 \begin_layout Plain Layout
26497 \begin_inset Flex Code
26500 \begin_layout Plain Layout
26508 \begin_inset Flex Code
26511 \begin_layout Plain Layout
26519 \begin_inset Flex Code
26522 \begin_layout Plain Layout
26530 \begin_inset Flex Code
26533 \begin_layout Plain Layout
26542 \begin_layout Subsection
26543 \begin_inset CommandInset label
26545 name "subsec:Citation-engine-description"
26549 Cite engine description
26552 \begin_layout Standard
26554 \begin_inset Flex Code
26557 \begin_layout Plain Layout
26564 as used mainly in cite engine files (see
26565 \begin_inset CommandInset ref
26567 reference "subsec:Cite-Engine-Files"
26576 define the citation commands provided by a specific
26577 \begin_inset Quotes eld
26581 \begin_inset Quotes erd
26586 in \SpecialChar LyX
26588 is way specific way to format citations,
26590 author names and/or years.
26593 supports three such engine types,
26597 \begin_layout Enumerate
26598 \begin_inset Flex Code
26601 \begin_layout Plain Layout
26608 the default Bib\SpecialChar TeX
26609 way to format citations,
26610 a simple numeric style (e.
26611 \begin_inset space \thinspace{}
26616 \begin_inset Quotes eld
26620 \begin_inset Quotes erd
26626 \begin_layout Enumerate
26627 \begin_inset Flex Code
26630 \begin_layout Plain Layout
26637 Harvard-styled citations using author names and publication year (e.
26638 \begin_inset space \thinspace{}
26643 \begin_inset Quotes eld
26646 Smith and Miller (2017b)
26647 \begin_inset Quotes erd
26653 \begin_layout Enumerate
26654 \begin_inset Flex Code
26657 \begin_layout Plain Layout
26664 extended numerical citations that also allow for author or title next to the number (e.
26665 \begin_inset space \thinspace{}
26670 \begin_inset Quotes eld
26673 Smith and Miller [1]
26674 \begin_inset Quotes erd
26680 \begin_layout Standard
26681 \begin_inset Flex Code
26684 \begin_layout Plain Layout
26690 blocks look like this:
26693 \begin_layout LyX-Code
26697 \begin_layout LyX-Code
26701 \begin_layout LyX-Code
26705 \begin_layout LyX-Code
26706 citeyearpar[][]=parencite*
26709 \begin_layout LyX-Code
26713 \begin_layout LyX-Code
26717 \begin_layout Standard
26719 \begin_inset Flex Code
26722 \begin_layout Plain Layout
26728 denotes the engine.
26729 The individual lines respectively define a cite command or cite command paradigm supported by this engine.
26730 The line can be as simple as a cite command that is used both to name the respective \SpecialChar LyX
26731 command and the \SpecialChar LaTeX
26732 output or more complex in order to differentiate things.
26733 The full syntax is:
26736 \begin_layout LyX-Code
26737 LyXName|alias$*<!_stardesc!_stardesctooltip>[][]=latexcmd
26740 \begin_layout Itemize
26741 \begin_inset Flex Code
26744 \begin_layout Plain Layout
26751 The name as used in the
26752 \begin_inset Flex Code
26755 \begin_layout Plain Layout
26765 \begin_layout Standard
26766 For portability reasons,
26767 we try to use the same name for same-formatted commands in different cite packages (thus many names stem from natbib,
26768 and thus we need to differentiate a
26769 \begin_inset Flex Code
26772 \begin_layout Plain Layout
26779 if the \SpecialChar LaTeX
26780 command names differ).
26784 \begin_layout Itemize
26785 \begin_inset Flex Code
26788 \begin_layout Plain Layout
26795 a (comma-separated) list of commands that fall back to the given
26796 \begin_inset Flex Code
26799 \begin_layout Plain Layout
26805 in the current engine.
26806 This eases the switch of citation packages and engines.
26808 \begin_inset Flex Code
26811 \begin_layout Plain Layout
26818 \begin_inset Flex Code
26821 \begin_layout Plain Layout
26827 in layout definitions.
26830 \begin_layout Itemize
26831 \begin_inset Flex Code
26834 \begin_layout Plain Layout
26841 The actual \SpecialChar LaTeX
26842 command that is output.
26846 \begin_layout Standard
26847 \begin_inset Flex Code
26850 \begin_layout Plain Layout
26857 \begin_inset Flex Code
26860 \begin_layout Plain Layout
26868 \begin_inset Flex Code
26871 \begin_layout Plain Layout
26879 \begin_inset Flex Code
26882 \begin_layout Plain Layout
26888 will be output to \SpecialChar LaTeX
26892 \begin_layout Standard
26896 \begin_layout Itemize
26897 Capitalization indicates that the command also has a capitalized form (
26898 \begin_inset Flex Code
26901 \begin_layout Plain Layout
26911 \begin_inset Flex Code
26914 \begin_layout Plain Layout
26923 These usually enforce up-casing of name prefixes (
26928 \begin_inset Formula $\Rightarrow$
26938 \begin_layout Itemize
26940 \begin_inset Flex Code
26943 \begin_layout Plain Layout
26949 indicate the number of optional arguments (there can be 0–2).
26952 \begin_layout Itemize
26954 \begin_inset Flex Code
26957 \begin_layout Plain Layout
26963 indicates there is a starred version of the command (
26964 \begin_inset Flex Code
26967 \begin_layout Plain Layout
26977 \begin_inset Flex Code
26980 \begin_layout Plain Layout
26993 \begin_layout Standard
26995 the starred version means:
26996 Output all authors even if it should be shortened with
26997 \begin_inset Quotes eld
27001 \begin_inset Quotes erd
27005 \begin_inset Flex Code
27008 \begin_layout Plain Layout
27017 \begin_layout Standard
27018 If the star has a different meaning for a given command,
27019 it can be specified in angle brackets:
27021 \begin_inset Flex Code
27024 \begin_layout Plain Layout
27025 <!_stardesc!_stardesctooltip>
27031 Maximal two translatable macro keywords,
27032 marked by the prefix
27033 \begin_inset Flex Code
27036 \begin_layout Plain Layout
27044 The first points to the string that replaces the
27045 \begin_inset Quotes eld
27049 \begin_inset Quotes erd
27052 checkbox label in the citation dialog,
27053 the second one to an optional tool tip for this checkbox.
27057 \begin_layout Standard
27058 Note that these two macros have to be defined in a
27059 \begin_inset Flex Code
27062 \begin_layout Plain Layout
27068 (see next section),
27070 \begin_inset Flex Code
27073 \begin_layout Plain Layout
27084 \begin_layout LyX-Code
27085 _stardesc Sta&rred command label
27088 \begin_layout LyX-Code
27089 _stardesctooltip Tooltip for the starred command checkbox.
27093 \begin_layout Itemize
27095 \begin_inset Flex Code
27098 \begin_layout Plain Layout
27104 indicates that this command features
27105 \begin_inset Quotes eld
27108 qualified citation lists
27109 \begin_inset Quotes erd
27117 -specific feature for multi-reference citations where an individual pre- and postnote can be given to each reference in the list.
27118 Please refer to the
27122 manual for details.
27123 \change_inserted -712698321 1526898670
27127 \begin_layout Standard
27129 \change_inserted -712698321 1526899524
27130 If you want to add a cite command to a cite engine (e.
27131 \begin_inset space \thinspace{}
27135 add a specific command provided by a class),
27137 \begin_inset Flex Code
27140 \begin_layout Plain Layout
27142 \change_inserted -712698321 1526898768
27143 AddToCiteEngine <engine type> \SpecialChar ldots
27152 Note that only cite commands that do not exist yet are added.
27157 \begin_layout Subsection
27158 \begin_inset CommandInset label
27160 name "subsec:Citation-format-description"
27164 Cite format description
27167 \begin_layout Standard
27169 \begin_inset Flex Code
27172 \begin_layout Plain Layout
27178 blocks are used to describe how bibliographic information should be displayed,
27179 both within \SpecialChar LyX
27180 itself (in the citation dialog and in tooltips,
27181 for example) and in XHTML output.
27182 Such a block might look like this:
27185 \begin_layout LyX-Code
27189 \begin_layout LyX-Code
27193 \begin_layout LyX-Code
27197 \begin_layout LyX-Code
27201 \begin_layout Standard
27205 \begin_layout LyX-Code
27209 \begin_layout LyX-Code
27213 \begin_layout LyX-Code
27217 \begin_layout LyX-Code
27221 \begin_layout Standard
27223 the individual lines define how the bibliographic information associated with an article or book,
27225 is to be displayed,
27226 and such a definition can be given for any
27227 \begin_inset Quotes els
27231 \begin_inset Quotes ers
27234 that might be present in a Bib\SpecialChar TeX
27237 defines a default format in the source code that will be used if no specific definition has been given.
27239 predefines several formats in the file
27240 \begin_inset Flex Code
27243 \begin_layout Plain Layout
27250 which is included in most of \SpecialChar LyX
27251 's document classes.
27254 \begin_layout Standard
27255 In the second case,
27256 the lines define how a specific citation command (in the example
27257 \begin_inset Flex Code
27260 \begin_layout Plain Layout
27270 \begin_inset Flex Code
27273 \begin_layout Plain Layout
27281 ) is to be displayed on the citation inset label,
27282 in the citation dialog,
27283 menu or XHTML output.
27285 defines such formats for the citation style variants it supports via
27287 Document\SpecialChar menuseparator
27288 Setting\SpecialChar menuseparator
27289 Bibliography\SpecialChar ldots
27293 \begin_inset Flex Code
27296 \begin_layout Plain Layout
27302 files that are shipped with \SpecialChar LyX
27304 \begin_inset CommandInset ref
27306 reference "subsec:Cite-Engine-Files"
27317 \begin_layout Standard
27318 The definitions use a simple language that allows Bib\SpecialChar TeX
27319 keys to be replaced with their values.
27320 Keys should be enclosed in
27321 \begin_inset Flex Code
27324 \begin_layout Plain Layout
27333 \begin_inset Flex Code
27336 \begin_layout Plain Layout
27343 So a simple definition might look like this:
27346 \begin_layout LyX-Code
27349 \begin_inset Quotes eld
27353 \begin_inset Quotes erd
27359 \begin_layout Standard
27360 This would print the author,
27361 followed by a comma,
27362 followed by the title,
27364 followed by a period.
27367 \begin_layout Standard
27369 sometimes you may want to print a key only if it exists.
27370 This can be done by using a conditional construction,
27373 \begin_inset Flex Code
27376 \begin_layout Plain Layout
27378 \begin_inset space ~
27389 \begin_inset Flex Code
27392 \begin_layout Plain Layout
27400 \begin_inset Quotes eld
27404 \begin_inset space ~
27408 \begin_inset Quotes erd
27411 followed by the volume key.
27412 It is also possible to have an else clause in the conditional,
27414 \begin_inset Newline newline
27418 \begin_inset Flex Code
27421 \begin_layout Plain Layout
27422 {%author%[[%author%]][[%editor%,
27429 \begin_inset Newline newline
27434 \begin_inset Flex Code
27437 \begin_layout Plain Layout
27443 key is printed if it exists;
27445 the editor key is printed,
27447 \begin_inset Quotes eld
27451 \begin_inset space ~
27455 \begin_inset Quotes erd
27458 Note that the key is again enclosed in
27459 \begin_inset Flex Code
27462 \begin_layout Plain Layout
27469 the entire conditional is enclosed in braces;
27470 and the if and else clauses are enclosed in double brackets,
27472 \begin_inset Quotes eld
27476 \begin_inset Flex Code
27479 \begin_layout Plain Layout
27486 \begin_inset Quotes eld
27490 \begin_inset Quotes eld
27494 \begin_inset Flex Code
27497 \begin_layout Plain Layout
27504 \begin_inset Quotes erd
27508 There must be no space between any of these.
27511 \begin_layout Standard
27512 Next to the entry keys,
27513 there are some special keys that can be used for these conditionals:
27516 \begin_layout Itemize
27517 \begin_inset Flex Code
27520 \begin_layout Plain Layout
27521 {%dialog%[[true]][[false]]}
27528 \begin_inset Quotes eld
27532 \begin_inset Quotes erd
27535 part for dialogs and menus,
27537 \begin_inset Quotes eld
27541 \begin_inset Quotes erd
27544 part for other contexts (workarea,
27548 \begin_layout Itemize
27549 \begin_inset Flex Code
27552 \begin_layout Plain Layout
27553 {%export%[[true]][[false]]}
27560 \begin_inset Quotes eld
27564 \begin_inset Quotes erd
27567 part for export and menus,
27569 \begin_inset Quotes eld
27573 \begin_inset Quotes erd
27576 part for other contexts (workarea,
27580 \begin_layout Itemize
27581 \begin_inset Flex Code
27584 \begin_layout Plain Layout
27592 \begin_inset Quotes eld
27596 \begin_inset Quotes erd
27599 part if another item follows (e.
27600 \begin_inset space \thinspace{}
27604 in a citation with multiple keys)
27607 \begin_layout Itemize
27608 \begin_inset Flex Code
27611 \begin_layout Plain Layout
27612 {%second%[[true]][[false]]}
27619 \begin_inset Quotes eld
27623 \begin_inset Quotes erd
27626 if this is the second of multiple items,
27628 \begin_inset Quotes eld
27632 \begin_inset Quotes erd
27638 \begin_layout Itemize
27639 \begin_inset Flex Code
27642 \begin_layout Plain Layout
27643 {%ifstar%[[true]][[false]]}
27650 \begin_inset Quotes eld
27654 \begin_inset Quotes erd
27657 part for starred citation commands (such as
27658 \begin_inset Flex Code
27661 \begin_layout Plain Layout
27670 the false part for unstarred
27673 \begin_layout Itemize
27674 \begin_inset Flex Code
27677 \begin_layout Plain Layout
27678 {%ifentrytype:<type>%[[true]][[false]]}
27685 \begin_inset Quotes eld
27689 \begin_inset Quotes erd
27692 if the current entry type matches
27693 \begin_inset Flex Code
27696 \begin_layout Plain Layout
27703 else the false part (e.g.,
27704 in a citation definition:
27706 \begin_inset Flex Code
27709 \begin_layout Plain Layout
27710 {%ifentrytype:book%[[this is a book]][[this is no book]]}
27718 \begin_layout Itemize
27719 \begin_inset Flex Code
27722 \begin_layout Plain Layout
27723 {%ifmultiple:<authortype>%[[true]][[false]]}
27730 \begin_inset Quotes eld
27734 \begin_inset Quotes erd
27737 if the current author type (author,
27738 editor etc.) has multiple authors,
27739 else the false part (e.g.,
27740 in a bibliography definition:
27742 \begin_inset Flex Code
27745 \begin_layout Plain Layout
27746 {%ifmultiple:editor%[[eds.]][[ed.]]}
27754 \begin_layout Itemize
27755 \begin_inset Flex Code
27758 \begin_layout Plain Layout
27759 {%ifqualified%[[true]][[false]]}
27766 \begin_inset Quotes eld
27770 \begin_inset Quotes erd
27773 part if the current citation is a qualified citation list (a specific
27777 format for multi-reference citations),
27778 the false part if this is not the case.
27781 \begin_layout Standard
27783 \begin_inset Flex Code
27786 \begin_layout Plain Layout
27792 prints the author key as it is recorded in the bibliography file.
27793 This might not be what you want,
27794 since it will result in a string such as
27795 \begin_inset Quotes eld
27802 \begin_inset Quotes erd
27806 \begin_inset Quotes eld
27810 \begin_inset Quotes erd
27813 is used by Bib\SpecialChar TeX
27814 to delimit authors).
27816 therefore provides some methods to get properly formatted name lists (which will also get translated).
27817 The following keys are provided:
27820 \begin_layout Enumerate
27821 For name lists with pre- and surname,
27822 suitable for the main authors/editors of a bibliography item.
27824 \begin_inset Flex Code
27827 \begin_layout Plain Layout
27833 part denotes the kind of list that is requested (e.g.
27835 \begin_inset Flex Code
27838 \begin_layout Plain Layout
27848 \begin_layout Itemize
27849 \begin_inset Flex Code
27852 \begin_layout Plain Layout
27853 %abbrvnames:<nametype>%
27859 Provides a name list which is abbreviated (with
27860 \begin_inset Quotes eld
27864 \begin_inset Quotes erd
27868 \begin_inset Flex Code
27871 \begin_layout Plain Layout
27880 \begin_layout Itemize
27881 \begin_inset Flex Code
27884 \begin_layout Plain Layout
27885 %fullnames:<nametype>%
27891 Provides a full name list (never abbreviated with
27892 \begin_inset Quotes eld
27896 \begin_inset Quotes erd
27902 \begin_layout Itemize
27903 \begin_inset Flex Code
27906 \begin_layout Plain Layout
27907 %forceabbrvnames:<nametype>%
27913 Provides a name list which is always abbreviated (with
27914 \begin_inset Quotes eld
27918 \begin_inset Quotes erd
27922 \begin_inset Flex Code
27925 \begin_layout Plain Layout
27935 \begin_layout Enumerate
27936 Alternative name lists with pre- and surname,
27937 if the order of pre- and surname inside the bibliography item differs (as in:
27939 \begin_inset Quotes eld
27949 \begin_inset Quotes erd
27956 \begin_layout Itemize
27957 \begin_inset Flex Code
27960 \begin_layout Plain Layout
27961 %abbrvbynames:<nametype>%
27967 Provides a name list which is abbreviated (with
27968 \begin_inset Quotes eld
27972 \begin_inset Quotes erd
27976 \begin_inset Flex Code
27979 \begin_layout Plain Layout
27988 \begin_layout Itemize
27989 \begin_inset Flex Code
27992 \begin_layout Plain Layout
27993 %fullbynames:<nametype>%
27999 Provides a full name list (never abbreviated with
28000 \begin_inset Quotes eld
28004 \begin_inset Quotes erd
28010 \begin_layout Itemize
28011 \begin_inset Flex Code
28014 \begin_layout Plain Layout
28015 %forceabbrvbynames:<nametype>%
28021 Provides a name list which is always abbreviated (with
28022 \begin_inset Quotes eld
28026 \begin_inset Quotes erd
28030 \begin_inset Flex Code
28033 \begin_layout Plain Layout
28043 \begin_layout Enumerate
28044 And finally name lists which consist of family names only,
28045 as used in author-year citation labels.
28046 These do not take a
28047 \begin_inset Flex Code
28050 \begin_layout Plain Layout
28057 but always return either an author list or,
28058 if this does not exist,
28059 an editor list (as common in author-year labels):
28063 \begin_layout Itemize
28064 \begin_inset Flex Code
28067 \begin_layout Plain Layout
28074 Provides a name list which is abbreviated (with
28075 \begin_inset Quotes eld
28079 \begin_inset Quotes erd
28083 \begin_inset Flex Code
28086 \begin_layout Plain Layout
28095 \begin_layout Itemize
28096 \begin_inset Flex Code
28099 \begin_layout Plain Layout
28106 Provides a full name list (never abbreviated with
28107 \begin_inset Quotes eld
28111 \begin_inset Quotes erd
28117 \begin_layout Itemize
28118 \begin_inset Flex Code
28121 \begin_layout Plain Layout
28122 %forceabbrvciteauthor%
28128 Provides a name list which is always abbreviated (with
28129 \begin_inset Quotes eld
28133 \begin_inset Quotes erd
28137 \begin_inset Flex Code
28140 \begin_layout Plain Layout
28150 \begin_layout Standard
28151 The order of pre- and surname in the former two lists can be adjusted by these macros:
28154 \begin_layout Itemize
28155 \begin_inset Flex Code
28158 \begin_layout Plain Layout
28159 !firstnameform %surname%,
28165 (first author in lists of type 1)
28168 \begin_layout Itemize
28169 \begin_inset Flex Code
28172 \begin_layout Plain Layout
28173 !othernameform %surname%,
28179 (other authors in lists of type 1)
28182 \begin_layout Itemize
28183 \begin_inset Flex Code
28186 \begin_layout Plain Layout
28187 !firstbynameform %prename% %surname%
28192 (first author in lists of type 2)
28195 \begin_layout Itemize
28196 \begin_inset Flex Code
28199 \begin_layout Plain Layout
28200 !otherbynameform %prename% %surname%
28205 (other authors in lists of type 2)
28208 \begin_layout Standard
28209 This allows you to configure namings like
28210 \begin_inset Quotes eld
28214 Peter and Mary Smith:
28218 John Doe and Pat Green,
28219 eds.:\SpecialChar ldots
28221 \begin_inset Quotes erd
28227 \begin_layout Standard
28228 There is one other piece of syntax available in definitions,
28229 which looks like this:
28231 \begin_inset Flex Code
28234 \begin_layout Plain Layout
28241 This defines a piece of formatting information that is to be used when creating
28242 \begin_inset Quotes eld
28246 \begin_inset Quotes erd
28251 we do not want to output HTML tags when writing plain text,
28252 so they should be wrapped in
28253 \begin_inset Quotes eld
28257 \begin_inset Quotes erd
28261 \begin_inset Quotes eld
28265 \begin_inset Quotes erd
28271 \begin_layout Standard
28272 Two special sorts of definitions are also possible in a
28273 \begin_inset Flex Code
28276 \begin_layout Plain Layout
28283 An example of the first would be:
28286 \begin_layout LyX-Code
28288 \begin_inset Quotes eld
28292 \begin_inset Quotes erd
28298 \begin_layout Standard
28299 This is an abbreviation,
28301 and it can be used by treating it as if it were a key:
28303 \begin_inset Flex Code
28306 \begin_layout Plain Layout
28315 \begin_inset Flex Code
28318 \begin_layout Plain Layout
28324 exactly as it would treat its definition.
28326 let us issue the obvious
28334 \begin_layout LyX-Code
28338 \begin_layout Standard
28339 or anything like it.
28341 shouldn't go into an infinite loop,
28342 but it may go into a long one before it gives up.
28345 \begin_layout Standard
28346 The second sort of special definition might look like this:
28349 \begin_layout LyX-Code
28353 \begin_layout Standard
28354 This defines a translatable piece of text,
28355 which allows relevant parts of the bibliography or citation to be translated.
28356 It can be included in a definition by treating it as a key:
28358 \begin_inset Flex Code
28361 \begin_layout Plain Layout
28368 Note that there are two different translation paths:
28369 All definitions starting with
28370 \begin_inset Flex Code
28373 \begin_layout Plain Layout
28380 such as in the example above,
28381 will be translated to the currently active buffer language (so the translation will match the generated document).
28382 All definitions starting with underscore only will be translated to the GUI language.
28383 This is the proper translation for strings that only occur in the dialogs or on buttons,
28387 \begin_layout LyX-Code
28388 _addtobib Add to bibliography only.
28391 \begin_layout Standard
28392 Several of these translatable strings are predefined in
28393 \begin_inset Flex Code
28396 \begin_layout Plain Layout
28403 \begin_inset Flex Code
28406 \begin_layout Plain Layout
28413 Note that these are not macros,
28414 in the sense just defined.
28415 They will not be expanded.
28418 \begin_layout Standard
28419 So here then is an example that uses several of these features:
28420 \begin_inset VSpace defskip
28426 \begin_layout Standard
28430 !authoredit {%author%[[%author%,
28431 ]][[{%editor%[[%editor%,
28436 \begin_layout Standard
28437 \begin_inset VSpace defskip
28440 This defines a macro that prints the author,
28441 followed by a comma,
28443 \begin_inset Flex Code
28446 \begin_layout Plain Layout
28453 or else prints the name of the editor,
28455 \begin_inset Flex Code
28458 \begin_layout Plain Layout
28464 or its translation (it is by default
28465 \begin_inset Quotes eld
28469 \begin_inset Quotes erd
28474 \begin_inset Flex Code
28477 \begin_layout Plain Layout
28484 Note that this is in fact defined in
28485 \begin_inset Flex Code
28488 \begin_layout Plain Layout
28495 so you can use it in your own definitions,
28497 if you load that file first.
28500 \begin_layout Section
28501 \begin_inset CommandInset label
28503 name "sec:Tags-for-XHTML"
28507 Tags for XHTML output
28510 \begin_layout Standard
28511 As with \SpecialChar LaTeX
28513 the format of \SpecialChar LyX
28514 's XHTML output is also controlled by layout information.
28517 provides sensible defaults and,
28518 as mentioned earlier,
28519 it will even construct default CSS style rules from the other layout tags.
28522 will attempt to use the information provided in the
28523 \begin_inset Flex Code
28526 \begin_layout Plain Layout
28532 declaration for the Chapter style to write CSS that will appropriately format chapter headings.
28535 \begin_layout Standard
28538 you may not have to do anything at all to get acceptable XHTML output for your own environments,
28541 But in some cases you will,
28542 and so \SpecialChar LyX
28543 provides a number of layout tags that can be used to customize the XHTML and CSS that are generated.
28546 \begin_layout Standard
28547 Note that there are two tags,
28549 \begin_inset Flex Code
28552 \begin_layout Plain Layout
28559 \begin_inset Flex Code
28562 \begin_layout Plain Layout
28568 that may appear outside style and inset declarations.
28570 \begin_inset CommandInset ref
28572 reference "subsec:General-text-class"
28577 for details on these.
28580 \begin_layout Subsection
28581 \begin_inset CommandInset label
28583 name "subsec:Paragraph-Style-XHTML"
28590 \begin_layout Standard
28591 The sort of XHTML \SpecialChar LyX
28592 outputs for a paragraph depends upon whether we are dealing with a normal paragraph,
28595 where this is itself determined by the contents of the corresponding
28596 \begin_inset Flex Code
28599 \begin_layout Plain Layout
28610 \begin_layout Standard
28611 For a command or normal paragraph,
28612 the output XHTML has the following form:
28615 \begin_layout LyX-Code
28619 \begin_inset Quotes erd
28623 \begin_inset Quotes erd
28629 \begin_layout LyX-Code
28633 \begin_inset Quotes erd
28637 \begin_inset Quotes erd
28643 \begin_layout LyX-Code
28646 Contents of the paragraph.
28649 \begin_layout LyX-Code
28655 \begin_layout Standard
28656 The label tags are of course omitted if the paragraph does not have a label.
28659 \begin_layout Standard
28660 For an environment that is not some sort of list,
28661 the XHTML takes this form:
28664 \begin_layout LyX-Code
28668 \begin_inset Quotes erd
28672 \begin_inset Quotes erd
28678 \begin_layout LyX-Code
28682 \begin_inset Quotes erd
28686 \begin_inset Quotes erd
28690 \begin_inset Quotes erd
28694 \begin_inset Quotes erd
28697 >Environment Label</labeltag>First paragraph.</itemtag>
28700 \begin_layout LyX-Code
28703 <itemtag>Second paragraph.</itemtag>
28706 \begin_layout LyX-Code
28712 \begin_layout Standard
28713 Note that the label is output only for the first paragraph,
28714 as it should be for a theorem,
28719 \begin_layout Standard
28721 we have one of these forms:
28724 \begin_layout LyX-Code
28728 \begin_inset Quotes erd
28732 \begin_inset Quotes erd
28738 \begin_layout LyX-Code
28742 \begin_inset Quotes erd
28746 \begin_inset Quotes erd
28750 \begin_inset Quotes erd
28754 \begin_inset Quotes erd
28757 >List Label</labeltag>First item.</itemtag>
28760 \begin_layout LyX-Code
28764 \begin_inset Quotes erd
28768 \begin_inset Quotes erd
28772 \begin_inset Quotes erd
28776 \begin_inset Quotes erd
28779 >List Label</labeltag>Second item.</itemtag>
28782 \begin_layout LyX-Code
28788 \begin_layout LyX-Code
28792 \begin_layout LyX-Code
28796 \begin_inset Quotes erd
28800 \begin_inset Quotes erd
28806 \begin_layout LyX-Code
28810 \begin_inset Quotes erd
28814 \begin_inset Quotes erd
28817 >List Label</labeltag><itemtag attr=
28818 \begin_inset Quotes erd
28822 \begin_inset Quotes erd
28825 >First item.</itemtag>
28828 \begin_layout LyX-Code
28832 \begin_inset Quotes erd
28836 \begin_inset Quotes erd
28839 >List Label</labeltag><itemtag attr=
28840 \begin_inset Quotes erd
28844 \begin_inset Quotes erd
28847 >Second item.</itemtag>
28850 \begin_layout LyX-Code
28856 \begin_layout Standard
28857 Note the different orders of
28858 \begin_inset Flex Code
28861 \begin_layout Plain Layout
28868 \begin_inset Flex Code
28871 \begin_layout Plain Layout
28878 Which order we get depends upon the setting of
28879 \begin_inset Flex Code
28882 \begin_layout Plain Layout
28890 \begin_inset Flex Code
28893 \begin_layout Plain Layout
28899 is false (the default),
28900 you get the first of these,
28901 with the label within the item;
28903 you get the second,
28904 with the label outside the item.
28907 \begin_layout Standard
28908 The specific tags and attributes output for each paragraph type can be controlled by means of the layout tags we are about to describe.
28909 As mentioned earlier,
28912 uses sensible defaults for many of these,
28913 so you often may not need to do very much to get good XHTML output.
28914 Think of the available tags as there so you can tweak things to your liking.
28917 \begin_layout Description
28918 \begin_inset Flex Code
28921 \begin_layout Plain Layout
28928 \begin_inset Flex Code
28931 \begin_layout Plain Layout
28937 ] Specifies attribute information to be output with the main tag.
28940 \begin_inset Quotes eld
28944 \begin_inset Flex Code
28947 \begin_layout Plain Layout
28954 \begin_inset Quotes erd
28961 \begin_inset Quotes eld
28965 \begin_inset Flex Code
28968 \begin_layout Plain Layout
28975 \begin_inset Quotes erd
28980 \begin_inset Flex Code
28983 \begin_layout Plain Layout
28989 is the \SpecialChar LyX
28990 name of the layout,
28998 contain any style information.
29000 \begin_inset Flex Code
29003 \begin_layout Plain Layout
29010 \change_inserted -584632292 1670182206
29014 \begin_layout Description
29016 \change_inserted -584632292 1670182369
29017 \begin_inset Flex Code
29020 \begin_layout Plain Layout
29022 \change_inserted -584632292 1670182222
29031 \begin_inset Flex Code
29034 \begin_layout Plain Layout
29036 \change_inserted -584632292 1670182217
29044 ] The CSS class to use for this paragraph.
29046 if the paragarph is of enumerate or itemize type,
29047 then the default will be
29048 \begin_inset Quotes eld
29052 \begin_inset Quotes erd
29056 \begin_inset Quotes eld
29060 \begin_inset Quotes erd
29065 \begin_inset Quotes eld
29069 \begin_inset Quotes erd
29074 \begin_inset Quotes eld
29078 \begin_inset Quotes erd
29083 \begin_inset Quotes eld
29087 \begin_inset Quotes erd
29092 \begin_inset Quotes eld
29096 \begin_inset Quotes erd
29100 depending upon the depth.
29101 That can be over-ridden here.
29103 the suffix will not be added in that case.
29105 the CSS class will always be exactly what it is declared to be here.
29110 \begin_layout Description
29111 \begin_inset Flex Code
29114 \begin_layout Plain Layout
29121 \begin_inset Flex Code
29124 \begin_layout Plain Layout
29134 ] Whether to output the default CSS information \SpecialChar LyX
29135 generates for this layout,
29136 even if additional information is explicitly provided via
29137 \begin_inset Flex Code
29140 \begin_layout Plain Layout
29148 \begin_inset Flex Code
29151 \begin_layout Plain Layout
29157 allows you to alter or augment the generated CSS,
29158 rather than to override it completely.
29160 \begin_inset Flex Code
29163 \begin_layout Plain Layout
29170 \change_inserted -584632292 1670132213
29174 \begin_layout Description
29176 \change_inserted -584632292 1670132277
29177 \begin_inset Flex Code
29180 \begin_layout Plain Layout
29182 \change_inserted -584632292 1670132221
29191 \begin_inset Flex Code
29194 \begin_layout Plain Layout
29196 \change_inserted -584632292 1670132214
29206 ] Whether to include this paragraph (usually,
29207 a section or something of the sort) in the TOC.
29210 so it should be set to false e.g.
29211 \begin_inset space ~
29214 for starred sections.
29219 \begin_layout Description
29220 \begin_inset Flex Code
29223 \begin_layout Plain Layout
29230 \begin_inset Flex Code
29233 \begin_layout Plain Layout
29239 ] The tag to be used for individual paragraphs of environments,
29241 \begin_inset Flex Code
29244 \begin_layout Plain Layout
29250 in the examples above.
29252 \begin_inset Flex Code
29255 \begin_layout Plain Layout
29264 \begin_layout Description
29265 \begin_inset Flex Code
29268 \begin_layout Plain Layout
29275 \begin_inset Flex Code
29278 \begin_layout Plain Layout
29284 ] Attributes for the item tag.
29286 \begin_inset Newline newline
29290 \begin_inset Quotes eld
29294 \begin_inset Flex Code
29297 \begin_layout Plain Layout
29298 class=`layoutname_item'
29304 \begin_inset Quotes erd
29312 contain any style information.
29314 \begin_inset Flex Code
29317 \begin_layout Plain Layout
29326 \begin_layout Description
29327 \begin_inset Flex Code
29330 \begin_layout Plain Layout
29337 \begin_inset Flex Code
29340 \begin_layout Plain Layout
29346 ] The tag to be used for paragraph and item labels,
29348 \begin_inset Flex Code
29351 \begin_layout Plain Layout
29357 in the examples above.
29359 \begin_inset Flex Code
29362 \begin_layout Plain Layout
29370 \begin_inset Flex Code
29373 \begin_layout Plain Layout
29380 \begin_inset Flex Code
29383 \begin_layout Plain Layout
29390 \begin_inset Flex Code
29393 \begin_layout Plain Layout
29394 Centered_Top_Environment
29400 in which case it defaults to
29401 \begin_inset Flex Code
29404 \begin_layout Plain Layout
29413 \begin_layout Description
29414 \begin_inset Flex Code
29417 \begin_layout Plain Layout
29424 \begin_inset Flex Code
29427 \begin_layout Plain Layout
29433 ] Attributes for the label tag.
29435 \begin_inset Newline newline
29439 \begin_inset Quotes eld
29443 \begin_inset Flex Code
29446 \begin_layout Plain Layout
29447 class=`layoutname_label'
29453 \begin_inset Quotes erd
29461 contain any style information.
29463 \begin_inset Flex Code
29466 \begin_layout Plain Layout
29475 \begin_layout Description
29476 \begin_inset Flex Code
29479 \begin_layout Plain Layout
29486 \begin_inset Flex Code
29489 \begin_layout Plain Layout
29499 ] Meaningful only for list-like environments,
29500 this tag controls whether the label tag is output before or inside the item tag.
29503 in the description environment,
29505 \begin_inset Flex Code
29508 \begin_layout Plain Layout
29509 <dt>\SpecialChar ldots
29510 </dt><dd>\SpecialChar ldots
29518 \begin_inset Flex Code
29521 \begin_layout Plain Layout
29528 The label tag is output inside the item tag.
29531 \begin_layout Description
29532 \begin_inset Flex Code
29535 \begin_layout Plain Layout
29541 Information to be output in the
29542 \begin_inset Flex Code
29545 \begin_layout Plain Layout
29551 section when this style is used.
29554 be used to include a
29555 \begin_inset Flex Code
29558 \begin_layout Plain Layout
29565 \begin_inset Flex Code
29568 \begin_layout Plain Layout
29577 \begin_layout Description
29578 \begin_inset Flex Code
29581 \begin_layout Plain Layout
29587 CSS style information to be included when this style is used.
29588 Note that this will automatically be wrapped in a layout-generated
29589 \begin_inset Flex Code
29592 \begin_layout Plain Layout
29599 so only the CSS itself need be included.
29601 \begin_inset Flex Code
29604 \begin_layout Plain Layout
29613 \begin_layout Description
29614 \begin_inset Flex Code
29617 \begin_layout Plain Layout
29624 \begin_inset Flex Code
29627 \begin_layout Plain Layout
29633 ] The tag to be used for the main label,
29635 \begin_inset Flex Code
29638 \begin_layout Plain Layout
29644 in the examples above.
29646 \begin_inset Flex Code
29649 \begin_layout Plain Layout
29658 \begin_layout Description
29659 \begin_inset Flex Code
29662 \begin_layout Plain Layout
29669 \begin_inset Flex Code
29672 \begin_layout Plain Layout
29682 ] Marks this style as the one to be used to generate the
29683 \begin_inset Flex Code
29686 \begin_layout Plain Layout
29692 tag for the XHTML file.
29696 \begin_inset Flex Code
29699 \begin_layout Plain Layout
29705 file sets it to true for the
29706 \begin_inset Flex Code
29709 \begin_layout Plain Layout
29719 \begin_layout Subsection
29723 \begin_layout Standard
29724 The XHTML output of insets can also be controlled by information in layout files.
29728 \begin_layout Plain Layout
29730 this is true only for
29731 \begin_inset Quotes eld
29735 \begin_inset Quotes erd
29738 insets (insets you can type into) and is not true for
29739 \begin_inset Quotes eld
29743 \begin_inset Quotes erd
29746 insets (insets that are associated with dialog boxes).
29754 tries to provide sensible defaults,
29755 and it constructs default CSS style rules.
29756 But everything can be customized.
29759 \begin_layout Standard
29760 The XHTML \SpecialChar LyX
29761 outputs for an inset has the following form:
29764 \begin_layout LyX-Code
29766 \begin_inset Quotes erd
29770 \begin_inset Quotes erd
29776 \begin_layout LyX-Code
29777 <labeltag>Label</labeltag>
29780 \begin_layout LyX-Code
29782 \begin_inset Quotes erd
29786 \begin_inset Quotes erd
29789 >Contents of the inset.</innertag>
29792 \begin_layout LyX-Code
29796 \begin_layout Standard
29797 If the inset permits multiple paragraphs—
29800 \begin_inset Flex Code
29803 \begin_layout Plain Layout
29810 then the contents of the inset will itself be output as paragraphs formatted according to the styles used for those paragraphs (standard,
29813 The label tag is of course omitted if the paragraph does not have a label and,
29816 \begin_inset Flex Code
29819 \begin_layout Plain Layout
29826 The inner tag is optional and,
29831 \begin_layout Standard
29832 The specific tags and attributes output for each inset can be controlled by means of the following layout tags.
29835 \begin_layout Description
29836 \begin_inset Flex Code
29839 \begin_layout Plain Layout
29846 \begin_inset Flex Code
29849 \begin_layout Plain Layout
29855 ] Specifies attribute information to be output with the main tag.
29858 \begin_inset Quotes eld
29862 \begin_inset Flex Code
29865 \begin_layout Plain Layout
29866 class=`myinset' onclick=`\SpecialChar ldots
29873 \begin_inset Quotes erd
29880 \begin_inset Quotes eld
29884 \begin_inset Flex Code
29887 \begin_layout Plain Layout
29894 \begin_inset Quotes erd
29899 \begin_inset Flex Code
29902 \begin_layout Plain Layout
29908 is the \SpecialChar LyX
29910 made lowercase and with non-alphanumeric characters converted to underscores,
29915 \begin_layout Description
29916 \begin_inset Flex Code
29919 \begin_layout Plain Layout
29926 \begin_inset Flex Code
29929 \begin_layout Plain Layout
29939 ] Whether to output the default CSS information \SpecialChar LyX
29940 generates for this layout,
29941 even if additional information is explicitly provided via
29942 \begin_inset Flex Code
29945 \begin_layout Plain Layout
29953 \begin_inset Flex Code
29956 \begin_layout Plain Layout
29962 allows you to alter or augment the generated CSS,
29963 rather than to override it completely.
29967 \begin_layout Description
29968 \begin_inset Flex Code
29971 \begin_layout Plain Layout
29978 \begin_inset Flex Code
29981 \begin_layout Plain Layout
29987 ] Attributes for the inner tag.
29989 \begin_inset Newline newline
29993 \begin_inset Quotes eld
29997 \begin_inset Flex Code
30000 \begin_layout Plain Layout
30001 class=`insetname_inner'
30007 \begin_inset Quotes erd
30013 \begin_layout Description
30014 \begin_inset Flex Code
30017 \begin_layout Plain Layout
30024 \begin_inset Flex Code
30027 \begin_layout Plain Layout
30035 \begin_inset Flex Code
30038 \begin_layout Plain Layout
30044 in the examples above.
30049 \begin_layout Description
30050 \begin_inset Flex Code
30053 \begin_layout Plain Layout
30060 \begin_inset Flex Code
30063 \begin_layout Plain Layout
30071 ] 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).
30075 \begin_layout Description
30076 \begin_inset Flex Code
30079 \begin_layout Plain Layout
30086 \begin_inset Flex Code
30089 \begin_layout Plain Layout
30095 ] A label for this inset,
30096 possibly including a reference to a counter.
30101 \begin_inset Flex Code
30104 \begin_layout Plain Layout
30114 and there is no default.
30117 \begin_layout Description
30118 \begin_inset Flex Code
30121 \begin_layout Plain Layout
30127 Information to be output in the
30128 \begin_inset Flex Code
30131 \begin_layout Plain Layout
30137 section when this style is used.
30140 be used to include a
30141 \begin_inset Flex Code
30144 \begin_layout Plain Layout
30151 \begin_inset Flex Code
30154 \begin_layout Plain Layout
30163 \begin_layout Description
30164 \begin_inset Flex Code
30167 \begin_layout Plain Layout
30173 CSS style information to be included when this style is used.
30174 Note that this will automatically be wrapped in a layout-generated
30175 \begin_inset Flex Code
30178 \begin_layout Plain Layout
30185 so only the CSS itself need be included.
30188 \begin_layout Description
30189 \begin_inset Flex Code
30192 \begin_layout Plain Layout
30199 \begin_inset Flex Code
30202 \begin_layout Plain Layout
30208 ] The tag to be used for the main label,
30210 \begin_inset Flex Code
30213 \begin_layout Plain Layout
30219 in the examples above.
30220 The default depends upon the setting of
30221 \begin_inset Flex Code
30224 \begin_layout Plain Layout
30232 \begin_inset Flex Code
30235 \begin_layout Plain Layout
30243 \begin_inset Flex Code
30246 \begin_layout Plain Layout
30255 \begin_inset Flex Code
30258 \begin_layout Plain Layout
30267 \begin_layout Subsection
30271 \begin_layout Standard
30272 The XHTML output for floats too can be controlled by layout information.
30273 The output has the following form:
30276 \begin_layout LyX-Code
30278 \begin_inset Quotes erd
30282 \begin_inset Quotes erd
30288 \begin_layout LyX-Code
30289 Contents of the float.
30292 \begin_layout LyX-Code
30296 \begin_layout Standard
30299 is a separate inset and will be output as such.
30300 Its appearance can be controlled via the InsetLayout for caption insets.
30304 \begin_layout Description
30305 \begin_inset Flex Code
30308 \begin_layout Plain Layout
30315 \begin_inset Flex Code
30318 \begin_layout Plain Layout
30324 ] Specifies attribute information to be output with the main tag.
30327 \begin_inset Quotes eld
30331 \begin_inset Flex Code
30334 \begin_layout Plain Layout
30335 class=`myfloat' onclick=`\SpecialChar ldots
30342 \begin_inset Quotes erd
30349 \begin_inset Quotes eld
30353 \begin_inset Flex Code
30356 \begin_layout Plain Layout
30357 class=`float float-floattype'
30363 \begin_inset Quotes erd
30368 \begin_inset Flex Code
30371 \begin_layout Plain Layout
30377 is \SpecialChar LyX
30378 's name for this type of float,
30379 as determined by the float declaration (see
30380 \begin_inset CommandInset ref
30382 reference "subsec:Floats"
30388 though made lowercase and with non-alphanumeric characters converted to underscores,
30393 \begin_layout Description
30394 \begin_inset Flex Code
30397 \begin_layout Plain Layout
30403 CSS style information to be included when this float is used.
30404 Note that this will automatically be wrapped in a layout-generated
30405 \begin_inset Flex Code
30408 \begin_layout Plain Layout
30415 so only the CSS itself need be included.
30418 \begin_layout Description
30419 \begin_inset Flex Code
30422 \begin_layout Plain Layout
30429 \begin_inset Flex Code
30432 \begin_layout Plain Layout
30438 ] The tag to be used for this float,
30440 \begin_inset Quotes eld
30444 \begin_inset Flex Code
30447 \begin_layout Plain Layout
30454 \begin_inset Quotes erd
30457 in the example above.
30459 \begin_inset Flex Code
30462 \begin_layout Plain Layout
30468 and will rarely need changing.
30471 \begin_layout Subsection
30472 Bibliography formatting
30475 \begin_layout Standard
30476 The bibliography can be formatted using
30477 \begin_inset Flex Code
30480 \begin_layout Plain Layout
30488 \begin_inset CommandInset ref
30490 reference "subsec:Citation-format-description"
30498 \begin_layout Subsection
30503 \begin_layout Standard
30504 We have several times mentioned that \SpecialChar LyX
30505 will generate default CSS style rules for both insets and paragraph styles,
30506 based upon the other layout information that is provided.
30508 we shall say a word about which layout information \SpecialChar LyX
30512 \begin_layout Standard
30515 auto-generates CSS only for font information,
30517 \begin_inset Flex Code
30520 \begin_layout Plain Layout
30528 \begin_inset Flex Code
30531 \begin_layout Plain Layout
30539 \begin_inset Flex Code
30542 \begin_layout Plain Layout
30550 \begin_inset Flex Code
30553 \begin_layout Plain Layout
30560 \begin_inset Flex Code
30563 \begin_layout Plain Layout
30570 \begin_inset CommandInset ref
30572 reference "subsec:Font-description"
30578 The translation is mostly straightforward and obvious.
30581 \begin_inset Quotes eld
30585 \begin_inset Flex Code
30588 \begin_layout Plain Layout
30595 \begin_inset Quotes erd
30599 \begin_inset Quotes eld
30603 \begin_inset Flex Code
30606 \begin_layout Plain Layout
30614 \begin_inset Quotes erd
30618 The correspondence of \SpecialChar LyX
30619 sizes and CSS sizes is a little less obvious but nonetheless intuitive.
30621 \begin_inset Flex Code
30624 \begin_layout Plain Layout
30631 \begin_inset Flex URL
30634 \begin_layout Plain Layout
30642 \change_inserted -970929547 1496610908
30646 \begin_layout Section
30648 \change_inserted -970929547 1496610966
30649 \begin_inset CommandInset label
30651 name "sec:Tags-for-DocBook"
30655 Tags for DocBook output
30658 \begin_layout Standard
30660 \change_inserted -970929547 1496611615
30661 As with \SpecialChar LaTeX
30663 the format of \SpecialChar LyX
30664 's DocBook output is also controlled by layout information.
30667 provides sensible defaults;
30669 much of the styling is lost during the conversion,
30670 as DocBook is strictly semantic and does not allow formatting.
30672 information from \SpecialChar LyX
30673 will be rendered in
30681 \begin_layout Standard
30683 \change_inserted -970929547 1496612080
30686 you may not have to do anything at all to get acceptable DocBook output for your own environments,
30689 But in some cases you will,
30690 and so \SpecialChar LyX
30691 provides a number of layout tags that can be used to customize the DocBook that is generated.
30694 \begin_layout Standard
30696 \change_inserted -970929547 1515109912
30697 Labels are rarely output,
30698 as they are redundant in DocBook:
30699 this information is carried by the tags themselves,
30700 and whether labels appear in the final documents (after processing of DocBook files) is controlled by the stylesheets.
30703 labels are not redundant content,
30704 such as definition lists:
30706 the term being defined will be the label.
30710 \begin_layout Subsection
30712 \change_inserted 1075283030 1597699417
30713 \begin_inset CommandInset label
30715 name "subsec:Paragraph-Style-DocBook"
30720 \change_deleted 1075283030 1597699417
30722 \begin_inset CommandInset label
30724 name "subsec:Paragraph-Style-XHTML-1"
30729 \change_inserted -970929547 1496610966
30733 \begin_layout Standard
30735 \change_inserted -970929547 1496612059
30736 The sort of DocBook \SpecialChar LyX
30737 outputs for a paragraph depends upon whether we are dealing with a normal paragraph,
30740 where this is itself determined by the contents of the corresponding
30741 \begin_inset Flex Code
30744 \begin_layout Plain Layout
30746 \change_inserted -970929547 1496610966
30759 \begin_layout Standard
30761 \change_inserted -970929547 1496612107
30762 For a command or normal paragraph,
30763 the output DocBook has the following form:
30766 \begin_layout LyX-Code
30768 \change_inserted -970929547 1515109666
30772 \begin_layout LyX-Code
30774 \change_inserted -970929547 1496610966
30775 Contents of the paragraph.
30778 \begin_layout LyX-Code
30780 \change_inserted -970929547 1496610966
30784 \begin_layout Standard
30786 \change_inserted -970929547 1515109821
30787 For an environment that is not some sort of list,
30788 the generated DocBook takes this form:
30791 \begin_layout LyX-Code
30793 \change_inserted -970929547 1515109671
30797 \begin_layout LyX-Code
30799 \change_inserted -970929547 1496612114
30800 <itemtag>First paragraph.</itemtag>
30803 \begin_layout LyX-Code
30805 \change_inserted -970929547 1496610966
30806 <itemtag>Second paragraph.</itemtag>
30809 \begin_layout LyX-Code
30811 \change_inserted -970929547 1496610966
30815 \begin_layout Standard
30817 \change_inserted -970929547 1515109825
30819 the resulting DocBook takes this form:
30822 \begin_layout LyX-Code
30824 \change_inserted -970929547 1515109672
30828 \begin_layout LyX-Code
30830 \change_inserted -970929547 1515109676
30831 <itemtag attr>First item.</itemtag>
30834 \begin_layout LyX-Code
30836 \change_inserted -970929547 1515109678
30837 <itemtag attr>Second item.</itemtag>
30840 \begin_layout LyX-Code
30842 \change_inserted -970929547 1496610966
30846 \begin_layout Standard
30848 \change_inserted -970929547 1496612243
30849 The specific tags and roles output for each paragraph type can be controlled by means of the layout tags we are about to describe.
30851 due to the very nature of DocBook,
30852 no sensible defaults really exist,
30853 and the values must always be carefully chosen.
30857 \begin_layout Description
30859 \change_inserted -970929547 1515110057
30860 \begin_inset Flex Code
30863 \begin_layout Plain Layout
30865 \change_inserted -970929547 1515109656
30874 \begin_inset Flex Code
30877 \begin_layout Plain Layout
30879 \change_inserted -970929547 1496610966
30887 ] Specifies attribute information to be output with the main tag,
30889 \begin_inset Quotes eld
30893 \begin_inset Flex Code
30896 \begin_layout Plain Layout
30898 \change_inserted -970929547 1515110057
30907 \begin_inset Quotes erd
30910 in the example above.
30911 This information can be used in further processing of the DocBook files.
30917 \begin_layout Description
30919 \change_inserted -970929547 1496612296
30920 \begin_inset Flex Code
30923 \begin_layout Plain Layout
30925 \change_inserted -970929547 1496612269
30934 \begin_inset Flex Code
30937 \begin_layout Plain Layout
30939 \change_inserted -970929547 1496610966
30947 ] The tag to be used for this inset,
30949 \begin_inset Quotes eld
30953 \begin_inset Flex Code
30956 \begin_layout Plain Layout
30958 \change_inserted -970929547 1496612296
30967 \begin_inset Quotes erd
30970 in the example above.
30971 The default is the name of the float and always needs to be changed,
30972 as DocBook provides no generic tag.
30973 \change_inserted 1075283030 1597698868
30977 \begin_layout Description
30979 \change_inserted 1075283030 1597699399
30980 \begin_inset Flex Code
30983 \begin_layout Plain Layout
30985 \change_inserted 1075283030 1597698872
30994 \begin_inset Flex Code
30997 \begin_layout Plain Layout
30999 \change_inserted 1075283030 1597700585
31009 ] The new-line policy for this tag,
31011 \begin_inset space ~
31015 \begin_inset CommandInset ref
31017 reference "subsec:DocBook-New-line-policy"
31031 \begin_layout Subsection
31033 \change_inserted 1075283030 1597699385
31035 \begin_inset CommandInset label
31037 name "subsec:DocBook-New-line-policy"
31044 \begin_layout Standard
31046 \change_inserted 1075283030 1597698993
31048 there are three possible policies for outputting new lines (given in the
31049 \begin_inset Flex Code
31052 \begin_layout Plain Layout
31054 \change_inserted 1075283030 1597698987
31066 \begin_layout Itemize
31068 \change_inserted 1075283030 1597699279
31069 \begin_inset Quotes eld
31073 \begin_inset Flex Code
31076 \begin_layout Plain Layout
31078 \change_inserted 1075283030 1597699012
31087 \begin_inset Quotes erd
31091 the opening and closing tags are on their own lines (i.e.
31092 a line feed after and before the opening and the closing tags).
31093 Typical elements are floats.
31098 \begin_layout LyX-Code
31100 \change_inserted 1075283030 1597699194
31104 \begin_layout LyX-Code
31106 \change_inserted 1075283030 1597699194
31110 \begin_layout LyX-Code
31112 \change_inserted 1075283030 1597699098
31113 Contents of the block.
31116 \begin_layout LyX-Code
31118 \change_inserted 1075283030 1597699196
31122 \begin_layout LyX-Code
31124 \change_inserted 1075283030 1597699198
31128 \begin_layout Itemize
31130 \change_inserted 1075283030 1597699289
31131 \begin_inset Quotes eld
31135 \begin_inset Flex Code
31138 \begin_layout Plain Layout
31140 \change_inserted 1075283030 1597699113
31149 \begin_inset Quotes erd
31153 the opening and closing tags are on the same,
31155 a line feed is output before the opening tag and after the closing tag.
31156 Typical elements are paragraphs and list items.
31161 \begin_layout LyX-Code
31163 \change_inserted 1075283030 1597699186
31167 \begin_layout LyX-Code
31169 \change_inserted 1075283030 1597699357
31170 <paratag>Contents of the paragraph.</paratag>
31173 \begin_layout LyX-Code
31175 \change_inserted 1075283030 1597699231
31179 \begin_layout Itemize
31181 \change_inserted 1075283030 1597699343
31182 \begin_inset Quotes eld
31186 \begin_inset Flex Code
31189 \begin_layout Plain Layout
31191 \change_inserted 1075283030 1597699307
31200 \begin_inset Quotes erd
31204 the opening and closing tags are on the same line as the rest of the content.
31205 No line feeds are output.
31206 Typical elements are fonts.
31211 \begin_layout LyX-Code
31213 \change_inserted 1075283030 1597699585
31214 Content before<inlinetag>Contents of the paragraph.</inlinetag>Content after
31217 \begin_layout Standard
31219 \change_inserted 1075283030 1597699585
31220 The default value is always
31221 \begin_inset Quotes eld
31225 \begin_inset Flex Code
31228 \begin_layout Plain Layout
31230 \change_inserted 1075283030 1597699585
31239 \begin_inset Quotes erd
31247 \begin_layout Subsection
31249 \change_inserted -970929547 1515111533
31250 InsetLayout DocBook
31255 \begin_layout Standard
31257 \change_inserted -970929547 1496611894
31258 The DocBook output of insets can also be controlled by information in layout files.
31261 \begin_layout Standard
31263 \change_inserted -970929547 1496612045
31264 The DocBook \SpecialChar LyX
31265 outputs for an inset has the following form:
31268 \begin_layout LyX-Code
31270 \change_inserted -970929547 1515110861
31271 <wrappertag wrapperattr>
31274 \begin_layout LyX-Code
31276 \change_inserted -970929547 1515110868
31280 \begin_layout LyX-Code
31282 \change_inserted -970929547 1515110869
31283 <innertag innerattr>
31286 \begin_layout LyX-Code
31288 \change_inserted -970929547 1515110869
31289 Contents of the inset.
31292 \begin_layout LyX-Code
31294 \change_inserted -970929547 1515110870
31298 \begin_layout LyX-Code
31300 \change_inserted -970929547 1515110871
31304 \begin_layout LyX-Code
31306 \change_inserted -970929547 1515111172
31310 \begin_layout Standard
31312 \change_inserted -970929547 1515111186
31313 For an itemising inset,
31314 it rather looks like this:
31318 \begin_layout LyX-Code
31320 \change_inserted -970929547 1515111186
31321 <wrappertag wrapperattr>
31324 \begin_layout LyX-Code
31326 \change_inserted -970929547 1515111186
31330 \begin_layout LyX-Code
31332 \change_inserted -970929547 1515111186
31333 <innertag innerattr>
31336 \begin_layout LyX-Code
31338 \change_inserted -970929547 1515111362
31339 <itemwrappertag itemwrapperattr>
31342 \begin_layout LyX-Code
31344 \change_inserted -970929547 1515111364
31345 <itemlabeltag itemattr>
31348 \begin_layout LyX-Code
31350 \change_inserted -970929547 1515111367
31351 Label of the first item.
31354 \begin_layout LyX-Code
31356 \change_inserted -970929547 1515111362
31362 \begin_layout LyX-Code
31364 \change_inserted -970929547 1515111517
31368 \begin_layout LyX-Code
31370 \change_inserted -970929547 1515111517
31376 \begin_layout LyX-Code
31378 \change_inserted -970929547 1515111516
31379 Contents of the first item.
31382 \begin_layout LyX-Code
31384 \change_inserted -970929547 1515111514
31390 \begin_layout LyX-Code
31392 \change_inserted -970929547 1515111247
31398 \begin_layout LyX-Code
31400 \change_inserted -970929547 1515111221
31404 \begin_layout LyX-Code
31406 \change_inserted -970929547 1515111370
31407 <itemwrappertag itemwrapperattr>
31410 \begin_layout LyX-Code
31412 \change_inserted -970929547 1515111370
31413 <itemlabeltag itemattr>
31416 \begin_layout LyX-Code
31418 \change_inserted -970929547 1515111372
31419 Label of the second item.
31422 \begin_layout LyX-Code
31424 \change_inserted -970929547 1515111370
31430 \begin_layout LyX-Code
31432 \change_inserted -970929547 1515111504
31436 \begin_layout LyX-Code
31438 \change_inserted -970929547 1515111505
31444 \begin_layout LyX-Code
31446 \change_inserted -970929547 1515111507
31447 Contents of the second item.
31450 \begin_layout LyX-Code
31452 \change_inserted -970929547 1515111509
31458 \begin_layout LyX-Code
31460 \change_inserted -970929547 1515111251
31466 \begin_layout LyX-Code
31468 \change_inserted -970929547 1515111221
31474 \begin_layout LyX-Code
31476 \change_inserted -970929547 1515111219
31482 \begin_layout LyX-Code
31484 \change_inserted -970929547 1515111186
31488 \begin_layout LyX-Code
31490 \change_inserted -970929547 1515111186
31494 \begin_layout LyX-Code
31496 \change_inserted -970929547 1515111186
31500 \begin_layout Standard
31502 \change_inserted -970929547 1515111183
31503 If the inset permits multiple paragraphs—
31506 \begin_inset Flex Code
31509 \begin_layout Plain Layout
31511 \change_inserted -970929547 1496610966
31520 then the contents of the inset will
31521 \change_deleted 34634807 1620029217
31523 \change_inserted 34634807 1620029219
31525 \change_inserted -970929547 1515111183
31526 be output as paragraphs formatted according to the styles used for those paragraphs (standard,
31529 The inner tag is optional and,
31534 \begin_layout Standard
31536 \change_inserted -970929547 1496610966
31537 The specific tags and attributes output for each inset can be controlled by means of the following layout tags.
31540 \begin_layout Description
31542 \change_inserted -970929547 1515110317
31543 \begin_inset Flex Code
31546 \begin_layout Plain Layout
31548 \change_inserted -970929547 1515109695
31557 \begin_inset Flex Code
31560 \begin_layout Plain Layout
31562 \change_inserted -970929547 1496611854
31570 ] Specifies attribute information to be output with the main tag,
31572 \begin_inset Quotes eld
31576 \begin_inset Flex Code
31579 \begin_layout Plain Layout
31581 \change_inserted -970929547 1515110044
31590 \begin_inset Quotes erd
31593 in the example above.
31594 This information can be used in further processing of the DocBook files.
31598 \begin_layout Description
31600 \change_inserted -970929547 1515110973
31601 \begin_inset Flex Code
31604 \begin_layout Plain Layout
31606 \change_inserted -970929547 1515110319
31615 \begin_inset Flex Code
31618 \begin_layout Plain Layout
31620 \change_inserted -970929547 1515110384
31630 ] Specifies whether this tag goes into the
31631 \begin_inset Flex Code
31634 \begin_layout Plain Layout
31636 \change_inserted -970929547 1515110412
31644 tag at the beginning of the parent layout.
31646 \begin_inset Flex Code
31649 \begin_layout Plain Layout
31651 \change_inserted -970929547 1515110437
31659 indicates that the tag never goes into
31660 \begin_inset Flex Code
31663 \begin_layout Plain Layout
31665 \change_inserted -970929547 1515110497
31673 (this is default value,
31674 and corresponds to usual content).
31676 \begin_inset Flex Code
31679 \begin_layout Plain Layout
31681 \change_inserted -970929547 1515110517
31689 indicates that the tag always goes into
31690 \begin_inset Flex Code
31693 \begin_layout Plain Layout
31695 \change_inserted -970929547 1515110514
31703 (this corresponds to usual metadata):
31705 \begin_inset Flex Code
31708 \begin_layout Plain Layout
31710 \change_inserted -970929547 1515110550
31718 tag for the parent,
31725 \begin_inset Flex Code
31728 \begin_layout Plain Layout
31730 \change_inserted -970929547 1515110540
31738 indicates that the tag may go into
31739 \begin_inset Flex Code
31742 \begin_layout Plain Layout
31744 \change_inserted -970929547 1515110538
31752 (this is only the case for titles):
31754 \begin_inset Flex Code
31757 \begin_layout Plain Layout
31759 \change_inserted -970929547 1515110585
31767 tag for the parent,
31773 the corresponding tag will be output directly as content.
31777 \begin_layout Description
31779 \change_inserted -970929547 1515111461
31780 \begin_inset Flex Code
31783 \begin_layout Plain Layout
31785 \change_inserted -970929547 1515110974
31794 \begin_inset Flex Code
31797 \begin_layout Plain Layout
31799 \change_inserted -970929547 1515110973
31807 ] Specifies attribute information to be output with the item tag,
31809 \begin_inset Quotes eld
31813 \begin_inset Flex Code
31816 \begin_layout Plain Layout
31818 \change_inserted -970929547 1515110984
31827 \begin_inset Quotes erd
31830 in the example above.
31831 This information can be used in further processing of the DocBook files.
31835 \begin_layout Description
31837 \change_inserted -970929547 1515111471
31838 \begin_inset Flex Code
31841 \begin_layout Plain Layout
31843 \change_inserted -970929547 1515111465
31844 DocBookItemInnerAttr
31852 \begin_inset Flex Code
31855 \begin_layout Plain Layout
31857 \change_inserted -970929547 1515111461
31865 ] Specifies attribute information to be output with the item inner tag,
31867 \begin_inset Quotes eld
31871 \begin_inset Flex Code
31874 \begin_layout Plain Layout
31876 \change_inserted -970929547 1515111476
31885 \begin_inset Quotes erd
31888 in the example above.
31889 This information can be used in further processing of the DocBook files.
31893 \begin_layout Description
31895 \change_inserted -970929547 1515111494
31896 \begin_inset Flex Code
31899 \begin_layout Plain Layout
31901 \change_inserted -970929547 1515111467
31902 DocBookItemInnerTag
31910 \begin_inset Flex Code
31913 \begin_layout Plain Layout
31915 \change_inserted -970929547 1515111461
31923 ] The tag to be used for the item inner tag within the inset,
31925 \begin_inset Quotes eld
31929 \begin_inset Flex Code
31932 \begin_layout Plain Layout
31934 \change_inserted -970929547 1515111486
31943 \begin_inset Quotes erd
31946 in the example above.
31948 \begin_inset Flex Code
31951 \begin_layout Plain Layout
31953 \change_inserted -970929547 1515111461
31962 indicating that there is no item inner tag:
31963 content is directly output without it for each itemised element.
31964 This parameter only makes sense when itemising layouts are used,
31967 \change_inserted 1075283030 1598469472
31968 The most likely value is
31969 \begin_inset Quotes eld
31973 \begin_inset Flex Code
31976 \begin_layout Plain Layout
31978 \change_inserted 1075283030 1598469476
31987 \begin_inset Quotes erd
31991 \begin_inset Newline newline
31994 When a list item is split using a new line,
31995 the item inner tag will be repeated for each part of the paragraph,
31996 parts being separated by new lines.
32000 \begin_layout Description
32002 \change_inserted 1075283030 1597699866
32003 \begin_inset Flex Code
32006 \begin_layout Plain Layout
32008 \change_inserted 1075283030 1597699853
32009 DocBookItemInnerTagType
32017 \begin_inset Flex Code
32020 \begin_layout Plain Layout
32022 \change_inserted 1075283030 1597699866
32032 ] The new-line policy for this tag,
32034 \begin_inset space ~
32038 \begin_inset CommandInset ref
32040 reference "subsec:DocBook-New-line-policy"
32054 \begin_layout Description
32056 \change_inserted -970929547 1515111290
32057 \begin_inset Flex Code
32060 \begin_layout Plain Layout
32062 \change_inserted -970929547 1515111283
32063 DocBookItemLabelAttr
32071 \begin_inset Flex Code
32074 \begin_layout Plain Layout
32076 \change_inserted -970929547 1515111279
32084 ] Specifies attribute information to be output with the item label tag,
32086 \begin_inset Quotes eld
32090 \begin_inset Flex Code
32093 \begin_layout Plain Layout
32095 \change_inserted -970929547 1515111304
32104 \begin_inset Quotes erd
32107 in the example above.
32108 This information can be used in further processing of the DocBook files.
32112 \begin_layout Description
32114 \change_inserted -970929547 1515111337
32115 \begin_inset Flex Code
32118 \begin_layout Plain Layout
32120 \change_inserted -970929547 1515111285
32121 DocBookItemLabelTag
32129 \begin_inset Flex Code
32132 \begin_layout Plain Layout
32134 \change_inserted -970929547 1515111279
32142 ] The tag to be used for the item label tag within the inset,
32144 \begin_inset Quotes eld
32148 \begin_inset Flex Code
32151 \begin_layout Plain Layout
32153 \change_inserted -970929547 1515111311
32162 \begin_inset Quotes erd
32165 in the example above.
32166 This parameter only makes sense when itemising layouts are used with a notion of labels,
32167 such as definition lists.
32169 \change_inserted 1075283030 1597699874
32173 \begin_layout Description
32175 \change_inserted 1075283030 1597699874
32176 \begin_inset Flex Code
32179 \begin_layout Plain Layout
32181 \change_inserted 1075283030 1597699880
32182 DocBookItemLabelTagType
32190 \begin_inset Flex Code
32193 \begin_layout Plain Layout
32195 \change_inserted 1075283030 1597699874
32205 ] The new-line policy for this tag,
32207 \begin_inset space ~
32211 \begin_inset CommandInset ref
32213 reference "subsec:DocBook-New-line-policy"
32227 \begin_layout Description
32229 \change_inserted -970929547 1515111124
32230 \begin_inset Flex Code
32233 \begin_layout Plain Layout
32235 \change_inserted -970929547 1515111060
32244 \begin_inset Flex Code
32247 \begin_layout Plain Layout
32249 \change_inserted -970929547 1515111060
32257 ] The tag to be used for the item tag within the inset,
32259 \begin_inset Quotes eld
32263 \begin_inset Flex Code
32266 \begin_layout Plain Layout
32268 \change_inserted -970929547 1515111060
32277 \begin_inset Quotes erd
32280 in the example above.
32282 \begin_inset Flex Code
32285 \begin_layout Plain Layout
32287 \change_inserted -970929547 1515111060
32296 indicating that there is no item tag.
32297 This parameter only makes sense when itemising layouts are used,
32300 \change_inserted 1075283030 1597699890
32304 \begin_layout Description
32306 \change_inserted 1075283030 1597699890
32307 \begin_inset Flex Code
32310 \begin_layout Plain Layout
32312 \change_inserted 1075283030 1597699890
32321 \begin_inset Flex Code
32324 \begin_layout Plain Layout
32326 \change_inserted 1075283030 1597699890
32336 ] The new-line policy for this tag,
32338 \begin_inset space ~
32342 \begin_inset CommandInset ref
32344 reference "subsec:DocBook-New-line-policy"
32358 \begin_layout Description
32360 \change_inserted -970929547 1515111298
32361 \begin_inset Flex Code
32364 \begin_layout Plain Layout
32366 \change_inserted -970929547 1515111124
32367 DocBookItemWrapperAttr
32375 \begin_inset Flex Code
32378 \begin_layout Plain Layout
32380 \change_inserted -970929547 1515111124
32388 ] Specifies attribute information to be output with the item wrapper tag,
32390 \begin_inset Quotes eld
32394 \begin_inset Flex Code
32397 \begin_layout Plain Layout
32399 \change_inserted -970929547 1515111150
32408 \begin_inset Quotes erd
32411 in the example above.
32412 This information can be used in further processing of the DocBook files.
32418 \begin_layout Description
32420 \change_inserted -970929547 1515111113
32421 \begin_inset Flex Code
32424 \begin_layout Plain Layout
32426 \change_inserted -970929547 1515111073
32427 DocBookItemWrapperTag
32435 \begin_inset Flex Code
32438 \begin_layout Plain Layout
32440 \change_inserted -970929547 1515111073
32448 ] The tag to be used for the item wrapper tag within the inset,
32450 \begin_inset Quotes eld
32454 \begin_inset Flex Code
32457 \begin_layout Plain Layout
32459 \change_inserted -970929547 1515111083
32468 \begin_inset Quotes erd
32471 in the example above.
32473 \begin_inset Flex Code
32476 \begin_layout Plain Layout
32478 \change_inserted -970929547 1515111073
32487 indicating that there is no item wrapper tag:
32488 tag and content are directly output without it for each itemised element.
32489 This parameter only makes sense when itemising layouts are used,
32492 \change_inserted 1075283030 1597699897
32496 \begin_layout Description
32498 \change_inserted 1075283030 1597699897
32499 \begin_inset Flex Code
32502 \begin_layout Plain Layout
32504 \change_inserted 1075283030 1597699900
32505 DocBookItemWrapperTagType
32513 \begin_inset Flex Code
32516 \begin_layout Plain Layout
32518 \change_inserted 1075283030 1597699897
32528 ] The new-line policy for this tag,
32530 \begin_inset space ~
32534 \begin_inset CommandInset ref
32536 reference "subsec:DocBook-New-line-policy"
32550 \begin_layout Description
32552 \change_inserted -970929547 1515110104
32553 \begin_inset Flex Code
32556 \begin_layout Plain Layout
32558 \change_inserted -970929547 1515110104
32567 \begin_inset Flex Code
32570 \begin_layout Plain Layout
32572 \change_inserted -970929547 1515110104
32580 ] Specifies attribute information to be output with the inner tag,
32582 \begin_inset Quotes eld
32586 \begin_inset Flex Code
32589 \begin_layout Plain Layout
32591 \change_inserted -970929547 1515110104
32600 \begin_inset Quotes erd
32603 in the example above.
32604 This information can be used in further processing of the DocBook files.
32608 \begin_layout Description
32610 \change_inserted -970929547 1515110906
32611 \begin_inset Flex Code
32614 \begin_layout Plain Layout
32616 \change_inserted -970929547 1515110104
32625 \begin_inset Flex Code
32628 \begin_layout Plain Layout
32630 \change_inserted -970929547 1515110104
32638 ] The tag to be used for the inner tag within the inset,
32640 \begin_inset Quotes eld
32644 \begin_inset Flex Code
32647 \begin_layout Plain Layout
32649 \change_inserted -970929547 1515110104
32658 \begin_inset Quotes erd
32661 in the example above.
32663 \begin_inset Flex Code
32666 \begin_layout Plain Layout
32668 \change_inserted -970929547 1515110791
32677 indicating that there is no inner tag:
32678 content is directly output without it.
32679 \change_inserted 1075283030 1597699904
32683 \begin_layout Description
32685 \change_inserted 1075283030 1597699904
32686 \begin_inset Flex Code
32689 \begin_layout Plain Layout
32691 \change_inserted 1075283030 1597699904
32692 DocBookInnerTagType
32700 \begin_inset Flex Code
32703 \begin_layout Plain Layout
32705 \change_inserted 1075283030 1597699904
32715 ] The new-line policy for this tag,
32717 \begin_inset space ~
32721 \begin_inset CommandInset ref
32723 reference "subsec:DocBook-New-line-policy"
32737 \begin_layout Description
32739 \change_inserted -970929547 1515110753
32740 \begin_inset Flex Code
32743 \begin_layout Plain Layout
32745 \change_inserted -970929547 1515110665
32754 \begin_inset Flex Code
32757 \begin_layout Plain Layout
32759 \change_inserted -970929547 1515110661
32767 ] Specifies the tag that corresponds to this kind of section.
32768 This parameter only makes sense for sectioning elements (part,
32772 The default value is
32773 \begin_inset Flex Code
32776 \begin_layout Plain Layout
32778 \change_inserted -970929547 1515110721
32787 and is only overridden when DocBook uses something else for sectioning (
32788 \change_inserted 1075283030 1597699921
32791 \change_inserted -970929547 1515110753
32792 parts and chapters of a book).
32798 \begin_layout Description
32800 \change_inserted -970929547 1515110811
32801 \begin_inset Flex Code
32804 \begin_layout Plain Layout
32806 \change_inserted -970929547 1496612023
32815 \begin_inset Flex Code
32818 \begin_layout Plain Layout
32820 \change_inserted -970929547 1496610966
32828 ] The tag to be used for this inset,
32830 \begin_inset Quotes eld
32834 \begin_inset Flex Code
32837 \begin_layout Plain Layout
32839 \change_inserted -970929547 1496612033
32848 \begin_inset Quotes erd
32851 in the example above.
32852 The default is the name of the float and always needs to be changed,
32853 as DocBook provides no generic inset tag.
32854 \change_inserted 1075283030 1597699924
32858 \begin_layout Description
32860 \change_inserted 1075283030 1597699924
32861 \begin_inset Flex Code
32864 \begin_layout Plain Layout
32866 \change_inserted 1075283030 1597699924
32875 \begin_inset Flex Code
32878 \begin_layout Plain Layout
32880 \change_inserted 1075283030 1597699924
32890 ] The new-line policy for this tag,
32892 \begin_inset space ~
32896 \begin_inset CommandInset ref
32898 reference "subsec:DocBook-New-line-policy"
32912 \begin_layout Description
32914 \change_inserted -970929547 1515110832
32915 \begin_inset Flex Code
32918 \begin_layout Plain Layout
32920 \change_inserted -970929547 1515110822
32929 \begin_inset Flex Code
32932 \begin_layout Plain Layout
32934 \change_inserted -970929547 1515110811
32942 ] Specifies attribute information to be output with the outer
32943 \change_inserted 34634807 1620057958
32945 \change_inserted -970929547 1515110832
32948 \begin_inset Quotes eld
32952 \begin_inset Flex Code
32955 \begin_layout Plain Layout
32957 \change_inserted -970929547 1515110845
32966 \begin_inset Quotes erd
32969 in the example above.
32970 This information can be used in further processing of the DocBook files.
32974 \begin_layout Description
32976 \change_inserted -970929547 1515110917
32977 \begin_inset Flex Code
32980 \begin_layout Plain Layout
32982 \change_inserted -970929547 1515110826
32991 \begin_inset Flex Code
32994 \begin_layout Plain Layout
32996 \change_inserted -970929547 1515110811
33004 ] The tag to be used for the wrapper tag around the inset,
33006 \begin_inset Quotes eld
33010 \begin_inset Flex Code
33013 \begin_layout Plain Layout
33015 \change_inserted -970929547 1515110842
33024 \begin_inset Quotes erd
33027 in the example above.
33029 \begin_inset Flex Code
33032 \begin_layout Plain Layout
33034 \change_inserted -970929547 1515110811
33043 indicating that there is no wrapper tag:
33044 tag and content are directly output without it.
33045 \change_inserted 1075283030 1597699929
33049 \begin_layout Description
33051 \change_inserted 1075283030 1597699929
33052 \begin_inset Flex Code
33055 \begin_layout Plain Layout
33057 \change_inserted 1075283030 1597699932
33058 DocBookWrapperTagType
33066 \begin_inset Flex Code
33069 \begin_layout Plain Layout
33071 \change_inserted 1075283030 1597699929
33081 ] The new-line policy for this tag,
33083 \begin_inset space ~
33087 \begin_inset CommandInset ref
33089 reference "subsec:DocBook-New-line-policy"
33103 \begin_layout Subsection
33105 \change_inserted -970929547 1515110040
33109 \begin_layout Standard
33111 \change_inserted -970929547 1496611700
33112 The DocBook output for floats too can be controlled by layout information.
33113 The output has the following form:
33116 \begin_layout LyX-Code
33118 \change_inserted -970929547 1515109700
33122 \begin_layout LyX-Code
33124 \change_inserted -970929547 1515110138
33125 Contents of the float as DocBook.
33128 \begin_layout LyX-Code
33130 \change_inserted -970929547 1496610966
33134 \begin_layout Standard
33136 \change_inserted -970929547 1496611715
33139 is a separate inset and will be output as a title.
33143 \begin_layout Description
33145 \change_inserted -970929547 1515110033
33146 \begin_inset Flex Code
33149 \begin_layout Plain Layout
33151 \change_inserted -970929547 1515109702
33160 \begin_inset Flex Code
33163 \begin_layout Plain Layout
33165 \change_inserted -970929547 1496610966
33173 ] Specifies attribute information to be output with the main tag,
33175 \begin_inset Quotes eld
33179 \begin_inset Flex Code
33182 \begin_layout Plain Layout
33184 \change_inserted -970929547 1515110035
33193 \begin_inset Quotes erd
33196 in the example above.
33197 This information can be used in further processing of the DocBook files.
33201 \begin_layout Description
33203 \change_inserted -970929547 1515110157
33204 \begin_inset Flex Code
33207 \begin_layout Plain Layout
33209 \change_inserted -970929547 1496611782
33218 \begin_inset Flex Code
33221 \begin_layout Plain Layout
33223 \change_inserted -970929547 1496610966
33231 ] The tag to be used for this float,
33233 \begin_inset Quotes eld
33237 \begin_inset Flex Code
33240 \begin_layout Plain Layout
33242 \change_inserted -970929547 1496610966
33251 \begin_inset Quotes erd
33254 in the example above.
33255 The default is the name of the float and always needs to be changed,
33256 as DocBook provides no generic float tag.
33259 \begin_layout Subsection
33261 \change_inserted -970929547 1515110157
33262 Bibliography formatting
33265 \begin_layout Standard
33267 \change_deleted 1075283030 1597699984
33269 \change_inserted 1075283030 1597699985
33271 \change_inserted -970929547 1515110187
33273 \change_deleted 1075283030 1597699987
33275 \change_inserted 1075283030 1597699987
33277 \change_inserted -970929547 1515110187
33278 cannot be formatted:
33279 all fields are always output in the database-like DocBook format (equivalent to a BibTeX file)
33280 \change_inserted 1075283030 1597700117
33283 \begin_inset Flex Code
33286 \begin_layout Plain Layout
33288 \change_inserted 1075283030 1597700120
33297 \change_inserted -970929547 1515110187
33299 \change_inserted 1075283030 1597700092
33303 \begin_layout Standard
33305 \change_inserted 1075283030 1597700112
33306 When the bibliographic entries are manually inserted into the
33307 \change_deleted 34634807 1620057319
33309 \change_inserted 34634807 1620057319
33312 \change_inserted 1075283030 1597700112
33313 document as Bibliography Items,
33314 the user deals with formatting
33317 \change_inserted 1075283030 1597700112
33319 there is no attempt of parsing what the user wrote,
33320 the string is directly used (with the
33321 \begin_inset Flex Code
33324 \begin_layout Plain Layout
33326 \change_inserted 1075283030 1597700076
33340 \begin_layout Chapter
33341 Including External Material
33342 \begin_inset CommandInset label
33344 name "chap:Including-External-Material"
33351 \begin_layout Standard
33352 \begin_inset Box Shadowbox
33362 height_special "totalheight"
33367 backgroundcolor "none"
33370 \begin_layout Plain Layout
33372 This portion of the documentation has not been updated for some time.
33373 We certainly hope that it is still accurate,
33374 but there are no guarantees.
33382 \begin_layout Standard
33383 The use of material from sources external to \SpecialChar LyX
33384 is covered in detail in the
33389 This part of the manual covers what needs to happen behind the scenes for new sorts of material to be included.
33392 \begin_layout Section
33396 \begin_layout Standard
33397 The external material feature is based on the concept of a
33402 A template is a specification of how \SpecialChar LyX
33403 should interface with a certain kind of material.
33406 comes with predefined templates for Xfig figures,
33407 various raster format images,
33409 and LilyPond music notation.
33410 You can check the actual list by using the menu
33411 \begin_inset Flex Noun
33414 \begin_layout Plain Layout
33415 Insert\SpecialChar menuseparator
33416 File\SpecialChar menuseparator
33424 it is possible to roll your own template to support a specific kind of material.
33425 Later we'll describe in more detail what is involved,
33426 and hopefully you will submit all the templates you create so we can include them in a later \SpecialChar LyX
33430 \begin_layout Standard
33431 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.
33433 consider the case of a figure produced with
33434 \begin_inset Flex Code
33437 \begin_layout Plain Layout
33444 The Xfig application itself works on an original file with the
33445 \begin_inset Flex Code
33448 \begin_layout Plain Layout
33456 you create and change your figure,
33457 and when you are done,
33459 \begin_inset Flex Code
33462 \begin_layout Plain Layout
33469 When you want to include the figure in your document,
33471 \begin_inset Flex Code
33474 \begin_layout Plain Layout
33480 in order to create a PostScript file that can readily be included in your \SpecialChar LaTeX
33484 \begin_inset Flex Code
33487 \begin_layout Plain Layout
33493 file is the original file,
33494 and the PostScript file is the produced file.
33497 \begin_layout Standard
33498 This distinction is important in order to allow updating of the material while you are in the process of writing the document.
33500 it provides us with the flexibility that is needed to support multiple export formats.
33502 in the case of a plain text file,
33503 it is not exactly an award-winning idea to include the figure as raw PostScript.
33505 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.
33506 The external material management allows you to do this,
33507 because it is parametrized on the different export formats that \SpecialChar LyX
33511 \begin_layout Standard
33512 Besides supporting the production of different products according to the exported format,
33513 it supports tight integration with editing and viewing applications.
33514 In the case of an Xfig figure,
33515 you are able to invoke Xfig on the original file with a single click from within the external material dialog in \SpecialChar LyX
33517 and also preview the produced PostScript file with Ghostview with another click.
33518 No more fiddling around with the command line and/or file browsers to locate and manipulate the original or produced files.
33520 you are finally able to take full advantage of the many different applications that are relevant to use when you write your documents,
33521 and ultimately be more productive.
33524 \begin_layout Section
33525 The external template configuration files
33528 \begin_layout Standard
33529 It is relatively easy to add custom external template definitions to \SpecialChar LyX
33532 be aware that doing this in an careless manner most probably
33536 introduce an easily exploitable security hole.
33537 So before you do this,
33538 please read the discussion about security in
33539 \begin_inset CommandInset ref
33541 reference "sec:Security-discussion"
33549 \begin_layout Standard
33551 we encourage you to submit any interesting templates that you create.
33555 \begin_layout Standard
33556 The external templates are defined in the
33557 \begin_inset Flex Code
33560 \begin_layout Plain Layout
33566 files that are stored in the
33567 \begin_inset Flex Code
33570 \begin_layout Plain Layout
33571 LyXDir/lib/xtemplates/
33577 Each template is defined in a file of its own.
33578 You can place your own templates in
33579 \begin_inset Flex Code
33582 \begin_layout Plain Layout
33583 UserDir/xtemplates/
33588 or copy existing templates to that directory in order to modify them.
33591 \begin_layout Standard
33592 A typical template looks like this:
33595 \begin_layout LyX-Code
33599 \begin_layout LyX-Code
33601 $$AbsOrRelPathParent$$Basename"
33604 \begin_layout LyX-Code
33608 \begin_layout LyX-Code
33612 \begin_layout LyX-Code
33616 \begin_layout LyX-Code
33620 \begin_layout LyX-Code
33624 \begin_layout LyX-Code
33625 AutomaticProduction true
33628 \begin_layout LyX-Code
33632 \begin_layout LyX-Code
33636 \begin_layout LyX-Code
33640 \begin_layout LyX-Code
33641 TransformCommand Rotate RotationLatexCommand
33644 \begin_layout LyX-Code
33645 TransformCommand Resize ResizeLatexCommand
33648 \begin_layout LyX-Code
33649 Product "$$RotateFront$$ResizeFront
33652 \begin_layout LyX-Code
33657 input{$$AbsOrRelPathMaster$$Basename.pstex_t}
33660 \begin_layout LyX-Code
33661 $$ResizeBack$$RotateBack"
33664 \begin_layout LyX-Code
33668 \begin_layout LyX-Code
33669 UpdateResult "$$AbsPath$$Basename.pstex_t"
33672 \begin_layout LyX-Code
33673 Requirement "graphicx"
33676 \begin_layout LyX-Code
33677 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
33680 \begin_layout LyX-Code
33681 ReferencedFile latex "$$AbsPath$$Basename.eps"
33684 \begin_layout LyX-Code
33685 ReferencedFile dvi "$$AbsPath$$Basename.eps"
33688 \begin_layout LyX-Code
33692 \begin_layout LyX-Code
33696 \begin_layout LyX-Code
33697 TransformCommand Rotate RotationLatexCommand
33700 \begin_layout LyX-Code
33701 TransformCommand Resize ResizeLatexCommand
33704 \begin_layout LyX-Code
33705 Product "$$RotateFront$$ResizeFront
33708 \begin_layout LyX-Code
33713 input{$$AbsOrRelPathMaster$$Basename.pdftex_t}
33716 \begin_layout LyX-Code
33717 $$ResizeBack$$RotateBack"
33720 \begin_layout LyX-Code
33721 UpdateFormat pdftex
33724 \begin_layout LyX-Code
33725 UpdateResult "$$AbsPath$$Basename.pdftex_t"
33728 \begin_layout LyX-Code
33729 Requirement "graphicx"
33732 \begin_layout LyX-Code
33733 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pdftex_t"
33736 \begin_layout LyX-Code
33737 ReferencedFile latex "$$AbsPath$$Basename.pdf"
33740 \begin_layout LyX-Code
33744 \begin_layout LyX-Code
33748 \begin_layout LyX-Code
33753 \begin_layout LyX-Code
33757 \begin_layout LyX-Code
33761 \begin_layout LyX-Code
33762 Product "<graphic fileref=
33764 "$$AbsOrRelPathMaster$$Basename.eps
33769 \begin_layout LyX-Code
33773 \begin_layout LyX-Code
33777 \begin_layout LyX-Code
33778 UpdateResult "$$AbsPath$$Basename.eps"
33781 \begin_layout LyX-Code
33782 ReferencedFile docbook "$$AbsPath$$Basename.eps"
33785 \begin_layout LyX-Code
33786 ReferencedFile docbook-xml "$$AbsPath$$Basename.eps"
33789 \begin_layout LyX-Code
33793 \begin_layout LyX-Code
33797 \begin_layout Standard
33799 the template is enclosed in
33800 \begin_inset Flex Code
33803 \begin_layout Plain Layout
33811 \begin_inset Flex Code
33814 \begin_layout Plain Layout
33821 It contains a header specifying some general settings and,
33822 for each supported primary document file format,
33824 \begin_inset Flex Code
33827 \begin_layout Plain Layout
33835 \begin_inset Flex Code
33838 \begin_layout Plain Layout
33847 \begin_layout Subsection
33848 The template header
33851 \begin_layout Description
33852 \begin_inset Flex Code
33855 \begin_layout Plain Layout
33856 AutomaticProduction
33857 \begin_inset space ~
33865 Whether the file represented by the template must be generated by \SpecialChar LyX
33867 This command must occur exactly once.
33870 \begin_layout Description
33871 \begin_inset Flex Code
33874 \begin_layout Plain Layout
33876 \begin_inset space ~
33884 A glob pattern that is used in the file dialog to filter out the desired files.
33885 If there is more than one possible file extension (e.
33886 \begin_inset space \thinspace{}
33890 \begin_inset space \space{}
33894 \begin_inset Flex Code
33897 \begin_layout Plain Layout
33904 \begin_inset Flex Code
33907 \begin_layout Plain Layout
33915 \begin_inset Flex Code
33918 \begin_layout Plain Layout
33925 This command must occur exactly once.
33928 \begin_layout Description
33929 \begin_inset Flex Code
33932 \begin_layout Plain Layout
33934 \begin_inset space ~
33942 The text that is displayed on the button.
33943 This command must occur exactly once.
33946 \begin_layout Description
33947 \begin_inset Flex Code
33950 \begin_layout Plain Layout
33952 \begin_inset space ~
33956 \begin_inset space ~
33964 The help text that is used in the External dialog.
33965 Provide enough information to explain to the user just what the template can provide him with.
33966 This command must occur exactly once.
33969 \begin_layout Description
33970 \begin_inset Flex Code
33973 \begin_layout Plain Layout
33975 \begin_inset space ~
33983 The file format of the original file.
33984 This must be the name of a format that is known to \SpecialChar LyX
33986 \begin_inset CommandInset ref
33988 reference "sec:Formats"
33995 \begin_inset Quotes eld
33999 \begin_inset Flex Code
34002 \begin_layout Plain Layout
34009 \begin_inset Quotes erd
34012 if the template can handle original files of more than one format.
34014 will attempt to interrogate the file itself in order to deduce its format in this case.
34015 This command must occur exactly once.
34018 \begin_layout Description
34019 \begin_inset Flex Code
34022 \begin_layout Plain Layout
34024 \begin_inset space ~
34032 A unique name for the template.
34033 It must not contain substitution macros (see below).
34036 \begin_layout Description
34037 \begin_inset Flex Code
34040 \begin_layout Plain Layout
34042 \begin_inset space ~
34045 Rotate|Resize|Clip|Extra
34050 This command specifies which transformations are supported by this template.
34051 It may occur zero or more times.
34052 This command enables the corresponding tabs in the external dialog.
34054 \begin_inset Flex Code
34057 \begin_layout Plain Layout
34063 command must have either a corresponding
34064 \begin_inset Flex Code
34067 \begin_layout Plain Layout
34074 \begin_inset Flex Code
34077 \begin_layout Plain Layout
34084 \begin_inset Flex Code
34087 \begin_layout Plain Layout
34094 Otherwise the transformation will not be supported by that format.
34097 \begin_layout Subsection
34101 \begin_layout Description
34102 \begin_inset Flex Code
34105 \begin_layout Plain Layout
34107 \begin_inset space ~
34110 LaTeX|PDFLaTeX|PlainText|DocBook|XHTML
34115 The primary document file format that this format definition is for.
34116 Not every template has a sensible representation in all document file formats.
34117 Please define nevertheless a
34118 \begin_inset Flex Code
34121 \begin_layout Plain Layout
34127 section for all templates.
34128 Use a dummy text when no representation is available.
34129 Then you can at least see a reference to the external material in the exported document.
34132 \begin_layout Description
34133 \begin_inset Flex Code
34136 \begin_layout Plain Layout
34138 \begin_inset space ~
34142 \begin_inset space ~
34150 This command defines an additional macro
34151 \begin_inset Flex Code
34154 \begin_layout Plain Layout
34160 for substitution in
34161 \begin_inset Flex Code
34164 \begin_layout Plain Layout
34172 \begin_inset Flex Code
34175 \begin_layout Plain Layout
34181 itself may contain substitution macros.
34182 The advantage over using
34183 \begin_inset Flex Code
34186 \begin_layout Plain Layout
34193 \begin_inset Flex Code
34196 \begin_layout Plain Layout
34202 is that the substituted value of
34203 \begin_inset Flex Code
34206 \begin_layout Plain Layout
34212 is sanitized so that it is a valid optional argument in the document format.
34213 This command may occur zero or more times.
34216 \begin_layout Description
34217 \begin_inset Flex Code
34220 \begin_layout Plain Layout
34222 \begin_inset space ~
34230 The text that is inserted in the exported document.
34231 This is actually the most important command and can be quite complex.
34232 This command must occur exactly once.
34235 \begin_layout Description
34236 \begin_inset Flex Code
34239 \begin_layout Plain Layout
34241 \begin_inset space ~
34249 This command specifies a preamble snippet that will be included in the \SpecialChar LaTeX
34251 It has to be defined using
34252 \begin_inset Flex Code
34255 \begin_layout Plain Layout
34263 \begin_inset Flex Code
34266 \begin_layout Plain Layout
34273 This command may occur zero or more times.
34276 \begin_layout Description
34277 \begin_inset Flex Code
34280 \begin_layout Plain Layout
34282 \begin_inset space ~
34286 \begin_inset space ~
34294 This command denotes files that are created by the conversion process and are needed for a particular export format.
34295 If the filename is relative,
34296 it is interpreted relative to the master document.
34297 This command may be given zero or more times.
34300 \begin_layout Description
34301 \begin_inset Flex Code
34304 \begin_layout Plain Layout
34306 \begin_inset space ~
34314 The name of a required \SpecialChar LaTeX
34316 The package is included via
34317 \begin_inset Flex Code
34320 \begin_layout Plain Layout
34328 in the \SpecialChar LaTeX
34330 This command may occur zero or more times.
34333 \begin_layout Description
34334 \begin_inset Flex Code
34337 \begin_layout Plain Layout
34339 \begin_inset space ~
34343 \begin_inset space ~
34346 RotationLatexCommand
34351 This command specifies that the built in \SpecialChar LaTeX
34352 command should be used for rotation.
34353 This command may occur once or not at all.
34356 \begin_layout Description
34357 \begin_inset Flex Code
34360 \begin_layout Plain Layout
34362 \begin_inset space ~
34366 \begin_inset space ~
34374 This command specifies that the built in \SpecialChar LaTeX
34375 command should be used for resizing.
34376 This command may occur once or not at all.
34379 \begin_layout Description
34380 \begin_inset Flex Code
34383 \begin_layout Plain Layout
34385 \begin_inset space ~
34389 \begin_inset space ~
34392 RotationLatexOption
34397 This command specifies that rotation is done via an optional argument.
34398 This command may occur once or not at all.
34401 \begin_layout Description
34402 \begin_inset Flex Code
34405 \begin_layout Plain Layout
34407 \begin_inset space ~
34411 \begin_inset space ~
34419 This command specifies that resizing is done via an optional argument.
34420 This command may occur once or not at all.
34423 \begin_layout Description
34424 \begin_inset Flex Code
34427 \begin_layout Plain Layout
34429 \begin_inset space ~
34433 \begin_inset space ~
34441 This command specifies that clipping is done via an optional argument.
34442 This command may occur once or not at all.
34445 \begin_layout Description
34446 \begin_inset Flex Code
34449 \begin_layout Plain Layout
34451 \begin_inset space ~
34455 \begin_inset space ~
34463 This command specifies that an extra optional argument is used.
34464 This command may occur once or not at all.
34467 \begin_layout Description
34468 \begin_inset Flex Code
34471 \begin_layout Plain Layout
34473 \begin_inset space ~
34481 The file format of the converted file.
34482 This must be the name of a format that is known to \SpecialChar LyX
34484 \begin_inset Flex Noun
34487 \begin_layout Plain Layout
34488 Tools\SpecialChar menuseparator
34489 Preferences\SpecialChar menuseparator
34490 File Handling\SpecialChar menuseparator
34497 This command must occur exactly once.
34498 If the resulting file format is PDF,
34499 you need to specify the format
34500 \begin_inset Flex Code
34503 \begin_layout Plain Layout
34510 This is the PDF format used for including graphics.
34511 The other defined PDF formats are for document export.
34514 \begin_layout Description
34515 \begin_inset Flex Code
34518 \begin_layout Plain Layout
34520 \begin_inset space ~
34528 The file name of the converted file.
34529 The file name must be absolute.
34530 This command must occur exactly once.
34533 \begin_layout Subsection
34534 Preamble definitions
34537 \begin_layout Standard
34538 The external template configuration file may contain additional preamble definitions enclosed by
34539 \begin_inset Flex Code
34542 \begin_layout Plain Layout
34550 \begin_inset Flex Code
34553 \begin_layout Plain Layout
34560 They can be used by the templates in the
34561 \begin_inset Flex Code
34564 \begin_layout Plain Layout
34573 \begin_layout Section
34574 The substitution mechanism
34577 \begin_layout Standard
34578 When the external material facility invokes an external program,
34579 it is done on the basis of a command defined in the template configuration file.
34580 These commands can contain various macros that are expanded before execution.
34581 Execution always take place in the directory of the containing document.
34584 \begin_layout Standard
34586 whenever external material is to be displayed,
34587 the name will be produced by the substitution mechanism,
34588 and most other commands in the template definition support substitution as well.
34591 \begin_layout Standard
34592 The available macros are the following:
34595 \begin_layout Description
34596 \begin_inset Flex Code
34599 \begin_layout Plain Layout
34600 $$AbsOrRelPathMaster
34606 absolute or relative to the master \SpecialChar LyX
34610 \begin_layout Description
34611 \begin_inset Flex Code
34614 \begin_layout Plain Layout
34615 $$AbsOrRelPathParent
34621 absolute or relative to the \SpecialChar LyX
34625 \begin_layout Description
34626 \begin_inset Flex Code
34629 \begin_layout Plain Layout
34635 The absolute file path.
34638 \begin_layout Description
34639 \begin_inset Flex Code
34642 \begin_layout Plain Layout
34648 The filename without path and without the extension.
34651 \begin_layout Description
34652 \begin_inset Flex Code
34655 \begin_layout Plain Layout
34657 \begin_inset Quotes eld
34661 \begin_inset Quotes erd
34669 This macro will expand to the contents of the file with the name
34670 \begin_inset Flex Code
34673 \begin_layout Plain Layout
34682 \begin_layout Description
34683 \begin_inset Flex Code
34686 \begin_layout Plain Layout
34692 The file extension (including the dot).
34695 \begin_layout Description
34696 \begin_inset Flex Code
34699 \begin_layout Plain Layout
34705 This will be the string
34706 \begin_inset Quotes eld
34710 \begin_inset Quotes erd
34713 if the file is in JPEG format,
34714 otherwise it will be the string
34715 \begin_inset Quotes eld
34719 \begin_inset Quotes erd
34723 This is useful to avoid uneeded conversions for output formats that support both PNG and JPEG fomats.
34724 The predefined RasterImage template uses this macro for the pdf\SpecialChar TeX
34728 \begin_layout Description
34729 \begin_inset Flex Code
34732 \begin_layout Plain Layout
34738 The filename of the file specified in the external material dialog.
34739 This is either an absolute name,
34740 or it is relative to the \SpecialChar LyX
34744 \begin_layout Description
34745 \begin_inset Flex Code
34748 \begin_layout Plain Layout
34755 \begin_inset Flex Code
34758 \begin_layout Plain Layout
34764 (absolute name or relative to the \SpecialChar LyX
34768 \begin_layout Description
34769 \begin_inset Flex Code
34772 \begin_layout Plain Layout
34779 relative to the master \SpecialChar LyX
34783 \begin_layout Description
34784 \begin_inset Flex Code
34787 \begin_layout Plain Layout
34794 relative to the \SpecialChar LyX
34798 \begin_layout Description
34799 \begin_inset Flex Code
34802 \begin_layout Plain Layout
34808 This macro will expand to the absolute path of the system directory.
34809 This is typically used to point to the various helper scripts that are bundled with \SpecialChar LyX
34813 \begin_layout Description
34814 \begin_inset Flex Code
34817 \begin_layout Plain Layout
34823 A name and full path to a temporary file which will be automatically deleted whenever the containing document is closed,
34824 or the external material insertion deleted.
34827 \begin_layout Standard
34828 All path macros contain a trailing directory separator,
34829 so you can construct e.
34830 \begin_inset space \thinspace{}
34834 \begin_inset space \space{}
34837 the absolute filename with
34838 \begin_inset Flex Code
34841 \begin_layout Plain Layout
34842 $$AbsPath$$Basename$$Extension
34850 \begin_layout Standard
34851 The macros above are substituted in all commands unless otherwise noted.
34853 \begin_inset Flex Code
34856 \begin_layout Plain Layout
34862 supports additionally the following substitutions if they are enabled by the
34863 \begin_inset Flex Code
34866 \begin_layout Plain Layout
34873 \begin_inset Flex Code
34876 \begin_layout Plain Layout
34885 \begin_layout Description
34886 \begin_inset Flex Code
34889 \begin_layout Plain Layout
34895 The front part of the resize command.
34898 \begin_layout Description
34899 \begin_inset Flex Code
34902 \begin_layout Plain Layout
34908 The back part of the resize command.
34911 \begin_layout Description
34912 \begin_inset Flex Code
34915 \begin_layout Plain Layout
34921 The front part of the rotation command.
34924 \begin_layout Description
34925 \begin_inset Flex Code
34928 \begin_layout Plain Layout
34934 The back part of the rotation command.
34937 \begin_layout Standard
34938 The value string of the
34939 \begin_inset Flex Code
34942 \begin_layout Plain Layout
34948 command supports additionally the following substitutions if they are enabled by the
34949 \begin_inset Flex Code
34952 \begin_layout Plain Layout
34959 \begin_inset Flex Code
34962 \begin_layout Plain Layout
34971 \begin_layout Description
34972 \begin_inset Flex Code
34975 \begin_layout Plain Layout
34984 \begin_layout Description
34985 \begin_inset Flex Code
34988 \begin_layout Plain Layout
34997 \begin_layout Description
34998 \begin_inset Flex Code
35001 \begin_layout Plain Layout
35010 \begin_layout Description
35011 \begin_inset Flex Code
35014 \begin_layout Plain Layout
35020 The rotation option.
35023 \begin_layout Standard
35024 You may ask why there are so many path macros.
35025 There are mainly two reasons:
35028 \begin_layout Enumerate
35029 Relative and absolute file names should remain relative or absolute,
35031 Users may have reasons to prefer either form.
35032 Relative names are useful for portable documents that should work on different machines,
35034 Absolute names may be required by some programs.
35037 \begin_layout Enumerate
35039 treats relative file names differently than \SpecialChar LyX
35040 and other programs in nested included files.
35041 For \SpecialChar LyX
35043 a relative file name is always relative to the document that contains the file name.
35044 For \SpecialChar LaTeX
35046 it is always relative to the master document.
35047 These two definitions are identical if you have only one document,
35048 but differ if you have a master document that includes part documents.
35049 That means that relative filenames must be transformed when presented to \SpecialChar LaTeX
35051 Fortunately \SpecialChar LyX
35052 does this automatically for you if you choose the right macros.
35055 \begin_layout Standard
35056 So which path macro should be used in new template definitions?
35057 The rule is not difficult:
35060 \begin_layout Itemize
35062 \begin_inset Flex Code
35065 \begin_layout Plain Layout
35071 if an absolute path is required.
35074 \begin_layout Itemize
35076 \begin_inset Flex Code
35079 \begin_layout Plain Layout
35080 $$AbsOrRelPathMaster
35085 if the substituted string is some kind of \SpecialChar LaTeX
35089 \begin_layout Itemize
35091 \begin_inset Flex Code
35094 \begin_layout Plain Layout
35095 $$AbsOrRelPathParent
35100 in order to preserve the user's choice.
35103 \begin_layout Standard
35104 There are special cases where this rule does not work and e.
35105 \begin_inset space \thinspace{}
35109 \begin_inset space \space{}
35112 relative names are needed,
35113 but normally it will work just fine.
35114 One example for such a case is the command
35115 \begin_inset Flex Code
35118 \begin_layout Plain Layout
35119 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
35124 in the XFig template above:
35125 We can't use the absolute name because the copier for
35126 \begin_inset Flex Code
35129 \begin_layout Plain Layout
35135 files needs the relative name in order to rewrite the file content.
35138 \begin_layout Section
35139 Security discussion
35140 \begin_inset CommandInset label
35142 name "sec:Security-discussion"
35149 \begin_layout Standard
35150 The external material feature interfaces with a lot of external programs and does so automatically,
35151 so we have to consider the security implications of this.
35153 since you have the option of including your own filenames and/or parameter strings and those are expanded into a command,
35154 it seems that it would be possible to create a malicious document which executes arbitrary commands when a user views or prints the document.
35155 This is something we definitely want to avoid.
35158 \begin_layout Standard
35160 since the external program commands are specified in the template configuration file only,
35161 there are no security issues if \SpecialChar LyX
35162 is properly configured with safe templates only.
35163 This is so because the external programs are invoked with the
35164 \begin_inset Flex Code
35167 \begin_layout Plain Layout
35173 -system call rather than the
35174 \begin_inset Flex Code
35177 \begin_layout Plain Layout
35184 so it's not possible to execute arbitrary commands from the filename or parameter section via the shell.
35187 \begin_layout Standard
35188 This also implies that you are restricted in what command strings you can use in the external material templates.
35190 pipes and redirection are not readily available.
35191 This has to be so if \SpecialChar LyX
35192 should remain safe.
35193 If you want to use some of the shell features,
35194 you should write a safe script to do this in a controlled manner,
35195 and then invoke the script from the command string.
35199 \begin_layout Standard
35200 It is possible to design a template that interacts directly with the shell,
35201 but since this would allow a malicious user to execute arbitrary commands by writing clever filenames and/or parameters,
35202 we generally recommend that you only use safe scripts that work with the
35203 \begin_inset Flex Code
35206 \begin_layout Plain Layout
35212 system call in a controlled manner.
35214 for use in a controlled environment,
35215 it can be tempting to just fall back to use ordinary shell scripts.
35221 provide an easily exploitable security hole in your system.
35222 Of course it stands to reason that such unsafe templates will never be included in the standard \SpecialChar LyX
35224 although we do encourage people to submit new templates in the open source tradition.
35225 But \SpecialChar LyX
35226 as shipped from the official distribution channels will never have unsafe templates.
35229 \begin_layout Standard
35230 Including external material provides a lot of power,
35231 and you have to be careful not to introduce security hazards with this power.
35232 A subtle error in a single line in an innocent looking script can open the door to huge security problems.
35233 So if you do not fully understand the issues,
35234 we recommend that you consult a knowledgeable security professional or the \SpecialChar LyX
35235 development team if you have any questions about whether a given template is safe or not.
35236 And do this before you use it in an uncontrolled environment.
35239 \begin_layout Chapter
35241 List of supported \SpecialChar LyX
35242 functions to be used in layouts
35243 \begin_inset CommandInset label
35245 name "chap:List-of-functions"
35252 \begin_layout Standard
35254 \begin_inset Tabular
35255 <lyxtabular version="3" rows="11" columns="8">
35256 <features tabularvalignment="middle">
35257 <column alignment="left" valignment="top">
35258 <column alignment="left" valignment="top">
35259 <column alignment="left" valignment="top">
35260 <column alignment="left" valignment="top">
35261 <column alignment="left" valignment="top">
35262 <column alignment="left" valignment="top">
35263 <column alignment="left" valignment="top">
35264 <column alignment="left" valignment="top">
35266 <cell alignment="left" valignment="top" usebox="none">
35269 \begin_layout Plain Layout
35275 <cell alignment="left" valignment="top" usebox="none">
35278 \begin_layout Plain Layout
35284 <cell alignment="left" valignment="top" usebox="none">
35287 \begin_layout Plain Layout
35293 <cell alignment="left" valignment="top" usebox="none">
35296 \begin_layout Plain Layout
35302 <cell alignment="center" valignment="top" usebox="none">
35305 \begin_layout Plain Layout
35311 <cell alignment="center" valignment="top" usebox="none">
35314 \begin_layout Plain Layout
35320 <cell alignment="center" valignment="top" usebox="none">
35323 \begin_layout Plain Layout
35329 <cell alignment="center" valignment="top" usebox="none">
35332 \begin_layout Plain Layout
35340 <cell alignment="left" valignment="top" usebox="none">
35343 \begin_layout Plain Layout
35349 <cell alignment="left" valignment="top" usebox="none">
35352 \begin_layout Plain Layout
35358 <cell alignment="left" valignment="top" usebox="none">
35361 \begin_layout Plain Layout
35367 <cell alignment="left" valignment="top" usebox="none">
35370 \begin_layout Plain Layout
35376 <cell alignment="center" valignment="top" usebox="none">
35379 \begin_layout Plain Layout
35385 <cell alignment="center" valignment="top" usebox="none">
35388 \begin_layout Plain Layout
35394 <cell alignment="center" valignment="top" usebox="none">
35397 \begin_layout Plain Layout
35403 <cell alignment="center" valignment="top" usebox="none">
35406 \begin_layout Plain Layout
35414 <cell alignment="left" valignment="top" usebox="none">
35417 \begin_layout Plain Layout
35423 <cell alignment="left" valignment="top" usebox="none">
35426 \begin_layout Plain Layout
35432 <cell alignment="left" valignment="top" usebox="none">
35435 \begin_layout Plain Layout
35441 <cell alignment="left" valignment="top" usebox="none">
35444 \begin_layout Plain Layout
35450 <cell alignment="center" valignment="top" usebox="none">
35453 \begin_layout Plain Layout
35459 <cell alignment="center" valignment="top" usebox="none">
35462 \begin_layout Plain Layout
35468 <cell alignment="center" valignment="top" usebox="none">
35471 \begin_layout Plain Layout
35477 <cell alignment="center" valignment="top" usebox="none">
35480 \begin_layout Plain Layout
35488 <cell alignment="left" valignment="top" usebox="none">
35491 \begin_layout Plain Layout
35497 <cell alignment="left" valignment="top" usebox="none">
35500 \begin_layout Plain Layout
35506 <cell alignment="left" valignment="top" usebox="none">
35509 \begin_layout Plain Layout
35515 <cell alignment="left" valignment="top" usebox="none">
35518 \begin_layout Plain Layout
35524 <cell alignment="center" valignment="top" usebox="none">
35527 \begin_layout Plain Layout
35533 <cell alignment="center" valignment="top" usebox="none">
35536 \begin_layout Plain Layout
35542 <cell alignment="center" valignment="top" usebox="none">
35545 \begin_layout Plain Layout
35551 <cell alignment="center" valignment="top" usebox="none">
35554 \begin_layout Plain Layout
35562 <cell alignment="left" valignment="top" usebox="none">
35565 \begin_layout Plain Layout
35571 <cell alignment="left" valignment="top" usebox="none">
35574 \begin_layout Plain Layout
35580 <cell alignment="left" valignment="top" usebox="none">
35583 \begin_layout Plain Layout
35589 <cell alignment="left" valignment="top" usebox="none">
35592 \begin_layout Plain Layout
35598 <cell alignment="center" valignment="top" usebox="none">
35601 \begin_layout Plain Layout
35607 <cell alignment="center" valignment="top" usebox="none">
35610 \begin_layout Plain Layout
35616 <cell alignment="center" valignment="top" usebox="none">
35619 \begin_layout Plain Layout
35625 <cell alignment="center" valignment="top" usebox="none">
35628 \begin_layout Plain Layout
35636 <cell alignment="left" valignment="top" usebox="none">
35639 \begin_layout Plain Layout
35645 <cell alignment="left" valignment="top" usebox="none">
35648 \begin_layout Plain Layout
35654 <cell alignment="left" valignment="top" usebox="none">
35657 \begin_layout Plain Layout
35663 <cell alignment="left" valignment="top" usebox="none">
35666 \begin_layout Plain Layout
35672 <cell alignment="center" valignment="top" usebox="none">
35675 \begin_layout Plain Layout
35681 <cell alignment="center" valignment="top" usebox="none">
35684 \begin_layout Plain Layout
35690 <cell alignment="center" valignment="top" usebox="none">
35693 \begin_layout Plain Layout
35699 <cell alignment="center" valignment="top" usebox="none">
35702 \begin_layout Plain Layout
35710 <cell alignment="left" valignment="top" usebox="none">
35713 \begin_layout Plain Layout
35719 <cell alignment="left" valignment="top" usebox="none">
35722 \begin_layout Plain Layout
35728 <cell alignment="left" valignment="top" usebox="none">
35731 \begin_layout Plain Layout
35737 <cell alignment="left" valignment="top" usebox="none">
35740 \begin_layout Plain Layout
35746 <cell alignment="center" valignment="top" usebox="none">
35749 \begin_layout Plain Layout
35755 <cell alignment="center" valignment="top" usebox="none">
35758 \begin_layout Plain Layout
35764 <cell alignment="center" valignment="top" usebox="none">
35767 \begin_layout Plain Layout
35773 <cell alignment="center" valignment="top" usebox="none">
35776 \begin_layout Plain Layout
35784 <cell alignment="left" valignment="top" usebox="none">
35787 \begin_layout Plain Layout
35793 <cell alignment="left" valignment="top" usebox="none">
35796 \begin_layout Plain Layout
35802 <cell alignment="left" valignment="top" usebox="none">
35805 \begin_layout Plain Layout
35811 <cell alignment="left" valignment="top" usebox="none">
35814 \begin_layout Plain Layout
35820 <cell alignment="center" valignment="top" usebox="none">
35823 \begin_layout Plain Layout
35829 <cell alignment="center" valignment="top" usebox="none">
35832 \begin_layout Plain Layout
35838 <cell alignment="center" valignment="top" usebox="none">
35841 \begin_layout Plain Layout
35847 <cell alignment="center" valignment="top" usebox="none">
35850 \begin_layout Plain Layout
35858 <cell alignment="left" valignment="top" usebox="none">
35861 \begin_layout Plain Layout
35867 <cell alignment="left" valignment="top" usebox="none">
35870 \begin_layout Plain Layout
35876 <cell alignment="left" valignment="top" usebox="none">
35879 \begin_layout Plain Layout
35885 <cell alignment="left" valignment="top" usebox="none">
35888 \begin_layout Plain Layout
35894 <cell alignment="center" valignment="top" usebox="none">
35897 \begin_layout Plain Layout
35903 <cell alignment="center" valignment="top" usebox="none">
35906 \begin_layout Plain Layout
35912 <cell alignment="center" valignment="top" usebox="none">
35915 \begin_layout Plain Layout
35921 <cell alignment="center" valignment="top" usebox="none">
35924 \begin_layout Plain Layout
35932 <cell alignment="left" valignment="top" usebox="none">
35935 \begin_layout Plain Layout
35941 <cell alignment="left" valignment="top" usebox="none">
35944 \begin_layout Plain Layout
35950 <cell alignment="left" valignment="top" usebox="none">
35953 \begin_layout Plain Layout
35959 <cell alignment="left" valignment="top" usebox="none">
35962 \begin_layout Plain Layout
35968 <cell alignment="center" valignment="top" usebox="none">
35971 \begin_layout Plain Layout
35977 <cell alignment="center" valignment="top" usebox="none">
35980 \begin_layout Plain Layout
35986 <cell alignment="center" valignment="top" usebox="none">
35989 \begin_layout Plain Layout
35995 <cell alignment="center" valignment="top" usebox="none">
35998 \begin_layout Plain Layout
36006 <cell alignment="center" valignment="top" usebox="none">
36009 \begin_layout Plain Layout
36015 <cell alignment="center" valignment="top" usebox="none">
36018 \begin_layout Plain Layout
36024 <cell alignment="center" valignment="top" usebox="none">
36027 \begin_layout Plain Layout
36033 <cell alignment="center" valignment="top" usebox="none">
36036 \begin_layout Plain Layout
36042 <cell alignment="center" valignment="top" usebox="none">
36045 \begin_layout Plain Layout
36051 <cell alignment="center" valignment="top" usebox="none">
36054 \begin_layout Plain Layout
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
36086 \begin_layout Chapter
36087 Names of available colors to be used in layouts
36088 \begin_inset CommandInset label
36090 name "chap:Names-of-colors"
36097 \begin_layout Standard
36098 The colors listed below are the standard colors and those that you can adjust in the \SpecialChar LyX
36102 \begin_layout Section
36106 \begin_layout Standard
36107 The following are no real colors,
36108 but rather act on color definitions:
36111 \begin_layout Description
36112 ignore The color is ignored
36115 \begin_layout Description
36116 inherit The color is inherited
36119 \begin_layout Description
36132 No particular color – clear or default
36135 \begin_layout Section
36139 \begin_layout Standard
36140 These are fixed colors that cannot be customized
36141 \change_inserted -712698321 1607683177
36147 use these colors in layout definitions,
36148 since they will not work well with some color themes (such as dark themes)
36153 \begin_layout Description
36157 \begin_layout Description
36161 \begin_layout Description
36165 \begin_layout Description
36169 \begin_layout Description
36173 \begin_layout Description
36177 \begin_layout Description
36181 \begin_layout Description
36185 \begin_layout Description
36189 \begin_layout Description
36193 \begin_layout Description
36197 \begin_layout Description
36201 \begin_layout Description
36205 \begin_layout Description
36209 \begin_layout Description
36213 \begin_layout Description
36217 \begin_layout Description
36221 \begin_layout Description
36225 \begin_layout Description
36229 \begin_layout Section
36233 \begin_layout Standard
36234 These are the colors allocated to specific elements in
36237 arg "dialog-show prefs"
36243 \begin_layout Description
36244 added_space Added space color
36247 \begin_layout Description
36248 addedtext Added text color
36251 \begin_layout Description
36252 appendix Appendix marker color
36255 \begin_layout Description
36256 background Background color
36259 \begin_layout Description
36260 bottomarea Bottom area color
36263 \begin_layout Description
36264 branchlabel Label color for branches
36267 \begin_layout Description
36268 buttonbg Color used for button background
36271 \begin_layout Description
36272 buttonframe Color for inset button frames
36275 \begin_layout Description
36276 buttonhoverbg Color used for button background under focus
36279 \begin_layout Description
36280 changebar Changebar color
36283 \begin_layout Description
36284 changedtextauthor1 Changed text color author 1
36287 \begin_layout Description
36288 changedtextauthor2 Changed text color author 2
36291 \begin_layout Description
36292 changedtextauthor3 Changed text color author 3
36295 \begin_layout Description
36296 changedtextauthor4 Changed text color author 4
36299 \begin_layout Description
36300 changedtextauthor5 Changed text color author 5
36303 \begin_layout Description
36304 collapsible Collapsible insets text color
36307 \begin_layout Description
36308 collapsibleframe Collapsible insets framecolor
36311 \begin_layout Description
36312 command Text color for command insets
36315 \begin_layout Description
36316 commandbg Background color for command insets
36319 \begin_layout Description
36320 commandframe Frame color for command insets
36323 \begin_layout Description
36324 comment Label color for comments
36327 \begin_layout Description
36328 commentbg Background color of comments
36331 \begin_layout Description
36332 cursor Cursor color
36335 \begin_layout Description
36336 deletedtext Deleted text color
36339 \begin_layout Description
36340 deletedtextmodifier Deleted text modifying color
36343 \begin_layout Description
36344 depthbar Color for the depth bars in the margin
36347 \begin_layout Description
36348 eolmarker End of line marker color
36351 \begin_layout Description
36352 error Color of the \SpecialChar LaTeX
36356 \begin_layout Description
36357 footlabel Label color for footnotes
36360 \begin_layout Description
36361 foreground Foreground color
36364 \begin_layout Description
36365 graphicsbg Graphics inset background color
36368 \begin_layout Description
36369 greyedoutbg Background color of greyedout inset
36372 \begin_layout Description
36373 greyedoutlabel Label color for greyedout insets
36376 \begin_layout Description
36377 greyedouttext Color for greyedout inset text
36380 \begin_layout Description
36381 indexlabel Label color for index insets
36384 \begin_layout Description
36385 inlinecompletion Inline completion color
36388 \begin_layout Description
36389 insetbg Inset marker background color
36392 \begin_layout Description
36393 insetframe Inset marker frame color
36396 \begin_layout Description
36397 language Color for marking foreign language words
36400 \begin_layout Description
36401 latex Text color in \SpecialChar LaTeX
36405 \begin_layout Description
36406 listingsbg Background color of listings inset
36409 \begin_layout Description
36410 marginlabel Label color for margin notes
36413 \begin_layout Description
36414 math Math inset text color
36417 \begin_layout Description
36418 mathbg Math inset background color
36421 \begin_layout Description
36422 mathcorners Math inset frame color not under focus
36425 \begin_layout Description
36426 mathframe Math inset frame color under focus
36429 \begin_layout Description
36430 mathline Math line color
36433 \begin_layout Description
36434 mathmacrobg Macro math inset background color
36437 \begin_layout Description
36438 mathmacroblend Macro math blended color
36441 \begin_layout Description
36442 mathmacroframe Macro math frame color
36445 \begin_layout Description
36446 mathmacrohoverbg Macro math inset background color hovered
36449 \begin_layout Description
36450 mathmacrolabel Macro math label color
36453 \begin_layout Description
36454 mathmacronewarg Macro template color for new parameters
36457 \begin_layout Description
36458 mathmacrooldarg Macro template color for old parameters
36461 \begin_layout Description
36462 newpage New page color
36465 \begin_layout Description
36466 nonunique_inlinecompletion Inline completion color for the non-unique part
36469 \begin_layout Description
36470 note Label color for notes
36473 \begin_layout Description
36474 notebg Background color of notes
36477 \begin_layout Description
36478 pagebreak Page break/line break color
36481 \begin_layout Description
36482 paragraphmarker Color used for the pilcrow sign to mark the end of a paragraph
36485 \begin_layout Description
36486 phantomtext Text color for phantom insets
36489 \begin_layout Description
36490 preview The color used for previews
36493 \begin_layout Description
36494 previewframe Preview frame color
36497 \begin_layout Description
36498 regexpframe Color for regexp frame
36501 \begin_layout Description
36502 scroll Color that indicates when a row can be scrolled
36505 \begin_layout Description
36506 selection Background color of selected text
36509 \begin_layout Description
36510 selectiontext Foreground color of selected text
36513 \begin_layout Description
36514 shadedbg Background color of shaded box
36517 \begin_layout Description
36518 special Special chars text color
36521 \begin_layout Description
36522 tabularline Table line color
36525 \begin_layout Description
36526 tabularonoffline Table line color
36527 \change_inserted -712698321 1607682522
36531 \begin_layout Description
36533 \change_inserted -712698321 1607682563
36534 textlabel1 Color 1 of layout and custom inset labels
36537 \begin_layout Description
36539 \change_inserted -712698321 1607682565
36540 textlabel2 Color 2 of layout and custom inset labels
36543 \begin_layout Description
36545 \change_inserted -712698321 1607682568
36546 textlabel3 Color 3 of layout and custom inset labels
36551 \begin_layout Description
36552 urllabel Label color for URL insets
36555 \begin_layout Description
36556 urltext Color for URL inset text