1 #LyX 2.4 created this file. For more info see https://www.lyx.org/
5 \save_transient_properties true
6 \origin /systemlyxdir/doc/
9 % DO NOT ALTER THIS PREAMBLE!!!
11 % This preamble is designed to ensure that this document prints
12 % out as advertised. If you mess with this preamble,
13 % parts of this document may not print out as expected. If you
14 % have problems LaTeXing this file, please contact
15 % the documentation team
16 % email: lyx-docs@lists.lyx.org
18 % the pages of the TOC is numbered roman
19 % and a pdf-bookmark for the TOC is added
20 \let\myTOC\tableofcontents
21 \renewcommand\tableofcontents{%
23 \pdfbookmark[1]{\contentsname}{}
27 % increase link area for cross-references and autoname them,
28 \AtBeginDocument{\renewcommand{\ref}[1]{\mbox{\autoref{#1}}}}
29 \@ifundefined{extrasenglish}{\usepackage[english]{babel}}{}
30 \@ifpackageloaded{babel}{
31 \addto\extrasenglish{%
32 \renewcommand*{\equationautorefname}[1]{}%
33 \renewcommand{\sectionautorefname}{sec.\negthinspace}%
34 \renewcommand{\subsectionautorefname}{sec.\negthinspace}%
35 \renewcommand{\subsubsectionautorefname}{sec.\negthinspace}%
39 \options bibliography=totoc,index=totoc,BCOR7.5mm,titlepage,captions=tableheading
40 \use_default_options false
44 \maintain_unincluded_children no
46 \language_package default
49 \font_roman "lmodern" "default"
50 \font_sans "lmss" "default"
51 \font_typewriter "lmtt" "default"
52 \font_math "auto" "auto"
53 \font_default_family default
54 \use_non_tex_fonts false
58 \font_typewriter_osf false
59 \font_sf_scale 100 100
60 \font_tt_scale 100 100
62 \use_dash_ligatures true
64 \default_output_format pdf2
66 \bibtex_command default
67 \index_command default
71 \pdf_title "LyX Configuration Manual"
72 \pdf_author "LyX Team"
73 \pdf_subject "LyX-documentation Customization"
74 \pdf_keywords "LyX, documentation, customization"
76 \pdf_bookmarksnumbered true
77 \pdf_bookmarksopen true
78 \pdf_bookmarksopenlevel 1
83 \pdf_pdfusetitle false
84 \pdf_quoted_options "linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue,pdfpagelayout=OneColumn, pdfnewwindow=true, pdfstartview=XYZ, plainpages=false"
87 \use_package amsmath 1
88 \use_package amssymb 1
91 \use_package mathdots 1
92 \use_package mathtools 1
94 \use_package stackrel 1
95 \use_package stmaryrd 1
96 \use_package undertilde 1
98 \cite_engine_type default
102 \paperorientation portrait
108 \notefontcolor #0000ff
112 \color #f5fae7 #0a0518
120 \paragraph_separation indent
121 \paragraph_indentation default
123 \math_indentation default
124 \math_numbering_side default
125 \quotes_style english
129 \paperpagestyle headings
131 \tracking_changes true
132 \output_changes false
134 \postpone_fragile_content false
138 \docbook_table_output 0
139 \author -970929547 "Thibaut Cuvelier"
140 \author -712698321 "Jürgen Spitzmüller"
141 \author -584632292 "Richard Kimberly Heck"
142 \author -495245474 "Jean-Marc Lasgouttes"
144 \author 232239728 "Owner"
145 \author 731793113 "Richard Kimberly Heck" rikiheck@lyx.org
146 \author 1075283030 "Thibaut"
152 Customizing \SpecialChar LyX
153 : Features for the Advanced User
157 by the \SpecialChar LyX
162 \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,
185 \change_inserted 5863208 1604930692
189 \change_inserted 5863208 1604930729
191 \change_deleted 5863208 1604930668
200 \begin_inset Newline newline
204 \begin_inset Newline newline
210 \begin_layout Standard
211 \begin_inset CommandInset toc
212 LatexCommand tableofcontents
219 \begin_layout Standard
220 \begin_inset Note Note
223 \begin_layout Plain Layout
224 Please use change tracking when modifying this document.
225 This makes it easier for our translators to recognize things that have
226 been changed, and it helps the maintainer keep up-to-date with what's been
235 \begin_layout Chapter
239 \begin_layout Standard
240 This manual covers the customization features present in \SpecialChar LyX
242 In it, we discuss issues like keyboard shortcuts, screen previewing options,
243 printer options, sending commands to \SpecialChar LyX
244 via the \SpecialChar LyX
245 Server, internationalization,
246 installing new \SpecialChar LaTeX
247 classes and \SpecialChar LyX
249 We can't possibly hope to touch on everything you can change—our developers
250 add new features faster than we can document them—but we will explain the
251 most common customizations and hopefully point you in the right direction
252 for some of the more obscure ones.
255 \begin_layout Standard
256 \begin_inset Branch OutDated
260 \begin_layout Standard
261 Information from previous versions of this document that now seems to be
262 outdated is contained in the OutDated branch of this document.
263 By default, this information will not appear in the \SpecialChar LaTeX
272 \begin_layout Chapter
277 \begin_layout Standard
278 This chapter aims to help you to find your way through the \SpecialChar LyX
281 Before continuing to read this chapter, you should find out where your
283 library and user directories are by using
284 \begin_inset Flex Noun
287 \begin_layout Plain Layout
288 Help\SpecialChar menuseparator
299 The library directory is the place where \SpecialChar LyX
300 places its system-wide configuration
301 files; the user directory is where you can place your modified versions.
302 We will call the former
303 \begin_inset Flex Code
306 \begin_layout Plain Layout
313 \begin_inset Flex Noun
316 \begin_layout Plain Layout
322 in the remainder of this document.
326 \begin_layout Section
328 \begin_inset Flex Code
331 \begin_layout Plain Layout
340 \begin_layout Standard
341 \begin_inset Flex Code
344 \begin_layout Plain Layout
350 and its sub-directories contain a number of files
351 \change_deleted 232239728 1604787780
354 that can be used to customize \SpecialChar LyX
356 You can change many of these files from within \SpecialChar LyX
358 \begin_inset Flex Noun
361 \begin_layout Plain Layout
362 Tools\SpecialChar menuseparator
369 Most customization that you will want to do in \SpecialChar LyX
370 is possible through this
372 However, many other inner aspects of \SpecialChar LyX
373 can be customized by modifying the
375 \begin_inset Flex Code
378 \begin_layout Plain Layout
385 These files fall in different categories, described in the following subsection
389 \begin_layout Subsection
390 Automatically generated files
393 \begin_layout Standard
395 \begin_inset Flex Noun
398 \begin_layout Plain Layout
404 are generated when you configure \SpecialChar LyX
406 They contain various default values that are
407 \change_inserted 5863208 1604919565
408 automatically detected during reconfiguration.
409 \change_deleted 232239728 1604788241
410 guessed by inspection
412 In general, it is not a good idea to modify them, since they might be overwritt
416 \begin_layout Labeling
417 \labelwidthstring 00.00.0000
418 \begin_inset Flex Code
421 \begin_layout Plain Layout
428 \change_deleted 5863208 1604919950
430 \begin_inset Note Note
433 \begin_layout Plain Layout
435 \change_inserted 232239728 1604853928
436 I capitalized the first word in all of these lists.
437 To me it looks better but it really is a stylistic thing, your call.
438 However if you are not going to capitalize them, the english in some needs
439 to be modified to make it read correctly as a sentence.
447 \change_deleted 232239728 1604853510
449 \change_inserted 232239728 1604853510
452 ontains defaults for various commands.
455 \begin_layout Labeling
456 \labelwidthstring 00.00.0000
457 \begin_inset Flex Code
460 \begin_layout Plain Layout
467 \change_deleted 232239728 1604853512
469 \change_inserted 232239728 1604853512
472 ontains the list of packages that have been recognized by \SpecialChar LyX
474 It is currently unused by the \SpecialChar LyX
475 program itself, but the information extracted,
476 and more, is made available with
477 \begin_inset Flex Noun
480 \begin_layout Plain Layout
481 Help\SpecialChar menuseparator
495 \begin_layout Labeling
496 \labelwidthstring 00.00.0000
497 \begin_inset Flex Code
500 \begin_layout Plain Layout
507 \change_deleted 232239728 1604853515
509 \change_inserted 232239728 1604853515
512 he list of text classes that have been found in your
513 \begin_inset Flex Code
516 \begin_layout Plain Layout
522 directories, along with the associated \SpecialChar LaTeX
523 document class and their description.
526 \begin_layout Labeling
527 \labelwidthstring 00.00.0000
528 \begin_inset Flex Code
531 \begin_layout Plain Layout
538 \change_deleted 232239728 1604853518
540 \change_inserted 232239728 1604853518
543 he list of layout modules found in your
544 \begin_inset Flex Code
547 \begin_layout Plain Layout
556 \begin_layout Labeling
557 \labelwidthstring 00.00.0000
558 \begin_inset Flex Code
561 \begin_layout Plain Layout
568 \change_deleted 232239728 1604853523
570 \change_inserted 232239728 1604853523
573 ists of various sorts of \SpecialChar LaTeX
574 -related files found on your system
577 \begin_layout Labeling
578 \labelwidthstring 00.00.0000
579 \begin_inset Flex Code
582 \begin_layout Plain Layout
583 doc/\SpecialChar LaTeX
589 is automatically generated during configuration from the file
590 \begin_inset Flex Code
593 \begin_layout Plain Layout
601 It contains information on your \SpecialChar LaTeX
605 \begin_layout Subsection
609 \begin_layout Standard
611 \change_deleted 5863208 1604928729
615 \change_inserted 5863208 1604928636
619 \change_inserted 5863208 1604928661
623 \begin_inset Flex Code
626 \begin_layout Plain Layout
633 \change_inserted 5863208 1604928662
635 \change_deleted 5863208 1604928642
639 \change_deleted 5863208 1604928669
641 \begin_inset Flex Code
644 \begin_layout Plain Layout
651 \change_inserted 5863208 1604928680
655 \begin_inset Flex Code
658 \begin_layout Plain Layout
666 \change_deleted 232239728 1604794430
669 exists in both places, the one in
670 \begin_inset Flex Code
673 \begin_layout Plain Layout
682 \begin_layout Labeling
683 \labelwidthstring 00.00.0000
684 \begin_inset Flex Code
687 \begin_layout Plain Layout
694 \change_deleted 232239728 1604794460
696 \change_inserted 232239728 1604794460
699 his directory contains files with the extension
700 \begin_inset Flex Code
703 \begin_layout Plain Layout
709 that define the keybindings used in \SpecialChar LyX
711 If there exists an internationalized version of the bind file named
712 \begin_inset Flex Code
715 \begin_layout Plain Layout
721 , that will be used first.
724 \begin_layout Labeling
725 \labelwidthstring 00.00.0000
726 \begin_inset Flex Code
729 \begin_layout Plain Layout
736 \change_deleted 232239728 1604794478
738 \change_inserted 232239728 1604794478
741 ontains files with the extension
742 \begin_inset Flex Code
745 \begin_layout Plain Layout
751 which define the diverse citation possibilities (natbib, biblatex etc.).
753 \begin_inset CommandInset ref
755 reference "subsec:Cite-Engine-Files"
765 \begin_layout Labeling
766 \labelwidthstring 00.00.0000
767 \begin_inset Flex Code
770 \begin_layout Plain Layout
777 \change_deleted 232239728 1604794483
779 \change_inserted 232239728 1604794486
782 ontains graphics files that can be included in documents.
786 \begin_layout Labeling
787 \labelwidthstring 00.00.0000
788 \begin_inset Flex Code
791 \begin_layout Plain Layout
798 \change_deleted 232239728 1604794492
800 \change_inserted 232239728 1604794492
803 ontains \SpecialChar LyX
804 documentation files (including the one you are currently reading).
806 \begin_inset Flex Code
809 \begin_layout Plain Layout
811 \change_deleted 232239728 1604794660
814 \change_inserted 232239728 1604794661
822 deserves special attention, as noted above.
823 The internationalized help docs are in subdirectories
824 \begin_inset Flex Code
827 \begin_layout Plain Layout
834 \begin_inset Quotes eld
838 \begin_inset Quotes erd
841 is the ISO language code.
843 \begin_inset CommandInset ref
845 reference "cha:Internationalizing-LyX"
852 \begin_layout Labeling
853 \labelwidthstring 00.00.0000
854 \begin_inset Flex Code
857 \begin_layout Plain Layout
864 \change_deleted 232239728 1604794497
866 \change_inserted 232239728 1604794497
869 ontains example files that explain how to use some features.
870 In the file browser, press the
871 \begin_inset Flex Noun
874 \begin_layout Plain Layout
883 \begin_layout Labeling
884 \labelwidthstring 00.00.0000
885 \begin_inset Flex Code
888 \begin_layout Plain Layout
895 \change_deleted 232239728 1604794500
897 \change_inserted 232239728 1604794500
900 ontains image files that are used by the
901 \begin_inset Flex Noun
904 \begin_layout Plain Layout
911 In addition, it also contains the individual icons used in the toolbar
912 and the banners that can be shown when \SpecialChar LyX
916 \begin_layout Labeling
917 \labelwidthstring 00.00.0000
918 \begin_inset Flex Code
921 \begin_layout Plain Layout
928 \change_deleted 232239728 1604794505
930 \change_inserted 232239728 1604794505
933 ontains keyboard keymapping files.
935 \begin_inset CommandInset ref
937 reference "sec:International-Keymap-Stuff"
944 \begin_layout Labeling
945 \labelwidthstring 00.00.0000
946 \begin_inset Flex Code
949 \begin_layout Plain Layout
956 \change_deleted 232239728 1604794508
958 \change_inserted 232239728 1604794508
961 ontains the text class and module files described in
962 \begin_inset CommandInset ref
964 reference "cha:Installing-New-Document"
971 \begin_layout Labeling
972 \labelwidthstring 00.00.0000
973 \begin_inset Flex Code
976 \begin_layout Plain Layout
983 \change_deleted 232239728 1604794513
985 \change_inserted 232239728 1604794513
989 \begin_inset Flex Code
992 \begin_layout Plain Layout
998 Python scripts used to convert between \SpecialChar LyX
1000 These can be run from the command line if
1001 \change_deleted 232239728 1604794749
1004 you want to batch-convert files.
1007 \begin_layout Labeling
1008 \labelwidthstring 00.00.0000
1009 \begin_inset Flex Code
1012 \begin_layout Plain Layout
1019 \change_deleted 232239728 1604794516
1021 \change_inserted 232239728 1604794516
1024 ontains some files that demonstrate the capabilities of the
1025 \begin_inset Flex Noun
1028 \begin_layout Plain Layout
1030 \begin_inset space ~
1039 Also contains some scripts used by \SpecialChar LyX
1043 \begin_layout Labeling
1044 \labelwidthstring 00.00.0000
1045 \begin_inset Flex Code
1048 \begin_layout Plain Layout
1055 \change_deleted 232239728 1604794520
1057 \change_inserted 232239728 1604794520
1060 ontains the standard \SpecialChar LyX
1061 template files described in
1062 \begin_inset CommandInset ref
1064 reference "subsec:Creating-Templates"
1071 \begin_layout Labeling
1072 \labelwidthstring 00.00.0000
1073 \begin_inset Flex Code
1076 \begin_layout Plain Layout
1083 \change_deleted 232239728 1604794524
1085 \change_inserted 232239728 1604794524
1088 ontains files with the extension
1089 \begin_inset Flex Code
1092 \begin_layout Plain Layout
1098 that define the user interface to \SpecialChar LyX
1100 That is, the files define which items appear in which menus and the items
1101 appearing on the toolbar.
1104 \begin_layout Labeling
1105 \labelwidthstring 00.00.0000
1106 \begin_inset Flex Code
1109 \begin_layout Plain Layout
1116 \change_deleted 232239728 1604794528
1118 \change_inserted 232239728 1604794528
1121 ontains files with the extension
1122 \begin_inset Flex Code
1125 \begin_layout Plain Layout
1131 which define the templates for the insertion of external material to a
1134 \begin_inset CommandInset ref
1136 reference "chap:Including-External-Material"
1143 \begin_layout Subsection
1144 Files you don't want to modify
1147 \begin_layout Standard
1148 These files are used internally by \SpecialChar LyX
1149 and you generally do not need to modify
1150 them unless you are a developer.
1153 \begin_layout Labeling
1154 \labelwidthstring 00.00.0000
1155 \begin_inset Flex Code
1158 \begin_layout Plain Layout
1165 \change_deleted 232239728 1604797616
1167 \change_inserted 232239728 1604797616
1170 his file contains the list of \SpecialChar LyX
1172 The contents are displayed with the menu entry
1173 \begin_inset Flex Noun
1176 \begin_layout Plain Layout
1177 Help\SpecialChar menuseparator
1179 \begin_inset space ~
1190 \begin_layout Labeling
1191 \labelwidthstring 00.00.0000
1192 \begin_inset Flex Code
1195 \begin_layout Plain Layout
1202 \change_deleted 232239728 1604797620
1204 \change_inserted 232239728 1604797620
1207 his is a \SpecialChar LaTeX
1208 script used during the configuration process.
1209 Do not run directly.
1212 \begin_layout Labeling
1213 \labelwidthstring 00.00.0000
1214 \begin_inset Flex Code
1217 \begin_layout Plain Layout
1224 \change_deleted 232239728 1604797624
1226 \change_inserted 232239728 1604797624
1229 his is a Python script that is used to re-configure \SpecialChar LyX
1231 It creates configuration files in the directory it was run from.
1234 \begin_layout Subsection
1235 Other files needing a line or two
1238 \begin_layout Labeling
1239 \labelwidthstring 00.00.0000
1240 \begin_inset Flex Code
1243 \begin_layout Plain Layout
1250 \change_deleted 232239728 1604797580
1252 \change_inserted 232239728 1604797580
1255 his contains tables describing how different character encodings can be
1259 \begin_layout Labeling
1260 \labelwidthstring 00.00.0000
1261 \begin_inset Flex Code
1264 \begin_layout Plain Layout
1271 \change_deleted 232239728 1604797584
1273 \change_inserted 232239728 1604797584
1276 his file contains a list of all the languages currently supported by \SpecialChar LyX
1280 \begin_layout Labeling
1281 \labelwidthstring 00.00.0000
1282 \begin_inset Flex Code
1285 \begin_layout Plain Layout
1292 \change_deleted 232239728 1604797587
1294 \change_inserted 232239728 1604797587
1297 ontains information about the supported fonts.
1300 \begin_layout Labeling
1301 \labelwidthstring 00.00.0000
1302 \begin_inset Flex Code
1305 \begin_layout Plain Layout
1312 \change_deleted 232239728 1604797591
1314 \change_inserted 232239728 1604797591
1317 his file contains translations for internationalized paragraph styles (see
1319 \begin_inset CommandInset ref
1321 reference "subsec:I18n"
1328 \begin_layout Labeling
1329 \labelwidthstring 00.00.0000
1330 \begin_inset Flex Code
1333 \begin_layout Plain Layout
1340 \change_deleted 232239728 1604797594
1342 \change_inserted 232239728 1604797594
1345 his file contains information about Unicode-encoded glyphs and the way they
1346 are supported by \SpecialChar LyX
1347 via \SpecialChar LaTeX
1351 \begin_layout Section
1352 Your local configuration directory
1355 \begin_layout Standard
1356 Even if you are using \SpecialChar LyX
1357 as an unprivileged user, you might want to change
1359 configuration for your own use.
1361 \begin_inset Flex Code
1364 \begin_layout Plain Layout
1370 directory contains all your personal configuration files.
1371 This is the directory described as
1372 \begin_inset Quotes eld
1376 \begin_inset Quotes erd
1380 \begin_inset Flex Noun
1383 \begin_layout Plain Layout
1384 Help\SpecialChar menuseparator
1386 \begin_inset space ~
1395 This directory is used as a mirror of
1396 \begin_inset Flex Code
1399 \begin_layout Plain Layout
1405 , which means that every file in
1406 \begin_inset Flex Code
1409 \begin_layout Plain Layout
1415 is a replacement for the corresponding file in
1416 \begin_inset Flex Code
1419 \begin_layout Plain Layout
1426 Any configuration file described in the above sections can be placed either
1427 in the system-wide directory, in which case it will affect all users, or
1428 in your local directory for your own use.
1431 \begin_layout Standard
1432 To make things clearer, let's provide a few examples:
1435 \begin_layout Itemize
1436 The preferences set in the
1437 \begin_inset Flex Noun
1440 \begin_layout Plain Layout
1441 Tools\SpecialChar menuseparator
1447 dialog are saved to a file
1448 \begin_inset Flex Code
1451 \begin_layout Plain Layout
1458 \begin_inset Flex Code
1461 \begin_layout Plain Layout
1470 \begin_layout Itemize
1471 When you reconfigure using
1472 \begin_inset Flex Noun
1475 \begin_layout Plain Layout
1476 Tools\SpecialChar menuseparator
1484 \begin_inset Flex Code
1487 \begin_layout Plain Layout
1493 script, and the resulting files are written in your local configuration
1495 This means that any additional text class file that you might have added
1497 \begin_inset Flex Code
1500 \begin_layout Plain Layout
1506 will be added to the list of classes in the
1507 \begin_inset Flex Noun
1510 \begin_layout Plain Layout
1511 Document\SpecialChar menuseparator
1520 \begin_layout Itemize
1521 If you get some updated documentation from
1522 \change_inserted 232239728 1604798171
1526 ftp site and cannot install it because you do not have sysadmin rights
1527 on your system, you can just copy the files
1528 \change_deleted 232239728 1604798193
1530 \change_inserted 232239728 1604798193
1534 \begin_inset Flex Code
1537 \begin_layout Plain Layout
1543 and the items in the
1544 \begin_inset Flex Noun
1547 \begin_layout Plain Layout
1553 menu will open them!
1556 \begin_layout Section
1557 Running \SpecialChar LyX
1558 with multiple configurations
1561 \begin_layout Standard
1562 The configuration freedom of the local configuration directory may not suffice
1563 if you want to have more than one configuration at your disposal.
1564 For example, you may want to
1565 \change_deleted 232239728 1604798238
1568 use different key bindings or printer settings at different times.
1569 You can achieve this by having several such directories.
1570 You then specify which directory to use at run-time.
1573 \begin_layout Standard
1574 Invoking \SpecialChar LyX
1575 with the command line switch
1576 \begin_inset Flex Code
1579 \begin_layout Plain Layout
1589 instructs the program to read the configuration from that directory, and
1590 not from the default directory.
1591 (You can determine the default directory by running \SpecialChar LyX
1593 \begin_inset Flex Code
1596 \begin_layout Plain Layout
1602 switch.) If the specified directory does not exist, \SpecialChar LyX
1604 for you, just like it does for the default directory
1605 \change_deleted 232239728 1604798318
1608 the first time you run the program.
1609 You can modify the configuration options in this additional user directory
1610 exactly as you would for the default directory.
1611 These directories are completely independent (but read on).
1612 Note that setting the environment variable
1613 \begin_inset Flex Code
1616 \begin_layout Plain Layout
1622 to some value has exactly the same effect.
1625 \begin_layout Standard
1626 Having several configurations also requires more maintenance: if you want
1627 to add a new layout to
1628 \begin_inset Flex Code
1631 \begin_layout Plain Layout
1637 which you want available from all your configurations, you must add it
1638 to each directory separately.
1639 You can avoid this with the following trick: after \SpecialChar LyX
1640 creates the additional
1641 directory, most of the subdirectories (see above) are empty.
1642 If you want the new configuration to mirror an existing one, replace the
1643 empty subdirectory with a symbolic link to the matching subdirectory in
1644 the existing configuration.
1646 \begin_inset Flex Code
1649 \begin_layout Plain Layout
1655 subdirectory, however, since it contains a file written by the configuration
1656 script (also accessible through
1657 \begin_inset Flex Noun
1660 \begin_layout Plain Layout
1661 Tools\SpecialChar menuseparator
1667 ) which is configuration
1668 \change_deleted 232239728 1604798083
1670 \change_inserted 232239728 1604798100
1676 \begin_layout Chapter
1677 The Preferences dialog
1680 \begin_layout Standard
1681 All options of the preferences dialog are described in the Appendix
1683 The Preferences Dialog
1690 For some options you might find here more details.
1693 \begin_layout Section
1695 \begin_inset CommandInset label
1704 \begin_layout Standard
1705 The first step is to define your file formats if they are not already defined.
1707 \begin_inset Flex Noun
1710 \begin_layout Plain Layout
1711 Tools\SpecialChar menuseparator
1719 \begin_inset Flex Noun
1722 \begin_layout Plain Layout
1723 File Handling\SpecialChar menuseparator
1730 \begin_inset Flex Noun
1733 \begin_layout Plain Layout
1739 button to define your new format.
1741 \begin_inset Flex Noun
1744 \begin_layout Plain Layout
1750 field contains the name used to identify the format in the GUI.
1752 \begin_inset Flex Noun
1755 \begin_layout Plain Layout
1761 is used to identify the format internally.
1762 You will also need to enter a file extension.
1763 These are all required.
1765 \begin_inset Flex Noun
1768 \begin_layout Plain Layout
1774 field is used to provide a keyboard shortcut on the menus.
1775 (For example, pressing
1776 \begin_inset Flex Noun
1779 \begin_layout Plain Layout
1786 \begin_inset Flex Noun
1789 \begin_layout Plain Layout
1790 Document\SpecialChar menuseparator
1791 View (Other Formats)\SpecialChar menuseparator
1800 \begin_layout Standard
1802 \begin_inset Flex Noun
1805 \begin_layout Plain Layout
1812 \begin_inset Flex Noun
1815 \begin_layout Plain Layout
1822 For example, you might want to use
1823 \begin_inset Flex Noun
1826 \begin_layout Plain Layout
1832 to view PostScript files.
1833 You can enter the command needed to start the program in the corresponding
1835 In defining this command, you can use the four variables listed in the
1837 The viewer is launched when you view an image in \SpecialChar LyX
1839 \begin_inset Flex Noun
1842 \begin_layout Plain Layout
1843 Document\SpecialChar menuseparator
1850 The editor is for example launched when you right-click on an image and
1852 \begin_inset Flex Noun
1855 \begin_layout Plain Layout
1861 in the appearing context menu.
1864 \begin_layout Standard
1866 \begin_inset Flex Noun
1869 \begin_layout Plain Layout
1875 type of a format is optional, but if it is specified, it must be unique
1877 It is used to detect files of this format from the file contents.
1878 For some important file formats there is no MIME type officially registered
1880 \begin_inset CommandInset href
1883 target "http://www.iana.org/assignments/media-types/"
1889 Therefore \SpecialChar LyX
1890 uses the extended list of MIME types as specified by
1891 \begin_inset CommandInset href
1893 name "freedesktop.org"
1894 target "http://www.freedesktop.org/wiki/Specifications/shared-mime-info-spec"
1902 \begin_layout Standard
1904 \begin_inset Flex Noun
1907 \begin_layout Plain Layout
1913 option tells \SpecialChar LyX
1914 that a format is suitable for document export.
1915 If this is set and if a suitable conversion route exists (see
1916 \begin_inset CommandInset ref
1918 reference "sec:Converters"
1922 ), the format will appear in the
1923 \begin_inset Flex Noun
1926 \begin_layout Plain Layout
1927 File\SpecialChar menuseparator
1934 The format will also appear in the
1935 \begin_inset Flex Noun
1938 \begin_layout Plain Layout
1939 Document\SpecialChar menuseparator
1945 menu if a viewer is specified for the format.
1946 Pure image formats, such as
1947 \begin_inset Flex Code
1950 \begin_layout Plain Layout
1956 , should not use this option.
1957 Formats that can both represent vector graphics and documents like
1958 \begin_inset Flex Code
1961 \begin_layout Plain Layout
1970 \begin_layout Standard
1972 \begin_inset Flex Noun
1975 \begin_layout Plain Layout
1976 Vector graphics format
1981 tells \SpecialChar LyX
1982 that a format can contain vector graphics.
1983 This information is used to determine the target format of included graphics
1985 \begin_inset Flex Noun
1988 \begin_layout Plain Layout
1995 Included graphics may need to be converted to either
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
2026 \begin_inset Flex Noun
2029 \begin_layout Plain Layout
2035 cannot handle other image formats.
2036 If an included graphic is not already in
2037 \begin_inset Flex Noun
2040 \begin_layout Plain Layout
2047 \begin_inset Flex Noun
2050 \begin_layout Plain Layout
2057 \begin_inset Flex Noun
2060 \begin_layout Plain Layout
2066 format, it is converted to
2067 \begin_inset Flex Noun
2070 \begin_layout Plain Layout
2076 if the vector format option is set, and otherwise to
2077 \begin_inset Flex Noun
2080 \begin_layout Plain Layout
2089 \begin_layout Section
2093 \begin_layout Standard
2094 Since all conversions from one format to another take place in \SpecialChar LyX
2096 directory, it is sometimes necessary to modify a file before copying it
2097 to the temporary directory in order that the conversion may be performed.
2101 \begin_layout Plain Layout
2102 For example, the file may refer to other files—images, for example—using
2103 relative file names, and these may become invalid when the file is copied
2104 to the temporary directory.
2109 This is done by a Copier: It copies a file to (or from) the temporary directory
2110 and may modify it in the process.
2113 \begin_layout Standard
2114 The definitions of the copiers may use eight variables:
2117 \begin_layout Labeling
2118 \labelwidthstring 00.00.0000
2119 \begin_inset Flex Code
2122 \begin_layout Plain Layout
2128 The \SpecialChar LyX
2129 system directory (e.
2130 \begin_inset space \thinspace{}
2134 \begin_inset space \space{}
2138 \begin_inset Flex Noun
2141 \begin_layout Plain Layout
2150 \begin_layout Labeling
2151 \labelwidthstring 00.00.0000
2152 \begin_inset Flex Code
2155 \begin_layout Plain Layout
2164 \begin_layout Labeling
2165 \labelwidthstring 00.00.0000
2166 \begin_inset Flex Code
2169 \begin_layout Plain Layout
2178 \begin_layout Labeling
2179 \labelwidthstring 00.00.0000
2180 \begin_inset Flex Code
2183 \begin_layout Plain Layout
2189 The base name (without filename extension) in the \SpecialChar LyX
2193 \begin_layout Labeling
2194 \labelwidthstring 00.00.0000
2195 \begin_inset Flex Code
2198 \begin_layout Plain Layout
2204 The full directory path of the \SpecialChar LyX
2208 \begin_layout Labeling
2209 \labelwidthstring 00.00.0000
2210 \begin_inset Flex Code
2213 \begin_layout Plain Layout
2219 The full pathname to the original \SpecialChar LyX
2220 file being processed
2223 \begin_layout Labeling
2224 \labelwidthstring 00.00.0000
2225 \begin_inset Flex Code
2228 \begin_layout Plain Layout
2234 The filename (without any directory path) of the \SpecialChar LyX
2238 \begin_layout Labeling
2239 \labelwidthstring 00.00.0000
2240 \begin_inset Flex Code
2243 \begin_layout Plain Layout
2249 The `\SpecialChar LaTeX
2253 \begin_layout Standard
2254 The latter should be the filename as it would be used in a \SpecialChar LaTeX
2262 It is relevant only when exporting files suitable for such inclusion.
2265 \begin_layout Standard
2266 Copiers can be used to do almost anything with output files.
2267 For example, suppose you want generated pdf files to be copied to a special
2269 \begin_inset Flex Code
2272 \begin_layout Plain Layout
2279 Then you could write a shell script such as this one:
2282 \begin_layout Standard
2283 \begin_inset listings
2287 \begin_layout Plain Layout
2292 \begin_layout Plain Layout
2297 \begin_layout Plain Layout
2299 TOFILE=`basename $2`
2302 \begin_layout Plain Layout
2304 cp $FROMFILE /home/you/pdf/$TOFILE
2309 Save it in your local \SpecialChar LyX
2311 \begin_inset Flex Code
2314 \begin_layout Plain Layout
2315 /home/you/.lyx/scripts/pdfcopier.sh
2320 —and make it executable, if you need to do so on your platform.
2322 \begin_inset Flex Noun
2325 \begin_layout Plain Layout
2326 Tools\SpecialChar menuseparator
2332 dialog, select under
2333 \begin_inset Flex Noun
2336 \begin_layout Plain Layout
2337 File Handling\SpecialChar menuseparator
2344 \begin_inset Flex Noun
2347 \begin_layout Plain Layout
2353 format—or one of the other pdf formats—and enter
2354 \begin_inset Flex Code
2357 \begin_layout Plain Layout
2358 pdfcopier.sh $$i $$o
2364 \begin_inset Flex Noun
2367 \begin_layout Plain Layout
2377 \begin_layout Standard
2378 Copiers are used by \SpecialChar LyX
2379 in various of its own conversions.
2380 For example, if appropriate programs are found, \SpecialChar LyX
2381 will automatically install
2383 \begin_inset Flex Noun
2386 \begin_layout Plain Layout
2393 \begin_inset Flex Noun
2396 \begin_layout Plain Layout
2398 \begin_inset space ~
2407 When these formats are exported, the copier sees that not just the main
2408 HTML file but various associated files (style files, images, etc.) are also
2410 All these files are written to a subdirectory of the directory in which
2411 the original \SpecialChar LyX
2416 \begin_layout Plain Layout
2417 This copier can be customized.
2419 \begin_inset Quotes eld
2423 \begin_inset Quotes erd
2426 argument takes a comma-separated list of extensions to be copied; if it
2427 is omitted, all files will be copied.
2429 \begin_inset Quotes eld
2433 \begin_inset Quotes erd
2436 argument determines the extension added to the generated directory.
2438 \begin_inset Quotes eld
2442 \begin_inset Flex Noun
2445 \begin_layout Plain Layout
2452 \begin_inset Quotes erd
2455 , so HTML generated from
2456 \begin_inset Flex Noun
2459 \begin_layout Plain Layout
2460 /path/to/filename.lyx
2466 \begin_inset Flex Noun
2469 \begin_layout Plain Layout
2470 /path/to/filename.html.LyXconv
2484 \begin_layout Section
2486 \begin_inset CommandInset label
2488 name "sec:Converters"
2495 \begin_layout Standard
2496 You can define your own Converters to convert files between different formats.
2498 \begin_inset Flex Noun
2501 \begin_layout Plain Layout
2502 Tools\SpecialChar menuseparator
2503 Preferences\SpecialChar menuseparator
2504 File Handling\SpecialChar menuseparator
2513 \begin_layout Standard
2514 To define a new converter, select the
2515 \begin_inset Flex Noun
2518 \begin_layout Plain Layout
2520 \begin_inset space ~
2529 \begin_inset Flex Noun
2532 \begin_layout Plain Layout
2534 \begin_inset space ~
2542 from the drop-down lists, enter the command needed for the conversion,
2544 \begin_inset Flex Noun
2547 \begin_layout Plain Layout
2554 Several variables can be used in the definition of converters:
2557 \begin_layout Labeling
2558 \labelwidthstring 00.00.0000
2559 \begin_inset Flex Code
2562 \begin_layout Plain Layout
2568 The \SpecialChar LyX
2572 \begin_layout Labeling
2573 \labelwidthstring 00.00.0000
2574 \begin_inset Flex Code
2577 \begin_layout Plain Layout
2586 \begin_layout Labeling
2587 \labelwidthstring 00.00.0000
2588 \begin_inset Flex Code
2591 \begin_layout Plain Layout
2600 \begin_layout Labeling
2601 \labelwidthstring 00.00.0000
2602 \begin_inset Flex Code
2605 \begin_layout Plain Layout
2611 The base filename of the input file (i.
2612 \begin_inset space \thinspace{}
2615 g., without the extension)
2618 \begin_layout Labeling
2619 \labelwidthstring 00.00.0000
2620 \begin_inset Flex Code
2623 \begin_layout Plain Layout
2629 The path to the input file
2632 \begin_layout Labeling
2633 \labelwidthstring 00.00.0000
2634 \begin_inset Flex Code
2637 \begin_layout Plain Layout
2643 The path to the original input file (this is different from $$p when a
2644 chain of converters is called)
2647 \begin_layout Labeling
2648 \labelwidthstring 00.00.0000
2649 \begin_inset Flex Code
2652 \begin_layout Plain Layout
2658 The iconv name for the encoding of the document.
2661 \begin_layout Standard
2663 \begin_inset Flex Noun
2666 \begin_layout Plain Layout
2668 \begin_inset space ~
2676 field you can enter the following flags, separated by commas:
2679 \begin_layout Labeling
2680 \labelwidthstring 00.00.0000
2681 \begin_inset Flex Code
2684 \begin_layout Plain Layout
2686 \change_inserted -712698321 1524656940
2694 This converter runs some form of \SpecialChar LaTeX
2696 This will make \SpecialChar LyX
2697 's \SpecialChar LaTeX
2698 error logs available.
2700 \change_inserted -712698321 1524657018
2702 \begin_inset Flex Code
2705 \begin_layout Plain Layout
2707 \change_inserted -712698321 1524657012
2715 value specifies the form of \SpecialChar LaTeX
2717 \begin_inset Flex Code
2720 \begin_layout Plain Layout
2722 \change_inserted -712698321 1524657005
2723 latex, pdflatex, platex, xetex, luatex
2731 If no value is specified,
2732 \begin_inset Flex Code
2735 \begin_layout Plain Layout
2737 \change_inserted -712698321 1524657018
2750 \begin_layout Labeling
2751 \labelwidthstring 00.00.0000
2752 \begin_inset Flex Code
2755 \begin_layout Plain Layout
2757 \change_inserted -712698321 1524656935
2765 Needs the \SpecialChar LaTeX
2767 \begin_inset Flex Noun
2770 \begin_layout Plain Layout
2776 file for the conversion.
2778 \change_inserted -712698321 1524657047
2780 \begin_inset Flex Code
2783 \begin_layout Plain Layout
2785 \change_inserted -712698321 1524657030
2793 value specifies the form of \SpecialChar LaTeX
2794 that is run in order to generate the
2795 \begin_inset Flex Noun
2798 \begin_layout Plain Layout
2800 \change_inserted -712698321 1524657047
2809 \begin_inset Flex Code
2812 \begin_layout Plain Layout
2814 \change_inserted -712698321 1524657030
2815 latex, pdflatex, platex, xetex, luatex
2823 If no value is specified,
2824 \begin_inset Flex Code
2827 \begin_layout Plain Layout
2829 \change_inserted -712698321 1524657030
2842 \begin_layout Labeling
2843 \labelwidthstring 00.00.0000
2844 \begin_inset Flex Code
2847 \begin_layout Plain Layout
2854 \begin_inset Quotes eld
2858 \begin_inset Quotes erd
2861 file from the backend, which in practice means a \SpecialChar LaTeX
2862 file like the one we
2863 would export, without
2864 \begin_inset Flex Code
2867 \begin_layout Plain Layout
2876 \begin_layout Labeling
2877 \labelwidthstring 00.00.0000
2878 \begin_inset Flex Code
2881 \begin_layout Plain Layout
2890 \begin_layout Standard
2891 The following three flags are not really flags at all because they take
2893 \begin_inset Flex Noun
2896 \begin_layout Plain Layout
2898 \begin_inset space ~
2902 \begin_inset space ~
2913 \begin_layout Labeling
2914 \labelwidthstring 00.00.0000
2916 \change_inserted -712698321 1523206314
2917 \begin_inset Flex Code
2920 \begin_layout Plain Layout
2922 \change_inserted -712698321 1523206193
2930 The name of the driver that needs to be loaded with the
2934 package for this converter.
2935 The loading of the correct driver is necessary to get some PDF-specific
2944 \begin_layout Labeling
2945 \labelwidthstring 00.00.0000
2946 \begin_inset Flex Code
2949 \begin_layout Plain Layout
2955 If set, the converter's standard error will be redirected to a file
2956 \begin_inset Flex Code
2959 \begin_layout Plain Layout
2965 , and the script given as argument will be run as:
2966 \begin_inset Flex Code
2969 \begin_layout Plain Layout
2970 script < infile.out > infile.log
2976 The argument may contain
2977 \begin_inset Flex Code
2980 \begin_layout Plain Layout
2989 \begin_layout Labeling
2990 \labelwidthstring 00.00.0000
2991 \begin_inset Flex Code
2994 \begin_layout Plain Layout
3000 The name of the directory in which the converter will dump the generated
3003 will not create this directory, and it does not copy anything into it,
3004 though it will copy this directory to the destination.
3005 The argument may contain
3006 \begin_inset Flex Code
3009 \begin_layout Plain Layout
3015 , which will be replaced by the base name of the input and output files,
3016 respectively, when the directory is copied.
3017 \begin_inset Newline newline
3020 Note that resultdir and usetempdir make no sense together.
3021 The latter will be ignored if the former is given.
3024 \begin_layout Labeling
3025 \labelwidthstring 00.00.0000
3026 \begin_inset Flex Code
3029 \begin_layout Plain Layout
3035 Determines the output file name and may, contain
3036 \begin_inset Flex Code
3039 \begin_layout Plain Layout
3046 Sensible only with resultdir and optional even then; if not given, it defaults
3050 \begin_layout Standard
3052 \change_inserted -712698321 1523206384
3053 A suitable hyperref-driver is set for some converters that are installed
3054 with \SpecialChar LyX
3057 \change_deleted -712698321 1523206388
3059 \change_inserted -712698321 1523206389
3063 \change_inserted -712698321 1523206400
3067 \change_inserted -712698321 1523206407
3071 \change_inserted -712698321 1523206437
3075 \change_deleted -712698321 1523206442
3076 that are installed with \SpecialChar LyX
3083 \begin_layout Standard
3084 You do not have to define converters for all formats between which you want
3086 For example, you will note that there is no `\SpecialChar LyX
3087 to PostScript' converter,
3088 but \SpecialChar LyX
3089 will export PostScript.
3090 It does so by first creating a \SpecialChar LaTeX
3091 file (no converter needs to be defined
3092 for this) which is then converted to DVI using the `\SpecialChar LaTeX
3094 and finally converting the resulting DVI file to PostScript.
3096 finds such `chains' of converters automatically, and it will always choose
3097 the shortest possible chain.
3098 You can, though, still define multiple conversion methods between file
3100 For example, the standard \SpecialChar LyX
3101 configuration provides five ways to convert
3106 \begin_layout Enumerate
3108 \begin_inset Flex Noun
3111 \begin_layout Plain Layout
3120 \begin_layout Enumerate
3121 via (DVI and) PostScript, using
3122 \begin_inset Flex Noun
3125 \begin_layout Plain Layout
3134 \begin_layout Enumerate
3136 \begin_inset Flex Noun
3139 \begin_layout Plain Layout
3148 \begin_layout Enumerate
3150 \begin_inset Flex Noun
3153 \begin_layout Plain Layout
3163 \begin_layout Enumerate
3165 \begin_inset Flex Noun
3168 \begin_layout Plain Layout
3178 \begin_layout Standard
3179 To define such alternate chains, you must define multiple target `file formats',
3181 \begin_inset CommandInset ref
3183 reference "sec:Formats"
3188 For example, in the standard configuration, the formats named
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
3259 \begin_inset Flex Noun
3262 \begin_layout Plain Layout
3270 \begin_inset Flex Noun
3273 \begin_layout Plain Layout
3280 \begin_inset Flex Noun
3283 \begin_layout Plain Layout
3290 ) are defined, all of which share the extension
3291 \begin_inset Flex Noun
3294 \begin_layout Plain Layout
3300 , and which correspond to the conversion methods just mentioned.
3303 \begin_layout Chapter
3304 Internationalizing \SpecialChar LyX
3306 \begin_inset CommandInset label
3308 name "cha:Internationalizing-LyX"
3315 \begin_layout Standard
3317 supports using a translated interface.
3318 Last time we checked, \SpecialChar LyX
3319 provided text in thirty languages.
3320 The language of choice is called your
3325 (For further reading on locale settings, see also the documentation for
3326 locale that comes with your operating system.
3327 For Linux, the manual page for
3328 \begin_inset Flex Code
3331 \begin_layout Plain Layout
3337 could be a good place to start).
3340 \begin_layout Standard
3341 Notice that these translations will work, but do contain a few flaws.
3342 In particular, all dialogs have been designed with the English text in
3343 mind, which means that some of the translated text will be too large to
3344 fit within the space allocated.
3345 This is only a display problem and will not cause any harm.
3346 Also, you will find that some of the translations do not define shortcut
3347 keys for everything.
3348 Sometimes, there are simply not enough free letters to do it.
3349 Other times, the translator just hasn't got around to doing it yet.
3350 Our localization team, which you may wish to join,
3354 \begin_layout Plain Layout
3355 If you are a fluent speaker of a language other than English, joining these
3356 teams is a great way to give back to the \SpecialChar LyX
3362 will of course try to fix these shortcomings in future versions of \SpecialChar LyX
3366 \begin_layout Section
3367 Translating \SpecialChar LyX
3371 \begin_layout Subsection
3372 Translating the graphical user interface (text messages).
3375 \begin_layout Standard
3378 \begin_inset Flex Code
3381 \begin_layout Plain Layout
3387 library to handle the internationalization of the interface.
3388 To have \SpecialChar LyX
3389 speak your favorite language in all menus and dialogs, you need
3391 \begin_inset Flex Code
3394 \begin_layout Plain Layout
3400 -file for that language.
3401 When this is available, you'll have to generate a
3402 \begin_inset Flex Code
3405 \begin_layout Plain Layout
3411 -file from it and install the
3412 \begin_inset Flex Code
3415 \begin_layout Plain Layout
3422 The process of doing all of this is explained in the documentation for
3424 \begin_inset Flex Code
3427 \begin_layout Plain Layout
3434 It is possible to do this just for yourself, but if you're going to do
3435 it, you might as well share the results of your labors with the rest of
3436 the \SpecialChar LyX
3438 Send a message to the \SpecialChar LyX
3439 developers' list for more information about how
3443 \begin_layout Standard
3444 In short, this is what you should do (xx denotes the language code):
3447 \begin_layout Itemize
3448 Check out the \SpecialChar LyX
3451 \begin_inset CommandInset href
3453 name "information on the web"
3454 target "https://www.lyx.org/HowToUseGIT"
3462 \begin_layout Itemize
3464 \begin_inset Flex Code
3467 \begin_layout Plain Layout
3473 to the folder of the
3474 \begin_inset Flex Code
3477 \begin_layout Plain Layout
3485 \begin_inset Flex Code
3488 \begin_layout Plain Layout
3496 \begin_inset Flex Code
3499 \begin_layout Plain Layout
3505 doesn't exist anywhere, it can be remade with the console command
3506 \begin_inset Flex Code
3509 \begin_layout Plain Layout
3515 in that directory, or you can use an existing po-file for some other language
3519 \begin_layout Itemize
3521 \begin_inset Flex Code
3524 \begin_layout Plain Layout
3534 \begin_layout Plain Layout
3535 This is just a text file, so it can be edited in any text editor.
3536 But there are also specialized programs that support such editing, such
3541 (for all platforms) or
3550 contains a `mode' for editing
3551 \begin_inset Flex Code
3554 \begin_layout Plain Layout
3561 \begin_inset Flex URL
3564 \begin_layout Plain Layout
3566 https://www.gnu.org/software/gettext/manual/html_node/PO-Mode.html#PO-Mode
3576 For some menu- and widget-labels, there are also shortcut keys that should
3578 Those keys are marked after a `|', and should be translated according to
3579 the words and phrases of the language.
3580 You should also fill also out the information at the beginning of the new
3582 \begin_inset Flex Code
3585 \begin_layout Plain Layout
3591 -file with your email-address, etc., so people know where to reach you with
3592 suggestions and entertaining flames.
3595 \begin_layout Standard
3596 If you are just doing this on your own, then:
3599 \begin_layout Itemize
3601 \begin_inset Flex Code
3604 \begin_layout Plain Layout
3611 This can be done with
3612 \begin_inset Flex Code
3615 \begin_layout Plain Layout
3616 msgfmt -o xx.mo < xx.po
3624 \begin_layout Itemize
3626 \begin_inset Flex Code
3629 \begin_layout Plain Layout
3635 -file to your locale-tree, at the correct directory for application messages
3640 xx, and under the name
3641 \begin_inset Flex Code
3644 \begin_layout Plain Layout
3651 \begin_inset space \thinspace{}
3655 \begin_inset space \space{}
3659 \begin_inset Flex Code
3662 \begin_layout Plain Layout
3663 /usr/local/share/locale/xx/LC_MESSAGES/lyx.mo
3673 \begin_layout Standard
3674 As said, however, it would be best if the new
3675 \begin_inset Flex Code
3678 \begin_layout Plain Layout
3684 file could be added to the \SpecialChar LyX
3685 distribution, so others can use it.
3686 Adding it involves making additional changes to \SpecialChar LyX
3688 So send an email to the developers' mailing list if you're interested in
3692 \begin_layout Subsubsection
3696 \begin_layout Standard
3697 Sometimes it turns out that one English message needs to be translated into
3698 different messages in the target language.
3699 One example is the message
3700 \begin_inset Flex Code
3703 \begin_layout Plain Layout
3709 which has the German translation
3717 , depending upon exactly what the English
3718 \begin_inset Quotes eld
3722 \begin_inset Quotes erd
3727 \begin_inset Flex Code
3730 \begin_layout Plain Layout
3736 does not handle such ambiguous translations.
3737 Therefore you have to add some context information to the message: Instead
3739 \begin_inset Flex Code
3742 \begin_layout Plain Layout
3749 \begin_inset Flex Code
3752 \begin_layout Plain Layout
3753 To[[as in 'From format x to format y']]
3759 \begin_inset Flex Code
3762 \begin_layout Plain Layout
3763 To[[as in 'From page x to page y']].
3768 Now the two occurrences of
3769 \begin_inset Flex Code
3772 \begin_layout Plain Layout
3779 \begin_inset Flex Code
3782 \begin_layout Plain Layout
3788 and can be translated correctly to
3799 \begin_layout Standard
3800 Of course the context information needs to be stripped off the original
3801 message when no translation is used.
3802 Therefore you have to put it in double square brackets at the end of the
3803 message (see the example above).
3804 The translation mechanism of \SpecialChar LyX
3805 ensures that everything in double square
3806 brackets at the end of messages is removed before displaying the message.
3809 \begin_layout Subsection
3810 Translating the documentation.
3813 \begin_layout Standard
3814 The online documentation (in the
3815 \begin_inset Flex Noun
3818 \begin_layout Plain Layout
3824 -menu) can (and should!) be translated.
3825 If there are translated versions of the documentation available
3829 \begin_layout Plain Layout
3830 As of March 2008, at least some of the documents have been translated into
3831 fourteen languages, with the Tutorial available in a few more.
3836 and the locale is set accordingly, these will be used automagically by
3840 looks for translated versions as
3841 \begin_inset Flex Code
3844 \begin_layout Plain Layout
3845 LyXDir/doc/xx/DocName.lyx
3851 \begin_inset Flex Code
3854 \begin_layout Plain Layout
3860 is the code for the language currently in use.
3861 If there are no translated documents, the default English versions will
3863 Note that the translated versions must have the same filenames (
3864 \begin_inset Flex Code
3867 \begin_layout Plain Layout
3873 above) as the original.
3874 If you feel up to translating the documentation (an excellent way to proof-read
3875 the original documentation by the way!), there are a few things you should
3879 \begin_layout Itemize
3880 Check out the documentation translation web page at
3881 \begin_inset CommandInset href
3883 name "https://www.lyx.org/Translation"
3884 target "https://www.lyx.org/Translation"
3890 That way, you can find out which (if any) documents have already been translate
3891 d into your language.
3892 You can also find out who (if anyone) is organizing the effort to translate
3893 the documentation into your language.
3894 If no one is organizing the effort, please let us know that you're interested.
3897 \begin_layout Standard
3898 Once you get to actually translating, here's a few hints for you that may
3902 \begin_layout Itemize
3903 Join the documentation team! There is information on how to do that in
3904 \begin_inset Flex Code
3907 \begin_layout Plain Layout
3914 \begin_inset Flex Noun
3917 \begin_layout Plain Layout
3918 Help\SpecialChar menuseparator
3924 ), which by the way is the first document you should translate.
3927 \begin_layout Itemize
3928 Learn the typographic conventions for the language you are translating to.
3929 Typography is an ancient art and over the centuries, a great variety of
3930 conventions have developed throughout different parts of the world.
3931 Also study the professional terminology amongst typographers in your country.
3932 Inventing your own terminology will only confuse the users.
3935 (Warning! Typography is addictive!)
3938 \begin_layout Itemize
3939 Make a copy of the document.
3940 This will be your working copy.
3941 You can use this as your personal translated help-file by placing it in
3943 \begin_inset Flex Code
3946 \begin_layout Plain Layout
3953 \begin_inset Note Greyedout
3956 \begin_layout Plain Layout
3961 For a complex document with external material (images, etc.), if you make
3963 \begin_inset space \thinspace{}
3967 \begin_inset space \space{}
3970 in a temp dir, beware that the links to external material may be broken
3971 when the document is moved to a different place.
3972 The best way is to retrieve the \SpecialChar LyX
3974 \begin_inset Flex URL
3977 \begin_layout Plain Layout
3979 https://www.lyx.org/HowToUseGIT
3984 ) and to edit the doc file in place.
3992 \begin_layout Itemize
3993 Sometimes the original document (from the \SpecialChar LyX
3994 team) will be updated.
3995 Use the source viewer at
3996 \begin_inset CommandInset href
3998 name "https://www.lyx.org/trac/timeline"
3999 target "https://www.lyx.org/trac/timeline"
4004 to see what has been changed.
4005 That way you can easily see which parts of the translated document need
4009 \begin_layout Standard
4010 If you ever find an error in the original document, fix it and notify the
4011 rest of the documentation team of the changes! (You didn't forget to join
4012 the documentation team, did you?)
4015 \begin_layout Standard
4016 \begin_inset Branch OutDated
4020 \begin_layout Section
4021 International Keyboard Support
4024 \begin_layout Standard
4027 [Editor's Note: The following section is by
4035 It needs to be fixed to conform to the new Documentation Style sheet and
4036 to make use of the new v1.0 features.
4037 The whole thing also needs to be merged with the section following it.-jw
4038 It may also be badly out of date.-rh (2008)]
4041 \begin_layout Subsection
4042 Defining Own Keymaps: Keymap File Format
4045 \begin_layout Standard
4046 Let's look at a keyboard definition file a little closer.
4047 It is a plain text file defining
4050 \begin_layout Itemize
4051 key-to-key or key-to-string translations
4054 \begin_layout Itemize
4058 \begin_layout Itemize
4059 dead keys exceptions
4062 \begin_layout Standard
4063 To define key-to-key or key-to-string translation, use this command:
4066 \begin_layout Quotation
4067 \begin_inset Flex Code
4070 \begin_layout Plain Layout
4079 \begin_inset Flex Code
4082 \begin_layout Plain Layout
4091 \begin_layout Standard
4093 \begin_inset Flex Code
4096 \begin_layout Plain Layout
4102 is the key to be translated and
4103 \begin_inset Flex Code
4106 \begin_layout Plain Layout
4112 is the string to be inserted into the document.
4113 To define dead keys, use:
4116 \begin_layout Quotation
4117 \begin_inset Flex Code
4120 \begin_layout Plain Layout
4129 \begin_inset Flex Code
4132 \begin_layout Plain Layout
4141 \begin_layout Standard
4143 \begin_inset Flex Code
4146 \begin_layout Plain Layout
4152 is a keyboard key and
4153 \begin_inset Flex Code
4156 \begin_layout Plain Layout
4163 The following dead keys are supported (shortcut name is in parentheses):
4166 \begin_layout Quotation
4170 \begin_inset space \hfill{}
4176 \begin_layout Quotation
4178 \begin_inset space \hfill{}
4184 \begin_layout Quotation
4186 \begin_inset space \hfill{}
4192 \begin_layout Quotation
4194 \begin_inset space \hfill{}
4200 \begin_layout Quotation
4202 \begin_inset space \hfill{}
4208 \begin_layout Quotation
4210 \begin_inset space \hfill{}
4217 \begin_layout Plain Layout
4229 \begin_layout Quotation
4231 \begin_inset space \hfill{}
4237 \begin_layout Quotation
4239 \begin_inset space \hfill{}
4246 \begin_layout Plain Layout
4258 \begin_layout Quotation
4260 \begin_inset space \hfill{}
4266 \begin_layout Quotation
4268 \begin_inset space \hfill{}
4274 \begin_layout Quotation
4276 \begin_inset space \hfill{}
4283 \begin_layout Plain Layout
4295 \begin_layout Quotation
4297 \begin_inset space \hfill{}
4304 \begin_layout Plain Layout
4316 \begin_layout Quotation
4318 \begin_inset space \hfill{}
4324 \begin_layout Quotation
4325 hungarian umlaut (hug)
4326 \begin_inset space \hfill{}
4332 \begin_layout Quotation
4334 \begin_inset space \hfill{}
4340 \begin_layout Quotation
4342 \begin_inset space \hfill{}
4349 \begin_layout Plain Layout
4361 \begin_layout Standard
4362 Since in many international keyboards there are exceptions to what some
4363 dead keys should do, you can define them using
4366 \begin_layout Quotation
4367 \begin_inset Flex Code
4370 \begin_layout Plain Layout
4378 deadkey key outstring
4381 \begin_layout Standard
4382 For example, on Slovak keyboard, if you enter caron-o, it generates circumflex-o
4386 \begin_layout Quotation
4387 \begin_inset Flex Code
4390 \begin_layout Plain Layout
4403 \begin_layout Standard
4404 to make it work correctly.
4405 Also, you have to define as exceptions dead keys over i and j, to remove
4406 the dot from them before inserting an accent mark.
4407 I will change this when the time comes, but so far I haven't had time.
4410 \begin_layout Standard
4411 Oh, and about characters: backslash is escaped, so to enter it, you'll need
4414 \begin_inset Flex Code
4417 \begin_layout Plain Layout
4423 have different meaning.
4425 \begin_inset Flex Code
4428 \begin_layout Plain Layout
4434 marks comments, quotes start and end \SpecialChar LaTeX
4436 To enter quote, you'll need to use
4437 \begin_inset Flex Code
4440 \begin_layout Plain Layout
4449 \begin_inset Flex Code
4452 \begin_layout Plain Layout
4459 \begin_inset Flex Code
4462 \begin_layout Plain Layout
4473 \begin_layout Standard
4474 If you make a keyboard description file that works for your language, please
4475 mail it to me, so I can include it in the next keymap distribution.
4478 \begin_layout Standard
4479 More keywords will be supported in keymap configuration file in future,
4483 \begin_layout Itemize
4484 \begin_inset Flex Code
4487 \begin_layout Plain Layout
4498 \begin_inset space \hfill{}
4502 \begin_inset Flex Code
4505 \begin_layout Plain Layout
4514 \begin_layout Itemize
4515 \begin_inset Flex Code
4518 \begin_layout Plain Layout
4529 \begin_inset space \hfill{}
4533 \begin_inset Flex Code
4536 \begin_layout Plain Layout
4542 an external keymap translation program
4545 \begin_layout Standard
4546 Also, it should look into
4547 \begin_inset Flex Code
4550 \begin_layout Plain Layout
4556 file for defaults, too (for example, a
4557 \begin_inset Flex Code
4560 \begin_layout Plain Layout
4568 option to include default keyboard).
4576 \begin_layout Section
4577 International Keymap Stuff
4578 \begin_inset CommandInset label
4580 name "sec:International-Keymap-Stuff"
4587 \begin_layout Standard
4588 \begin_inset Note Note
4591 \begin_layout Plain Layout
4592 In doing the revisions on this document in March 2008, I did not look over
4593 this stuff, as I do not understand it.
4594 It would be good if someone else could do so.
4603 \begin_layout Standard
4604 The next two sections describe the
4605 \begin_inset Flex Code
4608 \begin_layout Plain Layout
4617 \begin_inset Flex Code
4620 \begin_layout Plain Layout
4628 file syntax in detail.
4629 These sections should help you design your own key map if the ones provided
4630 do not meet your needs.
4633 \begin_layout Subsection
4637 \begin_layout Standard
4641 \begin_inset Flex Code
4644 \begin_layout Plain Layout
4650 file maps keystrokes to characters or strings.
4651 As the name suggests, it sets a keyboard mapping.
4653 \begin_inset Flex Code
4656 \begin_layout Plain Layout
4667 \begin_inset Flex Code
4670 \begin_layout Plain Layout
4685 \begin_inset Flex Code
4688 \begin_layout Plain Layout
4701 \begin_inset Flex Code
4704 \begin_layout Plain Layout
4713 \begin_inset Flex Code
4716 \begin_layout Plain Layout
4724 are described in this section.
4727 \begin_layout Labeling
4728 \labelwidthstring 00.00.0000
4729 \begin_inset Flex Code
4732 \begin_layout Plain Layout
4740 Map a character to a string
4743 \begin_layout LyX-Code
4758 \begin_layout Standard
4791 the double-quote (")
4808 must be escaped with a preceding backslash (
4819 \begin_layout Standard
4821 \begin_inset Flex Noun
4824 \begin_layout Plain Layout
4832 statement to cause the symbol
4833 \begin_inset Flex Noun
4836 \begin_layout Plain Layout
4844 to be output for the keystroke
4845 \begin_inset Flex Noun
4848 \begin_layout Plain Layout
4859 \begin_layout LyX-Code
4865 \begin_layout Labeling
4866 \labelwidthstring 00.00.0000
4867 \begin_inset Flex Code
4870 \begin_layout Plain Layout
4878 Specify an accent character
4881 \begin_layout LyX-Code
4890 \begin_layout Standard
4891 This will make the cha
4929 This is the dead key
4933 \begin_layout Plain Layout
4940 refers to a key that does not produce a character by itself, but when followed
4941 with another key, produces the desired accent character.
4942 For example, a German characte
4944 r with an umlaut like
4954 can be produced in this manner.
4963 \begin_layout Standard
4976 and then another key not in
4993 followed by the other, not allowed key, as output.
4997 \begin_inset Flex Noun
5000 \begin_layout Plain Layout
5008 cancels a dead key, so if
5019 \begin_inset Flex Noun
5022 \begin_layout Plain Layout
5031 , the cursor will not go one position backwards but will instead cancel
5047 might have had on the next keystroke.
5051 \begin_layout Standard
5052 The following example specifies that the character ' is to be an acute accent,
5053 allowed on the characters a, e, i, o, u, A, E, I, O, and U:
5056 \begin_layout LyX-Code
5059 kmod ' acute aeiouAEIOU
5062 \begin_layout Labeling
5063 \labelwidthstring 00.00.0000
5064 \begin_inset Flex Code
5067 \begin_layout Plain Layout
5073 Specify an exception to the accent character
5076 \begin_layout LyX-Code
5085 \begin_layout Standard
5086 This defines an exce
5127 have been assigned a keystroke with a previous
5130 \begin_inset Flex Code
5133 \begin_layout Plain Layout
5157 must not belong in the
5204 If such a declaration does not exist in
5212 \begin_inset Flex Code
5215 \begin_layout Plain Layout
5249 \begin_inset Flex Code
5252 \begin_layout Plain Layout
5266 \begin_layout Standard
5267 The following command produces causes äi to be produced when you enter acute-i
5271 \begin_layout LyX-Code
5285 \begin_layout Labeling
5286 \labelwidthstring 00.00.0000
5287 \begin_inset Flex Code
5290 \begin_layout Plain Layout
5296 Combine two accent characters
5299 \begin_layout LyX-Code
5305 accent1 accent2 allowed
5308 \begin_layout Standard
5309 This one is getting pretty esoteric.
5310 It allows you to combine the effect
5366 \begin_inset Flex Code
5369 \begin_layout Plain Layout
5397 \begin_layout Standard
5398 Consider this example from the
5399 \begin_inset Flex Code
5402 \begin_layout Plain Layout
5413 \begin_layout LyX-Code
5416 kmod ; acute aeioyvhAEIOYVH
5420 kcomb acute umlaut iyIY
5423 \begin_layout Standard
5424 This allows you to press
5425 \begin_inset Flex Noun
5428 \begin_layout Plain Layout
5436 and get the effect of
5437 \begin_inset Flex Code
5440 \begin_layout Plain Layout
5459 in this case cancels the last dead key, so if you press
5460 \begin_inset Flex Noun
5463 \begin_layout Plain Layout
5472 \begin_inset Flex Code
5475 \begin_layout Plain Layout
5488 \begin_layout Subsection
5492 \begin_layout Standard
5494 \begin_inset Flex Code
5497 \begin_layout Plain Layout
5505 mapping is performed, a
5506 \begin_inset Flex Code
5509 \begin_layout Plain Layout
5519 file maps the strings that the symbols generate to characters in the current
5521 The \SpecialChar LyX
5522 distribution currently includes at least the
5523 \begin_inset Flex Code
5526 \begin_layout Plain Layout
5535 \begin_inset Flex Code
5538 \begin_layout Plain Layout
5549 \begin_layout Standard
5551 \begin_inset Flex Code
5554 \begin_layout Plain Layout
5562 file is a sequence of declarations of the form
5565 \begin_layout LyX-Code
5578 \begin_layout Standard
5579 For example, in order to map
5580 \begin_inset Flex Noun
5583 \begin_layout Plain Layout
5593 to the corresponding character in the iso-8859-1 set (233), the following
5597 \begin_layout LyX-Code
5605 \begin_layout Standard
5607 \begin_inset Flex Code
5610 \begin_layout Plain Layout
5619 \begin_inset Flex Code
5622 \begin_layout Plain Layout
5640 the same character can apply to more than one string.
5642 \begin_inset Flex Code
5645 \begin_layout Plain Layout
5656 \begin_layout LyX-Code
5668 \begin_inset Newline newline
5684 \begin_layout Standard
5686 cannot find a mapping for the string produced by the keystroke or a
5687 deadkey sequence, it will check if it looks like an accented char and try
5688 to draw an accent over the character on screen.
5691 \begin_layout Subsection
5695 \begin_layout Standard
5696 There is a second way to add support for international characters through
5697 so-called dead-keys.
5698 A dead-key works in combination with a letter to produce an accented character.
5699 Here, we'll explain how to create a really simple dead-key to illustrate
5703 \begin_layout Standard
5704 Suppose you happen to need the circumflex character,
5705 \begin_inset Quotes eld
5709 \begin_inset Quotes erd
5714 \begin_inset Flex Noun
5717 \begin_layout Plain Layout
5724 \begin_inset space ~
5728 \begin_inset Flex Noun
5731 \begin_layout Plain Layout
5737 ] to the \SpecialChar LyX
5739 \begin_inset Flex Code
5742 \begin_layout Plain Layout
5749 \begin_inset Flex Code
5752 \begin_layout Plain Layout
5759 Now, whenever you type the
5760 \begin_inset Flex Noun
5763 \begin_layout Plain Layout
5769 -key followed by a letter, that letter will have a circumflex accent on
5771 For example, the sequence
5772 \begin_inset Quotes eld
5776 \begin_inset Flex Noun
5779 \begin_layout Plain Layout
5786 \begin_inset Quotes erd
5789 produces the letter:
5790 \begin_inset Quotes eld
5794 \begin_inset Quotes erd
5798 If you tried to type
5799 \begin_inset Quotes eld
5803 \begin_inset Flex Noun
5806 \begin_layout Plain Layout
5813 \begin_inset Quotes erd
5816 , however, \SpecialChar LyX
5817 will complain with a beep, since a
5818 \begin_inset Quotes eld
5822 \begin_inset Flex Noun
5825 \begin_layout Plain Layout
5832 \begin_inset Quotes erd
5835 never takes a circumflex accent.
5837 \begin_inset Flex Noun
5840 \begin_layout Plain Layout
5846 after a dead-key produces the bare-accent.
5847 Please note this last point! If you bind a key to a dead-key, you'll need
5848 to rebind the character on that key to yet another key.
5850 \begin_inset Flex Noun
5853 \begin_layout Plain Layout
5859 to a cedilla is a bad idea, since you'll only get cedillas instead of commas.
5862 \begin_layout Standard
5863 One common way to bind dead-keys is to use
5864 \begin_inset Flex Noun
5867 \begin_layout Plain Layout
5874 \begin_inset Flex Noun
5877 \begin_layout Plain Layout
5884 \begin_inset Flex Noun
5887 \begin_layout Plain Layout
5893 in combination with an accent, like
5894 \begin_inset Quotes eld
5898 \begin_inset Flex Noun
5901 \begin_layout Plain Layout
5908 \begin_inset Quotes erd
5912 \begin_inset Quotes eld
5916 \begin_inset Flex Noun
5919 \begin_layout Plain Layout
5926 \begin_inset Quotes erd
5930 \begin_inset Quotes eld
5934 \begin_inset Flex Noun
5937 \begin_layout Plain Layout
5944 \begin_inset Quotes erd
5948 Another way involves using
5949 \begin_inset Flex Code
5952 \begin_layout Plain Layout
5959 \begin_inset Flex Code
5962 \begin_layout Plain Layout
5968 to set up the special
5969 \begin_inset Flex Code
5972 \begin_layout Plain Layout
5980 \begin_inset Flex Code
5983 \begin_layout Plain Layout
5989 acts in some ways just like
5990 \begin_inset Flex Noun
5993 \begin_layout Plain Layout
5999 and permits you to bind keys to accented characters.
6000 You can also turn keys into dead-keys by binding them to something like
6002 \begin_inset Flex Code
6005 \begin_layout Plain Layout
6011 and then binding this symbolic key to the corresponding \SpecialChar LyX
6016 \begin_layout Plain Layout
6021 : This is exactly what I do in my
6022 \begin_inset Flex Code
6025 \begin_layout Plain Layout
6032 \begin_inset Flex Code
6035 \begin_layout Plain Layout
6043 \begin_inset Flex Noun
6046 \begin_layout Plain Layout
6048 \begin_inset space ~
6057 \begin_inset Flex Code
6060 \begin_layout Plain Layout
6066 and a bunch of these
6067 \begin_inset Quotes eld
6071 \begin_inset Flex Code
6074 \begin_layout Plain Layout
6081 \begin_inset Quotes erd
6084 symbolic keys bound such things as
6085 \begin_inset Flex Noun
6088 \begin_layout Plain Layout
6090 \begin_inset space ~
6099 \begin_inset Flex Noun
6102 \begin_layout Plain Layout
6104 \begin_inset space ~
6113 This is how I produce my accented characters.
6118 You can make just about anything into the
6119 \begin_inset Flex Code
6122 \begin_layout Plain Layout
6129 \begin_inset Flex Noun
6132 \begin_layout Plain Layout
6138 keys, a spare function key, etc.
6139 As for the \SpecialChar LyX
6140 commands that produce accents, check the entry for
6141 \begin_inset Flex Code
6144 \begin_layout Plain Layout
6155 You'll find the complete list there.
6158 \begin_layout Subsection
6159 Saving your Language Configuration
6162 \begin_layout Standard
6163 You can edit your preferences so that your desired language environment
6164 is automatically configured when \SpecialChar LyX
6166 \begin_inset Flex Noun
6169 \begin_layout Plain Layout
6170 Edit\SpecialChar menuseparator
6179 \begin_layout Chapter
6181 \change_inserted -584632292 1610232084
6184 Installing New Document Classes, Layouts, and Templates
6185 \begin_inset CommandInset label
6187 name "cha:Installing-New-Document"
6192 \begin_inset Argument 1
6195 \begin_layout Plain Layout
6196 Installing New Document Classes
6204 \begin_layout Standard
6205 In this chapter, we describe the procedures for creating and installing
6206 new \SpecialChar LyX
6207 layout and template files, as well as offer a refresher on correctly
6208 installing new \SpecialChar LaTeX
6213 \begin_layout Standard
6214 First, let us a say a few words about how one ought to think about the relation
6215 between \SpecialChar LyX
6216 and \SpecialChar LaTeX
6218 The thing to understand is that, in a certain sense, \SpecialChar LyX
6219 doesn't know anything
6220 about \SpecialChar LaTeX
6222 Indeed, from \SpecialChar LyX
6223 's point of view, \SpecialChar LaTeX
6224 is just one of several
6225 \begin_inset Quotes eld
6229 \begin_inset Quotes erd
6232 in which it is capable of producing output.
6233 Other such formats are DocBook, plaintext, and XHTML.
6235 is, of course, a particularly important format, but very little of the
6236 information \SpecialChar LyX
6237 has about \SpecialChar LaTeX
6238 is actually contained in the program itself.
6242 \begin_layout Plain Layout
6243 Some commands are sufficiently complex that they are
6244 \begin_inset Quotes eld
6248 \begin_inset Quotes erd
6251 into \SpecialChar LyX
6253 But the developers generally regard this as a Bad Thing.
6258 Rather, that information, even for the standard classes like
6259 \begin_inset Flex Code
6262 \begin_layout Plain Layout
6268 , is contained in `layout files'.
6269 Similarly, \SpecialChar LyX
6270 itself does not know much about DocBook or XHTML.
6271 What it knows is contained in layout files.
6274 \begin_layout Standard
6275 You can think of the layout file for a given document class as a translation
6276 manual between \SpecialChar LyX
6277 constructs—paragraphs with their corresponding styles,
6278 certain sorts of insets, etc—and the corresponding \SpecialChar LaTeX
6281 Almost everything \SpecialChar LyX
6283 \begin_inset Flex Code
6286 \begin_layout Plain Layout
6292 , for example, is contained in the file
6293 \begin_inset Flex Code
6296 \begin_layout Plain Layout
6302 and in various other files it includes.
6303 For this reason, anyone intending to write layout files should plan to
6304 study the existing files.
6305 A good place to start is with
6306 \begin_inset Flex Code
6309 \begin_layout Plain Layout
6315 , which is included in
6316 \begin_inset Flex Code
6319 \begin_layout Plain Layout
6326 \begin_inset Flex Code
6329 \begin_layout Plain Layout
6335 , and many of the other layout files for document classes.
6336 This file is where sections and the like are defined:
6337 \begin_inset Flex Code
6340 \begin_layout Plain Layout
6346 tells \SpecialChar LyX
6347 how paragraphs that are marked with the Section, Subsection, etc,
6348 styles can be translated into corresponding \SpecialChar LaTeX
6349 , DocBook, and XHTML commands
6352 \begin_inset Flex Code
6355 \begin_layout Plain Layout
6361 file basically just includes several of these
6362 \begin_inset Flex Code
6365 \begin_layout Plain Layout
6374 \begin_layout Standard
6375 Defining the \SpecialChar LyX
6377 correspondence is not the only thing layout files do, though.
6378 Their other job is to define how the \SpecialChar LyX
6379 constructs themselves will appear
6381 The fact that layout files have these two jobs is often a source of confusion,
6382 because they are completely separate.
6383 Telling \SpecialChar LyX
6384 how to translate a certain paragraph style into \SpecialChar LaTeX
6387 how to display it; conversely, telling \SpecialChar LyX
6388 how to display a certain paragraph
6389 style does not tell \SpecialChar LyX
6390 how to translate it into \SpecialChar LaTeX
6391 (let alone tell \SpecialChar LaTeX
6394 So, in general, when you define a new \SpecialChar LyX
6395 construct, you must always do two
6396 quite separate things: (i)
6397 \begin_inset space ~
6400 tell \SpecialChar LyX
6401 how to translate it into \SpecialChar LaTeX
6403 \begin_inset space ~
6406 tell \SpecialChar LyX
6410 \begin_layout Standard
6411 Much the same is true, of course, as regards \SpecialChar LyX
6412 's other backend formats, though
6413 XHTML is in some ways different, because in that case \SpecialChar LyX
6418 able, to some extent, to use information about how it should display a
6419 paragraph on the screen to output information (in the form of CSS) about
6420 how the paragraph should be displayed in a browser.
6421 Even in this case, however, the distinction between what \SpecialChar LyX
6423 and how things are rendered externally remains in force, and the two can
6424 be controlled separately.
6426 \begin_inset CommandInset ref
6428 reference "sec:Tags-for-XHTML"
6435 \begin_layout Section
6436 Installing new \SpecialChar LaTeX
6440 \begin_layout Standard
6441 Some installations may not include a \SpecialChar LaTeX
6442 package or class file that you would
6443 like to use within \SpecialChar LyX
6445 For example, you might need Foil\SpecialChar TeX
6446 , a package for preparing slides for overhead
6448 Modern \SpecialChar LaTeX
6449 distributions like \SpecialChar TeX
6450 Live (2008 or newer) or MiK\SpecialChar TeX
6451 provide a user interface
6452 for installing such packages.
6453 For example, with MiK\SpecialChar TeX
6454 , you start the program
6455 \begin_inset Quotes eld
6459 \begin_inset space ~
6463 \begin_inset Quotes erd
6466 to get a list of available packages.
6467 To install one of them, right click on it or use the corresponding toolbar
6471 \begin_layout Standard
6472 If your \SpecialChar LaTeX
6473 distribution does not provide such a `package manager', or if the
6474 package is not available from your distribution, then follow these steps
6475 to install it manually:
6478 \begin_layout Enumerate
6479 Get the package from
6480 \begin_inset CommandInset href
6483 target "http://www.ctan.org/"
6491 \begin_layout Enumerate
6492 If the package contains a file with the ending
6493 \begin_inset Quotes eld
6497 \begin_inset Flex Code
6500 \begin_layout Plain Layout
6507 \begin_inset Quotes erd
6510 (is the case for Foil\SpecialChar TeX
6511 ) then open a console, change to the folder of this
6512 file and execute the command
6513 \begin_inset Flex Code
6516 \begin_layout Plain Layout
6523 You have now unpacked the package and have all files to install it.
6524 Most \SpecialChar LaTeX
6525 -packages are not packed and you can skip this step.
6528 \begin_layout Enumerate
6529 Now you need to decide if the package should be available for all users
6534 \begin_layout Enumerate
6535 On *nix systems (Linux, OSX, etc.), if you want the new package to be available
6536 for all users on your system, then install it in your `local' \SpecialChar TeX
6538 install it in your own `user' \SpecialChar TeX
6540 Where these trees should be created, if they do not already exist, depends
6542 To find this out, look in the file
6543 \begin_inset Flex Code
6546 \begin_layout Plain Layout
6556 \begin_layout Plain Layout
6557 This is usually in the directory
6558 \begin_inset Flex Code
6561 \begin_layout Plain Layout
6567 , though you can execute the command
6568 \begin_inset Flex Code
6571 \begin_layout Plain Layout
6582 The location of the `local' \SpecialChar TeX
6583 tree is defined by the
6584 \begin_inset Flex Code
6587 \begin_layout Plain Layout
6593 variable; this is usually somewhere like
6594 \begin_inset Flex Code
6597 \begin_layout Plain Layout
6598 /usr/local/share/texmf
6603 or /usr/local/texlive/XXXX where XXXX is the year of the installed \SpecialChar TeX
6606 The location of the `user' \SpecialChar TeX
6608 \begin_inset Flex Code
6611 \begin_layout Plain Layout
6618 \begin_inset Flex Code
6621 \begin_layout Plain Layout
6628 \begin_inset Flex Code
6631 \begin_layout Plain Layout
6640 (If these variables are not predefined, you have to define them.) You'll
6641 probably need root permissions to create or modify the `local' tree, but
6642 not for your `user' tree.
6643 \begin_inset Newline newline
6646 In general, it is recommended to install in the user tree because your user
6647 will not be modified or even overwritten when you upgrade your system.
6648 It will typically also be backed up together with everything else when
6649 you backup your home directory (which, of course, you do on a regular basis).
6652 \begin_layout Enumerate
6653 On Windows, if you want the new package to be available for all users on
6654 your system, change to the folder where \SpecialChar LaTeX
6655 is installed and then change to
6657 \begin_inset Flex Code
6660 \begin_layout Plain Layout
6671 (For MiK\SpecialChar TeX
6672 , this would be by default the folder
6673 \begin_inset Flex Code
6676 \begin_layout Plain Layout
6694 \begin_layout Plain Layout
6695 Note that this will be the correct path only on English installations.
6696 On a German one, it would be
6697 \begin_inset Flex Code
6700 \begin_layout Plain Layout
6714 , and similarly for other languages.
6719 Create there a new folder
6720 \begin_inset Flex Code
6723 \begin_layout Plain Layout
6729 and copy all files of the package into it.
6731 \begin_inset Newline newline
6734 If the package should only available for you or you don't have admin permissions
6735 , do the same, but in the local \SpecialChar LaTeX
6738 \begin_inset space \thinspace{}
6741 g., for MiK\SpecialChar TeX
6743 \begin_inset space ~
6746 2.8 under Windows XP, this would be the folder:
6747 \begin_inset Newline newline
6753 \begin_inset Flex Code
6756 \begin_layout Plain Layout
6759 Documents and Settings
6771 \begin_inset Newline newline
6777 \begin_inset Phantom HPhantom
6780 \begin_layout Plain Layout
6791 \begin_inset Flex Code
6794 \begin_layout Plain Layout
6807 \begin_inset Newline newline
6810 On Vista, it would be:
6811 \begin_inset Newline newline
6815 \begin_inset Flex Code
6818 \begin_layout Plain Layout
6844 \begin_layout Enumerate
6845 Now one only need to tell \SpecialChar LaTeX
6846 that there are new files.
6847 This depends on the used \SpecialChar LaTeX
6852 \begin_layout Enumerate
6853 For \SpecialChar TeX
6854 Live execute the command
6855 \begin_inset Flex Code
6858 \begin_layout Plain Layout
6865 If you installed the package for all users, then you will probably need
6866 to have root permissions for that.
6869 \begin_layout Enumerate
6870 For MiK\SpecialChar TeX
6871 , if you have installed the package for all users, start the program
6873 \begin_inset Quotes eld
6877 \begin_inset space ~
6881 \begin_inset Quotes erd
6884 and press the button marked
6885 \begin_inset Quotes eld
6889 \begin_inset Quotes erd
6893 Otherwise start the program
6894 \begin_inset Quotes eld
6898 \begin_inset Quotes erd
6905 \begin_layout Enumerate
6906 Finally, you need to tell \SpecialChar LyX
6907 that there are new packages available.
6908 So, in \SpecialChar LyX
6910 \begin_inset Flex Noun
6913 \begin_layout Plain Layout
6916 \SpecialChar menuseparator
6922 and then restart \SpecialChar LyX
6926 \begin_layout Standard
6927 Now the package is installed.
6928 In our example, the document class
6929 \begin_inset Flex Code
6932 \begin_layout Plain Layout
6938 will now be available under
6939 \begin_inset Flex Noun
6942 \begin_layout Plain Layout
6943 Document\SpecialChar menuseparator
6944 Settings\SpecialChar menuseparator
6951 \begin_inset Quotes eld
6955 \begin_inset Quotes erd
6962 \begin_layout Standard
6963 If you would like to use a \SpecialChar LaTeX
6964 document class that is not even listed in the
6966 \begin_inset Flex Noun
6969 \begin_layout Plain Layout
6970 Document\SpecialChar menuseparator
6971 Settings\SpecialChar menuseparator
6977 , then you need to create a `layout' file for it.
6978 That is the topic of the next section.
6981 \begin_layout Section
6982 Types of layout files
6985 \begin_layout Standard
6986 This section describes the various sorts of \SpecialChar LyX
6987 files that contain layout informati
6989 These files describe various paragraph and character styles, determining
6990 how \SpecialChar LyX
6991 should display them and how they should be translated into \SpecialChar LaTeX
6993 XHTML, or whatever output format is being used.
6997 \begin_layout Standard
6998 We shall try to provide a thorough description of the process of writing
7000 However, there are so many different types of documents supported even
7001 by just \SpecialChar LaTeX
7002 that we can't hope to cover every different possibility or problem
7003 you might encounter.
7004 The \SpecialChar LyX
7005 users' list is frequented by people with lots of experience with layout
7006 design who are willing to share what they've learned, so please feel free
7007 to ask questions there.
7010 \begin_layout Standard
7011 As you prepare to write a new layout, it is extremely helpful to look at
7012 the layouts distributed with \SpecialChar LyX
7014 If you write a \SpecialChar LyX
7015 layout for a \SpecialChar LaTeX
7016 document class that might also be used by
7017 others, or write a module that might be useful to others, then you should
7018 consider posting your layout to the
7019 \begin_inset CommandInset href
7021 name "layout section on the LyX wiki"
7022 target "https://wiki.lyx.org/Layouts/Layouts"
7027 or even to the \SpecialChar LyX
7028 developers' list, so that it might be included in \SpecialChar LyX
7033 \begin_layout Plain Layout
7034 Note that \SpecialChar LyX
7035 is licensed under the General Public License, so any material
7036 that is contributed to \SpecialChar LyX
7037 must be similarly licensed.
7045 \begin_layout Subsection
7047 \begin_inset CommandInset label
7049 name "subsec:Layout-modules"
7056 \begin_layout Standard
7057 We have spoken to this point about `layout files'.
7058 But there are different sorts of files that contain layout information.
7059 Layout files, strictly so called, have the
7060 \begin_inset Flex Code
7063 \begin_layout Plain Layout
7069 extension and provide \SpecialChar LyX
7070 with information about document classes.
7071 Since \SpecialChar LyX
7072 1.6 layout information can also be contained in layout
7077 \begin_inset Flex Code
7080 \begin_layout Plain Layout
7087 Modules are to \SpecialChar LaTeX
7088 packages much as layouts are to \SpecialChar LaTeX
7089 classes, and some modules—such
7091 \begin_inset Flex Code
7094 \begin_layout Plain Layout
7100 module—specifically provide support for one package.
7101 In a sense, layout modules are similar to included
7105 \begin_layout Plain Layout
7106 These can have any extension, but by convention have the
7107 \begin_inset Flex Code
7110 \begin_layout Plain Layout
7122 \begin_inset Flex Code
7125 \begin_layout Plain Layout
7131 —in that modules are not specific to a given document class but may be used
7132 with many different classes.
7133 The difference is that using an included file with
7134 \begin_inset Flex Code
7137 \begin_layout Plain Layout
7143 requires editing that file.
7144 Modules, by contrast, are selected in the
7145 \begin_inset Flex Noun
7148 \begin_layout Plain Layout
7149 Document\SpecialChar menuseparator
7158 \begin_layout Standard
7159 Building modules is the easiest way to get started with layout editing,
7160 since it can be as simple as adding a single new paragraph style or flex
7162 But modules may, in principle, contain anything a layout file can contain.
7165 \begin_layout Standard
7166 After creating a new module and copying it to the
7167 \begin_inset Flex Code
7170 \begin_layout Plain Layout
7176 folder, you will need to reconfigure and then restart \SpecialChar LyX
7179 However, changes you make to the module will be seen immediately, if you
7181 \begin_inset Flex Noun
7184 \begin_layout Plain Layout
7185 Document\SpecialChar menuseparator
7191 , highlight something, and then hit
7192 \begin_inset Quotes eld
7196 \begin_inset Quotes erd
7202 It is strongly recommended that you save your work before doing this
7207 it is strongly recommended that you not attempt to edit modules while simultaneo
7208 usly working on actual documents
7211 Though of course the developers strive to keep \SpecialChar LyX
7212 stable in such situations,
7213 syntax errors and the like in your module file could cause strange behavior.
7216 \begin_layout Subsubsection
7220 \begin_layout Standard
7221 Modules are to \SpecialChar LyX
7222 as packages are to \SpecialChar LaTeX
7224 Sometimes, however, you find yourself wanting a specific inset or character
7225 style just for one document and writing a module that will also be available
7226 to other documents makes little sense.
7227 What you need is \SpecialChar LyX
7229 \begin_inset Quotes eld
7233 \begin_inset Quotes erd
7239 \begin_layout Standard
7240 You will find it under
7242 Document\SpecialChar menuseparator
7243 Settings\SpecialChar menuseparator
7247 The large text box allows you to enter anything that you might enter in
7248 a layout file or module.
7249 You can think of a document's local layout, in fact, as a module that belongs
7251 So, in particular, you must enter a
7252 \begin_inset Flex Code
7255 \begin_layout Plain Layout
7262 Any format is acceptable, but one would normally use the format current
7264 (In \SpecialChar LyX
7271 , the current layout format is
7280 \begin_layout Standard
7281 When you have entered something in the
7282 \begin_inset Flex Code
7285 \begin_layout Plain Layout
7291 pane, \SpecialChar LyX
7293 \begin_inset Quotes eld
7297 \begin_inset Quotes erd
7300 button at the bottom.
7301 Clicking this button will cause \SpecialChar LyX
7302 to determine whether what you have entered
7303 is valid layout information for the chosen format.
7305 will report the result but, unfortunately, will not tell you what errors
7306 there might have been.
7307 These will be written to the terminal, however, if \SpecialChar LyX
7308 is started from a terminal.
7309 You will not be permitted to save your local layout until you have entered
7313 \begin_layout Standard
7314 The warnings at the end of the previous section apply here, too.
7315 Do not play with local layout while you are actually working, especially
7316 if you have not saved your document.
7317 That said, using local layout with a test document can be a very convenient
7318 way to try out layout ideas, or even to start developing a module.
7321 \begin_layout Subsection
7323 \begin_inset Flex Noun
7326 \begin_layout Plain Layout
7335 \begin_layout Standard
7336 There are two situations you are likely to encounter when wanting to support
7337 a new \SpecialChar LaTeX
7338 document class, involving style (
7339 \begin_inset Flex Code
7342 \begin_layout Plain Layout
7348 ) files and \SpecialChar LaTeX2e
7350 \begin_inset Flex Code
7353 \begin_layout Plain Layout
7360 Supporting a style file is usually fairly easy.
7361 Supporting a new class file is a bit harder.
7362 We'll discuss the former in this section and the latter in the next.
7364 \change_deleted 5863208 1594239023
7365 Similar remarks apply, of course, if you want to support a new DocBook DTD.
7370 \begin_layout Standard
7371 The easier case is the one in which your new document class is provided
7372 as a style file that is to be used in conjunction with an already supported
7374 For the sake of the example, we'll assume that the style file is called
7376 \begin_inset Flex Noun
7379 \begin_layout Plain Layout
7385 and that it is meant to be used with
7386 \begin_inset Flex Noun
7389 \begin_layout Plain Layout
7395 , which is a standard class.
7399 \begin_layout Standard
7400 Start by copying the existing class's layout file into your local directory:
7404 \begin_layout Plain Layout
7405 Of course, which directory is your local directory will vary by platform,
7406 and \SpecialChar LyX
7407 allows you to specify your local directory on startup, too, using
7409 \begin_inset Flex Code
7412 \begin_layout Plain Layout
7426 \begin_layout LyX-Code
7427 cp report.layout ~/.lyx/layouts/myclass.layout
7430 \begin_layout Standard
7432 \begin_inset Flex Code
7435 \begin_layout Plain Layout
7441 and change the line:
7444 \begin_layout LyX-Code
7447 DeclareLaTeXClass{Report (Standard Class)}
7450 \begin_layout Standard
7454 \begin_layout LyX-Code
7457 DeclareLaTeXClass[report, myclass.sty]{Report (My Class)}
7460 \begin_layout Standard
7464 \begin_layout LyX-Code
7466 \begin_inset Newline newline
7472 \begin_inset Newline newline
7478 \begin_layout Standard
7479 near the top of the file.
7482 \begin_layout Standard
7483 Start \SpecialChar LyX
7485 \begin_inset Flex Noun
7488 \begin_layout Plain Layout
7489 Tools\SpecialChar menuseparator
7496 Then restart \SpecialChar LyX
7497 and try creating a new document.
7499 \begin_inset Flex Noun
7502 \begin_layout Plain Layout
7508 " as a document class option in the
7509 \begin_inset Flex Noun
7512 \begin_layout Plain Layout
7513 Document\SpecialChar menuseparator
7520 It is likely that some of the sectioning commands and such in your new
7521 class will work differently from how they worked in the base class—
7522 \begin_inset Flex Code
7525 \begin_layout Plain Layout
7531 in this example—so you can fiddle around with the settings for the different
7532 sections if you wish.
7533 The layout information for sections is contained in
7534 \begin_inset Flex Code
7537 \begin_layout Plain Layout
7543 , but you do not need to copy and change this file.
7544 Instead, you can simply add your changes to your layout file, after the
7546 \begin_inset Flex Code
7549 \begin_layout Plain Layout
7555 , which itself includes
7556 \begin_inset Flex Code
7559 \begin_layout Plain Layout
7566 For example, you might add these lines:
7569 \begin_layout LyX-Code
7573 \begin_layout LyX-Code
7577 \begin_layout LyX-Code
7581 \begin_layout LyX-Code
7585 \begin_layout LyX-Code
7589 \begin_layout Standard
7590 to change the font for chapter headings to sans-serif.
7591 This will override (or, in this case, add to) the existing declaration
7592 for the Chapter style.
7596 \begin_layout Standard
7597 Your new package may also provide commands or environments not present in
7599 In this case, you will want to add these to the layout file.
7601 \begin_inset CommandInset ref
7603 reference "sec:TextClass"
7607 for information on how to do so.
7610 \begin_layout Standard
7612 \begin_inset Flex Noun
7615 \begin_layout Plain Layout
7621 can be used with several different document classes, and even if it cannot,
7622 you might find it easiest just to write a module that you can load with
7624 The simplest possible such module would be:
7627 \begin_layout LyX-Code
7630 DeclareLyXModule{My Class}
7633 \begin_layout LyX-Code
7637 \begin_layout LyX-Code
7638 #Support for myclass.sty.
7641 \begin_layout LyX-Code
7643 \begin_inset Newline newline
7649 \begin_layout LyX-Code
7657 \begin_inset Newline newline
7663 \begin_layout LyX-Code
7665 \begin_inset Newline newline
7671 \begin_inset Newline newline
7677 \begin_layout Standard
7678 A more complex module might modify the behavior of some existing constructs
7679 or define some new ones.
7681 \begin_inset CommandInset ref
7683 reference "sec:TextClass"
7690 \begin_layout Subsection
7692 \begin_inset Flex Noun
7695 \begin_layout Plain Layout
7704 \begin_layout Standard
7705 There are two possibilities here.
7706 One is that the class file is itself based upon an existing document class.
7707 For example, many thesis classes are based upon
7708 \begin_inset Flex Noun
7711 \begin_layout Plain Layout
7718 To see whether yours is, look for a line like
7721 \begin_layout LyX-Code
7727 \begin_layout Standard
7729 If so, then you may proceed largely as in the previous section, though
7731 \begin_inset Flex Code
7734 \begin_layout Plain Layout
7735 Declare\SpecialChar LaTeX
7741 line will be different.
7742 If your new class is
7743 \begin_inset Flex Code
7746 \begin_layout Plain Layout
7752 and it is based upon
7753 \begin_inset Flex Code
7756 \begin_layout Plain Layout
7762 , then the line should read:
7766 \begin_layout Plain Layout
7767 And it will be easiest if you save the file to
7768 \begin_inset Flex Code
7771 \begin_layout Plain Layout
7778 assumes that the document class has the same name as the layout file.
7787 \begin_layout LyX-Code
7790 DeclareLaTeXClass[thesis,book]{thesis}
7793 \begin_layout Standard
7794 If, on the other hand, the new class is not based upon an existing class,
7795 you will probably have to
7796 \begin_inset Quotes eld
7800 \begin_inset Quotes erd
7804 We strongly suggest copying an existing layout file which uses a similar
7806 class and then modifying it, if you can do so.
7807 At least use an existing file as a starting point so you can find out what
7808 items you need to worry about.
7809 Again, the specifics are covered below.
7812 \begin_layout Subsection
7814 \begin_inset CommandInset label
7816 name "subsec:Creating-Templates"
7823 \begin_layout Standard
7824 Once you have written a layout file for a new document class, you might
7825 want to consider writing a
7830 A template acts as a kind of tutorial for your layout, showing how it might
7831 be used, though containing dummy content.
7832 You can of course look at the various templates included with \SpecialChar LyX
7836 \begin_layout Standard
7837 Templates are created just like usual documents: using \SpecialChar LyX
7839 The only difference is that usual documents contain all possible settings,
7840 including the font scheme and the paper size.
7841 Usually a user doesn't want a template to overwrite his preferred settings
7842 for such parameters.
7843 For that reason, the designer of a template should remove the corresponding
7845 \begin_inset Flex Code
7848 \begin_layout Plain Layout
7857 \begin_inset Flex Code
7860 \begin_layout Plain Layout
7868 from the template \SpecialChar LyX
7870 This can be done with any simple text-editor, for example
7871 \begin_inset Flex Code
7874 \begin_layout Plain Layout
7881 \begin_inset Flex Code
7884 \begin_layout Plain Layout
7893 \begin_layout Standard
7894 Put the edited template files you create in
7895 \begin_inset Flex Code
7898 \begin_layout Plain Layout
7904 , copy the ones you use from the global template directory in
7905 \begin_inset Flex Code
7908 \begin_layout Plain Layout
7914 to the same place, and redefine the template path in the
7915 \begin_inset Flex Noun
7918 \begin_layout Plain Layout
7919 Tools\SpecialChar menuseparator
7920 Preferences\SpecialChar menuseparator
7929 \begin_layout Standard
7930 Note, by the way, that there is a template which has a particular meaning:
7931 \begin_inset Newline linebreak
7935 \begin_inset Flex Code
7938 \begin_layout Plain Layout
7945 This template is loaded every time you create a new document with
7946 \begin_inset Flex Noun
7949 \begin_layout Plain Layout
7950 File\SpecialChar menuseparator
7956 in order to provide useful defaults.
7957 To create this template from inside \SpecialChar LyX
7958 , all you have to do is to open a document
7959 with the correct settings, and use the
7960 \begin_inset Flex Noun
7963 \begin_layout Plain Layout
7964 Save as Document Defaults
7972 \begin_layout Subsection
7973 Upgrading old layout files
7976 \begin_layout Standard
7977 The format of layout files changes with each \SpecialChar LyX
7978 release, so old layout files
7979 need to be converted to the new format.
7981 reads a layout file in an older format, it automatically calls the
7983 \begin_inset Flex Code
7986 \begin_layout Plain Layout
7992 to convert it to a temporary file in current format.
7993 The original file is left untouched.
7994 If you use the layout file often, then, you may want to convert it permanently,
7995 so that \SpecialChar LyX
7996 does not have to do so itself every time.
7997 To do this, you can call the converter manually:
8000 \begin_layout Enumerate
8002 \begin_inset Flex Code
8005 \begin_layout Plain Layout
8012 \begin_inset Flex Code
8015 \begin_layout Plain Layout
8024 \begin_layout Enumerate
8026 \begin_inset Newline newline
8030 \begin_inset Flex Code
8033 \begin_layout Plain Layout
8034 python LyXDir/scripts/layout2layout.py myclass.old myclass.layout
8040 \begin_inset Newline newline
8044 \begin_inset Flex Code
8047 \begin_layout Plain Layout
8053 is the name of your \SpecialChar LyX
8057 \begin_layout Standard
8058 Note that manual conversion does not affect included files, so these will
8059 have to be converted separately.
8062 \begin_layout Subsection
8063 \begin_inset CommandInset label
8065 name "subsec:Cite-Engine-Files"
8072 \begin_layout Standard
8073 A specific form of layout files are the so-called
8074 \begin_inset Flex Code
8077 \begin_layout Plain Layout
8083 files that are located in the
8084 \begin_inset Flex Code
8087 \begin_layout Plain Layout
8094 Their purpose is to define the specifics of \SpecialChar LaTeX
8095 packages aimed at bibliography
8108 , but also the way how normal Bib\SpecialChar TeX
8109 citations (without additional packages)
8110 are handled in \SpecialChar LyX
8111 is defined in such a file.
8115 \begin_layout Standard
8116 More specifically, it is defined which packages \SpecialChar LyX
8117 needs to load, which citation
8118 commands are available, how these are to be displayed in \SpecialChar LyX
8120 the dialogs, the context menus) as well as in the XHTML and plain text
8122 Furthermore, the files specify available style variants (author-year, numerical
8123 , etc.) and their specifics.
8124 The cite engine files are also used to generate the options that are available
8127 Document\SpecialChar menuseparator
8128 Settings\SpecialChar menuseparator
8129 Bibliography\SpecialChar menuseparator
8135 \begin_layout Standard
8136 Even though a cite engine file is essentially a normal layout file that
8137 could theoretically include any layout information, it usually primarily
8138 includes some specific parameters such as
8139 \begin_inset Flex Code
8142 \begin_layout Plain Layout
8149 \begin_inset Flex Code
8152 \begin_layout Plain Layout
8159 \begin_inset Flex Code
8162 \begin_layout Plain Layout
8169 \begin_inset Flex Code
8172 \begin_layout Plain Layout
8179 The syntax of the latter two is described in
8180 \begin_inset CommandInset ref
8182 reference "subsec:Citation-engine-description"
8190 \begin_inset CommandInset ref
8192 reference "subsec:Citation-format-description"
8196 , as well as in the files themselves.
8199 \begin_layout Section
8200 \begin_inset CommandInset label
8202 name "sec:TextClass"
8206 The layout file format
8209 \begin_layout Standard
8210 The following sections describe how layout files are structured and written.
8211 Our advice is to go slowly, save and test often.
8212 It is really not that hard, except that the multitude of options can become
8213 overwhelming, especially if you try to check out too many at once.
8214 It becomes easier if you use existing layouts of \SpecialChar LyX
8215 as examples/reference
8216 or if you modify an existing layout to your needs.
8219 \begin_layout Standard
8220 Note that all the tags used in layout files are case-insensitive.
8222 \begin_inset Flex Code
8225 \begin_layout Plain Layout
8232 \begin_inset Flex Code
8235 \begin_layout Plain Layout
8242 \begin_inset Flex Code
8245 \begin_layout Plain Layout
8251 are really the same tag.
8252 The possible arguments are printed in brackets after the tag's name.
8253 The default argument is typeset
8254 \begin_inset Flex Code
8257 \begin_layout Plain Layout
8266 If the argument has a data type like
8267 \begin_inset Quotes eld
8271 \begin_inset Quotes erd
8275 \begin_inset Quotes eld
8279 \begin_inset Quotes erd
8282 , the default is shown like this:
8283 \begin_inset Flex Code
8286 \begin_layout Plain Layout
8297 \begin_layout Subsection
8298 The document class declaration and classification
8301 \begin_layout Standard
8302 Lines in a layout file which begin with
8303 \begin_inset Flex Code
8306 \begin_layout Plain Layout
8313 There is one exception to this rule.
8315 \begin_inset Flex Code
8318 \begin_layout Plain Layout
8324 files should begin with lines like:
8327 \begin_layout LyX-Code
8330 #% Do not delete the line below; configure depends on this
8333 \begin_layout LyX-Code
8338 DeclareLaTeXClass{Article (Standard Class)}
8341 \begin_layout LyX-Code
8346 DeclareCategory{Articles}
8349 \begin_layout Standard
8350 The second and third lines are used when you (re)configure \SpecialChar LyX
8352 The layout file is read by the \SpecialChar LaTeX
8354 \begin_inset Flex Code
8357 \begin_layout Plain Layout
8363 , in a special mode where
8364 \begin_inset Flex Code
8367 \begin_layout Plain Layout
8374 The first line is just a \SpecialChar LaTeX
8375 comment, the second one contains the mandatory
8376 declaration of the text class and the third line contains the optional
8377 classification of the class.
8378 If these lines appear in a file named
8379 \begin_inset Flex Code
8382 \begin_layout Plain Layout
8388 , then they define a text class of name
8389 \begin_inset Flex Code
8392 \begin_layout Plain Layout
8398 (the name of the layout file) which uses the \SpecialChar LaTeX
8400 \begin_inset Flex Code
8403 \begin_layout Plain Layout
8409 (the default is to use the same name as the layout).
8411 \begin_inset Quotes eld
8414 Article (Standard Class)
8415 \begin_inset Quotes erd
8418 that appears above is used as a description of the text class in the
8419 \begin_inset Flex Noun
8422 \begin_layout Plain Layout
8423 Document\SpecialChar menuseparator
8431 \begin_inset Quotes eld
8435 \begin_inset Quotes erd
8438 in the example) is also used in the
8439 \begin_inset Flex Noun
8442 \begin_layout Plain Layout
8443 Document\SpecialChar menuseparator
8449 dialog: the text classes are grouped by these categories (which are usually
8450 genres, so typical categories are
8451 \begin_inset Quotes eld
8455 \begin_inset Quotes erd
8459 \begin_inset Quotes eld
8463 \begin_inset Quotes erd
8467 \begin_inset Quotes eld
8471 \begin_inset Quotes erd
8475 \begin_inset Quotes eld
8479 \begin_inset Quotes erd
8483 \begin_inset Quotes eld
8487 \begin_inset Quotes erd
8491 \begin_inset Quotes eld
8495 \begin_inset Quotes erd
8499 If no category has been declared, the class will be put in the
8500 \begin_inset Quotes eld
8504 \begin_inset Quotes erd
8510 \begin_layout Standard
8511 Let's assume that you wrote your own text class that uses the
8512 \begin_inset Flex Code
8515 \begin_layout Plain Layout
8521 document class, but where you changed the appearance of the section headings.
8522 If you put it in a file
8523 \begin_inset Flex Code
8526 \begin_layout Plain Layout
8532 , the header of this file should be:
8535 \begin_layout LyX-Code
8538 #% Do not delete the line below; configure depends on this
8541 \begin_layout LyX-Code
8546 DeclareLaTeXClass[article]{Article (with My Own Headings)}
8549 \begin_layout LyX-Code
8554 DeclareCategory{Articles}
8557 \begin_layout Standard
8558 This declares a text class
8559 \begin_inset Flex Code
8562 \begin_layout Plain Layout
8568 , associated with the \SpecialChar LaTeX
8570 \begin_inset Flex Code
8573 \begin_layout Plain Layout
8580 \begin_inset Quotes eld
8583 Article (with My Own Headings)
8584 \begin_inset Quotes erd
8588 If your text class depends on several packages, you can declare it as:
8591 \begin_layout LyX-Code
8594 #% Do not delete the line below; configure depends on this
8597 \begin_layout LyX-Code
8602 DeclareLaTeXClass[article,foo.sty]{Article (with My Own Headings)}
8605 \begin_layout LyX-Code
8610 DeclareCategory{Articles}
8613 \begin_layout Standard
8614 This indicates that your text class uses the
8615 \begin_inset Flex Code
8618 \begin_layout Plain Layout
8626 \change_deleted 5863208 1594239179
8627 Finally, it is also possible to declare classes for DocBook code.
8628 Typical declarations will look like:
8631 \begin_layout LyX-Code
8633 \change_deleted 5863208 1594239179
8636 #% Do not delete the line below; configure depends on this
8639 \begin_layout LyX-Code
8641 \change_deleted 5863208 1594239179
8646 DeclareDocBookClass[article]{SGML (DocBook Article)}
8649 \begin_layout LyX-Code
8651 \change_deleted 5863208 1594239179
8656 DeclareCategory{Articles (DocBook)}
8661 \begin_layout Standard
8662 Note that these declarations can also be given an optional parameter declaring
8663 the name of the document class (but not a list).
8666 \begin_layout Standard
8667 So, to be as explicit as possible, the form of the layout declaration is:
8670 \begin_layout LyX-Code
8675 DeclareLaTeXClass[class,package.sty]{layout description}
8678 \begin_layout LyX-Code
8683 DeclareCategory{category}
8686 \begin_layout Standard
8687 The class need only be specified if the name of the \SpecialChar LaTeX
8689 name of the layout file are different or if there are packages to load.
8690 If the name of the class file is not specified, then \SpecialChar LyX
8692 that it is the same as the name of the layout file.
8695 \begin_layout Standard
8696 When the text class has been modified to your taste, all you have to do
8697 is to copy it either to
8698 \begin_inset Flex Code
8701 \begin_layout Plain Layout
8708 \begin_inset Flex Code
8711 \begin_layout Plain Layout
8718 \begin_inset Flex Noun
8721 \begin_layout Plain Layout
8722 Tools\SpecialChar menuseparator
8728 , exit \SpecialChar LyX
8730 Then your new text class should be available along with the others.
8733 \begin_layout Standard
8734 Once the layout file is installed, you can edit it and see your changes
8735 without having to reconfigure or to restart \SpecialChar LyX
8740 \begin_layout Plain Layout
8741 In versions of \SpecialChar LyX
8742 prior to 1.6, this was not true.
8743 As a result, editing layout files was very time consuming, since you had
8744 constantly to restart \SpecialChar LyX
8750 You can force a reload of the current layout by using the \SpecialChar LyX
8752 \begin_inset Flex Noun
8755 \begin_layout Plain Layout
8762 There is no default binding for this function—though, of course, you can
8763 bind it to a key yourself.
8764 But you will normally use this function simply by entering it in the mini-buffe
8769 \begin_layout Standard
8775 \begin_inset Flex Noun
8778 \begin_layout Plain Layout
8784 is very much an `advanced feature'.
8789 recommended that you save your work before using this function.
8794 recommended that you not attempt to edit layout information while simultaneousl
8795 y working on a document that you care about.
8796 Use a test document.
8797 Syntax errors and the like in your layout file could cause peculiar behavior.
8798 In particular, such errors could cause \SpecialChar LyX
8799 to regard the current layout as
8800 invalid and to attempt to switch to some other layout.
8804 \begin_layout Plain Layout
8805 Really bad syntax errors may even caused \SpecialChar LyX
8807 This is because certain sorts of errors may make \SpecialChar LyX
8818 The \SpecialChar LyX
8819 team strives to keep \SpecialChar LyX
8820 stable in such situations, but safe is better
8825 \begin_layout Plain Layout
8826 While we're giving advice: make regular backups.
8827 And be nice to your mother.
8835 \begin_layout Subsection
8836 The Module declaration
8839 \begin_layout Standard
8840 A module must begin with a line like the following:
8843 \begin_layout LyX-Code
8846 DeclareLyXModule[endnotes.sty]{Endnotes}
8847 \change_inserted -712698321 1554395911
8851 \begin_layout LyX-Code
8853 \change_inserted -712698321 1554395924
8858 DeclareCategory{Foot- and Endnotes}
8859 \change_deleted -712698321 1554395911
8867 \begin_layout Standard
8868 The mandatory argument
8869 \change_inserted -712698321 1554395956
8878 , in curly brackets, is the name of the module, as it should appear in
8879 \begin_inset Flex Noun
8882 \begin_layout Plain Layout
8883 Document\SpecialChar menuseparator
8884 Settings\SpecialChar menuseparator
8891 The argument in square brackets is optional: It declares any \SpecialChar LaTeX
8893 on which the module depends.
8894 It is also possible to use the form
8895 \begin_inset Flex Noun
8898 \begin_layout Plain Layout
8904 as an optional argument, which declares that the module can only be used
8905 when there exists a conversion chain between the formats `
8906 \begin_inset Flex Code
8909 \begin_layout Plain Layout
8916 \begin_inset Flex Code
8919 \begin_layout Plain Layout
8927 \change_inserted -712698321 1554396133
8934 declaration is not strictly mandatory, but you should add it, since it
8935 is helpful to find the module.
8936 Please have a look at the existing module categories and if appropriate,
8942 \begin_layout Standard
8944 \change_inserted -712698321 1554395988
8947 declaration should then be followed by lines like the following:
8951 \begin_layout Plain Layout
8952 Preferably in English if the module should be published with \SpecialChar LyX
8954 This description will appear in the list of messages to be translated and
8955 will be thus translated with the next interface update.
8963 \begin_layout LyX-Code
8967 \begin_layout LyX-Code
8968 #Adds an endnote command, in addition to footnotes.
8972 \begin_layout LyX-Code
8973 #You will need to add
8975 theendnotes in TeX code where you
8978 \begin_layout LyX-Code
8979 #want the endnotes to appear.
8983 \begin_layout LyX-Code
8987 \begin_layout LyX-Code
8988 #Requires: somemodule | othermodule
8991 \begin_layout LyX-Code
8992 #Excludes: badmodule
8995 \begin_layout Standard
8996 The description is used in
8997 \begin_inset Flex Noun
9000 \begin_layout Plain Layout
9001 Document\SpecialChar menuseparator
9002 Settings\SpecialChar menuseparator
9008 to provide the user with information about what the module does.
9010 \begin_inset Flex Code
9013 \begin_layout Plain Layout
9019 line is used to identify other modules with which this one must be used;
9021 \begin_inset Flex Code
9024 \begin_layout Plain Layout
9030 line is used to identify modules with which this one may not be used.
9031 Both are optional, and, as shown, multiple modules should be separated
9032 with the pipe symbol: |.
9033 Note that the required modules are treated disjunctively:
9037 of the required modules must be used.
9042 excluded module may be used.
9043 Note that modules are identified here by their filenames without the
9044 \begin_inset Flex Code
9047 \begin_layout Plain Layout
9055 \begin_inset Flex Code
9058 \begin_layout Plain Layout
9065 \begin_inset Flex Code
9068 \begin_layout Plain Layout
9077 \begin_layout Subsection
9078 The CiteEngine file declaration
9081 \begin_layout Standard
9082 A cite engine file must begin with a line like the following:
9085 \begin_layout LyX-Code
9088 DeclareLyXCiteEngineModule[biblatex.sty]{Biblatex}
9091 \begin_layout Standard
9092 The mandatory argument, in curly brackets, is the name of the cite style,
9093 as it should appear in
9094 \begin_inset Flex Noun
9097 \begin_layout Plain Layout
9098 Document\SpecialChar menuseparator
9099 Settings\SpecialChar menuseparator
9106 The argument in square brackets is optional: It declares any \SpecialChar LaTeX
9108 on which the cite engine depends.
9111 \begin_layout Standard
9112 The cite engine declaration should then be followed by lines like the following:
9116 \begin_layout Plain Layout
9117 Preferably in English if the module should be published with \SpecialChar LyX
9119 This description will appear in the list of messages to be translated and
9120 will be thus translated with the next interface update.
9128 \begin_layout LyX-Code
9132 \begin_layout LyX-Code
9133 # Biblatex supports many author-year and numerical styles.
9136 \begin_layout LyX-Code
9137 # It is mainly aimed at the Humanities.
9141 \begin_layout LyX-Code
9142 # customizable, fully localized and provides many features
9145 \begin_layout LyX-Code
9146 # that are not possible with BibTeX.
9147 The use of 'biber' as
9150 \begin_layout LyX-Code
9151 # bibliography processor is advised.
9154 \begin_layout LyX-Code
9158 \begin_layout Standard
9159 The description is used in
9160 \begin_inset Flex Noun
9163 \begin_layout Plain Layout
9164 Document\SpecialChar menuseparator
9165 Settings\SpecialChar menuseparator
9171 to provide the user with information about the cite engine.
9174 \begin_layout Subsection
9178 \begin_layout Standard
9179 The first non-comment line of any layout file, included file, or module
9184 contain the file format number:
9187 \begin_layout Description
9188 \begin_inset Flex Code
9191 \begin_layout Plain Layout
9198 \begin_inset Flex Code
9201 \begin_layout Plain Layout
9207 ] The format number of the layout file.
9210 \begin_layout Standard
9211 This tag was introduced with \SpecialChar LyX
9213 \begin_inset space ~
9217 Layout files from older \SpecialChar LyX
9218 versions do not have an explicit file format and
9219 are considered to have
9220 \begin_inset Flex Code
9223 \begin_layout Plain Layout
9225 \begin_inset space ~
9234 The format for the present version of \SpecialChar LyX
9236 But each version of \SpecialChar LyX
9237 is capable of reading earlier versions' layout files,
9238 just as they are capable of reading files produced by earlier versions
9241 There is, however, no provision for converting to earlier formats.
9244 \begin_layout Subsection
9245 \begin_inset CommandInset label
9247 name "subsec:General-text-class"
9251 General text class parameters
9254 \begin_layout Standard
9255 These are general parameters that govern the behavior of an entire document
9261 mean that they must appear in
9262 \begin_inset Flex Code
9265 \begin_layout Plain Layout
9271 files rather than in modules.
9272 A module can contain any layout tag.)
9275 \begin_layout Description
9277 \change_inserted -712698321 1526899478
9278 \begin_inset Flex Code
9281 \begin_layout Plain Layout
9283 \change_inserted -712698321 1526898610
9284 AddToCiteEngine <engine>
9291 Extends the possibilities for displaying citation references.
9293 \begin_inset CommandInset ref
9295 reference "subsec:Citation-engine-description"
9304 \begin_inset Flex Code
9307 \begin_layout Plain Layout
9309 \change_inserted -712698321 1526898823
9320 \begin_layout Description
9321 \begin_inset Flex Code
9324 \begin_layout Plain Layout
9330 Adds information that will be output in the
9331 \begin_inset Flex Code
9334 \begin_layout Plain Layout
9340 block when the document is output to XHTML.
9341 Typically, this would be used to output CSS style information, but it can
9342 be used for anything that can appear in
9343 \begin_inset Flex Code
9346 \begin_layout Plain Layout
9354 \begin_inset Quotes eld
9358 \begin_inset Flex Code
9361 \begin_layout Plain Layout
9368 \begin_inset Quotes erd
9374 \begin_layout Description
9375 \begin_inset Flex Code
9378 \begin_layout Plain Layout
9384 Adds information to the document preamble.
9386 \begin_inset Newline newline
9390 \begin_inset Quotes eld
9394 \begin_inset Flex Code
9397 \begin_layout Plain Layout
9404 \begin_inset Quotes erd
9408 \change_inserted -712698321 1562592950
9412 \begin_layout Description
9414 \change_inserted -712698321 1562593040
9415 \begin_inset Flex Code
9418 \begin_layout Plain Layout
9420 \change_inserted -712698321 1562592954
9429 \begin_inset Flex Code
9432 \begin_layout Plain Layout
9434 \change_inserted -712698321 1562592950
9445 \begin_inset space \thinspace{}
9449 \begin_inset Flex Code
9452 \begin_layout Plain Layout
9454 \change_inserted -712698321 1562592950
9462 ] If the document class adds the bibliography to the table of contents,
9463 add this option with value
9464 \begin_inset Flex Code
9467 \begin_layout Plain Layout
9469 \change_inserted -712698321 1562592996
9478 \begin_inset Flex Code
9481 \begin_layout Plain Layout
9483 \change_inserted -712698321 1562593006
9492 This prevents the bibliography from being added twice.
9497 \begin_layout Description
9498 \begin_inset Flex Code
9501 \begin_layout Plain Layout
9507 Defines the possibilities for displaying citation references.
9509 \begin_inset CommandInset ref
9511 reference "subsec:Citation-engine-description"
9520 \begin_inset Quotes eld
9524 \begin_inset Flex Code
9527 \begin_layout Plain Layout
9534 \begin_inset Quotes erd
9538 Primarily used in cite engine files (see
9539 \begin_inset CommandInset ref
9541 reference "subsec:Cite-Engine-Files"
9550 \change_inserted -712698321 1526898530
9551 Note that if you specify this in a layout file or module, any cite engine
9552 definition will be overridden.
9554 \begin_inset Flex Code
9557 \begin_layout Plain Layout
9559 \change_inserted -712698321 1526898530
9572 \begin_layout Description
9573 \begin_inset Flex Code
9576 \begin_layout Plain Layout
9582 Defines formats for use in the display of bibliographic information.
9584 \begin_inset CommandInset ref
9586 reference "subsec:Citation-format-description"
9592 \begin_inset Quotes eld
9596 \begin_inset Flex Code
9599 \begin_layout Plain Layout
9606 \begin_inset Quotes erd
9610 Primarily used in cite engine files (see
9611 \begin_inset CommandInset ref
9613 reference "subsec:Cite-Engine-Files"
9622 \change_inserted -712698321 1526898585
9623 A cite format defined in a layout or module will override the cite engine
9629 \begin_layout Description
9630 \begin_inset Flex Code
9633 \begin_layout Plain Layout
9640 \begin_inset Flex Code
9643 \begin_layout Plain Layout
9652 \begin_inset Flex Code
9655 \begin_layout Plain Layout
9661 ] Determines whether
9665 or Bib\SpecialChar TeX
9666 is used to generate a Bibliography.
9667 Primarily used in cite engine files (see
9668 \begin_inset CommandInset ref
9670 reference "subsec:Cite-Engine-Files"
9680 \begin_layout Description
9681 \begin_inset Flex Code
9684 \begin_layout Plain Layout
9690 Describes various global options supported by the document class.
9692 \begin_inset CommandInset ref
9694 reference "subsec:ClassOptions"
9700 \begin_inset Quotes eld
9704 \begin_inset Flex Code
9707 \begin_layout Plain Layout
9714 \begin_inset Quotes erd
9720 \begin_layout Description
9721 \begin_inset Flex Code
9724 \begin_layout Plain Layout
9731 \begin_inset Flex Code
9734 \begin_layout Plain Layout
9743 \begin_inset space \thinspace{}
9747 \begin_inset Flex Code
9750 \begin_layout Plain Layout
9756 ] Whether the class should
9760 to having one or two columns.
9761 Can be changed in the
9762 \begin_inset Flex Noun
9765 \begin_layout Plain Layout
9766 Document\SpecialChar menuseparator
9775 \begin_layout Description
9776 \begin_inset Flex Code
9779 \begin_layout Plain Layout
9786 \begin_inset Flex Code
9789 \begin_layout Plain Layout
9795 ] This sequence defines the properties for a counter.
9796 If the counter does not yet exist, it is created; if it does exist, it
9799 \begin_inset Quotes eld
9803 \begin_inset Flex Code
9806 \begin_layout Plain Layout
9813 \begin_inset Quotes erd
9817 \begin_inset Newline newline
9821 \begin_inset CommandInset ref
9823 reference "subsec:Counters"
9827 for details on counters.
9830 \begin_layout Description
9831 \begin_inset Flex Code
9834 \begin_layout Plain Layout
9840 Sets the default font used to display the document.
9842 \begin_inset CommandInset ref
9844 reference "subsec:Font-description"
9848 for how to declare fonts.
9850 \begin_inset Quotes eld
9854 \begin_inset Flex Code
9857 \begin_layout Plain Layout
9864 \begin_inset Quotes erd
9870 \begin_layout Description
9871 \begin_inset Flex Code
9874 \begin_layout Plain Layout
9881 \begin_inset Flex Code
9884 \begin_layout Plain Layout
9890 ] Specifies a module to be included by default with this document class.
9891 The module is specified as filename without the
9892 \begin_inset Flex Code
9895 \begin_layout Plain Layout
9902 The user can still remove the module, but it will be active at the outset.
9903 (This applies only when new files are created, or when this class is chosen
9904 for an existing document.)
9907 \begin_layout Description
9908 \begin_inset Flex Code
9911 \begin_layout Plain Layout
9918 \begin_inset Flex Code
9921 \begin_layout Plain Layout
9927 ] This is the style that will be assigned to new paragraphs, usually
9928 \begin_inset Flex Noun
9931 \begin_layout Plain Layout
9938 This will default to the first defined style if not given, but you are
9939 encouraged to use this directive.
9942 \begin_layout Description
9944 \change_inserted -970929547 1515112870
9945 \begin_inset Flex Code
9948 \begin_layout Plain Layout
9950 \change_inserted -970929547 1515112782
9959 \begin_inset Flex Code
9962 \begin_layout Plain Layout
9964 \change_inserted -970929547 1515112766
9972 ] The root element (at the top of the document) to use when outputting documents
9973 with this class in DocBook.
9974 The default value is
9975 \begin_inset Quotes eld
9979 \begin_inset Flex Code
9982 \begin_layout Plain Layout
9984 \change_inserted -970929547 1515112845
9993 \begin_inset Quotes erd
9998 \change_deleted 1075283030 1594226862
10000 \change_inserted 1075283030 1594226777
10004 \begin_layout Description
10006 \change_inserted 1075283030 1594226859
10007 \begin_inset Flex Code
10010 \begin_layout Plain Layout
10012 \change_inserted 1075283030 1594226785
10013 DocBookForceAbstract
10021 \begin_inset Flex Code
10024 \begin_layout Plain Layout
10026 \change_inserted 1075283030 1594226804
10035 \begin_inset Quotes eld
10043 \begin_inset Quotes erd
10046 , the root element will always have an
10051 The default value is
10052 \begin_inset Quotes eld
10060 \begin_inset Quotes erd
10068 \begin_layout Description
10069 \begin_inset Flex Code
10072 \begin_layout Plain Layout
10079 \begin_inset Flex Code
10082 \begin_layout Plain Layout
10088 ] This tag indicates that the module (which is specified by filename without
10090 \begin_inset Flex Code
10093 \begin_layout Plain Layout
10099 extension) cannot be used with this document class.
10100 This might be used in a journal-specific layout file to prevent, say, the
10102 \begin_inset Flex Code
10105 \begin_layout Plain Layout
10111 module that numbers theorems by section.
10116 be used in a module.
10117 Modules have their own way of excluding other modules (see
10118 \begin_inset CommandInset ref
10120 reference "subsec:Layout-modules"
10127 \begin_layout Description
10128 \begin_inset Flex Code
10131 \begin_layout Plain Layout
10137 Defines a new float.
10139 \begin_inset CommandInset ref
10141 reference "subsec:Floats"
10147 \begin_inset Quotes eld
10151 \begin_inset Flex Code
10154 \begin_layout Plain Layout
10161 \begin_inset Quotes erd
10167 \begin_layout Description
10168 \begin_inset Flex Code
10171 \begin_layout Plain Layout
10177 Sets the information that will be output in the
10178 \begin_inset Flex Code
10181 \begin_layout Plain Layout
10187 block when this document class is output to XHTML.
10188 Note that this will completely override any prior
10189 \begin_inset Flex Code
10192 \begin_layout Plain Layout
10199 \begin_inset Flex Code
10202 \begin_layout Plain Layout
10210 \begin_inset Newline newline
10214 \begin_inset Flex Code
10217 \begin_layout Plain Layout
10223 if you just want to add material to the preamble.) Must end with
10224 \begin_inset Quotes eld
10228 \begin_inset Flex Code
10231 \begin_layout Plain Layout
10238 \begin_inset Quotes erd
10244 \begin_layout Description
10245 \begin_inset Flex Code
10248 \begin_layout Plain Layout
10255 \begin_inset Flex Code
10258 \begin_layout Plain Layout
10264 ] The style to use for the table of contents, bibliography, and so forth,
10265 when the document is output to HTML.
10266 For articles, this should normally be
10267 \begin_inset Flex Code
10270 \begin_layout Plain Layout
10277 \begin_inset Flex Code
10280 \begin_layout Plain Layout
10287 If it is not given, then \SpecialChar LyX
10288 will attempt to figure out which layout to use.
10291 \begin_layout Description
10292 \begin_inset Flex Code
10295 \begin_layout Plain Layout
10302 \begin_inset Flex Code
10305 \begin_layout Plain Layout
10311 ] Modifies the properties of the given counter.
10312 If the counter does not exist, the statement is ignored.
10314 \begin_inset Quotes eld
10318 \begin_inset Flex Code
10321 \begin_layout Plain Layout
10328 \begin_inset Quotes erd
10332 \begin_inset Newline newline
10336 \begin_inset CommandInset ref
10338 reference "subsec:Counters"
10342 for details on counters.
10345 \begin_layout Description
10346 \begin_inset Flex Code
10349 \begin_layout Plain Layout
10356 \begin_inset Flex Code
10359 \begin_layout Plain Layout
10365 ] This allows you to include another layout definition file within yours
10366 to avoid duplicating commands.
10367 Common examples are the standard layout files, for example,
10368 \begin_inset Flex Code
10371 \begin_layout Plain Layout
10377 , which contains most of the basic layouts.
10378 \change_inserted -712698321 1611646803
10382 \begin_layout Description
10384 \change_inserted -712698321 1611646804
10385 \begin_inset Flex Code
10388 \begin_layout Plain Layout
10390 \change_inserted -712698321 1611646837
10399 \begin_inset Flex Code
10402 \begin_layout Plain Layout
10404 \change_inserted -712698321 1611646804
10412 ] is a variant of the
10413 \begin_inset Flex Code
10416 \begin_layout Plain Layout
10418 \change_inserted -712698321 1611646804
10426 command which does not look for files in the user directory.
10427 This allows to create a file
10428 \begin_inset Flex Code
10431 \begin_layout Plain Layout
10433 \change_inserted -712698321 1611646804
10442 \begin_inset Flex Code
10445 \begin_layout Plain Layout
10447 \change_inserted -712698321 1611646804
10455 in the user directory which includes a global file with the same name via
10457 \begin_inset Flex Code
10460 \begin_layout Plain Layout
10462 \change_inserted -712698321 1611646853
10471 \begin_inset Flex Code
10474 \begin_layout Plain Layout
10476 \change_inserted -712698321 1611646855
10477 InputGlobal name.inc
10484 , respectively (with
10485 \begin_inset Flex Code
10488 \begin_layout Plain Layout
10490 \change_inserted -712698321 1611646804
10498 , the file would recursively include itself).
10499 This way, you can modify global files without having to completely copy
10505 \begin_layout Description
10506 \begin_inset Flex Code
10509 \begin_layout Plain Layout
10516 \begin_inset Flex Code
10519 \begin_layout Plain Layout
10525 ] This section (re-)defines the layout of an inset.
10526 It can be applied to an existing inset or to a new, user-defined inset,
10527 e.g., a new character style.
10529 \begin_inset Quotes eld
10533 \begin_inset Flex Code
10536 \begin_layout Plain Layout
10543 \begin_inset Quotes erd
10547 \begin_inset Newline newline
10551 \begin_inset CommandInset ref
10553 reference "subsec:Flex-insets-and"
10557 for more information.
10561 \begin_layout Description
10562 \begin_inset Flex Code
10565 \begin_layout Plain Layout
10572 \begin_inset Flex Code
10575 \begin_layout Plain Layout
10581 ] A string that indicates the width of the left margin on the screen, for
10583 \begin_inset Quotes eld
10587 \begin_inset Flex Code
10590 \begin_layout Plain Layout
10597 \begin_inset Quotes erd
10601 (Note that this is not a `length', like
10602 \begin_inset Quotes eld
10606 \begin_inset Quotes erd
10612 \begin_layout Description
10613 \begin_inset Flex Code
10616 \begin_layout Plain Layout
10623 \begin_inset Flex Code
10626 \begin_layout Plain Layout
10632 ] An integer that determines the maximal number of names displayed in an
10633 author-year citation before the citation switches to
10634 \begin_inset Quotes eld
10638 \begin_inset Quotes erd
10642 Primarily used in cite engine files (see
10643 \begin_inset CommandInset ref
10645 reference "subsec:Cite-Engine-Files"
10655 \begin_layout Description
10657 \change_inserted -712698321 1612018485
10658 \begin_inset Flex Code
10661 \begin_layout Plain Layout
10663 \change_inserted -712698321 1612018457
10670 \begin_inset Flex Code
10673 \begin_layout Plain Layout
10675 \change_inserted -712698321 1612018466
10681 ] Modifies the layout of an inset.
10682 If the layout does not exist, this section is ignored.
10684 \begin_inset Quotes eld
10688 \begin_inset Flex Code
10691 \begin_layout Plain Layout
10693 \change_inserted -712698321 1612018452
10700 \begin_inset Quotes erd
10706 \begin_layout Description
10707 \begin_inset Flex Code
10710 \begin_layout Plain Layout
10717 \begin_inset Flex Code
10720 \begin_layout Plain Layout
10726 ] Modifies the properties of the given paragraph style.
10727 If the style does not exist, this section is ignored.
10729 \begin_inset Quotes eld
10733 \begin_inset Flex Code
10736 \begin_layout Plain Layout
10743 \begin_inset Quotes erd
10749 \begin_layout Description
10750 \begin_inset Flex Code
10753 \begin_layout Plain Layout
10760 \begin_inset Flex Code
10763 \begin_layout Plain Layout
10769 ] Deletes an existing counter, usually one defined in an included file.
10772 \begin_layout Description
10773 \begin_inset Flex Code
10776 \begin_layout Plain Layout
10783 \begin_inset Flex Code
10786 \begin_layout Plain Layout
10792 ] Deletes an existing float.
10793 This is particularly useful when you want to suppress a float that has
10794 been defined in an input file.
10797 \begin_layout Description
10798 \begin_inset Flex Code
10801 \begin_layout Plain Layout
10808 \begin_inset Flex Code
10811 \begin_layout Plain Layout
10817 ] Deletes an existing style.
10820 \begin_layout Description
10821 \begin_inset Flex Code
10824 \begin_layout Plain Layout
10831 \begin_inset Flex Code
10834 \begin_layout Plain Layout
10841 \begin_inset Flex Code
10844 \begin_layout Plain Layout
10850 ] Define a new table of contents with type
10851 \begin_inset Flex Code
10854 \begin_layout Plain Layout
10861 \begin_inset Flex Code
10864 \begin_layout Plain Layout
10871 See also the AddToToc commands.
10874 \begin_layout Description
10875 \begin_inset Flex Code
10878 \begin_layout Plain Layout
10885 \begin_inset Flex Code
10888 \begin_layout Plain Layout
10894 ] The file format (as defined in the \SpecialChar LyX
10895 preferences) produced by this document
10897 It is mainly useful when
10898 \begin_inset Flex Code
10901 \begin_layout Plain Layout
10908 \begin_inset Flex Code
10911 \begin_layout Plain Layout
10917 and one wants to define a new type of literate document.
10918 The format is reset to
10919 \change_deleted 5863208 1594239413
10921 \begin_inset Quotes eld
10925 \begin_inset Flex Code
10928 \begin_layout Plain Layout
10935 \begin_inset Quotes erd
10941 \begin_inset Quotes eld
10945 \begin_inset Flex Code
10948 \begin_layout Plain Layout
10955 \begin_inset Quotes erd
10958 when the corresponding
10959 \begin_inset Flex Code
10962 \begin_layout Plain Layout
10968 parameter is encountered.
10971 \begin_layout Description
10972 \begin_inset Flex Code
10975 \begin_layout Plain Layout
10982 \begin_inset Flex Code
10985 \begin_layout Plain Layout
10996 \change_deleted 5863208 1594239430
10998 \begin_inset Flex Code
11001 \begin_layout Plain Layout
11010 \begin_inset Flex Code
11013 \begin_layout Plain Layout
11019 ] Specifies what sort of output documents using this class will produce.
11022 \begin_layout Description
11023 \begin_inset Flex Code
11026 \begin_layout Plain Layout
11033 \begin_inset Flex Code
11036 \begin_layout Plain Layout
11043 \begin_inset Flex Code
11046 \begin_layout Plain Layout
11052 ] Specifies options, given in the second string, for the package named by
11055 \begin_inset Quotes eld
11059 \begin_inset Flex Code
11062 \begin_layout Plain Layout
11063 PackageOptions natbib square
11069 \begin_inset Quotes erd
11073 \begin_inset Flex Code
11076 \begin_layout Plain Layout
11082 to be loaded with the
11083 \begin_inset Flex Code
11086 \begin_layout Plain Layout
11093 (For \SpecialChar TeX
11094 perts, this causes \SpecialChar LyX
11096 \begin_inset Flex Code
11099 \begin_layout Plain Layout
11102 PassOptionsToPackage{natbib}{square}
11108 \begin_inset Flex Code
11111 \begin_layout Plain Layout
11118 \change_inserted -712698321 1565102364
11122 \begin_layout Description
11124 \change_inserted -712698321 1565102470
11125 \begin_inset Flex Code
11128 \begin_layout Plain Layout
11130 \change_inserted -712698321 1565102365
11139 \begin_inset Flex Code
11142 \begin_layout Plain Layout
11144 \change_inserted -712698321 1565105222
11149 , letter, legal, executive, a0, a1, a2, a3, a4, a5, a6, b0, b1, b2, b3,
11150 b4, b5, b6, c0, c1, c2, c3, c4, c5, c6, b0j, b1j, b2j, b3j, b4j, b5j, b6j
11157 ] The default page size.
11158 This is used by some converters.
11163 \begin_layout Description
11164 \begin_inset Flex Code
11167 \begin_layout Plain Layout
11174 \begin_inset Flex Code
11177 \begin_layout Plain Layout
11186 \begin_inset Flex Code
11189 \begin_layout Plain Layout
11196 \begin_inset Flex Code
11199 \begin_layout Plain Layout
11205 ] The default pagestyle.
11206 Can be changed in the
11207 \begin_inset Flex Noun
11210 \begin_layout Plain Layout
11211 Document\SpecialChar menuseparator
11220 \begin_layout Description
11221 \begin_inset Flex Code
11224 \begin_layout Plain Layout
11230 Sets the preamble for the \SpecialChar LaTeX
11232 Note that this will completely override any prior
11233 \begin_inset Flex Code
11236 \begin_layout Plain Layout
11243 \begin_inset Flex Code
11246 \begin_layout Plain Layout
11254 \begin_inset Flex Code
11257 \begin_layout Plain Layout
11263 if you just want to add material to the preamble.) Must end with
11264 \begin_inset Quotes eld
11268 \begin_inset Flex Code
11271 \begin_layout Plain Layout
11278 \begin_inset Quotes erd
11282 \change_inserted -712698321 1612018500
11286 \begin_layout Description
11288 \change_inserted -712698321 1612018547
11289 \begin_inset Flex Code
11292 \begin_layout Plain Layout
11294 \change_inserted -712698321 1612018506
11301 \begin_inset Flex Code
11304 \begin_layout Plain Layout
11306 \change_inserted -712698321 1612018509
11312 ] Defines the layout of an inset if it does not already exist.
11313 If the layout does exist, this section is ignored.
11315 \begin_inset Quotes eld
11319 \begin_inset Flex Code
11322 \begin_layout Plain Layout
11324 \change_inserted -712698321 1612018500
11331 \begin_inset Quotes erd
11339 \begin_layout Description
11340 \begin_inset Flex Code
11343 \begin_layout Plain Layout
11350 \begin_inset Flex Code
11353 \begin_layout Plain Layout
11360 \begin_inset Flex Code
11363 \begin_layout Plain Layout
11372 \begin_inset space \thinspace{}
11376 \begin_inset Flex Code
11379 \begin_layout Plain Layout
11385 ] Whether the class already provides the feature
11386 \begin_inset Flex Code
11389 \begin_layout Plain Layout
11396 A feature is in general the name of a package (e.
11397 \begin_inset space \thinspace{}
11401 \begin_inset space \space{}
11405 \begin_inset Flex Code
11408 \begin_layout Plain Layout
11415 \begin_inset Flex Code
11418 \begin_layout Plain Layout
11425 \begin_inset space \thinspace{}
11429 \begin_inset space \space{}
11433 \begin_inset Flex Code
11436 \begin_layout Plain Layout
11443 \begin_inset Flex Code
11446 \begin_layout Plain Layout
11454 \begin_inset CommandInset ref
11456 reference "chap:List-of-functions"
11460 for the list of features.
11463 \begin_layout Description
11464 \begin_inset Flex Code
11467 \begin_layout Plain Layout
11474 \begin_inset Flex Code
11477 \begin_layout Plain Layout
11483 ] Indicates that this layout provides the functionality of the module mentioned,
11484 which should be specified by the filename without the
11485 \begin_inset Flex Code
11488 \begin_layout Plain Layout
11495 This will typically be used if the layout includes the module directly,
11496 rather than using the
11497 \begin_inset Flex Code
11500 \begin_layout Plain Layout
11506 tag to indicate that it ought to be used.
11507 It could also be used in a module that provided an alternate implementation
11508 of the same functionality.
11511 \begin_layout Description
11512 \begin_inset Flex Code
11515 \begin_layout Plain Layout
11522 \begin_inset Flex Code
11525 \begin_layout Plain Layout
11531 ] Creates a new paragraph style if it does not already exist.
11532 If the style does exist, this section is ignored.
11534 \begin_inset Quotes eld
11538 \begin_inset Flex Code
11541 \begin_layout Plain Layout
11548 \begin_inset Quotes erd
11554 \begin_layout Description
11555 \begin_inset Flex Code
11558 \begin_layout Plain Layout
11565 \begin_inset Flex Code
11568 \begin_layout Plain Layout
11574 ] Whether the class requires the feature
11575 \begin_inset Flex Code
11578 \begin_layout Plain Layout
11585 Multiple features must be separated by commas.
11586 Note that you can only request supported features.
11588 \begin_inset CommandInset ref
11590 reference "chap:List-of-functions"
11594 for the list of features.).
11595 If you require a package with specific options, you can additionally use
11597 \begin_inset Flex Code
11600 \begin_layout Plain Layout
11609 \begin_layout Description
11610 \begin_inset Flex Code
11613 \begin_layout Plain Layout
11620 \begin_inset Flex Code
11623 \begin_layout Plain Layout
11629 ] A string that indicates the width of the right margin on the screen, for
11631 \begin_inset Quotes eld
11635 \begin_inset Flex Code
11638 \begin_layout Plain Layout
11645 \begin_inset Quotes erd
11651 \begin_layout Description
11652 \begin_inset Flex Code
11655 \begin_layout Plain Layout
11662 \begin_inset Flex Code
11665 \begin_layout Plain Layout
11671 ] Sets which divisions get numbered.
11673 \begin_inset Newline newline
11677 \begin_inset Flex Code
11680 \begin_layout Plain Layout
11686 counter in \SpecialChar LaTeX
11690 \begin_layout Description
11691 \begin_inset Flex Code
11694 \begin_layout Plain Layout
11701 \begin_inset Flex Code
11704 \begin_layout Plain Layout
11713 \begin_inset space \thinspace{}
11717 \begin_inset Flex Code
11720 \begin_layout Plain Layout
11726 ] Whether the class-default should be printing on one or both sides of the
11728 Can be changed in the
11729 \begin_inset Flex Noun
11732 \begin_layout Plain Layout
11733 Document\SpecialChar menuseparator
11742 \begin_layout Description
11743 \begin_inset Flex Code
11746 \begin_layout Plain Layout
11753 \begin_inset Flex Code
11756 \begin_layout Plain Layout
11762 ] This sequence defines a paragraph style.
11763 If the style does not yet exist, it is created; if it does exist, its parameter
11766 \begin_inset Quotes eld
11770 \begin_inset Flex Code
11773 \begin_layout Plain Layout
11780 \begin_inset Quotes erd
11784 \begin_inset Newline newline
11788 \begin_inset CommandInset ref
11790 reference "subsec:Paragraph-Styles"
11794 for details on paragraph styles.
11795 \change_inserted -712698321 1553617804
11799 \begin_layout Description
11801 \change_inserted -712698321 1553617862
11802 \begin_inset Flex Code
11805 \begin_layout Plain Layout
11807 \change_inserted -712698321 1553617809
11816 \begin_inset Flex Code
11819 \begin_layout Plain Layout
11821 \change_inserted -712698321 1553617805
11829 ] defines the default table style that is used when inserting a table.
11830 The following styles are available:
11834 \begin_layout Itemize
11836 \change_inserted -712698321 1554308039
11837 \begin_inset Flex Code
11840 \begin_layout Plain Layout
11842 \change_inserted -712698321 1554307928
11843 Formal_with_Footline
11851 \begin_inset Quotes eld
11855 \begin_inset Quotes erd
11858 ) style with horizontal lines only, using a bold top and bottom line, the
11859 first and last row are additionally separated from the table body with
11860 a thin middle line.
11863 \begin_layout Itemize
11865 \change_inserted -712698321 1554308087
11866 \begin_inset Flex Code
11869 \begin_layout Plain Layout
11871 \change_inserted -712698321 1554308042
11872 Formal_without_Footline
11879 : same as the above, but the last row is not separated with a middle line
11883 \begin_layout Itemize
11885 \change_inserted -712698321 1553618031
11886 \begin_inset Flex Code
11889 \begin_layout Plain Layout
11891 \change_inserted -712698321 1553618006
11899 : Simple table lines.
11902 \begin_layout Itemize
11904 \change_inserted -712698321 1553618309
11905 \begin_inset Flex Code
11908 \begin_layout Plain Layout
11910 \change_inserted -712698321 1553618031
11919 \begin_inset Flex Code
11922 \begin_layout Plain Layout
11924 \change_inserted -712698321 1553618043
11932 , but with the header column offset with a second horizontal line.
11933 This is also the default style of \SpecialChar LyX
11937 \begin_layout Itemize
11939 \change_inserted -712698321 1553618280
11940 \begin_inset Flex Code
11943 \begin_layout Plain Layout
11945 \change_inserted -712698321 1553618261
11953 : Table without lines.
11959 \begin_layout Description
11960 \begin_inset Flex Code
11963 \begin_layout Plain Layout
11970 \begin_inset Flex Code
11973 \begin_layout Plain Layout
11979 ] The name of the command or environment to be used with
11980 \begin_inset Flex Code
11983 \begin_layout Plain Layout
11992 \begin_layout Description
11993 \begin_inset Flex Code
11996 \begin_layout Plain Layout
12003 \begin_inset Flex Code
12006 \begin_layout Plain Layout
12015 \begin_inset Flex Code
12018 \begin_layout Plain Layout
12024 ] Indicates what kind of markup is used to define the title of a document.
12026 \begin_inset Flex Code
12029 \begin_layout Plain Layout
12035 means that the macro with name
12036 \begin_inset Flex Code
12039 \begin_layout Plain Layout
12045 will be inserted after the last layout which has
12046 \begin_inset Quotes eld
12050 \begin_inset Flex Code
12053 \begin_layout Plain Layout
12055 \begin_inset space ~
12064 \begin_inset Quotes erd
12069 \begin_inset Flex Code
12072 \begin_layout Plain Layout
12078 corresponds to the case where all layouts which have
12079 \begin_inset Quotes eld
12083 \begin_inset Flex Code
12086 \begin_layout Plain Layout
12088 \begin_inset space ~
12097 \begin_inset Quotes erd
12100 should be enclosed into the
12101 \begin_inset Flex Code
12104 \begin_layout Plain Layout
12113 \begin_layout Description
12114 \begin_inset Flex Code
12117 \begin_layout Plain Layout
12124 \begin_inset Flex Code
12127 \begin_layout Plain Layout
12133 ] Sets which divisions are included in the table of contents.
12135 \begin_inset Flex Code
12138 \begin_layout Plain Layout
12144 counter in \SpecialChar LaTeX
12148 \begin_layout Subsection
12149 \begin_inset Flex Code
12152 \begin_layout Plain Layout
12159 \begin_inset CommandInset label
12161 name "subsec:ClassOptions"
12168 \begin_layout Standard
12170 \begin_inset Flex Code
12173 \begin_layout Plain Layout
12179 section can contain the following entries:
12182 \begin_layout Description
12183 \begin_inset Flex Code
12186 \begin_layout Plain Layout
12193 \begin_inset Flex Code
12196 \begin_layout Plain Layout
12202 ] The list of available font sizes for the document's main font, separated
12204 \begin_inset Quotes eld
12208 \begin_inset Flex Code
12211 \begin_layout Plain Layout
12218 \begin_inset Quotes erd
12223 \change_inserted -712698321 1565110196
12224 Any number is possible.
12227 \begin_layout Description
12229 \change_inserted -712698321 1565110259
12230 \begin_inset Flex Code
12233 \begin_layout Plain Layout
12235 \change_inserted -712698321 1565110199
12244 \begin_inset Flex Code
12247 \begin_layout Plain Layout
12249 \change_inserted -712698321 1565110196
12257 ] The format for the font size option.
12259 \begin_inset Flex Code
12262 \begin_layout Plain Layout
12264 \change_inserted -712698321 1565110238
12274 \begin_inset Flex Code
12277 \begin_layout Plain Layout
12279 \change_inserted -712698321 1565110248
12287 is a placeholder for the font size.
12292 \begin_layout Description
12294 \change_deleted 5863208 1594239483
12295 \begin_inset Flex Code
12298 \begin_layout Plain Layout
12304 Used to set the DTD line with XML-based output classes.
12306 \begin_inset space \thinspace{}
12310 \begin_inset Quotes eld
12313 -//OASIS//DTD DocBook V4.2//EN
12314 \begin_inset Quotes erd
12318 \change_inserted -712698321 1565101761
12322 \begin_layout Description
12324 \change_inserted -712698321 1565180598
12325 \begin_inset Flex Code
12328 \begin_layout Plain Layout
12330 \change_inserted -712698321 1565101918
12339 \begin_inset Flex Code
12342 \begin_layout Plain Layout
12344 \change_inserted -712698321 1565105399
12345 string="letter|\SpecialChar allowbreak
12346 legal|\SpecialChar allowbreak
12347 executive|\SpecialChar allowbreak
12348 a0|\SpecialChar allowbreak
12349 a1|\SpecialChar allowbreak
12350 a2|\SpecialChar allowbreak
12351 a3|\SpecialChar allowbreak
12352 a4|\SpecialChar allowbreak
12353 a5|\SpecialChar allowbreak
12354 a6|\SpecialChar allowbreak
12355 b0|\SpecialChar allowbreak
12356 b1|\SpecialChar allowbreak
12357 b2|\SpecialChar allowbreak
12358 b3|\SpecialChar allowbreak
12359 b4|\SpecialChar allowbreak
12360 b5|\SpecialChar allowbreak
12361 b6|\SpecialChar allowbreak
12362 c0|\SpecialChar allowbreak
12363 c1|\SpecialChar allowbreak
12365 2|\SpecialChar allowbreak
12366 c3|\SpecialChar allowbreak
12367 c4|\SpecialChar allowbreak
12368 c5|\SpecialChar allowbreak
12369 c6|\SpecialChar allowbreak
12370 b0j|\SpecialChar allowbreak
12371 b1j|\SpecialChar allowbreak
12372 b2j|\SpecialChar allowbreak
12373 b3j|\SpecialChar allowbreak
12374 b4j|\SpecialChar allowbreak
12375 b5j|\SpecialChar allowbreak
12383 ] The list of available page sizes, separated by
12384 \begin_inset Quotes eld
12388 \begin_inset Flex Code
12391 \begin_layout Plain Layout
12393 \change_inserted -712698321 1565101779
12402 \begin_inset Quotes erd
12406 Currently, only the listed sizes are supported.
12407 Other sizes might be entered as custom class option.
12410 \begin_layout Description
12412 \change_inserted -712698321 1565180623
12413 \begin_inset Flex Code
12416 \begin_layout Plain Layout
12418 \change_inserted -712698321 1565180605
12427 \begin_inset Flex Code
12430 \begin_layout Plain Layout
12432 \change_inserted -712698321 1565180601
12440 ] The format for the page size option.
12442 \begin_inset Flex Code
12445 \begin_layout Plain Layout
12447 \change_inserted -712698321 1565180618
12457 \begin_inset Flex Code
12460 \begin_layout Plain Layout
12462 \change_inserted -712698321 1565180601
12470 is a placeholder for the paper size.
12475 \begin_layout Description
12476 \begin_inset Flex Code
12479 \begin_layout Plain Layout
12486 \begin_inset Flex Code
12489 \begin_layout Plain Layout
12490 string="empty|plain|headings|fancy"
12495 ] The list of available page sty\SpecialChar softhyphen
12497 \begin_inset Quotes eld
12501 \begin_inset Flex Code
12504 \begin_layout Plain Layout
12511 \begin_inset Quotes erd
12517 \begin_layout Description
12518 \begin_inset Flex Code
12521 \begin_layout Plain Layout
12528 \begin_inset Flex Code
12531 \begin_layout Plain Layout
12537 ] Some document class options, separated by a comma, that will be added
12538 to the optional part of the
12539 \begin_inset Flex Code
12542 \begin_layout Plain Layout
12553 \begin_layout Standard
12555 \begin_inset Flex Code
12558 \begin_layout Plain Layout
12564 section must end with
12565 \begin_inset Quotes eld
12569 \begin_inset Flex Code
12572 \begin_layout Plain Layout
12579 \begin_inset Quotes erd
12585 \begin_layout Subsection
12587 \begin_inset CommandInset label
12589 name "subsec:Paragraph-Styles"
12596 \begin_layout Standard
12597 A paragraph style description looks like this:
12601 \begin_layout Plain Layout
12602 Note that this will either define a new style or modify an existing one.
12610 \begin_layout LyX-Code
12617 \begin_layout LyX-Code
12621 \begin_layout LyX-Code
12625 \begin_layout Standard
12626 where the following commands are allowed:
12629 \begin_layout Description
12630 \begin_inset Flex Code
12633 \begin_layout Plain Layout
12640 \begin_inset Flex Code
12643 \begin_layout Plain Layout
12649 =""] This paragraph will appear in the table of contents of the given type.
12650 An empty string disables.
12651 See also the OutlinerName and the IsTocCaption commands.
12655 \begin_layout Description
12656 \begin_inset Flex Code
12659 \begin_layout Plain Layout
12666 \begin_inset Flex Code
12669 \begin_layout Plain Layout
12674 , left, right, center
12679 ] Paragraph alignment.
12682 \begin_layout Description
12683 \begin_inset Flex Code
12686 \begin_layout Plain Layout
12693 \begin_inset Flex Code
12696 \begin_layout Plain Layout
12701 , left, right, center
12706 ] A comma separated list of permitted alignments.
12707 (Some \SpecialChar LaTeX
12708 styles prohibit certain alignments, since those wouldn't make sense.
12709 For example a right-aligned or centered enumeration isn't possible.)
12712 \begin_layout Description
12713 \begin_inset Flex Code
12716 \begin_layout Plain Layout
12723 \begin_inset Flex Code
12726 \begin_layout Plain Layout
12732 ] Defines argument number <int> of a command\SpecialChar breakableslash
12733 environment associated with
12735 This is useful for things like section headings, and only makes sense with
12738 Every (optional or required) argument of a command or environment – except
12739 for the required argument that is associated with the content of the paragraph
12740 itself – has a separate definition, where the number specifies the order
12742 The definition must end with
12743 \begin_inset Flex Code
12746 \begin_layout Plain Layout
12753 So a command with two optional arguments has:
12757 \begin_layout Quote
12763 \begin_layout Quote
12769 \begin_layout Quote
12775 \begin_layout Quote
12781 \begin_layout Quote
12787 \begin_layout Quote
12793 \begin_layout Standard
12795 \begin_inset Flex Code
12798 \begin_layout Plain Layout
12804 definition, the following specifications are possible:
12807 \begin_layout Itemize
12808 \begin_inset Flex Code
12811 \begin_layout Plain Layout
12818 \begin_inset Flex Code
12821 \begin_layout Plain Layout
12827 The string that will appear both in the menu (to insert this argument)
12828 and on the argument inset button (unless you also specify a separate
12829 \begin_inset Flex Code
12832 \begin_layout Plain Layout
12839 For the menu, you can define an accelerator by appending the respective
12840 character to the string, divided by
12841 \begin_inset Quotes eld
12845 \begin_inset Quotes erd
12849 \begin_inset space \thinspace{}
12853 \begin_inset space \space{}
12857 \begin_inset Quotes eld
12861 \begin_inset Flex Code
12864 \begin_layout Plain Layout
12871 \begin_inset Quotes erd
12877 \begin_layout Itemize
12878 \begin_inset Flex Code
12881 \begin_layout Plain Layout
12888 \begin_inset Flex Code
12891 \begin_layout Plain Layout
12897 A separate string for the menu.
12898 You can define an accelerator by appending the respective character to
12899 the string, divided by
12900 \begin_inset Quotes eld
12904 \begin_inset Quotes erd
12908 \begin_inset space \thinspace{}
12912 \begin_inset space \space{}
12916 \begin_inset Quotes eld
12920 \begin_inset Flex Code
12923 \begin_layout Plain Layout
12930 \begin_inset Quotes erd
12934 This specification is optional.
12935 If it is not given the
12936 \begin_inset Flex Code
12939 \begin_layout Plain Layout
12945 will be used instead for the menu.
12948 \begin_layout Itemize
12949 \begin_inset Flex Code
12952 \begin_layout Plain Layout
12959 \begin_inset Flex Code
12962 \begin_layout Plain Layout
12968 A longer explanatory text that appears in the tooltip when hovering over
12969 the argument inset.
12972 \begin_layout Itemize
12973 \begin_inset Flex Code
12976 \begin_layout Plain Layout
12983 \begin_inset Flex Code
12986 \begin_layout Plain Layout
12995 \begin_inset space \thinspace{}
12999 \begin_inset Flex Code
13002 \begin_layout Plain Layout
13008 ] Declare if this is a mandatory (1) or an optional (0) argument.
13009 Mandatory arguments will be output empty if not given, while optional arguments
13010 will not be output at all.
13011 By default, mandatory arguments are delimited by
13012 \begin_inset Flex Code
13015 \begin_layout Plain Layout
13021 , while optional arguments are delimited by
13022 \begin_inset Flex Code
13025 \begin_layout Plain Layout
13032 \change_inserted -712698321 1555579782
13036 \begin_layout Itemize
13038 \change_inserted -712698321 1555579780
13039 \begin_inset Flex Code
13042 \begin_layout Plain Layout
13044 \change_inserted -712698321 1555579780
13053 \begin_inset Flex Code
13056 \begin_layout Plain Layout
13058 \change_inserted -712698321 1555579780
13066 Option to define a different command (from the default
13067 \begin_inset Flex Code
13070 \begin_layout Plain Layout
13072 \change_inserted -712698321 1555579780
13084 ) to be used for line breaks.
13085 The initial backslash must not be specified.
13090 \begin_layout Itemize
13091 \begin_inset Flex Code
13094 \begin_layout Plain Layout
13101 \begin_inset Flex Code
13104 \begin_layout Plain Layout
13110 defines another argument (by its number) which this argument requires to
13111 be output if it is itself output.
13113 \begin_inset space \thinspace{}
13116 g., in \SpecialChar LaTeX
13117 commands, optional arguments often require previous optional arguments
13118 to be output (at least empty), as in
13119 \begin_inset Flex Code
13122 \begin_layout Plain Layout
13125 command[][argument]{text}
13131 This can be achieved by the statement
13132 \begin_inset Flex Code
13135 \begin_layout Plain Layout
13142 \begin_inset Flex Code
13145 \begin_layout Plain Layout
13154 \begin_layout Itemize
13155 \begin_inset Flex Code
13158 \begin_layout Plain Layout
13165 \begin_inset Flex Code
13168 \begin_layout Plain Layout
13174 defines a custom left delimiter (instead of
13175 \begin_inset Flex Code
13178 \begin_layout Plain Layout
13185 \begin_inset Flex Code
13188 \begin_layout Plain Layout
13195 A line break in the output can be indicated by
13196 \begin_inset Flex Code
13199 \begin_layout Plain Layout
13208 \begin_layout Itemize
13209 \begin_inset Flex Code
13212 \begin_layout Plain Layout
13219 \begin_inset Flex Code
13222 \begin_layout Plain Layout
13228 defines a custom right delimiter (instead of
13229 \begin_inset Flex Code
13232 \begin_layout Plain Layout
13239 \begin_inset Flex Code
13242 \begin_layout Plain Layout
13249 A line break in the output can be indicated by
13250 \begin_inset Flex Code
13253 \begin_layout Plain Layout
13262 \begin_layout Itemize
13263 \begin_inset Flex Code
13266 \begin_layout Plain Layout
13273 \begin_inset Flex Code
13276 \begin_layout Plain Layout
13282 defines an argument that is inserted if and only if no user-specified arguments
13284 \begin_inset space \thinspace{}
13288 \begin_inset space \space{}
13291 if no argument inset has been inserted (note that also an empty argument
13292 inset omits the DefaultArg).
13293 Multiple arguments need to be separated by comma.
13296 \begin_layout Itemize
13297 \begin_inset Flex Code
13300 \begin_layout Plain Layout
13307 \begin_inset Flex Code
13310 \begin_layout Plain Layout
13316 defines an argument that is inserted in any case (alone or in addition
13317 to user-specified arguments).
13318 Multiple arguments need to be separated by comma.
13321 \begin_layout Itemize
13322 \begin_inset Flex Code
13325 \begin_layout Plain Layout
13331 The font used for the argument content, see
13332 \begin_inset CommandInset ref
13334 reference "subsec:Font-description"
13339 \change_inserted -712698321 1559484228
13343 \begin_layout Itemize
13345 \change_inserted -712698321 1559484228
13346 \begin_inset Flex Code
13349 \begin_layout Plain Layout
13351 \change_inserted -712698321 1559484228
13360 \begin_inset Flex Code
13363 \begin_layout Plain Layout
13365 \change_inserted -712698321 1559484228
13376 \begin_inset space \thinspace{}
13380 \begin_inset Flex Code
13383 \begin_layout Plain Layout
13385 \change_inserted -712698321 1559484228
13393 ] As with paragraph styles, see
13394 \begin_inset CommandInset ref
13396 reference "subsec:Paragraph-Styles"
13405 \begin_layout Itemize
13406 \begin_inset Flex Code
13409 \begin_layout Plain Layout
13415 The font used for the label; see
13416 \begin_inset CommandInset ref
13418 reference "subsec:Font-description"
13425 \begin_layout Itemize
13426 \begin_inset Flex Code
13429 \begin_layout Plain Layout
13436 \begin_inset Flex Code
13439 \begin_layout Plain Layout
13444 , Minimalistic, Conglomerate
13449 ] describes the rendering style used for the inset's frame and buttons.
13452 \begin_layout Itemize
13453 \begin_inset Flex Code
13456 \begin_layout Plain Layout
13463 \begin_inset Flex Code
13466 \begin_layout Plain Layout
13473 \begin_inset Flex Code
13476 \begin_layout Plain Layout
13482 , this argument is automatically inserted when the respective style is selected.
13484 \change_deleted -712698321 1559484200
13485 Currently, only one argument per style\SpecialChar breakableslash
13486 layout can be automatically inserted.
13491 \begin_layout Itemize
13493 \change_inserted -712698321 1559491402
13494 \begin_inset Flex Code
13497 \begin_layout Plain Layout
13499 \change_inserted -712698321 1559490711
13508 \begin_inset Flex Code
13511 \begin_layout Plain Layout
13513 \change_inserted -712698321 1559490703
13522 \begin_inset Flex Code
13525 \begin_layout Plain Layout
13527 \change_inserted -712698321 1559490703
13535 , this argument will be inserted on a new line with
13536 \begin_inset Flex Code
13539 \begin_layout Plain Layout
13541 \change_inserted -712698321 1559491402
13549 (only available within Flex insets).
13552 \begin_layout Itemize
13553 \begin_inset Flex Code
13556 \begin_layout Plain Layout
13563 \begin_inset Flex Code
13566 \begin_layout Plain Layout
13573 \begin_inset Flex Code
13576 \begin_layout Plain Layout
13582 , this argument will be inserted with a copy of the co-text (either selected
13583 text or the whole paragraph) as content.
13586 \begin_layout Itemize
13587 \begin_inset Flex Code
13590 \begin_layout Plain Layout
13597 \begin_inset Flex Code
13600 \begin_layout Plain Layout
13610 ] Whether the contents of this argument should be output in raw form, meaning
13611 without special translations that \SpecialChar LaTeX
13614 \begin_inset Flex Code
13617 \begin_layout Plain Layout
13623 status is inherited by the inset or paragraph layout the argument belongs
13624 to, true and false change the status for the given argument only.
13627 \begin_layout Itemize
13628 \begin_inset Flex Code
13631 \begin_layout Plain Layout
13638 \begin_inset Flex Code
13641 \begin_layout Plain Layout
13642 string of characters
13651 Defines individual characters
13652 \begin_inset Newline linebreak
13655 that should be output in raw form, meaning without special translations
13656 that \SpecialChar LaTeX
13658 Note that, contrary to PassThru, this needs to be explicitly defined for
13660 That is, arguments do not inherit PassThruChars from their parent inset
13664 \begin_layout Itemize
13665 \begin_inset Flex Code
13668 \begin_layout Plain Layout
13675 \begin_inset Flex Code
13678 \begin_layout Plain Layout
13687 \begin_inset space \thinspace{}
13691 \begin_inset Flex Code
13694 \begin_layout Plain Layout
13700 ] If this is set to 1, the argument will output its content in the corresponding
13701 item in the table of contents.
13705 \begin_layout Standard
13706 By default, the text entered in the \SpecialChar LyX
13707 workarea in the respective layout is
13708 the last (mandatory) argument of a command if the
13709 \begin_inset Flex Code
13712 \begin_layout Plain Layout
13719 \begin_inset Flex Code
13722 \begin_layout Plain Layout
13729 However, arguments with the prefix
13730 \begin_inset Flex Code
13733 \begin_layout Plain Layout
13739 are output after this workarea argument.
13740 Note that post-argument numbering restarts at 1, so the first argument
13741 following the workarea argument is
13742 \begin_inset Flex Code
13745 \begin_layout Plain Layout
13752 Post-arguments are ignored in any other
13753 \begin_inset Flex Code
13756 \begin_layout Plain Layout
13763 \begin_inset Flex Code
13766 \begin_layout Plain Layout
13775 \begin_layout Standard
13777 \begin_inset Flex Code
13780 \begin_layout Plain Layout
13789 \begin_inset Flex Code
13792 \begin_layout Plain Layout
13801 \begin_inset Flex Code
13804 \begin_layout Plain Layout
13810 followed by the number (e.
13811 \begin_inset space \thinspace{}
13815 \begin_inset space \space{}
13819 \begin_inset Flex Code
13822 \begin_layout Plain Layout
13829 \change_inserted -712698321 1534487781
13833 \begin_layout Standard
13835 \change_inserted -712698321 1534488561
13836 Finally, there is a special argument type with the prefix
13837 \begin_inset Flex Code
13840 \begin_layout Plain Layout
13842 \change_inserted -712698321 1534487844
13851 It is not really an argument, but uses the argument interface (thus, the
13852 prefix is also followed by a number, e.
13853 \begin_inset space \thinspace{}
13858 \begin_inset Flex Code
13861 \begin_layout Plain Layout
13863 \change_inserted -712698321 1534488412
13864 Argument listpreamble:1
13872 As the name implies, it is targeted at lists such as
13889 Its content will be output at the list start, before the first
13890 \begin_inset Flex Code
13893 \begin_layout Plain Layout
13895 \change_inserted -712698321 1534488058
13905 , on an own line (a place that is otherwise not accessible in \SpecialChar LyX
13907 This way, users can insert redefinitions (of lengths etc.) to individual
13909 By default, these arguments do not have a delimiter.
13915 \begin_layout Description
13916 \begin_inset Flex Code
13919 \begin_layout Plain Layout
13925 Includes a comma-separated list of layouts that should be nested in and
13926 after the current layout.
13927 Only makes sense for nestable layouts (such as environments).
13929 \begin_inset Quotes eld
13933 \begin_inset Flex Code
13936 \begin_layout Plain Layout
13943 \begin_inset Quotes erd
13948 \begin_inset Flex Code
13951 \begin_layout Plain Layout
13960 \begin_layout Description
13961 \begin_inset Flex Code
13964 \begin_layout Plain Layout
13970 Note that this will completely override any prior
13971 \begin_inset Flex Code
13974 \begin_layout Plain Layout
13980 declaration for this style.
13982 \begin_inset Quotes eld
13986 \begin_inset Flex Code
13989 \begin_layout Plain Layout
13996 \begin_inset Quotes erd
14001 \begin_inset CommandInset ref
14003 reference "subsec:I18n"
14007 for details on its use.
14010 \begin_layout Description
14011 \begin_inset Flex Code
14014 \begin_layout Plain Layout
14021 \begin_inset Flex Code
14024 \begin_layout Plain Layout
14034 \begin_layout Plain Layout
14035 Note that a `float' here is a real number, such as: 1.5.
14040 The vertical space with which the last of a chain of paragraphs with this
14041 style is separated from the following paragraph.
14042 If the next paragraph has another style, the separations are not simply
14043 added, but the maximum is taken.
14046 \begin_layout Description
14047 \begin_inset Flex Code
14050 \begin_layout Plain Layout
14057 \begin_inset Flex Code
14060 \begin_layout Plain Layout
14066 ] The category for this style.
14067 This is used to group related styles in the style combobox on the toolbar.
14068 Any string can be used, but you may want to use existing categories with
14073 \begin_layout Description
14074 \begin_inset Flex Code
14077 \begin_layout Plain Layout
14083 Depth of XML command.
14084 Used only with XML-type formats.
14087 \begin_layout Description
14088 \begin_inset Flex Code
14091 \begin_layout Plain Layout
14098 \begin_inset Flex Code
14101 \begin_layout Plain Layout
14107 ] Copies all the features of an existing style into the current one.
14111 \begin_layout Description
14112 \begin_inset Flex Code
14115 \begin_layout Plain Layout
14122 \begin_inset Flex Code
14125 \begin_layout Plain Layout
14131 ] The name of a style whose preamble should be output
14136 This allows to ensure some ordering of the preamble snippets when macros
14137 definitions depend on one another.
14141 \begin_layout Plain Layout
14142 Note that, besides that functionality, there is no way to ensure any ordering
14144 The ordering that you see in a given version of \SpecialChar LyX
14145 may change without warning
14154 \begin_layout Description
14155 \begin_inset Flex Code
14158 \begin_layout Plain Layout
14165 \begin_inset Flex Code
14168 \begin_layout Plain Layout
14173 , Box, Filled_Box, Static
14178 ] The type of label that stands at the end of the paragraph (or sequence
14180 \begin_inset Flex Code
14183 \begin_layout Plain Layout
14190 \begin_inset Newline newline
14194 \begin_inset Flex Code
14197 \begin_layout Plain Layout
14204 \begin_inset Flex Code
14207 \begin_layout Plain Layout
14214 \begin_inset Flex Code
14217 \begin_layout Plain Layout
14225 \begin_inset Flex Code
14228 \begin_layout Plain Layout
14235 \begin_inset Quotes eld
14239 \begin_inset Quotes erd
14243 \begin_inset Flex Code
14246 \begin_layout Plain Layout
14253 \begin_inset space \space{}
14257 \begin_inset Flex Code
14260 \begin_layout Plain Layout
14266 ) is a white (resp.
14267 \begin_inset space ~
14270 black) square suitable for end of proof markers,
14271 \begin_inset Flex Code
14274 \begin_layout Plain Layout
14280 is an explicit text string.
14283 \begin_layout Description
14284 \begin_inset Flex Code
14287 \begin_layout Plain Layout
14294 \begin_inset Flex Code
14297 \begin_layout Plain Layout
14303 ] The string used for a label with a
14304 \begin_inset Flex Code
14307 \begin_layout Plain Layout
14314 \begin_inset Newline newline
14318 \begin_inset Flex Code
14321 \begin_layout Plain Layout
14331 \begin_layout Description
14332 \begin_inset Flex Code
14335 \begin_layout Plain Layout
14341 The font used for both the text body
14347 \begin_inset CommandInset ref
14349 reference "subsec:Font-description"
14354 Note that defining this font automatically defines the
14355 \begin_inset Flex Code
14358 \begin_layout Plain Layout
14365 So you should define this one first if you also want to define
14366 \begin_inset Flex Code
14369 \begin_layout Plain Layout
14378 \begin_layout Description
14379 \begin_inset Flex Code
14382 \begin_layout Plain Layout
14389 \begin_inset Flex Code
14392 \begin_layout Plain Layout
14398 ] Used for backporting new styles to stable \SpecialChar LyX
14400 The first stable version that supports this tag is \SpecialChar LyX
14402 The argument is a number which may either be 0, -1 or any value greater
14405 \begin_inset Flex Code
14408 \begin_layout Plain Layout
14414 flag of a style is greater than zero, it will always be written to the
14416 If a .lyx file is read, the style definitions from the document header are
14417 added to the document class.
14418 Therefore even older \SpecialChar LyX
14419 versions can handle the style.
14421 \begin_inset Flex Code
14424 \begin_layout Plain Layout
14430 is a version number: if the style is read, and the version number is less
14431 than the version number of the already existing style in the document class,
14432 the new style is ignored.
14433 If the version number is greater, the new style replaces the existing style.
14434 A value of -1 means an infinite version number, i.
14435 \begin_inset space \thinspace{}
14439 \begin_inset space \space{}
14442 the style is always used.
14445 \begin_layout Description
14446 \begin_inset Flex Code
14449 \begin_layout Plain Layout
14456 \begin_inset Flex Code
14459 \begin_layout Plain Layout
14468 \begin_inset space \thinspace{}
14472 \begin_inset Flex Code
14475 \begin_layout Plain Layout
14481 ] Usually \SpecialChar LyX
14482 does not allow you to insert more than one space between words,
14483 since a space is considered as the separation between two words, not a
14484 character or symbol of its own.
14485 This is a very fine thing but sometimes annoying, for example, when typing
14486 program code or plain \SpecialChar LaTeX
14489 \begin_inset Flex Code
14492 \begin_layout Plain Layout
14500 \change_deleted -495245474 1550490105
14504 will create protected blanks for the additional blanks when in
14505 \change_inserted -495245474 1550490096
14507 \begin_inset Flex Code
14510 \begin_layout Plain Layout
14512 \change_inserted -495245474 1550490089
14521 \change_deleted -495245474 1550490116
14522 another mode than \SpecialChar LaTeX
14525 \change_inserted -495245474 1550247760
14527 \begin_inset Flex Code
14530 \begin_layout Plain Layout
14532 \change_inserted -495245474 1550247736
14541 \begin_inset Flex Code
14544 \begin_layout Plain Layout
14546 \change_inserted -495245474 1550247755
14559 \begin_layout Description
14560 \begin_inset Flex Code
14563 \begin_layout Plain Layout
14569 These tags are used with XHTML output.
14571 \begin_inset CommandInset ref
14573 reference "subsec:Paragraph-Style-XHTML"
14580 \begin_layout Description
14581 \begin_inset Flex Code
14584 \begin_layout Plain Layout
14590 [FIXME] (Used only with XML-type formats.)
14593 \begin_layout Description
14594 \begin_inset Flex Code
14597 \begin_layout Plain Layout
14604 \begin_inset Flex Code
14607 \begin_layout Plain Layout
14616 \begin_inset space \thinspace{}
14620 \begin_inset Flex Code
14623 \begin_layout Plain Layout
14630 \begin_inset Flex Code
14633 \begin_layout Plain Layout
14639 , marks the style as to be included in the document preamble and not in
14641 This is useful for document classes that want such information as the title
14642 and author to appear in the preamble.
14643 Note that this works only for styles for which the
14644 \begin_inset Flex Code
14647 \begin_layout Plain Layout
14654 \begin_inset Flex Code
14657 \begin_layout Plain Layout
14664 \begin_inset Flex Code
14667 \begin_layout Plain Layout
14676 \begin_layout Description
14677 \begin_inset Flex Code
14680 \begin_layout Plain Layout
14687 \begin_inset Flex Code
14690 \begin_layout Plain Layout
14699 \begin_inset space \thinspace{}
14703 \begin_inset Flex Code
14706 \begin_layout Plain Layout
14713 \begin_inset Flex Code
14716 \begin_layout Plain Layout
14722 , marks the style as being part of a title block (see also the
14723 \begin_inset Flex Code
14726 \begin_layout Plain Layout
14733 \begin_inset Flex Code
14736 \begin_layout Plain Layout
14745 \begin_layout Description
14746 \begin_inset Flex Code
14749 \begin_layout Plain Layout
14755 Includes a comma-separated list of layouts after which this one should
14757 Only makes sense with regard to nestable layouts (such as environments).
14759 \begin_inset Quotes eld
14763 \begin_inset Flex Code
14766 \begin_layout Plain Layout
14773 \begin_inset Quotes erd
14778 \begin_inset Flex Code
14781 \begin_layout Plain Layout
14790 \begin_layout Description
14791 \begin_inset Flex Code
14794 \begin_layout Plain Layout
14801 \begin_inset Flex Code
14804 \begin_layout Plain Layout
14813 \begin_inset space \thinspace{}
14817 \begin_inset Flex Code
14820 \begin_layout Plain Layout
14826 ] If this is set to 1 and AddToToc is enabled, the paragraph adds a summary
14827 of its contents in its item in the table of contents.
14828 Otherwise, only the label, if it exists, appears.
14831 \begin_layout Description
14832 \begin_inset Flex Code
14835 \begin_layout Plain Layout
14842 \begin_inset Flex Code
14845 \begin_layout Plain Layout
14851 ] The \SpecialChar LaTeX
14852 command sequence declaring an item in a list.
14853 The command is to be defined without the preceding backslash (the default
14855 \begin_inset Quotes eld
14859 \begin_inset Quotes erd
14863 \begin_inset Flex Code
14866 \begin_layout Plain Layout
14874 in the \SpecialChar LaTeX
14878 \begin_layout Description
14879 \begin_inset Flex Code
14882 \begin_layout Plain Layout
14889 \begin_inset Flex Code
14892 \begin_layout Plain Layout
14898 ] This provides extra space between paragraphs that have the same style.
14899 If you put other styles into an environment, each is separated with the
14901 \begin_inset Flex Code
14904 \begin_layout Plain Layout
14911 But the whole items of the environment are additionally separated with
14913 \begin_inset Flex Code
14916 \begin_layout Plain Layout
14923 Note that this is a
14928 \begin_layout Description
14929 \begin_inset Flex Code
14932 \begin_layout Plain Layout
14938 [FIXME] (Used only with XML-type formats.)
14941 \begin_layout Description
14942 \begin_inset Flex Code
14945 \begin_layout Plain Layout
14952 \begin_inset Flex Code
14955 \begin_layout Plain Layout
14964 \begin_inset space \thinspace{}
14968 \begin_inset Flex Code
14971 \begin_layout Plain Layout
14977 ] Usually \SpecialChar LyX
14978 does not allow you to leave a paragraph empty, since it would
14979 lead to empty \SpecialChar LaTeX
14981 There are some cases where this could be desirable however: in a letter
14982 template, the required fields can be provided as empty fields, so that
14983 people do not forget them; in some special classes, a style can be used
14984 as some kind of break, which does not contain actual text.
14987 \begin_layout Description
14988 \begin_inset Flex Code
14991 \begin_layout Plain Layout
14998 \begin_inset Flex Code
15001 \begin_layout Plain Layout
15007 ] The vertical space between the label and the text body.
15008 Only used for labels that are above the text body (
15009 \begin_inset Flex Code
15012 \begin_layout Plain Layout
15019 \begin_inset Newline newline
15023 \begin_inset Flex Code
15026 \begin_layout Plain Layout
15027 Centered_Top_Environment
15035 \begin_layout Description
15036 \begin_inset Flex Code
15039 \begin_layout Plain Layout
15046 \begin_inset Flex Code
15049 \begin_layout Plain Layout
15055 ] The name of the counter for automatic numbering.
15056 In order to have the counter appear with your label, you will need to reference
15058 \begin_inset Flex Code
15061 \begin_layout Plain Layout
15070 This will work with
15071 \begin_inset Flex Code
15074 \begin_layout Plain Layout
15081 \begin_inset Flex Code
15084 \begin_layout Plain Layout
15091 \begin_inset Flex Code
15094 \begin_layout Plain Layout
15101 \begin_inset Flex Code
15104 \begin_layout Plain Layout
15111 \begin_inset Newline newline
15119 \begin_inset Flex Code
15122 \begin_layout Plain Layout
15129 \begin_inset Flex Code
15132 \begin_layout Plain Layout
15138 , though this case is a bit complicated.
15139 Suppose you declare
15140 \begin_inset Quotes eld
15144 \begin_inset Flex Code
15147 \begin_layout Plain Layout
15148 LabelCounter myenum
15154 \begin_inset Quotes erd
15158 Then the actual counters used are
15159 \begin_inset Flex Code
15162 \begin_layout Plain Layout
15169 \begin_inset Flex Code
15172 \begin_layout Plain Layout
15179 \begin_inset Flex Code
15182 \begin_layout Plain Layout
15189 \begin_inset Flex Code
15192 \begin_layout Plain Layout
15198 , much as in \SpecialChar LaTeX
15200 These counters must all be declared separately.
15201 \begin_inset Newline newline
15205 \begin_inset CommandInset ref
15207 reference "subsec:Counters"
15211 for details on counters.
15214 \begin_layout Description
15215 \begin_inset Flex Code
15218 \begin_layout Plain Layout
15224 The font used for the label.
15226 \begin_inset CommandInset ref
15228 reference "subsec:Font-description"
15235 \begin_layout Description
15236 \begin_inset Flex Code
15239 \begin_layout Plain Layout
15246 \begin_inset Flex Code
15249 \begin_layout Plain Layout
15255 ] Text that indicates how far a label should be indented.
15258 \begin_layout Description
15259 \begin_inset Flex Code
15262 \begin_layout Plain Layout
15269 \begin_inset Flex Code
15272 \begin_layout Plain Layout
15278 ] Text that indicates the amount of horizontal space between the label and
15280 Only used for labels that are not above the text body.
15283 \begin_layout Description
15284 \begin_inset Flex Code
15287 \begin_layout Plain Layout
15294 \begin_inset Flex Code
15297 \begin_layout Plain Layout
15303 ] The string used for the label.
15305 \begin_inset Flex Code
15308 \begin_layout Plain Layout
15314 is set, this string can be contain the special formatting commands described
15316 \begin_inset CommandInset ref
15318 reference "subsec:Counters"
15325 \begin_layout Description
15326 \begin_inset Flex Code
15329 \begin_layout Plain Layout
15330 LabelStringAppendix
15336 \begin_inset Flex Code
15339 \begin_layout Plain Layout
15345 ] This is used inside the appendix instead of
15346 \begin_inset Newline newline
15350 \begin_inset Flex Code
15353 \begin_layout Plain Layout
15361 \begin_inset Flex Code
15364 \begin_layout Plain Layout
15371 \begin_inset Newline newline
15375 \begin_inset Flex Code
15378 \begin_layout Plain Layout
15379 LabelStringAppendix
15387 \begin_layout Description
15388 \begin_inset Flex Code
15391 \begin_layout Plain Layout
15397 [FIXME] (Used only with XML-type formats.)
15400 \begin_layout Description
15401 \begin_inset Flex Code
15404 \begin_layout Plain Layout
15411 \begin_inset Flex Code
15414 \begin_layout Plain Layout
15419 , Manual, Static, Above,
15420 \begin_inset Newline newline
15423 Centered, Sensitive, Enumerate,
15424 \begin_inset Newline newline
15427 Itemize, Bibliography
15436 \begin_layout Description
15437 \begin_inset Flex Code
15440 \begin_layout Plain Layout
15446 means the label is the very first word (up to the first real blank).
15447 Use protected spaces if you want more than one word as the label.
15451 \begin_layout Description
15452 \begin_inset Flex Code
15455 \begin_layout Plain Layout
15461 means the label is simply what is declared as
15462 \begin_inset Flex Code
15465 \begin_layout Plain Layout
15472 This will be displayed
15473 \begin_inset Quotes eld
15477 \begin_inset Quotes erd
15480 , at the beginning of the paragraph.
15482 \begin_inset Flex Code
15485 \begin_layout Plain Layout
15492 \begin_inset Flex Code
15495 \begin_layout Plain Layout
15501 , then it will be displayed only in the first paragraph of any sequence
15502 of paragraphs with the same
15503 \begin_inset Flex Code
15506 \begin_layout Plain Layout
15515 \begin_layout Description
15516 \begin_inset Flex Code
15519 \begin_layout Plain Layout
15526 \begin_inset space ~
15530 \begin_inset space ~
15534 \begin_inset Flex Code
15537 \begin_layout Plain Layout
15543 are special cases of
15544 \begin_inset Flex Code
15547 \begin_layout Plain Layout
15554 The label will be printed above the paragraph either at the beginning of
15555 the line or centered.
15558 \begin_layout Description
15559 \begin_inset Flex Code
15562 \begin_layout Plain Layout
15568 is a special case for the caption-labels
15569 \begin_inset Quotes eld
15573 \begin_inset Quotes erd
15577 \begin_inset Quotes eld
15581 \begin_inset Quotes erd
15585 \begin_inset Newline newline
15589 \begin_inset Flex Code
15592 \begin_layout Plain Layout
15598 means the (hardcoded) label string depends on the kind of float: It is
15599 hardcoded to be `FloatType N', where N is the value of the counter associated
15601 For the case that a caption is inserted outside of a float the
15602 \begin_inset Flex Code
15605 \begin_layout Plain Layout
15612 \begin_inset Quotes eld
15616 \begin_inset Quotes erd
15622 \begin_layout Description
15623 \begin_inset Flex Code
15626 \begin_layout Plain Layout
15632 produces the usual sort of enumeration labels.
15633 The number type needs to be set in the
15638 \begin_inset CommandInset ref
15640 reference "subsec:Counters"
15647 \begin_layout Description
15648 \begin_inset Flex Code
15651 \begin_layout Plain Layout
15657 produces various bullets at the different levels.
15658 The bullet types displayed can be set via
15659 \begin_inset Flex Noun
15662 \begin_layout Plain Layout
15663 Document\SpecialChar menuseparator
15664 Settings\SpecialChar menuseparator
15673 \begin_layout Description
15674 \begin_inset Flex Code
15677 \begin_layout Plain Layout
15683 should be used only with
15684 \begin_inset Flex Code
15687 \begin_layout Plain Layout
15688 LatexType BibEnvironment
15697 \begin_layout Description
15698 \begin_inset Flex Code
15701 \begin_layout Plain Layout
15707 Note that this will completely override any prior
15708 \begin_inset Flex Code
15711 \begin_layout Plain Layout
15717 declaration for this style.
15719 \begin_inset Quotes eld
15723 \begin_inset Flex Code
15726 \begin_layout Plain Layout
15733 \begin_inset Quotes erd
15738 \begin_inset CommandInset ref
15740 reference "subsec:I18n"
15744 for details on its use.
15747 \begin_layout Description
15748 \begin_inset Flex Code
15751 \begin_layout Plain Layout
15758 \begin_inset Flex Code
15761 \begin_layout Plain Layout
15767 ] The name of the corresponding \SpecialChar LaTeX
15769 Either the environment or command name.
15772 \begin_layout Description
15773 \begin_inset Flex Code
15776 \begin_layout Plain Layout
15783 \begin_inset Flex Code
15786 \begin_layout Plain Layout
15792 ] An optional parameter for the corresponding
15793 \begin_inset Flex Code
15796 \begin_layout Plain Layout
15803 This parameter cannot be changed from within \SpecialChar LyX
15805 \begin_inset Flex Code
15808 \begin_layout Plain Layout
15814 for customizable parameters).
15815 This will be output as is after all \SpecialChar LaTeX
15817 \begin_inset Flex Code
15820 \begin_layout Plain Layout
15829 \begin_layout Description
15830 \begin_inset Flex Code
15833 \begin_layout Plain Layout
15840 \begin_inset Flex Code
15843 \begin_layout Plain Layout
15848 , Command, Environment, Item_Environment,
15849 \begin_inset Newline newline
15852 List_Environment, Bib_Environment
15857 ] How the style should be translated into \SpecialChar LaTeX
15862 \begin_layout Plain Layout
15863 \begin_inset Flex Code
15866 \begin_layout Plain Layout
15872 is perhaps a bit misleading, since these rules apply to SGML classes, too.
15873 Visit the SGML class files for specific examples.
15882 \begin_layout Description
15883 \begin_inset Flex Code
15886 \begin_layout Plain Layout
15892 means nothing special.
15895 \begin_layout Description
15896 \begin_inset Flex Code
15899 \begin_layout Plain Layout
15906 \begin_inset Flex Code
15909 \begin_layout Plain Layout
15916 {\SpecialChar ldots
15925 \begin_layout Description
15926 \begin_inset Flex Code
15929 \begin_layout Plain Layout
15936 \begin_inset Flex Code
15939 \begin_layout Plain Layout
15946 }\SpecialChar ldots
15962 \begin_layout Description
15963 \begin_inset Flex Code
15966 \begin_layout Plain Layout
15973 \begin_inset Flex Code
15976 \begin_layout Plain Layout
15983 \begin_inset Flex Code
15986 \begin_layout Plain Layout
15994 is generated for each paragraph of this environment.
15998 \begin_layout Description
15999 \begin_inset Flex Code
16002 \begin_layout Plain Layout
16009 \begin_inset Flex Code
16012 \begin_layout Plain Layout
16019 \begin_inset Newline newline
16023 \begin_inset Flex Code
16026 \begin_layout Plain Layout
16032 is passed as an argument to the environment.
16033 \begin_inset Newline newline
16037 \begin_inset Flex Code
16040 \begin_layout Plain Layout
16046 can be defined in the
16047 \begin_inset Flex Noun
16050 \begin_layout Plain Layout
16051 Edit\SpecialChar menuseparator
16053 \begin_inset space ~
16064 \begin_layout Description
16065 \begin_inset Flex Code
16068 \begin_layout Plain Layout
16075 \begin_inset Flex Code
16078 \begin_layout Plain Layout
16084 but adds the necessary mandatory argument (the longest label) to the begin
16085 statement of the bibliography environment:
16086 \begin_inset Newline newline
16090 \begin_inset Flex Code
16093 \begin_layout Plain Layout
16096 begin{thebibliography}{99}
16102 It is therefore only useful for bibliography environments.
16103 The default longest label
16104 \begin_inset Quotes eld
16108 \begin_inset Quotes erd
16111 can be changed by the user in the paragraph settings of a bibliography
16115 \begin_layout Standard
16116 Putting the last few things together, the \SpecialChar LaTeX
16117 output will be either:
16120 \begin_layout LyX-Code
16123 LatexName[LatexParam]{\SpecialChar ldots
16127 \begin_layout Standard
16131 \begin_layout LyX-Code
16134 begin{LatexName}[LatexParam] \SpecialChar ldots
16140 \begin_layout Standard
16141 depending upon the \SpecialChar LaTeX
16146 \begin_layout Description
16147 \begin_inset Flex Code
16150 \begin_layout Plain Layout
16157 \begin_inset Flex Code
16160 \begin_layout Plain Layout
16166 ] A string that is put at the beginning of the style content.
16167 A line break in the output can be indicated by
16168 \begin_inset Flex Code
16171 \begin_layout Plain Layout
16180 \begin_layout Description
16181 \begin_inset Flex Code
16184 \begin_layout Plain Layout
16191 \begin_inset Flex Code
16194 \begin_layout Plain Layout
16200 ] If you put styles into environments, the different
16201 \begin_inset Flex Code
16204 \begin_layout Plain Layout
16210 are not simply added, but added with a factor
16211 \begin_inset Formula $\frac{4}{\mathrm{depth}+4}$
16215 Note that this parameter is also used when
16216 \begin_inset Flex Code
16219 \begin_layout Plain Layout
16226 \begin_inset Flex Code
16229 \begin_layout Plain Layout
16236 \begin_inset Flex Code
16239 \begin_layout Plain Layout
16246 Then it is added to the manual or dynamic margin.
16247 \begin_inset Newline newline
16251 \begin_inset Quotes eld
16255 \begin_inset Flex Code
16258 \begin_layout Plain Layout
16265 \begin_inset Quotes erd
16268 means that the paragraph is indented with the width of
16269 \begin_inset Quotes eld
16273 \begin_inset Flex Code
16276 \begin_layout Plain Layout
16283 \begin_inset Quotes erd
16286 in the normal font.
16287 You can get a negative width by prefixing the string with
16288 \begin_inset Quotes eld
16292 \begin_inset Flex Code
16295 \begin_layout Plain Layout
16302 \begin_inset Quotes erd
16306 This way was chosen so that the look is the same with each used screen
16310 \begin_layout Description
16311 \begin_inset Flex Code
16314 \begin_layout Plain Layout
16321 \begin_inset Flex Code
16324 \begin_layout Plain Layout
16329 , Manual, Dynamic, First_Dynamic, Right_Address_Box
16335 \begin_inset Newline newline
16338 The kind of margin that the style has on the left side.
16342 \begin_layout Description
16343 \begin_inset Flex Code
16346 \begin_layout Plain Layout
16352 just means a fixed margin.
16355 \begin_layout Description
16356 \begin_inset Flex Code
16359 \begin_layout Plain Layout
16365 means that the left margin depends on the string entered in the
16366 \begin_inset Flex Noun
16369 \begin_layout Plain Layout
16370 Edit\SpecialChar menuseparator
16372 \begin_inset space ~
16381 This is used to typeset nice lists without tabulators.
16384 \begin_layout Description
16385 \begin_inset Flex Code
16388 \begin_layout Plain Layout
16394 means that the margin depends on the size of the label.
16395 This is used for automatic enumerated headlines.
16396 It is obvious that the headline
16397 \begin_inset Quotes eld
16400 5.4.3.2.1 Very long headline
16401 \begin_inset Quotes erd
16404 must have a wider left margin (as wide as
16405 \begin_inset Quotes eld
16409 \begin_inset Quotes erd
16412 plus the space) than
16413 \begin_inset Quotes eld
16416 3.2 Very long headline
16417 \begin_inset Quotes erd
16421 \begin_inset Quotes eld
16425 \begin_inset Quotes erd
16428 are not able to do this.
16431 \begin_layout Description
16432 \begin_inset Flex Code
16435 \begin_layout Plain Layout
16441 is similar, but only the very first row of the paragraph is dynamic, while
16442 the others are static; this is used, for example, for descriptions.
16445 \begin_layout Description
16446 \begin_inset Flex Code
16449 \begin_layout Plain Layout
16455 means the margin is chosen in a way that the longest row of this paragraph
16456 fits to the right margin.
16457 This is used to typeset an address on the right edge of the page.
16461 \begin_layout Description
16462 \begin_inset Flex Code
16465 \begin_layout Plain Layout
16472 \begin_inset Flex Code
16475 \begin_layout Plain Layout
16484 \begin_inset space \thinspace{}
16488 \begin_inset Flex Code
16491 \begin_layout Plain Layout
16497 ] Whether fragile commands in this style should be
16498 \begin_inset Flex Code
16501 \begin_layout Plain Layout
16514 whether this command should itself be protected.)
16515 \change_inserted -712698321 1523696949
16519 \begin_layout Description
16521 \change_inserted -712698321 1552395557
16522 \begin_inset Flex Code
16525 \begin_layout Plain Layout
16527 \change_inserted -712698321 1523696950
16536 \begin_inset Flex Code
16539 \begin_layout Plain Layout
16541 \change_inserted -712698321 1523696950
16552 \begin_inset space \thinspace{}
16556 \begin_inset Flex Code
16559 \begin_layout Plain Layout
16561 \change_inserted -712698321 1523696950
16569 ] This causes macros that contain this layout to be protected with
16570 \begin_inset Flex Code
16573 \begin_layout Plain Layout
16575 \change_inserted -712698321 1523696950
16590 ) if necessary and thus allows (some) verbatim stuff in macros.
16593 \begin_layout Description
16595 \change_inserted -712698321 1552395844
16596 \begin_inset Flex Code
16599 \begin_layout Plain Layout
16601 \change_inserted -712698321 1552395561
16610 \begin_inset Flex Code
16613 \begin_layout Plain Layout
16615 \change_inserted -712698321 1552395557
16626 \begin_inset space \thinspace{}
16630 \begin_inset Flex Code
16633 \begin_layout Plain Layout
16635 \change_inserted -712698321 1552395557
16643 ] Whether specific commands in this style (such as
16644 \begin_inset Flex Code
16647 \begin_layout Plain Layout
16649 \change_inserted -712698321 1552395655
16660 \begin_inset Flex Code
16663 \begin_layout Plain Layout
16665 \change_inserted -712698321 1552395661
16675 ) should be protected in an
16676 \begin_inset Flex Code
16679 \begin_layout Plain Layout
16681 \change_inserted -712698321 1552395631
16692 This is particularly needed for styles that draw on
16700 commands which parse their content in complex ways.
16705 \begin_layout Description
16706 \begin_inset Flex Code
16709 \begin_layout Plain Layout
16716 \begin_inset Flex Code
16719 \begin_layout Plain Layout
16726 \begin_inset space \thinspace{}
16730 \begin_inset Flex Code
16733 \begin_layout Plain Layout
16741 ] Whether newlines are translated into \SpecialChar LaTeX
16743 \begin_inset Flex Code
16746 \begin_layout Plain Layout
16757 The translation can be switched off to allow more comfortable \SpecialChar LaTeX
16759 inside \SpecialChar LyX
16763 \begin_layout Description
16764 \begin_inset Flex Code
16767 \begin_layout Plain Layout
16774 \begin_inset Flex Code
16777 \begin_layout Plain Layout
16786 \begin_inset space \thinspace{}
16790 \begin_inset Flex Code
16793 \begin_layout Plain Layout
16799 ] If set to true, and if
16800 \begin_inset Flex Code
16803 \begin_layout Plain Layout
16810 \begin_inset Flex Code
16813 \begin_layout Plain Layout
16819 ) paragraphs are being indented, then the indentation of such a paragraph
16820 following one of this type will be suppressed.
16821 (So this will not affect the display of non-default paragraphs.)
16824 \begin_layout Description
16825 \begin_inset Flex Code
16828 \begin_layout Plain Layout
16835 \begin_inset Flex Code
16838 \begin_layout Plain Layout
16844 ] Name of a style that has replaced this style.
16845 This is used to rename a style, while keeping backward compatibility.
16848 \begin_layout Description
16849 \begin_inset Flex Code
16852 \begin_layout Plain Layout
16859 \begin_inset Flex Code
16862 \begin_layout Plain Layout
16869 \begin_inset space \thinspace{}
16873 \begin_inset Flex Code
16876 \begin_layout Plain Layout
16882 ] Determines whether consecutive paragraphs of the same type are treated
16883 as belonging together.
16884 This has the effect that the
16885 \begin_inset Flex Code
16888 \begin_layout Plain Layout
16894 is only printed once before such a group.
16895 By default, this is true for
16896 \begin_inset Flex Code
16899 \begin_layout Plain Layout
16906 \begin_inset Flex Code
16909 \begin_layout Plain Layout
16916 \begin_inset Flex Code
16919 \begin_layout Plain Layout
16925 and false for all other types.
16928 \begin_layout Description
16929 \begin_inset Flex Code
16932 \begin_layout Plain Layout
16939 \begin_inset Flex Code
16942 \begin_layout Plain Layout
16951 \begin_inset space \thinspace{}
16955 \begin_inset Flex Code
16958 \begin_layout Plain Layout
16964 ] Indicates that paragraphs will not be separated by an empty line in \SpecialChar LaTeX
16966 but only by a line break; together with
16967 \begin_inset Flex Code
16970 \begin_layout Plain Layout
16976 , this allows to emulate a plain text editor (like the ERT inset).
16979 \begin_layout Description
16980 \begin_inset Flex Code
16983 \begin_layout Plain Layout
16990 \begin_inset Flex Code
16993 \begin_layout Plain Layout
16999 ] The indent of the very first line of a paragraph.
17001 \begin_inset Newline newline
17005 \begin_inset Flex Code
17008 \begin_layout Plain Layout
17014 will be fixed for a certain style.
17015 The exception is the default style, since the indentation for these paragraphs
17016 can be prohibited with
17017 \begin_inset Flex Code
17020 \begin_layout Plain Layout
17028 \begin_inset Flex Code
17031 \begin_layout Plain Layout
17037 style paragraphs inside environments use the
17038 \begin_inset Flex Code
17041 \begin_layout Plain Layout
17047 of the environment, not their native one.
17049 \begin_inset Flex Code
17052 \begin_layout Plain Layout
17058 paragraphs inside an enumeration are not indented.
17061 \begin_layout Description
17062 \begin_inset Flex Code
17065 \begin_layout Plain Layout
17072 \begin_inset Flex Code
17075 \begin_layout Plain Layout
17081 ] The vertical space between two paragraphs of this style.
17084 \begin_layout Description
17085 \begin_inset Flex Code
17088 \begin_layout Plain Layout
17095 \begin_inset Flex Code
17098 \begin_layout Plain Layout
17105 allows the user to choose either
17106 \begin_inset Quotes eld
17110 \begin_inset Quotes erd
17114 \begin_inset Quotes eld
17118 \begin_inset Quotes erd
17121 to separate paragraphs.
17123 \begin_inset Quotes eld
17127 \begin_inset Quotes erd
17131 \begin_inset Flex Code
17134 \begin_layout Plain Layout
17142 \begin_inset Quotes eld
17146 \begin_inset Quotes erd
17150 \begin_inset Flex Code
17153 \begin_layout Plain Layout
17159 is ignored and all paragraphs are separated by the
17160 \begin_inset Flex Code
17163 \begin_layout Plain Layout
17170 The vertical space is calculated with
17171 \begin_inset Flex Code
17174 \begin_layout Plain Layout
17176 \begin_inset space ~
17185 \begin_inset Flex Code
17188 \begin_layout Plain Layout
17194 is the height of a row with the normal font.
17195 This way, the look stays the same with different screen fonts.
17198 \begin_layout Description
17199 \begin_inset Flex Code
17202 \begin_layout Plain Layout
17209 \begin_inset Flex Code
17212 \begin_layout Plain Layout
17221 \begin_inset space \thinspace{}
17225 \begin_inset Flex Code
17228 \begin_layout Plain Layout
17234 ] Whether the contents of this paragraph should be output in raw form, meaning
17235 without special translations that \SpecialChar LaTeX
17239 \begin_layout Description
17240 \begin_inset Flex Code
17243 \begin_layout Plain Layout
17250 \begin_inset Flex Code
17253 \begin_layout Plain Layout
17263 Defines individual characters that should be output in raw form, meaning
17264 without special translations that \SpecialChar LaTeX
17268 \begin_layout Description
17269 \begin_inset Flex Code
17272 \begin_layout Plain Layout
17278 Information to be included in the \SpecialChar LaTeX
17279 preamble when this style is used.
17280 Used to define macros, load packages, etc., required by this particular
17283 \begin_inset Quotes eld
17287 \begin_inset Flex Code
17290 \begin_layout Plain Layout
17297 \begin_inset Quotes erd
17303 \begin_layout Description
17304 \begin_inset Flex Code
17307 \begin_layout Plain Layout
17314 \begin_inset Flex Code
17317 \begin_layout Plain Layout
17323 ] The prefix to use when creating labels referring to paragraphs of this
17325 This allows the use of formatted references.
17328 \begin_layout Description
17329 \begin_inset Flex Code
17332 \begin_layout Plain Layout
17339 \begin_inset Flex Code
17342 \begin_layout Plain Layout
17348 ] Whether the style requires the feature
17349 \begin_inset Flex Code
17352 \begin_layout Plain Layout
17359 \begin_inset CommandInset ref
17361 reference "chap:List-of-functions"
17365 for the list of features).
17366 If you require a package with specific options, you can additionally use
17368 \begin_inset Flex Code
17371 \begin_layout Plain Layout
17377 as a general text class parameter (see
17378 \begin_inset CommandInset ref
17380 reference "subsec:General-text-class"
17387 \begin_layout Description
17388 \begin_inset Flex Code
17391 \begin_layout Plain Layout
17398 \begin_inset Flex Code
17401 \begin_layout Plain Layout
17410 \begin_inset Flex Code
17413 \begin_layout Plain Layout
17419 ] Resets the \SpecialChar LaTeX
17420 arguments of this style (as defined via the
17421 \begin_inset Flex Code
17424 \begin_layout Plain Layout
17431 This is useful if you have copied a style via
17432 \begin_inset Flex Code
17435 \begin_layout Plain Layout
17441 , but you do not want to inherit its (required and optional) arguments.
17444 \begin_layout Description
17445 \begin_inset Flex Code
17448 \begin_layout Plain Layout
17455 \begin_inset Flex Code
17458 \begin_layout Plain Layout
17467 \begin_inset Flex Code
17470 \begin_layout Plain Layout
17476 ] Resumes a counter that is usually reset at each new sequence of layouts.
17477 This is currently only useful when
17478 \begin_inset Flex Code
17481 \begin_layout Plain Layout
17488 \begin_inset Flex Code
17491 \begin_layout Plain Layout
17500 \begin_layout Description
17501 \begin_inset Flex Code
17504 \begin_layout Plain Layout
17511 \begin_inset Flex Code
17514 \begin_layout Plain Layout
17520 ] A string that is put at the end of the layout content.
17521 A line break in the output can be indicated by
17522 \begin_inset Flex Code
17525 \begin_layout Plain Layout
17534 \begin_layout Description
17535 \begin_inset Flex Code
17538 \begin_layout Plain Layout
17545 \begin_inset Flex Code
17548 \begin_layout Plain Layout
17555 \begin_inset Flex Code
17558 \begin_layout Plain Layout
17567 \begin_layout Description
17568 \begin_inset Flex Code
17571 \begin_layout Plain Layout
17578 \begin_inset Flex Code
17581 \begin_layout Plain Layout
17590 \begin_inset Flex Code
17593 \begin_layout Plain Layout
17600 \begin_inset Flex Code
17603 \begin_layout Plain Layout
17610 \begin_inset Flex Code
17613 \begin_layout Plain Layout
17615 \begin_inset space ~
17623 ] This defines what the default spacing should be in the style.
17625 \begin_inset Flex Code
17628 \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 correspond respectively to a multiplier value of 1, 1.25 and 1.667.
17655 If you specify the argument
17656 \begin_inset Flex Code
17659 \begin_layout Plain Layout
17665 , then you must also provide a value argument which will be the actual multiplie
17667 Note that, contrary to other parameters,
17668 \begin_inset Flex Code
17671 \begin_layout Plain Layout
17677 implies the generation of specific \SpecialChar LaTeX
17678 code, using the \SpecialChar LaTeX
17682 \begin_inset Flex Code
17685 \begin_layout Plain Layout
17694 \begin_layout Description
17695 \begin_inset Flex Code
17698 \begin_layout Plain Layout
17705 \begin_inset Flex Code
17708 \begin_layout Plain Layout
17715 \begin_inset space \thinspace{}
17719 \begin_inset Flex Code
17722 \begin_layout Plain Layout
17730 ] Allow spell-checking paragraphs of this style.
17734 \begin_layout Description
17735 \begin_inset Flex Code
17738 \begin_layout Plain Layout
17740 \change_deleted 731793113 1604355211
17742 \change_inserted 731793113 1604355212
17751 \begin_inset Flex Code
17754 \begin_layout Plain Layout
17763 \begin_inset Flex Code
17766 \begin_layout Plain Layout
17773 \change_deleted 731793113 1604355214
17775 \change_inserted 731793113 1604355216
17778 counter of a given counter at the beginning of a new sequence of layouts.
17779 This is currently only useful when
17780 \begin_inset Flex Code
17783 \begin_layout Plain Layout
17790 \begin_inset Flex Code
17793 \begin_layout Plain Layout
17802 \begin_layout Description
17803 \begin_inset Flex Code
17806 \begin_layout Plain Layout
17812 The font used for the text body .
17814 \begin_inset CommandInset ref
17816 reference "subsec:Font-description"
17823 \begin_layout Description
17824 \begin_inset Flex Code
17827 \begin_layout Plain Layout
17836 \begin_inset Flex Code
17839 \begin_layout Plain Layout
17849 The level of the style in the table of contents.
17850 This is used for automatic numbering of section headings.
17853 \begin_layout Description
17854 \begin_inset Flex Code
17857 \begin_layout Plain Layout
17866 \begin_inset Flex Code
17869 \begin_layout Plain Layout
17880 \begin_inset Flex Code
17883 \begin_layout Plain Layout
17890 \begin_inset Flex Code
17893 \begin_layout Plain Layout
17899 ] This tag determines whether the first line indentation of this paragraph
17900 can be toggled via the Paragraph settings dialog.
17904 \begin_inset Flex Code
17907 \begin_layout Plain Layout
17917 is set, indentation can be toggled if the document settings use
17918 \begin_inset Quotes eld
17922 \begin_inset Quotes erd
17925 paragraph style, with
17926 \begin_inset Flex Code
17929 \begin_layout Plain Layout
17935 , indentation can always be toggled, notwithstanding the document settings,
17937 \begin_inset Flex Code
17940 \begin_layout Plain Layout
17946 , indentation can never be toggled.
17949 \begin_layout Description
17950 \begin_inset Flex Code
17953 \begin_layout Plain Layout
17960 \begin_inset Flex Code
17963 \begin_layout Plain Layout
17969 ] The vertical space with which the very first of a chain of paragraphs
17970 with this style is separated from the previous paragraph.
17971 If the previous paragraph has another style, the separations are not simply
17972 added, but the maximum is taken.
17975 \begin_layout Subsection
17976 \begin_inset CommandInset label
17982 Internationalization of Paragraph Styles
17985 \begin_layout Standard
17987 has long supported internationalization of layout information, but, until
17988 version 2.0, this applied only to the user interface and not to, say, PDF
17990 Thus, French authors were forced to resort to ugly hacks if they wanted
17995 1' instead of `Theorem 1'.
17996 Thanks to Georg Baum, that is no longer the case.
17999 \begin_layout Standard
18001 \begin_inset Flex Code
18004 \begin_layout Plain Layout
18010 defines text that is to appear in the typeset document, it may use
18011 \begin_inset Flex Code
18014 \begin_layout Plain Layout
18021 \begin_inset Flex Code
18024 \begin_layout Plain Layout
18030 to support non-English and even multi-language documents correctly.
18031 The following excerpt (from the
18032 \begin_inset Flex Code
18035 \begin_layout Plain Layout
18041 file) shows how this works:
18044 \begin_layout LyX-Code
18049 \begin_layout LyX-Code
18052 theoremstyle{remark}
18055 \begin_layout LyX-Code
18058 newtheorem{claim}[thm]{
18065 \begin_layout LyX-Code
18069 \begin_layout LyX-Code
18073 \begin_layout LyX-Code
18078 claimname}{_(Claim)}
18081 \begin_layout LyX-Code
18085 \begin_layout LyX-Code
18089 \begin_layout LyX-Code
18098 claimname}{_(Claim)}}
18101 \begin_layout LyX-Code
18106 \begin_layout Standard
18107 In principle, any legal \SpecialChar LaTeX
18109 \begin_inset Flex Code
18112 \begin_layout Plain Layout
18119 \begin_inset Flex Code
18122 \begin_layout Plain Layout
18128 tags, but in practice they will typically look as they do here.
18129 The key to correct translation of the typeset text is the definition of
18130 the \SpecialChar LaTeX
18132 \begin_inset Flex Code
18135 \begin_layout Plain Layout
18144 \begin_inset Flex Code
18147 \begin_layout Plain Layout
18159 \begin_layout Standard
18161 \begin_inset Flex Code
18164 \begin_layout Plain Layout
18170 tag provides for internationalization based upon the overall language of
18172 The contents of the tag will be included in the preamble, just as with
18174 \begin_inset Flex Code
18177 \begin_layout Plain Layout
18184 What makes it special is the use of the
18185 \begin_inset Quotes eld
18189 \begin_inset Quotes erd
18193 \begin_inset Flex Code
18196 \begin_layout Plain Layout
18202 , which will be replaced, when \SpecialChar LyX
18203 produces \SpecialChar LaTeX
18204 output, with the translation of
18205 its argument into the document language.
18208 \begin_layout Standard
18210 \begin_inset Flex Code
18213 \begin_layout Plain Layout
18219 tag is more complex, since it is meant to provide support for multi-language
18220 documents and so offers an interface to the
18221 \begin_inset Flex Code
18224 \begin_layout Plain Layout
18231 Its contents will be added to the preamble once for each language that
18232 appears in the document.
18233 In this case, the argument to
18234 \begin_inset Flex Code
18237 \begin_layout Plain Layout
18243 will be replaced with its translation into the language in question; the
18245 \begin_inset Flex Code
18248 \begin_layout Plain Layout
18254 is replaced by the language name (as used by the babel package).
18257 \begin_layout Standard
18258 A German document that also included a French section would thus have the
18259 following in the preamble:
18262 \begin_layout LyX-Code
18271 claimname}{Affirmation}}
18272 \begin_inset Newline newline
18283 claimname}{Behauptung}}
18284 \begin_inset Newline newline
18291 claimname}{Behauptung}
18294 \begin_layout Standard
18297 \begin_inset Flex Code
18300 \begin_layout Plain Layout
18306 will then conspire to produce the correct text in the output.
18309 \begin_layout Standard
18310 One important point to note here is that the translations are provided by
18312 itself, through the file
18313 \begin_inset Flex Code
18316 \begin_layout Plain Layout
18323 This means, in effect, that
18324 \begin_inset Flex Code
18327 \begin_layout Plain Layout
18334 \begin_inset Flex Code
18337 \begin_layout Plain Layout
18343 are really only of use in layout files that are provided with \SpecialChar LyX
18345 entered in user-created layout files will not be seen by \SpecialChar LyX
18346 's internationalizatio
18347 n routines unless the
18348 \begin_inset Flex Code
18351 \begin_layout Plain Layout
18357 file is modified accordingly.
18358 That said, however, any layout created with the intention that it will
18359 be included with \SpecialChar LyX
18360 should use these tags where appropriate.
18361 Please note that the paragraph style translations provided by \SpecialChar LyX
18363 change with a minor update (e.
18364 \begin_inset space \thinspace{}
18368 \begin_inset space \space{}
18371 from version 2.1.x to 2.1.y).
18372 It is however quite likely that a major update (e.
18373 \begin_inset space \thinspace{}
18377 \begin_inset space \space{}
18380 from 2.0.x to 2.1.0) will introduce new translations or corrections.
18383 \begin_layout Subsection
18385 \begin_inset CommandInset label
18387 name "subsec:Floats"
18394 \begin_layout Standard
18395 It is necessary to define the floats (
18396 \begin_inset Flex Noun
18399 \begin_layout Plain Layout
18406 \begin_inset Flex Noun
18409 \begin_layout Plain Layout
18415 , \SpecialChar ldots
18416 ) in the text class itself.
18417 Standard floats are included in the file
18418 \begin_inset Flex Code
18421 \begin_layout Plain Layout
18427 , so you may have to do no more than add
18430 \begin_layout LyX-Code
18431 Input stdfloats.inc
18434 \begin_layout Standard
18435 to your layout file.
18436 If you want to implement a text class that proposes some other float types
18437 (like the AGU class bundled with \SpecialChar LyX
18438 ), the information below will hopefully
18442 \begin_layout Description
18443 \begin_inset Flex Code
18446 \begin_layout Plain Layout
18453 \begin_inset Flex Code
18456 \begin_layout Plain Layout
18462 =!htbpH] Allowed placement options for this float type.
18463 The value is a string of placement characters.
18464 Possible characters include:
18469 \begin_inset Quotes eld
18473 \begin_inset Quotes erd
18481 \begin_inset Quotes eld
18485 \begin_inset Quotes erd
18493 \begin_inset Quotes eld
18497 \begin_inset Quotes erd
18505 \begin_inset Quotes eld
18509 \begin_inset Quotes erd
18517 \begin_inset Quotes eld
18521 \begin_inset Quotes erd
18529 \begin_inset Quotes eld
18533 \begin_inset Quotes erd
18537 The order of the characters in the string does not matter.
18538 If no placement options are allowed, use the string
18545 \begin_layout Description
18546 \begin_inset Flex Code
18549 \begin_layout Plain Layout
18556 \begin_inset Flex Code
18559 \begin_layout Plain Layout
18568 \begin_inset space \thinspace{}
18574 \begin_inset Flex Code
18577 \begin_layout Plain Layout
18587 ] Defines whether the float allows to be rotated via the \SpecialChar LaTeX
18594 \begin_inset Flex Code
18597 \begin_layout Plain Layout
18603 if the float does not support this feature.
18606 \begin_layout Description
18607 \begin_inset Flex Code
18610 \begin_layout Plain Layout
18617 \begin_inset Flex Code
18620 \begin_layout Plain Layout
18629 \begin_inset space \thinspace{}
18635 \begin_inset Flex Code
18638 \begin_layout Plain Layout
18648 ] Defines whether the float has a starred variant that spans columns in
18649 a two column paragraph.
18651 \begin_inset Flex Code
18654 \begin_layout Plain Layout
18660 if the float does not support this feature.
18663 \begin_layout Description
18664 \begin_inset Flex Code
18667 \begin_layout Plain Layout
18674 \begin_inset Flex Code
18677 \begin_layout Plain Layout
18684 \begin_inset Quotes erd
18688 \begin_inset Quotes erd
18691 ] The file name extension of an auxiliary file for the list of figures (or
18694 writes the captions to this file.
18697 \begin_layout Description
18698 \begin_inset Flex Code
18701 \begin_layout Plain Layout
18708 \begin_inset Flex Code
18711 \begin_layout Plain Layout
18718 \begin_inset Quotes erd
18722 \begin_inset Quotes erd
18725 ] The string that will be used in the menus and also for the caption.
18726 This is translated to the current language if babel is used.
18729 \begin_layout Description
18730 \begin_inset Flex Code
18733 \begin_layout Plain Layout
18739 These tags control the XHTML output.
18741 \begin_inset CommandInset ref
18743 reference "sec:Tags-for-XHTML"
18750 \begin_layout Description
18751 \begin_inset Flex Code
18754 \begin_layout Plain Layout
18763 \begin_inset Flex Code
18766 \begin_layout Plain Layout
18775 \begin_inset space \thinspace{}
18779 \begin_inset Flex Code
18782 \begin_layout Plain Layout
18788 ] Indicates whether the float is already defined in the document class or
18789 if instead the \SpecialChar LaTeX
18791 \begin_inset Flex Code
18794 \begin_layout Plain Layout
18800 needs to be loaded to define it on-the-fly.
18802 \begin_inset Flex Code
18805 \begin_layout Plain Layout
18812 \begin_inset Flex Code
18815 \begin_layout Plain Layout
18822 It should be set to
18823 \begin_inset Flex Code
18826 \begin_layout Plain Layout
18832 if the float is already defined by the \SpecialChar LaTeX
18836 \begin_layout Description
18837 \begin_inset Flex Code
18840 \begin_layout Plain Layout
18847 \begin_inset Flex Code
18850 \begin_layout Plain Layout
18857 \begin_inset Quotes erd
18861 \begin_inset Quotes erd
18864 ] The command used to generate a list of floats of this type; the leading
18873 \begin_inset Flex Code
18876 \begin_layout Plain Layout
18882 is false, since there is no standard way to generate this command.
18884 \begin_inset Flex Code
18887 \begin_layout Plain Layout
18893 is true, since in that case there is a standard way to define the command.
18896 \begin_layout Description
18897 \begin_inset Flex Code
18900 \begin_layout Plain Layout
18907 \begin_inset Flex Code
18910 \begin_layout Plain Layout
18917 \begin_inset Quotes erd
18921 \begin_inset Quotes erd
18924 ] A title for a list of floats of this kind (list of figures, tables, or
18926 It is used for the screen label within \SpecialChar LyX
18927 , it is used by \SpecialChar LaTeX
18929 it is used as the title in the XHTML output.
18930 It will be translated to the document language.
18933 \begin_layout Description
18934 \begin_inset Flex Code
18937 \begin_layout Plain Layout
18944 \begin_inset Flex Code
18947 \begin_layout Plain Layout
18954 \begin_inset Quotes erd
18958 \begin_inset Quotes erd
18961 ] This (optional) argument determines whether floats of this class will
18962 be numbered within some sectional unit of the document.
18964 \begin_inset Flex Code
18967 \begin_layout Plain Layout
18974 \begin_inset Quotes eld
18978 \begin_inset Flex Code
18981 \begin_layout Plain Layout
18988 \begin_inset Quotes erd
18991 , the floats will be numbered within chapters.
18995 \begin_layout Description
18996 \begin_inset Flex Code
18999 \begin_layout Plain Layout
19006 \begin_inset Flex Code
19009 \begin_layout Plain Layout
19016 \begin_inset Quotes erd
19020 \begin_inset Quotes erd
19023 ] The default placement for the given class of floats.
19024 The string should be as in standard \SpecialChar LaTeX
19026 \begin_inset Flex Code
19029 \begin_layout Plain Layout
19036 \begin_inset Flex Code
19039 \begin_layout Plain Layout
19046 \begin_inset Flex Code
19049 \begin_layout Plain Layout
19056 \begin_inset Flex Code
19059 \begin_layout Plain Layout
19065 for top, bottom, page, and here, respectively.
19069 \begin_layout Plain Layout
19070 Note that the order of these letters in the string is irrelevant, like in
19077 On top of that there is a new type,
19078 \begin_inset Flex Code
19081 \begin_layout Plain Layout
19087 , which does not really correspond to a float, since it means: put it
19088 \begin_inset Quotes eld
19092 \begin_inset Quotes erd
19096 Note however that the
19097 \begin_inset Flex Code
19100 \begin_layout Plain Layout
19106 specifier is special and, because of implementation details, cannot be
19107 used in non-built in float types.
19108 If you do not understand what this means, just use
19109 \begin_inset Quotes eld
19113 \begin_inset Flex Code
19116 \begin_layout Plain Layout
19123 \begin_inset Quotes erd
19129 \begin_layout Description
19130 \begin_inset Flex Code
19133 \begin_layout Plain Layout
19140 \begin_inset Flex Code
19143 \begin_layout Plain Layout
19149 ] The prefix to use when creating labels referring to floats of this type.
19150 This allows the use of formatted references.
19151 Note that you can remove any
19152 \begin_inset Flex Code
19155 \begin_layout Plain Layout
19161 set by a copied style by using the special value
19162 \begin_inset Quotes eld
19166 \begin_inset Quotes erd
19169 , which must be all caps.
19170 \change_inserted -712698321 1565605014
19174 \begin_layout Description
19176 \change_inserted -712698321 1565605014
19177 \begin_inset Flex Code
19180 \begin_layout Plain Layout
19182 \change_inserted -712698321 1565605014
19191 \begin_inset Flex Code
19194 \begin_layout Plain Layout
19196 \change_inserted -712698321 1565605014
19204 ] As with paragraph styles, see
19205 \begin_inset CommandInset ref
19207 reference "subsec:Paragraph-Styles"
19216 \begin_layout Description
19217 \begin_inset Flex Code
19220 \begin_layout Plain Layout
19227 \begin_inset Flex Code
19230 \begin_layout Plain Layout
19237 \begin_inset Quotes erd
19241 \begin_inset Quotes erd
19244 ] The style used when defining the float using
19245 \begin_inset Flex Code
19248 \begin_layout Plain Layout
19259 \begin_layout Description
19260 \begin_inset Flex Code
19263 \begin_layout Plain Layout
19270 \begin_inset Flex Code
19273 \begin_layout Plain Layout
19280 \begin_inset Quotes erd
19284 \begin_inset Quotes erd
19288 \begin_inset Quotes eld
19292 \begin_inset Quotes erd
19295 of the new class of floats, like program or algorithm.
19296 After the appropriate
19297 \begin_inset Flex Code
19300 \begin_layout Plain Layout
19309 \begin_inset Flex Code
19312 \begin_layout Plain Layout
19321 \begin_inset Flex Code
19324 \begin_layout Plain Layout
19335 \begin_layout Description
19336 \begin_inset Flex Code
19339 \begin_layout Plain Layout
19346 \begin_inset Flex Code
19349 \begin_layout Plain Layout
19356 \begin_inset space \thinspace{}
19360 \begin_inset Flex Code
19363 \begin_layout Plain Layout
19371 ] Specifies whether this float is defined using the \SpecialChar LaTeX
19373 \begin_inset Flex Code
19376 \begin_layout Plain Layout
19382 , either by the class file, another package or on-the-fly by \SpecialChar LyX
19386 \begin_layout Standard
19387 Note that defining a float with type
19388 \begin_inset Flex Code
19391 \begin_layout Plain Layout
19399 automatically defines the corresponding counter with name
19400 \begin_inset Flex Code
19403 \begin_layout Plain Layout
19414 \begin_layout Subsection
19415 Flex insets and InsetLayout
19416 \begin_inset CommandInset label
19418 name "subsec:Flex-insets-and"
19425 \begin_layout Standard
19426 Flex insets come in
19427 \change_deleted 5863208 1594239511
19429 \change_inserted 5863208 1594239512
19435 \begin_layout Itemize
19437 \begin_inset Flex Code
19440 \begin_layout Plain Layout
19446 ): These define semantic markup corresponding to such \SpecialChar LaTeX
19448 \begin_inset Flex Code
19451 \begin_layout Plain Layout
19460 \begin_inset Flex Code
19463 \begin_layout Plain Layout
19474 \begin_layout Itemize
19476 \begin_inset Flex Code
19479 \begin_layout Plain Layout
19485 ): These can be used to define custom collapsible insets, similar to \SpecialChar TeX
19487 footnote, and the like.
19488 An obvious example is an endnote inset, which is defined in the
19489 \begin_inset Flex Code
19492 \begin_layout Plain Layout
19501 \begin_layout Itemize
19503 \change_deleted 5863208 1594239528
19505 \begin_inset Flex Code
19508 \begin_layout Plain Layout
19514 ): For use with DocBook classes.
19519 \begin_layout Standard
19520 Flex insets are defined using the
19521 \begin_inset Flex Code
19524 \begin_layout Plain Layout
19530 tag, which shall be explained in a moment.
19533 \begin_layout Standard
19535 \begin_inset Flex Code
19538 \begin_layout Plain Layout
19544 tag also serves another function: It can be used to customize the general
19545 layout of many different types of insets.
19547 \begin_inset Flex Code
19550 \begin_layout Plain Layout
19556 can be used to customize the layout parameters for footnotes, marginal
19557 notes, note insets, \SpecialChar TeX
19558 code (ERT) insets, branches, listings, indexes, boxes,
19559 tables, algorithms, URLs, and captions, as well as to define Flex insets.
19562 \begin_layout Standard
19564 \begin_inset Flex Code
19567 \begin_layout Plain Layout
19573 definition must begin with a line of the form:
19576 \begin_layout LyX-Code
19580 \begin_layout Standard
19582 \begin_inset Flex Code
19585 \begin_layout Plain Layout
19591 indicates the inset whose layout is being defined, and here there are four
19595 \begin_layout Enumerate
19596 The layout for a pre-existing inset is being modified.
19597 In this case, can be
19598 \begin_inset Flex Code
19601 \begin_layout Plain Layout
19607 any one of the following:
19608 \begin_inset Flex Code
19611 \begin_layout Plain Layout
19618 \begin_inset Flex Code
19621 \begin_layout Plain Layout
19628 \begin_inset Flex Code
19631 \begin_layout Plain Layout
19638 \begin_inset Flex Code
19641 \begin_layout Plain Layout
19648 \begin_inset Flex Code
19651 \begin_layout Plain Layout
19658 \begin_inset Flex Code
19661 \begin_layout Plain Layout
19668 \begin_inset Flex Code
19671 \begin_layout Plain Layout
19678 \begin_inset Flex Code
19681 \begin_layout Plain Layout
19688 \begin_inset Flex Code
19691 \begin_layout Plain Layout
19698 \begin_inset Flex Code
19701 \begin_layout Plain Layout
19708 \begin_inset Flex Code
19711 \begin_layout Plain Layout
19718 \begin_inset Flex Code
19721 \begin_layout Plain Layout
19728 \begin_inset Flex Code
19731 \begin_layout Plain Layout
19738 \begin_inset Flex Code
19741 \begin_layout Plain Layout
19748 \begin_inset Flex Code
19751 \begin_layout Plain Layout
19758 \begin_inset Flex Code
19761 \begin_layout Plain Layout
19768 \begin_inset Flex Code
19771 \begin_layout Plain Layout
19778 \begin_inset Flex Code
19781 \begin_layout Plain Layout
19788 \begin_inset Flex Code
19791 \begin_layout Plain Layout
19798 \begin_inset Flex Code
19801 \begin_layout Plain Layout
19810 \begin_layout Enumerate
19811 The layout for a Flex inset is being defined.
19813 \begin_inset Flex Code
19816 \begin_layout Plain Layout
19822 must be of the form
19823 \begin_inset Quotes eld
19827 \begin_inset Flex Code
19830 \begin_layout Plain Layout
19837 \begin_inset Quotes erd
19841 \begin_inset Flex Code
19844 \begin_layout Plain Layout
19850 may be any valid identifier not used by a pre-existing Flex inset.
19851 The identifier may include spaces, but in that case the whole thing must
19852 be wrapped in quotes.
19853 Note that the definition of a flex inset
19858 \begin_inset Flex Code
19861 \begin_layout Plain Layout
19867 entry, declaring which type of inset it defines.
19870 \begin_layout Enumerate
19871 The layout for user specific branch is being defined.
19873 \begin_inset Flex Code
19876 \begin_layout Plain Layout
19882 must be of the form
19883 \begin_inset Quotes eld
19887 \begin_inset Flex Code
19890 \begin_layout Plain Layout
19897 \begin_inset Quotes erd
19901 \begin_inset Flex Code
19904 \begin_layout Plain Layout
19910 may be any valid identifier of branch defined in user's document.
19911 The identifier may include spaces, but in that case the whole thing must
19912 be wrapped in quotes.
19913 The main purpose of this feature is to allow \SpecialChar LaTeX
19914 wrapping around specific
19915 branches as user needs.
19918 \begin_layout Enumerate
19919 The layout of a user (or class) specific caption is being defined.
19921 \begin_inset Flex Code
19924 \begin_layout Plain Layout
19930 must be of the form
19931 \begin_inset Quotes eld
19935 \begin_inset Flex Code
19938 \begin_layout Plain Layout
19945 \begin_inset Quotes erd
19949 \begin_inset Flex Code
19952 \begin_layout Plain Layout
19958 specifies the name of the caption as it appears in the menu.
19959 Have a look at the standard caption (
19960 \begin_inset Flex Code
19963 \begin_layout Plain Layout
19969 ), the specific captions of the KOMA-Script classes (
19970 \begin_inset Flex Code
19973 \begin_layout Plain Layout
19980 \begin_inset Flex Code
19983 \begin_layout Plain Layout
19992 \begin_inset space ~
19996 \begin_inset Newline linebreak
20002 \begin_inset Flex Code
20005 \begin_layout Plain Layout
20011 ) for applications.
20014 \begin_layout Standard
20016 \begin_inset Flex Code
20019 \begin_layout Plain Layout
20025 definition can contain the following entries:
20028 \begin_layout Description
20029 \begin_inset Flex Code
20032 \begin_layout Plain Layout
20039 \begin_inset Flex Code
20042 \begin_layout Plain Layout
20048 =""] This inset will appear in the table of contents of the given type.
20049 An empty string disables.
20050 See also the OutlinerName and the IsTocCaption commands.
20051 This is only implemented for Flex insets.
20055 \begin_layout Description
20056 \begin_inset Flex Code
20059 \begin_layout Plain Layout
20066 \begin_inset Flex Code
20069 \begin_layout Plain Layout
20075 ] Defines argument number of a command\SpecialChar breakableslash
20076 environment associated with the current
20078 The definition must end with
20079 \begin_inset Flex Code
20082 \begin_layout Plain Layout
20090 \begin_inset CommandInset ref
20092 reference "subsec:Paragraph-Styles"
20099 \begin_layout Description
20100 \begin_inset Flex Code
20103 \begin_layout Plain Layout
20109 Preamble for changing language commands; see
20110 \begin_inset CommandInset ref
20112 reference "subsec:I18n"
20119 \begin_layout Description
20120 \begin_inset Flex Code
20123 \begin_layout Plain Layout
20130 \begin_inset Flex Code
20133 \begin_layout Plain Layout
20139 ] The color for the inset's background.
20141 \begin_inset CommandInset ref
20143 reference "chap:Names-of-colors"
20147 for a list of the available color names.
20150 \begin_layout Description
20151 \begin_inset Flex Code
20154 \begin_layout Plain Layout
20161 \begin_inset Flex Code
20164 \begin_layout Plain Layout
20173 \begin_inset space \thinspace{}
20177 \begin_inset Flex Code
20180 \begin_layout Plain Layout
20186 ] Whether to use the content of the inset as the label, when the inset is
20191 \begin_layout Description
20192 \begin_inset Flex Code
20195 \begin_layout Plain Layout
20202 \begin_inset Flex Code
20205 \begin_layout Plain Layout
20211 ] As with paragraph styles, see
20212 \begin_inset CommandInset ref
20214 reference "subsec:Paragraph-Styles"
20219 Note that you need to specify the complete type, e.
20220 \begin_inset space \thinspace{}
20224 \begin_inset space ~
20228 \begin_inset Flex Code
20231 \begin_layout Plain Layout
20232 CopyStyle Flex:<name>
20240 \begin_layout Description
20241 \begin_inset Flex Code
20244 \begin_layout Plain Layout
20251 \begin_inset Flex Code
20254 \begin_layout Plain Layout
20263 \begin_inset space \thinspace{}
20267 \begin_inset Flex Code
20270 \begin_layout Plain Layout
20276 ] Indicates whether the user may employ the Paragraph Settings dialog to
20277 customize the paragraph.
20280 \begin_layout Description
20281 \begin_inset Flex Code
20284 \begin_layout Plain Layout
20291 \begin_inset Flex Code
20294 \begin_layout Plain Layout
20301 \begin_inset Flex Code
20304 \begin_layout Plain Layout
20311 \begin_inset Flex Code
20314 \begin_layout Plain Layout
20320 , describing the rendering style used for the inset's frame and buttons.
20321 Footnotes generally use
20322 \begin_inset Flex Code
20325 \begin_layout Plain Layout
20331 , ERT insets generally
20332 \begin_inset Flex Code
20335 \begin_layout Plain Layout
20341 , and character styles
20342 \begin_inset Flex Code
20345 \begin_layout Plain Layout
20354 \begin_layout Description
20355 \begin_inset Flex Code
20358 \begin_layout Plain Layout
20365 \begin_inset Flex Code
20368 \begin_layout Plain Layout
20377 \begin_inset space \thinspace{}
20383 \begin_inset Flex Code
20386 \begin_layout Plain Layout
20395 \begin_inset Flex Code
20398 \begin_layout Plain Layout
20405 \begin_inset Flex Code
20408 \begin_layout Plain Layout
20415 Indicates whether the environment will stand on its own in the output or
20416 will appear inline with the surrounding text.
20417 If set to false, it is supposed that the \SpecialChar LaTeX
20418 environment ignores white space
20419 (including one newline character) after the
20420 \begin_inset Flex Code
20423 \begin_layout Plain Layout
20436 \begin_inset Flex Code
20439 \begin_layout Plain Layout
20453 \change_inserted 731793113 1538674858
20457 \begin_layout Description
20459 \change_inserted 731793113 1538674891
20460 \begin_inset Flex Code
20463 \begin_layout Plain Layout
20465 \change_inserted 731793113 1538674863
20477 ,1] Allow the contents of the inset to be edited externally (using whatever
20478 editor is defined for the document's output format).
20483 \begin_layout Description
20484 \begin_inset Flex Code
20487 \begin_layout Plain Layout
20493 Required at the end of the
20494 \begin_inset Flex Code
20497 \begin_layout Plain Layout
20506 \begin_layout Description
20507 \begin_inset Flex Code
20510 \begin_layout Plain Layout
20516 The font used for both the text body
20522 \begin_inset CommandInset ref
20524 reference "subsec:Font-description"
20529 Note that defining this font automatically defines the
20530 \begin_inset Flex Code
20533 \begin_layout Plain Layout
20539 to the same value, so define this first and define
20540 \begin_inset Flex Code
20543 \begin_layout Plain Layout
20549 later if you want them to be different.
20552 \begin_layout Description
20553 \begin_inset Flex Code
20556 \begin_layout Plain Layout
20557 FixedWidthPreambleEncoding
20563 \begin_inset Flex Code
20566 \begin_layout Plain Layout
20575 \begin_inset space \thinspace{}
20579 \begin_inset Flex Code
20582 \begin_layout Plain Layout
20588 ] Force a fixed width encoding for the translated contents of
20589 \begin_inset Flex Code
20592 \begin_layout Plain Layout
20599 \begin_inset Flex Code
20602 \begin_layout Plain Layout
20608 code generated by this layout.
20609 This is needed for special \SpecialChar LaTeX
20614 that do not work with variable width encodings such as
20619 This setting is ignored if fully Unicode aware \SpecialChar LaTeX
20620 backends such as Xe\SpecialChar TeX
20622 Lua\SpecialChar TeX
20626 \begin_layout Description
20627 \begin_inset Flex Code
20630 \begin_layout Plain Layout
20631 ForceLocalFontSwitch
20637 \begin_inset Flex Code
20640 \begin_layout Plain Layout
20649 \begin_inset space \thinspace{}
20653 \begin_inset Flex Code
20656 \begin_layout Plain Layout
20662 ] When using babel, always use a local font switch (
20663 \begin_inset Flex Code
20666 \begin_layout Plain Layout
20674 ), never a global one (such as
20675 \begin_inset Flex Code
20678 \begin_layout Plain Layout
20689 \begin_layout Description
20690 \begin_inset Flex Code
20693 \begin_layout Plain Layout
20700 \begin_inset Flex Code
20703 \begin_layout Plain Layout
20712 \begin_inset space \thinspace{}
20716 \begin_inset Flex Code
20719 \begin_layout Plain Layout
20726 \begin_inset Quotes eld
20730 \begin_inset Quotes erd
20733 language, leading to Left-to-Right (Latin) output, e.
20734 \begin_inset space \thinspace{}
20738 \begin_inset space \space{}
20741 in \SpecialChar TeX
20746 \begin_layout Description
20747 \begin_inset Flex Code
20750 \begin_layout Plain Layout
20757 \begin_inset Flex Code
20760 \begin_layout Plain Layout
20769 \begin_inset space \thinspace{}
20773 \begin_inset Flex Code
20776 \begin_layout Plain Layout
20782 ] Force a line break in the \SpecialChar LaTeX
20783 output before the inset starts and after the
20785 This assures the inset itself is output on its own lines, for parsing purposes.
20788 \begin_layout Description
20789 \begin_inset Flex Code
20792 \begin_layout Plain Layout
20799 \begin_inset Flex Code
20802 \begin_layout Plain Layout
20811 \begin_inset space \thinspace{}
20815 \begin_inset Flex Code
20818 \begin_layout Plain Layout
20824 ] Indicates whether the
20825 \begin_inset Flex Code
20828 \begin_layout Plain Layout
20834 should be used or, instead, the user can change the paragraph style used
20839 \begin_layout Description
20840 \begin_inset Flex Code
20843 \begin_layout Plain Layout
20850 \begin_inset Flex Code
20853 \begin_layout Plain Layout
20862 \begin_inset space \thinspace{}
20866 \begin_inset Flex Code
20869 \begin_layout Plain Layout
20875 ] As with paragraph styles, see
20876 \begin_inset CommandInset ref
20878 reference "subsec:Paragraph-Styles"
20885 \begin_layout Description
20886 \begin_inset Flex Code
20889 \begin_layout Plain Layout
20895 These tags control the XHTML output.
20897 \begin_inset CommandInset ref
20899 reference "sec:Tags-for-XHTML"
20906 \begin_layout Description
20907 \begin_inset Flex Code
20910 \begin_layout Plain Layout
20917 \begin_inset Flex Code
20920 \begin_layout Plain Layout
20929 \begin_inset space \thinspace{}
20933 \begin_inset Flex Code
20936 \begin_layout Plain Layout
20942 ] Whether to include the contents of this inset in the strings generated
20943 for the `Outline' pane for all table of contents, regardless of the AddToToc
20945 One would not, for example, want the content of a footnote in a section
20946 header to be included in the TOC displayed in the outline, but one would
20947 normally want the content of a character style displayed.
20948 Default is false: not to include.
20951 \begin_layout Description
20952 \begin_inset Flex Code
20955 \begin_layout Plain Layout
20962 \begin_inset Flex Code
20965 \begin_layout Plain Layout
20974 \begin_inset space \thinspace{}
20978 \begin_inset Flex Code
20981 \begin_layout Plain Layout
20987 ] If this is set to 1 and AddToToc is enabled, the inset adds a summary
20988 of its contents in its item in the table of contents.
20989 Otherwise, only the label appears.
20992 \begin_layout Description
20993 \begin_inset Flex Code
20996 \begin_layout Plain Layout
21005 \begin_inset Flex Code
21008 \begin_layout Plain Layout
21017 \begin_inset space \thinspace{}
21021 \begin_inset Flex Code
21024 \begin_layout Plain Layout
21030 ] As with paragraph styles, see
21031 \begin_inset CommandInset ref
21033 reference "subsec:Paragraph-Styles"
21040 \begin_layout Description
21041 \begin_inset Flex Code
21044 \begin_layout Plain Layout
21050 The font used for the label.
21052 \begin_inset CommandInset ref
21054 reference "subsec:Font-description"
21059 Note that this definition can never appear before
21060 \begin_inset Flex Code
21063 \begin_layout Plain Layout
21069 , lest it be ineffective.
21072 \begin_layout Description
21073 \begin_inset Flex Code
21076 \begin_layout Plain Layout
21083 \begin_inset Flex Code
21086 \begin_layout Plain Layout
21093 \begin_inset Quotes erd
21097 \begin_inset Quotes erd
21100 ] What will be displayed on the button or elsewhere as the inset label.
21102 \begin_inset Flex Code
21105 \begin_layout Plain Layout
21113 \begin_inset Flex Code
21116 \begin_layout Plain Layout
21122 ) modify this label on the fly.
21125 \begin_layout Description
21126 \begin_inset Flex Code
21129 \begin_layout Plain Layout
21135 Language dependent preamble; see
21136 \begin_inset CommandInset ref
21138 reference "subsec:I18n"
21145 \begin_layout Description
21146 \begin_inset Flex Code
21149 \begin_layout Plain Layout
21156 \begin_inset Flex Code
21159 \begin_layout Plain Layout
21165 ] The name of the corresponding \SpecialChar LaTeX
21167 Either the environment or command name.
21170 \begin_layout Description
21171 \begin_inset Flex Code
21174 \begin_layout Plain Layout
21181 \begin_inset Flex Code
21184 \begin_layout Plain Layout
21190 ] The optional parameter for the corresponding
21191 \begin_inset Flex Code
21194 \begin_layout Plain Layout
21200 stuff, including possible bracket pairs like
21201 \begin_inset Flex Code
21204 \begin_layout Plain Layout
21211 This parameter cannot be changed from within \SpecialChar LyX
21213 \begin_inset Flex Code
21216 \begin_layout Plain Layout
21222 for customizable parameters).
21223 It will be output as is after all \SpecialChar LaTeX
21225 \begin_inset Flex Code
21228 \begin_layout Plain Layout
21237 \begin_layout Description
21238 \begin_inset Flex Code
21241 \begin_layout Plain Layout
21248 \begin_inset Flex Code
21251 \begin_layout Plain Layout
21252 Command, Environment, None
21257 ] How the style should be translated into \SpecialChar LaTeX
21262 \begin_layout Plain Layout
21263 \begin_inset Flex Code
21266 \begin_layout Plain Layout
21272 is perhaps a bit misleading, since these rules apply to SGML classes too.
21273 Visit the SGML class files for specific examples.
21282 \begin_layout Description
21283 \begin_inset Flex Code
21286 \begin_layout Plain Layout
21292 means nothing special
21295 \begin_layout Description
21296 \begin_inset Flex Code
21299 \begin_layout Plain Layout
21306 \begin_inset Flex Code
21309 \begin_layout Plain Layout
21316 {\SpecialChar ldots
21325 \begin_layout Description
21326 \begin_inset Flex Code
21329 \begin_layout Plain Layout
21336 \begin_inset Flex Code
21339 \begin_layout Plain Layout
21346 }\SpecialChar ldots
21361 \begin_layout Standard
21362 Putting the last few things together, the \SpecialChar LaTeX
21363 output will be either:
21366 \begin_layout LyX-Code
21369 LatexName[LatexParam]{\SpecialChar ldots
21373 \begin_layout Standard
21377 \begin_layout LyX-Code
21380 begin{LatexName}[LatexParam] \SpecialChar ldots
21386 \begin_layout Standard
21387 depending upon the \SpecialChar LaTeX
21392 \begin_layout Description
21393 \begin_inset Flex Code
21396 \begin_layout Plain Layout
21403 \begin_inset Flex Code
21406 \begin_layout Plain Layout
21412 ] A string that is put at the beginning of the layout content.
21413 A line break in the output can be indicated by
21414 \begin_inset Flex Code
21417 \begin_layout Plain Layout
21426 \begin_layout Description
21427 \begin_inset Flex Code
21430 \begin_layout Plain Layout
21437 \begin_inset Flex Code
21440 \begin_layout Plain Layout
21447 \begin_inset Flex Code
21450 \begin_layout Plain Layout
21457 \begin_inset Flex Code
21460 \begin_layout Plain Layout
21467 \begin_inset Flex Code
21470 \begin_layout Plain Layout
21476 (indicating a dummy definition ending definitions of charstyles, etc).
21477 This entry is required in and is only meaningful for Flex insets.
21478 Among other things, it determines on which menu this inset will appear.
21480 \begin_inset Flex Code
21483 \begin_layout Plain Layout
21490 \begin_inset Flex Code
21493 \begin_layout Plain Layout
21499 will automatically set
21500 \begin_inset Flex Code
21503 \begin_layout Plain Layout
21510 \begin_inset Flex Code
21513 \begin_layout Plain Layout
21521 \begin_inset Flex Code
21524 \begin_layout Plain Layout
21530 can be set to true, or
21531 \begin_inset Flex Code
21534 \begin_layout Plain Layout
21541 \begin_inset Flex Code
21544 \begin_layout Plain Layout
21550 insets by setting it
21555 \begin_inset Flex Code
21558 \begin_layout Plain Layout
21565 \change_inserted -712698321 1555575738
21569 \begin_layout Description
21571 \change_inserted -712698321 1555575844
21572 \begin_inset Flex Code
21575 \begin_layout Plain Layout
21577 \change_inserted -712698321 1555575740
21586 \begin_inset Flex Code
21589 \begin_layout Plain Layout
21591 \change_inserted -712698321 1555575740
21599 A dedicated string for the menu.
21600 You can define an accelerator by appending the respective character to
21601 the string, divided by
21602 \begin_inset Quotes eld
21606 \begin_inset Quotes erd
21610 \begin_inset space \thinspace{}
21614 \begin_inset space \space{}
21618 \begin_inset Quotes eld
21622 \begin_inset Flex Code
21625 \begin_layout Plain Layout
21627 \change_inserted -712698321 1555575781
21636 \begin_inset Quotes erd
21640 This specification is optional.
21641 If it is not given the inset name as specified in the type declaration
21642 will be used instead for the menu.
21647 \begin_layout Description
21648 \begin_inset Flex Code
21651 \begin_layout Plain Layout
21658 \begin_inset Flex Code
21661 \begin_layout Plain Layout
21670 \begin_inset space \thinspace{}
21674 \begin_inset Flex Code
21677 \begin_layout Plain Layout
21683 ] Whether multiple paragraphs are permitted in this inset.
21685 \begin_inset Flex Code
21688 \begin_layout Plain Layout
21694 to the same value and
21695 \begin_inset Flex Code
21698 \begin_layout Plain Layout
21704 to the opposite value.
21705 These can be reset to other values, if they are used
21710 \begin_inset Flex Code
21713 \begin_layout Plain Layout
21723 \begin_layout Description
21724 \begin_inset Flex Code
21727 \begin_layout Plain Layout
21734 \begin_inset Flex Code
21737 \begin_layout Plain Layout
21746 \begin_inset space \thinspace{}
21750 \begin_inset Flex Code
21753 \begin_layout Plain Layout
21759 ] Whether fragile commands in this inset should be
21760 \begin_inset Flex Code
21763 \begin_layout Plain Layout
21776 whether the command should itself be protected.) Default is false.
21777 \change_inserted -712698321 1523633958
21781 \begin_layout Description
21783 \change_inserted -712698321 1552395786
21784 \begin_inset Flex Code
21787 \begin_layout Plain Layout
21789 \change_inserted -712698321 1523633961
21798 \begin_inset Flex Code
21801 \begin_layout Plain Layout
21803 \change_inserted -712698321 1523633958
21814 \begin_inset space \thinspace{}
21818 \begin_inset Flex Code
21821 \begin_layout Plain Layout
21823 \change_inserted -712698321 1523633958
21831 ] This causes macros that contain this inset to be protected with
21832 \begin_inset Flex Code
21835 \begin_layout Plain Layout
21837 \change_inserted -712698321 1523634038
21852 ) if necessary and thus allows (some) verbatim stuff in macros.
21856 \begin_layout Description
21858 \change_inserted -712698321 1555579651
21859 \begin_inset Flex Code
21862 \begin_layout Plain Layout
21864 \change_inserted -712698321 1552395787
21873 \begin_inset Flex Code
21876 \begin_layout Plain Layout
21878 \change_inserted -712698321 1552395787
21889 \begin_inset space \thinspace{}
21893 \begin_inset Flex Code
21896 \begin_layout Plain Layout
21898 \change_inserted -712698321 1552395787
21906 ] Whether specific commands in this inset (such as
21907 \begin_inset Flex Code
21910 \begin_layout Plain Layout
21912 \change_inserted -712698321 1552395787
21923 \begin_inset Flex Code
21926 \begin_layout Plain Layout
21928 \change_inserted -712698321 1552395787
21938 ) should be protected in an
21939 \begin_inset Flex Code
21942 \begin_layout Plain Layout
21944 \change_inserted -712698321 1552395787
21955 This is particularly needed for insets that draw on
21963 commands which parse their content in complex ways.
21967 \begin_layout Description
21969 \change_inserted -712698321 1555579742
21970 \begin_inset Flex Code
21973 \begin_layout Plain Layout
21975 \change_inserted -712698321 1555579658
21984 \begin_inset Flex Code
21987 \begin_layout Plain Layout
21989 \change_inserted -712698321 1555579651
21997 Option to define a different command (from the default
21998 \begin_inset Flex Code
22001 \begin_layout Plain Layout
22003 \change_inserted -712698321 1555579742
22015 ) to be used for line breaks.
22016 The initial backslash must not be specified.
22021 \begin_layout Description
22022 \begin_inset Flex Code
22025 \begin_layout Plain Layout
22032 \begin_inset Flex Code
22035 \begin_layout Plain Layout
22041 ] Deletes an existing
22042 \begin_inset Flex Code
22045 \begin_layout Plain Layout
22054 \begin_layout Description
22055 \begin_inset Flex Code
22058 \begin_layout Plain Layout
22065 \begin_inset Flex Code
22068 \begin_layout Plain Layout
22075 \begin_inset Flex Code
22078 \begin_layout Plain Layout
22084 that has replaced this
22085 \begin_inset Flex Code
22088 \begin_layout Plain Layout
22095 This is used to rename an
22096 \begin_inset Flex Code
22099 \begin_layout Plain Layout
22105 , while keeping backward compatibility.
22106 \change_inserted -712698321 1559491850
22110 \begin_layout Description
22112 \change_inserted -712698321 1559492002
22113 \begin_inset Flex Code
22116 \begin_layout Plain Layout
22118 \change_inserted -712698321 1559491854
22127 \begin_inset Flex Code
22130 \begin_layout Plain Layout
22132 \change_inserted -712698321 1559491850
22143 \begin_inset space \thinspace{}
22147 \begin_inset Flex Code
22150 \begin_layout Plain Layout
22152 \change_inserted -712698321 1559491850
22160 ] If this is set to
22161 \begin_inset Flex Code
22164 \begin_layout Plain Layout
22166 \change_inserted -712698321 1559491881
22174 , paragraph breaks will be ignored in the output.
22175 This might be useful for insets where the content should be alignable on
22176 different lines only in the \SpecialChar LyX
22177 workarea, without any effect in the output.
22182 \begin_layout Description
22183 \begin_inset Flex Code
22186 \begin_layout Plain Layout
22193 \begin_inset Flex Code
22196 \begin_layout Plain Layout
22205 \begin_inset space \thinspace{}
22209 \begin_inset Flex Code
22212 \begin_layout Plain Layout
22218 ] As with paragraph styles, see
22219 \begin_inset CommandInset ref
22221 reference "subsec:Paragraph-Styles"
22229 \begin_layout Description
22230 \begin_inset Flex Code
22233 \begin_layout Plain Layout
22240 \begin_inset Flex Code
22243 \begin_layout Plain Layout
22252 \begin_inset space \thinspace{}
22256 \begin_inset Flex Code
22259 \begin_layout Plain Layout
22265 ] As with paragraph styles, see
22266 \begin_inset CommandInset ref
22268 reference "subsec:Paragraph-Styles"
22276 \begin_layout Description
22277 \begin_inset Flex Code
22280 \begin_layout Plain Layout
22286 As with paragraph styles, see
22287 \begin_inset CommandInset ref
22289 reference "subsec:Paragraph-Styles"
22296 \begin_layout Description
22297 \begin_inset Flex Code
22300 \begin_layout Plain Layout
22307 \begin_inset Flex Code
22310 \begin_layout Plain Layout
22316 ] The prefix to use when creating labels referring to insets of this type.
22317 This allows the use of formatted references.
22320 \begin_layout Description
22321 \begin_inset Flex Code
22324 \begin_layout Plain Layout
22331 \begin_inset Flex Code
22334 \begin_layout Plain Layout
22340 ] As with paragraph styles, see
22341 \begin_inset CommandInset ref
22343 reference "subsec:Paragraph-Styles"
22350 \begin_layout Description
22351 \begin_inset Flex Code
22354 \begin_layout Plain Layout
22361 \begin_inset Flex Code
22364 \begin_layout Plain Layout
22373 \begin_inset space \thinspace{}
22377 \begin_inset Flex Code
22380 \begin_layout Plain Layout
22386 ] Resets the \SpecialChar LaTeX
22387 arguments of this layout (as defined via the
22388 \begin_inset Flex Code
22391 \begin_layout Plain Layout
22398 This is useful if you have copied a style via
22399 \begin_inset Flex Code
22402 \begin_layout Plain Layout
22408 , but you do not want to inherit its (required and optional) arguments.
22411 \begin_layout Description
22412 \begin_inset Flex Code
22415 \begin_layout Plain Layout
22422 \begin_inset Flex Code
22425 \begin_layout Plain Layout
22434 \begin_inset space \thinspace{}
22438 \begin_inset Flex Code
22441 \begin_layout Plain Layout
22448 \change_inserted -712698321 1597733473
22450 \begin_inset Flex Code
22453 \begin_layout Plain Layout
22455 \change_inserted -712698321 1597732178
22463 , font changes are redone inside the respective inset (in the output) even
22464 if the inset itself is in the context of this font changes (e.
22465 \begin_inset space \thinspace{}
22469 \begin_inset Flex Code
22472 \begin_layout Plain Layout
22474 \change_inserted -712698321 1597733683
22477 textbf{Sourrounding text
22481 textbf{content}}\SpecialChar ldots
22490 \begin_inset Flex Code
22493 \begin_layout Plain Layout
22495 \change_inserted -712698321 1597733686
22498 textbf{Sourrounding text
22500 myinset{content}\SpecialChar ldots
22509 Setting this makes sense for commands that internally reset font settings
22511 \begin_inset space \thinspace{}
22515 Note that wrongly setting this might lead to unwanted result (e.
22516 \begin_inset space \thinspace{}
22520 \begin_inset Flex Code
22523 \begin_layout Plain Layout
22525 \change_inserted -712698321 1597733688
22528 emph{Sourrounding text
22532 emph{content}}\SpecialChar ldots
22540 , content is upright, as
22541 \begin_inset Flex Code
22544 \begin_layout Plain Layout
22546 \change_inserted -712698321 1597733278
22558 \change_deleted -712698321 1597733283
22559 Whether this inset should use the font of its surrounding environment or
22564 \change_deleted -712698321 1597733290
22566 \change_inserted -712698321 1597733290
22568 \begin_inset Flex Code
22571 \begin_layout Plain Layout
22573 \change_inserted -712698321 1597733292
22584 \change_deleted -712698321 1597733327
22585 use the font of the surrounding environment
22586 \change_inserted -712698321 1597733343
22587 font changes are not redone inside the inset
22592 \begin_layout Description
22593 \begin_inset Flex Code
22596 \begin_layout Plain Layout
22603 \begin_inset Flex Code
22606 \begin_layout Plain Layout
22612 ] A string that is put at the end of the layout content.
22613 A line break in the output can be indicated by
22614 \begin_inset Flex Code
22617 \begin_layout Plain Layout
22626 \begin_layout Description
22627 \begin_inset Flex Code
22630 \begin_layout Plain Layout
22637 \begin_inset Flex Code
22640 \begin_layout Plain Layout
22647 \begin_inset space \thinspace{}
22651 \begin_inset Flex Code
22654 \begin_layout Plain Layout
22662 ] Allow spell-checking the contents of this inset.
22666 \begin_layout Subsection
22668 \begin_inset CommandInset label
22670 name "subsec:Counters"
22677 \begin_layout Standard
22678 It is necessary to define the counters (
22679 \begin_inset Flex Noun
22682 \begin_layout Plain Layout
22689 \begin_inset Flex Noun
22692 \begin_layout Plain Layout
22698 , \SpecialChar ldots
22699 ) in the text class itself.
22700 The standard counters are defined in the file
22701 \begin_inset Flex Code
22704 \begin_layout Plain Layout
22710 , so you may have to do no more than add
22713 \begin_layout LyX-Code
22714 Input stdcounters.inc
22717 \begin_layout Standard
22718 to your layout file to get them to work.
22719 But if you want to define custom counters, then you can do so.
22720 The counter declaration must begin with:
22723 \begin_layout LyX-Code
22724 Counter CounterName
22727 \begin_layout Standard
22729 \begin_inset Flex Code
22732 \begin_layout Plain Layout
22738 ' is replaced by the name of the counter.
22739 And it must end with
22740 \begin_inset Quotes eld
22744 \begin_inset Flex Code
22747 \begin_layout Plain Layout
22754 \begin_inset Quotes erd
22758 The following parameters can also be used:
22761 \begin_layout Description
22762 \begin_inset Flex Code
22765 \begin_layout Plain Layout
22772 \begin_inset Flex Code
22775 \begin_layout Plain Layout
22781 ] Sets the initial value for the counter, to which it will be reset whenever
22783 Normally, one will want the default, 1.
22786 \begin_layout Description
22787 \begin_inset Flex Code
22790 \begin_layout Plain Layout
22797 \begin_inset Flex Code
22800 \begin_layout Plain Layout
22807 \begin_inset Quotes erd
22811 \begin_inset Quotes erd
22814 ] When defined, this string defines how the counter is displayed.
22815 Setting this value sets
22816 \begin_inset Flex Code
22819 \begin_layout Plain Layout
22820 LabelStringAppendix
22826 The following special constructs can be used in the string:
22830 \begin_layout Itemize
22831 \begin_inset Flex Code
22834 \begin_layout Plain Layout
22842 will be replaced by the expansion of the
22843 \begin_inset Flex Code
22846 \begin_layout Plain Layout
22853 \begin_inset Flex Code
22856 \begin_layout Plain Layout
22857 LabelStringAppendix
22863 \begin_inset Flex Code
22866 \begin_layout Plain Layout
22876 \begin_layout Itemize
22877 counter values can be expressed using \SpecialChar LaTeX
22879 \begin_inset Newline newline
22883 \begin_inset Flex Code
22886 \begin_layout Plain Layout
22903 \begin_inset Flex Code
22906 \begin_layout Plain Layout
22918 \begin_layout Plain Layout
22928 Actually, the situation is a bit more complicated: any
22947 other than those described below will produce arabic numerals.
22948 It would not be surprising to see this change in the future.
22954 \begin_inset Flex Code
22957 \begin_layout Plain Layout
22963 : 1, 2, 3,\SpecialChar ldots
22965 \begin_inset Flex Code
22968 \begin_layout Plain Layout
22974 for lower-case letters: a, b, c, \SpecialChar ldots
22976 \begin_inset Flex Code
22979 \begin_layout Plain Layout
22985 for upper-case letters: A, B, C, \SpecialChar ldots
22987 \begin_inset Flex Code
22990 \begin_layout Plain Layout
22996 for lower-case roman numerals: i, ii, iii, \SpecialChar ldots
22998 \begin_inset Flex Code
23001 \begin_layout Plain Layout
23007 for upper-case roman numerals: I, II, III\SpecialChar ldots
23009 \begin_inset Flex Code
23012 \begin_layout Plain Layout
23018 for hebrew numerals.
23022 \begin_layout Standard
23023 If LabelString is not defined, a default value is constructed as follows:
23024 if the counter has a
23025 \change_deleted 731793113 1604355218
23027 \change_inserted 731793113 1604355221
23031 \begin_inset Flex Code
23034 \begin_layout Plain Layout
23036 \change_deleted 731793113 1604355223
23038 \change_inserted 731793113 1604355226
23047 \begin_inset Flex Code
23050 \begin_layout Plain Layout
23057 \begin_inset Newline newline
23061 \begin_inset Flex Code
23064 \begin_layout Plain Layout
23068 \change_inserted 731793113 1604355228
23070 \change_deleted 731793113 1604355230
23080 is used; otherwise the string
23081 \begin_inset Flex Code
23084 \begin_layout Plain Layout
23095 \begin_layout Description
23096 \begin_inset Flex Code
23099 \begin_layout Plain Layout
23100 LabelStringAppendix
23106 \begin_inset Flex Code
23109 \begin_layout Plain Layout
23116 \begin_inset Quotes eld
23120 \begin_inset Quotes erd
23124 \begin_inset Flex Code
23127 \begin_layout Plain Layout
23133 , but for use in the Appendix.
23134 \change_inserted -584632292 1607202551
23138 \begin_layout Description
23140 \change_inserted -584632292 1607202682
23141 \begin_inset Flex Code
23144 \begin_layout Plain Layout
23151 \begin_inset Flex Code
23154 \begin_layout Plain Layout
23156 \change_inserted -584632292 1607202576
23165 \begin_inset Quotes eld
23169 \begin_inset Quotes erd
23172 ] The counter name as used in \SpecialChar LaTeX
23174 (E.g., in \SpecialChar LyX
23175 , there is a counter named `theorem', but it is output to \SpecialChar LaTeX
23181 \begin_layout Description
23182 \begin_inset Flex Code
23185 \begin_layout Plain Layout
23192 \begin_inset Flex Code
23195 \begin_layout Plain Layout
23202 \begin_inset Quotes erd
23206 \begin_inset Quotes erd
23209 ] A format for use with formatted references to this counter.
23210 For example, one might want to have references to section numbers appear
23212 \begin_inset Quotes eld
23216 \begin_inset Quotes erd
23220 The string should contain
23221 \begin_inset Quotes eld
23225 \begin_inset Quotes erd
23229 This will be replaced by the counter number itself.
23230 So, for sections, it would be: Section ##.
23233 \begin_layout Description
23234 \begin_inset Flex Code
23237 \begin_layout Plain Layout
23244 \begin_inset Flex Code
23247 \begin_layout Plain Layout
23254 \begin_inset Quotes erd
23258 \begin_inset Quotes erd
23261 ] If this is set to the name of another counter, the present counter will
23262 be reset every time the other one is increased.
23264 \begin_inset Flex Code
23267 \begin_layout Plain Layout
23274 \begin_inset Flex Code
23277 \begin_layout Plain Layout
23286 \begin_layout Subsection
23288 \begin_inset CommandInset label
23290 name "subsec:Font-description"
23297 \begin_layout Standard
23298 A font description looks like this:
23301 \begin_layout LyX-Code
23318 \begin_layout LyX-Code
23322 \begin_layout LyX-Code
23326 \begin_layout Standard
23327 The following commands are available:
23330 \begin_layout Description
23331 \begin_inset Flex Code
23334 \begin_layout Plain Layout
23341 \change_deleted -712698321 1607682984
23343 \begin_inset Flex Code
23346 \begin_layout Plain Layout
23355 \begin_inset Flex Code
23358 \begin_layout Plain Layout
23365 \begin_inset Flex Code
23368 \begin_layout Plain Layout
23375 \begin_inset Flex Code
23378 \begin_layout Plain Layout
23385 \begin_inset Flex Code
23388 \begin_layout Plain Layout
23395 \begin_inset Flex Code
23398 \begin_layout Plain Layout
23405 \begin_inset Flex Code
23408 \begin_layout Plain Layout
23415 \begin_inset Flex Code
23418 \begin_layout Plain Layout
23425 \begin_inset Flex Code
23428 \begin_layout Plain Layout
23435 \begin_inset Flex Code
23438 \begin_layout Plain Layout
23445 \begin_inset Flex Code
23448 \begin_layout Plain Layout
23455 \begin_inset Flex Code
23458 \begin_layout Plain Layout
23465 \begin_inset Flex Code
23468 \begin_layout Plain Layout
23475 \begin_inset Flex Code
23478 \begin_layout Plain Layout
23485 \begin_inset Flex Code
23488 \begin_layout Plain Layout
23495 \begin_inset Flex Code
23498 \begin_layout Plain Layout
23505 \begin_inset Flex Code
23508 \begin_layout Plain Layout
23515 \begin_inset Flex Code
23518 \begin_layout Plain Layout
23525 \begin_inset Flex Code
23528 \begin_layout Plain Layout
23535 \begin_inset Flex Code
23538 \begin_layout Plain Layout
23545 \change_inserted -712698321 1607683139
23547 \begin_inset Flex Code
23550 \begin_layout Plain Layout
23552 \change_inserted -712698321 1607683135
23561 \begin_inset space ~
23565 \begin_inset CommandInset ref
23567 reference "chap:Names-of-colors"
23575 \change_deleted -712698321 1607683144
23577 \change_inserted -712698321 1607683146
23583 \begin_layout Description
23584 \begin_inset Flex Code
23587 \begin_layout Plain Layout
23594 \begin_inset Flex Code
23597 \begin_layout Plain Layout
23606 \begin_inset Flex Code
23609 \begin_layout Plain Layout
23616 \begin_inset Flex Code
23619 \begin_layout Plain Layout
23628 \begin_layout Description
23629 \begin_inset Flex Code
23632 \begin_layout Plain Layout
23639 \begin_inset Flex Code
23642 \begin_layout Plain Layout
23648 ] Valid arguments are:
23649 \begin_inset Flex Code
23652 \begin_layout Plain Layout
23659 \begin_inset Flex Code
23662 \begin_layout Plain Layout
23669 \begin_inset Flex Code
23672 \begin_layout Plain Layout
23679 \begin_inset Flex Code
23682 \begin_layout Plain Layout
23689 \begin_inset Flex Code
23692 \begin_layout Plain Layout
23699 \begin_inset Flex Code
23702 \begin_layout Plain Layout
23709 \begin_inset Flex Code
23712 \begin_layout Plain Layout
23719 \begin_inset Flex Code
23722 \begin_layout Plain Layout
23729 \begin_inset Flex Code
23732 \begin_layout Plain Layout
23739 \begin_inset Flex Code
23742 \begin_layout Plain Layout
23749 \begin_inset Flex Code
23752 \begin_layout Plain Layout
23759 \begin_inset Flex Code
23762 \begin_layout Plain Layout
23769 Each of these turns on or off the corresponding attribute.
23771 \begin_inset Flex Code
23774 \begin_layout Plain Layout
23780 turns on emphasis, and
23781 \begin_inset Flex Code
23784 \begin_layout Plain Layout
23792 \begin_inset Newline newline
23795 If the latter seems puzzling, remember that the font settings for the present
23796 context are generally inherited from the surrounding context.
23798 \begin_inset Flex Code
23801 \begin_layout Plain Layout
23807 would turn off the emphasis that was anyway in effect, say, in a theorem
23811 \begin_layout Description
23812 \begin_inset Flex Code
23815 \begin_layout Plain Layout
23822 \begin_inset Flex Code
23825 \begin_layout Plain Layout
23834 \begin_inset Flex Code
23837 \begin_layout Plain Layout
23846 \begin_layout Description
23847 \begin_inset Flex Code
23850 \begin_layout Plain Layout
23857 \begin_inset Flex Code
23860 \begin_layout Plain Layout
23869 \begin_inset Flex Code
23872 \begin_layout Plain Layout
23879 \begin_inset Flex Code
23882 \begin_layout Plain Layout
23889 \begin_inset Flex Code
23892 \begin_layout Plain Layout
23901 \begin_layout Description
23902 \begin_inset Flex Code
23905 \begin_layout Plain Layout
23912 \begin_inset Flex Code
23915 \begin_layout Plain Layout
23922 \begin_inset Flex Code
23925 \begin_layout Plain Layout
23932 \begin_inset Flex Code
23935 \begin_layout Plain Layout
23944 \begin_inset Flex Code
23947 \begin_layout Plain Layout
23954 \begin_inset Flex Code
23957 \begin_layout Plain Layout
23964 \begin_inset Flex Code
23967 \begin_layout Plain Layout
23974 \begin_inset Flex Code
23977 \begin_layout Plain Layout
23984 \begin_inset Flex Code
23987 \begin_layout Plain Layout
23996 \begin_layout Subsection
23997 \begin_inset CommandInset label
23999 name "subsec:Citation-engine-description"
24003 Cite engine description
24006 \begin_layout Standard
24008 \begin_inset Flex Code
24011 \begin_layout Plain Layout
24017 blocks, as used mainly in cite engine files (see
24018 \begin_inset CommandInset ref
24020 reference "subsec:Cite-Engine-Files"
24027 ), define the citation commands provided by a specific
24028 \begin_inset Quotes eld
24032 \begin_inset Quotes erd
24036 A cite engine, in \SpecialChar LyX
24037 terms, is way specific way to format citations, using
24038 numbers, author names and/or years.
24039 Currently, \SpecialChar LyX
24040 supports three such engine types, namely:
24043 \begin_layout Enumerate
24044 \begin_inset Flex Code
24047 \begin_layout Plain Layout
24053 : the default Bib\SpecialChar TeX
24054 way to format citations, a simple numeric style (e.
24055 \begin_inset space \thinspace{}
24059 \begin_inset Quotes eld
24063 \begin_inset Quotes erd
24069 \begin_layout Enumerate
24070 \begin_inset Flex Code
24073 \begin_layout Plain Layout
24079 : Harvard-styled citations using author names and publication year (e.
24080 \begin_inset space \thinspace{}
24084 \begin_inset Quotes eld
24087 Smith and Miller (2017b)
24088 \begin_inset Quotes erd
24094 \begin_layout Enumerate
24095 \begin_inset Flex Code
24098 \begin_layout Plain Layout
24104 : extended numerical citations that also allow for author or title next
24106 \begin_inset space \thinspace{}
24110 \begin_inset Quotes eld
24113 Smith and Miller [1]
24114 \begin_inset Quotes erd
24120 \begin_layout Standard
24121 \begin_inset Flex Code
24124 \begin_layout Plain Layout
24130 blocks look like this:
24133 \begin_layout LyX-Code
24137 \begin_layout LyX-Code
24141 \begin_layout LyX-Code
24145 \begin_layout LyX-Code
24146 citeyearpar[][]=parencite*
24149 \begin_layout LyX-Code
24153 \begin_layout LyX-Code
24157 \begin_layout Standard
24159 \begin_inset Flex Code
24162 \begin_layout Plain Layout
24168 denotes the engine.
24169 The individual lines respectively define a cite command or cite command
24170 paradigm supported by this engine.
24171 The line can be as simple as a cite command that is used both to name the
24172 respective \SpecialChar LyX
24173 command and the \SpecialChar LaTeX
24174 output or more complex in order to differentiate
24176 The full syntax is:
24179 \begin_layout LyX-Code
24180 LyXName|alias$*<!_stardesc!_stardesctooltip>[][]=latexcmd
24183 \begin_layout Itemize
24184 \begin_inset Flex Code
24187 \begin_layout Plain Layout
24193 : The name as used in the
24194 \begin_inset Flex Code
24197 \begin_layout Plain Layout
24207 \begin_layout Standard
24208 For portability reasons, we try to use the same name for same-formatted
24209 commands in different cite packages (thus many names stem from natbib,
24210 and thus we need to differentiate a
24211 \begin_inset Flex Code
24214 \begin_layout Plain Layout
24220 sometimes, if the \SpecialChar LaTeX
24221 command names differ).
24225 \begin_layout Itemize
24226 \begin_inset Flex Code
24229 \begin_layout Plain Layout
24235 : a (comma-separated) list of commands that fall back to the given
24236 \begin_inset Flex Code
24239 \begin_layout Plain Layout
24245 in the current engine.
24246 This eases the switch of citation packages and engines.
24248 \begin_inset Flex Code
24251 \begin_layout Plain Layout
24258 \begin_inset Flex Code
24261 \begin_layout Plain Layout
24267 in layout definitions.
24270 \begin_layout Itemize
24271 \begin_inset Flex Code
24274 \begin_layout Plain Layout
24280 : The actual \SpecialChar LaTeX
24281 command that is output.
24285 \begin_layout Standard
24286 \begin_inset Flex Code
24289 \begin_layout Plain Layout
24296 \begin_inset Flex Code
24299 \begin_layout Plain Layout
24307 \begin_inset Flex Code
24310 \begin_layout Plain Layout
24317 \begin_inset Flex Code
24320 \begin_layout Plain Layout
24326 will be output to \SpecialChar LaTeX
24330 \begin_layout Standard
24334 \begin_layout Itemize
24335 Capitalization indicates that the command also has a capitalized form (
24336 \begin_inset Flex Code
24339 \begin_layout Plain Layout
24349 \begin_inset Flex Code
24352 \begin_layout Plain Layout
24361 These usually enforce up-casing of name prefixes (
24366 \begin_inset Formula $\Rightarrow$
24376 \begin_layout Itemize
24378 \begin_inset Flex Code
24381 \begin_layout Plain Layout
24387 indicate the number of optional arguments (there can be 0–2).
24390 \begin_layout Itemize
24392 \begin_inset Flex Code
24395 \begin_layout Plain Layout
24401 indicates there is a starred version of the command (
24402 \begin_inset Flex Code
24405 \begin_layout Plain Layout
24415 \begin_inset Flex Code
24418 \begin_layout Plain Layout
24431 \begin_layout Standard
24432 By default, the starred version means: Output all authors even if it should
24434 \begin_inset Quotes eld
24438 \begin_inset Quotes erd
24442 \begin_inset Flex Code
24445 \begin_layout Plain Layout
24454 \begin_layout Standard
24455 If the star has a different meaning for a given command, it can be specified
24457 \begin_inset Flex Code
24460 \begin_layout Plain Layout
24461 <!_stardesc!_stardesctooltip>
24467 Maximal two translatable macro keywords, marked by the prefix
24468 \begin_inset Flex Code
24471 \begin_layout Plain Layout
24478 The first points to the string that replaces the
24479 \begin_inset Quotes eld
24483 \begin_inset Quotes erd
24486 checkbox label in the citation dialog, the second one to an optional tool
24487 tip for this checkbox.
24491 \begin_layout Standard
24492 Note that these two macros have to be defined in a
24493 \begin_inset Flex Code
24496 \begin_layout Plain Layout
24502 (see next section), dropping the
24503 \begin_inset Flex Code
24506 \begin_layout Plain Layout
24512 from the prefix, like this:
24515 \begin_layout LyX-Code
24516 _stardesc Sta&rred command label
24519 \begin_layout LyX-Code
24520 _stardesctooltip Tooltip for the starred command checkbox.
24524 \begin_layout Itemize
24526 \begin_inset Flex Code
24529 \begin_layout Plain Layout
24535 indicates that this command features
24536 \begin_inset Quotes eld
24539 qualified citation lists
24540 \begin_inset Quotes erd
24548 -specific feature for multi-reference citations where an individual pre-
24549 and postnote can be given to each reference in the list.
24550 Please refer to the
24554 manual for details.
24555 \change_inserted -712698321 1526898670
24559 \begin_layout Standard
24561 \change_inserted -712698321 1526899524
24562 If you want to add a cite command to a cite engine (e.
24563 \begin_inset space \thinspace{}
24566 g., add a specific command provided by a class), you can use
24567 \begin_inset Flex Code
24570 \begin_layout Plain Layout
24572 \change_inserted -712698321 1526898768
24573 AddToCiteEngine <engine type> \SpecialChar ldots
24582 Note that only cite commands that do not exist yet are added.
24587 \begin_layout Subsection
24588 \begin_inset CommandInset label
24590 name "subsec:Citation-format-description"
24594 Cite format description
24597 \begin_layout Standard
24599 \begin_inset Flex Code
24602 \begin_layout Plain Layout
24608 blocks are used to describe how bibliographic information should be displayed,
24609 both within \SpecialChar LyX
24610 itself (in the citation dialog and in tooltips, for example)
24611 and in XHTML output.
24612 Such a block might look like this:
24615 \begin_layout LyX-Code
24619 \begin_layout LyX-Code
24623 \begin_layout LyX-Code
24627 \begin_layout LyX-Code
24631 \begin_layout Standard
24635 \begin_layout LyX-Code
24639 \begin_layout LyX-Code
24643 \begin_layout LyX-Code
24647 \begin_layout LyX-Code
24651 \begin_layout Standard
24652 In the first case, the individual lines define how the bibliographic information
24653 associated with an article or book, respectively, is to be displayed, and
24654 such a definition can be given for any
24655 \begin_inset Quotes els
24659 \begin_inset Quotes ers
24662 that might be present in a Bib\SpecialChar TeX
24665 defines a default format in the source code that will be used if no specific
24666 definition has been given.
24668 predefines several formats in the file
24669 \begin_inset Flex Code
24672 \begin_layout Plain Layout
24678 , which is included in most of \SpecialChar LyX
24679 's document classes.
24682 \begin_layout Standard
24683 In the second case, the lines define how a specific citation command (in
24685 \begin_inset Flex Code
24688 \begin_layout Plain Layout
24697 \begin_inset Flex Code
24700 \begin_layout Plain Layout
24708 ) is to be displayed on the citation inset label, in the citation dialog,
24709 menu or XHTML output.
24711 defines such formats for the citation style variants it supports via
24713 Document\SpecialChar menuseparator
24714 Setting\SpecialChar menuseparator
24715 Bibliography\SpecialChar ldots
24719 \begin_inset Flex Code
24722 \begin_layout Plain Layout
24728 files that are shipped with \SpecialChar LyX
24730 \begin_inset CommandInset ref
24732 reference "subsec:Cite-Engine-Files"
24742 \begin_layout Standard
24743 The definitions use a simple language that allows Bib\SpecialChar TeX
24744 keys to be replaced
24746 Keys should be enclosed in
24747 \begin_inset Flex Code
24750 \begin_layout Plain Layout
24757 \begin_inset Flex Code
24760 \begin_layout Plain Layout
24767 So a simple definition might look like this:
24770 \begin_layout LyX-Code
24772 \begin_inset Quotes eld
24776 \begin_inset Quotes erd
24782 \begin_layout Standard
24783 This would print the author, followed by a comma, followed by the title,
24784 in quotes, followed by a period.
24787 \begin_layout Standard
24788 Of course, sometimes you may want to print a key only if it exists.
24789 This can be done by using a conditional construction, such as:
24790 \begin_inset Flex Code
24793 \begin_layout Plain Layout
24795 \begin_inset space ~
24805 \begin_inset Flex Code
24808 \begin_layout Plain Layout
24814 key exists, then print
24815 \begin_inset Quotes eld
24819 \begin_inset space ~
24823 \begin_inset Quotes erd
24826 followed by the volume key.
24827 It is also possible to have an else clause in the conditional, such as:
24828 \begin_inset Newline newline
24832 \begin_inset Flex Code
24835 \begin_layout Plain Layout
24836 {%author%[[%author%]][[%editor%, ed.]]}
24842 \begin_inset Newline newline
24846 \begin_inset Flex Code
24849 \begin_layout Plain Layout
24855 key is printed if it exists; otherwise, the editor key is printed, followed
24857 \begin_inset Quotes eld
24861 \begin_inset space ~
24865 \begin_inset Quotes erd
24868 Note that the key is again enclosed in
24869 \begin_inset Flex Code
24872 \begin_layout Plain Layout
24878 signs; the entire conditional is enclosed in braces; and the if and else
24879 clauses are enclosed in double brackets,
24880 \begin_inset Quotes eld
24884 \begin_inset Flex Code
24887 \begin_layout Plain Layout
24894 \begin_inset Quotes eld
24898 \begin_inset Quotes eld
24902 \begin_inset Flex Code
24905 \begin_layout Plain Layout
24912 \begin_inset Quotes erd
24916 There must be no space between any of these.
24919 \begin_layout Standard
24920 Next to the entry keys, there are some special keys that can be used for
24921 these conditionals:
24924 \begin_layout Itemize
24925 \begin_inset Flex Code
24928 \begin_layout Plain Layout
24929 {%dialog%[[true]][[false]]}
24935 \begin_inset Quotes eld
24939 \begin_inset Quotes erd
24942 part for dialogs and menus, the
24943 \begin_inset Quotes eld
24947 \begin_inset Quotes erd
24950 part for other contexts (workarea, export)
24953 \begin_layout Itemize
24954 \begin_inset Flex Code
24957 \begin_layout Plain Layout
24958 {%export%[[true]][[false]]}
24964 \begin_inset Quotes eld
24968 \begin_inset Quotes erd
24971 part for export and menus, the
24972 \begin_inset Quotes eld
24976 \begin_inset Quotes erd
24979 part for other contexts (workarea, dialog)
24982 \begin_layout Itemize
24983 \begin_inset Flex Code
24986 \begin_layout Plain Layout
24993 \begin_inset Quotes eld
24997 \begin_inset Quotes erd
25000 part if another item follows (e.
25001 \begin_inset space \thinspace{}
25004 g., in a citation with multiple keys)
25007 \begin_layout Itemize
25008 \begin_inset Flex Code
25011 \begin_layout Plain Layout
25012 {%second%[[true]][[false]]}
25018 \begin_inset Quotes eld
25022 \begin_inset Quotes erd
25025 if this is the second of multiple items, else the
25026 \begin_inset Quotes eld
25030 \begin_inset Quotes erd
25036 \begin_layout Itemize
25037 \begin_inset Flex Code
25040 \begin_layout Plain Layout
25041 {%ifstar%[[true]][[false]]}
25047 \begin_inset Quotes eld
25051 \begin_inset Quotes erd
25054 part for starred citation commands (such as
25055 \begin_inset Flex Code
25058 \begin_layout Plain Layout
25066 ), the false part for unstarred
25069 \begin_layout Itemize
25070 \begin_inset Flex Code
25073 \begin_layout Plain Layout
25074 {%ifentrytype:<type>%[[true]][[false]]}
25080 \begin_inset Quotes eld
25084 \begin_inset Quotes erd
25087 if the current entry type matches
25088 \begin_inset Flex Code
25091 \begin_layout Plain Layout
25097 , else the false part (e.g., in a citation definition:
25098 \begin_inset Flex Code
25101 \begin_layout Plain Layout
25102 {%ifentrytype:book%[[this is a book]][[this is no book]]}
25110 \begin_layout Itemize
25111 \begin_inset Flex Code
25114 \begin_layout Plain Layout
25115 {%ifmultiple:<authortype>%[[true]][[false]]}
25121 \begin_inset Quotes eld
25125 \begin_inset Quotes erd
25128 if the current author type (author, editor etc.) has multiple authors, else
25129 the false part (e.g., in a bibliography definition:
25130 \begin_inset Flex Code
25133 \begin_layout Plain Layout
25134 {%ifmultiple:editor%[[eds.]][[ed.]]}
25142 \begin_layout Itemize
25143 \begin_inset Flex Code
25146 \begin_layout Plain Layout
25147 {%ifqualified%[[true]][[false]]}
25153 \begin_inset Quotes eld
25157 \begin_inset Quotes erd
25160 part if the current citation is a qualified citation list (a specific
25164 format for multi-reference citations), the false part if this is not the
25168 \begin_layout Standard
25170 \begin_inset Flex Code
25173 \begin_layout Plain Layout
25179 prints the author key as it is recorded in the bibliography file.
25180 This might not be what you want, since it will result in a string such
25182 \begin_inset Quotes eld
25185 Miller, Peter and Smith, Mary and White, Jane
25186 \begin_inset Quotes erd
25190 \begin_inset Quotes eld
25194 \begin_inset Quotes erd
25197 is used by Bib\SpecialChar TeX
25198 to delimit authors).
25200 therefore provides some methods to get properly formatted name lists (which
25201 will also get translated).
25202 The following keys are provided:
25205 \begin_layout Enumerate
25206 For name lists with pre- and surname, suitable for the main authors/editors
25207 of a bibliography item.
25209 \begin_inset Flex Code
25212 \begin_layout Plain Layout
25218 part denotes the kind of list that is requested (e.g.
25220 \begin_inset Flex Code
25223 \begin_layout Plain Layout
25233 \begin_layout Itemize
25234 \begin_inset Flex Code
25237 \begin_layout Plain Layout
25238 %abbrvnames:<nametype>%
25243 : Provides a name list which is abbreviated (with
25244 \begin_inset Quotes eld
25248 \begin_inset Quotes erd
25252 \begin_inset Flex Code
25255 \begin_layout Plain Layout
25264 \begin_layout Itemize
25265 \begin_inset Flex Code
25268 \begin_layout Plain Layout
25269 %fullnames:<nametype>%
25274 : Provides a full name list (never abbreviated with
25275 \begin_inset Quotes eld
25279 \begin_inset Quotes erd
25285 \begin_layout Itemize
25286 \begin_inset Flex Code
25289 \begin_layout Plain Layout
25290 %forceabbrvnames:<nametype>%
25295 : Provides a name list which is always abbreviated (with
25296 \begin_inset Quotes eld
25300 \begin_inset Quotes erd
25304 \begin_inset Flex Code
25307 \begin_layout Plain Layout
25317 \begin_layout Enumerate
25318 Alternative name lists with pre- and surname, if the order of pre- and surname
25319 inside the bibliography item differs (as in:
25320 \begin_inset Quotes eld
25323 Miller, John: Some text, in: Mary Smith, ed.: A volume
25324 \begin_inset Quotes erd
25331 \begin_layout Itemize
25332 \begin_inset Flex Code
25335 \begin_layout Plain Layout
25336 %abbrvbynames:<nametype>%
25341 : Provides a name list which is abbreviated (with
25342 \begin_inset Quotes eld
25346 \begin_inset Quotes erd
25350 \begin_inset Flex Code
25353 \begin_layout Plain Layout
25362 \begin_layout Itemize
25363 \begin_inset Flex Code
25366 \begin_layout Plain Layout
25367 %fullbynames:<nametype>%
25372 : Provides a full name list (never abbreviated with
25373 \begin_inset Quotes eld
25377 \begin_inset Quotes erd
25383 \begin_layout Itemize
25384 \begin_inset Flex Code
25387 \begin_layout Plain Layout
25388 %forceabbrvbynames:<nametype>%
25393 : Provides a name list which is always abbreviated (with
25394 \begin_inset Quotes eld
25398 \begin_inset Quotes erd
25402 \begin_inset Flex Code
25405 \begin_layout Plain Layout
25415 \begin_layout Enumerate
25416 And finally name lists which consist of family names only, as used in author-yea
25418 These do not take a
25419 \begin_inset Flex Code
25422 \begin_layout Plain Layout
25428 part, but always return either an author list or, if this does not exist,
25429 an editor list (as common in author-year labels):
25433 \begin_layout Itemize
25434 \begin_inset Flex Code
25437 \begin_layout Plain Layout
25443 : Provides a name list which is abbreviated (with
25444 \begin_inset Quotes eld
25448 \begin_inset Quotes erd
25452 \begin_inset Flex Code
25455 \begin_layout Plain Layout
25464 \begin_layout Itemize
25465 \begin_inset Flex Code
25468 \begin_layout Plain Layout
25474 : Provides a full name list (never abbreviated with
25475 \begin_inset Quotes eld
25479 \begin_inset Quotes erd
25485 \begin_layout Itemize
25486 \begin_inset Flex Code
25489 \begin_layout Plain Layout
25490 %forceabbrvciteauthor%
25495 : Provides a name list which is always abbreviated (with
25496 \begin_inset Quotes eld
25500 \begin_inset Quotes erd
25504 \begin_inset Flex Code
25507 \begin_layout Plain Layout
25517 \begin_layout Standard
25518 The order of pre- and surname in the former two lists can be adjusted by
25522 \begin_layout Itemize
25523 \begin_inset Flex Code
25526 \begin_layout Plain Layout
25527 !firstnameform %surname%, %prename%
25532 (first author in lists of type 1)
25535 \begin_layout Itemize
25536 \begin_inset Flex Code
25539 \begin_layout Plain Layout
25540 !othernameform %surname%, %prename%
25545 (other authors in lists of type 1)
25548 \begin_layout Itemize
25549 \begin_inset Flex Code
25552 \begin_layout Plain Layout
25553 !firstbynameform %prename% %surname%
25558 (first author in lists of type 2)
25561 \begin_layout Itemize
25562 \begin_inset Flex Code
25565 \begin_layout Plain Layout
25566 !otherbynameform %prename% %surname%
25571 (other authors in lists of type 2)
25574 \begin_layout Standard
25575 This allows you to configure namings like
25576 \begin_inset Quotes eld
25579 Miller, Peter and Mary Smith: \SpecialChar ldots
25580 , in: John Doe and Pat Green, eds.:\SpecialChar ldots
25582 \begin_inset Quotes erd
25588 \begin_layout Standard
25589 There is one other piece of syntax available in definitions, which looks
25591 \begin_inset Flex Code
25594 \begin_layout Plain Layout
25601 This defines a piece of formatting information that is to be used when
25603 \begin_inset Quotes eld
25607 \begin_inset Quotes erd
25611 Obviously, we do not want to output HTML tags when writing plain text,
25612 so they should be wrapped in
25613 \begin_inset Quotes eld
25617 \begin_inset Quotes erd
25621 \begin_inset Quotes eld
25625 \begin_inset Quotes erd
25631 \begin_layout Standard
25632 Two special sorts of definitions are also possible in a
25633 \begin_inset Flex Code
25636 \begin_layout Plain Layout
25643 An example of the first would be:
25646 \begin_layout LyX-Code
25648 \begin_inset Quotes eld
25652 \begin_inset Quotes erd
25658 \begin_layout Standard
25659 This is an abbreviation, or macro, and it can be used by treating it as
25661 \begin_inset Flex Code
25664 \begin_layout Plain Layout
25673 \begin_inset Flex Code
25676 \begin_layout Plain Layout
25682 exactly as it would treat its definition.
25683 So, let us issue the obvious
25691 \begin_layout LyX-Code
25695 \begin_layout Standard
25696 or anything like it.
25698 shouldn't go into an infinite loop, but it may go into a long one before
25702 \begin_layout Standard
25703 The second sort of special definition might look like this:
25706 \begin_layout LyX-Code
25710 \begin_layout Standard
25711 This defines a translatable piece of text, which allows relevant parts of
25712 the bibliography or citation to be translated.
25713 It can be included in a definition by treating it as a key:
25714 \begin_inset Flex Code
25717 \begin_layout Plain Layout
25724 Note that there are two different translation paths: All definitions starting
25726 \begin_inset Flex Code
25729 \begin_layout Plain Layout
25735 , such as in the example above, will be translated to the currently active
25736 buffer language (so the translation will match the generated document).
25737 All definitions starting with underscore only will be translated to the
25739 This is the proper translation for strings that only occur in the dialogs
25740 or on buttons, such as this one:
25743 \begin_layout LyX-Code
25744 _addtobib Add to bibliography only.
25747 \begin_layout Standard
25748 Several of these translatable strings are predefined in
25749 \begin_inset Flex Code
25752 \begin_layout Plain Layout
25759 \begin_inset Flex Code
25762 \begin_layout Plain Layout
25769 Note that these are not macros, in the sense just defined.
25770 They will not be expanded.
25773 \begin_layout Standard
25774 So here then is an example that uses several of these features:
25775 \begin_inset VSpace defskip
25781 \begin_layout Standard
25785 !authoredit {%author%[[%author%, ]][[{%editor%[[%editor%, %B_edtext%, ]]}]]}
25788 \begin_layout Standard
25789 \begin_inset VSpace defskip
25792 This defines a macro that prints the author, followed by a comma, if the
25794 \begin_inset Flex Code
25797 \begin_layout Plain Layout
25803 key is defined, or else prints the name of the editor, followed by the
25805 \begin_inset Flex Code
25808 \begin_layout Plain Layout
25814 or its translation (it is by default
25815 \begin_inset Quotes eld
25819 \begin_inset Quotes erd
25823 \begin_inset Flex Code
25826 \begin_layout Plain Layout
25833 Note that this is in fact defined in
25834 \begin_inset Flex Code
25837 \begin_layout Plain Layout
25843 , so you can use it in your own definitions, or re-definitions, if you load
25847 \begin_layout Section
25848 \begin_inset CommandInset label
25850 name "sec:Tags-for-XHTML"
25854 Tags for XHTML output
25857 \begin_layout Standard
25858 As with \SpecialChar LaTeX
25859 or DocBook, the format of \SpecialChar LyX
25860 's XHTML output is also controlled by
25861 layout information.
25862 In general, \SpecialChar LyX
25863 provides sensible defaults and, as mentioned earlier, it will
25864 even construct default CSS style rules from the other layout tags.
25865 For example, \SpecialChar LyX
25866 will attempt to use the information provided in the
25867 \begin_inset Flex Code
25870 \begin_layout Plain Layout
25876 declaration for the Chapter style to write CSS that will appropriately
25877 format chapter headings.
25880 \begin_layout Standard
25881 In many cases, then, you may not have to do anything at all to get acceptable
25882 XHTML output for your own environments, custom insets, and so forth.
25883 But in some cases you will, and so \SpecialChar LyX
25884 provides a number of layout tags that
25885 can be used to customize the XHTML and CSS that are generated.
25888 \begin_layout Standard
25889 Note that there are two tags,
25890 \begin_inset Flex Code
25893 \begin_layout Plain Layout
25900 \begin_inset Flex Code
25903 \begin_layout Plain Layout
25909 that may appear outside style and inset declarations.
25911 \begin_inset CommandInset ref
25913 reference "subsec:General-text-class"
25917 for details on these.
25920 \begin_layout Subsection
25921 \begin_inset CommandInset label
25923 name "subsec:Paragraph-Style-XHTML"
25930 \begin_layout Standard
25931 The sort of XHTML \SpecialChar LyX
25932 outputs for a paragraph depends upon whether we are dealing
25933 with a normal paragraph, a command, or an environment, where this is itself
25934 determined by the contents of the corresponding
25935 \begin_inset Flex Code
25938 \begin_layout Plain Layout
25949 \begin_layout Standard
25950 For a command or normal paragraph, the output XHTML has the following form:
25953 \begin_layout LyX-Code
25957 \begin_inset Quotes erd
25961 \begin_inset Quotes erd
25967 \begin_layout LyX-Code
25971 \begin_inset Quotes erd
25975 \begin_inset Quotes erd
25981 \begin_layout LyX-Code
25984 Contents of the paragraph.
25987 \begin_layout LyX-Code
25993 \begin_layout Standard
25994 The label tags are of course omitted if the paragraph does not have a label.
25997 \begin_layout Standard
25998 For an environment that is not some sort of list, the XHTML takes this form:
26001 \begin_layout LyX-Code
26005 \begin_inset Quotes erd
26009 \begin_inset Quotes erd
26015 \begin_layout LyX-Code
26019 \begin_inset Quotes erd
26023 \begin_inset Quotes erd
26027 \begin_inset Quotes erd
26031 \begin_inset Quotes erd
26034 >Environment Label</labeltag>First paragraph.</itemtag>
26037 \begin_layout LyX-Code
26040 <itemtag>Second paragraph.</itemtag>
26043 \begin_layout LyX-Code
26049 \begin_layout Standard
26050 Note that the label is output only for the first paragraph, as it should
26051 be for a theorem, for example.
26055 \begin_layout Standard
26056 For a list, we have one of these forms:
26059 \begin_layout LyX-Code
26063 \begin_inset Quotes erd
26067 \begin_inset Quotes erd
26073 \begin_layout LyX-Code
26077 \begin_inset Quotes erd
26081 \begin_inset Quotes erd
26085 \begin_inset Quotes erd
26089 \begin_inset Quotes erd
26092 >List Label</labeltag>First item.</itemtag>
26095 \begin_layout LyX-Code
26099 \begin_inset Quotes erd
26103 \begin_inset Quotes erd
26107 \begin_inset Quotes erd
26111 \begin_inset Quotes erd
26114 >List Label</labeltag>Second item.</itemtag>
26117 \begin_layout LyX-Code
26123 \begin_layout LyX-Code
26127 \begin_layout LyX-Code
26131 \begin_inset Quotes erd
26135 \begin_inset Quotes erd
26141 \begin_layout LyX-Code
26145 \begin_inset Quotes erd
26149 \begin_inset Quotes erd
26152 >List Label</labeltag><itemtag attr=
26153 \begin_inset Quotes erd
26157 \begin_inset Quotes erd
26160 >First item.</itemtag>
26163 \begin_layout LyX-Code
26167 \begin_inset Quotes erd
26171 \begin_inset Quotes erd
26174 >List Label</labeltag><itemtag attr=
26175 \begin_inset Quotes erd
26179 \begin_inset Quotes erd
26182 >Second item.</itemtag>
26185 \begin_layout LyX-Code
26191 \begin_layout Standard
26192 Note the different orders of
26193 \begin_inset Flex Code
26196 \begin_layout Plain Layout
26203 \begin_inset Flex Code
26206 \begin_layout Plain Layout
26213 Which order we get depends upon the setting of
26214 \begin_inset Flex Code
26217 \begin_layout Plain Layout
26224 \begin_inset Flex Code
26227 \begin_layout Plain Layout
26233 is false (the default), you get the first of these, with the label within
26234 the item; if true, you get the second, with the label outside the item.
26237 \begin_layout Standard
26238 The specific tags and attributes output for each paragraph type can be controlle
26239 d by means of the layout tags we are about to describe.
26240 As mentioned earlier, however, \SpecialChar LyX
26241 uses sensible defaults for many of these,
26242 so you often may not need to do very much to get good XHTML output.
26243 Think of the available tags as there so you can tweak things to your liking.
26246 \begin_layout Description
26247 \begin_inset Flex Code
26250 \begin_layout Plain Layout
26257 \begin_inset Flex Code
26260 \begin_layout Plain Layout
26266 ] Specifies attribute information to be output with the main tag.
26268 \begin_inset Quotes eld
26272 \begin_inset Flex Code
26275 \begin_layout Plain Layout
26282 \begin_inset Quotes erd
26286 By default, \SpecialChar LyX
26288 \begin_inset Quotes eld
26292 \begin_inset Flex Code
26295 \begin_layout Plain Layout
26302 \begin_inset Quotes erd
26306 \begin_inset Flex Code
26309 \begin_layout Plain Layout
26315 is the \SpecialChar LyX
26316 name of the layout, made lowercase, for example: chapter.
26321 contain any style information.
26323 \begin_inset Flex Code
26326 \begin_layout Plain Layout
26335 \begin_layout Description
26336 \begin_inset Flex Code
26339 \begin_layout Plain Layout
26346 \begin_inset Flex Code
26349 \begin_layout Plain Layout
26359 ] Whether to output the default CSS information \SpecialChar LyX
26360 generates for this layout,
26361 even if additional information is explicitly provided via
26362 \begin_inset Flex Code
26365 \begin_layout Plain Layout
26373 \begin_inset Flex Code
26376 \begin_layout Plain Layout
26382 allows you to alter or augment the generated CSS, rather than to override
26385 \begin_inset Flex Code
26388 \begin_layout Plain Layout
26397 \begin_layout Description
26398 \begin_inset Flex Code
26401 \begin_layout Plain Layout
26408 \begin_inset Flex Code
26411 \begin_layout Plain Layout
26417 ] The tag to be used for individual paragraphs of environments, replacing
26419 \begin_inset Flex Code
26422 \begin_layout Plain Layout
26428 in the examples above.
26430 \begin_inset Flex Code
26433 \begin_layout Plain Layout
26442 \begin_layout Description
26443 \begin_inset Flex Code
26446 \begin_layout Plain Layout
26453 \begin_inset Flex Code
26456 \begin_layout Plain Layout
26462 ] Attributes for the item tag.
26464 \begin_inset Newline newline
26468 \begin_inset Quotes eld
26472 \begin_inset Flex Code
26475 \begin_layout Plain Layout
26476 class=`layoutname_item'
26482 \begin_inset Quotes erd
26490 contain any style information.
26492 \begin_inset Flex Code
26495 \begin_layout Plain Layout
26504 \begin_layout Description
26505 \begin_inset Flex Code
26508 \begin_layout Plain Layout
26515 \begin_inset Flex Code
26518 \begin_layout Plain Layout
26524 ] The tag to be used for paragraph and item labels, replacing
26525 \begin_inset Flex Code
26528 \begin_layout Plain Layout
26534 in the examples above.
26536 \begin_inset Flex Code
26539 \begin_layout Plain Layout
26546 \begin_inset Flex Code
26549 \begin_layout Plain Layout
26556 \begin_inset Flex Code
26559 \begin_layout Plain Layout
26566 \begin_inset Flex Code
26569 \begin_layout Plain Layout
26570 Centered_Top_Environment
26575 , in which case it defaults to
26576 \begin_inset Flex Code
26579 \begin_layout Plain Layout
26588 \begin_layout Description
26589 \begin_inset Flex Code
26592 \begin_layout Plain Layout
26599 \begin_inset Flex Code
26602 \begin_layout Plain Layout
26608 ] Attributes for the label tag.
26610 \begin_inset Newline newline
26614 \begin_inset Quotes eld
26618 \begin_inset Flex Code
26621 \begin_layout Plain Layout
26622 class=`layoutname_label'
26628 \begin_inset Quotes erd
26636 contain any style information.
26638 \begin_inset Flex Code
26641 \begin_layout Plain Layout
26650 \begin_layout Description
26651 \begin_inset Flex Code
26654 \begin_layout Plain Layout
26661 \begin_inset Flex Code
26664 \begin_layout Plain Layout
26674 ] Meaningful only for list-like environments, this tag controls whether
26675 the label tag is output before or inside the item tag.
26676 This is used, for example, in the description environment, where we want
26678 \begin_inset Flex Code
26681 \begin_layout Plain Layout
26682 <dt>\SpecialChar ldots
26683 </dt><dd>\SpecialChar ldots
26691 \begin_inset Flex Code
26694 \begin_layout Plain Layout
26700 : The label tag is output inside the item tag.
26703 \begin_layout Description
26704 \begin_inset Flex Code
26707 \begin_layout Plain Layout
26713 Information to be output in the
26714 \begin_inset Flex Code
26717 \begin_layout Plain Layout
26723 section when this style is used.
26724 This might, for example, be used to include a
26725 \begin_inset Flex Code
26728 \begin_layout Plain Layout
26735 \begin_inset Flex Code
26738 \begin_layout Plain Layout
26747 \begin_layout Description
26748 \begin_inset Flex Code
26751 \begin_layout Plain Layout
26757 CSS style information to be included when this style is used.
26758 Note that this will automatically be wrapped in a layout-generated
26759 \begin_inset Flex Code
26762 \begin_layout Plain Layout
26768 block, so only the CSS itself need be included.
26770 \begin_inset Flex Code
26773 \begin_layout Plain Layout
26782 \begin_layout Description
26783 \begin_inset Flex Code
26786 \begin_layout Plain Layout
26793 \begin_inset Flex Code
26796 \begin_layout Plain Layout
26802 ] The tag to be used for the main label, replacing
26803 \begin_inset Flex Code
26806 \begin_layout Plain Layout
26812 in the examples above.
26814 \begin_inset Flex Code
26817 \begin_layout Plain Layout
26826 \begin_layout Description
26827 \begin_inset Flex Code
26830 \begin_layout Plain Layout
26837 \begin_inset Flex Code
26840 \begin_layout Plain Layout
26850 ] Marks this style as the one to be used to generate the
26851 \begin_inset Flex Code
26854 \begin_layout Plain Layout
26860 tag for the XHTML file.
26861 By default, it is false.
26863 \begin_inset Flex Code
26866 \begin_layout Plain Layout
26872 file sets it to true for the
26873 \begin_inset Flex Code
26876 \begin_layout Plain Layout
26886 \begin_layout Subsection
26890 \begin_layout Standard
26891 The XHTML output of insets can also be controlled by information in layout
26896 \begin_layout Plain Layout
26897 At present, this is true only for
26898 \begin_inset Quotes eld
26902 \begin_inset Quotes erd
26905 insets (insets you can type into) and is not true for
26906 \begin_inset Quotes eld
26910 \begin_inset Quotes erd
26913 insets (insets that are associated with dialog boxes).
26918 Here, too, \SpecialChar LyX
26919 tries to provide sensible defaults, and it constructs default
26921 But everything can be customized.
26924 \begin_layout Standard
26925 The XHTML \SpecialChar LyX
26926 outputs for an inset has the following form:
26929 \begin_layout LyX-Code
26931 \begin_inset Quotes erd
26935 \begin_inset Quotes erd
26941 \begin_layout LyX-Code
26942 <labeltag>Label</labeltag>
26945 \begin_layout LyX-Code
26947 \begin_inset Quotes erd
26951 \begin_inset Quotes erd
26954 >Contents of the inset.</innertag>
26957 \begin_layout LyX-Code
26961 \begin_layout Standard
26962 If the inset permits multiple paragraphs—that is, if
26963 \begin_inset Flex Code
26966 \begin_layout Plain Layout
26972 is true—then the contents of the inset will itself be output as paragraphs
26973 formatted according to the styles used for those paragraphs (standard,
26974 quote, and the like).
26975 The label tag is of course omitted if the paragraph does not have a label
26976 and, at present, is always
26977 \begin_inset Flex Code
26980 \begin_layout Plain Layout
26987 The inner tag is optional and, by default, does not appear.
26990 \begin_layout Standard
26991 The specific tags and attributes output for each inset can be controlled
26992 by means of the following layout tags.
26995 \begin_layout Description
26996 \begin_inset Flex Code
26999 \begin_layout Plain Layout
27006 \begin_inset Flex Code
27009 \begin_layout Plain Layout
27015 ] Specifies attribute information to be output with the main tag.
27017 \begin_inset Quotes eld
27021 \begin_inset Flex Code
27024 \begin_layout Plain Layout
27025 class=`myinset' onclick=`\SpecialChar ldots
27032 \begin_inset Quotes erd
27036 By default, \SpecialChar LyX
27038 \begin_inset Quotes eld
27042 \begin_inset Flex Code
27045 \begin_layout Plain Layout
27052 \begin_inset Quotes erd
27056 \begin_inset Flex Code
27059 \begin_layout Plain Layout
27065 is the \SpecialChar LyX
27066 name of the inset, made lowercase and with non-alphanumeric characters
27067 converted to underscores, for example: footnote.
27070 \begin_layout Description
27071 \begin_inset Flex Code
27074 \begin_layout Plain Layout
27081 \begin_inset Flex Code
27084 \begin_layout Plain Layout
27094 ] Whether to output the default CSS information \SpecialChar LyX
27095 generates for this layout,
27096 even if additional information is explicitly provided via
27097 \begin_inset Flex Code
27100 \begin_layout Plain Layout
27108 \begin_inset Flex Code
27111 \begin_layout Plain Layout
27117 allows you to alter or augment the generated CSS, rather than to override
27122 \begin_layout Description
27123 \begin_inset Flex Code
27126 \begin_layout Plain Layout
27133 \begin_inset Flex Code
27136 \begin_layout Plain Layout
27142 ] Attributes for the inner tag.
27144 \begin_inset Newline newline
27148 \begin_inset Quotes eld
27152 \begin_inset Flex Code
27155 \begin_layout Plain Layout
27156 class=`insetname_inner'
27162 \begin_inset Quotes erd
27168 \begin_layout Description
27169 \begin_inset Flex Code
27172 \begin_layout Plain Layout
27179 \begin_inset Flex Code
27182 \begin_layout Plain Layout
27188 ] The inner tag, replacing
27189 \begin_inset Flex Code
27192 \begin_layout Plain Layout
27198 in the examples above.
27199 By default, there is none.
27202 \begin_layout Description
27203 \begin_inset Flex Code
27206 \begin_layout Plain Layout
27213 \begin_inset Flex Code
27216 \begin_layout Plain Layout
27224 ] Whether this inset represents a standalone block of text (such as a footnote)
27225 or instead represents material that is included in the surrounding text
27226 (such as a branch).
27230 \begin_layout Description
27231 \begin_inset Flex Code
27234 \begin_layout Plain Layout
27241 \begin_inset Flex Code
27244 \begin_layout Plain Layout
27250 ] A label for this inset, possibly including a reference to a counter.
27251 For example, for footnote, it might be:
27252 \begin_inset Flex Code
27255 \begin_layout Plain Layout
27264 This is optional, and there is no default.
27267 \begin_layout Description
27268 \begin_inset Flex Code
27271 \begin_layout Plain Layout
27277 Information to be output in the
27278 \begin_inset Flex Code
27281 \begin_layout Plain Layout
27287 section when this style is used.
27288 This might, for example, be used to include a
27289 \begin_inset Flex Code
27292 \begin_layout Plain Layout
27299 \begin_inset Flex Code
27302 \begin_layout Plain Layout
27311 \begin_layout Description
27312 \begin_inset Flex Code
27315 \begin_layout Plain Layout
27321 CSS style information to be included when this style is used.
27322 Note that this will automatically be wrapped in a layout-generated
27323 \begin_inset Flex Code
27326 \begin_layout Plain Layout
27332 block, so only the CSS itself need be included.
27335 \begin_layout Description
27336 \begin_inset Flex Code
27339 \begin_layout Plain Layout
27346 \begin_inset Flex Code
27349 \begin_layout Plain Layout
27355 ] The tag to be used for the main label, replacing
27356 \begin_inset Flex Code
27359 \begin_layout Plain Layout
27365 in the examples above.
27366 The default depends upon the setting of
27367 \begin_inset Flex Code
27370 \begin_layout Plain Layout
27377 \begin_inset Flex Code
27380 \begin_layout Plain Layout
27386 is true, the default is
27387 \begin_inset Flex Code
27390 \begin_layout Plain Layout
27396 ; if it is false, the default is
27397 \begin_inset Flex Code
27400 \begin_layout Plain Layout
27409 \begin_layout Subsection
27413 \begin_layout Standard
27414 The XHTML output for floats too can be controlled by layout information.
27415 The output has the following form:
27418 \begin_layout LyX-Code
27420 \begin_inset Quotes erd
27424 \begin_inset Quotes erd
27430 \begin_layout LyX-Code
27431 Contents of the float.
27434 \begin_layout LyX-Code
27438 \begin_layout Standard
27439 The caption, if there is one, is a separate inset and will be output as
27441 Its appearance can be controlled via the InsetLayout for caption insets.
27445 \begin_layout Description
27446 \begin_inset Flex Code
27449 \begin_layout Plain Layout
27456 \begin_inset Flex Code
27459 \begin_layout Plain Layout
27465 ] Specifies attribute information to be output with the main tag.
27467 \begin_inset Quotes eld
27471 \begin_inset Flex Code
27474 \begin_layout Plain Layout
27475 class=`myfloat' onclick=`\SpecialChar ldots
27482 \begin_inset Quotes erd
27486 By default, \SpecialChar LyX
27488 \begin_inset Quotes eld
27492 \begin_inset Flex Code
27495 \begin_layout Plain Layout
27496 class=`float float-floattype'
27502 \begin_inset Quotes erd
27506 \begin_inset Flex Code
27509 \begin_layout Plain Layout
27515 is \SpecialChar LyX
27516 's name for this type of float, as determined by the float declaration
27518 \begin_inset CommandInset ref
27520 reference "subsec:Floats"
27524 ), though made lowercase and with non-alphanumeric characters converted
27525 to underscores, for example: float-table.
27528 \begin_layout Description
27529 \begin_inset Flex Code
27532 \begin_layout Plain Layout
27538 CSS style information to be included when this float is used.
27539 Note that this will automatically be wrapped in a layout-generated
27540 \begin_inset Flex Code
27543 \begin_layout Plain Layout
27549 block, so only the CSS itself need be included.
27552 \begin_layout Description
27553 \begin_inset Flex Code
27556 \begin_layout Plain Layout
27563 \begin_inset Flex Code
27566 \begin_layout Plain Layout
27572 ] The tag to be used for this float, replacing
27573 \begin_inset Quotes eld
27577 \begin_inset Flex Code
27580 \begin_layout Plain Layout
27587 \begin_inset Quotes erd
27590 in the example above.
27592 \begin_inset Flex Code
27595 \begin_layout Plain Layout
27601 and will rarely need changing.
27604 \begin_layout Subsection
27605 Bibliography formatting
27608 \begin_layout Standard
27609 The bibliography can be formatted using
27610 \begin_inset Flex Code
27613 \begin_layout Plain Layout
27621 \begin_inset CommandInset ref
27623 reference "subsec:Citation-format-description"
27630 \begin_layout Subsection
27635 \begin_layout Standard
27636 We have several times mentioned that \SpecialChar LyX
27637 will generate default CSS style rules
27638 for both insets and paragraph styles, based upon the other layout information
27640 In this section, we shall say a word about which layout information \SpecialChar LyX
27645 \begin_layout Standard
27646 At present, \SpecialChar LyX
27647 auto-generates CSS only for font information, making use of
27649 \begin_inset Flex Code
27652 \begin_layout Plain Layout
27659 \begin_inset Flex Code
27662 \begin_layout Plain Layout
27669 \begin_inset Flex Code
27672 \begin_layout Plain Layout
27679 \begin_inset Flex Code
27682 \begin_layout Plain Layout
27689 \begin_inset Flex Code
27692 \begin_layout Plain Layout
27699 \begin_inset CommandInset ref
27701 reference "subsec:Font-description"
27706 The translation is mostly straightforward and obvious.
27708 \begin_inset Quotes eld
27712 \begin_inset Flex Code
27715 \begin_layout Plain Layout
27722 \begin_inset Quotes erd
27726 \begin_inset Quotes eld
27730 \begin_inset Flex Code
27733 \begin_layout Plain Layout
27734 font-family: sans-serif;
27740 \begin_inset Quotes erd
27744 The correspondence of \SpecialChar LyX
27745 sizes and CSS sizes is a little less obvious but
27746 nonetheless intuitive.
27748 \begin_inset Flex Code
27751 \begin_layout Plain Layout
27758 \begin_inset Flex URL
27761 \begin_layout Plain Layout
27769 \change_inserted -970929547 1496610908
27773 \begin_layout Section
27775 \change_inserted -970929547 1496610966
27776 \begin_inset CommandInset label
27778 name "sec:Tags-for-DocBook"
27782 Tags for DocBook output
27785 \begin_layout Standard
27787 \change_inserted -970929547 1496611615
27788 As with \SpecialChar LaTeX
27789 or XHTML, the format of \SpecialChar LyX
27790 's DocBook output is also controlled by
27791 layout information.
27792 In general, \SpecialChar LyX
27793 provides sensible defaults; however, much of the styling is
27794 lost during the conversion, as DocBook is strictly semantic and does not
27796 When possible, information from \SpecialChar LyX
27797 will be rendered in
27805 \begin_layout Standard
27807 \change_inserted -970929547 1496612080
27808 In many cases, then, you may not have to do anything at all to get acceptable
27809 DocBook output for your own environments, custom insets, and so forth.
27810 But in some cases you will, and so \SpecialChar LyX
27811 provides a number of layout tags that
27812 can be used to customize the DocBook that is generated.
27815 \begin_layout Standard
27817 \change_inserted -970929547 1515109912
27818 Labels are rarely output, as they are redundant in DocBook: this information
27819 is carried by the tags themselves, and whether labels appear in the final
27820 documents (after processing of DocBook files) is controlled by the stylesheets.
27821 However, sometimes, labels are not redundant content, such as definition
27822 lists: in this case, the term being defined will be the label.
27826 \begin_layout Subsection
27828 \change_inserted 1075283030 1597699417
27829 \begin_inset CommandInset label
27831 name "subsec:Paragraph-Style-DocBook"
27836 \change_deleted 1075283030 1597699417
27838 \begin_inset CommandInset label
27840 name "subsec:Paragraph-Style-XHTML-1"
27845 \change_inserted -970929547 1496610966
27849 \begin_layout Standard
27851 \change_inserted -970929547 1496612059
27852 The sort of DocBook \SpecialChar LyX
27853 outputs for a paragraph depends upon whether we are
27854 dealing with a normal paragraph, a command, or an environment, where this
27855 is itself determined by the contents of the corresponding
27856 \begin_inset Flex Code
27859 \begin_layout Plain Layout
27861 \change_inserted -970929547 1496610966
27874 \begin_layout Standard
27876 \change_inserted -970929547 1496612107
27877 For a command or normal paragraph, the output DocBook has the following
27881 \begin_layout LyX-Code
27883 \change_inserted -970929547 1515109666
27887 \begin_layout LyX-Code
27889 \change_inserted -970929547 1496610966
27890 Contents of the paragraph.
27893 \begin_layout LyX-Code
27895 \change_inserted -970929547 1496610966
27899 \begin_layout Standard
27901 \change_inserted -970929547 1515109821
27902 For an environment that is not some sort of list, the generated DocBook
27906 \begin_layout LyX-Code
27908 \change_inserted -970929547 1515109671
27912 \begin_layout LyX-Code
27914 \change_inserted -970929547 1496612114
27915 <itemtag>First paragraph.</itemtag>
27918 \begin_layout LyX-Code
27920 \change_inserted -970929547 1496610966
27921 <itemtag>Second paragraph.</itemtag>
27924 \begin_layout LyX-Code
27926 \change_inserted -970929547 1496610966
27930 \begin_layout Standard
27932 \change_inserted -970929547 1515109825
27933 For a list, the resulting DocBook takes this form:
27936 \begin_layout LyX-Code
27938 \change_inserted -970929547 1515109672
27942 \begin_layout LyX-Code
27944 \change_inserted -970929547 1515109676
27945 <itemtag attr>First item.</itemtag>
27948 \begin_layout LyX-Code
27950 \change_inserted -970929547 1515109678
27951 <itemtag attr>Second item.</itemtag>
27954 \begin_layout LyX-Code
27956 \change_inserted -970929547 1496610966
27960 \begin_layout Standard
27962 \change_inserted -970929547 1496612243
27963 The specific tags and roles output for each paragraph type can be controlled
27964 by means of the layout tags we are about to describe.
27965 Please note that, due to the very nature of DocBook, no sensible defaults
27966 really exist, and the values must always be carefully chosen.
27970 \begin_layout Description
27972 \change_inserted -970929547 1515110057
27973 \begin_inset Flex Code
27976 \begin_layout Plain Layout
27978 \change_inserted -970929547 1515109656
27987 \begin_inset Flex Code
27990 \begin_layout Plain Layout
27992 \change_inserted -970929547 1496610966
28000 ] Specifies attribute information to be output with the main tag, replacing
28002 \begin_inset Quotes eld
28006 \begin_inset Flex Code
28009 \begin_layout Plain Layout
28011 \change_inserted -970929547 1515110057
28020 \begin_inset Quotes erd
28023 in the example above.
28024 This information can be used in further processing of the DocBook files.
28030 \begin_layout Description
28032 \change_inserted -970929547 1496612296
28033 \begin_inset Flex Code
28036 \begin_layout Plain Layout
28038 \change_inserted -970929547 1496612269
28047 \begin_inset Flex Code
28050 \begin_layout Plain Layout
28052 \change_inserted -970929547 1496610966
28060 ] The tag to be used for this inset, replacing
28061 \begin_inset Quotes eld
28065 \begin_inset Flex Code
28068 \begin_layout Plain Layout
28070 \change_inserted -970929547 1496612296
28079 \begin_inset Quotes erd
28082 in the example above.
28083 The default is the name of the float and always needs to be changed, as
28084 DocBook provides no generic tag.
28085 \change_inserted 1075283030 1597698868
28089 \begin_layout Description
28091 \change_inserted 1075283030 1597699399
28092 \begin_inset Flex Code
28095 \begin_layout Plain Layout
28097 \change_inserted 1075283030 1597698872
28106 \begin_inset Flex Code
28109 \begin_layout Plain Layout
28111 \change_inserted 1075283030 1597700585
28112 block, paragraph, inline
28119 ] The new-line policy for this tag, see Section
28120 \begin_inset space ~
28124 \begin_inset CommandInset ref
28126 reference "subsec:DocBook-New-line-policy"
28139 \begin_layout Subsection
28141 \change_inserted 1075283030 1597699385
28143 \begin_inset CommandInset label
28145 name "subsec:DocBook-New-line-policy"
28152 \begin_layout Standard
28154 \change_inserted 1075283030 1597698993
28155 For all tags, there are three possible policies for outputting new lines
28157 \begin_inset Flex Code
28160 \begin_layout Plain Layout
28162 \change_inserted 1075283030 1597698987
28173 \begin_layout Itemize
28175 \change_inserted 1075283030 1597699279
28176 \begin_inset Quotes eld
28180 \begin_inset Flex Code
28183 \begin_layout Plain Layout
28185 \change_inserted 1075283030 1597699012
28194 \begin_inset Quotes erd
28197 : the opening and closing tags are on their own lines (i.e.
28198 a line feed after and before the opening and the closing tags).
28199 Typical elements are floats.
28203 \begin_layout LyX-Code
28205 \change_inserted 1075283030 1597699194
28209 \begin_layout LyX-Code
28211 \change_inserted 1075283030 1597699194
28215 \begin_layout LyX-Code
28217 \change_inserted 1075283030 1597699098
28218 Contents of the block.
28221 \begin_layout LyX-Code
28223 \change_inserted 1075283030 1597699196
28227 \begin_layout LyX-Code
28229 \change_inserted 1075283030 1597699198
28233 \begin_layout Itemize
28235 \change_inserted 1075283030 1597699289
28236 \begin_inset Quotes eld
28240 \begin_inset Flex Code
28243 \begin_layout Plain Layout
28245 \change_inserted 1075283030 1597699113
28254 \begin_inset Quotes erd
28257 : the opening and closing tags are on the same, new line; a line feed is
28258 output before the opening tag and after the closing tag.
28259 Typical elements are paragraphs and list items.
28263 \begin_layout LyX-Code
28265 \change_inserted 1075283030 1597699186
28269 \begin_layout LyX-Code
28271 \change_inserted 1075283030 1597699357
28272 <paratag>Contents of the paragraph.</paratag>
28275 \begin_layout LyX-Code
28277 \change_inserted 1075283030 1597699231
28281 \begin_layout Itemize
28283 \change_inserted 1075283030 1597699343
28284 \begin_inset Quotes eld
28288 \begin_inset Flex Code
28291 \begin_layout Plain Layout
28293 \change_inserted 1075283030 1597699307
28302 \begin_inset Quotes erd
28305 : the opening and closing tags are on the same line as the rest of the content.
28306 No line feeds are output.
28307 Typical elements are fonts.
28311 \begin_layout LyX-Code
28313 \change_inserted 1075283030 1597699585
28314 Content before<inlinetag>Contents of the paragraph.</inlinetag>Content after
28317 \begin_layout Standard
28319 \change_inserted 1075283030 1597699585
28320 The default value is always
28321 \begin_inset Quotes eld
28325 \begin_inset Flex Code
28328 \begin_layout Plain Layout
28330 \change_inserted 1075283030 1597699585
28339 \begin_inset Quotes erd
28347 \begin_layout Subsection
28349 \change_inserted -970929547 1515111533
28350 InsetLayout DocBook
28355 \begin_layout Standard
28357 \change_inserted -970929547 1496611894
28358 The DocBook output of insets can also be controlled by information in layout
28362 \begin_layout Standard
28364 \change_inserted -970929547 1496612045
28365 The DocBook \SpecialChar LyX
28366 outputs for an inset has the following form:
28369 \begin_layout LyX-Code
28371 \change_inserted -970929547 1515110861
28372 <wrappertag wrapperattr>
28375 \begin_layout LyX-Code
28377 \change_inserted -970929547 1515110868
28381 \begin_layout LyX-Code
28383 \change_inserted -970929547 1515110869
28384 <innertag innerattr>
28387 \begin_layout LyX-Code
28389 \change_inserted -970929547 1515110869
28390 Contents of the inset.
28393 \begin_layout LyX-Code
28395 \change_inserted -970929547 1515110870
28399 \begin_layout LyX-Code
28401 \change_inserted -970929547 1515110871
28405 \begin_layout LyX-Code
28407 \change_inserted -970929547 1515111172
28411 \begin_layout Standard
28413 \change_inserted -970929547 1515111186
28414 For an itemising inset, it rather looks like this:
28417 \begin_layout LyX-Code
28419 \change_inserted -970929547 1515111186
28420 <wrappertag wrapperattr>
28423 \begin_layout LyX-Code
28425 \change_inserted -970929547 1515111186
28429 \begin_layout LyX-Code
28431 \change_inserted -970929547 1515111186
28432 <innertag innerattr>
28435 \begin_layout LyX-Code
28437 \change_inserted -970929547 1515111362
28438 <itemwrappertag itemwrapperattr>
28441 \begin_layout LyX-Code
28443 \change_inserted -970929547 1515111364
28444 <itemlabeltag itemattr>
28447 \begin_layout LyX-Code
28449 \change_inserted -970929547 1515111367
28450 Label of the first item.
28453 \begin_layout LyX-Code
28455 \change_inserted -970929547 1515111362
28461 \begin_layout LyX-Code
28463 \change_inserted -970929547 1515111517
28467 \begin_layout LyX-Code
28469 \change_inserted -970929547 1515111517
28475 \begin_layout LyX-Code
28477 \change_inserted -970929547 1515111516
28478 Contents of the first item.
28481 \begin_layout LyX-Code
28483 \change_inserted -970929547 1515111514
28489 \begin_layout LyX-Code
28491 \change_inserted -970929547 1515111247
28497 \begin_layout LyX-Code
28499 \change_inserted -970929547 1515111221
28503 \begin_layout LyX-Code
28505 \change_inserted -970929547 1515111370
28506 <itemwrappertag itemwrapperattr>
28509 \begin_layout LyX-Code
28511 \change_inserted -970929547 1515111370
28512 <itemlabeltag itemattr>
28515 \begin_layout LyX-Code
28517 \change_inserted -970929547 1515111372
28518 Label of the second item.
28521 \begin_layout LyX-Code
28523 \change_inserted -970929547 1515111370
28529 \begin_layout LyX-Code
28531 \change_inserted -970929547 1515111504
28535 \begin_layout LyX-Code
28537 \change_inserted -970929547 1515111505
28543 \begin_layout LyX-Code
28545 \change_inserted -970929547 1515111507
28546 Contents of the second item.
28549 \begin_layout LyX-Code
28551 \change_inserted -970929547 1515111509
28557 \begin_layout LyX-Code
28559 \change_inserted -970929547 1515111251
28565 \begin_layout LyX-Code
28567 \change_inserted -970929547 1515111221
28573 \begin_layout LyX-Code
28575 \change_inserted -970929547 1515111219
28581 \begin_layout LyX-Code
28583 \change_inserted -970929547 1515111186
28587 \begin_layout LyX-Code
28589 \change_inserted -970929547 1515111186
28593 \begin_layout LyX-Code
28595 \change_inserted -970929547 1515111186
28599 \begin_layout Standard
28601 \change_inserted -970929547 1515111183
28602 If the inset permits multiple paragraphs—that is, if
28603 \begin_inset Flex Code
28606 \begin_layout Plain Layout
28608 \change_inserted -970929547 1496610966
28616 is true—then the contents of the inset will itself be output as paragraphs
28617 formatted according to the styles used for those paragraphs (standard,
28618 quote, and the like).
28619 The inner tag is optional and, by default, does not appear.
28622 \begin_layout Standard
28624 \change_inserted -970929547 1496610966
28625 The specific tags and attributes output for each inset can be controlled
28626 by means of the following layout tags.
28629 \begin_layout Description
28631 \change_inserted -970929547 1515110317
28632 \begin_inset Flex Code
28635 \begin_layout Plain Layout
28637 \change_inserted -970929547 1515109695
28646 \begin_inset Flex Code
28649 \begin_layout Plain Layout
28651 \change_inserted -970929547 1496611854
28659 ] Specifies attribute information to be output with the main tag, replacing
28661 \begin_inset Quotes eld
28665 \begin_inset Flex Code
28668 \begin_layout Plain Layout
28670 \change_inserted -970929547 1515110044
28679 \begin_inset Quotes erd
28682 in the example above.
28683 This information can be used in further processing of the DocBook files.
28687 \begin_layout Description
28689 \change_inserted -970929547 1515110973
28690 \begin_inset Flex Code
28693 \begin_layout Plain Layout
28695 \change_inserted -970929547 1515110319
28704 \begin_inset Flex Code
28707 \begin_layout Plain Layout
28709 \change_inserted -970929547 1515110384
28710 never, always, maybe
28717 ] Specifies whether this tag goes into the
28718 \begin_inset Flex Code
28721 \begin_layout Plain Layout
28723 \change_inserted -970929547 1515110412
28731 tag at the beginning of the parent layout.
28733 \begin_inset Flex Code
28736 \begin_layout Plain Layout
28738 \change_inserted -970929547 1515110437
28746 indicates that the tag never goes into
28747 \begin_inset Flex Code
28750 \begin_layout Plain Layout
28752 \change_inserted -970929547 1515110497
28760 (this is default value, and corresponds to usual content).
28762 \begin_inset Flex Code
28765 \begin_layout Plain Layout
28767 \change_inserted -970929547 1515110517
28775 indicates that the tag always goes into
28776 \begin_inset Flex Code
28779 \begin_layout Plain Layout
28781 \change_inserted -970929547 1515110514
28789 (this corresponds to usual metadata): if there is no
28790 \begin_inset Flex Code
28793 \begin_layout Plain Layout
28795 \change_inserted -970929547 1515110550
28803 tag for the parent, one
28809 \begin_inset Flex Code
28812 \begin_layout Plain Layout
28814 \change_inserted -970929547 1515110540
28822 indicates that the tag may go into
28823 \begin_inset Flex Code
28826 \begin_layout Plain Layout
28828 \change_inserted -970929547 1515110538
28836 (this is only the case for titles): if there is no
28837 \begin_inset Flex Code
28840 \begin_layout Plain Layout
28842 \change_inserted -970929547 1515110585
28850 tag for the parent,
28854 will be generated, the corresponding tag will be output directly as content.
28858 \begin_layout Description
28860 \change_inserted -970929547 1515111461
28861 \begin_inset Flex Code
28864 \begin_layout Plain Layout
28866 \change_inserted -970929547 1515110974
28875 \begin_inset Flex Code
28878 \begin_layout Plain Layout
28880 \change_inserted -970929547 1515110973
28888 ] Specifies attribute information to be output with the item tag, replacing
28890 \begin_inset Quotes eld
28894 \begin_inset Flex Code
28897 \begin_layout Plain Layout
28899 \change_inserted -970929547 1515110984
28908 \begin_inset Quotes erd
28911 in the example above.
28912 This information can be used in further processing of the DocBook files.
28916 \begin_layout Description
28918 \change_inserted -970929547 1515111471
28919 \begin_inset Flex Code
28922 \begin_layout Plain Layout
28924 \change_inserted -970929547 1515111465
28925 DocBookItemInnerAttr
28933 \begin_inset Flex Code
28936 \begin_layout Plain Layout
28938 \change_inserted -970929547 1515111461
28946 ] Specifies attribute information to be output with the item inner tag,
28948 \begin_inset Quotes eld
28952 \begin_inset Flex Code
28955 \begin_layout Plain Layout
28957 \change_inserted -970929547 1515111476
28966 \begin_inset Quotes erd
28969 in the example above.
28970 This information can be used in further processing of the DocBook files.
28974 \begin_layout Description
28976 \change_inserted -970929547 1515111494
28977 \begin_inset Flex Code
28980 \begin_layout Plain Layout
28982 \change_inserted -970929547 1515111467
28983 DocBookItemInnerTag
28991 \begin_inset Flex Code
28994 \begin_layout Plain Layout
28996 \change_inserted -970929547 1515111461
29004 ] The tag to be used for the item inner tag within the inset, replacing
29006 \begin_inset Quotes eld
29010 \begin_inset Flex Code
29013 \begin_layout Plain Layout
29015 \change_inserted -970929547 1515111486
29024 \begin_inset Quotes erd
29027 in the example above.
29029 \begin_inset Flex Code
29032 \begin_layout Plain Layout
29034 \change_inserted -970929547 1515111461
29042 , indicating that there is no item inner tag: content is directly output
29043 without it for each itemised element.
29044 This parameter only makes sense when itemising layouts are used, such as
29047 \change_inserted 1075283030 1598469472
29048 The most likely value is
29049 \begin_inset Quotes eld
29053 \begin_inset Flex Code
29056 \begin_layout Plain Layout
29058 \change_inserted 1075283030 1598469476
29067 \begin_inset Quotes erd
29071 \begin_inset Newline newline
29074 When a list item is split using a new line, the item inner tag will be repeated
29075 for each part of the paragraph, parts being separated by new lines.
29079 \begin_layout Description
29081 \change_inserted 1075283030 1597699866
29082 \begin_inset Flex Code
29085 \begin_layout Plain Layout
29087 \change_inserted 1075283030 1597699853
29088 DocBookItemInnerTagType
29096 \begin_inset Flex Code
29099 \begin_layout Plain Layout
29101 \change_inserted 1075283030 1597699866
29102 block, paragraph, inline
29109 ] The new-line policy for this tag, see Section
29110 \begin_inset space ~
29114 \begin_inset CommandInset ref
29116 reference "subsec:DocBook-New-line-policy"
29129 \begin_layout Description
29131 \change_inserted -970929547 1515111290
29132 \begin_inset Flex Code
29135 \begin_layout Plain Layout
29137 \change_inserted -970929547 1515111283
29138 DocBookItemLabelAttr
29146 \begin_inset Flex Code
29149 \begin_layout Plain Layout
29151 \change_inserted -970929547 1515111279
29159 ] Specifies attribute information to be output with the item label tag,
29161 \begin_inset Quotes eld
29165 \begin_inset Flex Code
29168 \begin_layout Plain Layout
29170 \change_inserted -970929547 1515111304
29179 \begin_inset Quotes erd
29182 in the example above.
29183 This information can be used in further processing of the DocBook files.
29187 \begin_layout Description
29189 \change_inserted -970929547 1515111337
29190 \begin_inset Flex Code
29193 \begin_layout Plain Layout
29195 \change_inserted -970929547 1515111285
29196 DocBookItemLabelTag
29204 \begin_inset Flex Code
29207 \begin_layout Plain Layout
29209 \change_inserted -970929547 1515111279
29217 ] The tag to be used for the item label tag within the inset, replacing
29219 \begin_inset Quotes eld
29223 \begin_inset Flex Code
29226 \begin_layout Plain Layout
29228 \change_inserted -970929547 1515111311
29237 \begin_inset Quotes erd
29240 in the example above.
29241 This parameter only makes sense when itemising layouts are used with a
29242 notion of labels, such as definition lists.
29244 \change_inserted 1075283030 1597699874
29248 \begin_layout Description
29250 \change_inserted 1075283030 1597699874
29251 \begin_inset Flex Code
29254 \begin_layout Plain Layout
29256 \change_inserted 1075283030 1597699880
29257 DocBookItemLabelTagType
29265 \begin_inset Flex Code
29268 \begin_layout Plain Layout
29270 \change_inserted 1075283030 1597699874
29271 block, paragraph, inline
29278 ] The new-line policy for this tag, see Section
29279 \begin_inset space ~
29283 \begin_inset CommandInset ref
29285 reference "subsec:DocBook-New-line-policy"
29298 \begin_layout Description
29300 \change_inserted -970929547 1515111124
29301 \begin_inset Flex Code
29304 \begin_layout Plain Layout
29306 \change_inserted -970929547 1515111060
29315 \begin_inset Flex Code
29318 \begin_layout Plain Layout
29320 \change_inserted -970929547 1515111060
29328 ] The tag to be used for the item tag within the inset, replacing
29329 \begin_inset Quotes eld
29333 \begin_inset Flex Code
29336 \begin_layout Plain Layout
29338 \change_inserted -970929547 1515111060
29347 \begin_inset Quotes erd
29350 in the example above.
29352 \begin_inset Flex Code
29355 \begin_layout Plain Layout
29357 \change_inserted -970929547 1515111060
29365 , indicating that there is no item tag.
29366 This parameter only makes sense when itemising layouts are used, such as
29369 \change_inserted 1075283030 1597699890
29373 \begin_layout Description
29375 \change_inserted 1075283030 1597699890
29376 \begin_inset Flex Code
29379 \begin_layout Plain Layout
29381 \change_inserted 1075283030 1597699890
29390 \begin_inset Flex Code
29393 \begin_layout Plain Layout
29395 \change_inserted 1075283030 1597699890
29396 block, paragraph, inline
29403 ] The new-line policy for this tag, see Section
29404 \begin_inset space ~
29408 \begin_inset CommandInset ref
29410 reference "subsec:DocBook-New-line-policy"
29423 \begin_layout Description
29425 \change_inserted -970929547 1515111298
29426 \begin_inset Flex Code
29429 \begin_layout Plain Layout
29431 \change_inserted -970929547 1515111124
29432 DocBookItemWrapperAttr
29440 \begin_inset Flex Code
29443 \begin_layout Plain Layout
29445 \change_inserted -970929547 1515111124
29453 ] Specifies attribute information to be output with the item wrapper tag,
29455 \begin_inset Quotes eld
29459 \begin_inset Flex Code
29462 \begin_layout Plain Layout
29464 \change_inserted -970929547 1515111150
29473 \begin_inset Quotes erd
29476 in the example above.
29477 This information can be used in further processing of the DocBook files.
29483 \begin_layout Description
29485 \change_inserted -970929547 1515111113
29486 \begin_inset Flex Code
29489 \begin_layout Plain Layout
29491 \change_inserted -970929547 1515111073
29492 DocBookItemWrapperTag
29500 \begin_inset Flex Code
29503 \begin_layout Plain Layout
29505 \change_inserted -970929547 1515111073
29513 ] The tag to be used for the item wrapper tag within the inset, replacing
29515 \begin_inset Quotes eld
29519 \begin_inset Flex Code
29522 \begin_layout Plain Layout
29524 \change_inserted -970929547 1515111083
29533 \begin_inset Quotes erd
29536 in the example above.
29538 \begin_inset Flex Code
29541 \begin_layout Plain Layout
29543 \change_inserted -970929547 1515111073
29551 , indicating that there is no item wrapper tag: tag and content are directly
29552 output without it for each itemised element.
29553 This parameter only makes sense when itemising layouts are used, such as
29556 \change_inserted 1075283030 1597699897
29560 \begin_layout Description
29562 \change_inserted 1075283030 1597699897
29563 \begin_inset Flex Code
29566 \begin_layout Plain Layout
29568 \change_inserted 1075283030 1597699900
29569 DocBookItemWrapperTagType
29577 \begin_inset Flex Code
29580 \begin_layout Plain Layout
29582 \change_inserted 1075283030 1597699897
29583 block, paragraph, inline
29590 ] The new-line policy for this tag, see Section
29591 \begin_inset space ~
29595 \begin_inset CommandInset ref
29597 reference "subsec:DocBook-New-line-policy"
29610 \begin_layout Description
29612 \change_inserted -970929547 1515110104
29613 \begin_inset Flex Code
29616 \begin_layout Plain Layout
29618 \change_inserted -970929547 1515110104
29627 \begin_inset Flex Code
29630 \begin_layout Plain Layout
29632 \change_inserted -970929547 1515110104
29640 ] Specifies attribute information to be output with the inner tag, replacing
29642 \begin_inset Quotes eld
29646 \begin_inset Flex Code
29649 \begin_layout Plain Layout
29651 \change_inserted -970929547 1515110104
29660 \begin_inset Quotes erd
29663 in the example above.
29664 This information can be used in further processing of the DocBook files.
29668 \begin_layout Description
29670 \change_inserted -970929547 1515110906
29671 \begin_inset Flex Code
29674 \begin_layout Plain Layout
29676 \change_inserted -970929547 1515110104
29685 \begin_inset Flex Code
29688 \begin_layout Plain Layout
29690 \change_inserted -970929547 1515110104
29698 ] The tag to be used for the inner tag within the inset, replacing
29699 \begin_inset Quotes eld
29703 \begin_inset Flex Code
29706 \begin_layout Plain Layout
29708 \change_inserted -970929547 1515110104
29717 \begin_inset Quotes erd
29720 in the example above.
29722 \begin_inset Flex Code
29725 \begin_layout Plain Layout
29727 \change_inserted -970929547 1515110791
29735 , indicating that there is no inner tag: content is directly output without
29737 \change_inserted 1075283030 1597699904
29741 \begin_layout Description
29743 \change_inserted 1075283030 1597699904
29744 \begin_inset Flex Code
29747 \begin_layout Plain Layout
29749 \change_inserted 1075283030 1597699904
29750 DocBookInnerTagType
29758 \begin_inset Flex Code
29761 \begin_layout Plain Layout
29763 \change_inserted 1075283030 1597699904
29764 block, paragraph, inline
29771 ] The new-line policy for this tag, see Section
29772 \begin_inset space ~
29776 \begin_inset CommandInset ref
29778 reference "subsec:DocBook-New-line-policy"
29791 \begin_layout Description
29793 \change_inserted -970929547 1515110753
29794 \begin_inset Flex Code
29797 \begin_layout Plain Layout
29799 \change_inserted -970929547 1515110665
29808 \begin_inset Flex Code
29811 \begin_layout Plain Layout
29813 \change_inserted -970929547 1515110661
29821 ] Specifies the tag that corresponds to this kind of section.
29822 This parameter only makes sense for sectioning elements (part, chapter,
29824 The default value is
29825 \begin_inset Flex Code
29828 \begin_layout Plain Layout
29830 \change_inserted -970929547 1515110721
29838 , and is only overridden when DocBook uses something else for sectioning
29840 \change_inserted 1075283030 1597699921
29842 \change_inserted -970929547 1515110753
29843 parts and chapters of a book).
29849 \begin_layout Description
29851 \change_inserted -970929547 1515110811
29852 \begin_inset Flex Code
29855 \begin_layout Plain Layout
29857 \change_inserted -970929547 1496612023
29866 \begin_inset Flex Code
29869 \begin_layout Plain Layout
29871 \change_inserted -970929547 1496610966
29879 ] The tag to be used for this inset, replacing
29880 \begin_inset Quotes eld
29884 \begin_inset Flex Code
29887 \begin_layout Plain Layout
29889 \change_inserted -970929547 1496612033
29898 \begin_inset Quotes erd
29901 in the example above.
29902 The default is the name of the float and always needs to be changed, as
29903 DocBook provides no generic inset tag.
29904 \change_inserted 1075283030 1597699924
29908 \begin_layout Description
29910 \change_inserted 1075283030 1597699924
29911 \begin_inset Flex Code
29914 \begin_layout Plain Layout
29916 \change_inserted 1075283030 1597699924
29925 \begin_inset Flex Code
29928 \begin_layout Plain Layout
29930 \change_inserted 1075283030 1597699924
29931 block, paragraph, inline
29938 ] The new-line policy for this tag, see Section
29939 \begin_inset space ~
29943 \begin_inset CommandInset ref
29945 reference "subsec:DocBook-New-line-policy"
29958 \begin_layout Description
29960 \change_inserted -970929547 1515110832
29961 \begin_inset Flex Code
29964 \begin_layout Plain Layout
29966 \change_inserted -970929547 1515110822
29975 \begin_inset Flex Code
29978 \begin_layout Plain Layout
29980 \change_inserted -970929547 1515110811
29988 ] Specifies attribute information to be output with the outer tag, replacing
29990 \begin_inset Quotes eld
29994 \begin_inset Flex Code
29997 \begin_layout Plain Layout
29999 \change_inserted -970929547 1515110845
30008 \begin_inset Quotes erd
30011 in the example above.
30012 This information can be used in further processing of the DocBook files.
30016 \begin_layout Description
30018 \change_inserted -970929547 1515110917
30019 \begin_inset Flex Code
30022 \begin_layout Plain Layout
30024 \change_inserted -970929547 1515110826
30033 \begin_inset Flex Code
30036 \begin_layout Plain Layout
30038 \change_inserted -970929547 1515110811
30046 ] The tag to be used for the wrapper tag around the inset, replacing
30047 \begin_inset Quotes eld
30051 \begin_inset Flex Code
30054 \begin_layout Plain Layout
30056 \change_inserted -970929547 1515110842
30065 \begin_inset Quotes erd
30068 in the example above.
30070 \begin_inset Flex Code
30073 \begin_layout Plain Layout
30075 \change_inserted -970929547 1515110811
30083 , indicating that there is no wrapper tag: tag and content are directly
30085 \change_inserted 1075283030 1597699929
30089 \begin_layout Description
30091 \change_inserted 1075283030 1597699929
30092 \begin_inset Flex Code
30095 \begin_layout Plain Layout
30097 \change_inserted 1075283030 1597699932
30098 DocBookWrapperTagType
30106 \begin_inset Flex Code
30109 \begin_layout Plain Layout
30111 \change_inserted 1075283030 1597699929
30112 block, paragraph, inline
30119 ] The new-line policy for this tag, see Section
30120 \begin_inset space ~
30124 \begin_inset CommandInset ref
30126 reference "subsec:DocBook-New-line-policy"
30139 \begin_layout Subsection
30141 \change_inserted -970929547 1515110040
30145 \begin_layout Standard
30147 \change_inserted -970929547 1496611700
30148 The DocBook output for floats too can be controlled by layout information.
30149 The output has the following form:
30152 \begin_layout LyX-Code
30154 \change_inserted -970929547 1515109700
30158 \begin_layout LyX-Code
30160 \change_inserted -970929547 1515110138
30161 Contents of the float as DocBook.
30164 \begin_layout LyX-Code
30166 \change_inserted -970929547 1496610966
30170 \begin_layout Standard
30172 \change_inserted -970929547 1496611715
30173 The caption, if there is one, is a separate inset and will be output as
30178 \begin_layout Description
30180 \change_inserted -970929547 1515110033
30181 \begin_inset Flex Code
30184 \begin_layout Plain Layout
30186 \change_inserted -970929547 1515109702
30195 \begin_inset Flex Code
30198 \begin_layout Plain Layout
30200 \change_inserted -970929547 1496610966
30208 ] Specifies attribute information to be output with the main tag, replacing
30210 \begin_inset Quotes eld
30214 \begin_inset Flex Code
30217 \begin_layout Plain Layout
30219 \change_inserted -970929547 1515110035
30228 \begin_inset Quotes erd
30231 in the example above.
30232 This information can be used in further processing of the DocBook files.
30236 \begin_layout Description
30238 \change_inserted -970929547 1515110157
30239 \begin_inset Flex Code
30242 \begin_layout Plain Layout
30244 \change_inserted -970929547 1496611782
30253 \begin_inset Flex Code
30256 \begin_layout Plain Layout
30258 \change_inserted -970929547 1496610966
30266 ] The tag to be used for this float, replacing
30267 \begin_inset Quotes eld
30271 \begin_inset Flex Code
30274 \begin_layout Plain Layout
30276 \change_inserted -970929547 1496610966
30285 \begin_inset Quotes erd
30288 in the example above.
30289 The default is the name of the float and always needs to be changed, as
30290 DocBook provides no generic float tag.
30293 \begin_layout Subsection
30295 \change_inserted -970929547 1515110157
30296 Bibliography formatting
30299 \begin_layout Standard
30301 \change_deleted 1075283030 1597699984
30303 \change_inserted 1075283030 1597699985
30305 \change_inserted -970929547 1515110187
30307 \change_deleted 1075283030 1597699987
30309 \change_inserted 1075283030 1597699987
30311 \change_inserted -970929547 1515110187
30312 cannot be formatted: all fields are always output in the database-like
30313 DocBook format (equivalent to a BibTeX file)
30314 \change_inserted 1075283030 1597700117
30316 \begin_inset Flex Code
30319 \begin_layout Plain Layout
30321 \change_inserted 1075283030 1597700120
30330 \change_inserted -970929547 1515110187
30332 \change_inserted 1075283030 1597700092
30336 \begin_layout Standard
30338 \change_inserted 1075283030 1597700112
30339 When the bibliographic entries are manually inserted into the LyX document
30340 as Bibliography Items, the user deals with formatting themself: there is
30341 no attempt of parsing what the user wrote, the string is directly used
30343 \begin_inset Flex Code
30346 \begin_layout Plain Layout
30348 \change_inserted 1075283030 1597700076
30362 \begin_layout Chapter
30363 Including External Material
30364 \begin_inset CommandInset label
30366 name "chap:Including-External-Material"
30373 \begin_layout Standard
30374 \begin_inset Box Shadowbox
30384 height_special "totalheight"
30389 backgroundcolor "none"
30392 \begin_layout Plain Layout
30393 WARNING: This portion of the documentation has not been updated for some
30395 We certainly hope that it is still accurate, but there are no guarantees.
30403 \begin_layout Standard
30404 The use of material from sources external to \SpecialChar LyX
30405 is covered in detail in the
30411 This part of the manual covers what needs to happen behind the scenes for
30412 new sorts of material to be included.
30415 \begin_layout Section
30419 \begin_layout Standard
30420 The external material feature is based on the concept of a
30425 A template is a specification of how \SpecialChar LyX
30426 should interface with a certain kind
30428 As bundled, \SpecialChar LyX
30429 comes with predefined templates for Xfig figures, various
30430 raster format images, chess diagrams, and LilyPond music notation.
30431 You can check the actual list by using the menu
30432 \begin_inset Flex Noun
30435 \begin_layout Plain Layout
30436 Insert\SpecialChar menuseparator
30437 File\SpecialChar menuseparator
30444 Furthermore, it is possible to roll your own template to support a specific
30446 Later we'll describe in more detail what is involved, and hopefully you
30447 will submit all the templates you create so we can include them in a later
30452 \begin_layout Standard
30453 Another basic idea of the external material feature is to distinguish between
30454 the original file that serves as a base for final material and the produced
30455 file that is included in your exported or printed document.
30456 For example, consider the case of a figure produced with
30457 \begin_inset Flex Code
30460 \begin_layout Plain Layout
30467 The Xfig application itself works on an original file with the
30468 \begin_inset Flex Code
30471 \begin_layout Plain Layout
30478 Within Xfig, you create and change your figure, and when you are done,
30480 \begin_inset Flex Code
30483 \begin_layout Plain Layout
30490 When you want to include the figure in your document, you invoke
30491 \begin_inset Flex Code
30494 \begin_layout Plain Layout
30500 in order to create a PostScript file that can readily be included in your
30504 \begin_inset Flex Code
30507 \begin_layout Plain Layout
30513 file is the original file, and the PostScript file is the produced file.
30516 \begin_layout Standard
30517 This distinction is important in order to allow updating of the material
30518 while you are in the process of writing the document.
30519 Furthermore, it provides us with the flexibility that is needed to support
30520 multiple export formats.
30521 For instance, in the case of a plain text file, it is not exactly an award-winn
30522 ing idea to include the figure as raw PostScript.
30523 Instead, you would either prefer to just include a reference to the figure
30524 or try to invoke some graphics to ASCII converter to make the final result
30525 look similar to the real graphics.
30526 The external material management allows you to do this, because it is parametri
30527 zed on the different export formats that \SpecialChar LyX
30531 \begin_layout Standard
30532 Besides supporting the production of different products according to the
30533 exported format, it supports tight integration with editing and viewing
30535 In the case of an Xfig figure, you are able to invoke Xfig on the original
30536 file with a single click from within the external material dialog in \SpecialChar LyX
30538 and also preview the produced PostScript file with Ghostview with another
30540 No more fiddling around with the command line and/or file browsers to locate
30541 and manipulate the original or produced files.
30542 In this way, you are finally able to take full advantage of the many different
30543 applications that are relevant to use when you write your documents, and
30544 ultimately be more productive.
30547 \begin_layout Section
30548 The external template configuration files
30551 \begin_layout Standard
30552 It is relatively easy to add custom external template definitions to \SpecialChar LyX
30554 However, be aware that doing this in an careless manner most probably
30558 introduce an easily exploitable security hole.
30559 So before you do this, please read the discussion about security in
30560 \begin_inset CommandInset ref
30562 reference "sec:Security-discussion"
30569 \begin_layout Standard
30570 Having said that, we encourage you to submit any interesting templates that
30575 \begin_layout Standard
30576 The external templates are defined in the
30577 \begin_inset Flex Code
30580 \begin_layout Plain Layout
30586 files that are stored in the
30587 \begin_inset Flex Code
30590 \begin_layout Plain Layout
30591 LyXDir/lib/xtemplates/
30597 Each template is defined in a file of its own.
30598 You can place your own templates in
30599 \begin_inset Flex Code
30602 \begin_layout Plain Layout
30603 UserDir/xtemplates/
30608 or copy existing templates to that directory in order to modify them.
30611 \begin_layout Standard
30612 A typical template looks like this:
30615 \begin_layout LyX-Code
30619 \begin_layout LyX-Code
30620 GuiName "XFig: $$AbsOrRelPathParent$$Basename"
30623 \begin_layout LyX-Code
30627 \begin_layout LyX-Code
30631 \begin_layout LyX-Code
30635 \begin_layout LyX-Code
30639 \begin_layout LyX-Code
30643 \begin_layout LyX-Code
30644 AutomaticProduction true
30647 \begin_layout LyX-Code
30651 \begin_layout LyX-Code
30655 \begin_layout LyX-Code
30659 \begin_layout LyX-Code
30660 TransformCommand Rotate RotationLatexCommand
30663 \begin_layout LyX-Code
30664 TransformCommand Resize ResizeLatexCommand
30667 \begin_layout LyX-Code
30668 Product "$$RotateFront$$ResizeFront
30671 \begin_layout LyX-Code
30676 input{$$AbsOrRelPathMaster$$Basename.pstex_t}
30679 \begin_layout LyX-Code
30680 $$ResizeBack$$RotateBack"
30683 \begin_layout LyX-Code
30687 \begin_layout LyX-Code
30688 UpdateResult "$$AbsPath$$Basename.pstex_t"
30691 \begin_layout LyX-Code
30692 Requirement "graphicx"
30695 \begin_layout LyX-Code
30696 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
30699 \begin_layout LyX-Code
30700 ReferencedFile latex "$$AbsPath$$Basename.eps"
30703 \begin_layout LyX-Code
30704 ReferencedFile dvi "$$AbsPath$$Basename.eps"
30707 \begin_layout LyX-Code
30711 \begin_layout LyX-Code
30715 \begin_layout LyX-Code
30716 TransformCommand Rotate RotationLatexCommand
30719 \begin_layout LyX-Code
30720 TransformCommand Resize ResizeLatexCommand
30723 \begin_layout LyX-Code
30724 Product "$$RotateFront$$ResizeFront
30727 \begin_layout LyX-Code
30732 input{$$AbsOrRelPathMaster$$Basename.pdftex_t}
30735 \begin_layout LyX-Code
30736 $$ResizeBack$$RotateBack"
30739 \begin_layout LyX-Code
30740 UpdateFormat pdftex
30743 \begin_layout LyX-Code
30744 UpdateResult "$$AbsPath$$Basename.pdftex_t"
30747 \begin_layout LyX-Code
30748 Requirement "graphicx"
30751 \begin_layout LyX-Code
30752 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pdftex_t"
30755 \begin_layout LyX-Code
30756 ReferencedFile latex "$$AbsPath$$Basename.pdf"
30759 \begin_layout LyX-Code
30763 \begin_layout LyX-Code
30767 \begin_layout LyX-Code
30768 Product "[XFig: $$FName]"
30771 \begin_layout LyX-Code
30775 \begin_layout LyX-Code
30779 \begin_layout LyX-Code
30780 Product "<graphic fileref=
30782 "$$AbsOrRelPathMaster$$Basename.eps
30787 \begin_layout LyX-Code
30791 \begin_layout LyX-Code
30795 \begin_layout LyX-Code
30796 UpdateResult "$$AbsPath$$Basename.eps"
30799 \begin_layout LyX-Code
30800 ReferencedFile docbook "$$AbsPath$$Basename.eps"
30803 \begin_layout LyX-Code
30804 ReferencedFile docbook-xml "$$AbsPath$$Basename.eps"
30807 \begin_layout LyX-Code
30811 \begin_layout LyX-Code
30815 \begin_layout Standard
30816 As you can see, the template is enclosed in
30817 \begin_inset Flex Code
30820 \begin_layout Plain Layout
30828 \begin_inset Flex Code
30831 \begin_layout Plain Layout
30838 It contains a header specifying some general settings and, for each supported
30839 primary document file format, a section
30840 \begin_inset Flex Code
30843 \begin_layout Plain Layout
30851 \begin_inset Flex Code
30854 \begin_layout Plain Layout
30863 \begin_layout Subsection
30864 The template header
30867 \begin_layout Description
30868 \begin_inset Flex Code
30871 \begin_layout Plain Layout
30872 AutomaticProduction
30873 \begin_inset space ~
30881 Whether the file represented by the template must be generated by \SpecialChar LyX
30883 This command must occur exactly once.
30886 \begin_layout Description
30887 \begin_inset Flex Code
30890 \begin_layout Plain Layout
30892 \begin_inset space ~
30900 A glob pattern that is used in the file dialog to filter out the desired
30902 If there is more than one possible file extension (e.
30903 \begin_inset space \thinspace{}
30907 \begin_inset space \space{}
30911 \begin_inset Flex Code
30914 \begin_layout Plain Layout
30921 \begin_inset Flex Code
30924 \begin_layout Plain Layout
30930 ), use something like
30931 \begin_inset Flex Code
30934 \begin_layout Plain Layout
30941 This command must occur exactly once.
30944 \begin_layout Description
30945 \begin_inset Flex Code
30948 \begin_layout Plain Layout
30950 \begin_inset space ~
30958 The text that is displayed on the button.
30959 This command must occur exactly once.
30962 \begin_layout Description
30963 \begin_inset Flex Code
30966 \begin_layout Plain Layout
30968 \begin_inset space ~
30972 \begin_inset space ~
30980 The help text that is used in the External dialog.
30981 Provide enough information to explain to the user just what the template
30982 can provide him with.
30983 This command must occur exactly once.
30986 \begin_layout Description
30987 \begin_inset Flex Code
30990 \begin_layout Plain Layout
30992 \begin_inset space ~
31000 The file format of the original file.
31001 This must be the name of a format that is known to \SpecialChar LyX
31003 \begin_inset CommandInset ref
31005 reference "sec:Formats"
31011 \begin_inset Quotes eld
31015 \begin_inset Flex Code
31018 \begin_layout Plain Layout
31025 \begin_inset Quotes erd
31028 if the template can handle original files of more than one format.
31030 will attempt to interrogate the file itself in order to deduce its format
31032 This command must occur exactly once.
31035 \begin_layout Description
31036 \begin_inset Flex Code
31039 \begin_layout Plain Layout
31041 \begin_inset space ~
31049 A unique name for the template.
31050 It must not contain substitution macros (see below).
31053 \begin_layout Description
31054 \begin_inset Flex Code
31057 \begin_layout Plain Layout
31059 \begin_inset space ~
31062 Rotate|Resize|Clip|Extra
31067 This command specifies which transformations are supported by this template.
31068 It may occur zero or more times.
31069 This command enables the corresponding tabs in the external dialog.
31071 \begin_inset Flex Code
31074 \begin_layout Plain Layout
31080 command must have either a corresponding
31081 \begin_inset Flex Code
31084 \begin_layout Plain Layout
31091 \begin_inset Flex Code
31094 \begin_layout Plain Layout
31101 \begin_inset Flex Code
31104 \begin_layout Plain Layout
31111 Otherwise the transformation will not be supported by that format.
31114 \begin_layout Subsection
31118 \begin_layout Description
31119 \begin_inset Flex Code
31122 \begin_layout Plain Layout
31124 \begin_inset space ~
31127 LaTeX|PDFLaTeX|PlainText|DocBook|XHTML
31132 The primary document file format that this format definition is for.
31133 Not every template has a sensible representation in all document file formats.
31134 Please define nevertheless a
31135 \begin_inset Flex Code
31138 \begin_layout Plain Layout
31144 section for all templates.
31145 Use a dummy text when no representation is available.
31146 Then you can at least see a reference to the external material in the exported
31150 \begin_layout Description
31151 \begin_inset Flex Code
31154 \begin_layout Plain Layout
31156 \begin_inset space ~
31160 \begin_inset space ~
31168 This command defines an additional macro
31169 \begin_inset Flex Code
31172 \begin_layout Plain Layout
31178 for substitution in
31179 \begin_inset Flex Code
31182 \begin_layout Plain Layout
31190 \begin_inset Flex Code
31193 \begin_layout Plain Layout
31199 itself may contain substitution macros.
31200 The advantage over using
31201 \begin_inset Flex Code
31204 \begin_layout Plain Layout
31211 \begin_inset Flex Code
31214 \begin_layout Plain Layout
31220 is that the substituted value of
31221 \begin_inset Flex Code
31224 \begin_layout Plain Layout
31230 is sanitized so that it is a valid optional argument in the document format.
31231 This command may occur zero or more times.
31234 \begin_layout Description
31235 \begin_inset Flex Code
31238 \begin_layout Plain Layout
31240 \begin_inset space ~
31248 The text that is inserted in the exported document.
31249 This is actually the most important command and can be quite complex.
31250 This command must occur exactly once.
31253 \begin_layout Description
31254 \begin_inset Flex Code
31257 \begin_layout Plain Layout
31259 \begin_inset space ~
31267 This command specifies a preamble snippet that will be included in the
31270 It has to be defined using
31271 \begin_inset Flex Code
31274 \begin_layout Plain Layout
31282 \begin_inset Flex Code
31285 \begin_layout Plain Layout
31292 This command may occur zero or more times.
31295 \begin_layout Description
31296 \begin_inset Flex Code
31299 \begin_layout Plain Layout
31301 \begin_inset space ~
31305 \begin_inset space ~
31313 This command denotes files that are created by the conversion process and
31314 are needed for a particular export format.
31315 If the filename is relative, it is interpreted relative to the master document.
31316 This command may be given zero or more times.
31319 \begin_layout Description
31320 \begin_inset Flex Code
31323 \begin_layout Plain Layout
31325 \begin_inset space ~
31333 The name of a required \SpecialChar LaTeX
31335 The package is included via
31336 \begin_inset Flex Code
31339 \begin_layout Plain Layout
31347 in the \SpecialChar LaTeX
31349 This command may occur zero or more times.
31352 \begin_layout Description
31353 \begin_inset Flex Code
31356 \begin_layout Plain Layout
31358 \begin_inset space ~
31362 \begin_inset space ~
31365 RotationLatexCommand
31370 This command specifies that the built in \SpecialChar LaTeX
31371 command should be used for rotation.
31372 This command may occur once or not at all.
31375 \begin_layout Description
31376 \begin_inset Flex Code
31379 \begin_layout Plain Layout
31381 \begin_inset space ~
31385 \begin_inset space ~
31393 This command specifies that the built in \SpecialChar LaTeX
31394 command should be used for resizing.
31395 This command may occur once or not at all.
31398 \begin_layout Description
31399 \begin_inset Flex Code
31402 \begin_layout Plain Layout
31404 \begin_inset space ~
31408 \begin_inset space ~
31411 RotationLatexOption
31416 This command specifies that rotation is done via an optional argument.
31417 This command may occur once or not at all.
31420 \begin_layout Description
31421 \begin_inset Flex Code
31424 \begin_layout Plain Layout
31426 \begin_inset space ~
31430 \begin_inset space ~
31438 This command specifies that resizing is done via an optional argument.
31439 This command may occur once or not at all.
31442 \begin_layout Description
31443 \begin_inset Flex Code
31446 \begin_layout Plain Layout
31448 \begin_inset space ~
31452 \begin_inset space ~
31460 This command specifies that clipping is done via an optional argument.
31461 This command may occur once or not at all.
31464 \begin_layout Description
31465 \begin_inset Flex Code
31468 \begin_layout Plain Layout
31470 \begin_inset space ~
31474 \begin_inset space ~
31482 This command specifies that an extra optional argument is used.
31483 This command may occur once or not at all.
31486 \begin_layout Description
31487 \begin_inset Flex Code
31490 \begin_layout Plain Layout
31492 \begin_inset space ~
31500 The file format of the converted file.
31501 This must be the name of a format that is known to \SpecialChar LyX
31503 \begin_inset Flex Noun
31506 \begin_layout Plain Layout
31507 Tools\SpecialChar menuseparator
31508 Preferences\SpecialChar menuseparator
31509 File Handling\SpecialChar menuseparator
31516 This command must occur exactly once.
31517 If the resulting file format is PDF, you need to specify the format
31518 \begin_inset Flex Code
31521 \begin_layout Plain Layout
31528 This is the PDF format used for including graphics.
31529 The other defined PDF formats are for document export.
31532 \begin_layout Description
31533 \begin_inset Flex Code
31536 \begin_layout Plain Layout
31538 \begin_inset space ~
31546 The file name of the converted file.
31547 The file name must be absolute.
31548 This command must occur exactly once.
31551 \begin_layout Subsection
31552 Preamble definitions
31555 \begin_layout Standard
31556 The external template configuration file may contain additional preamble
31557 definitions enclosed by
31558 \begin_inset Flex Code
31561 \begin_layout Plain Layout
31569 \begin_inset Flex Code
31572 \begin_layout Plain Layout
31579 They can be used by the templates in the
31580 \begin_inset Flex Code
31583 \begin_layout Plain Layout
31592 \begin_layout Section
31593 The substitution mechanism
31596 \begin_layout Standard
31597 When the external material facility invokes an external program, it is done
31598 on the basis of a command defined in the template configuration file.
31599 These commands can contain various macros that are expanded before execution.
31600 Execution always take place in the directory of the containing document.
31603 \begin_layout Standard
31604 Also, whenever external material is to be displayed, the name will be produced
31605 by the substitution mechanism, and most other commands in the template
31606 definition support substitution as well.
31609 \begin_layout Standard
31610 The available macros are the following:
31613 \begin_layout Description
31614 \begin_inset Flex Code
31617 \begin_layout Plain Layout
31618 $$AbsOrRelPathMaster
31623 The file path, absolute or relative to the master \SpecialChar LyX
31627 \begin_layout Description
31628 \begin_inset Flex Code
31631 \begin_layout Plain Layout
31632 $$AbsOrRelPathParent
31637 The file path, absolute or relative to the \SpecialChar LyX
31641 \begin_layout Description
31642 \begin_inset Flex Code
31645 \begin_layout Plain Layout
31651 The absolute file path.
31654 \begin_layout Description
31655 \begin_inset Flex Code
31658 \begin_layout Plain Layout
31664 The filename without path and without the extension.
31667 \begin_layout Description
31668 \begin_inset Flex Code
31671 \begin_layout Plain Layout
31673 \begin_inset Quotes eld
31677 \begin_inset Quotes erd
31685 This macro will expand to the contents of the file with the name
31686 \begin_inset Flex Code
31689 \begin_layout Plain Layout
31698 \begin_layout Description
31699 \begin_inset Flex Code
31702 \begin_layout Plain Layout
31708 The file extension (including the dot).
31711 \begin_layout Description
31712 \begin_inset Flex Code
31715 \begin_layout Plain Layout
31721 This will be the string
31722 \begin_inset Quotes eld
31726 \begin_inset Quotes erd
31729 if the file is in JPEG format, otherwise it will be the string
31730 \begin_inset Quotes eld
31734 \begin_inset Quotes erd
31738 This is useful to avoid uneeded conversions for output formats that support
31739 both PNG and JPEG fomats.
31740 The predefined RasterImage template uses this macro for the pdf\SpecialChar TeX
31745 \begin_layout Description
31746 \begin_inset Flex Code
31749 \begin_layout Plain Layout
31755 The filename of the file specified in the external material dialog.
31756 This is either an absolute name, or it is relative to the \SpecialChar LyX
31760 \begin_layout Description
31761 \begin_inset Flex Code
31764 \begin_layout Plain Layout
31771 \begin_inset Flex Code
31774 \begin_layout Plain Layout
31780 (absolute name or relative to the \SpecialChar LyX
31784 \begin_layout Description
31785 \begin_inset Flex Code
31788 \begin_layout Plain Layout
31794 The file path, relative to the master \SpecialChar LyX
31798 \begin_layout Description
31799 \begin_inset Flex Code
31802 \begin_layout Plain Layout
31808 The file path, relative to the \SpecialChar LyX
31812 \begin_layout Description
31813 \begin_inset Flex Code
31816 \begin_layout Plain Layout
31822 This macro will expand to the absolute path of the system directory.
31823 This is typically used to point to the various helper scripts that are
31824 bundled with \SpecialChar LyX
31828 \begin_layout Description
31829 \begin_inset Flex Code
31832 \begin_layout Plain Layout
31838 A name and full path to a temporary file which will be automatically deleted
31839 whenever the containing document is closed, or the external material insertion
31843 \begin_layout Standard
31844 All path macros contain a trailing directory separator, so you can construct
31846 \begin_inset space \thinspace{}
31850 \begin_inset space \space{}
31853 the absolute filename with
31854 \begin_inset Flex Code
31857 \begin_layout Plain Layout
31858 $$AbsPath$$Basename$$Extension
31866 \begin_layout Standard
31867 The macros above are substituted in all commands unless otherwise noted.
31869 \begin_inset Flex Code
31872 \begin_layout Plain Layout
31878 supports additionally the following substitutions if they are enabled by
31880 \begin_inset Flex Code
31883 \begin_layout Plain Layout
31890 \begin_inset Flex Code
31893 \begin_layout Plain Layout
31902 \begin_layout Description
31903 \begin_inset Flex Code
31906 \begin_layout Plain Layout
31912 The front part of the resize command.
31915 \begin_layout Description
31916 \begin_inset Flex Code
31919 \begin_layout Plain Layout
31925 The back part of the resize command.
31928 \begin_layout Description
31929 \begin_inset Flex Code
31932 \begin_layout Plain Layout
31938 The front part of the rotation command.
31941 \begin_layout Description
31942 \begin_inset Flex Code
31945 \begin_layout Plain Layout
31951 The back part of the rotation command.
31954 \begin_layout Standard
31955 The value string of the
31956 \begin_inset Flex Code
31959 \begin_layout Plain Layout
31965 command supports additionally the following substitutions if they are enabled
31967 \begin_inset Flex Code
31970 \begin_layout Plain Layout
31977 \begin_inset Flex Code
31980 \begin_layout Plain Layout
31989 \begin_layout Description
31990 \begin_inset Flex Code
31993 \begin_layout Plain Layout
32002 \begin_layout Description
32003 \begin_inset Flex Code
32006 \begin_layout Plain Layout
32015 \begin_layout Description
32016 \begin_inset Flex Code
32019 \begin_layout Plain Layout
32028 \begin_layout Description
32029 \begin_inset Flex Code
32032 \begin_layout Plain Layout
32038 The rotation option.
32041 \begin_layout Standard
32042 You may ask why there are so many path macros.
32043 There are mainly two reasons:
32046 \begin_layout Enumerate
32047 Relative and absolute file names should remain relative or absolute, respectivel
32049 Users may have reasons to prefer either form.
32050 Relative names are useful for portable documents that should work on different
32051 machines, for example.
32052 Absolute names may be required by some programs.
32055 \begin_layout Enumerate
32057 treats relative file names differently than \SpecialChar LyX
32058 and other programs in nested
32060 For \SpecialChar LyX
32061 , a relative file name is always relative to the document that contains
32063 For \SpecialChar LaTeX
32064 , it is always relative to the master document.
32065 These two definitions are identical if you have only one document, but
32066 differ if you have a master document that includes part documents.
32067 That means that relative filenames must be transformed when presented to
32070 Fortunately \SpecialChar LyX
32071 does this automatically for you if you choose the right macros.
32074 \begin_layout Standard
32075 So which path macro should be used in new template definitions? The rule
32079 \begin_layout Itemize
32081 \begin_inset Flex Code
32084 \begin_layout Plain Layout
32090 if an absolute path is required.
32093 \begin_layout Itemize
32095 \begin_inset Flex Code
32098 \begin_layout Plain Layout
32099 $$AbsOrRelPathMaster
32104 if the substituted string is some kind of \SpecialChar LaTeX
32108 \begin_layout Itemize
32110 \begin_inset Flex Code
32113 \begin_layout Plain Layout
32114 $$AbsOrRelPathParent
32119 in order to preserve the user's choice.
32122 \begin_layout Standard
32123 There are special cases where this rule does not work and e.
32124 \begin_inset space \thinspace{}
32128 \begin_inset space \space{}
32131 relative names are needed, but normally it will work just fine.
32132 One example for such a case is the command
32133 \begin_inset Flex Code
32136 \begin_layout Plain Layout
32137 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
32142 in the XFig template above: We can't use the absolute name because the
32144 \begin_inset Flex Code
32147 \begin_layout Plain Layout
32153 files needs the relative name in order to rewrite the file content.
32156 \begin_layout Section
32157 Security discussion
32158 \begin_inset CommandInset label
32160 name "sec:Security-discussion"
32167 \begin_layout Standard
32168 The external material feature interfaces with a lot of external programs
32169 and does so automatically, so we have to consider the security implications
32171 In particular, since you have the option of including your own filenames
32172 and/or parameter strings and those are expanded into a command, it seems
32173 that it would be possible to create a malicious document which executes
32174 arbitrary commands when a user views or prints the document.
32175 This is something we definitely want to avoid.
32178 \begin_layout Standard
32179 However, since the external program commands are specified in the template
32180 configuration file only, there are no security issues if \SpecialChar LyX
32181 is properly configure
32182 d with safe templates only.
32183 This is so because the external programs are invoked with the
32184 \begin_inset Flex Code
32187 \begin_layout Plain Layout
32193 -system call rather than the
32194 \begin_inset Flex Code
32197 \begin_layout Plain Layout
32203 system-call, so it's not possible to execute arbitrary commands from the
32204 filename or parameter section via the shell.
32207 \begin_layout Standard
32208 This also implies that you are restricted in what command strings you can
32209 use in the external material templates.
32210 In particular, pipes and redirection are not readily available.
32211 This has to be so if \SpecialChar LyX
32212 should remain safe.
32213 If you want to use some of the shell features, you should write a safe
32214 script to do this in a controlled manner, and then invoke the script from
32215 the command string.
32219 \begin_layout Standard
32220 It is possible to design a template that interacts directly with the shell,
32221 but since this would allow a malicious user to execute arbitrary commands
32222 by writing clever filenames and/or parameters, we generally recommend that
32223 you only use safe scripts that work with the
32224 \begin_inset Flex Code
32227 \begin_layout Plain Layout
32233 system call in a controlled manner.
32234 Of course, for use in a controlled environment, it can be tempting to just
32235 fall back to use ordinary shell scripts.
32236 If you do so, be aware that you
32240 provide an easily exploitable security hole in your system.
32241 Of course it stands to reason that such unsafe templates will never be
32242 included in the standard \SpecialChar LyX
32243 distribution, although we do encourage people
32244 to submit new templates in the open source tradition.
32245 But \SpecialChar LyX
32246 as shipped from the official distribution channels will never have
32250 \begin_layout Standard
32251 Including external material provides a lot of power, and you have to be
32252 careful not to introduce security hazards with this power.
32253 A subtle error in a single line in an innocent looking script can open
32254 the door to huge security problems.
32255 So if you do not fully understand the issues, we recommend that you consult
32256 a knowledgeable security professional or the \SpecialChar LyX
32257 development team if you have
32258 any questions about whether a given template is safe or not.
32259 And do this before you use it in an uncontrolled environment.
32262 \begin_layout Chapter
32264 List of supported \SpecialChar LyX
32265 functions to be used in layouts
32266 \begin_inset CommandInset label
32268 name "chap:List-of-functions"
32275 \begin_layout Standard
32277 \begin_inset Tabular
32278 <lyxtabular version="3" rows="11" columns="8">
32279 <features tabularvalignment="middle">
32280 <column alignment="left" valignment="top">
32281 <column alignment="left" valignment="top">
32282 <column alignment="left" valignment="top">
32283 <column alignment="left" valignment="top">
32284 <column alignment="left" valignment="top">
32285 <column alignment="left" valignment="top">
32286 <column alignment="left" valignment="top">
32287 <column alignment="left" valignment="top">
32289 <cell alignment="left" valignment="top" usebox="none">
32292 \begin_layout Plain Layout
32298 <cell alignment="left" valignment="top" usebox="none">
32301 \begin_layout Plain Layout
32307 <cell alignment="left" valignment="top" usebox="none">
32310 \begin_layout Plain Layout
32316 <cell alignment="left" valignment="top" usebox="none">
32319 \begin_layout Plain Layout
32325 <cell alignment="center" valignment="top" usebox="none">
32328 \begin_layout Plain Layout
32334 <cell alignment="center" valignment="top" usebox="none">
32337 \begin_layout Plain Layout
32343 <cell alignment="center" valignment="top" usebox="none">
32346 \begin_layout Plain Layout
32352 <cell alignment="center" valignment="top" usebox="none">
32355 \begin_layout Plain Layout
32363 <cell alignment="left" valignment="top" usebox="none">
32366 \begin_layout Plain Layout
32372 <cell alignment="left" valignment="top" usebox="none">
32375 \begin_layout Plain Layout
32381 <cell alignment="left" valignment="top" usebox="none">
32384 \begin_layout Plain Layout
32390 <cell alignment="left" valignment="top" usebox="none">
32393 \begin_layout Plain Layout
32399 <cell alignment="center" valignment="top" usebox="none">
32402 \begin_layout Plain Layout
32408 <cell alignment="center" valignment="top" usebox="none">
32411 \begin_layout Plain Layout
32417 <cell alignment="center" valignment="top" usebox="none">
32420 \begin_layout Plain Layout
32426 <cell alignment="center" valignment="top" usebox="none">
32429 \begin_layout Plain Layout
32437 <cell alignment="left" valignment="top" usebox="none">
32440 \begin_layout Plain Layout
32446 <cell alignment="left" valignment="top" usebox="none">
32449 \begin_layout Plain Layout
32455 <cell alignment="left" valignment="top" usebox="none">
32458 \begin_layout Plain Layout
32464 <cell alignment="left" valignment="top" usebox="none">
32467 \begin_layout Plain Layout
32473 <cell alignment="center" valignment="top" usebox="none">
32476 \begin_layout Plain Layout
32482 <cell alignment="center" valignment="top" usebox="none">
32485 \begin_layout Plain Layout
32491 <cell alignment="center" valignment="top" usebox="none">
32494 \begin_layout Plain Layout
32500 <cell alignment="center" valignment="top" usebox="none">
32503 \begin_layout Plain Layout
32511 <cell alignment="left" valignment="top" usebox="none">
32514 \begin_layout Plain Layout
32520 <cell alignment="left" valignment="top" usebox="none">
32523 \begin_layout Plain Layout
32529 <cell alignment="left" valignment="top" usebox="none">
32532 \begin_layout Plain Layout
32538 <cell alignment="left" valignment="top" usebox="none">
32541 \begin_layout Plain Layout
32547 <cell alignment="center" valignment="top" usebox="none">
32550 \begin_layout Plain Layout
32556 <cell alignment="center" valignment="top" usebox="none">
32559 \begin_layout Plain Layout
32565 <cell alignment="center" valignment="top" usebox="none">
32568 \begin_layout Plain Layout
32574 <cell alignment="center" valignment="top" usebox="none">
32577 \begin_layout Plain Layout
32585 <cell alignment="left" valignment="top" usebox="none">
32588 \begin_layout Plain Layout
32594 <cell alignment="left" valignment="top" usebox="none">
32597 \begin_layout Plain Layout
32603 <cell alignment="left" valignment="top" usebox="none">
32606 \begin_layout Plain Layout
32612 <cell alignment="left" valignment="top" usebox="none">
32615 \begin_layout Plain Layout
32621 <cell alignment="center" valignment="top" usebox="none">
32624 \begin_layout Plain Layout
32630 <cell alignment="center" valignment="top" usebox="none">
32633 \begin_layout Plain Layout
32639 <cell alignment="center" valignment="top" usebox="none">
32642 \begin_layout Plain Layout
32648 <cell alignment="center" valignment="top" usebox="none">
32651 \begin_layout Plain Layout
32659 <cell alignment="left" valignment="top" usebox="none">
32662 \begin_layout Plain Layout
32668 <cell alignment="left" valignment="top" usebox="none">
32671 \begin_layout Plain Layout
32677 <cell alignment="left" valignment="top" usebox="none">
32680 \begin_layout Plain Layout
32686 <cell alignment="left" valignment="top" usebox="none">
32689 \begin_layout Plain Layout
32695 <cell alignment="center" valignment="top" usebox="none">
32698 \begin_layout Plain Layout
32704 <cell alignment="center" valignment="top" usebox="none">
32707 \begin_layout Plain Layout
32713 <cell alignment="center" valignment="top" usebox="none">
32716 \begin_layout Plain Layout
32722 <cell alignment="center" valignment="top" usebox="none">
32725 \begin_layout Plain Layout
32733 <cell alignment="left" valignment="top" usebox="none">
32736 \begin_layout Plain Layout
32742 <cell alignment="left" valignment="top" usebox="none">
32745 \begin_layout Plain Layout
32751 <cell alignment="left" valignment="top" usebox="none">
32754 \begin_layout Plain Layout
32760 <cell alignment="left" valignment="top" usebox="none">
32763 \begin_layout Plain Layout
32769 <cell alignment="center" valignment="top" usebox="none">
32772 \begin_layout Plain Layout
32778 <cell alignment="center" valignment="top" usebox="none">
32781 \begin_layout Plain Layout
32787 <cell alignment="center" valignment="top" usebox="none">
32790 \begin_layout Plain Layout
32796 <cell alignment="center" valignment="top" usebox="none">
32799 \begin_layout Plain Layout
32807 <cell alignment="left" valignment="top" usebox="none">
32810 \begin_layout Plain Layout
32816 <cell alignment="left" valignment="top" usebox="none">
32819 \begin_layout Plain Layout
32825 <cell alignment="left" valignment="top" usebox="none">
32828 \begin_layout Plain Layout
32834 <cell alignment="left" valignment="top" usebox="none">
32837 \begin_layout Plain Layout
32843 <cell alignment="center" valignment="top" usebox="none">
32846 \begin_layout Plain Layout
32852 <cell alignment="center" valignment="top" usebox="none">
32855 \begin_layout Plain Layout
32861 <cell alignment="center" valignment="top" usebox="none">
32864 \begin_layout Plain Layout
32870 <cell alignment="center" valignment="top" usebox="none">
32873 \begin_layout Plain Layout
32881 <cell alignment="left" valignment="top" usebox="none">
32884 \begin_layout Plain Layout
32890 <cell alignment="left" valignment="top" usebox="none">
32893 \begin_layout Plain Layout
32899 <cell alignment="left" valignment="top" usebox="none">
32902 \begin_layout Plain Layout
32908 <cell alignment="left" valignment="top" usebox="none">
32911 \begin_layout Plain Layout
32917 <cell alignment="center" valignment="top" usebox="none">
32920 \begin_layout Plain Layout
32926 <cell alignment="center" valignment="top" usebox="none">
32929 \begin_layout Plain Layout
32935 <cell alignment="center" valignment="top" usebox="none">
32938 \begin_layout Plain Layout
32944 <cell alignment="center" valignment="top" usebox="none">
32947 \begin_layout Plain Layout
32955 <cell alignment="left" valignment="top" usebox="none">
32958 \begin_layout Plain Layout
32964 <cell alignment="left" valignment="top" usebox="none">
32967 \begin_layout Plain Layout
32973 <cell alignment="left" valignment="top" usebox="none">
32976 \begin_layout Plain Layout
32982 <cell alignment="left" valignment="top" usebox="none">
32985 \begin_layout Plain Layout
32991 <cell alignment="center" valignment="top" usebox="none">
32994 \begin_layout Plain Layout
33000 <cell alignment="center" valignment="top" usebox="none">
33003 \begin_layout Plain Layout
33009 <cell alignment="center" valignment="top" usebox="none">
33012 \begin_layout Plain Layout
33018 <cell alignment="center" valignment="top" usebox="none">
33021 \begin_layout Plain Layout
33029 <cell alignment="center" valignment="top" usebox="none">
33032 \begin_layout Plain Layout
33038 <cell alignment="center" valignment="top" usebox="none">
33041 \begin_layout Plain Layout
33047 <cell alignment="center" valignment="top" usebox="none">
33050 \begin_layout Plain Layout
33056 <cell alignment="center" valignment="top" usebox="none">
33059 \begin_layout Plain Layout
33065 <cell alignment="center" valignment="top" usebox="none">
33068 \begin_layout Plain Layout
33074 <cell alignment="center" valignment="top" usebox="none">
33077 \begin_layout Plain Layout
33083 <cell alignment="center" valignment="top" usebox="none">
33086 \begin_layout Plain Layout
33092 <cell alignment="center" valignment="top" usebox="none">
33095 \begin_layout Plain Layout
33109 \begin_layout Chapter
33110 Names of available colors to be used in layouts
33111 \begin_inset CommandInset label
33113 name "chap:Names-of-colors"
33120 \begin_layout Standard
33121 The colors listed below are the standard colors and those that you can adjust
33122 in the \SpecialChar LyX
33126 \begin_layout Section
33130 \begin_layout Standard
33131 The following are no real colors, but rather act on color definitions:
33134 \begin_layout Description
33135 ignore The color is ignored
33138 \begin_layout Description
33139 inherit The color is inherited
33142 \begin_layout Description
33155 No particular color – clear or default
33158 \begin_layout Section
33162 \begin_layout Standard
33163 These are fixed colors that cannot be customized
33164 \change_inserted -712698321 1607683177
33170 use these colors in layout definitions, since they will not work well with
33171 some color themes (such as dark themes)
33176 \begin_layout Description
33180 \begin_layout Description
33184 \begin_layout Description
33188 \begin_layout Description
33192 \begin_layout Description
33196 \begin_layout Description
33200 \begin_layout Description
33204 \begin_layout Description
33208 \begin_layout Description
33212 \begin_layout Description
33216 \begin_layout Description
33220 \begin_layout Description
33224 \begin_layout Description
33228 \begin_layout Description
33232 \begin_layout Description
33236 \begin_layout Description
33240 \begin_layout Description
33244 \begin_layout Description
33248 \begin_layout Description
33252 \begin_layout Section
33256 \begin_layout Standard
33257 These are the colors allocated to specific elements in
33260 arg "dialog-show prefs"
33266 \begin_layout Description
33267 added_space Added space color
33270 \begin_layout Description
33271 addedtext Added text color
33274 \begin_layout Description
33275 appendix Appendix marker color
33278 \begin_layout Description
33279 background Background color
33282 \begin_layout Description
33283 bottomarea Bottom area color
33286 \begin_layout Description
33287 branchlabel Label color for branches
33290 \begin_layout Description
33291 buttonbg Color used for button background
33294 \begin_layout Description
33295 buttonframe Color for inset button frames
33298 \begin_layout Description
33299 buttonhoverbg Color used for button background under focus
33302 \begin_layout Description
33303 changebar Changebar color
33306 \begin_layout Description
33307 changedtextauthor1 Changed text color author 1
33310 \begin_layout Description
33311 changedtextauthor2 Changed text color author 2
33314 \begin_layout Description
33315 changedtextauthor3 Changed text color author 3
33318 \begin_layout Description
33319 changedtextauthor4 Changed text color author 4
33322 \begin_layout Description
33323 changedtextauthor5 Changed text color author 5
33326 \begin_layout Description
33327 collapsible Collapsible insets text color
33330 \begin_layout Description
33331 collapsibleframe Collapsible insets framecolor
33334 \begin_layout Description
33335 command Text color for command insets
33338 \begin_layout Description
33339 commandbg Background color for command insets
33342 \begin_layout Description
33343 commandframe Frame color for command insets
33346 \begin_layout Description
33347 comment Label color for comments
33350 \begin_layout Description
33351 commentbg Background color of comments
33354 \begin_layout Description
33355 cursor Cursor color
33358 \begin_layout Description
33359 deletedtext Deleted text color
33362 \begin_layout Description
33363 deletedtextmodifier Deleted text modifying color
33366 \begin_layout Description
33367 depthbar Color for the depth bars in the margin
33370 \begin_layout Description
33371 eolmarker End of line marker color
33374 \begin_layout Description
33375 error Color of the \SpecialChar LaTeX
33379 \begin_layout Description
33380 footlabel Label color for footnotes
33383 \begin_layout Description
33384 foreground Foreground color
33387 \begin_layout Description
33388 graphicsbg Graphics inset background color
33391 \begin_layout Description
33392 greyedoutbg Background color of greyedout inset
33395 \begin_layout Description
33396 greyedoutlabel Label color for greyedout insets
33399 \begin_layout Description
33400 greyedouttext Color for greyedout inset text
33403 \begin_layout Description
33404 indexlabel Label color for index insets
33407 \begin_layout Description
33408 inlinecompletion Inline completion color
33411 \begin_layout Description
33412 insetbg Inset marker background color
33415 \begin_layout Description
33416 insetframe Inset marker frame color
33419 \begin_layout Description
33420 language Color for marking foreign language words
33423 \begin_layout Description
33424 latex Text color in \SpecialChar LaTeX
33428 \begin_layout Description
33429 listingsbg Background color of listings inset
33432 \begin_layout Description
33433 marginlabel Label color for margin notes
33436 \begin_layout Description
33437 math Math inset text color
33440 \begin_layout Description
33441 mathbg Math inset background color
33444 \begin_layout Description
33445 mathcorners Math inset frame color not under focus
33448 \begin_layout Description
33449 mathframe Math inset frame color under focus
33452 \begin_layout Description
33453 mathline Math line color
33456 \begin_layout Description
33457 mathmacrobg Macro math inset background color
33460 \begin_layout Description
33461 mathmacroblend Macro math blended color
33464 \begin_layout Description
33465 mathmacroframe Macro math frame color
33468 \begin_layout Description
33469 mathmacrohoverbg Macro math inset background color hovered
33472 \begin_layout Description
33473 mathmacrolabel Macro math label color
33476 \begin_layout Description
33477 mathmacronewarg Macro template color for new parameters
33480 \begin_layout Description
33481 mathmacrooldarg Macro template color for old parameters
33484 \begin_layout Description
33485 newpage New page color
33488 \begin_layout Description
33489 nonunique_inlinecompletion Inline completion color for the non-unique part
33492 \begin_layout Description
33493 note Label color for notes
33496 \begin_layout Description
33497 notebg Background color of notes
33500 \begin_layout Description
33501 pagebreak Page break/line break color
33504 \begin_layout Description
33505 paragraphmarker Color used for the pilcrow sign to mark the end of a paragraph
33508 \begin_layout Description
33509 phantomtext Text color for phantom insets
33512 \begin_layout Description
33513 preview The color used for previews
33516 \begin_layout Description
33517 previewframe Preview frame color
33520 \begin_layout Description
33521 regexpframe Color for regexp frame
33524 \begin_layout Description
33525 scroll Color that indicates when a row can be scrolled
33528 \begin_layout Description
33529 selection Background color of selected text
33532 \begin_layout Description
33533 selectiontext Foreground color of selected text
33536 \begin_layout Description
33537 shadedbg Background color of shaded box
33540 \begin_layout Description
33541 special Special chars text color
33544 \begin_layout Description
33545 tabularline Table line color
33548 \begin_layout Description
33549 tabularonoffline Table line color
33550 \change_inserted -712698321 1607682522
33554 \begin_layout Description
33556 \change_inserted -712698321 1607682563
33557 textlabel1 Color 1 of layout and custom inset labels
33560 \begin_layout Description
33562 \change_inserted -712698321 1607682565
33563 textlabel2 Color 2 of layout and custom inset labels
33566 \begin_layout Description
33568 \change_inserted -712698321 1607682568
33569 textlabel3 Color 3 of layout and custom inset labels
33574 \begin_layout Description
33575 urllabel Label color for URL insets
33578 \begin_layout Description
33579 urltext Color for URL inset text