1 #LyX 2.4 created this file. For more info see https://www.lyx.org/
5 \save_transient_properties true
6 \origin /systemlyxdir/doc/
9 % DO NOT ALTER THIS PREAMBLE!!!
11 % This preamble is designed to ensure that this document prints
12 % out as advertised. If you mess with this preamble,
13 % parts of this document may not print out as expected. If you
14 % have problems LaTeXing this file, please contact
15 % the documentation team
16 % email: lyx-docs@lists.lyx.org
18 % the pages of the TOC is numbered roman
19 % and a pdf-bookmark for the TOC is added
20 \let\myTOC\tableofcontents
21 \renewcommand\tableofcontents{%
23 \pdfbookmark[1]{\contentsname}{}
27 % increase link area for cross-references and autoname them,
28 \AtBeginDocument{\renewcommand{\ref}[1]{\mbox{\autoref{#1}}}}
29 \@ifundefined{extrasenglish}{\usepackage[english]{babel}}{}
30 \@ifpackageloaded{babel}{
31 \addto\extrasenglish{%
32 \renewcommand*{\equationautorefname}[1]{}%
33 \renewcommand{\sectionautorefname}{sec.\negthinspace}%
34 \renewcommand{\subsectionautorefname}{sec.\negthinspace}%
35 \renewcommand{\subsubsectionautorefname}{sec.\negthinspace}%
39 \options bibliography=totoc,index=totoc,BCOR7.5mm,titlepage,captions=tableheading
40 \use_default_options false
44 \maintain_unincluded_children no
46 \language_package default
49 \font_roman "lmodern" "default"
50 \font_sans "lmss" "default"
51 \font_typewriter "lmtt" "default"
52 \font_math "auto" "auto"
53 \font_default_family default
54 \use_non_tex_fonts false
58 \font_typewriter_osf false
59 \font_sf_scale 100 100
60 \font_tt_scale 100 100
62 \use_dash_ligatures true
64 \default_output_format pdf2
66 \bibtex_command default
67 \index_command default
71 \pdf_title "LyX Configuration Manual"
72 \pdf_author "LyX Team"
73 \pdf_subject "LyX-documentation Customization"
74 \pdf_keywords "LyX, documentation, customization"
76 \pdf_bookmarksnumbered true
77 \pdf_bookmarksopen true
78 \pdf_bookmarksopenlevel 1
83 \pdf_pdfusetitle false
84 \pdf_quoted_options "linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue,pdfpagelayout=OneColumn, pdfnewwindow=true, pdfstartview=XYZ, plainpages=false"
87 \use_package amsmath 1
88 \use_package amssymb 1
91 \use_package mathdots 1
92 \use_package mathtools 1
94 \use_package stackrel 1
95 \use_package stmaryrd 1
96 \use_package undertilde 1
98 \cite_engine_type default
102 \paperorientation portrait
108 \notefontcolor #0000ff
120 \paragraph_separation indent
121 \paragraph_indentation default
123 \math_indentation default
124 \math_numbering_side default
125 \quotes_style english
129 \paperpagestyle headings
131 \tracking_changes true
132 \output_changes false
134 \postpone_fragile_content false
138 \docbook_table_output 0
139 \author -970929547 "Thibaut Cuvelier"
140 \author -712698321 "Jürgen Spitzmüller"
141 \author -495245474 "Jean-Marc Lasgouttes"
143 \author 232239728 "Owner"
144 \author 731793113 "Richard Kimberly Heck" rikiheck@lyx.org
145 \author 1075283030 "Thibaut"
151 Customizing \SpecialChar LyX
152 : Features for the Advanced User
156 by the \SpecialChar LyX
161 \begin_layout Plain Layout
162 If you have comments or error corrections, please send them to the \SpecialChar LyX
165 \begin_inset CommandInset href
167 target "lyx-docs@lists.lyx.org"
175 \begin_inset Quotes eld
179 \begin_inset Quotes erd
182 in the subject header, and please cc the current maintainer of this file,
184 \change_inserted 5863208 1604930692
188 \change_inserted 5863208 1604930729
190 \change_deleted 5863208 1604930668
199 \begin_inset Newline newline
203 \begin_inset Newline newline
209 \begin_layout Standard
210 \begin_inset CommandInset toc
211 LatexCommand tableofcontents
218 \begin_layout Standard
219 \begin_inset Note Note
222 \begin_layout Plain Layout
223 Please use change tracking when modifying this document.
224 This makes it easier for our translators to recognize things that have
225 been changed, and it helps the maintainer keep up-to-date with what's been
234 \begin_layout Chapter
238 \begin_layout Standard
239 This manual covers the customization features present in \SpecialChar LyX
241 In it, we discuss issues like keyboard shortcuts, screen previewing options,
242 printer options, sending commands to \SpecialChar LyX
243 via the \SpecialChar LyX
244 Server, internationalization,
245 installing new \SpecialChar LaTeX
246 classes and \SpecialChar LyX
248 We can't possibly hope to touch on everything you can change—our developers
249 add new features faster than we can document them—but we will explain the
250 most common customizations and hopefully point you in the right direction
251 for some of the more obscure ones.
254 \begin_layout Standard
255 \begin_inset Branch OutDated
259 \begin_layout Standard
260 Information from previous versions of this document that now seems to be
261 outdated is contained in the OutDated branch of this document.
262 By default, this information will not appear in the \SpecialChar LaTeX
271 \begin_layout Chapter
276 \begin_layout Standard
277 This chapter aims to help you to find your way through the \SpecialChar LyX
280 Before continuing to read this chapter, you should find out where your
282 library and user directories are by using
283 \begin_inset Flex Noun
286 \begin_layout Plain Layout
287 Help\SpecialChar menuseparator
298 The library directory is the place where \SpecialChar LyX
299 places its system-wide configuration
300 files; the user directory is where you can place your modified versions.
301 We will call the former
302 \begin_inset Flex Code
305 \begin_layout Plain Layout
312 \begin_inset Flex Noun
315 \begin_layout Plain Layout
321 in the remainder of this document.
325 \begin_layout Section
327 \begin_inset Flex Code
330 \begin_layout Plain Layout
339 \begin_layout Standard
340 \begin_inset Flex Code
343 \begin_layout Plain Layout
349 and its sub-directories contain a number of files
350 \change_deleted 232239728 1604787780
353 that can be used to customize \SpecialChar LyX
355 You can change many of these files from within \SpecialChar LyX
357 \begin_inset Flex Noun
360 \begin_layout Plain Layout
361 Tools\SpecialChar menuseparator
368 Most customization that you will want to do in \SpecialChar LyX
369 is possible through this
371 However, many other inner aspects of \SpecialChar LyX
372 can be customized by modifying the
374 \begin_inset Flex Code
377 \begin_layout Plain Layout
384 These files fall in different categories, described in the following subsection
388 \begin_layout Subsection
389 Automatically generated files
392 \begin_layout Standard
394 \begin_inset Flex Noun
397 \begin_layout Plain Layout
403 are generated when you configure \SpecialChar LyX
405 They contain various default values that are
406 \change_inserted 5863208 1604919565
407 automatically detected during reconfiguration.
408 \change_deleted 232239728 1604788241
409 guessed by inspection
411 In general, it is not a good idea to modify them, since they might be overwritt
415 \begin_layout Labeling
416 \labelwidthstring 00.00.0000
417 \begin_inset Flex Code
420 \begin_layout Plain Layout
427 \change_deleted 5863208 1604919950
429 \begin_inset Note Note
432 \begin_layout Plain Layout
434 \change_inserted 232239728 1604853928
435 I capitalized the first word in all of these lists.
436 To me it looks better but it really is a stylistic thing, your call.
437 However if you are not going to capitalize them, the english in some needs
438 to be modified to make it read correctly as a sentence.
446 \change_deleted 232239728 1604853510
448 \change_inserted 232239728 1604853510
451 ontains defaults for various commands.
454 \begin_layout Labeling
455 \labelwidthstring 00.00.0000
456 \begin_inset Flex Code
459 \begin_layout Plain Layout
466 \change_deleted 232239728 1604853512
468 \change_inserted 232239728 1604853512
471 ontains the list of packages that have been recognized by \SpecialChar LyX
473 It is currently unused by the \SpecialChar LyX
474 program itself, but the information extracted,
475 and more, is made available with
476 \begin_inset Flex Noun
479 \begin_layout Plain Layout
480 Help\SpecialChar menuseparator
494 \begin_layout Labeling
495 \labelwidthstring 00.00.0000
496 \begin_inset Flex Code
499 \begin_layout Plain Layout
506 \change_deleted 232239728 1604853515
508 \change_inserted 232239728 1604853515
511 he list of text classes that have been found in your
512 \begin_inset Flex Code
515 \begin_layout Plain Layout
521 directories, along with the associated \SpecialChar LaTeX
522 document class and their description.
525 \begin_layout Labeling
526 \labelwidthstring 00.00.0000
527 \begin_inset Flex Code
530 \begin_layout Plain Layout
537 \change_deleted 232239728 1604853518
539 \change_inserted 232239728 1604853518
542 he list of layout modules found in your
543 \begin_inset Flex Code
546 \begin_layout Plain Layout
555 \begin_layout Labeling
556 \labelwidthstring 00.00.0000
557 \begin_inset Flex Code
560 \begin_layout Plain Layout
567 \change_deleted 232239728 1604853523
569 \change_inserted 232239728 1604853523
572 ists of various sorts of \SpecialChar LaTeX
573 -related files found on your system
576 \begin_layout Labeling
577 \labelwidthstring 00.00.0000
578 \begin_inset Flex Code
581 \begin_layout Plain Layout
582 doc/\SpecialChar LaTeX
588 is automatically generated during configuration from the file
589 \begin_inset Flex Code
592 \begin_layout Plain Layout
600 It contains information on your \SpecialChar LaTeX
604 \begin_layout Subsection
608 \begin_layout Standard
610 \change_deleted 5863208 1604928729
614 \change_inserted 5863208 1604928636
618 \change_inserted 5863208 1604928661
622 \begin_inset Flex Code
625 \begin_layout Plain Layout
632 \change_inserted 5863208 1604928662
634 \change_deleted 5863208 1604928642
638 \change_deleted 5863208 1604928669
640 \begin_inset Flex Code
643 \begin_layout Plain Layout
650 \change_inserted 5863208 1604928680
654 \begin_inset Flex Code
657 \begin_layout Plain Layout
665 \change_deleted 232239728 1604794430
668 exists in both places, the one in
669 \begin_inset Flex Code
672 \begin_layout Plain Layout
681 \begin_layout Labeling
682 \labelwidthstring 00.00.0000
683 \begin_inset Flex Code
686 \begin_layout Plain Layout
693 \change_deleted 232239728 1604794460
695 \change_inserted 232239728 1604794460
698 his directory contains files with the extension
699 \begin_inset Flex Code
702 \begin_layout Plain Layout
708 that define the keybindings used in \SpecialChar LyX
710 If there exists an internationalized version of the bind file named
711 \begin_inset Flex Code
714 \begin_layout Plain Layout
720 , that will be used first.
723 \begin_layout Labeling
724 \labelwidthstring 00.00.0000
725 \begin_inset Flex Code
728 \begin_layout Plain Layout
735 \change_deleted 232239728 1604794478
737 \change_inserted 232239728 1604794478
740 ontains files with the extension
741 \begin_inset Flex Code
744 \begin_layout Plain Layout
750 which define the diverse citation possibilities (natbib, biblatex etc.).
752 \begin_inset CommandInset ref
754 reference "subsec:Cite-Engine-Files"
764 \begin_layout Labeling
765 \labelwidthstring 00.00.0000
766 \begin_inset Flex Code
769 \begin_layout Plain Layout
776 \change_deleted 232239728 1604794483
778 \change_inserted 232239728 1604794486
781 ontains graphics files that can be included in documents.
785 \begin_layout Labeling
786 \labelwidthstring 00.00.0000
787 \begin_inset Flex Code
790 \begin_layout Plain Layout
797 \change_deleted 232239728 1604794492
799 \change_inserted 232239728 1604794492
802 ontains \SpecialChar LyX
803 documentation files (including the one you are currently reading).
805 \begin_inset Flex Code
808 \begin_layout Plain Layout
810 \change_deleted 232239728 1604794660
813 \change_inserted 232239728 1604794661
821 deserves special attention, as noted above.
822 The internationalized help docs are in subdirectories
823 \begin_inset Flex Code
826 \begin_layout Plain Layout
833 \begin_inset Quotes eld
837 \begin_inset Quotes erd
840 is the ISO language code.
842 \begin_inset CommandInset ref
844 reference "cha:Internationalizing-LyX"
851 \begin_layout Labeling
852 \labelwidthstring 00.00.0000
853 \begin_inset Flex Code
856 \begin_layout Plain Layout
863 \change_deleted 232239728 1604794497
865 \change_inserted 232239728 1604794497
868 ontains example files that explain how to use some features.
869 In the file browser, press the
870 \begin_inset Flex Noun
873 \begin_layout Plain Layout
882 \begin_layout Labeling
883 \labelwidthstring 00.00.0000
884 \begin_inset Flex Code
887 \begin_layout Plain Layout
894 \change_deleted 232239728 1604794500
896 \change_inserted 232239728 1604794500
899 ontains image files that are used by the
900 \begin_inset Flex Noun
903 \begin_layout Plain Layout
910 In addition, it also contains the individual icons used in the toolbar
911 and the banners that can be shown when \SpecialChar LyX
915 \begin_layout Labeling
916 \labelwidthstring 00.00.0000
917 \begin_inset Flex Code
920 \begin_layout Plain Layout
927 \change_deleted 232239728 1604794505
929 \change_inserted 232239728 1604794505
932 ontains keyboard keymapping files.
934 \begin_inset CommandInset ref
936 reference "sec:International-Keymap-Stuff"
943 \begin_layout Labeling
944 \labelwidthstring 00.00.0000
945 \begin_inset Flex Code
948 \begin_layout Plain Layout
955 \change_deleted 232239728 1604794508
957 \change_inserted 232239728 1604794508
960 ontains the text class and module files described in
961 \begin_inset CommandInset ref
963 reference "cha:Installing-New-Document"
970 \begin_layout Labeling
971 \labelwidthstring 00.00.0000
972 \begin_inset Flex Code
975 \begin_layout Plain Layout
982 \change_deleted 232239728 1604794513
984 \change_inserted 232239728 1604794513
988 \begin_inset Flex Code
991 \begin_layout Plain Layout
997 Python scripts used to convert between \SpecialChar LyX
999 These can be run from the command line if
1000 \change_deleted 232239728 1604794749
1003 you want to batch-convert files.
1006 \begin_layout Labeling
1007 \labelwidthstring 00.00.0000
1008 \begin_inset Flex Code
1011 \begin_layout Plain Layout
1018 \change_deleted 232239728 1604794516
1020 \change_inserted 232239728 1604794516
1023 ontains some files that demonstrate the capabilities of the
1024 \begin_inset Flex Noun
1027 \begin_layout Plain Layout
1029 \begin_inset space ~
1038 Also contains some scripts used by \SpecialChar LyX
1042 \begin_layout Labeling
1043 \labelwidthstring 00.00.0000
1044 \begin_inset Flex Code
1047 \begin_layout Plain Layout
1054 \change_deleted 232239728 1604794520
1056 \change_inserted 232239728 1604794520
1059 ontains the standard \SpecialChar LyX
1060 template files described in
1061 \begin_inset CommandInset ref
1063 reference "subsec:Creating-Templates"
1070 \begin_layout Labeling
1071 \labelwidthstring 00.00.0000
1072 \begin_inset Flex Code
1075 \begin_layout Plain Layout
1082 \change_deleted 232239728 1604794524
1084 \change_inserted 232239728 1604794524
1087 ontains files with the extension
1088 \begin_inset Flex Code
1091 \begin_layout Plain Layout
1097 that define the user interface to \SpecialChar LyX
1099 That is, the files define which items appear in which menus and the items
1100 appearing on the toolbar.
1103 \begin_layout Labeling
1104 \labelwidthstring 00.00.0000
1105 \begin_inset Flex Code
1108 \begin_layout Plain Layout
1115 \change_deleted 232239728 1604794528
1117 \change_inserted 232239728 1604794528
1120 ontains files with the extension
1121 \begin_inset Flex Code
1124 \begin_layout Plain Layout
1130 which define the templates for the insertion of external material to a
1133 \begin_inset CommandInset ref
1135 reference "chap:Including-External-Material"
1142 \begin_layout Subsection
1143 Files you don't want to modify
1146 \begin_layout Standard
1147 These files are used internally by \SpecialChar LyX
1148 and you generally do not need to modify
1149 them unless you are a developer.
1152 \begin_layout Labeling
1153 \labelwidthstring 00.00.0000
1154 \begin_inset Flex Code
1157 \begin_layout Plain Layout
1164 \change_deleted 232239728 1604797616
1166 \change_inserted 232239728 1604797616
1169 his file contains the list of \SpecialChar LyX
1171 The contents are displayed with the menu entry
1172 \begin_inset Flex Noun
1175 \begin_layout Plain Layout
1176 Help\SpecialChar menuseparator
1178 \begin_inset space ~
1189 \begin_layout Labeling
1190 \labelwidthstring 00.00.0000
1191 \begin_inset Flex Code
1194 \begin_layout Plain Layout
1201 \change_deleted 232239728 1604797620
1203 \change_inserted 232239728 1604797620
1206 his is a \SpecialChar LaTeX
1207 script used during the configuration process.
1208 Do not run directly.
1211 \begin_layout Labeling
1212 \labelwidthstring 00.00.0000
1213 \begin_inset Flex Code
1216 \begin_layout Plain Layout
1223 \change_deleted 232239728 1604797624
1225 \change_inserted 232239728 1604797624
1228 his is a Python script that is used to re-configure \SpecialChar LyX
1230 It creates configuration files in the directory it was run from.
1233 \begin_layout Subsection
1234 Other files needing a line or two
1237 \begin_layout Labeling
1238 \labelwidthstring 00.00.0000
1239 \begin_inset Flex Code
1242 \begin_layout Plain Layout
1249 \change_deleted 232239728 1604797580
1251 \change_inserted 232239728 1604797580
1254 his contains tables describing how different character encodings can be
1258 \begin_layout Labeling
1259 \labelwidthstring 00.00.0000
1260 \begin_inset Flex Code
1263 \begin_layout Plain Layout
1270 \change_deleted 232239728 1604797584
1272 \change_inserted 232239728 1604797584
1275 his file contains a list of all the languages currently supported by \SpecialChar LyX
1279 \begin_layout Labeling
1280 \labelwidthstring 00.00.0000
1281 \begin_inset Flex Code
1284 \begin_layout Plain Layout
1291 \change_deleted 232239728 1604797587
1293 \change_inserted 232239728 1604797587
1296 ontains information about the supported fonts.
1299 \begin_layout Labeling
1300 \labelwidthstring 00.00.0000
1301 \begin_inset Flex Code
1304 \begin_layout Plain Layout
1311 \change_deleted 232239728 1604797591
1313 \change_inserted 232239728 1604797591
1316 his file contains translations for internationalized paragraph styles (see
1318 \begin_inset CommandInset ref
1320 reference "subsec:I18n"
1327 \begin_layout Labeling
1328 \labelwidthstring 00.00.0000
1329 \begin_inset Flex Code
1332 \begin_layout Plain Layout
1339 \change_deleted 232239728 1604797594
1341 \change_inserted 232239728 1604797594
1344 his file contains information about Unicode-encoded glyphs and the way they
1345 are supported by \SpecialChar LyX
1346 via \SpecialChar LaTeX
1350 \begin_layout Section
1351 Your local configuration directory
1354 \begin_layout Standard
1355 Even if you are using \SpecialChar LyX
1356 as an unprivileged user, you might want to change
1358 configuration for your own use.
1360 \begin_inset Flex Code
1363 \begin_layout Plain Layout
1369 directory contains all your personal configuration files.
1370 This is the directory described as
1371 \begin_inset Quotes eld
1375 \begin_inset Quotes erd
1379 \begin_inset Flex Noun
1382 \begin_layout Plain Layout
1383 Help\SpecialChar menuseparator
1385 \begin_inset space ~
1394 This directory is used as a mirror of
1395 \begin_inset Flex Code
1398 \begin_layout Plain Layout
1404 , which means that every file in
1405 \begin_inset Flex Code
1408 \begin_layout Plain Layout
1414 is a replacement for the corresponding file in
1415 \begin_inset Flex Code
1418 \begin_layout Plain Layout
1425 Any configuration file described in the above sections can be placed either
1426 in the system-wide directory, in which case it will affect all users, or
1427 in your local directory for your own use.
1430 \begin_layout Standard
1431 To make things clearer, let's provide a few examples:
1434 \begin_layout Itemize
1435 The preferences set in the
1436 \begin_inset Flex Noun
1439 \begin_layout Plain Layout
1440 Tools\SpecialChar menuseparator
1446 dialog are saved to a file
1447 \begin_inset Flex Code
1450 \begin_layout Plain Layout
1457 \begin_inset Flex Code
1460 \begin_layout Plain Layout
1469 \begin_layout Itemize
1470 When you reconfigure using
1471 \begin_inset Flex Noun
1474 \begin_layout Plain Layout
1475 Tools\SpecialChar menuseparator
1483 \begin_inset Flex Code
1486 \begin_layout Plain Layout
1492 script, and the resulting files are written in your local configuration
1494 This means that any additional text class file that you might have added
1496 \begin_inset Flex Code
1499 \begin_layout Plain Layout
1505 will be added to the list of classes in the
1506 \begin_inset Flex Noun
1509 \begin_layout Plain Layout
1510 Document\SpecialChar menuseparator
1519 \begin_layout Itemize
1520 If you get some updated documentation from
1521 \change_inserted 232239728 1604798171
1525 ftp site and cannot install it because you do not have sysadmin rights
1526 on your system, you can just copy the files
1527 \change_deleted 232239728 1604798193
1529 \change_inserted 232239728 1604798193
1533 \begin_inset Flex Code
1536 \begin_layout Plain Layout
1542 and the items in the
1543 \begin_inset Flex Noun
1546 \begin_layout Plain Layout
1552 menu will open them!
1555 \begin_layout Section
1556 Running \SpecialChar LyX
1557 with multiple configurations
1560 \begin_layout Standard
1561 The configuration freedom of the local configuration directory may not suffice
1562 if you want to have more than one configuration at your disposal.
1563 For example, you may want to
1564 \change_deleted 232239728 1604798238
1567 use different key bindings or printer settings at different times.
1568 You can achieve this by having several such directories.
1569 You then specify which directory to use at run-time.
1572 \begin_layout Standard
1573 Invoking \SpecialChar LyX
1574 with the command line switch
1575 \begin_inset Flex Code
1578 \begin_layout Plain Layout
1588 instructs the program to read the configuration from that directory, and
1589 not from the default directory.
1590 (You can determine the default directory by running \SpecialChar LyX
1592 \begin_inset Flex Code
1595 \begin_layout Plain Layout
1601 switch.) If the specified directory does not exist, \SpecialChar LyX
1603 for you, just like it does for the default directory
1604 \change_deleted 232239728 1604798318
1607 the first time you run the program.
1608 You can modify the configuration options in this additional user directory
1609 exactly as you would for the default directory.
1610 These directories are completely independent (but read on).
1611 Note that setting the environment variable
1612 \begin_inset Flex Code
1615 \begin_layout Plain Layout
1621 to some value has exactly the same effect.
1624 \begin_layout Standard
1625 Having several configurations also requires more maintenance: if you want
1626 to add a new layout to
1627 \begin_inset Flex Code
1630 \begin_layout Plain Layout
1636 which you want available from all your configurations, you must add it
1637 to each directory separately.
1638 You can avoid this with the following trick: after \SpecialChar LyX
1639 creates the additional
1640 directory, most of the subdirectories (see above) are empty.
1641 If you want the new configuration to mirror an existing one, replace the
1642 empty subdirectory with a symbolic link to the matching subdirectory in
1643 the existing configuration.
1645 \begin_inset Flex Code
1648 \begin_layout Plain Layout
1654 subdirectory, however, since it contains a file written by the configuration
1655 script (also accessible through
1656 \begin_inset Flex Noun
1659 \begin_layout Plain Layout
1660 Tools\SpecialChar menuseparator
1666 ) which is configuration
1667 \change_deleted 232239728 1604798083
1669 \change_inserted 232239728 1604798100
1675 \begin_layout Chapter
1676 The Preferences dialog
1679 \begin_layout Standard
1680 All options of the preferences dialog are described in the Appendix
1682 The Preferences Dialog
1689 For some options you might find here more details.
1692 \begin_layout Section
1694 \begin_inset CommandInset label
1703 \begin_layout Standard
1704 The first step is to define your file formats if they are not already defined.
1706 \begin_inset Flex Noun
1709 \begin_layout Plain Layout
1710 Tools\SpecialChar menuseparator
1718 \begin_inset Flex Noun
1721 \begin_layout Plain Layout
1722 File Handling\SpecialChar menuseparator
1729 \begin_inset Flex Noun
1732 \begin_layout Plain Layout
1738 button to define your new format.
1740 \begin_inset Flex Noun
1743 \begin_layout Plain Layout
1749 field contains the name used to identify the format in the GUI.
1751 \begin_inset Flex Noun
1754 \begin_layout Plain Layout
1760 is used to identify the format internally.
1761 You will also need to enter a file extension.
1762 These are all required.
1764 \begin_inset Flex Noun
1767 \begin_layout Plain Layout
1773 field is used to provide a keyboard shortcut on the menus.
1774 (For example, pressing
1775 \begin_inset Flex Noun
1778 \begin_layout Plain Layout
1785 \begin_inset Flex Noun
1788 \begin_layout Plain Layout
1789 Document\SpecialChar menuseparator
1790 View (Other Formats)\SpecialChar menuseparator
1799 \begin_layout Standard
1801 \begin_inset Flex Noun
1804 \begin_layout Plain Layout
1811 \begin_inset Flex Noun
1814 \begin_layout Plain Layout
1821 For example, you might want to use
1822 \begin_inset Flex Noun
1825 \begin_layout Plain Layout
1831 to view PostScript files.
1832 You can enter the command needed to start the program in the corresponding
1834 In defining this command, you can use the four variables listed in the
1836 The viewer is launched when you view an image in \SpecialChar LyX
1838 \begin_inset Flex Noun
1841 \begin_layout Plain Layout
1842 Document\SpecialChar menuseparator
1849 The editor is for example launched when you right-click on an image and
1851 \begin_inset Flex Noun
1854 \begin_layout Plain Layout
1860 in the appearing context menu.
1863 \begin_layout Standard
1865 \begin_inset Flex Noun
1868 \begin_layout Plain Layout
1874 type of a format is optional, but if it is specified, it must be unique
1876 It is used to detect files of this format from the file contents.
1877 For some important file formats there is no MIME type officially registered
1879 \begin_inset CommandInset href
1882 target "http://www.iana.org/assignments/media-types/"
1888 Therefore \SpecialChar LyX
1889 uses the extended list of MIME types as specified by
1890 \begin_inset CommandInset href
1892 name "freedesktop.org"
1893 target "http://www.freedesktop.org/wiki/Specifications/shared-mime-info-spec"
1901 \begin_layout Standard
1903 \begin_inset Flex Noun
1906 \begin_layout Plain Layout
1912 option tells \SpecialChar LyX
1913 that a format is suitable for document export.
1914 If this is set and if a suitable conversion route exists (see
1915 \begin_inset CommandInset ref
1917 reference "sec:Converters"
1921 ), the format will appear in the
1922 \begin_inset Flex Noun
1925 \begin_layout Plain Layout
1926 File\SpecialChar menuseparator
1933 The format will also appear in the
1934 \begin_inset Flex Noun
1937 \begin_layout Plain Layout
1938 Document\SpecialChar menuseparator
1944 menu if a viewer is specified for the format.
1945 Pure image formats, such as
1946 \begin_inset Flex Code
1949 \begin_layout Plain Layout
1955 , should not use this option.
1956 Formats that can both represent vector graphics and documents like
1957 \begin_inset Flex Code
1960 \begin_layout Plain Layout
1969 \begin_layout Standard
1971 \begin_inset Flex Noun
1974 \begin_layout Plain Layout
1975 Vector graphics format
1980 tells \SpecialChar LyX
1981 that a format can contain vector graphics.
1982 This information is used to determine the target format of included graphics
1984 \begin_inset Flex Noun
1987 \begin_layout Plain Layout
1994 Included graphics may need to be converted to either
1995 \begin_inset Flex Noun
1998 \begin_layout Plain Layout
2005 \begin_inset Flex Noun
2008 \begin_layout Plain Layout
2015 \begin_inset Flex Noun
2018 \begin_layout Plain Layout
2025 \begin_inset Flex Noun
2028 \begin_layout Plain Layout
2034 cannot handle other image formats.
2035 If an included graphic is not already in
2036 \begin_inset Flex Noun
2039 \begin_layout Plain Layout
2046 \begin_inset Flex Noun
2049 \begin_layout Plain Layout
2056 \begin_inset Flex Noun
2059 \begin_layout Plain Layout
2065 format, it is converted to
2066 \begin_inset Flex Noun
2069 \begin_layout Plain Layout
2075 if the vector format option is set, and otherwise to
2076 \begin_inset Flex Noun
2079 \begin_layout Plain Layout
2088 \begin_layout Section
2092 \begin_layout Standard
2093 Since all conversions from one format to another take place in \SpecialChar LyX
2095 directory, it is sometimes necessary to modify a file before copying it
2096 to the temporary directory in order that the conversion may be performed.
2100 \begin_layout Plain Layout
2101 For example, the file may refer to other files—images, for example—using
2102 relative file names, and these may become invalid when the file is copied
2103 to the temporary directory.
2108 This is done by a Copier: It copies a file to (or from) the temporary directory
2109 and may modify it in the process.
2112 \begin_layout Standard
2113 The definitions of the copiers may use eight variables:
2116 \begin_layout Labeling
2117 \labelwidthstring 00.00.0000
2118 \begin_inset Flex Code
2121 \begin_layout Plain Layout
2127 The \SpecialChar LyX
2128 system directory (e.
2129 \begin_inset space \thinspace{}
2133 \begin_inset space \space{}
2137 \begin_inset Flex Noun
2140 \begin_layout Plain Layout
2149 \begin_layout Labeling
2150 \labelwidthstring 00.00.0000
2151 \begin_inset Flex Code
2154 \begin_layout Plain Layout
2163 \begin_layout Labeling
2164 \labelwidthstring 00.00.0000
2165 \begin_inset Flex Code
2168 \begin_layout Plain Layout
2177 \begin_layout Labeling
2178 \labelwidthstring 00.00.0000
2179 \begin_inset Flex Code
2182 \begin_layout Plain Layout
2188 The base name (without filename extension) in the \SpecialChar LyX
2192 \begin_layout Labeling
2193 \labelwidthstring 00.00.0000
2194 \begin_inset Flex Code
2197 \begin_layout Plain Layout
2203 The full directory path of the \SpecialChar LyX
2207 \begin_layout Labeling
2208 \labelwidthstring 00.00.0000
2209 \begin_inset Flex Code
2212 \begin_layout Plain Layout
2218 The full pathname to the original \SpecialChar LyX
2219 file being processed
2222 \begin_layout Labeling
2223 \labelwidthstring 00.00.0000
2224 \begin_inset Flex Code
2227 \begin_layout Plain Layout
2233 The filename (without any directory path) of the \SpecialChar LyX
2237 \begin_layout Labeling
2238 \labelwidthstring 00.00.0000
2239 \begin_inset Flex Code
2242 \begin_layout Plain Layout
2248 The `\SpecialChar LaTeX
2252 \begin_layout Standard
2253 The latter should be the filename as it would be used in a \SpecialChar LaTeX
2261 It is relevant only when exporting files suitable for such inclusion.
2264 \begin_layout Standard
2265 Copiers can be used to do almost anything with output files.
2266 For example, suppose you want generated pdf files to be copied to a special
2268 \begin_inset Flex Code
2271 \begin_layout Plain Layout
2278 Then you could write a shell script such as this one:
2281 \begin_layout Standard
2282 \begin_inset listings
2286 \begin_layout Plain Layout
2291 \begin_layout Plain Layout
2296 \begin_layout Plain Layout
2298 TOFILE=`basename $2`
2301 \begin_layout Plain Layout
2303 cp $FROMFILE /home/you/pdf/$TOFILE
2308 Save it in your local \SpecialChar LyX
2310 \begin_inset Flex Code
2313 \begin_layout Plain Layout
2314 /home/you/.lyx/scripts/pdfcopier.sh
2319 —and make it executable, if you need to do so on your platform.
2321 \begin_inset Flex Noun
2324 \begin_layout Plain Layout
2325 Tools\SpecialChar menuseparator
2331 dialog, select under
2332 \begin_inset Flex Noun
2335 \begin_layout Plain Layout
2336 File Handling\SpecialChar menuseparator
2343 \begin_inset Flex Noun
2346 \begin_layout Plain Layout
2352 format—or one of the other pdf formats—and enter
2353 \begin_inset Flex Code
2356 \begin_layout Plain Layout
2357 pdfcopier.sh $$i $$o
2363 \begin_inset Flex Noun
2366 \begin_layout Plain Layout
2376 \begin_layout Standard
2377 Copiers are used by \SpecialChar LyX
2378 in various of its own conversions.
2379 For example, if appropriate programs are found, \SpecialChar LyX
2380 will automatically install
2382 \begin_inset Flex Noun
2385 \begin_layout Plain Layout
2392 \begin_inset Flex Noun
2395 \begin_layout Plain Layout
2397 \begin_inset space ~
2406 When these formats are exported, the copier sees that not just the main
2407 HTML file but various associated files (style files, images, etc.) are also
2409 All these files are written to a subdirectory of the directory in which
2410 the original \SpecialChar LyX
2415 \begin_layout Plain Layout
2416 This copier can be customized.
2418 \begin_inset Quotes eld
2422 \begin_inset Quotes erd
2425 argument takes a comma-separated list of extensions to be copied; if it
2426 is omitted, all files will be copied.
2428 \begin_inset Quotes eld
2432 \begin_inset Quotes erd
2435 argument determines the extension added to the generated directory.
2437 \begin_inset Quotes eld
2441 \begin_inset Flex Noun
2444 \begin_layout Plain Layout
2451 \begin_inset Quotes erd
2454 , so HTML generated from
2455 \begin_inset Flex Noun
2458 \begin_layout Plain Layout
2459 /path/to/filename.lyx
2465 \begin_inset Flex Noun
2468 \begin_layout Plain Layout
2469 /path/to/filename.html.LyXconv
2483 \begin_layout Section
2485 \begin_inset CommandInset label
2487 name "sec:Converters"
2494 \begin_layout Standard
2495 You can define your own Converters to convert files between different formats.
2497 \begin_inset Flex Noun
2500 \begin_layout Plain Layout
2501 Tools\SpecialChar menuseparator
2502 Preferences\SpecialChar menuseparator
2503 File Handling\SpecialChar menuseparator
2512 \begin_layout Standard
2513 To define a new converter, select the
2514 \begin_inset Flex Noun
2517 \begin_layout Plain Layout
2519 \begin_inset space ~
2528 \begin_inset Flex Noun
2531 \begin_layout Plain Layout
2533 \begin_inset space ~
2541 from the drop-down lists, enter the command needed for the conversion,
2543 \begin_inset Flex Noun
2546 \begin_layout Plain Layout
2553 Several variables can be used in the definition of converters:
2556 \begin_layout Labeling
2557 \labelwidthstring 00.00.0000
2558 \begin_inset Flex Code
2561 \begin_layout Plain Layout
2567 The \SpecialChar LyX
2571 \begin_layout Labeling
2572 \labelwidthstring 00.00.0000
2573 \begin_inset Flex Code
2576 \begin_layout Plain Layout
2585 \begin_layout Labeling
2586 \labelwidthstring 00.00.0000
2587 \begin_inset Flex Code
2590 \begin_layout Plain Layout
2599 \begin_layout Labeling
2600 \labelwidthstring 00.00.0000
2601 \begin_inset Flex Code
2604 \begin_layout Plain Layout
2610 The base filename of the input file (i.
2611 \begin_inset space \thinspace{}
2614 g., without the extension)
2617 \begin_layout Labeling
2618 \labelwidthstring 00.00.0000
2619 \begin_inset Flex Code
2622 \begin_layout Plain Layout
2628 The path to the input file
2631 \begin_layout Labeling
2632 \labelwidthstring 00.00.0000
2633 \begin_inset Flex Code
2636 \begin_layout Plain Layout
2642 The path to the original input file (this is different from $$p when a
2643 chain of converters is called)
2646 \begin_layout Labeling
2647 \labelwidthstring 00.00.0000
2648 \begin_inset Flex Code
2651 \begin_layout Plain Layout
2657 The iconv name for the encoding of the document.
2660 \begin_layout Standard
2662 \begin_inset Flex Noun
2665 \begin_layout Plain Layout
2667 \begin_inset space ~
2675 field you can enter the following flags, separated by commas:
2678 \begin_layout Labeling
2679 \labelwidthstring 00.00.0000
2680 \begin_inset Flex Code
2683 \begin_layout Plain Layout
2685 \change_inserted -712698321 1524656940
2693 This converter runs some form of \SpecialChar LaTeX
2695 This will make \SpecialChar LyX
2696 's \SpecialChar LaTeX
2697 error logs available.
2699 \change_inserted -712698321 1524657018
2701 \begin_inset Flex Code
2704 \begin_layout Plain Layout
2706 \change_inserted -712698321 1524657012
2714 value specifies the form of \SpecialChar LaTeX
2716 \begin_inset Flex Code
2719 \begin_layout Plain Layout
2721 \change_inserted -712698321 1524657005
2722 latex, pdflatex, platex, xetex, luatex
2730 If no value is specified,
2731 \begin_inset Flex Code
2734 \begin_layout Plain Layout
2736 \change_inserted -712698321 1524657018
2749 \begin_layout Labeling
2750 \labelwidthstring 00.00.0000
2751 \begin_inset Flex Code
2754 \begin_layout Plain Layout
2756 \change_inserted -712698321 1524656935
2764 Needs the \SpecialChar LaTeX
2766 \begin_inset Flex Noun
2769 \begin_layout Plain Layout
2775 file for the conversion.
2777 \change_inserted -712698321 1524657047
2779 \begin_inset Flex Code
2782 \begin_layout Plain Layout
2784 \change_inserted -712698321 1524657030
2792 value specifies the form of \SpecialChar LaTeX
2793 that is run in order to generate the
2794 \begin_inset Flex Noun
2797 \begin_layout Plain Layout
2799 \change_inserted -712698321 1524657047
2808 \begin_inset Flex Code
2811 \begin_layout Plain Layout
2813 \change_inserted -712698321 1524657030
2814 latex, pdflatex, platex, xetex, luatex
2822 If no value is specified,
2823 \begin_inset Flex Code
2826 \begin_layout Plain Layout
2828 \change_inserted -712698321 1524657030
2841 \begin_layout Labeling
2842 \labelwidthstring 00.00.0000
2843 \begin_inset Flex Code
2846 \begin_layout Plain Layout
2853 \begin_inset Quotes eld
2857 \begin_inset Quotes erd
2860 file from the backend, which in practice means a \SpecialChar LaTeX
2861 file like the one we
2862 would export, without
2863 \begin_inset Flex Code
2866 \begin_layout Plain Layout
2875 \begin_layout Labeling
2876 \labelwidthstring 00.00.0000
2877 \begin_inset Flex Code
2880 \begin_layout Plain Layout
2889 \begin_layout Standard
2890 The following three flags are not really flags at all because they take
2892 \begin_inset Flex Noun
2895 \begin_layout Plain Layout
2897 \begin_inset space ~
2901 \begin_inset space ~
2912 \begin_layout Labeling
2913 \labelwidthstring 00.00.0000
2915 \change_inserted -712698321 1523206314
2916 \begin_inset Flex Code
2919 \begin_layout Plain Layout
2921 \change_inserted -712698321 1523206193
2929 The name of the driver that needs to be loaded with the
2933 package for this converter.
2934 The loading of the correct driver is necessary to get some PDF-specific
2943 \begin_layout Labeling
2944 \labelwidthstring 00.00.0000
2945 \begin_inset Flex Code
2948 \begin_layout Plain Layout
2954 If set, the converter's standard error will be redirected to a file
2955 \begin_inset Flex Code
2958 \begin_layout Plain Layout
2964 , and the script given as argument will be run as:
2965 \begin_inset Flex Code
2968 \begin_layout Plain Layout
2969 script < infile.out > infile.log
2975 The argument may contain
2976 \begin_inset Flex Code
2979 \begin_layout Plain Layout
2988 \begin_layout Labeling
2989 \labelwidthstring 00.00.0000
2990 \begin_inset Flex Code
2993 \begin_layout Plain Layout
2999 The name of the directory in which the converter will dump the generated
3002 will not create this directory, and it does not copy anything into it,
3003 though it will copy this directory to the destination.
3004 The argument may contain
3005 \begin_inset Flex Code
3008 \begin_layout Plain Layout
3014 , which will be replaced by the base name of the input and output files,
3015 respectively, when the directory is copied.
3016 \begin_inset Newline newline
3019 Note that resultdir and usetempdir make no sense together.
3020 The latter will be ignored if the former is given.
3023 \begin_layout Labeling
3024 \labelwidthstring 00.00.0000
3025 \begin_inset Flex Code
3028 \begin_layout Plain Layout
3034 Determines the output file name and may, contain
3035 \begin_inset Flex Code
3038 \begin_layout Plain Layout
3045 Sensible only with resultdir and optional even then; if not given, it defaults
3049 \begin_layout Standard
3051 \change_inserted -712698321 1523206384
3052 A suitable hyperref-driver is set for some converters that are installed
3053 with \SpecialChar LyX
3056 \change_deleted -712698321 1523206388
3058 \change_inserted -712698321 1523206389
3062 \change_inserted -712698321 1523206400
3066 \change_inserted -712698321 1523206407
3070 \change_inserted -712698321 1523206437
3074 \change_deleted -712698321 1523206442
3075 that are installed with \SpecialChar LyX
3082 \begin_layout Standard
3083 You do not have to define converters for all formats between which you want
3085 For example, you will note that there is no `\SpecialChar LyX
3086 to PostScript' converter,
3087 but \SpecialChar LyX
3088 will export PostScript.
3089 It does so by first creating a \SpecialChar LaTeX
3090 file (no converter needs to be defined
3091 for this) which is then converted to DVI using the `\SpecialChar LaTeX
3093 and finally converting the resulting DVI file to PostScript.
3095 finds such `chains' of converters automatically, and it will always choose
3096 the shortest possible chain.
3097 You can, though, still define multiple conversion methods between file
3099 For example, the standard \SpecialChar LyX
3100 configuration provides five ways to convert
3105 \begin_layout Enumerate
3107 \begin_inset Flex Noun
3110 \begin_layout Plain Layout
3119 \begin_layout Enumerate
3120 via (DVI and) PostScript, using
3121 \begin_inset Flex Noun
3124 \begin_layout Plain Layout
3133 \begin_layout Enumerate
3135 \begin_inset Flex Noun
3138 \begin_layout Plain Layout
3147 \begin_layout Enumerate
3149 \begin_inset Flex Noun
3152 \begin_layout Plain Layout
3162 \begin_layout Enumerate
3164 \begin_inset Flex Noun
3167 \begin_layout Plain Layout
3177 \begin_layout Standard
3178 To define such alternate chains, you must define multiple target `file formats',
3180 \begin_inset CommandInset ref
3182 reference "sec:Formats"
3187 For example, in the standard configuration, the formats named
3188 \begin_inset Flex Noun
3191 \begin_layout Plain Layout
3198 \begin_inset Flex Noun
3201 \begin_layout Plain Layout
3208 \begin_inset Flex Noun
3211 \begin_layout Plain Layout
3218 \begin_inset Flex Noun
3221 \begin_layout Plain Layout
3228 \begin_inset Flex Noun
3231 \begin_layout Plain Layout
3238 \begin_inset Flex Noun
3241 \begin_layout Plain Layout
3248 \begin_inset Flex Noun
3251 \begin_layout Plain Layout
3258 \begin_inset Flex Noun
3261 \begin_layout Plain Layout
3269 \begin_inset Flex Noun
3272 \begin_layout Plain Layout
3279 \begin_inset Flex Noun
3282 \begin_layout Plain Layout
3289 ) are defined, all of which share the extension
3290 \begin_inset Flex Noun
3293 \begin_layout Plain Layout
3299 , and which correspond to the conversion methods just mentioned.
3302 \begin_layout Chapter
3303 Internationalizing \SpecialChar LyX
3305 \begin_inset CommandInset label
3307 name "cha:Internationalizing-LyX"
3314 \begin_layout Standard
3316 supports using a translated interface.
3317 Last time we checked, \SpecialChar LyX
3318 provided text in thirty languages.
3319 The language of choice is called your
3324 (For further reading on locale settings, see also the documentation for
3325 locale that comes with your operating system.
3326 For Linux, the manual page for
3327 \begin_inset Flex Code
3330 \begin_layout Plain Layout
3336 could be a good place to start).
3339 \begin_layout Standard
3340 Notice that these translations will work, but do contain a few flaws.
3341 In particular, all dialogs have been designed with the English text in
3342 mind, which means that some of the translated text will be too large to
3343 fit within the space allocated.
3344 This is only a display problem and will not cause any harm.
3345 Also, you will find that some of the translations do not define shortcut
3346 keys for everything.
3347 Sometimes, there are simply not enough free letters to do it.
3348 Other times, the translator just hasn't got around to doing it yet.
3349 Our localization team, which you may wish to join,
3353 \begin_layout Plain Layout
3354 If you are a fluent speaker of a language other than English, joining these
3355 teams is a great way to give back to the \SpecialChar LyX
3361 will of course try to fix these shortcomings in future versions of \SpecialChar LyX
3365 \begin_layout Section
3366 Translating \SpecialChar LyX
3370 \begin_layout Subsection
3371 Translating the graphical user interface (text messages).
3374 \begin_layout Standard
3377 \begin_inset Flex Code
3380 \begin_layout Plain Layout
3386 library to handle the internationalization of the interface.
3387 To have \SpecialChar LyX
3388 speak your favorite language in all menus and dialogs, you need
3390 \begin_inset Flex Code
3393 \begin_layout Plain Layout
3399 -file for that language.
3400 When this is available, you'll have to generate a
3401 \begin_inset Flex Code
3404 \begin_layout Plain Layout
3410 -file from it and install the
3411 \begin_inset Flex Code
3414 \begin_layout Plain Layout
3421 The process of doing all of this is explained in the documentation for
3423 \begin_inset Flex Code
3426 \begin_layout Plain Layout
3433 It is possible to do this just for yourself, but if you're going to do
3434 it, you might as well share the results of your labors with the rest of
3435 the \SpecialChar LyX
3437 Send a message to the \SpecialChar LyX
3438 developers' list for more information about how
3442 \begin_layout Standard
3443 In short, this is what you should do (xx denotes the language code):
3446 \begin_layout Itemize
3447 Check out the \SpecialChar LyX
3450 \begin_inset CommandInset href
3452 name "information on the web"
3453 target "https://www.lyx.org/HowToUseGIT"
3461 \begin_layout Itemize
3463 \begin_inset Flex Code
3466 \begin_layout Plain Layout
3472 to the folder of the
3473 \begin_inset Flex Code
3476 \begin_layout Plain Layout
3484 \begin_inset Flex Code
3487 \begin_layout Plain Layout
3495 \begin_inset Flex Code
3498 \begin_layout Plain Layout
3504 doesn't exist anywhere, it can be remade with the console command
3505 \begin_inset Flex Code
3508 \begin_layout Plain Layout
3514 in that directory, or you can use an existing po-file for some other language
3518 \begin_layout Itemize
3520 \begin_inset Flex Code
3523 \begin_layout Plain Layout
3533 \begin_layout Plain Layout
3534 This is just a text file, so it can be edited in any text editor.
3535 But there are also specialized programs that support such editing, such
3540 (for all platforms) or
3549 contains a `mode' for editing
3550 \begin_inset Flex Code
3553 \begin_layout Plain Layout
3560 \begin_inset Flex URL
3563 \begin_layout Plain Layout
3565 https://www.gnu.org/software/gettext/manual/html_node/PO-Mode.html#PO-Mode
3575 For some menu- and widget-labels, there are also shortcut keys that should
3577 Those keys are marked after a `|', and should be translated according to
3578 the words and phrases of the language.
3579 You should also fill also out the information at the beginning of the new
3581 \begin_inset Flex Code
3584 \begin_layout Plain Layout
3590 -file with your email-address, etc., so people know where to reach you with
3591 suggestions and entertaining flames.
3594 \begin_layout Standard
3595 If you are just doing this on your own, then:
3598 \begin_layout Itemize
3600 \begin_inset Flex Code
3603 \begin_layout Plain Layout
3610 This can be done with
3611 \begin_inset Flex Code
3614 \begin_layout Plain Layout
3615 msgfmt -o xx.mo < xx.po
3623 \begin_layout Itemize
3625 \begin_inset Flex Code
3628 \begin_layout Plain Layout
3634 -file to your locale-tree, at the correct directory for application messages
3639 xx, and under the name
3640 \begin_inset Flex Code
3643 \begin_layout Plain Layout
3650 \begin_inset space \thinspace{}
3654 \begin_inset space \space{}
3658 \begin_inset Flex Code
3661 \begin_layout Plain Layout
3662 /usr/local/share/locale/xx/LC_MESSAGES/lyx.mo
3672 \begin_layout Standard
3673 As said, however, it would be best if the new
3674 \begin_inset Flex Code
3677 \begin_layout Plain Layout
3683 file could be added to the \SpecialChar LyX
3684 distribution, so others can use it.
3685 Adding it involves making additional changes to \SpecialChar LyX
3687 So send an email to the developers' mailing list if you're interested in
3691 \begin_layout Subsubsection
3695 \begin_layout Standard
3696 Sometimes it turns out that one English message needs to be translated into
3697 different messages in the target language.
3698 One example is the message
3699 \begin_inset Flex Code
3702 \begin_layout Plain Layout
3708 which has the German translation
3716 , depending upon exactly what the English
3717 \begin_inset Quotes eld
3721 \begin_inset Quotes erd
3726 \begin_inset Flex Code
3729 \begin_layout Plain Layout
3735 does not handle such ambiguous translations.
3736 Therefore you have to add some context information to the message: Instead
3738 \begin_inset Flex Code
3741 \begin_layout Plain Layout
3748 \begin_inset Flex Code
3751 \begin_layout Plain Layout
3752 To[[as in 'From format x to format y']]
3758 \begin_inset Flex Code
3761 \begin_layout Plain Layout
3762 To[[as in 'From page x to page y']].
3767 Now the two occurrences of
3768 \begin_inset Flex Code
3771 \begin_layout Plain Layout
3778 \begin_inset Flex Code
3781 \begin_layout Plain Layout
3787 and can be translated correctly to
3798 \begin_layout Standard
3799 Of course the context information needs to be stripped off the original
3800 message when no translation is used.
3801 Therefore you have to put it in double square brackets at the end of the
3802 message (see the example above).
3803 The translation mechanism of \SpecialChar LyX
3804 ensures that everything in double square
3805 brackets at the end of messages is removed before displaying the message.
3808 \begin_layout Subsection
3809 Translating the documentation.
3812 \begin_layout Standard
3813 The online documentation (in the
3814 \begin_inset Flex Noun
3817 \begin_layout Plain Layout
3823 -menu) can (and should!) be translated.
3824 If there are translated versions of the documentation available
3828 \begin_layout Plain Layout
3829 As of March 2008, at least some of the documents have been translated into
3830 fourteen languages, with the Tutorial available in a few more.
3835 and the locale is set accordingly, these will be used automagically by
3839 looks for translated versions as
3840 \begin_inset Flex Code
3843 \begin_layout Plain Layout
3844 LyXDir/doc/xx/DocName.lyx
3850 \begin_inset Flex Code
3853 \begin_layout Plain Layout
3859 is the code for the language currently in use.
3860 If there are no translated documents, the default English versions will
3862 Note that the translated versions must have the same filenames (
3863 \begin_inset Flex Code
3866 \begin_layout Plain Layout
3872 above) as the original.
3873 If you feel up to translating the documentation (an excellent way to proof-read
3874 the original documentation by the way!), there are a few things you should
3878 \begin_layout Itemize
3879 Check out the documentation translation web page at
3880 \begin_inset CommandInset href
3882 name "https://www.lyx.org/Translation"
3883 target "https://www.lyx.org/Translation"
3889 That way, you can find out which (if any) documents have already been translate
3890 d into your language.
3891 You can also find out who (if anyone) is organizing the effort to translate
3892 the documentation into your language.
3893 If no one is organizing the effort, please let us know that you're interested.
3896 \begin_layout Standard
3897 Once you get to actually translating, here's a few hints for you that may
3901 \begin_layout Itemize
3902 Join the documentation team! There is information on how to do that in
3903 \begin_inset Flex Code
3906 \begin_layout Plain Layout
3913 \begin_inset Flex Noun
3916 \begin_layout Plain Layout
3917 Help\SpecialChar menuseparator
3923 ), which by the way is the first document you should translate.
3926 \begin_layout Itemize
3927 Learn the typographic conventions for the language you are translating to.
3928 Typography is an ancient art and over the centuries, a great variety of
3929 conventions have developed throughout different parts of the world.
3930 Also study the professional terminology amongst typographers in your country.
3931 Inventing your own terminology will only confuse the users.
3934 (Warning! Typography is addictive!)
3937 \begin_layout Itemize
3938 Make a copy of the document.
3939 This will be your working copy.
3940 You can use this as your personal translated help-file by placing it in
3942 \begin_inset Flex Code
3945 \begin_layout Plain Layout
3952 \begin_inset Note Greyedout
3955 \begin_layout Plain Layout
3960 For a complex document with external material (images, etc.), if you make
3962 \begin_inset space \thinspace{}
3966 \begin_inset space \space{}
3969 in a temp dir, beware that the links to external material may be broken
3970 when the document is moved to a different place.
3971 The best way is to retrieve the \SpecialChar LyX
3973 \begin_inset Flex URL
3976 \begin_layout Plain Layout
3978 https://www.lyx.org/HowToUseGIT
3983 ) and to edit the doc file in place.
3991 \begin_layout Itemize
3992 Sometimes the original document (from the \SpecialChar LyX
3993 team) will be updated.
3994 Use the source viewer at
3995 \begin_inset CommandInset href
3997 name "https://www.lyx.org/trac/timeline"
3998 target "https://www.lyx.org/trac/timeline"
4003 to see what has been changed.
4004 That way you can easily see which parts of the translated document need
4008 \begin_layout Standard
4009 If you ever find an error in the original document, fix it and notify the
4010 rest of the documentation team of the changes! (You didn't forget to join
4011 the documentation team, did you?)
4014 \begin_layout Standard
4015 \begin_inset Branch OutDated
4019 \begin_layout Section
4020 International Keyboard Support
4023 \begin_layout Standard
4026 [Editor's Note: The following section is by
4034 It needs to be fixed to conform to the new Documentation Style sheet and
4035 to make use of the new v1.0 features.
4036 The whole thing also needs to be merged with the section following it.-jw
4037 It may also be badly out of date.-rh (2008)]
4040 \begin_layout Subsection
4041 Defining Own Keymaps: Keymap File Format
4044 \begin_layout Standard
4045 Let's look at a keyboard definition file a little closer.
4046 It is a plain text file defining
4049 \begin_layout Itemize
4050 key-to-key or key-to-string translations
4053 \begin_layout Itemize
4057 \begin_layout Itemize
4058 dead keys exceptions
4061 \begin_layout Standard
4062 To define key-to-key or key-to-string translation, use this command:
4065 \begin_layout Quotation
4066 \begin_inset Flex Code
4069 \begin_layout Plain Layout
4078 \begin_inset Flex Code
4081 \begin_layout Plain Layout
4090 \begin_layout Standard
4092 \begin_inset Flex Code
4095 \begin_layout Plain Layout
4101 is the key to be translated and
4102 \begin_inset Flex Code
4105 \begin_layout Plain Layout
4111 is the string to be inserted into the document.
4112 To define dead keys, use:
4115 \begin_layout Quotation
4116 \begin_inset Flex Code
4119 \begin_layout Plain Layout
4128 \begin_inset Flex Code
4131 \begin_layout Plain Layout
4140 \begin_layout Standard
4142 \begin_inset Flex Code
4145 \begin_layout Plain Layout
4151 is a keyboard key and
4152 \begin_inset Flex Code
4155 \begin_layout Plain Layout
4162 The following dead keys are supported (shortcut name is in parentheses):
4165 \begin_layout Quotation
4169 \begin_inset space \hfill{}
4175 \begin_layout Quotation
4177 \begin_inset space \hfill{}
4183 \begin_layout Quotation
4185 \begin_inset space \hfill{}
4191 \begin_layout Quotation
4193 \begin_inset space \hfill{}
4199 \begin_layout Quotation
4201 \begin_inset space \hfill{}
4207 \begin_layout Quotation
4209 \begin_inset space \hfill{}
4216 \begin_layout Plain Layout
4228 \begin_layout Quotation
4230 \begin_inset space \hfill{}
4236 \begin_layout Quotation
4238 \begin_inset space \hfill{}
4245 \begin_layout Plain Layout
4257 \begin_layout Quotation
4259 \begin_inset space \hfill{}
4265 \begin_layout Quotation
4267 \begin_inset space \hfill{}
4273 \begin_layout Quotation
4275 \begin_inset space \hfill{}
4282 \begin_layout Plain Layout
4294 \begin_layout Quotation
4296 \begin_inset space \hfill{}
4303 \begin_layout Plain Layout
4315 \begin_layout Quotation
4317 \begin_inset space \hfill{}
4323 \begin_layout Quotation
4324 hungarian umlaut (hug)
4325 \begin_inset space \hfill{}
4331 \begin_layout Quotation
4333 \begin_inset space \hfill{}
4339 \begin_layout Quotation
4341 \begin_inset space \hfill{}
4348 \begin_layout Plain Layout
4360 \begin_layout Standard
4361 Since in many international keyboards there are exceptions to what some
4362 dead keys should do, you can define them using
4365 \begin_layout Quotation
4366 \begin_inset Flex Code
4369 \begin_layout Plain Layout
4377 deadkey key outstring
4380 \begin_layout Standard
4381 For example, on Slovak keyboard, if you enter caron-o, it generates circumflex-o
4385 \begin_layout Quotation
4386 \begin_inset Flex Code
4389 \begin_layout Plain Layout
4402 \begin_layout Standard
4403 to make it work correctly.
4404 Also, you have to define as exceptions dead keys over i and j, to remove
4405 the dot from them before inserting an accent mark.
4406 I will change this when the time comes, but so far I haven't had time.
4409 \begin_layout Standard
4410 Oh, and about characters: backslash is escaped, so to enter it, you'll need
4413 \begin_inset Flex Code
4416 \begin_layout Plain Layout
4422 have different meaning.
4424 \begin_inset Flex Code
4427 \begin_layout Plain Layout
4433 marks comments, quotes start and end \SpecialChar LaTeX
4435 To enter quote, you'll need to use
4436 \begin_inset Flex Code
4439 \begin_layout Plain Layout
4448 \begin_inset Flex Code
4451 \begin_layout Plain Layout
4458 \begin_inset Flex Code
4461 \begin_layout Plain Layout
4472 \begin_layout Standard
4473 If you make a keyboard description file that works for your language, please
4474 mail it to me, so I can include it in the next keymap distribution.
4477 \begin_layout Standard
4478 More keywords will be supported in keymap configuration file in future,
4482 \begin_layout Itemize
4483 \begin_inset Flex Code
4486 \begin_layout Plain Layout
4497 \begin_inset space \hfill{}
4501 \begin_inset Flex Code
4504 \begin_layout Plain Layout
4513 \begin_layout Itemize
4514 \begin_inset Flex Code
4517 \begin_layout Plain Layout
4528 \begin_inset space \hfill{}
4532 \begin_inset Flex Code
4535 \begin_layout Plain Layout
4541 an external keymap translation program
4544 \begin_layout Standard
4545 Also, it should look into
4546 \begin_inset Flex Code
4549 \begin_layout Plain Layout
4555 file for defaults, too (for example, a
4556 \begin_inset Flex Code
4559 \begin_layout Plain Layout
4567 option to include default keyboard).
4575 \begin_layout Section
4576 International Keymap Stuff
4577 \begin_inset CommandInset label
4579 name "sec:International-Keymap-Stuff"
4586 \begin_layout Standard
4587 \begin_inset Note Note
4590 \begin_layout Plain Layout
4591 In doing the revisions on this document in March 2008, I did not look over
4592 this stuff, as I do not understand it.
4593 It would be good if someone else could do so.
4602 \begin_layout Standard
4603 The next two sections describe the
4604 \begin_inset Flex Code
4607 \begin_layout Plain Layout
4616 \begin_inset Flex Code
4619 \begin_layout Plain Layout
4627 file syntax in detail.
4628 These sections should help you design your own key map if the ones provided
4629 do not meet your needs.
4632 \begin_layout Subsection
4636 \begin_layout Standard
4640 \begin_inset Flex Code
4643 \begin_layout Plain Layout
4649 file maps keystrokes to characters or strings.
4650 As the name suggests, it sets a keyboard mapping.
4652 \begin_inset Flex Code
4655 \begin_layout Plain Layout
4666 \begin_inset Flex Code
4669 \begin_layout Plain Layout
4684 \begin_inset Flex Code
4687 \begin_layout Plain Layout
4700 \begin_inset Flex Code
4703 \begin_layout Plain Layout
4712 \begin_inset Flex Code
4715 \begin_layout Plain Layout
4723 are described in this section.
4726 \begin_layout Labeling
4727 \labelwidthstring 00.00.0000
4728 \begin_inset Flex Code
4731 \begin_layout Plain Layout
4739 Map a character to a string
4742 \begin_layout LyX-Code
4757 \begin_layout Standard
4790 the double-quote (")
4807 must be escaped with a preceding backslash (
4818 \begin_layout Standard
4820 \begin_inset Flex Noun
4823 \begin_layout Plain Layout
4831 statement to cause the symbol
4832 \begin_inset Flex Noun
4835 \begin_layout Plain Layout
4843 to be output for the keystroke
4844 \begin_inset Flex Noun
4847 \begin_layout Plain Layout
4858 \begin_layout LyX-Code
4864 \begin_layout Labeling
4865 \labelwidthstring 00.00.0000
4866 \begin_inset Flex Code
4869 \begin_layout Plain Layout
4877 Specify an accent character
4880 \begin_layout LyX-Code
4889 \begin_layout Standard
4890 This will make the cha
4928 This is the dead key
4932 \begin_layout Plain Layout
4939 refers to a key that does not produce a character by itself, but when followed
4940 with another key, produces the desired accent character.
4941 For example, a German characte
4943 r with an umlaut like
4953 can be produced in this manner.
4962 \begin_layout Standard
4975 and then another key not in
4992 followed by the other, not allowed key, as output.
4996 \begin_inset Flex Noun
4999 \begin_layout Plain Layout
5007 cancels a dead key, so if
5018 \begin_inset Flex Noun
5021 \begin_layout Plain Layout
5030 , the cursor will not go one position backwards but will instead cancel
5046 might have had on the next keystroke.
5050 \begin_layout Standard
5051 The following example specifies that the character ' is to be an acute accent,
5052 allowed on the characters a, e, i, o, u, A, E, I, O, and U:
5055 \begin_layout LyX-Code
5058 kmod ' acute aeiouAEIOU
5061 \begin_layout Labeling
5062 \labelwidthstring 00.00.0000
5063 \begin_inset Flex Code
5066 \begin_layout Plain Layout
5072 Specify an exception to the accent character
5075 \begin_layout LyX-Code
5084 \begin_layout Standard
5085 This defines an exce
5126 have been assigned a keystroke with a previous
5129 \begin_inset Flex Code
5132 \begin_layout Plain Layout
5156 must not belong in the
5203 If such a declaration does not exist in
5211 \begin_inset Flex Code
5214 \begin_layout Plain Layout
5248 \begin_inset Flex Code
5251 \begin_layout Plain Layout
5265 \begin_layout Standard
5266 The following command produces causes äi to be produced when you enter acute-i
5270 \begin_layout LyX-Code
5284 \begin_layout Labeling
5285 \labelwidthstring 00.00.0000
5286 \begin_inset Flex Code
5289 \begin_layout Plain Layout
5295 Combine two accent characters
5298 \begin_layout LyX-Code
5304 accent1 accent2 allowed
5307 \begin_layout Standard
5308 This one is getting pretty esoteric.
5309 It allows you to combine the effect
5365 \begin_inset Flex Code
5368 \begin_layout Plain Layout
5396 \begin_layout Standard
5397 Consider this example from the
5398 \begin_inset Flex Code
5401 \begin_layout Plain Layout
5412 \begin_layout LyX-Code
5415 kmod ; acute aeioyvhAEIOYVH
5419 kcomb acute umlaut iyIY
5422 \begin_layout Standard
5423 This allows you to press
5424 \begin_inset Flex Noun
5427 \begin_layout Plain Layout
5435 and get the effect of
5436 \begin_inset Flex Code
5439 \begin_layout Plain Layout
5458 in this case cancels the last dead key, so if you press
5459 \begin_inset Flex Noun
5462 \begin_layout Plain Layout
5471 \begin_inset Flex Code
5474 \begin_layout Plain Layout
5487 \begin_layout Subsection
5491 \begin_layout Standard
5493 \begin_inset Flex Code
5496 \begin_layout Plain Layout
5504 mapping is performed, a
5505 \begin_inset Flex Code
5508 \begin_layout Plain Layout
5518 file maps the strings that the symbols generate to characters in the current
5520 The \SpecialChar LyX
5521 distribution currently includes at least the
5522 \begin_inset Flex Code
5525 \begin_layout Plain Layout
5534 \begin_inset Flex Code
5537 \begin_layout Plain Layout
5548 \begin_layout Standard
5550 \begin_inset Flex Code
5553 \begin_layout Plain Layout
5561 file is a sequence of declarations of the form
5564 \begin_layout LyX-Code
5577 \begin_layout Standard
5578 For example, in order to map
5579 \begin_inset Flex Noun
5582 \begin_layout Plain Layout
5592 to the corresponding character in the iso-8859-1 set (233), the following
5596 \begin_layout LyX-Code
5604 \begin_layout Standard
5606 \begin_inset Flex Code
5609 \begin_layout Plain Layout
5618 \begin_inset Flex Code
5621 \begin_layout Plain Layout
5639 the same character can apply to more than one string.
5641 \begin_inset Flex Code
5644 \begin_layout Plain Layout
5655 \begin_layout LyX-Code
5667 \begin_inset Newline newline
5683 \begin_layout Standard
5685 cannot find a mapping for the string produced by the keystroke or a
5686 deadkey sequence, it will check if it looks like an accented char and try
5687 to draw an accent over the character on screen.
5690 \begin_layout Subsection
5694 \begin_layout Standard
5695 There is a second way to add support for international characters through
5696 so-called dead-keys.
5697 A dead-key works in combination with a letter to produce an accented character.
5698 Here, we'll explain how to create a really simple dead-key to illustrate
5702 \begin_layout Standard
5703 Suppose you happen to need the circumflex character,
5704 \begin_inset Quotes eld
5708 \begin_inset Quotes erd
5713 \begin_inset Flex Noun
5716 \begin_layout Plain Layout
5723 \begin_inset space ~
5727 \begin_inset Flex Noun
5730 \begin_layout Plain Layout
5736 ] to the \SpecialChar LyX
5738 \begin_inset Flex Code
5741 \begin_layout Plain Layout
5748 \begin_inset Flex Code
5751 \begin_layout Plain Layout
5758 Now, whenever you type the
5759 \begin_inset Flex Noun
5762 \begin_layout Plain Layout
5768 -key followed by a letter, that letter will have a circumflex accent on
5770 For example, the sequence
5771 \begin_inset Quotes eld
5775 \begin_inset Flex Noun
5778 \begin_layout Plain Layout
5785 \begin_inset Quotes erd
5788 produces the letter:
5789 \begin_inset Quotes eld
5793 \begin_inset Quotes erd
5797 If you tried to type
5798 \begin_inset Quotes eld
5802 \begin_inset Flex Noun
5805 \begin_layout Plain Layout
5812 \begin_inset Quotes erd
5815 , however, \SpecialChar LyX
5816 will complain with a beep, since a
5817 \begin_inset Quotes eld
5821 \begin_inset Flex Noun
5824 \begin_layout Plain Layout
5831 \begin_inset Quotes erd
5834 never takes a circumflex accent.
5836 \begin_inset Flex Noun
5839 \begin_layout Plain Layout
5845 after a dead-key produces the bare-accent.
5846 Please note this last point! If you bind a key to a dead-key, you'll need
5847 to rebind the character on that key to yet another key.
5849 \begin_inset Flex Noun
5852 \begin_layout Plain Layout
5858 to a cedilla is a bad idea, since you'll only get cedillas instead of commas.
5861 \begin_layout Standard
5862 One common way to bind dead-keys is to use
5863 \begin_inset Flex Noun
5866 \begin_layout Plain Layout
5873 \begin_inset Flex Noun
5876 \begin_layout Plain Layout
5883 \begin_inset Flex Noun
5886 \begin_layout Plain Layout
5892 in combination with an accent, like
5893 \begin_inset Quotes eld
5897 \begin_inset Flex Noun
5900 \begin_layout Plain Layout
5907 \begin_inset Quotes erd
5911 \begin_inset Quotes eld
5915 \begin_inset Flex Noun
5918 \begin_layout Plain Layout
5925 \begin_inset Quotes erd
5929 \begin_inset Quotes eld
5933 \begin_inset Flex Noun
5936 \begin_layout Plain Layout
5943 \begin_inset Quotes erd
5947 Another way involves using
5948 \begin_inset Flex Code
5951 \begin_layout Plain Layout
5958 \begin_inset Flex Code
5961 \begin_layout Plain Layout
5967 to set up the special
5968 \begin_inset Flex Code
5971 \begin_layout Plain Layout
5979 \begin_inset Flex Code
5982 \begin_layout Plain Layout
5988 acts in some ways just like
5989 \begin_inset Flex Noun
5992 \begin_layout Plain Layout
5998 and permits you to bind keys to accented characters.
5999 You can also turn keys into dead-keys by binding them to something like
6001 \begin_inset Flex Code
6004 \begin_layout Plain Layout
6010 and then binding this symbolic key to the corresponding \SpecialChar LyX
6015 \begin_layout Plain Layout
6020 : This is exactly what I do in my
6021 \begin_inset Flex Code
6024 \begin_layout Plain Layout
6031 \begin_inset Flex Code
6034 \begin_layout Plain Layout
6042 \begin_inset Flex Noun
6045 \begin_layout Plain Layout
6047 \begin_inset space ~
6056 \begin_inset Flex Code
6059 \begin_layout Plain Layout
6065 and a bunch of these
6066 \begin_inset Quotes eld
6070 \begin_inset Flex Code
6073 \begin_layout Plain Layout
6080 \begin_inset Quotes erd
6083 symbolic keys bound such things as
6084 \begin_inset Flex Noun
6087 \begin_layout Plain Layout
6089 \begin_inset space ~
6098 \begin_inset Flex Noun
6101 \begin_layout Plain Layout
6103 \begin_inset space ~
6112 This is how I produce my accented characters.
6117 You can make just about anything into the
6118 \begin_inset Flex Code
6121 \begin_layout Plain Layout
6128 \begin_inset Flex Noun
6131 \begin_layout Plain Layout
6137 keys, a spare function key, etc.
6138 As for the \SpecialChar LyX
6139 commands that produce accents, check the entry for
6140 \begin_inset Flex Code
6143 \begin_layout Plain Layout
6154 You'll find the complete list there.
6157 \begin_layout Subsection
6158 Saving your Language Configuration
6161 \begin_layout Standard
6162 You can edit your preferences so that your desired language environment
6163 is automatically configured when \SpecialChar LyX
6165 \begin_inset Flex Noun
6168 \begin_layout Plain Layout
6169 Edit\SpecialChar menuseparator
6178 \begin_layout Chapter
6179 Installing New Document Classes, Layouts, and Templates
6180 \begin_inset CommandInset label
6182 name "cha:Installing-New-Document"
6187 \begin_inset Argument 1
6190 \begin_layout Plain Layout
6191 Installing New Document Classes
6199 \begin_layout Standard
6200 In this chapter, we describe the procedures for creating and installing
6201 new \SpecialChar LyX
6202 layout and template files, as well as offer a refresher on correctly
6203 installing new \SpecialChar LaTeX
6208 \begin_layout Standard
6209 First, let us a say a few words about how one ought to think about the relation
6210 between \SpecialChar LyX
6211 and \SpecialChar LaTeX
6213 The thing to understand is that, in a certain sense, \SpecialChar LyX
6214 doesn't know anything
6215 about \SpecialChar LaTeX
6217 Indeed, from \SpecialChar LyX
6218 's point of view, \SpecialChar LaTeX
6219 is just one of several
6220 \begin_inset Quotes eld
6224 \begin_inset Quotes erd
6227 in which it is capable of producing output.
6228 Other such formats are DocBook, plaintext, and XHTML.
6230 is, of course, a particularly important format, but very little of the
6231 information \SpecialChar LyX
6232 has about \SpecialChar LaTeX
6233 is actually contained in the program itself.
6237 \begin_layout Plain Layout
6238 Some commands are sufficiently complex that they are
6239 \begin_inset Quotes eld
6243 \begin_inset Quotes erd
6246 into \SpecialChar LyX
6248 But the developers generally regard this as a Bad Thing.
6253 Rather, that information, even for the standard classes like
6254 \begin_inset Flex Code
6257 \begin_layout Plain Layout
6263 , is contained in `layout files'.
6264 Similarly, \SpecialChar LyX
6265 itself does not know much about DocBook or XHTML.
6266 What it knows is contained in layout files.
6269 \begin_layout Standard
6270 You can think of the layout file for a given document class as a translation
6271 manual between \SpecialChar LyX
6272 constructs—paragraphs with their corresponding styles,
6273 certain sorts of insets, etc—and the corresponding \SpecialChar LaTeX
6276 Almost everything \SpecialChar LyX
6278 \begin_inset Flex Code
6281 \begin_layout Plain Layout
6287 , for example, is contained in the file
6288 \begin_inset Flex Code
6291 \begin_layout Plain Layout
6297 and in various other files it includes.
6298 For this reason, anyone intending to write layout files should plan to
6299 study the existing files.
6300 A good place to start is with
6301 \begin_inset Flex Code
6304 \begin_layout Plain Layout
6310 , which is included in
6311 \begin_inset Flex Code
6314 \begin_layout Plain Layout
6321 \begin_inset Flex Code
6324 \begin_layout Plain Layout
6330 , and many of the other layout files for document classes.
6331 This file is where sections and the like are defined:
6332 \begin_inset Flex Code
6335 \begin_layout Plain Layout
6341 tells \SpecialChar LyX
6342 how paragraphs that are marked with the Section, Subsection, etc,
6343 styles can be translated into corresponding \SpecialChar LaTeX
6344 , DocBook, and XHTML commands
6347 \begin_inset Flex Code
6350 \begin_layout Plain Layout
6356 file basically just includes several of these
6357 \begin_inset Flex Code
6360 \begin_layout Plain Layout
6369 \begin_layout Standard
6370 Defining the \SpecialChar LyX
6372 correspondence is not the only thing layout files do, though.
6373 Their other job is to define how the \SpecialChar LyX
6374 constructs themselves will appear
6376 The fact that layout files have these two jobs is often a source of confusion,
6377 because they are completely separate.
6378 Telling \SpecialChar LyX
6379 how to translate a certain paragraph style into \SpecialChar LaTeX
6382 how to display it; conversely, telling \SpecialChar LyX
6383 how to display a certain paragraph
6384 style does not tell \SpecialChar LyX
6385 how to translate it into \SpecialChar LaTeX
6386 (let alone tell \SpecialChar LaTeX
6389 So, in general, when you define a new \SpecialChar LyX
6390 construct, you must always do two
6391 quite separate things: (i)
6392 \begin_inset space ~
6395 tell \SpecialChar LyX
6396 how to translate it into \SpecialChar LaTeX
6398 \begin_inset space ~
6401 tell \SpecialChar LyX
6405 \begin_layout Standard
6406 Much the same is true, of course, as regards \SpecialChar LyX
6407 's other backend formats, though
6408 XHTML is in some ways different, because in that case \SpecialChar LyX
6413 able, to some extent, to use information about how it should display a
6414 paragraph on the screen to output information (in the form of CSS) about
6415 how the paragraph should be displayed in a browser.
6416 Even in this case, however, the distinction between what \SpecialChar LyX
6418 and how things are rendered externally remains in force, and the two can
6419 be controlled separately.
6421 \begin_inset CommandInset ref
6423 reference "sec:Tags-for-XHTML"
6430 \begin_layout Section
6431 Installing new \SpecialChar LaTeX
6435 \begin_layout Standard
6436 Some installations may not include a \SpecialChar LaTeX
6437 package or class file that you would
6438 like to use within \SpecialChar LyX
6440 For example, you might need Foil\SpecialChar TeX
6441 , a package for preparing slides for overhead
6443 Modern \SpecialChar LaTeX
6444 distributions like \SpecialChar TeX
6445 Live (2008 or newer) or MiK\SpecialChar TeX
6446 provide a user interface
6447 for installing such packages.
6448 For example, with MiK\SpecialChar TeX
6449 , you start the program
6450 \begin_inset Quotes eld
6454 \begin_inset space ~
6458 \begin_inset Quotes erd
6461 to get a list of available packages.
6462 To install one of them, right click on it or use the corresponding toolbar
6466 \begin_layout Standard
6467 If your \SpecialChar LaTeX
6468 distribution does not provide such a `package manager', or if the
6469 package is not available from your distribution, then follow these steps
6470 to install it manually:
6473 \begin_layout Enumerate
6474 Get the package from
6475 \begin_inset CommandInset href
6478 target "http://www.ctan.org/"
6486 \begin_layout Enumerate
6487 If the package contains a file with the ending
6488 \begin_inset Quotes eld
6492 \begin_inset Flex Code
6495 \begin_layout Plain Layout
6502 \begin_inset Quotes erd
6505 (is the case for Foil\SpecialChar TeX
6506 ) then open a console, change to the folder of this
6507 file and execute the command
6508 \begin_inset Flex Code
6511 \begin_layout Plain Layout
6518 You have now unpacked the package and have all files to install it.
6519 Most \SpecialChar LaTeX
6520 -packages are not packed and you can skip this step.
6523 \begin_layout Enumerate
6524 Now you need to decide if the package should be available for all users
6529 \begin_layout Enumerate
6530 On *nix systems (Linux, OSX, etc.), if you want the new package to be available
6531 for all users on your system, then install it in your `local' \SpecialChar TeX
6533 install it in your own `user' \SpecialChar TeX
6535 Where these trees should be created, if they do not already exist, depends
6537 To find this out, look in the file
6538 \begin_inset Flex Code
6541 \begin_layout Plain Layout
6551 \begin_layout Plain Layout
6552 This is usually in the directory
6553 \begin_inset Flex Code
6556 \begin_layout Plain Layout
6562 , though you can execute the command
6563 \begin_inset Flex Code
6566 \begin_layout Plain Layout
6577 The location of the `local' \SpecialChar TeX
6578 tree is defined by the
6579 \begin_inset Flex Code
6582 \begin_layout Plain Layout
6588 variable; this is usually somewhere like
6589 \begin_inset Flex Code
6592 \begin_layout Plain Layout
6593 /usr/local/share/texmf
6598 or /usr/local/texlive/XXXX where XXXX is the year of the installed \SpecialChar TeX
6601 The location of the `user' \SpecialChar TeX
6603 \begin_inset Flex Code
6606 \begin_layout Plain Layout
6613 \begin_inset Flex Code
6616 \begin_layout Plain Layout
6623 \begin_inset Flex Code
6626 \begin_layout Plain Layout
6635 (If these variables are not predefined, you have to define them.) You'll
6636 probably need root permissions to create or modify the `local' tree, but
6637 not for your `user' tree.
6638 \begin_inset Newline newline
6641 In general, it is recommended to install in the user tree because your user
6642 will not be modified or even overwritten when you upgrade your system.
6643 It will typically also be backed up together with everything else when
6644 you backup your home directory (which, of course, you do on a regular basis).
6647 \begin_layout Enumerate
6648 On Windows, if you want the new package to be available for all users on
6649 your system, change to the folder where \SpecialChar LaTeX
6650 is installed and then change to
6652 \begin_inset Flex Code
6655 \begin_layout Plain Layout
6666 (For MiK\SpecialChar TeX
6667 , this would be by default the folder
6668 \begin_inset Flex Code
6671 \begin_layout Plain Layout
6689 \begin_layout Plain Layout
6690 Note that this will be the correct path only on English installations.
6691 On a German one, it would be
6692 \begin_inset Flex Code
6695 \begin_layout Plain Layout
6709 , and similarly for other languages.
6714 Create there a new folder
6715 \begin_inset Flex Code
6718 \begin_layout Plain Layout
6724 and copy all files of the package into it.
6726 \begin_inset Newline newline
6729 If the package should only available for you or you don't have admin permissions
6730 , do the same, but in the local \SpecialChar LaTeX
6733 \begin_inset space \thinspace{}
6736 g., for MiK\SpecialChar TeX
6738 \begin_inset space ~
6741 2.8 under Windows XP, this would be the folder:
6742 \begin_inset Newline newline
6748 \begin_inset Flex Code
6751 \begin_layout Plain Layout
6754 Documents and Settings
6766 \begin_inset Newline newline
6772 \begin_inset Phantom HPhantom
6775 \begin_layout Plain Layout
6786 \begin_inset Flex Code
6789 \begin_layout Plain Layout
6802 \begin_inset Newline newline
6805 On Vista, it would be:
6806 \begin_inset Newline newline
6810 \begin_inset Flex Code
6813 \begin_layout Plain Layout
6839 \begin_layout Enumerate
6840 Now one only need to tell \SpecialChar LaTeX
6841 that there are new files.
6842 This depends on the used \SpecialChar LaTeX
6847 \begin_layout Enumerate
6848 For \SpecialChar TeX
6849 Live execute the command
6850 \begin_inset Flex Code
6853 \begin_layout Plain Layout
6860 If you installed the package for all users, then you will probably need
6861 to have root permissions for that.
6864 \begin_layout Enumerate
6865 For MiK\SpecialChar TeX
6866 , if you have installed the package for all users, start the program
6868 \begin_inset Quotes eld
6872 \begin_inset space ~
6876 \begin_inset Quotes erd
6879 and press the button marked
6880 \begin_inset Quotes eld
6884 \begin_inset Quotes erd
6888 Otherwise start the program
6889 \begin_inset Quotes eld
6893 \begin_inset Quotes erd
6900 \begin_layout Enumerate
6901 Finally, you need to tell \SpecialChar LyX
6902 that there are new packages available.
6903 So, in \SpecialChar LyX
6905 \begin_inset Flex Noun
6908 \begin_layout Plain Layout
6911 \SpecialChar menuseparator
6917 and then restart \SpecialChar LyX
6921 \begin_layout Standard
6922 Now the package is installed.
6923 In our example, the document class
6924 \begin_inset Flex Code
6927 \begin_layout Plain Layout
6933 will now be available under
6934 \begin_inset Flex Noun
6937 \begin_layout Plain Layout
6938 Document\SpecialChar menuseparator
6939 Settings\SpecialChar menuseparator
6946 \begin_inset Quotes eld
6950 \begin_inset Quotes erd
6957 \begin_layout Standard
6958 If you would like to use a \SpecialChar LaTeX
6959 document class that is not even listed in the
6961 \begin_inset Flex Noun
6964 \begin_layout Plain Layout
6965 Document\SpecialChar menuseparator
6966 Settings\SpecialChar menuseparator
6972 , then you need to create a `layout' file for it.
6973 That is the topic of the next section.
6976 \begin_layout Section
6977 Types of layout files
6980 \begin_layout Standard
6981 This section describes the various sorts of \SpecialChar LyX
6982 files that contain layout informati
6984 These files describe various paragraph and character styles, determining
6985 how \SpecialChar LyX
6986 should display them and how they should be translated into \SpecialChar LaTeX
6988 XHTML, or whatever output format is being used.
6992 \begin_layout Standard
6993 We shall try to provide a thorough description of the process of writing
6995 However, there are so many different types of documents supported even
6996 by just \SpecialChar LaTeX
6997 that we can't hope to cover every different possibility or problem
6998 you might encounter.
6999 The \SpecialChar LyX
7000 users' list is frequented by people with lots of experience with layout
7001 design who are willing to share what they've learned, so please feel free
7002 to ask questions there.
7005 \begin_layout Standard
7006 As you prepare to write a new layout, it is extremely helpful to look at
7007 the layouts distributed with \SpecialChar LyX
7009 If you write a \SpecialChar LyX
7010 layout for a \SpecialChar LaTeX
7011 document class that might also be used by
7012 others, or write a module that might be useful to others, then you should
7013 consider posting your layout to the
7014 \begin_inset CommandInset href
7016 name "layout section on the LyX wiki"
7017 target "https://wiki.lyx.org/Layouts/Layouts"
7022 or even to the \SpecialChar LyX
7023 developers' list, so that it might be included in \SpecialChar LyX
7028 \begin_layout Plain Layout
7029 Note that \SpecialChar LyX
7030 is licensed under the General Public License, so any material
7031 that is contributed to \SpecialChar LyX
7032 must be similarly licensed.
7040 \begin_layout Subsection
7042 \begin_inset CommandInset label
7044 name "subsec:Layout-modules"
7051 \begin_layout Standard
7052 We have spoken to this point about `layout files'.
7053 But there are different sorts of files that contain layout information.
7054 Layout files, strictly so called, have the
7055 \begin_inset Flex Code
7058 \begin_layout Plain Layout
7064 extension and provide \SpecialChar LyX
7065 with information about document classes.
7066 Since \SpecialChar LyX
7067 1.6 layout information can also be contained in layout
7072 \begin_inset Flex Code
7075 \begin_layout Plain Layout
7082 Modules are to \SpecialChar LaTeX
7083 packages much as layouts are to \SpecialChar LaTeX
7084 classes, and some modules—such
7086 \begin_inset Flex Code
7089 \begin_layout Plain Layout
7095 module—specifically provide support for one package.
7096 In a sense, layout modules are similar to included
7100 \begin_layout Plain Layout
7101 These can have any extension, but by convention have the
7102 \begin_inset Flex Code
7105 \begin_layout Plain Layout
7117 \begin_inset Flex Code
7120 \begin_layout Plain Layout
7126 —in that modules are not specific to a given document class but may be used
7127 with many different classes.
7128 The difference is that using an included file with
7129 \begin_inset Flex Code
7132 \begin_layout Plain Layout
7138 requires editing that file.
7139 Modules, by contrast, are selected in the
7140 \begin_inset Flex Noun
7143 \begin_layout Plain Layout
7144 Document\SpecialChar menuseparator
7153 \begin_layout Standard
7154 Building modules is the easiest way to get started with layout editing,
7155 since it can be as simple as adding a single new paragraph style or flex
7157 But modules may, in principle, contain anything a layout file can contain.
7160 \begin_layout Standard
7161 After creating a new module and copying it to the
7162 \begin_inset Flex Code
7165 \begin_layout Plain Layout
7171 folder, you will need to reconfigure and then restart \SpecialChar LyX
7174 However, changes you make to the module will be seen immediately, if you
7176 \begin_inset Flex Noun
7179 \begin_layout Plain Layout
7180 Document\SpecialChar menuseparator
7186 , highlight something, and then hit
7187 \begin_inset Quotes eld
7191 \begin_inset Quotes erd
7197 It is strongly recommended that you save your work before doing this
7202 it is strongly recommended that you not attempt to edit modules while simultaneo
7203 usly working on actual documents
7206 Though of course the developers strive to keep \SpecialChar LyX
7207 stable in such situations,
7208 syntax errors and the like in your module file could cause strange behavior.
7211 \begin_layout Subsubsection
7215 \begin_layout Standard
7216 Modules are to \SpecialChar LyX
7217 as packages are to \SpecialChar LaTeX
7219 Sometimes, however, you find yourself wanting a specific inset or character
7220 style just for one document and writing a module that will also be available
7221 to other documents makes little sense.
7222 What you need is \SpecialChar LyX
7224 \begin_inset Quotes eld
7228 \begin_inset Quotes erd
7234 \begin_layout Standard
7235 You will find it under
7237 Document\SpecialChar menuseparator
7238 Settings\SpecialChar menuseparator
7242 The large text box allows you to enter anything that you might enter in
7243 a layout file or module.
7244 You can think of a document's local layout, in fact, as a module that belongs
7246 So, in particular, you must enter a
7247 \begin_inset Flex Code
7250 \begin_layout Plain Layout
7257 Any format is acceptable, but one would normally use the format current
7259 (In \SpecialChar LyX
7266 , the current layout format is
7275 \begin_layout Standard
7276 When you have entered something in the
7277 \begin_inset Flex Code
7280 \begin_layout Plain Layout
7286 pane, \SpecialChar LyX
7288 \begin_inset Quotes eld
7292 \begin_inset Quotes erd
7295 button at the bottom.
7296 Clicking this button will cause \SpecialChar LyX
7297 to determine whether what you have entered
7298 is valid layout information for the chosen format.
7300 will report the result but, unfortunately, will not tell you what errors
7301 there might have been.
7302 These will be written to the terminal, however, if \SpecialChar LyX
7303 is started from a terminal.
7304 You will not be permitted to save your local layout until you have entered
7308 \begin_layout Standard
7309 The warnings at the end of the previous section apply here, too.
7310 Do not play with local layout while you are actually working, especially
7311 if you have not saved your document.
7312 That said, using local layout with a test document can be a very convenient
7313 way to try out layout ideas, or even to start developing a module.
7316 \begin_layout Subsection
7318 \begin_inset Flex Noun
7321 \begin_layout Plain Layout
7330 \begin_layout Standard
7331 There are two situations you are likely to encounter when wanting to support
7332 a new \SpecialChar LaTeX
7333 document class, involving style (
7334 \begin_inset Flex Code
7337 \begin_layout Plain Layout
7343 ) files and \SpecialChar LaTeX2e
7345 \begin_inset Flex Code
7348 \begin_layout Plain Layout
7355 Supporting a style file is usually fairly easy.
7356 Supporting a new class file is a bit harder.
7357 We'll discuss the former in this section and the latter in the next.
7359 \change_deleted 5863208 1594239023
7360 Similar remarks apply, of course, if you want to support a new DocBook DTD.
7365 \begin_layout Standard
7366 The easier case is the one in which your new document class is provided
7367 as a style file that is to be used in conjunction with an already supported
7369 For the sake of the example, we'll assume that the style file is called
7371 \begin_inset Flex Noun
7374 \begin_layout Plain Layout
7380 and that it is meant to be used with
7381 \begin_inset Flex Noun
7384 \begin_layout Plain Layout
7390 , which is a standard class.
7394 \begin_layout Standard
7395 Start by copying the existing class's layout file into your local directory:
7399 \begin_layout Plain Layout
7400 Of course, which directory is your local directory will vary by platform,
7401 and \SpecialChar LyX
7402 allows you to specify your local directory on startup, too, using
7404 \begin_inset Flex Code
7407 \begin_layout Plain Layout
7421 \begin_layout LyX-Code
7422 cp report.layout ~/.lyx/layouts/myclass.layout
7425 \begin_layout Standard
7427 \begin_inset Flex Code
7430 \begin_layout Plain Layout
7436 and change the line:
7439 \begin_layout LyX-Code
7442 DeclareLaTeXClass{Report (Standard Class)}
7445 \begin_layout Standard
7449 \begin_layout LyX-Code
7452 DeclareLaTeXClass[report, myclass.sty]{Report (My Class)}
7455 \begin_layout Standard
7459 \begin_layout LyX-Code
7461 \begin_inset Newline newline
7467 \begin_inset Newline newline
7473 \begin_layout Standard
7474 near the top of the file.
7477 \begin_layout Standard
7478 Start \SpecialChar LyX
7480 \begin_inset Flex Noun
7483 \begin_layout Plain Layout
7484 Tools\SpecialChar menuseparator
7491 Then restart \SpecialChar LyX
7492 and try creating a new document.
7494 \begin_inset Flex Noun
7497 \begin_layout Plain Layout
7503 " as a document class option in the
7504 \begin_inset Flex Noun
7507 \begin_layout Plain Layout
7508 Document\SpecialChar menuseparator
7515 It is likely that some of the sectioning commands and such in your new
7516 class will work differently from how they worked in the base class—
7517 \begin_inset Flex Code
7520 \begin_layout Plain Layout
7526 in this example—so you can fiddle around with the settings for the different
7527 sections if you wish.
7528 The layout information for sections is contained in
7529 \begin_inset Flex Code
7532 \begin_layout Plain Layout
7538 , but you do not need to copy and change this file.
7539 Instead, you can simply add your changes to your layout file, after the
7541 \begin_inset Flex Code
7544 \begin_layout Plain Layout
7550 , which itself includes
7551 \begin_inset Flex Code
7554 \begin_layout Plain Layout
7561 For example, you might add these lines:
7564 \begin_layout LyX-Code
7568 \begin_layout LyX-Code
7572 \begin_layout LyX-Code
7576 \begin_layout LyX-Code
7580 \begin_layout LyX-Code
7584 \begin_layout Standard
7585 to change the font for chapter headings to sans-serif.
7586 This will override (or, in this case, add to) the existing declaration
7587 for the Chapter style.
7591 \begin_layout Standard
7592 Your new package may also provide commands or environments not present in
7594 In this case, you will want to add these to the layout file.
7596 \begin_inset CommandInset ref
7598 reference "sec:TextClass"
7602 for information on how to do so.
7605 \begin_layout Standard
7607 \begin_inset Flex Noun
7610 \begin_layout Plain Layout
7616 can be used with several different document classes, and even if it cannot,
7617 you might find it easiest just to write a module that you can load with
7619 The simplest possible such module would be:
7622 \begin_layout LyX-Code
7625 DeclareLyXModule{My Class}
7628 \begin_layout LyX-Code
7632 \begin_layout LyX-Code
7633 #Support for myclass.sty.
7636 \begin_layout LyX-Code
7638 \begin_inset Newline newline
7644 \begin_layout LyX-Code
7652 \begin_inset Newline newline
7658 \begin_layout LyX-Code
7660 \begin_inset Newline newline
7666 \begin_inset Newline newline
7672 \begin_layout Standard
7673 A more complex module might modify the behavior of some existing constructs
7674 or define some new ones.
7676 \begin_inset CommandInset ref
7678 reference "sec:TextClass"
7685 \begin_layout Subsection
7687 \begin_inset Flex Noun
7690 \begin_layout Plain Layout
7699 \begin_layout Standard
7700 There are two possibilities here.
7701 One is that the class file is itself based upon an existing document class.
7702 For example, many thesis classes are based upon
7703 \begin_inset Flex Noun
7706 \begin_layout Plain Layout
7713 To see whether yours is, look for a line like
7716 \begin_layout LyX-Code
7722 \begin_layout Standard
7724 If so, then you may proceed largely as in the previous section, though
7726 \begin_inset Flex Code
7729 \begin_layout Plain Layout
7730 Declare\SpecialChar LaTeX
7736 line will be different.
7737 If your new class is
7738 \begin_inset Flex Code
7741 \begin_layout Plain Layout
7747 and it is based upon
7748 \begin_inset Flex Code
7751 \begin_layout Plain Layout
7757 , then the line should read:
7761 \begin_layout Plain Layout
7762 And it will be easiest if you save the file to
7763 \begin_inset Flex Code
7766 \begin_layout Plain Layout
7773 assumes that the document class has the same name as the layout file.
7782 \begin_layout LyX-Code
7785 DeclareLaTeXClass[thesis,book]{thesis}
7788 \begin_layout Standard
7789 If, on the other hand, the new class is not based upon an existing class,
7790 you will probably have to
7791 \begin_inset Quotes eld
7795 \begin_inset Quotes erd
7799 We strongly suggest copying an existing layout file which uses a similar
7801 class and then modifying it, if you can do so.
7802 At least use an existing file as a starting point so you can find out what
7803 items you need to worry about.
7804 Again, the specifics are covered below.
7807 \begin_layout Subsection
7809 \begin_inset CommandInset label
7811 name "subsec:Creating-Templates"
7818 \begin_layout Standard
7819 Once you have written a layout file for a new document class, you might
7820 want to consider writing a
7825 A template acts as a kind of tutorial for your layout, showing how it might
7826 be used, though containing dummy content.
7827 You can of course look at the various templates included with \SpecialChar LyX
7831 \begin_layout Standard
7832 Templates are created just like usual documents: using \SpecialChar LyX
7834 The only difference is that usual documents contain all possible settings,
7835 including the font scheme and the paper size.
7836 Usually a user doesn't want a template to overwrite his preferred settings
7837 for such parameters.
7838 For that reason, the designer of a template should remove the corresponding
7840 \begin_inset Flex Code
7843 \begin_layout Plain Layout
7852 \begin_inset Flex Code
7855 \begin_layout Plain Layout
7863 from the template \SpecialChar LyX
7865 This can be done with any simple text-editor, for example
7866 \begin_inset Flex Code
7869 \begin_layout Plain Layout
7876 \begin_inset Flex Code
7879 \begin_layout Plain Layout
7888 \begin_layout Standard
7889 Put the edited template files you create in
7890 \begin_inset Flex Code
7893 \begin_layout Plain Layout
7899 , copy the ones you use from the global template directory in
7900 \begin_inset Flex Code
7903 \begin_layout Plain Layout
7909 to the same place, and redefine the template path in the
7910 \begin_inset Flex Noun
7913 \begin_layout Plain Layout
7914 Tools\SpecialChar menuseparator
7915 Preferences\SpecialChar menuseparator
7924 \begin_layout Standard
7925 Note, by the way, that there is a template which has a particular meaning:
7926 \begin_inset Newline linebreak
7930 \begin_inset Flex Code
7933 \begin_layout Plain Layout
7940 This template is loaded every time you create a new document with
7941 \begin_inset Flex Noun
7944 \begin_layout Plain Layout
7945 File\SpecialChar menuseparator
7951 in order to provide useful defaults.
7952 To create this template from inside \SpecialChar LyX
7953 , all you have to do is to open a document
7954 with the correct settings, and use the
7955 \begin_inset Flex Noun
7958 \begin_layout Plain Layout
7959 Save as Document Defaults
7967 \begin_layout Subsection
7968 Upgrading old layout files
7971 \begin_layout Standard
7972 The format of layout files changes with each \SpecialChar LyX
7973 release, so old layout files
7974 need to be converted to the new format.
7976 reads a layout file in an older format, it automatically calls the
7978 \begin_inset Flex Code
7981 \begin_layout Plain Layout
7987 to convert it to a temporary file in current format.
7988 The original file is left untouched.
7989 If you use the layout file often, then, you may want to convert it permanently,
7990 so that \SpecialChar LyX
7991 does not have to do so itself every time.
7992 To do this, you can call the converter manually:
7995 \begin_layout Enumerate
7997 \begin_inset Flex Code
8000 \begin_layout Plain Layout
8007 \begin_inset Flex Code
8010 \begin_layout Plain Layout
8019 \begin_layout Enumerate
8021 \begin_inset Newline newline
8025 \begin_inset Flex Code
8028 \begin_layout Plain Layout
8029 python LyXDir/scripts/layout2layout.py myclass.old myclass.layout
8035 \begin_inset Newline newline
8039 \begin_inset Flex Code
8042 \begin_layout Plain Layout
8048 is the name of your \SpecialChar LyX
8052 \begin_layout Standard
8053 Note that manual conversion does not affect included files, so these will
8054 have to be converted separately.
8057 \begin_layout Subsection
8058 \begin_inset CommandInset label
8060 name "subsec:Cite-Engine-Files"
8067 \begin_layout Standard
8068 A specific form of layout files are the so-called
8069 \begin_inset Flex Code
8072 \begin_layout Plain Layout
8078 files that are located in the
8079 \begin_inset Flex Code
8082 \begin_layout Plain Layout
8089 Their purpose is to define the specifics of \SpecialChar LaTeX
8090 packages aimed at bibliography
8103 , but also the way how normal Bib\SpecialChar TeX
8104 citations (without additional packages)
8105 are handled in \SpecialChar LyX
8106 is defined in such a file.
8110 \begin_layout Standard
8111 More specifically, it is defined which packages \SpecialChar LyX
8112 needs to load, which citation
8113 commands are available, how these are to be displayed in \SpecialChar LyX
8115 the dialogs, the context menus) as well as in the XHTML and plain text
8117 Furthermore, the files specify available style variants (author-year, numerical
8118 , etc.) and their specifics.
8119 The cite engine files are also used to generate the options that are available
8122 Document\SpecialChar menuseparator
8123 Settings\SpecialChar menuseparator
8124 Bibliography\SpecialChar menuseparator
8130 \begin_layout Standard
8131 Even though a cite engine file is essentially a normal layout file that
8132 could theoretically include any layout information, it usually primarily
8133 includes some specific parameters such as
8134 \begin_inset Flex Code
8137 \begin_layout Plain Layout
8144 \begin_inset Flex Code
8147 \begin_layout Plain Layout
8154 \begin_inset Flex Code
8157 \begin_layout Plain Layout
8164 \begin_inset Flex Code
8167 \begin_layout Plain Layout
8174 The syntax of the latter two is described in
8175 \begin_inset CommandInset ref
8177 reference "subsec:Citation-engine-description"
8185 \begin_inset CommandInset ref
8187 reference "subsec:Citation-format-description"
8191 , as well as in the files themselves.
8194 \begin_layout Section
8195 \begin_inset CommandInset label
8197 name "sec:TextClass"
8201 The layout file format
8204 \begin_layout Standard
8205 The following sections describe how layout files are structured and written.
8206 Our advice is to go slowly, save and test often.
8207 It is really not that hard, except that the multitude of options can become
8208 overwhelming, especially if you try to check out too many at once.
8209 It becomes easier if you use existing layouts of \SpecialChar LyX
8210 as examples/reference
8211 or if you modify an existing layout to your needs.
8214 \begin_layout Standard
8215 Note that all the tags used in layout files are case-insensitive.
8217 \begin_inset Flex Code
8220 \begin_layout Plain Layout
8227 \begin_inset Flex Code
8230 \begin_layout Plain Layout
8237 \begin_inset Flex Code
8240 \begin_layout Plain Layout
8246 are really the same tag.
8247 The possible arguments are printed in brackets after the tag's name.
8248 The default argument is typeset
8249 \begin_inset Flex Code
8252 \begin_layout Plain Layout
8261 If the argument has a data type like
8262 \begin_inset Quotes eld
8266 \begin_inset Quotes erd
8270 \begin_inset Quotes eld
8274 \begin_inset Quotes erd
8277 , the default is shown like this:
8278 \begin_inset Flex Code
8281 \begin_layout Plain Layout
8292 \begin_layout Subsection
8293 The document class declaration and classification
8296 \begin_layout Standard
8297 Lines in a layout file which begin with
8298 \begin_inset Flex Code
8301 \begin_layout Plain Layout
8308 There is one exception to this rule.
8310 \begin_inset Flex Code
8313 \begin_layout Plain Layout
8319 files should begin with lines like:
8322 \begin_layout LyX-Code
8325 #% Do not delete the line below; configure depends on this
8328 \begin_layout LyX-Code
8333 DeclareLaTeXClass{Article (Standard Class)}
8336 \begin_layout LyX-Code
8341 DeclareCategory{Articles}
8344 \begin_layout Standard
8345 The second and third lines are used when you (re)configure \SpecialChar LyX
8347 The layout file is read by the \SpecialChar LaTeX
8349 \begin_inset Flex Code
8352 \begin_layout Plain Layout
8358 , in a special mode where
8359 \begin_inset Flex Code
8362 \begin_layout Plain Layout
8369 The first line is just a \SpecialChar LaTeX
8370 comment, the second one contains the mandatory
8371 declaration of the text class and the third line contains the optional
8372 classification of the class.
8373 If these lines appear in a file named
8374 \begin_inset Flex Code
8377 \begin_layout Plain Layout
8383 , then they define a text class of name
8384 \begin_inset Flex Code
8387 \begin_layout Plain Layout
8393 (the name of the layout file) which uses the \SpecialChar LaTeX
8395 \begin_inset Flex Code
8398 \begin_layout Plain Layout
8404 (the default is to use the same name as the layout).
8406 \begin_inset Quotes eld
8409 Article (Standard Class)
8410 \begin_inset Quotes erd
8413 that appears above is used as a description of the text class in the
8414 \begin_inset Flex Noun
8417 \begin_layout Plain Layout
8418 Document\SpecialChar menuseparator
8426 \begin_inset Quotes eld
8430 \begin_inset Quotes erd
8433 in the example) is also used in the
8434 \begin_inset Flex Noun
8437 \begin_layout Plain Layout
8438 Document\SpecialChar menuseparator
8444 dialog: the text classes are grouped by these categories (which are usually
8445 genres, so typical categories are
8446 \begin_inset Quotes eld
8450 \begin_inset Quotes erd
8454 \begin_inset Quotes eld
8458 \begin_inset Quotes erd
8462 \begin_inset Quotes eld
8466 \begin_inset Quotes erd
8470 \begin_inset Quotes eld
8474 \begin_inset Quotes erd
8478 \begin_inset Quotes eld
8482 \begin_inset Quotes erd
8486 \begin_inset Quotes eld
8490 \begin_inset Quotes erd
8494 If no category has been declared, the class will be put in the
8495 \begin_inset Quotes eld
8499 \begin_inset Quotes erd
8505 \begin_layout Standard
8506 Let's assume that you wrote your own text class that uses the
8507 \begin_inset Flex Code
8510 \begin_layout Plain Layout
8516 document class, but where you changed the appearance of the section headings.
8517 If you put it in a file
8518 \begin_inset Flex Code
8521 \begin_layout Plain Layout
8527 , the header of this file should be:
8530 \begin_layout LyX-Code
8533 #% Do not delete the line below; configure depends on this
8536 \begin_layout LyX-Code
8541 DeclareLaTeXClass[article]{Article (with My Own Headings)}
8544 \begin_layout LyX-Code
8549 DeclareCategory{Articles}
8552 \begin_layout Standard
8553 This declares a text class
8554 \begin_inset Flex Code
8557 \begin_layout Plain Layout
8563 , associated with the \SpecialChar LaTeX
8565 \begin_inset Flex Code
8568 \begin_layout Plain Layout
8575 \begin_inset Quotes eld
8578 Article (with My Own Headings)
8579 \begin_inset Quotes erd
8583 If your text class depends on several packages, you can declare it as:
8586 \begin_layout LyX-Code
8589 #% Do not delete the line below; configure depends on this
8592 \begin_layout LyX-Code
8597 DeclareLaTeXClass[article,foo.sty]{Article (with My Own Headings)}
8600 \begin_layout LyX-Code
8605 DeclareCategory{Articles}
8608 \begin_layout Standard
8609 This indicates that your text class uses the
8610 \begin_inset Flex Code
8613 \begin_layout Plain Layout
8621 \change_deleted 5863208 1594239179
8622 Finally, it is also possible to declare classes for DocBook code.
8623 Typical declarations will look like:
8626 \begin_layout LyX-Code
8628 \change_deleted 5863208 1594239179
8631 #% Do not delete the line below; configure depends on this
8634 \begin_layout LyX-Code
8636 \change_deleted 5863208 1594239179
8641 DeclareDocBookClass[article]{SGML (DocBook Article)}
8644 \begin_layout LyX-Code
8646 \change_deleted 5863208 1594239179
8651 DeclareCategory{Articles (DocBook)}
8656 \begin_layout Standard
8657 Note that these declarations can also be given an optional parameter declaring
8658 the name of the document class (but not a list).
8661 \begin_layout Standard
8662 So, to be as explicit as possible, the form of the layout declaration is:
8665 \begin_layout LyX-Code
8670 DeclareLaTeXClass[class,package.sty]{layout description}
8673 \begin_layout LyX-Code
8678 DeclareCategory{category}
8681 \begin_layout Standard
8682 The class need only be specified if the name of the \SpecialChar LaTeX
8684 name of the layout file are different or if there are packages to load.
8685 If the name of the class file is not specified, then \SpecialChar LyX
8687 that it is the same as the name of the layout file.
8690 \begin_layout Standard
8691 When the text class has been modified to your taste, all you have to do
8692 is to copy it either to
8693 \begin_inset Flex Code
8696 \begin_layout Plain Layout
8703 \begin_inset Flex Code
8706 \begin_layout Plain Layout
8713 \begin_inset Flex Noun
8716 \begin_layout Plain Layout
8717 Tools\SpecialChar menuseparator
8723 , exit \SpecialChar LyX
8725 Then your new text class should be available along with the others.
8728 \begin_layout Standard
8729 Once the layout file is installed, you can edit it and see your changes
8730 without having to reconfigure or to restart \SpecialChar LyX
8735 \begin_layout Plain Layout
8736 In versions of \SpecialChar LyX
8737 prior to 1.6, this was not true.
8738 As a result, editing layout files was very time consuming, since you had
8739 constantly to restart \SpecialChar LyX
8745 You can force a reload of the current layout by using the \SpecialChar LyX
8747 \begin_inset Flex Noun
8750 \begin_layout Plain Layout
8757 There is no default binding for this function—though, of course, you can
8758 bind it to a key yourself.
8759 But you will normally use this function simply by entering it in the mini-buffe
8764 \begin_layout Standard
8770 \begin_inset Flex Noun
8773 \begin_layout Plain Layout
8779 is very much an `advanced feature'.
8784 recommended that you save your work before using this function.
8789 recommended that you not attempt to edit layout information while simultaneousl
8790 y working on a document that you care about.
8791 Use a test document.
8792 Syntax errors and the like in your layout file could cause peculiar behavior.
8793 In particular, such errors could cause \SpecialChar LyX
8794 to regard the current layout as
8795 invalid and to attempt to switch to some other layout.
8799 \begin_layout Plain Layout
8800 Really bad syntax errors may even caused \SpecialChar LyX
8802 This is because certain sorts of errors may make \SpecialChar LyX
8813 The \SpecialChar LyX
8814 team strives to keep \SpecialChar LyX
8815 stable in such situations, but safe is better
8820 \begin_layout Plain Layout
8821 While we're giving advice: make regular backups.
8822 And be nice to your mother.
8830 \begin_layout Subsection
8831 The Module declaration
8834 \begin_layout Standard
8835 A module must begin with a line like the following:
8838 \begin_layout LyX-Code
8841 DeclareLyXModule[endnotes.sty]{Endnotes}
8842 \change_inserted -712698321 1554395911
8846 \begin_layout LyX-Code
8848 \change_inserted -712698321 1554395924
8853 DeclareCategory{Foot- and Endnotes}
8854 \change_deleted -712698321 1554395911
8862 \begin_layout Standard
8863 The mandatory argument
8864 \change_inserted -712698321 1554395956
8873 , in curly brackets, is the name of the module, as it should appear in
8874 \begin_inset Flex Noun
8877 \begin_layout Plain Layout
8878 Document\SpecialChar menuseparator
8879 Settings\SpecialChar menuseparator
8886 The argument in square brackets is optional: It declares any \SpecialChar LaTeX
8888 on which the module depends.
8889 It is also possible to use the form
8890 \begin_inset Flex Noun
8893 \begin_layout Plain Layout
8899 as an optional argument, which declares that the module can only be used
8900 when there exists a conversion chain between the formats `
8901 \begin_inset Flex Code
8904 \begin_layout Plain Layout
8911 \begin_inset Flex Code
8914 \begin_layout Plain Layout
8922 \change_inserted -712698321 1554396133
8929 declaration is not strictly mandatory, but you should add it, since it
8930 is helpful to find the module.
8931 Please have a look at the existing module categories and if appropriate,
8937 \begin_layout Standard
8939 \change_inserted -712698321 1554395988
8942 declaration should then be followed by lines like the following:
8946 \begin_layout Plain Layout
8947 Preferably in English if the module should be published with \SpecialChar LyX
8949 This description will appear in the list of messages to be translated and
8950 will be thus translated with the next interface update.
8958 \begin_layout LyX-Code
8962 \begin_layout LyX-Code
8963 #Adds an endnote command, in addition to footnotes.
8967 \begin_layout LyX-Code
8968 #You will need to add
8970 theendnotes in TeX code where you
8973 \begin_layout LyX-Code
8974 #want the endnotes to appear.
8978 \begin_layout LyX-Code
8982 \begin_layout LyX-Code
8983 #Requires: somemodule | othermodule
8986 \begin_layout LyX-Code
8987 #Excludes: badmodule
8990 \begin_layout Standard
8991 The description is used in
8992 \begin_inset Flex Noun
8995 \begin_layout Plain Layout
8996 Document\SpecialChar menuseparator
8997 Settings\SpecialChar menuseparator
9003 to provide the user with information about what the module does.
9005 \begin_inset Flex Code
9008 \begin_layout Plain Layout
9014 line is used to identify other modules with which this one must be used;
9016 \begin_inset Flex Code
9019 \begin_layout Plain Layout
9025 line is used to identify modules with which this one may not be used.
9026 Both are optional, and, as shown, multiple modules should be separated
9027 with the pipe symbol: |.
9028 Note that the required modules are treated disjunctively:
9032 of the required modules must be used.
9037 excluded module may be used.
9038 Note that modules are identified here by their filenames without the
9039 \begin_inset Flex Code
9042 \begin_layout Plain Layout
9050 \begin_inset Flex Code
9053 \begin_layout Plain Layout
9060 \begin_inset Flex Code
9063 \begin_layout Plain Layout
9072 \begin_layout Subsection
9073 The CiteEngine file declaration
9076 \begin_layout Standard
9077 A cite engine file must begin with a line like the following:
9080 \begin_layout LyX-Code
9083 DeclareLyXCiteEngineModule[biblatex.sty]{Biblatex}
9086 \begin_layout Standard
9087 The mandatory argument, in curly brackets, is the name of the cite style,
9088 as it should appear in
9089 \begin_inset Flex Noun
9092 \begin_layout Plain Layout
9093 Document\SpecialChar menuseparator
9094 Settings\SpecialChar menuseparator
9101 The argument in square brackets is optional: It declares any \SpecialChar LaTeX
9103 on which the cite engine depends.
9106 \begin_layout Standard
9107 The cite engine declaration should then be followed by lines like the following:
9111 \begin_layout Plain Layout
9112 Preferably in English if the module should be published with \SpecialChar LyX
9114 This description will appear in the list of messages to be translated and
9115 will be thus translated with the next interface update.
9123 \begin_layout LyX-Code
9127 \begin_layout LyX-Code
9128 # Biblatex supports many author-year and numerical styles.
9131 \begin_layout LyX-Code
9132 # It is mainly aimed at the Humanities.
9136 \begin_layout LyX-Code
9137 # customizable, fully localized and provides many features
9140 \begin_layout LyX-Code
9141 # that are not possible with BibTeX.
9142 The use of 'biber' as
9145 \begin_layout LyX-Code
9146 # bibliography processor is advised.
9149 \begin_layout LyX-Code
9153 \begin_layout Standard
9154 The description is used in
9155 \begin_inset Flex Noun
9158 \begin_layout Plain Layout
9159 Document\SpecialChar menuseparator
9160 Settings\SpecialChar menuseparator
9166 to provide the user with information about the cite engine.
9169 \begin_layout Subsection
9173 \begin_layout Standard
9174 The first non-comment line of any layout file, included file, or module
9179 contain the file format number:
9182 \begin_layout Description
9183 \begin_inset Flex Code
9186 \begin_layout Plain Layout
9193 \begin_inset Flex Code
9196 \begin_layout Plain Layout
9202 ] The format number of the layout file.
9205 \begin_layout Standard
9206 This tag was introduced with \SpecialChar LyX
9208 \begin_inset space ~
9212 Layout files from older \SpecialChar LyX
9213 versions do not have an explicit file format and
9214 are considered to have
9215 \begin_inset Flex Code
9218 \begin_layout Plain Layout
9220 \begin_inset space ~
9229 The format for the present version of \SpecialChar LyX
9231 But each version of \SpecialChar LyX
9232 is capable of reading earlier versions' layout files,
9233 just as they are capable of reading files produced by earlier versions
9236 There is, however, no provision for converting to earlier formats.
9239 \begin_layout Subsection
9240 \begin_inset CommandInset label
9242 name "subsec:General-text-class"
9246 General text class parameters
9249 \begin_layout Standard
9250 These are general parameters that govern the behavior of an entire document
9256 mean that they must appear in
9257 \begin_inset Flex Code
9260 \begin_layout Plain Layout
9266 files rather than in modules.
9267 A module can contain any layout tag.)
9270 \begin_layout Description
9272 \change_inserted -712698321 1526899478
9273 \begin_inset Flex Code
9276 \begin_layout Plain Layout
9278 \change_inserted -712698321 1526898610
9279 AddToCiteEngine <engine>
9286 Extends the possibilities for displaying citation references.
9288 \begin_inset CommandInset ref
9290 reference "subsec:Citation-engine-description"
9299 \begin_inset Flex Code
9302 \begin_layout Plain Layout
9304 \change_inserted -712698321 1526898823
9315 \begin_layout Description
9316 \begin_inset Flex Code
9319 \begin_layout Plain Layout
9325 Adds information that will be output in the
9326 \begin_inset Flex Code
9329 \begin_layout Plain Layout
9335 block when the document is output to XHTML.
9336 Typically, this would be used to output CSS style information, but it can
9337 be used for anything that can appear in
9338 \begin_inset Flex Code
9341 \begin_layout Plain Layout
9349 \begin_inset Quotes eld
9353 \begin_inset Flex Code
9356 \begin_layout Plain Layout
9363 \begin_inset Quotes erd
9369 \begin_layout Description
9370 \begin_inset Flex Code
9373 \begin_layout Plain Layout
9379 Adds information to the document preamble.
9381 \begin_inset Newline newline
9385 \begin_inset Quotes eld
9389 \begin_inset Flex Code
9392 \begin_layout Plain Layout
9399 \begin_inset Quotes erd
9403 \change_inserted -712698321 1562592950
9407 \begin_layout Description
9409 \change_inserted -712698321 1562593040
9410 \begin_inset Flex Code
9413 \begin_layout Plain Layout
9415 \change_inserted -712698321 1562592954
9424 \begin_inset Flex Code
9427 \begin_layout Plain Layout
9429 \change_inserted -712698321 1562592950
9440 \begin_inset space \thinspace{}
9444 \begin_inset Flex Code
9447 \begin_layout Plain Layout
9449 \change_inserted -712698321 1562592950
9457 ] If the document class adds the bibliography to the table of contents,
9458 add this option with value
9459 \begin_inset Flex Code
9462 \begin_layout Plain Layout
9464 \change_inserted -712698321 1562592996
9473 \begin_inset Flex Code
9476 \begin_layout Plain Layout
9478 \change_inserted -712698321 1562593006
9487 This prevents the bibliography from being added twice.
9492 \begin_layout Description
9493 \begin_inset Flex Code
9496 \begin_layout Plain Layout
9502 Defines the possibilities for displaying citation references.
9504 \begin_inset CommandInset ref
9506 reference "subsec:Citation-engine-description"
9515 \begin_inset Quotes eld
9519 \begin_inset Flex Code
9522 \begin_layout Plain Layout
9529 \begin_inset Quotes erd
9533 Primarily used in cite engine files (see
9534 \begin_inset CommandInset ref
9536 reference "subsec:Cite-Engine-Files"
9545 \change_inserted -712698321 1526898530
9546 Note that if you specify this in a layout file or module, any cite engine
9547 definition will be overridden.
9549 \begin_inset Flex Code
9552 \begin_layout Plain Layout
9554 \change_inserted -712698321 1526898530
9567 \begin_layout Description
9568 \begin_inset Flex Code
9571 \begin_layout Plain Layout
9577 Defines formats for use in the display of bibliographic information.
9579 \begin_inset CommandInset ref
9581 reference "subsec:Citation-format-description"
9587 \begin_inset Quotes eld
9591 \begin_inset Flex Code
9594 \begin_layout Plain Layout
9601 \begin_inset Quotes erd
9605 Primarily used in cite engine files (see
9606 \begin_inset CommandInset ref
9608 reference "subsec:Cite-Engine-Files"
9617 \change_inserted -712698321 1526898585
9618 A cite format defined in a layout or module will override the cite engine
9624 \begin_layout Description
9625 \begin_inset Flex Code
9628 \begin_layout Plain Layout
9635 \begin_inset Flex Code
9638 \begin_layout Plain Layout
9647 \begin_inset Flex Code
9650 \begin_layout Plain Layout
9656 ] Determines whether
9660 or Bib\SpecialChar TeX
9661 is used to generate a Bibliography.
9662 Primarily used in cite engine files (see
9663 \begin_inset CommandInset ref
9665 reference "subsec:Cite-Engine-Files"
9675 \begin_layout Description
9676 \begin_inset Flex Code
9679 \begin_layout Plain Layout
9685 Describes various global options supported by the document class.
9687 \begin_inset CommandInset ref
9689 reference "subsec:ClassOptions"
9695 \begin_inset Quotes eld
9699 \begin_inset Flex Code
9702 \begin_layout Plain Layout
9709 \begin_inset Quotes erd
9715 \begin_layout Description
9716 \begin_inset Flex Code
9719 \begin_layout Plain Layout
9726 \begin_inset Flex Code
9729 \begin_layout Plain Layout
9738 \begin_inset space \thinspace{}
9742 \begin_inset Flex Code
9745 \begin_layout Plain Layout
9751 ] Whether the class should
9755 to having one or two columns.
9756 Can be changed in the
9757 \begin_inset Flex Noun
9760 \begin_layout Plain Layout
9761 Document\SpecialChar menuseparator
9770 \begin_layout Description
9771 \begin_inset Flex Code
9774 \begin_layout Plain Layout
9781 \begin_inset Flex Code
9784 \begin_layout Plain Layout
9790 ] This sequence defines the properties for a counter.
9791 If the counter does not yet exist, it is created; if it does exist, it
9794 \begin_inset Quotes eld
9798 \begin_inset Flex Code
9801 \begin_layout Plain Layout
9808 \begin_inset Quotes erd
9812 \begin_inset Newline newline
9816 \begin_inset CommandInset ref
9818 reference "subsec:Counters"
9822 for details on counters.
9825 \begin_layout Description
9826 \begin_inset Flex Code
9829 \begin_layout Plain Layout
9835 Sets the default font used to display the document.
9837 \begin_inset CommandInset ref
9839 reference "subsec:Font-description"
9843 for how to declare fonts.
9845 \begin_inset Quotes eld
9849 \begin_inset Flex Code
9852 \begin_layout Plain Layout
9859 \begin_inset Quotes erd
9865 \begin_layout Description
9866 \begin_inset Flex Code
9869 \begin_layout Plain Layout
9876 \begin_inset Flex Code
9879 \begin_layout Plain Layout
9885 ] Specifies a module to be included by default with this document class.
9886 The module is specified as filename without the
9887 \begin_inset Flex Code
9890 \begin_layout Plain Layout
9897 The user can still remove the module, but it will be active at the outset.
9898 (This applies only when new files are created, or when this class is chosen
9899 for an existing document.)
9902 \begin_layout Description
9903 \begin_inset Flex Code
9906 \begin_layout Plain Layout
9913 \begin_inset Flex Code
9916 \begin_layout Plain Layout
9922 ] This is the style that will be assigned to new paragraphs, usually
9923 \begin_inset Flex Noun
9926 \begin_layout Plain Layout
9933 This will default to the first defined style if not given, but you are
9934 encouraged to use this directive.
9937 \begin_layout Description
9939 \change_inserted -970929547 1515112870
9940 \begin_inset Flex Code
9943 \begin_layout Plain Layout
9945 \change_inserted -970929547 1515112782
9954 \begin_inset Flex Code
9957 \begin_layout Plain Layout
9959 \change_inserted -970929547 1515112766
9967 ] The root element (at the top of the document) to use when outputting documents
9968 with this class in DocBook.
9969 The default value is
9970 \begin_inset Quotes eld
9974 \begin_inset Flex Code
9977 \begin_layout Plain Layout
9979 \change_inserted -970929547 1515112845
9988 \begin_inset Quotes erd
9993 \change_deleted 1075283030 1594226862
9995 \change_inserted 1075283030 1594226777
9999 \begin_layout Description
10001 \change_inserted 1075283030 1594226859
10002 \begin_inset Flex Code
10005 \begin_layout Plain Layout
10007 \change_inserted 1075283030 1594226785
10008 DocBookForceAbstract
10016 \begin_inset Flex Code
10019 \begin_layout Plain Layout
10021 \change_inserted 1075283030 1594226804
10030 \begin_inset Quotes eld
10038 \begin_inset Quotes erd
10041 , the root element will always have an
10046 The default value is
10047 \begin_inset Quotes eld
10055 \begin_inset Quotes erd
10063 \begin_layout Description
10064 \begin_inset Flex Code
10067 \begin_layout Plain Layout
10074 \begin_inset Flex Code
10077 \begin_layout Plain Layout
10083 ] This tag indicates that the module (which is specified by filename without
10085 \begin_inset Flex Code
10088 \begin_layout Plain Layout
10094 extension) cannot be used with this document class.
10095 This might be used in a journal-specific layout file to prevent, say, the
10097 \begin_inset Flex Code
10100 \begin_layout Plain Layout
10106 module that numbers theorems by section.
10111 be used in a module.
10112 Modules have their own way of excluding other modules (see
10113 \begin_inset CommandInset ref
10115 reference "subsec:Layout-modules"
10122 \begin_layout Description
10123 \begin_inset Flex Code
10126 \begin_layout Plain Layout
10132 Defines a new float.
10134 \begin_inset CommandInset ref
10136 reference "subsec:Floats"
10142 \begin_inset Quotes eld
10146 \begin_inset Flex Code
10149 \begin_layout Plain Layout
10156 \begin_inset Quotes erd
10162 \begin_layout Description
10163 \begin_inset Flex Code
10166 \begin_layout Plain Layout
10172 Sets the information that will be output in the
10173 \begin_inset Flex Code
10176 \begin_layout Plain Layout
10182 block when this document class is output to XHTML.
10183 Note that this will completely override any prior
10184 \begin_inset Flex Code
10187 \begin_layout Plain Layout
10194 \begin_inset Flex Code
10197 \begin_layout Plain Layout
10205 \begin_inset Newline newline
10209 \begin_inset Flex Code
10212 \begin_layout Plain Layout
10218 if you just want to add material to the preamble.) Must end with
10219 \begin_inset Quotes eld
10223 \begin_inset Flex Code
10226 \begin_layout Plain Layout
10233 \begin_inset Quotes erd
10239 \begin_layout Description
10240 \begin_inset Flex Code
10243 \begin_layout Plain Layout
10250 \begin_inset Flex Code
10253 \begin_layout Plain Layout
10259 ] The style to use for the table of contents, bibliography, and so forth,
10260 when the document is output to HTML.
10261 For articles, this should normally be
10262 \begin_inset Flex Code
10265 \begin_layout Plain Layout
10272 \begin_inset Flex Code
10275 \begin_layout Plain Layout
10282 If it is not given, then \SpecialChar LyX
10283 will attempt to figure out which layout to use.
10286 \begin_layout Description
10287 \begin_inset Flex Code
10290 \begin_layout Plain Layout
10297 \begin_inset Flex Code
10300 \begin_layout Plain Layout
10306 ] Modifies the properties of the given counter.
10307 If the counter does not exist, the statement is ignored.
10309 \begin_inset Quotes eld
10313 \begin_inset Flex Code
10316 \begin_layout Plain Layout
10323 \begin_inset Quotes erd
10327 \begin_inset Newline newline
10331 \begin_inset CommandInset ref
10333 reference "subsec:Counters"
10337 for details on counters.
10340 \begin_layout Description
10341 \begin_inset Flex Code
10344 \begin_layout Plain Layout
10351 \begin_inset Flex Code
10354 \begin_layout Plain Layout
10360 ] This allows you to include another layout definition file within yours
10361 to avoid duplicating commands.
10362 Common examples are the standard layout files, for example,
10363 \begin_inset Flex Code
10366 \begin_layout Plain Layout
10372 , which contains most of the basic layouts.
10375 \begin_layout Description
10376 \begin_inset Flex Code
10379 \begin_layout Plain Layout
10386 \begin_inset Flex Code
10389 \begin_layout Plain Layout
10395 ] This section (re-)defines the layout of an inset.
10396 It can be applied to an existing inset or to a new, user-defined inset,
10397 e.g., a new character style.
10399 \begin_inset Quotes eld
10403 \begin_inset Flex Code
10406 \begin_layout Plain Layout
10413 \begin_inset Quotes erd
10417 \begin_inset Newline newline
10421 \begin_inset CommandInset ref
10423 reference "subsec:Flex-insets-and"
10427 for more information.
10431 \begin_layout Description
10432 \begin_inset Flex Code
10435 \begin_layout Plain Layout
10442 \begin_inset Flex Code
10445 \begin_layout Plain Layout
10451 ] A string that indicates the width of the left margin on the screen, for
10453 \begin_inset Quotes eld
10457 \begin_inset Flex Code
10460 \begin_layout Plain Layout
10467 \begin_inset Quotes erd
10471 (Note that this is not a `length', like
10472 \begin_inset Quotes eld
10476 \begin_inset Quotes erd
10482 \begin_layout Description
10483 \begin_inset Flex Code
10486 \begin_layout Plain Layout
10493 \begin_inset Flex Code
10496 \begin_layout Plain Layout
10502 ] An integer that determines the maximal number of names displayed in an
10503 author-year citation before the citation switches to
10504 \begin_inset Quotes eld
10508 \begin_inset Quotes erd
10512 Primarily used in cite engine files (see
10513 \begin_inset CommandInset ref
10515 reference "subsec:Cite-Engine-Files"
10525 \begin_layout Description
10526 \begin_inset Flex Code
10529 \begin_layout Plain Layout
10536 \begin_inset Flex Code
10539 \begin_layout Plain Layout
10545 ] Modifies the properties of the given paragraph style.
10546 If the style does not exist, this section is ignored.
10548 \begin_inset Quotes eld
10552 \begin_inset Flex Code
10555 \begin_layout Plain Layout
10562 \begin_inset Quotes erd
10568 \begin_layout Description
10569 \begin_inset Flex Code
10572 \begin_layout Plain Layout
10579 \begin_inset Flex Code
10582 \begin_layout Plain Layout
10588 ] Deletes an existing counter, usually one defined in an included file.
10591 \begin_layout Description
10592 \begin_inset Flex Code
10595 \begin_layout Plain Layout
10602 \begin_inset Flex Code
10605 \begin_layout Plain Layout
10611 ] Deletes an existing float.
10612 This is particularly useful when you want to suppress a float that has
10613 been defined in an input file.
10616 \begin_layout Description
10617 \begin_inset Flex Code
10620 \begin_layout Plain Layout
10627 \begin_inset Flex Code
10630 \begin_layout Plain Layout
10636 ] Deletes an existing style.
10639 \begin_layout Description
10640 \begin_inset Flex Code
10643 \begin_layout Plain Layout
10650 \begin_inset Flex Code
10653 \begin_layout Plain Layout
10660 \begin_inset Flex Code
10663 \begin_layout Plain Layout
10669 ] Define a new table of contents with type
10670 \begin_inset Flex Code
10673 \begin_layout Plain Layout
10680 \begin_inset Flex Code
10683 \begin_layout Plain Layout
10690 See also the AddToToc commands.
10693 \begin_layout Description
10694 \begin_inset Flex Code
10697 \begin_layout Plain Layout
10704 \begin_inset Flex Code
10707 \begin_layout Plain Layout
10713 ] The file format (as defined in the \SpecialChar LyX
10714 preferences) produced by this document
10716 It is mainly useful when
10717 \begin_inset Flex Code
10720 \begin_layout Plain Layout
10727 \begin_inset Flex Code
10730 \begin_layout Plain Layout
10736 and one wants to define a new type of literate document.
10737 The format is reset to
10738 \change_deleted 5863208 1594239413
10740 \begin_inset Quotes eld
10744 \begin_inset Flex Code
10747 \begin_layout Plain Layout
10754 \begin_inset Quotes erd
10760 \begin_inset Quotes eld
10764 \begin_inset Flex Code
10767 \begin_layout Plain Layout
10774 \begin_inset Quotes erd
10777 when the corresponding
10778 \begin_inset Flex Code
10781 \begin_layout Plain Layout
10787 parameter is encountered.
10790 \begin_layout Description
10791 \begin_inset Flex Code
10794 \begin_layout Plain Layout
10801 \begin_inset Flex Code
10804 \begin_layout Plain Layout
10815 \change_deleted 5863208 1594239430
10817 \begin_inset Flex Code
10820 \begin_layout Plain Layout
10829 \begin_inset Flex Code
10832 \begin_layout Plain Layout
10838 ] Specifies what sort of output documents using this class will produce.
10841 \begin_layout Description
10842 \begin_inset Flex Code
10845 \begin_layout Plain Layout
10852 \begin_inset Flex Code
10855 \begin_layout Plain Layout
10862 \begin_inset Flex Code
10865 \begin_layout Plain Layout
10871 ] Specifies options, given in the second string, for the package named by
10874 \begin_inset Quotes eld
10878 \begin_inset Flex Code
10881 \begin_layout Plain Layout
10882 PackageOptions natbib square
10888 \begin_inset Quotes erd
10892 \begin_inset Flex Code
10895 \begin_layout Plain Layout
10901 to be loaded with the
10902 \begin_inset Flex Code
10905 \begin_layout Plain Layout
10912 (For \SpecialChar TeX
10913 perts, this causes \SpecialChar LyX
10915 \begin_inset Flex Code
10918 \begin_layout Plain Layout
10921 PassOptionsToPackage{natbib}{square}
10927 \begin_inset Flex Code
10930 \begin_layout Plain Layout
10937 \change_inserted -712698321 1565102364
10941 \begin_layout Description
10943 \change_inserted -712698321 1565102470
10944 \begin_inset Flex Code
10947 \begin_layout Plain Layout
10949 \change_inserted -712698321 1565102365
10958 \begin_inset Flex Code
10961 \begin_layout Plain Layout
10963 \change_inserted -712698321 1565105222
10968 , letter, legal, executive, a0, a1, a2, a3, a4, a5, a6, b0, b1, b2, b3,
10969 b4, b5, b6, c0, c1, c2, c3, c4, c5, c6, b0j, b1j, b2j, b3j, b4j, b5j, b6j
10976 ] The default page size.
10977 This is used by some converters.
10982 \begin_layout Description
10983 \begin_inset Flex Code
10986 \begin_layout Plain Layout
10993 \begin_inset Flex Code
10996 \begin_layout Plain Layout
11005 \begin_inset Flex Code
11008 \begin_layout Plain Layout
11015 \begin_inset Flex Code
11018 \begin_layout Plain Layout
11024 ] The default pagestyle.
11025 Can be changed in the
11026 \begin_inset Flex Noun
11029 \begin_layout Plain Layout
11030 Document\SpecialChar menuseparator
11039 \begin_layout Description
11040 \begin_inset Flex Code
11043 \begin_layout Plain Layout
11049 Sets the preamble for the \SpecialChar LaTeX
11051 Note that this will completely override any prior
11052 \begin_inset Flex Code
11055 \begin_layout Plain Layout
11062 \begin_inset Flex Code
11065 \begin_layout Plain Layout
11073 \begin_inset Flex Code
11076 \begin_layout Plain Layout
11082 if you just want to add material to the preamble.) Must end with
11083 \begin_inset Quotes eld
11087 \begin_inset Flex Code
11090 \begin_layout Plain Layout
11097 \begin_inset Quotes erd
11103 \begin_layout Description
11104 \begin_inset Flex Code
11107 \begin_layout Plain Layout
11114 \begin_inset Flex Code
11117 \begin_layout Plain Layout
11124 \begin_inset Flex Code
11127 \begin_layout Plain Layout
11136 \begin_inset space \thinspace{}
11140 \begin_inset Flex Code
11143 \begin_layout Plain Layout
11149 ] Whether the class already provides the feature
11150 \begin_inset Flex Code
11153 \begin_layout Plain Layout
11160 A feature is in general the name of a package (e.
11161 \begin_inset space \thinspace{}
11165 \begin_inset space \space{}
11169 \begin_inset Flex Code
11172 \begin_layout Plain Layout
11179 \begin_inset Flex Code
11182 \begin_layout Plain Layout
11189 \begin_inset space \thinspace{}
11193 \begin_inset space \space{}
11197 \begin_inset Flex Code
11200 \begin_layout Plain Layout
11207 \begin_inset Flex Code
11210 \begin_layout Plain Layout
11218 \begin_inset CommandInset ref
11220 reference "chap:List-of-functions"
11224 for the list of features.
11227 \begin_layout Description
11228 \begin_inset Flex Code
11231 \begin_layout Plain Layout
11238 \begin_inset Flex Code
11241 \begin_layout Plain Layout
11247 ] Indicates that this layout provides the functionality of the module mentioned,
11248 which should be specified by the filename without the
11249 \begin_inset Flex Code
11252 \begin_layout Plain Layout
11259 This will typically be used if the layout includes the module directly,
11260 rather than using the
11261 \begin_inset Flex Code
11264 \begin_layout Plain Layout
11270 tag to indicate that it ought to be used.
11271 It could also be used in a module that provided an alternate implementation
11272 of the same functionality.
11275 \begin_layout Description
11276 \begin_inset Flex Code
11279 \begin_layout Plain Layout
11286 \begin_inset Flex Code
11289 \begin_layout Plain Layout
11295 ] Creates a new paragraph style if it does not already exist.
11296 If the style does exist, this section is ignored.
11298 \begin_inset Quotes eld
11302 \begin_inset Flex Code
11305 \begin_layout Plain Layout
11312 \begin_inset Quotes erd
11318 \begin_layout Description
11319 \begin_inset Flex Code
11322 \begin_layout Plain Layout
11329 \begin_inset Flex Code
11332 \begin_layout Plain Layout
11338 ] Whether the class requires the feature
11339 \begin_inset Flex Code
11342 \begin_layout Plain Layout
11349 Multiple features must be separated by commas.
11350 Note that you can only request supported features.
11352 \begin_inset CommandInset ref
11354 reference "chap:List-of-functions"
11358 for the list of features.).
11359 If you require a package with specific options, you can additionally use
11361 \begin_inset Flex Code
11364 \begin_layout Plain Layout
11373 \begin_layout Description
11374 \begin_inset Flex Code
11377 \begin_layout Plain Layout
11384 \begin_inset Flex Code
11387 \begin_layout Plain Layout
11393 ] A string that indicates the width of the right margin on the screen, for
11395 \begin_inset Quotes eld
11399 \begin_inset Flex Code
11402 \begin_layout Plain Layout
11409 \begin_inset Quotes erd
11415 \begin_layout Description
11416 \begin_inset Flex Code
11419 \begin_layout Plain Layout
11426 \begin_inset Flex Code
11429 \begin_layout Plain Layout
11435 ] Sets which divisions get numbered.
11437 \begin_inset Newline newline
11441 \begin_inset Flex Code
11444 \begin_layout Plain Layout
11450 counter in \SpecialChar LaTeX
11454 \begin_layout Description
11455 \begin_inset Flex Code
11458 \begin_layout Plain Layout
11465 \begin_inset Flex Code
11468 \begin_layout Plain Layout
11477 \begin_inset space \thinspace{}
11481 \begin_inset Flex Code
11484 \begin_layout Plain Layout
11490 ] Whether the class-default should be printing on one or both sides of the
11492 Can be changed in the
11493 \begin_inset Flex Noun
11496 \begin_layout Plain Layout
11497 Document\SpecialChar menuseparator
11506 \begin_layout Description
11507 \begin_inset Flex Code
11510 \begin_layout Plain Layout
11517 \begin_inset Flex Code
11520 \begin_layout Plain Layout
11526 ] This sequence defines a paragraph style.
11527 If the style does not yet exist, it is created; if it does exist, its parameter
11530 \begin_inset Quotes eld
11534 \begin_inset Flex Code
11537 \begin_layout Plain Layout
11544 \begin_inset Quotes erd
11548 \begin_inset Newline newline
11552 \begin_inset CommandInset ref
11554 reference "subsec:Paragraph-Styles"
11558 for details on paragraph styles.
11559 \change_inserted -712698321 1553617804
11563 \begin_layout Description
11565 \change_inserted -712698321 1553617862
11566 \begin_inset Flex Code
11569 \begin_layout Plain Layout
11571 \change_inserted -712698321 1553617809
11580 \begin_inset Flex Code
11583 \begin_layout Plain Layout
11585 \change_inserted -712698321 1553617805
11593 ] defines the default table style that is used when inserting a table.
11594 The following styles are available:
11598 \begin_layout Itemize
11600 \change_inserted -712698321 1554308039
11601 \begin_inset Flex Code
11604 \begin_layout Plain Layout
11606 \change_inserted -712698321 1554307928
11607 Formal_with_Footline
11615 \begin_inset Quotes eld
11619 \begin_inset Quotes erd
11622 ) style with horizontal lines only, using a bold top and bottom line, the
11623 first and last row are additionally separated from the table body with
11624 a thin middle line.
11627 \begin_layout Itemize
11629 \change_inserted -712698321 1554308087
11630 \begin_inset Flex Code
11633 \begin_layout Plain Layout
11635 \change_inserted -712698321 1554308042
11636 Formal_without_Footline
11643 : same as the above, but the last row is not separated with a middle line
11647 \begin_layout Itemize
11649 \change_inserted -712698321 1553618031
11650 \begin_inset Flex Code
11653 \begin_layout Plain Layout
11655 \change_inserted -712698321 1553618006
11663 : Simple table lines.
11666 \begin_layout Itemize
11668 \change_inserted -712698321 1553618309
11669 \begin_inset Flex Code
11672 \begin_layout Plain Layout
11674 \change_inserted -712698321 1553618031
11683 \begin_inset Flex Code
11686 \begin_layout Plain Layout
11688 \change_inserted -712698321 1553618043
11696 , but with the header column offset with a second horizontal line.
11697 This is also the default style of \SpecialChar LyX
11701 \begin_layout Itemize
11703 \change_inserted -712698321 1553618280
11704 \begin_inset Flex Code
11707 \begin_layout Plain Layout
11709 \change_inserted -712698321 1553618261
11717 : Table without lines.
11723 \begin_layout Description
11724 \begin_inset Flex Code
11727 \begin_layout Plain Layout
11734 \begin_inset Flex Code
11737 \begin_layout Plain Layout
11743 ] The name of the command or environment to be used with
11744 \begin_inset Flex Code
11747 \begin_layout Plain Layout
11756 \begin_layout Description
11757 \begin_inset Flex Code
11760 \begin_layout Plain Layout
11767 \begin_inset Flex Code
11770 \begin_layout Plain Layout
11779 \begin_inset Flex Code
11782 \begin_layout Plain Layout
11788 ] Indicates what kind of markup is used to define the title of a document.
11790 \begin_inset Flex Code
11793 \begin_layout Plain Layout
11799 means that the macro with name
11800 \begin_inset Flex Code
11803 \begin_layout Plain Layout
11809 will be inserted after the last layout which has
11810 \begin_inset Quotes eld
11814 \begin_inset Flex Code
11817 \begin_layout Plain Layout
11819 \begin_inset space ~
11828 \begin_inset Quotes erd
11833 \begin_inset Flex Code
11836 \begin_layout Plain Layout
11842 corresponds to the case where all layouts which have
11843 \begin_inset Quotes eld
11847 \begin_inset Flex Code
11850 \begin_layout Plain Layout
11852 \begin_inset space ~
11861 \begin_inset Quotes erd
11864 should be enclosed into the
11865 \begin_inset Flex Code
11868 \begin_layout Plain Layout
11877 \begin_layout Description
11878 \begin_inset Flex Code
11881 \begin_layout Plain Layout
11888 \begin_inset Flex Code
11891 \begin_layout Plain Layout
11897 ] Sets which divisions are included in the table of contents.
11899 \begin_inset Flex Code
11902 \begin_layout Plain Layout
11908 counter in \SpecialChar LaTeX
11912 \begin_layout Subsection
11913 \begin_inset Flex Code
11916 \begin_layout Plain Layout
11923 \begin_inset CommandInset label
11925 name "subsec:ClassOptions"
11932 \begin_layout Standard
11934 \begin_inset Flex Code
11937 \begin_layout Plain Layout
11943 section can contain the following entries:
11946 \begin_layout Description
11947 \begin_inset Flex Code
11950 \begin_layout Plain Layout
11957 \begin_inset Flex Code
11960 \begin_layout Plain Layout
11966 ] The list of available font sizes for the document's main font, separated
11968 \begin_inset Quotes eld
11972 \begin_inset Flex Code
11975 \begin_layout Plain Layout
11982 \begin_inset Quotes erd
11987 \change_inserted -712698321 1565110196
11988 Any number is possible.
11991 \begin_layout Description
11993 \change_inserted -712698321 1565110259
11994 \begin_inset Flex Code
11997 \begin_layout Plain Layout
11999 \change_inserted -712698321 1565110199
12008 \begin_inset Flex Code
12011 \begin_layout Plain Layout
12013 \change_inserted -712698321 1565110196
12021 ] The format for the font size option.
12023 \begin_inset Flex Code
12026 \begin_layout Plain Layout
12028 \change_inserted -712698321 1565110238
12038 \begin_inset Flex Code
12041 \begin_layout Plain Layout
12043 \change_inserted -712698321 1565110248
12051 is a placeholder for the font size.
12056 \begin_layout Description
12058 \change_deleted 5863208 1594239483
12059 \begin_inset Flex Code
12062 \begin_layout Plain Layout
12068 Used to set the DTD line with XML-based output classes.
12070 \begin_inset space \thinspace{}
12074 \begin_inset Quotes eld
12077 -//OASIS//DTD DocBook V4.2//EN
12078 \begin_inset Quotes erd
12082 \change_inserted -712698321 1565101761
12086 \begin_layout Description
12088 \change_inserted -712698321 1565180598
12089 \begin_inset Flex Code
12092 \begin_layout Plain Layout
12094 \change_inserted -712698321 1565101918
12103 \begin_inset Flex Code
12106 \begin_layout Plain Layout
12108 \change_inserted -712698321 1565105399
12109 string="letter|\SpecialChar allowbreak
12110 legal|\SpecialChar allowbreak
12111 executive|\SpecialChar allowbreak
12112 a0|\SpecialChar allowbreak
12113 a1|\SpecialChar allowbreak
12114 a2|\SpecialChar allowbreak
12115 a3|\SpecialChar allowbreak
12116 a4|\SpecialChar allowbreak
12117 a5|\SpecialChar allowbreak
12118 a6|\SpecialChar allowbreak
12119 b0|\SpecialChar allowbreak
12120 b1|\SpecialChar allowbreak
12121 b2|\SpecialChar allowbreak
12122 b3|\SpecialChar allowbreak
12123 b4|\SpecialChar allowbreak
12124 b5|\SpecialChar allowbreak
12125 b6|\SpecialChar allowbreak
12126 c0|\SpecialChar allowbreak
12127 c1|\SpecialChar allowbreak
12129 2|\SpecialChar allowbreak
12130 c3|\SpecialChar allowbreak
12131 c4|\SpecialChar allowbreak
12132 c5|\SpecialChar allowbreak
12133 c6|\SpecialChar allowbreak
12134 b0j|\SpecialChar allowbreak
12135 b1j|\SpecialChar allowbreak
12136 b2j|\SpecialChar allowbreak
12137 b3j|\SpecialChar allowbreak
12138 b4j|\SpecialChar allowbreak
12139 b5j|\SpecialChar allowbreak
12147 ] The list of available page sizes, separated by
12148 \begin_inset Quotes eld
12152 \begin_inset Flex Code
12155 \begin_layout Plain Layout
12157 \change_inserted -712698321 1565101779
12166 \begin_inset Quotes erd
12170 Currently, only the listed sizes are supported.
12171 Other sizes might be entered as custom class option.
12174 \begin_layout Description
12176 \change_inserted -712698321 1565180623
12177 \begin_inset Flex Code
12180 \begin_layout Plain Layout
12182 \change_inserted -712698321 1565180605
12191 \begin_inset Flex Code
12194 \begin_layout Plain Layout
12196 \change_inserted -712698321 1565180601
12204 ] The format for the page size option.
12206 \begin_inset Flex Code
12209 \begin_layout Plain Layout
12211 \change_inserted -712698321 1565180618
12221 \begin_inset Flex Code
12224 \begin_layout Plain Layout
12226 \change_inserted -712698321 1565180601
12234 is a placeholder for the paper size.
12239 \begin_layout Description
12240 \begin_inset Flex Code
12243 \begin_layout Plain Layout
12250 \begin_inset Flex Code
12253 \begin_layout Plain Layout
12254 string="empty|plain|headings|fancy"
12259 ] The list of available page sty\SpecialChar softhyphen
12261 \begin_inset Quotes eld
12265 \begin_inset Flex Code
12268 \begin_layout Plain Layout
12275 \begin_inset Quotes erd
12281 \begin_layout Description
12282 \begin_inset Flex Code
12285 \begin_layout Plain Layout
12292 \begin_inset Flex Code
12295 \begin_layout Plain Layout
12301 ] Some document class options, separated by a comma, that will be added
12302 to the optional part of the
12303 \begin_inset Flex Code
12306 \begin_layout Plain Layout
12317 \begin_layout Standard
12319 \begin_inset Flex Code
12322 \begin_layout Plain Layout
12328 section must end with
12329 \begin_inset Quotes eld
12333 \begin_inset Flex Code
12336 \begin_layout Plain Layout
12343 \begin_inset Quotes erd
12349 \begin_layout Subsection
12351 \begin_inset CommandInset label
12353 name "subsec:Paragraph-Styles"
12360 \begin_layout Standard
12361 A paragraph style description looks like this:
12365 \begin_layout Plain Layout
12366 Note that this will either define a new style or modify an existing one.
12374 \begin_layout LyX-Code
12381 \begin_layout LyX-Code
12385 \begin_layout LyX-Code
12389 \begin_layout Standard
12390 where the following commands are allowed:
12393 \begin_layout Description
12394 \begin_inset Flex Code
12397 \begin_layout Plain Layout
12404 \begin_inset Flex Code
12407 \begin_layout Plain Layout
12413 =""] This paragraph will appear in the table of contents of the given type.
12414 An empty string disables.
12415 See also the OutlinerName and the IsTocCaption commands.
12419 \begin_layout Description
12420 \begin_inset Flex Code
12423 \begin_layout Plain Layout
12430 \begin_inset Flex Code
12433 \begin_layout Plain Layout
12438 , left, right, center
12443 ] Paragraph alignment.
12446 \begin_layout Description
12447 \begin_inset Flex Code
12450 \begin_layout Plain Layout
12457 \begin_inset Flex Code
12460 \begin_layout Plain Layout
12465 , left, right, center
12470 ] A comma separated list of permitted alignments.
12471 (Some \SpecialChar LaTeX
12472 styles prohibit certain alignments, since those wouldn't make sense.
12473 For example a right-aligned or centered enumeration isn't possible.)
12476 \begin_layout Description
12477 \begin_inset Flex Code
12480 \begin_layout Plain Layout
12487 \begin_inset Flex Code
12490 \begin_layout Plain Layout
12496 ] Defines argument number <int> of a command\SpecialChar breakableslash
12497 environment associated with
12499 This is useful for things like section headings, and only makes sense with
12502 Every (optional or required) argument of a command or environment – except
12503 for the required argument that is associated with the content of the paragraph
12504 itself – has a separate definition, where the number specifies the order
12506 The definition must end with
12507 \begin_inset Flex Code
12510 \begin_layout Plain Layout
12517 So a command with two optional arguments has:
12521 \begin_layout Quote
12527 \begin_layout Quote
12533 \begin_layout Quote
12539 \begin_layout Quote
12545 \begin_layout Quote
12551 \begin_layout Quote
12557 \begin_layout Standard
12559 \begin_inset Flex Code
12562 \begin_layout Plain Layout
12568 definition, the following specifications are possible:
12571 \begin_layout Itemize
12572 \begin_inset Flex Code
12575 \begin_layout Plain Layout
12582 \begin_inset Flex Code
12585 \begin_layout Plain Layout
12591 The string that will appear both in the menu (to insert this argument)
12592 and on the argument inset button (unless you also specify a separate
12593 \begin_inset Flex Code
12596 \begin_layout Plain Layout
12603 For the menu, you can define an accelerator by appending the respective
12604 character to the string, divided by
12605 \begin_inset Quotes eld
12609 \begin_inset Quotes erd
12613 \begin_inset space \thinspace{}
12617 \begin_inset space \space{}
12621 \begin_inset Quotes eld
12625 \begin_inset Flex Code
12628 \begin_layout Plain Layout
12635 \begin_inset Quotes erd
12641 \begin_layout Itemize
12642 \begin_inset Flex Code
12645 \begin_layout Plain Layout
12652 \begin_inset Flex Code
12655 \begin_layout Plain Layout
12661 A separate string for the menu.
12662 You can define an accelerator by appending the respective character to
12663 the string, divided by
12664 \begin_inset Quotes eld
12668 \begin_inset Quotes erd
12672 \begin_inset space \thinspace{}
12676 \begin_inset space \space{}
12680 \begin_inset Quotes eld
12684 \begin_inset Flex Code
12687 \begin_layout Plain Layout
12694 \begin_inset Quotes erd
12698 This specification is optional.
12699 If it is not given the
12700 \begin_inset Flex Code
12703 \begin_layout Plain Layout
12709 will be used instead for the menu.
12712 \begin_layout Itemize
12713 \begin_inset Flex Code
12716 \begin_layout Plain Layout
12723 \begin_inset Flex Code
12726 \begin_layout Plain Layout
12732 A longer explanatory text that appears in the tooltip when hovering over
12733 the argument inset.
12736 \begin_layout Itemize
12737 \begin_inset Flex Code
12740 \begin_layout Plain Layout
12747 \begin_inset Flex Code
12750 \begin_layout Plain Layout
12759 \begin_inset space \thinspace{}
12763 \begin_inset Flex Code
12766 \begin_layout Plain Layout
12772 ] Declare if this is a mandatory (1) or an optional (0) argument.
12773 Mandatory arguments will be output empty if not given, while optional arguments
12774 will not be output at all.
12775 By default, mandatory arguments are delimited by
12776 \begin_inset Flex Code
12779 \begin_layout Plain Layout
12785 , while optional arguments are delimited by
12786 \begin_inset Flex Code
12789 \begin_layout Plain Layout
12796 \change_inserted -712698321 1555579782
12800 \begin_layout Itemize
12802 \change_inserted -712698321 1555579780
12803 \begin_inset Flex Code
12806 \begin_layout Plain Layout
12808 \change_inserted -712698321 1555579780
12817 \begin_inset Flex Code
12820 \begin_layout Plain Layout
12822 \change_inserted -712698321 1555579780
12830 Option to define a different command (from the default
12831 \begin_inset Flex Code
12834 \begin_layout Plain Layout
12836 \change_inserted -712698321 1555579780
12848 ) to be used for line breaks.
12849 The initial backslash must not be specified.
12854 \begin_layout Itemize
12855 \begin_inset Flex Code
12858 \begin_layout Plain Layout
12865 \begin_inset Flex Code
12868 \begin_layout Plain Layout
12874 defines another argument (by its number) which this argument requires to
12875 be output if it is itself output.
12877 \begin_inset space \thinspace{}
12880 g., in \SpecialChar LaTeX
12881 commands, optional arguments often require previous optional arguments
12882 to be output (at least empty), as in
12883 \begin_inset Flex Code
12886 \begin_layout Plain Layout
12889 command[][argument]{text}
12895 This can be achieved by the statement
12896 \begin_inset Flex Code
12899 \begin_layout Plain Layout
12906 \begin_inset Flex Code
12909 \begin_layout Plain Layout
12918 \begin_layout Itemize
12919 \begin_inset Flex Code
12922 \begin_layout Plain Layout
12929 \begin_inset Flex Code
12932 \begin_layout Plain Layout
12938 defines a custom left delimiter (instead of
12939 \begin_inset Flex Code
12942 \begin_layout Plain Layout
12949 \begin_inset Flex Code
12952 \begin_layout Plain Layout
12959 A line break in the output can be indicated by
12960 \begin_inset Flex Code
12963 \begin_layout Plain Layout
12972 \begin_layout Itemize
12973 \begin_inset Flex Code
12976 \begin_layout Plain Layout
12983 \begin_inset Flex Code
12986 \begin_layout Plain Layout
12992 defines a custom right delimiter (instead of
12993 \begin_inset Flex Code
12996 \begin_layout Plain Layout
13003 \begin_inset Flex Code
13006 \begin_layout Plain Layout
13013 A line break in the output can be indicated by
13014 \begin_inset Flex Code
13017 \begin_layout Plain Layout
13026 \begin_layout Itemize
13027 \begin_inset Flex Code
13030 \begin_layout Plain Layout
13037 \begin_inset Flex Code
13040 \begin_layout Plain Layout
13046 defines an argument that is inserted if and only if no user-specified arguments
13048 \begin_inset space \thinspace{}
13052 \begin_inset space \space{}
13055 if no argument inset has been inserted (note that also an empty argument
13056 inset omits the DefaultArg).
13057 Multiple arguments need to be separated by comma.
13060 \begin_layout Itemize
13061 \begin_inset Flex Code
13064 \begin_layout Plain Layout
13071 \begin_inset Flex Code
13074 \begin_layout Plain Layout
13080 defines an argument that is inserted in any case (alone or in addition
13081 to user-specified arguments).
13082 Multiple arguments need to be separated by comma.
13085 \begin_layout Itemize
13086 \begin_inset Flex Code
13089 \begin_layout Plain Layout
13095 The font used for the argument content, see
13096 \begin_inset CommandInset ref
13098 reference "subsec:Font-description"
13103 \change_inserted -712698321 1559484228
13107 \begin_layout Itemize
13109 \change_inserted -712698321 1559484228
13110 \begin_inset Flex Code
13113 \begin_layout Plain Layout
13115 \change_inserted -712698321 1559484228
13124 \begin_inset Flex Code
13127 \begin_layout Plain Layout
13129 \change_inserted -712698321 1559484228
13140 \begin_inset space \thinspace{}
13144 \begin_inset Flex Code
13147 \begin_layout Plain Layout
13149 \change_inserted -712698321 1559484228
13157 ] As with paragraph styles, see
13158 \begin_inset CommandInset ref
13160 reference "subsec:Paragraph-Styles"
13169 \begin_layout Itemize
13170 \begin_inset Flex Code
13173 \begin_layout Plain Layout
13179 The font used for the label; see
13180 \begin_inset CommandInset ref
13182 reference "subsec:Font-description"
13189 \begin_layout Itemize
13190 \begin_inset Flex Code
13193 \begin_layout Plain Layout
13200 \begin_inset Flex Code
13203 \begin_layout Plain Layout
13208 , Minimalistic, Conglomerate
13213 ] describes the rendering style used for the inset's frame and buttons.
13216 \begin_layout Itemize
13217 \begin_inset Flex Code
13220 \begin_layout Plain Layout
13227 \begin_inset Flex Code
13230 \begin_layout Plain Layout
13237 \begin_inset Flex Code
13240 \begin_layout Plain Layout
13246 , this argument is automatically inserted when the respective style is selected.
13248 \change_deleted -712698321 1559484200
13249 Currently, only one argument per style\SpecialChar breakableslash
13250 layout can be automatically inserted.
13255 \begin_layout Itemize
13257 \change_inserted -712698321 1559491402
13258 \begin_inset Flex Code
13261 \begin_layout Plain Layout
13263 \change_inserted -712698321 1559490711
13272 \begin_inset Flex Code
13275 \begin_layout Plain Layout
13277 \change_inserted -712698321 1559490703
13286 \begin_inset Flex Code
13289 \begin_layout Plain Layout
13291 \change_inserted -712698321 1559490703
13299 , this argument will be inserted on a new line with
13300 \begin_inset Flex Code
13303 \begin_layout Plain Layout
13305 \change_inserted -712698321 1559491402
13313 (only available within Flex insets).
13316 \begin_layout Itemize
13317 \begin_inset Flex Code
13320 \begin_layout Plain Layout
13327 \begin_inset Flex Code
13330 \begin_layout Plain Layout
13337 \begin_inset Flex Code
13340 \begin_layout Plain Layout
13346 , this argument will be inserted with a copy of the co-text (either selected
13347 text or the whole paragraph) as content.
13350 \begin_layout Itemize
13351 \begin_inset Flex Code
13354 \begin_layout Plain Layout
13361 \begin_inset Flex Code
13364 \begin_layout Plain Layout
13374 ] Whether the contents of this argument should be output in raw form, meaning
13375 without special translations that \SpecialChar LaTeX
13378 \begin_inset Flex Code
13381 \begin_layout Plain Layout
13387 status is inherited by the inset or paragraph layout the argument belongs
13388 to, true and false change the status for the given argument only.
13391 \begin_layout Itemize
13392 \begin_inset Flex Code
13395 \begin_layout Plain Layout
13402 \begin_inset Flex Code
13405 \begin_layout Plain Layout
13406 string of characters
13415 Defines individual characters
13416 \begin_inset Newline linebreak
13419 that should be output in raw form, meaning without special translations
13420 that \SpecialChar LaTeX
13422 Note that, contrary to PassThru, this needs to be explicitly defined for
13424 That is, arguments do not inherit PassThruChars from their parent inset
13428 \begin_layout Itemize
13429 \begin_inset Flex Code
13432 \begin_layout Plain Layout
13439 \begin_inset Flex Code
13442 \begin_layout Plain Layout
13451 \begin_inset space \thinspace{}
13455 \begin_inset Flex Code
13458 \begin_layout Plain Layout
13464 ] If this is set to 1, the argument will output its content in the corresponding
13465 item in the table of contents.
13469 \begin_layout Standard
13470 By default, the text entered in the \SpecialChar LyX
13471 workarea in the respective layout is
13472 the last (mandatory) argument of a command if the
13473 \begin_inset Flex Code
13476 \begin_layout Plain Layout
13483 \begin_inset Flex Code
13486 \begin_layout Plain Layout
13493 However, arguments with the prefix
13494 \begin_inset Flex Code
13497 \begin_layout Plain Layout
13503 are output after this workarea argument.
13504 Note that post-argument numbering restarts at 1, so the first argument
13505 following the workarea argument is
13506 \begin_inset Flex Code
13509 \begin_layout Plain Layout
13516 Post-arguments are ignored in any other
13517 \begin_inset Flex Code
13520 \begin_layout Plain Layout
13527 \begin_inset Flex Code
13530 \begin_layout Plain Layout
13539 \begin_layout Standard
13541 \begin_inset Flex Code
13544 \begin_layout Plain Layout
13553 \begin_inset Flex Code
13556 \begin_layout Plain Layout
13565 \begin_inset Flex Code
13568 \begin_layout Plain Layout
13574 followed by the number (e.
13575 \begin_inset space \thinspace{}
13579 \begin_inset space \space{}
13583 \begin_inset Flex Code
13586 \begin_layout Plain Layout
13593 \change_inserted -712698321 1534487781
13597 \begin_layout Standard
13599 \change_inserted -712698321 1534488561
13600 Finally, there is a special argument type with the prefix
13601 \begin_inset Flex Code
13604 \begin_layout Plain Layout
13606 \change_inserted -712698321 1534487844
13615 It is not really an argument, but uses the argument interface (thus, the
13616 prefix is also followed by a number, e.
13617 \begin_inset space \thinspace{}
13622 \begin_inset Flex Code
13625 \begin_layout Plain Layout
13627 \change_inserted -712698321 1534488412
13628 Argument listpreamble:1
13636 As the name implies, it is targeted at lists such as
13653 Its content will be output at the list start, before the first
13654 \begin_inset Flex Code
13657 \begin_layout Plain Layout
13659 \change_inserted -712698321 1534488058
13669 , on an own line (a place that is otherwise not accessible in \SpecialChar LyX
13671 This way, users can insert redefinitions (of lengths etc.) to individual
13673 By default, these arguments do not have a delimiter.
13679 \begin_layout Description
13680 \begin_inset Flex Code
13683 \begin_layout Plain Layout
13689 Includes a comma-separated list of layouts that should be nested in and
13690 after the current layout.
13691 Only makes sense for nestable layouts (such as environments).
13693 \begin_inset Quotes eld
13697 \begin_inset Flex Code
13700 \begin_layout Plain Layout
13707 \begin_inset Quotes erd
13712 \begin_inset Flex Code
13715 \begin_layout Plain Layout
13724 \begin_layout Description
13725 \begin_inset Flex Code
13728 \begin_layout Plain Layout
13734 Note that this will completely override any prior
13735 \begin_inset Flex Code
13738 \begin_layout Plain Layout
13744 declaration for this style.
13746 \begin_inset Quotes eld
13750 \begin_inset Flex Code
13753 \begin_layout Plain Layout
13760 \begin_inset Quotes erd
13765 \begin_inset CommandInset ref
13767 reference "subsec:I18n"
13771 for details on its use.
13774 \begin_layout Description
13775 \begin_inset Flex Code
13778 \begin_layout Plain Layout
13785 \begin_inset Flex Code
13788 \begin_layout Plain Layout
13798 \begin_layout Plain Layout
13799 Note that a `float' here is a real number, such as: 1.5.
13804 The vertical space with which the last of a chain of paragraphs with this
13805 style is separated from the following paragraph.
13806 If the next paragraph has another style, the separations are not simply
13807 added, but the maximum is taken.
13810 \begin_layout Description
13811 \begin_inset Flex Code
13814 \begin_layout Plain Layout
13821 \begin_inset Flex Code
13824 \begin_layout Plain Layout
13830 ] The category for this style.
13831 This is used to group related styles in the style combobox on the toolbar.
13832 Any string can be used, but you may want to use existing categories with
13837 \begin_layout Description
13838 \begin_inset Flex Code
13841 \begin_layout Plain Layout
13847 Depth of XML command.
13848 Used only with XML-type formats.
13851 \begin_layout Description
13852 \begin_inset Flex Code
13855 \begin_layout Plain Layout
13862 \begin_inset Flex Code
13865 \begin_layout Plain Layout
13871 ] Copies all the features of an existing style into the current one.
13875 \begin_layout Description
13876 \begin_inset Flex Code
13879 \begin_layout Plain Layout
13886 \begin_inset Flex Code
13889 \begin_layout Plain Layout
13895 ] The name of a style whose preamble should be output
13900 This allows to ensure some ordering of the preamble snippets when macros
13901 definitions depend on one another.
13905 \begin_layout Plain Layout
13906 Note that, besides that functionality, there is no way to ensure any ordering
13908 The ordering that you see in a given version of \SpecialChar LyX
13909 may change without warning
13918 \begin_layout Description
13919 \begin_inset Flex Code
13922 \begin_layout Plain Layout
13929 \begin_inset Flex Code
13932 \begin_layout Plain Layout
13937 , Box, Filled_Box, Static
13942 ] The type of label that stands at the end of the paragraph (or sequence
13944 \begin_inset Flex Code
13947 \begin_layout Plain Layout
13954 \begin_inset Newline newline
13958 \begin_inset Flex Code
13961 \begin_layout Plain Layout
13968 \begin_inset Flex Code
13971 \begin_layout Plain Layout
13978 \begin_inset Flex Code
13981 \begin_layout Plain Layout
13989 \begin_inset Flex Code
13992 \begin_layout Plain Layout
13999 \begin_inset Quotes eld
14003 \begin_inset Quotes erd
14007 \begin_inset Flex Code
14010 \begin_layout Plain Layout
14017 \begin_inset space \space{}
14021 \begin_inset Flex Code
14024 \begin_layout Plain Layout
14030 ) is a white (resp.
14031 \begin_inset space ~
14034 black) square suitable for end of proof markers,
14035 \begin_inset Flex Code
14038 \begin_layout Plain Layout
14044 is an explicit text string.
14047 \begin_layout Description
14048 \begin_inset Flex Code
14051 \begin_layout Plain Layout
14058 \begin_inset Flex Code
14061 \begin_layout Plain Layout
14067 ] The string used for a label with a
14068 \begin_inset Flex Code
14071 \begin_layout Plain Layout
14078 \begin_inset Newline newline
14082 \begin_inset Flex Code
14085 \begin_layout Plain Layout
14095 \begin_layout Description
14096 \begin_inset Flex Code
14099 \begin_layout Plain Layout
14105 The font used for both the text body
14111 \begin_inset CommandInset ref
14113 reference "subsec:Font-description"
14118 Note that defining this font automatically defines the
14119 \begin_inset Flex Code
14122 \begin_layout Plain Layout
14129 So you should define this one first if you also want to define
14130 \begin_inset Flex Code
14133 \begin_layout Plain Layout
14142 \begin_layout Description
14143 \begin_inset Flex Code
14146 \begin_layout Plain Layout
14153 \begin_inset Flex Code
14156 \begin_layout Plain Layout
14162 ] Used for backporting new styles to stable \SpecialChar LyX
14164 The first stable version that supports this tag is \SpecialChar LyX
14166 The argument is a number which may either be 0, -1 or any value greater
14169 \begin_inset Flex Code
14172 \begin_layout Plain Layout
14178 flag of a style is greater than zero, it will always be written to the
14180 If a .lyx file is read, the style definitions from the document header are
14181 added to the document class.
14182 Therefore even older \SpecialChar LyX
14183 versions can handle the style.
14185 \begin_inset Flex Code
14188 \begin_layout Plain Layout
14194 is a version number: if the style is read, and the version number is less
14195 than the version number of the already existing style in the document class,
14196 the new style is ignored.
14197 If the version number is greater, the new style replaces the existing style.
14198 A value of -1 means an infinite version number, i.
14199 \begin_inset space \thinspace{}
14203 \begin_inset space \space{}
14206 the style is always used.
14209 \begin_layout Description
14210 \begin_inset Flex Code
14213 \begin_layout Plain Layout
14220 \begin_inset Flex Code
14223 \begin_layout Plain Layout
14232 \begin_inset space \thinspace{}
14236 \begin_inset Flex Code
14239 \begin_layout Plain Layout
14245 ] Usually \SpecialChar LyX
14246 does not allow you to insert more than one space between words,
14247 since a space is considered as the separation between two words, not a
14248 character or symbol of its own.
14249 This is a very fine thing but sometimes annoying, for example, when typing
14250 program code or plain \SpecialChar LaTeX
14253 \begin_inset Flex Code
14256 \begin_layout Plain Layout
14264 \change_deleted -495245474 1550490105
14268 will create protected blanks for the additional blanks when in
14269 \change_inserted -495245474 1550490096
14271 \begin_inset Flex Code
14274 \begin_layout Plain Layout
14276 \change_inserted -495245474 1550490089
14285 \change_deleted -495245474 1550490116
14286 another mode than \SpecialChar LaTeX
14289 \change_inserted -495245474 1550247760
14291 \begin_inset Flex Code
14294 \begin_layout Plain Layout
14296 \change_inserted -495245474 1550247736
14305 \begin_inset Flex Code
14308 \begin_layout Plain Layout
14310 \change_inserted -495245474 1550247755
14323 \begin_layout Description
14324 \begin_inset Flex Code
14327 \begin_layout Plain Layout
14333 These tags are used with XHTML output.
14335 \begin_inset CommandInset ref
14337 reference "subsec:Paragraph-Style-XHTML"
14344 \begin_layout Description
14345 \begin_inset Flex Code
14348 \begin_layout Plain Layout
14354 [FIXME] (Used only with XML-type formats.)
14357 \begin_layout Description
14358 \begin_inset Flex Code
14361 \begin_layout Plain Layout
14368 \begin_inset Flex Code
14371 \begin_layout Plain Layout
14380 \begin_inset space \thinspace{}
14384 \begin_inset Flex Code
14387 \begin_layout Plain Layout
14394 \begin_inset Flex Code
14397 \begin_layout Plain Layout
14403 , marks the style as to be included in the document preamble and not in
14405 This is useful for document classes that want such information as the title
14406 and author to appear in the preamble.
14407 Note that this works only for styles for which the
14408 \begin_inset Flex Code
14411 \begin_layout Plain Layout
14418 \begin_inset Flex Code
14421 \begin_layout Plain Layout
14428 \begin_inset Flex Code
14431 \begin_layout Plain Layout
14440 \begin_layout Description
14441 \begin_inset Flex Code
14444 \begin_layout Plain Layout
14451 \begin_inset Flex Code
14454 \begin_layout Plain Layout
14463 \begin_inset space \thinspace{}
14467 \begin_inset Flex Code
14470 \begin_layout Plain Layout
14477 \begin_inset Flex Code
14480 \begin_layout Plain Layout
14486 , marks the style as being part of a title block (see also the
14487 \begin_inset Flex Code
14490 \begin_layout Plain Layout
14497 \begin_inset Flex Code
14500 \begin_layout Plain Layout
14509 \begin_layout Description
14510 \begin_inset Flex Code
14513 \begin_layout Plain Layout
14519 Includes a comma-separated list of layouts after which this one should
14521 Only makes sense with regard to nestable layouts (such as environments).
14523 \begin_inset Quotes eld
14527 \begin_inset Flex Code
14530 \begin_layout Plain Layout
14537 \begin_inset Quotes erd
14542 \begin_inset Flex Code
14545 \begin_layout Plain Layout
14554 \begin_layout Description
14555 \begin_inset Flex Code
14558 \begin_layout Plain Layout
14565 \begin_inset Flex Code
14568 \begin_layout Plain Layout
14577 \begin_inset space \thinspace{}
14581 \begin_inset Flex Code
14584 \begin_layout Plain Layout
14590 ] If this is set to 1 and AddToToc is enabled, the paragraph adds a summary
14591 of its contents in its item in the table of contents.
14592 Otherwise, only the label, if it exists, appears.
14595 \begin_layout Description
14596 \begin_inset Flex Code
14599 \begin_layout Plain Layout
14606 \begin_inset Flex Code
14609 \begin_layout Plain Layout
14615 ] The \SpecialChar LaTeX
14616 command sequence declaring an item in a list.
14617 The command is to be defined without the preceding backslash (the default
14619 \begin_inset Quotes eld
14623 \begin_inset Quotes erd
14627 \begin_inset Flex Code
14630 \begin_layout Plain Layout
14638 in the \SpecialChar LaTeX
14642 \begin_layout Description
14643 \begin_inset Flex Code
14646 \begin_layout Plain Layout
14653 \begin_inset Flex Code
14656 \begin_layout Plain Layout
14662 ] This provides extra space between paragraphs that have the same style.
14663 If you put other styles into an environment, each is separated with the
14665 \begin_inset Flex Code
14668 \begin_layout Plain Layout
14675 But the whole items of the environment are additionally separated with
14677 \begin_inset Flex Code
14680 \begin_layout Plain Layout
14687 Note that this is a
14692 \begin_layout Description
14693 \begin_inset Flex Code
14696 \begin_layout Plain Layout
14702 [FIXME] (Used only with XML-type formats.)
14705 \begin_layout Description
14706 \begin_inset Flex Code
14709 \begin_layout Plain Layout
14716 \begin_inset Flex Code
14719 \begin_layout Plain Layout
14728 \begin_inset space \thinspace{}
14732 \begin_inset Flex Code
14735 \begin_layout Plain Layout
14741 ] Usually \SpecialChar LyX
14742 does not allow you to leave a paragraph empty, since it would
14743 lead to empty \SpecialChar LaTeX
14745 There are some cases where this could be desirable however: in a letter
14746 template, the required fields can be provided as empty fields, so that
14747 people do not forget them; in some special classes, a style can be used
14748 as some kind of break, which does not contain actual text.
14751 \begin_layout Description
14752 \begin_inset Flex Code
14755 \begin_layout Plain Layout
14762 \begin_inset Flex Code
14765 \begin_layout Plain Layout
14771 ] The vertical space between the label and the text body.
14772 Only used for labels that are above the text body (
14773 \begin_inset Flex Code
14776 \begin_layout Plain Layout
14783 \begin_inset Newline newline
14787 \begin_inset Flex Code
14790 \begin_layout Plain Layout
14791 Centered_Top_Environment
14799 \begin_layout Description
14800 \begin_inset Flex Code
14803 \begin_layout Plain Layout
14810 \begin_inset Flex Code
14813 \begin_layout Plain Layout
14819 ] The name of the counter for automatic numbering.
14820 In order to have the counter appear with your label, you will need to reference
14822 \begin_inset Flex Code
14825 \begin_layout Plain Layout
14834 This will work with
14835 \begin_inset Flex Code
14838 \begin_layout Plain Layout
14845 \begin_inset Flex Code
14848 \begin_layout Plain Layout
14855 \begin_inset Flex Code
14858 \begin_layout Plain Layout
14865 \begin_inset Flex Code
14868 \begin_layout Plain Layout
14875 \begin_inset Newline newline
14883 \begin_inset Flex Code
14886 \begin_layout Plain Layout
14893 \begin_inset Flex Code
14896 \begin_layout Plain Layout
14902 , though this case is a bit complicated.
14903 Suppose you declare
14904 \begin_inset Quotes eld
14908 \begin_inset Flex Code
14911 \begin_layout Plain Layout
14912 LabelCounter myenum
14918 \begin_inset Quotes erd
14922 Then the actual counters used are
14923 \begin_inset Flex Code
14926 \begin_layout Plain Layout
14933 \begin_inset Flex Code
14936 \begin_layout Plain Layout
14943 \begin_inset Flex Code
14946 \begin_layout Plain Layout
14953 \begin_inset Flex Code
14956 \begin_layout Plain Layout
14962 , much as in \SpecialChar LaTeX
14964 These counters must all be declared separately.
14965 \begin_inset Newline newline
14969 \begin_inset CommandInset ref
14971 reference "subsec:Counters"
14975 for details on counters.
14978 \begin_layout Description
14979 \begin_inset Flex Code
14982 \begin_layout Plain Layout
14988 The font used for the label.
14990 \begin_inset CommandInset ref
14992 reference "subsec:Font-description"
14999 \begin_layout Description
15000 \begin_inset Flex Code
15003 \begin_layout Plain Layout
15010 \begin_inset Flex Code
15013 \begin_layout Plain Layout
15019 ] Text that indicates how far a label should be indented.
15022 \begin_layout Description
15023 \begin_inset Flex Code
15026 \begin_layout Plain Layout
15033 \begin_inset Flex Code
15036 \begin_layout Plain Layout
15042 ] Text that indicates the amount of horizontal space between the label and
15044 Only used for labels that are not above the text body.
15047 \begin_layout Description
15048 \begin_inset Flex Code
15051 \begin_layout Plain Layout
15058 \begin_inset Flex Code
15061 \begin_layout Plain Layout
15067 ] The string used for the label.
15069 \begin_inset Flex Code
15072 \begin_layout Plain Layout
15078 is set, this string can be contain the special formatting commands described
15080 \begin_inset CommandInset ref
15082 reference "subsec:Counters"
15089 \begin_layout Description
15090 \begin_inset Flex Code
15093 \begin_layout Plain Layout
15094 LabelStringAppendix
15100 \begin_inset Flex Code
15103 \begin_layout Plain Layout
15109 ] This is used inside the appendix instead of
15110 \begin_inset Newline newline
15114 \begin_inset Flex Code
15117 \begin_layout Plain Layout
15125 \begin_inset Flex Code
15128 \begin_layout Plain Layout
15135 \begin_inset Newline newline
15139 \begin_inset Flex Code
15142 \begin_layout Plain Layout
15143 LabelStringAppendix
15151 \begin_layout Description
15152 \begin_inset Flex Code
15155 \begin_layout Plain Layout
15161 [FIXME] (Used only with XML-type formats.)
15164 \begin_layout Description
15165 \begin_inset Flex Code
15168 \begin_layout Plain Layout
15175 \begin_inset Flex Code
15178 \begin_layout Plain Layout
15183 , Manual, Static, Above,
15184 \begin_inset Newline newline
15187 Centered, Sensitive, Enumerate,
15188 \begin_inset Newline newline
15191 Itemize, Bibliography
15200 \begin_layout Description
15201 \begin_inset Flex Code
15204 \begin_layout Plain Layout
15210 means the label is the very first word (up to the first real blank).
15211 Use protected spaces if you want more than one word as the label.
15215 \begin_layout Description
15216 \begin_inset Flex Code
15219 \begin_layout Plain Layout
15225 means the label is simply what is declared as
15226 \begin_inset Flex Code
15229 \begin_layout Plain Layout
15236 This will be displayed
15237 \begin_inset Quotes eld
15241 \begin_inset Quotes erd
15244 , at the beginning of the paragraph.
15246 \begin_inset Flex Code
15249 \begin_layout Plain Layout
15256 \begin_inset Flex Code
15259 \begin_layout Plain Layout
15265 , then it will be displayed only in the first paragraph of any sequence
15266 of paragraphs with the same
15267 \begin_inset Flex Code
15270 \begin_layout Plain Layout
15279 \begin_layout Description
15280 \begin_inset Flex Code
15283 \begin_layout Plain Layout
15290 \begin_inset space ~
15294 \begin_inset space ~
15298 \begin_inset Flex Code
15301 \begin_layout Plain Layout
15307 are special cases of
15308 \begin_inset Flex Code
15311 \begin_layout Plain Layout
15318 The label will be printed above the paragraph either at the beginning of
15319 the line or centered.
15322 \begin_layout Description
15323 \begin_inset Flex Code
15326 \begin_layout Plain Layout
15332 is a special case for the caption-labels
15333 \begin_inset Quotes eld
15337 \begin_inset Quotes erd
15341 \begin_inset Quotes eld
15345 \begin_inset Quotes erd
15349 \begin_inset Newline newline
15353 \begin_inset Flex Code
15356 \begin_layout Plain Layout
15362 means the (hardcoded) label string depends on the kind of float: It is
15363 hardcoded to be `FloatType N', where N is the value of the counter associated
15365 For the case that a caption is inserted outside of a float the
15366 \begin_inset Flex Code
15369 \begin_layout Plain Layout
15376 \begin_inset Quotes eld
15380 \begin_inset Quotes erd
15386 \begin_layout Description
15387 \begin_inset Flex Code
15390 \begin_layout Plain Layout
15396 produces the usual sort of enumeration labels.
15397 The number type needs to be set in the
15402 \begin_inset CommandInset ref
15404 reference "subsec:Counters"
15411 \begin_layout Description
15412 \begin_inset Flex Code
15415 \begin_layout Plain Layout
15421 produces various bullets at the different levels.
15422 The bullet types displayed can be set via
15423 \begin_inset Flex Noun
15426 \begin_layout Plain Layout
15427 Document\SpecialChar menuseparator
15428 Settings\SpecialChar menuseparator
15437 \begin_layout Description
15438 \begin_inset Flex Code
15441 \begin_layout Plain Layout
15447 should be used only with
15448 \begin_inset Flex Code
15451 \begin_layout Plain Layout
15452 LatexType BibEnvironment
15461 \begin_layout Description
15462 \begin_inset Flex Code
15465 \begin_layout Plain Layout
15471 Note that this will completely override any prior
15472 \begin_inset Flex Code
15475 \begin_layout Plain Layout
15481 declaration for this style.
15483 \begin_inset Quotes eld
15487 \begin_inset Flex Code
15490 \begin_layout Plain Layout
15497 \begin_inset Quotes erd
15502 \begin_inset CommandInset ref
15504 reference "subsec:I18n"
15508 for details on its use.
15511 \begin_layout Description
15512 \begin_inset Flex Code
15515 \begin_layout Plain Layout
15522 \begin_inset Flex Code
15525 \begin_layout Plain Layout
15531 ] The name of the corresponding \SpecialChar LaTeX
15533 Either the environment or command name.
15536 \begin_layout Description
15537 \begin_inset Flex Code
15540 \begin_layout Plain Layout
15547 \begin_inset Flex Code
15550 \begin_layout Plain Layout
15556 ] An optional parameter for the corresponding
15557 \begin_inset Flex Code
15560 \begin_layout Plain Layout
15567 This parameter cannot be changed from within \SpecialChar LyX
15569 \begin_inset Flex Code
15572 \begin_layout Plain Layout
15578 for customizable parameters).
15579 This will be output as is after all \SpecialChar LaTeX
15581 \begin_inset Flex Code
15584 \begin_layout Plain Layout
15593 \begin_layout Description
15594 \begin_inset Flex Code
15597 \begin_layout Plain Layout
15604 \begin_inset Flex Code
15607 \begin_layout Plain Layout
15612 , Command, Environment, Item_Environment,
15613 \begin_inset Newline newline
15616 List_Environment, Bib_Environment
15621 ] How the style should be translated into \SpecialChar LaTeX
15626 \begin_layout Plain Layout
15627 \begin_inset Flex Code
15630 \begin_layout Plain Layout
15636 is perhaps a bit misleading, since these rules apply to SGML classes, too.
15637 Visit the SGML class files for specific examples.
15646 \begin_layout Description
15647 \begin_inset Flex Code
15650 \begin_layout Plain Layout
15656 means nothing special.
15659 \begin_layout Description
15660 \begin_inset Flex Code
15663 \begin_layout Plain Layout
15670 \begin_inset Flex Code
15673 \begin_layout Plain Layout
15680 {\SpecialChar ldots
15689 \begin_layout Description
15690 \begin_inset Flex Code
15693 \begin_layout Plain Layout
15700 \begin_inset Flex Code
15703 \begin_layout Plain Layout
15710 }\SpecialChar ldots
15726 \begin_layout Description
15727 \begin_inset Flex Code
15730 \begin_layout Plain Layout
15737 \begin_inset Flex Code
15740 \begin_layout Plain Layout
15747 \begin_inset Flex Code
15750 \begin_layout Plain Layout
15758 is generated for each paragraph of this environment.
15762 \begin_layout Description
15763 \begin_inset Flex Code
15766 \begin_layout Plain Layout
15773 \begin_inset Flex Code
15776 \begin_layout Plain Layout
15783 \begin_inset Newline newline
15787 \begin_inset Flex Code
15790 \begin_layout Plain Layout
15796 is passed as an argument to the environment.
15797 \begin_inset Newline newline
15801 \begin_inset Flex Code
15804 \begin_layout Plain Layout
15810 can be defined in the
15811 \begin_inset Flex Noun
15814 \begin_layout Plain Layout
15815 Edit\SpecialChar menuseparator
15817 \begin_inset space ~
15828 \begin_layout Description
15829 \begin_inset Flex Code
15832 \begin_layout Plain Layout
15839 \begin_inset Flex Code
15842 \begin_layout Plain Layout
15848 but adds the necessary mandatory argument (the longest label) to the begin
15849 statement of the bibliography environment:
15850 \begin_inset Newline newline
15854 \begin_inset Flex Code
15857 \begin_layout Plain Layout
15860 begin{thebibliography}{99}
15866 It is therefore only useful for bibliography environments.
15867 The default longest label
15868 \begin_inset Quotes eld
15872 \begin_inset Quotes erd
15875 can be changed by the user in the paragraph settings of a bibliography
15879 \begin_layout Standard
15880 Putting the last few things together, the \SpecialChar LaTeX
15881 output will be either:
15884 \begin_layout LyX-Code
15887 LatexName[LatexParam]{\SpecialChar ldots
15891 \begin_layout Standard
15895 \begin_layout LyX-Code
15898 begin{LatexName}[LatexParam] \SpecialChar ldots
15904 \begin_layout Standard
15905 depending upon the \SpecialChar LaTeX
15910 \begin_layout Description
15911 \begin_inset Flex Code
15914 \begin_layout Plain Layout
15921 \begin_inset Flex Code
15924 \begin_layout Plain Layout
15930 ] A string that is put at the beginning of the style content.
15931 A line break in the output can be indicated by
15932 \begin_inset Flex Code
15935 \begin_layout Plain Layout
15944 \begin_layout Description
15945 \begin_inset Flex Code
15948 \begin_layout Plain Layout
15955 \begin_inset Flex Code
15958 \begin_layout Plain Layout
15964 ] If you put styles into environments, the different
15965 \begin_inset Flex Code
15968 \begin_layout Plain Layout
15974 are not simply added, but added with a factor
15975 \begin_inset Formula $\frac{4}{\mathrm{depth}+4}$
15979 Note that this parameter is also used when
15980 \begin_inset Flex Code
15983 \begin_layout Plain Layout
15990 \begin_inset Flex Code
15993 \begin_layout Plain Layout
16000 \begin_inset Flex Code
16003 \begin_layout Plain Layout
16010 Then it is added to the manual or dynamic margin.
16011 \begin_inset Newline newline
16015 \begin_inset Quotes eld
16019 \begin_inset Flex Code
16022 \begin_layout Plain Layout
16029 \begin_inset Quotes erd
16032 means that the paragraph is indented with the width of
16033 \begin_inset Quotes eld
16037 \begin_inset Flex Code
16040 \begin_layout Plain Layout
16047 \begin_inset Quotes erd
16050 in the normal font.
16051 You can get a negative width by prefixing the string with
16052 \begin_inset Quotes eld
16056 \begin_inset Flex Code
16059 \begin_layout Plain Layout
16066 \begin_inset Quotes erd
16070 This way was chosen so that the look is the same with each used screen
16074 \begin_layout Description
16075 \begin_inset Flex Code
16078 \begin_layout Plain Layout
16085 \begin_inset Flex Code
16088 \begin_layout Plain Layout
16093 , Manual, Dynamic, First_Dynamic, Right_Address_Box
16099 \begin_inset Newline newline
16102 The kind of margin that the style has on the left side.
16106 \begin_layout Description
16107 \begin_inset Flex Code
16110 \begin_layout Plain Layout
16116 just means a fixed margin.
16119 \begin_layout Description
16120 \begin_inset Flex Code
16123 \begin_layout Plain Layout
16129 means that the left margin depends on the string entered in the
16130 \begin_inset Flex Noun
16133 \begin_layout Plain Layout
16134 Edit\SpecialChar menuseparator
16136 \begin_inset space ~
16145 This is used to typeset nice lists without tabulators.
16148 \begin_layout Description
16149 \begin_inset Flex Code
16152 \begin_layout Plain Layout
16158 means that the margin depends on the size of the label.
16159 This is used for automatic enumerated headlines.
16160 It is obvious that the headline
16161 \begin_inset Quotes eld
16164 5.4.3.2.1 Very long headline
16165 \begin_inset Quotes erd
16168 must have a wider left margin (as wide as
16169 \begin_inset Quotes eld
16173 \begin_inset Quotes erd
16176 plus the space) than
16177 \begin_inset Quotes eld
16180 3.2 Very long headline
16181 \begin_inset Quotes erd
16185 \begin_inset Quotes eld
16189 \begin_inset Quotes erd
16192 are not able to do this.
16195 \begin_layout Description
16196 \begin_inset Flex Code
16199 \begin_layout Plain Layout
16205 is similar, but only the very first row of the paragraph is dynamic, while
16206 the others are static; this is used, for example, for descriptions.
16209 \begin_layout Description
16210 \begin_inset Flex Code
16213 \begin_layout Plain Layout
16219 means the margin is chosen in a way that the longest row of this paragraph
16220 fits to the right margin.
16221 This is used to typeset an address on the right edge of the page.
16225 \begin_layout Description
16226 \begin_inset Flex Code
16229 \begin_layout Plain Layout
16236 \begin_inset Flex Code
16239 \begin_layout Plain Layout
16248 \begin_inset space \thinspace{}
16252 \begin_inset Flex Code
16255 \begin_layout Plain Layout
16261 ] Whether fragile commands in this style should be
16262 \begin_inset Flex Code
16265 \begin_layout Plain Layout
16278 whether this command should itself be protected.)
16279 \change_inserted -712698321 1523696949
16283 \begin_layout Description
16285 \change_inserted -712698321 1552395557
16286 \begin_inset Flex Code
16289 \begin_layout Plain Layout
16291 \change_inserted -712698321 1523696950
16300 \begin_inset Flex Code
16303 \begin_layout Plain Layout
16305 \change_inserted -712698321 1523696950
16316 \begin_inset space \thinspace{}
16320 \begin_inset Flex Code
16323 \begin_layout Plain Layout
16325 \change_inserted -712698321 1523696950
16333 ] This causes macros that contain this layout to be protected with
16334 \begin_inset Flex Code
16337 \begin_layout Plain Layout
16339 \change_inserted -712698321 1523696950
16354 ) if necessary and thus allows (some) verbatim stuff in macros.
16357 \begin_layout Description
16359 \change_inserted -712698321 1552395844
16360 \begin_inset Flex Code
16363 \begin_layout Plain Layout
16365 \change_inserted -712698321 1552395561
16374 \begin_inset Flex Code
16377 \begin_layout Plain Layout
16379 \change_inserted -712698321 1552395557
16390 \begin_inset space \thinspace{}
16394 \begin_inset Flex Code
16397 \begin_layout Plain Layout
16399 \change_inserted -712698321 1552395557
16407 ] Whether specific commands in this style (such as
16408 \begin_inset Flex Code
16411 \begin_layout Plain Layout
16413 \change_inserted -712698321 1552395655
16424 \begin_inset Flex Code
16427 \begin_layout Plain Layout
16429 \change_inserted -712698321 1552395661
16439 ) should be protected in an
16440 \begin_inset Flex Code
16443 \begin_layout Plain Layout
16445 \change_inserted -712698321 1552395631
16456 This is particularly needed for styles that draw on
16464 commands which parse their content in complex ways.
16469 \begin_layout Description
16470 \begin_inset Flex Code
16473 \begin_layout Plain Layout
16480 \begin_inset Flex Code
16483 \begin_layout Plain Layout
16490 \begin_inset space \thinspace{}
16494 \begin_inset Flex Code
16497 \begin_layout Plain Layout
16505 ] Whether newlines are translated into \SpecialChar LaTeX
16507 \begin_inset Flex Code
16510 \begin_layout Plain Layout
16521 The translation can be switched off to allow more comfortable \SpecialChar LaTeX
16523 inside \SpecialChar LyX
16527 \begin_layout Description
16528 \begin_inset Flex Code
16531 \begin_layout Plain Layout
16538 \begin_inset Flex Code
16541 \begin_layout Plain Layout
16550 \begin_inset space \thinspace{}
16554 \begin_inset Flex Code
16557 \begin_layout Plain Layout
16563 ] If set to true, and if
16564 \begin_inset Flex Code
16567 \begin_layout Plain Layout
16574 \begin_inset Flex Code
16577 \begin_layout Plain Layout
16583 ) paragraphs are being indented, then the indentation of such a paragraph
16584 following one of this type will be suppressed.
16585 (So this will not affect the display of non-default paragraphs.)
16588 \begin_layout Description
16589 \begin_inset Flex Code
16592 \begin_layout Plain Layout
16599 \begin_inset Flex Code
16602 \begin_layout Plain Layout
16608 ] Name of a style that has replaced this style.
16609 This is used to rename a style, while keeping backward compatibility.
16612 \begin_layout Description
16613 \begin_inset Flex Code
16616 \begin_layout Plain Layout
16623 \begin_inset Flex Code
16626 \begin_layout Plain Layout
16633 \begin_inset space \thinspace{}
16637 \begin_inset Flex Code
16640 \begin_layout Plain Layout
16646 ] Determines whether consecutive paragraphs of the same type are treated
16647 as belonging together.
16648 This has the effect that the
16649 \begin_inset Flex Code
16652 \begin_layout Plain Layout
16658 is only printed once before such a group.
16659 By default, this is true for
16660 \begin_inset Flex Code
16663 \begin_layout Plain Layout
16670 \begin_inset Flex Code
16673 \begin_layout Plain Layout
16680 \begin_inset Flex Code
16683 \begin_layout Plain Layout
16689 and false for all other types.
16692 \begin_layout Description
16693 \begin_inset Flex Code
16696 \begin_layout Plain Layout
16703 \begin_inset Flex Code
16706 \begin_layout Plain Layout
16715 \begin_inset space \thinspace{}
16719 \begin_inset Flex Code
16722 \begin_layout Plain Layout
16728 ] Indicates that paragraphs will not be separated by an empty line in \SpecialChar LaTeX
16730 but only by a line break; together with
16731 \begin_inset Flex Code
16734 \begin_layout Plain Layout
16740 , this allows to emulate a plain text editor (like the ERT inset).
16743 \begin_layout Description
16744 \begin_inset Flex Code
16747 \begin_layout Plain Layout
16754 \begin_inset Flex Code
16757 \begin_layout Plain Layout
16763 ] The indent of the very first line of a paragraph.
16765 \begin_inset Newline newline
16769 \begin_inset Flex Code
16772 \begin_layout Plain Layout
16778 will be fixed for a certain style.
16779 The exception is the default style, since the indentation for these paragraphs
16780 can be prohibited with
16781 \begin_inset Flex Code
16784 \begin_layout Plain Layout
16792 \begin_inset Flex Code
16795 \begin_layout Plain Layout
16801 style paragraphs inside environments use the
16802 \begin_inset Flex Code
16805 \begin_layout Plain Layout
16811 of the environment, not their native one.
16813 \begin_inset Flex Code
16816 \begin_layout Plain Layout
16822 paragraphs inside an enumeration are not indented.
16825 \begin_layout Description
16826 \begin_inset Flex Code
16829 \begin_layout Plain Layout
16836 \begin_inset Flex Code
16839 \begin_layout Plain Layout
16845 ] The vertical space between two paragraphs of this style.
16848 \begin_layout Description
16849 \begin_inset Flex Code
16852 \begin_layout Plain Layout
16859 \begin_inset Flex Code
16862 \begin_layout Plain Layout
16869 allows the user to choose either
16870 \begin_inset Quotes eld
16874 \begin_inset Quotes erd
16878 \begin_inset Quotes eld
16882 \begin_inset Quotes erd
16885 to separate paragraphs.
16887 \begin_inset Quotes eld
16891 \begin_inset Quotes erd
16895 \begin_inset Flex Code
16898 \begin_layout Plain Layout
16906 \begin_inset Quotes eld
16910 \begin_inset Quotes erd
16914 \begin_inset Flex Code
16917 \begin_layout Plain Layout
16923 is ignored and all paragraphs are separated by the
16924 \begin_inset Flex Code
16927 \begin_layout Plain Layout
16934 The vertical space is calculated with
16935 \begin_inset Flex Code
16938 \begin_layout Plain Layout
16940 \begin_inset space ~
16949 \begin_inset Flex Code
16952 \begin_layout Plain Layout
16958 is the height of a row with the normal font.
16959 This way, the look stays the same with different screen fonts.
16962 \begin_layout Description
16963 \begin_inset Flex Code
16966 \begin_layout Plain Layout
16973 \begin_inset Flex Code
16976 \begin_layout Plain Layout
16985 \begin_inset space \thinspace{}
16989 \begin_inset Flex Code
16992 \begin_layout Plain Layout
16998 ] Whether the contents of this paragraph should be output in raw form, meaning
16999 without special translations that \SpecialChar LaTeX
17003 \begin_layout Description
17004 \begin_inset Flex Code
17007 \begin_layout Plain Layout
17014 \begin_inset Flex Code
17017 \begin_layout Plain Layout
17027 Defines individual characters that should be output in raw form, meaning
17028 without special translations that \SpecialChar LaTeX
17032 \begin_layout Description
17033 \begin_inset Flex Code
17036 \begin_layout Plain Layout
17042 Information to be included in the \SpecialChar LaTeX
17043 preamble when this style is used.
17044 Used to define macros, load packages, etc., required by this particular
17047 \begin_inset Quotes eld
17051 \begin_inset Flex Code
17054 \begin_layout Plain Layout
17061 \begin_inset Quotes erd
17067 \begin_layout Description
17068 \begin_inset Flex Code
17071 \begin_layout Plain Layout
17078 \begin_inset Flex Code
17081 \begin_layout Plain Layout
17087 ] The prefix to use when creating labels referring to paragraphs of this
17089 This allows the use of formatted references.
17092 \begin_layout Description
17093 \begin_inset Flex Code
17096 \begin_layout Plain Layout
17103 \begin_inset Flex Code
17106 \begin_layout Plain Layout
17112 ] Whether the style requires the feature
17113 \begin_inset Flex Code
17116 \begin_layout Plain Layout
17123 \begin_inset CommandInset ref
17125 reference "chap:List-of-functions"
17129 for the list of features).
17130 If you require a package with specific options, you can additionally use
17132 \begin_inset Flex Code
17135 \begin_layout Plain Layout
17141 as a general text class parameter (see
17142 \begin_inset CommandInset ref
17144 reference "subsec:General-text-class"
17151 \begin_layout Description
17152 \begin_inset Flex Code
17155 \begin_layout Plain Layout
17162 \begin_inset Flex Code
17165 \begin_layout Plain Layout
17174 \begin_inset Flex Code
17177 \begin_layout Plain Layout
17183 ] Resets the \SpecialChar LaTeX
17184 arguments of this style (as defined via the
17185 \begin_inset Flex Code
17188 \begin_layout Plain Layout
17195 This is useful if you have copied a style via
17196 \begin_inset Flex Code
17199 \begin_layout Plain Layout
17205 , but you do not want to inherit its (required and optional) arguments.
17208 \begin_layout Description
17209 \begin_inset Flex Code
17212 \begin_layout Plain Layout
17219 \begin_inset Flex Code
17222 \begin_layout Plain Layout
17231 \begin_inset Flex Code
17234 \begin_layout Plain Layout
17240 ] Resumes a counter that is usually reset at each new sequence of layouts.
17241 This is currently only useful when
17242 \begin_inset Flex Code
17245 \begin_layout Plain Layout
17252 \begin_inset Flex Code
17255 \begin_layout Plain Layout
17264 \begin_layout Description
17265 \begin_inset Flex Code
17268 \begin_layout Plain Layout
17275 \begin_inset Flex Code
17278 \begin_layout Plain Layout
17284 ] A string that is put at the end of the layout content.
17285 A line break in the output can be indicated by
17286 \begin_inset Flex Code
17289 \begin_layout Plain Layout
17298 \begin_layout Description
17299 \begin_inset Flex Code
17302 \begin_layout Plain Layout
17309 \begin_inset Flex Code
17312 \begin_layout Plain Layout
17319 \begin_inset Flex Code
17322 \begin_layout Plain Layout
17331 \begin_layout Description
17332 \begin_inset Flex Code
17335 \begin_layout Plain Layout
17342 \begin_inset Flex Code
17345 \begin_layout Plain Layout
17354 \begin_inset Flex Code
17357 \begin_layout Plain Layout
17364 \begin_inset Flex Code
17367 \begin_layout Plain Layout
17374 \begin_inset Flex Code
17377 \begin_layout Plain Layout
17379 \begin_inset space ~
17387 ] This defines what the default spacing should be in the style.
17389 \begin_inset Flex Code
17392 \begin_layout Plain Layout
17399 \begin_inset Flex Code
17402 \begin_layout Plain Layout
17409 \begin_inset Flex Code
17412 \begin_layout Plain Layout
17418 correspond respectively to a multiplier value of 1, 1.25 and 1.667.
17419 If you specify the argument
17420 \begin_inset Flex Code
17423 \begin_layout Plain Layout
17429 , then you must also provide a value argument which will be the actual multiplie
17431 Note that, contrary to other parameters,
17432 \begin_inset Flex Code
17435 \begin_layout Plain Layout
17441 implies the generation of specific \SpecialChar LaTeX
17442 code, using the \SpecialChar LaTeX
17446 \begin_inset Flex Code
17449 \begin_layout Plain Layout
17458 \begin_layout Description
17459 \begin_inset Flex Code
17462 \begin_layout Plain Layout
17469 \begin_inset Flex Code
17472 \begin_layout Plain Layout
17479 \begin_inset space \thinspace{}
17483 \begin_inset Flex Code
17486 \begin_layout Plain Layout
17494 ] Allow spell-checking paragraphs of this style.
17498 \begin_layout Description
17499 \begin_inset Flex Code
17502 \begin_layout Plain Layout
17504 \change_deleted 731793113 1604355211
17506 \change_inserted 731793113 1604355212
17515 \begin_inset Flex Code
17518 \begin_layout Plain Layout
17527 \begin_inset Flex Code
17530 \begin_layout Plain Layout
17537 \change_deleted 731793113 1604355214
17539 \change_inserted 731793113 1604355216
17542 counter of a given counter at the beginning of a new sequence of layouts.
17543 This is currently only useful when
17544 \begin_inset Flex Code
17547 \begin_layout Plain Layout
17554 \begin_inset Flex Code
17557 \begin_layout Plain Layout
17566 \begin_layout Description
17567 \begin_inset Flex Code
17570 \begin_layout Plain Layout
17576 The font used for the text body .
17578 \begin_inset CommandInset ref
17580 reference "subsec:Font-description"
17587 \begin_layout Description
17588 \begin_inset Flex Code
17591 \begin_layout Plain Layout
17600 \begin_inset Flex Code
17603 \begin_layout Plain Layout
17613 The level of the style in the table of contents.
17614 This is used for automatic numbering of section headings.
17617 \begin_layout Description
17618 \begin_inset Flex Code
17621 \begin_layout Plain Layout
17630 \begin_inset Flex Code
17633 \begin_layout Plain Layout
17644 \begin_inset Flex Code
17647 \begin_layout Plain Layout
17654 \begin_inset Flex Code
17657 \begin_layout Plain Layout
17663 ] This tag determines whether the first line indentation of this paragraph
17664 can be toggled via the Paragraph settings dialog.
17668 \begin_inset Flex Code
17671 \begin_layout Plain Layout
17681 is set, indentation can be toggled if the document settings use
17682 \begin_inset Quotes eld
17686 \begin_inset Quotes erd
17689 paragraph style, with
17690 \begin_inset Flex Code
17693 \begin_layout Plain Layout
17699 , indentation can always be toggled, notwithstanding the document settings,
17701 \begin_inset Flex Code
17704 \begin_layout Plain Layout
17710 , indentation can never be toggled.
17713 \begin_layout Description
17714 \begin_inset Flex Code
17717 \begin_layout Plain Layout
17724 \begin_inset Flex Code
17727 \begin_layout Plain Layout
17733 ] The vertical space with which the very first of a chain of paragraphs
17734 with this style is separated from the previous paragraph.
17735 If the previous paragraph has another style, the separations are not simply
17736 added, but the maximum is taken.
17739 \begin_layout Subsection
17740 \begin_inset CommandInset label
17746 Internationalization of Paragraph Styles
17749 \begin_layout Standard
17751 has long supported internationalization of layout information, but, until
17752 version 2.0, this applied only to the user interface and not to, say, PDF
17754 Thus, French authors were forced to resort to ugly hacks if they wanted
17759 1' instead of `Theorem 1'.
17760 Thanks to Georg Baum, that is no longer the case.
17763 \begin_layout Standard
17765 \begin_inset Flex Code
17768 \begin_layout Plain Layout
17774 defines text that is to appear in the typeset document, it may use
17775 \begin_inset Flex Code
17778 \begin_layout Plain Layout
17785 \begin_inset Flex Code
17788 \begin_layout Plain Layout
17794 to support non-English and even multi-language documents correctly.
17795 The following excerpt (from the
17796 \begin_inset Flex Code
17799 \begin_layout Plain Layout
17805 file) shows how this works:
17808 \begin_layout LyX-Code
17813 \begin_layout LyX-Code
17816 theoremstyle{remark}
17819 \begin_layout LyX-Code
17822 newtheorem{claim}[thm]{
17829 \begin_layout LyX-Code
17833 \begin_layout LyX-Code
17837 \begin_layout LyX-Code
17842 claimname}{_(Claim)}
17845 \begin_layout LyX-Code
17849 \begin_layout LyX-Code
17853 \begin_layout LyX-Code
17862 claimname}{_(Claim)}}
17865 \begin_layout LyX-Code
17870 \begin_layout Standard
17871 In principle, any legal \SpecialChar LaTeX
17873 \begin_inset Flex Code
17876 \begin_layout Plain Layout
17883 \begin_inset Flex Code
17886 \begin_layout Plain Layout
17892 tags, but in practice they will typically look as they do here.
17893 The key to correct translation of the typeset text is the definition of
17894 the \SpecialChar LaTeX
17896 \begin_inset Flex Code
17899 \begin_layout Plain Layout
17908 \begin_inset Flex Code
17911 \begin_layout Plain Layout
17923 \begin_layout Standard
17925 \begin_inset Flex Code
17928 \begin_layout Plain Layout
17934 tag provides for internationalization based upon the overall language of
17936 The contents of the tag will be included in the preamble, just as with
17938 \begin_inset Flex Code
17941 \begin_layout Plain Layout
17948 What makes it special is the use of the
17949 \begin_inset Quotes eld
17953 \begin_inset Quotes erd
17957 \begin_inset Flex Code
17960 \begin_layout Plain Layout
17966 , which will be replaced, when \SpecialChar LyX
17967 produces \SpecialChar LaTeX
17968 output, with the translation of
17969 its argument into the document language.
17972 \begin_layout Standard
17974 \begin_inset Flex Code
17977 \begin_layout Plain Layout
17983 tag is more complex, since it is meant to provide support for multi-language
17984 documents and so offers an interface to the
17985 \begin_inset Flex Code
17988 \begin_layout Plain Layout
17995 Its contents will be added to the preamble once for each language that
17996 appears in the document.
17997 In this case, the argument to
17998 \begin_inset Flex Code
18001 \begin_layout Plain Layout
18007 will be replaced with its translation into the language in question; the
18009 \begin_inset Flex Code
18012 \begin_layout Plain Layout
18018 is replaced by the language name (as used by the babel package).
18021 \begin_layout Standard
18022 A German document that also included a French section would thus have the
18023 following in the preamble:
18026 \begin_layout LyX-Code
18035 claimname}{Affirmation}}
18036 \begin_inset Newline newline
18047 claimname}{Behauptung}}
18048 \begin_inset Newline newline
18055 claimname}{Behauptung}
18058 \begin_layout Standard
18061 \begin_inset Flex Code
18064 \begin_layout Plain Layout
18070 will then conspire to produce the correct text in the output.
18073 \begin_layout Standard
18074 One important point to note here is that the translations are provided by
18076 itself, through the file
18077 \begin_inset Flex Code
18080 \begin_layout Plain Layout
18087 This means, in effect, that
18088 \begin_inset Flex Code
18091 \begin_layout Plain Layout
18098 \begin_inset Flex Code
18101 \begin_layout Plain Layout
18107 are really only of use in layout files that are provided with \SpecialChar LyX
18109 entered in user-created layout files will not be seen by \SpecialChar LyX
18110 's internationalizatio
18111 n routines unless the
18112 \begin_inset Flex Code
18115 \begin_layout Plain Layout
18121 file is modified accordingly.
18122 That said, however, any layout created with the intention that it will
18123 be included with \SpecialChar LyX
18124 should use these tags where appropriate.
18125 Please note that the paragraph style translations provided by \SpecialChar LyX
18127 change with a minor update (e.
18128 \begin_inset space \thinspace{}
18132 \begin_inset space \space{}
18135 from version 2.1.x to 2.1.y).
18136 It is however quite likely that a major update (e.
18137 \begin_inset space \thinspace{}
18141 \begin_inset space \space{}
18144 from 2.0.x to 2.1.0) will introduce new translations or corrections.
18147 \begin_layout Subsection
18149 \begin_inset CommandInset label
18151 name "subsec:Floats"
18158 \begin_layout Standard
18159 It is necessary to define the floats (
18160 \begin_inset Flex Noun
18163 \begin_layout Plain Layout
18170 \begin_inset Flex Noun
18173 \begin_layout Plain Layout
18179 , \SpecialChar ldots
18180 ) in the text class itself.
18181 Standard floats are included in the file
18182 \begin_inset Flex Code
18185 \begin_layout Plain Layout
18191 , so you may have to do no more than add
18194 \begin_layout LyX-Code
18195 Input stdfloats.inc
18198 \begin_layout Standard
18199 to your layout file.
18200 If you want to implement a text class that proposes some other float types
18201 (like the AGU class bundled with \SpecialChar LyX
18202 ), the information below will hopefully
18206 \begin_layout Description
18207 \begin_inset Flex Code
18210 \begin_layout Plain Layout
18217 \begin_inset Flex Code
18220 \begin_layout Plain Layout
18226 =!htbpH] Allowed placement options for this float type.
18227 The value is a string of placement characters.
18228 Possible characters include:
18233 \begin_inset Quotes eld
18237 \begin_inset Quotes erd
18245 \begin_inset Quotes eld
18249 \begin_inset Quotes erd
18257 \begin_inset Quotes eld
18261 \begin_inset Quotes erd
18269 \begin_inset Quotes eld
18273 \begin_inset Quotes erd
18281 \begin_inset Quotes eld
18285 \begin_inset Quotes erd
18293 \begin_inset Quotes eld
18297 \begin_inset Quotes erd
18301 The order of the characters in the string does not matter.
18302 If no placement options are allowed, use the string
18309 \begin_layout Description
18310 \begin_inset Flex Code
18313 \begin_layout Plain Layout
18320 \begin_inset Flex Code
18323 \begin_layout Plain Layout
18332 \begin_inset space \thinspace{}
18338 \begin_inset Flex Code
18341 \begin_layout Plain Layout
18351 ] Defines whether the float allows to be rotated via the \SpecialChar LaTeX
18358 \begin_inset Flex Code
18361 \begin_layout Plain Layout
18367 if the float does not support this feature.
18370 \begin_layout Description
18371 \begin_inset Flex Code
18374 \begin_layout Plain Layout
18381 \begin_inset Flex Code
18384 \begin_layout Plain Layout
18393 \begin_inset space \thinspace{}
18399 \begin_inset Flex Code
18402 \begin_layout Plain Layout
18412 ] Defines whether the float has a starred variant that spans columns in
18413 a two column paragraph.
18415 \begin_inset Flex Code
18418 \begin_layout Plain Layout
18424 if the float does not support this feature.
18427 \begin_layout Description
18428 \begin_inset Flex Code
18431 \begin_layout Plain Layout
18438 \begin_inset Flex Code
18441 \begin_layout Plain Layout
18448 \begin_inset Quotes erd
18452 \begin_inset Quotes erd
18455 ] The file name extension of an auxiliary file for the list of figures (or
18458 writes the captions to this file.
18461 \begin_layout Description
18462 \begin_inset Flex Code
18465 \begin_layout Plain Layout
18472 \begin_inset Flex Code
18475 \begin_layout Plain Layout
18482 \begin_inset Quotes erd
18486 \begin_inset Quotes erd
18489 ] The string that will be used in the menus and also for the caption.
18490 This is translated to the current language if babel is used.
18493 \begin_layout Description
18494 \begin_inset Flex Code
18497 \begin_layout Plain Layout
18503 These tags control the XHTML output.
18505 \begin_inset CommandInset ref
18507 reference "sec:Tags-for-XHTML"
18514 \begin_layout Description
18515 \begin_inset Flex Code
18518 \begin_layout Plain Layout
18527 \begin_inset Flex Code
18530 \begin_layout Plain Layout
18539 \begin_inset space \thinspace{}
18543 \begin_inset Flex Code
18546 \begin_layout Plain Layout
18552 ] Indicates whether the float is already defined in the document class or
18553 if instead the \SpecialChar LaTeX
18555 \begin_inset Flex Code
18558 \begin_layout Plain Layout
18564 needs to be loaded to define it on-the-fly.
18566 \begin_inset Flex Code
18569 \begin_layout Plain Layout
18576 \begin_inset Flex Code
18579 \begin_layout Plain Layout
18586 It should be set to
18587 \begin_inset Flex Code
18590 \begin_layout Plain Layout
18596 if the float is already defined by the \SpecialChar LaTeX
18600 \begin_layout Description
18601 \begin_inset Flex Code
18604 \begin_layout Plain Layout
18611 \begin_inset Flex Code
18614 \begin_layout Plain Layout
18621 \begin_inset Quotes erd
18625 \begin_inset Quotes erd
18628 ] The command used to generate a list of floats of this type; the leading
18637 \begin_inset Flex Code
18640 \begin_layout Plain Layout
18646 is false, since there is no standard way to generate this command.
18648 \begin_inset Flex Code
18651 \begin_layout Plain Layout
18657 is true, since in that case there is a standard way to define the command.
18660 \begin_layout Description
18661 \begin_inset Flex Code
18664 \begin_layout Plain Layout
18671 \begin_inset Flex Code
18674 \begin_layout Plain Layout
18681 \begin_inset Quotes erd
18685 \begin_inset Quotes erd
18688 ] A title for a list of floats of this kind (list of figures, tables, or
18690 It is used for the screen label within \SpecialChar LyX
18691 , it is used by \SpecialChar LaTeX
18693 it is used as the title in the XHTML output.
18694 It will be translated to the document language.
18697 \begin_layout Description
18698 \begin_inset Flex Code
18701 \begin_layout Plain Layout
18708 \begin_inset Flex Code
18711 \begin_layout Plain Layout
18718 \begin_inset Quotes erd
18722 \begin_inset Quotes erd
18725 ] This (optional) argument determines whether floats of this class will
18726 be numbered within some sectional unit of the document.
18728 \begin_inset Flex Code
18731 \begin_layout Plain Layout
18738 \begin_inset Quotes eld
18742 \begin_inset Flex Code
18745 \begin_layout Plain Layout
18752 \begin_inset Quotes erd
18755 , the floats will be numbered within chapters.
18759 \begin_layout Description
18760 \begin_inset Flex Code
18763 \begin_layout Plain Layout
18770 \begin_inset Flex Code
18773 \begin_layout Plain Layout
18780 \begin_inset Quotes erd
18784 \begin_inset Quotes erd
18787 ] The default placement for the given class of floats.
18788 The string should be as in standard \SpecialChar LaTeX
18790 \begin_inset Flex Code
18793 \begin_layout Plain Layout
18800 \begin_inset Flex Code
18803 \begin_layout Plain Layout
18810 \begin_inset Flex Code
18813 \begin_layout Plain Layout
18820 \begin_inset Flex Code
18823 \begin_layout Plain Layout
18829 for top, bottom, page, and here, respectively.
18833 \begin_layout Plain Layout
18834 Note that the order of these letters in the string is irrelevant, like in
18841 On top of that there is a new type,
18842 \begin_inset Flex Code
18845 \begin_layout Plain Layout
18851 , which does not really correspond to a float, since it means: put it
18852 \begin_inset Quotes eld
18856 \begin_inset Quotes erd
18860 Note however that the
18861 \begin_inset Flex Code
18864 \begin_layout Plain Layout
18870 specifier is special and, because of implementation details, cannot be
18871 used in non-built in float types.
18872 If you do not understand what this means, just use
18873 \begin_inset Quotes eld
18877 \begin_inset Flex Code
18880 \begin_layout Plain Layout
18887 \begin_inset Quotes erd
18893 \begin_layout Description
18894 \begin_inset Flex Code
18897 \begin_layout Plain Layout
18904 \begin_inset Flex Code
18907 \begin_layout Plain Layout
18913 ] The prefix to use when creating labels referring to floats of this type.
18914 This allows the use of formatted references.
18915 Note that you can remove any
18916 \begin_inset Flex Code
18919 \begin_layout Plain Layout
18925 set by a copied style by using the special value
18926 \begin_inset Quotes eld
18930 \begin_inset Quotes erd
18933 , which must be all caps.
18934 \change_inserted -712698321 1565605014
18938 \begin_layout Description
18940 \change_inserted -712698321 1565605014
18941 \begin_inset Flex Code
18944 \begin_layout Plain Layout
18946 \change_inserted -712698321 1565605014
18955 \begin_inset Flex Code
18958 \begin_layout Plain Layout
18960 \change_inserted -712698321 1565605014
18968 ] As with paragraph styles, see
18969 \begin_inset CommandInset ref
18971 reference "subsec:Paragraph-Styles"
18980 \begin_layout Description
18981 \begin_inset Flex Code
18984 \begin_layout Plain Layout
18991 \begin_inset Flex Code
18994 \begin_layout Plain Layout
19001 \begin_inset Quotes erd
19005 \begin_inset Quotes erd
19008 ] The style used when defining the float using
19009 \begin_inset Flex Code
19012 \begin_layout Plain Layout
19023 \begin_layout Description
19024 \begin_inset Flex Code
19027 \begin_layout Plain Layout
19034 \begin_inset Flex Code
19037 \begin_layout Plain Layout
19044 \begin_inset Quotes erd
19048 \begin_inset Quotes erd
19052 \begin_inset Quotes eld
19056 \begin_inset Quotes erd
19059 of the new class of floats, like program or algorithm.
19060 After the appropriate
19061 \begin_inset Flex Code
19064 \begin_layout Plain Layout
19073 \begin_inset Flex Code
19076 \begin_layout Plain Layout
19085 \begin_inset Flex Code
19088 \begin_layout Plain Layout
19099 \begin_layout Description
19100 \begin_inset Flex Code
19103 \begin_layout Plain Layout
19110 \begin_inset Flex Code
19113 \begin_layout Plain Layout
19120 \begin_inset space \thinspace{}
19124 \begin_inset Flex Code
19127 \begin_layout Plain Layout
19135 ] Specifies whether this float is defined using the \SpecialChar LaTeX
19137 \begin_inset Flex Code
19140 \begin_layout Plain Layout
19146 , either by the class file, another package or on-the-fly by \SpecialChar LyX
19150 \begin_layout Standard
19151 Note that defining a float with type
19152 \begin_inset Flex Code
19155 \begin_layout Plain Layout
19163 automatically defines the corresponding counter with name
19164 \begin_inset Flex Code
19167 \begin_layout Plain Layout
19178 \begin_layout Subsection
19179 Flex insets and InsetLayout
19180 \begin_inset CommandInset label
19182 name "subsec:Flex-insets-and"
19189 \begin_layout Standard
19190 Flex insets come in
19191 \change_deleted 5863208 1594239511
19193 \change_inserted 5863208 1594239512
19199 \begin_layout Itemize
19201 \begin_inset Flex Code
19204 \begin_layout Plain Layout
19210 ): These define semantic markup corresponding to such \SpecialChar LaTeX
19212 \begin_inset Flex Code
19215 \begin_layout Plain Layout
19224 \begin_inset Flex Code
19227 \begin_layout Plain Layout
19238 \begin_layout Itemize
19240 \begin_inset Flex Code
19243 \begin_layout Plain Layout
19249 ): These can be used to define custom collapsible insets, similar to \SpecialChar TeX
19251 footnote, and the like.
19252 An obvious example is an endnote inset, which is defined in the
19253 \begin_inset Flex Code
19256 \begin_layout Plain Layout
19265 \begin_layout Itemize
19267 \change_deleted 5863208 1594239528
19269 \begin_inset Flex Code
19272 \begin_layout Plain Layout
19278 ): For use with DocBook classes.
19283 \begin_layout Standard
19284 Flex insets are defined using the
19285 \begin_inset Flex Code
19288 \begin_layout Plain Layout
19294 tag, which shall be explained in a moment.
19297 \begin_layout Standard
19299 \begin_inset Flex Code
19302 \begin_layout Plain Layout
19308 tag also serves another function: It can be used to customize the general
19309 layout of many different types of insets.
19311 \begin_inset Flex Code
19314 \begin_layout Plain Layout
19320 can be used to customize the layout parameters for footnotes, marginal
19321 notes, note insets, \SpecialChar TeX
19322 code (ERT) insets, branches, listings, indexes, boxes,
19323 tables, algorithms, URLs, and captions, as well as to define Flex insets.
19326 \begin_layout Standard
19328 \begin_inset Flex Code
19331 \begin_layout Plain Layout
19337 definition must begin with a line of the form:
19340 \begin_layout LyX-Code
19344 \begin_layout Standard
19346 \begin_inset Flex Code
19349 \begin_layout Plain Layout
19355 indicates the inset whose layout is being defined, and here there are four
19359 \begin_layout Enumerate
19360 The layout for a pre-existing inset is being modified.
19361 In this case, can be
19362 \begin_inset Flex Code
19365 \begin_layout Plain Layout
19371 any one of the following:
19372 \begin_inset Flex Code
19375 \begin_layout Plain Layout
19382 \begin_inset Flex Code
19385 \begin_layout Plain Layout
19392 \begin_inset Flex Code
19395 \begin_layout Plain Layout
19402 \begin_inset Flex Code
19405 \begin_layout Plain Layout
19412 \begin_inset Flex Code
19415 \begin_layout Plain Layout
19422 \begin_inset Flex Code
19425 \begin_layout Plain Layout
19432 \begin_inset Flex Code
19435 \begin_layout Plain Layout
19442 \begin_inset Flex Code
19445 \begin_layout Plain Layout
19452 \begin_inset Flex Code
19455 \begin_layout Plain Layout
19462 \begin_inset Flex Code
19465 \begin_layout Plain Layout
19472 \begin_inset Flex Code
19475 \begin_layout Plain Layout
19482 \begin_inset Flex Code
19485 \begin_layout Plain Layout
19492 \begin_inset Flex Code
19495 \begin_layout Plain Layout
19502 \begin_inset Flex Code
19505 \begin_layout Plain Layout
19512 \begin_inset Flex Code
19515 \begin_layout Plain Layout
19522 \begin_inset Flex Code
19525 \begin_layout Plain Layout
19532 \begin_inset Flex Code
19535 \begin_layout Plain Layout
19542 \begin_inset Flex Code
19545 \begin_layout Plain Layout
19552 \begin_inset Flex Code
19555 \begin_layout Plain Layout
19562 \begin_inset Flex Code
19565 \begin_layout Plain Layout
19574 \begin_layout Enumerate
19575 The layout for a Flex inset is being defined.
19577 \begin_inset Flex Code
19580 \begin_layout Plain Layout
19586 must be of the form
19587 \begin_inset Quotes eld
19591 \begin_inset Flex Code
19594 \begin_layout Plain Layout
19601 \begin_inset Quotes erd
19605 \begin_inset Flex Code
19608 \begin_layout Plain Layout
19614 may be be any valid identifier not used by a pre-existing Flex inset.
19615 The identifier may include spaces, but in that case the whole thing must
19616 be wrapped in quotes.
19617 Note that the definition of a flex inset
19622 \begin_inset Flex Code
19625 \begin_layout Plain Layout
19631 entry, declaring which type of inset it defines.
19634 \begin_layout Enumerate
19635 The layout for user specific branch is being defined.
19637 \begin_inset Flex Code
19640 \begin_layout Plain Layout
19646 must be of the form
19647 \begin_inset Quotes eld
19651 \begin_inset Flex Code
19654 \begin_layout Plain Layout
19661 \begin_inset Quotes erd
19665 \begin_inset Flex Code
19668 \begin_layout Plain Layout
19674 may be be any valid identifier of branch defined in user's document.
19675 The identifier may include spaces, but in that case the whole thing must
19676 be wrapped in quotes.
19677 The main purpose of this feature is to allow \SpecialChar LaTeX
19678 wrapping around specific
19679 branches as user needs.
19682 \begin_layout Enumerate
19683 The layout of a user (or class) specific caption is being defined.
19685 \begin_inset Flex Code
19688 \begin_layout Plain Layout
19694 must be of the form
19695 \begin_inset Quotes eld
19699 \begin_inset Flex Code
19702 \begin_layout Plain Layout
19709 \begin_inset Quotes erd
19713 \begin_inset Flex Code
19716 \begin_layout Plain Layout
19722 specifies the name of the caption as it appears in the menu.
19723 Have a look at the standard caption (
19724 \begin_inset Flex Code
19727 \begin_layout Plain Layout
19733 ), the specific captions of the KOMA-Script classes (
19734 \begin_inset Flex Code
19737 \begin_layout Plain Layout
19744 \begin_inset Flex Code
19747 \begin_layout Plain Layout
19756 \begin_inset space ~
19760 \begin_inset Newline linebreak
19766 \begin_inset Flex Code
19769 \begin_layout Plain Layout
19775 ) for applications.
19778 \begin_layout Standard
19780 \begin_inset Flex Code
19783 \begin_layout Plain Layout
19789 definition can contain the following entries:
19792 \begin_layout Description
19793 \begin_inset Flex Code
19796 \begin_layout Plain Layout
19803 \begin_inset Flex Code
19806 \begin_layout Plain Layout
19812 =""] This inset will appear in the table of contents of the given type.
19813 An empty string disables.
19814 See also the OutlinerName and the IsTocCaption commands.
19815 This is only implemented for Flex insets.
19819 \begin_layout Description
19820 \begin_inset Flex Code
19823 \begin_layout Plain Layout
19830 \begin_inset Flex Code
19833 \begin_layout Plain Layout
19839 ] Defines argument number of a command\SpecialChar breakableslash
19840 environment associated with the current
19842 The definition must end with
19843 \begin_inset Flex Code
19846 \begin_layout Plain Layout
19854 \begin_inset CommandInset ref
19856 reference "subsec:Paragraph-Styles"
19863 \begin_layout Description
19864 \begin_inset Flex Code
19867 \begin_layout Plain Layout
19873 Preamble for changing language commands; see
19874 \begin_inset CommandInset ref
19876 reference "subsec:I18n"
19883 \begin_layout Description
19884 \begin_inset Flex Code
19887 \begin_layout Plain Layout
19894 \begin_inset Flex Code
19897 \begin_layout Plain Layout
19903 ] The color for the inset's background.
19905 \begin_inset CommandInset ref
19907 reference "chap:Names-of-colors"
19911 for a list of the available color names.
19914 \begin_layout Description
19915 \begin_inset Flex Code
19918 \begin_layout Plain Layout
19925 \begin_inset Flex Code
19928 \begin_layout Plain Layout
19937 \begin_inset space \thinspace{}
19941 \begin_inset Flex Code
19944 \begin_layout Plain Layout
19950 ] Whether to use the content of the inset as the label, when the inset is
19955 \begin_layout Description
19956 \begin_inset Flex Code
19959 \begin_layout Plain Layout
19966 \begin_inset Flex Code
19969 \begin_layout Plain Layout
19975 ] As with paragraph styles, see
19976 \begin_inset CommandInset ref
19978 reference "subsec:Paragraph-Styles"
19983 Note that you need to specify the complete type, e.
19984 \begin_inset space \thinspace{}
19988 \begin_inset space ~
19992 \begin_inset Flex Code
19995 \begin_layout Plain Layout
19996 CopyStyle Flex:<name>
20004 \begin_layout Description
20005 \begin_inset Flex Code
20008 \begin_layout Plain Layout
20015 \begin_inset Flex Code
20018 \begin_layout Plain Layout
20027 \begin_inset space \thinspace{}
20031 \begin_inset Flex Code
20034 \begin_layout Plain Layout
20040 ] Indicates whether the user may employ the Paragraph Settings dialog to
20041 customize the paragraph.
20044 \begin_layout Description
20045 \begin_inset Flex Code
20048 \begin_layout Plain Layout
20055 \begin_inset Flex Code
20058 \begin_layout Plain Layout
20065 \begin_inset Flex Code
20068 \begin_layout Plain Layout
20075 \begin_inset Flex Code
20078 \begin_layout Plain Layout
20084 , describing the rendering style used for the inset's frame and buttons.
20085 Footnotes generally use
20086 \begin_inset Flex Code
20089 \begin_layout Plain Layout
20095 , ERT insets generally
20096 \begin_inset Flex Code
20099 \begin_layout Plain Layout
20105 , and character styles
20106 \begin_inset Flex Code
20109 \begin_layout Plain Layout
20118 \begin_layout Description
20119 \begin_inset Flex Code
20122 \begin_layout Plain Layout
20129 \begin_inset Flex Code
20132 \begin_layout Plain Layout
20141 \begin_inset space \thinspace{}
20147 \begin_inset Flex Code
20150 \begin_layout Plain Layout
20159 \begin_inset Flex Code
20162 \begin_layout Plain Layout
20169 \begin_inset Flex Code
20172 \begin_layout Plain Layout
20179 Indicates whether the environment will stand on its own in the output or
20180 will appear inline with the surrounding text.
20181 If set to false, it is supposed that the \SpecialChar LaTeX
20182 environment ignores white space
20183 (including one newline character) after the
20184 \begin_inset Flex Code
20187 \begin_layout Plain Layout
20200 \begin_inset Flex Code
20203 \begin_layout Plain Layout
20217 \change_inserted 731793113 1538674858
20221 \begin_layout Description
20223 \change_inserted 731793113 1538674891
20224 \begin_inset Flex Code
20227 \begin_layout Plain Layout
20229 \change_inserted 731793113 1538674863
20241 ,1] Allow the contents of the inset to be edited externally (using whatever
20242 editor is defined for the document's output format).
20247 \begin_layout Description
20248 \begin_inset Flex Code
20251 \begin_layout Plain Layout
20257 Required at the end of the
20258 \begin_inset Flex Code
20261 \begin_layout Plain Layout
20270 \begin_layout Description
20271 \begin_inset Flex Code
20274 \begin_layout Plain Layout
20280 The font used for both the text body
20286 \begin_inset CommandInset ref
20288 reference "subsec:Font-description"
20293 Note that defining this font automatically defines the
20294 \begin_inset Flex Code
20297 \begin_layout Plain Layout
20303 to the same value, so define this first and define
20304 \begin_inset Flex Code
20307 \begin_layout Plain Layout
20313 later if you want them to be different.
20316 \begin_layout Description
20317 \begin_inset Flex Code
20320 \begin_layout Plain Layout
20321 FixedWidthPreambleEncoding
20327 \begin_inset Flex Code
20330 \begin_layout Plain Layout
20339 \begin_inset space \thinspace{}
20343 \begin_inset Flex Code
20346 \begin_layout Plain Layout
20352 ] Force a fixed width encoding for the translated contents of
20353 \begin_inset Flex Code
20356 \begin_layout Plain Layout
20363 \begin_inset Flex Code
20366 \begin_layout Plain Layout
20372 code generated by this layout.
20373 This is needed for special \SpecialChar LaTeX
20378 that do not work with variable width encodings such as
20383 This setting is ignored if fully Unicode aware \SpecialChar LaTeX
20384 backends such as Xe\SpecialChar TeX
20386 Lua\SpecialChar TeX
20390 \begin_layout Description
20391 \begin_inset Flex Code
20394 \begin_layout Plain Layout
20395 ForceLocalFontSwitch
20401 \begin_inset Flex Code
20404 \begin_layout Plain Layout
20413 \begin_inset space \thinspace{}
20417 \begin_inset Flex Code
20420 \begin_layout Plain Layout
20426 ] When using babel, always use a local font switch (
20427 \begin_inset Flex Code
20430 \begin_layout Plain Layout
20438 ), never a global one (such as
20439 \begin_inset Flex Code
20442 \begin_layout Plain Layout
20453 \begin_layout Description
20454 \begin_inset Flex Code
20457 \begin_layout Plain Layout
20464 \begin_inset Flex Code
20467 \begin_layout Plain Layout
20476 \begin_inset space \thinspace{}
20480 \begin_inset Flex Code
20483 \begin_layout Plain Layout
20490 \begin_inset Quotes eld
20494 \begin_inset Quotes erd
20497 language, leading to Left-to-Right (Latin) output, e.
20498 \begin_inset space \thinspace{}
20502 \begin_inset space \space{}
20505 in \SpecialChar TeX
20510 \begin_layout Description
20511 \begin_inset Flex Code
20514 \begin_layout Plain Layout
20521 \begin_inset Flex Code
20524 \begin_layout Plain Layout
20533 \begin_inset space \thinspace{}
20537 \begin_inset Flex Code
20540 \begin_layout Plain Layout
20546 ] Force a a line break in the \SpecialChar LaTeX
20547 output before the inset starts and after
20549 This assures the inset itself is output on its own lines, for parsing purposes.
20552 \begin_layout Description
20553 \begin_inset Flex Code
20556 \begin_layout Plain Layout
20563 \begin_inset Flex Code
20566 \begin_layout Plain Layout
20575 \begin_inset space \thinspace{}
20579 \begin_inset Flex Code
20582 \begin_layout Plain Layout
20588 ] Indicates whether the
20589 \begin_inset Flex Code
20592 \begin_layout Plain Layout
20598 should be used or, instead, the user can change the paragraph style used
20603 \begin_layout Description
20604 \begin_inset Flex Code
20607 \begin_layout Plain Layout
20614 \begin_inset Flex Code
20617 \begin_layout Plain Layout
20626 \begin_inset space \thinspace{}
20630 \begin_inset Flex Code
20633 \begin_layout Plain Layout
20639 ] As with paragraph styles, see
20640 \begin_inset CommandInset ref
20642 reference "subsec:Paragraph-Styles"
20649 \begin_layout Description
20650 \begin_inset Flex Code
20653 \begin_layout Plain Layout
20659 These tags control the XHTML output.
20661 \begin_inset CommandInset ref
20663 reference "sec:Tags-for-XHTML"
20670 \begin_layout Description
20671 \begin_inset Flex Code
20674 \begin_layout Plain Layout
20681 \begin_inset Flex Code
20684 \begin_layout Plain Layout
20693 \begin_inset space \thinspace{}
20697 \begin_inset Flex Code
20700 \begin_layout Plain Layout
20706 ] Whether to include the contents of this inset in the strings generated
20707 for the `Outline' pane for all table of contents, regardless of the AddToToc
20709 One would not, for example, want the content of a footnote in a section
20710 header to be included in the TOC displayed in the outline, but one would
20711 normally want the content of a character style displayed.
20712 Default is false: not to include.
20715 \begin_layout Description
20716 \begin_inset Flex Code
20719 \begin_layout Plain Layout
20726 \begin_inset Flex Code
20729 \begin_layout Plain Layout
20738 \begin_inset space \thinspace{}
20742 \begin_inset Flex Code
20745 \begin_layout Plain Layout
20751 ] If this is set to 1 and AddToToc is enabled, the inset adds a summary
20752 of its contents in its item in the table of contents.
20753 Otherwise, only the label appears.
20756 \begin_layout Description
20757 \begin_inset Flex Code
20760 \begin_layout Plain Layout
20769 \begin_inset Flex Code
20772 \begin_layout Plain Layout
20781 \begin_inset space \thinspace{}
20785 \begin_inset Flex Code
20788 \begin_layout Plain Layout
20794 ] As with paragraph styles, see
20795 \begin_inset CommandInset ref
20797 reference "subsec:Paragraph-Styles"
20804 \begin_layout Description
20805 \begin_inset Flex Code
20808 \begin_layout Plain Layout
20814 The font used for the label.
20816 \begin_inset CommandInset ref
20818 reference "subsec:Font-description"
20823 Note that this definition can never appear before
20824 \begin_inset Flex Code
20827 \begin_layout Plain Layout
20833 , lest it be ineffective.
20836 \begin_layout Description
20837 \begin_inset Flex Code
20840 \begin_layout Plain Layout
20847 \begin_inset Flex Code
20850 \begin_layout Plain Layout
20857 \begin_inset Quotes erd
20861 \begin_inset Quotes erd
20864 ] What will be displayed on the button or elsewhere as the inset label.
20866 \begin_inset Flex Code
20869 \begin_layout Plain Layout
20877 \begin_inset Flex Code
20880 \begin_layout Plain Layout
20886 ) modify this label on the fly.
20889 \begin_layout Description
20890 \begin_inset Flex Code
20893 \begin_layout Plain Layout
20899 Language dependent preamble; see
20900 \begin_inset CommandInset ref
20902 reference "subsec:I18n"
20909 \begin_layout Description
20910 \begin_inset Flex Code
20913 \begin_layout Plain Layout
20920 \begin_inset Flex Code
20923 \begin_layout Plain Layout
20929 ] The name of the corresponding \SpecialChar LaTeX
20931 Either the environment or command name.
20934 \begin_layout Description
20935 \begin_inset Flex Code
20938 \begin_layout Plain Layout
20945 \begin_inset Flex Code
20948 \begin_layout Plain Layout
20954 ] The optional parameter for the corresponding
20955 \begin_inset Flex Code
20958 \begin_layout Plain Layout
20964 stuff, including possible bracket pairs like
20965 \begin_inset Flex Code
20968 \begin_layout Plain Layout
20975 This parameter cannot be changed from within \SpecialChar LyX
20977 \begin_inset Flex Code
20980 \begin_layout Plain Layout
20986 for customizable parameters).
20987 It will be output as is after all \SpecialChar LaTeX
20989 \begin_inset Flex Code
20992 \begin_layout Plain Layout
21001 \begin_layout Description
21002 \begin_inset Flex Code
21005 \begin_layout Plain Layout
21012 \begin_inset Flex Code
21015 \begin_layout Plain Layout
21016 Command, Environment, None
21021 ] How the style should be translated into \SpecialChar LaTeX
21026 \begin_layout Plain Layout
21027 \begin_inset Flex Code
21030 \begin_layout Plain Layout
21036 is perhaps a bit misleading, since these rules apply to SGML classes too.
21037 Visit the SGML class files for specific examples.
21046 \begin_layout Description
21047 \begin_inset Flex Code
21050 \begin_layout Plain Layout
21056 means nothing special
21059 \begin_layout Description
21060 \begin_inset Flex Code
21063 \begin_layout Plain Layout
21070 \begin_inset Flex Code
21073 \begin_layout Plain Layout
21080 {\SpecialChar ldots
21089 \begin_layout Description
21090 \begin_inset Flex Code
21093 \begin_layout Plain Layout
21100 \begin_inset Flex Code
21103 \begin_layout Plain Layout
21110 }\SpecialChar ldots
21125 \begin_layout Standard
21126 Putting the last few things together, the \SpecialChar LaTeX
21127 output will be either:
21130 \begin_layout LyX-Code
21133 LatexName[LatexParam]{\SpecialChar ldots
21137 \begin_layout Standard
21141 \begin_layout LyX-Code
21144 begin{LatexName}[LatexParam] \SpecialChar ldots
21150 \begin_layout Standard
21151 depending upon the \SpecialChar LaTeX
21156 \begin_layout Description
21157 \begin_inset Flex Code
21160 \begin_layout Plain Layout
21167 \begin_inset Flex Code
21170 \begin_layout Plain Layout
21176 ] A string that is put at the beginning of the layout content.
21177 A line break in the output can be indicated by
21178 \begin_inset Flex Code
21181 \begin_layout Plain Layout
21190 \begin_layout Description
21191 \begin_inset Flex Code
21194 \begin_layout Plain Layout
21201 \begin_inset Flex Code
21204 \begin_layout Plain Layout
21211 \begin_inset Flex Code
21214 \begin_layout Plain Layout
21221 \begin_inset Flex Code
21224 \begin_layout Plain Layout
21231 \begin_inset Flex Code
21234 \begin_layout Plain Layout
21240 (indicating a dummy definition ending definitions of charstyles, etc).
21241 This entry is required in and is only meaningful for Flex insets.
21242 Among other things, it determines on which menu this inset will appear.
21244 \begin_inset Flex Code
21247 \begin_layout Plain Layout
21254 \begin_inset Flex Code
21257 \begin_layout Plain Layout
21263 will automatically set
21264 \begin_inset Flex Code
21267 \begin_layout Plain Layout
21274 \begin_inset Flex Code
21277 \begin_layout Plain Layout
21285 \begin_inset Flex Code
21288 \begin_layout Plain Layout
21294 can be set to true, or
21295 \begin_inset Flex Code
21298 \begin_layout Plain Layout
21305 \begin_inset Flex Code
21308 \begin_layout Plain Layout
21314 insets by setting it
21319 \begin_inset Flex Code
21322 \begin_layout Plain Layout
21329 \change_inserted -712698321 1555575738
21333 \begin_layout Description
21335 \change_inserted -712698321 1555575844
21336 \begin_inset Flex Code
21339 \begin_layout Plain Layout
21341 \change_inserted -712698321 1555575740
21350 \begin_inset Flex Code
21353 \begin_layout Plain Layout
21355 \change_inserted -712698321 1555575740
21363 A dedicated string for the menu.
21364 You can define an accelerator by appending the respective character to
21365 the string, divided by
21366 \begin_inset Quotes eld
21370 \begin_inset Quotes erd
21374 \begin_inset space \thinspace{}
21378 \begin_inset space \space{}
21382 \begin_inset Quotes eld
21386 \begin_inset Flex Code
21389 \begin_layout Plain Layout
21391 \change_inserted -712698321 1555575781
21400 \begin_inset Quotes erd
21404 This specification is optional.
21405 If it is not given the inset name as specified in the type declaration
21406 will be used instead for the menu.
21411 \begin_layout Description
21412 \begin_inset Flex Code
21415 \begin_layout Plain Layout
21422 \begin_inset Flex Code
21425 \begin_layout Plain Layout
21434 \begin_inset space \thinspace{}
21438 \begin_inset Flex Code
21441 \begin_layout Plain Layout
21447 ] Whether multiple paragraphs are permitted in this inset.
21449 \begin_inset Flex Code
21452 \begin_layout Plain Layout
21458 to the same value and
21459 \begin_inset Flex Code
21462 \begin_layout Plain Layout
21468 to the opposite value.
21469 These can be reset to other values, if they are used
21474 \begin_inset Flex Code
21477 \begin_layout Plain Layout
21487 \begin_layout Description
21488 \begin_inset Flex Code
21491 \begin_layout Plain Layout
21498 \begin_inset Flex Code
21501 \begin_layout Plain Layout
21510 \begin_inset space \thinspace{}
21514 \begin_inset Flex Code
21517 \begin_layout Plain Layout
21523 ] Whether fragile commands in this inset should be
21524 \begin_inset Flex Code
21527 \begin_layout Plain Layout
21540 whether the command should itself be protected.) Default is false.
21541 \change_inserted -712698321 1523633958
21545 \begin_layout Description
21547 \change_inserted -712698321 1552395786
21548 \begin_inset Flex Code
21551 \begin_layout Plain Layout
21553 \change_inserted -712698321 1523633961
21562 \begin_inset Flex Code
21565 \begin_layout Plain Layout
21567 \change_inserted -712698321 1523633958
21578 \begin_inset space \thinspace{}
21582 \begin_inset Flex Code
21585 \begin_layout Plain Layout
21587 \change_inserted -712698321 1523633958
21595 ] This causes macros that contain this inset to be protected with
21596 \begin_inset Flex Code
21599 \begin_layout Plain Layout
21601 \change_inserted -712698321 1523634038
21616 ) if necessary and thus allows (some) verbatim stuff in macros.
21620 \begin_layout Description
21622 \change_inserted -712698321 1555579651
21623 \begin_inset Flex Code
21626 \begin_layout Plain Layout
21628 \change_inserted -712698321 1552395787
21637 \begin_inset Flex Code
21640 \begin_layout Plain Layout
21642 \change_inserted -712698321 1552395787
21653 \begin_inset space \thinspace{}
21657 \begin_inset Flex Code
21660 \begin_layout Plain Layout
21662 \change_inserted -712698321 1552395787
21670 ] Whether specific commands in this inset (such as
21671 \begin_inset Flex Code
21674 \begin_layout Plain Layout
21676 \change_inserted -712698321 1552395787
21687 \begin_inset Flex Code
21690 \begin_layout Plain Layout
21692 \change_inserted -712698321 1552395787
21702 ) should be protected in an
21703 \begin_inset Flex Code
21706 \begin_layout Plain Layout
21708 \change_inserted -712698321 1552395787
21719 This is particularly needed for insets that draw on
21727 commands which parse their content in complex ways.
21731 \begin_layout Description
21733 \change_inserted -712698321 1555579742
21734 \begin_inset Flex Code
21737 \begin_layout Plain Layout
21739 \change_inserted -712698321 1555579658
21748 \begin_inset Flex Code
21751 \begin_layout Plain Layout
21753 \change_inserted -712698321 1555579651
21761 Option to define a different command (from the default
21762 \begin_inset Flex Code
21765 \begin_layout Plain Layout
21767 \change_inserted -712698321 1555579742
21779 ) to be used for line breaks.
21780 The initial backslash must not be specified.
21785 \begin_layout Description
21786 \begin_inset Flex Code
21789 \begin_layout Plain Layout
21796 \begin_inset Flex Code
21799 \begin_layout Plain Layout
21805 ] Deletes an existing
21806 \begin_inset Flex Code
21809 \begin_layout Plain Layout
21818 \begin_layout Description
21819 \begin_inset Flex Code
21822 \begin_layout Plain Layout
21829 \begin_inset Flex Code
21832 \begin_layout Plain Layout
21839 \begin_inset Flex Code
21842 \begin_layout Plain Layout
21848 that has replaced this
21849 \begin_inset Flex Code
21852 \begin_layout Plain Layout
21859 This is used to rename an
21860 \begin_inset Flex Code
21863 \begin_layout Plain Layout
21869 , while keeping backward compatibility.
21870 \change_inserted -712698321 1559491850
21874 \begin_layout Description
21876 \change_inserted -712698321 1559492002
21877 \begin_inset Flex Code
21880 \begin_layout Plain Layout
21882 \change_inserted -712698321 1559491854
21891 \begin_inset Flex Code
21894 \begin_layout Plain Layout
21896 \change_inserted -712698321 1559491850
21907 \begin_inset space \thinspace{}
21911 \begin_inset Flex Code
21914 \begin_layout Plain Layout
21916 \change_inserted -712698321 1559491850
21924 ] If this is set to
21925 \begin_inset Flex Code
21928 \begin_layout Plain Layout
21930 \change_inserted -712698321 1559491881
21938 , paragraph breaks will be ignored in the output.
21939 This might be useful for insets where the content should be alignable on
21940 different lines only in the \SpecialChar LyX
21941 workarea, without any effect in the output.
21946 \begin_layout Description
21947 \begin_inset Flex Code
21950 \begin_layout Plain Layout
21957 \begin_inset Flex Code
21960 \begin_layout Plain Layout
21969 \begin_inset space \thinspace{}
21973 \begin_inset Flex Code
21976 \begin_layout Plain Layout
21982 ] As with paragraph styles, see
21983 \begin_inset CommandInset ref
21985 reference "subsec:Paragraph-Styles"
21993 \begin_layout Description
21994 \begin_inset Flex Code
21997 \begin_layout Plain Layout
22004 \begin_inset Flex Code
22007 \begin_layout Plain Layout
22016 \begin_inset space \thinspace{}
22020 \begin_inset Flex Code
22023 \begin_layout Plain Layout
22029 ] As with paragraph styles, see
22030 \begin_inset CommandInset ref
22032 reference "subsec:Paragraph-Styles"
22040 \begin_layout Description
22041 \begin_inset Flex Code
22044 \begin_layout Plain Layout
22050 As with paragraph styles, see
22051 \begin_inset CommandInset ref
22053 reference "subsec:Paragraph-Styles"
22060 \begin_layout Description
22061 \begin_inset Flex Code
22064 \begin_layout Plain Layout
22071 \begin_inset Flex Code
22074 \begin_layout Plain Layout
22080 ] The prefix to use when creating labels referring to insets of this type.
22081 This allows the use of formatted references.
22084 \begin_layout Description
22085 \begin_inset Flex Code
22088 \begin_layout Plain Layout
22095 \begin_inset Flex Code
22098 \begin_layout Plain Layout
22104 ] As with paragraph styles, see
22105 \begin_inset CommandInset ref
22107 reference "subsec:Paragraph-Styles"
22114 \begin_layout Description
22115 \begin_inset Flex Code
22118 \begin_layout Plain Layout
22125 \begin_inset Flex Code
22128 \begin_layout Plain Layout
22137 \begin_inset space \thinspace{}
22141 \begin_inset Flex Code
22144 \begin_layout Plain Layout
22150 ] Resets the \SpecialChar LaTeX
22151 arguments of this layout (as defined via the
22152 \begin_inset Flex Code
22155 \begin_layout Plain Layout
22162 This is useful if you have copied a style via
22163 \begin_inset Flex Code
22166 \begin_layout Plain Layout
22172 , but you do not want to inherit its (required and optional) arguments.
22175 \begin_layout Description
22176 \begin_inset Flex Code
22179 \begin_layout Plain Layout
22186 \begin_inset Flex Code
22189 \begin_layout Plain Layout
22198 \begin_inset space \thinspace{}
22202 \begin_inset Flex Code
22205 \begin_layout Plain Layout
22212 \change_inserted -712698321 1597733473
22214 \begin_inset Flex Code
22217 \begin_layout Plain Layout
22219 \change_inserted -712698321 1597732178
22227 , font changes are redone inside the respective inset (in the output) even
22228 if the inset itself is in the context of this font changes (e.
22229 \begin_inset space \thinspace{}
22233 \begin_inset Flex Code
22236 \begin_layout Plain Layout
22238 \change_inserted -712698321 1597733683
22241 textbf{Sourrounding text
22245 textbf{content}}\SpecialChar ldots
22254 \begin_inset Flex Code
22257 \begin_layout Plain Layout
22259 \change_inserted -712698321 1597733686
22262 textbf{Sourrounding text
22264 myinset{content}\SpecialChar ldots
22273 Setting this makes sense for commands that internally reset font settings
22275 \begin_inset space \thinspace{}
22279 Note that wrongly setting this might lead to unwanted result (e.
22280 \begin_inset space \thinspace{}
22284 \begin_inset Flex Code
22287 \begin_layout Plain Layout
22289 \change_inserted -712698321 1597733688
22292 emph{Sourrounding text
22296 emph{content}}\SpecialChar ldots
22304 , content is upright, as
22305 \begin_inset Flex Code
22308 \begin_layout Plain Layout
22310 \change_inserted -712698321 1597733278
22322 \change_deleted -712698321 1597733283
22323 Whether this inset should use the font of its surrounding environment or
22328 \change_deleted -712698321 1597733290
22330 \change_inserted -712698321 1597733290
22332 \begin_inset Flex Code
22335 \begin_layout Plain Layout
22337 \change_inserted -712698321 1597733292
22348 \change_deleted -712698321 1597733327
22349 use the font of the surrounding environment
22350 \change_inserted -712698321 1597733343
22351 font changes are not redone inside the inset
22356 \begin_layout Description
22357 \begin_inset Flex Code
22360 \begin_layout Plain Layout
22367 \begin_inset Flex Code
22370 \begin_layout Plain Layout
22376 ] A string that is put at the end of the layout content.
22377 A line break in the output can be indicated by
22378 \begin_inset Flex Code
22381 \begin_layout Plain Layout
22390 \begin_layout Description
22391 \begin_inset Flex Code
22394 \begin_layout Plain Layout
22401 \begin_inset Flex Code
22404 \begin_layout Plain Layout
22411 \begin_inset space \thinspace{}
22415 \begin_inset Flex Code
22418 \begin_layout Plain Layout
22426 ] Allow spell-checking the contents of this inset.
22430 \begin_layout Subsection
22432 \begin_inset CommandInset label
22434 name "subsec:Counters"
22441 \begin_layout Standard
22442 It is necessary to define the counters (
22443 \begin_inset Flex Noun
22446 \begin_layout Plain Layout
22453 \begin_inset Flex Noun
22456 \begin_layout Plain Layout
22462 , \SpecialChar ldots
22463 ) in the text class itself.
22464 The standard counters are defined in the file
22465 \begin_inset Flex Code
22468 \begin_layout Plain Layout
22474 , so you may have to do no more than add
22477 \begin_layout LyX-Code
22478 Input stdcounters.inc
22481 \begin_layout Standard
22482 to your layout file to get them to work.
22483 But if you want to define custom counters, then you can do so.
22484 The counter declaration must begin with:
22487 \begin_layout LyX-Code
22488 Counter CounterName
22491 \begin_layout Standard
22493 \begin_inset Flex Code
22496 \begin_layout Plain Layout
22502 ' is replaced by the name of the counter.
22503 And it must end with
22504 \begin_inset Quotes eld
22508 \begin_inset Flex Code
22511 \begin_layout Plain Layout
22518 \begin_inset Quotes erd
22522 The following parameters can also be used:
22525 \begin_layout Description
22526 \begin_inset Flex Code
22529 \begin_layout Plain Layout
22536 \begin_inset Flex Code
22539 \begin_layout Plain Layout
22545 ] Sets the initial value for the counter, to which it will be reset whenever
22547 Normally, one will want the default, 1.
22550 \begin_layout Description
22551 \begin_inset Flex Code
22554 \begin_layout Plain Layout
22561 \begin_inset Flex Code
22564 \begin_layout Plain Layout
22571 \begin_inset Quotes erd
22575 \begin_inset Quotes erd
22578 ] When defined, this string defines how the counter is displayed.
22579 Setting this value sets
22580 \begin_inset Flex Code
22583 \begin_layout Plain Layout
22584 LabelStringAppendix
22590 The following special constructs can be used in the string:
22594 \begin_layout Itemize
22595 \begin_inset Flex Code
22598 \begin_layout Plain Layout
22606 will be replaced by the expansion of the
22607 \begin_inset Flex Code
22610 \begin_layout Plain Layout
22617 \begin_inset Flex Code
22620 \begin_layout Plain Layout
22621 LabelStringAppendix
22627 \begin_inset Flex Code
22630 \begin_layout Plain Layout
22640 \begin_layout Itemize
22641 counter values can be expressed using \SpecialChar LaTeX
22643 \begin_inset Newline newline
22647 \begin_inset Flex Code
22650 \begin_layout Plain Layout
22667 \begin_inset Flex Code
22670 \begin_layout Plain Layout
22682 \begin_layout Plain Layout
22692 Actually, the situation is a bit more complicated: any
22711 other than those described below will produce arabic numerals.
22712 It would not be surprising to see this change in the future.
22718 \begin_inset Flex Code
22721 \begin_layout Plain Layout
22727 : 1, 2, 3,\SpecialChar ldots
22729 \begin_inset Flex Code
22732 \begin_layout Plain Layout
22738 for lower-case letters: a, b, c, \SpecialChar ldots
22740 \begin_inset Flex Code
22743 \begin_layout Plain Layout
22749 for upper-case letters: A, B, C, \SpecialChar ldots
22751 \begin_inset Flex Code
22754 \begin_layout Plain Layout
22760 for lower-case roman numerals: i, ii, iii, \SpecialChar ldots
22762 \begin_inset Flex Code
22765 \begin_layout Plain Layout
22771 for upper-case roman numerals: I, II, III\SpecialChar ldots
22773 \begin_inset Flex Code
22776 \begin_layout Plain Layout
22782 for hebrew numerals.
22786 \begin_layout Standard
22787 If LabelString is not defined, a default value is constructed as follows:
22788 if the counter has a
22789 \change_deleted 731793113 1604355218
22791 \change_inserted 731793113 1604355221
22795 \begin_inset Flex Code
22798 \begin_layout Plain Layout
22800 \change_deleted 731793113 1604355223
22802 \change_inserted 731793113 1604355226
22811 \begin_inset Flex Code
22814 \begin_layout Plain Layout
22821 \begin_inset Newline newline
22825 \begin_inset Flex Code
22828 \begin_layout Plain Layout
22832 \change_inserted 731793113 1604355228
22834 \change_deleted 731793113 1604355230
22844 is used; otherwise the string
22845 \begin_inset Flex Code
22848 \begin_layout Plain Layout
22859 \begin_layout Description
22860 \begin_inset Flex Code
22863 \begin_layout Plain Layout
22864 LabelStringAppendix
22870 \begin_inset Flex Code
22873 \begin_layout Plain Layout
22880 \begin_inset Quotes erd
22884 \begin_inset Quotes erd
22888 \begin_inset Flex Code
22891 \begin_layout Plain Layout
22897 , but for use in the Appendix.
22900 \begin_layout Description
22901 \begin_inset Flex Code
22904 \begin_layout Plain Layout
22911 \begin_inset Flex Code
22914 \begin_layout Plain Layout
22921 \begin_inset Quotes erd
22925 \begin_inset Quotes erd
22928 ] A format for use with formatted references to this counter.
22929 For example, one might want to have references to section numbers appear
22931 \begin_inset Quotes eld
22935 \begin_inset Quotes erd
22939 The string should contain
22940 \begin_inset Quotes eld
22944 \begin_inset Quotes erd
22948 This will be replaced by the counter number itself.
22949 So, for sections, it would be: Section ##.
22952 \begin_layout Description
22953 \begin_inset Flex Code
22956 \begin_layout Plain Layout
22963 \begin_inset Flex Code
22966 \begin_layout Plain Layout
22973 \begin_inset Quotes erd
22977 \begin_inset Quotes erd
22980 ] If this is set to the name of another counter, the present counter will
22981 be reset every time the other one is increased.
22983 \begin_inset Flex Code
22986 \begin_layout Plain Layout
22993 \begin_inset Flex Code
22996 \begin_layout Plain Layout
23005 \begin_layout Subsection
23007 \begin_inset CommandInset label
23009 name "subsec:Font-description"
23016 \begin_layout Standard
23017 A font description looks like this:
23020 \begin_layout LyX-Code
23037 \begin_layout LyX-Code
23041 \begin_layout LyX-Code
23045 \begin_layout Standard
23046 The following commands are available:
23049 \begin_layout Description
23050 \begin_inset Flex Code
23053 \begin_layout Plain Layout
23060 \begin_inset Flex Code
23063 \begin_layout Plain Layout
23072 \begin_inset Flex Code
23075 \begin_layout Plain Layout
23082 \begin_inset Flex Code
23085 \begin_layout Plain Layout
23092 \begin_inset Flex Code
23095 \begin_layout Plain Layout
23102 \begin_inset Flex Code
23105 \begin_layout Plain Layout
23112 \begin_inset Flex Code
23115 \begin_layout Plain Layout
23122 \begin_inset Flex Code
23125 \begin_layout Plain Layout
23132 \begin_inset Flex Code
23135 \begin_layout Plain Layout
23142 \begin_inset Flex Code
23145 \begin_layout Plain Layout
23152 \begin_inset Flex Code
23155 \begin_layout Plain Layout
23162 \begin_inset Flex Code
23165 \begin_layout Plain Layout
23172 \begin_inset Flex Code
23175 \begin_layout Plain Layout
23182 \begin_inset Flex Code
23185 \begin_layout Plain Layout
23192 \begin_inset Flex Code
23195 \begin_layout Plain Layout
23202 \begin_inset Flex Code
23205 \begin_layout Plain Layout
23212 \begin_inset Flex Code
23215 \begin_layout Plain Layout
23222 \begin_inset Flex Code
23225 \begin_layout Plain Layout
23232 \begin_inset Flex Code
23235 \begin_layout Plain Layout
23242 \begin_inset Flex Code
23245 \begin_layout Plain Layout
23252 \begin_inset Flex Code
23255 \begin_layout Plain Layout
23264 \begin_layout Description
23265 \begin_inset Flex Code
23268 \begin_layout Plain Layout
23275 \begin_inset Flex Code
23278 \begin_layout Plain Layout
23287 \begin_inset Flex Code
23290 \begin_layout Plain Layout
23297 \begin_inset Flex Code
23300 \begin_layout Plain Layout
23309 \begin_layout Description
23310 \begin_inset Flex Code
23313 \begin_layout Plain Layout
23320 \begin_inset Flex Code
23323 \begin_layout Plain Layout
23329 ] Valid arguments are:
23330 \begin_inset Flex Code
23333 \begin_layout Plain Layout
23340 \begin_inset Flex Code
23343 \begin_layout Plain Layout
23350 \begin_inset Flex Code
23353 \begin_layout Plain Layout
23360 \begin_inset Flex Code
23363 \begin_layout Plain Layout
23370 \begin_inset Flex Code
23373 \begin_layout Plain Layout
23380 \begin_inset Flex Code
23383 \begin_layout Plain Layout
23390 \begin_inset Flex Code
23393 \begin_layout Plain Layout
23400 \begin_inset Flex Code
23403 \begin_layout Plain Layout
23410 \begin_inset Flex Code
23413 \begin_layout Plain Layout
23420 \begin_inset Flex Code
23423 \begin_layout Plain Layout
23430 \begin_inset Flex Code
23433 \begin_layout Plain Layout
23440 \begin_inset Flex Code
23443 \begin_layout Plain Layout
23450 Each of these turns on or off the corresponding attribute.
23452 \begin_inset Flex Code
23455 \begin_layout Plain Layout
23461 turns on emphasis, and
23462 \begin_inset Flex Code
23465 \begin_layout Plain Layout
23473 \begin_inset Newline newline
23476 If the latter seems puzzling, remember that the font settings for the present
23477 context are generally inherited from the surrounding context.
23479 \begin_inset Flex Code
23482 \begin_layout Plain Layout
23488 would turn off the emphasis that was anyway in effect, say, in a theorem
23492 \begin_layout Description
23493 \begin_inset Flex Code
23496 \begin_layout Plain Layout
23503 \begin_inset Flex Code
23506 \begin_layout Plain Layout
23515 \begin_inset Flex Code
23518 \begin_layout Plain Layout
23527 \begin_layout Description
23528 \begin_inset Flex Code
23531 \begin_layout Plain Layout
23538 \begin_inset Flex Code
23541 \begin_layout Plain Layout
23550 \begin_inset Flex Code
23553 \begin_layout Plain Layout
23560 \begin_inset Flex Code
23563 \begin_layout Plain Layout
23570 \begin_inset Flex Code
23573 \begin_layout Plain Layout
23582 \begin_layout Description
23583 \begin_inset Flex Code
23586 \begin_layout Plain Layout
23593 \begin_inset Flex Code
23596 \begin_layout Plain Layout
23603 \begin_inset Flex Code
23606 \begin_layout Plain Layout
23613 \begin_inset Flex Code
23616 \begin_layout Plain Layout
23625 \begin_inset Flex Code
23628 \begin_layout Plain Layout
23635 \begin_inset Flex Code
23638 \begin_layout Plain Layout
23645 \begin_inset Flex Code
23648 \begin_layout Plain Layout
23655 \begin_inset Flex Code
23658 \begin_layout Plain Layout
23665 \begin_inset Flex Code
23668 \begin_layout Plain Layout
23677 \begin_layout Subsection
23678 \begin_inset CommandInset label
23680 name "subsec:Citation-engine-description"
23684 Cite engine description
23687 \begin_layout Standard
23689 \begin_inset Flex Code
23692 \begin_layout Plain Layout
23698 blocks, as used mainly in cite engine files (see
23699 \begin_inset CommandInset ref
23701 reference "subsec:Cite-Engine-Files"
23708 ), define the citation commands provided by a specific
23709 \begin_inset Quotes eld
23713 \begin_inset Quotes erd
23717 A cite engine, in \SpecialChar LyX
23718 terms, is way specific way to format citations, using
23719 numbers, author names and/or years.
23720 Currently, \SpecialChar LyX
23721 supports three such engine types, namely:
23724 \begin_layout Enumerate
23725 \begin_inset Flex Code
23728 \begin_layout Plain Layout
23734 : the default Bib\SpecialChar TeX
23735 way to format citations, a simple numeric style (e.
23736 \begin_inset space \thinspace{}
23740 \begin_inset Quotes eld
23744 \begin_inset Quotes erd
23750 \begin_layout Enumerate
23751 \begin_inset Flex Code
23754 \begin_layout Plain Layout
23760 : Harvard-styled citations using author names and publication year (e.
23761 \begin_inset space \thinspace{}
23765 \begin_inset Quotes eld
23768 Smith and Miller (2017b)
23769 \begin_inset Quotes erd
23775 \begin_layout Enumerate
23776 \begin_inset Flex Code
23779 \begin_layout Plain Layout
23785 : extended numerical citations that also allow for author or title next
23787 \begin_inset space \thinspace{}
23791 \begin_inset Quotes eld
23794 Smith and Miller [1]
23795 \begin_inset Quotes erd
23801 \begin_layout Standard
23802 \begin_inset Flex Code
23805 \begin_layout Plain Layout
23811 blocks look like this:
23814 \begin_layout LyX-Code
23818 \begin_layout LyX-Code
23822 \begin_layout LyX-Code
23826 \begin_layout LyX-Code
23827 citeyearpar[][]=parencite*
23830 \begin_layout LyX-Code
23834 \begin_layout LyX-Code
23838 \begin_layout Standard
23840 \begin_inset Flex Code
23843 \begin_layout Plain Layout
23849 denotes the engine.
23850 The individual lines respectively define a cite command or cite command
23851 paradigm supported by this engine.
23852 The line can be as simple as a cite command that is used both to name the
23853 respective \SpecialChar LyX
23854 command and the \SpecialChar LaTeX
23855 output or more complex in order to differentiate
23857 The full syntax is:
23860 \begin_layout LyX-Code
23861 LyXName|alias$*<!_stardesc!_stardesctooltip>[][]=latexcmd
23864 \begin_layout Itemize
23865 \begin_inset Flex Code
23868 \begin_layout Plain Layout
23874 : The name as used in the
23875 \begin_inset Flex Code
23878 \begin_layout Plain Layout
23888 \begin_layout Standard
23889 For portability reasons, we try to use the same name for same-formatted
23890 commands in different cite packages (thus many names stem from natbib,
23891 and thus we need to differentiate a
23892 \begin_inset Flex Code
23895 \begin_layout Plain Layout
23901 sometimes, if the \SpecialChar LaTeX
23902 command names differ).
23906 \begin_layout Itemize
23907 \begin_inset Flex Code
23910 \begin_layout Plain Layout
23916 : a (comma-separated) list of commands that fall back to the given
23917 \begin_inset Flex Code
23920 \begin_layout Plain Layout
23926 in the current engine.
23927 This eases the switch of citation packages and engines.
23929 \begin_inset Flex Code
23932 \begin_layout Plain Layout
23939 \begin_inset Flex Code
23942 \begin_layout Plain Layout
23948 in layout definitions.
23951 \begin_layout Itemize
23952 \begin_inset Flex Code
23955 \begin_layout Plain Layout
23961 : The actual \SpecialChar LaTeX
23962 command that is output.
23966 \begin_layout Standard
23967 \begin_inset Flex Code
23970 \begin_layout Plain Layout
23977 \begin_inset Flex Code
23980 \begin_layout Plain Layout
23988 \begin_inset Flex Code
23991 \begin_layout Plain Layout
23998 \begin_inset Flex Code
24001 \begin_layout Plain Layout
24007 will be output to \SpecialChar LaTeX
24011 \begin_layout Standard
24015 \begin_layout Itemize
24016 Capitalization indicates that the command also has a capitalized form (
24017 \begin_inset Flex Code
24020 \begin_layout Plain Layout
24030 \begin_inset Flex Code
24033 \begin_layout Plain Layout
24042 These usually enforce up-casing of name prefixes (
24047 \begin_inset Formula $\Rightarrow$
24057 \begin_layout Itemize
24059 \begin_inset Flex Code
24062 \begin_layout Plain Layout
24068 indicate the number of optional arguments (there can be 0–2).
24071 \begin_layout Itemize
24073 \begin_inset Flex Code
24076 \begin_layout Plain Layout
24082 indicates there is a starred version of the command (
24083 \begin_inset Flex Code
24086 \begin_layout Plain Layout
24096 \begin_inset Flex Code
24099 \begin_layout Plain Layout
24112 \begin_layout Standard
24113 By default, the starred version means: Output all authors even if it should
24115 \begin_inset Quotes eld
24119 \begin_inset Quotes erd
24123 \begin_inset Flex Code
24126 \begin_layout Plain Layout
24135 \begin_layout Standard
24136 If the star has a different meaning for a given command, it can be specified
24138 \begin_inset Flex Code
24141 \begin_layout Plain Layout
24142 <!_stardesc!_stardesctooltip>
24148 Maximal two translatable macro keywords, marked by the prefix
24149 \begin_inset Flex Code
24152 \begin_layout Plain Layout
24159 The first points to the string that replaces the
24160 \begin_inset Quotes eld
24164 \begin_inset Quotes erd
24167 checkbox label in the citation dialog, the second one to an optional tool
24168 tip for this checkbox.
24172 \begin_layout Standard
24173 Note that these two macros have to be defined in a
24174 \begin_inset Flex Code
24177 \begin_layout Plain Layout
24183 (see next section), dropping the
24184 \begin_inset Flex Code
24187 \begin_layout Plain Layout
24193 from the prefix, like this:
24196 \begin_layout LyX-Code
24197 _stardesc Sta&rred command label
24200 \begin_layout LyX-Code
24201 _stardesctooltip Tooltip for the starred command checkbox.
24205 \begin_layout Itemize
24207 \begin_inset Flex Code
24210 \begin_layout Plain Layout
24216 indicates that this command features
24217 \begin_inset Quotes eld
24220 qualified citation lists
24221 \begin_inset Quotes erd
24229 -specific feature for multi-reference citations where an individual pre-
24230 and postnote can be given to each reference in the list.
24231 Please refer to the
24235 manual for details.
24236 \change_inserted -712698321 1526898670
24240 \begin_layout Standard
24242 \change_inserted -712698321 1526899524
24243 If you want to add a cite command to a cite engine (e.
24244 \begin_inset space \thinspace{}
24247 g., add a specific command provided by a class), you can use
24248 \begin_inset Flex Code
24251 \begin_layout Plain Layout
24253 \change_inserted -712698321 1526898768
24254 AddToCiteEngine <engine type> \SpecialChar ldots
24263 Note that only cite commands that do not exist yet are added.
24268 \begin_layout Subsection
24269 \begin_inset CommandInset label
24271 name "subsec:Citation-format-description"
24275 Cite format description
24278 \begin_layout Standard
24280 \begin_inset Flex Code
24283 \begin_layout Plain Layout
24289 blocks are used to describe how bibliographic information should be displayed,
24290 both within \SpecialChar LyX
24291 itself (in the citation dialog and in tooltips, for example)
24292 and in XHTML output.
24293 Such a block might look like this:
24296 \begin_layout LyX-Code
24300 \begin_layout LyX-Code
24304 \begin_layout LyX-Code
24308 \begin_layout LyX-Code
24312 \begin_layout Standard
24316 \begin_layout LyX-Code
24320 \begin_layout LyX-Code
24324 \begin_layout LyX-Code
24328 \begin_layout LyX-Code
24332 \begin_layout Standard
24333 In the first case, the individual lines define how the bibliographic information
24334 associated with an article or book, respectively, is to be displayed, and
24335 such a definition can be given for any
24336 \begin_inset Quotes els
24340 \begin_inset Quotes ers
24343 that might be present in a Bib\SpecialChar TeX
24346 defines a default format in the source code that will be used if no specific
24347 definition has been given.
24349 predefines several formats in the file
24350 \begin_inset Flex Code
24353 \begin_layout Plain Layout
24359 , which is included in most of \SpecialChar LyX
24360 's document classes.
24363 \begin_layout Standard
24364 In the second case, the lines define how a specific citation command (in
24366 \begin_inset Flex Code
24369 \begin_layout Plain Layout
24378 \begin_inset Flex Code
24381 \begin_layout Plain Layout
24389 ) is to be displayed on the citation inset label, in the citation dialog,
24390 menu or XHTML output.
24392 defines such formats for the citation style variants it supports via
24394 Document\SpecialChar menuseparator
24395 Setting\SpecialChar menuseparator
24396 Bibliography\SpecialChar ldots
24400 \begin_inset Flex Code
24403 \begin_layout Plain Layout
24409 files that are shipped with \SpecialChar LyX
24411 \begin_inset CommandInset ref
24413 reference "subsec:Cite-Engine-Files"
24423 \begin_layout Standard
24424 The definitions use a simple language that allows Bib\SpecialChar TeX
24425 keys to be replaced
24427 Keys should be enclosed in
24428 \begin_inset Flex Code
24431 \begin_layout Plain Layout
24438 \begin_inset Flex Code
24441 \begin_layout Plain Layout
24448 So a simple definition might look like this:
24451 \begin_layout LyX-Code
24453 \begin_inset Quotes eld
24457 \begin_inset Quotes erd
24463 \begin_layout Standard
24464 This would print the author, followed by a comma, followed by the title,
24465 in quotes, followed by a period.
24468 \begin_layout Standard
24469 Of course, sometimes you may want to print a key only if it exists.
24470 This can be done by using a conditional construction, such as:
24471 \begin_inset Flex Code
24474 \begin_layout Plain Layout
24476 \begin_inset space ~
24486 \begin_inset Flex Code
24489 \begin_layout Plain Layout
24495 key exists, then print
24496 \begin_inset Quotes eld
24500 \begin_inset space ~
24504 \begin_inset Quotes erd
24507 followed by the volume key.
24508 It is also possible to have an else clause in the conditional, such as:
24509 \begin_inset Newline newline
24513 \begin_inset Flex Code
24516 \begin_layout Plain Layout
24517 {%author%[[%author%]][[%editor%, ed.]]}
24523 \begin_inset Newline newline
24527 \begin_inset Flex Code
24530 \begin_layout Plain Layout
24536 key is printed if it exists; otherwise, the editor key is printed, followed
24538 \begin_inset Quotes eld
24542 \begin_inset space ~
24546 \begin_inset Quotes erd
24549 Note that the key is again enclosed in
24550 \begin_inset Flex Code
24553 \begin_layout Plain Layout
24559 signs; the entire conditional is enclosed in braces; and the if and else
24560 clauses are enclosed in double brackets,
24561 \begin_inset Quotes eld
24565 \begin_inset Flex Code
24568 \begin_layout Plain Layout
24575 \begin_inset Quotes eld
24579 \begin_inset Quotes eld
24583 \begin_inset Flex Code
24586 \begin_layout Plain Layout
24593 \begin_inset Quotes erd
24597 There must be no space between any of these.
24600 \begin_layout Standard
24601 Next to the entry keys, there are some special keys that can be used for
24602 these conditionals:
24605 \begin_layout Itemize
24606 \begin_inset Flex Code
24609 \begin_layout Plain Layout
24610 {%dialog%[[true]][[false]]}
24616 \begin_inset Quotes eld
24620 \begin_inset Quotes erd
24623 part for dialogs and menus, the
24624 \begin_inset Quotes eld
24628 \begin_inset Quotes erd
24631 part for other contexts (workarea, export)
24634 \begin_layout Itemize
24635 \begin_inset Flex Code
24638 \begin_layout Plain Layout
24639 {%export%[[true]][[false]]}
24645 \begin_inset Quotes eld
24649 \begin_inset Quotes erd
24652 part for export and menus, the
24653 \begin_inset Quotes eld
24657 \begin_inset Quotes erd
24660 part for other contexts (workarea, dialog)
24663 \begin_layout Itemize
24664 \begin_inset Flex Code
24667 \begin_layout Plain Layout
24674 \begin_inset Quotes eld
24678 \begin_inset Quotes erd
24681 part if another item follows (e.
24682 \begin_inset space \thinspace{}
24685 g., in a citation with multiple keys)
24688 \begin_layout Itemize
24689 \begin_inset Flex Code
24692 \begin_layout Plain Layout
24693 {%second%[[true]][[false]]}
24699 \begin_inset Quotes eld
24703 \begin_inset Quotes erd
24706 if this is the second of multiple items, else the
24707 \begin_inset Quotes eld
24711 \begin_inset Quotes erd
24717 \begin_layout Itemize
24718 \begin_inset Flex Code
24721 \begin_layout Plain Layout
24722 {%ifstar%[[true]][[false]]}
24728 \begin_inset Quotes eld
24732 \begin_inset Quotes erd
24735 part for starred citation commands (such as
24736 \begin_inset Flex Code
24739 \begin_layout Plain Layout
24747 ), the false part for unstarred
24750 \begin_layout Itemize
24751 \begin_inset Flex Code
24754 \begin_layout Plain Layout
24755 {%ifentrytype:<type>%[[true]][[false]]}
24761 \begin_inset Quotes eld
24765 \begin_inset Quotes erd
24768 if the current entry type matches
24769 \begin_inset Flex Code
24772 \begin_layout Plain Layout
24778 , else the false part (e.g., in a citation definition:
24779 \begin_inset Flex Code
24782 \begin_layout Plain Layout
24783 {%ifentrytype:book%[[this is a book]][[this is no book]]}
24791 \begin_layout Itemize
24792 \begin_inset Flex Code
24795 \begin_layout Plain Layout
24796 {%ifmultiple:<authortype>%[[true]][[false]]}
24802 \begin_inset Quotes eld
24806 \begin_inset Quotes erd
24809 if the current author type (author, editor etc.) has multiple authors, else
24810 the false part (e.g., in a bibliography definition:
24811 \begin_inset Flex Code
24814 \begin_layout Plain Layout
24815 {%ifmultiple:editor%[[eds.]][[ed.]]}
24823 \begin_layout Itemize
24824 \begin_inset Flex Code
24827 \begin_layout Plain Layout
24828 {%ifqualified%[[true]][[false]]}
24834 \begin_inset Quotes eld
24838 \begin_inset Quotes erd
24841 part if the current citation is a qualified citation list (a specific
24845 format for multi-reference citations), the false part if this is not the
24849 \begin_layout Standard
24851 \begin_inset Flex Code
24854 \begin_layout Plain Layout
24860 prints the author key as it is recorded in the bibliography file.
24861 This might not be what you want, since it will result in a string such
24863 \begin_inset Quotes eld
24866 Miller, Peter and Smith, Mary and White, Jane
24867 \begin_inset Quotes erd
24871 \begin_inset Quotes eld
24875 \begin_inset Quotes erd
24878 is used by Bib\SpecialChar TeX
24879 to delimit authors).
24881 therefore provides some methods to get properly formatted name lists (which
24882 will also get translated).
24883 The following keys are provided:
24886 \begin_layout Enumerate
24887 For name lists with pre- and surname, suitable for the main authors/editors
24888 of a bibliography item.
24890 \begin_inset Flex Code
24893 \begin_layout Plain Layout
24899 part denotes the kind of list that is requested (e.g.
24901 \begin_inset Flex Code
24904 \begin_layout Plain Layout
24914 \begin_layout Itemize
24915 \begin_inset Flex Code
24918 \begin_layout Plain Layout
24919 %abbrvnames:<nametype>%
24924 : Provides a name list which is abbreviated (with
24925 \begin_inset Quotes eld
24929 \begin_inset Quotes erd
24933 \begin_inset Flex Code
24936 \begin_layout Plain Layout
24945 \begin_layout Itemize
24946 \begin_inset Flex Code
24949 \begin_layout Plain Layout
24950 %fullnames:<nametype>%
24955 : Provides a full name list (never abbreviated with
24956 \begin_inset Quotes eld
24960 \begin_inset Quotes erd
24966 \begin_layout Itemize
24967 \begin_inset Flex Code
24970 \begin_layout Plain Layout
24971 %forceabbrvnames:<nametype>%
24976 : Provides a name list which is always abbreviated (with
24977 \begin_inset Quotes eld
24981 \begin_inset Quotes erd
24985 \begin_inset Flex Code
24988 \begin_layout Plain Layout
24998 \begin_layout Enumerate
24999 Alternative name lists with pre- and surname, if the order of pre- and surname
25000 inside the bibliography item differs (as in:
25001 \begin_inset Quotes eld
25004 Miller, John: Some text, in: Mary Smith, ed.: A volume
25005 \begin_inset Quotes erd
25012 \begin_layout Itemize
25013 \begin_inset Flex Code
25016 \begin_layout Plain Layout
25017 %abbrvbynames:<nametype>%
25022 : Provides a name list which is abbreviated (with
25023 \begin_inset Quotes eld
25027 \begin_inset Quotes erd
25031 \begin_inset Flex Code
25034 \begin_layout Plain Layout
25043 \begin_layout Itemize
25044 \begin_inset Flex Code
25047 \begin_layout Plain Layout
25048 %fullbynames:<nametype>%
25053 : Provides a full name list (never abbreviated with
25054 \begin_inset Quotes eld
25058 \begin_inset Quotes erd
25064 \begin_layout Itemize
25065 \begin_inset Flex Code
25068 \begin_layout Plain Layout
25069 %forceabbrvbynames:<nametype>%
25074 : Provides a name list which is always abbreviated (with
25075 \begin_inset Quotes eld
25079 \begin_inset Quotes erd
25083 \begin_inset Flex Code
25086 \begin_layout Plain Layout
25096 \begin_layout Enumerate
25097 And finally name lists which consist of family names only, as used in author-yea
25099 These do not take a
25100 \begin_inset Flex Code
25103 \begin_layout Plain Layout
25109 part, but always return either an author list or, if this does not exist,
25110 an editor list (as common in author-year labels):
25114 \begin_layout Itemize
25115 \begin_inset Flex Code
25118 \begin_layout Plain Layout
25124 : Provides a name list which is abbreviated (with
25125 \begin_inset Quotes eld
25129 \begin_inset Quotes erd
25133 \begin_inset Flex Code
25136 \begin_layout Plain Layout
25145 \begin_layout Itemize
25146 \begin_inset Flex Code
25149 \begin_layout Plain Layout
25155 : Provides a full name list (never abbreviated with
25156 \begin_inset Quotes eld
25160 \begin_inset Quotes erd
25166 \begin_layout Itemize
25167 \begin_inset Flex Code
25170 \begin_layout Plain Layout
25171 %forceabbrvciteauthor%
25176 : Provides a name list which is always abbreviated (with
25177 \begin_inset Quotes eld
25181 \begin_inset Quotes erd
25185 \begin_inset Flex Code
25188 \begin_layout Plain Layout
25198 \begin_layout Standard
25199 The order of pre- and surname in the former two lists can be adjusted by
25203 \begin_layout Itemize
25204 \begin_inset Flex Code
25207 \begin_layout Plain Layout
25208 !firstnameform %surname%, %prename%
25213 (first author in lists of type 1)
25216 \begin_layout Itemize
25217 \begin_inset Flex Code
25220 \begin_layout Plain Layout
25221 !othernameform %surname%, %prename%
25226 (other authors in lists of type 1)
25229 \begin_layout Itemize
25230 \begin_inset Flex Code
25233 \begin_layout Plain Layout
25234 !firstbynameform %prename% %surname%
25239 (first author in lists of type 2)
25242 \begin_layout Itemize
25243 \begin_inset Flex Code
25246 \begin_layout Plain Layout
25247 !otherbynameform %prename% %surname%
25252 (other authors in lists of type 2)
25255 \begin_layout Standard
25256 This allows you to configure namings like
25257 \begin_inset Quotes eld
25260 Miller, Peter and Mary Smith: \SpecialChar ldots
25261 , in: John Doe and Pat Green, eds.:\SpecialChar ldots
25263 \begin_inset Quotes erd
25269 \begin_layout Standard
25270 There is one other piece of syntax available in definitions, which looks
25272 \begin_inset Flex Code
25275 \begin_layout Plain Layout
25282 This defines a piece of formatting information that is to be used when
25284 \begin_inset Quotes eld
25288 \begin_inset Quotes erd
25292 Obviously, we do not want to output HTML tags when writing plain text,
25293 so they should be wrapped in
25294 \begin_inset Quotes eld
25298 \begin_inset Quotes erd
25302 \begin_inset Quotes eld
25306 \begin_inset Quotes erd
25312 \begin_layout Standard
25313 Two special sorts of definitions are also possible in a
25314 \begin_inset Flex Code
25317 \begin_layout Plain Layout
25324 An example of the first would be:
25327 \begin_layout LyX-Code
25329 \begin_inset Quotes eld
25333 \begin_inset Quotes erd
25339 \begin_layout Standard
25340 This is an abbreviation, or macro, and it can be used by treating it as
25342 \begin_inset Flex Code
25345 \begin_layout Plain Layout
25354 \begin_inset Flex Code
25357 \begin_layout Plain Layout
25363 exactly as it would treat its definition.
25364 So, let us issue the obvious
25372 \begin_layout LyX-Code
25376 \begin_layout Standard
25377 or anything like it.
25379 shouldn't go into an infinite loop, but it may go into a long one before
25383 \begin_layout Standard
25384 The second sort of special definition might look like this:
25387 \begin_layout LyX-Code
25391 \begin_layout Standard
25392 This defines a translatable piece of text, which allows relevant parts of
25393 the bibliography or citation to be translated.
25394 It can be included in a definition by treating it as a key:
25395 \begin_inset Flex Code
25398 \begin_layout Plain Layout
25405 Note that there are two different translation paths: All definitions starting
25407 \begin_inset Flex Code
25410 \begin_layout Plain Layout
25416 , such as in the example above, will be translated to the currently active
25417 buffer language (so the translation will match the generated document).
25418 All definitions starting with underscore only will be translated to the
25420 This is the proper translation for strings that only occur in the dialogs
25421 or on buttons, such as this one:
25424 \begin_layout LyX-Code
25425 _addtobib Add to bibliography only.
25428 \begin_layout Standard
25429 Several of these translatable strings are predefined in
25430 \begin_inset Flex Code
25433 \begin_layout Plain Layout
25440 \begin_inset Flex Code
25443 \begin_layout Plain Layout
25450 Note that these are not macros, in the sense just defined.
25451 They will not be expanded.
25454 \begin_layout Standard
25455 So here then is an example that uses several of these features:
25456 \begin_inset VSpace defskip
25462 \begin_layout Standard
25466 !authoredit {%author%[[%author%, ]][[{%editor%[[%editor%, %B_edtext%, ]]}]]}
25469 \begin_layout Standard
25470 \begin_inset VSpace defskip
25473 This defines a macro that prints the author, followed by a comma, if the
25475 \begin_inset Flex Code
25478 \begin_layout Plain Layout
25484 key is defined, or else prints the name of the editor, followed by the
25486 \begin_inset Flex Code
25489 \begin_layout Plain Layout
25495 or its translation (it is by default
25496 \begin_inset Quotes eld
25500 \begin_inset Quotes erd
25504 \begin_inset Flex Code
25507 \begin_layout Plain Layout
25514 Note that this is in fact defined in
25515 \begin_inset Flex Code
25518 \begin_layout Plain Layout
25524 , so you can use it in your own definitions, or re-definitions, if you load
25528 \begin_layout Section
25529 \begin_inset CommandInset label
25531 name "sec:Tags-for-XHTML"
25535 Tags for XHTML output
25538 \begin_layout Standard
25539 As with \SpecialChar LaTeX
25540 or DocBook, the format of \SpecialChar LyX
25541 's XHTML output is also controlled by
25542 layout information.
25543 In general, \SpecialChar LyX
25544 provides sensible defaults and, as mentioned earlier, it will
25545 even construct default CSS style rules from the other layout tags.
25546 For example, \SpecialChar LyX
25547 will attempt to use the information provided in the
25548 \begin_inset Flex Code
25551 \begin_layout Plain Layout
25557 declaration for the Chapter style to write CSS that will appropriately
25558 format chapter headings.
25561 \begin_layout Standard
25562 In many cases, then, you may not have to do anything at all to get acceptable
25563 XHTML output for your own environments, custom insets, and so forth.
25564 But in some cases you will, and so \SpecialChar LyX
25565 provides a number of layout tags that
25566 can be used to customize the XHTML and CSS that are generated.
25569 \begin_layout Standard
25570 Note that there are two tags,
25571 \begin_inset Flex Code
25574 \begin_layout Plain Layout
25581 \begin_inset Flex Code
25584 \begin_layout Plain Layout
25590 that may appear outside style and inset declarations.
25592 \begin_inset CommandInset ref
25594 reference "subsec:General-text-class"
25598 for details on these.
25601 \begin_layout Subsection
25602 \begin_inset CommandInset label
25604 name "subsec:Paragraph-Style-XHTML"
25611 \begin_layout Standard
25612 The sort of XHTML \SpecialChar LyX
25613 outputs for a paragraph depends upon whether we are dealing
25614 with a normal paragraph, a command, or an environment, where this is itself
25615 determined by the contents of the corresponding
25616 \begin_inset Flex Code
25619 \begin_layout Plain Layout
25630 \begin_layout Standard
25631 For a command or normal paragraph, the output XHTML has the following form:
25634 \begin_layout LyX-Code
25638 \begin_inset Quotes erd
25642 \begin_inset Quotes erd
25648 \begin_layout LyX-Code
25652 \begin_inset Quotes erd
25656 \begin_inset Quotes erd
25662 \begin_layout LyX-Code
25665 Contents of the paragraph.
25668 \begin_layout LyX-Code
25674 \begin_layout Standard
25675 The label tags are of course omitted if the paragraph does not have a label.
25678 \begin_layout Standard
25679 For an environment that is not some sort of list, the XHTML takes this form:
25682 \begin_layout LyX-Code
25686 \begin_inset Quotes erd
25690 \begin_inset Quotes erd
25696 \begin_layout LyX-Code
25700 \begin_inset Quotes erd
25704 \begin_inset Quotes erd
25708 \begin_inset Quotes erd
25712 \begin_inset Quotes erd
25715 >Environment Label</labeltag>First paragraph.</itemtag>
25718 \begin_layout LyX-Code
25721 <itemtag>Second paragraph.</itemtag>
25724 \begin_layout LyX-Code
25730 \begin_layout Standard
25731 Note that the label is output only for the first paragraph, as it should
25732 be for a theorem, for example.
25736 \begin_layout Standard
25737 For a list, we have one of these forms:
25740 \begin_layout LyX-Code
25744 \begin_inset Quotes erd
25748 \begin_inset Quotes erd
25754 \begin_layout LyX-Code
25758 \begin_inset Quotes erd
25762 \begin_inset Quotes erd
25766 \begin_inset Quotes erd
25770 \begin_inset Quotes erd
25773 >List Label</labeltag>First item.</itemtag>
25776 \begin_layout LyX-Code
25780 \begin_inset Quotes erd
25784 \begin_inset Quotes erd
25788 \begin_inset Quotes erd
25792 \begin_inset Quotes erd
25795 >List Label</labeltag>Second item.</itemtag>
25798 \begin_layout LyX-Code
25804 \begin_layout LyX-Code
25808 \begin_layout LyX-Code
25812 \begin_inset Quotes erd
25816 \begin_inset Quotes erd
25822 \begin_layout LyX-Code
25826 \begin_inset Quotes erd
25830 \begin_inset Quotes erd
25833 >List Label</labeltag><itemtag attr=
25834 \begin_inset Quotes erd
25838 \begin_inset Quotes erd
25841 >First item.</itemtag>
25844 \begin_layout LyX-Code
25848 \begin_inset Quotes erd
25852 \begin_inset Quotes erd
25855 >List Label</labeltag><itemtag attr=
25856 \begin_inset Quotes erd
25860 \begin_inset Quotes erd
25863 >Second item.</itemtag>
25866 \begin_layout LyX-Code
25872 \begin_layout Standard
25873 Note the different orders of
25874 \begin_inset Flex Code
25877 \begin_layout Plain Layout
25884 \begin_inset Flex Code
25887 \begin_layout Plain Layout
25894 Which order we get depends upon the setting of
25895 \begin_inset Flex Code
25898 \begin_layout Plain Layout
25905 \begin_inset Flex Code
25908 \begin_layout Plain Layout
25914 is false (the default), you get the first of these, with the label within
25915 the item; if true, you get the second, with the label outside the item.
25918 \begin_layout Standard
25919 The specific tags and attributes output for each paragraph type can be controlle
25920 d by means of the layout tags we are about to describe.
25921 As mentioned earlier, however, \SpecialChar LyX
25922 uses sensible defaults for many of these,
25923 so you often may not need to do very much to get good XHTML output.
25924 Think of the available tags as there so you can tweak things to your liking.
25927 \begin_layout Description
25928 \begin_inset Flex Code
25931 \begin_layout Plain Layout
25938 \begin_inset Flex Code
25941 \begin_layout Plain Layout
25947 ] Specifies attribute information to be output with the main tag.
25949 \begin_inset Quotes eld
25953 \begin_inset Flex Code
25956 \begin_layout Plain Layout
25963 \begin_inset Quotes erd
25967 By default, \SpecialChar LyX
25969 \begin_inset Quotes eld
25973 \begin_inset Flex Code
25976 \begin_layout Plain Layout
25983 \begin_inset Quotes erd
25987 \begin_inset Flex Code
25990 \begin_layout Plain Layout
25996 is the \SpecialChar LyX
25997 name of the layout, made lowercase, for example: chapter.
26002 contain any style information.
26004 \begin_inset Flex Code
26007 \begin_layout Plain Layout
26016 \begin_layout Description
26017 \begin_inset Flex Code
26020 \begin_layout Plain Layout
26027 \begin_inset Flex Code
26030 \begin_layout Plain Layout
26040 ] Whether to output the default CSS information \SpecialChar LyX
26041 generates for this layout,
26042 even if additional information is explicitly provided via
26043 \begin_inset Flex Code
26046 \begin_layout Plain Layout
26054 \begin_inset Flex Code
26057 \begin_layout Plain Layout
26063 allows you to alter or augment the generated CSS, rather than to override
26066 \begin_inset Flex Code
26069 \begin_layout Plain Layout
26078 \begin_layout Description
26079 \begin_inset Flex Code
26082 \begin_layout Plain Layout
26089 \begin_inset Flex Code
26092 \begin_layout Plain Layout
26098 ] The tag to be used for individual paragraphs of environments, replacing
26100 \begin_inset Flex Code
26103 \begin_layout Plain Layout
26109 in the examples above.
26111 \begin_inset Flex Code
26114 \begin_layout Plain Layout
26123 \begin_layout Description
26124 \begin_inset Flex Code
26127 \begin_layout Plain Layout
26134 \begin_inset Flex Code
26137 \begin_layout Plain Layout
26143 ] Attributes for the item tag.
26145 \begin_inset Newline newline
26149 \begin_inset Quotes eld
26153 \begin_inset Flex Code
26156 \begin_layout Plain Layout
26157 class=`layoutname_item'
26163 \begin_inset Quotes erd
26171 contain any style information.
26173 \begin_inset Flex Code
26176 \begin_layout Plain Layout
26185 \begin_layout Description
26186 \begin_inset Flex Code
26189 \begin_layout Plain Layout
26196 \begin_inset Flex Code
26199 \begin_layout Plain Layout
26205 ] The tag to be used for paragraph and item labels, replacing
26206 \begin_inset Flex Code
26209 \begin_layout Plain Layout
26215 in the examples above.
26217 \begin_inset Flex Code
26220 \begin_layout Plain Layout
26227 \begin_inset Flex Code
26230 \begin_layout Plain Layout
26237 \begin_inset Flex Code
26240 \begin_layout Plain Layout
26247 \begin_inset Flex Code
26250 \begin_layout Plain Layout
26251 Centered_Top_Environment
26256 , in which case it defaults to
26257 \begin_inset Flex Code
26260 \begin_layout Plain Layout
26269 \begin_layout Description
26270 \begin_inset Flex Code
26273 \begin_layout Plain Layout
26280 \begin_inset Flex Code
26283 \begin_layout Plain Layout
26289 ] Attributes for the label tag.
26291 \begin_inset Newline newline
26295 \begin_inset Quotes eld
26299 \begin_inset Flex Code
26302 \begin_layout Plain Layout
26303 class=`layoutname_label'
26309 \begin_inset Quotes erd
26317 contain any style information.
26319 \begin_inset Flex Code
26322 \begin_layout Plain Layout
26331 \begin_layout Description
26332 \begin_inset Flex Code
26335 \begin_layout Plain Layout
26342 \begin_inset Flex Code
26345 \begin_layout Plain Layout
26355 ] Meaningful only for list-like environments, this tag controls whether
26356 the label tag is output before or inside the item tag.
26357 This is used, for example, in the description environment, where we want
26359 \begin_inset Flex Code
26362 \begin_layout Plain Layout
26363 <dt>\SpecialChar ldots
26364 </dt><dd>\SpecialChar ldots
26372 \begin_inset Flex Code
26375 \begin_layout Plain Layout
26381 : The label tag is output inside the item tag.
26384 \begin_layout Description
26385 \begin_inset Flex Code
26388 \begin_layout Plain Layout
26394 Information to be output in the
26395 \begin_inset Flex Code
26398 \begin_layout Plain Layout
26404 section when this style is used.
26405 This might, for example, be used to include a
26406 \begin_inset Flex Code
26409 \begin_layout Plain Layout
26416 \begin_inset Flex Code
26419 \begin_layout Plain Layout
26428 \begin_layout Description
26429 \begin_inset Flex Code
26432 \begin_layout Plain Layout
26438 CSS style information to be included when this style is used.
26439 Note that this will automatically be wrapped in a layout-generated
26440 \begin_inset Flex Code
26443 \begin_layout Plain Layout
26449 block, so only the CSS itself need be included.
26451 \begin_inset Flex Code
26454 \begin_layout Plain Layout
26463 \begin_layout Description
26464 \begin_inset Flex Code
26467 \begin_layout Plain Layout
26474 \begin_inset Flex Code
26477 \begin_layout Plain Layout
26483 ] The tag to be used for the main label, replacing
26484 \begin_inset Flex Code
26487 \begin_layout Plain Layout
26493 in the examples above.
26495 \begin_inset Flex Code
26498 \begin_layout Plain Layout
26507 \begin_layout Description
26508 \begin_inset Flex Code
26511 \begin_layout Plain Layout
26518 \begin_inset Flex Code
26521 \begin_layout Plain Layout
26531 ] Marks this style as the one to be used to generate the
26532 \begin_inset Flex Code
26535 \begin_layout Plain Layout
26541 tag for the XHTML file.
26542 By default, it is false.
26544 \begin_inset Flex Code
26547 \begin_layout Plain Layout
26553 file sets it to true for the
26554 \begin_inset Flex Code
26557 \begin_layout Plain Layout
26567 \begin_layout Subsection
26571 \begin_layout Standard
26572 The XHTML output of insets can also be controlled by information in layout
26577 \begin_layout Plain Layout
26578 At present, this is true only for
26579 \begin_inset Quotes eld
26583 \begin_inset Quotes erd
26586 insets (insets you can type into) and is not true for
26587 \begin_inset Quotes eld
26591 \begin_inset Quotes erd
26594 insets (insets that are associated with dialog boxes).
26599 Here, too, \SpecialChar LyX
26600 tries to provide sensible defaults, and it constructs default
26602 But everything can be customized.
26605 \begin_layout Standard
26606 The XHTML \SpecialChar LyX
26607 outputs for an inset has the following form:
26610 \begin_layout LyX-Code
26612 \begin_inset Quotes erd
26616 \begin_inset Quotes erd
26622 \begin_layout LyX-Code
26623 <labeltag>Label</labeltag>
26626 \begin_layout LyX-Code
26628 \begin_inset Quotes erd
26632 \begin_inset Quotes erd
26635 >Contents of the inset.</innertag>
26638 \begin_layout LyX-Code
26642 \begin_layout Standard
26643 If the inset permits multiple paragraphs—that is, if
26644 \begin_inset Flex Code
26647 \begin_layout Plain Layout
26653 is true—then the contents of the inset will itself be output as paragraphs
26654 formatted according to the styles used for those paragraphs (standard,
26655 quote, and the like).
26656 The label tag is of course omitted if the paragraph does not have a label
26657 and, at present, is always
26658 \begin_inset Flex Code
26661 \begin_layout Plain Layout
26668 The inner tag is optional and, by default, does not appear.
26671 \begin_layout Standard
26672 The specific tags and attributes output for each inset can be controlled
26673 by means of the following layout tags.
26676 \begin_layout Description
26677 \begin_inset Flex Code
26680 \begin_layout Plain Layout
26687 \begin_inset Flex Code
26690 \begin_layout Plain Layout
26696 ] Specifies attribute information to be output with the main tag.
26698 \begin_inset Quotes eld
26702 \begin_inset Flex Code
26705 \begin_layout Plain Layout
26706 class=`myinset' onclick=`\SpecialChar ldots
26713 \begin_inset Quotes erd
26717 By default, \SpecialChar LyX
26719 \begin_inset Quotes eld
26723 \begin_inset Flex Code
26726 \begin_layout Plain Layout
26733 \begin_inset Quotes erd
26737 \begin_inset Flex Code
26740 \begin_layout Plain Layout
26746 is the \SpecialChar LyX
26747 name of the inset, made lowercase and with non-alphanumeric characters
26748 converted to underscores, for example: footnote.
26751 \begin_layout Description
26752 \begin_inset Flex Code
26755 \begin_layout Plain Layout
26762 \begin_inset Flex Code
26765 \begin_layout Plain Layout
26775 ] Whether to output the default CSS information \SpecialChar LyX
26776 generates for this layout,
26777 even if additional information is explicitly provided via
26778 \begin_inset Flex Code
26781 \begin_layout Plain Layout
26789 \begin_inset Flex Code
26792 \begin_layout Plain Layout
26798 allows you to alter or augment the generated CSS, rather than to override
26803 \begin_layout Description
26804 \begin_inset Flex Code
26807 \begin_layout Plain Layout
26814 \begin_inset Flex Code
26817 \begin_layout Plain Layout
26823 ] Attributes for the inner tag.
26825 \begin_inset Newline newline
26829 \begin_inset Quotes eld
26833 \begin_inset Flex Code
26836 \begin_layout Plain Layout
26837 class=`insetname_inner'
26843 \begin_inset Quotes erd
26849 \begin_layout Description
26850 \begin_inset Flex Code
26853 \begin_layout Plain Layout
26860 \begin_inset Flex Code
26863 \begin_layout Plain Layout
26869 ] The inner tag, replacing
26870 \begin_inset Flex Code
26873 \begin_layout Plain Layout
26879 in the examples above.
26880 By default, there is none.
26883 \begin_layout Description
26884 \begin_inset Flex Code
26887 \begin_layout Plain Layout
26894 \begin_inset Flex Code
26897 \begin_layout Plain Layout
26905 ] Whether this inset represents a standalone block of text (such as a footnote)
26906 or instead represents material that is included in the surrounding text
26907 (such as a branch).
26911 \begin_layout Description
26912 \begin_inset Flex Code
26915 \begin_layout Plain Layout
26922 \begin_inset Flex Code
26925 \begin_layout Plain Layout
26931 ] A label for this inset, possibly including a reference to a counter.
26932 For example, for footnote, it might be:
26933 \begin_inset Flex Code
26936 \begin_layout Plain Layout
26945 This is optional, and there is no default.
26948 \begin_layout Description
26949 \begin_inset Flex Code
26952 \begin_layout Plain Layout
26958 Information to be output in the
26959 \begin_inset Flex Code
26962 \begin_layout Plain Layout
26968 section when this style is used.
26969 This might, for example, be used to include a
26970 \begin_inset Flex Code
26973 \begin_layout Plain Layout
26980 \begin_inset Flex Code
26983 \begin_layout Plain Layout
26992 \begin_layout Description
26993 \begin_inset Flex Code
26996 \begin_layout Plain Layout
27002 CSS style information to be included when this style is used.
27003 Note that this will automatically be wrapped in a layout-generated
27004 \begin_inset Flex Code
27007 \begin_layout Plain Layout
27013 block, so only the CSS itself need be included.
27016 \begin_layout Description
27017 \begin_inset Flex Code
27020 \begin_layout Plain Layout
27027 \begin_inset Flex Code
27030 \begin_layout Plain Layout
27036 ] The tag to be used for the main label, replacing
27037 \begin_inset Flex Code
27040 \begin_layout Plain Layout
27046 in the examples above.
27047 The default depends upon the setting of
27048 \begin_inset Flex Code
27051 \begin_layout Plain Layout
27058 \begin_inset Flex Code
27061 \begin_layout Plain Layout
27067 is true, the default is
27068 \begin_inset Flex Code
27071 \begin_layout Plain Layout
27077 ; if it is false, the default is
27078 \begin_inset Flex Code
27081 \begin_layout Plain Layout
27090 \begin_layout Subsection
27094 \begin_layout Standard
27095 The XHTML output for floats too can be controlled by layout information.
27096 The output has the following form:
27099 \begin_layout LyX-Code
27101 \begin_inset Quotes erd
27105 \begin_inset Quotes erd
27111 \begin_layout LyX-Code
27112 Contents of the float.
27115 \begin_layout LyX-Code
27119 \begin_layout Standard
27120 The caption, if there is one, is a separate inset and will be output as
27122 Its appearance can be controlled via the InsetLayout for caption insets.
27126 \begin_layout Description
27127 \begin_inset Flex Code
27130 \begin_layout Plain Layout
27137 \begin_inset Flex Code
27140 \begin_layout Plain Layout
27146 ] Specifies attribute information to be output with the main tag.
27148 \begin_inset Quotes eld
27152 \begin_inset Flex Code
27155 \begin_layout Plain Layout
27156 class=`myfloat' onclick=`\SpecialChar ldots
27163 \begin_inset Quotes erd
27167 By default, \SpecialChar LyX
27169 \begin_inset Quotes eld
27173 \begin_inset Flex Code
27176 \begin_layout Plain Layout
27177 class=`float float-floattype'
27183 \begin_inset Quotes erd
27187 \begin_inset Flex Code
27190 \begin_layout Plain Layout
27196 is \SpecialChar LyX
27197 's name for this type of float, as determined by the float declaration
27199 \begin_inset CommandInset ref
27201 reference "subsec:Floats"
27205 ), though made lowercase and with non-alphanumeric characters converted
27206 to underscores, for example: float-table.
27209 \begin_layout Description
27210 \begin_inset Flex Code
27213 \begin_layout Plain Layout
27219 CSS style information to be included when this float is used.
27220 Note that this will automatically be wrapped in a layout-generated
27221 \begin_inset Flex Code
27224 \begin_layout Plain Layout
27230 block, so only the CSS itself need be included.
27233 \begin_layout Description
27234 \begin_inset Flex Code
27237 \begin_layout Plain Layout
27244 \begin_inset Flex Code
27247 \begin_layout Plain Layout
27253 ] The tag to be used for this float, replacing
27254 \begin_inset Quotes eld
27258 \begin_inset Flex Code
27261 \begin_layout Plain Layout
27268 \begin_inset Quotes erd
27271 in the example above.
27273 \begin_inset Flex Code
27276 \begin_layout Plain Layout
27282 and will rarely need changing.
27285 \begin_layout Subsection
27286 Bibliography formatting
27289 \begin_layout Standard
27290 The bibliography can be formatted using
27291 \begin_inset Flex Code
27294 \begin_layout Plain Layout
27302 \begin_inset CommandInset ref
27304 reference "subsec:Citation-format-description"
27311 \begin_layout Subsection
27316 \begin_layout Standard
27317 We have several times mentioned that \SpecialChar LyX
27318 will generate default CSS style rules
27319 for both insets and paragraph styles, based upon the other layout information
27321 In this section, we shall say a word about which layout information \SpecialChar LyX
27326 \begin_layout Standard
27327 At present, \SpecialChar LyX
27328 auto-generates CSS only for font information, making use of
27330 \begin_inset Flex Code
27333 \begin_layout Plain Layout
27340 \begin_inset Flex Code
27343 \begin_layout Plain Layout
27350 \begin_inset Flex Code
27353 \begin_layout Plain Layout
27360 \begin_inset Flex Code
27363 \begin_layout Plain Layout
27370 \begin_inset Flex Code
27373 \begin_layout Plain Layout
27380 \begin_inset CommandInset ref
27382 reference "subsec:Font-description"
27387 The translation is mostly straightforward and obvious.
27389 \begin_inset Quotes eld
27393 \begin_inset Flex Code
27396 \begin_layout Plain Layout
27403 \begin_inset Quotes erd
27407 \begin_inset Quotes eld
27411 \begin_inset Flex Code
27414 \begin_layout Plain Layout
27415 font-family: sans-serif;
27421 \begin_inset Quotes erd
27425 The correspondence of \SpecialChar LyX
27426 sizes and CSS sizes is a little less obvious but
27427 nonetheless intuitive.
27429 \begin_inset Flex Code
27432 \begin_layout Plain Layout
27439 \begin_inset Flex URL
27442 \begin_layout Plain Layout
27450 \change_inserted -970929547 1496610908
27454 \begin_layout Section
27456 \change_inserted -970929547 1496610966
27457 \begin_inset CommandInset label
27459 name "sec:Tags-for-DocBook"
27463 Tags for DocBook output
27466 \begin_layout Standard
27468 \change_inserted -970929547 1496611615
27469 As with \SpecialChar LaTeX
27470 or XHTML, the format of \SpecialChar LyX
27471 's DocBook output is also controlled by
27472 layout information.
27473 In general, \SpecialChar LyX
27474 provides sensible defaults; however, much of the styling is
27475 lost during the conversion, as DocBook is strictly semantic and does not
27477 When possible, information from \SpecialChar LyX
27478 will be rendered in
27486 \begin_layout Standard
27488 \change_inserted -970929547 1496612080
27489 In many cases, then, you may not have to do anything at all to get acceptable
27490 DocBook output for your own environments, custom insets, and so forth.
27491 But in some cases you will, and so \SpecialChar LyX
27492 provides a number of layout tags that
27493 can be used to customize the DocBook that is generated.
27496 \begin_layout Standard
27498 \change_inserted -970929547 1515109912
27499 Labels are rarely output, as they are redundant in DocBook: this information
27500 is carried by the tags themselves, and whether labels appear in the final
27501 documents (after processing of DocBook files) is controlled by the stylesheets.
27502 However, sometimes, labels are not redundant content, such as definition
27503 lists: in this case, the term being defined will be the label.
27507 \begin_layout Subsection
27509 \change_inserted 1075283030 1597699417
27510 \begin_inset CommandInset label
27512 name "subsec:Paragraph-Style-DocBook"
27517 \change_deleted 1075283030 1597699417
27519 \begin_inset CommandInset label
27521 name "subsec:Paragraph-Style-XHTML-1"
27526 \change_inserted -970929547 1496610966
27530 \begin_layout Standard
27532 \change_inserted -970929547 1496612059
27533 The sort of DocBook \SpecialChar LyX
27534 outputs for a paragraph depends upon whether we are
27535 dealing with a normal paragraph, a command, or an environment, where this
27536 is itself determined by the contents of the corresponding
27537 \begin_inset Flex Code
27540 \begin_layout Plain Layout
27542 \change_inserted -970929547 1496610966
27555 \begin_layout Standard
27557 \change_inserted -970929547 1496612107
27558 For a command or normal paragraph, the output DocBook has the following
27562 \begin_layout LyX-Code
27564 \change_inserted -970929547 1515109666
27568 \begin_layout LyX-Code
27570 \change_inserted -970929547 1496610966
27571 Contents of the paragraph.
27574 \begin_layout LyX-Code
27576 \change_inserted -970929547 1496610966
27580 \begin_layout Standard
27582 \change_inserted -970929547 1515109821
27583 For an environment that is not some sort of list, the generated DocBook
27587 \begin_layout LyX-Code
27589 \change_inserted -970929547 1515109671
27593 \begin_layout LyX-Code
27595 \change_inserted -970929547 1496612114
27596 <itemtag>First paragraph.</itemtag>
27599 \begin_layout LyX-Code
27601 \change_inserted -970929547 1496610966
27602 <itemtag>Second paragraph.</itemtag>
27605 \begin_layout LyX-Code
27607 \change_inserted -970929547 1496610966
27611 \begin_layout Standard
27613 \change_inserted -970929547 1515109825
27614 For a list, the resulting DocBook takes this form:
27617 \begin_layout LyX-Code
27619 \change_inserted -970929547 1515109672
27623 \begin_layout LyX-Code
27625 \change_inserted -970929547 1515109676
27626 <itemtag attr>First item.</itemtag>
27629 \begin_layout LyX-Code
27631 \change_inserted -970929547 1515109678
27632 <itemtag attr>Second item.</itemtag>
27635 \begin_layout LyX-Code
27637 \change_inserted -970929547 1496610966
27641 \begin_layout Standard
27643 \change_inserted -970929547 1496612243
27644 The specific tags and roles output for each paragraph type can be controlled
27645 by means of the layout tags we are about to describe.
27646 Please note that, due to the very nature of DocBook, no sensible defaults
27647 really exist, and the values must always be carefully chosen.
27651 \begin_layout Description
27653 \change_inserted -970929547 1515110057
27654 \begin_inset Flex Code
27657 \begin_layout Plain Layout
27659 \change_inserted -970929547 1515109656
27668 \begin_inset Flex Code
27671 \begin_layout Plain Layout
27673 \change_inserted -970929547 1496610966
27681 ] Specifies attribute information to be output with the main tag, replacing
27683 \begin_inset Quotes eld
27687 \begin_inset Flex Code
27690 \begin_layout Plain Layout
27692 \change_inserted -970929547 1515110057
27701 \begin_inset Quotes erd
27704 in the example above.
27705 This information can be used in further processing of the DocBook files.
27711 \begin_layout Description
27713 \change_inserted -970929547 1496612296
27714 \begin_inset Flex Code
27717 \begin_layout Plain Layout
27719 \change_inserted -970929547 1496612269
27728 \begin_inset Flex Code
27731 \begin_layout Plain Layout
27733 \change_inserted -970929547 1496610966
27741 ] The tag to be used for this inset, replacing
27742 \begin_inset Quotes eld
27746 \begin_inset Flex Code
27749 \begin_layout Plain Layout
27751 \change_inserted -970929547 1496612296
27760 \begin_inset Quotes erd
27763 in the example above.
27764 The default is the name of the float and always needs to be changed, as
27765 DocBook provides no generic tag.
27766 \change_inserted 1075283030 1597698868
27770 \begin_layout Description
27772 \change_inserted 1075283030 1597699399
27773 \begin_inset Flex Code
27776 \begin_layout Plain Layout
27778 \change_inserted 1075283030 1597698872
27787 \begin_inset Flex Code
27790 \begin_layout Plain Layout
27792 \change_inserted 1075283030 1597700585
27793 block, paragraph, inline
27800 ] The new-line policy for this tag, see Section
27801 \begin_inset space ~
27805 \begin_inset CommandInset ref
27807 reference "subsec:DocBook-New-line-policy"
27820 \begin_layout Subsection
27822 \change_inserted 1075283030 1597699385
27824 \begin_inset CommandInset label
27826 name "subsec:DocBook-New-line-policy"
27833 \begin_layout Standard
27835 \change_inserted 1075283030 1597698993
27836 For all tags, there are three possible policies for outputting new lines
27838 \begin_inset Flex Code
27841 \begin_layout Plain Layout
27843 \change_inserted 1075283030 1597698987
27854 \begin_layout Itemize
27856 \change_inserted 1075283030 1597699279
27857 \begin_inset Quotes eld
27861 \begin_inset Flex Code
27864 \begin_layout Plain Layout
27866 \change_inserted 1075283030 1597699012
27875 \begin_inset Quotes erd
27878 : the opening and closing tags are on their own lines (i.e.
27879 a line feed after and before the opening and the closing tags).
27880 Typical elements are floats.
27884 \begin_layout LyX-Code
27886 \change_inserted 1075283030 1597699194
27890 \begin_layout LyX-Code
27892 \change_inserted 1075283030 1597699194
27896 \begin_layout LyX-Code
27898 \change_inserted 1075283030 1597699098
27899 Contents of the block.
27902 \begin_layout LyX-Code
27904 \change_inserted 1075283030 1597699196
27908 \begin_layout LyX-Code
27910 \change_inserted 1075283030 1597699198
27914 \begin_layout Itemize
27916 \change_inserted 1075283030 1597699289
27917 \begin_inset Quotes eld
27921 \begin_inset Flex Code
27924 \begin_layout Plain Layout
27926 \change_inserted 1075283030 1597699113
27935 \begin_inset Quotes erd
27938 : the opening and closing tags are on the same, new line; a line feed is
27939 output before the opening tag and after the closing tag.
27940 Typical elements are paragraphs and list items.
27944 \begin_layout LyX-Code
27946 \change_inserted 1075283030 1597699186
27950 \begin_layout LyX-Code
27952 \change_inserted 1075283030 1597699357
27953 <paratag>Contents of the paragraph.</paratag>
27956 \begin_layout LyX-Code
27958 \change_inserted 1075283030 1597699231
27962 \begin_layout Itemize
27964 \change_inserted 1075283030 1597699343
27965 \begin_inset Quotes eld
27969 \begin_inset Flex Code
27972 \begin_layout Plain Layout
27974 \change_inserted 1075283030 1597699307
27983 \begin_inset Quotes erd
27986 : the opening and closing tags are on the same line as the rest of the content.
27987 No line feeds are output.
27988 Typical elements are fonts.
27992 \begin_layout LyX-Code
27994 \change_inserted 1075283030 1597699585
27995 Content before<inlinetag>Contents of the paragraph.</inlinetag>Content after
27998 \begin_layout Standard
28000 \change_inserted 1075283030 1597699585
28001 The default value is always
28002 \begin_inset Quotes eld
28006 \begin_inset Flex Code
28009 \begin_layout Plain Layout
28011 \change_inserted 1075283030 1597699585
28020 \begin_inset Quotes erd
28028 \begin_layout Subsection
28030 \change_inserted -970929547 1515111533
28031 InsetLayout DocBook
28036 \begin_layout Standard
28038 \change_inserted -970929547 1496611894
28039 The DocBook output of insets can also be controlled by information in layout
28043 \begin_layout Standard
28045 \change_inserted -970929547 1496612045
28046 The DocBook \SpecialChar LyX
28047 outputs for an inset has the following form:
28050 \begin_layout LyX-Code
28052 \change_inserted -970929547 1515110861
28053 <wrappertag wrapperattr>
28056 \begin_layout LyX-Code
28058 \change_inserted -970929547 1515110868
28062 \begin_layout LyX-Code
28064 \change_inserted -970929547 1515110869
28065 <innertag innerattr>
28068 \begin_layout LyX-Code
28070 \change_inserted -970929547 1515110869
28071 Contents of the inset.
28074 \begin_layout LyX-Code
28076 \change_inserted -970929547 1515110870
28080 \begin_layout LyX-Code
28082 \change_inserted -970929547 1515110871
28086 \begin_layout LyX-Code
28088 \change_inserted -970929547 1515111172
28092 \begin_layout Standard
28094 \change_inserted -970929547 1515111186
28095 For an itemising inset, it rather looks like this:
28098 \begin_layout LyX-Code
28100 \change_inserted -970929547 1515111186
28101 <wrappertag wrapperattr>
28104 \begin_layout LyX-Code
28106 \change_inserted -970929547 1515111186
28110 \begin_layout LyX-Code
28112 \change_inserted -970929547 1515111186
28113 <innertag innerattr>
28116 \begin_layout LyX-Code
28118 \change_inserted -970929547 1515111362
28119 <itemwrappertag itemwrapperattr>
28122 \begin_layout LyX-Code
28124 \change_inserted -970929547 1515111364
28125 <itemlabeltag itemattr>
28128 \begin_layout LyX-Code
28130 \change_inserted -970929547 1515111367
28131 Label of the first item.
28134 \begin_layout LyX-Code
28136 \change_inserted -970929547 1515111362
28142 \begin_layout LyX-Code
28144 \change_inserted -970929547 1515111517
28148 \begin_layout LyX-Code
28150 \change_inserted -970929547 1515111517
28156 \begin_layout LyX-Code
28158 \change_inserted -970929547 1515111516
28159 Contents of the first item.
28162 \begin_layout LyX-Code
28164 \change_inserted -970929547 1515111514
28170 \begin_layout LyX-Code
28172 \change_inserted -970929547 1515111247
28178 \begin_layout LyX-Code
28180 \change_inserted -970929547 1515111221
28184 \begin_layout LyX-Code
28186 \change_inserted -970929547 1515111370
28187 <itemwrappertag itemwrapperattr>
28190 \begin_layout LyX-Code
28192 \change_inserted -970929547 1515111370
28193 <itemlabeltag itemattr>
28196 \begin_layout LyX-Code
28198 \change_inserted -970929547 1515111372
28199 Label of the second item.
28202 \begin_layout LyX-Code
28204 \change_inserted -970929547 1515111370
28210 \begin_layout LyX-Code
28212 \change_inserted -970929547 1515111504
28216 \begin_layout LyX-Code
28218 \change_inserted -970929547 1515111505
28224 \begin_layout LyX-Code
28226 \change_inserted -970929547 1515111507
28227 Contents of the second item.
28230 \begin_layout LyX-Code
28232 \change_inserted -970929547 1515111509
28238 \begin_layout LyX-Code
28240 \change_inserted -970929547 1515111251
28246 \begin_layout LyX-Code
28248 \change_inserted -970929547 1515111221
28254 \begin_layout LyX-Code
28256 \change_inserted -970929547 1515111219
28262 \begin_layout LyX-Code
28264 \change_inserted -970929547 1515111186
28268 \begin_layout LyX-Code
28270 \change_inserted -970929547 1515111186
28274 \begin_layout LyX-Code
28276 \change_inserted -970929547 1515111186
28280 \begin_layout Standard
28282 \change_inserted -970929547 1515111183
28283 If the inset permits multiple paragraphs—that is, if
28284 \begin_inset Flex Code
28287 \begin_layout Plain Layout
28289 \change_inserted -970929547 1496610966
28297 is true—then the contents of the inset will itself be output as paragraphs
28298 formatted according to the styles used for those paragraphs (standard,
28299 quote, and the like).
28300 The inner tag is optional and, by default, does not appear.
28303 \begin_layout Standard
28305 \change_inserted -970929547 1496610966
28306 The specific tags and attributes output for each inset can be controlled
28307 by means of the following layout tags.
28310 \begin_layout Description
28312 \change_inserted -970929547 1515110317
28313 \begin_inset Flex Code
28316 \begin_layout Plain Layout
28318 \change_inserted -970929547 1515109695
28327 \begin_inset Flex Code
28330 \begin_layout Plain Layout
28332 \change_inserted -970929547 1496611854
28340 ] Specifies attribute information to be output with the main tag, replacing
28342 \begin_inset Quotes eld
28346 \begin_inset Flex Code
28349 \begin_layout Plain Layout
28351 \change_inserted -970929547 1515110044
28360 \begin_inset Quotes erd
28363 in the example above.
28364 This information can be used in further processing of the DocBook files.
28368 \begin_layout Description
28370 \change_inserted -970929547 1515110973
28371 \begin_inset Flex Code
28374 \begin_layout Plain Layout
28376 \change_inserted -970929547 1515110319
28385 \begin_inset Flex Code
28388 \begin_layout Plain Layout
28390 \change_inserted -970929547 1515110384
28391 never, always, maybe
28398 ] Specifies whether this tag goes into the
28399 \begin_inset Flex Code
28402 \begin_layout Plain Layout
28404 \change_inserted -970929547 1515110412
28412 tag at the beginning of the parent layout.
28414 \begin_inset Flex Code
28417 \begin_layout Plain Layout
28419 \change_inserted -970929547 1515110437
28427 indicates that the tag never goes into
28428 \begin_inset Flex Code
28431 \begin_layout Plain Layout
28433 \change_inserted -970929547 1515110497
28441 (this is default value, and corresponds to usual content).
28443 \begin_inset Flex Code
28446 \begin_layout Plain Layout
28448 \change_inserted -970929547 1515110517
28456 indicates that the tag always goes into
28457 \begin_inset Flex Code
28460 \begin_layout Plain Layout
28462 \change_inserted -970929547 1515110514
28470 (this corresponds to usual metadata): if there is no
28471 \begin_inset Flex Code
28474 \begin_layout Plain Layout
28476 \change_inserted -970929547 1515110550
28484 tag for the parent, one
28490 \begin_inset Flex Code
28493 \begin_layout Plain Layout
28495 \change_inserted -970929547 1515110540
28503 indicates that the tag may go into
28504 \begin_inset Flex Code
28507 \begin_layout Plain Layout
28509 \change_inserted -970929547 1515110538
28517 (this is only the case for titles): if there is no
28518 \begin_inset Flex Code
28521 \begin_layout Plain Layout
28523 \change_inserted -970929547 1515110585
28531 tag for the parent,
28535 will be generated, the corresponding tag will be output directly as content.
28539 \begin_layout Description
28541 \change_inserted -970929547 1515111461
28542 \begin_inset Flex Code
28545 \begin_layout Plain Layout
28547 \change_inserted -970929547 1515110974
28556 \begin_inset Flex Code
28559 \begin_layout Plain Layout
28561 \change_inserted -970929547 1515110973
28569 ] Specifies attribute information to be output with the item tag, replacing
28571 \begin_inset Quotes eld
28575 \begin_inset Flex Code
28578 \begin_layout Plain Layout
28580 \change_inserted -970929547 1515110984
28589 \begin_inset Quotes erd
28592 in the example above.
28593 This information can be used in further processing of the DocBook files.
28597 \begin_layout Description
28599 \change_inserted -970929547 1515111471
28600 \begin_inset Flex Code
28603 \begin_layout Plain Layout
28605 \change_inserted -970929547 1515111465
28606 DocBookItemInnerAttr
28614 \begin_inset Flex Code
28617 \begin_layout Plain Layout
28619 \change_inserted -970929547 1515111461
28627 ] Specifies attribute information to be output with the item inner tag,
28629 \begin_inset Quotes eld
28633 \begin_inset Flex Code
28636 \begin_layout Plain Layout
28638 \change_inserted -970929547 1515111476
28647 \begin_inset Quotes erd
28650 in the example above.
28651 This information can be used in further processing of the DocBook files.
28655 \begin_layout Description
28657 \change_inserted -970929547 1515111494
28658 \begin_inset Flex Code
28661 \begin_layout Plain Layout
28663 \change_inserted -970929547 1515111467
28664 DocBookItemInnerTag
28672 \begin_inset Flex Code
28675 \begin_layout Plain Layout
28677 \change_inserted -970929547 1515111461
28685 ] The tag to be used for the item inner tag within the inset, replacing
28687 \begin_inset Quotes eld
28691 \begin_inset Flex Code
28694 \begin_layout Plain Layout
28696 \change_inserted -970929547 1515111486
28705 \begin_inset Quotes erd
28708 in the example above.
28710 \begin_inset Flex Code
28713 \begin_layout Plain Layout
28715 \change_inserted -970929547 1515111461
28723 , indicating that there is no item inner tag: content is directly output
28724 without it for each itemised element.
28725 This parameter only makes sense when itemising layouts are used, such as
28728 \change_inserted 1075283030 1598469472
28729 The most likely value is
28730 \begin_inset Quotes eld
28734 \begin_inset Flex Code
28737 \begin_layout Plain Layout
28739 \change_inserted 1075283030 1598469476
28748 \begin_inset Quotes erd
28752 \begin_inset Newline newline
28755 When a list item is split using a new line, the item inner tag will be repeated
28756 for each part of the paragraph, parts being separated by new lines.
28760 \begin_layout Description
28762 \change_inserted 1075283030 1597699866
28763 \begin_inset Flex Code
28766 \begin_layout Plain Layout
28768 \change_inserted 1075283030 1597699853
28769 DocBookItemInnerTagType
28777 \begin_inset Flex Code
28780 \begin_layout Plain Layout
28782 \change_inserted 1075283030 1597699866
28783 block, paragraph, inline
28790 ] The new-line policy for this tag, see Section
28791 \begin_inset space ~
28795 \begin_inset CommandInset ref
28797 reference "subsec:DocBook-New-line-policy"
28810 \begin_layout Description
28812 \change_inserted -970929547 1515111290
28813 \begin_inset Flex Code
28816 \begin_layout Plain Layout
28818 \change_inserted -970929547 1515111283
28819 DocBookItemLabelAttr
28827 \begin_inset Flex Code
28830 \begin_layout Plain Layout
28832 \change_inserted -970929547 1515111279
28840 ] Specifies attribute information to be output with the item label tag,
28842 \begin_inset Quotes eld
28846 \begin_inset Flex Code
28849 \begin_layout Plain Layout
28851 \change_inserted -970929547 1515111304
28860 \begin_inset Quotes erd
28863 in the example above.
28864 This information can be used in further processing of the DocBook files.
28868 \begin_layout Description
28870 \change_inserted -970929547 1515111337
28871 \begin_inset Flex Code
28874 \begin_layout Plain Layout
28876 \change_inserted -970929547 1515111285
28877 DocBookItemLabelTag
28885 \begin_inset Flex Code
28888 \begin_layout Plain Layout
28890 \change_inserted -970929547 1515111279
28898 ] The tag to be used for the item label tag within the inset, replacing
28900 \begin_inset Quotes eld
28904 \begin_inset Flex Code
28907 \begin_layout Plain Layout
28909 \change_inserted -970929547 1515111311
28918 \begin_inset Quotes erd
28921 in the example above.
28922 This parameter only makes sense when itemising layouts are used with a
28923 notion of labels, such as definition lists.
28925 \change_inserted 1075283030 1597699874
28929 \begin_layout Description
28931 \change_inserted 1075283030 1597699874
28932 \begin_inset Flex Code
28935 \begin_layout Plain Layout
28937 \change_inserted 1075283030 1597699880
28938 DocBookItemLabelTagType
28946 \begin_inset Flex Code
28949 \begin_layout Plain Layout
28951 \change_inserted 1075283030 1597699874
28952 block, paragraph, inline
28959 ] The new-line policy for this tag, see Section
28960 \begin_inset space ~
28964 \begin_inset CommandInset ref
28966 reference "subsec:DocBook-New-line-policy"
28979 \begin_layout Description
28981 \change_inserted -970929547 1515111124
28982 \begin_inset Flex Code
28985 \begin_layout Plain Layout
28987 \change_inserted -970929547 1515111060
28996 \begin_inset Flex Code
28999 \begin_layout Plain Layout
29001 \change_inserted -970929547 1515111060
29009 ] The tag to be used for the item tag within the inset, replacing
29010 \begin_inset Quotes eld
29014 \begin_inset Flex Code
29017 \begin_layout Plain Layout
29019 \change_inserted -970929547 1515111060
29028 \begin_inset Quotes erd
29031 in the example above.
29033 \begin_inset Flex Code
29036 \begin_layout Plain Layout
29038 \change_inserted -970929547 1515111060
29046 , indicating that there is no item tag.
29047 This parameter only makes sense when itemising layouts are used, such as
29050 \change_inserted 1075283030 1597699890
29054 \begin_layout Description
29056 \change_inserted 1075283030 1597699890
29057 \begin_inset Flex Code
29060 \begin_layout Plain Layout
29062 \change_inserted 1075283030 1597699890
29071 \begin_inset Flex Code
29074 \begin_layout Plain Layout
29076 \change_inserted 1075283030 1597699890
29077 block, paragraph, inline
29084 ] The new-line policy for this tag, see Section
29085 \begin_inset space ~
29089 \begin_inset CommandInset ref
29091 reference "subsec:DocBook-New-line-policy"
29104 \begin_layout Description
29106 \change_inserted -970929547 1515111298
29107 \begin_inset Flex Code
29110 \begin_layout Plain Layout
29112 \change_inserted -970929547 1515111124
29113 DocBookItemWrapperAttr
29121 \begin_inset Flex Code
29124 \begin_layout Plain Layout
29126 \change_inserted -970929547 1515111124
29134 ] Specifies attribute information to be output with the item wrapper tag,
29136 \begin_inset Quotes eld
29140 \begin_inset Flex Code
29143 \begin_layout Plain Layout
29145 \change_inserted -970929547 1515111150
29154 \begin_inset Quotes erd
29157 in the example above.
29158 This information can be used in further processing of the DocBook files.
29164 \begin_layout Description
29166 \change_inserted -970929547 1515111113
29167 \begin_inset Flex Code
29170 \begin_layout Plain Layout
29172 \change_inserted -970929547 1515111073
29173 DocBookItemWrapperTag
29181 \begin_inset Flex Code
29184 \begin_layout Plain Layout
29186 \change_inserted -970929547 1515111073
29194 ] The tag to be used for the item wrapper tag within the inset, replacing
29196 \begin_inset Quotes eld
29200 \begin_inset Flex Code
29203 \begin_layout Plain Layout
29205 \change_inserted -970929547 1515111083
29214 \begin_inset Quotes erd
29217 in the example above.
29219 \begin_inset Flex Code
29222 \begin_layout Plain Layout
29224 \change_inserted -970929547 1515111073
29232 , indicating that there is no item wrapper tag: tag and content are directly
29233 output without it for each itemised element.
29234 This parameter only makes sense when itemising layouts are used, such as
29237 \change_inserted 1075283030 1597699897
29241 \begin_layout Description
29243 \change_inserted 1075283030 1597699897
29244 \begin_inset Flex Code
29247 \begin_layout Plain Layout
29249 \change_inserted 1075283030 1597699900
29250 DocBookItemWrapperTagType
29258 \begin_inset Flex Code
29261 \begin_layout Plain Layout
29263 \change_inserted 1075283030 1597699897
29264 block, paragraph, inline
29271 ] The new-line policy for this tag, see Section
29272 \begin_inset space ~
29276 \begin_inset CommandInset ref
29278 reference "subsec:DocBook-New-line-policy"
29291 \begin_layout Description
29293 \change_inserted -970929547 1515110104
29294 \begin_inset Flex Code
29297 \begin_layout Plain Layout
29299 \change_inserted -970929547 1515110104
29308 \begin_inset Flex Code
29311 \begin_layout Plain Layout
29313 \change_inserted -970929547 1515110104
29321 ] Specifies attribute information to be output with the inner tag, replacing
29323 \begin_inset Quotes eld
29327 \begin_inset Flex Code
29330 \begin_layout Plain Layout
29332 \change_inserted -970929547 1515110104
29341 \begin_inset Quotes erd
29344 in the example above.
29345 This information can be used in further processing of the DocBook files.
29349 \begin_layout Description
29351 \change_inserted -970929547 1515110906
29352 \begin_inset Flex Code
29355 \begin_layout Plain Layout
29357 \change_inserted -970929547 1515110104
29366 \begin_inset Flex Code
29369 \begin_layout Plain Layout
29371 \change_inserted -970929547 1515110104
29379 ] The tag to be used for the inner tag within the inset, replacing
29380 \begin_inset Quotes eld
29384 \begin_inset Flex Code
29387 \begin_layout Plain Layout
29389 \change_inserted -970929547 1515110104
29398 \begin_inset Quotes erd
29401 in the example above.
29403 \begin_inset Flex Code
29406 \begin_layout Plain Layout
29408 \change_inserted -970929547 1515110791
29416 , indicating that there is no inner tag: content is directly output without
29418 \change_inserted 1075283030 1597699904
29422 \begin_layout Description
29424 \change_inserted 1075283030 1597699904
29425 \begin_inset Flex Code
29428 \begin_layout Plain Layout
29430 \change_inserted 1075283030 1597699904
29431 DocBookInnerTagType
29439 \begin_inset Flex Code
29442 \begin_layout Plain Layout
29444 \change_inserted 1075283030 1597699904
29445 block, paragraph, inline
29452 ] The new-line policy for this tag, see Section
29453 \begin_inset space ~
29457 \begin_inset CommandInset ref
29459 reference "subsec:DocBook-New-line-policy"
29472 \begin_layout Description
29474 \change_inserted -970929547 1515110753
29475 \begin_inset Flex Code
29478 \begin_layout Plain Layout
29480 \change_inserted -970929547 1515110665
29489 \begin_inset Flex Code
29492 \begin_layout Plain Layout
29494 \change_inserted -970929547 1515110661
29502 ] Specifies the tag that corresponds to this kind of section.
29503 This parameter only makes sense for sectioning elements (part, chapter,
29505 The default value is
29506 \begin_inset Flex Code
29509 \begin_layout Plain Layout
29511 \change_inserted -970929547 1515110721
29519 , and is only overridden when DocBook uses something else for sectioning
29521 \change_inserted 1075283030 1597699921
29523 \change_inserted -970929547 1515110753
29524 parts and chapters of a book).
29530 \begin_layout Description
29532 \change_inserted -970929547 1515110811
29533 \begin_inset Flex Code
29536 \begin_layout Plain Layout
29538 \change_inserted -970929547 1496612023
29547 \begin_inset Flex Code
29550 \begin_layout Plain Layout
29552 \change_inserted -970929547 1496610966
29560 ] The tag to be used for this inset, replacing
29561 \begin_inset Quotes eld
29565 \begin_inset Flex Code
29568 \begin_layout Plain Layout
29570 \change_inserted -970929547 1496612033
29579 \begin_inset Quotes erd
29582 in the example above.
29583 The default is the name of the float and always needs to be changed, as
29584 DocBook provides no generic inset tag.
29585 \change_inserted 1075283030 1597699924
29589 \begin_layout Description
29591 \change_inserted 1075283030 1597699924
29592 \begin_inset Flex Code
29595 \begin_layout Plain Layout
29597 \change_inserted 1075283030 1597699924
29606 \begin_inset Flex Code
29609 \begin_layout Plain Layout
29611 \change_inserted 1075283030 1597699924
29612 block, paragraph, inline
29619 ] The new-line policy for this tag, see Section
29620 \begin_inset space ~
29624 \begin_inset CommandInset ref
29626 reference "subsec:DocBook-New-line-policy"
29639 \begin_layout Description
29641 \change_inserted -970929547 1515110832
29642 \begin_inset Flex Code
29645 \begin_layout Plain Layout
29647 \change_inserted -970929547 1515110822
29656 \begin_inset Flex Code
29659 \begin_layout Plain Layout
29661 \change_inserted -970929547 1515110811
29669 ] Specifies attribute information to be output with the outer tag, replacing
29671 \begin_inset Quotes eld
29675 \begin_inset Flex Code
29678 \begin_layout Plain Layout
29680 \change_inserted -970929547 1515110845
29689 \begin_inset Quotes erd
29692 in the example above.
29693 This information can be used in further processing of the DocBook files.
29697 \begin_layout Description
29699 \change_inserted -970929547 1515110917
29700 \begin_inset Flex Code
29703 \begin_layout Plain Layout
29705 \change_inserted -970929547 1515110826
29714 \begin_inset Flex Code
29717 \begin_layout Plain Layout
29719 \change_inserted -970929547 1515110811
29727 ] The tag to be used for the wrapper tag around the inset, replacing
29728 \begin_inset Quotes eld
29732 \begin_inset Flex Code
29735 \begin_layout Plain Layout
29737 \change_inserted -970929547 1515110842
29746 \begin_inset Quotes erd
29749 in the example above.
29751 \begin_inset Flex Code
29754 \begin_layout Plain Layout
29756 \change_inserted -970929547 1515110811
29764 , indicating that there is no wrapper tag: tag and content are directly
29766 \change_inserted 1075283030 1597699929
29770 \begin_layout Description
29772 \change_inserted 1075283030 1597699929
29773 \begin_inset Flex Code
29776 \begin_layout Plain Layout
29778 \change_inserted 1075283030 1597699932
29779 DocBookWrapperTagType
29787 \begin_inset Flex Code
29790 \begin_layout Plain Layout
29792 \change_inserted 1075283030 1597699929
29793 block, paragraph, inline
29800 ] The new-line policy for this tag, see Section
29801 \begin_inset space ~
29805 \begin_inset CommandInset ref
29807 reference "subsec:DocBook-New-line-policy"
29820 \begin_layout Subsection
29822 \change_inserted -970929547 1515110040
29826 \begin_layout Standard
29828 \change_inserted -970929547 1496611700
29829 The DocBook output for floats too can be controlled by layout information.
29830 The output has the following form:
29833 \begin_layout LyX-Code
29835 \change_inserted -970929547 1515109700
29839 \begin_layout LyX-Code
29841 \change_inserted -970929547 1515110138
29842 Contents of the float as DocBook.
29845 \begin_layout LyX-Code
29847 \change_inserted -970929547 1496610966
29851 \begin_layout Standard
29853 \change_inserted -970929547 1496611715
29854 The caption, if there is one, is a separate inset and will be output as
29859 \begin_layout Description
29861 \change_inserted -970929547 1515110033
29862 \begin_inset Flex Code
29865 \begin_layout Plain Layout
29867 \change_inserted -970929547 1515109702
29876 \begin_inset Flex Code
29879 \begin_layout Plain Layout
29881 \change_inserted -970929547 1496610966
29889 ] Specifies attribute information to be output with the main tag, replacing
29891 \begin_inset Quotes eld
29895 \begin_inset Flex Code
29898 \begin_layout Plain Layout
29900 \change_inserted -970929547 1515110035
29909 \begin_inset Quotes erd
29912 in the example above.
29913 This information can be used in further processing of the DocBook files.
29917 \begin_layout Description
29919 \change_inserted -970929547 1515110157
29920 \begin_inset Flex Code
29923 \begin_layout Plain Layout
29925 \change_inserted -970929547 1496611782
29934 \begin_inset Flex Code
29937 \begin_layout Plain Layout
29939 \change_inserted -970929547 1496610966
29947 ] The tag to be used for this float, replacing
29948 \begin_inset Quotes eld
29952 \begin_inset Flex Code
29955 \begin_layout Plain Layout
29957 \change_inserted -970929547 1496610966
29966 \begin_inset Quotes erd
29969 in the example above.
29970 The default is the name of the float and always needs to be changed, as
29971 DocBook provides no generic float tag.
29974 \begin_layout Subsection
29976 \change_inserted -970929547 1515110157
29977 Bibliography formatting
29980 \begin_layout Standard
29982 \change_deleted 1075283030 1597699984
29984 \change_inserted 1075283030 1597699985
29986 \change_inserted -970929547 1515110187
29988 \change_deleted 1075283030 1597699987
29990 \change_inserted 1075283030 1597699987
29992 \change_inserted -970929547 1515110187
29993 cannot be formatted: all fields are always output in the database-like
29994 DocBook format (equivalent to a BibTeX file)
29995 \change_inserted 1075283030 1597700117
29997 \begin_inset Flex Code
30000 \begin_layout Plain Layout
30002 \change_inserted 1075283030 1597700120
30011 \change_inserted -970929547 1515110187
30013 \change_inserted 1075283030 1597700092
30017 \begin_layout Standard
30019 \change_inserted 1075283030 1597700112
30020 When the bibliographic entries are manually inserted into the LyX document
30021 as Bibliography Items, the user deals with formatting themself: there is
30022 no attempt of parsing what the user wrote, the string is directly used
30024 \begin_inset Flex Code
30027 \begin_layout Plain Layout
30029 \change_inserted 1075283030 1597700076
30043 \begin_layout Chapter
30044 Including External Material
30045 \begin_inset CommandInset label
30047 name "chap:Including-External-Material"
30054 \begin_layout Standard
30055 \begin_inset Box Shadowbox
30065 height_special "totalheight"
30070 backgroundcolor "none"
30073 \begin_layout Plain Layout
30074 WARNING: This portion of the documentation has not been updated for some
30076 We certainly hope that it is still accurate, but there are no guarantees.
30084 \begin_layout Standard
30085 The use of material from sources external to \SpecialChar LyX
30086 is covered in detail in the
30092 This part of the manual covers what needs to happen behind the scenes for
30093 new sorts of material to be included.
30096 \begin_layout Section
30100 \begin_layout Standard
30101 The external material feature is based on the concept of a
30106 A template is a specification of how \SpecialChar LyX
30107 should interface with a certain kind
30109 As bundled, \SpecialChar LyX
30110 comes with predefined templates for Xfig figures, various
30111 raster format images, chess diagrams, and LilyPond music notation.
30112 You can check the actual list by using the menu
30113 \begin_inset Flex Noun
30116 \begin_layout Plain Layout
30117 Insert\SpecialChar menuseparator
30118 File\SpecialChar menuseparator
30125 Furthermore, it is possible to roll your own template to support a specific
30127 Later we'll describe in more detail what is involved, and hopefully you
30128 will submit all the templates you create so we can include them in a later
30133 \begin_layout Standard
30134 Another basic idea of the external material feature is to distinguish between
30135 the original file that serves as a base for final material and the produced
30136 file that is included in your exported or printed document.
30137 For example, consider the case of a figure produced with
30138 \begin_inset Flex Code
30141 \begin_layout Plain Layout
30148 The Xfig application itself works on an original file with the
30149 \begin_inset Flex Code
30152 \begin_layout Plain Layout
30159 Within Xfig, you create and change your figure, and when you are done,
30161 \begin_inset Flex Code
30164 \begin_layout Plain Layout
30171 When you want to include the figure in your document, you invoke
30172 \begin_inset Flex Code
30175 \begin_layout Plain Layout
30181 in order to create a PostScript file that can readily be included in your
30185 \begin_inset Flex Code
30188 \begin_layout Plain Layout
30194 file is the original file, and the PostScript file is the produced file.
30197 \begin_layout Standard
30198 This distinction is important in order to allow updating of the material
30199 while you are in the process of writing the document.
30200 Furthermore, it provides us with the flexibility that is needed to support
30201 multiple export formats.
30202 For instance, in the case of a plain text file, it is not exactly an award-winn
30203 ing idea to include the figure as raw PostScript.
30204 Instead, you would either prefer to just include a reference to the figure
30205 or try to invoke some graphics to ASCII converter to make the final result
30206 look similar to the real graphics.
30207 The external material management allows you to do this, because it is parametri
30208 zed on the different export formats that \SpecialChar LyX
30212 \begin_layout Standard
30213 Besides supporting the production of different products according to the
30214 exported format, it supports tight integration with editing and viewing
30216 In the case of an Xfig figure, you are able to invoke Xfig on the original
30217 file with a single click from within the external material dialog in \SpecialChar LyX
30219 and also preview the produced PostScript file with Ghostview with another
30221 No more fiddling around with the command line and/or file browsers to locate
30222 and manipulate the original or produced files.
30223 In this way, you are finally able to take full advantage of the many different
30224 applications that are relevant to use when you write your documents, and
30225 ultimately be more productive.
30228 \begin_layout Section
30229 The external template configuration files
30232 \begin_layout Standard
30233 It is relatively easy to add custom external template definitions to \SpecialChar LyX
30235 However, be aware that doing this in an careless manner most probably
30239 introduce an easily exploitable security hole.
30240 So before you do this, please read the discussion about security in
30241 \begin_inset CommandInset ref
30243 reference "sec:Security-discussion"
30250 \begin_layout Standard
30251 Having said that, we encourage you to submit any interesting templates that
30256 \begin_layout Standard
30257 The external templates are defined in the
30258 \begin_inset Flex Code
30261 \begin_layout Plain Layout
30267 files that are stored in the
30268 \begin_inset Flex Code
30271 \begin_layout Plain Layout
30272 LyXDir/lib/xtemplates/
30278 Each template is defined in a file of its own.
30279 You can place your own templates in
30280 \begin_inset Flex Code
30283 \begin_layout Plain Layout
30284 UserDir/xtemplates/
30289 or copy existing templates to that directory in order to modify them.
30292 \begin_layout Standard
30293 A typical template looks like this:
30296 \begin_layout LyX-Code
30300 \begin_layout LyX-Code
30301 GuiName "XFig: $$AbsOrRelPathParent$$Basename"
30304 \begin_layout LyX-Code
30308 \begin_layout LyX-Code
30312 \begin_layout LyX-Code
30316 \begin_layout LyX-Code
30320 \begin_layout LyX-Code
30324 \begin_layout LyX-Code
30325 AutomaticProduction true
30328 \begin_layout LyX-Code
30332 \begin_layout LyX-Code
30336 \begin_layout LyX-Code
30340 \begin_layout LyX-Code
30341 TransformCommand Rotate RotationLatexCommand
30344 \begin_layout LyX-Code
30345 TransformCommand Resize ResizeLatexCommand
30348 \begin_layout LyX-Code
30349 Product "$$RotateFront$$ResizeFront
30352 \begin_layout LyX-Code
30357 input{$$AbsOrRelPathMaster$$Basename.pstex_t}
30360 \begin_layout LyX-Code
30361 $$ResizeBack$$RotateBack"
30364 \begin_layout LyX-Code
30368 \begin_layout LyX-Code
30369 UpdateResult "$$AbsPath$$Basename.pstex_t"
30372 \begin_layout LyX-Code
30373 Requirement "graphicx"
30376 \begin_layout LyX-Code
30377 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
30380 \begin_layout LyX-Code
30381 ReferencedFile latex "$$AbsPath$$Basename.eps"
30384 \begin_layout LyX-Code
30385 ReferencedFile dvi "$$AbsPath$$Basename.eps"
30388 \begin_layout LyX-Code
30392 \begin_layout LyX-Code
30396 \begin_layout LyX-Code
30397 TransformCommand Rotate RotationLatexCommand
30400 \begin_layout LyX-Code
30401 TransformCommand Resize ResizeLatexCommand
30404 \begin_layout LyX-Code
30405 Product "$$RotateFront$$ResizeFront
30408 \begin_layout LyX-Code
30413 input{$$AbsOrRelPathMaster$$Basename.pdftex_t}
30416 \begin_layout LyX-Code
30417 $$ResizeBack$$RotateBack"
30420 \begin_layout LyX-Code
30421 UpdateFormat pdftex
30424 \begin_layout LyX-Code
30425 UpdateResult "$$AbsPath$$Basename.pdftex_t"
30428 \begin_layout LyX-Code
30429 Requirement "graphicx"
30432 \begin_layout LyX-Code
30433 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pdftex_t"
30436 \begin_layout LyX-Code
30437 ReferencedFile latex "$$AbsPath$$Basename.pdf"
30440 \begin_layout LyX-Code
30444 \begin_layout LyX-Code
30448 \begin_layout LyX-Code
30449 Product "[XFig: $$FName]"
30452 \begin_layout LyX-Code
30456 \begin_layout LyX-Code
30460 \begin_layout LyX-Code
30461 Product "<graphic fileref=
30463 "$$AbsOrRelPathMaster$$Basename.eps
30468 \begin_layout LyX-Code
30472 \begin_layout LyX-Code
30476 \begin_layout LyX-Code
30477 UpdateResult "$$AbsPath$$Basename.eps"
30480 \begin_layout LyX-Code
30481 ReferencedFile docbook "$$AbsPath$$Basename.eps"
30484 \begin_layout LyX-Code
30485 ReferencedFile docbook-xml "$$AbsPath$$Basename.eps"
30488 \begin_layout LyX-Code
30492 \begin_layout LyX-Code
30496 \begin_layout Standard
30497 As you can see, the template is enclosed in
30498 \begin_inset Flex Code
30501 \begin_layout Plain Layout
30509 \begin_inset Flex Code
30512 \begin_layout Plain Layout
30519 It contains a header specifying some general settings and, for each supported
30520 primary document file format, a section
30521 \begin_inset Flex Code
30524 \begin_layout Plain Layout
30532 \begin_inset Flex Code
30535 \begin_layout Plain Layout
30544 \begin_layout Subsection
30545 The template header
30548 \begin_layout Description
30549 \begin_inset Flex Code
30552 \begin_layout Plain Layout
30553 AutomaticProduction
30554 \begin_inset space ~
30562 Whether the file represented by the template must be generated by \SpecialChar LyX
30564 This command must occur exactly once.
30567 \begin_layout Description
30568 \begin_inset Flex Code
30571 \begin_layout Plain Layout
30573 \begin_inset space ~
30581 A glob pattern that is used in the file dialog to filter out the desired
30583 If there is more than one possible file extension (e.
30584 \begin_inset space \thinspace{}
30588 \begin_inset space \space{}
30592 \begin_inset Flex Code
30595 \begin_layout Plain Layout
30602 \begin_inset Flex Code
30605 \begin_layout Plain Layout
30611 ), use something like
30612 \begin_inset Flex Code
30615 \begin_layout Plain Layout
30622 This command must occur exactly once.
30625 \begin_layout Description
30626 \begin_inset Flex Code
30629 \begin_layout Plain Layout
30631 \begin_inset space ~
30639 The text that is displayed on the button.
30640 This command must occur exactly once.
30643 \begin_layout Description
30644 \begin_inset Flex Code
30647 \begin_layout Plain Layout
30649 \begin_inset space ~
30653 \begin_inset space ~
30661 The help text that is used in the External dialog.
30662 Provide enough information to explain to the user just what the template
30663 can provide him with.
30664 This command must occur exactly once.
30667 \begin_layout Description
30668 \begin_inset Flex Code
30671 \begin_layout Plain Layout
30673 \begin_inset space ~
30681 The file format of the original file.
30682 This must be the name of a format that is known to \SpecialChar LyX
30684 \begin_inset CommandInset ref
30686 reference "sec:Formats"
30692 \begin_inset Quotes eld
30696 \begin_inset Flex Code
30699 \begin_layout Plain Layout
30706 \begin_inset Quotes erd
30709 if the template can handle original files of more than one format.
30711 will attempt to interrogate the file itself in order to deduce its format
30713 This command must occur exactly once.
30716 \begin_layout Description
30717 \begin_inset Flex Code
30720 \begin_layout Plain Layout
30722 \begin_inset space ~
30730 A unique name for the template.
30731 It must not contain substitution macros (see below).
30734 \begin_layout Description
30735 \begin_inset Flex Code
30738 \begin_layout Plain Layout
30740 \begin_inset space ~
30743 Rotate|Resize|Clip|Extra
30748 This command specifies which transformations are supported by this template.
30749 It may occur zero or more times.
30750 This command enables the corresponding tabs in the external dialog.
30752 \begin_inset Flex Code
30755 \begin_layout Plain Layout
30761 command must have either a corresponding
30762 \begin_inset Flex Code
30765 \begin_layout Plain Layout
30772 \begin_inset Flex Code
30775 \begin_layout Plain Layout
30782 \begin_inset Flex Code
30785 \begin_layout Plain Layout
30792 Otherwise the transformation will not be supported by that format.
30795 \begin_layout Subsection
30799 \begin_layout Description
30800 \begin_inset Flex Code
30803 \begin_layout Plain Layout
30805 \begin_inset space ~
30808 LaTeX|PDFLaTeX|PlainText|DocBook|XHTML
30813 The primary document file format that this format definition is for.
30814 Not every template has a sensible representation in all document file formats.
30815 Please define nevertheless a
30816 \begin_inset Flex Code
30819 \begin_layout Plain Layout
30825 section for all templates.
30826 Use a dummy text when no representation is available.
30827 Then you can at least see a reference to the external material in the exported
30831 \begin_layout Description
30832 \begin_inset Flex Code
30835 \begin_layout Plain Layout
30837 \begin_inset space ~
30841 \begin_inset space ~
30849 This command defines an additional macro
30850 \begin_inset Flex Code
30853 \begin_layout Plain Layout
30859 for substitution in
30860 \begin_inset Flex Code
30863 \begin_layout Plain Layout
30871 \begin_inset Flex Code
30874 \begin_layout Plain Layout
30880 itself may contain substitution macros.
30881 The advantage over using
30882 \begin_inset Flex Code
30885 \begin_layout Plain Layout
30892 \begin_inset Flex Code
30895 \begin_layout Plain Layout
30901 is that the substituted value of
30902 \begin_inset Flex Code
30905 \begin_layout Plain Layout
30911 is sanitized so that it is a valid optional argument in the document format.
30912 This command may occur zero or more times.
30915 \begin_layout Description
30916 \begin_inset Flex Code
30919 \begin_layout Plain Layout
30921 \begin_inset space ~
30929 The text that is inserted in the exported document.
30930 This is actually the most important command and can be quite complex.
30931 This command must occur exactly once.
30934 \begin_layout Description
30935 \begin_inset Flex Code
30938 \begin_layout Plain Layout
30940 \begin_inset space ~
30948 This command specifies a preamble snippet that will be included in the
30951 It has to be defined using
30952 \begin_inset Flex Code
30955 \begin_layout Plain Layout
30963 \begin_inset Flex Code
30966 \begin_layout Plain Layout
30973 This command may occur zero or more times.
30976 \begin_layout Description
30977 \begin_inset Flex Code
30980 \begin_layout Plain Layout
30982 \begin_inset space ~
30986 \begin_inset space ~
30994 This command denotes files that are created by the conversion process and
30995 are needed for a particular export format.
30996 If the filename is relative, it is interpreted relative to the master document.
30997 This command may be given zero or more times.
31000 \begin_layout Description
31001 \begin_inset Flex Code
31004 \begin_layout Plain Layout
31006 \begin_inset space ~
31014 The name of a required \SpecialChar LaTeX
31016 The package is included via
31017 \begin_inset Flex Code
31020 \begin_layout Plain Layout
31028 in the \SpecialChar LaTeX
31030 This command may occur zero or more times.
31033 \begin_layout Description
31034 \begin_inset Flex Code
31037 \begin_layout Plain Layout
31039 \begin_inset space ~
31043 \begin_inset space ~
31046 RotationLatexCommand
31051 This command specifies that the built in \SpecialChar LaTeX
31052 command should be used for rotation.
31053 This command may occur once or not at all.
31056 \begin_layout Description
31057 \begin_inset Flex Code
31060 \begin_layout Plain Layout
31062 \begin_inset space ~
31066 \begin_inset space ~
31074 This command specifies that the built in \SpecialChar LaTeX
31075 command should be used for resizing.
31076 This command may occur once or not at all.
31079 \begin_layout Description
31080 \begin_inset Flex Code
31083 \begin_layout Plain Layout
31085 \begin_inset space ~
31089 \begin_inset space ~
31092 RotationLatexOption
31097 This command specifies that rotation is done via an optional argument.
31098 This command may occur once or not at all.
31101 \begin_layout Description
31102 \begin_inset Flex Code
31105 \begin_layout Plain Layout
31107 \begin_inset space ~
31111 \begin_inset space ~
31119 This command specifies that resizing is done via an optional argument.
31120 This command may occur once or not at all.
31123 \begin_layout Description
31124 \begin_inset Flex Code
31127 \begin_layout Plain Layout
31129 \begin_inset space ~
31133 \begin_inset space ~
31141 This command specifies that clipping is done via an optional argument.
31142 This command may occur once or not at all.
31145 \begin_layout Description
31146 \begin_inset Flex Code
31149 \begin_layout Plain Layout
31151 \begin_inset space ~
31155 \begin_inset space ~
31163 This command specifies that an extra optional argument is used.
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 ~
31181 The file format of the converted file.
31182 This must be the name of a format that is known to \SpecialChar LyX
31184 \begin_inset Flex Noun
31187 \begin_layout Plain Layout
31188 Tools\SpecialChar menuseparator
31189 Preferences\SpecialChar menuseparator
31190 File Handling\SpecialChar menuseparator
31197 This command must occur exactly once.
31198 If the resulting file format is PDF, you need to specify the format
31199 \begin_inset Flex Code
31202 \begin_layout Plain Layout
31209 This is the PDF format used for including graphics.
31210 The other defined PDF formats are for document export.
31213 \begin_layout Description
31214 \begin_inset Flex Code
31217 \begin_layout Plain Layout
31219 \begin_inset space ~
31227 The file name of the converted file.
31228 The file name must be absolute.
31229 This command must occur exactly once.
31232 \begin_layout Subsection
31233 Preamble definitions
31236 \begin_layout Standard
31237 The external template configuration file may contain additional preamble
31238 definitions enclosed by
31239 \begin_inset Flex Code
31242 \begin_layout Plain Layout
31250 \begin_inset Flex Code
31253 \begin_layout Plain Layout
31260 They can be used by the templates in the
31261 \begin_inset Flex Code
31264 \begin_layout Plain Layout
31273 \begin_layout Section
31274 The substitution mechanism
31277 \begin_layout Standard
31278 When the external material facility invokes an external program, it is done
31279 on the basis of a command defined in the template configuration file.
31280 These commands can contain various macros that are expanded before execution.
31281 Execution always take place in the directory of the containing document.
31284 \begin_layout Standard
31285 Also, whenever external material is to be displayed, the name will be produced
31286 by the substitution mechanism, and most other commands in the template
31287 definition support substitution as well.
31290 \begin_layout Standard
31291 The available macros are the following:
31294 \begin_layout Description
31295 \begin_inset Flex Code
31298 \begin_layout Plain Layout
31299 $$AbsOrRelPathMaster
31304 The file path, absolute or relative to the master \SpecialChar LyX
31308 \begin_layout Description
31309 \begin_inset Flex Code
31312 \begin_layout Plain Layout
31313 $$AbsOrRelPathParent
31318 The file path, absolute or relative to the \SpecialChar LyX
31322 \begin_layout Description
31323 \begin_inset Flex Code
31326 \begin_layout Plain Layout
31332 The absolute file path.
31335 \begin_layout Description
31336 \begin_inset Flex Code
31339 \begin_layout Plain Layout
31345 The filename without path and without the extension.
31348 \begin_layout Description
31349 \begin_inset Flex Code
31352 \begin_layout Plain Layout
31354 \begin_inset Quotes eld
31358 \begin_inset Quotes erd
31366 This macro will expand to the contents of the file with the name
31367 \begin_inset Flex Code
31370 \begin_layout Plain Layout
31379 \begin_layout Description
31380 \begin_inset Flex Code
31383 \begin_layout Plain Layout
31389 The file extension (including the dot).
31392 \begin_layout Description
31393 \begin_inset Flex Code
31396 \begin_layout Plain Layout
31402 This will be the string
31403 \begin_inset Quotes eld
31407 \begin_inset Quotes erd
31410 if the file is in JPEG format, otherwise it will be the string
31411 \begin_inset Quotes eld
31415 \begin_inset Quotes erd
31419 This is useful to avoid uneeded conversions for output formats that support
31420 both PNG and JPEG fomats.
31421 The predefined RasterImage template uses this macro for the pdf\SpecialChar TeX
31426 \begin_layout Description
31427 \begin_inset Flex Code
31430 \begin_layout Plain Layout
31436 The filename of the file specified in the external material dialog.
31437 This is either an absolute name, or it is relative to the \SpecialChar LyX
31441 \begin_layout Description
31442 \begin_inset Flex Code
31445 \begin_layout Plain Layout
31452 \begin_inset Flex Code
31455 \begin_layout Plain Layout
31461 (absolute name or relative to the \SpecialChar LyX
31465 \begin_layout Description
31466 \begin_inset Flex Code
31469 \begin_layout Plain Layout
31475 The file path, relative to the master \SpecialChar LyX
31479 \begin_layout Description
31480 \begin_inset Flex Code
31483 \begin_layout Plain Layout
31489 The file path, relative to the \SpecialChar LyX
31493 \begin_layout Description
31494 \begin_inset Flex Code
31497 \begin_layout Plain Layout
31503 This macro will expand to the absolute path of the system directory.
31504 This is typically used to point to the various helper scripts that are
31505 bundled with \SpecialChar LyX
31509 \begin_layout Description
31510 \begin_inset Flex Code
31513 \begin_layout Plain Layout
31519 A name and full path to a temporary file which will be automatically deleted
31520 whenever the containing document is closed, or the external material insertion
31524 \begin_layout Standard
31525 All path macros contain a trailing directory separator, so you can construct
31527 \begin_inset space \thinspace{}
31531 \begin_inset space \space{}
31534 the absolute filename with
31535 \begin_inset Flex Code
31538 \begin_layout Plain Layout
31539 $$AbsPath$$Basename$$Extension
31547 \begin_layout Standard
31548 The macros above are substituted in all commands unless otherwise noted.
31550 \begin_inset Flex Code
31553 \begin_layout Plain Layout
31559 supports additionally the following substitutions if they are enabled by
31561 \begin_inset Flex Code
31564 \begin_layout Plain Layout
31571 \begin_inset Flex Code
31574 \begin_layout Plain Layout
31583 \begin_layout Description
31584 \begin_inset Flex Code
31587 \begin_layout Plain Layout
31593 The front part of the resize command.
31596 \begin_layout Description
31597 \begin_inset Flex Code
31600 \begin_layout Plain Layout
31606 The back part of the resize command.
31609 \begin_layout Description
31610 \begin_inset Flex Code
31613 \begin_layout Plain Layout
31619 The front part of the rotation command.
31622 \begin_layout Description
31623 \begin_inset Flex Code
31626 \begin_layout Plain Layout
31632 The back part of the rotation command.
31635 \begin_layout Standard
31636 The value string of the
31637 \begin_inset Flex Code
31640 \begin_layout Plain Layout
31646 command supports additionally the following substitutions if they are enabled
31648 \begin_inset Flex Code
31651 \begin_layout Plain Layout
31658 \begin_inset Flex Code
31661 \begin_layout Plain Layout
31670 \begin_layout Description
31671 \begin_inset Flex Code
31674 \begin_layout Plain Layout
31683 \begin_layout Description
31684 \begin_inset Flex Code
31687 \begin_layout Plain Layout
31696 \begin_layout Description
31697 \begin_inset Flex Code
31700 \begin_layout Plain Layout
31709 \begin_layout Description
31710 \begin_inset Flex Code
31713 \begin_layout Plain Layout
31719 The rotation option.
31722 \begin_layout Standard
31723 You may ask why there are so many path macros.
31724 There are mainly two reasons:
31727 \begin_layout Enumerate
31728 Relative and absolute file names should remain relative or absolute, respectivel
31730 Users may have reasons to prefer either form.
31731 Relative names are useful for portable documents that should work on different
31732 machines, for example.
31733 Absolute names may be required by some programs.
31736 \begin_layout Enumerate
31738 treats relative file names differently than \SpecialChar LyX
31739 and other programs in nested
31741 For \SpecialChar LyX
31742 , a relative file name is always relative to the document that contains
31744 For \SpecialChar LaTeX
31745 , it is always relative to the master document.
31746 These two definitions are identical if you have only one document, but
31747 differ if you have a master document that includes part documents.
31748 That means that relative filenames must be transformed when presented to
31751 Fortunately \SpecialChar LyX
31752 does this automatically for you if you choose the right macros.
31755 \begin_layout Standard
31756 So which path macro should be used in new template definitions? The rule
31760 \begin_layout Itemize
31762 \begin_inset Flex Code
31765 \begin_layout Plain Layout
31771 if an absolute path is required.
31774 \begin_layout Itemize
31776 \begin_inset Flex Code
31779 \begin_layout Plain Layout
31780 $$AbsOrRelPathMaster
31785 if the substituted string is some kind of \SpecialChar LaTeX
31789 \begin_layout Itemize
31791 \begin_inset Flex Code
31794 \begin_layout Plain Layout
31795 $$AbsOrRelPathParent
31800 in order to preserve the user's choice.
31803 \begin_layout Standard
31804 There are special cases where this rule does not work and e.
31805 \begin_inset space \thinspace{}
31809 \begin_inset space \space{}
31812 relative names are needed, but normally it will work just fine.
31813 One example for such a case is the command
31814 \begin_inset Flex Code
31817 \begin_layout Plain Layout
31818 ReferencedFile latex "$$AbsOrRelPathMaster$$Basename.pstex_t"
31823 in the XFig template above: We can't use the absolute name because the
31825 \begin_inset Flex Code
31828 \begin_layout Plain Layout
31834 files needs the relative name in order to rewrite the file content.
31837 \begin_layout Section
31838 Security discussion
31839 \begin_inset CommandInset label
31841 name "sec:Security-discussion"
31848 \begin_layout Standard
31849 The external material feature interfaces with a lot of external programs
31850 and does so automatically, so we have to consider the security implications
31852 In particular, since you have the option of including your own filenames
31853 and/or parameter strings and those are expanded into a command, it seems
31854 that it would be possible to create a malicious document which executes
31855 arbitrary commands when a user views or prints the document.
31856 This is something we definitely want to avoid.
31859 \begin_layout Standard
31860 However, since the external program commands are specified in the template
31861 configuration file only, there are no security issues if \SpecialChar LyX
31862 is properly configure
31863 d with safe templates only.
31864 This is so because the external programs are invoked with the
31865 \begin_inset Flex Code
31868 \begin_layout Plain Layout
31874 -system call rather than the
31875 \begin_inset Flex Code
31878 \begin_layout Plain Layout
31884 system-call, so it's not possible to execute arbitrary commands from the
31885 filename or parameter section via the shell.
31888 \begin_layout Standard
31889 This also implies that you are restricted in what command strings you can
31890 use in the external material templates.
31891 In particular, pipes and redirection are not readily available.
31892 This has to be so if \SpecialChar LyX
31893 should remain safe.
31894 If you want to use some of the shell features, you should write a safe
31895 script to do this in a controlled manner, and then invoke the script from
31896 the command string.
31900 \begin_layout Standard
31901 It is possible to design a template that interacts directly with the shell,
31902 but since this would allow a malicious user to execute arbitrary commands
31903 by writing clever filenames and/or parameters, we generally recommend that
31904 you only use safe scripts that work with the
31905 \begin_inset Flex Code
31908 \begin_layout Plain Layout
31914 system call in a controlled manner.
31915 Of course, for use in a controlled environment, it can be tempting to just
31916 fall back to use ordinary shell scripts.
31917 If you do so, be aware that you
31921 provide an easily exploitable security hole in your system.
31922 Of course it stands to reason that such unsafe templates will never be
31923 included in the standard \SpecialChar LyX
31924 distribution, although we do encourage people
31925 to submit new templates in the open source tradition.
31926 But \SpecialChar LyX
31927 as shipped from the official distribution channels will never have
31931 \begin_layout Standard
31932 Including external material provides a lot of power, and you have to be
31933 careful not to introduce security hazards with this power.
31934 A subtle error in a single line in an innocent looking script can open
31935 the door to huge security problems.
31936 So if you do not fully understand the issues, we recommend that you consult
31937 a knowledgeable security professional or the \SpecialChar LyX
31938 development team if you have
31939 any questions about whether a given template is safe or not.
31940 And do this before you use it in an uncontrolled environment.
31943 \begin_layout Chapter
31945 List of supported \SpecialChar LyX
31946 functions to be used in layouts
31947 \begin_inset CommandInset label
31949 name "chap:List-of-functions"
31956 \begin_layout Standard
31958 \begin_inset Tabular
31959 <lyxtabular version="3" rows="11" columns="8">
31960 <features tabularvalignment="middle">
31961 <column alignment="left" valignment="top">
31962 <column alignment="left" valignment="top">
31963 <column alignment="left" valignment="top">
31964 <column alignment="left" valignment="top">
31965 <column alignment="left" valignment="top">
31966 <column alignment="left" valignment="top">
31967 <column alignment="left" valignment="top">
31968 <column alignment="left" valignment="top">
31970 <cell alignment="left" valignment="top" usebox="none">
31973 \begin_layout Plain Layout
31979 <cell alignment="left" valignment="top" usebox="none">
31982 \begin_layout Plain Layout
31988 <cell alignment="left" valignment="top" usebox="none">
31991 \begin_layout Plain Layout
31997 <cell alignment="left" valignment="top" usebox="none">
32000 \begin_layout Plain Layout
32006 <cell alignment="center" valignment="top" usebox="none">
32009 \begin_layout Plain Layout
32015 <cell alignment="center" valignment="top" usebox="none">
32018 \begin_layout Plain Layout
32024 <cell alignment="center" valignment="top" usebox="none">
32027 \begin_layout Plain Layout
32033 <cell alignment="center" valignment="top" usebox="none">
32036 \begin_layout Plain Layout
32044 <cell alignment="left" valignment="top" usebox="none">
32047 \begin_layout Plain Layout
32053 <cell alignment="left" valignment="top" usebox="none">
32056 \begin_layout Plain Layout
32062 <cell alignment="left" valignment="top" usebox="none">
32065 \begin_layout Plain Layout
32071 <cell alignment="left" valignment="top" usebox="none">
32074 \begin_layout Plain Layout
32080 <cell alignment="center" valignment="top" usebox="none">
32083 \begin_layout Plain Layout
32089 <cell alignment="center" valignment="top" usebox="none">
32092 \begin_layout Plain Layout
32098 <cell alignment="center" valignment="top" usebox="none">
32101 \begin_layout Plain Layout
32107 <cell alignment="center" valignment="top" usebox="none">
32110 \begin_layout Plain Layout
32118 <cell alignment="left" valignment="top" usebox="none">
32121 \begin_layout Plain Layout
32127 <cell alignment="left" valignment="top" usebox="none">
32130 \begin_layout Plain Layout
32136 <cell alignment="left" valignment="top" usebox="none">
32139 \begin_layout Plain Layout
32145 <cell alignment="left" valignment="top" usebox="none">
32148 \begin_layout Plain Layout
32154 <cell alignment="center" valignment="top" usebox="none">
32157 \begin_layout Plain Layout
32163 <cell alignment="center" valignment="top" usebox="none">
32166 \begin_layout Plain Layout
32172 <cell alignment="center" valignment="top" usebox="none">
32175 \begin_layout Plain Layout
32181 <cell alignment="center" valignment="top" usebox="none">
32184 \begin_layout Plain Layout
32192 <cell alignment="left" valignment="top" usebox="none">
32195 \begin_layout Plain Layout
32201 <cell alignment="left" valignment="top" usebox="none">
32204 \begin_layout Plain Layout
32210 <cell alignment="left" valignment="top" usebox="none">
32213 \begin_layout Plain Layout
32219 <cell alignment="left" valignment="top" usebox="none">
32222 \begin_layout Plain Layout
32228 <cell alignment="center" valignment="top" usebox="none">
32231 \begin_layout Plain Layout
32237 <cell alignment="center" valignment="top" usebox="none">
32240 \begin_layout Plain Layout
32246 <cell alignment="center" valignment="top" usebox="none">
32249 \begin_layout Plain Layout
32255 <cell alignment="center" valignment="top" usebox="none">
32258 \begin_layout Plain Layout
32266 <cell alignment="left" valignment="top" usebox="none">
32269 \begin_layout Plain Layout
32275 <cell alignment="left" valignment="top" usebox="none">
32278 \begin_layout Plain Layout
32284 <cell alignment="left" valignment="top" usebox="none">
32287 \begin_layout Plain Layout
32293 <cell alignment="left" valignment="top" usebox="none">
32296 \begin_layout Plain Layout
32302 <cell alignment="center" valignment="top" usebox="none">
32305 \begin_layout Plain Layout
32311 <cell alignment="center" valignment="top" usebox="none">
32314 \begin_layout Plain Layout
32320 <cell alignment="center" valignment="top" usebox="none">
32323 \begin_layout Plain Layout
32329 <cell alignment="center" valignment="top" usebox="none">
32332 \begin_layout Plain Layout
32340 <cell alignment="left" valignment="top" usebox="none">
32343 \begin_layout Plain Layout
32349 <cell alignment="left" valignment="top" usebox="none">
32352 \begin_layout Plain Layout
32358 <cell alignment="left" valignment="top" usebox="none">
32361 \begin_layout Plain Layout
32367 <cell alignment="left" valignment="top" usebox="none">
32370 \begin_layout Plain Layout
32376 <cell alignment="center" valignment="top" usebox="none">
32379 \begin_layout Plain Layout
32385 <cell alignment="center" valignment="top" usebox="none">
32388 \begin_layout Plain Layout
32394 <cell alignment="center" valignment="top" usebox="none">
32397 \begin_layout Plain Layout
32403 <cell alignment="center" valignment="top" usebox="none">
32406 \begin_layout Plain Layout
32414 <cell alignment="left" valignment="top" usebox="none">
32417 \begin_layout Plain Layout
32423 <cell alignment="left" valignment="top" usebox="none">
32426 \begin_layout Plain Layout
32432 <cell alignment="left" valignment="top" usebox="none">
32435 \begin_layout Plain Layout
32441 <cell alignment="left" valignment="top" usebox="none">
32444 \begin_layout Plain Layout
32450 <cell alignment="center" valignment="top" usebox="none">
32453 \begin_layout Plain Layout
32459 <cell alignment="center" valignment="top" usebox="none">
32462 \begin_layout Plain Layout
32468 <cell alignment="center" valignment="top" usebox="none">
32471 \begin_layout Plain Layout
32477 <cell alignment="center" valignment="top" usebox="none">
32480 \begin_layout Plain Layout
32488 <cell alignment="left" valignment="top" usebox="none">
32491 \begin_layout Plain Layout
32497 <cell alignment="left" valignment="top" usebox="none">
32500 \begin_layout Plain Layout
32506 <cell alignment="left" valignment="top" usebox="none">
32509 \begin_layout Plain Layout
32515 <cell alignment="left" valignment="top" usebox="none">
32518 \begin_layout Plain Layout
32524 <cell alignment="center" valignment="top" usebox="none">
32527 \begin_layout Plain Layout
32533 <cell alignment="center" valignment="top" usebox="none">
32536 \begin_layout Plain Layout
32542 <cell alignment="center" valignment="top" usebox="none">
32545 \begin_layout Plain Layout
32551 <cell alignment="center" valignment="top" usebox="none">
32554 \begin_layout Plain Layout
32562 <cell alignment="left" valignment="top" usebox="none">
32565 \begin_layout Plain Layout
32571 <cell alignment="left" valignment="top" usebox="none">
32574 \begin_layout Plain Layout
32580 <cell alignment="left" valignment="top" usebox="none">
32583 \begin_layout Plain Layout
32589 <cell alignment="left" valignment="top" usebox="none">
32592 \begin_layout Plain Layout
32598 <cell alignment="center" valignment="top" usebox="none">
32601 \begin_layout Plain Layout
32607 <cell alignment="center" valignment="top" usebox="none">
32610 \begin_layout Plain Layout
32616 <cell alignment="center" valignment="top" usebox="none">
32619 \begin_layout Plain Layout
32625 <cell alignment="center" valignment="top" usebox="none">
32628 \begin_layout Plain Layout
32636 <cell alignment="left" valignment="top" usebox="none">
32639 \begin_layout Plain Layout
32645 <cell alignment="left" valignment="top" usebox="none">
32648 \begin_layout Plain Layout
32654 <cell alignment="left" valignment="top" usebox="none">
32657 \begin_layout Plain Layout
32663 <cell alignment="left" valignment="top" usebox="none">
32666 \begin_layout Plain Layout
32672 <cell alignment="center" valignment="top" usebox="none">
32675 \begin_layout Plain Layout
32681 <cell alignment="center" valignment="top" usebox="none">
32684 \begin_layout Plain Layout
32690 <cell alignment="center" valignment="top" usebox="none">
32693 \begin_layout Plain Layout
32699 <cell alignment="center" valignment="top" usebox="none">
32702 \begin_layout Plain Layout
32710 <cell alignment="center" valignment="top" usebox="none">
32713 \begin_layout Plain Layout
32719 <cell alignment="center" valignment="top" usebox="none">
32722 \begin_layout Plain Layout
32728 <cell alignment="center" valignment="top" usebox="none">
32731 \begin_layout Plain Layout
32737 <cell alignment="center" valignment="top" usebox="none">
32740 \begin_layout Plain Layout
32746 <cell alignment="center" valignment="top" usebox="none">
32749 \begin_layout Plain Layout
32755 <cell alignment="center" valignment="top" usebox="none">
32758 \begin_layout Plain Layout
32764 <cell alignment="center" valignment="top" usebox="none">
32767 \begin_layout Plain Layout
32773 <cell alignment="center" valignment="top" usebox="none">
32776 \begin_layout Plain Layout
32790 \begin_layout Chapter
32791 Names of available colors to be used in layouts
32792 \begin_inset CommandInset label
32794 name "chap:Names-of-colors"
32801 \begin_layout Standard
32802 The colors listed below are the standard colors and those that you can adjust
32803 in the \SpecialChar LyX
32807 \begin_layout Section
32811 \begin_layout Standard
32812 The following are no real colors, but rather act on color definitions:
32815 \begin_layout Description
32816 ignore The color is ignored
32819 \begin_layout Description
32820 inherit The color is inherited
32823 \begin_layout Description
32836 No particular color – clear or default
32839 \begin_layout Section
32843 \begin_layout Standard
32844 These are fixed colors that cannot be customized:
32847 \begin_layout Description
32851 \begin_layout Description
32855 \begin_layout Description
32859 \begin_layout Description
32863 \begin_layout Description
32867 \begin_layout Description
32871 \begin_layout Description
32875 \begin_layout Description
32879 \begin_layout Description
32883 \begin_layout Description
32887 \begin_layout Description
32891 \begin_layout Description
32895 \begin_layout Description
32899 \begin_layout Description
32903 \begin_layout Description
32907 \begin_layout Description
32911 \begin_layout Description
32915 \begin_layout Description
32919 \begin_layout Description
32923 \begin_layout Section
32927 \begin_layout Standard
32928 These are the colors allocated to specific elements in
32931 arg "dialog-show prefs"
32937 \begin_layout Description
32938 added_space Added space color
32941 \begin_layout Description
32942 addedtext Added text color
32945 \begin_layout Description
32946 appendix Appendix marker color
32949 \begin_layout Description
32950 background Background color
32953 \begin_layout Description
32954 bottomarea Bottom area color
32957 \begin_layout Description
32958 branchlabel Label color for branches
32961 \begin_layout Description
32962 buttonbg Color used for button background
32965 \begin_layout Description
32966 buttonframe Color for inset button frames
32969 \begin_layout Description
32970 buttonhoverbg Color used for button background under focus
32973 \begin_layout Description
32974 changebar Changebar color
32977 \begin_layout Description
32978 changedtextauthor1 Changed text color author 1
32981 \begin_layout Description
32982 changedtextauthor2 Changed text color author 2
32985 \begin_layout Description
32986 changedtextauthor3 Changed text color author 3
32989 \begin_layout Description
32990 changedtextauthor4 Changed text color author 4
32993 \begin_layout Description
32994 changedtextauthor5 Changed text color author 5
32997 \begin_layout Description
32998 collapsible Collapsible insets text color
33001 \begin_layout Description
33002 collapsibleframe Collapsible insets framecolor
33005 \begin_layout Description
33006 command Text color for command insets
33009 \begin_layout Description
33010 commandbg Background color for command insets
33013 \begin_layout Description
33014 commandframe Frame color for command insets
33017 \begin_layout Description
33018 comment Label color for comments
33021 \begin_layout Description
33022 commentbg Background color of comments
33025 \begin_layout Description
33026 cursor Cursor color
33029 \begin_layout Description
33030 deletedtext Deleted text color
33033 \begin_layout Description
33034 deletedtextmodifier Deleted text modifying color
33037 \begin_layout Description
33038 depthbar Color for the depth bars in the margin
33041 \begin_layout Description
33042 eolmarker End of line marker color
33045 \begin_layout Description
33046 error Color of the \SpecialChar LaTeX
33050 \begin_layout Description
33051 footlabel Label color for footnotes
33054 \begin_layout Description
33055 foreground Foreground color
33058 \begin_layout Description
33059 graphicsbg Graphics inset background color
33062 \begin_layout Description
33063 greyedoutbg Background color of greyedout inset
33066 \begin_layout Description
33067 greyedoutlabel Label color for greyedout insets
33070 \begin_layout Description
33071 greyedouttext Color for greyedout inset text
33074 \begin_layout Description
33075 indexlabel Label color for index insets
33078 \begin_layout Description
33079 inlinecompletion Inline completion color
33082 \begin_layout Description
33083 insetbg Inset marker background color
33086 \begin_layout Description
33087 insetframe Inset marker frame color
33090 \begin_layout Description
33091 language Color for marking foreign language words
33094 \begin_layout Description
33095 latex Text color in \SpecialChar LaTeX
33099 \begin_layout Description
33100 listingsbg Background color of listings inset
33103 \begin_layout Description
33104 marginlabel Label color for margin notes
33107 \begin_layout Description
33108 math Math inset text color
33111 \begin_layout Description
33112 mathbg Math inset background color
33115 \begin_layout Description
33116 mathcorners Math inset frame color not under focus
33119 \begin_layout Description
33120 mathframe Math inset frame color under focus
33123 \begin_layout Description
33124 mathline Math line color
33127 \begin_layout Description
33128 mathmacrobg Macro math inset background color
33131 \begin_layout Description
33132 mathmacroblend Macro math blended color
33135 \begin_layout Description
33136 mathmacroframe Macro math frame color
33139 \begin_layout Description
33140 mathmacrohoverbg Macro math inset background color hovered
33143 \begin_layout Description
33144 mathmacrolabel Macro math label color
33147 \begin_layout Description
33148 mathmacronewarg Macro template color for new parameters
33151 \begin_layout Description
33152 mathmacrooldarg Macro template color for old parameters
33155 \begin_layout Description
33156 newpage New page color
33159 \begin_layout Description
33160 nonunique_inlinecompletion Inline completion color for the non-unique part
33163 \begin_layout Description
33164 note Label color for notes
33167 \begin_layout Description
33168 notebg Background color of notes
33171 \begin_layout Description
33172 pagebreak Page break/line break color
33175 \begin_layout Description
33176 paragraphmarker Color used for the pilcrow sign to mark the end of a paragraph
33179 \begin_layout Description
33180 phantomtext Text color for phantom insets
33183 \begin_layout Description
33184 preview The color used for previews
33187 \begin_layout Description
33188 previewframe Preview frame color
33191 \begin_layout Description
33192 regexpframe Color for regexp frame
33195 \begin_layout Description
33196 scroll Color that indicates when a row can be scrolled
33199 \begin_layout Description
33200 selection Background color of selected text
33203 \begin_layout Description
33204 selectiontext Foreground color of selected text
33207 \begin_layout Description
33208 shadedbg Background color of shaded box
33211 \begin_layout Description
33212 special Special chars text color
33215 \begin_layout Description
33216 tabularline Table line color
33219 \begin_layout Description
33220 tabularonoffline Table line color
33223 \begin_layout Description
33224 urllabel Label color for URL insets
33227 \begin_layout Description
33228 urltext Color for URL inset text