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
10397 \begin_inset Flex Code
10400 \begin_layout Plain Layout
10402 \change_inserted -712698321 1611646804
10408 ] is a variant of the
10409 \begin_inset Flex Code
10412 \begin_layout Plain Layout
10414 \change_inserted -712698321 1611646804
10420 command which does not look for files in the user directory.
10421 This allows to create a file
10422 \begin_inset Flex Code
10425 \begin_layout Plain Layout
10427 \change_inserted -712698321 1611646804
10434 \begin_inset Flex Code
10437 \begin_layout Plain Layout
10439 \change_inserted -712698321 1611646804
10445 in the user directory which includes a global file with the same name via
10447 \begin_inset Flex Code
10450 \begin_layout Plain Layout
10452 \change_inserted -712698321 1611646853
10459 \begin_inset Flex Code
10462 \begin_layout Plain Layout
10464 \change_inserted -712698321 1611646855
10465 InputGlobal name.inc
10470 , respectively (with
10471 \begin_inset Flex Code
10474 \begin_layout Plain Layout
10476 \change_inserted -712698321 1611646804
10482 , the file would recursively include itself).
10483 This way, you can modify global files without having to completely copy
10489 \begin_layout Description
10490 \begin_inset Flex Code
10493 \begin_layout Plain Layout
10500 \begin_inset Flex Code
10503 \begin_layout Plain Layout
10509 ] This section (re-)defines the layout of an inset.
10510 It can be applied to an existing inset or to a new, user-defined inset,
10511 e.g., a new character style.
10513 \begin_inset Quotes eld
10517 \begin_inset Flex Code
10520 \begin_layout Plain Layout
10527 \begin_inset Quotes erd
10531 \begin_inset Newline newline
10535 \begin_inset CommandInset ref
10537 reference "subsec:Flex-insets-and"
10541 for more information.
10545 \begin_layout Description
10546 \begin_inset Flex Code
10549 \begin_layout Plain Layout
10556 \begin_inset Flex Code
10559 \begin_layout Plain Layout
10565 ] A string that indicates the width of the left margin on the screen, for
10567 \begin_inset Quotes eld
10571 \begin_inset Flex Code
10574 \begin_layout Plain Layout
10581 \begin_inset Quotes erd
10585 (Note that this is not a `length', like
10586 \begin_inset Quotes eld
10590 \begin_inset Quotes erd
10596 \begin_layout Description
10597 \begin_inset Flex Code
10600 \begin_layout Plain Layout
10607 \begin_inset Flex Code
10610 \begin_layout Plain Layout
10616 ] An integer that determines the maximal number of names displayed in an
10617 author-year citation before the citation switches to
10618 \begin_inset Quotes eld
10622 \begin_inset Quotes erd
10626 Primarily used in cite engine files (see
10627 \begin_inset CommandInset ref
10629 reference "subsec:Cite-Engine-Files"
10639 \begin_layout Description
10640 \begin_inset Flex Code
10643 \begin_layout Plain Layout
10650 \begin_inset Flex Code
10653 \begin_layout Plain Layout
10659 ] Modifies the properties of the given paragraph style.
10660 If the style does not exist, this section is ignored.
10662 \begin_inset Quotes eld
10666 \begin_inset Flex Code
10669 \begin_layout Plain Layout
10676 \begin_inset Quotes erd
10682 \begin_layout Description
10683 \begin_inset Flex Code
10686 \begin_layout Plain Layout
10693 \begin_inset Flex Code
10696 \begin_layout Plain Layout
10702 ] Deletes an existing counter, usually one defined in an included file.
10705 \begin_layout Description
10706 \begin_inset Flex Code
10709 \begin_layout Plain Layout
10716 \begin_inset Flex Code
10719 \begin_layout Plain Layout
10725 ] Deletes an existing float.
10726 This is particularly useful when you want to suppress a float that has
10727 been defined in an input file.
10730 \begin_layout Description
10731 \begin_inset Flex Code
10734 \begin_layout Plain Layout
10741 \begin_inset Flex Code
10744 \begin_layout Plain Layout
10750 ] Deletes an existing style.
10753 \begin_layout Description
10754 \begin_inset Flex Code
10757 \begin_layout Plain Layout
10764 \begin_inset Flex Code
10767 \begin_layout Plain Layout
10774 \begin_inset Flex Code
10777 \begin_layout Plain Layout
10783 ] Define a new table of contents with type
10784 \begin_inset Flex Code
10787 \begin_layout Plain Layout
10794 \begin_inset Flex Code
10797 \begin_layout Plain Layout
10804 See also the AddToToc commands.
10807 \begin_layout Description
10808 \begin_inset Flex Code
10811 \begin_layout Plain Layout
10818 \begin_inset Flex Code
10821 \begin_layout Plain Layout
10827 ] The file format (as defined in the \SpecialChar LyX
10828 preferences) produced by this document
10830 It is mainly useful when
10831 \begin_inset Flex Code
10834 \begin_layout Plain Layout
10841 \begin_inset Flex Code
10844 \begin_layout Plain Layout
10850 and one wants to define a new type of literate document.
10851 The format is reset to
10852 \change_deleted 5863208 1594239413
10854 \begin_inset Quotes eld
10858 \begin_inset Flex Code
10861 \begin_layout Plain Layout
10868 \begin_inset Quotes erd
10874 \begin_inset Quotes eld
10878 \begin_inset Flex Code
10881 \begin_layout Plain Layout
10888 \begin_inset Quotes erd
10891 when the corresponding
10892 \begin_inset Flex Code
10895 \begin_layout Plain Layout
10901 parameter is encountered.
10904 \begin_layout Description
10905 \begin_inset Flex Code
10908 \begin_layout Plain Layout
10915 \begin_inset Flex Code
10918 \begin_layout Plain Layout
10929 \change_deleted 5863208 1594239430
10931 \begin_inset Flex Code
10934 \begin_layout Plain Layout
10943 \begin_inset Flex Code
10946 \begin_layout Plain Layout
10952 ] Specifies what sort of output documents using this class will produce.
10955 \begin_layout Description
10956 \begin_inset Flex Code
10959 \begin_layout Plain Layout
10966 \begin_inset Flex Code
10969 \begin_layout Plain Layout
10976 \begin_inset Flex Code
10979 \begin_layout Plain Layout
10985 ] Specifies options, given in the second string, for the package named by
10988 \begin_inset Quotes eld
10992 \begin_inset Flex Code
10995 \begin_layout Plain Layout
10996 PackageOptions natbib square
11002 \begin_inset Quotes erd
11006 \begin_inset Flex Code
11009 \begin_layout Plain Layout
11015 to be loaded with the
11016 \begin_inset Flex Code
11019 \begin_layout Plain Layout
11026 (For \SpecialChar TeX
11027 perts, this causes \SpecialChar LyX
11029 \begin_inset Flex Code
11032 \begin_layout Plain Layout
11035 PassOptionsToPackage{natbib}{square}
11041 \begin_inset Flex Code
11044 \begin_layout Plain Layout
11051 \change_inserted -712698321 1565102364
11055 \begin_layout Description
11057 \change_inserted -712698321 1565102470
11058 \begin_inset Flex Code
11061 \begin_layout Plain Layout
11063 \change_inserted -712698321 1565102365
11072 \begin_inset Flex Code
11075 \begin_layout Plain Layout
11077 \change_inserted -712698321 1565105222
11082 , letter, legal, executive, a0, a1, a2, a3, a4, a5, a6, b0, b1, b2, b3,
11083 b4, b5, b6, c0, c1, c2, c3, c4, c5, c6, b0j, b1j, b2j, b3j, b4j, b5j, b6j
11090 ] The default page size.
11091 This is used by some converters.
11096 \begin_layout Description
11097 \begin_inset Flex Code
11100 \begin_layout Plain Layout
11107 \begin_inset Flex Code
11110 \begin_layout Plain Layout
11119 \begin_inset Flex Code
11122 \begin_layout Plain Layout
11129 \begin_inset Flex Code
11132 \begin_layout Plain Layout
11138 ] The default pagestyle.
11139 Can be changed in the
11140 \begin_inset Flex Noun
11143 \begin_layout Plain Layout
11144 Document\SpecialChar menuseparator
11153 \begin_layout Description
11154 \begin_inset Flex Code
11157 \begin_layout Plain Layout
11163 Sets the preamble for the \SpecialChar LaTeX
11165 Note that this will completely override any prior
11166 \begin_inset Flex Code
11169 \begin_layout Plain Layout
11176 \begin_inset Flex Code
11179 \begin_layout Plain Layout
11187 \begin_inset Flex Code
11190 \begin_layout Plain Layout
11196 if you just want to add material to the preamble.) Must end with
11197 \begin_inset Quotes eld
11201 \begin_inset Flex Code
11204 \begin_layout Plain Layout
11211 \begin_inset Quotes erd
11217 \begin_layout Description
11218 \begin_inset Flex Code
11221 \begin_layout Plain Layout
11228 \begin_inset Flex Code
11231 \begin_layout Plain Layout
11238 \begin_inset Flex Code
11241 \begin_layout Plain Layout
11250 \begin_inset space \thinspace{}
11254 \begin_inset Flex Code
11257 \begin_layout Plain Layout
11263 ] Whether the class already provides the feature
11264 \begin_inset Flex Code
11267 \begin_layout Plain Layout
11274 A feature is in general the name of a package (e.
11275 \begin_inset space \thinspace{}
11279 \begin_inset space \space{}
11283 \begin_inset Flex Code
11286 \begin_layout Plain Layout
11293 \begin_inset Flex Code
11296 \begin_layout Plain Layout
11303 \begin_inset space \thinspace{}
11307 \begin_inset space \space{}
11311 \begin_inset Flex Code
11314 \begin_layout Plain Layout
11321 \begin_inset Flex Code
11324 \begin_layout Plain Layout
11332 \begin_inset CommandInset ref
11334 reference "chap:List-of-functions"
11338 for the list of features.
11341 \begin_layout Description
11342 \begin_inset Flex Code
11345 \begin_layout Plain Layout
11352 \begin_inset Flex Code
11355 \begin_layout Plain Layout
11361 ] Indicates that this layout provides the functionality of the module mentioned,
11362 which should be specified by the filename without the
11363 \begin_inset Flex Code
11366 \begin_layout Plain Layout
11373 This will typically be used if the layout includes the module directly,
11374 rather than using the
11375 \begin_inset Flex Code
11378 \begin_layout Plain Layout
11384 tag to indicate that it ought to be used.
11385 It could also be used in a module that provided an alternate implementation
11386 of the same functionality.
11389 \begin_layout Description
11390 \begin_inset Flex Code
11393 \begin_layout Plain Layout
11400 \begin_inset Flex Code
11403 \begin_layout Plain Layout
11409 ] Creates a new paragraph style if it does not already exist.
11410 If the style does exist, this section is ignored.
11412 \begin_inset Quotes eld
11416 \begin_inset Flex Code
11419 \begin_layout Plain Layout
11426 \begin_inset Quotes erd
11432 \begin_layout Description
11433 \begin_inset Flex Code
11436 \begin_layout Plain Layout
11443 \begin_inset Flex Code
11446 \begin_layout Plain Layout
11452 ] Whether the class requires the feature
11453 \begin_inset Flex Code
11456 \begin_layout Plain Layout
11463 Multiple features must be separated by commas.
11464 Note that you can only request supported features.
11466 \begin_inset CommandInset ref
11468 reference "chap:List-of-functions"
11472 for the list of features.).
11473 If you require a package with specific options, you can additionally use
11475 \begin_inset Flex Code
11478 \begin_layout Plain Layout
11487 \begin_layout Description
11488 \begin_inset Flex Code
11491 \begin_layout Plain Layout
11498 \begin_inset Flex Code
11501 \begin_layout Plain Layout
11507 ] A string that indicates the width of the right margin on the screen, for
11509 \begin_inset Quotes eld
11513 \begin_inset Flex Code
11516 \begin_layout Plain Layout
11523 \begin_inset Quotes erd
11529 \begin_layout Description
11530 \begin_inset Flex Code
11533 \begin_layout Plain Layout
11540 \begin_inset Flex Code
11543 \begin_layout Plain Layout
11549 ] Sets which divisions get numbered.
11551 \begin_inset Newline newline
11555 \begin_inset Flex Code
11558 \begin_layout Plain Layout
11564 counter in \SpecialChar LaTeX
11568 \begin_layout Description
11569 \begin_inset Flex Code
11572 \begin_layout Plain Layout
11579 \begin_inset Flex Code
11582 \begin_layout Plain Layout
11591 \begin_inset space \thinspace{}
11595 \begin_inset Flex Code
11598 \begin_layout Plain Layout
11604 ] Whether the class-default should be printing on one or both sides of the
11606 Can be changed in the
11607 \begin_inset Flex Noun
11610 \begin_layout Plain Layout
11611 Document\SpecialChar menuseparator
11620 \begin_layout Description
11621 \begin_inset Flex Code
11624 \begin_layout Plain Layout
11631 \begin_inset Flex Code
11634 \begin_layout Plain Layout
11640 ] This sequence defines a paragraph style.
11641 If the style does not yet exist, it is created; if it does exist, its parameter
11644 \begin_inset Quotes eld
11648 \begin_inset Flex Code
11651 \begin_layout Plain Layout
11658 \begin_inset Quotes erd
11662 \begin_inset Newline newline
11666 \begin_inset CommandInset ref
11668 reference "subsec:Paragraph-Styles"
11672 for details on paragraph styles.
11673 \change_inserted -712698321 1553617804
11677 \begin_layout Description
11679 \change_inserted -712698321 1553617862
11680 \begin_inset Flex Code
11683 \begin_layout Plain Layout
11685 \change_inserted -712698321 1553617809
11694 \begin_inset Flex Code
11697 \begin_layout Plain Layout
11699 \change_inserted -712698321 1553617805
11707 ] defines the default table style that is used when inserting a table.
11708 The following styles are available:
11712 \begin_layout Itemize
11714 \change_inserted -712698321 1554308039
11715 \begin_inset Flex Code
11718 \begin_layout Plain Layout
11720 \change_inserted -712698321 1554307928
11721 Formal_with_Footline
11729 \begin_inset Quotes eld
11733 \begin_inset Quotes erd
11736 ) style with horizontal lines only, using a bold top and bottom line, the
11737 first and last row are additionally separated from the table body with
11738 a thin middle line.
11741 \begin_layout Itemize
11743 \change_inserted -712698321 1554308087
11744 \begin_inset Flex Code
11747 \begin_layout Plain Layout
11749 \change_inserted -712698321 1554308042
11750 Formal_without_Footline
11757 : same as the above, but the last row is not separated with a middle line
11761 \begin_layout Itemize
11763 \change_inserted -712698321 1553618031
11764 \begin_inset Flex Code
11767 \begin_layout Plain Layout
11769 \change_inserted -712698321 1553618006
11777 : Simple table lines.
11780 \begin_layout Itemize
11782 \change_inserted -712698321 1553618309
11783 \begin_inset Flex Code
11786 \begin_layout Plain Layout
11788 \change_inserted -712698321 1553618031
11797 \begin_inset Flex Code
11800 \begin_layout Plain Layout
11802 \change_inserted -712698321 1553618043
11810 , but with the header column offset with a second horizontal line.
11811 This is also the default style of \SpecialChar LyX
11815 \begin_layout Itemize
11817 \change_inserted -712698321 1553618280
11818 \begin_inset Flex Code
11821 \begin_layout Plain Layout
11823 \change_inserted -712698321 1553618261
11831 : Table without lines.
11837 \begin_layout Description
11838 \begin_inset Flex Code
11841 \begin_layout Plain Layout
11848 \begin_inset Flex Code
11851 \begin_layout Plain Layout
11857 ] The name of the command or environment to be used with
11858 \begin_inset Flex Code
11861 \begin_layout Plain Layout
11870 \begin_layout Description
11871 \begin_inset Flex Code
11874 \begin_layout Plain Layout
11881 \begin_inset Flex Code
11884 \begin_layout Plain Layout
11893 \begin_inset Flex Code
11896 \begin_layout Plain Layout
11902 ] Indicates what kind of markup is used to define the title of a document.
11904 \begin_inset Flex Code
11907 \begin_layout Plain Layout
11913 means that the macro with name
11914 \begin_inset Flex Code
11917 \begin_layout Plain Layout
11923 will be inserted after the last layout which has
11924 \begin_inset Quotes eld
11928 \begin_inset Flex Code
11931 \begin_layout Plain Layout
11933 \begin_inset space ~
11942 \begin_inset Quotes erd
11947 \begin_inset Flex Code
11950 \begin_layout Plain Layout
11956 corresponds to the case where all layouts which have
11957 \begin_inset Quotes eld
11961 \begin_inset Flex Code
11964 \begin_layout Plain Layout
11966 \begin_inset space ~
11975 \begin_inset Quotes erd
11978 should be enclosed into the
11979 \begin_inset Flex Code
11982 \begin_layout Plain Layout
11991 \begin_layout Description
11992 \begin_inset Flex Code
11995 \begin_layout Plain Layout
12002 \begin_inset Flex Code
12005 \begin_layout Plain Layout
12011 ] Sets which divisions are included in the table of contents.
12013 \begin_inset Flex Code
12016 \begin_layout Plain Layout
12022 counter in \SpecialChar LaTeX
12026 \begin_layout Subsection
12027 \begin_inset Flex Code
12030 \begin_layout Plain Layout
12037 \begin_inset CommandInset label
12039 name "subsec:ClassOptions"
12046 \begin_layout Standard
12048 \begin_inset Flex Code
12051 \begin_layout Plain Layout
12057 section can contain the following entries:
12060 \begin_layout Description
12061 \begin_inset Flex Code
12064 \begin_layout Plain Layout
12071 \begin_inset Flex Code
12074 \begin_layout Plain Layout
12080 ] The list of available font sizes for the document's main font, separated
12082 \begin_inset Quotes eld
12086 \begin_inset Flex Code
12089 \begin_layout Plain Layout
12096 \begin_inset Quotes erd
12101 \change_inserted -712698321 1565110196
12102 Any number is possible.
12105 \begin_layout Description
12107 \change_inserted -712698321 1565110259
12108 \begin_inset Flex Code
12111 \begin_layout Plain Layout
12113 \change_inserted -712698321 1565110199
12122 \begin_inset Flex Code
12125 \begin_layout Plain Layout
12127 \change_inserted -712698321 1565110196
12135 ] The format for the font size option.
12137 \begin_inset Flex Code
12140 \begin_layout Plain Layout
12142 \change_inserted -712698321 1565110238
12152 \begin_inset Flex Code
12155 \begin_layout Plain Layout
12157 \change_inserted -712698321 1565110248
12165 is a placeholder for the font size.
12170 \begin_layout Description
12172 \change_deleted 5863208 1594239483
12173 \begin_inset Flex Code
12176 \begin_layout Plain Layout
12182 Used to set the DTD line with XML-based output classes.
12184 \begin_inset space \thinspace{}
12188 \begin_inset Quotes eld
12191 -//OASIS//DTD DocBook V4.2//EN
12192 \begin_inset Quotes erd
12196 \change_inserted -712698321 1565101761
12200 \begin_layout Description
12202 \change_inserted -712698321 1565180598
12203 \begin_inset Flex Code
12206 \begin_layout Plain Layout
12208 \change_inserted -712698321 1565101918
12217 \begin_inset Flex Code
12220 \begin_layout Plain Layout
12222 \change_inserted -712698321 1565105399
12223 string="letter|\SpecialChar allowbreak
12224 legal|\SpecialChar allowbreak
12225 executive|\SpecialChar allowbreak
12226 a0|\SpecialChar allowbreak
12227 a1|\SpecialChar allowbreak
12228 a2|\SpecialChar allowbreak
12229 a3|\SpecialChar allowbreak
12230 a4|\SpecialChar allowbreak
12231 a5|\SpecialChar allowbreak
12232 a6|\SpecialChar allowbreak
12233 b0|\SpecialChar allowbreak
12234 b1|\SpecialChar allowbreak
12235 b2|\SpecialChar allowbreak
12236 b3|\SpecialChar allowbreak
12237 b4|\SpecialChar allowbreak
12238 b5|\SpecialChar allowbreak
12239 b6|\SpecialChar allowbreak
12240 c0|\SpecialChar allowbreak
12241 c1|\SpecialChar allowbreak
12243 2|\SpecialChar allowbreak
12244 c3|\SpecialChar allowbreak
12245 c4|\SpecialChar allowbreak
12246 c5|\SpecialChar allowbreak
12247 c6|\SpecialChar allowbreak
12248 b0j|\SpecialChar allowbreak
12249 b1j|\SpecialChar allowbreak
12250 b2j|\SpecialChar allowbreak
12251 b3j|\SpecialChar allowbreak
12252 b4j|\SpecialChar allowbreak
12253 b5j|\SpecialChar allowbreak
12261 ] The list of available page sizes, separated by
12262 \begin_inset Quotes eld
12266 \begin_inset Flex Code
12269 \begin_layout Plain Layout
12271 \change_inserted -712698321 1565101779
12280 \begin_inset Quotes erd
12284 Currently, only the listed sizes are supported.
12285 Other sizes might be entered as custom class option.
12288 \begin_layout Description
12290 \change_inserted -712698321 1565180623
12291 \begin_inset Flex Code
12294 \begin_layout Plain Layout
12296 \change_inserted -712698321 1565180605
12305 \begin_inset Flex Code
12308 \begin_layout Plain Layout
12310 \change_inserted -712698321 1565180601
12318 ] The format for the page size option.
12320 \begin_inset Flex Code
12323 \begin_layout Plain Layout
12325 \change_inserted -712698321 1565180618
12335 \begin_inset Flex Code
12338 \begin_layout Plain Layout
12340 \change_inserted -712698321 1565180601
12348 is a placeholder for the paper size.
12353 \begin_layout Description
12354 \begin_inset Flex Code
12357 \begin_layout Plain Layout
12364 \begin_inset Flex Code
12367 \begin_layout Plain Layout
12368 string="empty|plain|headings|fancy"
12373 ] The list of available page sty\SpecialChar softhyphen
12375 \begin_inset Quotes eld
12379 \begin_inset Flex Code
12382 \begin_layout Plain Layout
12389 \begin_inset Quotes erd
12395 \begin_layout Description
12396 \begin_inset Flex Code
12399 \begin_layout Plain Layout
12406 \begin_inset Flex Code
12409 \begin_layout Plain Layout
12415 ] Some document class options, separated by a comma, that will be added
12416 to the optional part of the
12417 \begin_inset Flex Code
12420 \begin_layout Plain Layout
12431 \begin_layout Standard
12433 \begin_inset Flex Code
12436 \begin_layout Plain Layout
12442 section must end with
12443 \begin_inset Quotes eld
12447 \begin_inset Flex Code
12450 \begin_layout Plain Layout
12457 \begin_inset Quotes erd
12463 \begin_layout Subsection
12465 \begin_inset CommandInset label
12467 name "subsec:Paragraph-Styles"
12474 \begin_layout Standard
12475 A paragraph style description looks like this:
12479 \begin_layout Plain Layout
12480 Note that this will either define a new style or modify an existing one.
12488 \begin_layout LyX-Code
12495 \begin_layout LyX-Code
12499 \begin_layout LyX-Code
12503 \begin_layout Standard
12504 where the following commands are allowed:
12507 \begin_layout Description
12508 \begin_inset Flex Code
12511 \begin_layout Plain Layout
12518 \begin_inset Flex Code
12521 \begin_layout Plain Layout
12527 =""] This paragraph will appear in the table of contents of the given type.
12528 An empty string disables.
12529 See also the OutlinerName and the IsTocCaption commands.
12533 \begin_layout Description
12534 \begin_inset Flex Code
12537 \begin_layout Plain Layout
12544 \begin_inset Flex Code
12547 \begin_layout Plain Layout
12552 , left, right, center
12557 ] Paragraph alignment.
12560 \begin_layout Description
12561 \begin_inset Flex Code
12564 \begin_layout Plain Layout
12571 \begin_inset Flex Code
12574 \begin_layout Plain Layout
12579 , left, right, center
12584 ] A comma separated list of permitted alignments.
12585 (Some \SpecialChar LaTeX
12586 styles prohibit certain alignments, since those wouldn't make sense.
12587 For example a right-aligned or centered enumeration isn't possible.)
12590 \begin_layout Description
12591 \begin_inset Flex Code
12594 \begin_layout Plain Layout
12601 \begin_inset Flex Code
12604 \begin_layout Plain Layout
12610 ] Defines argument number <int> of a command\SpecialChar breakableslash
12611 environment associated with
12613 This is useful for things like section headings, and only makes sense with
12616 Every (optional or required) argument of a command or environment – except
12617 for the required argument that is associated with the content of the paragraph
12618 itself – has a separate definition, where the number specifies the order
12620 The definition must end with
12621 \begin_inset Flex Code
12624 \begin_layout Plain Layout
12631 So a command with two optional arguments has:
12635 \begin_layout Quote
12641 \begin_layout Quote
12647 \begin_layout Quote
12653 \begin_layout Quote
12659 \begin_layout Quote
12665 \begin_layout Quote
12671 \begin_layout Standard
12673 \begin_inset Flex Code
12676 \begin_layout Plain Layout
12682 definition, the following specifications are possible:
12685 \begin_layout Itemize
12686 \begin_inset Flex Code
12689 \begin_layout Plain Layout
12696 \begin_inset Flex Code
12699 \begin_layout Plain Layout
12705 The string that will appear both in the menu (to insert this argument)
12706 and on the argument inset button (unless you also specify a separate
12707 \begin_inset Flex Code
12710 \begin_layout Plain Layout
12717 For the menu, you can define an accelerator by appending the respective
12718 character to the string, divided by
12719 \begin_inset Quotes eld
12723 \begin_inset Quotes erd
12727 \begin_inset space \thinspace{}
12731 \begin_inset space \space{}
12735 \begin_inset Quotes eld
12739 \begin_inset Flex Code
12742 \begin_layout Plain Layout
12749 \begin_inset Quotes erd
12755 \begin_layout Itemize
12756 \begin_inset Flex Code
12759 \begin_layout Plain Layout
12766 \begin_inset Flex Code
12769 \begin_layout Plain Layout
12775 A separate string for the menu.
12776 You can define an accelerator by appending the respective character to
12777 the string, divided by
12778 \begin_inset Quotes eld
12782 \begin_inset Quotes erd
12786 \begin_inset space \thinspace{}
12790 \begin_inset space \space{}
12794 \begin_inset Quotes eld
12798 \begin_inset Flex Code
12801 \begin_layout Plain Layout
12808 \begin_inset Quotes erd
12812 This specification is optional.
12813 If it is not given the
12814 \begin_inset Flex Code
12817 \begin_layout Plain Layout
12823 will be used instead for the menu.
12826 \begin_layout Itemize
12827 \begin_inset Flex Code
12830 \begin_layout Plain Layout
12837 \begin_inset Flex Code
12840 \begin_layout Plain Layout
12846 A longer explanatory text that appears in the tooltip when hovering over
12847 the argument inset.
12850 \begin_layout Itemize
12851 \begin_inset Flex Code
12854 \begin_layout Plain Layout
12861 \begin_inset Flex Code
12864 \begin_layout Plain Layout
12873 \begin_inset space \thinspace{}
12877 \begin_inset Flex Code
12880 \begin_layout Plain Layout
12886 ] Declare if this is a mandatory (1) or an optional (0) argument.
12887 Mandatory arguments will be output empty if not given, while optional arguments
12888 will not be output at all.
12889 By default, mandatory arguments are delimited by
12890 \begin_inset Flex Code
12893 \begin_layout Plain Layout
12899 , while optional arguments are delimited by
12900 \begin_inset Flex Code
12903 \begin_layout Plain Layout
12910 \change_inserted -712698321 1555579782
12914 \begin_layout Itemize
12916 \change_inserted -712698321 1555579780
12917 \begin_inset Flex Code
12920 \begin_layout Plain Layout
12922 \change_inserted -712698321 1555579780
12931 \begin_inset Flex Code
12934 \begin_layout Plain Layout
12936 \change_inserted -712698321 1555579780
12944 Option to define a different command (from the default
12945 \begin_inset Flex Code
12948 \begin_layout Plain Layout
12950 \change_inserted -712698321 1555579780
12962 ) to be used for line breaks.
12963 The initial backslash must not be specified.
12968 \begin_layout Itemize
12969 \begin_inset Flex Code
12972 \begin_layout Plain Layout
12979 \begin_inset Flex Code
12982 \begin_layout Plain Layout
12988 defines another argument (by its number) which this argument requires to
12989 be output if it is itself output.
12991 \begin_inset space \thinspace{}
12994 g., in \SpecialChar LaTeX
12995 commands, optional arguments often require previous optional arguments
12996 to be output (at least empty), as in
12997 \begin_inset Flex Code
13000 \begin_layout Plain Layout
13003 command[][argument]{text}
13009 This can be achieved by the statement
13010 \begin_inset Flex Code
13013 \begin_layout Plain Layout
13020 \begin_inset Flex Code
13023 \begin_layout Plain Layout
13032 \begin_layout Itemize
13033 \begin_inset Flex Code
13036 \begin_layout Plain Layout
13043 \begin_inset Flex Code
13046 \begin_layout Plain Layout
13052 defines a custom left delimiter (instead of
13053 \begin_inset Flex Code
13056 \begin_layout Plain Layout
13063 \begin_inset Flex Code
13066 \begin_layout Plain Layout
13073 A line break in the output can be indicated by
13074 \begin_inset Flex Code
13077 \begin_layout Plain Layout
13086 \begin_layout Itemize
13087 \begin_inset Flex Code
13090 \begin_layout Plain Layout
13097 \begin_inset Flex Code
13100 \begin_layout Plain Layout
13106 defines a custom right delimiter (instead of
13107 \begin_inset Flex Code
13110 \begin_layout Plain Layout
13117 \begin_inset Flex Code
13120 \begin_layout Plain Layout
13127 A line break in the output can be indicated by
13128 \begin_inset Flex Code
13131 \begin_layout Plain Layout
13140 \begin_layout Itemize
13141 \begin_inset Flex Code
13144 \begin_layout Plain Layout
13151 \begin_inset Flex Code
13154 \begin_layout Plain Layout
13160 defines an argument that is inserted if and only if no user-specified arguments
13162 \begin_inset space \thinspace{}
13166 \begin_inset space \space{}
13169 if no argument inset has been inserted (note that also an empty argument
13170 inset omits the DefaultArg).
13171 Multiple arguments need to be separated by comma.
13174 \begin_layout Itemize
13175 \begin_inset Flex Code
13178 \begin_layout Plain Layout
13185 \begin_inset Flex Code
13188 \begin_layout Plain Layout
13194 defines an argument that is inserted in any case (alone or in addition
13195 to user-specified arguments).
13196 Multiple arguments need to be separated by comma.
13199 \begin_layout Itemize
13200 \begin_inset Flex Code
13203 \begin_layout Plain Layout
13209 The font used for the argument content, see
13210 \begin_inset CommandInset ref
13212 reference "subsec:Font-description"
13217 \change_inserted -712698321 1559484228
13221 \begin_layout Itemize
13223 \change_inserted -712698321 1559484228
13224 \begin_inset Flex Code
13227 \begin_layout Plain Layout
13229 \change_inserted -712698321 1559484228
13238 \begin_inset Flex Code
13241 \begin_layout Plain Layout
13243 \change_inserted -712698321 1559484228
13254 \begin_inset space \thinspace{}
13258 \begin_inset Flex Code
13261 \begin_layout Plain Layout
13263 \change_inserted -712698321 1559484228
13271 ] As with paragraph styles, see
13272 \begin_inset CommandInset ref
13274 reference "subsec:Paragraph-Styles"
13283 \begin_layout Itemize
13284 \begin_inset Flex Code
13287 \begin_layout Plain Layout
13293 The font used for the label; see
13294 \begin_inset CommandInset ref
13296 reference "subsec:Font-description"
13303 \begin_layout Itemize
13304 \begin_inset Flex Code
13307 \begin_layout Plain Layout
13314 \begin_inset Flex Code
13317 \begin_layout Plain Layout
13322 , Minimalistic, Conglomerate
13327 ] describes the rendering style used for the inset's frame and buttons.
13330 \begin_layout Itemize
13331 \begin_inset Flex Code
13334 \begin_layout Plain Layout
13341 \begin_inset Flex Code
13344 \begin_layout Plain Layout
13351 \begin_inset Flex Code
13354 \begin_layout Plain Layout
13360 , this argument is automatically inserted when the respective style is selected.
13362 \change_deleted -712698321 1559484200
13363 Currently, only one argument per style\SpecialChar breakableslash
13364 layout can be automatically inserted.
13369 \begin_layout Itemize
13371 \change_inserted -712698321 1559491402
13372 \begin_inset Flex Code
13375 \begin_layout Plain Layout
13377 \change_inserted -712698321 1559490711
13386 \begin_inset Flex Code
13389 \begin_layout Plain Layout
13391 \change_inserted -712698321 1559490703
13400 \begin_inset Flex Code
13403 \begin_layout Plain Layout
13405 \change_inserted -712698321 1559490703
13413 , this argument will be inserted on a new line with
13414 \begin_inset Flex Code
13417 \begin_layout Plain Layout
13419 \change_inserted -712698321 1559491402
13427 (only available within Flex insets).
13430 \begin_layout Itemize
13431 \begin_inset Flex Code
13434 \begin_layout Plain Layout
13441 \begin_inset Flex Code
13444 \begin_layout Plain Layout
13451 \begin_inset Flex Code
13454 \begin_layout Plain Layout
13460 , this argument will be inserted with a copy of the co-text (either selected
13461 text or the whole paragraph) as content.
13464 \begin_layout Itemize
13465 \begin_inset Flex Code
13468 \begin_layout Plain Layout
13475 \begin_inset Flex Code
13478 \begin_layout Plain Layout
13488 ] Whether the contents of this argument should be output in raw form, meaning
13489 without special translations that \SpecialChar LaTeX
13492 \begin_inset Flex Code
13495 \begin_layout Plain Layout
13501 status is inherited by the inset or paragraph layout the argument belongs
13502 to, true and false change the status for the given argument only.
13505 \begin_layout Itemize
13506 \begin_inset Flex Code
13509 \begin_layout Plain Layout
13516 \begin_inset Flex Code
13519 \begin_layout Plain Layout
13520 string of characters
13529 Defines individual characters
13530 \begin_inset Newline linebreak
13533 that should be output in raw form, meaning without special translations
13534 that \SpecialChar LaTeX
13536 Note that, contrary to PassThru, this needs to be explicitly defined for
13538 That is, arguments do not inherit PassThruChars from their parent inset
13542 \begin_layout Itemize
13543 \begin_inset Flex Code
13546 \begin_layout Plain Layout
13553 \begin_inset Flex Code
13556 \begin_layout Plain Layout
13565 \begin_inset space \thinspace{}
13569 \begin_inset Flex Code
13572 \begin_layout Plain Layout
13578 ] If this is set to 1, the argument will output its content in the corresponding
13579 item in the table of contents.
13583 \begin_layout Standard
13584 By default, the text entered in the \SpecialChar LyX
13585 workarea in the respective layout is
13586 the last (mandatory) argument of a command if the
13587 \begin_inset Flex Code
13590 \begin_layout Plain Layout
13597 \begin_inset Flex Code
13600 \begin_layout Plain Layout
13607 However, arguments with the prefix
13608 \begin_inset Flex Code
13611 \begin_layout Plain Layout
13617 are output after this workarea argument.
13618 Note that post-argument numbering restarts at 1, so the first argument
13619 following the workarea argument is
13620 \begin_inset Flex Code
13623 \begin_layout Plain Layout
13630 Post-arguments are ignored in any other
13631 \begin_inset Flex Code
13634 \begin_layout Plain Layout
13641 \begin_inset Flex Code
13644 \begin_layout Plain Layout
13653 \begin_layout Standard
13655 \begin_inset Flex Code
13658 \begin_layout Plain Layout
13667 \begin_inset Flex Code
13670 \begin_layout Plain Layout
13679 \begin_inset Flex Code
13682 \begin_layout Plain Layout
13688 followed by the number (e.
13689 \begin_inset space \thinspace{}
13693 \begin_inset space \space{}
13697 \begin_inset Flex Code
13700 \begin_layout Plain Layout
13707 \change_inserted -712698321 1534487781
13711 \begin_layout Standard
13713 \change_inserted -712698321 1534488561
13714 Finally, there is a special argument type with the prefix
13715 \begin_inset Flex Code
13718 \begin_layout Plain Layout
13720 \change_inserted -712698321 1534487844
13729 It is not really an argument, but uses the argument interface (thus, the
13730 prefix is also followed by a number, e.
13731 \begin_inset space \thinspace{}
13736 \begin_inset Flex Code
13739 \begin_layout Plain Layout
13741 \change_inserted -712698321 1534488412
13742 Argument listpreamble:1
13750 As the name implies, it is targeted at lists such as
13767 Its content will be output at the list start, before the first
13768 \begin_inset Flex Code
13771 \begin_layout Plain Layout
13773 \change_inserted -712698321 1534488058
13783 , on an own line (a place that is otherwise not accessible in \SpecialChar LyX
13785 This way, users can insert redefinitions (of lengths etc.) to individual
13787 By default, these arguments do not have a delimiter.
13793 \begin_layout Description
13794 \begin_inset Flex Code
13797 \begin_layout Plain Layout
13803 Includes a comma-separated list of layouts that should be nested in and
13804 after the current layout.
13805 Only makes sense for nestable layouts (such as environments).
13807 \begin_inset Quotes eld
13811 \begin_inset Flex Code
13814 \begin_layout Plain Layout
13821 \begin_inset Quotes erd
13826 \begin_inset Flex Code
13829 \begin_layout Plain Layout
13838 \begin_layout Description
13839 \begin_inset Flex Code
13842 \begin_layout Plain Layout
13848 Note that this will completely override any prior
13849 \begin_inset Flex Code
13852 \begin_layout Plain Layout
13858 declaration for this style.
13860 \begin_inset Quotes eld
13864 \begin_inset Flex Code
13867 \begin_layout Plain Layout
13874 \begin_inset Quotes erd
13879 \begin_inset CommandInset ref
13881 reference "subsec:I18n"
13885 for details on its use.
13888 \begin_layout Description
13889 \begin_inset Flex Code
13892 \begin_layout Plain Layout
13899 \begin_inset Flex Code
13902 \begin_layout Plain Layout
13912 \begin_layout Plain Layout
13913 Note that a `float' here is a real number, such as: 1.5.
13918 The vertical space with which the last of a chain of paragraphs with this
13919 style is separated from the following paragraph.
13920 If the next paragraph has another style, the separations are not simply
13921 added, but the maximum is taken.
13924 \begin_layout Description
13925 \begin_inset Flex Code
13928 \begin_layout Plain Layout
13935 \begin_inset Flex Code
13938 \begin_layout Plain Layout
13944 ] The category for this style.
13945 This is used to group related styles in the style combobox on the toolbar.
13946 Any string can be used, but you may want to use existing categories with
13951 \begin_layout Description
13952 \begin_inset Flex Code
13955 \begin_layout Plain Layout
13961 Depth of XML command.
13962 Used only with XML-type formats.
13965 \begin_layout Description
13966 \begin_inset Flex Code
13969 \begin_layout Plain Layout
13976 \begin_inset Flex Code
13979 \begin_layout Plain Layout
13985 ] Copies all the features of an existing style into the current one.
13989 \begin_layout Description
13990 \begin_inset Flex Code
13993 \begin_layout Plain Layout
14000 \begin_inset Flex Code
14003 \begin_layout Plain Layout
14009 ] The name of a style whose preamble should be output
14014 This allows to ensure some ordering of the preamble snippets when macros
14015 definitions depend on one another.
14019 \begin_layout Plain Layout
14020 Note that, besides that functionality, there is no way to ensure any ordering
14022 The ordering that you see in a given version of \SpecialChar LyX
14023 may change without warning
14032 \begin_layout Description
14033 \begin_inset Flex Code
14036 \begin_layout Plain Layout
14043 \begin_inset Flex Code
14046 \begin_layout Plain Layout
14051 , Box, Filled_Box, Static
14056 ] The type of label that stands at the end of the paragraph (or sequence
14058 \begin_inset Flex Code
14061 \begin_layout Plain Layout
14068 \begin_inset Newline newline
14072 \begin_inset Flex Code
14075 \begin_layout Plain Layout
14082 \begin_inset Flex Code
14085 \begin_layout Plain Layout
14092 \begin_inset Flex Code
14095 \begin_layout Plain Layout
14103 \begin_inset Flex Code
14106 \begin_layout Plain Layout
14113 \begin_inset Quotes eld
14117 \begin_inset Quotes erd
14121 \begin_inset Flex Code
14124 \begin_layout Plain Layout
14131 \begin_inset space \space{}
14135 \begin_inset Flex Code
14138 \begin_layout Plain Layout
14144 ) is a white (resp.
14145 \begin_inset space ~
14148 black) square suitable for end of proof markers,
14149 \begin_inset Flex Code
14152 \begin_layout Plain Layout
14158 is an explicit text string.
14161 \begin_layout Description
14162 \begin_inset Flex Code
14165 \begin_layout Plain Layout
14172 \begin_inset Flex Code
14175 \begin_layout Plain Layout
14181 ] The string used for a label with a
14182 \begin_inset Flex Code
14185 \begin_layout Plain Layout
14192 \begin_inset Newline newline
14196 \begin_inset Flex Code
14199 \begin_layout Plain Layout
14209 \begin_layout Description
14210 \begin_inset Flex Code
14213 \begin_layout Plain Layout
14219 The font used for both the text body
14225 \begin_inset CommandInset ref
14227 reference "subsec:Font-description"
14232 Note that defining this font automatically defines the
14233 \begin_inset Flex Code
14236 \begin_layout Plain Layout
14243 So you should define this one first if you also want to define
14244 \begin_inset Flex Code
14247 \begin_layout Plain Layout
14256 \begin_layout Description
14257 \begin_inset Flex Code
14260 \begin_layout Plain Layout
14267 \begin_inset Flex Code
14270 \begin_layout Plain Layout
14276 ] Used for backporting new styles to stable \SpecialChar LyX
14278 The first stable version that supports this tag is \SpecialChar LyX
14280 The argument is a number which may either be 0, -1 or any value greater
14283 \begin_inset Flex Code
14286 \begin_layout Plain Layout
14292 flag of a style is greater than zero, it will always be written to the
14294 If a .lyx file is read, the style definitions from the document header are
14295 added to the document class.
14296 Therefore even older \SpecialChar LyX
14297 versions can handle the style.
14299 \begin_inset Flex Code
14302 \begin_layout Plain Layout
14308 is a version number: if the style is read, and the version number is less
14309 than the version number of the already existing style in the document class,
14310 the new style is ignored.
14311 If the version number is greater, the new style replaces the existing style.
14312 A value of -1 means an infinite version number, i.
14313 \begin_inset space \thinspace{}
14317 \begin_inset space \space{}
14320 the style is always used.
14323 \begin_layout Description
14324 \begin_inset Flex Code
14327 \begin_layout Plain Layout
14334 \begin_inset Flex Code
14337 \begin_layout Plain Layout
14346 \begin_inset space \thinspace{}
14350 \begin_inset Flex Code
14353 \begin_layout Plain Layout
14359 ] Usually \SpecialChar LyX
14360 does not allow you to insert more than one space between words,
14361 since a space is considered as the separation between two words, not a
14362 character or symbol of its own.
14363 This is a very fine thing but sometimes annoying, for example, when typing
14364 program code or plain \SpecialChar LaTeX
14367 \begin_inset Flex Code
14370 \begin_layout Plain Layout
14378 \change_deleted -495245474 1550490105
14382 will create protected blanks for the additional blanks when in
14383 \change_inserted -495245474 1550490096
14385 \begin_inset Flex Code
14388 \begin_layout Plain Layout
14390 \change_inserted -495245474 1550490089
14399 \change_deleted -495245474 1550490116
14400 another mode than \SpecialChar LaTeX
14403 \change_inserted -495245474 1550247760
14405 \begin_inset Flex Code
14408 \begin_layout Plain Layout
14410 \change_inserted -495245474 1550247736
14419 \begin_inset Flex Code
14422 \begin_layout Plain Layout
14424 \change_inserted -495245474 1550247755
14437 \begin_layout Description
14438 \begin_inset Flex Code
14441 \begin_layout Plain Layout
14447 These tags are used with XHTML output.
14449 \begin_inset CommandInset ref
14451 reference "subsec:Paragraph-Style-XHTML"
14458 \begin_layout Description
14459 \begin_inset Flex Code
14462 \begin_layout Plain Layout
14468 [FIXME] (Used only with XML-type formats.)
14471 \begin_layout Description
14472 \begin_inset Flex Code
14475 \begin_layout Plain Layout
14482 \begin_inset Flex Code
14485 \begin_layout Plain Layout
14494 \begin_inset space \thinspace{}
14498 \begin_inset Flex Code
14501 \begin_layout Plain Layout
14508 \begin_inset Flex Code
14511 \begin_layout Plain Layout
14517 , marks the style as to be included in the document preamble and not in
14519 This is useful for document classes that want such information as the title
14520 and author to appear in the preamble.
14521 Note that this works only for styles for which the
14522 \begin_inset Flex Code
14525 \begin_layout Plain Layout
14532 \begin_inset Flex Code
14535 \begin_layout Plain Layout
14542 \begin_inset Flex Code
14545 \begin_layout Plain Layout
14554 \begin_layout Description
14555 \begin_inset Flex Code
14558 \begin_layout Plain Layout
14565 \begin_inset Flex Code
14568 \begin_layout Plain Layout
14577 \begin_inset space \thinspace{}
14581 \begin_inset Flex Code
14584 \begin_layout Plain Layout
14591 \begin_inset Flex Code
14594 \begin_layout Plain Layout
14600 , marks the style as being part of a title block (see also the
14601 \begin_inset Flex Code
14604 \begin_layout Plain Layout
14611 \begin_inset Flex Code
14614 \begin_layout Plain Layout
14623 \begin_layout Description
14624 \begin_inset Flex Code
14627 \begin_layout Plain Layout
14633 Includes a comma-separated list of layouts after which this one should
14635 Only makes sense with regard to nestable layouts (such as environments).
14637 \begin_inset Quotes eld
14641 \begin_inset Flex Code
14644 \begin_layout Plain Layout
14651 \begin_inset Quotes erd
14656 \begin_inset Flex Code
14659 \begin_layout Plain Layout
14668 \begin_layout Description
14669 \begin_inset Flex Code
14672 \begin_layout Plain Layout
14679 \begin_inset Flex Code
14682 \begin_layout Plain Layout
14691 \begin_inset space \thinspace{}
14695 \begin_inset Flex Code
14698 \begin_layout Plain Layout
14704 ] If this is set to 1 and AddToToc is enabled, the paragraph adds a summary
14705 of its contents in its item in the table of contents.
14706 Otherwise, only the label, if it exists, appears.
14709 \begin_layout Description
14710 \begin_inset Flex Code
14713 \begin_layout Plain Layout
14720 \begin_inset Flex Code
14723 \begin_layout Plain Layout
14729 ] The \SpecialChar LaTeX
14730 command sequence declaring an item in a list.
14731 The command is to be defined without the preceding backslash (the default
14733 \begin_inset Quotes eld
14737 \begin_inset Quotes erd
14741 \begin_inset Flex Code
14744 \begin_layout Plain Layout
14752 in the \SpecialChar LaTeX
14756 \begin_layout Description
14757 \begin_inset Flex Code
14760 \begin_layout Plain Layout
14767 \begin_inset Flex Code
14770 \begin_layout Plain Layout
14776 ] This provides extra space between paragraphs that have the same style.
14777 If you put other styles into an environment, each is separated with the
14779 \begin_inset Flex Code
14782 \begin_layout Plain Layout
14789 But the whole items of the environment are additionally separated with
14791 \begin_inset Flex Code
14794 \begin_layout Plain Layout
14801 Note that this is a
14806 \begin_layout Description
14807 \begin_inset Flex Code
14810 \begin_layout Plain Layout
14816 [FIXME] (Used only with XML-type formats.)
14819 \begin_layout Description
14820 \begin_inset Flex Code
14823 \begin_layout Plain Layout
14830 \begin_inset Flex Code
14833 \begin_layout Plain Layout
14842 \begin_inset space \thinspace{}
14846 \begin_inset Flex Code
14849 \begin_layout Plain Layout
14855 ] Usually \SpecialChar LyX
14856 does not allow you to leave a paragraph empty, since it would
14857 lead to empty \SpecialChar LaTeX
14859 There are some cases where this could be desirable however: in a letter
14860 template, the required fields can be provided as empty fields, so that
14861 people do not forget them; in some special classes, a style can be used
14862 as some kind of break, which does not contain actual text.
14865 \begin_layout Description
14866 \begin_inset Flex Code
14869 \begin_layout Plain Layout
14876 \begin_inset Flex Code
14879 \begin_layout Plain Layout
14885 ] The vertical space between the label and the text body.
14886 Only used for labels that are above the text body (
14887 \begin_inset Flex Code
14890 \begin_layout Plain Layout
14897 \begin_inset Newline newline
14901 \begin_inset Flex Code
14904 \begin_layout Plain Layout
14905 Centered_Top_Environment
14913 \begin_layout Description
14914 \begin_inset Flex Code
14917 \begin_layout Plain Layout
14924 \begin_inset Flex Code
14927 \begin_layout Plain Layout
14933 ] The name of the counter for automatic numbering.
14934 In order to have the counter appear with your label, you will need to reference
14936 \begin_inset Flex Code
14939 \begin_layout Plain Layout
14948 This will work with
14949 \begin_inset Flex Code
14952 \begin_layout Plain Layout
14959 \begin_inset Flex Code
14962 \begin_layout Plain Layout
14969 \begin_inset Flex Code
14972 \begin_layout Plain Layout
14979 \begin_inset Flex Code
14982 \begin_layout Plain Layout
14989 \begin_inset Newline newline
14997 \begin_inset Flex Code
15000 \begin_layout Plain Layout
15007 \begin_inset Flex Code
15010 \begin_layout Plain Layout
15016 , though this case is a bit complicated.
15017 Suppose you declare
15018 \begin_inset Quotes eld
15022 \begin_inset Flex Code
15025 \begin_layout Plain Layout
15026 LabelCounter myenum
15032 \begin_inset Quotes erd
15036 Then the actual counters used are
15037 \begin_inset Flex Code
15040 \begin_layout Plain Layout
15047 \begin_inset Flex Code
15050 \begin_layout Plain Layout
15057 \begin_inset Flex Code
15060 \begin_layout Plain Layout
15067 \begin_inset Flex Code
15070 \begin_layout Plain Layout
15076 , much as in \SpecialChar LaTeX
15078 These counters must all be declared separately.
15079 \begin_inset Newline newline
15083 \begin_inset CommandInset ref
15085 reference "subsec:Counters"
15089 for details on counters.
15092 \begin_layout Description
15093 \begin_inset Flex Code
15096 \begin_layout Plain Layout
15102 The font used for the label.
15104 \begin_inset CommandInset ref
15106 reference "subsec:Font-description"
15113 \begin_layout Description
15114 \begin_inset Flex Code
15117 \begin_layout Plain Layout
15124 \begin_inset Flex Code
15127 \begin_layout Plain Layout
15133 ] Text that indicates how far a label should be indented.
15136 \begin_layout Description
15137 \begin_inset Flex Code
15140 \begin_layout Plain Layout
15147 \begin_inset Flex Code
15150 \begin_layout Plain Layout
15156 ] Text that indicates the amount of horizontal space between the label and
15158 Only used for labels that are not above the text body.
15161 \begin_layout Description
15162 \begin_inset Flex Code
15165 \begin_layout Plain Layout
15172 \begin_inset Flex Code
15175 \begin_layout Plain Layout
15181 ] The string used for the label.
15183 \begin_inset Flex Code
15186 \begin_layout Plain Layout
15192 is set, this string can be contain the special formatting commands described
15194 \begin_inset CommandInset ref
15196 reference "subsec:Counters"
15203 \begin_layout Description
15204 \begin_inset Flex Code
15207 \begin_layout Plain Layout
15208 LabelStringAppendix
15214 \begin_inset Flex Code
15217 \begin_layout Plain Layout
15223 ] This is used inside the appendix instead of
15224 \begin_inset Newline newline
15228 \begin_inset Flex Code
15231 \begin_layout Plain Layout
15239 \begin_inset Flex Code
15242 \begin_layout Plain Layout
15249 \begin_inset Newline newline
15253 \begin_inset Flex Code
15256 \begin_layout Plain Layout
15257 LabelStringAppendix
15265 \begin_layout Description
15266 \begin_inset Flex Code
15269 \begin_layout Plain Layout
15275 [FIXME] (Used only with XML-type formats.)
15278 \begin_layout Description
15279 \begin_inset Flex Code
15282 \begin_layout Plain Layout
15289 \begin_inset Flex Code
15292 \begin_layout Plain Layout
15297 , Manual, Static, Above,
15298 \begin_inset Newline newline
15301 Centered, Sensitive, Enumerate,
15302 \begin_inset Newline newline
15305 Itemize, Bibliography
15314 \begin_layout Description
15315 \begin_inset Flex Code
15318 \begin_layout Plain Layout
15324 means the label is the very first word (up to the first real blank).
15325 Use protected spaces if you want more than one word as the label.
15329 \begin_layout Description
15330 \begin_inset Flex Code
15333 \begin_layout Plain Layout
15339 means the label is simply what is declared as
15340 \begin_inset Flex Code
15343 \begin_layout Plain Layout
15350 This will be displayed
15351 \begin_inset Quotes eld
15355 \begin_inset Quotes erd
15358 , at the beginning of the paragraph.
15360 \begin_inset Flex Code
15363 \begin_layout Plain Layout
15370 \begin_inset Flex Code
15373 \begin_layout Plain Layout
15379 , then it will be displayed only in the first paragraph of any sequence
15380 of paragraphs with the same
15381 \begin_inset Flex Code
15384 \begin_layout Plain Layout
15393 \begin_layout Description
15394 \begin_inset Flex Code
15397 \begin_layout Plain Layout
15404 \begin_inset space ~
15408 \begin_inset space ~
15412 \begin_inset Flex Code
15415 \begin_layout Plain Layout
15421 are special cases of
15422 \begin_inset Flex Code
15425 \begin_layout Plain Layout
15432 The label will be printed above the paragraph either at the beginning of
15433 the line or centered.
15436 \begin_layout Description
15437 \begin_inset Flex Code
15440 \begin_layout Plain Layout
15446 is a special case for the caption-labels
15447 \begin_inset Quotes eld
15451 \begin_inset Quotes erd
15455 \begin_inset Quotes eld
15459 \begin_inset Quotes erd
15463 \begin_inset Newline newline
15467 \begin_inset Flex Code
15470 \begin_layout Plain Layout
15476 means the (hardcoded) label string depends on the kind of float: It is
15477 hardcoded to be `FloatType N', where N is the value of the counter associated
15479 For the case that a caption is inserted outside of a float the
15480 \begin_inset Flex Code
15483 \begin_layout Plain Layout
15490 \begin_inset Quotes eld
15494 \begin_inset Quotes erd
15500 \begin_layout Description
15501 \begin_inset Flex Code
15504 \begin_layout Plain Layout
15510 produces the usual sort of enumeration labels.
15511 The number type needs to be set in the
15516 \begin_inset CommandInset ref
15518 reference "subsec:Counters"
15525 \begin_layout Description
15526 \begin_inset Flex Code
15529 \begin_layout Plain Layout
15535 produces various bullets at the different levels.
15536 The bullet types displayed can be set via
15537 \begin_inset Flex Noun
15540 \begin_layout Plain Layout
15541 Document\SpecialChar menuseparator
15542 Settings\SpecialChar menuseparator
15551 \begin_layout Description
15552 \begin_inset Flex Code
15555 \begin_layout Plain Layout
15561 should be used only with
15562 \begin_inset Flex Code
15565 \begin_layout Plain Layout
15566 LatexType BibEnvironment
15575 \begin_layout Description
15576 \begin_inset Flex Code
15579 \begin_layout Plain Layout
15585 Note that this will completely override any prior
15586 \begin_inset Flex Code
15589 \begin_layout Plain Layout
15595 declaration for this style.
15597 \begin_inset Quotes eld
15601 \begin_inset Flex Code
15604 \begin_layout Plain Layout
15611 \begin_inset Quotes erd
15616 \begin_inset CommandInset ref
15618 reference "subsec:I18n"
15622 for details on its use.
15625 \begin_layout Description
15626 \begin_inset Flex Code
15629 \begin_layout Plain Layout
15636 \begin_inset Flex Code
15639 \begin_layout Plain Layout
15645 ] The name of the corresponding \SpecialChar LaTeX
15647 Either the environment or command name.
15650 \begin_layout Description
15651 \begin_inset Flex Code
15654 \begin_layout Plain Layout
15661 \begin_inset Flex Code
15664 \begin_layout Plain Layout
15670 ] An optional parameter for the corresponding
15671 \begin_inset Flex Code
15674 \begin_layout Plain Layout
15681 This parameter cannot be changed from within \SpecialChar LyX
15683 \begin_inset Flex Code
15686 \begin_layout Plain Layout
15692 for customizable parameters).
15693 This will be output as is after all \SpecialChar LaTeX
15695 \begin_inset Flex Code
15698 \begin_layout Plain Layout
15707 \begin_layout Description
15708 \begin_inset Flex Code
15711 \begin_layout Plain Layout
15718 \begin_inset Flex Code
15721 \begin_layout Plain Layout
15726 , Command, Environment, Item_Environment,
15727 \begin_inset Newline newline
15730 List_Environment, Bib_Environment
15735 ] How the style should be translated into \SpecialChar LaTeX
15740 \begin_layout Plain Layout
15741 \begin_inset Flex Code
15744 \begin_layout Plain Layout
15750 is perhaps a bit misleading, since these rules apply to SGML classes, too.
15751 Visit the SGML class files for specific examples.
15760 \begin_layout Description
15761 \begin_inset Flex Code
15764 \begin_layout Plain Layout
15770 means nothing special.
15773 \begin_layout Description
15774 \begin_inset Flex Code
15777 \begin_layout Plain Layout
15784 \begin_inset Flex Code
15787 \begin_layout Plain Layout
15794 {\SpecialChar ldots
15803 \begin_layout Description
15804 \begin_inset Flex Code
15807 \begin_layout Plain Layout
15814 \begin_inset Flex Code
15817 \begin_layout Plain Layout
15824 }\SpecialChar ldots
15840 \begin_layout Description
15841 \begin_inset Flex Code
15844 \begin_layout Plain Layout
15851 \begin_inset Flex Code
15854 \begin_layout Plain Layout
15861 \begin_inset Flex Code
15864 \begin_layout Plain Layout
15872 is generated for each paragraph of this environment.
15876 \begin_layout Description
15877 \begin_inset Flex Code
15880 \begin_layout Plain Layout
15887 \begin_inset Flex Code
15890 \begin_layout Plain Layout
15897 \begin_inset Newline newline
15901 \begin_inset Flex Code
15904 \begin_layout Plain Layout
15910 is passed as an argument to the environment.
15911 \begin_inset Newline newline
15915 \begin_inset Flex Code
15918 \begin_layout Plain Layout
15924 can be defined in the
15925 \begin_inset Flex Noun
15928 \begin_layout Plain Layout
15929 Edit\SpecialChar menuseparator
15931 \begin_inset space ~
15942 \begin_layout Description
15943 \begin_inset Flex Code
15946 \begin_layout Plain Layout
15953 \begin_inset Flex Code
15956 \begin_layout Plain Layout
15962 but adds the necessary mandatory argument (the longest label) to the begin
15963 statement of the bibliography environment:
15964 \begin_inset Newline newline
15968 \begin_inset Flex Code
15971 \begin_layout Plain Layout
15974 begin{thebibliography}{99}
15980 It is therefore only useful for bibliography environments.
15981 The default longest label
15982 \begin_inset Quotes eld
15986 \begin_inset Quotes erd
15989 can be changed by the user in the paragraph settings of a bibliography
15993 \begin_layout Standard
15994 Putting the last few things together, the \SpecialChar LaTeX
15995 output will be either:
15998 \begin_layout LyX-Code
16001 LatexName[LatexParam]{\SpecialChar ldots
16005 \begin_layout Standard
16009 \begin_layout LyX-Code
16012 begin{LatexName}[LatexParam] \SpecialChar ldots
16018 \begin_layout Standard
16019 depending upon the \SpecialChar LaTeX
16024 \begin_layout Description
16025 \begin_inset Flex Code
16028 \begin_layout Plain Layout
16035 \begin_inset Flex Code
16038 \begin_layout Plain Layout
16044 ] A string that is put at the beginning of the style content.
16045 A line break in the output can be indicated by
16046 \begin_inset Flex Code
16049 \begin_layout Plain Layout
16058 \begin_layout Description
16059 \begin_inset Flex Code
16062 \begin_layout Plain Layout
16069 \begin_inset Flex Code
16072 \begin_layout Plain Layout
16078 ] If you put styles into environments, the different
16079 \begin_inset Flex Code
16082 \begin_layout Plain Layout
16088 are not simply added, but added with a factor
16089 \begin_inset Formula $\frac{4}{\mathrm{depth}+4}$
16093 Note that this parameter is also used when
16094 \begin_inset Flex Code
16097 \begin_layout Plain Layout
16104 \begin_inset Flex Code
16107 \begin_layout Plain Layout
16114 \begin_inset Flex Code
16117 \begin_layout Plain Layout
16124 Then it is added to the manual or dynamic margin.
16125 \begin_inset Newline newline
16129 \begin_inset Quotes eld
16133 \begin_inset Flex Code
16136 \begin_layout Plain Layout
16143 \begin_inset Quotes erd
16146 means that the paragraph is indented with the width of
16147 \begin_inset Quotes eld
16151 \begin_inset Flex Code
16154 \begin_layout Plain Layout
16161 \begin_inset Quotes erd
16164 in the normal font.
16165 You can get a negative width by prefixing the string with
16166 \begin_inset Quotes eld
16170 \begin_inset Flex Code
16173 \begin_layout Plain Layout
16180 \begin_inset Quotes erd
16184 This way was chosen so that the look is the same with each used screen
16188 \begin_layout Description
16189 \begin_inset Flex Code
16192 \begin_layout Plain Layout
16199 \begin_inset Flex Code
16202 \begin_layout Plain Layout
16207 , Manual, Dynamic, First_Dynamic, Right_Address_Box
16213 \begin_inset Newline newline
16216 The kind of margin that the style has on the left side.
16220 \begin_layout Description
16221 \begin_inset Flex Code
16224 \begin_layout Plain Layout
16230 just means a fixed margin.
16233 \begin_layout Description
16234 \begin_inset Flex Code
16237 \begin_layout Plain Layout
16243 means that the left margin depends on the string entered in the
16244 \begin_inset Flex Noun
16247 \begin_layout Plain Layout
16248 Edit\SpecialChar menuseparator
16250 \begin_inset space ~
16259 This is used to typeset nice lists without tabulators.
16262 \begin_layout Description
16263 \begin_inset Flex Code
16266 \begin_layout Plain Layout
16272 means that the margin depends on the size of the label.
16273 This is used for automatic enumerated headlines.
16274 It is obvious that the headline
16275 \begin_inset Quotes eld
16278 5.4.3.2.1 Very long headline
16279 \begin_inset Quotes erd
16282 must have a wider left margin (as wide as
16283 \begin_inset Quotes eld
16287 \begin_inset Quotes erd
16290 plus the space) than
16291 \begin_inset Quotes eld
16294 3.2 Very long headline
16295 \begin_inset Quotes erd
16299 \begin_inset Quotes eld
16303 \begin_inset Quotes erd
16306 are not able to do this.
16309 \begin_layout Description
16310 \begin_inset Flex Code
16313 \begin_layout Plain Layout
16319 is similar, but only the very first row of the paragraph is dynamic, while
16320 the others are static; this is used, for example, for descriptions.
16323 \begin_layout Description
16324 \begin_inset Flex Code
16327 \begin_layout Plain Layout
16333 means the margin is chosen in a way that the longest row of this paragraph
16334 fits to the right margin.
16335 This is used to typeset an address on the right edge of the page.
16339 \begin_layout Description
16340 \begin_inset Flex Code
16343 \begin_layout Plain Layout
16350 \begin_inset Flex Code
16353 \begin_layout Plain Layout
16362 \begin_inset space \thinspace{}
16366 \begin_inset Flex Code
16369 \begin_layout Plain Layout
16375 ] Whether fragile commands in this style should be
16376 \begin_inset Flex Code
16379 \begin_layout Plain Layout
16392 whether this command should itself be protected.)
16393 \change_inserted -712698321 1523696949
16397 \begin_layout Description
16399 \change_inserted -712698321 1552395557
16400 \begin_inset Flex Code
16403 \begin_layout Plain Layout
16405 \change_inserted -712698321 1523696950
16414 \begin_inset Flex Code
16417 \begin_layout Plain Layout
16419 \change_inserted -712698321 1523696950
16430 \begin_inset space \thinspace{}
16434 \begin_inset Flex Code
16437 \begin_layout Plain Layout
16439 \change_inserted -712698321 1523696950
16447 ] This causes macros that contain this layout to be protected with
16448 \begin_inset Flex Code
16451 \begin_layout Plain Layout
16453 \change_inserted -712698321 1523696950
16468 ) if necessary and thus allows (some) verbatim stuff in macros.
16471 \begin_layout Description
16473 \change_inserted -712698321 1552395844
16474 \begin_inset Flex Code
16477 \begin_layout Plain Layout
16479 \change_inserted -712698321 1552395561
16488 \begin_inset Flex Code
16491 \begin_layout Plain Layout
16493 \change_inserted -712698321 1552395557
16504 \begin_inset space \thinspace{}
16508 \begin_inset Flex Code
16511 \begin_layout Plain Layout
16513 \change_inserted -712698321 1552395557
16521 ] Whether specific commands in this style (such as
16522 \begin_inset Flex Code
16525 \begin_layout Plain Layout
16527 \change_inserted -712698321 1552395655
16538 \begin_inset Flex Code
16541 \begin_layout Plain Layout
16543 \change_inserted -712698321 1552395661
16553 ) should be protected in an
16554 \begin_inset Flex Code
16557 \begin_layout Plain Layout
16559 \change_inserted -712698321 1552395631
16570 This is particularly needed for styles that draw on
16578 commands which parse their content in complex ways.
16583 \begin_layout Description
16584 \begin_inset Flex Code
16587 \begin_layout Plain Layout
16594 \begin_inset Flex Code
16597 \begin_layout Plain Layout
16604 \begin_inset space \thinspace{}
16608 \begin_inset Flex Code
16611 \begin_layout Plain Layout
16619 ] Whether newlines are translated into \SpecialChar LaTeX
16621 \begin_inset Flex Code
16624 \begin_layout Plain Layout
16635 The translation can be switched off to allow more comfortable \SpecialChar LaTeX
16637 inside \SpecialChar LyX
16641 \begin_layout Description
16642 \begin_inset Flex Code
16645 \begin_layout Plain Layout
16652 \begin_inset Flex Code
16655 \begin_layout Plain Layout
16664 \begin_inset space \thinspace{}
16668 \begin_inset Flex Code
16671 \begin_layout Plain Layout
16677 ] If set to true, and if
16678 \begin_inset Flex Code
16681 \begin_layout Plain Layout
16688 \begin_inset Flex Code
16691 \begin_layout Plain Layout
16697 ) paragraphs are being indented, then the indentation of such a paragraph
16698 following one of this type will be suppressed.
16699 (So this will not affect the display of non-default paragraphs.)
16702 \begin_layout Description
16703 \begin_inset Flex Code
16706 \begin_layout Plain Layout
16713 \begin_inset Flex Code
16716 \begin_layout Plain Layout
16722 ] Name of a style that has replaced this style.
16723 This is used to rename a style, while keeping backward compatibility.
16726 \begin_layout Description
16727 \begin_inset Flex Code
16730 \begin_layout Plain Layout
16737 \begin_inset Flex Code
16740 \begin_layout Plain Layout
16747 \begin_inset space \thinspace{}
16751 \begin_inset Flex Code
16754 \begin_layout Plain Layout
16760 ] Determines whether consecutive paragraphs of the same type are treated
16761 as belonging together.
16762 This has the effect that the
16763 \begin_inset Flex Code
16766 \begin_layout Plain Layout
16772 is only printed once before such a group.
16773 By default, this is true for
16774 \begin_inset Flex Code
16777 \begin_layout Plain Layout
16784 \begin_inset Flex Code
16787 \begin_layout Plain Layout
16794 \begin_inset Flex Code
16797 \begin_layout Plain Layout
16803 and false for all other types.
16806 \begin_layout Description
16807 \begin_inset Flex Code
16810 \begin_layout Plain Layout
16817 \begin_inset Flex Code
16820 \begin_layout Plain Layout
16829 \begin_inset space \thinspace{}
16833 \begin_inset Flex Code
16836 \begin_layout Plain Layout
16842 ] Indicates that paragraphs will not be separated by an empty line in \SpecialChar LaTeX
16844 but only by a line break; together with
16845 \begin_inset Flex Code
16848 \begin_layout Plain Layout
16854 , this allows to emulate a plain text editor (like the ERT inset).
16857 \begin_layout Description
16858 \begin_inset Flex Code
16861 \begin_layout Plain Layout
16868 \begin_inset Flex Code
16871 \begin_layout Plain Layout
16877 ] The indent of the very first line of a paragraph.
16879 \begin_inset Newline newline
16883 \begin_inset Flex Code
16886 \begin_layout Plain Layout
16892 will be fixed for a certain style.
16893 The exception is the default style, since the indentation for these paragraphs
16894 can be prohibited with
16895 \begin_inset Flex Code
16898 \begin_layout Plain Layout
16906 \begin_inset Flex Code
16909 \begin_layout Plain Layout
16915 style paragraphs inside environments use the
16916 \begin_inset Flex Code
16919 \begin_layout Plain Layout
16925 of the environment, not their native one.
16927 \begin_inset Flex Code
16930 \begin_layout Plain Layout
16936 paragraphs inside an enumeration are not indented.
16939 \begin_layout Description
16940 \begin_inset Flex Code
16943 \begin_layout Plain Layout
16950 \begin_inset Flex Code
16953 \begin_layout Plain Layout
16959 ] The vertical space between two paragraphs of this style.
16962 \begin_layout Description
16963 \begin_inset Flex Code
16966 \begin_layout Plain Layout
16973 \begin_inset Flex Code
16976 \begin_layout Plain Layout
16983 allows the user to choose either
16984 \begin_inset Quotes eld
16988 \begin_inset Quotes erd
16992 \begin_inset Quotes eld
16996 \begin_inset Quotes erd
16999 to separate paragraphs.
17001 \begin_inset Quotes eld
17005 \begin_inset Quotes erd
17009 \begin_inset Flex Code
17012 \begin_layout Plain Layout
17020 \begin_inset Quotes eld
17024 \begin_inset Quotes erd
17028 \begin_inset Flex Code
17031 \begin_layout Plain Layout
17037 is ignored and all paragraphs are separated by the
17038 \begin_inset Flex Code
17041 \begin_layout Plain Layout
17048 The vertical space is calculated with
17049 \begin_inset Flex Code
17052 \begin_layout Plain Layout
17054 \begin_inset space ~
17063 \begin_inset Flex Code
17066 \begin_layout Plain Layout
17072 is the height of a row with the normal font.
17073 This way, the look stays the same with different screen fonts.
17076 \begin_layout Description
17077 \begin_inset Flex Code
17080 \begin_layout Plain Layout
17087 \begin_inset Flex Code
17090 \begin_layout Plain Layout
17099 \begin_inset space \thinspace{}
17103 \begin_inset Flex Code
17106 \begin_layout Plain Layout
17112 ] Whether the contents of this paragraph should be output in raw form, meaning
17113 without special translations that \SpecialChar LaTeX
17117 \begin_layout Description
17118 \begin_inset Flex Code
17121 \begin_layout Plain Layout
17128 \begin_inset Flex Code
17131 \begin_layout Plain Layout
17141 Defines individual characters that should be output in raw form, meaning
17142 without special translations that \SpecialChar LaTeX
17146 \begin_layout Description
17147 \begin_inset Flex Code
17150 \begin_layout Plain Layout
17156 Information to be included in the \SpecialChar LaTeX
17157 preamble when this style is used.
17158 Used to define macros, load packages, etc., required by this particular
17161 \begin_inset Quotes eld
17165 \begin_inset Flex Code
17168 \begin_layout Plain Layout
17175 \begin_inset Quotes erd
17181 \begin_layout Description
17182 \begin_inset Flex Code
17185 \begin_layout Plain Layout
17192 \begin_inset Flex Code
17195 \begin_layout Plain Layout
17201 ] The prefix to use when creating labels referring to paragraphs of this
17203 This allows the use of formatted references.
17206 \begin_layout Description
17207 \begin_inset Flex Code
17210 \begin_layout Plain Layout
17217 \begin_inset Flex Code
17220 \begin_layout Plain Layout
17226 ] Whether the style requires the feature
17227 \begin_inset Flex Code
17230 \begin_layout Plain Layout
17237 \begin_inset CommandInset ref
17239 reference "chap:List-of-functions"
17243 for the list of features).
17244 If you require a package with specific options, you can additionally use
17246 \begin_inset Flex Code
17249 \begin_layout Plain Layout
17255 as a general text class parameter (see
17256 \begin_inset CommandInset ref
17258 reference "subsec:General-text-class"
17265 \begin_layout Description
17266 \begin_inset Flex Code
17269 \begin_layout Plain Layout
17276 \begin_inset Flex Code
17279 \begin_layout Plain Layout
17288 \begin_inset Flex Code
17291 \begin_layout Plain Layout
17297 ] Resets the \SpecialChar LaTeX
17298 arguments of this style (as defined via the
17299 \begin_inset Flex Code
17302 \begin_layout Plain Layout
17309 This is useful if you have copied a style via
17310 \begin_inset Flex Code
17313 \begin_layout Plain Layout
17319 , but you do not want to inherit its (required and optional) arguments.
17322 \begin_layout Description
17323 \begin_inset Flex Code
17326 \begin_layout Plain Layout
17333 \begin_inset Flex Code
17336 \begin_layout Plain Layout
17345 \begin_inset Flex Code
17348 \begin_layout Plain Layout
17354 ] Resumes a counter that is usually reset at each new sequence of layouts.
17355 This is currently only useful when
17356 \begin_inset Flex Code
17359 \begin_layout Plain Layout
17366 \begin_inset Flex Code
17369 \begin_layout Plain Layout
17378 \begin_layout Description
17379 \begin_inset Flex Code
17382 \begin_layout Plain Layout
17389 \begin_inset Flex Code
17392 \begin_layout Plain Layout
17398 ] A string that is put at the end of the layout content.
17399 A line break in the output can be indicated by
17400 \begin_inset Flex Code
17403 \begin_layout Plain Layout
17412 \begin_layout Description
17413 \begin_inset Flex Code
17416 \begin_layout Plain Layout
17423 \begin_inset Flex Code
17426 \begin_layout Plain Layout
17433 \begin_inset Flex Code
17436 \begin_layout Plain Layout
17445 \begin_layout Description
17446 \begin_inset Flex Code
17449 \begin_layout Plain Layout
17456 \begin_inset Flex Code
17459 \begin_layout Plain Layout
17468 \begin_inset Flex Code
17471 \begin_layout Plain Layout
17478 \begin_inset Flex Code
17481 \begin_layout Plain Layout
17488 \begin_inset Flex Code
17491 \begin_layout Plain Layout
17493 \begin_inset space ~
17501 ] This defines what the default spacing should be in the style.
17503 \begin_inset Flex Code
17506 \begin_layout Plain Layout
17513 \begin_inset Flex Code
17516 \begin_layout Plain Layout
17523 \begin_inset Flex Code
17526 \begin_layout Plain Layout
17532 correspond respectively to a multiplier value of 1, 1.25 and 1.667.
17533 If you specify the argument
17534 \begin_inset Flex Code
17537 \begin_layout Plain Layout
17543 , then you must also provide a value argument which will be the actual multiplie
17545 Note that, contrary to other parameters,
17546 \begin_inset Flex Code
17549 \begin_layout Plain Layout
17555 implies the generation of specific \SpecialChar LaTeX
17556 code, using the \SpecialChar LaTeX
17560 \begin_inset Flex Code
17563 \begin_layout Plain Layout
17572 \begin_layout Description
17573 \begin_inset Flex Code
17576 \begin_layout Plain Layout
17583 \begin_inset Flex Code
17586 \begin_layout Plain Layout
17593 \begin_inset space \thinspace{}
17597 \begin_inset Flex Code
17600 \begin_layout Plain Layout
17608 ] Allow spell-checking paragraphs of this style.
17612 \begin_layout Description
17613 \begin_inset Flex Code
17616 \begin_layout Plain Layout
17618 \change_deleted 731793113 1604355211
17620 \change_inserted 731793113 1604355212
17629 \begin_inset Flex Code
17632 \begin_layout Plain Layout
17641 \begin_inset Flex Code
17644 \begin_layout Plain Layout
17651 \change_deleted 731793113 1604355214
17653 \change_inserted 731793113 1604355216
17656 counter of a given counter at the beginning of a new sequence of layouts.
17657 This is currently only useful when
17658 \begin_inset Flex Code
17661 \begin_layout Plain Layout
17668 \begin_inset Flex Code
17671 \begin_layout Plain Layout
17680 \begin_layout Description
17681 \begin_inset Flex Code
17684 \begin_layout Plain Layout
17690 The font used for the text body .
17692 \begin_inset CommandInset ref
17694 reference "subsec:Font-description"
17701 \begin_layout Description
17702 \begin_inset Flex Code
17705 \begin_layout Plain Layout
17714 \begin_inset Flex Code
17717 \begin_layout Plain Layout
17727 The level of the style in the table of contents.
17728 This is used for automatic numbering of section headings.
17731 \begin_layout Description
17732 \begin_inset Flex Code
17735 \begin_layout Plain Layout
17744 \begin_inset Flex Code
17747 \begin_layout Plain Layout
17758 \begin_inset Flex Code
17761 \begin_layout Plain Layout
17768 \begin_inset Flex Code
17771 \begin_layout Plain Layout
17777 ] This tag determines whether the first line indentation of this paragraph
17778 can be toggled via the Paragraph settings dialog.
17782 \begin_inset Flex Code
17785 \begin_layout Plain Layout
17795 is set, indentation can be toggled if the document settings use
17796 \begin_inset Quotes eld
17800 \begin_inset Quotes erd
17803 paragraph style, with
17804 \begin_inset Flex Code
17807 \begin_layout Plain Layout
17813 , indentation can always be toggled, notwithstanding the document settings,
17815 \begin_inset Flex Code
17818 \begin_layout Plain Layout
17824 , indentation can never be toggled.
17827 \begin_layout Description
17828 \begin_inset Flex Code
17831 \begin_layout Plain Layout
17838 \begin_inset Flex Code
17841 \begin_layout Plain Layout
17847 ] The vertical space with which the very first of a chain of paragraphs
17848 with this style is separated from the previous paragraph.
17849 If the previous paragraph has another style, the separations are not simply
17850 added, but the maximum is taken.
17853 \begin_layout Subsection
17854 \begin_inset CommandInset label
17860 Internationalization of Paragraph Styles
17863 \begin_layout Standard
17865 has long supported internationalization of layout information, but, until
17866 version 2.0, this applied only to the user interface and not to, say, PDF
17868 Thus, French authors were forced to resort to ugly hacks if they wanted
17873 1' instead of `Theorem 1'.
17874 Thanks to Georg Baum, that is no longer the case.
17877 \begin_layout Standard
17879 \begin_inset Flex Code
17882 \begin_layout Plain Layout
17888 defines text that is to appear in the typeset document, it may use
17889 \begin_inset Flex Code
17892 \begin_layout Plain Layout
17899 \begin_inset Flex Code
17902 \begin_layout Plain Layout
17908 to support non-English and even multi-language documents correctly.
17909 The following excerpt (from the
17910 \begin_inset Flex Code
17913 \begin_layout Plain Layout
17919 file) shows how this works:
17922 \begin_layout LyX-Code
17927 \begin_layout LyX-Code
17930 theoremstyle{remark}
17933 \begin_layout LyX-Code
17936 newtheorem{claim}[thm]{
17943 \begin_layout LyX-Code
17947 \begin_layout LyX-Code
17951 \begin_layout LyX-Code
17956 claimname}{_(Claim)}
17959 \begin_layout LyX-Code
17963 \begin_layout LyX-Code
17967 \begin_layout LyX-Code
17976 claimname}{_(Claim)}}
17979 \begin_layout LyX-Code
17984 \begin_layout Standard
17985 In principle, any legal \SpecialChar LaTeX
17987 \begin_inset Flex Code
17990 \begin_layout Plain Layout
17997 \begin_inset Flex Code
18000 \begin_layout Plain Layout
18006 tags, but in practice they will typically look as they do here.
18007 The key to correct translation of the typeset text is the definition of
18008 the \SpecialChar LaTeX
18010 \begin_inset Flex Code
18013 \begin_layout Plain Layout
18022 \begin_inset Flex Code
18025 \begin_layout Plain Layout
18037 \begin_layout Standard
18039 \begin_inset Flex Code
18042 \begin_layout Plain Layout
18048 tag provides for internationalization based upon the overall language of
18050 The contents of the tag will be included in the preamble, just as with
18052 \begin_inset Flex Code
18055 \begin_layout Plain Layout
18062 What makes it special is the use of the
18063 \begin_inset Quotes eld
18067 \begin_inset Quotes erd
18071 \begin_inset Flex Code
18074 \begin_layout Plain Layout
18080 , which will be replaced, when \SpecialChar LyX
18081 produces \SpecialChar LaTeX
18082 output, with the translation of
18083 its argument into the document language.
18086 \begin_layout Standard
18088 \begin_inset Flex Code
18091 \begin_layout Plain Layout
18097 tag is more complex, since it is meant to provide support for multi-language
18098 documents and so offers an interface to the
18099 \begin_inset Flex Code
18102 \begin_layout Plain Layout
18109 Its contents will be added to the preamble once for each language that
18110 appears in the document.
18111 In this case, the argument to
18112 \begin_inset Flex Code
18115 \begin_layout Plain Layout
18121 will be replaced with its translation into the language in question; the
18123 \begin_inset Flex Code
18126 \begin_layout Plain Layout
18132 is replaced by the language name (as used by the babel package).
18135 \begin_layout Standard
18136 A German document that also included a French section would thus have the
18137 following in the preamble:
18140 \begin_layout LyX-Code
18149 claimname}{Affirmation}}
18150 \begin_inset Newline newline
18161 claimname}{Behauptung}}
18162 \begin_inset Newline newline
18169 claimname}{Behauptung}
18172 \begin_layout Standard
18175 \begin_inset Flex Code
18178 \begin_layout Plain Layout
18184 will then conspire to produce the correct text in the output.
18187 \begin_layout Standard
18188 One important point to note here is that the translations are provided by
18190 itself, through the file
18191 \begin_inset Flex Code
18194 \begin_layout Plain Layout
18201 This means, in effect, that
18202 \begin_inset Flex Code
18205 \begin_layout Plain Layout
18212 \begin_inset Flex Code
18215 \begin_layout Plain Layout
18221 are really only of use in layout files that are provided with \SpecialChar LyX
18223 entered in user-created layout files will not be seen by \SpecialChar LyX
18224 's internationalizatio
18225 n routines unless the
18226 \begin_inset Flex Code
18229 \begin_layout Plain Layout
18235 file is modified accordingly.
18236 That said, however, any layout created with the intention that it will
18237 be included with \SpecialChar LyX
18238 should use these tags where appropriate.
18239 Please note that the paragraph style translations provided by \SpecialChar LyX
18241 change with a minor update (e.
18242 \begin_inset space \thinspace{}
18246 \begin_inset space \space{}
18249 from version 2.1.x to 2.1.y).
18250 It is however quite likely that a major update (e.
18251 \begin_inset space \thinspace{}
18255 \begin_inset space \space{}
18258 from 2.0.x to 2.1.0) will introduce new translations or corrections.
18261 \begin_layout Subsection
18263 \begin_inset CommandInset label
18265 name "subsec:Floats"
18272 \begin_layout Standard
18273 It is necessary to define the floats (
18274 \begin_inset Flex Noun
18277 \begin_layout Plain Layout
18284 \begin_inset Flex Noun
18287 \begin_layout Plain Layout
18293 , \SpecialChar ldots
18294 ) in the text class itself.
18295 Standard floats are included in the file
18296 \begin_inset Flex Code
18299 \begin_layout Plain Layout
18305 , so you may have to do no more than add
18308 \begin_layout LyX-Code
18309 Input stdfloats.inc
18312 \begin_layout Standard
18313 to your layout file.
18314 If you want to implement a text class that proposes some other float types
18315 (like the AGU class bundled with \SpecialChar LyX
18316 ), the information below will hopefully
18320 \begin_layout Description
18321 \begin_inset Flex Code
18324 \begin_layout Plain Layout
18331 \begin_inset Flex Code
18334 \begin_layout Plain Layout
18340 =!htbpH] Allowed placement options for this float type.
18341 The value is a string of placement characters.
18342 Possible characters include:
18347 \begin_inset Quotes eld
18351 \begin_inset Quotes erd
18359 \begin_inset Quotes eld
18363 \begin_inset Quotes erd
18371 \begin_inset Quotes eld
18375 \begin_inset Quotes erd
18383 \begin_inset Quotes eld
18387 \begin_inset Quotes erd
18395 \begin_inset Quotes eld
18399 \begin_inset Quotes erd
18407 \begin_inset Quotes eld
18411 \begin_inset Quotes erd
18415 The order of the characters in the string does not matter.
18416 If no placement options are allowed, use the string
18423 \begin_layout Description
18424 \begin_inset Flex Code
18427 \begin_layout Plain Layout
18434 \begin_inset Flex Code
18437 \begin_layout Plain Layout
18446 \begin_inset space \thinspace{}
18452 \begin_inset Flex Code
18455 \begin_layout Plain Layout
18465 ] Defines whether the float allows to be rotated via the \SpecialChar LaTeX
18472 \begin_inset Flex Code
18475 \begin_layout Plain Layout
18481 if the float does not support this feature.
18484 \begin_layout Description
18485 \begin_inset Flex Code
18488 \begin_layout Plain Layout
18495 \begin_inset Flex Code
18498 \begin_layout Plain Layout
18507 \begin_inset space \thinspace{}
18513 \begin_inset Flex Code
18516 \begin_layout Plain Layout
18526 ] Defines whether the float has a starred variant that spans columns in
18527 a two column paragraph.
18529 \begin_inset Flex Code
18532 \begin_layout Plain Layout
18538 if the float does not support this feature.
18541 \begin_layout Description
18542 \begin_inset Flex Code
18545 \begin_layout Plain Layout
18552 \begin_inset Flex Code
18555 \begin_layout Plain Layout
18562 \begin_inset Quotes erd
18566 \begin_inset Quotes erd
18569 ] The file name extension of an auxiliary file for the list of figures (or
18572 writes the captions to this file.
18575 \begin_layout Description
18576 \begin_inset Flex Code
18579 \begin_layout Plain Layout
18586 \begin_inset Flex Code
18589 \begin_layout Plain Layout
18596 \begin_inset Quotes erd
18600 \begin_inset Quotes erd
18603 ] The string that will be used in the menus and also for the caption.
18604 This is translated to the current language if babel is used.
18607 \begin_layout Description
18608 \begin_inset Flex Code
18611 \begin_layout Plain Layout
18617 These tags control the XHTML output.
18619 \begin_inset CommandInset ref
18621 reference "sec:Tags-for-XHTML"
18628 \begin_layout Description
18629 \begin_inset Flex Code
18632 \begin_layout Plain Layout
18641 \begin_inset Flex Code
18644 \begin_layout Plain Layout
18653 \begin_inset space \thinspace{}
18657 \begin_inset Flex Code
18660 \begin_layout Plain Layout
18666 ] Indicates whether the float is already defined in the document class or
18667 if instead the \SpecialChar LaTeX
18669 \begin_inset Flex Code
18672 \begin_layout Plain Layout
18678 needs to be loaded to define it on-the-fly.
18680 \begin_inset Flex Code
18683 \begin_layout Plain Layout
18690 \begin_inset Flex Code
18693 \begin_layout Plain Layout
18700 It should be set to
18701 \begin_inset Flex Code
18704 \begin_layout Plain Layout
18710 if the float is already defined by the \SpecialChar LaTeX
18714 \begin_layout Description
18715 \begin_inset Flex Code
18718 \begin_layout Plain Layout
18725 \begin_inset Flex Code
18728 \begin_layout Plain Layout
18735 \begin_inset Quotes erd
18739 \begin_inset Quotes erd
18742 ] The command used to generate a list of floats of this type; the leading
18751 \begin_inset Flex Code
18754 \begin_layout Plain Layout
18760 is false, since there is no standard way to generate this command.
18762 \begin_inset Flex Code
18765 \begin_layout Plain Layout
18771 is true, since in that case there is a standard way to define the command.
18774 \begin_layout Description
18775 \begin_inset Flex Code
18778 \begin_layout Plain Layout
18785 \begin_inset Flex Code
18788 \begin_layout Plain Layout
18795 \begin_inset Quotes erd
18799 \begin_inset Quotes erd
18802 ] A title for a list of floats of this kind (list of figures, tables, or
18804 It is used for the screen label within \SpecialChar LyX
18805 , it is used by \SpecialChar LaTeX
18807 it is used as the title in the XHTML output.
18808 It will be translated to the document language.
18811 \begin_layout Description
18812 \begin_inset Flex Code
18815 \begin_layout Plain Layout
18822 \begin_inset Flex Code
18825 \begin_layout Plain Layout
18832 \begin_inset Quotes erd
18836 \begin_inset Quotes erd
18839 ] This (optional) argument determines whether floats of this class will
18840 be numbered within some sectional unit of the document.
18842 \begin_inset Flex Code
18845 \begin_layout Plain Layout
18852 \begin_inset Quotes eld
18856 \begin_inset Flex Code
18859 \begin_layout Plain Layout
18866 \begin_inset Quotes erd
18869 , the floats will be numbered within chapters.
18873 \begin_layout Description
18874 \begin_inset Flex Code
18877 \begin_layout Plain Layout
18884 \begin_inset Flex Code
18887 \begin_layout Plain Layout
18894 \begin_inset Quotes erd
18898 \begin_inset Quotes erd
18901 ] The default placement for the given class of floats.
18902 The string should be as in standard \SpecialChar LaTeX
18904 \begin_inset Flex Code
18907 \begin_layout Plain Layout
18914 \begin_inset Flex Code
18917 \begin_layout Plain Layout
18924 \begin_inset Flex Code
18927 \begin_layout Plain Layout
18934 \begin_inset Flex Code
18937 \begin_layout Plain Layout
18943 for top, bottom, page, and here, respectively.
18947 \begin_layout Plain Layout
18948 Note that the order of these letters in the string is irrelevant, like in
18955 On top of that there is a new type,
18956 \begin_inset Flex Code
18959 \begin_layout Plain Layout
18965 , which does not really correspond to a float, since it means: put it
18966 \begin_inset Quotes eld
18970 \begin_inset Quotes erd
18974 Note however that the
18975 \begin_inset Flex Code
18978 \begin_layout Plain Layout
18984 specifier is special and, because of implementation details, cannot be
18985 used in non-built in float types.
18986 If you do not understand what this means, just use
18987 \begin_inset Quotes eld
18991 \begin_inset Flex Code
18994 \begin_layout Plain Layout
19001 \begin_inset Quotes erd
19007 \begin_layout Description
19008 \begin_inset Flex Code
19011 \begin_layout Plain Layout
19018 \begin_inset Flex Code
19021 \begin_layout Plain Layout
19027 ] The prefix to use when creating labels referring to floats of this type.
19028 This allows the use of formatted references.
19029 Note that you can remove any
19030 \begin_inset Flex Code
19033 \begin_layout Plain Layout
19039 set by a copied style by using the special value
19040 \begin_inset Quotes eld
19044 \begin_inset Quotes erd
19047 , which must be all caps.
19048 \change_inserted -712698321 1565605014
19052 \begin_layout Description
19054 \change_inserted -712698321 1565605014
19055 \begin_inset Flex Code
19058 \begin_layout Plain Layout
19060 \change_inserted -712698321 1565605014
19069 \begin_inset Flex Code
19072 \begin_layout Plain Layout
19074 \change_inserted -712698321 1565605014
19082 ] As with paragraph styles, see
19083 \begin_inset CommandInset ref
19085 reference "subsec:Paragraph-Styles"
19094 \begin_layout Description
19095 \begin_inset Flex Code
19098 \begin_layout Plain Layout
19105 \begin_inset Flex Code
19108 \begin_layout Plain Layout
19115 \begin_inset Quotes erd
19119 \begin_inset Quotes erd
19122 ] The style used when defining the float using
19123 \begin_inset Flex Code
19126 \begin_layout Plain Layout
19137 \begin_layout Description
19138 \begin_inset Flex Code
19141 \begin_layout Plain Layout
19148 \begin_inset Flex Code
19151 \begin_layout Plain Layout
19158 \begin_inset Quotes erd
19162 \begin_inset Quotes erd
19166 \begin_inset Quotes eld
19170 \begin_inset Quotes erd
19173 of the new class of floats, like program or algorithm.
19174 After the appropriate
19175 \begin_inset Flex Code
19178 \begin_layout Plain Layout
19187 \begin_inset Flex Code
19190 \begin_layout Plain Layout
19199 \begin_inset Flex Code
19202 \begin_layout Plain Layout
19213 \begin_layout Description
19214 \begin_inset Flex Code
19217 \begin_layout Plain Layout
19224 \begin_inset Flex Code
19227 \begin_layout Plain Layout
19234 \begin_inset space \thinspace{}
19238 \begin_inset Flex Code
19241 \begin_layout Plain Layout
19249 ] Specifies whether this float is defined using the \SpecialChar LaTeX
19251 \begin_inset Flex Code
19254 \begin_layout Plain Layout
19260 , either by the class file, another package or on-the-fly by \SpecialChar LyX
19264 \begin_layout Standard
19265 Note that defining a float with type
19266 \begin_inset Flex Code
19269 \begin_layout Plain Layout
19277 automatically defines the corresponding counter with name
19278 \begin_inset Flex Code
19281 \begin_layout Plain Layout
19292 \begin_layout Subsection
19293 Flex insets and InsetLayout
19294 \begin_inset CommandInset label
19296 name "subsec:Flex-insets-and"
19303 \begin_layout Standard
19304 Flex insets come in
19305 \change_deleted 5863208 1594239511
19307 \change_inserted 5863208 1594239512
19313 \begin_layout Itemize
19315 \begin_inset Flex Code
19318 \begin_layout Plain Layout
19324 ): These define semantic markup corresponding to such \SpecialChar LaTeX
19326 \begin_inset Flex Code
19329 \begin_layout Plain Layout
19338 \begin_inset Flex Code
19341 \begin_layout Plain Layout
19352 \begin_layout Itemize
19354 \begin_inset Flex Code
19357 \begin_layout Plain Layout
19363 ): These can be used to define custom collapsible insets, similar to \SpecialChar TeX
19365 footnote, and the like.
19366 An obvious example is an endnote inset, which is defined in the
19367 \begin_inset Flex Code
19370 \begin_layout Plain Layout
19379 \begin_layout Itemize
19381 \change_deleted 5863208 1594239528
19383 \begin_inset Flex Code
19386 \begin_layout Plain Layout
19392 ): For use with DocBook classes.
19397 \begin_layout Standard
19398 Flex insets are defined using the
19399 \begin_inset Flex Code
19402 \begin_layout Plain Layout
19408 tag, which shall be explained in a moment.
19411 \begin_layout Standard
19413 \begin_inset Flex Code
19416 \begin_layout Plain Layout
19422 tag also serves another function: It can be used to customize the general
19423 layout of many different types of insets.
19425 \begin_inset Flex Code
19428 \begin_layout Plain Layout
19434 can be used to customize the layout parameters for footnotes, marginal
19435 notes, note insets, \SpecialChar TeX
19436 code (ERT) insets, branches, listings, indexes, boxes,
19437 tables, algorithms, URLs, and captions, as well as to define Flex insets.
19440 \begin_layout Standard
19442 \begin_inset Flex Code
19445 \begin_layout Plain Layout
19451 definition must begin with a line of the form:
19454 \begin_layout LyX-Code
19458 \begin_layout Standard
19460 \begin_inset Flex Code
19463 \begin_layout Plain Layout
19469 indicates the inset whose layout is being defined, and here there are four
19473 \begin_layout Enumerate
19474 The layout for a pre-existing inset is being modified.
19475 In this case, can be
19476 \begin_inset Flex Code
19479 \begin_layout Plain Layout
19485 any one of the following:
19486 \begin_inset Flex Code
19489 \begin_layout Plain Layout
19496 \begin_inset Flex Code
19499 \begin_layout Plain Layout
19506 \begin_inset Flex Code
19509 \begin_layout Plain Layout
19516 \begin_inset Flex Code
19519 \begin_layout Plain Layout
19526 \begin_inset Flex Code
19529 \begin_layout Plain Layout
19536 \begin_inset Flex Code
19539 \begin_layout Plain Layout
19546 \begin_inset Flex Code
19549 \begin_layout Plain Layout
19556 \begin_inset Flex Code
19559 \begin_layout Plain Layout
19566 \begin_inset Flex Code
19569 \begin_layout Plain Layout
19576 \begin_inset Flex Code
19579 \begin_layout Plain Layout
19586 \begin_inset Flex Code
19589 \begin_layout Plain Layout
19596 \begin_inset Flex Code
19599 \begin_layout Plain Layout
19606 \begin_inset Flex Code
19609 \begin_layout Plain Layout
19616 \begin_inset Flex Code
19619 \begin_layout Plain Layout
19626 \begin_inset Flex Code
19629 \begin_layout Plain Layout
19636 \begin_inset Flex Code
19639 \begin_layout Plain Layout
19646 \begin_inset Flex Code
19649 \begin_layout Plain Layout
19656 \begin_inset Flex Code
19659 \begin_layout Plain Layout
19666 \begin_inset Flex Code
19669 \begin_layout Plain Layout
19676 \begin_inset Flex Code
19679 \begin_layout Plain Layout
19688 \begin_layout Enumerate
19689 The layout for a Flex inset is being defined.
19691 \begin_inset Flex Code
19694 \begin_layout Plain Layout
19700 must be of the form
19701 \begin_inset Quotes eld
19705 \begin_inset Flex Code
19708 \begin_layout Plain Layout
19715 \begin_inset Quotes erd
19719 \begin_inset Flex Code
19722 \begin_layout Plain Layout
19728 may be any valid identifier not used by a pre-existing Flex inset.
19729 The identifier may include spaces, but in that case the whole thing must
19730 be wrapped in quotes.
19731 Note that the definition of a flex inset
19736 \begin_inset Flex Code
19739 \begin_layout Plain Layout
19745 entry, declaring which type of inset it defines.
19748 \begin_layout Enumerate
19749 The layout for user specific branch is being defined.
19751 \begin_inset Flex Code
19754 \begin_layout Plain Layout
19760 must be of the form
19761 \begin_inset Quotes eld
19765 \begin_inset Flex Code
19768 \begin_layout Plain Layout
19775 \begin_inset Quotes erd
19779 \begin_inset Flex Code
19782 \begin_layout Plain Layout
19788 may be any valid identifier of branch defined in user's document.
19789 The identifier may include spaces, but in that case the whole thing must
19790 be wrapped in quotes.
19791 The main purpose of this feature is to allow \SpecialChar LaTeX
19792 wrapping around specific
19793 branches as user needs.
19796 \begin_layout Enumerate
19797 The layout of a user (or class) specific caption is being defined.
19799 \begin_inset Flex Code
19802 \begin_layout Plain Layout
19808 must be of the form
19809 \begin_inset Quotes eld
19813 \begin_inset Flex Code
19816 \begin_layout Plain Layout
19823 \begin_inset Quotes erd
19827 \begin_inset Flex Code
19830 \begin_layout Plain Layout
19836 specifies the name of the caption as it appears in the menu.
19837 Have a look at the standard caption (
19838 \begin_inset Flex Code
19841 \begin_layout Plain Layout
19847 ), the specific captions of the KOMA-Script classes (
19848 \begin_inset Flex Code
19851 \begin_layout Plain Layout
19858 \begin_inset Flex Code
19861 \begin_layout Plain Layout
19870 \begin_inset space ~
19874 \begin_inset Newline linebreak
19880 \begin_inset Flex Code
19883 \begin_layout Plain Layout
19889 ) for applications.
19892 \begin_layout Standard
19894 \begin_inset Flex Code
19897 \begin_layout Plain Layout
19903 definition can contain the following entries:
19906 \begin_layout Description
19907 \begin_inset Flex Code
19910 \begin_layout Plain Layout
19917 \begin_inset Flex Code
19920 \begin_layout Plain Layout
19926 =""] This inset will appear in the table of contents of the given type.
19927 An empty string disables.
19928 See also the OutlinerName and the IsTocCaption commands.
19929 This is only implemented for Flex insets.
19933 \begin_layout Description
19934 \begin_inset Flex Code
19937 \begin_layout Plain Layout
19944 \begin_inset Flex Code
19947 \begin_layout Plain Layout
19953 ] Defines argument number of a command\SpecialChar breakableslash
19954 environment associated with the current
19956 The definition must end with
19957 \begin_inset Flex Code
19960 \begin_layout Plain Layout
19968 \begin_inset CommandInset ref
19970 reference "subsec:Paragraph-Styles"
19977 \begin_layout Description
19978 \begin_inset Flex Code
19981 \begin_layout Plain Layout
19987 Preamble for changing language commands; see
19988 \begin_inset CommandInset ref
19990 reference "subsec:I18n"
19997 \begin_layout Description
19998 \begin_inset Flex Code
20001 \begin_layout Plain Layout
20008 \begin_inset Flex Code
20011 \begin_layout Plain Layout
20017 ] The color for the inset's background.
20019 \begin_inset CommandInset ref
20021 reference "chap:Names-of-colors"
20025 for a list of the available color names.
20028 \begin_layout Description
20029 \begin_inset Flex Code
20032 \begin_layout Plain Layout
20039 \begin_inset Flex Code
20042 \begin_layout Plain Layout
20051 \begin_inset space \thinspace{}
20055 \begin_inset Flex Code
20058 \begin_layout Plain Layout
20064 ] Whether to use the content of the inset as the label, when the inset is
20069 \begin_layout Description
20070 \begin_inset Flex Code
20073 \begin_layout Plain Layout
20080 \begin_inset Flex Code
20083 \begin_layout Plain Layout
20089 ] As with paragraph styles, see
20090 \begin_inset CommandInset ref
20092 reference "subsec:Paragraph-Styles"
20097 Note that you need to specify the complete type, e.
20098 \begin_inset space \thinspace{}
20102 \begin_inset space ~
20106 \begin_inset Flex Code
20109 \begin_layout Plain Layout
20110 CopyStyle Flex:<name>
20118 \begin_layout Description
20119 \begin_inset Flex Code
20122 \begin_layout Plain Layout
20129 \begin_inset Flex Code
20132 \begin_layout Plain Layout
20141 \begin_inset space \thinspace{}
20145 \begin_inset Flex Code
20148 \begin_layout Plain Layout
20154 ] Indicates whether the user may employ the Paragraph Settings dialog to
20155 customize the paragraph.
20158 \begin_layout Description
20159 \begin_inset Flex Code
20162 \begin_layout Plain Layout
20169 \begin_inset Flex Code
20172 \begin_layout Plain Layout
20179 \begin_inset Flex Code
20182 \begin_layout Plain Layout
20189 \begin_inset Flex Code
20192 \begin_layout Plain Layout
20198 , describing the rendering style used for the inset's frame and buttons.
20199 Footnotes generally use
20200 \begin_inset Flex Code
20203 \begin_layout Plain Layout
20209 , ERT insets generally
20210 \begin_inset Flex Code
20213 \begin_layout Plain Layout
20219 , and character styles
20220 \begin_inset Flex Code
20223 \begin_layout Plain Layout
20232 \begin_layout Description
20233 \begin_inset Flex Code
20236 \begin_layout Plain Layout
20243 \begin_inset Flex Code
20246 \begin_layout Plain Layout
20255 \begin_inset space \thinspace{}
20261 \begin_inset Flex Code
20264 \begin_layout Plain Layout
20273 \begin_inset Flex Code
20276 \begin_layout Plain Layout
20283 \begin_inset Flex Code
20286 \begin_layout Plain Layout
20293 Indicates whether the environment will stand on its own in the output or
20294 will appear inline with the surrounding text.
20295 If set to false, it is supposed that the \SpecialChar LaTeX
20296 environment ignores white space
20297 (including one newline character) after the
20298 \begin_inset Flex Code
20301 \begin_layout Plain Layout
20314 \begin_inset Flex Code
20317 \begin_layout Plain Layout
20331 \change_inserted 731793113 1538674858
20335 \begin_layout Description
20337 \change_inserted 731793113 1538674891
20338 \begin_inset Flex Code
20341 \begin_layout Plain Layout
20343 \change_inserted 731793113 1538674863
20355 ,1] Allow the contents of the inset to be edited externally (using whatever
20356 editor is defined for the document's output format).
20361 \begin_layout Description
20362 \begin_inset Flex Code
20365 \begin_layout Plain Layout
20371 Required at the end of the
20372 \begin_inset Flex Code
20375 \begin_layout Plain Layout
20384 \begin_layout Description
20385 \begin_inset Flex Code
20388 \begin_layout Plain Layout
20394 The font used for both the text body
20400 \begin_inset CommandInset ref
20402 reference "subsec:Font-description"
20407 Note that defining this font automatically defines the
20408 \begin_inset Flex Code
20411 \begin_layout Plain Layout
20417 to the same value, so define this first and define
20418 \begin_inset Flex Code
20421 \begin_layout Plain Layout
20427 later if you want them to be different.
20430 \begin_layout Description
20431 \begin_inset Flex Code
20434 \begin_layout Plain Layout
20435 FixedWidthPreambleEncoding
20441 \begin_inset Flex Code
20444 \begin_layout Plain Layout
20453 \begin_inset space \thinspace{}
20457 \begin_inset Flex Code
20460 \begin_layout Plain Layout
20466 ] Force a fixed width encoding for the translated contents of
20467 \begin_inset Flex Code
20470 \begin_layout Plain Layout
20477 \begin_inset Flex Code
20480 \begin_layout Plain Layout
20486 code generated by this layout.
20487 This is needed for special \SpecialChar LaTeX
20492 that do not work with variable width encodings such as
20497 This setting is ignored if fully Unicode aware \SpecialChar LaTeX
20498 backends such as Xe\SpecialChar TeX
20500 Lua\SpecialChar TeX
20504 \begin_layout Description
20505 \begin_inset Flex Code
20508 \begin_layout Plain Layout
20509 ForceLocalFontSwitch
20515 \begin_inset Flex Code
20518 \begin_layout Plain Layout
20527 \begin_inset space \thinspace{}
20531 \begin_inset Flex Code
20534 \begin_layout Plain Layout
20540 ] When using babel, always use a local font switch (
20541 \begin_inset Flex Code
20544 \begin_layout Plain Layout
20552 ), never a global one (such as
20553 \begin_inset Flex Code
20556 \begin_layout Plain Layout
20567 \begin_layout Description
20568 \begin_inset Flex Code
20571 \begin_layout Plain Layout
20578 \begin_inset Flex Code
20581 \begin_layout Plain Layout
20590 \begin_inset space \thinspace{}
20594 \begin_inset Flex Code
20597 \begin_layout Plain Layout
20604 \begin_inset Quotes eld
20608 \begin_inset Quotes erd
20611 language, leading to Left-to-Right (Latin) output, e.
20612 \begin_inset space \thinspace{}
20616 \begin_inset space \space{}
20619 in \SpecialChar TeX
20624 \begin_layout Description
20625 \begin_inset Flex Code
20628 \begin_layout Plain Layout
20635 \begin_inset Flex Code
20638 \begin_layout Plain Layout
20647 \begin_inset space \thinspace{}
20651 \begin_inset Flex Code
20654 \begin_layout Plain Layout
20660 ] Force a line break in the \SpecialChar LaTeX
20661 output before the inset starts and after the
20663 This assures the inset itself is output on its own lines, for parsing purposes.
20666 \begin_layout Description
20667 \begin_inset Flex Code
20670 \begin_layout Plain Layout
20677 \begin_inset Flex Code
20680 \begin_layout Plain Layout
20689 \begin_inset space \thinspace{}
20693 \begin_inset Flex Code
20696 \begin_layout Plain Layout
20702 ] Indicates whether the
20703 \begin_inset Flex Code
20706 \begin_layout Plain Layout
20712 should be used or, instead, the user can change the paragraph style used
20717 \begin_layout Description
20718 \begin_inset Flex Code
20721 \begin_layout Plain Layout
20728 \begin_inset Flex Code
20731 \begin_layout Plain Layout
20740 \begin_inset space \thinspace{}
20744 \begin_inset Flex Code
20747 \begin_layout Plain Layout
20753 ] As with paragraph styles, see
20754 \begin_inset CommandInset ref
20756 reference "subsec:Paragraph-Styles"
20763 \begin_layout Description
20764 \begin_inset Flex Code
20767 \begin_layout Plain Layout
20773 These tags control the XHTML output.
20775 \begin_inset CommandInset ref
20777 reference "sec:Tags-for-XHTML"
20784 \begin_layout Description
20785 \begin_inset Flex Code
20788 \begin_layout Plain Layout
20795 \begin_inset Flex Code
20798 \begin_layout Plain Layout
20807 \begin_inset space \thinspace{}
20811 \begin_inset Flex Code
20814 \begin_layout Plain Layout
20820 ] Whether to include the contents of this inset in the strings generated
20821 for the `Outline' pane for all table of contents, regardless of the AddToToc
20823 One would not, for example, want the content of a footnote in a section
20824 header to be included in the TOC displayed in the outline, but one would
20825 normally want the content of a character style displayed.
20826 Default is false: not to include.
20829 \begin_layout Description
20830 \begin_inset Flex Code
20833 \begin_layout Plain Layout
20840 \begin_inset Flex Code
20843 \begin_layout Plain Layout
20852 \begin_inset space \thinspace{}
20856 \begin_inset Flex Code
20859 \begin_layout Plain Layout
20865 ] If this is set to 1 and AddToToc is enabled, the inset adds a summary
20866 of its contents in its item in the table of contents.
20867 Otherwise, only the label appears.
20870 \begin_layout Description
20871 \begin_inset Flex Code
20874 \begin_layout Plain Layout
20883 \begin_inset Flex Code
20886 \begin_layout Plain Layout
20895 \begin_inset space \thinspace{}
20899 \begin_inset Flex Code
20902 \begin_layout Plain Layout
20908 ] As with paragraph styles, see
20909 \begin_inset CommandInset ref
20911 reference "subsec:Paragraph-Styles"
20918 \begin_layout Description
20919 \begin_inset Flex Code
20922 \begin_layout Plain Layout
20928 The font used for the label.
20930 \begin_inset CommandInset ref
20932 reference "subsec:Font-description"
20937 Note that this definition can never appear before
20938 \begin_inset Flex Code
20941 \begin_layout Plain Layout
20947 , lest it be ineffective.
20950 \begin_layout Description
20951 \begin_inset Flex Code
20954 \begin_layout Plain Layout
20961 \begin_inset Flex Code
20964 \begin_layout Plain Layout
20971 \begin_inset Quotes erd
20975 \begin_inset Quotes erd
20978 ] What will be displayed on the button or elsewhere as the inset label.
20980 \begin_inset Flex Code
20983 \begin_layout Plain Layout
20991 \begin_inset Flex Code
20994 \begin_layout Plain Layout
21000 ) modify this label on the fly.
21003 \begin_layout Description
21004 \begin_inset Flex Code
21007 \begin_layout Plain Layout
21013 Language dependent preamble; see
21014 \begin_inset CommandInset ref
21016 reference "subsec:I18n"
21023 \begin_layout Description
21024 \begin_inset Flex Code
21027 \begin_layout Plain Layout
21034 \begin_inset Flex Code
21037 \begin_layout Plain Layout
21043 ] The name of the corresponding \SpecialChar LaTeX
21045 Either the environment or command name.
21048 \begin_layout Description
21049 \begin_inset Flex Code
21052 \begin_layout Plain Layout
21059 \begin_inset Flex Code
21062 \begin_layout Plain Layout
21068 ] The optional parameter for the corresponding
21069 \begin_inset Flex Code
21072 \begin_layout Plain Layout
21078 stuff, including possible bracket pairs like
21079 \begin_inset Flex Code
21082 \begin_layout Plain Layout
21089 This parameter cannot be changed from within \SpecialChar LyX
21091 \begin_inset Flex Code
21094 \begin_layout Plain Layout
21100 for customizable parameters).
21101 It will be output as is after all \SpecialChar LaTeX
21103 \begin_inset Flex Code
21106 \begin_layout Plain Layout
21115 \begin_layout Description
21116 \begin_inset Flex Code
21119 \begin_layout Plain Layout
21126 \begin_inset Flex Code
21129 \begin_layout Plain Layout
21130 Command, Environment, None
21135 ] How the style should be translated into \SpecialChar LaTeX
21140 \begin_layout Plain Layout
21141 \begin_inset Flex Code
21144 \begin_layout Plain Layout
21150 is perhaps a bit misleading, since these rules apply to SGML classes too.
21151 Visit the SGML class files for specific examples.
21160 \begin_layout Description
21161 \begin_inset Flex Code
21164 \begin_layout Plain Layout
21170 means nothing special
21173 \begin_layout Description
21174 \begin_inset Flex Code
21177 \begin_layout Plain Layout
21184 \begin_inset Flex Code
21187 \begin_layout Plain Layout
21194 {\SpecialChar ldots
21203 \begin_layout Description
21204 \begin_inset Flex Code
21207 \begin_layout Plain Layout
21214 \begin_inset Flex Code
21217 \begin_layout Plain Layout
21224 }\SpecialChar ldots
21239 \begin_layout Standard
21240 Putting the last few things together, the \SpecialChar LaTeX
21241 output will be either:
21244 \begin_layout LyX-Code
21247 LatexName[LatexParam]{\SpecialChar ldots
21251 \begin_layout Standard
21255 \begin_layout LyX-Code
21258 begin{LatexName}[LatexParam] \SpecialChar ldots
21264 \begin_layout Standard
21265 depending upon the \SpecialChar LaTeX
21270 \begin_layout Description
21271 \begin_inset Flex Code
21274 \begin_layout Plain Layout
21281 \begin_inset Flex Code
21284 \begin_layout Plain Layout
21290 ] A string that is put at the beginning of the layout content.
21291 A line break in the output can be indicated by
21292 \begin_inset Flex Code
21295 \begin_layout Plain Layout
21304 \begin_layout Description
21305 \begin_inset Flex Code
21308 \begin_layout Plain Layout
21315 \begin_inset Flex Code
21318 \begin_layout Plain Layout
21325 \begin_inset Flex Code
21328 \begin_layout Plain Layout
21335 \begin_inset Flex Code
21338 \begin_layout Plain Layout
21345 \begin_inset Flex Code
21348 \begin_layout Plain Layout
21354 (indicating a dummy definition ending definitions of charstyles, etc).
21355 This entry is required in and is only meaningful for Flex insets.
21356 Among other things, it determines on which menu this inset will appear.
21358 \begin_inset Flex Code
21361 \begin_layout Plain Layout
21368 \begin_inset Flex Code
21371 \begin_layout Plain Layout
21377 will automatically set
21378 \begin_inset Flex Code
21381 \begin_layout Plain Layout
21388 \begin_inset Flex Code
21391 \begin_layout Plain Layout
21399 \begin_inset Flex Code
21402 \begin_layout Plain Layout
21408 can be set to true, or
21409 \begin_inset Flex Code
21412 \begin_layout Plain Layout
21419 \begin_inset Flex Code
21422 \begin_layout Plain Layout
21428 insets by setting it
21433 \begin_inset Flex Code
21436 \begin_layout Plain Layout
21443 \change_inserted -712698321 1555575738
21447 \begin_layout Description
21449 \change_inserted -712698321 1555575844
21450 \begin_inset Flex Code
21453 \begin_layout Plain Layout
21455 \change_inserted -712698321 1555575740
21464 \begin_inset Flex Code
21467 \begin_layout Plain Layout
21469 \change_inserted -712698321 1555575740
21477 A dedicated string for the menu.
21478 You can define an accelerator by appending the respective character to
21479 the string, divided by
21480 \begin_inset Quotes eld
21484 \begin_inset Quotes erd
21488 \begin_inset space \thinspace{}
21492 \begin_inset space \space{}
21496 \begin_inset Quotes eld
21500 \begin_inset Flex Code
21503 \begin_layout Plain Layout
21505 \change_inserted -712698321 1555575781
21514 \begin_inset Quotes erd
21518 This specification is optional.
21519 If it is not given the inset name as specified in the type declaration
21520 will be used instead for the menu.
21525 \begin_layout Description
21526 \begin_inset Flex Code
21529 \begin_layout Plain Layout
21536 \begin_inset Flex Code
21539 \begin_layout Plain Layout
21548 \begin_inset space \thinspace{}
21552 \begin_inset Flex Code
21555 \begin_layout Plain Layout
21561 ] Whether multiple paragraphs are permitted in this inset.
21563 \begin_inset Flex Code
21566 \begin_layout Plain Layout
21572 to the same value and
21573 \begin_inset Flex Code
21576 \begin_layout Plain Layout
21582 to the opposite value.
21583 These can be reset to other values, if they are used
21588 \begin_inset Flex Code
21591 \begin_layout Plain Layout
21601 \begin_layout Description
21602 \begin_inset Flex Code
21605 \begin_layout Plain Layout
21612 \begin_inset Flex Code
21615 \begin_layout Plain Layout
21624 \begin_inset space \thinspace{}
21628 \begin_inset Flex Code
21631 \begin_layout Plain Layout
21637 ] Whether fragile commands in this inset should be
21638 \begin_inset Flex Code
21641 \begin_layout Plain Layout
21654 whether the command should itself be protected.) Default is false.
21655 \change_inserted -712698321 1523633958
21659 \begin_layout Description
21661 \change_inserted -712698321 1552395786
21662 \begin_inset Flex Code
21665 \begin_layout Plain Layout
21667 \change_inserted -712698321 1523633961
21676 \begin_inset Flex Code
21679 \begin_layout Plain Layout
21681 \change_inserted -712698321 1523633958
21692 \begin_inset space \thinspace{}
21696 \begin_inset Flex Code
21699 \begin_layout Plain Layout
21701 \change_inserted -712698321 1523633958
21709 ] This causes macros that contain this inset to be protected with
21710 \begin_inset Flex Code
21713 \begin_layout Plain Layout
21715 \change_inserted -712698321 1523634038
21730 ) if necessary and thus allows (some) verbatim stuff in macros.
21734 \begin_layout Description
21736 \change_inserted -712698321 1555579651
21737 \begin_inset Flex Code
21740 \begin_layout Plain Layout
21742 \change_inserted -712698321 1552395787
21751 \begin_inset Flex Code
21754 \begin_layout Plain Layout
21756 \change_inserted -712698321 1552395787
21767 \begin_inset space \thinspace{}
21771 \begin_inset Flex Code
21774 \begin_layout Plain Layout
21776 \change_inserted -712698321 1552395787
21784 ] Whether specific commands in this inset (such as
21785 \begin_inset Flex Code
21788 \begin_layout Plain Layout
21790 \change_inserted -712698321 1552395787
21801 \begin_inset Flex Code
21804 \begin_layout Plain Layout
21806 \change_inserted -712698321 1552395787
21816 ) should be protected in an
21817 \begin_inset Flex Code
21820 \begin_layout Plain Layout
21822 \change_inserted -712698321 1552395787
21833 This is particularly needed for insets that draw on
21841 commands which parse their content in complex ways.
21845 \begin_layout Description
21847 \change_inserted -712698321 1555579742
21848 \begin_inset Flex Code
21851 \begin_layout Plain Layout
21853 \change_inserted -712698321 1555579658
21862 \begin_inset Flex Code
21865 \begin_layout Plain Layout
21867 \change_inserted -712698321 1555579651
21875 Option to define a different command (from the default
21876 \begin_inset Flex Code
21879 \begin_layout Plain Layout
21881 \change_inserted -712698321 1555579742
21893 ) to be used for line breaks.
21894 The initial backslash must not be specified.
21899 \begin_layout Description
21900 \begin_inset Flex Code
21903 \begin_layout Plain Layout
21910 \begin_inset Flex Code
21913 \begin_layout Plain Layout
21919 ] Deletes an existing
21920 \begin_inset Flex Code
21923 \begin_layout Plain Layout
21932 \begin_layout Description
21933 \begin_inset Flex Code
21936 \begin_layout Plain Layout
21943 \begin_inset Flex Code
21946 \begin_layout Plain Layout
21953 \begin_inset Flex Code
21956 \begin_layout Plain Layout
21962 that has replaced this
21963 \begin_inset Flex Code
21966 \begin_layout Plain Layout
21973 This is used to rename an
21974 \begin_inset Flex Code
21977 \begin_layout Plain Layout
21983 , while keeping backward compatibility.
21984 \change_inserted -712698321 1559491850
21988 \begin_layout Description
21990 \change_inserted -712698321 1559492002
21991 \begin_inset Flex Code
21994 \begin_layout Plain Layout
21996 \change_inserted -712698321 1559491854
22005 \begin_inset Flex Code
22008 \begin_layout Plain Layout
22010 \change_inserted -712698321 1559491850
22021 \begin_inset space \thinspace{}
22025 \begin_inset Flex Code
22028 \begin_layout Plain Layout
22030 \change_inserted -712698321 1559491850
22038 ] If this is set to
22039 \begin_inset Flex Code
22042 \begin_layout Plain Layout
22044 \change_inserted -712698321 1559491881
22052 , paragraph breaks will be ignored in the output.
22053 This might be useful for insets where the content should be alignable on
22054 different lines only in the \SpecialChar LyX
22055 workarea, without any effect in the output.
22060 \begin_layout Description
22061 \begin_inset Flex Code
22064 \begin_layout Plain Layout
22071 \begin_inset Flex Code
22074 \begin_layout Plain Layout
22083 \begin_inset space \thinspace{}
22087 \begin_inset Flex Code
22090 \begin_layout Plain Layout
22096 ] As with paragraph styles, see
22097 \begin_inset CommandInset ref
22099 reference "subsec:Paragraph-Styles"
22107 \begin_layout Description
22108 \begin_inset Flex Code
22111 \begin_layout Plain Layout
22118 \begin_inset Flex Code
22121 \begin_layout Plain Layout
22130 \begin_inset space \thinspace{}
22134 \begin_inset Flex Code
22137 \begin_layout Plain Layout
22143 ] As with paragraph styles, see
22144 \begin_inset CommandInset ref
22146 reference "subsec:Paragraph-Styles"
22154 \begin_layout Description
22155 \begin_inset Flex Code
22158 \begin_layout Plain Layout
22164 As with paragraph styles, see
22165 \begin_inset CommandInset ref
22167 reference "subsec:Paragraph-Styles"
22174 \begin_layout Description
22175 \begin_inset Flex Code
22178 \begin_layout Plain Layout
22185 \begin_inset Flex Code
22188 \begin_layout Plain Layout
22194 ] The prefix to use when creating labels referring to insets of this type.
22195 This allows the use of formatted references.
22198 \begin_layout Description
22199 \begin_inset Flex Code
22202 \begin_layout Plain Layout
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"
22228 \begin_layout Description
22229 \begin_inset Flex Code
22232 \begin_layout Plain Layout
22239 \begin_inset Flex Code
22242 \begin_layout Plain Layout
22251 \begin_inset space \thinspace{}
22255 \begin_inset Flex Code
22258 \begin_layout Plain Layout
22264 ] Resets the \SpecialChar LaTeX
22265 arguments of this layout (as defined via the
22266 \begin_inset Flex Code
22269 \begin_layout Plain Layout
22276 This is useful if you have copied a style via
22277 \begin_inset Flex Code
22280 \begin_layout Plain Layout
22286 , but you do not want to inherit its (required and optional) arguments.
22289 \begin_layout Description
22290 \begin_inset Flex Code
22293 \begin_layout Plain Layout
22300 \begin_inset Flex Code
22303 \begin_layout Plain Layout
22312 \begin_inset space \thinspace{}
22316 \begin_inset Flex Code
22319 \begin_layout Plain Layout
22326 \change_inserted -712698321 1597733473
22328 \begin_inset Flex Code
22331 \begin_layout Plain Layout
22333 \change_inserted -712698321 1597732178
22341 , font changes are redone inside the respective inset (in the output) even
22342 if the inset itself is in the context of this font changes (e.
22343 \begin_inset space \thinspace{}
22347 \begin_inset Flex Code
22350 \begin_layout Plain Layout
22352 \change_inserted -712698321 1597733683
22355 textbf{Sourrounding text
22359 textbf{content}}\SpecialChar ldots
22368 \begin_inset Flex Code
22371 \begin_layout Plain Layout
22373 \change_inserted -712698321 1597733686
22376 textbf{Sourrounding text
22378 myinset{content}\SpecialChar ldots
22387 Setting this makes sense for commands that internally reset font settings
22389 \begin_inset space \thinspace{}
22393 Note that wrongly setting this might lead to unwanted result (e.
22394 \begin_inset space \thinspace{}
22398 \begin_inset Flex Code
22401 \begin_layout Plain Layout
22403 \change_inserted -712698321 1597733688
22406 emph{Sourrounding text
22410 emph{content}}\SpecialChar ldots
22418 , content is upright, as
22419 \begin_inset Flex Code
22422 \begin_layout Plain Layout
22424 \change_inserted -712698321 1597733278
22436 \change_deleted -712698321 1597733283
22437 Whether this inset should use the font of its surrounding environment or
22442 \change_deleted -712698321 1597733290
22444 \change_inserted -712698321 1597733290
22446 \begin_inset Flex Code
22449 \begin_layout Plain Layout
22451 \change_inserted -712698321 1597733292
22462 \change_deleted -712698321 1597733327
22463 use the font of the surrounding environment
22464 \change_inserted -712698321 1597733343
22465 font changes are not redone inside the inset
22470 \begin_layout Description
22471 \begin_inset Flex Code
22474 \begin_layout Plain Layout
22481 \begin_inset Flex Code
22484 \begin_layout Plain Layout
22490 ] A string that is put at the end of the layout content.
22491 A line break in the output can be indicated by
22492 \begin_inset Flex Code
22495 \begin_layout Plain Layout
22504 \begin_layout Description
22505 \begin_inset Flex Code
22508 \begin_layout Plain Layout
22515 \begin_inset Flex Code
22518 \begin_layout Plain Layout
22525 \begin_inset space \thinspace{}
22529 \begin_inset Flex Code
22532 \begin_layout Plain Layout
22540 ] Allow spell-checking the contents of this inset.
22544 \begin_layout Subsection
22546 \begin_inset CommandInset label
22548 name "subsec:Counters"
22555 \begin_layout Standard
22556 It is necessary to define the counters (
22557 \begin_inset Flex Noun
22560 \begin_layout Plain Layout
22567 \begin_inset Flex Noun
22570 \begin_layout Plain Layout
22576 , \SpecialChar ldots
22577 ) in the text class itself.
22578 The standard counters are defined in the file
22579 \begin_inset Flex Code
22582 \begin_layout Plain Layout
22588 , so you may have to do no more than add
22591 \begin_layout LyX-Code
22592 Input stdcounters.inc
22595 \begin_layout Standard
22596 to your layout file to get them to work.
22597 But if you want to define custom counters, then you can do so.
22598 The counter declaration must begin with:
22601 \begin_layout LyX-Code
22602 Counter CounterName
22605 \begin_layout Standard
22607 \begin_inset Flex Code
22610 \begin_layout Plain Layout
22616 ' is replaced by the name of the counter.
22617 And it must end with
22618 \begin_inset Quotes eld
22622 \begin_inset Flex Code
22625 \begin_layout Plain Layout
22632 \begin_inset Quotes erd
22636 The following parameters can also be used:
22639 \begin_layout Description
22640 \begin_inset Flex Code
22643 \begin_layout Plain Layout
22650 \begin_inset Flex Code
22653 \begin_layout Plain Layout
22659 ] Sets the initial value for the counter, to which it will be reset whenever
22661 Normally, one will want the default, 1.
22664 \begin_layout Description
22665 \begin_inset Flex Code
22668 \begin_layout Plain Layout
22675 \begin_inset Flex Code
22678 \begin_layout Plain Layout
22685 \begin_inset Quotes erd
22689 \begin_inset Quotes erd
22692 ] When defined, this string defines how the counter is displayed.
22693 Setting this value sets
22694 \begin_inset Flex Code
22697 \begin_layout Plain Layout
22698 LabelStringAppendix
22704 The following special constructs can be used in the string:
22708 \begin_layout Itemize
22709 \begin_inset Flex Code
22712 \begin_layout Plain Layout
22720 will be replaced by the expansion of the
22721 \begin_inset Flex Code
22724 \begin_layout Plain Layout
22731 \begin_inset Flex Code
22734 \begin_layout Plain Layout
22735 LabelStringAppendix
22741 \begin_inset Flex Code
22744 \begin_layout Plain Layout
22754 \begin_layout Itemize
22755 counter values can be expressed using \SpecialChar LaTeX
22757 \begin_inset Newline newline
22761 \begin_inset Flex Code
22764 \begin_layout Plain Layout
22781 \begin_inset Flex Code
22784 \begin_layout Plain Layout
22796 \begin_layout Plain Layout
22806 Actually, the situation is a bit more complicated: any
22825 other than those described below will produce arabic numerals.
22826 It would not be surprising to see this change in the future.
22832 \begin_inset Flex Code
22835 \begin_layout Plain Layout
22841 : 1, 2, 3,\SpecialChar ldots
22843 \begin_inset Flex Code
22846 \begin_layout Plain Layout
22852 for lower-case letters: a, b, c, \SpecialChar ldots
22854 \begin_inset Flex Code
22857 \begin_layout Plain Layout
22863 for upper-case letters: A, B, C, \SpecialChar ldots
22865 \begin_inset Flex Code
22868 \begin_layout Plain Layout
22874 for lower-case roman numerals: i, ii, iii, \SpecialChar ldots
22876 \begin_inset Flex Code
22879 \begin_layout Plain Layout
22885 for upper-case roman numerals: I, II, III\SpecialChar ldots
22887 \begin_inset Flex Code
22890 \begin_layout Plain Layout
22896 for hebrew numerals.
22900 \begin_layout Standard
22901 If LabelString is not defined, a default value is constructed as follows:
22902 if the counter has a
22903 \change_deleted 731793113 1604355218
22905 \change_inserted 731793113 1604355221
22909 \begin_inset Flex Code
22912 \begin_layout Plain Layout
22914 \change_deleted 731793113 1604355223
22916 \change_inserted 731793113 1604355226
22925 \begin_inset Flex Code
22928 \begin_layout Plain Layout
22935 \begin_inset Newline newline
22939 \begin_inset Flex Code
22942 \begin_layout Plain Layout
22946 \change_inserted 731793113 1604355228
22948 \change_deleted 731793113 1604355230
22958 is used; otherwise the string
22959 \begin_inset Flex Code
22962 \begin_layout Plain Layout
22973 \begin_layout Description
22974 \begin_inset Flex Code
22977 \begin_layout Plain Layout
22978 LabelStringAppendix
22984 \begin_inset Flex Code
22987 \begin_layout Plain Layout
22994 \begin_inset Quotes eld
22998 \begin_inset Quotes erd
23002 \begin_inset Flex Code
23005 \begin_layout Plain Layout
23011 , but for use in the Appendix.
23012 \change_inserted -584632292 1607202551
23016 \begin_layout Description
23018 \change_inserted -584632292 1607202682
23019 \begin_inset Flex Code
23022 \begin_layout Plain Layout
23029 \begin_inset Flex Code
23032 \begin_layout Plain Layout
23034 \change_inserted -584632292 1607202576
23043 \begin_inset Quotes eld
23047 \begin_inset Quotes erd
23050 ] The counter name as used in \SpecialChar LaTeX
23052 (E.g., in \SpecialChar LyX
23053 , there is a counter named `theorem', but it is output to \SpecialChar LaTeX
23059 \begin_layout Description
23060 \begin_inset Flex Code
23063 \begin_layout Plain Layout
23070 \begin_inset Flex Code
23073 \begin_layout Plain Layout
23080 \begin_inset Quotes erd
23084 \begin_inset Quotes erd
23087 ] A format for use with formatted references to this counter.
23088 For example, one might want to have references to section numbers appear
23090 \begin_inset Quotes eld
23094 \begin_inset Quotes erd
23098 The string should contain
23099 \begin_inset Quotes eld
23103 \begin_inset Quotes erd
23107 This will be replaced by the counter number itself.
23108 So, for sections, it would be: Section ##.
23111 \begin_layout Description
23112 \begin_inset Flex Code
23115 \begin_layout Plain Layout
23122 \begin_inset Flex Code
23125 \begin_layout Plain Layout
23132 \begin_inset Quotes erd
23136 \begin_inset Quotes erd
23139 ] If this is set to the name of another counter, the present counter will
23140 be reset every time the other one is increased.
23142 \begin_inset Flex Code
23145 \begin_layout Plain Layout
23152 \begin_inset Flex Code
23155 \begin_layout Plain Layout
23164 \begin_layout Subsection
23166 \begin_inset CommandInset label
23168 name "subsec:Font-description"
23175 \begin_layout Standard
23176 A font description looks like this:
23179 \begin_layout LyX-Code
23196 \begin_layout LyX-Code
23200 \begin_layout LyX-Code
23204 \begin_layout Standard
23205 The following commands are available:
23208 \begin_layout Description
23209 \begin_inset Flex Code
23212 \begin_layout Plain Layout
23219 \change_deleted -712698321 1607682984
23221 \begin_inset Flex Code
23224 \begin_layout Plain Layout
23233 \begin_inset Flex Code
23236 \begin_layout Plain Layout
23243 \begin_inset Flex Code
23246 \begin_layout Plain Layout
23253 \begin_inset Flex Code
23256 \begin_layout Plain Layout
23263 \begin_inset Flex Code
23266 \begin_layout Plain Layout
23273 \begin_inset Flex Code
23276 \begin_layout Plain Layout
23283 \begin_inset Flex Code
23286 \begin_layout Plain Layout
23293 \begin_inset Flex Code
23296 \begin_layout Plain Layout
23303 \begin_inset Flex Code
23306 \begin_layout Plain Layout
23313 \begin_inset Flex Code
23316 \begin_layout Plain Layout
23323 \begin_inset Flex Code
23326 \begin_layout Plain Layout
23333 \begin_inset Flex Code
23336 \begin_layout Plain Layout
23343 \begin_inset Flex Code
23346 \begin_layout Plain Layout
23353 \begin_inset Flex Code
23356 \begin_layout Plain Layout
23363 \begin_inset Flex Code
23366 \begin_layout Plain Layout
23373 \begin_inset Flex Code
23376 \begin_layout Plain Layout
23383 \begin_inset Flex Code
23386 \begin_layout Plain Layout
23393 \begin_inset Flex Code
23396 \begin_layout Plain Layout
23403 \begin_inset Flex Code
23406 \begin_layout Plain Layout
23413 \begin_inset Flex Code
23416 \begin_layout Plain Layout
23423 \change_inserted -712698321 1607683139
23425 \begin_inset Flex Code
23428 \begin_layout Plain Layout
23430 \change_inserted -712698321 1607683135
23439 \begin_inset space ~
23443 \begin_inset CommandInset ref
23445 reference "chap:Names-of-colors"
23453 \change_deleted -712698321 1607683144
23455 \change_inserted -712698321 1607683146
23461 \begin_layout Description
23462 \begin_inset Flex Code
23465 \begin_layout Plain Layout
23472 \begin_inset Flex Code
23475 \begin_layout Plain Layout
23484 \begin_inset Flex Code
23487 \begin_layout Plain Layout
23494 \begin_inset Flex Code
23497 \begin_layout Plain Layout
23506 \begin_layout Description
23507 \begin_inset Flex Code
23510 \begin_layout Plain Layout
23517 \begin_inset Flex Code
23520 \begin_layout Plain Layout
23526 ] Valid arguments are:
23527 \begin_inset Flex Code
23530 \begin_layout Plain Layout
23537 \begin_inset Flex Code
23540 \begin_layout Plain Layout
23547 \begin_inset Flex Code
23550 \begin_layout Plain Layout
23557 \begin_inset Flex Code
23560 \begin_layout Plain Layout
23567 \begin_inset Flex Code
23570 \begin_layout Plain Layout
23577 \begin_inset Flex Code
23580 \begin_layout Plain Layout
23587 \begin_inset Flex Code
23590 \begin_layout Plain Layout
23597 \begin_inset Flex Code
23600 \begin_layout Plain Layout
23607 \begin_inset Flex Code
23610 \begin_layout Plain Layout
23617 \begin_inset Flex Code
23620 \begin_layout Plain Layout
23627 \begin_inset Flex Code
23630 \begin_layout Plain Layout
23637 \begin_inset Flex Code
23640 \begin_layout Plain Layout
23647 Each of these turns on or off the corresponding attribute.
23649 \begin_inset Flex Code
23652 \begin_layout Plain Layout
23658 turns on emphasis, and
23659 \begin_inset Flex Code
23662 \begin_layout Plain Layout
23670 \begin_inset Newline newline
23673 If the latter seems puzzling, remember that the font settings for the present
23674 context are generally inherited from the surrounding context.
23676 \begin_inset Flex Code
23679 \begin_layout Plain Layout
23685 would turn off the emphasis that was anyway in effect, say, in a theorem
23689 \begin_layout Description
23690 \begin_inset Flex Code
23693 \begin_layout Plain Layout
23700 \begin_inset Flex Code
23703 \begin_layout Plain Layout
23712 \begin_inset Flex Code
23715 \begin_layout Plain Layout
23724 \begin_layout Description
23725 \begin_inset Flex Code
23728 \begin_layout Plain Layout
23735 \begin_inset Flex Code
23738 \begin_layout Plain Layout
23747 \begin_inset Flex Code
23750 \begin_layout Plain Layout
23757 \begin_inset Flex Code
23760 \begin_layout Plain Layout
23767 \begin_inset Flex Code
23770 \begin_layout Plain Layout
23779 \begin_layout Description
23780 \begin_inset Flex Code
23783 \begin_layout Plain Layout
23790 \begin_inset Flex Code
23793 \begin_layout Plain Layout
23800 \begin_inset Flex Code
23803 \begin_layout Plain Layout
23810 \begin_inset Flex Code
23813 \begin_layout Plain Layout
23822 \begin_inset Flex Code
23825 \begin_layout Plain Layout
23832 \begin_inset Flex Code
23835 \begin_layout Plain Layout
23842 \begin_inset Flex Code
23845 \begin_layout Plain Layout
23852 \begin_inset Flex Code
23855 \begin_layout Plain Layout
23862 \begin_inset Flex Code
23865 \begin_layout Plain Layout
23874 \begin_layout Subsection
23875 \begin_inset CommandInset label
23877 name "subsec:Citation-engine-description"
23881 Cite engine description
23884 \begin_layout Standard
23886 \begin_inset Flex Code
23889 \begin_layout Plain Layout
23895 blocks, as used mainly in cite engine files (see
23896 \begin_inset CommandInset ref
23898 reference "subsec:Cite-Engine-Files"
23905 ), define the citation commands provided by a specific
23906 \begin_inset Quotes eld
23910 \begin_inset Quotes erd
23914 A cite engine, in \SpecialChar LyX
23915 terms, is way specific way to format citations, using
23916 numbers, author names and/or years.
23917 Currently, \SpecialChar LyX
23918 supports three such engine types, namely:
23921 \begin_layout Enumerate
23922 \begin_inset Flex Code
23925 \begin_layout Plain Layout
23931 : the default Bib\SpecialChar TeX
23932 way to format citations, a simple numeric style (e.
23933 \begin_inset space \thinspace{}
23937 \begin_inset Quotes eld
23941 \begin_inset Quotes erd
23947 \begin_layout Enumerate
23948 \begin_inset Flex Code
23951 \begin_layout Plain Layout
23957 : Harvard-styled citations using author names and publication year (e.
23958 \begin_inset space \thinspace{}
23962 \begin_inset Quotes eld
23965 Smith and Miller (2017b)
23966 \begin_inset Quotes erd
23972 \begin_layout Enumerate
23973 \begin_inset Flex Code
23976 \begin_layout Plain Layout
23982 : extended numerical citations that also allow for author or title next
23984 \begin_inset space \thinspace{}
23988 \begin_inset Quotes eld
23991 Smith and Miller [1]
23992 \begin_inset Quotes erd
23998 \begin_layout Standard
23999 \begin_inset Flex Code
24002 \begin_layout Plain Layout
24008 blocks look like this:
24011 \begin_layout LyX-Code
24015 \begin_layout LyX-Code
24019 \begin_layout LyX-Code
24023 \begin_layout LyX-Code
24024 citeyearpar[][]=parencite*
24027 \begin_layout LyX-Code
24031 \begin_layout LyX-Code
24035 \begin_layout Standard
24037 \begin_inset Flex Code
24040 \begin_layout Plain Layout
24046 denotes the engine.
24047 The individual lines respectively define a cite command or cite command
24048 paradigm supported by this engine.
24049 The line can be as simple as a cite command that is used both to name the
24050 respective \SpecialChar LyX
24051 command and the \SpecialChar LaTeX
24052 output or more complex in order to differentiate
24054 The full syntax is:
24057 \begin_layout LyX-Code
24058 LyXName|alias$*<!_stardesc!_stardesctooltip>[][]=latexcmd
24061 \begin_layout Itemize
24062 \begin_inset Flex Code
24065 \begin_layout Plain Layout
24071 : The name as used in the
24072 \begin_inset Flex Code
24075 \begin_layout Plain Layout
24085 \begin_layout Standard
24086 For portability reasons, we try to use the same name for same-formatted
24087 commands in different cite packages (thus many names stem from natbib,
24088 and thus we need to differentiate a
24089 \begin_inset Flex Code
24092 \begin_layout Plain Layout
24098 sometimes, if the \SpecialChar LaTeX
24099 command names differ).
24103 \begin_layout Itemize
24104 \begin_inset Flex Code
24107 \begin_layout Plain Layout
24113 : a (comma-separated) list of commands that fall back to the given
24114 \begin_inset Flex Code
24117 \begin_layout Plain Layout
24123 in the current engine.
24124 This eases the switch of citation packages and engines.
24126 \begin_inset Flex Code
24129 \begin_layout Plain Layout
24136 \begin_inset Flex Code
24139 \begin_layout Plain Layout
24145 in layout definitions.
24148 \begin_layout Itemize
24149 \begin_inset Flex Code
24152 \begin_layout Plain Layout
24158 : The actual \SpecialChar LaTeX
24159 command that is output.
24163 \begin_layout Standard
24164 \begin_inset Flex Code
24167 \begin_layout Plain Layout
24174 \begin_inset Flex Code
24177 \begin_layout Plain Layout
24185 \begin_inset Flex Code
24188 \begin_layout Plain Layout
24195 \begin_inset Flex Code
24198 \begin_layout Plain Layout
24204 will be output to \SpecialChar LaTeX
24208 \begin_layout Standard
24212 \begin_layout Itemize
24213 Capitalization indicates that the command also has a capitalized form (
24214 \begin_inset Flex Code
24217 \begin_layout Plain Layout
24227 \begin_inset Flex Code
24230 \begin_layout Plain Layout
24239 These usually enforce up-casing of name prefixes (
24244 \begin_inset Formula $\Rightarrow$
24254 \begin_layout Itemize
24256 \begin_inset Flex Code
24259 \begin_layout Plain Layout
24265 indicate the number of optional arguments (there can be 0–2).
24268 \begin_layout Itemize
24270 \begin_inset Flex Code
24273 \begin_layout Plain Layout
24279 indicates there is a starred version of the command (
24280 \begin_inset Flex Code
24283 \begin_layout Plain Layout
24293 \begin_inset Flex Code
24296 \begin_layout Plain Layout
24309 \begin_layout Standard
24310 By default, the starred version means: Output all authors even if it should
24312 \begin_inset Quotes eld
24316 \begin_inset Quotes erd
24320 \begin_inset Flex Code
24323 \begin_layout Plain Layout
24332 \begin_layout Standard
24333 If the star has a different meaning for a given command, it can be specified
24335 \begin_inset Flex Code
24338 \begin_layout Plain Layout
24339 <!_stardesc!_stardesctooltip>
24345 Maximal two translatable macro keywords, marked by the prefix
24346 \begin_inset Flex Code
24349 \begin_layout Plain Layout
24356 The first points to the string that replaces the
24357 \begin_inset Quotes eld
24361 \begin_inset Quotes erd
24364 checkbox label in the citation dialog, the second one to an optional tool
24365 tip for this checkbox.
24369 \begin_layout Standard
24370 Note that these two macros have to be defined in a
24371 \begin_inset Flex Code
24374 \begin_layout Plain Layout
24380 (see next section), dropping the
24381 \begin_inset Flex Code
24384 \begin_layout Plain Layout
24390 from the prefix, like this:
24393 \begin_layout LyX-Code
24394 _stardesc Sta&rred command label
24397 \begin_layout LyX-Code
24398 _stardesctooltip Tooltip for the starred command checkbox.
24402 \begin_layout Itemize
24404 \begin_inset Flex Code
24407 \begin_layout Plain Layout
24413 indicates that this command features
24414 \begin_inset Quotes eld
24417 qualified citation lists
24418 \begin_inset Quotes erd
24426 -specific feature for multi-reference citations where an individual pre-
24427 and postnote can be given to each reference in the list.
24428 Please refer to the
24432 manual for details.
24433 \change_inserted -712698321 1526898670
24437 \begin_layout Standard
24439 \change_inserted -712698321 1526899524
24440 If you want to add a cite command to a cite engine (e.
24441 \begin_inset space \thinspace{}
24444 g., add a specific command provided by a class), you can use
24445 \begin_inset Flex Code
24448 \begin_layout Plain Layout
24450 \change_inserted -712698321 1526898768
24451 AddToCiteEngine <engine type> \SpecialChar ldots
24460 Note that only cite commands that do not exist yet are added.
24465 \begin_layout Subsection
24466 \begin_inset CommandInset label
24468 name "subsec:Citation-format-description"
24472 Cite format description
24475 \begin_layout Standard
24477 \begin_inset Flex Code
24480 \begin_layout Plain Layout
24486 blocks are used to describe how bibliographic information should be displayed,
24487 both within \SpecialChar LyX
24488 itself (in the citation dialog and in tooltips, for example)
24489 and in XHTML output.
24490 Such a block might look like this:
24493 \begin_layout LyX-Code
24497 \begin_layout LyX-Code
24501 \begin_layout LyX-Code
24505 \begin_layout LyX-Code
24509 \begin_layout Standard
24513 \begin_layout LyX-Code
24517 \begin_layout LyX-Code
24521 \begin_layout LyX-Code
24525 \begin_layout LyX-Code
24529 \begin_layout Standard
24530 In the first case, the individual lines define how the bibliographic information
24531 associated with an article or book, respectively, is to be displayed, and
24532 such a definition can be given for any
24533 \begin_inset Quotes els
24537 \begin_inset Quotes ers
24540 that might be present in a Bib\SpecialChar TeX
24543 defines a default format in the source code that will be used if no specific
24544 definition has been given.
24546 predefines several formats in the file
24547 \begin_inset Flex Code
24550 \begin_layout Plain Layout
24556 , which is included in most of \SpecialChar LyX
24557 's document classes.
24560 \begin_layout Standard
24561 In the second case, the lines define how a specific citation command (in
24563 \begin_inset Flex Code
24566 \begin_layout Plain Layout
24575 \begin_inset Flex Code
24578 \begin_layout Plain Layout
24586 ) is to be displayed on the citation inset label, in the citation dialog,
24587 menu or XHTML output.
24589 defines such formats for the citation style variants it supports via
24591 Document\SpecialChar menuseparator
24592 Setting\SpecialChar menuseparator
24593 Bibliography\SpecialChar ldots
24597 \begin_inset Flex Code
24600 \begin_layout Plain Layout
24606 files that are shipped with \SpecialChar LyX
24608 \begin_inset CommandInset ref
24610 reference "subsec:Cite-Engine-Files"
24620 \begin_layout Standard
24621 The definitions use a simple language that allows Bib\SpecialChar TeX
24622 keys to be replaced
24624 Keys should be enclosed in
24625 \begin_inset Flex Code
24628 \begin_layout Plain Layout
24635 \begin_inset Flex Code
24638 \begin_layout Plain Layout
24645 So a simple definition might look like this:
24648 \begin_layout LyX-Code
24650 \begin_inset Quotes eld
24654 \begin_inset Quotes erd
24660 \begin_layout Standard
24661 This would print the author, followed by a comma, followed by the title,
24662 in quotes, followed by a period.
24665 \begin_layout Standard
24666 Of course, sometimes you may want to print a key only if it exists.
24667 This can be done by using a conditional construction, such as:
24668 \begin_inset Flex Code
24671 \begin_layout Plain Layout
24673 \begin_inset space ~
24683 \begin_inset Flex Code
24686 \begin_layout Plain Layout
24692 key exists, then print
24693 \begin_inset Quotes eld
24697 \begin_inset space ~
24701 \begin_inset Quotes erd
24704 followed by the volume key.
24705 It is also possible to have an else clause in the conditional, such as:
24706 \begin_inset Newline newline
24710 \begin_inset Flex Code
24713 \begin_layout Plain Layout
24714 {%author%[[%author%]][[%editor%, ed.]]}
24720 \begin_inset Newline newline
24724 \begin_inset Flex Code
24727 \begin_layout Plain Layout
24733 key is printed if it exists; otherwise, the editor key is printed, followed
24735 \begin_inset Quotes eld
24739 \begin_inset space ~
24743 \begin_inset Quotes erd
24746 Note that the key is again enclosed in
24747 \begin_inset Flex Code
24750 \begin_layout Plain Layout
24756 signs; the entire conditional is enclosed in braces; and the if and else
24757 clauses are enclosed in double brackets,
24758 \begin_inset Quotes eld
24762 \begin_inset Flex Code
24765 \begin_layout Plain Layout
24772 \begin_inset Quotes eld
24776 \begin_inset Quotes eld
24780 \begin_inset Flex Code
24783 \begin_layout Plain Layout
24790 \begin_inset Quotes erd
24794 There must be no space between any of these.
24797 \begin_layout Standard
24798 Next to the entry keys, there are some special keys that can be used for
24799 these conditionals:
24802 \begin_layout Itemize
24803 \begin_inset Flex Code
24806 \begin_layout Plain Layout
24807 {%dialog%[[true]][[false]]}
24813 \begin_inset Quotes eld
24817 \begin_inset Quotes erd
24820 part for dialogs and menus, the
24821 \begin_inset Quotes eld
24825 \begin_inset Quotes erd
24828 part for other contexts (workarea, export)
24831 \begin_layout Itemize
24832 \begin_inset Flex Code
24835 \begin_layout Plain Layout
24836 {%export%[[true]][[false]]}
24842 \begin_inset Quotes eld
24846 \begin_inset Quotes erd
24849 part for export and menus, the
24850 \begin_inset Quotes eld
24854 \begin_inset Quotes erd
24857 part for other contexts (workarea, dialog)
24860 \begin_layout Itemize
24861 \begin_inset Flex Code
24864 \begin_layout Plain Layout
24871 \begin_inset Quotes eld
24875 \begin_inset Quotes erd
24878 part if another item follows (e.
24879 \begin_inset space \thinspace{}
24882 g., in a citation with multiple keys)
24885 \begin_layout Itemize
24886 \begin_inset Flex Code
24889 \begin_layout Plain Layout
24890 {%second%[[true]][[false]]}
24896 \begin_inset Quotes eld
24900 \begin_inset Quotes erd
24903 if this is the second of multiple items, else the
24904 \begin_inset Quotes eld
24908 \begin_inset Quotes erd
24914 \begin_layout Itemize
24915 \begin_inset Flex Code
24918 \begin_layout Plain Layout
24919 {%ifstar%[[true]][[false]]}
24925 \begin_inset Quotes eld
24929 \begin_inset Quotes erd
24932 part for starred citation commands (such as
24933 \begin_inset Flex Code
24936 \begin_layout Plain Layout
24944 ), the false part for unstarred
24947 \begin_layout Itemize
24948 \begin_inset Flex Code
24951 \begin_layout Plain Layout
24952 {%ifentrytype:<type>%[[true]][[false]]}
24958 \begin_inset Quotes eld
24962 \begin_inset Quotes erd
24965 if the current entry type matches
24966 \begin_inset Flex Code
24969 \begin_layout Plain Layout
24975 , else the false part (e.g., in a citation definition:
24976 \begin_inset Flex Code
24979 \begin_layout Plain Layout
24980 {%ifentrytype:book%[[this is a book]][[this is no book]]}
24988 \begin_layout Itemize
24989 \begin_inset Flex Code
24992 \begin_layout Plain Layout
24993 {%ifmultiple:<authortype>%[[true]][[false]]}
24999 \begin_inset Quotes eld
25003 \begin_inset Quotes erd
25006 if the current author type (author, editor etc.) has multiple authors, else
25007 the false part (e.g., in a bibliography definition:
25008 \begin_inset Flex Code
25011 \begin_layout Plain Layout
25012 {%ifmultiple:editor%[[eds.]][[ed.]]}
25020 \begin_layout Itemize
25021 \begin_inset Flex Code
25024 \begin_layout Plain Layout
25025 {%ifqualified%[[true]][[false]]}
25031 \begin_inset Quotes eld
25035 \begin_inset Quotes erd
25038 part if the current citation is a qualified citation list (a specific
25042 format for multi-reference citations), the false part if this is not the
25046 \begin_layout Standard
25048 \begin_inset Flex Code
25051 \begin_layout Plain Layout
25057 prints the author key as it is recorded in the bibliography file.
25058 This might not be what you want, since it will result in a string such
25060 \begin_inset Quotes eld
25063 Miller, Peter and Smith, Mary and White, Jane
25064 \begin_inset Quotes erd
25068 \begin_inset Quotes eld
25072 \begin_inset Quotes erd
25075 is used by Bib\SpecialChar TeX
25076 to delimit authors).
25078 therefore provides some methods to get properly formatted name lists (which
25079 will also get translated).
25080 The following keys are provided:
25083 \begin_layout Enumerate
25084 For name lists with pre- and surname, suitable for the main authors/editors
25085 of a bibliography item.
25087 \begin_inset Flex Code
25090 \begin_layout Plain Layout
25096 part denotes the kind of list that is requested (e.g.
25098 \begin_inset Flex Code
25101 \begin_layout Plain Layout
25111 \begin_layout Itemize
25112 \begin_inset Flex Code
25115 \begin_layout Plain Layout
25116 %abbrvnames:<nametype>%
25121 : Provides a name list which is abbreviated (with
25122 \begin_inset Quotes eld
25126 \begin_inset Quotes erd
25130 \begin_inset Flex Code
25133 \begin_layout Plain Layout
25142 \begin_layout Itemize
25143 \begin_inset Flex Code
25146 \begin_layout Plain Layout
25147 %fullnames:<nametype>%
25152 : Provides a full name list (never abbreviated with
25153 \begin_inset Quotes eld
25157 \begin_inset Quotes erd
25163 \begin_layout Itemize
25164 \begin_inset Flex Code
25167 \begin_layout Plain Layout
25168 %forceabbrvnames:<nametype>%
25173 : Provides a name list which is always abbreviated (with
25174 \begin_inset Quotes eld
25178 \begin_inset Quotes erd
25182 \begin_inset Flex Code
25185 \begin_layout Plain Layout
25195 \begin_layout Enumerate
25196 Alternative name lists with pre- and surname, if the order of pre- and surname
25197 inside the bibliography item differs (as in:
25198 \begin_inset Quotes eld
25201 Miller, John: Some text, in: Mary Smith, ed.: A volume
25202 \begin_inset Quotes erd
25209 \begin_layout Itemize
25210 \begin_inset Flex Code
25213 \begin_layout Plain Layout
25214 %abbrvbynames:<nametype>%
25219 : Provides a name list which is abbreviated (with
25220 \begin_inset Quotes eld
25224 \begin_inset Quotes erd
25228 \begin_inset Flex Code
25231 \begin_layout Plain Layout
25240 \begin_layout Itemize
25241 \begin_inset Flex Code
25244 \begin_layout Plain Layout
25245 %fullbynames:<nametype>%
25250 : Provides a full name list (never abbreviated with
25251 \begin_inset Quotes eld
25255 \begin_inset Quotes erd
25261 \begin_layout Itemize
25262 \begin_inset Flex Code
25265 \begin_layout Plain Layout
25266 %forceabbrvbynames:<nametype>%
25271 : Provides a name list which is always abbreviated (with
25272 \begin_inset Quotes eld
25276 \begin_inset Quotes erd
25280 \begin_inset Flex Code
25283 \begin_layout Plain Layout
25293 \begin_layout Enumerate
25294 And finally name lists which consist of family names only, as used in author-yea
25296 These do not take a
25297 \begin_inset Flex Code
25300 \begin_layout Plain Layout
25306 part, but always return either an author list or, if this does not exist,
25307 an editor list (as common in author-year labels):
25311 \begin_layout Itemize
25312 \begin_inset Flex Code
25315 \begin_layout Plain Layout
25321 : Provides a name list which is abbreviated (with
25322 \begin_inset Quotes eld
25326 \begin_inset Quotes erd
25330 \begin_inset Flex Code
25333 \begin_layout Plain Layout
25342 \begin_layout Itemize
25343 \begin_inset Flex Code
25346 \begin_layout Plain Layout
25352 : Provides a full name list (never abbreviated with
25353 \begin_inset Quotes eld
25357 \begin_inset Quotes erd
25363 \begin_layout Itemize
25364 \begin_inset Flex Code
25367 \begin_layout Plain Layout
25368 %forceabbrvciteauthor%
25373 : Provides a name list which is always abbreviated (with
25374 \begin_inset Quotes eld
25378 \begin_inset Quotes erd
25382 \begin_inset Flex Code
25385 \begin_layout Plain Layout
25395 \begin_layout Standard
25396 The order of pre- and surname in the former two lists can be adjusted by
25400 \begin_layout Itemize
25401 \begin_inset Flex Code
25404 \begin_layout Plain Layout
25405 !firstnameform %surname%, %prename%
25410 (first author in lists of type 1)
25413 \begin_layout Itemize
25414 \begin_inset Flex Code
25417 \begin_layout Plain Layout
25418 !othernameform %surname%, %prename%
25423 (other authors in lists of type 1)
25426 \begin_layout Itemize
25427 \begin_inset Flex Code
25430 \begin_layout Plain Layout
25431 !firstbynameform %prename% %surname%
25436 (first author in lists of type 2)
25439 \begin_layout Itemize
25440 \begin_inset Flex Code
25443 \begin_layout Plain Layout
25444 !otherbynameform %prename% %surname%
25449 (other authors in lists of type 2)
25452 \begin_layout Standard
25453 This allows you to configure namings like
25454 \begin_inset Quotes eld
25457 Miller, Peter and Mary Smith: \SpecialChar ldots
25458 , in: John Doe and Pat Green, eds.:\SpecialChar ldots
25460 \begin_inset Quotes erd
25466 \begin_layout Standard
25467 There is one other piece of syntax available in definitions, which looks
25469 \begin_inset Flex Code
25472 \begin_layout Plain Layout
25479 This defines a piece of formatting information that is to be used when
25481 \begin_inset Quotes eld
25485 \begin_inset Quotes erd
25489 Obviously, we do not want to output HTML tags when writing plain text,
25490 so they should be wrapped in
25491 \begin_inset Quotes eld
25495 \begin_inset Quotes erd
25499 \begin_inset Quotes eld
25503 \begin_inset Quotes erd
25509 \begin_layout Standard
25510 Two special sorts of definitions are also possible in a
25511 \begin_inset Flex Code
25514 \begin_layout Plain Layout
25521 An example of the first would be:
25524 \begin_layout LyX-Code
25526 \begin_inset Quotes eld
25530 \begin_inset Quotes erd
25536 \begin_layout Standard
25537 This is an abbreviation, or macro, and it can be used by treating it as
25539 \begin_inset Flex Code
25542 \begin_layout Plain Layout
25551 \begin_inset Flex Code
25554 \begin_layout Plain Layout
25560 exactly as it would treat its definition.
25561 So, let us issue the obvious
25569 \begin_layout LyX-Code
25573 \begin_layout Standard
25574 or anything like it.
25576 shouldn't go into an infinite loop, but it may go into a long one before
25580 \begin_layout Standard
25581 The second sort of special definition might look like this:
25584 \begin_layout LyX-Code
25588 \begin_layout Standard
25589 This defines a translatable piece of text, which allows relevant parts of
25590 the bibliography or citation to be translated.
25591 It can be included in a definition by treating it as a key:
25592 \begin_inset Flex Code
25595 \begin_layout Plain Layout
25602 Note that there are two different translation paths: All definitions starting
25604 \begin_inset Flex Code
25607 \begin_layout Plain Layout
25613 , such as in the example above, will be translated to the currently active
25614 buffer language (so the translation will match the generated document).
25615 All definitions starting with underscore only will be translated to the
25617 This is the proper translation for strings that only occur in the dialogs
25618 or on buttons, such as this one:
25621 \begin_layout LyX-Code
25622 _addtobib Add to bibliography only.
25625 \begin_layout Standard
25626 Several of these translatable strings are predefined in
25627 \begin_inset Flex Code
25630 \begin_layout Plain Layout
25637 \begin_inset Flex Code
25640 \begin_layout Plain Layout
25647 Note that these are not macros, in the sense just defined.
25648 They will not be expanded.
25651 \begin_layout Standard
25652 So here then is an example that uses several of these features:
25653 \begin_inset VSpace defskip
25659 \begin_layout Standard
25663 !authoredit {%author%[[%author%, ]][[{%editor%[[%editor%, %B_edtext%, ]]}]]}
25666 \begin_layout Standard
25667 \begin_inset VSpace defskip
25670 This defines a macro that prints the author, followed by a comma, if the
25672 \begin_inset Flex Code
25675 \begin_layout Plain Layout
25681 key is defined, or else prints the name of the editor, followed by the
25683 \begin_inset Flex Code
25686 \begin_layout Plain Layout
25692 or its translation (it is by default
25693 \begin_inset Quotes eld
25697 \begin_inset Quotes erd
25701 \begin_inset Flex Code
25704 \begin_layout Plain Layout
25711 Note that this is in fact defined in
25712 \begin_inset Flex Code
25715 \begin_layout Plain Layout
25721 , so you can use it in your own definitions, or re-definitions, if you load
25725 \begin_layout Section
25726 \begin_inset CommandInset label
25728 name "sec:Tags-for-XHTML"
25732 Tags for XHTML output
25735 \begin_layout Standard
25736 As with \SpecialChar LaTeX
25737 or DocBook, the format of \SpecialChar LyX
25738 's XHTML output is also controlled by
25739 layout information.
25740 In general, \SpecialChar LyX
25741 provides sensible defaults and, as mentioned earlier, it will
25742 even construct default CSS style rules from the other layout tags.
25743 For example, \SpecialChar LyX
25744 will attempt to use the information provided in the
25745 \begin_inset Flex Code
25748 \begin_layout Plain Layout
25754 declaration for the Chapter style to write CSS that will appropriately
25755 format chapter headings.
25758 \begin_layout Standard
25759 In many cases, then, you may not have to do anything at all to get acceptable
25760 XHTML output for your own environments, custom insets, and so forth.
25761 But in some cases you will, and so \SpecialChar LyX
25762 provides a number of layout tags that
25763 can be used to customize the XHTML and CSS that are generated.
25766 \begin_layout Standard
25767 Note that there are two tags,
25768 \begin_inset Flex Code
25771 \begin_layout Plain Layout
25778 \begin_inset Flex Code
25781 \begin_layout Plain Layout
25787 that may appear outside style and inset declarations.
25789 \begin_inset CommandInset ref
25791 reference "subsec:General-text-class"
25795 for details on these.
25798 \begin_layout Subsection
25799 \begin_inset CommandInset label
25801 name "subsec:Paragraph-Style-XHTML"
25808 \begin_layout Standard
25809 The sort of XHTML \SpecialChar LyX
25810 outputs for a paragraph depends upon whether we are dealing
25811 with a normal paragraph, a command, or an environment, where this is itself
25812 determined by the contents of the corresponding
25813 \begin_inset Flex Code
25816 \begin_layout Plain Layout
25827 \begin_layout Standard
25828 For a command or normal paragraph, the output XHTML has the following form:
25831 \begin_layout LyX-Code
25835 \begin_inset Quotes erd
25839 \begin_inset Quotes erd
25845 \begin_layout LyX-Code
25849 \begin_inset Quotes erd
25853 \begin_inset Quotes erd
25859 \begin_layout LyX-Code
25862 Contents of the paragraph.
25865 \begin_layout LyX-Code
25871 \begin_layout Standard
25872 The label tags are of course omitted if the paragraph does not have a label.
25875 \begin_layout Standard
25876 For an environment that is not some sort of list, the XHTML takes this form:
25879 \begin_layout LyX-Code
25883 \begin_inset Quotes erd
25887 \begin_inset Quotes erd
25893 \begin_layout LyX-Code
25897 \begin_inset Quotes erd
25901 \begin_inset Quotes erd
25905 \begin_inset Quotes erd
25909 \begin_inset Quotes erd
25912 >Environment Label</labeltag>First paragraph.</itemtag>
25915 \begin_layout LyX-Code
25918 <itemtag>Second paragraph.</itemtag>
25921 \begin_layout LyX-Code
25927 \begin_layout Standard
25928 Note that the label is output only for the first paragraph, as it should
25929 be for a theorem, for example.
25933 \begin_layout Standard
25934 For a list, we have one of these forms:
25937 \begin_layout LyX-Code
25941 \begin_inset Quotes erd
25945 \begin_inset Quotes erd
25951 \begin_layout LyX-Code
25955 \begin_inset Quotes erd
25959 \begin_inset Quotes erd
25963 \begin_inset Quotes erd
25967 \begin_inset Quotes erd
25970 >List Label</labeltag>First item.</itemtag>
25973 \begin_layout LyX-Code
25977 \begin_inset Quotes erd
25981 \begin_inset Quotes erd
25985 \begin_inset Quotes erd
25989 \begin_inset Quotes erd
25992 >List Label</labeltag>Second item.</itemtag>
25995 \begin_layout LyX-Code
26001 \begin_layout LyX-Code
26005 \begin_layout LyX-Code
26009 \begin_inset Quotes erd
26013 \begin_inset Quotes erd
26019 \begin_layout LyX-Code
26023 \begin_inset Quotes erd
26027 \begin_inset Quotes erd
26030 >List Label</labeltag><itemtag attr=
26031 \begin_inset Quotes erd
26035 \begin_inset Quotes erd
26038 >First item.</itemtag>
26041 \begin_layout LyX-Code
26045 \begin_inset Quotes erd
26049 \begin_inset Quotes erd
26052 >List Label</labeltag><itemtag attr=
26053 \begin_inset Quotes erd
26057 \begin_inset Quotes erd
26060 >Second item.</itemtag>
26063 \begin_layout LyX-Code
26069 \begin_layout Standard
26070 Note the different orders of
26071 \begin_inset Flex Code
26074 \begin_layout Plain Layout
26081 \begin_inset Flex Code
26084 \begin_layout Plain Layout
26091 Which order we get depends upon the setting of
26092 \begin_inset Flex Code
26095 \begin_layout Plain Layout
26102 \begin_inset Flex Code
26105 \begin_layout Plain Layout
26111 is false (the default), you get the first of these, with the label within
26112 the item; if true, you get the second, with the label outside the item.
26115 \begin_layout Standard
26116 The specific tags and attributes output for each paragraph type can be controlle
26117 d by means of the layout tags we are about to describe.
26118 As mentioned earlier, however, \SpecialChar LyX
26119 uses sensible defaults for many of these,
26120 so you often may not need to do very much to get good XHTML output.
26121 Think of the available tags as there so you can tweak things to your liking.
26124 \begin_layout Description
26125 \begin_inset Flex Code
26128 \begin_layout Plain Layout
26135 \begin_inset Flex Code
26138 \begin_layout Plain Layout
26144 ] Specifies attribute information to be output with the main tag.
26146 \begin_inset Quotes eld
26150 \begin_inset Flex Code
26153 \begin_layout Plain Layout
26160 \begin_inset Quotes erd
26164 By default, \SpecialChar LyX
26166 \begin_inset Quotes eld
26170 \begin_inset Flex Code
26173 \begin_layout Plain Layout
26180 \begin_inset Quotes erd
26184 \begin_inset Flex Code
26187 \begin_layout Plain Layout
26193 is the \SpecialChar LyX
26194 name of the layout, made lowercase, for example: chapter.
26199 contain any style information.
26201 \begin_inset Flex Code
26204 \begin_layout Plain Layout
26213 \begin_layout Description
26214 \begin_inset Flex Code
26217 \begin_layout Plain Layout
26224 \begin_inset Flex Code
26227 \begin_layout Plain Layout
26237 ] Whether to output the default CSS information \SpecialChar LyX
26238 generates for this layout,
26239 even if additional information is explicitly provided via
26240 \begin_inset Flex Code
26243 \begin_layout Plain Layout
26251 \begin_inset Flex Code
26254 \begin_layout Plain Layout
26260 allows you to alter or augment the generated CSS, rather than to override
26263 \begin_inset Flex Code
26266 \begin_layout Plain Layout
26275 \begin_layout Description
26276 \begin_inset Flex Code
26279 \begin_layout Plain Layout
26286 \begin_inset Flex Code
26289 \begin_layout Plain Layout
26295 ] The tag to be used for individual paragraphs of environments, replacing
26297 \begin_inset Flex Code
26300 \begin_layout Plain Layout
26306 in the examples above.
26308 \begin_inset Flex Code
26311 \begin_layout Plain Layout
26320 \begin_layout Description
26321 \begin_inset Flex Code
26324 \begin_layout Plain Layout
26331 \begin_inset Flex Code
26334 \begin_layout Plain Layout
26340 ] Attributes for the item tag.
26342 \begin_inset Newline newline
26346 \begin_inset Quotes eld
26350 \begin_inset Flex Code
26353 \begin_layout Plain Layout
26354 class=`layoutname_item'
26360 \begin_inset Quotes erd
26368 contain any style information.
26370 \begin_inset Flex Code
26373 \begin_layout Plain Layout
26382 \begin_layout Description
26383 \begin_inset Flex Code
26386 \begin_layout Plain Layout
26393 \begin_inset Flex Code
26396 \begin_layout Plain Layout
26402 ] The tag to be used for paragraph and item labels, replacing
26403 \begin_inset Flex Code
26406 \begin_layout Plain Layout
26412 in the examples above.
26414 \begin_inset Flex Code
26417 \begin_layout Plain Layout
26424 \begin_inset Flex Code
26427 \begin_layout Plain Layout
26434 \begin_inset Flex Code
26437 \begin_layout Plain Layout
26444 \begin_inset Flex Code
26447 \begin_layout Plain Layout
26448 Centered_Top_Environment
26453 , in which case it defaults to
26454 \begin_inset Flex Code
26457 \begin_layout Plain Layout
26466 \begin_layout Description
26467 \begin_inset Flex Code
26470 \begin_layout Plain Layout
26477 \begin_inset Flex Code
26480 \begin_layout Plain Layout
26486 ] Attributes for the label tag.
26488 \begin_inset Newline newline
26492 \begin_inset Quotes eld
26496 \begin_inset Flex Code
26499 \begin_layout Plain Layout
26500 class=`layoutname_label'
26506 \begin_inset Quotes erd
26514 contain any style information.
26516 \begin_inset Flex Code
26519 \begin_layout Plain Layout
26528 \begin_layout Description
26529 \begin_inset Flex Code
26532 \begin_layout Plain Layout
26539 \begin_inset Flex Code
26542 \begin_layout Plain Layout
26552 ] Meaningful only for list-like environments, this tag controls whether
26553 the label tag is output before or inside the item tag.
26554 This is used, for example, in the description environment, where we want
26556 \begin_inset Flex Code
26559 \begin_layout Plain Layout
26560 <dt>\SpecialChar ldots
26561 </dt><dd>\SpecialChar ldots
26569 \begin_inset Flex Code
26572 \begin_layout Plain Layout
26578 : The label tag is output inside the item tag.
26581 \begin_layout Description
26582 \begin_inset Flex Code
26585 \begin_layout Plain Layout
26591 Information to be output in the
26592 \begin_inset Flex Code
26595 \begin_layout Plain Layout
26601 section when this style is used.
26602 This might, for example, be used to include a
26603 \begin_inset Flex Code
26606 \begin_layout Plain Layout
26613 \begin_inset Flex Code
26616 \begin_layout Plain Layout
26625 \begin_layout Description
26626 \begin_inset Flex Code
26629 \begin_layout Plain Layout
26635 CSS style information to be included when this style is used.
26636 Note that this will automatically be wrapped in a layout-generated
26637 \begin_inset Flex Code
26640 \begin_layout Plain Layout
26646 block, so only the CSS itself need be included.
26648 \begin_inset Flex Code
26651 \begin_layout Plain Layout
26660 \begin_layout Description
26661 \begin_inset Flex Code
26664 \begin_layout Plain Layout
26671 \begin_inset Flex Code
26674 \begin_layout Plain Layout
26680 ] The tag to be used for the main label, replacing
26681 \begin_inset Flex Code
26684 \begin_layout Plain Layout
26690 in the examples above.
26692 \begin_inset Flex Code
26695 \begin_layout Plain Layout
26704 \begin_layout Description
26705 \begin_inset Flex Code
26708 \begin_layout Plain Layout
26715 \begin_inset Flex Code
26718 \begin_layout Plain Layout
26728 ] Marks this style as the one to be used to generate the
26729 \begin_inset Flex Code
26732 \begin_layout Plain Layout
26738 tag for the XHTML file.
26739 By default, it is false.
26741 \begin_inset Flex Code
26744 \begin_layout Plain Layout
26750 file sets it to true for the
26751 \begin_inset Flex Code
26754 \begin_layout Plain Layout
26764 \begin_layout Subsection
26768 \begin_layout Standard
26769 The XHTML output of insets can also be controlled by information in layout
26774 \begin_layout Plain Layout
26775 At present, this is true only for
26776 \begin_inset Quotes eld
26780 \begin_inset Quotes erd
26783 insets (insets you can type into) and is not true for
26784 \begin_inset Quotes eld
26788 \begin_inset Quotes erd
26791 insets (insets that are associated with dialog boxes).
26796 Here, too, \SpecialChar LyX
26797 tries to provide sensible defaults, and it constructs default
26799 But everything can be customized.
26802 \begin_layout Standard
26803 The XHTML \SpecialChar LyX
26804 outputs for an inset has the following form:
26807 \begin_layout LyX-Code
26809 \begin_inset Quotes erd
26813 \begin_inset Quotes erd
26819 \begin_layout LyX-Code
26820 <labeltag>Label</labeltag>
26823 \begin_layout LyX-Code
26825 \begin_inset Quotes erd
26829 \begin_inset Quotes erd
26832 >Contents of the inset.</innertag>
26835 \begin_layout LyX-Code
26839 \begin_layout Standard
26840 If the inset permits multiple paragraphs—that is, if
26841 \begin_inset Flex Code
26844 \begin_layout Plain Layout
26850 is true—then the contents of the inset will itself be output as paragraphs
26851 formatted according to the styles used for those paragraphs (standard,
26852 quote, and the like).
26853 The label tag is of course omitted if the paragraph does not have a label
26854 and, at present, is always
26855 \begin_inset Flex Code
26858 \begin_layout Plain Layout
26865 The inner tag is optional and, by default, does not appear.
26868 \begin_layout Standard
26869 The specific tags and attributes output for each inset can be controlled
26870 by means of the following layout tags.
26873 \begin_layout Description
26874 \begin_inset Flex Code
26877 \begin_layout Plain Layout
26884 \begin_inset Flex Code
26887 \begin_layout Plain Layout
26893 ] Specifies attribute information to be output with the main tag.
26895 \begin_inset Quotes eld
26899 \begin_inset Flex Code
26902 \begin_layout Plain Layout
26903 class=`myinset' onclick=`\SpecialChar ldots
26910 \begin_inset Quotes erd
26914 By default, \SpecialChar LyX
26916 \begin_inset Quotes eld
26920 \begin_inset Flex Code
26923 \begin_layout Plain Layout
26930 \begin_inset Quotes erd
26934 \begin_inset Flex Code
26937 \begin_layout Plain Layout
26943 is the \SpecialChar LyX
26944 name of the inset, made lowercase and with non-alphanumeric characters
26945 converted to underscores, for example: footnote.
26948 \begin_layout Description
26949 \begin_inset Flex Code
26952 \begin_layout Plain Layout
26959 \begin_inset Flex Code
26962 \begin_layout Plain Layout
26972 ] Whether to output the default CSS information \SpecialChar LyX
26973 generates for this layout,
26974 even if additional information is explicitly provided via
26975 \begin_inset Flex Code
26978 \begin_layout Plain Layout
26986 \begin_inset Flex Code
26989 \begin_layout Plain Layout
26995 allows you to alter or augment the generated CSS, rather than to override
27000 \begin_layout Description
27001 \begin_inset Flex Code
27004 \begin_layout Plain Layout
27011 \begin_inset Flex Code
27014 \begin_layout Plain Layout
27020 ] Attributes for the inner tag.
27022 \begin_inset Newline newline
27026 \begin_inset Quotes eld
27030 \begin_inset Flex Code
27033 \begin_layout Plain Layout
27034 class=`insetname_inner'
27040 \begin_inset Quotes erd
27046 \begin_layout Description
27047 \begin_inset Flex Code
27050 \begin_layout Plain Layout
27057 \begin_inset Flex Code
27060 \begin_layout Plain Layout
27066 ] The inner tag, replacing
27067 \begin_inset Flex Code
27070 \begin_layout Plain Layout
27076 in the examples above.
27077 By default, there is none.
27080 \begin_layout Description
27081 \begin_inset Flex Code
27084 \begin_layout Plain Layout
27091 \begin_inset Flex Code
27094 \begin_layout Plain Layout
27102 ] Whether this inset represents a standalone block of text (such as a footnote)
27103 or instead represents material that is included in the surrounding text
27104 (such as a branch).
27108 \begin_layout Description
27109 \begin_inset Flex Code
27112 \begin_layout Plain Layout
27119 \begin_inset Flex Code
27122 \begin_layout Plain Layout
27128 ] A label for this inset, possibly including a reference to a counter.
27129 For example, for footnote, it might be:
27130 \begin_inset Flex Code
27133 \begin_layout Plain Layout
27142 This is optional, and there is no default.
27145 \begin_layout Description
27146 \begin_inset Flex Code
27149 \begin_layout Plain Layout
27155 Information to be output in the
27156 \begin_inset Flex Code
27159 \begin_layout Plain Layout
27165 section when this style is used.
27166 This might, for example, be used to include a
27167 \begin_inset Flex Code
27170 \begin_layout Plain Layout
27177 \begin_inset Flex Code
27180 \begin_layout Plain Layout
27189 \begin_layout Description
27190 \begin_inset Flex Code
27193 \begin_layout Plain Layout
27199 CSS style information to be included when this style is used.
27200 Note that this will automatically be wrapped in a layout-generated
27201 \begin_inset Flex Code
27204 \begin_layout Plain Layout
27210 block, so only the CSS itself need be included.
27213 \begin_layout Description
27214 \begin_inset Flex Code
27217 \begin_layout Plain Layout
27224 \begin_inset Flex Code
27227 \begin_layout Plain Layout
27233 ] The tag to be used for the main label, replacing
27234 \begin_inset Flex Code
27237 \begin_layout Plain Layout
27243 in the examples above.
27244 The default depends upon the setting of
27245 \begin_inset Flex Code
27248 \begin_layout Plain Layout
27255 \begin_inset Flex Code
27258 \begin_layout Plain Layout
27264 is true, the default is
27265 \begin_inset Flex Code
27268 \begin_layout Plain Layout
27274 ; if it is false, the default is
27275 \begin_inset Flex Code
27278 \begin_layout Plain Layout
27287 \begin_layout Subsection
27291 \begin_layout Standard
27292 The XHTML output for floats too can be controlled by layout information.
27293 The output has the following form:
27296 \begin_layout LyX-Code
27298 \begin_inset Quotes erd
27302 \begin_inset Quotes erd
27308 \begin_layout LyX-Code
27309 Contents of the float.
27312 \begin_layout LyX-Code
27316 \begin_layout Standard
27317 The caption, if there is one, is a separate inset and will be output as
27319 Its appearance can be controlled via the InsetLayout for caption insets.
27323 \begin_layout Description
27324 \begin_inset Flex Code
27327 \begin_layout Plain Layout
27334 \begin_inset Flex Code
27337 \begin_layout Plain Layout
27343 ] Specifies attribute information to be output with the main tag.
27345 \begin_inset Quotes eld
27349 \begin_inset Flex Code
27352 \begin_layout Plain Layout
27353 class=`myfloat' onclick=`\SpecialChar ldots
27360 \begin_inset Quotes erd
27364 By default, \SpecialChar LyX
27366 \begin_inset Quotes eld
27370 \begin_inset Flex Code
27373 \begin_layout Plain Layout
27374 class=`float float-floattype'
27380 \begin_inset Quotes erd
27384 \begin_inset Flex Code
27387 \begin_layout Plain Layout
27393 is \SpecialChar LyX
27394 's name for this type of float, as determined by the float declaration
27396 \begin_inset CommandInset ref
27398 reference "subsec:Floats"
27402 ), though made lowercase and with non-alphanumeric characters converted
27403 to underscores, for example: float-table.
27406 \begin_layout Description
27407 \begin_inset Flex Code
27410 \begin_layout Plain Layout
27416 CSS style information to be included when this float is used.
27417 Note that this will automatically be wrapped in a layout-generated
27418 \begin_inset Flex Code
27421 \begin_layout Plain Layout
27427 block, so only the CSS itself need be included.
27430 \begin_layout Description
27431 \begin_inset Flex Code
27434 \begin_layout Plain Layout
27441 \begin_inset Flex Code
27444 \begin_layout Plain Layout
27450 ] The tag to be used for this float, replacing
27451 \begin_inset Quotes eld
27455 \begin_inset Flex Code
27458 \begin_layout Plain Layout
27465 \begin_inset Quotes erd
27468 in the example above.
27470 \begin_inset Flex Code
27473 \begin_layout Plain Layout
27479 and will rarely need changing.
27482 \begin_layout Subsection
27483 Bibliography formatting
27486 \begin_layout Standard
27487 The bibliography can be formatted using
27488 \begin_inset Flex Code
27491 \begin_layout Plain Layout
27499 \begin_inset CommandInset ref
27501 reference "subsec:Citation-format-description"
27508 \begin_layout Subsection
27513 \begin_layout Standard
27514 We have several times mentioned that \SpecialChar LyX
27515 will generate default CSS style rules
27516 for both insets and paragraph styles, based upon the other layout information
27518 In this section, we shall say a word about which layout information \SpecialChar LyX
27523 \begin_layout Standard
27524 At present, \SpecialChar LyX
27525 auto-generates CSS only for font information, making use of
27527 \begin_inset Flex Code
27530 \begin_layout Plain Layout
27537 \begin_inset Flex Code
27540 \begin_layout Plain Layout
27547 \begin_inset Flex Code
27550 \begin_layout Plain Layout
27557 \begin_inset Flex Code
27560 \begin_layout Plain Layout
27567 \begin_inset Flex Code
27570 \begin_layout Plain Layout
27577 \begin_inset CommandInset ref
27579 reference "subsec:Font-description"
27584 The translation is mostly straightforward and obvious.
27586 \begin_inset Quotes eld
27590 \begin_inset Flex Code
27593 \begin_layout Plain Layout
27600 \begin_inset Quotes erd
27604 \begin_inset Quotes eld
27608 \begin_inset Flex Code
27611 \begin_layout Plain Layout
27612 font-family: sans-serif;
27618 \begin_inset Quotes erd
27622 The correspondence of \SpecialChar LyX
27623 sizes and CSS sizes is a little less obvious but
27624 nonetheless intuitive.
27626 \begin_inset Flex Code
27629 \begin_layout Plain Layout
27636 \begin_inset Flex URL
27639 \begin_layout Plain Layout
27647 \change_inserted -970929547 1496610908
27651 \begin_layout Section
27653 \change_inserted -970929547 1496610966
27654 \begin_inset CommandInset label
27656 name "sec:Tags-for-DocBook"
27660 Tags for DocBook output
27663 \begin_layout Standard
27665 \change_inserted -970929547 1496611615
27666 As with \SpecialChar LaTeX
27667 or XHTML, the format of \SpecialChar LyX
27668 's DocBook output is also controlled by
27669 layout information.
27670 In general, \SpecialChar LyX
27671 provides sensible defaults; however, much of the styling is
27672 lost during the conversion, as DocBook is strictly semantic and does not
27674 When possible, information from \SpecialChar LyX
27675 will be rendered in
27683 \begin_layout Standard
27685 \change_inserted -970929547 1496612080
27686 In many cases, then, you may not have to do anything at all to get acceptable
27687 DocBook output for your own environments, custom insets, and so forth.
27688 But in some cases you will, and so \SpecialChar LyX
27689 provides a number of layout tags that
27690 can be used to customize the DocBook that is generated.
27693 \begin_layout Standard
27695 \change_inserted -970929547 1515109912
27696 Labels are rarely output, as they are redundant in DocBook: this information
27697 is carried by the tags themselves, and whether labels appear in the final
27698 documents (after processing of DocBook files) is controlled by the stylesheets.
27699 However, sometimes, labels are not redundant content, such as definition
27700 lists: in this case, the term being defined will be the label.
27704 \begin_layout Subsection
27706 \change_inserted 1075283030 1597699417
27707 \begin_inset CommandInset label
27709 name "subsec:Paragraph-Style-DocBook"
27714 \change_deleted 1075283030 1597699417
27716 \begin_inset CommandInset label
27718 name "subsec:Paragraph-Style-XHTML-1"
27723 \change_inserted -970929547 1496610966
27727 \begin_layout Standard
27729 \change_inserted -970929547 1496612059
27730 The sort of DocBook \SpecialChar LyX
27731 outputs for a paragraph depends upon whether we are
27732 dealing with a normal paragraph, a command, or an environment, where this
27733 is itself determined by the contents of the corresponding
27734 \begin_inset Flex Code
27737 \begin_layout Plain Layout
27739 \change_inserted -970929547 1496610966
27752 \begin_layout Standard
27754 \change_inserted -970929547 1496612107
27755 For a command or normal paragraph, the output DocBook has the following
27759 \begin_layout LyX-Code
27761 \change_inserted -970929547 1515109666
27765 \begin_layout LyX-Code
27767 \change_inserted -970929547 1496610966
27768 Contents of the paragraph.
27771 \begin_layout LyX-Code
27773 \change_inserted -970929547 1496610966
27777 \begin_layout Standard
27779 \change_inserted -970929547 1515109821
27780 For an environment that is not some sort of list, the generated DocBook
27784 \begin_layout LyX-Code
27786 \change_inserted -970929547 1515109671
27790 \begin_layout LyX-Code
27792 \change_inserted -970929547 1496612114
27793 <itemtag>First paragraph.</itemtag>
27796 \begin_layout LyX-Code
27798 \change_inserted -970929547 1496610966
27799 <itemtag>Second paragraph.</itemtag>
27802 \begin_layout LyX-Code
27804 \change_inserted -970929547 1496610966
27808 \begin_layout Standard
27810 \change_inserted -970929547 1515109825
27811 For a list, the resulting DocBook takes this form:
27814 \begin_layout LyX-Code
27816 \change_inserted -970929547 1515109672
27820 \begin_layout LyX-Code
27822 \change_inserted -970929547 1515109676
27823 <itemtag attr>First item.</itemtag>
27826 \begin_layout LyX-Code
27828 \change_inserted -970929547 1515109678
27829 <itemtag attr>Second item.</itemtag>
27832 \begin_layout LyX-Code
27834 \change_inserted -970929547 1496610966
27838 \begin_layout Standard
27840 \change_inserted -970929547 1496612243
27841 The specific tags and roles output for each paragraph type can be controlled
27842 by means of the layout tags we are about to describe.
27843 Please note that, due to the very nature of DocBook, no sensible defaults
27844 really exist, and the values must always be carefully chosen.
27848 \begin_layout Description
27850 \change_inserted -970929547 1515110057
27851 \begin_inset Flex Code
27854 \begin_layout Plain Layout
27856 \change_inserted -970929547 1515109656
27865 \begin_inset Flex Code
27868 \begin_layout Plain Layout
27870 \change_inserted -970929547 1496610966
27878 ] Specifies attribute information to be output with the main tag, replacing
27880 \begin_inset Quotes eld
27884 \begin_inset Flex Code
27887 \begin_layout Plain Layout
27889 \change_inserted -970929547 1515110057
27898 \begin_inset Quotes erd
27901 in the example above.
27902 This information can be used in further processing of the DocBook files.
27908 \begin_layout Description
27910 \change_inserted -970929547 1496612296
27911 \begin_inset Flex Code
27914 \begin_layout Plain Layout
27916 \change_inserted -970929547 1496612269
27925 \begin_inset Flex Code
27928 \begin_layout Plain Layout
27930 \change_inserted -970929547 1496610966
27938 ] The tag to be used for this inset, replacing
27939 \begin_inset Quotes eld
27943 \begin_inset Flex Code
27946 \begin_layout Plain Layout
27948 \change_inserted -970929547 1496612296
27957 \begin_inset Quotes erd
27960 in the example above.
27961 The default is the name of the float and always needs to be changed, as
27962 DocBook provides no generic tag.
27963 \change_inserted 1075283030 1597698868
27967 \begin_layout Description
27969 \change_inserted 1075283030 1597699399
27970 \begin_inset Flex Code
27973 \begin_layout Plain Layout
27975 \change_inserted 1075283030 1597698872
27984 \begin_inset Flex Code
27987 \begin_layout Plain Layout
27989 \change_inserted 1075283030 1597700585
27990 block, paragraph, inline
27997 ] The new-line policy for this tag, see Section
27998 \begin_inset space ~
28002 \begin_inset CommandInset ref
28004 reference "subsec:DocBook-New-line-policy"
28017 \begin_layout Subsection
28019 \change_inserted 1075283030 1597699385
28021 \begin_inset CommandInset label
28023 name "subsec:DocBook-New-line-policy"
28030 \begin_layout Standard
28032 \change_inserted 1075283030 1597698993
28033 For all tags, there are three possible policies for outputting new lines
28035 \begin_inset Flex Code
28038 \begin_layout Plain Layout
28040 \change_inserted 1075283030 1597698987
28051 \begin_layout Itemize
28053 \change_inserted 1075283030 1597699279
28054 \begin_inset Quotes eld
28058 \begin_inset Flex Code
28061 \begin_layout Plain Layout
28063 \change_inserted 1075283030 1597699012
28072 \begin_inset Quotes erd
28075 : the opening and closing tags are on their own lines (i.e.
28076 a line feed after and before the opening and the closing tags).
28077 Typical elements are floats.
28081 \begin_layout LyX-Code
28083 \change_inserted 1075283030 1597699194
28087 \begin_layout LyX-Code
28089 \change_inserted 1075283030 1597699194
28093 \begin_layout LyX-Code
28095 \change_inserted 1075283030 1597699098
28096 Contents of the block.
28099 \begin_layout LyX-Code
28101 \change_inserted 1075283030 1597699196
28105 \begin_layout LyX-Code
28107 \change_inserted 1075283030 1597699198
28111 \begin_layout Itemize
28113 \change_inserted 1075283030 1597699289
28114 \begin_inset Quotes eld
28118 \begin_inset Flex Code
28121 \begin_layout Plain Layout
28123 \change_inserted 1075283030 1597699113
28132 \begin_inset Quotes erd
28135 : the opening and closing tags are on the same, new line; a line feed is
28136 output before the opening tag and after the closing tag.
28137 Typical elements are paragraphs and list items.
28141 \begin_layout LyX-Code
28143 \change_inserted 1075283030 1597699186
28147 \begin_layout LyX-Code
28149 \change_inserted 1075283030 1597699357
28150 <paratag>Contents of the paragraph.</paratag>
28153 \begin_layout LyX-Code
28155 \change_inserted 1075283030 1597699231
28159 \begin_layout Itemize
28161 \change_inserted 1075283030 1597699343
28162 \begin_inset Quotes eld
28166 \begin_inset Flex Code
28169 \begin_layout Plain Layout
28171 \change_inserted 1075283030 1597699307
28180 \begin_inset Quotes erd
28183 : the opening and closing tags are on the same line as the rest of the content.
28184 No line feeds are output.
28185 Typical elements are fonts.
28189 \begin_layout LyX-Code
28191 \change_inserted 1075283030 1597699585
28192 Content before<inlinetag>Contents of the paragraph.</inlinetag>Content after
28195 \begin_layout Standard
28197 \change_inserted 1075283030 1597699585
28198 The default value is always
28199 \begin_inset Quotes eld
28203 \begin_inset Flex Code
28206 \begin_layout Plain Layout
28208 \change_inserted 1075283030 1597699585
28217 \begin_inset Quotes erd
28225 \begin_layout Subsection
28227 \change_inserted -970929547 1515111533
28228 InsetLayout DocBook
28233 \begin_layout Standard
28235 \change_inserted -970929547 1496611894
28236 The DocBook output of insets can also be controlled by information in layout
28240 \begin_layout Standard
28242 \change_inserted -970929547 1496612045
28243 The DocBook \SpecialChar LyX
28244 outputs for an inset has the following form:
28247 \begin_layout LyX-Code
28249 \change_inserted -970929547 1515110861
28250 <wrappertag wrapperattr>
28253 \begin_layout LyX-Code
28255 \change_inserted -970929547 1515110868
28259 \begin_layout LyX-Code
28261 \change_inserted -970929547 1515110869
28262 <innertag innerattr>
28265 \begin_layout LyX-Code
28267 \change_inserted -970929547 1515110869
28268 Contents of the inset.
28271 \begin_layout LyX-Code
28273 \change_inserted -970929547 1515110870
28277 \begin_layout LyX-Code
28279 \change_inserted -970929547 1515110871
28283 \begin_layout LyX-Code
28285 \change_inserted -970929547 1515111172
28289 \begin_layout Standard
28291 \change_inserted -970929547 1515111186
28292 For an itemising inset, it rather looks like this:
28295 \begin_layout LyX-Code
28297 \change_inserted -970929547 1515111186
28298 <wrappertag wrapperattr>
28301 \begin_layout LyX-Code
28303 \change_inserted -970929547 1515111186
28307 \begin_layout LyX-Code
28309 \change_inserted -970929547 1515111186
28310 <innertag innerattr>
28313 \begin_layout LyX-Code
28315 \change_inserted -970929547 1515111362
28316 <itemwrappertag itemwrapperattr>
28319 \begin_layout LyX-Code
28321 \change_inserted -970929547 1515111364
28322 <itemlabeltag itemattr>
28325 \begin_layout LyX-Code
28327 \change_inserted -970929547 1515111367
28328 Label of the first item.
28331 \begin_layout LyX-Code
28333 \change_inserted -970929547 1515111362
28339 \begin_layout LyX-Code
28341 \change_inserted -970929547 1515111517
28345 \begin_layout LyX-Code
28347 \change_inserted -970929547 1515111517
28353 \begin_layout LyX-Code
28355 \change_inserted -970929547 1515111516
28356 Contents of the first item.
28359 \begin_layout LyX-Code
28361 \change_inserted -970929547 1515111514
28367 \begin_layout LyX-Code
28369 \change_inserted -970929547 1515111247
28375 \begin_layout LyX-Code
28377 \change_inserted -970929547 1515111221
28381 \begin_layout LyX-Code
28383 \change_inserted -970929547 1515111370
28384 <itemwrappertag itemwrapperattr>
28387 \begin_layout LyX-Code
28389 \change_inserted -970929547 1515111370
28390 <itemlabeltag itemattr>
28393 \begin_layout LyX-Code
28395 \change_inserted -970929547 1515111372
28396 Label of the second item.
28399 \begin_layout LyX-Code
28401 \change_inserted -970929547 1515111370
28407 \begin_layout LyX-Code
28409 \change_inserted -970929547 1515111504
28413 \begin_layout LyX-Code
28415 \change_inserted -970929547 1515111505
28421 \begin_layout LyX-Code
28423 \change_inserted -970929547 1515111507
28424 Contents of the second item.
28427 \begin_layout LyX-Code
28429 \change_inserted -970929547 1515111509
28435 \begin_layout LyX-Code
28437 \change_inserted -970929547 1515111251
28443 \begin_layout LyX-Code
28445 \change_inserted -970929547 1515111221
28451 \begin_layout LyX-Code
28453 \change_inserted -970929547 1515111219
28459 \begin_layout LyX-Code
28461 \change_inserted -970929547 1515111186
28465 \begin_layout LyX-Code
28467 \change_inserted -970929547 1515111186
28471 \begin_layout LyX-Code
28473 \change_inserted -970929547 1515111186
28477 \begin_layout Standard
28479 \change_inserted -970929547 1515111183
28480 If the inset permits multiple paragraphs—that is, if
28481 \begin_inset Flex Code
28484 \begin_layout Plain Layout
28486 \change_inserted -970929547 1496610966
28494 is true—then the contents of the inset will itself be output as paragraphs
28495 formatted according to the styles used for those paragraphs (standard,
28496 quote, and the like).
28497 The inner tag is optional and, by default, does not appear.
28500 \begin_layout Standard
28502 \change_inserted -970929547 1496610966
28503 The specific tags and attributes output for each inset can be controlled
28504 by means of the following layout tags.
28507 \begin_layout Description
28509 \change_inserted -970929547 1515110317
28510 \begin_inset Flex Code
28513 \begin_layout Plain Layout
28515 \change_inserted -970929547 1515109695
28524 \begin_inset Flex Code
28527 \begin_layout Plain Layout
28529 \change_inserted -970929547 1496611854
28537 ] Specifies attribute information to be output with the main tag, replacing
28539 \begin_inset Quotes eld
28543 \begin_inset Flex Code
28546 \begin_layout Plain Layout
28548 \change_inserted -970929547 1515110044
28557 \begin_inset Quotes erd
28560 in the example above.
28561 This information can be used in further processing of the DocBook files.
28565 \begin_layout Description
28567 \change_inserted -970929547 1515110973
28568 \begin_inset Flex Code
28571 \begin_layout Plain Layout
28573 \change_inserted -970929547 1515110319
28582 \begin_inset Flex Code
28585 \begin_layout Plain Layout
28587 \change_inserted -970929547 1515110384
28588 never, always, maybe
28595 ] Specifies whether this tag goes into the
28596 \begin_inset Flex Code
28599 \begin_layout Plain Layout
28601 \change_inserted -970929547 1515110412
28609 tag at the beginning of the parent layout.
28611 \begin_inset Flex Code
28614 \begin_layout Plain Layout
28616 \change_inserted -970929547 1515110437
28624 indicates that the tag never goes into
28625 \begin_inset Flex Code
28628 \begin_layout Plain Layout
28630 \change_inserted -970929547 1515110497
28638 (this is default value, and corresponds to usual content).
28640 \begin_inset Flex Code
28643 \begin_layout Plain Layout
28645 \change_inserted -970929547 1515110517
28653 indicates that the tag always goes into
28654 \begin_inset Flex Code
28657 \begin_layout Plain Layout
28659 \change_inserted -970929547 1515110514
28667 (this corresponds to usual metadata): if there is no
28668 \begin_inset Flex Code
28671 \begin_layout Plain Layout
28673 \change_inserted -970929547 1515110550
28681 tag for the parent, one
28687 \begin_inset Flex Code
28690 \begin_layout Plain Layout
28692 \change_inserted -970929547 1515110540
28700 indicates that the tag may go into
28701 \begin_inset Flex Code
28704 \begin_layout Plain Layout
28706 \change_inserted -970929547 1515110538
28714 (this is only the case for titles): if there is no
28715 \begin_inset Flex Code
28718 \begin_layout Plain Layout
28720 \change_inserted -970929547 1515110585
28728 tag for the parent,
28732 will be generated, the corresponding tag will be output directly as content.
28736 \begin_layout Description
28738 \change_inserted -970929547 1515111461
28739 \begin_inset Flex Code
28742 \begin_layout Plain Layout
28744 \change_inserted -970929547 1515110974
28753 \begin_inset Flex Code
28756 \begin_layout Plain Layout
28758 \change_inserted -970929547 1515110973
28766 ] Specifies attribute information to be output with the item tag, replacing
28768 \begin_inset Quotes eld
28772 \begin_inset Flex Code
28775 \begin_layout Plain Layout
28777 \change_inserted -970929547 1515110984
28786 \begin_inset Quotes erd
28789 in the example above.
28790 This information can be used in further processing of the DocBook files.
28794 \begin_layout Description
28796 \change_inserted -970929547 1515111471
28797 \begin_inset Flex Code
28800 \begin_layout Plain Layout
28802 \change_inserted -970929547 1515111465
28803 DocBookItemInnerAttr
28811 \begin_inset Flex Code
28814 \begin_layout Plain Layout
28816 \change_inserted -970929547 1515111461
28824 ] Specifies attribute information to be output with the item inner tag,
28826 \begin_inset Quotes eld
28830 \begin_inset Flex Code
28833 \begin_layout Plain Layout
28835 \change_inserted -970929547 1515111476
28844 \begin_inset Quotes erd
28847 in the example above.
28848 This information can be used in further processing of the DocBook files.
28852 \begin_layout Description
28854 \change_inserted -970929547 1515111494
28855 \begin_inset Flex Code
28858 \begin_layout Plain Layout
28860 \change_inserted -970929547 1515111467
28861 DocBookItemInnerTag
28869 \begin_inset Flex Code
28872 \begin_layout Plain Layout
28874 \change_inserted -970929547 1515111461
28882 ] The tag to be used for the item inner tag within the inset, replacing
28884 \begin_inset Quotes eld
28888 \begin_inset Flex Code
28891 \begin_layout Plain Layout
28893 \change_inserted -970929547 1515111486
28902 \begin_inset Quotes erd
28905 in the example above.
28907 \begin_inset Flex Code
28910 \begin_layout Plain Layout
28912 \change_inserted -970929547 1515111461
28920 , indicating that there is no item inner tag: content is directly output
28921 without it for each itemised element.
28922 This parameter only makes sense when itemising layouts are used, such as
28925 \change_inserted 1075283030 1598469472
28926 The most likely value is
28927 \begin_inset Quotes eld
28931 \begin_inset Flex Code
28934 \begin_layout Plain Layout
28936 \change_inserted 1075283030 1598469476
28945 \begin_inset Quotes erd
28949 \begin_inset Newline newline
28952 When a list item is split using a new line, the item inner tag will be repeated
28953 for each part of the paragraph, parts being separated by new lines.
28957 \begin_layout Description
28959 \change_inserted 1075283030 1597699866
28960 \begin_inset Flex Code
28963 \begin_layout Plain Layout
28965 \change_inserted 1075283030 1597699853
28966 DocBookItemInnerTagType
28974 \begin_inset Flex Code
28977 \begin_layout Plain Layout
28979 \change_inserted 1075283030 1597699866
28980 block, paragraph, inline
28987 ] The new-line policy for this tag, see Section
28988 \begin_inset space ~
28992 \begin_inset CommandInset ref
28994 reference "subsec:DocBook-New-line-policy"
29007 \begin_layout Description
29009 \change_inserted -970929547 1515111290
29010 \begin_inset Flex Code
29013 \begin_layout Plain Layout
29015 \change_inserted -970929547 1515111283
29016 DocBookItemLabelAttr
29024 \begin_inset Flex Code
29027 \begin_layout Plain Layout
29029 \change_inserted -970929547 1515111279
29037 ] Specifies attribute information to be output with the item label tag,
29039 \begin_inset Quotes eld
29043 \begin_inset Flex Code
29046 \begin_layout Plain Layout
29048 \change_inserted -970929547 1515111304
29057 \begin_inset Quotes erd
29060 in the example above.
29061 This information can be used in further processing of the DocBook files.
29065 \begin_layout Description
29067 \change_inserted -970929547 1515111337
29068 \begin_inset Flex Code
29071 \begin_layout Plain Layout
29073 \change_inserted -970929547 1515111285
29074 DocBookItemLabelTag
29082 \begin_inset Flex Code
29085 \begin_layout Plain Layout
29087 \change_inserted -970929547 1515111279
29095 ] The tag to be used for the item label tag within the inset, replacing
29097 \begin_inset Quotes eld
29101 \begin_inset Flex Code
29104 \begin_layout Plain Layout
29106 \change_inserted -970929547 1515111311
29115 \begin_inset Quotes erd
29118 in the example above.
29119 This parameter only makes sense when itemising layouts are used with a
29120 notion of labels, such as definition lists.
29122 \change_inserted 1075283030 1597699874
29126 \begin_layout Description
29128 \change_inserted 1075283030 1597699874
29129 \begin_inset Flex Code
29132 \begin_layout Plain Layout
29134 \change_inserted 1075283030 1597699880
29135 DocBookItemLabelTagType
29143 \begin_inset Flex Code
29146 \begin_layout Plain Layout
29148 \change_inserted 1075283030 1597699874
29149 block, paragraph, inline
29156 ] The new-line policy for this tag, see Section
29157 \begin_inset space ~
29161 \begin_inset CommandInset ref
29163 reference "subsec:DocBook-New-line-policy"
29176 \begin_layout Description
29178 \change_inserted -970929547 1515111124
29179 \begin_inset Flex Code
29182 \begin_layout Plain Layout
29184 \change_inserted -970929547 1515111060
29193 \begin_inset Flex Code
29196 \begin_layout Plain Layout
29198 \change_inserted -970929547 1515111060
29206 ] The tag to be used for the item tag within the inset, replacing
29207 \begin_inset Quotes eld
29211 \begin_inset Flex Code
29214 \begin_layout Plain Layout
29216 \change_inserted -970929547 1515111060
29225 \begin_inset Quotes erd
29228 in the example above.
29230 \begin_inset Flex Code
29233 \begin_layout Plain Layout
29235 \change_inserted -970929547 1515111060
29243 , indicating that there is no item tag.
29244 This parameter only makes sense when itemising layouts are used, such as
29247 \change_inserted 1075283030 1597699890
29251 \begin_layout Description
29253 \change_inserted 1075283030 1597699890
29254 \begin_inset Flex Code
29257 \begin_layout Plain Layout
29259 \change_inserted 1075283030 1597699890
29268 \begin_inset Flex Code
29271 \begin_layout Plain Layout
29273 \change_inserted 1075283030 1597699890
29274 block, paragraph, inline
29281 ] The new-line policy for this tag, see Section
29282 \begin_inset space ~
29286 \begin_inset CommandInset ref
29288 reference "subsec:DocBook-New-line-policy"
29301 \begin_layout Description
29303 \change_inserted -970929547 1515111298
29304 \begin_inset Flex Code
29307 \begin_layout Plain Layout
29309 \change_inserted -970929547 1515111124
29310 DocBookItemWrapperAttr
29318 \begin_inset Flex Code
29321 \begin_layout Plain Layout
29323 \change_inserted -970929547 1515111124
29331 ] Specifies attribute information to be output with the item wrapper tag,
29333 \begin_inset Quotes eld
29337 \begin_inset Flex Code
29340 \begin_layout Plain Layout
29342 \change_inserted -970929547 1515111150
29351 \begin_inset Quotes erd
29354 in the example above.
29355 This information can be used in further processing of the DocBook files.
29361 \begin_layout Description
29363 \change_inserted -970929547 1515111113
29364 \begin_inset Flex Code
29367 \begin_layout Plain Layout
29369 \change_inserted -970929547 1515111073
29370 DocBookItemWrapperTag
29378 \begin_inset Flex Code
29381 \begin_layout Plain Layout
29383 \change_inserted -970929547 1515111073
29391 ] The tag to be used for the item wrapper tag within the inset, replacing
29393 \begin_inset Quotes eld
29397 \begin_inset Flex Code
29400 \begin_layout Plain Layout
29402 \change_inserted -970929547 1515111083
29411 \begin_inset Quotes erd
29414 in the example above.
29416 \begin_inset Flex Code
29419 \begin_layout Plain Layout
29421 \change_inserted -970929547 1515111073
29429 , indicating that there is no item wrapper tag: tag and content are directly
29430 output without it for each itemised element.
29431 This parameter only makes sense when itemising layouts are used, such as
29434 \change_inserted 1075283030 1597699897
29438 \begin_layout Description
29440 \change_inserted 1075283030 1597699897
29441 \begin_inset Flex Code
29444 \begin_layout Plain Layout
29446 \change_inserted 1075283030 1597699900
29447 DocBookItemWrapperTagType
29455 \begin_inset Flex Code
29458 \begin_layout Plain Layout
29460 \change_inserted 1075283030 1597699897
29461 block, paragraph, inline
29468 ] The new-line policy for this tag, see Section
29469 \begin_inset space ~
29473 \begin_inset CommandInset ref
29475 reference "subsec:DocBook-New-line-policy"
29488 \begin_layout Description
29490 \change_inserted -970929547 1515110104
29491 \begin_inset Flex Code
29494 \begin_layout Plain Layout
29496 \change_inserted -970929547 1515110104
29505 \begin_inset Flex Code
29508 \begin_layout Plain Layout
29510 \change_inserted -970929547 1515110104
29518 ] Specifies attribute information to be output with the inner tag, replacing
29520 \begin_inset Quotes eld
29524 \begin_inset Flex Code
29527 \begin_layout Plain Layout
29529 \change_inserted -970929547 1515110104
29538 \begin_inset Quotes erd
29541 in the example above.
29542 This information can be used in further processing of the DocBook files.
29546 \begin_layout Description
29548 \change_inserted -970929547 1515110906
29549 \begin_inset Flex Code
29552 \begin_layout Plain Layout
29554 \change_inserted -970929547 1515110104
29563 \begin_inset Flex Code
29566 \begin_layout Plain Layout
29568 \change_inserted -970929547 1515110104
29576 ] The tag to be used for the inner tag within the inset, replacing
29577 \begin_inset Quotes eld
29581 \begin_inset Flex Code
29584 \begin_layout Plain Layout
29586 \change_inserted -970929547 1515110104
29595 \begin_inset Quotes erd
29598 in the example above.
29600 \begin_inset Flex Code
29603 \begin_layout Plain Layout
29605 \change_inserted -970929547 1515110791
29613 , indicating that there is no inner tag: content is directly output without
29615 \change_inserted 1075283030 1597699904
29619 \begin_layout Description
29621 \change_inserted 1075283030 1597699904
29622 \begin_inset Flex Code
29625 \begin_layout Plain Layout
29627 \change_inserted 1075283030 1597699904
29628 DocBookInnerTagType
29636 \begin_inset Flex Code
29639 \begin_layout Plain Layout
29641 \change_inserted 1075283030 1597699904
29642 block, paragraph, inline
29649 ] The new-line policy for this tag, see Section
29650 \begin_inset space ~
29654 \begin_inset CommandInset ref
29656 reference "subsec:DocBook-New-line-policy"
29669 \begin_layout Description
29671 \change_inserted -970929547 1515110753
29672 \begin_inset Flex Code
29675 \begin_layout Plain Layout
29677 \change_inserted -970929547 1515110665
29686 \begin_inset Flex Code
29689 \begin_layout Plain Layout
29691 \change_inserted -970929547 1515110661
29699 ] Specifies the tag that corresponds to this kind of section.
29700 This parameter only makes sense for sectioning elements (part, chapter,
29702 The default value is
29703 \begin_inset Flex Code
29706 \begin_layout Plain Layout
29708 \change_inserted -970929547 1515110721
29716 , and is only overridden when DocBook uses something else for sectioning
29718 \change_inserted 1075283030 1597699921
29720 \change_inserted -970929547 1515110753
29721 parts and chapters of a book).
29727 \begin_layout Description
29729 \change_inserted -970929547 1515110811
29730 \begin_inset Flex Code
29733 \begin_layout Plain Layout
29735 \change_inserted -970929547 1496612023
29744 \begin_inset Flex Code
29747 \begin_layout Plain Layout
29749 \change_inserted -970929547 1496610966
29757 ] The tag to be used for this inset, replacing
29758 \begin_inset Quotes eld
29762 \begin_inset Flex Code
29765 \begin_layout Plain Layout
29767 \change_inserted -970929547 1496612033
29776 \begin_inset Quotes erd
29779 in the example above.
29780 The default is the name of the float and always needs to be changed, as
29781 DocBook provides no generic inset tag.
29782 \change_inserted 1075283030 1597699924
29786 \begin_layout Description
29788 \change_inserted 1075283030 1597699924
29789 \begin_inset Flex Code
29792 \begin_layout Plain Layout
29794 \change_inserted 1075283030 1597699924
29803 \begin_inset Flex Code
29806 \begin_layout Plain Layout
29808 \change_inserted 1075283030 1597699924
29809 block, paragraph, inline
29816 ] The new-line policy for this tag, see Section
29817 \begin_inset space ~
29821 \begin_inset CommandInset ref
29823 reference "subsec:DocBook-New-line-policy"
29836 \begin_layout Description
29838 \change_inserted -970929547 1515110832
29839 \begin_inset Flex Code
29842 \begin_layout Plain Layout
29844 \change_inserted -970929547 1515110822
29853 \begin_inset Flex Code
29856 \begin_layout Plain Layout
29858 \change_inserted -970929547 1515110811
29866 ] Specifies attribute information to be output with the outer tag, replacing
29868 \begin_inset Quotes eld
29872 \begin_inset Flex Code
29875 \begin_layout Plain Layout
29877 \change_inserted -970929547 1515110845
29886 \begin_inset Quotes erd
29889 in the example above.
29890 This information can be used in further processing of the DocBook files.
29894 \begin_layout Description
29896 \change_inserted -970929547 1515110917
29897 \begin_inset Flex Code
29900 \begin_layout Plain Layout
29902 \change_inserted -970929547 1515110826
29911 \begin_inset Flex Code
29914 \begin_layout Plain Layout
29916 \change_inserted -970929547 1515110811
29924 ] The tag to be used for the wrapper tag around the inset, replacing
29925 \begin_inset Quotes eld
29929 \begin_inset Flex Code
29932 \begin_layout Plain Layout
29934 \change_inserted -970929547 1515110842
29943 \begin_inset Quotes erd
29946 in the example above.
29948 \begin_inset Flex Code
29951 \begin_layout Plain Layout
29953 \change_inserted -970929547 1515110811
29961 , indicating that there is no wrapper tag: tag and content are directly
29963 \change_inserted 1075283030 1597699929
29967 \begin_layout Description
29969 \change_inserted 1075283030 1597699929
29970 \begin_inset Flex Code
29973 \begin_layout Plain Layout
29975 \change_inserted 1075283030 1597699932
29976 DocBookWrapperTagType
29984 \begin_inset Flex Code
29987 \begin_layout Plain Layout
29989 \change_inserted 1075283030 1597699929
29990 block, paragraph, inline
29997 ] The new-line policy for this tag, see Section
29998 \begin_inset space ~
30002 \begin_inset CommandInset ref
30004 reference "subsec:DocBook-New-line-policy"
30017 \begin_layout Subsection
30019 \change_inserted -970929547 1515110040
30023 \begin_layout Standard
30025 \change_inserted -970929547 1496611700
30026 The DocBook output for floats too can be controlled by layout information.
30027 The output has the following form:
30030 \begin_layout LyX-Code
30032 \change_inserted -970929547 1515109700
30036 \begin_layout LyX-Code
30038 \change_inserted -970929547 1515110138
30039 Contents of the float as DocBook.
30042 \begin_layout LyX-Code
30044 \change_inserted -970929547 1496610966
30048 \begin_layout Standard
30050 \change_inserted -970929547 1496611715
30051 The caption, if there is one, is a separate inset and will be output as
30056 \begin_layout Description
30058 \change_inserted -970929547 1515110033
30059 \begin_inset Flex Code
30062 \begin_layout Plain Layout
30064 \change_inserted -970929547 1515109702
30073 \begin_inset Flex Code
30076 \begin_layout Plain Layout
30078 \change_inserted -970929547 1496610966
30086 ] Specifies attribute information to be output with the main tag, replacing
30088 \begin_inset Quotes eld
30092 \begin_inset Flex Code
30095 \begin_layout Plain Layout
30097 \change_inserted -970929547 1515110035
30106 \begin_inset Quotes erd
30109 in the example above.
30110 This information can be used in further processing of the DocBook files.
30114 \begin_layout Description
30116 \change_inserted -970929547 1515110157
30117 \begin_inset Flex Code
30120 \begin_layout Plain Layout
30122 \change_inserted -970929547 1496611782
30131 \begin_inset Flex Code
30134 \begin_layout Plain Layout
30136 \change_inserted -970929547 1496610966
30144 ] The tag to be used for this float, replacing
30145 \begin_inset Quotes eld
30149 \begin_inset Flex Code
30152 \begin_layout Plain Layout
30154 \change_inserted -970929547 1496610966
30163 \begin_inset Quotes erd
30166 in the example above.
30167 The default is the name of the float and always needs to be changed, as
30168 DocBook provides no generic float tag.
30171 \begin_layout Subsection
30173 \change_inserted -970929547 1515110157
30174 Bibliography formatting
30177 \begin_layout Standard
30179 \change_deleted 1075283030 1597699984
30181 \change_inserted 1075283030 1597699985
30183 \change_inserted -970929547 1515110187
30185 \change_deleted 1075283030 1597699987
30187 \change_inserted 1075283030 1597699987
30189 \change_inserted -970929547 1515110187
30190 cannot be formatted: all fields are always output in the database-like
30191 DocBook format (equivalent to a BibTeX file)
30192 \change_inserted 1075283030 1597700117
30194 \begin_inset Flex Code
30197 \begin_layout Plain Layout
30199 \change_inserted 1075283030 1597700120
30208 \change_inserted -970929547 1515110187
30210 \change_inserted 1075283030 1597700092
30214 \begin_layout Standard
30216 \change_inserted 1075283030 1597700112
30217 When the bibliographic entries are manually inserted into the LyX document
30218 as Bibliography Items, the user deals with formatting themself: there is
30219 no attempt of parsing what the user wrote, the string is directly used
30221 \begin_inset Flex Code
30224 \begin_layout Plain Layout
30226 \change_inserted 1075283030 1597700076
30240 \begin_layout Chapter
30241 Including External Material
30242 \begin_inset CommandInset label
30244 name "chap:Including-External-Material"
30251 \begin_layout Standard
30252 \begin_inset Box Shadowbox
30262 height_special "totalheight"
30267 backgroundcolor "none"
30270 \begin_layout Plain Layout
30271 WARNING: This portion of the documentation has not been updated for some
30273 We certainly hope that it is still accurate, but there are no guarantees.
30281 \begin_layout Standard
30282 The use of material from sources external to \SpecialChar LyX
30283 is covered in detail in the
30289 This part of the manual covers what needs to happen behind the scenes for
30290 new sorts of material to be included.
30293 \begin_layout Section
30297 \begin_layout Standard
30298 The external material feature is based on the concept of a
30303 A template is a specification of how \SpecialChar LyX
30304 should interface with a certain kind
30306 As bundled, \SpecialChar LyX
30307 comes with predefined templates for Xfig figures, various
30308 raster format images, chess diagrams, and LilyPond music notation.
30309 You can check the actual list by using the menu
30310 \begin_inset Flex Noun
30313 \begin_layout Plain Layout
30314 Insert\SpecialChar menuseparator
30315 File\SpecialChar menuseparator
30322 Furthermore, it is possible to roll your own template to support a specific
30324 Later we'll describe in more detail what is involved, and hopefully you
30325 will submit all the templates you create so we can include them in a later
30330 \begin_layout Standard
30331 Another basic idea of the external material feature is to distinguish between
30332 the original file that serves as a base for final material and the produced
30333 file that is included in your exported or printed document.
30334 For example, consider the case of a figure produced with
30335 \begin_inset Flex Code
30338 \begin_layout Plain Layout
30345 The Xfig application itself works on an original file with the
30346 \begin_inset Flex Code
30349 \begin_layout Plain Layout
30356 Within Xfig, you create and change your figure, and when you are done,
30358 \begin_inset Flex Code
30361 \begin_layout Plain Layout
30368 When you want to include the figure in your document, you invoke
30369 \begin_inset Flex Code
30372 \begin_layout Plain Layout
30378 in order to create a PostScript file that can readily be included in your
30382 \begin_inset Flex Code
30385 \begin_layout Plain Layout
30391 file is the original file, and the PostScript file is the produced file.
30394 \begin_layout Standard
30395 This distinction is important in order to allow updating of the material
30396 while you are in the process of writing the document.
30397 Furthermore, it provides us with the flexibility that is needed to support
30398 multiple export formats.
30399 For instance, in the case of a plain text file, it is not exactly an award-winn
30400 ing idea to include the figure as raw PostScript.
30401 Instead, you would either prefer to just include a reference to the figure
30402 or try to invoke some graphics to ASCII converter to make the final result
30403 look similar to the real graphics.
30404 The external material management allows you to do this, because it is parametri
30405 zed on the different export formats that \SpecialChar LyX
30409 \begin_layout Standard
30410 Besides supporting the production of different products according to the
30411 exported format, it supports tight integration with editing and viewing
30413 In the case of an Xfig figure, you are able to invoke Xfig on the original
30414 file with a single click from within the external material dialog in \SpecialChar LyX
30416 and also preview the produced PostScript file with Ghostview with another
30418 No more fiddling around with the command line and/or file browsers to locate
30419 and manipulate the original or produced files.
30420 In this way, you are finally able to take full advantage of the many different
30421 applications that are relevant to use when you write your documents, and
30422 ultimately be more productive.
30425 \begin_layout Section
30426 The external template configuration files
30429 \begin_layout Standard
30430 It is relatively easy to add custom external template definitions to \SpecialChar LyX
30432 However, be aware that doing this in an careless manner most probably
30436 introduce an easily exploitable security hole.
30437 So before you do this, please read the discussion about security in
30438 \begin_inset CommandInset ref
30440 reference "sec:Security-discussion"
30447 \begin_layout Standard
30448 Having said that, we encourage you to submit any interesting templates that
30453 \begin_layout Standard
30454 The external templates are defined in the
30455 \begin_inset Flex Code
30458 \begin_layout Plain Layout
30464 files that are stored in the
30465 \begin_inset Flex Code
30468 \begin_layout Plain Layout
30469 LyXDir/lib/xtemplates/
30475 Each template is defined in a file of its own.
30476 You can place your own templates in
30477 \begin_inset Flex Code
30480 \begin_layout Plain Layout
30481 UserDir/xtemplates/
30486 or copy existing templates to that directory in order to modify them.
30489 \begin_layout Standard
30490 A typical template looks like this:
30493 \begin_layout LyX-Code
30497 \begin_layout LyX-Code
30498 GuiName "XFig: $$AbsOrRelPathParent$$Basename"
30501 \begin_layout LyX-Code
30505 \begin_layout LyX-Code
30509 \begin_layout LyX-Code
30513 \begin_layout LyX-Code
30517 \begin_layout LyX-Code
30521 \begin_layout LyX-Code
30522 AutomaticProduction true
30525 \begin_layout LyX-Code
30529 \begin_layout LyX-Code
30533 \begin_layout LyX-Code
30537 \begin_layout LyX-Code
30538 TransformCommand Rotate RotationLatexCommand
30541 \begin_layout LyX-Code
30542 TransformCommand Resize ResizeLatexCommand
30545 \begin_layout LyX-Code
30546 Product "$$RotateFront$$ResizeFront
30549 \begin_layout LyX-Code
30554 input{$$AbsOrRelPathMaster$$Basename.pstex_t}
30557 \begin_layout LyX-Code
30558 $$ResizeBack$$RotateBack"
30561 \begin_layout LyX-Code
30565 \begin_layout LyX-Code
30566 UpdateResult "$$AbsPath$$Basename.pstex_t"
30569 \begin_layout LyX-Code
30570 Requirement "graphicx"
30573 \begin_layout LyX-Code
30574 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
30577 \begin_layout LyX-Code
30578 ReferencedFile latex "$$AbsPath$$Basename.eps"
30581 \begin_layout LyX-Code
30582 ReferencedFile dvi "$$AbsPath$$Basename.eps"
30585 \begin_layout LyX-Code
30589 \begin_layout LyX-Code
30593 \begin_layout LyX-Code
30594 TransformCommand Rotate RotationLatexCommand
30597 \begin_layout LyX-Code
30598 TransformCommand Resize ResizeLatexCommand
30601 \begin_layout LyX-Code
30602 Product "$$RotateFront$$ResizeFront
30605 \begin_layout LyX-Code
30610 input{$$AbsOrRelPathMaster$$Basename.pdftex_t}
30613 \begin_layout LyX-Code
30614 $$ResizeBack$$RotateBack"
30617 \begin_layout LyX-Code
30618 UpdateFormat pdftex
30621 \begin_layout LyX-Code
30622 UpdateResult "$$AbsPath$$Basename.pdftex_t"
30625 \begin_layout LyX-Code
30626 Requirement "graphicx"
30629 \begin_layout LyX-Code
30630 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pdftex_t"
30633 \begin_layout LyX-Code
30634 ReferencedFile latex "$$AbsPath$$Basename.pdf"
30637 \begin_layout LyX-Code
30641 \begin_layout LyX-Code
30645 \begin_layout LyX-Code
30646 Product "[XFig: $$FName]"
30649 \begin_layout LyX-Code
30653 \begin_layout LyX-Code
30657 \begin_layout LyX-Code
30658 Product "<graphic fileref=
30660 "$$AbsOrRelPathMaster$$Basename.eps
30665 \begin_layout LyX-Code
30669 \begin_layout LyX-Code
30673 \begin_layout LyX-Code
30674 UpdateResult "$$AbsPath$$Basename.eps"
30677 \begin_layout LyX-Code
30678 ReferencedFile docbook "$$AbsPath$$Basename.eps"
30681 \begin_layout LyX-Code
30682 ReferencedFile docbook-xml "$$AbsPath$$Basename.eps"
30685 \begin_layout LyX-Code
30689 \begin_layout LyX-Code
30693 \begin_layout Standard
30694 As you can see, the template is enclosed in
30695 \begin_inset Flex Code
30698 \begin_layout Plain Layout
30706 \begin_inset Flex Code
30709 \begin_layout Plain Layout
30716 It contains a header specifying some general settings and, for each supported
30717 primary document file format, a section
30718 \begin_inset Flex Code
30721 \begin_layout Plain Layout
30729 \begin_inset Flex Code
30732 \begin_layout Plain Layout
30741 \begin_layout Subsection
30742 The template header
30745 \begin_layout Description
30746 \begin_inset Flex Code
30749 \begin_layout Plain Layout
30750 AutomaticProduction
30751 \begin_inset space ~
30759 Whether the file represented by the template must be generated by \SpecialChar LyX
30761 This command must occur exactly once.
30764 \begin_layout Description
30765 \begin_inset Flex Code
30768 \begin_layout Plain Layout
30770 \begin_inset space ~
30778 A glob pattern that is used in the file dialog to filter out the desired
30780 If there is more than one possible file extension (e.
30781 \begin_inset space \thinspace{}
30785 \begin_inset space \space{}
30789 \begin_inset Flex Code
30792 \begin_layout Plain Layout
30799 \begin_inset Flex Code
30802 \begin_layout Plain Layout
30808 ), use something like
30809 \begin_inset Flex Code
30812 \begin_layout Plain Layout
30819 This command must occur exactly once.
30822 \begin_layout Description
30823 \begin_inset Flex Code
30826 \begin_layout Plain Layout
30828 \begin_inset space ~
30836 The text that is displayed on the button.
30837 This command must occur exactly once.
30840 \begin_layout Description
30841 \begin_inset Flex Code
30844 \begin_layout Plain Layout
30846 \begin_inset space ~
30850 \begin_inset space ~
30858 The help text that is used in the External dialog.
30859 Provide enough information to explain to the user just what the template
30860 can provide him with.
30861 This command must occur exactly once.
30864 \begin_layout Description
30865 \begin_inset Flex Code
30868 \begin_layout Plain Layout
30870 \begin_inset space ~
30878 The file format of the original file.
30879 This must be the name of a format that is known to \SpecialChar LyX
30881 \begin_inset CommandInset ref
30883 reference "sec:Formats"
30889 \begin_inset Quotes eld
30893 \begin_inset Flex Code
30896 \begin_layout Plain Layout
30903 \begin_inset Quotes erd
30906 if the template can handle original files of more than one format.
30908 will attempt to interrogate the file itself in order to deduce its format
30910 This command must occur exactly once.
30913 \begin_layout Description
30914 \begin_inset Flex Code
30917 \begin_layout Plain Layout
30919 \begin_inset space ~
30927 A unique name for the template.
30928 It must not contain substitution macros (see below).
30931 \begin_layout Description
30932 \begin_inset Flex Code
30935 \begin_layout Plain Layout
30937 \begin_inset space ~
30940 Rotate|Resize|Clip|Extra
30945 This command specifies which transformations are supported by this template.
30946 It may occur zero or more times.
30947 This command enables the corresponding tabs in the external dialog.
30949 \begin_inset Flex Code
30952 \begin_layout Plain Layout
30958 command must have either a corresponding
30959 \begin_inset Flex Code
30962 \begin_layout Plain Layout
30969 \begin_inset Flex Code
30972 \begin_layout Plain Layout
30979 \begin_inset Flex Code
30982 \begin_layout Plain Layout
30989 Otherwise the transformation will not be supported by that format.
30992 \begin_layout Subsection
30996 \begin_layout Description
30997 \begin_inset Flex Code
31000 \begin_layout Plain Layout
31002 \begin_inset space ~
31005 LaTeX|PDFLaTeX|PlainText|DocBook|XHTML
31010 The primary document file format that this format definition is for.
31011 Not every template has a sensible representation in all document file formats.
31012 Please define nevertheless a
31013 \begin_inset Flex Code
31016 \begin_layout Plain Layout
31022 section for all templates.
31023 Use a dummy text when no representation is available.
31024 Then you can at least see a reference to the external material in the exported
31028 \begin_layout Description
31029 \begin_inset Flex Code
31032 \begin_layout Plain Layout
31034 \begin_inset space ~
31038 \begin_inset space ~
31046 This command defines an additional macro
31047 \begin_inset Flex Code
31050 \begin_layout Plain Layout
31056 for substitution in
31057 \begin_inset Flex Code
31060 \begin_layout Plain Layout
31068 \begin_inset Flex Code
31071 \begin_layout Plain Layout
31077 itself may contain substitution macros.
31078 The advantage over using
31079 \begin_inset Flex Code
31082 \begin_layout Plain Layout
31089 \begin_inset Flex Code
31092 \begin_layout Plain Layout
31098 is that the substituted value of
31099 \begin_inset Flex Code
31102 \begin_layout Plain Layout
31108 is sanitized so that it is a valid optional argument in the document format.
31109 This command may occur zero or more times.
31112 \begin_layout Description
31113 \begin_inset Flex Code
31116 \begin_layout Plain Layout
31118 \begin_inset space ~
31126 The text that is inserted in the exported document.
31127 This is actually the most important command and can be quite complex.
31128 This command must occur exactly once.
31131 \begin_layout Description
31132 \begin_inset Flex Code
31135 \begin_layout Plain Layout
31137 \begin_inset space ~
31145 This command specifies a preamble snippet that will be included in the
31148 It has to be defined using
31149 \begin_inset Flex Code
31152 \begin_layout Plain Layout
31160 \begin_inset Flex Code
31163 \begin_layout Plain Layout
31170 This command may occur zero or more times.
31173 \begin_layout Description
31174 \begin_inset Flex Code
31177 \begin_layout Plain Layout
31179 \begin_inset space ~
31183 \begin_inset space ~
31191 This command denotes files that are created by the conversion process and
31192 are needed for a particular export format.
31193 If the filename is relative, it is interpreted relative to the master document.
31194 This command may be given zero or more times.
31197 \begin_layout Description
31198 \begin_inset Flex Code
31201 \begin_layout Plain Layout
31203 \begin_inset space ~
31211 The name of a required \SpecialChar LaTeX
31213 The package is included via
31214 \begin_inset Flex Code
31217 \begin_layout Plain Layout
31225 in the \SpecialChar LaTeX
31227 This command may occur zero or more times.
31230 \begin_layout Description
31231 \begin_inset Flex Code
31234 \begin_layout Plain Layout
31236 \begin_inset space ~
31240 \begin_inset space ~
31243 RotationLatexCommand
31248 This command specifies that the built in \SpecialChar LaTeX
31249 command should be used for rotation.
31250 This command may occur once or not at all.
31253 \begin_layout Description
31254 \begin_inset Flex Code
31257 \begin_layout Plain Layout
31259 \begin_inset space ~
31263 \begin_inset space ~
31271 This command specifies that the built in \SpecialChar LaTeX
31272 command should be used for resizing.
31273 This command may occur once or not at all.
31276 \begin_layout Description
31277 \begin_inset Flex Code
31280 \begin_layout Plain Layout
31282 \begin_inset space ~
31286 \begin_inset space ~
31289 RotationLatexOption
31294 This command specifies that rotation is done via an optional argument.
31295 This command may occur once or not at all.
31298 \begin_layout Description
31299 \begin_inset Flex Code
31302 \begin_layout Plain Layout
31304 \begin_inset space ~
31308 \begin_inset space ~
31316 This command specifies that resizing is done via an optional argument.
31317 This command may occur once or not at all.
31320 \begin_layout Description
31321 \begin_inset Flex Code
31324 \begin_layout Plain Layout
31326 \begin_inset space ~
31330 \begin_inset space ~
31338 This command specifies that clipping is done via an optional argument.
31339 This command may occur once or not at all.
31342 \begin_layout Description
31343 \begin_inset Flex Code
31346 \begin_layout Plain Layout
31348 \begin_inset space ~
31352 \begin_inset space ~
31360 This command specifies that an extra optional argument is used.
31361 This command may occur once or not at all.
31364 \begin_layout Description
31365 \begin_inset Flex Code
31368 \begin_layout Plain Layout
31370 \begin_inset space ~
31378 The file format of the converted file.
31379 This must be the name of a format that is known to \SpecialChar LyX
31381 \begin_inset Flex Noun
31384 \begin_layout Plain Layout
31385 Tools\SpecialChar menuseparator
31386 Preferences\SpecialChar menuseparator
31387 File Handling\SpecialChar menuseparator
31394 This command must occur exactly once.
31395 If the resulting file format is PDF, you need to specify the format
31396 \begin_inset Flex Code
31399 \begin_layout Plain Layout
31406 This is the PDF format used for including graphics.
31407 The other defined PDF formats are for document export.
31410 \begin_layout Description
31411 \begin_inset Flex Code
31414 \begin_layout Plain Layout
31416 \begin_inset space ~
31424 The file name of the converted file.
31425 The file name must be absolute.
31426 This command must occur exactly once.
31429 \begin_layout Subsection
31430 Preamble definitions
31433 \begin_layout Standard
31434 The external template configuration file may contain additional preamble
31435 definitions enclosed by
31436 \begin_inset Flex Code
31439 \begin_layout Plain Layout
31447 \begin_inset Flex Code
31450 \begin_layout Plain Layout
31457 They can be used by the templates in the
31458 \begin_inset Flex Code
31461 \begin_layout Plain Layout
31470 \begin_layout Section
31471 The substitution mechanism
31474 \begin_layout Standard
31475 When the external material facility invokes an external program, it is done
31476 on the basis of a command defined in the template configuration file.
31477 These commands can contain various macros that are expanded before execution.
31478 Execution always take place in the directory of the containing document.
31481 \begin_layout Standard
31482 Also, whenever external material is to be displayed, the name will be produced
31483 by the substitution mechanism, and most other commands in the template
31484 definition support substitution as well.
31487 \begin_layout Standard
31488 The available macros are the following:
31491 \begin_layout Description
31492 \begin_inset Flex Code
31495 \begin_layout Plain Layout
31496 $$AbsOrRelPathMaster
31501 The file path, absolute or relative to the master \SpecialChar LyX
31505 \begin_layout Description
31506 \begin_inset Flex Code
31509 \begin_layout Plain Layout
31510 $$AbsOrRelPathParent
31515 The file path, absolute or relative to the \SpecialChar LyX
31519 \begin_layout Description
31520 \begin_inset Flex Code
31523 \begin_layout Plain Layout
31529 The absolute file path.
31532 \begin_layout Description
31533 \begin_inset Flex Code
31536 \begin_layout Plain Layout
31542 The filename without path and without the extension.
31545 \begin_layout Description
31546 \begin_inset Flex Code
31549 \begin_layout Plain Layout
31551 \begin_inset Quotes eld
31555 \begin_inset Quotes erd
31563 This macro will expand to the contents of the file with the name
31564 \begin_inset Flex Code
31567 \begin_layout Plain Layout
31576 \begin_layout Description
31577 \begin_inset Flex Code
31580 \begin_layout Plain Layout
31586 The file extension (including the dot).
31589 \begin_layout Description
31590 \begin_inset Flex Code
31593 \begin_layout Plain Layout
31599 This will be the string
31600 \begin_inset Quotes eld
31604 \begin_inset Quotes erd
31607 if the file is in JPEG format, otherwise it will be the string
31608 \begin_inset Quotes eld
31612 \begin_inset Quotes erd
31616 This is useful to avoid uneeded conversions for output formats that support
31617 both PNG and JPEG fomats.
31618 The predefined RasterImage template uses this macro for the pdf\SpecialChar TeX
31623 \begin_layout Description
31624 \begin_inset Flex Code
31627 \begin_layout Plain Layout
31633 The filename of the file specified in the external material dialog.
31634 This is either an absolute name, or it is relative to the \SpecialChar LyX
31638 \begin_layout Description
31639 \begin_inset Flex Code
31642 \begin_layout Plain Layout
31649 \begin_inset Flex Code
31652 \begin_layout Plain Layout
31658 (absolute name or relative to the \SpecialChar LyX
31662 \begin_layout Description
31663 \begin_inset Flex Code
31666 \begin_layout Plain Layout
31672 The file path, relative to the master \SpecialChar LyX
31676 \begin_layout Description
31677 \begin_inset Flex Code
31680 \begin_layout Plain Layout
31686 The file path, relative to the \SpecialChar LyX
31690 \begin_layout Description
31691 \begin_inset Flex Code
31694 \begin_layout Plain Layout
31700 This macro will expand to the absolute path of the system directory.
31701 This is typically used to point to the various helper scripts that are
31702 bundled with \SpecialChar LyX
31706 \begin_layout Description
31707 \begin_inset Flex Code
31710 \begin_layout Plain Layout
31716 A name and full path to a temporary file which will be automatically deleted
31717 whenever the containing document is closed, or the external material insertion
31721 \begin_layout Standard
31722 All path macros contain a trailing directory separator, so you can construct
31724 \begin_inset space \thinspace{}
31728 \begin_inset space \space{}
31731 the absolute filename with
31732 \begin_inset Flex Code
31735 \begin_layout Plain Layout
31736 $$AbsPath$$Basename$$Extension
31744 \begin_layout Standard
31745 The macros above are substituted in all commands unless otherwise noted.
31747 \begin_inset Flex Code
31750 \begin_layout Plain Layout
31756 supports additionally the following substitutions if they are enabled by
31758 \begin_inset Flex Code
31761 \begin_layout Plain Layout
31768 \begin_inset Flex Code
31771 \begin_layout Plain Layout
31780 \begin_layout Description
31781 \begin_inset Flex Code
31784 \begin_layout Plain Layout
31790 The front part of the resize command.
31793 \begin_layout Description
31794 \begin_inset Flex Code
31797 \begin_layout Plain Layout
31803 The back part of the resize command.
31806 \begin_layout Description
31807 \begin_inset Flex Code
31810 \begin_layout Plain Layout
31816 The front part of the rotation command.
31819 \begin_layout Description
31820 \begin_inset Flex Code
31823 \begin_layout Plain Layout
31829 The back part of the rotation command.
31832 \begin_layout Standard
31833 The value string of the
31834 \begin_inset Flex Code
31837 \begin_layout Plain Layout
31843 command supports additionally the following substitutions if they are enabled
31845 \begin_inset Flex Code
31848 \begin_layout Plain Layout
31855 \begin_inset Flex Code
31858 \begin_layout Plain Layout
31867 \begin_layout Description
31868 \begin_inset Flex Code
31871 \begin_layout Plain Layout
31880 \begin_layout Description
31881 \begin_inset Flex Code
31884 \begin_layout Plain Layout
31893 \begin_layout Description
31894 \begin_inset Flex Code
31897 \begin_layout Plain Layout
31906 \begin_layout Description
31907 \begin_inset Flex Code
31910 \begin_layout Plain Layout
31916 The rotation option.
31919 \begin_layout Standard
31920 You may ask why there are so many path macros.
31921 There are mainly two reasons:
31924 \begin_layout Enumerate
31925 Relative and absolute file names should remain relative or absolute, respectivel
31927 Users may have reasons to prefer either form.
31928 Relative names are useful for portable documents that should work on different
31929 machines, for example.
31930 Absolute names may be required by some programs.
31933 \begin_layout Enumerate
31935 treats relative file names differently than \SpecialChar LyX
31936 and other programs in nested
31938 For \SpecialChar LyX
31939 , a relative file name is always relative to the document that contains
31941 For \SpecialChar LaTeX
31942 , it is always relative to the master document.
31943 These two definitions are identical if you have only one document, but
31944 differ if you have a master document that includes part documents.
31945 That means that relative filenames must be transformed when presented to
31948 Fortunately \SpecialChar LyX
31949 does this automatically for you if you choose the right macros.
31952 \begin_layout Standard
31953 So which path macro should be used in new template definitions? The rule
31957 \begin_layout Itemize
31959 \begin_inset Flex Code
31962 \begin_layout Plain Layout
31968 if an absolute path is required.
31971 \begin_layout Itemize
31973 \begin_inset Flex Code
31976 \begin_layout Plain Layout
31977 $$AbsOrRelPathMaster
31982 if the substituted string is some kind of \SpecialChar LaTeX
31986 \begin_layout Itemize
31988 \begin_inset Flex Code
31991 \begin_layout Plain Layout
31992 $$AbsOrRelPathParent
31997 in order to preserve the user's choice.
32000 \begin_layout Standard
32001 There are special cases where this rule does not work and e.
32002 \begin_inset space \thinspace{}
32006 \begin_inset space \space{}
32009 relative names are needed, but normally it will work just fine.
32010 One example for such a case is the command
32011 \begin_inset Flex Code
32014 \begin_layout Plain Layout
32015 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
32020 in the XFig template above: We can't use the absolute name because the
32022 \begin_inset Flex Code
32025 \begin_layout Plain Layout
32031 files needs the relative name in order to rewrite the file content.
32034 \begin_layout Section
32035 Security discussion
32036 \begin_inset CommandInset label
32038 name "sec:Security-discussion"
32045 \begin_layout Standard
32046 The external material feature interfaces with a lot of external programs
32047 and does so automatically, so we have to consider the security implications
32049 In particular, since you have the option of including your own filenames
32050 and/or parameter strings and those are expanded into a command, it seems
32051 that it would be possible to create a malicious document which executes
32052 arbitrary commands when a user views or prints the document.
32053 This is something we definitely want to avoid.
32056 \begin_layout Standard
32057 However, since the external program commands are specified in the template
32058 configuration file only, there are no security issues if \SpecialChar LyX
32059 is properly configure
32060 d with safe templates only.
32061 This is so because the external programs are invoked with the
32062 \begin_inset Flex Code
32065 \begin_layout Plain Layout
32071 -system call rather than the
32072 \begin_inset Flex Code
32075 \begin_layout Plain Layout
32081 system-call, so it's not possible to execute arbitrary commands from the
32082 filename or parameter section via the shell.
32085 \begin_layout Standard
32086 This also implies that you are restricted in what command strings you can
32087 use in the external material templates.
32088 In particular, pipes and redirection are not readily available.
32089 This has to be so if \SpecialChar LyX
32090 should remain safe.
32091 If you want to use some of the shell features, you should write a safe
32092 script to do this in a controlled manner, and then invoke the script from
32093 the command string.
32097 \begin_layout Standard
32098 It is possible to design a template that interacts directly with the shell,
32099 but since this would allow a malicious user to execute arbitrary commands
32100 by writing clever filenames and/or parameters, we generally recommend that
32101 you only use safe scripts that work with the
32102 \begin_inset Flex Code
32105 \begin_layout Plain Layout
32111 system call in a controlled manner.
32112 Of course, for use in a controlled environment, it can be tempting to just
32113 fall back to use ordinary shell scripts.
32114 If you do so, be aware that you
32118 provide an easily exploitable security hole in your system.
32119 Of course it stands to reason that such unsafe templates will never be
32120 included in the standard \SpecialChar LyX
32121 distribution, although we do encourage people
32122 to submit new templates in the open source tradition.
32123 But \SpecialChar LyX
32124 as shipped from the official distribution channels will never have
32128 \begin_layout Standard
32129 Including external material provides a lot of power, and you have to be
32130 careful not to introduce security hazards with this power.
32131 A subtle error in a single line in an innocent looking script can open
32132 the door to huge security problems.
32133 So if you do not fully understand the issues, we recommend that you consult
32134 a knowledgeable security professional or the \SpecialChar LyX
32135 development team if you have
32136 any questions about whether a given template is safe or not.
32137 And do this before you use it in an uncontrolled environment.
32140 \begin_layout Chapter
32142 List of supported \SpecialChar LyX
32143 functions to be used in layouts
32144 \begin_inset CommandInset label
32146 name "chap:List-of-functions"
32153 \begin_layout Standard
32155 \begin_inset Tabular
32156 <lyxtabular version="3" rows="11" columns="8">
32157 <features tabularvalignment="middle">
32158 <column alignment="left" valignment="top">
32159 <column alignment="left" valignment="top">
32160 <column alignment="left" valignment="top">
32161 <column alignment="left" valignment="top">
32162 <column alignment="left" valignment="top">
32163 <column alignment="left" valignment="top">
32164 <column alignment="left" valignment="top">
32165 <column alignment="left" valignment="top">
32167 <cell alignment="left" valignment="top" usebox="none">
32170 \begin_layout Plain Layout
32176 <cell alignment="left" valignment="top" usebox="none">
32179 \begin_layout Plain Layout
32185 <cell alignment="left" valignment="top" usebox="none">
32188 \begin_layout Plain Layout
32194 <cell alignment="left" valignment="top" usebox="none">
32197 \begin_layout Plain Layout
32203 <cell alignment="center" valignment="top" usebox="none">
32206 \begin_layout Plain Layout
32212 <cell alignment="center" valignment="top" usebox="none">
32215 \begin_layout Plain Layout
32221 <cell alignment="center" valignment="top" usebox="none">
32224 \begin_layout Plain Layout
32230 <cell alignment="center" valignment="top" usebox="none">
32233 \begin_layout Plain Layout
32241 <cell alignment="left" valignment="top" usebox="none">
32244 \begin_layout Plain Layout
32250 <cell alignment="left" valignment="top" usebox="none">
32253 \begin_layout Plain Layout
32259 <cell alignment="left" valignment="top" usebox="none">
32262 \begin_layout Plain Layout
32268 <cell alignment="left" valignment="top" usebox="none">
32271 \begin_layout Plain Layout
32277 <cell alignment="center" valignment="top" usebox="none">
32280 \begin_layout Plain Layout
32286 <cell alignment="center" valignment="top" usebox="none">
32289 \begin_layout Plain Layout
32295 <cell alignment="center" valignment="top" usebox="none">
32298 \begin_layout Plain Layout
32304 <cell alignment="center" valignment="top" usebox="none">
32307 \begin_layout Plain Layout
32315 <cell alignment="left" valignment="top" usebox="none">
32318 \begin_layout Plain Layout
32324 <cell alignment="left" valignment="top" usebox="none">
32327 \begin_layout Plain Layout
32333 <cell alignment="left" valignment="top" usebox="none">
32336 \begin_layout Plain Layout
32342 <cell alignment="left" valignment="top" usebox="none">
32345 \begin_layout Plain Layout
32351 <cell alignment="center" valignment="top" usebox="none">
32354 \begin_layout Plain Layout
32360 <cell alignment="center" valignment="top" usebox="none">
32363 \begin_layout Plain Layout
32369 <cell alignment="center" valignment="top" usebox="none">
32372 \begin_layout Plain Layout
32378 <cell alignment="center" valignment="top" usebox="none">
32381 \begin_layout Plain Layout
32389 <cell alignment="left" valignment="top" usebox="none">
32392 \begin_layout Plain Layout
32398 <cell alignment="left" valignment="top" usebox="none">
32401 \begin_layout Plain Layout
32407 <cell alignment="left" valignment="top" usebox="none">
32410 \begin_layout Plain Layout
32416 <cell alignment="left" valignment="top" usebox="none">
32419 \begin_layout Plain Layout
32425 <cell alignment="center" valignment="top" usebox="none">
32428 \begin_layout Plain Layout
32434 <cell alignment="center" valignment="top" usebox="none">
32437 \begin_layout Plain Layout
32443 <cell alignment="center" valignment="top" usebox="none">
32446 \begin_layout Plain Layout
32452 <cell alignment="center" valignment="top" usebox="none">
32455 \begin_layout Plain Layout
32463 <cell alignment="left" valignment="top" usebox="none">
32466 \begin_layout Plain Layout
32472 <cell alignment="left" valignment="top" usebox="none">
32475 \begin_layout Plain Layout
32481 <cell alignment="left" valignment="top" usebox="none">
32484 \begin_layout Plain Layout
32490 <cell alignment="left" valignment="top" usebox="none">
32493 \begin_layout Plain Layout
32499 <cell alignment="center" valignment="top" usebox="none">
32502 \begin_layout Plain Layout
32508 <cell alignment="center" valignment="top" usebox="none">
32511 \begin_layout Plain Layout
32517 <cell alignment="center" valignment="top" usebox="none">
32520 \begin_layout Plain Layout
32526 <cell alignment="center" valignment="top" usebox="none">
32529 \begin_layout Plain Layout
32537 <cell alignment="left" valignment="top" usebox="none">
32540 \begin_layout Plain Layout
32546 <cell alignment="left" valignment="top" usebox="none">
32549 \begin_layout Plain Layout
32555 <cell alignment="left" valignment="top" usebox="none">
32558 \begin_layout Plain Layout
32564 <cell alignment="left" valignment="top" usebox="none">
32567 \begin_layout Plain Layout
32573 <cell alignment="center" valignment="top" usebox="none">
32576 \begin_layout Plain Layout
32582 <cell alignment="center" valignment="top" usebox="none">
32585 \begin_layout Plain Layout
32591 <cell alignment="center" valignment="top" usebox="none">
32594 \begin_layout Plain Layout
32600 <cell alignment="center" valignment="top" usebox="none">
32603 \begin_layout Plain Layout
32611 <cell alignment="left" valignment="top" usebox="none">
32614 \begin_layout Plain Layout
32620 <cell alignment="left" valignment="top" usebox="none">
32623 \begin_layout Plain Layout
32629 <cell alignment="left" valignment="top" usebox="none">
32632 \begin_layout Plain Layout
32638 <cell alignment="left" valignment="top" usebox="none">
32641 \begin_layout Plain Layout
32647 <cell alignment="center" valignment="top" usebox="none">
32650 \begin_layout Plain Layout
32656 <cell alignment="center" valignment="top" usebox="none">
32659 \begin_layout Plain Layout
32665 <cell alignment="center" valignment="top" usebox="none">
32668 \begin_layout Plain Layout
32674 <cell alignment="center" valignment="top" usebox="none">
32677 \begin_layout Plain Layout
32685 <cell alignment="left" valignment="top" usebox="none">
32688 \begin_layout Plain Layout
32694 <cell alignment="left" valignment="top" usebox="none">
32697 \begin_layout Plain Layout
32703 <cell alignment="left" valignment="top" usebox="none">
32706 \begin_layout Plain Layout
32712 <cell alignment="left" valignment="top" usebox="none">
32715 \begin_layout Plain Layout
32721 <cell alignment="center" valignment="top" usebox="none">
32724 \begin_layout Plain Layout
32730 <cell alignment="center" valignment="top" usebox="none">
32733 \begin_layout Plain Layout
32739 <cell alignment="center" valignment="top" usebox="none">
32742 \begin_layout Plain Layout
32748 <cell alignment="center" valignment="top" usebox="none">
32751 \begin_layout Plain Layout
32759 <cell alignment="left" valignment="top" usebox="none">
32762 \begin_layout Plain Layout
32768 <cell alignment="left" valignment="top" usebox="none">
32771 \begin_layout Plain Layout
32777 <cell alignment="left" valignment="top" usebox="none">
32780 \begin_layout Plain Layout
32786 <cell alignment="left" valignment="top" usebox="none">
32789 \begin_layout Plain Layout
32795 <cell alignment="center" valignment="top" usebox="none">
32798 \begin_layout Plain Layout
32804 <cell alignment="center" valignment="top" usebox="none">
32807 \begin_layout Plain Layout
32813 <cell alignment="center" valignment="top" usebox="none">
32816 \begin_layout Plain Layout
32822 <cell alignment="center" valignment="top" usebox="none">
32825 \begin_layout Plain Layout
32833 <cell alignment="left" valignment="top" usebox="none">
32836 \begin_layout Plain Layout
32842 <cell alignment="left" valignment="top" usebox="none">
32845 \begin_layout Plain Layout
32851 <cell alignment="left" valignment="top" usebox="none">
32854 \begin_layout Plain Layout
32860 <cell alignment="left" valignment="top" usebox="none">
32863 \begin_layout Plain Layout
32869 <cell alignment="center" valignment="top" usebox="none">
32872 \begin_layout Plain Layout
32878 <cell alignment="center" valignment="top" usebox="none">
32881 \begin_layout Plain Layout
32887 <cell alignment="center" valignment="top" usebox="none">
32890 \begin_layout Plain Layout
32896 <cell alignment="center" valignment="top" usebox="none">
32899 \begin_layout Plain Layout
32907 <cell alignment="center" valignment="top" usebox="none">
32910 \begin_layout Plain Layout
32916 <cell alignment="center" valignment="top" usebox="none">
32919 \begin_layout Plain Layout
32925 <cell alignment="center" valignment="top" usebox="none">
32928 \begin_layout Plain Layout
32934 <cell alignment="center" valignment="top" usebox="none">
32937 \begin_layout Plain Layout
32943 <cell alignment="center" valignment="top" usebox="none">
32946 \begin_layout Plain Layout
32952 <cell alignment="center" valignment="top" usebox="none">
32955 \begin_layout Plain Layout
32961 <cell alignment="center" valignment="top" usebox="none">
32964 \begin_layout Plain Layout
32970 <cell alignment="center" valignment="top" usebox="none">
32973 \begin_layout Plain Layout
32987 \begin_layout Chapter
32988 Names of available colors to be used in layouts
32989 \begin_inset CommandInset label
32991 name "chap:Names-of-colors"
32998 \begin_layout Standard
32999 The colors listed below are the standard colors and those that you can adjust
33000 in the \SpecialChar LyX
33004 \begin_layout Section
33008 \begin_layout Standard
33009 The following are no real colors, but rather act on color definitions:
33012 \begin_layout Description
33013 ignore The color is ignored
33016 \begin_layout Description
33017 inherit The color is inherited
33020 \begin_layout Description
33033 No particular color – clear or default
33036 \begin_layout Section
33040 \begin_layout Standard
33041 These are fixed colors that cannot be customized
33042 \change_inserted -712698321 1607683177
33048 use these colors in layout definitions, since they will not work well with
33049 some color themes (such as dark themes)
33054 \begin_layout Description
33058 \begin_layout Description
33062 \begin_layout Description
33066 \begin_layout Description
33070 \begin_layout Description
33074 \begin_layout Description
33078 \begin_layout Description
33082 \begin_layout Description
33086 \begin_layout Description
33090 \begin_layout Description
33094 \begin_layout Description
33098 \begin_layout Description
33102 \begin_layout Description
33106 \begin_layout Description
33110 \begin_layout Description
33114 \begin_layout Description
33118 \begin_layout Description
33122 \begin_layout Description
33126 \begin_layout Description
33130 \begin_layout Section
33134 \begin_layout Standard
33135 These are the colors allocated to specific elements in
33138 arg "dialog-show prefs"
33144 \begin_layout Description
33145 added_space Added space color
33148 \begin_layout Description
33149 addedtext Added text color
33152 \begin_layout Description
33153 appendix Appendix marker color
33156 \begin_layout Description
33157 background Background color
33160 \begin_layout Description
33161 bottomarea Bottom area color
33164 \begin_layout Description
33165 branchlabel Label color for branches
33168 \begin_layout Description
33169 buttonbg Color used for button background
33172 \begin_layout Description
33173 buttonframe Color for inset button frames
33176 \begin_layout Description
33177 buttonhoverbg Color used for button background under focus
33180 \begin_layout Description
33181 changebar Changebar color
33184 \begin_layout Description
33185 changedtextauthor1 Changed text color author 1
33188 \begin_layout Description
33189 changedtextauthor2 Changed text color author 2
33192 \begin_layout Description
33193 changedtextauthor3 Changed text color author 3
33196 \begin_layout Description
33197 changedtextauthor4 Changed text color author 4
33200 \begin_layout Description
33201 changedtextauthor5 Changed text color author 5
33204 \begin_layout Description
33205 collapsible Collapsible insets text color
33208 \begin_layout Description
33209 collapsibleframe Collapsible insets framecolor
33212 \begin_layout Description
33213 command Text color for command insets
33216 \begin_layout Description
33217 commandbg Background color for command insets
33220 \begin_layout Description
33221 commandframe Frame color for command insets
33224 \begin_layout Description
33225 comment Label color for comments
33228 \begin_layout Description
33229 commentbg Background color of comments
33232 \begin_layout Description
33233 cursor Cursor color
33236 \begin_layout Description
33237 deletedtext Deleted text color
33240 \begin_layout Description
33241 deletedtextmodifier Deleted text modifying color
33244 \begin_layout Description
33245 depthbar Color for the depth bars in the margin
33248 \begin_layout Description
33249 eolmarker End of line marker color
33252 \begin_layout Description
33253 error Color of the \SpecialChar LaTeX
33257 \begin_layout Description
33258 footlabel Label color for footnotes
33261 \begin_layout Description
33262 foreground Foreground color
33265 \begin_layout Description
33266 graphicsbg Graphics inset background color
33269 \begin_layout Description
33270 greyedoutbg Background color of greyedout inset
33273 \begin_layout Description
33274 greyedoutlabel Label color for greyedout insets
33277 \begin_layout Description
33278 greyedouttext Color for greyedout inset text
33281 \begin_layout Description
33282 indexlabel Label color for index insets
33285 \begin_layout Description
33286 inlinecompletion Inline completion color
33289 \begin_layout Description
33290 insetbg Inset marker background color
33293 \begin_layout Description
33294 insetframe Inset marker frame color
33297 \begin_layout Description
33298 language Color for marking foreign language words
33301 \begin_layout Description
33302 latex Text color in \SpecialChar LaTeX
33306 \begin_layout Description
33307 listingsbg Background color of listings inset
33310 \begin_layout Description
33311 marginlabel Label color for margin notes
33314 \begin_layout Description
33315 math Math inset text color
33318 \begin_layout Description
33319 mathbg Math inset background color
33322 \begin_layout Description
33323 mathcorners Math inset frame color not under focus
33326 \begin_layout Description
33327 mathframe Math inset frame color under focus
33330 \begin_layout Description
33331 mathline Math line color
33334 \begin_layout Description
33335 mathmacrobg Macro math inset background color
33338 \begin_layout Description
33339 mathmacroblend Macro math blended color
33342 \begin_layout Description
33343 mathmacroframe Macro math frame color
33346 \begin_layout Description
33347 mathmacrohoverbg Macro math inset background color hovered
33350 \begin_layout Description
33351 mathmacrolabel Macro math label color
33354 \begin_layout Description
33355 mathmacronewarg Macro template color for new parameters
33358 \begin_layout Description
33359 mathmacrooldarg Macro template color for old parameters
33362 \begin_layout Description
33363 newpage New page color
33366 \begin_layout Description
33367 nonunique_inlinecompletion Inline completion color for the non-unique part
33370 \begin_layout Description
33371 note Label color for notes
33374 \begin_layout Description
33375 notebg Background color of notes
33378 \begin_layout Description
33379 pagebreak Page break/line break color
33382 \begin_layout Description
33383 paragraphmarker Color used for the pilcrow sign to mark the end of a paragraph
33386 \begin_layout Description
33387 phantomtext Text color for phantom insets
33390 \begin_layout Description
33391 preview The color used for previews
33394 \begin_layout Description
33395 previewframe Preview frame color
33398 \begin_layout Description
33399 regexpframe Color for regexp frame
33402 \begin_layout Description
33403 scroll Color that indicates when a row can be scrolled
33406 \begin_layout Description
33407 selection Background color of selected text
33410 \begin_layout Description
33411 selectiontext Foreground color of selected text
33414 \begin_layout Description
33415 shadedbg Background color of shaded box
33418 \begin_layout Description
33419 special Special chars text color
33422 \begin_layout Description
33423 tabularline Table line color
33426 \begin_layout Description
33427 tabularonoffline Table line color
33428 \change_inserted -712698321 1607682522
33432 \begin_layout Description
33434 \change_inserted -712698321 1607682563
33435 textlabel1 Color 1 of layout and custom inset labels
33438 \begin_layout Description
33440 \change_inserted -712698321 1607682565
33441 textlabel2 Color 2 of layout and custom inset labels
33444 \begin_layout Description
33446 \change_inserted -712698321 1607682568
33447 textlabel3 Color 3 of layout and custom inset labels
33452 \begin_layout Description
33453 urllabel Label color for URL insets
33456 \begin_layout Description
33457 urltext Color for URL inset text