1 #LyX 2.4 created this file. For more info see https://www.lyx.org/
5 \save_transient_properties true
6 \origin /systemlyxdir/doc/
9 % DO NOT ALTER THIS PREAMBLE!!!
11 % This preamble is designed to ensure that this document prints
12 % out as advertised. If you mess with this preamble,
13 % parts of this document may not print out as expected. If you
14 % have problems LaTeXing this file, please contact
15 % the documentation team
16 % email: lyx-docs@lists.lyx.org
18 % the pages of the TOC is numbered roman
19 % and a pdf-bookmark for the TOC is added
20 \let\myTOC\tableofcontents
21 \renewcommand\tableofcontents{%
23 \pdfbookmark[1]{\contentsname}{}
27 % increase link area for cross-references and autoname them,
28 \AtBeginDocument{\renewcommand{\ref}[1]{\mbox{\autoref{#1}}}}
29 \@ifundefined{extrasenglish}{\usepackage[english]{babel}}{}
30 \@ifpackageloaded{babel}{
31 \addto\extrasenglish{%
32 \renewcommand*{\equationautorefname}[1]{}%
33 \renewcommand{\sectionautorefname}{sec.\negthinspace}%
34 \renewcommand{\subsectionautorefname}{sec.\negthinspace}%
35 \renewcommand{\subsubsectionautorefname}{sec.\negthinspace}%
39 \options bibliography=totoc,index=totoc,BCOR7.5mm,titlepage,captions=tableheading
40 \use_default_options false
44 \maintain_unincluded_children no
46 \language_package default
49 \font_roman "lmodern" "default"
50 \font_sans "lmss" "default"
51 \font_typewriter "lmtt" "default"
52 \font_math "auto" "auto"
53 \font_default_family default
54 \use_non_tex_fonts false
58 \font_typewriter_osf false
59 \font_sf_scale 100 100
60 \font_tt_scale 100 100
62 \use_dash_ligatures true
64 \default_output_format pdf2
66 \bibtex_command default
67 \index_command default
71 \pdf_title "LyX Configuration Manual"
72 \pdf_author "LyX Team"
73 \pdf_subject "LyX-documentation Customization"
74 \pdf_keywords "LyX, documentation, customization"
76 \pdf_bookmarksnumbered true
77 \pdf_bookmarksopen true
78 \pdf_bookmarksopenlevel 1
83 \pdf_pdfusetitle false
84 \pdf_quoted_options "linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue,pdfpagelayout=OneColumn, pdfnewwindow=true, pdfstartview=XYZ, plainpages=false"
87 \use_package amsmath 1
88 \use_package amssymb 1
91 \use_package mathdots 1
92 \use_package mathtools 1
94 \use_package stackrel 1
95 \use_package stmaryrd 1
96 \use_package undertilde 1
98 \cite_engine_type default
102 \paperorientation portrait
108 \notefontcolor #0000ff
120 \paragraph_separation indent
121 \paragraph_indentation default
123 \math_indentation default
124 \math_numbering_side default
125 \quotes_style english
129 \paperpagestyle headings
131 \tracking_changes true
132 \output_changes false
134 \postpone_fragile_content false
138 \docbook_table_output 0
139 \author -970929547 "Thibaut Cuvelier"
140 \author -712698321 "Jürgen Spitzmüller"
141 \author -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
6180 Installing New Document Classes, Layouts, and Templates
6181 \begin_inset CommandInset label
6183 name "cha:Installing-New-Document"
6188 \begin_inset Argument 1
6191 \begin_layout Plain Layout
6192 Installing New Document Classes
6200 \begin_layout Standard
6201 In this chapter, we describe the procedures for creating and installing
6202 new \SpecialChar LyX
6203 layout and template files, as well as offer a refresher on correctly
6204 installing new \SpecialChar LaTeX
6209 \begin_layout Standard
6210 First, let us a say a few words about how one ought to think about the relation
6211 between \SpecialChar LyX
6212 and \SpecialChar LaTeX
6214 The thing to understand is that, in a certain sense, \SpecialChar LyX
6215 doesn't know anything
6216 about \SpecialChar LaTeX
6218 Indeed, from \SpecialChar LyX
6219 's point of view, \SpecialChar LaTeX
6220 is just one of several
6221 \begin_inset Quotes eld
6225 \begin_inset Quotes erd
6228 in which it is capable of producing output.
6229 Other such formats are DocBook, plaintext, and XHTML.
6231 is, of course, a particularly important format, but very little of the
6232 information \SpecialChar LyX
6233 has about \SpecialChar LaTeX
6234 is actually contained in the program itself.
6238 \begin_layout Plain Layout
6239 Some commands are sufficiently complex that they are
6240 \begin_inset Quotes eld
6244 \begin_inset Quotes erd
6247 into \SpecialChar LyX
6249 But the developers generally regard this as a Bad Thing.
6254 Rather, that information, even for the standard classes like
6255 \begin_inset Flex Code
6258 \begin_layout Plain Layout
6264 , is contained in `layout files'.
6265 Similarly, \SpecialChar LyX
6266 itself does not know much about DocBook or XHTML.
6267 What it knows is contained in layout files.
6270 \begin_layout Standard
6271 You can think of the layout file for a given document class as a translation
6272 manual between \SpecialChar LyX
6273 constructs—paragraphs with their corresponding styles,
6274 certain sorts of insets, etc—and the corresponding \SpecialChar LaTeX
6277 Almost everything \SpecialChar LyX
6279 \begin_inset Flex Code
6282 \begin_layout Plain Layout
6288 , for example, is contained in the file
6289 \begin_inset Flex Code
6292 \begin_layout Plain Layout
6298 and in various other files it includes.
6299 For this reason, anyone intending to write layout files should plan to
6300 study the existing files.
6301 A good place to start is with
6302 \begin_inset Flex Code
6305 \begin_layout Plain Layout
6311 , which is included in
6312 \begin_inset Flex Code
6315 \begin_layout Plain Layout
6322 \begin_inset Flex Code
6325 \begin_layout Plain Layout
6331 , and many of the other layout files for document classes.
6332 This file is where sections and the like are defined:
6333 \begin_inset Flex Code
6336 \begin_layout Plain Layout
6342 tells \SpecialChar LyX
6343 how paragraphs that are marked with the Section, Subsection, etc,
6344 styles can be translated into corresponding \SpecialChar LaTeX
6345 , DocBook, and XHTML commands
6348 \begin_inset Flex Code
6351 \begin_layout Plain Layout
6357 file basically just includes several of these
6358 \begin_inset Flex Code
6361 \begin_layout Plain Layout
6370 \begin_layout Standard
6371 Defining the \SpecialChar LyX
6373 correspondence is not the only thing layout files do, though.
6374 Their other job is to define how the \SpecialChar LyX
6375 constructs themselves will appear
6377 The fact that layout files have these two jobs is often a source of confusion,
6378 because they are completely separate.
6379 Telling \SpecialChar LyX
6380 how to translate a certain paragraph style into \SpecialChar LaTeX
6383 how to display it; conversely, telling \SpecialChar LyX
6384 how to display a certain paragraph
6385 style does not tell \SpecialChar LyX
6386 how to translate it into \SpecialChar LaTeX
6387 (let alone tell \SpecialChar LaTeX
6390 So, in general, when you define a new \SpecialChar LyX
6391 construct, you must always do two
6392 quite separate things: (i)
6393 \begin_inset space ~
6396 tell \SpecialChar LyX
6397 how to translate it into \SpecialChar LaTeX
6399 \begin_inset space ~
6402 tell \SpecialChar LyX
6406 \begin_layout Standard
6407 Much the same is true, of course, as regards \SpecialChar LyX
6408 's other backend formats, though
6409 XHTML is in some ways different, because in that case \SpecialChar LyX
6414 able, to some extent, to use information about how it should display a
6415 paragraph on the screen to output information (in the form of CSS) about
6416 how the paragraph should be displayed in a browser.
6417 Even in this case, however, the distinction between what \SpecialChar LyX
6419 and how things are rendered externally remains in force, and the two can
6420 be controlled separately.
6422 \begin_inset CommandInset ref
6424 reference "sec:Tags-for-XHTML"
6431 \begin_layout Section
6432 Installing new \SpecialChar LaTeX
6436 \begin_layout Standard
6437 Some installations may not include a \SpecialChar LaTeX
6438 package or class file that you would
6439 like to use within \SpecialChar LyX
6441 For example, you might need Foil\SpecialChar TeX
6442 , a package for preparing slides for overhead
6444 Modern \SpecialChar LaTeX
6445 distributions like \SpecialChar TeX
6446 Live (2008 or newer) or MiK\SpecialChar TeX
6447 provide a user interface
6448 for installing such packages.
6449 For example, with MiK\SpecialChar TeX
6450 , you start the program
6451 \begin_inset Quotes eld
6455 \begin_inset space ~
6459 \begin_inset Quotes erd
6462 to get a list of available packages.
6463 To install one of them, right click on it or use the corresponding toolbar
6467 \begin_layout Standard
6468 If your \SpecialChar LaTeX
6469 distribution does not provide such a `package manager', or if the
6470 package is not available from your distribution, then follow these steps
6471 to install it manually:
6474 \begin_layout Enumerate
6475 Get the package from
6476 \begin_inset CommandInset href
6479 target "http://www.ctan.org/"
6487 \begin_layout Enumerate
6488 If the package contains a file with the ending
6489 \begin_inset Quotes eld
6493 \begin_inset Flex Code
6496 \begin_layout Plain Layout
6503 \begin_inset Quotes erd
6506 (is the case for Foil\SpecialChar TeX
6507 ) then open a console, change to the folder of this
6508 file and execute the command
6509 \begin_inset Flex Code
6512 \begin_layout Plain Layout
6519 You have now unpacked the package and have all files to install it.
6520 Most \SpecialChar LaTeX
6521 -packages are not packed and you can skip this step.
6524 \begin_layout Enumerate
6525 Now you need to decide if the package should be available for all users
6530 \begin_layout Enumerate
6531 On *nix systems (Linux, OSX, etc.), if you want the new package to be available
6532 for all users on your system, then install it in your `local' \SpecialChar TeX
6534 install it in your own `user' \SpecialChar TeX
6536 Where these trees should be created, if they do not already exist, depends
6538 To find this out, look in the file
6539 \begin_inset Flex Code
6542 \begin_layout Plain Layout
6552 \begin_layout Plain Layout
6553 This is usually in the directory
6554 \begin_inset Flex Code
6557 \begin_layout Plain Layout
6563 , though you can execute the command
6564 \begin_inset Flex Code
6567 \begin_layout Plain Layout
6578 The location of the `local' \SpecialChar TeX
6579 tree is defined by the
6580 \begin_inset Flex Code
6583 \begin_layout Plain Layout
6589 variable; this is usually somewhere like
6590 \begin_inset Flex Code
6593 \begin_layout Plain Layout
6594 /usr/local/share/texmf
6599 or /usr/local/texlive/XXXX where XXXX is the year of the installed \SpecialChar TeX
6602 The location of the `user' \SpecialChar TeX
6604 \begin_inset Flex Code
6607 \begin_layout Plain Layout
6614 \begin_inset Flex Code
6617 \begin_layout Plain Layout
6624 \begin_inset Flex Code
6627 \begin_layout Plain Layout
6636 (If these variables are not predefined, you have to define them.) You'll
6637 probably need root permissions to create or modify the `local' tree, but
6638 not for your `user' tree.
6639 \begin_inset Newline newline
6642 In general, it is recommended to install in the user tree because your user
6643 will not be modified or even overwritten when you upgrade your system.
6644 It will typically also be backed up together with everything else when
6645 you backup your home directory (which, of course, you do on a regular basis).
6648 \begin_layout Enumerate
6649 On Windows, if you want the new package to be available for all users on
6650 your system, change to the folder where \SpecialChar LaTeX
6651 is installed and then change to
6653 \begin_inset Flex Code
6656 \begin_layout Plain Layout
6667 (For MiK\SpecialChar TeX
6668 , this would be by default the folder
6669 \begin_inset Flex Code
6672 \begin_layout Plain Layout
6690 \begin_layout Plain Layout
6691 Note that this will be the correct path only on English installations.
6692 On a German one, it would be
6693 \begin_inset Flex Code
6696 \begin_layout Plain Layout
6710 , and similarly for other languages.
6715 Create there a new folder
6716 \begin_inset Flex Code
6719 \begin_layout Plain Layout
6725 and copy all files of the package into it.
6727 \begin_inset Newline newline
6730 If the package should only available for you or you don't have admin permissions
6731 , do the same, but in the local \SpecialChar LaTeX
6734 \begin_inset space \thinspace{}
6737 g., for MiK\SpecialChar TeX
6739 \begin_inset space ~
6742 2.8 under Windows XP, this would be the folder:
6743 \begin_inset Newline newline
6749 \begin_inset Flex Code
6752 \begin_layout Plain Layout
6755 Documents and Settings
6767 \begin_inset Newline newline
6773 \begin_inset Phantom HPhantom
6776 \begin_layout Plain Layout
6787 \begin_inset Flex Code
6790 \begin_layout Plain Layout
6803 \begin_inset Newline newline
6806 On Vista, it would be:
6807 \begin_inset Newline newline
6811 \begin_inset Flex Code
6814 \begin_layout Plain Layout
6840 \begin_layout Enumerate
6841 Now one only need to tell \SpecialChar LaTeX
6842 that there are new files.
6843 This depends on the used \SpecialChar LaTeX
6848 \begin_layout Enumerate
6849 For \SpecialChar TeX
6850 Live execute the command
6851 \begin_inset Flex Code
6854 \begin_layout Plain Layout
6861 If you installed the package for all users, then you will probably need
6862 to have root permissions for that.
6865 \begin_layout Enumerate
6866 For MiK\SpecialChar TeX
6867 , if you have installed the package for all users, start the program
6869 \begin_inset Quotes eld
6873 \begin_inset space ~
6877 \begin_inset Quotes erd
6880 and press the button marked
6881 \begin_inset Quotes eld
6885 \begin_inset Quotes erd
6889 Otherwise start the program
6890 \begin_inset Quotes eld
6894 \begin_inset Quotes erd
6901 \begin_layout Enumerate
6902 Finally, you need to tell \SpecialChar LyX
6903 that there are new packages available.
6904 So, in \SpecialChar LyX
6906 \begin_inset Flex Noun
6909 \begin_layout Plain Layout
6912 \SpecialChar menuseparator
6918 and then restart \SpecialChar LyX
6922 \begin_layout Standard
6923 Now the package is installed.
6924 In our example, the document class
6925 \begin_inset Flex Code
6928 \begin_layout Plain Layout
6934 will now be available under
6935 \begin_inset Flex Noun
6938 \begin_layout Plain Layout
6939 Document\SpecialChar menuseparator
6940 Settings\SpecialChar menuseparator
6947 \begin_inset Quotes eld
6951 \begin_inset Quotes erd
6958 \begin_layout Standard
6959 If you would like to use a \SpecialChar LaTeX
6960 document class that is not even listed in the
6962 \begin_inset Flex Noun
6965 \begin_layout Plain Layout
6966 Document\SpecialChar menuseparator
6967 Settings\SpecialChar menuseparator
6973 , then you need to create a `layout' file for it.
6974 That is the topic of the next section.
6977 \begin_layout Section
6978 Types of layout files
6981 \begin_layout Standard
6982 This section describes the various sorts of \SpecialChar LyX
6983 files that contain layout informati
6985 These files describe various paragraph and character styles, determining
6986 how \SpecialChar LyX
6987 should display them and how they should be translated into \SpecialChar LaTeX
6989 XHTML, or whatever output format is being used.
6993 \begin_layout Standard
6994 We shall try to provide a thorough description of the process of writing
6996 However, there are so many different types of documents supported even
6997 by just \SpecialChar LaTeX
6998 that we can't hope to cover every different possibility or problem
6999 you might encounter.
7000 The \SpecialChar LyX
7001 users' list is frequented by people with lots of experience with layout
7002 design who are willing to share what they've learned, so please feel free
7003 to ask questions there.
7006 \begin_layout Standard
7007 As you prepare to write a new layout, it is extremely helpful to look at
7008 the layouts distributed with \SpecialChar LyX
7010 If you write a \SpecialChar LyX
7011 layout for a \SpecialChar LaTeX
7012 document class that might also be used by
7013 others, or write a module that might be useful to others, then you should
7014 consider posting your layout to the
7015 \begin_inset CommandInset href
7017 name "layout section on the LyX wiki"
7018 target "https://wiki.lyx.org/Layouts/Layouts"
7023 or even to the \SpecialChar LyX
7024 developers' list, so that it might be included in \SpecialChar LyX
7029 \begin_layout Plain Layout
7030 Note that \SpecialChar LyX
7031 is licensed under the General Public License, so any material
7032 that is contributed to \SpecialChar LyX
7033 must be similarly licensed.
7041 \begin_layout Subsection
7043 \begin_inset CommandInset label
7045 name "subsec:Layout-modules"
7052 \begin_layout Standard
7053 We have spoken to this point about `layout files'.
7054 But there are different sorts of files that contain layout information.
7055 Layout files, strictly so called, have the
7056 \begin_inset Flex Code
7059 \begin_layout Plain Layout
7065 extension and provide \SpecialChar LyX
7066 with information about document classes.
7067 Since \SpecialChar LyX
7068 1.6 layout information can also be contained in layout
7073 \begin_inset Flex Code
7076 \begin_layout Plain Layout
7083 Modules are to \SpecialChar LaTeX
7084 packages much as layouts are to \SpecialChar LaTeX
7085 classes, and some modules—such
7087 \begin_inset Flex Code
7090 \begin_layout Plain Layout
7096 module—specifically provide support for one package.
7097 In a sense, layout modules are similar to included
7101 \begin_layout Plain Layout
7102 These can have any extension, but by convention have the
7103 \begin_inset Flex Code
7106 \begin_layout Plain Layout
7118 \begin_inset Flex Code
7121 \begin_layout Plain Layout
7127 —in that modules are not specific to a given document class but may be used
7128 with many different classes.
7129 The difference is that using an included file with
7130 \begin_inset Flex Code
7133 \begin_layout Plain Layout
7139 requires editing that file.
7140 Modules, by contrast, are selected in the
7141 \begin_inset Flex Noun
7144 \begin_layout Plain Layout
7145 Document\SpecialChar menuseparator
7154 \begin_layout Standard
7155 Building modules is the easiest way to get started with layout editing,
7156 since it can be as simple as adding a single new paragraph style or flex
7158 But modules may, in principle, contain anything a layout file can contain.
7161 \begin_layout Standard
7162 After creating a new module and copying it to the
7163 \begin_inset Flex Code
7166 \begin_layout Plain Layout
7172 folder, you will need to reconfigure and then restart \SpecialChar LyX
7175 However, changes you make to the module will be seen immediately, if you
7177 \begin_inset Flex Noun
7180 \begin_layout Plain Layout
7181 Document\SpecialChar menuseparator
7187 , highlight something, and then hit
7188 \begin_inset Quotes eld
7192 \begin_inset Quotes erd
7198 It is strongly recommended that you save your work before doing this
7203 it is strongly recommended that you not attempt to edit modules while simultaneo
7204 usly working on actual documents
7207 Though of course the developers strive to keep \SpecialChar LyX
7208 stable in such situations,
7209 syntax errors and the like in your module file could cause strange behavior.
7212 \begin_layout Subsubsection
7216 \begin_layout Standard
7217 Modules are to \SpecialChar LyX
7218 as packages are to \SpecialChar LaTeX
7220 Sometimes, however, you find yourself wanting a specific inset or character
7221 style just for one document and writing a module that will also be available
7222 to other documents makes little sense.
7223 What you need is \SpecialChar LyX
7225 \begin_inset Quotes eld
7229 \begin_inset Quotes erd
7235 \begin_layout Standard
7236 You will find it under
7238 Document\SpecialChar menuseparator
7239 Settings\SpecialChar menuseparator
7243 The large text box allows you to enter anything that you might enter in
7244 a layout file or module.
7245 You can think of a document's local layout, in fact, as a module that belongs
7247 So, in particular, you must enter a
7248 \begin_inset Flex Code
7251 \begin_layout Plain Layout
7258 Any format is acceptable, but one would normally use the format current
7260 (In \SpecialChar LyX
7267 , the current layout format is
7276 \begin_layout Standard
7277 When you have entered something in the
7278 \begin_inset Flex Code
7281 \begin_layout Plain Layout
7287 pane, \SpecialChar LyX
7289 \begin_inset Quotes eld
7293 \begin_inset Quotes erd
7296 button at the bottom.
7297 Clicking this button will cause \SpecialChar LyX
7298 to determine whether what you have entered
7299 is valid layout information for the chosen format.
7301 will report the result but, unfortunately, will not tell you what errors
7302 there might have been.
7303 These will be written to the terminal, however, if \SpecialChar LyX
7304 is started from a terminal.
7305 You will not be permitted to save your local layout until you have entered
7309 \begin_layout Standard
7310 The warnings at the end of the previous section apply here, too.
7311 Do not play with local layout while you are actually working, especially
7312 if you have not saved your document.
7313 That said, using local layout with a test document can be a very convenient
7314 way to try out layout ideas, or even to start developing a module.
7317 \begin_layout Subsection
7319 \begin_inset Flex Noun
7322 \begin_layout Plain Layout
7331 \begin_layout Standard
7332 There are two situations you are likely to encounter when wanting to support
7333 a new \SpecialChar LaTeX
7334 document class, involving style (
7335 \begin_inset Flex Code
7338 \begin_layout Plain Layout
7344 ) files and \SpecialChar LaTeX2e
7346 \begin_inset Flex Code
7349 \begin_layout Plain Layout
7356 Supporting a style file is usually fairly easy.
7357 Supporting a new class file is a bit harder.
7358 We'll discuss the former in this section and the latter in the next.
7360 \change_deleted 5863208 1594239023
7361 Similar remarks apply, of course, if you want to support a new DocBook DTD.
7366 \begin_layout Standard
7367 The easier case is the one in which your new document class is provided
7368 as a style file that is to be used in conjunction with an already supported
7370 For the sake of the example, we'll assume that the style file is called
7372 \begin_inset Flex Noun
7375 \begin_layout Plain Layout
7381 and that it is meant to be used with
7382 \begin_inset Flex Noun
7385 \begin_layout Plain Layout
7391 , which is a standard class.
7395 \begin_layout Standard
7396 Start by copying the existing class's layout file into your local directory:
7400 \begin_layout Plain Layout
7401 Of course, which directory is your local directory will vary by platform,
7402 and \SpecialChar LyX
7403 allows you to specify your local directory on startup, too, using
7405 \begin_inset Flex Code
7408 \begin_layout Plain Layout
7422 \begin_layout LyX-Code
7423 cp report.layout ~/.lyx/layouts/myclass.layout
7426 \begin_layout Standard
7428 \begin_inset Flex Code
7431 \begin_layout Plain Layout
7437 and change the line:
7440 \begin_layout LyX-Code
7443 DeclareLaTeXClass{Report (Standard Class)}
7446 \begin_layout Standard
7450 \begin_layout LyX-Code
7453 DeclareLaTeXClass[report, myclass.sty]{Report (My Class)}
7456 \begin_layout Standard
7460 \begin_layout LyX-Code
7462 \begin_inset Newline newline
7468 \begin_inset Newline newline
7474 \begin_layout Standard
7475 near the top of the file.
7478 \begin_layout Standard
7479 Start \SpecialChar LyX
7481 \begin_inset Flex Noun
7484 \begin_layout Plain Layout
7485 Tools\SpecialChar menuseparator
7492 Then restart \SpecialChar LyX
7493 and try creating a new document.
7495 \begin_inset Flex Noun
7498 \begin_layout Plain Layout
7504 " as a document class option in the
7505 \begin_inset Flex Noun
7508 \begin_layout Plain Layout
7509 Document\SpecialChar menuseparator
7516 It is likely that some of the sectioning commands and such in your new
7517 class will work differently from how they worked in the base class—
7518 \begin_inset Flex Code
7521 \begin_layout Plain Layout
7527 in this example—so you can fiddle around with the settings for the different
7528 sections if you wish.
7529 The layout information for sections is contained in
7530 \begin_inset Flex Code
7533 \begin_layout Plain Layout
7539 , but you do not need to copy and change this file.
7540 Instead, you can simply add your changes to your layout file, after the
7542 \begin_inset Flex Code
7545 \begin_layout Plain Layout
7551 , which itself includes
7552 \begin_inset Flex Code
7555 \begin_layout Plain Layout
7562 For example, you might add these lines:
7565 \begin_layout LyX-Code
7569 \begin_layout LyX-Code
7573 \begin_layout LyX-Code
7577 \begin_layout LyX-Code
7581 \begin_layout LyX-Code
7585 \begin_layout Standard
7586 to change the font for chapter headings to sans-serif.
7587 This will override (or, in this case, add to) the existing declaration
7588 for the Chapter style.
7592 \begin_layout Standard
7593 Your new package may also provide commands or environments not present in
7595 In this case, you will want to add these to the layout file.
7597 \begin_inset CommandInset ref
7599 reference "sec:TextClass"
7603 for information on how to do so.
7606 \begin_layout Standard
7608 \begin_inset Flex Noun
7611 \begin_layout Plain Layout
7617 can be used with several different document classes, and even if it cannot,
7618 you might find it easiest just to write a module that you can load with
7620 The simplest possible such module would be:
7623 \begin_layout LyX-Code
7626 DeclareLyXModule{My Class}
7629 \begin_layout LyX-Code
7633 \begin_layout LyX-Code
7634 #Support for myclass.sty.
7637 \begin_layout LyX-Code
7639 \begin_inset Newline newline
7645 \begin_layout LyX-Code
7653 \begin_inset Newline newline
7659 \begin_layout LyX-Code
7661 \begin_inset Newline newline
7667 \begin_inset Newline newline
7673 \begin_layout Standard
7674 A more complex module might modify the behavior of some existing constructs
7675 or define some new ones.
7677 \begin_inset CommandInset ref
7679 reference "sec:TextClass"
7686 \begin_layout Subsection
7688 \begin_inset Flex Noun
7691 \begin_layout Plain Layout
7700 \begin_layout Standard
7701 There are two possibilities here.
7702 One is that the class file is itself based upon an existing document class.
7703 For example, many thesis classes are based upon
7704 \begin_inset Flex Noun
7707 \begin_layout Plain Layout
7714 To see whether yours is, look for a line like
7717 \begin_layout LyX-Code
7723 \begin_layout Standard
7725 If so, then you may proceed largely as in the previous section, though
7727 \begin_inset Flex Code
7730 \begin_layout Plain Layout
7731 Declare\SpecialChar LaTeX
7737 line will be different.
7738 If your new class is
7739 \begin_inset Flex Code
7742 \begin_layout Plain Layout
7748 and it is based upon
7749 \begin_inset Flex Code
7752 \begin_layout Plain Layout
7758 , then the line should read:
7762 \begin_layout Plain Layout
7763 And it will be easiest if you save the file to
7764 \begin_inset Flex Code
7767 \begin_layout Plain Layout
7774 assumes that the document class has the same name as the layout file.
7783 \begin_layout LyX-Code
7786 DeclareLaTeXClass[thesis,book]{thesis}
7789 \begin_layout Standard
7790 If, on the other hand, the new class is not based upon an existing class,
7791 you will probably have to
7792 \begin_inset Quotes eld
7796 \begin_inset Quotes erd
7800 We strongly suggest copying an existing layout file which uses a similar
7802 class and then modifying it, if you can do so.
7803 At least use an existing file as a starting point so you can find out what
7804 items you need to worry about.
7805 Again, the specifics are covered below.
7808 \begin_layout Subsection
7810 \begin_inset CommandInset label
7812 name "subsec:Creating-Templates"
7819 \begin_layout Standard
7820 Once you have written a layout file for a new document class, you might
7821 want to consider writing a
7826 A template acts as a kind of tutorial for your layout, showing how it might
7827 be used, though containing dummy content.
7828 You can of course look at the various templates included with \SpecialChar LyX
7832 \begin_layout Standard
7833 Templates are created just like usual documents: using \SpecialChar LyX
7835 The only difference is that usual documents contain all possible settings,
7836 including the font scheme and the paper size.
7837 Usually a user doesn't want a template to overwrite his preferred settings
7838 for such parameters.
7839 For that reason, the designer of a template should remove the corresponding
7841 \begin_inset Flex Code
7844 \begin_layout Plain Layout
7853 \begin_inset Flex Code
7856 \begin_layout Plain Layout
7864 from the template \SpecialChar LyX
7866 This can be done with any simple text-editor, for example
7867 \begin_inset Flex Code
7870 \begin_layout Plain Layout
7877 \begin_inset Flex Code
7880 \begin_layout Plain Layout
7889 \begin_layout Standard
7890 Put the edited template files you create in
7891 \begin_inset Flex Code
7894 \begin_layout Plain Layout
7900 , copy the ones you use from the global template directory in
7901 \begin_inset Flex Code
7904 \begin_layout Plain Layout
7910 to the same place, and redefine the template path in the
7911 \begin_inset Flex Noun
7914 \begin_layout Plain Layout
7915 Tools\SpecialChar menuseparator
7916 Preferences\SpecialChar menuseparator
7925 \begin_layout Standard
7926 Note, by the way, that there is a template which has a particular meaning:
7927 \begin_inset Newline linebreak
7931 \begin_inset Flex Code
7934 \begin_layout Plain Layout
7941 This template is loaded every time you create a new document with
7942 \begin_inset Flex Noun
7945 \begin_layout Plain Layout
7946 File\SpecialChar menuseparator
7952 in order to provide useful defaults.
7953 To create this template from inside \SpecialChar LyX
7954 , all you have to do is to open a document
7955 with the correct settings, and use the
7956 \begin_inset Flex Noun
7959 \begin_layout Plain Layout
7960 Save as Document Defaults
7968 \begin_layout Subsection
7969 Upgrading old layout files
7972 \begin_layout Standard
7973 The format of layout files changes with each \SpecialChar LyX
7974 release, so old layout files
7975 need to be converted to the new format.
7977 reads a layout file in an older format, it automatically calls the
7979 \begin_inset Flex Code
7982 \begin_layout Plain Layout
7988 to convert it to a temporary file in current format.
7989 The original file is left untouched.
7990 If you use the layout file often, then, you may want to convert it permanently,
7991 so that \SpecialChar LyX
7992 does not have to do so itself every time.
7993 To do this, you can call the converter manually:
7996 \begin_layout Enumerate
7998 \begin_inset Flex Code
8001 \begin_layout Plain Layout
8008 \begin_inset Flex Code
8011 \begin_layout Plain Layout
8020 \begin_layout Enumerate
8022 \begin_inset Newline newline
8026 \begin_inset Flex Code
8029 \begin_layout Plain Layout
8030 python LyXDir/scripts/layout2layout.py myclass.old myclass.layout
8036 \begin_inset Newline newline
8040 \begin_inset Flex Code
8043 \begin_layout Plain Layout
8049 is the name of your \SpecialChar LyX
8053 \begin_layout Standard
8054 Note that manual conversion does not affect included files, so these will
8055 have to be converted separately.
8058 \begin_layout Subsection
8059 \begin_inset CommandInset label
8061 name "subsec:Cite-Engine-Files"
8068 \begin_layout Standard
8069 A specific form of layout files are the so-called
8070 \begin_inset Flex Code
8073 \begin_layout Plain Layout
8079 files that are located in the
8080 \begin_inset Flex Code
8083 \begin_layout Plain Layout
8090 Their purpose is to define the specifics of \SpecialChar LaTeX
8091 packages aimed at bibliography
8104 , but also the way how normal Bib\SpecialChar TeX
8105 citations (without additional packages)
8106 are handled in \SpecialChar LyX
8107 is defined in such a file.
8111 \begin_layout Standard
8112 More specifically, it is defined which packages \SpecialChar LyX
8113 needs to load, which citation
8114 commands are available, how these are to be displayed in \SpecialChar LyX
8116 the dialogs, the context menus) as well as in the XHTML and plain text
8118 Furthermore, the files specify available style variants (author-year, numerical
8119 , etc.) and their specifics.
8120 The cite engine files are also used to generate the options that are available
8123 Document\SpecialChar menuseparator
8124 Settings\SpecialChar menuseparator
8125 Bibliography\SpecialChar menuseparator
8131 \begin_layout Standard
8132 Even though a cite engine file is essentially a normal layout file that
8133 could theoretically include any layout information, it usually primarily
8134 includes some specific parameters such as
8135 \begin_inset Flex Code
8138 \begin_layout Plain Layout
8145 \begin_inset Flex Code
8148 \begin_layout Plain Layout
8155 \begin_inset Flex Code
8158 \begin_layout Plain Layout
8165 \begin_inset Flex Code
8168 \begin_layout Plain Layout
8175 The syntax of the latter two is described in
8176 \begin_inset CommandInset ref
8178 reference "subsec:Citation-engine-description"
8186 \begin_inset CommandInset ref
8188 reference "subsec:Citation-format-description"
8192 , as well as in the files themselves.
8195 \begin_layout Section
8196 \begin_inset CommandInset label
8198 name "sec:TextClass"
8202 The layout file format
8205 \begin_layout Standard
8206 The following sections describe how layout files are structured and written.
8207 Our advice is to go slowly, save and test often.
8208 It is really not that hard, except that the multitude of options can become
8209 overwhelming, especially if you try to check out too many at once.
8210 It becomes easier if you use existing layouts of \SpecialChar LyX
8211 as examples/reference
8212 or if you modify an existing layout to your needs.
8215 \begin_layout Standard
8216 Note that all the tags used in layout files are case-insensitive.
8218 \begin_inset Flex Code
8221 \begin_layout Plain Layout
8228 \begin_inset Flex Code
8231 \begin_layout Plain Layout
8238 \begin_inset Flex Code
8241 \begin_layout Plain Layout
8247 are really the same tag.
8248 The possible arguments are printed in brackets after the tag's name.
8249 The default argument is typeset
8250 \begin_inset Flex Code
8253 \begin_layout Plain Layout
8262 If the argument has a data type like
8263 \begin_inset Quotes eld
8267 \begin_inset Quotes erd
8271 \begin_inset Quotes eld
8275 \begin_inset Quotes erd
8278 , the default is shown like this:
8279 \begin_inset Flex Code
8282 \begin_layout Plain Layout
8293 \begin_layout Subsection
8294 The document class declaration and classification
8297 \begin_layout Standard
8298 Lines in a layout file which begin with
8299 \begin_inset Flex Code
8302 \begin_layout Plain Layout
8309 There is one exception to this rule.
8311 \begin_inset Flex Code
8314 \begin_layout Plain Layout
8320 files should begin with lines like:
8323 \begin_layout LyX-Code
8326 #% Do not delete the line below; configure depends on this
8329 \begin_layout LyX-Code
8334 DeclareLaTeXClass{Article (Standard Class)}
8337 \begin_layout LyX-Code
8342 DeclareCategory{Articles}
8345 \begin_layout Standard
8346 The second and third lines are used when you (re)configure \SpecialChar LyX
8348 The layout file is read by the \SpecialChar LaTeX
8350 \begin_inset Flex Code
8353 \begin_layout Plain Layout
8359 , in a special mode where
8360 \begin_inset Flex Code
8363 \begin_layout Plain Layout
8370 The first line is just a \SpecialChar LaTeX
8371 comment, the second one contains the mandatory
8372 declaration of the text class and the third line contains the optional
8373 classification of the class.
8374 If these lines appear in a file named
8375 \begin_inset Flex Code
8378 \begin_layout Plain Layout
8384 , then they define a text class of name
8385 \begin_inset Flex Code
8388 \begin_layout Plain Layout
8394 (the name of the layout file) which uses the \SpecialChar LaTeX
8396 \begin_inset Flex Code
8399 \begin_layout Plain Layout
8405 (the default is to use the same name as the layout).
8407 \begin_inset Quotes eld
8410 Article (Standard Class)
8411 \begin_inset Quotes erd
8414 that appears above is used as a description of the text class in the
8415 \begin_inset Flex Noun
8418 \begin_layout Plain Layout
8419 Document\SpecialChar menuseparator
8427 \begin_inset Quotes eld
8431 \begin_inset Quotes erd
8434 in the example) is also used in the
8435 \begin_inset Flex Noun
8438 \begin_layout Plain Layout
8439 Document\SpecialChar menuseparator
8445 dialog: the text classes are grouped by these categories (which are usually
8446 genres, so typical categories are
8447 \begin_inset Quotes eld
8451 \begin_inset Quotes erd
8455 \begin_inset Quotes eld
8459 \begin_inset Quotes erd
8463 \begin_inset Quotes eld
8467 \begin_inset Quotes erd
8471 \begin_inset Quotes eld
8475 \begin_inset Quotes erd
8479 \begin_inset Quotes eld
8483 \begin_inset Quotes erd
8487 \begin_inset Quotes eld
8491 \begin_inset Quotes erd
8495 If no category has been declared, the class will be put in the
8496 \begin_inset Quotes eld
8500 \begin_inset Quotes erd
8506 \begin_layout Standard
8507 Let's assume that you wrote your own text class that uses the
8508 \begin_inset Flex Code
8511 \begin_layout Plain Layout
8517 document class, but where you changed the appearance of the section headings.
8518 If you put it in a file
8519 \begin_inset Flex Code
8522 \begin_layout Plain Layout
8528 , the header of this file should be:
8531 \begin_layout LyX-Code
8534 #% Do not delete the line below; configure depends on this
8537 \begin_layout LyX-Code
8542 DeclareLaTeXClass[article]{Article (with My Own Headings)}
8545 \begin_layout LyX-Code
8550 DeclareCategory{Articles}
8553 \begin_layout Standard
8554 This declares a text class
8555 \begin_inset Flex Code
8558 \begin_layout Plain Layout
8564 , associated with the \SpecialChar LaTeX
8566 \begin_inset Flex Code
8569 \begin_layout Plain Layout
8576 \begin_inset Quotes eld
8579 Article (with My Own Headings)
8580 \begin_inset Quotes erd
8584 If your text class depends on several packages, you can declare it as:
8587 \begin_layout LyX-Code
8590 #% Do not delete the line below; configure depends on this
8593 \begin_layout LyX-Code
8598 DeclareLaTeXClass[article,foo.sty]{Article (with My Own Headings)}
8601 \begin_layout LyX-Code
8606 DeclareCategory{Articles}
8609 \begin_layout Standard
8610 This indicates that your text class uses the
8611 \begin_inset Flex Code
8614 \begin_layout Plain Layout
8622 \change_deleted 5863208 1594239179
8623 Finally, it is also possible to declare classes for DocBook code.
8624 Typical declarations will look like:
8627 \begin_layout LyX-Code
8629 \change_deleted 5863208 1594239179
8632 #% Do not delete the line below; configure depends on this
8635 \begin_layout LyX-Code
8637 \change_deleted 5863208 1594239179
8642 DeclareDocBookClass[article]{SGML (DocBook Article)}
8645 \begin_layout LyX-Code
8647 \change_deleted 5863208 1594239179
8652 DeclareCategory{Articles (DocBook)}
8657 \begin_layout Standard
8658 Note that these declarations can also be given an optional parameter declaring
8659 the name of the document class (but not a list).
8662 \begin_layout Standard
8663 So, to be as explicit as possible, the form of the layout declaration is:
8666 \begin_layout LyX-Code
8671 DeclareLaTeXClass[class,package.sty]{layout description}
8674 \begin_layout LyX-Code
8679 DeclareCategory{category}
8682 \begin_layout Standard
8683 The class need only be specified if the name of the \SpecialChar LaTeX
8685 name of the layout file are different or if there are packages to load.
8686 If the name of the class file is not specified, then \SpecialChar LyX
8688 that it is the same as the name of the layout file.
8691 \begin_layout Standard
8692 When the text class has been modified to your taste, all you have to do
8693 is to copy it either to
8694 \begin_inset Flex Code
8697 \begin_layout Plain Layout
8704 \begin_inset Flex Code
8707 \begin_layout Plain Layout
8714 \begin_inset Flex Noun
8717 \begin_layout Plain Layout
8718 Tools\SpecialChar menuseparator
8724 , exit \SpecialChar LyX
8726 Then your new text class should be available along with the others.
8729 \begin_layout Standard
8730 Once the layout file is installed, you can edit it and see your changes
8731 without having to reconfigure or to restart \SpecialChar LyX
8736 \begin_layout Plain Layout
8737 In versions of \SpecialChar LyX
8738 prior to 1.6, this was not true.
8739 As a result, editing layout files was very time consuming, since you had
8740 constantly to restart \SpecialChar LyX
8746 You can force a reload of the current layout by using the \SpecialChar LyX
8748 \begin_inset Flex Noun
8751 \begin_layout Plain Layout
8758 There is no default binding for this function—though, of course, you can
8759 bind it to a key yourself.
8760 But you will normally use this function simply by entering it in the mini-buffe
8765 \begin_layout Standard
8771 \begin_inset Flex Noun
8774 \begin_layout Plain Layout
8780 is very much an `advanced feature'.
8785 recommended that you save your work before using this function.
8790 recommended that you not attempt to edit layout information while simultaneousl
8791 y working on a document that you care about.
8792 Use a test document.
8793 Syntax errors and the like in your layout file could cause peculiar behavior.
8794 In particular, such errors could cause \SpecialChar LyX
8795 to regard the current layout as
8796 invalid and to attempt to switch to some other layout.
8800 \begin_layout Plain Layout
8801 Really bad syntax errors may even caused \SpecialChar LyX
8803 This is because certain sorts of errors may make \SpecialChar LyX
8814 The \SpecialChar LyX
8815 team strives to keep \SpecialChar LyX
8816 stable in such situations, but safe is better
8821 \begin_layout Plain Layout
8822 While we're giving advice: make regular backups.
8823 And be nice to your mother.
8831 \begin_layout Subsection
8832 The Module declaration
8835 \begin_layout Standard
8836 A module must begin with a line like the following:
8839 \begin_layout LyX-Code
8842 DeclareLyXModule[endnotes.sty]{Endnotes}
8843 \change_inserted -712698321 1554395911
8847 \begin_layout LyX-Code
8849 \change_inserted -712698321 1554395924
8854 DeclareCategory{Foot- and Endnotes}
8855 \change_deleted -712698321 1554395911
8863 \begin_layout Standard
8864 The mandatory argument
8865 \change_inserted -712698321 1554395956
8874 , in curly brackets, is the name of the module, as it should appear in
8875 \begin_inset Flex Noun
8878 \begin_layout Plain Layout
8879 Document\SpecialChar menuseparator
8880 Settings\SpecialChar menuseparator
8887 The argument in square brackets is optional: It declares any \SpecialChar LaTeX
8889 on which the module depends.
8890 It is also possible to use the form
8891 \begin_inset Flex Noun
8894 \begin_layout Plain Layout
8900 as an optional argument, which declares that the module can only be used
8901 when there exists a conversion chain between the formats `
8902 \begin_inset Flex Code
8905 \begin_layout Plain Layout
8912 \begin_inset Flex Code
8915 \begin_layout Plain Layout
8923 \change_inserted -712698321 1554396133
8930 declaration is not strictly mandatory, but you should add it, since it
8931 is helpful to find the module.
8932 Please have a look at the existing module categories and if appropriate,
8938 \begin_layout Standard
8940 \change_inserted -712698321 1554395988
8943 declaration should then be followed by lines like the following:
8947 \begin_layout Plain Layout
8948 Preferably in English if the module should be published with \SpecialChar LyX
8950 This description will appear in the list of messages to be translated and
8951 will be thus translated with the next interface update.
8959 \begin_layout LyX-Code
8963 \begin_layout LyX-Code
8964 #Adds an endnote command, in addition to footnotes.
8968 \begin_layout LyX-Code
8969 #You will need to add
8971 theendnotes in TeX code where you
8974 \begin_layout LyX-Code
8975 #want the endnotes to appear.
8979 \begin_layout LyX-Code
8983 \begin_layout LyX-Code
8984 #Requires: somemodule | othermodule
8987 \begin_layout LyX-Code
8988 #Excludes: badmodule
8991 \begin_layout Standard
8992 The description is used in
8993 \begin_inset Flex Noun
8996 \begin_layout Plain Layout
8997 Document\SpecialChar menuseparator
8998 Settings\SpecialChar menuseparator
9004 to provide the user with information about what the module does.
9006 \begin_inset Flex Code
9009 \begin_layout Plain Layout
9015 line is used to identify other modules with which this one must be used;
9017 \begin_inset Flex Code
9020 \begin_layout Plain Layout
9026 line is used to identify modules with which this one may not be used.
9027 Both are optional, and, as shown, multiple modules should be separated
9028 with the pipe symbol: |.
9029 Note that the required modules are treated disjunctively:
9033 of the required modules must be used.
9038 excluded module may be used.
9039 Note that modules are identified here by their filenames without the
9040 \begin_inset Flex Code
9043 \begin_layout Plain Layout
9051 \begin_inset Flex Code
9054 \begin_layout Plain Layout
9061 \begin_inset Flex Code
9064 \begin_layout Plain Layout
9073 \begin_layout Subsection
9074 The CiteEngine file declaration
9077 \begin_layout Standard
9078 A cite engine file must begin with a line like the following:
9081 \begin_layout LyX-Code
9084 DeclareLyXCiteEngineModule[biblatex.sty]{Biblatex}
9087 \begin_layout Standard
9088 The mandatory argument, in curly brackets, is the name of the cite style,
9089 as it should appear in
9090 \begin_inset Flex Noun
9093 \begin_layout Plain Layout
9094 Document\SpecialChar menuseparator
9095 Settings\SpecialChar menuseparator
9102 The argument in square brackets is optional: It declares any \SpecialChar LaTeX
9104 on which the cite engine depends.
9107 \begin_layout Standard
9108 The cite engine declaration should then be followed by lines like the following:
9112 \begin_layout Plain Layout
9113 Preferably in English if the module should be published with \SpecialChar LyX
9115 This description will appear in the list of messages to be translated and
9116 will be thus translated with the next interface update.
9124 \begin_layout LyX-Code
9128 \begin_layout LyX-Code
9129 # Biblatex supports many author-year and numerical styles.
9132 \begin_layout LyX-Code
9133 # It is mainly aimed at the Humanities.
9137 \begin_layout LyX-Code
9138 # customizable, fully localized and provides many features
9141 \begin_layout LyX-Code
9142 # that are not possible with BibTeX.
9143 The use of 'biber' as
9146 \begin_layout LyX-Code
9147 # bibliography processor is advised.
9150 \begin_layout LyX-Code
9154 \begin_layout Standard
9155 The description is used in
9156 \begin_inset Flex Noun
9159 \begin_layout Plain Layout
9160 Document\SpecialChar menuseparator
9161 Settings\SpecialChar menuseparator
9167 to provide the user with information about the cite engine.
9170 \begin_layout Subsection
9174 \begin_layout Standard
9175 The first non-comment line of any layout file, included file, or module
9180 contain the file format number:
9183 \begin_layout Description
9184 \begin_inset Flex Code
9187 \begin_layout Plain Layout
9194 \begin_inset Flex Code
9197 \begin_layout Plain Layout
9203 ] The format number of the layout file.
9206 \begin_layout Standard
9207 This tag was introduced with \SpecialChar LyX
9209 \begin_inset space ~
9213 Layout files from older \SpecialChar LyX
9214 versions do not have an explicit file format and
9215 are considered to have
9216 \begin_inset Flex Code
9219 \begin_layout Plain Layout
9221 \begin_inset space ~
9230 The format for the present version of \SpecialChar LyX
9232 But each version of \SpecialChar LyX
9233 is capable of reading earlier versions' layout files,
9234 just as they are capable of reading files produced by earlier versions
9237 There is, however, no provision for converting to earlier formats.
9240 \begin_layout Subsection
9241 \begin_inset CommandInset label
9243 name "subsec:General-text-class"
9247 General text class parameters
9250 \begin_layout Standard
9251 These are general parameters that govern the behavior of an entire document
9257 mean that they must appear in
9258 \begin_inset Flex Code
9261 \begin_layout Plain Layout
9267 files rather than in modules.
9268 A module can contain any layout tag.)
9271 \begin_layout Description
9273 \change_inserted -712698321 1526899478
9274 \begin_inset Flex Code
9277 \begin_layout Plain Layout
9279 \change_inserted -712698321 1526898610
9280 AddToCiteEngine <engine>
9287 Extends the possibilities for displaying citation references.
9289 \begin_inset CommandInset ref
9291 reference "subsec:Citation-engine-description"
9300 \begin_inset Flex Code
9303 \begin_layout Plain Layout
9305 \change_inserted -712698321 1526898823
9316 \begin_layout Description
9317 \begin_inset Flex Code
9320 \begin_layout Plain Layout
9326 Adds information that will be output in the
9327 \begin_inset Flex Code
9330 \begin_layout Plain Layout
9336 block when the document is output to XHTML.
9337 Typically, this would be used to output CSS style information, but it can
9338 be used for anything that can appear in
9339 \begin_inset Flex Code
9342 \begin_layout Plain Layout
9350 \begin_inset Quotes eld
9354 \begin_inset Flex Code
9357 \begin_layout Plain Layout
9364 \begin_inset Quotes erd
9370 \begin_layout Description
9371 \begin_inset Flex Code
9374 \begin_layout Plain Layout
9380 Adds information to the document preamble.
9382 \begin_inset Newline newline
9386 \begin_inset Quotes eld
9390 \begin_inset Flex Code
9393 \begin_layout Plain Layout
9400 \begin_inset Quotes erd
9404 \change_inserted -712698321 1562592950
9408 \begin_layout Description
9410 \change_inserted -712698321 1562593040
9411 \begin_inset Flex Code
9414 \begin_layout Plain Layout
9416 \change_inserted -712698321 1562592954
9425 \begin_inset Flex Code
9428 \begin_layout Plain Layout
9430 \change_inserted -712698321 1562592950
9441 \begin_inset space \thinspace{}
9445 \begin_inset Flex Code
9448 \begin_layout Plain Layout
9450 \change_inserted -712698321 1562592950
9458 ] If the document class adds the bibliography to the table of contents,
9459 add this option with value
9460 \begin_inset Flex Code
9463 \begin_layout Plain Layout
9465 \change_inserted -712698321 1562592996
9474 \begin_inset Flex Code
9477 \begin_layout Plain Layout
9479 \change_inserted -712698321 1562593006
9488 This prevents the bibliography from being added twice.
9493 \begin_layout Description
9494 \begin_inset Flex Code
9497 \begin_layout Plain Layout
9503 Defines the possibilities for displaying citation references.
9505 \begin_inset CommandInset ref
9507 reference "subsec:Citation-engine-description"
9516 \begin_inset Quotes eld
9520 \begin_inset Flex Code
9523 \begin_layout Plain Layout
9530 \begin_inset Quotes erd
9534 Primarily used in cite engine files (see
9535 \begin_inset CommandInset ref
9537 reference "subsec:Cite-Engine-Files"
9546 \change_inserted -712698321 1526898530
9547 Note that if you specify this in a layout file or module, any cite engine
9548 definition will be overridden.
9550 \begin_inset Flex Code
9553 \begin_layout Plain Layout
9555 \change_inserted -712698321 1526898530
9568 \begin_layout Description
9569 \begin_inset Flex Code
9572 \begin_layout Plain Layout
9578 Defines formats for use in the display of bibliographic information.
9580 \begin_inset CommandInset ref
9582 reference "subsec:Citation-format-description"
9588 \begin_inset Quotes eld
9592 \begin_inset Flex Code
9595 \begin_layout Plain Layout
9602 \begin_inset Quotes erd
9606 Primarily used in cite engine files (see
9607 \begin_inset CommandInset ref
9609 reference "subsec:Cite-Engine-Files"
9618 \change_inserted -712698321 1526898585
9619 A cite format defined in a layout or module will override the cite engine
9625 \begin_layout Description
9626 \begin_inset Flex Code
9629 \begin_layout Plain Layout
9636 \begin_inset Flex Code
9639 \begin_layout Plain Layout
9648 \begin_inset Flex Code
9651 \begin_layout Plain Layout
9657 ] Determines whether
9661 or Bib\SpecialChar TeX
9662 is used to generate a Bibliography.
9663 Primarily used in cite engine files (see
9664 \begin_inset CommandInset ref
9666 reference "subsec:Cite-Engine-Files"
9676 \begin_layout Description
9677 \begin_inset Flex Code
9680 \begin_layout Plain Layout
9686 Describes various global options supported by the document class.
9688 \begin_inset CommandInset ref
9690 reference "subsec:ClassOptions"
9696 \begin_inset Quotes eld
9700 \begin_inset Flex Code
9703 \begin_layout Plain Layout
9710 \begin_inset Quotes erd
9716 \begin_layout Description
9717 \begin_inset Flex Code
9720 \begin_layout Plain Layout
9727 \begin_inset Flex Code
9730 \begin_layout Plain Layout
9739 \begin_inset space \thinspace{}
9743 \begin_inset Flex Code
9746 \begin_layout Plain Layout
9752 ] Whether the class should
9756 to having one or two columns.
9757 Can be changed in the
9758 \begin_inset Flex Noun
9761 \begin_layout Plain Layout
9762 Document\SpecialChar menuseparator
9771 \begin_layout Description
9772 \begin_inset Flex Code
9775 \begin_layout Plain Layout
9782 \begin_inset Flex Code
9785 \begin_layout Plain Layout
9791 ] This sequence defines the properties for a counter.
9792 If the counter does not yet exist, it is created; if it does exist, it
9795 \begin_inset Quotes eld
9799 \begin_inset Flex Code
9802 \begin_layout Plain Layout
9809 \begin_inset Quotes erd
9813 \begin_inset Newline newline
9817 \begin_inset CommandInset ref
9819 reference "subsec:Counters"
9823 for details on counters.
9826 \begin_layout Description
9827 \begin_inset Flex Code
9830 \begin_layout Plain Layout
9836 Sets the default font used to display the document.
9838 \begin_inset CommandInset ref
9840 reference "subsec:Font-description"
9844 for how to declare fonts.
9846 \begin_inset Quotes eld
9850 \begin_inset Flex Code
9853 \begin_layout Plain Layout
9860 \begin_inset Quotes erd
9866 \begin_layout Description
9867 \begin_inset Flex Code
9870 \begin_layout Plain Layout
9877 \begin_inset Flex Code
9880 \begin_layout Plain Layout
9886 ] Specifies a module to be included by default with this document class.
9887 The module is specified as filename without the
9888 \begin_inset Flex Code
9891 \begin_layout Plain Layout
9898 The user can still remove the module, but it will be active at the outset.
9899 (This applies only when new files are created, or when this class is chosen
9900 for an existing document.)
9903 \begin_layout Description
9904 \begin_inset Flex Code
9907 \begin_layout Plain Layout
9914 \begin_inset Flex Code
9917 \begin_layout Plain Layout
9923 ] This is the style that will be assigned to new paragraphs, usually
9924 \begin_inset Flex Noun
9927 \begin_layout Plain Layout
9934 This will default to the first defined style if not given, but you are
9935 encouraged to use this directive.
9938 \begin_layout Description
9940 \change_inserted -970929547 1515112870
9941 \begin_inset Flex Code
9944 \begin_layout Plain Layout
9946 \change_inserted -970929547 1515112782
9955 \begin_inset Flex Code
9958 \begin_layout Plain Layout
9960 \change_inserted -970929547 1515112766
9968 ] The root element (at the top of the document) to use when outputting documents
9969 with this class in DocBook.
9970 The default value is
9971 \begin_inset Quotes eld
9975 \begin_inset Flex Code
9978 \begin_layout Plain Layout
9980 \change_inserted -970929547 1515112845
9989 \begin_inset Quotes erd
9994 \change_deleted 1075283030 1594226862
9996 \change_inserted 1075283030 1594226777
10000 \begin_layout Description
10002 \change_inserted 1075283030 1594226859
10003 \begin_inset Flex Code
10006 \begin_layout Plain Layout
10008 \change_inserted 1075283030 1594226785
10009 DocBookForceAbstract
10017 \begin_inset Flex Code
10020 \begin_layout Plain Layout
10022 \change_inserted 1075283030 1594226804
10031 \begin_inset Quotes eld
10039 \begin_inset Quotes erd
10042 , the root element will always have an
10047 The default value is
10048 \begin_inset Quotes eld
10056 \begin_inset Quotes erd
10064 \begin_layout Description
10065 \begin_inset Flex Code
10068 \begin_layout Plain Layout
10075 \begin_inset Flex Code
10078 \begin_layout Plain Layout
10084 ] This tag indicates that the module (which is specified by filename without
10086 \begin_inset Flex Code
10089 \begin_layout Plain Layout
10095 extension) cannot be used with this document class.
10096 This might be used in a journal-specific layout file to prevent, say, the
10098 \begin_inset Flex Code
10101 \begin_layout Plain Layout
10107 module that numbers theorems by section.
10112 be used in a module.
10113 Modules have their own way of excluding other modules (see
10114 \begin_inset CommandInset ref
10116 reference "subsec:Layout-modules"
10123 \begin_layout Description
10124 \begin_inset Flex Code
10127 \begin_layout Plain Layout
10133 Defines a new float.
10135 \begin_inset CommandInset ref
10137 reference "subsec:Floats"
10143 \begin_inset Quotes eld
10147 \begin_inset Flex Code
10150 \begin_layout Plain Layout
10157 \begin_inset Quotes erd
10163 \begin_layout Description
10164 \begin_inset Flex Code
10167 \begin_layout Plain Layout
10173 Sets the information that will be output in the
10174 \begin_inset Flex Code
10177 \begin_layout Plain Layout
10183 block when this document class is output to XHTML.
10184 Note that this will completely override any prior
10185 \begin_inset Flex Code
10188 \begin_layout Plain Layout
10195 \begin_inset Flex Code
10198 \begin_layout Plain Layout
10206 \begin_inset Newline newline
10210 \begin_inset Flex Code
10213 \begin_layout Plain Layout
10219 if you just want to add material to the preamble.) Must end with
10220 \begin_inset Quotes eld
10224 \begin_inset Flex Code
10227 \begin_layout Plain Layout
10234 \begin_inset Quotes erd
10240 \begin_layout Description
10241 \begin_inset Flex Code
10244 \begin_layout Plain Layout
10251 \begin_inset Flex Code
10254 \begin_layout Plain Layout
10260 ] The style to use for the table of contents, bibliography, and so forth,
10261 when the document is output to HTML.
10262 For articles, this should normally be
10263 \begin_inset Flex Code
10266 \begin_layout Plain Layout
10273 \begin_inset Flex Code
10276 \begin_layout Plain Layout
10283 If it is not given, then \SpecialChar LyX
10284 will attempt to figure out which layout to use.
10287 \begin_layout Description
10288 \begin_inset Flex Code
10291 \begin_layout Plain Layout
10298 \begin_inset Flex Code
10301 \begin_layout Plain Layout
10307 ] Modifies the properties of the given counter.
10308 If the counter does not exist, the statement is ignored.
10310 \begin_inset Quotes eld
10314 \begin_inset Flex Code
10317 \begin_layout Plain Layout
10324 \begin_inset Quotes erd
10328 \begin_inset Newline newline
10332 \begin_inset CommandInset ref
10334 reference "subsec:Counters"
10338 for details on counters.
10341 \begin_layout Description
10342 \begin_inset Flex Code
10345 \begin_layout Plain Layout
10352 \begin_inset Flex Code
10355 \begin_layout Plain Layout
10361 ] This allows you to include another layout definition file within yours
10362 to avoid duplicating commands.
10363 Common examples are the standard layout files, for example,
10364 \begin_inset Flex Code
10367 \begin_layout Plain Layout
10373 , which contains most of the basic layouts.
10376 \begin_layout Description
10377 \begin_inset Flex Code
10380 \begin_layout Plain Layout
10387 \begin_inset Flex Code
10390 \begin_layout Plain Layout
10396 ] This section (re-)defines the layout of an inset.
10397 It can be applied to an existing inset or to a new, user-defined inset,
10398 e.g., a new character style.
10400 \begin_inset Quotes eld
10404 \begin_inset Flex Code
10407 \begin_layout Plain Layout
10414 \begin_inset Quotes erd
10418 \begin_inset Newline newline
10422 \begin_inset CommandInset ref
10424 reference "subsec:Flex-insets-and"
10428 for more information.
10432 \begin_layout Description
10433 \begin_inset Flex Code
10436 \begin_layout Plain Layout
10443 \begin_inset Flex Code
10446 \begin_layout Plain Layout
10452 ] A string that indicates the width of the left margin on the screen, for
10454 \begin_inset Quotes eld
10458 \begin_inset Flex Code
10461 \begin_layout Plain Layout
10468 \begin_inset Quotes erd
10472 (Note that this is not a `length', like
10473 \begin_inset Quotes eld
10477 \begin_inset Quotes erd
10483 \begin_layout Description
10484 \begin_inset Flex Code
10487 \begin_layout Plain Layout
10494 \begin_inset Flex Code
10497 \begin_layout Plain Layout
10503 ] An integer that determines the maximal number of names displayed in an
10504 author-year citation before the citation switches to
10505 \begin_inset Quotes eld
10509 \begin_inset Quotes erd
10513 Primarily used in cite engine files (see
10514 \begin_inset CommandInset ref
10516 reference "subsec:Cite-Engine-Files"
10526 \begin_layout Description
10527 \begin_inset Flex Code
10530 \begin_layout Plain Layout
10537 \begin_inset Flex Code
10540 \begin_layout Plain Layout
10546 ] Modifies the properties of the given paragraph style.
10547 If the style does not exist, this section is ignored.
10549 \begin_inset Quotes eld
10553 \begin_inset Flex Code
10556 \begin_layout Plain Layout
10563 \begin_inset Quotes erd
10569 \begin_layout Description
10570 \begin_inset Flex Code
10573 \begin_layout Plain Layout
10580 \begin_inset Flex Code
10583 \begin_layout Plain Layout
10589 ] Deletes an existing counter, usually one defined in an included file.
10592 \begin_layout Description
10593 \begin_inset Flex Code
10596 \begin_layout Plain Layout
10603 \begin_inset Flex Code
10606 \begin_layout Plain Layout
10612 ] Deletes an existing float.
10613 This is particularly useful when you want to suppress a float that has
10614 been defined in an input file.
10617 \begin_layout Description
10618 \begin_inset Flex Code
10621 \begin_layout Plain Layout
10628 \begin_inset Flex Code
10631 \begin_layout Plain Layout
10637 ] Deletes an existing style.
10640 \begin_layout Description
10641 \begin_inset Flex Code
10644 \begin_layout Plain Layout
10651 \begin_inset Flex Code
10654 \begin_layout Plain Layout
10661 \begin_inset Flex Code
10664 \begin_layout Plain Layout
10670 ] Define a new table of contents with type
10671 \begin_inset Flex Code
10674 \begin_layout Plain Layout
10681 \begin_inset Flex Code
10684 \begin_layout Plain Layout
10691 See also the AddToToc commands.
10694 \begin_layout Description
10695 \begin_inset Flex Code
10698 \begin_layout Plain Layout
10705 \begin_inset Flex Code
10708 \begin_layout Plain Layout
10714 ] The file format (as defined in the \SpecialChar LyX
10715 preferences) produced by this document
10717 It is mainly useful when
10718 \begin_inset Flex Code
10721 \begin_layout Plain Layout
10728 \begin_inset Flex Code
10731 \begin_layout Plain Layout
10737 and one wants to define a new type of literate document.
10738 The format is reset to
10739 \change_deleted 5863208 1594239413
10741 \begin_inset Quotes eld
10745 \begin_inset Flex Code
10748 \begin_layout Plain Layout
10755 \begin_inset Quotes erd
10761 \begin_inset Quotes eld
10765 \begin_inset Flex Code
10768 \begin_layout Plain Layout
10775 \begin_inset Quotes erd
10778 when the corresponding
10779 \begin_inset Flex Code
10782 \begin_layout Plain Layout
10788 parameter is encountered.
10791 \begin_layout Description
10792 \begin_inset Flex Code
10795 \begin_layout Plain Layout
10802 \begin_inset Flex Code
10805 \begin_layout Plain Layout
10816 \change_deleted 5863208 1594239430
10818 \begin_inset Flex Code
10821 \begin_layout Plain Layout
10830 \begin_inset Flex Code
10833 \begin_layout Plain Layout
10839 ] Specifies what sort of output documents using this class will produce.
10842 \begin_layout Description
10843 \begin_inset Flex Code
10846 \begin_layout Plain Layout
10853 \begin_inset Flex Code
10856 \begin_layout Plain Layout
10863 \begin_inset Flex Code
10866 \begin_layout Plain Layout
10872 ] Specifies options, given in the second string, for the package named by
10875 \begin_inset Quotes eld
10879 \begin_inset Flex Code
10882 \begin_layout Plain Layout
10883 PackageOptions natbib square
10889 \begin_inset Quotes erd
10893 \begin_inset Flex Code
10896 \begin_layout Plain Layout
10902 to be loaded with the
10903 \begin_inset Flex Code
10906 \begin_layout Plain Layout
10913 (For \SpecialChar TeX
10914 perts, this causes \SpecialChar LyX
10916 \begin_inset Flex Code
10919 \begin_layout Plain Layout
10922 PassOptionsToPackage{natbib}{square}
10928 \begin_inset Flex Code
10931 \begin_layout Plain Layout
10938 \change_inserted -712698321 1565102364
10942 \begin_layout Description
10944 \change_inserted -712698321 1565102470
10945 \begin_inset Flex Code
10948 \begin_layout Plain Layout
10950 \change_inserted -712698321 1565102365
10959 \begin_inset Flex Code
10962 \begin_layout Plain Layout
10964 \change_inserted -712698321 1565105222
10969 , letter, legal, executive, a0, a1, a2, a3, a4, a5, a6, b0, b1, b2, b3,
10970 b4, b5, b6, c0, c1, c2, c3, c4, c5, c6, b0j, b1j, b2j, b3j, b4j, b5j, b6j
10977 ] The default page size.
10978 This is used by some converters.
10983 \begin_layout Description
10984 \begin_inset Flex Code
10987 \begin_layout Plain Layout
10994 \begin_inset Flex Code
10997 \begin_layout Plain Layout
11006 \begin_inset Flex Code
11009 \begin_layout Plain Layout
11016 \begin_inset Flex Code
11019 \begin_layout Plain Layout
11025 ] The default pagestyle.
11026 Can be changed in the
11027 \begin_inset Flex Noun
11030 \begin_layout Plain Layout
11031 Document\SpecialChar menuseparator
11040 \begin_layout Description
11041 \begin_inset Flex Code
11044 \begin_layout Plain Layout
11050 Sets the preamble for the \SpecialChar LaTeX
11052 Note that this will completely override any prior
11053 \begin_inset Flex Code
11056 \begin_layout Plain Layout
11063 \begin_inset Flex Code
11066 \begin_layout Plain Layout
11074 \begin_inset Flex Code
11077 \begin_layout Plain Layout
11083 if you just want to add material to the preamble.) Must end with
11084 \begin_inset Quotes eld
11088 \begin_inset Flex Code
11091 \begin_layout Plain Layout
11098 \begin_inset Quotes erd
11104 \begin_layout Description
11105 \begin_inset Flex Code
11108 \begin_layout Plain Layout
11115 \begin_inset Flex Code
11118 \begin_layout Plain Layout
11125 \begin_inset Flex Code
11128 \begin_layout Plain Layout
11137 \begin_inset space \thinspace{}
11141 \begin_inset Flex Code
11144 \begin_layout Plain Layout
11150 ] Whether the class already provides the feature
11151 \begin_inset Flex Code
11154 \begin_layout Plain Layout
11161 A feature is in general the name of a package (e.
11162 \begin_inset space \thinspace{}
11166 \begin_inset space \space{}
11170 \begin_inset Flex Code
11173 \begin_layout Plain Layout
11180 \begin_inset Flex Code
11183 \begin_layout Plain Layout
11190 \begin_inset space \thinspace{}
11194 \begin_inset space \space{}
11198 \begin_inset Flex Code
11201 \begin_layout Plain Layout
11208 \begin_inset Flex Code
11211 \begin_layout Plain Layout
11219 \begin_inset CommandInset ref
11221 reference "chap:List-of-functions"
11225 for the list of features.
11228 \begin_layout Description
11229 \begin_inset Flex Code
11232 \begin_layout Plain Layout
11239 \begin_inset Flex Code
11242 \begin_layout Plain Layout
11248 ] Indicates that this layout provides the functionality of the module mentioned,
11249 which should be specified by the filename without the
11250 \begin_inset Flex Code
11253 \begin_layout Plain Layout
11260 This will typically be used if the layout includes the module directly,
11261 rather than using the
11262 \begin_inset Flex Code
11265 \begin_layout Plain Layout
11271 tag to indicate that it ought to be used.
11272 It could also be used in a module that provided an alternate implementation
11273 of the same functionality.
11276 \begin_layout Description
11277 \begin_inset Flex Code
11280 \begin_layout Plain Layout
11287 \begin_inset Flex Code
11290 \begin_layout Plain Layout
11296 ] Creates a new paragraph style if it does not already exist.
11297 If the style does exist, this section is ignored.
11299 \begin_inset Quotes eld
11303 \begin_inset Flex Code
11306 \begin_layout Plain Layout
11313 \begin_inset Quotes erd
11319 \begin_layout Description
11320 \begin_inset Flex Code
11323 \begin_layout Plain Layout
11330 \begin_inset Flex Code
11333 \begin_layout Plain Layout
11339 ] Whether the class requires the feature
11340 \begin_inset Flex Code
11343 \begin_layout Plain Layout
11350 Multiple features must be separated by commas.
11351 Note that you can only request supported features.
11353 \begin_inset CommandInset ref
11355 reference "chap:List-of-functions"
11359 for the list of features.).
11360 If you require a package with specific options, you can additionally use
11362 \begin_inset Flex Code
11365 \begin_layout Plain Layout
11374 \begin_layout Description
11375 \begin_inset Flex Code
11378 \begin_layout Plain Layout
11385 \begin_inset Flex Code
11388 \begin_layout Plain Layout
11394 ] A string that indicates the width of the right margin on the screen, for
11396 \begin_inset Quotes eld
11400 \begin_inset Flex Code
11403 \begin_layout Plain Layout
11410 \begin_inset Quotes erd
11416 \begin_layout Description
11417 \begin_inset Flex Code
11420 \begin_layout Plain Layout
11427 \begin_inset Flex Code
11430 \begin_layout Plain Layout
11436 ] Sets which divisions get numbered.
11438 \begin_inset Newline newline
11442 \begin_inset Flex Code
11445 \begin_layout Plain Layout
11451 counter in \SpecialChar LaTeX
11455 \begin_layout Description
11456 \begin_inset Flex Code
11459 \begin_layout Plain Layout
11466 \begin_inset Flex Code
11469 \begin_layout Plain Layout
11478 \begin_inset space \thinspace{}
11482 \begin_inset Flex Code
11485 \begin_layout Plain Layout
11491 ] Whether the class-default should be printing on one or both sides of the
11493 Can be changed in the
11494 \begin_inset Flex Noun
11497 \begin_layout Plain Layout
11498 Document\SpecialChar menuseparator
11507 \begin_layout Description
11508 \begin_inset Flex Code
11511 \begin_layout Plain Layout
11518 \begin_inset Flex Code
11521 \begin_layout Plain Layout
11527 ] This sequence defines a paragraph style.
11528 If the style does not yet exist, it is created; if it does exist, its parameter
11531 \begin_inset Quotes eld
11535 \begin_inset Flex Code
11538 \begin_layout Plain Layout
11545 \begin_inset Quotes erd
11549 \begin_inset Newline newline
11553 \begin_inset CommandInset ref
11555 reference "subsec:Paragraph-Styles"
11559 for details on paragraph styles.
11560 \change_inserted -712698321 1553617804
11564 \begin_layout Description
11566 \change_inserted -712698321 1553617862
11567 \begin_inset Flex Code
11570 \begin_layout Plain Layout
11572 \change_inserted -712698321 1553617809
11581 \begin_inset Flex Code
11584 \begin_layout Plain Layout
11586 \change_inserted -712698321 1553617805
11594 ] defines the default table style that is used when inserting a table.
11595 The following styles are available:
11599 \begin_layout Itemize
11601 \change_inserted -712698321 1554308039
11602 \begin_inset Flex Code
11605 \begin_layout Plain Layout
11607 \change_inserted -712698321 1554307928
11608 Formal_with_Footline
11616 \begin_inset Quotes eld
11620 \begin_inset Quotes erd
11623 ) style with horizontal lines only, using a bold top and bottom line, the
11624 first and last row are additionally separated from the table body with
11625 a thin middle line.
11628 \begin_layout Itemize
11630 \change_inserted -712698321 1554308087
11631 \begin_inset Flex Code
11634 \begin_layout Plain Layout
11636 \change_inserted -712698321 1554308042
11637 Formal_without_Footline
11644 : same as the above, but the last row is not separated with a middle line
11648 \begin_layout Itemize
11650 \change_inserted -712698321 1553618031
11651 \begin_inset Flex Code
11654 \begin_layout Plain Layout
11656 \change_inserted -712698321 1553618006
11664 : Simple table lines.
11667 \begin_layout Itemize
11669 \change_inserted -712698321 1553618309
11670 \begin_inset Flex Code
11673 \begin_layout Plain Layout
11675 \change_inserted -712698321 1553618031
11684 \begin_inset Flex Code
11687 \begin_layout Plain Layout
11689 \change_inserted -712698321 1553618043
11697 , but with the header column offset with a second horizontal line.
11698 This is also the default style of \SpecialChar LyX
11702 \begin_layout Itemize
11704 \change_inserted -712698321 1553618280
11705 \begin_inset Flex Code
11708 \begin_layout Plain Layout
11710 \change_inserted -712698321 1553618261
11718 : Table without lines.
11724 \begin_layout Description
11725 \begin_inset Flex Code
11728 \begin_layout Plain Layout
11735 \begin_inset Flex Code
11738 \begin_layout Plain Layout
11744 ] The name of the command or environment to be used with
11745 \begin_inset Flex Code
11748 \begin_layout Plain Layout
11757 \begin_layout Description
11758 \begin_inset Flex Code
11761 \begin_layout Plain Layout
11768 \begin_inset Flex Code
11771 \begin_layout Plain Layout
11780 \begin_inset Flex Code
11783 \begin_layout Plain Layout
11789 ] Indicates what kind of markup is used to define the title of a document.
11791 \begin_inset Flex Code
11794 \begin_layout Plain Layout
11800 means that the macro with name
11801 \begin_inset Flex Code
11804 \begin_layout Plain Layout
11810 will be inserted after the last layout which has
11811 \begin_inset Quotes eld
11815 \begin_inset Flex Code
11818 \begin_layout Plain Layout
11820 \begin_inset space ~
11829 \begin_inset Quotes erd
11834 \begin_inset Flex Code
11837 \begin_layout Plain Layout
11843 corresponds to the case where all layouts which have
11844 \begin_inset Quotes eld
11848 \begin_inset Flex Code
11851 \begin_layout Plain Layout
11853 \begin_inset space ~
11862 \begin_inset Quotes erd
11865 should be enclosed into the
11866 \begin_inset Flex Code
11869 \begin_layout Plain Layout
11878 \begin_layout Description
11879 \begin_inset Flex Code
11882 \begin_layout Plain Layout
11889 \begin_inset Flex Code
11892 \begin_layout Plain Layout
11898 ] Sets which divisions are included in the table of contents.
11900 \begin_inset Flex Code
11903 \begin_layout Plain Layout
11909 counter in \SpecialChar LaTeX
11913 \begin_layout Subsection
11914 \begin_inset Flex Code
11917 \begin_layout Plain Layout
11924 \begin_inset CommandInset label
11926 name "subsec:ClassOptions"
11933 \begin_layout Standard
11935 \begin_inset Flex Code
11938 \begin_layout Plain Layout
11944 section can contain the following entries:
11947 \begin_layout Description
11948 \begin_inset Flex Code
11951 \begin_layout Plain Layout
11958 \begin_inset Flex Code
11961 \begin_layout Plain Layout
11967 ] The list of available font sizes for the document's main font, separated
11969 \begin_inset Quotes eld
11973 \begin_inset Flex Code
11976 \begin_layout Plain Layout
11983 \begin_inset Quotes erd
11988 \change_inserted -712698321 1565110196
11989 Any number is possible.
11992 \begin_layout Description
11994 \change_inserted -712698321 1565110259
11995 \begin_inset Flex Code
11998 \begin_layout Plain Layout
12000 \change_inserted -712698321 1565110199
12009 \begin_inset Flex Code
12012 \begin_layout Plain Layout
12014 \change_inserted -712698321 1565110196
12022 ] The format for the font size option.
12024 \begin_inset Flex Code
12027 \begin_layout Plain Layout
12029 \change_inserted -712698321 1565110238
12039 \begin_inset Flex Code
12042 \begin_layout Plain Layout
12044 \change_inserted -712698321 1565110248
12052 is a placeholder for the font size.
12057 \begin_layout Description
12059 \change_deleted 5863208 1594239483
12060 \begin_inset Flex Code
12063 \begin_layout Plain Layout
12069 Used to set the DTD line with XML-based output classes.
12071 \begin_inset space \thinspace{}
12075 \begin_inset Quotes eld
12078 -//OASIS//DTD DocBook V4.2//EN
12079 \begin_inset Quotes erd
12083 \change_inserted -712698321 1565101761
12087 \begin_layout Description
12089 \change_inserted -712698321 1565180598
12090 \begin_inset Flex Code
12093 \begin_layout Plain Layout
12095 \change_inserted -712698321 1565101918
12104 \begin_inset Flex Code
12107 \begin_layout Plain Layout
12109 \change_inserted -712698321 1565105399
12110 string="letter|\SpecialChar allowbreak
12111 legal|\SpecialChar allowbreak
12112 executive|\SpecialChar allowbreak
12113 a0|\SpecialChar allowbreak
12114 a1|\SpecialChar allowbreak
12115 a2|\SpecialChar allowbreak
12116 a3|\SpecialChar allowbreak
12117 a4|\SpecialChar allowbreak
12118 a5|\SpecialChar allowbreak
12119 a6|\SpecialChar allowbreak
12120 b0|\SpecialChar allowbreak
12121 b1|\SpecialChar allowbreak
12122 b2|\SpecialChar allowbreak
12123 b3|\SpecialChar allowbreak
12124 b4|\SpecialChar allowbreak
12125 b5|\SpecialChar allowbreak
12126 b6|\SpecialChar allowbreak
12127 c0|\SpecialChar allowbreak
12128 c1|\SpecialChar allowbreak
12130 2|\SpecialChar allowbreak
12131 c3|\SpecialChar allowbreak
12132 c4|\SpecialChar allowbreak
12133 c5|\SpecialChar allowbreak
12134 c6|\SpecialChar allowbreak
12135 b0j|\SpecialChar allowbreak
12136 b1j|\SpecialChar allowbreak
12137 b2j|\SpecialChar allowbreak
12138 b3j|\SpecialChar allowbreak
12139 b4j|\SpecialChar allowbreak
12140 b5j|\SpecialChar allowbreak
12148 ] The list of available page sizes, separated by
12149 \begin_inset Quotes eld
12153 \begin_inset Flex Code
12156 \begin_layout Plain Layout
12158 \change_inserted -712698321 1565101779
12167 \begin_inset Quotes erd
12171 Currently, only the listed sizes are supported.
12172 Other sizes might be entered as custom class option.
12175 \begin_layout Description
12177 \change_inserted -712698321 1565180623
12178 \begin_inset Flex Code
12181 \begin_layout Plain Layout
12183 \change_inserted -712698321 1565180605
12192 \begin_inset Flex Code
12195 \begin_layout Plain Layout
12197 \change_inserted -712698321 1565180601
12205 ] The format for the page size option.
12207 \begin_inset Flex Code
12210 \begin_layout Plain Layout
12212 \change_inserted -712698321 1565180618
12222 \begin_inset Flex Code
12225 \begin_layout Plain Layout
12227 \change_inserted -712698321 1565180601
12235 is a placeholder for the paper size.
12240 \begin_layout Description
12241 \begin_inset Flex Code
12244 \begin_layout Plain Layout
12251 \begin_inset Flex Code
12254 \begin_layout Plain Layout
12255 string="empty|plain|headings|fancy"
12260 ] The list of available page sty\SpecialChar softhyphen
12262 \begin_inset Quotes eld
12266 \begin_inset Flex Code
12269 \begin_layout Plain Layout
12276 \begin_inset Quotes erd
12282 \begin_layout Description
12283 \begin_inset Flex Code
12286 \begin_layout Plain Layout
12293 \begin_inset Flex Code
12296 \begin_layout Plain Layout
12302 ] Some document class options, separated by a comma, that will be added
12303 to the optional part of the
12304 \begin_inset Flex Code
12307 \begin_layout Plain Layout
12318 \begin_layout Standard
12320 \begin_inset Flex Code
12323 \begin_layout Plain Layout
12329 section must end with
12330 \begin_inset Quotes eld
12334 \begin_inset Flex Code
12337 \begin_layout Plain Layout
12344 \begin_inset Quotes erd
12350 \begin_layout Subsection
12352 \begin_inset CommandInset label
12354 name "subsec:Paragraph-Styles"
12361 \begin_layout Standard
12362 A paragraph style description looks like this:
12366 \begin_layout Plain Layout
12367 Note that this will either define a new style or modify an existing one.
12375 \begin_layout LyX-Code
12382 \begin_layout LyX-Code
12386 \begin_layout LyX-Code
12390 \begin_layout Standard
12391 where the following commands are allowed:
12394 \begin_layout Description
12395 \begin_inset Flex Code
12398 \begin_layout Plain Layout
12405 \begin_inset Flex Code
12408 \begin_layout Plain Layout
12414 =""] This paragraph will appear in the table of contents of the given type.
12415 An empty string disables.
12416 See also the OutlinerName and the IsTocCaption commands.
12420 \begin_layout Description
12421 \begin_inset Flex Code
12424 \begin_layout Plain Layout
12431 \begin_inset Flex Code
12434 \begin_layout Plain Layout
12439 , left, right, center
12444 ] Paragraph alignment.
12447 \begin_layout Description
12448 \begin_inset Flex Code
12451 \begin_layout Plain Layout
12458 \begin_inset Flex Code
12461 \begin_layout Plain Layout
12466 , left, right, center
12471 ] A comma separated list of permitted alignments.
12472 (Some \SpecialChar LaTeX
12473 styles prohibit certain alignments, since those wouldn't make sense.
12474 For example a right-aligned or centered enumeration isn't possible.)
12477 \begin_layout Description
12478 \begin_inset Flex Code
12481 \begin_layout Plain Layout
12488 \begin_inset Flex Code
12491 \begin_layout Plain Layout
12497 ] Defines argument number <int> of a command\SpecialChar breakableslash
12498 environment associated with
12500 This is useful for things like section headings, and only makes sense with
12503 Every (optional or required) argument of a command or environment – except
12504 for the required argument that is associated with the content of the paragraph
12505 itself – has a separate definition, where the number specifies the order
12507 The definition must end with
12508 \begin_inset Flex Code
12511 \begin_layout Plain Layout
12518 So a command with two optional arguments has:
12522 \begin_layout Quote
12528 \begin_layout Quote
12534 \begin_layout Quote
12540 \begin_layout Quote
12546 \begin_layout Quote
12552 \begin_layout Quote
12558 \begin_layout Standard
12560 \begin_inset Flex Code
12563 \begin_layout Plain Layout
12569 definition, the following specifications are possible:
12572 \begin_layout Itemize
12573 \begin_inset Flex Code
12576 \begin_layout Plain Layout
12583 \begin_inset Flex Code
12586 \begin_layout Plain Layout
12592 The string that will appear both in the menu (to insert this argument)
12593 and on the argument inset button (unless you also specify a separate
12594 \begin_inset Flex Code
12597 \begin_layout Plain Layout
12604 For the menu, you can define an accelerator by appending the respective
12605 character to the string, divided by
12606 \begin_inset Quotes eld
12610 \begin_inset Quotes erd
12614 \begin_inset space \thinspace{}
12618 \begin_inset space \space{}
12622 \begin_inset Quotes eld
12626 \begin_inset Flex Code
12629 \begin_layout Plain Layout
12636 \begin_inset Quotes erd
12642 \begin_layout Itemize
12643 \begin_inset Flex Code
12646 \begin_layout Plain Layout
12653 \begin_inset Flex Code
12656 \begin_layout Plain Layout
12662 A separate string for the menu.
12663 You can define an accelerator by appending the respective character to
12664 the string, divided by
12665 \begin_inset Quotes eld
12669 \begin_inset Quotes erd
12673 \begin_inset space \thinspace{}
12677 \begin_inset space \space{}
12681 \begin_inset Quotes eld
12685 \begin_inset Flex Code
12688 \begin_layout Plain Layout
12695 \begin_inset Quotes erd
12699 This specification is optional.
12700 If it is not given the
12701 \begin_inset Flex Code
12704 \begin_layout Plain Layout
12710 will be used instead for the menu.
12713 \begin_layout Itemize
12714 \begin_inset Flex Code
12717 \begin_layout Plain Layout
12724 \begin_inset Flex Code
12727 \begin_layout Plain Layout
12733 A longer explanatory text that appears in the tooltip when hovering over
12734 the argument inset.
12737 \begin_layout Itemize
12738 \begin_inset Flex Code
12741 \begin_layout Plain Layout
12748 \begin_inset Flex Code
12751 \begin_layout Plain Layout
12760 \begin_inset space \thinspace{}
12764 \begin_inset Flex Code
12767 \begin_layout Plain Layout
12773 ] Declare if this is a mandatory (1) or an optional (0) argument.
12774 Mandatory arguments will be output empty if not given, while optional arguments
12775 will not be output at all.
12776 By default, mandatory arguments are delimited by
12777 \begin_inset Flex Code
12780 \begin_layout Plain Layout
12786 , while optional arguments are delimited by
12787 \begin_inset Flex Code
12790 \begin_layout Plain Layout
12797 \change_inserted -712698321 1555579782
12801 \begin_layout Itemize
12803 \change_inserted -712698321 1555579780
12804 \begin_inset Flex Code
12807 \begin_layout Plain Layout
12809 \change_inserted -712698321 1555579780
12818 \begin_inset Flex Code
12821 \begin_layout Plain Layout
12823 \change_inserted -712698321 1555579780
12831 Option to define a different command (from the default
12832 \begin_inset Flex Code
12835 \begin_layout Plain Layout
12837 \change_inserted -712698321 1555579780
12849 ) to be used for line breaks.
12850 The initial backslash must not be specified.
12855 \begin_layout Itemize
12856 \begin_inset Flex Code
12859 \begin_layout Plain Layout
12866 \begin_inset Flex Code
12869 \begin_layout Plain Layout
12875 defines another argument (by its number) which this argument requires to
12876 be output if it is itself output.
12878 \begin_inset space \thinspace{}
12881 g., in \SpecialChar LaTeX
12882 commands, optional arguments often require previous optional arguments
12883 to be output (at least empty), as in
12884 \begin_inset Flex Code
12887 \begin_layout Plain Layout
12890 command[][argument]{text}
12896 This can be achieved by the statement
12897 \begin_inset Flex Code
12900 \begin_layout Plain Layout
12907 \begin_inset Flex Code
12910 \begin_layout Plain Layout
12919 \begin_layout Itemize
12920 \begin_inset Flex Code
12923 \begin_layout Plain Layout
12930 \begin_inset Flex Code
12933 \begin_layout Plain Layout
12939 defines a custom left delimiter (instead of
12940 \begin_inset Flex Code
12943 \begin_layout Plain Layout
12950 \begin_inset Flex Code
12953 \begin_layout Plain Layout
12960 A line break in the output can be indicated by
12961 \begin_inset Flex Code
12964 \begin_layout Plain Layout
12973 \begin_layout Itemize
12974 \begin_inset Flex Code
12977 \begin_layout Plain Layout
12984 \begin_inset Flex Code
12987 \begin_layout Plain Layout
12993 defines a custom right delimiter (instead of
12994 \begin_inset Flex Code
12997 \begin_layout Plain Layout
13004 \begin_inset Flex Code
13007 \begin_layout Plain Layout
13014 A line break in the output can be indicated by
13015 \begin_inset Flex Code
13018 \begin_layout Plain Layout
13027 \begin_layout Itemize
13028 \begin_inset Flex Code
13031 \begin_layout Plain Layout
13038 \begin_inset Flex Code
13041 \begin_layout Plain Layout
13047 defines an argument that is inserted if and only if no user-specified arguments
13049 \begin_inset space \thinspace{}
13053 \begin_inset space \space{}
13056 if no argument inset has been inserted (note that also an empty argument
13057 inset omits the DefaultArg).
13058 Multiple arguments need to be separated by comma.
13061 \begin_layout Itemize
13062 \begin_inset Flex Code
13065 \begin_layout Plain Layout
13072 \begin_inset Flex Code
13075 \begin_layout Plain Layout
13081 defines an argument that is inserted in any case (alone or in addition
13082 to user-specified arguments).
13083 Multiple arguments need to be separated by comma.
13086 \begin_layout Itemize
13087 \begin_inset Flex Code
13090 \begin_layout Plain Layout
13096 The font used for the argument content, see
13097 \begin_inset CommandInset ref
13099 reference "subsec:Font-description"
13104 \change_inserted -712698321 1559484228
13108 \begin_layout Itemize
13110 \change_inserted -712698321 1559484228
13111 \begin_inset Flex Code
13114 \begin_layout Plain Layout
13116 \change_inserted -712698321 1559484228
13125 \begin_inset Flex Code
13128 \begin_layout Plain Layout
13130 \change_inserted -712698321 1559484228
13141 \begin_inset space \thinspace{}
13145 \begin_inset Flex Code
13148 \begin_layout Plain Layout
13150 \change_inserted -712698321 1559484228
13158 ] As with paragraph styles, see
13159 \begin_inset CommandInset ref
13161 reference "subsec:Paragraph-Styles"
13170 \begin_layout Itemize
13171 \begin_inset Flex Code
13174 \begin_layout Plain Layout
13180 The font used for the label; see
13181 \begin_inset CommandInset ref
13183 reference "subsec:Font-description"
13190 \begin_layout Itemize
13191 \begin_inset Flex Code
13194 \begin_layout Plain Layout
13201 \begin_inset Flex Code
13204 \begin_layout Plain Layout
13209 , Minimalistic, Conglomerate
13214 ] describes the rendering style used for the inset's frame and buttons.
13217 \begin_layout Itemize
13218 \begin_inset Flex Code
13221 \begin_layout Plain Layout
13228 \begin_inset Flex Code
13231 \begin_layout Plain Layout
13238 \begin_inset Flex Code
13241 \begin_layout Plain Layout
13247 , this argument is automatically inserted when the respective style is selected.
13249 \change_deleted -712698321 1559484200
13250 Currently, only one argument per style\SpecialChar breakableslash
13251 layout can be automatically inserted.
13256 \begin_layout Itemize
13258 \change_inserted -712698321 1559491402
13259 \begin_inset Flex Code
13262 \begin_layout Plain Layout
13264 \change_inserted -712698321 1559490711
13273 \begin_inset Flex Code
13276 \begin_layout Plain Layout
13278 \change_inserted -712698321 1559490703
13287 \begin_inset Flex Code
13290 \begin_layout Plain Layout
13292 \change_inserted -712698321 1559490703
13300 , this argument will be inserted on a new line with
13301 \begin_inset Flex Code
13304 \begin_layout Plain Layout
13306 \change_inserted -712698321 1559491402
13314 (only available within Flex insets).
13317 \begin_layout Itemize
13318 \begin_inset Flex Code
13321 \begin_layout Plain Layout
13328 \begin_inset Flex Code
13331 \begin_layout Plain Layout
13338 \begin_inset Flex Code
13341 \begin_layout Plain Layout
13347 , this argument will be inserted with a copy of the co-text (either selected
13348 text or the whole paragraph) as content.
13351 \begin_layout Itemize
13352 \begin_inset Flex Code
13355 \begin_layout Plain Layout
13362 \begin_inset Flex Code
13365 \begin_layout Plain Layout
13375 ] Whether the contents of this argument should be output in raw form, meaning
13376 without special translations that \SpecialChar LaTeX
13379 \begin_inset Flex Code
13382 \begin_layout Plain Layout
13388 status is inherited by the inset or paragraph layout the argument belongs
13389 to, true and false change the status for the given argument only.
13392 \begin_layout Itemize
13393 \begin_inset Flex Code
13396 \begin_layout Plain Layout
13403 \begin_inset Flex Code
13406 \begin_layout Plain Layout
13407 string of characters
13416 Defines individual characters
13417 \begin_inset Newline linebreak
13420 that should be output in raw form, meaning without special translations
13421 that \SpecialChar LaTeX
13423 Note that, contrary to PassThru, this needs to be explicitly defined for
13425 That is, arguments do not inherit PassThruChars from their parent inset
13429 \begin_layout Itemize
13430 \begin_inset Flex Code
13433 \begin_layout Plain Layout
13440 \begin_inset Flex Code
13443 \begin_layout Plain Layout
13452 \begin_inset space \thinspace{}
13456 \begin_inset Flex Code
13459 \begin_layout Plain Layout
13465 ] If this is set to 1, the argument will output its content in the corresponding
13466 item in the table of contents.
13470 \begin_layout Standard
13471 By default, the text entered in the \SpecialChar LyX
13472 workarea in the respective layout is
13473 the last (mandatory) argument of a command if the
13474 \begin_inset Flex Code
13477 \begin_layout Plain Layout
13484 \begin_inset Flex Code
13487 \begin_layout Plain Layout
13494 However, arguments with the prefix
13495 \begin_inset Flex Code
13498 \begin_layout Plain Layout
13504 are output after this workarea argument.
13505 Note that post-argument numbering restarts at 1, so the first argument
13506 following the workarea argument is
13507 \begin_inset Flex Code
13510 \begin_layout Plain Layout
13517 Post-arguments are ignored in any other
13518 \begin_inset Flex Code
13521 \begin_layout Plain Layout
13528 \begin_inset Flex Code
13531 \begin_layout Plain Layout
13540 \begin_layout Standard
13542 \begin_inset Flex Code
13545 \begin_layout Plain Layout
13554 \begin_inset Flex Code
13557 \begin_layout Plain Layout
13566 \begin_inset Flex Code
13569 \begin_layout Plain Layout
13575 followed by the number (e.
13576 \begin_inset space \thinspace{}
13580 \begin_inset space \space{}
13584 \begin_inset Flex Code
13587 \begin_layout Plain Layout
13594 \change_inserted -712698321 1534487781
13598 \begin_layout Standard
13600 \change_inserted -712698321 1534488561
13601 Finally, there is a special argument type with the prefix
13602 \begin_inset Flex Code
13605 \begin_layout Plain Layout
13607 \change_inserted -712698321 1534487844
13616 It is not really an argument, but uses the argument interface (thus, the
13617 prefix is also followed by a number, e.
13618 \begin_inset space \thinspace{}
13623 \begin_inset Flex Code
13626 \begin_layout Plain Layout
13628 \change_inserted -712698321 1534488412
13629 Argument listpreamble:1
13637 As the name implies, it is targeted at lists such as
13654 Its content will be output at the list start, before the first
13655 \begin_inset Flex Code
13658 \begin_layout Plain Layout
13660 \change_inserted -712698321 1534488058
13670 , on an own line (a place that is otherwise not accessible in \SpecialChar LyX
13672 This way, users can insert redefinitions (of lengths etc.) to individual
13674 By default, these arguments do not have a delimiter.
13680 \begin_layout Description
13681 \begin_inset Flex Code
13684 \begin_layout Plain Layout
13690 Includes a comma-separated list of layouts that should be nested in and
13691 after the current layout.
13692 Only makes sense for nestable layouts (such as environments).
13694 \begin_inset Quotes eld
13698 \begin_inset Flex Code
13701 \begin_layout Plain Layout
13708 \begin_inset Quotes erd
13713 \begin_inset Flex Code
13716 \begin_layout Plain Layout
13725 \begin_layout Description
13726 \begin_inset Flex Code
13729 \begin_layout Plain Layout
13735 Note that this will completely override any prior
13736 \begin_inset Flex Code
13739 \begin_layout Plain Layout
13745 declaration for this style.
13747 \begin_inset Quotes eld
13751 \begin_inset Flex Code
13754 \begin_layout Plain Layout
13761 \begin_inset Quotes erd
13766 \begin_inset CommandInset ref
13768 reference "subsec:I18n"
13772 for details on its use.
13775 \begin_layout Description
13776 \begin_inset Flex Code
13779 \begin_layout Plain Layout
13786 \begin_inset Flex Code
13789 \begin_layout Plain Layout
13799 \begin_layout Plain Layout
13800 Note that a `float' here is a real number, such as: 1.5.
13805 The vertical space with which the last of a chain of paragraphs with this
13806 style is separated from the following paragraph.
13807 If the next paragraph has another style, the separations are not simply
13808 added, but the maximum is taken.
13811 \begin_layout Description
13812 \begin_inset Flex Code
13815 \begin_layout Plain Layout
13822 \begin_inset Flex Code
13825 \begin_layout Plain Layout
13831 ] The category for this style.
13832 This is used to group related styles in the style combobox on the toolbar.
13833 Any string can be used, but you may want to use existing categories with
13838 \begin_layout Description
13839 \begin_inset Flex Code
13842 \begin_layout Plain Layout
13848 Depth of XML command.
13849 Used only with XML-type formats.
13852 \begin_layout Description
13853 \begin_inset Flex Code
13856 \begin_layout Plain Layout
13863 \begin_inset Flex Code
13866 \begin_layout Plain Layout
13872 ] Copies all the features of an existing style into the current one.
13876 \begin_layout Description
13877 \begin_inset Flex Code
13880 \begin_layout Plain Layout
13887 \begin_inset Flex Code
13890 \begin_layout Plain Layout
13896 ] The name of a style whose preamble should be output
13901 This allows to ensure some ordering of the preamble snippets when macros
13902 definitions depend on one another.
13906 \begin_layout Plain Layout
13907 Note that, besides that functionality, there is no way to ensure any ordering
13909 The ordering that you see in a given version of \SpecialChar LyX
13910 may change without warning
13919 \begin_layout Description
13920 \begin_inset Flex Code
13923 \begin_layout Plain Layout
13930 \begin_inset Flex Code
13933 \begin_layout Plain Layout
13938 , Box, Filled_Box, Static
13943 ] The type of label that stands at the end of the paragraph (or sequence
13945 \begin_inset Flex Code
13948 \begin_layout Plain Layout
13955 \begin_inset Newline newline
13959 \begin_inset Flex Code
13962 \begin_layout Plain Layout
13969 \begin_inset Flex Code
13972 \begin_layout Plain Layout
13979 \begin_inset Flex Code
13982 \begin_layout Plain Layout
13990 \begin_inset Flex Code
13993 \begin_layout Plain Layout
14000 \begin_inset Quotes eld
14004 \begin_inset Quotes erd
14008 \begin_inset Flex Code
14011 \begin_layout Plain Layout
14018 \begin_inset space \space{}
14022 \begin_inset Flex Code
14025 \begin_layout Plain Layout
14031 ) is a white (resp.
14032 \begin_inset space ~
14035 black) square suitable for end of proof markers,
14036 \begin_inset Flex Code
14039 \begin_layout Plain Layout
14045 is an explicit text string.
14048 \begin_layout Description
14049 \begin_inset Flex Code
14052 \begin_layout Plain Layout
14059 \begin_inset Flex Code
14062 \begin_layout Plain Layout
14068 ] The string used for a label with a
14069 \begin_inset Flex Code
14072 \begin_layout Plain Layout
14079 \begin_inset Newline newline
14083 \begin_inset Flex Code
14086 \begin_layout Plain Layout
14096 \begin_layout Description
14097 \begin_inset Flex Code
14100 \begin_layout Plain Layout
14106 The font used for both the text body
14112 \begin_inset CommandInset ref
14114 reference "subsec:Font-description"
14119 Note that defining this font automatically defines the
14120 \begin_inset Flex Code
14123 \begin_layout Plain Layout
14130 So you should define this one first if you also want to define
14131 \begin_inset Flex Code
14134 \begin_layout Plain Layout
14143 \begin_layout Description
14144 \begin_inset Flex Code
14147 \begin_layout Plain Layout
14154 \begin_inset Flex Code
14157 \begin_layout Plain Layout
14163 ] Used for backporting new styles to stable \SpecialChar LyX
14165 The first stable version that supports this tag is \SpecialChar LyX
14167 The argument is a number which may either be 0, -1 or any value greater
14170 \begin_inset Flex Code
14173 \begin_layout Plain Layout
14179 flag of a style is greater than zero, it will always be written to the
14181 If a .lyx file is read, the style definitions from the document header are
14182 added to the document class.
14183 Therefore even older \SpecialChar LyX
14184 versions can handle the style.
14186 \begin_inset Flex Code
14189 \begin_layout Plain Layout
14195 is a version number: if the style is read, and the version number is less
14196 than the version number of the already existing style in the document class,
14197 the new style is ignored.
14198 If the version number is greater, the new style replaces the existing style.
14199 A value of -1 means an infinite version number, i.
14200 \begin_inset space \thinspace{}
14204 \begin_inset space \space{}
14207 the style is always used.
14210 \begin_layout Description
14211 \begin_inset Flex Code
14214 \begin_layout Plain Layout
14221 \begin_inset Flex Code
14224 \begin_layout Plain Layout
14233 \begin_inset space \thinspace{}
14237 \begin_inset Flex Code
14240 \begin_layout Plain Layout
14246 ] Usually \SpecialChar LyX
14247 does not allow you to insert more than one space between words,
14248 since a space is considered as the separation between two words, not a
14249 character or symbol of its own.
14250 This is a very fine thing but sometimes annoying, for example, when typing
14251 program code or plain \SpecialChar LaTeX
14254 \begin_inset Flex Code
14257 \begin_layout Plain Layout
14265 \change_deleted -495245474 1550490105
14269 will create protected blanks for the additional blanks when in
14270 \change_inserted -495245474 1550490096
14272 \begin_inset Flex Code
14275 \begin_layout Plain Layout
14277 \change_inserted -495245474 1550490089
14286 \change_deleted -495245474 1550490116
14287 another mode than \SpecialChar LaTeX
14290 \change_inserted -495245474 1550247760
14292 \begin_inset Flex Code
14295 \begin_layout Plain Layout
14297 \change_inserted -495245474 1550247736
14306 \begin_inset Flex Code
14309 \begin_layout Plain Layout
14311 \change_inserted -495245474 1550247755
14324 \begin_layout Description
14325 \begin_inset Flex Code
14328 \begin_layout Plain Layout
14334 These tags are used with XHTML output.
14336 \begin_inset CommandInset ref
14338 reference "subsec:Paragraph-Style-XHTML"
14345 \begin_layout Description
14346 \begin_inset Flex Code
14349 \begin_layout Plain Layout
14355 [FIXME] (Used only with XML-type formats.)
14358 \begin_layout Description
14359 \begin_inset Flex Code
14362 \begin_layout Plain Layout
14369 \begin_inset Flex Code
14372 \begin_layout Plain Layout
14381 \begin_inset space \thinspace{}
14385 \begin_inset Flex Code
14388 \begin_layout Plain Layout
14395 \begin_inset Flex Code
14398 \begin_layout Plain Layout
14404 , marks the style as to be included in the document preamble and not in
14406 This is useful for document classes that want such information as the title
14407 and author to appear in the preamble.
14408 Note that this works only for styles for which the
14409 \begin_inset Flex Code
14412 \begin_layout Plain Layout
14419 \begin_inset Flex Code
14422 \begin_layout Plain Layout
14429 \begin_inset Flex Code
14432 \begin_layout Plain Layout
14441 \begin_layout Description
14442 \begin_inset Flex Code
14445 \begin_layout Plain Layout
14452 \begin_inset Flex Code
14455 \begin_layout Plain Layout
14464 \begin_inset space \thinspace{}
14468 \begin_inset Flex Code
14471 \begin_layout Plain Layout
14478 \begin_inset Flex Code
14481 \begin_layout Plain Layout
14487 , marks the style as being part of a title block (see also the
14488 \begin_inset Flex Code
14491 \begin_layout Plain Layout
14498 \begin_inset Flex Code
14501 \begin_layout Plain Layout
14510 \begin_layout Description
14511 \begin_inset Flex Code
14514 \begin_layout Plain Layout
14520 Includes a comma-separated list of layouts after which this one should
14522 Only makes sense with regard to nestable layouts (such as environments).
14524 \begin_inset Quotes eld
14528 \begin_inset Flex Code
14531 \begin_layout Plain Layout
14538 \begin_inset Quotes erd
14543 \begin_inset Flex Code
14546 \begin_layout Plain Layout
14555 \begin_layout Description
14556 \begin_inset Flex Code
14559 \begin_layout Plain Layout
14566 \begin_inset Flex Code
14569 \begin_layout Plain Layout
14578 \begin_inset space \thinspace{}
14582 \begin_inset Flex Code
14585 \begin_layout Plain Layout
14591 ] If this is set to 1 and AddToToc is enabled, the paragraph adds a summary
14592 of its contents in its item in the table of contents.
14593 Otherwise, only the label, if it exists, appears.
14596 \begin_layout Description
14597 \begin_inset Flex Code
14600 \begin_layout Plain Layout
14607 \begin_inset Flex Code
14610 \begin_layout Plain Layout
14616 ] The \SpecialChar LaTeX
14617 command sequence declaring an item in a list.
14618 The command is to be defined without the preceding backslash (the default
14620 \begin_inset Quotes eld
14624 \begin_inset Quotes erd
14628 \begin_inset Flex Code
14631 \begin_layout Plain Layout
14639 in the \SpecialChar LaTeX
14643 \begin_layout Description
14644 \begin_inset Flex Code
14647 \begin_layout Plain Layout
14654 \begin_inset Flex Code
14657 \begin_layout Plain Layout
14663 ] This provides extra space between paragraphs that have the same style.
14664 If you put other styles into an environment, each is separated with the
14666 \begin_inset Flex Code
14669 \begin_layout Plain Layout
14676 But the whole items of the environment are additionally separated with
14678 \begin_inset Flex Code
14681 \begin_layout Plain Layout
14688 Note that this is a
14693 \begin_layout Description
14694 \begin_inset Flex Code
14697 \begin_layout Plain Layout
14703 [FIXME] (Used only with XML-type formats.)
14706 \begin_layout Description
14707 \begin_inset Flex Code
14710 \begin_layout Plain Layout
14717 \begin_inset Flex Code
14720 \begin_layout Plain Layout
14729 \begin_inset space \thinspace{}
14733 \begin_inset Flex Code
14736 \begin_layout Plain Layout
14742 ] Usually \SpecialChar LyX
14743 does not allow you to leave a paragraph empty, since it would
14744 lead to empty \SpecialChar LaTeX
14746 There are some cases where this could be desirable however: in a letter
14747 template, the required fields can be provided as empty fields, so that
14748 people do not forget them; in some special classes, a style can be used
14749 as some kind of break, which does not contain actual text.
14752 \begin_layout Description
14753 \begin_inset Flex Code
14756 \begin_layout Plain Layout
14763 \begin_inset Flex Code
14766 \begin_layout Plain Layout
14772 ] The vertical space between the label and the text body.
14773 Only used for labels that are above the text body (
14774 \begin_inset Flex Code
14777 \begin_layout Plain Layout
14784 \begin_inset Newline newline
14788 \begin_inset Flex Code
14791 \begin_layout Plain Layout
14792 Centered_Top_Environment
14800 \begin_layout Description
14801 \begin_inset Flex Code
14804 \begin_layout Plain Layout
14811 \begin_inset Flex Code
14814 \begin_layout Plain Layout
14820 ] The name of the counter for automatic numbering.
14821 In order to have the counter appear with your label, you will need to reference
14823 \begin_inset Flex Code
14826 \begin_layout Plain Layout
14835 This will work with
14836 \begin_inset Flex Code
14839 \begin_layout Plain Layout
14846 \begin_inset Flex Code
14849 \begin_layout Plain Layout
14856 \begin_inset Flex Code
14859 \begin_layout Plain Layout
14866 \begin_inset Flex Code
14869 \begin_layout Plain Layout
14876 \begin_inset Newline newline
14884 \begin_inset Flex Code
14887 \begin_layout Plain Layout
14894 \begin_inset Flex Code
14897 \begin_layout Plain Layout
14903 , though this case is a bit complicated.
14904 Suppose you declare
14905 \begin_inset Quotes eld
14909 \begin_inset Flex Code
14912 \begin_layout Plain Layout
14913 LabelCounter myenum
14919 \begin_inset Quotes erd
14923 Then the actual counters used are
14924 \begin_inset Flex Code
14927 \begin_layout Plain Layout
14934 \begin_inset Flex Code
14937 \begin_layout Plain Layout
14944 \begin_inset Flex Code
14947 \begin_layout Plain Layout
14954 \begin_inset Flex Code
14957 \begin_layout Plain Layout
14963 , much as in \SpecialChar LaTeX
14965 These counters must all be declared separately.
14966 \begin_inset Newline newline
14970 \begin_inset CommandInset ref
14972 reference "subsec:Counters"
14976 for details on counters.
14979 \begin_layout Description
14980 \begin_inset Flex Code
14983 \begin_layout Plain Layout
14989 The font used for the label.
14991 \begin_inset CommandInset ref
14993 reference "subsec:Font-description"
15000 \begin_layout Description
15001 \begin_inset Flex Code
15004 \begin_layout Plain Layout
15011 \begin_inset Flex Code
15014 \begin_layout Plain Layout
15020 ] Text that indicates how far a label should be indented.
15023 \begin_layout Description
15024 \begin_inset Flex Code
15027 \begin_layout Plain Layout
15034 \begin_inset Flex Code
15037 \begin_layout Plain Layout
15043 ] Text that indicates the amount of horizontal space between the label and
15045 Only used for labels that are not above the text body.
15048 \begin_layout Description
15049 \begin_inset Flex Code
15052 \begin_layout Plain Layout
15059 \begin_inset Flex Code
15062 \begin_layout Plain Layout
15068 ] The string used for the label.
15070 \begin_inset Flex Code
15073 \begin_layout Plain Layout
15079 is set, this string can be contain the special formatting commands described
15081 \begin_inset CommandInset ref
15083 reference "subsec:Counters"
15090 \begin_layout Description
15091 \begin_inset Flex Code
15094 \begin_layout Plain Layout
15095 LabelStringAppendix
15101 \begin_inset Flex Code
15104 \begin_layout Plain Layout
15110 ] This is used inside the appendix instead of
15111 \begin_inset Newline newline
15115 \begin_inset Flex Code
15118 \begin_layout Plain Layout
15126 \begin_inset Flex Code
15129 \begin_layout Plain Layout
15136 \begin_inset Newline newline
15140 \begin_inset Flex Code
15143 \begin_layout Plain Layout
15144 LabelStringAppendix
15152 \begin_layout Description
15153 \begin_inset Flex Code
15156 \begin_layout Plain Layout
15162 [FIXME] (Used only with XML-type formats.)
15165 \begin_layout Description
15166 \begin_inset Flex Code
15169 \begin_layout Plain Layout
15176 \begin_inset Flex Code
15179 \begin_layout Plain Layout
15184 , Manual, Static, Above,
15185 \begin_inset Newline newline
15188 Centered, Sensitive, Enumerate,
15189 \begin_inset Newline newline
15192 Itemize, Bibliography
15201 \begin_layout Description
15202 \begin_inset Flex Code
15205 \begin_layout Plain Layout
15211 means the label is the very first word (up to the first real blank).
15212 Use protected spaces if you want more than one word as the label.
15216 \begin_layout Description
15217 \begin_inset Flex Code
15220 \begin_layout Plain Layout
15226 means the label is simply what is declared as
15227 \begin_inset Flex Code
15230 \begin_layout Plain Layout
15237 This will be displayed
15238 \begin_inset Quotes eld
15242 \begin_inset Quotes erd
15245 , at the beginning of the paragraph.
15247 \begin_inset Flex Code
15250 \begin_layout Plain Layout
15257 \begin_inset Flex Code
15260 \begin_layout Plain Layout
15266 , then it will be displayed only in the first paragraph of any sequence
15267 of paragraphs with the same
15268 \begin_inset Flex Code
15271 \begin_layout Plain Layout
15280 \begin_layout Description
15281 \begin_inset Flex Code
15284 \begin_layout Plain Layout
15291 \begin_inset space ~
15295 \begin_inset space ~
15299 \begin_inset Flex Code
15302 \begin_layout Plain Layout
15308 are special cases of
15309 \begin_inset Flex Code
15312 \begin_layout Plain Layout
15319 The label will be printed above the paragraph either at the beginning of
15320 the line or centered.
15323 \begin_layout Description
15324 \begin_inset Flex Code
15327 \begin_layout Plain Layout
15333 is a special case for the caption-labels
15334 \begin_inset Quotes eld
15338 \begin_inset Quotes erd
15342 \begin_inset Quotes eld
15346 \begin_inset Quotes erd
15350 \begin_inset Newline newline
15354 \begin_inset Flex Code
15357 \begin_layout Plain Layout
15363 means the (hardcoded) label string depends on the kind of float: It is
15364 hardcoded to be `FloatType N', where N is the value of the counter associated
15366 For the case that a caption is inserted outside of a float the
15367 \begin_inset Flex Code
15370 \begin_layout Plain Layout
15377 \begin_inset Quotes eld
15381 \begin_inset Quotes erd
15387 \begin_layout Description
15388 \begin_inset Flex Code
15391 \begin_layout Plain Layout
15397 produces the usual sort of enumeration labels.
15398 The number type needs to be set in the
15403 \begin_inset CommandInset ref
15405 reference "subsec:Counters"
15412 \begin_layout Description
15413 \begin_inset Flex Code
15416 \begin_layout Plain Layout
15422 produces various bullets at the different levels.
15423 The bullet types displayed can be set via
15424 \begin_inset Flex Noun
15427 \begin_layout Plain Layout
15428 Document\SpecialChar menuseparator
15429 Settings\SpecialChar menuseparator
15438 \begin_layout Description
15439 \begin_inset Flex Code
15442 \begin_layout Plain Layout
15448 should be used only with
15449 \begin_inset Flex Code
15452 \begin_layout Plain Layout
15453 LatexType BibEnvironment
15462 \begin_layout Description
15463 \begin_inset Flex Code
15466 \begin_layout Plain Layout
15472 Note that this will completely override any prior
15473 \begin_inset Flex Code
15476 \begin_layout Plain Layout
15482 declaration for this style.
15484 \begin_inset Quotes eld
15488 \begin_inset Flex Code
15491 \begin_layout Plain Layout
15498 \begin_inset Quotes erd
15503 \begin_inset CommandInset ref
15505 reference "subsec:I18n"
15509 for details on its use.
15512 \begin_layout Description
15513 \begin_inset Flex Code
15516 \begin_layout Plain Layout
15523 \begin_inset Flex Code
15526 \begin_layout Plain Layout
15532 ] The name of the corresponding \SpecialChar LaTeX
15534 Either the environment or command name.
15537 \begin_layout Description
15538 \begin_inset Flex Code
15541 \begin_layout Plain Layout
15548 \begin_inset Flex Code
15551 \begin_layout Plain Layout
15557 ] An optional parameter for the corresponding
15558 \begin_inset Flex Code
15561 \begin_layout Plain Layout
15568 This parameter cannot be changed from within \SpecialChar LyX
15570 \begin_inset Flex Code
15573 \begin_layout Plain Layout
15579 for customizable parameters).
15580 This will be output as is after all \SpecialChar LaTeX
15582 \begin_inset Flex Code
15585 \begin_layout Plain Layout
15594 \begin_layout Description
15595 \begin_inset Flex Code
15598 \begin_layout Plain Layout
15605 \begin_inset Flex Code
15608 \begin_layout Plain Layout
15613 , Command, Environment, Item_Environment,
15614 \begin_inset Newline newline
15617 List_Environment, Bib_Environment
15622 ] How the style should be translated into \SpecialChar LaTeX
15627 \begin_layout Plain Layout
15628 \begin_inset Flex Code
15631 \begin_layout Plain Layout
15637 is perhaps a bit misleading, since these rules apply to SGML classes, too.
15638 Visit the SGML class files for specific examples.
15647 \begin_layout Description
15648 \begin_inset Flex Code
15651 \begin_layout Plain Layout
15657 means nothing special.
15660 \begin_layout Description
15661 \begin_inset Flex Code
15664 \begin_layout Plain Layout
15671 \begin_inset Flex Code
15674 \begin_layout Plain Layout
15681 {\SpecialChar ldots
15690 \begin_layout Description
15691 \begin_inset Flex Code
15694 \begin_layout Plain Layout
15701 \begin_inset Flex Code
15704 \begin_layout Plain Layout
15711 }\SpecialChar ldots
15727 \begin_layout Description
15728 \begin_inset Flex Code
15731 \begin_layout Plain Layout
15738 \begin_inset Flex Code
15741 \begin_layout Plain Layout
15748 \begin_inset Flex Code
15751 \begin_layout Plain Layout
15759 is generated for each paragraph of this environment.
15763 \begin_layout Description
15764 \begin_inset Flex Code
15767 \begin_layout Plain Layout
15774 \begin_inset Flex Code
15777 \begin_layout Plain Layout
15784 \begin_inset Newline newline
15788 \begin_inset Flex Code
15791 \begin_layout Plain Layout
15797 is passed as an argument to the environment.
15798 \begin_inset Newline newline
15802 \begin_inset Flex Code
15805 \begin_layout Plain Layout
15811 can be defined in the
15812 \begin_inset Flex Noun
15815 \begin_layout Plain Layout
15816 Edit\SpecialChar menuseparator
15818 \begin_inset space ~
15829 \begin_layout Description
15830 \begin_inset Flex Code
15833 \begin_layout Plain Layout
15840 \begin_inset Flex Code
15843 \begin_layout Plain Layout
15849 but adds the necessary mandatory argument (the longest label) to the begin
15850 statement of the bibliography environment:
15851 \begin_inset Newline newline
15855 \begin_inset Flex Code
15858 \begin_layout Plain Layout
15861 begin{thebibliography}{99}
15867 It is therefore only useful for bibliography environments.
15868 The default longest label
15869 \begin_inset Quotes eld
15873 \begin_inset Quotes erd
15876 can be changed by the user in the paragraph settings of a bibliography
15880 \begin_layout Standard
15881 Putting the last few things together, the \SpecialChar LaTeX
15882 output will be either:
15885 \begin_layout LyX-Code
15888 LatexName[LatexParam]{\SpecialChar ldots
15892 \begin_layout Standard
15896 \begin_layout LyX-Code
15899 begin{LatexName}[LatexParam] \SpecialChar ldots
15905 \begin_layout Standard
15906 depending upon the \SpecialChar LaTeX
15911 \begin_layout Description
15912 \begin_inset Flex Code
15915 \begin_layout Plain Layout
15922 \begin_inset Flex Code
15925 \begin_layout Plain Layout
15931 ] A string that is put at the beginning of the style content.
15932 A line break in the output can be indicated by
15933 \begin_inset Flex Code
15936 \begin_layout Plain Layout
15945 \begin_layout Description
15946 \begin_inset Flex Code
15949 \begin_layout Plain Layout
15956 \begin_inset Flex Code
15959 \begin_layout Plain Layout
15965 ] If you put styles into environments, the different
15966 \begin_inset Flex Code
15969 \begin_layout Plain Layout
15975 are not simply added, but added with a factor
15976 \begin_inset Formula $\frac{4}{\mathrm{depth}+4}$
15980 Note that this parameter is also used when
15981 \begin_inset Flex Code
15984 \begin_layout Plain Layout
15991 \begin_inset Flex Code
15994 \begin_layout Plain Layout
16001 \begin_inset Flex Code
16004 \begin_layout Plain Layout
16011 Then it is added to the manual or dynamic margin.
16012 \begin_inset Newline newline
16016 \begin_inset Quotes eld
16020 \begin_inset Flex Code
16023 \begin_layout Plain Layout
16030 \begin_inset Quotes erd
16033 means that the paragraph is indented with the width of
16034 \begin_inset Quotes eld
16038 \begin_inset Flex Code
16041 \begin_layout Plain Layout
16048 \begin_inset Quotes erd
16051 in the normal font.
16052 You can get a negative width by prefixing the string with
16053 \begin_inset Quotes eld
16057 \begin_inset Flex Code
16060 \begin_layout Plain Layout
16067 \begin_inset Quotes erd
16071 This way was chosen so that the look is the same with each used screen
16075 \begin_layout Description
16076 \begin_inset Flex Code
16079 \begin_layout Plain Layout
16086 \begin_inset Flex Code
16089 \begin_layout Plain Layout
16094 , Manual, Dynamic, First_Dynamic, Right_Address_Box
16100 \begin_inset Newline newline
16103 The kind of margin that the style has on the left side.
16107 \begin_layout Description
16108 \begin_inset Flex Code
16111 \begin_layout Plain Layout
16117 just means a fixed margin.
16120 \begin_layout Description
16121 \begin_inset Flex Code
16124 \begin_layout Plain Layout
16130 means that the left margin depends on the string entered in the
16131 \begin_inset Flex Noun
16134 \begin_layout Plain Layout
16135 Edit\SpecialChar menuseparator
16137 \begin_inset space ~
16146 This is used to typeset nice lists without tabulators.
16149 \begin_layout Description
16150 \begin_inset Flex Code
16153 \begin_layout Plain Layout
16159 means that the margin depends on the size of the label.
16160 This is used for automatic enumerated headlines.
16161 It is obvious that the headline
16162 \begin_inset Quotes eld
16165 5.4.3.2.1 Very long headline
16166 \begin_inset Quotes erd
16169 must have a wider left margin (as wide as
16170 \begin_inset Quotes eld
16174 \begin_inset Quotes erd
16177 plus the space) than
16178 \begin_inset Quotes eld
16181 3.2 Very long headline
16182 \begin_inset Quotes erd
16186 \begin_inset Quotes eld
16190 \begin_inset Quotes erd
16193 are not able to do this.
16196 \begin_layout Description
16197 \begin_inset Flex Code
16200 \begin_layout Plain Layout
16206 is similar, but only the very first row of the paragraph is dynamic, while
16207 the others are static; this is used, for example, for descriptions.
16210 \begin_layout Description
16211 \begin_inset Flex Code
16214 \begin_layout Plain Layout
16220 means the margin is chosen in a way that the longest row of this paragraph
16221 fits to the right margin.
16222 This is used to typeset an address on the right edge of the page.
16226 \begin_layout Description
16227 \begin_inset Flex Code
16230 \begin_layout Plain Layout
16237 \begin_inset Flex Code
16240 \begin_layout Plain Layout
16249 \begin_inset space \thinspace{}
16253 \begin_inset Flex Code
16256 \begin_layout Plain Layout
16262 ] Whether fragile commands in this style should be
16263 \begin_inset Flex Code
16266 \begin_layout Plain Layout
16279 whether this command should itself be protected.)
16280 \change_inserted -712698321 1523696949
16284 \begin_layout Description
16286 \change_inserted -712698321 1552395557
16287 \begin_inset Flex Code
16290 \begin_layout Plain Layout
16292 \change_inserted -712698321 1523696950
16301 \begin_inset Flex Code
16304 \begin_layout Plain Layout
16306 \change_inserted -712698321 1523696950
16317 \begin_inset space \thinspace{}
16321 \begin_inset Flex Code
16324 \begin_layout Plain Layout
16326 \change_inserted -712698321 1523696950
16334 ] This causes macros that contain this layout to be protected with
16335 \begin_inset Flex Code
16338 \begin_layout Plain Layout
16340 \change_inserted -712698321 1523696950
16355 ) if necessary and thus allows (some) verbatim stuff in macros.
16358 \begin_layout Description
16360 \change_inserted -712698321 1552395844
16361 \begin_inset Flex Code
16364 \begin_layout Plain Layout
16366 \change_inserted -712698321 1552395561
16375 \begin_inset Flex Code
16378 \begin_layout Plain Layout
16380 \change_inserted -712698321 1552395557
16391 \begin_inset space \thinspace{}
16395 \begin_inset Flex Code
16398 \begin_layout Plain Layout
16400 \change_inserted -712698321 1552395557
16408 ] Whether specific commands in this style (such as
16409 \begin_inset Flex Code
16412 \begin_layout Plain Layout
16414 \change_inserted -712698321 1552395655
16425 \begin_inset Flex Code
16428 \begin_layout Plain Layout
16430 \change_inserted -712698321 1552395661
16440 ) should be protected in an
16441 \begin_inset Flex Code
16444 \begin_layout Plain Layout
16446 \change_inserted -712698321 1552395631
16457 This is particularly needed for styles that draw on
16465 commands which parse their content in complex ways.
16470 \begin_layout Description
16471 \begin_inset Flex Code
16474 \begin_layout Plain Layout
16481 \begin_inset Flex Code
16484 \begin_layout Plain Layout
16491 \begin_inset space \thinspace{}
16495 \begin_inset Flex Code
16498 \begin_layout Plain Layout
16506 ] Whether newlines are translated into \SpecialChar LaTeX
16508 \begin_inset Flex Code
16511 \begin_layout Plain Layout
16522 The translation can be switched off to allow more comfortable \SpecialChar LaTeX
16524 inside \SpecialChar LyX
16528 \begin_layout Description
16529 \begin_inset Flex Code
16532 \begin_layout Plain Layout
16539 \begin_inset Flex Code
16542 \begin_layout Plain Layout
16551 \begin_inset space \thinspace{}
16555 \begin_inset Flex Code
16558 \begin_layout Plain Layout
16564 ] If set to true, and if
16565 \begin_inset Flex Code
16568 \begin_layout Plain Layout
16575 \begin_inset Flex Code
16578 \begin_layout Plain Layout
16584 ) paragraphs are being indented, then the indentation of such a paragraph
16585 following one of this type will be suppressed.
16586 (So this will not affect the display of non-default paragraphs.)
16589 \begin_layout Description
16590 \begin_inset Flex Code
16593 \begin_layout Plain Layout
16600 \begin_inset Flex Code
16603 \begin_layout Plain Layout
16609 ] Name of a style that has replaced this style.
16610 This is used to rename a style, while keeping backward compatibility.
16613 \begin_layout Description
16614 \begin_inset Flex Code
16617 \begin_layout Plain Layout
16624 \begin_inset Flex Code
16627 \begin_layout Plain Layout
16634 \begin_inset space \thinspace{}
16638 \begin_inset Flex Code
16641 \begin_layout Plain Layout
16647 ] Determines whether consecutive paragraphs of the same type are treated
16648 as belonging together.
16649 This has the effect that the
16650 \begin_inset Flex Code
16653 \begin_layout Plain Layout
16659 is only printed once before such a group.
16660 By default, this is true for
16661 \begin_inset Flex Code
16664 \begin_layout Plain Layout
16671 \begin_inset Flex Code
16674 \begin_layout Plain Layout
16681 \begin_inset Flex Code
16684 \begin_layout Plain Layout
16690 and false for all other types.
16693 \begin_layout Description
16694 \begin_inset Flex Code
16697 \begin_layout Plain Layout
16704 \begin_inset Flex Code
16707 \begin_layout Plain Layout
16716 \begin_inset space \thinspace{}
16720 \begin_inset Flex Code
16723 \begin_layout Plain Layout
16729 ] Indicates that paragraphs will not be separated by an empty line in \SpecialChar LaTeX
16731 but only by a line break; together with
16732 \begin_inset Flex Code
16735 \begin_layout Plain Layout
16741 , this allows to emulate a plain text editor (like the ERT inset).
16744 \begin_layout Description
16745 \begin_inset Flex Code
16748 \begin_layout Plain Layout
16755 \begin_inset Flex Code
16758 \begin_layout Plain Layout
16764 ] The indent of the very first line of a paragraph.
16766 \begin_inset Newline newline
16770 \begin_inset Flex Code
16773 \begin_layout Plain Layout
16779 will be fixed for a certain style.
16780 The exception is the default style, since the indentation for these paragraphs
16781 can be prohibited with
16782 \begin_inset Flex Code
16785 \begin_layout Plain Layout
16793 \begin_inset Flex Code
16796 \begin_layout Plain Layout
16802 style paragraphs inside environments use the
16803 \begin_inset Flex Code
16806 \begin_layout Plain Layout
16812 of the environment, not their native one.
16814 \begin_inset Flex Code
16817 \begin_layout Plain Layout
16823 paragraphs inside an enumeration are not indented.
16826 \begin_layout Description
16827 \begin_inset Flex Code
16830 \begin_layout Plain Layout
16837 \begin_inset Flex Code
16840 \begin_layout Plain Layout
16846 ] The vertical space between two paragraphs of this style.
16849 \begin_layout Description
16850 \begin_inset Flex Code
16853 \begin_layout Plain Layout
16860 \begin_inset Flex Code
16863 \begin_layout Plain Layout
16870 allows the user to choose either
16871 \begin_inset Quotes eld
16875 \begin_inset Quotes erd
16879 \begin_inset Quotes eld
16883 \begin_inset Quotes erd
16886 to separate paragraphs.
16888 \begin_inset Quotes eld
16892 \begin_inset Quotes erd
16896 \begin_inset Flex Code
16899 \begin_layout Plain Layout
16907 \begin_inset Quotes eld
16911 \begin_inset Quotes erd
16915 \begin_inset Flex Code
16918 \begin_layout Plain Layout
16924 is ignored and all paragraphs are separated by the
16925 \begin_inset Flex Code
16928 \begin_layout Plain Layout
16935 The vertical space is calculated with
16936 \begin_inset Flex Code
16939 \begin_layout Plain Layout
16941 \begin_inset space ~
16950 \begin_inset Flex Code
16953 \begin_layout Plain Layout
16959 is the height of a row with the normal font.
16960 This way, the look stays the same with different screen fonts.
16963 \begin_layout Description
16964 \begin_inset Flex Code
16967 \begin_layout Plain Layout
16974 \begin_inset Flex Code
16977 \begin_layout Plain Layout
16986 \begin_inset space \thinspace{}
16990 \begin_inset Flex Code
16993 \begin_layout Plain Layout
16999 ] Whether the contents of this paragraph should be output in raw form, meaning
17000 without special translations that \SpecialChar LaTeX
17004 \begin_layout Description
17005 \begin_inset Flex Code
17008 \begin_layout Plain Layout
17015 \begin_inset Flex Code
17018 \begin_layout Plain Layout
17028 Defines individual characters that should be output in raw form, meaning
17029 without special translations that \SpecialChar LaTeX
17033 \begin_layout Description
17034 \begin_inset Flex Code
17037 \begin_layout Plain Layout
17043 Information to be included in the \SpecialChar LaTeX
17044 preamble when this style is used.
17045 Used to define macros, load packages, etc., required by this particular
17048 \begin_inset Quotes eld
17052 \begin_inset Flex Code
17055 \begin_layout Plain Layout
17062 \begin_inset Quotes erd
17068 \begin_layout Description
17069 \begin_inset Flex Code
17072 \begin_layout Plain Layout
17079 \begin_inset Flex Code
17082 \begin_layout Plain Layout
17088 ] The prefix to use when creating labels referring to paragraphs of this
17090 This allows the use of formatted references.
17093 \begin_layout Description
17094 \begin_inset Flex Code
17097 \begin_layout Plain Layout
17104 \begin_inset Flex Code
17107 \begin_layout Plain Layout
17113 ] Whether the style requires the feature
17114 \begin_inset Flex Code
17117 \begin_layout Plain Layout
17124 \begin_inset CommandInset ref
17126 reference "chap:List-of-functions"
17130 for the list of features).
17131 If you require a package with specific options, you can additionally use
17133 \begin_inset Flex Code
17136 \begin_layout Plain Layout
17142 as a general text class parameter (see
17143 \begin_inset CommandInset ref
17145 reference "subsec:General-text-class"
17152 \begin_layout Description
17153 \begin_inset Flex Code
17156 \begin_layout Plain Layout
17163 \begin_inset Flex Code
17166 \begin_layout Plain Layout
17175 \begin_inset Flex Code
17178 \begin_layout Plain Layout
17184 ] Resets the \SpecialChar LaTeX
17185 arguments of this style (as defined via the
17186 \begin_inset Flex Code
17189 \begin_layout Plain Layout
17196 This is useful if you have copied a style via
17197 \begin_inset Flex Code
17200 \begin_layout Plain Layout
17206 , but you do not want to inherit its (required and optional) arguments.
17209 \begin_layout Description
17210 \begin_inset Flex Code
17213 \begin_layout Plain Layout
17220 \begin_inset Flex Code
17223 \begin_layout Plain Layout
17232 \begin_inset Flex Code
17235 \begin_layout Plain Layout
17241 ] Resumes a counter that is usually reset at each new sequence of layouts.
17242 This is currently only useful when
17243 \begin_inset Flex Code
17246 \begin_layout Plain Layout
17253 \begin_inset Flex Code
17256 \begin_layout Plain Layout
17265 \begin_layout Description
17266 \begin_inset Flex Code
17269 \begin_layout Plain Layout
17276 \begin_inset Flex Code
17279 \begin_layout Plain Layout
17285 ] A string that is put at the end of the layout content.
17286 A line break in the output can be indicated by
17287 \begin_inset Flex Code
17290 \begin_layout Plain Layout
17299 \begin_layout Description
17300 \begin_inset Flex Code
17303 \begin_layout Plain Layout
17310 \begin_inset Flex Code
17313 \begin_layout Plain Layout
17320 \begin_inset Flex Code
17323 \begin_layout Plain Layout
17332 \begin_layout Description
17333 \begin_inset Flex Code
17336 \begin_layout Plain Layout
17343 \begin_inset Flex Code
17346 \begin_layout Plain Layout
17355 \begin_inset Flex Code
17358 \begin_layout Plain Layout
17365 \begin_inset Flex Code
17368 \begin_layout Plain Layout
17375 \begin_inset Flex Code
17378 \begin_layout Plain Layout
17380 \begin_inset space ~
17388 ] This defines what the default spacing should be in the style.
17390 \begin_inset Flex Code
17393 \begin_layout Plain Layout
17400 \begin_inset Flex Code
17403 \begin_layout Plain Layout
17410 \begin_inset Flex Code
17413 \begin_layout Plain Layout
17419 correspond respectively to a multiplier value of 1, 1.25 and 1.667.
17420 If you specify the argument
17421 \begin_inset Flex Code
17424 \begin_layout Plain Layout
17430 , then you must also provide a value argument which will be the actual multiplie
17432 Note that, contrary to other parameters,
17433 \begin_inset Flex Code
17436 \begin_layout Plain Layout
17442 implies the generation of specific \SpecialChar LaTeX
17443 code, using the \SpecialChar LaTeX
17447 \begin_inset Flex Code
17450 \begin_layout Plain Layout
17459 \begin_layout Description
17460 \begin_inset Flex Code
17463 \begin_layout Plain Layout
17470 \begin_inset Flex Code
17473 \begin_layout Plain Layout
17480 \begin_inset space \thinspace{}
17484 \begin_inset Flex Code
17487 \begin_layout Plain Layout
17495 ] Allow spell-checking paragraphs of this style.
17499 \begin_layout Description
17500 \begin_inset Flex Code
17503 \begin_layout Plain Layout
17505 \change_deleted 731793113 1604355211
17507 \change_inserted 731793113 1604355212
17516 \begin_inset Flex Code
17519 \begin_layout Plain Layout
17528 \begin_inset Flex Code
17531 \begin_layout Plain Layout
17538 \change_deleted 731793113 1604355214
17540 \change_inserted 731793113 1604355216
17543 counter of a given counter at the beginning of a new sequence of layouts.
17544 This is currently only useful when
17545 \begin_inset Flex Code
17548 \begin_layout Plain Layout
17555 \begin_inset Flex Code
17558 \begin_layout Plain Layout
17567 \begin_layout Description
17568 \begin_inset Flex Code
17571 \begin_layout Plain Layout
17577 The font used for the text body .
17579 \begin_inset CommandInset ref
17581 reference "subsec:Font-description"
17588 \begin_layout Description
17589 \begin_inset Flex Code
17592 \begin_layout Plain Layout
17601 \begin_inset Flex Code
17604 \begin_layout Plain Layout
17614 The level of the style in the table of contents.
17615 This is used for automatic numbering of section headings.
17618 \begin_layout Description
17619 \begin_inset Flex Code
17622 \begin_layout Plain Layout
17631 \begin_inset Flex Code
17634 \begin_layout Plain Layout
17645 \begin_inset Flex Code
17648 \begin_layout Plain Layout
17655 \begin_inset Flex Code
17658 \begin_layout Plain Layout
17664 ] This tag determines whether the first line indentation of this paragraph
17665 can be toggled via the Paragraph settings dialog.
17669 \begin_inset Flex Code
17672 \begin_layout Plain Layout
17682 is set, indentation can be toggled if the document settings use
17683 \begin_inset Quotes eld
17687 \begin_inset Quotes erd
17690 paragraph style, with
17691 \begin_inset Flex Code
17694 \begin_layout Plain Layout
17700 , indentation can always be toggled, notwithstanding the document settings,
17702 \begin_inset Flex Code
17705 \begin_layout Plain Layout
17711 , indentation can never be toggled.
17714 \begin_layout Description
17715 \begin_inset Flex Code
17718 \begin_layout Plain Layout
17725 \begin_inset Flex Code
17728 \begin_layout Plain Layout
17734 ] The vertical space with which the very first of a chain of paragraphs
17735 with this style is separated from the previous paragraph.
17736 If the previous paragraph has another style, the separations are not simply
17737 added, but the maximum is taken.
17740 \begin_layout Subsection
17741 \begin_inset CommandInset label
17747 Internationalization of Paragraph Styles
17750 \begin_layout Standard
17752 has long supported internationalization of layout information, but, until
17753 version 2.0, this applied only to the user interface and not to, say, PDF
17755 Thus, French authors were forced to resort to ugly hacks if they wanted
17760 1' instead of `Theorem 1'.
17761 Thanks to Georg Baum, that is no longer the case.
17764 \begin_layout Standard
17766 \begin_inset Flex Code
17769 \begin_layout Plain Layout
17775 defines text that is to appear in the typeset document, it may use
17776 \begin_inset Flex Code
17779 \begin_layout Plain Layout
17786 \begin_inset Flex Code
17789 \begin_layout Plain Layout
17795 to support non-English and even multi-language documents correctly.
17796 The following excerpt (from the
17797 \begin_inset Flex Code
17800 \begin_layout Plain Layout
17806 file) shows how this works:
17809 \begin_layout LyX-Code
17814 \begin_layout LyX-Code
17817 theoremstyle{remark}
17820 \begin_layout LyX-Code
17823 newtheorem{claim}[thm]{
17830 \begin_layout LyX-Code
17834 \begin_layout LyX-Code
17838 \begin_layout LyX-Code
17843 claimname}{_(Claim)}
17846 \begin_layout LyX-Code
17850 \begin_layout LyX-Code
17854 \begin_layout LyX-Code
17863 claimname}{_(Claim)}}
17866 \begin_layout LyX-Code
17871 \begin_layout Standard
17872 In principle, any legal \SpecialChar LaTeX
17874 \begin_inset Flex Code
17877 \begin_layout Plain Layout
17884 \begin_inset Flex Code
17887 \begin_layout Plain Layout
17893 tags, but in practice they will typically look as they do here.
17894 The key to correct translation of the typeset text is the definition of
17895 the \SpecialChar LaTeX
17897 \begin_inset Flex Code
17900 \begin_layout Plain Layout
17909 \begin_inset Flex Code
17912 \begin_layout Plain Layout
17924 \begin_layout Standard
17926 \begin_inset Flex Code
17929 \begin_layout Plain Layout
17935 tag provides for internationalization based upon the overall language of
17937 The contents of the tag will be included in the preamble, just as with
17939 \begin_inset Flex Code
17942 \begin_layout Plain Layout
17949 What makes it special is the use of the
17950 \begin_inset Quotes eld
17954 \begin_inset Quotes erd
17958 \begin_inset Flex Code
17961 \begin_layout Plain Layout
17967 , which will be replaced, when \SpecialChar LyX
17968 produces \SpecialChar LaTeX
17969 output, with the translation of
17970 its argument into the document language.
17973 \begin_layout Standard
17975 \begin_inset Flex Code
17978 \begin_layout Plain Layout
17984 tag is more complex, since it is meant to provide support for multi-language
17985 documents and so offers an interface to the
17986 \begin_inset Flex Code
17989 \begin_layout Plain Layout
17996 Its contents will be added to the preamble once for each language that
17997 appears in the document.
17998 In this case, the argument to
17999 \begin_inset Flex Code
18002 \begin_layout Plain Layout
18008 will be replaced with its translation into the language in question; the
18010 \begin_inset Flex Code
18013 \begin_layout Plain Layout
18019 is replaced by the language name (as used by the babel package).
18022 \begin_layout Standard
18023 A German document that also included a French section would thus have the
18024 following in the preamble:
18027 \begin_layout LyX-Code
18036 claimname}{Affirmation}}
18037 \begin_inset Newline newline
18048 claimname}{Behauptung}}
18049 \begin_inset Newline newline
18056 claimname}{Behauptung}
18059 \begin_layout Standard
18062 \begin_inset Flex Code
18065 \begin_layout Plain Layout
18071 will then conspire to produce the correct text in the output.
18074 \begin_layout Standard
18075 One important point to note here is that the translations are provided by
18077 itself, through the file
18078 \begin_inset Flex Code
18081 \begin_layout Plain Layout
18088 This means, in effect, that
18089 \begin_inset Flex Code
18092 \begin_layout Plain Layout
18099 \begin_inset Flex Code
18102 \begin_layout Plain Layout
18108 are really only of use in layout files that are provided with \SpecialChar LyX
18110 entered in user-created layout files will not be seen by \SpecialChar LyX
18111 's internationalizatio
18112 n routines unless the
18113 \begin_inset Flex Code
18116 \begin_layout Plain Layout
18122 file is modified accordingly.
18123 That said, however, any layout created with the intention that it will
18124 be included with \SpecialChar LyX
18125 should use these tags where appropriate.
18126 Please note that the paragraph style translations provided by \SpecialChar LyX
18128 change with a minor update (e.
18129 \begin_inset space \thinspace{}
18133 \begin_inset space \space{}
18136 from version 2.1.x to 2.1.y).
18137 It is however quite likely that a major update (e.
18138 \begin_inset space \thinspace{}
18142 \begin_inset space \space{}
18145 from 2.0.x to 2.1.0) will introduce new translations or corrections.
18148 \begin_layout Subsection
18150 \begin_inset CommandInset label
18152 name "subsec:Floats"
18159 \begin_layout Standard
18160 It is necessary to define the floats (
18161 \begin_inset Flex Noun
18164 \begin_layout Plain Layout
18171 \begin_inset Flex Noun
18174 \begin_layout Plain Layout
18180 , \SpecialChar ldots
18181 ) in the text class itself.
18182 Standard floats are included in the file
18183 \begin_inset Flex Code
18186 \begin_layout Plain Layout
18192 , so you may have to do no more than add
18195 \begin_layout LyX-Code
18196 Input stdfloats.inc
18199 \begin_layout Standard
18200 to your layout file.
18201 If you want to implement a text class that proposes some other float types
18202 (like the AGU class bundled with \SpecialChar LyX
18203 ), the information below will hopefully
18207 \begin_layout Description
18208 \begin_inset Flex Code
18211 \begin_layout Plain Layout
18218 \begin_inset Flex Code
18221 \begin_layout Plain Layout
18227 =!htbpH] Allowed placement options for this float type.
18228 The value is a string of placement characters.
18229 Possible characters include:
18234 \begin_inset Quotes eld
18238 \begin_inset Quotes erd
18246 \begin_inset Quotes eld
18250 \begin_inset Quotes erd
18258 \begin_inset Quotes eld
18262 \begin_inset Quotes erd
18270 \begin_inset Quotes eld
18274 \begin_inset Quotes erd
18282 \begin_inset Quotes eld
18286 \begin_inset Quotes erd
18294 \begin_inset Quotes eld
18298 \begin_inset Quotes erd
18302 The order of the characters in the string does not matter.
18303 If no placement options are allowed, use the string
18310 \begin_layout Description
18311 \begin_inset Flex Code
18314 \begin_layout Plain Layout
18321 \begin_inset Flex Code
18324 \begin_layout Plain Layout
18333 \begin_inset space \thinspace{}
18339 \begin_inset Flex Code
18342 \begin_layout Plain Layout
18352 ] Defines whether the float allows to be rotated via the \SpecialChar LaTeX
18359 \begin_inset Flex Code
18362 \begin_layout Plain Layout
18368 if the float does not support this feature.
18371 \begin_layout Description
18372 \begin_inset Flex Code
18375 \begin_layout Plain Layout
18382 \begin_inset Flex Code
18385 \begin_layout Plain Layout
18394 \begin_inset space \thinspace{}
18400 \begin_inset Flex Code
18403 \begin_layout Plain Layout
18413 ] Defines whether the float has a starred variant that spans columns in
18414 a two column paragraph.
18416 \begin_inset Flex Code
18419 \begin_layout Plain Layout
18425 if the float does not support this feature.
18428 \begin_layout Description
18429 \begin_inset Flex Code
18432 \begin_layout Plain Layout
18439 \begin_inset Flex Code
18442 \begin_layout Plain Layout
18449 \begin_inset Quotes erd
18453 \begin_inset Quotes erd
18456 ] The file name extension of an auxiliary file for the list of figures (or
18459 writes the captions to this file.
18462 \begin_layout Description
18463 \begin_inset Flex Code
18466 \begin_layout Plain Layout
18473 \begin_inset Flex Code
18476 \begin_layout Plain Layout
18483 \begin_inset Quotes erd
18487 \begin_inset Quotes erd
18490 ] The string that will be used in the menus and also for the caption.
18491 This is translated to the current language if babel is used.
18494 \begin_layout Description
18495 \begin_inset Flex Code
18498 \begin_layout Plain Layout
18504 These tags control the XHTML output.
18506 \begin_inset CommandInset ref
18508 reference "sec:Tags-for-XHTML"
18515 \begin_layout Description
18516 \begin_inset Flex Code
18519 \begin_layout Plain Layout
18528 \begin_inset Flex Code
18531 \begin_layout Plain Layout
18540 \begin_inset space \thinspace{}
18544 \begin_inset Flex Code
18547 \begin_layout Plain Layout
18553 ] Indicates whether the float is already defined in the document class or
18554 if instead the \SpecialChar LaTeX
18556 \begin_inset Flex Code
18559 \begin_layout Plain Layout
18565 needs to be loaded to define it on-the-fly.
18567 \begin_inset Flex Code
18570 \begin_layout Plain Layout
18577 \begin_inset Flex Code
18580 \begin_layout Plain Layout
18587 It should be set to
18588 \begin_inset Flex Code
18591 \begin_layout Plain Layout
18597 if the float is already defined by the \SpecialChar LaTeX
18601 \begin_layout Description
18602 \begin_inset Flex Code
18605 \begin_layout Plain Layout
18612 \begin_inset Flex Code
18615 \begin_layout Plain Layout
18622 \begin_inset Quotes erd
18626 \begin_inset Quotes erd
18629 ] The command used to generate a list of floats of this type; the leading
18638 \begin_inset Flex Code
18641 \begin_layout Plain Layout
18647 is false, since there is no standard way to generate this command.
18649 \begin_inset Flex Code
18652 \begin_layout Plain Layout
18658 is true, since in that case there is a standard way to define the command.
18661 \begin_layout Description
18662 \begin_inset Flex Code
18665 \begin_layout Plain Layout
18672 \begin_inset Flex Code
18675 \begin_layout Plain Layout
18682 \begin_inset Quotes erd
18686 \begin_inset Quotes erd
18689 ] A title for a list of floats of this kind (list of figures, tables, or
18691 It is used for the screen label within \SpecialChar LyX
18692 , it is used by \SpecialChar LaTeX
18694 it is used as the title in the XHTML output.
18695 It will be translated to the document language.
18698 \begin_layout Description
18699 \begin_inset Flex Code
18702 \begin_layout Plain Layout
18709 \begin_inset Flex Code
18712 \begin_layout Plain Layout
18719 \begin_inset Quotes erd
18723 \begin_inset Quotes erd
18726 ] This (optional) argument determines whether floats of this class will
18727 be numbered within some sectional unit of the document.
18729 \begin_inset Flex Code
18732 \begin_layout Plain Layout
18739 \begin_inset Quotes eld
18743 \begin_inset Flex Code
18746 \begin_layout Plain Layout
18753 \begin_inset Quotes erd
18756 , the floats will be numbered within chapters.
18760 \begin_layout Description
18761 \begin_inset Flex Code
18764 \begin_layout Plain Layout
18771 \begin_inset Flex Code
18774 \begin_layout Plain Layout
18781 \begin_inset Quotes erd
18785 \begin_inset Quotes erd
18788 ] The default placement for the given class of floats.
18789 The string should be as in standard \SpecialChar LaTeX
18791 \begin_inset Flex Code
18794 \begin_layout Plain Layout
18801 \begin_inset Flex Code
18804 \begin_layout Plain Layout
18811 \begin_inset Flex Code
18814 \begin_layout Plain Layout
18821 \begin_inset Flex Code
18824 \begin_layout Plain Layout
18830 for top, bottom, page, and here, respectively.
18834 \begin_layout Plain Layout
18835 Note that the order of these letters in the string is irrelevant, like in
18842 On top of that there is a new type,
18843 \begin_inset Flex Code
18846 \begin_layout Plain Layout
18852 , which does not really correspond to a float, since it means: put it
18853 \begin_inset Quotes eld
18857 \begin_inset Quotes erd
18861 Note however that the
18862 \begin_inset Flex Code
18865 \begin_layout Plain Layout
18871 specifier is special and, because of implementation details, cannot be
18872 used in non-built in float types.
18873 If you do not understand what this means, just use
18874 \begin_inset Quotes eld
18878 \begin_inset Flex Code
18881 \begin_layout Plain Layout
18888 \begin_inset Quotes erd
18894 \begin_layout Description
18895 \begin_inset Flex Code
18898 \begin_layout Plain Layout
18905 \begin_inset Flex Code
18908 \begin_layout Plain Layout
18914 ] The prefix to use when creating labels referring to floats of this type.
18915 This allows the use of formatted references.
18916 Note that you can remove any
18917 \begin_inset Flex Code
18920 \begin_layout Plain Layout
18926 set by a copied style by using the special value
18927 \begin_inset Quotes eld
18931 \begin_inset Quotes erd
18934 , which must be all caps.
18935 \change_inserted -712698321 1565605014
18939 \begin_layout Description
18941 \change_inserted -712698321 1565605014
18942 \begin_inset Flex Code
18945 \begin_layout Plain Layout
18947 \change_inserted -712698321 1565605014
18956 \begin_inset Flex Code
18959 \begin_layout Plain Layout
18961 \change_inserted -712698321 1565605014
18969 ] As with paragraph styles, see
18970 \begin_inset CommandInset ref
18972 reference "subsec:Paragraph-Styles"
18981 \begin_layout Description
18982 \begin_inset Flex Code
18985 \begin_layout Plain Layout
18992 \begin_inset Flex Code
18995 \begin_layout Plain Layout
19002 \begin_inset Quotes erd
19006 \begin_inset Quotes erd
19009 ] The style used when defining the float using
19010 \begin_inset Flex Code
19013 \begin_layout Plain Layout
19024 \begin_layout Description
19025 \begin_inset Flex Code
19028 \begin_layout Plain Layout
19035 \begin_inset Flex Code
19038 \begin_layout Plain Layout
19045 \begin_inset Quotes erd
19049 \begin_inset Quotes erd
19053 \begin_inset Quotes eld
19057 \begin_inset Quotes erd
19060 of the new class of floats, like program or algorithm.
19061 After the appropriate
19062 \begin_inset Flex Code
19065 \begin_layout Plain Layout
19074 \begin_inset Flex Code
19077 \begin_layout Plain Layout
19086 \begin_inset Flex Code
19089 \begin_layout Plain Layout
19100 \begin_layout Description
19101 \begin_inset Flex Code
19104 \begin_layout Plain Layout
19111 \begin_inset Flex Code
19114 \begin_layout Plain Layout
19121 \begin_inset space \thinspace{}
19125 \begin_inset Flex Code
19128 \begin_layout Plain Layout
19136 ] Specifies whether this float is defined using the \SpecialChar LaTeX
19138 \begin_inset Flex Code
19141 \begin_layout Plain Layout
19147 , either by the class file, another package or on-the-fly by \SpecialChar LyX
19151 \begin_layout Standard
19152 Note that defining a float with type
19153 \begin_inset Flex Code
19156 \begin_layout Plain Layout
19164 automatically defines the corresponding counter with name
19165 \begin_inset Flex Code
19168 \begin_layout Plain Layout
19179 \begin_layout Subsection
19180 Flex insets and InsetLayout
19181 \begin_inset CommandInset label
19183 name "subsec:Flex-insets-and"
19190 \begin_layout Standard
19191 Flex insets come in
19192 \change_deleted 5863208 1594239511
19194 \change_inserted 5863208 1594239512
19200 \begin_layout Itemize
19202 \begin_inset Flex Code
19205 \begin_layout Plain Layout
19211 ): These define semantic markup corresponding to such \SpecialChar LaTeX
19213 \begin_inset Flex Code
19216 \begin_layout Plain Layout
19225 \begin_inset Flex Code
19228 \begin_layout Plain Layout
19239 \begin_layout Itemize
19241 \begin_inset Flex Code
19244 \begin_layout Plain Layout
19250 ): These can be used to define custom collapsible insets, similar to \SpecialChar TeX
19252 footnote, and the like.
19253 An obvious example is an endnote inset, which is defined in the
19254 \begin_inset Flex Code
19257 \begin_layout Plain Layout
19266 \begin_layout Itemize
19268 \change_deleted 5863208 1594239528
19270 \begin_inset Flex Code
19273 \begin_layout Plain Layout
19279 ): For use with DocBook classes.
19284 \begin_layout Standard
19285 Flex insets are defined using the
19286 \begin_inset Flex Code
19289 \begin_layout Plain Layout
19295 tag, which shall be explained in a moment.
19298 \begin_layout Standard
19300 \begin_inset Flex Code
19303 \begin_layout Plain Layout
19309 tag also serves another function: It can be used to customize the general
19310 layout of many different types of insets.
19312 \begin_inset Flex Code
19315 \begin_layout Plain Layout
19321 can be used to customize the layout parameters for footnotes, marginal
19322 notes, note insets, \SpecialChar TeX
19323 code (ERT) insets, branches, listings, indexes, boxes,
19324 tables, algorithms, URLs, and captions, as well as to define Flex insets.
19327 \begin_layout Standard
19329 \begin_inset Flex Code
19332 \begin_layout Plain Layout
19338 definition must begin with a line of the form:
19341 \begin_layout LyX-Code
19345 \begin_layout Standard
19347 \begin_inset Flex Code
19350 \begin_layout Plain Layout
19356 indicates the inset whose layout is being defined, and here there are four
19360 \begin_layout Enumerate
19361 The layout for a pre-existing inset is being modified.
19362 In this case, can be
19363 \begin_inset Flex Code
19366 \begin_layout Plain Layout
19372 any one of the following:
19373 \begin_inset Flex Code
19376 \begin_layout Plain Layout
19383 \begin_inset Flex Code
19386 \begin_layout Plain Layout
19393 \begin_inset Flex Code
19396 \begin_layout Plain Layout
19403 \begin_inset Flex Code
19406 \begin_layout Plain Layout
19413 \begin_inset Flex Code
19416 \begin_layout Plain Layout
19423 \begin_inset Flex Code
19426 \begin_layout Plain Layout
19433 \begin_inset Flex Code
19436 \begin_layout Plain Layout
19443 \begin_inset Flex Code
19446 \begin_layout Plain Layout
19453 \begin_inset Flex Code
19456 \begin_layout Plain Layout
19463 \begin_inset Flex Code
19466 \begin_layout Plain Layout
19473 \begin_inset Flex Code
19476 \begin_layout Plain Layout
19483 \begin_inset Flex Code
19486 \begin_layout Plain Layout
19493 \begin_inset Flex Code
19496 \begin_layout Plain Layout
19503 \begin_inset Flex Code
19506 \begin_layout Plain Layout
19513 \begin_inset Flex Code
19516 \begin_layout Plain Layout
19523 \begin_inset Flex Code
19526 \begin_layout Plain Layout
19533 \begin_inset Flex Code
19536 \begin_layout Plain Layout
19543 \begin_inset Flex Code
19546 \begin_layout Plain Layout
19553 \begin_inset Flex Code
19556 \begin_layout Plain Layout
19563 \begin_inset Flex Code
19566 \begin_layout Plain Layout
19575 \begin_layout Enumerate
19576 The layout for a Flex inset is being defined.
19578 \begin_inset Flex Code
19581 \begin_layout Plain Layout
19587 must be of the form
19588 \begin_inset Quotes eld
19592 \begin_inset Flex Code
19595 \begin_layout Plain Layout
19602 \begin_inset Quotes erd
19606 \begin_inset Flex Code
19609 \begin_layout Plain Layout
19615 may be be any valid identifier not used by a pre-existing Flex inset.
19616 The identifier may include spaces, but in that case the whole thing must
19617 be wrapped in quotes.
19618 Note that the definition of a flex inset
19623 \begin_inset Flex Code
19626 \begin_layout Plain Layout
19632 entry, declaring which type of inset it defines.
19635 \begin_layout Enumerate
19636 The layout for user specific branch is being defined.
19638 \begin_inset Flex Code
19641 \begin_layout Plain Layout
19647 must be of the form
19648 \begin_inset Quotes eld
19652 \begin_inset Flex Code
19655 \begin_layout Plain Layout
19662 \begin_inset Quotes erd
19666 \begin_inset Flex Code
19669 \begin_layout Plain Layout
19675 may be be any valid identifier of branch defined in user's document.
19676 The identifier may include spaces, but in that case the whole thing must
19677 be wrapped in quotes.
19678 The main purpose of this feature is to allow \SpecialChar LaTeX
19679 wrapping around specific
19680 branches as user needs.
19683 \begin_layout Enumerate
19684 The layout of a user (or class) specific caption is being defined.
19686 \begin_inset Flex Code
19689 \begin_layout Plain Layout
19695 must be of the form
19696 \begin_inset Quotes eld
19700 \begin_inset Flex Code
19703 \begin_layout Plain Layout
19710 \begin_inset Quotes erd
19714 \begin_inset Flex Code
19717 \begin_layout Plain Layout
19723 specifies the name of the caption as it appears in the menu.
19724 Have a look at the standard caption (
19725 \begin_inset Flex Code
19728 \begin_layout Plain Layout
19734 ), the specific captions of the KOMA-Script classes (
19735 \begin_inset Flex Code
19738 \begin_layout Plain Layout
19745 \begin_inset Flex Code
19748 \begin_layout Plain Layout
19757 \begin_inset space ~
19761 \begin_inset Newline linebreak
19767 \begin_inset Flex Code
19770 \begin_layout Plain Layout
19776 ) for applications.
19779 \begin_layout Standard
19781 \begin_inset Flex Code
19784 \begin_layout Plain Layout
19790 definition can contain the following entries:
19793 \begin_layout Description
19794 \begin_inset Flex Code
19797 \begin_layout Plain Layout
19804 \begin_inset Flex Code
19807 \begin_layout Plain Layout
19813 =""] This inset will appear in the table of contents of the given type.
19814 An empty string disables.
19815 See also the OutlinerName and the IsTocCaption commands.
19816 This is only implemented for Flex insets.
19820 \begin_layout Description
19821 \begin_inset Flex Code
19824 \begin_layout Plain Layout
19831 \begin_inset Flex Code
19834 \begin_layout Plain Layout
19840 ] Defines argument number of a command\SpecialChar breakableslash
19841 environment associated with the current
19843 The definition must end with
19844 \begin_inset Flex Code
19847 \begin_layout Plain Layout
19855 \begin_inset CommandInset ref
19857 reference "subsec:Paragraph-Styles"
19864 \begin_layout Description
19865 \begin_inset Flex Code
19868 \begin_layout Plain Layout
19874 Preamble for changing language commands; see
19875 \begin_inset CommandInset ref
19877 reference "subsec:I18n"
19884 \begin_layout Description
19885 \begin_inset Flex Code
19888 \begin_layout Plain Layout
19895 \begin_inset Flex Code
19898 \begin_layout Plain Layout
19904 ] The color for the inset's background.
19906 \begin_inset CommandInset ref
19908 reference "chap:Names-of-colors"
19912 for a list of the available color names.
19915 \begin_layout Description
19916 \begin_inset Flex Code
19919 \begin_layout Plain Layout
19926 \begin_inset Flex Code
19929 \begin_layout Plain Layout
19938 \begin_inset space \thinspace{}
19942 \begin_inset Flex Code
19945 \begin_layout Plain Layout
19951 ] Whether to use the content of the inset as the label, when the inset is
19956 \begin_layout Description
19957 \begin_inset Flex Code
19960 \begin_layout Plain Layout
19967 \begin_inset Flex Code
19970 \begin_layout Plain Layout
19976 ] As with paragraph styles, see
19977 \begin_inset CommandInset ref
19979 reference "subsec:Paragraph-Styles"
19984 Note that you need to specify the complete type, e.
19985 \begin_inset space \thinspace{}
19989 \begin_inset space ~
19993 \begin_inset Flex Code
19996 \begin_layout Plain Layout
19997 CopyStyle Flex:<name>
20005 \begin_layout Description
20006 \begin_inset Flex Code
20009 \begin_layout Plain Layout
20016 \begin_inset Flex Code
20019 \begin_layout Plain Layout
20028 \begin_inset space \thinspace{}
20032 \begin_inset Flex Code
20035 \begin_layout Plain Layout
20041 ] Indicates whether the user may employ the Paragraph Settings dialog to
20042 customize the paragraph.
20045 \begin_layout Description
20046 \begin_inset Flex Code
20049 \begin_layout Plain Layout
20056 \begin_inset Flex Code
20059 \begin_layout Plain Layout
20066 \begin_inset Flex Code
20069 \begin_layout Plain Layout
20076 \begin_inset Flex Code
20079 \begin_layout Plain Layout
20085 , describing the rendering style used for the inset's frame and buttons.
20086 Footnotes generally use
20087 \begin_inset Flex Code
20090 \begin_layout Plain Layout
20096 , ERT insets generally
20097 \begin_inset Flex Code
20100 \begin_layout Plain Layout
20106 , and character styles
20107 \begin_inset Flex Code
20110 \begin_layout Plain Layout
20119 \begin_layout Description
20120 \begin_inset Flex Code
20123 \begin_layout Plain Layout
20130 \begin_inset Flex Code
20133 \begin_layout Plain Layout
20142 \begin_inset space \thinspace{}
20148 \begin_inset Flex Code
20151 \begin_layout Plain Layout
20160 \begin_inset Flex Code
20163 \begin_layout Plain Layout
20170 \begin_inset Flex Code
20173 \begin_layout Plain Layout
20180 Indicates whether the environment will stand on its own in the output or
20181 will appear inline with the surrounding text.
20182 If set to false, it is supposed that the \SpecialChar LaTeX
20183 environment ignores white space
20184 (including one newline character) after the
20185 \begin_inset Flex Code
20188 \begin_layout Plain Layout
20201 \begin_inset Flex Code
20204 \begin_layout Plain Layout
20218 \change_inserted 731793113 1538674858
20222 \begin_layout Description
20224 \change_inserted 731793113 1538674891
20225 \begin_inset Flex Code
20228 \begin_layout Plain Layout
20230 \change_inserted 731793113 1538674863
20242 ,1] Allow the contents of the inset to be edited externally (using whatever
20243 editor is defined for the document's output format).
20248 \begin_layout Description
20249 \begin_inset Flex Code
20252 \begin_layout Plain Layout
20258 Required at the end of the
20259 \begin_inset Flex Code
20262 \begin_layout Plain Layout
20271 \begin_layout Description
20272 \begin_inset Flex Code
20275 \begin_layout Plain Layout
20281 The font used for both the text body
20287 \begin_inset CommandInset ref
20289 reference "subsec:Font-description"
20294 Note that defining this font automatically defines the
20295 \begin_inset Flex Code
20298 \begin_layout Plain Layout
20304 to the same value, so define this first and define
20305 \begin_inset Flex Code
20308 \begin_layout Plain Layout
20314 later if you want them to be different.
20317 \begin_layout Description
20318 \begin_inset Flex Code
20321 \begin_layout Plain Layout
20322 FixedWidthPreambleEncoding
20328 \begin_inset Flex Code
20331 \begin_layout Plain Layout
20340 \begin_inset space \thinspace{}
20344 \begin_inset Flex Code
20347 \begin_layout Plain Layout
20353 ] Force a fixed width encoding for the translated contents of
20354 \begin_inset Flex Code
20357 \begin_layout Plain Layout
20364 \begin_inset Flex Code
20367 \begin_layout Plain Layout
20373 code generated by this layout.
20374 This is needed for special \SpecialChar LaTeX
20379 that do not work with variable width encodings such as
20384 This setting is ignored if fully Unicode aware \SpecialChar LaTeX
20385 backends such as Xe\SpecialChar TeX
20387 Lua\SpecialChar TeX
20391 \begin_layout Description
20392 \begin_inset Flex Code
20395 \begin_layout Plain Layout
20396 ForceLocalFontSwitch
20402 \begin_inset Flex Code
20405 \begin_layout Plain Layout
20414 \begin_inset space \thinspace{}
20418 \begin_inset Flex Code
20421 \begin_layout Plain Layout
20427 ] When using babel, always use a local font switch (
20428 \begin_inset Flex Code
20431 \begin_layout Plain Layout
20439 ), never a global one (such as
20440 \begin_inset Flex Code
20443 \begin_layout Plain Layout
20454 \begin_layout Description
20455 \begin_inset Flex Code
20458 \begin_layout Plain Layout
20465 \begin_inset Flex Code
20468 \begin_layout Plain Layout
20477 \begin_inset space \thinspace{}
20481 \begin_inset Flex Code
20484 \begin_layout Plain Layout
20491 \begin_inset Quotes eld
20495 \begin_inset Quotes erd
20498 language, leading to Left-to-Right (Latin) output, e.
20499 \begin_inset space \thinspace{}
20503 \begin_inset space \space{}
20506 in \SpecialChar TeX
20511 \begin_layout Description
20512 \begin_inset Flex Code
20515 \begin_layout Plain Layout
20522 \begin_inset Flex Code
20525 \begin_layout Plain Layout
20534 \begin_inset space \thinspace{}
20538 \begin_inset Flex Code
20541 \begin_layout Plain Layout
20547 ] Force a a line break in the \SpecialChar LaTeX
20548 output before the inset starts and after
20550 This assures the inset itself is output on its own lines, for parsing purposes.
20553 \begin_layout Description
20554 \begin_inset Flex Code
20557 \begin_layout Plain Layout
20564 \begin_inset Flex Code
20567 \begin_layout Plain Layout
20576 \begin_inset space \thinspace{}
20580 \begin_inset Flex Code
20583 \begin_layout Plain Layout
20589 ] Indicates whether the
20590 \begin_inset Flex Code
20593 \begin_layout Plain Layout
20599 should be used or, instead, the user can change the paragraph style used
20604 \begin_layout Description
20605 \begin_inset Flex Code
20608 \begin_layout Plain Layout
20615 \begin_inset Flex Code
20618 \begin_layout Plain Layout
20627 \begin_inset space \thinspace{}
20631 \begin_inset Flex Code
20634 \begin_layout Plain Layout
20640 ] As with paragraph styles, see
20641 \begin_inset CommandInset ref
20643 reference "subsec:Paragraph-Styles"
20650 \begin_layout Description
20651 \begin_inset Flex Code
20654 \begin_layout Plain Layout
20660 These tags control the XHTML output.
20662 \begin_inset CommandInset ref
20664 reference "sec:Tags-for-XHTML"
20671 \begin_layout Description
20672 \begin_inset Flex Code
20675 \begin_layout Plain Layout
20682 \begin_inset Flex Code
20685 \begin_layout Plain Layout
20694 \begin_inset space \thinspace{}
20698 \begin_inset Flex Code
20701 \begin_layout Plain Layout
20707 ] Whether to include the contents of this inset in the strings generated
20708 for the `Outline' pane for all table of contents, regardless of the AddToToc
20710 One would not, for example, want the content of a footnote in a section
20711 header to be included in the TOC displayed in the outline, but one would
20712 normally want the content of a character style displayed.
20713 Default is false: not to include.
20716 \begin_layout Description
20717 \begin_inset Flex Code
20720 \begin_layout Plain Layout
20727 \begin_inset Flex Code
20730 \begin_layout Plain Layout
20739 \begin_inset space \thinspace{}
20743 \begin_inset Flex Code
20746 \begin_layout Plain Layout
20752 ] If this is set to 1 and AddToToc is enabled, the inset adds a summary
20753 of its contents in its item in the table of contents.
20754 Otherwise, only the label appears.
20757 \begin_layout Description
20758 \begin_inset Flex Code
20761 \begin_layout Plain Layout
20770 \begin_inset Flex Code
20773 \begin_layout Plain Layout
20782 \begin_inset space \thinspace{}
20786 \begin_inset Flex Code
20789 \begin_layout Plain Layout
20795 ] As with paragraph styles, see
20796 \begin_inset CommandInset ref
20798 reference "subsec:Paragraph-Styles"
20805 \begin_layout Description
20806 \begin_inset Flex Code
20809 \begin_layout Plain Layout
20815 The font used for the label.
20817 \begin_inset CommandInset ref
20819 reference "subsec:Font-description"
20824 Note that this definition can never appear before
20825 \begin_inset Flex Code
20828 \begin_layout Plain Layout
20834 , lest it be ineffective.
20837 \begin_layout Description
20838 \begin_inset Flex Code
20841 \begin_layout Plain Layout
20848 \begin_inset Flex Code
20851 \begin_layout Plain Layout
20858 \begin_inset Quotes erd
20862 \begin_inset Quotes erd
20865 ] What will be displayed on the button or elsewhere as the inset label.
20867 \begin_inset Flex Code
20870 \begin_layout Plain Layout
20878 \begin_inset Flex Code
20881 \begin_layout Plain Layout
20887 ) modify this label on the fly.
20890 \begin_layout Description
20891 \begin_inset Flex Code
20894 \begin_layout Plain Layout
20900 Language dependent preamble; see
20901 \begin_inset CommandInset ref
20903 reference "subsec:I18n"
20910 \begin_layout Description
20911 \begin_inset Flex Code
20914 \begin_layout Plain Layout
20921 \begin_inset Flex Code
20924 \begin_layout Plain Layout
20930 ] The name of the corresponding \SpecialChar LaTeX
20932 Either the environment or command name.
20935 \begin_layout Description
20936 \begin_inset Flex Code
20939 \begin_layout Plain Layout
20946 \begin_inset Flex Code
20949 \begin_layout Plain Layout
20955 ] The optional parameter for the corresponding
20956 \begin_inset Flex Code
20959 \begin_layout Plain Layout
20965 stuff, including possible bracket pairs like
20966 \begin_inset Flex Code
20969 \begin_layout Plain Layout
20976 This parameter cannot be changed from within \SpecialChar LyX
20978 \begin_inset Flex Code
20981 \begin_layout Plain Layout
20987 for customizable parameters).
20988 It will be output as is after all \SpecialChar LaTeX
20990 \begin_inset Flex Code
20993 \begin_layout Plain Layout
21002 \begin_layout Description
21003 \begin_inset Flex Code
21006 \begin_layout Plain Layout
21013 \begin_inset Flex Code
21016 \begin_layout Plain Layout
21017 Command, Environment, None
21022 ] How the style should be translated into \SpecialChar LaTeX
21027 \begin_layout Plain Layout
21028 \begin_inset Flex Code
21031 \begin_layout Plain Layout
21037 is perhaps a bit misleading, since these rules apply to SGML classes too.
21038 Visit the SGML class files for specific examples.
21047 \begin_layout Description
21048 \begin_inset Flex Code
21051 \begin_layout Plain Layout
21057 means nothing special
21060 \begin_layout Description
21061 \begin_inset Flex Code
21064 \begin_layout Plain Layout
21071 \begin_inset Flex Code
21074 \begin_layout Plain Layout
21081 {\SpecialChar ldots
21090 \begin_layout Description
21091 \begin_inset Flex Code
21094 \begin_layout Plain Layout
21101 \begin_inset Flex Code
21104 \begin_layout Plain Layout
21111 }\SpecialChar ldots
21126 \begin_layout Standard
21127 Putting the last few things together, the \SpecialChar LaTeX
21128 output will be either:
21131 \begin_layout LyX-Code
21134 LatexName[LatexParam]{\SpecialChar ldots
21138 \begin_layout Standard
21142 \begin_layout LyX-Code
21145 begin{LatexName}[LatexParam] \SpecialChar ldots
21151 \begin_layout Standard
21152 depending upon the \SpecialChar LaTeX
21157 \begin_layout Description
21158 \begin_inset Flex Code
21161 \begin_layout Plain Layout
21168 \begin_inset Flex Code
21171 \begin_layout Plain Layout
21177 ] A string that is put at the beginning of the layout content.
21178 A line break in the output can be indicated by
21179 \begin_inset Flex Code
21182 \begin_layout Plain Layout
21191 \begin_layout Description
21192 \begin_inset Flex Code
21195 \begin_layout Plain Layout
21202 \begin_inset Flex Code
21205 \begin_layout Plain Layout
21212 \begin_inset Flex Code
21215 \begin_layout Plain Layout
21222 \begin_inset Flex Code
21225 \begin_layout Plain Layout
21232 \begin_inset Flex Code
21235 \begin_layout Plain Layout
21241 (indicating a dummy definition ending definitions of charstyles, etc).
21242 This entry is required in and is only meaningful for Flex insets.
21243 Among other things, it determines on which menu this inset will appear.
21245 \begin_inset Flex Code
21248 \begin_layout Plain Layout
21255 \begin_inset Flex Code
21258 \begin_layout Plain Layout
21264 will automatically set
21265 \begin_inset Flex Code
21268 \begin_layout Plain Layout
21275 \begin_inset Flex Code
21278 \begin_layout Plain Layout
21286 \begin_inset Flex Code
21289 \begin_layout Plain Layout
21295 can be set to true, or
21296 \begin_inset Flex Code
21299 \begin_layout Plain Layout
21306 \begin_inset Flex Code
21309 \begin_layout Plain Layout
21315 insets by setting it
21320 \begin_inset Flex Code
21323 \begin_layout Plain Layout
21330 \change_inserted -712698321 1555575738
21334 \begin_layout Description
21336 \change_inserted -712698321 1555575844
21337 \begin_inset Flex Code
21340 \begin_layout Plain Layout
21342 \change_inserted -712698321 1555575740
21351 \begin_inset Flex Code
21354 \begin_layout Plain Layout
21356 \change_inserted -712698321 1555575740
21364 A dedicated string for the menu.
21365 You can define an accelerator by appending the respective character to
21366 the string, divided by
21367 \begin_inset Quotes eld
21371 \begin_inset Quotes erd
21375 \begin_inset space \thinspace{}
21379 \begin_inset space \space{}
21383 \begin_inset Quotes eld
21387 \begin_inset Flex Code
21390 \begin_layout Plain Layout
21392 \change_inserted -712698321 1555575781
21401 \begin_inset Quotes erd
21405 This specification is optional.
21406 If it is not given the inset name as specified in the type declaration
21407 will be used instead for the menu.
21412 \begin_layout Description
21413 \begin_inset Flex Code
21416 \begin_layout Plain Layout
21423 \begin_inset Flex Code
21426 \begin_layout Plain Layout
21435 \begin_inset space \thinspace{}
21439 \begin_inset Flex Code
21442 \begin_layout Plain Layout
21448 ] Whether multiple paragraphs are permitted in this inset.
21450 \begin_inset Flex Code
21453 \begin_layout Plain Layout
21459 to the same value and
21460 \begin_inset Flex Code
21463 \begin_layout Plain Layout
21469 to the opposite value.
21470 These can be reset to other values, if they are used
21475 \begin_inset Flex Code
21478 \begin_layout Plain Layout
21488 \begin_layout Description
21489 \begin_inset Flex Code
21492 \begin_layout Plain Layout
21499 \begin_inset Flex Code
21502 \begin_layout Plain Layout
21511 \begin_inset space \thinspace{}
21515 \begin_inset Flex Code
21518 \begin_layout Plain Layout
21524 ] Whether fragile commands in this inset should be
21525 \begin_inset Flex Code
21528 \begin_layout Plain Layout
21541 whether the command should itself be protected.) Default is false.
21542 \change_inserted -712698321 1523633958
21546 \begin_layout Description
21548 \change_inserted -712698321 1552395786
21549 \begin_inset Flex Code
21552 \begin_layout Plain Layout
21554 \change_inserted -712698321 1523633961
21563 \begin_inset Flex Code
21566 \begin_layout Plain Layout
21568 \change_inserted -712698321 1523633958
21579 \begin_inset space \thinspace{}
21583 \begin_inset Flex Code
21586 \begin_layout Plain Layout
21588 \change_inserted -712698321 1523633958
21596 ] This causes macros that contain this inset to be protected with
21597 \begin_inset Flex Code
21600 \begin_layout Plain Layout
21602 \change_inserted -712698321 1523634038
21617 ) if necessary and thus allows (some) verbatim stuff in macros.
21621 \begin_layout Description
21623 \change_inserted -712698321 1555579651
21624 \begin_inset Flex Code
21627 \begin_layout Plain Layout
21629 \change_inserted -712698321 1552395787
21638 \begin_inset Flex Code
21641 \begin_layout Plain Layout
21643 \change_inserted -712698321 1552395787
21654 \begin_inset space \thinspace{}
21658 \begin_inset Flex Code
21661 \begin_layout Plain Layout
21663 \change_inserted -712698321 1552395787
21671 ] Whether specific commands in this inset (such as
21672 \begin_inset Flex Code
21675 \begin_layout Plain Layout
21677 \change_inserted -712698321 1552395787
21688 \begin_inset Flex Code
21691 \begin_layout Plain Layout
21693 \change_inserted -712698321 1552395787
21703 ) should be protected in an
21704 \begin_inset Flex Code
21707 \begin_layout Plain Layout
21709 \change_inserted -712698321 1552395787
21720 This is particularly needed for insets that draw on
21728 commands which parse their content in complex ways.
21732 \begin_layout Description
21734 \change_inserted -712698321 1555579742
21735 \begin_inset Flex Code
21738 \begin_layout Plain Layout
21740 \change_inserted -712698321 1555579658
21749 \begin_inset Flex Code
21752 \begin_layout Plain Layout
21754 \change_inserted -712698321 1555579651
21762 Option to define a different command (from the default
21763 \begin_inset Flex Code
21766 \begin_layout Plain Layout
21768 \change_inserted -712698321 1555579742
21780 ) to be used for line breaks.
21781 The initial backslash must not be specified.
21786 \begin_layout Description
21787 \begin_inset Flex Code
21790 \begin_layout Plain Layout
21797 \begin_inset Flex Code
21800 \begin_layout Plain Layout
21806 ] Deletes an existing
21807 \begin_inset Flex Code
21810 \begin_layout Plain Layout
21819 \begin_layout Description
21820 \begin_inset Flex Code
21823 \begin_layout Plain Layout
21830 \begin_inset Flex Code
21833 \begin_layout Plain Layout
21840 \begin_inset Flex Code
21843 \begin_layout Plain Layout
21849 that has replaced this
21850 \begin_inset Flex Code
21853 \begin_layout Plain Layout
21860 This is used to rename an
21861 \begin_inset Flex Code
21864 \begin_layout Plain Layout
21870 , while keeping backward compatibility.
21871 \change_inserted -712698321 1559491850
21875 \begin_layout Description
21877 \change_inserted -712698321 1559492002
21878 \begin_inset Flex Code
21881 \begin_layout Plain Layout
21883 \change_inserted -712698321 1559491854
21892 \begin_inset Flex Code
21895 \begin_layout Plain Layout
21897 \change_inserted -712698321 1559491850
21908 \begin_inset space \thinspace{}
21912 \begin_inset Flex Code
21915 \begin_layout Plain Layout
21917 \change_inserted -712698321 1559491850
21925 ] If this is set to
21926 \begin_inset Flex Code
21929 \begin_layout Plain Layout
21931 \change_inserted -712698321 1559491881
21939 , paragraph breaks will be ignored in the output.
21940 This might be useful for insets where the content should be alignable on
21941 different lines only in the \SpecialChar LyX
21942 workarea, without any effect in the output.
21947 \begin_layout Description
21948 \begin_inset Flex Code
21951 \begin_layout Plain Layout
21958 \begin_inset Flex Code
21961 \begin_layout Plain Layout
21970 \begin_inset space \thinspace{}
21974 \begin_inset Flex Code
21977 \begin_layout Plain Layout
21983 ] As with paragraph styles, see
21984 \begin_inset CommandInset ref
21986 reference "subsec:Paragraph-Styles"
21994 \begin_layout Description
21995 \begin_inset Flex Code
21998 \begin_layout Plain Layout
22005 \begin_inset Flex Code
22008 \begin_layout Plain Layout
22017 \begin_inset space \thinspace{}
22021 \begin_inset Flex Code
22024 \begin_layout Plain Layout
22030 ] As with paragraph styles, see
22031 \begin_inset CommandInset ref
22033 reference "subsec:Paragraph-Styles"
22041 \begin_layout Description
22042 \begin_inset Flex Code
22045 \begin_layout Plain Layout
22051 As with paragraph styles, see
22052 \begin_inset CommandInset ref
22054 reference "subsec:Paragraph-Styles"
22061 \begin_layout Description
22062 \begin_inset Flex Code
22065 \begin_layout Plain Layout
22072 \begin_inset Flex Code
22075 \begin_layout Plain Layout
22081 ] The prefix to use when creating labels referring to insets of this type.
22082 This allows the use of formatted references.
22085 \begin_layout Description
22086 \begin_inset Flex Code
22089 \begin_layout Plain Layout
22096 \begin_inset Flex Code
22099 \begin_layout Plain Layout
22105 ] As with paragraph styles, see
22106 \begin_inset CommandInset ref
22108 reference "subsec:Paragraph-Styles"
22115 \begin_layout Description
22116 \begin_inset Flex Code
22119 \begin_layout Plain Layout
22126 \begin_inset Flex Code
22129 \begin_layout Plain Layout
22138 \begin_inset space \thinspace{}
22142 \begin_inset Flex Code
22145 \begin_layout Plain Layout
22151 ] Resets the \SpecialChar LaTeX
22152 arguments of this layout (as defined via the
22153 \begin_inset Flex Code
22156 \begin_layout Plain Layout
22163 This is useful if you have copied a style via
22164 \begin_inset Flex Code
22167 \begin_layout Plain Layout
22173 , but you do not want to inherit its (required and optional) arguments.
22176 \begin_layout Description
22177 \begin_inset Flex Code
22180 \begin_layout Plain Layout
22187 \begin_inset Flex Code
22190 \begin_layout Plain Layout
22199 \begin_inset space \thinspace{}
22203 \begin_inset Flex Code
22206 \begin_layout Plain Layout
22213 \change_inserted -712698321 1597733473
22215 \begin_inset Flex Code
22218 \begin_layout Plain Layout
22220 \change_inserted -712698321 1597732178
22228 , font changes are redone inside the respective inset (in the output) even
22229 if the inset itself is in the context of this font changes (e.
22230 \begin_inset space \thinspace{}
22234 \begin_inset Flex Code
22237 \begin_layout Plain Layout
22239 \change_inserted -712698321 1597733683
22242 textbf{Sourrounding text
22246 textbf{content}}\SpecialChar ldots
22255 \begin_inset Flex Code
22258 \begin_layout Plain Layout
22260 \change_inserted -712698321 1597733686
22263 textbf{Sourrounding text
22265 myinset{content}\SpecialChar ldots
22274 Setting this makes sense for commands that internally reset font settings
22276 \begin_inset space \thinspace{}
22280 Note that wrongly setting this might lead to unwanted result (e.
22281 \begin_inset space \thinspace{}
22285 \begin_inset Flex Code
22288 \begin_layout Plain Layout
22290 \change_inserted -712698321 1597733688
22293 emph{Sourrounding text
22297 emph{content}}\SpecialChar ldots
22305 , content is upright, as
22306 \begin_inset Flex Code
22309 \begin_layout Plain Layout
22311 \change_inserted -712698321 1597733278
22323 \change_deleted -712698321 1597733283
22324 Whether this inset should use the font of its surrounding environment or
22329 \change_deleted -712698321 1597733290
22331 \change_inserted -712698321 1597733290
22333 \begin_inset Flex Code
22336 \begin_layout Plain Layout
22338 \change_inserted -712698321 1597733292
22349 \change_deleted -712698321 1597733327
22350 use the font of the surrounding environment
22351 \change_inserted -712698321 1597733343
22352 font changes are not redone inside the inset
22357 \begin_layout Description
22358 \begin_inset Flex Code
22361 \begin_layout Plain Layout
22368 \begin_inset Flex Code
22371 \begin_layout Plain Layout
22377 ] A string that is put at the end of the layout content.
22378 A line break in the output can be indicated by
22379 \begin_inset Flex Code
22382 \begin_layout Plain Layout
22391 \begin_layout Description
22392 \begin_inset Flex Code
22395 \begin_layout Plain Layout
22402 \begin_inset Flex Code
22405 \begin_layout Plain Layout
22412 \begin_inset space \thinspace{}
22416 \begin_inset Flex Code
22419 \begin_layout Plain Layout
22427 ] Allow spell-checking the contents of this inset.
22431 \begin_layout Subsection
22433 \begin_inset CommandInset label
22435 name "subsec:Counters"
22442 \begin_layout Standard
22443 It is necessary to define the counters (
22444 \begin_inset Flex Noun
22447 \begin_layout Plain Layout
22454 \begin_inset Flex Noun
22457 \begin_layout Plain Layout
22463 , \SpecialChar ldots
22464 ) in the text class itself.
22465 The standard counters are defined in the file
22466 \begin_inset Flex Code
22469 \begin_layout Plain Layout
22475 , so you may have to do no more than add
22478 \begin_layout LyX-Code
22479 Input stdcounters.inc
22482 \begin_layout Standard
22483 to your layout file to get them to work.
22484 But if you want to define custom counters, then you can do so.
22485 The counter declaration must begin with:
22488 \begin_layout LyX-Code
22489 Counter CounterName
22492 \begin_layout Standard
22494 \begin_inset Flex Code
22497 \begin_layout Plain Layout
22503 ' is replaced by the name of the counter.
22504 And it must end with
22505 \begin_inset Quotes eld
22509 \begin_inset Flex Code
22512 \begin_layout Plain Layout
22519 \begin_inset Quotes erd
22523 The following parameters can also be used:
22526 \begin_layout Description
22527 \begin_inset Flex Code
22530 \begin_layout Plain Layout
22537 \begin_inset Flex Code
22540 \begin_layout Plain Layout
22546 ] Sets the initial value for the counter, to which it will be reset whenever
22548 Normally, one will want the default, 1.
22551 \begin_layout Description
22552 \begin_inset Flex Code
22555 \begin_layout Plain Layout
22562 \begin_inset Flex Code
22565 \begin_layout Plain Layout
22572 \begin_inset Quotes erd
22576 \begin_inset Quotes erd
22579 ] When defined, this string defines how the counter is displayed.
22580 Setting this value sets
22581 \begin_inset Flex Code
22584 \begin_layout Plain Layout
22585 LabelStringAppendix
22591 The following special constructs can be used in the string:
22595 \begin_layout Itemize
22596 \begin_inset Flex Code
22599 \begin_layout Plain Layout
22607 will be replaced by the expansion of the
22608 \begin_inset Flex Code
22611 \begin_layout Plain Layout
22618 \begin_inset Flex Code
22621 \begin_layout Plain Layout
22622 LabelStringAppendix
22628 \begin_inset Flex Code
22631 \begin_layout Plain Layout
22641 \begin_layout Itemize
22642 counter values can be expressed using \SpecialChar LaTeX
22644 \begin_inset Newline newline
22648 \begin_inset Flex Code
22651 \begin_layout Plain Layout
22668 \begin_inset Flex Code
22671 \begin_layout Plain Layout
22683 \begin_layout Plain Layout
22693 Actually, the situation is a bit more complicated: any
22712 other than those described below will produce arabic numerals.
22713 It would not be surprising to see this change in the future.
22719 \begin_inset Flex Code
22722 \begin_layout Plain Layout
22728 : 1, 2, 3,\SpecialChar ldots
22730 \begin_inset Flex Code
22733 \begin_layout Plain Layout
22739 for lower-case letters: a, b, c, \SpecialChar ldots
22741 \begin_inset Flex Code
22744 \begin_layout Plain Layout
22750 for upper-case letters: A, B, C, \SpecialChar ldots
22752 \begin_inset Flex Code
22755 \begin_layout Plain Layout
22761 for lower-case roman numerals: i, ii, iii, \SpecialChar ldots
22763 \begin_inset Flex Code
22766 \begin_layout Plain Layout
22772 for upper-case roman numerals: I, II, III\SpecialChar ldots
22774 \begin_inset Flex Code
22777 \begin_layout Plain Layout
22783 for hebrew numerals.
22787 \begin_layout Standard
22788 If LabelString is not defined, a default value is constructed as follows:
22789 if the counter has a
22790 \change_deleted 731793113 1604355218
22792 \change_inserted 731793113 1604355221
22796 \begin_inset Flex Code
22799 \begin_layout Plain Layout
22801 \change_deleted 731793113 1604355223
22803 \change_inserted 731793113 1604355226
22812 \begin_inset Flex Code
22815 \begin_layout Plain Layout
22822 \begin_inset Newline newline
22826 \begin_inset Flex Code
22829 \begin_layout Plain Layout
22833 \change_inserted 731793113 1604355228
22835 \change_deleted 731793113 1604355230
22845 is used; otherwise the string
22846 \begin_inset Flex Code
22849 \begin_layout Plain Layout
22860 \begin_layout Description
22861 \begin_inset Flex Code
22864 \begin_layout Plain Layout
22865 LabelStringAppendix
22871 \begin_inset Flex Code
22874 \begin_layout Plain Layout
22881 \begin_inset Quotes eld
22885 \begin_inset Quotes erd
22889 \begin_inset Flex Code
22892 \begin_layout Plain Layout
22898 , but for use in the Appendix.
22899 \change_inserted -584632292 1607202551
22903 \begin_layout Description
22905 \change_inserted -584632292 1607202682
22906 \begin_inset Flex Code
22909 \begin_layout Plain Layout
22916 \begin_inset Flex Code
22919 \begin_layout Plain Layout
22921 \change_inserted -584632292 1607202576
22930 \begin_inset Quotes eld
22934 \begin_inset Quotes erd
22937 ] The counter name as used in \SpecialChar LaTeX
22939 (E.g., in \SpecialChar LyX
22940 , there is a counter named `theorem', but it is output to \SpecialChar LaTeX
22946 \begin_layout Description
22947 \begin_inset Flex Code
22950 \begin_layout Plain Layout
22957 \begin_inset Flex Code
22960 \begin_layout Plain Layout
22967 \begin_inset Quotes erd
22971 \begin_inset Quotes erd
22974 ] A format for use with formatted references to this counter.
22975 For example, one might want to have references to section numbers appear
22977 \begin_inset Quotes eld
22981 \begin_inset Quotes erd
22985 The string should contain
22986 \begin_inset Quotes eld
22990 \begin_inset Quotes erd
22994 This will be replaced by the counter number itself.
22995 So, for sections, it would be: Section ##.
22998 \begin_layout Description
22999 \begin_inset Flex Code
23002 \begin_layout Plain Layout
23009 \begin_inset Flex Code
23012 \begin_layout Plain Layout
23019 \begin_inset Quotes erd
23023 \begin_inset Quotes erd
23026 ] If this is set to the name of another counter, the present counter will
23027 be reset every time the other one is increased.
23029 \begin_inset Flex Code
23032 \begin_layout Plain Layout
23039 \begin_inset Flex Code
23042 \begin_layout Plain Layout
23051 \begin_layout Subsection
23053 \begin_inset CommandInset label
23055 name "subsec:Font-description"
23062 \begin_layout Standard
23063 A font description looks like this:
23066 \begin_layout LyX-Code
23083 \begin_layout LyX-Code
23087 \begin_layout LyX-Code
23091 \begin_layout Standard
23092 The following commands are available:
23095 \begin_layout Description
23096 \begin_inset Flex Code
23099 \begin_layout Plain Layout
23106 \begin_inset Flex Code
23109 \begin_layout Plain Layout
23118 \begin_inset Flex Code
23121 \begin_layout Plain Layout
23128 \begin_inset Flex Code
23131 \begin_layout Plain Layout
23138 \begin_inset Flex Code
23141 \begin_layout Plain Layout
23148 \begin_inset Flex Code
23151 \begin_layout Plain Layout
23158 \begin_inset Flex Code
23161 \begin_layout Plain Layout
23168 \begin_inset Flex Code
23171 \begin_layout Plain Layout
23178 \begin_inset Flex Code
23181 \begin_layout Plain Layout
23188 \begin_inset Flex Code
23191 \begin_layout Plain Layout
23198 \begin_inset Flex Code
23201 \begin_layout Plain Layout
23208 \begin_inset Flex Code
23211 \begin_layout Plain Layout
23218 \begin_inset Flex Code
23221 \begin_layout Plain Layout
23228 \begin_inset Flex Code
23231 \begin_layout Plain Layout
23238 \begin_inset Flex Code
23241 \begin_layout Plain Layout
23248 \begin_inset Flex Code
23251 \begin_layout Plain Layout
23258 \begin_inset Flex Code
23261 \begin_layout Plain Layout
23268 \begin_inset Flex Code
23271 \begin_layout Plain Layout
23278 \begin_inset Flex Code
23281 \begin_layout Plain Layout
23288 \begin_inset Flex Code
23291 \begin_layout Plain Layout
23298 \begin_inset Flex Code
23301 \begin_layout Plain Layout
23310 \begin_layout Description
23311 \begin_inset Flex Code
23314 \begin_layout Plain Layout
23321 \begin_inset Flex Code
23324 \begin_layout Plain Layout
23333 \begin_inset Flex Code
23336 \begin_layout Plain Layout
23343 \begin_inset Flex Code
23346 \begin_layout Plain Layout
23355 \begin_layout Description
23356 \begin_inset Flex Code
23359 \begin_layout Plain Layout
23366 \begin_inset Flex Code
23369 \begin_layout Plain Layout
23375 ] Valid arguments are:
23376 \begin_inset Flex Code
23379 \begin_layout Plain Layout
23386 \begin_inset Flex Code
23389 \begin_layout Plain Layout
23396 \begin_inset Flex Code
23399 \begin_layout Plain Layout
23406 \begin_inset Flex Code
23409 \begin_layout Plain Layout
23416 \begin_inset Flex Code
23419 \begin_layout Plain Layout
23426 \begin_inset Flex Code
23429 \begin_layout Plain Layout
23436 \begin_inset Flex Code
23439 \begin_layout Plain Layout
23446 \begin_inset Flex Code
23449 \begin_layout Plain Layout
23456 \begin_inset Flex Code
23459 \begin_layout Plain Layout
23466 \begin_inset Flex Code
23469 \begin_layout Plain Layout
23476 \begin_inset Flex Code
23479 \begin_layout Plain Layout
23486 \begin_inset Flex Code
23489 \begin_layout Plain Layout
23496 Each of these turns on or off the corresponding attribute.
23498 \begin_inset Flex Code
23501 \begin_layout Plain Layout
23507 turns on emphasis, and
23508 \begin_inset Flex Code
23511 \begin_layout Plain Layout
23519 \begin_inset Newline newline
23522 If the latter seems puzzling, remember that the font settings for the present
23523 context are generally inherited from the surrounding context.
23525 \begin_inset Flex Code
23528 \begin_layout Plain Layout
23534 would turn off the emphasis that was anyway in effect, say, in a theorem
23538 \begin_layout Description
23539 \begin_inset Flex Code
23542 \begin_layout Plain Layout
23549 \begin_inset Flex Code
23552 \begin_layout Plain Layout
23561 \begin_inset Flex Code
23564 \begin_layout Plain Layout
23573 \begin_layout Description
23574 \begin_inset Flex Code
23577 \begin_layout Plain Layout
23584 \begin_inset Flex Code
23587 \begin_layout Plain Layout
23596 \begin_inset Flex Code
23599 \begin_layout Plain Layout
23606 \begin_inset Flex Code
23609 \begin_layout Plain Layout
23616 \begin_inset Flex Code
23619 \begin_layout Plain Layout
23628 \begin_layout Description
23629 \begin_inset Flex Code
23632 \begin_layout Plain Layout
23639 \begin_inset Flex Code
23642 \begin_layout Plain Layout
23649 \begin_inset Flex Code
23652 \begin_layout Plain Layout
23659 \begin_inset Flex Code
23662 \begin_layout Plain Layout
23671 \begin_inset Flex Code
23674 \begin_layout Plain Layout
23681 \begin_inset Flex Code
23684 \begin_layout Plain Layout
23691 \begin_inset Flex Code
23694 \begin_layout Plain Layout
23701 \begin_inset Flex Code
23704 \begin_layout Plain Layout
23711 \begin_inset Flex Code
23714 \begin_layout Plain Layout
23723 \begin_layout Subsection
23724 \begin_inset CommandInset label
23726 name "subsec:Citation-engine-description"
23730 Cite engine description
23733 \begin_layout Standard
23735 \begin_inset Flex Code
23738 \begin_layout Plain Layout
23744 blocks, as used mainly in cite engine files (see
23745 \begin_inset CommandInset ref
23747 reference "subsec:Cite-Engine-Files"
23754 ), define the citation commands provided by a specific
23755 \begin_inset Quotes eld
23759 \begin_inset Quotes erd
23763 A cite engine, in \SpecialChar LyX
23764 terms, is way specific way to format citations, using
23765 numbers, author names and/or years.
23766 Currently, \SpecialChar LyX
23767 supports three such engine types, namely:
23770 \begin_layout Enumerate
23771 \begin_inset Flex Code
23774 \begin_layout Plain Layout
23780 : the default Bib\SpecialChar TeX
23781 way to format citations, a simple numeric style (e.
23782 \begin_inset space \thinspace{}
23786 \begin_inset Quotes eld
23790 \begin_inset Quotes erd
23796 \begin_layout Enumerate
23797 \begin_inset Flex Code
23800 \begin_layout Plain Layout
23806 : Harvard-styled citations using author names and publication year (e.
23807 \begin_inset space \thinspace{}
23811 \begin_inset Quotes eld
23814 Smith and Miller (2017b)
23815 \begin_inset Quotes erd
23821 \begin_layout Enumerate
23822 \begin_inset Flex Code
23825 \begin_layout Plain Layout
23831 : extended numerical citations that also allow for author or title next
23833 \begin_inset space \thinspace{}
23837 \begin_inset Quotes eld
23840 Smith and Miller [1]
23841 \begin_inset Quotes erd
23847 \begin_layout Standard
23848 \begin_inset Flex Code
23851 \begin_layout Plain Layout
23857 blocks look like this:
23860 \begin_layout LyX-Code
23864 \begin_layout LyX-Code
23868 \begin_layout LyX-Code
23872 \begin_layout LyX-Code
23873 citeyearpar[][]=parencite*
23876 \begin_layout LyX-Code
23880 \begin_layout LyX-Code
23884 \begin_layout Standard
23886 \begin_inset Flex Code
23889 \begin_layout Plain Layout
23895 denotes the engine.
23896 The individual lines respectively define a cite command or cite command
23897 paradigm supported by this engine.
23898 The line can be as simple as a cite command that is used both to name the
23899 respective \SpecialChar LyX
23900 command and the \SpecialChar LaTeX
23901 output or more complex in order to differentiate
23903 The full syntax is:
23906 \begin_layout LyX-Code
23907 LyXName|alias$*<!_stardesc!_stardesctooltip>[][]=latexcmd
23910 \begin_layout Itemize
23911 \begin_inset Flex Code
23914 \begin_layout Plain Layout
23920 : The name as used in the
23921 \begin_inset Flex Code
23924 \begin_layout Plain Layout
23934 \begin_layout Standard
23935 For portability reasons, we try to use the same name for same-formatted
23936 commands in different cite packages (thus many names stem from natbib,
23937 and thus we need to differentiate a
23938 \begin_inset Flex Code
23941 \begin_layout Plain Layout
23947 sometimes, if the \SpecialChar LaTeX
23948 command names differ).
23952 \begin_layout Itemize
23953 \begin_inset Flex Code
23956 \begin_layout Plain Layout
23962 : a (comma-separated) list of commands that fall back to the given
23963 \begin_inset Flex Code
23966 \begin_layout Plain Layout
23972 in the current engine.
23973 This eases the switch of citation packages and engines.
23975 \begin_inset Flex Code
23978 \begin_layout Plain Layout
23985 \begin_inset Flex Code
23988 \begin_layout Plain Layout
23994 in layout definitions.
23997 \begin_layout Itemize
23998 \begin_inset Flex Code
24001 \begin_layout Plain Layout
24007 : The actual \SpecialChar LaTeX
24008 command that is output.
24012 \begin_layout Standard
24013 \begin_inset Flex Code
24016 \begin_layout Plain Layout
24023 \begin_inset Flex Code
24026 \begin_layout Plain Layout
24034 \begin_inset Flex Code
24037 \begin_layout Plain Layout
24044 \begin_inset Flex Code
24047 \begin_layout Plain Layout
24053 will be output to \SpecialChar LaTeX
24057 \begin_layout Standard
24061 \begin_layout Itemize
24062 Capitalization indicates that the command also has a capitalized form (
24063 \begin_inset Flex Code
24066 \begin_layout Plain Layout
24076 \begin_inset Flex Code
24079 \begin_layout Plain Layout
24088 These usually enforce up-casing of name prefixes (
24093 \begin_inset Formula $\Rightarrow$
24103 \begin_layout Itemize
24105 \begin_inset Flex Code
24108 \begin_layout Plain Layout
24114 indicate the number of optional arguments (there can be 0–2).
24117 \begin_layout Itemize
24119 \begin_inset Flex Code
24122 \begin_layout Plain Layout
24128 indicates there is a starred version of the command (
24129 \begin_inset Flex Code
24132 \begin_layout Plain Layout
24142 \begin_inset Flex Code
24145 \begin_layout Plain Layout
24158 \begin_layout Standard
24159 By default, the starred version means: Output all authors even if it should
24161 \begin_inset Quotes eld
24165 \begin_inset Quotes erd
24169 \begin_inset Flex Code
24172 \begin_layout Plain Layout
24181 \begin_layout Standard
24182 If the star has a different meaning for a given command, it can be specified
24184 \begin_inset Flex Code
24187 \begin_layout Plain Layout
24188 <!_stardesc!_stardesctooltip>
24194 Maximal two translatable macro keywords, marked by the prefix
24195 \begin_inset Flex Code
24198 \begin_layout Plain Layout
24205 The first points to the string that replaces the
24206 \begin_inset Quotes eld
24210 \begin_inset Quotes erd
24213 checkbox label in the citation dialog, the second one to an optional tool
24214 tip for this checkbox.
24218 \begin_layout Standard
24219 Note that these two macros have to be defined in a
24220 \begin_inset Flex Code
24223 \begin_layout Plain Layout
24229 (see next section), dropping the
24230 \begin_inset Flex Code
24233 \begin_layout Plain Layout
24239 from the prefix, like this:
24242 \begin_layout LyX-Code
24243 _stardesc Sta&rred command label
24246 \begin_layout LyX-Code
24247 _stardesctooltip Tooltip for the starred command checkbox.
24251 \begin_layout Itemize
24253 \begin_inset Flex Code
24256 \begin_layout Plain Layout
24262 indicates that this command features
24263 \begin_inset Quotes eld
24266 qualified citation lists
24267 \begin_inset Quotes erd
24275 -specific feature for multi-reference citations where an individual pre-
24276 and postnote can be given to each reference in the list.
24277 Please refer to the
24281 manual for details.
24282 \change_inserted -712698321 1526898670
24286 \begin_layout Standard
24288 \change_inserted -712698321 1526899524
24289 If you want to add a cite command to a cite engine (e.
24290 \begin_inset space \thinspace{}
24293 g., add a specific command provided by a class), you can use
24294 \begin_inset Flex Code
24297 \begin_layout Plain Layout
24299 \change_inserted -712698321 1526898768
24300 AddToCiteEngine <engine type> \SpecialChar ldots
24309 Note that only cite commands that do not exist yet are added.
24314 \begin_layout Subsection
24315 \begin_inset CommandInset label
24317 name "subsec:Citation-format-description"
24321 Cite format description
24324 \begin_layout Standard
24326 \begin_inset Flex Code
24329 \begin_layout Plain Layout
24335 blocks are used to describe how bibliographic information should be displayed,
24336 both within \SpecialChar LyX
24337 itself (in the citation dialog and in tooltips, for example)
24338 and in XHTML output.
24339 Such a block might look like this:
24342 \begin_layout LyX-Code
24346 \begin_layout LyX-Code
24350 \begin_layout LyX-Code
24354 \begin_layout LyX-Code
24358 \begin_layout Standard
24362 \begin_layout LyX-Code
24366 \begin_layout LyX-Code
24370 \begin_layout LyX-Code
24374 \begin_layout LyX-Code
24378 \begin_layout Standard
24379 In the first case, the individual lines define how the bibliographic information
24380 associated with an article or book, respectively, is to be displayed, and
24381 such a definition can be given for any
24382 \begin_inset Quotes els
24386 \begin_inset Quotes ers
24389 that might be present in a Bib\SpecialChar TeX
24392 defines a default format in the source code that will be used if no specific
24393 definition has been given.
24395 predefines several formats in the file
24396 \begin_inset Flex Code
24399 \begin_layout Plain Layout
24405 , which is included in most of \SpecialChar LyX
24406 's document classes.
24409 \begin_layout Standard
24410 In the second case, the lines define how a specific citation command (in
24412 \begin_inset Flex Code
24415 \begin_layout Plain Layout
24424 \begin_inset Flex Code
24427 \begin_layout Plain Layout
24435 ) is to be displayed on the citation inset label, in the citation dialog,
24436 menu or XHTML output.
24438 defines such formats for the citation style variants it supports via
24440 Document\SpecialChar menuseparator
24441 Setting\SpecialChar menuseparator
24442 Bibliography\SpecialChar ldots
24446 \begin_inset Flex Code
24449 \begin_layout Plain Layout
24455 files that are shipped with \SpecialChar LyX
24457 \begin_inset CommandInset ref
24459 reference "subsec:Cite-Engine-Files"
24469 \begin_layout Standard
24470 The definitions use a simple language that allows Bib\SpecialChar TeX
24471 keys to be replaced
24473 Keys should be enclosed in
24474 \begin_inset Flex Code
24477 \begin_layout Plain Layout
24484 \begin_inset Flex Code
24487 \begin_layout Plain Layout
24494 So a simple definition might look like this:
24497 \begin_layout LyX-Code
24499 \begin_inset Quotes eld
24503 \begin_inset Quotes erd
24509 \begin_layout Standard
24510 This would print the author, followed by a comma, followed by the title,
24511 in quotes, followed by a period.
24514 \begin_layout Standard
24515 Of course, sometimes you may want to print a key only if it exists.
24516 This can be done by using a conditional construction, such as:
24517 \begin_inset Flex Code
24520 \begin_layout Plain Layout
24522 \begin_inset space ~
24532 \begin_inset Flex Code
24535 \begin_layout Plain Layout
24541 key exists, then print
24542 \begin_inset Quotes eld
24546 \begin_inset space ~
24550 \begin_inset Quotes erd
24553 followed by the volume key.
24554 It is also possible to have an else clause in the conditional, such as:
24555 \begin_inset Newline newline
24559 \begin_inset Flex Code
24562 \begin_layout Plain Layout
24563 {%author%[[%author%]][[%editor%, ed.]]}
24569 \begin_inset Newline newline
24573 \begin_inset Flex Code
24576 \begin_layout Plain Layout
24582 key is printed if it exists; otherwise, the editor key is printed, followed
24584 \begin_inset Quotes eld
24588 \begin_inset space ~
24592 \begin_inset Quotes erd
24595 Note that the key is again enclosed in
24596 \begin_inset Flex Code
24599 \begin_layout Plain Layout
24605 signs; the entire conditional is enclosed in braces; and the if and else
24606 clauses are enclosed in double brackets,
24607 \begin_inset Quotes eld
24611 \begin_inset Flex Code
24614 \begin_layout Plain Layout
24621 \begin_inset Quotes eld
24625 \begin_inset Quotes eld
24629 \begin_inset Flex Code
24632 \begin_layout Plain Layout
24639 \begin_inset Quotes erd
24643 There must be no space between any of these.
24646 \begin_layout Standard
24647 Next to the entry keys, there are some special keys that can be used for
24648 these conditionals:
24651 \begin_layout Itemize
24652 \begin_inset Flex Code
24655 \begin_layout Plain Layout
24656 {%dialog%[[true]][[false]]}
24662 \begin_inset Quotes eld
24666 \begin_inset Quotes erd
24669 part for dialogs and menus, the
24670 \begin_inset Quotes eld
24674 \begin_inset Quotes erd
24677 part for other contexts (workarea, export)
24680 \begin_layout Itemize
24681 \begin_inset Flex Code
24684 \begin_layout Plain Layout
24685 {%export%[[true]][[false]]}
24691 \begin_inset Quotes eld
24695 \begin_inset Quotes erd
24698 part for export and menus, the
24699 \begin_inset Quotes eld
24703 \begin_inset Quotes erd
24706 part for other contexts (workarea, dialog)
24709 \begin_layout Itemize
24710 \begin_inset Flex Code
24713 \begin_layout Plain Layout
24720 \begin_inset Quotes eld
24724 \begin_inset Quotes erd
24727 part if another item follows (e.
24728 \begin_inset space \thinspace{}
24731 g., in a citation with multiple keys)
24734 \begin_layout Itemize
24735 \begin_inset Flex Code
24738 \begin_layout Plain Layout
24739 {%second%[[true]][[false]]}
24745 \begin_inset Quotes eld
24749 \begin_inset Quotes erd
24752 if this is the second of multiple items, else the
24753 \begin_inset Quotes eld
24757 \begin_inset Quotes erd
24763 \begin_layout Itemize
24764 \begin_inset Flex Code
24767 \begin_layout Plain Layout
24768 {%ifstar%[[true]][[false]]}
24774 \begin_inset Quotes eld
24778 \begin_inset Quotes erd
24781 part for starred citation commands (such as
24782 \begin_inset Flex Code
24785 \begin_layout Plain Layout
24793 ), the false part for unstarred
24796 \begin_layout Itemize
24797 \begin_inset Flex Code
24800 \begin_layout Plain Layout
24801 {%ifentrytype:<type>%[[true]][[false]]}
24807 \begin_inset Quotes eld
24811 \begin_inset Quotes erd
24814 if the current entry type matches
24815 \begin_inset Flex Code
24818 \begin_layout Plain Layout
24824 , else the false part (e.g., in a citation definition:
24825 \begin_inset Flex Code
24828 \begin_layout Plain Layout
24829 {%ifentrytype:book%[[this is a book]][[this is no book]]}
24837 \begin_layout Itemize
24838 \begin_inset Flex Code
24841 \begin_layout Plain Layout
24842 {%ifmultiple:<authortype>%[[true]][[false]]}
24848 \begin_inset Quotes eld
24852 \begin_inset Quotes erd
24855 if the current author type (author, editor etc.) has multiple authors, else
24856 the false part (e.g., in a bibliography definition:
24857 \begin_inset Flex Code
24860 \begin_layout Plain Layout
24861 {%ifmultiple:editor%[[eds.]][[ed.]]}
24869 \begin_layout Itemize
24870 \begin_inset Flex Code
24873 \begin_layout Plain Layout
24874 {%ifqualified%[[true]][[false]]}
24880 \begin_inset Quotes eld
24884 \begin_inset Quotes erd
24887 part if the current citation is a qualified citation list (a specific
24891 format for multi-reference citations), the false part if this is not the
24895 \begin_layout Standard
24897 \begin_inset Flex Code
24900 \begin_layout Plain Layout
24906 prints the author key as it is recorded in the bibliography file.
24907 This might not be what you want, since it will result in a string such
24909 \begin_inset Quotes eld
24912 Miller, Peter and Smith, Mary and White, Jane
24913 \begin_inset Quotes erd
24917 \begin_inset Quotes eld
24921 \begin_inset Quotes erd
24924 is used by Bib\SpecialChar TeX
24925 to delimit authors).
24927 therefore provides some methods to get properly formatted name lists (which
24928 will also get translated).
24929 The following keys are provided:
24932 \begin_layout Enumerate
24933 For name lists with pre- and surname, suitable for the main authors/editors
24934 of a bibliography item.
24936 \begin_inset Flex Code
24939 \begin_layout Plain Layout
24945 part denotes the kind of list that is requested (e.g.
24947 \begin_inset Flex Code
24950 \begin_layout Plain Layout
24960 \begin_layout Itemize
24961 \begin_inset Flex Code
24964 \begin_layout Plain Layout
24965 %abbrvnames:<nametype>%
24970 : Provides a name list which is abbreviated (with
24971 \begin_inset Quotes eld
24975 \begin_inset Quotes erd
24979 \begin_inset Flex Code
24982 \begin_layout Plain Layout
24991 \begin_layout Itemize
24992 \begin_inset Flex Code
24995 \begin_layout Plain Layout
24996 %fullnames:<nametype>%
25001 : Provides a full name list (never abbreviated with
25002 \begin_inset Quotes eld
25006 \begin_inset Quotes erd
25012 \begin_layout Itemize
25013 \begin_inset Flex Code
25016 \begin_layout Plain Layout
25017 %forceabbrvnames:<nametype>%
25022 : Provides a name list which is always abbreviated (with
25023 \begin_inset Quotes eld
25027 \begin_inset Quotes erd
25031 \begin_inset Flex Code
25034 \begin_layout Plain Layout
25044 \begin_layout Enumerate
25045 Alternative name lists with pre- and surname, if the order of pre- and surname
25046 inside the bibliography item differs (as in:
25047 \begin_inset Quotes eld
25050 Miller, John: Some text, in: Mary Smith, ed.: A volume
25051 \begin_inset Quotes erd
25058 \begin_layout Itemize
25059 \begin_inset Flex Code
25062 \begin_layout Plain Layout
25063 %abbrvbynames:<nametype>%
25068 : Provides a name list which is abbreviated (with
25069 \begin_inset Quotes eld
25073 \begin_inset Quotes erd
25077 \begin_inset Flex Code
25080 \begin_layout Plain Layout
25089 \begin_layout Itemize
25090 \begin_inset Flex Code
25093 \begin_layout Plain Layout
25094 %fullbynames:<nametype>%
25099 : Provides a full name list (never abbreviated with
25100 \begin_inset Quotes eld
25104 \begin_inset Quotes erd
25110 \begin_layout Itemize
25111 \begin_inset Flex Code
25114 \begin_layout Plain Layout
25115 %forceabbrvbynames:<nametype>%
25120 : Provides a name list which is always abbreviated (with
25121 \begin_inset Quotes eld
25125 \begin_inset Quotes erd
25129 \begin_inset Flex Code
25132 \begin_layout Plain Layout
25142 \begin_layout Enumerate
25143 And finally name lists which consist of family names only, as used in author-yea
25145 These do not take a
25146 \begin_inset Flex Code
25149 \begin_layout Plain Layout
25155 part, but always return either an author list or, if this does not exist,
25156 an editor list (as common in author-year labels):
25160 \begin_layout Itemize
25161 \begin_inset Flex Code
25164 \begin_layout Plain Layout
25170 : Provides a name list which is abbreviated (with
25171 \begin_inset Quotes eld
25175 \begin_inset Quotes erd
25179 \begin_inset Flex Code
25182 \begin_layout Plain Layout
25191 \begin_layout Itemize
25192 \begin_inset Flex Code
25195 \begin_layout Plain Layout
25201 : Provides a full name list (never abbreviated with
25202 \begin_inset Quotes eld
25206 \begin_inset Quotes erd
25212 \begin_layout Itemize
25213 \begin_inset Flex Code
25216 \begin_layout Plain Layout
25217 %forceabbrvciteauthor%
25222 : Provides a name list which is always abbreviated (with
25223 \begin_inset Quotes eld
25227 \begin_inset Quotes erd
25231 \begin_inset Flex Code
25234 \begin_layout Plain Layout
25244 \begin_layout Standard
25245 The order of pre- and surname in the former two lists can be adjusted by
25249 \begin_layout Itemize
25250 \begin_inset Flex Code
25253 \begin_layout Plain Layout
25254 !firstnameform %surname%, %prename%
25259 (first author in lists of type 1)
25262 \begin_layout Itemize
25263 \begin_inset Flex Code
25266 \begin_layout Plain Layout
25267 !othernameform %surname%, %prename%
25272 (other authors in lists of type 1)
25275 \begin_layout Itemize
25276 \begin_inset Flex Code
25279 \begin_layout Plain Layout
25280 !firstbynameform %prename% %surname%
25285 (first author in lists of type 2)
25288 \begin_layout Itemize
25289 \begin_inset Flex Code
25292 \begin_layout Plain Layout
25293 !otherbynameform %prename% %surname%
25298 (other authors in lists of type 2)
25301 \begin_layout Standard
25302 This allows you to configure namings like
25303 \begin_inset Quotes eld
25306 Miller, Peter and Mary Smith: \SpecialChar ldots
25307 , in: John Doe and Pat Green, eds.:\SpecialChar ldots
25309 \begin_inset Quotes erd
25315 \begin_layout Standard
25316 There is one other piece of syntax available in definitions, which looks
25318 \begin_inset Flex Code
25321 \begin_layout Plain Layout
25328 This defines a piece of formatting information that is to be used when
25330 \begin_inset Quotes eld
25334 \begin_inset Quotes erd
25338 Obviously, we do not want to output HTML tags when writing plain text,
25339 so they should be wrapped in
25340 \begin_inset Quotes eld
25344 \begin_inset Quotes erd
25348 \begin_inset Quotes eld
25352 \begin_inset Quotes erd
25358 \begin_layout Standard
25359 Two special sorts of definitions are also possible in a
25360 \begin_inset Flex Code
25363 \begin_layout Plain Layout
25370 An example of the first would be:
25373 \begin_layout LyX-Code
25375 \begin_inset Quotes eld
25379 \begin_inset Quotes erd
25385 \begin_layout Standard
25386 This is an abbreviation, or macro, and it can be used by treating it as
25388 \begin_inset Flex Code
25391 \begin_layout Plain Layout
25400 \begin_inset Flex Code
25403 \begin_layout Plain Layout
25409 exactly as it would treat its definition.
25410 So, let us issue the obvious
25418 \begin_layout LyX-Code
25422 \begin_layout Standard
25423 or anything like it.
25425 shouldn't go into an infinite loop, but it may go into a long one before
25429 \begin_layout Standard
25430 The second sort of special definition might look like this:
25433 \begin_layout LyX-Code
25437 \begin_layout Standard
25438 This defines a translatable piece of text, which allows relevant parts of
25439 the bibliography or citation to be translated.
25440 It can be included in a definition by treating it as a key:
25441 \begin_inset Flex Code
25444 \begin_layout Plain Layout
25451 Note that there are two different translation paths: All definitions starting
25453 \begin_inset Flex Code
25456 \begin_layout Plain Layout
25462 , such as in the example above, will be translated to the currently active
25463 buffer language (so the translation will match the generated document).
25464 All definitions starting with underscore only will be translated to the
25466 This is the proper translation for strings that only occur in the dialogs
25467 or on buttons, such as this one:
25470 \begin_layout LyX-Code
25471 _addtobib Add to bibliography only.
25474 \begin_layout Standard
25475 Several of these translatable strings are predefined in
25476 \begin_inset Flex Code
25479 \begin_layout Plain Layout
25486 \begin_inset Flex Code
25489 \begin_layout Plain Layout
25496 Note that these are not macros, in the sense just defined.
25497 They will not be expanded.
25500 \begin_layout Standard
25501 So here then is an example that uses several of these features:
25502 \begin_inset VSpace defskip
25508 \begin_layout Standard
25512 !authoredit {%author%[[%author%, ]][[{%editor%[[%editor%, %B_edtext%, ]]}]]}
25515 \begin_layout Standard
25516 \begin_inset VSpace defskip
25519 This defines a macro that prints the author, followed by a comma, if the
25521 \begin_inset Flex Code
25524 \begin_layout Plain Layout
25530 key is defined, or else prints the name of the editor, followed by the
25532 \begin_inset Flex Code
25535 \begin_layout Plain Layout
25541 or its translation (it is by default
25542 \begin_inset Quotes eld
25546 \begin_inset Quotes erd
25550 \begin_inset Flex Code
25553 \begin_layout Plain Layout
25560 Note that this is in fact defined in
25561 \begin_inset Flex Code
25564 \begin_layout Plain Layout
25570 , so you can use it in your own definitions, or re-definitions, if you load
25574 \begin_layout Section
25575 \begin_inset CommandInset label
25577 name "sec:Tags-for-XHTML"
25581 Tags for XHTML output
25584 \begin_layout Standard
25585 As with \SpecialChar LaTeX
25586 or DocBook, the format of \SpecialChar LyX
25587 's XHTML output is also controlled by
25588 layout information.
25589 In general, \SpecialChar LyX
25590 provides sensible defaults and, as mentioned earlier, it will
25591 even construct default CSS style rules from the other layout tags.
25592 For example, \SpecialChar LyX
25593 will attempt to use the information provided in the
25594 \begin_inset Flex Code
25597 \begin_layout Plain Layout
25603 declaration for the Chapter style to write CSS that will appropriately
25604 format chapter headings.
25607 \begin_layout Standard
25608 In many cases, then, you may not have to do anything at all to get acceptable
25609 XHTML output for your own environments, custom insets, and so forth.
25610 But in some cases you will, and so \SpecialChar LyX
25611 provides a number of layout tags that
25612 can be used to customize the XHTML and CSS that are generated.
25615 \begin_layout Standard
25616 Note that there are two tags,
25617 \begin_inset Flex Code
25620 \begin_layout Plain Layout
25627 \begin_inset Flex Code
25630 \begin_layout Plain Layout
25636 that may appear outside style and inset declarations.
25638 \begin_inset CommandInset ref
25640 reference "subsec:General-text-class"
25644 for details on these.
25647 \begin_layout Subsection
25648 \begin_inset CommandInset label
25650 name "subsec:Paragraph-Style-XHTML"
25657 \begin_layout Standard
25658 The sort of XHTML \SpecialChar LyX
25659 outputs for a paragraph depends upon whether we are dealing
25660 with a normal paragraph, a command, or an environment, where this is itself
25661 determined by the contents of the corresponding
25662 \begin_inset Flex Code
25665 \begin_layout Plain Layout
25676 \begin_layout Standard
25677 For a command or normal paragraph, the output XHTML has the following form:
25680 \begin_layout LyX-Code
25684 \begin_inset Quotes erd
25688 \begin_inset Quotes erd
25694 \begin_layout LyX-Code
25698 \begin_inset Quotes erd
25702 \begin_inset Quotes erd
25708 \begin_layout LyX-Code
25711 Contents of the paragraph.
25714 \begin_layout LyX-Code
25720 \begin_layout Standard
25721 The label tags are of course omitted if the paragraph does not have a label.
25724 \begin_layout Standard
25725 For an environment that is not some sort of list, the XHTML takes this form:
25728 \begin_layout LyX-Code
25732 \begin_inset Quotes erd
25736 \begin_inset Quotes erd
25742 \begin_layout LyX-Code
25746 \begin_inset Quotes erd
25750 \begin_inset Quotes erd
25754 \begin_inset Quotes erd
25758 \begin_inset Quotes erd
25761 >Environment Label</labeltag>First paragraph.</itemtag>
25764 \begin_layout LyX-Code
25767 <itemtag>Second paragraph.</itemtag>
25770 \begin_layout LyX-Code
25776 \begin_layout Standard
25777 Note that the label is output only for the first paragraph, as it should
25778 be for a theorem, for example.
25782 \begin_layout Standard
25783 For a list, we have one of these forms:
25786 \begin_layout LyX-Code
25790 \begin_inset Quotes erd
25794 \begin_inset Quotes erd
25800 \begin_layout LyX-Code
25804 \begin_inset Quotes erd
25808 \begin_inset Quotes erd
25812 \begin_inset Quotes erd
25816 \begin_inset Quotes erd
25819 >List Label</labeltag>First item.</itemtag>
25822 \begin_layout LyX-Code
25826 \begin_inset Quotes erd
25830 \begin_inset Quotes erd
25834 \begin_inset Quotes erd
25838 \begin_inset Quotes erd
25841 >List Label</labeltag>Second item.</itemtag>
25844 \begin_layout LyX-Code
25850 \begin_layout LyX-Code
25854 \begin_layout LyX-Code
25858 \begin_inset Quotes erd
25862 \begin_inset Quotes erd
25868 \begin_layout LyX-Code
25872 \begin_inset Quotes erd
25876 \begin_inset Quotes erd
25879 >List Label</labeltag><itemtag attr=
25880 \begin_inset Quotes erd
25884 \begin_inset Quotes erd
25887 >First item.</itemtag>
25890 \begin_layout LyX-Code
25894 \begin_inset Quotes erd
25898 \begin_inset Quotes erd
25901 >List Label</labeltag><itemtag attr=
25902 \begin_inset Quotes erd
25906 \begin_inset Quotes erd
25909 >Second item.</itemtag>
25912 \begin_layout LyX-Code
25918 \begin_layout Standard
25919 Note the different orders of
25920 \begin_inset Flex Code
25923 \begin_layout Plain Layout
25930 \begin_inset Flex Code
25933 \begin_layout Plain Layout
25940 Which order we get depends upon the setting of
25941 \begin_inset Flex Code
25944 \begin_layout Plain Layout
25951 \begin_inset Flex Code
25954 \begin_layout Plain Layout
25960 is false (the default), you get the first of these, with the label within
25961 the item; if true, you get the second, with the label outside the item.
25964 \begin_layout Standard
25965 The specific tags and attributes output for each paragraph type can be controlle
25966 d by means of the layout tags we are about to describe.
25967 As mentioned earlier, however, \SpecialChar LyX
25968 uses sensible defaults for many of these,
25969 so you often may not need to do very much to get good XHTML output.
25970 Think of the available tags as there so you can tweak things to your liking.
25973 \begin_layout Description
25974 \begin_inset Flex Code
25977 \begin_layout Plain Layout
25984 \begin_inset Flex Code
25987 \begin_layout Plain Layout
25993 ] Specifies attribute information to be output with the main tag.
25995 \begin_inset Quotes eld
25999 \begin_inset Flex Code
26002 \begin_layout Plain Layout
26009 \begin_inset Quotes erd
26013 By default, \SpecialChar LyX
26015 \begin_inset Quotes eld
26019 \begin_inset Flex Code
26022 \begin_layout Plain Layout
26029 \begin_inset Quotes erd
26033 \begin_inset Flex Code
26036 \begin_layout Plain Layout
26042 is the \SpecialChar LyX
26043 name of the layout, made lowercase, for example: chapter.
26048 contain any style information.
26050 \begin_inset Flex Code
26053 \begin_layout Plain Layout
26062 \begin_layout Description
26063 \begin_inset Flex Code
26066 \begin_layout Plain Layout
26073 \begin_inset Flex Code
26076 \begin_layout Plain Layout
26086 ] Whether to output the default CSS information \SpecialChar LyX
26087 generates for this layout,
26088 even if additional information is explicitly provided via
26089 \begin_inset Flex Code
26092 \begin_layout Plain Layout
26100 \begin_inset Flex Code
26103 \begin_layout Plain Layout
26109 allows you to alter or augment the generated CSS, rather than to override
26112 \begin_inset Flex Code
26115 \begin_layout Plain Layout
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 ] The tag to be used for individual paragraphs of environments, replacing
26146 \begin_inset Flex Code
26149 \begin_layout Plain Layout
26155 in the examples above.
26157 \begin_inset Flex Code
26160 \begin_layout Plain Layout
26169 \begin_layout Description
26170 \begin_inset Flex Code
26173 \begin_layout Plain Layout
26180 \begin_inset Flex Code
26183 \begin_layout Plain Layout
26189 ] Attributes for the item tag.
26191 \begin_inset Newline newline
26195 \begin_inset Quotes eld
26199 \begin_inset Flex Code
26202 \begin_layout Plain Layout
26203 class=`layoutname_item'
26209 \begin_inset Quotes erd
26217 contain any style information.
26219 \begin_inset Flex Code
26222 \begin_layout Plain Layout
26231 \begin_layout Description
26232 \begin_inset Flex Code
26235 \begin_layout Plain Layout
26242 \begin_inset Flex Code
26245 \begin_layout Plain Layout
26251 ] The tag to be used for paragraph and item labels, replacing
26252 \begin_inset Flex Code
26255 \begin_layout Plain Layout
26261 in the examples above.
26263 \begin_inset Flex Code
26266 \begin_layout Plain Layout
26273 \begin_inset Flex Code
26276 \begin_layout Plain Layout
26283 \begin_inset Flex Code
26286 \begin_layout Plain Layout
26293 \begin_inset Flex Code
26296 \begin_layout Plain Layout
26297 Centered_Top_Environment
26302 , in which case it defaults to
26303 \begin_inset Flex Code
26306 \begin_layout Plain Layout
26315 \begin_layout Description
26316 \begin_inset Flex Code
26319 \begin_layout Plain Layout
26326 \begin_inset Flex Code
26329 \begin_layout Plain Layout
26335 ] Attributes for the label tag.
26337 \begin_inset Newline newline
26341 \begin_inset Quotes eld
26345 \begin_inset Flex Code
26348 \begin_layout Plain Layout
26349 class=`layoutname_label'
26355 \begin_inset Quotes erd
26363 contain any style information.
26365 \begin_inset Flex Code
26368 \begin_layout Plain Layout
26377 \begin_layout Description
26378 \begin_inset Flex Code
26381 \begin_layout Plain Layout
26388 \begin_inset Flex Code
26391 \begin_layout Plain Layout
26401 ] Meaningful only for list-like environments, this tag controls whether
26402 the label tag is output before or inside the item tag.
26403 This is used, for example, in the description environment, where we want
26405 \begin_inset Flex Code
26408 \begin_layout Plain Layout
26409 <dt>\SpecialChar ldots
26410 </dt><dd>\SpecialChar ldots
26418 \begin_inset Flex Code
26421 \begin_layout Plain Layout
26427 : The label tag is output inside the item tag.
26430 \begin_layout Description
26431 \begin_inset Flex Code
26434 \begin_layout Plain Layout
26440 Information to be output in the
26441 \begin_inset Flex Code
26444 \begin_layout Plain Layout
26450 section when this style is used.
26451 This might, for example, be used to include a
26452 \begin_inset Flex Code
26455 \begin_layout Plain Layout
26462 \begin_inset Flex Code
26465 \begin_layout Plain Layout
26474 \begin_layout Description
26475 \begin_inset Flex Code
26478 \begin_layout Plain Layout
26484 CSS style information to be included when this style is used.
26485 Note that this will automatically be wrapped in a layout-generated
26486 \begin_inset Flex Code
26489 \begin_layout Plain Layout
26495 block, so only the CSS itself need be included.
26497 \begin_inset Flex Code
26500 \begin_layout Plain Layout
26509 \begin_layout Description
26510 \begin_inset Flex Code
26513 \begin_layout Plain Layout
26520 \begin_inset Flex Code
26523 \begin_layout Plain Layout
26529 ] The tag to be used for the main label, replacing
26530 \begin_inset Flex Code
26533 \begin_layout Plain Layout
26539 in the examples above.
26541 \begin_inset Flex Code
26544 \begin_layout Plain Layout
26553 \begin_layout Description
26554 \begin_inset Flex Code
26557 \begin_layout Plain Layout
26564 \begin_inset Flex Code
26567 \begin_layout Plain Layout
26577 ] Marks this style as the one to be used to generate the
26578 \begin_inset Flex Code
26581 \begin_layout Plain Layout
26587 tag for the XHTML file.
26588 By default, it is false.
26590 \begin_inset Flex Code
26593 \begin_layout Plain Layout
26599 file sets it to true for the
26600 \begin_inset Flex Code
26603 \begin_layout Plain Layout
26613 \begin_layout Subsection
26617 \begin_layout Standard
26618 The XHTML output of insets can also be controlled by information in layout
26623 \begin_layout Plain Layout
26624 At present, this is true only for
26625 \begin_inset Quotes eld
26629 \begin_inset Quotes erd
26632 insets (insets you can type into) and is not true for
26633 \begin_inset Quotes eld
26637 \begin_inset Quotes erd
26640 insets (insets that are associated with dialog boxes).
26645 Here, too, \SpecialChar LyX
26646 tries to provide sensible defaults, and it constructs default
26648 But everything can be customized.
26651 \begin_layout Standard
26652 The XHTML \SpecialChar LyX
26653 outputs for an inset has the following form:
26656 \begin_layout LyX-Code
26658 \begin_inset Quotes erd
26662 \begin_inset Quotes erd
26668 \begin_layout LyX-Code
26669 <labeltag>Label</labeltag>
26672 \begin_layout LyX-Code
26674 \begin_inset Quotes erd
26678 \begin_inset Quotes erd
26681 >Contents of the inset.</innertag>
26684 \begin_layout LyX-Code
26688 \begin_layout Standard
26689 If the inset permits multiple paragraphs—that is, if
26690 \begin_inset Flex Code
26693 \begin_layout Plain Layout
26699 is true—then the contents of the inset will itself be output as paragraphs
26700 formatted according to the styles used for those paragraphs (standard,
26701 quote, and the like).
26702 The label tag is of course omitted if the paragraph does not have a label
26703 and, at present, is always
26704 \begin_inset Flex Code
26707 \begin_layout Plain Layout
26714 The inner tag is optional and, by default, does not appear.
26717 \begin_layout Standard
26718 The specific tags and attributes output for each inset can be controlled
26719 by means of the following layout tags.
26722 \begin_layout Description
26723 \begin_inset Flex Code
26726 \begin_layout Plain Layout
26733 \begin_inset Flex Code
26736 \begin_layout Plain Layout
26742 ] Specifies attribute information to be output with the main tag.
26744 \begin_inset Quotes eld
26748 \begin_inset Flex Code
26751 \begin_layout Plain Layout
26752 class=`myinset' onclick=`\SpecialChar ldots
26759 \begin_inset Quotes erd
26763 By default, \SpecialChar LyX
26765 \begin_inset Quotes eld
26769 \begin_inset Flex Code
26772 \begin_layout Plain Layout
26779 \begin_inset Quotes erd
26783 \begin_inset Flex Code
26786 \begin_layout Plain Layout
26792 is the \SpecialChar LyX
26793 name of the inset, made lowercase and with non-alphanumeric characters
26794 converted to underscores, for example: footnote.
26797 \begin_layout Description
26798 \begin_inset Flex Code
26801 \begin_layout Plain Layout
26808 \begin_inset Flex Code
26811 \begin_layout Plain Layout
26821 ] Whether to output the default CSS information \SpecialChar LyX
26822 generates for this layout,
26823 even if additional information is explicitly provided via
26824 \begin_inset Flex Code
26827 \begin_layout Plain Layout
26835 \begin_inset Flex Code
26838 \begin_layout Plain Layout
26844 allows you to alter or augment the generated CSS, rather than to override
26849 \begin_layout Description
26850 \begin_inset Flex Code
26853 \begin_layout Plain Layout
26860 \begin_inset Flex Code
26863 \begin_layout Plain Layout
26869 ] Attributes for the inner tag.
26871 \begin_inset Newline newline
26875 \begin_inset Quotes eld
26879 \begin_inset Flex Code
26882 \begin_layout Plain Layout
26883 class=`insetname_inner'
26889 \begin_inset Quotes erd
26895 \begin_layout Description
26896 \begin_inset Flex Code
26899 \begin_layout Plain Layout
26906 \begin_inset Flex Code
26909 \begin_layout Plain Layout
26915 ] The inner tag, replacing
26916 \begin_inset Flex Code
26919 \begin_layout Plain Layout
26925 in the examples above.
26926 By default, there is none.
26929 \begin_layout Description
26930 \begin_inset Flex Code
26933 \begin_layout Plain Layout
26940 \begin_inset Flex Code
26943 \begin_layout Plain Layout
26951 ] Whether this inset represents a standalone block of text (such as a footnote)
26952 or instead represents material that is included in the surrounding text
26953 (such as a branch).
26957 \begin_layout Description
26958 \begin_inset Flex Code
26961 \begin_layout Plain Layout
26968 \begin_inset Flex Code
26971 \begin_layout Plain Layout
26977 ] A label for this inset, possibly including a reference to a counter.
26978 For example, for footnote, it might be:
26979 \begin_inset Flex Code
26982 \begin_layout Plain Layout
26991 This is optional, and there is no default.
26994 \begin_layout Description
26995 \begin_inset Flex Code
26998 \begin_layout Plain Layout
27004 Information to be output in the
27005 \begin_inset Flex Code
27008 \begin_layout Plain Layout
27014 section when this style is used.
27015 This might, for example, be used to include a
27016 \begin_inset Flex Code
27019 \begin_layout Plain Layout
27026 \begin_inset Flex Code
27029 \begin_layout Plain Layout
27038 \begin_layout Description
27039 \begin_inset Flex Code
27042 \begin_layout Plain Layout
27048 CSS style information to be included when this style is used.
27049 Note that this will automatically be wrapped in a layout-generated
27050 \begin_inset Flex Code
27053 \begin_layout Plain Layout
27059 block, so only the CSS itself need be included.
27062 \begin_layout Description
27063 \begin_inset Flex Code
27066 \begin_layout Plain Layout
27073 \begin_inset Flex Code
27076 \begin_layout Plain Layout
27082 ] The tag to be used for the main label, replacing
27083 \begin_inset Flex Code
27086 \begin_layout Plain Layout
27092 in the examples above.
27093 The default depends upon the setting of
27094 \begin_inset Flex Code
27097 \begin_layout Plain Layout
27104 \begin_inset Flex Code
27107 \begin_layout Plain Layout
27113 is true, the default is
27114 \begin_inset Flex Code
27117 \begin_layout Plain Layout
27123 ; if it is false, the default is
27124 \begin_inset Flex Code
27127 \begin_layout Plain Layout
27136 \begin_layout Subsection
27140 \begin_layout Standard
27141 The XHTML output for floats too can be controlled by layout information.
27142 The output has the following form:
27145 \begin_layout LyX-Code
27147 \begin_inset Quotes erd
27151 \begin_inset Quotes erd
27157 \begin_layout LyX-Code
27158 Contents of the float.
27161 \begin_layout LyX-Code
27165 \begin_layout Standard
27166 The caption, if there is one, is a separate inset and will be output as
27168 Its appearance can be controlled via the InsetLayout for caption insets.
27172 \begin_layout Description
27173 \begin_inset Flex Code
27176 \begin_layout Plain Layout
27183 \begin_inset Flex Code
27186 \begin_layout Plain Layout
27192 ] Specifies attribute information to be output with the main tag.
27194 \begin_inset Quotes eld
27198 \begin_inset Flex Code
27201 \begin_layout Plain Layout
27202 class=`myfloat' onclick=`\SpecialChar ldots
27209 \begin_inset Quotes erd
27213 By default, \SpecialChar LyX
27215 \begin_inset Quotes eld
27219 \begin_inset Flex Code
27222 \begin_layout Plain Layout
27223 class=`float float-floattype'
27229 \begin_inset Quotes erd
27233 \begin_inset Flex Code
27236 \begin_layout Plain Layout
27242 is \SpecialChar LyX
27243 's name for this type of float, as determined by the float declaration
27245 \begin_inset CommandInset ref
27247 reference "subsec:Floats"
27251 ), though made lowercase and with non-alphanumeric characters converted
27252 to underscores, for example: float-table.
27255 \begin_layout Description
27256 \begin_inset Flex Code
27259 \begin_layout Plain Layout
27265 CSS style information to be included when this float is used.
27266 Note that this will automatically be wrapped in a layout-generated
27267 \begin_inset Flex Code
27270 \begin_layout Plain Layout
27276 block, so only the CSS itself need be included.
27279 \begin_layout Description
27280 \begin_inset Flex Code
27283 \begin_layout Plain Layout
27290 \begin_inset Flex Code
27293 \begin_layout Plain Layout
27299 ] The tag to be used for this float, replacing
27300 \begin_inset Quotes eld
27304 \begin_inset Flex Code
27307 \begin_layout Plain Layout
27314 \begin_inset Quotes erd
27317 in the example above.
27319 \begin_inset Flex Code
27322 \begin_layout Plain Layout
27328 and will rarely need changing.
27331 \begin_layout Subsection
27332 Bibliography formatting
27335 \begin_layout Standard
27336 The bibliography can be formatted using
27337 \begin_inset Flex Code
27340 \begin_layout Plain Layout
27348 \begin_inset CommandInset ref
27350 reference "subsec:Citation-format-description"
27357 \begin_layout Subsection
27362 \begin_layout Standard
27363 We have several times mentioned that \SpecialChar LyX
27364 will generate default CSS style rules
27365 for both insets and paragraph styles, based upon the other layout information
27367 In this section, we shall say a word about which layout information \SpecialChar LyX
27372 \begin_layout Standard
27373 At present, \SpecialChar LyX
27374 auto-generates CSS only for font information, making use of
27376 \begin_inset Flex Code
27379 \begin_layout Plain Layout
27386 \begin_inset Flex Code
27389 \begin_layout Plain Layout
27396 \begin_inset Flex Code
27399 \begin_layout Plain Layout
27406 \begin_inset Flex Code
27409 \begin_layout Plain Layout
27416 \begin_inset Flex Code
27419 \begin_layout Plain Layout
27426 \begin_inset CommandInset ref
27428 reference "subsec:Font-description"
27433 The translation is mostly straightforward and obvious.
27435 \begin_inset Quotes eld
27439 \begin_inset Flex Code
27442 \begin_layout Plain Layout
27449 \begin_inset Quotes erd
27453 \begin_inset Quotes eld
27457 \begin_inset Flex Code
27460 \begin_layout Plain Layout
27461 font-family: sans-serif;
27467 \begin_inset Quotes erd
27471 The correspondence of \SpecialChar LyX
27472 sizes and CSS sizes is a little less obvious but
27473 nonetheless intuitive.
27475 \begin_inset Flex Code
27478 \begin_layout Plain Layout
27485 \begin_inset Flex URL
27488 \begin_layout Plain Layout
27496 \change_inserted -970929547 1496610908
27500 \begin_layout Section
27502 \change_inserted -970929547 1496610966
27503 \begin_inset CommandInset label
27505 name "sec:Tags-for-DocBook"
27509 Tags for DocBook output
27512 \begin_layout Standard
27514 \change_inserted -970929547 1496611615
27515 As with \SpecialChar LaTeX
27516 or XHTML, the format of \SpecialChar LyX
27517 's DocBook output is also controlled by
27518 layout information.
27519 In general, \SpecialChar LyX
27520 provides sensible defaults; however, much of the styling is
27521 lost during the conversion, as DocBook is strictly semantic and does not
27523 When possible, information from \SpecialChar LyX
27524 will be rendered in
27532 \begin_layout Standard
27534 \change_inserted -970929547 1496612080
27535 In many cases, then, you may not have to do anything at all to get acceptable
27536 DocBook output for your own environments, custom insets, and so forth.
27537 But in some cases you will, and so \SpecialChar LyX
27538 provides a number of layout tags that
27539 can be used to customize the DocBook that is generated.
27542 \begin_layout Standard
27544 \change_inserted -970929547 1515109912
27545 Labels are rarely output, as they are redundant in DocBook: this information
27546 is carried by the tags themselves, and whether labels appear in the final
27547 documents (after processing of DocBook files) is controlled by the stylesheets.
27548 However, sometimes, labels are not redundant content, such as definition
27549 lists: in this case, the term being defined will be the label.
27553 \begin_layout Subsection
27555 \change_inserted 1075283030 1597699417
27556 \begin_inset CommandInset label
27558 name "subsec:Paragraph-Style-DocBook"
27563 \change_deleted 1075283030 1597699417
27565 \begin_inset CommandInset label
27567 name "subsec:Paragraph-Style-XHTML-1"
27572 \change_inserted -970929547 1496610966
27576 \begin_layout Standard
27578 \change_inserted -970929547 1496612059
27579 The sort of DocBook \SpecialChar LyX
27580 outputs for a paragraph depends upon whether we are
27581 dealing with a normal paragraph, a command, or an environment, where this
27582 is itself determined by the contents of the corresponding
27583 \begin_inset Flex Code
27586 \begin_layout Plain Layout
27588 \change_inserted -970929547 1496610966
27601 \begin_layout Standard
27603 \change_inserted -970929547 1496612107
27604 For a command or normal paragraph, the output DocBook has the following
27608 \begin_layout LyX-Code
27610 \change_inserted -970929547 1515109666
27614 \begin_layout LyX-Code
27616 \change_inserted -970929547 1496610966
27617 Contents of the paragraph.
27620 \begin_layout LyX-Code
27622 \change_inserted -970929547 1496610966
27626 \begin_layout Standard
27628 \change_inserted -970929547 1515109821
27629 For an environment that is not some sort of list, the generated DocBook
27633 \begin_layout LyX-Code
27635 \change_inserted -970929547 1515109671
27639 \begin_layout LyX-Code
27641 \change_inserted -970929547 1496612114
27642 <itemtag>First paragraph.</itemtag>
27645 \begin_layout LyX-Code
27647 \change_inserted -970929547 1496610966
27648 <itemtag>Second paragraph.</itemtag>
27651 \begin_layout LyX-Code
27653 \change_inserted -970929547 1496610966
27657 \begin_layout Standard
27659 \change_inserted -970929547 1515109825
27660 For a list, the resulting DocBook takes this form:
27663 \begin_layout LyX-Code
27665 \change_inserted -970929547 1515109672
27669 \begin_layout LyX-Code
27671 \change_inserted -970929547 1515109676
27672 <itemtag attr>First item.</itemtag>
27675 \begin_layout LyX-Code
27677 \change_inserted -970929547 1515109678
27678 <itemtag attr>Second item.</itemtag>
27681 \begin_layout LyX-Code
27683 \change_inserted -970929547 1496610966
27687 \begin_layout Standard
27689 \change_inserted -970929547 1496612243
27690 The specific tags and roles output for each paragraph type can be controlled
27691 by means of the layout tags we are about to describe.
27692 Please note that, due to the very nature of DocBook, no sensible defaults
27693 really exist, and the values must always be carefully chosen.
27697 \begin_layout Description
27699 \change_inserted -970929547 1515110057
27700 \begin_inset Flex Code
27703 \begin_layout Plain Layout
27705 \change_inserted -970929547 1515109656
27714 \begin_inset Flex Code
27717 \begin_layout Plain Layout
27719 \change_inserted -970929547 1496610966
27727 ] Specifies attribute information to be output with the main tag, replacing
27729 \begin_inset Quotes eld
27733 \begin_inset Flex Code
27736 \begin_layout Plain Layout
27738 \change_inserted -970929547 1515110057
27747 \begin_inset Quotes erd
27750 in the example above.
27751 This information can be used in further processing of the DocBook files.
27757 \begin_layout Description
27759 \change_inserted -970929547 1496612296
27760 \begin_inset Flex Code
27763 \begin_layout Plain Layout
27765 \change_inserted -970929547 1496612269
27774 \begin_inset Flex Code
27777 \begin_layout Plain Layout
27779 \change_inserted -970929547 1496610966
27787 ] The tag to be used for this inset, replacing
27788 \begin_inset Quotes eld
27792 \begin_inset Flex Code
27795 \begin_layout Plain Layout
27797 \change_inserted -970929547 1496612296
27806 \begin_inset Quotes erd
27809 in the example above.
27810 The default is the name of the float and always needs to be changed, as
27811 DocBook provides no generic tag.
27812 \change_inserted 1075283030 1597698868
27816 \begin_layout Description
27818 \change_inserted 1075283030 1597699399
27819 \begin_inset Flex Code
27822 \begin_layout Plain Layout
27824 \change_inserted 1075283030 1597698872
27833 \begin_inset Flex Code
27836 \begin_layout Plain Layout
27838 \change_inserted 1075283030 1597700585
27839 block, paragraph, inline
27846 ] The new-line policy for this tag, see Section
27847 \begin_inset space ~
27851 \begin_inset CommandInset ref
27853 reference "subsec:DocBook-New-line-policy"
27866 \begin_layout Subsection
27868 \change_inserted 1075283030 1597699385
27870 \begin_inset CommandInset label
27872 name "subsec:DocBook-New-line-policy"
27879 \begin_layout Standard
27881 \change_inserted 1075283030 1597698993
27882 For all tags, there are three possible policies for outputting new lines
27884 \begin_inset Flex Code
27887 \begin_layout Plain Layout
27889 \change_inserted 1075283030 1597698987
27900 \begin_layout Itemize
27902 \change_inserted 1075283030 1597699279
27903 \begin_inset Quotes eld
27907 \begin_inset Flex Code
27910 \begin_layout Plain Layout
27912 \change_inserted 1075283030 1597699012
27921 \begin_inset Quotes erd
27924 : the opening and closing tags are on their own lines (i.e.
27925 a line feed after and before the opening and the closing tags).
27926 Typical elements are floats.
27930 \begin_layout LyX-Code
27932 \change_inserted 1075283030 1597699194
27936 \begin_layout LyX-Code
27938 \change_inserted 1075283030 1597699194
27942 \begin_layout LyX-Code
27944 \change_inserted 1075283030 1597699098
27945 Contents of the block.
27948 \begin_layout LyX-Code
27950 \change_inserted 1075283030 1597699196
27954 \begin_layout LyX-Code
27956 \change_inserted 1075283030 1597699198
27960 \begin_layout Itemize
27962 \change_inserted 1075283030 1597699289
27963 \begin_inset Quotes eld
27967 \begin_inset Flex Code
27970 \begin_layout Plain Layout
27972 \change_inserted 1075283030 1597699113
27981 \begin_inset Quotes erd
27984 : the opening and closing tags are on the same, new line; a line feed is
27985 output before the opening tag and after the closing tag.
27986 Typical elements are paragraphs and list items.
27990 \begin_layout LyX-Code
27992 \change_inserted 1075283030 1597699186
27996 \begin_layout LyX-Code
27998 \change_inserted 1075283030 1597699357
27999 <paratag>Contents of the paragraph.</paratag>
28002 \begin_layout LyX-Code
28004 \change_inserted 1075283030 1597699231
28008 \begin_layout Itemize
28010 \change_inserted 1075283030 1597699343
28011 \begin_inset Quotes eld
28015 \begin_inset Flex Code
28018 \begin_layout Plain Layout
28020 \change_inserted 1075283030 1597699307
28029 \begin_inset Quotes erd
28032 : the opening and closing tags are on the same line as the rest of the content.
28033 No line feeds are output.
28034 Typical elements are fonts.
28038 \begin_layout LyX-Code
28040 \change_inserted 1075283030 1597699585
28041 Content before<inlinetag>Contents of the paragraph.</inlinetag>Content after
28044 \begin_layout Standard
28046 \change_inserted 1075283030 1597699585
28047 The default value is always
28048 \begin_inset Quotes eld
28052 \begin_inset Flex Code
28055 \begin_layout Plain Layout
28057 \change_inserted 1075283030 1597699585
28066 \begin_inset Quotes erd
28074 \begin_layout Subsection
28076 \change_inserted -970929547 1515111533
28077 InsetLayout DocBook
28082 \begin_layout Standard
28084 \change_inserted -970929547 1496611894
28085 The DocBook output of insets can also be controlled by information in layout
28089 \begin_layout Standard
28091 \change_inserted -970929547 1496612045
28092 The DocBook \SpecialChar LyX
28093 outputs for an inset has the following form:
28096 \begin_layout LyX-Code
28098 \change_inserted -970929547 1515110861
28099 <wrappertag wrapperattr>
28102 \begin_layout LyX-Code
28104 \change_inserted -970929547 1515110868
28108 \begin_layout LyX-Code
28110 \change_inserted -970929547 1515110869
28111 <innertag innerattr>
28114 \begin_layout LyX-Code
28116 \change_inserted -970929547 1515110869
28117 Contents of the inset.
28120 \begin_layout LyX-Code
28122 \change_inserted -970929547 1515110870
28126 \begin_layout LyX-Code
28128 \change_inserted -970929547 1515110871
28132 \begin_layout LyX-Code
28134 \change_inserted -970929547 1515111172
28138 \begin_layout Standard
28140 \change_inserted -970929547 1515111186
28141 For an itemising inset, it rather looks like this:
28144 \begin_layout LyX-Code
28146 \change_inserted -970929547 1515111186
28147 <wrappertag wrapperattr>
28150 \begin_layout LyX-Code
28152 \change_inserted -970929547 1515111186
28156 \begin_layout LyX-Code
28158 \change_inserted -970929547 1515111186
28159 <innertag innerattr>
28162 \begin_layout LyX-Code
28164 \change_inserted -970929547 1515111362
28165 <itemwrappertag itemwrapperattr>
28168 \begin_layout LyX-Code
28170 \change_inserted -970929547 1515111364
28171 <itemlabeltag itemattr>
28174 \begin_layout LyX-Code
28176 \change_inserted -970929547 1515111367
28177 Label of the first item.
28180 \begin_layout LyX-Code
28182 \change_inserted -970929547 1515111362
28188 \begin_layout LyX-Code
28190 \change_inserted -970929547 1515111517
28194 \begin_layout LyX-Code
28196 \change_inserted -970929547 1515111517
28202 \begin_layout LyX-Code
28204 \change_inserted -970929547 1515111516
28205 Contents of the first item.
28208 \begin_layout LyX-Code
28210 \change_inserted -970929547 1515111514
28216 \begin_layout LyX-Code
28218 \change_inserted -970929547 1515111247
28224 \begin_layout LyX-Code
28226 \change_inserted -970929547 1515111221
28230 \begin_layout LyX-Code
28232 \change_inserted -970929547 1515111370
28233 <itemwrappertag itemwrapperattr>
28236 \begin_layout LyX-Code
28238 \change_inserted -970929547 1515111370
28239 <itemlabeltag itemattr>
28242 \begin_layout LyX-Code
28244 \change_inserted -970929547 1515111372
28245 Label of the second item.
28248 \begin_layout LyX-Code
28250 \change_inserted -970929547 1515111370
28256 \begin_layout LyX-Code
28258 \change_inserted -970929547 1515111504
28262 \begin_layout LyX-Code
28264 \change_inserted -970929547 1515111505
28270 \begin_layout LyX-Code
28272 \change_inserted -970929547 1515111507
28273 Contents of the second item.
28276 \begin_layout LyX-Code
28278 \change_inserted -970929547 1515111509
28284 \begin_layout LyX-Code
28286 \change_inserted -970929547 1515111251
28292 \begin_layout LyX-Code
28294 \change_inserted -970929547 1515111221
28300 \begin_layout LyX-Code
28302 \change_inserted -970929547 1515111219
28308 \begin_layout LyX-Code
28310 \change_inserted -970929547 1515111186
28314 \begin_layout LyX-Code
28316 \change_inserted -970929547 1515111186
28320 \begin_layout LyX-Code
28322 \change_inserted -970929547 1515111186
28326 \begin_layout Standard
28328 \change_inserted -970929547 1515111183
28329 If the inset permits multiple paragraphs—that is, if
28330 \begin_inset Flex Code
28333 \begin_layout Plain Layout
28335 \change_inserted -970929547 1496610966
28343 is true—then the contents of the inset will itself be output as paragraphs
28344 formatted according to the styles used for those paragraphs (standard,
28345 quote, and the like).
28346 The inner tag is optional and, by default, does not appear.
28349 \begin_layout Standard
28351 \change_inserted -970929547 1496610966
28352 The specific tags and attributes output for each inset can be controlled
28353 by means of the following layout tags.
28356 \begin_layout Description
28358 \change_inserted -970929547 1515110317
28359 \begin_inset Flex Code
28362 \begin_layout Plain Layout
28364 \change_inserted -970929547 1515109695
28373 \begin_inset Flex Code
28376 \begin_layout Plain Layout
28378 \change_inserted -970929547 1496611854
28386 ] Specifies attribute information to be output with the main tag, replacing
28388 \begin_inset Quotes eld
28392 \begin_inset Flex Code
28395 \begin_layout Plain Layout
28397 \change_inserted -970929547 1515110044
28406 \begin_inset Quotes erd
28409 in the example above.
28410 This information can be used in further processing of the DocBook files.
28414 \begin_layout Description
28416 \change_inserted -970929547 1515110973
28417 \begin_inset Flex Code
28420 \begin_layout Plain Layout
28422 \change_inserted -970929547 1515110319
28431 \begin_inset Flex Code
28434 \begin_layout Plain Layout
28436 \change_inserted -970929547 1515110384
28437 never, always, maybe
28444 ] Specifies whether this tag goes into the
28445 \begin_inset Flex Code
28448 \begin_layout Plain Layout
28450 \change_inserted -970929547 1515110412
28458 tag at the beginning of the parent layout.
28460 \begin_inset Flex Code
28463 \begin_layout Plain Layout
28465 \change_inserted -970929547 1515110437
28473 indicates that the tag never goes into
28474 \begin_inset Flex Code
28477 \begin_layout Plain Layout
28479 \change_inserted -970929547 1515110497
28487 (this is default value, and corresponds to usual content).
28489 \begin_inset Flex Code
28492 \begin_layout Plain Layout
28494 \change_inserted -970929547 1515110517
28502 indicates that the tag always goes into
28503 \begin_inset Flex Code
28506 \begin_layout Plain Layout
28508 \change_inserted -970929547 1515110514
28516 (this corresponds to usual metadata): if there is no
28517 \begin_inset Flex Code
28520 \begin_layout Plain Layout
28522 \change_inserted -970929547 1515110550
28530 tag for the parent, one
28536 \begin_inset Flex Code
28539 \begin_layout Plain Layout
28541 \change_inserted -970929547 1515110540
28549 indicates that the tag may go into
28550 \begin_inset Flex Code
28553 \begin_layout Plain Layout
28555 \change_inserted -970929547 1515110538
28563 (this is only the case for titles): if there is no
28564 \begin_inset Flex Code
28567 \begin_layout Plain Layout
28569 \change_inserted -970929547 1515110585
28577 tag for the parent,
28581 will be generated, the corresponding tag will be output directly as content.
28585 \begin_layout Description
28587 \change_inserted -970929547 1515111461
28588 \begin_inset Flex Code
28591 \begin_layout Plain Layout
28593 \change_inserted -970929547 1515110974
28602 \begin_inset Flex Code
28605 \begin_layout Plain Layout
28607 \change_inserted -970929547 1515110973
28615 ] Specifies attribute information to be output with the item tag, replacing
28617 \begin_inset Quotes eld
28621 \begin_inset Flex Code
28624 \begin_layout Plain Layout
28626 \change_inserted -970929547 1515110984
28635 \begin_inset Quotes erd
28638 in the example above.
28639 This information can be used in further processing of the DocBook files.
28643 \begin_layout Description
28645 \change_inserted -970929547 1515111471
28646 \begin_inset Flex Code
28649 \begin_layout Plain Layout
28651 \change_inserted -970929547 1515111465
28652 DocBookItemInnerAttr
28660 \begin_inset Flex Code
28663 \begin_layout Plain Layout
28665 \change_inserted -970929547 1515111461
28673 ] Specifies attribute information to be output with the item inner tag,
28675 \begin_inset Quotes eld
28679 \begin_inset Flex Code
28682 \begin_layout Plain Layout
28684 \change_inserted -970929547 1515111476
28693 \begin_inset Quotes erd
28696 in the example above.
28697 This information can be used in further processing of the DocBook files.
28701 \begin_layout Description
28703 \change_inserted -970929547 1515111494
28704 \begin_inset Flex Code
28707 \begin_layout Plain Layout
28709 \change_inserted -970929547 1515111467
28710 DocBookItemInnerTag
28718 \begin_inset Flex Code
28721 \begin_layout Plain Layout
28723 \change_inserted -970929547 1515111461
28731 ] The tag to be used for the item inner tag within the inset, replacing
28733 \begin_inset Quotes eld
28737 \begin_inset Flex Code
28740 \begin_layout Plain Layout
28742 \change_inserted -970929547 1515111486
28751 \begin_inset Quotes erd
28754 in the example above.
28756 \begin_inset Flex Code
28759 \begin_layout Plain Layout
28761 \change_inserted -970929547 1515111461
28769 , indicating that there is no item inner tag: content is directly output
28770 without it for each itemised element.
28771 This parameter only makes sense when itemising layouts are used, such as
28774 \change_inserted 1075283030 1598469472
28775 The most likely value is
28776 \begin_inset Quotes eld
28780 \begin_inset Flex Code
28783 \begin_layout Plain Layout
28785 \change_inserted 1075283030 1598469476
28794 \begin_inset Quotes erd
28798 \begin_inset Newline newline
28801 When a list item is split using a new line, the item inner tag will be repeated
28802 for each part of the paragraph, parts being separated by new lines.
28806 \begin_layout Description
28808 \change_inserted 1075283030 1597699866
28809 \begin_inset Flex Code
28812 \begin_layout Plain Layout
28814 \change_inserted 1075283030 1597699853
28815 DocBookItemInnerTagType
28823 \begin_inset Flex Code
28826 \begin_layout Plain Layout
28828 \change_inserted 1075283030 1597699866
28829 block, paragraph, inline
28836 ] The new-line policy for this tag, see Section
28837 \begin_inset space ~
28841 \begin_inset CommandInset ref
28843 reference "subsec:DocBook-New-line-policy"
28856 \begin_layout Description
28858 \change_inserted -970929547 1515111290
28859 \begin_inset Flex Code
28862 \begin_layout Plain Layout
28864 \change_inserted -970929547 1515111283
28865 DocBookItemLabelAttr
28873 \begin_inset Flex Code
28876 \begin_layout Plain Layout
28878 \change_inserted -970929547 1515111279
28886 ] Specifies attribute information to be output with the item label tag,
28888 \begin_inset Quotes eld
28892 \begin_inset Flex Code
28895 \begin_layout Plain Layout
28897 \change_inserted -970929547 1515111304
28906 \begin_inset Quotes erd
28909 in the example above.
28910 This information can be used in further processing of the DocBook files.
28914 \begin_layout Description
28916 \change_inserted -970929547 1515111337
28917 \begin_inset Flex Code
28920 \begin_layout Plain Layout
28922 \change_inserted -970929547 1515111285
28923 DocBookItemLabelTag
28931 \begin_inset Flex Code
28934 \begin_layout Plain Layout
28936 \change_inserted -970929547 1515111279
28944 ] The tag to be used for the item label tag within the inset, replacing
28946 \begin_inset Quotes eld
28950 \begin_inset Flex Code
28953 \begin_layout Plain Layout
28955 \change_inserted -970929547 1515111311
28964 \begin_inset Quotes erd
28967 in the example above.
28968 This parameter only makes sense when itemising layouts are used with a
28969 notion of labels, such as definition lists.
28971 \change_inserted 1075283030 1597699874
28975 \begin_layout Description
28977 \change_inserted 1075283030 1597699874
28978 \begin_inset Flex Code
28981 \begin_layout Plain Layout
28983 \change_inserted 1075283030 1597699880
28984 DocBookItemLabelTagType
28992 \begin_inset Flex Code
28995 \begin_layout Plain Layout
28997 \change_inserted 1075283030 1597699874
28998 block, paragraph, inline
29005 ] The new-line policy for this tag, see Section
29006 \begin_inset space ~
29010 \begin_inset CommandInset ref
29012 reference "subsec:DocBook-New-line-policy"
29025 \begin_layout Description
29027 \change_inserted -970929547 1515111124
29028 \begin_inset Flex Code
29031 \begin_layout Plain Layout
29033 \change_inserted -970929547 1515111060
29042 \begin_inset Flex Code
29045 \begin_layout Plain Layout
29047 \change_inserted -970929547 1515111060
29055 ] The tag to be used for the item tag within the inset, replacing
29056 \begin_inset Quotes eld
29060 \begin_inset Flex Code
29063 \begin_layout Plain Layout
29065 \change_inserted -970929547 1515111060
29074 \begin_inset Quotes erd
29077 in the example above.
29079 \begin_inset Flex Code
29082 \begin_layout Plain Layout
29084 \change_inserted -970929547 1515111060
29092 , indicating that there is no item tag.
29093 This parameter only makes sense when itemising layouts are used, such as
29096 \change_inserted 1075283030 1597699890
29100 \begin_layout Description
29102 \change_inserted 1075283030 1597699890
29103 \begin_inset Flex Code
29106 \begin_layout Plain Layout
29108 \change_inserted 1075283030 1597699890
29117 \begin_inset Flex Code
29120 \begin_layout Plain Layout
29122 \change_inserted 1075283030 1597699890
29123 block, paragraph, inline
29130 ] The new-line policy for this tag, see Section
29131 \begin_inset space ~
29135 \begin_inset CommandInset ref
29137 reference "subsec:DocBook-New-line-policy"
29150 \begin_layout Description
29152 \change_inserted -970929547 1515111298
29153 \begin_inset Flex Code
29156 \begin_layout Plain Layout
29158 \change_inserted -970929547 1515111124
29159 DocBookItemWrapperAttr
29167 \begin_inset Flex Code
29170 \begin_layout Plain Layout
29172 \change_inserted -970929547 1515111124
29180 ] Specifies attribute information to be output with the item wrapper tag,
29182 \begin_inset Quotes eld
29186 \begin_inset Flex Code
29189 \begin_layout Plain Layout
29191 \change_inserted -970929547 1515111150
29200 \begin_inset Quotes erd
29203 in the example above.
29204 This information can be used in further processing of the DocBook files.
29210 \begin_layout Description
29212 \change_inserted -970929547 1515111113
29213 \begin_inset Flex Code
29216 \begin_layout Plain Layout
29218 \change_inserted -970929547 1515111073
29219 DocBookItemWrapperTag
29227 \begin_inset Flex Code
29230 \begin_layout Plain Layout
29232 \change_inserted -970929547 1515111073
29240 ] The tag to be used for the item wrapper tag within the inset, replacing
29242 \begin_inset Quotes eld
29246 \begin_inset Flex Code
29249 \begin_layout Plain Layout
29251 \change_inserted -970929547 1515111083
29260 \begin_inset Quotes erd
29263 in the example above.
29265 \begin_inset Flex Code
29268 \begin_layout Plain Layout
29270 \change_inserted -970929547 1515111073
29278 , indicating that there is no item wrapper tag: tag and content are directly
29279 output without it for each itemised element.
29280 This parameter only makes sense when itemising layouts are used, such as
29283 \change_inserted 1075283030 1597699897
29287 \begin_layout Description
29289 \change_inserted 1075283030 1597699897
29290 \begin_inset Flex Code
29293 \begin_layout Plain Layout
29295 \change_inserted 1075283030 1597699900
29296 DocBookItemWrapperTagType
29304 \begin_inset Flex Code
29307 \begin_layout Plain Layout
29309 \change_inserted 1075283030 1597699897
29310 block, paragraph, inline
29317 ] The new-line policy for this tag, see Section
29318 \begin_inset space ~
29322 \begin_inset CommandInset ref
29324 reference "subsec:DocBook-New-line-policy"
29337 \begin_layout Description
29339 \change_inserted -970929547 1515110104
29340 \begin_inset Flex Code
29343 \begin_layout Plain Layout
29345 \change_inserted -970929547 1515110104
29354 \begin_inset Flex Code
29357 \begin_layout Plain Layout
29359 \change_inserted -970929547 1515110104
29367 ] Specifies attribute information to be output with the inner tag, replacing
29369 \begin_inset Quotes eld
29373 \begin_inset Flex Code
29376 \begin_layout Plain Layout
29378 \change_inserted -970929547 1515110104
29387 \begin_inset Quotes erd
29390 in the example above.
29391 This information can be used in further processing of the DocBook files.
29395 \begin_layout Description
29397 \change_inserted -970929547 1515110906
29398 \begin_inset Flex Code
29401 \begin_layout Plain Layout
29403 \change_inserted -970929547 1515110104
29412 \begin_inset Flex Code
29415 \begin_layout Plain Layout
29417 \change_inserted -970929547 1515110104
29425 ] The tag to be used for the inner tag within the inset, replacing
29426 \begin_inset Quotes eld
29430 \begin_inset Flex Code
29433 \begin_layout Plain Layout
29435 \change_inserted -970929547 1515110104
29444 \begin_inset Quotes erd
29447 in the example above.
29449 \begin_inset Flex Code
29452 \begin_layout Plain Layout
29454 \change_inserted -970929547 1515110791
29462 , indicating that there is no inner tag: content is directly output without
29464 \change_inserted 1075283030 1597699904
29468 \begin_layout Description
29470 \change_inserted 1075283030 1597699904
29471 \begin_inset Flex Code
29474 \begin_layout Plain Layout
29476 \change_inserted 1075283030 1597699904
29477 DocBookInnerTagType
29485 \begin_inset Flex Code
29488 \begin_layout Plain Layout
29490 \change_inserted 1075283030 1597699904
29491 block, paragraph, inline
29498 ] The new-line policy for this tag, see Section
29499 \begin_inset space ~
29503 \begin_inset CommandInset ref
29505 reference "subsec:DocBook-New-line-policy"
29518 \begin_layout Description
29520 \change_inserted -970929547 1515110753
29521 \begin_inset Flex Code
29524 \begin_layout Plain Layout
29526 \change_inserted -970929547 1515110665
29535 \begin_inset Flex Code
29538 \begin_layout Plain Layout
29540 \change_inserted -970929547 1515110661
29548 ] Specifies the tag that corresponds to this kind of section.
29549 This parameter only makes sense for sectioning elements (part, chapter,
29551 The default value is
29552 \begin_inset Flex Code
29555 \begin_layout Plain Layout
29557 \change_inserted -970929547 1515110721
29565 , and is only overridden when DocBook uses something else for sectioning
29567 \change_inserted 1075283030 1597699921
29569 \change_inserted -970929547 1515110753
29570 parts and chapters of a book).
29576 \begin_layout Description
29578 \change_inserted -970929547 1515110811
29579 \begin_inset Flex Code
29582 \begin_layout Plain Layout
29584 \change_inserted -970929547 1496612023
29593 \begin_inset Flex Code
29596 \begin_layout Plain Layout
29598 \change_inserted -970929547 1496610966
29606 ] The tag to be used for this inset, replacing
29607 \begin_inset Quotes eld
29611 \begin_inset Flex Code
29614 \begin_layout Plain Layout
29616 \change_inserted -970929547 1496612033
29625 \begin_inset Quotes erd
29628 in the example above.
29629 The default is the name of the float and always needs to be changed, as
29630 DocBook provides no generic inset tag.
29631 \change_inserted 1075283030 1597699924
29635 \begin_layout Description
29637 \change_inserted 1075283030 1597699924
29638 \begin_inset Flex Code
29641 \begin_layout Plain Layout
29643 \change_inserted 1075283030 1597699924
29652 \begin_inset Flex Code
29655 \begin_layout Plain Layout
29657 \change_inserted 1075283030 1597699924
29658 block, paragraph, inline
29665 ] The new-line policy for this tag, see Section
29666 \begin_inset space ~
29670 \begin_inset CommandInset ref
29672 reference "subsec:DocBook-New-line-policy"
29685 \begin_layout Description
29687 \change_inserted -970929547 1515110832
29688 \begin_inset Flex Code
29691 \begin_layout Plain Layout
29693 \change_inserted -970929547 1515110822
29702 \begin_inset Flex Code
29705 \begin_layout Plain Layout
29707 \change_inserted -970929547 1515110811
29715 ] Specifies attribute information to be output with the outer tag, replacing
29717 \begin_inset Quotes eld
29721 \begin_inset Flex Code
29724 \begin_layout Plain Layout
29726 \change_inserted -970929547 1515110845
29735 \begin_inset Quotes erd
29738 in the example above.
29739 This information can be used in further processing of the DocBook files.
29743 \begin_layout Description
29745 \change_inserted -970929547 1515110917
29746 \begin_inset Flex Code
29749 \begin_layout Plain Layout
29751 \change_inserted -970929547 1515110826
29760 \begin_inset Flex Code
29763 \begin_layout Plain Layout
29765 \change_inserted -970929547 1515110811
29773 ] The tag to be used for the wrapper tag around the inset, replacing
29774 \begin_inset Quotes eld
29778 \begin_inset Flex Code
29781 \begin_layout Plain Layout
29783 \change_inserted -970929547 1515110842
29792 \begin_inset Quotes erd
29795 in the example above.
29797 \begin_inset Flex Code
29800 \begin_layout Plain Layout
29802 \change_inserted -970929547 1515110811
29810 , indicating that there is no wrapper tag: tag and content are directly
29812 \change_inserted 1075283030 1597699929
29816 \begin_layout Description
29818 \change_inserted 1075283030 1597699929
29819 \begin_inset Flex Code
29822 \begin_layout Plain Layout
29824 \change_inserted 1075283030 1597699932
29825 DocBookWrapperTagType
29833 \begin_inset Flex Code
29836 \begin_layout Plain Layout
29838 \change_inserted 1075283030 1597699929
29839 block, paragraph, inline
29846 ] The new-line policy for this tag, see Section
29847 \begin_inset space ~
29851 \begin_inset CommandInset ref
29853 reference "subsec:DocBook-New-line-policy"
29866 \begin_layout Subsection
29868 \change_inserted -970929547 1515110040
29872 \begin_layout Standard
29874 \change_inserted -970929547 1496611700
29875 The DocBook output for floats too can be controlled by layout information.
29876 The output has the following form:
29879 \begin_layout LyX-Code
29881 \change_inserted -970929547 1515109700
29885 \begin_layout LyX-Code
29887 \change_inserted -970929547 1515110138
29888 Contents of the float as DocBook.
29891 \begin_layout LyX-Code
29893 \change_inserted -970929547 1496610966
29897 \begin_layout Standard
29899 \change_inserted -970929547 1496611715
29900 The caption, if there is one, is a separate inset and will be output as
29905 \begin_layout Description
29907 \change_inserted -970929547 1515110033
29908 \begin_inset Flex Code
29911 \begin_layout Plain Layout
29913 \change_inserted -970929547 1515109702
29922 \begin_inset Flex Code
29925 \begin_layout Plain Layout
29927 \change_inserted -970929547 1496610966
29935 ] Specifies attribute information to be output with the main tag, replacing
29937 \begin_inset Quotes eld
29941 \begin_inset Flex Code
29944 \begin_layout Plain Layout
29946 \change_inserted -970929547 1515110035
29955 \begin_inset Quotes erd
29958 in the example above.
29959 This information can be used in further processing of the DocBook files.
29963 \begin_layout Description
29965 \change_inserted -970929547 1515110157
29966 \begin_inset Flex Code
29969 \begin_layout Plain Layout
29971 \change_inserted -970929547 1496611782
29980 \begin_inset Flex Code
29983 \begin_layout Plain Layout
29985 \change_inserted -970929547 1496610966
29993 ] The tag to be used for this float, replacing
29994 \begin_inset Quotes eld
29998 \begin_inset Flex Code
30001 \begin_layout Plain Layout
30003 \change_inserted -970929547 1496610966
30012 \begin_inset Quotes erd
30015 in the example above.
30016 The default is the name of the float and always needs to be changed, as
30017 DocBook provides no generic float tag.
30020 \begin_layout Subsection
30022 \change_inserted -970929547 1515110157
30023 Bibliography formatting
30026 \begin_layout Standard
30028 \change_deleted 1075283030 1597699984
30030 \change_inserted 1075283030 1597699985
30032 \change_inserted -970929547 1515110187
30034 \change_deleted 1075283030 1597699987
30036 \change_inserted 1075283030 1597699987
30038 \change_inserted -970929547 1515110187
30039 cannot be formatted: all fields are always output in the database-like
30040 DocBook format (equivalent to a BibTeX file)
30041 \change_inserted 1075283030 1597700117
30043 \begin_inset Flex Code
30046 \begin_layout Plain Layout
30048 \change_inserted 1075283030 1597700120
30057 \change_inserted -970929547 1515110187
30059 \change_inserted 1075283030 1597700092
30063 \begin_layout Standard
30065 \change_inserted 1075283030 1597700112
30066 When the bibliographic entries are manually inserted into the LyX document
30067 as Bibliography Items, the user deals with formatting themself: there is
30068 no attempt of parsing what the user wrote, the string is directly used
30070 \begin_inset Flex Code
30073 \begin_layout Plain Layout
30075 \change_inserted 1075283030 1597700076
30089 \begin_layout Chapter
30090 Including External Material
30091 \begin_inset CommandInset label
30093 name "chap:Including-External-Material"
30100 \begin_layout Standard
30101 \begin_inset Box Shadowbox
30111 height_special "totalheight"
30116 backgroundcolor "none"
30119 \begin_layout Plain Layout
30120 WARNING: This portion of the documentation has not been updated for some
30122 We certainly hope that it is still accurate, but there are no guarantees.
30130 \begin_layout Standard
30131 The use of material from sources external to \SpecialChar LyX
30132 is covered in detail in the
30138 This part of the manual covers what needs to happen behind the scenes for
30139 new sorts of material to be included.
30142 \begin_layout Section
30146 \begin_layout Standard
30147 The external material feature is based on the concept of a
30152 A template is a specification of how \SpecialChar LyX
30153 should interface with a certain kind
30155 As bundled, \SpecialChar LyX
30156 comes with predefined templates for Xfig figures, various
30157 raster format images, chess diagrams, and LilyPond music notation.
30158 You can check the actual list by using the menu
30159 \begin_inset Flex Noun
30162 \begin_layout Plain Layout
30163 Insert\SpecialChar menuseparator
30164 File\SpecialChar menuseparator
30171 Furthermore, it is possible to roll your own template to support a specific
30173 Later we'll describe in more detail what is involved, and hopefully you
30174 will submit all the templates you create so we can include them in a later
30179 \begin_layout Standard
30180 Another basic idea of the external material feature is to distinguish between
30181 the original file that serves as a base for final material and the produced
30182 file that is included in your exported or printed document.
30183 For example, consider the case of a figure produced with
30184 \begin_inset Flex Code
30187 \begin_layout Plain Layout
30194 The Xfig application itself works on an original file with the
30195 \begin_inset Flex Code
30198 \begin_layout Plain Layout
30205 Within Xfig, you create and change your figure, and when you are done,
30207 \begin_inset Flex Code
30210 \begin_layout Plain Layout
30217 When you want to include the figure in your document, you invoke
30218 \begin_inset Flex Code
30221 \begin_layout Plain Layout
30227 in order to create a PostScript file that can readily be included in your
30231 \begin_inset Flex Code
30234 \begin_layout Plain Layout
30240 file is the original file, and the PostScript file is the produced file.
30243 \begin_layout Standard
30244 This distinction is important in order to allow updating of the material
30245 while you are in the process of writing the document.
30246 Furthermore, it provides us with the flexibility that is needed to support
30247 multiple export formats.
30248 For instance, in the case of a plain text file, it is not exactly an award-winn
30249 ing idea to include the figure as raw PostScript.
30250 Instead, you would either prefer to just include a reference to the figure
30251 or try to invoke some graphics to ASCII converter to make the final result
30252 look similar to the real graphics.
30253 The external material management allows you to do this, because it is parametri
30254 zed on the different export formats that \SpecialChar LyX
30258 \begin_layout Standard
30259 Besides supporting the production of different products according to the
30260 exported format, it supports tight integration with editing and viewing
30262 In the case of an Xfig figure, you are able to invoke Xfig on the original
30263 file with a single click from within the external material dialog in \SpecialChar LyX
30265 and also preview the produced PostScript file with Ghostview with another
30267 No more fiddling around with the command line and/or file browsers to locate
30268 and manipulate the original or produced files.
30269 In this way, you are finally able to take full advantage of the many different
30270 applications that are relevant to use when you write your documents, and
30271 ultimately be more productive.
30274 \begin_layout Section
30275 The external template configuration files
30278 \begin_layout Standard
30279 It is relatively easy to add custom external template definitions to \SpecialChar LyX
30281 However, be aware that doing this in an careless manner most probably
30285 introduce an easily exploitable security hole.
30286 So before you do this, please read the discussion about security in
30287 \begin_inset CommandInset ref
30289 reference "sec:Security-discussion"
30296 \begin_layout Standard
30297 Having said that, we encourage you to submit any interesting templates that
30302 \begin_layout Standard
30303 The external templates are defined in the
30304 \begin_inset Flex Code
30307 \begin_layout Plain Layout
30313 files that are stored in the
30314 \begin_inset Flex Code
30317 \begin_layout Plain Layout
30318 LyXDir/lib/xtemplates/
30324 Each template is defined in a file of its own.
30325 You can place your own templates in
30326 \begin_inset Flex Code
30329 \begin_layout Plain Layout
30330 UserDir/xtemplates/
30335 or copy existing templates to that directory in order to modify them.
30338 \begin_layout Standard
30339 A typical template looks like this:
30342 \begin_layout LyX-Code
30346 \begin_layout LyX-Code
30347 GuiName "XFig: $$AbsOrRelPathParent$$Basename"
30350 \begin_layout LyX-Code
30354 \begin_layout LyX-Code
30358 \begin_layout LyX-Code
30362 \begin_layout LyX-Code
30366 \begin_layout LyX-Code
30370 \begin_layout LyX-Code
30371 AutomaticProduction true
30374 \begin_layout LyX-Code
30378 \begin_layout LyX-Code
30382 \begin_layout LyX-Code
30386 \begin_layout LyX-Code
30387 TransformCommand Rotate RotationLatexCommand
30390 \begin_layout LyX-Code
30391 TransformCommand Resize ResizeLatexCommand
30394 \begin_layout LyX-Code
30395 Product "$$RotateFront$$ResizeFront
30398 \begin_layout LyX-Code
30403 input{$$AbsOrRelPathMaster$$Basename.pstex_t}
30406 \begin_layout LyX-Code
30407 $$ResizeBack$$RotateBack"
30410 \begin_layout LyX-Code
30414 \begin_layout LyX-Code
30415 UpdateResult "$$AbsPath$$Basename.pstex_t"
30418 \begin_layout LyX-Code
30419 Requirement "graphicx"
30422 \begin_layout LyX-Code
30423 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
30426 \begin_layout LyX-Code
30427 ReferencedFile latex "$$AbsPath$$Basename.eps"
30430 \begin_layout LyX-Code
30431 ReferencedFile dvi "$$AbsPath$$Basename.eps"
30434 \begin_layout LyX-Code
30438 \begin_layout LyX-Code
30442 \begin_layout LyX-Code
30443 TransformCommand Rotate RotationLatexCommand
30446 \begin_layout LyX-Code
30447 TransformCommand Resize ResizeLatexCommand
30450 \begin_layout LyX-Code
30451 Product "$$RotateFront$$ResizeFront
30454 \begin_layout LyX-Code
30459 input{$$AbsOrRelPathMaster$$Basename.pdftex_t}
30462 \begin_layout LyX-Code
30463 $$ResizeBack$$RotateBack"
30466 \begin_layout LyX-Code
30467 UpdateFormat pdftex
30470 \begin_layout LyX-Code
30471 UpdateResult "$$AbsPath$$Basename.pdftex_t"
30474 \begin_layout LyX-Code
30475 Requirement "graphicx"
30478 \begin_layout LyX-Code
30479 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pdftex_t"
30482 \begin_layout LyX-Code
30483 ReferencedFile latex "$$AbsPath$$Basename.pdf"
30486 \begin_layout LyX-Code
30490 \begin_layout LyX-Code
30494 \begin_layout LyX-Code
30495 Product "[XFig: $$FName]"
30498 \begin_layout LyX-Code
30502 \begin_layout LyX-Code
30506 \begin_layout LyX-Code
30507 Product "<graphic fileref=
30509 "$$AbsOrRelPathMaster$$Basename.eps
30514 \begin_layout LyX-Code
30518 \begin_layout LyX-Code
30522 \begin_layout LyX-Code
30523 UpdateResult "$$AbsPath$$Basename.eps"
30526 \begin_layout LyX-Code
30527 ReferencedFile docbook "$$AbsPath$$Basename.eps"
30530 \begin_layout LyX-Code
30531 ReferencedFile docbook-xml "$$AbsPath$$Basename.eps"
30534 \begin_layout LyX-Code
30538 \begin_layout LyX-Code
30542 \begin_layout Standard
30543 As you can see, the template is enclosed in
30544 \begin_inset Flex Code
30547 \begin_layout Plain Layout
30555 \begin_inset Flex Code
30558 \begin_layout Plain Layout
30565 It contains a header specifying some general settings and, for each supported
30566 primary document file format, a section
30567 \begin_inset Flex Code
30570 \begin_layout Plain Layout
30578 \begin_inset Flex Code
30581 \begin_layout Plain Layout
30590 \begin_layout Subsection
30591 The template header
30594 \begin_layout Description
30595 \begin_inset Flex Code
30598 \begin_layout Plain Layout
30599 AutomaticProduction
30600 \begin_inset space ~
30608 Whether the file represented by the template must be generated by \SpecialChar LyX
30610 This command must occur exactly once.
30613 \begin_layout Description
30614 \begin_inset Flex Code
30617 \begin_layout Plain Layout
30619 \begin_inset space ~
30627 A glob pattern that is used in the file dialog to filter out the desired
30629 If there is more than one possible file extension (e.
30630 \begin_inset space \thinspace{}
30634 \begin_inset space \space{}
30638 \begin_inset Flex Code
30641 \begin_layout Plain Layout
30648 \begin_inset Flex Code
30651 \begin_layout Plain Layout
30657 ), use something like
30658 \begin_inset Flex Code
30661 \begin_layout Plain Layout
30668 This command must occur exactly once.
30671 \begin_layout Description
30672 \begin_inset Flex Code
30675 \begin_layout Plain Layout
30677 \begin_inset space ~
30685 The text that is displayed on the button.
30686 This command must occur exactly once.
30689 \begin_layout Description
30690 \begin_inset Flex Code
30693 \begin_layout Plain Layout
30695 \begin_inset space ~
30699 \begin_inset space ~
30707 The help text that is used in the External dialog.
30708 Provide enough information to explain to the user just what the template
30709 can provide him with.
30710 This command must occur exactly once.
30713 \begin_layout Description
30714 \begin_inset Flex Code
30717 \begin_layout Plain Layout
30719 \begin_inset space ~
30727 The file format of the original file.
30728 This must be the name of a format that is known to \SpecialChar LyX
30730 \begin_inset CommandInset ref
30732 reference "sec:Formats"
30738 \begin_inset Quotes eld
30742 \begin_inset Flex Code
30745 \begin_layout Plain Layout
30752 \begin_inset Quotes erd
30755 if the template can handle original files of more than one format.
30757 will attempt to interrogate the file itself in order to deduce its format
30759 This command must occur exactly once.
30762 \begin_layout Description
30763 \begin_inset Flex Code
30766 \begin_layout Plain Layout
30768 \begin_inset space ~
30776 A unique name for the template.
30777 It must not contain substitution macros (see below).
30780 \begin_layout Description
30781 \begin_inset Flex Code
30784 \begin_layout Plain Layout
30786 \begin_inset space ~
30789 Rotate|Resize|Clip|Extra
30794 This command specifies which transformations are supported by this template.
30795 It may occur zero or more times.
30796 This command enables the corresponding tabs in the external dialog.
30798 \begin_inset Flex Code
30801 \begin_layout Plain Layout
30807 command must have either a corresponding
30808 \begin_inset Flex Code
30811 \begin_layout Plain Layout
30818 \begin_inset Flex Code
30821 \begin_layout Plain Layout
30828 \begin_inset Flex Code
30831 \begin_layout Plain Layout
30838 Otherwise the transformation will not be supported by that format.
30841 \begin_layout Subsection
30845 \begin_layout Description
30846 \begin_inset Flex Code
30849 \begin_layout Plain Layout
30851 \begin_inset space ~
30854 LaTeX|PDFLaTeX|PlainText|DocBook|XHTML
30859 The primary document file format that this format definition is for.
30860 Not every template has a sensible representation in all document file formats.
30861 Please define nevertheless a
30862 \begin_inset Flex Code
30865 \begin_layout Plain Layout
30871 section for all templates.
30872 Use a dummy text when no representation is available.
30873 Then you can at least see a reference to the external material in the exported
30877 \begin_layout Description
30878 \begin_inset Flex Code
30881 \begin_layout Plain Layout
30883 \begin_inset space ~
30887 \begin_inset space ~
30895 This command defines an additional macro
30896 \begin_inset Flex Code
30899 \begin_layout Plain Layout
30905 for substitution in
30906 \begin_inset Flex Code
30909 \begin_layout Plain Layout
30917 \begin_inset Flex Code
30920 \begin_layout Plain Layout
30926 itself may contain substitution macros.
30927 The advantage over using
30928 \begin_inset Flex Code
30931 \begin_layout Plain Layout
30938 \begin_inset Flex Code
30941 \begin_layout Plain Layout
30947 is that the substituted value of
30948 \begin_inset Flex Code
30951 \begin_layout Plain Layout
30957 is sanitized so that it is a valid optional argument in the document format.
30958 This command may occur zero or more times.
30961 \begin_layout Description
30962 \begin_inset Flex Code
30965 \begin_layout Plain Layout
30967 \begin_inset space ~
30975 The text that is inserted in the exported document.
30976 This is actually the most important command and can be quite complex.
30977 This command must occur exactly once.
30980 \begin_layout Description
30981 \begin_inset Flex Code
30984 \begin_layout Plain Layout
30986 \begin_inset space ~
30994 This command specifies a preamble snippet that will be included in the
30997 It has to be defined using
30998 \begin_inset Flex Code
31001 \begin_layout Plain Layout
31009 \begin_inset Flex Code
31012 \begin_layout Plain Layout
31019 This command may occur zero or more times.
31022 \begin_layout Description
31023 \begin_inset Flex Code
31026 \begin_layout Plain Layout
31028 \begin_inset space ~
31032 \begin_inset space ~
31040 This command denotes files that are created by the conversion process and
31041 are needed for a particular export format.
31042 If the filename is relative, it is interpreted relative to the master document.
31043 This command may be given zero or more times.
31046 \begin_layout Description
31047 \begin_inset Flex Code
31050 \begin_layout Plain Layout
31052 \begin_inset space ~
31060 The name of a required \SpecialChar LaTeX
31062 The package is included via
31063 \begin_inset Flex Code
31066 \begin_layout Plain Layout
31074 in the \SpecialChar LaTeX
31076 This command may occur zero or more times.
31079 \begin_layout Description
31080 \begin_inset Flex Code
31083 \begin_layout Plain Layout
31085 \begin_inset space ~
31089 \begin_inset space ~
31092 RotationLatexCommand
31097 This command specifies that the built in \SpecialChar LaTeX
31098 command should be used for rotation.
31099 This command may occur once or not at all.
31102 \begin_layout Description
31103 \begin_inset Flex Code
31106 \begin_layout Plain Layout
31108 \begin_inset space ~
31112 \begin_inset space ~
31120 This command specifies that the built in \SpecialChar LaTeX
31121 command should be used for resizing.
31122 This command may occur once or not at all.
31125 \begin_layout Description
31126 \begin_inset Flex Code
31129 \begin_layout Plain Layout
31131 \begin_inset space ~
31135 \begin_inset space ~
31138 RotationLatexOption
31143 This command specifies that rotation is done via an optional argument.
31144 This command may occur once or not at all.
31147 \begin_layout Description
31148 \begin_inset Flex Code
31151 \begin_layout Plain Layout
31153 \begin_inset space ~
31157 \begin_inset space ~
31165 This command specifies that resizing is done via an optional argument.
31166 This command may occur once or not at all.
31169 \begin_layout Description
31170 \begin_inset Flex Code
31173 \begin_layout Plain Layout
31175 \begin_inset space ~
31179 \begin_inset space ~
31187 This command specifies that clipping is done via an optional argument.
31188 This command may occur once or not at all.
31191 \begin_layout Description
31192 \begin_inset Flex Code
31195 \begin_layout Plain Layout
31197 \begin_inset space ~
31201 \begin_inset space ~
31209 This command specifies that an extra optional argument is used.
31210 This command may occur once or not at all.
31213 \begin_layout Description
31214 \begin_inset Flex Code
31217 \begin_layout Plain Layout
31219 \begin_inset space ~
31227 The file format of the converted file.
31228 This must be the name of a format that is known to \SpecialChar LyX
31230 \begin_inset Flex Noun
31233 \begin_layout Plain Layout
31234 Tools\SpecialChar menuseparator
31235 Preferences\SpecialChar menuseparator
31236 File Handling\SpecialChar menuseparator
31243 This command must occur exactly once.
31244 If the resulting file format is PDF, you need to specify the format
31245 \begin_inset Flex Code
31248 \begin_layout Plain Layout
31255 This is the PDF format used for including graphics.
31256 The other defined PDF formats are for document export.
31259 \begin_layout Description
31260 \begin_inset Flex Code
31263 \begin_layout Plain Layout
31265 \begin_inset space ~
31273 The file name of the converted file.
31274 The file name must be absolute.
31275 This command must occur exactly once.
31278 \begin_layout Subsection
31279 Preamble definitions
31282 \begin_layout Standard
31283 The external template configuration file may contain additional preamble
31284 definitions enclosed by
31285 \begin_inset Flex Code
31288 \begin_layout Plain Layout
31296 \begin_inset Flex Code
31299 \begin_layout Plain Layout
31306 They can be used by the templates in the
31307 \begin_inset Flex Code
31310 \begin_layout Plain Layout
31319 \begin_layout Section
31320 The substitution mechanism
31323 \begin_layout Standard
31324 When the external material facility invokes an external program, it is done
31325 on the basis of a command defined in the template configuration file.
31326 These commands can contain various macros that are expanded before execution.
31327 Execution always take place in the directory of the containing document.
31330 \begin_layout Standard
31331 Also, whenever external material is to be displayed, the name will be produced
31332 by the substitution mechanism, and most other commands in the template
31333 definition support substitution as well.
31336 \begin_layout Standard
31337 The available macros are the following:
31340 \begin_layout Description
31341 \begin_inset Flex Code
31344 \begin_layout Plain Layout
31345 $$AbsOrRelPathMaster
31350 The file path, absolute or relative to the master \SpecialChar LyX
31354 \begin_layout Description
31355 \begin_inset Flex Code
31358 \begin_layout Plain Layout
31359 $$AbsOrRelPathParent
31364 The file path, absolute or relative to the \SpecialChar LyX
31368 \begin_layout Description
31369 \begin_inset Flex Code
31372 \begin_layout Plain Layout
31378 The absolute file path.
31381 \begin_layout Description
31382 \begin_inset Flex Code
31385 \begin_layout Plain Layout
31391 The filename without path and without the extension.
31394 \begin_layout Description
31395 \begin_inset Flex Code
31398 \begin_layout Plain Layout
31400 \begin_inset Quotes eld
31404 \begin_inset Quotes erd
31412 This macro will expand to the contents of the file with the name
31413 \begin_inset Flex Code
31416 \begin_layout Plain Layout
31425 \begin_layout Description
31426 \begin_inset Flex Code
31429 \begin_layout Plain Layout
31435 The file extension (including the dot).
31438 \begin_layout Description
31439 \begin_inset Flex Code
31442 \begin_layout Plain Layout
31448 This will be the string
31449 \begin_inset Quotes eld
31453 \begin_inset Quotes erd
31456 if the file is in JPEG format, otherwise it will be the string
31457 \begin_inset Quotes eld
31461 \begin_inset Quotes erd
31465 This is useful to avoid uneeded conversions for output formats that support
31466 both PNG and JPEG fomats.
31467 The predefined RasterImage template uses this macro for the pdf\SpecialChar TeX
31472 \begin_layout Description
31473 \begin_inset Flex Code
31476 \begin_layout Plain Layout
31482 The filename of the file specified in the external material dialog.
31483 This is either an absolute name, or it is relative to the \SpecialChar LyX
31487 \begin_layout Description
31488 \begin_inset Flex Code
31491 \begin_layout Plain Layout
31498 \begin_inset Flex Code
31501 \begin_layout Plain Layout
31507 (absolute name or relative to the \SpecialChar LyX
31511 \begin_layout Description
31512 \begin_inset Flex Code
31515 \begin_layout Plain Layout
31521 The file path, relative to the master \SpecialChar LyX
31525 \begin_layout Description
31526 \begin_inset Flex Code
31529 \begin_layout Plain Layout
31535 The file path, relative to the \SpecialChar LyX
31539 \begin_layout Description
31540 \begin_inset Flex Code
31543 \begin_layout Plain Layout
31549 This macro will expand to the absolute path of the system directory.
31550 This is typically used to point to the various helper scripts that are
31551 bundled with \SpecialChar LyX
31555 \begin_layout Description
31556 \begin_inset Flex Code
31559 \begin_layout Plain Layout
31565 A name and full path to a temporary file which will be automatically deleted
31566 whenever the containing document is closed, or the external material insertion
31570 \begin_layout Standard
31571 All path macros contain a trailing directory separator, so you can construct
31573 \begin_inset space \thinspace{}
31577 \begin_inset space \space{}
31580 the absolute filename with
31581 \begin_inset Flex Code
31584 \begin_layout Plain Layout
31585 $$AbsPath$$Basename$$Extension
31593 \begin_layout Standard
31594 The macros above are substituted in all commands unless otherwise noted.
31596 \begin_inset Flex Code
31599 \begin_layout Plain Layout
31605 supports additionally the following substitutions if they are enabled by
31607 \begin_inset Flex Code
31610 \begin_layout Plain Layout
31617 \begin_inset Flex Code
31620 \begin_layout Plain Layout
31629 \begin_layout Description
31630 \begin_inset Flex Code
31633 \begin_layout Plain Layout
31639 The front part of the resize command.
31642 \begin_layout Description
31643 \begin_inset Flex Code
31646 \begin_layout Plain Layout
31652 The back part of the resize command.
31655 \begin_layout Description
31656 \begin_inset Flex Code
31659 \begin_layout Plain Layout
31665 The front part of the rotation command.
31668 \begin_layout Description
31669 \begin_inset Flex Code
31672 \begin_layout Plain Layout
31678 The back part of the rotation command.
31681 \begin_layout Standard
31682 The value string of the
31683 \begin_inset Flex Code
31686 \begin_layout Plain Layout
31692 command supports additionally the following substitutions if they are enabled
31694 \begin_inset Flex Code
31697 \begin_layout Plain Layout
31704 \begin_inset Flex Code
31707 \begin_layout Plain Layout
31716 \begin_layout Description
31717 \begin_inset Flex Code
31720 \begin_layout Plain Layout
31729 \begin_layout Description
31730 \begin_inset Flex Code
31733 \begin_layout Plain Layout
31742 \begin_layout Description
31743 \begin_inset Flex Code
31746 \begin_layout Plain Layout
31755 \begin_layout Description
31756 \begin_inset Flex Code
31759 \begin_layout Plain Layout
31765 The rotation option.
31768 \begin_layout Standard
31769 You may ask why there are so many path macros.
31770 There are mainly two reasons:
31773 \begin_layout Enumerate
31774 Relative and absolute file names should remain relative or absolute, respectivel
31776 Users may have reasons to prefer either form.
31777 Relative names are useful for portable documents that should work on different
31778 machines, for example.
31779 Absolute names may be required by some programs.
31782 \begin_layout Enumerate
31784 treats relative file names differently than \SpecialChar LyX
31785 and other programs in nested
31787 For \SpecialChar LyX
31788 , a relative file name is always relative to the document that contains
31790 For \SpecialChar LaTeX
31791 , it is always relative to the master document.
31792 These two definitions are identical if you have only one document, but
31793 differ if you have a master document that includes part documents.
31794 That means that relative filenames must be transformed when presented to
31797 Fortunately \SpecialChar LyX
31798 does this automatically for you if you choose the right macros.
31801 \begin_layout Standard
31802 So which path macro should be used in new template definitions? The rule
31806 \begin_layout Itemize
31808 \begin_inset Flex Code
31811 \begin_layout Plain Layout
31817 if an absolute path is required.
31820 \begin_layout Itemize
31822 \begin_inset Flex Code
31825 \begin_layout Plain Layout
31826 $$AbsOrRelPathMaster
31831 if the substituted string is some kind of \SpecialChar LaTeX
31835 \begin_layout Itemize
31837 \begin_inset Flex Code
31840 \begin_layout Plain Layout
31841 $$AbsOrRelPathParent
31846 in order to preserve the user's choice.
31849 \begin_layout Standard
31850 There are special cases where this rule does not work and e.
31851 \begin_inset space \thinspace{}
31855 \begin_inset space \space{}
31858 relative names are needed, but normally it will work just fine.
31859 One example for such a case is the command
31860 \begin_inset Flex Code
31863 \begin_layout Plain Layout
31864 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
31869 in the XFig template above: We can't use the absolute name because the
31871 \begin_inset Flex Code
31874 \begin_layout Plain Layout
31880 files needs the relative name in order to rewrite the file content.
31883 \begin_layout Section
31884 Security discussion
31885 \begin_inset CommandInset label
31887 name "sec:Security-discussion"
31894 \begin_layout Standard
31895 The external material feature interfaces with a lot of external programs
31896 and does so automatically, so we have to consider the security implications
31898 In particular, since you have the option of including your own filenames
31899 and/or parameter strings and those are expanded into a command, it seems
31900 that it would be possible to create a malicious document which executes
31901 arbitrary commands when a user views or prints the document.
31902 This is something we definitely want to avoid.
31905 \begin_layout Standard
31906 However, since the external program commands are specified in the template
31907 configuration file only, there are no security issues if \SpecialChar LyX
31908 is properly configure
31909 d with safe templates only.
31910 This is so because the external programs are invoked with the
31911 \begin_inset Flex Code
31914 \begin_layout Plain Layout
31920 -system call rather than the
31921 \begin_inset Flex Code
31924 \begin_layout Plain Layout
31930 system-call, so it's not possible to execute arbitrary commands from the
31931 filename or parameter section via the shell.
31934 \begin_layout Standard
31935 This also implies that you are restricted in what command strings you can
31936 use in the external material templates.
31937 In particular, pipes and redirection are not readily available.
31938 This has to be so if \SpecialChar LyX
31939 should remain safe.
31940 If you want to use some of the shell features, you should write a safe
31941 script to do this in a controlled manner, and then invoke the script from
31942 the command string.
31946 \begin_layout Standard
31947 It is possible to design a template that interacts directly with the shell,
31948 but since this would allow a malicious user to execute arbitrary commands
31949 by writing clever filenames and/or parameters, we generally recommend that
31950 you only use safe scripts that work with the
31951 \begin_inset Flex Code
31954 \begin_layout Plain Layout
31960 system call in a controlled manner.
31961 Of course, for use in a controlled environment, it can be tempting to just
31962 fall back to use ordinary shell scripts.
31963 If you do so, be aware that you
31967 provide an easily exploitable security hole in your system.
31968 Of course it stands to reason that such unsafe templates will never be
31969 included in the standard \SpecialChar LyX
31970 distribution, although we do encourage people
31971 to submit new templates in the open source tradition.
31972 But \SpecialChar LyX
31973 as shipped from the official distribution channels will never have
31977 \begin_layout Standard
31978 Including external material provides a lot of power, and you have to be
31979 careful not to introduce security hazards with this power.
31980 A subtle error in a single line in an innocent looking script can open
31981 the door to huge security problems.
31982 So if you do not fully understand the issues, we recommend that you consult
31983 a knowledgeable security professional or the \SpecialChar LyX
31984 development team if you have
31985 any questions about whether a given template is safe or not.
31986 And do this before you use it in an uncontrolled environment.
31989 \begin_layout Chapter
31991 List of supported \SpecialChar LyX
31992 functions to be used in layouts
31993 \begin_inset CommandInset label
31995 name "chap:List-of-functions"
32002 \begin_layout Standard
32004 \begin_inset Tabular
32005 <lyxtabular version="3" rows="11" columns="8">
32006 <features tabularvalignment="middle">
32007 <column alignment="left" valignment="top">
32008 <column alignment="left" valignment="top">
32009 <column alignment="left" valignment="top">
32010 <column alignment="left" valignment="top">
32011 <column alignment="left" valignment="top">
32012 <column alignment="left" valignment="top">
32013 <column alignment="left" valignment="top">
32014 <column alignment="left" valignment="top">
32016 <cell alignment="left" valignment="top" usebox="none">
32019 \begin_layout Plain Layout
32025 <cell alignment="left" valignment="top" usebox="none">
32028 \begin_layout Plain Layout
32034 <cell alignment="left" valignment="top" usebox="none">
32037 \begin_layout Plain Layout
32043 <cell alignment="left" valignment="top" usebox="none">
32046 \begin_layout Plain Layout
32052 <cell alignment="center" valignment="top" usebox="none">
32055 \begin_layout Plain Layout
32061 <cell alignment="center" valignment="top" usebox="none">
32064 \begin_layout Plain Layout
32070 <cell alignment="center" valignment="top" usebox="none">
32073 \begin_layout Plain Layout
32079 <cell alignment="center" valignment="top" usebox="none">
32082 \begin_layout Plain Layout
32090 <cell alignment="left" valignment="top" usebox="none">
32093 \begin_layout Plain Layout
32099 <cell alignment="left" valignment="top" usebox="none">
32102 \begin_layout Plain Layout
32108 <cell alignment="left" valignment="top" usebox="none">
32111 \begin_layout Plain Layout
32117 <cell alignment="left" valignment="top" usebox="none">
32120 \begin_layout Plain Layout
32126 <cell alignment="center" valignment="top" usebox="none">
32129 \begin_layout Plain Layout
32135 <cell alignment="center" valignment="top" usebox="none">
32138 \begin_layout Plain Layout
32144 <cell alignment="center" valignment="top" usebox="none">
32147 \begin_layout Plain Layout
32153 <cell alignment="center" valignment="top" usebox="none">
32156 \begin_layout Plain Layout
32164 <cell alignment="left" valignment="top" usebox="none">
32167 \begin_layout Plain Layout
32173 <cell alignment="left" valignment="top" usebox="none">
32176 \begin_layout Plain Layout
32182 <cell alignment="left" valignment="top" usebox="none">
32185 \begin_layout Plain Layout
32191 <cell alignment="left" valignment="top" usebox="none">
32194 \begin_layout Plain Layout
32200 <cell alignment="center" valignment="top" usebox="none">
32203 \begin_layout Plain Layout
32209 <cell alignment="center" valignment="top" usebox="none">
32212 \begin_layout Plain Layout
32218 <cell alignment="center" valignment="top" usebox="none">
32221 \begin_layout Plain Layout
32227 <cell alignment="center" valignment="top" usebox="none">
32230 \begin_layout Plain Layout
32238 <cell alignment="left" valignment="top" usebox="none">
32241 \begin_layout Plain Layout
32247 <cell alignment="left" valignment="top" usebox="none">
32250 \begin_layout Plain Layout
32256 <cell alignment="left" valignment="top" usebox="none">
32259 \begin_layout Plain Layout
32265 <cell alignment="left" valignment="top" usebox="none">
32268 \begin_layout Plain Layout
32274 <cell alignment="center" valignment="top" usebox="none">
32277 \begin_layout Plain Layout
32283 <cell alignment="center" valignment="top" usebox="none">
32286 \begin_layout Plain Layout
32292 <cell alignment="center" valignment="top" usebox="none">
32295 \begin_layout Plain Layout
32301 <cell alignment="center" valignment="top" usebox="none">
32304 \begin_layout Plain Layout
32312 <cell alignment="left" valignment="top" usebox="none">
32315 \begin_layout Plain Layout
32321 <cell alignment="left" valignment="top" usebox="none">
32324 \begin_layout Plain Layout
32330 <cell alignment="left" valignment="top" usebox="none">
32333 \begin_layout Plain Layout
32339 <cell alignment="left" valignment="top" usebox="none">
32342 \begin_layout Plain Layout
32348 <cell alignment="center" valignment="top" usebox="none">
32351 \begin_layout Plain Layout
32357 <cell alignment="center" valignment="top" usebox="none">
32360 \begin_layout Plain Layout
32366 <cell alignment="center" valignment="top" usebox="none">
32369 \begin_layout Plain Layout
32375 <cell alignment="center" valignment="top" usebox="none">
32378 \begin_layout Plain Layout
32386 <cell alignment="left" valignment="top" usebox="none">
32389 \begin_layout Plain Layout
32395 <cell alignment="left" valignment="top" usebox="none">
32398 \begin_layout Plain Layout
32404 <cell alignment="left" valignment="top" usebox="none">
32407 \begin_layout Plain Layout
32413 <cell alignment="left" valignment="top" usebox="none">
32416 \begin_layout Plain Layout
32422 <cell alignment="center" valignment="top" usebox="none">
32425 \begin_layout Plain Layout
32431 <cell alignment="center" valignment="top" usebox="none">
32434 \begin_layout Plain Layout
32440 <cell alignment="center" valignment="top" usebox="none">
32443 \begin_layout Plain Layout
32449 <cell alignment="center" valignment="top" usebox="none">
32452 \begin_layout Plain Layout
32460 <cell alignment="left" valignment="top" usebox="none">
32463 \begin_layout Plain Layout
32469 <cell alignment="left" valignment="top" usebox="none">
32472 \begin_layout Plain Layout
32478 <cell alignment="left" valignment="top" usebox="none">
32481 \begin_layout Plain Layout
32487 <cell alignment="left" valignment="top" usebox="none">
32490 \begin_layout Plain Layout
32496 <cell alignment="center" valignment="top" usebox="none">
32499 \begin_layout Plain Layout
32505 <cell alignment="center" valignment="top" usebox="none">
32508 \begin_layout Plain Layout
32514 <cell alignment="center" valignment="top" usebox="none">
32517 \begin_layout Plain Layout
32523 <cell alignment="center" valignment="top" usebox="none">
32526 \begin_layout Plain Layout
32534 <cell alignment="left" valignment="top" usebox="none">
32537 \begin_layout Plain Layout
32543 <cell alignment="left" valignment="top" usebox="none">
32546 \begin_layout Plain Layout
32552 <cell alignment="left" valignment="top" usebox="none">
32555 \begin_layout Plain Layout
32561 <cell alignment="left" valignment="top" usebox="none">
32564 \begin_layout Plain Layout
32570 <cell alignment="center" valignment="top" usebox="none">
32573 \begin_layout Plain Layout
32579 <cell alignment="center" valignment="top" usebox="none">
32582 \begin_layout Plain Layout
32588 <cell alignment="center" valignment="top" usebox="none">
32591 \begin_layout Plain Layout
32597 <cell alignment="center" valignment="top" usebox="none">
32600 \begin_layout Plain Layout
32608 <cell alignment="left" valignment="top" usebox="none">
32611 \begin_layout Plain Layout
32617 <cell alignment="left" valignment="top" usebox="none">
32620 \begin_layout Plain Layout
32626 <cell alignment="left" valignment="top" usebox="none">
32629 \begin_layout Plain Layout
32635 <cell alignment="left" valignment="top" usebox="none">
32638 \begin_layout Plain Layout
32644 <cell alignment="center" valignment="top" usebox="none">
32647 \begin_layout Plain Layout
32653 <cell alignment="center" valignment="top" usebox="none">
32656 \begin_layout Plain Layout
32662 <cell alignment="center" valignment="top" usebox="none">
32665 \begin_layout Plain Layout
32671 <cell alignment="center" valignment="top" usebox="none">
32674 \begin_layout Plain Layout
32682 <cell alignment="left" valignment="top" usebox="none">
32685 \begin_layout Plain Layout
32691 <cell alignment="left" valignment="top" usebox="none">
32694 \begin_layout Plain Layout
32700 <cell alignment="left" valignment="top" usebox="none">
32703 \begin_layout Plain Layout
32709 <cell alignment="left" valignment="top" usebox="none">
32712 \begin_layout Plain Layout
32718 <cell alignment="center" valignment="top" usebox="none">
32721 \begin_layout Plain Layout
32727 <cell alignment="center" valignment="top" usebox="none">
32730 \begin_layout Plain Layout
32736 <cell alignment="center" valignment="top" usebox="none">
32739 \begin_layout Plain Layout
32745 <cell alignment="center" valignment="top" usebox="none">
32748 \begin_layout Plain Layout
32756 <cell alignment="center" valignment="top" usebox="none">
32759 \begin_layout Plain Layout
32765 <cell alignment="center" valignment="top" usebox="none">
32768 \begin_layout Plain Layout
32774 <cell alignment="center" valignment="top" usebox="none">
32777 \begin_layout Plain Layout
32783 <cell alignment="center" valignment="top" usebox="none">
32786 \begin_layout Plain Layout
32792 <cell alignment="center" valignment="top" usebox="none">
32795 \begin_layout Plain Layout
32801 <cell alignment="center" valignment="top" usebox="none">
32804 \begin_layout Plain Layout
32810 <cell alignment="center" valignment="top" usebox="none">
32813 \begin_layout Plain Layout
32819 <cell alignment="center" valignment="top" usebox="none">
32822 \begin_layout Plain Layout
32836 \begin_layout Chapter
32837 Names of available colors to be used in layouts
32838 \begin_inset CommandInset label
32840 name "chap:Names-of-colors"
32847 \begin_layout Standard
32848 The colors listed below are the standard colors and those that you can adjust
32849 in the \SpecialChar LyX
32853 \begin_layout Section
32857 \begin_layout Standard
32858 The following are no real colors, but rather act on color definitions:
32861 \begin_layout Description
32862 ignore The color is ignored
32865 \begin_layout Description
32866 inherit The color is inherited
32869 \begin_layout Description
32882 No particular color – clear or default
32885 \begin_layout Section
32889 \begin_layout Standard
32890 These are fixed colors that cannot be customized:
32893 \begin_layout Description
32897 \begin_layout Description
32901 \begin_layout Description
32905 \begin_layout Description
32909 \begin_layout Description
32913 \begin_layout Description
32917 \begin_layout Description
32921 \begin_layout Description
32925 \begin_layout Description
32929 \begin_layout Description
32933 \begin_layout Description
32937 \begin_layout Description
32941 \begin_layout Description
32945 \begin_layout Description
32949 \begin_layout Description
32953 \begin_layout Description
32957 \begin_layout Description
32961 \begin_layout Description
32965 \begin_layout Description
32969 \begin_layout Section
32973 \begin_layout Standard
32974 These are the colors allocated to specific elements in
32977 arg "dialog-show prefs"
32983 \begin_layout Description
32984 added_space Added space color
32987 \begin_layout Description
32988 addedtext Added text color
32991 \begin_layout Description
32992 appendix Appendix marker color
32995 \begin_layout Description
32996 background Background color
32999 \begin_layout Description
33000 bottomarea Bottom area color
33003 \begin_layout Description
33004 branchlabel Label color for branches
33007 \begin_layout Description
33008 buttonbg Color used for button background
33011 \begin_layout Description
33012 buttonframe Color for inset button frames
33015 \begin_layout Description
33016 buttonhoverbg Color used for button background under focus
33019 \begin_layout Description
33020 changebar Changebar color
33023 \begin_layout Description
33024 changedtextauthor1 Changed text color author 1
33027 \begin_layout Description
33028 changedtextauthor2 Changed text color author 2
33031 \begin_layout Description
33032 changedtextauthor3 Changed text color author 3
33035 \begin_layout Description
33036 changedtextauthor4 Changed text color author 4
33039 \begin_layout Description
33040 changedtextauthor5 Changed text color author 5
33043 \begin_layout Description
33044 collapsible Collapsible insets text color
33047 \begin_layout Description
33048 collapsibleframe Collapsible insets framecolor
33051 \begin_layout Description
33052 command Text color for command insets
33055 \begin_layout Description
33056 commandbg Background color for command insets
33059 \begin_layout Description
33060 commandframe Frame color for command insets
33063 \begin_layout Description
33064 comment Label color for comments
33067 \begin_layout Description
33068 commentbg Background color of comments
33071 \begin_layout Description
33072 cursor Cursor color
33075 \begin_layout Description
33076 deletedtext Deleted text color
33079 \begin_layout Description
33080 deletedtextmodifier Deleted text modifying color
33083 \begin_layout Description
33084 depthbar Color for the depth bars in the margin
33087 \begin_layout Description
33088 eolmarker End of line marker color
33091 \begin_layout Description
33092 error Color of the \SpecialChar LaTeX
33096 \begin_layout Description
33097 footlabel Label color for footnotes
33100 \begin_layout Description
33101 foreground Foreground color
33104 \begin_layout Description
33105 graphicsbg Graphics inset background color
33108 \begin_layout Description
33109 greyedoutbg Background color of greyedout inset
33112 \begin_layout Description
33113 greyedoutlabel Label color for greyedout insets
33116 \begin_layout Description
33117 greyedouttext Color for greyedout inset text
33120 \begin_layout Description
33121 indexlabel Label color for index insets
33124 \begin_layout Description
33125 inlinecompletion Inline completion color
33128 \begin_layout Description
33129 insetbg Inset marker background color
33132 \begin_layout Description
33133 insetframe Inset marker frame color
33136 \begin_layout Description
33137 language Color for marking foreign language words
33140 \begin_layout Description
33141 latex Text color in \SpecialChar LaTeX
33145 \begin_layout Description
33146 listingsbg Background color of listings inset
33149 \begin_layout Description
33150 marginlabel Label color for margin notes
33153 \begin_layout Description
33154 math Math inset text color
33157 \begin_layout Description
33158 mathbg Math inset background color
33161 \begin_layout Description
33162 mathcorners Math inset frame color not under focus
33165 \begin_layout Description
33166 mathframe Math inset frame color under focus
33169 \begin_layout Description
33170 mathline Math line color
33173 \begin_layout Description
33174 mathmacrobg Macro math inset background color
33177 \begin_layout Description
33178 mathmacroblend Macro math blended color
33181 \begin_layout Description
33182 mathmacroframe Macro math frame color
33185 \begin_layout Description
33186 mathmacrohoverbg Macro math inset background color hovered
33189 \begin_layout Description
33190 mathmacrolabel Macro math label color
33193 \begin_layout Description
33194 mathmacronewarg Macro template color for new parameters
33197 \begin_layout Description
33198 mathmacrooldarg Macro template color for old parameters
33201 \begin_layout Description
33202 newpage New page color
33205 \begin_layout Description
33206 nonunique_inlinecompletion Inline completion color for the non-unique part
33209 \begin_layout Description
33210 note Label color for notes
33213 \begin_layout Description
33214 notebg Background color of notes
33217 \begin_layout Description
33218 pagebreak Page break/line break color
33221 \begin_layout Description
33222 paragraphmarker Color used for the pilcrow sign to mark the end of a paragraph
33225 \begin_layout Description
33226 phantomtext Text color for phantom insets
33229 \begin_layout Description
33230 preview The color used for previews
33233 \begin_layout Description
33234 previewframe Preview frame color
33237 \begin_layout Description
33238 regexpframe Color for regexp frame
33241 \begin_layout Description
33242 scroll Color that indicates when a row can be scrolled
33245 \begin_layout Description
33246 selection Background color of selected text
33249 \begin_layout Description
33250 selectiontext Foreground color of selected text
33253 \begin_layout Description
33254 shadedbg Background color of shaded box
33257 \begin_layout Description
33258 special Special chars text color
33261 \begin_layout Description
33262 tabularline Table line color
33265 \begin_layout Description
33266 tabularonoffline Table line color
33269 \begin_layout Description
33270 urllabel Label color for URL insets
33273 \begin_layout Description
33274 urltext Color for URL inset text