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
6181 \change_inserted -584632292 1610232084
6184 Installing New Document Classes, Layouts, and Templates
6185 \begin_inset CommandInset label
6187 name "cha:Installing-New-Document"
6192 \begin_inset Argument 1
6195 \begin_layout Plain Layout
6196 Installing New Document Classes
6204 \begin_layout Standard
6205 In this chapter, we describe the procedures for creating and installing
6206 new \SpecialChar LyX
6207 layout and template files, as well as offer a refresher on correctly
6208 installing new \SpecialChar LaTeX
6213 \begin_layout Standard
6214 First, let us a say a few words about how one ought to think about the relation
6215 between \SpecialChar LyX
6216 and \SpecialChar LaTeX
6218 The thing to understand is that, in a certain sense, \SpecialChar LyX
6219 doesn't know anything
6220 about \SpecialChar LaTeX
6222 Indeed, from \SpecialChar LyX
6223 's point of view, \SpecialChar LaTeX
6224 is just one of several
6225 \begin_inset Quotes eld
6229 \begin_inset Quotes erd
6232 in which it is capable of producing output.
6233 Other such formats are DocBook, plaintext, and XHTML.
6235 is, of course, a particularly important format, but very little of the
6236 information \SpecialChar LyX
6237 has about \SpecialChar LaTeX
6238 is actually contained in the program itself.
6242 \begin_layout Plain Layout
6243 Some commands are sufficiently complex that they are
6244 \begin_inset Quotes eld
6248 \begin_inset Quotes erd
6251 into \SpecialChar LyX
6253 But the developers generally regard this as a Bad Thing.
6258 Rather, that information, even for the standard classes like
6259 \begin_inset Flex Code
6262 \begin_layout Plain Layout
6268 , is contained in `layout files'.
6269 Similarly, \SpecialChar LyX
6270 itself does not know much about DocBook or XHTML.
6271 What it knows is contained in layout files.
6274 \begin_layout Standard
6275 You can think of the layout file for a given document class as a translation
6276 manual between \SpecialChar LyX
6277 constructs—paragraphs with their corresponding styles,
6278 certain sorts of insets, etc—and the corresponding \SpecialChar LaTeX
6281 Almost everything \SpecialChar LyX
6283 \begin_inset Flex Code
6286 \begin_layout Plain Layout
6292 , for example, is contained in the file
6293 \begin_inset Flex Code
6296 \begin_layout Plain Layout
6302 and in various other files it includes.
6303 For this reason, anyone intending to write layout files should plan to
6304 study the existing files.
6305 A good place to start is with
6306 \begin_inset Flex Code
6309 \begin_layout Plain Layout
6315 , which is included in
6316 \begin_inset Flex Code
6319 \begin_layout Plain Layout
6326 \begin_inset Flex Code
6329 \begin_layout Plain Layout
6335 , and many of the other layout files for document classes.
6336 This file is where sections and the like are defined:
6337 \begin_inset Flex Code
6340 \begin_layout Plain Layout
6346 tells \SpecialChar LyX
6347 how paragraphs that are marked with the Section, Subsection, etc,
6348 styles can be translated into corresponding \SpecialChar LaTeX
6349 , DocBook, and XHTML commands
6352 \begin_inset Flex Code
6355 \begin_layout Plain Layout
6361 file basically just includes several of these
6362 \begin_inset Flex Code
6365 \begin_layout Plain Layout
6374 \begin_layout Standard
6375 Defining the \SpecialChar LyX
6377 correspondence is not the only thing layout files do, though.
6378 Their other job is to define how the \SpecialChar LyX
6379 constructs themselves will appear
6381 The fact that layout files have these two jobs is often a source of confusion,
6382 because they are completely separate.
6383 Telling \SpecialChar LyX
6384 how to translate a certain paragraph style into \SpecialChar LaTeX
6387 how to display it; conversely, telling \SpecialChar LyX
6388 how to display a certain paragraph
6389 style does not tell \SpecialChar LyX
6390 how to translate it into \SpecialChar LaTeX
6391 (let alone tell \SpecialChar LaTeX
6394 So, in general, when you define a new \SpecialChar LyX
6395 construct, you must always do two
6396 quite separate things: (i)
6397 \begin_inset space ~
6400 tell \SpecialChar LyX
6401 how to translate it into \SpecialChar LaTeX
6403 \begin_inset space ~
6406 tell \SpecialChar LyX
6410 \begin_layout Standard
6411 Much the same is true, of course, as regards \SpecialChar LyX
6412 's other backend formats, though
6413 XHTML is in some ways different, because in that case \SpecialChar LyX
6418 able, to some extent, to use information about how it should display a
6419 paragraph on the screen to output information (in the form of CSS) about
6420 how the paragraph should be displayed in a browser.
6421 Even in this case, however, the distinction between what \SpecialChar LyX
6423 and how things are rendered externally remains in force, and the two can
6424 be controlled separately.
6426 \begin_inset CommandInset ref
6428 reference "sec:Tags-for-XHTML"
6435 \begin_layout Section
6436 Installing new \SpecialChar LaTeX
6440 \begin_layout Standard
6441 Some installations may not include a \SpecialChar LaTeX
6442 package or class file that you would
6443 like to use within \SpecialChar LyX
6445 For example, you might need Foil\SpecialChar TeX
6446 , a package for preparing slides for overhead
6448 Modern \SpecialChar LaTeX
6449 distributions like \SpecialChar TeX
6450 Live (2008 or newer) or MiK\SpecialChar TeX
6451 provide a user interface
6452 for installing such packages.
6453 For example, with MiK\SpecialChar TeX
6454 , you start the program
6455 \begin_inset Quotes eld
6459 \begin_inset space ~
6463 \begin_inset Quotes erd
6466 to get a list of available packages.
6467 To install one of them, right click on it or use the corresponding toolbar
6471 \begin_layout Standard
6472 If your \SpecialChar LaTeX
6473 distribution does not provide such a `package manager', or if the
6474 package is not available from your distribution, then follow these steps
6475 to install it manually:
6478 \begin_layout Enumerate
6479 Get the package from
6480 \begin_inset CommandInset href
6483 target "http://www.ctan.org/"
6491 \begin_layout Enumerate
6492 If the package contains a file with the ending
6493 \begin_inset Quotes eld
6497 \begin_inset Flex Code
6500 \begin_layout Plain Layout
6507 \begin_inset Quotes erd
6510 (is the case for Foil\SpecialChar TeX
6511 ) then open a console, change to the folder of this
6512 file and execute the command
6513 \begin_inset Flex Code
6516 \begin_layout Plain Layout
6523 You have now unpacked the package and have all files to install it.
6524 Most \SpecialChar LaTeX
6525 -packages are not packed and you can skip this step.
6528 \begin_layout Enumerate
6529 Now you need to decide if the package should be available for all users
6534 \begin_layout Enumerate
6535 On *nix systems (Linux, OSX, etc.), if you want the new package to be available
6536 for all users on your system, then install it in your `local' \SpecialChar TeX
6538 install it in your own `user' \SpecialChar TeX
6540 Where these trees should be created, if they do not already exist, depends
6542 To find this out, look in the file
6543 \begin_inset Flex Code
6546 \begin_layout Plain Layout
6556 \begin_layout Plain Layout
6557 This is usually in the directory
6558 \begin_inset Flex Code
6561 \begin_layout Plain Layout
6567 , though you can execute the command
6568 \begin_inset Flex Code
6571 \begin_layout Plain Layout
6582 The location of the `local' \SpecialChar TeX
6583 tree is defined by the
6584 \begin_inset Flex Code
6587 \begin_layout Plain Layout
6593 variable; this is usually somewhere like
6594 \begin_inset Flex Code
6597 \begin_layout Plain Layout
6598 /usr/local/share/texmf
6603 or /usr/local/texlive/XXXX where XXXX is the year of the installed \SpecialChar TeX
6606 The location of the `user' \SpecialChar TeX
6608 \begin_inset Flex Code
6611 \begin_layout Plain Layout
6618 \begin_inset Flex Code
6621 \begin_layout Plain Layout
6628 \begin_inset Flex Code
6631 \begin_layout Plain Layout
6640 (If these variables are not predefined, you have to define them.) You'll
6641 probably need root permissions to create or modify the `local' tree, but
6642 not for your `user' tree.
6643 \begin_inset Newline newline
6646 In general, it is recommended to install in the user tree because your user
6647 will not be modified or even overwritten when you upgrade your system.
6648 It will typically also be backed up together with everything else when
6649 you backup your home directory (which, of course, you do on a regular basis).
6652 \begin_layout Enumerate
6653 On Windows, if you want the new package to be available for all users on
6654 your system, change to the folder where \SpecialChar LaTeX
6655 is installed and then change to
6657 \begin_inset Flex Code
6660 \begin_layout Plain Layout
6671 (For MiK\SpecialChar TeX
6672 , this would be by default the folder
6673 \begin_inset Flex Code
6676 \begin_layout Plain Layout
6694 \begin_layout Plain Layout
6695 Note that this will be the correct path only on English installations.
6696 On a German one, it would be
6697 \begin_inset Flex Code
6700 \begin_layout Plain Layout
6714 , and similarly for other languages.
6719 Create there a new folder
6720 \begin_inset Flex Code
6723 \begin_layout Plain Layout
6729 and copy all files of the package into it.
6731 \begin_inset Newline newline
6734 If the package should only available for you or you don't have admin permissions
6735 , do the same, but in the local \SpecialChar LaTeX
6738 \begin_inset space \thinspace{}
6741 g., for MiK\SpecialChar TeX
6743 \begin_inset space ~
6746 2.8 under Windows XP, this would be the folder:
6747 \begin_inset Newline newline
6753 \begin_inset Flex Code
6756 \begin_layout Plain Layout
6759 Documents and Settings
6771 \begin_inset Newline newline
6777 \begin_inset Phantom HPhantom
6780 \begin_layout Plain Layout
6791 \begin_inset Flex Code
6794 \begin_layout Plain Layout
6807 \begin_inset Newline newline
6810 On Vista, it would be:
6811 \begin_inset Newline newline
6815 \begin_inset Flex Code
6818 \begin_layout Plain Layout
6844 \begin_layout Enumerate
6845 Now one only need to tell \SpecialChar LaTeX
6846 that there are new files.
6847 This depends on the used \SpecialChar LaTeX
6852 \begin_layout Enumerate
6853 For \SpecialChar TeX
6854 Live execute the command
6855 \begin_inset Flex Code
6858 \begin_layout Plain Layout
6865 If you installed the package for all users, then you will probably need
6866 to have root permissions for that.
6869 \begin_layout Enumerate
6870 For MiK\SpecialChar TeX
6871 , if you have installed the package for all users, start the program
6873 \begin_inset Quotes eld
6877 \begin_inset space ~
6881 \begin_inset Quotes erd
6884 and press the button marked
6885 \begin_inset Quotes eld
6889 \begin_inset Quotes erd
6893 Otherwise start the program
6894 \begin_inset Quotes eld
6898 \begin_inset Quotes erd
6905 \begin_layout Enumerate
6906 Finally, you need to tell \SpecialChar LyX
6907 that there are new packages available.
6908 So, in \SpecialChar LyX
6910 \begin_inset Flex Noun
6913 \begin_layout Plain Layout
6916 \SpecialChar menuseparator
6922 and then restart \SpecialChar LyX
6926 \begin_layout Standard
6927 Now the package is installed.
6928 In our example, the document class
6929 \begin_inset Flex Code
6932 \begin_layout Plain Layout
6938 will now be available under
6939 \begin_inset Flex Noun
6942 \begin_layout Plain Layout
6943 Document\SpecialChar menuseparator
6944 Settings\SpecialChar menuseparator
6951 \begin_inset Quotes eld
6955 \begin_inset Quotes erd
6962 \begin_layout Standard
6963 If you would like to use a \SpecialChar LaTeX
6964 document class that is not even listed in the
6966 \begin_inset Flex Noun
6969 \begin_layout Plain Layout
6970 Document\SpecialChar menuseparator
6971 Settings\SpecialChar menuseparator
6977 , then you need to create a `layout' file for it.
6978 That is the topic of the next section.
6981 \begin_layout Section
6982 Types of layout files
6985 \begin_layout Standard
6986 This section describes the various sorts of \SpecialChar LyX
6987 files that contain layout informati
6989 These files describe various paragraph and character styles, determining
6990 how \SpecialChar LyX
6991 should display them and how they should be translated into \SpecialChar LaTeX
6993 XHTML, or whatever output format is being used.
6997 \begin_layout Standard
6998 We shall try to provide a thorough description of the process of writing
7000 However, there are so many different types of documents supported even
7001 by just \SpecialChar LaTeX
7002 that we can't hope to cover every different possibility or problem
7003 you might encounter.
7004 The \SpecialChar LyX
7005 users' list is frequented by people with lots of experience with layout
7006 design who are willing to share what they've learned, so please feel free
7007 to ask questions there.
7010 \begin_layout Standard
7011 As you prepare to write a new layout, it is extremely helpful to look at
7012 the layouts distributed with \SpecialChar LyX
7014 If you write a \SpecialChar LyX
7015 layout for a \SpecialChar LaTeX
7016 document class that might also be used by
7017 others, or write a module that might be useful to others, then you should
7018 consider posting your layout to the
7019 \begin_inset CommandInset href
7021 name "layout section on the LyX wiki"
7022 target "https://wiki.lyx.org/Layouts/Layouts"
7027 or even to the \SpecialChar LyX
7028 developers' list, so that it might be included in \SpecialChar LyX
7033 \begin_layout Plain Layout
7034 Note that \SpecialChar LyX
7035 is licensed under the General Public License, so any material
7036 that is contributed to \SpecialChar LyX
7037 must be similarly licensed.
7045 \begin_layout Subsection
7047 \begin_inset CommandInset label
7049 name "subsec:Layout-modules"
7056 \begin_layout Standard
7057 We have spoken to this point about `layout files'.
7058 But there are different sorts of files that contain layout information.
7059 Layout files, strictly so called, have the
7060 \begin_inset Flex Code
7063 \begin_layout Plain Layout
7069 extension and provide \SpecialChar LyX
7070 with information about document classes.
7071 Since \SpecialChar LyX
7072 1.6 layout information can also be contained in layout
7077 \begin_inset Flex Code
7080 \begin_layout Plain Layout
7087 Modules are to \SpecialChar LaTeX
7088 packages much as layouts are to \SpecialChar LaTeX
7089 classes, and some modules—such
7091 \begin_inset Flex Code
7094 \begin_layout Plain Layout
7100 module—specifically provide support for one package.
7101 In a sense, layout modules are similar to included
7105 \begin_layout Plain Layout
7106 These can have any extension, but by convention have the
7107 \begin_inset Flex Code
7110 \begin_layout Plain Layout
7122 \begin_inset Flex Code
7125 \begin_layout Plain Layout
7131 —in that modules are not specific to a given document class but may be used
7132 with many different classes.
7133 The difference is that using an included file with
7134 \begin_inset Flex Code
7137 \begin_layout Plain Layout
7143 requires editing that file.
7144 Modules, by contrast, are selected in the
7145 \begin_inset Flex Noun
7148 \begin_layout Plain Layout
7149 Document\SpecialChar menuseparator
7158 \begin_layout Standard
7159 Building modules is the easiest way to get started with layout editing,
7160 since it can be as simple as adding a single new paragraph style or flex
7162 But modules may, in principle, contain anything a layout file can contain.
7165 \begin_layout Standard
7166 After creating a new module and copying it to the
7167 \begin_inset Flex Code
7170 \begin_layout Plain Layout
7176 folder, you will need to reconfigure and then restart \SpecialChar LyX
7179 However, changes you make to the module will be seen immediately, if you
7181 \begin_inset Flex Noun
7184 \begin_layout Plain Layout
7185 Document\SpecialChar menuseparator
7191 , highlight something, and then hit
7192 \begin_inset Quotes eld
7196 \begin_inset Quotes erd
7202 It is strongly recommended that you save your work before doing this
7207 it is strongly recommended that you not attempt to edit modules while simultaneo
7208 usly working on actual documents
7211 Though of course the developers strive to keep \SpecialChar LyX
7212 stable in such situations,
7213 syntax errors and the like in your module file could cause strange behavior.
7216 \begin_layout Subsubsection
7220 \begin_layout Standard
7221 Modules are to \SpecialChar LyX
7222 as packages are to \SpecialChar LaTeX
7224 Sometimes, however, you find yourself wanting a specific inset or character
7225 style just for one document and writing a module that will also be available
7226 to other documents makes little sense.
7227 What you need is \SpecialChar LyX
7229 \begin_inset Quotes eld
7233 \begin_inset Quotes erd
7239 \begin_layout Standard
7240 You will find it under
7242 Document\SpecialChar menuseparator
7243 Settings\SpecialChar menuseparator
7247 The large text box allows you to enter anything that you might enter in
7248 a layout file or module.
7249 You can think of a document's local layout, in fact, as a module that belongs
7251 So, in particular, you must enter a
7252 \begin_inset Flex Code
7255 \begin_layout Plain Layout
7262 Any format is acceptable, but one would normally use the format current
7264 (In \SpecialChar LyX
7271 , the current layout format is
7280 \begin_layout Standard
7281 When you have entered something in the
7282 \begin_inset Flex Code
7285 \begin_layout Plain Layout
7291 pane, \SpecialChar LyX
7293 \begin_inset Quotes eld
7297 \begin_inset Quotes erd
7300 button at the bottom.
7301 Clicking this button will cause \SpecialChar LyX
7302 to determine whether what you have entered
7303 is valid layout information for the chosen format.
7305 will report the result but, unfortunately, will not tell you what errors
7306 there might have been.
7307 These will be written to the terminal, however, if \SpecialChar LyX
7308 is started from a terminal.
7309 You will not be permitted to save your local layout until you have entered
7313 \begin_layout Standard
7314 The warnings at the end of the previous section apply here, too.
7315 Do not play with local layout while you are actually working, especially
7316 if you have not saved your document.
7317 That said, using local layout with a test document can be a very convenient
7318 way to try out layout ideas, or even to start developing a module.
7321 \begin_layout Subsection
7323 \begin_inset Flex Noun
7326 \begin_layout Plain Layout
7335 \begin_layout Standard
7336 There are two situations you are likely to encounter when wanting to support
7337 a new \SpecialChar LaTeX
7338 document class, involving style (
7339 \begin_inset Flex Code
7342 \begin_layout Plain Layout
7348 ) files and \SpecialChar LaTeX2e
7350 \begin_inset Flex Code
7353 \begin_layout Plain Layout
7360 Supporting a style file is usually fairly easy.
7361 Supporting a new class file is a bit harder.
7362 We'll discuss the former in this section and the latter in the next.
7364 \change_deleted 5863208 1594239023
7365 Similar remarks apply, of course, if you want to support a new DocBook DTD.
7370 \begin_layout Standard
7371 The easier case is the one in which your new document class is provided
7372 as a style file that is to be used in conjunction with an already supported
7374 For the sake of the example, we'll assume that the style file is called
7376 \begin_inset Flex Noun
7379 \begin_layout Plain Layout
7385 and that it is meant to be used with
7386 \begin_inset Flex Noun
7389 \begin_layout Plain Layout
7395 , which is a standard class.
7399 \begin_layout Standard
7400 Start by copying the existing class's layout file into your local directory:
7404 \begin_layout Plain Layout
7405 Of course, which directory is your local directory will vary by platform,
7406 and \SpecialChar LyX
7407 allows you to specify your local directory on startup, too, using
7409 \begin_inset Flex Code
7412 \begin_layout Plain Layout
7426 \begin_layout LyX-Code
7427 cp report.layout ~/.lyx/layouts/myclass.layout
7430 \begin_layout Standard
7432 \begin_inset Flex Code
7435 \begin_layout Plain Layout
7441 and change the line:
7444 \begin_layout LyX-Code
7447 DeclareLaTeXClass{Report (Standard Class)}
7450 \begin_layout Standard
7454 \begin_layout LyX-Code
7457 DeclareLaTeXClass[report, myclass.sty]{Report (My Class)}
7460 \begin_layout Standard
7464 \begin_layout LyX-Code
7466 \begin_inset Newline newline
7472 \begin_inset Newline newline
7478 \begin_layout Standard
7479 near the top of the file.
7482 \begin_layout Standard
7483 Start \SpecialChar LyX
7485 \begin_inset Flex Noun
7488 \begin_layout Plain Layout
7489 Tools\SpecialChar menuseparator
7496 Then restart \SpecialChar LyX
7497 and try creating a new document.
7499 \begin_inset Flex Noun
7502 \begin_layout Plain Layout
7508 " as a document class option in the
7509 \begin_inset Flex Noun
7512 \begin_layout Plain Layout
7513 Document\SpecialChar menuseparator
7520 It is likely that some of the sectioning commands and such in your new
7521 class will work differently from how they worked in the base class—
7522 \begin_inset Flex Code
7525 \begin_layout Plain Layout
7531 in this example—so you can fiddle around with the settings for the different
7532 sections if you wish.
7533 The layout information for sections is contained in
7534 \begin_inset Flex Code
7537 \begin_layout Plain Layout
7543 , but you do not need to copy and change this file.
7544 Instead, you can simply add your changes to your layout file, after the
7546 \begin_inset Flex Code
7549 \begin_layout Plain Layout
7555 , which itself includes
7556 \begin_inset Flex Code
7559 \begin_layout Plain Layout
7566 For example, you might add these lines:
7569 \begin_layout LyX-Code
7573 \begin_layout LyX-Code
7577 \begin_layout LyX-Code
7581 \begin_layout LyX-Code
7585 \begin_layout LyX-Code
7589 \begin_layout Standard
7590 to change the font for chapter headings to sans-serif.
7591 This will override (or, in this case, add to) the existing declaration
7592 for the Chapter style.
7596 \begin_layout Standard
7597 Your new package may also provide commands or environments not present in
7599 In this case, you will want to add these to the layout file.
7601 \begin_inset CommandInset ref
7603 reference "sec:TextClass"
7607 for information on how to do so.
7610 \begin_layout Standard
7612 \begin_inset Flex Noun
7615 \begin_layout Plain Layout
7621 can be used with several different document classes, and even if it cannot,
7622 you might find it easiest just to write a module that you can load with
7624 The simplest possible such module would be:
7627 \begin_layout LyX-Code
7630 DeclareLyXModule{My Class}
7633 \begin_layout LyX-Code
7637 \begin_layout LyX-Code
7638 #Support for myclass.sty.
7641 \begin_layout LyX-Code
7643 \begin_inset Newline newline
7649 \begin_layout LyX-Code
7657 \begin_inset Newline newline
7663 \begin_layout LyX-Code
7665 \begin_inset Newline newline
7671 \begin_inset Newline newline
7677 \begin_layout Standard
7678 A more complex module might modify the behavior of some existing constructs
7679 or define some new ones.
7681 \begin_inset CommandInset ref
7683 reference "sec:TextClass"
7690 \begin_layout Subsection
7692 \begin_inset Flex Noun
7695 \begin_layout Plain Layout
7704 \begin_layout Standard
7705 There are two possibilities here.
7706 One is that the class file is itself based upon an existing document class.
7707 For example, many thesis classes are based upon
7708 \begin_inset Flex Noun
7711 \begin_layout Plain Layout
7718 To see whether yours is, look for a line like
7721 \begin_layout LyX-Code
7727 \begin_layout Standard
7729 If so, then you may proceed largely as in the previous section, though
7731 \begin_inset Flex Code
7734 \begin_layout Plain Layout
7735 Declare\SpecialChar LaTeX
7741 line will be different.
7742 If your new class is
7743 \begin_inset Flex Code
7746 \begin_layout Plain Layout
7752 and it is based upon
7753 \begin_inset Flex Code
7756 \begin_layout Plain Layout
7762 , then the line should read:
7766 \begin_layout Plain Layout
7767 And it will be easiest if you save the file to
7768 \begin_inset Flex Code
7771 \begin_layout Plain Layout
7778 assumes that the document class has the same name as the layout file.
7787 \begin_layout LyX-Code
7790 DeclareLaTeXClass[thesis,book]{thesis}
7793 \begin_layout Standard
7794 If, on the other hand, the new class is not based upon an existing class,
7795 you will probably have to
7796 \begin_inset Quotes eld
7800 \begin_inset Quotes erd
7804 We strongly suggest copying an existing layout file which uses a similar
7806 class and then modifying it, if you can do so.
7807 At least use an existing file as a starting point so you can find out what
7808 items you need to worry about.
7809 Again, the specifics are covered below.
7812 \begin_layout Subsection
7814 \begin_inset CommandInset label
7816 name "subsec:Creating-Templates"
7823 \begin_layout Standard
7824 Once you have written a layout file for a new document class, you might
7825 want to consider writing a
7830 A template acts as a kind of tutorial for your layout, showing how it might
7831 be used, though containing dummy content.
7832 You can of course look at the various templates included with \SpecialChar LyX
7836 \begin_layout Standard
7837 Templates are created just like usual documents: using \SpecialChar LyX
7839 The only difference is that usual documents contain all possible settings,
7840 including the font scheme and the paper size.
7841 Usually a user doesn't want a template to overwrite his preferred settings
7842 for such parameters.
7843 For that reason, the designer of a template should remove the corresponding
7845 \begin_inset Flex Code
7848 \begin_layout Plain Layout
7857 \begin_inset Flex Code
7860 \begin_layout Plain Layout
7868 from the template \SpecialChar LyX
7870 This can be done with any simple text-editor, for example
7871 \begin_inset Flex Code
7874 \begin_layout Plain Layout
7881 \begin_inset Flex Code
7884 \begin_layout Plain Layout
7893 \begin_layout Standard
7894 Put the edited template files you create in
7895 \begin_inset Flex Code
7898 \begin_layout Plain Layout
7904 , copy the ones you use from the global template directory in
7905 \begin_inset Flex Code
7908 \begin_layout Plain Layout
7914 to the same place, and redefine the template path in the
7915 \begin_inset Flex Noun
7918 \begin_layout Plain Layout
7919 Tools\SpecialChar menuseparator
7920 Preferences\SpecialChar menuseparator
7929 \begin_layout Standard
7930 Note, by the way, that there is a template which has a particular meaning:
7931 \begin_inset Newline linebreak
7935 \begin_inset Flex Code
7938 \begin_layout Plain Layout
7945 This template is loaded every time you create a new document with
7946 \begin_inset Flex Noun
7949 \begin_layout Plain Layout
7950 File\SpecialChar menuseparator
7956 in order to provide useful defaults.
7957 To create this template from inside \SpecialChar LyX
7958 , all you have to do is to open a document
7959 with the correct settings, and use the
7960 \begin_inset Flex Noun
7963 \begin_layout Plain Layout
7964 Save as Document Defaults
7972 \begin_layout Subsection
7973 Upgrading old layout files
7976 \begin_layout Standard
7977 The format of layout files changes with each \SpecialChar LyX
7978 release, so old layout files
7979 need to be converted to the new format.
7981 reads a layout file in an older format, it automatically calls the
7983 \begin_inset Flex Code
7986 \begin_layout Plain Layout
7992 to convert it to a temporary file in current format.
7993 The original file is left untouched.
7994 If you use the layout file often, then, you may want to convert it permanently,
7995 so that \SpecialChar LyX
7996 does not have to do so itself every time.
7997 To do this, you can call the converter manually:
8000 \begin_layout Enumerate
8002 \begin_inset Flex Code
8005 \begin_layout Plain Layout
8012 \begin_inset Flex Code
8015 \begin_layout Plain Layout
8024 \begin_layout Enumerate
8026 \begin_inset Newline newline
8030 \begin_inset Flex Code
8033 \begin_layout Plain Layout
8034 python LyXDir/scripts/layout2layout.py myclass.old myclass.layout
8040 \begin_inset Newline newline
8044 \begin_inset Flex Code
8047 \begin_layout Plain Layout
8053 is the name of your \SpecialChar LyX
8057 \begin_layout Standard
8058 Note that manual conversion does not affect included files, so these will
8059 have to be converted separately.
8062 \begin_layout Subsection
8063 \begin_inset CommandInset label
8065 name "subsec:Cite-Engine-Files"
8072 \begin_layout Standard
8073 A specific form of layout files are the so-called
8074 \begin_inset Flex Code
8077 \begin_layout Plain Layout
8083 files that are located in the
8084 \begin_inset Flex Code
8087 \begin_layout Plain Layout
8094 Their purpose is to define the specifics of \SpecialChar LaTeX
8095 packages aimed at bibliography
8108 , but also the way how normal Bib\SpecialChar TeX
8109 citations (without additional packages)
8110 are handled in \SpecialChar LyX
8111 is defined in such a file.
8115 \begin_layout Standard
8116 More specifically, it is defined which packages \SpecialChar LyX
8117 needs to load, which citation
8118 commands are available, how these are to be displayed in \SpecialChar LyX
8120 the dialogs, the context menus) as well as in the XHTML and plain text
8122 Furthermore, the files specify available style variants (author-year, numerical
8123 , etc.) and their specifics.
8124 The cite engine files are also used to generate the options that are available
8127 Document\SpecialChar menuseparator
8128 Settings\SpecialChar menuseparator
8129 Bibliography\SpecialChar menuseparator
8135 \begin_layout Standard
8136 Even though a cite engine file is essentially a normal layout file that
8137 could theoretically include any layout information, it usually primarily
8138 includes some specific parameters such as
8139 \begin_inset Flex Code
8142 \begin_layout Plain Layout
8149 \begin_inset Flex Code
8152 \begin_layout Plain Layout
8159 \begin_inset Flex Code
8162 \begin_layout Plain Layout
8169 \begin_inset Flex Code
8172 \begin_layout Plain Layout
8179 The syntax of the latter two is described in
8180 \begin_inset CommandInset ref
8182 reference "subsec:Citation-engine-description"
8190 \begin_inset CommandInset ref
8192 reference "subsec:Citation-format-description"
8196 , as well as in the files themselves.
8199 \begin_layout Section
8200 \begin_inset CommandInset label
8202 name "sec:TextClass"
8206 The layout file format
8209 \begin_layout Standard
8210 The following sections describe how layout files are structured and written.
8211 Our advice is to go slowly, save and test often.
8212 It is really not that hard, except that the multitude of options can become
8213 overwhelming, especially if you try to check out too many at once.
8214 It becomes easier if you use existing layouts of \SpecialChar LyX
8215 as examples/reference
8216 or if you modify an existing layout to your needs.
8219 \begin_layout Standard
8220 Note that all the tags used in layout files are case-insensitive.
8222 \begin_inset Flex Code
8225 \begin_layout Plain Layout
8232 \begin_inset Flex Code
8235 \begin_layout Plain Layout
8242 \begin_inset Flex Code
8245 \begin_layout Plain Layout
8251 are really the same tag.
8252 The possible arguments are printed in brackets after the tag's name.
8253 The default argument is typeset
8254 \begin_inset Flex Code
8257 \begin_layout Plain Layout
8266 If the argument has a data type like
8267 \begin_inset Quotes eld
8271 \begin_inset Quotes erd
8275 \begin_inset Quotes eld
8279 \begin_inset Quotes erd
8282 , the default is shown like this:
8283 \begin_inset Flex Code
8286 \begin_layout Plain Layout
8297 \begin_layout Subsection
8298 The document class declaration and classification
8301 \begin_layout Standard
8302 Lines in a layout file which begin with
8303 \begin_inset Flex Code
8306 \begin_layout Plain Layout
8313 There is one exception to this rule.
8315 \begin_inset Flex Code
8318 \begin_layout Plain Layout
8324 files should begin with lines like:
8327 \begin_layout LyX-Code
8330 #% Do not delete the line below; configure depends on this
8333 \begin_layout LyX-Code
8338 DeclareLaTeXClass{Article (Standard Class)}
8341 \begin_layout LyX-Code
8346 DeclareCategory{Articles}
8349 \begin_layout Standard
8350 The second and third lines are used when you (re)configure \SpecialChar LyX
8352 The layout file is read by the \SpecialChar LaTeX
8354 \begin_inset Flex Code
8357 \begin_layout Plain Layout
8363 , in a special mode where
8364 \begin_inset Flex Code
8367 \begin_layout Plain Layout
8374 The first line is just a \SpecialChar LaTeX
8375 comment, the second one contains the mandatory
8376 declaration of the text class and the third line contains the optional
8377 classification of the class.
8378 If these lines appear in a file named
8379 \begin_inset Flex Code
8382 \begin_layout Plain Layout
8388 , then they define a text class of name
8389 \begin_inset Flex Code
8392 \begin_layout Plain Layout
8398 (the name of the layout file) which uses the \SpecialChar LaTeX
8400 \begin_inset Flex Code
8403 \begin_layout Plain Layout
8409 (the default is to use the same name as the layout).
8411 \begin_inset Quotes eld
8414 Article (Standard Class)
8415 \begin_inset Quotes erd
8418 that appears above is used as a description of the text class in the
8419 \begin_inset Flex Noun
8422 \begin_layout Plain Layout
8423 Document\SpecialChar menuseparator
8431 \begin_inset Quotes eld
8435 \begin_inset Quotes erd
8438 in the example) is also used in the
8439 \begin_inset Flex Noun
8442 \begin_layout Plain Layout
8443 Document\SpecialChar menuseparator
8449 dialog: the text classes are grouped by these categories (which are usually
8450 genres, so typical categories are
8451 \begin_inset Quotes eld
8455 \begin_inset Quotes erd
8459 \begin_inset Quotes eld
8463 \begin_inset Quotes erd
8467 \begin_inset Quotes eld
8471 \begin_inset Quotes erd
8475 \begin_inset Quotes eld
8479 \begin_inset Quotes erd
8483 \begin_inset Quotes eld
8487 \begin_inset Quotes erd
8491 \begin_inset Quotes eld
8495 \begin_inset Quotes erd
8499 If no category has been declared, the class will be put in the
8500 \begin_inset Quotes eld
8504 \begin_inset Quotes erd
8510 \begin_layout Standard
8511 Let's assume that you wrote your own text class that uses the
8512 \begin_inset Flex Code
8515 \begin_layout Plain Layout
8521 document class, but where you changed the appearance of the section headings.
8522 If you put it in a file
8523 \begin_inset Flex Code
8526 \begin_layout Plain Layout
8532 , the header of this file should be:
8535 \begin_layout LyX-Code
8538 #% Do not delete the line below; configure depends on this
8541 \begin_layout LyX-Code
8546 DeclareLaTeXClass[article]{Article (with My Own Headings)}
8549 \begin_layout LyX-Code
8554 DeclareCategory{Articles}
8557 \begin_layout Standard
8558 This declares a text class
8559 \begin_inset Flex Code
8562 \begin_layout Plain Layout
8568 , associated with the \SpecialChar LaTeX
8570 \begin_inset Flex Code
8573 \begin_layout Plain Layout
8580 \begin_inset Quotes eld
8583 Article (with My Own Headings)
8584 \begin_inset Quotes erd
8588 If your text class depends on several packages, you can declare it as:
8591 \begin_layout LyX-Code
8594 #% Do not delete the line below; configure depends on this
8597 \begin_layout LyX-Code
8602 DeclareLaTeXClass[article,foo.sty]{Article (with My Own Headings)}
8605 \begin_layout LyX-Code
8610 DeclareCategory{Articles}
8613 \begin_layout Standard
8614 This indicates that your text class uses the
8615 \begin_inset Flex Code
8618 \begin_layout Plain Layout
8626 \change_deleted 5863208 1594239179
8627 Finally, it is also possible to declare classes for DocBook code.
8628 Typical declarations will look like:
8631 \begin_layout LyX-Code
8633 \change_deleted 5863208 1594239179
8636 #% Do not delete the line below; configure depends on this
8639 \begin_layout LyX-Code
8641 \change_deleted 5863208 1594239179
8646 DeclareDocBookClass[article]{SGML (DocBook Article)}
8649 \begin_layout LyX-Code
8651 \change_deleted 5863208 1594239179
8656 DeclareCategory{Articles (DocBook)}
8661 \begin_layout Standard
8662 Note that these declarations can also be given an optional parameter declaring
8663 the name of the document class (but not a list).
8666 \begin_layout Standard
8667 So, to be as explicit as possible, the form of the layout declaration is:
8670 \begin_layout LyX-Code
8675 DeclareLaTeXClass[class,package.sty]{layout description}
8678 \begin_layout LyX-Code
8683 DeclareCategory{category}
8686 \begin_layout Standard
8687 The class need only be specified if the name of the \SpecialChar LaTeX
8689 name of the layout file are different or if there are packages to load.
8690 If the name of the class file is not specified, then \SpecialChar LyX
8692 that it is the same as the name of the layout file.
8695 \begin_layout Standard
8696 When the text class has been modified to your taste, all you have to do
8697 is to copy it either to
8698 \begin_inset Flex Code
8701 \begin_layout Plain Layout
8708 \begin_inset Flex Code
8711 \begin_layout Plain Layout
8718 \begin_inset Flex Noun
8721 \begin_layout Plain Layout
8722 Tools\SpecialChar menuseparator
8728 , exit \SpecialChar LyX
8730 Then your new text class should be available along with the others.
8733 \begin_layout Standard
8734 Once the layout file is installed, you can edit it and see your changes
8735 without having to reconfigure or to restart \SpecialChar LyX
8740 \begin_layout Plain Layout
8741 In versions of \SpecialChar LyX
8742 prior to 1.6, this was not true.
8743 As a result, editing layout files was very time consuming, since you had
8744 constantly to restart \SpecialChar LyX
8750 You can force a reload of the current layout by using the \SpecialChar LyX
8752 \begin_inset Flex Noun
8755 \begin_layout Plain Layout
8762 There is no default binding for this function—though, of course, you can
8763 bind it to a key yourself.
8764 But you will normally use this function simply by entering it in the mini-buffe
8769 \begin_layout Standard
8775 \begin_inset Flex Noun
8778 \begin_layout Plain Layout
8784 is very much an `advanced feature'.
8789 recommended that you save your work before using this function.
8794 recommended that you not attempt to edit layout information while simultaneousl
8795 y working on a document that you care about.
8796 Use a test document.
8797 Syntax errors and the like in your layout file could cause peculiar behavior.
8798 In particular, such errors could cause \SpecialChar LyX
8799 to regard the current layout as
8800 invalid and to attempt to switch to some other layout.
8804 \begin_layout Plain Layout
8805 Really bad syntax errors may even caused \SpecialChar LyX
8807 This is because certain sorts of errors may make \SpecialChar LyX
8818 The \SpecialChar LyX
8819 team strives to keep \SpecialChar LyX
8820 stable in such situations, but safe is better
8825 \begin_layout Plain Layout
8826 While we're giving advice: make regular backups.
8827 And be nice to your mother.
8835 \begin_layout Subsection
8836 The Module declaration
8839 \begin_layout Standard
8840 A module must begin with a line like the following:
8843 \begin_layout LyX-Code
8846 DeclareLyXModule[endnotes.sty]{Endnotes}
8847 \change_inserted -712698321 1554395911
8851 \begin_layout LyX-Code
8853 \change_inserted -712698321 1554395924
8858 DeclareCategory{Foot- and Endnotes}
8859 \change_deleted -712698321 1554395911
8867 \begin_layout Standard
8868 The mandatory argument
8869 \change_inserted -712698321 1554395956
8878 , in curly brackets, is the name of the module, as it should appear in
8879 \begin_inset Flex Noun
8882 \begin_layout Plain Layout
8883 Document\SpecialChar menuseparator
8884 Settings\SpecialChar menuseparator
8891 The argument in square brackets is optional: It declares any \SpecialChar LaTeX
8893 on which the module depends.
8894 It is also possible to use the form
8895 \begin_inset Flex Noun
8898 \begin_layout Plain Layout
8904 as an optional argument, which declares that the module can only be used
8905 when there exists a conversion chain between the formats `
8906 \begin_inset Flex Code
8909 \begin_layout Plain Layout
8916 \begin_inset Flex Code
8919 \begin_layout Plain Layout
8927 \change_inserted -712698321 1554396133
8934 declaration is not strictly mandatory, but you should add it, since it
8935 is helpful to find the module.
8936 Please have a look at the existing module categories and if appropriate,
8942 \begin_layout Standard
8944 \change_inserted -712698321 1554395988
8947 declaration should then be followed by lines like the following:
8951 \begin_layout Plain Layout
8952 Preferably in English if the module should be published with \SpecialChar LyX
8954 This description will appear in the list of messages to be translated and
8955 will be thus translated with the next interface update.
8963 \begin_layout LyX-Code
8967 \begin_layout LyX-Code
8968 #Adds an endnote command, in addition to footnotes.
8972 \begin_layout LyX-Code
8973 #You will need to add
8975 theendnotes in TeX code where you
8978 \begin_layout LyX-Code
8979 #want the endnotes to appear.
8983 \begin_layout LyX-Code
8987 \begin_layout LyX-Code
8988 #Requires: somemodule | othermodule
8991 \begin_layout LyX-Code
8992 #Excludes: badmodule
8995 \begin_layout Standard
8996 The description is used in
8997 \begin_inset Flex Noun
9000 \begin_layout Plain Layout
9001 Document\SpecialChar menuseparator
9002 Settings\SpecialChar menuseparator
9008 to provide the user with information about what the module does.
9010 \begin_inset Flex Code
9013 \begin_layout Plain Layout
9019 line is used to identify other modules with which this one must be used;
9021 \begin_inset Flex Code
9024 \begin_layout Plain Layout
9030 line is used to identify modules with which this one may not be used.
9031 Both are optional, and, as shown, multiple modules should be separated
9032 with the pipe symbol: |.
9033 Note that the required modules are treated disjunctively:
9037 of the required modules must be used.
9042 excluded module may be used.
9043 Note that modules are identified here by their filenames without the
9044 \begin_inset Flex Code
9047 \begin_layout Plain Layout
9055 \begin_inset Flex Code
9058 \begin_layout Plain Layout
9065 \begin_inset Flex Code
9068 \begin_layout Plain Layout
9077 \begin_layout Subsection
9078 The CiteEngine file declaration
9081 \begin_layout Standard
9082 A cite engine file must begin with a line like the following:
9085 \begin_layout LyX-Code
9088 DeclareLyXCiteEngineModule[biblatex.sty]{Biblatex}
9091 \begin_layout Standard
9092 The mandatory argument, in curly brackets, is the name of the cite style,
9093 as it should appear in
9094 \begin_inset Flex Noun
9097 \begin_layout Plain Layout
9098 Document\SpecialChar menuseparator
9099 Settings\SpecialChar menuseparator
9106 The argument in square brackets is optional: It declares any \SpecialChar LaTeX
9108 on which the cite engine depends.
9111 \begin_layout Standard
9112 The cite engine declaration should then be followed by lines like the following:
9116 \begin_layout Plain Layout
9117 Preferably in English if the module should be published with \SpecialChar LyX
9119 This description will appear in the list of messages to be translated and
9120 will be thus translated with the next interface update.
9128 \begin_layout LyX-Code
9132 \begin_layout LyX-Code
9133 # Biblatex supports many author-year and numerical styles.
9136 \begin_layout LyX-Code
9137 # It is mainly aimed at the Humanities.
9141 \begin_layout LyX-Code
9142 # customizable, fully localized and provides many features
9145 \begin_layout LyX-Code
9146 # that are not possible with BibTeX.
9147 The use of 'biber' as
9150 \begin_layout LyX-Code
9151 # bibliography processor is advised.
9154 \begin_layout LyX-Code
9158 \begin_layout Standard
9159 The description is used in
9160 \begin_inset Flex Noun
9163 \begin_layout Plain Layout
9164 Document\SpecialChar menuseparator
9165 Settings\SpecialChar menuseparator
9171 to provide the user with information about the cite engine.
9174 \begin_layout Subsection
9178 \begin_layout Standard
9179 The first non-comment line of any layout file, included file, or module
9184 contain the file format number:
9187 \begin_layout Description
9188 \begin_inset Flex Code
9191 \begin_layout Plain Layout
9198 \begin_inset Flex Code
9201 \begin_layout Plain Layout
9207 ] The format number of the layout file.
9210 \begin_layout Standard
9211 This tag was introduced with \SpecialChar LyX
9213 \begin_inset space ~
9217 Layout files from older \SpecialChar LyX
9218 versions do not have an explicit file format and
9219 are considered to have
9220 \begin_inset Flex Code
9223 \begin_layout Plain Layout
9225 \begin_inset space ~
9234 The format for the present version of \SpecialChar LyX
9236 But each version of \SpecialChar LyX
9237 is capable of reading earlier versions' layout files,
9238 just as they are capable of reading files produced by earlier versions
9241 There is, however, no provision for converting to earlier formats.
9244 \begin_layout Subsection
9245 \begin_inset CommandInset label
9247 name "subsec:General-text-class"
9251 General text class parameters
9254 \begin_layout Standard
9255 These are general parameters that govern the behavior of an entire document
9261 mean that they must appear in
9262 \begin_inset Flex Code
9265 \begin_layout Plain Layout
9271 files rather than in modules.
9272 A module can contain any layout tag.)
9275 \begin_layout Description
9277 \change_inserted -712698321 1526899478
9278 \begin_inset Flex Code
9281 \begin_layout Plain Layout
9283 \change_inserted -712698321 1526898610
9284 AddToCiteEngine <engine>
9291 Extends the possibilities for displaying citation references.
9293 \begin_inset CommandInset ref
9295 reference "subsec:Citation-engine-description"
9304 \begin_inset Flex Code
9307 \begin_layout Plain Layout
9309 \change_inserted -712698321 1526898823
9320 \begin_layout Description
9321 \begin_inset Flex Code
9324 \begin_layout Plain Layout
9330 Adds information that will be output in the
9331 \begin_inset Flex Code
9334 \begin_layout Plain Layout
9340 block when the document is output to XHTML.
9341 Typically, this would be used to output CSS style information, but it can
9342 be used for anything that can appear in
9343 \begin_inset Flex Code
9346 \begin_layout Plain Layout
9354 \begin_inset Quotes eld
9358 \begin_inset Flex Code
9361 \begin_layout Plain Layout
9368 \begin_inset Quotes erd
9374 \begin_layout Description
9375 \begin_inset Flex Code
9378 \begin_layout Plain Layout
9384 Adds information to the document preamble.
9386 \begin_inset Newline newline
9390 \begin_inset Quotes eld
9394 \begin_inset Flex Code
9397 \begin_layout Plain Layout
9404 \begin_inset Quotes erd
9408 \change_inserted -712698321 1562592950
9412 \begin_layout Description
9414 \change_inserted -712698321 1562593040
9415 \begin_inset Flex Code
9418 \begin_layout Plain Layout
9420 \change_inserted -712698321 1562592954
9429 \begin_inset Flex Code
9432 \begin_layout Plain Layout
9434 \change_inserted -712698321 1562592950
9445 \begin_inset space \thinspace{}
9449 \begin_inset Flex Code
9452 \begin_layout Plain Layout
9454 \change_inserted -712698321 1562592950
9462 ] If the document class adds the bibliography to the table of contents,
9463 add this option with value
9464 \begin_inset Flex Code
9467 \begin_layout Plain Layout
9469 \change_inserted -712698321 1562592996
9478 \begin_inset Flex Code
9481 \begin_layout Plain Layout
9483 \change_inserted -712698321 1562593006
9492 This prevents the bibliography from being added twice.
9497 \begin_layout Description
9498 \begin_inset Flex Code
9501 \begin_layout Plain Layout
9507 Defines the possibilities for displaying citation references.
9509 \begin_inset CommandInset ref
9511 reference "subsec:Citation-engine-description"
9520 \begin_inset Quotes eld
9524 \begin_inset Flex Code
9527 \begin_layout Plain Layout
9534 \begin_inset Quotes erd
9538 Primarily used in cite engine files (see
9539 \begin_inset CommandInset ref
9541 reference "subsec:Cite-Engine-Files"
9550 \change_inserted -712698321 1526898530
9551 Note that if you specify this in a layout file or module, any cite engine
9552 definition will be overridden.
9554 \begin_inset Flex Code
9557 \begin_layout Plain Layout
9559 \change_inserted -712698321 1526898530
9572 \begin_layout Description
9573 \begin_inset Flex Code
9576 \begin_layout Plain Layout
9582 Defines formats for use in the display of bibliographic information.
9584 \begin_inset CommandInset ref
9586 reference "subsec:Citation-format-description"
9592 \begin_inset Quotes eld
9596 \begin_inset Flex Code
9599 \begin_layout Plain Layout
9606 \begin_inset Quotes erd
9610 Primarily used in cite engine files (see
9611 \begin_inset CommandInset ref
9613 reference "subsec:Cite-Engine-Files"
9622 \change_inserted -712698321 1526898585
9623 A cite format defined in a layout or module will override the cite engine
9629 \begin_layout Description
9630 \begin_inset Flex Code
9633 \begin_layout Plain Layout
9640 \begin_inset Flex Code
9643 \begin_layout Plain Layout
9652 \begin_inset Flex Code
9655 \begin_layout Plain Layout
9661 ] Determines whether
9665 or Bib\SpecialChar TeX
9666 is used to generate a Bibliography.
9667 Primarily used in cite engine files (see
9668 \begin_inset CommandInset ref
9670 reference "subsec:Cite-Engine-Files"
9680 \begin_layout Description
9681 \begin_inset Flex Code
9684 \begin_layout Plain Layout
9690 Describes various global options supported by the document class.
9692 \begin_inset CommandInset ref
9694 reference "subsec:ClassOptions"
9700 \begin_inset Quotes eld
9704 \begin_inset Flex Code
9707 \begin_layout Plain Layout
9714 \begin_inset Quotes erd
9720 \begin_layout Description
9721 \begin_inset Flex Code
9724 \begin_layout Plain Layout
9731 \begin_inset Flex Code
9734 \begin_layout Plain Layout
9743 \begin_inset space \thinspace{}
9747 \begin_inset Flex Code
9750 \begin_layout Plain Layout
9756 ] Whether the class should
9760 to having one or two columns.
9761 Can be changed in the
9762 \begin_inset Flex Noun
9765 \begin_layout Plain Layout
9766 Document\SpecialChar menuseparator
9775 \begin_layout Description
9776 \begin_inset Flex Code
9779 \begin_layout Plain Layout
9786 \begin_inset Flex Code
9789 \begin_layout Plain Layout
9795 ] This sequence defines the properties for a counter.
9796 If the counter does not yet exist, it is created; if it does exist, it
9799 \begin_inset Quotes eld
9803 \begin_inset Flex Code
9806 \begin_layout Plain Layout
9813 \begin_inset Quotes erd
9817 \begin_inset Newline newline
9821 \begin_inset CommandInset ref
9823 reference "subsec:Counters"
9827 for details on counters.
9830 \begin_layout Description
9831 \begin_inset Flex Code
9834 \begin_layout Plain Layout
9840 Sets the default font used to display the document.
9842 \begin_inset CommandInset ref
9844 reference "subsec:Font-description"
9848 for how to declare fonts.
9850 \begin_inset Quotes eld
9854 \begin_inset Flex Code
9857 \begin_layout Plain Layout
9864 \begin_inset Quotes erd
9870 \begin_layout Description
9871 \begin_inset Flex Code
9874 \begin_layout Plain Layout
9881 \begin_inset Flex Code
9884 \begin_layout Plain Layout
9890 ] Specifies a module to be included by default with this document class.
9891 The module is specified as filename without the
9892 \begin_inset Flex Code
9895 \begin_layout Plain Layout
9902 The user can still remove the module, but it will be active at the outset.
9903 (This applies only when new files are created, or when this class is chosen
9904 for an existing document.)
9907 \begin_layout Description
9908 \begin_inset Flex Code
9911 \begin_layout Plain Layout
9918 \begin_inset Flex Code
9921 \begin_layout Plain Layout
9927 ] This is the style that will be assigned to new paragraphs, usually
9928 \begin_inset Flex Noun
9931 \begin_layout Plain Layout
9938 This will default to the first defined style if not given, but you are
9939 encouraged to use this directive.
9942 \begin_layout Description
9944 \change_inserted -970929547 1515112870
9945 \begin_inset Flex Code
9948 \begin_layout Plain Layout
9950 \change_inserted -970929547 1515112782
9959 \begin_inset Flex Code
9962 \begin_layout Plain Layout
9964 \change_inserted -970929547 1515112766
9972 ] The root element (at the top of the document) to use when outputting documents
9973 with this class in DocBook.
9974 The default value is
9975 \begin_inset Quotes eld
9979 \begin_inset Flex Code
9982 \begin_layout Plain Layout
9984 \change_inserted -970929547 1515112845
9993 \begin_inset Quotes erd
9998 \change_deleted 1075283030 1594226862
10000 \change_inserted 1075283030 1594226777
10004 \begin_layout Description
10006 \change_inserted 1075283030 1594226859
10007 \begin_inset Flex Code
10010 \begin_layout Plain Layout
10012 \change_inserted 1075283030 1594226785
10013 DocBookForceAbstract
10021 \begin_inset Flex Code
10024 \begin_layout Plain Layout
10026 \change_inserted 1075283030 1594226804
10035 \begin_inset Quotes eld
10043 \begin_inset Quotes erd
10046 , the root element will always have an
10051 The default value is
10052 \begin_inset Quotes eld
10060 \begin_inset Quotes erd
10068 \begin_layout Description
10069 \begin_inset Flex Code
10072 \begin_layout Plain Layout
10079 \begin_inset Flex Code
10082 \begin_layout Plain Layout
10088 ] This tag indicates that the module (which is specified by filename without
10090 \begin_inset Flex Code
10093 \begin_layout Plain Layout
10099 extension) cannot be used with this document class.
10100 This might be used in a journal-specific layout file to prevent, say, the
10102 \begin_inset Flex Code
10105 \begin_layout Plain Layout
10111 module that numbers theorems by section.
10116 be used in a module.
10117 Modules have their own way of excluding other modules (see
10118 \begin_inset CommandInset ref
10120 reference "subsec:Layout-modules"
10127 \begin_layout Description
10128 \begin_inset Flex Code
10131 \begin_layout Plain Layout
10137 Defines a new float.
10139 \begin_inset CommandInset ref
10141 reference "subsec:Floats"
10147 \begin_inset Quotes eld
10151 \begin_inset Flex Code
10154 \begin_layout Plain Layout
10161 \begin_inset Quotes erd
10167 \begin_layout Description
10168 \begin_inset Flex Code
10171 \begin_layout Plain Layout
10177 Sets the information that will be output in the
10178 \begin_inset Flex Code
10181 \begin_layout Plain Layout
10187 block when this document class is output to XHTML.
10188 Note that this will completely override any prior
10189 \begin_inset Flex Code
10192 \begin_layout Plain Layout
10199 \begin_inset Flex Code
10202 \begin_layout Plain Layout
10210 \begin_inset Newline newline
10214 \begin_inset Flex Code
10217 \begin_layout Plain Layout
10223 if you just want to add material to the preamble.) Must end with
10224 \begin_inset Quotes eld
10228 \begin_inset Flex Code
10231 \begin_layout Plain Layout
10238 \begin_inset Quotes erd
10244 \begin_layout Description
10245 \begin_inset Flex Code
10248 \begin_layout Plain Layout
10255 \begin_inset Flex Code
10258 \begin_layout Plain Layout
10264 ] The style to use for the table of contents, bibliography, and so forth,
10265 when the document is output to HTML.
10266 For articles, this should normally be
10267 \begin_inset Flex Code
10270 \begin_layout Plain Layout
10277 \begin_inset Flex Code
10280 \begin_layout Plain Layout
10287 If it is not given, then \SpecialChar LyX
10288 will attempt to figure out which layout to use.
10291 \begin_layout Description
10292 \begin_inset Flex Code
10295 \begin_layout Plain Layout
10302 \begin_inset Flex Code
10305 \begin_layout Plain Layout
10311 ] Modifies the properties of the given counter.
10312 If the counter does not exist, the statement is ignored.
10314 \begin_inset Quotes eld
10318 \begin_inset Flex Code
10321 \begin_layout Plain Layout
10328 \begin_inset Quotes erd
10332 \begin_inset Newline newline
10336 \begin_inset CommandInset ref
10338 reference "subsec:Counters"
10342 for details on counters.
10345 \begin_layout Description
10346 \begin_inset Flex Code
10349 \begin_layout Plain Layout
10356 \begin_inset Flex Code
10359 \begin_layout Plain Layout
10365 ] This allows you to include another layout definition file within yours
10366 to avoid duplicating commands.
10367 Common examples are the standard layout files, for example,
10368 \begin_inset Flex Code
10371 \begin_layout Plain Layout
10377 , which contains most of the basic layouts.
10380 \begin_layout Description
10381 \begin_inset Flex Code
10384 \begin_layout Plain Layout
10391 \begin_inset Flex Code
10394 \begin_layout Plain Layout
10400 ] This section (re-)defines the layout of an inset.
10401 It can be applied to an existing inset or to a new, user-defined inset,
10402 e.g., a new character style.
10404 \begin_inset Quotes eld
10408 \begin_inset Flex Code
10411 \begin_layout Plain Layout
10418 \begin_inset Quotes erd
10422 \begin_inset Newline newline
10426 \begin_inset CommandInset ref
10428 reference "subsec:Flex-insets-and"
10432 for more information.
10436 \begin_layout Description
10437 \begin_inset Flex Code
10440 \begin_layout Plain Layout
10447 \begin_inset Flex Code
10450 \begin_layout Plain Layout
10456 ] A string that indicates the width of the left margin on the screen, for
10458 \begin_inset Quotes eld
10462 \begin_inset Flex Code
10465 \begin_layout Plain Layout
10472 \begin_inset Quotes erd
10476 (Note that this is not a `length', like
10477 \begin_inset Quotes eld
10481 \begin_inset Quotes erd
10487 \begin_layout Description
10488 \begin_inset Flex Code
10491 \begin_layout Plain Layout
10498 \begin_inset Flex Code
10501 \begin_layout Plain Layout
10507 ] An integer that determines the maximal number of names displayed in an
10508 author-year citation before the citation switches to
10509 \begin_inset Quotes eld
10513 \begin_inset Quotes erd
10517 Primarily used in cite engine files (see
10518 \begin_inset CommandInset ref
10520 reference "subsec:Cite-Engine-Files"
10530 \begin_layout Description
10531 \begin_inset Flex Code
10534 \begin_layout Plain Layout
10541 \begin_inset Flex Code
10544 \begin_layout Plain Layout
10550 ] Modifies the properties of the given paragraph style.
10551 If the style does not exist, this section is ignored.
10553 \begin_inset Quotes eld
10557 \begin_inset Flex Code
10560 \begin_layout Plain Layout
10567 \begin_inset Quotes erd
10573 \begin_layout Description
10574 \begin_inset Flex Code
10577 \begin_layout Plain Layout
10584 \begin_inset Flex Code
10587 \begin_layout Plain Layout
10593 ] Deletes an existing counter, usually one defined in an included file.
10596 \begin_layout Description
10597 \begin_inset Flex Code
10600 \begin_layout Plain Layout
10607 \begin_inset Flex Code
10610 \begin_layout Plain Layout
10616 ] Deletes an existing float.
10617 This is particularly useful when you want to suppress a float that has
10618 been defined in an input file.
10621 \begin_layout Description
10622 \begin_inset Flex Code
10625 \begin_layout Plain Layout
10632 \begin_inset Flex Code
10635 \begin_layout Plain Layout
10641 ] Deletes an existing style.
10644 \begin_layout Description
10645 \begin_inset Flex Code
10648 \begin_layout Plain Layout
10655 \begin_inset Flex Code
10658 \begin_layout Plain Layout
10665 \begin_inset Flex Code
10668 \begin_layout Plain Layout
10674 ] Define a new table of contents with type
10675 \begin_inset Flex Code
10678 \begin_layout Plain Layout
10685 \begin_inset Flex Code
10688 \begin_layout Plain Layout
10695 See also the AddToToc commands.
10698 \begin_layout Description
10699 \begin_inset Flex Code
10702 \begin_layout Plain Layout
10709 \begin_inset Flex Code
10712 \begin_layout Plain Layout
10718 ] The file format (as defined in the \SpecialChar LyX
10719 preferences) produced by this document
10721 It is mainly useful when
10722 \begin_inset Flex Code
10725 \begin_layout Plain Layout
10732 \begin_inset Flex Code
10735 \begin_layout Plain Layout
10741 and one wants to define a new type of literate document.
10742 The format is reset to
10743 \change_deleted 5863208 1594239413
10745 \begin_inset Quotes eld
10749 \begin_inset Flex Code
10752 \begin_layout Plain Layout
10759 \begin_inset Quotes erd
10765 \begin_inset Quotes eld
10769 \begin_inset Flex Code
10772 \begin_layout Plain Layout
10779 \begin_inset Quotes erd
10782 when the corresponding
10783 \begin_inset Flex Code
10786 \begin_layout Plain Layout
10792 parameter is encountered.
10795 \begin_layout Description
10796 \begin_inset Flex Code
10799 \begin_layout Plain Layout
10806 \begin_inset Flex Code
10809 \begin_layout Plain Layout
10820 \change_deleted 5863208 1594239430
10822 \begin_inset Flex Code
10825 \begin_layout Plain Layout
10834 \begin_inset Flex Code
10837 \begin_layout Plain Layout
10843 ] Specifies what sort of output documents using this class will produce.
10846 \begin_layout Description
10847 \begin_inset Flex Code
10850 \begin_layout Plain Layout
10857 \begin_inset Flex Code
10860 \begin_layout Plain Layout
10867 \begin_inset Flex Code
10870 \begin_layout Plain Layout
10876 ] Specifies options, given in the second string, for the package named by
10879 \begin_inset Quotes eld
10883 \begin_inset Flex Code
10886 \begin_layout Plain Layout
10887 PackageOptions natbib square
10893 \begin_inset Quotes erd
10897 \begin_inset Flex Code
10900 \begin_layout Plain Layout
10906 to be loaded with the
10907 \begin_inset Flex Code
10910 \begin_layout Plain Layout
10917 (For \SpecialChar TeX
10918 perts, this causes \SpecialChar LyX
10920 \begin_inset Flex Code
10923 \begin_layout Plain Layout
10926 PassOptionsToPackage{natbib}{square}
10932 \begin_inset Flex Code
10935 \begin_layout Plain Layout
10942 \change_inserted -712698321 1565102364
10946 \begin_layout Description
10948 \change_inserted -712698321 1565102470
10949 \begin_inset Flex Code
10952 \begin_layout Plain Layout
10954 \change_inserted -712698321 1565102365
10963 \begin_inset Flex Code
10966 \begin_layout Plain Layout
10968 \change_inserted -712698321 1565105222
10973 , letter, legal, executive, a0, a1, a2, a3, a4, a5, a6, b0, b1, b2, b3,
10974 b4, b5, b6, c0, c1, c2, c3, c4, c5, c6, b0j, b1j, b2j, b3j, b4j, b5j, b6j
10981 ] The default page size.
10982 This is used by some converters.
10987 \begin_layout Description
10988 \begin_inset Flex Code
10991 \begin_layout Plain Layout
10998 \begin_inset Flex Code
11001 \begin_layout Plain Layout
11010 \begin_inset Flex Code
11013 \begin_layout Plain Layout
11020 \begin_inset Flex Code
11023 \begin_layout Plain Layout
11029 ] The default pagestyle.
11030 Can be changed in the
11031 \begin_inset Flex Noun
11034 \begin_layout Plain Layout
11035 Document\SpecialChar menuseparator
11044 \begin_layout Description
11045 \begin_inset Flex Code
11048 \begin_layout Plain Layout
11054 Sets the preamble for the \SpecialChar LaTeX
11056 Note that this will completely override any prior
11057 \begin_inset Flex Code
11060 \begin_layout Plain Layout
11067 \begin_inset Flex Code
11070 \begin_layout Plain Layout
11078 \begin_inset Flex Code
11081 \begin_layout Plain Layout
11087 if you just want to add material to the preamble.) Must end with
11088 \begin_inset Quotes eld
11092 \begin_inset Flex Code
11095 \begin_layout Plain Layout
11102 \begin_inset Quotes erd
11108 \begin_layout Description
11109 \begin_inset Flex Code
11112 \begin_layout Plain Layout
11119 \begin_inset Flex Code
11122 \begin_layout Plain Layout
11129 \begin_inset Flex Code
11132 \begin_layout Plain Layout
11141 \begin_inset space \thinspace{}
11145 \begin_inset Flex Code
11148 \begin_layout Plain Layout
11154 ] Whether the class already provides the feature
11155 \begin_inset Flex Code
11158 \begin_layout Plain Layout
11165 A feature is in general the name of a package (e.
11166 \begin_inset space \thinspace{}
11170 \begin_inset space \space{}
11174 \begin_inset Flex Code
11177 \begin_layout Plain Layout
11184 \begin_inset Flex Code
11187 \begin_layout Plain Layout
11194 \begin_inset space \thinspace{}
11198 \begin_inset space \space{}
11202 \begin_inset Flex Code
11205 \begin_layout Plain Layout
11212 \begin_inset Flex Code
11215 \begin_layout Plain Layout
11223 \begin_inset CommandInset ref
11225 reference "chap:List-of-functions"
11229 for the list of features.
11232 \begin_layout Description
11233 \begin_inset Flex Code
11236 \begin_layout Plain Layout
11243 \begin_inset Flex Code
11246 \begin_layout Plain Layout
11252 ] Indicates that this layout provides the functionality of the module mentioned,
11253 which should be specified by the filename without the
11254 \begin_inset Flex Code
11257 \begin_layout Plain Layout
11264 This will typically be used if the layout includes the module directly,
11265 rather than using the
11266 \begin_inset Flex Code
11269 \begin_layout Plain Layout
11275 tag to indicate that it ought to be used.
11276 It could also be used in a module that provided an alternate implementation
11277 of the same functionality.
11280 \begin_layout Description
11281 \begin_inset Flex Code
11284 \begin_layout Plain Layout
11291 \begin_inset Flex Code
11294 \begin_layout Plain Layout
11300 ] Creates a new paragraph style if it does not already exist.
11301 If the style does exist, this section is ignored.
11303 \begin_inset Quotes eld
11307 \begin_inset Flex Code
11310 \begin_layout Plain Layout
11317 \begin_inset Quotes erd
11323 \begin_layout Description
11324 \begin_inset Flex Code
11327 \begin_layout Plain Layout
11334 \begin_inset Flex Code
11337 \begin_layout Plain Layout
11343 ] Whether the class requires the feature
11344 \begin_inset Flex Code
11347 \begin_layout Plain Layout
11354 Multiple features must be separated by commas.
11355 Note that you can only request supported features.
11357 \begin_inset CommandInset ref
11359 reference "chap:List-of-functions"
11363 for the list of features.).
11364 If you require a package with specific options, you can additionally use
11366 \begin_inset Flex Code
11369 \begin_layout Plain Layout
11378 \begin_layout Description
11379 \begin_inset Flex Code
11382 \begin_layout Plain Layout
11389 \begin_inset Flex Code
11392 \begin_layout Plain Layout
11398 ] A string that indicates the width of the right margin on the screen, for
11400 \begin_inset Quotes eld
11404 \begin_inset Flex Code
11407 \begin_layout Plain Layout
11414 \begin_inset Quotes erd
11420 \begin_layout Description
11421 \begin_inset Flex Code
11424 \begin_layout Plain Layout
11431 \begin_inset Flex Code
11434 \begin_layout Plain Layout
11440 ] Sets which divisions get numbered.
11442 \begin_inset Newline newline
11446 \begin_inset Flex Code
11449 \begin_layout Plain Layout
11455 counter in \SpecialChar LaTeX
11459 \begin_layout Description
11460 \begin_inset Flex Code
11463 \begin_layout Plain Layout
11470 \begin_inset Flex Code
11473 \begin_layout Plain Layout
11482 \begin_inset space \thinspace{}
11486 \begin_inset Flex Code
11489 \begin_layout Plain Layout
11495 ] Whether the class-default should be printing on one or both sides of the
11497 Can be changed in the
11498 \begin_inset Flex Noun
11501 \begin_layout Plain Layout
11502 Document\SpecialChar menuseparator
11511 \begin_layout Description
11512 \begin_inset Flex Code
11515 \begin_layout Plain Layout
11522 \begin_inset Flex Code
11525 \begin_layout Plain Layout
11531 ] This sequence defines a paragraph style.
11532 If the style does not yet exist, it is created; if it does exist, its parameter
11535 \begin_inset Quotes eld
11539 \begin_inset Flex Code
11542 \begin_layout Plain Layout
11549 \begin_inset Quotes erd
11553 \begin_inset Newline newline
11557 \begin_inset CommandInset ref
11559 reference "subsec:Paragraph-Styles"
11563 for details on paragraph styles.
11564 \change_inserted -712698321 1553617804
11568 \begin_layout Description
11570 \change_inserted -712698321 1553617862
11571 \begin_inset Flex Code
11574 \begin_layout Plain Layout
11576 \change_inserted -712698321 1553617809
11585 \begin_inset Flex Code
11588 \begin_layout Plain Layout
11590 \change_inserted -712698321 1553617805
11598 ] defines the default table style that is used when inserting a table.
11599 The following styles are available:
11603 \begin_layout Itemize
11605 \change_inserted -712698321 1554308039
11606 \begin_inset Flex Code
11609 \begin_layout Plain Layout
11611 \change_inserted -712698321 1554307928
11612 Formal_with_Footline
11620 \begin_inset Quotes eld
11624 \begin_inset Quotes erd
11627 ) style with horizontal lines only, using a bold top and bottom line, the
11628 first and last row are additionally separated from the table body with
11629 a thin middle line.
11632 \begin_layout Itemize
11634 \change_inserted -712698321 1554308087
11635 \begin_inset Flex Code
11638 \begin_layout Plain Layout
11640 \change_inserted -712698321 1554308042
11641 Formal_without_Footline
11648 : same as the above, but the last row is not separated with a middle line
11652 \begin_layout Itemize
11654 \change_inserted -712698321 1553618031
11655 \begin_inset Flex Code
11658 \begin_layout Plain Layout
11660 \change_inserted -712698321 1553618006
11668 : Simple table lines.
11671 \begin_layout Itemize
11673 \change_inserted -712698321 1553618309
11674 \begin_inset Flex Code
11677 \begin_layout Plain Layout
11679 \change_inserted -712698321 1553618031
11688 \begin_inset Flex Code
11691 \begin_layout Plain Layout
11693 \change_inserted -712698321 1553618043
11701 , but with the header column offset with a second horizontal line.
11702 This is also the default style of \SpecialChar LyX
11706 \begin_layout Itemize
11708 \change_inserted -712698321 1553618280
11709 \begin_inset Flex Code
11712 \begin_layout Plain Layout
11714 \change_inserted -712698321 1553618261
11722 : Table without lines.
11728 \begin_layout Description
11729 \begin_inset Flex Code
11732 \begin_layout Plain Layout
11739 \begin_inset Flex Code
11742 \begin_layout Plain Layout
11748 ] The name of the command or environment to be used with
11749 \begin_inset Flex Code
11752 \begin_layout Plain Layout
11761 \begin_layout Description
11762 \begin_inset Flex Code
11765 \begin_layout Plain Layout
11772 \begin_inset Flex Code
11775 \begin_layout Plain Layout
11784 \begin_inset Flex Code
11787 \begin_layout Plain Layout
11793 ] Indicates what kind of markup is used to define the title of a document.
11795 \begin_inset Flex Code
11798 \begin_layout Plain Layout
11804 means that the macro with name
11805 \begin_inset Flex Code
11808 \begin_layout Plain Layout
11814 will be inserted after the last layout which has
11815 \begin_inset Quotes eld
11819 \begin_inset Flex Code
11822 \begin_layout Plain Layout
11824 \begin_inset space ~
11833 \begin_inset Quotes erd
11838 \begin_inset Flex Code
11841 \begin_layout Plain Layout
11847 corresponds to the case where all layouts which have
11848 \begin_inset Quotes eld
11852 \begin_inset Flex Code
11855 \begin_layout Plain Layout
11857 \begin_inset space ~
11866 \begin_inset Quotes erd
11869 should be enclosed into the
11870 \begin_inset Flex Code
11873 \begin_layout Plain Layout
11882 \begin_layout Description
11883 \begin_inset Flex Code
11886 \begin_layout Plain Layout
11893 \begin_inset Flex Code
11896 \begin_layout Plain Layout
11902 ] Sets which divisions are included in the table of contents.
11904 \begin_inset Flex Code
11907 \begin_layout Plain Layout
11913 counter in \SpecialChar LaTeX
11917 \begin_layout Subsection
11918 \begin_inset Flex Code
11921 \begin_layout Plain Layout
11928 \begin_inset CommandInset label
11930 name "subsec:ClassOptions"
11937 \begin_layout Standard
11939 \begin_inset Flex Code
11942 \begin_layout Plain Layout
11948 section can contain the following entries:
11951 \begin_layout Description
11952 \begin_inset Flex Code
11955 \begin_layout Plain Layout
11962 \begin_inset Flex Code
11965 \begin_layout Plain Layout
11971 ] The list of available font sizes for the document's main font, separated
11973 \begin_inset Quotes eld
11977 \begin_inset Flex Code
11980 \begin_layout Plain Layout
11987 \begin_inset Quotes erd
11992 \change_inserted -712698321 1565110196
11993 Any number is possible.
11996 \begin_layout Description
11998 \change_inserted -712698321 1565110259
11999 \begin_inset Flex Code
12002 \begin_layout Plain Layout
12004 \change_inserted -712698321 1565110199
12013 \begin_inset Flex Code
12016 \begin_layout Plain Layout
12018 \change_inserted -712698321 1565110196
12026 ] The format for the font size option.
12028 \begin_inset Flex Code
12031 \begin_layout Plain Layout
12033 \change_inserted -712698321 1565110238
12043 \begin_inset Flex Code
12046 \begin_layout Plain Layout
12048 \change_inserted -712698321 1565110248
12056 is a placeholder for the font size.
12061 \begin_layout Description
12063 \change_deleted 5863208 1594239483
12064 \begin_inset Flex Code
12067 \begin_layout Plain Layout
12073 Used to set the DTD line with XML-based output classes.
12075 \begin_inset space \thinspace{}
12079 \begin_inset Quotes eld
12082 -//OASIS//DTD DocBook V4.2//EN
12083 \begin_inset Quotes erd
12087 \change_inserted -712698321 1565101761
12091 \begin_layout Description
12093 \change_inserted -712698321 1565180598
12094 \begin_inset Flex Code
12097 \begin_layout Plain Layout
12099 \change_inserted -712698321 1565101918
12108 \begin_inset Flex Code
12111 \begin_layout Plain Layout
12113 \change_inserted -712698321 1565105399
12114 string="letter|\SpecialChar allowbreak
12115 legal|\SpecialChar allowbreak
12116 executive|\SpecialChar allowbreak
12117 a0|\SpecialChar allowbreak
12118 a1|\SpecialChar allowbreak
12119 a2|\SpecialChar allowbreak
12120 a3|\SpecialChar allowbreak
12121 a4|\SpecialChar allowbreak
12122 a5|\SpecialChar allowbreak
12123 a6|\SpecialChar allowbreak
12124 b0|\SpecialChar allowbreak
12125 b1|\SpecialChar allowbreak
12126 b2|\SpecialChar allowbreak
12127 b3|\SpecialChar allowbreak
12128 b4|\SpecialChar allowbreak
12129 b5|\SpecialChar allowbreak
12130 b6|\SpecialChar allowbreak
12131 c0|\SpecialChar allowbreak
12132 c1|\SpecialChar allowbreak
12134 2|\SpecialChar allowbreak
12135 c3|\SpecialChar allowbreak
12136 c4|\SpecialChar allowbreak
12137 c5|\SpecialChar allowbreak
12138 c6|\SpecialChar allowbreak
12139 b0j|\SpecialChar allowbreak
12140 b1j|\SpecialChar allowbreak
12141 b2j|\SpecialChar allowbreak
12142 b3j|\SpecialChar allowbreak
12143 b4j|\SpecialChar allowbreak
12144 b5j|\SpecialChar allowbreak
12152 ] The list of available page sizes, separated by
12153 \begin_inset Quotes eld
12157 \begin_inset Flex Code
12160 \begin_layout Plain Layout
12162 \change_inserted -712698321 1565101779
12171 \begin_inset Quotes erd
12175 Currently, only the listed sizes are supported.
12176 Other sizes might be entered as custom class option.
12179 \begin_layout Description
12181 \change_inserted -712698321 1565180623
12182 \begin_inset Flex Code
12185 \begin_layout Plain Layout
12187 \change_inserted -712698321 1565180605
12196 \begin_inset Flex Code
12199 \begin_layout Plain Layout
12201 \change_inserted -712698321 1565180601
12209 ] The format for the page size option.
12211 \begin_inset Flex Code
12214 \begin_layout Plain Layout
12216 \change_inserted -712698321 1565180618
12226 \begin_inset Flex Code
12229 \begin_layout Plain Layout
12231 \change_inserted -712698321 1565180601
12239 is a placeholder for the paper size.
12244 \begin_layout Description
12245 \begin_inset Flex Code
12248 \begin_layout Plain Layout
12255 \begin_inset Flex Code
12258 \begin_layout Plain Layout
12259 string="empty|plain|headings|fancy"
12264 ] The list of available page sty\SpecialChar softhyphen
12266 \begin_inset Quotes eld
12270 \begin_inset Flex Code
12273 \begin_layout Plain Layout
12280 \begin_inset Quotes erd
12286 \begin_layout Description
12287 \begin_inset Flex Code
12290 \begin_layout Plain Layout
12297 \begin_inset Flex Code
12300 \begin_layout Plain Layout
12306 ] Some document class options, separated by a comma, that will be added
12307 to the optional part of the
12308 \begin_inset Flex Code
12311 \begin_layout Plain Layout
12322 \begin_layout Standard
12324 \begin_inset Flex Code
12327 \begin_layout Plain Layout
12333 section must end with
12334 \begin_inset Quotes eld
12338 \begin_inset Flex Code
12341 \begin_layout Plain Layout
12348 \begin_inset Quotes erd
12354 \begin_layout Subsection
12356 \begin_inset CommandInset label
12358 name "subsec:Paragraph-Styles"
12365 \begin_layout Standard
12366 A paragraph style description looks like this:
12370 \begin_layout Plain Layout
12371 Note that this will either define a new style or modify an existing one.
12379 \begin_layout LyX-Code
12386 \begin_layout LyX-Code
12390 \begin_layout LyX-Code
12394 \begin_layout Standard
12395 where the following commands are allowed:
12398 \begin_layout Description
12399 \begin_inset Flex Code
12402 \begin_layout Plain Layout
12409 \begin_inset Flex Code
12412 \begin_layout Plain Layout
12418 =""] This paragraph will appear in the table of contents of the given type.
12419 An empty string disables.
12420 See also the OutlinerName and the IsTocCaption commands.
12424 \begin_layout Description
12425 \begin_inset Flex Code
12428 \begin_layout Plain Layout
12435 \begin_inset Flex Code
12438 \begin_layout Plain Layout
12443 , left, right, center
12448 ] Paragraph alignment.
12451 \begin_layout Description
12452 \begin_inset Flex Code
12455 \begin_layout Plain Layout
12462 \begin_inset Flex Code
12465 \begin_layout Plain Layout
12470 , left, right, center
12475 ] A comma separated list of permitted alignments.
12476 (Some \SpecialChar LaTeX
12477 styles prohibit certain alignments, since those wouldn't make sense.
12478 For example a right-aligned or centered enumeration isn't possible.)
12481 \begin_layout Description
12482 \begin_inset Flex Code
12485 \begin_layout Plain Layout
12492 \begin_inset Flex Code
12495 \begin_layout Plain Layout
12501 ] Defines argument number <int> of a command\SpecialChar breakableslash
12502 environment associated with
12504 This is useful for things like section headings, and only makes sense with
12507 Every (optional or required) argument of a command or environment – except
12508 for the required argument that is associated with the content of the paragraph
12509 itself – has a separate definition, where the number specifies the order
12511 The definition must end with
12512 \begin_inset Flex Code
12515 \begin_layout Plain Layout
12522 So a command with two optional arguments has:
12526 \begin_layout Quote
12532 \begin_layout Quote
12538 \begin_layout Quote
12544 \begin_layout Quote
12550 \begin_layout Quote
12556 \begin_layout Quote
12562 \begin_layout Standard
12564 \begin_inset Flex Code
12567 \begin_layout Plain Layout
12573 definition, the following specifications are possible:
12576 \begin_layout Itemize
12577 \begin_inset Flex Code
12580 \begin_layout Plain Layout
12587 \begin_inset Flex Code
12590 \begin_layout Plain Layout
12596 The string that will appear both in the menu (to insert this argument)
12597 and on the argument inset button (unless you also specify a separate
12598 \begin_inset Flex Code
12601 \begin_layout Plain Layout
12608 For the menu, you can define an accelerator by appending the respective
12609 character to the string, divided by
12610 \begin_inset Quotes eld
12614 \begin_inset Quotes erd
12618 \begin_inset space \thinspace{}
12622 \begin_inset space \space{}
12626 \begin_inset Quotes eld
12630 \begin_inset Flex Code
12633 \begin_layout Plain Layout
12640 \begin_inset Quotes erd
12646 \begin_layout Itemize
12647 \begin_inset Flex Code
12650 \begin_layout Plain Layout
12657 \begin_inset Flex Code
12660 \begin_layout Plain Layout
12666 A separate string for the menu.
12667 You can define an accelerator by appending the respective character to
12668 the string, divided by
12669 \begin_inset Quotes eld
12673 \begin_inset Quotes erd
12677 \begin_inset space \thinspace{}
12681 \begin_inset space \space{}
12685 \begin_inset Quotes eld
12689 \begin_inset Flex Code
12692 \begin_layout Plain Layout
12699 \begin_inset Quotes erd
12703 This specification is optional.
12704 If it is not given the
12705 \begin_inset Flex Code
12708 \begin_layout Plain Layout
12714 will be used instead for the menu.
12717 \begin_layout Itemize
12718 \begin_inset Flex Code
12721 \begin_layout Plain Layout
12728 \begin_inset Flex Code
12731 \begin_layout Plain Layout
12737 A longer explanatory text that appears in the tooltip when hovering over
12738 the argument inset.
12741 \begin_layout Itemize
12742 \begin_inset Flex Code
12745 \begin_layout Plain Layout
12752 \begin_inset Flex Code
12755 \begin_layout Plain Layout
12764 \begin_inset space \thinspace{}
12768 \begin_inset Flex Code
12771 \begin_layout Plain Layout
12777 ] Declare if this is a mandatory (1) or an optional (0) argument.
12778 Mandatory arguments will be output empty if not given, while optional arguments
12779 will not be output at all.
12780 By default, mandatory arguments are delimited by
12781 \begin_inset Flex Code
12784 \begin_layout Plain Layout
12790 , while optional arguments are delimited by
12791 \begin_inset Flex Code
12794 \begin_layout Plain Layout
12801 \change_inserted -712698321 1555579782
12805 \begin_layout Itemize
12807 \change_inserted -712698321 1555579780
12808 \begin_inset Flex Code
12811 \begin_layout Plain Layout
12813 \change_inserted -712698321 1555579780
12822 \begin_inset Flex Code
12825 \begin_layout Plain Layout
12827 \change_inserted -712698321 1555579780
12835 Option to define a different command (from the default
12836 \begin_inset Flex Code
12839 \begin_layout Plain Layout
12841 \change_inserted -712698321 1555579780
12853 ) to be used for line breaks.
12854 The initial backslash must not be specified.
12859 \begin_layout Itemize
12860 \begin_inset Flex Code
12863 \begin_layout Plain Layout
12870 \begin_inset Flex Code
12873 \begin_layout Plain Layout
12879 defines another argument (by its number) which this argument requires to
12880 be output if it is itself output.
12882 \begin_inset space \thinspace{}
12885 g., in \SpecialChar LaTeX
12886 commands, optional arguments often require previous optional arguments
12887 to be output (at least empty), as in
12888 \begin_inset Flex Code
12891 \begin_layout Plain Layout
12894 command[][argument]{text}
12900 This can be achieved by the statement
12901 \begin_inset Flex Code
12904 \begin_layout Plain Layout
12911 \begin_inset Flex Code
12914 \begin_layout Plain Layout
12923 \begin_layout Itemize
12924 \begin_inset Flex Code
12927 \begin_layout Plain Layout
12934 \begin_inset Flex Code
12937 \begin_layout Plain Layout
12943 defines a custom left delimiter (instead of
12944 \begin_inset Flex Code
12947 \begin_layout Plain Layout
12954 \begin_inset Flex Code
12957 \begin_layout Plain Layout
12964 A line break in the output can be indicated by
12965 \begin_inset Flex Code
12968 \begin_layout Plain Layout
12977 \begin_layout Itemize
12978 \begin_inset Flex Code
12981 \begin_layout Plain Layout
12988 \begin_inset Flex Code
12991 \begin_layout Plain Layout
12997 defines a custom right delimiter (instead of
12998 \begin_inset Flex Code
13001 \begin_layout Plain Layout
13008 \begin_inset Flex Code
13011 \begin_layout Plain Layout
13018 A line break in the output can be indicated by
13019 \begin_inset Flex Code
13022 \begin_layout Plain Layout
13031 \begin_layout Itemize
13032 \begin_inset Flex Code
13035 \begin_layout Plain Layout
13042 \begin_inset Flex Code
13045 \begin_layout Plain Layout
13051 defines an argument that is inserted if and only if no user-specified arguments
13053 \begin_inset space \thinspace{}
13057 \begin_inset space \space{}
13060 if no argument inset has been inserted (note that also an empty argument
13061 inset omits the DefaultArg).
13062 Multiple arguments need to be separated by comma.
13065 \begin_layout Itemize
13066 \begin_inset Flex Code
13069 \begin_layout Plain Layout
13076 \begin_inset Flex Code
13079 \begin_layout Plain Layout
13085 defines an argument that is inserted in any case (alone or in addition
13086 to user-specified arguments).
13087 Multiple arguments need to be separated by comma.
13090 \begin_layout Itemize
13091 \begin_inset Flex Code
13094 \begin_layout Plain Layout
13100 The font used for the argument content, see
13101 \begin_inset CommandInset ref
13103 reference "subsec:Font-description"
13108 \change_inserted -712698321 1559484228
13112 \begin_layout Itemize
13114 \change_inserted -712698321 1559484228
13115 \begin_inset Flex Code
13118 \begin_layout Plain Layout
13120 \change_inserted -712698321 1559484228
13129 \begin_inset Flex Code
13132 \begin_layout Plain Layout
13134 \change_inserted -712698321 1559484228
13145 \begin_inset space \thinspace{}
13149 \begin_inset Flex Code
13152 \begin_layout Plain Layout
13154 \change_inserted -712698321 1559484228
13162 ] As with paragraph styles, see
13163 \begin_inset CommandInset ref
13165 reference "subsec:Paragraph-Styles"
13174 \begin_layout Itemize
13175 \begin_inset Flex Code
13178 \begin_layout Plain Layout
13184 The font used for the label; see
13185 \begin_inset CommandInset ref
13187 reference "subsec:Font-description"
13194 \begin_layout Itemize
13195 \begin_inset Flex Code
13198 \begin_layout Plain Layout
13205 \begin_inset Flex Code
13208 \begin_layout Plain Layout
13213 , Minimalistic, Conglomerate
13218 ] describes the rendering style used for the inset's frame and buttons.
13221 \begin_layout Itemize
13222 \begin_inset Flex Code
13225 \begin_layout Plain Layout
13232 \begin_inset Flex Code
13235 \begin_layout Plain Layout
13242 \begin_inset Flex Code
13245 \begin_layout Plain Layout
13251 , this argument is automatically inserted when the respective style is selected.
13253 \change_deleted -712698321 1559484200
13254 Currently, only one argument per style\SpecialChar breakableslash
13255 layout can be automatically inserted.
13260 \begin_layout Itemize
13262 \change_inserted -712698321 1559491402
13263 \begin_inset Flex Code
13266 \begin_layout Plain Layout
13268 \change_inserted -712698321 1559490711
13277 \begin_inset Flex Code
13280 \begin_layout Plain Layout
13282 \change_inserted -712698321 1559490703
13291 \begin_inset Flex Code
13294 \begin_layout Plain Layout
13296 \change_inserted -712698321 1559490703
13304 , this argument will be inserted on a new line with
13305 \begin_inset Flex Code
13308 \begin_layout Plain Layout
13310 \change_inserted -712698321 1559491402
13318 (only available within Flex insets).
13321 \begin_layout Itemize
13322 \begin_inset Flex Code
13325 \begin_layout Plain Layout
13332 \begin_inset Flex Code
13335 \begin_layout Plain Layout
13342 \begin_inset Flex Code
13345 \begin_layout Plain Layout
13351 , this argument will be inserted with a copy of the co-text (either selected
13352 text or the whole paragraph) as content.
13355 \begin_layout Itemize
13356 \begin_inset Flex Code
13359 \begin_layout Plain Layout
13366 \begin_inset Flex Code
13369 \begin_layout Plain Layout
13379 ] Whether the contents of this argument should be output in raw form, meaning
13380 without special translations that \SpecialChar LaTeX
13383 \begin_inset Flex Code
13386 \begin_layout Plain Layout
13392 status is inherited by the inset or paragraph layout the argument belongs
13393 to, true and false change the status for the given argument only.
13396 \begin_layout Itemize
13397 \begin_inset Flex Code
13400 \begin_layout Plain Layout
13407 \begin_inset Flex Code
13410 \begin_layout Plain Layout
13411 string of characters
13420 Defines individual characters
13421 \begin_inset Newline linebreak
13424 that should be output in raw form, meaning without special translations
13425 that \SpecialChar LaTeX
13427 Note that, contrary to PassThru, this needs to be explicitly defined for
13429 That is, arguments do not inherit PassThruChars from their parent inset
13433 \begin_layout Itemize
13434 \begin_inset Flex Code
13437 \begin_layout Plain Layout
13444 \begin_inset Flex Code
13447 \begin_layout Plain Layout
13456 \begin_inset space \thinspace{}
13460 \begin_inset Flex Code
13463 \begin_layout Plain Layout
13469 ] If this is set to 1, the argument will output its content in the corresponding
13470 item in the table of contents.
13474 \begin_layout Standard
13475 By default, the text entered in the \SpecialChar LyX
13476 workarea in the respective layout is
13477 the last (mandatory) argument of a command if the
13478 \begin_inset Flex Code
13481 \begin_layout Plain Layout
13488 \begin_inset Flex Code
13491 \begin_layout Plain Layout
13498 However, arguments with the prefix
13499 \begin_inset Flex Code
13502 \begin_layout Plain Layout
13508 are output after this workarea argument.
13509 Note that post-argument numbering restarts at 1, so the first argument
13510 following the workarea argument is
13511 \begin_inset Flex Code
13514 \begin_layout Plain Layout
13521 Post-arguments are ignored in any other
13522 \begin_inset Flex Code
13525 \begin_layout Plain Layout
13532 \begin_inset Flex Code
13535 \begin_layout Plain Layout
13544 \begin_layout Standard
13546 \begin_inset Flex Code
13549 \begin_layout Plain Layout
13558 \begin_inset Flex Code
13561 \begin_layout Plain Layout
13570 \begin_inset Flex Code
13573 \begin_layout Plain Layout
13579 followed by the number (e.
13580 \begin_inset space \thinspace{}
13584 \begin_inset space \space{}
13588 \begin_inset Flex Code
13591 \begin_layout Plain Layout
13598 \change_inserted -712698321 1534487781
13602 \begin_layout Standard
13604 \change_inserted -712698321 1534488561
13605 Finally, there is a special argument type with the prefix
13606 \begin_inset Flex Code
13609 \begin_layout Plain Layout
13611 \change_inserted -712698321 1534487844
13620 It is not really an argument, but uses the argument interface (thus, the
13621 prefix is also followed by a number, e.
13622 \begin_inset space \thinspace{}
13627 \begin_inset Flex Code
13630 \begin_layout Plain Layout
13632 \change_inserted -712698321 1534488412
13633 Argument listpreamble:1
13641 As the name implies, it is targeted at lists such as
13658 Its content will be output at the list start, before the first
13659 \begin_inset Flex Code
13662 \begin_layout Plain Layout
13664 \change_inserted -712698321 1534488058
13674 , on an own line (a place that is otherwise not accessible in \SpecialChar LyX
13676 This way, users can insert redefinitions (of lengths etc.) to individual
13678 By default, these arguments do not have a delimiter.
13684 \begin_layout Description
13685 \begin_inset Flex Code
13688 \begin_layout Plain Layout
13694 Includes a comma-separated list of layouts that should be nested in and
13695 after the current layout.
13696 Only makes sense for nestable layouts (such as environments).
13698 \begin_inset Quotes eld
13702 \begin_inset Flex Code
13705 \begin_layout Plain Layout
13712 \begin_inset Quotes erd
13717 \begin_inset Flex Code
13720 \begin_layout Plain Layout
13729 \begin_layout Description
13730 \begin_inset Flex Code
13733 \begin_layout Plain Layout
13739 Note that this will completely override any prior
13740 \begin_inset Flex Code
13743 \begin_layout Plain Layout
13749 declaration for this style.
13751 \begin_inset Quotes eld
13755 \begin_inset Flex Code
13758 \begin_layout Plain Layout
13765 \begin_inset Quotes erd
13770 \begin_inset CommandInset ref
13772 reference "subsec:I18n"
13776 for details on its use.
13779 \begin_layout Description
13780 \begin_inset Flex Code
13783 \begin_layout Plain Layout
13790 \begin_inset Flex Code
13793 \begin_layout Plain Layout
13803 \begin_layout Plain Layout
13804 Note that a `float' here is a real number, such as: 1.5.
13809 The vertical space with which the last of a chain of paragraphs with this
13810 style is separated from the following paragraph.
13811 If the next paragraph has another style, the separations are not simply
13812 added, but the maximum is taken.
13815 \begin_layout Description
13816 \begin_inset Flex Code
13819 \begin_layout Plain Layout
13826 \begin_inset Flex Code
13829 \begin_layout Plain Layout
13835 ] The category for this style.
13836 This is used to group related styles in the style combobox on the toolbar.
13837 Any string can be used, but you may want to use existing categories with
13842 \begin_layout Description
13843 \begin_inset Flex Code
13846 \begin_layout Plain Layout
13852 Depth of XML command.
13853 Used only with XML-type formats.
13856 \begin_layout Description
13857 \begin_inset Flex Code
13860 \begin_layout Plain Layout
13867 \begin_inset Flex Code
13870 \begin_layout Plain Layout
13876 ] Copies all the features of an existing style into the current one.
13880 \begin_layout Description
13881 \begin_inset Flex Code
13884 \begin_layout Plain Layout
13891 \begin_inset Flex Code
13894 \begin_layout Plain Layout
13900 ] The name of a style whose preamble should be output
13905 This allows to ensure some ordering of the preamble snippets when macros
13906 definitions depend on one another.
13910 \begin_layout Plain Layout
13911 Note that, besides that functionality, there is no way to ensure any ordering
13913 The ordering that you see in a given version of \SpecialChar LyX
13914 may change without warning
13923 \begin_layout Description
13924 \begin_inset Flex Code
13927 \begin_layout Plain Layout
13934 \begin_inset Flex Code
13937 \begin_layout Plain Layout
13942 , Box, Filled_Box, Static
13947 ] The type of label that stands at the end of the paragraph (or sequence
13949 \begin_inset Flex Code
13952 \begin_layout Plain Layout
13959 \begin_inset Newline newline
13963 \begin_inset Flex Code
13966 \begin_layout Plain Layout
13973 \begin_inset Flex Code
13976 \begin_layout Plain Layout
13983 \begin_inset Flex Code
13986 \begin_layout Plain Layout
13994 \begin_inset Flex Code
13997 \begin_layout Plain Layout
14004 \begin_inset Quotes eld
14008 \begin_inset Quotes erd
14012 \begin_inset Flex Code
14015 \begin_layout Plain Layout
14022 \begin_inset space \space{}
14026 \begin_inset Flex Code
14029 \begin_layout Plain Layout
14035 ) is a white (resp.
14036 \begin_inset space ~
14039 black) square suitable for end of proof markers,
14040 \begin_inset Flex Code
14043 \begin_layout Plain Layout
14049 is an explicit text string.
14052 \begin_layout Description
14053 \begin_inset Flex Code
14056 \begin_layout Plain Layout
14063 \begin_inset Flex Code
14066 \begin_layout Plain Layout
14072 ] The string used for a label with a
14073 \begin_inset Flex Code
14076 \begin_layout Plain Layout
14083 \begin_inset Newline newline
14087 \begin_inset Flex Code
14090 \begin_layout Plain Layout
14100 \begin_layout Description
14101 \begin_inset Flex Code
14104 \begin_layout Plain Layout
14110 The font used for both the text body
14116 \begin_inset CommandInset ref
14118 reference "subsec:Font-description"
14123 Note that defining this font automatically defines the
14124 \begin_inset Flex Code
14127 \begin_layout Plain Layout
14134 So you should define this one first if you also want to define
14135 \begin_inset Flex Code
14138 \begin_layout Plain Layout
14147 \begin_layout Description
14148 \begin_inset Flex Code
14151 \begin_layout Plain Layout
14158 \begin_inset Flex Code
14161 \begin_layout Plain Layout
14167 ] Used for backporting new styles to stable \SpecialChar LyX
14169 The first stable version that supports this tag is \SpecialChar LyX
14171 The argument is a number which may either be 0, -1 or any value greater
14174 \begin_inset Flex Code
14177 \begin_layout Plain Layout
14183 flag of a style is greater than zero, it will always be written to the
14185 If a .lyx file is read, the style definitions from the document header are
14186 added to the document class.
14187 Therefore even older \SpecialChar LyX
14188 versions can handle the style.
14190 \begin_inset Flex Code
14193 \begin_layout Plain Layout
14199 is a version number: if the style is read, and the version number is less
14200 than the version number of the already existing style in the document class,
14201 the new style is ignored.
14202 If the version number is greater, the new style replaces the existing style.
14203 A value of -1 means an infinite version number, i.
14204 \begin_inset space \thinspace{}
14208 \begin_inset space \space{}
14211 the style is always used.
14214 \begin_layout Description
14215 \begin_inset Flex Code
14218 \begin_layout Plain Layout
14225 \begin_inset Flex Code
14228 \begin_layout Plain Layout
14237 \begin_inset space \thinspace{}
14241 \begin_inset Flex Code
14244 \begin_layout Plain Layout
14250 ] Usually \SpecialChar LyX
14251 does not allow you to insert more than one space between words,
14252 since a space is considered as the separation between two words, not a
14253 character or symbol of its own.
14254 This is a very fine thing but sometimes annoying, for example, when typing
14255 program code or plain \SpecialChar LaTeX
14258 \begin_inset Flex Code
14261 \begin_layout Plain Layout
14269 \change_deleted -495245474 1550490105
14273 will create protected blanks for the additional blanks when in
14274 \change_inserted -495245474 1550490096
14276 \begin_inset Flex Code
14279 \begin_layout Plain Layout
14281 \change_inserted -495245474 1550490089
14290 \change_deleted -495245474 1550490116
14291 another mode than \SpecialChar LaTeX
14294 \change_inserted -495245474 1550247760
14296 \begin_inset Flex Code
14299 \begin_layout Plain Layout
14301 \change_inserted -495245474 1550247736
14310 \begin_inset Flex Code
14313 \begin_layout Plain Layout
14315 \change_inserted -495245474 1550247755
14328 \begin_layout Description
14329 \begin_inset Flex Code
14332 \begin_layout Plain Layout
14338 These tags are used with XHTML output.
14340 \begin_inset CommandInset ref
14342 reference "subsec:Paragraph-Style-XHTML"
14349 \begin_layout Description
14350 \begin_inset Flex Code
14353 \begin_layout Plain Layout
14359 [FIXME] (Used only with XML-type formats.)
14362 \begin_layout Description
14363 \begin_inset Flex Code
14366 \begin_layout Plain Layout
14373 \begin_inset Flex Code
14376 \begin_layout Plain Layout
14385 \begin_inset space \thinspace{}
14389 \begin_inset Flex Code
14392 \begin_layout Plain Layout
14399 \begin_inset Flex Code
14402 \begin_layout Plain Layout
14408 , marks the style as to be included in the document preamble and not in
14410 This is useful for document classes that want such information as the title
14411 and author to appear in the preamble.
14412 Note that this works only for styles for which the
14413 \begin_inset Flex Code
14416 \begin_layout Plain Layout
14423 \begin_inset Flex Code
14426 \begin_layout Plain Layout
14433 \begin_inset Flex Code
14436 \begin_layout Plain Layout
14445 \begin_layout Description
14446 \begin_inset Flex Code
14449 \begin_layout Plain Layout
14456 \begin_inset Flex Code
14459 \begin_layout Plain Layout
14468 \begin_inset space \thinspace{}
14472 \begin_inset Flex Code
14475 \begin_layout Plain Layout
14482 \begin_inset Flex Code
14485 \begin_layout Plain Layout
14491 , marks the style as being part of a title block (see also the
14492 \begin_inset Flex Code
14495 \begin_layout Plain Layout
14502 \begin_inset Flex Code
14505 \begin_layout Plain Layout
14514 \begin_layout Description
14515 \begin_inset Flex Code
14518 \begin_layout Plain Layout
14524 Includes a comma-separated list of layouts after which this one should
14526 Only makes sense with regard to nestable layouts (such as environments).
14528 \begin_inset Quotes eld
14532 \begin_inset Flex Code
14535 \begin_layout Plain Layout
14542 \begin_inset Quotes erd
14547 \begin_inset Flex Code
14550 \begin_layout Plain Layout
14559 \begin_layout Description
14560 \begin_inset Flex Code
14563 \begin_layout Plain Layout
14570 \begin_inset Flex Code
14573 \begin_layout Plain Layout
14582 \begin_inset space \thinspace{}
14586 \begin_inset Flex Code
14589 \begin_layout Plain Layout
14595 ] If this is set to 1 and AddToToc is enabled, the paragraph adds a summary
14596 of its contents in its item in the table of contents.
14597 Otherwise, only the label, if it exists, appears.
14600 \begin_layout Description
14601 \begin_inset Flex Code
14604 \begin_layout Plain Layout
14611 \begin_inset Flex Code
14614 \begin_layout Plain Layout
14620 ] The \SpecialChar LaTeX
14621 command sequence declaring an item in a list.
14622 The command is to be defined without the preceding backslash (the default
14624 \begin_inset Quotes eld
14628 \begin_inset Quotes erd
14632 \begin_inset Flex Code
14635 \begin_layout Plain Layout
14643 in the \SpecialChar LaTeX
14647 \begin_layout Description
14648 \begin_inset Flex Code
14651 \begin_layout Plain Layout
14658 \begin_inset Flex Code
14661 \begin_layout Plain Layout
14667 ] This provides extra space between paragraphs that have the same style.
14668 If you put other styles into an environment, each is separated with the
14670 \begin_inset Flex Code
14673 \begin_layout Plain Layout
14680 But the whole items of the environment are additionally separated with
14682 \begin_inset Flex Code
14685 \begin_layout Plain Layout
14692 Note that this is a
14697 \begin_layout Description
14698 \begin_inset Flex Code
14701 \begin_layout Plain Layout
14707 [FIXME] (Used only with XML-type formats.)
14710 \begin_layout Description
14711 \begin_inset Flex Code
14714 \begin_layout Plain Layout
14721 \begin_inset Flex Code
14724 \begin_layout Plain Layout
14733 \begin_inset space \thinspace{}
14737 \begin_inset Flex Code
14740 \begin_layout Plain Layout
14746 ] Usually \SpecialChar LyX
14747 does not allow you to leave a paragraph empty, since it would
14748 lead to empty \SpecialChar LaTeX
14750 There are some cases where this could be desirable however: in a letter
14751 template, the required fields can be provided as empty fields, so that
14752 people do not forget them; in some special classes, a style can be used
14753 as some kind of break, which does not contain actual text.
14756 \begin_layout Description
14757 \begin_inset Flex Code
14760 \begin_layout Plain Layout
14767 \begin_inset Flex Code
14770 \begin_layout Plain Layout
14776 ] The vertical space between the label and the text body.
14777 Only used for labels that are above the text body (
14778 \begin_inset Flex Code
14781 \begin_layout Plain Layout
14788 \begin_inset Newline newline
14792 \begin_inset Flex Code
14795 \begin_layout Plain Layout
14796 Centered_Top_Environment
14804 \begin_layout Description
14805 \begin_inset Flex Code
14808 \begin_layout Plain Layout
14815 \begin_inset Flex Code
14818 \begin_layout Plain Layout
14824 ] The name of the counter for automatic numbering.
14825 In order to have the counter appear with your label, you will need to reference
14827 \begin_inset Flex Code
14830 \begin_layout Plain Layout
14839 This will work with
14840 \begin_inset Flex Code
14843 \begin_layout Plain Layout
14850 \begin_inset Flex Code
14853 \begin_layout Plain Layout
14860 \begin_inset Flex Code
14863 \begin_layout Plain Layout
14870 \begin_inset Flex Code
14873 \begin_layout Plain Layout
14880 \begin_inset Newline newline
14888 \begin_inset Flex Code
14891 \begin_layout Plain Layout
14898 \begin_inset Flex Code
14901 \begin_layout Plain Layout
14907 , though this case is a bit complicated.
14908 Suppose you declare
14909 \begin_inset Quotes eld
14913 \begin_inset Flex Code
14916 \begin_layout Plain Layout
14917 LabelCounter myenum
14923 \begin_inset Quotes erd
14927 Then the actual counters used are
14928 \begin_inset Flex Code
14931 \begin_layout Plain Layout
14938 \begin_inset Flex Code
14941 \begin_layout Plain Layout
14948 \begin_inset Flex Code
14951 \begin_layout Plain Layout
14958 \begin_inset Flex Code
14961 \begin_layout Plain Layout
14967 , much as in \SpecialChar LaTeX
14969 These counters must all be declared separately.
14970 \begin_inset Newline newline
14974 \begin_inset CommandInset ref
14976 reference "subsec:Counters"
14980 for details on counters.
14983 \begin_layout Description
14984 \begin_inset Flex Code
14987 \begin_layout Plain Layout
14993 The font used for the label.
14995 \begin_inset CommandInset ref
14997 reference "subsec:Font-description"
15004 \begin_layout Description
15005 \begin_inset Flex Code
15008 \begin_layout Plain Layout
15015 \begin_inset Flex Code
15018 \begin_layout Plain Layout
15024 ] Text that indicates how far a label should be indented.
15027 \begin_layout Description
15028 \begin_inset Flex Code
15031 \begin_layout Plain Layout
15038 \begin_inset Flex Code
15041 \begin_layout Plain Layout
15047 ] Text that indicates the amount of horizontal space between the label and
15049 Only used for labels that are not above the text body.
15052 \begin_layout Description
15053 \begin_inset Flex Code
15056 \begin_layout Plain Layout
15063 \begin_inset Flex Code
15066 \begin_layout Plain Layout
15072 ] The string used for the label.
15074 \begin_inset Flex Code
15077 \begin_layout Plain Layout
15083 is set, this string can be contain the special formatting commands described
15085 \begin_inset CommandInset ref
15087 reference "subsec:Counters"
15094 \begin_layout Description
15095 \begin_inset Flex Code
15098 \begin_layout Plain Layout
15099 LabelStringAppendix
15105 \begin_inset Flex Code
15108 \begin_layout Plain Layout
15114 ] This is used inside the appendix instead of
15115 \begin_inset Newline newline
15119 \begin_inset Flex Code
15122 \begin_layout Plain Layout
15130 \begin_inset Flex Code
15133 \begin_layout Plain Layout
15140 \begin_inset Newline newline
15144 \begin_inset Flex Code
15147 \begin_layout Plain Layout
15148 LabelStringAppendix
15156 \begin_layout Description
15157 \begin_inset Flex Code
15160 \begin_layout Plain Layout
15166 [FIXME] (Used only with XML-type formats.)
15169 \begin_layout Description
15170 \begin_inset Flex Code
15173 \begin_layout Plain Layout
15180 \begin_inset Flex Code
15183 \begin_layout Plain Layout
15188 , Manual, Static, Above,
15189 \begin_inset Newline newline
15192 Centered, Sensitive, Enumerate,
15193 \begin_inset Newline newline
15196 Itemize, Bibliography
15205 \begin_layout Description
15206 \begin_inset Flex Code
15209 \begin_layout Plain Layout
15215 means the label is the very first word (up to the first real blank).
15216 Use protected spaces if you want more than one word as the label.
15220 \begin_layout Description
15221 \begin_inset Flex Code
15224 \begin_layout Plain Layout
15230 means the label is simply what is declared as
15231 \begin_inset Flex Code
15234 \begin_layout Plain Layout
15241 This will be displayed
15242 \begin_inset Quotes eld
15246 \begin_inset Quotes erd
15249 , at the beginning of the paragraph.
15251 \begin_inset Flex Code
15254 \begin_layout Plain Layout
15261 \begin_inset Flex Code
15264 \begin_layout Plain Layout
15270 , then it will be displayed only in the first paragraph of any sequence
15271 of paragraphs with the same
15272 \begin_inset Flex Code
15275 \begin_layout Plain Layout
15284 \begin_layout Description
15285 \begin_inset Flex Code
15288 \begin_layout Plain Layout
15295 \begin_inset space ~
15299 \begin_inset space ~
15303 \begin_inset Flex Code
15306 \begin_layout Plain Layout
15312 are special cases of
15313 \begin_inset Flex Code
15316 \begin_layout Plain Layout
15323 The label will be printed above the paragraph either at the beginning of
15324 the line or centered.
15327 \begin_layout Description
15328 \begin_inset Flex Code
15331 \begin_layout Plain Layout
15337 is a special case for the caption-labels
15338 \begin_inset Quotes eld
15342 \begin_inset Quotes erd
15346 \begin_inset Quotes eld
15350 \begin_inset Quotes erd
15354 \begin_inset Newline newline
15358 \begin_inset Flex Code
15361 \begin_layout Plain Layout
15367 means the (hardcoded) label string depends on the kind of float: It is
15368 hardcoded to be `FloatType N', where N is the value of the counter associated
15370 For the case that a caption is inserted outside of a float the
15371 \begin_inset Flex Code
15374 \begin_layout Plain Layout
15381 \begin_inset Quotes eld
15385 \begin_inset Quotes erd
15391 \begin_layout Description
15392 \begin_inset Flex Code
15395 \begin_layout Plain Layout
15401 produces the usual sort of enumeration labels.
15402 The number type needs to be set in the
15407 \begin_inset CommandInset ref
15409 reference "subsec:Counters"
15416 \begin_layout Description
15417 \begin_inset Flex Code
15420 \begin_layout Plain Layout
15426 produces various bullets at the different levels.
15427 The bullet types displayed can be set via
15428 \begin_inset Flex Noun
15431 \begin_layout Plain Layout
15432 Document\SpecialChar menuseparator
15433 Settings\SpecialChar menuseparator
15442 \begin_layout Description
15443 \begin_inset Flex Code
15446 \begin_layout Plain Layout
15452 should be used only with
15453 \begin_inset Flex Code
15456 \begin_layout Plain Layout
15457 LatexType BibEnvironment
15466 \begin_layout Description
15467 \begin_inset Flex Code
15470 \begin_layout Plain Layout
15476 Note that this will completely override any prior
15477 \begin_inset Flex Code
15480 \begin_layout Plain Layout
15486 declaration for this style.
15488 \begin_inset Quotes eld
15492 \begin_inset Flex Code
15495 \begin_layout Plain Layout
15502 \begin_inset Quotes erd
15507 \begin_inset CommandInset ref
15509 reference "subsec:I18n"
15513 for details on its use.
15516 \begin_layout Description
15517 \begin_inset Flex Code
15520 \begin_layout Plain Layout
15527 \begin_inset Flex Code
15530 \begin_layout Plain Layout
15536 ] The name of the corresponding \SpecialChar LaTeX
15538 Either the environment or command name.
15541 \begin_layout Description
15542 \begin_inset Flex Code
15545 \begin_layout Plain Layout
15552 \begin_inset Flex Code
15555 \begin_layout Plain Layout
15561 ] An optional parameter for the corresponding
15562 \begin_inset Flex Code
15565 \begin_layout Plain Layout
15572 This parameter cannot be changed from within \SpecialChar LyX
15574 \begin_inset Flex Code
15577 \begin_layout Plain Layout
15583 for customizable parameters).
15584 This will be output as is after all \SpecialChar LaTeX
15586 \begin_inset Flex Code
15589 \begin_layout Plain Layout
15598 \begin_layout Description
15599 \begin_inset Flex Code
15602 \begin_layout Plain Layout
15609 \begin_inset Flex Code
15612 \begin_layout Plain Layout
15617 , Command, Environment, Item_Environment,
15618 \begin_inset Newline newline
15621 List_Environment, Bib_Environment
15626 ] How the style should be translated into \SpecialChar LaTeX
15631 \begin_layout Plain Layout
15632 \begin_inset Flex Code
15635 \begin_layout Plain Layout
15641 is perhaps a bit misleading, since these rules apply to SGML classes, too.
15642 Visit the SGML class files for specific examples.
15651 \begin_layout Description
15652 \begin_inset Flex Code
15655 \begin_layout Plain Layout
15661 means nothing special.
15664 \begin_layout Description
15665 \begin_inset Flex Code
15668 \begin_layout Plain Layout
15675 \begin_inset Flex Code
15678 \begin_layout Plain Layout
15685 {\SpecialChar ldots
15694 \begin_layout Description
15695 \begin_inset Flex Code
15698 \begin_layout Plain Layout
15705 \begin_inset Flex Code
15708 \begin_layout Plain Layout
15715 }\SpecialChar ldots
15731 \begin_layout Description
15732 \begin_inset Flex Code
15735 \begin_layout Plain Layout
15742 \begin_inset Flex Code
15745 \begin_layout Plain Layout
15752 \begin_inset Flex Code
15755 \begin_layout Plain Layout
15763 is generated for each paragraph of this environment.
15767 \begin_layout Description
15768 \begin_inset Flex Code
15771 \begin_layout Plain Layout
15778 \begin_inset Flex Code
15781 \begin_layout Plain Layout
15788 \begin_inset Newline newline
15792 \begin_inset Flex Code
15795 \begin_layout Plain Layout
15801 is passed as an argument to the environment.
15802 \begin_inset Newline newline
15806 \begin_inset Flex Code
15809 \begin_layout Plain Layout
15815 can be defined in the
15816 \begin_inset Flex Noun
15819 \begin_layout Plain Layout
15820 Edit\SpecialChar menuseparator
15822 \begin_inset space ~
15833 \begin_layout Description
15834 \begin_inset Flex Code
15837 \begin_layout Plain Layout
15844 \begin_inset Flex Code
15847 \begin_layout Plain Layout
15853 but adds the necessary mandatory argument (the longest label) to the begin
15854 statement of the bibliography environment:
15855 \begin_inset Newline newline
15859 \begin_inset Flex Code
15862 \begin_layout Plain Layout
15865 begin{thebibliography}{99}
15871 It is therefore only useful for bibliography environments.
15872 The default longest label
15873 \begin_inset Quotes eld
15877 \begin_inset Quotes erd
15880 can be changed by the user in the paragraph settings of a bibliography
15884 \begin_layout Standard
15885 Putting the last few things together, the \SpecialChar LaTeX
15886 output will be either:
15889 \begin_layout LyX-Code
15892 LatexName[LatexParam]{\SpecialChar ldots
15896 \begin_layout Standard
15900 \begin_layout LyX-Code
15903 begin{LatexName}[LatexParam] \SpecialChar ldots
15909 \begin_layout Standard
15910 depending upon the \SpecialChar LaTeX
15915 \begin_layout Description
15916 \begin_inset Flex Code
15919 \begin_layout Plain Layout
15926 \begin_inset Flex Code
15929 \begin_layout Plain Layout
15935 ] A string that is put at the beginning of the style content.
15936 A line break in the output can be indicated by
15937 \begin_inset Flex Code
15940 \begin_layout Plain Layout
15949 \begin_layout Description
15950 \begin_inset Flex Code
15953 \begin_layout Plain Layout
15960 \begin_inset Flex Code
15963 \begin_layout Plain Layout
15969 ] If you put styles into environments, the different
15970 \begin_inset Flex Code
15973 \begin_layout Plain Layout
15979 are not simply added, but added with a factor
15980 \begin_inset Formula $\frac{4}{\mathrm{depth}+4}$
15984 Note that this parameter is also used when
15985 \begin_inset Flex Code
15988 \begin_layout Plain Layout
15995 \begin_inset Flex Code
15998 \begin_layout Plain Layout
16005 \begin_inset Flex Code
16008 \begin_layout Plain Layout
16015 Then it is added to the manual or dynamic margin.
16016 \begin_inset Newline newline
16020 \begin_inset Quotes eld
16024 \begin_inset Flex Code
16027 \begin_layout Plain Layout
16034 \begin_inset Quotes erd
16037 means that the paragraph is indented with the width of
16038 \begin_inset Quotes eld
16042 \begin_inset Flex Code
16045 \begin_layout Plain Layout
16052 \begin_inset Quotes erd
16055 in the normal font.
16056 You can get a negative width by prefixing the string with
16057 \begin_inset Quotes eld
16061 \begin_inset Flex Code
16064 \begin_layout Plain Layout
16071 \begin_inset Quotes erd
16075 This way was chosen so that the look is the same with each used screen
16079 \begin_layout Description
16080 \begin_inset Flex Code
16083 \begin_layout Plain Layout
16090 \begin_inset Flex Code
16093 \begin_layout Plain Layout
16098 , Manual, Dynamic, First_Dynamic, Right_Address_Box
16104 \begin_inset Newline newline
16107 The kind of margin that the style has on the left side.
16111 \begin_layout Description
16112 \begin_inset Flex Code
16115 \begin_layout Plain Layout
16121 just means a fixed margin.
16124 \begin_layout Description
16125 \begin_inset Flex Code
16128 \begin_layout Plain Layout
16134 means that the left margin depends on the string entered in the
16135 \begin_inset Flex Noun
16138 \begin_layout Plain Layout
16139 Edit\SpecialChar menuseparator
16141 \begin_inset space ~
16150 This is used to typeset nice lists without tabulators.
16153 \begin_layout Description
16154 \begin_inset Flex Code
16157 \begin_layout Plain Layout
16163 means that the margin depends on the size of the label.
16164 This is used for automatic enumerated headlines.
16165 It is obvious that the headline
16166 \begin_inset Quotes eld
16169 5.4.3.2.1 Very long headline
16170 \begin_inset Quotes erd
16173 must have a wider left margin (as wide as
16174 \begin_inset Quotes eld
16178 \begin_inset Quotes erd
16181 plus the space) than
16182 \begin_inset Quotes eld
16185 3.2 Very long headline
16186 \begin_inset Quotes erd
16190 \begin_inset Quotes eld
16194 \begin_inset Quotes erd
16197 are not able to do this.
16200 \begin_layout Description
16201 \begin_inset Flex Code
16204 \begin_layout Plain Layout
16210 is similar, but only the very first row of the paragraph is dynamic, while
16211 the others are static; this is used, for example, for descriptions.
16214 \begin_layout Description
16215 \begin_inset Flex Code
16218 \begin_layout Plain Layout
16224 means the margin is chosen in a way that the longest row of this paragraph
16225 fits to the right margin.
16226 This is used to typeset an address on the right edge of the page.
16230 \begin_layout Description
16231 \begin_inset Flex Code
16234 \begin_layout Plain Layout
16241 \begin_inset Flex Code
16244 \begin_layout Plain Layout
16253 \begin_inset space \thinspace{}
16257 \begin_inset Flex Code
16260 \begin_layout Plain Layout
16266 ] Whether fragile commands in this style should be
16267 \begin_inset Flex Code
16270 \begin_layout Plain Layout
16283 whether this command should itself be protected.)
16284 \change_inserted -712698321 1523696949
16288 \begin_layout Description
16290 \change_inserted -712698321 1552395557
16291 \begin_inset Flex Code
16294 \begin_layout Plain Layout
16296 \change_inserted -712698321 1523696950
16305 \begin_inset Flex Code
16308 \begin_layout Plain Layout
16310 \change_inserted -712698321 1523696950
16321 \begin_inset space \thinspace{}
16325 \begin_inset Flex Code
16328 \begin_layout Plain Layout
16330 \change_inserted -712698321 1523696950
16338 ] This causes macros that contain this layout to be protected with
16339 \begin_inset Flex Code
16342 \begin_layout Plain Layout
16344 \change_inserted -712698321 1523696950
16359 ) if necessary and thus allows (some) verbatim stuff in macros.
16362 \begin_layout Description
16364 \change_inserted -712698321 1552395844
16365 \begin_inset Flex Code
16368 \begin_layout Plain Layout
16370 \change_inserted -712698321 1552395561
16379 \begin_inset Flex Code
16382 \begin_layout Plain Layout
16384 \change_inserted -712698321 1552395557
16395 \begin_inset space \thinspace{}
16399 \begin_inset Flex Code
16402 \begin_layout Plain Layout
16404 \change_inserted -712698321 1552395557
16412 ] Whether specific commands in this style (such as
16413 \begin_inset Flex Code
16416 \begin_layout Plain Layout
16418 \change_inserted -712698321 1552395655
16429 \begin_inset Flex Code
16432 \begin_layout Plain Layout
16434 \change_inserted -712698321 1552395661
16444 ) should be protected in an
16445 \begin_inset Flex Code
16448 \begin_layout Plain Layout
16450 \change_inserted -712698321 1552395631
16461 This is particularly needed for styles that draw on
16469 commands which parse their content in complex ways.
16474 \begin_layout Description
16475 \begin_inset Flex Code
16478 \begin_layout Plain Layout
16485 \begin_inset Flex Code
16488 \begin_layout Plain Layout
16495 \begin_inset space \thinspace{}
16499 \begin_inset Flex Code
16502 \begin_layout Plain Layout
16510 ] Whether newlines are translated into \SpecialChar LaTeX
16512 \begin_inset Flex Code
16515 \begin_layout Plain Layout
16526 The translation can be switched off to allow more comfortable \SpecialChar LaTeX
16528 inside \SpecialChar LyX
16532 \begin_layout Description
16533 \begin_inset Flex Code
16536 \begin_layout Plain Layout
16543 \begin_inset Flex Code
16546 \begin_layout Plain Layout
16555 \begin_inset space \thinspace{}
16559 \begin_inset Flex Code
16562 \begin_layout Plain Layout
16568 ] If set to true, and if
16569 \begin_inset Flex Code
16572 \begin_layout Plain Layout
16579 \begin_inset Flex Code
16582 \begin_layout Plain Layout
16588 ) paragraphs are being indented, then the indentation of such a paragraph
16589 following one of this type will be suppressed.
16590 (So this will not affect the display of non-default paragraphs.)
16593 \begin_layout Description
16594 \begin_inset Flex Code
16597 \begin_layout Plain Layout
16604 \begin_inset Flex Code
16607 \begin_layout Plain Layout
16613 ] Name of a style that has replaced this style.
16614 This is used to rename a style, while keeping backward compatibility.
16617 \begin_layout Description
16618 \begin_inset Flex Code
16621 \begin_layout Plain Layout
16628 \begin_inset Flex Code
16631 \begin_layout Plain Layout
16638 \begin_inset space \thinspace{}
16642 \begin_inset Flex Code
16645 \begin_layout Plain Layout
16651 ] Determines whether consecutive paragraphs of the same type are treated
16652 as belonging together.
16653 This has the effect that the
16654 \begin_inset Flex Code
16657 \begin_layout Plain Layout
16663 is only printed once before such a group.
16664 By default, this is true for
16665 \begin_inset Flex Code
16668 \begin_layout Plain Layout
16675 \begin_inset Flex Code
16678 \begin_layout Plain Layout
16685 \begin_inset Flex Code
16688 \begin_layout Plain Layout
16694 and false for all other types.
16697 \begin_layout Description
16698 \begin_inset Flex Code
16701 \begin_layout Plain Layout
16708 \begin_inset Flex Code
16711 \begin_layout Plain Layout
16720 \begin_inset space \thinspace{}
16724 \begin_inset Flex Code
16727 \begin_layout Plain Layout
16733 ] Indicates that paragraphs will not be separated by an empty line in \SpecialChar LaTeX
16735 but only by a line break; together with
16736 \begin_inset Flex Code
16739 \begin_layout Plain Layout
16745 , this allows to emulate a plain text editor (like the ERT inset).
16748 \begin_layout Description
16749 \begin_inset Flex Code
16752 \begin_layout Plain Layout
16759 \begin_inset Flex Code
16762 \begin_layout Plain Layout
16768 ] The indent of the very first line of a paragraph.
16770 \begin_inset Newline newline
16774 \begin_inset Flex Code
16777 \begin_layout Plain Layout
16783 will be fixed for a certain style.
16784 The exception is the default style, since the indentation for these paragraphs
16785 can be prohibited with
16786 \begin_inset Flex Code
16789 \begin_layout Plain Layout
16797 \begin_inset Flex Code
16800 \begin_layout Plain Layout
16806 style paragraphs inside environments use the
16807 \begin_inset Flex Code
16810 \begin_layout Plain Layout
16816 of the environment, not their native one.
16818 \begin_inset Flex Code
16821 \begin_layout Plain Layout
16827 paragraphs inside an enumeration are not indented.
16830 \begin_layout Description
16831 \begin_inset Flex Code
16834 \begin_layout Plain Layout
16841 \begin_inset Flex Code
16844 \begin_layout Plain Layout
16850 ] The vertical space between two paragraphs of this style.
16853 \begin_layout Description
16854 \begin_inset Flex Code
16857 \begin_layout Plain Layout
16864 \begin_inset Flex Code
16867 \begin_layout Plain Layout
16874 allows the user to choose either
16875 \begin_inset Quotes eld
16879 \begin_inset Quotes erd
16883 \begin_inset Quotes eld
16887 \begin_inset Quotes erd
16890 to separate paragraphs.
16892 \begin_inset Quotes eld
16896 \begin_inset Quotes erd
16900 \begin_inset Flex Code
16903 \begin_layout Plain Layout
16911 \begin_inset Quotes eld
16915 \begin_inset Quotes erd
16919 \begin_inset Flex Code
16922 \begin_layout Plain Layout
16928 is ignored and all paragraphs are separated by the
16929 \begin_inset Flex Code
16932 \begin_layout Plain Layout
16939 The vertical space is calculated with
16940 \begin_inset Flex Code
16943 \begin_layout Plain Layout
16945 \begin_inset space ~
16954 \begin_inset Flex Code
16957 \begin_layout Plain Layout
16963 is the height of a row with the normal font.
16964 This way, the look stays the same with different screen fonts.
16967 \begin_layout Description
16968 \begin_inset Flex Code
16971 \begin_layout Plain Layout
16978 \begin_inset Flex Code
16981 \begin_layout Plain Layout
16990 \begin_inset space \thinspace{}
16994 \begin_inset Flex Code
16997 \begin_layout Plain Layout
17003 ] Whether the contents of this paragraph should be output in raw form, meaning
17004 without special translations that \SpecialChar LaTeX
17008 \begin_layout Description
17009 \begin_inset Flex Code
17012 \begin_layout Plain Layout
17019 \begin_inset Flex Code
17022 \begin_layout Plain Layout
17032 Defines individual characters that should be output in raw form, meaning
17033 without special translations that \SpecialChar LaTeX
17037 \begin_layout Description
17038 \begin_inset Flex Code
17041 \begin_layout Plain Layout
17047 Information to be included in the \SpecialChar LaTeX
17048 preamble when this style is used.
17049 Used to define macros, load packages, etc., required by this particular
17052 \begin_inset Quotes eld
17056 \begin_inset Flex Code
17059 \begin_layout Plain Layout
17066 \begin_inset Quotes erd
17072 \begin_layout Description
17073 \begin_inset Flex Code
17076 \begin_layout Plain Layout
17083 \begin_inset Flex Code
17086 \begin_layout Plain Layout
17092 ] The prefix to use when creating labels referring to paragraphs of this
17094 This allows the use of formatted references.
17097 \begin_layout Description
17098 \begin_inset Flex Code
17101 \begin_layout Plain Layout
17108 \begin_inset Flex Code
17111 \begin_layout Plain Layout
17117 ] Whether the style requires the feature
17118 \begin_inset Flex Code
17121 \begin_layout Plain Layout
17128 \begin_inset CommandInset ref
17130 reference "chap:List-of-functions"
17134 for the list of features).
17135 If you require a package with specific options, you can additionally use
17137 \begin_inset Flex Code
17140 \begin_layout Plain Layout
17146 as a general text class parameter (see
17147 \begin_inset CommandInset ref
17149 reference "subsec:General-text-class"
17156 \begin_layout Description
17157 \begin_inset Flex Code
17160 \begin_layout Plain Layout
17167 \begin_inset Flex Code
17170 \begin_layout Plain Layout
17179 \begin_inset Flex Code
17182 \begin_layout Plain Layout
17188 ] Resets the \SpecialChar LaTeX
17189 arguments of this style (as defined via the
17190 \begin_inset Flex Code
17193 \begin_layout Plain Layout
17200 This is useful if you have copied a style via
17201 \begin_inset Flex Code
17204 \begin_layout Plain Layout
17210 , but you do not want to inherit its (required and optional) arguments.
17213 \begin_layout Description
17214 \begin_inset Flex Code
17217 \begin_layout Plain Layout
17224 \begin_inset Flex Code
17227 \begin_layout Plain Layout
17236 \begin_inset Flex Code
17239 \begin_layout Plain Layout
17245 ] Resumes a counter that is usually reset at each new sequence of layouts.
17246 This is currently only useful when
17247 \begin_inset Flex Code
17250 \begin_layout Plain Layout
17257 \begin_inset Flex Code
17260 \begin_layout Plain Layout
17269 \begin_layout Description
17270 \begin_inset Flex Code
17273 \begin_layout Plain Layout
17280 \begin_inset Flex Code
17283 \begin_layout Plain Layout
17289 ] A string that is put at the end of the layout content.
17290 A line break in the output can be indicated by
17291 \begin_inset Flex Code
17294 \begin_layout Plain Layout
17303 \begin_layout Description
17304 \begin_inset Flex Code
17307 \begin_layout Plain Layout
17314 \begin_inset Flex Code
17317 \begin_layout Plain Layout
17324 \begin_inset Flex Code
17327 \begin_layout Plain Layout
17336 \begin_layout Description
17337 \begin_inset Flex Code
17340 \begin_layout Plain Layout
17347 \begin_inset Flex Code
17350 \begin_layout Plain Layout
17359 \begin_inset Flex Code
17362 \begin_layout Plain Layout
17369 \begin_inset Flex Code
17372 \begin_layout Plain Layout
17379 \begin_inset Flex Code
17382 \begin_layout Plain Layout
17384 \begin_inset space ~
17392 ] This defines what the default spacing should be in the style.
17394 \begin_inset Flex Code
17397 \begin_layout Plain Layout
17404 \begin_inset Flex Code
17407 \begin_layout Plain Layout
17414 \begin_inset Flex Code
17417 \begin_layout Plain Layout
17423 correspond respectively to a multiplier value of 1, 1.25 and 1.667.
17424 If you specify the argument
17425 \begin_inset Flex Code
17428 \begin_layout Plain Layout
17434 , then you must also provide a value argument which will be the actual multiplie
17436 Note that, contrary to other parameters,
17437 \begin_inset Flex Code
17440 \begin_layout Plain Layout
17446 implies the generation of specific \SpecialChar LaTeX
17447 code, using the \SpecialChar LaTeX
17451 \begin_inset Flex Code
17454 \begin_layout Plain Layout
17463 \begin_layout Description
17464 \begin_inset Flex Code
17467 \begin_layout Plain Layout
17474 \begin_inset Flex Code
17477 \begin_layout Plain Layout
17484 \begin_inset space \thinspace{}
17488 \begin_inset Flex Code
17491 \begin_layout Plain Layout
17499 ] Allow spell-checking paragraphs of this style.
17503 \begin_layout Description
17504 \begin_inset Flex Code
17507 \begin_layout Plain Layout
17509 \change_deleted 731793113 1604355211
17511 \change_inserted 731793113 1604355212
17520 \begin_inset Flex Code
17523 \begin_layout Plain Layout
17532 \begin_inset Flex Code
17535 \begin_layout Plain Layout
17542 \change_deleted 731793113 1604355214
17544 \change_inserted 731793113 1604355216
17547 counter of a given counter at the beginning of a new sequence of layouts.
17548 This is currently only useful when
17549 \begin_inset Flex Code
17552 \begin_layout Plain Layout
17559 \begin_inset Flex Code
17562 \begin_layout Plain Layout
17571 \begin_layout Description
17572 \begin_inset Flex Code
17575 \begin_layout Plain Layout
17581 The font used for the text body .
17583 \begin_inset CommandInset ref
17585 reference "subsec:Font-description"
17592 \begin_layout Description
17593 \begin_inset Flex Code
17596 \begin_layout Plain Layout
17605 \begin_inset Flex Code
17608 \begin_layout Plain Layout
17618 The level of the style in the table of contents.
17619 This is used for automatic numbering of section headings.
17622 \begin_layout Description
17623 \begin_inset Flex Code
17626 \begin_layout Plain Layout
17635 \begin_inset Flex Code
17638 \begin_layout Plain Layout
17649 \begin_inset Flex Code
17652 \begin_layout Plain Layout
17659 \begin_inset Flex Code
17662 \begin_layout Plain Layout
17668 ] This tag determines whether the first line indentation of this paragraph
17669 can be toggled via the Paragraph settings dialog.
17673 \begin_inset Flex Code
17676 \begin_layout Plain Layout
17686 is set, indentation can be toggled if the document settings use
17687 \begin_inset Quotes eld
17691 \begin_inset Quotes erd
17694 paragraph style, with
17695 \begin_inset Flex Code
17698 \begin_layout Plain Layout
17704 , indentation can always be toggled, notwithstanding the document settings,
17706 \begin_inset Flex Code
17709 \begin_layout Plain Layout
17715 , indentation can never be toggled.
17718 \begin_layout Description
17719 \begin_inset Flex Code
17722 \begin_layout Plain Layout
17729 \begin_inset Flex Code
17732 \begin_layout Plain Layout
17738 ] The vertical space with which the very first of a chain of paragraphs
17739 with this style is separated from the previous paragraph.
17740 If the previous paragraph has another style, the separations are not simply
17741 added, but the maximum is taken.
17744 \begin_layout Subsection
17745 \begin_inset CommandInset label
17751 Internationalization of Paragraph Styles
17754 \begin_layout Standard
17756 has long supported internationalization of layout information, but, until
17757 version 2.0, this applied only to the user interface and not to, say, PDF
17759 Thus, French authors were forced to resort to ugly hacks if they wanted
17764 1' instead of `Theorem 1'.
17765 Thanks to Georg Baum, that is no longer the case.
17768 \begin_layout Standard
17770 \begin_inset Flex Code
17773 \begin_layout Plain Layout
17779 defines text that is to appear in the typeset document, it may use
17780 \begin_inset Flex Code
17783 \begin_layout Plain Layout
17790 \begin_inset Flex Code
17793 \begin_layout Plain Layout
17799 to support non-English and even multi-language documents correctly.
17800 The following excerpt (from the
17801 \begin_inset Flex Code
17804 \begin_layout Plain Layout
17810 file) shows how this works:
17813 \begin_layout LyX-Code
17818 \begin_layout LyX-Code
17821 theoremstyle{remark}
17824 \begin_layout LyX-Code
17827 newtheorem{claim}[thm]{
17834 \begin_layout LyX-Code
17838 \begin_layout LyX-Code
17842 \begin_layout LyX-Code
17847 claimname}{_(Claim)}
17850 \begin_layout LyX-Code
17854 \begin_layout LyX-Code
17858 \begin_layout LyX-Code
17867 claimname}{_(Claim)}}
17870 \begin_layout LyX-Code
17875 \begin_layout Standard
17876 In principle, any legal \SpecialChar LaTeX
17878 \begin_inset Flex Code
17881 \begin_layout Plain Layout
17888 \begin_inset Flex Code
17891 \begin_layout Plain Layout
17897 tags, but in practice they will typically look as they do here.
17898 The key to correct translation of the typeset text is the definition of
17899 the \SpecialChar LaTeX
17901 \begin_inset Flex Code
17904 \begin_layout Plain Layout
17913 \begin_inset Flex Code
17916 \begin_layout Plain Layout
17928 \begin_layout Standard
17930 \begin_inset Flex Code
17933 \begin_layout Plain Layout
17939 tag provides for internationalization based upon the overall language of
17941 The contents of the tag will be included in the preamble, just as with
17943 \begin_inset Flex Code
17946 \begin_layout Plain Layout
17953 What makes it special is the use of the
17954 \begin_inset Quotes eld
17958 \begin_inset Quotes erd
17962 \begin_inset Flex Code
17965 \begin_layout Plain Layout
17971 , which will be replaced, when \SpecialChar LyX
17972 produces \SpecialChar LaTeX
17973 output, with the translation of
17974 its argument into the document language.
17977 \begin_layout Standard
17979 \begin_inset Flex Code
17982 \begin_layout Plain Layout
17988 tag is more complex, since it is meant to provide support for multi-language
17989 documents and so offers an interface to the
17990 \begin_inset Flex Code
17993 \begin_layout Plain Layout
18000 Its contents will be added to the preamble once for each language that
18001 appears in the document.
18002 In this case, the argument to
18003 \begin_inset Flex Code
18006 \begin_layout Plain Layout
18012 will be replaced with its translation into the language in question; the
18014 \begin_inset Flex Code
18017 \begin_layout Plain Layout
18023 is replaced by the language name (as used by the babel package).
18026 \begin_layout Standard
18027 A German document that also included a French section would thus have the
18028 following in the preamble:
18031 \begin_layout LyX-Code
18040 claimname}{Affirmation}}
18041 \begin_inset Newline newline
18052 claimname}{Behauptung}}
18053 \begin_inset Newline newline
18060 claimname}{Behauptung}
18063 \begin_layout Standard
18066 \begin_inset Flex Code
18069 \begin_layout Plain Layout
18075 will then conspire to produce the correct text in the output.
18078 \begin_layout Standard
18079 One important point to note here is that the translations are provided by
18081 itself, through the file
18082 \begin_inset Flex Code
18085 \begin_layout Plain Layout
18092 This means, in effect, that
18093 \begin_inset Flex Code
18096 \begin_layout Plain Layout
18103 \begin_inset Flex Code
18106 \begin_layout Plain Layout
18112 are really only of use in layout files that are provided with \SpecialChar LyX
18114 entered in user-created layout files will not be seen by \SpecialChar LyX
18115 's internationalizatio
18116 n routines unless the
18117 \begin_inset Flex Code
18120 \begin_layout Plain Layout
18126 file is modified accordingly.
18127 That said, however, any layout created with the intention that it will
18128 be included with \SpecialChar LyX
18129 should use these tags where appropriate.
18130 Please note that the paragraph style translations provided by \SpecialChar LyX
18132 change with a minor update (e.
18133 \begin_inset space \thinspace{}
18137 \begin_inset space \space{}
18140 from version 2.1.x to 2.1.y).
18141 It is however quite likely that a major update (e.
18142 \begin_inset space \thinspace{}
18146 \begin_inset space \space{}
18149 from 2.0.x to 2.1.0) will introduce new translations or corrections.
18152 \begin_layout Subsection
18154 \begin_inset CommandInset label
18156 name "subsec:Floats"
18163 \begin_layout Standard
18164 It is necessary to define the floats (
18165 \begin_inset Flex Noun
18168 \begin_layout Plain Layout
18175 \begin_inset Flex Noun
18178 \begin_layout Plain Layout
18184 , \SpecialChar ldots
18185 ) in the text class itself.
18186 Standard floats are included in the file
18187 \begin_inset Flex Code
18190 \begin_layout Plain Layout
18196 , so you may have to do no more than add
18199 \begin_layout LyX-Code
18200 Input stdfloats.inc
18203 \begin_layout Standard
18204 to your layout file.
18205 If you want to implement a text class that proposes some other float types
18206 (like the AGU class bundled with \SpecialChar LyX
18207 ), the information below will hopefully
18211 \begin_layout Description
18212 \begin_inset Flex Code
18215 \begin_layout Plain Layout
18222 \begin_inset Flex Code
18225 \begin_layout Plain Layout
18231 =!htbpH] Allowed placement options for this float type.
18232 The value is a string of placement characters.
18233 Possible characters include:
18238 \begin_inset Quotes eld
18242 \begin_inset Quotes erd
18250 \begin_inset Quotes eld
18254 \begin_inset Quotes erd
18262 \begin_inset Quotes eld
18266 \begin_inset Quotes erd
18274 \begin_inset Quotes eld
18278 \begin_inset Quotes erd
18286 \begin_inset Quotes eld
18290 \begin_inset Quotes erd
18298 \begin_inset Quotes eld
18302 \begin_inset Quotes erd
18306 The order of the characters in the string does not matter.
18307 If no placement options are allowed, use the string
18314 \begin_layout Description
18315 \begin_inset Flex Code
18318 \begin_layout Plain Layout
18325 \begin_inset Flex Code
18328 \begin_layout Plain Layout
18337 \begin_inset space \thinspace{}
18343 \begin_inset Flex Code
18346 \begin_layout Plain Layout
18356 ] Defines whether the float allows to be rotated via the \SpecialChar LaTeX
18363 \begin_inset Flex Code
18366 \begin_layout Plain Layout
18372 if the float does not support this feature.
18375 \begin_layout Description
18376 \begin_inset Flex Code
18379 \begin_layout Plain Layout
18386 \begin_inset Flex Code
18389 \begin_layout Plain Layout
18398 \begin_inset space \thinspace{}
18404 \begin_inset Flex Code
18407 \begin_layout Plain Layout
18417 ] Defines whether the float has a starred variant that spans columns in
18418 a two column paragraph.
18420 \begin_inset Flex Code
18423 \begin_layout Plain Layout
18429 if the float does not support this feature.
18432 \begin_layout Description
18433 \begin_inset Flex Code
18436 \begin_layout Plain Layout
18443 \begin_inset Flex Code
18446 \begin_layout Plain Layout
18453 \begin_inset Quotes erd
18457 \begin_inset Quotes erd
18460 ] The file name extension of an auxiliary file for the list of figures (or
18463 writes the captions to this file.
18466 \begin_layout Description
18467 \begin_inset Flex Code
18470 \begin_layout Plain Layout
18477 \begin_inset Flex Code
18480 \begin_layout Plain Layout
18487 \begin_inset Quotes erd
18491 \begin_inset Quotes erd
18494 ] The string that will be used in the menus and also for the caption.
18495 This is translated to the current language if babel is used.
18498 \begin_layout Description
18499 \begin_inset Flex Code
18502 \begin_layout Plain Layout
18508 These tags control the XHTML output.
18510 \begin_inset CommandInset ref
18512 reference "sec:Tags-for-XHTML"
18519 \begin_layout Description
18520 \begin_inset Flex Code
18523 \begin_layout Plain Layout
18532 \begin_inset Flex Code
18535 \begin_layout Plain Layout
18544 \begin_inset space \thinspace{}
18548 \begin_inset Flex Code
18551 \begin_layout Plain Layout
18557 ] Indicates whether the float is already defined in the document class or
18558 if instead the \SpecialChar LaTeX
18560 \begin_inset Flex Code
18563 \begin_layout Plain Layout
18569 needs to be loaded to define it on-the-fly.
18571 \begin_inset Flex Code
18574 \begin_layout Plain Layout
18581 \begin_inset Flex Code
18584 \begin_layout Plain Layout
18591 It should be set to
18592 \begin_inset Flex Code
18595 \begin_layout Plain Layout
18601 if the float is already defined by the \SpecialChar LaTeX
18605 \begin_layout Description
18606 \begin_inset Flex Code
18609 \begin_layout Plain Layout
18616 \begin_inset Flex Code
18619 \begin_layout Plain Layout
18626 \begin_inset Quotes erd
18630 \begin_inset Quotes erd
18633 ] The command used to generate a list of floats of this type; the leading
18642 \begin_inset Flex Code
18645 \begin_layout Plain Layout
18651 is false, since there is no standard way to generate this command.
18653 \begin_inset Flex Code
18656 \begin_layout Plain Layout
18662 is true, since in that case there is a standard way to define the command.
18665 \begin_layout Description
18666 \begin_inset Flex Code
18669 \begin_layout Plain Layout
18676 \begin_inset Flex Code
18679 \begin_layout Plain Layout
18686 \begin_inset Quotes erd
18690 \begin_inset Quotes erd
18693 ] A title for a list of floats of this kind (list of figures, tables, or
18695 It is used for the screen label within \SpecialChar LyX
18696 , it is used by \SpecialChar LaTeX
18698 it is used as the title in the XHTML output.
18699 It will be translated to the document language.
18702 \begin_layout Description
18703 \begin_inset Flex Code
18706 \begin_layout Plain Layout
18713 \begin_inset Flex Code
18716 \begin_layout Plain Layout
18723 \begin_inset Quotes erd
18727 \begin_inset Quotes erd
18730 ] This (optional) argument determines whether floats of this class will
18731 be numbered within some sectional unit of the document.
18733 \begin_inset Flex Code
18736 \begin_layout Plain Layout
18743 \begin_inset Quotes eld
18747 \begin_inset Flex Code
18750 \begin_layout Plain Layout
18757 \begin_inset Quotes erd
18760 , the floats will be numbered within chapters.
18764 \begin_layout Description
18765 \begin_inset Flex Code
18768 \begin_layout Plain Layout
18775 \begin_inset Flex Code
18778 \begin_layout Plain Layout
18785 \begin_inset Quotes erd
18789 \begin_inset Quotes erd
18792 ] The default placement for the given class of floats.
18793 The string should be as in standard \SpecialChar LaTeX
18795 \begin_inset Flex Code
18798 \begin_layout Plain Layout
18805 \begin_inset Flex Code
18808 \begin_layout Plain Layout
18815 \begin_inset Flex Code
18818 \begin_layout Plain Layout
18825 \begin_inset Flex Code
18828 \begin_layout Plain Layout
18834 for top, bottom, page, and here, respectively.
18838 \begin_layout Plain Layout
18839 Note that the order of these letters in the string is irrelevant, like in
18846 On top of that there is a new type,
18847 \begin_inset Flex Code
18850 \begin_layout Plain Layout
18856 , which does not really correspond to a float, since it means: put it
18857 \begin_inset Quotes eld
18861 \begin_inset Quotes erd
18865 Note however that the
18866 \begin_inset Flex Code
18869 \begin_layout Plain Layout
18875 specifier is special and, because of implementation details, cannot be
18876 used in non-built in float types.
18877 If you do not understand what this means, just use
18878 \begin_inset Quotes eld
18882 \begin_inset Flex Code
18885 \begin_layout Plain Layout
18892 \begin_inset Quotes erd
18898 \begin_layout Description
18899 \begin_inset Flex Code
18902 \begin_layout Plain Layout
18909 \begin_inset Flex Code
18912 \begin_layout Plain Layout
18918 ] The prefix to use when creating labels referring to floats of this type.
18919 This allows the use of formatted references.
18920 Note that you can remove any
18921 \begin_inset Flex Code
18924 \begin_layout Plain Layout
18930 set by a copied style by using the special value
18931 \begin_inset Quotes eld
18935 \begin_inset Quotes erd
18938 , which must be all caps.
18939 \change_inserted -712698321 1565605014
18943 \begin_layout Description
18945 \change_inserted -712698321 1565605014
18946 \begin_inset Flex Code
18949 \begin_layout Plain Layout
18951 \change_inserted -712698321 1565605014
18960 \begin_inset Flex Code
18963 \begin_layout Plain Layout
18965 \change_inserted -712698321 1565605014
18973 ] As with paragraph styles, see
18974 \begin_inset CommandInset ref
18976 reference "subsec:Paragraph-Styles"
18985 \begin_layout Description
18986 \begin_inset Flex Code
18989 \begin_layout Plain Layout
18996 \begin_inset Flex Code
18999 \begin_layout Plain Layout
19006 \begin_inset Quotes erd
19010 \begin_inset Quotes erd
19013 ] The style used when defining the float using
19014 \begin_inset Flex Code
19017 \begin_layout Plain Layout
19028 \begin_layout Description
19029 \begin_inset Flex Code
19032 \begin_layout Plain Layout
19039 \begin_inset Flex Code
19042 \begin_layout Plain Layout
19049 \begin_inset Quotes erd
19053 \begin_inset Quotes erd
19057 \begin_inset Quotes eld
19061 \begin_inset Quotes erd
19064 of the new class of floats, like program or algorithm.
19065 After the appropriate
19066 \begin_inset Flex Code
19069 \begin_layout Plain Layout
19078 \begin_inset Flex Code
19081 \begin_layout Plain Layout
19090 \begin_inset Flex Code
19093 \begin_layout Plain Layout
19104 \begin_layout Description
19105 \begin_inset Flex Code
19108 \begin_layout Plain Layout
19115 \begin_inset Flex Code
19118 \begin_layout Plain Layout
19125 \begin_inset space \thinspace{}
19129 \begin_inset Flex Code
19132 \begin_layout Plain Layout
19140 ] Specifies whether this float is defined using the \SpecialChar LaTeX
19142 \begin_inset Flex Code
19145 \begin_layout Plain Layout
19151 , either by the class file, another package or on-the-fly by \SpecialChar LyX
19155 \begin_layout Standard
19156 Note that defining a float with type
19157 \begin_inset Flex Code
19160 \begin_layout Plain Layout
19168 automatically defines the corresponding counter with name
19169 \begin_inset Flex Code
19172 \begin_layout Plain Layout
19183 \begin_layout Subsection
19184 Flex insets and InsetLayout
19185 \begin_inset CommandInset label
19187 name "subsec:Flex-insets-and"
19194 \begin_layout Standard
19195 Flex insets come in
19196 \change_deleted 5863208 1594239511
19198 \change_inserted 5863208 1594239512
19204 \begin_layout Itemize
19206 \begin_inset Flex Code
19209 \begin_layout Plain Layout
19215 ): These define semantic markup corresponding to such \SpecialChar LaTeX
19217 \begin_inset Flex Code
19220 \begin_layout Plain Layout
19229 \begin_inset Flex Code
19232 \begin_layout Plain Layout
19243 \begin_layout Itemize
19245 \begin_inset Flex Code
19248 \begin_layout Plain Layout
19254 ): These can be used to define custom collapsible insets, similar to \SpecialChar TeX
19256 footnote, and the like.
19257 An obvious example is an endnote inset, which is defined in the
19258 \begin_inset Flex Code
19261 \begin_layout Plain Layout
19270 \begin_layout Itemize
19272 \change_deleted 5863208 1594239528
19274 \begin_inset Flex Code
19277 \begin_layout Plain Layout
19283 ): For use with DocBook classes.
19288 \begin_layout Standard
19289 Flex insets are defined using the
19290 \begin_inset Flex Code
19293 \begin_layout Plain Layout
19299 tag, which shall be explained in a moment.
19302 \begin_layout Standard
19304 \begin_inset Flex Code
19307 \begin_layout Plain Layout
19313 tag also serves another function: It can be used to customize the general
19314 layout of many different types of insets.
19316 \begin_inset Flex Code
19319 \begin_layout Plain Layout
19325 can be used to customize the layout parameters for footnotes, marginal
19326 notes, note insets, \SpecialChar TeX
19327 code (ERT) insets, branches, listings, indexes, boxes,
19328 tables, algorithms, URLs, and captions, as well as to define Flex insets.
19331 \begin_layout Standard
19333 \begin_inset Flex Code
19336 \begin_layout Plain Layout
19342 definition must begin with a line of the form:
19345 \begin_layout LyX-Code
19349 \begin_layout Standard
19351 \begin_inset Flex Code
19354 \begin_layout Plain Layout
19360 indicates the inset whose layout is being defined, and here there are four
19364 \begin_layout Enumerate
19365 The layout for a pre-existing inset is being modified.
19366 In this case, can be
19367 \begin_inset Flex Code
19370 \begin_layout Plain Layout
19376 any one of the following:
19377 \begin_inset Flex Code
19380 \begin_layout Plain Layout
19387 \begin_inset Flex Code
19390 \begin_layout Plain Layout
19397 \begin_inset Flex Code
19400 \begin_layout Plain Layout
19407 \begin_inset Flex Code
19410 \begin_layout Plain Layout
19417 \begin_inset Flex Code
19420 \begin_layout Plain Layout
19427 \begin_inset Flex Code
19430 \begin_layout Plain Layout
19437 \begin_inset Flex Code
19440 \begin_layout Plain Layout
19447 \begin_inset Flex Code
19450 \begin_layout Plain Layout
19457 \begin_inset Flex Code
19460 \begin_layout Plain Layout
19467 \begin_inset Flex Code
19470 \begin_layout Plain Layout
19477 \begin_inset Flex Code
19480 \begin_layout Plain Layout
19487 \begin_inset Flex Code
19490 \begin_layout Plain Layout
19497 \begin_inset Flex Code
19500 \begin_layout Plain Layout
19507 \begin_inset Flex Code
19510 \begin_layout Plain Layout
19517 \begin_inset Flex Code
19520 \begin_layout Plain Layout
19527 \begin_inset Flex Code
19530 \begin_layout Plain Layout
19537 \begin_inset Flex Code
19540 \begin_layout Plain Layout
19547 \begin_inset Flex Code
19550 \begin_layout Plain Layout
19557 \begin_inset Flex Code
19560 \begin_layout Plain Layout
19567 \begin_inset Flex Code
19570 \begin_layout Plain Layout
19579 \begin_layout Enumerate
19580 The layout for a Flex inset is being defined.
19582 \begin_inset Flex Code
19585 \begin_layout Plain Layout
19591 must be of the form
19592 \begin_inset Quotes eld
19596 \begin_inset Flex Code
19599 \begin_layout Plain Layout
19606 \begin_inset Quotes erd
19610 \begin_inset Flex Code
19613 \begin_layout Plain Layout
19619 may be any valid identifier not used by a pre-existing Flex inset.
19620 The identifier may include spaces, but in that case the whole thing must
19621 be wrapped in quotes.
19622 Note that the definition of a flex inset
19627 \begin_inset Flex Code
19630 \begin_layout Plain Layout
19636 entry, declaring which type of inset it defines.
19639 \begin_layout Enumerate
19640 The layout for user specific branch is being defined.
19642 \begin_inset Flex Code
19645 \begin_layout Plain Layout
19651 must be of the form
19652 \begin_inset Quotes eld
19656 \begin_inset Flex Code
19659 \begin_layout Plain Layout
19666 \begin_inset Quotes erd
19670 \begin_inset Flex Code
19673 \begin_layout Plain Layout
19679 may be any valid identifier of branch defined in user's document.
19680 The identifier may include spaces, but in that case the whole thing must
19681 be wrapped in quotes.
19682 The main purpose of this feature is to allow \SpecialChar LaTeX
19683 wrapping around specific
19684 branches as user needs.
19687 \begin_layout Enumerate
19688 The layout of a user (or class) specific caption is being defined.
19690 \begin_inset Flex Code
19693 \begin_layout Plain Layout
19699 must be of the form
19700 \begin_inset Quotes eld
19704 \begin_inset Flex Code
19707 \begin_layout Plain Layout
19714 \begin_inset Quotes erd
19718 \begin_inset Flex Code
19721 \begin_layout Plain Layout
19727 specifies the name of the caption as it appears in the menu.
19728 Have a look at the standard caption (
19729 \begin_inset Flex Code
19732 \begin_layout Plain Layout
19738 ), the specific captions of the KOMA-Script classes (
19739 \begin_inset Flex Code
19742 \begin_layout Plain Layout
19749 \begin_inset Flex Code
19752 \begin_layout Plain Layout
19761 \begin_inset space ~
19765 \begin_inset Newline linebreak
19771 \begin_inset Flex Code
19774 \begin_layout Plain Layout
19780 ) for applications.
19783 \begin_layout Standard
19785 \begin_inset Flex Code
19788 \begin_layout Plain Layout
19794 definition can contain the following entries:
19797 \begin_layout Description
19798 \begin_inset Flex Code
19801 \begin_layout Plain Layout
19808 \begin_inset Flex Code
19811 \begin_layout Plain Layout
19817 =""] This inset will appear in the table of contents of the given type.
19818 An empty string disables.
19819 See also the OutlinerName and the IsTocCaption commands.
19820 This is only implemented for Flex insets.
19824 \begin_layout Description
19825 \begin_inset Flex Code
19828 \begin_layout Plain Layout
19835 \begin_inset Flex Code
19838 \begin_layout Plain Layout
19844 ] Defines argument number of a command\SpecialChar breakableslash
19845 environment associated with the current
19847 The definition must end with
19848 \begin_inset Flex Code
19851 \begin_layout Plain Layout
19859 \begin_inset CommandInset ref
19861 reference "subsec:Paragraph-Styles"
19868 \begin_layout Description
19869 \begin_inset Flex Code
19872 \begin_layout Plain Layout
19878 Preamble for changing language commands; see
19879 \begin_inset CommandInset ref
19881 reference "subsec:I18n"
19888 \begin_layout Description
19889 \begin_inset Flex Code
19892 \begin_layout Plain Layout
19899 \begin_inset Flex Code
19902 \begin_layout Plain Layout
19908 ] The color for the inset's background.
19910 \begin_inset CommandInset ref
19912 reference "chap:Names-of-colors"
19916 for a list of the available color names.
19919 \begin_layout Description
19920 \begin_inset Flex Code
19923 \begin_layout Plain Layout
19930 \begin_inset Flex Code
19933 \begin_layout Plain Layout
19942 \begin_inset space \thinspace{}
19946 \begin_inset Flex Code
19949 \begin_layout Plain Layout
19955 ] Whether to use the content of the inset as the label, when the inset is
19960 \begin_layout Description
19961 \begin_inset Flex Code
19964 \begin_layout Plain Layout
19971 \begin_inset Flex Code
19974 \begin_layout Plain Layout
19980 ] As with paragraph styles, see
19981 \begin_inset CommandInset ref
19983 reference "subsec:Paragraph-Styles"
19988 Note that you need to specify the complete type, e.
19989 \begin_inset space \thinspace{}
19993 \begin_inset space ~
19997 \begin_inset Flex Code
20000 \begin_layout Plain Layout
20001 CopyStyle Flex:<name>
20009 \begin_layout Description
20010 \begin_inset Flex Code
20013 \begin_layout Plain Layout
20020 \begin_inset Flex Code
20023 \begin_layout Plain Layout
20032 \begin_inset space \thinspace{}
20036 \begin_inset Flex Code
20039 \begin_layout Plain Layout
20045 ] Indicates whether the user may employ the Paragraph Settings dialog to
20046 customize the paragraph.
20049 \begin_layout Description
20050 \begin_inset Flex Code
20053 \begin_layout Plain Layout
20060 \begin_inset Flex Code
20063 \begin_layout Plain Layout
20070 \begin_inset Flex Code
20073 \begin_layout Plain Layout
20080 \begin_inset Flex Code
20083 \begin_layout Plain Layout
20089 , describing the rendering style used for the inset's frame and buttons.
20090 Footnotes generally use
20091 \begin_inset Flex Code
20094 \begin_layout Plain Layout
20100 , ERT insets generally
20101 \begin_inset Flex Code
20104 \begin_layout Plain Layout
20110 , and character styles
20111 \begin_inset Flex Code
20114 \begin_layout Plain Layout
20123 \begin_layout Description
20124 \begin_inset Flex Code
20127 \begin_layout Plain Layout
20134 \begin_inset Flex Code
20137 \begin_layout Plain Layout
20146 \begin_inset space \thinspace{}
20152 \begin_inset Flex Code
20155 \begin_layout Plain Layout
20164 \begin_inset Flex Code
20167 \begin_layout Plain Layout
20174 \begin_inset Flex Code
20177 \begin_layout Plain Layout
20184 Indicates whether the environment will stand on its own in the output or
20185 will appear inline with the surrounding text.
20186 If set to false, it is supposed that the \SpecialChar LaTeX
20187 environment ignores white space
20188 (including one newline character) after the
20189 \begin_inset Flex Code
20192 \begin_layout Plain Layout
20205 \begin_inset Flex Code
20208 \begin_layout Plain Layout
20222 \change_inserted 731793113 1538674858
20226 \begin_layout Description
20228 \change_inserted 731793113 1538674891
20229 \begin_inset Flex Code
20232 \begin_layout Plain Layout
20234 \change_inserted 731793113 1538674863
20246 ,1] Allow the contents of the inset to be edited externally (using whatever
20247 editor is defined for the document's output format).
20252 \begin_layout Description
20253 \begin_inset Flex Code
20256 \begin_layout Plain Layout
20262 Required at the end of the
20263 \begin_inset Flex Code
20266 \begin_layout Plain Layout
20275 \begin_layout Description
20276 \begin_inset Flex Code
20279 \begin_layout Plain Layout
20285 The font used for both the text body
20291 \begin_inset CommandInset ref
20293 reference "subsec:Font-description"
20298 Note that defining this font automatically defines the
20299 \begin_inset Flex Code
20302 \begin_layout Plain Layout
20308 to the same value, so define this first and define
20309 \begin_inset Flex Code
20312 \begin_layout Plain Layout
20318 later if you want them to be different.
20321 \begin_layout Description
20322 \begin_inset Flex Code
20325 \begin_layout Plain Layout
20326 FixedWidthPreambleEncoding
20332 \begin_inset Flex Code
20335 \begin_layout Plain Layout
20344 \begin_inset space \thinspace{}
20348 \begin_inset Flex Code
20351 \begin_layout Plain Layout
20357 ] Force a fixed width encoding for the translated contents of
20358 \begin_inset Flex Code
20361 \begin_layout Plain Layout
20368 \begin_inset Flex Code
20371 \begin_layout Plain Layout
20377 code generated by this layout.
20378 This is needed for special \SpecialChar LaTeX
20383 that do not work with variable width encodings such as
20388 This setting is ignored if fully Unicode aware \SpecialChar LaTeX
20389 backends such as Xe\SpecialChar TeX
20391 Lua\SpecialChar TeX
20395 \begin_layout Description
20396 \begin_inset Flex Code
20399 \begin_layout Plain Layout
20400 ForceLocalFontSwitch
20406 \begin_inset Flex Code
20409 \begin_layout Plain Layout
20418 \begin_inset space \thinspace{}
20422 \begin_inset Flex Code
20425 \begin_layout Plain Layout
20431 ] When using babel, always use a local font switch (
20432 \begin_inset Flex Code
20435 \begin_layout Plain Layout
20443 ), never a global one (such as
20444 \begin_inset Flex Code
20447 \begin_layout Plain Layout
20458 \begin_layout Description
20459 \begin_inset Flex Code
20462 \begin_layout Plain Layout
20469 \begin_inset Flex Code
20472 \begin_layout Plain Layout
20481 \begin_inset space \thinspace{}
20485 \begin_inset Flex Code
20488 \begin_layout Plain Layout
20495 \begin_inset Quotes eld
20499 \begin_inset Quotes erd
20502 language, leading to Left-to-Right (Latin) output, e.
20503 \begin_inset space \thinspace{}
20507 \begin_inset space \space{}
20510 in \SpecialChar TeX
20515 \begin_layout Description
20516 \begin_inset Flex Code
20519 \begin_layout Plain Layout
20526 \begin_inset Flex Code
20529 \begin_layout Plain Layout
20538 \begin_inset space \thinspace{}
20542 \begin_inset Flex Code
20545 \begin_layout Plain Layout
20551 ] Force a line break in the \SpecialChar LaTeX
20552 output before the inset starts and after the
20554 This assures the inset itself is output on its own lines, for parsing purposes.
20557 \begin_layout Description
20558 \begin_inset Flex Code
20561 \begin_layout Plain Layout
20568 \begin_inset Flex Code
20571 \begin_layout Plain Layout
20580 \begin_inset space \thinspace{}
20584 \begin_inset Flex Code
20587 \begin_layout Plain Layout
20593 ] Indicates whether the
20594 \begin_inset Flex Code
20597 \begin_layout Plain Layout
20603 should be used or, instead, the user can change the paragraph style used
20608 \begin_layout Description
20609 \begin_inset Flex Code
20612 \begin_layout Plain Layout
20619 \begin_inset Flex Code
20622 \begin_layout Plain Layout
20631 \begin_inset space \thinspace{}
20635 \begin_inset Flex Code
20638 \begin_layout Plain Layout
20644 ] As with paragraph styles, see
20645 \begin_inset CommandInset ref
20647 reference "subsec:Paragraph-Styles"
20654 \begin_layout Description
20655 \begin_inset Flex Code
20658 \begin_layout Plain Layout
20664 These tags control the XHTML output.
20666 \begin_inset CommandInset ref
20668 reference "sec:Tags-for-XHTML"
20675 \begin_layout Description
20676 \begin_inset Flex Code
20679 \begin_layout Plain Layout
20686 \begin_inset Flex Code
20689 \begin_layout Plain Layout
20698 \begin_inset space \thinspace{}
20702 \begin_inset Flex Code
20705 \begin_layout Plain Layout
20711 ] Whether to include the contents of this inset in the strings generated
20712 for the `Outline' pane for all table of contents, regardless of the AddToToc
20714 One would not, for example, want the content of a footnote in a section
20715 header to be included in the TOC displayed in the outline, but one would
20716 normally want the content of a character style displayed.
20717 Default is false: not to include.
20720 \begin_layout Description
20721 \begin_inset Flex Code
20724 \begin_layout Plain Layout
20731 \begin_inset Flex Code
20734 \begin_layout Plain Layout
20743 \begin_inset space \thinspace{}
20747 \begin_inset Flex Code
20750 \begin_layout Plain Layout
20756 ] If this is set to 1 and AddToToc is enabled, the inset adds a summary
20757 of its contents in its item in the table of contents.
20758 Otherwise, only the label appears.
20761 \begin_layout Description
20762 \begin_inset Flex Code
20765 \begin_layout Plain Layout
20774 \begin_inset Flex Code
20777 \begin_layout Plain Layout
20786 \begin_inset space \thinspace{}
20790 \begin_inset Flex Code
20793 \begin_layout Plain Layout
20799 ] As with paragraph styles, see
20800 \begin_inset CommandInset ref
20802 reference "subsec:Paragraph-Styles"
20809 \begin_layout Description
20810 \begin_inset Flex Code
20813 \begin_layout Plain Layout
20819 The font used for the label.
20821 \begin_inset CommandInset ref
20823 reference "subsec:Font-description"
20828 Note that this definition can never appear before
20829 \begin_inset Flex Code
20832 \begin_layout Plain Layout
20838 , lest it be ineffective.
20841 \begin_layout Description
20842 \begin_inset Flex Code
20845 \begin_layout Plain Layout
20852 \begin_inset Flex Code
20855 \begin_layout Plain Layout
20862 \begin_inset Quotes erd
20866 \begin_inset Quotes erd
20869 ] What will be displayed on the button or elsewhere as the inset label.
20871 \begin_inset Flex Code
20874 \begin_layout Plain Layout
20882 \begin_inset Flex Code
20885 \begin_layout Plain Layout
20891 ) modify this label on the fly.
20894 \begin_layout Description
20895 \begin_inset Flex Code
20898 \begin_layout Plain Layout
20904 Language dependent preamble; see
20905 \begin_inset CommandInset ref
20907 reference "subsec:I18n"
20914 \begin_layout Description
20915 \begin_inset Flex Code
20918 \begin_layout Plain Layout
20925 \begin_inset Flex Code
20928 \begin_layout Plain Layout
20934 ] The name of the corresponding \SpecialChar LaTeX
20936 Either the environment or command name.
20939 \begin_layout Description
20940 \begin_inset Flex Code
20943 \begin_layout Plain Layout
20950 \begin_inset Flex Code
20953 \begin_layout Plain Layout
20959 ] The optional parameter for the corresponding
20960 \begin_inset Flex Code
20963 \begin_layout Plain Layout
20969 stuff, including possible bracket pairs like
20970 \begin_inset Flex Code
20973 \begin_layout Plain Layout
20980 This parameter cannot be changed from within \SpecialChar LyX
20982 \begin_inset Flex Code
20985 \begin_layout Plain Layout
20991 for customizable parameters).
20992 It will be output as is after all \SpecialChar LaTeX
20994 \begin_inset Flex Code
20997 \begin_layout Plain Layout
21006 \begin_layout Description
21007 \begin_inset Flex Code
21010 \begin_layout Plain Layout
21017 \begin_inset Flex Code
21020 \begin_layout Plain Layout
21021 Command, Environment, None
21026 ] How the style should be translated into \SpecialChar LaTeX
21031 \begin_layout Plain Layout
21032 \begin_inset Flex Code
21035 \begin_layout Plain Layout
21041 is perhaps a bit misleading, since these rules apply to SGML classes too.
21042 Visit the SGML class files for specific examples.
21051 \begin_layout Description
21052 \begin_inset Flex Code
21055 \begin_layout Plain Layout
21061 means nothing special
21064 \begin_layout Description
21065 \begin_inset Flex Code
21068 \begin_layout Plain Layout
21075 \begin_inset Flex Code
21078 \begin_layout Plain Layout
21085 {\SpecialChar ldots
21094 \begin_layout Description
21095 \begin_inset Flex Code
21098 \begin_layout Plain Layout
21105 \begin_inset Flex Code
21108 \begin_layout Plain Layout
21115 }\SpecialChar ldots
21130 \begin_layout Standard
21131 Putting the last few things together, the \SpecialChar LaTeX
21132 output will be either:
21135 \begin_layout LyX-Code
21138 LatexName[LatexParam]{\SpecialChar ldots
21142 \begin_layout Standard
21146 \begin_layout LyX-Code
21149 begin{LatexName}[LatexParam] \SpecialChar ldots
21155 \begin_layout Standard
21156 depending upon the \SpecialChar LaTeX
21161 \begin_layout Description
21162 \begin_inset Flex Code
21165 \begin_layout Plain Layout
21172 \begin_inset Flex Code
21175 \begin_layout Plain Layout
21181 ] A string that is put at the beginning of the layout content.
21182 A line break in the output can be indicated by
21183 \begin_inset Flex Code
21186 \begin_layout Plain Layout
21195 \begin_layout Description
21196 \begin_inset Flex Code
21199 \begin_layout Plain Layout
21206 \begin_inset Flex Code
21209 \begin_layout Plain Layout
21216 \begin_inset Flex Code
21219 \begin_layout Plain Layout
21226 \begin_inset Flex Code
21229 \begin_layout Plain Layout
21236 \begin_inset Flex Code
21239 \begin_layout Plain Layout
21245 (indicating a dummy definition ending definitions of charstyles, etc).
21246 This entry is required in and is only meaningful for Flex insets.
21247 Among other things, it determines on which menu this inset will appear.
21249 \begin_inset Flex Code
21252 \begin_layout Plain Layout
21259 \begin_inset Flex Code
21262 \begin_layout Plain Layout
21268 will automatically set
21269 \begin_inset Flex Code
21272 \begin_layout Plain Layout
21279 \begin_inset Flex Code
21282 \begin_layout Plain Layout
21290 \begin_inset Flex Code
21293 \begin_layout Plain Layout
21299 can be set to true, or
21300 \begin_inset Flex Code
21303 \begin_layout Plain Layout
21310 \begin_inset Flex Code
21313 \begin_layout Plain Layout
21319 insets by setting it
21324 \begin_inset Flex Code
21327 \begin_layout Plain Layout
21334 \change_inserted -712698321 1555575738
21338 \begin_layout Description
21340 \change_inserted -712698321 1555575844
21341 \begin_inset Flex Code
21344 \begin_layout Plain Layout
21346 \change_inserted -712698321 1555575740
21355 \begin_inset Flex Code
21358 \begin_layout Plain Layout
21360 \change_inserted -712698321 1555575740
21368 A dedicated string for the menu.
21369 You can define an accelerator by appending the respective character to
21370 the string, divided by
21371 \begin_inset Quotes eld
21375 \begin_inset Quotes erd
21379 \begin_inset space \thinspace{}
21383 \begin_inset space \space{}
21387 \begin_inset Quotes eld
21391 \begin_inset Flex Code
21394 \begin_layout Plain Layout
21396 \change_inserted -712698321 1555575781
21405 \begin_inset Quotes erd
21409 This specification is optional.
21410 If it is not given the inset name as specified in the type declaration
21411 will be used instead for the menu.
21416 \begin_layout Description
21417 \begin_inset Flex Code
21420 \begin_layout Plain Layout
21427 \begin_inset Flex Code
21430 \begin_layout Plain Layout
21439 \begin_inset space \thinspace{}
21443 \begin_inset Flex Code
21446 \begin_layout Plain Layout
21452 ] Whether multiple paragraphs are permitted in this inset.
21454 \begin_inset Flex Code
21457 \begin_layout Plain Layout
21463 to the same value and
21464 \begin_inset Flex Code
21467 \begin_layout Plain Layout
21473 to the opposite value.
21474 These can be reset to other values, if they are used
21479 \begin_inset Flex Code
21482 \begin_layout Plain Layout
21492 \begin_layout Description
21493 \begin_inset Flex Code
21496 \begin_layout Plain Layout
21503 \begin_inset Flex Code
21506 \begin_layout Plain Layout
21515 \begin_inset space \thinspace{}
21519 \begin_inset Flex Code
21522 \begin_layout Plain Layout
21528 ] Whether fragile commands in this inset should be
21529 \begin_inset Flex Code
21532 \begin_layout Plain Layout
21545 whether the command should itself be protected.) Default is false.
21546 \change_inserted -712698321 1523633958
21550 \begin_layout Description
21552 \change_inserted -712698321 1552395786
21553 \begin_inset Flex Code
21556 \begin_layout Plain Layout
21558 \change_inserted -712698321 1523633961
21567 \begin_inset Flex Code
21570 \begin_layout Plain Layout
21572 \change_inserted -712698321 1523633958
21583 \begin_inset space \thinspace{}
21587 \begin_inset Flex Code
21590 \begin_layout Plain Layout
21592 \change_inserted -712698321 1523633958
21600 ] This causes macros that contain this inset to be protected with
21601 \begin_inset Flex Code
21604 \begin_layout Plain Layout
21606 \change_inserted -712698321 1523634038
21621 ) if necessary and thus allows (some) verbatim stuff in macros.
21625 \begin_layout Description
21627 \change_inserted -712698321 1555579651
21628 \begin_inset Flex Code
21631 \begin_layout Plain Layout
21633 \change_inserted -712698321 1552395787
21642 \begin_inset Flex Code
21645 \begin_layout Plain Layout
21647 \change_inserted -712698321 1552395787
21658 \begin_inset space \thinspace{}
21662 \begin_inset Flex Code
21665 \begin_layout Plain Layout
21667 \change_inserted -712698321 1552395787
21675 ] Whether specific commands in this inset (such as
21676 \begin_inset Flex Code
21679 \begin_layout Plain Layout
21681 \change_inserted -712698321 1552395787
21692 \begin_inset Flex Code
21695 \begin_layout Plain Layout
21697 \change_inserted -712698321 1552395787
21707 ) should be protected in an
21708 \begin_inset Flex Code
21711 \begin_layout Plain Layout
21713 \change_inserted -712698321 1552395787
21724 This is particularly needed for insets that draw on
21732 commands which parse their content in complex ways.
21736 \begin_layout Description
21738 \change_inserted -712698321 1555579742
21739 \begin_inset Flex Code
21742 \begin_layout Plain Layout
21744 \change_inserted -712698321 1555579658
21753 \begin_inset Flex Code
21756 \begin_layout Plain Layout
21758 \change_inserted -712698321 1555579651
21766 Option to define a different command (from the default
21767 \begin_inset Flex Code
21770 \begin_layout Plain Layout
21772 \change_inserted -712698321 1555579742
21784 ) to be used for line breaks.
21785 The initial backslash must not be specified.
21790 \begin_layout Description
21791 \begin_inset Flex Code
21794 \begin_layout Plain Layout
21801 \begin_inset Flex Code
21804 \begin_layout Plain Layout
21810 ] Deletes an existing
21811 \begin_inset Flex Code
21814 \begin_layout Plain Layout
21823 \begin_layout Description
21824 \begin_inset Flex Code
21827 \begin_layout Plain Layout
21834 \begin_inset Flex Code
21837 \begin_layout Plain Layout
21844 \begin_inset Flex Code
21847 \begin_layout Plain Layout
21853 that has replaced this
21854 \begin_inset Flex Code
21857 \begin_layout Plain Layout
21864 This is used to rename an
21865 \begin_inset Flex Code
21868 \begin_layout Plain Layout
21874 , while keeping backward compatibility.
21875 \change_inserted -712698321 1559491850
21879 \begin_layout Description
21881 \change_inserted -712698321 1559492002
21882 \begin_inset Flex Code
21885 \begin_layout Plain Layout
21887 \change_inserted -712698321 1559491854
21896 \begin_inset Flex Code
21899 \begin_layout Plain Layout
21901 \change_inserted -712698321 1559491850
21912 \begin_inset space \thinspace{}
21916 \begin_inset Flex Code
21919 \begin_layout Plain Layout
21921 \change_inserted -712698321 1559491850
21929 ] If this is set to
21930 \begin_inset Flex Code
21933 \begin_layout Plain Layout
21935 \change_inserted -712698321 1559491881
21943 , paragraph breaks will be ignored in the output.
21944 This might be useful for insets where the content should be alignable on
21945 different lines only in the \SpecialChar LyX
21946 workarea, without any effect in the output.
21951 \begin_layout Description
21952 \begin_inset Flex Code
21955 \begin_layout Plain Layout
21962 \begin_inset Flex Code
21965 \begin_layout Plain Layout
21974 \begin_inset space \thinspace{}
21978 \begin_inset Flex Code
21981 \begin_layout Plain Layout
21987 ] As with paragraph styles, see
21988 \begin_inset CommandInset ref
21990 reference "subsec:Paragraph-Styles"
21998 \begin_layout Description
21999 \begin_inset Flex Code
22002 \begin_layout Plain Layout
22009 \begin_inset Flex Code
22012 \begin_layout Plain Layout
22021 \begin_inset space \thinspace{}
22025 \begin_inset Flex Code
22028 \begin_layout Plain Layout
22034 ] As with paragraph styles, see
22035 \begin_inset CommandInset ref
22037 reference "subsec:Paragraph-Styles"
22045 \begin_layout Description
22046 \begin_inset Flex Code
22049 \begin_layout Plain Layout
22055 As with paragraph styles, see
22056 \begin_inset CommandInset ref
22058 reference "subsec:Paragraph-Styles"
22065 \begin_layout Description
22066 \begin_inset Flex Code
22069 \begin_layout Plain Layout
22076 \begin_inset Flex Code
22079 \begin_layout Plain Layout
22085 ] The prefix to use when creating labels referring to insets of this type.
22086 This allows the use of formatted references.
22089 \begin_layout Description
22090 \begin_inset Flex Code
22093 \begin_layout Plain Layout
22100 \begin_inset Flex Code
22103 \begin_layout Plain Layout
22109 ] As with paragraph styles, see
22110 \begin_inset CommandInset ref
22112 reference "subsec:Paragraph-Styles"
22119 \begin_layout Description
22120 \begin_inset Flex Code
22123 \begin_layout Plain Layout
22130 \begin_inset Flex Code
22133 \begin_layout Plain Layout
22142 \begin_inset space \thinspace{}
22146 \begin_inset Flex Code
22149 \begin_layout Plain Layout
22155 ] Resets the \SpecialChar LaTeX
22156 arguments of this layout (as defined via the
22157 \begin_inset Flex Code
22160 \begin_layout Plain Layout
22167 This is useful if you have copied a style via
22168 \begin_inset Flex Code
22171 \begin_layout Plain Layout
22177 , but you do not want to inherit its (required and optional) arguments.
22180 \begin_layout Description
22181 \begin_inset Flex Code
22184 \begin_layout Plain Layout
22191 \begin_inset Flex Code
22194 \begin_layout Plain Layout
22203 \begin_inset space \thinspace{}
22207 \begin_inset Flex Code
22210 \begin_layout Plain Layout
22217 \change_inserted -712698321 1597733473
22219 \begin_inset Flex Code
22222 \begin_layout Plain Layout
22224 \change_inserted -712698321 1597732178
22232 , font changes are redone inside the respective inset (in the output) even
22233 if the inset itself is in the context of this font changes (e.
22234 \begin_inset space \thinspace{}
22238 \begin_inset Flex Code
22241 \begin_layout Plain Layout
22243 \change_inserted -712698321 1597733683
22246 textbf{Sourrounding text
22250 textbf{content}}\SpecialChar ldots
22259 \begin_inset Flex Code
22262 \begin_layout Plain Layout
22264 \change_inserted -712698321 1597733686
22267 textbf{Sourrounding text
22269 myinset{content}\SpecialChar ldots
22278 Setting this makes sense for commands that internally reset font settings
22280 \begin_inset space \thinspace{}
22284 Note that wrongly setting this might lead to unwanted result (e.
22285 \begin_inset space \thinspace{}
22289 \begin_inset Flex Code
22292 \begin_layout Plain Layout
22294 \change_inserted -712698321 1597733688
22297 emph{Sourrounding text
22301 emph{content}}\SpecialChar ldots
22309 , content is upright, as
22310 \begin_inset Flex Code
22313 \begin_layout Plain Layout
22315 \change_inserted -712698321 1597733278
22327 \change_deleted -712698321 1597733283
22328 Whether this inset should use the font of its surrounding environment or
22333 \change_deleted -712698321 1597733290
22335 \change_inserted -712698321 1597733290
22337 \begin_inset Flex Code
22340 \begin_layout Plain Layout
22342 \change_inserted -712698321 1597733292
22353 \change_deleted -712698321 1597733327
22354 use the font of the surrounding environment
22355 \change_inserted -712698321 1597733343
22356 font changes are not redone inside the inset
22361 \begin_layout Description
22362 \begin_inset Flex Code
22365 \begin_layout Plain Layout
22372 \begin_inset Flex Code
22375 \begin_layout Plain Layout
22381 ] A string that is put at the end of the layout content.
22382 A line break in the output can be indicated by
22383 \begin_inset Flex Code
22386 \begin_layout Plain Layout
22395 \begin_layout Description
22396 \begin_inset Flex Code
22399 \begin_layout Plain Layout
22406 \begin_inset Flex Code
22409 \begin_layout Plain Layout
22416 \begin_inset space \thinspace{}
22420 \begin_inset Flex Code
22423 \begin_layout Plain Layout
22431 ] Allow spell-checking the contents of this inset.
22435 \begin_layout Subsection
22437 \begin_inset CommandInset label
22439 name "subsec:Counters"
22446 \begin_layout Standard
22447 It is necessary to define the counters (
22448 \begin_inset Flex Noun
22451 \begin_layout Plain Layout
22458 \begin_inset Flex Noun
22461 \begin_layout Plain Layout
22467 , \SpecialChar ldots
22468 ) in the text class itself.
22469 The standard counters are defined in the file
22470 \begin_inset Flex Code
22473 \begin_layout Plain Layout
22479 , so you may have to do no more than add
22482 \begin_layout LyX-Code
22483 Input stdcounters.inc
22486 \begin_layout Standard
22487 to your layout file to get them to work.
22488 But if you want to define custom counters, then you can do so.
22489 The counter declaration must begin with:
22492 \begin_layout LyX-Code
22493 Counter CounterName
22496 \begin_layout Standard
22498 \begin_inset Flex Code
22501 \begin_layout Plain Layout
22507 ' is replaced by the name of the counter.
22508 And it must end with
22509 \begin_inset Quotes eld
22513 \begin_inset Flex Code
22516 \begin_layout Plain Layout
22523 \begin_inset Quotes erd
22527 The following parameters can also be used:
22530 \begin_layout Description
22531 \begin_inset Flex Code
22534 \begin_layout Plain Layout
22541 \begin_inset Flex Code
22544 \begin_layout Plain Layout
22550 ] Sets the initial value for the counter, to which it will be reset whenever
22552 Normally, one will want the default, 1.
22555 \begin_layout Description
22556 \begin_inset Flex Code
22559 \begin_layout Plain Layout
22566 \begin_inset Flex Code
22569 \begin_layout Plain Layout
22576 \begin_inset Quotes erd
22580 \begin_inset Quotes erd
22583 ] When defined, this string defines how the counter is displayed.
22584 Setting this value sets
22585 \begin_inset Flex Code
22588 \begin_layout Plain Layout
22589 LabelStringAppendix
22595 The following special constructs can be used in the string:
22599 \begin_layout Itemize
22600 \begin_inset Flex Code
22603 \begin_layout Plain Layout
22611 will be replaced by the expansion of the
22612 \begin_inset Flex Code
22615 \begin_layout Plain Layout
22622 \begin_inset Flex Code
22625 \begin_layout Plain Layout
22626 LabelStringAppendix
22632 \begin_inset Flex Code
22635 \begin_layout Plain Layout
22645 \begin_layout Itemize
22646 counter values can be expressed using \SpecialChar LaTeX
22648 \begin_inset Newline newline
22652 \begin_inset Flex Code
22655 \begin_layout Plain Layout
22672 \begin_inset Flex Code
22675 \begin_layout Plain Layout
22687 \begin_layout Plain Layout
22697 Actually, the situation is a bit more complicated: any
22716 other than those described below will produce arabic numerals.
22717 It would not be surprising to see this change in the future.
22723 \begin_inset Flex Code
22726 \begin_layout Plain Layout
22732 : 1, 2, 3,\SpecialChar ldots
22734 \begin_inset Flex Code
22737 \begin_layout Plain Layout
22743 for lower-case letters: a, b, c, \SpecialChar ldots
22745 \begin_inset Flex Code
22748 \begin_layout Plain Layout
22754 for upper-case letters: A, B, C, \SpecialChar ldots
22756 \begin_inset Flex Code
22759 \begin_layout Plain Layout
22765 for lower-case roman numerals: i, ii, iii, \SpecialChar ldots
22767 \begin_inset Flex Code
22770 \begin_layout Plain Layout
22776 for upper-case roman numerals: I, II, III\SpecialChar ldots
22778 \begin_inset Flex Code
22781 \begin_layout Plain Layout
22787 for hebrew numerals.
22791 \begin_layout Standard
22792 If LabelString is not defined, a default value is constructed as follows:
22793 if the counter has a
22794 \change_deleted 731793113 1604355218
22796 \change_inserted 731793113 1604355221
22800 \begin_inset Flex Code
22803 \begin_layout Plain Layout
22805 \change_deleted 731793113 1604355223
22807 \change_inserted 731793113 1604355226
22816 \begin_inset Flex Code
22819 \begin_layout Plain Layout
22826 \begin_inset Newline newline
22830 \begin_inset Flex Code
22833 \begin_layout Plain Layout
22837 \change_inserted 731793113 1604355228
22839 \change_deleted 731793113 1604355230
22849 is used; otherwise the string
22850 \begin_inset Flex Code
22853 \begin_layout Plain Layout
22864 \begin_layout Description
22865 \begin_inset Flex Code
22868 \begin_layout Plain Layout
22869 LabelStringAppendix
22875 \begin_inset Flex Code
22878 \begin_layout Plain Layout
22885 \begin_inset Quotes eld
22889 \begin_inset Quotes erd
22893 \begin_inset Flex Code
22896 \begin_layout Plain Layout
22902 , but for use in the Appendix.
22903 \change_inserted -584632292 1607202551
22907 \begin_layout Description
22909 \change_inserted -584632292 1607202682
22910 \begin_inset Flex Code
22913 \begin_layout Plain Layout
22920 \begin_inset Flex Code
22923 \begin_layout Plain Layout
22925 \change_inserted -584632292 1607202576
22934 \begin_inset Quotes eld
22938 \begin_inset Quotes erd
22941 ] The counter name as used in \SpecialChar LaTeX
22943 (E.g., in \SpecialChar LyX
22944 , there is a counter named `theorem', but it is output to \SpecialChar LaTeX
22950 \begin_layout Description
22951 \begin_inset Flex Code
22954 \begin_layout Plain Layout
22961 \begin_inset Flex Code
22964 \begin_layout Plain Layout
22971 \begin_inset Quotes erd
22975 \begin_inset Quotes erd
22978 ] A format for use with formatted references to this counter.
22979 For example, one might want to have references to section numbers appear
22981 \begin_inset Quotes eld
22985 \begin_inset Quotes erd
22989 The string should contain
22990 \begin_inset Quotes eld
22994 \begin_inset Quotes erd
22998 This will be replaced by the counter number itself.
22999 So, for sections, it would be: Section ##.
23002 \begin_layout Description
23003 \begin_inset Flex Code
23006 \begin_layout Plain Layout
23013 \begin_inset Flex Code
23016 \begin_layout Plain Layout
23023 \begin_inset Quotes erd
23027 \begin_inset Quotes erd
23030 ] If this is set to the name of another counter, the present counter will
23031 be reset every time the other one is increased.
23033 \begin_inset Flex Code
23036 \begin_layout Plain Layout
23043 \begin_inset Flex Code
23046 \begin_layout Plain Layout
23055 \begin_layout Subsection
23057 \begin_inset CommandInset label
23059 name "subsec:Font-description"
23066 \begin_layout Standard
23067 A font description looks like this:
23070 \begin_layout LyX-Code
23087 \begin_layout LyX-Code
23091 \begin_layout LyX-Code
23095 \begin_layout Standard
23096 The following commands are available:
23099 \begin_layout Description
23100 \begin_inset Flex Code
23103 \begin_layout Plain Layout
23110 \change_deleted -712698321 1607682984
23112 \begin_inset Flex Code
23115 \begin_layout Plain Layout
23124 \begin_inset Flex Code
23127 \begin_layout Plain Layout
23134 \begin_inset Flex Code
23137 \begin_layout Plain Layout
23144 \begin_inset Flex Code
23147 \begin_layout Plain Layout
23154 \begin_inset Flex Code
23157 \begin_layout Plain Layout
23164 \begin_inset Flex Code
23167 \begin_layout Plain Layout
23174 \begin_inset Flex Code
23177 \begin_layout Plain Layout
23184 \begin_inset Flex Code
23187 \begin_layout Plain Layout
23194 \begin_inset Flex Code
23197 \begin_layout Plain Layout
23204 \begin_inset Flex Code
23207 \begin_layout Plain Layout
23214 \begin_inset Flex Code
23217 \begin_layout Plain Layout
23224 \begin_inset Flex Code
23227 \begin_layout Plain Layout
23234 \begin_inset Flex Code
23237 \begin_layout Plain Layout
23244 \begin_inset Flex Code
23247 \begin_layout Plain Layout
23254 \begin_inset Flex Code
23257 \begin_layout Plain Layout
23264 \begin_inset Flex Code
23267 \begin_layout Plain Layout
23274 \begin_inset Flex Code
23277 \begin_layout Plain Layout
23284 \begin_inset Flex Code
23287 \begin_layout Plain Layout
23294 \begin_inset Flex Code
23297 \begin_layout Plain Layout
23304 \begin_inset Flex Code
23307 \begin_layout Plain Layout
23314 \change_inserted -712698321 1607683139
23316 \begin_inset Flex Code
23319 \begin_layout Plain Layout
23321 \change_inserted -712698321 1607683135
23330 \begin_inset space ~
23334 \begin_inset CommandInset ref
23336 reference "chap:Names-of-colors"
23344 \change_deleted -712698321 1607683144
23346 \change_inserted -712698321 1607683146
23352 \begin_layout Description
23353 \begin_inset Flex Code
23356 \begin_layout Plain Layout
23363 \begin_inset Flex Code
23366 \begin_layout Plain Layout
23375 \begin_inset Flex Code
23378 \begin_layout Plain Layout
23385 \begin_inset Flex Code
23388 \begin_layout Plain Layout
23397 \begin_layout Description
23398 \begin_inset Flex Code
23401 \begin_layout Plain Layout
23408 \begin_inset Flex Code
23411 \begin_layout Plain Layout
23417 ] Valid arguments are:
23418 \begin_inset Flex Code
23421 \begin_layout Plain Layout
23428 \begin_inset Flex Code
23431 \begin_layout Plain Layout
23438 \begin_inset Flex Code
23441 \begin_layout Plain Layout
23448 \begin_inset Flex Code
23451 \begin_layout Plain Layout
23458 \begin_inset Flex Code
23461 \begin_layout Plain Layout
23468 \begin_inset Flex Code
23471 \begin_layout Plain Layout
23478 \begin_inset Flex Code
23481 \begin_layout Plain Layout
23488 \begin_inset Flex Code
23491 \begin_layout Plain Layout
23498 \begin_inset Flex Code
23501 \begin_layout Plain Layout
23508 \begin_inset Flex Code
23511 \begin_layout Plain Layout
23518 \begin_inset Flex Code
23521 \begin_layout Plain Layout
23528 \begin_inset Flex Code
23531 \begin_layout Plain Layout
23538 Each of these turns on or off the corresponding attribute.
23540 \begin_inset Flex Code
23543 \begin_layout Plain Layout
23549 turns on emphasis, and
23550 \begin_inset Flex Code
23553 \begin_layout Plain Layout
23561 \begin_inset Newline newline
23564 If the latter seems puzzling, remember that the font settings for the present
23565 context are generally inherited from the surrounding context.
23567 \begin_inset Flex Code
23570 \begin_layout Plain Layout
23576 would turn off the emphasis that was anyway in effect, say, in a theorem
23580 \begin_layout Description
23581 \begin_inset Flex Code
23584 \begin_layout Plain Layout
23591 \begin_inset Flex Code
23594 \begin_layout Plain Layout
23603 \begin_inset Flex Code
23606 \begin_layout Plain Layout
23615 \begin_layout Description
23616 \begin_inset Flex Code
23619 \begin_layout Plain Layout
23626 \begin_inset Flex Code
23629 \begin_layout Plain Layout
23638 \begin_inset Flex Code
23641 \begin_layout Plain Layout
23648 \begin_inset Flex Code
23651 \begin_layout Plain Layout
23658 \begin_inset Flex Code
23661 \begin_layout Plain Layout
23670 \begin_layout Description
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
23713 \begin_inset Flex Code
23716 \begin_layout Plain Layout
23723 \begin_inset Flex Code
23726 \begin_layout Plain Layout
23733 \begin_inset Flex Code
23736 \begin_layout Plain Layout
23743 \begin_inset Flex Code
23746 \begin_layout Plain Layout
23753 \begin_inset Flex Code
23756 \begin_layout Plain Layout
23765 \begin_layout Subsection
23766 \begin_inset CommandInset label
23768 name "subsec:Citation-engine-description"
23772 Cite engine description
23775 \begin_layout Standard
23777 \begin_inset Flex Code
23780 \begin_layout Plain Layout
23786 blocks, as used mainly in cite engine files (see
23787 \begin_inset CommandInset ref
23789 reference "subsec:Cite-Engine-Files"
23796 ), define the citation commands provided by a specific
23797 \begin_inset Quotes eld
23801 \begin_inset Quotes erd
23805 A cite engine, in \SpecialChar LyX
23806 terms, is way specific way to format citations, using
23807 numbers, author names and/or years.
23808 Currently, \SpecialChar LyX
23809 supports three such engine types, namely:
23812 \begin_layout Enumerate
23813 \begin_inset Flex Code
23816 \begin_layout Plain Layout
23822 : the default Bib\SpecialChar TeX
23823 way to format citations, a simple numeric style (e.
23824 \begin_inset space \thinspace{}
23828 \begin_inset Quotes eld
23832 \begin_inset Quotes erd
23838 \begin_layout Enumerate
23839 \begin_inset Flex Code
23842 \begin_layout Plain Layout
23848 : Harvard-styled citations using author names and publication year (e.
23849 \begin_inset space \thinspace{}
23853 \begin_inset Quotes eld
23856 Smith and Miller (2017b)
23857 \begin_inset Quotes erd
23863 \begin_layout Enumerate
23864 \begin_inset Flex Code
23867 \begin_layout Plain Layout
23873 : extended numerical citations that also allow for author or title next
23875 \begin_inset space \thinspace{}
23879 \begin_inset Quotes eld
23882 Smith and Miller [1]
23883 \begin_inset Quotes erd
23889 \begin_layout Standard
23890 \begin_inset Flex Code
23893 \begin_layout Plain Layout
23899 blocks look like this:
23902 \begin_layout LyX-Code
23906 \begin_layout LyX-Code
23910 \begin_layout LyX-Code
23914 \begin_layout LyX-Code
23915 citeyearpar[][]=parencite*
23918 \begin_layout LyX-Code
23922 \begin_layout LyX-Code
23926 \begin_layout Standard
23928 \begin_inset Flex Code
23931 \begin_layout Plain Layout
23937 denotes the engine.
23938 The individual lines respectively define a cite command or cite command
23939 paradigm supported by this engine.
23940 The line can be as simple as a cite command that is used both to name the
23941 respective \SpecialChar LyX
23942 command and the \SpecialChar LaTeX
23943 output or more complex in order to differentiate
23945 The full syntax is:
23948 \begin_layout LyX-Code
23949 LyXName|alias$*<!_stardesc!_stardesctooltip>[][]=latexcmd
23952 \begin_layout Itemize
23953 \begin_inset Flex Code
23956 \begin_layout Plain Layout
23962 : The name as used in the
23963 \begin_inset Flex Code
23966 \begin_layout Plain Layout
23976 \begin_layout Standard
23977 For portability reasons, we try to use the same name for same-formatted
23978 commands in different cite packages (thus many names stem from natbib,
23979 and thus we need to differentiate a
23980 \begin_inset Flex Code
23983 \begin_layout Plain Layout
23989 sometimes, if the \SpecialChar LaTeX
23990 command names differ).
23994 \begin_layout Itemize
23995 \begin_inset Flex Code
23998 \begin_layout Plain Layout
24004 : a (comma-separated) list of commands that fall back to the given
24005 \begin_inset Flex Code
24008 \begin_layout Plain Layout
24014 in the current engine.
24015 This eases the switch of citation packages and engines.
24017 \begin_inset Flex Code
24020 \begin_layout Plain Layout
24027 \begin_inset Flex Code
24030 \begin_layout Plain Layout
24036 in layout definitions.
24039 \begin_layout Itemize
24040 \begin_inset Flex Code
24043 \begin_layout Plain Layout
24049 : The actual \SpecialChar LaTeX
24050 command that is output.
24054 \begin_layout Standard
24055 \begin_inset Flex Code
24058 \begin_layout Plain Layout
24065 \begin_inset Flex Code
24068 \begin_layout Plain Layout
24076 \begin_inset Flex Code
24079 \begin_layout Plain Layout
24086 \begin_inset Flex Code
24089 \begin_layout Plain Layout
24095 will be output to \SpecialChar LaTeX
24099 \begin_layout Standard
24103 \begin_layout Itemize
24104 Capitalization indicates that the command also has a capitalized form (
24105 \begin_inset Flex Code
24108 \begin_layout Plain Layout
24118 \begin_inset Flex Code
24121 \begin_layout Plain Layout
24130 These usually enforce up-casing of name prefixes (
24135 \begin_inset Formula $\Rightarrow$
24145 \begin_layout Itemize
24147 \begin_inset Flex Code
24150 \begin_layout Plain Layout
24156 indicate the number of optional arguments (there can be 0–2).
24159 \begin_layout Itemize
24161 \begin_inset Flex Code
24164 \begin_layout Plain Layout
24170 indicates there is a starred version of the command (
24171 \begin_inset Flex Code
24174 \begin_layout Plain Layout
24184 \begin_inset Flex Code
24187 \begin_layout Plain Layout
24200 \begin_layout Standard
24201 By default, the starred version means: Output all authors even if it should
24203 \begin_inset Quotes eld
24207 \begin_inset Quotes erd
24211 \begin_inset Flex Code
24214 \begin_layout Plain Layout
24223 \begin_layout Standard
24224 If the star has a different meaning for a given command, it can be specified
24226 \begin_inset Flex Code
24229 \begin_layout Plain Layout
24230 <!_stardesc!_stardesctooltip>
24236 Maximal two translatable macro keywords, marked by the prefix
24237 \begin_inset Flex Code
24240 \begin_layout Plain Layout
24247 The first points to the string that replaces the
24248 \begin_inset Quotes eld
24252 \begin_inset Quotes erd
24255 checkbox label in the citation dialog, the second one to an optional tool
24256 tip for this checkbox.
24260 \begin_layout Standard
24261 Note that these two macros have to be defined in a
24262 \begin_inset Flex Code
24265 \begin_layout Plain Layout
24271 (see next section), dropping the
24272 \begin_inset Flex Code
24275 \begin_layout Plain Layout
24281 from the prefix, like this:
24284 \begin_layout LyX-Code
24285 _stardesc Sta&rred command label
24288 \begin_layout LyX-Code
24289 _stardesctooltip Tooltip for the starred command checkbox.
24293 \begin_layout Itemize
24295 \begin_inset Flex Code
24298 \begin_layout Plain Layout
24304 indicates that this command features
24305 \begin_inset Quotes eld
24308 qualified citation lists
24309 \begin_inset Quotes erd
24317 -specific feature for multi-reference citations where an individual pre-
24318 and postnote can be given to each reference in the list.
24319 Please refer to the
24323 manual for details.
24324 \change_inserted -712698321 1526898670
24328 \begin_layout Standard
24330 \change_inserted -712698321 1526899524
24331 If you want to add a cite command to a cite engine (e.
24332 \begin_inset space \thinspace{}
24335 g., add a specific command provided by a class), you can use
24336 \begin_inset Flex Code
24339 \begin_layout Plain Layout
24341 \change_inserted -712698321 1526898768
24342 AddToCiteEngine <engine type> \SpecialChar ldots
24351 Note that only cite commands that do not exist yet are added.
24356 \begin_layout Subsection
24357 \begin_inset CommandInset label
24359 name "subsec:Citation-format-description"
24363 Cite format description
24366 \begin_layout Standard
24368 \begin_inset Flex Code
24371 \begin_layout Plain Layout
24377 blocks are used to describe how bibliographic information should be displayed,
24378 both within \SpecialChar LyX
24379 itself (in the citation dialog and in tooltips, for example)
24380 and in XHTML output.
24381 Such a block might look like this:
24384 \begin_layout LyX-Code
24388 \begin_layout LyX-Code
24392 \begin_layout LyX-Code
24396 \begin_layout LyX-Code
24400 \begin_layout Standard
24404 \begin_layout LyX-Code
24408 \begin_layout LyX-Code
24412 \begin_layout LyX-Code
24416 \begin_layout LyX-Code
24420 \begin_layout Standard
24421 In the first case, the individual lines define how the bibliographic information
24422 associated with an article or book, respectively, is to be displayed, and
24423 such a definition can be given for any
24424 \begin_inset Quotes els
24428 \begin_inset Quotes ers
24431 that might be present in a Bib\SpecialChar TeX
24434 defines a default format in the source code that will be used if no specific
24435 definition has been given.
24437 predefines several formats in the file
24438 \begin_inset Flex Code
24441 \begin_layout Plain Layout
24447 , which is included in most of \SpecialChar LyX
24448 's document classes.
24451 \begin_layout Standard
24452 In the second case, the lines define how a specific citation command (in
24454 \begin_inset Flex Code
24457 \begin_layout Plain Layout
24466 \begin_inset Flex Code
24469 \begin_layout Plain Layout
24477 ) is to be displayed on the citation inset label, in the citation dialog,
24478 menu or XHTML output.
24480 defines such formats for the citation style variants it supports via
24482 Document\SpecialChar menuseparator
24483 Setting\SpecialChar menuseparator
24484 Bibliography\SpecialChar ldots
24488 \begin_inset Flex Code
24491 \begin_layout Plain Layout
24497 files that are shipped with \SpecialChar LyX
24499 \begin_inset CommandInset ref
24501 reference "subsec:Cite-Engine-Files"
24511 \begin_layout Standard
24512 The definitions use a simple language that allows Bib\SpecialChar TeX
24513 keys to be replaced
24515 Keys should be enclosed in
24516 \begin_inset Flex Code
24519 \begin_layout Plain Layout
24526 \begin_inset Flex Code
24529 \begin_layout Plain Layout
24536 So a simple definition might look like this:
24539 \begin_layout LyX-Code
24541 \begin_inset Quotes eld
24545 \begin_inset Quotes erd
24551 \begin_layout Standard
24552 This would print the author, followed by a comma, followed by the title,
24553 in quotes, followed by a period.
24556 \begin_layout Standard
24557 Of course, sometimes you may want to print a key only if it exists.
24558 This can be done by using a conditional construction, such as:
24559 \begin_inset Flex Code
24562 \begin_layout Plain Layout
24564 \begin_inset space ~
24574 \begin_inset Flex Code
24577 \begin_layout Plain Layout
24583 key exists, then print
24584 \begin_inset Quotes eld
24588 \begin_inset space ~
24592 \begin_inset Quotes erd
24595 followed by the volume key.
24596 It is also possible to have an else clause in the conditional, such as:
24597 \begin_inset Newline newline
24601 \begin_inset Flex Code
24604 \begin_layout Plain Layout
24605 {%author%[[%author%]][[%editor%, ed.]]}
24611 \begin_inset Newline newline
24615 \begin_inset Flex Code
24618 \begin_layout Plain Layout
24624 key is printed if it exists; otherwise, the editor key is printed, followed
24626 \begin_inset Quotes eld
24630 \begin_inset space ~
24634 \begin_inset Quotes erd
24637 Note that the key is again enclosed in
24638 \begin_inset Flex Code
24641 \begin_layout Plain Layout
24647 signs; the entire conditional is enclosed in braces; and the if and else
24648 clauses are enclosed in double brackets,
24649 \begin_inset Quotes eld
24653 \begin_inset Flex Code
24656 \begin_layout Plain Layout
24663 \begin_inset Quotes eld
24667 \begin_inset Quotes eld
24671 \begin_inset Flex Code
24674 \begin_layout Plain Layout
24681 \begin_inset Quotes erd
24685 There must be no space between any of these.
24688 \begin_layout Standard
24689 Next to the entry keys, there are some special keys that can be used for
24690 these conditionals:
24693 \begin_layout Itemize
24694 \begin_inset Flex Code
24697 \begin_layout Plain Layout
24698 {%dialog%[[true]][[false]]}
24704 \begin_inset Quotes eld
24708 \begin_inset Quotes erd
24711 part for dialogs and menus, the
24712 \begin_inset Quotes eld
24716 \begin_inset Quotes erd
24719 part for other contexts (workarea, export)
24722 \begin_layout Itemize
24723 \begin_inset Flex Code
24726 \begin_layout Plain Layout
24727 {%export%[[true]][[false]]}
24733 \begin_inset Quotes eld
24737 \begin_inset Quotes erd
24740 part for export and menus, the
24741 \begin_inset Quotes eld
24745 \begin_inset Quotes erd
24748 part for other contexts (workarea, dialog)
24751 \begin_layout Itemize
24752 \begin_inset Flex Code
24755 \begin_layout Plain Layout
24762 \begin_inset Quotes eld
24766 \begin_inset Quotes erd
24769 part if another item follows (e.
24770 \begin_inset space \thinspace{}
24773 g., in a citation with multiple keys)
24776 \begin_layout Itemize
24777 \begin_inset Flex Code
24780 \begin_layout Plain Layout
24781 {%second%[[true]][[false]]}
24787 \begin_inset Quotes eld
24791 \begin_inset Quotes erd
24794 if this is the second of multiple items, else the
24795 \begin_inset Quotes eld
24799 \begin_inset Quotes erd
24805 \begin_layout Itemize
24806 \begin_inset Flex Code
24809 \begin_layout Plain Layout
24810 {%ifstar%[[true]][[false]]}
24816 \begin_inset Quotes eld
24820 \begin_inset Quotes erd
24823 part for starred citation commands (such as
24824 \begin_inset Flex Code
24827 \begin_layout Plain Layout
24835 ), the false part for unstarred
24838 \begin_layout Itemize
24839 \begin_inset Flex Code
24842 \begin_layout Plain Layout
24843 {%ifentrytype:<type>%[[true]][[false]]}
24849 \begin_inset Quotes eld
24853 \begin_inset Quotes erd
24856 if the current entry type matches
24857 \begin_inset Flex Code
24860 \begin_layout Plain Layout
24866 , else the false part (e.g., in a citation definition:
24867 \begin_inset Flex Code
24870 \begin_layout Plain Layout
24871 {%ifentrytype:book%[[this is a book]][[this is no book]]}
24879 \begin_layout Itemize
24880 \begin_inset Flex Code
24883 \begin_layout Plain Layout
24884 {%ifmultiple:<authortype>%[[true]][[false]]}
24890 \begin_inset Quotes eld
24894 \begin_inset Quotes erd
24897 if the current author type (author, editor etc.) has multiple authors, else
24898 the false part (e.g., in a bibliography definition:
24899 \begin_inset Flex Code
24902 \begin_layout Plain Layout
24903 {%ifmultiple:editor%[[eds.]][[ed.]]}
24911 \begin_layout Itemize
24912 \begin_inset Flex Code
24915 \begin_layout Plain Layout
24916 {%ifqualified%[[true]][[false]]}
24922 \begin_inset Quotes eld
24926 \begin_inset Quotes erd
24929 part if the current citation is a qualified citation list (a specific
24933 format for multi-reference citations), the false part if this is not the
24937 \begin_layout Standard
24939 \begin_inset Flex Code
24942 \begin_layout Plain Layout
24948 prints the author key as it is recorded in the bibliography file.
24949 This might not be what you want, since it will result in a string such
24951 \begin_inset Quotes eld
24954 Miller, Peter and Smith, Mary and White, Jane
24955 \begin_inset Quotes erd
24959 \begin_inset Quotes eld
24963 \begin_inset Quotes erd
24966 is used by Bib\SpecialChar TeX
24967 to delimit authors).
24969 therefore provides some methods to get properly formatted name lists (which
24970 will also get translated).
24971 The following keys are provided:
24974 \begin_layout Enumerate
24975 For name lists with pre- and surname, suitable for the main authors/editors
24976 of a bibliography item.
24978 \begin_inset Flex Code
24981 \begin_layout Plain Layout
24987 part denotes the kind of list that is requested (e.g.
24989 \begin_inset Flex Code
24992 \begin_layout Plain Layout
25002 \begin_layout Itemize
25003 \begin_inset Flex Code
25006 \begin_layout Plain Layout
25007 %abbrvnames:<nametype>%
25012 : Provides a name list which is abbreviated (with
25013 \begin_inset Quotes eld
25017 \begin_inset Quotes erd
25021 \begin_inset Flex Code
25024 \begin_layout Plain Layout
25033 \begin_layout Itemize
25034 \begin_inset Flex Code
25037 \begin_layout Plain Layout
25038 %fullnames:<nametype>%
25043 : Provides a full name list (never abbreviated with
25044 \begin_inset Quotes eld
25048 \begin_inset Quotes erd
25054 \begin_layout Itemize
25055 \begin_inset Flex Code
25058 \begin_layout Plain Layout
25059 %forceabbrvnames:<nametype>%
25064 : Provides a name list which is always abbreviated (with
25065 \begin_inset Quotes eld
25069 \begin_inset Quotes erd
25073 \begin_inset Flex Code
25076 \begin_layout Plain Layout
25086 \begin_layout Enumerate
25087 Alternative name lists with pre- and surname, if the order of pre- and surname
25088 inside the bibliography item differs (as in:
25089 \begin_inset Quotes eld
25092 Miller, John: Some text, in: Mary Smith, ed.: A volume
25093 \begin_inset Quotes erd
25100 \begin_layout Itemize
25101 \begin_inset Flex Code
25104 \begin_layout Plain Layout
25105 %abbrvbynames:<nametype>%
25110 : Provides a name list which is abbreviated (with
25111 \begin_inset Quotes eld
25115 \begin_inset Quotes erd
25119 \begin_inset Flex Code
25122 \begin_layout Plain Layout
25131 \begin_layout Itemize
25132 \begin_inset Flex Code
25135 \begin_layout Plain Layout
25136 %fullbynames:<nametype>%
25141 : Provides a full name list (never abbreviated with
25142 \begin_inset Quotes eld
25146 \begin_inset Quotes erd
25152 \begin_layout Itemize
25153 \begin_inset Flex Code
25156 \begin_layout Plain Layout
25157 %forceabbrvbynames:<nametype>%
25162 : Provides a name list which is always abbreviated (with
25163 \begin_inset Quotes eld
25167 \begin_inset Quotes erd
25171 \begin_inset Flex Code
25174 \begin_layout Plain Layout
25184 \begin_layout Enumerate
25185 And finally name lists which consist of family names only, as used in author-yea
25187 These do not take a
25188 \begin_inset Flex Code
25191 \begin_layout Plain Layout
25197 part, but always return either an author list or, if this does not exist,
25198 an editor list (as common in author-year labels):
25202 \begin_layout Itemize
25203 \begin_inset Flex Code
25206 \begin_layout Plain Layout
25212 : Provides a name list which is abbreviated (with
25213 \begin_inset Quotes eld
25217 \begin_inset Quotes erd
25221 \begin_inset Flex Code
25224 \begin_layout Plain Layout
25233 \begin_layout Itemize
25234 \begin_inset Flex Code
25237 \begin_layout Plain Layout
25243 : Provides a full name list (never abbreviated with
25244 \begin_inset Quotes eld
25248 \begin_inset Quotes erd
25254 \begin_layout Itemize
25255 \begin_inset Flex Code
25258 \begin_layout Plain Layout
25259 %forceabbrvciteauthor%
25264 : Provides a name list which is always abbreviated (with
25265 \begin_inset Quotes eld
25269 \begin_inset Quotes erd
25273 \begin_inset Flex Code
25276 \begin_layout Plain Layout
25286 \begin_layout Standard
25287 The order of pre- and surname in the former two lists can be adjusted by
25291 \begin_layout Itemize
25292 \begin_inset Flex Code
25295 \begin_layout Plain Layout
25296 !firstnameform %surname%, %prename%
25301 (first author in lists of type 1)
25304 \begin_layout Itemize
25305 \begin_inset Flex Code
25308 \begin_layout Plain Layout
25309 !othernameform %surname%, %prename%
25314 (other authors in lists of type 1)
25317 \begin_layout Itemize
25318 \begin_inset Flex Code
25321 \begin_layout Plain Layout
25322 !firstbynameform %prename% %surname%
25327 (first author in lists of type 2)
25330 \begin_layout Itemize
25331 \begin_inset Flex Code
25334 \begin_layout Plain Layout
25335 !otherbynameform %prename% %surname%
25340 (other authors in lists of type 2)
25343 \begin_layout Standard
25344 This allows you to configure namings like
25345 \begin_inset Quotes eld
25348 Miller, Peter and Mary Smith: \SpecialChar ldots
25349 , in: John Doe and Pat Green, eds.:\SpecialChar ldots
25351 \begin_inset Quotes erd
25357 \begin_layout Standard
25358 There is one other piece of syntax available in definitions, which looks
25360 \begin_inset Flex Code
25363 \begin_layout Plain Layout
25370 This defines a piece of formatting information that is to be used when
25372 \begin_inset Quotes eld
25376 \begin_inset Quotes erd
25380 Obviously, we do not want to output HTML tags when writing plain text,
25381 so they should be wrapped in
25382 \begin_inset Quotes eld
25386 \begin_inset Quotes erd
25390 \begin_inset Quotes eld
25394 \begin_inset Quotes erd
25400 \begin_layout Standard
25401 Two special sorts of definitions are also possible in a
25402 \begin_inset Flex Code
25405 \begin_layout Plain Layout
25412 An example of the first would be:
25415 \begin_layout LyX-Code
25417 \begin_inset Quotes eld
25421 \begin_inset Quotes erd
25427 \begin_layout Standard
25428 This is an abbreviation, or macro, and it can be used by treating it as
25430 \begin_inset Flex Code
25433 \begin_layout Plain Layout
25442 \begin_inset Flex Code
25445 \begin_layout Plain Layout
25451 exactly as it would treat its definition.
25452 So, let us issue the obvious
25460 \begin_layout LyX-Code
25464 \begin_layout Standard
25465 or anything like it.
25467 shouldn't go into an infinite loop, but it may go into a long one before
25471 \begin_layout Standard
25472 The second sort of special definition might look like this:
25475 \begin_layout LyX-Code
25479 \begin_layout Standard
25480 This defines a translatable piece of text, which allows relevant parts of
25481 the bibliography or citation to be translated.
25482 It can be included in a definition by treating it as a key:
25483 \begin_inset Flex Code
25486 \begin_layout Plain Layout
25493 Note that there are two different translation paths: All definitions starting
25495 \begin_inset Flex Code
25498 \begin_layout Plain Layout
25504 , such as in the example above, will be translated to the currently active
25505 buffer language (so the translation will match the generated document).
25506 All definitions starting with underscore only will be translated to the
25508 This is the proper translation for strings that only occur in the dialogs
25509 or on buttons, such as this one:
25512 \begin_layout LyX-Code
25513 _addtobib Add to bibliography only.
25516 \begin_layout Standard
25517 Several of these translatable strings are predefined in
25518 \begin_inset Flex Code
25521 \begin_layout Plain Layout
25528 \begin_inset Flex Code
25531 \begin_layout Plain Layout
25538 Note that these are not macros, in the sense just defined.
25539 They will not be expanded.
25542 \begin_layout Standard
25543 So here then is an example that uses several of these features:
25544 \begin_inset VSpace defskip
25550 \begin_layout Standard
25554 !authoredit {%author%[[%author%, ]][[{%editor%[[%editor%, %B_edtext%, ]]}]]}
25557 \begin_layout Standard
25558 \begin_inset VSpace defskip
25561 This defines a macro that prints the author, followed by a comma, if the
25563 \begin_inset Flex Code
25566 \begin_layout Plain Layout
25572 key is defined, or else prints the name of the editor, followed by the
25574 \begin_inset Flex Code
25577 \begin_layout Plain Layout
25583 or its translation (it is by default
25584 \begin_inset Quotes eld
25588 \begin_inset Quotes erd
25592 \begin_inset Flex Code
25595 \begin_layout Plain Layout
25602 Note that this is in fact defined in
25603 \begin_inset Flex Code
25606 \begin_layout Plain Layout
25612 , so you can use it in your own definitions, or re-definitions, if you load
25616 \begin_layout Section
25617 \begin_inset CommandInset label
25619 name "sec:Tags-for-XHTML"
25623 Tags for XHTML output
25626 \begin_layout Standard
25627 As with \SpecialChar LaTeX
25628 or DocBook, the format of \SpecialChar LyX
25629 's XHTML output is also controlled by
25630 layout information.
25631 In general, \SpecialChar LyX
25632 provides sensible defaults and, as mentioned earlier, it will
25633 even construct default CSS style rules from the other layout tags.
25634 For example, \SpecialChar LyX
25635 will attempt to use the information provided in the
25636 \begin_inset Flex Code
25639 \begin_layout Plain Layout
25645 declaration for the Chapter style to write CSS that will appropriately
25646 format chapter headings.
25649 \begin_layout Standard
25650 In many cases, then, you may not have to do anything at all to get acceptable
25651 XHTML output for your own environments, custom insets, and so forth.
25652 But in some cases you will, and so \SpecialChar LyX
25653 provides a number of layout tags that
25654 can be used to customize the XHTML and CSS that are generated.
25657 \begin_layout Standard
25658 Note that there are two tags,
25659 \begin_inset Flex Code
25662 \begin_layout Plain Layout
25669 \begin_inset Flex Code
25672 \begin_layout Plain Layout
25678 that may appear outside style and inset declarations.
25680 \begin_inset CommandInset ref
25682 reference "subsec:General-text-class"
25686 for details on these.
25689 \begin_layout Subsection
25690 \begin_inset CommandInset label
25692 name "subsec:Paragraph-Style-XHTML"
25699 \begin_layout Standard
25700 The sort of XHTML \SpecialChar LyX
25701 outputs for a paragraph depends upon whether we are dealing
25702 with a normal paragraph, a command, or an environment, where this is itself
25703 determined by the contents of the corresponding
25704 \begin_inset Flex Code
25707 \begin_layout Plain Layout
25718 \begin_layout Standard
25719 For a command or normal paragraph, the output XHTML has the following form:
25722 \begin_layout LyX-Code
25726 \begin_inset Quotes erd
25730 \begin_inset Quotes erd
25736 \begin_layout LyX-Code
25740 \begin_inset Quotes erd
25744 \begin_inset Quotes erd
25750 \begin_layout LyX-Code
25753 Contents of the paragraph.
25756 \begin_layout LyX-Code
25762 \begin_layout Standard
25763 The label tags are of course omitted if the paragraph does not have a label.
25766 \begin_layout Standard
25767 For an environment that is not some sort of list, the XHTML takes this form:
25770 \begin_layout LyX-Code
25774 \begin_inset Quotes erd
25778 \begin_inset Quotes erd
25784 \begin_layout LyX-Code
25788 \begin_inset Quotes erd
25792 \begin_inset Quotes erd
25796 \begin_inset Quotes erd
25800 \begin_inset Quotes erd
25803 >Environment Label</labeltag>First paragraph.</itemtag>
25806 \begin_layout LyX-Code
25809 <itemtag>Second paragraph.</itemtag>
25812 \begin_layout LyX-Code
25818 \begin_layout Standard
25819 Note that the label is output only for the first paragraph, as it should
25820 be for a theorem, for example.
25824 \begin_layout Standard
25825 For a list, we have one of these forms:
25828 \begin_layout LyX-Code
25832 \begin_inset Quotes erd
25836 \begin_inset Quotes erd
25842 \begin_layout LyX-Code
25846 \begin_inset Quotes erd
25850 \begin_inset Quotes erd
25854 \begin_inset Quotes erd
25858 \begin_inset Quotes erd
25861 >List Label</labeltag>First item.</itemtag>
25864 \begin_layout LyX-Code
25868 \begin_inset Quotes erd
25872 \begin_inset Quotes erd
25876 \begin_inset Quotes erd
25880 \begin_inset Quotes erd
25883 >List Label</labeltag>Second item.</itemtag>
25886 \begin_layout LyX-Code
25892 \begin_layout LyX-Code
25896 \begin_layout LyX-Code
25900 \begin_inset Quotes erd
25904 \begin_inset Quotes erd
25910 \begin_layout LyX-Code
25914 \begin_inset Quotes erd
25918 \begin_inset Quotes erd
25921 >List Label</labeltag><itemtag attr=
25922 \begin_inset Quotes erd
25926 \begin_inset Quotes erd
25929 >First item.</itemtag>
25932 \begin_layout LyX-Code
25936 \begin_inset Quotes erd
25940 \begin_inset Quotes erd
25943 >List Label</labeltag><itemtag attr=
25944 \begin_inset Quotes erd
25948 \begin_inset Quotes erd
25951 >Second item.</itemtag>
25954 \begin_layout LyX-Code
25960 \begin_layout Standard
25961 Note the different orders of
25962 \begin_inset Flex Code
25965 \begin_layout Plain Layout
25972 \begin_inset Flex Code
25975 \begin_layout Plain Layout
25982 Which order we get depends upon the setting of
25983 \begin_inset Flex Code
25986 \begin_layout Plain Layout
25993 \begin_inset Flex Code
25996 \begin_layout Plain Layout
26002 is false (the default), you get the first of these, with the label within
26003 the item; if true, you get the second, with the label outside the item.
26006 \begin_layout Standard
26007 The specific tags and attributes output for each paragraph type can be controlle
26008 d by means of the layout tags we are about to describe.
26009 As mentioned earlier, however, \SpecialChar LyX
26010 uses sensible defaults for many of these,
26011 so you often may not need to do very much to get good XHTML output.
26012 Think of the available tags as there so you can tweak things to your liking.
26015 \begin_layout Description
26016 \begin_inset Flex Code
26019 \begin_layout Plain Layout
26026 \begin_inset Flex Code
26029 \begin_layout Plain Layout
26035 ] Specifies attribute information to be output with the main tag.
26037 \begin_inset Quotes eld
26041 \begin_inset Flex Code
26044 \begin_layout Plain Layout
26051 \begin_inset Quotes erd
26055 By default, \SpecialChar LyX
26057 \begin_inset Quotes eld
26061 \begin_inset Flex Code
26064 \begin_layout Plain Layout
26071 \begin_inset Quotes erd
26075 \begin_inset Flex Code
26078 \begin_layout Plain Layout
26084 is the \SpecialChar LyX
26085 name of the layout, made lowercase, for example: chapter.
26090 contain any style information.
26092 \begin_inset Flex Code
26095 \begin_layout Plain Layout
26104 \begin_layout Description
26105 \begin_inset Flex Code
26108 \begin_layout Plain Layout
26115 \begin_inset Flex Code
26118 \begin_layout Plain Layout
26128 ] Whether to output the default CSS information \SpecialChar LyX
26129 generates for this layout,
26130 even if additional information is explicitly provided via
26131 \begin_inset Flex Code
26134 \begin_layout Plain Layout
26142 \begin_inset Flex Code
26145 \begin_layout Plain Layout
26151 allows you to alter or augment the generated CSS, rather than to override
26154 \begin_inset Flex Code
26157 \begin_layout Plain Layout
26166 \begin_layout Description
26167 \begin_inset Flex Code
26170 \begin_layout Plain Layout
26177 \begin_inset Flex Code
26180 \begin_layout Plain Layout
26186 ] The tag to be used for individual paragraphs of environments, replacing
26188 \begin_inset Flex Code
26191 \begin_layout Plain Layout
26197 in the examples above.
26199 \begin_inset Flex Code
26202 \begin_layout Plain Layout
26211 \begin_layout Description
26212 \begin_inset Flex Code
26215 \begin_layout Plain Layout
26222 \begin_inset Flex Code
26225 \begin_layout Plain Layout
26231 ] Attributes for the item tag.
26233 \begin_inset Newline newline
26237 \begin_inset Quotes eld
26241 \begin_inset Flex Code
26244 \begin_layout Plain Layout
26245 class=`layoutname_item'
26251 \begin_inset Quotes erd
26259 contain any style information.
26261 \begin_inset Flex Code
26264 \begin_layout Plain Layout
26273 \begin_layout Description
26274 \begin_inset Flex Code
26277 \begin_layout Plain Layout
26284 \begin_inset Flex Code
26287 \begin_layout Plain Layout
26293 ] The tag to be used for paragraph and item labels, replacing
26294 \begin_inset Flex Code
26297 \begin_layout Plain Layout
26303 in the examples above.
26305 \begin_inset Flex Code
26308 \begin_layout Plain Layout
26315 \begin_inset Flex Code
26318 \begin_layout Plain Layout
26325 \begin_inset Flex Code
26328 \begin_layout Plain Layout
26335 \begin_inset Flex Code
26338 \begin_layout Plain Layout
26339 Centered_Top_Environment
26344 , in which case it defaults to
26345 \begin_inset Flex Code
26348 \begin_layout Plain Layout
26357 \begin_layout Description
26358 \begin_inset Flex Code
26361 \begin_layout Plain Layout
26368 \begin_inset Flex Code
26371 \begin_layout Plain Layout
26377 ] Attributes for the label tag.
26379 \begin_inset Newline newline
26383 \begin_inset Quotes eld
26387 \begin_inset Flex Code
26390 \begin_layout Plain Layout
26391 class=`layoutname_label'
26397 \begin_inset Quotes erd
26405 contain any style information.
26407 \begin_inset Flex Code
26410 \begin_layout Plain Layout
26419 \begin_layout Description
26420 \begin_inset Flex Code
26423 \begin_layout Plain Layout
26430 \begin_inset Flex Code
26433 \begin_layout Plain Layout
26443 ] Meaningful only for list-like environments, this tag controls whether
26444 the label tag is output before or inside the item tag.
26445 This is used, for example, in the description environment, where we want
26447 \begin_inset Flex Code
26450 \begin_layout Plain Layout
26451 <dt>\SpecialChar ldots
26452 </dt><dd>\SpecialChar ldots
26460 \begin_inset Flex Code
26463 \begin_layout Plain Layout
26469 : The label tag is output inside the item tag.
26472 \begin_layout Description
26473 \begin_inset Flex Code
26476 \begin_layout Plain Layout
26482 Information to be output in the
26483 \begin_inset Flex Code
26486 \begin_layout Plain Layout
26492 section when this style is used.
26493 This might, for example, be used to include a
26494 \begin_inset Flex Code
26497 \begin_layout Plain Layout
26504 \begin_inset Flex Code
26507 \begin_layout Plain Layout
26516 \begin_layout Description
26517 \begin_inset Flex Code
26520 \begin_layout Plain Layout
26526 CSS style information to be included when this style is used.
26527 Note that this will automatically be wrapped in a layout-generated
26528 \begin_inset Flex Code
26531 \begin_layout Plain Layout
26537 block, so only the CSS itself need be included.
26539 \begin_inset Flex Code
26542 \begin_layout Plain Layout
26551 \begin_layout Description
26552 \begin_inset Flex Code
26555 \begin_layout Plain Layout
26562 \begin_inset Flex Code
26565 \begin_layout Plain Layout
26571 ] The tag to be used for the main label, replacing
26572 \begin_inset Flex Code
26575 \begin_layout Plain Layout
26581 in the examples above.
26583 \begin_inset Flex Code
26586 \begin_layout Plain Layout
26595 \begin_layout Description
26596 \begin_inset Flex Code
26599 \begin_layout Plain Layout
26606 \begin_inset Flex Code
26609 \begin_layout Plain Layout
26619 ] Marks this style as the one to be used to generate the
26620 \begin_inset Flex Code
26623 \begin_layout Plain Layout
26629 tag for the XHTML file.
26630 By default, it is false.
26632 \begin_inset Flex Code
26635 \begin_layout Plain Layout
26641 file sets it to true for the
26642 \begin_inset Flex Code
26645 \begin_layout Plain Layout
26655 \begin_layout Subsection
26659 \begin_layout Standard
26660 The XHTML output of insets can also be controlled by information in layout
26665 \begin_layout Plain Layout
26666 At present, this is true only for
26667 \begin_inset Quotes eld
26671 \begin_inset Quotes erd
26674 insets (insets you can type into) and is not true for
26675 \begin_inset Quotes eld
26679 \begin_inset Quotes erd
26682 insets (insets that are associated with dialog boxes).
26687 Here, too, \SpecialChar LyX
26688 tries to provide sensible defaults, and it constructs default
26690 But everything can be customized.
26693 \begin_layout Standard
26694 The XHTML \SpecialChar LyX
26695 outputs for an inset has the following form:
26698 \begin_layout LyX-Code
26700 \begin_inset Quotes erd
26704 \begin_inset Quotes erd
26710 \begin_layout LyX-Code
26711 <labeltag>Label</labeltag>
26714 \begin_layout LyX-Code
26716 \begin_inset Quotes erd
26720 \begin_inset Quotes erd
26723 >Contents of the inset.</innertag>
26726 \begin_layout LyX-Code
26730 \begin_layout Standard
26731 If the inset permits multiple paragraphs—that is, if
26732 \begin_inset Flex Code
26735 \begin_layout Plain Layout
26741 is true—then the contents of the inset will itself be output as paragraphs
26742 formatted according to the styles used for those paragraphs (standard,
26743 quote, and the like).
26744 The label tag is of course omitted if the paragraph does not have a label
26745 and, at present, is always
26746 \begin_inset Flex Code
26749 \begin_layout Plain Layout
26756 The inner tag is optional and, by default, does not appear.
26759 \begin_layout Standard
26760 The specific tags and attributes output for each inset can be controlled
26761 by means of the following layout tags.
26764 \begin_layout Description
26765 \begin_inset Flex Code
26768 \begin_layout Plain Layout
26775 \begin_inset Flex Code
26778 \begin_layout Plain Layout
26784 ] Specifies attribute information to be output with the main tag.
26786 \begin_inset Quotes eld
26790 \begin_inset Flex Code
26793 \begin_layout Plain Layout
26794 class=`myinset' onclick=`\SpecialChar ldots
26801 \begin_inset Quotes erd
26805 By default, \SpecialChar LyX
26807 \begin_inset Quotes eld
26811 \begin_inset Flex Code
26814 \begin_layout Plain Layout
26821 \begin_inset Quotes erd
26825 \begin_inset Flex Code
26828 \begin_layout Plain Layout
26834 is the \SpecialChar LyX
26835 name of the inset, made lowercase and with non-alphanumeric characters
26836 converted to underscores, for example: footnote.
26839 \begin_layout Description
26840 \begin_inset Flex Code
26843 \begin_layout Plain Layout
26850 \begin_inset Flex Code
26853 \begin_layout Plain Layout
26863 ] Whether to output the default CSS information \SpecialChar LyX
26864 generates for this layout,
26865 even if additional information is explicitly provided via
26866 \begin_inset Flex Code
26869 \begin_layout Plain Layout
26877 \begin_inset Flex Code
26880 \begin_layout Plain Layout
26886 allows you to alter or augment the generated CSS, rather than to override
26891 \begin_layout Description
26892 \begin_inset Flex Code
26895 \begin_layout Plain Layout
26902 \begin_inset Flex Code
26905 \begin_layout Plain Layout
26911 ] Attributes for the inner tag.
26913 \begin_inset Newline newline
26917 \begin_inset Quotes eld
26921 \begin_inset Flex Code
26924 \begin_layout Plain Layout
26925 class=`insetname_inner'
26931 \begin_inset Quotes erd
26937 \begin_layout Description
26938 \begin_inset Flex Code
26941 \begin_layout Plain Layout
26948 \begin_inset Flex Code
26951 \begin_layout Plain Layout
26957 ] The inner tag, replacing
26958 \begin_inset Flex Code
26961 \begin_layout Plain Layout
26967 in the examples above.
26968 By default, there is none.
26971 \begin_layout Description
26972 \begin_inset Flex Code
26975 \begin_layout Plain Layout
26982 \begin_inset Flex Code
26985 \begin_layout Plain Layout
26993 ] Whether this inset represents a standalone block of text (such as a footnote)
26994 or instead represents material that is included in the surrounding text
26995 (such as a branch).
26999 \begin_layout Description
27000 \begin_inset Flex Code
27003 \begin_layout Plain Layout
27010 \begin_inset Flex Code
27013 \begin_layout Plain Layout
27019 ] A label for this inset, possibly including a reference to a counter.
27020 For example, for footnote, it might be:
27021 \begin_inset Flex Code
27024 \begin_layout Plain Layout
27033 This is optional, and there is no default.
27036 \begin_layout Description
27037 \begin_inset Flex Code
27040 \begin_layout Plain Layout
27046 Information to be output in the
27047 \begin_inset Flex Code
27050 \begin_layout Plain Layout
27056 section when this style is used.
27057 This might, for example, be used to include a
27058 \begin_inset Flex Code
27061 \begin_layout Plain Layout
27068 \begin_inset Flex Code
27071 \begin_layout Plain Layout
27080 \begin_layout Description
27081 \begin_inset Flex Code
27084 \begin_layout Plain Layout
27090 CSS style information to be included when this style is used.
27091 Note that this will automatically be wrapped in a layout-generated
27092 \begin_inset Flex Code
27095 \begin_layout Plain Layout
27101 block, so only the CSS itself need be included.
27104 \begin_layout Description
27105 \begin_inset Flex Code
27108 \begin_layout Plain Layout
27115 \begin_inset Flex Code
27118 \begin_layout Plain Layout
27124 ] The tag to be used for the main label, replacing
27125 \begin_inset Flex Code
27128 \begin_layout Plain Layout
27134 in the examples above.
27135 The default depends upon the setting of
27136 \begin_inset Flex Code
27139 \begin_layout Plain Layout
27146 \begin_inset Flex Code
27149 \begin_layout Plain Layout
27155 is true, the default is
27156 \begin_inset Flex Code
27159 \begin_layout Plain Layout
27165 ; if it is false, the default is
27166 \begin_inset Flex Code
27169 \begin_layout Plain Layout
27178 \begin_layout Subsection
27182 \begin_layout Standard
27183 The XHTML output for floats too can be controlled by layout information.
27184 The output has the following form:
27187 \begin_layout LyX-Code
27189 \begin_inset Quotes erd
27193 \begin_inset Quotes erd
27199 \begin_layout LyX-Code
27200 Contents of the float.
27203 \begin_layout LyX-Code
27207 \begin_layout Standard
27208 The caption, if there is one, is a separate inset and will be output as
27210 Its appearance can be controlled via the InsetLayout for caption insets.
27214 \begin_layout Description
27215 \begin_inset Flex Code
27218 \begin_layout Plain Layout
27225 \begin_inset Flex Code
27228 \begin_layout Plain Layout
27234 ] Specifies attribute information to be output with the main tag.
27236 \begin_inset Quotes eld
27240 \begin_inset Flex Code
27243 \begin_layout Plain Layout
27244 class=`myfloat' onclick=`\SpecialChar ldots
27251 \begin_inset Quotes erd
27255 By default, \SpecialChar LyX
27257 \begin_inset Quotes eld
27261 \begin_inset Flex Code
27264 \begin_layout Plain Layout
27265 class=`float float-floattype'
27271 \begin_inset Quotes erd
27275 \begin_inset Flex Code
27278 \begin_layout Plain Layout
27284 is \SpecialChar LyX
27285 's name for this type of float, as determined by the float declaration
27287 \begin_inset CommandInset ref
27289 reference "subsec:Floats"
27293 ), though made lowercase and with non-alphanumeric characters converted
27294 to underscores, for example: float-table.
27297 \begin_layout Description
27298 \begin_inset Flex Code
27301 \begin_layout Plain Layout
27307 CSS style information to be included when this float is used.
27308 Note that this will automatically be wrapped in a layout-generated
27309 \begin_inset Flex Code
27312 \begin_layout Plain Layout
27318 block, so only the CSS itself need be included.
27321 \begin_layout Description
27322 \begin_inset Flex Code
27325 \begin_layout Plain Layout
27332 \begin_inset Flex Code
27335 \begin_layout Plain Layout
27341 ] The tag to be used for this float, replacing
27342 \begin_inset Quotes eld
27346 \begin_inset Flex Code
27349 \begin_layout Plain Layout
27356 \begin_inset Quotes erd
27359 in the example above.
27361 \begin_inset Flex Code
27364 \begin_layout Plain Layout
27370 and will rarely need changing.
27373 \begin_layout Subsection
27374 Bibliography formatting
27377 \begin_layout Standard
27378 The bibliography can be formatted using
27379 \begin_inset Flex Code
27382 \begin_layout Plain Layout
27390 \begin_inset CommandInset ref
27392 reference "subsec:Citation-format-description"
27399 \begin_layout Subsection
27404 \begin_layout Standard
27405 We have several times mentioned that \SpecialChar LyX
27406 will generate default CSS style rules
27407 for both insets and paragraph styles, based upon the other layout information
27409 In this section, we shall say a word about which layout information \SpecialChar LyX
27414 \begin_layout Standard
27415 At present, \SpecialChar LyX
27416 auto-generates CSS only for font information, making use of
27418 \begin_inset Flex Code
27421 \begin_layout Plain Layout
27428 \begin_inset Flex Code
27431 \begin_layout Plain Layout
27438 \begin_inset Flex Code
27441 \begin_layout Plain Layout
27448 \begin_inset Flex Code
27451 \begin_layout Plain Layout
27458 \begin_inset Flex Code
27461 \begin_layout Plain Layout
27468 \begin_inset CommandInset ref
27470 reference "subsec:Font-description"
27475 The translation is mostly straightforward and obvious.
27477 \begin_inset Quotes eld
27481 \begin_inset Flex Code
27484 \begin_layout Plain Layout
27491 \begin_inset Quotes erd
27495 \begin_inset Quotes eld
27499 \begin_inset Flex Code
27502 \begin_layout Plain Layout
27503 font-family: sans-serif;
27509 \begin_inset Quotes erd
27513 The correspondence of \SpecialChar LyX
27514 sizes and CSS sizes is a little less obvious but
27515 nonetheless intuitive.
27517 \begin_inset Flex Code
27520 \begin_layout Plain Layout
27527 \begin_inset Flex URL
27530 \begin_layout Plain Layout
27538 \change_inserted -970929547 1496610908
27542 \begin_layout Section
27544 \change_inserted -970929547 1496610966
27545 \begin_inset CommandInset label
27547 name "sec:Tags-for-DocBook"
27551 Tags for DocBook output
27554 \begin_layout Standard
27556 \change_inserted -970929547 1496611615
27557 As with \SpecialChar LaTeX
27558 or XHTML, the format of \SpecialChar LyX
27559 's DocBook output is also controlled by
27560 layout information.
27561 In general, \SpecialChar LyX
27562 provides sensible defaults; however, much of the styling is
27563 lost during the conversion, as DocBook is strictly semantic and does not
27565 When possible, information from \SpecialChar LyX
27566 will be rendered in
27574 \begin_layout Standard
27576 \change_inserted -970929547 1496612080
27577 In many cases, then, you may not have to do anything at all to get acceptable
27578 DocBook output for your own environments, custom insets, and so forth.
27579 But in some cases you will, and so \SpecialChar LyX
27580 provides a number of layout tags that
27581 can be used to customize the DocBook that is generated.
27584 \begin_layout Standard
27586 \change_inserted -970929547 1515109912
27587 Labels are rarely output, as they are redundant in DocBook: this information
27588 is carried by the tags themselves, and whether labels appear in the final
27589 documents (after processing of DocBook files) is controlled by the stylesheets.
27590 However, sometimes, labels are not redundant content, such as definition
27591 lists: in this case, the term being defined will be the label.
27595 \begin_layout Subsection
27597 \change_inserted 1075283030 1597699417
27598 \begin_inset CommandInset label
27600 name "subsec:Paragraph-Style-DocBook"
27605 \change_deleted 1075283030 1597699417
27607 \begin_inset CommandInset label
27609 name "subsec:Paragraph-Style-XHTML-1"
27614 \change_inserted -970929547 1496610966
27618 \begin_layout Standard
27620 \change_inserted -970929547 1496612059
27621 The sort of DocBook \SpecialChar LyX
27622 outputs for a paragraph depends upon whether we are
27623 dealing with a normal paragraph, a command, or an environment, where this
27624 is itself determined by the contents of the corresponding
27625 \begin_inset Flex Code
27628 \begin_layout Plain Layout
27630 \change_inserted -970929547 1496610966
27643 \begin_layout Standard
27645 \change_inserted -970929547 1496612107
27646 For a command or normal paragraph, the output DocBook has the following
27650 \begin_layout LyX-Code
27652 \change_inserted -970929547 1515109666
27656 \begin_layout LyX-Code
27658 \change_inserted -970929547 1496610966
27659 Contents of the paragraph.
27662 \begin_layout LyX-Code
27664 \change_inserted -970929547 1496610966
27668 \begin_layout Standard
27670 \change_inserted -970929547 1515109821
27671 For an environment that is not some sort of list, the generated DocBook
27675 \begin_layout LyX-Code
27677 \change_inserted -970929547 1515109671
27681 \begin_layout LyX-Code
27683 \change_inserted -970929547 1496612114
27684 <itemtag>First paragraph.</itemtag>
27687 \begin_layout LyX-Code
27689 \change_inserted -970929547 1496610966
27690 <itemtag>Second paragraph.</itemtag>
27693 \begin_layout LyX-Code
27695 \change_inserted -970929547 1496610966
27699 \begin_layout Standard
27701 \change_inserted -970929547 1515109825
27702 For a list, the resulting DocBook takes this form:
27705 \begin_layout LyX-Code
27707 \change_inserted -970929547 1515109672
27711 \begin_layout LyX-Code
27713 \change_inserted -970929547 1515109676
27714 <itemtag attr>First item.</itemtag>
27717 \begin_layout LyX-Code
27719 \change_inserted -970929547 1515109678
27720 <itemtag attr>Second item.</itemtag>
27723 \begin_layout LyX-Code
27725 \change_inserted -970929547 1496610966
27729 \begin_layout Standard
27731 \change_inserted -970929547 1496612243
27732 The specific tags and roles output for each paragraph type can be controlled
27733 by means of the layout tags we are about to describe.
27734 Please note that, due to the very nature of DocBook, no sensible defaults
27735 really exist, and the values must always be carefully chosen.
27739 \begin_layout Description
27741 \change_inserted -970929547 1515110057
27742 \begin_inset Flex Code
27745 \begin_layout Plain Layout
27747 \change_inserted -970929547 1515109656
27756 \begin_inset Flex Code
27759 \begin_layout Plain Layout
27761 \change_inserted -970929547 1496610966
27769 ] Specifies attribute information to be output with the main tag, replacing
27771 \begin_inset Quotes eld
27775 \begin_inset Flex Code
27778 \begin_layout Plain Layout
27780 \change_inserted -970929547 1515110057
27789 \begin_inset Quotes erd
27792 in the example above.
27793 This information can be used in further processing of the DocBook files.
27799 \begin_layout Description
27801 \change_inserted -970929547 1496612296
27802 \begin_inset Flex Code
27805 \begin_layout Plain Layout
27807 \change_inserted -970929547 1496612269
27816 \begin_inset Flex Code
27819 \begin_layout Plain Layout
27821 \change_inserted -970929547 1496610966
27829 ] The tag to be used for this inset, replacing
27830 \begin_inset Quotes eld
27834 \begin_inset Flex Code
27837 \begin_layout Plain Layout
27839 \change_inserted -970929547 1496612296
27848 \begin_inset Quotes erd
27851 in the example above.
27852 The default is the name of the float and always needs to be changed, as
27853 DocBook provides no generic tag.
27854 \change_inserted 1075283030 1597698868
27858 \begin_layout Description
27860 \change_inserted 1075283030 1597699399
27861 \begin_inset Flex Code
27864 \begin_layout Plain Layout
27866 \change_inserted 1075283030 1597698872
27875 \begin_inset Flex Code
27878 \begin_layout Plain Layout
27880 \change_inserted 1075283030 1597700585
27881 block, paragraph, inline
27888 ] The new-line policy for this tag, see Section
27889 \begin_inset space ~
27893 \begin_inset CommandInset ref
27895 reference "subsec:DocBook-New-line-policy"
27908 \begin_layout Subsection
27910 \change_inserted 1075283030 1597699385
27912 \begin_inset CommandInset label
27914 name "subsec:DocBook-New-line-policy"
27921 \begin_layout Standard
27923 \change_inserted 1075283030 1597698993
27924 For all tags, there are three possible policies for outputting new lines
27926 \begin_inset Flex Code
27929 \begin_layout Plain Layout
27931 \change_inserted 1075283030 1597698987
27942 \begin_layout Itemize
27944 \change_inserted 1075283030 1597699279
27945 \begin_inset Quotes eld
27949 \begin_inset Flex Code
27952 \begin_layout Plain Layout
27954 \change_inserted 1075283030 1597699012
27963 \begin_inset Quotes erd
27966 : the opening and closing tags are on their own lines (i.e.
27967 a line feed after and before the opening and the closing tags).
27968 Typical elements are floats.
27972 \begin_layout LyX-Code
27974 \change_inserted 1075283030 1597699194
27978 \begin_layout LyX-Code
27980 \change_inserted 1075283030 1597699194
27984 \begin_layout LyX-Code
27986 \change_inserted 1075283030 1597699098
27987 Contents of the block.
27990 \begin_layout LyX-Code
27992 \change_inserted 1075283030 1597699196
27996 \begin_layout LyX-Code
27998 \change_inserted 1075283030 1597699198
28002 \begin_layout Itemize
28004 \change_inserted 1075283030 1597699289
28005 \begin_inset Quotes eld
28009 \begin_inset Flex Code
28012 \begin_layout Plain Layout
28014 \change_inserted 1075283030 1597699113
28023 \begin_inset Quotes erd
28026 : the opening and closing tags are on the same, new line; a line feed is
28027 output before the opening tag and after the closing tag.
28028 Typical elements are paragraphs and list items.
28032 \begin_layout LyX-Code
28034 \change_inserted 1075283030 1597699186
28038 \begin_layout LyX-Code
28040 \change_inserted 1075283030 1597699357
28041 <paratag>Contents of the paragraph.</paratag>
28044 \begin_layout LyX-Code
28046 \change_inserted 1075283030 1597699231
28050 \begin_layout Itemize
28052 \change_inserted 1075283030 1597699343
28053 \begin_inset Quotes eld
28057 \begin_inset Flex Code
28060 \begin_layout Plain Layout
28062 \change_inserted 1075283030 1597699307
28071 \begin_inset Quotes erd
28074 : the opening and closing tags are on the same line as the rest of the content.
28075 No line feeds are output.
28076 Typical elements are fonts.
28080 \begin_layout LyX-Code
28082 \change_inserted 1075283030 1597699585
28083 Content before<inlinetag>Contents of the paragraph.</inlinetag>Content after
28086 \begin_layout Standard
28088 \change_inserted 1075283030 1597699585
28089 The default value is always
28090 \begin_inset Quotes eld
28094 \begin_inset Flex Code
28097 \begin_layout Plain Layout
28099 \change_inserted 1075283030 1597699585
28108 \begin_inset Quotes erd
28116 \begin_layout Subsection
28118 \change_inserted -970929547 1515111533
28119 InsetLayout DocBook
28124 \begin_layout Standard
28126 \change_inserted -970929547 1496611894
28127 The DocBook output of insets can also be controlled by information in layout
28131 \begin_layout Standard
28133 \change_inserted -970929547 1496612045
28134 The DocBook \SpecialChar LyX
28135 outputs for an inset has the following form:
28138 \begin_layout LyX-Code
28140 \change_inserted -970929547 1515110861
28141 <wrappertag wrapperattr>
28144 \begin_layout LyX-Code
28146 \change_inserted -970929547 1515110868
28150 \begin_layout LyX-Code
28152 \change_inserted -970929547 1515110869
28153 <innertag innerattr>
28156 \begin_layout LyX-Code
28158 \change_inserted -970929547 1515110869
28159 Contents of the inset.
28162 \begin_layout LyX-Code
28164 \change_inserted -970929547 1515110870
28168 \begin_layout LyX-Code
28170 \change_inserted -970929547 1515110871
28174 \begin_layout LyX-Code
28176 \change_inserted -970929547 1515111172
28180 \begin_layout Standard
28182 \change_inserted -970929547 1515111186
28183 For an itemising inset, it rather looks like this:
28186 \begin_layout LyX-Code
28188 \change_inserted -970929547 1515111186
28189 <wrappertag wrapperattr>
28192 \begin_layout LyX-Code
28194 \change_inserted -970929547 1515111186
28198 \begin_layout LyX-Code
28200 \change_inserted -970929547 1515111186
28201 <innertag innerattr>
28204 \begin_layout LyX-Code
28206 \change_inserted -970929547 1515111362
28207 <itemwrappertag itemwrapperattr>
28210 \begin_layout LyX-Code
28212 \change_inserted -970929547 1515111364
28213 <itemlabeltag itemattr>
28216 \begin_layout LyX-Code
28218 \change_inserted -970929547 1515111367
28219 Label of the first item.
28222 \begin_layout LyX-Code
28224 \change_inserted -970929547 1515111362
28230 \begin_layout LyX-Code
28232 \change_inserted -970929547 1515111517
28236 \begin_layout LyX-Code
28238 \change_inserted -970929547 1515111517
28244 \begin_layout LyX-Code
28246 \change_inserted -970929547 1515111516
28247 Contents of the first item.
28250 \begin_layout LyX-Code
28252 \change_inserted -970929547 1515111514
28258 \begin_layout LyX-Code
28260 \change_inserted -970929547 1515111247
28266 \begin_layout LyX-Code
28268 \change_inserted -970929547 1515111221
28272 \begin_layout LyX-Code
28274 \change_inserted -970929547 1515111370
28275 <itemwrappertag itemwrapperattr>
28278 \begin_layout LyX-Code
28280 \change_inserted -970929547 1515111370
28281 <itemlabeltag itemattr>
28284 \begin_layout LyX-Code
28286 \change_inserted -970929547 1515111372
28287 Label of the second item.
28290 \begin_layout LyX-Code
28292 \change_inserted -970929547 1515111370
28298 \begin_layout LyX-Code
28300 \change_inserted -970929547 1515111504
28304 \begin_layout LyX-Code
28306 \change_inserted -970929547 1515111505
28312 \begin_layout LyX-Code
28314 \change_inserted -970929547 1515111507
28315 Contents of the second item.
28318 \begin_layout LyX-Code
28320 \change_inserted -970929547 1515111509
28326 \begin_layout LyX-Code
28328 \change_inserted -970929547 1515111251
28334 \begin_layout LyX-Code
28336 \change_inserted -970929547 1515111221
28342 \begin_layout LyX-Code
28344 \change_inserted -970929547 1515111219
28350 \begin_layout LyX-Code
28352 \change_inserted -970929547 1515111186
28356 \begin_layout LyX-Code
28358 \change_inserted -970929547 1515111186
28362 \begin_layout LyX-Code
28364 \change_inserted -970929547 1515111186
28368 \begin_layout Standard
28370 \change_inserted -970929547 1515111183
28371 If the inset permits multiple paragraphs—that is, if
28372 \begin_inset Flex Code
28375 \begin_layout Plain Layout
28377 \change_inserted -970929547 1496610966
28385 is true—then the contents of the inset will itself be output as paragraphs
28386 formatted according to the styles used for those paragraphs (standard,
28387 quote, and the like).
28388 The inner tag is optional and, by default, does not appear.
28391 \begin_layout Standard
28393 \change_inserted -970929547 1496610966
28394 The specific tags and attributes output for each inset can be controlled
28395 by means of the following layout tags.
28398 \begin_layout Description
28400 \change_inserted -970929547 1515110317
28401 \begin_inset Flex Code
28404 \begin_layout Plain Layout
28406 \change_inserted -970929547 1515109695
28415 \begin_inset Flex Code
28418 \begin_layout Plain Layout
28420 \change_inserted -970929547 1496611854
28428 ] Specifies attribute information to be output with the main tag, replacing
28430 \begin_inset Quotes eld
28434 \begin_inset Flex Code
28437 \begin_layout Plain Layout
28439 \change_inserted -970929547 1515110044
28448 \begin_inset Quotes erd
28451 in the example above.
28452 This information can be used in further processing of the DocBook files.
28456 \begin_layout Description
28458 \change_inserted -970929547 1515110973
28459 \begin_inset Flex Code
28462 \begin_layout Plain Layout
28464 \change_inserted -970929547 1515110319
28473 \begin_inset Flex Code
28476 \begin_layout Plain Layout
28478 \change_inserted -970929547 1515110384
28479 never, always, maybe
28486 ] Specifies whether this tag goes into the
28487 \begin_inset Flex Code
28490 \begin_layout Plain Layout
28492 \change_inserted -970929547 1515110412
28500 tag at the beginning of the parent layout.
28502 \begin_inset Flex Code
28505 \begin_layout Plain Layout
28507 \change_inserted -970929547 1515110437
28515 indicates that the tag never goes into
28516 \begin_inset Flex Code
28519 \begin_layout Plain Layout
28521 \change_inserted -970929547 1515110497
28529 (this is default value, and corresponds to usual content).
28531 \begin_inset Flex Code
28534 \begin_layout Plain Layout
28536 \change_inserted -970929547 1515110517
28544 indicates that the tag always goes into
28545 \begin_inset Flex Code
28548 \begin_layout Plain Layout
28550 \change_inserted -970929547 1515110514
28558 (this corresponds to usual metadata): if there is no
28559 \begin_inset Flex Code
28562 \begin_layout Plain Layout
28564 \change_inserted -970929547 1515110550
28572 tag for the parent, one
28578 \begin_inset Flex Code
28581 \begin_layout Plain Layout
28583 \change_inserted -970929547 1515110540
28591 indicates that the tag may go into
28592 \begin_inset Flex Code
28595 \begin_layout Plain Layout
28597 \change_inserted -970929547 1515110538
28605 (this is only the case for titles): if there is no
28606 \begin_inset Flex Code
28609 \begin_layout Plain Layout
28611 \change_inserted -970929547 1515110585
28619 tag for the parent,
28623 will be generated, the corresponding tag will be output directly as content.
28627 \begin_layout Description
28629 \change_inserted -970929547 1515111461
28630 \begin_inset Flex Code
28633 \begin_layout Plain Layout
28635 \change_inserted -970929547 1515110974
28644 \begin_inset Flex Code
28647 \begin_layout Plain Layout
28649 \change_inserted -970929547 1515110973
28657 ] Specifies attribute information to be output with the item tag, replacing
28659 \begin_inset Quotes eld
28663 \begin_inset Flex Code
28666 \begin_layout Plain Layout
28668 \change_inserted -970929547 1515110984
28677 \begin_inset Quotes erd
28680 in the example above.
28681 This information can be used in further processing of the DocBook files.
28685 \begin_layout Description
28687 \change_inserted -970929547 1515111471
28688 \begin_inset Flex Code
28691 \begin_layout Plain Layout
28693 \change_inserted -970929547 1515111465
28694 DocBookItemInnerAttr
28702 \begin_inset Flex Code
28705 \begin_layout Plain Layout
28707 \change_inserted -970929547 1515111461
28715 ] Specifies attribute information to be output with the item inner tag,
28717 \begin_inset Quotes eld
28721 \begin_inset Flex Code
28724 \begin_layout Plain Layout
28726 \change_inserted -970929547 1515111476
28735 \begin_inset Quotes erd
28738 in the example above.
28739 This information can be used in further processing of the DocBook files.
28743 \begin_layout Description
28745 \change_inserted -970929547 1515111494
28746 \begin_inset Flex Code
28749 \begin_layout Plain Layout
28751 \change_inserted -970929547 1515111467
28752 DocBookItemInnerTag
28760 \begin_inset Flex Code
28763 \begin_layout Plain Layout
28765 \change_inserted -970929547 1515111461
28773 ] The tag to be used for the item inner tag within the inset, replacing
28775 \begin_inset Quotes eld
28779 \begin_inset Flex Code
28782 \begin_layout Plain Layout
28784 \change_inserted -970929547 1515111486
28793 \begin_inset Quotes erd
28796 in the example above.
28798 \begin_inset Flex Code
28801 \begin_layout Plain Layout
28803 \change_inserted -970929547 1515111461
28811 , indicating that there is no item inner tag: content is directly output
28812 without it for each itemised element.
28813 This parameter only makes sense when itemising layouts are used, such as
28816 \change_inserted 1075283030 1598469472
28817 The most likely value is
28818 \begin_inset Quotes eld
28822 \begin_inset Flex Code
28825 \begin_layout Plain Layout
28827 \change_inserted 1075283030 1598469476
28836 \begin_inset Quotes erd
28840 \begin_inset Newline newline
28843 When a list item is split using a new line, the item inner tag will be repeated
28844 for each part of the paragraph, parts being separated by new lines.
28848 \begin_layout Description
28850 \change_inserted 1075283030 1597699866
28851 \begin_inset Flex Code
28854 \begin_layout Plain Layout
28856 \change_inserted 1075283030 1597699853
28857 DocBookItemInnerTagType
28865 \begin_inset Flex Code
28868 \begin_layout Plain Layout
28870 \change_inserted 1075283030 1597699866
28871 block, paragraph, inline
28878 ] The new-line policy for this tag, see Section
28879 \begin_inset space ~
28883 \begin_inset CommandInset ref
28885 reference "subsec:DocBook-New-line-policy"
28898 \begin_layout Description
28900 \change_inserted -970929547 1515111290
28901 \begin_inset Flex Code
28904 \begin_layout Plain Layout
28906 \change_inserted -970929547 1515111283
28907 DocBookItemLabelAttr
28915 \begin_inset Flex Code
28918 \begin_layout Plain Layout
28920 \change_inserted -970929547 1515111279
28928 ] Specifies attribute information to be output with the item label tag,
28930 \begin_inset Quotes eld
28934 \begin_inset Flex Code
28937 \begin_layout Plain Layout
28939 \change_inserted -970929547 1515111304
28948 \begin_inset Quotes erd
28951 in the example above.
28952 This information can be used in further processing of the DocBook files.
28956 \begin_layout Description
28958 \change_inserted -970929547 1515111337
28959 \begin_inset Flex Code
28962 \begin_layout Plain Layout
28964 \change_inserted -970929547 1515111285
28965 DocBookItemLabelTag
28973 \begin_inset Flex Code
28976 \begin_layout Plain Layout
28978 \change_inserted -970929547 1515111279
28986 ] The tag to be used for the item label tag within the inset, replacing
28988 \begin_inset Quotes eld
28992 \begin_inset Flex Code
28995 \begin_layout Plain Layout
28997 \change_inserted -970929547 1515111311
29006 \begin_inset Quotes erd
29009 in the example above.
29010 This parameter only makes sense when itemising layouts are used with a
29011 notion of labels, such as definition lists.
29013 \change_inserted 1075283030 1597699874
29017 \begin_layout Description
29019 \change_inserted 1075283030 1597699874
29020 \begin_inset Flex Code
29023 \begin_layout Plain Layout
29025 \change_inserted 1075283030 1597699880
29026 DocBookItemLabelTagType
29034 \begin_inset Flex Code
29037 \begin_layout Plain Layout
29039 \change_inserted 1075283030 1597699874
29040 block, paragraph, inline
29047 ] The new-line policy for this tag, see Section
29048 \begin_inset space ~
29052 \begin_inset CommandInset ref
29054 reference "subsec:DocBook-New-line-policy"
29067 \begin_layout Description
29069 \change_inserted -970929547 1515111124
29070 \begin_inset Flex Code
29073 \begin_layout Plain Layout
29075 \change_inserted -970929547 1515111060
29084 \begin_inset Flex Code
29087 \begin_layout Plain Layout
29089 \change_inserted -970929547 1515111060
29097 ] The tag to be used for the item tag within the inset, replacing
29098 \begin_inset Quotes eld
29102 \begin_inset Flex Code
29105 \begin_layout Plain Layout
29107 \change_inserted -970929547 1515111060
29116 \begin_inset Quotes erd
29119 in the example above.
29121 \begin_inset Flex Code
29124 \begin_layout Plain Layout
29126 \change_inserted -970929547 1515111060
29134 , indicating that there is no item tag.
29135 This parameter only makes sense when itemising layouts are used, such as
29138 \change_inserted 1075283030 1597699890
29142 \begin_layout Description
29144 \change_inserted 1075283030 1597699890
29145 \begin_inset Flex Code
29148 \begin_layout Plain Layout
29150 \change_inserted 1075283030 1597699890
29159 \begin_inset Flex Code
29162 \begin_layout Plain Layout
29164 \change_inserted 1075283030 1597699890
29165 block, paragraph, inline
29172 ] The new-line policy for this tag, see Section
29173 \begin_inset space ~
29177 \begin_inset CommandInset ref
29179 reference "subsec:DocBook-New-line-policy"
29192 \begin_layout Description
29194 \change_inserted -970929547 1515111298
29195 \begin_inset Flex Code
29198 \begin_layout Plain Layout
29200 \change_inserted -970929547 1515111124
29201 DocBookItemWrapperAttr
29209 \begin_inset Flex Code
29212 \begin_layout Plain Layout
29214 \change_inserted -970929547 1515111124
29222 ] Specifies attribute information to be output with the item wrapper tag,
29224 \begin_inset Quotes eld
29228 \begin_inset Flex Code
29231 \begin_layout Plain Layout
29233 \change_inserted -970929547 1515111150
29242 \begin_inset Quotes erd
29245 in the example above.
29246 This information can be used in further processing of the DocBook files.
29252 \begin_layout Description
29254 \change_inserted -970929547 1515111113
29255 \begin_inset Flex Code
29258 \begin_layout Plain Layout
29260 \change_inserted -970929547 1515111073
29261 DocBookItemWrapperTag
29269 \begin_inset Flex Code
29272 \begin_layout Plain Layout
29274 \change_inserted -970929547 1515111073
29282 ] The tag to be used for the item wrapper tag within the inset, replacing
29284 \begin_inset Quotes eld
29288 \begin_inset Flex Code
29291 \begin_layout Plain Layout
29293 \change_inserted -970929547 1515111083
29302 \begin_inset Quotes erd
29305 in the example above.
29307 \begin_inset Flex Code
29310 \begin_layout Plain Layout
29312 \change_inserted -970929547 1515111073
29320 , indicating that there is no item wrapper tag: tag and content are directly
29321 output without it for each itemised element.
29322 This parameter only makes sense when itemising layouts are used, such as
29325 \change_inserted 1075283030 1597699897
29329 \begin_layout Description
29331 \change_inserted 1075283030 1597699897
29332 \begin_inset Flex Code
29335 \begin_layout Plain Layout
29337 \change_inserted 1075283030 1597699900
29338 DocBookItemWrapperTagType
29346 \begin_inset Flex Code
29349 \begin_layout Plain Layout
29351 \change_inserted 1075283030 1597699897
29352 block, paragraph, inline
29359 ] The new-line policy for this tag, see Section
29360 \begin_inset space ~
29364 \begin_inset CommandInset ref
29366 reference "subsec:DocBook-New-line-policy"
29379 \begin_layout Description
29381 \change_inserted -970929547 1515110104
29382 \begin_inset Flex Code
29385 \begin_layout Plain Layout
29387 \change_inserted -970929547 1515110104
29396 \begin_inset Flex Code
29399 \begin_layout Plain Layout
29401 \change_inserted -970929547 1515110104
29409 ] Specifies attribute information to be output with the inner tag, replacing
29411 \begin_inset Quotes eld
29415 \begin_inset Flex Code
29418 \begin_layout Plain Layout
29420 \change_inserted -970929547 1515110104
29429 \begin_inset Quotes erd
29432 in the example above.
29433 This information can be used in further processing of the DocBook files.
29437 \begin_layout Description
29439 \change_inserted -970929547 1515110906
29440 \begin_inset Flex Code
29443 \begin_layout Plain Layout
29445 \change_inserted -970929547 1515110104
29454 \begin_inset Flex Code
29457 \begin_layout Plain Layout
29459 \change_inserted -970929547 1515110104
29467 ] The tag to be used for the inner tag within the inset, replacing
29468 \begin_inset Quotes eld
29472 \begin_inset Flex Code
29475 \begin_layout Plain Layout
29477 \change_inserted -970929547 1515110104
29486 \begin_inset Quotes erd
29489 in the example above.
29491 \begin_inset Flex Code
29494 \begin_layout Plain Layout
29496 \change_inserted -970929547 1515110791
29504 , indicating that there is no inner tag: content is directly output without
29506 \change_inserted 1075283030 1597699904
29510 \begin_layout Description
29512 \change_inserted 1075283030 1597699904
29513 \begin_inset Flex Code
29516 \begin_layout Plain Layout
29518 \change_inserted 1075283030 1597699904
29519 DocBookInnerTagType
29527 \begin_inset Flex Code
29530 \begin_layout Plain Layout
29532 \change_inserted 1075283030 1597699904
29533 block, paragraph, inline
29540 ] The new-line policy for this tag, see Section
29541 \begin_inset space ~
29545 \begin_inset CommandInset ref
29547 reference "subsec:DocBook-New-line-policy"
29560 \begin_layout Description
29562 \change_inserted -970929547 1515110753
29563 \begin_inset Flex Code
29566 \begin_layout Plain Layout
29568 \change_inserted -970929547 1515110665
29577 \begin_inset Flex Code
29580 \begin_layout Plain Layout
29582 \change_inserted -970929547 1515110661
29590 ] Specifies the tag that corresponds to this kind of section.
29591 This parameter only makes sense for sectioning elements (part, chapter,
29593 The default value is
29594 \begin_inset Flex Code
29597 \begin_layout Plain Layout
29599 \change_inserted -970929547 1515110721
29607 , and is only overridden when DocBook uses something else for sectioning
29609 \change_inserted 1075283030 1597699921
29611 \change_inserted -970929547 1515110753
29612 parts and chapters of a book).
29618 \begin_layout Description
29620 \change_inserted -970929547 1515110811
29621 \begin_inset Flex Code
29624 \begin_layout Plain Layout
29626 \change_inserted -970929547 1496612023
29635 \begin_inset Flex Code
29638 \begin_layout Plain Layout
29640 \change_inserted -970929547 1496610966
29648 ] The tag to be used for this inset, replacing
29649 \begin_inset Quotes eld
29653 \begin_inset Flex Code
29656 \begin_layout Plain Layout
29658 \change_inserted -970929547 1496612033
29667 \begin_inset Quotes erd
29670 in the example above.
29671 The default is the name of the float and always needs to be changed, as
29672 DocBook provides no generic inset tag.
29673 \change_inserted 1075283030 1597699924
29677 \begin_layout Description
29679 \change_inserted 1075283030 1597699924
29680 \begin_inset Flex Code
29683 \begin_layout Plain Layout
29685 \change_inserted 1075283030 1597699924
29694 \begin_inset Flex Code
29697 \begin_layout Plain Layout
29699 \change_inserted 1075283030 1597699924
29700 block, paragraph, inline
29707 ] The new-line policy for this tag, see Section
29708 \begin_inset space ~
29712 \begin_inset CommandInset ref
29714 reference "subsec:DocBook-New-line-policy"
29727 \begin_layout Description
29729 \change_inserted -970929547 1515110832
29730 \begin_inset Flex Code
29733 \begin_layout Plain Layout
29735 \change_inserted -970929547 1515110822
29744 \begin_inset Flex Code
29747 \begin_layout Plain Layout
29749 \change_inserted -970929547 1515110811
29757 ] Specifies attribute information to be output with the outer tag, replacing
29759 \begin_inset Quotes eld
29763 \begin_inset Flex Code
29766 \begin_layout Plain Layout
29768 \change_inserted -970929547 1515110845
29777 \begin_inset Quotes erd
29780 in the example above.
29781 This information can be used in further processing of the DocBook files.
29785 \begin_layout Description
29787 \change_inserted -970929547 1515110917
29788 \begin_inset Flex Code
29791 \begin_layout Plain Layout
29793 \change_inserted -970929547 1515110826
29802 \begin_inset Flex Code
29805 \begin_layout Plain Layout
29807 \change_inserted -970929547 1515110811
29815 ] The tag to be used for the wrapper tag around the inset, replacing
29816 \begin_inset Quotes eld
29820 \begin_inset Flex Code
29823 \begin_layout Plain Layout
29825 \change_inserted -970929547 1515110842
29834 \begin_inset Quotes erd
29837 in the example above.
29839 \begin_inset Flex Code
29842 \begin_layout Plain Layout
29844 \change_inserted -970929547 1515110811
29852 , indicating that there is no wrapper tag: tag and content are directly
29854 \change_inserted 1075283030 1597699929
29858 \begin_layout Description
29860 \change_inserted 1075283030 1597699929
29861 \begin_inset Flex Code
29864 \begin_layout Plain Layout
29866 \change_inserted 1075283030 1597699932
29867 DocBookWrapperTagType
29875 \begin_inset Flex Code
29878 \begin_layout Plain Layout
29880 \change_inserted 1075283030 1597699929
29881 block, paragraph, inline
29888 ] The new-line policy for this tag, see Section
29889 \begin_inset space ~
29893 \begin_inset CommandInset ref
29895 reference "subsec:DocBook-New-line-policy"
29908 \begin_layout Subsection
29910 \change_inserted -970929547 1515110040
29914 \begin_layout Standard
29916 \change_inserted -970929547 1496611700
29917 The DocBook output for floats too can be controlled by layout information.
29918 The output has the following form:
29921 \begin_layout LyX-Code
29923 \change_inserted -970929547 1515109700
29927 \begin_layout LyX-Code
29929 \change_inserted -970929547 1515110138
29930 Contents of the float as DocBook.
29933 \begin_layout LyX-Code
29935 \change_inserted -970929547 1496610966
29939 \begin_layout Standard
29941 \change_inserted -970929547 1496611715
29942 The caption, if there is one, is a separate inset and will be output as
29947 \begin_layout Description
29949 \change_inserted -970929547 1515110033
29950 \begin_inset Flex Code
29953 \begin_layout Plain Layout
29955 \change_inserted -970929547 1515109702
29964 \begin_inset Flex Code
29967 \begin_layout Plain Layout
29969 \change_inserted -970929547 1496610966
29977 ] Specifies attribute information to be output with the main tag, replacing
29979 \begin_inset Quotes eld
29983 \begin_inset Flex Code
29986 \begin_layout Plain Layout
29988 \change_inserted -970929547 1515110035
29997 \begin_inset Quotes erd
30000 in the example above.
30001 This information can be used in further processing of the DocBook files.
30005 \begin_layout Description
30007 \change_inserted -970929547 1515110157
30008 \begin_inset Flex Code
30011 \begin_layout Plain Layout
30013 \change_inserted -970929547 1496611782
30022 \begin_inset Flex Code
30025 \begin_layout Plain Layout
30027 \change_inserted -970929547 1496610966
30035 ] The tag to be used for this float, replacing
30036 \begin_inset Quotes eld
30040 \begin_inset Flex Code
30043 \begin_layout Plain Layout
30045 \change_inserted -970929547 1496610966
30054 \begin_inset Quotes erd
30057 in the example above.
30058 The default is the name of the float and always needs to be changed, as
30059 DocBook provides no generic float tag.
30062 \begin_layout Subsection
30064 \change_inserted -970929547 1515110157
30065 Bibliography formatting
30068 \begin_layout Standard
30070 \change_deleted 1075283030 1597699984
30072 \change_inserted 1075283030 1597699985
30074 \change_inserted -970929547 1515110187
30076 \change_deleted 1075283030 1597699987
30078 \change_inserted 1075283030 1597699987
30080 \change_inserted -970929547 1515110187
30081 cannot be formatted: all fields are always output in the database-like
30082 DocBook format (equivalent to a BibTeX file)
30083 \change_inserted 1075283030 1597700117
30085 \begin_inset Flex Code
30088 \begin_layout Plain Layout
30090 \change_inserted 1075283030 1597700120
30099 \change_inserted -970929547 1515110187
30101 \change_inserted 1075283030 1597700092
30105 \begin_layout Standard
30107 \change_inserted 1075283030 1597700112
30108 When the bibliographic entries are manually inserted into the LyX document
30109 as Bibliography Items, the user deals with formatting themself: there is
30110 no attempt of parsing what the user wrote, the string is directly used
30112 \begin_inset Flex Code
30115 \begin_layout Plain Layout
30117 \change_inserted 1075283030 1597700076
30131 \begin_layout Chapter
30132 Including External Material
30133 \begin_inset CommandInset label
30135 name "chap:Including-External-Material"
30142 \begin_layout Standard
30143 \begin_inset Box Shadowbox
30153 height_special "totalheight"
30158 backgroundcolor "none"
30161 \begin_layout Plain Layout
30162 WARNING: This portion of the documentation has not been updated for some
30164 We certainly hope that it is still accurate, but there are no guarantees.
30172 \begin_layout Standard
30173 The use of material from sources external to \SpecialChar LyX
30174 is covered in detail in the
30180 This part of the manual covers what needs to happen behind the scenes for
30181 new sorts of material to be included.
30184 \begin_layout Section
30188 \begin_layout Standard
30189 The external material feature is based on the concept of a
30194 A template is a specification of how \SpecialChar LyX
30195 should interface with a certain kind
30197 As bundled, \SpecialChar LyX
30198 comes with predefined templates for Xfig figures, various
30199 raster format images, chess diagrams, and LilyPond music notation.
30200 You can check the actual list by using the menu
30201 \begin_inset Flex Noun
30204 \begin_layout Plain Layout
30205 Insert\SpecialChar menuseparator
30206 File\SpecialChar menuseparator
30213 Furthermore, it is possible to roll your own template to support a specific
30215 Later we'll describe in more detail what is involved, and hopefully you
30216 will submit all the templates you create so we can include them in a later
30221 \begin_layout Standard
30222 Another basic idea of the external material feature is to distinguish between
30223 the original file that serves as a base for final material and the produced
30224 file that is included in your exported or printed document.
30225 For example, consider the case of a figure produced with
30226 \begin_inset Flex Code
30229 \begin_layout Plain Layout
30236 The Xfig application itself works on an original file with the
30237 \begin_inset Flex Code
30240 \begin_layout Plain Layout
30247 Within Xfig, you create and change your figure, and when you are done,
30249 \begin_inset Flex Code
30252 \begin_layout Plain Layout
30259 When you want to include the figure in your document, you invoke
30260 \begin_inset Flex Code
30263 \begin_layout Plain Layout
30269 in order to create a PostScript file that can readily be included in your
30273 \begin_inset Flex Code
30276 \begin_layout Plain Layout
30282 file is the original file, and the PostScript file is the produced file.
30285 \begin_layout Standard
30286 This distinction is important in order to allow updating of the material
30287 while you are in the process of writing the document.
30288 Furthermore, it provides us with the flexibility that is needed to support
30289 multiple export formats.
30290 For instance, in the case of a plain text file, it is not exactly an award-winn
30291 ing idea to include the figure as raw PostScript.
30292 Instead, you would either prefer to just include a reference to the figure
30293 or try to invoke some graphics to ASCII converter to make the final result
30294 look similar to the real graphics.
30295 The external material management allows you to do this, because it is parametri
30296 zed on the different export formats that \SpecialChar LyX
30300 \begin_layout Standard
30301 Besides supporting the production of different products according to the
30302 exported format, it supports tight integration with editing and viewing
30304 In the case of an Xfig figure, you are able to invoke Xfig on the original
30305 file with a single click from within the external material dialog in \SpecialChar LyX
30307 and also preview the produced PostScript file with Ghostview with another
30309 No more fiddling around with the command line and/or file browsers to locate
30310 and manipulate the original or produced files.
30311 In this way, you are finally able to take full advantage of the many different
30312 applications that are relevant to use when you write your documents, and
30313 ultimately be more productive.
30316 \begin_layout Section
30317 The external template configuration files
30320 \begin_layout Standard
30321 It is relatively easy to add custom external template definitions to \SpecialChar LyX
30323 However, be aware that doing this in an careless manner most probably
30327 introduce an easily exploitable security hole.
30328 So before you do this, please read the discussion about security in
30329 \begin_inset CommandInset ref
30331 reference "sec:Security-discussion"
30338 \begin_layout Standard
30339 Having said that, we encourage you to submit any interesting templates that
30344 \begin_layout Standard
30345 The external templates are defined in the
30346 \begin_inset Flex Code
30349 \begin_layout Plain Layout
30355 files that are stored in the
30356 \begin_inset Flex Code
30359 \begin_layout Plain Layout
30360 LyXDir/lib/xtemplates/
30366 Each template is defined in a file of its own.
30367 You can place your own templates in
30368 \begin_inset Flex Code
30371 \begin_layout Plain Layout
30372 UserDir/xtemplates/
30377 or copy existing templates to that directory in order to modify them.
30380 \begin_layout Standard
30381 A typical template looks like this:
30384 \begin_layout LyX-Code
30388 \begin_layout LyX-Code
30389 GuiName "XFig: $$AbsOrRelPathParent$$Basename"
30392 \begin_layout LyX-Code
30396 \begin_layout LyX-Code
30400 \begin_layout LyX-Code
30404 \begin_layout LyX-Code
30408 \begin_layout LyX-Code
30412 \begin_layout LyX-Code
30413 AutomaticProduction true
30416 \begin_layout LyX-Code
30420 \begin_layout LyX-Code
30424 \begin_layout LyX-Code
30428 \begin_layout LyX-Code
30429 TransformCommand Rotate RotationLatexCommand
30432 \begin_layout LyX-Code
30433 TransformCommand Resize ResizeLatexCommand
30436 \begin_layout LyX-Code
30437 Product "$$RotateFront$$ResizeFront
30440 \begin_layout LyX-Code
30445 input{$$AbsOrRelPathMaster$$Basename.pstex_t}
30448 \begin_layout LyX-Code
30449 $$ResizeBack$$RotateBack"
30452 \begin_layout LyX-Code
30456 \begin_layout LyX-Code
30457 UpdateResult "$$AbsPath$$Basename.pstex_t"
30460 \begin_layout LyX-Code
30461 Requirement "graphicx"
30464 \begin_layout LyX-Code
30465 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
30468 \begin_layout LyX-Code
30469 ReferencedFile latex "$$AbsPath$$Basename.eps"
30472 \begin_layout LyX-Code
30473 ReferencedFile dvi "$$AbsPath$$Basename.eps"
30476 \begin_layout LyX-Code
30480 \begin_layout LyX-Code
30484 \begin_layout LyX-Code
30485 TransformCommand Rotate RotationLatexCommand
30488 \begin_layout LyX-Code
30489 TransformCommand Resize ResizeLatexCommand
30492 \begin_layout LyX-Code
30493 Product "$$RotateFront$$ResizeFront
30496 \begin_layout LyX-Code
30501 input{$$AbsOrRelPathMaster$$Basename.pdftex_t}
30504 \begin_layout LyX-Code
30505 $$ResizeBack$$RotateBack"
30508 \begin_layout LyX-Code
30509 UpdateFormat pdftex
30512 \begin_layout LyX-Code
30513 UpdateResult "$$AbsPath$$Basename.pdftex_t"
30516 \begin_layout LyX-Code
30517 Requirement "graphicx"
30520 \begin_layout LyX-Code
30521 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pdftex_t"
30524 \begin_layout LyX-Code
30525 ReferencedFile latex "$$AbsPath$$Basename.pdf"
30528 \begin_layout LyX-Code
30532 \begin_layout LyX-Code
30536 \begin_layout LyX-Code
30537 Product "[XFig: $$FName]"
30540 \begin_layout LyX-Code
30544 \begin_layout LyX-Code
30548 \begin_layout LyX-Code
30549 Product "<graphic fileref=
30551 "$$AbsOrRelPathMaster$$Basename.eps
30556 \begin_layout LyX-Code
30560 \begin_layout LyX-Code
30564 \begin_layout LyX-Code
30565 UpdateResult "$$AbsPath$$Basename.eps"
30568 \begin_layout LyX-Code
30569 ReferencedFile docbook "$$AbsPath$$Basename.eps"
30572 \begin_layout LyX-Code
30573 ReferencedFile docbook-xml "$$AbsPath$$Basename.eps"
30576 \begin_layout LyX-Code
30580 \begin_layout LyX-Code
30584 \begin_layout Standard
30585 As you can see, the template is enclosed in
30586 \begin_inset Flex Code
30589 \begin_layout Plain Layout
30597 \begin_inset Flex Code
30600 \begin_layout Plain Layout
30607 It contains a header specifying some general settings and, for each supported
30608 primary document file format, a section
30609 \begin_inset Flex Code
30612 \begin_layout Plain Layout
30620 \begin_inset Flex Code
30623 \begin_layout Plain Layout
30632 \begin_layout Subsection
30633 The template header
30636 \begin_layout Description
30637 \begin_inset Flex Code
30640 \begin_layout Plain Layout
30641 AutomaticProduction
30642 \begin_inset space ~
30650 Whether the file represented by the template must be generated by \SpecialChar LyX
30652 This command must occur exactly once.
30655 \begin_layout Description
30656 \begin_inset Flex Code
30659 \begin_layout Plain Layout
30661 \begin_inset space ~
30669 A glob pattern that is used in the file dialog to filter out the desired
30671 If there is more than one possible file extension (e.
30672 \begin_inset space \thinspace{}
30676 \begin_inset space \space{}
30680 \begin_inset Flex Code
30683 \begin_layout Plain Layout
30690 \begin_inset Flex Code
30693 \begin_layout Plain Layout
30699 ), use something like
30700 \begin_inset Flex Code
30703 \begin_layout Plain Layout
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 text that is displayed on the button.
30728 This command must occur exactly once.
30731 \begin_layout Description
30732 \begin_inset Flex Code
30735 \begin_layout Plain Layout
30737 \begin_inset space ~
30741 \begin_inset space ~
30749 The help text that is used in the External dialog.
30750 Provide enough information to explain to the user just what the template
30751 can provide him with.
30752 This command must occur exactly once.
30755 \begin_layout Description
30756 \begin_inset Flex Code
30759 \begin_layout Plain Layout
30761 \begin_inset space ~
30769 The file format of the original file.
30770 This must be the name of a format that is known to \SpecialChar LyX
30772 \begin_inset CommandInset ref
30774 reference "sec:Formats"
30780 \begin_inset Quotes eld
30784 \begin_inset Flex Code
30787 \begin_layout Plain Layout
30794 \begin_inset Quotes erd
30797 if the template can handle original files of more than one format.
30799 will attempt to interrogate the file itself in order to deduce its format
30801 This command must occur exactly once.
30804 \begin_layout Description
30805 \begin_inset Flex Code
30808 \begin_layout Plain Layout
30810 \begin_inset space ~
30818 A unique name for the template.
30819 It must not contain substitution macros (see below).
30822 \begin_layout Description
30823 \begin_inset Flex Code
30826 \begin_layout Plain Layout
30828 \begin_inset space ~
30831 Rotate|Resize|Clip|Extra
30836 This command specifies which transformations are supported by this template.
30837 It may occur zero or more times.
30838 This command enables the corresponding tabs in the external dialog.
30840 \begin_inset Flex Code
30843 \begin_layout Plain Layout
30849 command must have either a corresponding
30850 \begin_inset Flex Code
30853 \begin_layout Plain Layout
30860 \begin_inset Flex Code
30863 \begin_layout Plain Layout
30870 \begin_inset Flex Code
30873 \begin_layout Plain Layout
30880 Otherwise the transformation will not be supported by that format.
30883 \begin_layout Subsection
30887 \begin_layout Description
30888 \begin_inset Flex Code
30891 \begin_layout Plain Layout
30893 \begin_inset space ~
30896 LaTeX|PDFLaTeX|PlainText|DocBook|XHTML
30901 The primary document file format that this format definition is for.
30902 Not every template has a sensible representation in all document file formats.
30903 Please define nevertheless a
30904 \begin_inset Flex Code
30907 \begin_layout Plain Layout
30913 section for all templates.
30914 Use a dummy text when no representation is available.
30915 Then you can at least see a reference to the external material in the exported
30919 \begin_layout Description
30920 \begin_inset Flex Code
30923 \begin_layout Plain Layout
30925 \begin_inset space ~
30929 \begin_inset space ~
30937 This command defines an additional macro
30938 \begin_inset Flex Code
30941 \begin_layout Plain Layout
30947 for substitution in
30948 \begin_inset Flex Code
30951 \begin_layout Plain Layout
30959 \begin_inset Flex Code
30962 \begin_layout Plain Layout
30968 itself may contain substitution macros.
30969 The advantage over using
30970 \begin_inset Flex Code
30973 \begin_layout Plain Layout
30980 \begin_inset Flex Code
30983 \begin_layout Plain Layout
30989 is that the substituted value of
30990 \begin_inset Flex Code
30993 \begin_layout Plain Layout
30999 is sanitized so that it is a valid optional argument in the document format.
31000 This command may occur zero or more times.
31003 \begin_layout Description
31004 \begin_inset Flex Code
31007 \begin_layout Plain Layout
31009 \begin_inset space ~
31017 The text that is inserted in the exported document.
31018 This is actually the most important command and can be quite complex.
31019 This command must occur exactly once.
31022 \begin_layout Description
31023 \begin_inset Flex Code
31026 \begin_layout Plain Layout
31028 \begin_inset space ~
31036 This command specifies a preamble snippet that will be included in the
31039 It has to be defined using
31040 \begin_inset Flex Code
31043 \begin_layout Plain Layout
31051 \begin_inset Flex Code
31054 \begin_layout Plain Layout
31061 This command may occur zero or more times.
31064 \begin_layout Description
31065 \begin_inset Flex Code
31068 \begin_layout Plain Layout
31070 \begin_inset space ~
31074 \begin_inset space ~
31082 This command denotes files that are created by the conversion process and
31083 are needed for a particular export format.
31084 If the filename is relative, it is interpreted relative to the master document.
31085 This command may be given zero or more times.
31088 \begin_layout Description
31089 \begin_inset Flex Code
31092 \begin_layout Plain Layout
31094 \begin_inset space ~
31102 The name of a required \SpecialChar LaTeX
31104 The package is included via
31105 \begin_inset Flex Code
31108 \begin_layout Plain Layout
31116 in the \SpecialChar LaTeX
31118 This command may occur zero or more times.
31121 \begin_layout Description
31122 \begin_inset Flex Code
31125 \begin_layout Plain Layout
31127 \begin_inset space ~
31131 \begin_inset space ~
31134 RotationLatexCommand
31139 This command specifies that the built in \SpecialChar LaTeX
31140 command should be used for rotation.
31141 This command may occur once or not at all.
31144 \begin_layout Description
31145 \begin_inset Flex Code
31148 \begin_layout Plain Layout
31150 \begin_inset space ~
31154 \begin_inset space ~
31162 This command specifies that the built in \SpecialChar LaTeX
31163 command should be used for resizing.
31164 This command may occur once or not at all.
31167 \begin_layout Description
31168 \begin_inset Flex Code
31171 \begin_layout Plain Layout
31173 \begin_inset space ~
31177 \begin_inset space ~
31180 RotationLatexOption
31185 This command specifies that rotation is done via an optional argument.
31186 This command may occur once or not at all.
31189 \begin_layout Description
31190 \begin_inset Flex Code
31193 \begin_layout Plain Layout
31195 \begin_inset space ~
31199 \begin_inset space ~
31207 This command specifies that resizing is done via an optional argument.
31208 This command may occur once or not at all.
31211 \begin_layout Description
31212 \begin_inset Flex Code
31215 \begin_layout Plain Layout
31217 \begin_inset space ~
31221 \begin_inset space ~
31229 This command specifies that clipping is done via an optional argument.
31230 This command may occur once or not at all.
31233 \begin_layout Description
31234 \begin_inset Flex Code
31237 \begin_layout Plain Layout
31239 \begin_inset space ~
31243 \begin_inset space ~
31251 This command specifies that an extra optional argument is used.
31252 This command may occur once or not at all.
31255 \begin_layout Description
31256 \begin_inset Flex Code
31259 \begin_layout Plain Layout
31261 \begin_inset space ~
31269 The file format of the converted file.
31270 This must be the name of a format that is known to \SpecialChar LyX
31272 \begin_inset Flex Noun
31275 \begin_layout Plain Layout
31276 Tools\SpecialChar menuseparator
31277 Preferences\SpecialChar menuseparator
31278 File Handling\SpecialChar menuseparator
31285 This command must occur exactly once.
31286 If the resulting file format is PDF, you need to specify the format
31287 \begin_inset Flex Code
31290 \begin_layout Plain Layout
31297 This is the PDF format used for including graphics.
31298 The other defined PDF formats are for document export.
31301 \begin_layout Description
31302 \begin_inset Flex Code
31305 \begin_layout Plain Layout
31307 \begin_inset space ~
31315 The file name of the converted file.
31316 The file name must be absolute.
31317 This command must occur exactly once.
31320 \begin_layout Subsection
31321 Preamble definitions
31324 \begin_layout Standard
31325 The external template configuration file may contain additional preamble
31326 definitions enclosed by
31327 \begin_inset Flex Code
31330 \begin_layout Plain Layout
31338 \begin_inset Flex Code
31341 \begin_layout Plain Layout
31348 They can be used by the templates in the
31349 \begin_inset Flex Code
31352 \begin_layout Plain Layout
31361 \begin_layout Section
31362 The substitution mechanism
31365 \begin_layout Standard
31366 When the external material facility invokes an external program, it is done
31367 on the basis of a command defined in the template configuration file.
31368 These commands can contain various macros that are expanded before execution.
31369 Execution always take place in the directory of the containing document.
31372 \begin_layout Standard
31373 Also, whenever external material is to be displayed, the name will be produced
31374 by the substitution mechanism, and most other commands in the template
31375 definition support substitution as well.
31378 \begin_layout Standard
31379 The available macros are the following:
31382 \begin_layout Description
31383 \begin_inset Flex Code
31386 \begin_layout Plain Layout
31387 $$AbsOrRelPathMaster
31392 The file path, absolute or relative to the master \SpecialChar LyX
31396 \begin_layout Description
31397 \begin_inset Flex Code
31400 \begin_layout Plain Layout
31401 $$AbsOrRelPathParent
31406 The file path, absolute or relative to the \SpecialChar LyX
31410 \begin_layout Description
31411 \begin_inset Flex Code
31414 \begin_layout Plain Layout
31420 The absolute file path.
31423 \begin_layout Description
31424 \begin_inset Flex Code
31427 \begin_layout Plain Layout
31433 The filename without path and without the extension.
31436 \begin_layout Description
31437 \begin_inset Flex Code
31440 \begin_layout Plain Layout
31442 \begin_inset Quotes eld
31446 \begin_inset Quotes erd
31454 This macro will expand to the contents of the file with the name
31455 \begin_inset Flex Code
31458 \begin_layout Plain Layout
31467 \begin_layout Description
31468 \begin_inset Flex Code
31471 \begin_layout Plain Layout
31477 The file extension (including the dot).
31480 \begin_layout Description
31481 \begin_inset Flex Code
31484 \begin_layout Plain Layout
31490 This will be the string
31491 \begin_inset Quotes eld
31495 \begin_inset Quotes erd
31498 if the file is in JPEG format, otherwise it will be the string
31499 \begin_inset Quotes eld
31503 \begin_inset Quotes erd
31507 This is useful to avoid uneeded conversions for output formats that support
31508 both PNG and JPEG fomats.
31509 The predefined RasterImage template uses this macro for the pdf\SpecialChar TeX
31514 \begin_layout Description
31515 \begin_inset Flex Code
31518 \begin_layout Plain Layout
31524 The filename of the file specified in the external material dialog.
31525 This is either an absolute name, or it is relative to the \SpecialChar LyX
31529 \begin_layout Description
31530 \begin_inset Flex Code
31533 \begin_layout Plain Layout
31540 \begin_inset Flex Code
31543 \begin_layout Plain Layout
31549 (absolute name or relative to the \SpecialChar LyX
31553 \begin_layout Description
31554 \begin_inset Flex Code
31557 \begin_layout Plain Layout
31563 The file path, relative to the master \SpecialChar LyX
31567 \begin_layout Description
31568 \begin_inset Flex Code
31571 \begin_layout Plain Layout
31577 The file path, relative to the \SpecialChar LyX
31581 \begin_layout Description
31582 \begin_inset Flex Code
31585 \begin_layout Plain Layout
31591 This macro will expand to the absolute path of the system directory.
31592 This is typically used to point to the various helper scripts that are
31593 bundled with \SpecialChar LyX
31597 \begin_layout Description
31598 \begin_inset Flex Code
31601 \begin_layout Plain Layout
31607 A name and full path to a temporary file which will be automatically deleted
31608 whenever the containing document is closed, or the external material insertion
31612 \begin_layout Standard
31613 All path macros contain a trailing directory separator, so you can construct
31615 \begin_inset space \thinspace{}
31619 \begin_inset space \space{}
31622 the absolute filename with
31623 \begin_inset Flex Code
31626 \begin_layout Plain Layout
31627 $$AbsPath$$Basename$$Extension
31635 \begin_layout Standard
31636 The macros above are substituted in all commands unless otherwise noted.
31638 \begin_inset Flex Code
31641 \begin_layout Plain Layout
31647 supports additionally the following substitutions if they are enabled by
31649 \begin_inset Flex Code
31652 \begin_layout Plain Layout
31659 \begin_inset Flex Code
31662 \begin_layout Plain Layout
31671 \begin_layout Description
31672 \begin_inset Flex Code
31675 \begin_layout Plain Layout
31681 The front part of the resize command.
31684 \begin_layout Description
31685 \begin_inset Flex Code
31688 \begin_layout Plain Layout
31694 The back part of the resize command.
31697 \begin_layout Description
31698 \begin_inset Flex Code
31701 \begin_layout Plain Layout
31707 The front part of the rotation command.
31710 \begin_layout Description
31711 \begin_inset Flex Code
31714 \begin_layout Plain Layout
31720 The back part of the rotation command.
31723 \begin_layout Standard
31724 The value string of the
31725 \begin_inset Flex Code
31728 \begin_layout Plain Layout
31734 command supports additionally the following substitutions if they are enabled
31736 \begin_inset Flex Code
31739 \begin_layout Plain Layout
31746 \begin_inset Flex Code
31749 \begin_layout Plain Layout
31758 \begin_layout Description
31759 \begin_inset Flex Code
31762 \begin_layout Plain Layout
31771 \begin_layout Description
31772 \begin_inset Flex Code
31775 \begin_layout Plain Layout
31784 \begin_layout Description
31785 \begin_inset Flex Code
31788 \begin_layout Plain Layout
31797 \begin_layout Description
31798 \begin_inset Flex Code
31801 \begin_layout Plain Layout
31807 The rotation option.
31810 \begin_layout Standard
31811 You may ask why there are so many path macros.
31812 There are mainly two reasons:
31815 \begin_layout Enumerate
31816 Relative and absolute file names should remain relative or absolute, respectivel
31818 Users may have reasons to prefer either form.
31819 Relative names are useful for portable documents that should work on different
31820 machines, for example.
31821 Absolute names may be required by some programs.
31824 \begin_layout Enumerate
31826 treats relative file names differently than \SpecialChar LyX
31827 and other programs in nested
31829 For \SpecialChar LyX
31830 , a relative file name is always relative to the document that contains
31832 For \SpecialChar LaTeX
31833 , it is always relative to the master document.
31834 These two definitions are identical if you have only one document, but
31835 differ if you have a master document that includes part documents.
31836 That means that relative filenames must be transformed when presented to
31839 Fortunately \SpecialChar LyX
31840 does this automatically for you if you choose the right macros.
31843 \begin_layout Standard
31844 So which path macro should be used in new template definitions? The rule
31848 \begin_layout Itemize
31850 \begin_inset Flex Code
31853 \begin_layout Plain Layout
31859 if an absolute path is required.
31862 \begin_layout Itemize
31864 \begin_inset Flex Code
31867 \begin_layout Plain Layout
31868 $$AbsOrRelPathMaster
31873 if the substituted string is some kind of \SpecialChar LaTeX
31877 \begin_layout Itemize
31879 \begin_inset Flex Code
31882 \begin_layout Plain Layout
31883 $$AbsOrRelPathParent
31888 in order to preserve the user's choice.
31891 \begin_layout Standard
31892 There are special cases where this rule does not work and e.
31893 \begin_inset space \thinspace{}
31897 \begin_inset space \space{}
31900 relative names are needed, but normally it will work just fine.
31901 One example for such a case is the command
31902 \begin_inset Flex Code
31905 \begin_layout Plain Layout
31906 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
31911 in the XFig template above: We can't use the absolute name because the
31913 \begin_inset Flex Code
31916 \begin_layout Plain Layout
31922 files needs the relative name in order to rewrite the file content.
31925 \begin_layout Section
31926 Security discussion
31927 \begin_inset CommandInset label
31929 name "sec:Security-discussion"
31936 \begin_layout Standard
31937 The external material feature interfaces with a lot of external programs
31938 and does so automatically, so we have to consider the security implications
31940 In particular, since you have the option of including your own filenames
31941 and/or parameter strings and those are expanded into a command, it seems
31942 that it would be possible to create a malicious document which executes
31943 arbitrary commands when a user views or prints the document.
31944 This is something we definitely want to avoid.
31947 \begin_layout Standard
31948 However, since the external program commands are specified in the template
31949 configuration file only, there are no security issues if \SpecialChar LyX
31950 is properly configure
31951 d with safe templates only.
31952 This is so because the external programs are invoked with the
31953 \begin_inset Flex Code
31956 \begin_layout Plain Layout
31962 -system call rather than the
31963 \begin_inset Flex Code
31966 \begin_layout Plain Layout
31972 system-call, so it's not possible to execute arbitrary commands from the
31973 filename or parameter section via the shell.
31976 \begin_layout Standard
31977 This also implies that you are restricted in what command strings you can
31978 use in the external material templates.
31979 In particular, pipes and redirection are not readily available.
31980 This has to be so if \SpecialChar LyX
31981 should remain safe.
31982 If you want to use some of the shell features, you should write a safe
31983 script to do this in a controlled manner, and then invoke the script from
31984 the command string.
31988 \begin_layout Standard
31989 It is possible to design a template that interacts directly with the shell,
31990 but since this would allow a malicious user to execute arbitrary commands
31991 by writing clever filenames and/or parameters, we generally recommend that
31992 you only use safe scripts that work with the
31993 \begin_inset Flex Code
31996 \begin_layout Plain Layout
32002 system call in a controlled manner.
32003 Of course, for use in a controlled environment, it can be tempting to just
32004 fall back to use ordinary shell scripts.
32005 If you do so, be aware that you
32009 provide an easily exploitable security hole in your system.
32010 Of course it stands to reason that such unsafe templates will never be
32011 included in the standard \SpecialChar LyX
32012 distribution, although we do encourage people
32013 to submit new templates in the open source tradition.
32014 But \SpecialChar LyX
32015 as shipped from the official distribution channels will never have
32019 \begin_layout Standard
32020 Including external material provides a lot of power, and you have to be
32021 careful not to introduce security hazards with this power.
32022 A subtle error in a single line in an innocent looking script can open
32023 the door to huge security problems.
32024 So if you do not fully understand the issues, we recommend that you consult
32025 a knowledgeable security professional or the \SpecialChar LyX
32026 development team if you have
32027 any questions about whether a given template is safe or not.
32028 And do this before you use it in an uncontrolled environment.
32031 \begin_layout Chapter
32033 List of supported \SpecialChar LyX
32034 functions to be used in layouts
32035 \begin_inset CommandInset label
32037 name "chap:List-of-functions"
32044 \begin_layout Standard
32046 \begin_inset Tabular
32047 <lyxtabular version="3" rows="11" columns="8">
32048 <features tabularvalignment="middle">
32049 <column alignment="left" valignment="top">
32050 <column alignment="left" valignment="top">
32051 <column alignment="left" valignment="top">
32052 <column alignment="left" valignment="top">
32053 <column alignment="left" valignment="top">
32054 <column alignment="left" valignment="top">
32055 <column alignment="left" valignment="top">
32056 <column alignment="left" valignment="top">
32058 <cell alignment="left" valignment="top" usebox="none">
32061 \begin_layout Plain Layout
32067 <cell alignment="left" valignment="top" usebox="none">
32070 \begin_layout Plain Layout
32076 <cell alignment="left" valignment="top" usebox="none">
32079 \begin_layout Plain Layout
32085 <cell alignment="left" valignment="top" usebox="none">
32088 \begin_layout Plain Layout
32094 <cell alignment="center" valignment="top" usebox="none">
32097 \begin_layout Plain Layout
32103 <cell alignment="center" valignment="top" usebox="none">
32106 \begin_layout Plain Layout
32112 <cell alignment="center" valignment="top" usebox="none">
32115 \begin_layout Plain Layout
32121 <cell alignment="center" valignment="top" usebox="none">
32124 \begin_layout Plain Layout
32132 <cell alignment="left" valignment="top" usebox="none">
32135 \begin_layout Plain Layout
32141 <cell alignment="left" valignment="top" usebox="none">
32144 \begin_layout Plain Layout
32150 <cell alignment="left" valignment="top" usebox="none">
32153 \begin_layout Plain Layout
32159 <cell alignment="left" valignment="top" usebox="none">
32162 \begin_layout Plain Layout
32168 <cell alignment="center" valignment="top" usebox="none">
32171 \begin_layout Plain Layout
32177 <cell alignment="center" valignment="top" usebox="none">
32180 \begin_layout Plain Layout
32186 <cell alignment="center" valignment="top" usebox="none">
32189 \begin_layout Plain Layout
32195 <cell alignment="center" valignment="top" usebox="none">
32198 \begin_layout Plain Layout
32206 <cell alignment="left" valignment="top" usebox="none">
32209 \begin_layout Plain Layout
32215 <cell alignment="left" valignment="top" usebox="none">
32218 \begin_layout Plain Layout
32224 <cell alignment="left" valignment="top" usebox="none">
32227 \begin_layout Plain Layout
32233 <cell alignment="left" valignment="top" usebox="none">
32236 \begin_layout Plain Layout
32242 <cell alignment="center" valignment="top" usebox="none">
32245 \begin_layout Plain Layout
32251 <cell alignment="center" valignment="top" usebox="none">
32254 \begin_layout Plain Layout
32260 <cell alignment="center" valignment="top" usebox="none">
32263 \begin_layout Plain Layout
32269 <cell alignment="center" valignment="top" usebox="none">
32272 \begin_layout Plain Layout
32280 <cell alignment="left" valignment="top" usebox="none">
32283 \begin_layout Plain Layout
32289 <cell alignment="left" valignment="top" usebox="none">
32292 \begin_layout Plain Layout
32298 <cell alignment="left" valignment="top" usebox="none">
32301 \begin_layout Plain Layout
32307 <cell alignment="left" valignment="top" usebox="none">
32310 \begin_layout Plain Layout
32316 <cell alignment="center" valignment="top" usebox="none">
32319 \begin_layout Plain Layout
32325 <cell alignment="center" valignment="top" usebox="none">
32328 \begin_layout Plain Layout
32334 <cell alignment="center" valignment="top" usebox="none">
32337 \begin_layout Plain Layout
32343 <cell alignment="center" valignment="top" usebox="none">
32346 \begin_layout Plain Layout
32354 <cell alignment="left" valignment="top" usebox="none">
32357 \begin_layout Plain Layout
32363 <cell alignment="left" valignment="top" usebox="none">
32366 \begin_layout Plain Layout
32372 <cell alignment="left" valignment="top" usebox="none">
32375 \begin_layout Plain Layout
32381 <cell alignment="left" valignment="top" usebox="none">
32384 \begin_layout Plain Layout
32390 <cell alignment="center" valignment="top" usebox="none">
32393 \begin_layout Plain Layout
32399 <cell alignment="center" valignment="top" usebox="none">
32402 \begin_layout Plain Layout
32408 <cell alignment="center" valignment="top" usebox="none">
32411 \begin_layout Plain Layout
32417 <cell alignment="center" valignment="top" usebox="none">
32420 \begin_layout Plain Layout
32428 <cell alignment="left" valignment="top" usebox="none">
32431 \begin_layout Plain Layout
32437 <cell alignment="left" valignment="top" usebox="none">
32440 \begin_layout Plain Layout
32446 <cell alignment="left" valignment="top" usebox="none">
32449 \begin_layout Plain Layout
32455 <cell alignment="left" valignment="top" usebox="none">
32458 \begin_layout Plain Layout
32464 <cell alignment="center" valignment="top" usebox="none">
32467 \begin_layout Plain Layout
32473 <cell alignment="center" valignment="top" usebox="none">
32476 \begin_layout Plain Layout
32482 <cell alignment="center" valignment="top" usebox="none">
32485 \begin_layout Plain Layout
32491 <cell alignment="center" valignment="top" usebox="none">
32494 \begin_layout Plain Layout
32502 <cell alignment="left" valignment="top" usebox="none">
32505 \begin_layout Plain Layout
32511 <cell alignment="left" valignment="top" usebox="none">
32514 \begin_layout Plain Layout
32520 <cell alignment="left" valignment="top" usebox="none">
32523 \begin_layout Plain Layout
32529 <cell alignment="left" valignment="top" usebox="none">
32532 \begin_layout Plain Layout
32538 <cell alignment="center" valignment="top" usebox="none">
32541 \begin_layout Plain Layout
32547 <cell alignment="center" valignment="top" usebox="none">
32550 \begin_layout Plain Layout
32556 <cell alignment="center" valignment="top" usebox="none">
32559 \begin_layout Plain Layout
32565 <cell alignment="center" valignment="top" usebox="none">
32568 \begin_layout Plain Layout
32576 <cell alignment="left" valignment="top" usebox="none">
32579 \begin_layout Plain Layout
32585 <cell alignment="left" valignment="top" usebox="none">
32588 \begin_layout Plain Layout
32594 <cell alignment="left" valignment="top" usebox="none">
32597 \begin_layout Plain Layout
32603 <cell alignment="left" valignment="top" usebox="none">
32606 \begin_layout Plain Layout
32612 <cell alignment="center" valignment="top" usebox="none">
32615 \begin_layout Plain Layout
32621 <cell alignment="center" valignment="top" usebox="none">
32624 \begin_layout Plain Layout
32630 <cell alignment="center" valignment="top" usebox="none">
32633 \begin_layout Plain Layout
32639 <cell alignment="center" valignment="top" usebox="none">
32642 \begin_layout Plain Layout
32650 <cell alignment="left" valignment="top" usebox="none">
32653 \begin_layout Plain Layout
32659 <cell alignment="left" valignment="top" usebox="none">
32662 \begin_layout Plain Layout
32668 <cell alignment="left" valignment="top" usebox="none">
32671 \begin_layout Plain Layout
32677 <cell alignment="left" valignment="top" usebox="none">
32680 \begin_layout Plain Layout
32686 <cell alignment="center" valignment="top" usebox="none">
32689 \begin_layout Plain Layout
32695 <cell alignment="center" valignment="top" usebox="none">
32698 \begin_layout Plain Layout
32704 <cell alignment="center" valignment="top" usebox="none">
32707 \begin_layout Plain Layout
32713 <cell alignment="center" valignment="top" usebox="none">
32716 \begin_layout Plain Layout
32724 <cell alignment="left" valignment="top" usebox="none">
32727 \begin_layout Plain Layout
32733 <cell alignment="left" valignment="top" usebox="none">
32736 \begin_layout Plain Layout
32742 <cell alignment="left" valignment="top" usebox="none">
32745 \begin_layout Plain Layout
32751 <cell alignment="left" valignment="top" usebox="none">
32754 \begin_layout Plain Layout
32760 <cell alignment="center" valignment="top" usebox="none">
32763 \begin_layout Plain Layout
32769 <cell alignment="center" valignment="top" usebox="none">
32772 \begin_layout Plain Layout
32778 <cell alignment="center" valignment="top" usebox="none">
32781 \begin_layout Plain Layout
32787 <cell alignment="center" valignment="top" usebox="none">
32790 \begin_layout Plain Layout
32798 <cell alignment="center" valignment="top" usebox="none">
32801 \begin_layout Plain Layout
32807 <cell alignment="center" valignment="top" usebox="none">
32810 \begin_layout Plain Layout
32816 <cell alignment="center" valignment="top" usebox="none">
32819 \begin_layout Plain Layout
32825 <cell alignment="center" valignment="top" usebox="none">
32828 \begin_layout Plain Layout
32834 <cell alignment="center" valignment="top" usebox="none">
32837 \begin_layout Plain Layout
32843 <cell alignment="center" valignment="top" usebox="none">
32846 \begin_layout Plain Layout
32852 <cell alignment="center" valignment="top" usebox="none">
32855 \begin_layout Plain Layout
32861 <cell alignment="center" valignment="top" usebox="none">
32864 \begin_layout Plain Layout
32878 \begin_layout Chapter
32879 Names of available colors to be used in layouts
32880 \begin_inset CommandInset label
32882 name "chap:Names-of-colors"
32889 \begin_layout Standard
32890 The colors listed below are the standard colors and those that you can adjust
32891 in the \SpecialChar LyX
32895 \begin_layout Section
32899 \begin_layout Standard
32900 The following are no real colors, but rather act on color definitions:
32903 \begin_layout Description
32904 ignore The color is ignored
32907 \begin_layout Description
32908 inherit The color is inherited
32911 \begin_layout Description
32924 No particular color – clear or default
32927 \begin_layout Section
32931 \begin_layout Standard
32932 These are fixed colors that cannot be customized
32933 \change_inserted -712698321 1607683177
32939 use these colors in layout definitions, since they will not work well with
32940 some color themes (such as dark themes)
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 Description
32973 \begin_layout Description
32977 \begin_layout Description
32981 \begin_layout Description
32985 \begin_layout Description
32989 \begin_layout Description
32993 \begin_layout Description
32997 \begin_layout Description
33001 \begin_layout Description
33005 \begin_layout Description
33009 \begin_layout Description
33013 \begin_layout Description
33017 \begin_layout Description
33021 \begin_layout Section
33025 \begin_layout Standard
33026 These are the colors allocated to specific elements in
33029 arg "dialog-show prefs"
33035 \begin_layout Description
33036 added_space Added space color
33039 \begin_layout Description
33040 addedtext Added text color
33043 \begin_layout Description
33044 appendix Appendix marker color
33047 \begin_layout Description
33048 background Background color
33051 \begin_layout Description
33052 bottomarea Bottom area color
33055 \begin_layout Description
33056 branchlabel Label color for branches
33059 \begin_layout Description
33060 buttonbg Color used for button background
33063 \begin_layout Description
33064 buttonframe Color for inset button frames
33067 \begin_layout Description
33068 buttonhoverbg Color used for button background under focus
33071 \begin_layout Description
33072 changebar Changebar color
33075 \begin_layout Description
33076 changedtextauthor1 Changed text color author 1
33079 \begin_layout Description
33080 changedtextauthor2 Changed text color author 2
33083 \begin_layout Description
33084 changedtextauthor3 Changed text color author 3
33087 \begin_layout Description
33088 changedtextauthor4 Changed text color author 4
33091 \begin_layout Description
33092 changedtextauthor5 Changed text color author 5
33095 \begin_layout Description
33096 collapsible Collapsible insets text color
33099 \begin_layout Description
33100 collapsibleframe Collapsible insets framecolor
33103 \begin_layout Description
33104 command Text color for command insets
33107 \begin_layout Description
33108 commandbg Background color for command insets
33111 \begin_layout Description
33112 commandframe Frame color for command insets
33115 \begin_layout Description
33116 comment Label color for comments
33119 \begin_layout Description
33120 commentbg Background color of comments
33123 \begin_layout Description
33124 cursor Cursor color
33127 \begin_layout Description
33128 deletedtext Deleted text color
33131 \begin_layout Description
33132 deletedtextmodifier Deleted text modifying color
33135 \begin_layout Description
33136 depthbar Color for the depth bars in the margin
33139 \begin_layout Description
33140 eolmarker End of line marker color
33143 \begin_layout Description
33144 error Color of the \SpecialChar LaTeX
33148 \begin_layout Description
33149 footlabel Label color for footnotes
33152 \begin_layout Description
33153 foreground Foreground color
33156 \begin_layout Description
33157 graphicsbg Graphics inset background color
33160 \begin_layout Description
33161 greyedoutbg Background color of greyedout inset
33164 \begin_layout Description
33165 greyedoutlabel Label color for greyedout insets
33168 \begin_layout Description
33169 greyedouttext Color for greyedout inset text
33172 \begin_layout Description
33173 indexlabel Label color for index insets
33176 \begin_layout Description
33177 inlinecompletion Inline completion color
33180 \begin_layout Description
33181 insetbg Inset marker background color
33184 \begin_layout Description
33185 insetframe Inset marker frame color
33188 \begin_layout Description
33189 language Color for marking foreign language words
33192 \begin_layout Description
33193 latex Text color in \SpecialChar LaTeX
33197 \begin_layout Description
33198 listingsbg Background color of listings inset
33201 \begin_layout Description
33202 marginlabel Label color for margin notes
33205 \begin_layout Description
33206 math Math inset text color
33209 \begin_layout Description
33210 mathbg Math inset background color
33213 \begin_layout Description
33214 mathcorners Math inset frame color not under focus
33217 \begin_layout Description
33218 mathframe Math inset frame color under focus
33221 \begin_layout Description
33222 mathline Math line color
33225 \begin_layout Description
33226 mathmacrobg Macro math inset background color
33229 \begin_layout Description
33230 mathmacroblend Macro math blended color
33233 \begin_layout Description
33234 mathmacroframe Macro math frame color
33237 \begin_layout Description
33238 mathmacrohoverbg Macro math inset background color hovered
33241 \begin_layout Description
33242 mathmacrolabel Macro math label color
33245 \begin_layout Description
33246 mathmacronewarg Macro template color for new parameters
33249 \begin_layout Description
33250 mathmacrooldarg Macro template color for old parameters
33253 \begin_layout Description
33254 newpage New page color
33257 \begin_layout Description
33258 nonunique_inlinecompletion Inline completion color for the non-unique part
33261 \begin_layout Description
33262 note Label color for notes
33265 \begin_layout Description
33266 notebg Background color of notes
33269 \begin_layout Description
33270 pagebreak Page break/line break color
33273 \begin_layout Description
33274 paragraphmarker Color used for the pilcrow sign to mark the end of a paragraph
33277 \begin_layout Description
33278 phantomtext Text color for phantom insets
33281 \begin_layout Description
33282 preview The color used for previews
33285 \begin_layout Description
33286 previewframe Preview frame color
33289 \begin_layout Description
33290 regexpframe Color for regexp frame
33293 \begin_layout Description
33294 scroll Color that indicates when a row can be scrolled
33297 \begin_layout Description
33298 selection Background color of selected text
33301 \begin_layout Description
33302 selectiontext Foreground color of selected text
33305 \begin_layout Description
33306 shadedbg Background color of shaded box
33309 \begin_layout Description
33310 special Special chars text color
33313 \begin_layout Description
33314 tabularline Table line color
33317 \begin_layout Description
33318 tabularonoffline Table line color
33319 \change_inserted -712698321 1607682522
33323 \begin_layout Description
33325 \change_inserted -712698321 1607682563
33326 textlabel1 Color 1 of layout and custom inset labels
33329 \begin_layout Description
33331 \change_inserted -712698321 1607682565
33332 textlabel2 Color 2 of layout and custom inset labels
33335 \begin_layout Description
33337 \change_inserted -712698321 1607682568
33338 textlabel3 Color 3 of layout and custom inset labels
33343 \begin_layout Description
33344 urllabel Label color for URL insets
33347 \begin_layout Description
33348 urltext Color for URL inset text