1 #LyX 2.4 created this file. For more info see https://www.lyx.org/
5 \save_transient_properties true
6 \origin /systemlyxdir/doc/
9 % DO NOT ALTER THIS PREAMBLE!!!
11 % This preamble is designed to ensure that this document prints
12 % out as advertised. If you mess with this preamble,
13 % parts of this document may not print out as expected. If you
14 % have problems LaTeXing this file, please contact
15 % the documentation team
16 % email: lyx-docs@lists.lyx.org
18 % the pages of the TOC is numbered roman
19 % and a pdf-bookmark for the TOC is added
20 \let\myTOC\tableofcontents
21 \renewcommand\tableofcontents{%
23 \pdfbookmark[1]{\contentsname}{}
27 % increase link area for cross-references and autoname them,
28 \AtBeginDocument{\renewcommand{\ref}[1]{\mbox{\autoref{#1}}}}
29 \@ifundefined{extrasenglish}{\usepackage[english]{babel}}{}
30 \@ifpackageloaded{babel}{
31 \addto\extrasenglish{%
32 \renewcommand*{\equationautorefname}[1]{}%
33 \renewcommand{\sectionautorefname}{sec.\negthinspace}%
34 \renewcommand{\subsectionautorefname}{sec.\negthinspace}%
35 \renewcommand{\subsubsectionautorefname}{sec.\negthinspace}%
39 \options bibliography=totoc,index=totoc,BCOR7.5mm,titlepage,captions=tableheading
40 \use_default_options false
44 \maintain_unincluded_children no
46 \language_package default
49 \font_roman "lmodern" "default"
50 \font_sans "lmss" "default"
51 \font_typewriter "lmtt" "default"
52 \font_math "auto" "auto"
53 \font_default_family default
54 \use_non_tex_fonts false
58 \font_typewriter_osf false
59 \font_sf_scale 100 100
60 \font_tt_scale 100 100
62 \use_dash_ligatures true
64 \default_output_format pdf2
66 \bibtex_command default
67 \index_command default
71 \pdf_title "LyX Configuration Manual"
72 \pdf_author "LyX Team"
73 \pdf_subject "LyX-documentation Customization"
74 \pdf_keywords "LyX, documentation, customization"
76 \pdf_bookmarksnumbered true
77 \pdf_bookmarksopen true
78 \pdf_bookmarksopenlevel 1
83 \pdf_pdfusetitle false
84 \pdf_quoted_options "linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue,pdfpagelayout=OneColumn, pdfnewwindow=true, pdfstartview=XYZ, plainpages=false"
87 \use_package amsmath 1
88 \use_package amssymb 1
91 \use_package mathdots 1
92 \use_package mathtools 1
94 \use_package stackrel 1
95 \use_package stmaryrd 1
96 \use_package undertilde 1
98 \cite_engine_type default
102 \paperorientation portrait
108 \notefontcolor #0000ff
112 \color #f5fae7 #0a0518
120 \paragraph_separation indent
121 \paragraph_indentation default
123 \math_indentation default
124 \math_numbering_side default
125 \quotes_style english
129 \paperpagestyle headings
131 \tracking_changes true
132 \output_changes false
134 \postpone_fragile_content false
138 \docbook_table_output 0
139 \docbook_mathml_prefix 1
140 \author -970929547 "Thibaut Cuvelier"
141 \author -712698321 "Jürgen Spitzmüller"
142 \author -584632292 "Richard Kimberly Heck"
143 \author -495245474 "Jean-Marc Lasgouttes"
145 \author 232239728 "Owner"
146 \author 731793113 "Richard Kimberly Heck" rikiheck@lyx.org
147 \author 1075283030 "Thibaut"
153 Customizing \SpecialChar LyX
154 : Features for the Advanced User
158 by the \SpecialChar LyX
163 \begin_layout Plain Layout
164 If you have comments or error corrections, please send them to the \SpecialChar LyX
167 \begin_inset CommandInset href
169 target "lyx-docs@lists.lyx.org"
177 \begin_inset Quotes eld
181 \begin_inset Quotes erd
184 in the subject header, and please cc the current maintainer of this file,
186 \change_inserted 5863208 1604930692
190 \change_inserted 5863208 1604930729
192 \change_deleted 5863208 1604930668
201 \begin_inset Newline newline
205 \begin_inset Newline newline
211 \begin_layout Standard
212 \begin_inset CommandInset toc
213 LatexCommand tableofcontents
220 \begin_layout Standard
221 \begin_inset Note Note
224 \begin_layout Plain Layout
225 Please use change tracking when modifying this document.
226 This makes it easier for our translators to recognize things that have
227 been changed, and it helps the maintainer keep up-to-date with what's been
236 \begin_layout Chapter
240 \begin_layout Standard
241 This manual covers the customization features present in \SpecialChar LyX
243 In it, we discuss issues like keyboard shortcuts, screen previewing options,
244 printer options, sending commands to \SpecialChar LyX
245 via the \SpecialChar LyX
246 Server, internationalization,
247 installing new \SpecialChar LaTeX
248 classes and \SpecialChar LyX
250 We can't possibly hope to touch on everything you can change—our developers
251 add new features faster than we can document them—but we will explain the
252 most common customizations and hopefully point you in the right direction
253 for some of the more obscure ones.
256 \begin_layout Standard
257 \begin_inset Branch OutDated
261 \begin_layout Standard
262 Information from previous versions of this document that now seems to be
263 outdated is contained in the OutDated branch of this document.
264 By default, this information will not appear in the \SpecialChar LaTeX
273 \begin_layout Chapter
278 \begin_layout Standard
279 This chapter aims to help you to find your way through the \SpecialChar LyX
282 Before continuing to read this chapter, you should find out where your
284 library and user directories are by using
285 \begin_inset Flex Noun
288 \begin_layout Plain Layout
289 Help\SpecialChar menuseparator
300 The library directory is the place where \SpecialChar LyX
301 places its system-wide configuration
302 files; the user directory is where you can place your modified versions.
303 We will call the former
304 \begin_inset Flex Code
307 \begin_layout Plain Layout
314 \begin_inset Flex Noun
317 \begin_layout Plain Layout
323 in the remainder of this document.
327 \begin_layout Section
329 \begin_inset Flex Code
332 \begin_layout Plain Layout
341 \begin_layout Standard
342 \begin_inset Flex Code
345 \begin_layout Plain Layout
351 and its sub-directories contain a number of files
352 \change_deleted 232239728 1604787780
355 that can be used to customize \SpecialChar LyX
357 You can change many of these files from within \SpecialChar LyX
359 \begin_inset Flex Noun
362 \begin_layout Plain Layout
363 Tools\SpecialChar menuseparator
370 Most customization that you will want to do in \SpecialChar LyX
371 is possible through this
373 However, many other inner aspects of \SpecialChar LyX
374 can be customized by modifying the
376 \begin_inset Flex Code
379 \begin_layout Plain Layout
386 These files fall in different categories, described in the following subsection
390 \begin_layout Subsection
391 Automatically generated files
394 \begin_layout Standard
396 \begin_inset Flex Noun
399 \begin_layout Plain Layout
405 are generated when you configure \SpecialChar LyX
407 They contain various default values that are
408 \change_inserted 5863208 1604919565
409 automatically detected during reconfiguration.
410 \change_deleted 232239728 1604788241
411 guessed by inspection
413 In general, it is not a good idea to modify them, since they might be overwritt
417 \begin_layout Labeling
418 \labelwidthstring 00.00.0000
419 \begin_inset Flex Code
422 \begin_layout Plain Layout
429 \change_deleted 5863208 1604919950
431 \begin_inset Note Note
434 \begin_layout Plain Layout
436 \change_inserted 232239728 1604853928
437 I capitalized the first word in all of these lists.
438 To me it looks better but it really is a stylistic thing, your call.
439 However if you are not going to capitalize them, the english in some needs
440 to be modified to make it read correctly as a sentence.
448 \change_deleted 232239728 1604853510
450 \change_inserted 232239728 1604853510
453 ontains defaults for various commands.
456 \begin_layout Labeling
457 \labelwidthstring 00.00.0000
458 \begin_inset Flex Code
461 \begin_layout Plain Layout
468 \change_deleted 232239728 1604853512
470 \change_inserted 232239728 1604853512
473 ontains the list of packages that have been recognized by \SpecialChar LyX
475 It is currently unused by the \SpecialChar LyX
476 program itself, but the information extracted,
477 and more, is made available with
478 \begin_inset Flex Noun
481 \begin_layout Plain Layout
482 Help\SpecialChar menuseparator
496 \begin_layout Labeling
497 \labelwidthstring 00.00.0000
498 \begin_inset Flex Code
501 \begin_layout Plain Layout
508 \change_deleted 232239728 1604853515
510 \change_inserted 232239728 1604853515
513 he list of text classes that have been found in your
514 \begin_inset Flex Code
517 \begin_layout Plain Layout
523 directories, along with the associated \SpecialChar LaTeX
524 document class and their description.
527 \begin_layout Labeling
528 \labelwidthstring 00.00.0000
529 \begin_inset Flex Code
532 \begin_layout Plain Layout
539 \change_deleted 232239728 1604853518
541 \change_inserted 232239728 1604853518
544 he list of layout modules found in your
545 \begin_inset Flex Code
548 \begin_layout Plain Layout
557 \begin_layout Labeling
558 \labelwidthstring 00.00.0000
559 \begin_inset Flex Code
562 \begin_layout Plain Layout
569 \change_deleted 232239728 1604853523
571 \change_inserted 232239728 1604853523
574 ists of various sorts of \SpecialChar LaTeX
575 -related files found on your system
578 \begin_layout Labeling
579 \labelwidthstring 00.00.0000
580 \begin_inset Flex Code
583 \begin_layout Plain Layout
584 doc/\SpecialChar LaTeX
590 is automatically generated during configuration from the file
591 \begin_inset Flex Code
594 \begin_layout Plain Layout
602 It contains information on your \SpecialChar LaTeX
606 \begin_layout Subsection
610 \begin_layout Standard
612 \change_deleted 5863208 1604928729
616 \change_inserted 5863208 1604928636
620 \change_inserted 5863208 1604928661
624 \begin_inset Flex Code
627 \begin_layout Plain Layout
634 \change_inserted 5863208 1604928662
636 \change_deleted 5863208 1604928642
640 \change_deleted 5863208 1604928669
642 \begin_inset Flex Code
645 \begin_layout Plain Layout
652 \change_inserted 5863208 1604928680
656 \begin_inset Flex Code
659 \begin_layout Plain Layout
667 \change_deleted 232239728 1604794430
670 exists in both places, the one in
671 \begin_inset Flex Code
674 \begin_layout Plain Layout
683 \begin_layout Labeling
684 \labelwidthstring 00.00.0000
685 \begin_inset Flex Code
688 \begin_layout Plain Layout
695 \change_deleted 232239728 1604794460
697 \change_inserted 232239728 1604794460
700 his directory contains files with the extension
701 \begin_inset Flex Code
704 \begin_layout Plain Layout
710 that define the keybindings used in \SpecialChar LyX
712 If there exists an internationalized version of the bind file named
713 \begin_inset Flex Code
716 \begin_layout Plain Layout
722 , that will be used first.
725 \begin_layout Labeling
726 \labelwidthstring 00.00.0000
727 \begin_inset Flex Code
730 \begin_layout Plain Layout
737 \change_deleted 232239728 1604794478
739 \change_inserted 232239728 1604794478
742 ontains files with the extension
743 \begin_inset Flex Code
746 \begin_layout Plain Layout
752 which define the diverse citation possibilities (natbib, biblatex etc.).
754 \begin_inset CommandInset ref
756 reference "subsec:Cite-Engine-Files"
766 \begin_layout Labeling
767 \labelwidthstring 00.00.0000
768 \begin_inset Flex Code
771 \begin_layout Plain Layout
778 \change_deleted 232239728 1604794483
780 \change_inserted 232239728 1604794486
783 ontains graphics files that can be included in documents.
787 \begin_layout Labeling
788 \labelwidthstring 00.00.0000
789 \begin_inset Flex Code
792 \begin_layout Plain Layout
799 \change_deleted 232239728 1604794492
801 \change_inserted 232239728 1604794492
804 ontains \SpecialChar LyX
805 documentation files (including the one you are currently reading).
807 \begin_inset Flex Code
810 \begin_layout Plain Layout
812 \change_deleted 232239728 1604794660
815 \change_inserted 232239728 1604794661
823 deserves special attention, as noted above.
824 The internationalized help docs are in subdirectories
825 \begin_inset Flex Code
828 \begin_layout Plain Layout
835 \begin_inset Quotes eld
839 \begin_inset Quotes erd
842 is the ISO language code.
844 \begin_inset CommandInset ref
846 reference "cha:Internationalizing-LyX"
853 \begin_layout Labeling
854 \labelwidthstring 00.00.0000
855 \begin_inset Flex Code
858 \begin_layout Plain Layout
865 \change_deleted 232239728 1604794497
867 \change_inserted 232239728 1604794497
870 ontains example files that explain how to use some features.
871 In the file browser, press the
872 \begin_inset Flex Noun
875 \begin_layout Plain Layout
884 \begin_layout Labeling
885 \labelwidthstring 00.00.0000
886 \begin_inset Flex Code
889 \begin_layout Plain Layout
896 \change_deleted 232239728 1604794500
898 \change_inserted 232239728 1604794500
901 ontains image files that are used by the
902 \begin_inset Flex Noun
905 \begin_layout Plain Layout
912 In addition, it also contains the individual icons used in the toolbar
913 and the banners that can be shown when \SpecialChar LyX
917 \begin_layout Labeling
918 \labelwidthstring 00.00.0000
919 \begin_inset Flex Code
922 \begin_layout Plain Layout
929 \change_deleted 232239728 1604794505
931 \change_inserted 232239728 1604794505
934 ontains keyboard keymapping files.
936 \begin_inset CommandInset ref
938 reference "sec:International-Keymap-Stuff"
945 \begin_layout Labeling
946 \labelwidthstring 00.00.0000
947 \begin_inset Flex Code
950 \begin_layout Plain Layout
957 \change_deleted 232239728 1604794508
959 \change_inserted 232239728 1604794508
962 ontains the text class and module files described in
963 \begin_inset CommandInset ref
965 reference "cha:Installing-New-Document"
972 \begin_layout Labeling
973 \labelwidthstring 00.00.0000
974 \begin_inset Flex Code
977 \begin_layout Plain Layout
984 \change_deleted 232239728 1604794513
986 \change_inserted 232239728 1604794513
990 \begin_inset Flex Code
993 \begin_layout Plain Layout
999 Python scripts used to convert between \SpecialChar LyX
1001 These can be run from the command line if
1002 \change_deleted 232239728 1604794749
1005 you want to batch-convert files.
1008 \begin_layout Labeling
1009 \labelwidthstring 00.00.0000
1010 \begin_inset Flex Code
1013 \begin_layout Plain Layout
1020 \change_deleted 232239728 1604794516
1022 \change_inserted 232239728 1604794516
1025 ontains some files that demonstrate the capabilities of the
1026 \begin_inset Flex Noun
1029 \begin_layout Plain Layout
1031 \begin_inset space ~
1040 Also contains some scripts used by \SpecialChar LyX
1044 \begin_layout Labeling
1045 \labelwidthstring 00.00.0000
1046 \begin_inset Flex Code
1049 \begin_layout Plain Layout
1056 \change_deleted 232239728 1604794520
1058 \change_inserted 232239728 1604794520
1061 ontains the standard \SpecialChar LyX
1062 template files described in
1063 \begin_inset CommandInset ref
1065 reference "subsec:Creating-Templates"
1072 \begin_layout Labeling
1073 \labelwidthstring 00.00.0000
1074 \begin_inset Flex Code
1077 \begin_layout Plain Layout
1084 \change_deleted 232239728 1604794524
1086 \change_inserted 232239728 1604794524
1089 ontains files with the extension
1090 \begin_inset Flex Code
1093 \begin_layout Plain Layout
1099 that define the user interface to \SpecialChar LyX
1101 That is, the files define which items appear in which menus and the items
1102 appearing on the toolbar.
1105 \begin_layout Labeling
1106 \labelwidthstring 00.00.0000
1107 \begin_inset Flex Code
1110 \begin_layout Plain Layout
1117 \change_deleted 232239728 1604794528
1119 \change_inserted 232239728 1604794528
1122 ontains files with the extension
1123 \begin_inset Flex Code
1126 \begin_layout Plain Layout
1132 which define the templates for the insertion of external material to a
1135 \begin_inset CommandInset ref
1137 reference "chap:Including-External-Material"
1144 \begin_layout Subsection
1145 Files you don't want to modify
1148 \begin_layout Standard
1149 These files are used internally by \SpecialChar LyX
1150 and you generally do not need to modify
1151 them unless you are a developer.
1154 \begin_layout Labeling
1155 \labelwidthstring 00.00.0000
1156 \begin_inset Flex Code
1159 \begin_layout Plain Layout
1166 \change_deleted 232239728 1604797616
1168 \change_inserted 232239728 1604797616
1171 his file contains the list of \SpecialChar LyX
1173 The contents are displayed with the menu entry
1174 \begin_inset Flex Noun
1177 \begin_layout Plain Layout
1178 Help\SpecialChar menuseparator
1180 \begin_inset space ~
1191 \begin_layout Labeling
1192 \labelwidthstring 00.00.0000
1193 \begin_inset Flex Code
1196 \begin_layout Plain Layout
1203 \change_deleted 232239728 1604797620
1205 \change_inserted 232239728 1604797620
1208 his is a \SpecialChar LaTeX
1209 script used during the configuration process.
1210 Do not run directly.
1213 \begin_layout Labeling
1214 \labelwidthstring 00.00.0000
1215 \begin_inset Flex Code
1218 \begin_layout Plain Layout
1225 \change_deleted 232239728 1604797624
1227 \change_inserted 232239728 1604797624
1230 his is a Python script that is used to re-configure \SpecialChar LyX
1232 It creates configuration files in the directory it was run from.
1235 \begin_layout Subsection
1236 Other files needing a line or two
1239 \begin_layout Labeling
1240 \labelwidthstring 00.00.0000
1241 \begin_inset Flex Code
1244 \begin_layout Plain Layout
1251 \change_deleted 232239728 1604797580
1253 \change_inserted 232239728 1604797580
1256 his contains tables describing how different character encodings can be
1260 \begin_layout Labeling
1261 \labelwidthstring 00.00.0000
1262 \begin_inset Flex Code
1265 \begin_layout Plain Layout
1272 \change_deleted 232239728 1604797584
1274 \change_inserted 232239728 1604797584
1277 his file contains a list of all the languages currently supported by \SpecialChar LyX
1281 \begin_layout Labeling
1282 \labelwidthstring 00.00.0000
1283 \begin_inset Flex Code
1286 \begin_layout Plain Layout
1293 \change_deleted 232239728 1604797587
1295 \change_inserted 232239728 1604797587
1298 ontains information about the supported fonts.
1301 \begin_layout Labeling
1302 \labelwidthstring 00.00.0000
1303 \begin_inset Flex Code
1306 \begin_layout Plain Layout
1313 \change_deleted 232239728 1604797591
1315 \change_inserted 232239728 1604797591
1318 his file contains translations for internationalized paragraph styles (see
1320 \begin_inset CommandInset ref
1322 reference "subsec:I18n"
1329 \begin_layout Labeling
1330 \labelwidthstring 00.00.0000
1331 \begin_inset Flex Code
1334 \begin_layout Plain Layout
1341 \change_deleted 232239728 1604797594
1343 \change_inserted 232239728 1604797594
1346 his file contains information about Unicode-encoded glyphs and the way they
1347 are supported by \SpecialChar LyX
1348 via \SpecialChar LaTeX
1352 \begin_layout Section
1353 Your local configuration directory
1356 \begin_layout Standard
1357 Even if you are using \SpecialChar LyX
1358 as an unprivileged user, you might want to change
1360 configuration for your own use.
1362 \begin_inset Flex Code
1365 \begin_layout Plain Layout
1371 directory contains all your personal configuration files.
1372 This is the directory described as
1373 \begin_inset Quotes eld
1377 \begin_inset Quotes erd
1381 \begin_inset Flex Noun
1384 \begin_layout Plain Layout
1385 Help\SpecialChar menuseparator
1387 \begin_inset space ~
1396 This directory is used as a mirror of
1397 \begin_inset Flex Code
1400 \begin_layout Plain Layout
1406 , which means that every file in
1407 \begin_inset Flex Code
1410 \begin_layout Plain Layout
1416 is a replacement for the corresponding file in
1417 \begin_inset Flex Code
1420 \begin_layout Plain Layout
1427 Any configuration file described in the above sections can be placed either
1428 in the system-wide directory, in which case it will affect all users, or
1429 in your local directory for your own use.
1432 \begin_layout Standard
1433 To make things clearer, let's provide a few examples:
1436 \begin_layout Itemize
1437 The preferences set in the
1438 \begin_inset Flex Noun
1441 \begin_layout Plain Layout
1442 Tools\SpecialChar menuseparator
1448 dialog are saved to a file
1449 \begin_inset Flex Code
1452 \begin_layout Plain Layout
1459 \begin_inset Flex Code
1462 \begin_layout Plain Layout
1471 \begin_layout Itemize
1472 When you reconfigure using
1473 \begin_inset Flex Noun
1476 \begin_layout Plain Layout
1477 Tools\SpecialChar menuseparator
1485 \begin_inset Flex Code
1488 \begin_layout Plain Layout
1494 script, and the resulting files are written in your local configuration
1496 This means that any additional text class file that you might have added
1498 \begin_inset Flex Code
1501 \begin_layout Plain Layout
1507 will be added to the list of classes in the
1508 \begin_inset Flex Noun
1511 \begin_layout Plain Layout
1512 Document\SpecialChar menuseparator
1521 \begin_layout Itemize
1522 If you get some updated documentation from
1523 \change_inserted 232239728 1604798171
1527 ftp site and cannot install it because you do not have sysadmin rights
1528 on your system, you can just copy the files
1529 \change_deleted 232239728 1604798193
1531 \change_inserted 232239728 1604798193
1535 \begin_inset Flex Code
1538 \begin_layout Plain Layout
1544 and the items in the
1545 \begin_inset Flex Noun
1548 \begin_layout Plain Layout
1554 menu will open them!
1557 \begin_layout Section
1558 Running \SpecialChar LyX
1559 with multiple configurations
1562 \begin_layout Standard
1563 The configuration freedom of the local configuration directory may not suffice
1564 if you want to have more than one configuration at your disposal.
1565 For example, you may want to
1566 \change_deleted 232239728 1604798238
1569 use different key bindings or printer settings at different times.
1570 You can achieve this by having several such directories.
1571 You then specify which directory to use at run-time.
1574 \begin_layout Standard
1575 Invoking \SpecialChar LyX
1576 with the command line switch
1577 \begin_inset Flex Code
1580 \begin_layout Plain Layout
1590 instructs the program to read the configuration from that directory, and
1591 not from the default directory.
1592 (You can determine the default directory by running \SpecialChar LyX
1594 \begin_inset Flex Code
1597 \begin_layout Plain Layout
1603 switch.) If the specified directory does not exist, \SpecialChar LyX
1605 for you, just like it does for the default directory
1606 \change_deleted 232239728 1604798318
1609 the first time you run the program.
1610 You can modify the configuration options in this additional user directory
1611 exactly as you would for the default directory.
1612 These directories are completely independent (but read on).
1613 Note that setting the environment variable
1614 \begin_inset Flex Code
1617 \begin_layout Plain Layout
1623 to some value has exactly the same effect.
1626 \begin_layout Standard
1627 Having several configurations also requires more maintenance: if you want
1628 to add a new layout to
1629 \begin_inset Flex Code
1632 \begin_layout Plain Layout
1638 which you want available from all your configurations, you must add it
1639 to each directory separately.
1640 You can avoid this with the following trick: after \SpecialChar LyX
1641 creates the additional
1642 directory, most of the subdirectories (see above) are empty.
1643 If you want the new configuration to mirror an existing one, replace the
1644 empty subdirectory with a symbolic link to the matching subdirectory in
1645 the existing configuration.
1647 \begin_inset Flex Code
1650 \begin_layout Plain Layout
1656 subdirectory, however, since it contains a file written by the configuration
1657 script (also accessible through
1658 \begin_inset Flex Noun
1661 \begin_layout Plain Layout
1662 Tools\SpecialChar menuseparator
1668 ) which is configuration
1669 \change_deleted 232239728 1604798083
1671 \change_inserted 232239728 1604798100
1677 \begin_layout Chapter
1678 The Preferences dialog
1681 \begin_layout Standard
1682 All options of the preferences dialog are described in the Appendix
1684 The Preferences Dialog
1691 For some options you might find here more details.
1694 \begin_layout Section
1696 \begin_inset CommandInset label
1705 \begin_layout Standard
1706 The first step is to define your file formats if they are not already defined.
1708 \begin_inset Flex Noun
1711 \begin_layout Plain Layout
1712 Tools\SpecialChar menuseparator
1720 \begin_inset Flex Noun
1723 \begin_layout Plain Layout
1724 File Handling\SpecialChar menuseparator
1731 \begin_inset Flex Noun
1734 \begin_layout Plain Layout
1740 button to define your new format.
1742 \begin_inset Flex Noun
1745 \begin_layout Plain Layout
1751 field contains the name used to identify the format in the GUI.
1753 \begin_inset Flex Noun
1756 \begin_layout Plain Layout
1762 is used to identify the format internally.
1763 You will also need to enter a file extension.
1764 These are all required.
1766 \begin_inset Flex Noun
1769 \begin_layout Plain Layout
1775 field is used to provide a keyboard shortcut on the menus.
1776 (For example, pressing
1777 \begin_inset Flex Noun
1780 \begin_layout Plain Layout
1787 \begin_inset Flex Noun
1790 \begin_layout Plain Layout
1791 Document\SpecialChar menuseparator
1792 View (Other Formats)\SpecialChar menuseparator
1801 \begin_layout Standard
1803 \begin_inset Flex Noun
1806 \begin_layout Plain Layout
1813 \begin_inset Flex Noun
1816 \begin_layout Plain Layout
1823 For example, you might want to use
1824 \begin_inset Flex Noun
1827 \begin_layout Plain Layout
1833 to view PostScript files.
1834 You can enter the command needed to start the program in the corresponding
1836 In defining this command, you can use the four variables listed in the
1838 The viewer is launched when you view an image in \SpecialChar LyX
1840 \begin_inset Flex Noun
1843 \begin_layout Plain Layout
1844 Document\SpecialChar menuseparator
1851 The editor is for example launched when you right-click on an image and
1853 \begin_inset Flex Noun
1856 \begin_layout Plain Layout
1862 in the appearing context menu.
1865 \begin_layout Standard
1867 \begin_inset Flex Noun
1870 \begin_layout Plain Layout
1876 type of a format is optional, but if it is specified, it must be unique
1878 It is used to detect files of this format from the file contents.
1879 For some important file formats there is no MIME type officially registered
1881 \begin_inset CommandInset href
1884 target "http://www.iana.org/assignments/media-types/"
1890 Therefore \SpecialChar LyX
1891 uses the extended list of MIME types as specified by
1892 \begin_inset CommandInset href
1894 name "freedesktop.org"
1895 target "http://www.freedesktop.org/wiki/Specifications/shared-mime-info-spec"
1903 \begin_layout Standard
1905 \begin_inset Flex Noun
1908 \begin_layout Plain Layout
1914 option tells \SpecialChar LyX
1915 that a format is suitable for document export.
1916 If this is set and if a suitable conversion route exists (see
1917 \begin_inset CommandInset ref
1919 reference "sec:Converters"
1923 ), the format will appear in the
1924 \begin_inset Flex Noun
1927 \begin_layout Plain Layout
1928 File\SpecialChar menuseparator
1935 The format will also appear in the
1936 \begin_inset Flex Noun
1939 \begin_layout Plain Layout
1940 Document\SpecialChar menuseparator
1946 menu if a viewer is specified for the format.
1947 Pure image formats, such as
1948 \begin_inset Flex Code
1951 \begin_layout Plain Layout
1957 , should not use this option.
1958 Formats that can both represent vector graphics and documents like
1959 \begin_inset Flex Code
1962 \begin_layout Plain Layout
1971 \begin_layout Standard
1973 \begin_inset Flex Noun
1976 \begin_layout Plain Layout
1977 Vector graphics format
1982 tells \SpecialChar LyX
1983 that a format can contain vector graphics.
1984 This information is used to determine the target format of included graphics
1986 \begin_inset Flex Noun
1989 \begin_layout Plain Layout
1996 Included graphics may need to be converted to either
1997 \begin_inset Flex Noun
2000 \begin_layout Plain Layout
2007 \begin_inset Flex Noun
2010 \begin_layout Plain Layout
2017 \begin_inset Flex Noun
2020 \begin_layout Plain Layout
2027 \begin_inset Flex Noun
2030 \begin_layout Plain Layout
2036 cannot handle other image formats.
2037 If an included graphic is not already in
2038 \begin_inset Flex Noun
2041 \begin_layout Plain Layout
2048 \begin_inset Flex Noun
2051 \begin_layout Plain Layout
2058 \begin_inset Flex Noun
2061 \begin_layout Plain Layout
2067 format, it is converted to
2068 \begin_inset Flex Noun
2071 \begin_layout Plain Layout
2077 if the vector format option is set, and otherwise to
2078 \begin_inset Flex Noun
2081 \begin_layout Plain Layout
2090 \begin_layout Section
2094 \begin_layout Standard
2095 Since all conversions from one format to another take place in \SpecialChar LyX
2097 directory, it is sometimes necessary to modify a file before copying it
2098 to the temporary directory in order that the conversion may be performed.
2102 \begin_layout Plain Layout
2103 For example, the file may refer to other files—images, for example—using
2104 relative file names, and these may become invalid when the file is copied
2105 to the temporary directory.
2110 This is done by a Copier: It copies a file to (or from) the temporary directory
2111 and may modify it in the process.
2114 \begin_layout Standard
2115 The definitions of the copiers may use eight variables:
2118 \begin_layout Labeling
2119 \labelwidthstring 00.00.0000
2120 \begin_inset Flex Code
2123 \begin_layout Plain Layout
2129 The \SpecialChar LyX
2130 system directory (e.
2131 \begin_inset space \thinspace{}
2135 \begin_inset space \space{}
2139 \begin_inset Flex Noun
2142 \begin_layout Plain Layout
2151 \begin_layout Labeling
2152 \labelwidthstring 00.00.0000
2153 \begin_inset Flex Code
2156 \begin_layout Plain Layout
2165 \begin_layout Labeling
2166 \labelwidthstring 00.00.0000
2167 \begin_inset Flex Code
2170 \begin_layout Plain Layout
2179 \begin_layout Labeling
2180 \labelwidthstring 00.00.0000
2181 \begin_inset Flex Code
2184 \begin_layout Plain Layout
2190 The base name (without filename extension) in the \SpecialChar LyX
2194 \begin_layout Labeling
2195 \labelwidthstring 00.00.0000
2196 \begin_inset Flex Code
2199 \begin_layout Plain Layout
2205 The full directory path of the \SpecialChar LyX
2209 \begin_layout Labeling
2210 \labelwidthstring 00.00.0000
2211 \begin_inset Flex Code
2214 \begin_layout Plain Layout
2220 The full pathname to the original \SpecialChar LyX
2221 file being processed
2224 \begin_layout Labeling
2225 \labelwidthstring 00.00.0000
2226 \begin_inset Flex Code
2229 \begin_layout Plain Layout
2235 The filename (without any directory path) of the \SpecialChar LyX
2239 \begin_layout Labeling
2240 \labelwidthstring 00.00.0000
2241 \begin_inset Flex Code
2244 \begin_layout Plain Layout
2250 The `\SpecialChar LaTeX
2254 \begin_layout Standard
2255 The latter should be the filename as it would be used in a \SpecialChar LaTeX
2263 It is relevant only when exporting files suitable for such inclusion.
2266 \begin_layout Standard
2267 Copiers can be used to do almost anything with output files.
2268 For example, suppose you want generated pdf files to be copied to a special
2270 \begin_inset Flex Code
2273 \begin_layout Plain Layout
2280 Then you could write a shell script such as this one:
2283 \begin_layout Standard
2284 \begin_inset listings
2288 \begin_layout Plain Layout
2293 \begin_layout Plain Layout
2298 \begin_layout Plain Layout
2300 TOFILE=`basename $2`
2303 \begin_layout Plain Layout
2305 cp $FROMFILE /home/you/pdf/$TOFILE
2310 Save it in your local \SpecialChar LyX
2312 \begin_inset Flex Code
2315 \begin_layout Plain Layout
2316 /home/you/.lyx/scripts/pdfcopier.sh
2321 —and make it executable, if you need to do so on your platform.
2323 \begin_inset Flex Noun
2326 \begin_layout Plain Layout
2327 Tools\SpecialChar menuseparator
2333 dialog, select under
2334 \begin_inset Flex Noun
2337 \begin_layout Plain Layout
2338 File Handling\SpecialChar menuseparator
2345 \begin_inset Flex Noun
2348 \begin_layout Plain Layout
2354 format—or one of the other pdf formats—and enter
2355 \begin_inset Flex Code
2358 \begin_layout Plain Layout
2359 pdfcopier.sh $$i $$o
2365 \begin_inset Flex Noun
2368 \begin_layout Plain Layout
2378 \begin_layout Standard
2379 Copiers are used by \SpecialChar LyX
2380 in various of its own conversions.
2381 For example, if appropriate programs are found, \SpecialChar LyX
2382 will automatically install
2384 \begin_inset Flex Noun
2387 \begin_layout Plain Layout
2394 \begin_inset Flex Noun
2397 \begin_layout Plain Layout
2399 \begin_inset space ~
2408 When these formats are exported, the copier sees that not just the main
2409 HTML file but various associated files (style files, images, etc.) are also
2411 All these files are written to a subdirectory of the directory in which
2412 the original \SpecialChar LyX
2417 \begin_layout Plain Layout
2418 This copier can be customized.
2420 \begin_inset Quotes eld
2424 \begin_inset Quotes erd
2427 argument takes a comma-separated list of extensions to be copied; if it
2428 is omitted, all files will be copied.
2430 \begin_inset Quotes eld
2434 \begin_inset Quotes erd
2437 argument determines the extension added to the generated directory.
2439 \begin_inset Quotes eld
2443 \begin_inset Flex Noun
2446 \begin_layout Plain Layout
2453 \begin_inset Quotes erd
2456 , so HTML generated from
2457 \begin_inset Flex Noun
2460 \begin_layout Plain Layout
2461 /path/to/filename.lyx
2467 \begin_inset Flex Noun
2470 \begin_layout Plain Layout
2471 /path/to/filename.html.LyXconv
2485 \begin_layout Section
2487 \begin_inset CommandInset label
2489 name "sec:Converters"
2496 \begin_layout Standard
2497 You can define your own Converters to convert files between different formats.
2499 \begin_inset Flex Noun
2502 \begin_layout Plain Layout
2503 Tools\SpecialChar menuseparator
2504 Preferences\SpecialChar menuseparator
2505 File Handling\SpecialChar menuseparator
2514 \begin_layout Standard
2515 To define a new converter, select the
2516 \begin_inset Flex Noun
2519 \begin_layout Plain Layout
2521 \begin_inset space ~
2530 \begin_inset Flex Noun
2533 \begin_layout Plain Layout
2535 \begin_inset space ~
2543 from the drop-down lists, enter the command needed for the conversion,
2545 \begin_inset Flex Noun
2548 \begin_layout Plain Layout
2555 Several variables can be used in the definition of converters:
2558 \begin_layout Labeling
2559 \labelwidthstring 00.00.0000
2560 \begin_inset Flex Code
2563 \begin_layout Plain Layout
2569 The \SpecialChar LyX
2573 \begin_layout Labeling
2574 \labelwidthstring 00.00.0000
2575 \begin_inset Flex Code
2578 \begin_layout Plain Layout
2587 \begin_layout Labeling
2588 \labelwidthstring 00.00.0000
2589 \begin_inset Flex Code
2592 \begin_layout Plain Layout
2601 \begin_layout Labeling
2602 \labelwidthstring 00.00.0000
2603 \begin_inset Flex Code
2606 \begin_layout Plain Layout
2612 The base filename of the input file (i.
2613 \begin_inset space \thinspace{}
2616 g., without the extension)
2619 \begin_layout Labeling
2620 \labelwidthstring 00.00.0000
2621 \begin_inset Flex Code
2624 \begin_layout Plain Layout
2630 The path to the input file
2633 \begin_layout Labeling
2634 \labelwidthstring 00.00.0000
2635 \begin_inset Flex Code
2638 \begin_layout Plain Layout
2644 The path to the original input file (this is different from $$p when a
2645 chain of converters is called)
2648 \begin_layout Labeling
2649 \labelwidthstring 00.00.0000
2650 \begin_inset Flex Code
2653 \begin_layout Plain Layout
2659 The iconv name for the encoding of the document.
2662 \begin_layout Standard
2664 \begin_inset Flex Noun
2667 \begin_layout Plain Layout
2669 \begin_inset space ~
2677 field you can enter the following flags, separated by commas:
2680 \begin_layout Labeling
2681 \labelwidthstring 00.00.0000
2682 \begin_inset Flex Code
2685 \begin_layout Plain Layout
2687 \change_inserted -712698321 1524656940
2695 This converter runs some form of \SpecialChar LaTeX
2697 This will make \SpecialChar LyX
2698 's \SpecialChar LaTeX
2699 error logs available.
2701 \change_inserted -712698321 1524657018
2703 \begin_inset Flex Code
2706 \begin_layout Plain Layout
2708 \change_inserted -712698321 1524657012
2716 value specifies the form of \SpecialChar LaTeX
2718 \begin_inset Flex Code
2721 \begin_layout Plain Layout
2723 \change_inserted -712698321 1524657005
2724 latex, pdflatex, platex, xetex, luatex
2732 If no value is specified,
2733 \begin_inset Flex Code
2736 \begin_layout Plain Layout
2738 \change_inserted -712698321 1524657018
2751 \begin_layout Labeling
2752 \labelwidthstring 00.00.0000
2753 \begin_inset Flex Code
2756 \begin_layout Plain Layout
2758 \change_inserted -712698321 1524656935
2766 Needs the \SpecialChar LaTeX
2768 \begin_inset Flex Noun
2771 \begin_layout Plain Layout
2777 file for the conversion.
2779 \change_inserted -712698321 1524657047
2781 \begin_inset Flex Code
2784 \begin_layout Plain Layout
2786 \change_inserted -712698321 1524657030
2794 value specifies the form of \SpecialChar LaTeX
2795 that is run in order to generate the
2796 \begin_inset Flex Noun
2799 \begin_layout Plain Layout
2801 \change_inserted -712698321 1524657047
2810 \begin_inset Flex Code
2813 \begin_layout Plain Layout
2815 \change_inserted -712698321 1524657030
2816 latex, pdflatex, platex, xetex, luatex
2824 If no value is specified,
2825 \begin_inset Flex Code
2828 \begin_layout Plain Layout
2830 \change_inserted -712698321 1524657030
2843 \begin_layout Labeling
2844 \labelwidthstring 00.00.0000
2845 \begin_inset Flex Code
2848 \begin_layout Plain Layout
2855 \begin_inset Quotes eld
2859 \begin_inset Quotes erd
2862 file from the backend, which in practice means a \SpecialChar LaTeX
2863 file like the one we
2864 would export, without
2865 \begin_inset Flex Code
2868 \begin_layout Plain Layout
2877 \begin_layout Labeling
2878 \labelwidthstring 00.00.0000
2879 \begin_inset Flex Code
2882 \begin_layout Plain Layout
2891 \begin_layout Standard
2892 The following three flags are not really flags at all because they take
2894 \begin_inset Flex Noun
2897 \begin_layout Plain Layout
2899 \begin_inset space ~
2903 \begin_inset space ~
2914 \begin_layout Labeling
2915 \labelwidthstring 00.00.0000
2917 \change_inserted -712698321 1523206314
2918 \begin_inset Flex Code
2921 \begin_layout Plain Layout
2923 \change_inserted -712698321 1523206193
2931 The name of the driver that needs to be loaded with the
2935 package for this converter.
2936 The loading of the correct driver is necessary to get some PDF-specific
2945 \begin_layout Labeling
2946 \labelwidthstring 00.00.0000
2947 \begin_inset Flex Code
2950 \begin_layout Plain Layout
2956 If set, the converter's standard error will be redirected to a file
2957 \begin_inset Flex Code
2960 \begin_layout Plain Layout
2966 , and the script given as argument will be run as:
2967 \begin_inset Flex Code
2970 \begin_layout Plain Layout
2971 script < infile.out > infile.log
2977 The argument may contain
2978 \begin_inset Flex Code
2981 \begin_layout Plain Layout
2990 \begin_layout Labeling
2991 \labelwidthstring 00.00.0000
2992 \begin_inset Flex Code
2995 \begin_layout Plain Layout
3001 The name of the directory in which the converter will dump the generated
3004 will not create this directory, and it does not copy anything into it,
3005 though it will copy this directory to the destination.
3006 The argument may contain
3007 \begin_inset Flex Code
3010 \begin_layout Plain Layout
3016 , which will be replaced by the base name of the input and output files,
3017 respectively, when the directory is copied.
3018 \begin_inset Newline newline
3021 Note that resultdir and usetempdir make no sense together.
3022 The latter will be ignored if the former is given.
3025 \begin_layout Labeling
3026 \labelwidthstring 00.00.0000
3027 \begin_inset Flex Code
3030 \begin_layout Plain Layout
3036 Determines the output file name and may, contain
3037 \begin_inset Flex Code
3040 \begin_layout Plain Layout
3047 Sensible only with resultdir and optional even then; if not given, it defaults
3051 \begin_layout Standard
3053 \change_inserted -712698321 1523206384
3054 A suitable hyperref-driver is set for some converters that are installed
3055 with \SpecialChar LyX
3058 \change_deleted -712698321 1523206388
3060 \change_inserted -712698321 1523206389
3064 \change_inserted -712698321 1523206400
3068 \change_inserted -712698321 1523206407
3072 \change_inserted -712698321 1523206437
3076 \change_deleted -712698321 1523206442
3077 that are installed with \SpecialChar LyX
3084 \begin_layout Standard
3085 You do not have to define converters for all formats between which you want
3087 For example, you will note that there is no `\SpecialChar LyX
3088 to PostScript' converter,
3089 but \SpecialChar LyX
3090 will export PostScript.
3091 It does so by first creating a \SpecialChar LaTeX
3092 file (no converter needs to be defined
3093 for this) which is then converted to DVI using the `\SpecialChar LaTeX
3095 and finally converting the resulting DVI file to PostScript.
3097 finds such `chains' of converters automatically, and it will always choose
3098 the shortest possible chain.
3099 You can, though, still define multiple conversion methods between file
3101 For example, the standard \SpecialChar LyX
3102 configuration provides five ways to convert
3107 \begin_layout Enumerate
3109 \begin_inset Flex Noun
3112 \begin_layout Plain Layout
3121 \begin_layout Enumerate
3122 via (DVI and) PostScript, using
3123 \begin_inset Flex Noun
3126 \begin_layout Plain Layout
3135 \begin_layout Enumerate
3137 \begin_inset Flex Noun
3140 \begin_layout Plain Layout
3149 \begin_layout Enumerate
3151 \begin_inset Flex Noun
3154 \begin_layout Plain Layout
3164 \begin_layout Enumerate
3166 \begin_inset Flex Noun
3169 \begin_layout Plain Layout
3179 \begin_layout Standard
3180 To define such alternate chains, you must define multiple target `file formats',
3182 \begin_inset CommandInset ref
3184 reference "sec:Formats"
3189 For example, in the standard configuration, the formats named
3190 \begin_inset Flex Noun
3193 \begin_layout Plain Layout
3200 \begin_inset Flex Noun
3203 \begin_layout Plain Layout
3210 \begin_inset Flex Noun
3213 \begin_layout Plain Layout
3220 \begin_inset Flex Noun
3223 \begin_layout Plain Layout
3230 \begin_inset Flex Noun
3233 \begin_layout Plain Layout
3240 \begin_inset Flex Noun
3243 \begin_layout Plain Layout
3250 \begin_inset Flex Noun
3253 \begin_layout Plain Layout
3260 \begin_inset Flex Noun
3263 \begin_layout Plain Layout
3271 \begin_inset Flex Noun
3274 \begin_layout Plain Layout
3281 \begin_inset Flex Noun
3284 \begin_layout Plain Layout
3291 ) are defined, all of which share the extension
3292 \begin_inset Flex Noun
3295 \begin_layout Plain Layout
3301 , and which correspond to the conversion methods just mentioned.
3304 \begin_layout Chapter
3305 Internationalizing \SpecialChar LyX
3307 \begin_inset CommandInset label
3309 name "cha:Internationalizing-LyX"
3316 \begin_layout Standard
3318 supports using a translated interface.
3319 Last time we checked, \SpecialChar LyX
3320 provided text in thirty languages.
3321 The language of choice is called your
3326 (For further reading on locale settings, see also the documentation for
3327 locale that comes with your operating system.
3328 For Linux, the manual page for
3329 \begin_inset Flex Code
3332 \begin_layout Plain Layout
3338 could be a good place to start).
3341 \begin_layout Standard
3342 Notice that these translations will work, but do contain a few flaws.
3343 In particular, all dialogs have been designed with the English text in
3344 mind, which means that some of the translated text will be too large to
3345 fit within the space allocated.
3346 This is only a display problem and will not cause any harm.
3347 Also, you will find that some of the translations do not define shortcut
3348 keys for everything.
3349 Sometimes, there are simply not enough free letters to do it.
3350 Other times, the translator just hasn't got around to doing it yet.
3351 Our localization team, which you may wish to join,
3355 \begin_layout Plain Layout
3356 If you are a fluent speaker of a language other than English, joining these
3357 teams is a great way to give back to the \SpecialChar LyX
3363 will of course try to fix these shortcomings in future versions of \SpecialChar LyX
3367 \begin_layout Section
3368 Translating \SpecialChar LyX
3372 \begin_layout Subsection
3373 Translating the graphical user interface (text messages).
3376 \begin_layout Standard
3379 \begin_inset Flex Code
3382 \begin_layout Plain Layout
3388 library to handle the internationalization of the interface.
3389 To have \SpecialChar LyX
3390 speak your favorite language in all menus and dialogs, you need
3392 \begin_inset Flex Code
3395 \begin_layout Plain Layout
3401 -file for that language.
3402 When this is available, you'll have to generate a
3403 \begin_inset Flex Code
3406 \begin_layout Plain Layout
3412 -file from it and install the
3413 \begin_inset Flex Code
3416 \begin_layout Plain Layout
3423 The process of doing all of this is explained in the documentation for
3425 \begin_inset Flex Code
3428 \begin_layout Plain Layout
3435 It is possible to do this just for yourself, but if you're going to do
3436 it, you might as well share the results of your labors with the rest of
3437 the \SpecialChar LyX
3439 Send a message to the \SpecialChar LyX
3440 developers' list for more information about how
3444 \begin_layout Standard
3445 In short, this is what you should do (xx denotes the language code):
3448 \begin_layout Itemize
3449 Check out the \SpecialChar LyX
3452 \begin_inset CommandInset href
3454 name "information on the web"
3455 target "https://www.lyx.org/HowToUseGIT"
3463 \begin_layout Itemize
3465 \begin_inset Flex Code
3468 \begin_layout Plain Layout
3474 to the folder of the
3475 \begin_inset Flex Code
3478 \begin_layout Plain Layout
3486 \begin_inset Flex Code
3489 \begin_layout Plain Layout
3497 \begin_inset Flex Code
3500 \begin_layout Plain Layout
3506 doesn't exist anywhere, it can be remade with the console command
3507 \begin_inset Flex Code
3510 \begin_layout Plain Layout
3516 in that directory, or you can use an existing po-file for some other language
3520 \begin_layout Itemize
3522 \begin_inset Flex Code
3525 \begin_layout Plain Layout
3535 \begin_layout Plain Layout
3536 This is just a text file, so it can be edited in any text editor.
3537 But there are also specialized programs that support such editing, such
3542 (for all platforms) or
3551 contains a `mode' for editing
3552 \begin_inset Flex Code
3555 \begin_layout Plain Layout
3562 \begin_inset Flex URL
3565 \begin_layout Plain Layout
3567 https://www.gnu.org/software/gettext/manual/html_node/PO-Mode.html#PO-Mode
3577 For some menu- and widget-labels, there are also shortcut keys that should
3579 Those keys are marked after a `|', and should be translated according to
3580 the words and phrases of the language.
3581 You should also fill also out the information at the beginning of the new
3583 \begin_inset Flex Code
3586 \begin_layout Plain Layout
3592 -file with your email-address, etc., so people know where to reach you with
3593 suggestions and entertaining flames.
3596 \begin_layout Standard
3597 If you are just doing this on your own, then:
3600 \begin_layout Itemize
3602 \begin_inset Flex Code
3605 \begin_layout Plain Layout
3612 This can be done with
3613 \begin_inset Flex Code
3616 \begin_layout Plain Layout
3617 msgfmt -o xx.mo < xx.po
3625 \begin_layout Itemize
3627 \begin_inset Flex Code
3630 \begin_layout Plain Layout
3636 -file to your locale-tree, at the correct directory for application messages
3641 xx, and under the name
3642 \begin_inset Flex Code
3645 \begin_layout Plain Layout
3652 \begin_inset space \thinspace{}
3656 \begin_inset space \space{}
3660 \begin_inset Flex Code
3663 \begin_layout Plain Layout
3664 /usr/local/share/locale/xx/LC_MESSAGES/lyx.mo
3674 \begin_layout Standard
3675 As said, however, it would be best if the new
3676 \begin_inset Flex Code
3679 \begin_layout Plain Layout
3685 file could be added to the \SpecialChar LyX
3686 distribution, so others can use it.
3687 Adding it involves making additional changes to \SpecialChar LyX
3689 So send an email to the developers' mailing list if you're interested in
3693 \begin_layout Subsubsection
3697 \begin_layout Standard
3698 Sometimes it turns out that one English message needs to be translated into
3699 different messages in the target language.
3700 One example is the message
3701 \begin_inset Flex Code
3704 \begin_layout Plain Layout
3710 which has the German translation
3718 , depending upon exactly what the English
3719 \begin_inset Quotes eld
3723 \begin_inset Quotes erd
3728 \begin_inset Flex Code
3731 \begin_layout Plain Layout
3737 does not handle such ambiguous translations.
3738 Therefore you have to add some context information to the message: Instead
3740 \begin_inset Flex Code
3743 \begin_layout Plain Layout
3750 \begin_inset Flex Code
3753 \begin_layout Plain Layout
3754 To[[as in 'From format x to format y']]
3760 \begin_inset Flex Code
3763 \begin_layout Plain Layout
3764 To[[as in 'From page x to page y']].
3769 Now the two occurrences of
3770 \begin_inset Flex Code
3773 \begin_layout Plain Layout
3780 \begin_inset Flex Code
3783 \begin_layout Plain Layout
3789 and can be translated correctly to
3800 \begin_layout Standard
3801 Of course the context information needs to be stripped off the original
3802 message when no translation is used.
3803 Therefore you have to put it in double square brackets at the end of the
3804 message (see the example above).
3805 The translation mechanism of \SpecialChar LyX
3806 ensures that everything in double square
3807 brackets at the end of messages is removed before displaying the message.
3810 \begin_layout Subsection
3811 Translating the documentation.
3814 \begin_layout Standard
3815 The online documentation (in the
3816 \begin_inset Flex Noun
3819 \begin_layout Plain Layout
3825 -menu) can (and should!) be translated.
3826 If there are translated versions of the documentation available
3830 \begin_layout Plain Layout
3831 As of March 2008, at least some of the documents have been translated into
3832 fourteen languages, with the Tutorial available in a few more.
3837 and the locale is set accordingly, these will be used automagically by
3841 looks for translated versions as
3842 \begin_inset Flex Code
3845 \begin_layout Plain Layout
3846 LyXDir/doc/xx/DocName.lyx
3852 \begin_inset Flex Code
3855 \begin_layout Plain Layout
3861 is the code for the language currently in use.
3862 If there are no translated documents, the default English versions will
3864 Note that the translated versions must have the same filenames (
3865 \begin_inset Flex Code
3868 \begin_layout Plain Layout
3874 above) as the original.
3875 If you feel up to translating the documentation (an excellent way to proof-read
3876 the original documentation by the way!), there are a few things you should
3880 \begin_layout Itemize
3881 Check out the documentation translation web page at
3882 \begin_inset CommandInset href
3884 name "https://www.lyx.org/Translation"
3885 target "https://www.lyx.org/Translation"
3891 That way, you can find out which (if any) documents have already been translate
3892 d into your language.
3893 You can also find out who (if anyone) is organizing the effort to translate
3894 the documentation into your language.
3895 If no one is organizing the effort, please let us know that you're interested.
3898 \begin_layout Standard
3899 Once you get to actually translating, here's a few hints for you that may
3903 \begin_layout Itemize
3904 Join the documentation team! There is information on how to do that in
3905 \begin_inset Flex Code
3908 \begin_layout Plain Layout
3915 \begin_inset Flex Noun
3918 \begin_layout Plain Layout
3919 Help\SpecialChar menuseparator
3925 ), which by the way is the first document you should translate.
3928 \begin_layout Itemize
3929 Learn the typographic conventions for the language you are translating to.
3930 Typography is an ancient art and over the centuries, a great variety of
3931 conventions have developed throughout different parts of the world.
3932 Also study the professional terminology amongst typographers in your country.
3933 Inventing your own terminology will only confuse the users.
3936 (Warning! Typography is addictive!)
3939 \begin_layout Itemize
3940 Make a copy of the document.
3941 This will be your working copy.
3942 You can use this as your personal translated help-file by placing it in
3944 \begin_inset Flex Code
3947 \begin_layout Plain Layout
3954 \begin_inset Note Greyedout
3957 \begin_layout Plain Layout
3962 For a complex document with external material (images, etc.), if you make
3964 \begin_inset space \thinspace{}
3968 \begin_inset space \space{}
3971 in a temp dir, beware that the links to external material may be broken
3972 when the document is moved to a different place.
3973 The best way is to retrieve the \SpecialChar LyX
3975 \begin_inset Flex URL
3978 \begin_layout Plain Layout
3980 https://www.lyx.org/HowToUseGIT
3985 ) and to edit the doc file in place.
3993 \begin_layout Itemize
3994 Sometimes the original document (from the \SpecialChar LyX
3995 team) will be updated.
3996 Use the source viewer at
3997 \begin_inset CommandInset href
3999 name "https://www.lyx.org/trac/timeline"
4000 target "https://www.lyx.org/trac/timeline"
4005 to see what has been changed.
4006 That way you can easily see which parts of the translated document need
4010 \begin_layout Standard
4011 If you ever find an error in the original document, fix it and notify the
4012 rest of the documentation team of the changes! (You didn't forget to join
4013 the documentation team, did you?)
4016 \begin_layout Standard
4017 \begin_inset Branch OutDated
4021 \begin_layout Section
4022 International Keyboard Support
4025 \begin_layout Standard
4028 [Editor's Note: The following section is by
4036 It needs to be fixed to conform to the new Documentation Style sheet and
4037 to make use of the new v1.0 features.
4038 The whole thing also needs to be merged with the section following it.-jw
4039 It may also be badly out of date.-rh (2008)]
4042 \begin_layout Subsection
4043 Defining Own Keymaps: Keymap File Format
4046 \begin_layout Standard
4047 Let's look at a keyboard definition file a little closer.
4048 It is a plain text file defining
4051 \begin_layout Itemize
4052 key-to-key or key-to-string translations
4055 \begin_layout Itemize
4059 \begin_layout Itemize
4060 dead keys exceptions
4063 \begin_layout Standard
4064 To define key-to-key or key-to-string translation, use this command:
4067 \begin_layout Quotation
4068 \begin_inset Flex Code
4071 \begin_layout Plain Layout
4080 \begin_inset Flex Code
4083 \begin_layout Plain Layout
4092 \begin_layout Standard
4094 \begin_inset Flex Code
4097 \begin_layout Plain Layout
4103 is the key to be translated and
4104 \begin_inset Flex Code
4107 \begin_layout Plain Layout
4113 is the string to be inserted into the document.
4114 To define dead keys, use:
4117 \begin_layout Quotation
4118 \begin_inset Flex Code
4121 \begin_layout Plain Layout
4130 \begin_inset Flex Code
4133 \begin_layout Plain Layout
4142 \begin_layout Standard
4144 \begin_inset Flex Code
4147 \begin_layout Plain Layout
4153 is a keyboard key and
4154 \begin_inset Flex Code
4157 \begin_layout Plain Layout
4164 The following dead keys are supported (shortcut name is in parentheses):
4167 \begin_layout Quotation
4171 \begin_inset space \hfill{}
4177 \begin_layout Quotation
4179 \begin_inset space \hfill{}
4185 \begin_layout Quotation
4187 \begin_inset space \hfill{}
4193 \begin_layout Quotation
4195 \begin_inset space \hfill{}
4201 \begin_layout Quotation
4203 \begin_inset space \hfill{}
4209 \begin_layout Quotation
4211 \begin_inset space \hfill{}
4218 \begin_layout Plain Layout
4230 \begin_layout Quotation
4232 \begin_inset space \hfill{}
4238 \begin_layout Quotation
4240 \begin_inset space \hfill{}
4247 \begin_layout Plain Layout
4259 \begin_layout Quotation
4261 \begin_inset space \hfill{}
4267 \begin_layout Quotation
4269 \begin_inset space \hfill{}
4275 \begin_layout Quotation
4277 \begin_inset space \hfill{}
4284 \begin_layout Plain Layout
4296 \begin_layout Quotation
4298 \begin_inset space \hfill{}
4305 \begin_layout Plain Layout
4317 \begin_layout Quotation
4319 \begin_inset space \hfill{}
4325 \begin_layout Quotation
4326 hungarian umlaut (hug)
4327 \begin_inset space \hfill{}
4333 \begin_layout Quotation
4335 \begin_inset space \hfill{}
4341 \begin_layout Quotation
4343 \begin_inset space \hfill{}
4350 \begin_layout Plain Layout
4362 \begin_layout Standard
4363 Since in many international keyboards there are exceptions to what some
4364 dead keys should do, you can define them using
4367 \begin_layout Quotation
4368 \begin_inset Flex Code
4371 \begin_layout Plain Layout
4379 deadkey key outstring
4382 \begin_layout Standard
4383 For example, on Slovak keyboard, if you enter caron-o, it generates circumflex-o
4387 \begin_layout Quotation
4388 \begin_inset Flex Code
4391 \begin_layout Plain Layout
4404 \begin_layout Standard
4405 to make it work correctly.
4406 Also, you have to define as exceptions dead keys over i and j, to remove
4407 the dot from them before inserting an accent mark.
4408 I will change this when the time comes, but so far I haven't had time.
4411 \begin_layout Standard
4412 Oh, and about characters: backslash is escaped, so to enter it, you'll need
4415 \begin_inset Flex Code
4418 \begin_layout Plain Layout
4424 have different meaning.
4426 \begin_inset Flex Code
4429 \begin_layout Plain Layout
4435 marks comments, quotes start and end \SpecialChar LaTeX
4437 To enter quote, you'll need to use
4438 \begin_inset Flex Code
4441 \begin_layout Plain Layout
4450 \begin_inset Flex Code
4453 \begin_layout Plain Layout
4460 \begin_inset Flex Code
4463 \begin_layout Plain Layout
4474 \begin_layout Standard
4475 If you make a keyboard description file that works for your language, please
4476 mail it to me, so I can include it in the next keymap distribution.
4479 \begin_layout Standard
4480 More keywords will be supported in keymap configuration file in future,
4484 \begin_layout Itemize
4485 \begin_inset Flex Code
4488 \begin_layout Plain Layout
4499 \begin_inset space \hfill{}
4503 \begin_inset Flex Code
4506 \begin_layout Plain Layout
4515 \begin_layout Itemize
4516 \begin_inset Flex Code
4519 \begin_layout Plain Layout
4530 \begin_inset space \hfill{}
4534 \begin_inset Flex Code
4537 \begin_layout Plain Layout
4543 an external keymap translation program
4546 \begin_layout Standard
4547 Also, it should look into
4548 \begin_inset Flex Code
4551 \begin_layout Plain Layout
4557 file for defaults, too (for example, a
4558 \begin_inset Flex Code
4561 \begin_layout Plain Layout
4569 option to include default keyboard).
4577 \begin_layout Section
4578 International Keymap Stuff
4579 \begin_inset CommandInset label
4581 name "sec:International-Keymap-Stuff"
4588 \begin_layout Standard
4589 \begin_inset Note Note
4592 \begin_layout Plain Layout
4593 In doing the revisions on this document in March 2008, I did not look over
4594 this stuff, as I do not understand it.
4595 It would be good if someone else could do so.
4604 \begin_layout Standard
4605 The next two sections describe the
4606 \begin_inset Flex Code
4609 \begin_layout Plain Layout
4618 \begin_inset Flex Code
4621 \begin_layout Plain Layout
4629 file syntax in detail.
4630 These sections should help you design your own key map if the ones provided
4631 do not meet your needs.
4634 \begin_layout Subsection
4638 \begin_layout Standard
4642 \begin_inset Flex Code
4645 \begin_layout Plain Layout
4651 file maps keystrokes to characters or strings.
4652 As the name suggests, it sets a keyboard mapping.
4654 \begin_inset Flex Code
4657 \begin_layout Plain Layout
4668 \begin_inset Flex Code
4671 \begin_layout Plain Layout
4686 \begin_inset Flex Code
4689 \begin_layout Plain Layout
4702 \begin_inset Flex Code
4705 \begin_layout Plain Layout
4714 \begin_inset Flex Code
4717 \begin_layout Plain Layout
4725 are described in this section.
4728 \begin_layout Labeling
4729 \labelwidthstring 00.00.0000
4730 \begin_inset Flex Code
4733 \begin_layout Plain Layout
4741 Map a character to a string
4744 \begin_layout LyX-Code
4759 \begin_layout Standard
4792 the double-quote (")
4809 must be escaped with a preceding backslash (
4820 \begin_layout Standard
4822 \begin_inset Flex Noun
4825 \begin_layout Plain Layout
4833 statement to cause the symbol
4834 \begin_inset Flex Noun
4837 \begin_layout Plain Layout
4845 to be output for the keystroke
4846 \begin_inset Flex Noun
4849 \begin_layout Plain Layout
4860 \begin_layout LyX-Code
4866 \begin_layout Labeling
4867 \labelwidthstring 00.00.0000
4868 \begin_inset Flex Code
4871 \begin_layout Plain Layout
4879 Specify an accent character
4882 \begin_layout LyX-Code
4891 \begin_layout Standard
4892 This will make the cha
4930 This is the dead key
4934 \begin_layout Plain Layout
4941 refers to a key that does not produce a character by itself, but when followed
4942 with another key, produces the desired accent character.
4943 For example, a German characte
4945 r with an umlaut like
4955 can be produced in this manner.
4964 \begin_layout Standard
4977 and then another key not in
4994 followed by the other, not allowed key, as output.
4998 \begin_inset Flex Noun
5001 \begin_layout Plain Layout
5009 cancels a dead key, so if
5020 \begin_inset Flex Noun
5023 \begin_layout Plain Layout
5032 , the cursor will not go one position backwards but will instead cancel
5048 might have had on the next keystroke.
5052 \begin_layout Standard
5053 The following example specifies that the character ' is to be an acute accent,
5054 allowed on the characters a, e, i, o, u, A, E, I, O, and U:
5057 \begin_layout LyX-Code
5060 kmod ' acute aeiouAEIOU
5063 \begin_layout Labeling
5064 \labelwidthstring 00.00.0000
5065 \begin_inset Flex Code
5068 \begin_layout Plain Layout
5074 Specify an exception to the accent character
5077 \begin_layout LyX-Code
5086 \begin_layout Standard
5087 This defines an exce
5128 have been assigned a keystroke with a previous
5131 \begin_inset Flex Code
5134 \begin_layout Plain Layout
5158 must not belong in the
5205 If such a declaration does not exist in
5213 \begin_inset Flex Code
5216 \begin_layout Plain Layout
5250 \begin_inset Flex Code
5253 \begin_layout Plain Layout
5267 \begin_layout Standard
5268 The following command produces causes äi to be produced when you enter acute-i
5272 \begin_layout LyX-Code
5286 \begin_layout Labeling
5287 \labelwidthstring 00.00.0000
5288 \begin_inset Flex Code
5291 \begin_layout Plain Layout
5297 Combine two accent characters
5300 \begin_layout LyX-Code
5306 accent1 accent2 allowed
5309 \begin_layout Standard
5310 This one is getting pretty esoteric.
5311 It allows you to combine the effect
5367 \begin_inset Flex Code
5370 \begin_layout Plain Layout
5398 \begin_layout Standard
5399 Consider this example from the
5400 \begin_inset Flex Code
5403 \begin_layout Plain Layout
5414 \begin_layout LyX-Code
5417 kmod ; acute aeioyvhAEIOYVH
5421 kcomb acute umlaut iyIY
5424 \begin_layout Standard
5425 This allows you to press
5426 \begin_inset Flex Noun
5429 \begin_layout Plain Layout
5437 and get the effect of
5438 \begin_inset Flex Code
5441 \begin_layout Plain Layout
5460 in this case cancels the last dead key, so if you press
5461 \begin_inset Flex Noun
5464 \begin_layout Plain Layout
5473 \begin_inset Flex Code
5476 \begin_layout Plain Layout
5489 \begin_layout Subsection
5493 \begin_layout Standard
5495 \begin_inset Flex Code
5498 \begin_layout Plain Layout
5506 mapping is performed, a
5507 \begin_inset Flex Code
5510 \begin_layout Plain Layout
5520 file maps the strings that the symbols generate to characters in the current
5522 The \SpecialChar LyX
5523 distribution currently includes at least the
5524 \begin_inset Flex Code
5527 \begin_layout Plain Layout
5536 \begin_inset Flex Code
5539 \begin_layout Plain Layout
5550 \begin_layout Standard
5552 \begin_inset Flex Code
5555 \begin_layout Plain Layout
5563 file is a sequence of declarations of the form
5566 \begin_layout LyX-Code
5579 \begin_layout Standard
5580 For example, in order to map
5581 \begin_inset Flex Noun
5584 \begin_layout Plain Layout
5594 to the corresponding character in the iso-8859-1 set (233), the following
5598 \begin_layout LyX-Code
5606 \begin_layout Standard
5608 \begin_inset Flex Code
5611 \begin_layout Plain Layout
5620 \begin_inset Flex Code
5623 \begin_layout Plain Layout
5641 the same character can apply to more than one string.
5643 \begin_inset Flex Code
5646 \begin_layout Plain Layout
5657 \begin_layout LyX-Code
5669 \begin_inset Newline newline
5685 \begin_layout Standard
5687 cannot find a mapping for the string produced by the keystroke or a
5688 deadkey sequence, it will check if it looks like an accented char and try
5689 to draw an accent over the character on screen.
5692 \begin_layout Subsection
5696 \begin_layout Standard
5697 There is a second way to add support for international characters through
5698 so-called dead-keys.
5699 A dead-key works in combination with a letter to produce an accented character.
5700 Here, we'll explain how to create a really simple dead-key to illustrate
5704 \begin_layout Standard
5705 Suppose you happen to need the circumflex character,
5706 \begin_inset Quotes eld
5710 \begin_inset Quotes erd
5715 \begin_inset Flex Noun
5718 \begin_layout Plain Layout
5725 \begin_inset space ~
5729 \begin_inset Flex Noun
5732 \begin_layout Plain Layout
5738 ] to the \SpecialChar LyX
5740 \begin_inset Flex Code
5743 \begin_layout Plain Layout
5750 \begin_inset Flex Code
5753 \begin_layout Plain Layout
5760 Now, whenever you type the
5761 \begin_inset Flex Noun
5764 \begin_layout Plain Layout
5770 -key followed by a letter, that letter will have a circumflex accent on
5772 For example, the sequence
5773 \begin_inset Quotes eld
5777 \begin_inset Flex Noun
5780 \begin_layout Plain Layout
5787 \begin_inset Quotes erd
5790 produces the letter:
5791 \begin_inset Quotes eld
5795 \begin_inset Quotes erd
5799 If you tried to type
5800 \begin_inset Quotes eld
5804 \begin_inset Flex Noun
5807 \begin_layout Plain Layout
5814 \begin_inset Quotes erd
5817 , however, \SpecialChar LyX
5818 will complain with a beep, since a
5819 \begin_inset Quotes eld
5823 \begin_inset Flex Noun
5826 \begin_layout Plain Layout
5833 \begin_inset Quotes erd
5836 never takes a circumflex accent.
5838 \begin_inset Flex Noun
5841 \begin_layout Plain Layout
5847 after a dead-key produces the bare-accent.
5848 Please note this last point! If you bind a key to a dead-key, you'll need
5849 to rebind the character on that key to yet another key.
5851 \begin_inset Flex Noun
5854 \begin_layout Plain Layout
5860 to a cedilla is a bad idea, since you'll only get cedillas instead of commas.
5863 \begin_layout Standard
5864 One common way to bind dead-keys is to use
5865 \begin_inset Flex Noun
5868 \begin_layout Plain Layout
5875 \begin_inset Flex Noun
5878 \begin_layout Plain Layout
5885 \begin_inset Flex Noun
5888 \begin_layout Plain Layout
5894 in combination with an accent, like
5895 \begin_inset Quotes eld
5899 \begin_inset Flex Noun
5902 \begin_layout Plain Layout
5909 \begin_inset Quotes erd
5913 \begin_inset Quotes eld
5917 \begin_inset Flex Noun
5920 \begin_layout Plain Layout
5927 \begin_inset Quotes erd
5931 \begin_inset Quotes eld
5935 \begin_inset Flex Noun
5938 \begin_layout Plain Layout
5945 \begin_inset Quotes erd
5949 Another way involves using
5950 \begin_inset Flex Code
5953 \begin_layout Plain Layout
5960 \begin_inset Flex Code
5963 \begin_layout Plain Layout
5969 to set up the special
5970 \begin_inset Flex Code
5973 \begin_layout Plain Layout
5981 \begin_inset Flex Code
5984 \begin_layout Plain Layout
5990 acts in some ways just like
5991 \begin_inset Flex Noun
5994 \begin_layout Plain Layout
6000 and permits you to bind keys to accented characters.
6001 You can also turn keys into dead-keys by binding them to something like
6003 \begin_inset Flex Code
6006 \begin_layout Plain Layout
6012 and then binding this symbolic key to the corresponding \SpecialChar LyX
6017 \begin_layout Plain Layout
6022 : This is exactly what I do in my
6023 \begin_inset Flex Code
6026 \begin_layout Plain Layout
6033 \begin_inset Flex Code
6036 \begin_layout Plain Layout
6044 \begin_inset Flex Noun
6047 \begin_layout Plain Layout
6049 \begin_inset space ~
6058 \begin_inset Flex Code
6061 \begin_layout Plain Layout
6067 and a bunch of these
6068 \begin_inset Quotes eld
6072 \begin_inset Flex Code
6075 \begin_layout Plain Layout
6082 \begin_inset Quotes erd
6085 symbolic keys bound such things as
6086 \begin_inset Flex Noun
6089 \begin_layout Plain Layout
6091 \begin_inset space ~
6100 \begin_inset Flex Noun
6103 \begin_layout Plain Layout
6105 \begin_inset space ~
6114 This is how I produce my accented characters.
6119 You can make just about anything into the
6120 \begin_inset Flex Code
6123 \begin_layout Plain Layout
6130 \begin_inset Flex Noun
6133 \begin_layout Plain Layout
6139 keys, a spare function key, etc.
6140 As for the \SpecialChar LyX
6141 commands that produce accents, check the entry for
6142 \begin_inset Flex Code
6145 \begin_layout Plain Layout
6156 You'll find the complete list there.
6159 \begin_layout Subsection
6160 Saving your Language Configuration
6163 \begin_layout Standard
6164 You can edit your preferences so that your desired language environment
6165 is automatically configured when \SpecialChar LyX
6167 \begin_inset Flex Noun
6170 \begin_layout Plain Layout
6171 Edit\SpecialChar menuseparator
6180 \begin_layout Chapter
6182 \change_inserted -584632292 1610232084
6185 Installing New Document Classes, Layouts, and Templates
6186 \begin_inset CommandInset label
6188 name "cha:Installing-New-Document"
6193 \begin_inset Argument 1
6196 \begin_layout Plain Layout
6197 Installing New Document Classes
6205 \begin_layout Standard
6206 In this chapter, we describe the procedures for creating and installing
6207 new \SpecialChar LyX
6208 layout and template files, as well as offer a refresher on correctly
6209 installing new \SpecialChar LaTeX
6214 \begin_layout Standard
6215 First, let us a say a few words about how one ought to think about the relation
6216 between \SpecialChar LyX
6217 and \SpecialChar LaTeX
6219 The thing to understand is that, in a certain sense, \SpecialChar LyX
6220 doesn't know anything
6221 about \SpecialChar LaTeX
6223 Indeed, from \SpecialChar LyX
6224 's point of view, \SpecialChar LaTeX
6225 is just one of several
6226 \begin_inset Quotes eld
6230 \begin_inset Quotes erd
6233 in which it is capable of producing output.
6234 Other such formats are DocBook, plaintext, and XHTML.
6236 is, of course, a particularly important format, but very little of the
6237 information \SpecialChar LyX
6238 has about \SpecialChar LaTeX
6239 is actually contained in the program itself.
6243 \begin_layout Plain Layout
6244 Some commands are sufficiently complex that they are
6245 \begin_inset Quotes eld
6249 \begin_inset Quotes erd
6252 into \SpecialChar LyX
6254 But the developers generally regard this as a Bad Thing.
6259 Rather, that information, even for the standard classes like
6260 \begin_inset Flex Code
6263 \begin_layout Plain Layout
6269 , is contained in `layout files'.
6270 Similarly, \SpecialChar LyX
6271 itself does not know much about DocBook or XHTML.
6272 What it knows is contained in layout files.
6275 \begin_layout Standard
6276 You can think of the layout file for a given document class as a translation
6277 manual between \SpecialChar LyX
6278 constructs—paragraphs with their corresponding styles,
6279 certain sorts of insets, etc—and the corresponding \SpecialChar LaTeX
6282 Almost everything \SpecialChar LyX
6284 \begin_inset Flex Code
6287 \begin_layout Plain Layout
6293 , for example, is contained in the file
6294 \begin_inset Flex Code
6297 \begin_layout Plain Layout
6303 and in various other files it includes.
6304 For this reason, anyone intending to write layout files should plan to
6305 study the existing files.
6306 A good place to start is with
6307 \begin_inset Flex Code
6310 \begin_layout Plain Layout
6316 , which is included in
6317 \begin_inset Flex Code
6320 \begin_layout Plain Layout
6327 \begin_inset Flex Code
6330 \begin_layout Plain Layout
6336 , and many of the other layout files for document classes.
6337 This file is where sections and the like are defined:
6338 \begin_inset Flex Code
6341 \begin_layout Plain Layout
6347 tells \SpecialChar LyX
6348 how paragraphs that are marked with the Section, Subsection, etc,
6349 styles can be translated into corresponding \SpecialChar LaTeX
6350 , DocBook, and XHTML commands
6353 \begin_inset Flex Code
6356 \begin_layout Plain Layout
6362 file basically just includes several of these
6363 \begin_inset Flex Code
6366 \begin_layout Plain Layout
6375 \begin_layout Standard
6376 Defining the \SpecialChar LyX
6378 correspondence is not the only thing layout files do, though.
6379 Their other job is to define how the \SpecialChar LyX
6380 constructs themselves will appear
6382 The fact that layout files have these two jobs is often a source of confusion,
6383 because they are completely separate.
6384 Telling \SpecialChar LyX
6385 how to translate a certain paragraph style into \SpecialChar LaTeX
6388 how to display it; conversely, telling \SpecialChar LyX
6389 how to display a certain paragraph
6390 style does not tell \SpecialChar LyX
6391 how to translate it into \SpecialChar LaTeX
6392 (let alone tell \SpecialChar LaTeX
6395 So, in general, when you define a new \SpecialChar LyX
6396 construct, you must always do two
6397 quite separate things: (i)
6398 \begin_inset space ~
6401 tell \SpecialChar LyX
6402 how to translate it into \SpecialChar LaTeX
6404 \begin_inset space ~
6407 tell \SpecialChar LyX
6411 \begin_layout Standard
6412 Much the same is true, of course, as regards \SpecialChar LyX
6413 's other backend formats, though
6414 XHTML is in some ways different, because in that case \SpecialChar LyX
6419 able, to some extent, to use information about how it should display a
6420 paragraph on the screen to output information (in the form of CSS) about
6421 how the paragraph should be displayed in a browser.
6422 Even in this case, however, the distinction between what \SpecialChar LyX
6424 and how things are rendered externally remains in force, and the two can
6425 be controlled separately.
6427 \begin_inset CommandInset ref
6429 reference "sec:Tags-for-XHTML"
6436 \begin_layout Section
6437 Installing new \SpecialChar LaTeX
6441 \begin_layout Standard
6442 Some installations may not include a \SpecialChar LaTeX
6443 package or class file that you would
6444 like to use within \SpecialChar LyX
6446 For example, you might need Foil\SpecialChar TeX
6447 , a package for preparing slides for overhead
6449 Modern \SpecialChar LaTeX
6450 distributions like \SpecialChar TeX
6451 Live (2008 or newer) or MiK\SpecialChar TeX
6452 provide a user interface
6453 for installing such packages.
6454 For example, with MiK\SpecialChar TeX
6455 , you start the program
6456 \begin_inset Quotes eld
6460 \begin_inset space ~
6464 \begin_inset Quotes erd
6467 to get a list of available packages.
6468 To install one of them, right click on it or use the corresponding toolbar
6472 \begin_layout Standard
6473 If your \SpecialChar LaTeX
6474 distribution does not provide such a `package manager', or if the
6475 package is not available from your distribution, then follow these steps
6476 to install it manually:
6479 \begin_layout Enumerate
6480 Get the package from
6481 \begin_inset CommandInset href
6484 target "http://www.ctan.org/"
6492 \begin_layout Enumerate
6493 If the package contains a file with the ending
6494 \begin_inset Quotes eld
6498 \begin_inset Flex Code
6501 \begin_layout Plain Layout
6508 \begin_inset Quotes erd
6511 (is the case for Foil\SpecialChar TeX
6512 ) then open a console, change to the folder of this
6513 file and execute the command
6514 \begin_inset Flex Code
6517 \begin_layout Plain Layout
6524 You have now unpacked the package and have all files to install it.
6525 Most \SpecialChar LaTeX
6526 -packages are not packed and you can skip this step.
6529 \begin_layout Enumerate
6530 Now you need to decide if the package should be available for all users
6535 \begin_layout Enumerate
6536 On *nix systems (Linux, OSX, etc.), if you want the new package to be available
6537 for all users on your system, then install it in your `local' \SpecialChar TeX
6539 install it in your own `user' \SpecialChar TeX
6541 Where these trees should be created, if they do not already exist, depends
6543 To find this out, look in the file
6544 \begin_inset Flex Code
6547 \begin_layout Plain Layout
6557 \begin_layout Plain Layout
6558 This is usually in the directory
6559 \begin_inset Flex Code
6562 \begin_layout Plain Layout
6568 , though you can execute the command
6569 \begin_inset Flex Code
6572 \begin_layout Plain Layout
6583 The location of the `local' \SpecialChar TeX
6584 tree is defined by the
6585 \begin_inset Flex Code
6588 \begin_layout Plain Layout
6594 variable; this is usually somewhere like
6595 \begin_inset Flex Code
6598 \begin_layout Plain Layout
6599 /usr/local/share/texmf
6604 or /usr/local/texlive/XXXX where XXXX is the year of the installed \SpecialChar TeX
6607 The location of the `user' \SpecialChar TeX
6609 \begin_inset Flex Code
6612 \begin_layout Plain Layout
6619 \begin_inset Flex Code
6622 \begin_layout Plain Layout
6629 \begin_inset Flex Code
6632 \begin_layout Plain Layout
6641 (If these variables are not predefined, you have to define them.) You'll
6642 probably need root permissions to create or modify the `local' tree, but
6643 not for your `user' tree.
6644 \begin_inset Newline newline
6647 In general, it is recommended to install in the user tree because your user
6648 will not be modified or even overwritten when you upgrade your system.
6649 It will typically also be backed up together with everything else when
6650 you backup your home directory (which, of course, you do on a regular basis).
6653 \begin_layout Enumerate
6654 On Windows, if you want the new package to be available for all users on
6655 your system, change to the folder where \SpecialChar LaTeX
6656 is installed and then change to
6658 \begin_inset Flex Code
6661 \begin_layout Plain Layout
6672 (For MiK\SpecialChar TeX
6673 , this would be by default the folder
6674 \begin_inset Flex Code
6677 \begin_layout Plain Layout
6695 \begin_layout Plain Layout
6696 Note that this will be the correct path only on English installations.
6697 On a German one, it would be
6698 \begin_inset Flex Code
6701 \begin_layout Plain Layout
6715 , and similarly for other languages.
6720 Create there a new folder
6721 \begin_inset Flex Code
6724 \begin_layout Plain Layout
6730 and copy all files of the package into it.
6732 \begin_inset Newline newline
6735 If the package should only available for you or you don't have admin permissions
6736 , do the same, but in the local \SpecialChar LaTeX
6739 \begin_inset space \thinspace{}
6742 g., for MiK\SpecialChar TeX
6744 \begin_inset space ~
6747 2.8 under Windows XP, this would be the folder:
6748 \begin_inset Newline newline
6754 \begin_inset Flex Code
6757 \begin_layout Plain Layout
6760 Documents and Settings
6772 \begin_inset Newline newline
6778 \begin_inset Phantom HPhantom
6781 \begin_layout Plain Layout
6792 \begin_inset Flex Code
6795 \begin_layout Plain Layout
6808 \begin_inset Newline newline
6811 On Vista, it would be:
6812 \begin_inset Newline newline
6816 \begin_inset Flex Code
6819 \begin_layout Plain Layout
6845 \begin_layout Enumerate
6846 Now one only need to tell \SpecialChar LaTeX
6847 that there are new files.
6848 This depends on the used \SpecialChar LaTeX
6853 \begin_layout Enumerate
6854 For \SpecialChar TeX
6855 Live execute the command
6856 \begin_inset Flex Code
6859 \begin_layout Plain Layout
6866 If you installed the package for all users, then you will probably need
6867 to have root permissions for that.
6870 \begin_layout Enumerate
6871 For MiK\SpecialChar TeX
6872 , if you have installed the package for all users, start the program
6874 \begin_inset Quotes eld
6878 \begin_inset space ~
6882 \begin_inset Quotes erd
6885 and press the button marked
6886 \begin_inset Quotes eld
6890 \begin_inset Quotes erd
6894 Otherwise start the program
6895 \begin_inset Quotes eld
6899 \begin_inset Quotes erd
6906 \begin_layout Enumerate
6907 Finally, you need to tell \SpecialChar LyX
6908 that there are new packages available.
6909 So, in \SpecialChar LyX
6911 \begin_inset Flex Noun
6914 \begin_layout Plain Layout
6917 \SpecialChar menuseparator
6923 and then restart \SpecialChar LyX
6927 \begin_layout Standard
6928 Now the package is installed.
6929 In our example, the document class
6930 \begin_inset Flex Code
6933 \begin_layout Plain Layout
6939 will now be available under
6940 \begin_inset Flex Noun
6943 \begin_layout Plain Layout
6944 Document\SpecialChar menuseparator
6945 Settings\SpecialChar menuseparator
6952 \begin_inset Quotes eld
6956 \begin_inset Quotes erd
6963 \begin_layout Standard
6964 If you would like to use a \SpecialChar LaTeX
6965 document class that is not even listed in the
6967 \begin_inset Flex Noun
6970 \begin_layout Plain Layout
6971 Document\SpecialChar menuseparator
6972 Settings\SpecialChar menuseparator
6978 , then you need to create a `layout' file for it.
6979 That is the topic of the next section.
6982 \begin_layout Section
6983 Types of layout files
6986 \begin_layout Standard
6987 This section describes the various sorts of \SpecialChar LyX
6988 files that contain layout informati
6990 These files describe various paragraph and character styles, determining
6991 how \SpecialChar LyX
6992 should display them and how they should be translated into \SpecialChar LaTeX
6994 XHTML, or whatever output format is being used.
6998 \begin_layout Standard
6999 We shall try to provide a thorough description of the process of writing
7001 However, there are so many different types of documents supported even
7002 by just \SpecialChar LaTeX
7003 that we can't hope to cover every different possibility or problem
7004 you might encounter.
7005 The \SpecialChar LyX
7006 users' list is frequented by people with lots of experience with layout
7007 design who are willing to share what they've learned, so please feel free
7008 to ask questions there.
7011 \begin_layout Standard
7012 As you prepare to write a new layout, it is extremely helpful to look at
7013 the layouts distributed with \SpecialChar LyX
7015 If you write a \SpecialChar LyX
7016 layout for a \SpecialChar LaTeX
7017 document class that might also be used by
7018 others, or write a module that might be useful to others, then you should
7019 consider posting your layout to the
7020 \begin_inset CommandInset href
7022 name "layout section on the LyX wiki"
7023 target "https://wiki.lyx.org/Layouts/Layouts"
7028 or even to the \SpecialChar LyX
7029 developers' list, so that it might be included in \SpecialChar LyX
7034 \begin_layout Plain Layout
7035 Note that \SpecialChar LyX
7036 is licensed under the General Public License, so any material
7037 that is contributed to \SpecialChar LyX
7038 must be similarly licensed.
7046 \begin_layout Subsection
7048 \begin_inset CommandInset label
7050 name "subsec:Layout-modules"
7057 \begin_layout Standard
7058 We have spoken to this point about `layout files'.
7059 But there are different sorts of files that contain layout information.
7060 Layout files, strictly so called, have the
7061 \begin_inset Flex Code
7064 \begin_layout Plain Layout
7070 extension and provide \SpecialChar LyX
7071 with information about document classes.
7072 Since \SpecialChar LyX
7073 1.6 layout information can also be contained in layout
7078 \begin_inset Flex Code
7081 \begin_layout Plain Layout
7088 Modules are to \SpecialChar LaTeX
7089 packages much as layouts are to \SpecialChar LaTeX
7090 classes, and some modules—such
7092 \begin_inset Flex Code
7095 \begin_layout Plain Layout
7101 module—specifically provide support for one package.
7102 In a sense, layout modules are similar to included
7106 \begin_layout Plain Layout
7107 These can have any extension, but by convention have the
7108 \begin_inset Flex Code
7111 \begin_layout Plain Layout
7123 \begin_inset Flex Code
7126 \begin_layout Plain Layout
7132 —in that modules are not specific to a given document class but may be used
7133 with many different classes.
7134 The difference is that using an included file with
7135 \begin_inset Flex Code
7138 \begin_layout Plain Layout
7144 requires editing that file.
7145 Modules, by contrast, are selected in the
7146 \begin_inset Flex Noun
7149 \begin_layout Plain Layout
7150 Document\SpecialChar menuseparator
7159 \begin_layout Standard
7160 Building modules is the easiest way to get started with layout editing,
7161 since it can be as simple as adding a single new paragraph style or flex
7163 But modules may, in principle, contain anything a layout file can contain.
7166 \begin_layout Standard
7167 After creating a new module and copying it to the
7168 \begin_inset Flex Code
7171 \begin_layout Plain Layout
7177 folder, you will need to reconfigure and then restart \SpecialChar LyX
7180 However, changes you make to the module will be seen immediately, if you
7182 \begin_inset Flex Noun
7185 \begin_layout Plain Layout
7186 Document\SpecialChar menuseparator
7192 , highlight something, and then hit
7193 \begin_inset Quotes eld
7197 \begin_inset Quotes erd
7203 It is strongly recommended that you save your work before doing this
7208 it is strongly recommended that you not attempt to edit modules while simultaneo
7209 usly working on actual documents
7212 Though of course the developers strive to keep \SpecialChar LyX
7213 stable in such situations,
7214 syntax errors and the like in your module file could cause strange behavior.
7217 \begin_layout Subsubsection
7221 \begin_layout Standard
7222 Modules are to \SpecialChar LyX
7223 as packages are to \SpecialChar LaTeX
7225 Sometimes, however, you find yourself wanting a specific inset or character
7226 style just for one document and writing a module that will also be available
7227 to other documents makes little sense.
7228 What you need is \SpecialChar LyX
7230 \begin_inset Quotes eld
7234 \begin_inset Quotes erd
7240 \begin_layout Standard
7241 You will find it under
7243 Document\SpecialChar menuseparator
7244 Settings\SpecialChar menuseparator
7248 The large text box allows you to enter anything that you might enter in
7249 a layout file or module.
7250 You can think of a document's local layout, in fact, as a module that belongs
7252 So, in particular, you must enter a
7253 \begin_inset Flex Code
7256 \begin_layout Plain Layout
7263 Any format is acceptable, but one would normally use the format current
7265 (In \SpecialChar LyX
7272 , the current layout format is
7281 \begin_layout Standard
7282 When you have entered something in the
7283 \begin_inset Flex Code
7286 \begin_layout Plain Layout
7292 pane, \SpecialChar LyX
7294 \begin_inset Quotes eld
7298 \begin_inset Quotes erd
7301 button at the bottom.
7302 Clicking this button will cause \SpecialChar LyX
7303 to determine whether what you have entered
7304 is valid layout information for the chosen format.
7306 will report the result but, unfortunately, will not tell you what errors
7307 there might have been.
7308 These will be written to the terminal, however, if \SpecialChar LyX
7309 is started from a terminal.
7310 You will not be permitted to save your local layout until you have entered
7314 \begin_layout Standard
7315 The warnings at the end of the previous section apply here, too.
7316 Do not play with local layout while you are actually working, especially
7317 if you have not saved your document.
7318 That said, using local layout with a test document can be a very convenient
7319 way to try out layout ideas, or even to start developing a module.
7322 \begin_layout Subsection
7324 \begin_inset Flex Noun
7327 \begin_layout Plain Layout
7336 \begin_layout Standard
7337 There are two situations you are likely to encounter when wanting to support
7338 a new \SpecialChar LaTeX
7339 document class, involving style (
7340 \begin_inset Flex Code
7343 \begin_layout Plain Layout
7349 ) files and \SpecialChar LaTeX2e
7351 \begin_inset Flex Code
7354 \begin_layout Plain Layout
7361 Supporting a style file is usually fairly easy.
7362 Supporting a new class file is a bit harder.
7363 We'll discuss the former in this section and the latter in the next.
7365 \change_deleted 5863208 1594239023
7366 Similar remarks apply, of course, if you want to support a new DocBook DTD.
7371 \begin_layout Standard
7372 The easier case is the one in which your new document class is provided
7373 as a style file that is to be used in conjunction with an already supported
7375 For the sake of the example, we'll assume that the style file is called
7377 \begin_inset Flex Noun
7380 \begin_layout Plain Layout
7386 and that it is meant to be used with
7387 \begin_inset Flex Noun
7390 \begin_layout Plain Layout
7396 , which is a standard class.
7400 \begin_layout Standard
7401 Start by copying the existing class's layout file into your local directory:
7405 \begin_layout Plain Layout
7406 Of course, which directory is your local directory will vary by platform,
7407 and \SpecialChar LyX
7408 allows you to specify your local directory on startup, too, using
7410 \begin_inset Flex Code
7413 \begin_layout Plain Layout
7427 \begin_layout LyX-Code
7428 cp report.layout ~/.lyx/layouts/myclass.layout
7431 \begin_layout Standard
7433 \begin_inset Flex Code
7436 \begin_layout Plain Layout
7442 and change the line:
7445 \begin_layout LyX-Code
7448 DeclareLaTeXClass{Report (Standard Class)}
7451 \begin_layout Standard
7455 \begin_layout LyX-Code
7458 DeclareLaTeXClass[report, myclass.sty]{Report (My Class)}
7461 \begin_layout Standard
7465 \begin_layout LyX-Code
7467 \begin_inset Newline newline
7473 \begin_inset Newline newline
7479 \begin_layout Standard
7480 near the top of the file.
7483 \begin_layout Standard
7484 Start \SpecialChar LyX
7486 \begin_inset Flex Noun
7489 \begin_layout Plain Layout
7490 Tools\SpecialChar menuseparator
7497 Then restart \SpecialChar LyX
7498 and try creating a new document.
7500 \begin_inset Flex Noun
7503 \begin_layout Plain Layout
7509 " as a document class option in the
7510 \begin_inset Flex Noun
7513 \begin_layout Plain Layout
7514 Document\SpecialChar menuseparator
7521 It is likely that some of the sectioning commands and such in your new
7522 class will work differently from how they worked in the base class—
7523 \begin_inset Flex Code
7526 \begin_layout Plain Layout
7532 in this example—so you can fiddle around with the settings for the different
7533 sections if you wish.
7534 The layout information for sections is contained in
7535 \begin_inset Flex Code
7538 \begin_layout Plain Layout
7544 , but you do not need to copy and change this file.
7545 Instead, you can simply add your changes to your layout file, after the
7547 \begin_inset Flex Code
7550 \begin_layout Plain Layout
7556 , which itself includes
7557 \begin_inset Flex Code
7560 \begin_layout Plain Layout
7567 For example, you might add these lines:
7570 \begin_layout LyX-Code
7574 \begin_layout LyX-Code
7578 \begin_layout LyX-Code
7582 \begin_layout LyX-Code
7586 \begin_layout LyX-Code
7590 \begin_layout Standard
7591 to change the font for chapter headings to sans-serif.
7592 This will override (or, in this case, add to) the existing declaration
7593 for the Chapter style.
7597 \begin_layout Standard
7598 Your new package may also provide commands or environments not present in
7600 In this case, you will want to add these to the layout file.
7602 \begin_inset CommandInset ref
7604 reference "sec:TextClass"
7608 for information on how to do so.
7611 \begin_layout Standard
7613 \begin_inset Flex Noun
7616 \begin_layout Plain Layout
7622 can be used with several different document classes, and even if it cannot,
7623 you might find it easiest just to write a module that you can load with
7625 The simplest possible such module would be:
7628 \begin_layout LyX-Code
7631 DeclareLyXModule{My Class}
7634 \begin_layout LyX-Code
7638 \begin_layout LyX-Code
7639 #Support for myclass.sty.
7642 \begin_layout LyX-Code
7644 \begin_inset Newline newline
7650 \begin_layout LyX-Code
7658 \begin_inset Newline newline
7664 \begin_layout LyX-Code
7666 \begin_inset Newline newline
7672 \begin_inset Newline newline
7678 \begin_layout Standard
7679 A more complex module might modify the behavior of some existing constructs
7680 or define some new ones.
7682 \begin_inset CommandInset ref
7684 reference "sec:TextClass"
7691 \begin_layout Subsection
7693 \begin_inset Flex Noun
7696 \begin_layout Plain Layout
7705 \begin_layout Standard
7706 There are two possibilities here.
7707 One is that the class file is itself based upon an existing document class.
7708 For example, many thesis classes are based upon
7709 \begin_inset Flex Noun
7712 \begin_layout Plain Layout
7719 To see whether yours is, look for a line like
7722 \begin_layout LyX-Code
7728 \begin_layout Standard
7730 If so, then you may proceed largely as in the previous section, though
7732 \begin_inset Flex Code
7735 \begin_layout Plain Layout
7736 Declare\SpecialChar LaTeX
7742 line will be different.
7743 If your new class is
7744 \begin_inset Flex Code
7747 \begin_layout Plain Layout
7753 and it is based upon
7754 \begin_inset Flex Code
7757 \begin_layout Plain Layout
7763 , then the line should read:
7767 \begin_layout Plain Layout
7768 And it will be easiest if you save the file to
7769 \begin_inset Flex Code
7772 \begin_layout Plain Layout
7779 assumes that the document class has the same name as the layout file.
7788 \begin_layout LyX-Code
7791 DeclareLaTeXClass[thesis,book]{thesis}
7794 \begin_layout Standard
7795 If, on the other hand, the new class is not based upon an existing class,
7796 you will probably have to
7797 \begin_inset Quotes eld
7801 \begin_inset Quotes erd
7805 We strongly suggest copying an existing layout file which uses a similar
7807 class and then modifying it, if you can do so.
7808 At least use an existing file as a starting point so you can find out what
7809 items you need to worry about.
7810 Again, the specifics are covered below.
7813 \begin_layout Subsection
7815 \begin_inset CommandInset label
7817 name "subsec:Creating-Templates"
7824 \begin_layout Standard
7825 Once you have written a layout file for a new document class, you might
7826 want to consider writing a
7831 A template acts as a kind of tutorial for your layout, showing how it might
7832 be used, though containing dummy content.
7833 You can of course look at the various templates included with \SpecialChar LyX
7837 \begin_layout Standard
7838 Templates are created just like usual documents: using \SpecialChar LyX
7840 The only difference is that usual documents contain all possible settings,
7841 including the font scheme and the paper size.
7842 Usually a user doesn't want a template to overwrite his preferred settings
7843 for such parameters.
7844 For that reason, the designer of a template should remove the corresponding
7846 \begin_inset Flex Code
7849 \begin_layout Plain Layout
7858 \begin_inset Flex Code
7861 \begin_layout Plain Layout
7869 from the template \SpecialChar LyX
7871 This can be done with any simple text-editor, for example
7872 \begin_inset Flex Code
7875 \begin_layout Plain Layout
7882 \begin_inset Flex Code
7885 \begin_layout Plain Layout
7894 \begin_layout Standard
7895 Put the edited template files you create in
7896 \begin_inset Flex Code
7899 \begin_layout Plain Layout
7905 , copy the ones you use from the global template directory in
7906 \begin_inset Flex Code
7909 \begin_layout Plain Layout
7915 to the same place, and redefine the template path in the
7916 \begin_inset Flex Noun
7919 \begin_layout Plain Layout
7920 Tools\SpecialChar menuseparator
7921 Preferences\SpecialChar menuseparator
7930 \begin_layout Standard
7931 Note, by the way, that there is a template which has a particular meaning:
7932 \begin_inset Newline linebreak
7936 \begin_inset Flex Code
7939 \begin_layout Plain Layout
7946 This template is loaded every time you create a new document with
7947 \begin_inset Flex Noun
7950 \begin_layout Plain Layout
7951 File\SpecialChar menuseparator
7957 in order to provide useful defaults.
7958 To create this template from inside \SpecialChar LyX
7959 , all you have to do is to open a document
7960 with the correct settings, and use the
7961 \begin_inset Flex Noun
7964 \begin_layout Plain Layout
7965 Save as Document Defaults
7973 \begin_layout Subsection
7974 Upgrading old layout files
7977 \begin_layout Standard
7978 The format of layout files changes with each \SpecialChar LyX
7979 release, so old layout files
7980 need to be converted to the new format.
7982 reads a layout file in an older format, it automatically calls the
7984 \begin_inset Flex Code
7987 \begin_layout Plain Layout
7993 to convert it to a temporary file in current format.
7994 The original file is left untouched.
7995 If you use the layout file often, then, you may want to convert it permanently,
7996 so that \SpecialChar LyX
7997 does not have to do so itself every time.
7998 To do this, you can call the converter manually:
8001 \begin_layout Enumerate
8003 \begin_inset Flex Code
8006 \begin_layout Plain Layout
8013 \begin_inset Flex Code
8016 \begin_layout Plain Layout
8025 \begin_layout Enumerate
8027 \begin_inset Newline newline
8031 \begin_inset Flex Code
8034 \begin_layout Plain Layout
8035 python LyXDir/scripts/layout2layout.py myclass.old myclass.layout
8041 \begin_inset Newline newline
8045 \begin_inset Flex Code
8048 \begin_layout Plain Layout
8054 is the name of your \SpecialChar LyX
8058 \begin_layout Standard
8059 Note that manual conversion does not affect included files, so these will
8060 have to be converted separately.
8063 \begin_layout Subsection
8064 \begin_inset CommandInset label
8066 name "subsec:Cite-Engine-Files"
8073 \begin_layout Standard
8074 A specific form of layout files are the so-called
8075 \begin_inset Flex Code
8078 \begin_layout Plain Layout
8084 files that are located in the
8085 \begin_inset Flex Code
8088 \begin_layout Plain Layout
8095 Their purpose is to define the specifics of \SpecialChar LaTeX
8096 packages aimed at bibliography
8109 , but also the way how normal Bib\SpecialChar TeX
8110 citations (without additional packages)
8111 are handled in \SpecialChar LyX
8112 is defined in such a file.
8116 \begin_layout Standard
8117 More specifically, it is defined which packages \SpecialChar LyX
8118 needs to load, which citation
8119 commands are available, how these are to be displayed in \SpecialChar LyX
8121 the dialogs, the context menus) as well as in the XHTML and plain text
8123 Furthermore, the files specify available style variants (author-year, numerical
8124 , etc.) and their specifics.
8125 The cite engine files are also used to generate the options that are available
8128 Document\SpecialChar menuseparator
8129 Settings\SpecialChar menuseparator
8130 Bibliography\SpecialChar menuseparator
8136 \begin_layout Standard
8137 Even though a cite engine file is essentially a normal layout file that
8138 could theoretically include any layout information, it usually primarily
8139 includes some specific parameters such as
8140 \begin_inset Flex Code
8143 \begin_layout Plain Layout
8150 \begin_inset Flex Code
8153 \begin_layout Plain Layout
8160 \begin_inset Flex Code
8163 \begin_layout Plain Layout
8170 \begin_inset Flex Code
8173 \begin_layout Plain Layout
8180 The syntax of the latter two is described in
8181 \begin_inset CommandInset ref
8183 reference "subsec:Citation-engine-description"
8191 \begin_inset CommandInset ref
8193 reference "subsec:Citation-format-description"
8197 , as well as in the files themselves.
8200 \begin_layout Section
8201 \begin_inset CommandInset label
8203 name "sec:TextClass"
8207 The layout file format
8210 \begin_layout Standard
8211 The following sections describe how layout files are structured and written.
8212 Our advice is to go slowly, save and test often.
8213 It is really not that hard, except that the multitude of options can become
8214 overwhelming, especially if you try to check out too many at once.
8215 It becomes easier if you use existing layouts of \SpecialChar LyX
8216 as examples/reference
8217 or if you modify an existing layout to your needs.
8220 \begin_layout Standard
8221 Note that all the tags used in layout files are case-insensitive.
8223 \begin_inset Flex Code
8226 \begin_layout Plain Layout
8233 \begin_inset Flex Code
8236 \begin_layout Plain Layout
8243 \begin_inset Flex Code
8246 \begin_layout Plain Layout
8252 are really the same tag.
8253 The possible arguments are printed in brackets after the tag's name.
8254 The default argument is typeset
8255 \begin_inset Flex Code
8258 \begin_layout Plain Layout
8267 If the argument has a data type like
8268 \begin_inset Quotes eld
8272 \begin_inset Quotes erd
8276 \begin_inset Quotes eld
8280 \begin_inset Quotes erd
8283 , the default is shown like this:
8284 \begin_inset Flex Code
8287 \begin_layout Plain Layout
8298 \begin_layout Subsection
8299 The document class declaration and classification
8302 \begin_layout Standard
8303 Lines in a layout file which begin with
8304 \begin_inset Flex Code
8307 \begin_layout Plain Layout
8314 There is one exception to this rule.
8316 \begin_inset Flex Code
8319 \begin_layout Plain Layout
8325 files should begin with lines like:
8328 \begin_layout LyX-Code
8331 #% Do not delete the line below; configure depends on this
8334 \begin_layout LyX-Code
8339 DeclareLaTeXClass{Article (Standard Class)}
8342 \begin_layout LyX-Code
8347 DeclareCategory{Articles}
8350 \begin_layout Standard
8351 The second and third lines are used when you (re)configure \SpecialChar LyX
8353 The layout file is read by the \SpecialChar LaTeX
8355 \begin_inset Flex Code
8358 \begin_layout Plain Layout
8364 , in a special mode where
8365 \begin_inset Flex Code
8368 \begin_layout Plain Layout
8375 The first line is just a \SpecialChar LaTeX
8376 comment, the second one contains the mandatory
8377 declaration of the text class and the third line contains the optional
8378 classification of the class.
8379 If these lines appear in a file named
8380 \begin_inset Flex Code
8383 \begin_layout Plain Layout
8389 , then they define a text class of name
8390 \begin_inset Flex Code
8393 \begin_layout Plain Layout
8399 (the name of the layout file) which uses the \SpecialChar LaTeX
8401 \begin_inset Flex Code
8404 \begin_layout Plain Layout
8410 (the default is to use the same name as the layout).
8412 \begin_inset Quotes eld
8415 Article (Standard Class)
8416 \begin_inset Quotes erd
8419 that appears above is used as a description of the text class in the
8420 \begin_inset Flex Noun
8423 \begin_layout Plain Layout
8424 Document\SpecialChar menuseparator
8432 \begin_inset Quotes eld
8436 \begin_inset Quotes erd
8439 in the example) is also used in the
8440 \begin_inset Flex Noun
8443 \begin_layout Plain Layout
8444 Document\SpecialChar menuseparator
8450 dialog: the text classes are grouped by these categories (which are usually
8451 genres, so typical categories are
8452 \begin_inset Quotes eld
8456 \begin_inset Quotes erd
8460 \begin_inset Quotes eld
8464 \begin_inset Quotes erd
8468 \begin_inset Quotes eld
8472 \begin_inset Quotes erd
8476 \begin_inset Quotes eld
8480 \begin_inset Quotes erd
8484 \begin_inset Quotes eld
8488 \begin_inset Quotes erd
8492 \begin_inset Quotes eld
8496 \begin_inset Quotes erd
8500 If no category has been declared, the class will be put in the
8501 \begin_inset Quotes eld
8505 \begin_inset Quotes erd
8511 \begin_layout Standard
8512 Let's assume that you wrote your own text class that uses the
8513 \begin_inset Flex Code
8516 \begin_layout Plain Layout
8522 document class, but where you changed the appearance of the section headings.
8523 If you put it in a file
8524 \begin_inset Flex Code
8527 \begin_layout Plain Layout
8533 , the header of this file should be:
8536 \begin_layout LyX-Code
8539 #% Do not delete the line below; configure depends on this
8542 \begin_layout LyX-Code
8547 DeclareLaTeXClass[article]{Article (with My Own Headings)}
8550 \begin_layout LyX-Code
8555 DeclareCategory{Articles}
8558 \begin_layout Standard
8559 This declares a text class
8560 \begin_inset Flex Code
8563 \begin_layout Plain Layout
8569 , associated with the \SpecialChar LaTeX
8571 \begin_inset Flex Code
8574 \begin_layout Plain Layout
8581 \begin_inset Quotes eld
8584 Article (with My Own Headings)
8585 \begin_inset Quotes erd
8589 If your text class depends on several packages, you can declare it as:
8592 \begin_layout LyX-Code
8595 #% Do not delete the line below; configure depends on this
8598 \begin_layout LyX-Code
8603 DeclareLaTeXClass[article,foo.sty]{Article (with My Own Headings)}
8606 \begin_layout LyX-Code
8611 DeclareCategory{Articles}
8614 \begin_layout Standard
8615 This indicates that your text class uses the
8616 \begin_inset Flex Code
8619 \begin_layout Plain Layout
8627 \change_deleted 5863208 1594239179
8628 Finally, it is also possible to declare classes for DocBook code.
8629 Typical declarations will look like:
8632 \begin_layout LyX-Code
8634 \change_deleted 5863208 1594239179
8637 #% Do not delete the line below; configure depends on this
8640 \begin_layout LyX-Code
8642 \change_deleted 5863208 1594239179
8647 DeclareDocBookClass[article]{SGML (DocBook Article)}
8650 \begin_layout LyX-Code
8652 \change_deleted 5863208 1594239179
8657 DeclareCategory{Articles (DocBook)}
8662 \begin_layout Standard
8663 Note that these declarations can also be given an optional parameter declaring
8664 the name of the document class (but not a list).
8667 \begin_layout Standard
8668 So, to be as explicit as possible, the form of the layout declaration is:
8671 \begin_layout LyX-Code
8676 DeclareLaTeXClass[class,package.sty]{layout description}
8679 \begin_layout LyX-Code
8684 DeclareCategory{category}
8687 \begin_layout Standard
8688 The class need only be specified if the name of the \SpecialChar LaTeX
8690 name of the layout file are different or if there are packages to load.
8691 If the name of the class file is not specified, then \SpecialChar LyX
8693 that it is the same as the name of the layout file.
8696 \begin_layout Standard
8697 When the text class has been modified to your taste, all you have to do
8698 is to copy it either to
8699 \begin_inset Flex Code
8702 \begin_layout Plain Layout
8709 \begin_inset Flex Code
8712 \begin_layout Plain Layout
8719 \begin_inset Flex Noun
8722 \begin_layout Plain Layout
8723 Tools\SpecialChar menuseparator
8729 , exit \SpecialChar LyX
8731 Then your new text class should be available along with the others.
8734 \begin_layout Standard
8735 Once the layout file is installed, you can edit it and see your changes
8736 without having to reconfigure or to restart \SpecialChar LyX
8741 \begin_layout Plain Layout
8742 In versions of \SpecialChar LyX
8743 prior to 1.6, this was not true.
8744 As a result, editing layout files was very time consuming, since you had
8745 constantly to restart \SpecialChar LyX
8751 You can force a reload of the current layout by using the \SpecialChar LyX
8753 \begin_inset Flex Noun
8756 \begin_layout Plain Layout
8763 There is no default binding for this function—though, of course, you can
8764 bind it to a key yourself.
8765 But you will normally use this function simply by entering it in the mini-buffe
8770 \begin_layout Standard
8776 \begin_inset Flex Noun
8779 \begin_layout Plain Layout
8785 is very much an `advanced feature'.
8790 recommended that you save your work before using this function.
8795 recommended that you not attempt to edit layout information while simultaneousl
8796 y working on a document that you care about.
8797 Use a test document.
8798 Syntax errors and the like in your layout file could cause peculiar behavior.
8799 In particular, such errors could cause \SpecialChar LyX
8800 to regard the current layout as
8801 invalid and to attempt to switch to some other layout.
8805 \begin_layout Plain Layout
8806 Really bad syntax errors may even caused \SpecialChar LyX
8808 This is because certain sorts of errors may make \SpecialChar LyX
8819 The \SpecialChar LyX
8820 team strives to keep \SpecialChar LyX
8821 stable in such situations, but safe is better
8826 \begin_layout Plain Layout
8827 While we're giving advice: make regular backups.
8828 And be nice to your mother.
8836 \begin_layout Subsection
8837 The Module declaration
8840 \begin_layout Standard
8841 A module must begin with a line like the following:
8844 \begin_layout LyX-Code
8847 DeclareLyXModule[endnotes.sty]{Endnotes}
8848 \change_inserted -712698321 1554395911
8852 \begin_layout LyX-Code
8854 \change_inserted -712698321 1554395924
8859 DeclareCategory{Foot- and Endnotes}
8860 \change_deleted -712698321 1554395911
8868 \begin_layout Standard
8869 The mandatory argument
8870 \change_inserted -712698321 1554395956
8879 , in curly brackets, is the name of the module, as it should appear in
8880 \begin_inset Flex Noun
8883 \begin_layout Plain Layout
8884 Document\SpecialChar menuseparator
8885 Settings\SpecialChar menuseparator
8892 The argument in square brackets is optional: It declares any \SpecialChar LaTeX
8894 on which the module depends.
8895 It is also possible to use the form
8896 \begin_inset Flex Noun
8899 \begin_layout Plain Layout
8905 as an optional argument, which declares that the module can only be used
8906 when there exists a conversion chain between the formats `
8907 \begin_inset Flex Code
8910 \begin_layout Plain Layout
8917 \begin_inset Flex Code
8920 \begin_layout Plain Layout
8928 \change_inserted -712698321 1554396133
8935 declaration is not strictly mandatory, but you should add it, since it
8936 is helpful to find the module.
8937 Please have a look at the existing module categories and if appropriate,
8943 \begin_layout Standard
8945 \change_inserted -712698321 1554395988
8948 declaration should then be followed by lines like the following:
8952 \begin_layout Plain Layout
8953 Preferably in English if the module should be published with \SpecialChar LyX
8955 This description will appear in the list of messages to be translated and
8956 will be thus translated with the next interface update.
8964 \begin_layout LyX-Code
8968 \begin_layout LyX-Code
8969 #Adds an endnote command, in addition to footnotes.
8973 \begin_layout LyX-Code
8974 #You will need to add
8976 theendnotes in TeX code where you
8979 \begin_layout LyX-Code
8980 #want the endnotes to appear.
8984 \begin_layout LyX-Code
8988 \begin_layout LyX-Code
8989 #Requires: somemodule | othermodule
8992 \begin_layout LyX-Code
8993 #Excludes: badmodule
8996 \begin_layout Standard
8997 The description is used in
8998 \begin_inset Flex Noun
9001 \begin_layout Plain Layout
9002 Document\SpecialChar menuseparator
9003 Settings\SpecialChar menuseparator
9009 to provide the user with information about what the module does.
9011 \begin_inset Flex Code
9014 \begin_layout Plain Layout
9020 line is used to identify other modules with which this one must be used;
9022 \begin_inset Flex Code
9025 \begin_layout Plain Layout
9031 line is used to identify modules with which this one may not be used.
9032 Both are optional, and, as shown, multiple modules should be separated
9033 with the pipe symbol: |.
9034 Note that the required modules are treated disjunctively:
9038 of the required modules must be used.
9043 excluded module may be used.
9044 Note that modules are identified here by their filenames without the
9045 \begin_inset Flex Code
9048 \begin_layout Plain Layout
9056 \begin_inset Flex Code
9059 \begin_layout Plain Layout
9066 \begin_inset Flex Code
9069 \begin_layout Plain Layout
9078 \begin_layout Subsection
9079 The CiteEngine file declaration
9082 \begin_layout Standard
9083 A cite engine file must begin with a line like the following:
9086 \begin_layout LyX-Code
9089 DeclareLyXCiteEngineModule[biblatex.sty]{Biblatex}
9092 \begin_layout Standard
9093 The mandatory argument, in curly brackets, is the name of the cite style,
9094 as it should appear in
9095 \begin_inset Flex Noun
9098 \begin_layout Plain Layout
9099 Document\SpecialChar menuseparator
9100 Settings\SpecialChar menuseparator
9107 The argument in square brackets is optional: It declares any \SpecialChar LaTeX
9109 on which the cite engine depends.
9112 \begin_layout Standard
9113 The cite engine declaration should then be followed by lines like the following:
9117 \begin_layout Plain Layout
9118 Preferably in English if the module should be published with \SpecialChar LyX
9120 This description will appear in the list of messages to be translated and
9121 will be thus translated with the next interface update.
9129 \begin_layout LyX-Code
9133 \begin_layout LyX-Code
9134 # Biblatex supports many author-year and numerical styles.
9137 \begin_layout LyX-Code
9138 # It is mainly aimed at the Humanities.
9142 \begin_layout LyX-Code
9143 # customizable, fully localized and provides many features
9146 \begin_layout LyX-Code
9147 # that are not possible with BibTeX.
9148 The use of 'biber' as
9151 \begin_layout LyX-Code
9152 # bibliography processor is advised.
9155 \begin_layout LyX-Code
9159 \begin_layout Standard
9160 The description is used in
9161 \begin_inset Flex Noun
9164 \begin_layout Plain Layout
9165 Document\SpecialChar menuseparator
9166 Settings\SpecialChar menuseparator
9172 to provide the user with information about the cite engine.
9175 \begin_layout Subsection
9179 \begin_layout Standard
9180 The first non-comment line of any layout file, included file, or module
9185 contain the file format number:
9188 \begin_layout Description
9189 \begin_inset Flex Code
9192 \begin_layout Plain Layout
9199 \begin_inset Flex Code
9202 \begin_layout Plain Layout
9208 ] The format number of the layout file.
9211 \begin_layout Standard
9212 This tag was introduced with \SpecialChar LyX
9214 \begin_inset space ~
9218 Layout files from older \SpecialChar LyX
9219 versions do not have an explicit file format and
9220 are considered to have
9221 \begin_inset Flex Code
9224 \begin_layout Plain Layout
9226 \begin_inset space ~
9235 The format for the present version of \SpecialChar LyX
9237 But each version of \SpecialChar LyX
9238 is capable of reading earlier versions' layout files,
9239 just as they are capable of reading files produced by earlier versions
9242 There is, however, no provision for converting to earlier formats.
9245 \begin_layout Subsection
9246 \begin_inset CommandInset label
9248 name "subsec:General-text-class"
9252 General text class parameters
9255 \begin_layout Standard
9256 These are general parameters that govern the behavior of an entire document
9262 mean that they must appear in
9263 \begin_inset Flex Code
9266 \begin_layout Plain Layout
9272 files rather than in modules.
9273 A module can contain any layout tag.)
9276 \begin_layout Description
9278 \change_inserted -712698321 1526899478
9279 \begin_inset Flex Code
9282 \begin_layout Plain Layout
9284 \change_inserted -712698321 1526898610
9285 AddToCiteEngine <engine>
9292 Extends the possibilities for displaying citation references.
9294 \begin_inset CommandInset ref
9296 reference "subsec:Citation-engine-description"
9305 \begin_inset Flex Code
9308 \begin_layout Plain Layout
9310 \change_inserted -712698321 1526898823
9321 \begin_layout Description
9322 \begin_inset Flex Code
9325 \begin_layout Plain Layout
9331 Adds information that will be output in the
9332 \begin_inset Flex Code
9335 \begin_layout Plain Layout
9341 block when the document is output to XHTML.
9342 Typically, this would be used to output CSS style information, but it can
9343 be used for anything that can appear in
9344 \begin_inset Flex Code
9347 \begin_layout Plain Layout
9355 \begin_inset Quotes eld
9359 \begin_inset Flex Code
9362 \begin_layout Plain Layout
9369 \begin_inset Quotes erd
9375 \begin_layout Description
9376 \begin_inset Flex Code
9379 \begin_layout Plain Layout
9385 Adds information to the document preamble.
9387 \begin_inset Newline newline
9391 \begin_inset Quotes eld
9395 \begin_inset Flex Code
9398 \begin_layout Plain Layout
9405 \begin_inset Quotes erd
9409 \change_inserted -712698321 1562592950
9413 \begin_layout Description
9415 \change_inserted -712698321 1562593040
9416 \begin_inset Flex Code
9419 \begin_layout Plain Layout
9421 \change_inserted -712698321 1562592954
9430 \begin_inset Flex Code
9433 \begin_layout Plain Layout
9435 \change_inserted -712698321 1562592950
9446 \begin_inset space \thinspace{}
9450 \begin_inset Flex Code
9453 \begin_layout Plain Layout
9455 \change_inserted -712698321 1562592950
9463 ] If the document class adds the bibliography to the table of contents,
9464 add this option with value
9465 \begin_inset Flex Code
9468 \begin_layout Plain Layout
9470 \change_inserted -712698321 1562592996
9479 \begin_inset Flex Code
9482 \begin_layout Plain Layout
9484 \change_inserted -712698321 1562593006
9493 This prevents the bibliography from being added twice.
9498 \begin_layout Description
9499 \begin_inset Flex Code
9502 \begin_layout Plain Layout
9508 Defines the possibilities for displaying citation references.
9510 \begin_inset CommandInset ref
9512 reference "subsec:Citation-engine-description"
9521 \begin_inset Quotes eld
9525 \begin_inset Flex Code
9528 \begin_layout Plain Layout
9535 \begin_inset Quotes erd
9539 Primarily used in cite engine files (see
9540 \begin_inset CommandInset ref
9542 reference "subsec:Cite-Engine-Files"
9551 \change_inserted -712698321 1526898530
9552 Note that if you specify this in a layout file or module, any cite engine
9553 definition will be overridden.
9555 \begin_inset Flex Code
9558 \begin_layout Plain Layout
9560 \change_inserted -712698321 1526898530
9573 \begin_layout Description
9574 \begin_inset Flex Code
9577 \begin_layout Plain Layout
9583 Defines formats for use in the display of bibliographic information.
9585 \begin_inset CommandInset ref
9587 reference "subsec:Citation-format-description"
9593 \begin_inset Quotes eld
9597 \begin_inset Flex Code
9600 \begin_layout Plain Layout
9607 \begin_inset Quotes erd
9611 Primarily used in cite engine files (see
9612 \begin_inset CommandInset ref
9614 reference "subsec:Cite-Engine-Files"
9623 \change_inserted -712698321 1526898585
9624 A cite format defined in a layout or module will override the cite engine
9630 \begin_layout Description
9631 \begin_inset Flex Code
9634 \begin_layout Plain Layout
9641 \begin_inset Flex Code
9644 \begin_layout Plain Layout
9653 \begin_inset Flex Code
9656 \begin_layout Plain Layout
9662 ] Determines whether
9666 or Bib\SpecialChar TeX
9667 is used to generate a Bibliography.
9668 Primarily used in cite engine files (see
9669 \begin_inset CommandInset ref
9671 reference "subsec:Cite-Engine-Files"
9681 \begin_layout Description
9682 \begin_inset Flex Code
9685 \begin_layout Plain Layout
9691 Describes various global options supported by the document class.
9693 \begin_inset CommandInset ref
9695 reference "subsec:ClassOptions"
9701 \begin_inset Quotes eld
9705 \begin_inset Flex Code
9708 \begin_layout Plain Layout
9715 \begin_inset Quotes erd
9721 \begin_layout Description
9722 \begin_inset Flex Code
9725 \begin_layout Plain Layout
9732 \begin_inset Flex Code
9735 \begin_layout Plain Layout
9744 \begin_inset space \thinspace{}
9748 \begin_inset Flex Code
9751 \begin_layout Plain Layout
9757 ] Whether the class should
9761 to having one or two columns.
9762 Can be changed in the
9763 \begin_inset Flex Noun
9766 \begin_layout Plain Layout
9767 Document\SpecialChar menuseparator
9776 \begin_layout Description
9777 \begin_inset Flex Code
9780 \begin_layout Plain Layout
9787 \begin_inset Flex Code
9790 \begin_layout Plain Layout
9796 ] This sequence defines the properties for a counter.
9797 If the counter does not yet exist, it is created; if it does exist, it
9800 \begin_inset Quotes eld
9804 \begin_inset Flex Code
9807 \begin_layout Plain Layout
9814 \begin_inset Quotes erd
9818 \begin_inset Newline newline
9822 \begin_inset CommandInset ref
9824 reference "subsec:Counters"
9828 for details on counters.
9831 \begin_layout Description
9832 \begin_inset Flex Code
9835 \begin_layout Plain Layout
9841 Sets the default font used to display the document.
9843 \begin_inset CommandInset ref
9845 reference "subsec:Font-description"
9849 for how to declare fonts.
9851 \begin_inset Quotes eld
9855 \begin_inset Flex Code
9858 \begin_layout Plain Layout
9865 \begin_inset Quotes erd
9871 \begin_layout Description
9872 \begin_inset Flex Code
9875 \begin_layout Plain Layout
9882 \begin_inset Flex Code
9885 \begin_layout Plain Layout
9891 ] Specifies a module to be included by default with this document class.
9892 The module is specified as filename without the
9893 \begin_inset Flex Code
9896 \begin_layout Plain Layout
9903 The user can still remove the module, but it will be active at the outset.
9904 (This applies only when new files are created, or when this class is chosen
9905 for an existing document.)
9908 \begin_layout Description
9909 \begin_inset Flex Code
9912 \begin_layout Plain Layout
9919 \begin_inset Flex Code
9922 \begin_layout Plain Layout
9928 ] This is the style that will be assigned to new paragraphs, usually
9929 \begin_inset Flex Noun
9932 \begin_layout Plain Layout
9939 This will default to the first defined style if not given, but you are
9940 encouraged to use this directive.
9943 \begin_layout Description
9945 \change_inserted -970929547 1515112870
9946 \begin_inset Flex Code
9949 \begin_layout Plain Layout
9951 \change_inserted -970929547 1515112782
9960 \begin_inset Flex Code
9963 \begin_layout Plain Layout
9965 \change_inserted -970929547 1515112766
9973 ] The root element (at the top of the document) to use when outputting documents
9974 with this class in DocBook.
9975 The default value is
9976 \begin_inset Quotes eld
9980 \begin_inset Flex Code
9983 \begin_layout Plain Layout
9985 \change_inserted -970929547 1515112845
9994 \begin_inset Quotes erd
9999 \change_deleted 1075283030 1594226862
10001 \change_inserted 1075283030 1594226777
10005 \begin_layout Description
10007 \change_inserted 1075283030 1594226859
10008 \begin_inset Flex Code
10011 \begin_layout Plain Layout
10013 \change_inserted 1075283030 1594226785
10014 DocBookForceAbstract
10022 \begin_inset Flex Code
10025 \begin_layout Plain Layout
10027 \change_inserted 1075283030 1594226804
10036 \begin_inset Quotes eld
10044 \begin_inset Quotes erd
10047 , the root element will always have an
10052 The default value is
10053 \begin_inset Quotes eld
10061 \begin_inset Quotes erd
10069 \begin_layout Description
10070 \begin_inset Flex Code
10073 \begin_layout Plain Layout
10080 \begin_inset Flex Code
10083 \begin_layout Plain Layout
10089 ] This tag indicates that the module (which is specified by filename without
10091 \begin_inset Flex Code
10094 \begin_layout Plain Layout
10100 extension) cannot be used with this document class.
10101 This might be used in a journal-specific layout file to prevent, say, the
10103 \begin_inset Flex Code
10106 \begin_layout Plain Layout
10112 module that numbers theorems by section.
10117 be used in a module.
10118 Modules have their own way of excluding other modules (see
10119 \begin_inset CommandInset ref
10121 reference "subsec:Layout-modules"
10128 \begin_layout Description
10129 \begin_inset Flex Code
10132 \begin_layout Plain Layout
10138 Defines a new float.
10140 \begin_inset CommandInset ref
10142 reference "subsec:Floats"
10148 \begin_inset Quotes eld
10152 \begin_inset Flex Code
10155 \begin_layout Plain Layout
10162 \begin_inset Quotes erd
10168 \begin_layout Description
10169 \begin_inset Flex Code
10172 \begin_layout Plain Layout
10178 Sets the information that will be output in the
10179 \begin_inset Flex Code
10182 \begin_layout Plain Layout
10188 block when this document class is output to XHTML.
10189 Note that this will completely override any prior
10190 \begin_inset Flex Code
10193 \begin_layout Plain Layout
10200 \begin_inset Flex Code
10203 \begin_layout Plain Layout
10211 \begin_inset Newline newline
10215 \begin_inset Flex Code
10218 \begin_layout Plain Layout
10224 if you just want to add material to the preamble.) Must end with
10225 \begin_inset Quotes eld
10229 \begin_inset Flex Code
10232 \begin_layout Plain Layout
10239 \begin_inset Quotes erd
10245 \begin_layout Description
10246 \begin_inset Flex Code
10249 \begin_layout Plain Layout
10256 \begin_inset Flex Code
10259 \begin_layout Plain Layout
10265 ] The style to use for the table of contents, bibliography, and so forth,
10266 when the document is output to HTML.
10267 For articles, this should normally be
10268 \begin_inset Flex Code
10271 \begin_layout Plain Layout
10278 \begin_inset Flex Code
10281 \begin_layout Plain Layout
10288 If it is not given, then \SpecialChar LyX
10289 will attempt to figure out which layout to use.
10292 \begin_layout Description
10293 \begin_inset Flex Code
10296 \begin_layout Plain Layout
10303 \begin_inset Flex Code
10306 \begin_layout Plain Layout
10312 ] Modifies the properties of the given counter.
10313 If the counter does not exist, the statement is ignored.
10315 \begin_inset Quotes eld
10319 \begin_inset Flex Code
10322 \begin_layout Plain Layout
10329 \begin_inset Quotes erd
10333 \begin_inset Newline newline
10337 \begin_inset CommandInset ref
10339 reference "subsec:Counters"
10343 for details on counters.
10346 \begin_layout Description
10347 \begin_inset Flex Code
10350 \begin_layout Plain Layout
10357 \begin_inset Flex Code
10360 \begin_layout Plain Layout
10366 ] This allows you to include another layout definition file within yours
10367 to avoid duplicating commands.
10368 Common examples are the standard layout files, for example,
10369 \begin_inset Flex Code
10372 \begin_layout Plain Layout
10378 , which contains most of the basic layouts.
10379 \change_inserted -712698321 1611646803
10383 \begin_layout Description
10385 \change_inserted -712698321 1611646804
10386 \begin_inset Flex Code
10389 \begin_layout Plain Layout
10391 \change_inserted -712698321 1611646837
10400 \begin_inset Flex Code
10403 \begin_layout Plain Layout
10405 \change_inserted -712698321 1611646804
10413 ] is a variant of the
10414 \begin_inset Flex Code
10417 \begin_layout Plain Layout
10419 \change_inserted -712698321 1611646804
10427 command which does not look for files in the user directory.
10428 This allows to create a file
10429 \begin_inset Flex Code
10432 \begin_layout Plain Layout
10434 \change_inserted -712698321 1611646804
10443 \begin_inset Flex Code
10446 \begin_layout Plain Layout
10448 \change_inserted -712698321 1611646804
10456 in the user directory which includes a global file with the same name via
10458 \begin_inset Flex Code
10461 \begin_layout Plain Layout
10463 \change_inserted -712698321 1611646853
10472 \begin_inset Flex Code
10475 \begin_layout Plain Layout
10477 \change_inserted -712698321 1611646855
10478 InputGlobal name.inc
10485 , respectively (with
10486 \begin_inset Flex Code
10489 \begin_layout Plain Layout
10491 \change_inserted -712698321 1611646804
10499 , the file would recursively include itself).
10500 This way, you can modify global files without having to completely copy
10506 \begin_layout Description
10507 \begin_inset Flex Code
10510 \begin_layout Plain Layout
10517 \begin_inset Flex Code
10520 \begin_layout Plain Layout
10526 ] This section (re-)defines the layout of an inset.
10527 It can be applied to an existing inset or to a new, user-defined inset,
10528 e.g., a new character style.
10530 \begin_inset Quotes eld
10534 \begin_inset Flex Code
10537 \begin_layout Plain Layout
10544 \begin_inset Quotes erd
10548 \begin_inset Newline newline
10552 \begin_inset CommandInset ref
10554 reference "subsec:Flex-insets-and"
10558 for more information.
10562 \begin_layout Description
10563 \begin_inset Flex Code
10566 \begin_layout Plain Layout
10573 \begin_inset Flex Code
10576 \begin_layout Plain Layout
10582 ] A string that indicates the width of the left margin on the screen, for
10584 \begin_inset Quotes eld
10588 \begin_inset Flex Code
10591 \begin_layout Plain Layout
10598 \begin_inset Quotes erd
10602 (Note that this is not a `length', like
10603 \begin_inset Quotes eld
10607 \begin_inset Quotes erd
10613 \begin_layout Description
10614 \begin_inset Flex Code
10617 \begin_layout Plain Layout
10624 \begin_inset Flex Code
10627 \begin_layout Plain Layout
10633 ] An integer that determines the maximal number of names displayed in an
10634 author-year citation before the citation switches to
10635 \begin_inset Quotes eld
10639 \begin_inset Quotes erd
10643 Primarily used in cite engine files (see
10644 \begin_inset CommandInset ref
10646 reference "subsec:Cite-Engine-Files"
10656 \begin_layout Description
10658 \change_inserted -712698321 1612018485
10659 \begin_inset Flex Code
10662 \begin_layout Plain Layout
10664 \change_inserted -712698321 1612018457
10673 \begin_inset Flex Code
10676 \begin_layout Plain Layout
10678 \change_inserted -712698321 1612018466
10686 ] Modifies the layout of an inset.
10687 If the layout does not exist, this section is ignored.
10689 \begin_inset Quotes eld
10693 \begin_inset Flex Code
10696 \begin_layout Plain Layout
10698 \change_inserted -712698321 1612018452
10707 \begin_inset Quotes erd
10713 \begin_layout Description
10714 \begin_inset Flex Code
10717 \begin_layout Plain Layout
10724 \begin_inset Flex Code
10727 \begin_layout Plain Layout
10733 ] Modifies the properties of the given paragraph style.
10734 If the style does not exist, this section is ignored.
10736 \begin_inset Quotes eld
10740 \begin_inset Flex Code
10743 \begin_layout Plain Layout
10750 \begin_inset Quotes erd
10756 \begin_layout Description
10757 \begin_inset Flex Code
10760 \begin_layout Plain Layout
10767 \begin_inset Flex Code
10770 \begin_layout Plain Layout
10776 ] Deletes an existing counter, usually one defined in an included file.
10779 \begin_layout Description
10780 \begin_inset Flex Code
10783 \begin_layout Plain Layout
10790 \begin_inset Flex Code
10793 \begin_layout Plain Layout
10799 ] Deletes an existing float.
10800 This is particularly useful when you want to suppress a float that has
10801 been defined in an input file.
10804 \begin_layout Description
10805 \begin_inset Flex Code
10808 \begin_layout Plain Layout
10815 \begin_inset Flex Code
10818 \begin_layout Plain Layout
10824 ] Deletes an existing style.
10827 \begin_layout Description
10828 \begin_inset Flex Code
10831 \begin_layout Plain Layout
10838 \begin_inset Flex Code
10841 \begin_layout Plain Layout
10848 \begin_inset Flex Code
10851 \begin_layout Plain Layout
10857 ] Define a new table of contents with type
10858 \begin_inset Flex Code
10861 \begin_layout Plain Layout
10868 \begin_inset Flex Code
10871 \begin_layout Plain Layout
10878 See also the AddToToc commands.
10881 \begin_layout Description
10882 \begin_inset Flex Code
10885 \begin_layout Plain Layout
10892 \begin_inset Flex Code
10895 \begin_layout Plain Layout
10901 ] The file format (as defined in the \SpecialChar LyX
10902 preferences) produced by this document
10904 It is mainly useful when
10905 \begin_inset Flex Code
10908 \begin_layout Plain Layout
10915 \begin_inset Flex Code
10918 \begin_layout Plain Layout
10924 and one wants to define a new type of literate document.
10925 The format is reset to
10926 \change_deleted 5863208 1594239413
10928 \begin_inset Quotes eld
10932 \begin_inset Flex Code
10935 \begin_layout Plain Layout
10942 \begin_inset Quotes erd
10948 \begin_inset Quotes eld
10952 \begin_inset Flex Code
10955 \begin_layout Plain Layout
10962 \begin_inset Quotes erd
10965 when the corresponding
10966 \begin_inset Flex Code
10969 \begin_layout Plain Layout
10975 parameter is encountered.
10978 \begin_layout Description
10979 \begin_inset Flex Code
10982 \begin_layout Plain Layout
10989 \begin_inset Flex Code
10992 \begin_layout Plain Layout
11003 \change_deleted 5863208 1594239430
11005 \begin_inset Flex Code
11008 \begin_layout Plain Layout
11017 \begin_inset Flex Code
11020 \begin_layout Plain Layout
11026 ] Specifies what sort of output documents using this class will produce.
11029 \begin_layout Description
11030 \begin_inset Flex Code
11033 \begin_layout Plain Layout
11040 \begin_inset Flex Code
11043 \begin_layout Plain Layout
11050 \begin_inset Flex Code
11053 \begin_layout Plain Layout
11059 ] Specifies options, given in the second string, for the package named by
11062 \begin_inset Quotes eld
11066 \begin_inset Flex Code
11069 \begin_layout Plain Layout
11070 PackageOptions natbib square
11076 \begin_inset Quotes erd
11080 \begin_inset Flex Code
11083 \begin_layout Plain Layout
11089 to be loaded with the
11090 \begin_inset Flex Code
11093 \begin_layout Plain Layout
11100 (For \SpecialChar TeX
11101 perts, this causes \SpecialChar LyX
11103 \begin_inset Flex Code
11106 \begin_layout Plain Layout
11109 PassOptionsToPackage{natbib}{square}
11115 \begin_inset Flex Code
11118 \begin_layout Plain Layout
11125 \change_inserted -712698321 1565102364
11129 \begin_layout Description
11131 \change_inserted -712698321 1565102470
11132 \begin_inset Flex Code
11135 \begin_layout Plain Layout
11137 \change_inserted -712698321 1565102365
11146 \begin_inset Flex Code
11149 \begin_layout Plain Layout
11151 \change_inserted -712698321 1565105222
11156 , letter, legal, executive, a0, a1, a2, a3, a4, a5, a6, b0, b1, b2, b3,
11157 b4, b5, b6, c0, c1, c2, c3, c4, c5, c6, b0j, b1j, b2j, b3j, b4j, b5j, b6j
11164 ] The default page size.
11165 This is used by some converters.
11170 \begin_layout Description
11171 \begin_inset Flex Code
11174 \begin_layout Plain Layout
11181 \begin_inset Flex Code
11184 \begin_layout Plain Layout
11193 \begin_inset Flex Code
11196 \begin_layout Plain Layout
11203 \begin_inset Flex Code
11206 \begin_layout Plain Layout
11212 ] The default pagestyle.
11213 Can be changed in the
11214 \begin_inset Flex Noun
11217 \begin_layout Plain Layout
11218 Document\SpecialChar menuseparator
11227 \begin_layout Description
11228 \begin_inset Flex Code
11231 \begin_layout Plain Layout
11237 Sets the preamble for the \SpecialChar LaTeX
11239 Note that this will completely override any prior
11240 \begin_inset Flex Code
11243 \begin_layout Plain Layout
11250 \begin_inset Flex Code
11253 \begin_layout Plain Layout
11261 \begin_inset Flex Code
11264 \begin_layout Plain Layout
11270 if you just want to add material to the preamble.) Must end with
11271 \begin_inset Quotes eld
11275 \begin_inset Flex Code
11278 \begin_layout Plain Layout
11285 \begin_inset Quotes erd
11289 \change_inserted -712698321 1612018500
11293 \begin_layout Description
11295 \change_inserted -712698321 1612018547
11296 \begin_inset Flex Code
11299 \begin_layout Plain Layout
11301 \change_inserted -712698321 1612018506
11310 \begin_inset Flex Code
11313 \begin_layout Plain Layout
11315 \change_inserted -712698321 1612018509
11323 ] Defines the layout of an inset if it does not already exist.
11324 If the layout does exist, this section is ignored.
11326 \begin_inset Quotes eld
11330 \begin_inset Flex Code
11333 \begin_layout Plain Layout
11335 \change_inserted -712698321 1612018500
11344 \begin_inset Quotes erd
11352 \begin_layout Description
11353 \begin_inset Flex Code
11356 \begin_layout Plain Layout
11363 \begin_inset Flex Code
11366 \begin_layout Plain Layout
11373 \begin_inset Flex Code
11376 \begin_layout Plain Layout
11385 \begin_inset space \thinspace{}
11389 \begin_inset Flex Code
11392 \begin_layout Plain Layout
11398 ] Whether the class already provides the feature
11399 \begin_inset Flex Code
11402 \begin_layout Plain Layout
11409 A feature is in general the name of a package (e.
11410 \begin_inset space \thinspace{}
11414 \begin_inset space \space{}
11418 \begin_inset Flex Code
11421 \begin_layout Plain Layout
11428 \begin_inset Flex Code
11431 \begin_layout Plain Layout
11438 \begin_inset space \thinspace{}
11442 \begin_inset space \space{}
11446 \begin_inset Flex Code
11449 \begin_layout Plain Layout
11456 \begin_inset Flex Code
11459 \begin_layout Plain Layout
11467 \begin_inset CommandInset ref
11469 reference "chap:List-of-functions"
11473 for the list of features.
11476 \begin_layout Description
11477 \begin_inset Flex Code
11480 \begin_layout Plain Layout
11487 \begin_inset Flex Code
11490 \begin_layout Plain Layout
11496 ] Indicates that this layout provides the functionality of the module mentioned,
11497 which should be specified by the filename without the
11498 \begin_inset Flex Code
11501 \begin_layout Plain Layout
11508 This will typically be used if the layout includes the module directly,
11509 rather than using the
11510 \begin_inset Flex Code
11513 \begin_layout Plain Layout
11519 tag to indicate that it ought to be used.
11520 It could also be used in a module that provided an alternate implementation
11521 of the same functionality.
11524 \begin_layout Description
11525 \begin_inset Flex Code
11528 \begin_layout Plain Layout
11535 \begin_inset Flex Code
11538 \begin_layout Plain Layout
11544 ] Creates a new paragraph style if it does not already exist.
11545 If the style does exist, this section is ignored.
11547 \begin_inset Quotes eld
11551 \begin_inset Flex Code
11554 \begin_layout Plain Layout
11561 \begin_inset Quotes erd
11567 \begin_layout Description
11568 \begin_inset Flex Code
11571 \begin_layout Plain Layout
11578 \begin_inset Flex Code
11581 \begin_layout Plain Layout
11587 ] Whether the class requires the feature
11588 \begin_inset Flex Code
11591 \begin_layout Plain Layout
11598 Multiple features must be separated by commas.
11599 Note that you can only request supported features.
11601 \begin_inset CommandInset ref
11603 reference "chap:List-of-functions"
11607 for the list of features.).
11608 If you require a package with specific options, you can additionally use
11610 \begin_inset Flex Code
11613 \begin_layout Plain Layout
11622 \begin_layout Description
11623 \begin_inset Flex Code
11626 \begin_layout Plain Layout
11633 \begin_inset Flex Code
11636 \begin_layout Plain Layout
11642 ] A string that indicates the width of the right margin on the screen, for
11644 \begin_inset Quotes eld
11648 \begin_inset Flex Code
11651 \begin_layout Plain Layout
11658 \begin_inset Quotes erd
11664 \begin_layout Description
11665 \begin_inset Flex Code
11668 \begin_layout Plain Layout
11675 \begin_inset Flex Code
11678 \begin_layout Plain Layout
11684 ] Sets which divisions get numbered.
11686 \begin_inset Newline newline
11690 \begin_inset Flex Code
11693 \begin_layout Plain Layout
11699 counter in \SpecialChar LaTeX
11703 \begin_layout Description
11704 \begin_inset Flex Code
11707 \begin_layout Plain Layout
11714 \begin_inset Flex Code
11717 \begin_layout Plain Layout
11726 \begin_inset space \thinspace{}
11730 \begin_inset Flex Code
11733 \begin_layout Plain Layout
11739 ] Whether the class-default should be printing on one or both sides of the
11741 Can be changed in the
11742 \begin_inset Flex Noun
11745 \begin_layout Plain Layout
11746 Document\SpecialChar menuseparator
11755 \begin_layout Description
11756 \begin_inset Flex Code
11759 \begin_layout Plain Layout
11766 \begin_inset Flex Code
11769 \begin_layout Plain Layout
11775 ] This sequence defines a paragraph style.
11776 If the style does not yet exist, it is created; if it does exist, its parameter
11779 \begin_inset Quotes eld
11783 \begin_inset Flex Code
11786 \begin_layout Plain Layout
11793 \begin_inset Quotes erd
11797 \begin_inset Newline newline
11801 \begin_inset CommandInset ref
11803 reference "subsec:Paragraph-Styles"
11807 for details on paragraph styles.
11808 \change_inserted -712698321 1553617804
11812 \begin_layout Description
11814 \change_inserted -712698321 1553617862
11815 \begin_inset Flex Code
11818 \begin_layout Plain Layout
11820 \change_inserted -712698321 1553617809
11829 \begin_inset Flex Code
11832 \begin_layout Plain Layout
11834 \change_inserted -712698321 1553617805
11842 ] defines the default table style that is used when inserting a table.
11843 The following styles are available:
11847 \begin_layout Itemize
11849 \change_inserted -712698321 1554308039
11850 \begin_inset Flex Code
11853 \begin_layout Plain Layout
11855 \change_inserted -712698321 1554307928
11856 Formal_with_Footline
11864 \begin_inset Quotes eld
11868 \begin_inset Quotes erd
11871 ) style with horizontal lines only, using a bold top and bottom line, the
11872 first and last row are additionally separated from the table body with
11873 a thin middle line.
11876 \begin_layout Itemize
11878 \change_inserted -712698321 1554308087
11879 \begin_inset Flex Code
11882 \begin_layout Plain Layout
11884 \change_inserted -712698321 1554308042
11885 Formal_without_Footline
11892 : same as the above, but the last row is not separated with a middle line
11896 \begin_layout Itemize
11898 \change_inserted -712698321 1553618031
11899 \begin_inset Flex Code
11902 \begin_layout Plain Layout
11904 \change_inserted -712698321 1553618006
11912 : Simple table lines.
11915 \begin_layout Itemize
11917 \change_inserted -712698321 1553618309
11918 \begin_inset Flex Code
11921 \begin_layout Plain Layout
11923 \change_inserted -712698321 1553618031
11932 \begin_inset Flex Code
11935 \begin_layout Plain Layout
11937 \change_inserted -712698321 1553618043
11945 , but with the header column offset with a second horizontal line.
11946 This is also the default style of \SpecialChar LyX
11950 \begin_layout Itemize
11952 \change_inserted -712698321 1553618280
11953 \begin_inset Flex Code
11956 \begin_layout Plain Layout
11958 \change_inserted -712698321 1553618261
11966 : Table without lines.
11972 \begin_layout Description
11973 \begin_inset Flex Code
11976 \begin_layout Plain Layout
11983 \begin_inset Flex Code
11986 \begin_layout Plain Layout
11992 ] The name of the command or environment to be used with
11993 \begin_inset Flex Code
11996 \begin_layout Plain Layout
12005 \begin_layout Description
12006 \begin_inset Flex Code
12009 \begin_layout Plain Layout
12016 \begin_inset Flex Code
12019 \begin_layout Plain Layout
12028 \begin_inset Flex Code
12031 \begin_layout Plain Layout
12037 ] Indicates what kind of markup is used to define the title of a document.
12039 \begin_inset Flex Code
12042 \begin_layout Plain Layout
12048 means that the macro with name
12049 \begin_inset Flex Code
12052 \begin_layout Plain Layout
12058 will be inserted after the last layout which has
12059 \begin_inset Quotes eld
12063 \begin_inset Flex Code
12066 \begin_layout Plain Layout
12068 \begin_inset space ~
12077 \begin_inset Quotes erd
12082 \begin_inset Flex Code
12085 \begin_layout Plain Layout
12091 corresponds to the case where all layouts which have
12092 \begin_inset Quotes eld
12096 \begin_inset Flex Code
12099 \begin_layout Plain Layout
12101 \begin_inset space ~
12110 \begin_inset Quotes erd
12113 should be enclosed into the
12114 \begin_inset Flex Code
12117 \begin_layout Plain Layout
12126 \begin_layout Description
12127 \begin_inset Flex Code
12130 \begin_layout Plain Layout
12137 \begin_inset Flex Code
12140 \begin_layout Plain Layout
12146 ] Sets which divisions are included in the table of contents.
12148 \begin_inset Flex Code
12151 \begin_layout Plain Layout
12157 counter in \SpecialChar LaTeX
12161 \begin_layout Subsection
12162 \begin_inset Flex Code
12165 \begin_layout Plain Layout
12172 \begin_inset CommandInset label
12174 name "subsec:ClassOptions"
12181 \begin_layout Standard
12183 \begin_inset Flex Code
12186 \begin_layout Plain Layout
12192 section can contain the following entries:
12195 \begin_layout Description
12196 \begin_inset Flex Code
12199 \begin_layout Plain Layout
12206 \begin_inset Flex Code
12209 \begin_layout Plain Layout
12215 ] The list of available font sizes for the document's main font, separated
12217 \begin_inset Quotes eld
12221 \begin_inset Flex Code
12224 \begin_layout Plain Layout
12231 \begin_inset Quotes erd
12236 \change_inserted -712698321 1565110196
12237 Any number is possible.
12240 \begin_layout Description
12242 \change_inserted -712698321 1565110259
12243 \begin_inset Flex Code
12246 \begin_layout Plain Layout
12248 \change_inserted -712698321 1565110199
12257 \begin_inset Flex Code
12260 \begin_layout Plain Layout
12262 \change_inserted -712698321 1565110196
12270 ] The format for the font size option.
12272 \begin_inset Flex Code
12275 \begin_layout Plain Layout
12277 \change_inserted -712698321 1565110238
12287 \begin_inset Flex Code
12290 \begin_layout Plain Layout
12292 \change_inserted -712698321 1565110248
12300 is a placeholder for the font size.
12305 \begin_layout Description
12307 \change_deleted 5863208 1594239483
12308 \begin_inset Flex Code
12311 \begin_layout Plain Layout
12317 Used to set the DTD line with XML-based output classes.
12319 \begin_inset space \thinspace{}
12323 \begin_inset Quotes eld
12326 -//OASIS//DTD DocBook V4.2//EN
12327 \begin_inset Quotes erd
12331 \change_inserted -712698321 1565101761
12335 \begin_layout Description
12337 \change_inserted -712698321 1565180598
12338 \begin_inset Flex Code
12341 \begin_layout Plain Layout
12343 \change_inserted -712698321 1565101918
12352 \begin_inset Flex Code
12355 \begin_layout Plain Layout
12357 \change_inserted -712698321 1565105399
12358 string="letter|\SpecialChar allowbreak
12359 legal|\SpecialChar allowbreak
12360 executive|\SpecialChar allowbreak
12361 a0|\SpecialChar allowbreak
12362 a1|\SpecialChar allowbreak
12363 a2|\SpecialChar allowbreak
12364 a3|\SpecialChar allowbreak
12365 a4|\SpecialChar allowbreak
12366 a5|\SpecialChar allowbreak
12367 a6|\SpecialChar allowbreak
12368 b0|\SpecialChar allowbreak
12369 b1|\SpecialChar allowbreak
12370 b2|\SpecialChar allowbreak
12371 b3|\SpecialChar allowbreak
12372 b4|\SpecialChar allowbreak
12373 b5|\SpecialChar allowbreak
12374 b6|\SpecialChar allowbreak
12375 c0|\SpecialChar allowbreak
12376 c1|\SpecialChar allowbreak
12378 2|\SpecialChar allowbreak
12379 c3|\SpecialChar allowbreak
12380 c4|\SpecialChar allowbreak
12381 c5|\SpecialChar allowbreak
12382 c6|\SpecialChar allowbreak
12383 b0j|\SpecialChar allowbreak
12384 b1j|\SpecialChar allowbreak
12385 b2j|\SpecialChar allowbreak
12386 b3j|\SpecialChar allowbreak
12387 b4j|\SpecialChar allowbreak
12388 b5j|\SpecialChar allowbreak
12396 ] The list of available page sizes, separated by
12397 \begin_inset Quotes eld
12401 \begin_inset Flex Code
12404 \begin_layout Plain Layout
12406 \change_inserted -712698321 1565101779
12415 \begin_inset Quotes erd
12419 Currently, only the listed sizes are supported.
12420 Other sizes might be entered as custom class option.
12423 \begin_layout Description
12425 \change_inserted -712698321 1565180623
12426 \begin_inset Flex Code
12429 \begin_layout Plain Layout
12431 \change_inserted -712698321 1565180605
12440 \begin_inset Flex Code
12443 \begin_layout Plain Layout
12445 \change_inserted -712698321 1565180601
12453 ] The format for the page size option.
12455 \begin_inset Flex Code
12458 \begin_layout Plain Layout
12460 \change_inserted -712698321 1565180618
12470 \begin_inset Flex Code
12473 \begin_layout Plain Layout
12475 \change_inserted -712698321 1565180601
12483 is a placeholder for the paper size.
12488 \begin_layout Description
12489 \begin_inset Flex Code
12492 \begin_layout Plain Layout
12499 \begin_inset Flex Code
12502 \begin_layout Plain Layout
12503 string="empty|plain|headings|fancy"
12508 ] The list of available page sty\SpecialChar softhyphen
12510 \begin_inset Quotes eld
12514 \begin_inset Flex Code
12517 \begin_layout Plain Layout
12524 \begin_inset Quotes erd
12530 \begin_layout Description
12531 \begin_inset Flex Code
12534 \begin_layout Plain Layout
12541 \begin_inset Flex Code
12544 \begin_layout Plain Layout
12550 ] Some document class options, separated by a comma, that will be added
12551 to the optional part of the
12552 \begin_inset Flex Code
12555 \begin_layout Plain Layout
12566 \begin_layout Standard
12568 \begin_inset Flex Code
12571 \begin_layout Plain Layout
12577 section must end with
12578 \begin_inset Quotes eld
12582 \begin_inset Flex Code
12585 \begin_layout Plain Layout
12592 \begin_inset Quotes erd
12598 \begin_layout Subsection
12600 \begin_inset CommandInset label
12602 name "subsec:Paragraph-Styles"
12609 \begin_layout Standard
12610 A paragraph style description looks like this:
12614 \begin_layout Plain Layout
12615 Note that this will either define a new style or modify an existing one.
12623 \begin_layout LyX-Code
12630 \begin_layout LyX-Code
12634 \begin_layout LyX-Code
12638 \begin_layout Standard
12639 where the following commands are allowed:
12642 \begin_layout Description
12643 \begin_inset Flex Code
12646 \begin_layout Plain Layout
12653 \begin_inset Flex Code
12656 \begin_layout Plain Layout
12662 =""] This paragraph will appear in the table of contents of the given type.
12663 An empty string disables.
12664 See also the OutlinerName and the IsTocCaption commands.
12668 \begin_layout Description
12669 \begin_inset Flex Code
12672 \begin_layout Plain Layout
12679 \begin_inset Flex Code
12682 \begin_layout Plain Layout
12687 , left, right, center
12692 ] Paragraph alignment.
12695 \begin_layout Description
12696 \begin_inset Flex Code
12699 \begin_layout Plain Layout
12706 \begin_inset Flex Code
12709 \begin_layout Plain Layout
12714 , left, right, center
12719 ] A comma separated list of permitted alignments.
12720 (Some \SpecialChar LaTeX
12721 styles prohibit certain alignments, since those wouldn't make sense.
12722 For example a right-aligned or centered enumeration isn't possible.)
12725 \begin_layout Description
12726 \begin_inset Flex Code
12729 \begin_layout Plain Layout
12736 \begin_inset Flex Code
12739 \begin_layout Plain Layout
12745 ] Defines argument number <int> of a command\SpecialChar breakableslash
12746 environment associated with
12749 \change_inserted -584632292 1615846868
12750 The definition must end with
12751 \begin_inset Flex Code
12754 \begin_layout Plain Layout
12756 \change_inserted -584632292 1615846867
12768 \change_inserted -584632292 1615846880
12770 \begin_inset CommandInset ref
12772 reference "subsec:Arguments"
12779 for more information.
12781 \change_deleted -584632292 1615846694
12782 This is useful for things like section headings, and only makes sense with
12785 Every (optional or required) argument of a command or environment – except
12786 for the required argument that is associated with the content of the paragraph
12787 itself – has a separate definition, where the number specifies the order
12789 The definition must end with
12790 \begin_inset Flex Code
12793 \begin_layout Plain Layout
12800 So a command with two optional arguments has:
12804 \begin_layout Quote
12806 \change_deleted -584632292 1615846694
12812 \begin_layout Quote
12814 \change_deleted -584632292 1615846694
12820 \begin_layout Quote
12822 \change_deleted -584632292 1615846694
12828 \begin_layout Quote
12830 \change_deleted -584632292 1615846694
12836 \begin_layout Quote
12838 \change_deleted -584632292 1615846694
12844 \begin_layout Quote
12846 \change_deleted -584632292 1615846694
12852 \begin_layout Standard
12854 \change_deleted -584632292 1615846694
12856 \begin_inset Flex Code
12859 \begin_layout Plain Layout
12865 definition, the following specifications are possible:
12868 \begin_layout Itemize
12870 \change_deleted -584632292 1615846694
12871 \begin_inset Flex Code
12874 \begin_layout Plain Layout
12881 \begin_inset Flex Code
12884 \begin_layout Plain Layout
12890 The string that will appear both in the menu (to insert this argument)
12891 and on the argument inset button (unless you also specify a separate
12892 \begin_inset Flex Code
12895 \begin_layout Plain Layout
12902 For the menu, you can define an accelerator by appending the respective
12903 character to the string, divided by
12904 \begin_inset Quotes eld
12908 \begin_inset Quotes erd
12912 \begin_inset space \thinspace{}
12916 \begin_inset space \space{}
12920 \begin_inset Quotes eld
12924 \begin_inset Flex Code
12927 \begin_layout Plain Layout
12934 \begin_inset Quotes erd
12940 \begin_layout Itemize
12942 \change_deleted -584632292 1615846694
12943 \begin_inset Flex Code
12946 \begin_layout Plain Layout
12953 \begin_inset Flex Code
12956 \begin_layout Plain Layout
12962 A separate string for the menu.
12963 You can define an accelerator by appending the respective character to
12964 the string, divided by
12965 \begin_inset Quotes eld
12969 \begin_inset Quotes erd
12973 \begin_inset space \thinspace{}
12977 \begin_inset space \space{}
12981 \begin_inset Quotes eld
12985 \begin_inset Flex Code
12988 \begin_layout Plain Layout
12995 \begin_inset Quotes erd
12999 This specification is optional.
13000 If it is not given the
13001 \begin_inset Flex Code
13004 \begin_layout Plain Layout
13010 will be used instead for the menu.
13013 \begin_layout Itemize
13015 \change_deleted -584632292 1615846694
13016 \begin_inset Flex Code
13019 \begin_layout Plain Layout
13026 \begin_inset Flex Code
13029 \begin_layout Plain Layout
13035 A longer explanatory text that appears in the tooltip when hovering over
13036 the argument inset.
13039 \begin_layout Itemize
13041 \change_deleted -584632292 1615846694
13042 \begin_inset Flex Code
13045 \begin_layout Plain Layout
13052 \begin_inset Flex Code
13055 \begin_layout Plain Layout
13064 \begin_inset space \thinspace{}
13068 \begin_inset Flex Code
13071 \begin_layout Plain Layout
13077 ] Declare if this is a mandatory (1) or an optional (0) argument.
13078 Mandatory arguments will be output empty if not given, while optional arguments
13079 will not be output at all.
13080 By default, mandatory arguments are delimited by
13081 \begin_inset Flex Code
13084 \begin_layout Plain Layout
13090 , while optional arguments are delimited by
13091 \begin_inset Flex Code
13094 \begin_layout Plain Layout
13103 \begin_layout Itemize
13105 \change_deleted -584632292 1615846694
13106 \begin_inset Flex Code
13109 \begin_layout Plain Layout
13111 \change_inserted -712698321 1555579780
13120 \begin_inset Flex Code
13123 \begin_layout Plain Layout
13125 \change_inserted -712698321 1555579780
13133 Option to define a different command (from the default
13134 \begin_inset Flex Code
13137 \begin_layout Plain Layout
13139 \change_inserted -712698321 1555579780
13151 ) to be used for line breaks.
13152 The initial backslash must not be specified.
13155 \begin_layout Itemize
13157 \change_deleted -584632292 1615846694
13158 \begin_inset Flex Code
13161 \begin_layout Plain Layout
13168 \begin_inset Flex Code
13171 \begin_layout Plain Layout
13177 defines another argument (by its number) which this argument requires to
13178 be output if it is itself output.
13180 \begin_inset space \thinspace{}
13183 g., in \SpecialChar LaTeX
13184 commands, optional arguments often require previous optional arguments
13185 to be output (at least empty), as in
13186 \begin_inset Flex Code
13189 \begin_layout Plain Layout
13192 command[][argument]{text}
13198 This can be achieved by the statement
13199 \begin_inset Flex Code
13202 \begin_layout Plain Layout
13209 \begin_inset Flex Code
13212 \begin_layout Plain Layout
13221 \begin_layout Itemize
13223 \change_deleted -584632292 1615846694
13224 \begin_inset Flex Code
13227 \begin_layout Plain Layout
13234 \begin_inset Flex Code
13237 \begin_layout Plain Layout
13243 defines a custom left delimiter (instead of
13244 \begin_inset Flex Code
13247 \begin_layout Plain Layout
13254 \begin_inset Flex Code
13257 \begin_layout Plain Layout
13264 A line break in the output can be indicated by
13265 \begin_inset Flex Code
13268 \begin_layout Plain Layout
13277 \begin_layout Itemize
13279 \change_deleted -584632292 1615846694
13280 \begin_inset Flex Code
13283 \begin_layout Plain Layout
13290 \begin_inset Flex Code
13293 \begin_layout Plain Layout
13299 defines a custom right delimiter (instead of
13300 \begin_inset Flex Code
13303 \begin_layout Plain Layout
13310 \begin_inset Flex Code
13313 \begin_layout Plain Layout
13320 A line break in the output can be indicated by
13321 \begin_inset Flex Code
13324 \begin_layout Plain Layout
13333 \begin_layout Itemize
13335 \change_deleted -584632292 1615846694
13336 \begin_inset Flex Code
13339 \begin_layout Plain Layout
13346 \begin_inset Flex Code
13349 \begin_layout Plain Layout
13355 defines an argument that is inserted if and only if no user-specified arguments
13357 \begin_inset space \thinspace{}
13361 \begin_inset space \space{}
13364 if no argument inset has been inserted (note that also an empty argument
13365 inset omits the DefaultArg).
13366 Multiple arguments need to be separated by comma.
13369 \begin_layout Itemize
13371 \change_deleted -584632292 1615846694
13372 \begin_inset Flex Code
13375 \begin_layout Plain Layout
13382 \begin_inset Flex Code
13385 \begin_layout Plain Layout
13391 defines an argument that is inserted in any case (alone or in addition
13392 to user-specified arguments).
13393 Multiple arguments need to be separated by comma.
13396 \begin_layout Itemize
13398 \change_deleted -584632292 1615846694
13399 \begin_inset Flex Code
13402 \begin_layout Plain Layout
13408 The font used for the argument content, see
13409 \begin_inset CommandInset ref
13411 reference "subsec:Font-description"
13418 \begin_layout Itemize
13420 \change_deleted -584632292 1615846694
13421 \begin_inset Flex Code
13424 \begin_layout Plain Layout
13426 \change_inserted -712698321 1559484228
13435 \begin_inset Flex Code
13438 \begin_layout Plain Layout
13440 \change_inserted -712698321 1559484228
13451 \begin_inset space \thinspace{}
13455 \begin_inset Flex Code
13458 \begin_layout Plain Layout
13460 \change_inserted -712698321 1559484228
13468 ] As with paragraph styles, see
13469 \begin_inset CommandInset ref
13471 reference "subsec:Paragraph-Styles"
13478 \begin_layout Itemize
13480 \change_deleted -584632292 1615846694
13481 \begin_inset Flex Code
13484 \begin_layout Plain Layout
13490 The font used for the label; see
13491 \begin_inset CommandInset ref
13493 reference "subsec:Font-description"
13500 \begin_layout Itemize
13502 \change_deleted -584632292 1615846694
13503 \begin_inset Flex Code
13506 \begin_layout Plain Layout
13513 \begin_inset Flex Code
13516 \begin_layout Plain Layout
13521 , Minimalistic, Conglomerate
13526 ] describes the rendering style used for the inset's frame and buttons.
13529 \begin_layout Itemize
13531 \change_deleted -584632292 1615846694
13532 \begin_inset Flex Code
13535 \begin_layout Plain Layout
13542 \begin_inset Flex Code
13545 \begin_layout Plain Layout
13552 \begin_inset Flex Code
13555 \begin_layout Plain Layout
13561 , this argument is automatically inserted when the respective style is selected.
13563 \change_deleted -712698321 1559484200
13564 Currently, only one argument per style\SpecialChar breakableslash
13565 layout can be automatically inserted.
13566 \change_deleted -584632292 1615846694
13570 \begin_layout Itemize
13572 \change_deleted -584632292 1615846694
13573 \begin_inset Flex Code
13576 \begin_layout Plain Layout
13578 \change_inserted -712698321 1559490711
13587 \begin_inset Flex Code
13590 \begin_layout Plain Layout
13592 \change_inserted -712698321 1559490703
13601 \begin_inset Flex Code
13604 \begin_layout Plain Layout
13606 \change_inserted -712698321 1559490703
13614 , this argument will be inserted on a new line with
13615 \begin_inset Flex Code
13618 \begin_layout Plain Layout
13620 \change_inserted -712698321 1559491402
13628 (only available within Flex insets).
13631 \begin_layout Itemize
13633 \change_deleted -584632292 1615846694
13634 \begin_inset Flex Code
13637 \begin_layout Plain Layout
13644 \begin_inset Flex Code
13647 \begin_layout Plain Layout
13654 \begin_inset Flex Code
13657 \begin_layout Plain Layout
13663 , this argument will be inserted with a copy of the co-text (either selected
13664 text or the whole paragraph) as content.
13667 \begin_layout Itemize
13669 \change_deleted -584632292 1615846694
13670 \begin_inset Flex Code
13673 \begin_layout Plain Layout
13680 \begin_inset Flex Code
13683 \begin_layout Plain Layout
13693 ] Whether the contents of this argument should be output in raw form, meaning
13694 without special translations that \SpecialChar LaTeX
13697 \begin_inset Flex Code
13700 \begin_layout Plain Layout
13706 status is inherited by the inset or paragraph layout the argument belongs
13707 to, true and false change the status for the given argument only.
13710 \begin_layout Itemize
13712 \change_deleted -584632292 1615846694
13713 \begin_inset Flex Code
13716 \begin_layout Plain Layout
13723 \begin_inset Flex Code
13726 \begin_layout Plain Layout
13727 string of characters
13736 Defines individual characters
13737 \begin_inset Newline linebreak
13740 that should be output in raw form, meaning without special translations
13741 that \SpecialChar LaTeX
13743 Note that, contrary to PassThru, this needs to be explicitly defined for
13745 That is, arguments do not inherit PassThruChars from their parent inset
13749 \begin_layout Itemize
13751 \change_deleted -584632292 1615846694
13752 \begin_inset Flex Code
13755 \begin_layout Plain Layout
13762 \begin_inset Flex Code
13765 \begin_layout Plain Layout
13774 \begin_inset space \thinspace{}
13778 \begin_inset Flex Code
13781 \begin_layout Plain Layout
13787 ] If this is set to 1, the argument will output its content in the corresponding
13788 item in the table of contents.
13792 \begin_layout Standard
13794 \change_deleted -584632292 1615846694
13795 By default, the text entered in the \SpecialChar LyX
13796 workarea in the respective layout is
13797 the last (mandatory) argument of a command if the
13798 \begin_inset Flex Code
13801 \begin_layout Plain Layout
13808 \begin_inset Flex Code
13811 \begin_layout Plain Layout
13818 However, arguments with the prefix
13819 \begin_inset Flex Code
13822 \begin_layout Plain Layout
13828 are output after this workarea argument.
13829 Note that post-argument numbering restarts at 1, so the first argument
13830 following the workarea argument is
13831 \begin_inset Flex Code
13834 \begin_layout Plain Layout
13841 Post-arguments are ignored in any other
13842 \begin_inset Flex Code
13845 \begin_layout Plain Layout
13852 \begin_inset Flex Code
13855 \begin_layout Plain Layout
13864 \begin_layout Standard
13866 \change_deleted -584632292 1615846694
13868 \begin_inset Flex Code
13871 \begin_layout Plain Layout
13880 \begin_inset Flex Code
13883 \begin_layout Plain Layout
13892 \begin_inset Flex Code
13895 \begin_layout Plain Layout
13901 followed by the number (e.
13902 \begin_inset space \thinspace{}
13906 \begin_inset space \space{}
13910 \begin_inset Flex Code
13913 \begin_layout Plain Layout
13922 \begin_layout Standard
13924 \change_deleted -584632292 1615846694
13925 Finally, there is a special argument type with the prefix
13926 \begin_inset Flex Code
13929 \begin_layout Plain Layout
13931 \change_inserted -712698321 1534487844
13940 It is not really an argument, but uses the argument interface (thus, the
13941 prefix is also followed by a number, e.
13942 \begin_inset space \thinspace{}
13947 \begin_inset Flex Code
13950 \begin_layout Plain Layout
13952 \change_inserted -712698321 1534488412
13953 Argument listpreamble:1
13961 As the name implies, it is targeted at lists such as
13978 Its content will be output at the list start, before the first
13979 \begin_inset Flex Code
13982 \begin_layout Plain Layout
13984 \change_inserted -712698321 1534488058
13994 , on an own line (a place that is otherwise not accessible in \SpecialChar LyX
13996 This way, users can insert redefinitions (of lengths etc.) to individual
13998 By default, these arguments do not have a delimiter.
14004 \begin_layout Description
14005 \begin_inset Flex Code
14008 \begin_layout Plain Layout
14014 Includes a comma-separated list of layouts that should be nested in and
14015 after the current layout.
14016 Only makes sense for nestable layouts (such as environments).
14018 \begin_inset Quotes eld
14022 \begin_inset Flex Code
14025 \begin_layout Plain Layout
14032 \begin_inset Quotes erd
14037 \begin_inset Flex Code
14040 \begin_layout Plain Layout
14049 \begin_layout Description
14050 \begin_inset Flex Code
14053 \begin_layout Plain Layout
14059 Note that this will completely override any prior
14060 \begin_inset Flex Code
14063 \begin_layout Plain Layout
14069 declaration for this style.
14071 \begin_inset Quotes eld
14075 \begin_inset Flex Code
14078 \begin_layout Plain Layout
14085 \begin_inset Quotes erd
14090 \begin_inset CommandInset ref
14092 reference "subsec:I18n"
14096 for details on its use.
14099 \begin_layout Description
14100 \begin_inset Flex Code
14103 \begin_layout Plain Layout
14110 \begin_inset Flex Code
14113 \begin_layout Plain Layout
14123 \begin_layout Plain Layout
14124 Note that a `float' here is a real number, such as: 1.5.
14129 The vertical space with which the last of a chain of paragraphs with this
14130 style is separated from the following paragraph.
14131 If the next paragraph has another style, the separations are not simply
14132 added, but the maximum is taken.
14135 \begin_layout Description
14136 \begin_inset Flex Code
14139 \begin_layout Plain Layout
14146 \begin_inset Flex Code
14149 \begin_layout Plain Layout
14155 ] The category for this style.
14156 This is used to group related styles in the style combobox on the toolbar.
14157 Any string can be used, but you may want to use existing categories with
14162 \begin_layout Description
14163 \begin_inset Flex Code
14166 \begin_layout Plain Layout
14172 Depth of XML command.
14173 Used only with XML-type formats.
14176 \begin_layout Description
14177 \begin_inset Flex Code
14180 \begin_layout Plain Layout
14187 \begin_inset Flex Code
14190 \begin_layout Plain Layout
14196 ] Copies all the features of an existing style into the current one.
14200 \begin_layout Description
14201 \begin_inset Flex Code
14204 \begin_layout Plain Layout
14211 \begin_inset Flex Code
14214 \begin_layout Plain Layout
14220 ] The name of a style whose preamble should be output
14225 This allows to ensure some ordering of the preamble snippets when macros
14226 definitions depend on one another.
14230 \begin_layout Plain Layout
14231 Note that, besides that functionality, there is no way to ensure any ordering
14233 The ordering that you see in a given version of \SpecialChar LyX
14234 may change without warning
14243 \begin_layout Description
14244 \begin_inset Flex Code
14247 \begin_layout Plain Layout
14254 \begin_inset Flex Code
14257 \begin_layout Plain Layout
14262 , Box, Filled_Box, Static
14267 ] The type of label that stands at the end of the paragraph (or sequence
14269 \begin_inset Flex Code
14272 \begin_layout Plain Layout
14279 \begin_inset Newline newline
14283 \begin_inset Flex Code
14286 \begin_layout Plain Layout
14293 \begin_inset Flex Code
14296 \begin_layout Plain Layout
14303 \begin_inset Flex Code
14306 \begin_layout Plain Layout
14314 \begin_inset Flex Code
14317 \begin_layout Plain Layout
14324 \begin_inset Quotes eld
14328 \begin_inset Quotes erd
14332 \begin_inset Flex Code
14335 \begin_layout Plain Layout
14342 \begin_inset space \space{}
14346 \begin_inset Flex Code
14349 \begin_layout Plain Layout
14355 ) is a white (resp.
14356 \begin_inset space ~
14359 black) square suitable for end of proof markers,
14360 \begin_inset Flex Code
14363 \begin_layout Plain Layout
14369 is an explicit text string.
14372 \begin_layout Description
14373 \begin_inset Flex Code
14376 \begin_layout Plain Layout
14383 \begin_inset Flex Code
14386 \begin_layout Plain Layout
14392 ] The string used for a label with a
14393 \begin_inset Flex Code
14396 \begin_layout Plain Layout
14403 \begin_inset Newline newline
14407 \begin_inset Flex Code
14410 \begin_layout Plain Layout
14420 \begin_layout Description
14421 \begin_inset Flex Code
14424 \begin_layout Plain Layout
14430 The font used for both the text body
14436 \begin_inset CommandInset ref
14438 reference "subsec:Font-description"
14443 Note that defining this font automatically defines the
14444 \begin_inset Flex Code
14447 \begin_layout Plain Layout
14454 So you should define this one first if you also want to define
14455 \begin_inset Flex Code
14458 \begin_layout Plain Layout
14467 \begin_layout Description
14468 \begin_inset Flex Code
14471 \begin_layout Plain Layout
14478 \begin_inset Flex Code
14481 \begin_layout Plain Layout
14487 ] Used for backporting new styles to stable \SpecialChar LyX
14489 The first stable version that supports this tag is \SpecialChar LyX
14491 The argument is a number which may either be 0, -1 or any value greater
14494 \begin_inset Flex Code
14497 \begin_layout Plain Layout
14503 flag of a style is greater than zero, it will always be written to the
14505 If a .lyx file is read, the style definitions from the document header are
14506 added to the document class.
14507 Therefore even older \SpecialChar LyX
14508 versions can handle the style.
14510 \begin_inset Flex Code
14513 \begin_layout Plain Layout
14519 is a version number: if the style is read, and the version number is less
14520 than the version number of the already existing style in the document class,
14521 the new style is ignored.
14522 If the version number is greater, the new style replaces the existing style.
14523 A value of -1 means an infinite version number, i.
14524 \begin_inset space \thinspace{}
14528 \begin_inset space \space{}
14531 the style is always used.
14534 \begin_layout Description
14535 \begin_inset Flex Code
14538 \begin_layout Plain Layout
14545 \begin_inset Flex Code
14548 \begin_layout Plain Layout
14557 \begin_inset space \thinspace{}
14561 \begin_inset Flex Code
14564 \begin_layout Plain Layout
14570 ] Usually \SpecialChar LyX
14571 does not allow you to insert more than one space between words,
14572 since a space is considered as the separation between two words, not a
14573 character or symbol of its own.
14574 This is a very fine thing but sometimes annoying, for example, when typing
14575 program code or plain \SpecialChar LaTeX
14578 \begin_inset Flex Code
14581 \begin_layout Plain Layout
14589 \change_deleted -495245474 1550490105
14593 will create protected blanks for the additional blanks when in
14594 \change_inserted -495245474 1550490096
14596 \begin_inset Flex Code
14599 \begin_layout Plain Layout
14601 \change_inserted -495245474 1550490089
14610 \change_deleted -495245474 1550490116
14611 another mode than \SpecialChar LaTeX
14614 \change_inserted -495245474 1550247760
14616 \begin_inset Flex Code
14619 \begin_layout Plain Layout
14621 \change_inserted -495245474 1550247736
14630 \begin_inset Flex Code
14633 \begin_layout Plain Layout
14635 \change_inserted -495245474 1550247755
14648 \begin_layout Description
14649 \begin_inset Flex Code
14652 \begin_layout Plain Layout
14658 These tags are used with XHTML output.
14660 \begin_inset CommandInset ref
14662 reference "subsec:Paragraph-Style-XHTML"
14669 \begin_layout Description
14670 \begin_inset Flex Code
14673 \begin_layout Plain Layout
14679 [FIXME] (Used only with XML-type formats.)
14682 \begin_layout Description
14683 \begin_inset Flex Code
14686 \begin_layout Plain Layout
14693 \begin_inset Flex Code
14696 \begin_layout Plain Layout
14705 \begin_inset space \thinspace{}
14709 \begin_inset Flex Code
14712 \begin_layout Plain Layout
14719 \begin_inset Flex Code
14722 \begin_layout Plain Layout
14728 , marks the style as to be included in the document preamble and not in
14730 This is useful for document classes that want such information as the title
14731 and author to appear in the preamble.
14732 Note that this works only for styles for which the
14733 \begin_inset Flex Code
14736 \begin_layout Plain Layout
14743 \begin_inset Flex Code
14746 \begin_layout Plain Layout
14753 \begin_inset Flex Code
14756 \begin_layout Plain Layout
14765 \begin_layout Description
14766 \begin_inset Flex Code
14769 \begin_layout Plain Layout
14776 \begin_inset Flex Code
14779 \begin_layout Plain Layout
14788 \begin_inset space \thinspace{}
14792 \begin_inset Flex Code
14795 \begin_layout Plain Layout
14802 \begin_inset Flex Code
14805 \begin_layout Plain Layout
14811 , marks the style as being part of a title block (see also the
14812 \begin_inset Flex Code
14815 \begin_layout Plain Layout
14822 \begin_inset Flex Code
14825 \begin_layout Plain Layout
14834 \begin_layout Description
14835 \begin_inset Flex Code
14838 \begin_layout Plain Layout
14844 Includes a comma-separated list of layouts after which this one should
14846 Only makes sense with regard to nestable layouts (such as environments).
14848 \begin_inset Quotes eld
14852 \begin_inset Flex Code
14855 \begin_layout Plain Layout
14862 \begin_inset Quotes erd
14867 \begin_inset Flex Code
14870 \begin_layout Plain Layout
14879 \begin_layout Description
14880 \begin_inset Flex Code
14883 \begin_layout Plain Layout
14890 \begin_inset Flex Code
14893 \begin_layout Plain Layout
14902 \begin_inset space \thinspace{}
14906 \begin_inset Flex Code
14909 \begin_layout Plain Layout
14915 ] If this is set to 1 and AddToToc is enabled, the paragraph adds a summary
14916 of its contents in its item in the table of contents.
14917 Otherwise, only the label, if it exists, appears.
14920 \begin_layout Description
14921 \begin_inset Flex Code
14924 \begin_layout Plain Layout
14931 \begin_inset Flex Code
14934 \begin_layout Plain Layout
14940 ] The \SpecialChar LaTeX
14941 command sequence declaring an item in a list.
14942 The command is to be defined without the preceding backslash (the default
14944 \begin_inset Quotes eld
14948 \begin_inset Quotes erd
14952 \begin_inset Flex Code
14955 \begin_layout Plain Layout
14963 in the \SpecialChar LaTeX
14967 \begin_layout Description
14968 \begin_inset Flex Code
14971 \begin_layout Plain Layout
14978 \begin_inset Flex Code
14981 \begin_layout Plain Layout
14987 ] This provides extra space between paragraphs that have the same style.
14988 If you put other styles into an environment, each is separated with the
14990 \begin_inset Flex Code
14993 \begin_layout Plain Layout
15000 But the whole items of the environment are additionally separated with
15002 \begin_inset Flex Code
15005 \begin_layout Plain Layout
15012 Note that this is a
15017 \begin_layout Description
15018 \begin_inset Flex Code
15021 \begin_layout Plain Layout
15027 [FIXME] (Used only with XML-type formats.)
15030 \begin_layout Description
15031 \begin_inset Flex Code
15034 \begin_layout Plain Layout
15041 \begin_inset Flex Code
15044 \begin_layout Plain Layout
15053 \begin_inset space \thinspace{}
15057 \begin_inset Flex Code
15060 \begin_layout Plain Layout
15066 ] Usually \SpecialChar LyX
15067 does not allow you to leave a paragraph empty, since it would
15068 lead to empty \SpecialChar LaTeX
15070 There are some cases where this could be desirable however: in a letter
15071 template, the required fields can be provided as empty fields, so that
15072 people do not forget them; in some special classes, a style can be used
15073 as some kind of break, which does not contain actual text.
15076 \begin_layout Description
15077 \begin_inset Flex Code
15080 \begin_layout Plain Layout
15087 \begin_inset Flex Code
15090 \begin_layout Plain Layout
15096 ] The vertical space between the label and the text body.
15097 Only used for labels that are above the text body (
15098 \begin_inset Flex Code
15101 \begin_layout Plain Layout
15108 \begin_inset Newline newline
15112 \begin_inset Flex Code
15115 \begin_layout Plain Layout
15116 Centered_Top_Environment
15124 \begin_layout Description
15125 \begin_inset Flex Code
15128 \begin_layout Plain Layout
15135 \begin_inset Flex Code
15138 \begin_layout Plain Layout
15144 ] The name of the counter for automatic numbering.
15145 In order to have the counter appear with your label, you will need to reference
15147 \begin_inset Flex Code
15150 \begin_layout Plain Layout
15159 This will work with
15160 \begin_inset Flex Code
15163 \begin_layout Plain Layout
15170 \begin_inset Flex Code
15173 \begin_layout Plain Layout
15180 \begin_inset Flex Code
15183 \begin_layout Plain Layout
15190 \begin_inset Flex Code
15193 \begin_layout Plain Layout
15200 \begin_inset Newline newline
15208 \begin_inset Flex Code
15211 \begin_layout Plain Layout
15218 \begin_inset Flex Code
15221 \begin_layout Plain Layout
15227 , though this case is a bit complicated.
15228 Suppose you declare
15229 \begin_inset Quotes eld
15233 \begin_inset Flex Code
15236 \begin_layout Plain Layout
15237 LabelCounter myenum
15243 \begin_inset Quotes erd
15247 Then the actual counters used are
15248 \begin_inset Flex Code
15251 \begin_layout Plain Layout
15258 \begin_inset Flex Code
15261 \begin_layout Plain Layout
15268 \begin_inset Flex Code
15271 \begin_layout Plain Layout
15278 \begin_inset Flex Code
15281 \begin_layout Plain Layout
15287 , much as in \SpecialChar LaTeX
15289 These counters must all be declared separately.
15290 \begin_inset Newline newline
15294 \begin_inset CommandInset ref
15296 reference "subsec:Counters"
15300 for details on counters.
15303 \begin_layout Description
15304 \begin_inset Flex Code
15307 \begin_layout Plain Layout
15313 The font used for the label.
15315 \begin_inset CommandInset ref
15317 reference "subsec:Font-description"
15324 \begin_layout Description
15325 \begin_inset Flex Code
15328 \begin_layout Plain Layout
15335 \begin_inset Flex Code
15338 \begin_layout Plain Layout
15344 ] Text that indicates how far a label should be indented.
15347 \begin_layout Description
15348 \begin_inset Flex Code
15351 \begin_layout Plain Layout
15358 \begin_inset Flex Code
15361 \begin_layout Plain Layout
15367 ] Text that indicates the amount of horizontal space between the label and
15369 Only used for labels that are not above the text body.
15372 \begin_layout Description
15373 \begin_inset Flex Code
15376 \begin_layout Plain Layout
15383 \begin_inset Flex Code
15386 \begin_layout Plain Layout
15392 ] The string used for the label.
15394 \begin_inset Flex Code
15397 \begin_layout Plain Layout
15403 is set, this string can be contain the special formatting commands described
15405 \begin_inset CommandInset ref
15407 reference "subsec:Counters"
15414 \begin_layout Description
15415 \begin_inset Flex Code
15418 \begin_layout Plain Layout
15419 LabelStringAppendix
15425 \begin_inset Flex Code
15428 \begin_layout Plain Layout
15434 ] This is used inside the appendix instead of
15435 \begin_inset Newline newline
15439 \begin_inset Flex Code
15442 \begin_layout Plain Layout
15450 \begin_inset Flex Code
15453 \begin_layout Plain Layout
15460 \begin_inset Newline newline
15464 \begin_inset Flex Code
15467 \begin_layout Plain Layout
15468 LabelStringAppendix
15476 \begin_layout Description
15477 \begin_inset Flex Code
15480 \begin_layout Plain Layout
15486 [FIXME] (Used only with XML-type formats.)
15489 \begin_layout Description
15490 \begin_inset Flex Code
15493 \begin_layout Plain Layout
15500 \begin_inset Flex Code
15503 \begin_layout Plain Layout
15508 , Manual, Static, Above,
15509 \begin_inset Newline newline
15512 Centered, Sensitive, Enumerate,
15513 \begin_inset Newline newline
15516 Itemize, Bibliography
15525 \begin_layout Description
15526 \begin_inset Flex Code
15529 \begin_layout Plain Layout
15535 means the label is the very first word (up to the first real blank).
15536 Use protected spaces if you want more than one word as the label.
15540 \begin_layout Description
15541 \begin_inset Flex Code
15544 \begin_layout Plain Layout
15550 means the label is simply what is declared as
15551 \begin_inset Flex Code
15554 \begin_layout Plain Layout
15561 This will be displayed
15562 \begin_inset Quotes eld
15566 \begin_inset Quotes erd
15569 , at the beginning of the paragraph.
15571 \begin_inset Flex Code
15574 \begin_layout Plain Layout
15581 \begin_inset Flex Code
15584 \begin_layout Plain Layout
15590 , then it will be displayed only in the first paragraph of any sequence
15591 of paragraphs with the same
15592 \begin_inset Flex Code
15595 \begin_layout Plain Layout
15604 \begin_layout Description
15605 \begin_inset Flex Code
15608 \begin_layout Plain Layout
15615 \begin_inset space ~
15619 \begin_inset space ~
15623 \begin_inset Flex Code
15626 \begin_layout Plain Layout
15632 are special cases of
15633 \begin_inset Flex Code
15636 \begin_layout Plain Layout
15643 The label will be printed above the paragraph either at the beginning of
15644 the line or centered.
15647 \begin_layout Description
15648 \begin_inset Flex Code
15651 \begin_layout Plain Layout
15657 is a special case for the caption-labels
15658 \begin_inset Quotes eld
15662 \begin_inset Quotes erd
15666 \begin_inset Quotes eld
15670 \begin_inset Quotes erd
15674 \begin_inset Newline newline
15678 \begin_inset Flex Code
15681 \begin_layout Plain Layout
15687 means the (hardcoded) label string depends on the kind of float: It is
15688 hardcoded to be `FloatType N', where N is the value of the counter associated
15690 For the case that a caption is inserted outside of a float the
15691 \begin_inset Flex Code
15694 \begin_layout Plain Layout
15701 \begin_inset Quotes eld
15705 \begin_inset Quotes erd
15711 \begin_layout Description
15712 \begin_inset Flex Code
15715 \begin_layout Plain Layout
15721 produces the usual sort of enumeration labels.
15722 The number type needs to be set in the
15727 \begin_inset CommandInset ref
15729 reference "subsec:Counters"
15736 \begin_layout Description
15737 \begin_inset Flex Code
15740 \begin_layout Plain Layout
15746 produces various bullets at the different levels.
15747 The bullet types displayed can be set via
15748 \begin_inset Flex Noun
15751 \begin_layout Plain Layout
15752 Document\SpecialChar menuseparator
15753 Settings\SpecialChar menuseparator
15762 \begin_layout Description
15763 \begin_inset Flex Code
15766 \begin_layout Plain Layout
15772 should be used only with
15773 \begin_inset Flex Code
15776 \begin_layout Plain Layout
15777 LatexType BibEnvironment
15786 \begin_layout Description
15787 \begin_inset Flex Code
15790 \begin_layout Plain Layout
15796 Note that this will completely override any prior
15797 \begin_inset Flex Code
15800 \begin_layout Plain Layout
15806 declaration for this style.
15808 \begin_inset Quotes eld
15812 \begin_inset Flex Code
15815 \begin_layout Plain Layout
15822 \begin_inset Quotes erd
15827 \begin_inset CommandInset ref
15829 reference "subsec:I18n"
15833 for details on its use.
15836 \begin_layout Description
15837 \begin_inset Flex Code
15840 \begin_layout Plain Layout
15847 \begin_inset Flex Code
15850 \begin_layout Plain Layout
15856 ] The name of the corresponding \SpecialChar LaTeX
15858 Either the environment or command name.
15861 \begin_layout Description
15862 \begin_inset Flex Code
15865 \begin_layout Plain Layout
15872 \begin_inset Flex Code
15875 \begin_layout Plain Layout
15881 ] An optional parameter for the corresponding
15882 \begin_inset Flex Code
15885 \begin_layout Plain Layout
15892 This parameter cannot be changed from within \SpecialChar LyX
15894 \begin_inset Flex Code
15897 \begin_layout Plain Layout
15903 for customizable parameters).
15904 This will be output as is after all \SpecialChar LaTeX
15906 \begin_inset Flex Code
15909 \begin_layout Plain Layout
15918 \begin_layout Description
15919 \begin_inset Flex Code
15922 \begin_layout Plain Layout
15929 \begin_inset Flex Code
15932 \begin_layout Plain Layout
15937 , Command, Environment, Item_Environment,
15938 \begin_inset Newline newline
15941 List_Environment, Bib_Environment
15946 ] How the style should be translated into \SpecialChar LaTeX
15951 \begin_layout Plain Layout
15952 \begin_inset Flex Code
15955 \begin_layout Plain Layout
15961 is perhaps a bit misleading, since these rules apply to SGML classes, too.
15962 Visit the SGML class files for specific examples.
15971 \begin_layout Description
15972 \begin_inset Flex Code
15975 \begin_layout Plain Layout
15981 means nothing special.
15984 \begin_layout Description
15985 \begin_inset Flex Code
15988 \begin_layout Plain Layout
15995 \begin_inset Flex Code
15998 \begin_layout Plain Layout
16005 {\SpecialChar ldots
16014 \begin_layout Description
16015 \begin_inset Flex Code
16018 \begin_layout Plain Layout
16025 \begin_inset Flex Code
16028 \begin_layout Plain Layout
16035 }\SpecialChar ldots
16051 \begin_layout Description
16052 \begin_inset Flex Code
16055 \begin_layout Plain Layout
16062 \begin_inset Flex Code
16065 \begin_layout Plain Layout
16072 \begin_inset Flex Code
16075 \begin_layout Plain Layout
16083 is generated for each paragraph of this environment.
16087 \begin_layout Description
16088 \begin_inset Flex Code
16091 \begin_layout Plain Layout
16098 \begin_inset Flex Code
16101 \begin_layout Plain Layout
16108 \begin_inset Newline newline
16112 \begin_inset Flex Code
16115 \begin_layout Plain Layout
16121 is passed as an argument to the environment.
16122 \begin_inset Newline newline
16126 \begin_inset Flex Code
16129 \begin_layout Plain Layout
16135 can be defined in the
16136 \begin_inset Flex Noun
16139 \begin_layout Plain Layout
16140 Edit\SpecialChar menuseparator
16142 \begin_inset space ~
16153 \begin_layout Description
16154 \begin_inset Flex Code
16157 \begin_layout Plain Layout
16164 \begin_inset Flex Code
16167 \begin_layout Plain Layout
16173 but adds the necessary mandatory argument (the longest label) to the begin
16174 statement of the bibliography environment:
16175 \begin_inset Newline newline
16179 \begin_inset Flex Code
16182 \begin_layout Plain Layout
16185 begin{thebibliography}{99}
16191 It is therefore only useful for bibliography environments.
16192 The default longest label
16193 \begin_inset Quotes eld
16197 \begin_inset Quotes erd
16200 can be changed by the user in the paragraph settings of a bibliography
16204 \begin_layout Standard
16205 Putting the last few things together, the \SpecialChar LaTeX
16206 output will be either:
16209 \begin_layout LyX-Code
16212 LatexName[LatexParam]{\SpecialChar ldots
16216 \begin_layout Standard
16220 \begin_layout LyX-Code
16223 begin{LatexName}[LatexParam] \SpecialChar ldots
16229 \begin_layout Standard
16230 depending upon the \SpecialChar LaTeX
16235 \begin_layout Description
16236 \begin_inset Flex Code
16239 \begin_layout Plain Layout
16246 \begin_inset Flex Code
16249 \begin_layout Plain Layout
16255 ] A string that is put at the beginning of the style content.
16256 A line break in the output can be indicated by
16257 \begin_inset Flex Code
16260 \begin_layout Plain Layout
16269 \begin_layout Description
16270 \begin_inset Flex Code
16273 \begin_layout Plain Layout
16280 \begin_inset Flex Code
16283 \begin_layout Plain Layout
16289 ] If you put styles into environments, the different
16290 \begin_inset Flex Code
16293 \begin_layout Plain Layout
16299 are not simply added, but added with a factor
16300 \begin_inset Formula $\frac{4}{\mathrm{depth}+4}$
16304 Note that this parameter is also used when
16305 \begin_inset Flex Code
16308 \begin_layout Plain Layout
16315 \begin_inset Flex Code
16318 \begin_layout Plain Layout
16325 \begin_inset Flex Code
16328 \begin_layout Plain Layout
16335 Then it is added to the manual or dynamic margin.
16336 \begin_inset Newline newline
16340 \begin_inset Quotes eld
16344 \begin_inset Flex Code
16347 \begin_layout Plain Layout
16354 \begin_inset Quotes erd
16357 means that the paragraph is indented with the width of
16358 \begin_inset Quotes eld
16362 \begin_inset Flex Code
16365 \begin_layout Plain Layout
16372 \begin_inset Quotes erd
16375 in the normal font.
16376 You can get a negative width by prefixing the string with
16377 \begin_inset Quotes eld
16381 \begin_inset Flex Code
16384 \begin_layout Plain Layout
16391 \begin_inset Quotes erd
16395 This way was chosen so that the look is the same with each used screen
16399 \begin_layout Description
16400 \begin_inset Flex Code
16403 \begin_layout Plain Layout
16410 \begin_inset Flex Code
16413 \begin_layout Plain Layout
16418 , Manual, Dynamic, First_Dynamic, Right_Address_Box
16424 \begin_inset Newline newline
16427 The kind of margin that the style has on the left side.
16431 \begin_layout Description
16432 \begin_inset Flex Code
16435 \begin_layout Plain Layout
16441 just means a fixed margin.
16444 \begin_layout Description
16445 \begin_inset Flex Code
16448 \begin_layout Plain Layout
16454 means that the left margin depends on the string entered in the
16455 \begin_inset Flex Noun
16458 \begin_layout Plain Layout
16459 Edit\SpecialChar menuseparator
16461 \begin_inset space ~
16470 This is used to typeset nice lists without tabulators.
16473 \begin_layout Description
16474 \begin_inset Flex Code
16477 \begin_layout Plain Layout
16483 means that the margin depends on the size of the label.
16484 This is used for automatic enumerated headlines.
16485 It is obvious that the headline
16486 \begin_inset Quotes eld
16489 5.4.3.2.1 Very long headline
16490 \begin_inset Quotes erd
16493 must have a wider left margin (as wide as
16494 \begin_inset Quotes eld
16498 \begin_inset Quotes erd
16501 plus the space) than
16502 \begin_inset Quotes eld
16505 3.2 Very long headline
16506 \begin_inset Quotes erd
16510 \begin_inset Quotes eld
16514 \begin_inset Quotes erd
16517 are not able to do this.
16520 \begin_layout Description
16521 \begin_inset Flex Code
16524 \begin_layout Plain Layout
16530 is similar, but only the very first row of the paragraph is dynamic, while
16531 the others are static; this is used, for example, for descriptions.
16534 \begin_layout Description
16535 \begin_inset Flex Code
16538 \begin_layout Plain Layout
16544 means the margin is chosen in a way that the longest row of this paragraph
16545 fits to the right margin.
16546 This is used to typeset an address on the right edge of the page.
16550 \begin_layout Description
16551 \begin_inset Flex Code
16554 \begin_layout Plain Layout
16561 \begin_inset Flex Code
16564 \begin_layout Plain Layout
16573 \begin_inset space \thinspace{}
16577 \begin_inset Flex Code
16580 \begin_layout Plain Layout
16586 ] Whether fragile commands in this style should be
16587 \begin_inset Flex Code
16590 \begin_layout Plain Layout
16603 whether this command should itself be protected.)
16604 \change_inserted -712698321 1523696949
16608 \begin_layout Description
16610 \change_inserted -712698321 1552395557
16611 \begin_inset Flex Code
16614 \begin_layout Plain Layout
16616 \change_inserted -712698321 1523696950
16625 \begin_inset Flex Code
16628 \begin_layout Plain Layout
16630 \change_inserted -712698321 1523696950
16641 \begin_inset space \thinspace{}
16645 \begin_inset Flex Code
16648 \begin_layout Plain Layout
16650 \change_inserted -712698321 1523696950
16658 ] This causes macros that contain this layout to be protected with
16659 \begin_inset Flex Code
16662 \begin_layout Plain Layout
16664 \change_inserted -712698321 1523696950
16679 ) if necessary and thus allows (some) verbatim stuff in macros.
16682 \begin_layout Description
16684 \change_inserted -712698321 1552395844
16685 \begin_inset Flex Code
16688 \begin_layout Plain Layout
16690 \change_inserted -712698321 1552395561
16699 \begin_inset Flex Code
16702 \begin_layout Plain Layout
16704 \change_inserted -712698321 1552395557
16715 \begin_inset space \thinspace{}
16719 \begin_inset Flex Code
16722 \begin_layout Plain Layout
16724 \change_inserted -712698321 1552395557
16732 ] Whether specific commands in this style (such as
16733 \begin_inset Flex Code
16736 \begin_layout Plain Layout
16738 \change_inserted -712698321 1552395655
16749 \begin_inset Flex Code
16752 \begin_layout Plain Layout
16754 \change_inserted -712698321 1552395661
16764 ) should be protected in an
16765 \begin_inset Flex Code
16768 \begin_layout Plain Layout
16770 \change_inserted -712698321 1552395631
16781 This is particularly needed for styles that draw on
16789 commands which parse their content in complex ways.
16794 \begin_layout Description
16795 \begin_inset Flex Code
16798 \begin_layout Plain Layout
16805 \begin_inset Flex Code
16808 \begin_layout Plain Layout
16815 \begin_inset space \thinspace{}
16819 \begin_inset Flex Code
16822 \begin_layout Plain Layout
16830 ] Whether newlines are translated into \SpecialChar LaTeX
16832 \begin_inset Flex Code
16835 \begin_layout Plain Layout
16846 The translation can be switched off to allow more comfortable \SpecialChar LaTeX
16848 inside \SpecialChar LyX
16852 \begin_layout Description
16853 \begin_inset Flex Code
16856 \begin_layout Plain Layout
16863 \begin_inset Flex Code
16866 \begin_layout Plain Layout
16875 \begin_inset space \thinspace{}
16879 \begin_inset Flex Code
16882 \begin_layout Plain Layout
16888 ] If set to true, and if
16889 \begin_inset Flex Code
16892 \begin_layout Plain Layout
16899 \begin_inset Flex Code
16902 \begin_layout Plain Layout
16908 ) paragraphs are being indented, then the indentation of such a paragraph
16909 following one of this type will be suppressed.
16910 (So this will not affect the display of non-default paragraphs.)
16913 \begin_layout Description
16914 \begin_inset Flex Code
16917 \begin_layout Plain Layout
16924 \begin_inset Flex Code
16927 \begin_layout Plain Layout
16933 ] Name of a style that has replaced this style.
16934 This is used to rename a style, while keeping backward compatibility.
16937 \begin_layout Description
16938 \begin_inset Flex Code
16941 \begin_layout Plain Layout
16948 \begin_inset Flex Code
16951 \begin_layout Plain Layout
16958 \begin_inset space \thinspace{}
16962 \begin_inset Flex Code
16965 \begin_layout Plain Layout
16971 ] Determines whether consecutive paragraphs of the same type are treated
16972 as belonging together.
16973 This has the effect that the
16974 \begin_inset Flex Code
16977 \begin_layout Plain Layout
16983 is only printed once before such a group.
16984 By default, this is true for
16985 \begin_inset Flex Code
16988 \begin_layout Plain Layout
16995 \begin_inset Flex Code
16998 \begin_layout Plain Layout
17005 \begin_inset Flex Code
17008 \begin_layout Plain Layout
17014 and false for all other types.
17017 \begin_layout Description
17018 \begin_inset Flex Code
17021 \begin_layout Plain Layout
17028 \begin_inset Flex Code
17031 \begin_layout Plain Layout
17040 \begin_inset space \thinspace{}
17044 \begin_inset Flex Code
17047 \begin_layout Plain Layout
17053 ] Indicates that paragraphs will not be separated by an empty line in \SpecialChar LaTeX
17055 but only by a line break; together with
17056 \begin_inset Flex Code
17059 \begin_layout Plain Layout
17065 , this allows to emulate a plain text editor (like the ERT inset).
17068 \begin_layout Description
17069 \begin_inset Flex Code
17072 \begin_layout Plain Layout
17079 \begin_inset Flex Code
17082 \begin_layout Plain Layout
17088 ] The indent of the very first line of a paragraph.
17090 \begin_inset Newline newline
17094 \begin_inset Flex Code
17097 \begin_layout Plain Layout
17103 will be fixed for a certain style.
17104 The exception is the default style, since the indentation for these paragraphs
17105 can be prohibited with
17106 \begin_inset Flex Code
17109 \begin_layout Plain Layout
17117 \begin_inset Flex Code
17120 \begin_layout Plain Layout
17126 style paragraphs inside environments use the
17127 \begin_inset Flex Code
17130 \begin_layout Plain Layout
17136 of the environment, not their native one.
17138 \begin_inset Flex Code
17141 \begin_layout Plain Layout
17147 paragraphs inside an enumeration are not indented.
17150 \begin_layout Description
17151 \begin_inset Flex Code
17154 \begin_layout Plain Layout
17161 \begin_inset Flex Code
17164 \begin_layout Plain Layout
17170 ] The vertical space between two paragraphs of this style.
17173 \begin_layout Description
17174 \begin_inset Flex Code
17177 \begin_layout Plain Layout
17184 \begin_inset Flex Code
17187 \begin_layout Plain Layout
17194 allows the user to choose either
17195 \begin_inset Quotes eld
17199 \begin_inset Quotes erd
17203 \begin_inset Quotes eld
17207 \begin_inset Quotes erd
17210 to separate paragraphs.
17212 \begin_inset Quotes eld
17216 \begin_inset Quotes erd
17220 \begin_inset Flex Code
17223 \begin_layout Plain Layout
17231 \begin_inset Quotes eld
17235 \begin_inset Quotes erd
17239 \begin_inset Flex Code
17242 \begin_layout Plain Layout
17248 is ignored and all paragraphs are separated by the
17249 \begin_inset Flex Code
17252 \begin_layout Plain Layout
17259 The vertical space is calculated with
17260 \begin_inset Flex Code
17263 \begin_layout Plain Layout
17265 \begin_inset space ~
17274 \begin_inset Flex Code
17277 \begin_layout Plain Layout
17283 is the height of a row with the normal font.
17284 This way, the look stays the same with different screen fonts.
17287 \begin_layout Description
17288 \begin_inset Flex Code
17291 \begin_layout Plain Layout
17298 \begin_inset Flex Code
17301 \begin_layout Plain Layout
17310 \begin_inset space \thinspace{}
17314 \begin_inset Flex Code
17317 \begin_layout Plain Layout
17323 ] Whether the contents of this paragraph should be output in raw form, meaning
17324 without special translations that \SpecialChar LaTeX
17328 \begin_layout Description
17329 \begin_inset Flex Code
17332 \begin_layout Plain Layout
17339 \begin_inset Flex Code
17342 \begin_layout Plain Layout
17352 Defines individual characters that should be output in raw form, meaning
17353 without special translations that \SpecialChar LaTeX
17357 \begin_layout Description
17358 \begin_inset Flex Code
17361 \begin_layout Plain Layout
17367 Information to be included in the \SpecialChar LaTeX
17368 preamble when this style is used.
17369 Used to define macros, load packages, etc., required by this particular
17372 \begin_inset Quotes eld
17376 \begin_inset Flex Code
17379 \begin_layout Plain Layout
17386 \begin_inset Quotes erd
17392 \begin_layout Description
17393 \begin_inset Flex Code
17396 \begin_layout Plain Layout
17403 \begin_inset Flex Code
17406 \begin_layout Plain Layout
17412 ] The prefix to use when creating labels referring to paragraphs of this
17414 This allows the use of formatted references.
17417 \begin_layout Description
17418 \begin_inset Flex Code
17421 \begin_layout Plain Layout
17428 \begin_inset Flex Code
17431 \begin_layout Plain Layout
17437 ] Whether the style requires the feature
17438 \begin_inset Flex Code
17441 \begin_layout Plain Layout
17448 \begin_inset CommandInset ref
17450 reference "chap:List-of-functions"
17454 for the list of features).
17455 If you require a package with specific options, you can additionally use
17457 \begin_inset Flex Code
17460 \begin_layout Plain Layout
17466 as a general text class parameter (see
17467 \begin_inset CommandInset ref
17469 reference "subsec:General-text-class"
17476 \begin_layout Description
17477 \begin_inset Flex Code
17480 \begin_layout Plain Layout
17487 \begin_inset Flex Code
17490 \begin_layout Plain Layout
17499 \begin_inset Flex Code
17502 \begin_layout Plain Layout
17508 ] Resets the \SpecialChar LaTeX
17509 arguments of this style (as defined via the
17510 \begin_inset Flex Code
17513 \begin_layout Plain Layout
17520 This is useful if you have copied a style via
17521 \begin_inset Flex Code
17524 \begin_layout Plain Layout
17530 , but you do not want to inherit its (required and optional) arguments.
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 Flex Code
17559 \begin_layout Plain Layout
17565 ] Resumes a counter that is usually reset at each new sequence of layouts.
17566 This is currently only useful when
17567 \begin_inset Flex Code
17570 \begin_layout Plain Layout
17577 \begin_inset Flex Code
17580 \begin_layout Plain Layout
17589 \begin_layout Description
17590 \begin_inset Flex Code
17593 \begin_layout Plain Layout
17600 \begin_inset Flex Code
17603 \begin_layout Plain Layout
17609 ] A string that is put at the end of the layout content.
17610 A line break in the output can be indicated by
17611 \begin_inset Flex Code
17614 \begin_layout Plain Layout
17623 \begin_layout Description
17624 \begin_inset Flex Code
17627 \begin_layout Plain Layout
17634 \begin_inset Flex Code
17637 \begin_layout Plain Layout
17644 \begin_inset Flex Code
17647 \begin_layout Plain Layout
17656 \begin_layout Description
17657 \begin_inset Flex Code
17660 \begin_layout Plain Layout
17667 \begin_inset Flex Code
17670 \begin_layout Plain Layout
17679 \begin_inset Flex Code
17682 \begin_layout Plain Layout
17689 \begin_inset Flex Code
17692 \begin_layout Plain Layout
17699 \begin_inset Flex Code
17702 \begin_layout Plain Layout
17704 \begin_inset space ~
17712 ] This defines what the default spacing should be in the style.
17714 \begin_inset Flex Code
17717 \begin_layout Plain Layout
17724 \begin_inset Flex Code
17727 \begin_layout Plain Layout
17734 \begin_inset Flex Code
17737 \begin_layout Plain Layout
17743 correspond respectively to a multiplier value of 1, 1.25 and 1.667.
17744 If you specify the argument
17745 \begin_inset Flex Code
17748 \begin_layout Plain Layout
17754 , then you must also provide a value argument which will be the actual multiplie
17756 Note that, contrary to other parameters,
17757 \begin_inset Flex Code
17760 \begin_layout Plain Layout
17766 implies the generation of specific \SpecialChar LaTeX
17767 code, using the \SpecialChar LaTeX
17771 \begin_inset Flex Code
17774 \begin_layout Plain Layout
17783 \begin_layout Description
17784 \begin_inset Flex Code
17787 \begin_layout Plain Layout
17794 \begin_inset Flex Code
17797 \begin_layout Plain Layout
17804 \begin_inset space \thinspace{}
17808 \begin_inset Flex Code
17811 \begin_layout Plain Layout
17819 ] Allow spell-checking paragraphs of this style.
17823 \begin_layout Description
17824 \begin_inset Flex Code
17827 \begin_layout Plain Layout
17829 \change_deleted 731793113 1604355211
17831 \change_inserted 731793113 1604355212
17840 \begin_inset Flex Code
17843 \begin_layout Plain Layout
17852 \begin_inset Flex Code
17855 \begin_layout Plain Layout
17862 \change_deleted 731793113 1604355214
17864 \change_inserted 731793113 1604355216
17867 counter of a given counter at the beginning of a new sequence of layouts.
17868 This is currently only useful when
17869 \begin_inset Flex Code
17872 \begin_layout Plain Layout
17879 \begin_inset Flex Code
17882 \begin_layout Plain Layout
17891 \begin_layout Description
17892 \begin_inset Flex Code
17895 \begin_layout Plain Layout
17901 The font used for the text body .
17903 \begin_inset CommandInset ref
17905 reference "subsec:Font-description"
17912 \begin_layout Description
17913 \begin_inset Flex Code
17916 \begin_layout Plain Layout
17925 \begin_inset Flex Code
17928 \begin_layout Plain Layout
17938 The level of the style in the table of contents.
17939 This is used for automatic numbering of section headings.
17942 \begin_layout Description
17943 \begin_inset Flex Code
17946 \begin_layout Plain Layout
17955 \begin_inset Flex Code
17958 \begin_layout Plain Layout
17969 \begin_inset Flex Code
17972 \begin_layout Plain Layout
17979 \begin_inset Flex Code
17982 \begin_layout Plain Layout
17988 ] This tag determines whether the first line indentation of this paragraph
17989 can be toggled via the Paragraph settings dialog.
17993 \begin_inset Flex Code
17996 \begin_layout Plain Layout
18006 is set, indentation can be toggled if the document settings use
18007 \begin_inset Quotes eld
18011 \begin_inset Quotes erd
18014 paragraph style, with
18015 \begin_inset Flex Code
18018 \begin_layout Plain Layout
18024 , indentation can always be toggled, notwithstanding the document settings,
18026 \begin_inset Flex Code
18029 \begin_layout Plain Layout
18035 , indentation can never be toggled.
18038 \begin_layout Description
18039 \begin_inset Flex Code
18042 \begin_layout Plain Layout
18049 \begin_inset Flex Code
18052 \begin_layout Plain Layout
18058 ] The vertical space with which the very first of a chain of paragraphs
18059 with this style is separated from the previous paragraph.
18060 If the previous paragraph has another style, the separations are not simply
18061 added, but the maximum is taken.
18064 \begin_layout Subsection
18065 \begin_inset CommandInset label
18071 Internationalization of Paragraph Styles
18074 \begin_layout Standard
18076 has long supported internationalization of layout information, but, until
18077 version 2.0, this applied only to the user interface and not to, say, PDF
18079 Thus, French authors were forced to resort to ugly hacks if they wanted
18084 1' instead of `Theorem 1'.
18085 Thanks to Georg Baum, that is no longer the case.
18088 \begin_layout Standard
18090 \begin_inset Flex Code
18093 \begin_layout Plain Layout
18099 defines text that is to appear in the typeset document, it may use
18100 \begin_inset Flex Code
18103 \begin_layout Plain Layout
18110 \begin_inset Flex Code
18113 \begin_layout Plain Layout
18119 to support non-English and even multi-language documents correctly.
18120 The following excerpt (from the
18121 \begin_inset Flex Code
18124 \begin_layout Plain Layout
18130 file) shows how this works:
18133 \begin_layout LyX-Code
18138 \begin_layout LyX-Code
18141 theoremstyle{remark}
18144 \begin_layout LyX-Code
18147 newtheorem{claim}[thm]{
18154 \begin_layout LyX-Code
18158 \begin_layout LyX-Code
18162 \begin_layout LyX-Code
18167 claimname}{_(Claim)}
18170 \begin_layout LyX-Code
18174 \begin_layout LyX-Code
18178 \begin_layout LyX-Code
18187 claimname}{_(Claim)}}
18190 \begin_layout LyX-Code
18195 \begin_layout Standard
18196 In principle, any legal \SpecialChar LaTeX
18198 \begin_inset Flex Code
18201 \begin_layout Plain Layout
18208 \begin_inset Flex Code
18211 \begin_layout Plain Layout
18217 tags, but in practice they will typically look as they do here.
18218 The key to correct translation of the typeset text is the definition of
18219 the \SpecialChar LaTeX
18221 \begin_inset Flex Code
18224 \begin_layout Plain Layout
18233 \begin_inset Flex Code
18236 \begin_layout Plain Layout
18248 \begin_layout Standard
18250 \begin_inset Flex Code
18253 \begin_layout Plain Layout
18259 tag provides for internationalization based upon the overall language of
18261 The contents of the tag will be included in the preamble, just as with
18263 \begin_inset Flex Code
18266 \begin_layout Plain Layout
18273 What makes it special is the use of the
18274 \begin_inset Quotes eld
18278 \begin_inset Quotes erd
18282 \begin_inset Flex Code
18285 \begin_layout Plain Layout
18291 , which will be replaced, when \SpecialChar LyX
18292 produces \SpecialChar LaTeX
18293 output, with the translation of
18294 its argument into the document language.
18297 \begin_layout Standard
18299 \begin_inset Flex Code
18302 \begin_layout Plain Layout
18308 tag is more complex, since it is meant to provide support for multi-language
18309 documents and so offers an interface to the
18310 \begin_inset Flex Code
18313 \begin_layout Plain Layout
18320 Its contents will be added to the preamble once for each language that
18321 appears in the document.
18322 In this case, the argument to
18323 \begin_inset Flex Code
18326 \begin_layout Plain Layout
18332 will be replaced with its translation into the language in question; the
18334 \begin_inset Flex Code
18337 \begin_layout Plain Layout
18343 is replaced by the language name (as used by the babel package).
18346 \begin_layout Standard
18347 A German document that also included a French section would thus have the
18348 following in the preamble:
18351 \begin_layout LyX-Code
18360 claimname}{Affirmation}}
18361 \begin_inset Newline newline
18372 claimname}{Behauptung}}
18373 \begin_inset Newline newline
18380 claimname}{Behauptung}
18383 \begin_layout Standard
18386 \begin_inset Flex Code
18389 \begin_layout Plain Layout
18395 will then conspire to produce the correct text in the output.
18398 \begin_layout Standard
18399 One important point to note here is that the translations are provided by
18401 itself, through the file
18402 \begin_inset Flex Code
18405 \begin_layout Plain Layout
18412 This means, in effect, that
18413 \begin_inset Flex Code
18416 \begin_layout Plain Layout
18423 \begin_inset Flex Code
18426 \begin_layout Plain Layout
18432 are really only of use in layout files that are provided with \SpecialChar LyX
18434 entered in user-created layout files will not be seen by \SpecialChar LyX
18435 's internationalizatio
18436 n routines unless the
18437 \begin_inset Flex Code
18440 \begin_layout Plain Layout
18446 file is modified accordingly.
18447 That said, however, any layout created with the intention that it will
18448 be included with \SpecialChar LyX
18449 should use these tags where appropriate.
18450 Please note that the paragraph style translations provided by \SpecialChar LyX
18452 change with a minor update (e.
18453 \begin_inset space \thinspace{}
18457 \begin_inset space \space{}
18460 from version 2.1.x to 2.1.y).
18461 It is however quite likely that a major update (e.
18462 \begin_inset space \thinspace{}
18466 \begin_inset space \space{}
18469 from 2.0.x to 2.1.0) will introduce new translations or corrections.
18472 \begin_layout Subsection
18474 \begin_inset CommandInset label
18476 name "subsec:Floats"
18483 \begin_layout Standard
18484 It is necessary to define the floats (
18485 \begin_inset Flex Noun
18488 \begin_layout Plain Layout
18495 \begin_inset Flex Noun
18498 \begin_layout Plain Layout
18504 , \SpecialChar ldots
18505 ) in the text class itself.
18506 Standard floats are included in the file
18507 \begin_inset Flex Code
18510 \begin_layout Plain Layout
18516 , so you may have to do no more than add
18519 \begin_layout LyX-Code
18520 Input stdfloats.inc
18523 \begin_layout Standard
18524 to your layout file.
18525 If you want to implement a text class that proposes some other float types
18526 (like the AGU class bundled with \SpecialChar LyX
18527 ), the information below will hopefully
18531 \begin_layout Description
18532 \begin_inset Flex Code
18535 \begin_layout Plain Layout
18542 \begin_inset Flex Code
18545 \begin_layout Plain Layout
18551 =!htbpH] Allowed placement options for this float type.
18552 The value is a string of placement characters.
18553 Possible characters include:
18558 \begin_inset Quotes eld
18562 \begin_inset Quotes erd
18570 \begin_inset Quotes eld
18574 \begin_inset Quotes erd
18582 \begin_inset Quotes eld
18586 \begin_inset Quotes erd
18594 \begin_inset Quotes eld
18598 \begin_inset Quotes erd
18606 \begin_inset Quotes eld
18610 \begin_inset Quotes erd
18618 \begin_inset Quotes eld
18622 \begin_inset Quotes erd
18626 The order of the characters in the string does not matter.
18627 If no placement options are allowed, use the string
18634 \begin_layout Description
18635 \begin_inset Flex Code
18638 \begin_layout Plain Layout
18645 \begin_inset Flex Code
18648 \begin_layout Plain Layout
18657 \begin_inset space \thinspace{}
18663 \begin_inset Flex Code
18666 \begin_layout Plain Layout
18676 ] Defines whether the float allows to be rotated via the \SpecialChar LaTeX
18683 \begin_inset Flex Code
18686 \begin_layout Plain Layout
18692 if the float does not support this feature.
18695 \begin_layout Description
18696 \begin_inset Flex Code
18699 \begin_layout Plain Layout
18706 \begin_inset Flex Code
18709 \begin_layout Plain Layout
18718 \begin_inset space \thinspace{}
18724 \begin_inset Flex Code
18727 \begin_layout Plain Layout
18737 ] Defines whether the float has a starred variant that spans columns in
18738 a two column paragraph.
18740 \begin_inset Flex Code
18743 \begin_layout Plain Layout
18749 if the float does not support this feature.
18752 \begin_layout Description
18753 \begin_inset Flex Code
18756 \begin_layout Plain Layout
18763 \begin_inset Flex Code
18766 \begin_layout Plain Layout
18773 \begin_inset Quotes erd
18777 \begin_inset Quotes erd
18780 ] The file name extension of an auxiliary file for the list of figures (or
18783 writes the captions to this file.
18786 \begin_layout Description
18787 \begin_inset Flex Code
18790 \begin_layout Plain Layout
18797 \begin_inset Flex Code
18800 \begin_layout Plain Layout
18807 \begin_inset Quotes erd
18811 \begin_inset Quotes erd
18814 ] The string that will be used in the menus and also for the caption.
18815 This is translated to the current language if babel is used.
18818 \begin_layout Description
18819 \begin_inset Flex Code
18822 \begin_layout Plain Layout
18828 These tags control the XHTML output.
18830 \begin_inset CommandInset ref
18832 reference "sec:Tags-for-XHTML"
18839 \begin_layout Description
18840 \begin_inset Flex Code
18843 \begin_layout Plain Layout
18852 \begin_inset Flex Code
18855 \begin_layout Plain Layout
18864 \begin_inset space \thinspace{}
18868 \begin_inset Flex Code
18871 \begin_layout Plain Layout
18877 ] Indicates whether the float is already defined in the document class or
18878 if instead the \SpecialChar LaTeX
18880 \begin_inset Flex Code
18883 \begin_layout Plain Layout
18889 needs to be loaded to define it on-the-fly.
18891 \begin_inset Flex Code
18894 \begin_layout Plain Layout
18901 \begin_inset Flex Code
18904 \begin_layout Plain Layout
18911 It should be set to
18912 \begin_inset Flex Code
18915 \begin_layout Plain Layout
18921 if the float is already defined by the \SpecialChar LaTeX
18925 \begin_layout Description
18926 \begin_inset Flex Code
18929 \begin_layout Plain Layout
18936 \begin_inset Flex Code
18939 \begin_layout Plain Layout
18946 \begin_inset Quotes erd
18950 \begin_inset Quotes erd
18953 ] The command used to generate a list of floats of this type; the leading
18962 \begin_inset Flex Code
18965 \begin_layout Plain Layout
18971 is false, since there is no standard way to generate this command.
18973 \begin_inset Flex Code
18976 \begin_layout Plain Layout
18982 is true, since in that case there is a standard way to define the command.
18985 \begin_layout Description
18986 \begin_inset Flex Code
18989 \begin_layout Plain Layout
18996 \begin_inset Flex Code
18999 \begin_layout Plain Layout
19006 \begin_inset Quotes erd
19010 \begin_inset Quotes erd
19013 ] A title for a list of floats of this kind (list of figures, tables, or
19015 It is used for the screen label within \SpecialChar LyX
19016 , it is used by \SpecialChar LaTeX
19018 it is used as the title in the XHTML output.
19019 It will be translated to the document language.
19022 \begin_layout Description
19023 \begin_inset Flex Code
19026 \begin_layout Plain Layout
19033 \begin_inset Flex Code
19036 \begin_layout Plain Layout
19043 \begin_inset Quotes erd
19047 \begin_inset Quotes erd
19050 ] This (optional) argument determines whether floats of this class will
19051 be numbered within some sectional unit of the document.
19053 \begin_inset Flex Code
19056 \begin_layout Plain Layout
19063 \begin_inset Quotes eld
19067 \begin_inset Flex Code
19070 \begin_layout Plain Layout
19077 \begin_inset Quotes erd
19080 , the floats will be numbered within chapters.
19084 \begin_layout Description
19085 \begin_inset Flex Code
19088 \begin_layout Plain Layout
19095 \begin_inset Flex Code
19098 \begin_layout Plain Layout
19105 \begin_inset Quotes erd
19109 \begin_inset Quotes erd
19112 ] The default placement for the given class of floats.
19113 The string should be as in standard \SpecialChar LaTeX
19115 \begin_inset Flex Code
19118 \begin_layout Plain Layout
19125 \begin_inset Flex Code
19128 \begin_layout Plain Layout
19135 \begin_inset Flex Code
19138 \begin_layout Plain Layout
19145 \begin_inset Flex Code
19148 \begin_layout Plain Layout
19154 for top, bottom, page, and here, respectively.
19158 \begin_layout Plain Layout
19159 Note that the order of these letters in the string is irrelevant, like in
19166 On top of that there is a new type,
19167 \begin_inset Flex Code
19170 \begin_layout Plain Layout
19176 , which does not really correspond to a float, since it means: put it
19177 \begin_inset Quotes eld
19181 \begin_inset Quotes erd
19185 Note however that the
19186 \begin_inset Flex Code
19189 \begin_layout Plain Layout
19195 specifier is special and, because of implementation details, cannot be
19196 used in non-built in float types.
19197 If you do not understand what this means, just use
19198 \begin_inset Quotes eld
19202 \begin_inset Flex Code
19205 \begin_layout Plain Layout
19212 \begin_inset Quotes erd
19218 \begin_layout Description
19219 \begin_inset Flex Code
19222 \begin_layout Plain Layout
19229 \begin_inset Flex Code
19232 \begin_layout Plain Layout
19238 ] The prefix to use when creating labels referring to floats of this type.
19239 This allows the use of formatted references.
19240 Note that you can remove any
19241 \begin_inset Flex Code
19244 \begin_layout Plain Layout
19250 set by a copied style by using the special value
19251 \begin_inset Quotes eld
19255 \begin_inset Quotes erd
19258 , which must be all caps.
19259 \change_inserted -712698321 1565605014
19263 \begin_layout Description
19265 \change_inserted -712698321 1565605014
19266 \begin_inset Flex Code
19269 \begin_layout Plain Layout
19271 \change_inserted -712698321 1565605014
19280 \begin_inset Flex Code
19283 \begin_layout Plain Layout
19285 \change_inserted -712698321 1565605014
19293 ] As with paragraph styles, see
19294 \begin_inset CommandInset ref
19296 reference "subsec:Paragraph-Styles"
19305 \begin_layout Description
19306 \begin_inset Flex Code
19309 \begin_layout Plain Layout
19316 \begin_inset Flex Code
19319 \begin_layout Plain Layout
19326 \begin_inset Quotes erd
19330 \begin_inset Quotes erd
19333 ] The style used when defining the float using
19334 \begin_inset Flex Code
19337 \begin_layout Plain Layout
19348 \begin_layout Description
19349 \begin_inset Flex Code
19352 \begin_layout Plain Layout
19359 \begin_inset Flex Code
19362 \begin_layout Plain Layout
19369 \begin_inset Quotes erd
19373 \begin_inset Quotes erd
19377 \begin_inset Quotes eld
19381 \begin_inset Quotes erd
19384 of the new class of floats, like program or algorithm.
19385 After the appropriate
19386 \begin_inset Flex Code
19389 \begin_layout Plain Layout
19398 \begin_inset Flex Code
19401 \begin_layout Plain Layout
19410 \begin_inset Flex Code
19413 \begin_layout Plain Layout
19424 \begin_layout Description
19425 \begin_inset Flex Code
19428 \begin_layout Plain Layout
19435 \begin_inset Flex Code
19438 \begin_layout Plain Layout
19445 \begin_inset space \thinspace{}
19449 \begin_inset Flex Code
19452 \begin_layout Plain Layout
19460 ] Specifies whether this float is defined using the \SpecialChar LaTeX
19462 \begin_inset Flex Code
19465 \begin_layout Plain Layout
19471 , either by the class file, another package or on-the-fly by \SpecialChar LyX
19475 \begin_layout Standard
19476 Note that defining a float with type
19477 \begin_inset Flex Code
19480 \begin_layout Plain Layout
19488 automatically defines the corresponding counter with name
19489 \begin_inset Flex Code
19492 \begin_layout Plain Layout
19503 \begin_layout Subsection
19504 Flex insets and InsetLayout
19505 \begin_inset CommandInset label
19507 name "subsec:Flex-insets-and"
19514 \begin_layout Standard
19515 Flex insets come in
19516 \change_deleted 5863208 1594239511
19518 \change_inserted 5863208 1594239512
19524 \begin_layout Itemize
19526 \begin_inset Flex Code
19529 \begin_layout Plain Layout
19535 ): These define semantic markup corresponding to such \SpecialChar LaTeX
19537 \begin_inset Flex Code
19540 \begin_layout Plain Layout
19549 \begin_inset Flex Code
19552 \begin_layout Plain Layout
19563 \begin_layout Itemize
19565 \begin_inset Flex Code
19568 \begin_layout Plain Layout
19574 ): These can be used to define custom collapsible insets, similar to \SpecialChar TeX
19576 footnote, and the like.
19577 An obvious example is an endnote inset, which is defined in the
19578 \begin_inset Flex Code
19581 \begin_layout Plain Layout
19590 \begin_layout Itemize
19592 \change_deleted 5863208 1594239528
19594 \begin_inset Flex Code
19597 \begin_layout Plain Layout
19603 ): For use with DocBook classes.
19608 \begin_layout Standard
19609 Flex insets are defined using the
19610 \begin_inset Flex Code
19613 \begin_layout Plain Layout
19619 tag, which shall be explained in a moment.
19622 \begin_layout Standard
19624 \begin_inset Flex Code
19627 \begin_layout Plain Layout
19633 tag also serves another function: It can be used to customize the general
19634 layout of many different types of insets.
19636 \begin_inset Flex Code
19639 \begin_layout Plain Layout
19645 can be used to customize the layout parameters for footnotes, marginal
19646 notes, note insets, \SpecialChar TeX
19647 code (ERT) insets, branches, listings, indexes, boxes,
19648 tables, algorithms, URLs, and captions, as well as to define Flex insets.
19651 \begin_layout Standard
19653 \begin_inset Flex Code
19656 \begin_layout Plain Layout
19662 definition must begin with a line of the form:
19665 \begin_layout LyX-Code
19669 \begin_layout Standard
19671 \begin_inset Flex Code
19674 \begin_layout Plain Layout
19680 indicates the inset whose layout is being defined, and here there are four
19684 \begin_layout Enumerate
19685 The layout for a pre-existing inset is being modified.
19686 In this case, can be
19687 \begin_inset Flex Code
19690 \begin_layout Plain Layout
19696 any one of the following:
19697 \begin_inset Flex Code
19700 \begin_layout Plain Layout
19707 \begin_inset Flex Code
19710 \begin_layout Plain Layout
19717 \begin_inset Flex Code
19720 \begin_layout Plain Layout
19727 \begin_inset Flex Code
19730 \begin_layout Plain Layout
19737 \begin_inset Flex Code
19740 \begin_layout Plain Layout
19747 \begin_inset Flex Code
19750 \begin_layout Plain Layout
19757 \begin_inset Flex Code
19760 \begin_layout Plain Layout
19767 \begin_inset Flex Code
19770 \begin_layout Plain Layout
19777 \begin_inset Flex Code
19780 \begin_layout Plain Layout
19787 \begin_inset Flex Code
19790 \begin_layout Plain Layout
19797 \begin_inset Flex Code
19800 \begin_layout Plain Layout
19807 \begin_inset Flex Code
19810 \begin_layout Plain Layout
19817 \begin_inset Flex Code
19820 \begin_layout Plain Layout
19827 \begin_inset Flex Code
19830 \begin_layout Plain Layout
19837 \begin_inset Flex Code
19840 \begin_layout Plain Layout
19847 \begin_inset Flex Code
19850 \begin_layout Plain Layout
19857 \begin_inset Flex Code
19860 \begin_layout Plain Layout
19867 \begin_inset Flex Code
19870 \begin_layout Plain Layout
19877 \begin_inset Flex Code
19880 \begin_layout Plain Layout
19887 \begin_inset Flex Code
19890 \begin_layout Plain Layout
19899 \begin_layout Enumerate
19900 The layout for a Flex inset is being defined.
19902 \begin_inset Flex Code
19905 \begin_layout Plain Layout
19911 must be of the form
19912 \begin_inset Quotes eld
19916 \begin_inset Flex Code
19919 \begin_layout Plain Layout
19926 \begin_inset Quotes erd
19930 \begin_inset Flex Code
19933 \begin_layout Plain Layout
19939 may be any valid identifier not used by a pre-existing Flex inset.
19940 The identifier may include spaces, but in that case the whole thing must
19941 be wrapped in quotes.
19942 Note that the definition of a flex inset
19947 \begin_inset Flex Code
19950 \begin_layout Plain Layout
19956 entry, declaring which type of inset it defines.
19959 \begin_layout Enumerate
19960 The layout for user specific branch is being defined.
19962 \begin_inset Flex Code
19965 \begin_layout Plain Layout
19971 must be of the form
19972 \begin_inset Quotes eld
19976 \begin_inset Flex Code
19979 \begin_layout Plain Layout
19986 \begin_inset Quotes erd
19990 \begin_inset Flex Code
19993 \begin_layout Plain Layout
19999 may be any valid identifier of branch defined in user's document.
20000 The identifier may include spaces, but in that case the whole thing must
20001 be wrapped in quotes.
20002 The main purpose of this feature is to allow \SpecialChar LaTeX
20003 wrapping around specific
20004 branches as user needs.
20007 \begin_layout Enumerate
20008 The layout of a user (or class) specific caption is being defined.
20010 \begin_inset Flex Code
20013 \begin_layout Plain Layout
20019 must be of the form
20020 \begin_inset Quotes eld
20024 \begin_inset Flex Code
20027 \begin_layout Plain Layout
20034 \begin_inset Quotes erd
20038 \begin_inset Flex Code
20041 \begin_layout Plain Layout
20047 specifies the name of the caption as it appears in the menu.
20048 Have a look at the standard caption (
20049 \begin_inset Flex Code
20052 \begin_layout Plain Layout
20058 ), the specific captions of the KOMA-Script classes (
20059 \begin_inset Flex Code
20062 \begin_layout Plain Layout
20069 \begin_inset Flex Code
20072 \begin_layout Plain Layout
20081 \begin_inset space ~
20085 \begin_inset Newline linebreak
20091 \begin_inset Flex Code
20094 \begin_layout Plain Layout
20100 ) for applications.
20103 \begin_layout Standard
20105 \begin_inset Flex Code
20108 \begin_layout Plain Layout
20114 definition can contain the following entries:
20117 \begin_layout Description
20118 \begin_inset Flex Code
20121 \begin_layout Plain Layout
20128 \begin_inset Flex Code
20131 \begin_layout Plain Layout
20137 =""] This inset will appear in the table of contents of the given type.
20138 An empty string disables.
20139 See also the OutlinerName and the IsTocCaption commands.
20140 This is only implemented for Flex insets.
20144 \begin_layout Description
20145 \begin_inset Flex Code
20148 \begin_layout Plain Layout
20155 \begin_inset Flex Code
20158 \begin_layout Plain Layout
20164 ] Defines argument number of a command\SpecialChar breakableslash
20165 environment associated with the current
20167 The definition must end with
20168 \begin_inset Flex Code
20171 \begin_layout Plain Layout
20179 \change_inserted -584632292 1615846847
20181 \begin_inset CommandInset ref
20183 reference "subsec:Arguments"
20191 \change_deleted -584632292 1615846847
20193 \begin_inset CommandInset ref
20195 reference "subsec:Paragraph-Styles"
20202 \change_deleted -584632292 1615846902
20204 \change_inserted -584632292 1615846906
20210 \begin_layout Description
20211 \begin_inset Flex Code
20214 \begin_layout Plain Layout
20220 Preamble for changing language commands; see
20221 \begin_inset CommandInset ref
20223 reference "subsec:I18n"
20230 \begin_layout Description
20231 \begin_inset Flex Code
20234 \begin_layout Plain Layout
20241 \begin_inset Flex Code
20244 \begin_layout Plain Layout
20250 ] The color for the inset's background.
20252 \begin_inset CommandInset ref
20254 reference "chap:Names-of-colors"
20258 for a list of the available color names.
20261 \begin_layout Description
20262 \begin_inset Flex Code
20265 \begin_layout Plain Layout
20272 \begin_inset Flex Code
20275 \begin_layout Plain Layout
20284 \begin_inset space \thinspace{}
20288 \begin_inset Flex Code
20291 \begin_layout Plain Layout
20297 ] Whether to use the content of the inset as the label, when the inset is
20302 \begin_layout Description
20303 \begin_inset Flex Code
20306 \begin_layout Plain Layout
20313 \begin_inset Flex Code
20316 \begin_layout Plain Layout
20322 ] As with paragraph styles, see
20323 \begin_inset CommandInset ref
20325 reference "subsec:Paragraph-Styles"
20330 Note that you need to specify the complete type, e.
20331 \begin_inset space \thinspace{}
20335 \begin_inset space ~
20339 \begin_inset Flex Code
20342 \begin_layout Plain Layout
20343 CopyStyle Flex:<name>
20351 \begin_layout Description
20352 \begin_inset Flex Code
20355 \begin_layout Plain Layout
20362 \begin_inset Flex Code
20365 \begin_layout Plain Layout
20374 \begin_inset space \thinspace{}
20378 \begin_inset Flex Code
20381 \begin_layout Plain Layout
20387 ] Indicates whether the user may employ the Paragraph Settings dialog to
20388 customize the paragraph.
20391 \begin_layout Description
20392 \begin_inset Flex Code
20395 \begin_layout Plain Layout
20402 \begin_inset Flex Code
20405 \begin_layout Plain Layout
20412 \begin_inset Flex Code
20415 \begin_layout Plain Layout
20422 \begin_inset Flex Code
20425 \begin_layout Plain Layout
20431 , describing the rendering style used for the inset's frame and buttons.
20432 Footnotes generally use
20433 \begin_inset Flex Code
20436 \begin_layout Plain Layout
20442 , ERT insets generally
20443 \begin_inset Flex Code
20446 \begin_layout Plain Layout
20452 , and character styles
20453 \begin_inset Flex Code
20456 \begin_layout Plain Layout
20465 \begin_layout Description
20466 \begin_inset Flex Code
20469 \begin_layout Plain Layout
20476 \begin_inset Flex Code
20479 \begin_layout Plain Layout
20488 \begin_inset space \thinspace{}
20494 \begin_inset Flex Code
20497 \begin_layout Plain Layout
20506 \begin_inset Flex Code
20509 \begin_layout Plain Layout
20516 \begin_inset Flex Code
20519 \begin_layout Plain Layout
20526 Indicates whether the environment will stand on its own in the output or
20527 will appear inline with the surrounding text.
20528 If set to false, it is supposed that the \SpecialChar LaTeX
20529 environment ignores white space
20530 (including one newline character) after the
20531 \begin_inset Flex Code
20534 \begin_layout Plain Layout
20547 \begin_inset Flex Code
20550 \begin_layout Plain Layout
20564 \change_inserted 731793113 1538674858
20568 \begin_layout Description
20570 \change_inserted 731793113 1538674891
20571 \begin_inset Flex Code
20574 \begin_layout Plain Layout
20576 \change_inserted 731793113 1538674863
20588 ,1] Allow the contents of the inset to be edited externally (using whatever
20589 editor is defined for the document's output format).
20594 \begin_layout Description
20595 \begin_inset Flex Code
20598 \begin_layout Plain Layout
20604 Required at the end of the
20605 \begin_inset Flex Code
20608 \begin_layout Plain Layout
20617 \begin_layout Description
20618 \begin_inset Flex Code
20621 \begin_layout Plain Layout
20627 The font used for both the text body
20633 \begin_inset CommandInset ref
20635 reference "subsec:Font-description"
20640 Note that defining this font automatically defines the
20641 \begin_inset Flex Code
20644 \begin_layout Plain Layout
20650 to the same value, so define this first and define
20651 \begin_inset Flex Code
20654 \begin_layout Plain Layout
20660 later if you want them to be different.
20663 \begin_layout Description
20664 \begin_inset Flex Code
20667 \begin_layout Plain Layout
20668 FixedWidthPreambleEncoding
20674 \begin_inset Flex Code
20677 \begin_layout Plain Layout
20686 \begin_inset space \thinspace{}
20690 \begin_inset Flex Code
20693 \begin_layout Plain Layout
20699 ] Force a fixed width encoding for the translated contents of
20700 \begin_inset Flex Code
20703 \begin_layout Plain Layout
20710 \begin_inset Flex Code
20713 \begin_layout Plain Layout
20719 code generated by this layout.
20720 This is needed for special \SpecialChar LaTeX
20725 that do not work with variable width encodings such as
20730 This setting is ignored if fully Unicode aware \SpecialChar LaTeX
20731 backends such as Xe\SpecialChar TeX
20733 Lua\SpecialChar TeX
20737 \begin_layout Description
20738 \begin_inset Flex Code
20741 \begin_layout Plain Layout
20742 ForceLocalFontSwitch
20748 \begin_inset Flex Code
20751 \begin_layout Plain Layout
20760 \begin_inset space \thinspace{}
20764 \begin_inset Flex Code
20767 \begin_layout Plain Layout
20773 ] When using babel, always use a local font switch (
20774 \begin_inset Flex Code
20777 \begin_layout Plain Layout
20785 ), never a global one (such as
20786 \begin_inset Flex Code
20789 \begin_layout Plain Layout
20800 \begin_layout Description
20801 \begin_inset Flex Code
20804 \begin_layout Plain Layout
20811 \begin_inset Flex Code
20814 \begin_layout Plain Layout
20823 \begin_inset space \thinspace{}
20827 \begin_inset Flex Code
20830 \begin_layout Plain Layout
20837 \begin_inset Quotes eld
20841 \begin_inset Quotes erd
20844 language, leading to Left-to-Right (Latin) output, e.
20845 \begin_inset space \thinspace{}
20849 \begin_inset space \space{}
20852 in \SpecialChar TeX
20857 \begin_layout Description
20858 \begin_inset Flex Code
20861 \begin_layout Plain Layout
20868 \begin_inset Flex Code
20871 \begin_layout Plain Layout
20880 \begin_inset space \thinspace{}
20884 \begin_inset Flex Code
20887 \begin_layout Plain Layout
20893 ] Force a line break in the \SpecialChar LaTeX
20894 output before the inset starts and after the
20896 This assures the inset itself is output on its own lines, for parsing purposes.
20899 \begin_layout Description
20900 \begin_inset Flex Code
20903 \begin_layout Plain Layout
20910 \begin_inset Flex Code
20913 \begin_layout Plain Layout
20922 \begin_inset space \thinspace{}
20926 \begin_inset Flex Code
20929 \begin_layout Plain Layout
20935 ] Indicates whether the
20936 \begin_inset Flex Code
20939 \begin_layout Plain Layout
20945 should be used or, instead, the user can change the paragraph style used
20950 \begin_layout Description
20951 \begin_inset Flex Code
20954 \begin_layout Plain Layout
20961 \begin_inset Flex Code
20964 \begin_layout Plain Layout
20973 \begin_inset space \thinspace{}
20977 \begin_inset Flex Code
20980 \begin_layout Plain Layout
20986 ] As with paragraph styles, see
20987 \begin_inset CommandInset ref
20989 reference "subsec:Paragraph-Styles"
20996 \begin_layout Description
20997 \begin_inset Flex Code
21000 \begin_layout Plain Layout
21006 These tags control the XHTML output.
21008 \begin_inset CommandInset ref
21010 reference "sec:Tags-for-XHTML"
21017 \begin_layout Description
21018 \begin_inset Flex Code
21021 \begin_layout Plain Layout
21028 \begin_inset Flex Code
21031 \begin_layout Plain Layout
21040 \begin_inset space \thinspace{}
21044 \begin_inset Flex Code
21047 \begin_layout Plain Layout
21053 ] Whether to include the contents of this inset in the strings generated
21054 for the `Outline' pane for all table of contents, regardless of the AddToToc
21056 One would not, for example, want the content of a footnote in a section
21057 header to be included in the TOC displayed in the outline, but one would
21058 normally want the content of a character style displayed.
21059 Default is false: not to include.
21062 \begin_layout Description
21063 \begin_inset Flex Code
21066 \begin_layout Plain Layout
21073 \begin_inset Flex Code
21076 \begin_layout Plain Layout
21085 \begin_inset space \thinspace{}
21089 \begin_inset Flex Code
21092 \begin_layout Plain Layout
21098 ] If this is set to 1 and AddToToc is enabled, the inset adds a summary
21099 of its contents in its item in the table of contents.
21100 Otherwise, only the label appears.
21103 \begin_layout Description
21104 \begin_inset Flex Code
21107 \begin_layout Plain Layout
21116 \begin_inset Flex Code
21119 \begin_layout Plain Layout
21128 \begin_inset space \thinspace{}
21132 \begin_inset Flex Code
21135 \begin_layout Plain Layout
21141 ] As with paragraph styles, see
21142 \begin_inset CommandInset ref
21144 reference "subsec:Paragraph-Styles"
21151 \begin_layout Description
21152 \begin_inset Flex Code
21155 \begin_layout Plain Layout
21161 The font used for the label.
21163 \begin_inset CommandInset ref
21165 reference "subsec:Font-description"
21170 Note that this definition can never appear before
21171 \begin_inset Flex Code
21174 \begin_layout Plain Layout
21180 , lest it be ineffective.
21183 \begin_layout Description
21184 \begin_inset Flex Code
21187 \begin_layout Plain Layout
21194 \begin_inset Flex Code
21197 \begin_layout Plain Layout
21204 \begin_inset Quotes erd
21208 \begin_inset Quotes erd
21211 ] What will be displayed on the button or elsewhere as the inset label.
21213 \begin_inset Flex Code
21216 \begin_layout Plain Layout
21224 \begin_inset Flex Code
21227 \begin_layout Plain Layout
21233 ) modify this label on the fly.
21236 \begin_layout Description
21237 \begin_inset Flex Code
21240 \begin_layout Plain Layout
21246 Language dependent preamble; see
21247 \begin_inset CommandInset ref
21249 reference "subsec:I18n"
21256 \begin_layout Description
21257 \begin_inset Flex Code
21260 \begin_layout Plain Layout
21267 \begin_inset Flex Code
21270 \begin_layout Plain Layout
21276 ] The name of the corresponding \SpecialChar LaTeX
21278 Either the environment or command name.
21281 \begin_layout Description
21282 \begin_inset Flex Code
21285 \begin_layout Plain Layout
21292 \begin_inset Flex Code
21295 \begin_layout Plain Layout
21301 ] The optional parameter for the corresponding
21302 \begin_inset Flex Code
21305 \begin_layout Plain Layout
21311 stuff, including possible bracket pairs like
21312 \begin_inset Flex Code
21315 \begin_layout Plain Layout
21322 This parameter cannot be changed from within \SpecialChar LyX
21324 \begin_inset Flex Code
21327 \begin_layout Plain Layout
21333 for customizable parameters).
21334 It will be output as is after all \SpecialChar LaTeX
21336 \begin_inset Flex Code
21339 \begin_layout Plain Layout
21348 \begin_layout Description
21349 \begin_inset Flex Code
21352 \begin_layout Plain Layout
21359 \begin_inset Flex Code
21362 \begin_layout Plain Layout
21363 Command, Environment, None
21368 ] How the style should be translated into \SpecialChar LaTeX
21373 \begin_layout Plain Layout
21374 \begin_inset Flex Code
21377 \begin_layout Plain Layout
21383 is perhaps a bit misleading, since these rules apply to SGML classes too.
21384 Visit the SGML class files for specific examples.
21393 \begin_layout Description
21394 \begin_inset Flex Code
21397 \begin_layout Plain Layout
21403 means nothing special
21406 \begin_layout Description
21407 \begin_inset Flex Code
21410 \begin_layout Plain Layout
21417 \begin_inset Flex Code
21420 \begin_layout Plain Layout
21427 {\SpecialChar ldots
21436 \begin_layout Description
21437 \begin_inset Flex Code
21440 \begin_layout Plain Layout
21447 \begin_inset Flex Code
21450 \begin_layout Plain Layout
21457 }\SpecialChar ldots
21472 \begin_layout Standard
21473 Putting the last few things together, the \SpecialChar LaTeX
21474 output will be either:
21477 \begin_layout LyX-Code
21480 LatexName[LatexParam]{\SpecialChar ldots
21484 \begin_layout Standard
21488 \begin_layout LyX-Code
21491 begin{LatexName}[LatexParam] \SpecialChar ldots
21497 \begin_layout Standard
21498 depending upon the \SpecialChar LaTeX
21503 \begin_layout Description
21504 \begin_inset Flex Code
21507 \begin_layout Plain Layout
21514 \begin_inset Flex Code
21517 \begin_layout Plain Layout
21523 ] A string that is put at the beginning of the layout content.
21524 A line break in the output can be indicated by
21525 \begin_inset Flex Code
21528 \begin_layout Plain Layout
21537 \begin_layout Description
21538 \begin_inset Flex Code
21541 \begin_layout Plain Layout
21548 \begin_inset Flex Code
21551 \begin_layout Plain Layout
21558 \begin_inset Flex Code
21561 \begin_layout Plain Layout
21568 \change_deleted -584632292 1615846609
21570 \begin_inset Flex Code
21573 \begin_layout Plain Layout
21582 \begin_inset Flex Code
21585 \begin_layout Plain Layout
21591 (indicating a dummy definition ending definitions of charstyles, etc).
21592 This entry is required in and is only meaningful for Flex insets.
21593 Among other things, it determines on which menu this inset will appear.
21595 \begin_inset Flex Code
21598 \begin_layout Plain Layout
21605 \begin_inset Flex Code
21608 \begin_layout Plain Layout
21614 will automatically set
21615 \begin_inset Flex Code
21618 \begin_layout Plain Layout
21625 \begin_inset Flex Code
21628 \begin_layout Plain Layout
21636 \begin_inset Flex Code
21639 \begin_layout Plain Layout
21645 can be set to true, or
21646 \begin_inset Flex Code
21649 \begin_layout Plain Layout
21656 \begin_inset Flex Code
21659 \begin_layout Plain Layout
21665 insets by setting it
21670 \begin_inset Flex Code
21673 \begin_layout Plain Layout
21680 \change_inserted -712698321 1555575738
21684 \begin_layout Description
21686 \change_inserted -712698321 1555575844
21687 \begin_inset Flex Code
21690 \begin_layout Plain Layout
21692 \change_inserted -712698321 1555575740
21701 \begin_inset Flex Code
21704 \begin_layout Plain Layout
21706 \change_inserted -712698321 1555575740
21714 A dedicated string for the menu.
21715 You can define an accelerator by appending the respective character to
21716 the string, divided by
21717 \begin_inset Quotes eld
21721 \begin_inset Quotes erd
21725 \begin_inset space \thinspace{}
21729 \begin_inset space \space{}
21733 \begin_inset Quotes eld
21737 \begin_inset Flex Code
21740 \begin_layout Plain Layout
21742 \change_inserted -712698321 1555575781
21751 \begin_inset Quotes erd
21755 This specification is optional.
21756 If it is not given the inset name as specified in the type declaration
21757 will be used instead for the menu.
21762 \begin_layout Description
21763 \begin_inset Flex Code
21766 \begin_layout Plain Layout
21773 \begin_inset Flex Code
21776 \begin_layout Plain Layout
21785 \begin_inset space \thinspace{}
21789 \begin_inset Flex Code
21792 \begin_layout Plain Layout
21798 ] Whether multiple paragraphs are permitted in this inset.
21800 \begin_inset Flex Code
21803 \begin_layout Plain Layout
21809 to the same value and
21810 \begin_inset Flex Code
21813 \begin_layout Plain Layout
21819 to the opposite value.
21820 These can be reset to other values, if they are used
21825 \begin_inset Flex Code
21828 \begin_layout Plain Layout
21838 \begin_layout Description
21839 \begin_inset Flex Code
21842 \begin_layout Plain Layout
21849 \begin_inset Flex Code
21852 \begin_layout Plain Layout
21861 \begin_inset space \thinspace{}
21865 \begin_inset Flex Code
21868 \begin_layout Plain Layout
21874 ] Whether fragile commands in this inset should be
21875 \begin_inset Flex Code
21878 \begin_layout Plain Layout
21891 whether the command should itself be protected.) Default is false.
21892 \change_inserted -712698321 1523633958
21896 \begin_layout Description
21898 \change_inserted -712698321 1552395786
21899 \begin_inset Flex Code
21902 \begin_layout Plain Layout
21904 \change_inserted -712698321 1523633961
21913 \begin_inset Flex Code
21916 \begin_layout Plain Layout
21918 \change_inserted -712698321 1523633958
21929 \begin_inset space \thinspace{}
21933 \begin_inset Flex Code
21936 \begin_layout Plain Layout
21938 \change_inserted -712698321 1523633958
21946 ] This causes macros that contain this inset to be protected with
21947 \begin_inset Flex Code
21950 \begin_layout Plain Layout
21952 \change_inserted -712698321 1523634038
21967 ) if necessary and thus allows (some) verbatim stuff in macros.
21971 \begin_layout Description
21973 \change_inserted -712698321 1555579651
21974 \begin_inset Flex Code
21977 \begin_layout Plain Layout
21979 \change_inserted -712698321 1552395787
21988 \begin_inset Flex Code
21991 \begin_layout Plain Layout
21993 \change_inserted -712698321 1552395787
22004 \begin_inset space \thinspace{}
22008 \begin_inset Flex Code
22011 \begin_layout Plain Layout
22013 \change_inserted -712698321 1552395787
22021 ] Whether specific commands in this inset (such as
22022 \begin_inset Flex Code
22025 \begin_layout Plain Layout
22027 \change_inserted -712698321 1552395787
22038 \begin_inset Flex Code
22041 \begin_layout Plain Layout
22043 \change_inserted -712698321 1552395787
22053 ) should be protected in an
22054 \begin_inset Flex Code
22057 \begin_layout Plain Layout
22059 \change_inserted -712698321 1552395787
22070 This is particularly needed for insets that draw on
22078 commands which parse their content in complex ways.
22082 \begin_layout Description
22084 \change_inserted -712698321 1555579742
22085 \begin_inset Flex Code
22088 \begin_layout Plain Layout
22090 \change_inserted -712698321 1555579658
22099 \begin_inset Flex Code
22102 \begin_layout Plain Layout
22104 \change_inserted -712698321 1555579651
22112 Option to define a different command (from the default
22113 \begin_inset Flex Code
22116 \begin_layout Plain Layout
22118 \change_inserted -712698321 1555579742
22130 ) to be used for line breaks.
22131 The initial backslash must not be specified.
22136 \begin_layout Description
22137 \begin_inset Flex Code
22140 \begin_layout Plain Layout
22147 \begin_inset Flex Code
22150 \begin_layout Plain Layout
22156 ] Deletes an existing
22157 \begin_inset Flex Code
22160 \begin_layout Plain Layout
22169 \begin_layout Description
22170 \begin_inset Flex Code
22173 \begin_layout Plain Layout
22180 \begin_inset Flex Code
22183 \begin_layout Plain Layout
22190 \begin_inset Flex Code
22193 \begin_layout Plain Layout
22199 that has replaced this
22200 \begin_inset Flex Code
22203 \begin_layout Plain Layout
22210 This is used to rename an
22211 \begin_inset Flex Code
22214 \begin_layout Plain Layout
22220 , while keeping backward compatibility.
22221 \change_inserted -712698321 1559491850
22225 \begin_layout Description
22227 \change_inserted -712698321 1559492002
22228 \begin_inset Flex Code
22231 \begin_layout Plain Layout
22233 \change_inserted -712698321 1559491854
22242 \begin_inset Flex Code
22245 \begin_layout Plain Layout
22247 \change_inserted -712698321 1559491850
22258 \begin_inset space \thinspace{}
22262 \begin_inset Flex Code
22265 \begin_layout Plain Layout
22267 \change_inserted -712698321 1559491850
22275 ] If this is set to
22276 \begin_inset Flex Code
22279 \begin_layout Plain Layout
22281 \change_inserted -712698321 1559491881
22289 , paragraph breaks will be ignored in the output.
22290 This might be useful for insets where the content should be alignable on
22291 different lines only in the \SpecialChar LyX
22292 workarea, without any effect in the output.
22297 \begin_layout Description
22298 \begin_inset Flex Code
22301 \begin_layout Plain Layout
22308 \begin_inset Flex Code
22311 \begin_layout Plain Layout
22320 \begin_inset space \thinspace{}
22324 \begin_inset Flex Code
22327 \begin_layout Plain Layout
22333 ] As with paragraph styles, see
22334 \begin_inset CommandInset ref
22336 reference "subsec:Paragraph-Styles"
22344 \begin_layout Description
22345 \begin_inset Flex Code
22348 \begin_layout Plain Layout
22355 \begin_inset Flex Code
22358 \begin_layout Plain Layout
22367 \begin_inset space \thinspace{}
22371 \begin_inset Flex Code
22374 \begin_layout Plain Layout
22380 ] As with paragraph styles, see
22381 \begin_inset CommandInset ref
22383 reference "subsec:Paragraph-Styles"
22391 \begin_layout Description
22392 \begin_inset Flex Code
22395 \begin_layout Plain Layout
22401 As with paragraph styles, see
22402 \begin_inset CommandInset ref
22404 reference "subsec:Paragraph-Styles"
22411 \begin_layout Description
22412 \begin_inset Flex Code
22415 \begin_layout Plain Layout
22422 \begin_inset Flex Code
22425 \begin_layout Plain Layout
22431 ] The prefix to use when creating labels referring to insets of this type.
22432 This allows the use of formatted references.
22435 \begin_layout Description
22436 \begin_inset Flex Code
22439 \begin_layout Plain Layout
22446 \begin_inset Flex Code
22449 \begin_layout Plain Layout
22455 ] As with paragraph styles, see
22456 \begin_inset CommandInset ref
22458 reference "subsec:Paragraph-Styles"
22465 \begin_layout Description
22466 \begin_inset Flex Code
22469 \begin_layout Plain Layout
22476 \begin_inset Flex Code
22479 \begin_layout Plain Layout
22488 \begin_inset space \thinspace{}
22492 \begin_inset Flex Code
22495 \begin_layout Plain Layout
22501 ] Resets the \SpecialChar LaTeX
22502 arguments of this layout (as defined via the
22503 \begin_inset Flex Code
22506 \begin_layout Plain Layout
22513 This is useful if you have copied a style via
22514 \begin_inset Flex Code
22517 \begin_layout Plain Layout
22523 , but you do not want to inherit its (required and optional) arguments.
22526 \begin_layout Description
22527 \begin_inset Flex Code
22530 \begin_layout Plain Layout
22537 \begin_inset Flex Code
22540 \begin_layout Plain Layout
22549 \begin_inset space \thinspace{}
22553 \begin_inset Flex Code
22556 \begin_layout Plain Layout
22563 \change_inserted -712698321 1597733473
22565 \begin_inset Flex Code
22568 \begin_layout Plain Layout
22570 \change_inserted -712698321 1597732178
22578 , font changes are redone inside the respective inset (in the output) even
22579 if the inset itself is in the context of this font changes (e.
22580 \begin_inset space \thinspace{}
22584 \begin_inset Flex Code
22587 \begin_layout Plain Layout
22589 \change_inserted -712698321 1597733683
22592 textbf{Sourrounding text
22596 textbf{content}}\SpecialChar ldots
22605 \begin_inset Flex Code
22608 \begin_layout Plain Layout
22610 \change_inserted -712698321 1597733686
22613 textbf{Sourrounding text
22615 myinset{content}\SpecialChar ldots
22624 Setting this makes sense for commands that internally reset font settings
22626 \begin_inset space \thinspace{}
22630 Note that wrongly setting this might lead to unwanted result (e.
22631 \begin_inset space \thinspace{}
22635 \begin_inset Flex Code
22638 \begin_layout Plain Layout
22640 \change_inserted -712698321 1597733688
22643 emph{Sourrounding text
22647 emph{content}}\SpecialChar ldots
22655 , content is upright, as
22656 \begin_inset Flex Code
22659 \begin_layout Plain Layout
22661 \change_inserted -712698321 1597733278
22673 \change_deleted -712698321 1597733283
22674 Whether this inset should use the font of its surrounding environment or
22679 \change_deleted -712698321 1597733290
22681 \change_inserted -712698321 1597733290
22683 \begin_inset Flex Code
22686 \begin_layout Plain Layout
22688 \change_inserted -712698321 1597733292
22699 \change_deleted -712698321 1597733327
22700 use the font of the surrounding environment
22701 \change_inserted -712698321 1597733343
22702 font changes are not redone inside the inset
22707 \begin_layout Description
22708 \begin_inset Flex Code
22711 \begin_layout Plain Layout
22718 \begin_inset Flex Code
22721 \begin_layout Plain Layout
22727 ] A string that is put at the end of the layout content.
22728 A line break in the output can be indicated by
22729 \begin_inset Flex Code
22732 \begin_layout Plain Layout
22741 \begin_layout Description
22742 \begin_inset Flex Code
22745 \begin_layout Plain Layout
22752 \begin_inset Flex Code
22755 \begin_layout Plain Layout
22762 \begin_inset space \thinspace{}
22766 \begin_inset Flex Code
22769 \begin_layout Plain Layout
22777 ] Allow spell-checking the contents of this inset.
22779 \change_inserted -584632292 1615846659
22783 \begin_layout Subsection
22785 \change_inserted -584632292 1615846729
22787 \begin_inset CommandInset label
22789 name "subsec:Arguments"
22796 \begin_layout Standard
22798 \change_inserted -584632292 1615846807
22799 Both paragraph styles and inset layouts allow for
22803 as well as the main content.
22804 This is especially useful for things like section headings and only makes
22805 sense with \SpecialChar LaTeX
22807 Each (optional or required) argument of a command or environment—except
22808 for the required argument that is associated with the content—has a separate
22809 definition, where the number specifies the order of the arguments.
22810 The definition must end with
22811 \begin_inset Flex Code
22814 \begin_layout Plain Layout
22816 \change_inserted -584632292 1615846730
22825 So a command with two optional arguments looks like:
22828 \begin_layout Quote
22830 \change_inserted -584632292 1615846730
22836 \begin_layout Quote
22838 \change_inserted -584632292 1615846730
22844 \begin_layout Quote
22846 \change_inserted -584632292 1615846730
22852 \begin_layout Quote
22854 \change_inserted -584632292 1615846730
22860 \begin_layout Quote
22862 \change_inserted -584632292 1615846730
22868 \begin_layout Quote
22870 \change_inserted -584632292 1615846730
22876 \begin_layout Standard
22878 \change_inserted -584632292 1615846730
22880 \begin_inset Flex Code
22883 \begin_layout Plain Layout
22885 \change_inserted -584632292 1615846730
22893 definition, the following specifications are possible:
22896 \begin_layout Itemize
22898 \change_inserted -584632292 1615846730
22899 \begin_inset Flex Code
22902 \begin_layout Plain Layout
22904 \change_inserted -584632292 1615846730
22913 \begin_inset Flex Code
22916 \begin_layout Plain Layout
22918 \change_inserted -584632292 1615846730
22926 The string that will appear both in the menu (to insert this argument)
22927 and on the argument inset button (unless you also specify a separate
22928 \begin_inset Flex Code
22931 \begin_layout Plain Layout
22933 \change_inserted -584632292 1615846730
22942 For the menu, you can define an accelerator by appending the respective
22943 character to the string, divided by
22944 \begin_inset Quotes eld
22948 \begin_inset Quotes erd
22952 \begin_inset space \thinspace{}
22956 \begin_inset space \space{}
22960 \begin_inset Quotes eld
22964 \begin_inset Flex Code
22967 \begin_layout Plain Layout
22969 \change_inserted -584632292 1615846730
22978 \begin_inset Quotes erd
22984 \begin_layout Itemize
22986 \change_inserted -584632292 1615846730
22987 \begin_inset Flex Code
22990 \begin_layout Plain Layout
22992 \change_inserted -584632292 1615846730
23001 \begin_inset Flex Code
23004 \begin_layout Plain Layout
23006 \change_inserted -584632292 1615846730
23014 A separate string for the menu.
23015 You can define an accelerator by appending the respective character to
23016 the string, divided by
23017 \begin_inset Quotes eld
23021 \begin_inset Quotes erd
23025 \begin_inset space \thinspace{}
23029 \begin_inset space \space{}
23033 \begin_inset Quotes eld
23037 \begin_inset Flex Code
23040 \begin_layout Plain Layout
23042 \change_inserted -584632292 1615846730
23051 \begin_inset Quotes erd
23055 This specification is optional.
23056 If it is not given the
23057 \begin_inset Flex Code
23060 \begin_layout Plain Layout
23062 \change_inserted -584632292 1615846730
23070 will be used instead for the menu.
23073 \begin_layout Itemize
23075 \change_inserted -584632292 1615846730
23076 \begin_inset Flex Code
23079 \begin_layout Plain Layout
23081 \change_inserted -584632292 1615846730
23090 \begin_inset Flex Code
23093 \begin_layout Plain Layout
23095 \change_inserted -584632292 1615846730
23103 A longer explanatory text that appears in the tooltip when hovering over
23104 the argument inset.
23107 \begin_layout Itemize
23109 \change_inserted -584632292 1615846730
23110 \begin_inset Flex Code
23113 \begin_layout Plain Layout
23115 \change_inserted -584632292 1615846730
23124 \begin_inset Flex Code
23127 \begin_layout Plain Layout
23129 \change_inserted -584632292 1615846730
23140 \begin_inset space \thinspace{}
23144 \begin_inset Flex Code
23147 \begin_layout Plain Layout
23149 \change_inserted -584632292 1615846730
23157 ] Declare if this is a mandatory (1) or an optional (0) argument.
23158 Mandatory arguments will be output empty if not given, while optional arguments
23159 will not be output at all.
23160 By default, mandatory arguments are delimited by
23161 \begin_inset Flex Code
23164 \begin_layout Plain Layout
23166 \change_inserted -584632292 1615846730
23174 , while optional arguments are delimited by
23175 \begin_inset Flex Code
23178 \begin_layout Plain Layout
23180 \change_inserted -584632292 1615846730
23191 \begin_layout Itemize
23193 \change_inserted -584632292 1615846730
23194 \begin_inset Flex Code
23197 \begin_layout Plain Layout
23199 \change_inserted -584632292 1615846730
23208 \begin_inset Flex Code
23211 \begin_layout Plain Layout
23213 \change_inserted -584632292 1615846730
23221 Option to define a different command (from the default
23222 \begin_inset Flex Code
23225 \begin_layout Plain Layout
23227 \change_inserted -584632292 1615846730
23239 ) to be used for line breaks.
23240 The initial backslash must not be specified.
23243 \begin_layout Itemize
23245 \change_inserted -584632292 1615846730
23246 \begin_inset Flex Code
23249 \begin_layout Plain Layout
23251 \change_inserted -584632292 1615846730
23260 \begin_inset Flex Code
23263 \begin_layout Plain Layout
23265 \change_inserted -584632292 1615846730
23273 defines another argument (by its number) which this argument requires to
23274 be output if it is itself output.
23276 \begin_inset space \thinspace{}
23279 g., in \SpecialChar LaTeX
23280 commands, optional arguments often require previous optional arguments
23281 to be output (at least empty), as in
23282 \begin_inset Flex Code
23285 \begin_layout Plain Layout
23287 \change_inserted -584632292 1615846730
23290 command[][argument]{text}
23298 This can be achieved by the statement
23299 \begin_inset Flex Code
23302 \begin_layout Plain Layout
23304 \change_inserted -584632292 1615846730
23313 \begin_inset Flex Code
23316 \begin_layout Plain Layout
23318 \change_inserted -584632292 1615846730
23329 \begin_layout Itemize
23331 \change_inserted -584632292 1615846730
23332 \begin_inset Flex Code
23335 \begin_layout Plain Layout
23337 \change_inserted -584632292 1615846730
23346 \begin_inset Flex Code
23349 \begin_layout Plain Layout
23351 \change_inserted -584632292 1615846730
23359 defines a custom left delimiter (instead of
23360 \begin_inset Flex Code
23363 \begin_layout Plain Layout
23365 \change_inserted -584632292 1615846730
23374 \begin_inset Flex Code
23377 \begin_layout Plain Layout
23379 \change_inserted -584632292 1615846730
23388 A line break in the output can be indicated by
23389 \begin_inset Flex Code
23392 \begin_layout Plain Layout
23394 \change_inserted -584632292 1615846730
23405 \begin_layout Itemize
23407 \change_inserted -584632292 1615846730
23408 \begin_inset Flex Code
23411 \begin_layout Plain Layout
23413 \change_inserted -584632292 1615846730
23422 \begin_inset Flex Code
23425 \begin_layout Plain Layout
23427 \change_inserted -584632292 1615846730
23435 defines a custom right delimiter (instead of
23436 \begin_inset Flex Code
23439 \begin_layout Plain Layout
23441 \change_inserted -584632292 1615846730
23450 \begin_inset Flex Code
23453 \begin_layout Plain Layout
23455 \change_inserted -584632292 1615846730
23464 A line break in the output can be indicated by
23465 \begin_inset Flex Code
23468 \begin_layout Plain Layout
23470 \change_inserted -584632292 1615846730
23481 \begin_layout Itemize
23483 \change_inserted -584632292 1615846730
23484 \begin_inset Flex Code
23487 \begin_layout Plain Layout
23489 \change_inserted -584632292 1615846730
23498 \begin_inset Flex Code
23501 \begin_layout Plain Layout
23503 \change_inserted -584632292 1615846730
23511 defines an argument that is inserted if and only if no user-specified arguments
23513 \begin_inset space \thinspace{}
23517 \begin_inset space \space{}
23520 if no argument inset has been inserted (note that also an empty argument
23521 inset omits the DefaultArg).
23522 Multiple arguments need to be separated by comma.
23525 \begin_layout Itemize
23527 \change_inserted -584632292 1615846730
23528 \begin_inset Flex Code
23531 \begin_layout Plain Layout
23533 \change_inserted -584632292 1615846730
23542 \begin_inset Flex Code
23545 \begin_layout Plain Layout
23547 \change_inserted -584632292 1615846730
23555 defines an argument that is inserted in any case (alone or in addition
23556 to user-specified arguments).
23557 Multiple arguments need to be separated by comma.
23560 \begin_layout Itemize
23562 \change_inserted -584632292 1615846730
23563 \begin_inset Flex Code
23566 \begin_layout Plain Layout
23568 \change_inserted -584632292 1615846730
23576 The font used for the argument content, see
23577 \begin_inset CommandInset ref
23579 reference "subsec:Font-description"
23586 \begin_layout Itemize
23588 \change_inserted -584632292 1615846730
23589 \begin_inset Flex Code
23592 \begin_layout Plain Layout
23594 \change_inserted -584632292 1615846730
23603 \begin_inset Flex Code
23606 \begin_layout Plain Layout
23608 \change_inserted -584632292 1615846730
23619 \begin_inset space \thinspace{}
23623 \begin_inset Flex Code
23626 \begin_layout Plain Layout
23628 \change_inserted -584632292 1615846730
23636 ] As with paragraph styles, see
23637 \begin_inset CommandInset ref
23639 reference "subsec:Paragraph-Styles"
23646 \begin_layout Itemize
23648 \change_inserted -584632292 1615846730
23649 \begin_inset Flex Code
23652 \begin_layout Plain Layout
23654 \change_inserted -584632292 1615846730
23662 The font used for the label; see
23663 \begin_inset CommandInset ref
23665 reference "subsec:Font-description"
23672 \begin_layout Itemize
23674 \change_inserted -584632292 1615846730
23675 \begin_inset Flex Code
23678 \begin_layout Plain Layout
23680 \change_inserted -584632292 1615846730
23689 \begin_inset Flex Code
23692 \begin_layout Plain Layout
23694 \change_inserted -584632292 1615846730
23699 , Minimalistic, Conglomerate
23706 ] describes the rendering style used for the inset's frame and buttons.
23709 \begin_layout Itemize
23711 \change_inserted -584632292 1615846730
23712 \begin_inset Flex Code
23715 \begin_layout Plain Layout
23717 \change_inserted -584632292 1615846730
23726 \begin_inset Flex Code
23729 \begin_layout Plain Layout
23731 \change_inserted -584632292 1615846730
23740 \begin_inset Flex Code
23743 \begin_layout Plain Layout
23745 \change_inserted -584632292 1615846730
23753 , this argument is automatically inserted when the respective style is selected.
23756 \begin_layout Itemize
23758 \change_inserted -584632292 1615846730
23759 \begin_inset Flex Code
23762 \begin_layout Plain Layout
23764 \change_inserted -584632292 1615846730
23773 \begin_inset Flex Code
23776 \begin_layout Plain Layout
23778 \change_inserted -584632292 1615846730
23787 \begin_inset Flex Code
23790 \begin_layout Plain Layout
23792 \change_inserted -584632292 1615846730
23800 , this argument will be inserted on a new line with
23801 \begin_inset Flex Code
23804 \begin_layout Plain Layout
23806 \change_inserted -584632292 1615846730
23814 (only available within Flex insets).
23817 \begin_layout Itemize
23819 \change_inserted -584632292 1615846730
23820 \begin_inset Flex Code
23823 \begin_layout Plain Layout
23825 \change_inserted -584632292 1615846730
23834 \begin_inset Flex Code
23837 \begin_layout Plain Layout
23839 \change_inserted -584632292 1615846730
23848 \begin_inset Flex Code
23851 \begin_layout Plain Layout
23853 \change_inserted -584632292 1615846730
23861 , this argument will be inserted with a copy of the co-text (either selected
23862 text or the whole paragraph) as content.
23865 \begin_layout Itemize
23867 \change_inserted -584632292 1615846730
23868 \begin_inset Flex Code
23871 \begin_layout Plain Layout
23873 \change_inserted -584632292 1615846730
23882 \begin_inset Flex Code
23885 \begin_layout Plain Layout
23887 \change_inserted -584632292 1615846730
23899 ] Whether the contents of this argument should be output in raw form, meaning
23900 without special translations that \SpecialChar LaTeX
23903 \begin_inset Flex Code
23906 \begin_layout Plain Layout
23908 \change_inserted -584632292 1615846730
23916 status is inherited by the inset or paragraph layout the argument belongs
23917 to, true and false change the status for the given argument only.
23920 \begin_layout Itemize
23922 \change_inserted -584632292 1615846730
23923 \begin_inset Flex Code
23926 \begin_layout Plain Layout
23928 \change_inserted -584632292 1615846730
23937 \begin_inset Flex Code
23940 \begin_layout Plain Layout
23942 \change_inserted -584632292 1615846730
23943 string of characters
23954 Defines individual characters
23955 \begin_inset Newline linebreak
23958 that should be output in raw form, meaning without special translations
23959 that \SpecialChar LaTeX
23961 Note that, contrary to PassThru, this needs to be explicitly defined for
23963 That is, arguments do not inherit PassThruChars from their parent inset
23967 \begin_layout Itemize
23969 \change_inserted -584632292 1615846730
23970 \begin_inset Flex Code
23973 \begin_layout Plain Layout
23975 \change_inserted -584632292 1615846730
23984 \begin_inset Flex Code
23987 \begin_layout Plain Layout
23989 \change_inserted -584632292 1615846730
24000 \begin_inset space \thinspace{}
24004 \begin_inset Flex Code
24007 \begin_layout Plain Layout
24009 \change_inserted -584632292 1615846730
24017 ] If this is set to 1, the argument will output its content in the corresponding
24018 item in the table of contents.
24022 \begin_layout Standard
24024 \change_inserted -584632292 1615846730
24025 By default, the text entered in the \SpecialChar LyX
24026 workarea in the respective layout is
24027 the last (mandatory) argument of a command if the
24028 \begin_inset Flex Code
24031 \begin_layout Plain Layout
24033 \change_inserted -584632292 1615846730
24042 \begin_inset Flex Code
24045 \begin_layout Plain Layout
24047 \change_inserted -584632292 1615846730
24056 However, arguments with the prefix
24057 \begin_inset Flex Code
24060 \begin_layout Plain Layout
24062 \change_inserted -584632292 1615846730
24070 are output after this workarea argument.
24071 Note that post-argument numbering restarts at 1, so the first argument
24072 following the workarea argument is
24073 \begin_inset Flex Code
24076 \begin_layout Plain Layout
24078 \change_inserted -584632292 1615846730
24087 Post-arguments are ignored in any other
24088 \begin_inset Flex Code
24091 \begin_layout Plain Layout
24093 \change_inserted -584632292 1615846730
24102 \begin_inset Flex Code
24105 \begin_layout Plain Layout
24107 \change_inserted -584632292 1615846730
24118 \begin_layout Standard
24120 \change_inserted -584632292 1615846730
24122 \begin_inset Flex Code
24125 \begin_layout Plain Layout
24127 \change_inserted -584632292 1615846730
24138 \begin_inset Flex Code
24141 \begin_layout Plain Layout
24143 \change_inserted -584632292 1615846730
24154 \begin_inset Flex Code
24157 \begin_layout Plain Layout
24159 \change_inserted -584632292 1615846730
24167 followed by the number (e.
24168 \begin_inset space \thinspace{}
24172 \begin_inset space \space{}
24176 \begin_inset Flex Code
24179 \begin_layout Plain Layout
24181 \change_inserted -584632292 1615846730
24192 \begin_layout Standard
24194 \change_inserted -584632292 1615846730
24195 Finally, there is a special argument type with the prefix
24196 \begin_inset Flex Code
24199 \begin_layout Plain Layout
24201 \change_inserted -584632292 1615846730
24210 It is not really an argument, but uses the argument interface (thus, the
24211 prefix is also followed by a number, e.
24212 \begin_inset space \thinspace{}
24217 \begin_inset Flex Code
24220 \begin_layout Plain Layout
24222 \change_inserted -584632292 1615846730
24223 Argument listpreamble:1
24231 As the name implies, it is targeted at lists such as
24248 Its content will be output at the list start, before the first
24249 \begin_inset Flex Code
24252 \begin_layout Plain Layout
24254 \change_inserted -584632292 1615846730
24264 , on an own line (a place that is otherwise not accessible in \SpecialChar LyX
24266 This way, users can insert redefinitions (of lengths etc.) to individual
24268 By default, these arguments do not have a delimiter.
24273 \begin_layout Subsection
24275 \begin_inset CommandInset label
24277 name "subsec:Counters"
24284 \begin_layout Standard
24285 It is necessary to define the counters (
24286 \begin_inset Flex Noun
24289 \begin_layout Plain Layout
24296 \begin_inset Flex Noun
24299 \begin_layout Plain Layout
24305 , \SpecialChar ldots
24306 ) in the text class itself.
24307 The standard counters are defined in the file
24308 \begin_inset Flex Code
24311 \begin_layout Plain Layout
24317 , so you may have to do no more than add
24320 \begin_layout LyX-Code
24321 Input stdcounters.inc
24324 \begin_layout Standard
24325 to your layout file to get them to work.
24326 But if you want to define custom counters, then you can do so.
24327 The counter declaration must begin with:
24330 \begin_layout LyX-Code
24331 Counter CounterName
24334 \begin_layout Standard
24336 \begin_inset Flex Code
24339 \begin_layout Plain Layout
24345 ' is replaced by the name of the counter.
24346 And it must end with
24347 \begin_inset Quotes eld
24351 \begin_inset Flex Code
24354 \begin_layout Plain Layout
24361 \begin_inset Quotes erd
24365 The following parameters can also be used:
24368 \begin_layout Description
24369 \begin_inset Flex Code
24372 \begin_layout Plain Layout
24379 \begin_inset Flex Code
24382 \begin_layout Plain Layout
24388 ] Sets the initial value for the counter, to which it will be reset whenever
24390 Normally, one will want the default, 1.
24393 \begin_layout Description
24394 \begin_inset Flex Code
24397 \begin_layout Plain Layout
24404 \begin_inset Flex Code
24407 \begin_layout Plain Layout
24414 \begin_inset Quotes erd
24418 \begin_inset Quotes erd
24421 ] When defined, this string defines how the counter is displayed.
24422 Setting this value sets
24423 \begin_inset Flex Code
24426 \begin_layout Plain Layout
24427 LabelStringAppendix
24433 The following special constructs can be used in the string:
24437 \begin_layout Itemize
24438 \begin_inset Flex Code
24441 \begin_layout Plain Layout
24449 will be replaced by the expansion of the
24450 \begin_inset Flex Code
24453 \begin_layout Plain Layout
24460 \begin_inset Flex Code
24463 \begin_layout Plain Layout
24464 LabelStringAppendix
24470 \begin_inset Flex Code
24473 \begin_layout Plain Layout
24483 \begin_layout Itemize
24484 counter values can be expressed using \SpecialChar LaTeX
24486 \begin_inset Newline newline
24490 \begin_inset Flex Code
24493 \begin_layout Plain Layout
24510 \begin_inset Flex Code
24513 \begin_layout Plain Layout
24525 \begin_layout Plain Layout
24535 Actually, the situation is a bit more complicated: any
24554 other than those described below will produce arabic numerals.
24555 It would not be surprising to see this change in the future.
24561 \begin_inset Flex Code
24564 \begin_layout Plain Layout
24570 : 1, 2, 3,\SpecialChar ldots
24572 \begin_inset Flex Code
24575 \begin_layout Plain Layout
24581 for lower-case letters: a, b, c, \SpecialChar ldots
24583 \begin_inset Flex Code
24586 \begin_layout Plain Layout
24592 for upper-case letters: A, B, C, \SpecialChar ldots
24594 \begin_inset Flex Code
24597 \begin_layout Plain Layout
24603 for lower-case roman numerals: i, ii, iii, \SpecialChar ldots
24605 \begin_inset Flex Code
24608 \begin_layout Plain Layout
24614 for upper-case roman numerals: I, II, III\SpecialChar ldots
24616 \begin_inset Flex Code
24619 \begin_layout Plain Layout
24625 for hebrew numerals.
24629 \begin_layout Standard
24630 If LabelString is not defined, a default value is constructed as follows:
24631 if the counter has a
24632 \change_deleted 731793113 1604355218
24634 \change_inserted 731793113 1604355221
24638 \begin_inset Flex Code
24641 \begin_layout Plain Layout
24643 \change_deleted 731793113 1604355223
24645 \change_inserted 731793113 1604355226
24654 \begin_inset Flex Code
24657 \begin_layout Plain Layout
24664 \begin_inset Newline newline
24668 \begin_inset Flex Code
24671 \begin_layout Plain Layout
24675 \change_inserted 731793113 1604355228
24677 \change_deleted 731793113 1604355230
24687 is used; otherwise the string
24688 \begin_inset Flex Code
24691 \begin_layout Plain Layout
24702 \begin_layout Description
24703 \begin_inset Flex Code
24706 \begin_layout Plain Layout
24707 LabelStringAppendix
24713 \begin_inset Flex Code
24716 \begin_layout Plain Layout
24723 \begin_inset Quotes eld
24727 \begin_inset Quotes erd
24731 \begin_inset Flex Code
24734 \begin_layout Plain Layout
24740 , but for use in the Appendix.
24741 \change_inserted -584632292 1607202551
24745 \begin_layout Description
24747 \change_inserted -584632292 1607202682
24748 \begin_inset Flex Code
24751 \begin_layout Plain Layout
24758 \begin_inset Flex Code
24761 \begin_layout Plain Layout
24763 \change_inserted -584632292 1607202576
24772 \begin_inset Quotes eld
24776 \begin_inset Quotes erd
24779 ] The counter name as used in \SpecialChar LaTeX
24781 (E.g., in \SpecialChar LyX
24782 , there is a counter named `theorem', but it is output to \SpecialChar LaTeX
24788 \begin_layout Description
24789 \begin_inset Flex Code
24792 \begin_layout Plain Layout
24799 \begin_inset Flex Code
24802 \begin_layout Plain Layout
24809 \begin_inset Quotes erd
24813 \begin_inset Quotes erd
24816 ] A format for use with formatted references to this counter.
24817 For example, one might want to have references to section numbers appear
24819 \begin_inset Quotes eld
24823 \begin_inset Quotes erd
24827 The string should contain
24828 \begin_inset Quotes eld
24832 \begin_inset Quotes erd
24836 This will be replaced by the counter number itself.
24837 So, for sections, it would be: Section ##.
24840 \begin_layout Description
24841 \begin_inset Flex Code
24844 \begin_layout Plain Layout
24851 \begin_inset Flex Code
24854 \begin_layout Plain Layout
24861 \begin_inset Quotes erd
24865 \begin_inset Quotes erd
24868 ] If this is set to the name of another counter, the present counter will
24869 be reset every time the other one is increased.
24871 \begin_inset Flex Code
24874 \begin_layout Plain Layout
24881 \begin_inset Flex Code
24884 \begin_layout Plain Layout
24893 \begin_layout Subsection
24895 \begin_inset CommandInset label
24897 name "subsec:Font-description"
24904 \begin_layout Standard
24905 A font description looks like this:
24908 \begin_layout LyX-Code
24925 \begin_layout LyX-Code
24929 \begin_layout LyX-Code
24933 \begin_layout Standard
24934 The following commands are available:
24937 \begin_layout Description
24938 \begin_inset Flex Code
24941 \begin_layout Plain Layout
24948 \change_deleted -712698321 1607682984
24950 \begin_inset Flex Code
24953 \begin_layout Plain Layout
24962 \begin_inset Flex Code
24965 \begin_layout Plain Layout
24972 \begin_inset Flex Code
24975 \begin_layout Plain Layout
24982 \begin_inset Flex Code
24985 \begin_layout Plain Layout
24992 \begin_inset Flex Code
24995 \begin_layout Plain Layout
25002 \begin_inset Flex Code
25005 \begin_layout Plain Layout
25012 \begin_inset Flex Code
25015 \begin_layout Plain Layout
25022 \begin_inset Flex Code
25025 \begin_layout Plain Layout
25032 \begin_inset Flex Code
25035 \begin_layout Plain Layout
25042 \begin_inset Flex Code
25045 \begin_layout Plain Layout
25052 \begin_inset Flex Code
25055 \begin_layout Plain Layout
25062 \begin_inset Flex Code
25065 \begin_layout Plain Layout
25072 \begin_inset Flex Code
25075 \begin_layout Plain Layout
25082 \begin_inset Flex Code
25085 \begin_layout Plain Layout
25092 \begin_inset Flex Code
25095 \begin_layout Plain Layout
25102 \begin_inset Flex Code
25105 \begin_layout Plain Layout
25112 \begin_inset Flex Code
25115 \begin_layout Plain Layout
25122 \begin_inset Flex Code
25125 \begin_layout Plain Layout
25132 \begin_inset Flex Code
25135 \begin_layout Plain Layout
25142 \begin_inset Flex Code
25145 \begin_layout Plain Layout
25152 \change_inserted -712698321 1607683139
25154 \begin_inset Flex Code
25157 \begin_layout Plain Layout
25159 \change_inserted -712698321 1607683135
25168 \begin_inset space ~
25172 \begin_inset CommandInset ref
25174 reference "chap:Names-of-colors"
25182 \change_deleted -712698321 1607683144
25184 \change_inserted -712698321 1607683146
25190 \begin_layout Description
25191 \begin_inset Flex Code
25194 \begin_layout Plain Layout
25201 \begin_inset Flex Code
25204 \begin_layout Plain Layout
25213 \begin_inset Flex Code
25216 \begin_layout Plain Layout
25223 \begin_inset Flex Code
25226 \begin_layout Plain Layout
25235 \begin_layout Description
25236 \begin_inset Flex Code
25239 \begin_layout Plain Layout
25246 \begin_inset Flex Code
25249 \begin_layout Plain Layout
25255 ] Valid arguments are:
25256 \begin_inset Flex Code
25259 \begin_layout Plain Layout
25266 \begin_inset Flex Code
25269 \begin_layout Plain Layout
25276 \begin_inset Flex Code
25279 \begin_layout Plain Layout
25286 \begin_inset Flex Code
25289 \begin_layout Plain Layout
25296 \begin_inset Flex Code
25299 \begin_layout Plain Layout
25306 \begin_inset Flex Code
25309 \begin_layout Plain Layout
25316 \begin_inset Flex Code
25319 \begin_layout Plain Layout
25326 \begin_inset Flex Code
25329 \begin_layout Plain Layout
25336 \begin_inset Flex Code
25339 \begin_layout Plain Layout
25346 \begin_inset Flex Code
25349 \begin_layout Plain Layout
25356 \begin_inset Flex Code
25359 \begin_layout Plain Layout
25366 \begin_inset Flex Code
25369 \begin_layout Plain Layout
25376 Each of these turns on or off the corresponding attribute.
25378 \begin_inset Flex Code
25381 \begin_layout Plain Layout
25387 turns on emphasis, and
25388 \begin_inset Flex Code
25391 \begin_layout Plain Layout
25399 \begin_inset Newline newline
25402 If the latter seems puzzling, remember that the font settings for the present
25403 context are generally inherited from the surrounding context.
25405 \begin_inset Flex Code
25408 \begin_layout Plain Layout
25414 would turn off the emphasis that was anyway in effect, say, in a theorem
25418 \begin_layout Description
25419 \begin_inset Flex Code
25422 \begin_layout Plain Layout
25429 \begin_inset Flex Code
25432 \begin_layout Plain Layout
25441 \begin_inset Flex Code
25444 \begin_layout Plain Layout
25453 \begin_layout Description
25454 \begin_inset Flex Code
25457 \begin_layout Plain Layout
25464 \begin_inset Flex Code
25467 \begin_layout Plain Layout
25476 \begin_inset Flex Code
25479 \begin_layout Plain Layout
25486 \begin_inset Flex Code
25489 \begin_layout Plain Layout
25496 \begin_inset Flex Code
25499 \begin_layout Plain Layout
25508 \begin_layout Description
25509 \begin_inset Flex Code
25512 \begin_layout Plain Layout
25519 \begin_inset Flex Code
25522 \begin_layout Plain Layout
25529 \begin_inset Flex Code
25532 \begin_layout Plain Layout
25539 \begin_inset Flex Code
25542 \begin_layout Plain Layout
25551 \begin_inset Flex Code
25554 \begin_layout Plain Layout
25561 \begin_inset Flex Code
25564 \begin_layout Plain Layout
25571 \begin_inset Flex Code
25574 \begin_layout Plain Layout
25581 \begin_inset Flex Code
25584 \begin_layout Plain Layout
25591 \begin_inset Flex Code
25594 \begin_layout Plain Layout
25603 \begin_layout Subsection
25604 \begin_inset CommandInset label
25606 name "subsec:Citation-engine-description"
25610 Cite engine description
25613 \begin_layout Standard
25615 \begin_inset Flex Code
25618 \begin_layout Plain Layout
25624 blocks, as used mainly in cite engine files (see
25625 \begin_inset CommandInset ref
25627 reference "subsec:Cite-Engine-Files"
25634 ), define the citation commands provided by a specific
25635 \begin_inset Quotes eld
25639 \begin_inset Quotes erd
25643 A cite engine, in \SpecialChar LyX
25644 terms, is way specific way to format citations, using
25645 numbers, author names and/or years.
25646 Currently, \SpecialChar LyX
25647 supports three such engine types, namely:
25650 \begin_layout Enumerate
25651 \begin_inset Flex Code
25654 \begin_layout Plain Layout
25660 : the default Bib\SpecialChar TeX
25661 way to format citations, a simple numeric style (e.
25662 \begin_inset space \thinspace{}
25666 \begin_inset Quotes eld
25670 \begin_inset Quotes erd
25676 \begin_layout Enumerate
25677 \begin_inset Flex Code
25680 \begin_layout Plain Layout
25686 : Harvard-styled citations using author names and publication year (e.
25687 \begin_inset space \thinspace{}
25691 \begin_inset Quotes eld
25694 Smith and Miller (2017b)
25695 \begin_inset Quotes erd
25701 \begin_layout Enumerate
25702 \begin_inset Flex Code
25705 \begin_layout Plain Layout
25711 : extended numerical citations that also allow for author or title next
25713 \begin_inset space \thinspace{}
25717 \begin_inset Quotes eld
25720 Smith and Miller [1]
25721 \begin_inset Quotes erd
25727 \begin_layout Standard
25728 \begin_inset Flex Code
25731 \begin_layout Plain Layout
25737 blocks look like this:
25740 \begin_layout LyX-Code
25744 \begin_layout LyX-Code
25748 \begin_layout LyX-Code
25752 \begin_layout LyX-Code
25753 citeyearpar[][]=parencite*
25756 \begin_layout LyX-Code
25760 \begin_layout LyX-Code
25764 \begin_layout Standard
25766 \begin_inset Flex Code
25769 \begin_layout Plain Layout
25775 denotes the engine.
25776 The individual lines respectively define a cite command or cite command
25777 paradigm supported by this engine.
25778 The line can be as simple as a cite command that is used both to name the
25779 respective \SpecialChar LyX
25780 command and the \SpecialChar LaTeX
25781 output or more complex in order to differentiate
25783 The full syntax is:
25786 \begin_layout LyX-Code
25787 LyXName|alias$*<!_stardesc!_stardesctooltip>[][]=latexcmd
25790 \begin_layout Itemize
25791 \begin_inset Flex Code
25794 \begin_layout Plain Layout
25800 : The name as used in the
25801 \begin_inset Flex Code
25804 \begin_layout Plain Layout
25814 \begin_layout Standard
25815 For portability reasons, we try to use the same name for same-formatted
25816 commands in different cite packages (thus many names stem from natbib,
25817 and thus we need to differentiate a
25818 \begin_inset Flex Code
25821 \begin_layout Plain Layout
25827 sometimes, if the \SpecialChar LaTeX
25828 command names differ).
25832 \begin_layout Itemize
25833 \begin_inset Flex Code
25836 \begin_layout Plain Layout
25842 : a (comma-separated) list of commands that fall back to the given
25843 \begin_inset Flex Code
25846 \begin_layout Plain Layout
25852 in the current engine.
25853 This eases the switch of citation packages and engines.
25855 \begin_inset Flex Code
25858 \begin_layout Plain Layout
25865 \begin_inset Flex Code
25868 \begin_layout Plain Layout
25874 in layout definitions.
25877 \begin_layout Itemize
25878 \begin_inset Flex Code
25881 \begin_layout Plain Layout
25887 : The actual \SpecialChar LaTeX
25888 command that is output.
25892 \begin_layout Standard
25893 \begin_inset Flex Code
25896 \begin_layout Plain Layout
25903 \begin_inset Flex Code
25906 \begin_layout Plain Layout
25914 \begin_inset Flex Code
25917 \begin_layout Plain Layout
25924 \begin_inset Flex Code
25927 \begin_layout Plain Layout
25933 will be output to \SpecialChar LaTeX
25937 \begin_layout Standard
25941 \begin_layout Itemize
25942 Capitalization indicates that the command also has a capitalized form (
25943 \begin_inset Flex Code
25946 \begin_layout Plain Layout
25956 \begin_inset Flex Code
25959 \begin_layout Plain Layout
25968 These usually enforce up-casing of name prefixes (
25973 \begin_inset Formula $\Rightarrow$
25983 \begin_layout Itemize
25985 \begin_inset Flex Code
25988 \begin_layout Plain Layout
25994 indicate the number of optional arguments (there can be 0–2).
25997 \begin_layout Itemize
25999 \begin_inset Flex Code
26002 \begin_layout Plain Layout
26008 indicates there is a starred version of the command (
26009 \begin_inset Flex Code
26012 \begin_layout Plain Layout
26022 \begin_inset Flex Code
26025 \begin_layout Plain Layout
26038 \begin_layout Standard
26039 By default, the starred version means: Output all authors even if it should
26041 \begin_inset Quotes eld
26045 \begin_inset Quotes erd
26049 \begin_inset Flex Code
26052 \begin_layout Plain Layout
26061 \begin_layout Standard
26062 If the star has a different meaning for a given command, it can be specified
26064 \begin_inset Flex Code
26067 \begin_layout Plain Layout
26068 <!_stardesc!_stardesctooltip>
26074 Maximal two translatable macro keywords, marked by the prefix
26075 \begin_inset Flex Code
26078 \begin_layout Plain Layout
26085 The first points to the string that replaces the
26086 \begin_inset Quotes eld
26090 \begin_inset Quotes erd
26093 checkbox label in the citation dialog, the second one to an optional tool
26094 tip for this checkbox.
26098 \begin_layout Standard
26099 Note that these two macros have to be defined in a
26100 \begin_inset Flex Code
26103 \begin_layout Plain Layout
26109 (see next section), dropping the
26110 \begin_inset Flex Code
26113 \begin_layout Plain Layout
26119 from the prefix, like this:
26122 \begin_layout LyX-Code
26123 _stardesc Sta&rred command label
26126 \begin_layout LyX-Code
26127 _stardesctooltip Tooltip for the starred command checkbox.
26131 \begin_layout Itemize
26133 \begin_inset Flex Code
26136 \begin_layout Plain Layout
26142 indicates that this command features
26143 \begin_inset Quotes eld
26146 qualified citation lists
26147 \begin_inset Quotes erd
26155 -specific feature for multi-reference citations where an individual pre-
26156 and postnote can be given to each reference in the list.
26157 Please refer to the
26161 manual for details.
26162 \change_inserted -712698321 1526898670
26166 \begin_layout Standard
26168 \change_inserted -712698321 1526899524
26169 If you want to add a cite command to a cite engine (e.
26170 \begin_inset space \thinspace{}
26173 g., add a specific command provided by a class), you can use
26174 \begin_inset Flex Code
26177 \begin_layout Plain Layout
26179 \change_inserted -712698321 1526898768
26180 AddToCiteEngine <engine type> \SpecialChar ldots
26189 Note that only cite commands that do not exist yet are added.
26194 \begin_layout Subsection
26195 \begin_inset CommandInset label
26197 name "subsec:Citation-format-description"
26201 Cite format description
26204 \begin_layout Standard
26206 \begin_inset Flex Code
26209 \begin_layout Plain Layout
26215 blocks are used to describe how bibliographic information should be displayed,
26216 both within \SpecialChar LyX
26217 itself (in the citation dialog and in tooltips, for example)
26218 and in XHTML output.
26219 Such a block might look like this:
26222 \begin_layout LyX-Code
26226 \begin_layout LyX-Code
26230 \begin_layout LyX-Code
26234 \begin_layout LyX-Code
26238 \begin_layout Standard
26242 \begin_layout LyX-Code
26246 \begin_layout LyX-Code
26250 \begin_layout LyX-Code
26254 \begin_layout LyX-Code
26258 \begin_layout Standard
26259 In the first case, the individual lines define how the bibliographic information
26260 associated with an article or book, respectively, is to be displayed, and
26261 such a definition can be given for any
26262 \begin_inset Quotes els
26266 \begin_inset Quotes ers
26269 that might be present in a Bib\SpecialChar TeX
26272 defines a default format in the source code that will be used if no specific
26273 definition has been given.
26275 predefines several formats in the file
26276 \begin_inset Flex Code
26279 \begin_layout Plain Layout
26285 , which is included in most of \SpecialChar LyX
26286 's document classes.
26289 \begin_layout Standard
26290 In the second case, the lines define how a specific citation command (in
26292 \begin_inset Flex Code
26295 \begin_layout Plain Layout
26304 \begin_inset Flex Code
26307 \begin_layout Plain Layout
26315 ) is to be displayed on the citation inset label, in the citation dialog,
26316 menu or XHTML output.
26318 defines such formats for the citation style variants it supports via
26320 Document\SpecialChar menuseparator
26321 Setting\SpecialChar menuseparator
26322 Bibliography\SpecialChar ldots
26326 \begin_inset Flex Code
26329 \begin_layout Plain Layout
26335 files that are shipped with \SpecialChar LyX
26337 \begin_inset CommandInset ref
26339 reference "subsec:Cite-Engine-Files"
26349 \begin_layout Standard
26350 The definitions use a simple language that allows Bib\SpecialChar TeX
26351 keys to be replaced
26353 Keys should be enclosed in
26354 \begin_inset Flex Code
26357 \begin_layout Plain Layout
26364 \begin_inset Flex Code
26367 \begin_layout Plain Layout
26374 So a simple definition might look like this:
26377 \begin_layout LyX-Code
26379 \begin_inset Quotes eld
26383 \begin_inset Quotes erd
26389 \begin_layout Standard
26390 This would print the author, followed by a comma, followed by the title,
26391 in quotes, followed by a period.
26394 \begin_layout Standard
26395 Of course, sometimes you may want to print a key only if it exists.
26396 This can be done by using a conditional construction, such as:
26397 \begin_inset Flex Code
26400 \begin_layout Plain Layout
26402 \begin_inset space ~
26412 \begin_inset Flex Code
26415 \begin_layout Plain Layout
26421 key exists, then print
26422 \begin_inset Quotes eld
26426 \begin_inset space ~
26430 \begin_inset Quotes erd
26433 followed by the volume key.
26434 It is also possible to have an else clause in the conditional, such as:
26435 \begin_inset Newline newline
26439 \begin_inset Flex Code
26442 \begin_layout Plain Layout
26443 {%author%[[%author%]][[%editor%, ed.]]}
26449 \begin_inset Newline newline
26453 \begin_inset Flex Code
26456 \begin_layout Plain Layout
26462 key is printed if it exists; otherwise, the editor key is printed, followed
26464 \begin_inset Quotes eld
26468 \begin_inset space ~
26472 \begin_inset Quotes erd
26475 Note that the key is again enclosed in
26476 \begin_inset Flex Code
26479 \begin_layout Plain Layout
26485 signs; the entire conditional is enclosed in braces; and the if and else
26486 clauses are enclosed in double brackets,
26487 \begin_inset Quotes eld
26491 \begin_inset Flex Code
26494 \begin_layout Plain Layout
26501 \begin_inset Quotes eld
26505 \begin_inset Quotes eld
26509 \begin_inset Flex Code
26512 \begin_layout Plain Layout
26519 \begin_inset Quotes erd
26523 There must be no space between any of these.
26526 \begin_layout Standard
26527 Next to the entry keys, there are some special keys that can be used for
26528 these conditionals:
26531 \begin_layout Itemize
26532 \begin_inset Flex Code
26535 \begin_layout Plain Layout
26536 {%dialog%[[true]][[false]]}
26542 \begin_inset Quotes eld
26546 \begin_inset Quotes erd
26549 part for dialogs and menus, the
26550 \begin_inset Quotes eld
26554 \begin_inset Quotes erd
26557 part for other contexts (workarea, export)
26560 \begin_layout Itemize
26561 \begin_inset Flex Code
26564 \begin_layout Plain Layout
26565 {%export%[[true]][[false]]}
26571 \begin_inset Quotes eld
26575 \begin_inset Quotes erd
26578 part for export and menus, the
26579 \begin_inset Quotes eld
26583 \begin_inset Quotes erd
26586 part for other contexts (workarea, dialog)
26589 \begin_layout Itemize
26590 \begin_inset Flex Code
26593 \begin_layout Plain Layout
26600 \begin_inset Quotes eld
26604 \begin_inset Quotes erd
26607 part if another item follows (e.
26608 \begin_inset space \thinspace{}
26611 g., in a citation with multiple keys)
26614 \begin_layout Itemize
26615 \begin_inset Flex Code
26618 \begin_layout Plain Layout
26619 {%second%[[true]][[false]]}
26625 \begin_inset Quotes eld
26629 \begin_inset Quotes erd
26632 if this is the second of multiple items, else the
26633 \begin_inset Quotes eld
26637 \begin_inset Quotes erd
26643 \begin_layout Itemize
26644 \begin_inset Flex Code
26647 \begin_layout Plain Layout
26648 {%ifstar%[[true]][[false]]}
26654 \begin_inset Quotes eld
26658 \begin_inset Quotes erd
26661 part for starred citation commands (such as
26662 \begin_inset Flex Code
26665 \begin_layout Plain Layout
26673 ), the false part for unstarred
26676 \begin_layout Itemize
26677 \begin_inset Flex Code
26680 \begin_layout Plain Layout
26681 {%ifentrytype:<type>%[[true]][[false]]}
26687 \begin_inset Quotes eld
26691 \begin_inset Quotes erd
26694 if the current entry type matches
26695 \begin_inset Flex Code
26698 \begin_layout Plain Layout
26704 , else the false part (e.g., in a citation definition:
26705 \begin_inset Flex Code
26708 \begin_layout Plain Layout
26709 {%ifentrytype:book%[[this is a book]][[this is no book]]}
26717 \begin_layout Itemize
26718 \begin_inset Flex Code
26721 \begin_layout Plain Layout
26722 {%ifmultiple:<authortype>%[[true]][[false]]}
26728 \begin_inset Quotes eld
26732 \begin_inset Quotes erd
26735 if the current author type (author, editor etc.) has multiple authors, else
26736 the false part (e.g., in a bibliography definition:
26737 \begin_inset Flex Code
26740 \begin_layout Plain Layout
26741 {%ifmultiple:editor%[[eds.]][[ed.]]}
26749 \begin_layout Itemize
26750 \begin_inset Flex Code
26753 \begin_layout Plain Layout
26754 {%ifqualified%[[true]][[false]]}
26760 \begin_inset Quotes eld
26764 \begin_inset Quotes erd
26767 part if the current citation is a qualified citation list (a specific
26771 format for multi-reference citations), the false part if this is not the
26775 \begin_layout Standard
26777 \begin_inset Flex Code
26780 \begin_layout Plain Layout
26786 prints the author key as it is recorded in the bibliography file.
26787 This might not be what you want, since it will result in a string such
26789 \begin_inset Quotes eld
26792 Miller, Peter and Smith, Mary and White, Jane
26793 \begin_inset Quotes erd
26797 \begin_inset Quotes eld
26801 \begin_inset Quotes erd
26804 is used by Bib\SpecialChar TeX
26805 to delimit authors).
26807 therefore provides some methods to get properly formatted name lists (which
26808 will also get translated).
26809 The following keys are provided:
26812 \begin_layout Enumerate
26813 For name lists with pre- and surname, suitable for the main authors/editors
26814 of a bibliography item.
26816 \begin_inset Flex Code
26819 \begin_layout Plain Layout
26825 part denotes the kind of list that is requested (e.g.
26827 \begin_inset Flex Code
26830 \begin_layout Plain Layout
26840 \begin_layout Itemize
26841 \begin_inset Flex Code
26844 \begin_layout Plain Layout
26845 %abbrvnames:<nametype>%
26850 : Provides a name list which is abbreviated (with
26851 \begin_inset Quotes eld
26855 \begin_inset Quotes erd
26859 \begin_inset Flex Code
26862 \begin_layout Plain Layout
26871 \begin_layout Itemize
26872 \begin_inset Flex Code
26875 \begin_layout Plain Layout
26876 %fullnames:<nametype>%
26881 : Provides a full name list (never abbreviated with
26882 \begin_inset Quotes eld
26886 \begin_inset Quotes erd
26892 \begin_layout Itemize
26893 \begin_inset Flex Code
26896 \begin_layout Plain Layout
26897 %forceabbrvnames:<nametype>%
26902 : Provides a name list which is always abbreviated (with
26903 \begin_inset Quotes eld
26907 \begin_inset Quotes erd
26911 \begin_inset Flex Code
26914 \begin_layout Plain Layout
26924 \begin_layout Enumerate
26925 Alternative name lists with pre- and surname, if the order of pre- and surname
26926 inside the bibliography item differs (as in:
26927 \begin_inset Quotes eld
26930 Miller, John: Some text, in: Mary Smith, ed.: A volume
26931 \begin_inset Quotes erd
26938 \begin_layout Itemize
26939 \begin_inset Flex Code
26942 \begin_layout Plain Layout
26943 %abbrvbynames:<nametype>%
26948 : Provides a name list which is abbreviated (with
26949 \begin_inset Quotes eld
26953 \begin_inset Quotes erd
26957 \begin_inset Flex Code
26960 \begin_layout Plain Layout
26969 \begin_layout Itemize
26970 \begin_inset Flex Code
26973 \begin_layout Plain Layout
26974 %fullbynames:<nametype>%
26979 : Provides a full name list (never abbreviated with
26980 \begin_inset Quotes eld
26984 \begin_inset Quotes erd
26990 \begin_layout Itemize
26991 \begin_inset Flex Code
26994 \begin_layout Plain Layout
26995 %forceabbrvbynames:<nametype>%
27000 : Provides a name list which is always abbreviated (with
27001 \begin_inset Quotes eld
27005 \begin_inset Quotes erd
27009 \begin_inset Flex Code
27012 \begin_layout Plain Layout
27022 \begin_layout Enumerate
27023 And finally name lists which consist of family names only, as used in author-yea
27025 These do not take a
27026 \begin_inset Flex Code
27029 \begin_layout Plain Layout
27035 part, but always return either an author list or, if this does not exist,
27036 an editor list (as common in author-year labels):
27040 \begin_layout Itemize
27041 \begin_inset Flex Code
27044 \begin_layout Plain Layout
27050 : Provides a name list which is abbreviated (with
27051 \begin_inset Quotes eld
27055 \begin_inset Quotes erd
27059 \begin_inset Flex Code
27062 \begin_layout Plain Layout
27071 \begin_layout Itemize
27072 \begin_inset Flex Code
27075 \begin_layout Plain Layout
27081 : Provides a full name list (never abbreviated with
27082 \begin_inset Quotes eld
27086 \begin_inset Quotes erd
27092 \begin_layout Itemize
27093 \begin_inset Flex Code
27096 \begin_layout Plain Layout
27097 %forceabbrvciteauthor%
27102 : Provides a name list which is always abbreviated (with
27103 \begin_inset Quotes eld
27107 \begin_inset Quotes erd
27111 \begin_inset Flex Code
27114 \begin_layout Plain Layout
27124 \begin_layout Standard
27125 The order of pre- and surname in the former two lists can be adjusted by
27129 \begin_layout Itemize
27130 \begin_inset Flex Code
27133 \begin_layout Plain Layout
27134 !firstnameform %surname%, %prename%
27139 (first author in lists of type 1)
27142 \begin_layout Itemize
27143 \begin_inset Flex Code
27146 \begin_layout Plain Layout
27147 !othernameform %surname%, %prename%
27152 (other authors in lists of type 1)
27155 \begin_layout Itemize
27156 \begin_inset Flex Code
27159 \begin_layout Plain Layout
27160 !firstbynameform %prename% %surname%
27165 (first author in lists of type 2)
27168 \begin_layout Itemize
27169 \begin_inset Flex Code
27172 \begin_layout Plain Layout
27173 !otherbynameform %prename% %surname%
27178 (other authors in lists of type 2)
27181 \begin_layout Standard
27182 This allows you to configure namings like
27183 \begin_inset Quotes eld
27186 Miller, Peter and Mary Smith: \SpecialChar ldots
27187 , in: John Doe and Pat Green, eds.:\SpecialChar ldots
27189 \begin_inset Quotes erd
27195 \begin_layout Standard
27196 There is one other piece of syntax available in definitions, which looks
27198 \begin_inset Flex Code
27201 \begin_layout Plain Layout
27208 This defines a piece of formatting information that is to be used when
27210 \begin_inset Quotes eld
27214 \begin_inset Quotes erd
27218 Obviously, we do not want to output HTML tags when writing plain text,
27219 so they should be wrapped in
27220 \begin_inset Quotes eld
27224 \begin_inset Quotes erd
27228 \begin_inset Quotes eld
27232 \begin_inset Quotes erd
27238 \begin_layout Standard
27239 Two special sorts of definitions are also possible in a
27240 \begin_inset Flex Code
27243 \begin_layout Plain Layout
27250 An example of the first would be:
27253 \begin_layout LyX-Code
27255 \begin_inset Quotes eld
27259 \begin_inset Quotes erd
27265 \begin_layout Standard
27266 This is an abbreviation, or macro, and it can be used by treating it as
27268 \begin_inset Flex Code
27271 \begin_layout Plain Layout
27280 \begin_inset Flex Code
27283 \begin_layout Plain Layout
27289 exactly as it would treat its definition.
27290 So, let us issue the obvious
27298 \begin_layout LyX-Code
27302 \begin_layout Standard
27303 or anything like it.
27305 shouldn't go into an infinite loop, but it may go into a long one before
27309 \begin_layout Standard
27310 The second sort of special definition might look like this:
27313 \begin_layout LyX-Code
27317 \begin_layout Standard
27318 This defines a translatable piece of text, which allows relevant parts of
27319 the bibliography or citation to be translated.
27320 It can be included in a definition by treating it as a key:
27321 \begin_inset Flex Code
27324 \begin_layout Plain Layout
27331 Note that there are two different translation paths: All definitions starting
27333 \begin_inset Flex Code
27336 \begin_layout Plain Layout
27342 , such as in the example above, will be translated to the currently active
27343 buffer language (so the translation will match the generated document).
27344 All definitions starting with underscore only will be translated to the
27346 This is the proper translation for strings that only occur in the dialogs
27347 or on buttons, such as this one:
27350 \begin_layout LyX-Code
27351 _addtobib Add to bibliography only.
27354 \begin_layout Standard
27355 Several of these translatable strings are predefined in
27356 \begin_inset Flex Code
27359 \begin_layout Plain Layout
27366 \begin_inset Flex Code
27369 \begin_layout Plain Layout
27376 Note that these are not macros, in the sense just defined.
27377 They will not be expanded.
27380 \begin_layout Standard
27381 So here then is an example that uses several of these features:
27382 \begin_inset VSpace defskip
27388 \begin_layout Standard
27392 !authoredit {%author%[[%author%, ]][[{%editor%[[%editor%, %B_edtext%, ]]}]]}
27395 \begin_layout Standard
27396 \begin_inset VSpace defskip
27399 This defines a macro that prints the author, followed by a comma, if the
27401 \begin_inset Flex Code
27404 \begin_layout Plain Layout
27410 key is defined, or else prints the name of the editor, followed by the
27412 \begin_inset Flex Code
27415 \begin_layout Plain Layout
27421 or its translation (it is by default
27422 \begin_inset Quotes eld
27426 \begin_inset Quotes erd
27430 \begin_inset Flex Code
27433 \begin_layout Plain Layout
27440 Note that this is in fact defined in
27441 \begin_inset Flex Code
27444 \begin_layout Plain Layout
27450 , so you can use it in your own definitions, or re-definitions, if you load
27454 \begin_layout Section
27455 \begin_inset CommandInset label
27457 name "sec:Tags-for-XHTML"
27461 Tags for XHTML output
27464 \begin_layout Standard
27465 As with \SpecialChar LaTeX
27466 or DocBook, the format of \SpecialChar LyX
27467 's XHTML output is also controlled by
27468 layout information.
27469 In general, \SpecialChar LyX
27470 provides sensible defaults and, as mentioned earlier, it will
27471 even construct default CSS style rules from the other layout tags.
27472 For example, \SpecialChar LyX
27473 will attempt to use the information provided in the
27474 \begin_inset Flex Code
27477 \begin_layout Plain Layout
27483 declaration for the Chapter style to write CSS that will appropriately
27484 format chapter headings.
27487 \begin_layout Standard
27488 In many cases, then, you may not have to do anything at all to get acceptable
27489 XHTML output for your own environments, custom insets, and so forth.
27490 But in some cases you will, and so \SpecialChar LyX
27491 provides a number of layout tags that
27492 can be used to customize the XHTML and CSS that are generated.
27495 \begin_layout Standard
27496 Note that there are two tags,
27497 \begin_inset Flex Code
27500 \begin_layout Plain Layout
27507 \begin_inset Flex Code
27510 \begin_layout Plain Layout
27516 that may appear outside style and inset declarations.
27518 \begin_inset CommandInset ref
27520 reference "subsec:General-text-class"
27524 for details on these.
27527 \begin_layout Subsection
27528 \begin_inset CommandInset label
27530 name "subsec:Paragraph-Style-XHTML"
27537 \begin_layout Standard
27538 The sort of XHTML \SpecialChar LyX
27539 outputs for a paragraph depends upon whether we are dealing
27540 with a normal paragraph, a command, or an environment, where this is itself
27541 determined by the contents of the corresponding
27542 \begin_inset Flex Code
27545 \begin_layout Plain Layout
27556 \begin_layout Standard
27557 For a command or normal paragraph, the output XHTML has the following form:
27560 \begin_layout LyX-Code
27564 \begin_inset Quotes erd
27568 \begin_inset Quotes erd
27574 \begin_layout LyX-Code
27578 \begin_inset Quotes erd
27582 \begin_inset Quotes erd
27588 \begin_layout LyX-Code
27591 Contents of the paragraph.
27594 \begin_layout LyX-Code
27600 \begin_layout Standard
27601 The label tags are of course omitted if the paragraph does not have a label.
27604 \begin_layout Standard
27605 For an environment that is not some sort of list, the XHTML takes this form:
27608 \begin_layout LyX-Code
27612 \begin_inset Quotes erd
27616 \begin_inset Quotes erd
27622 \begin_layout LyX-Code
27626 \begin_inset Quotes erd
27630 \begin_inset Quotes erd
27634 \begin_inset Quotes erd
27638 \begin_inset Quotes erd
27641 >Environment Label</labeltag>First paragraph.</itemtag>
27644 \begin_layout LyX-Code
27647 <itemtag>Second paragraph.</itemtag>
27650 \begin_layout LyX-Code
27656 \begin_layout Standard
27657 Note that the label is output only for the first paragraph, as it should
27658 be for a theorem, for example.
27662 \begin_layout Standard
27663 For a list, we have one of these forms:
27666 \begin_layout LyX-Code
27670 \begin_inset Quotes erd
27674 \begin_inset Quotes erd
27680 \begin_layout LyX-Code
27684 \begin_inset Quotes erd
27688 \begin_inset Quotes erd
27692 \begin_inset Quotes erd
27696 \begin_inset Quotes erd
27699 >List Label</labeltag>First item.</itemtag>
27702 \begin_layout LyX-Code
27706 \begin_inset Quotes erd
27710 \begin_inset Quotes erd
27714 \begin_inset Quotes erd
27718 \begin_inset Quotes erd
27721 >List Label</labeltag>Second item.</itemtag>
27724 \begin_layout LyX-Code
27730 \begin_layout LyX-Code
27734 \begin_layout LyX-Code
27738 \begin_inset Quotes erd
27742 \begin_inset Quotes erd
27748 \begin_layout LyX-Code
27752 \begin_inset Quotes erd
27756 \begin_inset Quotes erd
27759 >List Label</labeltag><itemtag attr=
27760 \begin_inset Quotes erd
27764 \begin_inset Quotes erd
27767 >First item.</itemtag>
27770 \begin_layout LyX-Code
27774 \begin_inset Quotes erd
27778 \begin_inset Quotes erd
27781 >List Label</labeltag><itemtag attr=
27782 \begin_inset Quotes erd
27786 \begin_inset Quotes erd
27789 >Second item.</itemtag>
27792 \begin_layout LyX-Code
27798 \begin_layout Standard
27799 Note the different orders of
27800 \begin_inset Flex Code
27803 \begin_layout Plain Layout
27810 \begin_inset Flex Code
27813 \begin_layout Plain Layout
27820 Which order we get depends upon the setting of
27821 \begin_inset Flex Code
27824 \begin_layout Plain Layout
27831 \begin_inset Flex Code
27834 \begin_layout Plain Layout
27840 is false (the default), you get the first of these, with the label within
27841 the item; if true, you get the second, with the label outside the item.
27844 \begin_layout Standard
27845 The specific tags and attributes output for each paragraph type can be controlle
27846 d by means of the layout tags we are about to describe.
27847 As mentioned earlier, however, \SpecialChar LyX
27848 uses sensible defaults for many of these,
27849 so you often may not need to do very much to get good XHTML output.
27850 Think of the available tags as there so you can tweak things to your liking.
27853 \begin_layout Description
27854 \begin_inset Flex Code
27857 \begin_layout Plain Layout
27864 \begin_inset Flex Code
27867 \begin_layout Plain Layout
27873 ] Specifies attribute information to be output with the main tag.
27875 \begin_inset Quotes eld
27879 \begin_inset Flex Code
27882 \begin_layout Plain Layout
27889 \begin_inset Quotes erd
27893 By default, \SpecialChar LyX
27895 \begin_inset Quotes eld
27899 \begin_inset Flex Code
27902 \begin_layout Plain Layout
27909 \begin_inset Quotes erd
27913 \begin_inset Flex Code
27916 \begin_layout Plain Layout
27922 is the \SpecialChar LyX
27923 name of the layout, made lowercase, for example: chapter.
27928 contain any style information.
27930 \begin_inset Flex Code
27933 \begin_layout Plain Layout
27942 \begin_layout Description
27943 \begin_inset Flex Code
27946 \begin_layout Plain Layout
27953 \begin_inset Flex Code
27956 \begin_layout Plain Layout
27966 ] Whether to output the default CSS information \SpecialChar LyX
27967 generates for this layout,
27968 even if additional information is explicitly provided via
27969 \begin_inset Flex Code
27972 \begin_layout Plain Layout
27980 \begin_inset Flex Code
27983 \begin_layout Plain Layout
27989 allows you to alter or augment the generated CSS, rather than to override
27992 \begin_inset Flex Code
27995 \begin_layout Plain Layout
28004 \begin_layout Description
28005 \begin_inset Flex Code
28008 \begin_layout Plain Layout
28015 \begin_inset Flex Code
28018 \begin_layout Plain Layout
28024 ] The tag to be used for individual paragraphs of environments, replacing
28026 \begin_inset Flex Code
28029 \begin_layout Plain Layout
28035 in the examples above.
28037 \begin_inset Flex Code
28040 \begin_layout Plain Layout
28049 \begin_layout Description
28050 \begin_inset Flex Code
28053 \begin_layout Plain Layout
28060 \begin_inset Flex Code
28063 \begin_layout Plain Layout
28069 ] Attributes for the item tag.
28071 \begin_inset Newline newline
28075 \begin_inset Quotes eld
28079 \begin_inset Flex Code
28082 \begin_layout Plain Layout
28083 class=`layoutname_item'
28089 \begin_inset Quotes erd
28097 contain any style information.
28099 \begin_inset Flex Code
28102 \begin_layout Plain Layout
28111 \begin_layout Description
28112 \begin_inset Flex Code
28115 \begin_layout Plain Layout
28122 \begin_inset Flex Code
28125 \begin_layout Plain Layout
28131 ] The tag to be used for paragraph and item labels, replacing
28132 \begin_inset Flex Code
28135 \begin_layout Plain Layout
28141 in the examples above.
28143 \begin_inset Flex Code
28146 \begin_layout Plain Layout
28153 \begin_inset Flex Code
28156 \begin_layout Plain Layout
28163 \begin_inset Flex Code
28166 \begin_layout Plain Layout
28173 \begin_inset Flex Code
28176 \begin_layout Plain Layout
28177 Centered_Top_Environment
28182 , in which case it defaults to
28183 \begin_inset Flex Code
28186 \begin_layout Plain Layout
28195 \begin_layout Description
28196 \begin_inset Flex Code
28199 \begin_layout Plain Layout
28206 \begin_inset Flex Code
28209 \begin_layout Plain Layout
28215 ] Attributes for the label tag.
28217 \begin_inset Newline newline
28221 \begin_inset Quotes eld
28225 \begin_inset Flex Code
28228 \begin_layout Plain Layout
28229 class=`layoutname_label'
28235 \begin_inset Quotes erd
28243 contain any style information.
28245 \begin_inset Flex Code
28248 \begin_layout Plain Layout
28257 \begin_layout Description
28258 \begin_inset Flex Code
28261 \begin_layout Plain Layout
28268 \begin_inset Flex Code
28271 \begin_layout Plain Layout
28281 ] Meaningful only for list-like environments, this tag controls whether
28282 the label tag is output before or inside the item tag.
28283 This is used, for example, in the description environment, where we want
28285 \begin_inset Flex Code
28288 \begin_layout Plain Layout
28289 <dt>\SpecialChar ldots
28290 </dt><dd>\SpecialChar ldots
28298 \begin_inset Flex Code
28301 \begin_layout Plain Layout
28307 : The label tag is output inside the item tag.
28310 \begin_layout Description
28311 \begin_inset Flex Code
28314 \begin_layout Plain Layout
28320 Information to be output in the
28321 \begin_inset Flex Code
28324 \begin_layout Plain Layout
28330 section when this style is used.
28331 This might, for example, be used to include a
28332 \begin_inset Flex Code
28335 \begin_layout Plain Layout
28342 \begin_inset Flex Code
28345 \begin_layout Plain Layout
28354 \begin_layout Description
28355 \begin_inset Flex Code
28358 \begin_layout Plain Layout
28364 CSS style information to be included when this style is used.
28365 Note that this will automatically be wrapped in a layout-generated
28366 \begin_inset Flex Code
28369 \begin_layout Plain Layout
28375 block, so only the CSS itself need be included.
28377 \begin_inset Flex Code
28380 \begin_layout Plain Layout
28389 \begin_layout Description
28390 \begin_inset Flex Code
28393 \begin_layout Plain Layout
28400 \begin_inset Flex Code
28403 \begin_layout Plain Layout
28409 ] The tag to be used for the main label, replacing
28410 \begin_inset Flex Code
28413 \begin_layout Plain Layout
28419 in the examples above.
28421 \begin_inset Flex Code
28424 \begin_layout Plain Layout
28433 \begin_layout Description
28434 \begin_inset Flex Code
28437 \begin_layout Plain Layout
28444 \begin_inset Flex Code
28447 \begin_layout Plain Layout
28457 ] Marks this style as the one to be used to generate the
28458 \begin_inset Flex Code
28461 \begin_layout Plain Layout
28467 tag for the XHTML file.
28468 By default, it is false.
28470 \begin_inset Flex Code
28473 \begin_layout Plain Layout
28479 file sets it to true for the
28480 \begin_inset Flex Code
28483 \begin_layout Plain Layout
28493 \begin_layout Subsection
28497 \begin_layout Standard
28498 The XHTML output of insets can also be controlled by information in layout
28503 \begin_layout Plain Layout
28504 At present, this is true only for
28505 \begin_inset Quotes eld
28509 \begin_inset Quotes erd
28512 insets (insets you can type into) and is not true for
28513 \begin_inset Quotes eld
28517 \begin_inset Quotes erd
28520 insets (insets that are associated with dialog boxes).
28525 Here, too, \SpecialChar LyX
28526 tries to provide sensible defaults, and it constructs default
28528 But everything can be customized.
28531 \begin_layout Standard
28532 The XHTML \SpecialChar LyX
28533 outputs for an inset has the following form:
28536 \begin_layout LyX-Code
28538 \begin_inset Quotes erd
28542 \begin_inset Quotes erd
28548 \begin_layout LyX-Code
28549 <labeltag>Label</labeltag>
28552 \begin_layout LyX-Code
28554 \begin_inset Quotes erd
28558 \begin_inset Quotes erd
28561 >Contents of the inset.</innertag>
28564 \begin_layout LyX-Code
28568 \begin_layout Standard
28569 If the inset permits multiple paragraphs—that is, if
28570 \begin_inset Flex Code
28573 \begin_layout Plain Layout
28579 is true—then the contents of the inset will itself be output as paragraphs
28580 formatted according to the styles used for those paragraphs (standard,
28581 quote, and the like).
28582 The label tag is of course omitted if the paragraph does not have a label
28583 and, at present, is always
28584 \begin_inset Flex Code
28587 \begin_layout Plain Layout
28594 The inner tag is optional and, by default, does not appear.
28597 \begin_layout Standard
28598 The specific tags and attributes output for each inset can be controlled
28599 by means of the following layout tags.
28602 \begin_layout Description
28603 \begin_inset Flex Code
28606 \begin_layout Plain Layout
28613 \begin_inset Flex Code
28616 \begin_layout Plain Layout
28622 ] Specifies attribute information to be output with the main tag.
28624 \begin_inset Quotes eld
28628 \begin_inset Flex Code
28631 \begin_layout Plain Layout
28632 class=`myinset' onclick=`\SpecialChar ldots
28639 \begin_inset Quotes erd
28643 By default, \SpecialChar LyX
28645 \begin_inset Quotes eld
28649 \begin_inset Flex Code
28652 \begin_layout Plain Layout
28659 \begin_inset Quotes erd
28663 \begin_inset Flex Code
28666 \begin_layout Plain Layout
28672 is the \SpecialChar LyX
28673 name of the inset, made lowercase and with non-alphanumeric characters
28674 converted to underscores, for example: footnote.
28677 \begin_layout Description
28678 \begin_inset Flex Code
28681 \begin_layout Plain Layout
28688 \begin_inset Flex Code
28691 \begin_layout Plain Layout
28701 ] Whether to output the default CSS information \SpecialChar LyX
28702 generates for this layout,
28703 even if additional information is explicitly provided via
28704 \begin_inset Flex Code
28707 \begin_layout Plain Layout
28715 \begin_inset Flex Code
28718 \begin_layout Plain Layout
28724 allows you to alter or augment the generated CSS, rather than to override
28729 \begin_layout Description
28730 \begin_inset Flex Code
28733 \begin_layout Plain Layout
28740 \begin_inset Flex Code
28743 \begin_layout Plain Layout
28749 ] Attributes for the inner tag.
28751 \begin_inset Newline newline
28755 \begin_inset Quotes eld
28759 \begin_inset Flex Code
28762 \begin_layout Plain Layout
28763 class=`insetname_inner'
28769 \begin_inset Quotes erd
28775 \begin_layout Description
28776 \begin_inset Flex Code
28779 \begin_layout Plain Layout
28786 \begin_inset Flex Code
28789 \begin_layout Plain Layout
28795 ] The inner tag, replacing
28796 \begin_inset Flex Code
28799 \begin_layout Plain Layout
28805 in the examples above.
28806 By default, there is none.
28809 \begin_layout Description
28810 \begin_inset Flex Code
28813 \begin_layout Plain Layout
28820 \begin_inset Flex Code
28823 \begin_layout Plain Layout
28831 ] Whether this inset represents a standalone block of text (such as a footnote)
28832 or instead represents material that is included in the surrounding text
28833 (such as a branch).
28837 \begin_layout Description
28838 \begin_inset Flex Code
28841 \begin_layout Plain Layout
28848 \begin_inset Flex Code
28851 \begin_layout Plain Layout
28857 ] A label for this inset, possibly including a reference to a counter.
28858 For example, for footnote, it might be:
28859 \begin_inset Flex Code
28862 \begin_layout Plain Layout
28871 This is optional, and there is no default.
28874 \begin_layout Description
28875 \begin_inset Flex Code
28878 \begin_layout Plain Layout
28884 Information to be output in the
28885 \begin_inset Flex Code
28888 \begin_layout Plain Layout
28894 section when this style is used.
28895 This might, for example, be used to include a
28896 \begin_inset Flex Code
28899 \begin_layout Plain Layout
28906 \begin_inset Flex Code
28909 \begin_layout Plain Layout
28918 \begin_layout Description
28919 \begin_inset Flex Code
28922 \begin_layout Plain Layout
28928 CSS style information to be included when this style is used.
28929 Note that this will automatically be wrapped in a layout-generated
28930 \begin_inset Flex Code
28933 \begin_layout Plain Layout
28939 block, so only the CSS itself need be included.
28942 \begin_layout Description
28943 \begin_inset Flex Code
28946 \begin_layout Plain Layout
28953 \begin_inset Flex Code
28956 \begin_layout Plain Layout
28962 ] The tag to be used for the main label, replacing
28963 \begin_inset Flex Code
28966 \begin_layout Plain Layout
28972 in the examples above.
28973 The default depends upon the setting of
28974 \begin_inset Flex Code
28977 \begin_layout Plain Layout
28984 \begin_inset Flex Code
28987 \begin_layout Plain Layout
28993 is true, the default is
28994 \begin_inset Flex Code
28997 \begin_layout Plain Layout
29003 ; if it is false, the default is
29004 \begin_inset Flex Code
29007 \begin_layout Plain Layout
29016 \begin_layout Subsection
29020 \begin_layout Standard
29021 The XHTML output for floats too can be controlled by layout information.
29022 The output has the following form:
29025 \begin_layout LyX-Code
29027 \begin_inset Quotes erd
29031 \begin_inset Quotes erd
29037 \begin_layout LyX-Code
29038 Contents of the float.
29041 \begin_layout LyX-Code
29045 \begin_layout Standard
29046 The caption, if there is one, is a separate inset and will be output as
29048 Its appearance can be controlled via the InsetLayout for caption insets.
29052 \begin_layout Description
29053 \begin_inset Flex Code
29056 \begin_layout Plain Layout
29063 \begin_inset Flex Code
29066 \begin_layout Plain Layout
29072 ] Specifies attribute information to be output with the main tag.
29074 \begin_inset Quotes eld
29078 \begin_inset Flex Code
29081 \begin_layout Plain Layout
29082 class=`myfloat' onclick=`\SpecialChar ldots
29089 \begin_inset Quotes erd
29093 By default, \SpecialChar LyX
29095 \begin_inset Quotes eld
29099 \begin_inset Flex Code
29102 \begin_layout Plain Layout
29103 class=`float float-floattype'
29109 \begin_inset Quotes erd
29113 \begin_inset Flex Code
29116 \begin_layout Plain Layout
29122 is \SpecialChar LyX
29123 's name for this type of float, as determined by the float declaration
29125 \begin_inset CommandInset ref
29127 reference "subsec:Floats"
29131 ), though made lowercase and with non-alphanumeric characters converted
29132 to underscores, for example: float-table.
29135 \begin_layout Description
29136 \begin_inset Flex Code
29139 \begin_layout Plain Layout
29145 CSS style information to be included when this float is used.
29146 Note that this will automatically be wrapped in a layout-generated
29147 \begin_inset Flex Code
29150 \begin_layout Plain Layout
29156 block, so only the CSS itself need be included.
29159 \begin_layout Description
29160 \begin_inset Flex Code
29163 \begin_layout Plain Layout
29170 \begin_inset Flex Code
29173 \begin_layout Plain Layout
29179 ] The tag to be used for this float, replacing
29180 \begin_inset Quotes eld
29184 \begin_inset Flex Code
29187 \begin_layout Plain Layout
29194 \begin_inset Quotes erd
29197 in the example above.
29199 \begin_inset Flex Code
29202 \begin_layout Plain Layout
29208 and will rarely need changing.
29211 \begin_layout Subsection
29212 Bibliography formatting
29215 \begin_layout Standard
29216 The bibliography can be formatted using
29217 \begin_inset Flex Code
29220 \begin_layout Plain Layout
29228 \begin_inset CommandInset ref
29230 reference "subsec:Citation-format-description"
29237 \begin_layout Subsection
29242 \begin_layout Standard
29243 We have several times mentioned that \SpecialChar LyX
29244 will generate default CSS style rules
29245 for both insets and paragraph styles, based upon the other layout information
29247 In this section, we shall say a word about which layout information \SpecialChar LyX
29252 \begin_layout Standard
29253 At present, \SpecialChar LyX
29254 auto-generates CSS only for font information, making use of
29256 \begin_inset Flex Code
29259 \begin_layout Plain Layout
29266 \begin_inset Flex Code
29269 \begin_layout Plain Layout
29276 \begin_inset Flex Code
29279 \begin_layout Plain Layout
29286 \begin_inset Flex Code
29289 \begin_layout Plain Layout
29296 \begin_inset Flex Code
29299 \begin_layout Plain Layout
29306 \begin_inset CommandInset ref
29308 reference "subsec:Font-description"
29313 The translation is mostly straightforward and obvious.
29315 \begin_inset Quotes eld
29319 \begin_inset Flex Code
29322 \begin_layout Plain Layout
29329 \begin_inset Quotes erd
29333 \begin_inset Quotes eld
29337 \begin_inset Flex Code
29340 \begin_layout Plain Layout
29341 font-family: sans-serif;
29347 \begin_inset Quotes erd
29351 The correspondence of \SpecialChar LyX
29352 sizes and CSS sizes is a little less obvious but
29353 nonetheless intuitive.
29355 \begin_inset Flex Code
29358 \begin_layout Plain Layout
29365 \begin_inset Flex URL
29368 \begin_layout Plain Layout
29376 \change_inserted -970929547 1496610908
29380 \begin_layout Section
29382 \change_inserted -970929547 1496610966
29383 \begin_inset CommandInset label
29385 name "sec:Tags-for-DocBook"
29389 Tags for DocBook output
29392 \begin_layout Standard
29394 \change_inserted -970929547 1496611615
29395 As with \SpecialChar LaTeX
29396 or XHTML, the format of \SpecialChar LyX
29397 's DocBook output is also controlled by
29398 layout information.
29399 In general, \SpecialChar LyX
29400 provides sensible defaults; however, much of the styling is
29401 lost during the conversion, as DocBook is strictly semantic and does not
29403 When possible, information from \SpecialChar LyX
29404 will be rendered in
29412 \begin_layout Standard
29414 \change_inserted -970929547 1496612080
29415 In many cases, then, you may not have to do anything at all to get acceptable
29416 DocBook output for your own environments, custom insets, and so forth.
29417 But in some cases you will, and so \SpecialChar LyX
29418 provides a number of layout tags that
29419 can be used to customize the DocBook that is generated.
29422 \begin_layout Standard
29424 \change_inserted -970929547 1515109912
29425 Labels are rarely output, as they are redundant in DocBook: this information
29426 is carried by the tags themselves, and whether labels appear in the final
29427 documents (after processing of DocBook files) is controlled by the stylesheets.
29428 However, sometimes, labels are not redundant content, such as definition
29429 lists: in this case, the term being defined will be the label.
29433 \begin_layout Subsection
29435 \change_inserted 1075283030 1597699417
29436 \begin_inset CommandInset label
29438 name "subsec:Paragraph-Style-DocBook"
29443 \change_deleted 1075283030 1597699417
29445 \begin_inset CommandInset label
29447 name "subsec:Paragraph-Style-XHTML-1"
29452 \change_inserted -970929547 1496610966
29456 \begin_layout Standard
29458 \change_inserted -970929547 1496612059
29459 The sort of DocBook \SpecialChar LyX
29460 outputs for a paragraph depends upon whether we are
29461 dealing with a normal paragraph, a command, or an environment, where this
29462 is itself determined by the contents of the corresponding
29463 \begin_inset Flex Code
29466 \begin_layout Plain Layout
29468 \change_inserted -970929547 1496610966
29481 \begin_layout Standard
29483 \change_inserted -970929547 1496612107
29484 For a command or normal paragraph, the output DocBook has the following
29488 \begin_layout LyX-Code
29490 \change_inserted -970929547 1515109666
29494 \begin_layout LyX-Code
29496 \change_inserted -970929547 1496610966
29497 Contents of the paragraph.
29500 \begin_layout LyX-Code
29502 \change_inserted -970929547 1496610966
29506 \begin_layout Standard
29508 \change_inserted -970929547 1515109821
29509 For an environment that is not some sort of list, the generated DocBook
29513 \begin_layout LyX-Code
29515 \change_inserted -970929547 1515109671
29519 \begin_layout LyX-Code
29521 \change_inserted -970929547 1496612114
29522 <itemtag>First paragraph.</itemtag>
29525 \begin_layout LyX-Code
29527 \change_inserted -970929547 1496610966
29528 <itemtag>Second paragraph.</itemtag>
29531 \begin_layout LyX-Code
29533 \change_inserted -970929547 1496610966
29537 \begin_layout Standard
29539 \change_inserted -970929547 1515109825
29540 For a list, the resulting DocBook takes this form:
29543 \begin_layout LyX-Code
29545 \change_inserted -970929547 1515109672
29549 \begin_layout LyX-Code
29551 \change_inserted -970929547 1515109676
29552 <itemtag attr>First item.</itemtag>
29555 \begin_layout LyX-Code
29557 \change_inserted -970929547 1515109678
29558 <itemtag attr>Second item.</itemtag>
29561 \begin_layout LyX-Code
29563 \change_inserted -970929547 1496610966
29567 \begin_layout Standard
29569 \change_inserted -970929547 1496612243
29570 The specific tags and roles output for each paragraph type can be controlled
29571 by means of the layout tags we are about to describe.
29572 Please note that, due to the very nature of DocBook, no sensible defaults
29573 really exist, and the values must always be carefully chosen.
29577 \begin_layout Description
29579 \change_inserted -970929547 1515110057
29580 \begin_inset Flex Code
29583 \begin_layout Plain Layout
29585 \change_inserted -970929547 1515109656
29594 \begin_inset Flex Code
29597 \begin_layout Plain Layout
29599 \change_inserted -970929547 1496610966
29607 ] Specifies attribute information to be output with the main tag, replacing
29609 \begin_inset Quotes eld
29613 \begin_inset Flex Code
29616 \begin_layout Plain Layout
29618 \change_inserted -970929547 1515110057
29627 \begin_inset Quotes erd
29630 in the example above.
29631 This information can be used in further processing of the DocBook files.
29637 \begin_layout Description
29639 \change_inserted -970929547 1496612296
29640 \begin_inset Flex Code
29643 \begin_layout Plain Layout
29645 \change_inserted -970929547 1496612269
29654 \begin_inset Flex Code
29657 \begin_layout Plain Layout
29659 \change_inserted -970929547 1496610966
29667 ] The tag to be used for this inset, replacing
29668 \begin_inset Quotes eld
29672 \begin_inset Flex Code
29675 \begin_layout Plain Layout
29677 \change_inserted -970929547 1496612296
29686 \begin_inset Quotes erd
29689 in the example above.
29690 The default is the name of the float and always needs to be changed, as
29691 DocBook provides no generic tag.
29692 \change_inserted 1075283030 1597698868
29696 \begin_layout Description
29698 \change_inserted 1075283030 1597699399
29699 \begin_inset Flex Code
29702 \begin_layout Plain Layout
29704 \change_inserted 1075283030 1597698872
29713 \begin_inset Flex Code
29716 \begin_layout Plain Layout
29718 \change_inserted 1075283030 1597700585
29719 block, paragraph, inline
29726 ] The new-line policy for this tag, see Section
29727 \begin_inset space ~
29731 \begin_inset CommandInset ref
29733 reference "subsec:DocBook-New-line-policy"
29746 \begin_layout Subsection
29748 \change_inserted 1075283030 1597699385
29750 \begin_inset CommandInset label
29752 name "subsec:DocBook-New-line-policy"
29759 \begin_layout Standard
29761 \change_inserted 1075283030 1597698993
29762 For all tags, there are three possible policies for outputting new lines
29764 \begin_inset Flex Code
29767 \begin_layout Plain Layout
29769 \change_inserted 1075283030 1597698987
29780 \begin_layout Itemize
29782 \change_inserted 1075283030 1597699279
29783 \begin_inset Quotes eld
29787 \begin_inset Flex Code
29790 \begin_layout Plain Layout
29792 \change_inserted 1075283030 1597699012
29801 \begin_inset Quotes erd
29804 : the opening and closing tags are on their own lines (i.e.
29805 a line feed after and before the opening and the closing tags).
29806 Typical elements are floats.
29810 \begin_layout LyX-Code
29812 \change_inserted 1075283030 1597699194
29816 \begin_layout LyX-Code
29818 \change_inserted 1075283030 1597699194
29822 \begin_layout LyX-Code
29824 \change_inserted 1075283030 1597699098
29825 Contents of the block.
29828 \begin_layout LyX-Code
29830 \change_inserted 1075283030 1597699196
29834 \begin_layout LyX-Code
29836 \change_inserted 1075283030 1597699198
29840 \begin_layout Itemize
29842 \change_inserted 1075283030 1597699289
29843 \begin_inset Quotes eld
29847 \begin_inset Flex Code
29850 \begin_layout Plain Layout
29852 \change_inserted 1075283030 1597699113
29861 \begin_inset Quotes erd
29864 : the opening and closing tags are on the same, new line; a line feed is
29865 output before the opening tag and after the closing tag.
29866 Typical elements are paragraphs and list items.
29870 \begin_layout LyX-Code
29872 \change_inserted 1075283030 1597699186
29876 \begin_layout LyX-Code
29878 \change_inserted 1075283030 1597699357
29879 <paratag>Contents of the paragraph.</paratag>
29882 \begin_layout LyX-Code
29884 \change_inserted 1075283030 1597699231
29888 \begin_layout Itemize
29890 \change_inserted 1075283030 1597699343
29891 \begin_inset Quotes eld
29895 \begin_inset Flex Code
29898 \begin_layout Plain Layout
29900 \change_inserted 1075283030 1597699307
29909 \begin_inset Quotes erd
29912 : the opening and closing tags are on the same line as the rest of the content.
29913 No line feeds are output.
29914 Typical elements are fonts.
29918 \begin_layout LyX-Code
29920 \change_inserted 1075283030 1597699585
29921 Content before<inlinetag>Contents of the paragraph.</inlinetag>Content after
29924 \begin_layout Standard
29926 \change_inserted 1075283030 1597699585
29927 The default value is always
29928 \begin_inset Quotes eld
29932 \begin_inset Flex Code
29935 \begin_layout Plain Layout
29937 \change_inserted 1075283030 1597699585
29946 \begin_inset Quotes erd
29954 \begin_layout Subsection
29956 \change_inserted -970929547 1515111533
29957 InsetLayout DocBook
29962 \begin_layout Standard
29964 \change_inserted -970929547 1496611894
29965 The DocBook output of insets can also be controlled by information in layout
29969 \begin_layout Standard
29971 \change_inserted -970929547 1496612045
29972 The DocBook \SpecialChar LyX
29973 outputs for an inset has the following form:
29976 \begin_layout LyX-Code
29978 \change_inserted -970929547 1515110861
29979 <wrappertag wrapperattr>
29982 \begin_layout LyX-Code
29984 \change_inserted -970929547 1515110868
29988 \begin_layout LyX-Code
29990 \change_inserted -970929547 1515110869
29991 <innertag innerattr>
29994 \begin_layout LyX-Code
29996 \change_inserted -970929547 1515110869
29997 Contents of the inset.
30000 \begin_layout LyX-Code
30002 \change_inserted -970929547 1515110870
30006 \begin_layout LyX-Code
30008 \change_inserted -970929547 1515110871
30012 \begin_layout LyX-Code
30014 \change_inserted -970929547 1515111172
30018 \begin_layout Standard
30020 \change_inserted -970929547 1515111186
30021 For an itemising inset, it rather looks like this:
30024 \begin_layout LyX-Code
30026 \change_inserted -970929547 1515111186
30027 <wrappertag wrapperattr>
30030 \begin_layout LyX-Code
30032 \change_inserted -970929547 1515111186
30036 \begin_layout LyX-Code
30038 \change_inserted -970929547 1515111186
30039 <innertag innerattr>
30042 \begin_layout LyX-Code
30044 \change_inserted -970929547 1515111362
30045 <itemwrappertag itemwrapperattr>
30048 \begin_layout LyX-Code
30050 \change_inserted -970929547 1515111364
30051 <itemlabeltag itemattr>
30054 \begin_layout LyX-Code
30056 \change_inserted -970929547 1515111367
30057 Label of the first item.
30060 \begin_layout LyX-Code
30062 \change_inserted -970929547 1515111362
30068 \begin_layout LyX-Code
30070 \change_inserted -970929547 1515111517
30074 \begin_layout LyX-Code
30076 \change_inserted -970929547 1515111517
30082 \begin_layout LyX-Code
30084 \change_inserted -970929547 1515111516
30085 Contents of the first item.
30088 \begin_layout LyX-Code
30090 \change_inserted -970929547 1515111514
30096 \begin_layout LyX-Code
30098 \change_inserted -970929547 1515111247
30104 \begin_layout LyX-Code
30106 \change_inserted -970929547 1515111221
30110 \begin_layout LyX-Code
30112 \change_inserted -970929547 1515111370
30113 <itemwrappertag itemwrapperattr>
30116 \begin_layout LyX-Code
30118 \change_inserted -970929547 1515111370
30119 <itemlabeltag itemattr>
30122 \begin_layout LyX-Code
30124 \change_inserted -970929547 1515111372
30125 Label of the second item.
30128 \begin_layout LyX-Code
30130 \change_inserted -970929547 1515111370
30136 \begin_layout LyX-Code
30138 \change_inserted -970929547 1515111504
30142 \begin_layout LyX-Code
30144 \change_inserted -970929547 1515111505
30150 \begin_layout LyX-Code
30152 \change_inserted -970929547 1515111507
30153 Contents of the second item.
30156 \begin_layout LyX-Code
30158 \change_inserted -970929547 1515111509
30164 \begin_layout LyX-Code
30166 \change_inserted -970929547 1515111251
30172 \begin_layout LyX-Code
30174 \change_inserted -970929547 1515111221
30180 \begin_layout LyX-Code
30182 \change_inserted -970929547 1515111219
30188 \begin_layout LyX-Code
30190 \change_inserted -970929547 1515111186
30194 \begin_layout LyX-Code
30196 \change_inserted -970929547 1515111186
30200 \begin_layout LyX-Code
30202 \change_inserted -970929547 1515111186
30206 \begin_layout Standard
30208 \change_inserted -970929547 1515111183
30209 If the inset permits multiple paragraphs—that is, if
30210 \begin_inset Flex Code
30213 \begin_layout Plain Layout
30215 \change_inserted -970929547 1496610966
30223 is true—then the contents of the inset will itself be output as paragraphs
30224 formatted according to the styles used for those paragraphs (standard,
30225 quote, and the like).
30226 The inner tag is optional and, by default, does not appear.
30229 \begin_layout Standard
30231 \change_inserted -970929547 1496610966
30232 The specific tags and attributes output for each inset can be controlled
30233 by means of the following layout tags.
30236 \begin_layout Description
30238 \change_inserted -970929547 1515110317
30239 \begin_inset Flex Code
30242 \begin_layout Plain Layout
30244 \change_inserted -970929547 1515109695
30253 \begin_inset Flex Code
30256 \begin_layout Plain Layout
30258 \change_inserted -970929547 1496611854
30266 ] Specifies attribute information to be output with the main tag, replacing
30268 \begin_inset Quotes eld
30272 \begin_inset Flex Code
30275 \begin_layout Plain Layout
30277 \change_inserted -970929547 1515110044
30286 \begin_inset Quotes erd
30289 in the example above.
30290 This information can be used in further processing of the DocBook files.
30294 \begin_layout Description
30296 \change_inserted -970929547 1515110973
30297 \begin_inset Flex Code
30300 \begin_layout Plain Layout
30302 \change_inserted -970929547 1515110319
30311 \begin_inset Flex Code
30314 \begin_layout Plain Layout
30316 \change_inserted -970929547 1515110384
30317 never, always, maybe
30324 ] Specifies whether this tag goes into the
30325 \begin_inset Flex Code
30328 \begin_layout Plain Layout
30330 \change_inserted -970929547 1515110412
30338 tag at the beginning of the parent layout.
30340 \begin_inset Flex Code
30343 \begin_layout Plain Layout
30345 \change_inserted -970929547 1515110437
30353 indicates that the tag never goes into
30354 \begin_inset Flex Code
30357 \begin_layout Plain Layout
30359 \change_inserted -970929547 1515110497
30367 (this is default value, and corresponds to usual content).
30369 \begin_inset Flex Code
30372 \begin_layout Plain Layout
30374 \change_inserted -970929547 1515110517
30382 indicates that the tag always goes into
30383 \begin_inset Flex Code
30386 \begin_layout Plain Layout
30388 \change_inserted -970929547 1515110514
30396 (this corresponds to usual metadata): if there is no
30397 \begin_inset Flex Code
30400 \begin_layout Plain Layout
30402 \change_inserted -970929547 1515110550
30410 tag for the parent, one
30416 \begin_inset Flex Code
30419 \begin_layout Plain Layout
30421 \change_inserted -970929547 1515110540
30429 indicates that the tag may go into
30430 \begin_inset Flex Code
30433 \begin_layout Plain Layout
30435 \change_inserted -970929547 1515110538
30443 (this is only the case for titles): if there is no
30444 \begin_inset Flex Code
30447 \begin_layout Plain Layout
30449 \change_inserted -970929547 1515110585
30457 tag for the parent,
30461 will be generated, the corresponding tag will be output directly as content.
30465 \begin_layout Description
30467 \change_inserted -970929547 1515111461
30468 \begin_inset Flex Code
30471 \begin_layout Plain Layout
30473 \change_inserted -970929547 1515110974
30482 \begin_inset Flex Code
30485 \begin_layout Plain Layout
30487 \change_inserted -970929547 1515110973
30495 ] Specifies attribute information to be output with the item tag, replacing
30497 \begin_inset Quotes eld
30501 \begin_inset Flex Code
30504 \begin_layout Plain Layout
30506 \change_inserted -970929547 1515110984
30515 \begin_inset Quotes erd
30518 in the example above.
30519 This information can be used in further processing of the DocBook files.
30523 \begin_layout Description
30525 \change_inserted -970929547 1515111471
30526 \begin_inset Flex Code
30529 \begin_layout Plain Layout
30531 \change_inserted -970929547 1515111465
30532 DocBookItemInnerAttr
30540 \begin_inset Flex Code
30543 \begin_layout Plain Layout
30545 \change_inserted -970929547 1515111461
30553 ] Specifies attribute information to be output with the item inner tag,
30555 \begin_inset Quotes eld
30559 \begin_inset Flex Code
30562 \begin_layout Plain Layout
30564 \change_inserted -970929547 1515111476
30573 \begin_inset Quotes erd
30576 in the example above.
30577 This information can be used in further processing of the DocBook files.
30581 \begin_layout Description
30583 \change_inserted -970929547 1515111494
30584 \begin_inset Flex Code
30587 \begin_layout Plain Layout
30589 \change_inserted -970929547 1515111467
30590 DocBookItemInnerTag
30598 \begin_inset Flex Code
30601 \begin_layout Plain Layout
30603 \change_inserted -970929547 1515111461
30611 ] The tag to be used for the item inner tag within the inset, replacing
30613 \begin_inset Quotes eld
30617 \begin_inset Flex Code
30620 \begin_layout Plain Layout
30622 \change_inserted -970929547 1515111486
30631 \begin_inset Quotes erd
30634 in the example above.
30636 \begin_inset Flex Code
30639 \begin_layout Plain Layout
30641 \change_inserted -970929547 1515111461
30649 , indicating that there is no item inner tag: content is directly output
30650 without it for each itemised element.
30651 This parameter only makes sense when itemising layouts are used, such as
30654 \change_inserted 1075283030 1598469472
30655 The most likely value is
30656 \begin_inset Quotes eld
30660 \begin_inset Flex Code
30663 \begin_layout Plain Layout
30665 \change_inserted 1075283030 1598469476
30674 \begin_inset Quotes erd
30678 \begin_inset Newline newline
30681 When a list item is split using a new line, the item inner tag will be repeated
30682 for each part of the paragraph, parts being separated by new lines.
30686 \begin_layout Description
30688 \change_inserted 1075283030 1597699866
30689 \begin_inset Flex Code
30692 \begin_layout Plain Layout
30694 \change_inserted 1075283030 1597699853
30695 DocBookItemInnerTagType
30703 \begin_inset Flex Code
30706 \begin_layout Plain Layout
30708 \change_inserted 1075283030 1597699866
30709 block, paragraph, inline
30716 ] The new-line policy for this tag, see Section
30717 \begin_inset space ~
30721 \begin_inset CommandInset ref
30723 reference "subsec:DocBook-New-line-policy"
30736 \begin_layout Description
30738 \change_inserted -970929547 1515111290
30739 \begin_inset Flex Code
30742 \begin_layout Plain Layout
30744 \change_inserted -970929547 1515111283
30745 DocBookItemLabelAttr
30753 \begin_inset Flex Code
30756 \begin_layout Plain Layout
30758 \change_inserted -970929547 1515111279
30766 ] Specifies attribute information to be output with the item label tag,
30768 \begin_inset Quotes eld
30772 \begin_inset Flex Code
30775 \begin_layout Plain Layout
30777 \change_inserted -970929547 1515111304
30786 \begin_inset Quotes erd
30789 in the example above.
30790 This information can be used in further processing of the DocBook files.
30794 \begin_layout Description
30796 \change_inserted -970929547 1515111337
30797 \begin_inset Flex Code
30800 \begin_layout Plain Layout
30802 \change_inserted -970929547 1515111285
30803 DocBookItemLabelTag
30811 \begin_inset Flex Code
30814 \begin_layout Plain Layout
30816 \change_inserted -970929547 1515111279
30824 ] The tag to be used for the item label tag within the inset, replacing
30826 \begin_inset Quotes eld
30830 \begin_inset Flex Code
30833 \begin_layout Plain Layout
30835 \change_inserted -970929547 1515111311
30844 \begin_inset Quotes erd
30847 in the example above.
30848 This parameter only makes sense when itemising layouts are used with a
30849 notion of labels, such as definition lists.
30851 \change_inserted 1075283030 1597699874
30855 \begin_layout Description
30857 \change_inserted 1075283030 1597699874
30858 \begin_inset Flex Code
30861 \begin_layout Plain Layout
30863 \change_inserted 1075283030 1597699880
30864 DocBookItemLabelTagType
30872 \begin_inset Flex Code
30875 \begin_layout Plain Layout
30877 \change_inserted 1075283030 1597699874
30878 block, paragraph, inline
30885 ] The new-line policy for this tag, see Section
30886 \begin_inset space ~
30890 \begin_inset CommandInset ref
30892 reference "subsec:DocBook-New-line-policy"
30905 \begin_layout Description
30907 \change_inserted -970929547 1515111124
30908 \begin_inset Flex Code
30911 \begin_layout Plain Layout
30913 \change_inserted -970929547 1515111060
30922 \begin_inset Flex Code
30925 \begin_layout Plain Layout
30927 \change_inserted -970929547 1515111060
30935 ] The tag to be used for the item tag within the inset, replacing
30936 \begin_inset Quotes eld
30940 \begin_inset Flex Code
30943 \begin_layout Plain Layout
30945 \change_inserted -970929547 1515111060
30954 \begin_inset Quotes erd
30957 in the example above.
30959 \begin_inset Flex Code
30962 \begin_layout Plain Layout
30964 \change_inserted -970929547 1515111060
30972 , indicating that there is no item tag.
30973 This parameter only makes sense when itemising layouts are used, such as
30976 \change_inserted 1075283030 1597699890
30980 \begin_layout Description
30982 \change_inserted 1075283030 1597699890
30983 \begin_inset Flex Code
30986 \begin_layout Plain Layout
30988 \change_inserted 1075283030 1597699890
30997 \begin_inset Flex Code
31000 \begin_layout Plain Layout
31002 \change_inserted 1075283030 1597699890
31003 block, paragraph, inline
31010 ] The new-line policy for this tag, see Section
31011 \begin_inset space ~
31015 \begin_inset CommandInset ref
31017 reference "subsec:DocBook-New-line-policy"
31030 \begin_layout Description
31032 \change_inserted -970929547 1515111298
31033 \begin_inset Flex Code
31036 \begin_layout Plain Layout
31038 \change_inserted -970929547 1515111124
31039 DocBookItemWrapperAttr
31047 \begin_inset Flex Code
31050 \begin_layout Plain Layout
31052 \change_inserted -970929547 1515111124
31060 ] Specifies attribute information to be output with the item wrapper tag,
31062 \begin_inset Quotes eld
31066 \begin_inset Flex Code
31069 \begin_layout Plain Layout
31071 \change_inserted -970929547 1515111150
31080 \begin_inset Quotes erd
31083 in the example above.
31084 This information can be used in further processing of the DocBook files.
31090 \begin_layout Description
31092 \change_inserted -970929547 1515111113
31093 \begin_inset Flex Code
31096 \begin_layout Plain Layout
31098 \change_inserted -970929547 1515111073
31099 DocBookItemWrapperTag
31107 \begin_inset Flex Code
31110 \begin_layout Plain Layout
31112 \change_inserted -970929547 1515111073
31120 ] The tag to be used for the item wrapper tag within the inset, replacing
31122 \begin_inset Quotes eld
31126 \begin_inset Flex Code
31129 \begin_layout Plain Layout
31131 \change_inserted -970929547 1515111083
31140 \begin_inset Quotes erd
31143 in the example above.
31145 \begin_inset Flex Code
31148 \begin_layout Plain Layout
31150 \change_inserted -970929547 1515111073
31158 , indicating that there is no item wrapper tag: tag and content are directly
31159 output without it for each itemised element.
31160 This parameter only makes sense when itemising layouts are used, such as
31163 \change_inserted 1075283030 1597699897
31167 \begin_layout Description
31169 \change_inserted 1075283030 1597699897
31170 \begin_inset Flex Code
31173 \begin_layout Plain Layout
31175 \change_inserted 1075283030 1597699900
31176 DocBookItemWrapperTagType
31184 \begin_inset Flex Code
31187 \begin_layout Plain Layout
31189 \change_inserted 1075283030 1597699897
31190 block, paragraph, inline
31197 ] The new-line policy for this tag, see Section
31198 \begin_inset space ~
31202 \begin_inset CommandInset ref
31204 reference "subsec:DocBook-New-line-policy"
31217 \begin_layout Description
31219 \change_inserted -970929547 1515110104
31220 \begin_inset Flex Code
31223 \begin_layout Plain Layout
31225 \change_inserted -970929547 1515110104
31234 \begin_inset Flex Code
31237 \begin_layout Plain Layout
31239 \change_inserted -970929547 1515110104
31247 ] Specifies attribute information to be output with the inner tag, replacing
31249 \begin_inset Quotes eld
31253 \begin_inset Flex Code
31256 \begin_layout Plain Layout
31258 \change_inserted -970929547 1515110104
31267 \begin_inset Quotes erd
31270 in the example above.
31271 This information can be used in further processing of the DocBook files.
31275 \begin_layout Description
31277 \change_inserted -970929547 1515110906
31278 \begin_inset Flex Code
31281 \begin_layout Plain Layout
31283 \change_inserted -970929547 1515110104
31292 \begin_inset Flex Code
31295 \begin_layout Plain Layout
31297 \change_inserted -970929547 1515110104
31305 ] The tag to be used for the inner tag within the inset, replacing
31306 \begin_inset Quotes eld
31310 \begin_inset Flex Code
31313 \begin_layout Plain Layout
31315 \change_inserted -970929547 1515110104
31324 \begin_inset Quotes erd
31327 in the example above.
31329 \begin_inset Flex Code
31332 \begin_layout Plain Layout
31334 \change_inserted -970929547 1515110791
31342 , indicating that there is no inner tag: content is directly output without
31344 \change_inserted 1075283030 1597699904
31348 \begin_layout Description
31350 \change_inserted 1075283030 1597699904
31351 \begin_inset Flex Code
31354 \begin_layout Plain Layout
31356 \change_inserted 1075283030 1597699904
31357 DocBookInnerTagType
31365 \begin_inset Flex Code
31368 \begin_layout Plain Layout
31370 \change_inserted 1075283030 1597699904
31371 block, paragraph, inline
31378 ] The new-line policy for this tag, see Section
31379 \begin_inset space ~
31383 \begin_inset CommandInset ref
31385 reference "subsec:DocBook-New-line-policy"
31398 \begin_layout Description
31400 \change_inserted -970929547 1515110753
31401 \begin_inset Flex Code
31404 \begin_layout Plain Layout
31406 \change_inserted -970929547 1515110665
31415 \begin_inset Flex Code
31418 \begin_layout Plain Layout
31420 \change_inserted -970929547 1515110661
31428 ] Specifies the tag that corresponds to this kind of section.
31429 This parameter only makes sense for sectioning elements (part, chapter,
31431 The default value is
31432 \begin_inset Flex Code
31435 \begin_layout Plain Layout
31437 \change_inserted -970929547 1515110721
31445 , and is only overridden when DocBook uses something else for sectioning
31447 \change_inserted 1075283030 1597699921
31449 \change_inserted -970929547 1515110753
31450 parts and chapters of a book).
31456 \begin_layout Description
31458 \change_inserted -970929547 1515110811
31459 \begin_inset Flex Code
31462 \begin_layout Plain Layout
31464 \change_inserted -970929547 1496612023
31473 \begin_inset Flex Code
31476 \begin_layout Plain Layout
31478 \change_inserted -970929547 1496610966
31486 ] The tag to be used for this inset, replacing
31487 \begin_inset Quotes eld
31491 \begin_inset Flex Code
31494 \begin_layout Plain Layout
31496 \change_inserted -970929547 1496612033
31505 \begin_inset Quotes erd
31508 in the example above.
31509 The default is the name of the float and always needs to be changed, as
31510 DocBook provides no generic inset tag.
31511 \change_inserted 1075283030 1597699924
31515 \begin_layout Description
31517 \change_inserted 1075283030 1597699924
31518 \begin_inset Flex Code
31521 \begin_layout Plain Layout
31523 \change_inserted 1075283030 1597699924
31532 \begin_inset Flex Code
31535 \begin_layout Plain Layout
31537 \change_inserted 1075283030 1597699924
31538 block, paragraph, inline
31545 ] The new-line policy for this tag, see Section
31546 \begin_inset space ~
31550 \begin_inset CommandInset ref
31552 reference "subsec:DocBook-New-line-policy"
31565 \begin_layout Description
31567 \change_inserted -970929547 1515110832
31568 \begin_inset Flex Code
31571 \begin_layout Plain Layout
31573 \change_inserted -970929547 1515110822
31582 \begin_inset Flex Code
31585 \begin_layout Plain Layout
31587 \change_inserted -970929547 1515110811
31595 ] Specifies attribute information to be output with the outer tag, replacing
31597 \begin_inset Quotes eld
31601 \begin_inset Flex Code
31604 \begin_layout Plain Layout
31606 \change_inserted -970929547 1515110845
31615 \begin_inset Quotes erd
31618 in the example above.
31619 This information can be used in further processing of the DocBook files.
31623 \begin_layout Description
31625 \change_inserted -970929547 1515110917
31626 \begin_inset Flex Code
31629 \begin_layout Plain Layout
31631 \change_inserted -970929547 1515110826
31640 \begin_inset Flex Code
31643 \begin_layout Plain Layout
31645 \change_inserted -970929547 1515110811
31653 ] The tag to be used for the wrapper tag around the inset, replacing
31654 \begin_inset Quotes eld
31658 \begin_inset Flex Code
31661 \begin_layout Plain Layout
31663 \change_inserted -970929547 1515110842
31672 \begin_inset Quotes erd
31675 in the example above.
31677 \begin_inset Flex Code
31680 \begin_layout Plain Layout
31682 \change_inserted -970929547 1515110811
31690 , indicating that there is no wrapper tag: tag and content are directly
31692 \change_inserted 1075283030 1597699929
31696 \begin_layout Description
31698 \change_inserted 1075283030 1597699929
31699 \begin_inset Flex Code
31702 \begin_layout Plain Layout
31704 \change_inserted 1075283030 1597699932
31705 DocBookWrapperTagType
31713 \begin_inset Flex Code
31716 \begin_layout Plain Layout
31718 \change_inserted 1075283030 1597699929
31719 block, paragraph, inline
31726 ] The new-line policy for this tag, see Section
31727 \begin_inset space ~
31731 \begin_inset CommandInset ref
31733 reference "subsec:DocBook-New-line-policy"
31746 \begin_layout Subsection
31748 \change_inserted -970929547 1515110040
31752 \begin_layout Standard
31754 \change_inserted -970929547 1496611700
31755 The DocBook output for floats too can be controlled by layout information.
31756 The output has the following form:
31759 \begin_layout LyX-Code
31761 \change_inserted -970929547 1515109700
31765 \begin_layout LyX-Code
31767 \change_inserted -970929547 1515110138
31768 Contents of the float as DocBook.
31771 \begin_layout LyX-Code
31773 \change_inserted -970929547 1496610966
31777 \begin_layout Standard
31779 \change_inserted -970929547 1496611715
31780 The caption, if there is one, is a separate inset and will be output as
31785 \begin_layout Description
31787 \change_inserted -970929547 1515110033
31788 \begin_inset Flex Code
31791 \begin_layout Plain Layout
31793 \change_inserted -970929547 1515109702
31802 \begin_inset Flex Code
31805 \begin_layout Plain Layout
31807 \change_inserted -970929547 1496610966
31815 ] Specifies attribute information to be output with the main tag, replacing
31817 \begin_inset Quotes eld
31821 \begin_inset Flex Code
31824 \begin_layout Plain Layout
31826 \change_inserted -970929547 1515110035
31835 \begin_inset Quotes erd
31838 in the example above.
31839 This information can be used in further processing of the DocBook files.
31843 \begin_layout Description
31845 \change_inserted -970929547 1515110157
31846 \begin_inset Flex Code
31849 \begin_layout Plain Layout
31851 \change_inserted -970929547 1496611782
31860 \begin_inset Flex Code
31863 \begin_layout Plain Layout
31865 \change_inserted -970929547 1496610966
31873 ] The tag to be used for this float, replacing
31874 \begin_inset Quotes eld
31878 \begin_inset Flex Code
31881 \begin_layout Plain Layout
31883 \change_inserted -970929547 1496610966
31892 \begin_inset Quotes erd
31895 in the example above.
31896 The default is the name of the float and always needs to be changed, as
31897 DocBook provides no generic float tag.
31900 \begin_layout Subsection
31902 \change_inserted -970929547 1515110157
31903 Bibliography formatting
31906 \begin_layout Standard
31908 \change_deleted 1075283030 1597699984
31910 \change_inserted 1075283030 1597699985
31912 \change_inserted -970929547 1515110187
31914 \change_deleted 1075283030 1597699987
31916 \change_inserted 1075283030 1597699987
31918 \change_inserted -970929547 1515110187
31919 cannot be formatted: all fields are always output in the database-like
31920 DocBook format (equivalent to a BibTeX file)
31921 \change_inserted 1075283030 1597700117
31923 \begin_inset Flex Code
31926 \begin_layout Plain Layout
31928 \change_inserted 1075283030 1597700120
31937 \change_inserted -970929547 1515110187
31939 \change_inserted 1075283030 1597700092
31943 \begin_layout Standard
31945 \change_inserted 1075283030 1597700112
31946 When the bibliographic entries are manually inserted into the LyX document
31947 as Bibliography Items, the user deals with formatting themself: there is
31948 no attempt of parsing what the user wrote, the string is directly used
31950 \begin_inset Flex Code
31953 \begin_layout Plain Layout
31955 \change_inserted 1075283030 1597700076
31969 \begin_layout Chapter
31970 Including External Material
31971 \begin_inset CommandInset label
31973 name "chap:Including-External-Material"
31980 \begin_layout Standard
31981 \begin_inset Box Shadowbox
31991 height_special "totalheight"
31996 backgroundcolor "none"
31999 \begin_layout Plain Layout
32000 WARNING: This portion of the documentation has not been updated for some
32002 We certainly hope that it is still accurate, but there are no guarantees.
32010 \begin_layout Standard
32011 The use of material from sources external to \SpecialChar LyX
32012 is covered in detail in the
32018 This part of the manual covers what needs to happen behind the scenes for
32019 new sorts of material to be included.
32022 \begin_layout Section
32026 \begin_layout Standard
32027 The external material feature is based on the concept of a
32032 A template is a specification of how \SpecialChar LyX
32033 should interface with a certain kind
32035 As bundled, \SpecialChar LyX
32036 comes with predefined templates for Xfig figures, various
32037 raster format images, chess diagrams, and LilyPond music notation.
32038 You can check the actual list by using the menu
32039 \begin_inset Flex Noun
32042 \begin_layout Plain Layout
32043 Insert\SpecialChar menuseparator
32044 File\SpecialChar menuseparator
32051 Furthermore, it is possible to roll your own template to support a specific
32053 Later we'll describe in more detail what is involved, and hopefully you
32054 will submit all the templates you create so we can include them in a later
32059 \begin_layout Standard
32060 Another basic idea of the external material feature is to distinguish between
32061 the original file that serves as a base for final material and the produced
32062 file that is included in your exported or printed document.
32063 For example, consider the case of a figure produced with
32064 \begin_inset Flex Code
32067 \begin_layout Plain Layout
32074 The Xfig application itself works on an original file with the
32075 \begin_inset Flex Code
32078 \begin_layout Plain Layout
32085 Within Xfig, you create and change your figure, and when you are done,
32087 \begin_inset Flex Code
32090 \begin_layout Plain Layout
32097 When you want to include the figure in your document, you invoke
32098 \begin_inset Flex Code
32101 \begin_layout Plain Layout
32107 in order to create a PostScript file that can readily be included in your
32111 \begin_inset Flex Code
32114 \begin_layout Plain Layout
32120 file is the original file, and the PostScript file is the produced file.
32123 \begin_layout Standard
32124 This distinction is important in order to allow updating of the material
32125 while you are in the process of writing the document.
32126 Furthermore, it provides us with the flexibility that is needed to support
32127 multiple export formats.
32128 For instance, in the case of a plain text file, it is not exactly an award-winn
32129 ing idea to include the figure as raw PostScript.
32130 Instead, you would either prefer to just include a reference to the figure
32131 or try to invoke some graphics to ASCII converter to make the final result
32132 look similar to the real graphics.
32133 The external material management allows you to do this, because it is parametri
32134 zed on the different export formats that \SpecialChar LyX
32138 \begin_layout Standard
32139 Besides supporting the production of different products according to the
32140 exported format, it supports tight integration with editing and viewing
32142 In the case of an Xfig figure, you are able to invoke Xfig on the original
32143 file with a single click from within the external material dialog in \SpecialChar LyX
32145 and also preview the produced PostScript file with Ghostview with another
32147 No more fiddling around with the command line and/or file browsers to locate
32148 and manipulate the original or produced files.
32149 In this way, you are finally able to take full advantage of the many different
32150 applications that are relevant to use when you write your documents, and
32151 ultimately be more productive.
32154 \begin_layout Section
32155 The external template configuration files
32158 \begin_layout Standard
32159 It is relatively easy to add custom external template definitions to \SpecialChar LyX
32161 However, be aware that doing this in an careless manner most probably
32165 introduce an easily exploitable security hole.
32166 So before you do this, please read the discussion about security in
32167 \begin_inset CommandInset ref
32169 reference "sec:Security-discussion"
32176 \begin_layout Standard
32177 Having said that, we encourage you to submit any interesting templates that
32182 \begin_layout Standard
32183 The external templates are defined in the
32184 \begin_inset Flex Code
32187 \begin_layout Plain Layout
32193 files that are stored in the
32194 \begin_inset Flex Code
32197 \begin_layout Plain Layout
32198 LyXDir/lib/xtemplates/
32204 Each template is defined in a file of its own.
32205 You can place your own templates in
32206 \begin_inset Flex Code
32209 \begin_layout Plain Layout
32210 UserDir/xtemplates/
32215 or copy existing templates to that directory in order to modify them.
32218 \begin_layout Standard
32219 A typical template looks like this:
32222 \begin_layout LyX-Code
32226 \begin_layout LyX-Code
32227 GuiName "XFig: $$AbsOrRelPathParent$$Basename"
32230 \begin_layout LyX-Code
32234 \begin_layout LyX-Code
32238 \begin_layout LyX-Code
32242 \begin_layout LyX-Code
32246 \begin_layout LyX-Code
32250 \begin_layout LyX-Code
32251 AutomaticProduction true
32254 \begin_layout LyX-Code
32258 \begin_layout LyX-Code
32262 \begin_layout LyX-Code
32266 \begin_layout LyX-Code
32267 TransformCommand Rotate RotationLatexCommand
32270 \begin_layout LyX-Code
32271 TransformCommand Resize ResizeLatexCommand
32274 \begin_layout LyX-Code
32275 Product "$$RotateFront$$ResizeFront
32278 \begin_layout LyX-Code
32283 input{$$AbsOrRelPathMaster$$Basename.pstex_t}
32286 \begin_layout LyX-Code
32287 $$ResizeBack$$RotateBack"
32290 \begin_layout LyX-Code
32294 \begin_layout LyX-Code
32295 UpdateResult "$$AbsPath$$Basename.pstex_t"
32298 \begin_layout LyX-Code
32299 Requirement "graphicx"
32302 \begin_layout LyX-Code
32303 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
32306 \begin_layout LyX-Code
32307 ReferencedFile latex "$$AbsPath$$Basename.eps"
32310 \begin_layout LyX-Code
32311 ReferencedFile dvi "$$AbsPath$$Basename.eps"
32314 \begin_layout LyX-Code
32318 \begin_layout LyX-Code
32322 \begin_layout LyX-Code
32323 TransformCommand Rotate RotationLatexCommand
32326 \begin_layout LyX-Code
32327 TransformCommand Resize ResizeLatexCommand
32330 \begin_layout LyX-Code
32331 Product "$$RotateFront$$ResizeFront
32334 \begin_layout LyX-Code
32339 input{$$AbsOrRelPathMaster$$Basename.pdftex_t}
32342 \begin_layout LyX-Code
32343 $$ResizeBack$$RotateBack"
32346 \begin_layout LyX-Code
32347 UpdateFormat pdftex
32350 \begin_layout LyX-Code
32351 UpdateResult "$$AbsPath$$Basename.pdftex_t"
32354 \begin_layout LyX-Code
32355 Requirement "graphicx"
32358 \begin_layout LyX-Code
32359 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pdftex_t"
32362 \begin_layout LyX-Code
32363 ReferencedFile latex "$$AbsPath$$Basename.pdf"
32366 \begin_layout LyX-Code
32370 \begin_layout LyX-Code
32374 \begin_layout LyX-Code
32375 Product "[XFig: $$FName]"
32378 \begin_layout LyX-Code
32382 \begin_layout LyX-Code
32386 \begin_layout LyX-Code
32387 Product "<graphic fileref=
32389 "$$AbsOrRelPathMaster$$Basename.eps
32394 \begin_layout LyX-Code
32398 \begin_layout LyX-Code
32402 \begin_layout LyX-Code
32403 UpdateResult "$$AbsPath$$Basename.eps"
32406 \begin_layout LyX-Code
32407 ReferencedFile docbook "$$AbsPath$$Basename.eps"
32410 \begin_layout LyX-Code
32411 ReferencedFile docbook-xml "$$AbsPath$$Basename.eps"
32414 \begin_layout LyX-Code
32418 \begin_layout LyX-Code
32422 \begin_layout Standard
32423 As you can see, the template is enclosed in
32424 \begin_inset Flex Code
32427 \begin_layout Plain Layout
32435 \begin_inset Flex Code
32438 \begin_layout Plain Layout
32445 It contains a header specifying some general settings and, for each supported
32446 primary document file format, a section
32447 \begin_inset Flex Code
32450 \begin_layout Plain Layout
32458 \begin_inset Flex Code
32461 \begin_layout Plain Layout
32470 \begin_layout Subsection
32471 The template header
32474 \begin_layout Description
32475 \begin_inset Flex Code
32478 \begin_layout Plain Layout
32479 AutomaticProduction
32480 \begin_inset space ~
32488 Whether the file represented by the template must be generated by \SpecialChar LyX
32490 This command must occur exactly once.
32493 \begin_layout Description
32494 \begin_inset Flex Code
32497 \begin_layout Plain Layout
32499 \begin_inset space ~
32507 A glob pattern that is used in the file dialog to filter out the desired
32509 If there is more than one possible file extension (e.
32510 \begin_inset space \thinspace{}
32514 \begin_inset space \space{}
32518 \begin_inset Flex Code
32521 \begin_layout Plain Layout
32528 \begin_inset Flex Code
32531 \begin_layout Plain Layout
32537 ), use something like
32538 \begin_inset Flex Code
32541 \begin_layout Plain Layout
32548 This command must occur exactly once.
32551 \begin_layout Description
32552 \begin_inset Flex Code
32555 \begin_layout Plain Layout
32557 \begin_inset space ~
32565 The text that is displayed on the button.
32566 This command must occur exactly once.
32569 \begin_layout Description
32570 \begin_inset Flex Code
32573 \begin_layout Plain Layout
32575 \begin_inset space ~
32579 \begin_inset space ~
32587 The help text that is used in the External dialog.
32588 Provide enough information to explain to the user just what the template
32589 can provide him with.
32590 This command must occur exactly once.
32593 \begin_layout Description
32594 \begin_inset Flex Code
32597 \begin_layout Plain Layout
32599 \begin_inset space ~
32607 The file format of the original file.
32608 This must be the name of a format that is known to \SpecialChar LyX
32610 \begin_inset CommandInset ref
32612 reference "sec:Formats"
32618 \begin_inset Quotes eld
32622 \begin_inset Flex Code
32625 \begin_layout Plain Layout
32632 \begin_inset Quotes erd
32635 if the template can handle original files of more than one format.
32637 will attempt to interrogate the file itself in order to deduce its format
32639 This command must occur exactly once.
32642 \begin_layout Description
32643 \begin_inset Flex Code
32646 \begin_layout Plain Layout
32648 \begin_inset space ~
32656 A unique name for the template.
32657 It must not contain substitution macros (see below).
32660 \begin_layout Description
32661 \begin_inset Flex Code
32664 \begin_layout Plain Layout
32666 \begin_inset space ~
32669 Rotate|Resize|Clip|Extra
32674 This command specifies which transformations are supported by this template.
32675 It may occur zero or more times.
32676 This command enables the corresponding tabs in the external dialog.
32678 \begin_inset Flex Code
32681 \begin_layout Plain Layout
32687 command must have either a corresponding
32688 \begin_inset Flex Code
32691 \begin_layout Plain Layout
32698 \begin_inset Flex Code
32701 \begin_layout Plain Layout
32708 \begin_inset Flex Code
32711 \begin_layout Plain Layout
32718 Otherwise the transformation will not be supported by that format.
32721 \begin_layout Subsection
32725 \begin_layout Description
32726 \begin_inset Flex Code
32729 \begin_layout Plain Layout
32731 \begin_inset space ~
32734 LaTeX|PDFLaTeX|PlainText|DocBook|XHTML
32739 The primary document file format that this format definition is for.
32740 Not every template has a sensible representation in all document file formats.
32741 Please define nevertheless a
32742 \begin_inset Flex Code
32745 \begin_layout Plain Layout
32751 section for all templates.
32752 Use a dummy text when no representation is available.
32753 Then you can at least see a reference to the external material in the exported
32757 \begin_layout Description
32758 \begin_inset Flex Code
32761 \begin_layout Plain Layout
32763 \begin_inset space ~
32767 \begin_inset space ~
32775 This command defines an additional macro
32776 \begin_inset Flex Code
32779 \begin_layout Plain Layout
32785 for substitution in
32786 \begin_inset Flex Code
32789 \begin_layout Plain Layout
32797 \begin_inset Flex Code
32800 \begin_layout Plain Layout
32806 itself may contain substitution macros.
32807 The advantage over using
32808 \begin_inset Flex Code
32811 \begin_layout Plain Layout
32818 \begin_inset Flex Code
32821 \begin_layout Plain Layout
32827 is that the substituted value of
32828 \begin_inset Flex Code
32831 \begin_layout Plain Layout
32837 is sanitized so that it is a valid optional argument in the document format.
32838 This command may occur zero or more times.
32841 \begin_layout Description
32842 \begin_inset Flex Code
32845 \begin_layout Plain Layout
32847 \begin_inset space ~
32855 The text that is inserted in the exported document.
32856 This is actually the most important command and can be quite complex.
32857 This command must occur exactly once.
32860 \begin_layout Description
32861 \begin_inset Flex Code
32864 \begin_layout Plain Layout
32866 \begin_inset space ~
32874 This command specifies a preamble snippet that will be included in the
32877 It has to be defined using
32878 \begin_inset Flex Code
32881 \begin_layout Plain Layout
32889 \begin_inset Flex Code
32892 \begin_layout Plain Layout
32899 This command may occur zero or more times.
32902 \begin_layout Description
32903 \begin_inset Flex Code
32906 \begin_layout Plain Layout
32908 \begin_inset space ~
32912 \begin_inset space ~
32920 This command denotes files that are created by the conversion process and
32921 are needed for a particular export format.
32922 If the filename is relative, it is interpreted relative to the master document.
32923 This command may be given zero or more times.
32926 \begin_layout Description
32927 \begin_inset Flex Code
32930 \begin_layout Plain Layout
32932 \begin_inset space ~
32940 The name of a required \SpecialChar LaTeX
32942 The package is included via
32943 \begin_inset Flex Code
32946 \begin_layout Plain Layout
32954 in the \SpecialChar LaTeX
32956 This command may occur zero or more times.
32959 \begin_layout Description
32960 \begin_inset Flex Code
32963 \begin_layout Plain Layout
32965 \begin_inset space ~
32969 \begin_inset space ~
32972 RotationLatexCommand
32977 This command specifies that the built in \SpecialChar LaTeX
32978 command should be used for rotation.
32979 This command may occur once or not at all.
32982 \begin_layout Description
32983 \begin_inset Flex Code
32986 \begin_layout Plain Layout
32988 \begin_inset space ~
32992 \begin_inset space ~
33000 This command specifies that the built in \SpecialChar LaTeX
33001 command should be used for resizing.
33002 This command may occur once or not at all.
33005 \begin_layout Description
33006 \begin_inset Flex Code
33009 \begin_layout Plain Layout
33011 \begin_inset space ~
33015 \begin_inset space ~
33018 RotationLatexOption
33023 This command specifies that rotation is done via an optional argument.
33024 This command may occur once or not at all.
33027 \begin_layout Description
33028 \begin_inset Flex Code
33031 \begin_layout Plain Layout
33033 \begin_inset space ~
33037 \begin_inset space ~
33045 This command specifies that resizing is done via an optional argument.
33046 This command may occur once or not at all.
33049 \begin_layout Description
33050 \begin_inset Flex Code
33053 \begin_layout Plain Layout
33055 \begin_inset space ~
33059 \begin_inset space ~
33067 This command specifies that clipping is done via an optional argument.
33068 This command may occur once or not at all.
33071 \begin_layout Description
33072 \begin_inset Flex Code
33075 \begin_layout Plain Layout
33077 \begin_inset space ~
33081 \begin_inset space ~
33089 This command specifies that an extra optional argument is used.
33090 This command may occur once or not at all.
33093 \begin_layout Description
33094 \begin_inset Flex Code
33097 \begin_layout Plain Layout
33099 \begin_inset space ~
33107 The file format of the converted file.
33108 This must be the name of a format that is known to \SpecialChar LyX
33110 \begin_inset Flex Noun
33113 \begin_layout Plain Layout
33114 Tools\SpecialChar menuseparator
33115 Preferences\SpecialChar menuseparator
33116 File Handling\SpecialChar menuseparator
33123 This command must occur exactly once.
33124 If the resulting file format is PDF, you need to specify the format
33125 \begin_inset Flex Code
33128 \begin_layout Plain Layout
33135 This is the PDF format used for including graphics.
33136 The other defined PDF formats are for document export.
33139 \begin_layout Description
33140 \begin_inset Flex Code
33143 \begin_layout Plain Layout
33145 \begin_inset space ~
33153 The file name of the converted file.
33154 The file name must be absolute.
33155 This command must occur exactly once.
33158 \begin_layout Subsection
33159 Preamble definitions
33162 \begin_layout Standard
33163 The external template configuration file may contain additional preamble
33164 definitions enclosed by
33165 \begin_inset Flex Code
33168 \begin_layout Plain Layout
33176 \begin_inset Flex Code
33179 \begin_layout Plain Layout
33186 They can be used by the templates in the
33187 \begin_inset Flex Code
33190 \begin_layout Plain Layout
33199 \begin_layout Section
33200 The substitution mechanism
33203 \begin_layout Standard
33204 When the external material facility invokes an external program, it is done
33205 on the basis of a command defined in the template configuration file.
33206 These commands can contain various macros that are expanded before execution.
33207 Execution always take place in the directory of the containing document.
33210 \begin_layout Standard
33211 Also, whenever external material is to be displayed, the name will be produced
33212 by the substitution mechanism, and most other commands in the template
33213 definition support substitution as well.
33216 \begin_layout Standard
33217 The available macros are the following:
33220 \begin_layout Description
33221 \begin_inset Flex Code
33224 \begin_layout Plain Layout
33225 $$AbsOrRelPathMaster
33230 The file path, absolute or relative to the master \SpecialChar LyX
33234 \begin_layout Description
33235 \begin_inset Flex Code
33238 \begin_layout Plain Layout
33239 $$AbsOrRelPathParent
33244 The file path, absolute or relative to the \SpecialChar LyX
33248 \begin_layout Description
33249 \begin_inset Flex Code
33252 \begin_layout Plain Layout
33258 The absolute file path.
33261 \begin_layout Description
33262 \begin_inset Flex Code
33265 \begin_layout Plain Layout
33271 The filename without path and without the extension.
33274 \begin_layout Description
33275 \begin_inset Flex Code
33278 \begin_layout Plain Layout
33280 \begin_inset Quotes eld
33284 \begin_inset Quotes erd
33292 This macro will expand to the contents of the file with the name
33293 \begin_inset Flex Code
33296 \begin_layout Plain Layout
33305 \begin_layout Description
33306 \begin_inset Flex Code
33309 \begin_layout Plain Layout
33315 The file extension (including the dot).
33318 \begin_layout Description
33319 \begin_inset Flex Code
33322 \begin_layout Plain Layout
33328 This will be the string
33329 \begin_inset Quotes eld
33333 \begin_inset Quotes erd
33336 if the file is in JPEG format, otherwise it will be the string
33337 \begin_inset Quotes eld
33341 \begin_inset Quotes erd
33345 This is useful to avoid uneeded conversions for output formats that support
33346 both PNG and JPEG fomats.
33347 The predefined RasterImage template uses this macro for the pdf\SpecialChar TeX
33352 \begin_layout Description
33353 \begin_inset Flex Code
33356 \begin_layout Plain Layout
33362 The filename of the file specified in the external material dialog.
33363 This is either an absolute name, or it is relative to the \SpecialChar LyX
33367 \begin_layout Description
33368 \begin_inset Flex Code
33371 \begin_layout Plain Layout
33378 \begin_inset Flex Code
33381 \begin_layout Plain Layout
33387 (absolute name or relative to the \SpecialChar LyX
33391 \begin_layout Description
33392 \begin_inset Flex Code
33395 \begin_layout Plain Layout
33401 The file path, relative to the master \SpecialChar LyX
33405 \begin_layout Description
33406 \begin_inset Flex Code
33409 \begin_layout Plain Layout
33415 The file path, relative to the \SpecialChar LyX
33419 \begin_layout Description
33420 \begin_inset Flex Code
33423 \begin_layout Plain Layout
33429 This macro will expand to the absolute path of the system directory.
33430 This is typically used to point to the various helper scripts that are
33431 bundled with \SpecialChar LyX
33435 \begin_layout Description
33436 \begin_inset Flex Code
33439 \begin_layout Plain Layout
33445 A name and full path to a temporary file which will be automatically deleted
33446 whenever the containing document is closed, or the external material insertion
33450 \begin_layout Standard
33451 All path macros contain a trailing directory separator, so you can construct
33453 \begin_inset space \thinspace{}
33457 \begin_inset space \space{}
33460 the absolute filename with
33461 \begin_inset Flex Code
33464 \begin_layout Plain Layout
33465 $$AbsPath$$Basename$$Extension
33473 \begin_layout Standard
33474 The macros above are substituted in all commands unless otherwise noted.
33476 \begin_inset Flex Code
33479 \begin_layout Plain Layout
33485 supports additionally the following substitutions if they are enabled by
33487 \begin_inset Flex Code
33490 \begin_layout Plain Layout
33497 \begin_inset Flex Code
33500 \begin_layout Plain Layout
33509 \begin_layout Description
33510 \begin_inset Flex Code
33513 \begin_layout Plain Layout
33519 The front part of the resize command.
33522 \begin_layout Description
33523 \begin_inset Flex Code
33526 \begin_layout Plain Layout
33532 The back part of the resize command.
33535 \begin_layout Description
33536 \begin_inset Flex Code
33539 \begin_layout Plain Layout
33545 The front part of the rotation command.
33548 \begin_layout Description
33549 \begin_inset Flex Code
33552 \begin_layout Plain Layout
33558 The back part of the rotation command.
33561 \begin_layout Standard
33562 The value string of the
33563 \begin_inset Flex Code
33566 \begin_layout Plain Layout
33572 command supports additionally the following substitutions if they are enabled
33574 \begin_inset Flex Code
33577 \begin_layout Plain Layout
33584 \begin_inset Flex Code
33587 \begin_layout Plain Layout
33596 \begin_layout Description
33597 \begin_inset Flex Code
33600 \begin_layout Plain Layout
33609 \begin_layout Description
33610 \begin_inset Flex Code
33613 \begin_layout Plain Layout
33622 \begin_layout Description
33623 \begin_inset Flex Code
33626 \begin_layout Plain Layout
33635 \begin_layout Description
33636 \begin_inset Flex Code
33639 \begin_layout Plain Layout
33645 The rotation option.
33648 \begin_layout Standard
33649 You may ask why there are so many path macros.
33650 There are mainly two reasons:
33653 \begin_layout Enumerate
33654 Relative and absolute file names should remain relative or absolute, respectivel
33656 Users may have reasons to prefer either form.
33657 Relative names are useful for portable documents that should work on different
33658 machines, for example.
33659 Absolute names may be required by some programs.
33662 \begin_layout Enumerate
33664 treats relative file names differently than \SpecialChar LyX
33665 and other programs in nested
33667 For \SpecialChar LyX
33668 , a relative file name is always relative to the document that contains
33670 For \SpecialChar LaTeX
33671 , it is always relative to the master document.
33672 These two definitions are identical if you have only one document, but
33673 differ if you have a master document that includes part documents.
33674 That means that relative filenames must be transformed when presented to
33677 Fortunately \SpecialChar LyX
33678 does this automatically for you if you choose the right macros.
33681 \begin_layout Standard
33682 So which path macro should be used in new template definitions? The rule
33686 \begin_layout Itemize
33688 \begin_inset Flex Code
33691 \begin_layout Plain Layout
33697 if an absolute path is required.
33700 \begin_layout Itemize
33702 \begin_inset Flex Code
33705 \begin_layout Plain Layout
33706 $$AbsOrRelPathMaster
33711 if the substituted string is some kind of \SpecialChar LaTeX
33715 \begin_layout Itemize
33717 \begin_inset Flex Code
33720 \begin_layout Plain Layout
33721 $$AbsOrRelPathParent
33726 in order to preserve the user's choice.
33729 \begin_layout Standard
33730 There are special cases where this rule does not work and e.
33731 \begin_inset space \thinspace{}
33735 \begin_inset space \space{}
33738 relative names are needed, but normally it will work just fine.
33739 One example for such a case is the command
33740 \begin_inset Flex Code
33743 \begin_layout Plain Layout
33744 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
33749 in the XFig template above: We can't use the absolute name because the
33751 \begin_inset Flex Code
33754 \begin_layout Plain Layout
33760 files needs the relative name in order to rewrite the file content.
33763 \begin_layout Section
33764 Security discussion
33765 \begin_inset CommandInset label
33767 name "sec:Security-discussion"
33774 \begin_layout Standard
33775 The external material feature interfaces with a lot of external programs
33776 and does so automatically, so we have to consider the security implications
33778 In particular, since you have the option of including your own filenames
33779 and/or parameter strings and those are expanded into a command, it seems
33780 that it would be possible to create a malicious document which executes
33781 arbitrary commands when a user views or prints the document.
33782 This is something we definitely want to avoid.
33785 \begin_layout Standard
33786 However, since the external program commands are specified in the template
33787 configuration file only, there are no security issues if \SpecialChar LyX
33788 is properly configure
33789 d with safe templates only.
33790 This is so because the external programs are invoked with the
33791 \begin_inset Flex Code
33794 \begin_layout Plain Layout
33800 -system call rather than the
33801 \begin_inset Flex Code
33804 \begin_layout Plain Layout
33810 system-call, so it's not possible to execute arbitrary commands from the
33811 filename or parameter section via the shell.
33814 \begin_layout Standard
33815 This also implies that you are restricted in what command strings you can
33816 use in the external material templates.
33817 In particular, pipes and redirection are not readily available.
33818 This has to be so if \SpecialChar LyX
33819 should remain safe.
33820 If you want to use some of the shell features, you should write a safe
33821 script to do this in a controlled manner, and then invoke the script from
33822 the command string.
33826 \begin_layout Standard
33827 It is possible to design a template that interacts directly with the shell,
33828 but since this would allow a malicious user to execute arbitrary commands
33829 by writing clever filenames and/or parameters, we generally recommend that
33830 you only use safe scripts that work with the
33831 \begin_inset Flex Code
33834 \begin_layout Plain Layout
33840 system call in a controlled manner.
33841 Of course, for use in a controlled environment, it can be tempting to just
33842 fall back to use ordinary shell scripts.
33843 If you do so, be aware that you
33847 provide an easily exploitable security hole in your system.
33848 Of course it stands to reason that such unsafe templates will never be
33849 included in the standard \SpecialChar LyX
33850 distribution, although we do encourage people
33851 to submit new templates in the open source tradition.
33852 But \SpecialChar LyX
33853 as shipped from the official distribution channels will never have
33857 \begin_layout Standard
33858 Including external material provides a lot of power, and you have to be
33859 careful not to introduce security hazards with this power.
33860 A subtle error in a single line in an innocent looking script can open
33861 the door to huge security problems.
33862 So if you do not fully understand the issues, we recommend that you consult
33863 a knowledgeable security professional or the \SpecialChar LyX
33864 development team if you have
33865 any questions about whether a given template is safe or not.
33866 And do this before you use it in an uncontrolled environment.
33869 \begin_layout Chapter
33871 List of supported \SpecialChar LyX
33872 functions to be used in layouts
33873 \begin_inset CommandInset label
33875 name "chap:List-of-functions"
33882 \begin_layout Standard
33884 \begin_inset Tabular
33885 <lyxtabular version="3" rows="11" columns="8">
33886 <features tabularvalignment="middle">
33887 <column alignment="left" valignment="top">
33888 <column alignment="left" valignment="top">
33889 <column alignment="left" valignment="top">
33890 <column alignment="left" valignment="top">
33891 <column alignment="left" valignment="top">
33892 <column alignment="left" valignment="top">
33893 <column alignment="left" valignment="top">
33894 <column alignment="left" valignment="top">
33896 <cell alignment="left" valignment="top" usebox="none">
33899 \begin_layout Plain Layout
33905 <cell alignment="left" valignment="top" usebox="none">
33908 \begin_layout Plain Layout
33914 <cell alignment="left" valignment="top" usebox="none">
33917 \begin_layout Plain Layout
33923 <cell alignment="left" valignment="top" usebox="none">
33926 \begin_layout Plain Layout
33932 <cell alignment="center" valignment="top" usebox="none">
33935 \begin_layout Plain Layout
33941 <cell alignment="center" valignment="top" usebox="none">
33944 \begin_layout Plain Layout
33950 <cell alignment="center" valignment="top" usebox="none">
33953 \begin_layout Plain Layout
33959 <cell alignment="center" valignment="top" usebox="none">
33962 \begin_layout Plain Layout
33970 <cell alignment="left" valignment="top" usebox="none">
33973 \begin_layout Plain Layout
33979 <cell alignment="left" valignment="top" usebox="none">
33982 \begin_layout Plain Layout
33988 <cell alignment="left" valignment="top" usebox="none">
33991 \begin_layout Plain Layout
33997 <cell alignment="left" valignment="top" usebox="none">
34000 \begin_layout Plain Layout
34006 <cell alignment="center" valignment="top" usebox="none">
34009 \begin_layout Plain Layout
34015 <cell alignment="center" valignment="top" usebox="none">
34018 \begin_layout Plain Layout
34024 <cell alignment="center" valignment="top" usebox="none">
34027 \begin_layout Plain Layout
34033 <cell alignment="center" valignment="top" usebox="none">
34036 \begin_layout Plain Layout
34044 <cell alignment="left" valignment="top" usebox="none">
34047 \begin_layout Plain Layout
34053 <cell alignment="left" valignment="top" usebox="none">
34056 \begin_layout Plain Layout
34062 <cell alignment="left" valignment="top" usebox="none">
34065 \begin_layout Plain Layout
34071 <cell alignment="left" valignment="top" usebox="none">
34074 \begin_layout Plain Layout
34080 <cell alignment="center" valignment="top" usebox="none">
34083 \begin_layout Plain Layout
34089 <cell alignment="center" valignment="top" usebox="none">
34092 \begin_layout Plain Layout
34098 <cell alignment="center" valignment="top" usebox="none">
34101 \begin_layout Plain Layout
34107 <cell alignment="center" valignment="top" usebox="none">
34110 \begin_layout Plain Layout
34118 <cell alignment="left" valignment="top" usebox="none">
34121 \begin_layout Plain Layout
34127 <cell alignment="left" valignment="top" usebox="none">
34130 \begin_layout Plain Layout
34136 <cell alignment="left" valignment="top" usebox="none">
34139 \begin_layout Plain Layout
34145 <cell alignment="left" valignment="top" usebox="none">
34148 \begin_layout Plain Layout
34154 <cell alignment="center" valignment="top" usebox="none">
34157 \begin_layout Plain Layout
34163 <cell alignment="center" valignment="top" usebox="none">
34166 \begin_layout Plain Layout
34172 <cell alignment="center" valignment="top" usebox="none">
34175 \begin_layout Plain Layout
34181 <cell alignment="center" valignment="top" usebox="none">
34184 \begin_layout Plain Layout
34192 <cell alignment="left" valignment="top" usebox="none">
34195 \begin_layout Plain Layout
34201 <cell alignment="left" valignment="top" usebox="none">
34204 \begin_layout Plain Layout
34210 <cell alignment="left" valignment="top" usebox="none">
34213 \begin_layout Plain Layout
34219 <cell alignment="left" valignment="top" usebox="none">
34222 \begin_layout Plain Layout
34228 <cell alignment="center" valignment="top" usebox="none">
34231 \begin_layout Plain Layout
34237 <cell alignment="center" valignment="top" usebox="none">
34240 \begin_layout Plain Layout
34246 <cell alignment="center" valignment="top" usebox="none">
34249 \begin_layout Plain Layout
34255 <cell alignment="center" valignment="top" usebox="none">
34258 \begin_layout Plain Layout
34266 <cell alignment="left" valignment="top" usebox="none">
34269 \begin_layout Plain Layout
34275 <cell alignment="left" valignment="top" usebox="none">
34278 \begin_layout Plain Layout
34284 <cell alignment="left" valignment="top" usebox="none">
34287 \begin_layout Plain Layout
34293 <cell alignment="left" valignment="top" usebox="none">
34296 \begin_layout Plain Layout
34302 <cell alignment="center" valignment="top" usebox="none">
34305 \begin_layout Plain Layout
34311 <cell alignment="center" valignment="top" usebox="none">
34314 \begin_layout Plain Layout
34320 <cell alignment="center" valignment="top" usebox="none">
34323 \begin_layout Plain Layout
34329 <cell alignment="center" valignment="top" usebox="none">
34332 \begin_layout Plain Layout
34340 <cell alignment="left" valignment="top" usebox="none">
34343 \begin_layout Plain Layout
34349 <cell alignment="left" valignment="top" usebox="none">
34352 \begin_layout Plain Layout
34358 <cell alignment="left" valignment="top" usebox="none">
34361 \begin_layout Plain Layout
34367 <cell alignment="left" valignment="top" usebox="none">
34370 \begin_layout Plain Layout
34376 <cell alignment="center" valignment="top" usebox="none">
34379 \begin_layout Plain Layout
34385 <cell alignment="center" valignment="top" usebox="none">
34388 \begin_layout Plain Layout
34394 <cell alignment="center" valignment="top" usebox="none">
34397 \begin_layout Plain Layout
34403 <cell alignment="center" valignment="top" usebox="none">
34406 \begin_layout Plain Layout
34414 <cell alignment="left" valignment="top" usebox="none">
34417 \begin_layout Plain Layout
34423 <cell alignment="left" valignment="top" usebox="none">
34426 \begin_layout Plain Layout
34432 <cell alignment="left" valignment="top" usebox="none">
34435 \begin_layout Plain Layout
34441 <cell alignment="left" valignment="top" usebox="none">
34444 \begin_layout Plain Layout
34450 <cell alignment="center" valignment="top" usebox="none">
34453 \begin_layout Plain Layout
34459 <cell alignment="center" valignment="top" usebox="none">
34462 \begin_layout Plain Layout
34468 <cell alignment="center" valignment="top" usebox="none">
34471 \begin_layout Plain Layout
34477 <cell alignment="center" valignment="top" usebox="none">
34480 \begin_layout Plain Layout
34488 <cell alignment="left" valignment="top" usebox="none">
34491 \begin_layout Plain Layout
34497 <cell alignment="left" valignment="top" usebox="none">
34500 \begin_layout Plain Layout
34506 <cell alignment="left" valignment="top" usebox="none">
34509 \begin_layout Plain Layout
34515 <cell alignment="left" valignment="top" usebox="none">
34518 \begin_layout Plain Layout
34524 <cell alignment="center" valignment="top" usebox="none">
34527 \begin_layout Plain Layout
34533 <cell alignment="center" valignment="top" usebox="none">
34536 \begin_layout Plain Layout
34542 <cell alignment="center" valignment="top" usebox="none">
34545 \begin_layout Plain Layout
34551 <cell alignment="center" valignment="top" usebox="none">
34554 \begin_layout Plain Layout
34562 <cell alignment="left" valignment="top" usebox="none">
34565 \begin_layout Plain Layout
34571 <cell alignment="left" valignment="top" usebox="none">
34574 \begin_layout Plain Layout
34580 <cell alignment="left" valignment="top" usebox="none">
34583 \begin_layout Plain Layout
34589 <cell alignment="left" valignment="top" usebox="none">
34592 \begin_layout Plain Layout
34598 <cell alignment="center" valignment="top" usebox="none">
34601 \begin_layout Plain Layout
34607 <cell alignment="center" valignment="top" usebox="none">
34610 \begin_layout Plain Layout
34616 <cell alignment="center" valignment="top" usebox="none">
34619 \begin_layout Plain Layout
34625 <cell alignment="center" valignment="top" usebox="none">
34628 \begin_layout Plain Layout
34636 <cell alignment="center" valignment="top" usebox="none">
34639 \begin_layout Plain Layout
34645 <cell alignment="center" valignment="top" usebox="none">
34648 \begin_layout Plain Layout
34654 <cell alignment="center" valignment="top" usebox="none">
34657 \begin_layout Plain Layout
34663 <cell alignment="center" valignment="top" usebox="none">
34666 \begin_layout Plain Layout
34672 <cell alignment="center" valignment="top" usebox="none">
34675 \begin_layout Plain Layout
34681 <cell alignment="center" valignment="top" usebox="none">
34684 \begin_layout Plain Layout
34690 <cell alignment="center" valignment="top" usebox="none">
34693 \begin_layout Plain Layout
34699 <cell alignment="center" valignment="top" usebox="none">
34702 \begin_layout Plain Layout
34716 \begin_layout Chapter
34717 Names of available colors to be used in layouts
34718 \begin_inset CommandInset label
34720 name "chap:Names-of-colors"
34727 \begin_layout Standard
34728 The colors listed below are the standard colors and those that you can adjust
34729 in the \SpecialChar LyX
34733 \begin_layout Section
34737 \begin_layout Standard
34738 The following are no real colors, but rather act on color definitions:
34741 \begin_layout Description
34742 ignore The color is ignored
34745 \begin_layout Description
34746 inherit The color is inherited
34749 \begin_layout Description
34762 No particular color – clear or default
34765 \begin_layout Section
34769 \begin_layout Standard
34770 These are fixed colors that cannot be customized
34771 \change_inserted -712698321 1607683177
34777 use these colors in layout definitions, since they will not work well with
34778 some color themes (such as dark themes)
34783 \begin_layout Description
34787 \begin_layout Description
34791 \begin_layout Description
34795 \begin_layout Description
34799 \begin_layout Description
34803 \begin_layout Description
34807 \begin_layout Description
34811 \begin_layout Description
34815 \begin_layout Description
34819 \begin_layout Description
34823 \begin_layout Description
34827 \begin_layout Description
34831 \begin_layout Description
34835 \begin_layout Description
34839 \begin_layout Description
34843 \begin_layout Description
34847 \begin_layout Description
34851 \begin_layout Description
34855 \begin_layout Description
34859 \begin_layout Section
34863 \begin_layout Standard
34864 These are the colors allocated to specific elements in
34867 arg "dialog-show prefs"
34873 \begin_layout Description
34874 added_space Added space color
34877 \begin_layout Description
34878 addedtext Added text color
34881 \begin_layout Description
34882 appendix Appendix marker color
34885 \begin_layout Description
34886 background Background color
34889 \begin_layout Description
34890 bottomarea Bottom area color
34893 \begin_layout Description
34894 branchlabel Label color for branches
34897 \begin_layout Description
34898 buttonbg Color used for button background
34901 \begin_layout Description
34902 buttonframe Color for inset button frames
34905 \begin_layout Description
34906 buttonhoverbg Color used for button background under focus
34909 \begin_layout Description
34910 changebar Changebar color
34913 \begin_layout Description
34914 changedtextauthor1 Changed text color author 1
34917 \begin_layout Description
34918 changedtextauthor2 Changed text color author 2
34921 \begin_layout Description
34922 changedtextauthor3 Changed text color author 3
34925 \begin_layout Description
34926 changedtextauthor4 Changed text color author 4
34929 \begin_layout Description
34930 changedtextauthor5 Changed text color author 5
34933 \begin_layout Description
34934 collapsible Collapsible insets text color
34937 \begin_layout Description
34938 collapsibleframe Collapsible insets framecolor
34941 \begin_layout Description
34942 command Text color for command insets
34945 \begin_layout Description
34946 commandbg Background color for command insets
34949 \begin_layout Description
34950 commandframe Frame color for command insets
34953 \begin_layout Description
34954 comment Label color for comments
34957 \begin_layout Description
34958 commentbg Background color of comments
34961 \begin_layout Description
34962 cursor Cursor color
34965 \begin_layout Description
34966 deletedtext Deleted text color
34969 \begin_layout Description
34970 deletedtextmodifier Deleted text modifying color
34973 \begin_layout Description
34974 depthbar Color for the depth bars in the margin
34977 \begin_layout Description
34978 eolmarker End of line marker color
34981 \begin_layout Description
34982 error Color of the \SpecialChar LaTeX
34986 \begin_layout Description
34987 footlabel Label color for footnotes
34990 \begin_layout Description
34991 foreground Foreground color
34994 \begin_layout Description
34995 graphicsbg Graphics inset background color
34998 \begin_layout Description
34999 greyedoutbg Background color of greyedout inset
35002 \begin_layout Description
35003 greyedoutlabel Label color for greyedout insets
35006 \begin_layout Description
35007 greyedouttext Color for greyedout inset text
35010 \begin_layout Description
35011 indexlabel Label color for index insets
35014 \begin_layout Description
35015 inlinecompletion Inline completion color
35018 \begin_layout Description
35019 insetbg Inset marker background color
35022 \begin_layout Description
35023 insetframe Inset marker frame color
35026 \begin_layout Description
35027 language Color for marking foreign language words
35030 \begin_layout Description
35031 latex Text color in \SpecialChar LaTeX
35035 \begin_layout Description
35036 listingsbg Background color of listings inset
35039 \begin_layout Description
35040 marginlabel Label color for margin notes
35043 \begin_layout Description
35044 math Math inset text color
35047 \begin_layout Description
35048 mathbg Math inset background color
35051 \begin_layout Description
35052 mathcorners Math inset frame color not under focus
35055 \begin_layout Description
35056 mathframe Math inset frame color under focus
35059 \begin_layout Description
35060 mathline Math line color
35063 \begin_layout Description
35064 mathmacrobg Macro math inset background color
35067 \begin_layout Description
35068 mathmacroblend Macro math blended color
35071 \begin_layout Description
35072 mathmacroframe Macro math frame color
35075 \begin_layout Description
35076 mathmacrohoverbg Macro math inset background color hovered
35079 \begin_layout Description
35080 mathmacrolabel Macro math label color
35083 \begin_layout Description
35084 mathmacronewarg Macro template color for new parameters
35087 \begin_layout Description
35088 mathmacrooldarg Macro template color for old parameters
35091 \begin_layout Description
35092 newpage New page color
35095 \begin_layout Description
35096 nonunique_inlinecompletion Inline completion color for the non-unique part
35099 \begin_layout Description
35100 note Label color for notes
35103 \begin_layout Description
35104 notebg Background color of notes
35107 \begin_layout Description
35108 pagebreak Page break/line break color
35111 \begin_layout Description
35112 paragraphmarker Color used for the pilcrow sign to mark the end of a paragraph
35115 \begin_layout Description
35116 phantomtext Text color for phantom insets
35119 \begin_layout Description
35120 preview The color used for previews
35123 \begin_layout Description
35124 previewframe Preview frame color
35127 \begin_layout Description
35128 regexpframe Color for regexp frame
35131 \begin_layout Description
35132 scroll Color that indicates when a row can be scrolled
35135 \begin_layout Description
35136 selection Background color of selected text
35139 \begin_layout Description
35140 selectiontext Foreground color of selected text
35143 \begin_layout Description
35144 shadedbg Background color of shaded box
35147 \begin_layout Description
35148 special Special chars text color
35151 \begin_layout Description
35152 tabularline Table line color
35155 \begin_layout Description
35156 tabularonoffline Table line color
35157 \change_inserted -712698321 1607682522
35161 \begin_layout Description
35163 \change_inserted -712698321 1607682563
35164 textlabel1 Color 1 of layout and custom inset labels
35167 \begin_layout Description
35169 \change_inserted -712698321 1607682565
35170 textlabel2 Color 2 of layout and custom inset labels
35173 \begin_layout Description
35175 \change_inserted -712698321 1607682568
35176 textlabel3 Color 3 of layout and custom inset labels
35181 \begin_layout Description
35182 urllabel Label color for URL insets
35185 \begin_layout Description
35186 urltext Color for URL inset text