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
14631 \begin_inset Flex Code
14634 \begin_layout Plain Layout
14640 Depth of XML command.
14641 Used only with XML-type formats.
14644 \begin_layout Description
14645 \begin_inset Flex Code
14648 \begin_layout Plain Layout
14655 \begin_inset Flex Code
14658 \begin_layout Plain Layout
14664 ] Copies all the features of an existing style into the current one.
14668 \begin_layout Description
14669 \begin_inset Flex Code
14672 \begin_layout Plain Layout
14679 \begin_inset Flex Code
14682 \begin_layout Plain Layout
14688 ] The name of a style whose preamble should be output
14693 This allows to ensure some ordering of the preamble snippets when macros definitions depend on one another.
14697 \begin_layout Plain Layout
14699 besides that functionality,
14700 there is no way to ensure any ordering of preambles.
14701 The ordering that you see in a given version of \SpecialChar LyX
14702 may change without warning in later versions.
14710 \begin_layout Description
14711 \begin_inset Flex Code
14714 \begin_layout Plain Layout
14721 \begin_inset Flex Code
14724 \begin_layout Plain Layout
14737 ] The type of label that stands at the end of the paragraph (or sequence of paragraphs if
14738 \begin_inset Flex Code
14741 \begin_layout Plain Layout
14748 \begin_inset Newline newline
14752 \begin_inset Flex Code
14755 \begin_layout Plain Layout
14763 \begin_inset Flex Code
14766 \begin_layout Plain Layout
14773 \begin_inset Flex Code
14776 \begin_layout Plain Layout
14784 \begin_inset Flex Code
14787 \begin_layout Plain Layout
14794 \begin_inset Quotes eld
14798 \begin_inset Quotes erd
14803 \begin_inset Flex Code
14806 \begin_layout Plain Layout
14813 \begin_inset space \space{}
14817 \begin_inset Flex Code
14820 \begin_layout Plain Layout
14826 ) is a white (resp.
14827 \begin_inset space ~
14830 black) square suitable for end of proof markers,
14832 \begin_inset Flex Code
14835 \begin_layout Plain Layout
14841 is an explicit text string.
14844 \begin_layout Description
14845 \begin_inset Flex Code
14848 \begin_layout Plain Layout
14855 \begin_inset Flex Code
14858 \begin_layout Plain Layout
14864 ] The string used for a label with a
14865 \begin_inset Flex Code
14868 \begin_layout Plain Layout
14875 \begin_inset Newline newline
14879 \begin_inset Flex Code
14882 \begin_layout Plain Layout
14892 \begin_layout Description
14893 \begin_inset Flex Code
14896 \begin_layout Plain Layout
14902 The font used for both the text body
14908 \begin_inset CommandInset ref
14910 reference "subsec:Font-description"
14916 Note that defining this font automatically defines the
14917 \begin_inset Flex Code
14920 \begin_layout Plain Layout
14927 So you should define this one first if you also want to define
14928 \begin_inset Flex Code
14931 \begin_layout Plain Layout
14940 \begin_layout Description
14941 \begin_inset Flex Code
14944 \begin_layout Plain Layout
14951 \begin_inset Flex Code
14954 \begin_layout Plain Layout
14960 ] Used for backporting new styles to stable \SpecialChar LyX
14962 The first stable version that supports this tag is \SpecialChar LyX
14964 The argument is a number which may either be 0,
14965 -1 or any value greater than zero.
14967 \begin_inset Flex Code
14970 \begin_layout Plain Layout
14976 flag of a style is greater than zero,
14977 it will always be written to the document header.
14978 If a .lyx file is read,
14979 the style definitions from the document header are added to the document class.
14980 Therefore even older \SpecialChar LyX
14981 versions can handle the style.
14983 \begin_inset Flex Code
14986 \begin_layout Plain Layout
14992 is a version number:
14993 if the style is read,
14994 and the version number is less than the version number of the already existing style in the document class,
14995 the new style is ignored.
14996 If the version number is greater,
14997 the new style replaces the existing style.
14998 A value of -1 means an infinite version number,
15000 \begin_inset space \thinspace{}
15004 \begin_inset space \space{}
15007 the style is always used.
15010 \begin_layout Description
15011 \begin_inset Flex Code
15014 \begin_layout Plain Layout
15021 \begin_inset Flex Code
15024 \begin_layout Plain Layout
15033 \begin_inset space \thinspace{}
15037 \begin_inset Flex Code
15040 \begin_layout Plain Layout
15046 ] Usually \SpecialChar LyX
15047 does not allow you to insert more than one space between words,
15048 since a space is considered as the separation between two words,
15049 not a character or symbol of its own.
15050 This is a very fine thing but sometimes annoying,
15052 when typing program code or plain \SpecialChar LaTeX
15056 \begin_inset Flex Code
15059 \begin_layout Plain Layout
15067 \change_deleted -495245474 1550490105
15072 \change_deleted 177693 1654669077
15074 \change_inserted 177693 1654669079
15078 \change_deleted 177693 1654669082
15080 \change_inserted 177693 1654669082
15083 for the additional blanks when
15084 \change_deleted 34634807 1619626461
15088 \change_inserted -495245474 1550490096
15090 \begin_inset Flex Code
15093 \begin_layout Plain Layout
15095 \change_inserted -495245474 1550490089
15104 \change_deleted -495245474 1550490116
15105 another mode than \SpecialChar LaTeX
15108 \change_inserted -495245474 1550247760
15110 \begin_inset Flex Code
15113 \begin_layout Plain Layout
15115 \change_inserted -495245474 1550247736
15124 \begin_inset Flex Code
15127 \begin_layout Plain Layout
15129 \change_inserted -495245474 1550247755
15142 \begin_layout Description
15143 \begin_inset Flex Code
15146 \begin_layout Plain Layout
15152 These tags are used with XHTML output.
15154 \begin_inset CommandInset ref
15156 reference "subsec:Paragraph-Style-XHTML"
15164 \begin_layout Description
15165 \begin_inset Flex Code
15168 \begin_layout Plain Layout
15174 [FIXME] (Used only with XML-type formats.)
15177 \begin_layout Description
15178 \begin_inset Flex Code
15181 \begin_layout Plain Layout
15188 \begin_inset Flex Code
15191 \begin_layout Plain Layout
15200 \begin_inset space \thinspace{}
15204 \begin_inset Flex Code
15207 \begin_layout Plain Layout
15214 \begin_inset Flex Code
15217 \begin_layout Plain Layout
15224 marks the style as to be included in the document preamble and not in the document body.
15225 This is useful for document classes that want such information as the title and author to appear in the preamble.
15226 Note that this works only for styles for which the
15227 \begin_inset Flex Code
15230 \begin_layout Plain Layout
15237 \begin_inset Flex Code
15240 \begin_layout Plain Layout
15247 \begin_inset Flex Code
15250 \begin_layout Plain Layout
15259 \begin_layout Description
15260 \begin_inset Flex Code
15263 \begin_layout Plain Layout
15270 \begin_inset Flex Code
15273 \begin_layout Plain Layout
15282 \begin_inset space \thinspace{}
15286 \begin_inset Flex Code
15289 \begin_layout Plain Layout
15296 \begin_inset Flex Code
15299 \begin_layout Plain Layout
15306 marks the style as being part of a title block (see also the
15307 \begin_inset Flex Code
15310 \begin_layout Plain Layout
15317 \begin_inset Flex Code
15320 \begin_layout Plain Layout
15329 \begin_layout Description
15330 \begin_inset Flex Code
15333 \begin_layout Plain Layout
15339 Includes a comma-separated list of layouts after which this one should be nested.
15340 Only makes sense with regard to nestable layouts (such as environments).
15342 \begin_inset Quotes eld
15346 \begin_inset Flex Code
15349 \begin_layout Plain Layout
15356 \begin_inset Quotes erd
15361 \begin_inset Flex Code
15364 \begin_layout Plain Layout
15373 \begin_layout Description
15374 \begin_inset Flex Code
15377 \begin_layout Plain Layout
15384 \begin_inset Flex Code
15387 \begin_layout Plain Layout
15396 \begin_inset space \thinspace{}
15400 \begin_inset Flex Code
15403 \begin_layout Plain Layout
15409 ] If this is set to 1 and AddToToc is enabled,
15410 the paragraph adds a summary of its contents in its item in the table of contents.
15417 \begin_layout Description
15418 \begin_inset Flex Code
15421 \begin_layout Plain Layout
15428 \begin_inset Flex Code
15431 \begin_layout Plain Layout
15437 ] The \SpecialChar LaTeX
15438 command sequence declaring an item in a list.
15439 The command is to be defined without the preceding backslash (the default is
15440 \begin_inset Quotes eld
15444 \begin_inset Quotes erd
15449 \begin_inset Flex Code
15452 \begin_layout Plain Layout
15460 in the \SpecialChar LaTeX
15464 \begin_layout Description
15465 \begin_inset Flex Code
15468 \begin_layout Plain Layout
15475 \begin_inset Flex Code
15478 \begin_layout Plain Layout
15484 ] This provides extra space between paragraphs that have the same style.
15485 If you put other styles into an environment,
15486 each is separated with the environment's
15487 \begin_inset Flex Code
15490 \begin_layout Plain Layout
15497 But the whole items of the environment are additionally separated with this
15498 \begin_inset Flex Code
15501 \begin_layout Plain Layout
15508 Note that this is a
15513 \begin_layout Description
15514 \begin_inset Flex Code
15517 \begin_layout Plain Layout
15523 [FIXME] (Used only with XML-type formats.)
15526 \begin_layout Description
15527 \begin_inset Flex Code
15530 \begin_layout Plain Layout
15537 \begin_inset Flex Code
15540 \begin_layout Plain Layout
15549 \begin_inset space \thinspace{}
15553 \begin_inset Flex Code
15556 \begin_layout Plain Layout
15562 ] Usually \SpecialChar LyX
15563 does not allow you to leave a paragraph empty,
15564 since it would lead to empty \SpecialChar LaTeX
15566 There are some cases where this could be desirable however:
15567 in a letter template,
15568 the required fields can be provided as empty fields,
15569 so that people do not forget them;
15570 in some special classes,
15571 a style can be used as some kind of break,
15572 which does not contain actual text.
15575 \begin_layout Description
15576 \begin_inset Flex Code
15579 \begin_layout Plain Layout
15586 \begin_inset Flex Code
15589 \begin_layout Plain Layout
15595 ] The vertical space between the label and the text body.
15596 Only used for labels that are above the text body (
15597 \begin_inset Flex Code
15600 \begin_layout Plain Layout
15607 \begin_inset Newline newline
15611 \begin_inset Flex Code
15614 \begin_layout Plain Layout
15615 Centered_Top_Environment
15623 \begin_layout Description
15624 \begin_inset Flex Code
15627 \begin_layout Plain Layout
15634 \begin_inset Flex Code
15637 \begin_layout Plain Layout
15643 ] The name of the counter for automatic numbering.
15644 In order to have the counter appear with your label,
15645 you will need to reference it in the
15646 \begin_inset Flex Code
15649 \begin_layout Plain Layout
15658 This will work with
15659 \begin_inset Flex Code
15662 \begin_layout Plain Layout
15670 \begin_inset Flex Code
15673 \begin_layout Plain Layout
15681 \begin_inset Flex Code
15684 \begin_layout Plain Layout
15691 \begin_inset Flex Code
15694 \begin_layout Plain Layout
15702 \begin_inset Newline newline
15710 \begin_inset Flex Code
15713 \begin_layout Plain Layout
15720 \begin_inset Flex Code
15723 \begin_layout Plain Layout
15730 though this case is a bit complicated.
15731 Suppose you declare
15732 \begin_inset Quotes eld
15736 \begin_inset Flex Code
15739 \begin_layout Plain Layout
15740 LabelCounter myenum
15746 \begin_inset Quotes erd
15750 Then the actual counters used are
15751 \begin_inset Flex Code
15754 \begin_layout Plain Layout
15762 \begin_inset Flex Code
15765 \begin_layout Plain Layout
15773 \begin_inset Flex Code
15776 \begin_layout Plain Layout
15783 \begin_inset Flex Code
15786 \begin_layout Plain Layout
15793 much as in \SpecialChar LaTeX
15795 These counters must all be declared separately.
15796 \begin_inset Newline newline
15800 \begin_inset CommandInset ref
15802 reference "subsec:Counters"
15807 for details on counters.
15810 \begin_layout Description
15811 \begin_inset Flex Code
15814 \begin_layout Plain Layout
15820 The font used for the label.
15822 \begin_inset CommandInset ref
15824 reference "subsec:Font-description"
15832 \begin_layout Description
15833 \begin_inset Flex Code
15836 \begin_layout Plain Layout
15843 \begin_inset Flex Code
15846 \begin_layout Plain Layout
15852 ] Text that indicates how far a label should be indented.
15855 \begin_layout Description
15856 \begin_inset Flex Code
15859 \begin_layout Plain Layout
15866 \begin_inset Flex Code
15869 \begin_layout Plain Layout
15875 ] Text that indicates the amount of horizontal space between the label and the text body.
15876 Only used for labels that are not above the text body.
15879 \begin_layout Description
15880 \begin_inset Flex Code
15883 \begin_layout Plain Layout
15890 \begin_inset Flex Code
15893 \begin_layout Plain Layout
15899 ] The string used for the label.
15901 \begin_inset Flex Code
15904 \begin_layout Plain Layout
15911 this string can be contain the special formatting commands described in
15912 \begin_inset CommandInset ref
15914 reference "subsec:Counters"
15922 \begin_layout Description
15923 \begin_inset Flex Code
15926 \begin_layout Plain Layout
15927 LabelStringAppendix
15933 \begin_inset Flex Code
15936 \begin_layout Plain Layout
15942 ] This is used inside the appendix instead of
15943 \begin_inset Newline newline
15947 \begin_inset Flex Code
15950 \begin_layout Plain Layout
15958 \begin_inset Flex Code
15961 \begin_layout Plain Layout
15968 \begin_inset Newline newline
15972 \begin_inset Flex Code
15975 \begin_layout Plain Layout
15976 LabelStringAppendix
15984 \begin_layout Description
15985 \begin_inset Flex Code
15988 \begin_layout Plain Layout
15994 [FIXME] (Used only with XML-type formats.)
15997 \begin_layout Description
15998 \begin_inset Flex Code
16001 \begin_layout Plain Layout
16008 \begin_inset Flex Code
16011 \begin_layout Plain Layout
16021 \begin_inset Newline newline
16027 \begin_inset Newline newline
16040 \begin_layout Description
16041 \begin_inset Flex Code
16044 \begin_layout Plain Layout
16050 means the label is the very first word (up to the first real blank).
16052 \change_deleted 177693 1654669087
16054 \change_inserted 177693 1654669089
16057 spaces if you want more than one word as the label.
16061 \begin_layout Description
16062 \begin_inset Flex Code
16065 \begin_layout Plain Layout
16071 means the label is simply what is declared as
16072 \begin_inset Flex Code
16075 \begin_layout Plain Layout
16082 This will be displayed
16083 \begin_inset Quotes eld
16087 \begin_inset Quotes erd
16091 at the beginning of the paragraph.
16093 \begin_inset Flex Code
16096 \begin_layout Plain Layout
16103 \begin_inset Flex Code
16106 \begin_layout Plain Layout
16113 then it will be displayed only in the first paragraph of any sequence of paragraphs with the same
16114 \begin_inset Flex Code
16117 \begin_layout Plain Layout
16126 \begin_layout Description
16127 \begin_inset Flex Code
16130 \begin_layout Plain Layout
16137 \begin_inset space ~
16141 \begin_inset space ~
16145 \begin_inset Flex Code
16148 \begin_layout Plain Layout
16154 are special cases of
16155 \begin_inset Flex Code
16158 \begin_layout Plain Layout
16165 The label will be printed above the paragraph either at the beginning of the line or centered.
16168 \begin_layout Description
16169 \begin_inset Flex Code
16172 \begin_layout Plain Layout
16178 is a special case for the caption-labels
16179 \begin_inset Quotes eld
16183 \begin_inset Quotes erd
16187 \begin_inset Quotes eld
16191 \begin_inset Quotes erd
16195 \begin_inset Newline newline
16199 \begin_inset Flex Code
16202 \begin_layout Plain Layout
16208 means the (hardcoded) label string depends on the kind of float:
16209 It is hardcoded to be `FloatType N',
16210 where N is the value of the counter associated with the float.
16211 For the case that a caption is inserted outside of a float the
16212 \begin_inset Flex Code
16215 \begin_layout Plain Layout
16222 \begin_inset Quotes eld
16226 \begin_inset Quotes erd
16232 \begin_layout Description
16233 \begin_inset Flex Code
16236 \begin_layout Plain Layout
16242 produces the usual sort of enumeration labels.
16243 The number type needs to be set in the
16249 \begin_inset CommandInset ref
16251 reference "subsec:Counters"
16259 \begin_layout Description
16260 \begin_inset Flex Code
16263 \begin_layout Plain Layout
16269 produces various bullets at the different levels.
16270 The bullet types displayed can be set via
16271 \begin_inset Flex Noun
16274 \begin_layout Plain Layout
16275 Document\SpecialChar menuseparator
16276 Settings\SpecialChar menuseparator
16285 \begin_layout Description
16286 \begin_inset Flex Code
16289 \begin_layout Plain Layout
16295 should be used only with
16296 \begin_inset Flex Code
16299 \begin_layout Plain Layout
16300 LatexType BibEnvironment
16309 \begin_layout Description
16310 \begin_inset Flex Code
16313 \begin_layout Plain Layout
16319 Note that this will completely override any prior
16320 \begin_inset Flex Code
16323 \begin_layout Plain Layout
16329 declaration for this style.
16331 \begin_inset Quotes eld
16335 \begin_inset Flex Code
16338 \begin_layout Plain Layout
16345 \begin_inset Quotes erd
16350 \begin_inset CommandInset ref
16352 reference "subsec:I18n"
16357 for details on its use.
16360 \begin_layout Description
16361 \begin_inset Flex Code
16364 \begin_layout Plain Layout
16371 \begin_inset Flex Code
16374 \begin_layout Plain Layout
16380 ] The name of the corresponding \SpecialChar LaTeX
16382 Either the environment or command name.
16385 \begin_layout Description
16386 \begin_inset Flex Code
16389 \begin_layout Plain Layout
16396 \begin_inset Flex Code
16399 \begin_layout Plain Layout
16405 ] An optional parameter for the corresponding
16406 \begin_inset Flex Code
16409 \begin_layout Plain Layout
16416 This parameter cannot be changed from within \SpecialChar LyX
16418 \begin_inset Flex Code
16421 \begin_layout Plain Layout
16427 for customizable parameters).
16428 This will be output as is after all \SpecialChar LaTeX
16430 \begin_inset Flex Code
16433 \begin_layout Plain Layout
16442 \begin_layout Description
16443 \begin_inset Flex Code
16446 \begin_layout Plain Layout
16453 \begin_inset Flex Code
16456 \begin_layout Plain Layout
16465 \begin_inset Newline newline
16474 ] How the style should be translated into \SpecialChar LaTeX
16479 \begin_layout Plain Layout
16480 \begin_inset Flex Code
16483 \begin_layout Plain Layout
16489 is perhaps a bit misleading,
16490 since these rules apply to SGML classes,
16492 Visit the SGML class files for specific examples.
16501 \begin_layout Description
16502 \begin_inset Flex Code
16505 \begin_layout Plain Layout
16511 means nothing special.
16514 \begin_layout Description
16515 \begin_inset Flex Code
16518 \begin_layout Plain Layout
16525 \begin_inset Flex Code
16528 \begin_layout Plain Layout
16535 {\SpecialChar ldots
16544 \begin_layout Description
16545 \begin_inset Flex Code
16548 \begin_layout Plain Layout
16555 \begin_inset Flex Code
16558 \begin_layout Plain Layout
16565 }\SpecialChar ldots
16581 \begin_layout Description
16582 \begin_inset Flex Code
16585 \begin_layout Plain Layout
16592 \begin_inset Flex Code
16595 \begin_layout Plain Layout
16603 \begin_inset Flex Code
16606 \begin_layout Plain Layout
16614 is generated for each paragraph of this environment.
16618 \begin_layout Description
16619 \begin_inset Flex Code
16622 \begin_layout Plain Layout
16629 \begin_inset Flex Code
16632 \begin_layout Plain Layout
16640 \begin_inset Newline newline
16644 \begin_inset Flex Code
16647 \begin_layout Plain Layout
16653 is passed as an argument to the environment.
16654 \begin_inset Newline newline
16658 \begin_inset Flex Code
16661 \begin_layout Plain Layout
16667 can be defined in the
16668 \begin_inset Flex Noun
16671 \begin_layout Plain Layout
16672 Edit\SpecialChar menuseparator
16674 \begin_inset space ~
16685 \begin_layout Description
16686 \begin_inset Flex Code
16689 \begin_layout Plain Layout
16696 \begin_inset Flex Code
16699 \begin_layout Plain Layout
16705 but adds the necessary mandatory argument (the longest label) to the begin statement of the bibliography environment:
16706 \begin_inset Newline newline
16710 \begin_inset Flex Code
16713 \begin_layout Plain Layout
16716 begin{thebibliography}{99}
16722 It is therefore only useful for bibliography environments.
16723 The default longest label
16724 \begin_inset Quotes eld
16728 \begin_inset Quotes erd
16731 can be changed by the user in the paragraph settings of a bibliography item.
16734 \begin_layout Standard
16735 Putting the last few things together,
16736 the \SpecialChar LaTeX
16737 output will be either:
16741 \begin_layout LyX-Code
16744 LatexName[LatexParam]{\SpecialChar ldots
16748 \begin_layout Standard
16753 \begin_layout LyX-Code
16756 begin{LatexName}[LatexParam] \SpecialChar ldots
16762 \begin_layout Standard
16763 depending upon the \SpecialChar LaTeX
16768 \begin_layout Description
16769 \begin_inset Flex Code
16772 \begin_layout Plain Layout
16779 \begin_inset Flex Code
16782 \begin_layout Plain Layout
16788 ] A string that is put at the beginning of the style content.
16789 A line break in the output can be indicated by
16790 \begin_inset Flex Code
16793 \begin_layout Plain Layout
16802 \begin_layout Description
16803 \begin_inset Flex Code
16806 \begin_layout Plain Layout
16813 \begin_inset Flex Code
16816 \begin_layout Plain Layout
16822 ] If you put styles into environments,
16824 \begin_inset Flex Code
16827 \begin_layout Plain Layout
16833 are not simply added,
16834 but added with a factor
16835 \begin_inset Formula $\frac{4}{\mathrm{depth}+4}$
16839 Note that this parameter is also used when
16840 \begin_inset Flex Code
16843 \begin_layout Plain Layout
16850 \begin_inset Flex Code
16853 \begin_layout Plain Layout
16860 \begin_inset Flex Code
16863 \begin_layout Plain Layout
16870 Then it is added to the manual or dynamic margin.
16871 \begin_inset Newline newline
16875 \begin_inset Quotes eld
16879 \begin_inset Flex Code
16882 \begin_layout Plain Layout
16889 \begin_inset Quotes erd
16892 means that the paragraph is indented with the width of
16893 \begin_inset Quotes eld
16897 \begin_inset Flex Code
16900 \begin_layout Plain Layout
16907 \begin_inset Quotes erd
16910 in the normal font.
16911 You can get a negative width by prefixing the string with
16912 \begin_inset Quotes eld
16916 \begin_inset Flex Code
16919 \begin_layout Plain Layout
16926 \begin_inset Quotes erd
16930 This way was chosen so that the look is the same with each used screen font.
16933 \begin_layout Description
16934 \begin_inset Flex Code
16937 \begin_layout Plain Layout
16944 \begin_inset Flex Code
16947 \begin_layout Plain Layout
16962 \begin_inset Newline newline
16965 The kind of margin that the style has on the left side.
16969 \begin_layout Description
16970 \begin_inset Flex Code
16973 \begin_layout Plain Layout
16979 just means a fixed margin.
16982 \begin_layout Description
16983 \begin_inset Flex Code
16986 \begin_layout Plain Layout
16992 means that the left margin depends on the string entered in the
16993 \begin_inset Flex Noun
16996 \begin_layout Plain Layout
16997 Edit\SpecialChar menuseparator
16999 \begin_inset space ~
17008 This is used to typeset nice lists without tabulators.
17011 \begin_layout Description
17012 \begin_inset Flex Code
17015 \begin_layout Plain Layout
17021 means that the margin depends on the size of the label.
17022 This is used for automatic enumerated headlines.
17023 It is obvious that the headline
17024 \begin_inset Quotes eld
17027 5.4.3.2.1 Very long headline
17028 \begin_inset Quotes erd
17031 must have a wider left margin (as wide as
17032 \begin_inset Quotes eld
17036 \begin_inset Quotes erd
17039 plus the space) than
17040 \begin_inset Quotes eld
17043 3.2 Very long headline
17044 \begin_inset Quotes erd
17049 \begin_inset Quotes eld
17053 \begin_inset Quotes erd
17056 are not able to do this.
17059 \begin_layout Description
17060 \begin_inset Flex Code
17063 \begin_layout Plain Layout
17070 but only the very first row of the paragraph is dynamic,
17071 while the others are static;
17077 \begin_layout Description
17078 \begin_inset Flex Code
17081 \begin_layout Plain Layout
17087 means the margin is chosen in a way that the longest row of this paragraph fits to the right margin.
17088 This is used to typeset an address on the right edge of the page.
17092 \begin_layout Description
17093 \begin_inset Flex Code
17096 \begin_layout Plain Layout
17103 \begin_inset Flex Code
17106 \begin_layout Plain Layout
17115 \begin_inset space \thinspace{}
17119 \begin_inset Flex Code
17122 \begin_layout Plain Layout
17128 ] Whether fragile commands in this style should be
17129 \begin_inset Flex Code
17132 \begin_layout Plain Layout
17146 whether this command should itself be protected.)
17147 \change_inserted -712698321 1523696949
17151 \begin_layout Description
17153 \change_inserted -712698321 1552395557
17154 \begin_inset Flex Code
17157 \begin_layout Plain Layout
17159 \change_inserted -712698321 1523696950
17168 \begin_inset Flex Code
17171 \begin_layout Plain Layout
17173 \change_inserted -712698321 1523696950
17184 \begin_inset space \thinspace{}
17188 \begin_inset Flex Code
17191 \begin_layout Plain Layout
17193 \change_inserted -712698321 1523696950
17201 ] This causes macros that contain this layout to be protected with
17202 \begin_inset Flex Code
17205 \begin_layout Plain Layout
17207 \change_inserted -712698321 1523696950
17222 ) if necessary and thus allows (some) verbatim stuff in macros.
17225 \begin_layout Description
17227 \change_inserted -712698321 1552395844
17228 \begin_inset Flex Code
17231 \begin_layout Plain Layout
17233 \change_inserted -712698321 1552395561
17242 \begin_inset Flex Code
17245 \begin_layout Plain Layout
17247 \change_inserted -712698321 1552395557
17258 \begin_inset space \thinspace{}
17262 \begin_inset Flex Code
17265 \begin_layout Plain Layout
17267 \change_inserted -712698321 1552395557
17275 ] Whether specific commands in this style (such as
17276 \begin_inset Flex Code
17279 \begin_layout Plain Layout
17281 \change_inserted -712698321 1552395655
17292 \begin_inset Flex Code
17295 \begin_layout Plain Layout
17297 \change_inserted -712698321 1552395661
17307 ) should be protected in an
17308 \begin_inset Flex Code
17311 \begin_layout Plain Layout
17313 \change_inserted -712698321 1552395631
17324 This is particularly needed for styles that draw on
17332 commands which parse their content in complex ways.
17337 \begin_layout Description
17338 \begin_inset Flex Code
17341 \begin_layout Plain Layout
17348 \begin_inset Flex Code
17351 \begin_layout Plain Layout
17358 \begin_inset space \thinspace{}
17362 \begin_inset Flex Code
17365 \begin_layout Plain Layout
17373 ] Whether newlines are translated into \SpecialChar LaTeX
17375 \begin_inset Flex Code
17378 \begin_layout Plain Layout
17389 The translation can be switched off to allow more comfortable \SpecialChar LaTeX
17390 editing inside \SpecialChar LyX
17394 \begin_layout Description
17395 \begin_inset Flex Code
17398 \begin_layout Plain Layout
17405 \begin_inset Flex Code
17408 \begin_layout Plain Layout
17417 \begin_inset space \thinspace{}
17421 \begin_inset Flex Code
17424 \begin_layout Plain Layout
17432 \begin_inset Flex Code
17435 \begin_layout Plain Layout
17442 \begin_inset Flex Code
17445 \begin_layout Plain Layout
17451 ) paragraphs are being indented,
17452 then the indentation of such a paragraph following one of this type will be suppressed.
17453 (So this will not affect the display of non-default paragraphs.)
17456 \begin_layout Description
17457 \begin_inset Flex Code
17460 \begin_layout Plain Layout
17467 \begin_inset Flex Code
17470 \begin_layout Plain Layout
17476 ] Name of a style that has replaced this style.
17477 This is used to rename a style,
17478 while keeping backward compatibility.
17481 \begin_layout Description
17482 \begin_inset Flex Code
17485 \begin_layout Plain Layout
17492 \begin_inset Flex Code
17495 \begin_layout Plain Layout
17502 \begin_inset space \thinspace{}
17506 \begin_inset Flex Code
17509 \begin_layout Plain Layout
17515 ] Determines whether consecutive paragraphs of the same type are treated as belonging together.
17516 This has the effect that the
17517 \begin_inset Flex Code
17520 \begin_layout Plain Layout
17526 is only printed once before such a group.
17529 \begin_inset Flex Code
17532 \begin_layout Plain Layout
17539 \begin_inset Flex Code
17542 \begin_layout Plain Layout
17549 \begin_inset Flex Code
17552 \begin_layout Plain Layout
17558 and false for all other types.
17561 \begin_layout Description
17562 \begin_inset Flex Code
17565 \begin_layout Plain Layout
17572 \begin_inset Flex Code
17575 \begin_layout Plain Layout
17584 \begin_inset space \thinspace{}
17588 \begin_inset Flex Code
17591 \begin_layout Plain Layout
17597 ] Indicates that paragraphs will not be separated by an empty line in \SpecialChar LaTeX
17599 but only by a line break;
17601 \begin_inset Flex Code
17604 \begin_layout Plain Layout
17611 this allows to emulate a plain text editor (like the ERT inset).
17614 \begin_layout Description
17615 \begin_inset Flex Code
17618 \begin_layout Plain Layout
17625 \begin_inset Flex Code
17628 \begin_layout Plain Layout
17634 ] The indent of the very first line of a paragraph.
17636 \begin_inset Newline newline
17640 \begin_inset Flex Code
17643 \begin_layout Plain Layout
17649 will be fixed for a certain style.
17650 The exception is the default style,
17651 since the indentation for these paragraphs can be prohibited with
17652 \begin_inset Flex Code
17655 \begin_layout Plain Layout
17664 \begin_inset Flex Code
17667 \begin_layout Plain Layout
17673 style paragraphs inside environments use the
17674 \begin_inset Flex Code
17677 \begin_layout Plain Layout
17683 of the environment,
17684 not their native one.
17687 \begin_inset Flex Code
17690 \begin_layout Plain Layout
17696 paragraphs inside an enumeration are not indented.
17699 \begin_layout Description
17700 \begin_inset Flex Code
17703 \begin_layout Plain Layout
17710 \begin_inset Flex Code
17713 \begin_layout Plain Layout
17719 ] The vertical space between two paragraphs of this style.
17722 \begin_layout Description
17723 \begin_inset Flex Code
17726 \begin_layout Plain Layout
17733 \begin_inset Flex Code
17736 \begin_layout Plain Layout
17743 allows the user to choose either
17744 \begin_inset Quotes eld
17748 \begin_inset Quotes erd
17752 \begin_inset Quotes eld
17756 \begin_inset Quotes erd
17759 to separate paragraphs.
17761 \begin_inset Quotes eld
17765 \begin_inset Quotes erd
17770 \begin_inset Flex Code
17773 \begin_layout Plain Layout
17781 \begin_inset Quotes eld
17785 \begin_inset Quotes erd
17790 \begin_inset Flex Code
17793 \begin_layout Plain Layout
17799 is ignored and all paragraphs are separated by the
17800 \begin_inset Flex Code
17803 \begin_layout Plain Layout
17810 The vertical space is calculated with
17811 \begin_inset Flex Code
17814 \begin_layout Plain Layout
17816 \begin_inset space ~
17825 \begin_inset Flex Code
17828 \begin_layout Plain Layout
17834 is the height of a row with the normal font.
17836 the look stays the same with different screen fonts.
17839 \begin_layout Description
17840 \begin_inset Flex Code
17843 \begin_layout Plain Layout
17850 \begin_inset Flex Code
17853 \begin_layout Plain Layout
17862 \begin_inset space \thinspace{}
17866 \begin_inset Flex Code
17869 \begin_layout Plain Layout
17875 ] Whether the contents of this paragraph should be output in raw form,
17876 meaning without special translations that \SpecialChar LaTeX
17880 \begin_layout Description
17881 \begin_inset Flex Code
17884 \begin_layout Plain Layout
17891 \begin_inset Flex Code
17894 \begin_layout Plain Layout
17904 Defines individual characters that should be output in raw form,
17905 meaning without special translations that \SpecialChar LaTeX
17909 \begin_layout Description
17910 \begin_inset Flex Code
17913 \begin_layout Plain Layout
17919 Information to be included in the \SpecialChar LaTeX
17920 preamble when this style is used.
17921 Used to define macros,
17924 required by this particular style.
17926 \begin_inset Quotes eld
17930 \begin_inset Flex Code
17933 \begin_layout Plain Layout
17940 \begin_inset Quotes erd
17946 \begin_layout Description
17947 \begin_inset Flex Code
17950 \begin_layout Plain Layout
17957 \begin_inset Flex Code
17960 \begin_layout Plain Layout
17966 ] The prefix to use when creating labels referring to paragraphs of this type.
17967 This allows the use of formatted references.
17970 \begin_layout Description
17971 \begin_inset Flex Code
17974 \begin_layout Plain Layout
17981 \begin_inset Flex Code
17984 \begin_layout Plain Layout
17990 ] Whether the style requires the feature
17991 \begin_inset Flex Code
17994 \begin_layout Plain Layout
18001 \begin_inset CommandInset ref
18003 reference "chap:List-of-functions"
18008 for the list of features).
18009 If you require a package with specific options,
18010 you can additionally use
18011 \begin_inset Flex Code
18014 \begin_layout Plain Layout
18020 as a general text class parameter (see
18021 \begin_inset CommandInset ref
18023 reference "subsec:General-text-class"
18031 \begin_layout Description
18032 \begin_inset Flex Code
18035 \begin_layout Plain Layout
18042 \begin_inset Flex Code
18045 \begin_layout Plain Layout
18054 \begin_inset Flex Code
18057 \begin_layout Plain Layout
18063 ] Resets the \SpecialChar LaTeX
18064 arguments of this style (as defined via the
18065 \begin_inset Flex Code
18068 \begin_layout Plain Layout
18075 This is useful if you have copied a style via
18076 \begin_inset Flex Code
18079 \begin_layout Plain Layout
18086 but you do not want to inherit its (required and optional) arguments.
18089 \begin_layout Description
18090 \begin_inset Flex Code
18093 \begin_layout Plain Layout
18100 \begin_inset Flex Code
18103 \begin_layout Plain Layout
18112 \begin_inset Flex Code
18115 \begin_layout Plain Layout
18121 ] Resumes a counter that is usually reset at each new sequence of layouts.
18122 This is currently only useful when
18123 \begin_inset Flex Code
18126 \begin_layout Plain Layout
18133 \begin_inset Flex Code
18136 \begin_layout Plain Layout
18145 \begin_layout Description
18146 \begin_inset Flex Code
18149 \begin_layout Plain Layout
18156 \begin_inset Flex Code
18159 \begin_layout Plain Layout
18165 ] A string that is put at the end of the layout content.
18166 A line break in the output can be indicated by
18167 \begin_inset Flex Code
18170 \begin_layout Plain Layout
18179 \begin_layout Description
18180 \begin_inset Flex Code
18183 \begin_layout Plain Layout
18190 \begin_inset Flex Code
18193 \begin_layout Plain Layout
18200 \begin_inset Flex Code
18203 \begin_layout Plain Layout
18212 \begin_layout Description
18213 \begin_inset Flex Code
18216 \begin_layout Plain Layout
18223 \begin_inset Flex Code
18226 \begin_layout Plain Layout
18236 \begin_inset Flex Code
18239 \begin_layout Plain Layout
18247 \begin_inset Flex Code
18250 \begin_layout Plain Layout
18258 \begin_inset Flex Code
18261 \begin_layout Plain Layout
18263 \begin_inset space ~
18271 ] This defines what the default spacing should be in the style.
18273 \begin_inset Flex Code
18276 \begin_layout Plain Layout
18284 \begin_inset Flex Code
18287 \begin_layout Plain Layout
18294 \begin_inset Flex Code
18297 \begin_layout Plain Layout
18303 correspond respectively to a multiplier value of 1,
18305 If you specify the argument
18306 \begin_inset Flex Code
18309 \begin_layout Plain Layout
18316 then you must also provide a value argument which will be the actual multiplier value.
18318 contrary to other parameters,
18320 \begin_inset Flex Code
18323 \begin_layout Plain Layout
18329 implies the generation of specific \SpecialChar LaTeX
18331 using the \SpecialChar LaTeX
18335 \begin_inset Flex Code
18338 \begin_layout Plain Layout
18347 \begin_layout Description
18348 \begin_inset Flex Code
18351 \begin_layout Plain Layout
18358 \begin_inset Flex Code
18361 \begin_layout Plain Layout
18368 \begin_inset space \thinspace{}
18372 \begin_inset Flex Code
18375 \begin_layout Plain Layout
18383 ] Allow spell-checking paragraphs of this style.
18387 \begin_layout Description
18388 \begin_inset Flex Code
18391 \begin_layout Plain Layout
18393 \change_deleted 731793113 1604355211
18395 \change_inserted 731793113 1604355212
18404 \begin_inset Flex Code
18407 \begin_layout Plain Layout
18416 \begin_inset Flex Code
18419 \begin_layout Plain Layout
18426 \change_deleted 731793113 1604355214
18428 \change_inserted 731793113 1604355216
18431 counter of a given counter at the beginning of a new sequence of layouts.
18432 This is currently only useful when
18433 \begin_inset Flex Code
18436 \begin_layout Plain Layout
18443 \begin_inset Flex Code
18446 \begin_layout Plain Layout
18455 \begin_layout Description
18456 \begin_inset Flex Code
18459 \begin_layout Plain Layout
18465 The font used for the text body .
18467 \begin_inset CommandInset ref
18469 reference "subsec:Font-description"
18477 \begin_layout Description
18478 \begin_inset Flex Code
18481 \begin_layout Plain Layout
18490 \begin_inset Flex Code
18493 \begin_layout Plain Layout
18503 The level of the style in the table of contents.
18504 This is used for automatic numbering of section headings.
18507 \begin_layout Description
18508 \begin_inset Flex Code
18511 \begin_layout Plain Layout
18520 \begin_inset Flex Code
18523 \begin_layout Plain Layout
18535 \begin_inset Flex Code
18538 \begin_layout Plain Layout
18546 \begin_inset Flex Code
18549 \begin_layout Plain Layout
18555 ] This tag determines whether the first line indentation of this paragraph can be toggled via the Paragraph settings dialog.
18559 \begin_inset Flex Code
18562 \begin_layout Plain Layout
18573 indentation can be toggled if the document settings use
18574 \begin_inset Quotes eld
18578 \begin_inset Quotes erd
18583 \begin_inset Flex Code
18586 \begin_layout Plain Layout
18593 indentation can always be toggled,
18594 notwithstanding the document settings,
18596 \begin_inset Flex Code
18599 \begin_layout Plain Layout
18606 indentation can never be toggled.
18609 \begin_layout Description
18610 \begin_inset Flex Code
18613 \begin_layout Plain Layout
18620 \begin_inset Flex Code
18623 \begin_layout Plain Layout
18629 ] The vertical space with which the very first of a chain of paragraphs with this style is separated from the previous paragraph.
18630 If the previous paragraph has another style,
18631 the separations are not simply added,
18632 but the maximum is taken.
18635 \begin_layout Subsection
18636 \begin_inset CommandInset label
18642 Internationalization of Paragraph Styles
18645 \begin_layout Standard
18647 has long supported internationalization of layout information,
18650 this applied only to the user interface and not to,
18654 French authors were forced to resort to ugly hacks if they wanted `
18658 1' instead of `Theorem 1'.
18659 Thanks to Georg Baum,
18660 that is no longer the case.
18663 \begin_layout Standard
18665 \begin_inset Flex Code
18668 \begin_layout Plain Layout
18674 defines text that is to appear in the typeset document,
18676 \begin_inset Flex Code
18679 \begin_layout Plain Layout
18686 \begin_inset Flex Code
18689 \begin_layout Plain Layout
18695 to support non-English and even multi-language documents correctly.
18696 The following excerpt (from the
18697 \begin_inset Flex Code
18700 \begin_layout Plain Layout
18706 file) shows how this works:
18709 \begin_layout LyX-Code
18714 \begin_layout LyX-Code
18717 theoremstyle{remark}
18720 \begin_layout LyX-Code
18723 newtheorem{claim}[thm]{
18730 \begin_layout LyX-Code
18734 \begin_layout LyX-Code
18738 \begin_layout LyX-Code
18743 claimname}{_(Claim)}
18746 \begin_layout LyX-Code
18750 \begin_layout LyX-Code
18754 \begin_layout LyX-Code
18763 claimname}{_(Claim)}}
18766 \begin_layout LyX-Code
18771 \begin_layout Standard
18773 any legal \SpecialChar LaTeX
18775 \begin_inset Flex Code
18778 \begin_layout Plain Layout
18785 \begin_inset Flex Code
18788 \begin_layout Plain Layout
18795 but in practice they will typically look as they do here.
18796 The key to correct translation of the typeset text is the definition of the \SpecialChar LaTeX
18798 \begin_inset Flex Code
18801 \begin_layout Plain Layout
18810 \begin_inset Flex Code
18813 \begin_layout Plain Layout
18825 \begin_layout Standard
18827 \begin_inset Flex Code
18830 \begin_layout Plain Layout
18836 tag provides for internationalization based upon the overall language of the document.
18837 The contents of the tag will be included in the preamble,
18839 \begin_inset Flex Code
18842 \begin_layout Plain Layout
18849 What makes it special is the use of the
18850 \begin_inset Quotes eld
18854 \begin_inset Quotes erd
18858 \begin_inset Flex Code
18861 \begin_layout Plain Layout
18868 which will be replaced,
18869 when \SpecialChar LyX
18870 produces \SpecialChar LaTeX
18872 with the translation of its argument into the document language.
18875 \begin_layout Standard
18877 \begin_inset Flex Code
18880 \begin_layout Plain Layout
18886 tag is more complex,
18887 since it is meant to provide support for multi-language documents and so offers an interface to the
18888 \begin_inset Flex Code
18891 \begin_layout Plain Layout
18898 Its contents will be added to the preamble once for each language that appears in the document.
18901 \begin_inset Flex Code
18904 \begin_layout Plain Layout
18910 will be replaced with its translation into the language in question;
18912 \begin_inset Flex Code
18915 \begin_layout Plain Layout
18921 is replaced by the language name (as used by the babel package).
18924 \begin_layout Standard
18925 A German document that also included a French section would thus have the following in the preamble:
18928 \begin_layout LyX-Code
18937 claimname}{Affirmation}}
18938 \begin_inset Newline newline
18949 claimname}{Behauptung}}
18950 \begin_inset Newline newline
18957 claimname}{Behauptung}
18960 \begin_layout Standard
18963 \begin_inset Flex Code
18966 \begin_layout Plain Layout
18972 will then conspire to produce the correct text in the output.
18975 \begin_layout Standard
18976 One important point to note here is that the translations are provided by \SpecialChar LyX
18979 \begin_inset Flex Code
18982 \begin_layout Plain Layout
18992 \begin_inset Flex Code
18995 \begin_layout Plain Layout
19002 \begin_inset Flex Code
19005 \begin_layout Plain Layout
19011 are really only of use in layout files that are provided with \SpecialChar LyX
19013 since text entered in user-created layout files will not be seen by \SpecialChar LyX
19014 's internationalization routines unless the
19015 \begin_inset Flex Code
19018 \begin_layout Plain Layout
19024 file is modified accordingly.
19027 any layout created with the intention that it will be included with \SpecialChar LyX
19028 should use these tags where appropriate.
19029 Please note that the paragraph style translations provided by \SpecialChar LyX
19030 will never change with a minor update (e.
19031 \begin_inset space \thinspace{}
19035 \begin_inset space \space{}
19038 from version 2.1.x to 2.1.y).
19039 It is however quite likely that a major update (e.
19040 \begin_inset space \thinspace{}
19044 \begin_inset space \space{}
19047 from 2.0.x to 2.1.0) will introduce new translations or corrections.
19050 \begin_layout Subsection
19052 \begin_inset CommandInset label
19054 name "subsec:Floats"
19061 \begin_layout Standard
19062 It is necessary to define the floats (
19063 \begin_inset Flex Noun
19066 \begin_layout Plain Layout
19074 \begin_inset Flex Noun
19077 \begin_layout Plain Layout
19085 ) in the text class itself.
19086 Standard floats are included in the file
19087 \begin_inset Flex Code
19090 \begin_layout Plain Layout
19097 so you may have to do no more than add
19100 \begin_layout LyX-Code
19101 Input stdfloats.inc
19104 \begin_layout Standard
19105 to your layout file.
19106 If you want to implement a text class that proposes some other float types (like the AGU class bundled with \SpecialChar LyX
19108 the information below will hopefully help you:
19111 \begin_layout Description
19112 \begin_inset Flex Code
19115 \begin_layout Plain Layout
19122 \begin_inset Flex Code
19125 \begin_layout Plain Layout
19131 =!htbpH] Allowed placement options for this float type.
19132 The value is a string of placement characters.
19133 Possible characters include:
19139 \begin_inset Quotes eld
19143 \begin_inset Quotes erd
19152 \begin_inset Quotes eld
19156 \begin_inset Quotes erd
19165 \begin_inset Quotes eld
19169 \begin_inset Quotes erd
19178 \begin_inset Quotes eld
19182 \begin_inset Quotes erd
19191 \begin_inset Quotes eld
19195 \begin_inset Quotes erd
19204 \begin_inset Quotes eld
19208 \begin_inset Quotes erd
19212 The order of the characters in the string does not matter.
19213 If no placement options are allowed,
19221 \begin_layout Description
19222 \begin_inset Flex Code
19225 \begin_layout Plain Layout
19232 \begin_inset Flex Code
19235 \begin_layout Plain Layout
19244 \begin_inset space \thinspace{}
19250 \begin_inset Flex Code
19253 \begin_layout Plain Layout
19263 ] Defines whether the float allows to be rotated via the \SpecialChar LaTeX
19270 \begin_inset Flex Code
19273 \begin_layout Plain Layout
19279 if the float does not support this feature.
19282 \begin_layout Description
19283 \begin_inset Flex Code
19286 \begin_layout Plain Layout
19293 \begin_inset Flex Code
19296 \begin_layout Plain Layout
19305 \begin_inset space \thinspace{}
19311 \begin_inset Flex Code
19314 \begin_layout Plain Layout
19324 ] Defines whether the float has a starred variant that spans columns in a two column paragraph.
19326 \begin_inset Flex Code
19329 \begin_layout Plain Layout
19335 if the float does not support this feature.
19338 \begin_layout Description
19339 \begin_inset Flex Code
19342 \begin_layout Plain Layout
19349 \begin_inset Flex Code
19352 \begin_layout Plain Layout
19359 \begin_inset Quotes erd
19363 \begin_inset Quotes erd
19366 ] The file name extension of an auxiliary file for the list of figures (or whatever).
19368 writes the captions to this file.
19371 \begin_layout Description
19372 \begin_inset Flex Code
19375 \begin_layout Plain Layout
19382 \begin_inset Flex Code
19385 \begin_layout Plain Layout
19392 \begin_inset Quotes erd
19396 \begin_inset Quotes erd
19399 ] The string that will be used in the menus and also for the caption.
19400 This is translated to the current language if babel is used.
19403 \begin_layout Description
19404 \begin_inset Flex Code
19407 \begin_layout Plain Layout
19413 These tags control the XHTML output.
19415 \begin_inset CommandInset ref
19417 reference "sec:Tags-for-XHTML"
19425 \begin_layout Description
19426 \begin_inset Flex Code
19429 \begin_layout Plain Layout
19438 \begin_inset Flex Code
19441 \begin_layout Plain Layout
19450 \begin_inset space \thinspace{}
19454 \begin_inset Flex Code
19457 \begin_layout Plain Layout
19463 ] Indicates whether the float is already defined in the document class or if instead the \SpecialChar LaTeX
19465 \begin_inset Flex Code
19468 \begin_layout Plain Layout
19474 needs to be loaded to define it on-the-fly.
19476 \begin_inset Flex Code
19479 \begin_layout Plain Layout
19488 \begin_inset Flex Code
19491 \begin_layout Plain Layout
19498 It should be set to
19499 \begin_inset Flex Code
19502 \begin_layout Plain Layout
19508 if the float is already defined by the \SpecialChar LaTeX
19512 \begin_layout Description
19513 \begin_inset Flex Code
19516 \begin_layout Plain Layout
19523 \begin_inset Flex Code
19526 \begin_layout Plain Layout
19533 \begin_inset Quotes erd
19537 \begin_inset Quotes erd
19540 ] The command used to generate a list of floats of this type;
19549 \begin_inset Flex Code
19552 \begin_layout Plain Layout
19559 since there is no standard way to generate this command.
19561 \begin_inset Flex Code
19564 \begin_layout Plain Layout
19571 since in that case there is a standard way to define the command.
19574 \begin_layout Description
19575 \begin_inset Flex Code
19578 \begin_layout Plain Layout
19585 \begin_inset Flex Code
19588 \begin_layout Plain Layout
19595 \begin_inset Quotes erd
19599 \begin_inset Quotes erd
19602 ] A title for a list of floats of this kind (list of figures,
19605 It is used for the screen label within \SpecialChar LyX
19607 it is used by \SpecialChar LaTeX
19608 for the title and it is used as the title in the XHTML output.
19609 It will be translated to the document language.
19612 \begin_layout Description
19613 \begin_inset Flex Code
19616 \begin_layout Plain Layout
19623 \begin_inset Flex Code
19626 \begin_layout Plain Layout
19633 \begin_inset Quotes erd
19637 \begin_inset Quotes erd
19640 ] This (optional) argument determines whether floats of this class will be numbered within some sectional unit of the document.
19643 \begin_inset Flex Code
19646 \begin_layout Plain Layout
19653 \begin_inset Quotes eld
19657 \begin_inset Flex Code
19660 \begin_layout Plain Layout
19667 \begin_inset Quotes erd
19671 the floats will be numbered within chapters.
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 ] The default placement for the given class of floats.
19704 The string should be as in standard \SpecialChar LaTeX
19707 \begin_inset Flex Code
19710 \begin_layout Plain Layout
19718 \begin_inset Flex Code
19721 \begin_layout Plain Layout
19729 \begin_inset Flex Code
19732 \begin_layout Plain Layout
19739 \begin_inset Flex Code
19742 \begin_layout Plain Layout
19756 \begin_layout Plain Layout
19757 Note that the order of these letters in the string is irrelevant,
19758 like in \SpecialChar LaTeX
19764 On top of that there is a new type,
19766 \begin_inset Flex Code
19769 \begin_layout Plain Layout
19776 which does not really correspond to a float,
19779 \begin_inset Quotes eld
19783 \begin_inset Quotes erd
19787 Note however that the
19788 \begin_inset Flex Code
19791 \begin_layout Plain Layout
19797 specifier is special and,
19798 because of implementation details,
19799 cannot be used in non-built in float types.
19800 If you do not understand what this means,
19802 \begin_inset Quotes eld
19806 \begin_inset Flex Code
19809 \begin_layout Plain Layout
19816 \begin_inset Quotes erd
19822 \begin_layout Description
19823 \begin_inset Flex Code
19826 \begin_layout Plain Layout
19833 \begin_inset Flex Code
19836 \begin_layout Plain Layout
19842 ] The prefix to use when creating labels referring to floats of this type.
19843 This allows the use of formatted references.
19844 Note that you can remove any
19845 \begin_inset Flex Code
19848 \begin_layout Plain Layout
19854 set by a copied style by using the special value
19855 \begin_inset Quotes eld
19859 \begin_inset Quotes erd
19863 which must be all caps.
19864 \change_inserted -712698321 1565605014
19868 \begin_layout Description
19870 \change_inserted -712698321 1565605014
19871 \begin_inset Flex Code
19874 \begin_layout Plain Layout
19876 \change_inserted -712698321 1565605014
19885 \begin_inset Flex Code
19888 \begin_layout Plain Layout
19890 \change_inserted -712698321 1565605014
19898 ] As with paragraph styles,
19900 \begin_inset CommandInset ref
19902 reference "subsec:Paragraph-Styles"
19912 \begin_layout Description
19913 \begin_inset Flex Code
19916 \begin_layout Plain Layout
19923 \begin_inset Flex Code
19926 \begin_layout Plain Layout
19933 \begin_inset Quotes erd
19937 \begin_inset Quotes erd
19940 ] The style used when defining the float using
19941 \begin_inset Flex Code
19944 \begin_layout Plain Layout
19955 \begin_layout Description
19956 \begin_inset Flex Code
19959 \begin_layout Plain Layout
19966 \begin_inset Flex Code
19969 \begin_layout Plain Layout
19976 \begin_inset Quotes erd
19980 \begin_inset Quotes erd
19984 \begin_inset Quotes eld
19988 \begin_inset Quotes erd
19991 of the new class of floats,
19992 like program or algorithm.
19993 After the appropriate
19994 \begin_inset Flex Code
19997 \begin_layout Plain Layout
20007 \begin_inset Flex Code
20010 \begin_layout Plain Layout
20019 \begin_inset Flex Code
20022 \begin_layout Plain Layout
20033 \begin_layout Description
20034 \begin_inset Flex Code
20037 \begin_layout Plain Layout
20044 \begin_inset Flex Code
20047 \begin_layout Plain Layout
20054 \begin_inset space \thinspace{}
20058 \begin_inset Flex Code
20061 \begin_layout Plain Layout
20069 ] Specifies whether this float is defined using the \SpecialChar LaTeX
20071 \begin_inset Flex Code
20074 \begin_layout Plain Layout
20081 either by the class file,
20082 another package or on-the-fly by \SpecialChar LyX
20086 \begin_layout Standard
20087 Note that defining a float with type
20088 \begin_inset Flex Code
20091 \begin_layout Plain Layout
20099 automatically defines the corresponding counter with name
20100 \begin_inset Flex Code
20103 \begin_layout Plain Layout
20114 \begin_layout Subsection
20115 Flex insets and InsetLayout
20116 \begin_inset CommandInset label
20118 name "subsec:Flex-insets-and"
20125 \begin_layout Standard
20126 Flex insets come in
20127 \change_deleted 5863208 1594239511
20129 \change_inserted 5863208 1594239512
20136 \begin_layout Itemize
20138 \begin_inset Flex Code
20141 \begin_layout Plain Layout
20148 These define semantic markup corresponding to such \SpecialChar LaTeX
20150 \begin_inset Flex Code
20153 \begin_layout Plain Layout
20162 \begin_inset Flex Code
20165 \begin_layout Plain Layout
20176 \begin_layout Itemize
20178 \begin_inset Flex Code
20181 \begin_layout Plain Layout
20188 These can be used to define custom collapsible insets,
20189 similar to \SpecialChar TeX
20193 An obvious example is an endnote inset,
20194 which is defined in the
20195 \begin_inset Flex Code
20198 \begin_layout Plain Layout
20207 \begin_layout Itemize
20209 \change_deleted 5863208 1594239528
20211 \begin_inset Flex Code
20214 \begin_layout Plain Layout
20221 For use with DocBook classes.
20226 \begin_layout Standard
20227 Flex insets are defined using the
20228 \begin_inset Flex Code
20231 \begin_layout Plain Layout
20238 which shall be explained in a moment.
20241 \begin_layout Standard
20243 \begin_inset Flex Code
20246 \begin_layout Plain Layout
20252 tag also serves another function:
20253 It can be used to customize the general layout of many different types of insets.
20256 \begin_inset Flex Code
20259 \begin_layout Plain Layout
20265 can be used to customize the layout parameters for footnotes,
20278 as well as to define Flex insets.
20281 \begin_layout Standard
20283 \begin_inset Flex Code
20286 \begin_layout Plain Layout
20292 definition must begin with a line of the form:
20295 \begin_layout LyX-Code
20299 \begin_layout Standard
20301 \begin_inset Flex Code
20304 \begin_layout Plain Layout
20310 indicates the inset whose layout is being defined,
20311 and here there are four cases.
20314 \begin_layout Enumerate
20315 The layout for a pre-existing inset is being modified.
20318 \begin_inset Flex Code
20321 \begin_layout Plain Layout
20327 any one of the following:
20329 \begin_inset Flex Code
20332 \begin_layout Plain Layout
20340 \begin_inset Flex Code
20343 \begin_layout Plain Layout
20351 \begin_inset Flex Code
20354 \begin_layout Plain Layout
20362 \begin_inset Flex Code
20365 \begin_layout Plain Layout
20373 \begin_inset Flex Code
20376 \begin_layout Plain Layout
20384 \begin_inset Flex Code
20387 \begin_layout Plain Layout
20395 \begin_inset Flex Code
20398 \begin_layout Plain Layout
20406 \begin_inset Flex Code
20409 \begin_layout Plain Layout
20417 \begin_inset Flex Code
20420 \begin_layout Plain Layout
20428 \begin_inset Flex Code
20431 \begin_layout Plain Layout
20439 \begin_inset Flex Code
20442 \begin_layout Plain Layout
20450 \begin_inset Flex Code
20453 \begin_layout Plain Layout
20461 \begin_inset Flex Code
20464 \begin_layout Plain Layout
20472 \begin_inset Flex Code
20475 \begin_layout Plain Layout
20483 \begin_inset Flex Code
20486 \begin_layout Plain Layout
20494 \begin_inset Flex Code
20497 \begin_layout Plain Layout
20505 \begin_inset Flex Code
20508 \begin_layout Plain Layout
20516 \begin_inset Flex Code
20519 \begin_layout Plain Layout
20527 \begin_inset Flex Code
20530 \begin_layout Plain Layout
20538 \begin_inset Flex Code
20541 \begin_layout Plain Layout
20550 \begin_layout Enumerate
20551 The layout for a Flex inset is being defined.
20554 \begin_inset Flex Code
20557 \begin_layout Plain Layout
20563 must be of the form
20564 \begin_inset Quotes eld
20568 \begin_inset Flex Code
20571 \begin_layout Plain Layout
20578 \begin_inset Quotes erd
20583 \begin_inset Flex Code
20586 \begin_layout Plain Layout
20592 may be any valid identifier not used by a pre-existing Flex inset.
20593 The identifier may include spaces,
20594 but in that case the whole thing must be wrapped in quotes.
20595 Note that the definition of a flex inset
20600 \begin_inset Flex Code
20603 \begin_layout Plain Layout
20610 declaring which type of inset it defines.
20613 \begin_layout Enumerate
20614 The layout for user specific branch is being defined.
20617 \begin_inset Flex Code
20620 \begin_layout Plain Layout
20626 must be of the form
20627 \begin_inset Quotes eld
20631 \begin_inset Flex Code
20634 \begin_layout Plain Layout
20641 \begin_inset Quotes erd
20646 \begin_inset Flex Code
20649 \begin_layout Plain Layout
20655 may be any valid identifier of branch defined in user's document.
20656 The identifier may include spaces,
20657 but in that case the whole thing must be wrapped in quotes.
20658 The main purpose of this feature is to allow \SpecialChar LaTeX
20659 wrapping around specific branches as user needs.
20662 \begin_layout Enumerate
20663 The layout of a user (or class) specific caption is being defined.
20666 \begin_inset Flex Code
20669 \begin_layout Plain Layout
20675 must be of the form
20676 \begin_inset Quotes eld
20680 \begin_inset Flex Code
20683 \begin_layout Plain Layout
20690 \begin_inset Quotes erd
20695 \begin_inset Flex Code
20698 \begin_layout Plain Layout
20704 specifies the name of the caption as it appears in the menu.
20705 Have a look at the standard caption (
20706 \begin_inset Flex Code
20709 \begin_layout Plain Layout
20716 the specific captions of the KOMA-Script classes (
20717 \begin_inset Flex Code
20720 \begin_layout Plain Layout
20728 \begin_inset Flex Code
20731 \begin_layout Plain Layout
20740 \begin_inset space ~
20744 \begin_inset Newline linebreak
20750 \begin_inset Flex Code
20753 \begin_layout Plain Layout
20759 ) for applications.
20762 \begin_layout Standard
20764 \begin_inset Flex Code
20767 \begin_layout Plain Layout
20773 definition can contain the following entries:
20776 \begin_layout Description
20777 \begin_inset Flex Code
20780 \begin_layout Plain Layout
20787 \begin_inset Flex Code
20790 \begin_layout Plain Layout
20796 =""] This inset will appear in the table of contents of the given type.
20797 An empty string disables.
20798 See also the OutlinerName and the IsTocCaption commands.
20799 This is only implemented for Flex insets.
20804 \begin_layout Description
20805 \begin_inset Flex Code
20808 \begin_layout Plain Layout
20815 \begin_inset Flex Code
20818 \begin_layout Plain Layout
20824 ] Defines argument number of a command\SpecialChar breakableslash
20825 environment associated with the current layout.
20826 The definition must end with
20827 \begin_inset Flex Code
20830 \begin_layout Plain Layout
20838 \change_inserted -584632292 1615846847
20840 \begin_inset CommandInset ref
20842 reference "subsec:Arguments"
20851 \change_deleted -584632292 1615846847
20853 \begin_inset CommandInset ref
20855 reference "subsec:Paragraph-Styles"
20863 \change_deleted -584632292 1615846902
20865 \change_inserted -584632292 1615846906
20871 \begin_layout Description
20872 \begin_inset Flex Code
20875 \begin_layout Plain Layout
20881 Preamble for changing language commands;
20883 \begin_inset CommandInset ref
20885 reference "subsec:I18n"
20893 \begin_layout Description
20894 \begin_inset Flex Code
20897 \begin_layout Plain Layout
20904 \begin_inset Flex Code
20907 \begin_layout Plain Layout
20913 ] The color for the inset's background.
20915 \begin_inset CommandInset ref
20917 reference "chap:Names-of-colors"
20922 for a list of the available color names.
20925 \begin_layout Description
20926 \begin_inset Flex Code
20929 \begin_layout Plain Layout
20936 \begin_inset Flex Code
20939 \begin_layout Plain Layout
20948 \begin_inset space \thinspace{}
20952 \begin_inset Flex Code
20955 \begin_layout Plain Layout
20961 ] Whether to use the content of the inset as the label,
20962 when the inset is closed.
20966 \begin_layout Description
20967 \begin_inset Flex Code
20970 \begin_layout Plain Layout
20977 \begin_inset Flex Code
20980 \begin_layout Plain Layout
20986 ] As with paragraph styles,
20988 \begin_inset CommandInset ref
20990 reference "subsec:Paragraph-Styles"
20996 Note that you need to specify the complete type,
20998 \begin_inset space \thinspace{}
21002 \begin_inset space ~
21006 \begin_inset Flex Code
21009 \begin_layout Plain Layout
21010 CopyStyle Flex:<name>
21018 \begin_layout Description
21019 \begin_inset Flex Code
21022 \begin_layout Plain Layout
21029 \begin_inset Flex Code
21032 \begin_layout Plain Layout
21041 \begin_inset space \thinspace{}
21045 \begin_inset Flex Code
21048 \begin_layout Plain Layout
21054 ] Indicates whether the user may employ the Paragraph Settings dialog to customize the paragraph.
21057 \begin_layout Description
21058 \begin_inset Flex Code
21061 \begin_layout Plain Layout
21068 \begin_inset Flex Code
21071 \begin_layout Plain Layout
21079 \begin_inset Flex Code
21082 \begin_layout Plain Layout
21090 \begin_inset Flex Code
21093 \begin_layout Plain Layout
21100 describing the rendering style used for the inset's frame and buttons.
21101 Footnotes generally use
21102 \begin_inset Flex Code
21105 \begin_layout Plain Layout
21112 ERT insets generally
21113 \begin_inset Flex Code
21116 \begin_layout Plain Layout
21123 and character styles
21124 \begin_inset Flex Code
21127 \begin_layout Plain Layout
21136 \begin_layout Description
21137 \begin_inset Flex Code
21140 \begin_layout Plain Layout
21147 \begin_inset Flex Code
21150 \begin_layout Plain Layout
21159 \begin_inset space \thinspace{}
21165 \begin_inset Flex Code
21168 \begin_layout Plain Layout
21177 \begin_inset Flex Code
21180 \begin_layout Plain Layout
21187 \begin_inset Flex Code
21190 \begin_layout Plain Layout
21197 Indicates whether the environment will stand on its own in the output or will appear inline with the surrounding text.
21199 it is supposed that the \SpecialChar LaTeX
21200 environment ignores white space (including one newline character) after the
21201 \begin_inset Flex Code
21204 \begin_layout Plain Layout
21217 \begin_inset Flex Code
21220 \begin_layout Plain Layout
21234 \change_inserted 731793113 1538674858
21238 \begin_layout Description
21240 \change_inserted 731793113 1538674891
21241 \begin_inset Flex Code
21244 \begin_layout Plain Layout
21246 \change_inserted 731793113 1538674863
21258 ,1] Allow the contents of the inset to be edited externally (using whatever editor is defined for the document's output format).
21263 \begin_layout Description
21264 \begin_inset Flex Code
21267 \begin_layout Plain Layout
21273 Required at the end of the
21274 \begin_inset Flex Code
21277 \begin_layout Plain Layout
21286 \begin_layout Description
21287 \begin_inset Flex Code
21290 \begin_layout Plain Layout
21296 The font used for both the text body
21302 \begin_inset CommandInset ref
21304 reference "subsec:Font-description"
21310 Note that defining this font automatically defines the
21311 \begin_inset Flex Code
21314 \begin_layout Plain Layout
21321 so define this first and define
21322 \begin_inset Flex Code
21325 \begin_layout Plain Layout
21331 later if you want them to be different.
21334 \begin_layout Description
21335 \begin_inset Flex Code
21338 \begin_layout Plain Layout
21339 FixedWidthPreambleEncoding
21345 \begin_inset Flex Code
21348 \begin_layout Plain Layout
21357 \begin_inset space \thinspace{}
21361 \begin_inset Flex Code
21364 \begin_layout Plain Layout
21370 ] Force a fixed width encoding for the translated contents of
21371 \begin_inset Flex Code
21374 \begin_layout Plain Layout
21381 \begin_inset Flex Code
21384 \begin_layout Plain Layout
21390 code generated by this layout.
21391 This is needed for special \SpecialChar LaTeX
21396 that do not work with variable width encodings such as
21401 This setting is ignored if fully Unicode aware \SpecialChar LaTeX
21402 backends such as Xe\SpecialChar TeX
21403 or Lua\SpecialChar TeX
21407 \begin_layout Description
21408 \begin_inset Flex Code
21411 \begin_layout Plain Layout
21412 ForceLocalFontSwitch
21418 \begin_inset Flex Code
21421 \begin_layout Plain Layout
21430 \begin_inset space \thinspace{}
21434 \begin_inset Flex Code
21437 \begin_layout Plain Layout
21443 ] When using babel,
21444 always use a local font switch (
21445 \begin_inset Flex Code
21448 \begin_layout Plain Layout
21457 never a global one (such as
21458 \begin_inset Flex Code
21461 \begin_layout Plain Layout
21472 \begin_layout Description
21473 \begin_inset Flex Code
21476 \begin_layout Plain Layout
21483 \begin_inset Flex Code
21486 \begin_layout Plain Layout
21495 \begin_inset space \thinspace{}
21499 \begin_inset Flex Code
21502 \begin_layout Plain Layout
21509 \begin_inset Quotes eld
21513 \begin_inset Quotes erd
21517 leading to Left-to-Right (Latin) output,
21519 \begin_inset space \thinspace{}
21523 \begin_inset space \space{}
21526 in \SpecialChar TeX
21531 \begin_layout Description
21532 \begin_inset Flex Code
21535 \begin_layout Plain Layout
21542 \begin_inset Flex Code
21545 \begin_layout Plain Layout
21554 \begin_inset space \thinspace{}
21558 \begin_inset Flex Code
21561 \begin_layout Plain Layout
21567 ] Force a line break in the \SpecialChar LaTeX
21568 output before the inset starts and after the inset ends.
21569 This assures the inset itself is output on its own lines,
21570 for parsing purposes.
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
21609 ] Indicates whether the
21610 \begin_inset Flex Code
21613 \begin_layout Plain Layout
21621 the user can change the paragraph style used in the inset.
21625 \begin_layout Description
21626 \begin_inset Flex Code
21629 \begin_layout Plain Layout
21636 \begin_inset Flex Code
21639 \begin_layout Plain Layout
21648 \begin_inset space \thinspace{}
21652 \begin_inset Flex Code
21655 \begin_layout Plain Layout
21661 ] As with paragraph styles,
21663 \begin_inset CommandInset ref
21665 reference "subsec:Paragraph-Styles"
21673 \begin_layout Description
21674 \begin_inset Flex Code
21677 \begin_layout Plain Layout
21683 These tags control the XHTML output.
21685 \begin_inset CommandInset ref
21687 reference "sec:Tags-for-XHTML"
21695 \begin_layout Description
21696 \begin_inset Flex Code
21699 \begin_layout Plain Layout
21706 \begin_inset Flex Code
21709 \begin_layout Plain Layout
21718 \begin_inset space \thinspace{}
21722 \begin_inset Flex Code
21725 \begin_layout Plain Layout
21731 ] Whether to include the contents of this inset in the strings generated for the `Outline' pane for all table of contents,
21732 regardless of the AddToToc setting.
21735 want the content of a footnote in a section header to be included in the TOC displayed in the outline,
21736 but one would normally want the content of a character style displayed.
21741 \begin_layout Description
21742 \begin_inset Flex Code
21745 \begin_layout Plain Layout
21752 \begin_inset Flex Code
21755 \begin_layout Plain Layout
21764 \begin_inset space \thinspace{}
21768 \begin_inset Flex Code
21771 \begin_layout Plain Layout
21777 ] If this is set to 1 and AddToToc is enabled,
21778 the inset adds a summary of its contents in its item in the table of contents.
21780 only the label appears.
21783 \begin_layout Description
21784 \begin_inset Flex Code
21787 \begin_layout Plain Layout
21796 \begin_inset Flex Code
21799 \begin_layout Plain Layout
21808 \begin_inset space \thinspace{}
21812 \begin_inset Flex Code
21815 \begin_layout Plain Layout
21821 ] As with paragraph styles,
21823 \begin_inset CommandInset ref
21825 reference "subsec:Paragraph-Styles"
21833 \begin_layout Description
21834 \begin_inset Flex Code
21837 \begin_layout Plain Layout
21843 The font used for the label.
21845 \begin_inset CommandInset ref
21847 reference "subsec:Font-description"
21853 Note that this definition can never appear before
21854 \begin_inset Flex Code
21857 \begin_layout Plain Layout
21864 lest it be ineffective.
21867 \begin_layout Description
21868 \begin_inset Flex Code
21871 \begin_layout Plain Layout
21878 \begin_inset Flex Code
21881 \begin_layout Plain Layout
21888 \begin_inset Quotes erd
21892 \begin_inset Quotes erd
21895 ] What will be displayed on the button or elsewhere as the inset label.
21897 \begin_inset Flex Code
21900 \begin_layout Plain Layout
21908 \begin_inset Flex Code
21911 \begin_layout Plain Layout
21917 ) modify this label on the fly.
21920 \begin_layout Description
21921 \begin_inset Flex Code
21924 \begin_layout Plain Layout
21930 Language dependent preamble;
21932 \begin_inset CommandInset ref
21934 reference "subsec:I18n"
21942 \begin_layout Description
21943 \begin_inset Flex Code
21946 \begin_layout Plain Layout
21953 \begin_inset Flex Code
21956 \begin_layout Plain Layout
21962 ] The name of the corresponding \SpecialChar LaTeX
21964 Either the environment or command name.
21967 \begin_layout Description
21968 \begin_inset Flex Code
21971 \begin_layout Plain Layout
21978 \begin_inset Flex Code
21981 \begin_layout Plain Layout
21987 ] The optional parameter for the corresponding
21988 \begin_inset Flex Code
21991 \begin_layout Plain Layout
21998 including possible bracket pairs like
21999 \begin_inset Flex Code
22002 \begin_layout Plain Layout
22009 This parameter cannot be changed from within \SpecialChar LyX
22011 \begin_inset Flex Code
22014 \begin_layout Plain Layout
22020 for customizable parameters).
22021 It will be output as is after all \SpecialChar LaTeX
22023 \begin_inset Flex Code
22026 \begin_layout Plain Layout
22035 \begin_layout Description
22036 \begin_inset Flex Code
22039 \begin_layout Plain Layout
22046 \begin_inset Flex Code
22049 \begin_layout Plain Layout
22057 ] How the style should be translated into \SpecialChar LaTeX
22062 \begin_layout Plain Layout
22063 \begin_inset Flex Code
22066 \begin_layout Plain Layout
22072 is perhaps a bit misleading,
22073 since these rules apply to SGML classes too.
22074 Visit the SGML class files for specific examples.
22083 \begin_layout Description
22084 \begin_inset Flex Code
22087 \begin_layout Plain Layout
22093 means nothing special
22096 \begin_layout Description
22097 \begin_inset Flex Code
22100 \begin_layout Plain Layout
22107 \begin_inset Flex Code
22110 \begin_layout Plain Layout
22117 {\SpecialChar ldots
22126 \begin_layout Description
22127 \begin_inset Flex Code
22130 \begin_layout Plain Layout
22137 \begin_inset Flex Code
22140 \begin_layout Plain Layout
22147 }\SpecialChar ldots
22162 \begin_layout Standard
22163 Putting the last few things together,
22164 the \SpecialChar LaTeX
22165 output will be either:
22169 \begin_layout LyX-Code
22172 LatexName[LatexParam]{\SpecialChar ldots
22176 \begin_layout Standard
22181 \begin_layout LyX-Code
22184 begin{LatexName}[LatexParam] \SpecialChar ldots
22190 \begin_layout Standard
22191 depending upon the \SpecialChar LaTeX
22196 \begin_layout Description
22197 \begin_inset Flex Code
22200 \begin_layout Plain Layout
22207 \begin_inset Flex Code
22210 \begin_layout Plain Layout
22216 ] A string that is put at the beginning of the layout content.
22217 A line break in the output can be indicated by
22218 \begin_inset Flex Code
22221 \begin_layout Plain Layout
22230 \begin_layout Description
22231 \begin_inset Flex Code
22234 \begin_layout Plain Layout
22241 \begin_inset Flex Code
22244 \begin_layout Plain Layout
22252 \begin_inset Flex Code
22255 \begin_layout Plain Layout
22263 \change_deleted -584632292 1615846609
22265 \begin_inset Flex Code
22268 \begin_layout Plain Layout
22277 \begin_inset Flex Code
22280 \begin_layout Plain Layout
22286 (indicating a dummy definition ending definitions of charstyles,
22288 This entry is required in and is only meaningful for Flex insets.
22289 Among other things,
22290 it determines on which menu this inset will appear.
22292 \begin_inset Flex Code
22295 \begin_layout Plain Layout
22302 \begin_inset Flex Code
22305 \begin_layout Plain Layout
22311 will automatically set
22312 \begin_inset Flex Code
22315 \begin_layout Plain Layout
22322 \begin_inset Flex Code
22325 \begin_layout Plain Layout
22333 \begin_inset Flex Code
22336 \begin_layout Plain Layout
22342 can be set to true,
22344 \begin_inset Flex Code
22347 \begin_layout Plain Layout
22355 \begin_inset Flex Code
22358 \begin_layout Plain Layout
22364 insets by setting it
22369 \begin_inset Flex Code
22372 \begin_layout Plain Layout
22379 \change_inserted -712698321 1555575738
22383 \begin_layout Description
22385 \change_inserted -712698321 1555575844
22386 \begin_inset Flex Code
22389 \begin_layout Plain Layout
22391 \change_inserted -712698321 1555575740
22400 \begin_inset Flex Code
22403 \begin_layout Plain Layout
22405 \change_inserted -712698321 1555575740
22413 A dedicated string for the menu.
22414 You can define an accelerator by appending the respective character to the string,
22416 \begin_inset Quotes eld
22420 \begin_inset Quotes erd
22424 \begin_inset space \thinspace{}
22428 \begin_inset space \space{}
22432 \begin_inset Quotes eld
22436 \begin_inset Flex Code
22439 \begin_layout Plain Layout
22441 \change_inserted -712698321 1555575781
22450 \begin_inset Quotes erd
22454 This specification is optional.
22455 If it is not given the inset name as specified in the type declaration will be used instead for the menu.
22460 \begin_layout Description
22461 \begin_inset Flex Code
22464 \begin_layout Plain Layout
22471 \begin_inset Flex Code
22474 \begin_layout Plain Layout
22483 \begin_inset space \thinspace{}
22487 \begin_inset Flex Code
22490 \begin_layout Plain Layout
22496 ] Whether multiple paragraphs are permitted in this inset.
22498 \begin_inset Flex Code
22501 \begin_layout Plain Layout
22507 to the same value and
22508 \begin_inset Flex Code
22511 \begin_layout Plain Layout
22517 to the opposite value.
22518 These can be reset to other values,
22524 \begin_inset Flex Code
22527 \begin_layout Plain Layout
22537 \begin_layout Description
22538 \begin_inset Flex Code
22541 \begin_layout Plain Layout
22548 \begin_inset Flex Code
22551 \begin_layout Plain Layout
22560 \begin_inset space \thinspace{}
22564 \begin_inset Flex Code
22567 \begin_layout Plain Layout
22573 ] Whether fragile commands in this inset should be
22574 \begin_inset Flex Code
22577 \begin_layout Plain Layout
22591 whether the command should itself be protected.) Default is false.
22592 \change_inserted -712698321 1523633958
22596 \begin_layout Description
22598 \change_inserted -712698321 1552395786
22599 \begin_inset Flex Code
22602 \begin_layout Plain Layout
22604 \change_inserted -712698321 1523633961
22613 \begin_inset Flex Code
22616 \begin_layout Plain Layout
22618 \change_inserted -712698321 1523633958
22629 \begin_inset space \thinspace{}
22633 \begin_inset Flex Code
22636 \begin_layout Plain Layout
22638 \change_inserted -712698321 1523633958
22646 ] This causes macros that contain this inset to be protected with
22647 \begin_inset Flex Code
22650 \begin_layout Plain Layout
22652 \change_inserted -712698321 1523634038
22667 ) if necessary and thus allows (some) verbatim stuff in macros.
22671 \begin_layout Description
22673 \change_inserted -712698321 1555579651
22674 \begin_inset Flex Code
22677 \begin_layout Plain Layout
22679 \change_inserted -712698321 1552395787
22688 \begin_inset Flex Code
22691 \begin_layout Plain Layout
22693 \change_inserted -712698321 1552395787
22704 \begin_inset space \thinspace{}
22708 \begin_inset Flex Code
22711 \begin_layout Plain Layout
22713 \change_inserted -712698321 1552395787
22721 ] Whether specific commands in this inset (such as
22722 \begin_inset Flex Code
22725 \begin_layout Plain Layout
22727 \change_inserted -712698321 1552395787
22738 \begin_inset Flex Code
22741 \begin_layout Plain Layout
22743 \change_inserted -712698321 1552395787
22753 ) should be protected in an
22754 \begin_inset Flex Code
22757 \begin_layout Plain Layout
22759 \change_inserted -712698321 1552395787
22770 This is particularly needed for insets that draw on
22778 commands which parse their content in complex ways.
22782 \begin_layout Description
22784 \change_inserted -712698321 1555579742
22785 \begin_inset Flex Code
22788 \begin_layout Plain Layout
22790 \change_inserted -712698321 1555579658
22799 \begin_inset Flex Code
22802 \begin_layout Plain Layout
22804 \change_inserted -712698321 1555579651
22812 Option to define a different command (from the default
22813 \begin_inset Flex Code
22816 \begin_layout Plain Layout
22818 \change_inserted -712698321 1555579742
22830 ) to be used for line breaks.
22831 The initial backslash must not be specified.
22836 \begin_layout Description
22837 \begin_inset Flex Code
22840 \begin_layout Plain Layout
22847 \begin_inset Flex Code
22850 \begin_layout Plain Layout
22856 ] Deletes an existing
22857 \begin_inset Flex Code
22860 \begin_layout Plain Layout
22869 \begin_layout Description
22870 \begin_inset Flex Code
22873 \begin_layout Plain Layout
22880 \begin_inset Flex Code
22883 \begin_layout Plain Layout
22890 \begin_inset Flex Code
22893 \begin_layout Plain Layout
22899 that has replaced this
22900 \begin_inset Flex Code
22903 \begin_layout Plain Layout
22910 This is used to rename an
22911 \begin_inset Flex Code
22914 \begin_layout Plain Layout
22921 while keeping backward compatibility.
22922 \change_inserted -712698321 1559491850
22926 \begin_layout Description
22928 \change_inserted -712698321 1559492002
22929 \begin_inset Flex Code
22932 \begin_layout Plain Layout
22934 \change_inserted -712698321 1559491854
22943 \begin_inset Flex Code
22946 \begin_layout Plain Layout
22948 \change_inserted -712698321 1559491850
22959 \begin_inset space \thinspace{}
22963 \begin_inset Flex Code
22966 \begin_layout Plain Layout
22968 \change_inserted -712698321 1559491850
22976 ] If this is set to
22977 \begin_inset Flex Code
22980 \begin_layout Plain Layout
22982 \change_inserted -712698321 1559491881
22991 paragraph breaks will be ignored in the output.
22992 This might be useful for insets where the content should be alignable on different lines only in the \SpecialChar LyX
22994 without any effect in the output.
22999 \begin_layout Description
23000 \begin_inset Flex Code
23003 \begin_layout Plain Layout
23010 \begin_inset Flex Code
23013 \begin_layout Plain Layout
23022 \begin_inset space \thinspace{}
23026 \begin_inset Flex Code
23029 \begin_layout Plain Layout
23035 ] As with paragraph styles,
23037 \begin_inset CommandInset ref
23039 reference "subsec:Paragraph-Styles"
23048 \begin_layout Description
23049 \begin_inset Flex Code
23052 \begin_layout Plain Layout
23059 \begin_inset Flex Code
23062 \begin_layout Plain Layout
23071 \begin_inset space \thinspace{}
23075 \begin_inset Flex Code
23078 \begin_layout Plain Layout
23084 ] As with paragraph styles,
23086 \begin_inset CommandInset ref
23088 reference "subsec:Paragraph-Styles"
23097 \begin_layout Description
23098 \begin_inset Flex Code
23101 \begin_layout Plain Layout
23107 As with paragraph styles,
23109 \begin_inset CommandInset ref
23111 reference "subsec:Paragraph-Styles"
23119 \begin_layout Description
23120 \begin_inset Flex Code
23123 \begin_layout Plain Layout
23130 \begin_inset Flex Code
23133 \begin_layout Plain Layout
23139 ] The prefix to use when creating labels referring to insets of this type.
23140 This allows the use of formatted references.
23143 \begin_layout Description
23144 \begin_inset Flex Code
23147 \begin_layout Plain Layout
23154 \begin_inset Flex Code
23157 \begin_layout Plain Layout
23163 ] As with paragraph styles,
23165 \begin_inset CommandInset ref
23167 reference "subsec:Paragraph-Styles"
23175 \begin_layout Description
23176 \begin_inset Flex Code
23179 \begin_layout Plain Layout
23186 \begin_inset Flex Code
23189 \begin_layout Plain Layout
23198 \begin_inset space \thinspace{}
23202 \begin_inset Flex Code
23205 \begin_layout Plain Layout
23211 ] Resets the \SpecialChar LaTeX
23212 arguments of this layout (as defined via the
23213 \begin_inset Flex Code
23216 \begin_layout Plain Layout
23223 This is useful if you have copied a style via
23224 \begin_inset Flex Code
23227 \begin_layout Plain Layout
23234 but you do not want to inherit its (required and optional) arguments.
23237 \begin_layout Description
23238 \begin_inset Flex Code
23241 \begin_layout Plain Layout
23248 \begin_inset Flex Code
23251 \begin_layout Plain Layout
23260 \begin_inset space \thinspace{}
23264 \begin_inset Flex Code
23267 \begin_layout Plain Layout
23274 \change_inserted -712698321 1597733473
23276 \begin_inset Flex Code
23279 \begin_layout Plain Layout
23281 \change_inserted -712698321 1597732178
23290 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.
23291 \begin_inset space \thinspace{}
23296 \begin_inset Flex Code
23299 \begin_layout Plain Layout
23301 \change_inserted -712698321 1597733683
23304 textbf{Sourrounding text
23308 textbf{content}}\SpecialChar ldots
23317 \begin_inset Flex Code
23320 \begin_layout Plain Layout
23322 \change_inserted -712698321 1597733686
23325 textbf{Sourrounding text
23327 myinset{content}\SpecialChar ldots
23336 Setting this makes sense for commands that internally reset font settings (e.
23337 \begin_inset space \thinspace{}
23342 Note that wrongly setting this might lead to unwanted result (e.
23343 \begin_inset space \thinspace{}
23348 \begin_inset Flex Code
23351 \begin_layout Plain Layout
23353 \change_inserted -712698321 1597733688
23356 emph{Sourrounding text
23360 emph{content}}\SpecialChar ldots
23369 content is upright,
23371 \begin_inset Flex Code
23374 \begin_layout Plain Layout
23376 \change_inserted -712698321 1597733278
23388 \change_deleted -712698321 1597733283
23389 Whether this inset should use the font of its surrounding environment or uses its own.
23393 \change_deleted -712698321 1597733290
23395 \change_inserted -712698321 1597733290
23397 \begin_inset Flex Code
23400 \begin_layout Plain Layout
23402 \change_inserted -712698321 1597733292
23414 \change_deleted -712698321 1597733327
23415 use the font of the surrounding environment
23416 \change_inserted -712698321 1597733343
23417 font changes are not redone inside the inset
23422 \begin_layout Description
23423 \begin_inset Flex Code
23426 \begin_layout Plain Layout
23433 \begin_inset Flex Code
23436 \begin_layout Plain Layout
23442 ] A string that is put at the end of the layout content.
23443 A line break in the output can be indicated by
23444 \begin_inset Flex Code
23447 \begin_layout Plain Layout
23456 \begin_layout Description
23457 \begin_inset Flex Code
23460 \begin_layout Plain Layout
23467 \begin_inset Flex Code
23470 \begin_layout Plain Layout
23477 \begin_inset space \thinspace{}
23481 \begin_inset Flex Code
23484 \begin_layout Plain Layout
23492 ] Allow spell-checking the contents of this inset.
23494 \change_inserted -584632292 1615846659
23498 \begin_layout Subsection
23500 \change_inserted -584632292 1615846729
23502 \begin_inset CommandInset label
23504 name "subsec:Arguments"
23511 \begin_layout Standard
23513 \change_inserted -584632292 1615846807
23514 Both paragraph styles and inset layouts allow for
23518 as well as the main content.
23519 This is especially useful for things like section headings and only makes sense with \SpecialChar LaTeX
23521 Each (optional or required) argument of a command or environment—
23522 except for the required argument that is associated with the content—
23523 has a separate definition,
23524 where the number specifies the order of the arguments.
23525 The definition must end with
23526 \begin_inset Flex Code
23529 \begin_layout Plain Layout
23531 \change_inserted -584632292 1615846730
23540 So a command with two optional arguments looks like:
23543 \begin_layout Quote
23545 \change_inserted -584632292 1615846730
23551 \begin_layout Quote
23553 \change_inserted -584632292 1615846730
23559 \begin_layout Quote
23561 \change_inserted -584632292 1615846730
23567 \begin_layout Quote
23569 \change_inserted -584632292 1615846730
23575 \begin_layout Quote
23577 \change_inserted -584632292 1615846730
23583 \begin_layout Quote
23585 \change_inserted -584632292 1615846730
23591 \begin_layout Standard
23593 \change_inserted -584632292 1615846730
23595 \begin_inset Flex Code
23598 \begin_layout Plain Layout
23600 \change_inserted -584632292 1615846730
23609 the following specifications are possible:
23612 \begin_layout Itemize
23614 \change_inserted -584632292 1615846730
23615 \begin_inset Flex Code
23618 \begin_layout Plain Layout
23620 \change_inserted -584632292 1615846730
23629 \begin_inset Flex Code
23632 \begin_layout Plain Layout
23634 \change_inserted -584632292 1615846730
23642 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
23643 \begin_inset Flex Code
23646 \begin_layout Plain Layout
23648 \change_inserted -584632292 1615846730
23658 you can define an accelerator by appending the respective character to the string,
23660 \begin_inset Quotes eld
23664 \begin_inset Quotes erd
23668 \begin_inset space \thinspace{}
23672 \begin_inset space \space{}
23676 \begin_inset Quotes eld
23680 \begin_inset Flex Code
23683 \begin_layout Plain Layout
23685 \change_inserted -584632292 1615846730
23694 \begin_inset Quotes erd
23700 \begin_layout Itemize
23702 \change_inserted -584632292 1615846730
23703 \begin_inset Flex Code
23706 \begin_layout Plain Layout
23708 \change_inserted -584632292 1615846730
23717 \begin_inset Flex Code
23720 \begin_layout Plain Layout
23722 \change_inserted -584632292 1615846730
23730 A separate string for the menu.
23731 You can define an accelerator by appending the respective character to the string,
23733 \begin_inset Quotes eld
23737 \begin_inset Quotes erd
23741 \begin_inset space \thinspace{}
23745 \begin_inset space \space{}
23749 \begin_inset Quotes eld
23753 \begin_inset Flex Code
23756 \begin_layout Plain Layout
23758 \change_inserted -584632292 1615846730
23767 \begin_inset Quotes erd
23771 This specification is optional.
23772 If it is not given the
23773 \begin_inset Flex Code
23776 \begin_layout Plain Layout
23778 \change_inserted -584632292 1615846730
23786 will be used instead for the menu.
23789 \begin_layout Itemize
23791 \change_inserted -584632292 1615846730
23792 \begin_inset Flex Code
23795 \begin_layout Plain Layout
23797 \change_inserted -584632292 1615846730
23806 \begin_inset Flex Code
23809 \begin_layout Plain Layout
23811 \change_inserted -584632292 1615846730
23819 A longer explanatory text that appears in the tooltip when hovering over the argument inset.
23822 \begin_layout Itemize
23824 \change_inserted -584632292 1615846730
23825 \begin_inset Flex Code
23828 \begin_layout Plain Layout
23830 \change_inserted -584632292 1615846730
23839 \begin_inset Flex Code
23842 \begin_layout Plain Layout
23844 \change_inserted -584632292 1615846730
23855 \begin_inset space \thinspace{}
23859 \begin_inset Flex Code
23862 \begin_layout Plain Layout
23864 \change_inserted -584632292 1615846730
23872 ] Declare if this is a mandatory (1) or an optional (0) argument.
23873 Mandatory arguments will be output empty if not given,
23874 while optional arguments will not be output at all.
23876 mandatory arguments are delimited by
23877 \begin_inset Flex Code
23880 \begin_layout Plain Layout
23882 \change_inserted -584632292 1615846730
23891 while optional arguments are delimited by
23892 \begin_inset Flex Code
23895 \begin_layout Plain Layout
23897 \change_inserted -584632292 1615846730
23908 \begin_layout Itemize
23910 \change_inserted -584632292 1615846730
23911 \begin_inset Flex Code
23914 \begin_layout Plain Layout
23916 \change_inserted -584632292 1615846730
23925 \begin_inset Flex Code
23928 \begin_layout Plain Layout
23930 \change_inserted -584632292 1615846730
23938 Option to define a different command (from the default
23939 \begin_inset Flex Code
23942 \begin_layout Plain Layout
23944 \change_inserted -584632292 1615846730
23956 ) to be used for line breaks.
23957 The initial backslash must not be specified.
23960 \begin_layout Itemize
23962 \change_inserted -584632292 1615846730
23963 \begin_inset Flex Code
23966 \begin_layout Plain Layout
23968 \change_inserted -584632292 1615846730
23977 \begin_inset Flex Code
23980 \begin_layout Plain Layout
23982 \change_inserted -584632292 1615846730
23990 defines another argument (by its number) which this argument requires to be output if it is itself output.
23992 \begin_inset space \thinspace{}
23996 in \SpecialChar LaTeX
23998 optional arguments often require previous optional arguments to be output (at least empty),
24000 \begin_inset Flex Code
24003 \begin_layout Plain Layout
24005 \change_inserted -584632292 1615846730
24008 command[][argument]{text}
24016 This can be achieved by the statement
24017 \begin_inset Flex Code
24020 \begin_layout Plain Layout
24022 \change_inserted -584632292 1615846730
24031 \begin_inset Flex Code
24034 \begin_layout Plain Layout
24036 \change_inserted -584632292 1615846730
24047 \begin_layout Itemize
24049 \change_inserted -584632292 1615846730
24050 \begin_inset Flex Code
24053 \begin_layout Plain Layout
24055 \change_inserted -584632292 1615846730
24064 \begin_inset Flex Code
24067 \begin_layout Plain Layout
24069 \change_inserted -584632292 1615846730
24077 defines a custom left delimiter (instead of
24078 \begin_inset Flex Code
24081 \begin_layout Plain Layout
24083 \change_inserted -584632292 1615846730
24092 \begin_inset Flex Code
24095 \begin_layout Plain Layout
24097 \change_inserted -584632292 1615846730
24106 A line break in the output can be indicated by
24107 \begin_inset Flex Code
24110 \begin_layout Plain Layout
24112 \change_inserted -584632292 1615846730
24123 \begin_layout Itemize
24125 \change_inserted -584632292 1615846730
24126 \begin_inset Flex Code
24129 \begin_layout Plain Layout
24131 \change_inserted -584632292 1615846730
24140 \begin_inset Flex Code
24143 \begin_layout Plain Layout
24145 \change_inserted -584632292 1615846730
24153 defines a custom right delimiter (instead of
24154 \begin_inset Flex Code
24157 \begin_layout Plain Layout
24159 \change_inserted -584632292 1615846730
24168 \begin_inset Flex Code
24171 \begin_layout Plain Layout
24173 \change_inserted -584632292 1615846730
24182 A line break in the output can be indicated by
24183 \begin_inset Flex Code
24186 \begin_layout Plain Layout
24188 \change_inserted -584632292 1615846730
24199 \begin_layout Itemize
24201 \change_inserted -584632292 1615846730
24202 \begin_inset Flex Code
24205 \begin_layout Plain Layout
24207 \change_inserted -584632292 1615846730
24216 \begin_inset Flex Code
24219 \begin_layout Plain Layout
24221 \change_inserted -584632292 1615846730
24229 defines an argument that is inserted if and only if no user-specified arguments were given,
24231 \begin_inset space \thinspace{}
24235 \begin_inset space \space{}
24238 if no argument inset has been inserted (note that also an empty argument inset omits the DefaultArg).
24239 Multiple arguments need to be separated by comma.
24242 \begin_layout Itemize
24244 \change_inserted -584632292 1615846730
24245 \begin_inset Flex Code
24248 \begin_layout Plain Layout
24250 \change_inserted -584632292 1615846730
24259 \begin_inset Flex Code
24262 \begin_layout Plain Layout
24264 \change_inserted -584632292 1615846730
24272 defines an argument that is inserted in any case (alone or in addition to user-specified arguments).
24273 Multiple arguments need to be separated by comma.
24276 \begin_layout Itemize
24278 \change_inserted -584632292 1615846730
24279 \begin_inset Flex Code
24282 \begin_layout Plain Layout
24284 \change_inserted -584632292 1615846730
24292 The font used for the argument content,
24294 \begin_inset CommandInset ref
24296 reference "subsec:Font-description"
24304 \begin_layout Itemize
24306 \change_inserted -584632292 1615846730
24307 \begin_inset Flex Code
24310 \begin_layout Plain Layout
24312 \change_inserted -584632292 1615846730
24321 \begin_inset Flex Code
24324 \begin_layout Plain Layout
24326 \change_inserted -584632292 1615846730
24337 \begin_inset space \thinspace{}
24341 \begin_inset Flex Code
24344 \begin_layout Plain Layout
24346 \change_inserted -584632292 1615846730
24354 ] As with paragraph styles,
24356 \begin_inset CommandInset ref
24358 reference "subsec:Paragraph-Styles"
24366 \begin_layout Itemize
24368 \change_inserted -584632292 1615846730
24369 \begin_inset Flex Code
24372 \begin_layout Plain Layout
24374 \change_inserted -584632292 1615846730
24382 The font used for the label;
24384 \begin_inset CommandInset ref
24386 reference "subsec:Font-description"
24394 \begin_layout Itemize
24396 \change_inserted -584632292 1615846730
24397 \begin_inset Flex Code
24400 \begin_layout Plain Layout
24402 \change_inserted -584632292 1615846730
24411 \begin_inset Flex Code
24414 \begin_layout Plain Layout
24416 \change_inserted -584632292 1615846730
24430 ] describes the rendering style used for the inset's frame and buttons.
24433 \begin_layout Itemize
24435 \change_inserted -584632292 1615846730
24436 \begin_inset Flex Code
24439 \begin_layout Plain Layout
24441 \change_inserted -584632292 1615846730
24450 \begin_inset Flex Code
24453 \begin_layout Plain Layout
24455 \change_inserted -584632292 1615846730
24464 \begin_inset Flex Code
24467 \begin_layout Plain Layout
24469 \change_inserted -584632292 1615846730
24478 this argument is automatically inserted when the respective style is selected.
24481 \begin_layout Itemize
24483 \change_inserted -584632292 1615846730
24484 \begin_inset Flex Code
24487 \begin_layout Plain Layout
24489 \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
24526 this argument will be inserted on a new line with
24527 \begin_inset Flex Code
24530 \begin_layout Plain Layout
24532 \change_inserted -584632292 1615846730
24540 (only available within Flex insets).
24543 \begin_layout Itemize
24545 \change_inserted -584632292 1615846730
24546 \begin_inset Flex Code
24549 \begin_layout Plain Layout
24551 \change_inserted -584632292 1615846730
24560 \begin_inset Flex Code
24563 \begin_layout Plain Layout
24565 \change_inserted -584632292 1615846730
24574 \begin_inset Flex Code
24577 \begin_layout Plain Layout
24579 \change_inserted -584632292 1615846730
24588 this argument will be inserted with a copy of the co-text (either selected text or the whole paragraph) as content.
24591 \begin_layout Itemize
24593 \change_inserted -584632292 1615846730
24594 \begin_inset Flex Code
24597 \begin_layout Plain Layout
24599 \change_inserted -584632292 1615846730
24608 \begin_inset Flex Code
24611 \begin_layout Plain Layout
24613 \change_inserted -584632292 1615846730
24627 ] Whether the contents of this argument should be output in raw form,
24628 meaning without special translations that \SpecialChar LaTeX
24632 \begin_inset Flex Code
24635 \begin_layout Plain Layout
24637 \change_inserted -584632292 1615846730
24645 status is inherited by the inset or paragraph layout the argument belongs to,
24646 true and false change the status for the given argument only.
24649 \begin_layout Itemize
24651 \change_inserted -584632292 1615846730
24652 \begin_inset Flex Code
24655 \begin_layout Plain Layout
24657 \change_inserted -584632292 1615846730
24666 \begin_inset Flex Code
24669 \begin_layout Plain Layout
24671 \change_inserted -584632292 1615846730
24672 string of characters
24683 Defines individual characters
24684 \begin_inset Newline linebreak
24687 that should be output in raw form,
24688 meaning without special translations that \SpecialChar LaTeX
24691 contrary to PassThru,
24692 this needs to be explicitly defined for arguments.
24694 arguments do not inherit PassThruChars from their parent inset or layout.
24697 \begin_layout Itemize
24699 \change_inserted -584632292 1615846730
24700 \begin_inset Flex Code
24703 \begin_layout Plain Layout
24705 \change_inserted -584632292 1615846730
24714 \begin_inset Flex Code
24717 \begin_layout Plain Layout
24719 \change_inserted -584632292 1615846730
24730 \begin_inset space \thinspace{}
24734 \begin_inset Flex Code
24737 \begin_layout Plain Layout
24739 \change_inserted -584632292 1615846730
24747 ] If this is set to 1,
24748 the argument will output its content in the corresponding item in the table of contents.
24752 \begin_layout Standard
24754 \change_inserted -584632292 1615846730
24756 the text entered in the \SpecialChar LyX
24757 workarea in the respective layout is the last (mandatory) argument of a command if the
24758 \begin_inset Flex Code
24761 \begin_layout Plain Layout
24763 \change_inserted -584632292 1615846730
24772 \begin_inset Flex Code
24775 \begin_layout Plain Layout
24777 \change_inserted -584632292 1615846730
24787 arguments with the prefix
24788 \begin_inset Flex Code
24791 \begin_layout Plain Layout
24793 \change_inserted -584632292 1615846730
24801 are output after this workarea argument.
24802 Note that post-argument numbering restarts at 1,
24803 so the first argument following the workarea argument is
24804 \begin_inset Flex Code
24807 \begin_layout Plain Layout
24809 \change_inserted -584632292 1615846730
24818 Post-arguments are ignored in any other
24819 \begin_inset Flex Code
24822 \begin_layout Plain Layout
24824 \change_inserted -584632292 1615846730
24833 \begin_inset Flex Code
24836 \begin_layout Plain Layout
24838 \change_inserted -584632292 1615846730
24849 \begin_layout Standard
24851 \change_inserted -584632292 1615846730
24853 \begin_inset Flex Code
24856 \begin_layout Plain Layout
24858 \change_inserted -584632292 1615846730
24869 \begin_inset Flex Code
24872 \begin_layout Plain Layout
24874 \change_inserted -584632292 1615846730
24885 \begin_inset Flex Code
24888 \begin_layout Plain Layout
24890 \change_inserted -584632292 1615846730
24898 followed by the number (e.
24899 \begin_inset space \thinspace{}
24903 \begin_inset space \space{}
24907 \begin_inset Flex Code
24910 \begin_layout Plain Layout
24912 \change_inserted -584632292 1615846730
24923 \begin_layout Standard
24925 \change_inserted -584632292 1615846730
24927 there is a special argument type with the prefix
24928 \begin_inset Flex Code
24931 \begin_layout Plain Layout
24933 \change_inserted -584632292 1615846730
24942 It is not really an argument,
24943 but uses the argument interface (thus,
24944 the prefix is also followed by a number,
24946 \begin_inset space \thinspace{}
24951 \begin_inset Flex Code
24954 \begin_layout Plain Layout
24956 \change_inserted -584632292 1615846730
24957 Argument listpreamble:1
24965 As the name implies,
24966 it is targeted at lists such as
24986 Its content will be output at the list start,
24988 \begin_inset Flex Code
24991 \begin_layout Plain Layout
24993 \change_inserted -584632292 1615846730
25004 on an own line (a place that is otherwise not accessible in \SpecialChar LyX
25007 users can insert redefinitions (of lengths etc.) to individual lists.
25009 these arguments do not have a delimiter.
25014 \begin_layout Subsection
25016 \begin_inset CommandInset label
25018 name "subsec:Counters"
25025 \begin_layout Standard
25026 It is necessary to define the counters (
25027 \begin_inset Flex Noun
25030 \begin_layout Plain Layout
25038 \begin_inset Flex Noun
25041 \begin_layout Plain Layout
25049 ) in the text class itself.
25050 The standard counters are defined in the file
25051 \begin_inset Flex Code
25054 \begin_layout Plain Layout
25061 so you may have to do no more than add
25064 \begin_layout LyX-Code
25065 Input stdcounters.inc
25068 \begin_layout Standard
25069 to your layout file to get them to work.
25070 But if you want to define custom counters,
25071 then you can do so.
25072 The counter declaration must begin with:
25075 \begin_layout LyX-Code
25076 Counter CounterName
25079 \begin_layout Standard
25081 \begin_inset Flex Code
25084 \begin_layout Plain Layout
25090 ' is replaced by the name of the counter.
25091 And it must end with
25092 \begin_inset Quotes eld
25096 \begin_inset Flex Code
25099 \begin_layout Plain Layout
25106 \begin_inset Quotes erd
25110 The following parameters can also be used:
25113 \begin_layout Description
25114 \begin_inset Flex Code
25117 \begin_layout Plain Layout
25124 \begin_inset Flex Code
25127 \begin_layout Plain Layout
25133 ] Sets the initial value for the counter,
25134 to which it will be reset whenever that happens.
25136 one will want the default,
25140 \begin_layout Description
25141 \begin_inset Flex Code
25144 \begin_layout Plain Layout
25151 \begin_inset Flex Code
25154 \begin_layout Plain Layout
25161 \begin_inset Quotes erd
25165 \begin_inset Quotes erd
25169 this string defines how the counter is displayed.
25170 Setting this value sets
25171 \begin_inset Flex Code
25174 \begin_layout Plain Layout
25175 LabelStringAppendix
25181 The following special constructs can be used in the string:
25185 \begin_layout Itemize
25186 \begin_inset Flex Code
25189 \begin_layout Plain Layout
25197 will be replaced by the expansion of the
25198 \begin_inset Flex Code
25201 \begin_layout Plain Layout
25208 \begin_inset Flex Code
25211 \begin_layout Plain Layout
25212 LabelStringAppendix
25218 \begin_inset Flex Code
25221 \begin_layout Plain Layout
25231 \begin_layout Itemize
25232 counter values can be expressed using \SpecialChar LaTeX
25234 \begin_inset Newline newline
25238 \begin_inset Flex Code
25241 \begin_layout Plain Layout
25259 \begin_inset Flex Code
25262 \begin_layout Plain Layout
25274 \begin_layout Plain Layout
25285 the situation is a bit more complicated:
25305 other than those described below will produce arabic numerals.
25306 It would not be surprising to see this change in the future.
25312 \begin_inset Flex Code
25315 \begin_layout Plain Layout
25324 3,\SpecialChar ldots
25327 \begin_inset Flex Code
25330 \begin_layout Plain Layout
25336 for lower-case letters:
25343 \begin_inset Flex Code
25346 \begin_layout Plain Layout
25352 for upper-case letters:
25359 \begin_inset Flex Code
25362 \begin_layout Plain Layout
25368 for lower-case roman numerals:
25375 \begin_inset Flex Code
25378 \begin_layout Plain Layout
25384 for upper-case roman numerals:
25387 III\SpecialChar ldots
25390 \begin_inset Flex Code
25393 \begin_layout Plain Layout
25399 for hebrew numerals.
25403 \begin_layout Standard
25404 If LabelString is not defined,
25405 a default value is constructed as follows:
25406 if the counter has a
25407 \change_deleted 731793113 1604355218
25409 \change_inserted 731793113 1604355221
25413 \begin_inset Flex Code
25416 \begin_layout Plain Layout
25418 \change_deleted 731793113 1604355223
25420 \change_inserted 731793113 1604355226
25429 \begin_inset Flex Code
25432 \begin_layout Plain Layout
25440 \begin_inset Newline newline
25444 \begin_inset Flex Code
25447 \begin_layout Plain Layout
25451 \change_inserted 731793113 1604355228
25453 \change_deleted 731793113 1604355230
25464 otherwise the string
25465 \begin_inset Flex Code
25468 \begin_layout Plain Layout
25479 \begin_layout Description
25480 \begin_inset Flex Code
25483 \begin_layout Plain Layout
25484 LabelStringAppendix
25490 \begin_inset Flex Code
25493 \begin_layout Plain Layout
25500 \begin_inset Quotes eld
25504 \begin_inset Quotes erd
25508 \begin_inset Flex Code
25511 \begin_layout Plain Layout
25518 but for use in the Appendix.
25519 \change_inserted -584632292 1607202551
25523 \begin_layout Description
25525 \change_inserted -584632292 1607202682
25526 \begin_inset Flex Code
25529 \begin_layout Plain Layout
25536 \begin_inset Flex Code
25539 \begin_layout Plain Layout
25541 \change_inserted -584632292 1607202576
25550 \begin_inset Quotes eld
25554 \begin_inset Quotes erd
25557 ] The counter name as used in \SpecialChar LaTeX
25560 \change_inserted 34634807 1619711355
25562 \change_deleted 34634807 1619711355
25564 \change_inserted -584632292 1607202682
25566 in \SpecialChar LyX
25568 there is a counter named `theorem',
25569 but it is output to \SpecialChar LaTeX
25575 \begin_layout Description
25576 \begin_inset Flex Code
25579 \begin_layout Plain Layout
25586 \begin_inset Flex Code
25589 \begin_layout Plain Layout
25596 \begin_inset Quotes erd
25600 \begin_inset Quotes erd
25603 ] A format for use with formatted references to this counter.
25605 one might want to have references to section numbers appear as
25606 \begin_inset Quotes eld
25610 \begin_inset Quotes erd
25614 The string should contain
25615 \begin_inset Quotes eld
25619 \begin_inset Quotes erd
25623 This will be replaced by the counter number itself.
25630 \begin_layout Description
25631 \begin_inset Flex Code
25634 \begin_layout Plain Layout
25641 \begin_inset Flex Code
25644 \begin_layout Plain Layout
25651 \begin_inset Quotes erd
25655 \begin_inset Quotes erd
25658 ] If this is set to the name of another counter,
25659 the present counter will be reset every time the other one is increased.
25662 \begin_inset Flex Code
25665 \begin_layout Plain Layout
25672 \begin_inset Flex Code
25675 \begin_layout Plain Layout
25684 \begin_layout Subsection
25686 \begin_inset CommandInset label
25688 name "subsec:Font-description"
25695 \begin_layout Standard
25696 A font description looks like this:
25699 \begin_layout LyX-Code
25716 \begin_layout LyX-Code
25720 \begin_layout LyX-Code
25724 \begin_layout Standard
25725 The following commands are available:
25728 \begin_layout Description
25729 \begin_inset Flex Code
25732 \begin_layout Plain Layout
25739 \change_deleted -712698321 1607682984
25741 \begin_inset Flex Code
25744 \begin_layout Plain Layout
25754 \begin_inset Flex Code
25757 \begin_layout Plain Layout
25765 \begin_inset Flex Code
25768 \begin_layout Plain Layout
25776 \begin_inset Flex Code
25779 \begin_layout Plain Layout
25787 \begin_inset Flex Code
25790 \begin_layout Plain Layout
25798 \begin_inset Flex Code
25801 \begin_layout Plain Layout
25809 \begin_inset Flex Code
25812 \begin_layout Plain Layout
25820 \begin_inset Flex Code
25823 \begin_layout Plain Layout
25831 \begin_inset Flex Code
25834 \begin_layout Plain Layout
25842 \begin_inset Flex Code
25845 \begin_layout Plain Layout
25853 \begin_inset Flex Code
25856 \begin_layout Plain Layout
25864 \begin_inset Flex Code
25867 \begin_layout Plain Layout
25875 \begin_inset Flex Code
25878 \begin_layout Plain Layout
25886 \begin_inset Flex Code
25889 \begin_layout Plain Layout
25897 \begin_inset Flex Code
25900 \begin_layout Plain Layout
25908 \begin_inset Flex Code
25911 \begin_layout Plain Layout
25919 \begin_inset Flex Code
25922 \begin_layout Plain Layout
25930 \begin_inset Flex Code
25933 \begin_layout Plain Layout
25941 \begin_inset Flex Code
25944 \begin_layout Plain Layout
25952 \begin_inset Flex Code
25955 \begin_layout Plain Layout
25962 \change_inserted -712698321 1607683139
25964 \begin_inset Flex Code
25967 \begin_layout Plain Layout
25969 \change_inserted -712698321 1607683135
25978 \begin_inset space ~
25982 \begin_inset CommandInset ref
25984 reference "chap:Names-of-colors"
25993 \change_deleted -712698321 1607683144
25995 \change_inserted -712698321 1607683146
26001 \begin_layout Description
26002 \begin_inset Flex Code
26005 \begin_layout Plain Layout
26012 \begin_inset Flex Code
26015 \begin_layout Plain Layout
26025 \begin_inset Flex Code
26028 \begin_layout Plain Layout
26036 \begin_inset Flex Code
26039 \begin_layout Plain Layout
26048 \begin_layout Description
26049 \begin_inset Flex Code
26052 \begin_layout Plain Layout
26059 \begin_inset Flex Code
26062 \begin_layout Plain Layout
26068 ] Valid arguments are:
26070 \begin_inset Flex Code
26073 \begin_layout Plain Layout
26081 \begin_inset Flex Code
26084 \begin_layout Plain Layout
26092 \begin_inset Flex Code
26095 \begin_layout Plain Layout
26103 \begin_inset Flex Code
26106 \begin_layout Plain Layout
26114 \begin_inset Flex Code
26117 \begin_layout Plain Layout
26125 \begin_inset Flex Code
26128 \begin_layout Plain Layout
26136 \begin_inset Flex Code
26139 \begin_layout Plain Layout
26147 \begin_inset Flex Code
26150 \begin_layout Plain Layout
26158 \begin_inset Flex Code
26161 \begin_layout Plain Layout
26169 \begin_inset Flex Code
26172 \begin_layout Plain Layout
26180 \begin_inset Flex Code
26183 \begin_layout Plain Layout
26190 \begin_inset Flex Code
26193 \begin_layout Plain Layout
26200 Each of these turns on or off the corresponding attribute.
26203 \begin_inset Flex Code
26206 \begin_layout Plain Layout
26214 \begin_inset Flex Code
26217 \begin_layout Plain Layout
26225 \begin_inset Newline newline
26228 If the latter seems puzzling,
26229 remember that the font settings for the present context are generally inherited from the surrounding context.
26231 \begin_inset Flex Code
26234 \begin_layout Plain Layout
26240 would turn off the emphasis that was anyway in effect,
26242 in a theorem environment.
26245 \begin_layout Description
26246 \begin_inset Flex Code
26249 \begin_layout Plain Layout
26256 \begin_inset Flex Code
26259 \begin_layout Plain Layout
26269 \begin_inset Flex Code
26272 \begin_layout Plain Layout
26281 \begin_layout Description
26282 \begin_inset Flex Code
26285 \begin_layout Plain Layout
26292 \begin_inset Flex Code
26295 \begin_layout Plain Layout
26305 \begin_inset Flex Code
26308 \begin_layout Plain Layout
26316 \begin_inset Flex Code
26319 \begin_layout Plain Layout
26327 \begin_inset Flex Code
26330 \begin_layout Plain Layout
26339 \begin_layout Description
26340 \begin_inset Flex Code
26343 \begin_layout Plain Layout
26350 \begin_inset Flex Code
26353 \begin_layout Plain Layout
26361 \begin_inset Flex Code
26364 \begin_layout Plain Layout
26372 \begin_inset Flex Code
26375 \begin_layout Plain Layout
26385 \begin_inset Flex Code
26388 \begin_layout Plain Layout
26396 \begin_inset Flex Code
26399 \begin_layout Plain Layout
26407 \begin_inset Flex Code
26410 \begin_layout Plain Layout
26418 \begin_inset Flex Code
26421 \begin_layout Plain Layout
26429 \begin_inset Flex Code
26432 \begin_layout Plain Layout
26441 \begin_layout Subsection
26442 \begin_inset CommandInset label
26444 name "subsec:Citation-engine-description"
26448 Cite engine description
26451 \begin_layout Standard
26453 \begin_inset Flex Code
26456 \begin_layout Plain Layout
26463 as used mainly in cite engine files (see
26464 \begin_inset CommandInset ref
26466 reference "subsec:Cite-Engine-Files"
26475 define the citation commands provided by a specific
26476 \begin_inset Quotes eld
26480 \begin_inset Quotes erd
26485 in \SpecialChar LyX
26487 is way specific way to format citations,
26489 author names and/or years.
26492 supports three such engine types,
26496 \begin_layout Enumerate
26497 \begin_inset Flex Code
26500 \begin_layout Plain Layout
26507 the default Bib\SpecialChar TeX
26508 way to format citations,
26509 a simple numeric style (e.
26510 \begin_inset space \thinspace{}
26515 \begin_inset Quotes eld
26519 \begin_inset Quotes erd
26525 \begin_layout Enumerate
26526 \begin_inset Flex Code
26529 \begin_layout Plain Layout
26536 Harvard-styled citations using author names and publication year (e.
26537 \begin_inset space \thinspace{}
26542 \begin_inset Quotes eld
26545 Smith and Miller (2017b)
26546 \begin_inset Quotes erd
26552 \begin_layout Enumerate
26553 \begin_inset Flex Code
26556 \begin_layout Plain Layout
26563 extended numerical citations that also allow for author or title next to the number (e.
26564 \begin_inset space \thinspace{}
26569 \begin_inset Quotes eld
26572 Smith and Miller [1]
26573 \begin_inset Quotes erd
26579 \begin_layout Standard
26580 \begin_inset Flex Code
26583 \begin_layout Plain Layout
26589 blocks look like this:
26592 \begin_layout LyX-Code
26596 \begin_layout LyX-Code
26600 \begin_layout LyX-Code
26604 \begin_layout LyX-Code
26605 citeyearpar[][]=parencite*
26608 \begin_layout LyX-Code
26612 \begin_layout LyX-Code
26616 \begin_layout Standard
26618 \begin_inset Flex Code
26621 \begin_layout Plain Layout
26627 denotes the engine.
26628 The individual lines respectively define a cite command or cite command paradigm supported by this engine.
26629 The line can be as simple as a cite command that is used both to name the respective \SpecialChar LyX
26630 command and the \SpecialChar LaTeX
26631 output or more complex in order to differentiate things.
26632 The full syntax is:
26635 \begin_layout LyX-Code
26636 LyXName|alias$*<!_stardesc!_stardesctooltip>[][]=latexcmd
26639 \begin_layout Itemize
26640 \begin_inset Flex Code
26643 \begin_layout Plain Layout
26650 The name as used in the
26651 \begin_inset Flex Code
26654 \begin_layout Plain Layout
26664 \begin_layout Standard
26665 For portability reasons,
26666 we try to use the same name for same-formatted commands in different cite packages (thus many names stem from natbib,
26667 and thus we need to differentiate a
26668 \begin_inset Flex Code
26671 \begin_layout Plain Layout
26678 if the \SpecialChar LaTeX
26679 command names differ).
26683 \begin_layout Itemize
26684 \begin_inset Flex Code
26687 \begin_layout Plain Layout
26694 a (comma-separated) list of commands that fall back to the given
26695 \begin_inset Flex Code
26698 \begin_layout Plain Layout
26704 in the current engine.
26705 This eases the switch of citation packages and engines.
26707 \begin_inset Flex Code
26710 \begin_layout Plain Layout
26717 \begin_inset Flex Code
26720 \begin_layout Plain Layout
26726 in layout definitions.
26729 \begin_layout Itemize
26730 \begin_inset Flex Code
26733 \begin_layout Plain Layout
26740 The actual \SpecialChar LaTeX
26741 command that is output.
26745 \begin_layout Standard
26746 \begin_inset Flex Code
26749 \begin_layout Plain Layout
26756 \begin_inset Flex Code
26759 \begin_layout Plain Layout
26767 \begin_inset Flex Code
26770 \begin_layout Plain Layout
26778 \begin_inset Flex Code
26781 \begin_layout Plain Layout
26787 will be output to \SpecialChar LaTeX
26791 \begin_layout Standard
26795 \begin_layout Itemize
26796 Capitalization indicates that the command also has a capitalized form (
26797 \begin_inset Flex Code
26800 \begin_layout Plain Layout
26810 \begin_inset Flex Code
26813 \begin_layout Plain Layout
26822 These usually enforce up-casing of name prefixes (
26827 \begin_inset Formula $\Rightarrow$
26837 \begin_layout Itemize
26839 \begin_inset Flex Code
26842 \begin_layout Plain Layout
26848 indicate the number of optional arguments (there can be 0–2).
26851 \begin_layout Itemize
26853 \begin_inset Flex Code
26856 \begin_layout Plain Layout
26862 indicates there is a starred version of the command (
26863 \begin_inset Flex Code
26866 \begin_layout Plain Layout
26876 \begin_inset Flex Code
26879 \begin_layout Plain Layout
26892 \begin_layout Standard
26894 the starred version means:
26895 Output all authors even if it should be shortened with
26896 \begin_inset Quotes eld
26900 \begin_inset Quotes erd
26904 \begin_inset Flex Code
26907 \begin_layout Plain Layout
26916 \begin_layout Standard
26917 If the star has a different meaning for a given command,
26918 it can be specified in angle brackets:
26920 \begin_inset Flex Code
26923 \begin_layout Plain Layout
26924 <!_stardesc!_stardesctooltip>
26930 Maximal two translatable macro keywords,
26931 marked by the prefix
26932 \begin_inset Flex Code
26935 \begin_layout Plain Layout
26943 The first points to the string that replaces the
26944 \begin_inset Quotes eld
26948 \begin_inset Quotes erd
26951 checkbox label in the citation dialog,
26952 the second one to an optional tool tip for this checkbox.
26956 \begin_layout Standard
26957 Note that these two macros have to be defined in a
26958 \begin_inset Flex Code
26961 \begin_layout Plain Layout
26967 (see next section),
26969 \begin_inset Flex Code
26972 \begin_layout Plain Layout
26983 \begin_layout LyX-Code
26984 _stardesc Sta&rred command label
26987 \begin_layout LyX-Code
26988 _stardesctooltip Tooltip for the starred command checkbox.
26992 \begin_layout Itemize
26994 \begin_inset Flex Code
26997 \begin_layout Plain Layout
27003 indicates that this command features
27004 \begin_inset Quotes eld
27007 qualified citation lists
27008 \begin_inset Quotes erd
27016 -specific feature for multi-reference citations where an individual pre- and postnote can be given to each reference in the list.
27017 Please refer to the
27021 manual for details.
27022 \change_inserted -712698321 1526898670
27026 \begin_layout Standard
27028 \change_inserted -712698321 1526899524
27029 If you want to add a cite command to a cite engine (e.
27030 \begin_inset space \thinspace{}
27034 add a specific command provided by a class),
27036 \begin_inset Flex Code
27039 \begin_layout Plain Layout
27041 \change_inserted -712698321 1526898768
27042 AddToCiteEngine <engine type> \SpecialChar ldots
27051 Note that only cite commands that do not exist yet are added.
27056 \begin_layout Subsection
27057 \begin_inset CommandInset label
27059 name "subsec:Citation-format-description"
27063 Cite format description
27066 \begin_layout Standard
27068 \begin_inset Flex Code
27071 \begin_layout Plain Layout
27077 blocks are used to describe how bibliographic information should be displayed,
27078 both within \SpecialChar LyX
27079 itself (in the citation dialog and in tooltips,
27080 for example) and in XHTML output.
27081 Such a block might look like this:
27084 \begin_layout LyX-Code
27088 \begin_layout LyX-Code
27092 \begin_layout LyX-Code
27096 \begin_layout LyX-Code
27100 \begin_layout Standard
27104 \begin_layout LyX-Code
27108 \begin_layout LyX-Code
27112 \begin_layout LyX-Code
27116 \begin_layout LyX-Code
27120 \begin_layout Standard
27122 the individual lines define how the bibliographic information associated with an article or book,
27124 is to be displayed,
27125 and such a definition can be given for any
27126 \begin_inset Quotes els
27130 \begin_inset Quotes ers
27133 that might be present in a Bib\SpecialChar TeX
27136 defines a default format in the source code that will be used if no specific definition has been given.
27138 predefines several formats in the file
27139 \begin_inset Flex Code
27142 \begin_layout Plain Layout
27149 which is included in most of \SpecialChar LyX
27150 's document classes.
27153 \begin_layout Standard
27154 In the second case,
27155 the lines define how a specific citation command (in the example
27156 \begin_inset Flex Code
27159 \begin_layout Plain Layout
27169 \begin_inset Flex Code
27172 \begin_layout Plain Layout
27180 ) is to be displayed on the citation inset label,
27181 in the citation dialog,
27182 menu or XHTML output.
27184 defines such formats for the citation style variants it supports via
27186 Document\SpecialChar menuseparator
27187 Setting\SpecialChar menuseparator
27188 Bibliography\SpecialChar ldots
27192 \begin_inset Flex Code
27195 \begin_layout Plain Layout
27201 files that are shipped with \SpecialChar LyX
27203 \begin_inset CommandInset ref
27205 reference "subsec:Cite-Engine-Files"
27216 \begin_layout Standard
27217 The definitions use a simple language that allows Bib\SpecialChar TeX
27218 keys to be replaced with their values.
27219 Keys should be enclosed in
27220 \begin_inset Flex Code
27223 \begin_layout Plain Layout
27232 \begin_inset Flex Code
27235 \begin_layout Plain Layout
27242 So a simple definition might look like this:
27245 \begin_layout LyX-Code
27248 \begin_inset Quotes eld
27252 \begin_inset Quotes erd
27258 \begin_layout Standard
27259 This would print the author,
27260 followed by a comma,
27261 followed by the title,
27263 followed by a period.
27266 \begin_layout Standard
27268 sometimes you may want to print a key only if it exists.
27269 This can be done by using a conditional construction,
27272 \begin_inset Flex Code
27275 \begin_layout Plain Layout
27277 \begin_inset space ~
27288 \begin_inset Flex Code
27291 \begin_layout Plain Layout
27299 \begin_inset Quotes eld
27303 \begin_inset space ~
27307 \begin_inset Quotes erd
27310 followed by the volume key.
27311 It is also possible to have an else clause in the conditional,
27313 \begin_inset Newline newline
27317 \begin_inset Flex Code
27320 \begin_layout Plain Layout
27321 {%author%[[%author%]][[%editor%,
27328 \begin_inset Newline newline
27333 \begin_inset Flex Code
27336 \begin_layout Plain Layout
27342 key is printed if it exists;
27344 the editor key is printed,
27346 \begin_inset Quotes eld
27350 \begin_inset space ~
27354 \begin_inset Quotes erd
27357 Note that the key is again enclosed in
27358 \begin_inset Flex Code
27361 \begin_layout Plain Layout
27368 the entire conditional is enclosed in braces;
27369 and the if and else clauses are enclosed in double brackets,
27371 \begin_inset Quotes eld
27375 \begin_inset Flex Code
27378 \begin_layout Plain Layout
27385 \begin_inset Quotes eld
27389 \begin_inset Quotes eld
27393 \begin_inset Flex Code
27396 \begin_layout Plain Layout
27403 \begin_inset Quotes erd
27407 There must be no space between any of these.
27410 \begin_layout Standard
27411 Next to the entry keys,
27412 there are some special keys that can be used for these conditionals:
27415 \begin_layout Itemize
27416 \begin_inset Flex Code
27419 \begin_layout Plain Layout
27420 {%dialog%[[true]][[false]]}
27427 \begin_inset Quotes eld
27431 \begin_inset Quotes erd
27434 part for dialogs and menus,
27436 \begin_inset Quotes eld
27440 \begin_inset Quotes erd
27443 part for other contexts (workarea,
27447 \begin_layout Itemize
27448 \begin_inset Flex Code
27451 \begin_layout Plain Layout
27452 {%export%[[true]][[false]]}
27459 \begin_inset Quotes eld
27463 \begin_inset Quotes erd
27466 part for export and menus,
27468 \begin_inset Quotes eld
27472 \begin_inset Quotes erd
27475 part for other contexts (workarea,
27479 \begin_layout Itemize
27480 \begin_inset Flex Code
27483 \begin_layout Plain Layout
27491 \begin_inset Quotes eld
27495 \begin_inset Quotes erd
27498 part if another item follows (e.
27499 \begin_inset space \thinspace{}
27503 in a citation with multiple keys)
27506 \begin_layout Itemize
27507 \begin_inset Flex Code
27510 \begin_layout Plain Layout
27511 {%second%[[true]][[false]]}
27518 \begin_inset Quotes eld
27522 \begin_inset Quotes erd
27525 if this is the second of multiple items,
27527 \begin_inset Quotes eld
27531 \begin_inset Quotes erd
27537 \begin_layout Itemize
27538 \begin_inset Flex Code
27541 \begin_layout Plain Layout
27542 {%ifstar%[[true]][[false]]}
27549 \begin_inset Quotes eld
27553 \begin_inset Quotes erd
27556 part for starred citation commands (such as
27557 \begin_inset Flex Code
27560 \begin_layout Plain Layout
27569 the false part for unstarred
27572 \begin_layout Itemize
27573 \begin_inset Flex Code
27576 \begin_layout Plain Layout
27577 {%ifentrytype:<type>%[[true]][[false]]}
27584 \begin_inset Quotes eld
27588 \begin_inset Quotes erd
27591 if the current entry type matches
27592 \begin_inset Flex Code
27595 \begin_layout Plain Layout
27602 else the false part (e.g.,
27603 in a citation definition:
27605 \begin_inset Flex Code
27608 \begin_layout Plain Layout
27609 {%ifentrytype:book%[[this is a book]][[this is no book]]}
27617 \begin_layout Itemize
27618 \begin_inset Flex Code
27621 \begin_layout Plain Layout
27622 {%ifmultiple:<authortype>%[[true]][[false]]}
27629 \begin_inset Quotes eld
27633 \begin_inset Quotes erd
27636 if the current author type (author,
27637 editor etc.) has multiple authors,
27638 else the false part (e.g.,
27639 in a bibliography definition:
27641 \begin_inset Flex Code
27644 \begin_layout Plain Layout
27645 {%ifmultiple:editor%[[eds.]][[ed.]]}
27653 \begin_layout Itemize
27654 \begin_inset Flex Code
27657 \begin_layout Plain Layout
27658 {%ifqualified%[[true]][[false]]}
27665 \begin_inset Quotes eld
27669 \begin_inset Quotes erd
27672 part if the current citation is a qualified citation list (a specific
27676 format for multi-reference citations),
27677 the false part if this is not the case.
27680 \begin_layout Standard
27682 \begin_inset Flex Code
27685 \begin_layout Plain Layout
27691 prints the author key as it is recorded in the bibliography file.
27692 This might not be what you want,
27693 since it will result in a string such as
27694 \begin_inset Quotes eld
27701 \begin_inset Quotes erd
27705 \begin_inset Quotes eld
27709 \begin_inset Quotes erd
27712 is used by Bib\SpecialChar TeX
27713 to delimit authors).
27715 therefore provides some methods to get properly formatted name lists (which will also get translated).
27716 The following keys are provided:
27719 \begin_layout Enumerate
27720 For name lists with pre- and surname,
27721 suitable for the main authors/editors of a bibliography item.
27723 \begin_inset Flex Code
27726 \begin_layout Plain Layout
27732 part denotes the kind of list that is requested (e.g.
27734 \begin_inset Flex Code
27737 \begin_layout Plain Layout
27747 \begin_layout Itemize
27748 \begin_inset Flex Code
27751 \begin_layout Plain Layout
27752 %abbrvnames:<nametype>%
27758 Provides a name list which is abbreviated (with
27759 \begin_inset Quotes eld
27763 \begin_inset Quotes erd
27767 \begin_inset Flex Code
27770 \begin_layout Plain Layout
27779 \begin_layout Itemize
27780 \begin_inset Flex Code
27783 \begin_layout Plain Layout
27784 %fullnames:<nametype>%
27790 Provides a full name list (never abbreviated with
27791 \begin_inset Quotes eld
27795 \begin_inset Quotes erd
27801 \begin_layout Itemize
27802 \begin_inset Flex Code
27805 \begin_layout Plain Layout
27806 %forceabbrvnames:<nametype>%
27812 Provides a name list which is always abbreviated (with
27813 \begin_inset Quotes eld
27817 \begin_inset Quotes erd
27821 \begin_inset Flex Code
27824 \begin_layout Plain Layout
27834 \begin_layout Enumerate
27835 Alternative name lists with pre- and surname,
27836 if the order of pre- and surname inside the bibliography item differs (as in:
27838 \begin_inset Quotes eld
27848 \begin_inset Quotes erd
27855 \begin_layout Itemize
27856 \begin_inset Flex Code
27859 \begin_layout Plain Layout
27860 %abbrvbynames:<nametype>%
27866 Provides a name list which is abbreviated (with
27867 \begin_inset Quotes eld
27871 \begin_inset Quotes erd
27875 \begin_inset Flex Code
27878 \begin_layout Plain Layout
27887 \begin_layout Itemize
27888 \begin_inset Flex Code
27891 \begin_layout Plain Layout
27892 %fullbynames:<nametype>%
27898 Provides a full name list (never abbreviated with
27899 \begin_inset Quotes eld
27903 \begin_inset Quotes erd
27909 \begin_layout Itemize
27910 \begin_inset Flex Code
27913 \begin_layout Plain Layout
27914 %forceabbrvbynames:<nametype>%
27920 Provides a name list which is always abbreviated (with
27921 \begin_inset Quotes eld
27925 \begin_inset Quotes erd
27929 \begin_inset Flex Code
27932 \begin_layout Plain Layout
27942 \begin_layout Enumerate
27943 And finally name lists which consist of family names only,
27944 as used in author-year citation labels.
27945 These do not take a
27946 \begin_inset Flex Code
27949 \begin_layout Plain Layout
27956 but always return either an author list or,
27957 if this does not exist,
27958 an editor list (as common in author-year labels):
27962 \begin_layout Itemize
27963 \begin_inset Flex Code
27966 \begin_layout Plain Layout
27973 Provides a name list which is abbreviated (with
27974 \begin_inset Quotes eld
27978 \begin_inset Quotes erd
27982 \begin_inset Flex Code
27985 \begin_layout Plain Layout
27994 \begin_layout Itemize
27995 \begin_inset Flex Code
27998 \begin_layout Plain Layout
28005 Provides a full name list (never abbreviated with
28006 \begin_inset Quotes eld
28010 \begin_inset Quotes erd
28016 \begin_layout Itemize
28017 \begin_inset Flex Code
28020 \begin_layout Plain Layout
28021 %forceabbrvciteauthor%
28027 Provides a name list which is always abbreviated (with
28028 \begin_inset Quotes eld
28032 \begin_inset Quotes erd
28036 \begin_inset Flex Code
28039 \begin_layout Plain Layout
28049 \begin_layout Standard
28050 The order of pre- and surname in the former two lists can be adjusted by these macros:
28053 \begin_layout Itemize
28054 \begin_inset Flex Code
28057 \begin_layout Plain Layout
28058 !firstnameform %surname%,
28064 (first author in lists of type 1)
28067 \begin_layout Itemize
28068 \begin_inset Flex Code
28071 \begin_layout Plain Layout
28072 !othernameform %surname%,
28078 (other authors in lists of type 1)
28081 \begin_layout Itemize
28082 \begin_inset Flex Code
28085 \begin_layout Plain Layout
28086 !firstbynameform %prename% %surname%
28091 (first author in lists of type 2)
28094 \begin_layout Itemize
28095 \begin_inset Flex Code
28098 \begin_layout Plain Layout
28099 !otherbynameform %prename% %surname%
28104 (other authors in lists of type 2)
28107 \begin_layout Standard
28108 This allows you to configure namings like
28109 \begin_inset Quotes eld
28113 Peter and Mary Smith:
28117 John Doe and Pat Green,
28118 eds.:\SpecialChar ldots
28120 \begin_inset Quotes erd
28126 \begin_layout Standard
28127 There is one other piece of syntax available in definitions,
28128 which looks like this:
28130 \begin_inset Flex Code
28133 \begin_layout Plain Layout
28140 This defines a piece of formatting information that is to be used when creating
28141 \begin_inset Quotes eld
28145 \begin_inset Quotes erd
28150 we do not want to output HTML tags when writing plain text,
28151 so they should be wrapped in
28152 \begin_inset Quotes eld
28156 \begin_inset Quotes erd
28160 \begin_inset Quotes eld
28164 \begin_inset Quotes erd
28170 \begin_layout Standard
28171 Two special sorts of definitions are also possible in a
28172 \begin_inset Flex Code
28175 \begin_layout Plain Layout
28182 An example of the first would be:
28185 \begin_layout LyX-Code
28187 \begin_inset Quotes eld
28191 \begin_inset Quotes erd
28197 \begin_layout Standard
28198 This is an abbreviation,
28200 and it can be used by treating it as if it were a key:
28202 \begin_inset Flex Code
28205 \begin_layout Plain Layout
28214 \begin_inset Flex Code
28217 \begin_layout Plain Layout
28223 exactly as it would treat its definition.
28225 let us issue the obvious
28233 \begin_layout LyX-Code
28237 \begin_layout Standard
28238 or anything like it.
28240 shouldn't go into an infinite loop,
28241 but it may go into a long one before it gives up.
28244 \begin_layout Standard
28245 The second sort of special definition might look like this:
28248 \begin_layout LyX-Code
28252 \begin_layout Standard
28253 This defines a translatable piece of text,
28254 which allows relevant parts of the bibliography or citation to be translated.
28255 It can be included in a definition by treating it as a key:
28257 \begin_inset Flex Code
28260 \begin_layout Plain Layout
28267 Note that there are two different translation paths:
28268 All definitions starting with
28269 \begin_inset Flex Code
28272 \begin_layout Plain Layout
28279 such as in the example above,
28280 will be translated to the currently active buffer language (so the translation will match the generated document).
28281 All definitions starting with underscore only will be translated to the GUI language.
28282 This is the proper translation for strings that only occur in the dialogs or on buttons,
28286 \begin_layout LyX-Code
28287 _addtobib Add to bibliography only.
28290 \begin_layout Standard
28291 Several of these translatable strings are predefined in
28292 \begin_inset Flex Code
28295 \begin_layout Plain Layout
28302 \begin_inset Flex Code
28305 \begin_layout Plain Layout
28312 Note that these are not macros,
28313 in the sense just defined.
28314 They will not be expanded.
28317 \begin_layout Standard
28318 So here then is an example that uses several of these features:
28319 \begin_inset VSpace defskip
28325 \begin_layout Standard
28329 !authoredit {%author%[[%author%,
28330 ]][[{%editor%[[%editor%,
28335 \begin_layout Standard
28336 \begin_inset VSpace defskip
28339 This defines a macro that prints the author,
28340 followed by a comma,
28342 \begin_inset Flex Code
28345 \begin_layout Plain Layout
28352 or else prints the name of the editor,
28354 \begin_inset Flex Code
28357 \begin_layout Plain Layout
28363 or its translation (it is by default
28364 \begin_inset Quotes eld
28368 \begin_inset Quotes erd
28373 \begin_inset Flex Code
28376 \begin_layout Plain Layout
28383 Note that this is in fact defined in
28384 \begin_inset Flex Code
28387 \begin_layout Plain Layout
28394 so you can use it in your own definitions,
28396 if you load that file first.
28399 \begin_layout Section
28400 \begin_inset CommandInset label
28402 name "sec:Tags-for-XHTML"
28406 Tags for XHTML output
28409 \begin_layout Standard
28410 As with \SpecialChar LaTeX
28412 the format of \SpecialChar LyX
28413 's XHTML output is also controlled by layout information.
28416 provides sensible defaults and,
28417 as mentioned earlier,
28418 it will even construct default CSS style rules from the other layout tags.
28421 will attempt to use the information provided in the
28422 \begin_inset Flex Code
28425 \begin_layout Plain Layout
28431 declaration for the Chapter style to write CSS that will appropriately format chapter headings.
28434 \begin_layout Standard
28437 you may not have to do anything at all to get acceptable XHTML output for your own environments,
28440 But in some cases you will,
28441 and so \SpecialChar LyX
28442 provides a number of layout tags that can be used to customize the XHTML and CSS that are generated.
28445 \begin_layout Standard
28446 Note that there are two tags,
28448 \begin_inset Flex Code
28451 \begin_layout Plain Layout
28458 \begin_inset Flex Code
28461 \begin_layout Plain Layout
28467 that may appear outside style and inset declarations.
28469 \begin_inset CommandInset ref
28471 reference "subsec:General-text-class"
28476 for details on these.
28479 \begin_layout Subsection
28480 \begin_inset CommandInset label
28482 name "subsec:Paragraph-Style-XHTML"
28489 \begin_layout Standard
28490 The sort of XHTML \SpecialChar LyX
28491 outputs for a paragraph depends upon whether we are dealing with a normal paragraph,
28494 where this is itself determined by the contents of the corresponding
28495 \begin_inset Flex Code
28498 \begin_layout Plain Layout
28509 \begin_layout Standard
28510 For a command or normal paragraph,
28511 the output XHTML has the following form:
28514 \begin_layout LyX-Code
28518 \begin_inset Quotes erd
28522 \begin_inset Quotes erd
28528 \begin_layout LyX-Code
28532 \begin_inset Quotes erd
28536 \begin_inset Quotes erd
28542 \begin_layout LyX-Code
28545 Contents of the paragraph.
28548 \begin_layout LyX-Code
28554 \begin_layout Standard
28555 The label tags are of course omitted if the paragraph does not have a label.
28558 \begin_layout Standard
28559 For an environment that is not some sort of list,
28560 the XHTML takes this form:
28563 \begin_layout LyX-Code
28567 \begin_inset Quotes erd
28571 \begin_inset Quotes erd
28577 \begin_layout LyX-Code
28581 \begin_inset Quotes erd
28585 \begin_inset Quotes erd
28589 \begin_inset Quotes erd
28593 \begin_inset Quotes erd
28596 >Environment Label</labeltag>First paragraph.</itemtag>
28599 \begin_layout LyX-Code
28602 <itemtag>Second paragraph.</itemtag>
28605 \begin_layout LyX-Code
28611 \begin_layout Standard
28612 Note that the label is output only for the first paragraph,
28613 as it should be for a theorem,
28618 \begin_layout Standard
28620 we have one of these forms:
28623 \begin_layout LyX-Code
28627 \begin_inset Quotes erd
28631 \begin_inset Quotes erd
28637 \begin_layout LyX-Code
28641 \begin_inset Quotes erd
28645 \begin_inset Quotes erd
28649 \begin_inset Quotes erd
28653 \begin_inset Quotes erd
28656 >List Label</labeltag>First item.</itemtag>
28659 \begin_layout LyX-Code
28663 \begin_inset Quotes erd
28667 \begin_inset Quotes erd
28671 \begin_inset Quotes erd
28675 \begin_inset Quotes erd
28678 >List Label</labeltag>Second item.</itemtag>
28681 \begin_layout LyX-Code
28687 \begin_layout LyX-Code
28691 \begin_layout LyX-Code
28695 \begin_inset Quotes erd
28699 \begin_inset Quotes erd
28705 \begin_layout LyX-Code
28709 \begin_inset Quotes erd
28713 \begin_inset Quotes erd
28716 >List Label</labeltag><itemtag attr=
28717 \begin_inset Quotes erd
28721 \begin_inset Quotes erd
28724 >First item.</itemtag>
28727 \begin_layout LyX-Code
28731 \begin_inset Quotes erd
28735 \begin_inset Quotes erd
28738 >List Label</labeltag><itemtag attr=
28739 \begin_inset Quotes erd
28743 \begin_inset Quotes erd
28746 >Second item.</itemtag>
28749 \begin_layout LyX-Code
28755 \begin_layout Standard
28756 Note the different orders of
28757 \begin_inset Flex Code
28760 \begin_layout Plain Layout
28767 \begin_inset Flex Code
28770 \begin_layout Plain Layout
28777 Which order we get depends upon the setting of
28778 \begin_inset Flex Code
28781 \begin_layout Plain Layout
28789 \begin_inset Flex Code
28792 \begin_layout Plain Layout
28798 is false (the default),
28799 you get the first of these,
28800 with the label within the item;
28802 you get the second,
28803 with the label outside the item.
28806 \begin_layout Standard
28807 The specific tags and attributes output for each paragraph type can be controlled by means of the layout tags we are about to describe.
28808 As mentioned earlier,
28811 uses sensible defaults for many of these,
28812 so you often may not need to do very much to get good XHTML output.
28813 Think of the available tags as there so you can tweak things to your liking.
28816 \begin_layout Description
28817 \begin_inset Flex Code
28820 \begin_layout Plain Layout
28827 \begin_inset Flex Code
28830 \begin_layout Plain Layout
28836 ] Specifies attribute information to be output with the main tag.
28839 \begin_inset Quotes eld
28843 \begin_inset Flex Code
28846 \begin_layout Plain Layout
28853 \begin_inset Quotes erd
28860 \begin_inset Quotes eld
28864 \begin_inset Flex Code
28867 \begin_layout Plain Layout
28874 \begin_inset Quotes erd
28879 \begin_inset Flex Code
28882 \begin_layout Plain Layout
28888 is the \SpecialChar LyX
28889 name of the layout,
28897 contain any style information.
28899 \begin_inset Flex Code
28902 \begin_layout Plain Layout
28909 \change_inserted -584632292 1670182206
28913 \begin_layout Description
28915 \change_inserted -584632292 1670182369
28916 \begin_inset Flex Code
28919 \begin_layout Plain Layout
28921 \change_inserted -584632292 1670182222
28930 \begin_inset Flex Code
28933 \begin_layout Plain Layout
28935 \change_inserted -584632292 1670182217
28943 ] The CSS class to use for this paragraph.
28945 if the paragarph is of enumerate or itemize type,
28946 then the default will be
28947 \begin_inset Quotes eld
28951 \begin_inset Quotes erd
28955 \begin_inset Quotes eld
28959 \begin_inset Quotes erd
28964 \begin_inset Quotes eld
28968 \begin_inset Quotes erd
28973 \begin_inset Quotes eld
28977 \begin_inset Quotes erd
28982 \begin_inset Quotes eld
28986 \begin_inset Quotes erd
28991 \begin_inset Quotes eld
28995 \begin_inset Quotes erd
28999 depending upon the depth.
29000 That can be over-ridden here.
29002 the suffix will not be added in that case.
29004 the CSS class will always be exactly what it is declared to be here.
29009 \begin_layout Description
29010 \begin_inset Flex Code
29013 \begin_layout Plain Layout
29020 \begin_inset Flex Code
29023 \begin_layout Plain Layout
29033 ] Whether to output the default CSS information \SpecialChar LyX
29034 generates for this layout,
29035 even if additional information is explicitly provided via
29036 \begin_inset Flex Code
29039 \begin_layout Plain Layout
29047 \begin_inset Flex Code
29050 \begin_layout Plain Layout
29056 allows you to alter or augment the generated CSS,
29057 rather than to override it completely.
29059 \begin_inset Flex Code
29062 \begin_layout Plain Layout
29069 \change_inserted -584632292 1670132213
29073 \begin_layout Description
29075 \change_inserted -584632292 1670132277
29076 \begin_inset Flex Code
29079 \begin_layout Plain Layout
29081 \change_inserted -584632292 1670132221
29090 \begin_inset Flex Code
29093 \begin_layout Plain Layout
29095 \change_inserted -584632292 1670132214
29105 ] Whether to include this paragraph (usually,
29106 a section or something of the sort) in the TOC.
29109 so it should be set to false e.g.
29110 \begin_inset space ~
29113 for starred sections.
29118 \begin_layout Description
29119 \begin_inset Flex Code
29122 \begin_layout Plain Layout
29129 \begin_inset Flex Code
29132 \begin_layout Plain Layout
29138 ] The tag to be used for individual paragraphs of environments,
29140 \begin_inset Flex Code
29143 \begin_layout Plain Layout
29149 in the examples above.
29151 \begin_inset Flex Code
29154 \begin_layout Plain Layout
29163 \begin_layout Description
29164 \begin_inset Flex Code
29167 \begin_layout Plain Layout
29174 \begin_inset Flex Code
29177 \begin_layout Plain Layout
29183 ] Attributes for the item tag.
29185 \begin_inset Newline newline
29189 \begin_inset Quotes eld
29193 \begin_inset Flex Code
29196 \begin_layout Plain Layout
29197 class=`layoutname_item'
29203 \begin_inset Quotes erd
29211 contain any style information.
29213 \begin_inset Flex Code
29216 \begin_layout Plain Layout
29225 \begin_layout Description
29226 \begin_inset Flex Code
29229 \begin_layout Plain Layout
29236 \begin_inset Flex Code
29239 \begin_layout Plain Layout
29245 ] The tag to be used for paragraph and item labels,
29247 \begin_inset Flex Code
29250 \begin_layout Plain Layout
29256 in the examples above.
29258 \begin_inset Flex Code
29261 \begin_layout Plain Layout
29269 \begin_inset Flex Code
29272 \begin_layout Plain Layout
29279 \begin_inset Flex Code
29282 \begin_layout Plain Layout
29289 \begin_inset Flex Code
29292 \begin_layout Plain Layout
29293 Centered_Top_Environment
29299 in which case it defaults to
29300 \begin_inset Flex Code
29303 \begin_layout Plain Layout
29312 \begin_layout Description
29313 \begin_inset Flex Code
29316 \begin_layout Plain Layout
29323 \begin_inset Flex Code
29326 \begin_layout Plain Layout
29332 ] Attributes for the label tag.
29334 \begin_inset Newline newline
29338 \begin_inset Quotes eld
29342 \begin_inset Flex Code
29345 \begin_layout Plain Layout
29346 class=`layoutname_label'
29352 \begin_inset Quotes erd
29360 contain any style information.
29362 \begin_inset Flex Code
29365 \begin_layout Plain Layout
29374 \begin_layout Description
29375 \begin_inset Flex Code
29378 \begin_layout Plain Layout
29385 \begin_inset Flex Code
29388 \begin_layout Plain Layout
29398 ] Meaningful only for list-like environments,
29399 this tag controls whether the label tag is output before or inside the item tag.
29402 in the description environment,
29404 \begin_inset Flex Code
29407 \begin_layout Plain Layout
29408 <dt>\SpecialChar ldots
29409 </dt><dd>\SpecialChar ldots
29417 \begin_inset Flex Code
29420 \begin_layout Plain Layout
29427 The label tag is output inside the item tag.
29430 \begin_layout Description
29431 \begin_inset Flex Code
29434 \begin_layout Plain Layout
29440 Information to be output in the
29441 \begin_inset Flex Code
29444 \begin_layout Plain Layout
29450 section when this style is used.
29453 be used to include a
29454 \begin_inset Flex Code
29457 \begin_layout Plain Layout
29464 \begin_inset Flex Code
29467 \begin_layout Plain Layout
29476 \begin_layout Description
29477 \begin_inset Flex Code
29480 \begin_layout Plain Layout
29486 CSS style information to be included when this style is used.
29487 Note that this will automatically be wrapped in a layout-generated
29488 \begin_inset Flex Code
29491 \begin_layout Plain Layout
29498 so only the CSS itself need be included.
29500 \begin_inset Flex Code
29503 \begin_layout Plain Layout
29512 \begin_layout Description
29513 \begin_inset Flex Code
29516 \begin_layout Plain Layout
29523 \begin_inset Flex Code
29526 \begin_layout Plain Layout
29532 ] The tag to be used for the main label,
29534 \begin_inset Flex Code
29537 \begin_layout Plain Layout
29543 in the examples above.
29545 \begin_inset Flex Code
29548 \begin_layout Plain Layout
29557 \begin_layout Description
29558 \begin_inset Flex Code
29561 \begin_layout Plain Layout
29568 \begin_inset Flex Code
29571 \begin_layout Plain Layout
29581 ] Marks this style as the one to be used to generate the
29582 \begin_inset Flex Code
29585 \begin_layout Plain Layout
29591 tag for the XHTML file.
29595 \begin_inset Flex Code
29598 \begin_layout Plain Layout
29604 file sets it to true for the
29605 \begin_inset Flex Code
29608 \begin_layout Plain Layout
29618 \begin_layout Subsection
29622 \begin_layout Standard
29623 The XHTML output of insets can also be controlled by information in layout files.
29627 \begin_layout Plain Layout
29629 this is true only for
29630 \begin_inset Quotes eld
29634 \begin_inset Quotes erd
29637 insets (insets you can type into) and is not true for
29638 \begin_inset Quotes eld
29642 \begin_inset Quotes erd
29645 insets (insets that are associated with dialog boxes).
29653 tries to provide sensible defaults,
29654 and it constructs default CSS style rules.
29655 But everything can be customized.
29658 \begin_layout Standard
29659 The XHTML \SpecialChar LyX
29660 outputs for an inset has the following form:
29663 \begin_layout LyX-Code
29665 \begin_inset Quotes erd
29669 \begin_inset Quotes erd
29675 \begin_layout LyX-Code
29676 <labeltag>Label</labeltag>
29679 \begin_layout LyX-Code
29681 \begin_inset Quotes erd
29685 \begin_inset Quotes erd
29688 >Contents of the inset.</innertag>
29691 \begin_layout LyX-Code
29695 \begin_layout Standard
29696 If the inset permits multiple paragraphs—
29699 \begin_inset Flex Code
29702 \begin_layout Plain Layout
29709 then the contents of the inset will itself be output as paragraphs formatted according to the styles used for those paragraphs (standard,
29712 The label tag is of course omitted if the paragraph does not have a label and,
29715 \begin_inset Flex Code
29718 \begin_layout Plain Layout
29725 The inner tag is optional and,
29730 \begin_layout Standard
29731 The specific tags and attributes output for each inset can be controlled by means of the following layout tags.
29734 \begin_layout Description
29735 \begin_inset Flex Code
29738 \begin_layout Plain Layout
29745 \begin_inset Flex Code
29748 \begin_layout Plain Layout
29754 ] Specifies attribute information to be output with the main tag.
29757 \begin_inset Quotes eld
29761 \begin_inset Flex Code
29764 \begin_layout Plain Layout
29765 class=`myinset' onclick=`\SpecialChar ldots
29772 \begin_inset Quotes erd
29779 \begin_inset Quotes eld
29783 \begin_inset Flex Code
29786 \begin_layout Plain Layout
29793 \begin_inset Quotes erd
29798 \begin_inset Flex Code
29801 \begin_layout Plain Layout
29807 is the \SpecialChar LyX
29809 made lowercase and with non-alphanumeric characters converted to underscores,
29814 \begin_layout Description
29815 \begin_inset Flex Code
29818 \begin_layout Plain Layout
29825 \begin_inset Flex Code
29828 \begin_layout Plain Layout
29838 ] Whether to output the default CSS information \SpecialChar LyX
29839 generates for this layout,
29840 even if additional information is explicitly provided via
29841 \begin_inset Flex Code
29844 \begin_layout Plain Layout
29852 \begin_inset Flex Code
29855 \begin_layout Plain Layout
29861 allows you to alter or augment the generated CSS,
29862 rather than to override it completely.
29866 \begin_layout Description
29867 \begin_inset Flex Code
29870 \begin_layout Plain Layout
29877 \begin_inset Flex Code
29880 \begin_layout Plain Layout
29886 ] Attributes for the inner tag.
29888 \begin_inset Newline newline
29892 \begin_inset Quotes eld
29896 \begin_inset Flex Code
29899 \begin_layout Plain Layout
29900 class=`insetname_inner'
29906 \begin_inset Quotes erd
29912 \begin_layout Description
29913 \begin_inset Flex Code
29916 \begin_layout Plain Layout
29923 \begin_inset Flex Code
29926 \begin_layout Plain Layout
29934 \begin_inset Flex Code
29937 \begin_layout Plain Layout
29943 in the examples above.
29948 \begin_layout Description
29949 \begin_inset Flex Code
29952 \begin_layout Plain Layout
29959 \begin_inset Flex Code
29962 \begin_layout Plain Layout
29970 ] 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).
29974 \begin_layout Description
29975 \begin_inset Flex Code
29978 \begin_layout Plain Layout
29985 \begin_inset Flex Code
29988 \begin_layout Plain Layout
29994 ] A label for this inset,
29995 possibly including a reference to a counter.
30000 \begin_inset Flex Code
30003 \begin_layout Plain Layout
30013 and there is no default.
30016 \begin_layout Description
30017 \begin_inset Flex Code
30020 \begin_layout Plain Layout
30026 Information to be output in the
30027 \begin_inset Flex Code
30030 \begin_layout Plain Layout
30036 section when this style is used.
30039 be used to include a
30040 \begin_inset Flex Code
30043 \begin_layout Plain Layout
30050 \begin_inset Flex Code
30053 \begin_layout Plain Layout
30062 \begin_layout Description
30063 \begin_inset Flex Code
30066 \begin_layout Plain Layout
30072 CSS style information to be included when this style is used.
30073 Note that this will automatically be wrapped in a layout-generated
30074 \begin_inset Flex Code
30077 \begin_layout Plain Layout
30084 so only the CSS itself need be included.
30087 \begin_layout Description
30088 \begin_inset Flex Code
30091 \begin_layout Plain Layout
30098 \begin_inset Flex Code
30101 \begin_layout Plain Layout
30107 ] The tag to be used for the main label,
30109 \begin_inset Flex Code
30112 \begin_layout Plain Layout
30118 in the examples above.
30119 The default depends upon the setting of
30120 \begin_inset Flex Code
30123 \begin_layout Plain Layout
30131 \begin_inset Flex Code
30134 \begin_layout Plain Layout
30142 \begin_inset Flex Code
30145 \begin_layout Plain Layout
30154 \begin_inset Flex Code
30157 \begin_layout Plain Layout
30166 \begin_layout Subsection
30170 \begin_layout Standard
30171 The XHTML output for floats too can be controlled by layout information.
30172 The output has the following form:
30175 \begin_layout LyX-Code
30177 \begin_inset Quotes erd
30181 \begin_inset Quotes erd
30187 \begin_layout LyX-Code
30188 Contents of the float.
30191 \begin_layout LyX-Code
30195 \begin_layout Standard
30198 is a separate inset and will be output as such.
30199 Its appearance can be controlled via the InsetLayout for caption insets.
30203 \begin_layout Description
30204 \begin_inset Flex Code
30207 \begin_layout Plain Layout
30214 \begin_inset Flex Code
30217 \begin_layout Plain Layout
30223 ] Specifies attribute information to be output with the main tag.
30226 \begin_inset Quotes eld
30230 \begin_inset Flex Code
30233 \begin_layout Plain Layout
30234 class=`myfloat' onclick=`\SpecialChar ldots
30241 \begin_inset Quotes erd
30248 \begin_inset Quotes eld
30252 \begin_inset Flex Code
30255 \begin_layout Plain Layout
30256 class=`float float-floattype'
30262 \begin_inset Quotes erd
30267 \begin_inset Flex Code
30270 \begin_layout Plain Layout
30276 is \SpecialChar LyX
30277 's name for this type of float,
30278 as determined by the float declaration (see
30279 \begin_inset CommandInset ref
30281 reference "subsec:Floats"
30287 though made lowercase and with non-alphanumeric characters converted to underscores,
30292 \begin_layout Description
30293 \begin_inset Flex Code
30296 \begin_layout Plain Layout
30302 CSS style information to be included when this float is used.
30303 Note that this will automatically be wrapped in a layout-generated
30304 \begin_inset Flex Code
30307 \begin_layout Plain Layout
30314 so only the CSS itself need be included.
30317 \begin_layout Description
30318 \begin_inset Flex Code
30321 \begin_layout Plain Layout
30328 \begin_inset Flex Code
30331 \begin_layout Plain Layout
30337 ] The tag to be used for this float,
30339 \begin_inset Quotes eld
30343 \begin_inset Flex Code
30346 \begin_layout Plain Layout
30353 \begin_inset Quotes erd
30356 in the example above.
30358 \begin_inset Flex Code
30361 \begin_layout Plain Layout
30367 and will rarely need changing.
30370 \begin_layout Subsection
30371 Bibliography formatting
30374 \begin_layout Standard
30375 The bibliography can be formatted using
30376 \begin_inset Flex Code
30379 \begin_layout Plain Layout
30387 \begin_inset CommandInset ref
30389 reference "subsec:Citation-format-description"
30397 \begin_layout Subsection
30402 \begin_layout Standard
30403 We have several times mentioned that \SpecialChar LyX
30404 will generate default CSS style rules for both insets and paragraph styles,
30405 based upon the other layout information that is provided.
30407 we shall say a word about which layout information \SpecialChar LyX
30411 \begin_layout Standard
30414 auto-generates CSS only for font information,
30416 \begin_inset Flex Code
30419 \begin_layout Plain Layout
30427 \begin_inset Flex Code
30430 \begin_layout Plain Layout
30438 \begin_inset Flex Code
30441 \begin_layout Plain Layout
30449 \begin_inset Flex Code
30452 \begin_layout Plain Layout
30459 \begin_inset Flex Code
30462 \begin_layout Plain Layout
30469 \begin_inset CommandInset ref
30471 reference "subsec:Font-description"
30477 The translation is mostly straightforward and obvious.
30480 \begin_inset Quotes eld
30484 \begin_inset Flex Code
30487 \begin_layout Plain Layout
30494 \begin_inset Quotes erd
30498 \begin_inset Quotes eld
30502 \begin_inset Flex Code
30505 \begin_layout Plain Layout
30513 \begin_inset Quotes erd
30517 The correspondence of \SpecialChar LyX
30518 sizes and CSS sizes is a little less obvious but nonetheless intuitive.
30520 \begin_inset Flex Code
30523 \begin_layout Plain Layout
30530 \begin_inset Flex URL
30533 \begin_layout Plain Layout
30541 \change_inserted -970929547 1496610908
30545 \begin_layout Section
30547 \change_inserted -970929547 1496610966
30548 \begin_inset CommandInset label
30550 name "sec:Tags-for-DocBook"
30554 Tags for DocBook output
30557 \begin_layout Standard
30559 \change_inserted -970929547 1496611615
30560 As with \SpecialChar LaTeX
30562 the format of \SpecialChar LyX
30563 's DocBook output is also controlled by layout information.
30566 provides sensible defaults;
30568 much of the styling is lost during the conversion,
30569 as DocBook is strictly semantic and does not allow formatting.
30571 information from \SpecialChar LyX
30572 will be rendered in
30580 \begin_layout Standard
30582 \change_inserted -970929547 1496612080
30585 you may not have to do anything at all to get acceptable DocBook output for your own environments,
30588 But in some cases you will,
30589 and so \SpecialChar LyX
30590 provides a number of layout tags that can be used to customize the DocBook that is generated.
30593 \begin_layout Standard
30595 \change_inserted -970929547 1515109912
30596 Labels are rarely output,
30597 as they are redundant in DocBook:
30598 this information is carried by the tags themselves,
30599 and whether labels appear in the final documents (after processing of DocBook files) is controlled by the stylesheets.
30602 labels are not redundant content,
30603 such as definition lists:
30605 the term being defined will be the label.
30609 \begin_layout Subsection
30611 \change_inserted 1075283030 1597699417
30612 \begin_inset CommandInset label
30614 name "subsec:Paragraph-Style-DocBook"
30619 \change_deleted 1075283030 1597699417
30621 \begin_inset CommandInset label
30623 name "subsec:Paragraph-Style-XHTML-1"
30628 \change_inserted -970929547 1496610966
30632 \begin_layout Standard
30634 \change_inserted -970929547 1496612059
30635 The sort of DocBook \SpecialChar LyX
30636 outputs for a paragraph depends upon whether we are dealing with a normal paragraph,
30639 where this is itself determined by the contents of the corresponding
30640 \begin_inset Flex Code
30643 \begin_layout Plain Layout
30645 \change_inserted -970929547 1496610966
30658 \begin_layout Standard
30660 \change_inserted -970929547 1496612107
30661 For a command or normal paragraph,
30662 the output DocBook has the following form:
30665 \begin_layout LyX-Code
30667 \change_inserted -970929547 1515109666
30671 \begin_layout LyX-Code
30673 \change_inserted -970929547 1496610966
30674 Contents of the paragraph.
30677 \begin_layout LyX-Code
30679 \change_inserted -970929547 1496610966
30683 \begin_layout Standard
30685 \change_inserted -970929547 1515109821
30686 For an environment that is not some sort of list,
30687 the generated DocBook takes this form:
30690 \begin_layout LyX-Code
30692 \change_inserted -970929547 1515109671
30696 \begin_layout LyX-Code
30698 \change_inserted -970929547 1496612114
30699 <itemtag>First paragraph.</itemtag>
30702 \begin_layout LyX-Code
30704 \change_inserted -970929547 1496610966
30705 <itemtag>Second paragraph.</itemtag>
30708 \begin_layout LyX-Code
30710 \change_inserted -970929547 1496610966
30714 \begin_layout Standard
30716 \change_inserted -970929547 1515109825
30718 the resulting DocBook takes this form:
30721 \begin_layout LyX-Code
30723 \change_inserted -970929547 1515109672
30727 \begin_layout LyX-Code
30729 \change_inserted -970929547 1515109676
30730 <itemtag attr>First item.</itemtag>
30733 \begin_layout LyX-Code
30735 \change_inserted -970929547 1515109678
30736 <itemtag attr>Second item.</itemtag>
30739 \begin_layout LyX-Code
30741 \change_inserted -970929547 1496610966
30745 \begin_layout Standard
30747 \change_inserted -970929547 1496612243
30748 The specific tags and roles output for each paragraph type can be controlled by means of the layout tags we are about to describe.
30750 due to the very nature of DocBook,
30751 no sensible defaults really exist,
30752 and the values must always be carefully chosen.
30756 \begin_layout Description
30758 \change_inserted -970929547 1515110057
30759 \begin_inset Flex Code
30762 \begin_layout Plain Layout
30764 \change_inserted -970929547 1515109656
30773 \begin_inset Flex Code
30776 \begin_layout Plain Layout
30778 \change_inserted -970929547 1496610966
30786 ] Specifies attribute information to be output with the main tag,
30788 \begin_inset Quotes eld
30792 \begin_inset Flex Code
30795 \begin_layout Plain Layout
30797 \change_inserted -970929547 1515110057
30806 \begin_inset Quotes erd
30809 in the example above.
30810 This information can be used in further processing of the DocBook files.
30816 \begin_layout Description
30818 \change_inserted -970929547 1496612296
30819 \begin_inset Flex Code
30822 \begin_layout Plain Layout
30824 \change_inserted -970929547 1496612269
30833 \begin_inset Flex Code
30836 \begin_layout Plain Layout
30838 \change_inserted -970929547 1496610966
30846 ] The tag to be used for this inset,
30848 \begin_inset Quotes eld
30852 \begin_inset Flex Code
30855 \begin_layout Plain Layout
30857 \change_inserted -970929547 1496612296
30866 \begin_inset Quotes erd
30869 in the example above.
30870 The default is the name of the float and always needs to be changed,
30871 as DocBook provides no generic tag.
30872 \change_inserted 1075283030 1597698868
30876 \begin_layout Description
30878 \change_inserted 1075283030 1597699399
30879 \begin_inset Flex Code
30882 \begin_layout Plain Layout
30884 \change_inserted 1075283030 1597698872
30893 \begin_inset Flex Code
30896 \begin_layout Plain Layout
30898 \change_inserted 1075283030 1597700585
30908 ] The new-line policy for this tag,
30910 \begin_inset space ~
30914 \begin_inset CommandInset ref
30916 reference "subsec:DocBook-New-line-policy"
30930 \begin_layout Subsection
30932 \change_inserted 1075283030 1597699385
30934 \begin_inset CommandInset label
30936 name "subsec:DocBook-New-line-policy"
30943 \begin_layout Standard
30945 \change_inserted 1075283030 1597698993
30947 there are three possible policies for outputting new lines (given in the
30948 \begin_inset Flex Code
30951 \begin_layout Plain Layout
30953 \change_inserted 1075283030 1597698987
30965 \begin_layout Itemize
30967 \change_inserted 1075283030 1597699279
30968 \begin_inset Quotes eld
30972 \begin_inset Flex Code
30975 \begin_layout Plain Layout
30977 \change_inserted 1075283030 1597699012
30986 \begin_inset Quotes erd
30990 the opening and closing tags are on their own lines (i.e.
30991 a line feed after and before the opening and the closing tags).
30992 Typical elements are floats.
30997 \begin_layout LyX-Code
30999 \change_inserted 1075283030 1597699194
31003 \begin_layout LyX-Code
31005 \change_inserted 1075283030 1597699194
31009 \begin_layout LyX-Code
31011 \change_inserted 1075283030 1597699098
31012 Contents of the block.
31015 \begin_layout LyX-Code
31017 \change_inserted 1075283030 1597699196
31021 \begin_layout LyX-Code
31023 \change_inserted 1075283030 1597699198
31027 \begin_layout Itemize
31029 \change_inserted 1075283030 1597699289
31030 \begin_inset Quotes eld
31034 \begin_inset Flex Code
31037 \begin_layout Plain Layout
31039 \change_inserted 1075283030 1597699113
31048 \begin_inset Quotes erd
31052 the opening and closing tags are on the same,
31054 a line feed is output before the opening tag and after the closing tag.
31055 Typical elements are paragraphs and list items.
31060 \begin_layout LyX-Code
31062 \change_inserted 1075283030 1597699186
31066 \begin_layout LyX-Code
31068 \change_inserted 1075283030 1597699357
31069 <paratag>Contents of the paragraph.</paratag>
31072 \begin_layout LyX-Code
31074 \change_inserted 1075283030 1597699231
31078 \begin_layout Itemize
31080 \change_inserted 1075283030 1597699343
31081 \begin_inset Quotes eld
31085 \begin_inset Flex Code
31088 \begin_layout Plain Layout
31090 \change_inserted 1075283030 1597699307
31099 \begin_inset Quotes erd
31103 the opening and closing tags are on the same line as the rest of the content.
31104 No line feeds are output.
31105 Typical elements are fonts.
31110 \begin_layout LyX-Code
31112 \change_inserted 1075283030 1597699585
31113 Content before<inlinetag>Contents of the paragraph.</inlinetag>Content after
31116 \begin_layout Standard
31118 \change_inserted 1075283030 1597699585
31119 The default value is always
31120 \begin_inset Quotes eld
31124 \begin_inset Flex Code
31127 \begin_layout Plain Layout
31129 \change_inserted 1075283030 1597699585
31138 \begin_inset Quotes erd
31146 \begin_layout Subsection
31148 \change_inserted -970929547 1515111533
31149 InsetLayout DocBook
31154 \begin_layout Standard
31156 \change_inserted -970929547 1496611894
31157 The DocBook output of insets can also be controlled by information in layout files.
31160 \begin_layout Standard
31162 \change_inserted -970929547 1496612045
31163 The DocBook \SpecialChar LyX
31164 outputs for an inset has the following form:
31167 \begin_layout LyX-Code
31169 \change_inserted -970929547 1515110861
31170 <wrappertag wrapperattr>
31173 \begin_layout LyX-Code
31175 \change_inserted -970929547 1515110868
31179 \begin_layout LyX-Code
31181 \change_inserted -970929547 1515110869
31182 <innertag innerattr>
31185 \begin_layout LyX-Code
31187 \change_inserted -970929547 1515110869
31188 Contents of the inset.
31191 \begin_layout LyX-Code
31193 \change_inserted -970929547 1515110870
31197 \begin_layout LyX-Code
31199 \change_inserted -970929547 1515110871
31203 \begin_layout LyX-Code
31205 \change_inserted -970929547 1515111172
31209 \begin_layout Standard
31211 \change_inserted -970929547 1515111186
31212 For an itemising inset,
31213 it rather looks like this:
31217 \begin_layout LyX-Code
31219 \change_inserted -970929547 1515111186
31220 <wrappertag wrapperattr>
31223 \begin_layout LyX-Code
31225 \change_inserted -970929547 1515111186
31229 \begin_layout LyX-Code
31231 \change_inserted -970929547 1515111186
31232 <innertag innerattr>
31235 \begin_layout LyX-Code
31237 \change_inserted -970929547 1515111362
31238 <itemwrappertag itemwrapperattr>
31241 \begin_layout LyX-Code
31243 \change_inserted -970929547 1515111364
31244 <itemlabeltag itemattr>
31247 \begin_layout LyX-Code
31249 \change_inserted -970929547 1515111367
31250 Label of the first item.
31253 \begin_layout LyX-Code
31255 \change_inserted -970929547 1515111362
31261 \begin_layout LyX-Code
31263 \change_inserted -970929547 1515111517
31267 \begin_layout LyX-Code
31269 \change_inserted -970929547 1515111517
31275 \begin_layout LyX-Code
31277 \change_inserted -970929547 1515111516
31278 Contents of the first item.
31281 \begin_layout LyX-Code
31283 \change_inserted -970929547 1515111514
31289 \begin_layout LyX-Code
31291 \change_inserted -970929547 1515111247
31297 \begin_layout LyX-Code
31299 \change_inserted -970929547 1515111221
31303 \begin_layout LyX-Code
31305 \change_inserted -970929547 1515111370
31306 <itemwrappertag itemwrapperattr>
31309 \begin_layout LyX-Code
31311 \change_inserted -970929547 1515111370
31312 <itemlabeltag itemattr>
31315 \begin_layout LyX-Code
31317 \change_inserted -970929547 1515111372
31318 Label of the second item.
31321 \begin_layout LyX-Code
31323 \change_inserted -970929547 1515111370
31329 \begin_layout LyX-Code
31331 \change_inserted -970929547 1515111504
31335 \begin_layout LyX-Code
31337 \change_inserted -970929547 1515111505
31343 \begin_layout LyX-Code
31345 \change_inserted -970929547 1515111507
31346 Contents of the second item.
31349 \begin_layout LyX-Code
31351 \change_inserted -970929547 1515111509
31357 \begin_layout LyX-Code
31359 \change_inserted -970929547 1515111251
31365 \begin_layout LyX-Code
31367 \change_inserted -970929547 1515111221
31373 \begin_layout LyX-Code
31375 \change_inserted -970929547 1515111219
31381 \begin_layout LyX-Code
31383 \change_inserted -970929547 1515111186
31387 \begin_layout LyX-Code
31389 \change_inserted -970929547 1515111186
31393 \begin_layout LyX-Code
31395 \change_inserted -970929547 1515111186
31399 \begin_layout Standard
31401 \change_inserted -970929547 1515111183
31402 If the inset permits multiple paragraphs—
31405 \begin_inset Flex Code
31408 \begin_layout Plain Layout
31410 \change_inserted -970929547 1496610966
31419 then the contents of the inset will
31420 \change_deleted 34634807 1620029217
31422 \change_inserted 34634807 1620029219
31424 \change_inserted -970929547 1515111183
31425 be output as paragraphs formatted according to the styles used for those paragraphs (standard,
31428 The inner tag is optional and,
31433 \begin_layout Standard
31435 \change_inserted -970929547 1496610966
31436 The specific tags and attributes output for each inset can be controlled by means of the following layout tags.
31439 \begin_layout Description
31441 \change_inserted -970929547 1515110317
31442 \begin_inset Flex Code
31445 \begin_layout Plain Layout
31447 \change_inserted -970929547 1515109695
31456 \begin_inset Flex Code
31459 \begin_layout Plain Layout
31461 \change_inserted -970929547 1496611854
31469 ] Specifies attribute information to be output with the main tag,
31471 \begin_inset Quotes eld
31475 \begin_inset Flex Code
31478 \begin_layout Plain Layout
31480 \change_inserted -970929547 1515110044
31489 \begin_inset Quotes erd
31492 in the example above.
31493 This information can be used in further processing of the DocBook files.
31497 \begin_layout Description
31499 \change_inserted -970929547 1515110973
31500 \begin_inset Flex Code
31503 \begin_layout Plain Layout
31505 \change_inserted -970929547 1515110319
31514 \begin_inset Flex Code
31517 \begin_layout Plain Layout
31519 \change_inserted -970929547 1515110384
31529 ] Specifies whether this tag goes into the
31530 \begin_inset Flex Code
31533 \begin_layout Plain Layout
31535 \change_inserted -970929547 1515110412
31543 tag at the beginning of the parent layout.
31545 \begin_inset Flex Code
31548 \begin_layout Plain Layout
31550 \change_inserted -970929547 1515110437
31558 indicates that the tag never goes into
31559 \begin_inset Flex Code
31562 \begin_layout Plain Layout
31564 \change_inserted -970929547 1515110497
31572 (this is default value,
31573 and corresponds to usual content).
31575 \begin_inset Flex Code
31578 \begin_layout Plain Layout
31580 \change_inserted -970929547 1515110517
31588 indicates that the tag always goes into
31589 \begin_inset Flex Code
31592 \begin_layout Plain Layout
31594 \change_inserted -970929547 1515110514
31602 (this corresponds to usual metadata):
31604 \begin_inset Flex Code
31607 \begin_layout Plain Layout
31609 \change_inserted -970929547 1515110550
31617 tag for the parent,
31624 \begin_inset Flex Code
31627 \begin_layout Plain Layout
31629 \change_inserted -970929547 1515110540
31637 indicates that the tag may go into
31638 \begin_inset Flex Code
31641 \begin_layout Plain Layout
31643 \change_inserted -970929547 1515110538
31651 (this is only the case for titles):
31653 \begin_inset Flex Code
31656 \begin_layout Plain Layout
31658 \change_inserted -970929547 1515110585
31666 tag for the parent,
31672 the corresponding tag will be output directly as content.
31676 \begin_layout Description
31678 \change_inserted -970929547 1515111461
31679 \begin_inset Flex Code
31682 \begin_layout Plain Layout
31684 \change_inserted -970929547 1515110974
31693 \begin_inset Flex Code
31696 \begin_layout Plain Layout
31698 \change_inserted -970929547 1515110973
31706 ] Specifies attribute information to be output with the item tag,
31708 \begin_inset Quotes eld
31712 \begin_inset Flex Code
31715 \begin_layout Plain Layout
31717 \change_inserted -970929547 1515110984
31726 \begin_inset Quotes erd
31729 in the example above.
31730 This information can be used in further processing of the DocBook files.
31734 \begin_layout Description
31736 \change_inserted -970929547 1515111471
31737 \begin_inset Flex Code
31740 \begin_layout Plain Layout
31742 \change_inserted -970929547 1515111465
31743 DocBookItemInnerAttr
31751 \begin_inset Flex Code
31754 \begin_layout Plain Layout
31756 \change_inserted -970929547 1515111461
31764 ] Specifies attribute information to be output with the item inner tag,
31766 \begin_inset Quotes eld
31770 \begin_inset Flex Code
31773 \begin_layout Plain Layout
31775 \change_inserted -970929547 1515111476
31784 \begin_inset Quotes erd
31787 in the example above.
31788 This information can be used in further processing of the DocBook files.
31792 \begin_layout Description
31794 \change_inserted -970929547 1515111494
31795 \begin_inset Flex Code
31798 \begin_layout Plain Layout
31800 \change_inserted -970929547 1515111467
31801 DocBookItemInnerTag
31809 \begin_inset Flex Code
31812 \begin_layout Plain Layout
31814 \change_inserted -970929547 1515111461
31822 ] The tag to be used for the item inner tag within the inset,
31824 \begin_inset Quotes eld
31828 \begin_inset Flex Code
31831 \begin_layout Plain Layout
31833 \change_inserted -970929547 1515111486
31842 \begin_inset Quotes erd
31845 in the example above.
31847 \begin_inset Flex Code
31850 \begin_layout Plain Layout
31852 \change_inserted -970929547 1515111461
31861 indicating that there is no item inner tag:
31862 content is directly output without it for each itemised element.
31863 This parameter only makes sense when itemising layouts are used,
31866 \change_inserted 1075283030 1598469472
31867 The most likely value is
31868 \begin_inset Quotes eld
31872 \begin_inset Flex Code
31875 \begin_layout Plain Layout
31877 \change_inserted 1075283030 1598469476
31886 \begin_inset Quotes erd
31890 \begin_inset Newline newline
31893 When a list item is split using a new line,
31894 the item inner tag will be repeated for each part of the paragraph,
31895 parts being separated by new lines.
31899 \begin_layout Description
31901 \change_inserted 1075283030 1597699866
31902 \begin_inset Flex Code
31905 \begin_layout Plain Layout
31907 \change_inserted 1075283030 1597699853
31908 DocBookItemInnerTagType
31916 \begin_inset Flex Code
31919 \begin_layout Plain Layout
31921 \change_inserted 1075283030 1597699866
31931 ] The new-line policy for this tag,
31933 \begin_inset space ~
31937 \begin_inset CommandInset ref
31939 reference "subsec:DocBook-New-line-policy"
31953 \begin_layout Description
31955 \change_inserted -970929547 1515111290
31956 \begin_inset Flex Code
31959 \begin_layout Plain Layout
31961 \change_inserted -970929547 1515111283
31962 DocBookItemLabelAttr
31970 \begin_inset Flex Code
31973 \begin_layout Plain Layout
31975 \change_inserted -970929547 1515111279
31983 ] Specifies attribute information to be output with the item label tag,
31985 \begin_inset Quotes eld
31989 \begin_inset Flex Code
31992 \begin_layout Plain Layout
31994 \change_inserted -970929547 1515111304
32003 \begin_inset Quotes erd
32006 in the example above.
32007 This information can be used in further processing of the DocBook files.
32011 \begin_layout Description
32013 \change_inserted -970929547 1515111337
32014 \begin_inset Flex Code
32017 \begin_layout Plain Layout
32019 \change_inserted -970929547 1515111285
32020 DocBookItemLabelTag
32028 \begin_inset Flex Code
32031 \begin_layout Plain Layout
32033 \change_inserted -970929547 1515111279
32041 ] The tag to be used for the item label tag within the inset,
32043 \begin_inset Quotes eld
32047 \begin_inset Flex Code
32050 \begin_layout Plain Layout
32052 \change_inserted -970929547 1515111311
32061 \begin_inset Quotes erd
32064 in the example above.
32065 This parameter only makes sense when itemising layouts are used with a notion of labels,
32066 such as definition lists.
32068 \change_inserted 1075283030 1597699874
32072 \begin_layout Description
32074 \change_inserted 1075283030 1597699874
32075 \begin_inset Flex Code
32078 \begin_layout Plain Layout
32080 \change_inserted 1075283030 1597699880
32081 DocBookItemLabelTagType
32089 \begin_inset Flex Code
32092 \begin_layout Plain Layout
32094 \change_inserted 1075283030 1597699874
32104 ] The new-line policy for this tag,
32106 \begin_inset space ~
32110 \begin_inset CommandInset ref
32112 reference "subsec:DocBook-New-line-policy"
32126 \begin_layout Description
32128 \change_inserted -970929547 1515111124
32129 \begin_inset Flex Code
32132 \begin_layout Plain Layout
32134 \change_inserted -970929547 1515111060
32143 \begin_inset Flex Code
32146 \begin_layout Plain Layout
32148 \change_inserted -970929547 1515111060
32156 ] The tag to be used for the item tag within the inset,
32158 \begin_inset Quotes eld
32162 \begin_inset Flex Code
32165 \begin_layout Plain Layout
32167 \change_inserted -970929547 1515111060
32176 \begin_inset Quotes erd
32179 in the example above.
32181 \begin_inset Flex Code
32184 \begin_layout Plain Layout
32186 \change_inserted -970929547 1515111060
32195 indicating that there is no item tag.
32196 This parameter only makes sense when itemising layouts are used,
32199 \change_inserted 1075283030 1597699890
32203 \begin_layout Description
32205 \change_inserted 1075283030 1597699890
32206 \begin_inset Flex Code
32209 \begin_layout Plain Layout
32211 \change_inserted 1075283030 1597699890
32220 \begin_inset Flex Code
32223 \begin_layout Plain Layout
32225 \change_inserted 1075283030 1597699890
32235 ] The new-line policy for this tag,
32237 \begin_inset space ~
32241 \begin_inset CommandInset ref
32243 reference "subsec:DocBook-New-line-policy"
32257 \begin_layout Description
32259 \change_inserted -970929547 1515111298
32260 \begin_inset Flex Code
32263 \begin_layout Plain Layout
32265 \change_inserted -970929547 1515111124
32266 DocBookItemWrapperAttr
32274 \begin_inset Flex Code
32277 \begin_layout Plain Layout
32279 \change_inserted -970929547 1515111124
32287 ] Specifies attribute information to be output with the item wrapper tag,
32289 \begin_inset Quotes eld
32293 \begin_inset Flex Code
32296 \begin_layout Plain Layout
32298 \change_inserted -970929547 1515111150
32307 \begin_inset Quotes erd
32310 in the example above.
32311 This information can be used in further processing of the DocBook files.
32317 \begin_layout Description
32319 \change_inserted -970929547 1515111113
32320 \begin_inset Flex Code
32323 \begin_layout Plain Layout
32325 \change_inserted -970929547 1515111073
32326 DocBookItemWrapperTag
32334 \begin_inset Flex Code
32337 \begin_layout Plain Layout
32339 \change_inserted -970929547 1515111073
32347 ] The tag to be used for the item wrapper tag within the inset,
32349 \begin_inset Quotes eld
32353 \begin_inset Flex Code
32356 \begin_layout Plain Layout
32358 \change_inserted -970929547 1515111083
32367 \begin_inset Quotes erd
32370 in the example above.
32372 \begin_inset Flex Code
32375 \begin_layout Plain Layout
32377 \change_inserted -970929547 1515111073
32386 indicating that there is no item wrapper tag:
32387 tag and content are directly output without it for each itemised element.
32388 This parameter only makes sense when itemising layouts are used,
32391 \change_inserted 1075283030 1597699897
32395 \begin_layout Description
32397 \change_inserted 1075283030 1597699897
32398 \begin_inset Flex Code
32401 \begin_layout Plain Layout
32403 \change_inserted 1075283030 1597699900
32404 DocBookItemWrapperTagType
32412 \begin_inset Flex Code
32415 \begin_layout Plain Layout
32417 \change_inserted 1075283030 1597699897
32427 ] The new-line policy for this tag,
32429 \begin_inset space ~
32433 \begin_inset CommandInset ref
32435 reference "subsec:DocBook-New-line-policy"
32449 \begin_layout Description
32451 \change_inserted -970929547 1515110104
32452 \begin_inset Flex Code
32455 \begin_layout Plain Layout
32457 \change_inserted -970929547 1515110104
32466 \begin_inset Flex Code
32469 \begin_layout Plain Layout
32471 \change_inserted -970929547 1515110104
32479 ] Specifies attribute information to be output with the inner tag,
32481 \begin_inset Quotes eld
32485 \begin_inset Flex Code
32488 \begin_layout Plain Layout
32490 \change_inserted -970929547 1515110104
32499 \begin_inset Quotes erd
32502 in the example above.
32503 This information can be used in further processing of the DocBook files.
32507 \begin_layout Description
32509 \change_inserted -970929547 1515110906
32510 \begin_inset Flex Code
32513 \begin_layout Plain Layout
32515 \change_inserted -970929547 1515110104
32524 \begin_inset Flex Code
32527 \begin_layout Plain Layout
32529 \change_inserted -970929547 1515110104
32537 ] The tag to be used for the inner tag within the inset,
32539 \begin_inset Quotes eld
32543 \begin_inset Flex Code
32546 \begin_layout Plain Layout
32548 \change_inserted -970929547 1515110104
32557 \begin_inset Quotes erd
32560 in the example above.
32562 \begin_inset Flex Code
32565 \begin_layout Plain Layout
32567 \change_inserted -970929547 1515110791
32576 indicating that there is no inner tag:
32577 content is directly output without it.
32578 \change_inserted 1075283030 1597699904
32582 \begin_layout Description
32584 \change_inserted 1075283030 1597699904
32585 \begin_inset Flex Code
32588 \begin_layout Plain Layout
32590 \change_inserted 1075283030 1597699904
32591 DocBookInnerTagType
32599 \begin_inset Flex Code
32602 \begin_layout Plain Layout
32604 \change_inserted 1075283030 1597699904
32614 ] The new-line policy for this tag,
32616 \begin_inset space ~
32620 \begin_inset CommandInset ref
32622 reference "subsec:DocBook-New-line-policy"
32636 \begin_layout Description
32638 \change_inserted -970929547 1515110753
32639 \begin_inset Flex Code
32642 \begin_layout Plain Layout
32644 \change_inserted -970929547 1515110665
32653 \begin_inset Flex Code
32656 \begin_layout Plain Layout
32658 \change_inserted -970929547 1515110661
32666 ] Specifies the tag that corresponds to this kind of section.
32667 This parameter only makes sense for sectioning elements (part,
32671 The default value is
32672 \begin_inset Flex Code
32675 \begin_layout Plain Layout
32677 \change_inserted -970929547 1515110721
32686 and is only overridden when DocBook uses something else for sectioning (
32687 \change_inserted 1075283030 1597699921
32690 \change_inserted -970929547 1515110753
32691 parts and chapters of a book).
32697 \begin_layout Description
32699 \change_inserted -970929547 1515110811
32700 \begin_inset Flex Code
32703 \begin_layout Plain Layout
32705 \change_inserted -970929547 1496612023
32714 \begin_inset Flex Code
32717 \begin_layout Plain Layout
32719 \change_inserted -970929547 1496610966
32727 ] The tag to be used for this inset,
32729 \begin_inset Quotes eld
32733 \begin_inset Flex Code
32736 \begin_layout Plain Layout
32738 \change_inserted -970929547 1496612033
32747 \begin_inset Quotes erd
32750 in the example above.
32751 The default is the name of the float and always needs to be changed,
32752 as DocBook provides no generic inset tag.
32753 \change_inserted 1075283030 1597699924
32757 \begin_layout Description
32759 \change_inserted 1075283030 1597699924
32760 \begin_inset Flex Code
32763 \begin_layout Plain Layout
32765 \change_inserted 1075283030 1597699924
32774 \begin_inset Flex Code
32777 \begin_layout Plain Layout
32779 \change_inserted 1075283030 1597699924
32789 ] The new-line policy for this tag,
32791 \begin_inset space ~
32795 \begin_inset CommandInset ref
32797 reference "subsec:DocBook-New-line-policy"
32811 \begin_layout Description
32813 \change_inserted -970929547 1515110832
32814 \begin_inset Flex Code
32817 \begin_layout Plain Layout
32819 \change_inserted -970929547 1515110822
32828 \begin_inset Flex Code
32831 \begin_layout Plain Layout
32833 \change_inserted -970929547 1515110811
32841 ] Specifies attribute information to be output with the outer
32842 \change_inserted 34634807 1620057958
32844 \change_inserted -970929547 1515110832
32847 \begin_inset Quotes eld
32851 \begin_inset Flex Code
32854 \begin_layout Plain Layout
32856 \change_inserted -970929547 1515110845
32865 \begin_inset Quotes erd
32868 in the example above.
32869 This information can be used in further processing of the DocBook files.
32873 \begin_layout Description
32875 \change_inserted -970929547 1515110917
32876 \begin_inset Flex Code
32879 \begin_layout Plain Layout
32881 \change_inserted -970929547 1515110826
32890 \begin_inset Flex Code
32893 \begin_layout Plain Layout
32895 \change_inserted -970929547 1515110811
32903 ] The tag to be used for the wrapper tag around the inset,
32905 \begin_inset Quotes eld
32909 \begin_inset Flex Code
32912 \begin_layout Plain Layout
32914 \change_inserted -970929547 1515110842
32923 \begin_inset Quotes erd
32926 in the example above.
32928 \begin_inset Flex Code
32931 \begin_layout Plain Layout
32933 \change_inserted -970929547 1515110811
32942 indicating that there is no wrapper tag:
32943 tag and content are directly output without it.
32944 \change_inserted 1075283030 1597699929
32948 \begin_layout Description
32950 \change_inserted 1075283030 1597699929
32951 \begin_inset Flex Code
32954 \begin_layout Plain Layout
32956 \change_inserted 1075283030 1597699932
32957 DocBookWrapperTagType
32965 \begin_inset Flex Code
32968 \begin_layout Plain Layout
32970 \change_inserted 1075283030 1597699929
32980 ] The new-line policy for this tag,
32982 \begin_inset space ~
32986 \begin_inset CommandInset ref
32988 reference "subsec:DocBook-New-line-policy"
33002 \begin_layout Subsection
33004 \change_inserted -970929547 1515110040
33008 \begin_layout Standard
33010 \change_inserted -970929547 1496611700
33011 The DocBook output for floats too can be controlled by layout information.
33012 The output has the following form:
33015 \begin_layout LyX-Code
33017 \change_inserted -970929547 1515109700
33021 \begin_layout LyX-Code
33023 \change_inserted -970929547 1515110138
33024 Contents of the float as DocBook.
33027 \begin_layout LyX-Code
33029 \change_inserted -970929547 1496610966
33033 \begin_layout Standard
33035 \change_inserted -970929547 1496611715
33038 is a separate inset and will be output as a title.
33042 \begin_layout Description
33044 \change_inserted -970929547 1515110033
33045 \begin_inset Flex Code
33048 \begin_layout Plain Layout
33050 \change_inserted -970929547 1515109702
33059 \begin_inset Flex Code
33062 \begin_layout Plain Layout
33064 \change_inserted -970929547 1496610966
33072 ] Specifies attribute information to be output with the main tag,
33074 \begin_inset Quotes eld
33078 \begin_inset Flex Code
33081 \begin_layout Plain Layout
33083 \change_inserted -970929547 1515110035
33092 \begin_inset Quotes erd
33095 in the example above.
33096 This information can be used in further processing of the DocBook files.
33100 \begin_layout Description
33102 \change_inserted -970929547 1515110157
33103 \begin_inset Flex Code
33106 \begin_layout Plain Layout
33108 \change_inserted -970929547 1496611782
33117 \begin_inset Flex Code
33120 \begin_layout Plain Layout
33122 \change_inserted -970929547 1496610966
33130 ] The tag to be used for this float,
33132 \begin_inset Quotes eld
33136 \begin_inset Flex Code
33139 \begin_layout Plain Layout
33141 \change_inserted -970929547 1496610966
33150 \begin_inset Quotes erd
33153 in the example above.
33154 The default is the name of the float and always needs to be changed,
33155 as DocBook provides no generic float tag.
33158 \begin_layout Subsection
33160 \change_inserted -970929547 1515110157
33161 Bibliography formatting
33164 \begin_layout Standard
33166 \change_deleted 1075283030 1597699984
33168 \change_inserted 1075283030 1597699985
33170 \change_inserted -970929547 1515110187
33172 \change_deleted 1075283030 1597699987
33174 \change_inserted 1075283030 1597699987
33176 \change_inserted -970929547 1515110187
33177 cannot be formatted:
33178 all fields are always output in the database-like DocBook format (equivalent to a BibTeX file)
33179 \change_inserted 1075283030 1597700117
33182 \begin_inset Flex Code
33185 \begin_layout Plain Layout
33187 \change_inserted 1075283030 1597700120
33196 \change_inserted -970929547 1515110187
33198 \change_inserted 1075283030 1597700092
33202 \begin_layout Standard
33204 \change_inserted 1075283030 1597700112
33205 When the bibliographic entries are manually inserted into the
33206 \change_deleted 34634807 1620057319
33208 \change_inserted 34634807 1620057319
33211 \change_inserted 1075283030 1597700112
33212 document as Bibliography Items,
33213 the user deals with formatting
33216 \change_inserted 1075283030 1597700112
33218 there is no attempt of parsing what the user wrote,
33219 the string is directly used (with the
33220 \begin_inset Flex Code
33223 \begin_layout Plain Layout
33225 \change_inserted 1075283030 1597700076
33239 \begin_layout Chapter
33240 Including External Material
33241 \begin_inset CommandInset label
33243 name "chap:Including-External-Material"
33250 \begin_layout Standard
33251 \begin_inset Box Shadowbox
33261 height_special "totalheight"
33266 backgroundcolor "none"
33269 \begin_layout Plain Layout
33271 This portion of the documentation has not been updated for some time.
33272 We certainly hope that it is still accurate,
33273 but there are no guarantees.
33281 \begin_layout Standard
33282 The use of material from sources external to \SpecialChar LyX
33283 is covered in detail in the
33288 This part of the manual covers what needs to happen behind the scenes for new sorts of material to be included.
33291 \begin_layout Section
33295 \begin_layout Standard
33296 The external material feature is based on the concept of a
33301 A template is a specification of how \SpecialChar LyX
33302 should interface with a certain kind of material.
33305 comes with predefined templates for Xfig figures,
33306 various raster format images,
33308 and LilyPond music notation.
33309 You can check the actual list by using the menu
33310 \begin_inset Flex Noun
33313 \begin_layout Plain Layout
33314 Insert\SpecialChar menuseparator
33315 File\SpecialChar menuseparator
33323 it is possible to roll your own template to support a specific kind of material.
33324 Later we'll describe in more detail what is involved,
33325 and hopefully you will submit all the templates you create so we can include them in a later \SpecialChar LyX
33329 \begin_layout Standard
33330 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.
33332 consider the case of a figure produced with
33333 \begin_inset Flex Code
33336 \begin_layout Plain Layout
33343 The Xfig application itself works on an original file with the
33344 \begin_inset Flex Code
33347 \begin_layout Plain Layout
33355 you create and change your figure,
33356 and when you are done,
33358 \begin_inset Flex Code
33361 \begin_layout Plain Layout
33368 When you want to include the figure in your document,
33370 \begin_inset Flex Code
33373 \begin_layout Plain Layout
33379 in order to create a PostScript file that can readily be included in your \SpecialChar LaTeX
33383 \begin_inset Flex Code
33386 \begin_layout Plain Layout
33392 file is the original file,
33393 and the PostScript file is the produced file.
33396 \begin_layout Standard
33397 This distinction is important in order to allow updating of the material while you are in the process of writing the document.
33399 it provides us with the flexibility that is needed to support multiple export formats.
33401 in the case of a plain text file,
33402 it is not exactly an award-winning idea to include the figure as raw PostScript.
33404 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.
33405 The external material management allows you to do this,
33406 because it is parametrized on the different export formats that \SpecialChar LyX
33410 \begin_layout Standard
33411 Besides supporting the production of different products according to the exported format,
33412 it supports tight integration with editing and viewing applications.
33413 In the case of an Xfig figure,
33414 you are able to invoke Xfig on the original file with a single click from within the external material dialog in \SpecialChar LyX
33416 and also preview the produced PostScript file with Ghostview with another click.
33417 No more fiddling around with the command line and/or file browsers to locate and manipulate the original or produced files.
33419 you are finally able to take full advantage of the many different applications that are relevant to use when you write your documents,
33420 and ultimately be more productive.
33423 \begin_layout Section
33424 The external template configuration files
33427 \begin_layout Standard
33428 It is relatively easy to add custom external template definitions to \SpecialChar LyX
33431 be aware that doing this in an careless manner most probably
33435 introduce an easily exploitable security hole.
33436 So before you do this,
33437 please read the discussion about security in
33438 \begin_inset CommandInset ref
33440 reference "sec:Security-discussion"
33448 \begin_layout Standard
33450 we encourage you to submit any interesting templates that you create.
33454 \begin_layout Standard
33455 The external templates are defined in the
33456 \begin_inset Flex Code
33459 \begin_layout Plain Layout
33465 files that are stored in the
33466 \begin_inset Flex Code
33469 \begin_layout Plain Layout
33470 LyXDir/lib/xtemplates/
33476 Each template is defined in a file of its own.
33477 You can place your own templates in
33478 \begin_inset Flex Code
33481 \begin_layout Plain Layout
33482 UserDir/xtemplates/
33487 or copy existing templates to that directory in order to modify them.
33490 \begin_layout Standard
33491 A typical template looks like this:
33494 \begin_layout LyX-Code
33498 \begin_layout LyX-Code
33500 $$AbsOrRelPathParent$$Basename"
33503 \begin_layout LyX-Code
33507 \begin_layout LyX-Code
33511 \begin_layout LyX-Code
33515 \begin_layout LyX-Code
33519 \begin_layout LyX-Code
33523 \begin_layout LyX-Code
33524 AutomaticProduction true
33527 \begin_layout LyX-Code
33531 \begin_layout LyX-Code
33535 \begin_layout LyX-Code
33539 \begin_layout LyX-Code
33540 TransformCommand Rotate RotationLatexCommand
33543 \begin_layout LyX-Code
33544 TransformCommand Resize ResizeLatexCommand
33547 \begin_layout LyX-Code
33548 Product "$$RotateFront$$ResizeFront
33551 \begin_layout LyX-Code
33556 input{$$AbsOrRelPathMaster$$Basename.pstex_t}
33559 \begin_layout LyX-Code
33560 $$ResizeBack$$RotateBack"
33563 \begin_layout LyX-Code
33567 \begin_layout LyX-Code
33568 UpdateResult "$$AbsPath$$Basename.pstex_t"
33571 \begin_layout LyX-Code
33572 Requirement "graphicx"
33575 \begin_layout LyX-Code
33576 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
33579 \begin_layout LyX-Code
33580 ReferencedFile latex "$$AbsPath$$Basename.eps"
33583 \begin_layout LyX-Code
33584 ReferencedFile dvi "$$AbsPath$$Basename.eps"
33587 \begin_layout LyX-Code
33591 \begin_layout LyX-Code
33595 \begin_layout LyX-Code
33596 TransformCommand Rotate RotationLatexCommand
33599 \begin_layout LyX-Code
33600 TransformCommand Resize ResizeLatexCommand
33603 \begin_layout LyX-Code
33604 Product "$$RotateFront$$ResizeFront
33607 \begin_layout LyX-Code
33612 input{$$AbsOrRelPathMaster$$Basename.pdftex_t}
33615 \begin_layout LyX-Code
33616 $$ResizeBack$$RotateBack"
33619 \begin_layout LyX-Code
33620 UpdateFormat pdftex
33623 \begin_layout LyX-Code
33624 UpdateResult "$$AbsPath$$Basename.pdftex_t"
33627 \begin_layout LyX-Code
33628 Requirement "graphicx"
33631 \begin_layout LyX-Code
33632 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pdftex_t"
33635 \begin_layout LyX-Code
33636 ReferencedFile latex "$$AbsPath$$Basename.pdf"
33639 \begin_layout LyX-Code
33643 \begin_layout LyX-Code
33647 \begin_layout LyX-Code
33652 \begin_layout LyX-Code
33656 \begin_layout LyX-Code
33660 \begin_layout LyX-Code
33661 Product "<graphic fileref=
33663 "$$AbsOrRelPathMaster$$Basename.eps
33668 \begin_layout LyX-Code
33672 \begin_layout LyX-Code
33676 \begin_layout LyX-Code
33677 UpdateResult "$$AbsPath$$Basename.eps"
33680 \begin_layout LyX-Code
33681 ReferencedFile docbook "$$AbsPath$$Basename.eps"
33684 \begin_layout LyX-Code
33685 ReferencedFile docbook-xml "$$AbsPath$$Basename.eps"
33688 \begin_layout LyX-Code
33692 \begin_layout LyX-Code
33696 \begin_layout Standard
33698 the template is enclosed in
33699 \begin_inset Flex Code
33702 \begin_layout Plain Layout
33710 \begin_inset Flex Code
33713 \begin_layout Plain Layout
33720 It contains a header specifying some general settings and,
33721 for each supported primary document file format,
33723 \begin_inset Flex Code
33726 \begin_layout Plain Layout
33734 \begin_inset Flex Code
33737 \begin_layout Plain Layout
33746 \begin_layout Subsection
33747 The template header
33750 \begin_layout Description
33751 \begin_inset Flex Code
33754 \begin_layout Plain Layout
33755 AutomaticProduction
33756 \begin_inset space ~
33764 Whether the file represented by the template must be generated by \SpecialChar LyX
33766 This command must occur exactly once.
33769 \begin_layout Description
33770 \begin_inset Flex Code
33773 \begin_layout Plain Layout
33775 \begin_inset space ~
33783 A glob pattern that is used in the file dialog to filter out the desired files.
33784 If there is more than one possible file extension (e.
33785 \begin_inset space \thinspace{}
33789 \begin_inset space \space{}
33793 \begin_inset Flex Code
33796 \begin_layout Plain Layout
33803 \begin_inset Flex Code
33806 \begin_layout Plain Layout
33814 \begin_inset Flex Code
33817 \begin_layout Plain Layout
33824 This command must occur exactly once.
33827 \begin_layout Description
33828 \begin_inset Flex Code
33831 \begin_layout Plain Layout
33833 \begin_inset space ~
33841 The text that is displayed on the button.
33842 This command must occur exactly once.
33845 \begin_layout Description
33846 \begin_inset Flex Code
33849 \begin_layout Plain Layout
33851 \begin_inset space ~
33855 \begin_inset space ~
33863 The help text that is used in the External dialog.
33864 Provide enough information to explain to the user just what the template can provide him with.
33865 This command must occur exactly once.
33868 \begin_layout Description
33869 \begin_inset Flex Code
33872 \begin_layout Plain Layout
33874 \begin_inset space ~
33882 The file format of the original file.
33883 This must be the name of a format that is known to \SpecialChar LyX
33885 \begin_inset CommandInset ref
33887 reference "sec:Formats"
33894 \begin_inset Quotes eld
33898 \begin_inset Flex Code
33901 \begin_layout Plain Layout
33908 \begin_inset Quotes erd
33911 if the template can handle original files of more than one format.
33913 will attempt to interrogate the file itself in order to deduce its format in this case.
33914 This command must occur exactly once.
33917 \begin_layout Description
33918 \begin_inset Flex Code
33921 \begin_layout Plain Layout
33923 \begin_inset space ~
33931 A unique name for the template.
33932 It must not contain substitution macros (see below).
33935 \begin_layout Description
33936 \begin_inset Flex Code
33939 \begin_layout Plain Layout
33941 \begin_inset space ~
33944 Rotate|Resize|Clip|Extra
33949 This command specifies which transformations are supported by this template.
33950 It may occur zero or more times.
33951 This command enables the corresponding tabs in the external dialog.
33953 \begin_inset Flex Code
33956 \begin_layout Plain Layout
33962 command must have either a corresponding
33963 \begin_inset Flex Code
33966 \begin_layout Plain Layout
33973 \begin_inset Flex Code
33976 \begin_layout Plain Layout
33983 \begin_inset Flex Code
33986 \begin_layout Plain Layout
33993 Otherwise the transformation will not be supported by that format.
33996 \begin_layout Subsection
34000 \begin_layout Description
34001 \begin_inset Flex Code
34004 \begin_layout Plain Layout
34006 \begin_inset space ~
34009 LaTeX|PDFLaTeX|PlainText|DocBook|XHTML
34014 The primary document file format that this format definition is for.
34015 Not every template has a sensible representation in all document file formats.
34016 Please define nevertheless a
34017 \begin_inset Flex Code
34020 \begin_layout Plain Layout
34026 section for all templates.
34027 Use a dummy text when no representation is available.
34028 Then you can at least see a reference to the external material in the exported document.
34031 \begin_layout Description
34032 \begin_inset Flex Code
34035 \begin_layout Plain Layout
34037 \begin_inset space ~
34041 \begin_inset space ~
34049 This command defines an additional macro
34050 \begin_inset Flex Code
34053 \begin_layout Plain Layout
34059 for substitution in
34060 \begin_inset Flex Code
34063 \begin_layout Plain Layout
34071 \begin_inset Flex Code
34074 \begin_layout Plain Layout
34080 itself may contain substitution macros.
34081 The advantage over using
34082 \begin_inset Flex Code
34085 \begin_layout Plain Layout
34092 \begin_inset Flex Code
34095 \begin_layout Plain Layout
34101 is that the substituted value of
34102 \begin_inset Flex Code
34105 \begin_layout Plain Layout
34111 is sanitized so that it is a valid optional argument in the document format.
34112 This command may occur zero or more times.
34115 \begin_layout Description
34116 \begin_inset Flex Code
34119 \begin_layout Plain Layout
34121 \begin_inset space ~
34129 The text that is inserted in the exported document.
34130 This is actually the most important command and can be quite complex.
34131 This command must occur exactly once.
34134 \begin_layout Description
34135 \begin_inset Flex Code
34138 \begin_layout Plain Layout
34140 \begin_inset space ~
34148 This command specifies a preamble snippet that will be included in the \SpecialChar LaTeX
34150 It has to be defined using
34151 \begin_inset Flex Code
34154 \begin_layout Plain Layout
34162 \begin_inset Flex Code
34165 \begin_layout Plain Layout
34172 This command may occur zero or more times.
34175 \begin_layout Description
34176 \begin_inset Flex Code
34179 \begin_layout Plain Layout
34181 \begin_inset space ~
34185 \begin_inset space ~
34193 This command denotes files that are created by the conversion process and are needed for a particular export format.
34194 If the filename is relative,
34195 it is interpreted relative to the master document.
34196 This command may be given zero or more times.
34199 \begin_layout Description
34200 \begin_inset Flex Code
34203 \begin_layout Plain Layout
34205 \begin_inset space ~
34213 The name of a required \SpecialChar LaTeX
34215 The package is included via
34216 \begin_inset Flex Code
34219 \begin_layout Plain Layout
34227 in the \SpecialChar LaTeX
34229 This command may occur zero or more times.
34232 \begin_layout Description
34233 \begin_inset Flex Code
34236 \begin_layout Plain Layout
34238 \begin_inset space ~
34242 \begin_inset space ~
34245 RotationLatexCommand
34250 This command specifies that the built in \SpecialChar LaTeX
34251 command should be used for rotation.
34252 This command may occur once or not at all.
34255 \begin_layout Description
34256 \begin_inset Flex Code
34259 \begin_layout Plain Layout
34261 \begin_inset space ~
34265 \begin_inset space ~
34273 This command specifies that the built in \SpecialChar LaTeX
34274 command should be used for resizing.
34275 This command may occur once or not at all.
34278 \begin_layout Description
34279 \begin_inset Flex Code
34282 \begin_layout Plain Layout
34284 \begin_inset space ~
34288 \begin_inset space ~
34291 RotationLatexOption
34296 This command specifies that rotation is done via an optional argument.
34297 This command may occur once or not at all.
34300 \begin_layout Description
34301 \begin_inset Flex Code
34304 \begin_layout Plain Layout
34306 \begin_inset space ~
34310 \begin_inset space ~
34318 This command specifies that resizing is done via an optional argument.
34319 This command may occur once or not at all.
34322 \begin_layout Description
34323 \begin_inset Flex Code
34326 \begin_layout Plain Layout
34328 \begin_inset space ~
34332 \begin_inset space ~
34340 This command specifies that clipping is done via an optional argument.
34341 This command may occur once or not at all.
34344 \begin_layout Description
34345 \begin_inset Flex Code
34348 \begin_layout Plain Layout
34350 \begin_inset space ~
34354 \begin_inset space ~
34362 This command specifies that an extra optional argument is used.
34363 This command may occur once or not at all.
34366 \begin_layout Description
34367 \begin_inset Flex Code
34370 \begin_layout Plain Layout
34372 \begin_inset space ~
34380 The file format of the converted file.
34381 This must be the name of a format that is known to \SpecialChar LyX
34383 \begin_inset Flex Noun
34386 \begin_layout Plain Layout
34387 Tools\SpecialChar menuseparator
34388 Preferences\SpecialChar menuseparator
34389 File Handling\SpecialChar menuseparator
34396 This command must occur exactly once.
34397 If the resulting file format is PDF,
34398 you need to specify the format
34399 \begin_inset Flex Code
34402 \begin_layout Plain Layout
34409 This is the PDF format used for including graphics.
34410 The other defined PDF formats are for document export.
34413 \begin_layout Description
34414 \begin_inset Flex Code
34417 \begin_layout Plain Layout
34419 \begin_inset space ~
34427 The file name of the converted file.
34428 The file name must be absolute.
34429 This command must occur exactly once.
34432 \begin_layout Subsection
34433 Preamble definitions
34436 \begin_layout Standard
34437 The external template configuration file may contain additional preamble definitions enclosed by
34438 \begin_inset Flex Code
34441 \begin_layout Plain Layout
34449 \begin_inset Flex Code
34452 \begin_layout Plain Layout
34459 They can be used by the templates in the
34460 \begin_inset Flex Code
34463 \begin_layout Plain Layout
34472 \begin_layout Section
34473 The substitution mechanism
34476 \begin_layout Standard
34477 When the external material facility invokes an external program,
34478 it is done on the basis of a command defined in the template configuration file.
34479 These commands can contain various macros that are expanded before execution.
34480 Execution always take place in the directory of the containing document.
34483 \begin_layout Standard
34485 whenever external material is to be displayed,
34486 the name will be produced by the substitution mechanism,
34487 and most other commands in the template definition support substitution as well.
34490 \begin_layout Standard
34491 The available macros are the following:
34494 \begin_layout Description
34495 \begin_inset Flex Code
34498 \begin_layout Plain Layout
34499 $$AbsOrRelPathMaster
34505 absolute or relative to the master \SpecialChar LyX
34509 \begin_layout Description
34510 \begin_inset Flex Code
34513 \begin_layout Plain Layout
34514 $$AbsOrRelPathParent
34520 absolute or relative to the \SpecialChar LyX
34524 \begin_layout Description
34525 \begin_inset Flex Code
34528 \begin_layout Plain Layout
34534 The absolute file path.
34537 \begin_layout Description
34538 \begin_inset Flex Code
34541 \begin_layout Plain Layout
34547 The filename without path and without the extension.
34550 \begin_layout Description
34551 \begin_inset Flex Code
34554 \begin_layout Plain Layout
34556 \begin_inset Quotes eld
34560 \begin_inset Quotes erd
34568 This macro will expand to the contents of the file with the name
34569 \begin_inset Flex Code
34572 \begin_layout Plain Layout
34581 \begin_layout Description
34582 \begin_inset Flex Code
34585 \begin_layout Plain Layout
34591 The file extension (including the dot).
34594 \begin_layout Description
34595 \begin_inset Flex Code
34598 \begin_layout Plain Layout
34604 This will be the string
34605 \begin_inset Quotes eld
34609 \begin_inset Quotes erd
34612 if the file is in JPEG format,
34613 otherwise it will be the string
34614 \begin_inset Quotes eld
34618 \begin_inset Quotes erd
34622 This is useful to avoid uneeded conversions for output formats that support both PNG and JPEG fomats.
34623 The predefined RasterImage template uses this macro for the pdf\SpecialChar TeX
34627 \begin_layout Description
34628 \begin_inset Flex Code
34631 \begin_layout Plain Layout
34637 The filename of the file specified in the external material dialog.
34638 This is either an absolute name,
34639 or it is relative to the \SpecialChar LyX
34643 \begin_layout Description
34644 \begin_inset Flex Code
34647 \begin_layout Plain Layout
34654 \begin_inset Flex Code
34657 \begin_layout Plain Layout
34663 (absolute name or relative to the \SpecialChar LyX
34667 \begin_layout Description
34668 \begin_inset Flex Code
34671 \begin_layout Plain Layout
34678 relative to the master \SpecialChar LyX
34682 \begin_layout Description
34683 \begin_inset Flex Code
34686 \begin_layout Plain Layout
34693 relative to the \SpecialChar LyX
34697 \begin_layout Description
34698 \begin_inset Flex Code
34701 \begin_layout Plain Layout
34707 This macro will expand to the absolute path of the system directory.
34708 This is typically used to point to the various helper scripts that are bundled with \SpecialChar LyX
34712 \begin_layout Description
34713 \begin_inset Flex Code
34716 \begin_layout Plain Layout
34722 A name and full path to a temporary file which will be automatically deleted whenever the containing document is closed,
34723 or the external material insertion deleted.
34726 \begin_layout Standard
34727 All path macros contain a trailing directory separator,
34728 so you can construct e.
34729 \begin_inset space \thinspace{}
34733 \begin_inset space \space{}
34736 the absolute filename with
34737 \begin_inset Flex Code
34740 \begin_layout Plain Layout
34741 $$AbsPath$$Basename$$Extension
34749 \begin_layout Standard
34750 The macros above are substituted in all commands unless otherwise noted.
34752 \begin_inset Flex Code
34755 \begin_layout Plain Layout
34761 supports additionally the following substitutions if they are enabled by the
34762 \begin_inset Flex Code
34765 \begin_layout Plain Layout
34772 \begin_inset Flex Code
34775 \begin_layout Plain Layout
34784 \begin_layout Description
34785 \begin_inset Flex Code
34788 \begin_layout Plain Layout
34794 The front part of the resize command.
34797 \begin_layout Description
34798 \begin_inset Flex Code
34801 \begin_layout Plain Layout
34807 The back part of the resize command.
34810 \begin_layout Description
34811 \begin_inset Flex Code
34814 \begin_layout Plain Layout
34820 The front part of the rotation command.
34823 \begin_layout Description
34824 \begin_inset Flex Code
34827 \begin_layout Plain Layout
34833 The back part of the rotation command.
34836 \begin_layout Standard
34837 The value string of the
34838 \begin_inset Flex Code
34841 \begin_layout Plain Layout
34847 command supports additionally the following substitutions if they are enabled by the
34848 \begin_inset Flex Code
34851 \begin_layout Plain Layout
34858 \begin_inset Flex Code
34861 \begin_layout Plain Layout
34870 \begin_layout Description
34871 \begin_inset Flex Code
34874 \begin_layout Plain Layout
34883 \begin_layout Description
34884 \begin_inset Flex Code
34887 \begin_layout Plain Layout
34896 \begin_layout Description
34897 \begin_inset Flex Code
34900 \begin_layout Plain Layout
34909 \begin_layout Description
34910 \begin_inset Flex Code
34913 \begin_layout Plain Layout
34919 The rotation option.
34922 \begin_layout Standard
34923 You may ask why there are so many path macros.
34924 There are mainly two reasons:
34927 \begin_layout Enumerate
34928 Relative and absolute file names should remain relative or absolute,
34930 Users may have reasons to prefer either form.
34931 Relative names are useful for portable documents that should work on different machines,
34933 Absolute names may be required by some programs.
34936 \begin_layout Enumerate
34938 treats relative file names differently than \SpecialChar LyX
34939 and other programs in nested included files.
34940 For \SpecialChar LyX
34942 a relative file name is always relative to the document that contains the file name.
34943 For \SpecialChar LaTeX
34945 it is always relative to the master document.
34946 These two definitions are identical if you have only one document,
34947 but differ if you have a master document that includes part documents.
34948 That means that relative filenames must be transformed when presented to \SpecialChar LaTeX
34950 Fortunately \SpecialChar LyX
34951 does this automatically for you if you choose the right macros.
34954 \begin_layout Standard
34955 So which path macro should be used in new template definitions?
34956 The rule is not difficult:
34959 \begin_layout Itemize
34961 \begin_inset Flex Code
34964 \begin_layout Plain Layout
34970 if an absolute path is required.
34973 \begin_layout Itemize
34975 \begin_inset Flex Code
34978 \begin_layout Plain Layout
34979 $$AbsOrRelPathMaster
34984 if the substituted string is some kind of \SpecialChar LaTeX
34988 \begin_layout Itemize
34990 \begin_inset Flex Code
34993 \begin_layout Plain Layout
34994 $$AbsOrRelPathParent
34999 in order to preserve the user's choice.
35002 \begin_layout Standard
35003 There are special cases where this rule does not work and e.
35004 \begin_inset space \thinspace{}
35008 \begin_inset space \space{}
35011 relative names are needed,
35012 but normally it will work just fine.
35013 One example for such a case is the command
35014 \begin_inset Flex Code
35017 \begin_layout Plain Layout
35018 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
35023 in the XFig template above:
35024 We can't use the absolute name because the copier for
35025 \begin_inset Flex Code
35028 \begin_layout Plain Layout
35034 files needs the relative name in order to rewrite the file content.
35037 \begin_layout Section
35038 Security discussion
35039 \begin_inset CommandInset label
35041 name "sec:Security-discussion"
35048 \begin_layout Standard
35049 The external material feature interfaces with a lot of external programs and does so automatically,
35050 so we have to consider the security implications of this.
35052 since you have the option of including your own filenames and/or parameter strings and those are expanded into a command,
35053 it seems that it would be possible to create a malicious document which executes arbitrary commands when a user views or prints the document.
35054 This is something we definitely want to avoid.
35057 \begin_layout Standard
35059 since the external program commands are specified in the template configuration file only,
35060 there are no security issues if \SpecialChar LyX
35061 is properly configured with safe templates only.
35062 This is so because the external programs are invoked with the
35063 \begin_inset Flex Code
35066 \begin_layout Plain Layout
35072 -system call rather than the
35073 \begin_inset Flex Code
35076 \begin_layout Plain Layout
35083 so it's not possible to execute arbitrary commands from the filename or parameter section via the shell.
35086 \begin_layout Standard
35087 This also implies that you are restricted in what command strings you can use in the external material templates.
35089 pipes and redirection are not readily available.
35090 This has to be so if \SpecialChar LyX
35091 should remain safe.
35092 If you want to use some of the shell features,
35093 you should write a safe script to do this in a controlled manner,
35094 and then invoke the script from the command string.
35098 \begin_layout Standard
35099 It is possible to design a template that interacts directly with the shell,
35100 but since this would allow a malicious user to execute arbitrary commands by writing clever filenames and/or parameters,
35101 we generally recommend that you only use safe scripts that work with the
35102 \begin_inset Flex Code
35105 \begin_layout Plain Layout
35111 system call in a controlled manner.
35113 for use in a controlled environment,
35114 it can be tempting to just fall back to use ordinary shell scripts.
35120 provide an easily exploitable security hole in your system.
35121 Of course it stands to reason that such unsafe templates will never be included in the standard \SpecialChar LyX
35123 although we do encourage people to submit new templates in the open source tradition.
35124 But \SpecialChar LyX
35125 as shipped from the official distribution channels will never have unsafe templates.
35128 \begin_layout Standard
35129 Including external material provides a lot of power,
35130 and you have to be careful not to introduce security hazards with this power.
35131 A subtle error in a single line in an innocent looking script can open the door to huge security problems.
35132 So if you do not fully understand the issues,
35133 we recommend that you consult a knowledgeable security professional or the \SpecialChar LyX
35134 development team if you have any questions about whether a given template is safe or not.
35135 And do this before you use it in an uncontrolled environment.
35138 \begin_layout Chapter
35140 List of supported \SpecialChar LyX
35141 functions to be used in layouts
35142 \begin_inset CommandInset label
35144 name "chap:List-of-functions"
35151 \begin_layout Standard
35153 \begin_inset Tabular
35154 <lyxtabular version="3" rows="11" columns="8">
35155 <features tabularvalignment="middle">
35156 <column alignment="left" valignment="top">
35157 <column alignment="left" valignment="top">
35158 <column alignment="left" valignment="top">
35159 <column alignment="left" valignment="top">
35160 <column alignment="left" valignment="top">
35161 <column alignment="left" valignment="top">
35162 <column alignment="left" valignment="top">
35163 <column alignment="left" valignment="top">
35165 <cell alignment="left" valignment="top" usebox="none">
35168 \begin_layout Plain Layout
35174 <cell alignment="left" valignment="top" usebox="none">
35177 \begin_layout Plain Layout
35183 <cell alignment="left" valignment="top" usebox="none">
35186 \begin_layout Plain Layout
35192 <cell alignment="left" valignment="top" usebox="none">
35195 \begin_layout Plain Layout
35201 <cell alignment="center" valignment="top" usebox="none">
35204 \begin_layout Plain Layout
35210 <cell alignment="center" valignment="top" usebox="none">
35213 \begin_layout Plain Layout
35219 <cell alignment="center" valignment="top" usebox="none">
35222 \begin_layout Plain Layout
35228 <cell alignment="center" valignment="top" usebox="none">
35231 \begin_layout Plain Layout
35239 <cell alignment="left" valignment="top" usebox="none">
35242 \begin_layout Plain Layout
35248 <cell alignment="left" valignment="top" usebox="none">
35251 \begin_layout Plain Layout
35257 <cell alignment="left" valignment="top" usebox="none">
35260 \begin_layout Plain Layout
35266 <cell alignment="left" valignment="top" usebox="none">
35269 \begin_layout Plain Layout
35275 <cell alignment="center" valignment="top" usebox="none">
35278 \begin_layout Plain Layout
35284 <cell alignment="center" valignment="top" usebox="none">
35287 \begin_layout Plain Layout
35293 <cell alignment="center" valignment="top" usebox="none">
35296 \begin_layout Plain Layout
35302 <cell alignment="center" valignment="top" usebox="none">
35305 \begin_layout Plain Layout
35313 <cell alignment="left" valignment="top" usebox="none">
35316 \begin_layout Plain Layout
35322 <cell alignment="left" valignment="top" usebox="none">
35325 \begin_layout Plain Layout
35331 <cell alignment="left" valignment="top" usebox="none">
35334 \begin_layout Plain Layout
35340 <cell alignment="left" valignment="top" usebox="none">
35343 \begin_layout Plain Layout
35349 <cell alignment="center" valignment="top" usebox="none">
35352 \begin_layout Plain Layout
35358 <cell alignment="center" valignment="top" usebox="none">
35361 \begin_layout Plain Layout
35367 <cell alignment="center" valignment="top" usebox="none">
35370 \begin_layout Plain Layout
35376 <cell alignment="center" valignment="top" usebox="none">
35379 \begin_layout Plain Layout
35387 <cell alignment="left" valignment="top" usebox="none">
35390 \begin_layout Plain Layout
35396 <cell alignment="left" valignment="top" usebox="none">
35399 \begin_layout Plain Layout
35405 <cell alignment="left" valignment="top" usebox="none">
35408 \begin_layout Plain Layout
35414 <cell alignment="left" valignment="top" usebox="none">
35417 \begin_layout Plain Layout
35423 <cell alignment="center" valignment="top" usebox="none">
35426 \begin_layout Plain Layout
35432 <cell alignment="center" valignment="top" usebox="none">
35435 \begin_layout Plain Layout
35441 <cell alignment="center" valignment="top" usebox="none">
35444 \begin_layout Plain Layout
35450 <cell alignment="center" valignment="top" usebox="none">
35453 \begin_layout Plain Layout
35461 <cell alignment="left" valignment="top" usebox="none">
35464 \begin_layout Plain Layout
35470 <cell alignment="left" valignment="top" usebox="none">
35473 \begin_layout Plain Layout
35479 <cell alignment="left" valignment="top" usebox="none">
35482 \begin_layout Plain Layout
35488 <cell alignment="left" valignment="top" usebox="none">
35491 \begin_layout Plain Layout
35497 <cell alignment="center" valignment="top" usebox="none">
35500 \begin_layout Plain Layout
35506 <cell alignment="center" valignment="top" usebox="none">
35509 \begin_layout Plain Layout
35515 <cell alignment="center" valignment="top" usebox="none">
35518 \begin_layout Plain Layout
35524 <cell alignment="center" valignment="top" usebox="none">
35527 \begin_layout Plain Layout
35535 <cell alignment="left" valignment="top" usebox="none">
35538 \begin_layout Plain Layout
35544 <cell alignment="left" valignment="top" usebox="none">
35547 \begin_layout Plain Layout
35553 <cell alignment="left" valignment="top" usebox="none">
35556 \begin_layout Plain Layout
35562 <cell alignment="left" valignment="top" usebox="none">
35565 \begin_layout Plain Layout
35571 <cell alignment="center" valignment="top" usebox="none">
35574 \begin_layout Plain Layout
35580 <cell alignment="center" valignment="top" usebox="none">
35583 \begin_layout Plain Layout
35589 <cell alignment="center" valignment="top" usebox="none">
35592 \begin_layout Plain Layout
35598 <cell alignment="center" valignment="top" usebox="none">
35601 \begin_layout Plain Layout
35609 <cell alignment="left" valignment="top" usebox="none">
35612 \begin_layout Plain Layout
35618 <cell alignment="left" valignment="top" usebox="none">
35621 \begin_layout Plain Layout
35627 <cell alignment="left" valignment="top" usebox="none">
35630 \begin_layout Plain Layout
35636 <cell alignment="left" valignment="top" usebox="none">
35639 \begin_layout Plain Layout
35645 <cell alignment="center" valignment="top" usebox="none">
35648 \begin_layout Plain Layout
35654 <cell alignment="center" valignment="top" usebox="none">
35657 \begin_layout Plain Layout
35663 <cell alignment="center" valignment="top" usebox="none">
35666 \begin_layout Plain Layout
35672 <cell alignment="center" valignment="top" usebox="none">
35675 \begin_layout Plain Layout
35683 <cell alignment="left" valignment="top" usebox="none">
35686 \begin_layout Plain Layout
35692 <cell alignment="left" valignment="top" usebox="none">
35695 \begin_layout Plain Layout
35701 <cell alignment="left" valignment="top" usebox="none">
35704 \begin_layout Plain Layout
35710 <cell alignment="left" valignment="top" usebox="none">
35713 \begin_layout Plain Layout
35719 <cell alignment="center" valignment="top" usebox="none">
35722 \begin_layout Plain Layout
35728 <cell alignment="center" valignment="top" usebox="none">
35731 \begin_layout Plain Layout
35737 <cell alignment="center" valignment="top" usebox="none">
35740 \begin_layout Plain Layout
35746 <cell alignment="center" valignment="top" usebox="none">
35749 \begin_layout Plain Layout
35757 <cell alignment="left" valignment="top" usebox="none">
35760 \begin_layout Plain Layout
35766 <cell alignment="left" valignment="top" usebox="none">
35769 \begin_layout Plain Layout
35775 <cell alignment="left" valignment="top" usebox="none">
35778 \begin_layout Plain Layout
35784 <cell alignment="left" valignment="top" usebox="none">
35787 \begin_layout Plain Layout
35793 <cell alignment="center" valignment="top" usebox="none">
35796 \begin_layout Plain Layout
35802 <cell alignment="center" valignment="top" usebox="none">
35805 \begin_layout Plain Layout
35811 <cell alignment="center" valignment="top" usebox="none">
35814 \begin_layout Plain Layout
35820 <cell alignment="center" valignment="top" usebox="none">
35823 \begin_layout Plain Layout
35831 <cell alignment="left" valignment="top" usebox="none">
35834 \begin_layout Plain Layout
35840 <cell alignment="left" valignment="top" usebox="none">
35843 \begin_layout Plain Layout
35849 <cell alignment="left" valignment="top" usebox="none">
35852 \begin_layout Plain Layout
35858 <cell alignment="left" valignment="top" usebox="none">
35861 \begin_layout Plain Layout
35867 <cell alignment="center" valignment="top" usebox="none">
35870 \begin_layout Plain Layout
35876 <cell alignment="center" valignment="top" usebox="none">
35879 \begin_layout Plain Layout
35885 <cell alignment="center" valignment="top" usebox="none">
35888 \begin_layout Plain Layout
35894 <cell alignment="center" valignment="top" usebox="none">
35897 \begin_layout Plain Layout
35905 <cell alignment="center" valignment="top" usebox="none">
35908 \begin_layout Plain Layout
35914 <cell alignment="center" valignment="top" usebox="none">
35917 \begin_layout Plain Layout
35923 <cell alignment="center" valignment="top" usebox="none">
35926 \begin_layout Plain Layout
35932 <cell alignment="center" valignment="top" usebox="none">
35935 \begin_layout Plain Layout
35941 <cell alignment="center" valignment="top" usebox="none">
35944 \begin_layout Plain Layout
35950 <cell alignment="center" valignment="top" usebox="none">
35953 \begin_layout Plain Layout
35959 <cell alignment="center" valignment="top" usebox="none">
35962 \begin_layout Plain Layout
35968 <cell alignment="center" valignment="top" usebox="none">
35971 \begin_layout Plain Layout
35985 \begin_layout Chapter
35986 Names of available colors to be used in layouts
35987 \begin_inset CommandInset label
35989 name "chap:Names-of-colors"
35996 \begin_layout Standard
35997 The colors listed below are the standard colors and those that you can adjust in the \SpecialChar LyX
36001 \begin_layout Section
36005 \begin_layout Standard
36006 The following are no real colors,
36007 but rather act on color definitions:
36010 \begin_layout Description
36011 ignore The color is ignored
36014 \begin_layout Description
36015 inherit The color is inherited
36018 \begin_layout Description
36031 No particular color – clear or default
36034 \begin_layout Section
36038 \begin_layout Standard
36039 These are fixed colors that cannot be customized
36040 \change_inserted -712698321 1607683177
36046 use these colors in layout definitions,
36047 since they will not work well with some color themes (such as dark themes)
36052 \begin_layout Description
36056 \begin_layout Description
36060 \begin_layout Description
36064 \begin_layout Description
36068 \begin_layout Description
36072 \begin_layout Description
36076 \begin_layout Description
36080 \begin_layout Description
36084 \begin_layout Description
36088 \begin_layout Description
36092 \begin_layout Description
36096 \begin_layout Description
36100 \begin_layout Description
36104 \begin_layout Description
36108 \begin_layout Description
36112 \begin_layout Description
36116 \begin_layout Description
36120 \begin_layout Description
36124 \begin_layout Description
36128 \begin_layout Section
36132 \begin_layout Standard
36133 These are the colors allocated to specific elements in
36136 arg "dialog-show prefs"
36142 \begin_layout Description
36143 added_space Added space color
36146 \begin_layout Description
36147 addedtext Added text color
36150 \begin_layout Description
36151 appendix Appendix marker color
36154 \begin_layout Description
36155 background Background color
36158 \begin_layout Description
36159 bottomarea Bottom area color
36162 \begin_layout Description
36163 branchlabel Label color for branches
36166 \begin_layout Description
36167 buttonbg Color used for button background
36170 \begin_layout Description
36171 buttonframe Color for inset button frames
36174 \begin_layout Description
36175 buttonhoverbg Color used for button background under focus
36178 \begin_layout Description
36179 changebar Changebar color
36182 \begin_layout Description
36183 changedtextauthor1 Changed text color author 1
36186 \begin_layout Description
36187 changedtextauthor2 Changed text color author 2
36190 \begin_layout Description
36191 changedtextauthor3 Changed text color author 3
36194 \begin_layout Description
36195 changedtextauthor4 Changed text color author 4
36198 \begin_layout Description
36199 changedtextauthor5 Changed text color author 5
36202 \begin_layout Description
36203 collapsible Collapsible insets text color
36206 \begin_layout Description
36207 collapsibleframe Collapsible insets framecolor
36210 \begin_layout Description
36211 command Text color for command insets
36214 \begin_layout Description
36215 commandbg Background color for command insets
36218 \begin_layout Description
36219 commandframe Frame color for command insets
36222 \begin_layout Description
36223 comment Label color for comments
36226 \begin_layout Description
36227 commentbg Background color of comments
36230 \begin_layout Description
36231 cursor Cursor color
36234 \begin_layout Description
36235 deletedtext Deleted text color
36238 \begin_layout Description
36239 deletedtextmodifier Deleted text modifying color
36242 \begin_layout Description
36243 depthbar Color for the depth bars in the margin
36246 \begin_layout Description
36247 eolmarker End of line marker color
36250 \begin_layout Description
36251 error Color of the \SpecialChar LaTeX
36255 \begin_layout Description
36256 footlabel Label color for footnotes
36259 \begin_layout Description
36260 foreground Foreground color
36263 \begin_layout Description
36264 graphicsbg Graphics inset background color
36267 \begin_layout Description
36268 greyedoutbg Background color of greyedout inset
36271 \begin_layout Description
36272 greyedoutlabel Label color for greyedout insets
36275 \begin_layout Description
36276 greyedouttext Color for greyedout inset text
36279 \begin_layout Description
36280 indexlabel Label color for index insets
36283 \begin_layout Description
36284 inlinecompletion Inline completion color
36287 \begin_layout Description
36288 insetbg Inset marker background color
36291 \begin_layout Description
36292 insetframe Inset marker frame color
36295 \begin_layout Description
36296 language Color for marking foreign language words
36299 \begin_layout Description
36300 latex Text color in \SpecialChar LaTeX
36304 \begin_layout Description
36305 listingsbg Background color of listings inset
36308 \begin_layout Description
36309 marginlabel Label color for margin notes
36312 \begin_layout Description
36313 math Math inset text color
36316 \begin_layout Description
36317 mathbg Math inset background color
36320 \begin_layout Description
36321 mathcorners Math inset frame color not under focus
36324 \begin_layout Description
36325 mathframe Math inset frame color under focus
36328 \begin_layout Description
36329 mathline Math line color
36332 \begin_layout Description
36333 mathmacrobg Macro math inset background color
36336 \begin_layout Description
36337 mathmacroblend Macro math blended color
36340 \begin_layout Description
36341 mathmacroframe Macro math frame color
36344 \begin_layout Description
36345 mathmacrohoverbg Macro math inset background color hovered
36348 \begin_layout Description
36349 mathmacrolabel Macro math label color
36352 \begin_layout Description
36353 mathmacronewarg Macro template color for new parameters
36356 \begin_layout Description
36357 mathmacrooldarg Macro template color for old parameters
36360 \begin_layout Description
36361 newpage New page color
36364 \begin_layout Description
36365 nonunique_inlinecompletion Inline completion color for the non-unique part
36368 \begin_layout Description
36369 note Label color for notes
36372 \begin_layout Description
36373 notebg Background color of notes
36376 \begin_layout Description
36377 pagebreak Page break/line break color
36380 \begin_layout Description
36381 paragraphmarker Color used for the pilcrow sign to mark the end of a paragraph
36384 \begin_layout Description
36385 phantomtext Text color for phantom insets
36388 \begin_layout Description
36389 preview The color used for previews
36392 \begin_layout Description
36393 previewframe Preview frame color
36396 \begin_layout Description
36397 regexpframe Color for regexp frame
36400 \begin_layout Description
36401 scroll Color that indicates when a row can be scrolled
36404 \begin_layout Description
36405 selection Background color of selected text
36408 \begin_layout Description
36409 selectiontext Foreground color of selected text
36412 \begin_layout Description
36413 shadedbg Background color of shaded box
36416 \begin_layout Description
36417 special Special chars text color
36420 \begin_layout Description
36421 tabularline Table line color
36424 \begin_layout Description
36425 tabularonoffline Table line color
36426 \change_inserted -712698321 1607682522
36430 \begin_layout Description
36432 \change_inserted -712698321 1607682563
36433 textlabel1 Color 1 of layout and custom inset labels
36436 \begin_layout Description
36438 \change_inserted -712698321 1607682565
36439 textlabel2 Color 2 of layout and custom inset labels
36442 \begin_layout Description
36444 \change_inserted -712698321 1607682568
36445 textlabel3 Color 3 of layout and custom inset labels
36450 \begin_layout Description
36451 urllabel Label color for URL insets
36454 \begin_layout Description
36455 urltext Color for URL inset text