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
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 \author -970929547 "Thibaut Cuvelier"
140 \author -712698321 "Jürgen Spitzmüller"
141 \author -495245474 "Jean-Marc Lasgouttes"
143 \author 232239728 "Owner"
144 \author 731793113 "Richard Kimberly Heck" rikiheck@lyx.org
145 \author 1075283030 "Thibaut"
151 Customizing \SpecialChar LyX
152 : Features for the Advanced User
156 by the \SpecialChar LyX
161 \begin_layout Plain Layout
163 If you have comments or error corrections, please send them to the \SpecialChar LyX
166 \begin_inset CommandInset href
168 target "lyx-docs@lists.lyx.org"
176 \begin_inset Quotes eld
180 \begin_inset Quotes erd
183 in the subject header, and please cc the current maintainer of this file,
184 Richard Heck <rgheck@comcast.net>.
190 \begin_inset Newline newline
194 \begin_inset Newline newline
200 \begin_layout Standard
201 \begin_inset CommandInset toc
202 LatexCommand tableofcontents
209 \begin_layout Standard
210 \begin_inset Note Note
213 \begin_layout Plain Layout
214 Please use change tracking when modifying this document.
215 This makes it easier for our translators to recognize things that have
216 been changed, and it helps the maintainer keep up-to-date with what's been
225 \begin_layout Chapter
229 \begin_layout Standard
230 This manual covers the customization features present in \SpecialChar LyX
232 In it, we discuss issues like keyboard shortcuts, screen previewing options,
233 printer options, sending commands to \SpecialChar LyX
234 via the \SpecialChar LyX
235 Server, internationalization,
236 installing new \SpecialChar LaTeX
237 classes and \SpecialChar LyX
239 We can't possibly hope to touch on everything you can change—our developers
240 add new features faster than we can document them—but we will explain the
241 most common customizations and hopefully point you in the right direction
242 for some of the more obscure ones.
245 \begin_layout Standard
246 \begin_inset Branch OutDated
250 \begin_layout Standard
251 Information from previous versions of this document that now seems to be
252 outdated is contained in the OutDated branch of this document.
253 By default, this information will not appear in the \SpecialChar LaTeX
262 \begin_layout Chapter
267 \begin_layout Standard
268 This chapter aims to help you to find your way through the \SpecialChar LyX
271 Before continuing to read this chapter, you should find out where your
273 library and user directories are by using
274 \begin_inset Flex Noun
277 \begin_layout Plain Layout
278 Help\SpecialChar menuseparator
289 The library directory is the place where \SpecialChar LyX
290 places its system-wide configuration
291 files; the user directory is where you can place your modified versions.
292 We will call the former
293 \begin_inset Flex Code
296 \begin_layout Plain Layout
303 \begin_inset Flex Noun
306 \begin_layout Plain Layout
312 in the remainder of this document.
316 \begin_layout Section
318 \begin_inset Flex Code
321 \begin_layout Plain Layout
330 \begin_layout Standard
331 \begin_inset Flex Code
334 \begin_layout Plain Layout
340 and its sub-directories contain a number of files
341 \change_deleted 232239728 1604787780
344 that can be used to customize \SpecialChar LyX
346 You can change many of these files from within \SpecialChar LyX
348 \begin_inset Flex Noun
351 \begin_layout Plain Layout
352 Tools\SpecialChar menuseparator
359 Most customization that you will want to do in \SpecialChar LyX
360 is possible through this
362 However, many other inner aspects of \SpecialChar LyX
363 can be customized by modifying the
365 \begin_inset Flex Code
368 \begin_layout Plain Layout
375 These files fall in different categories, described in the following subsection
379 \begin_layout Subsection
380 Automatically generated files
383 \begin_layout Standard
385 \begin_inset Flex Noun
388 \begin_layout Plain Layout
394 are generated when you configure \SpecialChar LyX
396 They contain various default values that are
397 \change_inserted 5863208 1604919565
398 automatically detected during reconfiguration.
399 \change_deleted 232239728 1604788241
400 guessed by inspection
402 In general, it is not a good idea to modify them, since they might be overwritt
406 \begin_layout Labeling
407 \labelwidthstring 00.00.0000
408 \begin_inset Flex Code
411 \begin_layout Plain Layout
418 \change_deleted 5863208 1604919950
420 \begin_inset Note Note
423 \begin_layout Plain Layout
425 \change_inserted 232239728 1604853928
426 I capitalized the first word in all of these lists.
427 To me it looks better but it really is a stylistic thing, your call.
428 However if you are not going to capitalize them, the english in some needs
429 to be modified to make it read correctly as a sentence.
437 \change_deleted 232239728 1604853510
439 \change_inserted 232239728 1604853510
442 ontains defaults for various commands.
445 \begin_layout Labeling
446 \labelwidthstring 00.00.0000
447 \begin_inset Flex Code
450 \begin_layout Plain Layout
457 \change_deleted 232239728 1604853512
459 \change_inserted 232239728 1604853512
462 ontains the list of packages that have been recognized by \SpecialChar LyX
464 It is currently unused by the \SpecialChar LyX
465 program itself, but the information extracted,
466 and more, is made available with
467 \begin_inset Flex Noun
470 \begin_layout Plain Layout
471 Help\SpecialChar menuseparator
485 \begin_layout Labeling
486 \labelwidthstring 00.00.0000
487 \begin_inset Flex Code
490 \begin_layout Plain Layout
497 \change_deleted 232239728 1604853515
499 \change_inserted 232239728 1604853515
502 he list of text classes that have been found in your
503 \begin_inset Flex Code
506 \begin_layout Plain Layout
512 directories, along with the associated \SpecialChar LaTeX
513 document class and their description.
516 \begin_layout Labeling
517 \labelwidthstring 00.00.0000
518 \begin_inset Flex Code
521 \begin_layout Plain Layout
528 \change_deleted 232239728 1604853518
530 \change_inserted 232239728 1604853518
533 he list of layout modules found in your
534 \begin_inset Flex Code
537 \begin_layout Plain Layout
546 \begin_layout Labeling
547 \labelwidthstring 00.00.0000
548 \begin_inset Flex Code
551 \begin_layout Plain Layout
558 \change_deleted 232239728 1604853523
560 \change_inserted 232239728 1604853523
563 ists of various sorts of \SpecialChar LaTeX
564 -related files found on your system
567 \begin_layout Labeling
568 \labelwidthstring 00.00.0000
569 \begin_inset Flex Code
572 \begin_layout Plain Layout
573 doc/\SpecialChar LaTeX
579 is automatically generated during configuration from the file
580 \begin_inset Flex Code
583 \begin_layout Plain Layout
591 It contains information on your \SpecialChar LaTeX
595 \begin_layout Subsection
599 \begin_layout Standard
601 \change_deleted 5863208 1604928729
605 \change_inserted 5863208 1604928636
609 \change_inserted 5863208 1604928661
613 \begin_inset Flex Code
616 \begin_layout Plain Layout
623 \change_inserted 5863208 1604928662
625 \change_deleted 5863208 1604928642
629 \change_deleted 5863208 1604928669
631 \begin_inset Flex Code
634 \begin_layout Plain Layout
641 \change_inserted 5863208 1604928680
645 \begin_inset Flex Code
648 \begin_layout Plain Layout
656 \change_deleted 232239728 1604794430
659 exists in both places, the one in
660 \begin_inset Flex Code
663 \begin_layout Plain Layout
672 \begin_layout Labeling
673 \labelwidthstring 00.00.0000
674 \begin_inset Flex Code
677 \begin_layout Plain Layout
684 \change_deleted 232239728 1604794460
686 \change_inserted 232239728 1604794460
689 his directory contains files with the extension
690 \begin_inset Flex Code
693 \begin_layout Plain Layout
699 that define the keybindings used in \SpecialChar LyX
701 If there exists an internationalized version of the bind file named
702 \begin_inset Flex Code
705 \begin_layout Plain Layout
711 , that will be used first.
714 \begin_layout Labeling
715 \labelwidthstring 00.00.0000
716 \begin_inset Flex Code
719 \begin_layout Plain Layout
726 \change_deleted 232239728 1604794478
728 \change_inserted 232239728 1604794478
731 ontains files with the extension
732 \begin_inset Flex Code
735 \begin_layout Plain Layout
741 which define the diverse citation possibilities (natbib, biblatex etc.).
743 \begin_inset CommandInset ref
745 reference "subsec:Cite-Engine-Files"
755 \begin_layout Labeling
756 \labelwidthstring 00.00.0000
757 \begin_inset Flex Code
760 \begin_layout Plain Layout
767 \change_deleted 232239728 1604794483
769 \change_inserted 232239728 1604794486
772 ontains graphics files that can be included in documents.
776 \begin_layout Labeling
777 \labelwidthstring 00.00.0000
778 \begin_inset Flex Code
781 \begin_layout Plain Layout
788 \change_deleted 232239728 1604794492
790 \change_inserted 232239728 1604794492
793 ontains \SpecialChar LyX
794 documentation files (including the one you are currently reading).
796 \begin_inset Flex Code
799 \begin_layout Plain Layout
801 \change_deleted 232239728 1604794660
804 \change_inserted 232239728 1604794661
812 deserves special attention, as noted above.
813 The internationalized help docs are in subdirectories
814 \begin_inset Flex Code
817 \begin_layout Plain Layout
824 \begin_inset Quotes eld
828 \begin_inset Quotes erd
831 is the ISO language code.
833 \begin_inset CommandInset ref
835 reference "cha:Internationalizing-LyX"
842 \begin_layout Labeling
843 \labelwidthstring 00.00.0000
844 \begin_inset Flex Code
847 \begin_layout Plain Layout
854 \change_deleted 232239728 1604794497
856 \change_inserted 232239728 1604794497
859 ontains example files that explain how to use some features.
860 In the file browser, press the
861 \begin_inset Flex Noun
864 \begin_layout Plain Layout
873 \begin_layout Labeling
874 \labelwidthstring 00.00.0000
875 \begin_inset Flex Code
878 \begin_layout Plain Layout
885 \change_deleted 232239728 1604794500
887 \change_inserted 232239728 1604794500
890 ontains image files that are used by the
891 \begin_inset Flex Noun
894 \begin_layout Plain Layout
901 In addition, it also contains the individual icons used in the toolbar
902 and the banners that can be shown when \SpecialChar LyX
906 \begin_layout Labeling
907 \labelwidthstring 00.00.0000
908 \begin_inset Flex Code
911 \begin_layout Plain Layout
918 \change_deleted 232239728 1604794505
920 \change_inserted 232239728 1604794505
923 ontains keyboard keymapping files.
925 \begin_inset CommandInset ref
927 reference "sec:International-Keymap-Stuff"
934 \begin_layout Labeling
935 \labelwidthstring 00.00.0000
936 \begin_inset Flex Code
939 \begin_layout Plain Layout
946 \change_deleted 232239728 1604794508
948 \change_inserted 232239728 1604794508
951 ontains the text class and module files described in
952 \begin_inset CommandInset ref
954 reference "cha:Installing-New-Document"
961 \begin_layout Labeling
962 \labelwidthstring 00.00.0000
963 \begin_inset Flex Code
966 \begin_layout Plain Layout
973 \change_deleted 232239728 1604794513
975 \change_inserted 232239728 1604794513
979 \begin_inset Flex Code
982 \begin_layout Plain Layout
988 Python scripts used to convert between \SpecialChar LyX
990 These can be run from the command line if
991 \change_deleted 232239728 1604794749
994 you want to batch-convert files.
997 \begin_layout Labeling
998 \labelwidthstring 00.00.0000
999 \begin_inset Flex Code
1002 \begin_layout Plain Layout
1009 \change_deleted 232239728 1604794516
1011 \change_inserted 232239728 1604794516
1014 ontains some files that demonstrate the capabilities of the
1015 \begin_inset Flex Noun
1018 \begin_layout Plain Layout
1020 \begin_inset space ~
1029 Also contains some scripts used by \SpecialChar LyX
1033 \begin_layout Labeling
1034 \labelwidthstring 00.00.0000
1035 \begin_inset Flex Code
1038 \begin_layout Plain Layout
1045 \change_deleted 232239728 1604794520
1047 \change_inserted 232239728 1604794520
1050 ontains the standard \SpecialChar LyX
1051 template files described in
1052 \begin_inset CommandInset ref
1054 reference "subsec:Creating-Templates"
1061 \begin_layout Labeling
1062 \labelwidthstring 00.00.0000
1063 \begin_inset Flex Code
1066 \begin_layout Plain Layout
1073 \change_deleted 232239728 1604794524
1075 \change_inserted 232239728 1604794524
1078 ontains files with the extension
1079 \begin_inset Flex Code
1082 \begin_layout Plain Layout
1088 that define the user interface to \SpecialChar LyX
1090 That is, the files define which items appear in which menus and the items
1091 appearing on the toolbar.
1094 \begin_layout Labeling
1095 \labelwidthstring 00.00.0000
1096 \begin_inset Flex Code
1099 \begin_layout Plain Layout
1106 \change_deleted 232239728 1604794528
1108 \change_inserted 232239728 1604794528
1111 ontains files with the extension
1112 \begin_inset Flex Code
1115 \begin_layout Plain Layout
1121 which define the templates for the insertion of external material to a
1124 \begin_inset CommandInset ref
1126 reference "chap:Including-External-Material"
1133 \begin_layout Subsection
1134 Files you don't want to modify
1137 \begin_layout Standard
1138 These files are used internally by \SpecialChar LyX
1139 and you generally do not need to modify
1140 them unless you are a developer.
1143 \begin_layout Labeling
1144 \labelwidthstring 00.00.0000
1145 \begin_inset Flex Code
1148 \begin_layout Plain Layout
1155 \change_deleted 232239728 1604797616
1157 \change_inserted 232239728 1604797616
1160 his file contains the list of \SpecialChar LyX
1162 The contents are displayed with the menu entry
1163 \begin_inset Flex Noun
1166 \begin_layout Plain Layout
1167 Help\SpecialChar menuseparator
1169 \begin_inset space ~
1180 \begin_layout Labeling
1181 \labelwidthstring 00.00.0000
1182 \begin_inset Flex Code
1185 \begin_layout Plain Layout
1192 \change_deleted 232239728 1604797620
1194 \change_inserted 232239728 1604797620
1197 his is a \SpecialChar LaTeX
1198 script used during the configuration process.
1199 Do not run directly.
1202 \begin_layout Labeling
1203 \labelwidthstring 00.00.0000
1204 \begin_inset Flex Code
1207 \begin_layout Plain Layout
1214 \change_deleted 232239728 1604797624
1216 \change_inserted 232239728 1604797624
1219 his is a Python script that is used to re-configure \SpecialChar LyX
1221 It creates configuration files in the directory it was run from.
1224 \begin_layout Subsection
1225 Other files needing a line or two
1228 \begin_layout Labeling
1229 \labelwidthstring 00.00.0000
1230 \begin_inset Flex Code
1233 \begin_layout Plain Layout
1240 \change_deleted 232239728 1604797580
1242 \change_inserted 232239728 1604797580
1245 his contains tables describing how different character encodings can be
1249 \begin_layout Labeling
1250 \labelwidthstring 00.00.0000
1251 \begin_inset Flex Code
1254 \begin_layout Plain Layout
1261 \change_deleted 232239728 1604797584
1263 \change_inserted 232239728 1604797584
1266 his file contains a list of all the languages currently supported by \SpecialChar LyX
1270 \begin_layout Labeling
1271 \labelwidthstring 00.00.0000
1272 \begin_inset Flex Code
1275 \begin_layout Plain Layout
1282 \change_deleted 232239728 1604797587
1284 \change_inserted 232239728 1604797587
1287 ontains information about the supported fonts.
1290 \begin_layout Labeling
1291 \labelwidthstring 00.00.0000
1292 \begin_inset Flex Code
1295 \begin_layout Plain Layout
1302 \change_deleted 232239728 1604797591
1304 \change_inserted 232239728 1604797591
1307 his file contains translations for internationalized paragraph styles (see
1309 \begin_inset CommandInset ref
1311 reference "subsec:I18n"
1318 \begin_layout Labeling
1319 \labelwidthstring 00.00.0000
1320 \begin_inset Flex Code
1323 \begin_layout Plain Layout
1330 \change_deleted 232239728 1604797594
1332 \change_inserted 232239728 1604797594
1335 his file contains information about Unicode-encoded glyphs and the way they
1336 are supported by \SpecialChar LyX
1337 via \SpecialChar LaTeX
1341 \begin_layout Section
1342 Your local configuration directory
1345 \begin_layout Standard
1346 Even if you are using \SpecialChar LyX
1347 as an unprivileged user, you might want to change
1349 configuration for your own use.
1351 \begin_inset Flex Code
1354 \begin_layout Plain Layout
1360 directory contains all your personal configuration files.
1361 This is the directory described as
1362 \begin_inset Quotes eld
1366 \begin_inset Quotes erd
1370 \begin_inset Flex Noun
1373 \begin_layout Plain Layout
1374 Help\SpecialChar menuseparator
1376 \begin_inset space ~
1385 This directory is used as a mirror of
1386 \begin_inset Flex Code
1389 \begin_layout Plain Layout
1395 , which means that every file in
1396 \begin_inset Flex Code
1399 \begin_layout Plain Layout
1405 is a replacement for the corresponding file in
1406 \begin_inset Flex Code
1409 \begin_layout Plain Layout
1416 Any configuration file described in the above sections can be placed either
1417 in the system-wide directory, in which case it will affect all users, or
1418 in your local directory for your own use.
1421 \begin_layout Standard
1422 To make things clearer, let's provide a few examples:
1425 \begin_layout Itemize
1426 The preferences set in the
1427 \begin_inset Flex Noun
1430 \begin_layout Plain Layout
1431 Tools\SpecialChar menuseparator
1437 dialog are saved to a file
1438 \begin_inset Flex Code
1441 \begin_layout Plain Layout
1448 \begin_inset Flex Code
1451 \begin_layout Plain Layout
1460 \begin_layout Itemize
1461 When you reconfigure using
1462 \begin_inset Flex Noun
1465 \begin_layout Plain Layout
1466 Tools\SpecialChar menuseparator
1474 \begin_inset Flex Code
1477 \begin_layout Plain Layout
1483 script, and the resulting files are written in your local configuration
1485 This means that any additional text class file that you might have added
1487 \begin_inset Flex Code
1490 \begin_layout Plain Layout
1496 will be added to the list of classes in the
1497 \begin_inset Flex Noun
1500 \begin_layout Plain Layout
1501 Document\SpecialChar menuseparator
1510 \begin_layout Itemize
1511 If you get some updated documentation from
1512 \change_inserted 232239728 1604798171
1516 ftp site and cannot install it because you do not have sysadmin rights
1517 on your system, you can just copy the files
1518 \change_deleted 232239728 1604798193
1520 \change_inserted 232239728 1604798193
1524 \begin_inset Flex Code
1527 \begin_layout Plain Layout
1533 and the items in the
1534 \begin_inset Flex Noun
1537 \begin_layout Plain Layout
1543 menu will open them!
1546 \begin_layout Section
1547 Running \SpecialChar LyX
1548 with multiple configurations
1551 \begin_layout Standard
1552 The configuration freedom of the local configuration directory may not suffice
1553 if you want to have more than one configuration at your disposal.
1554 For example, you may want to
1555 \change_deleted 232239728 1604798238
1558 use different key bindings or printer settings at different times.
1559 You can achieve this by having several such directories.
1560 You then specify which directory to use at run-time.
1563 \begin_layout Standard
1564 Invoking \SpecialChar LyX
1565 with the command line switch
1566 \begin_inset Flex Code
1569 \begin_layout Plain Layout
1579 instructs the program to read the configuration from that directory, and
1580 not from the default directory.
1581 (You can determine the default directory by running \SpecialChar LyX
1583 \begin_inset Flex Code
1586 \begin_layout Plain Layout
1592 switch.) If the specified directory does not exist, \SpecialChar LyX
1594 for you, just like it does for the default directory
1595 \change_deleted 232239728 1604798318
1598 the first time you run the program.
1599 You can modify the configuration options in this additional user directory
1600 exactly as you would for the default directory.
1601 These directories are completely independent (but read on).
1602 Note that setting the environment variable
1603 \begin_inset Flex Code
1606 \begin_layout Plain Layout
1612 to some value has exactly the same effect.
1615 \begin_layout Standard
1616 Having several configurations also requires more maintenance: if you want
1617 to add a new layout to
1618 \begin_inset Flex Code
1621 \begin_layout Plain Layout
1627 which you want available from all your configurations, you must add it
1628 to each directory separately.
1629 You can avoid this with the following trick: after \SpecialChar LyX
1630 creates the additional
1631 directory, most of the subdirectories (see above) are empty.
1632 If you want the new configuration to mirror an existing one, replace the
1633 empty subdirectory with a symbolic link to the matching subdirectory in
1634 the existing configuration.
1636 \begin_inset Flex Code
1639 \begin_layout Plain Layout
1645 subdirectory, however, since it contains a file written by the configuration
1646 script (also accessible through
1647 \begin_inset Flex Noun
1650 \begin_layout Plain Layout
1651 Tools\SpecialChar menuseparator
1657 ) which is configuration
1658 \change_deleted 232239728 1604798083
1660 \change_inserted 232239728 1604798100
1666 \begin_layout Chapter
1667 The Preferences dialog
1670 \begin_layout Standard
1671 All options of the preferences dialog are described in the Appendix
1673 The Preferences Dialog
1680 For some options you might find here more details.
1683 \begin_layout Section
1685 \begin_inset CommandInset label
1694 \begin_layout Standard
1695 The first step is to define your file formats if they are not already defined.
1697 \begin_inset Flex Noun
1700 \begin_layout Plain Layout
1701 Tools\SpecialChar menuseparator
1709 \begin_inset Flex Noun
1712 \begin_layout Plain Layout
1713 File Handling\SpecialChar menuseparator
1720 \begin_inset Flex Noun
1723 \begin_layout Plain Layout
1729 button to define your new format.
1731 \begin_inset Flex Noun
1734 \begin_layout Plain Layout
1740 field contains the name used to identify the format in the GUI.
1742 \begin_inset Flex Noun
1745 \begin_layout Plain Layout
1751 is used to identify the format internally.
1752 You will also need to enter a file extension.
1753 These are all required.
1755 \begin_inset Flex Noun
1758 \begin_layout Plain Layout
1764 field is used to provide a keyboard shortcut on the menus.
1765 (For example, pressing
1766 \begin_inset Flex Noun
1769 \begin_layout Plain Layout
1776 \begin_inset Flex Noun
1779 \begin_layout Plain Layout
1780 Document\SpecialChar menuseparator
1781 View (Other Formats)\SpecialChar menuseparator
1790 \begin_layout Standard
1792 \begin_inset Flex Noun
1795 \begin_layout Plain Layout
1802 \begin_inset Flex Noun
1805 \begin_layout Plain Layout
1812 For example, you might want to use
1813 \begin_inset Flex Noun
1816 \begin_layout Plain Layout
1822 to view PostScript files.
1823 You can enter the command needed to start the program in the corresponding
1825 In defining this command, you can use the four variables listed in the
1827 The viewer is launched when you view an image in \SpecialChar LyX
1829 \begin_inset Flex Noun
1832 \begin_layout Plain Layout
1833 Document\SpecialChar menuseparator
1840 The editor is for example launched when you right-click on an image and
1842 \begin_inset Flex Noun
1845 \begin_layout Plain Layout
1851 in the appearing context menu.
1854 \begin_layout Standard
1856 \begin_inset Flex Noun
1859 \begin_layout Plain Layout
1865 type of a format is optional, but if it is specified, it must be unique
1867 It is used to detect files of this format from the file contents.
1868 For some important file formats there is no MIME type officially registered
1870 \begin_inset CommandInset href
1873 target "http://www.iana.org/assignments/media-types/"
1879 Therefore \SpecialChar LyX
1880 uses the extended list of MIME types as specified by
1881 \begin_inset CommandInset href
1883 name "freedesktop.org"
1884 target "http://www.freedesktop.org/wiki/Specifications/shared-mime-info-spec"
1892 \begin_layout Standard
1894 \begin_inset Flex Noun
1897 \begin_layout Plain Layout
1903 option tells \SpecialChar LyX
1904 that a format is suitable for document export.
1905 If this is set and if a suitable conversion route exists (see
1906 \begin_inset CommandInset ref
1908 reference "sec:Converters"
1912 ), the format will appear in the
1913 \begin_inset Flex Noun
1916 \begin_layout Plain Layout
1917 File\SpecialChar menuseparator
1924 The format will also appear in the
1925 \begin_inset Flex Noun
1928 \begin_layout Plain Layout
1929 Document\SpecialChar menuseparator
1935 menu if a viewer is specified for the format.
1936 Pure image formats, such as
1937 \begin_inset Flex Code
1940 \begin_layout Plain Layout
1946 , should not use this option.
1947 Formats that can both represent vector graphics and documents like
1948 \begin_inset Flex Code
1951 \begin_layout Plain Layout
1960 \begin_layout Standard
1962 \begin_inset Flex Noun
1965 \begin_layout Plain Layout
1966 Vector graphics format
1971 tells \SpecialChar LyX
1972 that a format can contain vector graphics.
1973 This information is used to determine the target format of included graphics
1975 \begin_inset Flex Noun
1978 \begin_layout Plain Layout
1985 Included graphics may need to be converted to either
1986 \begin_inset Flex Noun
1989 \begin_layout Plain Layout
1996 \begin_inset Flex Noun
1999 \begin_layout Plain Layout
2006 \begin_inset Flex Noun
2009 \begin_layout Plain Layout
2016 \begin_inset Flex Noun
2019 \begin_layout Plain Layout
2025 cannot handle other image formats.
2026 If an included graphic is not already in
2027 \begin_inset Flex Noun
2030 \begin_layout Plain Layout
2037 \begin_inset Flex Noun
2040 \begin_layout Plain Layout
2047 \begin_inset Flex Noun
2050 \begin_layout Plain Layout
2056 format, it is converted to
2057 \begin_inset Flex Noun
2060 \begin_layout Plain Layout
2066 if the vector format option is set, and otherwise to
2067 \begin_inset Flex Noun
2070 \begin_layout Plain Layout
2079 \begin_layout Section
2083 \begin_layout Standard
2084 Since all conversions from one format to another take place in \SpecialChar LyX
2086 directory, it is sometimes necessary to modify a file before copying it
2087 to the temporary directory in order that the conversion may be performed.
2091 \begin_layout Plain Layout
2092 For example, the file may refer to other files—images, for example—using
2093 relative file names, and these may become invalid when the file is copied
2094 to the temporary directory.
2099 This is done by a Copier: It copies a file to (or from) the temporary directory
2100 and may modify it in the process.
2103 \begin_layout Standard
2104 The definitions of the copiers may use eight variables:
2107 \begin_layout Labeling
2108 \labelwidthstring 00.00.0000
2109 \begin_inset Flex Code
2112 \begin_layout Plain Layout
2118 The \SpecialChar LyX
2119 system directory (e.
2120 \begin_inset space \thinspace{}
2124 \begin_inset space \space{}
2128 \begin_inset Flex Noun
2131 \begin_layout Plain Layout
2140 \begin_layout Labeling
2141 \labelwidthstring 00.00.0000
2142 \begin_inset Flex Code
2145 \begin_layout Plain Layout
2154 \begin_layout Labeling
2155 \labelwidthstring 00.00.0000
2156 \begin_inset Flex Code
2159 \begin_layout Plain Layout
2168 \begin_layout Labeling
2169 \labelwidthstring 00.00.0000
2170 \begin_inset Flex Code
2173 \begin_layout Plain Layout
2179 The base name (without filename extension) in the \SpecialChar LyX
2183 \begin_layout Labeling
2184 \labelwidthstring 00.00.0000
2185 \begin_inset Flex Code
2188 \begin_layout Plain Layout
2194 The full directory path of the \SpecialChar LyX
2198 \begin_layout Labeling
2199 \labelwidthstring 00.00.0000
2200 \begin_inset Flex Code
2203 \begin_layout Plain Layout
2209 The full pathname to the original \SpecialChar LyX
2210 file being processed
2213 \begin_layout Labeling
2214 \labelwidthstring 00.00.0000
2215 \begin_inset Flex Code
2218 \begin_layout Plain Layout
2224 The filename (without any directory path) of the \SpecialChar LyX
2228 \begin_layout Labeling
2229 \labelwidthstring 00.00.0000
2230 \begin_inset Flex Code
2233 \begin_layout Plain Layout
2239 The `\SpecialChar LaTeX
2243 \begin_layout Standard
2244 The latter should be the filename as it would be used in a \SpecialChar LaTeX
2252 It is relevant only when exporting files suitable for such inclusion.
2255 \begin_layout Standard
2256 Copiers can be used to do almost anything with output files.
2257 For example, suppose you want generated pdf files to be copied to a special
2259 \begin_inset Flex Code
2262 \begin_layout Plain Layout
2269 Then you could write a shell script such as this one:
2272 \begin_layout Standard
2273 \begin_inset listings
2277 \begin_layout Plain Layout
2282 \begin_layout Plain Layout
2287 \begin_layout Plain Layout
2289 TOFILE=`basename $2`
2292 \begin_layout Plain Layout
2294 cp $FROMFILE /home/you/pdf/$TOFILE
2299 Save it in your local \SpecialChar LyX
2301 \begin_inset Flex Code
2304 \begin_layout Plain Layout
2305 /home/you/.lyx/scripts/pdfcopier.sh
2310 —and make it executable, if you need to do so on your platform.
2312 \begin_inset Flex Noun
2315 \begin_layout Plain Layout
2316 Tools\SpecialChar menuseparator
2322 dialog, select under
2323 \begin_inset Flex Noun
2326 \begin_layout Plain Layout
2327 File Handling\SpecialChar menuseparator
2334 \begin_inset Flex Noun
2337 \begin_layout Plain Layout
2343 format—or one of the other pdf formats—and enter
2344 \begin_inset Flex Code
2347 \begin_layout Plain Layout
2348 pdfcopier.sh $$i $$o
2354 \begin_inset Flex Noun
2357 \begin_layout Plain Layout
2367 \begin_layout Standard
2368 Copiers are used by \SpecialChar LyX
2369 in various of its own conversions.
2370 For example, if appropriate programs are found, \SpecialChar LyX
2371 will automatically install
2373 \begin_inset Flex Noun
2376 \begin_layout Plain Layout
2383 \begin_inset Flex Noun
2386 \begin_layout Plain Layout
2388 \begin_inset space ~
2397 When these formats are exported, the copier sees that not just the main
2398 HTML file but various associated files (style files, images, etc.) are also
2400 All these files are written to a subdirectory of the directory in which
2401 the original \SpecialChar LyX
2406 \begin_layout Plain Layout
2407 This copier can be customized.
2409 \begin_inset Quotes eld
2413 \begin_inset Quotes erd
2416 argument takes a comma-separated list of extensions to be copied; if it
2417 is omitted, all files will be copied.
2419 \begin_inset Quotes eld
2423 \begin_inset Quotes erd
2426 argument determines the extension added to the generated directory.
2428 \begin_inset Quotes eld
2432 \begin_inset Flex Noun
2435 \begin_layout Plain Layout
2442 \begin_inset Quotes erd
2445 , so HTML generated from
2446 \begin_inset Flex Noun
2449 \begin_layout Plain Layout
2450 /path/to/filename.lyx
2456 \begin_inset Flex Noun
2459 \begin_layout Plain Layout
2460 /path/to/filename.html.LyXconv
2474 \begin_layout Section
2476 \begin_inset CommandInset label
2478 name "sec:Converters"
2485 \begin_layout Standard
2486 You can define your own Converters to convert files between different formats.
2488 \begin_inset Flex Noun
2491 \begin_layout Plain Layout
2492 Tools\SpecialChar menuseparator
2493 Preferences\SpecialChar menuseparator
2494 File Handling\SpecialChar menuseparator
2503 \begin_layout Standard
2504 To define a new converter, select the
2505 \begin_inset Flex Noun
2508 \begin_layout Plain Layout
2510 \begin_inset space ~
2519 \begin_inset Flex Noun
2522 \begin_layout Plain Layout
2524 \begin_inset space ~
2532 from the drop-down lists, enter the command needed for the conversion,
2534 \begin_inset Flex Noun
2537 \begin_layout Plain Layout
2544 Several variables can be used in the definition of converters:
2547 \begin_layout Labeling
2548 \labelwidthstring 00.00.0000
2549 \begin_inset Flex Code
2552 \begin_layout Plain Layout
2558 The \SpecialChar LyX
2562 \begin_layout Labeling
2563 \labelwidthstring 00.00.0000
2564 \begin_inset Flex Code
2567 \begin_layout Plain Layout
2576 \begin_layout Labeling
2577 \labelwidthstring 00.00.0000
2578 \begin_inset Flex Code
2581 \begin_layout Plain Layout
2590 \begin_layout Labeling
2591 \labelwidthstring 00.00.0000
2592 \begin_inset Flex Code
2595 \begin_layout Plain Layout
2601 The base filename of the input file (i.
2602 \begin_inset space \thinspace{}
2605 g., without the extension)
2608 \begin_layout Labeling
2609 \labelwidthstring 00.00.0000
2610 \begin_inset Flex Code
2613 \begin_layout Plain Layout
2619 The path to the input file
2622 \begin_layout Labeling
2623 \labelwidthstring 00.00.0000
2624 \begin_inset Flex Code
2627 \begin_layout Plain Layout
2633 The path to the original input file (this is different from $$p when a
2634 chain of converters is called)
2637 \begin_layout Labeling
2638 \labelwidthstring 00.00.0000
2639 \begin_inset Flex Code
2642 \begin_layout Plain Layout
2648 The iconv name for the encoding of the document.
2651 \begin_layout Standard
2653 \begin_inset Flex Noun
2656 \begin_layout Plain Layout
2658 \begin_inset space ~
2666 field you can enter the following flags, separated by commas:
2669 \begin_layout Labeling
2670 \labelwidthstring 00.00.0000
2671 \begin_inset Flex Code
2674 \begin_layout Plain Layout
2676 \change_inserted -712698321 1524656940
2684 This converter runs some form of \SpecialChar LaTeX
2686 This will make \SpecialChar LyX
2687 's \SpecialChar LaTeX
2688 error logs available.
2690 \change_inserted -712698321 1524657018
2692 \begin_inset Flex Code
2695 \begin_layout Plain Layout
2697 \change_inserted -712698321 1524657012
2705 value specifies the form of \SpecialChar LaTeX
2707 \begin_inset Flex Code
2710 \begin_layout Plain Layout
2712 \change_inserted -712698321 1524657005
2713 latex, pdflatex, platex, xetex, luatex
2721 If no value is specified,
2722 \begin_inset Flex Code
2725 \begin_layout Plain Layout
2727 \change_inserted -712698321 1524657018
2740 \begin_layout Labeling
2741 \labelwidthstring 00.00.0000
2742 \begin_inset Flex Code
2745 \begin_layout Plain Layout
2747 \change_inserted -712698321 1524656935
2755 Needs the \SpecialChar LaTeX
2757 \begin_inset Flex Noun
2760 \begin_layout Plain Layout
2766 file for the conversion.
2768 \change_inserted -712698321 1524657047
2770 \begin_inset Flex Code
2773 \begin_layout Plain Layout
2775 \change_inserted -712698321 1524657030
2783 value specifies the form of \SpecialChar LaTeX
2784 that is run in order to generate the
2785 \begin_inset Flex Noun
2788 \begin_layout Plain Layout
2790 \change_inserted -712698321 1524657047
2799 \begin_inset Flex Code
2802 \begin_layout Plain Layout
2804 \change_inserted -712698321 1524657030
2805 latex, pdflatex, platex, xetex, luatex
2813 If no value is specified,
2814 \begin_inset Flex Code
2817 \begin_layout Plain Layout
2819 \change_inserted -712698321 1524657030
2832 \begin_layout Labeling
2833 \labelwidthstring 00.00.0000
2834 \begin_inset Flex Code
2837 \begin_layout Plain Layout
2844 \begin_inset Quotes eld
2848 \begin_inset Quotes erd
2851 file from the backend, which in practice means a \SpecialChar LaTeX
2852 file like the one we
2853 would export, without
2854 \begin_inset Flex Code
2857 \begin_layout Plain Layout
2866 \begin_layout Labeling
2867 \labelwidthstring 00.00.0000
2868 \begin_inset Flex Code
2871 \begin_layout Plain Layout
2880 \begin_layout Standard
2881 The following three flags are not really flags at all because they take
2883 \begin_inset Flex Noun
2886 \begin_layout Plain Layout
2888 \begin_inset space ~
2892 \begin_inset space ~
2903 \begin_layout Labeling
2904 \labelwidthstring 00.00.0000
2906 \change_inserted -712698321 1523206314
2907 \begin_inset Flex Code
2910 \begin_layout Plain Layout
2912 \change_inserted -712698321 1523206193
2920 The name of the driver that needs to be loaded with the
2924 package for this converter.
2925 The loading of the correct driver is necessary to get some PDF-specific
2934 \begin_layout Labeling
2935 \labelwidthstring 00.00.0000
2936 \begin_inset Flex Code
2939 \begin_layout Plain Layout
2945 If set, the converter's standard error will be redirected to a file
2946 \begin_inset Flex Code
2949 \begin_layout Plain Layout
2955 , and the script given as argument will be run as:
2956 \begin_inset Flex Code
2959 \begin_layout Plain Layout
2960 script < infile.out > infile.log
2966 The argument may contain
2967 \begin_inset Flex Code
2970 \begin_layout Plain Layout
2979 \begin_layout Labeling
2980 \labelwidthstring 00.00.0000
2981 \begin_inset Flex Code
2984 \begin_layout Plain Layout
2990 The name of the directory in which the converter will dump the generated
2993 will not create this directory, and it does not copy anything into it,
2994 though it will copy this directory to the destination.
2995 The argument may contain
2996 \begin_inset Flex Code
2999 \begin_layout Plain Layout
3005 , which will be replaced by the base name of the input and output files,
3006 respectively, when the directory is copied.
3007 \begin_inset Newline newline
3010 Note that resultdir and usetempdir make no sense together.
3011 The latter will be ignored if the former is given.
3014 \begin_layout Labeling
3015 \labelwidthstring 00.00.0000
3016 \begin_inset Flex Code
3019 \begin_layout Plain Layout
3025 Determines the output file name and may, contain
3026 \begin_inset Flex Code
3029 \begin_layout Plain Layout
3036 Sensible only with resultdir and optional even then; if not given, it defaults
3040 \begin_layout Standard
3042 \change_inserted -712698321 1523206384
3043 A suitable hyperref-driver is set for some converters that are installed
3044 with \SpecialChar LyX
3047 \change_deleted -712698321 1523206388
3049 \change_inserted -712698321 1523206389
3053 \change_inserted -712698321 1523206400
3057 \change_inserted -712698321 1523206407
3061 \change_inserted -712698321 1523206437
3065 \change_deleted -712698321 1523206442
3066 that are installed with \SpecialChar LyX
3073 \begin_layout Standard
3074 You do not have to define converters for all formats between which you want
3076 For example, you will note that there is no `\SpecialChar LyX
3077 to PostScript' converter,
3078 but \SpecialChar LyX
3079 will export PostScript.
3080 It does so by first creating a \SpecialChar LaTeX
3081 file (no converter needs to be defined
3082 for this) which is then converted to DVI using the `\SpecialChar LaTeX
3084 and finally converting the resulting DVI file to PostScript.
3086 finds such `chains' of converters automatically, and it will always choose
3087 the shortest possible chain.
3088 You can, though, still define multiple conversion methods between file
3090 For example, the standard \SpecialChar LyX
3091 configuration provides five ways to convert
3096 \begin_layout Enumerate
3098 \begin_inset Flex Noun
3101 \begin_layout Plain Layout
3110 \begin_layout Enumerate
3111 via (DVI and) PostScript, using
3112 \begin_inset Flex Noun
3115 \begin_layout Plain Layout
3124 \begin_layout Enumerate
3126 \begin_inset Flex Noun
3129 \begin_layout Plain Layout
3138 \begin_layout Enumerate
3140 \begin_inset Flex Noun
3143 \begin_layout Plain Layout
3153 \begin_layout Enumerate
3155 \begin_inset Flex Noun
3158 \begin_layout Plain Layout
3168 \begin_layout Standard
3169 To define such alternate chains, you must define multiple target `file formats',
3171 \begin_inset CommandInset ref
3173 reference "sec:Formats"
3178 For example, in the standard configuration, the formats named
3179 \begin_inset Flex Noun
3182 \begin_layout Plain Layout
3189 \begin_inset Flex Noun
3192 \begin_layout Plain Layout
3199 \begin_inset Flex Noun
3202 \begin_layout Plain Layout
3209 \begin_inset Flex Noun
3212 \begin_layout Plain Layout
3219 \begin_inset Flex Noun
3222 \begin_layout Plain Layout
3229 \begin_inset Flex Noun
3232 \begin_layout Plain Layout
3239 \begin_inset Flex Noun
3242 \begin_layout Plain Layout
3249 \begin_inset Flex Noun
3252 \begin_layout Plain Layout
3260 \begin_inset Flex Noun
3263 \begin_layout Plain Layout
3270 \begin_inset Flex Noun
3273 \begin_layout Plain Layout
3280 ) are defined, all of which share the extension
3281 \begin_inset Flex Noun
3284 \begin_layout Plain Layout
3290 , and which correspond to the conversion methods just mentioned.
3293 \begin_layout Chapter
3294 Internationalizing \SpecialChar LyX
3296 \begin_inset CommandInset label
3298 name "cha:Internationalizing-LyX"
3305 \begin_layout Standard
3307 supports using a translated interface.
3308 Last time we checked, \SpecialChar LyX
3309 provided text in thirty languages.
3310 The language of choice is called your
3315 (For further reading on locale settings, see also the documentation for
3316 locale that comes with your operating system.
3317 For Linux, the manual page for
3318 \begin_inset Flex Code
3321 \begin_layout Plain Layout
3327 could be a good place to start).
3330 \begin_layout Standard
3331 Notice that these translations will work, but do contain a few flaws.
3332 In particular, all dialogs have been designed with the English text in
3333 mind, which means that some of the translated text will be too large to
3334 fit within the space allocated.
3335 This is only a display problem and will not cause any harm.
3336 Also, you will find that some of the translations do not define shortcut
3337 keys for everything.
3338 Sometimes, there are simply not enough free letters to do it.
3339 Other times, the translator just hasn't got around to doing it yet.
3340 Our localization team, which you may wish to join,
3344 \begin_layout Plain Layout
3345 If you are a fluent speaker of a language other than English, joining these
3346 teams is a great way to give back to the \SpecialChar LyX
3352 will of course try to fix these shortcomings in future versions of \SpecialChar LyX
3356 \begin_layout Section
3357 Translating \SpecialChar LyX
3361 \begin_layout Subsection
3362 Translating the graphical user interface (text messages).
3365 \begin_layout Standard
3368 \begin_inset Flex Code
3371 \begin_layout Plain Layout
3377 library to handle the internationalization of the interface.
3378 To have \SpecialChar LyX
3379 speak your favorite language in all menus and dialogs, you need
3381 \begin_inset Flex Code
3384 \begin_layout Plain Layout
3390 -file for that language.
3391 When this is available, you'll have to generate a
3392 \begin_inset Flex Code
3395 \begin_layout Plain Layout
3401 -file from it and install the
3402 \begin_inset Flex Code
3405 \begin_layout Plain Layout
3412 The process of doing all of this is explained in the documentation for
3414 \begin_inset Flex Code
3417 \begin_layout Plain Layout
3424 It is possible to do this just for yourself, but if you're going to do
3425 it, you might as well share the results of your labors with the rest of
3426 the \SpecialChar LyX
3428 Send a message to the \SpecialChar LyX
3429 developers' list for more information about how
3433 \begin_layout Standard
3434 In short, this is what you should do (xx denotes the language code):
3437 \begin_layout Itemize
3438 Check out the \SpecialChar LyX
3441 \begin_inset CommandInset href
3443 name "information on the web"
3444 target "https://www.lyx.org/HowToUseGIT"
3452 \begin_layout Itemize
3454 \begin_inset Flex Code
3457 \begin_layout Plain Layout
3463 to the folder of the
3464 \begin_inset Flex Code
3467 \begin_layout Plain Layout
3475 \begin_inset Flex Code
3478 \begin_layout Plain Layout
3486 \begin_inset Flex Code
3489 \begin_layout Plain Layout
3495 doesn't exist anywhere, it can be remade with the console command
3496 \begin_inset Flex Code
3499 \begin_layout Plain Layout
3505 in that directory, or you can use an existing po-file for some other language
3509 \begin_layout Itemize
3511 \begin_inset Flex Code
3514 \begin_layout Plain Layout
3524 \begin_layout Plain Layout
3525 This is just a text file, so it can be edited in any text editor.
3526 But there are also specialized programs that support such editing, such
3531 (for all platforms) or
3540 contains a `mode' for editing
3541 \begin_inset Flex Code
3544 \begin_layout Plain Layout
3551 \begin_inset Flex URL
3554 \begin_layout Plain Layout
3556 https://www.gnu.org/software/gettext/manual/html_node/PO-Mode.html#PO-Mode
3566 For some menu- and widget-labels, there are also shortcut keys that should
3568 Those keys are marked after a `|', and should be translated according to
3569 the words and phrases of the language.
3570 You should also fill also out the information at the beginning of the new
3572 \begin_inset Flex Code
3575 \begin_layout Plain Layout
3581 -file with your email-address, etc., so people know where to reach you with
3582 suggestions and entertaining flames.
3585 \begin_layout Standard
3586 If you are just doing this on your own, then:
3589 \begin_layout Itemize
3591 \begin_inset Flex Code
3594 \begin_layout Plain Layout
3601 This can be done with
3602 \begin_inset Flex Code
3605 \begin_layout Plain Layout
3606 msgfmt -o xx.mo < xx.po
3614 \begin_layout Itemize
3616 \begin_inset Flex Code
3619 \begin_layout Plain Layout
3625 -file to your locale-tree, at the correct directory for application messages
3630 xx, and under the name
3631 \begin_inset Flex Code
3634 \begin_layout Plain Layout
3641 \begin_inset space \thinspace{}
3645 \begin_inset space \space{}
3649 \begin_inset Flex Code
3652 \begin_layout Plain Layout
3653 /usr/local/share/locale/xx/LC_MESSAGES/lyx.mo
3663 \begin_layout Standard
3664 As said, however, it would be best if the new
3665 \begin_inset Flex Code
3668 \begin_layout Plain Layout
3674 file could be added to the \SpecialChar LyX
3675 distribution, so others can use it.
3676 Adding it involves making additional changes to \SpecialChar LyX
3678 So send an email to the developers' mailing list if you're interested in
3682 \begin_layout Subsubsection
3686 \begin_layout Standard
3687 Sometimes it turns out that one English message needs to be translated into
3688 different messages in the target language.
3689 One example is the message
3690 \begin_inset Flex Code
3693 \begin_layout Plain Layout
3699 which has the German translation
3707 , depending upon exactly what the English
3708 \begin_inset Quotes eld
3712 \begin_inset Quotes erd
3717 \begin_inset Flex Code
3720 \begin_layout Plain Layout
3726 does not handle such ambiguous translations.
3727 Therefore you have to add some context information to the message: Instead
3729 \begin_inset Flex Code
3732 \begin_layout Plain Layout
3739 \begin_inset Flex Code
3742 \begin_layout Plain Layout
3743 To[[as in 'From format x to format y']]
3749 \begin_inset Flex Code
3752 \begin_layout Plain Layout
3753 To[[as in 'From page x to page y']].
3758 Now the two occurrences of
3759 \begin_inset Flex Code
3762 \begin_layout Plain Layout
3769 \begin_inset Flex Code
3772 \begin_layout Plain Layout
3778 and can be translated correctly to
3789 \begin_layout Standard
3790 Of course the context information needs to be stripped off the original
3791 message when no translation is used.
3792 Therefore you have to put it in double square brackets at the end of the
3793 message (see the example above).
3794 The translation mechanism of \SpecialChar LyX
3795 ensures that everything in double square
3796 brackets at the end of messages is removed before displaying the message.
3799 \begin_layout Subsection
3800 Translating the documentation.
3803 \begin_layout Standard
3804 The online documentation (in the
3805 \begin_inset Flex Noun
3808 \begin_layout Plain Layout
3814 -menu) can (and should!) be translated.
3815 If there are translated versions of the documentation available
3819 \begin_layout Plain Layout
3820 As of March 2008, at least some of the documents have been translated into
3821 fourteen languages, with the Tutorial available in a few more.
3826 and the locale is set accordingly, these will be used automagically by
3830 looks for translated versions as
3831 \begin_inset Flex Code
3834 \begin_layout Plain Layout
3835 LyXDir/doc/xx/DocName.lyx
3841 \begin_inset Flex Code
3844 \begin_layout Plain Layout
3850 is the code for the language currently in use.
3851 If there are no translated documents, the default English versions will
3853 Note that the translated versions must have the same filenames (
3854 \begin_inset Flex Code
3857 \begin_layout Plain Layout
3863 above) as the original.
3864 If you feel up to translating the documentation (an excellent way to proof-read
3865 the original documentation by the way!), there are a few things you should
3869 \begin_layout Itemize
3870 Check out the documentation translation web page at
3871 \begin_inset CommandInset href
3873 name "https://www.lyx.org/Translation"
3874 target "https://www.lyx.org/Translation"
3880 That way, you can find out which (if any) documents have already been translate
3881 d into your language.
3882 You can also find out who (if anyone) is organizing the effort to translate
3883 the documentation into your language.
3884 If no one is organizing the effort, please let us know that you're interested.
3887 \begin_layout Standard
3888 Once you get to actually translating, here's a few hints for you that may
3892 \begin_layout Itemize
3893 Join the documentation team! There is information on how to do that in
3894 \begin_inset Flex Code
3897 \begin_layout Plain Layout
3904 \begin_inset Flex Noun
3907 \begin_layout Plain Layout
3908 Help\SpecialChar menuseparator
3914 ), which by the way is the first document you should translate.
3917 \begin_layout Itemize
3918 Learn the typographic conventions for the language you are translating to.
3919 Typography is an ancient art and over the centuries, a great variety of
3920 conventions have developed throughout different parts of the world.
3921 Also study the professional terminology amongst typographers in your country.
3922 Inventing your own terminology will only confuse the users.
3925 (Warning! Typography is addictive!)
3928 \begin_layout Itemize
3929 Make a copy of the document.
3930 This will be your working copy.
3931 You can use this as your personal translated help-file by placing it in
3933 \begin_inset Flex Code
3936 \begin_layout Plain Layout
3943 \begin_inset Note Greyedout
3946 \begin_layout Plain Layout
3951 For a complex document with external material (images, etc.), if you make
3953 \begin_inset space \thinspace{}
3957 \begin_inset space \space{}
3960 in a temp dir, beware that the links to external material may be broken
3961 when the document is moved to a different place.
3962 The best way is to retrieve the \SpecialChar LyX
3964 \begin_inset Flex URL
3967 \begin_layout Plain Layout
3969 https://www.lyx.org/HowToUseGIT
3974 ) and to edit the doc file in place.
3982 \begin_layout Itemize
3983 Sometimes the original document (from the \SpecialChar LyX
3984 team) will be updated.
3985 Use the source viewer at
3986 \begin_inset CommandInset href
3988 name "https://www.lyx.org/trac/timeline"
3989 target "https://www.lyx.org/trac/timeline"
3994 to see what has been changed.
3995 That way you can easily see which parts of the translated document need
3999 \begin_layout Standard
4000 If you ever find an error in the original document, fix it and notify the
4001 rest of the documentation team of the changes! (You didn't forget to join
4002 the documentation team, did you?)
4005 \begin_layout Standard
4006 \begin_inset Branch OutDated
4010 \begin_layout Section
4011 International Keyboard Support
4014 \begin_layout Standard
4017 [Editor's Note: The following section is by
4025 It needs to be fixed to conform to the new Documentation Style sheet and
4026 to make use of the new v1.0 features.
4027 The whole thing also needs to be merged with the section following it.-jw
4028 It may also be badly out of date.-rh (2008)]
4031 \begin_layout Subsection
4032 Defining Own Keymaps: Keymap File Format
4035 \begin_layout Standard
4036 Let's look at a keyboard definition file a little closer.
4037 It is a plain text file defining
4040 \begin_layout Itemize
4041 key-to-key or key-to-string translations
4044 \begin_layout Itemize
4048 \begin_layout Itemize
4049 dead keys exceptions
4052 \begin_layout Standard
4053 To define key-to-key or key-to-string translation, use this command:
4056 \begin_layout Quotation
4057 \begin_inset Flex Code
4060 \begin_layout Plain Layout
4069 \begin_inset Flex Code
4072 \begin_layout Plain Layout
4081 \begin_layout Standard
4083 \begin_inset Flex Code
4086 \begin_layout Plain Layout
4092 is the key to be translated and
4093 \begin_inset Flex Code
4096 \begin_layout Plain Layout
4102 is the string to be inserted into the document.
4103 To define dead keys, use:
4106 \begin_layout Quotation
4107 \begin_inset Flex Code
4110 \begin_layout Plain Layout
4119 \begin_inset Flex Code
4122 \begin_layout Plain Layout
4131 \begin_layout Standard
4133 \begin_inset Flex Code
4136 \begin_layout Plain Layout
4142 is a keyboard key and
4143 \begin_inset Flex Code
4146 \begin_layout Plain Layout
4153 The following dead keys are supported (shortcut name is in parentheses):
4156 \begin_layout Quotation
4160 \begin_inset space \hfill{}
4166 \begin_layout Quotation
4168 \begin_inset space \hfill{}
4174 \begin_layout Quotation
4176 \begin_inset space \hfill{}
4182 \begin_layout Quotation
4184 \begin_inset space \hfill{}
4190 \begin_layout Quotation
4192 \begin_inset space \hfill{}
4198 \begin_layout Quotation
4200 \begin_inset space \hfill{}
4207 \begin_layout Plain Layout
4219 \begin_layout Quotation
4221 \begin_inset space \hfill{}
4227 \begin_layout Quotation
4229 \begin_inset space \hfill{}
4236 \begin_layout Plain Layout
4248 \begin_layout Quotation
4250 \begin_inset space \hfill{}
4256 \begin_layout Quotation
4258 \begin_inset space \hfill{}
4264 \begin_layout Quotation
4266 \begin_inset space \hfill{}
4273 \begin_layout Plain Layout
4285 \begin_layout Quotation
4287 \begin_inset space \hfill{}
4294 \begin_layout Plain Layout
4306 \begin_layout Quotation
4308 \begin_inset space \hfill{}
4314 \begin_layout Quotation
4315 hungarian umlaut (hug)
4316 \begin_inset space \hfill{}
4322 \begin_layout Quotation
4324 \begin_inset space \hfill{}
4330 \begin_layout Quotation
4332 \begin_inset space \hfill{}
4339 \begin_layout Plain Layout
4351 \begin_layout Standard
4352 Since in many international keyboards there are exceptions to what some
4353 dead keys should do, you can define them using
4356 \begin_layout Quotation
4357 \begin_inset Flex Code
4360 \begin_layout Plain Layout
4368 deadkey key outstring
4371 \begin_layout Standard
4372 For example, on Slovak keyboard, if you enter caron-o, it generates circumflex-o
4376 \begin_layout Quotation
4377 \begin_inset Flex Code
4380 \begin_layout Plain Layout
4393 \begin_layout Standard
4394 to make it work correctly.
4395 Also, you have to define as exceptions dead keys over i and j, to remove
4396 the dot from them before inserting an accent mark.
4397 I will change this when the time comes, but so far I haven't had time.
4400 \begin_layout Standard
4401 Oh, and about characters: backslash is escaped, so to enter it, you'll need
4404 \begin_inset Flex Code
4407 \begin_layout Plain Layout
4413 have different meaning.
4415 \begin_inset Flex Code
4418 \begin_layout Plain Layout
4424 marks comments, quotes start and end \SpecialChar LaTeX
4426 To enter quote, you'll need to use
4427 \begin_inset Flex Code
4430 \begin_layout Plain Layout
4439 \begin_inset Flex Code
4442 \begin_layout Plain Layout
4449 \begin_inset Flex Code
4452 \begin_layout Plain Layout
4463 \begin_layout Standard
4464 If you make a keyboard description file that works for your language, please
4465 mail it to me, so I can include it in the next keymap distribution.
4468 \begin_layout Standard
4469 More keywords will be supported in keymap configuration file in future,
4473 \begin_layout Itemize
4474 \begin_inset Flex Code
4477 \begin_layout Plain Layout
4488 \begin_inset space \hfill{}
4492 \begin_inset Flex Code
4495 \begin_layout Plain Layout
4504 \begin_layout Itemize
4505 \begin_inset Flex Code
4508 \begin_layout Plain Layout
4519 \begin_inset space \hfill{}
4523 \begin_inset Flex Code
4526 \begin_layout Plain Layout
4532 an external keymap translation program
4535 \begin_layout Standard
4536 Also, it should look into
4537 \begin_inset Flex Code
4540 \begin_layout Plain Layout
4546 file for defaults, too (for example, a
4547 \begin_inset Flex Code
4550 \begin_layout Plain Layout
4558 option to include default keyboard).
4566 \begin_layout Section
4567 International Keymap Stuff
4568 \begin_inset CommandInset label
4570 name "sec:International-Keymap-Stuff"
4577 \begin_layout Standard
4578 \begin_inset Note Note
4581 \begin_layout Plain Layout
4582 In doing the revisions on this document in March 2008, I did not look over
4583 this stuff, as I do not understand it.
4584 It would be good if someone else could do so.
4593 \begin_layout Standard
4594 The next two sections describe the
4595 \begin_inset Flex Code
4598 \begin_layout Plain Layout
4607 \begin_inset Flex Code
4610 \begin_layout Plain Layout
4618 file syntax in detail.
4619 These sections should help you design your own key map if the ones provided
4620 do not meet your needs.
4623 \begin_layout Subsection
4627 \begin_layout Standard
4631 \begin_inset Flex Code
4634 \begin_layout Plain Layout
4640 file maps keystrokes to characters or strings.
4641 As the name suggests, it sets a keyboard mapping.
4643 \begin_inset Flex Code
4646 \begin_layout Plain Layout
4657 \begin_inset Flex Code
4660 \begin_layout Plain Layout
4675 \begin_inset Flex Code
4678 \begin_layout Plain Layout
4691 \begin_inset Flex Code
4694 \begin_layout Plain Layout
4703 \begin_inset Flex Code
4706 \begin_layout Plain Layout
4714 are described in this section.
4717 \begin_layout Labeling
4718 \labelwidthstring 00.00.0000
4719 \begin_inset Flex Code
4722 \begin_layout Plain Layout
4730 Map a character to a string
4733 \begin_layout LyX-Code
4748 \begin_layout Standard
4781 the double-quote (")
4798 must be escaped with a preceding backslash (
4809 \begin_layout Standard
4811 \begin_inset Flex Noun
4814 \begin_layout Plain Layout
4822 statement to cause the symbol
4823 \begin_inset Flex Noun
4826 \begin_layout Plain Layout
4834 to be output for the keystroke
4835 \begin_inset Flex Noun
4838 \begin_layout Plain Layout
4849 \begin_layout LyX-Code
4855 \begin_layout Labeling
4856 \labelwidthstring 00.00.0000
4857 \begin_inset Flex Code
4860 \begin_layout Plain Layout
4868 Specify an accent character
4871 \begin_layout LyX-Code
4880 \begin_layout Standard
4881 This will make the cha
4919 This is the dead key
4923 \begin_layout Plain Layout
4930 refers to a key that does not produce a character by itself, but when followed
4931 with another key, produces the desired accent character.
4932 For example, a German characte
4934 r with an umlaut like
4944 can be produced in this manner.
4953 \begin_layout Standard
4966 and then another key not in
4983 followed by the other, not allowed key, as output.
4987 \begin_inset Flex Noun
4990 \begin_layout Plain Layout
4998 cancels a dead key, so if
5009 \begin_inset Flex Noun
5012 \begin_layout Plain Layout
5021 , the cursor will not go one position backwards but will instead cancel
5037 might have had on the next keystroke.
5041 \begin_layout Standard
5042 The following example specifies that the character ' is to be an acute accent,
5043 allowed on the characters a, e, i, o, u, A, E, I, O, and U:
5046 \begin_layout LyX-Code
5049 kmod ' acute aeiouAEIOU
5052 \begin_layout Labeling
5053 \labelwidthstring 00.00.0000
5054 \begin_inset Flex Code
5057 \begin_layout Plain Layout
5063 Specify an exception to the accent character
5066 \begin_layout LyX-Code
5075 \begin_layout Standard
5076 This defines an exce
5117 have been assigned a keystroke with a previous
5120 \begin_inset Flex Code
5123 \begin_layout Plain Layout
5147 must not belong in the
5194 If such a declaration does not exist in
5202 \begin_inset Flex Code
5205 \begin_layout Plain Layout
5239 \begin_inset Flex Code
5242 \begin_layout Plain Layout
5256 \begin_layout Standard
5257 The following command produces causes äi to be produced when you enter acute-i
5261 \begin_layout LyX-Code
5275 \begin_layout Labeling
5276 \labelwidthstring 00.00.0000
5277 \begin_inset Flex Code
5280 \begin_layout Plain Layout
5286 Combine two accent characters
5289 \begin_layout LyX-Code
5295 accent1 accent2 allowed
5298 \begin_layout Standard
5299 This one is getting pretty esoteric.
5300 It allows you to combine the effect
5356 \begin_inset Flex Code
5359 \begin_layout Plain Layout
5387 \begin_layout Standard
5388 Consider this example from the
5389 \begin_inset Flex Code
5392 \begin_layout Plain Layout
5403 \begin_layout LyX-Code
5406 kmod ; acute aeioyvhAEIOYVH
5410 kcomb acute umlaut iyIY
5413 \begin_layout Standard
5414 This allows you to press
5415 \begin_inset Flex Noun
5418 \begin_layout Plain Layout
5426 and get the effect of
5427 \begin_inset Flex Code
5430 \begin_layout Plain Layout
5449 in this case cancels the last dead key, so if you press
5450 \begin_inset Flex Noun
5453 \begin_layout Plain Layout
5462 \begin_inset Flex Code
5465 \begin_layout Plain Layout
5478 \begin_layout Subsection
5482 \begin_layout Standard
5484 \begin_inset Flex Code
5487 \begin_layout Plain Layout
5495 mapping is performed, a
5496 \begin_inset Flex Code
5499 \begin_layout Plain Layout
5509 file maps the strings that the symbols generate to characters in the current
5511 The \SpecialChar LyX
5512 distribution currently includes at least the
5513 \begin_inset Flex Code
5516 \begin_layout Plain Layout
5525 \begin_inset Flex Code
5528 \begin_layout Plain Layout
5539 \begin_layout Standard
5541 \begin_inset Flex Code
5544 \begin_layout Plain Layout
5552 file is a sequence of declarations of the form
5555 \begin_layout LyX-Code
5568 \begin_layout Standard
5569 For example, in order to map
5570 \begin_inset Flex Noun
5573 \begin_layout Plain Layout
5583 to the corresponding character in the iso-8859-1 set (233), the following
5587 \begin_layout LyX-Code
5595 \begin_layout Standard
5597 \begin_inset Flex Code
5600 \begin_layout Plain Layout
5609 \begin_inset Flex Code
5612 \begin_layout Plain Layout
5630 the same character can apply to more than one string.
5632 \begin_inset Flex Code
5635 \begin_layout Plain Layout
5646 \begin_layout LyX-Code
5658 \begin_inset Newline newline
5674 \begin_layout Standard
5676 cannot find a mapping for the string produced by the keystroke or a
5677 deadkey sequence, it will check if it looks like an accented char and try
5678 to draw an accent over the character on screen.
5681 \begin_layout Subsection
5685 \begin_layout Standard
5686 There is a second way to add support for international characters through
5687 so-called dead-keys.
5688 A dead-key works in combination with a letter to produce an accented character.
5689 Here, we'll explain how to create a really simple dead-key to illustrate
5693 \begin_layout Standard
5694 Suppose you happen to need the circumflex character,
5695 \begin_inset Quotes eld
5699 \begin_inset Quotes erd
5704 \begin_inset Flex Noun
5707 \begin_layout Plain Layout
5714 \begin_inset space ~
5718 \begin_inset Flex Noun
5721 \begin_layout Plain Layout
5727 ] to the \SpecialChar LyX
5729 \begin_inset Flex Code
5732 \begin_layout Plain Layout
5739 \begin_inset Flex Code
5742 \begin_layout Plain Layout
5749 Now, whenever you type the
5750 \begin_inset Flex Noun
5753 \begin_layout Plain Layout
5759 -key followed by a letter, that letter will have a circumflex accent on
5761 For example, the sequence
5762 \begin_inset Quotes eld
5766 \begin_inset Flex Noun
5769 \begin_layout Plain Layout
5776 \begin_inset Quotes erd
5779 produces the letter:
5780 \begin_inset Quotes eld
5784 \begin_inset Quotes erd
5788 If you tried to type
5789 \begin_inset Quotes eld
5793 \begin_inset Flex Noun
5796 \begin_layout Plain Layout
5803 \begin_inset Quotes erd
5806 , however, \SpecialChar LyX
5807 will complain with a beep, since a
5808 \begin_inset Quotes eld
5812 \begin_inset Flex Noun
5815 \begin_layout Plain Layout
5822 \begin_inset Quotes erd
5825 never takes a circumflex accent.
5827 \begin_inset Flex Noun
5830 \begin_layout Plain Layout
5836 after a dead-key produces the bare-accent.
5837 Please note this last point! If you bind a key to a dead-key, you'll need
5838 to rebind the character on that key to yet another key.
5840 \begin_inset Flex Noun
5843 \begin_layout Plain Layout
5849 to a cedilla is a bad idea, since you'll only get cedillas instead of commas.
5852 \begin_layout Standard
5853 One common way to bind dead-keys is to use
5854 \begin_inset Flex Noun
5857 \begin_layout Plain Layout
5864 \begin_inset Flex Noun
5867 \begin_layout Plain Layout
5874 \begin_inset Flex Noun
5877 \begin_layout Plain Layout
5883 in combination with an accent, like
5884 \begin_inset Quotes eld
5888 \begin_inset Flex Noun
5891 \begin_layout Plain Layout
5898 \begin_inset Quotes erd
5902 \begin_inset Quotes eld
5906 \begin_inset Flex Noun
5909 \begin_layout Plain Layout
5916 \begin_inset Quotes erd
5920 \begin_inset Quotes eld
5924 \begin_inset Flex Noun
5927 \begin_layout Plain Layout
5934 \begin_inset Quotes erd
5938 Another way involves using
5939 \begin_inset Flex Code
5942 \begin_layout Plain Layout
5949 \begin_inset Flex Code
5952 \begin_layout Plain Layout
5958 to set up the special
5959 \begin_inset Flex Code
5962 \begin_layout Plain Layout
5970 \begin_inset Flex Code
5973 \begin_layout Plain Layout
5979 acts in some ways just like
5980 \begin_inset Flex Noun
5983 \begin_layout Plain Layout
5989 and permits you to bind keys to accented characters.
5990 You can also turn keys into dead-keys by binding them to something like
5992 \begin_inset Flex Code
5995 \begin_layout Plain Layout
6001 and then binding this symbolic key to the corresponding \SpecialChar LyX
6006 \begin_layout Plain Layout
6011 : This is exactly what I do in my
6012 \begin_inset Flex Code
6015 \begin_layout Plain Layout
6022 \begin_inset Flex Code
6025 \begin_layout Plain Layout
6033 \begin_inset Flex Noun
6036 \begin_layout Plain Layout
6038 \begin_inset space ~
6047 \begin_inset Flex Code
6050 \begin_layout Plain Layout
6056 and a bunch of these
6057 \begin_inset Quotes eld
6061 \begin_inset Flex Code
6064 \begin_layout Plain Layout
6071 \begin_inset Quotes erd
6074 symbolic keys bound such things as
6075 \begin_inset Flex Noun
6078 \begin_layout Plain Layout
6080 \begin_inset space ~
6089 \begin_inset Flex Noun
6092 \begin_layout Plain Layout
6094 \begin_inset space ~
6103 This is how I produce my accented characters.
6108 You can make just about anything into the
6109 \begin_inset Flex Code
6112 \begin_layout Plain Layout
6119 \begin_inset Flex Noun
6122 \begin_layout Plain Layout
6128 keys, a spare function key, etc.
6129 As for the \SpecialChar LyX
6130 commands that produce accents, check the entry for
6131 \begin_inset Flex Code
6134 \begin_layout Plain Layout
6145 You'll find the complete list there.
6148 \begin_layout Subsection
6149 Saving your Language Configuration
6152 \begin_layout Standard
6153 You can edit your preferences so that your desired language environment
6154 is automatically configured when \SpecialChar LyX
6156 \begin_inset Flex Noun
6159 \begin_layout Plain Layout
6160 Edit\SpecialChar menuseparator
6169 \begin_layout Chapter
6170 Installing New Document Classes, Layouts, and Templates
6171 \begin_inset CommandInset label
6173 name "cha:Installing-New-Document"
6178 \begin_inset Argument 1
6181 \begin_layout Plain Layout
6182 Installing New Document Classes
6190 \begin_layout Standard
6191 In this chapter, we describe the procedures for creating and installing
6192 new \SpecialChar LyX
6193 layout and template files, as well as offer a refresher on correctly
6194 installing new \SpecialChar LaTeX
6199 \begin_layout Standard
6200 First, let us a say a few words about how one ought to think about the relation
6201 between \SpecialChar LyX
6202 and \SpecialChar LaTeX
6204 The thing to understand is that, in a certain sense, \SpecialChar LyX
6205 doesn't know anything
6206 about \SpecialChar LaTeX
6208 Indeed, from \SpecialChar LyX
6209 's point of view, \SpecialChar LaTeX
6210 is just one of several
6211 \begin_inset Quotes eld
6215 \begin_inset Quotes erd
6218 in which it is capable of producing output.
6219 Other such formats are DocBook, plaintext, and XHTML.
6221 is, of course, a particularly important format, but very little of the
6222 information \SpecialChar LyX
6223 has about \SpecialChar LaTeX
6224 is actually contained in the program itself.
6228 \begin_layout Plain Layout
6229 Some commands are sufficiently complex that they are
6230 \begin_inset Quotes eld
6234 \begin_inset Quotes erd
6237 into \SpecialChar LyX
6239 But the developers generally regard this as a Bad Thing.
6244 Rather, that information, even for the standard classes like
6245 \begin_inset Flex Code
6248 \begin_layout Plain Layout
6254 , is contained in `layout files'.
6255 Similarly, \SpecialChar LyX
6256 itself does not know much about DocBook or XHTML.
6257 What it knows is contained in layout files.
6260 \begin_layout Standard
6261 You can think of the layout file for a given document class as a translation
6262 manual between \SpecialChar LyX
6263 constructs—paragraphs with their corresponding styles,
6264 certain sorts of insets, etc—and the corresponding \SpecialChar LaTeX
6267 Almost everything \SpecialChar LyX
6269 \begin_inset Flex Code
6272 \begin_layout Plain Layout
6278 , for example, is contained in the file
6279 \begin_inset Flex Code
6282 \begin_layout Plain Layout
6288 and in various other files it includes.
6289 For this reason, anyone intending to write layout files should plan to
6290 study the existing files.
6291 A good place to start is with
6292 \begin_inset Flex Code
6295 \begin_layout Plain Layout
6301 , which is included in
6302 \begin_inset Flex Code
6305 \begin_layout Plain Layout
6312 \begin_inset Flex Code
6315 \begin_layout Plain Layout
6321 , and many of the other layout files for document classes.
6322 This file is where sections and the like are defined:
6323 \begin_inset Flex Code
6326 \begin_layout Plain Layout
6332 tells \SpecialChar LyX
6333 how paragraphs that are marked with the Section, Subsection, etc,
6334 styles can be translated into corresponding \SpecialChar LaTeX
6335 , DocBook, and XHTML commands
6338 \begin_inset Flex Code
6341 \begin_layout Plain Layout
6347 file basically just includes several of these
6348 \begin_inset Flex Code
6351 \begin_layout Plain Layout
6360 \begin_layout Standard
6361 Defining the \SpecialChar LyX
6363 correspondence is not the only thing layout files do, though.
6364 Their other job is to define how the \SpecialChar LyX
6365 constructs themselves will appear
6367 The fact that layout files have these two jobs is often a source of confusion,
6368 because they are completely separate.
6369 Telling \SpecialChar LyX
6370 how to translate a certain paragraph style into \SpecialChar LaTeX
6373 how to display it; conversely, telling \SpecialChar LyX
6374 how to display a certain paragraph
6375 style does not tell \SpecialChar LyX
6376 how to translate it into \SpecialChar LaTeX
6377 (let alone tell \SpecialChar LaTeX
6380 So, in general, when you define a new \SpecialChar LyX
6381 construct, you must always do two
6382 quite separate things: (i)
6383 \begin_inset space ~
6386 tell \SpecialChar LyX
6387 how to translate it into \SpecialChar LaTeX
6389 \begin_inset space ~
6392 tell \SpecialChar LyX
6396 \begin_layout Standard
6397 Much the same is true, of course, as regards \SpecialChar LyX
6398 's other backend formats, though
6399 XHTML is in some ways different, because in that case \SpecialChar LyX
6404 able, to some extent, to use information about how it should display a
6405 paragraph on the screen to output information (in the form of CSS) about
6406 how the paragraph should be displayed in a browser.
6407 Even in this case, however, the distinction between what \SpecialChar LyX
6409 and how things are rendered externally remains in force, and the two can
6410 be controlled separately.
6412 \begin_inset CommandInset ref
6414 reference "sec:Tags-for-XHTML"
6421 \begin_layout Section
6422 Installing new \SpecialChar LaTeX
6426 \begin_layout Standard
6427 Some installations may not include a \SpecialChar LaTeX
6428 package or class file that you would
6429 like to use within \SpecialChar LyX
6431 For example, you might need Foil\SpecialChar TeX
6432 , a package for preparing slides for overhead
6434 Modern \SpecialChar LaTeX
6435 distributions like \SpecialChar TeX
6436 Live (2008 or newer) or MiK\SpecialChar TeX
6437 provide a user interface
6438 for installing such packages.
6439 For example, with MiK\SpecialChar TeX
6440 , you start the program
6441 \begin_inset Quotes eld
6445 \begin_inset space ~
6449 \begin_inset Quotes erd
6452 to get a list of available packages.
6453 To install one of them, right click on it or use the corresponding toolbar
6457 \begin_layout Standard
6458 If your \SpecialChar LaTeX
6459 distribution does not provide such a `package manager', or if the
6460 package is not available from your distribution, then follow these steps
6461 to install it manually:
6464 \begin_layout Enumerate
6465 Get the package from
6466 \begin_inset CommandInset href
6469 target "http://www.ctan.org/"
6477 \begin_layout Enumerate
6478 If the package contains a file with the ending
6479 \begin_inset Quotes eld
6483 \begin_inset Flex Code
6486 \begin_layout Plain Layout
6493 \begin_inset Quotes erd
6496 (is the case for Foil\SpecialChar TeX
6497 ) then open a console, change to the folder of this
6498 file and execute the command
6499 \begin_inset Flex Code
6502 \begin_layout Plain Layout
6509 You have now unpacked the package and have all files to install it.
6510 Most \SpecialChar LaTeX
6511 -packages are not packed and you can skip this step.
6514 \begin_layout Enumerate
6515 Now you need to decide if the package should be available for all users
6520 \begin_layout Enumerate
6521 On *nix systems (Linux, OSX, etc.), if you want the new package to be available
6522 for all users on your system, then install it in your `local' \SpecialChar TeX
6524 install it in your own `user' \SpecialChar TeX
6526 Where these trees should be created, if they do not already exist, depends
6528 To find this out, look in the file
6529 \begin_inset Flex Code
6532 \begin_layout Plain Layout
6542 \begin_layout Plain Layout
6543 This is usually in the directory
6544 \begin_inset Flex Code
6547 \begin_layout Plain Layout
6553 , though you can execute the command
6554 \begin_inset Flex Code
6557 \begin_layout Plain Layout
6568 The location of the `local' \SpecialChar TeX
6569 tree is defined by the
6570 \begin_inset Flex Code
6573 \begin_layout Plain Layout
6579 variable; this is usually somewhere like
6580 \begin_inset Flex Code
6583 \begin_layout Plain Layout
6584 /usr/local/share/texmf
6589 or /usr/local/texlive/XXXX where XXXX is the year of the installed \SpecialChar TeX
6592 The location of the `user' \SpecialChar TeX
6594 \begin_inset Flex Code
6597 \begin_layout Plain Layout
6604 \begin_inset Flex Code
6607 \begin_layout Plain Layout
6614 \begin_inset Flex Code
6617 \begin_layout Plain Layout
6626 (If these variables are not predefined, you have to define them.) You'll
6627 probably need root permissions to create or modify the `local' tree, but
6628 not for your `user' tree.
6629 \begin_inset Newline newline
6632 In general, it is recommended to install in the user tree because your user
6633 will not be modified or even overwritten when you upgrade your system.
6634 It will typically also be backed up together with everything else when
6635 you backup your home directory (which, of course, you do on a regular basis).
6638 \begin_layout Enumerate
6639 On Windows, if you want the new package to be available for all users on
6640 your system, change to the folder where \SpecialChar LaTeX
6641 is installed and then change to
6643 \begin_inset Flex Code
6646 \begin_layout Plain Layout
6657 (For MiK\SpecialChar TeX
6658 , this would be by default the folder
6659 \begin_inset Flex Code
6662 \begin_layout Plain Layout
6680 \begin_layout Plain Layout
6681 Note that this will be the correct path only on English installations.
6682 On a German one, it would be
6683 \begin_inset Flex Code
6686 \begin_layout Plain Layout
6700 , and similarly for other languages.
6705 Create there a new folder
6706 \begin_inset Flex Code
6709 \begin_layout Plain Layout
6715 and copy all files of the package into it.
6717 \begin_inset Newline newline
6720 If the package should only available for you or you don't have admin permissions
6721 , do the same, but in the local \SpecialChar LaTeX
6724 \begin_inset space \thinspace{}
6727 g., for MiK\SpecialChar TeX
6729 \begin_inset space ~
6732 2.8 under Windows XP, this would be the folder:
6733 \begin_inset Newline newline
6739 \begin_inset Flex Code
6742 \begin_layout Plain Layout
6745 Documents and Settings
6757 \begin_inset Newline newline
6763 \begin_inset Phantom HPhantom
6766 \begin_layout Plain Layout
6777 \begin_inset Flex Code
6780 \begin_layout Plain Layout
6793 \begin_inset Newline newline
6796 On Vista, it would be:
6797 \begin_inset Newline newline
6801 \begin_inset Flex Code
6804 \begin_layout Plain Layout
6830 \begin_layout Enumerate
6831 Now one only need to tell \SpecialChar LaTeX
6832 that there are new files.
6833 This depends on the used \SpecialChar LaTeX
6838 \begin_layout Enumerate
6839 For \SpecialChar TeX
6840 Live execute the command
6841 \begin_inset Flex Code
6844 \begin_layout Plain Layout
6851 If you installed the package for all users, then you will probably need
6852 to have root permissions for that.
6855 \begin_layout Enumerate
6856 For MiK\SpecialChar TeX
6857 , if you have installed the package for all users, start the program
6859 \begin_inset Quotes eld
6863 \begin_inset space ~
6867 \begin_inset Quotes erd
6870 and press the button marked
6871 \begin_inset Quotes eld
6875 \begin_inset Quotes erd
6879 Otherwise start the program
6880 \begin_inset Quotes eld
6884 \begin_inset Quotes erd
6891 \begin_layout Enumerate
6892 Finally, you need to tell \SpecialChar LyX
6893 that there are new packages available.
6894 So, in \SpecialChar LyX
6896 \begin_inset Flex Noun
6899 \begin_layout Plain Layout
6902 \SpecialChar menuseparator
6908 and then restart \SpecialChar LyX
6912 \begin_layout Standard
6913 Now the package is installed.
6914 In our example, the document class
6915 \begin_inset Flex Code
6918 \begin_layout Plain Layout
6924 will now be available under
6925 \begin_inset Flex Noun
6928 \begin_layout Plain Layout
6929 Document\SpecialChar menuseparator
6930 Settings\SpecialChar menuseparator
6937 \begin_inset Quotes eld
6941 \begin_inset Quotes erd
6948 \begin_layout Standard
6949 If you would like to use a \SpecialChar LaTeX
6950 document class that is not even listed in the
6952 \begin_inset Flex Noun
6955 \begin_layout Plain Layout
6956 Document\SpecialChar menuseparator
6957 Settings\SpecialChar menuseparator
6963 , then you need to create a `layout' file for it.
6964 That is the topic of the next section.
6967 \begin_layout Section
6968 Types of layout files
6971 \begin_layout Standard
6972 This section describes the various sorts of \SpecialChar LyX
6973 files that contain layout informati
6975 These files describe various paragraph and character styles, determining
6976 how \SpecialChar LyX
6977 should display them and how they should be translated into \SpecialChar LaTeX
6979 XHTML, or whatever output format is being used.
6983 \begin_layout Standard
6984 We shall try to provide a thorough description of the process of writing
6986 However, there are so many different types of documents supported even
6987 by just \SpecialChar LaTeX
6988 that we can't hope to cover every different possibility or problem
6989 you might encounter.
6990 The \SpecialChar LyX
6991 users' list is frequented by people with lots of experience with layout
6992 design who are willing to share what they've learned, so please feel free
6993 to ask questions there.
6996 \begin_layout Standard
6997 As you prepare to write a new layout, it is extremely helpful to look at
6998 the layouts distributed with \SpecialChar LyX
7000 If you write a \SpecialChar LyX
7001 layout for a \SpecialChar LaTeX
7002 document class that might also be used by
7003 others, or write a module that might be useful to others, then you should
7004 consider posting your layout to the
7005 \begin_inset CommandInset href
7007 name "layout section on the LyX wiki"
7008 target "https://wiki.lyx.org/Layouts/Layouts"
7013 or even to the \SpecialChar LyX
7014 developers' list, so that it might be included in \SpecialChar LyX
7019 \begin_layout Plain Layout
7020 Note that \SpecialChar LyX
7021 is licensed under the General Public License, so any material
7022 that is contributed to \SpecialChar LyX
7023 must be similarly licensed.
7031 \begin_layout Subsection
7033 \begin_inset CommandInset label
7035 name "subsec:Layout-modules"
7042 \begin_layout Standard
7043 We have spoken to this point about `layout files'.
7044 But there are different sorts of files that contain layout information.
7045 Layout files, strictly so called, have the
7046 \begin_inset Flex Code
7049 \begin_layout Plain Layout
7055 extension and provide \SpecialChar LyX
7056 with information about document classes.
7057 Since \SpecialChar LyX
7058 1.6 layout information can also be contained in layout
7063 \begin_inset Flex Code
7066 \begin_layout Plain Layout
7073 Modules are to \SpecialChar LaTeX
7074 packages much as layouts are to \SpecialChar LaTeX
7075 classes, and some modules—such
7077 \begin_inset Flex Code
7080 \begin_layout Plain Layout
7086 module—specifically provide support for one package.
7087 In a sense, layout modules are similar to included
7091 \begin_layout Plain Layout
7092 These can have any extension, but by convention have the
7093 \begin_inset Flex Code
7096 \begin_layout Plain Layout
7108 \begin_inset Flex Code
7111 \begin_layout Plain Layout
7117 —in that modules are not specific to a given document class but may be used
7118 with many different classes.
7119 The difference is that using an included file with
7120 \begin_inset Flex Code
7123 \begin_layout Plain Layout
7129 requires editing that file.
7130 Modules, by contrast, are selected in the
7131 \begin_inset Flex Noun
7134 \begin_layout Plain Layout
7135 Document\SpecialChar menuseparator
7144 \begin_layout Standard
7145 Building modules is the easiest way to get started with layout editing,
7146 since it can be as simple as adding a single new paragraph style or flex
7148 But modules may, in principle, contain anything a layout file can contain.
7151 \begin_layout Standard
7152 After creating a new module and copying it to the
7153 \begin_inset Flex Code
7156 \begin_layout Plain Layout
7162 folder, you will need to reconfigure and then restart \SpecialChar LyX
7165 However, changes you make to the module will be seen immediately, if you
7167 \begin_inset Flex Noun
7170 \begin_layout Plain Layout
7171 Document\SpecialChar menuseparator
7177 , highlight something, and then hit
7178 \begin_inset Quotes eld
7182 \begin_inset Quotes erd
7188 It is strongly recommended that you save your work before doing this
7193 it is strongly recommended that you not attempt to edit modules while simultaneo
7194 usly working on actual documents
7197 Though of course the developers strive to keep \SpecialChar LyX
7198 stable in such situations,
7199 syntax errors and the like in your module file could cause strange behavior.
7202 \begin_layout Subsubsection
7206 \begin_layout Standard
7207 Modules are to \SpecialChar LyX
7208 as packages are to \SpecialChar LaTeX
7210 Sometimes, however, you find yourself wanting a specific inset or character
7211 style just for one document and writing a module that will also be available
7212 to other documents makes little sense.
7213 What you need is \SpecialChar LyX
7215 \begin_inset Quotes eld
7219 \begin_inset Quotes erd
7225 \begin_layout Standard
7226 You will find it under
7228 Document\SpecialChar menuseparator
7229 Settings\SpecialChar menuseparator
7233 The large text box allows you to enter anything that you might enter in
7234 a layout file or module.
7235 You can think of a document's local layout, in fact, as a module that belongs
7237 So, in particular, you must enter a
7238 \begin_inset Flex Code
7241 \begin_layout Plain Layout
7248 Any format is acceptable, but one would normally use the format current
7250 (In \SpecialChar LyX
7257 , the current layout format is
7266 \begin_layout Standard
7267 When you have entered something in the
7268 \begin_inset Flex Code
7271 \begin_layout Plain Layout
7277 pane, \SpecialChar LyX
7279 \begin_inset Quotes eld
7283 \begin_inset Quotes erd
7286 button at the bottom.
7287 Clicking this button will cause \SpecialChar LyX
7288 to determine whether what you have entered
7289 is valid layout information for the chosen format.
7291 will report the result but, unfortunately, will not tell you what errors
7292 there might have been.
7293 These will be written to the terminal, however, if \SpecialChar LyX
7294 is started from a terminal.
7295 You will not be permitted to save your local layout until you have entered
7299 \begin_layout Standard
7300 The warnings at the end of the previous section apply here, too.
7301 Do not play with local layout while you are actually working, especially
7302 if you have not saved your document.
7303 That said, using local layout with a test document can be a very convenient
7304 way to try out layout ideas, or even to start developing a module.
7307 \begin_layout Subsection
7309 \begin_inset Flex Noun
7312 \begin_layout Plain Layout
7321 \begin_layout Standard
7322 There are two situations you are likely to encounter when wanting to support
7323 a new \SpecialChar LaTeX
7324 document class, involving style (
7325 \begin_inset Flex Code
7328 \begin_layout Plain Layout
7334 ) files and \SpecialChar LaTeX2e
7336 \begin_inset Flex Code
7339 \begin_layout Plain Layout
7346 Supporting a style file is usually fairly easy.
7347 Supporting a new class file is a bit harder.
7348 We'll discuss the former in this section and the latter in the next.
7350 \change_deleted 5863208 1594239023
7351 Similar remarks apply, of course, if you want to support a new DocBook DTD.
7356 \begin_layout Standard
7357 The easier case is the one in which your new document class is provided
7358 as a style file that is to be used in conjunction with an already supported
7360 For the sake of the example, we'll assume that the style file is called
7362 \begin_inset Flex Noun
7365 \begin_layout Plain Layout
7371 and that it is meant to be used with
7372 \begin_inset Flex Noun
7375 \begin_layout Plain Layout
7381 , which is a standard class.
7385 \begin_layout Standard
7386 Start by copying the existing class's layout file into your local directory:
7390 \begin_layout Plain Layout
7391 Of course, which directory is your local directory will vary by platform,
7392 and \SpecialChar LyX
7393 allows you to specify your local directory on startup, too, using
7395 \begin_inset Flex Code
7398 \begin_layout Plain Layout
7412 \begin_layout LyX-Code
7413 cp report.layout ~/.lyx/layouts/myclass.layout
7416 \begin_layout Standard
7418 \begin_inset Flex Code
7421 \begin_layout Plain Layout
7427 and change the line:
7430 \begin_layout LyX-Code
7433 DeclareLaTeXClass{Report (Standard Class)}
7436 \begin_layout Standard
7440 \begin_layout LyX-Code
7443 DeclareLaTeXClass[report, myclass.sty]{Report (My Class)}
7446 \begin_layout Standard
7450 \begin_layout LyX-Code
7452 \begin_inset Newline newline
7458 \begin_inset Newline newline
7464 \begin_layout Standard
7465 near the top of the file.
7468 \begin_layout Standard
7469 Start \SpecialChar LyX
7471 \begin_inset Flex Noun
7474 \begin_layout Plain Layout
7475 Tools\SpecialChar menuseparator
7482 Then restart \SpecialChar LyX
7483 and try creating a new document.
7485 \begin_inset Flex Noun
7488 \begin_layout Plain Layout
7494 " as a document class option in the
7495 \begin_inset Flex Noun
7498 \begin_layout Plain Layout
7499 Document\SpecialChar menuseparator
7506 It is likely that some of the sectioning commands and such in your new
7507 class will work differently from how they worked in the base class—
7508 \begin_inset Flex Code
7511 \begin_layout Plain Layout
7517 in this example—so you can fiddle around with the settings for the different
7518 sections if you wish.
7519 The layout information for sections is contained in
7520 \begin_inset Flex Code
7523 \begin_layout Plain Layout
7529 , but you do not need to copy and change this file.
7530 Instead, you can simply add your changes to your layout file, after the
7532 \begin_inset Flex Code
7535 \begin_layout Plain Layout
7541 , which itself includes
7542 \begin_inset Flex Code
7545 \begin_layout Plain Layout
7552 For example, you might add these lines:
7555 \begin_layout LyX-Code
7559 \begin_layout LyX-Code
7563 \begin_layout LyX-Code
7567 \begin_layout LyX-Code
7571 \begin_layout LyX-Code
7575 \begin_layout Standard
7576 to change the font for chapter headings to sans-serif.
7577 This will override (or, in this case, add to) the existing declaration
7578 for the Chapter style.
7582 \begin_layout Standard
7583 Your new package may also provide commands or environments not present in
7585 In this case, you will want to add these to the layout file.
7587 \begin_inset CommandInset ref
7589 reference "sec:TextClass"
7593 for information on how to do so.
7596 \begin_layout Standard
7598 \begin_inset Flex Noun
7601 \begin_layout Plain Layout
7607 can be used with several different document classes, and even if it cannot,
7608 you might find it easiest just to write a module that you can load with
7610 The simplest possible such module would be:
7613 \begin_layout LyX-Code
7616 DeclareLyXModule{My Class}
7619 \begin_layout LyX-Code
7623 \begin_layout LyX-Code
7624 #Support for myclass.sty.
7627 \begin_layout LyX-Code
7629 \begin_inset Newline newline
7635 \begin_layout LyX-Code
7643 \begin_inset Newline newline
7649 \begin_layout LyX-Code
7651 \begin_inset Newline newline
7657 \begin_inset Newline newline
7663 \begin_layout Standard
7664 A more complex module might modify the behavior of some existing constructs
7665 or define some new ones.
7667 \begin_inset CommandInset ref
7669 reference "sec:TextClass"
7676 \begin_layout Subsection
7678 \begin_inset Flex Noun
7681 \begin_layout Plain Layout
7690 \begin_layout Standard
7691 There are two possibilities here.
7692 One is that the class file is itself based upon an existing document class.
7693 For example, many thesis classes are based upon
7694 \begin_inset Flex Noun
7697 \begin_layout Plain Layout
7704 To see whether yours is, look for a line like
7707 \begin_layout LyX-Code
7713 \begin_layout Standard
7715 If so, then you may proceed largely as in the previous section, though
7717 \begin_inset Flex Code
7720 \begin_layout Plain Layout
7721 Declare\SpecialChar LaTeX
7727 line will be different.
7728 If your new class is
7729 \begin_inset Flex Code
7732 \begin_layout Plain Layout
7738 and it is based upon
7739 \begin_inset Flex Code
7742 \begin_layout Plain Layout
7748 , then the line should read:
7752 \begin_layout Plain Layout
7753 And it will be easiest if you save the file to
7754 \begin_inset Flex Code
7757 \begin_layout Plain Layout
7764 assumes that the document class has the same name as the layout file.
7773 \begin_layout LyX-Code
7776 DeclareLaTeXClass[thesis,book]{thesis}
7779 \begin_layout Standard
7780 If, on the other hand, the new class is not based upon an existing class,
7781 you will probably have to
7782 \begin_inset Quotes eld
7786 \begin_inset Quotes erd
7790 We strongly suggest copying an existing layout file which uses a similar
7792 class and then modifying it, if you can do so.
7793 At least use an existing file as a starting point so you can find out what
7794 items you need to worry about.
7795 Again, the specifics are covered below.
7798 \begin_layout Subsection
7800 \begin_inset CommandInset label
7802 name "subsec:Creating-Templates"
7809 \begin_layout Standard
7810 Once you have written a layout file for a new document class, you might
7811 want to consider writing a
7816 A template acts as a kind of tutorial for your layout, showing how it might
7817 be used, though containing dummy content.
7818 You can of course look at the various templates included with \SpecialChar LyX
7822 \begin_layout Standard
7823 Templates are created just like usual documents: using \SpecialChar LyX
7825 The only difference is that usual documents contain all possible settings,
7826 including the font scheme and the paper size.
7827 Usually a user doesn't want a template to overwrite his preferred settings
7828 for such parameters.
7829 For that reason, the designer of a template should remove the corresponding
7831 \begin_inset Flex Code
7834 \begin_layout Plain Layout
7843 \begin_inset Flex Code
7846 \begin_layout Plain Layout
7854 from the template \SpecialChar LyX
7856 This can be done with any simple text-editor, for example
7857 \begin_inset Flex Code
7860 \begin_layout Plain Layout
7867 \begin_inset Flex Code
7870 \begin_layout Plain Layout
7879 \begin_layout Standard
7880 Put the edited template files you create in
7881 \begin_inset Flex Code
7884 \begin_layout Plain Layout
7890 , copy the ones you use from the global template directory in
7891 \begin_inset Flex Code
7894 \begin_layout Plain Layout
7900 to the same place, and redefine the template path in the
7901 \begin_inset Flex Noun
7904 \begin_layout Plain Layout
7905 Tools\SpecialChar menuseparator
7906 Preferences\SpecialChar menuseparator
7915 \begin_layout Standard
7916 Note, by the way, that there is a template which has a particular meaning:
7917 \begin_inset Newline linebreak
7921 \begin_inset Flex Code
7924 \begin_layout Plain Layout
7931 This template is loaded every time you create a new document with
7932 \begin_inset Flex Noun
7935 \begin_layout Plain Layout
7936 File\SpecialChar menuseparator
7942 in order to provide useful defaults.
7943 To create this template from inside \SpecialChar LyX
7944 , all you have to do is to open a document
7945 with the correct settings, and use the
7946 \begin_inset Flex Noun
7949 \begin_layout Plain Layout
7950 Save as Document Defaults
7958 \begin_layout Subsection
7959 Upgrading old layout files
7962 \begin_layout Standard
7963 The format of layout files changes with each \SpecialChar LyX
7964 release, so old layout files
7965 need to be converted to the new format.
7967 reads a layout file in an older format, it automatically calls the
7969 \begin_inset Flex Code
7972 \begin_layout Plain Layout
7978 to convert it to a temporary file in current format.
7979 The original file is left untouched.
7980 If you use the layout file often, then, you may want to convert it permanently,
7981 so that \SpecialChar LyX
7982 does not have to do so itself every time.
7983 To do this, you can call the converter manually:
7986 \begin_layout Enumerate
7988 \begin_inset Flex Code
7991 \begin_layout Plain Layout
7998 \begin_inset Flex Code
8001 \begin_layout Plain Layout
8010 \begin_layout Enumerate
8012 \begin_inset Newline newline
8016 \begin_inset Flex Code
8019 \begin_layout Plain Layout
8020 python LyXDir/scripts/layout2layout.py myclass.old myclass.layout
8026 \begin_inset Newline newline
8030 \begin_inset Flex Code
8033 \begin_layout Plain Layout
8039 is the name of your \SpecialChar LyX
8043 \begin_layout Standard
8044 Note that manual conversion does not affect included files, so these will
8045 have to be converted separately.
8048 \begin_layout Subsection
8049 \begin_inset CommandInset label
8051 name "subsec:Cite-Engine-Files"
8058 \begin_layout Standard
8059 A specific form of layout files are the so-called
8060 \begin_inset Flex Code
8063 \begin_layout Plain Layout
8069 files that are located in the
8070 \begin_inset Flex Code
8073 \begin_layout Plain Layout
8080 Their purpose is to define the specifics of \SpecialChar LaTeX
8081 packages aimed at bibliography
8094 , but also the way how normal Bib\SpecialChar TeX
8095 citations (without additional packages)
8096 are handled in \SpecialChar LyX
8097 is defined in such a file.
8101 \begin_layout Standard
8102 More specifically, it is defined which packages \SpecialChar LyX
8103 needs to load, which citation
8104 commands are available, how these are to be displayed in \SpecialChar LyX
8106 the dialogs, the context menus) as well as in the XHTML and plain text
8108 Furthermore, the files specify available style variants (author-year, numerical
8109 , etc.) and their specifics.
8110 The cite engine files are also used to generate the options that are available
8113 Document\SpecialChar menuseparator
8114 Settings\SpecialChar menuseparator
8115 Bibliography\SpecialChar menuseparator
8121 \begin_layout Standard
8122 Even though a cite engine file is essentially a normal layout file that
8123 could theoretically include any layout information, it usually primarily
8124 includes some specific parameters such as
8125 \begin_inset Flex Code
8128 \begin_layout Plain Layout
8135 \begin_inset Flex Code
8138 \begin_layout Plain Layout
8145 \begin_inset Flex Code
8148 \begin_layout Plain Layout
8155 \begin_inset Flex Code
8158 \begin_layout Plain Layout
8165 The syntax of the latter two is described in
8166 \begin_inset CommandInset ref
8168 reference "subsec:Citation-engine-description"
8176 \begin_inset CommandInset ref
8178 reference "subsec:Citation-format-description"
8182 , as well as in the files themselves.
8185 \begin_layout Section
8186 \begin_inset CommandInset label
8188 name "sec:TextClass"
8192 The layout file format
8195 \begin_layout Standard
8196 The following sections describe how layout files are structured and written.
8197 Our advice is to go slowly, save and test often.
8198 It is really not that hard, except that the multitude of options can become
8199 overwhelming, especially if you try to check out too many at once.
8200 It becomes easier if you use existing layouts of \SpecialChar LyX
8201 as examples/reference
8202 or if you modify an existing layout to your needs.
8205 \begin_layout Standard
8206 Note that all the tags used in layout files are case-insensitive.
8208 \begin_inset Flex Code
8211 \begin_layout Plain Layout
8218 \begin_inset Flex Code
8221 \begin_layout Plain Layout
8228 \begin_inset Flex Code
8231 \begin_layout Plain Layout
8237 are really the same tag.
8238 The possible arguments are printed in brackets after the tag's name.
8239 The default argument is typeset
8240 \begin_inset Flex Code
8243 \begin_layout Plain Layout
8252 If the argument has a data type like
8253 \begin_inset Quotes eld
8257 \begin_inset Quotes erd
8261 \begin_inset Quotes eld
8265 \begin_inset Quotes erd
8268 , the default is shown like this:
8269 \begin_inset Flex Code
8272 \begin_layout Plain Layout
8283 \begin_layout Subsection
8284 The document class declaration and classification
8287 \begin_layout Standard
8288 Lines in a layout file which begin with
8289 \begin_inset Flex Code
8292 \begin_layout Plain Layout
8299 There is one exception to this rule.
8301 \begin_inset Flex Code
8304 \begin_layout Plain Layout
8310 files should begin with lines like:
8313 \begin_layout LyX-Code
8316 #% Do not delete the line below; configure depends on this
8319 \begin_layout LyX-Code
8324 DeclareLaTeXClass{Article (Standard Class)}
8327 \begin_layout LyX-Code
8332 DeclareCategory{Articles}
8335 \begin_layout Standard
8336 The second and third lines are used when you (re)configure \SpecialChar LyX
8338 The layout file is read by the \SpecialChar LaTeX
8340 \begin_inset Flex Code
8343 \begin_layout Plain Layout
8349 , in a special mode where
8350 \begin_inset Flex Code
8353 \begin_layout Plain Layout
8360 The first line is just a \SpecialChar LaTeX
8361 comment, the second one contains the mandatory
8362 declaration of the text class and the third line contains the optional
8363 classification of the class.
8364 If these lines appear in a file named
8365 \begin_inset Flex Code
8368 \begin_layout Plain Layout
8374 , then they define a text class of name
8375 \begin_inset Flex Code
8378 \begin_layout Plain Layout
8384 (the name of the layout file) which uses the \SpecialChar LaTeX
8386 \begin_inset Flex Code
8389 \begin_layout Plain Layout
8395 (the default is to use the same name as the layout).
8397 \begin_inset Quotes eld
8400 Article (Standard Class)
8401 \begin_inset Quotes erd
8404 that appears above is used as a description of the text class in the
8405 \begin_inset Flex Noun
8408 \begin_layout Plain Layout
8409 Document\SpecialChar menuseparator
8417 \begin_inset Quotes eld
8421 \begin_inset Quotes erd
8424 in the example) is also used in the
8425 \begin_inset Flex Noun
8428 \begin_layout Plain Layout
8429 Document\SpecialChar menuseparator
8435 dialog: the text classes are grouped by these categories (which are usually
8436 genres, so typical categories are
8437 \begin_inset Quotes eld
8441 \begin_inset Quotes erd
8445 \begin_inset Quotes eld
8449 \begin_inset Quotes erd
8453 \begin_inset Quotes eld
8457 \begin_inset Quotes erd
8461 \begin_inset Quotes eld
8465 \begin_inset Quotes erd
8469 \begin_inset Quotes eld
8473 \begin_inset Quotes erd
8477 \begin_inset Quotes eld
8481 \begin_inset Quotes erd
8485 If no category has been declared, the class will be put in the
8486 \begin_inset Quotes eld
8490 \begin_inset Quotes erd
8496 \begin_layout Standard
8497 Let's assume that you wrote your own text class that uses the
8498 \begin_inset Flex Code
8501 \begin_layout Plain Layout
8507 document class, but where you changed the appearance of the section headings.
8508 If you put it in a file
8509 \begin_inset Flex Code
8512 \begin_layout Plain Layout
8518 , the header of this file should be:
8521 \begin_layout LyX-Code
8524 #% Do not delete the line below; configure depends on this
8527 \begin_layout LyX-Code
8532 DeclareLaTeXClass[article]{Article (with My Own Headings)}
8535 \begin_layout LyX-Code
8540 DeclareCategory{Articles}
8543 \begin_layout Standard
8544 This declares a text class
8545 \begin_inset Flex Code
8548 \begin_layout Plain Layout
8554 , associated with the \SpecialChar LaTeX
8556 \begin_inset Flex Code
8559 \begin_layout Plain Layout
8566 \begin_inset Quotes eld
8569 Article (with My Own Headings)
8570 \begin_inset Quotes erd
8574 If your text class depends on several packages, you can declare it as:
8577 \begin_layout LyX-Code
8580 #% Do not delete the line below; configure depends on this
8583 \begin_layout LyX-Code
8588 DeclareLaTeXClass[article,foo.sty]{Article (with My Own Headings)}
8591 \begin_layout LyX-Code
8596 DeclareCategory{Articles}
8599 \begin_layout Standard
8600 This indicates that your text class uses the
8601 \begin_inset Flex Code
8604 \begin_layout Plain Layout
8612 \change_deleted 5863208 1594239179
8613 Finally, it is also possible to declare classes for DocBook code.
8614 Typical declarations will look like:
8617 \begin_layout LyX-Code
8619 \change_deleted 5863208 1594239179
8622 #% Do not delete the line below; configure depends on this
8625 \begin_layout LyX-Code
8627 \change_deleted 5863208 1594239179
8632 DeclareDocBookClass[article]{SGML (DocBook Article)}
8635 \begin_layout LyX-Code
8637 \change_deleted 5863208 1594239179
8642 DeclareCategory{Articles (DocBook)}
8647 \begin_layout Standard
8648 Note that these declarations can also be given an optional parameter declaring
8649 the name of the document class (but not a list).
8652 \begin_layout Standard
8653 So, to be as explicit as possible, the form of the layout declaration is:
8656 \begin_layout LyX-Code
8661 DeclareLaTeXClass[class,package.sty]{layout description}
8664 \begin_layout LyX-Code
8669 DeclareCategory{category}
8672 \begin_layout Standard
8673 The class need only be specified if the name of the \SpecialChar LaTeX
8675 name of the layout file are different or if there are packages to load.
8676 If the name of the class file is not specified, then \SpecialChar LyX
8678 that it is the same as the name of the layout file.
8681 \begin_layout Standard
8682 When the text class has been modified to your taste, all you have to do
8683 is to copy it either to
8684 \begin_inset Flex Code
8687 \begin_layout Plain Layout
8694 \begin_inset Flex Code
8697 \begin_layout Plain Layout
8704 \begin_inset Flex Noun
8707 \begin_layout Plain Layout
8708 Tools\SpecialChar menuseparator
8714 , exit \SpecialChar LyX
8716 Then your new text class should be available along with the others.
8719 \begin_layout Standard
8720 Once the layout file is installed, you can edit it and see your changes
8721 without having to reconfigure or to restart \SpecialChar LyX
8726 \begin_layout Plain Layout
8727 In versions of \SpecialChar LyX
8728 prior to 1.6, this was not true.
8729 As a result, editing layout files was very time consuming, since you had
8730 constantly to restart \SpecialChar LyX
8736 You can force a reload of the current layout by using the \SpecialChar LyX
8738 \begin_inset Flex Noun
8741 \begin_layout Plain Layout
8748 There is no default binding for this function—though, of course, you can
8749 bind it to a key yourself.
8750 But you will normally use this function simply by entering it in the mini-buffe
8755 \begin_layout Standard
8761 \begin_inset Flex Noun
8764 \begin_layout Plain Layout
8770 is very much an `advanced feature'.
8775 recommended that you save your work before using this function.
8780 recommended that you not attempt to edit layout information while simultaneousl
8781 y working on a document that you care about.
8782 Use a test document.
8783 Syntax errors and the like in your layout file could cause peculiar behavior.
8784 In particular, such errors could cause \SpecialChar LyX
8785 to regard the current layout as
8786 invalid and to attempt to switch to some other layout.
8790 \begin_layout Plain Layout
8791 Really bad syntax errors may even caused \SpecialChar LyX
8793 This is because certain sorts of errors may make \SpecialChar LyX
8804 The \SpecialChar LyX
8805 team strives to keep \SpecialChar LyX
8806 stable in such situations, but safe is better
8811 \begin_layout Plain Layout
8812 While we're giving advice: make regular backups.
8813 And be nice to your mother.
8821 \begin_layout Subsection
8822 The Module declaration
8825 \begin_layout Standard
8826 A module must begin with a line like the following:
8829 \begin_layout LyX-Code
8832 DeclareLyXModule[endnotes.sty]{Endnotes}
8833 \change_inserted -712698321 1554395911
8837 \begin_layout LyX-Code
8839 \change_inserted -712698321 1554395924
8844 DeclareCategory{Foot- and Endnotes}
8845 \change_deleted -712698321 1554395911
8853 \begin_layout Standard
8854 The mandatory argument
8855 \change_inserted -712698321 1554395956
8864 , in curly brackets, is the name of the module, as it should appear in
8865 \begin_inset Flex Noun
8868 \begin_layout Plain Layout
8869 Document\SpecialChar menuseparator
8870 Settings\SpecialChar menuseparator
8877 The argument in square brackets is optional: It declares any \SpecialChar LaTeX
8879 on which the module depends.
8880 It is also possible to use the form
8881 \begin_inset Flex Noun
8884 \begin_layout Plain Layout
8890 as an optional argument, which declares that the module can only be used
8891 when there exists a conversion chain between the formats `
8892 \begin_inset Flex Code
8895 \begin_layout Plain Layout
8902 \begin_inset Flex Code
8905 \begin_layout Plain Layout
8913 \change_inserted -712698321 1554396133
8920 declaration is not strictly mandatory, but you should add it, since it
8921 is helpful to find the module.
8922 Please have a look at the existing module categories and if appropriate,
8928 \begin_layout Standard
8930 \change_inserted -712698321 1554395988
8933 declaration should then be followed by lines like the following:
8937 \begin_layout Plain Layout
8938 Preferably in English if the module should be published with \SpecialChar LyX
8940 This description will appear in the list of messages to be translated and
8941 will be thus translated with the next interface update.
8949 \begin_layout LyX-Code
8953 \begin_layout LyX-Code
8954 #Adds an endnote command, in addition to footnotes.
8958 \begin_layout LyX-Code
8959 #You will need to add
8961 theendnotes in TeX code where you
8964 \begin_layout LyX-Code
8965 #want the endnotes to appear.
8969 \begin_layout LyX-Code
8973 \begin_layout LyX-Code
8974 #Requires: somemodule | othermodule
8977 \begin_layout LyX-Code
8978 #Excludes: badmodule
8981 \begin_layout Standard
8982 The description is used in
8983 \begin_inset Flex Noun
8986 \begin_layout Plain Layout
8987 Document\SpecialChar menuseparator
8988 Settings\SpecialChar menuseparator
8994 to provide the user with information about what the module does.
8996 \begin_inset Flex Code
8999 \begin_layout Plain Layout
9005 line is used to identify other modules with which this one must be used;
9007 \begin_inset Flex Code
9010 \begin_layout Plain Layout
9016 line is used to identify modules with which this one may not be used.
9017 Both are optional, and, as shown, multiple modules should be separated
9018 with the pipe symbol: |.
9019 Note that the required modules are treated disjunctively:
9023 of the required modules must be used.
9028 excluded module may be used.
9029 Note that modules are identified here by their filenames without the
9030 \begin_inset Flex Code
9033 \begin_layout Plain Layout
9041 \begin_inset Flex Code
9044 \begin_layout Plain Layout
9051 \begin_inset Flex Code
9054 \begin_layout Plain Layout
9063 \begin_layout Subsection
9064 The CiteEngine file declaration
9067 \begin_layout Standard
9068 A cite engine file must begin with a line like the following:
9071 \begin_layout LyX-Code
9074 DeclareLyXCiteEngineModule[biblatex.sty]{Biblatex}
9077 \begin_layout Standard
9078 The mandatory argument, in curly brackets, is the name of the cite style,
9079 as it should appear in
9080 \begin_inset Flex Noun
9083 \begin_layout Plain Layout
9084 Document\SpecialChar menuseparator
9085 Settings\SpecialChar menuseparator
9092 The argument in square brackets is optional: It declares any \SpecialChar LaTeX
9094 on which the cite engine depends.
9097 \begin_layout Standard
9098 The cite engine declaration should then be followed by lines like the following:
9102 \begin_layout Plain Layout
9103 Preferably in English if the module should be published with \SpecialChar LyX
9105 This description will appear in the list of messages to be translated and
9106 will be thus translated with the next interface update.
9114 \begin_layout LyX-Code
9118 \begin_layout LyX-Code
9119 # Biblatex supports many author-year and numerical styles.
9122 \begin_layout LyX-Code
9123 # It is mainly aimed at the Humanities.
9127 \begin_layout LyX-Code
9128 # customizable, fully localized and provides many features
9131 \begin_layout LyX-Code
9132 # that are not possible with BibTeX.
9133 The use of 'biber' as
9136 \begin_layout LyX-Code
9137 # bibliography processor is advised.
9140 \begin_layout LyX-Code
9144 \begin_layout Standard
9145 The description is used in
9146 \begin_inset Flex Noun
9149 \begin_layout Plain Layout
9150 Document\SpecialChar menuseparator
9151 Settings\SpecialChar menuseparator
9157 to provide the user with information about the cite engine.
9160 \begin_layout Subsection
9164 \begin_layout Standard
9165 The first non-comment line of any layout file, included file, or module
9170 contain the file format number:
9173 \begin_layout Description
9174 \begin_inset Flex Code
9177 \begin_layout Plain Layout
9184 \begin_inset Flex Code
9187 \begin_layout Plain Layout
9193 ] The format number of the layout file.
9196 \begin_layout Standard
9197 This tag was introduced with \SpecialChar LyX
9199 \begin_inset space ~
9203 Layout files from older \SpecialChar LyX
9204 versions do not have an explicit file format and
9205 are considered to have
9206 \begin_inset Flex Code
9209 \begin_layout Plain Layout
9211 \begin_inset space ~
9220 The format for the present version of \SpecialChar LyX
9222 But each version of \SpecialChar LyX
9223 is capable of reading earlier versions' layout files,
9224 just as they are capable of reading files produced by earlier versions
9227 There is, however, no provision for converting to earlier formats.
9230 \begin_layout Subsection
9231 \begin_inset CommandInset label
9233 name "subsec:General-text-class"
9237 General text class parameters
9240 \begin_layout Standard
9241 These are general parameters that govern the behavior of an entire document
9247 mean that they must appear in
9248 \begin_inset Flex Code
9251 \begin_layout Plain Layout
9257 files rather than in modules.
9258 A module can contain any layout tag.)
9261 \begin_layout Description
9263 \change_inserted -712698321 1526899478
9264 \begin_inset Flex Code
9267 \begin_layout Plain Layout
9269 \change_inserted -712698321 1526898610
9270 AddToCiteEngine <engine>
9277 Extends the possibilities for displaying citation references.
9279 \begin_inset CommandInset ref
9281 reference "subsec:Citation-engine-description"
9290 \begin_inset Flex Code
9293 \begin_layout Plain Layout
9295 \change_inserted -712698321 1526898823
9306 \begin_layout Description
9307 \begin_inset Flex Code
9310 \begin_layout Plain Layout
9316 Adds information that will be output in the
9317 \begin_inset Flex Code
9320 \begin_layout Plain Layout
9326 block when the document is output to XHTML.
9327 Typically, this would be used to output CSS style information, but it can
9328 be used for anything that can appear in
9329 \begin_inset Flex Code
9332 \begin_layout Plain Layout
9340 \begin_inset Quotes eld
9344 \begin_inset Flex Code
9347 \begin_layout Plain Layout
9354 \begin_inset Quotes erd
9360 \begin_layout Description
9361 \begin_inset Flex Code
9364 \begin_layout Plain Layout
9370 Adds information to the document preamble.
9372 \begin_inset Newline newline
9376 \begin_inset Quotes eld
9380 \begin_inset Flex Code
9383 \begin_layout Plain Layout
9390 \begin_inset Quotes erd
9394 \change_inserted -712698321 1562592950
9398 \begin_layout Description
9400 \change_inserted -712698321 1562593040
9401 \begin_inset Flex Code
9404 \begin_layout Plain Layout
9406 \change_inserted -712698321 1562592954
9415 \begin_inset Flex Code
9418 \begin_layout Plain Layout
9420 \change_inserted -712698321 1562592950
9431 \begin_inset space \thinspace{}
9435 \begin_inset Flex Code
9438 \begin_layout Plain Layout
9440 \change_inserted -712698321 1562592950
9448 ] If the document class adds the bibliography to the table of contents,
9449 add this option with value
9450 \begin_inset Flex Code
9453 \begin_layout Plain Layout
9455 \change_inserted -712698321 1562592996
9464 \begin_inset Flex Code
9467 \begin_layout Plain Layout
9469 \change_inserted -712698321 1562593006
9478 This prevents the bibliography from being added twice.
9483 \begin_layout Description
9484 \begin_inset Flex Code
9487 \begin_layout Plain Layout
9493 Defines the possibilities for displaying citation references.
9495 \begin_inset CommandInset ref
9497 reference "subsec:Citation-engine-description"
9506 \begin_inset Quotes eld
9510 \begin_inset Flex Code
9513 \begin_layout Plain Layout
9520 \begin_inset Quotes erd
9524 Primarily used in cite engine files (see
9525 \begin_inset CommandInset ref
9527 reference "subsec:Cite-Engine-Files"
9536 \change_inserted -712698321 1526898530
9537 Note that if you specify this in a layout file or module, any cite engine
9538 definition will be overridden.
9540 \begin_inset Flex Code
9543 \begin_layout Plain Layout
9545 \change_inserted -712698321 1526898530
9558 \begin_layout Description
9559 \begin_inset Flex Code
9562 \begin_layout Plain Layout
9568 Defines formats for use in the display of bibliographic information.
9570 \begin_inset CommandInset ref
9572 reference "subsec:Citation-format-description"
9578 \begin_inset Quotes eld
9582 \begin_inset Flex Code
9585 \begin_layout Plain Layout
9592 \begin_inset Quotes erd
9596 Primarily used in cite engine files (see
9597 \begin_inset CommandInset ref
9599 reference "subsec:Cite-Engine-Files"
9608 \change_inserted -712698321 1526898585
9609 A cite format defined in a layout or module will override the cite engine
9615 \begin_layout Description
9616 \begin_inset Flex Code
9619 \begin_layout Plain Layout
9626 \begin_inset Flex Code
9629 \begin_layout Plain Layout
9638 \begin_inset Flex Code
9641 \begin_layout Plain Layout
9647 ] Determines whether
9651 or Bib\SpecialChar TeX
9652 is used to generate a Bibliography.
9653 Primarily used in cite engine files (see
9654 \begin_inset CommandInset ref
9656 reference "subsec:Cite-Engine-Files"
9666 \begin_layout Description
9667 \begin_inset Flex Code
9670 \begin_layout Plain Layout
9676 Describes various global options supported by the document class.
9678 \begin_inset CommandInset ref
9680 reference "subsec:ClassOptions"
9686 \begin_inset Quotes eld
9690 \begin_inset Flex Code
9693 \begin_layout Plain Layout
9700 \begin_inset Quotes erd
9706 \begin_layout Description
9707 \begin_inset Flex Code
9710 \begin_layout Plain Layout
9717 \begin_inset Flex Code
9720 \begin_layout Plain Layout
9729 \begin_inset space \thinspace{}
9733 \begin_inset Flex Code
9736 \begin_layout Plain Layout
9742 ] Whether the class should
9746 to having one or two columns.
9747 Can be changed in the
9748 \begin_inset Flex Noun
9751 \begin_layout Plain Layout
9752 Document\SpecialChar menuseparator
9761 \begin_layout Description
9762 \begin_inset Flex Code
9765 \begin_layout Plain Layout
9772 \begin_inset Flex Code
9775 \begin_layout Plain Layout
9781 ] This sequence defines the properties for a counter.
9782 If the counter does not yet exist, it is created; if it does exist, it
9785 \begin_inset Quotes eld
9789 \begin_inset Flex Code
9792 \begin_layout Plain Layout
9799 \begin_inset Quotes erd
9803 \begin_inset Newline newline
9807 \begin_inset CommandInset ref
9809 reference "subsec:Counters"
9813 for details on counters.
9816 \begin_layout Description
9817 \begin_inset Flex Code
9820 \begin_layout Plain Layout
9826 Sets the default font used to display the document.
9828 \begin_inset CommandInset ref
9830 reference "subsec:Font-description"
9834 for how to declare fonts.
9836 \begin_inset Quotes eld
9840 \begin_inset Flex Code
9843 \begin_layout Plain Layout
9850 \begin_inset Quotes erd
9856 \begin_layout Description
9857 \begin_inset Flex Code
9860 \begin_layout Plain Layout
9867 \begin_inset Flex Code
9870 \begin_layout Plain Layout
9876 ] Specifies a module to be included by default with this document class.
9877 The module is specified as filename without the
9878 \begin_inset Flex Code
9881 \begin_layout Plain Layout
9888 The user can still remove the module, but it will be active at the outset.
9889 (This applies only when new files are created, or when this class is chosen
9890 for an existing document.)
9893 \begin_layout Description
9894 \begin_inset Flex Code
9897 \begin_layout Plain Layout
9904 \begin_inset Flex Code
9907 \begin_layout Plain Layout
9913 ] This is the style that will be assigned to new paragraphs, usually
9914 \begin_inset Flex Noun
9917 \begin_layout Plain Layout
9924 This will default to the first defined style if not given, but you are
9925 encouraged to use this directive.
9928 \begin_layout Description
9930 \change_inserted -970929547 1515112870
9931 \begin_inset Flex Code
9934 \begin_layout Plain Layout
9936 \change_inserted -970929547 1515112782
9945 \begin_inset Flex Code
9948 \begin_layout Plain Layout
9950 \change_inserted -970929547 1515112766
9958 ] The root element (at the top of the document) to use when outputting documents
9959 with this class in DocBook.
9960 The default value is
9961 \begin_inset Quotes eld
9965 \begin_inset Flex Code
9968 \begin_layout Plain Layout
9970 \change_inserted -970929547 1515112845
9979 \begin_inset Quotes erd
9984 \change_deleted 1075283030 1594226862
9986 \change_inserted 1075283030 1594226777
9990 \begin_layout Description
9992 \change_inserted 1075283030 1594226859
9993 \begin_inset Flex Code
9996 \begin_layout Plain Layout
9998 \change_inserted 1075283030 1594226785
9999 DocBookForceAbstract
10007 \begin_inset Flex Code
10010 \begin_layout Plain Layout
10012 \change_inserted 1075283030 1594226804
10021 \begin_inset Quotes eld
10029 \begin_inset Quotes erd
10032 , the root element will always have an
10037 The default value is
10038 \begin_inset Quotes eld
10046 \begin_inset Quotes erd
10054 \begin_layout Description
10055 \begin_inset Flex Code
10058 \begin_layout Plain Layout
10065 \begin_inset Flex Code
10068 \begin_layout Plain Layout
10074 ] This tag indicates that the module (which is specified by filename without
10076 \begin_inset Flex Code
10079 \begin_layout Plain Layout
10085 extension) cannot be used with this document class.
10086 This might be used in a journal-specific layout file to prevent, say, the
10088 \begin_inset Flex Code
10091 \begin_layout Plain Layout
10097 module that numbers theorems by section.
10102 be used in a module.
10103 Modules have their own way of excluding other modules (see
10104 \begin_inset CommandInset ref
10106 reference "subsec:Layout-modules"
10113 \begin_layout Description
10114 \begin_inset Flex Code
10117 \begin_layout Plain Layout
10123 Defines a new float.
10125 \begin_inset CommandInset ref
10127 reference "subsec:Floats"
10133 \begin_inset Quotes eld
10137 \begin_inset Flex Code
10140 \begin_layout Plain Layout
10147 \begin_inset Quotes erd
10153 \begin_layout Description
10154 \begin_inset Flex Code
10157 \begin_layout Plain Layout
10163 Sets the information that will be output in the
10164 \begin_inset Flex Code
10167 \begin_layout Plain Layout
10173 block when this document class is output to XHTML.
10174 Note that this will completely override any prior
10175 \begin_inset Flex Code
10178 \begin_layout Plain Layout
10185 \begin_inset Flex Code
10188 \begin_layout Plain Layout
10196 \begin_inset Newline newline
10200 \begin_inset Flex Code
10203 \begin_layout Plain Layout
10209 if you just want to add material to the preamble.) Must end with
10210 \begin_inset Quotes eld
10214 \begin_inset Flex Code
10217 \begin_layout Plain Layout
10224 \begin_inset Quotes erd
10230 \begin_layout Description
10231 \begin_inset Flex Code
10234 \begin_layout Plain Layout
10241 \begin_inset Flex Code
10244 \begin_layout Plain Layout
10250 ] The style to use for the table of contents, bibliography, and so forth,
10251 when the document is output to HTML.
10252 For articles, this should normally be
10253 \begin_inset Flex Code
10256 \begin_layout Plain Layout
10263 \begin_inset Flex Code
10266 \begin_layout Plain Layout
10273 If it is not given, then \SpecialChar LyX
10274 will attempt to figure out which layout to use.
10277 \begin_layout Description
10278 \begin_inset Flex Code
10281 \begin_layout Plain Layout
10288 \begin_inset Flex Code
10291 \begin_layout Plain Layout
10297 ] Modifies the properties of the given counter.
10298 If the counter does not exist, the statement is ignored.
10300 \begin_inset Quotes eld
10304 \begin_inset Flex Code
10307 \begin_layout Plain Layout
10314 \begin_inset Quotes erd
10318 \begin_inset Newline newline
10322 \begin_inset CommandInset ref
10324 reference "subsec:Counters"
10328 for details on counters.
10331 \begin_layout Description
10332 \begin_inset Flex Code
10335 \begin_layout Plain Layout
10342 \begin_inset Flex Code
10345 \begin_layout Plain Layout
10351 ] This allows you to include another layout definition file within yours
10352 to avoid duplicating commands.
10353 Common examples are the standard layout files, for example,
10354 \begin_inset Flex Code
10357 \begin_layout Plain Layout
10363 , which contains most of the basic layouts.
10366 \begin_layout Description
10367 \begin_inset Flex Code
10370 \begin_layout Plain Layout
10377 \begin_inset Flex Code
10380 \begin_layout Plain Layout
10386 ] This section (re-)defines the layout of an inset.
10387 It can be applied to an existing inset or to a new, user-defined inset,
10388 e.g., a new character style.
10390 \begin_inset Quotes eld
10394 \begin_inset Flex Code
10397 \begin_layout Plain Layout
10404 \begin_inset Quotes erd
10408 \begin_inset Newline newline
10412 \begin_inset CommandInset ref
10414 reference "subsec:Flex-insets-and"
10418 for more information.
10422 \begin_layout Description
10423 \begin_inset Flex Code
10426 \begin_layout Plain Layout
10433 \begin_inset Flex Code
10436 \begin_layout Plain Layout
10442 ] A string that indicates the width of the left margin on the screen, for
10444 \begin_inset Quotes eld
10448 \begin_inset Flex Code
10451 \begin_layout Plain Layout
10458 \begin_inset Quotes erd
10462 (Note that this is not a `length', like
10463 \begin_inset Quotes eld
10467 \begin_inset Quotes erd
10473 \begin_layout Description
10474 \begin_inset Flex Code
10477 \begin_layout Plain Layout
10484 \begin_inset Flex Code
10487 \begin_layout Plain Layout
10493 ] An integer that determines the maximal number of names displayed in an
10494 author-year citation before the citation switches to
10495 \begin_inset Quotes eld
10499 \begin_inset Quotes erd
10503 Primarily used in cite engine files (see
10504 \begin_inset CommandInset ref
10506 reference "subsec:Cite-Engine-Files"
10516 \begin_layout Description
10517 \begin_inset Flex Code
10520 \begin_layout Plain Layout
10527 \begin_inset Flex Code
10530 \begin_layout Plain Layout
10536 ] Modifies the properties of the given paragraph style.
10537 If the style does not exist, this section is ignored.
10539 \begin_inset Quotes eld
10543 \begin_inset Flex Code
10546 \begin_layout Plain Layout
10553 \begin_inset Quotes erd
10559 \begin_layout Description
10560 \begin_inset Flex Code
10563 \begin_layout Plain Layout
10570 \begin_inset Flex Code
10573 \begin_layout Plain Layout
10579 ] Deletes an existing counter, usually one defined in an included file.
10582 \begin_layout Description
10583 \begin_inset Flex Code
10586 \begin_layout Plain Layout
10593 \begin_inset Flex Code
10596 \begin_layout Plain Layout
10602 ] Deletes an existing float.
10603 This is particularly useful when you want to suppress a float that has
10604 been defined in an input file.
10607 \begin_layout Description
10608 \begin_inset Flex Code
10611 \begin_layout Plain Layout
10618 \begin_inset Flex Code
10621 \begin_layout Plain Layout
10627 ] Deletes an existing style.
10630 \begin_layout Description
10631 \begin_inset Flex Code
10634 \begin_layout Plain Layout
10641 \begin_inset Flex Code
10644 \begin_layout Plain Layout
10651 \begin_inset Flex Code
10654 \begin_layout Plain Layout
10660 ] Define a new table of contents with type
10661 \begin_inset Flex Code
10664 \begin_layout Plain Layout
10671 \begin_inset Flex Code
10674 \begin_layout Plain Layout
10681 See also the AddToToc commands.
10684 \begin_layout Description
10685 \begin_inset Flex Code
10688 \begin_layout Plain Layout
10695 \begin_inset Flex Code
10698 \begin_layout Plain Layout
10704 ] The file format (as defined in the \SpecialChar LyX
10705 preferences) produced by this document
10707 It is mainly useful when
10708 \begin_inset Flex Code
10711 \begin_layout Plain Layout
10718 \begin_inset Flex Code
10721 \begin_layout Plain Layout
10727 and one wants to define a new type of literate document.
10728 The format is reset to
10729 \change_deleted 5863208 1594239413
10731 \begin_inset Quotes eld
10735 \begin_inset Flex Code
10738 \begin_layout Plain Layout
10745 \begin_inset Quotes erd
10751 \begin_inset Quotes eld
10755 \begin_inset Flex Code
10758 \begin_layout Plain Layout
10765 \begin_inset Quotes erd
10768 when the corresponding
10769 \begin_inset Flex Code
10772 \begin_layout Plain Layout
10778 parameter is encountered.
10781 \begin_layout Description
10782 \begin_inset Flex Code
10785 \begin_layout Plain Layout
10792 \begin_inset Flex Code
10795 \begin_layout Plain Layout
10806 \change_deleted 5863208 1594239430
10808 \begin_inset Flex Code
10811 \begin_layout Plain Layout
10820 \begin_inset Flex Code
10823 \begin_layout Plain Layout
10829 ] Specifies what sort of output documents using this class will produce.
10832 \begin_layout Description
10833 \begin_inset Flex Code
10836 \begin_layout Plain Layout
10843 \begin_inset Flex Code
10846 \begin_layout Plain Layout
10853 \begin_inset Flex Code
10856 \begin_layout Plain Layout
10862 ] Specifies options, given in the second string, for the package named by
10865 \begin_inset Quotes eld
10869 \begin_inset Flex Code
10872 \begin_layout Plain Layout
10873 PackageOptions natbib square
10879 \begin_inset Quotes erd
10883 \begin_inset Flex Code
10886 \begin_layout Plain Layout
10892 to be loaded with the
10893 \begin_inset Flex Code
10896 \begin_layout Plain Layout
10903 (For \SpecialChar TeX
10904 perts, this causes \SpecialChar LyX
10906 \begin_inset Flex Code
10909 \begin_layout Plain Layout
10912 PassOptionsToPackage{natbib}{square}
10918 \begin_inset Flex Code
10921 \begin_layout Plain Layout
10928 \change_inserted -712698321 1565102364
10932 \begin_layout Description
10934 \change_inserted -712698321 1565102470
10935 \begin_inset Flex Code
10938 \begin_layout Plain Layout
10940 \change_inserted -712698321 1565102365
10949 \begin_inset Flex Code
10952 \begin_layout Plain Layout
10954 \change_inserted -712698321 1565105222
10959 , letter, legal, executive, a0, a1, a2, a3, a4, a5, a6, b0, b1, b2, b3,
10960 b4, b5, b6, c0, c1, c2, c3, c4, c5, c6, b0j, b1j, b2j, b3j, b4j, b5j, b6j
10967 ] The default page size.
10968 This is used by some converters.
10973 \begin_layout Description
10974 \begin_inset Flex Code
10977 \begin_layout Plain Layout
10984 \begin_inset Flex Code
10987 \begin_layout Plain Layout
10996 \begin_inset Flex Code
10999 \begin_layout Plain Layout
11006 \begin_inset Flex Code
11009 \begin_layout Plain Layout
11015 ] The default pagestyle.
11016 Can be changed in the
11017 \begin_inset Flex Noun
11020 \begin_layout Plain Layout
11021 Document\SpecialChar menuseparator
11030 \begin_layout Description
11031 \begin_inset Flex Code
11034 \begin_layout Plain Layout
11040 Sets the preamble for the \SpecialChar LaTeX
11042 Note that this will completely override any prior
11043 \begin_inset Flex Code
11046 \begin_layout Plain Layout
11053 \begin_inset Flex Code
11056 \begin_layout Plain Layout
11064 \begin_inset Flex Code
11067 \begin_layout Plain Layout
11073 if you just want to add material to the preamble.) Must end with
11074 \begin_inset Quotes eld
11078 \begin_inset Flex Code
11081 \begin_layout Plain Layout
11088 \begin_inset Quotes erd
11094 \begin_layout Description
11095 \begin_inset Flex Code
11098 \begin_layout Plain Layout
11105 \begin_inset Flex Code
11108 \begin_layout Plain Layout
11115 \begin_inset Flex Code
11118 \begin_layout Plain Layout
11127 \begin_inset space \thinspace{}
11131 \begin_inset Flex Code
11134 \begin_layout Plain Layout
11140 ] Whether the class already provides the feature
11141 \begin_inset Flex Code
11144 \begin_layout Plain Layout
11151 A feature is in general the name of a package (e.
11152 \begin_inset space \thinspace{}
11156 \begin_inset space \space{}
11160 \begin_inset Flex Code
11163 \begin_layout Plain Layout
11170 \begin_inset Flex Code
11173 \begin_layout Plain Layout
11180 \begin_inset space \thinspace{}
11184 \begin_inset space \space{}
11188 \begin_inset Flex Code
11191 \begin_layout Plain Layout
11198 \begin_inset Flex Code
11201 \begin_layout Plain Layout
11209 \begin_inset CommandInset ref
11211 reference "chap:List-of-functions"
11215 for the list of features.
11218 \begin_layout Description
11219 \begin_inset Flex Code
11222 \begin_layout Plain Layout
11229 \begin_inset Flex Code
11232 \begin_layout Plain Layout
11238 ] Indicates that this layout provides the functionality of the module mentioned,
11239 which should be specified by the filename without the
11240 \begin_inset Flex Code
11243 \begin_layout Plain Layout
11250 This will typically be used if the layout includes the module directly,
11251 rather than using the
11252 \begin_inset Flex Code
11255 \begin_layout Plain Layout
11261 tag to indicate that it ought to be used.
11262 It could also be used in a module that provided an alternate implementation
11263 of the same functionality.
11266 \begin_layout Description
11267 \begin_inset Flex Code
11270 \begin_layout Plain Layout
11277 \begin_inset Flex Code
11280 \begin_layout Plain Layout
11286 ] Creates a new paragraph style if it does not already exist.
11287 If the style does exist, this section is ignored.
11289 \begin_inset Quotes eld
11293 \begin_inset Flex Code
11296 \begin_layout Plain Layout
11303 \begin_inset Quotes erd
11309 \begin_layout Description
11310 \begin_inset Flex Code
11313 \begin_layout Plain Layout
11320 \begin_inset Flex Code
11323 \begin_layout Plain Layout
11329 ] Whether the class requires the feature
11330 \begin_inset Flex Code
11333 \begin_layout Plain Layout
11340 Multiple features must be separated by commas.
11341 Note that you can only request supported features.
11343 \begin_inset CommandInset ref
11345 reference "chap:List-of-functions"
11349 for the list of features.).
11350 If you require a package with specific options, you can additionally use
11352 \begin_inset Flex Code
11355 \begin_layout Plain Layout
11364 \begin_layout Description
11365 \begin_inset Flex Code
11368 \begin_layout Plain Layout
11375 \begin_inset Flex Code
11378 \begin_layout Plain Layout
11384 ] A string that indicates the width of the right margin on the screen, for
11386 \begin_inset Quotes eld
11390 \begin_inset Flex Code
11393 \begin_layout Plain Layout
11400 \begin_inset Quotes erd
11406 \begin_layout Description
11407 \begin_inset Flex Code
11410 \begin_layout Plain Layout
11417 \begin_inset Flex Code
11420 \begin_layout Plain Layout
11426 ] Sets which divisions get numbered.
11428 \begin_inset Newline newline
11432 \begin_inset Flex Code
11435 \begin_layout Plain Layout
11441 counter in \SpecialChar LaTeX
11445 \begin_layout Description
11446 \begin_inset Flex Code
11449 \begin_layout Plain Layout
11456 \begin_inset Flex Code
11459 \begin_layout Plain Layout
11468 \begin_inset space \thinspace{}
11472 \begin_inset Flex Code
11475 \begin_layout Plain Layout
11481 ] Whether the class-default should be printing on one or both sides of the
11483 Can be changed in the
11484 \begin_inset Flex Noun
11487 \begin_layout Plain Layout
11488 Document\SpecialChar menuseparator
11497 \begin_layout Description
11498 \begin_inset Flex Code
11501 \begin_layout Plain Layout
11508 \begin_inset Flex Code
11511 \begin_layout Plain Layout
11517 ] This sequence defines a paragraph style.
11518 If the style does not yet exist, it is created; if it does exist, its parameter
11521 \begin_inset Quotes eld
11525 \begin_inset Flex Code
11528 \begin_layout Plain Layout
11535 \begin_inset Quotes erd
11539 \begin_inset Newline newline
11543 \begin_inset CommandInset ref
11545 reference "subsec:Paragraph-Styles"
11549 for details on paragraph styles.
11550 \change_inserted -712698321 1553617804
11554 \begin_layout Description
11556 \change_inserted -712698321 1553617862
11557 \begin_inset Flex Code
11560 \begin_layout Plain Layout
11562 \change_inserted -712698321 1553617809
11571 \begin_inset Flex Code
11574 \begin_layout Plain Layout
11576 \change_inserted -712698321 1553617805
11584 ] defines the default table style that is used when inserting a table.
11585 The following styles are available:
11589 \begin_layout Itemize
11591 \change_inserted -712698321 1554308039
11592 \begin_inset Flex Code
11595 \begin_layout Plain Layout
11597 \change_inserted -712698321 1554307928
11598 Formal_with_Footline
11606 \begin_inset Quotes eld
11610 \begin_inset Quotes erd
11613 ) style with horizontal lines only, using a bold top and bottom line, the
11614 first and last row are additionally separated from the table body with
11615 a thin middle line.
11618 \begin_layout Itemize
11620 \change_inserted -712698321 1554308087
11621 \begin_inset Flex Code
11624 \begin_layout Plain Layout
11626 \change_inserted -712698321 1554308042
11627 Formal_without_Footline
11634 : same as the above, but the last row is not separated with a middle line
11638 \begin_layout Itemize
11640 \change_inserted -712698321 1553618031
11641 \begin_inset Flex Code
11644 \begin_layout Plain Layout
11646 \change_inserted -712698321 1553618006
11654 : Simple table lines.
11657 \begin_layout Itemize
11659 \change_inserted -712698321 1553618309
11660 \begin_inset Flex Code
11663 \begin_layout Plain Layout
11665 \change_inserted -712698321 1553618031
11674 \begin_inset Flex Code
11677 \begin_layout Plain Layout
11679 \change_inserted -712698321 1553618043
11687 , but with the header column offset with a second horizontal line.
11688 This is also the default style of \SpecialChar LyX
11692 \begin_layout Itemize
11694 \change_inserted -712698321 1553618280
11695 \begin_inset Flex Code
11698 \begin_layout Plain Layout
11700 \change_inserted -712698321 1553618261
11708 : Table without lines.
11714 \begin_layout Description
11715 \begin_inset Flex Code
11718 \begin_layout Plain Layout
11725 \begin_inset Flex Code
11728 \begin_layout Plain Layout
11734 ] The name of the command or environment to be used with
11735 \begin_inset Flex Code
11738 \begin_layout Plain Layout
11747 \begin_layout Description
11748 \begin_inset Flex Code
11751 \begin_layout Plain Layout
11758 \begin_inset Flex Code
11761 \begin_layout Plain Layout
11770 \begin_inset Flex Code
11773 \begin_layout Plain Layout
11779 ] Indicates what kind of markup is used to define the title of a document.
11781 \begin_inset Flex Code
11784 \begin_layout Plain Layout
11790 means that the macro with name
11791 \begin_inset Flex Code
11794 \begin_layout Plain Layout
11800 will be inserted after the last layout which has
11801 \begin_inset Quotes eld
11805 \begin_inset Flex Code
11808 \begin_layout Plain Layout
11810 \begin_inset space ~
11819 \begin_inset Quotes erd
11824 \begin_inset Flex Code
11827 \begin_layout Plain Layout
11833 corresponds to the case where all layouts which have
11834 \begin_inset Quotes eld
11838 \begin_inset Flex Code
11841 \begin_layout Plain Layout
11843 \begin_inset space ~
11852 \begin_inset Quotes erd
11855 should be enclosed into the
11856 \begin_inset Flex Code
11859 \begin_layout Plain Layout
11868 \begin_layout Description
11869 \begin_inset Flex Code
11872 \begin_layout Plain Layout
11879 \begin_inset Flex Code
11882 \begin_layout Plain Layout
11888 ] Sets which divisions are included in the table of contents.
11890 \begin_inset Flex Code
11893 \begin_layout Plain Layout
11899 counter in \SpecialChar LaTeX
11903 \begin_layout Subsection
11904 \begin_inset Flex Code
11907 \begin_layout Plain Layout
11914 \begin_inset CommandInset label
11916 name "subsec:ClassOptions"
11923 \begin_layout Standard
11925 \begin_inset Flex Code
11928 \begin_layout Plain Layout
11934 section can contain the following entries:
11937 \begin_layout Description
11938 \begin_inset Flex Code
11941 \begin_layout Plain Layout
11948 \begin_inset Flex Code
11951 \begin_layout Plain Layout
11957 ] The list of available font sizes for the document's main font, separated
11959 \begin_inset Quotes eld
11963 \begin_inset Flex Code
11966 \begin_layout Plain Layout
11973 \begin_inset Quotes erd
11978 \change_inserted -712698321 1565110196
11979 Any number is possible.
11982 \begin_layout Description
11984 \change_inserted -712698321 1565110259
11985 \begin_inset Flex Code
11988 \begin_layout Plain Layout
11990 \change_inserted -712698321 1565110199
11999 \begin_inset Flex Code
12002 \begin_layout Plain Layout
12004 \change_inserted -712698321 1565110196
12012 ] The format for the font size option.
12014 \begin_inset Flex Code
12017 \begin_layout Plain Layout
12019 \change_inserted -712698321 1565110238
12029 \begin_inset Flex Code
12032 \begin_layout Plain Layout
12034 \change_inserted -712698321 1565110248
12042 is a placeholder for the font size.
12047 \begin_layout Description
12049 \change_deleted 5863208 1594239483
12050 \begin_inset Flex Code
12053 \begin_layout Plain Layout
12059 Used to set the DTD line with XML-based output classes.
12061 \begin_inset space \thinspace{}
12065 \begin_inset Quotes eld
12068 -//OASIS//DTD DocBook V4.2//EN
12069 \begin_inset Quotes erd
12073 \change_inserted -712698321 1565101761
12077 \begin_layout Description
12079 \change_inserted -712698321 1565180598
12080 \begin_inset Flex Code
12083 \begin_layout Plain Layout
12085 \change_inserted -712698321 1565101918
12094 \begin_inset Flex Code
12097 \begin_layout Plain Layout
12099 \change_inserted -712698321 1565105399
12100 string="letter|\SpecialChar allowbreak
12101 legal|\SpecialChar allowbreak
12102 executive|\SpecialChar allowbreak
12103 a0|\SpecialChar allowbreak
12104 a1|\SpecialChar allowbreak
12105 a2|\SpecialChar allowbreak
12106 a3|\SpecialChar allowbreak
12107 a4|\SpecialChar allowbreak
12108 a5|\SpecialChar allowbreak
12109 a6|\SpecialChar allowbreak
12110 b0|\SpecialChar allowbreak
12111 b1|\SpecialChar allowbreak
12112 b2|\SpecialChar allowbreak
12113 b3|\SpecialChar allowbreak
12114 b4|\SpecialChar allowbreak
12115 b5|\SpecialChar allowbreak
12116 b6|\SpecialChar allowbreak
12117 c0|\SpecialChar allowbreak
12118 c1|\SpecialChar allowbreak
12120 2|\SpecialChar allowbreak
12121 c3|\SpecialChar allowbreak
12122 c4|\SpecialChar allowbreak
12123 c5|\SpecialChar allowbreak
12124 c6|\SpecialChar allowbreak
12125 b0j|\SpecialChar allowbreak
12126 b1j|\SpecialChar allowbreak
12127 b2j|\SpecialChar allowbreak
12128 b3j|\SpecialChar allowbreak
12129 b4j|\SpecialChar allowbreak
12130 b5j|\SpecialChar allowbreak
12138 ] The list of available page sizes, separated by
12139 \begin_inset Quotes eld
12143 \begin_inset Flex Code
12146 \begin_layout Plain Layout
12148 \change_inserted -712698321 1565101779
12157 \begin_inset Quotes erd
12161 Currently, only the listed sizes are supported.
12162 Other sizes might be entered as custom class option.
12165 \begin_layout Description
12167 \change_inserted -712698321 1565180623
12168 \begin_inset Flex Code
12171 \begin_layout Plain Layout
12173 \change_inserted -712698321 1565180605
12182 \begin_inset Flex Code
12185 \begin_layout Plain Layout
12187 \change_inserted -712698321 1565180601
12195 ] The format for the page size option.
12197 \begin_inset Flex Code
12200 \begin_layout Plain Layout
12202 \change_inserted -712698321 1565180618
12212 \begin_inset Flex Code
12215 \begin_layout Plain Layout
12217 \change_inserted -712698321 1565180601
12225 is a placeholder for the paper size.
12230 \begin_layout Description
12231 \begin_inset Flex Code
12234 \begin_layout Plain Layout
12241 \begin_inset Flex Code
12244 \begin_layout Plain Layout
12245 string="empty|plain|headings|fancy"
12250 ] The list of available page sty\SpecialChar softhyphen
12252 \begin_inset Quotes eld
12256 \begin_inset Flex Code
12259 \begin_layout Plain Layout
12266 \begin_inset Quotes erd
12272 \begin_layout Description
12273 \begin_inset Flex Code
12276 \begin_layout Plain Layout
12283 \begin_inset Flex Code
12286 \begin_layout Plain Layout
12292 ] Some document class options, separated by a comma, that will be added
12293 to the optional part of the
12294 \begin_inset Flex Code
12297 \begin_layout Plain Layout
12308 \begin_layout Standard
12310 \begin_inset Flex Code
12313 \begin_layout Plain Layout
12319 section must end with
12320 \begin_inset Quotes eld
12324 \begin_inset Flex Code
12327 \begin_layout Plain Layout
12334 \begin_inset Quotes erd
12340 \begin_layout Subsection
12342 \begin_inset CommandInset label
12344 name "subsec:Paragraph-Styles"
12351 \begin_layout Standard
12352 A paragraph style description looks like this:
12356 \begin_layout Plain Layout
12357 Note that this will either define a new style or modify an existing one.
12365 \begin_layout LyX-Code
12372 \begin_layout LyX-Code
12376 \begin_layout LyX-Code
12380 \begin_layout Standard
12381 where the following commands are allowed:
12384 \begin_layout Description
12385 \begin_inset Flex Code
12388 \begin_layout Plain Layout
12395 \begin_inset Flex Code
12398 \begin_layout Plain Layout
12404 =""] This paragraph will appear in the table of contents of the given type.
12405 An empty string disables.
12406 See also the OutlinerName and the IsTocCaption commands.
12410 \begin_layout Description
12411 \begin_inset Flex Code
12414 \begin_layout Plain Layout
12421 \begin_inset Flex Code
12424 \begin_layout Plain Layout
12429 , left, right, center
12434 ] Paragraph alignment.
12437 \begin_layout Description
12438 \begin_inset Flex Code
12441 \begin_layout Plain Layout
12448 \begin_inset Flex Code
12451 \begin_layout Plain Layout
12456 , left, right, center
12461 ] A comma separated list of permitted alignments.
12462 (Some \SpecialChar LaTeX
12463 styles prohibit certain alignments, since those wouldn't make sense.
12464 For example a right-aligned or centered enumeration isn't possible.)
12467 \begin_layout Description
12468 \begin_inset Flex Code
12471 \begin_layout Plain Layout
12478 \begin_inset Flex Code
12481 \begin_layout Plain Layout
12487 ] Defines argument number <int> of a command\SpecialChar breakableslash
12488 environment associated with
12490 This is useful for things like section headings, and only makes sense with
12493 Every (optional or required) argument of a command or environment – except
12494 for the required argument that is associated with the content of the paragraph
12495 itself – has a separate definition, where the number specifies the order
12497 The definition must end with
12498 \begin_inset Flex Code
12501 \begin_layout Plain Layout
12508 So a command with two optional arguments has:
12512 \begin_layout Quote
12518 \begin_layout Quote
12524 \begin_layout Quote
12530 \begin_layout Quote
12536 \begin_layout Quote
12542 \begin_layout Quote
12548 \begin_layout Standard
12550 \begin_inset Flex Code
12553 \begin_layout Plain Layout
12559 definition, the following specifications are possible:
12562 \begin_layout Itemize
12563 \begin_inset Flex Code
12566 \begin_layout Plain Layout
12573 \begin_inset Flex Code
12576 \begin_layout Plain Layout
12582 The string that will appear both in the menu (to insert this argument)
12583 and on the argument inset button (unless you also specify a separate
12584 \begin_inset Flex Code
12587 \begin_layout Plain Layout
12594 For the menu, you can define an accelerator by appending the respective
12595 character to the string, divided by
12596 \begin_inset Quotes eld
12600 \begin_inset Quotes erd
12604 \begin_inset space \thinspace{}
12608 \begin_inset space \space{}
12612 \begin_inset Quotes eld
12616 \begin_inset Flex Code
12619 \begin_layout Plain Layout
12626 \begin_inset Quotes erd
12632 \begin_layout Itemize
12633 \begin_inset Flex Code
12636 \begin_layout Plain Layout
12643 \begin_inset Flex Code
12646 \begin_layout Plain Layout
12652 A separate string for the menu.
12653 You can define an accelerator by appending the respective character to
12654 the string, divided by
12655 \begin_inset Quotes eld
12659 \begin_inset Quotes erd
12663 \begin_inset space \thinspace{}
12667 \begin_inset space \space{}
12671 \begin_inset Quotes eld
12675 \begin_inset Flex Code
12678 \begin_layout Plain Layout
12685 \begin_inset Quotes erd
12689 This specification is optional.
12690 If it is not given the
12691 \begin_inset Flex Code
12694 \begin_layout Plain Layout
12700 will be used instead for the menu.
12703 \begin_layout Itemize
12704 \begin_inset Flex Code
12707 \begin_layout Plain Layout
12714 \begin_inset Flex Code
12717 \begin_layout Plain Layout
12723 A longer explanatory text that appears in the tooltip when hovering over
12724 the argument inset.
12727 \begin_layout Itemize
12728 \begin_inset Flex Code
12731 \begin_layout Plain Layout
12738 \begin_inset Flex Code
12741 \begin_layout Plain Layout
12750 \begin_inset space \thinspace{}
12754 \begin_inset Flex Code
12757 \begin_layout Plain Layout
12763 ] Declare if this is a mandatory (1) or an optional (0) argument.
12764 Mandatory arguments will be output empty if not given, while optional arguments
12765 will not be output at all.
12766 By default, mandatory arguments are delimited by
12767 \begin_inset Flex Code
12770 \begin_layout Plain Layout
12776 , while optional arguments are delimited by
12777 \begin_inset Flex Code
12780 \begin_layout Plain Layout
12787 \change_inserted -712698321 1555579782
12791 \begin_layout Itemize
12793 \change_inserted -712698321 1555579780
12794 \begin_inset Flex Code
12797 \begin_layout Plain Layout
12799 \change_inserted -712698321 1555579780
12808 \begin_inset Flex Code
12811 \begin_layout Plain Layout
12813 \change_inserted -712698321 1555579780
12821 Option to define a different command (from the default
12822 \begin_inset Flex Code
12825 \begin_layout Plain Layout
12827 \change_inserted -712698321 1555579780
12839 ) to be used for line breaks.
12840 The initial backslash must not be specified.
12845 \begin_layout Itemize
12846 \begin_inset Flex Code
12849 \begin_layout Plain Layout
12856 \begin_inset Flex Code
12859 \begin_layout Plain Layout
12865 defines another argument (by its number) which this argument requires to
12866 be output if it is itself output.
12868 \begin_inset space \thinspace{}
12871 g., in \SpecialChar LaTeX
12872 commands, optional arguments often require previous optional arguments
12873 to be output (at least empty), as in
12874 \begin_inset Flex Code
12877 \begin_layout Plain Layout
12880 command[][argument]{text}
12886 This can be achieved by the statement
12887 \begin_inset Flex Code
12890 \begin_layout Plain Layout
12897 \begin_inset Flex Code
12900 \begin_layout Plain Layout
12909 \begin_layout Itemize
12910 \begin_inset Flex Code
12913 \begin_layout Plain Layout
12920 \begin_inset Flex Code
12923 \begin_layout Plain Layout
12929 defines a custom left delimiter (instead of
12930 \begin_inset Flex Code
12933 \begin_layout Plain Layout
12940 \begin_inset Flex Code
12943 \begin_layout Plain Layout
12950 A line break in the output can be indicated by
12951 \begin_inset Flex Code
12954 \begin_layout Plain Layout
12963 \begin_layout Itemize
12964 \begin_inset Flex Code
12967 \begin_layout Plain Layout
12974 \begin_inset Flex Code
12977 \begin_layout Plain Layout
12983 defines a custom right delimiter (instead of
12984 \begin_inset Flex Code
12987 \begin_layout Plain Layout
12994 \begin_inset Flex Code
12997 \begin_layout Plain Layout
13004 A line break in the output can be indicated by
13005 \begin_inset Flex Code
13008 \begin_layout Plain Layout
13017 \begin_layout Itemize
13018 \begin_inset Flex Code
13021 \begin_layout Plain Layout
13028 \begin_inset Flex Code
13031 \begin_layout Plain Layout
13037 defines an argument that is inserted if and only if no user-specified arguments
13039 \begin_inset space \thinspace{}
13043 \begin_inset space \space{}
13046 if no argument inset has been inserted (note that also an empty argument
13047 inset omits the DefaultArg).
13048 Multiple arguments need to be separated by comma.
13051 \begin_layout Itemize
13052 \begin_inset Flex Code
13055 \begin_layout Plain Layout
13062 \begin_inset Flex Code
13065 \begin_layout Plain Layout
13071 defines an argument that is inserted in any case (alone or in addition
13072 to user-specified arguments).
13073 Multiple arguments need to be separated by comma.
13076 \begin_layout Itemize
13077 \begin_inset Flex Code
13080 \begin_layout Plain Layout
13086 The font used for the argument content, see
13087 \begin_inset CommandInset ref
13089 reference "subsec:Font-description"
13094 \change_inserted -712698321 1559484228
13098 \begin_layout Itemize
13100 \change_inserted -712698321 1559484228
13101 \begin_inset Flex Code
13104 \begin_layout Plain Layout
13106 \change_inserted -712698321 1559484228
13115 \begin_inset Flex Code
13118 \begin_layout Plain Layout
13120 \change_inserted -712698321 1559484228
13131 \begin_inset space \thinspace{}
13135 \begin_inset Flex Code
13138 \begin_layout Plain Layout
13140 \change_inserted -712698321 1559484228
13148 ] As with paragraph styles, see
13149 \begin_inset CommandInset ref
13151 reference "subsec:Paragraph-Styles"
13160 \begin_layout Itemize
13161 \begin_inset Flex Code
13164 \begin_layout Plain Layout
13170 The font used for the label; see
13171 \begin_inset CommandInset ref
13173 reference "subsec:Font-description"
13180 \begin_layout Itemize
13181 \begin_inset Flex Code
13184 \begin_layout Plain Layout
13191 \begin_inset Flex Code
13194 \begin_layout Plain Layout
13199 , Minimalistic, Conglomerate
13204 ] describes the rendering style used for the inset's frame and buttons.
13207 \begin_layout Itemize
13208 \begin_inset Flex Code
13211 \begin_layout Plain Layout
13218 \begin_inset Flex Code
13221 \begin_layout Plain Layout
13228 \begin_inset Flex Code
13231 \begin_layout Plain Layout
13237 , this argument is automatically inserted when the respective style is selected.
13239 \change_deleted -712698321 1559484200
13240 Currently, only one argument per style\SpecialChar breakableslash
13241 layout can be automatically inserted.
13246 \begin_layout Itemize
13248 \change_inserted -712698321 1559491402
13249 \begin_inset Flex Code
13252 \begin_layout Plain Layout
13254 \change_inserted -712698321 1559490711
13263 \begin_inset Flex Code
13266 \begin_layout Plain Layout
13268 \change_inserted -712698321 1559490703
13277 \begin_inset Flex Code
13280 \begin_layout Plain Layout
13282 \change_inserted -712698321 1559490703
13290 , this argument will be inserted on a new line with
13291 \begin_inset Flex Code
13294 \begin_layout Plain Layout
13296 \change_inserted -712698321 1559491402
13304 (only available within Flex insets).
13307 \begin_layout Itemize
13308 \begin_inset Flex Code
13311 \begin_layout Plain Layout
13318 \begin_inset Flex Code
13321 \begin_layout Plain Layout
13328 \begin_inset Flex Code
13331 \begin_layout Plain Layout
13337 , this argument will be inserted with a copy of the co-text (either selected
13338 text or the whole paragraph) as content.
13341 \begin_layout Itemize
13342 \begin_inset Flex Code
13345 \begin_layout Plain Layout
13352 \begin_inset Flex Code
13355 \begin_layout Plain Layout
13365 ] Whether the contents of this argument should be output in raw form, meaning
13366 without special translations that \SpecialChar LaTeX
13369 \begin_inset Flex Code
13372 \begin_layout Plain Layout
13378 status is inherited by the inset or paragraph layout the argument belongs
13379 to, true and false change the status for the given argument only.
13382 \begin_layout Itemize
13383 \begin_inset Flex Code
13386 \begin_layout Plain Layout
13393 \begin_inset Flex Code
13396 \begin_layout Plain Layout
13397 string of characters
13406 Defines individual characters
13407 \begin_inset Newline linebreak
13410 that should be output in raw form, meaning without special translations
13411 that \SpecialChar LaTeX
13413 Note that, contrary to PassThru, this needs to be explicitly defined for
13415 That is, arguments do not inherit PassThruChars from their parent inset
13419 \begin_layout Itemize
13420 \begin_inset Flex Code
13423 \begin_layout Plain Layout
13430 \begin_inset Flex Code
13433 \begin_layout Plain Layout
13442 \begin_inset space \thinspace{}
13446 \begin_inset Flex Code
13449 \begin_layout Plain Layout
13455 ] If this is set to 1, the argument will output its content in the corresponding
13456 item in the table of contents.
13460 \begin_layout Standard
13461 By default, the text entered in the \SpecialChar LyX
13462 workarea in the respective layout is
13463 the last (mandatory) argument of a command if the
13464 \begin_inset Flex Code
13467 \begin_layout Plain Layout
13474 \begin_inset Flex Code
13477 \begin_layout Plain Layout
13484 However, arguments with the prefix
13485 \begin_inset Flex Code
13488 \begin_layout Plain Layout
13494 are output after this workarea argument.
13495 Note that post-argument numbering restarts at 1, so the first argument
13496 following the workarea argument is
13497 \begin_inset Flex Code
13500 \begin_layout Plain Layout
13507 Post-arguments are ignored in any other
13508 \begin_inset Flex Code
13511 \begin_layout Plain Layout
13518 \begin_inset Flex Code
13521 \begin_layout Plain Layout
13530 \begin_layout Standard
13532 \begin_inset Flex Code
13535 \begin_layout Plain Layout
13544 \begin_inset Flex Code
13547 \begin_layout Plain Layout
13556 \begin_inset Flex Code
13559 \begin_layout Plain Layout
13565 followed by the number (e.
13566 \begin_inset space \thinspace{}
13570 \begin_inset space \space{}
13574 \begin_inset Flex Code
13577 \begin_layout Plain Layout
13584 \change_inserted -712698321 1534487781
13588 \begin_layout Standard
13590 \change_inserted -712698321 1534488561
13591 Finally, there is a special argument type with the prefix
13592 \begin_inset Flex Code
13595 \begin_layout Plain Layout
13597 \change_inserted -712698321 1534487844
13606 It is not really an argument, but uses the argument interface (thus, the
13607 prefix is also followed by a number, e.
13608 \begin_inset space \thinspace{}
13613 \begin_inset Flex Code
13616 \begin_layout Plain Layout
13618 \change_inserted -712698321 1534488412
13619 Argument listpreamble:1
13627 As the name implies, it is targeted at lists such as
13644 Its content will be output at the list start, before the first
13645 \begin_inset Flex Code
13648 \begin_layout Plain Layout
13650 \change_inserted -712698321 1534488058
13660 , on an own line (a place that is otherwise not accessible in \SpecialChar LyX
13662 This way, users can insert redefinitions (of lengths etc.) to individual
13664 By default, these arguments do not have a delimiter.
13670 \begin_layout Description
13671 \begin_inset Flex Code
13674 \begin_layout Plain Layout
13680 Includes a comma-separated list of layouts that should be nested in and
13681 after the current layout.
13682 Only makes sense for nestable layouts (such as environments).
13684 \begin_inset Quotes eld
13688 \begin_inset Flex Code
13691 \begin_layout Plain Layout
13698 \begin_inset Quotes erd
13703 \begin_inset Flex Code
13706 \begin_layout Plain Layout
13715 \begin_layout Description
13716 \begin_inset Flex Code
13719 \begin_layout Plain Layout
13725 Note that this will completely override any prior
13726 \begin_inset Flex Code
13729 \begin_layout Plain Layout
13735 declaration for this style.
13737 \begin_inset Quotes eld
13741 \begin_inset Flex Code
13744 \begin_layout Plain Layout
13751 \begin_inset Quotes erd
13756 \begin_inset CommandInset ref
13758 reference "subsec:I18n"
13762 for details on its use.
13765 \begin_layout Description
13766 \begin_inset Flex Code
13769 \begin_layout Plain Layout
13776 \begin_inset Flex Code
13779 \begin_layout Plain Layout
13789 \begin_layout Plain Layout
13790 Note that a `float' here is a real number, such as: 1.5.
13795 The vertical space with which the last of a chain of paragraphs with this
13796 style is separated from the following paragraph.
13797 If the next paragraph has another style, the separations are not simply
13798 added, but the maximum is taken.
13801 \begin_layout Description
13802 \begin_inset Flex Code
13805 \begin_layout Plain Layout
13812 \begin_inset Flex Code
13815 \begin_layout Plain Layout
13821 ] The category for this style.
13822 This is used to group related styles in the style combobox on the toolbar.
13823 Any string can be used, but you may want to use existing categories with
13828 \begin_layout Description
13829 \begin_inset Flex Code
13832 \begin_layout Plain Layout
13838 Depth of XML command.
13839 Used only with XML-type formats.
13842 \begin_layout Description
13843 \begin_inset Flex Code
13846 \begin_layout Plain Layout
13853 \begin_inset Flex Code
13856 \begin_layout Plain Layout
13862 ] Copies all the features of an existing style into the current one.
13866 \begin_layout Description
13867 \begin_inset Flex Code
13870 \begin_layout Plain Layout
13877 \begin_inset Flex Code
13880 \begin_layout Plain Layout
13886 ] The name of a style whose preamble should be output
13891 This allows to ensure some ordering of the preamble snippets when macros
13892 definitions depend on one another.
13896 \begin_layout Plain Layout
13897 Note that, besides that functionality, there is no way to ensure any ordering
13899 The ordering that you see in a given version of \SpecialChar LyX
13900 may change without warning
13909 \begin_layout Description
13910 \begin_inset Flex Code
13913 \begin_layout Plain Layout
13920 \begin_inset Flex Code
13923 \begin_layout Plain Layout
13928 , Box, Filled_Box, Static
13933 ] The type of label that stands at the end of the paragraph (or sequence
13935 \begin_inset Flex Code
13938 \begin_layout Plain Layout
13945 \begin_inset Newline newline
13949 \begin_inset Flex Code
13952 \begin_layout Plain Layout
13959 \begin_inset Flex Code
13962 \begin_layout Plain Layout
13969 \begin_inset Flex Code
13972 \begin_layout Plain Layout
13980 \begin_inset Flex Code
13983 \begin_layout Plain Layout
13990 \begin_inset Quotes eld
13994 \begin_inset Quotes erd
13998 \begin_inset Flex Code
14001 \begin_layout Plain Layout
14008 \begin_inset space \space{}
14012 \begin_inset Flex Code
14015 \begin_layout Plain Layout
14021 ) is a white (resp.
14022 \begin_inset space ~
14025 black) square suitable for end of proof markers,
14026 \begin_inset Flex Code
14029 \begin_layout Plain Layout
14035 is an explicit text string.
14038 \begin_layout Description
14039 \begin_inset Flex Code
14042 \begin_layout Plain Layout
14049 \begin_inset Flex Code
14052 \begin_layout Plain Layout
14058 ] The string used for a label with a
14059 \begin_inset Flex Code
14062 \begin_layout Plain Layout
14069 \begin_inset Newline newline
14073 \begin_inset Flex Code
14076 \begin_layout Plain Layout
14086 \begin_layout Description
14087 \begin_inset Flex Code
14090 \begin_layout Plain Layout
14096 The font used for both the text body
14102 \begin_inset CommandInset ref
14104 reference "subsec:Font-description"
14109 Note that defining this font automatically defines the
14110 \begin_inset Flex Code
14113 \begin_layout Plain Layout
14120 So you should define this one first if you also want to define
14121 \begin_inset Flex Code
14124 \begin_layout Plain Layout
14133 \begin_layout Description
14134 \begin_inset Flex Code
14137 \begin_layout Plain Layout
14144 \begin_inset Flex Code
14147 \begin_layout Plain Layout
14153 ] Used for backporting new styles to stable \SpecialChar LyX
14155 The first stable version that supports this tag is \SpecialChar LyX
14157 The argument is a number which may either be 0, -1 or any value greater
14160 \begin_inset Flex Code
14163 \begin_layout Plain Layout
14169 flag of a style is greater than zero, it will always be written to the
14171 If a .lyx file is read, the style definitions from the document header are
14172 added to the document class.
14173 Therefore even older \SpecialChar LyX
14174 versions can handle the style.
14176 \begin_inset Flex Code
14179 \begin_layout Plain Layout
14185 is a version number: if the style is read, and the version number is less
14186 than the version number of the already existing style in the document class,
14187 the new style is ignored.
14188 If the version number is greater, the new style replaces the existing style.
14189 A value of -1 means an infinite version number, i.
14190 \begin_inset space \thinspace{}
14194 \begin_inset space \space{}
14197 the style is always used.
14200 \begin_layout Description
14201 \begin_inset Flex Code
14204 \begin_layout Plain Layout
14211 \begin_inset Flex Code
14214 \begin_layout Plain Layout
14223 \begin_inset space \thinspace{}
14227 \begin_inset Flex Code
14230 \begin_layout Plain Layout
14236 ] Usually \SpecialChar LyX
14237 does not allow you to insert more than one space between words,
14238 since a space is considered as the separation between two words, not a
14239 character or symbol of its own.
14240 This is a very fine thing but sometimes annoying, for example, when typing
14241 program code or plain \SpecialChar LaTeX
14244 \begin_inset Flex Code
14247 \begin_layout Plain Layout
14255 \change_deleted -495245474 1550490105
14259 will create protected blanks for the additional blanks when in
14260 \change_inserted -495245474 1550490096
14262 \begin_inset Flex Code
14265 \begin_layout Plain Layout
14267 \change_inserted -495245474 1550490089
14276 \change_deleted -495245474 1550490116
14277 another mode than \SpecialChar LaTeX
14280 \change_inserted -495245474 1550247760
14282 \begin_inset Flex Code
14285 \begin_layout Plain Layout
14287 \change_inserted -495245474 1550247736
14296 \begin_inset Flex Code
14299 \begin_layout Plain Layout
14301 \change_inserted -495245474 1550247755
14314 \begin_layout Description
14315 \begin_inset Flex Code
14318 \begin_layout Plain Layout
14324 These tags are used with XHTML output.
14326 \begin_inset CommandInset ref
14328 reference "subsec:Paragraph-Style-XHTML"
14335 \begin_layout Description
14336 \begin_inset Flex Code
14339 \begin_layout Plain Layout
14345 [FIXME] (Used only with XML-type formats.)
14348 \begin_layout Description
14349 \begin_inset Flex Code
14352 \begin_layout Plain Layout
14359 \begin_inset Flex Code
14362 \begin_layout Plain Layout
14371 \begin_inset space \thinspace{}
14375 \begin_inset Flex Code
14378 \begin_layout Plain Layout
14385 \begin_inset Flex Code
14388 \begin_layout Plain Layout
14394 , marks the style as to be included in the document preamble and not in
14396 This is useful for document classes that want such information as the title
14397 and author to appear in the preamble.
14398 Note that this works only for styles for which the
14399 \begin_inset Flex Code
14402 \begin_layout Plain Layout
14409 \begin_inset Flex Code
14412 \begin_layout Plain Layout
14419 \begin_inset Flex Code
14422 \begin_layout Plain Layout
14431 \begin_layout Description
14432 \begin_inset Flex Code
14435 \begin_layout Plain Layout
14442 \begin_inset Flex Code
14445 \begin_layout Plain Layout
14454 \begin_inset space \thinspace{}
14458 \begin_inset Flex Code
14461 \begin_layout Plain Layout
14468 \begin_inset Flex Code
14471 \begin_layout Plain Layout
14477 , marks the style as being part of a title block (see also the
14478 \begin_inset Flex Code
14481 \begin_layout Plain Layout
14488 \begin_inset Flex Code
14491 \begin_layout Plain Layout
14500 \begin_layout Description
14501 \begin_inset Flex Code
14504 \begin_layout Plain Layout
14510 Includes a comma-separated list of layouts after which this one should
14512 Only makes sense with regard to nestable layouts (such as environments).
14514 \begin_inset Quotes eld
14518 \begin_inset Flex Code
14521 \begin_layout Plain Layout
14528 \begin_inset Quotes erd
14533 \begin_inset Flex Code
14536 \begin_layout Plain Layout
14545 \begin_layout Description
14546 \begin_inset Flex Code
14549 \begin_layout Plain Layout
14556 \begin_inset Flex Code
14559 \begin_layout Plain Layout
14568 \begin_inset space \thinspace{}
14572 \begin_inset Flex Code
14575 \begin_layout Plain Layout
14581 ] If this is set to 1 and AddToToc is enabled, the paragraph adds a summary
14582 of its contents in its item in the table of contents.
14583 Otherwise, only the label, if it exists, appears.
14586 \begin_layout Description
14587 \begin_inset Flex Code
14590 \begin_layout Plain Layout
14597 \begin_inset Flex Code
14600 \begin_layout Plain Layout
14606 ] The \SpecialChar LaTeX
14607 command sequence declaring an item in a list.
14608 The command is to be defined without the preceding backslash (the default
14610 \begin_inset Quotes eld
14614 \begin_inset Quotes erd
14618 \begin_inset Flex Code
14621 \begin_layout Plain Layout
14629 in the \SpecialChar LaTeX
14633 \begin_layout Description
14634 \begin_inset Flex Code
14637 \begin_layout Plain Layout
14644 \begin_inset Flex Code
14647 \begin_layout Plain Layout
14653 ] This provides extra space between paragraphs that have the same style.
14654 If you put other styles into an environment, each is separated with the
14656 \begin_inset Flex Code
14659 \begin_layout Plain Layout
14666 But the whole items of the environment are additionally separated with
14668 \begin_inset Flex Code
14671 \begin_layout Plain Layout
14678 Note that this is a
14683 \begin_layout Description
14684 \begin_inset Flex Code
14687 \begin_layout Plain Layout
14693 [FIXME] (Used only with XML-type formats.)
14696 \begin_layout Description
14697 \begin_inset Flex Code
14700 \begin_layout Plain Layout
14707 \begin_inset Flex Code
14710 \begin_layout Plain Layout
14719 \begin_inset space \thinspace{}
14723 \begin_inset Flex Code
14726 \begin_layout Plain Layout
14732 ] Usually \SpecialChar LyX
14733 does not allow you to leave a paragraph empty, since it would
14734 lead to empty \SpecialChar LaTeX
14736 There are some cases where this could be desirable however: in a letter
14737 template, the required fields can be provided as empty fields, so that
14738 people do not forget them; in some special classes, a style can be used
14739 as some kind of break, which does not contain actual text.
14742 \begin_layout Description
14743 \begin_inset Flex Code
14746 \begin_layout Plain Layout
14753 \begin_inset Flex Code
14756 \begin_layout Plain Layout
14762 ] The vertical space between the label and the text body.
14763 Only used for labels that are above the text body (
14764 \begin_inset Flex Code
14767 \begin_layout Plain Layout
14774 \begin_inset Newline newline
14778 \begin_inset Flex Code
14781 \begin_layout Plain Layout
14782 Centered_Top_Environment
14790 \begin_layout Description
14791 \begin_inset Flex Code
14794 \begin_layout Plain Layout
14801 \begin_inset Flex Code
14804 \begin_layout Plain Layout
14810 ] The name of the counter for automatic numbering.
14811 In order to have the counter appear with your label, you will need to reference
14813 \begin_inset Flex Code
14816 \begin_layout Plain Layout
14825 This will work with
14826 \begin_inset Flex Code
14829 \begin_layout Plain Layout
14836 \begin_inset Flex Code
14839 \begin_layout Plain Layout
14846 \begin_inset Flex Code
14849 \begin_layout Plain Layout
14856 \begin_inset Flex Code
14859 \begin_layout Plain Layout
14866 \begin_inset Newline newline
14874 \begin_inset Flex Code
14877 \begin_layout Plain Layout
14884 \begin_inset Flex Code
14887 \begin_layout Plain Layout
14893 , though this case is a bit complicated.
14894 Suppose you declare
14895 \begin_inset Quotes eld
14899 \begin_inset Flex Code
14902 \begin_layout Plain Layout
14903 LabelCounter myenum
14909 \begin_inset Quotes erd
14913 Then the actual counters used are
14914 \begin_inset Flex Code
14917 \begin_layout Plain Layout
14924 \begin_inset Flex Code
14927 \begin_layout Plain Layout
14934 \begin_inset Flex Code
14937 \begin_layout Plain Layout
14944 \begin_inset Flex Code
14947 \begin_layout Plain Layout
14953 , much as in \SpecialChar LaTeX
14955 These counters must all be declared separately.
14956 \begin_inset Newline newline
14960 \begin_inset CommandInset ref
14962 reference "subsec:Counters"
14966 for details on counters.
14969 \begin_layout Description
14970 \begin_inset Flex Code
14973 \begin_layout Plain Layout
14979 The font used for the label.
14981 \begin_inset CommandInset ref
14983 reference "subsec:Font-description"
14990 \begin_layout Description
14991 \begin_inset Flex Code
14994 \begin_layout Plain Layout
15001 \begin_inset Flex Code
15004 \begin_layout Plain Layout
15010 ] Text that indicates how far a label should be indented.
15013 \begin_layout Description
15014 \begin_inset Flex Code
15017 \begin_layout Plain Layout
15024 \begin_inset Flex Code
15027 \begin_layout Plain Layout
15033 ] Text that indicates the amount of horizontal space between the label and
15035 Only used for labels that are not above the text body.
15038 \begin_layout Description
15039 \begin_inset Flex Code
15042 \begin_layout Plain Layout
15049 \begin_inset Flex Code
15052 \begin_layout Plain Layout
15058 ] The string used for the label.
15060 \begin_inset Flex Code
15063 \begin_layout Plain Layout
15069 is set, this string can be contain the special formatting commands described
15071 \begin_inset CommandInset ref
15073 reference "subsec:Counters"
15080 \begin_layout Description
15081 \begin_inset Flex Code
15084 \begin_layout Plain Layout
15085 LabelStringAppendix
15091 \begin_inset Flex Code
15094 \begin_layout Plain Layout
15100 ] This is used inside the appendix instead of
15101 \begin_inset Newline newline
15105 \begin_inset Flex Code
15108 \begin_layout Plain Layout
15116 \begin_inset Flex Code
15119 \begin_layout Plain Layout
15126 \begin_inset Newline newline
15130 \begin_inset Flex Code
15133 \begin_layout Plain Layout
15134 LabelStringAppendix
15142 \begin_layout Description
15143 \begin_inset Flex Code
15146 \begin_layout Plain Layout
15152 [FIXME] (Used only with XML-type formats.)
15155 \begin_layout Description
15156 \begin_inset Flex Code
15159 \begin_layout Plain Layout
15166 \begin_inset Flex Code
15169 \begin_layout Plain Layout
15174 , Manual, Static, Above,
15175 \begin_inset Newline newline
15178 Centered, Sensitive, Enumerate,
15179 \begin_inset Newline newline
15182 Itemize, Bibliography
15191 \begin_layout Description
15192 \begin_inset Flex Code
15195 \begin_layout Plain Layout
15201 means the label is the very first word (up to the first real blank).
15202 Use protected spaces if you want more than one word as the label.
15206 \begin_layout Description
15207 \begin_inset Flex Code
15210 \begin_layout Plain Layout
15216 means the label is simply what is declared as
15217 \begin_inset Flex Code
15220 \begin_layout Plain Layout
15227 This will be displayed
15228 \begin_inset Quotes eld
15232 \begin_inset Quotes erd
15235 , at the beginning of the paragraph.
15237 \begin_inset Flex Code
15240 \begin_layout Plain Layout
15247 \begin_inset Flex Code
15250 \begin_layout Plain Layout
15256 , then it will be displayed only in the first paragraph of any sequence
15257 of paragraphs with the same
15258 \begin_inset Flex Code
15261 \begin_layout Plain Layout
15270 \begin_layout Description
15271 \begin_inset Flex Code
15274 \begin_layout Plain Layout
15281 \begin_inset space ~
15285 \begin_inset space ~
15289 \begin_inset Flex Code
15292 \begin_layout Plain Layout
15298 are special cases of
15299 \begin_inset Flex Code
15302 \begin_layout Plain Layout
15309 The label will be printed above the paragraph either at the beginning of
15310 the line or centered.
15313 \begin_layout Description
15314 \begin_inset Flex Code
15317 \begin_layout Plain Layout
15323 is a special case for the caption-labels
15324 \begin_inset Quotes eld
15328 \begin_inset Quotes erd
15332 \begin_inset Quotes eld
15336 \begin_inset Quotes erd
15340 \begin_inset Newline newline
15344 \begin_inset Flex Code
15347 \begin_layout Plain Layout
15353 means the (hardcoded) label string depends on the kind of float: It is
15354 hardcoded to be `FloatType N', where N is the value of the counter associated
15356 For the case that a caption is inserted outside of a float the
15357 \begin_inset Flex Code
15360 \begin_layout Plain Layout
15367 \begin_inset Quotes eld
15371 \begin_inset Quotes erd
15377 \begin_layout Description
15378 \begin_inset Flex Code
15381 \begin_layout Plain Layout
15387 produces the usual sort of enumeration labels.
15388 The number type needs to be set in the
15393 \begin_inset CommandInset ref
15395 reference "subsec:Counters"
15402 \begin_layout Description
15403 \begin_inset Flex Code
15406 \begin_layout Plain Layout
15412 produces various bullets at the different levels.
15413 The bullet types displayed can be set via
15414 \begin_inset Flex Noun
15417 \begin_layout Plain Layout
15418 Document\SpecialChar menuseparator
15419 Settings\SpecialChar menuseparator
15428 \begin_layout Description
15429 \begin_inset Flex Code
15432 \begin_layout Plain Layout
15438 should be used only with
15439 \begin_inset Flex Code
15442 \begin_layout Plain Layout
15443 LatexType BibEnvironment
15452 \begin_layout Description
15453 \begin_inset Flex Code
15456 \begin_layout Plain Layout
15462 Note that this will completely override any prior
15463 \begin_inset Flex Code
15466 \begin_layout Plain Layout
15472 declaration for this style.
15474 \begin_inset Quotes eld
15478 \begin_inset Flex Code
15481 \begin_layout Plain Layout
15488 \begin_inset Quotes erd
15493 \begin_inset CommandInset ref
15495 reference "subsec:I18n"
15499 for details on its use.
15502 \begin_layout Description
15503 \begin_inset Flex Code
15506 \begin_layout Plain Layout
15513 \begin_inset Flex Code
15516 \begin_layout Plain Layout
15522 ] The name of the corresponding \SpecialChar LaTeX
15524 Either the environment or command name.
15527 \begin_layout Description
15528 \begin_inset Flex Code
15531 \begin_layout Plain Layout
15538 \begin_inset Flex Code
15541 \begin_layout Plain Layout
15547 ] An optional parameter for the corresponding
15548 \begin_inset Flex Code
15551 \begin_layout Plain Layout
15558 This parameter cannot be changed from within \SpecialChar LyX
15560 \begin_inset Flex Code
15563 \begin_layout Plain Layout
15569 for customizable parameters).
15570 This will be output as is after all \SpecialChar LaTeX
15572 \begin_inset Flex Code
15575 \begin_layout Plain Layout
15584 \begin_layout Description
15585 \begin_inset Flex Code
15588 \begin_layout Plain Layout
15595 \begin_inset Flex Code
15598 \begin_layout Plain Layout
15603 , Command, Environment, Item_Environment,
15604 \begin_inset Newline newline
15607 List_Environment, Bib_Environment
15612 ] How the style should be translated into \SpecialChar LaTeX
15617 \begin_layout Plain Layout
15618 \begin_inset Flex Code
15621 \begin_layout Plain Layout
15627 is perhaps a bit misleading, since these rules apply to SGML classes, too.
15628 Visit the SGML class files for specific examples.
15637 \begin_layout Description
15638 \begin_inset Flex Code
15641 \begin_layout Plain Layout
15647 means nothing special.
15650 \begin_layout Description
15651 \begin_inset Flex Code
15654 \begin_layout Plain Layout
15661 \begin_inset Flex Code
15664 \begin_layout Plain Layout
15671 {\SpecialChar ldots
15680 \begin_layout Description
15681 \begin_inset Flex Code
15684 \begin_layout Plain Layout
15691 \begin_inset Flex Code
15694 \begin_layout Plain Layout
15701 }\SpecialChar ldots
15717 \begin_layout Description
15718 \begin_inset Flex Code
15721 \begin_layout Plain Layout
15728 \begin_inset Flex Code
15731 \begin_layout Plain Layout
15738 \begin_inset Flex Code
15741 \begin_layout Plain Layout
15749 is generated for each paragraph of this environment.
15753 \begin_layout Description
15754 \begin_inset Flex Code
15757 \begin_layout Plain Layout
15764 \begin_inset Flex Code
15767 \begin_layout Plain Layout
15774 \begin_inset Newline newline
15778 \begin_inset Flex Code
15781 \begin_layout Plain Layout
15787 is passed as an argument to the environment.
15788 \begin_inset Newline newline
15792 \begin_inset Flex Code
15795 \begin_layout Plain Layout
15801 can be defined in the
15802 \begin_inset Flex Noun
15805 \begin_layout Plain Layout
15806 Edit\SpecialChar menuseparator
15808 \begin_inset space ~
15819 \begin_layout Description
15820 \begin_inset Flex Code
15823 \begin_layout Plain Layout
15830 \begin_inset Flex Code
15833 \begin_layout Plain Layout
15839 but adds the necessary mandatory argument (the longest label) to the begin
15840 statement of the bibliography environment:
15841 \begin_inset Newline newline
15845 \begin_inset Flex Code
15848 \begin_layout Plain Layout
15851 begin{thebibliography}{99}
15857 It is therefore only useful for bibliography environments.
15858 The default longest label
15859 \begin_inset Quotes eld
15863 \begin_inset Quotes erd
15866 can be changed by the user in the paragraph settings of a bibliography
15870 \begin_layout Standard
15871 Putting the last few things together, the \SpecialChar LaTeX
15872 output will be either:
15875 \begin_layout LyX-Code
15878 LatexName[LatexParam]{\SpecialChar ldots
15882 \begin_layout Standard
15886 \begin_layout LyX-Code
15889 begin{LatexName}[LatexParam] \SpecialChar ldots
15895 \begin_layout Standard
15896 depending upon the \SpecialChar LaTeX
15901 \begin_layout Description
15902 \begin_inset Flex Code
15905 \begin_layout Plain Layout
15912 \begin_inset Flex Code
15915 \begin_layout Plain Layout
15921 ] A string that is put at the beginning of the style content.
15922 A line break in the output can be indicated by
15923 \begin_inset Flex Code
15926 \begin_layout Plain Layout
15935 \begin_layout Description
15936 \begin_inset Flex Code
15939 \begin_layout Plain Layout
15946 \begin_inset Flex Code
15949 \begin_layout Plain Layout
15955 ] If you put styles into environments, the different
15956 \begin_inset Flex Code
15959 \begin_layout Plain Layout
15965 are not simply added, but added with a factor
15966 \begin_inset Formula $\frac{4}{\mathrm{depth}+4}$
15970 Note that this parameter is also used when
15971 \begin_inset Flex Code
15974 \begin_layout Plain Layout
15981 \begin_inset Flex Code
15984 \begin_layout Plain Layout
15991 \begin_inset Flex Code
15994 \begin_layout Plain Layout
16001 Then it is added to the manual or dynamic margin.
16002 \begin_inset Newline newline
16006 \begin_inset Quotes eld
16010 \begin_inset Flex Code
16013 \begin_layout Plain Layout
16020 \begin_inset Quotes erd
16023 means that the paragraph is indented with the width of
16024 \begin_inset Quotes eld
16028 \begin_inset Flex Code
16031 \begin_layout Plain Layout
16038 \begin_inset Quotes erd
16041 in the normal font.
16042 You can get a negative width by prefixing the string with
16043 \begin_inset Quotes eld
16047 \begin_inset Flex Code
16050 \begin_layout Plain Layout
16057 \begin_inset Quotes erd
16061 This way was chosen so that the look is the same with each used screen
16065 \begin_layout Description
16066 \begin_inset Flex Code
16069 \begin_layout Plain Layout
16076 \begin_inset Flex Code
16079 \begin_layout Plain Layout
16084 , Manual, Dynamic, First_Dynamic, Right_Address_Box
16090 \begin_inset Newline newline
16093 The kind of margin that the style has on the left side.
16097 \begin_layout Description
16098 \begin_inset Flex Code
16101 \begin_layout Plain Layout
16107 just means a fixed margin.
16110 \begin_layout Description
16111 \begin_inset Flex Code
16114 \begin_layout Plain Layout
16120 means that the left margin depends on the string entered in the
16121 \begin_inset Flex Noun
16124 \begin_layout Plain Layout
16125 Edit\SpecialChar menuseparator
16127 \begin_inset space ~
16136 This is used to typeset nice lists without tabulators.
16139 \begin_layout Description
16140 \begin_inset Flex Code
16143 \begin_layout Plain Layout
16149 means that the margin depends on the size of the label.
16150 This is used for automatic enumerated headlines.
16151 It is obvious that the headline
16152 \begin_inset Quotes eld
16155 5.4.3.2.1 Very long headline
16156 \begin_inset Quotes erd
16159 must have a wider left margin (as wide as
16160 \begin_inset Quotes eld
16164 \begin_inset Quotes erd
16167 plus the space) than
16168 \begin_inset Quotes eld
16171 3.2 Very long headline
16172 \begin_inset Quotes erd
16176 \begin_inset Quotes eld
16180 \begin_inset Quotes erd
16183 are not able to do this.
16186 \begin_layout Description
16187 \begin_inset Flex Code
16190 \begin_layout Plain Layout
16196 is similar, but only the very first row of the paragraph is dynamic, while
16197 the others are static; this is used, for example, for descriptions.
16200 \begin_layout Description
16201 \begin_inset Flex Code
16204 \begin_layout Plain Layout
16210 means the margin is chosen in a way that the longest row of this paragraph
16211 fits to the right margin.
16212 This is used to typeset an address on the right edge of the page.
16216 \begin_layout Description
16217 \begin_inset Flex Code
16220 \begin_layout Plain Layout
16227 \begin_inset Flex Code
16230 \begin_layout Plain Layout
16239 \begin_inset space \thinspace{}
16243 \begin_inset Flex Code
16246 \begin_layout Plain Layout
16252 ] Whether fragile commands in this style should be
16253 \begin_inset Flex Code
16256 \begin_layout Plain Layout
16269 whether this command should itself be protected.)
16270 \change_inserted -712698321 1523696949
16274 \begin_layout Description
16276 \change_inserted -712698321 1552395557
16277 \begin_inset Flex Code
16280 \begin_layout Plain Layout
16282 \change_inserted -712698321 1523696950
16291 \begin_inset Flex Code
16294 \begin_layout Plain Layout
16296 \change_inserted -712698321 1523696950
16307 \begin_inset space \thinspace{}
16311 \begin_inset Flex Code
16314 \begin_layout Plain Layout
16316 \change_inserted -712698321 1523696950
16324 ] This causes macros that contain this layout to be protected with
16325 \begin_inset Flex Code
16328 \begin_layout Plain Layout
16330 \change_inserted -712698321 1523696950
16345 ) if necessary and thus allows (some) verbatim stuff in macros.
16348 \begin_layout Description
16350 \change_inserted -712698321 1552395844
16351 \begin_inset Flex Code
16354 \begin_layout Plain Layout
16356 \change_inserted -712698321 1552395561
16365 \begin_inset Flex Code
16368 \begin_layout Plain Layout
16370 \change_inserted -712698321 1552395557
16381 \begin_inset space \thinspace{}
16385 \begin_inset Flex Code
16388 \begin_layout Plain Layout
16390 \change_inserted -712698321 1552395557
16398 ] Whether specific commands in this style (such as
16399 \begin_inset Flex Code
16402 \begin_layout Plain Layout
16404 \change_inserted -712698321 1552395655
16415 \begin_inset Flex Code
16418 \begin_layout Plain Layout
16420 \change_inserted -712698321 1552395661
16430 ) should be protected in an
16431 \begin_inset Flex Code
16434 \begin_layout Plain Layout
16436 \change_inserted -712698321 1552395631
16447 This is particularly needed for styles that draw on
16455 commands which parse their content in complex ways.
16460 \begin_layout Description
16461 \begin_inset Flex Code
16464 \begin_layout Plain Layout
16471 \begin_inset Flex Code
16474 \begin_layout Plain Layout
16481 \begin_inset space \thinspace{}
16485 \begin_inset Flex Code
16488 \begin_layout Plain Layout
16496 ] Whether newlines are translated into \SpecialChar LaTeX
16498 \begin_inset Flex Code
16501 \begin_layout Plain Layout
16512 The translation can be switched off to allow more comfortable \SpecialChar LaTeX
16514 inside \SpecialChar LyX
16518 \begin_layout Description
16519 \begin_inset Flex Code
16522 \begin_layout Plain Layout
16529 \begin_inset Flex Code
16532 \begin_layout Plain Layout
16541 \begin_inset space \thinspace{}
16545 \begin_inset Flex Code
16548 \begin_layout Plain Layout
16554 ] If set to true, and if
16555 \begin_inset Flex Code
16558 \begin_layout Plain Layout
16565 \begin_inset Flex Code
16568 \begin_layout Plain Layout
16574 ) paragraphs are being indented, then the indentation of such a paragraph
16575 following one of this type will be suppressed.
16576 (So this will not affect the display of non-default paragraphs.)
16579 \begin_layout Description
16580 \begin_inset Flex Code
16583 \begin_layout Plain Layout
16590 \begin_inset Flex Code
16593 \begin_layout Plain Layout
16599 ] Name of a style that has replaced this style.
16600 This is used to rename a style, while keeping backward compatibility.
16603 \begin_layout Description
16604 \begin_inset Flex Code
16607 \begin_layout Plain Layout
16614 \begin_inset Flex Code
16617 \begin_layout Plain Layout
16624 \begin_inset space \thinspace{}
16628 \begin_inset Flex Code
16631 \begin_layout Plain Layout
16637 ] Determines whether consecutive paragraphs of the same type are treated
16638 as belonging together.
16639 This has the effect that the
16640 \begin_inset Flex Code
16643 \begin_layout Plain Layout
16649 is only printed once before such a group.
16650 By default, this is true for
16651 \begin_inset Flex Code
16654 \begin_layout Plain Layout
16661 \begin_inset Flex Code
16664 \begin_layout Plain Layout
16671 \begin_inset Flex Code
16674 \begin_layout Plain Layout
16680 and false for all other types.
16683 \begin_layout Description
16684 \begin_inset Flex Code
16687 \begin_layout Plain Layout
16694 \begin_inset Flex Code
16697 \begin_layout Plain Layout
16706 \begin_inset space \thinspace{}
16710 \begin_inset Flex Code
16713 \begin_layout Plain Layout
16719 ] Indicates that paragraphs will not be separated by an empty line in \SpecialChar LaTeX
16721 but only by a line break; together with
16722 \begin_inset Flex Code
16725 \begin_layout Plain Layout
16731 , this allows to emulate a plain text editor (like the ERT inset).
16734 \begin_layout Description
16735 \begin_inset Flex Code
16738 \begin_layout Plain Layout
16745 \begin_inset Flex Code
16748 \begin_layout Plain Layout
16754 ] The indent of the very first line of a paragraph.
16756 \begin_inset Newline newline
16760 \begin_inset Flex Code
16763 \begin_layout Plain Layout
16769 will be fixed for a certain style.
16770 The exception is the default style, since the indentation for these paragraphs
16771 can be prohibited with
16772 \begin_inset Flex Code
16775 \begin_layout Plain Layout
16783 \begin_inset Flex Code
16786 \begin_layout Plain Layout
16792 style paragraphs inside environments use the
16793 \begin_inset Flex Code
16796 \begin_layout Plain Layout
16802 of the environment, not their native one.
16804 \begin_inset Flex Code
16807 \begin_layout Plain Layout
16813 paragraphs inside an enumeration are not indented.
16816 \begin_layout Description
16817 \begin_inset Flex Code
16820 \begin_layout Plain Layout
16827 \begin_inset Flex Code
16830 \begin_layout Plain Layout
16836 ] The vertical space between two paragraphs of this style.
16839 \begin_layout Description
16840 \begin_inset Flex Code
16843 \begin_layout Plain Layout
16850 \begin_inset Flex Code
16853 \begin_layout Plain Layout
16860 allows the user to choose either
16861 \begin_inset Quotes eld
16865 \begin_inset Quotes erd
16869 \begin_inset Quotes eld
16873 \begin_inset Quotes erd
16876 to separate paragraphs.
16878 \begin_inset Quotes eld
16882 \begin_inset Quotes erd
16886 \begin_inset Flex Code
16889 \begin_layout Plain Layout
16897 \begin_inset Quotes eld
16901 \begin_inset Quotes erd
16905 \begin_inset Flex Code
16908 \begin_layout Plain Layout
16914 is ignored and all paragraphs are separated by the
16915 \begin_inset Flex Code
16918 \begin_layout Plain Layout
16925 The vertical space is calculated with
16926 \begin_inset Flex Code
16929 \begin_layout Plain Layout
16931 \begin_inset space ~
16940 \begin_inset Flex Code
16943 \begin_layout Plain Layout
16949 is the height of a row with the normal font.
16950 This way, the look stays the same with different screen fonts.
16953 \begin_layout Description
16954 \begin_inset Flex Code
16957 \begin_layout Plain Layout
16964 \begin_inset Flex Code
16967 \begin_layout Plain Layout
16976 \begin_inset space \thinspace{}
16980 \begin_inset Flex Code
16983 \begin_layout Plain Layout
16989 ] Whether the contents of this paragraph should be output in raw form, meaning
16990 without special translations that \SpecialChar LaTeX
16994 \begin_layout Description
16995 \begin_inset Flex Code
16998 \begin_layout Plain Layout
17005 \begin_inset Flex Code
17008 \begin_layout Plain Layout
17018 Defines individual characters that should be output in raw form, meaning
17019 without special translations that \SpecialChar LaTeX
17023 \begin_layout Description
17024 \begin_inset Flex Code
17027 \begin_layout Plain Layout
17033 Information to be included in the \SpecialChar LaTeX
17034 preamble when this style is used.
17035 Used to define macros, load packages, etc., required by this particular
17038 \begin_inset Quotes eld
17042 \begin_inset Flex Code
17045 \begin_layout Plain Layout
17052 \begin_inset Quotes erd
17058 \begin_layout Description
17059 \begin_inset Flex Code
17062 \begin_layout Plain Layout
17069 \begin_inset Flex Code
17072 \begin_layout Plain Layout
17078 ] The prefix to use when creating labels referring to paragraphs of this
17080 This allows the use of formatted references.
17083 \begin_layout Description
17084 \begin_inset Flex Code
17087 \begin_layout Plain Layout
17094 \begin_inset Flex Code
17097 \begin_layout Plain Layout
17103 ] Whether the style requires the feature
17104 \begin_inset Flex Code
17107 \begin_layout Plain Layout
17114 \begin_inset CommandInset ref
17116 reference "chap:List-of-functions"
17120 for the list of features).
17121 If you require a package with specific options, you can additionally use
17123 \begin_inset Flex Code
17126 \begin_layout Plain Layout
17132 as a general text class parameter (see
17133 \begin_inset CommandInset ref
17135 reference "subsec:General-text-class"
17142 \begin_layout Description
17143 \begin_inset Flex Code
17146 \begin_layout Plain Layout
17153 \begin_inset Flex Code
17156 \begin_layout Plain Layout
17165 \begin_inset Flex Code
17168 \begin_layout Plain Layout
17174 ] Resets the \SpecialChar LaTeX
17175 arguments of this style (as defined via the
17176 \begin_inset Flex Code
17179 \begin_layout Plain Layout
17186 This is useful if you have copied a style via
17187 \begin_inset Flex Code
17190 \begin_layout Plain Layout
17196 , but you do not want to inherit its (required and optional) arguments.
17199 \begin_layout Description
17200 \begin_inset Flex Code
17203 \begin_layout Plain Layout
17210 \begin_inset Flex Code
17213 \begin_layout Plain Layout
17222 \begin_inset Flex Code
17225 \begin_layout Plain Layout
17231 ] Resumes a counter that is usually reset at each new sequence of layouts.
17232 This is currently only useful when
17233 \begin_inset Flex Code
17236 \begin_layout Plain Layout
17243 \begin_inset Flex Code
17246 \begin_layout Plain Layout
17255 \begin_layout Description
17256 \begin_inset Flex Code
17259 \begin_layout Plain Layout
17266 \begin_inset Flex Code
17269 \begin_layout Plain Layout
17275 ] A string that is put at the end of the layout content.
17276 A line break in the output can be indicated by
17277 \begin_inset Flex Code
17280 \begin_layout Plain Layout
17289 \begin_layout Description
17290 \begin_inset Flex Code
17293 \begin_layout Plain Layout
17300 \begin_inset Flex Code
17303 \begin_layout Plain Layout
17310 \begin_inset Flex Code
17313 \begin_layout Plain Layout
17322 \begin_layout Description
17323 \begin_inset Flex Code
17326 \begin_layout Plain Layout
17333 \begin_inset Flex Code
17336 \begin_layout Plain Layout
17345 \begin_inset Flex Code
17348 \begin_layout Plain Layout
17355 \begin_inset Flex Code
17358 \begin_layout Plain Layout
17365 \begin_inset Flex Code
17368 \begin_layout Plain Layout
17370 \begin_inset space ~
17378 ] This defines what the default spacing should be in the style.
17380 \begin_inset Flex Code
17383 \begin_layout Plain Layout
17390 \begin_inset Flex Code
17393 \begin_layout Plain Layout
17400 \begin_inset Flex Code
17403 \begin_layout Plain Layout
17409 correspond respectively to a multiplier value of 1, 1.25 and 1.667.
17410 If you specify the argument
17411 \begin_inset Flex Code
17414 \begin_layout Plain Layout
17420 , then you must also provide a value argument which will be the actual multiplie
17422 Note that, contrary to other parameters,
17423 \begin_inset Flex Code
17426 \begin_layout Plain Layout
17432 implies the generation of specific \SpecialChar LaTeX
17433 code, using the \SpecialChar LaTeX
17437 \begin_inset Flex Code
17440 \begin_layout Plain Layout
17449 \begin_layout Description
17450 \begin_inset Flex Code
17453 \begin_layout Plain Layout
17460 \begin_inset Flex Code
17463 \begin_layout Plain Layout
17470 \begin_inset space \thinspace{}
17474 \begin_inset Flex Code
17477 \begin_layout Plain Layout
17485 ] Allow spell-checking paragraphs of this style.
17489 \begin_layout Description
17490 \begin_inset Flex Code
17493 \begin_layout Plain Layout
17495 \change_deleted 731793113 1604355211
17497 \change_inserted 731793113 1604355212
17506 \begin_inset Flex Code
17509 \begin_layout Plain Layout
17518 \begin_inset Flex Code
17521 \begin_layout Plain Layout
17528 \change_deleted 731793113 1604355214
17530 \change_inserted 731793113 1604355216
17533 counter of a given counter at the beginning of a new sequence of layouts.
17534 This is currently only useful when
17535 \begin_inset Flex Code
17538 \begin_layout Plain Layout
17545 \begin_inset Flex Code
17548 \begin_layout Plain Layout
17557 \begin_layout Description
17558 \begin_inset Flex Code
17561 \begin_layout Plain Layout
17567 The font used for the text body .
17569 \begin_inset CommandInset ref
17571 reference "subsec:Font-description"
17578 \begin_layout Description
17579 \begin_inset Flex Code
17582 \begin_layout Plain Layout
17591 \begin_inset Flex Code
17594 \begin_layout Plain Layout
17604 The level of the style in the table of contents.
17605 This is used for automatic numbering of section headings.
17608 \begin_layout Description
17609 \begin_inset Flex Code
17612 \begin_layout Plain Layout
17621 \begin_inset Flex Code
17624 \begin_layout Plain Layout
17635 \begin_inset Flex Code
17638 \begin_layout Plain Layout
17645 \begin_inset Flex Code
17648 \begin_layout Plain Layout
17654 ] This tag determines whether the first line indentation of this paragraph
17655 can be toggled via the Paragraph settings dialog.
17659 \begin_inset Flex Code
17662 \begin_layout Plain Layout
17672 is set, indentation can be toggled if the document settings use
17673 \begin_inset Quotes eld
17677 \begin_inset Quotes erd
17680 paragraph style, with
17681 \begin_inset Flex Code
17684 \begin_layout Plain Layout
17690 , indentation can always be toggled, notwithstanding the document settings,
17692 \begin_inset Flex Code
17695 \begin_layout Plain Layout
17701 , indentation can never be toggled.
17704 \begin_layout Description
17705 \begin_inset Flex Code
17708 \begin_layout Plain Layout
17715 \begin_inset Flex Code
17718 \begin_layout Plain Layout
17724 ] The vertical space with which the very first of a chain of paragraphs
17725 with this style is separated from the previous paragraph.
17726 If the previous paragraph has another style, the separations are not simply
17727 added, but the maximum is taken.
17730 \begin_layout Subsection
17731 \begin_inset CommandInset label
17737 Internationalization of Paragraph Styles
17740 \begin_layout Standard
17742 has long supported internationalization of layout information, but, until
17743 version 2.0, this applied only to the user interface and not to, say, PDF
17745 Thus, French authors were forced to resort to ugly hacks if they wanted
17750 1' instead of `Theorem 1'.
17751 Thanks to Georg Baum, that is no longer the case.
17754 \begin_layout Standard
17756 \begin_inset Flex Code
17759 \begin_layout Plain Layout
17765 defines text that is to appear in the typeset document, it may use
17766 \begin_inset Flex Code
17769 \begin_layout Plain Layout
17776 \begin_inset Flex Code
17779 \begin_layout Plain Layout
17785 to support non-English and even multi-language documents correctly.
17786 The following excerpt (from the
17787 \begin_inset Flex Code
17790 \begin_layout Plain Layout
17796 file) shows how this works:
17799 \begin_layout LyX-Code
17804 \begin_layout LyX-Code
17807 theoremstyle{remark}
17810 \begin_layout LyX-Code
17813 newtheorem{claim}[thm]{
17820 \begin_layout LyX-Code
17824 \begin_layout LyX-Code
17828 \begin_layout LyX-Code
17833 claimname}{_(Claim)}
17836 \begin_layout LyX-Code
17840 \begin_layout LyX-Code
17844 \begin_layout LyX-Code
17853 claimname}{_(Claim)}}
17856 \begin_layout LyX-Code
17861 \begin_layout Standard
17862 In principle, any legal \SpecialChar LaTeX
17864 \begin_inset Flex Code
17867 \begin_layout Plain Layout
17874 \begin_inset Flex Code
17877 \begin_layout Plain Layout
17883 tags, but in practice they will typically look as they do here.
17884 The key to correct translation of the typeset text is the definition of
17885 the \SpecialChar LaTeX
17887 \begin_inset Flex Code
17890 \begin_layout Plain Layout
17899 \begin_inset Flex Code
17902 \begin_layout Plain Layout
17914 \begin_layout Standard
17916 \begin_inset Flex Code
17919 \begin_layout Plain Layout
17925 tag provides for internationalization based upon the overall language of
17927 The contents of the tag will be included in the preamble, just as with
17929 \begin_inset Flex Code
17932 \begin_layout Plain Layout
17939 What makes it special is the use of the
17940 \begin_inset Quotes eld
17944 \begin_inset Quotes erd
17948 \begin_inset Flex Code
17951 \begin_layout Plain Layout
17957 , which will be replaced, when \SpecialChar LyX
17958 produces \SpecialChar LaTeX
17959 output, with the translation of
17960 its argument into the document language.
17963 \begin_layout Standard
17965 \begin_inset Flex Code
17968 \begin_layout Plain Layout
17974 tag is more complex, since it is meant to provide support for multi-language
17975 documents and so offers an interface to the
17976 \begin_inset Flex Code
17979 \begin_layout Plain Layout
17986 Its contents will be added to the preamble once for each language that
17987 appears in the document.
17988 In this case, the argument to
17989 \begin_inset Flex Code
17992 \begin_layout Plain Layout
17998 will be replaced with its translation into the language in question; the
18000 \begin_inset Flex Code
18003 \begin_layout Plain Layout
18009 is replaced by the language name (as used by the babel package).
18012 \begin_layout Standard
18013 A German document that also included a French section would thus have the
18014 following in the preamble:
18017 \begin_layout LyX-Code
18026 claimname}{Affirmation}}
18027 \begin_inset Newline newline
18038 claimname}{Behauptung}}
18039 \begin_inset Newline newline
18046 claimname}{Behauptung}
18049 \begin_layout Standard
18052 \begin_inset Flex Code
18055 \begin_layout Plain Layout
18061 will then conspire to produce the correct text in the output.
18064 \begin_layout Standard
18065 One important point to note here is that the translations are provided by
18067 itself, through the file
18068 \begin_inset Flex Code
18071 \begin_layout Plain Layout
18078 This means, in effect, that
18079 \begin_inset Flex Code
18082 \begin_layout Plain Layout
18089 \begin_inset Flex Code
18092 \begin_layout Plain Layout
18098 are really only of use in layout files that are provided with \SpecialChar LyX
18100 entered in user-created layout files will not be seen by \SpecialChar LyX
18101 's internationalizatio
18102 n routines unless the
18103 \begin_inset Flex Code
18106 \begin_layout Plain Layout
18112 file is modified accordingly.
18113 That said, however, any layout created with the intention that it will
18114 be included with \SpecialChar LyX
18115 should use these tags where appropriate.
18116 Please note that the paragraph style translations provided by \SpecialChar LyX
18118 change with a minor update (e.
18119 \begin_inset space \thinspace{}
18123 \begin_inset space \space{}
18126 from version 2.1.x to 2.1.y).
18127 It is however quite likely that a major update (e.
18128 \begin_inset space \thinspace{}
18132 \begin_inset space \space{}
18135 from 2.0.x to 2.1.0) will introduce new translations or corrections.
18138 \begin_layout Subsection
18140 \begin_inset CommandInset label
18142 name "subsec:Floats"
18149 \begin_layout Standard
18150 It is necessary to define the floats (
18151 \begin_inset Flex Noun
18154 \begin_layout Plain Layout
18161 \begin_inset Flex Noun
18164 \begin_layout Plain Layout
18170 , \SpecialChar ldots
18171 ) in the text class itself.
18172 Standard floats are included in the file
18173 \begin_inset Flex Code
18176 \begin_layout Plain Layout
18182 , so you may have to do no more than add
18185 \begin_layout LyX-Code
18186 Input stdfloats.inc
18189 \begin_layout Standard
18190 to your layout file.
18191 If you want to implement a text class that proposes some other float types
18192 (like the AGU class bundled with \SpecialChar LyX
18193 ), the information below will hopefully
18197 \begin_layout Description
18198 \begin_inset Flex Code
18201 \begin_layout Plain Layout
18208 \begin_inset Flex Code
18211 \begin_layout Plain Layout
18217 =!htbpH] Allowed placement options for this float type.
18218 The value is a string of placement characters.
18219 Possible characters include:
18224 \begin_inset Quotes eld
18228 \begin_inset Quotes erd
18236 \begin_inset Quotes eld
18240 \begin_inset Quotes erd
18248 \begin_inset Quotes eld
18252 \begin_inset Quotes erd
18260 \begin_inset Quotes eld
18264 \begin_inset Quotes erd
18272 \begin_inset Quotes eld
18276 \begin_inset Quotes erd
18284 \begin_inset Quotes eld
18288 \begin_inset Quotes erd
18292 The order of the characters in the string does not matter.
18293 If no placement options are allowed, use the string
18300 \begin_layout Description
18301 \begin_inset Flex Code
18304 \begin_layout Plain Layout
18311 \begin_inset Flex Code
18314 \begin_layout Plain Layout
18323 \begin_inset space \thinspace{}
18329 \begin_inset Flex Code
18332 \begin_layout Plain Layout
18342 ] Defines whether the float allows to be rotated via the \SpecialChar LaTeX
18349 \begin_inset Flex Code
18352 \begin_layout Plain Layout
18358 if the float does not support this feature.
18361 \begin_layout Description
18362 \begin_inset Flex Code
18365 \begin_layout Plain Layout
18372 \begin_inset Flex Code
18375 \begin_layout Plain Layout
18384 \begin_inset space \thinspace{}
18390 \begin_inset Flex Code
18393 \begin_layout Plain Layout
18403 ] Defines whether the float has a starred variant that spans columns in
18404 a two column paragraph.
18406 \begin_inset Flex Code
18409 \begin_layout Plain Layout
18415 if the float does not support this feature.
18418 \begin_layout Description
18419 \begin_inset Flex Code
18422 \begin_layout Plain Layout
18429 \begin_inset Flex Code
18432 \begin_layout Plain Layout
18439 \begin_inset Quotes erd
18443 \begin_inset Quotes erd
18446 ] The file name extension of an auxiliary file for the list of figures (or
18449 writes the captions to this file.
18452 \begin_layout Description
18453 \begin_inset Flex Code
18456 \begin_layout Plain Layout
18463 \begin_inset Flex Code
18466 \begin_layout Plain Layout
18473 \begin_inset Quotes erd
18477 \begin_inset Quotes erd
18480 ] The string that will be used in the menus and also for the caption.
18481 This is translated to the current language if babel is used.
18484 \begin_layout Description
18485 \begin_inset Flex Code
18488 \begin_layout Plain Layout
18494 These tags control the XHTML output.
18496 \begin_inset CommandInset ref
18498 reference "sec:Tags-for-XHTML"
18505 \begin_layout Description
18506 \begin_inset Flex Code
18509 \begin_layout Plain Layout
18518 \begin_inset Flex Code
18521 \begin_layout Plain Layout
18530 \begin_inset space \thinspace{}
18534 \begin_inset Flex Code
18537 \begin_layout Plain Layout
18543 ] Indicates whether the float is already defined in the document class or
18544 if instead the \SpecialChar LaTeX
18546 \begin_inset Flex Code
18549 \begin_layout Plain Layout
18555 needs to be loaded to define it on-the-fly.
18557 \begin_inset Flex Code
18560 \begin_layout Plain Layout
18567 \begin_inset Flex Code
18570 \begin_layout Plain Layout
18577 It should be set to
18578 \begin_inset Flex Code
18581 \begin_layout Plain Layout
18587 if the float is already defined by the \SpecialChar LaTeX
18591 \begin_layout Description
18592 \begin_inset Flex Code
18595 \begin_layout Plain Layout
18602 \begin_inset Flex Code
18605 \begin_layout Plain Layout
18612 \begin_inset Quotes erd
18616 \begin_inset Quotes erd
18619 ] The command used to generate a list of floats of this type; the leading
18628 \begin_inset Flex Code
18631 \begin_layout Plain Layout
18637 is false, since there is no standard way to generate this command.
18639 \begin_inset Flex Code
18642 \begin_layout Plain Layout
18648 is true, since in that case there is a standard way to define the command.
18651 \begin_layout Description
18652 \begin_inset Flex Code
18655 \begin_layout Plain Layout
18662 \begin_inset Flex Code
18665 \begin_layout Plain Layout
18672 \begin_inset Quotes erd
18676 \begin_inset Quotes erd
18679 ] A title for a list of floats of this kind (list of figures, tables, or
18681 It is used for the screen label within \SpecialChar LyX
18682 , it is used by \SpecialChar LaTeX
18684 it is used as the title in the XHTML output.
18685 It will be translated to the document language.
18688 \begin_layout Description
18689 \begin_inset Flex Code
18692 \begin_layout Plain Layout
18699 \begin_inset Flex Code
18702 \begin_layout Plain Layout
18709 \begin_inset Quotes erd
18713 \begin_inset Quotes erd
18716 ] This (optional) argument determines whether floats of this class will
18717 be numbered within some sectional unit of the document.
18719 \begin_inset Flex Code
18722 \begin_layout Plain Layout
18729 \begin_inset Quotes eld
18733 \begin_inset Flex Code
18736 \begin_layout Plain Layout
18743 \begin_inset Quotes erd
18746 , the floats will be numbered within chapters.
18750 \begin_layout Description
18751 \begin_inset Flex Code
18754 \begin_layout Plain Layout
18761 \begin_inset Flex Code
18764 \begin_layout Plain Layout
18771 \begin_inset Quotes erd
18775 \begin_inset Quotes erd
18778 ] The default placement for the given class of floats.
18779 The string should be as in standard \SpecialChar LaTeX
18781 \begin_inset Flex Code
18784 \begin_layout Plain Layout
18791 \begin_inset Flex Code
18794 \begin_layout Plain Layout
18801 \begin_inset Flex Code
18804 \begin_layout Plain Layout
18811 \begin_inset Flex Code
18814 \begin_layout Plain Layout
18820 for top, bottom, page, and here, respectively.
18824 \begin_layout Plain Layout
18825 Note that the order of these letters in the string is irrelevant, like in
18832 On top of that there is a new type,
18833 \begin_inset Flex Code
18836 \begin_layout Plain Layout
18842 , which does not really correspond to a float, since it means: put it
18843 \begin_inset Quotes eld
18847 \begin_inset Quotes erd
18851 Note however that the
18852 \begin_inset Flex Code
18855 \begin_layout Plain Layout
18861 specifier is special and, because of implementation details, cannot be
18862 used in non-built in float types.
18863 If you do not understand what this means, just use
18864 \begin_inset Quotes eld
18868 \begin_inset Flex Code
18871 \begin_layout Plain Layout
18878 \begin_inset Quotes erd
18884 \begin_layout Description
18885 \begin_inset Flex Code
18888 \begin_layout Plain Layout
18895 \begin_inset Flex Code
18898 \begin_layout Plain Layout
18904 ] The prefix to use when creating labels referring to floats of this type.
18905 This allows the use of formatted references.
18906 Note that you can remove any
18907 \begin_inset Flex Code
18910 \begin_layout Plain Layout
18916 set by a copied style by using the special value
18917 \begin_inset Quotes eld
18921 \begin_inset Quotes erd
18924 , which must be all caps.
18925 \change_inserted -712698321 1565605014
18929 \begin_layout Description
18931 \change_inserted -712698321 1565605014
18932 \begin_inset Flex Code
18935 \begin_layout Plain Layout
18937 \change_inserted -712698321 1565605014
18946 \begin_inset Flex Code
18949 \begin_layout Plain Layout
18951 \change_inserted -712698321 1565605014
18959 ] As with paragraph styles, see
18960 \begin_inset CommandInset ref
18962 reference "subsec:Paragraph-Styles"
18971 \begin_layout Description
18972 \begin_inset Flex Code
18975 \begin_layout Plain Layout
18982 \begin_inset Flex Code
18985 \begin_layout Plain Layout
18992 \begin_inset Quotes erd
18996 \begin_inset Quotes erd
18999 ] The style used when defining the float using
19000 \begin_inset Flex Code
19003 \begin_layout Plain Layout
19014 \begin_layout Description
19015 \begin_inset Flex Code
19018 \begin_layout Plain Layout
19025 \begin_inset Flex Code
19028 \begin_layout Plain Layout
19035 \begin_inset Quotes erd
19039 \begin_inset Quotes erd
19043 \begin_inset Quotes eld
19047 \begin_inset Quotes erd
19050 of the new class of floats, like program or algorithm.
19051 After the appropriate
19052 \begin_inset Flex Code
19055 \begin_layout Plain Layout
19064 \begin_inset Flex Code
19067 \begin_layout Plain Layout
19076 \begin_inset Flex Code
19079 \begin_layout Plain Layout
19090 \begin_layout Description
19091 \begin_inset Flex Code
19094 \begin_layout Plain Layout
19101 \begin_inset Flex Code
19104 \begin_layout Plain Layout
19111 \begin_inset space \thinspace{}
19115 \begin_inset Flex Code
19118 \begin_layout Plain Layout
19126 ] Specifies whether this float is defined using the \SpecialChar LaTeX
19128 \begin_inset Flex Code
19131 \begin_layout Plain Layout
19137 , either by the class file, another package or on-the-fly by \SpecialChar LyX
19141 \begin_layout Standard
19142 Note that defining a float with type
19143 \begin_inset Flex Code
19146 \begin_layout Plain Layout
19154 automatically defines the corresponding counter with name
19155 \begin_inset Flex Code
19158 \begin_layout Plain Layout
19169 \begin_layout Subsection
19170 Flex insets and InsetLayout
19171 \begin_inset CommandInset label
19173 name "subsec:Flex-insets-and"
19180 \begin_layout Standard
19181 Flex insets come in
19182 \change_deleted 5863208 1594239511
19184 \change_inserted 5863208 1594239512
19190 \begin_layout Itemize
19192 \begin_inset Flex Code
19195 \begin_layout Plain Layout
19201 ): These define semantic markup corresponding to such \SpecialChar LaTeX
19203 \begin_inset Flex Code
19206 \begin_layout Plain Layout
19215 \begin_inset Flex Code
19218 \begin_layout Plain Layout
19229 \begin_layout Itemize
19231 \begin_inset Flex Code
19234 \begin_layout Plain Layout
19240 ): These can be used to define custom collapsible insets, similar to \SpecialChar TeX
19242 footnote, and the like.
19243 An obvious example is an endnote inset, which is defined in the
19244 \begin_inset Flex Code
19247 \begin_layout Plain Layout
19256 \begin_layout Itemize
19258 \change_deleted 5863208 1594239528
19260 \begin_inset Flex Code
19263 \begin_layout Plain Layout
19269 ): For use with DocBook classes.
19274 \begin_layout Standard
19275 Flex insets are defined using the
19276 \begin_inset Flex Code
19279 \begin_layout Plain Layout
19285 tag, which shall be explained in a moment.
19288 \begin_layout Standard
19290 \begin_inset Flex Code
19293 \begin_layout Plain Layout
19299 tag also serves another function: It can be used to customize the general
19300 layout of many different types of insets.
19302 \begin_inset Flex Code
19305 \begin_layout Plain Layout
19311 can be used to customize the layout parameters for footnotes, marginal
19312 notes, note insets, \SpecialChar TeX
19313 code (ERT) insets, branches, listings, indexes, boxes,
19314 tables, algorithms, URLs, and captions, as well as to define Flex insets.
19317 \begin_layout Standard
19319 \begin_inset Flex Code
19322 \begin_layout Plain Layout
19328 definition must begin with a line of the form:
19331 \begin_layout LyX-Code
19335 \begin_layout Standard
19337 \begin_inset Flex Code
19340 \begin_layout Plain Layout
19346 indicates the inset whose layout is being defined, and here there are four
19350 \begin_layout Enumerate
19351 The layout for a pre-existing inset is being modified.
19352 In this case, can be
19353 \begin_inset Flex Code
19356 \begin_layout Plain Layout
19362 any one of the following:
19363 \begin_inset Flex Code
19366 \begin_layout Plain Layout
19373 \begin_inset Flex Code
19376 \begin_layout Plain Layout
19383 \begin_inset Flex Code
19386 \begin_layout Plain Layout
19393 \begin_inset Flex Code
19396 \begin_layout Plain Layout
19403 \begin_inset Flex Code
19406 \begin_layout Plain Layout
19413 \begin_inset Flex Code
19416 \begin_layout Plain Layout
19423 \begin_inset Flex Code
19426 \begin_layout Plain Layout
19433 \begin_inset Flex Code
19436 \begin_layout Plain Layout
19443 \begin_inset Flex Code
19446 \begin_layout Plain Layout
19453 \begin_inset Flex Code
19456 \begin_layout Plain Layout
19463 \begin_inset Flex Code
19466 \begin_layout Plain Layout
19473 \begin_inset Flex Code
19476 \begin_layout Plain Layout
19483 \begin_inset Flex Code
19486 \begin_layout Plain Layout
19493 \begin_inset Flex Code
19496 \begin_layout Plain Layout
19503 \begin_inset Flex Code
19506 \begin_layout Plain Layout
19513 \begin_inset Flex Code
19516 \begin_layout Plain Layout
19523 \begin_inset Flex Code
19526 \begin_layout Plain Layout
19533 \begin_inset Flex Code
19536 \begin_layout Plain Layout
19543 \begin_inset Flex Code
19546 \begin_layout Plain Layout
19553 \begin_inset Flex Code
19556 \begin_layout Plain Layout
19565 \begin_layout Enumerate
19566 The layout for a Flex inset is being defined.
19568 \begin_inset Flex Code
19571 \begin_layout Plain Layout
19577 must be of the form
19578 \begin_inset Quotes eld
19582 \begin_inset Flex Code
19585 \begin_layout Plain Layout
19592 \begin_inset Quotes erd
19596 \begin_inset Flex Code
19599 \begin_layout Plain Layout
19605 may be be any valid identifier not used by a pre-existing Flex inset.
19606 The identifier may include spaces, but in that case the whole thing must
19607 be wrapped in quotes.
19608 Note that the definition of a flex inset
19613 \begin_inset Flex Code
19616 \begin_layout Plain Layout
19622 entry, declaring which type of inset it defines.
19625 \begin_layout Enumerate
19626 The layout for user specific branch is being defined.
19628 \begin_inset Flex Code
19631 \begin_layout Plain Layout
19637 must be of the form
19638 \begin_inset Quotes eld
19642 \begin_inset Flex Code
19645 \begin_layout Plain Layout
19652 \begin_inset Quotes erd
19656 \begin_inset Flex Code
19659 \begin_layout Plain Layout
19665 may be be any valid identifier of branch defined in user's document.
19666 The identifier may include spaces, but in that case the whole thing must
19667 be wrapped in quotes.
19668 The main purpose of this feature is to allow \SpecialChar LaTeX
19669 wrapping around specific
19670 branches as user needs.
19673 \begin_layout Enumerate
19674 The layout of a user (or class) specific caption is being defined.
19676 \begin_inset Flex Code
19679 \begin_layout Plain Layout
19685 must be of the form
19686 \begin_inset Quotes eld
19690 \begin_inset Flex Code
19693 \begin_layout Plain Layout
19700 \begin_inset Quotes erd
19704 \begin_inset Flex Code
19707 \begin_layout Plain Layout
19713 specifies the name of the caption as it appears in the menu.
19714 Have a look at the standard caption (
19715 \begin_inset Flex Code
19718 \begin_layout Plain Layout
19724 ), the specific captions of the KOMA-Script classes (
19725 \begin_inset Flex Code
19728 \begin_layout Plain Layout
19735 \begin_inset Flex Code
19738 \begin_layout Plain Layout
19747 \begin_inset space ~
19751 \begin_inset Newline linebreak
19757 \begin_inset Flex Code
19760 \begin_layout Plain Layout
19766 ) for applications.
19769 \begin_layout Standard
19771 \begin_inset Flex Code
19774 \begin_layout Plain Layout
19780 definition can contain the following entries:
19783 \begin_layout Description
19784 \begin_inset Flex Code
19787 \begin_layout Plain Layout
19794 \begin_inset Flex Code
19797 \begin_layout Plain Layout
19803 =""] This inset will appear in the table of contents of the given type.
19804 An empty string disables.
19805 See also the OutlinerName and the IsTocCaption commands.
19806 This is only implemented for Flex insets.
19810 \begin_layout Description
19811 \begin_inset Flex Code
19814 \begin_layout Plain Layout
19821 \begin_inset Flex Code
19824 \begin_layout Plain Layout
19830 ] Defines argument number of a command\SpecialChar breakableslash
19831 environment associated with the current
19833 The definition must end with
19834 \begin_inset Flex Code
19837 \begin_layout Plain Layout
19845 \begin_inset CommandInset ref
19847 reference "subsec:Paragraph-Styles"
19854 \begin_layout Description
19855 \begin_inset Flex Code
19858 \begin_layout Plain Layout
19864 Preamble for changing language commands; see
19865 \begin_inset CommandInset ref
19867 reference "subsec:I18n"
19874 \begin_layout Description
19875 \begin_inset Flex Code
19878 \begin_layout Plain Layout
19885 \begin_inset Flex Code
19888 \begin_layout Plain Layout
19894 ] The color for the inset's background.
19896 \begin_inset CommandInset ref
19898 reference "chap:Names-of-colors"
19902 for a list of the available color names.
19905 \begin_layout Description
19906 \begin_inset Flex Code
19909 \begin_layout Plain Layout
19916 \begin_inset Flex Code
19919 \begin_layout Plain Layout
19928 \begin_inset space \thinspace{}
19932 \begin_inset Flex Code
19935 \begin_layout Plain Layout
19941 ] Whether to use the content of the inset as the label, when the inset is
19946 \begin_layout Description
19947 \begin_inset Flex Code
19950 \begin_layout Plain Layout
19957 \begin_inset Flex Code
19960 \begin_layout Plain Layout
19966 ] As with paragraph styles, see
19967 \begin_inset CommandInset ref
19969 reference "subsec:Paragraph-Styles"
19974 Note that you need to specify the complete type, e.
19975 \begin_inset space \thinspace{}
19979 \begin_inset space ~
19983 \begin_inset Flex Code
19986 \begin_layout Plain Layout
19987 CopyStyle Flex:<name>
19995 \begin_layout Description
19996 \begin_inset Flex Code
19999 \begin_layout Plain Layout
20006 \begin_inset Flex Code
20009 \begin_layout Plain Layout
20018 \begin_inset space \thinspace{}
20022 \begin_inset Flex Code
20025 \begin_layout Plain Layout
20031 ] Indicates whether the user may employ the Paragraph Settings dialog to
20032 customize the paragraph.
20035 \begin_layout Description
20036 \begin_inset Flex Code
20039 \begin_layout Plain Layout
20046 \begin_inset Flex Code
20049 \begin_layout Plain Layout
20056 \begin_inset Flex Code
20059 \begin_layout Plain Layout
20066 \begin_inset Flex Code
20069 \begin_layout Plain Layout
20075 , describing the rendering style used for the inset's frame and buttons.
20076 Footnotes generally use
20077 \begin_inset Flex Code
20080 \begin_layout Plain Layout
20086 , ERT insets generally
20087 \begin_inset Flex Code
20090 \begin_layout Plain Layout
20096 , and character styles
20097 \begin_inset Flex Code
20100 \begin_layout Plain Layout
20109 \begin_layout Description
20110 \begin_inset Flex Code
20113 \begin_layout Plain Layout
20120 \begin_inset Flex Code
20123 \begin_layout Plain Layout
20132 \begin_inset space \thinspace{}
20138 \begin_inset Flex Code
20141 \begin_layout Plain Layout
20150 \begin_inset Flex Code
20153 \begin_layout Plain Layout
20160 \begin_inset Flex Code
20163 \begin_layout Plain Layout
20170 Indicates whether the environment will stand on its own in the output or
20171 will appear inline with the surrounding text.
20172 If set to false, it is supposed that the \SpecialChar LaTeX
20173 environment ignores white space
20174 (including one newline character) after the
20175 \begin_inset Flex Code
20178 \begin_layout Plain Layout
20191 \begin_inset Flex Code
20194 \begin_layout Plain Layout
20208 \change_inserted 731793113 1538674858
20212 \begin_layout Description
20214 \change_inserted 731793113 1538674891
20215 \begin_inset Flex Code
20218 \begin_layout Plain Layout
20220 \change_inserted 731793113 1538674863
20232 ,1] Allow the contents of the inset to be edited externally (using whatever
20233 editor is defined for the document's output format).
20238 \begin_layout Description
20239 \begin_inset Flex Code
20242 \begin_layout Plain Layout
20248 Required at the end of the
20249 \begin_inset Flex Code
20252 \begin_layout Plain Layout
20261 \begin_layout Description
20262 \begin_inset Flex Code
20265 \begin_layout Plain Layout
20271 The font used for both the text body
20277 \begin_inset CommandInset ref
20279 reference "subsec:Font-description"
20284 Note that defining this font automatically defines the
20285 \begin_inset Flex Code
20288 \begin_layout Plain Layout
20294 to the same value, so define this first and define
20295 \begin_inset Flex Code
20298 \begin_layout Plain Layout
20304 later if you want them to be different.
20307 \begin_layout Description
20308 \begin_inset Flex Code
20311 \begin_layout Plain Layout
20312 FixedWidthPreambleEncoding
20318 \begin_inset Flex Code
20321 \begin_layout Plain Layout
20330 \begin_inset space \thinspace{}
20334 \begin_inset Flex Code
20337 \begin_layout Plain Layout
20343 ] Force a fixed width encoding for the translated contents of
20344 \begin_inset Flex Code
20347 \begin_layout Plain Layout
20354 \begin_inset Flex Code
20357 \begin_layout Plain Layout
20363 code generated by this layout.
20364 This is needed for special \SpecialChar LaTeX
20369 that do not work with variable width encodings such as
20374 This setting is ignored if fully Unicode aware \SpecialChar LaTeX
20375 backends such as Xe\SpecialChar TeX
20377 Lua\SpecialChar TeX
20381 \begin_layout Description
20382 \begin_inset Flex Code
20385 \begin_layout Plain Layout
20386 ForceLocalFontSwitch
20392 \begin_inset Flex Code
20395 \begin_layout Plain Layout
20404 \begin_inset space \thinspace{}
20408 \begin_inset Flex Code
20411 \begin_layout Plain Layout
20417 ] When using babel, always use a local font switch (
20418 \begin_inset Flex Code
20421 \begin_layout Plain Layout
20429 ), never a global one (such as
20430 \begin_inset Flex Code
20433 \begin_layout Plain Layout
20444 \begin_layout Description
20445 \begin_inset Flex Code
20448 \begin_layout Plain Layout
20455 \begin_inset Flex Code
20458 \begin_layout Plain Layout
20467 \begin_inset space \thinspace{}
20471 \begin_inset Flex Code
20474 \begin_layout Plain Layout
20481 \begin_inset Quotes eld
20485 \begin_inset Quotes erd
20488 language, leading to Left-to-Right (Latin) output, e.
20489 \begin_inset space \thinspace{}
20493 \begin_inset space \space{}
20496 in \SpecialChar TeX
20501 \begin_layout Description
20502 \begin_inset Flex Code
20505 \begin_layout Plain Layout
20512 \begin_inset Flex Code
20515 \begin_layout Plain Layout
20524 \begin_inset space \thinspace{}
20528 \begin_inset Flex Code
20531 \begin_layout Plain Layout
20537 ] Force a a line break in the \SpecialChar LaTeX
20538 output before the inset starts and after
20540 This assures the inset itself is output on its own lines, for parsing purposes.
20543 \begin_layout Description
20544 \begin_inset Flex Code
20547 \begin_layout Plain Layout
20554 \begin_inset Flex Code
20557 \begin_layout Plain Layout
20566 \begin_inset space \thinspace{}
20570 \begin_inset Flex Code
20573 \begin_layout Plain Layout
20579 ] Indicates whether the
20580 \begin_inset Flex Code
20583 \begin_layout Plain Layout
20589 should be used or, instead, the user can change the paragraph style used
20594 \begin_layout Description
20595 \begin_inset Flex Code
20598 \begin_layout Plain Layout
20605 \begin_inset Flex Code
20608 \begin_layout Plain Layout
20617 \begin_inset space \thinspace{}
20621 \begin_inset Flex Code
20624 \begin_layout Plain Layout
20630 ] As with paragraph styles, see
20631 \begin_inset CommandInset ref
20633 reference "subsec:Paragraph-Styles"
20640 \begin_layout Description
20641 \begin_inset Flex Code
20644 \begin_layout Plain Layout
20650 These tags control the XHTML output.
20652 \begin_inset CommandInset ref
20654 reference "sec:Tags-for-XHTML"
20661 \begin_layout Description
20662 \begin_inset Flex Code
20665 \begin_layout Plain Layout
20672 \begin_inset Flex Code
20675 \begin_layout Plain Layout
20684 \begin_inset space \thinspace{}
20688 \begin_inset Flex Code
20691 \begin_layout Plain Layout
20697 ] Whether to include the contents of this inset in the strings generated
20698 for the `Outline' pane for all table of contents, regardless of the AddToToc
20700 One would not, for example, want the content of a footnote in a section
20701 header to be included in the TOC displayed in the outline, but one would
20702 normally want the content of a character style displayed.
20703 Default is false: not to include.
20706 \begin_layout Description
20707 \begin_inset Flex Code
20710 \begin_layout Plain Layout
20717 \begin_inset Flex Code
20720 \begin_layout Plain Layout
20729 \begin_inset space \thinspace{}
20733 \begin_inset Flex Code
20736 \begin_layout Plain Layout
20742 ] If this is set to 1 and AddToToc is enabled, the inset adds a summary
20743 of its contents in its item in the table of contents.
20744 Otherwise, only the label appears.
20747 \begin_layout Description
20748 \begin_inset Flex Code
20751 \begin_layout Plain Layout
20760 \begin_inset Flex Code
20763 \begin_layout Plain Layout
20772 \begin_inset space \thinspace{}
20776 \begin_inset Flex Code
20779 \begin_layout Plain Layout
20785 ] As with paragraph styles, see
20786 \begin_inset CommandInset ref
20788 reference "subsec:Paragraph-Styles"
20795 \begin_layout Description
20796 \begin_inset Flex Code
20799 \begin_layout Plain Layout
20805 The font used for the label.
20807 \begin_inset CommandInset ref
20809 reference "subsec:Font-description"
20814 Note that this definition can never appear before
20815 \begin_inset Flex Code
20818 \begin_layout Plain Layout
20824 , lest it be ineffective.
20827 \begin_layout Description
20828 \begin_inset Flex Code
20831 \begin_layout Plain Layout
20838 \begin_inset Flex Code
20841 \begin_layout Plain Layout
20848 \begin_inset Quotes erd
20852 \begin_inset Quotes erd
20855 ] What will be displayed on the button or elsewhere as the inset label.
20857 \begin_inset Flex Code
20860 \begin_layout Plain Layout
20868 \begin_inset Flex Code
20871 \begin_layout Plain Layout
20877 ) modify this label on the fly.
20880 \begin_layout Description
20881 \begin_inset Flex Code
20884 \begin_layout Plain Layout
20890 Language dependent preamble; see
20891 \begin_inset CommandInset ref
20893 reference "subsec:I18n"
20900 \begin_layout Description
20901 \begin_inset Flex Code
20904 \begin_layout Plain Layout
20911 \begin_inset Flex Code
20914 \begin_layout Plain Layout
20920 ] The name of the corresponding \SpecialChar LaTeX
20922 Either the environment or command name.
20925 \begin_layout Description
20926 \begin_inset Flex Code
20929 \begin_layout Plain Layout
20936 \begin_inset Flex Code
20939 \begin_layout Plain Layout
20945 ] The optional parameter for the corresponding
20946 \begin_inset Flex Code
20949 \begin_layout Plain Layout
20955 stuff, including possible bracket pairs like
20956 \begin_inset Flex Code
20959 \begin_layout Plain Layout
20966 This parameter cannot be changed from within \SpecialChar LyX
20968 \begin_inset Flex Code
20971 \begin_layout Plain Layout
20977 for customizable parameters).
20978 It will be output as is after all \SpecialChar LaTeX
20980 \begin_inset Flex Code
20983 \begin_layout Plain Layout
20992 \begin_layout Description
20993 \begin_inset Flex Code
20996 \begin_layout Plain Layout
21003 \begin_inset Flex Code
21006 \begin_layout Plain Layout
21007 Command, Environment, None
21012 ] How the style should be translated into \SpecialChar LaTeX
21017 \begin_layout Plain Layout
21018 \begin_inset Flex Code
21021 \begin_layout Plain Layout
21027 is perhaps a bit misleading, since these rules apply to SGML classes too.
21028 Visit the SGML class files for specific examples.
21037 \begin_layout Description
21038 \begin_inset Flex Code
21041 \begin_layout Plain Layout
21047 means nothing special
21050 \begin_layout Description
21051 \begin_inset Flex Code
21054 \begin_layout Plain Layout
21061 \begin_inset Flex Code
21064 \begin_layout Plain Layout
21071 {\SpecialChar ldots
21080 \begin_layout Description
21081 \begin_inset Flex Code
21084 \begin_layout Plain Layout
21091 \begin_inset Flex Code
21094 \begin_layout Plain Layout
21101 }\SpecialChar ldots
21116 \begin_layout Standard
21117 Putting the last few things together, the \SpecialChar LaTeX
21118 output will be either:
21121 \begin_layout LyX-Code
21124 LatexName[LatexParam]{\SpecialChar ldots
21128 \begin_layout Standard
21132 \begin_layout LyX-Code
21135 begin{LatexName}[LatexParam] \SpecialChar ldots
21141 \begin_layout Standard
21142 depending upon the \SpecialChar LaTeX
21147 \begin_layout Description
21148 \begin_inset Flex Code
21151 \begin_layout Plain Layout
21158 \begin_inset Flex Code
21161 \begin_layout Plain Layout
21167 ] A string that is put at the beginning of the layout content.
21168 A line break in the output can be indicated by
21169 \begin_inset Flex Code
21172 \begin_layout Plain Layout
21181 \begin_layout Description
21182 \begin_inset Flex Code
21185 \begin_layout Plain Layout
21192 \begin_inset Flex Code
21195 \begin_layout Plain Layout
21202 \begin_inset Flex Code
21205 \begin_layout Plain Layout
21212 \begin_inset Flex Code
21215 \begin_layout Plain Layout
21222 \begin_inset Flex Code
21225 \begin_layout Plain Layout
21231 (indicating a dummy definition ending definitions of charstyles, etc).
21232 This entry is required in and is only meaningful for Flex insets.
21233 Among other things, it determines on which menu this inset will appear.
21235 \begin_inset Flex Code
21238 \begin_layout Plain Layout
21245 \begin_inset Flex Code
21248 \begin_layout Plain Layout
21254 will automatically set
21255 \begin_inset Flex Code
21258 \begin_layout Plain Layout
21265 \begin_inset Flex Code
21268 \begin_layout Plain Layout
21276 \begin_inset Flex Code
21279 \begin_layout Plain Layout
21285 can be set to true, or
21286 \begin_inset Flex Code
21289 \begin_layout Plain Layout
21296 \begin_inset Flex Code
21299 \begin_layout Plain Layout
21305 insets by setting it
21310 \begin_inset Flex Code
21313 \begin_layout Plain Layout
21320 \change_inserted -712698321 1555575738
21324 \begin_layout Description
21326 \change_inserted -712698321 1555575844
21327 \begin_inset Flex Code
21330 \begin_layout Plain Layout
21332 \change_inserted -712698321 1555575740
21341 \begin_inset Flex Code
21344 \begin_layout Plain Layout
21346 \change_inserted -712698321 1555575740
21354 A dedicated string for the menu.
21355 You can define an accelerator by appending the respective character to
21356 the string, divided by
21357 \begin_inset Quotes eld
21361 \begin_inset Quotes erd
21365 \begin_inset space \thinspace{}
21369 \begin_inset space \space{}
21373 \begin_inset Quotes eld
21377 \begin_inset Flex Code
21380 \begin_layout Plain Layout
21382 \change_inserted -712698321 1555575781
21391 \begin_inset Quotes erd
21395 This specification is optional.
21396 If it is not given the inset name as specified in the type declaration
21397 will be used instead for the menu.
21402 \begin_layout Description
21403 \begin_inset Flex Code
21406 \begin_layout Plain Layout
21413 \begin_inset Flex Code
21416 \begin_layout Plain Layout
21425 \begin_inset space \thinspace{}
21429 \begin_inset Flex Code
21432 \begin_layout Plain Layout
21438 ] Whether multiple paragraphs are permitted in this inset.
21440 \begin_inset Flex Code
21443 \begin_layout Plain Layout
21449 to the same value and
21450 \begin_inset Flex Code
21453 \begin_layout Plain Layout
21459 to the opposite value.
21460 These can be reset to other values, if they are used
21465 \begin_inset Flex Code
21468 \begin_layout Plain Layout
21478 \begin_layout Description
21479 \begin_inset Flex Code
21482 \begin_layout Plain Layout
21489 \begin_inset Flex Code
21492 \begin_layout Plain Layout
21501 \begin_inset space \thinspace{}
21505 \begin_inset Flex Code
21508 \begin_layout Plain Layout
21514 ] Whether fragile commands in this inset should be
21515 \begin_inset Flex Code
21518 \begin_layout Plain Layout
21531 whether the command should itself be protected.) Default is false.
21532 \change_inserted -712698321 1523633958
21536 \begin_layout Description
21538 \change_inserted -712698321 1552395786
21539 \begin_inset Flex Code
21542 \begin_layout Plain Layout
21544 \change_inserted -712698321 1523633961
21553 \begin_inset Flex Code
21556 \begin_layout Plain Layout
21558 \change_inserted -712698321 1523633958
21569 \begin_inset space \thinspace{}
21573 \begin_inset Flex Code
21576 \begin_layout Plain Layout
21578 \change_inserted -712698321 1523633958
21586 ] This causes macros that contain this inset to be protected with
21587 \begin_inset Flex Code
21590 \begin_layout Plain Layout
21592 \change_inserted -712698321 1523634038
21607 ) if necessary and thus allows (some) verbatim stuff in macros.
21611 \begin_layout Description
21613 \change_inserted -712698321 1555579651
21614 \begin_inset Flex Code
21617 \begin_layout Plain Layout
21619 \change_inserted -712698321 1552395787
21628 \begin_inset Flex Code
21631 \begin_layout Plain Layout
21633 \change_inserted -712698321 1552395787
21644 \begin_inset space \thinspace{}
21648 \begin_inset Flex Code
21651 \begin_layout Plain Layout
21653 \change_inserted -712698321 1552395787
21661 ] Whether specific commands in this inset (such as
21662 \begin_inset Flex Code
21665 \begin_layout Plain Layout
21667 \change_inserted -712698321 1552395787
21678 \begin_inset Flex Code
21681 \begin_layout Plain Layout
21683 \change_inserted -712698321 1552395787
21693 ) should be protected in an
21694 \begin_inset Flex Code
21697 \begin_layout Plain Layout
21699 \change_inserted -712698321 1552395787
21710 This is particularly needed for insets that draw on
21718 commands which parse their content in complex ways.
21722 \begin_layout Description
21724 \change_inserted -712698321 1555579742
21725 \begin_inset Flex Code
21728 \begin_layout Plain Layout
21730 \change_inserted -712698321 1555579658
21739 \begin_inset Flex Code
21742 \begin_layout Plain Layout
21744 \change_inserted -712698321 1555579651
21752 Option to define a different command (from the default
21753 \begin_inset Flex Code
21756 \begin_layout Plain Layout
21758 \change_inserted -712698321 1555579742
21770 ) to be used for line breaks.
21771 The initial backslash must not be specified.
21776 \begin_layout Description
21777 \begin_inset Flex Code
21780 \begin_layout Plain Layout
21787 \begin_inset Flex Code
21790 \begin_layout Plain Layout
21796 ] Deletes an existing
21797 \begin_inset Flex Code
21800 \begin_layout Plain Layout
21809 \begin_layout Description
21810 \begin_inset Flex Code
21813 \begin_layout Plain Layout
21820 \begin_inset Flex Code
21823 \begin_layout Plain Layout
21830 \begin_inset Flex Code
21833 \begin_layout Plain Layout
21839 that has replaced this
21840 \begin_inset Flex Code
21843 \begin_layout Plain Layout
21850 This is used to rename an
21851 \begin_inset Flex Code
21854 \begin_layout Plain Layout
21860 , while keeping backward compatibility.
21861 \change_inserted -712698321 1559491850
21865 \begin_layout Description
21867 \change_inserted -712698321 1559492002
21868 \begin_inset Flex Code
21871 \begin_layout Plain Layout
21873 \change_inserted -712698321 1559491854
21882 \begin_inset Flex Code
21885 \begin_layout Plain Layout
21887 \change_inserted -712698321 1559491850
21898 \begin_inset space \thinspace{}
21902 \begin_inset Flex Code
21905 \begin_layout Plain Layout
21907 \change_inserted -712698321 1559491850
21915 ] If this is set to
21916 \begin_inset Flex Code
21919 \begin_layout Plain Layout
21921 \change_inserted -712698321 1559491881
21929 , paragraph breaks will be ignored in the output.
21930 This might be useful for insets where the content should be alignable on
21931 different lines only in the \SpecialChar LyX
21932 workarea, without any effect in the output.
21937 \begin_layout Description
21938 \begin_inset Flex Code
21941 \begin_layout Plain Layout
21948 \begin_inset Flex Code
21951 \begin_layout Plain Layout
21960 \begin_inset space \thinspace{}
21964 \begin_inset Flex Code
21967 \begin_layout Plain Layout
21973 ] As with paragraph styles, see
21974 \begin_inset CommandInset ref
21976 reference "subsec:Paragraph-Styles"
21984 \begin_layout Description
21985 \begin_inset Flex Code
21988 \begin_layout Plain Layout
21995 \begin_inset Flex Code
21998 \begin_layout Plain Layout
22007 \begin_inset space \thinspace{}
22011 \begin_inset Flex Code
22014 \begin_layout Plain Layout
22020 ] As with paragraph styles, see
22021 \begin_inset CommandInset ref
22023 reference "subsec:Paragraph-Styles"
22031 \begin_layout Description
22032 \begin_inset Flex Code
22035 \begin_layout Plain Layout
22041 As with paragraph styles, see
22042 \begin_inset CommandInset ref
22044 reference "subsec:Paragraph-Styles"
22051 \begin_layout Description
22052 \begin_inset Flex Code
22055 \begin_layout Plain Layout
22062 \begin_inset Flex Code
22065 \begin_layout Plain Layout
22071 ] The prefix to use when creating labels referring to insets of this type.
22072 This allows the use of formatted references.
22075 \begin_layout Description
22076 \begin_inset Flex Code
22079 \begin_layout Plain Layout
22086 \begin_inset Flex Code
22089 \begin_layout Plain Layout
22095 ] As with paragraph styles, see
22096 \begin_inset CommandInset ref
22098 reference "subsec:Paragraph-Styles"
22105 \begin_layout Description
22106 \begin_inset Flex Code
22109 \begin_layout Plain Layout
22116 \begin_inset Flex Code
22119 \begin_layout Plain Layout
22128 \begin_inset space \thinspace{}
22132 \begin_inset Flex Code
22135 \begin_layout Plain Layout
22141 ] Resets the \SpecialChar LaTeX
22142 arguments of this layout (as defined via the
22143 \begin_inset Flex Code
22146 \begin_layout Plain Layout
22153 This is useful if you have copied a style via
22154 \begin_inset Flex Code
22157 \begin_layout Plain Layout
22163 , but you do not want to inherit its (required and optional) arguments.
22166 \begin_layout Description
22167 \begin_inset Flex Code
22170 \begin_layout Plain Layout
22177 \begin_inset Flex Code
22180 \begin_layout Plain Layout
22189 \begin_inset space \thinspace{}
22193 \begin_inset Flex Code
22196 \begin_layout Plain Layout
22203 \change_inserted -712698321 1597733473
22205 \begin_inset Flex Code
22208 \begin_layout Plain Layout
22210 \change_inserted -712698321 1597732178
22218 , font changes are redone inside the respective inset (in the output) even
22219 if the inset itself is in the context of this font changes (e.
22220 \begin_inset space \thinspace{}
22224 \begin_inset Flex Code
22227 \begin_layout Plain Layout
22229 \change_inserted -712698321 1597733683
22232 textbf{Sourrounding text
22236 textbf{content}}\SpecialChar ldots
22245 \begin_inset Flex Code
22248 \begin_layout Plain Layout
22250 \change_inserted -712698321 1597733686
22253 textbf{Sourrounding text
22255 myinset{content}\SpecialChar ldots
22264 Setting this makes sense for commands that internally reset font settings
22266 \begin_inset space \thinspace{}
22270 Note that wrongly setting this might lead to unwanted result (e.
22271 \begin_inset space \thinspace{}
22275 \begin_inset Flex Code
22278 \begin_layout Plain Layout
22280 \change_inserted -712698321 1597733688
22283 emph{Sourrounding text
22287 emph{content}}\SpecialChar ldots
22295 , content is upright, as
22296 \begin_inset Flex Code
22299 \begin_layout Plain Layout
22301 \change_inserted -712698321 1597733278
22313 \change_deleted -712698321 1597733283
22314 Whether this inset should use the font of its surrounding environment or
22319 \change_deleted -712698321 1597733290
22321 \change_inserted -712698321 1597733290
22323 \begin_inset Flex Code
22326 \begin_layout Plain Layout
22328 \change_inserted -712698321 1597733292
22339 \change_deleted -712698321 1597733327
22340 use the font of the surrounding environment
22341 \change_inserted -712698321 1597733343
22342 font changes are not redone inside the inset
22347 \begin_layout Description
22348 \begin_inset Flex Code
22351 \begin_layout Plain Layout
22358 \begin_inset Flex Code
22361 \begin_layout Plain Layout
22367 ] A string that is put at the end of the layout content.
22368 A line break in the output can be indicated by
22369 \begin_inset Flex Code
22372 \begin_layout Plain Layout
22381 \begin_layout Description
22382 \begin_inset Flex Code
22385 \begin_layout Plain Layout
22392 \begin_inset Flex Code
22395 \begin_layout Plain Layout
22402 \begin_inset space \thinspace{}
22406 \begin_inset Flex Code
22409 \begin_layout Plain Layout
22417 ] Allow spell-checking the contents of this inset.
22421 \begin_layout Subsection
22423 \begin_inset CommandInset label
22425 name "subsec:Counters"
22432 \begin_layout Standard
22433 It is necessary to define the counters (
22434 \begin_inset Flex Noun
22437 \begin_layout Plain Layout
22444 \begin_inset Flex Noun
22447 \begin_layout Plain Layout
22453 , \SpecialChar ldots
22454 ) in the text class itself.
22455 The standard counters are defined in the file
22456 \begin_inset Flex Code
22459 \begin_layout Plain Layout
22465 , so you may have to do no more than add
22468 \begin_layout LyX-Code
22469 Input stdcounters.inc
22472 \begin_layout Standard
22473 to your layout file to get them to work.
22474 But if you want to define custom counters, then you can do so.
22475 The counter declaration must begin with:
22478 \begin_layout LyX-Code
22479 Counter CounterName
22482 \begin_layout Standard
22484 \begin_inset Flex Code
22487 \begin_layout Plain Layout
22493 ' is replaced by the name of the counter.
22494 And it must end with
22495 \begin_inset Quotes eld
22499 \begin_inset Flex Code
22502 \begin_layout Plain Layout
22509 \begin_inset Quotes erd
22513 The following parameters can also be used:
22516 \begin_layout Description
22517 \begin_inset Flex Code
22520 \begin_layout Plain Layout
22527 \begin_inset Flex Code
22530 \begin_layout Plain Layout
22536 ] Sets the initial value for the counter, to which it will be reset whenever
22538 Normally, one will want the default, 1.
22541 \begin_layout Description
22542 \begin_inset Flex Code
22545 \begin_layout Plain Layout
22552 \begin_inset Flex Code
22555 \begin_layout Plain Layout
22562 \begin_inset Quotes erd
22566 \begin_inset Quotes erd
22569 ] When defined, this string defines how the counter is displayed.
22570 Setting this value sets
22571 \begin_inset Flex Code
22574 \begin_layout Plain Layout
22575 LabelStringAppendix
22581 The following special constructs can be used in the string:
22585 \begin_layout Itemize
22586 \begin_inset Flex Code
22589 \begin_layout Plain Layout
22597 will be replaced by the expansion of the
22598 \begin_inset Flex Code
22601 \begin_layout Plain Layout
22608 \begin_inset Flex Code
22611 \begin_layout Plain Layout
22612 LabelStringAppendix
22618 \begin_inset Flex Code
22621 \begin_layout Plain Layout
22631 \begin_layout Itemize
22632 counter values can be expressed using \SpecialChar LaTeX
22634 \begin_inset Newline newline
22638 \begin_inset Flex Code
22641 \begin_layout Plain Layout
22658 \begin_inset Flex Code
22661 \begin_layout Plain Layout
22673 \begin_layout Plain Layout
22683 Actually, the situation is a bit more complicated: any
22702 other than those described below will produce arabic numerals.
22703 It would not be surprising to see this change in the future.
22709 \begin_inset Flex Code
22712 \begin_layout Plain Layout
22718 : 1, 2, 3,\SpecialChar ldots
22720 \begin_inset Flex Code
22723 \begin_layout Plain Layout
22729 for lower-case letters: a, b, c, \SpecialChar ldots
22731 \begin_inset Flex Code
22734 \begin_layout Plain Layout
22740 for upper-case letters: A, B, C, \SpecialChar ldots
22742 \begin_inset Flex Code
22745 \begin_layout Plain Layout
22751 for lower-case roman numerals: i, ii, iii, \SpecialChar ldots
22753 \begin_inset Flex Code
22756 \begin_layout Plain Layout
22762 for upper-case roman numerals: I, II, III\SpecialChar ldots
22764 \begin_inset Flex Code
22767 \begin_layout Plain Layout
22773 for hebrew numerals.
22777 \begin_layout Standard
22778 If LabelString is not defined, a default value is constructed as follows:
22779 if the counter has a
22780 \change_deleted 731793113 1604355218
22782 \change_inserted 731793113 1604355221
22786 \begin_inset Flex Code
22789 \begin_layout Plain Layout
22791 \change_deleted 731793113 1604355223
22793 \change_inserted 731793113 1604355226
22802 \begin_inset Flex Code
22805 \begin_layout Plain Layout
22812 \begin_inset Newline newline
22816 \begin_inset Flex Code
22819 \begin_layout Plain Layout
22823 \change_inserted 731793113 1604355228
22825 \change_deleted 731793113 1604355230
22835 is used; otherwise the string
22836 \begin_inset Flex Code
22839 \begin_layout Plain Layout
22850 \begin_layout Description
22851 \begin_inset Flex Code
22854 \begin_layout Plain Layout
22855 LabelStringAppendix
22861 \begin_inset Flex Code
22864 \begin_layout Plain Layout
22871 \begin_inset Quotes erd
22875 \begin_inset Quotes erd
22879 \begin_inset Flex Code
22882 \begin_layout Plain Layout
22888 , but for use in the Appendix.
22891 \begin_layout Description
22892 \begin_inset Flex Code
22895 \begin_layout Plain Layout
22902 \begin_inset Flex Code
22905 \begin_layout Plain Layout
22912 \begin_inset Quotes erd
22916 \begin_inset Quotes erd
22919 ] A format for use with formatted references to this counter.
22920 For example, one might want to have references to section numbers appear
22922 \begin_inset Quotes eld
22926 \begin_inset Quotes erd
22930 The string should contain
22931 \begin_inset Quotes eld
22935 \begin_inset Quotes erd
22939 This will be replaced by the counter number itself.
22940 So, for sections, it would be: Section ##.
22943 \begin_layout Description
22944 \begin_inset Flex Code
22947 \begin_layout Plain Layout
22954 \begin_inset Flex Code
22957 \begin_layout Plain Layout
22964 \begin_inset Quotes erd
22968 \begin_inset Quotes erd
22971 ] If this is set to the name of another counter, the present counter will
22972 be reset every time the other one is increased.
22974 \begin_inset Flex Code
22977 \begin_layout Plain Layout
22984 \begin_inset Flex Code
22987 \begin_layout Plain Layout
22996 \begin_layout Subsection
22998 \begin_inset CommandInset label
23000 name "subsec:Font-description"
23007 \begin_layout Standard
23008 A font description looks like this:
23011 \begin_layout LyX-Code
23028 \begin_layout LyX-Code
23032 \begin_layout LyX-Code
23036 \begin_layout Standard
23037 The following commands are available:
23040 \begin_layout Description
23041 \begin_inset Flex Code
23044 \begin_layout Plain Layout
23051 \begin_inset Flex Code
23054 \begin_layout Plain Layout
23063 \begin_inset Flex Code
23066 \begin_layout Plain Layout
23073 \begin_inset Flex Code
23076 \begin_layout Plain Layout
23083 \begin_inset Flex Code
23086 \begin_layout Plain Layout
23093 \begin_inset Flex Code
23096 \begin_layout Plain Layout
23103 \begin_inset Flex Code
23106 \begin_layout Plain Layout
23113 \begin_inset Flex Code
23116 \begin_layout Plain Layout
23123 \begin_inset Flex Code
23126 \begin_layout Plain Layout
23133 \begin_inset Flex Code
23136 \begin_layout Plain Layout
23143 \begin_inset Flex Code
23146 \begin_layout Plain Layout
23153 \begin_inset Flex Code
23156 \begin_layout Plain Layout
23163 \begin_inset Flex Code
23166 \begin_layout Plain Layout
23173 \begin_inset Flex Code
23176 \begin_layout Plain Layout
23183 \begin_inset Flex Code
23186 \begin_layout Plain Layout
23193 \begin_inset Flex Code
23196 \begin_layout Plain Layout
23203 \begin_inset Flex Code
23206 \begin_layout Plain Layout
23213 \begin_inset Flex Code
23216 \begin_layout Plain Layout
23223 \begin_inset Flex Code
23226 \begin_layout Plain Layout
23233 \begin_inset Flex Code
23236 \begin_layout Plain Layout
23243 \begin_inset Flex Code
23246 \begin_layout Plain Layout
23255 \begin_layout Description
23256 \begin_inset Flex Code
23259 \begin_layout Plain Layout
23266 \begin_inset Flex Code
23269 \begin_layout Plain Layout
23278 \begin_inset Flex Code
23281 \begin_layout Plain Layout
23288 \begin_inset Flex Code
23291 \begin_layout Plain Layout
23300 \begin_layout Description
23301 \begin_inset Flex Code
23304 \begin_layout Plain Layout
23311 \begin_inset Flex Code
23314 \begin_layout Plain Layout
23320 ] Valid arguments are:
23321 \begin_inset Flex Code
23324 \begin_layout Plain Layout
23331 \begin_inset Flex Code
23334 \begin_layout Plain Layout
23341 \begin_inset Flex Code
23344 \begin_layout Plain Layout
23351 \begin_inset Flex Code
23354 \begin_layout Plain Layout
23361 \begin_inset Flex Code
23364 \begin_layout Plain Layout
23371 \begin_inset Flex Code
23374 \begin_layout Plain Layout
23381 \begin_inset Flex Code
23384 \begin_layout Plain Layout
23391 \begin_inset Flex Code
23394 \begin_layout Plain Layout
23401 \begin_inset Flex Code
23404 \begin_layout Plain Layout
23411 \begin_inset Flex Code
23414 \begin_layout Plain Layout
23421 \begin_inset Flex Code
23424 \begin_layout Plain Layout
23431 \begin_inset Flex Code
23434 \begin_layout Plain Layout
23441 Each of these turns on or off the corresponding attribute.
23443 \begin_inset Flex Code
23446 \begin_layout Plain Layout
23452 turns on emphasis, and
23453 \begin_inset Flex Code
23456 \begin_layout Plain Layout
23464 \begin_inset Newline newline
23467 If the latter seems puzzling, remember that the font settings for the present
23468 context are generally inherited from the surrounding context.
23470 \begin_inset Flex Code
23473 \begin_layout Plain Layout
23479 would turn off the emphasis that was anyway in effect, say, in a theorem
23483 \begin_layout Description
23484 \begin_inset Flex Code
23487 \begin_layout Plain Layout
23494 \begin_inset Flex Code
23497 \begin_layout Plain Layout
23506 \begin_inset Flex Code
23509 \begin_layout Plain Layout
23518 \begin_layout Description
23519 \begin_inset Flex Code
23522 \begin_layout Plain Layout
23529 \begin_inset Flex Code
23532 \begin_layout Plain Layout
23541 \begin_inset Flex Code
23544 \begin_layout Plain Layout
23551 \begin_inset Flex Code
23554 \begin_layout Plain Layout
23561 \begin_inset Flex Code
23564 \begin_layout Plain Layout
23573 \begin_layout Description
23574 \begin_inset Flex Code
23577 \begin_layout Plain Layout
23584 \begin_inset Flex Code
23587 \begin_layout Plain Layout
23594 \begin_inset Flex Code
23597 \begin_layout Plain Layout
23604 \begin_inset Flex Code
23607 \begin_layout Plain Layout
23616 \begin_inset Flex Code
23619 \begin_layout Plain Layout
23626 \begin_inset Flex Code
23629 \begin_layout Plain Layout
23636 \begin_inset Flex Code
23639 \begin_layout Plain Layout
23646 \begin_inset Flex Code
23649 \begin_layout Plain Layout
23656 \begin_inset Flex Code
23659 \begin_layout Plain Layout
23668 \begin_layout Subsection
23669 \begin_inset CommandInset label
23671 name "subsec:Citation-engine-description"
23675 Cite engine description
23678 \begin_layout Standard
23680 \begin_inset Flex Code
23683 \begin_layout Plain Layout
23689 blocks, as used mainly in cite engine files (see
23690 \begin_inset CommandInset ref
23692 reference "subsec:Cite-Engine-Files"
23699 ), define the citation commands provided by a specific
23700 \begin_inset Quotes eld
23704 \begin_inset Quotes erd
23708 A cite engine, in \SpecialChar LyX
23709 terms, is way specific way to format citations, using
23710 numbers, author names and/or years.
23711 Currently, \SpecialChar LyX
23712 supports three such engine types, namely:
23715 \begin_layout Enumerate
23716 \begin_inset Flex Code
23719 \begin_layout Plain Layout
23725 : the default Bib\SpecialChar TeX
23726 way to format citations, a simple numeric style (e.
23727 \begin_inset space \thinspace{}
23731 \begin_inset Quotes eld
23735 \begin_inset Quotes erd
23741 \begin_layout Enumerate
23742 \begin_inset Flex Code
23745 \begin_layout Plain Layout
23751 : Harvard-styled citations using author names and publication year (e.
23752 \begin_inset space \thinspace{}
23756 \begin_inset Quotes eld
23759 Smith and Miller (2017b)
23760 \begin_inset Quotes erd
23766 \begin_layout Enumerate
23767 \begin_inset Flex Code
23770 \begin_layout Plain Layout
23776 : extended numerical citations that also allow for author or title next
23778 \begin_inset space \thinspace{}
23782 \begin_inset Quotes eld
23785 Smith and Miller [1]
23786 \begin_inset Quotes erd
23792 \begin_layout Standard
23793 \begin_inset Flex Code
23796 \begin_layout Plain Layout
23802 blocks look like this:
23805 \begin_layout LyX-Code
23809 \begin_layout LyX-Code
23813 \begin_layout LyX-Code
23817 \begin_layout LyX-Code
23818 citeyearpar[][]=parencite*
23821 \begin_layout LyX-Code
23825 \begin_layout LyX-Code
23829 \begin_layout Standard
23831 \begin_inset Flex Code
23834 \begin_layout Plain Layout
23840 denotes the engine.
23841 The individual lines respectively define a cite command or cite command
23842 paradigm supported by this engine.
23843 The line can be as simple as a cite command that is used both to name the
23844 respective \SpecialChar LyX
23845 command and the \SpecialChar LaTeX
23846 output or more complex in order to differentiate
23848 The full syntax is:
23851 \begin_layout LyX-Code
23852 LyXName|alias$*<!_stardesc!_stardesctooltip>[][]=latexcmd
23855 \begin_layout Itemize
23856 \begin_inset Flex Code
23859 \begin_layout Plain Layout
23865 : The name as used in the
23866 \begin_inset Flex Code
23869 \begin_layout Plain Layout
23879 \begin_layout Standard
23880 For portability reasons, we try to use the same name for same-formatted
23881 commands in different cite packages (thus many names stem from natbib,
23882 and thus we need to differentiate a
23883 \begin_inset Flex Code
23886 \begin_layout Plain Layout
23892 sometimes, if the \SpecialChar LaTeX
23893 command names differ).
23897 \begin_layout Itemize
23898 \begin_inset Flex Code
23901 \begin_layout Plain Layout
23907 : a (comma-separated) list of commands that fall back to the given
23908 \begin_inset Flex Code
23911 \begin_layout Plain Layout
23917 in the current engine.
23918 This eases the switch of citation packages and engines.
23920 \begin_inset Flex Code
23923 \begin_layout Plain Layout
23930 \begin_inset Flex Code
23933 \begin_layout Plain Layout
23939 in layout definitions.
23942 \begin_layout Itemize
23943 \begin_inset Flex Code
23946 \begin_layout Plain Layout
23952 : The actual \SpecialChar LaTeX
23953 command that is output.
23957 \begin_layout Standard
23958 \begin_inset Flex Code
23961 \begin_layout Plain Layout
23968 \begin_inset Flex Code
23971 \begin_layout Plain Layout
23979 \begin_inset Flex Code
23982 \begin_layout Plain Layout
23989 \begin_inset Flex Code
23992 \begin_layout Plain Layout
23998 will be output to \SpecialChar LaTeX
24002 \begin_layout Standard
24006 \begin_layout Itemize
24007 Capitalization indicates that the command also has a capitalized form (
24008 \begin_inset Flex Code
24011 \begin_layout Plain Layout
24021 \begin_inset Flex Code
24024 \begin_layout Plain Layout
24033 These usually enforce up-casing of name prefixes (
24038 \begin_inset Formula $\Rightarrow$
24048 \begin_layout Itemize
24050 \begin_inset Flex Code
24053 \begin_layout Plain Layout
24059 indicate the number of optional arguments (there can be 0–2).
24062 \begin_layout Itemize
24064 \begin_inset Flex Code
24067 \begin_layout Plain Layout
24073 indicates there is a starred version of the command (
24074 \begin_inset Flex Code
24077 \begin_layout Plain Layout
24087 \begin_inset Flex Code
24090 \begin_layout Plain Layout
24103 \begin_layout Standard
24104 By default, the starred version means: Output all authors even if it should
24106 \begin_inset Quotes eld
24110 \begin_inset Quotes erd
24114 \begin_inset Flex Code
24117 \begin_layout Plain Layout
24126 \begin_layout Standard
24127 If the star has a different meaning for a given command, it can be specified
24129 \begin_inset Flex Code
24132 \begin_layout Plain Layout
24133 <!_stardesc!_stardesctooltip>
24139 Maximal two translatable macro keywords, marked by the prefix
24140 \begin_inset Flex Code
24143 \begin_layout Plain Layout
24150 The first points to the string that replaces the
24151 \begin_inset Quotes eld
24155 \begin_inset Quotes erd
24158 checkbox label in the citation dialog, the second one to an optional tool
24159 tip for this checkbox.
24163 \begin_layout Standard
24164 Note that these two macros have to be defined in a
24165 \begin_inset Flex Code
24168 \begin_layout Plain Layout
24174 (see next section), dropping the
24175 \begin_inset Flex Code
24178 \begin_layout Plain Layout
24184 from the prefix, like this:
24187 \begin_layout LyX-Code
24188 _stardesc Sta&rred command label
24191 \begin_layout LyX-Code
24192 _stardesctooltip Tooltip for the starred command checkbox.
24196 \begin_layout Itemize
24198 \begin_inset Flex Code
24201 \begin_layout Plain Layout
24207 indicates that this command features
24208 \begin_inset Quotes eld
24211 qualified citation lists
24212 \begin_inset Quotes erd
24220 -specific feature for multi-reference citations where an individual pre-
24221 and postnote can be given to each reference in the list.
24222 Please refer to the
24226 manual for details.
24227 \change_inserted -712698321 1526898670
24231 \begin_layout Standard
24233 \change_inserted -712698321 1526899524
24234 If you want to add a cite command to a cite engine (e.
24235 \begin_inset space \thinspace{}
24238 g., add a specific command provided by a class), you can use
24239 \begin_inset Flex Code
24242 \begin_layout Plain Layout
24244 \change_inserted -712698321 1526898768
24245 AddToCiteEngine <engine type> \SpecialChar ldots
24254 Note that only cite commands that do not exist yet are added.
24259 \begin_layout Subsection
24260 \begin_inset CommandInset label
24262 name "subsec:Citation-format-description"
24266 Cite format description
24269 \begin_layout Standard
24271 \begin_inset Flex Code
24274 \begin_layout Plain Layout
24280 blocks are used to describe how bibliographic information should be displayed,
24281 both within \SpecialChar LyX
24282 itself (in the citation dialog and in tooltips, for example)
24283 and in XHTML output.
24284 Such a block might look like this:
24287 \begin_layout LyX-Code
24291 \begin_layout LyX-Code
24295 \begin_layout LyX-Code
24299 \begin_layout LyX-Code
24303 \begin_layout Standard
24307 \begin_layout LyX-Code
24311 \begin_layout LyX-Code
24315 \begin_layout LyX-Code
24319 \begin_layout LyX-Code
24323 \begin_layout Standard
24324 In the first case, the individual lines define how the bibliographic information
24325 associated with an article or book, respectively, is to be displayed, and
24326 such a definition can be given for any
24327 \begin_inset Quotes els
24331 \begin_inset Quotes ers
24334 that might be present in a Bib\SpecialChar TeX
24337 defines a default format in the source code that will be used if no specific
24338 definition has been given.
24340 predefines several formats in the file
24341 \begin_inset Flex Code
24344 \begin_layout Plain Layout
24350 , which is included in most of \SpecialChar LyX
24351 's document classes.
24354 \begin_layout Standard
24355 In the second case, the lines define how a specific citation command (in
24357 \begin_inset Flex Code
24360 \begin_layout Plain Layout
24369 \begin_inset Flex Code
24372 \begin_layout Plain Layout
24380 ) is to be displayed on the citation inset label, in the citation dialog,
24381 menu or XHTML output.
24383 defines such formats for the citation style variants it supports via
24385 Document\SpecialChar menuseparator
24386 Setting\SpecialChar menuseparator
24387 Bibliography\SpecialChar ldots
24391 \begin_inset Flex Code
24394 \begin_layout Plain Layout
24400 files that are shipped with \SpecialChar LyX
24402 \begin_inset CommandInset ref
24404 reference "subsec:Cite-Engine-Files"
24414 \begin_layout Standard
24415 The definitions use a simple language that allows Bib\SpecialChar TeX
24416 keys to be replaced
24418 Keys should be enclosed in
24419 \begin_inset Flex Code
24422 \begin_layout Plain Layout
24429 \begin_inset Flex Code
24432 \begin_layout Plain Layout
24439 So a simple definition might look like this:
24442 \begin_layout LyX-Code
24444 \begin_inset Quotes eld
24448 \begin_inset Quotes erd
24454 \begin_layout Standard
24455 This would print the author, followed by a comma, followed by the title,
24456 in quotes, followed by a period.
24459 \begin_layout Standard
24460 Of course, sometimes you may want to print a key only if it exists.
24461 This can be done by using a conditional construction, such as:
24462 \begin_inset Flex Code
24465 \begin_layout Plain Layout
24467 \begin_inset space ~
24477 \begin_inset Flex Code
24480 \begin_layout Plain Layout
24486 key exists, then print
24487 \begin_inset Quotes eld
24491 \begin_inset space ~
24495 \begin_inset Quotes erd
24498 followed by the volume key.
24499 It is also possible to have an else clause in the conditional, such as:
24500 \begin_inset Newline newline
24504 \begin_inset Flex Code
24507 \begin_layout Plain Layout
24508 {%author%[[%author%]][[%editor%, ed.]]}
24514 \begin_inset Newline newline
24518 \begin_inset Flex Code
24521 \begin_layout Plain Layout
24527 key is printed if it exists; otherwise, the editor key is printed, followed
24529 \begin_inset Quotes eld
24533 \begin_inset space ~
24537 \begin_inset Quotes erd
24540 Note that the key is again enclosed in
24541 \begin_inset Flex Code
24544 \begin_layout Plain Layout
24550 signs; the entire conditional is enclosed in braces; and the if and else
24551 clauses are enclosed in double brackets,
24552 \begin_inset Quotes eld
24556 \begin_inset Flex Code
24559 \begin_layout Plain Layout
24566 \begin_inset Quotes eld
24570 \begin_inset Quotes eld
24574 \begin_inset Flex Code
24577 \begin_layout Plain Layout
24584 \begin_inset Quotes erd
24588 There must be no space between any of these.
24591 \begin_layout Standard
24592 Next to the entry keys, there are some special keys that can be used for
24593 these conditionals:
24596 \begin_layout Itemize
24597 \begin_inset Flex Code
24600 \begin_layout Plain Layout
24601 {%dialog%[[true]][[false]]}
24607 \begin_inset Quotes eld
24611 \begin_inset Quotes erd
24614 part for dialogs and menus, the
24615 \begin_inset Quotes eld
24619 \begin_inset Quotes erd
24622 part for other contexts (workarea, export)
24625 \begin_layout Itemize
24626 \begin_inset Flex Code
24629 \begin_layout Plain Layout
24630 {%export%[[true]][[false]]}
24636 \begin_inset Quotes eld
24640 \begin_inset Quotes erd
24643 part for export and menus, the
24644 \begin_inset Quotes eld
24648 \begin_inset Quotes erd
24651 part for other contexts (workarea, dialog)
24654 \begin_layout Itemize
24655 \begin_inset Flex Code
24658 \begin_layout Plain Layout
24665 \begin_inset Quotes eld
24669 \begin_inset Quotes erd
24672 part if another item follows (e.
24673 \begin_inset space \thinspace{}
24676 g., in a citation with multiple keys)
24679 \begin_layout Itemize
24680 \begin_inset Flex Code
24683 \begin_layout Plain Layout
24684 {%second%[[true]][[false]]}
24690 \begin_inset Quotes eld
24694 \begin_inset Quotes erd
24697 if this is the second of multiple items, else the
24698 \begin_inset Quotes eld
24702 \begin_inset Quotes erd
24708 \begin_layout Itemize
24709 \begin_inset Flex Code
24712 \begin_layout Plain Layout
24713 {%ifstar%[[true]][[false]]}
24719 \begin_inset Quotes eld
24723 \begin_inset Quotes erd
24726 part for starred citation commands (such as
24727 \begin_inset Flex Code
24730 \begin_layout Plain Layout
24738 ), the false part for unstarred
24741 \begin_layout Itemize
24742 \begin_inset Flex Code
24745 \begin_layout Plain Layout
24746 {%ifentrytype:<type>%[[true]][[false]]}
24752 \begin_inset Quotes eld
24756 \begin_inset Quotes erd
24759 if the current entry type matches
24760 \begin_inset Flex Code
24763 \begin_layout Plain Layout
24769 , else the false part (e.g., in a citation definition:
24770 \begin_inset Flex Code
24773 \begin_layout Plain Layout
24774 {%ifentrytype:book%[[this is a book]][[this is no book]]}
24782 \begin_layout Itemize
24783 \begin_inset Flex Code
24786 \begin_layout Plain Layout
24787 {%ifmultiple:<authortype>%[[true]][[false]]}
24793 \begin_inset Quotes eld
24797 \begin_inset Quotes erd
24800 if the current author type (author, editor etc.) has multiple authors, else
24801 the false part (e.g., in a bibliography definition:
24802 \begin_inset Flex Code
24805 \begin_layout Plain Layout
24806 {%ifmultiple:editor%[[eds.]][[ed.]]}
24814 \begin_layout Itemize
24815 \begin_inset Flex Code
24818 \begin_layout Plain Layout
24819 {%ifqualified%[[true]][[false]]}
24825 \begin_inset Quotes eld
24829 \begin_inset Quotes erd
24832 part if the current citation is a qualified citation list (a specific
24836 format for multi-reference citations), the false part if this is not the
24840 \begin_layout Standard
24842 \begin_inset Flex Code
24845 \begin_layout Plain Layout
24851 prints the author key as it is recorded in the bibliography file.
24852 This might not be what you want, since it will result in a string such
24854 \begin_inset Quotes eld
24857 Miller, Peter and Smith, Mary and White, Jane
24858 \begin_inset Quotes erd
24862 \begin_inset Quotes eld
24866 \begin_inset Quotes erd
24869 is used by Bib\SpecialChar TeX
24870 to delimit authors).
24872 therefore provides some methods to get properly formatted name lists (which
24873 will also get translated).
24874 The following keys are provided:
24877 \begin_layout Enumerate
24878 For name lists with pre- and surname, suitable for the main authors/editors
24879 of a bibliography item.
24881 \begin_inset Flex Code
24884 \begin_layout Plain Layout
24890 part denotes the kind of list that is requested (e.g.
24892 \begin_inset Flex Code
24895 \begin_layout Plain Layout
24905 \begin_layout Itemize
24906 \begin_inset Flex Code
24909 \begin_layout Plain Layout
24910 %abbrvnames:<nametype>%
24915 : Provides a name list which is abbreviated (with
24916 \begin_inset Quotes eld
24920 \begin_inset Quotes erd
24924 \begin_inset Flex Code
24927 \begin_layout Plain Layout
24936 \begin_layout Itemize
24937 \begin_inset Flex Code
24940 \begin_layout Plain Layout
24941 %fullnames:<nametype>%
24946 : Provides a full name list (never abbreviated with
24947 \begin_inset Quotes eld
24951 \begin_inset Quotes erd
24957 \begin_layout Itemize
24958 \begin_inset Flex Code
24961 \begin_layout Plain Layout
24962 %forceabbrvnames:<nametype>%
24967 : Provides a name list which is always abbreviated (with
24968 \begin_inset Quotes eld
24972 \begin_inset Quotes erd
24976 \begin_inset Flex Code
24979 \begin_layout Plain Layout
24989 \begin_layout Enumerate
24990 Alternative name lists with pre- and surname, if the order of pre- and surname
24991 inside the bibliography item differs (as in:
24992 \begin_inset Quotes eld
24995 Miller, John: Some text, in: Mary Smith, ed.: A volume
24996 \begin_inset Quotes erd
25003 \begin_layout Itemize
25004 \begin_inset Flex Code
25007 \begin_layout Plain Layout
25008 %abbrvbynames:<nametype>%
25013 : Provides a name list which is abbreviated (with
25014 \begin_inset Quotes eld
25018 \begin_inset Quotes erd
25022 \begin_inset Flex Code
25025 \begin_layout Plain Layout
25034 \begin_layout Itemize
25035 \begin_inset Flex Code
25038 \begin_layout Plain Layout
25039 %fullbynames:<nametype>%
25044 : Provides a full name list (never abbreviated with
25045 \begin_inset Quotes eld
25049 \begin_inset Quotes erd
25055 \begin_layout Itemize
25056 \begin_inset Flex Code
25059 \begin_layout Plain Layout
25060 %forceabbrvbynames:<nametype>%
25065 : Provides a name list which is always abbreviated (with
25066 \begin_inset Quotes eld
25070 \begin_inset Quotes erd
25074 \begin_inset Flex Code
25077 \begin_layout Plain Layout
25087 \begin_layout Enumerate
25088 And finally name lists which consist of family names only, as used in author-yea
25090 These do not take a
25091 \begin_inset Flex Code
25094 \begin_layout Plain Layout
25100 part, but always return either an author list or, if this does not exist,
25101 an editor list (as common in author-year labels):
25105 \begin_layout Itemize
25106 \begin_inset Flex Code
25109 \begin_layout Plain Layout
25115 : Provides a name list which is abbreviated (with
25116 \begin_inset Quotes eld
25120 \begin_inset Quotes erd
25124 \begin_inset Flex Code
25127 \begin_layout Plain Layout
25136 \begin_layout Itemize
25137 \begin_inset Flex Code
25140 \begin_layout Plain Layout
25146 : Provides a full name list (never abbreviated with
25147 \begin_inset Quotes eld
25151 \begin_inset Quotes erd
25157 \begin_layout Itemize
25158 \begin_inset Flex Code
25161 \begin_layout Plain Layout
25162 %forceabbrvciteauthor%
25167 : Provides a name list which is always abbreviated (with
25168 \begin_inset Quotes eld
25172 \begin_inset Quotes erd
25176 \begin_inset Flex Code
25179 \begin_layout Plain Layout
25189 \begin_layout Standard
25190 The order of pre- and surname in the former two lists can be adjusted by
25194 \begin_layout Itemize
25195 \begin_inset Flex Code
25198 \begin_layout Plain Layout
25199 !firstnameform %surname%, %prename%
25204 (first author in lists of type 1)
25207 \begin_layout Itemize
25208 \begin_inset Flex Code
25211 \begin_layout Plain Layout
25212 !othernameform %surname%, %prename%
25217 (other authors in lists of type 1)
25220 \begin_layout Itemize
25221 \begin_inset Flex Code
25224 \begin_layout Plain Layout
25225 !firstbynameform %prename% %surname%
25230 (first author in lists of type 2)
25233 \begin_layout Itemize
25234 \begin_inset Flex Code
25237 \begin_layout Plain Layout
25238 !otherbynameform %prename% %surname%
25243 (other authors in lists of type 2)
25246 \begin_layout Standard
25247 This allows you to configure namings like
25248 \begin_inset Quotes eld
25251 Miller, Peter and Mary Smith: \SpecialChar ldots
25252 , in: John Doe and Pat Green, eds.:\SpecialChar ldots
25254 \begin_inset Quotes erd
25260 \begin_layout Standard
25261 There is one other piece of syntax available in definitions, which looks
25263 \begin_inset Flex Code
25266 \begin_layout Plain Layout
25273 This defines a piece of formatting information that is to be used when
25275 \begin_inset Quotes eld
25279 \begin_inset Quotes erd
25283 Obviously, we do not want to output HTML tags when writing plain text,
25284 so they should be wrapped in
25285 \begin_inset Quotes eld
25289 \begin_inset Quotes erd
25293 \begin_inset Quotes eld
25297 \begin_inset Quotes erd
25303 \begin_layout Standard
25304 Two special sorts of definitions are also possible in a
25305 \begin_inset Flex Code
25308 \begin_layout Plain Layout
25315 An example of the first would be:
25318 \begin_layout LyX-Code
25320 \begin_inset Quotes eld
25324 \begin_inset Quotes erd
25330 \begin_layout Standard
25331 This is an abbreviation, or macro, and it can be used by treating it as
25333 \begin_inset Flex Code
25336 \begin_layout Plain Layout
25345 \begin_inset Flex Code
25348 \begin_layout Plain Layout
25354 exactly as it would treat its definition.
25355 So, let us issue the obvious
25363 \begin_layout LyX-Code
25367 \begin_layout Standard
25368 or anything like it.
25370 shouldn't go into an infinite loop, but it may go into a long one before
25374 \begin_layout Standard
25375 The second sort of special definition might look like this:
25378 \begin_layout LyX-Code
25382 \begin_layout Standard
25383 This defines a translatable piece of text, which allows relevant parts of
25384 the bibliography or citation to be translated.
25385 It can be included in a definition by treating it as a key:
25386 \begin_inset Flex Code
25389 \begin_layout Plain Layout
25396 Note that there are two different translation paths: All definitions starting
25398 \begin_inset Flex Code
25401 \begin_layout Plain Layout
25407 , such as in the example above, will be translated to the currently active
25408 buffer language (so the translation will match the generated document).
25409 All definitions starting with underscore only will be translated to the
25411 This is the proper translation for strings that only occur in the dialogs
25412 or on buttons, such as this one:
25415 \begin_layout LyX-Code
25416 _addtobib Add to bibliography only.
25419 \begin_layout Standard
25420 Several of these translatable strings are predefined in
25421 \begin_inset Flex Code
25424 \begin_layout Plain Layout
25431 \begin_inset Flex Code
25434 \begin_layout Plain Layout
25441 Note that these are not macros, in the sense just defined.
25442 They will not be expanded.
25445 \begin_layout Standard
25446 So here then is an example that uses several of these features:
25447 \begin_inset VSpace defskip
25453 \begin_layout Standard
25457 !authoredit {%author%[[%author%, ]][[{%editor%[[%editor%, %B_edtext%, ]]}]]}
25460 \begin_layout Standard
25461 \begin_inset VSpace defskip
25464 This defines a macro that prints the author, followed by a comma, if the
25466 \begin_inset Flex Code
25469 \begin_layout Plain Layout
25475 key is defined, or else prints the name of the editor, followed by the
25477 \begin_inset Flex Code
25480 \begin_layout Plain Layout
25486 or its translation (it is by default
25487 \begin_inset Quotes eld
25491 \begin_inset Quotes erd
25495 \begin_inset Flex Code
25498 \begin_layout Plain Layout
25505 Note that this is in fact defined in
25506 \begin_inset Flex Code
25509 \begin_layout Plain Layout
25515 , so you can use it in your own definitions, or re-definitions, if you load
25519 \begin_layout Section
25520 \begin_inset CommandInset label
25522 name "sec:Tags-for-XHTML"
25526 Tags for XHTML output
25529 \begin_layout Standard
25530 As with \SpecialChar LaTeX
25531 or DocBook, the format of \SpecialChar LyX
25532 's XHTML output is also controlled by
25533 layout information.
25534 In general, \SpecialChar LyX
25535 provides sensible defaults and, as mentioned earlier, it will
25536 even construct default CSS style rules from the other layout tags.
25537 For example, \SpecialChar LyX
25538 will attempt to use the information provided in the
25539 \begin_inset Flex Code
25542 \begin_layout Plain Layout
25548 declaration for the Chapter style to write CSS that will appropriately
25549 format chapter headings.
25552 \begin_layout Standard
25553 In many cases, then, you may not have to do anything at all to get acceptable
25554 XHTML output for your own environments, custom insets, and so forth.
25555 But in some cases you will, and so \SpecialChar LyX
25556 provides a number of layout tags that
25557 can be used to customize the XHTML and CSS that are generated.
25560 \begin_layout Standard
25561 Note that there are two tags,
25562 \begin_inset Flex Code
25565 \begin_layout Plain Layout
25572 \begin_inset Flex Code
25575 \begin_layout Plain Layout
25581 that may appear outside style and inset declarations.
25583 \begin_inset CommandInset ref
25585 reference "subsec:General-text-class"
25589 for details on these.
25592 \begin_layout Subsection
25593 \begin_inset CommandInset label
25595 name "subsec:Paragraph-Style-XHTML"
25602 \begin_layout Standard
25603 The sort of XHTML \SpecialChar LyX
25604 outputs for a paragraph depends upon whether we are dealing
25605 with a normal paragraph, a command, or an environment, where this is itself
25606 determined by the contents of the corresponding
25607 \begin_inset Flex Code
25610 \begin_layout Plain Layout
25621 \begin_layout Standard
25622 For a command or normal paragraph, the output XHTML has the following form:
25625 \begin_layout LyX-Code
25629 \begin_inset Quotes erd
25633 \begin_inset Quotes erd
25639 \begin_layout LyX-Code
25643 \begin_inset Quotes erd
25647 \begin_inset Quotes erd
25653 \begin_layout LyX-Code
25656 Contents of the paragraph.
25659 \begin_layout LyX-Code
25665 \begin_layout Standard
25666 The label tags are of course omitted if the paragraph does not have a label.
25669 \begin_layout Standard
25670 For an environment that is not some sort of list, the XHTML takes this form:
25673 \begin_layout LyX-Code
25677 \begin_inset Quotes erd
25681 \begin_inset Quotes erd
25687 \begin_layout LyX-Code
25691 \begin_inset Quotes erd
25695 \begin_inset Quotes erd
25699 \begin_inset Quotes erd
25703 \begin_inset Quotes erd
25706 >Environment Label</labeltag>First paragraph.</itemtag>
25709 \begin_layout LyX-Code
25712 <itemtag>Second paragraph.</itemtag>
25715 \begin_layout LyX-Code
25721 \begin_layout Standard
25722 Note that the label is output only for the first paragraph, as it should
25723 be for a theorem, for example.
25727 \begin_layout Standard
25728 For a list, we have one of these forms:
25731 \begin_layout LyX-Code
25735 \begin_inset Quotes erd
25739 \begin_inset Quotes erd
25745 \begin_layout LyX-Code
25749 \begin_inset Quotes erd
25753 \begin_inset Quotes erd
25757 \begin_inset Quotes erd
25761 \begin_inset Quotes erd
25764 >List Label</labeltag>First item.</itemtag>
25767 \begin_layout LyX-Code
25771 \begin_inset Quotes erd
25775 \begin_inset Quotes erd
25779 \begin_inset Quotes erd
25783 \begin_inset Quotes erd
25786 >List Label</labeltag>Second item.</itemtag>
25789 \begin_layout LyX-Code
25795 \begin_layout LyX-Code
25799 \begin_layout LyX-Code
25803 \begin_inset Quotes erd
25807 \begin_inset Quotes erd
25813 \begin_layout LyX-Code
25817 \begin_inset Quotes erd
25821 \begin_inset Quotes erd
25824 >List Label</labeltag><itemtag attr=
25825 \begin_inset Quotes erd
25829 \begin_inset Quotes erd
25832 >First item.</itemtag>
25835 \begin_layout LyX-Code
25839 \begin_inset Quotes erd
25843 \begin_inset Quotes erd
25846 >List Label</labeltag><itemtag attr=
25847 \begin_inset Quotes erd
25851 \begin_inset Quotes erd
25854 >Second item.</itemtag>
25857 \begin_layout LyX-Code
25863 \begin_layout Standard
25864 Note the different orders of
25865 \begin_inset Flex Code
25868 \begin_layout Plain Layout
25875 \begin_inset Flex Code
25878 \begin_layout Plain Layout
25885 Which order we get depends upon the setting of
25886 \begin_inset Flex Code
25889 \begin_layout Plain Layout
25896 \begin_inset Flex Code
25899 \begin_layout Plain Layout
25905 is false (the default), you get the first of these, with the label within
25906 the item; if true, you get the second, with the label outside the item.
25909 \begin_layout Standard
25910 The specific tags and attributes output for each paragraph type can be controlle
25911 d by means of the layout tags we are about to describe.
25912 As mentioned earlier, however, \SpecialChar LyX
25913 uses sensible defaults for many of these,
25914 so you often may not need to do very much to get good XHTML output.
25915 Think of the available tags as there so you can tweak things to your liking.
25918 \begin_layout Description
25919 \begin_inset Flex Code
25922 \begin_layout Plain Layout
25929 \begin_inset Flex Code
25932 \begin_layout Plain Layout
25938 ] Specifies attribute information to be output with the main tag.
25940 \begin_inset Quotes eld
25944 \begin_inset Flex Code
25947 \begin_layout Plain Layout
25954 \begin_inset Quotes erd
25958 By default, \SpecialChar LyX
25960 \begin_inset Quotes eld
25964 \begin_inset Flex Code
25967 \begin_layout Plain Layout
25974 \begin_inset Quotes erd
25978 \begin_inset Flex Code
25981 \begin_layout Plain Layout
25987 is the \SpecialChar LyX
25988 name of the layout, made lowercase, for example: chapter.
25993 contain any style information.
25995 \begin_inset Flex Code
25998 \begin_layout Plain Layout
26007 \begin_layout Description
26008 \begin_inset Flex Code
26011 \begin_layout Plain Layout
26018 \begin_inset Flex Code
26021 \begin_layout Plain Layout
26031 ] Whether to output the default CSS information \SpecialChar LyX
26032 generates for this layout,
26033 even if additional information is explicitly provided via
26034 \begin_inset Flex Code
26037 \begin_layout Plain Layout
26045 \begin_inset Flex Code
26048 \begin_layout Plain Layout
26054 allows you to alter or augment the generated CSS, rather than to override
26057 \begin_inset Flex Code
26060 \begin_layout Plain Layout
26069 \begin_layout Description
26070 \begin_inset Flex Code
26073 \begin_layout Plain Layout
26080 \begin_inset Flex Code
26083 \begin_layout Plain Layout
26089 ] The tag to be used for individual paragraphs of environments, replacing
26091 \begin_inset Flex Code
26094 \begin_layout Plain Layout
26100 in the examples above.
26102 \begin_inset Flex Code
26105 \begin_layout Plain Layout
26114 \begin_layout Description
26115 \begin_inset Flex Code
26118 \begin_layout Plain Layout
26125 \begin_inset Flex Code
26128 \begin_layout Plain Layout
26134 ] Attributes for the item tag.
26136 \begin_inset Newline newline
26140 \begin_inset Quotes eld
26144 \begin_inset Flex Code
26147 \begin_layout Plain Layout
26148 class=`layoutname_item'
26154 \begin_inset Quotes erd
26162 contain any style information.
26164 \begin_inset Flex Code
26167 \begin_layout Plain Layout
26176 \begin_layout Description
26177 \begin_inset Flex Code
26180 \begin_layout Plain Layout
26187 \begin_inset Flex Code
26190 \begin_layout Plain Layout
26196 ] The tag to be used for paragraph and item labels, replacing
26197 \begin_inset Flex Code
26200 \begin_layout Plain Layout
26206 in the examples above.
26208 \begin_inset Flex Code
26211 \begin_layout Plain Layout
26218 \begin_inset Flex Code
26221 \begin_layout Plain Layout
26228 \begin_inset Flex Code
26231 \begin_layout Plain Layout
26238 \begin_inset Flex Code
26241 \begin_layout Plain Layout
26242 Centered_Top_Environment
26247 , in which case it defaults to
26248 \begin_inset Flex Code
26251 \begin_layout Plain Layout
26260 \begin_layout Description
26261 \begin_inset Flex Code
26264 \begin_layout Plain Layout
26271 \begin_inset Flex Code
26274 \begin_layout Plain Layout
26280 ] Attributes for the label tag.
26282 \begin_inset Newline newline
26286 \begin_inset Quotes eld
26290 \begin_inset Flex Code
26293 \begin_layout Plain Layout
26294 class=`layoutname_label'
26300 \begin_inset Quotes erd
26308 contain any style information.
26310 \begin_inset Flex Code
26313 \begin_layout Plain Layout
26322 \begin_layout Description
26323 \begin_inset Flex Code
26326 \begin_layout Plain Layout
26333 \begin_inset Flex Code
26336 \begin_layout Plain Layout
26346 ] Meaningful only for list-like environments, this tag controls whether
26347 the label tag is output before or inside the item tag.
26348 This is used, for example, in the description environment, where we want
26350 \begin_inset Flex Code
26353 \begin_layout Plain Layout
26354 <dt>\SpecialChar ldots
26355 </dt><dd>\SpecialChar ldots
26363 \begin_inset Flex Code
26366 \begin_layout Plain Layout
26372 : The label tag is output inside the item tag.
26375 \begin_layout Description
26376 \begin_inset Flex Code
26379 \begin_layout Plain Layout
26385 Information to be output in the
26386 \begin_inset Flex Code
26389 \begin_layout Plain Layout
26395 section when this style is used.
26396 This might, for example, be used to include a
26397 \begin_inset Flex Code
26400 \begin_layout Plain Layout
26407 \begin_inset Flex Code
26410 \begin_layout Plain Layout
26419 \begin_layout Description
26420 \begin_inset Flex Code
26423 \begin_layout Plain Layout
26429 CSS style information to be included when this style is used.
26430 Note that this will automatically be wrapped in a layout-generated
26431 \begin_inset Flex Code
26434 \begin_layout Plain Layout
26440 block, so only the CSS itself need be included.
26442 \begin_inset Flex Code
26445 \begin_layout Plain Layout
26454 \begin_layout Description
26455 \begin_inset Flex Code
26458 \begin_layout Plain Layout
26465 \begin_inset Flex Code
26468 \begin_layout Plain Layout
26474 ] The tag to be used for the main label, replacing
26475 \begin_inset Flex Code
26478 \begin_layout Plain Layout
26484 in the examples above.
26486 \begin_inset Flex Code
26489 \begin_layout Plain Layout
26498 \begin_layout Description
26499 \begin_inset Flex Code
26502 \begin_layout Plain Layout
26509 \begin_inset Flex Code
26512 \begin_layout Plain Layout
26522 ] Marks this style as the one to be used to generate the
26523 \begin_inset Flex Code
26526 \begin_layout Plain Layout
26532 tag for the XHTML file.
26533 By default, it is false.
26535 \begin_inset Flex Code
26538 \begin_layout Plain Layout
26544 file sets it to true for the
26545 \begin_inset Flex Code
26548 \begin_layout Plain Layout
26558 \begin_layout Subsection
26562 \begin_layout Standard
26563 The XHTML output of insets can also be controlled by information in layout
26568 \begin_layout Plain Layout
26569 At present, this is true only for
26570 \begin_inset Quotes eld
26574 \begin_inset Quotes erd
26577 insets (insets you can type into) and is not true for
26578 \begin_inset Quotes eld
26582 \begin_inset Quotes erd
26585 insets (insets that are associated with dialog boxes).
26590 Here, too, \SpecialChar LyX
26591 tries to provide sensible defaults, and it constructs default
26593 But everything can be customized.
26596 \begin_layout Standard
26597 The XHTML \SpecialChar LyX
26598 outputs for an inset has the following form:
26601 \begin_layout LyX-Code
26603 \begin_inset Quotes erd
26607 \begin_inset Quotes erd
26613 \begin_layout LyX-Code
26614 <labeltag>Label</labeltag>
26617 \begin_layout LyX-Code
26619 \begin_inset Quotes erd
26623 \begin_inset Quotes erd
26626 >Contents of the inset.</innertag>
26629 \begin_layout LyX-Code
26633 \begin_layout Standard
26634 If the inset permits multiple paragraphs—that is, if
26635 \begin_inset Flex Code
26638 \begin_layout Plain Layout
26644 is true—then the contents of the inset will itself be output as paragraphs
26645 formatted according to the styles used for those paragraphs (standard,
26646 quote, and the like).
26647 The label tag is of course omitted if the paragraph does not have a label
26648 and, at present, is always
26649 \begin_inset Flex Code
26652 \begin_layout Plain Layout
26659 The inner tag is optional and, by default, does not appear.
26662 \begin_layout Standard
26663 The specific tags and attributes output for each inset can be controlled
26664 by means of the following layout tags.
26667 \begin_layout Description
26668 \begin_inset Flex Code
26671 \begin_layout Plain Layout
26678 \begin_inset Flex Code
26681 \begin_layout Plain Layout
26687 ] Specifies attribute information to be output with the main tag.
26689 \begin_inset Quotes eld
26693 \begin_inset Flex Code
26696 \begin_layout Plain Layout
26697 class=`myinset' onclick=`\SpecialChar ldots
26704 \begin_inset Quotes erd
26708 By default, \SpecialChar LyX
26710 \begin_inset Quotes eld
26714 \begin_inset Flex Code
26717 \begin_layout Plain Layout
26724 \begin_inset Quotes erd
26728 \begin_inset Flex Code
26731 \begin_layout Plain Layout
26737 is the \SpecialChar LyX
26738 name of the inset, made lowercase and with non-alphanumeric characters
26739 converted to underscores, for example: footnote.
26742 \begin_layout Description
26743 \begin_inset Flex Code
26746 \begin_layout Plain Layout
26753 \begin_inset Flex Code
26756 \begin_layout Plain Layout
26766 ] Whether to output the default CSS information \SpecialChar LyX
26767 generates for this layout,
26768 even if additional information is explicitly provided via
26769 \begin_inset Flex Code
26772 \begin_layout Plain Layout
26780 \begin_inset Flex Code
26783 \begin_layout Plain Layout
26789 allows you to alter or augment the generated CSS, rather than to override
26794 \begin_layout Description
26795 \begin_inset Flex Code
26798 \begin_layout Plain Layout
26805 \begin_inset Flex Code
26808 \begin_layout Plain Layout
26814 ] Attributes for the inner tag.
26816 \begin_inset Newline newline
26820 \begin_inset Quotes eld
26824 \begin_inset Flex Code
26827 \begin_layout Plain Layout
26828 class=`insetname_inner'
26834 \begin_inset Quotes erd
26840 \begin_layout Description
26841 \begin_inset Flex Code
26844 \begin_layout Plain Layout
26851 \begin_inset Flex Code
26854 \begin_layout Plain Layout
26860 ] The inner tag, replacing
26861 \begin_inset Flex Code
26864 \begin_layout Plain Layout
26870 in the examples above.
26871 By default, there is none.
26874 \begin_layout Description
26875 \begin_inset Flex Code
26878 \begin_layout Plain Layout
26885 \begin_inset Flex Code
26888 \begin_layout Plain Layout
26896 ] Whether this inset represents a standalone block of text (such as a footnote)
26897 or instead represents material that is included in the surrounding text
26898 (such as a branch).
26902 \begin_layout Description
26903 \begin_inset Flex Code
26906 \begin_layout Plain Layout
26913 \begin_inset Flex Code
26916 \begin_layout Plain Layout
26922 ] A label for this inset, possibly including a reference to a counter.
26923 For example, for footnote, it might be:
26924 \begin_inset Flex Code
26927 \begin_layout Plain Layout
26936 This is optional, and there is no default.
26939 \begin_layout Description
26940 \begin_inset Flex Code
26943 \begin_layout Plain Layout
26949 Information to be output in the
26950 \begin_inset Flex Code
26953 \begin_layout Plain Layout
26959 section when this style is used.
26960 This might, for example, be used to include a
26961 \begin_inset Flex Code
26964 \begin_layout Plain Layout
26971 \begin_inset Flex Code
26974 \begin_layout Plain Layout
26983 \begin_layout Description
26984 \begin_inset Flex Code
26987 \begin_layout Plain Layout
26993 CSS style information to be included when this style is used.
26994 Note that this will automatically be wrapped in a layout-generated
26995 \begin_inset Flex Code
26998 \begin_layout Plain Layout
27004 block, so only the CSS itself need be included.
27007 \begin_layout Description
27008 \begin_inset Flex Code
27011 \begin_layout Plain Layout
27018 \begin_inset Flex Code
27021 \begin_layout Plain Layout
27027 ] The tag to be used for the main label, replacing
27028 \begin_inset Flex Code
27031 \begin_layout Plain Layout
27037 in the examples above.
27038 The default depends upon the setting of
27039 \begin_inset Flex Code
27042 \begin_layout Plain Layout
27049 \begin_inset Flex Code
27052 \begin_layout Plain Layout
27058 is true, the default is
27059 \begin_inset Flex Code
27062 \begin_layout Plain Layout
27068 ; if it is false, the default is
27069 \begin_inset Flex Code
27072 \begin_layout Plain Layout
27081 \begin_layout Subsection
27085 \begin_layout Standard
27086 The XHTML output for floats too can be controlled by layout information.
27087 The output has the following form:
27090 \begin_layout LyX-Code
27092 \begin_inset Quotes erd
27096 \begin_inset Quotes erd
27102 \begin_layout LyX-Code
27103 Contents of the float.
27106 \begin_layout LyX-Code
27110 \begin_layout Standard
27111 The caption, if there is one, is a separate inset and will be output as
27113 Its appearance can be controlled via the InsetLayout for caption insets.
27117 \begin_layout Description
27118 \begin_inset Flex Code
27121 \begin_layout Plain Layout
27128 \begin_inset Flex Code
27131 \begin_layout Plain Layout
27137 ] Specifies attribute information to be output with the main tag.
27139 \begin_inset Quotes eld
27143 \begin_inset Flex Code
27146 \begin_layout Plain Layout
27147 class=`myfloat' onclick=`\SpecialChar ldots
27154 \begin_inset Quotes erd
27158 By default, \SpecialChar LyX
27160 \begin_inset Quotes eld
27164 \begin_inset Flex Code
27167 \begin_layout Plain Layout
27168 class=`float float-floattype'
27174 \begin_inset Quotes erd
27178 \begin_inset Flex Code
27181 \begin_layout Plain Layout
27187 is \SpecialChar LyX
27188 's name for this type of float, as determined by the float declaration
27190 \begin_inset CommandInset ref
27192 reference "subsec:Floats"
27196 ), though made lowercase and with non-alphanumeric characters converted
27197 to underscores, for example: float-table.
27200 \begin_layout Description
27201 \begin_inset Flex Code
27204 \begin_layout Plain Layout
27210 CSS style information to be included when this float is used.
27211 Note that this will automatically be wrapped in a layout-generated
27212 \begin_inset Flex Code
27215 \begin_layout Plain Layout
27221 block, so only the CSS itself need be included.
27224 \begin_layout Description
27225 \begin_inset Flex Code
27228 \begin_layout Plain Layout
27235 \begin_inset Flex Code
27238 \begin_layout Plain Layout
27244 ] The tag to be used for this float, replacing
27245 \begin_inset Quotes eld
27249 \begin_inset Flex Code
27252 \begin_layout Plain Layout
27259 \begin_inset Quotes erd
27262 in the example above.
27264 \begin_inset Flex Code
27267 \begin_layout Plain Layout
27273 and will rarely need changing.
27276 \begin_layout Subsection
27277 Bibliography formatting
27280 \begin_layout Standard
27281 The bibliography can be formatted using
27282 \begin_inset Flex Code
27285 \begin_layout Plain Layout
27293 \begin_inset CommandInset ref
27295 reference "subsec:Citation-format-description"
27302 \begin_layout Subsection
27307 \begin_layout Standard
27308 We have several times mentioned that \SpecialChar LyX
27309 will generate default CSS style rules
27310 for both insets and paragraph styles, based upon the other layout information
27312 In this section, we shall say a word about which layout information \SpecialChar LyX
27317 \begin_layout Standard
27318 At present, \SpecialChar LyX
27319 auto-generates CSS only for font information, making use of
27321 \begin_inset Flex Code
27324 \begin_layout Plain Layout
27331 \begin_inset Flex Code
27334 \begin_layout Plain Layout
27341 \begin_inset Flex Code
27344 \begin_layout Plain Layout
27351 \begin_inset Flex Code
27354 \begin_layout Plain Layout
27361 \begin_inset Flex Code
27364 \begin_layout Plain Layout
27371 \begin_inset CommandInset ref
27373 reference "subsec:Font-description"
27378 The translation is mostly straightforward and obvious.
27380 \begin_inset Quotes eld
27384 \begin_inset Flex Code
27387 \begin_layout Plain Layout
27394 \begin_inset Quotes erd
27398 \begin_inset Quotes eld
27402 \begin_inset Flex Code
27405 \begin_layout Plain Layout
27406 font-family: sans-serif;
27412 \begin_inset Quotes erd
27416 The correspondence of \SpecialChar LyX
27417 sizes and CSS sizes is a little less obvious but
27418 nonetheless intuitive.
27420 \begin_inset Flex Code
27423 \begin_layout Plain Layout
27430 \begin_inset Flex URL
27433 \begin_layout Plain Layout
27441 \change_inserted -970929547 1496610908
27445 \begin_layout Section
27447 \change_inserted -970929547 1496610966
27448 \begin_inset CommandInset label
27450 name "sec:Tags-for-DocBook"
27454 Tags for DocBook output
27457 \begin_layout Standard
27459 \change_inserted -970929547 1496611615
27460 As with \SpecialChar LaTeX
27461 or XHTML, the format of \SpecialChar LyX
27462 's DocBook output is also controlled by
27463 layout information.
27464 In general, \SpecialChar LyX
27465 provides sensible defaults; however, much of the styling is
27466 lost during the conversion, as DocBook is strictly semantic and does not
27468 When possible, information from \SpecialChar LyX
27469 will be rendered in
27477 \begin_layout Standard
27479 \change_inserted -970929547 1496612080
27480 In many cases, then, you may not have to do anything at all to get acceptable
27481 DocBook output for your own environments, custom insets, and so forth.
27482 But in some cases you will, and so \SpecialChar LyX
27483 provides a number of layout tags that
27484 can be used to customize the DocBook that is generated.
27487 \begin_layout Standard
27489 \change_inserted -970929547 1515109912
27490 Labels are rarely output, as they are redundant in DocBook: this information
27491 is carried by the tags themselves, and whether labels appear in the final
27492 documents (after processing of DocBook files) is controlled by the stylesheets.
27493 However, sometimes, labels are not redundant content, such as definition
27494 lists: in this case, the term being defined will be the label.
27498 \begin_layout Subsection
27500 \change_inserted 1075283030 1597699417
27501 \begin_inset CommandInset label
27503 name "subsec:Paragraph-Style-DocBook"
27508 \change_deleted 1075283030 1597699417
27510 \begin_inset CommandInset label
27512 name "subsec:Paragraph-Style-XHTML-1"
27517 \change_inserted -970929547 1496610966
27521 \begin_layout Standard
27523 \change_inserted -970929547 1496612059
27524 The sort of DocBook \SpecialChar LyX
27525 outputs for a paragraph depends upon whether we are
27526 dealing with a normal paragraph, a command, or an environment, where this
27527 is itself determined by the contents of the corresponding
27528 \begin_inset Flex Code
27531 \begin_layout Plain Layout
27533 \change_inserted -970929547 1496610966
27546 \begin_layout Standard
27548 \change_inserted -970929547 1496612107
27549 For a command or normal paragraph, the output DocBook has the following
27553 \begin_layout LyX-Code
27555 \change_inserted -970929547 1515109666
27559 \begin_layout LyX-Code
27561 \change_inserted -970929547 1496610966
27562 Contents of the paragraph.
27565 \begin_layout LyX-Code
27567 \change_inserted -970929547 1496610966
27571 \begin_layout Standard
27573 \change_inserted -970929547 1515109821
27574 For an environment that is not some sort of list, the generated DocBook
27578 \begin_layout LyX-Code
27580 \change_inserted -970929547 1515109671
27584 \begin_layout LyX-Code
27586 \change_inserted -970929547 1496612114
27587 <itemtag>First paragraph.</itemtag>
27590 \begin_layout LyX-Code
27592 \change_inserted -970929547 1496610966
27593 <itemtag>Second paragraph.</itemtag>
27596 \begin_layout LyX-Code
27598 \change_inserted -970929547 1496610966
27602 \begin_layout Standard
27604 \change_inserted -970929547 1515109825
27605 For a list, the resulting DocBook takes this form:
27608 \begin_layout LyX-Code
27610 \change_inserted -970929547 1515109672
27614 \begin_layout LyX-Code
27616 \change_inserted -970929547 1515109676
27617 <itemtag attr>First item.</itemtag>
27620 \begin_layout LyX-Code
27622 \change_inserted -970929547 1515109678
27623 <itemtag attr>Second item.</itemtag>
27626 \begin_layout LyX-Code
27628 \change_inserted -970929547 1496610966
27632 \begin_layout Standard
27634 \change_inserted -970929547 1496612243
27635 The specific tags and roles output for each paragraph type can be controlled
27636 by means of the layout tags we are about to describe.
27637 Please note that, due to the very nature of DocBook, no sensible defaults
27638 really exist, and the values must always be carefully chosen.
27642 \begin_layout Description
27644 \change_inserted -970929547 1515110057
27645 \begin_inset Flex Code
27648 \begin_layout Plain Layout
27650 \change_inserted -970929547 1515109656
27659 \begin_inset Flex Code
27662 \begin_layout Plain Layout
27664 \change_inserted -970929547 1496610966
27672 ] Specifies attribute information to be output with the main tag, replacing
27674 \begin_inset Quotes eld
27678 \begin_inset Flex Code
27681 \begin_layout Plain Layout
27683 \change_inserted -970929547 1515110057
27692 \begin_inset Quotes erd
27695 in the example above.
27696 This information can be used in further processing of the DocBook files.
27702 \begin_layout Description
27704 \change_inserted -970929547 1496612296
27705 \begin_inset Flex Code
27708 \begin_layout Plain Layout
27710 \change_inserted -970929547 1496612269
27719 \begin_inset Flex Code
27722 \begin_layout Plain Layout
27724 \change_inserted -970929547 1496610966
27732 ] The tag to be used for this inset, replacing
27733 \begin_inset Quotes eld
27737 \begin_inset Flex Code
27740 \begin_layout Plain Layout
27742 \change_inserted -970929547 1496612296
27751 \begin_inset Quotes erd
27754 in the example above.
27755 The default is the name of the float and always needs to be changed, as
27756 DocBook provides no generic tag.
27757 \change_inserted 1075283030 1597698868
27761 \begin_layout Description
27763 \change_inserted 1075283030 1597699399
27764 \begin_inset Flex Code
27767 \begin_layout Plain Layout
27769 \change_inserted 1075283030 1597698872
27778 \begin_inset Flex Code
27781 \begin_layout Plain Layout
27783 \change_inserted 1075283030 1597700585
27784 block, paragraph, inline
27791 ] The new-line policy for this tag, see Section
27792 \begin_inset space ~
27796 \begin_inset CommandInset ref
27798 reference "subsec:DocBook-New-line-policy"
27811 \begin_layout Subsection
27813 \change_inserted 1075283030 1597699385
27815 \begin_inset CommandInset label
27817 name "subsec:DocBook-New-line-policy"
27824 \begin_layout Standard
27826 \change_inserted 1075283030 1597698993
27827 For all tags, there are three possible policies for outputting new lines
27829 \begin_inset Flex Code
27832 \begin_layout Plain Layout
27834 \change_inserted 1075283030 1597698987
27845 \begin_layout Itemize
27847 \change_inserted 1075283030 1597699279
27848 \begin_inset Quotes eld
27852 \begin_inset Flex Code
27855 \begin_layout Plain Layout
27857 \change_inserted 1075283030 1597699012
27866 \begin_inset Quotes erd
27869 : the opening and closing tags are on their own lines (i.e.
27870 a line feed after and before the opening and the closing tags).
27871 Typical elements are floats.
27875 \begin_layout LyX-Code
27877 \change_inserted 1075283030 1597699194
27881 \begin_layout LyX-Code
27883 \change_inserted 1075283030 1597699194
27887 \begin_layout LyX-Code
27889 \change_inserted 1075283030 1597699098
27890 Contents of the block.
27893 \begin_layout LyX-Code
27895 \change_inserted 1075283030 1597699196
27899 \begin_layout LyX-Code
27901 \change_inserted 1075283030 1597699198
27905 \begin_layout Itemize
27907 \change_inserted 1075283030 1597699289
27908 \begin_inset Quotes eld
27912 \begin_inset Flex Code
27915 \begin_layout Plain Layout
27917 \change_inserted 1075283030 1597699113
27926 \begin_inset Quotes erd
27929 : the opening and closing tags are on the same, new line; a line feed is
27930 output before the opening tag and after the closing tag.
27931 Typical elements are paragraphs and list items.
27935 \begin_layout LyX-Code
27937 \change_inserted 1075283030 1597699186
27941 \begin_layout LyX-Code
27943 \change_inserted 1075283030 1597699357
27944 <paratag>Contents of the paragraph.</paratag>
27947 \begin_layout LyX-Code
27949 \change_inserted 1075283030 1597699231
27953 \begin_layout Itemize
27955 \change_inserted 1075283030 1597699343
27956 \begin_inset Quotes eld
27960 \begin_inset Flex Code
27963 \begin_layout Plain Layout
27965 \change_inserted 1075283030 1597699307
27974 \begin_inset Quotes erd
27977 : the opening and closing tags are on the same line as the rest of the content.
27978 No line feeds are output.
27979 Typical elements are fonts.
27983 \begin_layout LyX-Code
27985 \change_inserted 1075283030 1597699585
27986 Content before<inlinetag>Contents of the paragraph.</inlinetag>Content after
27989 \begin_layout Standard
27991 \change_inserted 1075283030 1597699585
27992 The default value is always
27993 \begin_inset Quotes eld
27997 \begin_inset Flex Code
28000 \begin_layout Plain Layout
28002 \change_inserted 1075283030 1597699585
28011 \begin_inset Quotes erd
28019 \begin_layout Subsection
28021 \change_inserted -970929547 1515111533
28022 InsetLayout DocBook
28027 \begin_layout Standard
28029 \change_inserted -970929547 1496611894
28030 The DocBook output of insets can also be controlled by information in layout
28034 \begin_layout Standard
28036 \change_inserted -970929547 1496612045
28037 The DocBook \SpecialChar LyX
28038 outputs for an inset has the following form:
28041 \begin_layout LyX-Code
28043 \change_inserted -970929547 1515110861
28044 <wrappertag wrapperattr>
28047 \begin_layout LyX-Code
28049 \change_inserted -970929547 1515110868
28053 \begin_layout LyX-Code
28055 \change_inserted -970929547 1515110869
28056 <innertag innerattr>
28059 \begin_layout LyX-Code
28061 \change_inserted -970929547 1515110869
28062 Contents of the inset.
28065 \begin_layout LyX-Code
28067 \change_inserted -970929547 1515110870
28071 \begin_layout LyX-Code
28073 \change_inserted -970929547 1515110871
28077 \begin_layout LyX-Code
28079 \change_inserted -970929547 1515111172
28083 \begin_layout Standard
28085 \change_inserted -970929547 1515111186
28086 For an itemising inset, it rather looks like this:
28089 \begin_layout LyX-Code
28091 \change_inserted -970929547 1515111186
28092 <wrappertag wrapperattr>
28095 \begin_layout LyX-Code
28097 \change_inserted -970929547 1515111186
28101 \begin_layout LyX-Code
28103 \change_inserted -970929547 1515111186
28104 <innertag innerattr>
28107 \begin_layout LyX-Code
28109 \change_inserted -970929547 1515111362
28110 <itemwrappertag itemwrapperattr>
28113 \begin_layout LyX-Code
28115 \change_inserted -970929547 1515111364
28116 <itemlabeltag itemattr>
28119 \begin_layout LyX-Code
28121 \change_inserted -970929547 1515111367
28122 Label of the first item.
28125 \begin_layout LyX-Code
28127 \change_inserted -970929547 1515111362
28133 \begin_layout LyX-Code
28135 \change_inserted -970929547 1515111517
28139 \begin_layout LyX-Code
28141 \change_inserted -970929547 1515111517
28147 \begin_layout LyX-Code
28149 \change_inserted -970929547 1515111516
28150 Contents of the first item.
28153 \begin_layout LyX-Code
28155 \change_inserted -970929547 1515111514
28161 \begin_layout LyX-Code
28163 \change_inserted -970929547 1515111247
28169 \begin_layout LyX-Code
28171 \change_inserted -970929547 1515111221
28175 \begin_layout LyX-Code
28177 \change_inserted -970929547 1515111370
28178 <itemwrappertag itemwrapperattr>
28181 \begin_layout LyX-Code
28183 \change_inserted -970929547 1515111370
28184 <itemlabeltag itemattr>
28187 \begin_layout LyX-Code
28189 \change_inserted -970929547 1515111372
28190 Label of the second item.
28193 \begin_layout LyX-Code
28195 \change_inserted -970929547 1515111370
28201 \begin_layout LyX-Code
28203 \change_inserted -970929547 1515111504
28207 \begin_layout LyX-Code
28209 \change_inserted -970929547 1515111505
28215 \begin_layout LyX-Code
28217 \change_inserted -970929547 1515111507
28218 Contents of the second item.
28221 \begin_layout LyX-Code
28223 \change_inserted -970929547 1515111509
28229 \begin_layout LyX-Code
28231 \change_inserted -970929547 1515111251
28237 \begin_layout LyX-Code
28239 \change_inserted -970929547 1515111221
28245 \begin_layout LyX-Code
28247 \change_inserted -970929547 1515111219
28253 \begin_layout LyX-Code
28255 \change_inserted -970929547 1515111186
28259 \begin_layout LyX-Code
28261 \change_inserted -970929547 1515111186
28265 \begin_layout LyX-Code
28267 \change_inserted -970929547 1515111186
28271 \begin_layout Standard
28273 \change_inserted -970929547 1515111183
28274 If the inset permits multiple paragraphs—that is, if
28275 \begin_inset Flex Code
28278 \begin_layout Plain Layout
28280 \change_inserted -970929547 1496610966
28288 is true—then the contents of the inset will itself be output as paragraphs
28289 formatted according to the styles used for those paragraphs (standard,
28290 quote, and the like).
28291 The inner tag is optional and, by default, does not appear.
28294 \begin_layout Standard
28296 \change_inserted -970929547 1496610966
28297 The specific tags and attributes output for each inset can be controlled
28298 by means of the following layout tags.
28301 \begin_layout Description
28303 \change_inserted -970929547 1515110317
28304 \begin_inset Flex Code
28307 \begin_layout Plain Layout
28309 \change_inserted -970929547 1515109695
28318 \begin_inset Flex Code
28321 \begin_layout Plain Layout
28323 \change_inserted -970929547 1496611854
28331 ] Specifies attribute information to be output with the main tag, replacing
28333 \begin_inset Quotes eld
28337 \begin_inset Flex Code
28340 \begin_layout Plain Layout
28342 \change_inserted -970929547 1515110044
28351 \begin_inset Quotes erd
28354 in the example above.
28355 This information can be used in further processing of the DocBook files.
28359 \begin_layout Description
28361 \change_inserted -970929547 1515110973
28362 \begin_inset Flex Code
28365 \begin_layout Plain Layout
28367 \change_inserted -970929547 1515110319
28376 \begin_inset Flex Code
28379 \begin_layout Plain Layout
28381 \change_inserted -970929547 1515110384
28382 never, always, maybe
28389 ] Specifies whether this tag goes into the
28390 \begin_inset Flex Code
28393 \begin_layout Plain Layout
28395 \change_inserted -970929547 1515110412
28403 tag at the beginning of the parent layout.
28405 \begin_inset Flex Code
28408 \begin_layout Plain Layout
28410 \change_inserted -970929547 1515110437
28418 indicates that the tag never goes into
28419 \begin_inset Flex Code
28422 \begin_layout Plain Layout
28424 \change_inserted -970929547 1515110497
28432 (this is default value, and corresponds to usual content).
28434 \begin_inset Flex Code
28437 \begin_layout Plain Layout
28439 \change_inserted -970929547 1515110517
28447 indicates that the tag always goes into
28448 \begin_inset Flex Code
28451 \begin_layout Plain Layout
28453 \change_inserted -970929547 1515110514
28461 (this corresponds to usual metadata): if there is no
28462 \begin_inset Flex Code
28465 \begin_layout Plain Layout
28467 \change_inserted -970929547 1515110550
28475 tag for the parent, one
28481 \begin_inset Flex Code
28484 \begin_layout Plain Layout
28486 \change_inserted -970929547 1515110540
28494 indicates that the tag may go into
28495 \begin_inset Flex Code
28498 \begin_layout Plain Layout
28500 \change_inserted -970929547 1515110538
28508 (this is only the case for titles): if there is no
28509 \begin_inset Flex Code
28512 \begin_layout Plain Layout
28514 \change_inserted -970929547 1515110585
28522 tag for the parent,
28526 will be generated, the corresponding tag will be output directly as content.
28530 \begin_layout Description
28532 \change_inserted -970929547 1515111461
28533 \begin_inset Flex Code
28536 \begin_layout Plain Layout
28538 \change_inserted -970929547 1515110974
28547 \begin_inset Flex Code
28550 \begin_layout Plain Layout
28552 \change_inserted -970929547 1515110973
28560 ] Specifies attribute information to be output with the item tag, replacing
28562 \begin_inset Quotes eld
28566 \begin_inset Flex Code
28569 \begin_layout Plain Layout
28571 \change_inserted -970929547 1515110984
28580 \begin_inset Quotes erd
28583 in the example above.
28584 This information can be used in further processing of the DocBook files.
28588 \begin_layout Description
28590 \change_inserted -970929547 1515111471
28591 \begin_inset Flex Code
28594 \begin_layout Plain Layout
28596 \change_inserted -970929547 1515111465
28597 DocBookItemInnerAttr
28605 \begin_inset Flex Code
28608 \begin_layout Plain Layout
28610 \change_inserted -970929547 1515111461
28618 ] Specifies attribute information to be output with the item inner tag,
28620 \begin_inset Quotes eld
28624 \begin_inset Flex Code
28627 \begin_layout Plain Layout
28629 \change_inserted -970929547 1515111476
28638 \begin_inset Quotes erd
28641 in the example above.
28642 This information can be used in further processing of the DocBook files.
28646 \begin_layout Description
28648 \change_inserted -970929547 1515111494
28649 \begin_inset Flex Code
28652 \begin_layout Plain Layout
28654 \change_inserted -970929547 1515111467
28655 DocBookItemInnerTag
28663 \begin_inset Flex Code
28666 \begin_layout Plain Layout
28668 \change_inserted -970929547 1515111461
28676 ] The tag to be used for the item inner tag within the inset, replacing
28678 \begin_inset Quotes eld
28682 \begin_inset Flex Code
28685 \begin_layout Plain Layout
28687 \change_inserted -970929547 1515111486
28696 \begin_inset Quotes erd
28699 in the example above.
28701 \begin_inset Flex Code
28704 \begin_layout Plain Layout
28706 \change_inserted -970929547 1515111461
28714 , indicating that there is no item inner tag: content is directly output
28715 without it for each itemised element.
28716 This parameter only makes sense when itemising layouts are used, such as
28719 \change_inserted 1075283030 1598469472
28720 The most likely value is
28721 \begin_inset Quotes eld
28725 \begin_inset Flex Code
28728 \begin_layout Plain Layout
28730 \change_inserted 1075283030 1598469476
28739 \begin_inset Quotes erd
28743 \begin_inset Newline newline
28746 When a list item is split using a new line, the item inner tag will be repeated
28747 for each part of the paragraph, parts being separated by new lines.
28751 \begin_layout Description
28753 \change_inserted 1075283030 1597699866
28754 \begin_inset Flex Code
28757 \begin_layout Plain Layout
28759 \change_inserted 1075283030 1597699853
28760 DocBookItemInnerTagType
28768 \begin_inset Flex Code
28771 \begin_layout Plain Layout
28773 \change_inserted 1075283030 1597699866
28774 block, paragraph, inline
28781 ] The new-line policy for this tag, see Section
28782 \begin_inset space ~
28786 \begin_inset CommandInset ref
28788 reference "subsec:DocBook-New-line-policy"
28801 \begin_layout Description
28803 \change_inserted -970929547 1515111290
28804 \begin_inset Flex Code
28807 \begin_layout Plain Layout
28809 \change_inserted -970929547 1515111283
28810 DocBookItemLabelAttr
28818 \begin_inset Flex Code
28821 \begin_layout Plain Layout
28823 \change_inserted -970929547 1515111279
28831 ] Specifies attribute information to be output with the item label tag,
28833 \begin_inset Quotes eld
28837 \begin_inset Flex Code
28840 \begin_layout Plain Layout
28842 \change_inserted -970929547 1515111304
28851 \begin_inset Quotes erd
28854 in the example above.
28855 This information can be used in further processing of the DocBook files.
28859 \begin_layout Description
28861 \change_inserted -970929547 1515111337
28862 \begin_inset Flex Code
28865 \begin_layout Plain Layout
28867 \change_inserted -970929547 1515111285
28868 DocBookItemLabelTag
28876 \begin_inset Flex Code
28879 \begin_layout Plain Layout
28881 \change_inserted -970929547 1515111279
28889 ] The tag to be used for the item label tag within the inset, replacing
28891 \begin_inset Quotes eld
28895 \begin_inset Flex Code
28898 \begin_layout Plain Layout
28900 \change_inserted -970929547 1515111311
28909 \begin_inset Quotes erd
28912 in the example above.
28913 This parameter only makes sense when itemising layouts are used with a
28914 notion of labels, such as definition lists.
28916 \change_inserted 1075283030 1597699874
28920 \begin_layout Description
28922 \change_inserted 1075283030 1597699874
28923 \begin_inset Flex Code
28926 \begin_layout Plain Layout
28928 \change_inserted 1075283030 1597699880
28929 DocBookItemLabelTagType
28937 \begin_inset Flex Code
28940 \begin_layout Plain Layout
28942 \change_inserted 1075283030 1597699874
28943 block, paragraph, inline
28950 ] The new-line policy for this tag, see Section
28951 \begin_inset space ~
28955 \begin_inset CommandInset ref
28957 reference "subsec:DocBook-New-line-policy"
28970 \begin_layout Description
28972 \change_inserted -970929547 1515111124
28973 \begin_inset Flex Code
28976 \begin_layout Plain Layout
28978 \change_inserted -970929547 1515111060
28987 \begin_inset Flex Code
28990 \begin_layout Plain Layout
28992 \change_inserted -970929547 1515111060
29000 ] The tag to be used for the item tag within the inset, replacing
29001 \begin_inset Quotes eld
29005 \begin_inset Flex Code
29008 \begin_layout Plain Layout
29010 \change_inserted -970929547 1515111060
29019 \begin_inset Quotes erd
29022 in the example above.
29024 \begin_inset Flex Code
29027 \begin_layout Plain Layout
29029 \change_inserted -970929547 1515111060
29037 , indicating that there is no item tag.
29038 This parameter only makes sense when itemising layouts are used, such as
29041 \change_inserted 1075283030 1597699890
29045 \begin_layout Description
29047 \change_inserted 1075283030 1597699890
29048 \begin_inset Flex Code
29051 \begin_layout Plain Layout
29053 \change_inserted 1075283030 1597699890
29062 \begin_inset Flex Code
29065 \begin_layout Plain Layout
29067 \change_inserted 1075283030 1597699890
29068 block, paragraph, inline
29075 ] The new-line policy for this tag, see Section
29076 \begin_inset space ~
29080 \begin_inset CommandInset ref
29082 reference "subsec:DocBook-New-line-policy"
29095 \begin_layout Description
29097 \change_inserted -970929547 1515111298
29098 \begin_inset Flex Code
29101 \begin_layout Plain Layout
29103 \change_inserted -970929547 1515111124
29104 DocBookItemWrapperAttr
29112 \begin_inset Flex Code
29115 \begin_layout Plain Layout
29117 \change_inserted -970929547 1515111124
29125 ] Specifies attribute information to be output with the item wrapper tag,
29127 \begin_inset Quotes eld
29131 \begin_inset Flex Code
29134 \begin_layout Plain Layout
29136 \change_inserted -970929547 1515111150
29145 \begin_inset Quotes erd
29148 in the example above.
29149 This information can be used in further processing of the DocBook files.
29155 \begin_layout Description
29157 \change_inserted -970929547 1515111113
29158 \begin_inset Flex Code
29161 \begin_layout Plain Layout
29163 \change_inserted -970929547 1515111073
29164 DocBookItemWrapperTag
29172 \begin_inset Flex Code
29175 \begin_layout Plain Layout
29177 \change_inserted -970929547 1515111073
29185 ] The tag to be used for the item wrapper tag within the inset, replacing
29187 \begin_inset Quotes eld
29191 \begin_inset Flex Code
29194 \begin_layout Plain Layout
29196 \change_inserted -970929547 1515111083
29205 \begin_inset Quotes erd
29208 in the example above.
29210 \begin_inset Flex Code
29213 \begin_layout Plain Layout
29215 \change_inserted -970929547 1515111073
29223 , indicating that there is no item wrapper tag: tag and content are directly
29224 output without it for each itemised element.
29225 This parameter only makes sense when itemising layouts are used, such as
29228 \change_inserted 1075283030 1597699897
29232 \begin_layout Description
29234 \change_inserted 1075283030 1597699897
29235 \begin_inset Flex Code
29238 \begin_layout Plain Layout
29240 \change_inserted 1075283030 1597699900
29241 DocBookItemWrapperTagType
29249 \begin_inset Flex Code
29252 \begin_layout Plain Layout
29254 \change_inserted 1075283030 1597699897
29255 block, paragraph, inline
29262 ] The new-line policy for this tag, see Section
29263 \begin_inset space ~
29267 \begin_inset CommandInset ref
29269 reference "subsec:DocBook-New-line-policy"
29282 \begin_layout Description
29284 \change_inserted -970929547 1515110104
29285 \begin_inset Flex Code
29288 \begin_layout Plain Layout
29290 \change_inserted -970929547 1515110104
29299 \begin_inset Flex Code
29302 \begin_layout Plain Layout
29304 \change_inserted -970929547 1515110104
29312 ] Specifies attribute information to be output with the inner tag, replacing
29314 \begin_inset Quotes eld
29318 \begin_inset Flex Code
29321 \begin_layout Plain Layout
29323 \change_inserted -970929547 1515110104
29332 \begin_inset Quotes erd
29335 in the example above.
29336 This information can be used in further processing of the DocBook files.
29340 \begin_layout Description
29342 \change_inserted -970929547 1515110906
29343 \begin_inset Flex Code
29346 \begin_layout Plain Layout
29348 \change_inserted -970929547 1515110104
29357 \begin_inset Flex Code
29360 \begin_layout Plain Layout
29362 \change_inserted -970929547 1515110104
29370 ] The tag to be used for the inner tag within the inset, replacing
29371 \begin_inset Quotes eld
29375 \begin_inset Flex Code
29378 \begin_layout Plain Layout
29380 \change_inserted -970929547 1515110104
29389 \begin_inset Quotes erd
29392 in the example above.
29394 \begin_inset Flex Code
29397 \begin_layout Plain Layout
29399 \change_inserted -970929547 1515110791
29407 , indicating that there is no inner tag: content is directly output without
29409 \change_inserted 1075283030 1597699904
29413 \begin_layout Description
29415 \change_inserted 1075283030 1597699904
29416 \begin_inset Flex Code
29419 \begin_layout Plain Layout
29421 \change_inserted 1075283030 1597699904
29422 DocBookInnerTagType
29430 \begin_inset Flex Code
29433 \begin_layout Plain Layout
29435 \change_inserted 1075283030 1597699904
29436 block, paragraph, inline
29443 ] The new-line policy for this tag, see Section
29444 \begin_inset space ~
29448 \begin_inset CommandInset ref
29450 reference "subsec:DocBook-New-line-policy"
29463 \begin_layout Description
29465 \change_inserted -970929547 1515110753
29466 \begin_inset Flex Code
29469 \begin_layout Plain Layout
29471 \change_inserted -970929547 1515110665
29480 \begin_inset Flex Code
29483 \begin_layout Plain Layout
29485 \change_inserted -970929547 1515110661
29493 ] Specifies the tag that corresponds to this kind of section.
29494 This parameter only makes sense for sectioning elements (part, chapter,
29496 The default value is
29497 \begin_inset Flex Code
29500 \begin_layout Plain Layout
29502 \change_inserted -970929547 1515110721
29510 , and is only overridden when DocBook uses something else for sectioning
29512 \change_inserted 1075283030 1597699921
29514 \change_inserted -970929547 1515110753
29515 parts and chapters of a book).
29521 \begin_layout Description
29523 \change_inserted -970929547 1515110811
29524 \begin_inset Flex Code
29527 \begin_layout Plain Layout
29529 \change_inserted -970929547 1496612023
29538 \begin_inset Flex Code
29541 \begin_layout Plain Layout
29543 \change_inserted -970929547 1496610966
29551 ] The tag to be used for this inset, replacing
29552 \begin_inset Quotes eld
29556 \begin_inset Flex Code
29559 \begin_layout Plain Layout
29561 \change_inserted -970929547 1496612033
29570 \begin_inset Quotes erd
29573 in the example above.
29574 The default is the name of the float and always needs to be changed, as
29575 DocBook provides no generic inset tag.
29576 \change_inserted 1075283030 1597699924
29580 \begin_layout Description
29582 \change_inserted 1075283030 1597699924
29583 \begin_inset Flex Code
29586 \begin_layout Plain Layout
29588 \change_inserted 1075283030 1597699924
29597 \begin_inset Flex Code
29600 \begin_layout Plain Layout
29602 \change_inserted 1075283030 1597699924
29603 block, paragraph, inline
29610 ] The new-line policy for this tag, see Section
29611 \begin_inset space ~
29615 \begin_inset CommandInset ref
29617 reference "subsec:DocBook-New-line-policy"
29630 \begin_layout Description
29632 \change_inserted -970929547 1515110832
29633 \begin_inset Flex Code
29636 \begin_layout Plain Layout
29638 \change_inserted -970929547 1515110822
29647 \begin_inset Flex Code
29650 \begin_layout Plain Layout
29652 \change_inserted -970929547 1515110811
29660 ] Specifies attribute information to be output with the outer tag, replacing
29662 \begin_inset Quotes eld
29666 \begin_inset Flex Code
29669 \begin_layout Plain Layout
29671 \change_inserted -970929547 1515110845
29680 \begin_inset Quotes erd
29683 in the example above.
29684 This information can be used in further processing of the DocBook files.
29688 \begin_layout Description
29690 \change_inserted -970929547 1515110917
29691 \begin_inset Flex Code
29694 \begin_layout Plain Layout
29696 \change_inserted -970929547 1515110826
29705 \begin_inset Flex Code
29708 \begin_layout Plain Layout
29710 \change_inserted -970929547 1515110811
29718 ] The tag to be used for the wrapper tag around the inset, replacing
29719 \begin_inset Quotes eld
29723 \begin_inset Flex Code
29726 \begin_layout Plain Layout
29728 \change_inserted -970929547 1515110842
29737 \begin_inset Quotes erd
29740 in the example above.
29742 \begin_inset Flex Code
29745 \begin_layout Plain Layout
29747 \change_inserted -970929547 1515110811
29755 , indicating that there is no wrapper tag: tag and content are directly
29757 \change_inserted 1075283030 1597699929
29761 \begin_layout Description
29763 \change_inserted 1075283030 1597699929
29764 \begin_inset Flex Code
29767 \begin_layout Plain Layout
29769 \change_inserted 1075283030 1597699932
29770 DocBookWrapperTagType
29778 \begin_inset Flex Code
29781 \begin_layout Plain Layout
29783 \change_inserted 1075283030 1597699929
29784 block, paragraph, inline
29791 ] The new-line policy for this tag, see Section
29792 \begin_inset space ~
29796 \begin_inset CommandInset ref
29798 reference "subsec:DocBook-New-line-policy"
29811 \begin_layout Subsection
29813 \change_inserted -970929547 1515110040
29817 \begin_layout Standard
29819 \change_inserted -970929547 1496611700
29820 The DocBook output for floats too can be controlled by layout information.
29821 The output has the following form:
29824 \begin_layout LyX-Code
29826 \change_inserted -970929547 1515109700
29830 \begin_layout LyX-Code
29832 \change_inserted -970929547 1515110138
29833 Contents of the float as DocBook.
29836 \begin_layout LyX-Code
29838 \change_inserted -970929547 1496610966
29842 \begin_layout Standard
29844 \change_inserted -970929547 1496611715
29845 The caption, if there is one, is a separate inset and will be output as
29850 \begin_layout Description
29852 \change_inserted -970929547 1515110033
29853 \begin_inset Flex Code
29856 \begin_layout Plain Layout
29858 \change_inserted -970929547 1515109702
29867 \begin_inset Flex Code
29870 \begin_layout Plain Layout
29872 \change_inserted -970929547 1496610966
29880 ] Specifies attribute information to be output with the main tag, replacing
29882 \begin_inset Quotes eld
29886 \begin_inset Flex Code
29889 \begin_layout Plain Layout
29891 \change_inserted -970929547 1515110035
29900 \begin_inset Quotes erd
29903 in the example above.
29904 This information can be used in further processing of the DocBook files.
29908 \begin_layout Description
29910 \change_inserted -970929547 1515110157
29911 \begin_inset Flex Code
29914 \begin_layout Plain Layout
29916 \change_inserted -970929547 1496611782
29925 \begin_inset Flex Code
29928 \begin_layout Plain Layout
29930 \change_inserted -970929547 1496610966
29938 ] The tag to be used for this float, replacing
29939 \begin_inset Quotes eld
29943 \begin_inset Flex Code
29946 \begin_layout Plain Layout
29948 \change_inserted -970929547 1496610966
29957 \begin_inset Quotes erd
29960 in the example above.
29961 The default is the name of the float and always needs to be changed, as
29962 DocBook provides no generic float tag.
29965 \begin_layout Subsection
29967 \change_inserted -970929547 1515110157
29968 Bibliography formatting
29971 \begin_layout Standard
29973 \change_deleted 1075283030 1597699984
29975 \change_inserted 1075283030 1597699985
29977 \change_inserted -970929547 1515110187
29979 \change_deleted 1075283030 1597699987
29981 \change_inserted 1075283030 1597699987
29983 \change_inserted -970929547 1515110187
29984 cannot be formatted: all fields are always output in the database-like
29985 DocBook format (equivalent to a BibTeX file)
29986 \change_inserted 1075283030 1597700117
29988 \begin_inset Flex Code
29991 \begin_layout Plain Layout
29993 \change_inserted 1075283030 1597700120
30002 \change_inserted -970929547 1515110187
30004 \change_inserted 1075283030 1597700092
30008 \begin_layout Standard
30010 \change_inserted 1075283030 1597700112
30011 When the bibliographic entries are manually inserted into the LyX document
30012 as Bibliography Items, the user deals with formatting themself: there is
30013 no attempt of parsing what the user wrote, the string is directly used
30015 \begin_inset Flex Code
30018 \begin_layout Plain Layout
30020 \change_inserted 1075283030 1597700076
30034 \begin_layout Chapter
30035 Including External Material
30036 \begin_inset CommandInset label
30038 name "chap:Including-External-Material"
30045 \begin_layout Standard
30046 \begin_inset Box Shadowbox
30056 height_special "totalheight"
30061 backgroundcolor "none"
30064 \begin_layout Plain Layout
30065 WARNING: This portion of the documentation has not been updated for some
30067 We certainly hope that it is still accurate, but there are no guarantees.
30075 \begin_layout Standard
30076 The use of material from sources external to \SpecialChar LyX
30077 is covered in detail in the
30083 This part of the manual covers what needs to happen behind the scenes for
30084 new sorts of material to be included.
30087 \begin_layout Section
30091 \begin_layout Standard
30092 The external material feature is based on the concept of a
30097 A template is a specification of how \SpecialChar LyX
30098 should interface with a certain kind
30100 As bundled, \SpecialChar LyX
30101 comes with predefined templates for Xfig figures, various
30102 raster format images, chess diagrams, and LilyPond music notation.
30103 You can check the actual list by using the menu
30104 \begin_inset Flex Noun
30107 \begin_layout Plain Layout
30108 Insert\SpecialChar menuseparator
30109 File\SpecialChar menuseparator
30116 Furthermore, it is possible to roll your own template to support a specific
30118 Later we'll describe in more detail what is involved, and hopefully you
30119 will submit all the templates you create so we can include them in a later
30124 \begin_layout Standard
30125 Another basic idea of the external material feature is to distinguish between
30126 the original file that serves as a base for final material and the produced
30127 file that is included in your exported or printed document.
30128 For example, consider the case of a figure produced with
30129 \begin_inset Flex Code
30132 \begin_layout Plain Layout
30139 The Xfig application itself works on an original file with the
30140 \begin_inset Flex Code
30143 \begin_layout Plain Layout
30150 Within Xfig, you create and change your figure, and when you are done,
30152 \begin_inset Flex Code
30155 \begin_layout Plain Layout
30162 When you want to include the figure in your document, you invoke
30163 \begin_inset Flex Code
30166 \begin_layout Plain Layout
30172 in order to create a PostScript file that can readily be included in your
30176 \begin_inset Flex Code
30179 \begin_layout Plain Layout
30185 file is the original file, and the PostScript file is the produced file.
30188 \begin_layout Standard
30189 This distinction is important in order to allow updating of the material
30190 while you are in the process of writing the document.
30191 Furthermore, it provides us with the flexibility that is needed to support
30192 multiple export formats.
30193 For instance, in the case of a plain text file, it is not exactly an award-winn
30194 ing idea to include the figure as raw PostScript.
30195 Instead, you would either prefer to just include a reference to the figure
30196 or try to invoke some graphics to ASCII converter to make the final result
30197 look similar to the real graphics.
30198 The external material management allows you to do this, because it is parametri
30199 zed on the different export formats that \SpecialChar LyX
30203 \begin_layout Standard
30204 Besides supporting the production of different products according to the
30205 exported format, it supports tight integration with editing and viewing
30207 In the case of an Xfig figure, you are able to invoke Xfig on the original
30208 file with a single click from within the external material dialog in \SpecialChar LyX
30210 and also preview the produced PostScript file with Ghostview with another
30212 No more fiddling around with the command line and/or file browsers to locate
30213 and manipulate the original or produced files.
30214 In this way, you are finally able to take full advantage of the many different
30215 applications that are relevant to use when you write your documents, and
30216 ultimately be more productive.
30219 \begin_layout Section
30220 The external template configuration files
30223 \begin_layout Standard
30224 It is relatively easy to add custom external template definitions to \SpecialChar LyX
30226 However, be aware that doing this in an careless manner most probably
30230 introduce an easily exploitable security hole.
30231 So before you do this, please read the discussion about security in
30232 \begin_inset CommandInset ref
30234 reference "sec:Security-discussion"
30241 \begin_layout Standard
30242 Having said that, we encourage you to submit any interesting templates that
30247 \begin_layout Standard
30248 The external templates are defined in the
30249 \begin_inset Flex Code
30252 \begin_layout Plain Layout
30258 files that are stored in the
30259 \begin_inset Flex Code
30262 \begin_layout Plain Layout
30263 LyXDir/lib/xtemplates/
30269 Each template is defined in a file of its own.
30270 You can place your own templates in
30271 \begin_inset Flex Code
30274 \begin_layout Plain Layout
30275 UserDir/xtemplates/
30280 or copy existing templates to that directory in order to modify them.
30283 \begin_layout Standard
30284 A typical template looks like this:
30287 \begin_layout LyX-Code
30291 \begin_layout LyX-Code
30292 GuiName "XFig: $$AbsOrRelPathParent$$Basename"
30295 \begin_layout LyX-Code
30299 \begin_layout LyX-Code
30303 \begin_layout LyX-Code
30307 \begin_layout LyX-Code
30311 \begin_layout LyX-Code
30315 \begin_layout LyX-Code
30316 AutomaticProduction true
30319 \begin_layout LyX-Code
30323 \begin_layout LyX-Code
30327 \begin_layout LyX-Code
30331 \begin_layout LyX-Code
30332 TransformCommand Rotate RotationLatexCommand
30335 \begin_layout LyX-Code
30336 TransformCommand Resize ResizeLatexCommand
30339 \begin_layout LyX-Code
30340 Product "$$RotateFront$$ResizeFront
30343 \begin_layout LyX-Code
30348 input{$$AbsOrRelPathMaster$$Basename.pstex_t}
30351 \begin_layout LyX-Code
30352 $$ResizeBack$$RotateBack"
30355 \begin_layout LyX-Code
30359 \begin_layout LyX-Code
30360 UpdateResult "$$AbsPath$$Basename.pstex_t"
30363 \begin_layout LyX-Code
30364 Requirement "graphicx"
30367 \begin_layout LyX-Code
30368 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
30371 \begin_layout LyX-Code
30372 ReferencedFile latex "$$AbsPath$$Basename.eps"
30375 \begin_layout LyX-Code
30376 ReferencedFile dvi "$$AbsPath$$Basename.eps"
30379 \begin_layout LyX-Code
30383 \begin_layout LyX-Code
30387 \begin_layout LyX-Code
30388 TransformCommand Rotate RotationLatexCommand
30391 \begin_layout LyX-Code
30392 TransformCommand Resize ResizeLatexCommand
30395 \begin_layout LyX-Code
30396 Product "$$RotateFront$$ResizeFront
30399 \begin_layout LyX-Code
30404 input{$$AbsOrRelPathMaster$$Basename.pdftex_t}
30407 \begin_layout LyX-Code
30408 $$ResizeBack$$RotateBack"
30411 \begin_layout LyX-Code
30412 UpdateFormat pdftex
30415 \begin_layout LyX-Code
30416 UpdateResult "$$AbsPath$$Basename.pdftex_t"
30419 \begin_layout LyX-Code
30420 Requirement "graphicx"
30423 \begin_layout LyX-Code
30424 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pdftex_t"
30427 \begin_layout LyX-Code
30428 ReferencedFile latex "$$AbsPath$$Basename.pdf"
30431 \begin_layout LyX-Code
30435 \begin_layout LyX-Code
30439 \begin_layout LyX-Code
30440 Product "[XFig: $$FName]"
30443 \begin_layout LyX-Code
30447 \begin_layout LyX-Code
30451 \begin_layout LyX-Code
30452 Product "<graphic fileref=
30454 "$$AbsOrRelPathMaster$$Basename.eps
30459 \begin_layout LyX-Code
30463 \begin_layout LyX-Code
30467 \begin_layout LyX-Code
30468 UpdateResult "$$AbsPath$$Basename.eps"
30471 \begin_layout LyX-Code
30472 ReferencedFile docbook "$$AbsPath$$Basename.eps"
30475 \begin_layout LyX-Code
30476 ReferencedFile docbook-xml "$$AbsPath$$Basename.eps"
30479 \begin_layout LyX-Code
30483 \begin_layout LyX-Code
30487 \begin_layout Standard
30488 As you can see, the template is enclosed in
30489 \begin_inset Flex Code
30492 \begin_layout Plain Layout
30500 \begin_inset Flex Code
30503 \begin_layout Plain Layout
30510 It contains a header specifying some general settings and, for each supported
30511 primary document file format, a section
30512 \begin_inset Flex Code
30515 \begin_layout Plain Layout
30523 \begin_inset Flex Code
30526 \begin_layout Plain Layout
30535 \begin_layout Subsection
30536 The template header
30539 \begin_layout Description
30540 \begin_inset Flex Code
30543 \begin_layout Plain Layout
30544 AutomaticProduction
30545 \begin_inset space ~
30553 Whether the file represented by the template must be generated by \SpecialChar LyX
30555 This command must occur exactly once.
30558 \begin_layout Description
30559 \begin_inset Flex Code
30562 \begin_layout Plain Layout
30564 \begin_inset space ~
30572 A glob pattern that is used in the file dialog to filter out the desired
30574 If there is more than one possible file extension (e.
30575 \begin_inset space \thinspace{}
30579 \begin_inset space \space{}
30583 \begin_inset Flex Code
30586 \begin_layout Plain Layout
30593 \begin_inset Flex Code
30596 \begin_layout Plain Layout
30602 ), use something like
30603 \begin_inset Flex Code
30606 \begin_layout Plain Layout
30613 This command must occur exactly once.
30616 \begin_layout Description
30617 \begin_inset Flex Code
30620 \begin_layout Plain Layout
30622 \begin_inset space ~
30630 The text that is displayed on the button.
30631 This command must occur exactly once.
30634 \begin_layout Description
30635 \begin_inset Flex Code
30638 \begin_layout Plain Layout
30640 \begin_inset space ~
30644 \begin_inset space ~
30652 The help text that is used in the External dialog.
30653 Provide enough information to explain to the user just what the template
30654 can provide him with.
30655 This command must occur exactly once.
30658 \begin_layout Description
30659 \begin_inset Flex Code
30662 \begin_layout Plain Layout
30664 \begin_inset space ~
30672 The file format of the original file.
30673 This must be the name of a format that is known to \SpecialChar LyX
30675 \begin_inset CommandInset ref
30677 reference "sec:Formats"
30683 \begin_inset Quotes eld
30687 \begin_inset Flex Code
30690 \begin_layout Plain Layout
30697 \begin_inset Quotes erd
30700 if the template can handle original files of more than one format.
30702 will attempt to interrogate the file itself in order to deduce its format
30704 This command must occur exactly once.
30707 \begin_layout Description
30708 \begin_inset Flex Code
30711 \begin_layout Plain Layout
30713 \begin_inset space ~
30721 A unique name for the template.
30722 It must not contain substitution macros (see below).
30725 \begin_layout Description
30726 \begin_inset Flex Code
30729 \begin_layout Plain Layout
30731 \begin_inset space ~
30734 Rotate|Resize|Clip|Extra
30739 This command specifies which transformations are supported by this template.
30740 It may occur zero or more times.
30741 This command enables the corresponding tabs in the external dialog.
30743 \begin_inset Flex Code
30746 \begin_layout Plain Layout
30752 command must have either a corresponding
30753 \begin_inset Flex Code
30756 \begin_layout Plain Layout
30763 \begin_inset Flex Code
30766 \begin_layout Plain Layout
30773 \begin_inset Flex Code
30776 \begin_layout Plain Layout
30783 Otherwise the transformation will not be supported by that format.
30786 \begin_layout Subsection
30790 \begin_layout Description
30791 \begin_inset Flex Code
30794 \begin_layout Plain Layout
30796 \begin_inset space ~
30799 LaTeX|PDFLaTeX|PlainText|DocBook|XHTML
30804 The primary document file format that this format definition is for.
30805 Not every template has a sensible representation in all document file formats.
30806 Please define nevertheless a
30807 \begin_inset Flex Code
30810 \begin_layout Plain Layout
30816 section for all templates.
30817 Use a dummy text when no representation is available.
30818 Then you can at least see a reference to the external material in the exported
30822 \begin_layout Description
30823 \begin_inset Flex Code
30826 \begin_layout Plain Layout
30828 \begin_inset space ~
30832 \begin_inset space ~
30840 This command defines an additional macro
30841 \begin_inset Flex Code
30844 \begin_layout Plain Layout
30850 for substitution in
30851 \begin_inset Flex Code
30854 \begin_layout Plain Layout
30862 \begin_inset Flex Code
30865 \begin_layout Plain Layout
30871 itself may contain substitution macros.
30872 The advantage over using
30873 \begin_inset Flex Code
30876 \begin_layout Plain Layout
30883 \begin_inset Flex Code
30886 \begin_layout Plain Layout
30892 is that the substituted value of
30893 \begin_inset Flex Code
30896 \begin_layout Plain Layout
30902 is sanitized so that it is a valid optional argument in the document format.
30903 This command may occur zero or more times.
30906 \begin_layout Description
30907 \begin_inset Flex Code
30910 \begin_layout Plain Layout
30912 \begin_inset space ~
30920 The text that is inserted in the exported document.
30921 This is actually the most important command and can be quite complex.
30922 This command must occur exactly once.
30925 \begin_layout Description
30926 \begin_inset Flex Code
30929 \begin_layout Plain Layout
30931 \begin_inset space ~
30939 This command specifies a preamble snippet that will be included in the
30942 It has to be defined using
30943 \begin_inset Flex Code
30946 \begin_layout Plain Layout
30954 \begin_inset Flex Code
30957 \begin_layout Plain Layout
30964 This command may occur zero or more times.
30967 \begin_layout Description
30968 \begin_inset Flex Code
30971 \begin_layout Plain Layout
30973 \begin_inset space ~
30977 \begin_inset space ~
30985 This command denotes files that are created by the conversion process and
30986 are needed for a particular export format.
30987 If the filename is relative, it is interpreted relative to the master document.
30988 This command may be given zero or more times.
30991 \begin_layout Description
30992 \begin_inset Flex Code
30995 \begin_layout Plain Layout
30997 \begin_inset space ~
31005 The name of a required \SpecialChar LaTeX
31007 The package is included via
31008 \begin_inset Flex Code
31011 \begin_layout Plain Layout
31019 in the \SpecialChar LaTeX
31021 This command may occur zero or more times.
31024 \begin_layout Description
31025 \begin_inset Flex Code
31028 \begin_layout Plain Layout
31030 \begin_inset space ~
31034 \begin_inset space ~
31037 RotationLatexCommand
31042 This command specifies that the built in \SpecialChar LaTeX
31043 command should be used for rotation.
31044 This command may occur once or not at all.
31047 \begin_layout Description
31048 \begin_inset Flex Code
31051 \begin_layout Plain Layout
31053 \begin_inset space ~
31057 \begin_inset space ~
31065 This command specifies that the built in \SpecialChar LaTeX
31066 command should be used for resizing.
31067 This command may occur once or not at all.
31070 \begin_layout Description
31071 \begin_inset Flex Code
31074 \begin_layout Plain Layout
31076 \begin_inset space ~
31080 \begin_inset space ~
31083 RotationLatexOption
31088 This command specifies that rotation is done via an optional argument.
31089 This command may occur once or not at all.
31092 \begin_layout Description
31093 \begin_inset Flex Code
31096 \begin_layout Plain Layout
31098 \begin_inset space ~
31102 \begin_inset space ~
31110 This command specifies that resizing is done via an optional argument.
31111 This command may occur once or not at all.
31114 \begin_layout Description
31115 \begin_inset Flex Code
31118 \begin_layout Plain Layout
31120 \begin_inset space ~
31124 \begin_inset space ~
31132 This command specifies that clipping is done via an optional argument.
31133 This command may occur once or not at all.
31136 \begin_layout Description
31137 \begin_inset Flex Code
31140 \begin_layout Plain Layout
31142 \begin_inset space ~
31146 \begin_inset space ~
31154 This command specifies that an extra optional argument is used.
31155 This command may occur once or not at all.
31158 \begin_layout Description
31159 \begin_inset Flex Code
31162 \begin_layout Plain Layout
31164 \begin_inset space ~
31172 The file format of the converted file.
31173 This must be the name of a format that is known to \SpecialChar LyX
31175 \begin_inset Flex Noun
31178 \begin_layout Plain Layout
31179 Tools\SpecialChar menuseparator
31180 Preferences\SpecialChar menuseparator
31181 File Handling\SpecialChar menuseparator
31188 This command must occur exactly once.
31189 If the resulting file format is PDF, you need to specify the format
31190 \begin_inset Flex Code
31193 \begin_layout Plain Layout
31200 This is the PDF format used for including graphics.
31201 The other defined PDF formats are for document export.
31204 \begin_layout Description
31205 \begin_inset Flex Code
31208 \begin_layout Plain Layout
31210 \begin_inset space ~
31218 The file name of the converted file.
31219 The file name must be absolute.
31220 This command must occur exactly once.
31223 \begin_layout Subsection
31224 Preamble definitions
31227 \begin_layout Standard
31228 The external template configuration file may contain additional preamble
31229 definitions enclosed by
31230 \begin_inset Flex Code
31233 \begin_layout Plain Layout
31241 \begin_inset Flex Code
31244 \begin_layout Plain Layout
31251 They can be used by the templates in the
31252 \begin_inset Flex Code
31255 \begin_layout Plain Layout
31264 \begin_layout Section
31265 The substitution mechanism
31268 \begin_layout Standard
31269 When the external material facility invokes an external program, it is done
31270 on the basis of a command defined in the template configuration file.
31271 These commands can contain various macros that are expanded before execution.
31272 Execution always take place in the directory of the containing document.
31275 \begin_layout Standard
31276 Also, whenever external material is to be displayed, the name will be produced
31277 by the substitution mechanism, and most other commands in the template
31278 definition support substitution as well.
31281 \begin_layout Standard
31282 The available macros are the following:
31285 \begin_layout Description
31286 \begin_inset Flex Code
31289 \begin_layout Plain Layout
31290 $$AbsOrRelPathMaster
31295 The file path, absolute or relative to the master \SpecialChar LyX
31299 \begin_layout Description
31300 \begin_inset Flex Code
31303 \begin_layout Plain Layout
31304 $$AbsOrRelPathParent
31309 The file path, absolute or relative to the \SpecialChar LyX
31313 \begin_layout Description
31314 \begin_inset Flex Code
31317 \begin_layout Plain Layout
31323 The absolute file path.
31326 \begin_layout Description
31327 \begin_inset Flex Code
31330 \begin_layout Plain Layout
31336 The filename without path and without the extension.
31339 \begin_layout Description
31340 \begin_inset Flex Code
31343 \begin_layout Plain Layout
31345 \begin_inset Quotes eld
31349 \begin_inset Quotes erd
31357 This macro will expand to the contents of the file with the name
31358 \begin_inset Flex Code
31361 \begin_layout Plain Layout
31370 \begin_layout Description
31371 \begin_inset Flex Code
31374 \begin_layout Plain Layout
31380 The file extension (including the dot).
31383 \begin_layout Description
31384 \begin_inset Flex Code
31387 \begin_layout Plain Layout
31393 This will be the string
31394 \begin_inset Quotes eld
31398 \begin_inset Quotes erd
31401 if the file is in JPEG format, otherwise it will be the string
31402 \begin_inset Quotes eld
31406 \begin_inset Quotes erd
31410 This is useful to avoid uneeded conversions for output formats that support
31411 both PNG and JPEG fomats.
31412 The predefined RasterImage template uses this macro for the pdf\SpecialChar TeX
31417 \begin_layout Description
31418 \begin_inset Flex Code
31421 \begin_layout Plain Layout
31427 The filename of the file specified in the external material dialog.
31428 This is either an absolute name, or it is relative to the \SpecialChar LyX
31432 \begin_layout Description
31433 \begin_inset Flex Code
31436 \begin_layout Plain Layout
31443 \begin_inset Flex Code
31446 \begin_layout Plain Layout
31452 (absolute name or relative to the \SpecialChar LyX
31456 \begin_layout Description
31457 \begin_inset Flex Code
31460 \begin_layout Plain Layout
31466 The file path, relative to the master \SpecialChar LyX
31470 \begin_layout Description
31471 \begin_inset Flex Code
31474 \begin_layout Plain Layout
31480 The file path, relative to the \SpecialChar LyX
31484 \begin_layout Description
31485 \begin_inset Flex Code
31488 \begin_layout Plain Layout
31494 This macro will expand to the absolute path of the system directory.
31495 This is typically used to point to the various helper scripts that are
31496 bundled with \SpecialChar LyX
31500 \begin_layout Description
31501 \begin_inset Flex Code
31504 \begin_layout Plain Layout
31510 A name and full path to a temporary file which will be automatically deleted
31511 whenever the containing document is closed, or the external material insertion
31515 \begin_layout Standard
31516 All path macros contain a trailing directory separator, so you can construct
31518 \begin_inset space \thinspace{}
31522 \begin_inset space \space{}
31525 the absolute filename with
31526 \begin_inset Flex Code
31529 \begin_layout Plain Layout
31530 $$AbsPath$$Basename$$Extension
31538 \begin_layout Standard
31539 The macros above are substituted in all commands unless otherwise noted.
31541 \begin_inset Flex Code
31544 \begin_layout Plain Layout
31550 supports additionally the following substitutions if they are enabled by
31552 \begin_inset Flex Code
31555 \begin_layout Plain Layout
31562 \begin_inset Flex Code
31565 \begin_layout Plain Layout
31574 \begin_layout Description
31575 \begin_inset Flex Code
31578 \begin_layout Plain Layout
31584 The front part of the resize command.
31587 \begin_layout Description
31588 \begin_inset Flex Code
31591 \begin_layout Plain Layout
31597 The back part of the resize command.
31600 \begin_layout Description
31601 \begin_inset Flex Code
31604 \begin_layout Plain Layout
31610 The front part of the rotation command.
31613 \begin_layout Description
31614 \begin_inset Flex Code
31617 \begin_layout Plain Layout
31623 The back part of the rotation command.
31626 \begin_layout Standard
31627 The value string of the
31628 \begin_inset Flex Code
31631 \begin_layout Plain Layout
31637 command supports additionally the following substitutions if they are enabled
31639 \begin_inset Flex Code
31642 \begin_layout Plain Layout
31649 \begin_inset Flex Code
31652 \begin_layout Plain Layout
31661 \begin_layout Description
31662 \begin_inset Flex Code
31665 \begin_layout Plain Layout
31674 \begin_layout Description
31675 \begin_inset Flex Code
31678 \begin_layout Plain Layout
31687 \begin_layout Description
31688 \begin_inset Flex Code
31691 \begin_layout Plain Layout
31700 \begin_layout Description
31701 \begin_inset Flex Code
31704 \begin_layout Plain Layout
31710 The rotation option.
31713 \begin_layout Standard
31714 You may ask why there are so many path macros.
31715 There are mainly two reasons:
31718 \begin_layout Enumerate
31719 Relative and absolute file names should remain relative or absolute, respectivel
31721 Users may have reasons to prefer either form.
31722 Relative names are useful for portable documents that should work on different
31723 machines, for example.
31724 Absolute names may be required by some programs.
31727 \begin_layout Enumerate
31729 treats relative file names differently than \SpecialChar LyX
31730 and other programs in nested
31732 For \SpecialChar LyX
31733 , a relative file name is always relative to the document that contains
31735 For \SpecialChar LaTeX
31736 , it is always relative to the master document.
31737 These two definitions are identical if you have only one document, but
31738 differ if you have a master document that includes part documents.
31739 That means that relative filenames must be transformed when presented to
31742 Fortunately \SpecialChar LyX
31743 does this automatically for you if you choose the right macros.
31746 \begin_layout Standard
31747 So which path macro should be used in new template definitions? The rule
31751 \begin_layout Itemize
31753 \begin_inset Flex Code
31756 \begin_layout Plain Layout
31762 if an absolute path is required.
31765 \begin_layout Itemize
31767 \begin_inset Flex Code
31770 \begin_layout Plain Layout
31771 $$AbsOrRelPathMaster
31776 if the substituted string is some kind of \SpecialChar LaTeX
31780 \begin_layout Itemize
31782 \begin_inset Flex Code
31785 \begin_layout Plain Layout
31786 $$AbsOrRelPathParent
31791 in order to preserve the user's choice.
31794 \begin_layout Standard
31795 There are special cases where this rule does not work and e.
31796 \begin_inset space \thinspace{}
31800 \begin_inset space \space{}
31803 relative names are needed, but normally it will work just fine.
31804 One example for such a case is the command
31805 \begin_inset Flex Code
31808 \begin_layout Plain Layout
31809 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
31814 in the XFig template above: We can't use the absolute name because the
31816 \begin_inset Flex Code
31819 \begin_layout Plain Layout
31825 files needs the relative name in order to rewrite the file content.
31828 \begin_layout Section
31829 Security discussion
31830 \begin_inset CommandInset label
31832 name "sec:Security-discussion"
31839 \begin_layout Standard
31840 The external material feature interfaces with a lot of external programs
31841 and does so automatically, so we have to consider the security implications
31843 In particular, since you have the option of including your own filenames
31844 and/or parameter strings and those are expanded into a command, it seems
31845 that it would be possible to create a malicious document which executes
31846 arbitrary commands when a user views or prints the document.
31847 This is something we definitely want to avoid.
31850 \begin_layout Standard
31851 However, since the external program commands are specified in the template
31852 configuration file only, there are no security issues if \SpecialChar LyX
31853 is properly configure
31854 d with safe templates only.
31855 This is so because the external programs are invoked with the
31856 \begin_inset Flex Code
31859 \begin_layout Plain Layout
31865 -system call rather than the
31866 \begin_inset Flex Code
31869 \begin_layout Plain Layout
31875 system-call, so it's not possible to execute arbitrary commands from the
31876 filename or parameter section via the shell.
31879 \begin_layout Standard
31880 This also implies that you are restricted in what command strings you can
31881 use in the external material templates.
31882 In particular, pipes and redirection are not readily available.
31883 This has to be so if \SpecialChar LyX
31884 should remain safe.
31885 If you want to use some of the shell features, you should write a safe
31886 script to do this in a controlled manner, and then invoke the script from
31887 the command string.
31891 \begin_layout Standard
31892 It is possible to design a template that interacts directly with the shell,
31893 but since this would allow a malicious user to execute arbitrary commands
31894 by writing clever filenames and/or parameters, we generally recommend that
31895 you only use safe scripts that work with the
31896 \begin_inset Flex Code
31899 \begin_layout Plain Layout
31905 system call in a controlled manner.
31906 Of course, for use in a controlled environment, it can be tempting to just
31907 fall back to use ordinary shell scripts.
31908 If you do so, be aware that you
31912 provide an easily exploitable security hole in your system.
31913 Of course it stands to reason that such unsafe templates will never be
31914 included in the standard \SpecialChar LyX
31915 distribution, although we do encourage people
31916 to submit new templates in the open source tradition.
31917 But \SpecialChar LyX
31918 as shipped from the official distribution channels will never have
31922 \begin_layout Standard
31923 Including external material provides a lot of power, and you have to be
31924 careful not to introduce security hazards with this power.
31925 A subtle error in a single line in an innocent looking script can open
31926 the door to huge security problems.
31927 So if you do not fully understand the issues, we recommend that you consult
31928 a knowledgeable security professional or the \SpecialChar LyX
31929 development team if you have
31930 any questions about whether a given template is safe or not.
31931 And do this before you use it in an uncontrolled environment.
31934 \begin_layout Chapter
31936 List of supported \SpecialChar LyX
31937 functions to be used in layouts
31938 \begin_inset CommandInset label
31940 name "chap:List-of-functions"
31947 \begin_layout Standard
31949 \begin_inset Tabular
31950 <lyxtabular version="3" rows="11" columns="8">
31951 <features tabularvalignment="middle">
31952 <column alignment="left" valignment="top">
31953 <column alignment="left" valignment="top">
31954 <column alignment="left" valignment="top">
31955 <column alignment="left" valignment="top">
31956 <column alignment="left" valignment="top">
31957 <column alignment="left" valignment="top">
31958 <column alignment="left" valignment="top">
31959 <column alignment="left" valignment="top">
31961 <cell alignment="left" valignment="top" usebox="none">
31964 \begin_layout Plain Layout
31970 <cell alignment="left" valignment="top" usebox="none">
31973 \begin_layout Plain Layout
31979 <cell alignment="left" valignment="top" usebox="none">
31982 \begin_layout Plain Layout
31988 <cell alignment="left" valignment="top" usebox="none">
31991 \begin_layout Plain Layout
31997 <cell alignment="center" valignment="top" usebox="none">
32000 \begin_layout Plain Layout
32006 <cell alignment="center" valignment="top" usebox="none">
32009 \begin_layout Plain Layout
32015 <cell alignment="center" valignment="top" usebox="none">
32018 \begin_layout Plain Layout
32024 <cell alignment="center" valignment="top" usebox="none">
32027 \begin_layout Plain Layout
32035 <cell alignment="left" valignment="top" usebox="none">
32038 \begin_layout Plain Layout
32044 <cell alignment="left" valignment="top" usebox="none">
32047 \begin_layout Plain Layout
32053 <cell alignment="left" valignment="top" usebox="none">
32056 \begin_layout Plain Layout
32062 <cell alignment="left" valignment="top" usebox="none">
32065 \begin_layout Plain Layout
32071 <cell alignment="center" valignment="top" usebox="none">
32074 \begin_layout Plain Layout
32080 <cell alignment="center" valignment="top" usebox="none">
32083 \begin_layout Plain Layout
32089 <cell alignment="center" valignment="top" usebox="none">
32092 \begin_layout Plain Layout
32098 <cell alignment="center" valignment="top" usebox="none">
32101 \begin_layout Plain Layout
32109 <cell alignment="left" valignment="top" usebox="none">
32112 \begin_layout Plain Layout
32118 <cell alignment="left" valignment="top" usebox="none">
32121 \begin_layout Plain Layout
32127 <cell alignment="left" valignment="top" usebox="none">
32130 \begin_layout Plain Layout
32136 <cell alignment="left" valignment="top" usebox="none">
32139 \begin_layout Plain Layout
32145 <cell alignment="center" valignment="top" usebox="none">
32148 \begin_layout Plain Layout
32154 <cell alignment="center" valignment="top" usebox="none">
32157 \begin_layout Plain Layout
32163 <cell alignment="center" valignment="top" usebox="none">
32166 \begin_layout Plain Layout
32172 <cell alignment="center" valignment="top" usebox="none">
32175 \begin_layout Plain Layout
32183 <cell alignment="left" valignment="top" usebox="none">
32186 \begin_layout Plain Layout
32192 <cell alignment="left" valignment="top" usebox="none">
32195 \begin_layout Plain Layout
32201 <cell alignment="left" valignment="top" usebox="none">
32204 \begin_layout Plain Layout
32210 <cell alignment="left" valignment="top" usebox="none">
32213 \begin_layout Plain Layout
32219 <cell alignment="center" valignment="top" usebox="none">
32222 \begin_layout Plain Layout
32228 <cell alignment="center" valignment="top" usebox="none">
32231 \begin_layout Plain Layout
32237 <cell alignment="center" valignment="top" usebox="none">
32240 \begin_layout Plain Layout
32246 <cell alignment="center" valignment="top" usebox="none">
32249 \begin_layout Plain Layout
32257 <cell alignment="left" valignment="top" usebox="none">
32260 \begin_layout Plain Layout
32266 <cell alignment="left" valignment="top" usebox="none">
32269 \begin_layout Plain Layout
32275 <cell alignment="left" valignment="top" usebox="none">
32278 \begin_layout Plain Layout
32284 <cell alignment="left" valignment="top" usebox="none">
32287 \begin_layout Plain Layout
32293 <cell alignment="center" valignment="top" usebox="none">
32296 \begin_layout Plain Layout
32302 <cell alignment="center" valignment="top" usebox="none">
32305 \begin_layout Plain Layout
32311 <cell alignment="center" valignment="top" usebox="none">
32314 \begin_layout Plain Layout
32320 <cell alignment="center" valignment="top" usebox="none">
32323 \begin_layout Plain Layout
32331 <cell alignment="left" valignment="top" usebox="none">
32334 \begin_layout Plain Layout
32340 <cell alignment="left" valignment="top" usebox="none">
32343 \begin_layout Plain Layout
32349 <cell alignment="left" valignment="top" usebox="none">
32352 \begin_layout Plain Layout
32358 <cell alignment="left" valignment="top" usebox="none">
32361 \begin_layout Plain Layout
32367 <cell alignment="center" valignment="top" usebox="none">
32370 \begin_layout Plain Layout
32376 <cell alignment="center" valignment="top" usebox="none">
32379 \begin_layout Plain Layout
32385 <cell alignment="center" valignment="top" usebox="none">
32388 \begin_layout Plain Layout
32394 <cell alignment="center" valignment="top" usebox="none">
32397 \begin_layout Plain Layout
32405 <cell alignment="left" valignment="top" usebox="none">
32408 \begin_layout Plain Layout
32414 <cell alignment="left" valignment="top" usebox="none">
32417 \begin_layout Plain Layout
32423 <cell alignment="left" valignment="top" usebox="none">
32426 \begin_layout Plain Layout
32432 <cell alignment="left" valignment="top" usebox="none">
32435 \begin_layout Plain Layout
32441 <cell alignment="center" valignment="top" usebox="none">
32444 \begin_layout Plain Layout
32450 <cell alignment="center" valignment="top" usebox="none">
32453 \begin_layout Plain Layout
32459 <cell alignment="center" valignment="top" usebox="none">
32462 \begin_layout Plain Layout
32468 <cell alignment="center" valignment="top" usebox="none">
32471 \begin_layout Plain Layout
32479 <cell alignment="left" valignment="top" usebox="none">
32482 \begin_layout Plain Layout
32488 <cell alignment="left" valignment="top" usebox="none">
32491 \begin_layout Plain Layout
32497 <cell alignment="left" valignment="top" usebox="none">
32500 \begin_layout Plain Layout
32506 <cell alignment="left" valignment="top" usebox="none">
32509 \begin_layout Plain Layout
32515 <cell alignment="center" valignment="top" usebox="none">
32518 \begin_layout Plain Layout
32524 <cell alignment="center" valignment="top" usebox="none">
32527 \begin_layout Plain Layout
32533 <cell alignment="center" valignment="top" usebox="none">
32536 \begin_layout Plain Layout
32542 <cell alignment="center" valignment="top" usebox="none">
32545 \begin_layout Plain Layout
32553 <cell alignment="left" valignment="top" usebox="none">
32556 \begin_layout Plain Layout
32562 <cell alignment="left" valignment="top" usebox="none">
32565 \begin_layout Plain Layout
32571 <cell alignment="left" valignment="top" usebox="none">
32574 \begin_layout Plain Layout
32580 <cell alignment="left" valignment="top" usebox="none">
32583 \begin_layout Plain Layout
32589 <cell alignment="center" valignment="top" usebox="none">
32592 \begin_layout Plain Layout
32598 <cell alignment="center" valignment="top" usebox="none">
32601 \begin_layout Plain Layout
32607 <cell alignment="center" valignment="top" usebox="none">
32610 \begin_layout Plain Layout
32616 <cell alignment="center" valignment="top" usebox="none">
32619 \begin_layout Plain Layout
32627 <cell alignment="left" valignment="top" usebox="none">
32630 \begin_layout Plain Layout
32636 <cell alignment="left" valignment="top" usebox="none">
32639 \begin_layout Plain Layout
32645 <cell alignment="left" valignment="top" usebox="none">
32648 \begin_layout Plain Layout
32654 <cell alignment="left" valignment="top" usebox="none">
32657 \begin_layout Plain Layout
32663 <cell alignment="center" valignment="top" usebox="none">
32666 \begin_layout Plain Layout
32672 <cell alignment="center" valignment="top" usebox="none">
32675 \begin_layout Plain Layout
32681 <cell alignment="center" valignment="top" usebox="none">
32684 \begin_layout Plain Layout
32690 <cell alignment="center" valignment="top" usebox="none">
32693 \begin_layout Plain Layout
32701 <cell alignment="center" valignment="top" usebox="none">
32704 \begin_layout Plain Layout
32710 <cell alignment="center" valignment="top" usebox="none">
32713 \begin_layout Plain Layout
32719 <cell alignment="center" valignment="top" usebox="none">
32722 \begin_layout Plain Layout
32728 <cell alignment="center" valignment="top" usebox="none">
32731 \begin_layout Plain Layout
32737 <cell alignment="center" valignment="top" usebox="none">
32740 \begin_layout Plain Layout
32746 <cell alignment="center" valignment="top" usebox="none">
32749 \begin_layout Plain Layout
32755 <cell alignment="center" valignment="top" usebox="none">
32758 \begin_layout Plain Layout
32764 <cell alignment="center" valignment="top" usebox="none">
32767 \begin_layout Plain Layout
32781 \begin_layout Chapter
32782 Names of available colors to be used in layouts
32783 \begin_inset CommandInset label
32785 name "chap:Names-of-colors"
32792 \begin_layout Standard
32793 The colors listed below are the standard colors and those that you can adjust
32794 in the \SpecialChar LyX
32798 \begin_layout Section
32802 \begin_layout Standard
32803 The following are no real colors, but rather act on color definitions:
32806 \begin_layout Description
32807 ignore The color is ignored
32810 \begin_layout Description
32811 inherit The color is inherited
32814 \begin_layout Description
32827 No particular color – clear or default
32830 \begin_layout Section
32834 \begin_layout Standard
32835 These are fixed colors that cannot be customized:
32838 \begin_layout Description
32842 \begin_layout Description
32846 \begin_layout Description
32850 \begin_layout Description
32854 \begin_layout Description
32858 \begin_layout Description
32862 \begin_layout Description
32866 \begin_layout Description
32870 \begin_layout Description
32874 \begin_layout Description
32878 \begin_layout Description
32882 \begin_layout Description
32886 \begin_layout Description
32890 \begin_layout Description
32894 \begin_layout Description
32898 \begin_layout Description
32902 \begin_layout Description
32906 \begin_layout Description
32910 \begin_layout Description
32914 \begin_layout Section
32918 \begin_layout Standard
32919 These are the colors allocated to specific elements in
32922 arg "dialog-show prefs"
32928 \begin_layout Description
32929 added_space Added space color
32932 \begin_layout Description
32933 addedtext Added text color
32936 \begin_layout Description
32937 appendix Appendix marker color
32940 \begin_layout Description
32941 background Background color
32944 \begin_layout Description
32945 bottomarea Bottom area color
32948 \begin_layout Description
32949 branchlabel Label color for branches
32952 \begin_layout Description
32953 buttonbg Color used for button background
32956 \begin_layout Description
32957 buttonframe Color for inset button frames
32960 \begin_layout Description
32961 buttonhoverbg Color used for button background under focus
32964 \begin_layout Description
32965 changebar Changebar color
32968 \begin_layout Description
32969 changedtextauthor1 Changed text color author 1
32972 \begin_layout Description
32973 changedtextauthor2 Changed text color author 2
32976 \begin_layout Description
32977 changedtextauthor3 Changed text color author 3
32980 \begin_layout Description
32981 changedtextauthor4 Changed text color author 4
32984 \begin_layout Description
32985 changedtextauthor5 Changed text color author 5
32988 \begin_layout Description
32989 collapsible Collapsible insets text color
32992 \begin_layout Description
32993 collapsibleframe Collapsible insets framecolor
32996 \begin_layout Description
32997 command Text color for command insets
33000 \begin_layout Description
33001 commandbg Background color for command insets
33004 \begin_layout Description
33005 commandframe Frame color for command insets
33008 \begin_layout Description
33009 comment Label color for comments
33012 \begin_layout Description
33013 commentbg Background color of comments
33016 \begin_layout Description
33017 cursor Cursor color
33020 \begin_layout Description
33021 deletedtext Deleted text color
33024 \begin_layout Description
33025 deletedtextmodifier Deleted text modifying color
33028 \begin_layout Description
33029 depthbar Color for the depth bars in the margin
33032 \begin_layout Description
33033 eolmarker End of line marker color
33036 \begin_layout Description
33037 error Color of the \SpecialChar LaTeX
33041 \begin_layout Description
33042 footlabel Label color for footnotes
33045 \begin_layout Description
33046 foreground Foreground color
33049 \begin_layout Description
33050 graphicsbg Graphics inset background color
33053 \begin_layout Description
33054 greyedoutbg Background color of greyedout inset
33057 \begin_layout Description
33058 greyedoutlabel Label color for greyedout insets
33061 \begin_layout Description
33062 greyedouttext Color for greyedout inset text
33065 \begin_layout Description
33066 indexlabel Label color for index insets
33069 \begin_layout Description
33070 inlinecompletion Inline completion color
33073 \begin_layout Description
33074 insetbg Inset marker background color
33077 \begin_layout Description
33078 insetframe Inset marker frame color
33081 \begin_layout Description
33082 language Color for marking foreign language words
33085 \begin_layout Description
33086 latex Text color in \SpecialChar LaTeX
33090 \begin_layout Description
33091 listingsbg Background color of listings inset
33094 \begin_layout Description
33095 marginlabel Label color for margin notes
33098 \begin_layout Description
33099 math Math inset text color
33102 \begin_layout Description
33103 mathbg Math inset background color
33106 \begin_layout Description
33107 mathcorners Math inset frame color not under focus
33110 \begin_layout Description
33111 mathframe Math inset frame color under focus
33114 \begin_layout Description
33115 mathline Math line color
33118 \begin_layout Description
33119 mathmacrobg Macro math inset background color
33122 \begin_layout Description
33123 mathmacroblend Macro math blended color
33126 \begin_layout Description
33127 mathmacroframe Macro math frame color
33130 \begin_layout Description
33131 mathmacrohoverbg Macro math inset background color hovered
33134 \begin_layout Description
33135 mathmacrolabel Macro math label color
33138 \begin_layout Description
33139 mathmacronewarg Macro template color for new parameters
33142 \begin_layout Description
33143 mathmacrooldarg Macro template color for old parameters
33146 \begin_layout Description
33147 newpage New page color
33150 \begin_layout Description
33151 nonunique_inlinecompletion Inline completion color for the non-unique part
33154 \begin_layout Description
33155 note Label color for notes
33158 \begin_layout Description
33159 notebg Background color of notes
33162 \begin_layout Description
33163 pagebreak Page break/line break color
33166 \begin_layout Description
33167 paragraphmarker Color used for the pilcrow sign to mark the end of a paragraph
33170 \begin_layout Description
33171 phantomtext Text color for phantom insets
33174 \begin_layout Description
33175 preview The color used for previews
33178 \begin_layout Description
33179 previewframe Preview frame color
33182 \begin_layout Description
33183 regexpframe Color for regexp frame
33186 \begin_layout Description
33187 scroll Color that indicates when a row can be scrolled
33190 \begin_layout Description
33191 selection Background color of selected text
33194 \begin_layout Description
33195 selectiontext Foreground color of selected text
33198 \begin_layout Description
33199 shadedbg Background color of shaded box
33202 \begin_layout Description
33203 special Special chars text color
33206 \begin_layout Description
33207 tabularline Table line color
33210 \begin_layout Description
33211 tabularonoffline Table line color
33214 \begin_layout Description
33215 urllabel Label color for URL insets
33218 \begin_layout Description
33219 urltext Color for URL inset text