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
2842 \change_inserted -712698321 1676553236
2843 \begin_inset Flex Code
2846 \begin_layout Plain Layout
2848 \change_inserted -712698321 1676552303
2856 This converter is considered non-safe and needs authorization by the user.
2857 Depending on the settings in
2859 Tools\SpecialChar menuseparator
2860 Preferences\SpecialChar menuseparator
2861 File Handling\SpecialChar menuseparator
2865 users will (a.) be asked whether they trust the current document temporarily,
2868 (b.) be informed that conversion is not possible due to security concerns,
2869 or (c.) not be informed as they gave permanent consent.
2870 Set this flag for converters that might execute arbitrary programs.
2873 \begin_layout Labeling
2874 \labelwidthstring 00.00.0000
2875 \begin_inset Flex Code
2878 \begin_layout Plain Layout
2880 \change_inserted -712698321 1524656935
2888 Needs the \SpecialChar LaTeX
2890 \begin_inset Flex Noun
2893 \begin_layout Plain Layout
2899 file for the conversion.
2901 \change_inserted -712698321 1524657047
2903 \begin_inset Flex Code
2906 \begin_layout Plain Layout
2908 \change_inserted -712698321 1524657030
2916 value specifies the form of \SpecialChar LaTeX
2917 that is run in order to generate the
2918 \begin_inset Flex Noun
2921 \begin_layout Plain Layout
2923 \change_inserted -712698321 1524657047
2932 \begin_inset Flex Code
2935 \begin_layout Plain Layout
2937 \change_inserted -712698321 1524657030
2950 If no value is specified,
2952 \begin_inset Flex Code
2955 \begin_layout Plain Layout
2957 \change_inserted -712698321 1524657030
2970 \begin_layout Labeling
2971 \labelwidthstring 00.00.0000
2972 \begin_inset Flex Code
2975 \begin_layout Plain Layout
2982 \begin_inset Quotes eld
2986 \begin_inset Quotes erd
2989 file from the backend,
2990 which in practice means a \SpecialChar LaTeX
2991 file like the one we would export,
2993 \begin_inset Flex Code
2996 \begin_layout Plain Layout
3005 \begin_layout Labeling
3006 \labelwidthstring 00.00.0000
3007 \begin_inset Flex Code
3010 \begin_layout Plain Layout
3019 \begin_layout Standard
3020 The following three flags are not really flags at all because they take an argument in the
3021 \begin_inset Flex Noun
3024 \begin_layout Plain Layout
3026 \begin_inset space ~
3030 \begin_inset space ~
3041 \begin_layout Labeling
3042 \labelwidthstring 00.00.0000
3044 \change_inserted -712698321 1523206314
3045 \begin_inset Flex Code
3048 \begin_layout Plain Layout
3050 \change_inserted -712698321 1523206193
3058 The name of the driver that needs to be loaded with the
3062 package for this converter.
3063 The loading of the correct driver is necessary to get some PDF-specific features.
3071 \begin_layout Labeling
3072 \labelwidthstring 00.00.0000
3073 \begin_inset Flex Code
3076 \begin_layout Plain Layout
3083 the converter's standard error will be redirected to a file
3084 \begin_inset Flex Code
3087 \begin_layout Plain Layout
3094 and the script given as argument will be run as:
3096 \begin_inset Flex Code
3099 \begin_layout Plain Layout
3100 script < infile.out > infile.log
3106 The argument may contain
3107 \begin_inset Flex Code
3110 \begin_layout Plain Layout
3119 \begin_layout Labeling
3120 \labelwidthstring 00.00.0000
3121 \begin_inset Flex Code
3124 \begin_layout Plain Layout
3130 The name of the directory in which the converter will dump the generated files.
3132 will not create this directory,
3133 and it does not copy anything into it,
3134 though it will copy this directory to the destination.
3135 The argument may contain
3136 \begin_inset Flex Code
3139 \begin_layout Plain Layout
3146 which will be replaced by the base name of the input and output files,
3148 when the directory is copied.
3149 \begin_inset Newline newline
3152 Note that resultdir and usetempdir make no sense together.
3153 The latter will be ignored if the former is given.
3156 \begin_layout Labeling
3157 \labelwidthstring 00.00.0000
3158 \begin_inset Flex Code
3161 \begin_layout Plain Layout
3167 Determines the output file name and may,
3169 \begin_inset Flex Code
3172 \begin_layout Plain Layout
3179 Sensible only with resultdir and optional even then;
3181 it defaults to `index'.
3184 \begin_layout Standard
3186 \change_inserted -712698321 1523206384
3187 A suitable hyperref-driver is set for some converters that are installed with \SpecialChar LyX
3190 \change_deleted -712698321 1523206388
3192 \change_inserted -712698321 1523206389
3196 \change_inserted -712698321 1523206400
3202 \change_inserted -712698321 1523206407
3206 \change_inserted -712698321 1523206437
3210 \change_deleted -712698321 1523206442
3211 that are installed with \SpecialChar LyX
3218 \begin_layout Standard
3219 You do not have to define converters for all formats between which you want to convert.
3221 you will note that there is no `\SpecialChar LyX
3222 to PostScript' converter,
3223 but \SpecialChar LyX
3224 will export PostScript.
3225 It does so by first creating a \SpecialChar LaTeX
3226 file (no converter needs to be defined for this) which is then converted to DVI using the `\SpecialChar LaTeX
3228 and finally converting the resulting DVI file to PostScript.
3230 finds such `chains' of converters automatically,
3231 and it will always choose the shortest possible chain.
3234 still define multiple conversion methods between file formats.
3236 the standard \SpecialChar LyX
3237 configuration provides five ways to convert \SpecialChar LaTeX
3241 \begin_layout Enumerate
3244 \begin_inset Flex Noun
3247 \begin_layout Plain Layout
3256 \begin_layout Enumerate
3257 via (DVI and) PostScript,
3259 \begin_inset Flex Noun
3262 \begin_layout Plain Layout
3271 \begin_layout Enumerate
3274 \begin_inset Flex Noun
3277 \begin_layout Plain Layout
3286 \begin_layout Enumerate
3288 \begin_inset Flex Noun
3291 \begin_layout Plain Layout
3301 \begin_layout Enumerate
3303 \begin_inset Flex Noun
3306 \begin_layout Plain Layout
3316 \begin_layout Standard
3317 To define such alternate chains,
3318 you must define multiple target `file formats',
3320 \begin_inset CommandInset ref
3322 reference "sec:Formats"
3329 in the standard configuration,
3331 \begin_inset Flex Noun
3334 \begin_layout Plain Layout
3341 \begin_inset Flex Noun
3344 \begin_layout Plain Layout
3352 \begin_inset Flex Noun
3355 \begin_layout Plain Layout
3362 \begin_inset Flex Noun
3365 \begin_layout Plain Layout
3373 \begin_inset Flex Noun
3376 \begin_layout Plain Layout
3383 \begin_inset Flex Noun
3386 \begin_layout Plain Layout
3394 \begin_inset Flex Noun
3397 \begin_layout Plain Layout
3404 \begin_inset Flex Noun
3407 \begin_layout Plain Layout
3416 \begin_inset Flex Noun
3419 \begin_layout Plain Layout
3426 \begin_inset Flex Noun
3429 \begin_layout Plain Layout
3437 all of which share the extension
3438 \begin_inset Flex Noun
3441 \begin_layout Plain Layout
3448 and which correspond to the conversion methods just mentioned.
3451 \begin_layout Chapter
3452 Internationalizing \SpecialChar LyX
3454 \begin_inset CommandInset label
3456 name "cha:Internationalizing-LyX"
3463 \begin_layout Standard
3465 supports using a translated interface.
3466 Last time we checked,
3468 provided text in thirty languages.
3469 The language of choice is called your
3474 (For further reading on locale settings,
3475 see also the documentation for locale that comes with your operating system.
3478 \begin_inset Flex Code
3481 \begin_layout Plain Layout
3487 could be a good place to start).
3490 \begin_layout Standard
3491 Notice that these translations will work,
3492 but do contain a few flaws.
3494 all dialogs have been designed with the English text in mind,
3495 which means that some of the translated text will be too large to fit within the space allocated.
3496 This is only a display problem and will not cause any harm.
3498 you will find that some of the translations do not define shortcut keys for everything.
3500 there are simply not enough free letters to do it.
3502 the translator just hasn't got around to doing it yet.
3503 Our localization team,
3504 which you may wish to join,
3508 \begin_layout Plain Layout
3509 If you are a fluent speaker of a language other than English,
3510 joining these teams is a great way to give back to the \SpecialChar LyX
3516 will of course try to fix these shortcomings in future versions of \SpecialChar LyX
3520 \begin_layout Section
3521 Translating \SpecialChar LyX
3525 \begin_layout Subsection
3526 Translating the graphical user interface (text messages).
3529 \begin_layout Standard
3532 \begin_inset Flex Code
3535 \begin_layout Plain Layout
3541 library to handle the internationalization of the interface.
3542 To have \SpecialChar LyX
3543 speak your favorite language in all menus and dialogs,
3545 \begin_inset Flex Code
3548 \begin_layout Plain Layout
3554 -file for that language.
3555 When this is available,
3556 you'll have to generate a
3557 \begin_inset Flex Code
3560 \begin_layout Plain Layout
3566 -file from it and install the
3567 \begin_inset Flex Code
3570 \begin_layout Plain Layout
3577 The process of doing all of this is explained in the documentation for GNU
3578 \begin_inset Flex Code
3581 \begin_layout Plain Layout
3588 It is possible to do this just for yourself,
3589 but if you're going to do it,
3590 you might as well share the results of your labors with the rest of the \SpecialChar LyX
3592 Send a message to the \SpecialChar LyX
3593 developers' list for more information about how to proceed.
3596 \begin_layout Standard
3598 this is what you should do (xx denotes the language code):
3601 \begin_layout Itemize
3602 Check out the \SpecialChar LyX
3605 \begin_inset CommandInset href
3607 name "information on the web"
3608 target "https://www.lyx.org/HowToUseGIT"
3616 \begin_layout Itemize
3618 \begin_inset Flex Code
3621 \begin_layout Plain Layout
3627 to the folder of the
3628 \begin_inset Flex Code
3631 \begin_layout Plain Layout
3639 \begin_inset Flex Code
3642 \begin_layout Plain Layout
3650 \begin_inset Flex Code
3653 \begin_layout Plain Layout
3659 doesn't exist anywhere,
3660 it can be remade with the console command
3661 \begin_inset Flex Code
3664 \begin_layout Plain Layout
3671 or you can use an existing po-file for some other language as a template).
3674 \begin_layout Itemize
3676 \begin_inset Flex Code
3679 \begin_layout Plain Layout
3689 \begin_layout Plain Layout
3690 This is just a text file,
3691 so it can be edited in any text editor.
3692 But there are also specialized programs that support such editing,
3697 (for all platforms) or
3706 contains a `mode' for editing
3707 \begin_inset Flex Code
3710 \begin_layout Plain Layout
3719 \begin_inset Flex URL
3722 \begin_layout Plain Layout
3724 https://www.gnu.org/software/gettext/manual/html_node/PO-Mode.html#PO-Mode
3734 For some menu- and widget-labels,
3735 there are also shortcut keys that should be translated.
3736 Those keys are marked after a `|',
3737 and should be translated according to the words and phrases of the language.
3738 You should also fill also out the information at the beginning of the new
3739 \begin_inset Flex Code
3742 \begin_layout Plain Layout
3748 -file with your email-address,
3750 so people know where to reach you with suggestions and entertaining flames.
3753 \begin_layout Standard
3754 If you are just doing this on your own,
3758 \begin_layout Itemize
3760 \begin_inset Flex Code
3763 \begin_layout Plain Layout
3770 This can be done with
3771 \begin_inset Flex Code
3774 \begin_layout Plain Layout
3775 msgfmt -o xx.mo < xx.po
3783 \begin_layout Itemize
3785 \begin_inset Flex Code
3788 \begin_layout Plain Layout
3794 -file to your locale-tree,
3795 at the correct directory for application messages for the language
3801 \begin_inset Flex Code
3804 \begin_layout Plain Layout
3811 \begin_inset space \thinspace{}
3815 \begin_inset space \space{}
3819 \begin_inset Flex Code
3822 \begin_layout Plain Layout
3823 /usr/local/share/locale/xx/LC_MESSAGES/lyx.mo
3833 \begin_layout Standard
3836 it would be best if the new
3837 \begin_inset Flex Code
3840 \begin_layout Plain Layout
3846 file could be added to the \SpecialChar LyX
3848 so others can use it.
3849 Adding it involves making additional changes to \SpecialChar LyX
3851 So send an email to the developers' mailing list if you're interested in doing that.
3854 \begin_layout Subsubsection
3858 \begin_layout Standard
3859 Sometimes it turns out that one English message needs to be translated into different messages in the target language.
3860 One example is the message
3861 \begin_inset Flex Code
3864 \begin_layout Plain Layout
3870 which has the German translation
3879 depending upon exactly what the English
3880 \begin_inset Quotes eld
3884 \begin_inset Quotes erd
3889 \begin_inset Flex Code
3892 \begin_layout Plain Layout
3898 does not handle such ambiguous translations.
3899 Therefore you have to add some context information to the message:
3901 \begin_inset Flex Code
3904 \begin_layout Plain Layout
3911 \begin_inset Flex Code
3914 \begin_layout Plain Layout
3915 To[[as in 'From format x to format y']]
3921 \begin_inset Flex Code
3924 \begin_layout Plain Layout
3925 To[[as in 'From page x to page y']].
3930 Now the two occurrences of
3931 \begin_inset Flex Code
3934 \begin_layout Plain Layout
3941 \begin_inset Flex Code
3944 \begin_layout Plain Layout
3950 and can be translated correctly to
3962 \begin_layout Standard
3963 Of course the context information needs to be stripped off the original message when no translation is used.
3964 Therefore you have to put it in double square brackets at the end of the message (see the example above).
3965 The translation mechanism of \SpecialChar LyX
3966 ensures that everything in double square brackets at the end of messages is removed before displaying the message.
3969 \begin_layout Subsection
3970 Translating the documentation.
3973 \begin_layout Standard
3974 The online documentation (in the
3975 \begin_inset Flex Noun
3978 \begin_layout Plain Layout
3984 -menu) can (and should!) be translated.
3985 If there are translated versions of the documentation available
3989 \begin_layout Plain Layout
3991 at least some of the documents have been translated into fourteen languages,
3992 with the Tutorial available in a few more.
3997 and the locale is set accordingly,
3998 these will be used automagically by \SpecialChar LyX
4001 looks for translated versions as
4002 \begin_inset Flex Code
4005 \begin_layout Plain Layout
4006 LyXDir/doc/xx/DocName.lyx
4013 \begin_inset Flex Code
4016 \begin_layout Plain Layout
4022 is the code for the language currently in use.
4023 If there are no translated documents,
4024 the default English versions will be displayed.
4025 Note that the translated versions must have the same filenames (
4026 \begin_inset Flex Code
4029 \begin_layout Plain Layout
4035 above) as the original.
4036 If you feel up to translating the documentation (an excellent way to proof-read the original documentation by the way!),
4037 there are a few things you should do right away:
4040 \begin_layout Itemize
4041 Check out the documentation translation web page at
4042 \begin_inset CommandInset href
4044 name "https://www.lyx.org/Translation"
4045 target "https://www.lyx.org/Translation"
4052 you can find out which (if any) documents have already been translated into your language.
4053 You can also find out who (if anyone) is organizing the effort to translate the documentation into your language.
4054 If no one is organizing the effort,
4055 please let us know that you're interested.
4058 \begin_layout Standard
4059 Once you get to actually translating,
4060 here's a few hints for you that may save you trouble:
4063 \begin_layout Itemize
4064 Join the documentation team!
4065 There is information on how to do that in
4066 \begin_inset Flex Code
4069 \begin_layout Plain Layout
4076 \begin_inset Flex Noun
4079 \begin_layout Plain Layout
4080 Help\SpecialChar menuseparator
4087 which by the way is the first document you should translate.
4090 \begin_layout Itemize
4091 Learn the typographic conventions for the language you are translating to.
4092 Typography is an ancient art and over the centuries,
4093 a great variety of conventions have developed throughout different parts of the world.
4094 Also study the professional terminology amongst typographers in your country.
4095 Inventing your own terminology will only confuse the users.
4099 Typography is addictive!)
4102 \begin_layout Itemize
4103 Make a copy of the document.
4104 This will be your working copy.
4105 You can use this as your personal translated help-file by placing it in your
4106 \begin_inset Flex Code
4109 \begin_layout Plain Layout
4116 \begin_inset Note Greyedout
4119 \begin_layout Plain Layout
4125 For a complex document with external material (images,
4127 if you make a copy e.
4128 \begin_inset space \thinspace{}
4132 \begin_inset space \space{}
4136 beware that the links to external material may be broken when the document is moved to a different place.
4137 The best way is to retrieve the \SpecialChar LyX
4139 \begin_inset Flex URL
4142 \begin_layout Plain Layout
4144 https://www.lyx.org/HowToUseGIT
4149 ) and to edit the doc file in place.
4157 \begin_layout Itemize
4158 Sometimes the original document (from the \SpecialChar LyX
4159 team) will be updated.
4160 Use the source viewer at
4161 \begin_inset CommandInset href
4163 name "https://www.lyx.org/trac/timeline"
4164 target "https://www.lyx.org/trac/timeline"
4169 to see what has been changed.
4170 That way you can easily see which parts of the translated document need to be updated.
4173 \begin_layout Standard
4174 If you ever find an error in the original document,
4175 fix it and notify the rest of the documentation team of the changes!
4176 (You didn't forget to join the documentation team,
4180 \begin_layout Standard
4181 \begin_inset Branch OutDated
4185 \begin_layout Section
4186 International Keyboard Support
4189 \begin_layout Standard
4193 The following section is by
4201 It needs to be fixed to conform to the new Documentation Style sheet and to make use of the new v1.0 features.
4202 The whole thing also needs to be merged with the section following it.-jw It may also be badly out of date.-rh (2008)]
4205 \begin_layout Subsection
4206 Defining Own Keymaps:
4210 \begin_layout Standard
4211 Let's look at a keyboard definition file a little closer.
4212 It is a plain text file defining
4215 \begin_layout Itemize
4216 key-to-key or key-to-string translations
4219 \begin_layout Itemize
4223 \begin_layout Itemize
4224 dead keys exceptions
4227 \begin_layout Standard
4228 To define key-to-key or key-to-string translation,
4232 \begin_layout Quotation
4233 \begin_inset Flex Code
4236 \begin_layout Plain Layout
4245 \begin_inset Flex Code
4248 \begin_layout Plain Layout
4257 \begin_layout Standard
4259 \begin_inset Flex Code
4262 \begin_layout Plain Layout
4268 is the key to be translated and
4269 \begin_inset Flex Code
4272 \begin_layout Plain Layout
4278 is the string to be inserted into the document.
4279 To define dead keys,
4283 \begin_layout Quotation
4284 \begin_inset Flex Code
4287 \begin_layout Plain Layout
4296 \begin_inset Flex Code
4299 \begin_layout Plain Layout
4308 \begin_layout Standard
4310 \begin_inset Flex Code
4313 \begin_layout Plain Layout
4319 is a keyboard key and
4320 \begin_inset Flex Code
4323 \begin_layout Plain Layout
4330 The following dead keys are supported (shortcut name is in parentheses):
4333 \begin_layout Quotation
4337 \begin_inset space \hfill{}
4343 \begin_layout Quotation
4345 \begin_inset space \hfill{}
4351 \begin_layout Quotation
4353 \begin_inset space \hfill{}
4359 \begin_layout Quotation
4361 \begin_inset space \hfill{}
4367 \begin_layout Quotation
4369 \begin_inset space \hfill{}
4375 \begin_layout Quotation
4377 \begin_inset space \hfill{}
4384 \begin_layout Plain Layout
4396 \begin_layout Quotation
4398 \begin_inset space \hfill{}
4404 \begin_layout Quotation
4406 \begin_inset space \hfill{}
4413 \begin_layout Plain Layout
4425 \begin_layout Quotation
4427 \begin_inset space \hfill{}
4433 \begin_layout Quotation
4435 \begin_inset space \hfill{}
4441 \begin_layout Quotation
4443 \begin_inset space \hfill{}
4450 \begin_layout Plain Layout
4462 \begin_layout Quotation
4464 \begin_inset space \hfill{}
4471 \begin_layout Plain Layout
4483 \begin_layout Quotation
4485 \begin_inset space \hfill{}
4491 \begin_layout Quotation
4492 hungarian umlaut (hug)
4493 \begin_inset space \hfill{}
4499 \begin_layout Quotation
4501 \begin_inset space \hfill{}
4507 \begin_layout Quotation
4509 \begin_inset space \hfill{}
4516 \begin_layout Plain Layout
4528 \begin_layout Standard
4529 Since in many international keyboards there are exceptions to what some dead keys should do,
4530 you can define them using
4533 \begin_layout Quotation
4534 \begin_inset Flex Code
4537 \begin_layout Plain Layout
4545 deadkey key outstring
4548 \begin_layout Standard
4551 if you enter caron-o,
4552 it generates circumflex-o,
4556 \begin_layout Quotation
4557 \begin_inset Flex Code
4560 \begin_layout Plain Layout
4573 \begin_layout Standard
4574 to make it work correctly.
4576 you have to define as exceptions dead keys over i and j,
4577 to remove the dot from them before inserting an accent mark.
4578 I will change this when the time comes,
4579 but so far I haven't had time.
4582 \begin_layout Standard
4584 and about characters:
4585 backslash is escaped,
4587 you'll need double backslash.
4590 \begin_inset Flex Code
4593 \begin_layout Plain Layout
4599 have different meaning.
4601 \begin_inset Flex Code
4604 \begin_layout Plain Layout
4611 quotes start and end \SpecialChar LaTeX
4615 \begin_inset Flex Code
4618 \begin_layout Plain Layout
4628 \begin_inset Flex Code
4631 \begin_layout Plain Layout
4639 \begin_inset Flex Code
4642 \begin_layout Plain Layout
4653 \begin_layout Standard
4654 If you make a keyboard description file that works for your language,
4655 please mail it to me,
4656 so I can include it in the next keymap distribution.
4659 \begin_layout Standard
4660 More keywords will be supported in keymap configuration file in future,
4664 \begin_layout Itemize
4665 \begin_inset Flex Code
4668 \begin_layout Plain Layout
4679 \begin_inset space \hfill{}
4683 \begin_inset Flex Code
4686 \begin_layout Plain Layout
4695 \begin_layout Itemize
4696 \begin_inset Flex Code
4699 \begin_layout Plain Layout
4710 \begin_inset space \hfill{}
4714 \begin_inset Flex Code
4717 \begin_layout Plain Layout
4723 an external keymap translation program
4726 \begin_layout Standard
4729 \begin_inset Flex Code
4732 \begin_layout Plain Layout
4741 \begin_inset Flex Code
4744 \begin_layout Plain Layout
4752 option to include default keyboard).
4760 \begin_layout Section
4761 International Keymap Stuff
4762 \begin_inset CommandInset label
4764 name "sec:International-Keymap-Stuff"
4771 \begin_layout Standard
4772 \begin_inset Note Note
4775 \begin_layout Plain Layout
4776 In doing the revisions on this document in March 2008,
4777 I did not look over this stuff,
4778 as I do not understand it.
4779 It would be good if someone else could do so.
4788 \begin_layout Standard
4789 The next two sections describe the
4790 \begin_inset Flex Code
4793 \begin_layout Plain Layout
4802 \begin_inset Flex Code
4805 \begin_layout Plain Layout
4813 file syntax in detail.
4814 These sections should help you design your own key map if the ones provided do not meet your needs.
4817 \begin_layout Subsection
4821 \begin_layout Standard
4825 \begin_inset Flex Code
4828 \begin_layout Plain Layout
4834 file maps keystrokes to characters or strings.
4835 As the name suggests,
4836 it sets a keyboard mapping.
4838 \begin_inset Flex Code
4841 \begin_layout Plain Layout
4852 \begin_inset Flex Code
4855 \begin_layout Plain Layout
4871 \begin_inset Flex Code
4874 \begin_layout Plain Layout
4888 \begin_inset Flex Code
4891 \begin_layout Plain Layout
4901 \begin_inset Flex Code
4904 \begin_layout Plain Layout
4912 are described in this section.
4915 \begin_layout Labeling
4916 \labelwidthstring 00.00.0000
4917 \begin_inset Flex Code
4920 \begin_layout Plain Layout
4928 Map a character to a string
4931 \begin_layout LyX-Code
4946 \begin_layout Standard
4980 the double-quote (")
4997 must be escaped with a preceding backslash (
5008 \begin_layout Standard
5010 \begin_inset Flex Noun
5013 \begin_layout Plain Layout
5021 statement to cause the symbol
5022 \begin_inset Flex Noun
5025 \begin_layout Plain Layout
5033 to be output for the keystroke
5034 \begin_inset Flex Noun
5037 \begin_layout Plain Layout
5048 \begin_layout LyX-Code
5054 \begin_layout Labeling
5055 \labelwidthstring 00.00.0000
5056 \begin_inset Flex Code
5059 \begin_layout Plain Layout
5067 Specify an accent character
5070 \begin_layout LyX-Code
5079 \begin_layout Standard
5080 This will make the cha
5118 This is the dead key
5122 \begin_layout Plain Layout
5129 refers to a key that does not produce a character by itself,
5130 but when followed with another key,
5131 produces the desired accent character.
5135 r with an umlaut like
5145 can be produced in this manner.
5154 \begin_layout Standard
5167 and then another key not in
5185 followed by the other,
5191 \begin_inset Flex Noun
5194 \begin_layout Plain Layout
5214 \begin_inset Flex Noun
5217 \begin_layout Plain Layout
5227 the cursor will not go one position backwards but will instead cancel the effect t
5242 might have had on the next keystroke.
5246 \begin_layout Standard
5247 The following example specifies that the character ' is to be an acute accent,
5248 allowed on the characters a,
5260 \begin_layout LyX-Code
5263 kmod ' acute aeiouAEIOU
5266 \begin_layout Labeling
5267 \labelwidthstring 00.00.0000
5268 \begin_inset Flex Code
5271 \begin_layout Plain Layout
5277 Specify an exception to the accent character
5280 \begin_layout LyX-Code
5289 \begin_layout Standard
5290 This defines an exce
5331 have been assigned a keystroke with a previous
5334 \begin_inset Flex Code
5337 \begin_layout Plain Layout
5361 must not belong in the
5409 If such a declaration does not exist in
5417 \begin_inset Flex Code
5420 \begin_layout Plain Layout
5455 \begin_inset Flex Code
5458 \begin_layout Plain Layout
5472 \begin_layout Standard
5473 The following command produces causes äi to be produced when you enter acute-i ('i):
5476 \begin_layout LyX-Code
5490 \begin_layout Labeling
5491 \labelwidthstring 00.00.0000
5492 \begin_inset Flex Code
5495 \begin_layout Plain Layout
5501 Combine two accent characters
5504 \begin_layout LyX-Code
5510 accent1 accent2 allowed
5513 \begin_layout Standard
5514 This one is getting pretty esoteric.
5515 It allows you to combine the effect
5571 \begin_inset Flex Code
5574 \begin_layout Plain Layout
5602 \begin_layout Standard
5603 Consider this example from the
5604 \begin_inset Flex Code
5607 \begin_layout Plain Layout
5618 \begin_layout LyX-Code
5622 acute aeioyvhAEIOYVH
5627 kcomb acute umlaut iyIY
5630 \begin_layout Standard
5631 This allows you to press
5632 \begin_inset Flex Noun
5635 \begin_layout Plain Layout
5643 and get the effect of
5644 \begin_inset Flex Code
5647 \begin_layout Plain Layout
5666 in this case cancels the last dead key,
5668 \begin_inset Flex Noun
5671 \begin_layout Plain Layout
5681 \begin_inset Flex Code
5684 \begin_layout Plain Layout
5697 \begin_layout Subsection
5701 \begin_layout Standard
5703 \begin_inset Flex Code
5706 \begin_layout Plain Layout
5714 mapping is performed,
5716 \begin_inset Flex Code
5719 \begin_layout Plain Layout
5729 file maps the strings that the symbols generate to characters in the current font.
5730 The \SpecialChar LyX
5731 distribution currently includes at least the
5732 \begin_inset Flex Code
5735 \begin_layout Plain Layout
5744 \begin_inset Flex Code
5747 \begin_layout Plain Layout
5758 \begin_layout Standard
5760 \begin_inset Flex Code
5763 \begin_layout Plain Layout
5771 file is a sequence of declarations of the form
5774 \begin_layout LyX-Code
5787 \begin_layout Standard
5790 \begin_inset Flex Noun
5793 \begin_layout Plain Layout
5803 to the corresponding character in the iso-8859-1 set (233),
5804 the following declaration is used
5807 \begin_layout LyX-Code
5815 \begin_layout Standard
5817 \begin_inset Flex Code
5820 \begin_layout Plain Layout
5829 \begin_inset Flex Code
5832 \begin_layout Plain Layout
5850 the same character can apply to more than one string.
5852 \begin_inset Flex Code
5855 \begin_layout Plain Layout
5866 \begin_layout LyX-Code
5878 \begin_inset Newline newline
5894 \begin_layout Standard
5896 cannot find a mapping for the string produced by the keystroke or a deadkey sequence,
5897 it will check if it looks like an accented char and try to draw an accent over the character on screen.
5900 \begin_layout Subsection
5904 \begin_layout Standard
5905 There is a second way to add support for international characters through so-called dead-keys.
5906 A dead-key works in combination with a letter to produce an accented character.
5908 we'll explain how to create a really simple dead-key to illustrate how they work.
5911 \begin_layout Standard
5912 Suppose you happen to need the circumflex character,
5914 \begin_inset Quotes eld
5918 \begin_inset Quotes erd
5923 \begin_inset Flex Noun
5926 \begin_layout Plain Layout
5933 \begin_inset space ~
5937 \begin_inset Flex Noun
5940 \begin_layout Plain Layout
5946 ] to the \SpecialChar LyX
5948 \begin_inset Flex Code
5951 \begin_layout Plain Layout
5958 \begin_inset Flex Code
5961 \begin_layout Plain Layout
5969 whenever you type the
5970 \begin_inset Flex Noun
5973 \begin_layout Plain Layout
5979 -key followed by a letter,
5980 that letter will have a circumflex accent on it.
5983 \begin_inset Quotes eld
5987 \begin_inset Flex Noun
5990 \begin_layout Plain Layout
5997 \begin_inset Quotes erd
6000 produces the letter:
6002 \begin_inset Quotes eld
6006 \begin_inset Quotes erd
6010 If you tried to type
6011 \begin_inset Quotes eld
6015 \begin_inset Flex Noun
6018 \begin_layout Plain Layout
6025 \begin_inset Quotes erd
6031 will complain with a beep,
6033 \begin_inset Quotes eld
6037 \begin_inset Flex Noun
6040 \begin_layout Plain Layout
6047 \begin_inset Quotes erd
6050 never takes a circumflex accent.
6052 \begin_inset Flex Noun
6055 \begin_layout Plain Layout
6061 after a dead-key produces the bare-accent.
6062 Please note this last point!
6063 If you bind a key to a dead-key,
6064 you'll need to rebind the character on that key to yet another key.
6066 \begin_inset Flex Noun
6069 \begin_layout Plain Layout
6075 to a cedilla is a bad idea,
6076 since you'll only get cedillas instead of commas.
6079 \begin_layout Standard
6080 One common way to bind dead-keys is to use
6081 \begin_inset Flex Noun
6084 \begin_layout Plain Layout
6092 \begin_inset Flex Noun
6095 \begin_layout Plain Layout
6103 \begin_inset Flex Noun
6106 \begin_layout Plain Layout
6112 in combination with an accent,
6114 \begin_inset Quotes eld
6118 \begin_inset Flex Noun
6121 \begin_layout Plain Layout
6128 \begin_inset Quotes erd
6132 \begin_inset Quotes eld
6136 \begin_inset Flex Noun
6139 \begin_layout Plain Layout
6146 \begin_inset Quotes erd
6150 \begin_inset Quotes eld
6154 \begin_inset Flex Noun
6157 \begin_layout Plain Layout
6164 \begin_inset Quotes erd
6168 Another way involves using
6169 \begin_inset Flex Code
6172 \begin_layout Plain Layout
6179 \begin_inset Flex Code
6182 \begin_layout Plain Layout
6188 to set up the special
6189 \begin_inset Flex Code
6192 \begin_layout Plain Layout
6200 \begin_inset Flex Code
6203 \begin_layout Plain Layout
6209 acts in some ways just like
6210 \begin_inset Flex Noun
6213 \begin_layout Plain Layout
6219 and permits you to bind keys to accented characters.
6220 You can also turn keys into dead-keys by binding them to something like
6221 \begin_inset Flex Code
6224 \begin_layout Plain Layout
6230 and then binding this symbolic key to the corresponding \SpecialChar LyX
6235 \begin_layout Plain Layout
6241 This is exactly what I do in my
6242 \begin_inset Flex Code
6245 \begin_layout Plain Layout
6252 \begin_inset Flex Code
6255 \begin_layout Plain Layout
6263 \begin_inset Flex Noun
6266 \begin_layout Plain Layout
6268 \begin_inset space ~
6277 \begin_inset Flex Code
6280 \begin_layout Plain Layout
6286 and a bunch of these
6287 \begin_inset Quotes eld
6291 \begin_inset Flex Code
6294 \begin_layout Plain Layout
6301 \begin_inset Quotes erd
6304 symbolic keys bound such things as
6305 \begin_inset Flex Noun
6308 \begin_layout Plain Layout
6310 \begin_inset space ~
6319 \begin_inset Flex Noun
6322 \begin_layout Plain Layout
6324 \begin_inset space ~
6333 This is how I produce my accented characters.
6338 You can make just about anything into the
6339 \begin_inset Flex Code
6342 \begin_layout Plain Layout
6350 \begin_inset Flex Noun
6353 \begin_layout Plain Layout
6360 a spare function key,
6362 As for the \SpecialChar LyX
6363 commands that produce accents,
6365 \begin_inset Flex Code
6368 \begin_layout Plain Layout
6379 You'll find the complete list there.
6382 \begin_layout Subsection
6383 Saving your Language Configuration
6386 \begin_layout Standard
6387 You can edit your preferences so that your desired language environment is automatically configured when \SpecialChar LyX
6390 \begin_inset Flex Noun
6393 \begin_layout Plain Layout
6394 Edit\SpecialChar menuseparator
6403 \begin_layout Chapter
6405 \change_inserted -584632292 1610232084
6408 Installing New Document Classes,
6411 \begin_inset CommandInset label
6413 name "cha:Installing-New-Document"
6418 \begin_inset Argument 1
6421 \begin_layout Plain Layout
6422 Installing New Document Classes
6430 \begin_layout Standard
6432 we describe the procedures for creating and installing new \SpecialChar LyX
6433 layout and template files,
6434 as well as offer a refresher on correctly installing new \SpecialChar LaTeX
6439 \begin_layout Standard
6441 let us a say a few words about how one ought to think about the relation between \SpecialChar LyX
6442 and \SpecialChar LaTeX
6444 The thing to understand is that,
6447 doesn't know anything about \SpecialChar LaTeX
6450 from \SpecialChar LyX
6453 is just one of several
6454 \begin_inset Quotes eld
6458 \begin_inset Quotes erd
6461 in which it is capable of producing output.
6462 Other such formats are DocBook,
6468 a particularly important format,
6469 but very little of the information \SpecialChar LyX
6470 has about \SpecialChar LaTeX
6471 is actually contained in the program itself.
6475 \begin_layout Plain Layout
6476 Some commands are sufficiently complex that they are
6477 \begin_inset Quotes eld
6481 \begin_inset Quotes erd
6484 into \SpecialChar LyX
6486 But the developers generally regard this as a Bad Thing.
6493 even for the standard classes like
6494 \begin_inset Flex Code
6497 \begin_layout Plain Layout
6504 is contained in `layout files'.
6507 itself does not know much about DocBook or XHTML.
6508 What it knows is contained in layout files.
6511 \begin_layout Standard
6512 You can think of the layout file for a given document class as a translation manual between \SpecialChar LyX
6514 paragraphs with their corresponding styles,
6515 certain sorts of insets,
6517 and the corresponding \SpecialChar LaTeX
6520 or XHTML constructs.
6521 Almost everything \SpecialChar LyX
6523 \begin_inset Flex Code
6526 \begin_layout Plain Layout
6534 is contained in the file
6535 \begin_inset Flex Code
6538 \begin_layout Plain Layout
6544 and in various other files it includes.
6546 anyone intending to write layout files should plan to study the existing files.
6547 A good place to start is with
6548 \begin_inset Flex Code
6551 \begin_layout Plain Layout
6558 which is included in
6559 \begin_inset Flex Code
6562 \begin_layout Plain Layout
6570 \begin_inset Flex Code
6573 \begin_layout Plain Layout
6580 and many of the other layout files for document classes.
6581 This file is where sections and the like are defined:
6583 \begin_inset Flex Code
6586 \begin_layout Plain Layout
6592 tells \SpecialChar LyX
6593 how paragraphs that are marked with the Section,
6596 styles can be translated into corresponding \SpecialChar LaTeX
6599 and XHTML commands and tags.
6601 \begin_inset Flex Code
6604 \begin_layout Plain Layout
6610 file basically just includes several of these
6611 \begin_inset Flex Code
6614 \begin_layout Plain Layout
6623 \begin_layout Standard
6624 Defining the \SpecialChar LyX
6626 correspondence is not the only thing layout files do,
6628 Their other job is to define how the \SpecialChar LyX
6629 constructs themselves will appear on-screen.
6630 The fact that layout files have these two jobs is often a source of confusion,
6631 because they are completely separate.
6632 Telling \SpecialChar LyX
6633 how to translate a certain paragraph style into \SpecialChar LaTeX
6634 does not tell \SpecialChar LyX
6637 telling \SpecialChar LyX
6638 how to display a certain paragraph style does not tell \SpecialChar LyX
6639 how to translate it into \SpecialChar LaTeX
6640 (let alone tell \SpecialChar LaTeX
6644 when you define a new \SpecialChar LyX
6646 you must always do two quite separate things:
6648 \begin_inset space ~
6651 tell \SpecialChar LyX
6652 how to translate it into \SpecialChar LaTeX
6654 \begin_inset space ~
6657 tell \SpecialChar LyX
6661 \begin_layout Standard
6662 Much the same is true,
6664 as regards \SpecialChar LyX
6665 's other backend formats,
6666 though XHTML is in some ways different,
6667 because in that case \SpecialChar LyX
6674 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.
6677 the distinction between what \SpecialChar LyX
6678 does internally and how things are rendered externally remains in force,
6679 and the two can be controlled separately.
6681 \begin_inset CommandInset ref
6683 reference "sec:Tags-for-XHTML"
6691 \begin_layout Section
6692 Installing new \SpecialChar LaTeX
6696 \begin_layout Standard
6697 Some installations may not include a \SpecialChar LaTeX
6698 package or class file that you would like to use within \SpecialChar LyX
6701 you might need Foil\SpecialChar TeX
6703 a package for preparing slides for overhead projectors.
6704 Modern \SpecialChar LaTeX
6705 distributions like \SpecialChar TeX
6706 Live (2008 or newer) or MiK\SpecialChar TeX
6707 provide a user interface for installing such packages.
6709 with MiK\SpecialChar TeX
6711 you start the program
6712 \begin_inset Quotes eld
6716 \begin_inset space ~
6720 \begin_inset Quotes erd
6723 to get a list of available packages.
6724 To install one of them,
6725 right click on it or use the corresponding toolbar button.
6728 \begin_layout Standard
6729 If your \SpecialChar LaTeX
6730 distribution does not provide such a `package manager',
6731 or if the package is not available from your distribution,
6732 then follow these steps to install it manually:
6735 \begin_layout Enumerate
6736 Get the package from
6737 \begin_inset CommandInset href
6740 target "http://www.ctan.org/"
6748 \begin_layout Enumerate
6749 If the package contains a file with the ending
6750 \begin_inset Quotes eld
6754 \begin_inset Flex Code
6757 \begin_layout Plain Layout
6764 \begin_inset Quotes erd
6767 (is the case for Foil\SpecialChar TeX
6768 ) then open a console,
6769 change to the folder of this file and execute the command
6770 \begin_inset Flex Code
6773 \begin_layout Plain Layout
6780 You have now unpacked the package and have all files to install it.
6781 Most \SpecialChar LaTeX
6782 -packages are not packed and you can skip this step.
6785 \begin_layout Enumerate
6786 Now you need to decide if the package should be available for all users or only for you.
6790 \begin_layout Enumerate
6791 On *nix systems (Linux,
6794 if you want the new package to be available for all users on your system,
6795 then install it in your `local' \SpecialChar TeX
6797 otherwise install it in your own `user' \SpecialChar TeX
6799 Where these trees should be created,
6800 if they do not already exist,
6801 depends on your system.
6804 \begin_inset Flex Code
6807 \begin_layout Plain Layout
6817 \begin_layout Plain Layout
6818 This is usually in the directory
6819 \begin_inset Flex Code
6822 \begin_layout Plain Layout
6829 though you can execute the command
6830 \begin_inset Flex Code
6833 \begin_layout Plain Layout
6844 The location of the `local' \SpecialChar TeX
6845 tree is defined by the
6846 \begin_inset Flex Code
6849 \begin_layout Plain Layout
6856 this is usually somewhere like
6857 \begin_inset Flex Code
6860 \begin_layout Plain Layout
6861 /usr/local/share/texmf
6866 or /usr/local/texlive/XXXX where XXXX is the year of the installed \SpecialChar TeX
6868 The location of the `user' \SpecialChar TeX
6870 \begin_inset Flex Code
6873 \begin_layout Plain Layout
6880 \begin_inset Flex Code
6883 \begin_layout Plain Layout
6890 \begin_inset Flex Code
6893 \begin_layout Plain Layout
6902 (If these variables are not predefined,
6903 you have to define them.) You'll probably need root permissions to create or modify the `local' tree,
6904 but not for your `user' tree.
6905 \begin_inset Newline newline
6909 it is recommended to install in the user tree because your user will not be modified or even overwritten when you upgrade your system.
6910 It will typically also be backed up together with everything else when you backup your home directory (which,
6912 you do on a regular basis).
6915 \begin_layout Enumerate
6917 if you want the new package to be available for all users on your system,
6918 change to the folder where \SpecialChar LaTeX
6919 is installed and then change to the subfolder
6920 \begin_inset Flex Code
6923 \begin_layout Plain Layout
6934 (For MiK\SpecialChar TeX
6936 this would be by default the folder
6937 \begin_inset Flex Code
6940 \begin_layout Plain Layout
6958 \begin_layout Plain Layout
6959 Note that this will be the correct path only on English installations.
6962 \begin_inset Flex Code
6965 \begin_layout Plain Layout
6980 and similarly for other languages.
6985 Create there a new folder
6986 \begin_inset Flex Code
6989 \begin_layout Plain Layout
6995 and copy all files of the package into it.
6997 \begin_inset Newline newline
7000 If the package should only available for you or you don't have admin permissions,
7002 but in the local \SpecialChar LaTeX
7005 \begin_inset space \thinspace{}
7009 for MiK\SpecialChar TeX
7011 \begin_inset space ~
7014 2.8 under Windows XP,
7015 this would be the folder:
7016 \begin_inset Newline newline
7022 \begin_inset Flex Code
7025 \begin_layout Plain Layout
7028 Documents and Settings
7040 \begin_inset Newline newline
7046 \begin_inset Phantom HPhantom
7049 \begin_layout Plain Layout
7060 \begin_inset Flex Code
7063 \begin_layout Plain Layout
7076 \begin_inset Newline newline
7081 \begin_inset Newline newline
7085 \begin_inset Flex Code
7088 \begin_layout Plain Layout
7114 \begin_layout Enumerate
7115 Now one only need to tell \SpecialChar LaTeX
7116 that there are new files.
7117 This depends on the used \SpecialChar LaTeX
7122 \begin_layout Enumerate
7123 For \SpecialChar TeX
7124 Live execute the command
7125 \begin_inset Flex Code
7128 \begin_layout Plain Layout
7135 If you installed the package for all users,
7136 then you will probably need to have root permissions for that.
7139 \begin_layout Enumerate
7140 For MiK\SpecialChar TeX
7142 if you have installed the package for all users,
7144 \begin_inset Quotes eld
7148 \begin_inset space ~
7152 \begin_inset Quotes erd
7155 and press the button marked
7156 \begin_inset Quotes eld
7160 \begin_inset Quotes erd
7164 Otherwise start the program
7165 \begin_inset Quotes eld
7169 \begin_inset Quotes erd
7176 \begin_layout Enumerate
7178 you need to tell \SpecialChar LyX
7179 that there are new packages available.
7184 \begin_inset Flex Noun
7187 \begin_layout Plain Layout
7190 \SpecialChar menuseparator
7196 and then restart \SpecialChar LyX
7200 \begin_layout Standard
7201 Now the package is installed.
7204 \begin_inset Flex Code
7207 \begin_layout Plain Layout
7213 will now be available under
7214 \begin_inset Flex Noun
7217 \begin_layout Plain Layout
7218 Document\SpecialChar menuseparator
7219 Settings\SpecialChar menuseparator
7226 \begin_inset Quotes eld
7230 \begin_inset Quotes erd
7237 \begin_layout Standard
7238 If you would like to use a \SpecialChar LaTeX
7239 document class that is not even listed in the menu
7240 \begin_inset Flex Noun
7243 \begin_layout Plain Layout
7244 Document\SpecialChar menuseparator
7245 Settings\SpecialChar menuseparator
7252 then you need to create a `layout' file for it.
7253 That is the topic of the next section.
7256 \begin_layout Section
7257 Types of layout files
7260 \begin_layout Standard
7261 This section describes the various sorts of \SpecialChar LyX
7262 files that contain layout information.
7263 These files describe various paragraph and character styles,
7264 determining how \SpecialChar LyX
7265 should display them and how they should be translated into \SpecialChar LaTeX
7269 or whatever output format is being used.
7273 \begin_layout Standard
7274 We shall try to provide a thorough description of the process of writing layout files here.
7276 there are so many different types of documents supported even by just \SpecialChar LaTeX
7277 that we can't hope to cover every different possibility or problem you might encounter.
7278 The \SpecialChar LyX
7279 users' list is frequented by people with lots of experience with layout design who are willing to share what they've learned,
7280 so please feel free to ask questions there.
7283 \begin_layout Standard
7284 As you prepare to write a new layout,
7285 it is extremely helpful to look at the layouts distributed with \SpecialChar LyX
7287 If you write a \SpecialChar LyX
7288 layout for a \SpecialChar LaTeX
7289 document class that might also be used by others,
7290 or write a module that might be useful to others,
7291 then you should consider posting your layout to the
7292 \begin_inset CommandInset href
7294 name "layout section on the LyX wiki"
7295 target "https://wiki.lyx.org/Layouts/Layouts"
7300 or even to the \SpecialChar LyX
7302 so that it might be included in \SpecialChar LyX
7307 \begin_layout Plain Layout
7308 Note that \SpecialChar LyX
7309 is licensed under the General Public License,
7310 so any material that is contributed to \SpecialChar LyX
7311 must be similarly licensed.
7319 \begin_layout Subsection
7321 \begin_inset CommandInset label
7323 name "subsec:Layout-modules"
7330 \begin_layout Standard
7331 We have spoken to this point about `layout files'.
7332 But there are different sorts of files that contain layout information.
7336 \begin_inset Flex Code
7339 \begin_layout Plain Layout
7345 extension and provide \SpecialChar LyX
7346 with information about document classes.
7347 Since \SpecialChar LyX
7348 1.6 layout information can also be contained in layout
7354 \begin_inset Flex Code
7357 \begin_layout Plain Layout
7364 Modules are to \SpecialChar LaTeX
7365 packages much as layouts are to \SpecialChar LaTeX
7369 \begin_inset Flex Code
7372 \begin_layout Plain Layout
7379 specifically provide support for one package.
7381 layout modules are similar to included
7385 \begin_layout Plain Layout
7386 These can have any extension,
7387 but by convention have the
7388 \begin_inset Flex Code
7391 \begin_layout Plain Layout
7404 \begin_inset Flex Code
7407 \begin_layout Plain Layout
7414 in that modules are not specific to a given document class but may be used with many different classes.
7415 The difference is that using an included file with
7416 \begin_inset Flex Code
7419 \begin_layout Plain Layout
7425 requires editing that file.
7429 \begin_inset Flex Noun
7432 \begin_layout Plain Layout
7433 Document\SpecialChar menuseparator
7442 \begin_layout Standard
7443 Building modules is the easiest way to get started with layout editing,
7444 since it can be as simple as adding a single new paragraph style or flex inset.
7447 contain anything a layout file can contain.
7450 \begin_layout Standard
7451 After creating a new module and copying it to the
7452 \begin_inset Flex Code
7455 \begin_layout Plain Layout
7462 you will need to reconfigure and then restart \SpecialChar LyX
7463 for the module to appear in the menu.
7465 changes you make to the module will be seen immediately,
7467 \begin_inset Flex Noun
7470 \begin_layout Plain Layout
7471 Document\SpecialChar menuseparator
7478 highlight something,
7480 \begin_inset Quotes eld
7484 \begin_inset Quotes erd
7490 It is strongly recommended that you save your work before doing this
7496 it is strongly recommended that you not attempt to edit modules while simultaneously working on actual documents
7499 Though of course the developers strive to keep \SpecialChar LyX
7500 stable in such situations,
7501 syntax errors and the like in your module file could cause strange behavior.
7504 \begin_layout Subsubsection
7508 \begin_layout Standard
7509 Modules are to \SpecialChar LyX
7510 as packages are to \SpecialChar LaTeX
7514 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.
7515 What you need is \SpecialChar LyX
7517 \begin_inset Quotes eld
7521 \begin_inset Quotes erd
7527 \begin_layout Standard
7528 You will find it under
7530 Document\SpecialChar menuseparator
7531 Settings\SpecialChar menuseparator
7535 The large text box allows you to enter anything that you might enter in a layout file or module.
7536 You can think of a document's local layout,
7538 as a module that belongs just to it.
7542 \begin_inset Flex Code
7545 \begin_layout Plain Layout
7552 Any format is acceptable,
7553 but one would normally use the format current at the time.
7554 (In \SpecialChar LyX
7562 the current layout format is
7571 \begin_layout Standard
7572 When you have entered something in the
7573 \begin_inset Flex Code
7576 \begin_layout Plain Layout
7585 \begin_inset Quotes eld
7589 \begin_inset Quotes erd
7592 button at the bottom.
7593 Clicking this button will cause \SpecialChar LyX
7594 to determine whether what you have entered is valid layout information for the chosen format.
7596 will report the result but,
7598 will not tell you what errors there might have been.
7599 These will be written to the terminal,
7602 is started from a terminal.
7603 You will not be permitted to save your local layout until you have entered something valid.
7606 \begin_layout Standard
7607 The warnings at the end of the previous section apply here,
7609 Do not play with local layout while you are actually working,
7610 especially if you have not saved your document.
7612 using local layout with a test document can be a very convenient way to try out layout ideas,
7613 or even to start developing a module.
7616 \begin_layout Subsection
7618 \begin_inset Flex Noun
7621 \begin_layout Plain Layout
7630 \begin_layout Standard
7631 There are two situations you are likely to encounter when wanting to support a new \SpecialChar LaTeX
7634 \begin_inset Flex Code
7637 \begin_layout Plain Layout
7643 ) files and \SpecialChar LaTeX2e
7645 \begin_inset Flex Code
7648 \begin_layout Plain Layout
7655 Supporting a style file is usually fairly easy.
7656 Supporting a new class file is a bit harder.
7657 We'll discuss the former in this section and the latter in the next.
7659 \change_deleted 5863208 1594239023
7660 Similar remarks apply,
7662 if you want to support a new DocBook DTD.
7667 \begin_layout Standard
7668 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.
7669 For the sake of the example,
7670 we'll assume that the style file is called
7671 \begin_inset Flex Noun
7674 \begin_layout Plain Layout
7680 and that it is meant to be used with
7681 \begin_inset Flex Noun
7684 \begin_layout Plain Layout
7691 which is a standard class.
7695 \begin_layout Standard
7696 Start by copying the existing class's layout file into your local directory:
7700 \begin_layout Plain Layout
7702 which directory is your local directory will vary by platform,
7703 and \SpecialChar LyX
7704 allows you to specify your local directory on startup,
7707 \begin_inset Flex Code
7710 \begin_layout Plain Layout
7724 \begin_layout LyX-Code
7725 cp report.layout ~/.lyx/layouts/myclass.layout
7728 \begin_layout Standard
7730 \begin_inset Flex Code
7733 \begin_layout Plain Layout
7739 and change the line:
7743 \begin_layout LyX-Code
7746 DeclareLaTeXClass{Report (Standard Class)}
7749 \begin_layout Standard
7753 \begin_layout LyX-Code
7756 DeclareLaTeXClass[report,
7757 myclass.sty]{Report (My Class)}
7760 \begin_layout Standard
7764 \begin_layout LyX-Code
7766 \begin_inset Newline newline
7772 \begin_inset Newline newline
7778 \begin_layout Standard
7779 near the top of the file.
7782 \begin_layout Standard
7783 Start \SpecialChar LyX
7785 \begin_inset Flex Noun
7788 \begin_layout Plain Layout
7789 Tools\SpecialChar menuseparator
7796 Then restart \SpecialChar LyX
7797 and try creating a new document.
7799 \begin_inset Flex Noun
7802 \begin_layout Plain Layout
7808 " as a document class option in the
7809 \begin_inset Flex Noun
7812 \begin_layout Plain Layout
7813 Document\SpecialChar menuseparator
7820 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—
7822 \begin_inset Flex Code
7825 \begin_layout Plain Layout
7832 so you can fiddle around with the settings for the different sections if you wish.
7833 The layout information for sections is contained in
7834 \begin_inset Flex Code
7837 \begin_layout Plain Layout
7844 but you do not need to copy and change this file.
7846 you can simply add your changes to your layout file,
7848 \begin_inset Flex Code
7851 \begin_layout Plain Layout
7858 which itself includes
7859 \begin_inset Flex Code
7862 \begin_layout Plain Layout
7870 you might add these lines:
7873 \begin_layout LyX-Code
7877 \begin_layout LyX-Code
7881 \begin_layout LyX-Code
7885 \begin_layout LyX-Code
7889 \begin_layout LyX-Code
7893 \begin_layout Standard
7894 to change the font for chapter headings to sans-serif.
7895 This will override (or,
7897 add to) the existing declaration for the Chapter style.
7901 \begin_layout Standard
7902 Your new package may also provide commands or environments not present in the base class.
7904 you will want to add these to the layout file.
7906 \begin_inset CommandInset ref
7908 reference "sec:TextClass"
7913 for information on how to do so.
7916 \begin_layout Standard
7918 \begin_inset Flex Noun
7921 \begin_layout Plain Layout
7927 can be used with several different document classes,
7928 and even if it cannot,
7929 you might find it easiest just to write a module that you can load with the base class.
7930 The simplest possible such module would be:
7933 \begin_layout LyX-Code
7936 DeclareLyXModule{My Class}
7939 \begin_layout LyX-Code
7943 \begin_layout LyX-Code
7944 #Support for myclass.sty.
7947 \begin_layout LyX-Code
7949 \begin_inset Newline newline
7955 \begin_layout LyX-Code
7963 \begin_inset Newline newline
7969 \begin_layout LyX-Code
7971 \begin_inset Newline newline
7977 \begin_inset Newline newline
7983 \begin_layout Standard
7984 A more complex module might modify the behavior of some existing constructs or define some new ones.
7987 \begin_inset CommandInset ref
7989 reference "sec:TextClass"
7997 \begin_layout Subsection
7999 \begin_inset Flex Noun
8002 \begin_layout Plain Layout
8011 \begin_layout Standard
8012 There are two possibilities here.
8013 One is that the class file is itself based upon an existing document class.
8015 many thesis classes are based upon
8016 \begin_inset Flex Noun
8019 \begin_layout Plain Layout
8026 To see whether yours is,
8027 look for a line like
8030 \begin_layout LyX-Code
8036 \begin_layout Standard
8039 then you may proceed largely as in the previous section,
8041 \begin_inset Flex Code
8044 \begin_layout Plain Layout
8045 Declare\SpecialChar LaTeX
8051 line will be different.
8052 If your new class is
8053 \begin_inset Flex Code
8056 \begin_layout Plain Layout
8062 and it is based upon
8063 \begin_inset Flex Code
8066 \begin_layout Plain Layout
8073 then the line should read:
8077 \begin_layout Plain Layout
8078 And it will be easiest if you save the file to
8079 \begin_inset Flex Code
8082 \begin_layout Plain Layout
8090 assumes that the document class has the same name as the layout file.
8099 \begin_layout LyX-Code
8102 DeclareLaTeXClass[thesis,book]{thesis}
8105 \begin_layout Standard
8108 the new class is not based upon an existing class,
8109 you will probably have to
8110 \begin_inset Quotes eld
8114 \begin_inset Quotes erd
8118 We strongly suggest copying an existing layout file which uses a similar \SpecialChar LaTeX
8119 class and then modifying it,
8121 At least use an existing file as a starting point so you can find out what items you need to worry about.
8123 the specifics are covered below.
8126 \begin_layout Subsection
8128 \begin_inset CommandInset label
8130 name "subsec:Creating-Templates"
8137 \begin_layout Standard
8138 Once you have written a layout file for a new document class,
8139 you might want to consider writing a
8145 A template acts as a kind of tutorial for your layout,
8146 showing how it might be used,
8147 though containing dummy content.
8148 You can of course look at the various templates included with \SpecialChar LyX
8152 \begin_layout Standard
8153 Templates are created just like usual documents:
8154 using \SpecialChar LyX
8156 The only difference is that usual documents contain all possible settings,
8157 including the font scheme and the paper size.
8158 Usually a user doesn't want a template to overwrite his preferred settings for such parameters.
8160 the designer of a template should remove the corresponding commands like
8161 \begin_inset Flex Code
8164 \begin_layout Plain Layout
8173 \begin_inset Flex Code
8176 \begin_layout Plain Layout
8184 from the template \SpecialChar LyX
8186 This can be done with any simple text-editor,
8188 \begin_inset Flex Code
8191 \begin_layout Plain Layout
8198 \begin_inset Flex Code
8201 \begin_layout Plain Layout
8210 \begin_layout Standard
8211 Put the edited template files you create in
8212 \begin_inset Flex Code
8215 \begin_layout Plain Layout
8222 copy the ones you use from the global template directory in
8223 \begin_inset Flex Code
8226 \begin_layout Plain Layout
8233 and redefine the template path in the
8234 \begin_inset Flex Noun
8237 \begin_layout Plain Layout
8238 Tools\SpecialChar menuseparator
8239 Preferences\SpecialChar menuseparator
8248 \begin_layout Standard
8251 that there is a template which has a particular meaning:
8252 \begin_inset Newline linebreak
8256 \begin_inset Flex Code
8259 \begin_layout Plain Layout
8266 This template is loaded every time you create a new document with
8267 \begin_inset Flex Noun
8270 \begin_layout Plain Layout
8271 File\SpecialChar menuseparator
8277 in order to provide useful defaults.
8278 To create this template from inside \SpecialChar LyX
8280 all you have to do is to open a document with the correct settings,
8282 \begin_inset Flex Noun
8285 \begin_layout Plain Layout
8286 Save as Document Defaults
8294 \begin_layout Subsection
8295 Upgrading old layout files
8298 \begin_layout Standard
8299 The format of layout files changes with each \SpecialChar LyX
8301 so old layout files need to be converted to the new format.
8303 reads a layout file in an older format,
8304 it automatically calls the script
8305 \begin_inset Flex Code
8308 \begin_layout Plain Layout
8314 to convert it to a temporary file in current format.
8315 The original file is left untouched.
8316 If you use the layout file often,
8318 you may want to convert it permanently,
8319 so that \SpecialChar LyX
8320 does not have to do so itself every time.
8322 you can call the converter manually:
8325 \begin_layout Enumerate
8327 \begin_inset Flex Code
8330 \begin_layout Plain Layout
8337 \begin_inset Flex Code
8340 \begin_layout Plain Layout
8349 \begin_layout Enumerate
8351 \begin_inset Newline newline
8355 \begin_inset Flex Code
8358 \begin_layout Plain Layout
8359 python LyXDir/scripts/layout2layout.py myclass.old myclass.layout
8365 \begin_inset Newline newline
8369 \begin_inset Flex Code
8372 \begin_layout Plain Layout
8378 is the name of your \SpecialChar LyX
8382 \begin_layout Standard
8383 Note that manual conversion does not affect included files,
8384 so these will have to be converted separately.
8387 \begin_layout Subsection
8388 \begin_inset CommandInset label
8390 name "subsec:Cite-Engine-Files"
8397 \begin_layout Standard
8398 A specific form of layout files are the so-called
8399 \begin_inset Flex Code
8402 \begin_layout Plain Layout
8408 files that are located in the
8409 \begin_inset Flex Code
8412 \begin_layout Plain Layout
8419 Their purpose is to define the specifics of \SpecialChar LaTeX
8420 packages aimed at bibliography generation,
8435 but also the way how normal Bib\SpecialChar TeX
8436 citations (without additional packages) are handled in \SpecialChar LyX
8437 is defined in such a file.
8441 \begin_layout Standard
8443 it is defined which packages \SpecialChar LyX
8445 which citation commands are available,
8446 how these are to be displayed in \SpecialChar LyX
8449 the context menus) as well as in the XHTML and plain text output.
8451 the files specify available style variants (author-year,
8453 etc.) and their specifics.
8454 The cite engine files are also used to generate the options that are available in
8456 Document\SpecialChar menuseparator
8457 Settings\SpecialChar menuseparator
8458 Bibliography\SpecialChar menuseparator
8464 \begin_layout Standard
8465 Even though a cite engine file is essentially a normal layout file that could theoretically include any layout information,
8466 it usually primarily includes some specific parameters such as
8467 \begin_inset Flex Code
8470 \begin_layout Plain Layout
8478 \begin_inset Flex Code
8481 \begin_layout Plain Layout
8489 \begin_inset Flex Code
8492 \begin_layout Plain Layout
8499 \begin_inset Flex Code
8502 \begin_layout Plain Layout
8509 The syntax of the latter two is described in
8510 \begin_inset CommandInset ref
8512 reference "subsec:Citation-engine-description"
8521 \begin_inset CommandInset ref
8523 reference "subsec:Citation-format-description"
8529 as well as in the files themselves.
8532 \begin_layout Section
8533 \begin_inset CommandInset label
8535 name "sec:TextClass"
8539 The layout file format
8542 \begin_layout Standard
8543 The following sections describe how layout files are structured and written.
8544 Our advice is to go slowly,
8545 save and test often.
8546 It is really not that hard,
8547 except that the multitude of options can become overwhelming,
8548 especially if you try to check out too many at once.
8549 It becomes easier if you use existing layouts of \SpecialChar LyX
8550 as examples/reference or if you modify an existing layout to your needs.
8553 \begin_layout Standard
8554 Note that all the tags used in layout files are case-insensitive.
8556 \begin_inset Flex Code
8559 \begin_layout Plain Layout
8567 \begin_inset Flex Code
8570 \begin_layout Plain Layout
8577 \begin_inset Flex Code
8580 \begin_layout Plain Layout
8586 are really the same tag.
8587 The possible arguments are printed in brackets after the tag's name.
8588 The default argument is typeset
8589 \begin_inset Flex Code
8592 \begin_layout Plain Layout
8601 If the argument has a data type like
8602 \begin_inset Quotes eld
8606 \begin_inset Quotes erd
8610 \begin_inset Quotes eld
8614 \begin_inset Quotes erd
8618 the default is shown like this:
8620 \begin_inset Flex Code
8623 \begin_layout Plain Layout
8634 \begin_layout Subsection
8635 The document class declaration and classification
8638 \begin_layout Standard
8639 Lines in a layout file which begin with
8640 \begin_inset Flex Code
8643 \begin_layout Plain Layout
8650 There is one exception to this rule.
8652 \begin_inset Flex Code
8655 \begin_layout Plain Layout
8661 files should begin with lines like:
8664 \begin_layout LyX-Code
8667 #% Do not delete the line below;
8668 configure depends on this
8671 \begin_layout LyX-Code
8676 DeclareLaTeXClass{Article (Standard Class)}
8679 \begin_layout LyX-Code
8684 DeclareCategory{Articles}
8687 \begin_layout Standard
8688 The second and third lines are used when you (re)configure \SpecialChar LyX
8690 The layout file is read by the \SpecialChar LaTeX
8692 \begin_inset Flex Code
8695 \begin_layout Plain Layout
8702 in a special mode where
8703 \begin_inset Flex Code
8706 \begin_layout Plain Layout
8713 The first line is just a \SpecialChar LaTeX
8715 the second one contains the mandatory declaration of the text class and the third line contains the optional classification of the class.
8716 If these lines appear in a file named
8717 \begin_inset Flex Code
8720 \begin_layout Plain Layout
8727 then they define a text class of name
8728 \begin_inset Flex Code
8731 \begin_layout Plain Layout
8737 (the name of the layout file) which uses the \SpecialChar LaTeX
8739 \begin_inset Flex Code
8742 \begin_layout Plain Layout
8748 (the default is to use the same name as the layout).
8750 \begin_inset Quotes eld
8753 Article (Standard Class)
8754 \begin_inset Quotes erd
8757 that appears above is used as a description of the text class in the
8758 \begin_inset Flex Noun
8761 \begin_layout Plain Layout
8762 Document\SpecialChar menuseparator
8770 \begin_inset Quotes eld
8774 \begin_inset Quotes erd
8777 in the example) is also used in the
8778 \begin_inset Flex Noun
8781 \begin_layout Plain Layout
8782 Document\SpecialChar menuseparator
8789 the text classes are grouped by these categories (which are usually genres,
8790 so typical categories are
8791 \begin_inset Quotes eld
8795 \begin_inset Quotes erd
8800 \begin_inset Quotes eld
8804 \begin_inset Quotes erd
8809 \begin_inset Quotes eld
8813 \begin_inset Quotes erd
8818 \begin_inset Quotes eld
8822 \begin_inset Quotes erd
8827 \begin_inset Quotes eld
8831 \begin_inset Quotes erd
8836 \begin_inset Quotes eld
8840 \begin_inset Quotes erd
8844 If no category has been declared,
8845 the class will be put in the
8846 \begin_inset Quotes eld
8850 \begin_inset Quotes erd
8856 \begin_layout Standard
8857 Let's assume that you wrote your own text class that uses the
8858 \begin_inset Flex Code
8861 \begin_layout Plain Layout
8868 but where you changed the appearance of the section headings.
8869 If you put it in a file
8870 \begin_inset Flex Code
8873 \begin_layout Plain Layout
8880 the header of this file should be:
8883 \begin_layout LyX-Code
8886 #% Do not delete the line below;
8887 configure depends on this
8890 \begin_layout LyX-Code
8895 DeclareLaTeXClass[article]{Article (with My Own Headings)}
8898 \begin_layout LyX-Code
8903 DeclareCategory{Articles}
8906 \begin_layout Standard
8907 This declares a text class
8908 \begin_inset Flex Code
8911 \begin_layout Plain Layout
8918 associated with the \SpecialChar LaTeX
8920 \begin_inset Flex Code
8923 \begin_layout Plain Layout
8930 \begin_inset Quotes eld
8933 Article (with My Own Headings)
8934 \begin_inset Quotes erd
8938 If your text class depends on several packages,
8939 you can declare it as:
8942 \begin_layout LyX-Code
8945 #% Do not delete the line below;
8946 configure depends on this
8949 \begin_layout LyX-Code
8954 DeclareLaTeXClass[article,foo.sty]{Article (with My Own Headings)}
8957 \begin_layout LyX-Code
8962 DeclareCategory{Articles}
8965 \begin_layout Standard
8966 This indicates that your text class uses the
8967 \begin_inset Flex Code
8970 \begin_layout Plain Layout
8978 \change_deleted 5863208 1594239179
8980 it is also possible to declare classes for DocBook code.
8981 Typical declarations will look like:
8984 \begin_layout LyX-Code
8986 \change_deleted 5863208 1594239179
8989 #% Do not delete the line below;
8990 configure depends on this
8993 \begin_layout LyX-Code
8995 \change_deleted 5863208 1594239179
9000 DeclareDocBookClass[article]{SGML (DocBook Article)}
9003 \begin_layout LyX-Code
9005 \change_deleted 5863208 1594239179
9010 DeclareCategory{Articles (DocBook)}
9015 \begin_layout Standard
9016 Note that these declarations can also be given an optional parameter declaring the name of the document class (but not a list).
9019 \begin_layout Standard
9021 to be as explicit as possible,
9022 the form of the layout declaration is:
9025 \begin_layout LyX-Code
9030 DeclareLaTeXClass[class,package.sty]{layout description}
9033 \begin_layout LyX-Code
9038 DeclareCategory{category}
9041 \begin_layout Standard
9042 The class need only be specified if the name of the \SpecialChar LaTeX
9043 class file and the name of the layout file are different or if there are packages to load.
9044 If the name of the class file is not specified,
9045 then \SpecialChar LyX
9046 will simply assume that it is the same as the name of the layout file.
9049 \begin_layout Standard
9050 When the text class has been modified to your taste,
9051 all you have to do is to copy it either to
9052 \begin_inset Flex Code
9055 \begin_layout Plain Layout
9062 \begin_inset Flex Code
9065 \begin_layout Plain Layout
9073 \begin_inset Flex Noun
9076 \begin_layout Plain Layout
9077 Tools\SpecialChar menuseparator
9084 exit \SpecialChar LyX
9086 Then your new text class should be available along with the others.
9089 \begin_layout Standard
9090 Once the layout file is installed,
9091 you can edit it and see your changes without having to reconfigure or to restart \SpecialChar LyX
9096 \begin_layout Plain Layout
9097 In versions of \SpecialChar LyX
9101 editing layout files was very time consuming,
9102 since you had constantly to restart \SpecialChar LyX
9108 You can force a reload of the current layout by using the \SpecialChar LyX
9110 \begin_inset Flex Noun
9113 \begin_layout Plain Layout
9120 There is no default binding for this function—
9123 you can bind it to a key yourself.
9124 But you will normally use this function simply by entering it in the mini-buffer.
9128 \begin_layout Standard
9135 \begin_inset Flex Noun
9138 \begin_layout Plain Layout
9144 is very much an `advanced feature'.
9149 recommended that you save your work before using this function.
9155 recommended that you not attempt to edit layout information while simultaneously working on a document that you care about.
9156 Use a test document.
9157 Syntax errors and the like in your layout file could cause peculiar behavior.
9159 such errors could cause \SpecialChar LyX
9160 to regard the current layout as invalid and to attempt to switch to some other layout.
9164 \begin_layout Plain Layout
9165 Really bad syntax errors may even caused \SpecialChar LyX
9167 This is because certain sorts of errors may make \SpecialChar LyX
9178 The \SpecialChar LyX
9179 team strives to keep \SpecialChar LyX
9180 stable in such situations,
9181 but safe is better than sorry.
9185 \begin_layout Plain Layout
9186 While we're giving advice:
9187 make regular backups.
9188 And be nice to your mother.
9196 \begin_layout Subsection
9197 The Module declaration
9200 \begin_layout Standard
9201 A module must begin with a line like the following:
9204 \begin_layout LyX-Code
9207 DeclareLyXModule[endnotes.sty]{Endnotes}
9208 \change_inserted -712698321 1554395911
9212 \begin_layout LyX-Code
9214 \change_inserted -712698321 1554395924
9219 DeclareCategory{Foot- and Endnotes}
9220 \change_deleted -712698321 1554395911
9228 \begin_layout Standard
9229 The mandatory argument
9230 \change_inserted -712698321 1554395956
9241 is the name of the module,
9242 as it should appear in
9243 \begin_inset Flex Noun
9246 \begin_layout Plain Layout
9247 Document\SpecialChar menuseparator
9248 Settings\SpecialChar menuseparator
9255 The argument in square brackets is optional:
9256 It declares any \SpecialChar LaTeX
9257 packages on which the module depends.
9258 It is also possible to use the form
9259 \begin_inset Flex Noun
9262 \begin_layout Plain Layout
9268 as an optional argument,
9269 which declares that the module can only be used when there exists a conversion chain between the formats `
9270 \begin_inset Flex Code
9273 \begin_layout Plain Layout
9280 \begin_inset Flex Code
9283 \begin_layout Plain Layout
9291 \change_inserted -712698321 1554396133
9298 declaration is not strictly mandatory,
9299 but you should add it,
9300 since it is helpful to find the module.
9301 Please have a look at the existing module categories and if appropriate,
9307 \begin_layout Standard
9309 \change_inserted -712698321 1554395988
9312 declaration should then be followed by lines like the following:
9316 \begin_layout Plain Layout
9317 Preferably in English if the module should be published with \SpecialChar LyX
9319 This description will appear in the list of messages to be translated and will be thus translated with the next interface update.
9327 \begin_layout LyX-Code
9331 \begin_layout LyX-Code
9332 #Adds an endnote command,
9333 in addition to footnotes.
9337 \begin_layout LyX-Code
9338 #You will need to add
9340 theendnotes in TeX code where you
9343 \begin_layout LyX-Code
9344 #want the endnotes to appear.
9348 \begin_layout LyX-Code
9352 \begin_layout LyX-Code
9354 somemodule | othermodule
9357 \begin_layout LyX-Code
9362 \begin_layout Standard
9363 The description is used in
9364 \begin_inset Flex Noun
9367 \begin_layout Plain Layout
9368 Document\SpecialChar menuseparator
9369 Settings\SpecialChar menuseparator
9375 to provide the user with information about what the module does.
9377 \begin_inset Flex Code
9380 \begin_layout Plain Layout
9386 line is used to identify other modules with which this one must be used;
9388 \begin_inset Flex Code
9391 \begin_layout Plain Layout
9397 line is used to identify modules with which this one may not be used.
9401 multiple modules should be separated with the pipe symbol:
9403 Note that the required modules are treated disjunctively:
9408 of the required modules must be used.
9414 excluded module may be used.
9415 Note that modules are identified here by their filenames without the
9416 \begin_inset Flex Code
9419 \begin_layout Plain Layout
9427 \begin_inset Flex Code
9430 \begin_layout Plain Layout
9437 \begin_inset Flex Code
9440 \begin_layout Plain Layout
9449 \begin_layout Subsection
9450 The CiteEngine file declaration
9453 \begin_layout Standard
9454 A cite engine file must begin with a line like the following:
9457 \begin_layout LyX-Code
9460 DeclareLyXCiteEngineModule[biblatex.sty]{Biblatex}
9463 \begin_layout Standard
9464 The mandatory argument,
9466 is the name of the cite style,
9467 as it should appear in
9468 \begin_inset Flex Noun
9471 \begin_layout Plain Layout
9472 Document\SpecialChar menuseparator
9473 Settings\SpecialChar menuseparator
9480 The argument in square brackets is optional:
9481 It declares any \SpecialChar LaTeX
9482 packages on which the cite engine depends.
9485 \begin_layout Standard
9486 The cite engine declaration should then be followed by lines like the following:
9490 \begin_layout Plain Layout
9491 Preferably in English if the module should be published with \SpecialChar LyX
9493 This description will appear in the list of messages to be translated and will be thus translated with the next interface update.
9501 \begin_layout LyX-Code
9505 \begin_layout LyX-Code
9506 # Biblatex supports many author-year and numerical styles.
9509 \begin_layout LyX-Code
9510 # It is mainly aimed at the Humanities.
9514 \begin_layout LyX-Code
9516 fully localized and provides many features
9519 \begin_layout LyX-Code
9520 # that are not possible with BibTeX.
9521 The use of 'biber' as
9524 \begin_layout LyX-Code
9525 # bibliography processor is advised.
9528 \begin_layout LyX-Code
9532 \begin_layout Standard
9533 The description is used in
9534 \begin_inset Flex Noun
9537 \begin_layout Plain Layout
9538 Document\SpecialChar menuseparator
9539 Settings\SpecialChar menuseparator
9545 to provide the user with information about the cite engine.
9548 \begin_layout Subsection
9552 \begin_layout Standard
9553 The first non-comment line of any layout file,
9559 contain the file format number:
9562 \begin_layout Description
9563 \begin_inset Flex Code
9566 \begin_layout Plain Layout
9573 \begin_inset Flex Code
9576 \begin_layout Plain Layout
9582 ] The format number of the layout file.
9585 \begin_layout Standard
9586 This tag was introduced with \SpecialChar LyX
9588 \begin_inset space ~
9592 Layout files from older \SpecialChar LyX
9593 versions do not have an explicit file format and are considered to have
9594 \begin_inset Flex Code
9597 \begin_layout Plain Layout
9599 \begin_inset space ~
9608 The format for the present version of \SpecialChar LyX
9610 But each version of \SpecialChar LyX
9611 is capable of reading earlier versions' layout files,
9612 just as they are capable of reading files produced by earlier versions of \SpecialChar LyX
9616 no provision for converting to earlier formats.
9619 \begin_layout Subsection
9620 \begin_inset CommandInset label
9622 name "subsec:General-text-class"
9626 General text class parameters
9629 \begin_layout Standard
9630 These are general parameters that govern the behavior of an entire document class.
9635 mean that they must appear in
9636 \begin_inset Flex Code
9639 \begin_layout Plain Layout
9645 files rather than in modules.
9646 A module can contain any layout tag.)
9649 \begin_layout Description
9651 \change_inserted -712698321 1526899478
9652 \begin_inset Flex Code
9655 \begin_layout Plain Layout
9657 \change_inserted -712698321 1526898610
9658 AddToCiteEngine <engine>
9665 Extends the possibilities for displaying citation references.
9667 \begin_inset CommandInset ref
9669 reference "subsec:Citation-engine-description"
9679 \begin_inset Flex Code
9682 \begin_layout Plain Layout
9684 \change_inserted -712698321 1526898823
9695 \begin_layout Description
9696 \begin_inset Flex Code
9699 \begin_layout Plain Layout
9705 Adds information that will be output in the
9706 \begin_inset Flex Code
9709 \begin_layout Plain Layout
9715 block when the document is output to XHTML.
9717 this would be used to output CSS style information,
9718 but it can be used for anything that can appear in
9719 \begin_inset Flex Code
9722 \begin_layout Plain Layout
9730 \begin_inset Quotes eld
9734 \begin_inset Flex Code
9737 \begin_layout Plain Layout
9744 \begin_inset Quotes erd
9750 \begin_layout Description
9751 \begin_inset Flex Code
9754 \begin_layout Plain Layout
9760 Adds information to the document preamble.
9762 \begin_inset Newline newline
9766 \begin_inset Quotes eld
9770 \begin_inset Flex Code
9773 \begin_layout Plain Layout
9780 \begin_inset Quotes erd
9784 \change_inserted -712698321 1562592950
9788 \begin_layout Description
9790 \change_inserted -712698321 1562593040
9791 \begin_inset Flex Code
9794 \begin_layout Plain Layout
9796 \change_inserted -712698321 1562592954
9805 \begin_inset Flex Code
9808 \begin_layout Plain Layout
9810 \change_inserted -712698321 1562592950
9821 \begin_inset space \thinspace{}
9825 \begin_inset Flex Code
9828 \begin_layout Plain Layout
9830 \change_inserted -712698321 1562592950
9838 ] If the document class adds the bibliography to the table of contents,
9839 add this option with value
9840 \begin_inset Flex Code
9843 \begin_layout Plain Layout
9845 \change_inserted -712698321 1562592996
9854 \begin_inset Flex Code
9857 \begin_layout Plain Layout
9859 \change_inserted -712698321 1562593006
9868 This prevents the bibliography from being added twice.
9873 \begin_layout Description
9874 \begin_inset Flex Code
9877 \begin_layout Plain Layout
9883 Defines the possibilities for displaying citation references.
9885 \begin_inset CommandInset ref
9887 reference "subsec:Citation-engine-description"
9897 \begin_inset Quotes eld
9901 \begin_inset Flex Code
9904 \begin_layout Plain Layout
9911 \begin_inset Quotes erd
9915 Primarily used in cite engine files (see
9916 \begin_inset CommandInset ref
9918 reference "subsec:Cite-Engine-Files"
9928 \change_inserted -712698321 1526898530
9929 Note that if you specify this in a layout file or module,
9930 any cite engine definition will be overridden.
9932 \begin_inset Flex Code
9935 \begin_layout Plain Layout
9937 \change_inserted -712698321 1526898530
9950 \begin_layout Description
9951 \begin_inset Flex Code
9954 \begin_layout Plain Layout
9960 Defines formats for use in the display of bibliographic information.
9962 \begin_inset CommandInset ref
9964 reference "subsec:Citation-format-description"
9971 \begin_inset Quotes eld
9975 \begin_inset Flex Code
9978 \begin_layout Plain Layout
9985 \begin_inset Quotes erd
9989 Primarily used in cite engine files (see
9990 \begin_inset CommandInset ref
9992 reference "subsec:Cite-Engine-Files"
10002 \change_inserted -712698321 1526898585
10003 A cite format defined in a layout or module will override the cite engine definition.
10008 \begin_layout Description
10009 \begin_inset Flex Code
10012 \begin_layout Plain Layout
10019 \begin_inset Flex Code
10022 \begin_layout Plain Layout
10031 \begin_inset Flex Code
10034 \begin_layout Plain Layout
10040 ] Determines whether
10044 or Bib\SpecialChar TeX
10045 is used to generate a Bibliography.
10046 Primarily used in cite engine files (see
10047 \begin_inset CommandInset ref
10049 reference "subsec:Cite-Engine-Files"
10060 \begin_layout Description
10061 \begin_inset Flex Code
10064 \begin_layout Plain Layout
10070 Describes various global options supported by the document class.
10072 \begin_inset CommandInset ref
10074 reference "subsec:ClassOptions"
10081 \begin_inset Quotes eld
10085 \begin_inset Flex Code
10088 \begin_layout Plain Layout
10095 \begin_inset Quotes erd
10101 \begin_layout Description
10102 \begin_inset Flex Code
10105 \begin_layout Plain Layout
10112 \begin_inset Flex Code
10115 \begin_layout Plain Layout
10124 \begin_inset space \thinspace{}
10128 \begin_inset Flex Code
10131 \begin_layout Plain Layout
10137 ] Whether the class should
10141 to having one or two columns.
10142 Can be changed in the
10143 \begin_inset Flex Noun
10146 \begin_layout Plain Layout
10147 Document\SpecialChar menuseparator
10156 \begin_layout Description
10157 \begin_inset Flex Code
10160 \begin_layout Plain Layout
10167 \begin_inset Flex Code
10170 \begin_layout Plain Layout
10176 ] This sequence defines the properties for a counter.
10177 If the counter does not yet exist,
10182 \begin_inset Quotes eld
10186 \begin_inset Flex Code
10189 \begin_layout Plain Layout
10196 \begin_inset Quotes erd
10200 \begin_inset Newline newline
10204 \begin_inset CommandInset ref
10206 reference "subsec:Counters"
10211 for details on counters.
10214 \begin_layout Description
10215 \begin_inset Flex Code
10218 \begin_layout Plain Layout
10224 Sets the default font used to display the document.
10226 \begin_inset CommandInset ref
10228 reference "subsec:Font-description"
10233 for how to declare fonts.
10235 \begin_inset Quotes eld
10239 \begin_inset Flex Code
10242 \begin_layout Plain Layout
10249 \begin_inset Quotes erd
10255 \begin_layout Description
10256 \begin_inset Flex Code
10259 \begin_layout Plain Layout
10266 \begin_inset Flex Code
10269 \begin_layout Plain Layout
10275 ] Specifies a module to be included by default with this document class.
10276 The module is specified as filename without the
10277 \begin_inset Flex Code
10280 \begin_layout Plain Layout
10287 The user can still remove the module,
10288 but it will be active at the outset.
10289 (This applies only when new files are created,
10290 or when this class is chosen for an existing document.)
10293 \begin_layout Description
10294 \begin_inset Flex Code
10297 \begin_layout Plain Layout
10304 \begin_inset Flex Code
10307 \begin_layout Plain Layout
10313 ] This is the style that will be assigned to new paragraphs,
10315 \begin_inset Flex Noun
10318 \begin_layout Plain Layout
10325 This will default to the first defined style if not given,
10326 but you are encouraged to use this directive.
10329 \begin_layout Description
10331 \change_inserted -970929547 1515112870
10332 \begin_inset Flex Code
10335 \begin_layout Plain Layout
10337 \change_inserted -970929547 1515112782
10346 \begin_inset Flex Code
10349 \begin_layout Plain Layout
10351 \change_inserted -970929547 1515112766
10359 ] The root element (at the top of the document) to use when outputting documents with this class in DocBook.
10360 The default value is
10361 \begin_inset Quotes eld
10365 \begin_inset Flex Code
10368 \begin_layout Plain Layout
10370 \change_inserted -970929547 1515112845
10379 \begin_inset Quotes erd
10384 \change_deleted 1075283030 1594226862
10386 \change_inserted 1075283030 1594226777
10390 \begin_layout Description
10392 \change_inserted 1075283030 1594226859
10393 \begin_inset Flex Code
10396 \begin_layout Plain Layout
10398 \change_inserted 1075283030 1594226785
10399 DocBookForceAbstract
10407 \begin_inset Flex Code
10410 \begin_layout Plain Layout
10412 \change_inserted 1075283030 1594226804
10421 \begin_inset Quotes eld
10429 \begin_inset Quotes erd
10433 the root element will always have an
10438 The default value is
10439 \begin_inset Quotes eld
10447 \begin_inset Quotes erd
10455 \begin_layout Description
10456 \begin_inset Flex Code
10459 \begin_layout Plain Layout
10466 \begin_inset Flex Code
10469 \begin_layout Plain Layout
10475 ] This tag indicates that the module (which is specified by filename without the
10476 \begin_inset Flex Code
10479 \begin_layout Plain Layout
10485 extension) cannot be used with this document class.
10486 This might be used in a journal-specific layout file to prevent,
10489 \begin_inset Flex Code
10492 \begin_layout Plain Layout
10498 module that numbers theorems by section.
10503 be used in a module.
10504 Modules have their own way of excluding other modules (see
10505 \begin_inset CommandInset ref
10507 reference "subsec:Layout-modules"
10515 \begin_layout Description
10516 \begin_inset Flex Code
10519 \begin_layout Plain Layout
10525 Defines a new float.
10527 \begin_inset CommandInset ref
10529 reference "subsec:Floats"
10536 \begin_inset Quotes eld
10540 \begin_inset Flex Code
10543 \begin_layout Plain Layout
10550 \begin_inset Quotes erd
10556 \begin_layout Description
10557 \begin_inset Flex Code
10560 \begin_layout Plain Layout
10566 Sets the information that will be output in the
10567 \begin_inset Flex Code
10570 \begin_layout Plain Layout
10576 block when this document class is output to XHTML.
10577 Note that this will completely override any prior
10578 \begin_inset Flex Code
10581 \begin_layout Plain Layout
10588 \begin_inset Flex Code
10591 \begin_layout Plain Layout
10599 \begin_inset Newline newline
10603 \begin_inset Flex Code
10606 \begin_layout Plain Layout
10612 if you just want to add material to the preamble.) Must end with
10613 \begin_inset Quotes eld
10617 \begin_inset Flex Code
10620 \begin_layout Plain Layout
10627 \begin_inset Quotes erd
10633 \begin_layout Description
10634 \begin_inset Flex Code
10637 \begin_layout Plain Layout
10644 \begin_inset Flex Code
10647 \begin_layout Plain Layout
10653 ] The style to use for the table of contents,
10656 when the document is output to HTML.
10658 this should normally be
10659 \begin_inset Flex Code
10662 \begin_layout Plain Layout
10670 \begin_inset Flex Code
10673 \begin_layout Plain Layout
10680 If it is not given,
10681 then \SpecialChar LyX
10682 will attempt to figure out which layout to use.
10685 \begin_layout Description
10686 \begin_inset Flex Code
10689 \begin_layout Plain Layout
10696 \begin_inset Flex Code
10699 \begin_layout Plain Layout
10705 ] Modifies the properties of the given counter.
10706 If the counter does not exist,
10707 the statement is ignored.
10709 \begin_inset Quotes eld
10713 \begin_inset Flex Code
10716 \begin_layout Plain Layout
10723 \begin_inset Quotes erd
10727 \begin_inset Newline newline
10731 \begin_inset CommandInset ref
10733 reference "subsec:Counters"
10738 for details on counters.
10741 \begin_layout Description
10742 \begin_inset Flex Code
10745 \begin_layout Plain Layout
10752 \begin_inset Flex Code
10755 \begin_layout Plain Layout
10761 ] This allows you to include another layout definition file within yours to avoid duplicating commands.
10762 Common examples are the standard layout files,
10765 \begin_inset Flex Code
10768 \begin_layout Plain Layout
10775 which contains most of the basic layouts.
10776 \change_inserted -712698321 1611646803
10780 \begin_layout Description
10782 \change_inserted -712698321 1611646804
10783 \begin_inset Flex Code
10786 \begin_layout Plain Layout
10788 \change_inserted -712698321 1611646837
10797 \begin_inset Flex Code
10800 \begin_layout Plain Layout
10802 \change_inserted -712698321 1611646804
10810 ] is a variant of the
10811 \begin_inset Flex Code
10814 \begin_layout Plain Layout
10816 \change_inserted -712698321 1611646804
10824 command which does not look for files in the user directory.
10825 This allows to create a file
10826 \begin_inset Flex Code
10829 \begin_layout Plain Layout
10831 \change_inserted -712698321 1611646804
10840 \begin_inset Flex Code
10843 \begin_layout Plain Layout
10845 \change_inserted -712698321 1611646804
10853 in the user directory which includes a global file with the same name via
10854 \begin_inset Flex Code
10857 \begin_layout Plain Layout
10859 \change_inserted -712698321 1611646853
10868 \begin_inset Flex Code
10871 \begin_layout Plain Layout
10873 \change_inserted -712698321 1611646855
10874 InputGlobal name.inc
10883 \begin_inset Flex Code
10886 \begin_layout Plain Layout
10888 \change_inserted -712698321 1611646804
10897 the file would recursively include itself).
10899 you can modify global files without having to completely copy them.
10904 \begin_layout Description
10905 \begin_inset Flex Code
10908 \begin_layout Plain Layout
10915 \begin_inset Flex Code
10918 \begin_layout Plain Layout
10924 ] This section (re-)defines the layout of an inset.
10925 It can be applied to an existing inset or to a new,
10926 user-defined inset,
10928 a new character style.
10930 \begin_inset Quotes eld
10934 \begin_inset Flex Code
10937 \begin_layout Plain Layout
10944 \begin_inset Quotes erd
10948 \begin_inset Newline newline
10952 \begin_inset CommandInset ref
10954 reference "subsec:Flex-insets-and"
10959 for more information.
10963 \begin_layout Description
10964 \begin_inset Flex Code
10967 \begin_layout Plain Layout
10974 \begin_inset Flex Code
10977 \begin_layout Plain Layout
10983 ] A string that indicates the width of the left margin on the screen,
10986 \begin_inset Quotes eld
10990 \begin_inset Flex Code
10993 \begin_layout Plain Layout
11000 \begin_inset Quotes erd
11004 (Note that this is not a `length',
11006 \begin_inset Quotes eld
11010 \begin_inset Quotes erd
11016 \begin_layout Description
11017 \begin_inset Flex Code
11020 \begin_layout Plain Layout
11027 \begin_inset Flex Code
11030 \begin_layout Plain Layout
11036 ] An integer that determines the maximal number of names displayed in an author-year citation before the citation switches to
11037 \begin_inset Quotes eld
11041 \begin_inset Quotes erd
11045 Primarily used in cite engine files (see
11046 \begin_inset CommandInset ref
11048 reference "subsec:Cite-Engine-Files"
11059 \begin_layout Description
11061 \change_inserted -712698321 1612018485
11062 \begin_inset Flex Code
11065 \begin_layout Plain Layout
11067 \change_inserted -712698321 1612018457
11076 \begin_inset Flex Code
11079 \begin_layout Plain Layout
11081 \change_inserted -712698321 1612018466
11089 ] Modifies the layout of an inset.
11090 If the layout does not exist,
11091 this section is ignored.
11093 \begin_inset Quotes eld
11097 \begin_inset Flex Code
11100 \begin_layout Plain Layout
11102 \change_inserted -712698321 1612018452
11111 \begin_inset Quotes erd
11117 \begin_layout Description
11118 \begin_inset Flex Code
11121 \begin_layout Plain Layout
11128 \begin_inset Flex Code
11131 \begin_layout Plain Layout
11137 ] Modifies the properties of the given paragraph style.
11138 If the style does not exist,
11139 this section is ignored.
11141 \begin_inset Quotes eld
11145 \begin_inset Flex Code
11148 \begin_layout Plain Layout
11155 \begin_inset Quotes erd
11161 \begin_layout Description
11162 \begin_inset Flex Code
11165 \begin_layout Plain Layout
11172 \begin_inset Flex Code
11175 \begin_layout Plain Layout
11181 ] Deletes an existing counter,
11182 usually one defined in an included file.
11185 \begin_layout Description
11186 \begin_inset Flex Code
11189 \begin_layout Plain Layout
11196 \begin_inset Flex Code
11199 \begin_layout Plain Layout
11205 ] Deletes an existing float.
11206 This is particularly useful when you want to suppress a float that has been defined in an input file.
11209 \begin_layout Description
11210 \begin_inset Flex Code
11213 \begin_layout Plain Layout
11220 \begin_inset Flex Code
11223 \begin_layout Plain Layout
11229 ] Deletes an existing style.
11232 \begin_layout Description
11233 \begin_inset Flex Code
11236 \begin_layout Plain Layout
11243 \begin_inset Flex Code
11246 \begin_layout Plain Layout
11253 \begin_inset Flex Code
11256 \begin_layout Plain Layout
11262 ] Define a new table of contents with type
11263 \begin_inset Flex Code
11266 \begin_layout Plain Layout
11273 \begin_inset Flex Code
11276 \begin_layout Plain Layout
11283 See also the AddToToc commands.
11286 \begin_layout Description
11287 \begin_inset Flex Code
11290 \begin_layout Plain Layout
11297 \begin_inset Flex Code
11300 \begin_layout Plain Layout
11306 ] The file format (as defined in the \SpecialChar LyX
11307 preferences) produced by this document class.
11308 It is mainly useful when
11309 \begin_inset Flex Code
11312 \begin_layout Plain Layout
11319 \begin_inset Flex Code
11322 \begin_layout Plain Layout
11328 and one wants to define a new type of literate document.
11329 The format is reset to
11330 \change_deleted 5863208 1594239413
11332 \begin_inset Quotes eld
11336 \begin_inset Flex Code
11339 \begin_layout Plain Layout
11346 \begin_inset Quotes erd
11352 \begin_inset Quotes eld
11356 \begin_inset Flex Code
11359 \begin_layout Plain Layout
11366 \begin_inset Quotes erd
11369 when the corresponding
11370 \begin_inset Flex Code
11373 \begin_layout Plain Layout
11379 parameter is encountered.
11382 \begin_layout Description
11383 \begin_inset Flex Code
11386 \begin_layout Plain Layout
11393 \begin_inset Flex Code
11396 \begin_layout Plain Layout
11408 \change_deleted 5863208 1594239430
11410 \begin_inset Flex Code
11413 \begin_layout Plain Layout
11423 \begin_inset Flex Code
11426 \begin_layout Plain Layout
11432 ] Specifies what sort of output documents using this class will produce.
11435 \begin_layout Description
11436 \begin_inset Flex Code
11439 \begin_layout Plain Layout
11446 \begin_inset Flex Code
11449 \begin_layout Plain Layout
11456 \begin_inset Flex Code
11459 \begin_layout Plain Layout
11465 ] Specifies options,
11466 given in the second string,
11467 for the package named by the first string.
11470 \begin_inset Quotes eld
11474 \begin_inset Flex Code
11477 \begin_layout Plain Layout
11478 PackageOptions natbib square
11484 \begin_inset Quotes erd
11488 \begin_inset Flex Code
11491 \begin_layout Plain Layout
11497 to be loaded with the
11498 \begin_inset Flex Code
11501 \begin_layout Plain Layout
11508 (For \SpecialChar TeX
11510 this causes \SpecialChar LyX
11513 \begin_inset Flex Code
11516 \begin_layout Plain Layout
11519 PassOptionsToPackage{natbib}{square}
11525 \begin_inset Flex Code
11528 \begin_layout Plain Layout
11535 \change_inserted -712698321 1565102364
11539 \begin_layout Description
11541 \change_inserted -712698321 1565102470
11542 \begin_inset Flex Code
11545 \begin_layout Plain Layout
11547 \change_inserted -712698321 1565102365
11556 \begin_inset Flex Code
11559 \begin_layout Plain Layout
11561 \change_inserted -712698321 1565105222
11604 ] The default page size.
11605 This is used by some converters.
11610 \begin_layout Description
11611 \begin_inset Flex Code
11614 \begin_layout Plain Layout
11621 \begin_inset Flex Code
11624 \begin_layout Plain Layout
11634 \begin_inset Flex Code
11637 \begin_layout Plain Layout
11645 \begin_inset Flex Code
11648 \begin_layout Plain Layout
11654 ] The default pagestyle.
11655 Can be changed in the
11656 \begin_inset Flex Noun
11659 \begin_layout Plain Layout
11660 Document\SpecialChar menuseparator
11669 \begin_layout Description
11670 \begin_inset Flex Code
11673 \begin_layout Plain Layout
11679 Sets the preamble for the \SpecialChar LaTeX
11681 Note that this will completely override any prior
11682 \begin_inset Flex Code
11685 \begin_layout Plain Layout
11692 \begin_inset Flex Code
11695 \begin_layout Plain Layout
11703 \begin_inset Flex Code
11706 \begin_layout Plain Layout
11712 if you just want to add material to the preamble.) Must end with
11713 \begin_inset Quotes eld
11717 \begin_inset Flex Code
11720 \begin_layout Plain Layout
11727 \begin_inset Quotes erd
11731 \change_inserted -712698321 1612018500
11735 \begin_layout Description
11737 \change_inserted -712698321 1612018547
11738 \begin_inset Flex Code
11741 \begin_layout Plain Layout
11743 \change_inserted -712698321 1612018506
11752 \begin_inset Flex Code
11755 \begin_layout Plain Layout
11757 \change_inserted -712698321 1612018509
11765 ] Defines the layout of an inset if it does not already exist.
11766 If the layout does exist,
11767 this section is ignored.
11769 \begin_inset Quotes eld
11773 \begin_inset Flex Code
11776 \begin_layout Plain Layout
11778 \change_inserted -712698321 1612018500
11787 \begin_inset Quotes erd
11795 \begin_layout Description
11796 \begin_inset Flex Code
11799 \begin_layout Plain Layout
11806 \begin_inset Flex Code
11809 \begin_layout Plain Layout
11816 \begin_inset Flex Code
11819 \begin_layout Plain Layout
11828 \begin_inset space \thinspace{}
11832 \begin_inset Flex Code
11835 \begin_layout Plain Layout
11841 ] Whether the class already provides the feature
11842 \begin_inset Flex Code
11845 \begin_layout Plain Layout
11852 A feature is in general the name of a package (e.
11853 \begin_inset space \thinspace{}
11857 \begin_inset space \space{}
11861 \begin_inset Flex Code
11864 \begin_layout Plain Layout
11871 \begin_inset Flex Code
11874 \begin_layout Plain Layout
11881 \begin_inset space \thinspace{}
11885 \begin_inset space \space{}
11889 \begin_inset Flex Code
11892 \begin_layout Plain Layout
11899 \begin_inset Flex Code
11902 \begin_layout Plain Layout
11910 \begin_inset CommandInset ref
11912 reference "chap:List-of-functions"
11917 for the list of features.
11920 \begin_layout Description
11921 \begin_inset Flex Code
11924 \begin_layout Plain Layout
11931 \begin_inset Flex Code
11934 \begin_layout Plain Layout
11940 ] Indicates that this layout provides the functionality of the module mentioned,
11941 which should be specified by the filename without the
11942 \begin_inset Flex Code
11945 \begin_layout Plain Layout
11952 This will typically be used if the layout includes the module directly,
11953 rather than using the
11954 \begin_inset Flex Code
11957 \begin_layout Plain Layout
11963 tag to indicate that it ought to be used.
11964 It could also be used in a module that provided an alternate implementation of the same functionality.
11967 \begin_layout Description
11968 \begin_inset Flex Code
11971 \begin_layout Plain Layout
11978 \begin_inset Flex Code
11981 \begin_layout Plain Layout
11987 ] Creates a new paragraph style if it does not already exist.
11988 If the style does exist,
11989 this section is ignored.
11991 \begin_inset Quotes eld
11995 \begin_inset Flex Code
11998 \begin_layout Plain Layout
12005 \begin_inset Quotes erd
12011 \begin_layout Description
12012 \begin_inset Flex Code
12015 \begin_layout Plain Layout
12022 \begin_inset Flex Code
12025 \begin_layout Plain Layout
12031 ] Whether the class requires the feature
12032 \begin_inset Flex Code
12035 \begin_layout Plain Layout
12042 Multiple features must be separated by commas.
12043 Note that you can only request supported features.
12045 \begin_inset CommandInset ref
12047 reference "chap:List-of-functions"
12052 for the list of features.).
12053 If you require a package with specific options,
12054 you can additionally use
12055 \begin_inset Flex Code
12058 \begin_layout Plain Layout
12067 \begin_layout Description
12068 \begin_inset Flex Code
12071 \begin_layout Plain Layout
12078 \begin_inset Flex Code
12081 \begin_layout Plain Layout
12087 ] A string that indicates the width of the right margin on the screen,
12090 \begin_inset Quotes eld
12094 \begin_inset Flex Code
12097 \begin_layout Plain Layout
12104 \begin_inset Quotes erd
12110 \begin_layout Description
12111 \begin_inset Flex Code
12114 \begin_layout Plain Layout
12121 \begin_inset Flex Code
12124 \begin_layout Plain Layout
12130 ] Sets which divisions get numbered.
12132 \begin_inset Newline newline
12136 \begin_inset Flex Code
12139 \begin_layout Plain Layout
12145 counter in \SpecialChar LaTeX
12149 \begin_layout Description
12150 \begin_inset Flex Code
12153 \begin_layout Plain Layout
12160 \begin_inset Flex Code
12163 \begin_layout Plain Layout
12172 \begin_inset space \thinspace{}
12176 \begin_inset Flex Code
12179 \begin_layout Plain Layout
12185 ] Whether the class-default should be printing on one or both sides of the paper.
12186 Can be changed in the
12187 \begin_inset Flex Noun
12190 \begin_layout Plain Layout
12191 Document\SpecialChar menuseparator
12200 \begin_layout Description
12201 \begin_inset Flex Code
12204 \begin_layout Plain Layout
12211 \begin_inset Flex Code
12214 \begin_layout Plain Layout
12220 ] This sequence defines a paragraph style.
12221 If the style does not yet exist,
12224 its parameters are modified.
12226 \begin_inset Quotes eld
12230 \begin_inset Flex Code
12233 \begin_layout Plain Layout
12240 \begin_inset Quotes erd
12244 \begin_inset Newline newline
12248 \begin_inset CommandInset ref
12250 reference "subsec:Paragraph-Styles"
12255 for details on paragraph styles.
12256 \change_inserted -712698321 1553617804
12260 \begin_layout Description
12262 \change_inserted -712698321 1553617862
12263 \begin_inset Flex Code
12266 \begin_layout Plain Layout
12268 \change_inserted -712698321 1553617809
12277 \begin_inset Flex Code
12280 \begin_layout Plain Layout
12282 \change_inserted -712698321 1553617805
12290 ] defines the default table style that is used when inserting a table.
12291 The following styles are available:
12295 \begin_layout Itemize
12297 \change_inserted -712698321 1554308039
12298 \begin_inset Flex Code
12301 \begin_layout Plain Layout
12303 \change_inserted -712698321 1554307928
12304 Formal_with_Footline
12313 \begin_inset Quotes eld
12317 \begin_inset Quotes erd
12320 ) style with horizontal lines only,
12321 using a bold top and bottom line,
12322 the first and last row are additionally separated from the table body with a thin middle line.
12325 \begin_layout Itemize
12327 \change_inserted -712698321 1554308087
12328 \begin_inset Flex Code
12331 \begin_layout Plain Layout
12333 \change_inserted -712698321 1554308042
12334 Formal_without_Footline
12343 but the last row is not separated with a middle line from the body.
12346 \begin_layout Itemize
12348 \change_inserted -712698321 1553618031
12349 \begin_inset Flex Code
12352 \begin_layout Plain Layout
12354 \change_inserted -712698321 1553618006
12363 Simple table lines.
12366 \begin_layout Itemize
12368 \change_inserted -712698321 1553618309
12369 \begin_inset Flex Code
12372 \begin_layout Plain Layout
12374 \change_inserted -712698321 1553618031
12384 \begin_inset Flex Code
12387 \begin_layout Plain Layout
12389 \change_inserted -712698321 1553618043
12398 but with the header
12399 \change_deleted 34634807 1619712593
12401 \change_inserted 34634807 1619712594
12403 \change_inserted -712698321 1553618309
12404 offset with a second horizontal line.
12405 This is also the default style of \SpecialChar LyX
12409 \begin_layout Itemize
12411 \change_inserted -712698321 1553618280
12412 \begin_inset Flex Code
12415 \begin_layout Plain Layout
12417 \change_inserted -712698321 1553618261
12426 Table without lines.
12432 \begin_layout Description
12433 \begin_inset Flex Code
12436 \begin_layout Plain Layout
12443 \begin_inset Flex Code
12446 \begin_layout Plain Layout
12452 ] The name of the command or environment to be used with
12453 \begin_inset Flex Code
12456 \begin_layout Plain Layout
12465 \begin_layout Description
12466 \begin_inset Flex Code
12469 \begin_layout Plain Layout
12476 \begin_inset Flex Code
12479 \begin_layout Plain Layout
12489 \begin_inset Flex Code
12492 \begin_layout Plain Layout
12498 ] Indicates what kind of markup is used to define the title of a document.
12500 \begin_inset Flex Code
12503 \begin_layout Plain Layout
12509 means that the macro with name
12510 \begin_inset Flex Code
12513 \begin_layout Plain Layout
12519 will be inserted after the last layout which has
12520 \begin_inset Quotes eld
12524 \begin_inset Flex Code
12527 \begin_layout Plain Layout
12529 \begin_inset space ~
12538 \begin_inset Quotes erd
12543 \begin_inset Flex Code
12546 \begin_layout Plain Layout
12552 corresponds to the case where all layouts which have
12553 \begin_inset Quotes eld
12557 \begin_inset Flex Code
12560 \begin_layout Plain Layout
12562 \begin_inset space ~
12571 \begin_inset Quotes erd
12574 should be enclosed into the
12575 \begin_inset Flex Code
12578 \begin_layout Plain Layout
12587 \begin_layout Description
12588 \begin_inset Flex Code
12591 \begin_layout Plain Layout
12598 \begin_inset Flex Code
12601 \begin_layout Plain Layout
12607 ] Sets which divisions are included in the table of contents.
12609 \begin_inset Flex Code
12612 \begin_layout Plain Layout
12618 counter in \SpecialChar LaTeX
12622 \begin_layout Subsection
12623 \begin_inset Flex Code
12626 \begin_layout Plain Layout
12633 \begin_inset CommandInset label
12635 name "subsec:ClassOptions"
12642 \begin_layout Standard
12644 \begin_inset Flex Code
12647 \begin_layout Plain Layout
12653 section can contain the following entries:
12656 \begin_layout Description
12657 \begin_inset Flex Code
12660 \begin_layout Plain Layout
12667 \begin_inset Flex Code
12670 \begin_layout Plain Layout
12676 ] The list of available font sizes for the document's main font,
12678 \begin_inset Quotes eld
12682 \begin_inset Flex Code
12685 \begin_layout Plain Layout
12692 \begin_inset Quotes erd
12697 \change_inserted -712698321 1565110196
12698 Any number is possible.
12701 \begin_layout Description
12703 \change_inserted -712698321 1565110259
12704 \begin_inset Flex Code
12707 \begin_layout Plain Layout
12709 \change_inserted -712698321 1565110199
12718 \begin_inset Flex Code
12721 \begin_layout Plain Layout
12723 \change_inserted -712698321 1565110196
12731 ] The format for the font size option.
12734 \begin_inset Flex Code
12737 \begin_layout Plain Layout
12739 \change_inserted -712698321 1565110238
12749 \begin_inset Flex Code
12752 \begin_layout Plain Layout
12754 \change_inserted -712698321 1565110248
12762 is a placeholder for the font size.
12767 \begin_layout Description
12769 \change_deleted 5863208 1594239483
12770 \begin_inset Flex Code
12773 \begin_layout Plain Layout
12779 Used to set the DTD line with XML-based output classes.
12781 \begin_inset space \thinspace{}
12786 \begin_inset Quotes eld
12789 -//OASIS//DTD DocBook V4.2//EN
12790 \begin_inset Quotes erd
12794 \change_inserted -712698321 1565101761
12798 \begin_layout Description
12800 \change_inserted -712698321 1565180598
12801 \begin_inset Flex Code
12804 \begin_layout Plain Layout
12806 \change_inserted -712698321 1565101918
12815 \begin_inset Flex Code
12818 \begin_layout Plain Layout
12820 \change_inserted -712698321 1565105399
12821 string="letter|\SpecialChar allowbreak
12822 legal|\SpecialChar allowbreak
12823 executive|\SpecialChar allowbreak
12824 a0|\SpecialChar allowbreak
12825 a1|\SpecialChar allowbreak
12826 a2|\SpecialChar allowbreak
12827 a3|\SpecialChar allowbreak
12828 a4|\SpecialChar allowbreak
12829 a5|\SpecialChar allowbreak
12830 a6|\SpecialChar allowbreak
12831 b0|\SpecialChar allowbreak
12832 b1|\SpecialChar allowbreak
12833 b2|\SpecialChar allowbreak
12834 b3|\SpecialChar allowbreak
12835 b4|\SpecialChar allowbreak
12836 b5|\SpecialChar allowbreak
12837 b6|\SpecialChar allowbreak
12838 c0|\SpecialChar allowbreak
12839 c1|\SpecialChar allowbreak
12840 c2|\SpecialChar allowbreak
12841 c3|\SpecialChar allowbreak
12842 c4|\SpecialChar allowbreak
12843 c5|\SpecialChar allowbreak
12844 c6|\SpecialChar allowbreak
12845 b0j|\SpecialChar allowbreak
12846 b1j|\SpecialChar allowbreak
12847 b2j|\SpecialChar allowbreak
12848 b3j|\SpecialChar allowbreak
12849 b4j|\SpecialChar allowbreak
12850 b5j|\SpecialChar allowbreak
12858 ] The list of available page sizes,
12860 \begin_inset Quotes eld
12864 \begin_inset Flex Code
12867 \begin_layout Plain Layout
12869 \change_inserted -712698321 1565101779
12878 \begin_inset Quotes erd
12883 only the listed sizes are supported.
12884 Other sizes might be entered as custom class option.
12887 \begin_layout Description
12889 \change_inserted -712698321 1565180623
12890 \begin_inset Flex Code
12893 \begin_layout Plain Layout
12895 \change_inserted -712698321 1565180605
12904 \begin_inset Flex Code
12907 \begin_layout Plain Layout
12909 \change_inserted -712698321 1565180601
12917 ] The format for the page size option.
12920 \begin_inset Flex Code
12923 \begin_layout Plain Layout
12925 \change_inserted -712698321 1565180618
12935 \begin_inset Flex Code
12938 \begin_layout Plain Layout
12940 \change_inserted -712698321 1565180601
12948 is a placeholder for the paper size.
12953 \begin_layout Description
12954 \begin_inset Flex Code
12957 \begin_layout Plain Layout
12964 \begin_inset Flex Code
12967 \begin_layout Plain Layout
12968 string="empty|plain|headings|fancy"
12973 ] The list of available page sty\SpecialChar softhyphen
12976 \begin_inset Quotes eld
12980 \begin_inset Flex Code
12983 \begin_layout Plain Layout
12990 \begin_inset Quotes erd
12996 \begin_layout Description
12997 \begin_inset Flex Code
13000 \begin_layout Plain Layout
13007 \begin_inset Flex Code
13010 \begin_layout Plain Layout
13016 ] Some document class options,
13017 separated by a comma,
13018 that will be added to the optional part of the
13019 \begin_inset Flex Code
13022 \begin_layout Plain Layout
13033 \begin_layout Standard
13035 \begin_inset Flex Code
13038 \begin_layout Plain Layout
13044 section must end with
13045 \begin_inset Quotes eld
13049 \begin_inset Flex Code
13052 \begin_layout Plain Layout
13059 \begin_inset Quotes erd
13065 \begin_layout Subsection
13067 \begin_inset CommandInset label
13069 name "subsec:Paragraph-Styles"
13076 \begin_layout Standard
13077 A paragraph style description looks like this:
13081 \begin_layout Plain Layout
13082 Note that this will either define a new style or modify an existing one.
13090 \begin_layout LyX-Code
13097 \begin_layout LyX-Code
13101 \begin_layout LyX-Code
13105 \begin_layout Standard
13106 where the following commands are allowed:
13109 \begin_layout Description
13110 \begin_inset Flex Code
13113 \begin_layout Plain Layout
13120 \begin_inset Flex Code
13123 \begin_layout Plain Layout
13129 =""] This paragraph will appear in the table of contents of the given type.
13130 An empty string disables.
13131 See also the OutlinerName and the IsTocCaption commands.
13136 \begin_layout Description
13137 \begin_inset Flex Code
13140 \begin_layout Plain Layout
13147 \begin_inset Flex Code
13150 \begin_layout Plain Layout
13163 ] Paragraph alignment.
13166 \begin_layout Description
13167 \begin_inset Flex Code
13170 \begin_layout Plain Layout
13177 \begin_inset Flex Code
13180 \begin_layout Plain Layout
13193 ] A comma separated list of permitted alignments.
13194 (Some \SpecialChar LaTeX
13195 styles prohibit certain alignments,
13196 since those wouldn't make sense.
13197 For example a right-aligned or centered enumeration isn't possible.)
13200 \begin_layout Description
13201 \begin_inset Flex Code
13204 \begin_layout Plain Layout
13211 \begin_inset Flex Code
13214 \begin_layout Plain Layout
13220 ] Defines argument number <int> of a command\SpecialChar breakableslash
13221 environment associated with the current style.
13223 \change_inserted -584632292 1615846868
13224 The definition must end with
13225 \begin_inset Flex Code
13228 \begin_layout Plain Layout
13230 \change_inserted -584632292 1615846867
13242 \change_inserted -584632292 1615846880
13244 \begin_inset CommandInset ref
13246 reference "subsec:Arguments"
13254 for more information.
13256 \change_deleted -584632292 1615846694
13257 This is useful for things like section headings,
13258 and only makes sense with \SpecialChar LaTeX
13260 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,
13261 where the number specifies the order of the arguments.
13262 The definition must end with
13263 \begin_inset Flex Code
13266 \begin_layout Plain Layout
13273 So a command with two optional arguments has:
13277 \begin_layout Quote
13279 \change_deleted -584632292 1615846694
13285 \begin_layout Quote
13287 \change_deleted -584632292 1615846694
13293 \begin_layout Quote
13295 \change_deleted -584632292 1615846694
13301 \begin_layout Quote
13303 \change_deleted -584632292 1615846694
13309 \begin_layout Quote
13311 \change_deleted -584632292 1615846694
13317 \begin_layout Quote
13319 \change_deleted -584632292 1615846694
13325 \begin_layout Standard
13327 \change_deleted -584632292 1615846694
13329 \begin_inset Flex Code
13332 \begin_layout Plain Layout
13339 the following specifications are possible:
13342 \begin_layout Itemize
13344 \change_deleted -584632292 1615846694
13345 \begin_inset Flex Code
13348 \begin_layout Plain Layout
13355 \begin_inset Flex Code
13358 \begin_layout Plain Layout
13364 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
13365 \begin_inset Flex Code
13368 \begin_layout Plain Layout
13376 you can define an accelerator by appending the respective character to the string,
13378 \begin_inset Quotes eld
13382 \begin_inset Quotes erd
13386 \begin_inset space \thinspace{}
13390 \begin_inset space \space{}
13394 \begin_inset Quotes eld
13398 \begin_inset Flex Code
13401 \begin_layout Plain Layout
13408 \begin_inset Quotes erd
13414 \begin_layout Itemize
13416 \change_deleted -584632292 1615846694
13417 \begin_inset Flex Code
13420 \begin_layout Plain Layout
13427 \begin_inset Flex Code
13430 \begin_layout Plain Layout
13436 A separate string for the menu.
13437 You can define an accelerator by appending the respective character to the string,
13439 \begin_inset Quotes eld
13443 \begin_inset Quotes erd
13447 \begin_inset space \thinspace{}
13451 \begin_inset space \space{}
13455 \begin_inset Quotes eld
13459 \begin_inset Flex Code
13462 \begin_layout Plain Layout
13469 \begin_inset Quotes erd
13473 This specification is optional.
13474 If it is not given the
13475 \begin_inset Flex Code
13478 \begin_layout Plain Layout
13484 will be used instead for the menu.
13487 \begin_layout Itemize
13489 \change_deleted -584632292 1615846694
13490 \begin_inset Flex Code
13493 \begin_layout Plain Layout
13500 \begin_inset Flex Code
13503 \begin_layout Plain Layout
13509 A longer explanatory text that appears in the tooltip when hovering over the argument inset.
13512 \begin_layout Itemize
13514 \change_deleted -584632292 1615846694
13515 \begin_inset Flex Code
13518 \begin_layout Plain Layout
13525 \begin_inset Flex Code
13528 \begin_layout Plain Layout
13537 \begin_inset space \thinspace{}
13541 \begin_inset Flex Code
13544 \begin_layout Plain Layout
13550 ] Declare if this is a mandatory (1) or an optional (0) argument.
13551 Mandatory arguments will be output empty if not given,
13552 while optional arguments will not be output at all.
13554 mandatory arguments are delimited by
13555 \begin_inset Flex Code
13558 \begin_layout Plain Layout
13565 while optional arguments are delimited by
13566 \begin_inset Flex Code
13569 \begin_layout Plain Layout
13578 \begin_layout Itemize
13580 \change_deleted -584632292 1615846694
13581 \begin_inset Flex Code
13584 \begin_layout Plain Layout
13586 \change_inserted -712698321 1555579780
13595 \begin_inset Flex Code
13598 \begin_layout Plain Layout
13600 \change_inserted -712698321 1555579780
13608 Option to define a different command (from the default
13609 \begin_inset Flex Code
13612 \begin_layout Plain Layout
13614 \change_inserted -712698321 1555579780
13626 ) to be used for line breaks.
13627 The initial backslash must not be specified.
13630 \begin_layout Itemize
13632 \change_deleted -584632292 1615846694
13633 \begin_inset Flex Code
13636 \begin_layout Plain Layout
13643 \begin_inset Flex Code
13646 \begin_layout Plain Layout
13652 defines another argument (by its number) which this argument requires to be output if it is itself output.
13654 \begin_inset space \thinspace{}
13658 in \SpecialChar LaTeX
13660 optional arguments often require previous optional arguments to be output (at least empty),
13662 \begin_inset Flex Code
13665 \begin_layout Plain Layout
13668 command[][argument]{text}
13674 This can be achieved by the statement
13675 \begin_inset Flex Code
13678 \begin_layout Plain Layout
13685 \begin_inset Flex Code
13688 \begin_layout Plain Layout
13697 \begin_layout Itemize
13699 \change_deleted -584632292 1615846694
13700 \begin_inset Flex Code
13703 \begin_layout Plain Layout
13710 \begin_inset Flex Code
13713 \begin_layout Plain Layout
13719 defines a custom left delimiter (instead of
13720 \begin_inset Flex Code
13723 \begin_layout Plain Layout
13730 \begin_inset Flex Code
13733 \begin_layout Plain Layout
13740 A line break in the output can be indicated by
13741 \begin_inset Flex Code
13744 \begin_layout Plain Layout
13753 \begin_layout Itemize
13755 \change_deleted -584632292 1615846694
13756 \begin_inset Flex Code
13759 \begin_layout Plain Layout
13766 \begin_inset Flex Code
13769 \begin_layout Plain Layout
13775 defines a custom right delimiter (instead of
13776 \begin_inset Flex Code
13779 \begin_layout Plain Layout
13786 \begin_inset Flex Code
13789 \begin_layout Plain Layout
13796 A line break in the output can be indicated by
13797 \begin_inset Flex Code
13800 \begin_layout Plain Layout
13809 \begin_layout Itemize
13811 \change_deleted -584632292 1615846694
13812 \begin_inset Flex Code
13815 \begin_layout Plain Layout
13822 \begin_inset Flex Code
13825 \begin_layout Plain Layout
13831 defines an argument that is inserted if and only if no user-specified arguments were given,
13833 \begin_inset space \thinspace{}
13837 \begin_inset space \space{}
13840 if no argument inset has been inserted (note that also an empty argument inset omits the DefaultArg).
13841 Multiple arguments need to be separated by comma.
13844 \begin_layout Itemize
13846 \change_deleted -584632292 1615846694
13847 \begin_inset Flex Code
13850 \begin_layout Plain Layout
13857 \begin_inset Flex Code
13860 \begin_layout Plain Layout
13866 defines an argument that is inserted in any case (alone or in addition to user-specified arguments).
13867 Multiple arguments need to be separated by comma.
13870 \begin_layout Itemize
13872 \change_deleted -584632292 1615846694
13873 \begin_inset Flex Code
13876 \begin_layout Plain Layout
13882 The font used for the argument content,
13884 \begin_inset CommandInset ref
13886 reference "subsec:Font-description"
13894 \begin_layout Itemize
13896 \change_deleted -584632292 1615846694
13897 \begin_inset Flex Code
13900 \begin_layout Plain Layout
13902 \change_inserted -712698321 1559484228
13911 \begin_inset Flex Code
13914 \begin_layout Plain Layout
13916 \change_inserted -712698321 1559484228
13927 \begin_inset space \thinspace{}
13931 \begin_inset Flex Code
13934 \begin_layout Plain Layout
13936 \change_inserted -712698321 1559484228
13944 ] As with paragraph styles,
13946 \begin_inset CommandInset ref
13948 reference "subsec:Paragraph-Styles"
13956 \begin_layout Itemize
13958 \change_deleted -584632292 1615846694
13959 \begin_inset Flex Code
13962 \begin_layout Plain Layout
13968 The font used for the label;
13970 \begin_inset CommandInset ref
13972 reference "subsec:Font-description"
13980 \begin_layout Itemize
13982 \change_deleted -584632292 1615846694
13983 \begin_inset Flex Code
13986 \begin_layout Plain Layout
13993 \begin_inset Flex Code
13996 \begin_layout Plain Layout
14008 ] describes the rendering style used for the inset's frame and buttons.
14011 \begin_layout Itemize
14013 \change_deleted -584632292 1615846694
14014 \begin_inset Flex Code
14017 \begin_layout Plain Layout
14024 \begin_inset Flex Code
14027 \begin_layout Plain Layout
14034 \begin_inset Flex Code
14037 \begin_layout Plain Layout
14044 this argument is automatically inserted when the respective style is selected.
14046 \change_deleted -712698321 1559484200
14048 only one argument per style\SpecialChar breakableslash
14049 layout can be automatically inserted.
14050 \change_deleted -584632292 1615846694
14054 \begin_layout Itemize
14056 \change_deleted -584632292 1615846694
14057 \begin_inset Flex Code
14060 \begin_layout Plain Layout
14062 \change_inserted -712698321 1559490711
14071 \begin_inset Flex Code
14074 \begin_layout Plain Layout
14076 \change_inserted -712698321 1559490703
14085 \begin_inset Flex Code
14088 \begin_layout Plain Layout
14090 \change_inserted -712698321 1559490703
14099 this argument will be inserted on a new line with
14100 \begin_inset Flex Code
14103 \begin_layout Plain Layout
14105 \change_inserted -712698321 1559491402
14113 (only available within Flex insets).
14116 \begin_layout Itemize
14118 \change_deleted -584632292 1615846694
14119 \begin_inset Flex Code
14122 \begin_layout Plain Layout
14129 \begin_inset Flex Code
14132 \begin_layout Plain Layout
14139 \begin_inset Flex Code
14142 \begin_layout Plain Layout
14149 this argument will be inserted with a copy of the co-text (either selected text or the whole paragraph) as content.
14152 \begin_layout Itemize
14154 \change_deleted -584632292 1615846694
14155 \begin_inset Flex Code
14158 \begin_layout Plain Layout
14165 \begin_inset Flex Code
14168 \begin_layout Plain Layout
14180 ] Whether the contents of this argument should be output in raw form,
14181 meaning without special translations that \SpecialChar LaTeX
14185 \begin_inset Flex Code
14188 \begin_layout Plain Layout
14194 status is inherited by the inset or paragraph layout the argument belongs to,
14195 true and false change the status for the given argument only.
14198 \begin_layout Itemize
14200 \change_deleted -584632292 1615846694
14201 \begin_inset Flex Code
14204 \begin_layout Plain Layout
14211 \begin_inset Flex Code
14214 \begin_layout Plain Layout
14215 string of characters
14224 Defines individual characters
14225 \begin_inset Newline linebreak
14228 that should be output in raw form,
14229 meaning without special translations that \SpecialChar LaTeX
14232 contrary to PassThru,
14233 this needs to be explicitly defined for arguments.
14235 arguments do not inherit PassThruChars from their parent inset or layout.
14238 \begin_layout Itemize
14240 \change_deleted -584632292 1615846694
14241 \begin_inset Flex Code
14244 \begin_layout Plain Layout
14251 \begin_inset Flex Code
14254 \begin_layout Plain Layout
14263 \begin_inset space \thinspace{}
14267 \begin_inset Flex Code
14270 \begin_layout Plain Layout
14276 ] If this is set to 1,
14277 the argument will output its content in the corresponding item in the table of contents.
14281 \begin_layout Standard
14283 \change_deleted -584632292 1615846694
14285 the text entered in the \SpecialChar LyX
14286 workarea in the respective layout is the last (mandatory) argument of a command if the
14287 \begin_inset Flex Code
14290 \begin_layout Plain Layout
14297 \begin_inset Flex Code
14300 \begin_layout Plain Layout
14308 arguments with the prefix
14309 \begin_inset Flex Code
14312 \begin_layout Plain Layout
14318 are output after this workarea argument.
14319 Note that post-argument numbering restarts at 1,
14320 so the first argument following the workarea argument is
14321 \begin_inset Flex Code
14324 \begin_layout Plain Layout
14331 Post-arguments are ignored in any other
14332 \begin_inset Flex Code
14335 \begin_layout Plain Layout
14342 \begin_inset Flex Code
14345 \begin_layout Plain Layout
14354 \begin_layout Standard
14356 \change_deleted -584632292 1615846694
14358 \begin_inset Flex Code
14361 \begin_layout Plain Layout
14370 \begin_inset Flex Code
14373 \begin_layout Plain Layout
14382 \begin_inset Flex Code
14385 \begin_layout Plain Layout
14391 followed by the number (e.
14392 \begin_inset space \thinspace{}
14396 \begin_inset space \space{}
14400 \begin_inset Flex Code
14403 \begin_layout Plain Layout
14412 \begin_layout Standard
14414 \change_deleted -584632292 1615846694
14416 there is a special argument type with the prefix
14417 \begin_inset Flex Code
14420 \begin_layout Plain Layout
14422 \change_inserted -712698321 1534487844
14431 It is not really an argument,
14432 but uses the argument interface (thus,
14433 the prefix is also followed by a number,
14435 \begin_inset space \thinspace{}
14440 \begin_inset Flex Code
14443 \begin_layout Plain Layout
14445 \change_inserted -712698321 1534488412
14446 Argument listpreamble:1
14454 As the name implies,
14455 it is targeted at lists such as
14475 Its content will be output at the list start,
14477 \begin_inset Flex Code
14480 \begin_layout Plain Layout
14482 \change_inserted -712698321 1534488058
14493 on an own line (a place that is otherwise not accessible in \SpecialChar LyX
14496 users can insert redefinitions (of lengths etc.) to individual lists.
14498 these arguments do not have a delimiter.
14504 \begin_layout Description
14505 \begin_inset Flex Code
14508 \begin_layout Plain Layout
14514 Includes a comma-separated list of layouts that should be nested in and after the current layout.
14515 Only makes sense for nestable layouts (such as environments).
14517 \begin_inset Quotes eld
14521 \begin_inset Flex Code
14524 \begin_layout Plain Layout
14531 \begin_inset Quotes erd
14536 \begin_inset Flex Code
14539 \begin_layout Plain Layout
14548 \begin_layout Description
14549 \begin_inset Flex Code
14552 \begin_layout Plain Layout
14558 Note that this will completely override any prior
14559 \begin_inset Flex Code
14562 \begin_layout Plain Layout
14568 declaration for this style.
14570 \begin_inset Quotes eld
14574 \begin_inset Flex Code
14577 \begin_layout Plain Layout
14584 \begin_inset Quotes erd
14589 \begin_inset CommandInset ref
14591 reference "subsec:I18n"
14596 for details on its use.
14599 \begin_layout Description
14600 \begin_inset Flex Code
14603 \begin_layout Plain Layout
14610 \begin_inset Flex Code
14613 \begin_layout Plain Layout
14623 \begin_layout Plain Layout
14624 Note that a `float' here is a real number,
14631 The vertical space with which the last of a chain of paragraphs with this style is separated from the following paragraph.
14632 If the next paragraph has another style,
14633 the separations are not simply added,
14634 but the maximum is taken.
14637 \begin_layout Description
14638 \begin_inset Flex Code
14641 \begin_layout Plain Layout
14648 \begin_inset Flex Code
14651 \begin_layout Plain Layout
14657 ] The category for this style.
14658 This is used to group related styles in the style combobox on the toolbar.
14659 Any string can be used,
14660 but you may want to use existing categories with your own styles.
14664 \begin_layout Description
14666 \change_deleted 1075283030 1672014981
14667 \begin_inset Flex Code
14670 \begin_layout Plain Layout
14676 Depth of XML command.
14677 Used only with XML-type formats.
14680 \begin_layout Description
14681 \begin_inset Flex Code
14684 \begin_layout Plain Layout
14691 \begin_inset Flex Code
14694 \begin_layout Plain Layout
14700 ] Copies all the features of an existing style into the current one.
14701 \change_inserted 1075283030 1671679774
14705 \begin_layout Description
14707 \change_inserted 1075283030 1672014806
14708 \begin_inset Flex Code
14711 \begin_layout Plain Layout
14713 \change_inserted 1075283030 1671679781
14714 DocBookGenerateTitle
14722 \begin_inset Flex Code
14725 \begin_layout Plain Layout
14727 \change_inserted 1075283030 1672014763
14736 \begin_inset Flex Code
14739 \begin_layout Plain Layout
14741 \change_inserted 1075283030 1672014789
14749 tag after the wrapper tag.
14750 This parameter should only be used with
14751 \begin_inset Flex Code
14754 \begin_layout Plain Layout
14756 \change_inserted 1075283030 1671679828
14765 otherwise the title will be output
14769 the contents of the environment.
14770 The generated title is the same as the LyXHTML label:
14771 a combination of the environment type and its number.
14772 A major use is when DocBook has no close mapping for LaTeX environments and users must fallback to using a generic container such as
14773 \begin_inset Flex Code
14776 \begin_layout Plain Layout
14778 \change_inserted 1075283030 1672014801
14787 which requires a title although there is none in LaTeX.
14788 This feature is heavily used for theorem-like environments.
14793 \begin_layout Description
14794 \begin_inset Flex Code
14797 \begin_layout Plain Layout
14804 \begin_inset Flex Code
14807 \begin_layout Plain Layout
14813 ] The name of a style whose preamble should be output
14818 This allows to ensure some ordering of the preamble snippets when macros definitions depend on one another.
14822 \begin_layout Plain Layout
14824 besides that functionality,
14825 there is no way to ensure any ordering of preambles.
14826 The ordering that you see in a given version of \SpecialChar LyX
14827 may change without warning in later versions.
14835 \begin_layout Description
14836 \begin_inset Flex Code
14839 \begin_layout Plain Layout
14846 \begin_inset Flex Code
14849 \begin_layout Plain Layout
14862 ] The type of label that stands at the end of the paragraph (or sequence of paragraphs if
14863 \begin_inset Flex Code
14866 \begin_layout Plain Layout
14873 \begin_inset Newline newline
14877 \begin_inset Flex Code
14880 \begin_layout Plain Layout
14888 \begin_inset Flex Code
14891 \begin_layout Plain Layout
14898 \begin_inset Flex Code
14901 \begin_layout Plain Layout
14909 \begin_inset Flex Code
14912 \begin_layout Plain Layout
14919 \begin_inset Quotes eld
14923 \begin_inset Quotes erd
14928 \begin_inset Flex Code
14931 \begin_layout Plain Layout
14938 \begin_inset space \space{}
14942 \begin_inset Flex Code
14945 \begin_layout Plain Layout
14951 ) is a white (resp.
14952 \begin_inset space ~
14955 black) square suitable for end of proof markers,
14957 \begin_inset Flex Code
14960 \begin_layout Plain Layout
14966 is an explicit text string.
14969 \begin_layout Description
14970 \begin_inset Flex Code
14973 \begin_layout Plain Layout
14980 \begin_inset Flex Code
14983 \begin_layout Plain Layout
14989 ] The string used for a label with a
14990 \begin_inset Flex Code
14993 \begin_layout Plain Layout
15000 \begin_inset Newline newline
15004 \begin_inset Flex Code
15007 \begin_layout Plain Layout
15017 \begin_layout Description
15018 \begin_inset Flex Code
15021 \begin_layout Plain Layout
15027 The font used for both the text body
15033 \begin_inset CommandInset ref
15035 reference "subsec:Font-description"
15041 Note that defining this font automatically defines the
15042 \begin_inset Flex Code
15045 \begin_layout Plain Layout
15052 So you should define this one first if you also want to define
15053 \begin_inset Flex Code
15056 \begin_layout Plain Layout
15065 \begin_layout Description
15066 \begin_inset Flex Code
15069 \begin_layout Plain Layout
15076 \begin_inset Flex Code
15079 \begin_layout Plain Layout
15085 ] Used for backporting new styles to stable \SpecialChar LyX
15087 The first stable version that supports this tag is \SpecialChar LyX
15089 The argument is a number which may either be 0,
15090 -1 or any value greater than zero.
15092 \begin_inset Flex Code
15095 \begin_layout Plain Layout
15101 flag of a style is greater than zero,
15102 it will always be written to the document header.
15103 If a .lyx file is read,
15104 the style definitions from the document header are added to the document class.
15105 Therefore even older \SpecialChar LyX
15106 versions can handle the style.
15108 \begin_inset Flex Code
15111 \begin_layout Plain Layout
15117 is a version number:
15118 if the style is read,
15119 and the version number is less than the version number of the already existing style in the document class,
15120 the new style is ignored.
15121 If the version number is greater,
15122 the new style replaces the existing style.
15123 A value of -1 means an infinite version number,
15125 \begin_inset space \thinspace{}
15129 \begin_inset space \space{}
15132 the style is always used.
15135 \begin_layout Description
15136 \begin_inset Flex Code
15139 \begin_layout Plain Layout
15146 \begin_inset Flex Code
15149 \begin_layout Plain Layout
15158 \begin_inset space \thinspace{}
15162 \begin_inset Flex Code
15165 \begin_layout Plain Layout
15171 ] Usually \SpecialChar LyX
15172 does not allow you to insert more than one space between words,
15173 since a space is considered as the separation between two words,
15174 not a character or symbol of its own.
15175 This is a very fine thing but sometimes annoying,
15177 when typing program code or plain \SpecialChar LaTeX
15181 \begin_inset Flex Code
15184 \begin_layout Plain Layout
15192 \change_deleted -495245474 1550490105
15197 \change_deleted 177693 1654669077
15199 \change_inserted 177693 1654669079
15203 \change_deleted 177693 1654669082
15205 \change_inserted 177693 1654669082
15208 for the additional blanks when
15209 \change_deleted 34634807 1619626461
15213 \change_inserted -495245474 1550490096
15215 \begin_inset Flex Code
15218 \begin_layout Plain Layout
15220 \change_inserted -495245474 1550490089
15229 \change_deleted -495245474 1550490116
15230 another mode than \SpecialChar LaTeX
15233 \change_inserted -495245474 1550247760
15235 \begin_inset Flex Code
15238 \begin_layout Plain Layout
15240 \change_inserted -495245474 1550247736
15249 \begin_inset Flex Code
15252 \begin_layout Plain Layout
15254 \change_inserted -495245474 1550247755
15267 \begin_layout Description
15268 \begin_inset Flex Code
15271 \begin_layout Plain Layout
15277 These tags are used with XHTML output.
15279 \begin_inset CommandInset ref
15281 reference "subsec:Paragraph-Style-XHTML"
15289 \begin_layout Description
15291 \change_deleted 1075283030 1672014684
15292 \begin_inset Flex Code
15295 \begin_layout Plain Layout
15301 [FIXME] (Used only with XML-type formats.)
15306 \begin_layout Description
15307 \begin_inset Flex Code
15310 \begin_layout Plain Layout
15317 \begin_inset Flex Code
15320 \begin_layout Plain Layout
15329 \begin_inset space \thinspace{}
15333 \begin_inset Flex Code
15336 \begin_layout Plain Layout
15343 \begin_inset Flex Code
15346 \begin_layout Plain Layout
15353 marks the style as to be included in the document preamble and not in the document body.
15354 This is useful for document classes that want such information as the title and author to appear in the preamble.
15355 Note that this works only for styles for which the
15356 \begin_inset Flex Code
15359 \begin_layout Plain Layout
15366 \begin_inset Flex Code
15369 \begin_layout Plain Layout
15376 \begin_inset Flex Code
15379 \begin_layout Plain Layout
15388 \begin_layout Description
15389 \begin_inset Flex Code
15392 \begin_layout Plain Layout
15399 \begin_inset Flex Code
15402 \begin_layout Plain Layout
15411 \begin_inset space \thinspace{}
15415 \begin_inset Flex Code
15418 \begin_layout Plain Layout
15425 \begin_inset Flex Code
15428 \begin_layout Plain Layout
15435 marks the style as being part of a title block (see also the
15436 \begin_inset Flex Code
15439 \begin_layout Plain Layout
15446 \begin_inset Flex Code
15449 \begin_layout Plain Layout
15458 \begin_layout Description
15459 \begin_inset Flex Code
15462 \begin_layout Plain Layout
15468 Includes a comma-separated list of layouts after which this one should be nested.
15469 Only makes sense with regard to nestable layouts (such as environments).
15471 \begin_inset Quotes eld
15475 \begin_inset Flex Code
15478 \begin_layout Plain Layout
15485 \begin_inset Quotes erd
15490 \begin_inset Flex Code
15493 \begin_layout Plain Layout
15502 \begin_layout Description
15503 \begin_inset Flex Code
15506 \begin_layout Plain Layout
15513 \begin_inset Flex Code
15516 \begin_layout Plain Layout
15525 \begin_inset space \thinspace{}
15529 \begin_inset Flex Code
15532 \begin_layout Plain Layout
15538 ] If this is set to 1 and AddToToc is enabled,
15539 the paragraph adds a summary of its contents in its item in the table of contents.
15546 \begin_layout Description
15547 \begin_inset Flex Code
15550 \begin_layout Plain Layout
15557 \begin_inset Flex Code
15560 \begin_layout Plain Layout
15566 ] The \SpecialChar LaTeX
15567 command sequence declaring an item in a list.
15568 The command is to be defined without the preceding backslash (the default is
15569 \begin_inset Quotes eld
15573 \begin_inset Quotes erd
15578 \begin_inset Flex Code
15581 \begin_layout Plain Layout
15589 in the \SpecialChar LaTeX
15593 \begin_layout Description
15594 \begin_inset Flex Code
15597 \begin_layout Plain Layout
15604 \begin_inset Flex Code
15607 \begin_layout Plain Layout
15613 ] This provides extra space between paragraphs that have the same style.
15614 If you put other styles into an environment,
15615 each is separated with the environment's
15616 \begin_inset Flex Code
15619 \begin_layout Plain Layout
15626 But the whole items of the environment are additionally separated with this
15627 \begin_inset Flex Code
15630 \begin_layout Plain Layout
15637 Note that this is a
15642 \begin_layout Description
15644 \change_deleted 1075283030 1672014680
15645 \begin_inset Flex Code
15648 \begin_layout Plain Layout
15654 [FIXME] (Used only with XML-type formats.)
15659 \begin_layout Description
15660 \begin_inset Flex Code
15663 \begin_layout Plain Layout
15670 \begin_inset Flex Code
15673 \begin_layout Plain Layout
15682 \begin_inset space \thinspace{}
15686 \begin_inset Flex Code
15689 \begin_layout Plain Layout
15695 ] Usually \SpecialChar LyX
15696 does not allow you to leave a paragraph empty,
15697 since it would lead to empty \SpecialChar LaTeX
15699 There are some cases where this could be desirable however:
15700 in a letter template,
15701 the required fields can be provided as empty fields,
15702 so that people do not forget them;
15703 in some special classes,
15704 a style can be used as some kind of break,
15705 which does not contain actual text.
15708 \begin_layout Description
15709 \begin_inset Flex Code
15712 \begin_layout Plain Layout
15719 \begin_inset Flex Code
15722 \begin_layout Plain Layout
15728 ] The vertical space between the label and the text body.
15729 Only used for labels that are above the text body (
15730 \begin_inset Flex Code
15733 \begin_layout Plain Layout
15740 \begin_inset Newline newline
15744 \begin_inset Flex Code
15747 \begin_layout Plain Layout
15748 Centered_Top_Environment
15756 \begin_layout Description
15757 \begin_inset Flex Code
15760 \begin_layout Plain Layout
15767 \begin_inset Flex Code
15770 \begin_layout Plain Layout
15776 ] The name of the counter for automatic numbering.
15777 In order to have the counter appear with your label,
15778 you will need to reference it in the
15779 \begin_inset Flex Code
15782 \begin_layout Plain Layout
15791 This will work with
15792 \begin_inset Flex Code
15795 \begin_layout Plain Layout
15803 \begin_inset Flex Code
15806 \begin_layout Plain Layout
15814 \begin_inset Flex Code
15817 \begin_layout Plain Layout
15824 \begin_inset Flex Code
15827 \begin_layout Plain Layout
15835 \begin_inset Newline newline
15843 \begin_inset Flex Code
15846 \begin_layout Plain Layout
15853 \begin_inset Flex Code
15856 \begin_layout Plain Layout
15863 though this case is a bit complicated.
15864 Suppose you declare
15865 \begin_inset Quotes eld
15869 \begin_inset Flex Code
15872 \begin_layout Plain Layout
15873 LabelCounter myenum
15879 \begin_inset Quotes erd
15883 Then the actual counters used are
15884 \begin_inset Flex Code
15887 \begin_layout Plain Layout
15895 \begin_inset Flex Code
15898 \begin_layout Plain Layout
15906 \begin_inset Flex Code
15909 \begin_layout Plain Layout
15916 \begin_inset Flex Code
15919 \begin_layout Plain Layout
15926 much as in \SpecialChar LaTeX
15928 These counters must all be declared separately.
15929 \begin_inset Newline newline
15933 \begin_inset CommandInset ref
15935 reference "subsec:Counters"
15940 for details on counters.
15943 \begin_layout Description
15944 \begin_inset Flex Code
15947 \begin_layout Plain Layout
15953 The font used for the label.
15955 \begin_inset CommandInset ref
15957 reference "subsec:Font-description"
15965 \begin_layout Description
15966 \begin_inset Flex Code
15969 \begin_layout Plain Layout
15976 \begin_inset Flex Code
15979 \begin_layout Plain Layout
15985 ] Text that indicates how far a label should be indented.
15988 \begin_layout Description
15989 \begin_inset Flex Code
15992 \begin_layout Plain Layout
15999 \begin_inset Flex Code
16002 \begin_layout Plain Layout
16008 ] Text that indicates the amount of horizontal space between the label and the text body.
16009 Only used for labels that are not above the text body.
16012 \begin_layout Description
16013 \begin_inset Flex Code
16016 \begin_layout Plain Layout
16023 \begin_inset Flex Code
16026 \begin_layout Plain Layout
16032 ] The string used for the label.
16034 \begin_inset Flex Code
16037 \begin_layout Plain Layout
16044 this string can be contain the special formatting commands described in
16045 \begin_inset CommandInset ref
16047 reference "subsec:Counters"
16055 \begin_layout Description
16056 \begin_inset Flex Code
16059 \begin_layout Plain Layout
16060 LabelStringAppendix
16066 \begin_inset Flex Code
16069 \begin_layout Plain Layout
16075 ] This is used inside the appendix instead of
16076 \begin_inset Newline newline
16080 \begin_inset Flex Code
16083 \begin_layout Plain Layout
16091 \begin_inset Flex Code
16094 \begin_layout Plain Layout
16101 \begin_inset Newline newline
16105 \begin_inset Flex Code
16108 \begin_layout Plain Layout
16109 LabelStringAppendix
16115 \change_deleted 1075283030 1672015070
16119 \begin_layout Description
16121 \change_deleted 1075283030 1672015070
16122 \begin_inset Flex Code
16125 \begin_layout Plain Layout
16131 [FIXME] (Used only with XML-type formats.)
16136 \begin_layout Description
16137 \begin_inset Flex Code
16140 \begin_layout Plain Layout
16147 \begin_inset Flex Code
16150 \begin_layout Plain Layout
16160 \begin_inset Newline newline
16166 \begin_inset Newline newline
16179 \begin_layout Description
16180 \begin_inset Flex Code
16183 \begin_layout Plain Layout
16189 means the label is the very first word (up to the first real blank).
16191 \change_deleted 177693 1654669087
16193 \change_inserted 177693 1654669089
16196 spaces if you want more than one word as the label.
16200 \begin_layout Description
16201 \begin_inset Flex Code
16204 \begin_layout Plain Layout
16210 means the label is simply what is declared as
16211 \begin_inset Flex Code
16214 \begin_layout Plain Layout
16221 This will be displayed
16222 \begin_inset Quotes eld
16226 \begin_inset Quotes erd
16230 at the beginning of the paragraph.
16232 \begin_inset Flex Code
16235 \begin_layout Plain Layout
16242 \begin_inset Flex Code
16245 \begin_layout Plain Layout
16252 then it will be displayed only in the first paragraph of any sequence of paragraphs with the same
16253 \begin_inset Flex Code
16256 \begin_layout Plain Layout
16265 \begin_layout Description
16266 \begin_inset Flex Code
16269 \begin_layout Plain Layout
16276 \begin_inset space ~
16280 \begin_inset space ~
16284 \begin_inset Flex Code
16287 \begin_layout Plain Layout
16293 are special cases of
16294 \begin_inset Flex Code
16297 \begin_layout Plain Layout
16304 The label will be printed above the paragraph either at the beginning of the line or centered.
16307 \begin_layout Description
16308 \begin_inset Flex Code
16311 \begin_layout Plain Layout
16317 is a special case for the caption-labels
16318 \begin_inset Quotes eld
16322 \begin_inset Quotes erd
16326 \begin_inset Quotes eld
16330 \begin_inset Quotes erd
16334 \begin_inset Newline newline
16338 \begin_inset Flex Code
16341 \begin_layout Plain Layout
16347 means the (hardcoded) label string depends on the kind of float:
16348 It is hardcoded to be `FloatType N',
16349 where N is the value of the counter associated with the float.
16350 For the case that a caption is inserted outside of a float the
16351 \begin_inset Flex Code
16354 \begin_layout Plain Layout
16361 \begin_inset Quotes eld
16365 \begin_inset Quotes erd
16371 \begin_layout Description
16372 \begin_inset Flex Code
16375 \begin_layout Plain Layout
16381 produces the usual sort of enumeration labels.
16382 The number type needs to be set in the
16388 \begin_inset CommandInset ref
16390 reference "subsec:Counters"
16398 \begin_layout Description
16399 \begin_inset Flex Code
16402 \begin_layout Plain Layout
16408 produces various bullets at the different levels.
16409 The bullet types displayed can be set via
16410 \begin_inset Flex Noun
16413 \begin_layout Plain Layout
16414 Document\SpecialChar menuseparator
16415 Settings\SpecialChar menuseparator
16424 \begin_layout Description
16425 \begin_inset Flex Code
16428 \begin_layout Plain Layout
16434 should be used only with
16435 \begin_inset Flex Code
16438 \begin_layout Plain Layout
16439 LatexType BibEnvironment
16448 \begin_layout Description
16449 \begin_inset Flex Code
16452 \begin_layout Plain Layout
16458 Note that this will completely override any prior
16459 \begin_inset Flex Code
16462 \begin_layout Plain Layout
16468 declaration for this style.
16470 \begin_inset Quotes eld
16474 \begin_inset Flex Code
16477 \begin_layout Plain Layout
16484 \begin_inset Quotes erd
16489 \begin_inset CommandInset ref
16491 reference "subsec:I18n"
16496 for details on its use.
16499 \begin_layout Description
16500 \begin_inset Flex Code
16503 \begin_layout Plain Layout
16510 \begin_inset Flex Code
16513 \begin_layout Plain Layout
16519 ] The name of the corresponding \SpecialChar LaTeX
16521 Either the environment or command name.
16524 \begin_layout Description
16525 \begin_inset Flex Code
16528 \begin_layout Plain Layout
16535 \begin_inset Flex Code
16538 \begin_layout Plain Layout
16544 ] An optional parameter for the corresponding
16545 \begin_inset Flex Code
16548 \begin_layout Plain Layout
16555 This parameter cannot be changed from within \SpecialChar LyX
16557 \begin_inset Flex Code
16560 \begin_layout Plain Layout
16566 for customizable parameters).
16567 This will be output as is after all \SpecialChar LaTeX
16569 \begin_inset Flex Code
16572 \begin_layout Plain Layout
16581 \begin_layout Description
16582 \begin_inset Flex Code
16585 \begin_layout Plain Layout
16592 \begin_inset Flex Code
16595 \begin_layout Plain Layout
16604 \begin_inset Newline newline
16613 ] How the style should be translated into \SpecialChar LaTeX
16618 \begin_layout Plain Layout
16619 \begin_inset Flex Code
16622 \begin_layout Plain Layout
16628 is perhaps a bit misleading,
16629 since these rules apply to SGML classes,
16631 Visit the SGML class files for specific examples.
16640 \begin_layout Description
16641 \begin_inset Flex Code
16644 \begin_layout Plain Layout
16650 means nothing special.
16653 \begin_layout Description
16654 \begin_inset Flex Code
16657 \begin_layout Plain Layout
16664 \begin_inset Flex Code
16667 \begin_layout Plain Layout
16674 {\SpecialChar ldots
16683 \begin_layout Description
16684 \begin_inset Flex Code
16687 \begin_layout Plain Layout
16694 \begin_inset Flex Code
16697 \begin_layout Plain Layout
16704 }\SpecialChar ldots
16720 \begin_layout Description
16721 \begin_inset Flex Code
16724 \begin_layout Plain Layout
16731 \begin_inset Flex Code
16734 \begin_layout Plain Layout
16742 \begin_inset Flex Code
16745 \begin_layout Plain Layout
16753 is generated for each paragraph of this environment.
16757 \begin_layout Description
16758 \begin_inset Flex Code
16761 \begin_layout Plain Layout
16768 \begin_inset Flex Code
16771 \begin_layout Plain Layout
16779 \begin_inset Newline newline
16783 \begin_inset Flex Code
16786 \begin_layout Plain Layout
16792 is passed as an argument to the environment.
16793 \begin_inset Newline newline
16797 \begin_inset Flex Code
16800 \begin_layout Plain Layout
16806 can be defined in the
16807 \begin_inset Flex Noun
16810 \begin_layout Plain Layout
16811 Edit\SpecialChar menuseparator
16813 \begin_inset space ~
16824 \begin_layout Description
16825 \begin_inset Flex Code
16828 \begin_layout Plain Layout
16835 \begin_inset Flex Code
16838 \begin_layout Plain Layout
16844 but adds the necessary mandatory argument (the longest label) to the begin statement of the bibliography environment:
16845 \begin_inset Newline newline
16849 \begin_inset Flex Code
16852 \begin_layout Plain Layout
16855 begin{thebibliography}{99}
16861 It is therefore only useful for bibliography environments.
16862 The default longest label
16863 \begin_inset Quotes eld
16867 \begin_inset Quotes erd
16870 can be changed by the user in the paragraph settings of a bibliography item.
16873 \begin_layout Standard
16874 Putting the last few things together,
16875 the \SpecialChar LaTeX
16876 output will be either:
16880 \begin_layout LyX-Code
16883 LatexName[LatexParam]{\SpecialChar ldots
16887 \begin_layout Standard
16892 \begin_layout LyX-Code
16895 begin{LatexName}[LatexParam] \SpecialChar ldots
16901 \begin_layout Standard
16902 depending upon the \SpecialChar LaTeX
16907 \begin_layout Description
16908 \begin_inset Flex Code
16911 \begin_layout Plain Layout
16918 \begin_inset Flex Code
16921 \begin_layout Plain Layout
16927 ] A string that is put at the beginning of the style content.
16928 A line break in the output can be indicated by
16929 \begin_inset Flex Code
16932 \begin_layout Plain Layout
16941 \begin_layout Description
16942 \begin_inset Flex Code
16945 \begin_layout Plain Layout
16952 \begin_inset Flex Code
16955 \begin_layout Plain Layout
16961 ] If you put styles into environments,
16963 \begin_inset Flex Code
16966 \begin_layout Plain Layout
16972 are not simply added,
16973 but added with a factor
16974 \begin_inset Formula $\frac{4}{\mathrm{depth}+4}$
16978 Note that this parameter is also used when
16979 \begin_inset Flex Code
16982 \begin_layout Plain Layout
16989 \begin_inset Flex Code
16992 \begin_layout Plain Layout
16999 \begin_inset Flex Code
17002 \begin_layout Plain Layout
17009 Then it is added to the manual or dynamic margin.
17010 \begin_inset Newline newline
17014 \begin_inset Quotes eld
17018 \begin_inset Flex Code
17021 \begin_layout Plain Layout
17028 \begin_inset Quotes erd
17031 means that the paragraph is indented with the width of
17032 \begin_inset Quotes eld
17036 \begin_inset Flex Code
17039 \begin_layout Plain Layout
17046 \begin_inset Quotes erd
17049 in the normal font.
17050 You can get a negative width by prefixing the string with
17051 \begin_inset Quotes eld
17055 \begin_inset Flex Code
17058 \begin_layout Plain Layout
17065 \begin_inset Quotes erd
17069 This way was chosen so that the look is the same with each used screen font.
17072 \begin_layout Description
17073 \begin_inset Flex Code
17076 \begin_layout Plain Layout
17083 \begin_inset Flex Code
17086 \begin_layout Plain Layout
17101 \begin_inset Newline newline
17104 The kind of margin that the style has on the left side.
17108 \begin_layout Description
17109 \begin_inset Flex Code
17112 \begin_layout Plain Layout
17118 just means a fixed margin.
17121 \begin_layout Description
17122 \begin_inset Flex Code
17125 \begin_layout Plain Layout
17131 means that the left margin depends on the string entered in the
17132 \begin_inset Flex Noun
17135 \begin_layout Plain Layout
17136 Edit\SpecialChar menuseparator
17138 \begin_inset space ~
17147 This is used to typeset nice lists without tabulators.
17150 \begin_layout Description
17151 \begin_inset Flex Code
17154 \begin_layout Plain Layout
17160 means that the margin depends on the size of the label.
17161 This is used for automatic enumerated headlines.
17162 It is obvious that the headline
17163 \begin_inset Quotes eld
17166 5.4.3.2.1 Very long headline
17167 \begin_inset Quotes erd
17170 must have a wider left margin (as wide as
17171 \begin_inset Quotes eld
17175 \begin_inset Quotes erd
17178 plus the space) than
17179 \begin_inset Quotes eld
17182 3.2 Very long headline
17183 \begin_inset Quotes erd
17188 \begin_inset Quotes eld
17192 \begin_inset Quotes erd
17195 are not able to do this.
17198 \begin_layout Description
17199 \begin_inset Flex Code
17202 \begin_layout Plain Layout
17209 but only the very first row of the paragraph is dynamic,
17210 while the others are static;
17216 \begin_layout Description
17217 \begin_inset Flex Code
17220 \begin_layout Plain Layout
17226 means the margin is chosen in a way that the longest row of this paragraph fits to the right margin.
17227 This is used to typeset an address on the right edge of the page.
17231 \begin_layout Description
17232 \begin_inset Flex Code
17235 \begin_layout Plain Layout
17242 \begin_inset Flex Code
17245 \begin_layout Plain Layout
17254 \begin_inset space \thinspace{}
17258 \begin_inset Flex Code
17261 \begin_layout Plain Layout
17267 ] Whether fragile commands in this style should be
17268 \begin_inset Flex Code
17271 \begin_layout Plain Layout
17285 whether this command should itself be protected.)
17286 \change_inserted -712698321 1523696949
17290 \begin_layout Description
17292 \change_inserted -712698321 1552395557
17293 \begin_inset Flex Code
17296 \begin_layout Plain Layout
17298 \change_inserted -712698321 1523696950
17307 \begin_inset Flex Code
17310 \begin_layout Plain Layout
17312 \change_inserted -712698321 1523696950
17323 \begin_inset space \thinspace{}
17327 \begin_inset Flex Code
17330 \begin_layout Plain Layout
17332 \change_inserted -712698321 1523696950
17340 ] This causes macros that contain this layout to be protected with
17341 \begin_inset Flex Code
17344 \begin_layout Plain Layout
17346 \change_inserted -712698321 1523696950
17361 ) if necessary and thus allows (some) verbatim stuff in macros.
17364 \begin_layout Description
17366 \change_inserted -712698321 1552395844
17367 \begin_inset Flex Code
17370 \begin_layout Plain Layout
17372 \change_inserted -712698321 1552395561
17381 \begin_inset Flex Code
17384 \begin_layout Plain Layout
17386 \change_inserted -712698321 1552395557
17397 \begin_inset space \thinspace{}
17401 \begin_inset Flex Code
17404 \begin_layout Plain Layout
17406 \change_inserted -712698321 1552395557
17414 ] Whether specific commands in this style (such as
17415 \begin_inset Flex Code
17418 \begin_layout Plain Layout
17420 \change_inserted -712698321 1552395655
17431 \begin_inset Flex Code
17434 \begin_layout Plain Layout
17436 \change_inserted -712698321 1552395661
17446 ) should be protected in an
17447 \begin_inset Flex Code
17450 \begin_layout Plain Layout
17452 \change_inserted -712698321 1552395631
17463 This is particularly needed for styles that draw on
17471 commands which parse their content in complex ways.
17476 \begin_layout Description
17477 \begin_inset Flex Code
17480 \begin_layout Plain Layout
17487 \begin_inset Flex Code
17490 \begin_layout Plain Layout
17497 \begin_inset space \thinspace{}
17501 \begin_inset Flex Code
17504 \begin_layout Plain Layout
17512 ] Whether newlines are translated into \SpecialChar LaTeX
17514 \begin_inset Flex Code
17517 \begin_layout Plain Layout
17528 The translation can be switched off to allow more comfortable \SpecialChar LaTeX
17529 editing inside \SpecialChar LyX
17533 \begin_layout Description
17534 \begin_inset Flex Code
17537 \begin_layout Plain Layout
17544 \begin_inset Flex Code
17547 \begin_layout Plain Layout
17556 \begin_inset space \thinspace{}
17560 \begin_inset Flex Code
17563 \begin_layout Plain Layout
17571 \begin_inset Flex Code
17574 \begin_layout Plain Layout
17581 \begin_inset Flex Code
17584 \begin_layout Plain Layout
17590 ) paragraphs are being indented,
17591 then the indentation of such a paragraph following one of this type will be suppressed.
17592 (So this will not affect the display of non-default paragraphs.)
17595 \begin_layout Description
17596 \begin_inset Flex Code
17599 \begin_layout Plain Layout
17606 \begin_inset Flex Code
17609 \begin_layout Plain Layout
17615 ] Name of a style that has replaced this style.
17616 This is used to rename a style,
17617 while keeping backward compatibility.
17620 \begin_layout Description
17621 \begin_inset Flex Code
17624 \begin_layout Plain Layout
17631 \begin_inset Flex Code
17634 \begin_layout Plain Layout
17641 \begin_inset space \thinspace{}
17645 \begin_inset Flex Code
17648 \begin_layout Plain Layout
17654 ] Determines whether consecutive paragraphs of the same type are treated as belonging together.
17655 This has the effect that the
17656 \begin_inset Flex Code
17659 \begin_layout Plain Layout
17665 is only printed once before such a group.
17668 \begin_inset Flex Code
17671 \begin_layout Plain Layout
17678 \begin_inset Flex Code
17681 \begin_layout Plain Layout
17688 \begin_inset Flex Code
17691 \begin_layout Plain Layout
17697 and false for all other types.
17700 \begin_layout Description
17701 \begin_inset Flex Code
17704 \begin_layout Plain Layout
17711 \begin_inset Flex Code
17714 \begin_layout Plain Layout
17723 \begin_inset space \thinspace{}
17727 \begin_inset Flex Code
17730 \begin_layout Plain Layout
17736 ] Indicates that paragraphs will not be separated by an empty line in \SpecialChar LaTeX
17738 but only by a line break;
17740 \begin_inset Flex Code
17743 \begin_layout Plain Layout
17750 this allows to emulate a plain text editor (like the ERT inset).
17753 \begin_layout Description
17754 \begin_inset Flex Code
17757 \begin_layout Plain Layout
17764 \begin_inset Flex Code
17767 \begin_layout Plain Layout
17773 ] The indent of the very first line of a paragraph.
17775 \begin_inset Newline newline
17779 \begin_inset Flex Code
17782 \begin_layout Plain Layout
17788 will be fixed for a certain style.
17789 The exception is the default style,
17790 since the indentation for these paragraphs can be prohibited with
17791 \begin_inset Flex Code
17794 \begin_layout Plain Layout
17803 \begin_inset Flex Code
17806 \begin_layout Plain Layout
17812 style paragraphs inside environments use the
17813 \begin_inset Flex Code
17816 \begin_layout Plain Layout
17822 of the environment,
17823 not their native one.
17826 \begin_inset Flex Code
17829 \begin_layout Plain Layout
17835 paragraphs inside an enumeration are not indented.
17838 \begin_layout Description
17839 \begin_inset Flex Code
17842 \begin_layout Plain Layout
17849 \begin_inset Flex Code
17852 \begin_layout Plain Layout
17858 ] The vertical space between two paragraphs of this style.
17861 \begin_layout Description
17862 \begin_inset Flex Code
17865 \begin_layout Plain Layout
17872 \begin_inset Flex Code
17875 \begin_layout Plain Layout
17882 allows the user to choose either
17883 \begin_inset Quotes eld
17887 \begin_inset Quotes erd
17891 \begin_inset Quotes eld
17895 \begin_inset Quotes erd
17898 to separate paragraphs.
17900 \begin_inset Quotes eld
17904 \begin_inset Quotes erd
17909 \begin_inset Flex Code
17912 \begin_layout Plain Layout
17920 \begin_inset Quotes eld
17924 \begin_inset Quotes erd
17929 \begin_inset Flex Code
17932 \begin_layout Plain Layout
17938 is ignored and all paragraphs are separated by the
17939 \begin_inset Flex Code
17942 \begin_layout Plain Layout
17949 The vertical space is calculated with
17950 \begin_inset Flex Code
17953 \begin_layout Plain Layout
17955 \begin_inset space ~
17964 \begin_inset Flex Code
17967 \begin_layout Plain Layout
17973 is the height of a row with the normal font.
17975 the look stays the same with different screen fonts.
17978 \begin_layout Description
17979 \begin_inset Flex Code
17982 \begin_layout Plain Layout
17989 \begin_inset Flex Code
17992 \begin_layout Plain Layout
18001 \begin_inset space \thinspace{}
18005 \begin_inset Flex Code
18008 \begin_layout Plain Layout
18014 ] Whether the contents of this paragraph should be output in raw form,
18015 meaning without special translations that \SpecialChar LaTeX
18019 \begin_layout Description
18020 \begin_inset Flex Code
18023 \begin_layout Plain Layout
18030 \begin_inset Flex Code
18033 \begin_layout Plain Layout
18043 Defines individual characters that should be output in raw form,
18044 meaning without special translations that \SpecialChar LaTeX
18048 \begin_layout Description
18049 \begin_inset Flex Code
18052 \begin_layout Plain Layout
18058 Information to be included in the \SpecialChar LaTeX
18059 preamble when this style is used.
18060 Used to define macros,
18063 required by this particular style.
18065 \begin_inset Quotes eld
18069 \begin_inset Flex Code
18072 \begin_layout Plain Layout
18079 \begin_inset Quotes erd
18085 \begin_layout Description
18086 \begin_inset Flex Code
18089 \begin_layout Plain Layout
18096 \begin_inset Flex Code
18099 \begin_layout Plain Layout
18105 ] The prefix to use when creating labels referring to paragraphs of this type.
18106 This allows the use of formatted references.
18109 \begin_layout Description
18110 \begin_inset Flex Code
18113 \begin_layout Plain Layout
18120 \begin_inset Flex Code
18123 \begin_layout Plain Layout
18129 ] Whether the style requires the feature
18130 \begin_inset Flex Code
18133 \begin_layout Plain Layout
18140 \begin_inset CommandInset ref
18142 reference "chap:List-of-functions"
18147 for the list of features).
18148 If you require a package with specific options,
18149 you can additionally use
18150 \begin_inset Flex Code
18153 \begin_layout Plain Layout
18159 as a general text class parameter (see
18160 \begin_inset CommandInset ref
18162 reference "subsec:General-text-class"
18170 \begin_layout Description
18171 \begin_inset Flex Code
18174 \begin_layout Plain Layout
18181 \begin_inset Flex Code
18184 \begin_layout Plain Layout
18193 \begin_inset Flex Code
18196 \begin_layout Plain Layout
18202 ] Resets the \SpecialChar LaTeX
18203 arguments of this style (as defined via the
18204 \begin_inset Flex Code
18207 \begin_layout Plain Layout
18214 This is useful if you have copied a style via
18215 \begin_inset Flex Code
18218 \begin_layout Plain Layout
18225 but you do not want to inherit its (required and optional) arguments.
18228 \begin_layout Description
18229 \begin_inset Flex Code
18232 \begin_layout Plain Layout
18239 \begin_inset Flex Code
18242 \begin_layout Plain Layout
18251 \begin_inset Flex Code
18254 \begin_layout Plain Layout
18260 ] Resumes a counter that is usually reset at each new sequence of layouts.
18261 This is currently only useful when
18262 \begin_inset Flex Code
18265 \begin_layout Plain Layout
18272 \begin_inset Flex Code
18275 \begin_layout Plain Layout
18284 \begin_layout Description
18285 \begin_inset Flex Code
18288 \begin_layout Plain Layout
18295 \begin_inset Flex Code
18298 \begin_layout Plain Layout
18304 ] A string that is put at the end of the layout content.
18305 A line break in the output can be indicated by
18306 \begin_inset Flex Code
18309 \begin_layout Plain Layout
18318 \begin_layout Description
18319 \begin_inset Flex Code
18322 \begin_layout Plain Layout
18329 \begin_inset Flex Code
18332 \begin_layout Plain Layout
18339 \begin_inset Flex Code
18342 \begin_layout Plain Layout
18351 \begin_layout Description
18352 \begin_inset Flex Code
18355 \begin_layout Plain Layout
18362 \begin_inset Flex Code
18365 \begin_layout Plain Layout
18375 \begin_inset Flex Code
18378 \begin_layout Plain Layout
18386 \begin_inset Flex Code
18389 \begin_layout Plain Layout
18397 \begin_inset Flex Code
18400 \begin_layout Plain Layout
18402 \begin_inset space ~
18410 ] This defines what the default spacing should be in the style.
18412 \begin_inset Flex Code
18415 \begin_layout Plain Layout
18423 \begin_inset Flex Code
18426 \begin_layout Plain Layout
18433 \begin_inset Flex Code
18436 \begin_layout Plain Layout
18442 correspond respectively to a multiplier value of 1,
18444 If you specify the argument
18445 \begin_inset Flex Code
18448 \begin_layout Plain Layout
18455 then you must also provide a value argument which will be the actual multiplier value.
18457 contrary to other parameters,
18459 \begin_inset Flex Code
18462 \begin_layout Plain Layout
18468 implies the generation of specific \SpecialChar LaTeX
18470 using the \SpecialChar LaTeX
18474 \begin_inset Flex Code
18477 \begin_layout Plain Layout
18486 \begin_layout Description
18487 \begin_inset Flex Code
18490 \begin_layout Plain Layout
18497 \begin_inset Flex Code
18500 \begin_layout Plain Layout
18507 \begin_inset space \thinspace{}
18511 \begin_inset Flex Code
18514 \begin_layout Plain Layout
18522 ] Allow spell-checking paragraphs of this style.
18526 \begin_layout Description
18527 \begin_inset Flex Code
18530 \begin_layout Plain Layout
18532 \change_deleted 731793113 1604355211
18534 \change_inserted 731793113 1604355212
18543 \begin_inset Flex Code
18546 \begin_layout Plain Layout
18555 \begin_inset Flex Code
18558 \begin_layout Plain Layout
18565 \change_deleted 731793113 1604355214
18567 \change_inserted 731793113 1604355216
18570 counter of a given counter at the beginning of a new sequence of layouts.
18571 This is currently only useful when
18572 \begin_inset Flex Code
18575 \begin_layout Plain Layout
18582 \begin_inset Flex Code
18585 \begin_layout Plain Layout
18594 \begin_layout Description
18595 \begin_inset Flex Code
18598 \begin_layout Plain Layout
18604 The font used for the text body .
18606 \begin_inset CommandInset ref
18608 reference "subsec:Font-description"
18616 \begin_layout Description
18617 \begin_inset Flex Code
18620 \begin_layout Plain Layout
18629 \begin_inset Flex Code
18632 \begin_layout Plain Layout
18642 The level of the style in the table of contents.
18643 This is used for automatic numbering of section headings.
18646 \begin_layout Description
18647 \begin_inset Flex Code
18650 \begin_layout Plain Layout
18659 \begin_inset Flex Code
18662 \begin_layout Plain Layout
18674 \begin_inset Flex Code
18677 \begin_layout Plain Layout
18685 \begin_inset Flex Code
18688 \begin_layout Plain Layout
18694 ] This tag determines whether the first line indentation of this paragraph can be toggled via the Paragraph settings dialog.
18698 \begin_inset Flex Code
18701 \begin_layout Plain Layout
18712 indentation can be toggled if the document settings use
18713 \begin_inset Quotes eld
18717 \begin_inset Quotes erd
18722 \begin_inset Flex Code
18725 \begin_layout Plain Layout
18732 indentation can always be toggled,
18733 notwithstanding the document settings,
18735 \begin_inset Flex Code
18738 \begin_layout Plain Layout
18745 indentation can never be toggled.
18748 \begin_layout Description
18749 \begin_inset Flex Code
18752 \begin_layout Plain Layout
18759 \begin_inset Flex Code
18762 \begin_layout Plain Layout
18768 ] The vertical space with which the very first of a chain of paragraphs with this style is separated from the previous paragraph.
18769 If the previous paragraph has another style,
18770 the separations are not simply added,
18771 but the maximum is taken.
18774 \begin_layout Subsection
18775 \begin_inset CommandInset label
18781 Internationalization of Paragraph Styles
18784 \begin_layout Standard
18786 has long supported internationalization of layout information,
18789 this applied only to the user interface and not to,
18793 French authors were forced to resort to ugly hacks if they wanted `
18797 1' instead of `Theorem 1'.
18798 Thanks to Georg Baum,
18799 that is no longer the case.
18802 \begin_layout Standard
18804 \begin_inset Flex Code
18807 \begin_layout Plain Layout
18813 defines text that is to appear in the typeset document,
18815 \begin_inset Flex Code
18818 \begin_layout Plain Layout
18825 \begin_inset Flex Code
18828 \begin_layout Plain Layout
18834 to support non-English and even multi-language documents correctly.
18835 The following excerpt (from the
18836 \begin_inset Flex Code
18839 \begin_layout Plain Layout
18845 file) shows how this works:
18848 \begin_layout LyX-Code
18853 \begin_layout LyX-Code
18856 theoremstyle{remark}
18859 \begin_layout LyX-Code
18862 newtheorem{claim}[thm]{
18869 \begin_layout LyX-Code
18873 \begin_layout LyX-Code
18877 \begin_layout LyX-Code
18882 claimname}{_(Claim)}
18885 \begin_layout LyX-Code
18889 \begin_layout LyX-Code
18893 \begin_layout LyX-Code
18902 claimname}{_(Claim)}}
18905 \begin_layout LyX-Code
18910 \begin_layout Standard
18912 any legal \SpecialChar LaTeX
18914 \begin_inset Flex Code
18917 \begin_layout Plain Layout
18924 \begin_inset Flex Code
18927 \begin_layout Plain Layout
18934 but in practice they will typically look as they do here.
18935 The key to correct translation of the typeset text is the definition of the \SpecialChar LaTeX
18937 \begin_inset Flex Code
18940 \begin_layout Plain Layout
18949 \begin_inset Flex Code
18952 \begin_layout Plain Layout
18964 \begin_layout Standard
18966 \begin_inset Flex Code
18969 \begin_layout Plain Layout
18975 tag provides for internationalization based upon the overall language of the document.
18976 The contents of the tag will be included in the preamble,
18978 \begin_inset Flex Code
18981 \begin_layout Plain Layout
18988 What makes it special is the use of the
18989 \begin_inset Quotes eld
18993 \begin_inset Quotes erd
18997 \begin_inset Flex Code
19000 \begin_layout Plain Layout
19007 which will be replaced,
19008 when \SpecialChar LyX
19009 produces \SpecialChar LaTeX
19011 with the translation of its argument into the document language.
19014 \begin_layout Standard
19016 \begin_inset Flex Code
19019 \begin_layout Plain Layout
19025 tag is more complex,
19026 since it is meant to provide support for multi-language documents and so offers an interface to the
19027 \begin_inset Flex Code
19030 \begin_layout Plain Layout
19037 Its contents will be added to the preamble once for each language that appears in the document.
19040 \begin_inset Flex Code
19043 \begin_layout Plain Layout
19049 will be replaced with its translation into the language in question;
19051 \begin_inset Flex Code
19054 \begin_layout Plain Layout
19060 is replaced by the language name (as used by the babel package).
19063 \begin_layout Standard
19064 A German document that also included a French section would thus have the following in the preamble:
19067 \begin_layout LyX-Code
19076 claimname}{Affirmation}}
19077 \begin_inset Newline newline
19088 claimname}{Behauptung}}
19089 \begin_inset Newline newline
19096 claimname}{Behauptung}
19099 \begin_layout Standard
19102 \begin_inset Flex Code
19105 \begin_layout Plain Layout
19111 will then conspire to produce the correct text in the output.
19114 \begin_layout Standard
19115 One important point to note here is that the translations are provided by \SpecialChar LyX
19118 \begin_inset Flex Code
19121 \begin_layout Plain Layout
19131 \begin_inset Flex Code
19134 \begin_layout Plain Layout
19141 \begin_inset Flex Code
19144 \begin_layout Plain Layout
19150 are really only of use in layout files that are provided with \SpecialChar LyX
19152 since text entered in user-created layout files will not be seen by \SpecialChar LyX
19153 's internationalization routines unless the
19154 \begin_inset Flex Code
19157 \begin_layout Plain Layout
19163 file is modified accordingly.
19166 any layout created with the intention that it will be included with \SpecialChar LyX
19167 should use these tags where appropriate.
19168 Please note that the paragraph style translations provided by \SpecialChar LyX
19169 will never change with a minor update (e.
19170 \begin_inset space \thinspace{}
19174 \begin_inset space \space{}
19177 from version 2.1.x to 2.1.y).
19178 It is however quite likely that a major update (e.
19179 \begin_inset space \thinspace{}
19183 \begin_inset space \space{}
19186 from 2.0.x to 2.1.0) will introduce new translations or corrections.
19189 \begin_layout Subsection
19191 \begin_inset CommandInset label
19193 name "subsec:Floats"
19200 \begin_layout Standard
19201 It is necessary to define the floats (
19202 \begin_inset Flex Noun
19205 \begin_layout Plain Layout
19213 \begin_inset Flex Noun
19216 \begin_layout Plain Layout
19224 ) in the text class itself.
19225 Standard floats are included in the file
19226 \begin_inset Flex Code
19229 \begin_layout Plain Layout
19236 so you may have to do no more than add
19239 \begin_layout LyX-Code
19240 Input stdfloats.inc
19243 \begin_layout Standard
19244 to your layout file.
19245 If you want to implement a text class that proposes some other float types (like the AGU class bundled with \SpecialChar LyX
19247 the information below will hopefully help you:
19250 \begin_layout Description
19251 \begin_inset Flex Code
19254 \begin_layout Plain Layout
19261 \begin_inset Flex Code
19264 \begin_layout Plain Layout
19270 =!htbpH] Allowed placement options for this float type.
19271 The value is a string of placement characters.
19272 Possible characters include:
19278 \begin_inset Quotes eld
19282 \begin_inset Quotes erd
19291 \begin_inset Quotes eld
19295 \begin_inset Quotes erd
19304 \begin_inset Quotes eld
19308 \begin_inset Quotes erd
19317 \begin_inset Quotes eld
19321 \begin_inset Quotes erd
19330 \begin_inset Quotes eld
19334 \begin_inset Quotes erd
19343 \begin_inset Quotes eld
19347 \begin_inset Quotes erd
19351 The order of the characters in the string does not matter.
19352 If no placement options are allowed,
19360 \begin_layout Description
19361 \begin_inset Flex Code
19364 \begin_layout Plain Layout
19371 \begin_inset Flex Code
19374 \begin_layout Plain Layout
19383 \begin_inset space \thinspace{}
19389 \begin_inset Flex Code
19392 \begin_layout Plain Layout
19402 ] Defines whether the float allows to be rotated via the \SpecialChar LaTeX
19409 \begin_inset Flex Code
19412 \begin_layout Plain Layout
19418 if the float does not support this feature.
19421 \begin_layout Description
19422 \begin_inset Flex Code
19425 \begin_layout Plain Layout
19432 \begin_inset Flex Code
19435 \begin_layout Plain Layout
19444 \begin_inset space \thinspace{}
19450 \begin_inset Flex Code
19453 \begin_layout Plain Layout
19463 ] Defines whether the float has a starred variant that spans columns in a two column paragraph.
19465 \begin_inset Flex Code
19468 \begin_layout Plain Layout
19474 if the float does not support this feature.
19477 \begin_layout Description
19478 \begin_inset Flex Code
19481 \begin_layout Plain Layout
19488 \begin_inset Flex Code
19491 \begin_layout Plain Layout
19498 \begin_inset Quotes erd
19502 \begin_inset Quotes erd
19505 ] The file name extension of an auxiliary file for the list of figures (or whatever).
19507 writes the captions to this file.
19510 \begin_layout Description
19511 \begin_inset Flex Code
19514 \begin_layout Plain Layout
19521 \begin_inset Flex Code
19524 \begin_layout Plain Layout
19531 \begin_inset Quotes erd
19535 \begin_inset Quotes erd
19538 ] The string that will be used in the menus and also for the caption.
19539 This is translated to the current language if babel is used.
19542 \begin_layout Description
19543 \begin_inset Flex Code
19546 \begin_layout Plain Layout
19552 These tags control the XHTML output.
19554 \begin_inset CommandInset ref
19556 reference "sec:Tags-for-XHTML"
19564 \begin_layout Description
19565 \begin_inset Flex Code
19568 \begin_layout Plain Layout
19577 \begin_inset Flex Code
19580 \begin_layout Plain Layout
19589 \begin_inset space \thinspace{}
19593 \begin_inset Flex Code
19596 \begin_layout Plain Layout
19602 ] Indicates whether the float is already defined in the document class or if instead the \SpecialChar LaTeX
19604 \begin_inset Flex Code
19607 \begin_layout Plain Layout
19613 needs to be loaded to define it on-the-fly.
19615 \begin_inset Flex Code
19618 \begin_layout Plain Layout
19627 \begin_inset Flex Code
19630 \begin_layout Plain Layout
19637 It should be set to
19638 \begin_inset Flex Code
19641 \begin_layout Plain Layout
19647 if the float is already defined by the \SpecialChar LaTeX
19651 \begin_layout Description
19652 \begin_inset Flex Code
19655 \begin_layout Plain Layout
19662 \begin_inset Flex Code
19665 \begin_layout Plain Layout
19672 \begin_inset Quotes erd
19676 \begin_inset Quotes erd
19679 ] The command used to generate a list of floats of this type;
19688 \begin_inset Flex Code
19691 \begin_layout Plain Layout
19698 since there is no standard way to generate this command.
19700 \begin_inset Flex Code
19703 \begin_layout Plain Layout
19710 since in that case there is a standard way to define the command.
19713 \begin_layout Description
19714 \begin_inset Flex Code
19717 \begin_layout Plain Layout
19724 \begin_inset Flex Code
19727 \begin_layout Plain Layout
19734 \begin_inset Quotes erd
19738 \begin_inset Quotes erd
19741 ] A title for a list of floats of this kind (list of figures,
19744 It is used for the screen label within \SpecialChar LyX
19746 it is used by \SpecialChar LaTeX
19747 for the title and it is used as the title in the XHTML output.
19748 It will be translated to the document language.
19751 \begin_layout Description
19752 \begin_inset Flex Code
19755 \begin_layout Plain Layout
19762 \begin_inset Flex Code
19765 \begin_layout Plain Layout
19772 \begin_inset Quotes erd
19776 \begin_inset Quotes erd
19779 ] This (optional) argument determines whether floats of this class will be numbered within some sectional unit of the document.
19782 \begin_inset Flex Code
19785 \begin_layout Plain Layout
19792 \begin_inset Quotes eld
19796 \begin_inset Flex Code
19799 \begin_layout Plain Layout
19806 \begin_inset Quotes erd
19810 the floats will be numbered within chapters.
19814 \begin_layout Description
19815 \begin_inset Flex Code
19818 \begin_layout Plain Layout
19825 \begin_inset Flex Code
19828 \begin_layout Plain Layout
19835 \begin_inset Quotes erd
19839 \begin_inset Quotes erd
19842 ] The default placement for the given class of floats.
19843 The string should be as in standard \SpecialChar LaTeX
19846 \begin_inset Flex Code
19849 \begin_layout Plain Layout
19857 \begin_inset Flex Code
19860 \begin_layout Plain Layout
19868 \begin_inset Flex Code
19871 \begin_layout Plain Layout
19878 \begin_inset Flex Code
19881 \begin_layout Plain Layout
19895 \begin_layout Plain Layout
19896 Note that the order of these letters in the string is irrelevant,
19897 like in \SpecialChar LaTeX
19903 On top of that there is a new type,
19905 \begin_inset Flex Code
19908 \begin_layout Plain Layout
19915 which does not really correspond to a float,
19918 \begin_inset Quotes eld
19922 \begin_inset Quotes erd
19926 Note however that the
19927 \begin_inset Flex Code
19930 \begin_layout Plain Layout
19936 specifier is special and,
19937 because of implementation details,
19938 cannot be used in non-built in float types.
19939 If you do not understand what this means,
19941 \begin_inset Quotes eld
19945 \begin_inset Flex Code
19948 \begin_layout Plain Layout
19955 \begin_inset Quotes erd
19961 \begin_layout Description
19962 \begin_inset Flex Code
19965 \begin_layout Plain Layout
19972 \begin_inset Flex Code
19975 \begin_layout Plain Layout
19981 ] The prefix to use when creating labels referring to floats of this type.
19982 This allows the use of formatted references.
19983 Note that you can remove any
19984 \begin_inset Flex Code
19987 \begin_layout Plain Layout
19993 set by a copied style by using the special value
19994 \begin_inset Quotes eld
19998 \begin_inset Quotes erd
20002 which must be all caps.
20003 \change_inserted -712698321 1565605014
20007 \begin_layout Description
20009 \change_inserted -712698321 1565605014
20010 \begin_inset Flex Code
20013 \begin_layout Plain Layout
20015 \change_inserted -712698321 1565605014
20024 \begin_inset Flex Code
20027 \begin_layout Plain Layout
20029 \change_inserted -712698321 1565605014
20037 ] As with paragraph styles,
20039 \begin_inset CommandInset ref
20041 reference "subsec:Paragraph-Styles"
20051 \begin_layout Description
20052 \begin_inset Flex Code
20055 \begin_layout Plain Layout
20062 \begin_inset Flex Code
20065 \begin_layout Plain Layout
20072 \begin_inset Quotes erd
20076 \begin_inset Quotes erd
20079 ] The style used when defining the float using
20080 \begin_inset Flex Code
20083 \begin_layout Plain Layout
20094 \begin_layout Description
20095 \begin_inset Flex Code
20098 \begin_layout Plain Layout
20105 \begin_inset Flex Code
20108 \begin_layout Plain Layout
20115 \begin_inset Quotes erd
20119 \begin_inset Quotes erd
20123 \begin_inset Quotes eld
20127 \begin_inset Quotes erd
20130 of the new class of floats,
20131 like program or algorithm.
20132 After the appropriate
20133 \begin_inset Flex Code
20136 \begin_layout Plain Layout
20146 \begin_inset Flex Code
20149 \begin_layout Plain Layout
20158 \begin_inset Flex Code
20161 \begin_layout Plain Layout
20172 \begin_layout Description
20173 \begin_inset Flex Code
20176 \begin_layout Plain Layout
20183 \begin_inset Flex Code
20186 \begin_layout Plain Layout
20193 \begin_inset space \thinspace{}
20197 \begin_inset Flex Code
20200 \begin_layout Plain Layout
20208 ] Specifies whether this float is defined using the \SpecialChar LaTeX
20210 \begin_inset Flex Code
20213 \begin_layout Plain Layout
20220 either by the class file,
20221 another package or on-the-fly by \SpecialChar LyX
20225 \begin_layout Standard
20226 Note that defining a float with type
20227 \begin_inset Flex Code
20230 \begin_layout Plain Layout
20238 automatically defines the corresponding counter with name
20239 \begin_inset Flex Code
20242 \begin_layout Plain Layout
20253 \begin_layout Subsection
20254 Flex insets and InsetLayout
20255 \begin_inset CommandInset label
20257 name "subsec:Flex-insets-and"
20264 \begin_layout Standard
20265 Flex insets come in
20266 \change_deleted 5863208 1594239511
20268 \change_inserted 5863208 1594239512
20275 \begin_layout Itemize
20277 \begin_inset Flex Code
20280 \begin_layout Plain Layout
20287 These define semantic markup corresponding to such \SpecialChar LaTeX
20289 \begin_inset Flex Code
20292 \begin_layout Plain Layout
20301 \begin_inset Flex Code
20304 \begin_layout Plain Layout
20315 \begin_layout Itemize
20317 \begin_inset Flex Code
20320 \begin_layout Plain Layout
20327 These can be used to define custom collapsible insets,
20328 similar to \SpecialChar TeX
20332 An obvious example is an endnote inset,
20333 which is defined in the
20334 \begin_inset Flex Code
20337 \begin_layout Plain Layout
20346 \begin_layout Itemize
20348 \change_deleted 5863208 1594239528
20350 \begin_inset Flex Code
20353 \begin_layout Plain Layout
20360 For use with DocBook classes.
20365 \begin_layout Standard
20366 Flex insets are defined using the
20367 \begin_inset Flex Code
20370 \begin_layout Plain Layout
20377 which shall be explained in a moment.
20380 \begin_layout Standard
20382 \begin_inset Flex Code
20385 \begin_layout Plain Layout
20391 tag also serves another function:
20392 It can be used to customize the general layout of many different types of insets.
20395 \begin_inset Flex Code
20398 \begin_layout Plain Layout
20404 can be used to customize the layout parameters for footnotes,
20417 as well as to define Flex insets.
20420 \begin_layout Standard
20422 \begin_inset Flex Code
20425 \begin_layout Plain Layout
20431 definition must begin with a line of the form:
20434 \begin_layout LyX-Code
20438 \begin_layout Standard
20440 \begin_inset Flex Code
20443 \begin_layout Plain Layout
20449 indicates the inset whose layout is being defined,
20450 and here there are four cases.
20453 \begin_layout Enumerate
20454 The layout for a pre-existing inset is being modified.
20457 \begin_inset Flex Code
20460 \begin_layout Plain Layout
20466 any one of the following:
20468 \begin_inset Flex Code
20471 \begin_layout Plain Layout
20479 \begin_inset Flex Code
20482 \begin_layout Plain Layout
20490 \begin_inset Flex Code
20493 \begin_layout Plain Layout
20501 \begin_inset Flex Code
20504 \begin_layout Plain Layout
20512 \begin_inset Flex Code
20515 \begin_layout Plain Layout
20523 \begin_inset Flex Code
20526 \begin_layout Plain Layout
20534 \begin_inset Flex Code
20537 \begin_layout Plain Layout
20545 \begin_inset Flex Code
20548 \begin_layout Plain Layout
20556 \begin_inset Flex Code
20559 \begin_layout Plain Layout
20567 \begin_inset Flex Code
20570 \begin_layout Plain Layout
20578 \begin_inset Flex Code
20581 \begin_layout Plain Layout
20589 \begin_inset Flex Code
20592 \begin_layout Plain Layout
20600 \begin_inset Flex Code
20603 \begin_layout Plain Layout
20611 \begin_inset Flex Code
20614 \begin_layout Plain Layout
20622 \begin_inset Flex Code
20625 \begin_layout Plain Layout
20633 \begin_inset Flex Code
20636 \begin_layout Plain Layout
20644 \begin_inset Flex Code
20647 \begin_layout Plain Layout
20655 \begin_inset Flex Code
20658 \begin_layout Plain Layout
20666 \begin_inset Flex Code
20669 \begin_layout Plain Layout
20677 \begin_inset Flex Code
20680 \begin_layout Plain Layout
20689 \begin_layout Enumerate
20690 The layout for a Flex inset is being defined.
20693 \begin_inset Flex Code
20696 \begin_layout Plain Layout
20702 must be of the form
20703 \begin_inset Quotes eld
20707 \begin_inset Flex Code
20710 \begin_layout Plain Layout
20717 \begin_inset Quotes erd
20722 \begin_inset Flex Code
20725 \begin_layout Plain Layout
20731 may be any valid identifier not used by a pre-existing Flex inset.
20732 The identifier may include spaces,
20733 but in that case the whole thing must be wrapped in quotes.
20734 Note that the definition of a flex inset
20739 \begin_inset Flex Code
20742 \begin_layout Plain Layout
20749 declaring which type of inset it defines.
20752 \begin_layout Enumerate
20753 The layout for user specific branch is being defined.
20756 \begin_inset Flex Code
20759 \begin_layout Plain Layout
20765 must be of the form
20766 \begin_inset Quotes eld
20770 \begin_inset Flex Code
20773 \begin_layout Plain Layout
20780 \begin_inset Quotes erd
20785 \begin_inset Flex Code
20788 \begin_layout Plain Layout
20794 may be any valid identifier of branch defined in user's document.
20795 The identifier may include spaces,
20796 but in that case the whole thing must be wrapped in quotes.
20797 The main purpose of this feature is to allow \SpecialChar LaTeX
20798 wrapping around specific branches as user needs.
20801 \begin_layout Enumerate
20802 The layout of a user (or class) specific caption is being defined.
20805 \begin_inset Flex Code
20808 \begin_layout Plain Layout
20814 must be of the form
20815 \begin_inset Quotes eld
20819 \begin_inset Flex Code
20822 \begin_layout Plain Layout
20829 \begin_inset Quotes erd
20834 \begin_inset Flex Code
20837 \begin_layout Plain Layout
20843 specifies the name of the caption as it appears in the menu.
20844 Have a look at the standard caption (
20845 \begin_inset Flex Code
20848 \begin_layout Plain Layout
20855 the specific captions of the KOMA-Script classes (
20856 \begin_inset Flex Code
20859 \begin_layout Plain Layout
20867 \begin_inset Flex Code
20870 \begin_layout Plain Layout
20879 \begin_inset space ~
20883 \begin_inset Newline linebreak
20889 \begin_inset Flex Code
20892 \begin_layout Plain Layout
20898 ) for applications.
20901 \begin_layout Standard
20903 \begin_inset Flex Code
20906 \begin_layout Plain Layout
20912 definition can contain the following entries:
20915 \begin_layout Description
20916 \begin_inset Flex Code
20919 \begin_layout Plain Layout
20926 \begin_inset Flex Code
20929 \begin_layout Plain Layout
20935 =""] This inset will appear in the table of contents of the given type.
20936 An empty string disables.
20937 See also the OutlinerName and the IsTocCaption commands.
20938 This is only implemented for Flex insets.
20943 \begin_layout Description
20944 \begin_inset Flex Code
20947 \begin_layout Plain Layout
20954 \begin_inset Flex Code
20957 \begin_layout Plain Layout
20963 ] Defines argument number of a command\SpecialChar breakableslash
20964 environment associated with the current layout.
20965 The definition must end with
20966 \begin_inset Flex Code
20969 \begin_layout Plain Layout
20977 \change_inserted -584632292 1615846847
20979 \begin_inset CommandInset ref
20981 reference "subsec:Arguments"
20990 \change_deleted -584632292 1615846847
20992 \begin_inset CommandInset ref
20994 reference "subsec:Paragraph-Styles"
21002 \change_deleted -584632292 1615846902
21004 \change_inserted -584632292 1615846906
21010 \begin_layout Description
21011 \begin_inset Flex Code
21014 \begin_layout Plain Layout
21020 Preamble for changing language commands;
21022 \begin_inset CommandInset ref
21024 reference "subsec:I18n"
21032 \begin_layout Description
21033 \begin_inset Flex Code
21036 \begin_layout Plain Layout
21043 \begin_inset Flex Code
21046 \begin_layout Plain Layout
21052 ] The color for the inset's background.
21054 \begin_inset CommandInset ref
21056 reference "chap:Names-of-colors"
21061 for a list of the available color names.
21064 \begin_layout Description
21065 \begin_inset Flex Code
21068 \begin_layout Plain Layout
21075 \begin_inset Flex Code
21078 \begin_layout Plain Layout
21087 \begin_inset space \thinspace{}
21091 \begin_inset Flex Code
21094 \begin_layout Plain Layout
21100 ] Whether to use the content of the inset as the label,
21101 when the inset is closed.
21105 \begin_layout Description
21106 \begin_inset Flex Code
21109 \begin_layout Plain Layout
21116 \begin_inset Flex Code
21119 \begin_layout Plain Layout
21125 ] As with paragraph styles,
21127 \begin_inset CommandInset ref
21129 reference "subsec:Paragraph-Styles"
21135 Note that you need to specify the complete type,
21137 \begin_inset space \thinspace{}
21141 \begin_inset space ~
21145 \begin_inset Flex Code
21148 \begin_layout Plain Layout
21149 CopyStyle Flex:<name>
21157 \begin_layout Description
21158 \begin_inset Flex Code
21161 \begin_layout Plain Layout
21168 \begin_inset Flex Code
21171 \begin_layout Plain Layout
21180 \begin_inset space \thinspace{}
21184 \begin_inset Flex Code
21187 \begin_layout Plain Layout
21193 ] Indicates whether the user may employ the Paragraph Settings dialog to customize the paragraph.
21196 \begin_layout Description
21197 \begin_inset Flex Code
21200 \begin_layout Plain Layout
21207 \begin_inset Flex Code
21210 \begin_layout Plain Layout
21218 \begin_inset Flex Code
21221 \begin_layout Plain Layout
21229 \begin_inset Flex Code
21232 \begin_layout Plain Layout
21239 describing the rendering style used for the inset's frame and buttons.
21240 Footnotes generally use
21241 \begin_inset Flex Code
21244 \begin_layout Plain Layout
21251 ERT insets generally
21252 \begin_inset Flex Code
21255 \begin_layout Plain Layout
21262 and character styles
21263 \begin_inset Flex Code
21266 \begin_layout Plain Layout
21275 \begin_layout Description
21276 \begin_inset Flex Code
21279 \begin_layout Plain Layout
21286 \begin_inset Flex Code
21289 \begin_layout Plain Layout
21298 \begin_inset space \thinspace{}
21304 \begin_inset Flex Code
21307 \begin_layout Plain Layout
21316 \begin_inset Flex Code
21319 \begin_layout Plain Layout
21326 \begin_inset Flex Code
21329 \begin_layout Plain Layout
21336 Indicates whether the environment will stand on its own in the output or will appear inline with the surrounding text.
21338 it is supposed that the \SpecialChar LaTeX
21339 environment ignores white space (including one newline character) after the
21340 \begin_inset Flex Code
21343 \begin_layout Plain Layout
21356 \begin_inset Flex Code
21359 \begin_layout Plain Layout
21373 \change_inserted 731793113 1538674858
21377 \begin_layout Description
21379 \change_inserted 731793113 1538674891
21380 \begin_inset Flex Code
21383 \begin_layout Plain Layout
21385 \change_inserted 731793113 1538674863
21397 ,1] Allow the contents of the inset to be edited externally (using whatever editor is defined for the document's output format).
21402 \begin_layout Description
21403 \begin_inset Flex Code
21406 \begin_layout Plain Layout
21412 Required at the end of the
21413 \begin_inset Flex Code
21416 \begin_layout Plain Layout
21425 \begin_layout Description
21426 \begin_inset Flex Code
21429 \begin_layout Plain Layout
21435 The font used for both the text body
21441 \begin_inset CommandInset ref
21443 reference "subsec:Font-description"
21449 Note that defining this font automatically defines the
21450 \begin_inset Flex Code
21453 \begin_layout Plain Layout
21460 so define this first and define
21461 \begin_inset Flex Code
21464 \begin_layout Plain Layout
21470 later if you want them to be different.
21473 \begin_layout Description
21474 \begin_inset Flex Code
21477 \begin_layout Plain Layout
21478 FixedWidthPreambleEncoding
21484 \begin_inset Flex Code
21487 \begin_layout Plain Layout
21496 \begin_inset space \thinspace{}
21500 \begin_inset Flex Code
21503 \begin_layout Plain Layout
21509 ] Force a fixed width encoding for the translated contents of
21510 \begin_inset Flex Code
21513 \begin_layout Plain Layout
21520 \begin_inset Flex Code
21523 \begin_layout Plain Layout
21529 code generated by this layout.
21530 This is needed for special \SpecialChar LaTeX
21535 that do not work with variable width encodings such as
21540 This setting is ignored if fully Unicode aware \SpecialChar LaTeX
21541 backends such as Xe\SpecialChar TeX
21542 or Lua\SpecialChar TeX
21546 \begin_layout Description
21547 \begin_inset Flex Code
21550 \begin_layout Plain Layout
21551 ForceLocalFontSwitch
21557 \begin_inset Flex Code
21560 \begin_layout Plain Layout
21569 \begin_inset space \thinspace{}
21573 \begin_inset Flex Code
21576 \begin_layout Plain Layout
21582 ] When using babel,
21583 always use a local font switch (
21584 \begin_inset Flex Code
21587 \begin_layout Plain Layout
21596 never a global one (such as
21597 \begin_inset Flex Code
21600 \begin_layout Plain Layout
21611 \begin_layout Description
21612 \begin_inset Flex Code
21615 \begin_layout Plain Layout
21622 \begin_inset Flex Code
21625 \begin_layout Plain Layout
21634 \begin_inset space \thinspace{}
21638 \begin_inset Flex Code
21641 \begin_layout Plain Layout
21648 \begin_inset Quotes eld
21652 \begin_inset Quotes erd
21656 leading to Left-to-Right (Latin) output,
21658 \begin_inset space \thinspace{}
21662 \begin_inset space \space{}
21665 in \SpecialChar TeX
21670 \begin_layout Description
21671 \begin_inset Flex Code
21674 \begin_layout Plain Layout
21681 \begin_inset Flex Code
21684 \begin_layout Plain Layout
21693 \begin_inset space \thinspace{}
21697 \begin_inset Flex Code
21700 \begin_layout Plain Layout
21706 ] Force a line break in the \SpecialChar LaTeX
21707 output before the inset starts and after the inset ends.
21708 This assures the inset itself is output on its own lines,
21709 for parsing purposes.
21712 \begin_layout Description
21713 \begin_inset Flex Code
21716 \begin_layout Plain Layout
21723 \begin_inset Flex Code
21726 \begin_layout Plain Layout
21735 \begin_inset space \thinspace{}
21739 \begin_inset Flex Code
21742 \begin_layout Plain Layout
21748 ] Indicates whether the
21749 \begin_inset Flex Code
21752 \begin_layout Plain Layout
21760 the user can change the paragraph style used in the inset.
21764 \begin_layout Description
21765 \begin_inset Flex Code
21768 \begin_layout Plain Layout
21775 \begin_inset Flex Code
21778 \begin_layout Plain Layout
21787 \begin_inset space \thinspace{}
21791 \begin_inset Flex Code
21794 \begin_layout Plain Layout
21800 ] As with paragraph styles,
21802 \begin_inset CommandInset ref
21804 reference "subsec:Paragraph-Styles"
21812 \begin_layout Description
21813 \begin_inset Flex Code
21816 \begin_layout Plain Layout
21822 These tags control the XHTML output.
21824 \begin_inset CommandInset ref
21826 reference "sec:Tags-for-XHTML"
21834 \begin_layout Description
21835 \begin_inset Flex Code
21838 \begin_layout Plain Layout
21845 \begin_inset Flex Code
21848 \begin_layout Plain Layout
21857 \begin_inset space \thinspace{}
21861 \begin_inset Flex Code
21864 \begin_layout Plain Layout
21870 ] Whether to include the contents of this inset in the strings generated for the `Outline' pane for all table of contents,
21871 regardless of the AddToToc setting.
21874 want the content of a footnote in a section header to be included in the TOC displayed in the outline,
21875 but one would normally want the content of a character style displayed.
21880 \begin_layout Description
21881 \begin_inset Flex Code
21884 \begin_layout Plain Layout
21891 \begin_inset Flex Code
21894 \begin_layout Plain Layout
21903 \begin_inset space \thinspace{}
21907 \begin_inset Flex Code
21910 \begin_layout Plain Layout
21916 ] If this is set to 1 and AddToToc is enabled,
21917 the inset adds a summary of its contents in its item in the table of contents.
21919 only the label appears.
21922 \begin_layout Description
21923 \begin_inset Flex Code
21926 \begin_layout Plain Layout
21935 \begin_inset Flex Code
21938 \begin_layout Plain Layout
21947 \begin_inset space \thinspace{}
21951 \begin_inset Flex Code
21954 \begin_layout Plain Layout
21960 ] As with paragraph styles,
21962 \begin_inset CommandInset ref
21964 reference "subsec:Paragraph-Styles"
21972 \begin_layout Description
21973 \begin_inset Flex Code
21976 \begin_layout Plain Layout
21982 The font used for the label.
21984 \begin_inset CommandInset ref
21986 reference "subsec:Font-description"
21992 Note that this definition can never appear before
21993 \begin_inset Flex Code
21996 \begin_layout Plain Layout
22003 lest it be ineffective.
22006 \begin_layout Description
22007 \begin_inset Flex Code
22010 \begin_layout Plain Layout
22017 \begin_inset Flex Code
22020 \begin_layout Plain Layout
22027 \begin_inset Quotes erd
22031 \begin_inset Quotes erd
22034 ] What will be displayed on the button or elsewhere as the inset label.
22036 \begin_inset Flex Code
22039 \begin_layout Plain Layout
22047 \begin_inset Flex Code
22050 \begin_layout Plain Layout
22056 ) modify this label on the fly.
22059 \begin_layout Description
22060 \begin_inset Flex Code
22063 \begin_layout Plain Layout
22069 Language dependent preamble;
22071 \begin_inset CommandInset ref
22073 reference "subsec:I18n"
22081 \begin_layout Description
22082 \begin_inset Flex Code
22085 \begin_layout Plain Layout
22092 \begin_inset Flex Code
22095 \begin_layout Plain Layout
22101 ] The name of the corresponding \SpecialChar LaTeX
22103 Either the environment or command name.
22106 \begin_layout Description
22107 \begin_inset Flex Code
22110 \begin_layout Plain Layout
22117 \begin_inset Flex Code
22120 \begin_layout Plain Layout
22126 ] The optional parameter for the corresponding
22127 \begin_inset Flex Code
22130 \begin_layout Plain Layout
22137 including possible bracket pairs like
22138 \begin_inset Flex Code
22141 \begin_layout Plain Layout
22148 This parameter cannot be changed from within \SpecialChar LyX
22150 \begin_inset Flex Code
22153 \begin_layout Plain Layout
22159 for customizable parameters).
22160 It will be output as is after all \SpecialChar LaTeX
22162 \begin_inset Flex Code
22165 \begin_layout Plain Layout
22174 \begin_layout Description
22175 \begin_inset Flex Code
22178 \begin_layout Plain Layout
22185 \begin_inset Flex Code
22188 \begin_layout Plain Layout
22196 ] How the style should be translated into \SpecialChar LaTeX
22201 \begin_layout Plain Layout
22202 \begin_inset Flex Code
22205 \begin_layout Plain Layout
22211 is perhaps a bit misleading,
22212 since these rules apply to SGML classes too.
22213 Visit the SGML class files for specific examples.
22222 \begin_layout Description
22223 \begin_inset Flex Code
22226 \begin_layout Plain Layout
22232 means nothing special
22235 \begin_layout Description
22236 \begin_inset Flex Code
22239 \begin_layout Plain Layout
22246 \begin_inset Flex Code
22249 \begin_layout Plain Layout
22256 {\SpecialChar ldots
22265 \begin_layout Description
22266 \begin_inset Flex Code
22269 \begin_layout Plain Layout
22276 \begin_inset Flex Code
22279 \begin_layout Plain Layout
22286 }\SpecialChar ldots
22301 \begin_layout Standard
22302 Putting the last few things together,
22303 the \SpecialChar LaTeX
22304 output will be either:
22308 \begin_layout LyX-Code
22311 LatexName[LatexParam]{\SpecialChar ldots
22315 \begin_layout Standard
22320 \begin_layout LyX-Code
22323 begin{LatexName}[LatexParam] \SpecialChar ldots
22329 \begin_layout Standard
22330 depending upon the \SpecialChar LaTeX
22335 \begin_layout Description
22336 \begin_inset Flex Code
22339 \begin_layout Plain Layout
22346 \begin_inset Flex Code
22349 \begin_layout Plain Layout
22355 ] A string that is put at the beginning of the layout content.
22356 A line break in the output can be indicated by
22357 \begin_inset Flex Code
22360 \begin_layout Plain Layout
22369 \begin_layout Description
22370 \begin_inset Flex Code
22373 \begin_layout Plain Layout
22380 \begin_inset Flex Code
22383 \begin_layout Plain Layout
22391 \begin_inset Flex Code
22394 \begin_layout Plain Layout
22402 \change_deleted -584632292 1615846609
22404 \begin_inset Flex Code
22407 \begin_layout Plain Layout
22416 \begin_inset Flex Code
22419 \begin_layout Plain Layout
22425 (indicating a dummy definition ending definitions of charstyles,
22427 This entry is required in and is only meaningful for Flex insets.
22428 Among other things,
22429 it determines on which menu this inset will appear.
22431 \begin_inset Flex Code
22434 \begin_layout Plain Layout
22441 \begin_inset Flex Code
22444 \begin_layout Plain Layout
22450 will automatically set
22451 \begin_inset Flex Code
22454 \begin_layout Plain Layout
22461 \begin_inset Flex Code
22464 \begin_layout Plain Layout
22472 \begin_inset Flex Code
22475 \begin_layout Plain Layout
22481 can be set to true,
22483 \begin_inset Flex Code
22486 \begin_layout Plain Layout
22494 \begin_inset Flex Code
22497 \begin_layout Plain Layout
22503 insets by setting it
22508 \begin_inset Flex Code
22511 \begin_layout Plain Layout
22518 \change_inserted -712698321 1555575738
22522 \begin_layout Description
22524 \change_inserted -712698321 1555575844
22525 \begin_inset Flex Code
22528 \begin_layout Plain Layout
22530 \change_inserted -712698321 1555575740
22539 \begin_inset Flex Code
22542 \begin_layout Plain Layout
22544 \change_inserted -712698321 1555575740
22552 A dedicated string for the menu.
22553 You can define an accelerator by appending the respective character to the string,
22555 \begin_inset Quotes eld
22559 \begin_inset Quotes erd
22563 \begin_inset space \thinspace{}
22567 \begin_inset space \space{}
22571 \begin_inset Quotes eld
22575 \begin_inset Flex Code
22578 \begin_layout Plain Layout
22580 \change_inserted -712698321 1555575781
22589 \begin_inset Quotes erd
22593 This specification is optional.
22594 If it is not given the inset name as specified in the type declaration will be used instead for the menu.
22599 \begin_layout Description
22600 \begin_inset Flex Code
22603 \begin_layout Plain Layout
22610 \begin_inset Flex Code
22613 \begin_layout Plain Layout
22622 \begin_inset space \thinspace{}
22626 \begin_inset Flex Code
22629 \begin_layout Plain Layout
22635 ] Whether multiple paragraphs are permitted in this inset.
22637 \begin_inset Flex Code
22640 \begin_layout Plain Layout
22646 to the same value and
22647 \begin_inset Flex Code
22650 \begin_layout Plain Layout
22656 to the opposite value.
22657 These can be reset to other values,
22663 \begin_inset Flex Code
22666 \begin_layout Plain Layout
22676 \begin_layout Description
22677 \begin_inset Flex Code
22680 \begin_layout Plain Layout
22687 \begin_inset Flex Code
22690 \begin_layout Plain Layout
22699 \begin_inset space \thinspace{}
22703 \begin_inset Flex Code
22706 \begin_layout Plain Layout
22712 ] Whether fragile commands in this inset should be
22713 \begin_inset Flex Code
22716 \begin_layout Plain Layout
22730 whether the command should itself be protected.) Default is false.
22731 \change_inserted -712698321 1523633958
22735 \begin_layout Description
22737 \change_inserted -712698321 1552395786
22738 \begin_inset Flex Code
22741 \begin_layout Plain Layout
22743 \change_inserted -712698321 1523633961
22752 \begin_inset Flex Code
22755 \begin_layout Plain Layout
22757 \change_inserted -712698321 1523633958
22768 \begin_inset space \thinspace{}
22772 \begin_inset Flex Code
22775 \begin_layout Plain Layout
22777 \change_inserted -712698321 1523633958
22785 ] This causes macros that contain this inset to be protected with
22786 \begin_inset Flex Code
22789 \begin_layout Plain Layout
22791 \change_inserted -712698321 1523634038
22806 ) if necessary and thus allows (some) verbatim stuff in macros.
22810 \begin_layout Description
22812 \change_inserted -712698321 1555579651
22813 \begin_inset Flex Code
22816 \begin_layout Plain Layout
22818 \change_inserted -712698321 1552395787
22827 \begin_inset Flex Code
22830 \begin_layout Plain Layout
22832 \change_inserted -712698321 1552395787
22843 \begin_inset space \thinspace{}
22847 \begin_inset Flex Code
22850 \begin_layout Plain Layout
22852 \change_inserted -712698321 1552395787
22860 ] Whether specific commands in this inset (such as
22861 \begin_inset Flex Code
22864 \begin_layout Plain Layout
22866 \change_inserted -712698321 1552395787
22877 \begin_inset Flex Code
22880 \begin_layout Plain Layout
22882 \change_inserted -712698321 1552395787
22892 ) should be protected in an
22893 \begin_inset Flex Code
22896 \begin_layout Plain Layout
22898 \change_inserted -712698321 1552395787
22909 This is particularly needed for insets that draw on
22917 commands which parse their content in complex ways.
22921 \begin_layout Description
22923 \change_inserted -712698321 1555579742
22924 \begin_inset Flex Code
22927 \begin_layout Plain Layout
22929 \change_inserted -712698321 1555579658
22938 \begin_inset Flex Code
22941 \begin_layout Plain Layout
22943 \change_inserted -712698321 1555579651
22951 Option to define a different command (from the default
22952 \begin_inset Flex Code
22955 \begin_layout Plain Layout
22957 \change_inserted -712698321 1555579742
22969 ) to be used for line breaks.
22970 The initial backslash must not be specified.
22975 \begin_layout Description
22976 \begin_inset Flex Code
22979 \begin_layout Plain Layout
22986 \begin_inset Flex Code
22989 \begin_layout Plain Layout
22995 ] Deletes an existing
22996 \begin_inset Flex Code
22999 \begin_layout Plain Layout
23008 \begin_layout Description
23009 \begin_inset Flex Code
23012 \begin_layout Plain Layout
23019 \begin_inset Flex Code
23022 \begin_layout Plain Layout
23029 \begin_inset Flex Code
23032 \begin_layout Plain Layout
23038 that has replaced this
23039 \begin_inset Flex Code
23042 \begin_layout Plain Layout
23049 This is used to rename an
23050 \begin_inset Flex Code
23053 \begin_layout Plain Layout
23060 while keeping backward compatibility.
23061 \change_inserted -712698321 1559491850
23065 \begin_layout Description
23067 \change_inserted -712698321 1559492002
23068 \begin_inset Flex Code
23071 \begin_layout Plain Layout
23073 \change_inserted -712698321 1559491854
23082 \begin_inset Flex Code
23085 \begin_layout Plain Layout
23087 \change_inserted -712698321 1559491850
23098 \begin_inset space \thinspace{}
23102 \begin_inset Flex Code
23105 \begin_layout Plain Layout
23107 \change_inserted -712698321 1559491850
23115 ] If this is set to
23116 \begin_inset Flex Code
23119 \begin_layout Plain Layout
23121 \change_inserted -712698321 1559491881
23130 paragraph breaks will be ignored in the output.
23131 This might be useful for insets where the content should be alignable on different lines only in the \SpecialChar LyX
23133 without any effect in the output.
23138 \begin_layout Description
23139 \begin_inset Flex Code
23142 \begin_layout Plain Layout
23149 \begin_inset Flex Code
23152 \begin_layout Plain Layout
23161 \begin_inset space \thinspace{}
23165 \begin_inset Flex Code
23168 \begin_layout Plain Layout
23174 ] As with paragraph styles,
23176 \begin_inset CommandInset ref
23178 reference "subsec:Paragraph-Styles"
23187 \begin_layout Description
23188 \begin_inset Flex Code
23191 \begin_layout Plain Layout
23198 \begin_inset Flex Code
23201 \begin_layout Plain Layout
23210 \begin_inset space \thinspace{}
23214 \begin_inset Flex Code
23217 \begin_layout Plain Layout
23223 ] As with paragraph styles,
23225 \begin_inset CommandInset ref
23227 reference "subsec:Paragraph-Styles"
23236 \begin_layout Description
23237 \begin_inset Flex Code
23240 \begin_layout Plain Layout
23246 As with paragraph styles,
23248 \begin_inset CommandInset ref
23250 reference "subsec:Paragraph-Styles"
23258 \begin_layout Description
23259 \begin_inset Flex Code
23262 \begin_layout Plain Layout
23269 \begin_inset Flex Code
23272 \begin_layout Plain Layout
23278 ] The prefix to use when creating labels referring to insets of this type.
23279 This allows the use of formatted references.
23282 \begin_layout Description
23283 \begin_inset Flex Code
23286 \begin_layout Plain Layout
23293 \begin_inset Flex Code
23296 \begin_layout Plain Layout
23302 ] As with paragraph styles,
23304 \begin_inset CommandInset ref
23306 reference "subsec:Paragraph-Styles"
23314 \begin_layout Description
23315 \begin_inset Flex Code
23318 \begin_layout Plain Layout
23325 \begin_inset Flex Code
23328 \begin_layout Plain Layout
23337 \begin_inset space \thinspace{}
23341 \begin_inset Flex Code
23344 \begin_layout Plain Layout
23350 ] Resets the \SpecialChar LaTeX
23351 arguments of this layout (as defined via the
23352 \begin_inset Flex Code
23355 \begin_layout Plain Layout
23362 This is useful if you have copied a style via
23363 \begin_inset Flex Code
23366 \begin_layout Plain Layout
23373 but you do not want to inherit its (required and optional) arguments.
23376 \begin_layout Description
23377 \begin_inset Flex Code
23380 \begin_layout Plain Layout
23387 \begin_inset Flex Code
23390 \begin_layout Plain Layout
23399 \begin_inset space \thinspace{}
23403 \begin_inset Flex Code
23406 \begin_layout Plain Layout
23413 \change_inserted -712698321 1597733473
23415 \begin_inset Flex Code
23418 \begin_layout Plain Layout
23420 \change_inserted -712698321 1597732178
23429 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.
23430 \begin_inset space \thinspace{}
23435 \begin_inset Flex Code
23438 \begin_layout Plain Layout
23440 \change_inserted -712698321 1597733683
23443 textbf{Sourrounding text
23447 textbf{content}}\SpecialChar ldots
23456 \begin_inset Flex Code
23459 \begin_layout Plain Layout
23461 \change_inserted -712698321 1597733686
23464 textbf{Sourrounding text
23466 myinset{content}\SpecialChar ldots
23475 Setting this makes sense for commands that internally reset font settings (e.
23476 \begin_inset space \thinspace{}
23481 Note that wrongly setting this might lead to unwanted result (e.
23482 \begin_inset space \thinspace{}
23487 \begin_inset Flex Code
23490 \begin_layout Plain Layout
23492 \change_inserted -712698321 1597733688
23495 emph{Sourrounding text
23499 emph{content}}\SpecialChar ldots
23508 content is upright,
23510 \begin_inset Flex Code
23513 \begin_layout Plain Layout
23515 \change_inserted -712698321 1597733278
23527 \change_deleted -712698321 1597733283
23528 Whether this inset should use the font of its surrounding environment or uses its own.
23532 \change_deleted -712698321 1597733290
23534 \change_inserted -712698321 1597733290
23536 \begin_inset Flex Code
23539 \begin_layout Plain Layout
23541 \change_inserted -712698321 1597733292
23553 \change_deleted -712698321 1597733327
23554 use the font of the surrounding environment
23555 \change_inserted -712698321 1597733343
23556 font changes are not redone inside the inset
23561 \begin_layout Description
23562 \begin_inset Flex Code
23565 \begin_layout Plain Layout
23572 \begin_inset Flex Code
23575 \begin_layout Plain Layout
23581 ] A string that is put at the end of the layout content.
23582 A line break in the output can be indicated by
23583 \begin_inset Flex Code
23586 \begin_layout Plain Layout
23595 \begin_layout Description
23596 \begin_inset Flex Code
23599 \begin_layout Plain Layout
23606 \begin_inset Flex Code
23609 \begin_layout Plain Layout
23616 \begin_inset space \thinspace{}
23620 \begin_inset Flex Code
23623 \begin_layout Plain Layout
23631 ] Allow spell-checking the contents of this inset.
23633 \change_inserted -584632292 1615846659
23637 \begin_layout Subsection
23639 \change_inserted -584632292 1615846729
23641 \begin_inset CommandInset label
23643 name "subsec:Arguments"
23650 \begin_layout Standard
23652 \change_inserted -584632292 1615846807
23653 Both paragraph styles and inset layouts allow for
23657 as well as the main content.
23658 This is especially useful for things like section headings and only makes sense with \SpecialChar LaTeX
23660 Each (optional or required) argument of a command or environment—
23661 except for the required argument that is associated with the content—
23662 has a separate definition,
23663 where the number specifies the order of the arguments.
23664 The definition must end with
23665 \begin_inset Flex Code
23668 \begin_layout Plain Layout
23670 \change_inserted -584632292 1615846730
23679 So a command with two optional arguments looks like:
23682 \begin_layout Quote
23684 \change_inserted -584632292 1615846730
23690 \begin_layout Quote
23692 \change_inserted -584632292 1615846730
23698 \begin_layout Quote
23700 \change_inserted -584632292 1615846730
23706 \begin_layout Quote
23708 \change_inserted -584632292 1615846730
23714 \begin_layout Quote
23716 \change_inserted -584632292 1615846730
23722 \begin_layout Quote
23724 \change_inserted -584632292 1615846730
23730 \begin_layout Standard
23732 \change_inserted -584632292 1615846730
23734 \begin_inset Flex Code
23737 \begin_layout Plain Layout
23739 \change_inserted -584632292 1615846730
23748 the following specifications are possible:
23751 \begin_layout Itemize
23753 \change_inserted -584632292 1615846730
23754 \begin_inset Flex Code
23757 \begin_layout Plain Layout
23759 \change_inserted -584632292 1615846730
23768 \begin_inset Flex Code
23771 \begin_layout Plain Layout
23773 \change_inserted -584632292 1615846730
23781 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
23782 \begin_inset Flex Code
23785 \begin_layout Plain Layout
23787 \change_inserted -584632292 1615846730
23797 you can define an accelerator by appending the respective character to the string,
23799 \begin_inset Quotes eld
23803 \begin_inset Quotes erd
23807 \begin_inset space \thinspace{}
23811 \begin_inset space \space{}
23815 \begin_inset Quotes eld
23819 \begin_inset Flex Code
23822 \begin_layout Plain Layout
23824 \change_inserted -584632292 1615846730
23833 \begin_inset Quotes erd
23839 \begin_layout Itemize
23841 \change_inserted -584632292 1615846730
23842 \begin_inset Flex Code
23845 \begin_layout Plain Layout
23847 \change_inserted -584632292 1615846730
23856 \begin_inset Flex Code
23859 \begin_layout Plain Layout
23861 \change_inserted -584632292 1615846730
23869 A separate string for the menu.
23870 You can define an accelerator by appending the respective character to the string,
23872 \begin_inset Quotes eld
23876 \begin_inset Quotes erd
23880 \begin_inset space \thinspace{}
23884 \begin_inset space \space{}
23888 \begin_inset Quotes eld
23892 \begin_inset Flex Code
23895 \begin_layout Plain Layout
23897 \change_inserted -584632292 1615846730
23906 \begin_inset Quotes erd
23910 This specification is optional.
23911 If it is not given the
23912 \begin_inset Flex Code
23915 \begin_layout Plain Layout
23917 \change_inserted -584632292 1615846730
23925 will be used instead for the menu.
23928 \begin_layout Itemize
23930 \change_inserted -584632292 1615846730
23931 \begin_inset Flex Code
23934 \begin_layout Plain Layout
23936 \change_inserted -584632292 1615846730
23945 \begin_inset Flex Code
23948 \begin_layout Plain Layout
23950 \change_inserted -584632292 1615846730
23958 A longer explanatory text that appears in the tooltip when hovering over the argument inset.
23961 \begin_layout Itemize
23963 \change_inserted -584632292 1615846730
23964 \begin_inset Flex Code
23967 \begin_layout Plain Layout
23969 \change_inserted -584632292 1615846730
23978 \begin_inset Flex Code
23981 \begin_layout Plain Layout
23983 \change_inserted -584632292 1615846730
23994 \begin_inset space \thinspace{}
23998 \begin_inset Flex Code
24001 \begin_layout Plain Layout
24003 \change_inserted -584632292 1615846730
24011 ] Declare if this is a mandatory (1) or an optional (0) argument.
24012 Mandatory arguments will be output empty if not given,
24013 while optional arguments will not be output at all.
24015 mandatory arguments are delimited by
24016 \begin_inset Flex Code
24019 \begin_layout Plain Layout
24021 \change_inserted -584632292 1615846730
24030 while optional arguments are delimited by
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 Option to define a different command (from the default
24078 \begin_inset Flex Code
24081 \begin_layout Plain Layout
24083 \change_inserted -584632292 1615846730
24095 ) to be used for line breaks.
24096 The initial backslash must not be specified.
24099 \begin_layout Itemize
24101 \change_inserted -584632292 1615846730
24102 \begin_inset Flex Code
24105 \begin_layout Plain Layout
24107 \change_inserted -584632292 1615846730
24116 \begin_inset Flex Code
24119 \begin_layout Plain Layout
24121 \change_inserted -584632292 1615846730
24129 defines another argument (by its number) which this argument requires to be output if it is itself output.
24131 \begin_inset space \thinspace{}
24135 in \SpecialChar LaTeX
24137 optional arguments often require previous optional arguments to be output (at least empty),
24139 \begin_inset Flex Code
24142 \begin_layout Plain Layout
24144 \change_inserted -584632292 1615846730
24147 command[][argument]{text}
24155 This can be achieved by the statement
24156 \begin_inset Flex Code
24159 \begin_layout Plain Layout
24161 \change_inserted -584632292 1615846730
24170 \begin_inset Flex Code
24173 \begin_layout Plain Layout
24175 \change_inserted -584632292 1615846730
24186 \begin_layout Itemize
24188 \change_inserted -584632292 1615846730
24189 \begin_inset Flex Code
24192 \begin_layout Plain Layout
24194 \change_inserted -584632292 1615846730
24203 \begin_inset Flex Code
24206 \begin_layout Plain Layout
24208 \change_inserted -584632292 1615846730
24216 defines a custom left delimiter (instead of
24217 \begin_inset Flex Code
24220 \begin_layout Plain Layout
24222 \change_inserted -584632292 1615846730
24231 \begin_inset Flex Code
24234 \begin_layout Plain Layout
24236 \change_inserted -584632292 1615846730
24245 A line break in the output can be indicated by
24246 \begin_inset Flex Code
24249 \begin_layout Plain Layout
24251 \change_inserted -584632292 1615846730
24262 \begin_layout Itemize
24264 \change_inserted -584632292 1615846730
24265 \begin_inset Flex Code
24268 \begin_layout Plain Layout
24270 \change_inserted -584632292 1615846730
24279 \begin_inset Flex Code
24282 \begin_layout Plain Layout
24284 \change_inserted -584632292 1615846730
24292 defines a custom right delimiter (instead of
24293 \begin_inset Flex Code
24296 \begin_layout Plain Layout
24298 \change_inserted -584632292 1615846730
24307 \begin_inset Flex Code
24310 \begin_layout Plain Layout
24312 \change_inserted -584632292 1615846730
24321 A line break in the output can be indicated by
24322 \begin_inset Flex Code
24325 \begin_layout Plain Layout
24327 \change_inserted -584632292 1615846730
24338 \begin_layout Itemize
24340 \change_inserted -584632292 1615846730
24341 \begin_inset Flex Code
24344 \begin_layout Plain Layout
24346 \change_inserted -584632292 1615846730
24355 \begin_inset Flex Code
24358 \begin_layout Plain Layout
24360 \change_inserted -584632292 1615846730
24368 defines an argument that is inserted if and only if no user-specified arguments were given,
24370 \begin_inset space \thinspace{}
24374 \begin_inset space \space{}
24377 if no argument inset has been inserted (note that also an empty argument inset omits the DefaultArg).
24378 Multiple arguments need to be separated by comma.
24381 \begin_layout Itemize
24383 \change_inserted -584632292 1615846730
24384 \begin_inset Flex Code
24387 \begin_layout Plain Layout
24389 \change_inserted -584632292 1615846730
24398 \begin_inset Flex Code
24401 \begin_layout Plain Layout
24403 \change_inserted -584632292 1615846730
24411 defines an argument that is inserted in any case (alone or in addition to user-specified arguments).
24412 Multiple arguments need to be separated by comma.
24415 \begin_layout Itemize
24417 \change_inserted -584632292 1615846730
24418 \begin_inset Flex Code
24421 \begin_layout Plain Layout
24423 \change_inserted -584632292 1615846730
24431 The font used for the argument content,
24433 \begin_inset CommandInset ref
24435 reference "subsec:Font-description"
24443 \begin_layout Itemize
24445 \change_inserted -584632292 1615846730
24446 \begin_inset Flex Code
24449 \begin_layout Plain Layout
24451 \change_inserted -584632292 1615846730
24460 \begin_inset Flex Code
24463 \begin_layout Plain Layout
24465 \change_inserted -584632292 1615846730
24476 \begin_inset space \thinspace{}
24480 \begin_inset Flex Code
24483 \begin_layout Plain Layout
24485 \change_inserted -584632292 1615846730
24493 ] As with paragraph styles,
24495 \begin_inset CommandInset ref
24497 reference "subsec:Paragraph-Styles"
24505 \begin_layout Itemize
24507 \change_inserted -584632292 1615846730
24508 \begin_inset Flex Code
24511 \begin_layout Plain Layout
24513 \change_inserted -584632292 1615846730
24521 The font used for the label;
24523 \begin_inset CommandInset ref
24525 reference "subsec:Font-description"
24533 \begin_layout Itemize
24535 \change_inserted -584632292 1615846730
24536 \begin_inset Flex Code
24539 \begin_layout Plain Layout
24541 \change_inserted -584632292 1615846730
24550 \begin_inset Flex Code
24553 \begin_layout Plain Layout
24555 \change_inserted -584632292 1615846730
24569 ] describes the rendering style used for the inset's frame and buttons.
24572 \begin_layout Itemize
24574 \change_inserted -584632292 1615846730
24575 \begin_inset Flex Code
24578 \begin_layout Plain Layout
24580 \change_inserted -584632292 1615846730
24589 \begin_inset Flex Code
24592 \begin_layout Plain Layout
24594 \change_inserted -584632292 1615846730
24603 \begin_inset Flex Code
24606 \begin_layout Plain Layout
24608 \change_inserted -584632292 1615846730
24617 this argument is automatically inserted when the respective style is selected.
24620 \begin_layout Itemize
24622 \change_inserted -584632292 1615846730
24623 \begin_inset Flex Code
24626 \begin_layout Plain Layout
24628 \change_inserted -584632292 1615846730
24637 \begin_inset Flex Code
24640 \begin_layout Plain Layout
24642 \change_inserted -584632292 1615846730
24651 \begin_inset Flex Code
24654 \begin_layout Plain Layout
24656 \change_inserted -584632292 1615846730
24665 this argument will be inserted on a new line with
24666 \begin_inset Flex Code
24669 \begin_layout Plain Layout
24671 \change_inserted -584632292 1615846730
24679 (only available within Flex insets).
24682 \begin_layout Itemize
24684 \change_inserted -584632292 1615846730
24685 \begin_inset Flex Code
24688 \begin_layout Plain Layout
24690 \change_inserted -584632292 1615846730
24699 \begin_inset Flex Code
24702 \begin_layout Plain Layout
24704 \change_inserted -584632292 1615846730
24713 \begin_inset Flex Code
24716 \begin_layout Plain Layout
24718 \change_inserted -584632292 1615846730
24727 this argument will be inserted with a copy of the co-text (either selected text or the whole paragraph) as content.
24730 \begin_layout Itemize
24732 \change_inserted -584632292 1615846730
24733 \begin_inset Flex Code
24736 \begin_layout Plain Layout
24738 \change_inserted -584632292 1615846730
24747 \begin_inset Flex Code
24750 \begin_layout Plain Layout
24752 \change_inserted -584632292 1615846730
24766 ] Whether the contents of this argument should be output in raw form,
24767 meaning without special translations that \SpecialChar LaTeX
24771 \begin_inset Flex Code
24774 \begin_layout Plain Layout
24776 \change_inserted -584632292 1615846730
24784 status is inherited by the inset or paragraph layout the argument belongs to,
24785 true and false change the status for the given argument only.
24788 \begin_layout Itemize
24790 \change_inserted -584632292 1615846730
24791 \begin_inset Flex Code
24794 \begin_layout Plain Layout
24796 \change_inserted -584632292 1615846730
24805 \begin_inset Flex Code
24808 \begin_layout Plain Layout
24810 \change_inserted -584632292 1615846730
24811 string of characters
24822 Defines individual characters
24823 \begin_inset Newline linebreak
24826 that should be output in raw form,
24827 meaning without special translations that \SpecialChar LaTeX
24830 contrary to PassThru,
24831 this needs to be explicitly defined for arguments.
24833 arguments do not inherit PassThruChars from their parent inset or layout.
24836 \begin_layout Itemize
24838 \change_inserted -584632292 1615846730
24839 \begin_inset Flex Code
24842 \begin_layout Plain Layout
24844 \change_inserted -584632292 1615846730
24853 \begin_inset Flex Code
24856 \begin_layout Plain Layout
24858 \change_inserted -584632292 1615846730
24869 \begin_inset space \thinspace{}
24873 \begin_inset Flex Code
24876 \begin_layout Plain Layout
24878 \change_inserted -584632292 1615846730
24886 ] If this is set to 1,
24887 the argument will output its content in the corresponding item in the table of contents.
24891 \begin_layout Standard
24893 \change_inserted -584632292 1615846730
24895 the text entered in the \SpecialChar LyX
24896 workarea in the respective layout is the last (mandatory) argument of a command if the
24897 \begin_inset Flex Code
24900 \begin_layout Plain Layout
24902 \change_inserted -584632292 1615846730
24911 \begin_inset Flex Code
24914 \begin_layout Plain Layout
24916 \change_inserted -584632292 1615846730
24926 arguments with the prefix
24927 \begin_inset Flex Code
24930 \begin_layout Plain Layout
24932 \change_inserted -584632292 1615846730
24940 are output after this workarea argument.
24941 Note that post-argument numbering restarts at 1,
24942 so the first argument following the workarea argument is
24943 \begin_inset Flex Code
24946 \begin_layout Plain Layout
24948 \change_inserted -584632292 1615846730
24957 Post-arguments are ignored in any other
24958 \begin_inset Flex Code
24961 \begin_layout Plain Layout
24963 \change_inserted -584632292 1615846730
24972 \begin_inset Flex Code
24975 \begin_layout Plain Layout
24977 \change_inserted -584632292 1615846730
24988 \begin_layout Standard
24990 \change_inserted -584632292 1615846730
24992 \begin_inset Flex Code
24995 \begin_layout Plain Layout
24997 \change_inserted -584632292 1615846730
25008 \begin_inset Flex Code
25011 \begin_layout Plain Layout
25013 \change_inserted -584632292 1615846730
25024 \begin_inset Flex Code
25027 \begin_layout Plain Layout
25029 \change_inserted -584632292 1615846730
25037 followed by the number (e.
25038 \begin_inset space \thinspace{}
25042 \begin_inset space \space{}
25046 \begin_inset Flex Code
25049 \begin_layout Plain Layout
25051 \change_inserted -584632292 1615846730
25062 \begin_layout Standard
25064 \change_inserted -584632292 1615846730
25066 there is a special argument type with the prefix
25067 \begin_inset Flex Code
25070 \begin_layout Plain Layout
25072 \change_inserted -584632292 1615846730
25081 It is not really an argument,
25082 but uses the argument interface (thus,
25083 the prefix is also followed by a number,
25085 \begin_inset space \thinspace{}
25090 \begin_inset Flex Code
25093 \begin_layout Plain Layout
25095 \change_inserted -584632292 1615846730
25096 Argument listpreamble:1
25104 As the name implies,
25105 it is targeted at lists such as
25125 Its content will be output at the list start,
25127 \begin_inset Flex Code
25130 \begin_layout Plain Layout
25132 \change_inserted -584632292 1615846730
25143 on an own line (a place that is otherwise not accessible in \SpecialChar LyX
25146 users can insert redefinitions (of lengths etc.) to individual lists.
25148 these arguments do not have a delimiter.
25153 \begin_layout Subsection
25155 \begin_inset CommandInset label
25157 name "subsec:Counters"
25164 \begin_layout Standard
25165 It is necessary to define the counters (
25166 \begin_inset Flex Noun
25169 \begin_layout Plain Layout
25177 \begin_inset Flex Noun
25180 \begin_layout Plain Layout
25188 ) in the text class itself.
25189 The standard counters are defined in the file
25190 \begin_inset Flex Code
25193 \begin_layout Plain Layout
25200 so you may have to do no more than add
25203 \begin_layout LyX-Code
25204 Input stdcounters.inc
25207 \begin_layout Standard
25208 to your layout file to get them to work.
25209 But if you want to define custom counters,
25210 then you can do so.
25211 The counter declaration must begin with:
25214 \begin_layout LyX-Code
25215 Counter CounterName
25218 \begin_layout Standard
25220 \begin_inset Flex Code
25223 \begin_layout Plain Layout
25229 ' is replaced by the name of the counter.
25230 And it must end with
25231 \begin_inset Quotes eld
25235 \begin_inset Flex Code
25238 \begin_layout Plain Layout
25245 \begin_inset Quotes erd
25249 The following parameters can also be used:
25252 \begin_layout Description
25253 \begin_inset Flex Code
25256 \begin_layout Plain Layout
25263 \begin_inset Flex Code
25266 \begin_layout Plain Layout
25272 ] Sets the initial value for the counter,
25273 to which it will be reset whenever that happens.
25275 one will want the default,
25279 \begin_layout Description
25280 \begin_inset Flex Code
25283 \begin_layout Plain Layout
25290 \begin_inset Flex Code
25293 \begin_layout Plain Layout
25300 \begin_inset Quotes erd
25304 \begin_inset Quotes erd
25308 this string defines how the counter is displayed.
25309 Setting this value sets
25310 \begin_inset Flex Code
25313 \begin_layout Plain Layout
25314 LabelStringAppendix
25320 The following special constructs can be used in the string:
25324 \begin_layout Itemize
25325 \begin_inset Flex Code
25328 \begin_layout Plain Layout
25336 will be replaced by the expansion of the
25337 \begin_inset Flex Code
25340 \begin_layout Plain Layout
25347 \begin_inset Flex Code
25350 \begin_layout Plain Layout
25351 LabelStringAppendix
25357 \begin_inset Flex Code
25360 \begin_layout Plain Layout
25370 \begin_layout Itemize
25371 counter values can be expressed using \SpecialChar LaTeX
25373 \begin_inset Newline newline
25377 \begin_inset Flex Code
25380 \begin_layout Plain Layout
25398 \begin_inset Flex Code
25401 \begin_layout Plain Layout
25413 \begin_layout Plain Layout
25424 the situation is a bit more complicated:
25444 other than those described below will produce arabic numerals.
25445 It would not be surprising to see this change in the future.
25451 \begin_inset Flex Code
25454 \begin_layout Plain Layout
25463 3,\SpecialChar ldots
25466 \begin_inset Flex Code
25469 \begin_layout Plain Layout
25475 for lower-case letters:
25482 \begin_inset Flex Code
25485 \begin_layout Plain Layout
25491 for upper-case letters:
25498 \begin_inset Flex Code
25501 \begin_layout Plain Layout
25507 for lower-case roman numerals:
25514 \begin_inset Flex Code
25517 \begin_layout Plain Layout
25523 for upper-case roman numerals:
25526 III\SpecialChar ldots
25529 \begin_inset Flex Code
25532 \begin_layout Plain Layout
25538 for hebrew numerals.
25542 \begin_layout Standard
25543 If LabelString is not defined,
25544 a default value is constructed as follows:
25545 if the counter has a
25546 \change_deleted 731793113 1604355218
25548 \change_inserted 731793113 1604355221
25552 \begin_inset Flex Code
25555 \begin_layout Plain Layout
25557 \change_deleted 731793113 1604355223
25559 \change_inserted 731793113 1604355226
25568 \begin_inset Flex Code
25571 \begin_layout Plain Layout
25579 \begin_inset Newline newline
25583 \begin_inset Flex Code
25586 \begin_layout Plain Layout
25590 \change_inserted 731793113 1604355228
25592 \change_deleted 731793113 1604355230
25603 otherwise the string
25604 \begin_inset Flex Code
25607 \begin_layout Plain Layout
25618 \begin_layout Description
25619 \begin_inset Flex Code
25622 \begin_layout Plain Layout
25623 LabelStringAppendix
25629 \begin_inset Flex Code
25632 \begin_layout Plain Layout
25639 \begin_inset Quotes eld
25643 \begin_inset Quotes erd
25647 \begin_inset Flex Code
25650 \begin_layout Plain Layout
25657 but for use in the Appendix.
25658 \change_inserted -584632292 1607202551
25662 \begin_layout Description
25664 \change_inserted -584632292 1607202682
25665 \begin_inset Flex Code
25668 \begin_layout Plain Layout
25675 \begin_inset Flex Code
25678 \begin_layout Plain Layout
25680 \change_inserted -584632292 1607202576
25689 \begin_inset Quotes eld
25693 \begin_inset Quotes erd
25696 ] The counter name as used in \SpecialChar LaTeX
25699 \change_inserted 34634807 1619711355
25701 \change_deleted 34634807 1619711355
25703 \change_inserted -584632292 1607202682
25705 in \SpecialChar LyX
25707 there is a counter named `theorem',
25708 but it is output to \SpecialChar LaTeX
25714 \begin_layout Description
25715 \begin_inset Flex Code
25718 \begin_layout Plain Layout
25725 \begin_inset Flex Code
25728 \begin_layout Plain Layout
25735 \begin_inset Quotes erd
25739 \begin_inset Quotes erd
25742 ] A format for use with formatted references to this counter.
25744 one might want to have references to section numbers appear as
25745 \begin_inset Quotes eld
25749 \begin_inset Quotes erd
25753 The string should contain
25754 \begin_inset Quotes eld
25758 \begin_inset Quotes erd
25762 This will be replaced by the counter number itself.
25769 \begin_layout Description
25770 \begin_inset Flex Code
25773 \begin_layout Plain Layout
25780 \begin_inset Flex Code
25783 \begin_layout Plain Layout
25790 \begin_inset Quotes erd
25794 \begin_inset Quotes erd
25797 ] If this is set to the name of another counter,
25798 the present counter will be reset every time the other one is increased.
25801 \begin_inset Flex Code
25804 \begin_layout Plain Layout
25811 \begin_inset Flex Code
25814 \begin_layout Plain Layout
25823 \begin_layout Subsection
25825 \begin_inset CommandInset label
25827 name "subsec:Font-description"
25834 \begin_layout Standard
25835 A font description looks like this:
25838 \begin_layout LyX-Code
25855 \begin_layout LyX-Code
25859 \begin_layout LyX-Code
25863 \begin_layout Standard
25864 The following commands are available:
25867 \begin_layout Description
25868 \begin_inset Flex Code
25871 \begin_layout Plain Layout
25878 \change_deleted -712698321 1607682984
25880 \begin_inset Flex Code
25883 \begin_layout Plain Layout
25893 \begin_inset Flex Code
25896 \begin_layout Plain Layout
25904 \begin_inset Flex Code
25907 \begin_layout Plain Layout
25915 \begin_inset Flex Code
25918 \begin_layout Plain Layout
25926 \begin_inset Flex Code
25929 \begin_layout Plain Layout
25937 \begin_inset Flex Code
25940 \begin_layout Plain Layout
25948 \begin_inset Flex Code
25951 \begin_layout Plain Layout
25959 \begin_inset Flex Code
25962 \begin_layout Plain Layout
25970 \begin_inset Flex Code
25973 \begin_layout Plain Layout
25981 \begin_inset Flex Code
25984 \begin_layout Plain Layout
25992 \begin_inset Flex Code
25995 \begin_layout Plain Layout
26003 \begin_inset Flex Code
26006 \begin_layout Plain Layout
26014 \begin_inset Flex Code
26017 \begin_layout Plain Layout
26025 \begin_inset Flex Code
26028 \begin_layout Plain Layout
26036 \begin_inset Flex Code
26039 \begin_layout Plain Layout
26047 \begin_inset Flex Code
26050 \begin_layout Plain Layout
26058 \begin_inset Flex Code
26061 \begin_layout Plain Layout
26069 \begin_inset Flex Code
26072 \begin_layout Plain Layout
26080 \begin_inset Flex Code
26083 \begin_layout Plain Layout
26091 \begin_inset Flex Code
26094 \begin_layout Plain Layout
26101 \change_inserted -712698321 1607683139
26103 \begin_inset Flex Code
26106 \begin_layout Plain Layout
26108 \change_inserted -712698321 1607683135
26117 \begin_inset space ~
26121 \begin_inset CommandInset ref
26123 reference "chap:Names-of-colors"
26132 \change_deleted -712698321 1607683144
26134 \change_inserted -712698321 1607683146
26140 \begin_layout Description
26141 \begin_inset Flex Code
26144 \begin_layout Plain Layout
26151 \begin_inset Flex Code
26154 \begin_layout Plain Layout
26164 \begin_inset Flex Code
26167 \begin_layout Plain Layout
26175 \begin_inset Flex Code
26178 \begin_layout Plain Layout
26187 \begin_layout Description
26188 \begin_inset Flex Code
26191 \begin_layout Plain Layout
26198 \begin_inset Flex Code
26201 \begin_layout Plain Layout
26207 ] Valid arguments are:
26209 \begin_inset Flex Code
26212 \begin_layout Plain Layout
26220 \begin_inset Flex Code
26223 \begin_layout Plain Layout
26231 \begin_inset Flex Code
26234 \begin_layout Plain Layout
26242 \begin_inset Flex Code
26245 \begin_layout Plain Layout
26253 \begin_inset Flex Code
26256 \begin_layout Plain Layout
26264 \begin_inset Flex Code
26267 \begin_layout Plain Layout
26275 \begin_inset Flex Code
26278 \begin_layout Plain Layout
26286 \begin_inset Flex Code
26289 \begin_layout Plain Layout
26297 \begin_inset Flex Code
26300 \begin_layout Plain Layout
26308 \begin_inset Flex Code
26311 \begin_layout Plain Layout
26319 \begin_inset Flex Code
26322 \begin_layout Plain Layout
26329 \begin_inset Flex Code
26332 \begin_layout Plain Layout
26339 Each of these turns on or off the corresponding attribute.
26342 \begin_inset Flex Code
26345 \begin_layout Plain Layout
26353 \begin_inset Flex Code
26356 \begin_layout Plain Layout
26364 \begin_inset Newline newline
26367 If the latter seems puzzling,
26368 remember that the font settings for the present context are generally inherited from the surrounding context.
26370 \begin_inset Flex Code
26373 \begin_layout Plain Layout
26379 would turn off the emphasis that was anyway in effect,
26381 in a theorem environment.
26384 \begin_layout Description
26385 \begin_inset Flex Code
26388 \begin_layout Plain Layout
26395 \begin_inset Flex Code
26398 \begin_layout Plain Layout
26408 \begin_inset Flex Code
26411 \begin_layout Plain Layout
26420 \begin_layout Description
26421 \begin_inset Flex Code
26424 \begin_layout Plain Layout
26431 \begin_inset Flex Code
26434 \begin_layout Plain Layout
26444 \begin_inset Flex Code
26447 \begin_layout Plain Layout
26455 \begin_inset Flex Code
26458 \begin_layout Plain Layout
26466 \begin_inset Flex Code
26469 \begin_layout Plain Layout
26478 \begin_layout Description
26479 \begin_inset Flex Code
26482 \begin_layout Plain Layout
26489 \begin_inset Flex Code
26492 \begin_layout Plain Layout
26500 \begin_inset Flex Code
26503 \begin_layout Plain Layout
26511 \begin_inset Flex Code
26514 \begin_layout Plain Layout
26524 \begin_inset Flex Code
26527 \begin_layout Plain Layout
26535 \begin_inset Flex Code
26538 \begin_layout Plain Layout
26546 \begin_inset Flex Code
26549 \begin_layout Plain Layout
26557 \begin_inset Flex Code
26560 \begin_layout Plain Layout
26568 \begin_inset Flex Code
26571 \begin_layout Plain Layout
26580 \begin_layout Subsection
26581 \begin_inset CommandInset label
26583 name "subsec:Citation-engine-description"
26587 Cite engine description
26590 \begin_layout Standard
26592 \begin_inset Flex Code
26595 \begin_layout Plain Layout
26602 as used mainly in cite engine files (see
26603 \begin_inset CommandInset ref
26605 reference "subsec:Cite-Engine-Files"
26614 define the citation commands provided by a specific
26615 \begin_inset Quotes eld
26619 \begin_inset Quotes erd
26624 in \SpecialChar LyX
26626 is way specific way to format citations,
26628 author names and/or years.
26631 supports three such engine types,
26635 \begin_layout Enumerate
26636 \begin_inset Flex Code
26639 \begin_layout Plain Layout
26646 the default Bib\SpecialChar TeX
26647 way to format citations,
26648 a simple numeric style (e.
26649 \begin_inset space \thinspace{}
26654 \begin_inset Quotes eld
26658 \begin_inset Quotes erd
26664 \begin_layout Enumerate
26665 \begin_inset Flex Code
26668 \begin_layout Plain Layout
26675 Harvard-styled citations using author names and publication year (e.
26676 \begin_inset space \thinspace{}
26681 \begin_inset Quotes eld
26684 Smith and Miller (2017b)
26685 \begin_inset Quotes erd
26691 \begin_layout Enumerate
26692 \begin_inset Flex Code
26695 \begin_layout Plain Layout
26702 extended numerical citations that also allow for author or title next to the number (e.
26703 \begin_inset space \thinspace{}
26708 \begin_inset Quotes eld
26711 Smith and Miller [1]
26712 \begin_inset Quotes erd
26718 \begin_layout Standard
26719 \begin_inset Flex Code
26722 \begin_layout Plain Layout
26728 blocks look like this:
26731 \begin_layout LyX-Code
26735 \begin_layout LyX-Code
26739 \begin_layout LyX-Code
26743 \begin_layout LyX-Code
26744 citeyearpar[][]=parencite*
26747 \begin_layout LyX-Code
26751 \begin_layout LyX-Code
26755 \begin_layout Standard
26757 \begin_inset Flex Code
26760 \begin_layout Plain Layout
26766 denotes the engine.
26767 The individual lines respectively define a cite command or cite command paradigm supported by this engine.
26768 The line can be as simple as a cite command that is used both to name the respective \SpecialChar LyX
26769 command and the \SpecialChar LaTeX
26770 output or more complex in order to differentiate things.
26771 The full syntax is:
26774 \begin_layout LyX-Code
26775 LyXName|alias$*<!_stardesc!_stardesctooltip>[][]=latexcmd
26778 \begin_layout Itemize
26779 \begin_inset Flex Code
26782 \begin_layout Plain Layout
26789 The name as used in the
26790 \begin_inset Flex Code
26793 \begin_layout Plain Layout
26803 \begin_layout Standard
26804 For portability reasons,
26805 we try to use the same name for same-formatted commands in different cite packages (thus many names stem from natbib,
26806 and thus we need to differentiate a
26807 \begin_inset Flex Code
26810 \begin_layout Plain Layout
26817 if the \SpecialChar LaTeX
26818 command names differ).
26822 \begin_layout Itemize
26823 \begin_inset Flex Code
26826 \begin_layout Plain Layout
26833 a (comma-separated) list of commands that fall back to the given
26834 \begin_inset Flex Code
26837 \begin_layout Plain Layout
26843 in the current engine.
26844 This eases the switch of citation packages and engines.
26846 \begin_inset Flex Code
26849 \begin_layout Plain Layout
26856 \begin_inset Flex Code
26859 \begin_layout Plain Layout
26865 in layout definitions.
26868 \begin_layout Itemize
26869 \begin_inset Flex Code
26872 \begin_layout Plain Layout
26879 The actual \SpecialChar LaTeX
26880 command that is output.
26884 \begin_layout Standard
26885 \begin_inset Flex Code
26888 \begin_layout Plain Layout
26895 \begin_inset Flex Code
26898 \begin_layout Plain Layout
26906 \begin_inset Flex Code
26909 \begin_layout Plain Layout
26917 \begin_inset Flex Code
26920 \begin_layout Plain Layout
26926 will be output to \SpecialChar LaTeX
26930 \begin_layout Standard
26934 \begin_layout Itemize
26935 Capitalization indicates that the command also has a capitalized form (
26936 \begin_inset Flex Code
26939 \begin_layout Plain Layout
26949 \begin_inset Flex Code
26952 \begin_layout Plain Layout
26961 These usually enforce up-casing of name prefixes (
26966 \begin_inset Formula $\Rightarrow$
26976 \begin_layout Itemize
26978 \begin_inset Flex Code
26981 \begin_layout Plain Layout
26987 indicate the number of optional arguments (there can be 0–2).
26990 \begin_layout Itemize
26992 \begin_inset Flex Code
26995 \begin_layout Plain Layout
27001 indicates there is a starred version of the command (
27002 \begin_inset Flex Code
27005 \begin_layout Plain Layout
27015 \begin_inset Flex Code
27018 \begin_layout Plain Layout
27031 \begin_layout Standard
27033 the starred version means:
27034 Output all authors even if it should be shortened with
27035 \begin_inset Quotes eld
27039 \begin_inset Quotes erd
27043 \begin_inset Flex Code
27046 \begin_layout Plain Layout
27055 \begin_layout Standard
27056 If the star has a different meaning for a given command,
27057 it can be specified in angle brackets:
27059 \begin_inset Flex Code
27062 \begin_layout Plain Layout
27063 <!_stardesc!_stardesctooltip>
27069 Maximal two translatable macro keywords,
27070 marked by the prefix
27071 \begin_inset Flex Code
27074 \begin_layout Plain Layout
27082 The first points to the string that replaces the
27083 \begin_inset Quotes eld
27087 \begin_inset Quotes erd
27090 checkbox label in the citation dialog,
27091 the second one to an optional tool tip for this checkbox.
27095 \begin_layout Standard
27096 Note that these two macros have to be defined in a
27097 \begin_inset Flex Code
27100 \begin_layout Plain Layout
27106 (see next section),
27108 \begin_inset Flex Code
27111 \begin_layout Plain Layout
27122 \begin_layout LyX-Code
27123 _stardesc Sta&rred command label
27126 \begin_layout LyX-Code
27127 _stardesctooltip Tooltip for the starred command checkbox.
27131 \begin_layout Itemize
27133 \begin_inset Flex Code
27136 \begin_layout Plain Layout
27142 indicates that this command features
27143 \begin_inset Quotes eld
27146 qualified citation lists
27147 \begin_inset Quotes erd
27155 -specific feature for multi-reference citations where an individual pre- and postnote can be given to each reference in the list.
27156 Please refer to the
27160 manual for details.
27161 \change_inserted -712698321 1526898670
27165 \begin_layout Standard
27167 \change_inserted -712698321 1526899524
27168 If you want to add a cite command to a cite engine (e.
27169 \begin_inset space \thinspace{}
27173 add a specific command provided by a class),
27175 \begin_inset Flex Code
27178 \begin_layout Plain Layout
27180 \change_inserted -712698321 1526898768
27181 AddToCiteEngine <engine type> \SpecialChar ldots
27190 Note that only cite commands that do not exist yet are added.
27195 \begin_layout Subsection
27196 \begin_inset CommandInset label
27198 name "subsec:Citation-format-description"
27202 Cite format description
27205 \begin_layout Standard
27207 \begin_inset Flex Code
27210 \begin_layout Plain Layout
27216 blocks are used to describe how bibliographic information should be displayed,
27217 both within \SpecialChar LyX
27218 itself (in the citation dialog and in tooltips,
27219 for example) and in XHTML output.
27220 Such a block might look like this:
27223 \begin_layout LyX-Code
27227 \begin_layout LyX-Code
27231 \begin_layout LyX-Code
27235 \begin_layout LyX-Code
27239 \begin_layout Standard
27243 \begin_layout LyX-Code
27247 \begin_layout LyX-Code
27251 \begin_layout LyX-Code
27255 \begin_layout LyX-Code
27259 \begin_layout Standard
27261 the individual lines define how the bibliographic information associated with an article or book,
27263 is to be displayed,
27264 and such a definition can be given for any
27265 \begin_inset Quotes els
27269 \begin_inset Quotes ers
27272 that might be present in a Bib\SpecialChar TeX
27275 defines a default format in the source code that will be used if no specific definition has been given.
27277 predefines several formats in the file
27278 \begin_inset Flex Code
27281 \begin_layout Plain Layout
27288 which is included in most of \SpecialChar LyX
27289 's document classes.
27292 \begin_layout Standard
27293 In the second case,
27294 the lines define how a specific citation command (in the example
27295 \begin_inset Flex Code
27298 \begin_layout Plain Layout
27308 \begin_inset Flex Code
27311 \begin_layout Plain Layout
27319 ) is to be displayed on the citation inset label,
27320 in the citation dialog,
27321 menu or XHTML output.
27323 defines such formats for the citation style variants it supports via
27325 Document\SpecialChar menuseparator
27326 Setting\SpecialChar menuseparator
27327 Bibliography\SpecialChar ldots
27331 \begin_inset Flex Code
27334 \begin_layout Plain Layout
27340 files that are shipped with \SpecialChar LyX
27342 \begin_inset CommandInset ref
27344 reference "subsec:Cite-Engine-Files"
27355 \begin_layout Standard
27356 The definitions use a simple language that allows Bib\SpecialChar TeX
27357 keys to be replaced with their values.
27358 Keys should be enclosed in
27359 \begin_inset Flex Code
27362 \begin_layout Plain Layout
27371 \begin_inset Flex Code
27374 \begin_layout Plain Layout
27381 So a simple definition might look like this:
27384 \begin_layout LyX-Code
27387 \begin_inset Quotes eld
27391 \begin_inset Quotes erd
27397 \begin_layout Standard
27398 This would print the author,
27399 followed by a comma,
27400 followed by the title,
27402 followed by a period.
27405 \begin_layout Standard
27407 sometimes you may want to print a key only if it exists.
27408 This can be done by using a conditional construction,
27411 \begin_inset Flex Code
27414 \begin_layout Plain Layout
27416 \begin_inset space ~
27427 \begin_inset Flex Code
27430 \begin_layout Plain Layout
27438 \begin_inset Quotes eld
27442 \begin_inset space ~
27446 \begin_inset Quotes erd
27449 followed by the volume key.
27450 It is also possible to have an else clause in the conditional,
27452 \begin_inset Newline newline
27456 \begin_inset Flex Code
27459 \begin_layout Plain Layout
27460 {%author%[[%author%]][[%editor%,
27467 \begin_inset Newline newline
27472 \begin_inset Flex Code
27475 \begin_layout Plain Layout
27481 key is printed if it exists;
27483 the editor key is printed,
27485 \begin_inset Quotes eld
27489 \begin_inset space ~
27493 \begin_inset Quotes erd
27496 Note that the key is again enclosed in
27497 \begin_inset Flex Code
27500 \begin_layout Plain Layout
27507 the entire conditional is enclosed in braces;
27508 and the if and else clauses are enclosed in double brackets,
27510 \begin_inset Quotes eld
27514 \begin_inset Flex Code
27517 \begin_layout Plain Layout
27524 \begin_inset Quotes eld
27528 \begin_inset Quotes eld
27532 \begin_inset Flex Code
27535 \begin_layout Plain Layout
27542 \begin_inset Quotes erd
27546 There must be no space between any of these.
27549 \begin_layout Standard
27550 Next to the entry keys,
27551 there are some special keys that can be used for these conditionals:
27554 \begin_layout Itemize
27555 \begin_inset Flex Code
27558 \begin_layout Plain Layout
27559 {%dialog%[[true]][[false]]}
27566 \begin_inset Quotes eld
27570 \begin_inset Quotes erd
27573 part for dialogs and menus,
27575 \begin_inset Quotes eld
27579 \begin_inset Quotes erd
27582 part for other contexts (workarea,
27586 \begin_layout Itemize
27587 \begin_inset Flex Code
27590 \begin_layout Plain Layout
27591 {%export%[[true]][[false]]}
27598 \begin_inset Quotes eld
27602 \begin_inset Quotes erd
27605 part for export and menus,
27607 \begin_inset Quotes eld
27611 \begin_inset Quotes erd
27614 part for other contexts (workarea,
27618 \begin_layout Itemize
27619 \begin_inset Flex Code
27622 \begin_layout Plain Layout
27630 \begin_inset Quotes eld
27634 \begin_inset Quotes erd
27637 part if another item follows (e.
27638 \begin_inset space \thinspace{}
27642 in a citation with multiple keys)
27645 \begin_layout Itemize
27646 \begin_inset Flex Code
27649 \begin_layout Plain Layout
27650 {%second%[[true]][[false]]}
27657 \begin_inset Quotes eld
27661 \begin_inset Quotes erd
27664 if this is the second of multiple items,
27666 \begin_inset Quotes eld
27670 \begin_inset Quotes erd
27676 \begin_layout Itemize
27677 \begin_inset Flex Code
27680 \begin_layout Plain Layout
27681 {%ifstar%[[true]][[false]]}
27688 \begin_inset Quotes eld
27692 \begin_inset Quotes erd
27695 part for starred citation commands (such as
27696 \begin_inset Flex Code
27699 \begin_layout Plain Layout
27708 the false part for unstarred
27711 \begin_layout Itemize
27712 \begin_inset Flex Code
27715 \begin_layout Plain Layout
27716 {%ifentrytype:<type>%[[true]][[false]]}
27723 \begin_inset Quotes eld
27727 \begin_inset Quotes erd
27730 if the current entry type matches
27731 \begin_inset Flex Code
27734 \begin_layout Plain Layout
27741 else the false part (e.g.,
27742 in a citation definition:
27744 \begin_inset Flex Code
27747 \begin_layout Plain Layout
27748 {%ifentrytype:book%[[this is a book]][[this is no book]]}
27756 \begin_layout Itemize
27757 \begin_inset Flex Code
27760 \begin_layout Plain Layout
27761 {%ifmultiple:<authortype>%[[true]][[false]]}
27768 \begin_inset Quotes eld
27772 \begin_inset Quotes erd
27775 if the current author type (author,
27776 editor etc.) has multiple authors,
27777 else the false part (e.g.,
27778 in a bibliography definition:
27780 \begin_inset Flex Code
27783 \begin_layout Plain Layout
27784 {%ifmultiple:editor%[[eds.]][[ed.]]}
27792 \begin_layout Itemize
27793 \begin_inset Flex Code
27796 \begin_layout Plain Layout
27797 {%ifqualified%[[true]][[false]]}
27804 \begin_inset Quotes eld
27808 \begin_inset Quotes erd
27811 part if the current citation is a qualified citation list (a specific
27815 format for multi-reference citations),
27816 the false part if this is not the case.
27819 \begin_layout Standard
27821 \begin_inset Flex Code
27824 \begin_layout Plain Layout
27830 prints the author key as it is recorded in the bibliography file.
27831 This might not be what you want,
27832 since it will result in a string such as
27833 \begin_inset Quotes eld
27840 \begin_inset Quotes erd
27844 \begin_inset Quotes eld
27848 \begin_inset Quotes erd
27851 is used by Bib\SpecialChar TeX
27852 to delimit authors).
27854 therefore provides some methods to get properly formatted name lists (which will also get translated).
27855 The following keys are provided:
27858 \begin_layout Enumerate
27859 For name lists with pre- and surname,
27860 suitable for the main authors/editors of a bibliography item.
27862 \begin_inset Flex Code
27865 \begin_layout Plain Layout
27871 part denotes the kind of list that is requested (e.g.
27873 \begin_inset Flex Code
27876 \begin_layout Plain Layout
27886 \begin_layout Itemize
27887 \begin_inset Flex Code
27890 \begin_layout Plain Layout
27891 %abbrvnames:<nametype>%
27897 Provides a name list which is abbreviated (with
27898 \begin_inset Quotes eld
27902 \begin_inset Quotes erd
27906 \begin_inset Flex Code
27909 \begin_layout Plain Layout
27918 \begin_layout Itemize
27919 \begin_inset Flex Code
27922 \begin_layout Plain Layout
27923 %fullnames:<nametype>%
27929 Provides a full name list (never abbreviated with
27930 \begin_inset Quotes eld
27934 \begin_inset Quotes erd
27940 \begin_layout Itemize
27941 \begin_inset Flex Code
27944 \begin_layout Plain Layout
27945 %forceabbrvnames:<nametype>%
27951 Provides a name list which is always abbreviated (with
27952 \begin_inset Quotes eld
27956 \begin_inset Quotes erd
27960 \begin_inset Flex Code
27963 \begin_layout Plain Layout
27973 \begin_layout Enumerate
27974 Alternative name lists with pre- and surname,
27975 if the order of pre- and surname inside the bibliography item differs (as in:
27977 \begin_inset Quotes eld
27987 \begin_inset Quotes erd
27994 \begin_layout Itemize
27995 \begin_inset Flex Code
27998 \begin_layout Plain Layout
27999 %abbrvbynames:<nametype>%
28005 Provides a name list which is abbreviated (with
28006 \begin_inset Quotes eld
28010 \begin_inset Quotes erd
28014 \begin_inset Flex Code
28017 \begin_layout Plain Layout
28026 \begin_layout Itemize
28027 \begin_inset Flex Code
28030 \begin_layout Plain Layout
28031 %fullbynames:<nametype>%
28037 Provides a full name list (never abbreviated with
28038 \begin_inset Quotes eld
28042 \begin_inset Quotes erd
28048 \begin_layout Itemize
28049 \begin_inset Flex Code
28052 \begin_layout Plain Layout
28053 %forceabbrvbynames:<nametype>%
28059 Provides a name list which is always abbreviated (with
28060 \begin_inset Quotes eld
28064 \begin_inset Quotes erd
28068 \begin_inset Flex Code
28071 \begin_layout Plain Layout
28081 \begin_layout Enumerate
28082 And finally name lists which consist of family names only,
28083 as used in author-year citation labels.
28084 These do not take a
28085 \begin_inset Flex Code
28088 \begin_layout Plain Layout
28095 but always return either an author list or,
28096 if this does not exist,
28097 an editor list (as common in author-year labels):
28101 \begin_layout Itemize
28102 \begin_inset Flex Code
28105 \begin_layout Plain Layout
28112 Provides a name list which is abbreviated (with
28113 \begin_inset Quotes eld
28117 \begin_inset Quotes erd
28121 \begin_inset Flex Code
28124 \begin_layout Plain Layout
28133 \begin_layout Itemize
28134 \begin_inset Flex Code
28137 \begin_layout Plain Layout
28144 Provides a full name list (never abbreviated with
28145 \begin_inset Quotes eld
28149 \begin_inset Quotes erd
28155 \begin_layout Itemize
28156 \begin_inset Flex Code
28159 \begin_layout Plain Layout
28160 %forceabbrvciteauthor%
28166 Provides a name list which is always abbreviated (with
28167 \begin_inset Quotes eld
28171 \begin_inset Quotes erd
28175 \begin_inset Flex Code
28178 \begin_layout Plain Layout
28188 \begin_layout Standard
28189 The order of pre- and surname in the former two lists can be adjusted by these macros:
28192 \begin_layout Itemize
28193 \begin_inset Flex Code
28196 \begin_layout Plain Layout
28197 !firstnameform %surname%,
28203 (first author in lists of type 1)
28206 \begin_layout Itemize
28207 \begin_inset Flex Code
28210 \begin_layout Plain Layout
28211 !othernameform %surname%,
28217 (other authors in lists of type 1)
28220 \begin_layout Itemize
28221 \begin_inset Flex Code
28224 \begin_layout Plain Layout
28225 !firstbynameform %prename% %surname%
28230 (first author in lists of type 2)
28233 \begin_layout Itemize
28234 \begin_inset Flex Code
28237 \begin_layout Plain Layout
28238 !otherbynameform %prename% %surname%
28243 (other authors in lists of type 2)
28246 \begin_layout Standard
28247 This allows you to configure namings like
28248 \begin_inset Quotes eld
28252 Peter and Mary Smith:
28256 John Doe and Pat Green,
28257 eds.:\SpecialChar ldots
28259 \begin_inset Quotes erd
28265 \begin_layout Standard
28266 There is one other piece of syntax available in definitions,
28267 which looks like this:
28269 \begin_inset Flex Code
28272 \begin_layout Plain Layout
28279 This defines a piece of formatting information that is to be used when creating
28280 \begin_inset Quotes eld
28284 \begin_inset Quotes erd
28289 we do not want to output HTML tags when writing plain text,
28290 so they should be wrapped in
28291 \begin_inset Quotes eld
28295 \begin_inset Quotes erd
28299 \begin_inset Quotes eld
28303 \begin_inset Quotes erd
28309 \begin_layout Standard
28310 Two special sorts of definitions are also possible in a
28311 \begin_inset Flex Code
28314 \begin_layout Plain Layout
28321 An example of the first would be:
28324 \begin_layout LyX-Code
28326 \begin_inset Quotes eld
28330 \begin_inset Quotes erd
28336 \begin_layout Standard
28337 This is an abbreviation,
28339 and it can be used by treating it as if it were a key:
28341 \begin_inset Flex Code
28344 \begin_layout Plain Layout
28353 \begin_inset Flex Code
28356 \begin_layout Plain Layout
28362 exactly as it would treat its definition.
28364 let us issue the obvious
28372 \begin_layout LyX-Code
28376 \begin_layout Standard
28377 or anything like it.
28379 shouldn't go into an infinite loop,
28380 but it may go into a long one before it gives up.
28383 \begin_layout Standard
28384 The second sort of special definition might look like this:
28387 \begin_layout LyX-Code
28391 \begin_layout Standard
28392 This defines a translatable piece of text,
28393 which allows relevant parts of the bibliography or citation to be translated.
28394 It can be included in a definition by treating it as a key:
28396 \begin_inset Flex Code
28399 \begin_layout Plain Layout
28406 Note that there are two different translation paths:
28407 All definitions starting with
28408 \begin_inset Flex Code
28411 \begin_layout Plain Layout
28418 such as in the example above,
28419 will be translated to the currently active buffer language (so the translation will match the generated document).
28420 All definitions starting with underscore only will be translated to the GUI language.
28421 This is the proper translation for strings that only occur in the dialogs or on buttons,
28425 \begin_layout LyX-Code
28426 _addtobib Add to bibliography only.
28429 \begin_layout Standard
28430 Several of these translatable strings are predefined in
28431 \begin_inset Flex Code
28434 \begin_layout Plain Layout
28441 \begin_inset Flex Code
28444 \begin_layout Plain Layout
28451 Note that these are not macros,
28452 in the sense just defined.
28453 They will not be expanded.
28456 \begin_layout Standard
28457 So here then is an example that uses several of these features:
28458 \begin_inset VSpace defskip
28464 \begin_layout Standard
28468 !authoredit {%author%[[%author%,
28469 ]][[{%editor%[[%editor%,
28474 \begin_layout Standard
28475 \begin_inset VSpace defskip
28478 This defines a macro that prints the author,
28479 followed by a comma,
28481 \begin_inset Flex Code
28484 \begin_layout Plain Layout
28491 or else prints the name of the editor,
28493 \begin_inset Flex Code
28496 \begin_layout Plain Layout
28502 or its translation (it is by default
28503 \begin_inset Quotes eld
28507 \begin_inset Quotes erd
28512 \begin_inset Flex Code
28515 \begin_layout Plain Layout
28522 Note that this is in fact defined in
28523 \begin_inset Flex Code
28526 \begin_layout Plain Layout
28533 so you can use it in your own definitions,
28535 if you load that file first.
28538 \begin_layout Section
28539 \begin_inset CommandInset label
28541 name "sec:Tags-for-XHTML"
28545 Tags for XHTML output
28548 \begin_layout Standard
28549 As with \SpecialChar LaTeX
28551 the format of \SpecialChar LyX
28552 's XHTML output is also controlled by layout information.
28555 provides sensible defaults and,
28556 as mentioned earlier,
28557 it will even construct default CSS style rules from the other layout tags.
28560 will attempt to use the information provided in the
28561 \begin_inset Flex Code
28564 \begin_layout Plain Layout
28570 declaration for the Chapter style to write CSS that will appropriately format chapter headings.
28573 \begin_layout Standard
28576 you may not have to do anything at all to get acceptable XHTML output for your own environments,
28579 But in some cases you will,
28580 and so \SpecialChar LyX
28581 provides a number of layout tags that can be used to customize the XHTML and CSS that are generated.
28584 \begin_layout Standard
28585 Note that there are two tags,
28587 \begin_inset Flex Code
28590 \begin_layout Plain Layout
28597 \begin_inset Flex Code
28600 \begin_layout Plain Layout
28606 that may appear outside style and inset declarations.
28608 \begin_inset CommandInset ref
28610 reference "subsec:General-text-class"
28615 for details on these.
28618 \begin_layout Subsection
28619 \begin_inset CommandInset label
28621 name "subsec:Paragraph-Style-XHTML"
28628 \begin_layout Standard
28629 The sort of XHTML \SpecialChar LyX
28630 outputs for a paragraph depends upon whether we are dealing with a normal paragraph,
28633 where this is itself determined by the contents of the corresponding
28634 \begin_inset Flex Code
28637 \begin_layout Plain Layout
28648 \begin_layout Standard
28649 For a command or normal paragraph,
28650 the output XHTML has the following form:
28653 \begin_layout LyX-Code
28657 \begin_inset Quotes erd
28661 \begin_inset Quotes erd
28667 \begin_layout LyX-Code
28671 \begin_inset Quotes erd
28675 \begin_inset Quotes erd
28681 \begin_layout LyX-Code
28684 Contents of the paragraph.
28687 \begin_layout LyX-Code
28693 \begin_layout Standard
28694 The label tags are of course omitted if the paragraph does not have a label.
28697 \begin_layout Standard
28698 For an environment that is not some sort of list,
28699 the XHTML takes this form:
28702 \begin_layout LyX-Code
28706 \begin_inset Quotes erd
28710 \begin_inset Quotes erd
28716 \begin_layout LyX-Code
28720 \begin_inset Quotes erd
28724 \begin_inset Quotes erd
28728 \begin_inset Quotes erd
28732 \begin_inset Quotes erd
28735 >Environment Label</labeltag>First paragraph.</itemtag>
28738 \begin_layout LyX-Code
28741 <itemtag>Second paragraph.</itemtag>
28744 \begin_layout LyX-Code
28750 \begin_layout Standard
28751 Note that the label is output only for the first paragraph,
28752 as it should be for a theorem,
28757 \begin_layout Standard
28759 we have one of these forms:
28762 \begin_layout LyX-Code
28766 \begin_inset Quotes erd
28770 \begin_inset Quotes erd
28776 \begin_layout LyX-Code
28780 \begin_inset Quotes erd
28784 \begin_inset Quotes erd
28788 \begin_inset Quotes erd
28792 \begin_inset Quotes erd
28795 >List Label</labeltag>First item.</itemtag>
28798 \begin_layout LyX-Code
28802 \begin_inset Quotes erd
28806 \begin_inset Quotes erd
28810 \begin_inset Quotes erd
28814 \begin_inset Quotes erd
28817 >List Label</labeltag>Second item.</itemtag>
28820 \begin_layout LyX-Code
28826 \begin_layout LyX-Code
28830 \begin_layout LyX-Code
28834 \begin_inset Quotes erd
28838 \begin_inset Quotes erd
28844 \begin_layout LyX-Code
28848 \begin_inset Quotes erd
28852 \begin_inset Quotes erd
28855 >List Label</labeltag><itemtag attr=
28856 \begin_inset Quotes erd
28860 \begin_inset Quotes erd
28863 >First item.</itemtag>
28866 \begin_layout LyX-Code
28870 \begin_inset Quotes erd
28874 \begin_inset Quotes erd
28877 >List Label</labeltag><itemtag attr=
28878 \begin_inset Quotes erd
28882 \begin_inset Quotes erd
28885 >Second item.</itemtag>
28888 \begin_layout LyX-Code
28894 \begin_layout Standard
28895 Note the different orders of
28896 \begin_inset Flex Code
28899 \begin_layout Plain Layout
28906 \begin_inset Flex Code
28909 \begin_layout Plain Layout
28916 Which order we get depends upon the setting of
28917 \begin_inset Flex Code
28920 \begin_layout Plain Layout
28928 \begin_inset Flex Code
28931 \begin_layout Plain Layout
28937 is false (the default),
28938 you get the first of these,
28939 with the label within the item;
28941 you get the second,
28942 with the label outside the item.
28945 \begin_layout Standard
28946 The specific tags and attributes output for each paragraph type can be controlled by means of the layout tags we are about to describe.
28947 As mentioned earlier,
28950 uses sensible defaults for many of these,
28951 so you often may not need to do very much to get good XHTML output.
28952 Think of the available tags as there so you can tweak things to your liking.
28955 \begin_layout Description
28956 \begin_inset Flex Code
28959 \begin_layout Plain Layout
28966 \begin_inset Flex Code
28969 \begin_layout Plain Layout
28975 ] Specifies attribute information to be output with the main tag.
28978 \begin_inset Quotes eld
28982 \begin_inset Flex Code
28985 \begin_layout Plain Layout
28992 \begin_inset Quotes erd
28999 \begin_inset Quotes eld
29003 \begin_inset Flex Code
29006 \begin_layout Plain Layout
29013 \begin_inset Quotes erd
29018 \begin_inset Flex Code
29021 \begin_layout Plain Layout
29027 is the \SpecialChar LyX
29028 name of the layout,
29036 contain any style information.
29038 \begin_inset Flex Code
29041 \begin_layout Plain Layout
29048 \change_inserted -584632292 1670182206
29052 \begin_layout Description
29054 \change_inserted -584632292 1670182369
29055 \begin_inset Flex Code
29058 \begin_layout Plain Layout
29060 \change_inserted -584632292 1670182222
29069 \begin_inset Flex Code
29072 \begin_layout Plain Layout
29074 \change_inserted -584632292 1670182217
29082 ] The CSS class to use for this paragraph.
29084 if the paragarph is of enumerate or itemize type,
29085 then the default will be
29086 \begin_inset Quotes eld
29090 \begin_inset Quotes erd
29094 \begin_inset Quotes eld
29098 \begin_inset Quotes erd
29103 \begin_inset Quotes eld
29107 \begin_inset Quotes erd
29112 \begin_inset Quotes eld
29116 \begin_inset Quotes erd
29121 \begin_inset Quotes eld
29125 \begin_inset Quotes erd
29130 \begin_inset Quotes eld
29134 \begin_inset Quotes erd
29138 depending upon the depth.
29139 That can be over-ridden here.
29141 the suffix will not be added in that case.
29143 the CSS class will always be exactly what it is declared to be here.
29148 \begin_layout Description
29149 \begin_inset Flex Code
29152 \begin_layout Plain Layout
29159 \begin_inset Flex Code
29162 \begin_layout Plain Layout
29172 ] Whether to output the default CSS information \SpecialChar LyX
29173 generates for this layout,
29174 even if additional information is explicitly provided via
29175 \begin_inset Flex Code
29178 \begin_layout Plain Layout
29186 \begin_inset Flex Code
29189 \begin_layout Plain Layout
29195 allows you to alter or augment the generated CSS,
29196 rather than to override it completely.
29198 \begin_inset Flex Code
29201 \begin_layout Plain Layout
29208 \change_inserted -584632292 1670132213
29212 \begin_layout Description
29214 \change_inserted -584632292 1670132277
29215 \begin_inset Flex Code
29218 \begin_layout Plain Layout
29220 \change_inserted -584632292 1670132221
29229 \begin_inset Flex Code
29232 \begin_layout Plain Layout
29234 \change_inserted -584632292 1670132214
29244 ] Whether to include this paragraph (usually,
29245 a section or something of the sort) in the TOC.
29248 so it should be set to false e.g.
29249 \begin_inset space ~
29252 for starred sections.
29257 \begin_layout Description
29258 \begin_inset Flex Code
29261 \begin_layout Plain Layout
29268 \begin_inset Flex Code
29271 \begin_layout Plain Layout
29277 ] The tag to be used for individual paragraphs of environments,
29279 \begin_inset Flex Code
29282 \begin_layout Plain Layout
29288 in the examples above.
29290 \begin_inset Flex Code
29293 \begin_layout Plain Layout
29302 \begin_layout Description
29303 \begin_inset Flex Code
29306 \begin_layout Plain Layout
29313 \begin_inset Flex Code
29316 \begin_layout Plain Layout
29322 ] Attributes for the item tag.
29324 \begin_inset Newline newline
29328 \begin_inset Quotes eld
29332 \begin_inset Flex Code
29335 \begin_layout Plain Layout
29336 class=`layoutname_item'
29342 \begin_inset Quotes erd
29350 contain any style information.
29352 \begin_inset Flex Code
29355 \begin_layout Plain Layout
29364 \begin_layout Description
29365 \begin_inset Flex Code
29368 \begin_layout Plain Layout
29375 \begin_inset Flex Code
29378 \begin_layout Plain Layout
29384 ] The tag to be used for paragraph and item labels,
29386 \begin_inset Flex Code
29389 \begin_layout Plain Layout
29395 in the examples above.
29397 \begin_inset Flex Code
29400 \begin_layout Plain Layout
29408 \begin_inset Flex Code
29411 \begin_layout Plain Layout
29418 \begin_inset Flex Code
29421 \begin_layout Plain Layout
29428 \begin_inset Flex Code
29431 \begin_layout Plain Layout
29432 Centered_Top_Environment
29438 in which case it defaults to
29439 \begin_inset Flex Code
29442 \begin_layout Plain Layout
29451 \begin_layout Description
29452 \begin_inset Flex Code
29455 \begin_layout Plain Layout
29462 \begin_inset Flex Code
29465 \begin_layout Plain Layout
29471 ] Attributes for the label tag.
29473 \begin_inset Newline newline
29477 \begin_inset Quotes eld
29481 \begin_inset Flex Code
29484 \begin_layout Plain Layout
29485 class=`layoutname_label'
29491 \begin_inset Quotes erd
29499 contain any style information.
29501 \begin_inset Flex Code
29504 \begin_layout Plain Layout
29513 \begin_layout Description
29514 \begin_inset Flex Code
29517 \begin_layout Plain Layout
29524 \begin_inset Flex Code
29527 \begin_layout Plain Layout
29537 ] Meaningful only for list-like environments,
29538 this tag controls whether the label tag is output before or inside the item tag.
29541 in the description environment,
29543 \begin_inset Flex Code
29546 \begin_layout Plain Layout
29547 <dt>\SpecialChar ldots
29548 </dt><dd>\SpecialChar ldots
29556 \begin_inset Flex Code
29559 \begin_layout Plain Layout
29566 The label tag is output inside the item tag.
29569 \begin_layout Description
29570 \begin_inset Flex Code
29573 \begin_layout Plain Layout
29579 Information to be output in the
29580 \begin_inset Flex Code
29583 \begin_layout Plain Layout
29589 section when this style is used.
29592 be used to include a
29593 \begin_inset Flex Code
29596 \begin_layout Plain Layout
29603 \begin_inset Flex Code
29606 \begin_layout Plain Layout
29615 \begin_layout Description
29616 \begin_inset Flex Code
29619 \begin_layout Plain Layout
29625 CSS style information to be included when this style is used.
29626 Note that this will automatically be wrapped in a layout-generated
29627 \begin_inset Flex Code
29630 \begin_layout Plain Layout
29637 so only the CSS itself need be included.
29639 \begin_inset Flex Code
29642 \begin_layout Plain Layout
29651 \begin_layout Description
29652 \begin_inset Flex Code
29655 \begin_layout Plain Layout
29662 \begin_inset Flex Code
29665 \begin_layout Plain Layout
29671 ] The tag to be used for the main label,
29673 \begin_inset Flex Code
29676 \begin_layout Plain Layout
29682 in the examples above.
29684 \begin_inset Flex Code
29687 \begin_layout Plain Layout
29696 \begin_layout Description
29697 \begin_inset Flex Code
29700 \begin_layout Plain Layout
29707 \begin_inset Flex Code
29710 \begin_layout Plain Layout
29720 ] Marks this style as the one to be used to generate the
29721 \begin_inset Flex Code
29724 \begin_layout Plain Layout
29730 tag for the XHTML file.
29734 \begin_inset Flex Code
29737 \begin_layout Plain Layout
29743 file sets it to true for the
29744 \begin_inset Flex Code
29747 \begin_layout Plain Layout
29757 \begin_layout Subsection
29761 \begin_layout Standard
29762 The XHTML output of insets can also be controlled by information in layout files.
29766 \begin_layout Plain Layout
29768 this is true only for
29769 \begin_inset Quotes eld
29773 \begin_inset Quotes erd
29776 insets (insets you can type into) and is not true for
29777 \begin_inset Quotes eld
29781 \begin_inset Quotes erd
29784 insets (insets that are associated with dialog boxes).
29792 tries to provide sensible defaults,
29793 and it constructs default CSS style rules.
29794 But everything can be customized.
29797 \begin_layout Standard
29798 The XHTML \SpecialChar LyX
29799 outputs for an inset has the following form:
29802 \begin_layout LyX-Code
29804 \begin_inset Quotes erd
29808 \begin_inset Quotes erd
29814 \begin_layout LyX-Code
29815 <labeltag>Label</labeltag>
29818 \begin_layout LyX-Code
29820 \begin_inset Quotes erd
29824 \begin_inset Quotes erd
29827 >Contents of the inset.</innertag>
29830 \begin_layout LyX-Code
29834 \begin_layout Standard
29835 If the inset permits multiple paragraphs—
29838 \begin_inset Flex Code
29841 \begin_layout Plain Layout
29848 then the contents of the inset will itself be output as paragraphs formatted according to the styles used for those paragraphs (standard,
29851 The label tag is of course omitted if the paragraph does not have a label and,
29854 \begin_inset Flex Code
29857 \begin_layout Plain Layout
29864 The inner tag is optional and,
29869 \begin_layout Standard
29870 The specific tags and attributes output for each inset can be controlled by means of the following layout tags.
29873 \begin_layout Description
29874 \begin_inset Flex Code
29877 \begin_layout Plain Layout
29884 \begin_inset Flex Code
29887 \begin_layout Plain Layout
29893 ] Specifies attribute information to be output with the main tag.
29896 \begin_inset Quotes eld
29900 \begin_inset Flex Code
29903 \begin_layout Plain Layout
29904 class=`myinset' onclick=`\SpecialChar ldots
29911 \begin_inset Quotes erd
29918 \begin_inset Quotes eld
29922 \begin_inset Flex Code
29925 \begin_layout Plain Layout
29932 \begin_inset Quotes erd
29937 \begin_inset Flex Code
29940 \begin_layout Plain Layout
29946 is the \SpecialChar LyX
29948 made lowercase and with non-alphanumeric characters converted to underscores,
29953 \begin_layout Description
29954 \begin_inset Flex Code
29957 \begin_layout Plain Layout
29964 \begin_inset Flex Code
29967 \begin_layout Plain Layout
29977 ] Whether to output the default CSS information \SpecialChar LyX
29978 generates for this layout,
29979 even if additional information is explicitly provided via
29980 \begin_inset Flex Code
29983 \begin_layout Plain Layout
29991 \begin_inset Flex Code
29994 \begin_layout Plain Layout
30000 allows you to alter or augment the generated CSS,
30001 rather than to override it completely.
30005 \begin_layout Description
30006 \begin_inset Flex Code
30009 \begin_layout Plain Layout
30016 \begin_inset Flex Code
30019 \begin_layout Plain Layout
30025 ] Attributes for the inner tag.
30027 \begin_inset Newline newline
30031 \begin_inset Quotes eld
30035 \begin_inset Flex Code
30038 \begin_layout Plain Layout
30039 class=`insetname_inner'
30045 \begin_inset Quotes erd
30051 \begin_layout Description
30052 \begin_inset Flex Code
30055 \begin_layout Plain Layout
30062 \begin_inset Flex Code
30065 \begin_layout Plain Layout
30073 \begin_inset Flex Code
30076 \begin_layout Plain Layout
30082 in the examples above.
30087 \begin_layout Description
30088 \begin_inset Flex Code
30091 \begin_layout Plain Layout
30098 \begin_inset Flex Code
30101 \begin_layout Plain Layout
30109 ] 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).
30113 \begin_layout Description
30114 \begin_inset Flex Code
30117 \begin_layout Plain Layout
30124 \begin_inset Flex Code
30127 \begin_layout Plain Layout
30133 ] A label for this inset,
30134 possibly including a reference to a counter.
30139 \begin_inset Flex Code
30142 \begin_layout Plain Layout
30152 and there is no default.
30155 \begin_layout Description
30156 \begin_inset Flex Code
30159 \begin_layout Plain Layout
30165 Information to be output in the
30166 \begin_inset Flex Code
30169 \begin_layout Plain Layout
30175 section when this style is used.
30178 be used to include a
30179 \begin_inset Flex Code
30182 \begin_layout Plain Layout
30189 \begin_inset Flex Code
30192 \begin_layout Plain Layout
30201 \begin_layout Description
30202 \begin_inset Flex Code
30205 \begin_layout Plain Layout
30211 CSS style information to be included when this style is used.
30212 Note that this will automatically be wrapped in a layout-generated
30213 \begin_inset Flex Code
30216 \begin_layout Plain Layout
30223 so only the CSS itself need be included.
30226 \begin_layout Description
30227 \begin_inset Flex Code
30230 \begin_layout Plain Layout
30237 \begin_inset Flex Code
30240 \begin_layout Plain Layout
30246 ] The tag to be used for the main label,
30248 \begin_inset Flex Code
30251 \begin_layout Plain Layout
30257 in the examples above.
30258 The default depends upon the setting of
30259 \begin_inset Flex Code
30262 \begin_layout Plain Layout
30270 \begin_inset Flex Code
30273 \begin_layout Plain Layout
30281 \begin_inset Flex Code
30284 \begin_layout Plain Layout
30293 \begin_inset Flex Code
30296 \begin_layout Plain Layout
30305 \begin_layout Subsection
30309 \begin_layout Standard
30310 The XHTML output for floats too can be controlled by layout information.
30311 The output has the following form:
30314 \begin_layout LyX-Code
30316 \begin_inset Quotes erd
30320 \begin_inset Quotes erd
30326 \begin_layout LyX-Code
30327 Contents of the float.
30330 \begin_layout LyX-Code
30334 \begin_layout Standard
30337 is a separate inset and will be output as such.
30338 Its appearance can be controlled via the InsetLayout for caption insets.
30342 \begin_layout Description
30343 \begin_inset Flex Code
30346 \begin_layout Plain Layout
30353 \begin_inset Flex Code
30356 \begin_layout Plain Layout
30362 ] Specifies attribute information to be output with the main tag.
30365 \begin_inset Quotes eld
30369 \begin_inset Flex Code
30372 \begin_layout Plain Layout
30373 class=`myfloat' onclick=`\SpecialChar ldots
30380 \begin_inset Quotes erd
30387 \begin_inset Quotes eld
30391 \begin_inset Flex Code
30394 \begin_layout Plain Layout
30395 class=`float float-floattype'
30401 \begin_inset Quotes erd
30406 \begin_inset Flex Code
30409 \begin_layout Plain Layout
30415 is \SpecialChar LyX
30416 's name for this type of float,
30417 as determined by the float declaration (see
30418 \begin_inset CommandInset ref
30420 reference "subsec:Floats"
30426 though made lowercase and with non-alphanumeric characters converted to underscores,
30431 \begin_layout Description
30432 \begin_inset Flex Code
30435 \begin_layout Plain Layout
30441 CSS style information to be included when this float is used.
30442 Note that this will automatically be wrapped in a layout-generated
30443 \begin_inset Flex Code
30446 \begin_layout Plain Layout
30453 so only the CSS itself need be included.
30456 \begin_layout Description
30457 \begin_inset Flex Code
30460 \begin_layout Plain Layout
30467 \begin_inset Flex Code
30470 \begin_layout Plain Layout
30476 ] The tag to be used for this float,
30478 \begin_inset Quotes eld
30482 \begin_inset Flex Code
30485 \begin_layout Plain Layout
30492 \begin_inset Quotes erd
30495 in the example above.
30497 \begin_inset Flex Code
30500 \begin_layout Plain Layout
30506 and will rarely need changing.
30509 \begin_layout Subsection
30510 Bibliography formatting
30513 \begin_layout Standard
30514 The bibliography can be formatted using
30515 \begin_inset Flex Code
30518 \begin_layout Plain Layout
30526 \begin_inset CommandInset ref
30528 reference "subsec:Citation-format-description"
30536 \begin_layout Subsection
30541 \begin_layout Standard
30542 We have several times mentioned that \SpecialChar LyX
30543 will generate default CSS style rules for both insets and paragraph styles,
30544 based upon the other layout information that is provided.
30546 we shall say a word about which layout information \SpecialChar LyX
30550 \begin_layout Standard
30553 auto-generates CSS only for font information,
30555 \begin_inset Flex Code
30558 \begin_layout Plain Layout
30566 \begin_inset Flex Code
30569 \begin_layout Plain Layout
30577 \begin_inset Flex Code
30580 \begin_layout Plain Layout
30588 \begin_inset Flex Code
30591 \begin_layout Plain Layout
30598 \begin_inset Flex Code
30601 \begin_layout Plain Layout
30608 \begin_inset CommandInset ref
30610 reference "subsec:Font-description"
30616 The translation is mostly straightforward and obvious.
30619 \begin_inset Quotes eld
30623 \begin_inset Flex Code
30626 \begin_layout Plain Layout
30633 \begin_inset Quotes erd
30637 \begin_inset Quotes eld
30641 \begin_inset Flex Code
30644 \begin_layout Plain Layout
30652 \begin_inset Quotes erd
30656 The correspondence of \SpecialChar LyX
30657 sizes and CSS sizes is a little less obvious but nonetheless intuitive.
30659 \begin_inset Flex Code
30662 \begin_layout Plain Layout
30669 \begin_inset Flex URL
30672 \begin_layout Plain Layout
30680 \change_inserted -970929547 1496610908
30684 \begin_layout Section
30686 \change_inserted -970929547 1496610966
30687 \begin_inset CommandInset label
30689 name "sec:Tags-for-DocBook"
30693 Tags for DocBook output
30696 \begin_layout Standard
30698 \change_inserted -970929547 1496611615
30699 As with \SpecialChar LaTeX
30701 the format of \SpecialChar LyX
30702 's DocBook output is also controlled by layout information.
30705 provides sensible defaults;
30707 much of the styling is lost during the conversion,
30708 as DocBook is strictly semantic and does not allow formatting.
30710 information from \SpecialChar LyX
30711 will be rendered in
30719 \begin_layout Standard
30721 \change_inserted -970929547 1496612080
30724 you may not have to do anything at all to get acceptable DocBook output for your own environments,
30727 But in some cases you will,
30728 and so \SpecialChar LyX
30729 provides a number of layout tags that can be used to customize the DocBook that is generated.
30732 \begin_layout Standard
30734 \change_inserted -970929547 1515109912
30735 Labels are rarely output,
30736 as they are redundant in DocBook:
30737 this information is carried by the tags themselves,
30738 and whether labels appear in the final documents (after processing of DocBook files) is controlled by the stylesheets.
30741 labels are not redundant content,
30742 such as definition lists:
30744 the term being defined will be the label.
30748 \begin_layout Subsection
30750 \change_inserted 1075283030 1597699417
30751 \begin_inset CommandInset label
30753 name "subsec:Paragraph-Style-DocBook"
30758 \change_deleted 1075283030 1597699417
30760 \begin_inset CommandInset label
30762 name "subsec:Paragraph-Style-XHTML-1"
30767 \change_inserted -970929547 1496610966
30771 \begin_layout Standard
30773 \change_inserted -970929547 1496612059
30774 The sort of DocBook \SpecialChar LyX
30775 outputs for a paragraph depends upon whether we are dealing with a normal paragraph,
30778 where this is itself determined by the contents of the corresponding
30779 \begin_inset Flex Code
30782 \begin_layout Plain Layout
30784 \change_inserted -970929547 1496610966
30797 \begin_layout Standard
30799 \change_inserted -970929547 1496612107
30800 For a command or normal paragraph,
30801 the output DocBook has the following form:
30804 \begin_layout LyX-Code
30806 \change_inserted -970929547 1515109666
30810 \begin_layout LyX-Code
30812 \change_inserted -970929547 1496610966
30813 Contents of the paragraph.
30816 \begin_layout LyX-Code
30818 \change_inserted -970929547 1496610966
30822 \begin_layout Standard
30824 \change_inserted -970929547 1515109821
30825 For an environment that is not some sort of list,
30826 the generated DocBook takes this form:
30829 \begin_layout LyX-Code
30831 \change_inserted -970929547 1515109671
30835 \begin_layout LyX-Code
30837 \change_inserted -970929547 1496612114
30838 <itemtag>First paragraph.</itemtag>
30841 \begin_layout LyX-Code
30843 \change_inserted -970929547 1496610966
30844 <itemtag>Second paragraph.</itemtag>
30847 \begin_layout LyX-Code
30849 \change_inserted -970929547 1496610966
30853 \begin_layout Standard
30855 \change_inserted -970929547 1515109825
30857 the resulting DocBook takes this form:
30860 \begin_layout LyX-Code
30862 \change_inserted -970929547 1515109672
30866 \begin_layout LyX-Code
30868 \change_inserted -970929547 1515109676
30869 <itemtag attr>First item.</itemtag>
30872 \begin_layout LyX-Code
30874 \change_inserted -970929547 1515109678
30875 <itemtag attr>Second item.</itemtag>
30878 \begin_layout LyX-Code
30880 \change_inserted -970929547 1496610966
30884 \begin_layout Standard
30886 \change_inserted -970929547 1496612243
30887 The specific tags and roles output for each paragraph type can be controlled by means of the layout tags we are about to describe.
30889 due to the very nature of DocBook,
30890 no sensible defaults really exist,
30891 and the values must always be carefully chosen.
30895 \begin_layout Description
30897 \change_inserted -970929547 1515110057
30898 \begin_inset Flex Code
30901 \begin_layout Plain Layout
30903 \change_inserted -970929547 1515109656
30912 \begin_inset Flex Code
30915 \begin_layout Plain Layout
30917 \change_inserted -970929547 1496610966
30925 ] Specifies attribute information to be output with the main tag,
30927 \begin_inset Quotes eld
30931 \begin_inset Flex Code
30934 \begin_layout Plain Layout
30936 \change_inserted -970929547 1515110057
30945 \begin_inset Quotes erd
30948 in the example above.
30949 This information can be used in further processing of the DocBook files.
30955 \begin_layout Description
30957 \change_inserted -970929547 1496612296
30958 \begin_inset Flex Code
30961 \begin_layout Plain Layout
30963 \change_inserted -970929547 1496612269
30972 \begin_inset Flex Code
30975 \begin_layout Plain Layout
30977 \change_inserted -970929547 1496610966
30985 ] The tag to be used for this inset,
30987 \begin_inset Quotes eld
30991 \begin_inset Flex Code
30994 \begin_layout Plain Layout
30996 \change_inserted -970929547 1496612296
31005 \begin_inset Quotes erd
31008 in the example above.
31009 The default is the name of the float and always needs to be changed,
31010 as DocBook provides no generic tag.
31011 \change_inserted 1075283030 1597698868
31015 \begin_layout Description
31017 \change_inserted 1075283030 1597699399
31018 \begin_inset Flex Code
31021 \begin_layout Plain Layout
31023 \change_inserted 1075283030 1597698872
31032 \begin_inset Flex Code
31035 \begin_layout Plain Layout
31037 \change_inserted 1075283030 1597700585
31047 ] The new-line policy for this tag,
31049 \begin_inset space ~
31053 \begin_inset CommandInset ref
31055 reference "subsec:DocBook-New-line-policy"
31069 \begin_layout Subsection
31071 \change_inserted 1075283030 1597699385
31073 \begin_inset CommandInset label
31075 name "subsec:DocBook-New-line-policy"
31082 \begin_layout Standard
31084 \change_inserted 1075283030 1597698993
31086 there are three possible policies for outputting new lines (given in the
31087 \begin_inset Flex Code
31090 \begin_layout Plain Layout
31092 \change_inserted 1075283030 1597698987
31104 \begin_layout Itemize
31106 \change_inserted 1075283030 1597699279
31107 \begin_inset Quotes eld
31111 \begin_inset Flex Code
31114 \begin_layout Plain Layout
31116 \change_inserted 1075283030 1597699012
31125 \begin_inset Quotes erd
31129 the opening and closing tags are on their own lines (i.e.
31130 a line feed after and before the opening and the closing tags).
31131 Typical elements are floats.
31136 \begin_layout LyX-Code
31138 \change_inserted 1075283030 1597699194
31142 \begin_layout LyX-Code
31144 \change_inserted 1075283030 1597699194
31148 \begin_layout LyX-Code
31150 \change_inserted 1075283030 1597699098
31151 Contents of the block.
31154 \begin_layout LyX-Code
31156 \change_inserted 1075283030 1597699196
31160 \begin_layout LyX-Code
31162 \change_inserted 1075283030 1597699198
31166 \begin_layout Itemize
31168 \change_inserted 1075283030 1597699289
31169 \begin_inset Quotes eld
31173 \begin_inset Flex Code
31176 \begin_layout Plain Layout
31178 \change_inserted 1075283030 1597699113
31187 \begin_inset Quotes erd
31191 the opening and closing tags are on the same,
31193 a line feed is output before the opening tag and after the closing tag.
31194 Typical elements are paragraphs and list items.
31199 \begin_layout LyX-Code
31201 \change_inserted 1075283030 1597699186
31205 \begin_layout LyX-Code
31207 \change_inserted 1075283030 1597699357
31208 <paratag>Contents of the paragraph.</paratag>
31211 \begin_layout LyX-Code
31213 \change_inserted 1075283030 1597699231
31217 \begin_layout Itemize
31219 \change_inserted 1075283030 1597699343
31220 \begin_inset Quotes eld
31224 \begin_inset Flex Code
31227 \begin_layout Plain Layout
31229 \change_inserted 1075283030 1597699307
31238 \begin_inset Quotes erd
31242 the opening and closing tags are on the same line as the rest of the content.
31243 No line feeds are output.
31244 Typical elements are fonts.
31249 \begin_layout LyX-Code
31251 \change_inserted 1075283030 1597699585
31252 Content before<inlinetag>Contents of the paragraph.</inlinetag>Content after
31255 \begin_layout Standard
31257 \change_inserted 1075283030 1597699585
31258 The default value is always
31259 \begin_inset Quotes eld
31263 \begin_inset Flex Code
31266 \begin_layout Plain Layout
31268 \change_inserted 1075283030 1597699585
31277 \begin_inset Quotes erd
31285 \begin_layout Subsection
31287 \change_inserted -970929547 1515111533
31288 InsetLayout DocBook
31293 \begin_layout Standard
31295 \change_inserted -970929547 1496611894
31296 The DocBook output of insets can also be controlled by information in layout files.
31299 \begin_layout Standard
31301 \change_inserted -970929547 1496612045
31302 The DocBook \SpecialChar LyX
31303 outputs for an inset has the following form:
31306 \begin_layout LyX-Code
31308 \change_inserted -970929547 1515110861
31309 <wrappertag wrapperattr>
31312 \begin_layout LyX-Code
31314 \change_inserted -970929547 1515110868
31318 \begin_layout LyX-Code
31320 \change_inserted -970929547 1515110869
31321 <innertag innerattr>
31324 \begin_layout LyX-Code
31326 \change_inserted -970929547 1515110869
31327 Contents of the inset.
31330 \begin_layout LyX-Code
31332 \change_inserted -970929547 1515110870
31336 \begin_layout LyX-Code
31338 \change_inserted -970929547 1515110871
31342 \begin_layout LyX-Code
31344 \change_inserted -970929547 1515111172
31348 \begin_layout Standard
31350 \change_inserted -970929547 1515111186
31351 For an itemising inset,
31352 it rather looks like this:
31356 \begin_layout LyX-Code
31358 \change_inserted -970929547 1515111186
31359 <wrappertag wrapperattr>
31362 \begin_layout LyX-Code
31364 \change_inserted -970929547 1515111186
31368 \begin_layout LyX-Code
31370 \change_inserted -970929547 1515111186
31371 <innertag innerattr>
31374 \begin_layout LyX-Code
31376 \change_inserted -970929547 1515111362
31377 <itemwrappertag itemwrapperattr>
31380 \begin_layout LyX-Code
31382 \change_inserted -970929547 1515111364
31383 <itemlabeltag itemattr>
31386 \begin_layout LyX-Code
31388 \change_inserted -970929547 1515111367
31389 Label of the first item.
31392 \begin_layout LyX-Code
31394 \change_inserted -970929547 1515111362
31400 \begin_layout LyX-Code
31402 \change_inserted -970929547 1515111517
31406 \begin_layout LyX-Code
31408 \change_inserted -970929547 1515111517
31414 \begin_layout LyX-Code
31416 \change_inserted -970929547 1515111516
31417 Contents of the first item.
31420 \begin_layout LyX-Code
31422 \change_inserted -970929547 1515111514
31428 \begin_layout LyX-Code
31430 \change_inserted -970929547 1515111247
31436 \begin_layout LyX-Code
31438 \change_inserted -970929547 1515111221
31442 \begin_layout LyX-Code
31444 \change_inserted -970929547 1515111370
31445 <itemwrappertag itemwrapperattr>
31448 \begin_layout LyX-Code
31450 \change_inserted -970929547 1515111370
31451 <itemlabeltag itemattr>
31454 \begin_layout LyX-Code
31456 \change_inserted -970929547 1515111372
31457 Label of the second item.
31460 \begin_layout LyX-Code
31462 \change_inserted -970929547 1515111370
31468 \begin_layout LyX-Code
31470 \change_inserted -970929547 1515111504
31474 \begin_layout LyX-Code
31476 \change_inserted -970929547 1515111505
31482 \begin_layout LyX-Code
31484 \change_inserted -970929547 1515111507
31485 Contents of the second item.
31488 \begin_layout LyX-Code
31490 \change_inserted -970929547 1515111509
31496 \begin_layout LyX-Code
31498 \change_inserted -970929547 1515111251
31504 \begin_layout LyX-Code
31506 \change_inserted -970929547 1515111221
31512 \begin_layout LyX-Code
31514 \change_inserted -970929547 1515111219
31520 \begin_layout LyX-Code
31522 \change_inserted -970929547 1515111186
31526 \begin_layout LyX-Code
31528 \change_inserted -970929547 1515111186
31532 \begin_layout LyX-Code
31534 \change_inserted -970929547 1515111186
31538 \begin_layout Standard
31540 \change_inserted -970929547 1515111183
31541 If the inset permits multiple paragraphs—
31544 \begin_inset Flex Code
31547 \begin_layout Plain Layout
31549 \change_inserted -970929547 1496610966
31558 then the contents of the inset will
31559 \change_deleted 34634807 1620029217
31561 \change_inserted 34634807 1620029219
31563 \change_inserted -970929547 1515111183
31564 be output as paragraphs formatted according to the styles used for those paragraphs (standard,
31567 The inner tag is optional and,
31572 \begin_layout Standard
31574 \change_inserted -970929547 1496610966
31575 The specific tags and attributes output for each inset can be controlled by means of the following layout tags.
31578 \begin_layout Description
31580 \change_inserted -970929547 1515110317
31581 \begin_inset Flex Code
31584 \begin_layout Plain Layout
31586 \change_inserted -970929547 1515109695
31595 \begin_inset Flex Code
31598 \begin_layout Plain Layout
31600 \change_inserted -970929547 1496611854
31608 ] Specifies attribute information to be output with the main tag,
31610 \begin_inset Quotes eld
31614 \begin_inset Flex Code
31617 \begin_layout Plain Layout
31619 \change_inserted -970929547 1515110044
31628 \begin_inset Quotes erd
31631 in the example above.
31632 This information can be used in further processing of the DocBook files.
31636 \begin_layout Description
31638 \change_inserted -970929547 1515110973
31639 \begin_inset Flex Code
31642 \begin_layout Plain Layout
31644 \change_inserted -970929547 1515110319
31653 \begin_inset Flex Code
31656 \begin_layout Plain Layout
31658 \change_inserted -970929547 1515110384
31668 ] Specifies whether this tag goes into the
31669 \begin_inset Flex Code
31672 \begin_layout Plain Layout
31674 \change_inserted -970929547 1515110412
31682 tag at the beginning of the parent layout.
31684 \begin_inset Flex Code
31687 \begin_layout Plain Layout
31689 \change_inserted -970929547 1515110437
31697 indicates that the tag never goes into
31698 \begin_inset Flex Code
31701 \begin_layout Plain Layout
31703 \change_inserted -970929547 1515110497
31711 (this is default value,
31712 and corresponds to usual content).
31714 \begin_inset Flex Code
31717 \begin_layout Plain Layout
31719 \change_inserted -970929547 1515110517
31727 indicates that the tag always goes into
31728 \begin_inset Flex Code
31731 \begin_layout Plain Layout
31733 \change_inserted -970929547 1515110514
31741 (this corresponds to usual metadata):
31743 \begin_inset Flex Code
31746 \begin_layout Plain Layout
31748 \change_inserted -970929547 1515110550
31756 tag for the parent,
31763 \begin_inset Flex Code
31766 \begin_layout Plain Layout
31768 \change_inserted -970929547 1515110540
31776 indicates that the tag may go into
31777 \begin_inset Flex Code
31780 \begin_layout Plain Layout
31782 \change_inserted -970929547 1515110538
31790 (this is only the case for titles):
31792 \begin_inset Flex Code
31795 \begin_layout Plain Layout
31797 \change_inserted -970929547 1515110585
31805 tag for the parent,
31811 the corresponding tag will be output directly as content.
31815 \begin_layout Description
31817 \change_inserted -970929547 1515111461
31818 \begin_inset Flex Code
31821 \begin_layout Plain Layout
31823 \change_inserted -970929547 1515110974
31832 \begin_inset Flex Code
31835 \begin_layout Plain Layout
31837 \change_inserted -970929547 1515110973
31845 ] Specifies attribute information to be output with the item tag,
31847 \begin_inset Quotes eld
31851 \begin_inset Flex Code
31854 \begin_layout Plain Layout
31856 \change_inserted -970929547 1515110984
31865 \begin_inset Quotes erd
31868 in the example above.
31869 This information can be used in further processing of the DocBook files.
31873 \begin_layout Description
31875 \change_inserted -970929547 1515111471
31876 \begin_inset Flex Code
31879 \begin_layout Plain Layout
31881 \change_inserted -970929547 1515111465
31882 DocBookItemInnerAttr
31890 \begin_inset Flex Code
31893 \begin_layout Plain Layout
31895 \change_inserted -970929547 1515111461
31903 ] Specifies attribute information to be output with the item inner tag,
31905 \begin_inset Quotes eld
31909 \begin_inset Flex Code
31912 \begin_layout Plain Layout
31914 \change_inserted -970929547 1515111476
31923 \begin_inset Quotes erd
31926 in the example above.
31927 This information can be used in further processing of the DocBook files.
31931 \begin_layout Description
31933 \change_inserted -970929547 1515111494
31934 \begin_inset Flex Code
31937 \begin_layout Plain Layout
31939 \change_inserted -970929547 1515111467
31940 DocBookItemInnerTag
31948 \begin_inset Flex Code
31951 \begin_layout Plain Layout
31953 \change_inserted -970929547 1515111461
31961 ] The tag to be used for the item inner tag within the inset,
31963 \begin_inset Quotes eld
31967 \begin_inset Flex Code
31970 \begin_layout Plain Layout
31972 \change_inserted -970929547 1515111486
31981 \begin_inset Quotes erd
31984 in the example above.
31986 \begin_inset Flex Code
31989 \begin_layout Plain Layout
31991 \change_inserted -970929547 1515111461
32000 indicating that there is no item inner tag:
32001 content is directly output without it for each itemised element.
32002 This parameter only makes sense when itemising layouts are used,
32005 \change_inserted 1075283030 1598469472
32006 The most likely value is
32007 \begin_inset Quotes eld
32011 \begin_inset Flex Code
32014 \begin_layout Plain Layout
32016 \change_inserted 1075283030 1598469476
32025 \begin_inset Quotes erd
32029 \begin_inset Newline newline
32032 When a list item is split using a new line,
32033 the item inner tag will be repeated for each part of the paragraph,
32034 parts being separated by new lines.
32038 \begin_layout Description
32040 \change_inserted 1075283030 1597699866
32041 \begin_inset Flex Code
32044 \begin_layout Plain Layout
32046 \change_inserted 1075283030 1597699853
32047 DocBookItemInnerTagType
32055 \begin_inset Flex Code
32058 \begin_layout Plain Layout
32060 \change_inserted 1075283030 1597699866
32070 ] The new-line policy for this tag,
32072 \begin_inset space ~
32076 \begin_inset CommandInset ref
32078 reference "subsec:DocBook-New-line-policy"
32092 \begin_layout Description
32094 \change_inserted -970929547 1515111290
32095 \begin_inset Flex Code
32098 \begin_layout Plain Layout
32100 \change_inserted -970929547 1515111283
32101 DocBookItemLabelAttr
32109 \begin_inset Flex Code
32112 \begin_layout Plain Layout
32114 \change_inserted -970929547 1515111279
32122 ] Specifies attribute information to be output with the item label tag,
32124 \begin_inset Quotes eld
32128 \begin_inset Flex Code
32131 \begin_layout Plain Layout
32133 \change_inserted -970929547 1515111304
32142 \begin_inset Quotes erd
32145 in the example above.
32146 This information can be used in further processing of the DocBook files.
32150 \begin_layout Description
32152 \change_inserted -970929547 1515111337
32153 \begin_inset Flex Code
32156 \begin_layout Plain Layout
32158 \change_inserted -970929547 1515111285
32159 DocBookItemLabelTag
32167 \begin_inset Flex Code
32170 \begin_layout Plain Layout
32172 \change_inserted -970929547 1515111279
32180 ] The tag to be used for the item label tag within the inset,
32182 \begin_inset Quotes eld
32186 \begin_inset Flex Code
32189 \begin_layout Plain Layout
32191 \change_inserted -970929547 1515111311
32200 \begin_inset Quotes erd
32203 in the example above.
32204 This parameter only makes sense when itemising layouts are used with a notion of labels,
32205 such as definition lists.
32207 \change_inserted 1075283030 1597699874
32211 \begin_layout Description
32213 \change_inserted 1075283030 1597699874
32214 \begin_inset Flex Code
32217 \begin_layout Plain Layout
32219 \change_inserted 1075283030 1597699880
32220 DocBookItemLabelTagType
32228 \begin_inset Flex Code
32231 \begin_layout Plain Layout
32233 \change_inserted 1075283030 1597699874
32243 ] The new-line policy for this tag,
32245 \begin_inset space ~
32249 \begin_inset CommandInset ref
32251 reference "subsec:DocBook-New-line-policy"
32265 \begin_layout Description
32267 \change_inserted -970929547 1515111124
32268 \begin_inset Flex Code
32271 \begin_layout Plain Layout
32273 \change_inserted -970929547 1515111060
32282 \begin_inset Flex Code
32285 \begin_layout Plain Layout
32287 \change_inserted -970929547 1515111060
32295 ] The tag to be used for the item tag within the inset,
32297 \begin_inset Quotes eld
32301 \begin_inset Flex Code
32304 \begin_layout Plain Layout
32306 \change_inserted -970929547 1515111060
32315 \begin_inset Quotes erd
32318 in the example above.
32320 \begin_inset Flex Code
32323 \begin_layout Plain Layout
32325 \change_inserted -970929547 1515111060
32334 indicating that there is no item tag.
32335 This parameter only makes sense when itemising layouts are used,
32338 \change_inserted 1075283030 1597699890
32342 \begin_layout Description
32344 \change_inserted 1075283030 1597699890
32345 \begin_inset Flex Code
32348 \begin_layout Plain Layout
32350 \change_inserted 1075283030 1597699890
32359 \begin_inset Flex Code
32362 \begin_layout Plain Layout
32364 \change_inserted 1075283030 1597699890
32374 ] The new-line policy for this tag,
32376 \begin_inset space ~
32380 \begin_inset CommandInset ref
32382 reference "subsec:DocBook-New-line-policy"
32396 \begin_layout Description
32398 \change_inserted -970929547 1515111298
32399 \begin_inset Flex Code
32402 \begin_layout Plain Layout
32404 \change_inserted -970929547 1515111124
32405 DocBookItemWrapperAttr
32413 \begin_inset Flex Code
32416 \begin_layout Plain Layout
32418 \change_inserted -970929547 1515111124
32426 ] Specifies attribute information to be output with the item wrapper tag,
32428 \begin_inset Quotes eld
32432 \begin_inset Flex Code
32435 \begin_layout Plain Layout
32437 \change_inserted -970929547 1515111150
32446 \begin_inset Quotes erd
32449 in the example above.
32450 This information can be used in further processing of the DocBook files.
32456 \begin_layout Description
32458 \change_inserted -970929547 1515111113
32459 \begin_inset Flex Code
32462 \begin_layout Plain Layout
32464 \change_inserted -970929547 1515111073
32465 DocBookItemWrapperTag
32473 \begin_inset Flex Code
32476 \begin_layout Plain Layout
32478 \change_inserted -970929547 1515111073
32486 ] The tag to be used for the item wrapper tag within the inset,
32488 \begin_inset Quotes eld
32492 \begin_inset Flex Code
32495 \begin_layout Plain Layout
32497 \change_inserted -970929547 1515111083
32506 \begin_inset Quotes erd
32509 in the example above.
32511 \begin_inset Flex Code
32514 \begin_layout Plain Layout
32516 \change_inserted -970929547 1515111073
32525 indicating that there is no item wrapper tag:
32526 tag and content are directly output without it for each itemised element.
32527 This parameter only makes sense when itemising layouts are used,
32530 \change_inserted 1075283030 1597699897
32534 \begin_layout Description
32536 \change_inserted 1075283030 1597699897
32537 \begin_inset Flex Code
32540 \begin_layout Plain Layout
32542 \change_inserted 1075283030 1597699900
32543 DocBookItemWrapperTagType
32551 \begin_inset Flex Code
32554 \begin_layout Plain Layout
32556 \change_inserted 1075283030 1597699897
32566 ] The new-line policy for this tag,
32568 \begin_inset space ~
32572 \begin_inset CommandInset ref
32574 reference "subsec:DocBook-New-line-policy"
32588 \begin_layout Description
32590 \change_inserted -970929547 1515110104
32591 \begin_inset Flex Code
32594 \begin_layout Plain Layout
32596 \change_inserted -970929547 1515110104
32605 \begin_inset Flex Code
32608 \begin_layout Plain Layout
32610 \change_inserted -970929547 1515110104
32618 ] Specifies attribute information to be output with the inner tag,
32620 \begin_inset Quotes eld
32624 \begin_inset Flex Code
32627 \begin_layout Plain Layout
32629 \change_inserted -970929547 1515110104
32638 \begin_inset Quotes erd
32641 in the example above.
32642 This information can be used in further processing of the DocBook files.
32646 \begin_layout Description
32648 \change_inserted -970929547 1515110906
32649 \begin_inset Flex Code
32652 \begin_layout Plain Layout
32654 \change_inserted -970929547 1515110104
32663 \begin_inset Flex Code
32666 \begin_layout Plain Layout
32668 \change_inserted -970929547 1515110104
32676 ] The tag to be used for the inner tag within the inset,
32678 \begin_inset Quotes eld
32682 \begin_inset Flex Code
32685 \begin_layout Plain Layout
32687 \change_inserted -970929547 1515110104
32696 \begin_inset Quotes erd
32699 in the example above.
32701 \begin_inset Flex Code
32704 \begin_layout Plain Layout
32706 \change_inserted -970929547 1515110791
32715 indicating that there is no inner tag:
32716 content is directly output without it.
32717 \change_inserted 1075283030 1597699904
32721 \begin_layout Description
32723 \change_inserted 1075283030 1597699904
32724 \begin_inset Flex Code
32727 \begin_layout Plain Layout
32729 \change_inserted 1075283030 1597699904
32730 DocBookInnerTagType
32738 \begin_inset Flex Code
32741 \begin_layout Plain Layout
32743 \change_inserted 1075283030 1597699904
32753 ] The new-line policy for this tag,
32755 \begin_inset space ~
32759 \begin_inset CommandInset ref
32761 reference "subsec:DocBook-New-line-policy"
32775 \begin_layout Description
32777 \change_inserted -970929547 1515110753
32778 \begin_inset Flex Code
32781 \begin_layout Plain Layout
32783 \change_inserted -970929547 1515110665
32792 \begin_inset Flex Code
32795 \begin_layout Plain Layout
32797 \change_inserted -970929547 1515110661
32805 ] Specifies the tag that corresponds to this kind of section.
32806 This parameter only makes sense for sectioning elements (part,
32810 The default value is
32811 \begin_inset Flex Code
32814 \begin_layout Plain Layout
32816 \change_inserted -970929547 1515110721
32825 and is only overridden when DocBook uses something else for sectioning (
32826 \change_inserted 1075283030 1597699921
32829 \change_inserted -970929547 1515110753
32830 parts and chapters of a book).
32836 \begin_layout Description
32838 \change_inserted -970929547 1515110811
32839 \begin_inset Flex Code
32842 \begin_layout Plain Layout
32844 \change_inserted -970929547 1496612023
32853 \begin_inset Flex Code
32856 \begin_layout Plain Layout
32858 \change_inserted -970929547 1496610966
32866 ] The tag to be used for this inset,
32868 \begin_inset Quotes eld
32872 \begin_inset Flex Code
32875 \begin_layout Plain Layout
32877 \change_inserted -970929547 1496612033
32886 \begin_inset Quotes erd
32889 in the example above.
32890 The default is the name of the float and always needs to be changed,
32891 as DocBook provides no generic inset tag.
32892 \change_inserted 1075283030 1597699924
32896 \begin_layout Description
32898 \change_inserted 1075283030 1597699924
32899 \begin_inset Flex Code
32902 \begin_layout Plain Layout
32904 \change_inserted 1075283030 1597699924
32913 \begin_inset Flex Code
32916 \begin_layout Plain Layout
32918 \change_inserted 1075283030 1597699924
32928 ] The new-line policy for this tag,
32930 \begin_inset space ~
32934 \begin_inset CommandInset ref
32936 reference "subsec:DocBook-New-line-policy"
32950 \begin_layout Description
32952 \change_inserted -970929547 1515110832
32953 \begin_inset Flex Code
32956 \begin_layout Plain Layout
32958 \change_inserted -970929547 1515110822
32967 \begin_inset Flex Code
32970 \begin_layout Plain Layout
32972 \change_inserted -970929547 1515110811
32980 ] Specifies attribute information to be output with the outer
32981 \change_inserted 34634807 1620057958
32983 \change_inserted -970929547 1515110832
32986 \begin_inset Quotes eld
32990 \begin_inset Flex Code
32993 \begin_layout Plain Layout
32995 \change_inserted -970929547 1515110845
33004 \begin_inset Quotes erd
33007 in the example above.
33008 This information can be used in further processing of the DocBook files.
33012 \begin_layout Description
33014 \change_inserted -970929547 1515110917
33015 \begin_inset Flex Code
33018 \begin_layout Plain Layout
33020 \change_inserted -970929547 1515110826
33029 \begin_inset Flex Code
33032 \begin_layout Plain Layout
33034 \change_inserted -970929547 1515110811
33042 ] The tag to be used for the wrapper tag around the inset,
33044 \begin_inset Quotes eld
33048 \begin_inset Flex Code
33051 \begin_layout Plain Layout
33053 \change_inserted -970929547 1515110842
33062 \begin_inset Quotes erd
33065 in the example above.
33067 \begin_inset Flex Code
33070 \begin_layout Plain Layout
33072 \change_inserted -970929547 1515110811
33081 indicating that there is no wrapper tag:
33082 tag and content are directly output without it.
33083 \change_inserted 1075283030 1597699929
33087 \begin_layout Description
33089 \change_inserted 1075283030 1597699929
33090 \begin_inset Flex Code
33093 \begin_layout Plain Layout
33095 \change_inserted 1075283030 1597699932
33096 DocBookWrapperTagType
33104 \begin_inset Flex Code
33107 \begin_layout Plain Layout
33109 \change_inserted 1075283030 1597699929
33119 ] The new-line policy for this tag,
33121 \begin_inset space ~
33125 \begin_inset CommandInset ref
33127 reference "subsec:DocBook-New-line-policy"
33141 \begin_layout Subsection
33143 \change_inserted -970929547 1515110040
33147 \begin_layout Standard
33149 \change_inserted -970929547 1496611700
33150 The DocBook output for floats too can be controlled by layout information.
33151 The output has the following form:
33154 \begin_layout LyX-Code
33156 \change_inserted -970929547 1515109700
33160 \begin_layout LyX-Code
33162 \change_inserted -970929547 1515110138
33163 Contents of the float as DocBook.
33166 \begin_layout LyX-Code
33168 \change_inserted -970929547 1496610966
33172 \begin_layout Standard
33174 \change_inserted -970929547 1496611715
33177 is a separate inset and will be output as a title.
33181 \begin_layout Description
33183 \change_inserted -970929547 1515110033
33184 \begin_inset Flex Code
33187 \begin_layout Plain Layout
33189 \change_inserted -970929547 1515109702
33198 \begin_inset Flex Code
33201 \begin_layout Plain Layout
33203 \change_inserted -970929547 1496610966
33211 ] Specifies attribute information to be output with the main tag,
33213 \begin_inset Quotes eld
33217 \begin_inset Flex Code
33220 \begin_layout Plain Layout
33222 \change_inserted -970929547 1515110035
33231 \begin_inset Quotes erd
33234 in the example above.
33235 This information can be used in further processing of the DocBook files.
33239 \begin_layout Description
33241 \change_inserted -970929547 1515110157
33242 \begin_inset Flex Code
33245 \begin_layout Plain Layout
33247 \change_inserted -970929547 1496611782
33256 \begin_inset Flex Code
33259 \begin_layout Plain Layout
33261 \change_inserted -970929547 1496610966
33269 ] The tag to be used for this float,
33271 \begin_inset Quotes eld
33275 \begin_inset Flex Code
33278 \begin_layout Plain Layout
33280 \change_inserted -970929547 1496610966
33289 \begin_inset Quotes erd
33292 in the example above.
33293 The default is the name of the float and always needs to be changed,
33294 as DocBook provides no generic float tag.
33297 \begin_layout Subsection
33299 \change_inserted -970929547 1515110157
33300 Bibliography formatting
33303 \begin_layout Standard
33305 \change_deleted 1075283030 1597699984
33307 \change_inserted 1075283030 1597699985
33309 \change_inserted -970929547 1515110187
33311 \change_deleted 1075283030 1597699987
33313 \change_inserted 1075283030 1597699987
33315 \change_inserted -970929547 1515110187
33316 cannot be formatted:
33317 all fields are always output in the database-like DocBook format (equivalent to a BibTeX file)
33318 \change_inserted 1075283030 1597700117
33321 \begin_inset Flex Code
33324 \begin_layout Plain Layout
33326 \change_inserted 1075283030 1597700120
33335 \change_inserted -970929547 1515110187
33337 \change_inserted 1075283030 1597700092
33341 \begin_layout Standard
33343 \change_inserted 1075283030 1597700112
33344 When the bibliographic entries are manually inserted into the
33345 \change_deleted 34634807 1620057319
33347 \change_inserted 34634807 1620057319
33350 \change_inserted 1075283030 1597700112
33351 document as Bibliography Items,
33352 the user deals with formatting
33355 \change_inserted 1075283030 1597700112
33357 there is no attempt of parsing what the user wrote,
33358 the string is directly used (with the
33359 \begin_inset Flex Code
33362 \begin_layout Plain Layout
33364 \change_inserted 1075283030 1597700076
33378 \begin_layout Chapter
33379 Including External Material
33380 \begin_inset CommandInset label
33382 name "chap:Including-External-Material"
33389 \begin_layout Standard
33390 \begin_inset Box Shadowbox
33400 height_special "totalheight"
33405 backgroundcolor "none"
33408 \begin_layout Plain Layout
33410 This portion of the documentation has not been updated for some time.
33411 We certainly hope that it is still accurate,
33412 but there are no guarantees.
33420 \begin_layout Standard
33421 The use of material from sources external to \SpecialChar LyX
33422 is covered in detail in the
33427 This part of the manual covers what needs to happen behind the scenes for new sorts of material to be included.
33430 \begin_layout Section
33434 \begin_layout Standard
33435 The external material feature is based on the concept of a
33440 A template is a specification of how \SpecialChar LyX
33441 should interface with a certain kind of material.
33444 comes with predefined templates for Xfig figures,
33445 various raster format images,
33447 and LilyPond music notation.
33448 You can check the actual list by using the menu
33449 \begin_inset Flex Noun
33452 \begin_layout Plain Layout
33453 Insert\SpecialChar menuseparator
33454 File\SpecialChar menuseparator
33462 it is possible to roll your own template to support a specific kind of material.
33463 Later we'll describe in more detail what is involved,
33464 and hopefully you will submit all the templates you create so we can include them in a later \SpecialChar LyX
33468 \begin_layout Standard
33469 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.
33471 consider the case of a figure produced with
33472 \begin_inset Flex Code
33475 \begin_layout Plain Layout
33482 The Xfig application itself works on an original file with the
33483 \begin_inset Flex Code
33486 \begin_layout Plain Layout
33494 you create and change your figure,
33495 and when you are done,
33497 \begin_inset Flex Code
33500 \begin_layout Plain Layout
33507 When you want to include the figure in your document,
33509 \begin_inset Flex Code
33512 \begin_layout Plain Layout
33518 in order to create a PostScript file that can readily be included in your \SpecialChar LaTeX
33522 \begin_inset Flex Code
33525 \begin_layout Plain Layout
33531 file is the original file,
33532 and the PostScript file is the produced file.
33535 \begin_layout Standard
33536 This distinction is important in order to allow updating of the material while you are in the process of writing the document.
33538 it provides us with the flexibility that is needed to support multiple export formats.
33540 in the case of a plain text file,
33541 it is not exactly an award-winning idea to include the figure as raw PostScript.
33543 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.
33544 The external material management allows you to do this,
33545 because it is parametrized on the different export formats that \SpecialChar LyX
33549 \begin_layout Standard
33550 Besides supporting the production of different products according to the exported format,
33551 it supports tight integration with editing and viewing applications.
33552 In the case of an Xfig figure,
33553 you are able to invoke Xfig on the original file with a single click from within the external material dialog in \SpecialChar LyX
33555 and also preview the produced PostScript file with Ghostview with another click.
33556 No more fiddling around with the command line and/or file browsers to locate and manipulate the original or produced files.
33558 you are finally able to take full advantage of the many different applications that are relevant to use when you write your documents,
33559 and ultimately be more productive.
33562 \begin_layout Section
33563 The external template configuration files
33566 \begin_layout Standard
33567 It is relatively easy to add custom external template definitions to \SpecialChar LyX
33570 be aware that doing this in an careless manner most probably
33574 introduce an easily exploitable security hole.
33575 So before you do this,
33576 please read the discussion about security in
33577 \begin_inset CommandInset ref
33579 reference "sec:Security-discussion"
33587 \begin_layout Standard
33589 we encourage you to submit any interesting templates that you create.
33593 \begin_layout Standard
33594 The external templates are defined in the
33595 \begin_inset Flex Code
33598 \begin_layout Plain Layout
33604 files that are stored in the
33605 \begin_inset Flex Code
33608 \begin_layout Plain Layout
33609 LyXDir/lib/xtemplates/
33615 Each template is defined in a file of its own.
33616 You can place your own templates in
33617 \begin_inset Flex Code
33620 \begin_layout Plain Layout
33621 UserDir/xtemplates/
33626 or copy existing templates to that directory in order to modify them.
33629 \begin_layout Standard
33630 A typical template looks like this:
33633 \begin_layout LyX-Code
33637 \begin_layout LyX-Code
33639 $$AbsOrRelPathParent$$Basename"
33642 \begin_layout LyX-Code
33646 \begin_layout LyX-Code
33650 \begin_layout LyX-Code
33654 \begin_layout LyX-Code
33658 \begin_layout LyX-Code
33662 \begin_layout LyX-Code
33663 AutomaticProduction true
33666 \begin_layout LyX-Code
33670 \begin_layout LyX-Code
33674 \begin_layout LyX-Code
33678 \begin_layout LyX-Code
33679 TransformCommand Rotate RotationLatexCommand
33682 \begin_layout LyX-Code
33683 TransformCommand Resize ResizeLatexCommand
33686 \begin_layout LyX-Code
33687 Product "$$RotateFront$$ResizeFront
33690 \begin_layout LyX-Code
33695 input{$$AbsOrRelPathMaster$$Basename.pstex_t}
33698 \begin_layout LyX-Code
33699 $$ResizeBack$$RotateBack"
33702 \begin_layout LyX-Code
33706 \begin_layout LyX-Code
33707 UpdateResult "$$AbsPath$$Basename.pstex_t"
33710 \begin_layout LyX-Code
33711 Requirement "graphicx"
33714 \begin_layout LyX-Code
33715 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
33718 \begin_layout LyX-Code
33719 ReferencedFile latex "$$AbsPath$$Basename.eps"
33722 \begin_layout LyX-Code
33723 ReferencedFile dvi "$$AbsPath$$Basename.eps"
33726 \begin_layout LyX-Code
33730 \begin_layout LyX-Code
33734 \begin_layout LyX-Code
33735 TransformCommand Rotate RotationLatexCommand
33738 \begin_layout LyX-Code
33739 TransformCommand Resize ResizeLatexCommand
33742 \begin_layout LyX-Code
33743 Product "$$RotateFront$$ResizeFront
33746 \begin_layout LyX-Code
33751 input{$$AbsOrRelPathMaster$$Basename.pdftex_t}
33754 \begin_layout LyX-Code
33755 $$ResizeBack$$RotateBack"
33758 \begin_layout LyX-Code
33759 UpdateFormat pdftex
33762 \begin_layout LyX-Code
33763 UpdateResult "$$AbsPath$$Basename.pdftex_t"
33766 \begin_layout LyX-Code
33767 Requirement "graphicx"
33770 \begin_layout LyX-Code
33771 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pdftex_t"
33774 \begin_layout LyX-Code
33775 ReferencedFile latex "$$AbsPath$$Basename.pdf"
33778 \begin_layout LyX-Code
33782 \begin_layout LyX-Code
33786 \begin_layout LyX-Code
33791 \begin_layout LyX-Code
33795 \begin_layout LyX-Code
33799 \begin_layout LyX-Code
33800 Product "<graphic fileref=
33802 "$$AbsOrRelPathMaster$$Basename.eps
33807 \begin_layout LyX-Code
33811 \begin_layout LyX-Code
33815 \begin_layout LyX-Code
33816 UpdateResult "$$AbsPath$$Basename.eps"
33819 \begin_layout LyX-Code
33820 ReferencedFile docbook "$$AbsPath$$Basename.eps"
33823 \begin_layout LyX-Code
33824 ReferencedFile docbook-xml "$$AbsPath$$Basename.eps"
33827 \begin_layout LyX-Code
33831 \begin_layout LyX-Code
33835 \begin_layout Standard
33837 the template is enclosed in
33838 \begin_inset Flex Code
33841 \begin_layout Plain Layout
33849 \begin_inset Flex Code
33852 \begin_layout Plain Layout
33859 It contains a header specifying some general settings and,
33860 for each supported primary document file format,
33862 \begin_inset Flex Code
33865 \begin_layout Plain Layout
33873 \begin_inset Flex Code
33876 \begin_layout Plain Layout
33885 \begin_layout Subsection
33886 The template header
33889 \begin_layout Description
33890 \begin_inset Flex Code
33893 \begin_layout Plain Layout
33894 AutomaticProduction
33895 \begin_inset space ~
33903 Whether the file represented by the template must be generated by \SpecialChar LyX
33905 This command must occur exactly once.
33908 \begin_layout Description
33909 \begin_inset Flex Code
33912 \begin_layout Plain Layout
33914 \begin_inset space ~
33922 A glob pattern that is used in the file dialog to filter out the desired files.
33923 If there is more than one possible file extension (e.
33924 \begin_inset space \thinspace{}
33928 \begin_inset space \space{}
33932 \begin_inset Flex Code
33935 \begin_layout Plain Layout
33942 \begin_inset Flex Code
33945 \begin_layout Plain Layout
33953 \begin_inset Flex Code
33956 \begin_layout Plain Layout
33963 This command must occur exactly once.
33966 \begin_layout Description
33967 \begin_inset Flex Code
33970 \begin_layout Plain Layout
33972 \begin_inset space ~
33980 The text that is displayed on the button.
33981 This command must occur exactly once.
33984 \begin_layout Description
33985 \begin_inset Flex Code
33988 \begin_layout Plain Layout
33990 \begin_inset space ~
33994 \begin_inset space ~
34002 The help text that is used in the External dialog.
34003 Provide enough information to explain to the user just what the template can provide him with.
34004 This command must occur exactly once.
34007 \begin_layout Description
34008 \begin_inset Flex Code
34011 \begin_layout Plain Layout
34013 \begin_inset space ~
34021 The file format of the original file.
34022 This must be the name of a format that is known to \SpecialChar LyX
34024 \begin_inset CommandInset ref
34026 reference "sec:Formats"
34033 \begin_inset Quotes eld
34037 \begin_inset Flex Code
34040 \begin_layout Plain Layout
34047 \begin_inset Quotes erd
34050 if the template can handle original files of more than one format.
34052 will attempt to interrogate the file itself in order to deduce its format in this case.
34053 This command must occur exactly once.
34056 \begin_layout Description
34057 \begin_inset Flex Code
34060 \begin_layout Plain Layout
34062 \begin_inset space ~
34070 A unique name for the template.
34071 It must not contain substitution macros (see below).
34074 \begin_layout Description
34075 \begin_inset Flex Code
34078 \begin_layout Plain Layout
34080 \begin_inset space ~
34083 Rotate|Resize|Clip|Extra
34088 This command specifies which transformations are supported by this template.
34089 It may occur zero or more times.
34090 This command enables the corresponding tabs in the external dialog.
34092 \begin_inset Flex Code
34095 \begin_layout Plain Layout
34101 command must have either a corresponding
34102 \begin_inset Flex Code
34105 \begin_layout Plain Layout
34112 \begin_inset Flex Code
34115 \begin_layout Plain Layout
34122 \begin_inset Flex Code
34125 \begin_layout Plain Layout
34132 Otherwise the transformation will not be supported by that format.
34135 \begin_layout Subsection
34139 \begin_layout Description
34140 \begin_inset Flex Code
34143 \begin_layout Plain Layout
34145 \begin_inset space ~
34148 LaTeX|PDFLaTeX|PlainText|DocBook|XHTML
34153 The primary document file format that this format definition is for.
34154 Not every template has a sensible representation in all document file formats.
34155 Please define nevertheless a
34156 \begin_inset Flex Code
34159 \begin_layout Plain Layout
34165 section for all templates.
34166 Use a dummy text when no representation is available.
34167 Then you can at least see a reference to the external material in the exported document.
34170 \begin_layout Description
34171 \begin_inset Flex Code
34174 \begin_layout Plain Layout
34176 \begin_inset space ~
34180 \begin_inset space ~
34188 This command defines an additional macro
34189 \begin_inset Flex Code
34192 \begin_layout Plain Layout
34198 for substitution in
34199 \begin_inset Flex Code
34202 \begin_layout Plain Layout
34210 \begin_inset Flex Code
34213 \begin_layout Plain Layout
34219 itself may contain substitution macros.
34220 The advantage over using
34221 \begin_inset Flex Code
34224 \begin_layout Plain Layout
34231 \begin_inset Flex Code
34234 \begin_layout Plain Layout
34240 is that the substituted value of
34241 \begin_inset Flex Code
34244 \begin_layout Plain Layout
34250 is sanitized so that it is a valid optional argument in the document format.
34251 This command may occur zero or more times.
34254 \begin_layout Description
34255 \begin_inset Flex Code
34258 \begin_layout Plain Layout
34260 \begin_inset space ~
34268 The text that is inserted in the exported document.
34269 This is actually the most important command and can be quite complex.
34270 This command must occur exactly once.
34273 \begin_layout Description
34274 \begin_inset Flex Code
34277 \begin_layout Plain Layout
34279 \begin_inset space ~
34287 This command specifies a preamble snippet that will be included in the \SpecialChar LaTeX
34289 It has to be defined using
34290 \begin_inset Flex Code
34293 \begin_layout Plain Layout
34301 \begin_inset Flex Code
34304 \begin_layout Plain Layout
34311 This command may occur zero or more times.
34314 \begin_layout Description
34315 \begin_inset Flex Code
34318 \begin_layout Plain Layout
34320 \begin_inset space ~
34324 \begin_inset space ~
34332 This command denotes files that are created by the conversion process and are needed for a particular export format.
34333 If the filename is relative,
34334 it is interpreted relative to the master document.
34335 This command may be given zero or more times.
34338 \begin_layout Description
34339 \begin_inset Flex Code
34342 \begin_layout Plain Layout
34344 \begin_inset space ~
34352 The name of a required \SpecialChar LaTeX
34354 The package is included via
34355 \begin_inset Flex Code
34358 \begin_layout Plain Layout
34366 in the \SpecialChar LaTeX
34368 This command may occur zero or more times.
34371 \begin_layout Description
34372 \begin_inset Flex Code
34375 \begin_layout Plain Layout
34377 \begin_inset space ~
34381 \begin_inset space ~
34384 RotationLatexCommand
34389 This command specifies that the built in \SpecialChar LaTeX
34390 command should be used for rotation.
34391 This command may occur once or not at all.
34394 \begin_layout Description
34395 \begin_inset Flex Code
34398 \begin_layout Plain Layout
34400 \begin_inset space ~
34404 \begin_inset space ~
34412 This command specifies that the built in \SpecialChar LaTeX
34413 command should be used for resizing.
34414 This command may occur once or not at all.
34417 \begin_layout Description
34418 \begin_inset Flex Code
34421 \begin_layout Plain Layout
34423 \begin_inset space ~
34427 \begin_inset space ~
34430 RotationLatexOption
34435 This command specifies that rotation is done via an optional argument.
34436 This command may occur once or not at all.
34439 \begin_layout Description
34440 \begin_inset Flex Code
34443 \begin_layout Plain Layout
34445 \begin_inset space ~
34449 \begin_inset space ~
34457 This command specifies that resizing is done via an optional argument.
34458 This command may occur once or not at all.
34461 \begin_layout Description
34462 \begin_inset Flex Code
34465 \begin_layout Plain Layout
34467 \begin_inset space ~
34471 \begin_inset space ~
34479 This command specifies that clipping is done via an optional argument.
34480 This command may occur once or not at all.
34483 \begin_layout Description
34484 \begin_inset Flex Code
34487 \begin_layout Plain Layout
34489 \begin_inset space ~
34493 \begin_inset space ~
34501 This command specifies that an extra optional argument is used.
34502 This command may occur once or not at all.
34505 \begin_layout Description
34506 \begin_inset Flex Code
34509 \begin_layout Plain Layout
34511 \begin_inset space ~
34519 The file format of the converted file.
34520 This must be the name of a format that is known to \SpecialChar LyX
34522 \begin_inset Flex Noun
34525 \begin_layout Plain Layout
34526 Tools\SpecialChar menuseparator
34527 Preferences\SpecialChar menuseparator
34528 File Handling\SpecialChar menuseparator
34535 This command must occur exactly once.
34536 If the resulting file format is PDF,
34537 you need to specify the format
34538 \begin_inset Flex Code
34541 \begin_layout Plain Layout
34548 This is the PDF format used for including graphics.
34549 The other defined PDF formats are for document export.
34552 \begin_layout Description
34553 \begin_inset Flex Code
34556 \begin_layout Plain Layout
34558 \begin_inset space ~
34566 The file name of the converted file.
34567 The file name must be absolute.
34568 This command must occur exactly once.
34571 \begin_layout Subsection
34572 Preamble definitions
34575 \begin_layout Standard
34576 The external template configuration file may contain additional preamble definitions enclosed by
34577 \begin_inset Flex Code
34580 \begin_layout Plain Layout
34588 \begin_inset Flex Code
34591 \begin_layout Plain Layout
34598 They can be used by the templates in the
34599 \begin_inset Flex Code
34602 \begin_layout Plain Layout
34611 \begin_layout Section
34612 The substitution mechanism
34615 \begin_layout Standard
34616 When the external material facility invokes an external program,
34617 it is done on the basis of a command defined in the template configuration file.
34618 These commands can contain various macros that are expanded before execution.
34619 Execution always take place in the directory of the containing document.
34622 \begin_layout Standard
34624 whenever external material is to be displayed,
34625 the name will be produced by the substitution mechanism,
34626 and most other commands in the template definition support substitution as well.
34629 \begin_layout Standard
34630 The available macros are the following:
34633 \begin_layout Description
34634 \begin_inset Flex Code
34637 \begin_layout Plain Layout
34638 $$AbsOrRelPathMaster
34644 absolute or relative to the master \SpecialChar LyX
34648 \begin_layout Description
34649 \begin_inset Flex Code
34652 \begin_layout Plain Layout
34653 $$AbsOrRelPathParent
34659 absolute or relative to the \SpecialChar LyX
34663 \begin_layout Description
34664 \begin_inset Flex Code
34667 \begin_layout Plain Layout
34673 The absolute file path.
34676 \begin_layout Description
34677 \begin_inset Flex Code
34680 \begin_layout Plain Layout
34686 The filename without path and without the extension.
34689 \begin_layout Description
34690 \begin_inset Flex Code
34693 \begin_layout Plain Layout
34695 \begin_inset Quotes eld
34699 \begin_inset Quotes erd
34707 This macro will expand to the contents of the file with the name
34708 \begin_inset Flex Code
34711 \begin_layout Plain Layout
34720 \begin_layout Description
34721 \begin_inset Flex Code
34724 \begin_layout Plain Layout
34730 The file extension (including the dot).
34733 \begin_layout Description
34734 \begin_inset Flex Code
34737 \begin_layout Plain Layout
34743 This will be the string
34744 \begin_inset Quotes eld
34748 \begin_inset Quotes erd
34751 if the file is in JPEG format,
34752 otherwise it will be the string
34753 \begin_inset Quotes eld
34757 \begin_inset Quotes erd
34761 This is useful to avoid uneeded conversions for output formats that support both PNG and JPEG fomats.
34762 The predefined RasterImage template uses this macro for the pdf\SpecialChar TeX
34766 \begin_layout Description
34767 \begin_inset Flex Code
34770 \begin_layout Plain Layout
34776 The filename of the file specified in the external material dialog.
34777 This is either an absolute name,
34778 or it is relative to the \SpecialChar LyX
34782 \begin_layout Description
34783 \begin_inset Flex Code
34786 \begin_layout Plain Layout
34793 \begin_inset Flex Code
34796 \begin_layout Plain Layout
34802 (absolute name or relative to the \SpecialChar LyX
34806 \begin_layout Description
34807 \begin_inset Flex Code
34810 \begin_layout Plain Layout
34817 relative to the master \SpecialChar LyX
34821 \begin_layout Description
34822 \begin_inset Flex Code
34825 \begin_layout Plain Layout
34832 relative to the \SpecialChar LyX
34836 \begin_layout Description
34837 \begin_inset Flex Code
34840 \begin_layout Plain Layout
34846 This macro will expand to the absolute path of the system directory.
34847 This is typically used to point to the various helper scripts that are bundled with \SpecialChar LyX
34851 \begin_layout Description
34852 \begin_inset Flex Code
34855 \begin_layout Plain Layout
34861 A name and full path to a temporary file which will be automatically deleted whenever the containing document is closed,
34862 or the external material insertion deleted.
34865 \begin_layout Standard
34866 All path macros contain a trailing directory separator,
34867 so you can construct e.
34868 \begin_inset space \thinspace{}
34872 \begin_inset space \space{}
34875 the absolute filename with
34876 \begin_inset Flex Code
34879 \begin_layout Plain Layout
34880 $$AbsPath$$Basename$$Extension
34888 \begin_layout Standard
34889 The macros above are substituted in all commands unless otherwise noted.
34891 \begin_inset Flex Code
34894 \begin_layout Plain Layout
34900 supports additionally the following substitutions if they are enabled by the
34901 \begin_inset Flex Code
34904 \begin_layout Plain Layout
34911 \begin_inset Flex Code
34914 \begin_layout Plain Layout
34923 \begin_layout Description
34924 \begin_inset Flex Code
34927 \begin_layout Plain Layout
34933 The front part of the resize command.
34936 \begin_layout Description
34937 \begin_inset Flex Code
34940 \begin_layout Plain Layout
34946 The back part of the resize command.
34949 \begin_layout Description
34950 \begin_inset Flex Code
34953 \begin_layout Plain Layout
34959 The front part of the rotation command.
34962 \begin_layout Description
34963 \begin_inset Flex Code
34966 \begin_layout Plain Layout
34972 The back part of the rotation command.
34975 \begin_layout Standard
34976 The value string of the
34977 \begin_inset Flex Code
34980 \begin_layout Plain Layout
34986 command supports additionally the following substitutions if they are enabled by the
34987 \begin_inset Flex Code
34990 \begin_layout Plain Layout
34997 \begin_inset Flex Code
35000 \begin_layout Plain Layout
35009 \begin_layout Description
35010 \begin_inset Flex Code
35013 \begin_layout Plain Layout
35022 \begin_layout Description
35023 \begin_inset Flex Code
35026 \begin_layout Plain Layout
35035 \begin_layout Description
35036 \begin_inset Flex Code
35039 \begin_layout Plain Layout
35048 \begin_layout Description
35049 \begin_inset Flex Code
35052 \begin_layout Plain Layout
35058 The rotation option.
35061 \begin_layout Standard
35062 You may ask why there are so many path macros.
35063 There are mainly two reasons:
35066 \begin_layout Enumerate
35067 Relative and absolute file names should remain relative or absolute,
35069 Users may have reasons to prefer either form.
35070 Relative names are useful for portable documents that should work on different machines,
35072 Absolute names may be required by some programs.
35075 \begin_layout Enumerate
35077 treats relative file names differently than \SpecialChar LyX
35078 and other programs in nested included files.
35079 For \SpecialChar LyX
35081 a relative file name is always relative to the document that contains the file name.
35082 For \SpecialChar LaTeX
35084 it is always relative to the master document.
35085 These two definitions are identical if you have only one document,
35086 but differ if you have a master document that includes part documents.
35087 That means that relative filenames must be transformed when presented to \SpecialChar LaTeX
35089 Fortunately \SpecialChar LyX
35090 does this automatically for you if you choose the right macros.
35093 \begin_layout Standard
35094 So which path macro should be used in new template definitions?
35095 The rule is not difficult:
35098 \begin_layout Itemize
35100 \begin_inset Flex Code
35103 \begin_layout Plain Layout
35109 if an absolute path is required.
35112 \begin_layout Itemize
35114 \begin_inset Flex Code
35117 \begin_layout Plain Layout
35118 $$AbsOrRelPathMaster
35123 if the substituted string is some kind of \SpecialChar LaTeX
35127 \begin_layout Itemize
35129 \begin_inset Flex Code
35132 \begin_layout Plain Layout
35133 $$AbsOrRelPathParent
35138 in order to preserve the user's choice.
35141 \begin_layout Standard
35142 There are special cases where this rule does not work and e.
35143 \begin_inset space \thinspace{}
35147 \begin_inset space \space{}
35150 relative names are needed,
35151 but normally it will work just fine.
35152 One example for such a case is the command
35153 \begin_inset Flex Code
35156 \begin_layout Plain Layout
35157 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
35162 in the XFig template above:
35163 We can't use the absolute name because the copier for
35164 \begin_inset Flex Code
35167 \begin_layout Plain Layout
35173 files needs the relative name in order to rewrite the file content.
35176 \begin_layout Section
35177 Security discussion
35178 \begin_inset CommandInset label
35180 name "sec:Security-discussion"
35187 \begin_layout Standard
35188 The external material feature interfaces with a lot of external programs and does so automatically,
35189 so we have to consider the security implications of this.
35191 since you have the option of including your own filenames and/or parameter strings and those are expanded into a command,
35192 it seems that it would be possible to create a malicious document which executes arbitrary commands when a user views or prints the document.
35193 This is something we definitely want to avoid.
35196 \begin_layout Standard
35198 since the external program commands are specified in the template configuration file only,
35199 there are no security issues if \SpecialChar LyX
35200 is properly configured with safe templates only.
35201 This is so because the external programs are invoked with the
35202 \begin_inset Flex Code
35205 \begin_layout Plain Layout
35211 -system call rather than the
35212 \begin_inset Flex Code
35215 \begin_layout Plain Layout
35222 so it's not possible to execute arbitrary commands from the filename or parameter section via the shell.
35225 \begin_layout Standard
35226 This also implies that you are restricted in what command strings you can use in the external material templates.
35228 pipes and redirection are not readily available.
35229 This has to be so if \SpecialChar LyX
35230 should remain safe.
35231 If you want to use some of the shell features,
35232 you should write a safe script to do this in a controlled manner,
35233 and then invoke the script from the command string.
35237 \begin_layout Standard
35238 It is possible to design a template that interacts directly with the shell,
35239 but since this would allow a malicious user to execute arbitrary commands by writing clever filenames and/or parameters,
35240 we generally recommend that you only use safe scripts that work with the
35241 \begin_inset Flex Code
35244 \begin_layout Plain Layout
35250 system call in a controlled manner.
35252 for use in a controlled environment,
35253 it can be tempting to just fall back to use ordinary shell scripts.
35259 provide an easily exploitable security hole in your system.
35260 Of course it stands to reason that such unsafe templates will never be included in the standard \SpecialChar LyX
35262 although we do encourage people to submit new templates in the open source tradition.
35263 But \SpecialChar LyX
35264 as shipped from the official distribution channels will never have unsafe templates.
35267 \begin_layout Standard
35268 Including external material provides a lot of power,
35269 and you have to be careful not to introduce security hazards with this power.
35270 A subtle error in a single line in an innocent looking script can open the door to huge security problems.
35271 So if you do not fully understand the issues,
35272 we recommend that you consult a knowledgeable security professional or the \SpecialChar LyX
35273 development team if you have any questions about whether a given template is safe or not.
35274 And do this before you use it in an uncontrolled environment.
35277 \begin_layout Chapter
35279 List of supported \SpecialChar LyX
35280 functions to be used in layouts
35281 \begin_inset CommandInset label
35283 name "chap:List-of-functions"
35290 \begin_layout Standard
35292 \begin_inset Tabular
35293 <lyxtabular version="3" rows="11" columns="8">
35294 <features tabularvalignment="middle">
35295 <column alignment="left" valignment="top">
35296 <column alignment="left" valignment="top">
35297 <column alignment="left" valignment="top">
35298 <column alignment="left" valignment="top">
35299 <column alignment="left" valignment="top">
35300 <column alignment="left" valignment="top">
35301 <column alignment="left" valignment="top">
35302 <column alignment="left" valignment="top">
35304 <cell alignment="left" valignment="top" usebox="none">
35307 \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="center" 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
35378 <cell alignment="left" valignment="top" usebox="none">
35381 \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="center" 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
35452 <cell alignment="left" valignment="top" usebox="none">
35455 \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="center" 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
35526 <cell alignment="left" valignment="top" usebox="none">
35529 \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="center" 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
35600 <cell alignment="left" valignment="top" usebox="none">
35603 \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="center" 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
35674 <cell alignment="left" valignment="top" usebox="none">
35677 \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="center" 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
35748 <cell alignment="left" valignment="top" usebox="none">
35751 \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="center" 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
35822 <cell alignment="left" valignment="top" usebox="none">
35825 \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="center" 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
35896 <cell alignment="left" valignment="top" usebox="none">
35899 \begin_layout Plain Layout
35905 <cell alignment="left" valignment="top" usebox="none">
35908 \begin_layout Plain Layout
35914 <cell alignment="left" valignment="top" usebox="none">
35917 \begin_layout Plain Layout
35923 <cell alignment="left" 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
35970 <cell alignment="left" valignment="top" usebox="none">
35973 \begin_layout Plain Layout
35979 <cell alignment="left" valignment="top" usebox="none">
35982 \begin_layout Plain Layout
35988 <cell alignment="left" valignment="top" usebox="none">
35991 \begin_layout Plain Layout
35997 <cell alignment="left" valignment="top" usebox="none">
36000 \begin_layout Plain Layout
36006 <cell alignment="center" valignment="top" usebox="none">
36009 \begin_layout Plain Layout
36015 <cell alignment="center" valignment="top" usebox="none">
36018 \begin_layout Plain Layout
36024 <cell alignment="center" valignment="top" usebox="none">
36027 \begin_layout Plain Layout
36033 <cell alignment="center" valignment="top" usebox="none">
36036 \begin_layout Plain Layout
36044 <cell alignment="center" valignment="top" usebox="none">
36047 \begin_layout Plain Layout
36053 <cell alignment="center" valignment="top" usebox="none">
36056 \begin_layout Plain Layout
36062 <cell alignment="center" valignment="top" usebox="none">
36065 \begin_layout Plain Layout
36071 <cell alignment="center" valignment="top" usebox="none">
36074 \begin_layout Plain Layout
36080 <cell alignment="center" valignment="top" usebox="none">
36083 \begin_layout Plain Layout
36089 <cell alignment="center" valignment="top" usebox="none">
36092 \begin_layout Plain Layout
36098 <cell alignment="center" valignment="top" usebox="none">
36101 \begin_layout Plain Layout
36107 <cell alignment="center" valignment="top" usebox="none">
36110 \begin_layout Plain Layout
36124 \begin_layout Chapter
36125 Names of available colors to be used in layouts
36126 \begin_inset CommandInset label
36128 name "chap:Names-of-colors"
36135 \begin_layout Standard
36136 The colors listed below are the standard colors and those that you can adjust in the \SpecialChar LyX
36140 \begin_layout Section
36144 \begin_layout Standard
36145 The following are no real colors,
36146 but rather act on color definitions:
36149 \begin_layout Description
36150 ignore The color is ignored
36153 \begin_layout Description
36154 inherit The color is inherited
36157 \begin_layout Description
36170 No particular color – clear or default
36173 \begin_layout Section
36177 \begin_layout Standard
36178 These are fixed colors that cannot be customized
36179 \change_inserted -712698321 1607683177
36185 use these colors in layout definitions,
36186 since they will not work well with some color themes (such as dark themes)
36191 \begin_layout Description
36195 \begin_layout Description
36199 \begin_layout Description
36203 \begin_layout Description
36207 \begin_layout Description
36211 \begin_layout Description
36215 \begin_layout Description
36219 \begin_layout Description
36223 \begin_layout Description
36227 \begin_layout Description
36231 \begin_layout Description
36235 \begin_layout Description
36239 \begin_layout Description
36243 \begin_layout Description
36247 \begin_layout Description
36251 \begin_layout Description
36255 \begin_layout Description
36259 \begin_layout Description
36263 \begin_layout Description
36267 \begin_layout Section
36271 \begin_layout Standard
36272 These are the colors allocated to specific elements in
36275 arg "dialog-show prefs"
36281 \begin_layout Description
36282 added_space Added space color
36285 \begin_layout Description
36286 addedtext Added text color
36289 \begin_layout Description
36290 appendix Appendix marker color
36293 \begin_layout Description
36294 background Background color
36297 \begin_layout Description
36298 bottomarea Bottom area color
36301 \begin_layout Description
36302 branchlabel Label color for branches
36305 \begin_layout Description
36306 buttonbg Color used for button background
36309 \begin_layout Description
36310 buttonframe Color for inset button frames
36313 \begin_layout Description
36314 buttonhoverbg Color used for button background under focus
36317 \begin_layout Description
36318 changebar Changebar color
36321 \begin_layout Description
36322 changedtextauthor1 Changed text color author 1
36325 \begin_layout Description
36326 changedtextauthor2 Changed text color author 2
36329 \begin_layout Description
36330 changedtextauthor3 Changed text color author 3
36333 \begin_layout Description
36334 changedtextauthor4 Changed text color author 4
36337 \begin_layout Description
36338 changedtextauthor5 Changed text color author 5
36341 \begin_layout Description
36342 collapsible Collapsible insets text color
36345 \begin_layout Description
36346 collapsibleframe Collapsible insets framecolor
36349 \begin_layout Description
36350 command Text color for command insets
36353 \begin_layout Description
36354 commandbg Background color for command insets
36357 \begin_layout Description
36358 commandframe Frame color for command insets
36361 \begin_layout Description
36362 comment Label color for comments
36365 \begin_layout Description
36366 commentbg Background color of comments
36369 \begin_layout Description
36370 cursor Cursor color
36373 \begin_layout Description
36374 deletedtext Deleted text color
36377 \begin_layout Description
36378 deletedtextmodifier Deleted text modifying color
36381 \begin_layout Description
36382 depthbar Color for the depth bars in the margin
36385 \begin_layout Description
36386 eolmarker End of line marker color
36389 \begin_layout Description
36390 error Color of the \SpecialChar LaTeX
36394 \begin_layout Description
36395 footlabel Label color for footnotes
36398 \begin_layout Description
36399 foreground Foreground color
36402 \begin_layout Description
36403 graphicsbg Graphics inset background color
36406 \begin_layout Description
36407 greyedoutbg Background color of greyedout inset
36410 \begin_layout Description
36411 greyedoutlabel Label color for greyedout insets
36414 \begin_layout Description
36415 greyedouttext Color for greyedout inset text
36418 \begin_layout Description
36419 indexlabel Label color for index insets
36422 \begin_layout Description
36423 inlinecompletion Inline completion color
36426 \begin_layout Description
36427 insetbg Inset marker background color
36430 \begin_layout Description
36431 insetframe Inset marker frame color
36434 \begin_layout Description
36435 language Color for marking foreign language words
36438 \begin_layout Description
36439 latex Text color in \SpecialChar LaTeX
36443 \begin_layout Description
36444 listingsbg Background color of listings inset
36447 \begin_layout Description
36448 marginlabel Label color for margin notes
36451 \begin_layout Description
36452 math Math inset text color
36455 \begin_layout Description
36456 mathbg Math inset background color
36459 \begin_layout Description
36460 mathcorners Math inset frame color not under focus
36463 \begin_layout Description
36464 mathframe Math inset frame color under focus
36467 \begin_layout Description
36468 mathline Math line color
36471 \begin_layout Description
36472 mathmacrobg Macro math inset background color
36475 \begin_layout Description
36476 mathmacroblend Macro math blended color
36479 \begin_layout Description
36480 mathmacroframe Macro math frame color
36483 \begin_layout Description
36484 mathmacrohoverbg Macro math inset background color hovered
36487 \begin_layout Description
36488 mathmacrolabel Macro math label color
36491 \begin_layout Description
36492 mathmacronewarg Macro template color for new parameters
36495 \begin_layout Description
36496 mathmacrooldarg Macro template color for old parameters
36499 \begin_layout Description
36500 newpage New page color
36503 \begin_layout Description
36504 nonunique_inlinecompletion Inline completion color for the non-unique part
36507 \begin_layout Description
36508 note Label color for notes
36511 \begin_layout Description
36512 notebg Background color of notes
36515 \begin_layout Description
36516 pagebreak Page break/line break color
36519 \begin_layout Description
36520 paragraphmarker Color used for the pilcrow sign to mark the end of a paragraph
36523 \begin_layout Description
36524 phantomtext Text color for phantom insets
36527 \begin_layout Description
36528 preview The color used for previews
36531 \begin_layout Description
36532 previewframe Preview frame color
36535 \begin_layout Description
36536 regexpframe Color for regexp frame
36539 \begin_layout Description
36540 scroll Color that indicates when a row can be scrolled
36543 \begin_layout Description
36544 selection Background color of selected text
36547 \begin_layout Description
36548 selectiontext Foreground color of selected text
36551 \begin_layout Description
36552 shadedbg Background color of shaded box
36555 \begin_layout Description
36556 special Special chars text color
36559 \begin_layout Description
36560 tabularline Table line color
36563 \begin_layout Description
36564 tabularonoffline Table line color
36565 \change_inserted -712698321 1607682522
36569 \begin_layout Description
36571 \change_inserted -712698321 1607682563
36572 textlabel1 Color 1 of layout and custom inset labels
36575 \begin_layout Description
36577 \change_inserted -712698321 1607682565
36578 textlabel2 Color 2 of layout and custom inset labels
36581 \begin_layout Description
36583 \change_inserted -712698321 1607682568
36584 textlabel3 Color 3 of layout and custom inset labels
36589 \begin_layout Description
36590 urllabel Label color for URL insets
36593 \begin_layout Description
36594 urltext Color for URL inset text